obix-sdk-core
v0.5.0
Published
Compatibility name: obix-sdk-core now resolves to obix-core-runtime. Contains no logic of its own — import from obix-core-runtime in new code.
Readme
obix-sdk-core
Previous name:
@obinexusltd/obix-sdk-core— OBIX packages are named without an npm scope since decision D-102 (2026-09-29); the package, its version and its exports are unchanged.
Compatibility package.
obix-sdk-coreis kept so that code and documents that import it keep resolving. It contains no logic: every export below is the export ofobix-core-runtimeunder the old name. New code should import fromobix-core-runtime.
Old package (historical provenance): upstream:obix-sdk@1269cfa:obix-sdk/packages/sdk/obix-core. Decision: compat-shim (documented name; listed in obix-naming.json (OBIX monorepo record) legacyShims) in docs/recovery/migration-table.md (OBIX monorepo record) — DOC-IMPORTED (Part 1: import { ObixRuntime } from "obix-sdk-core") but the repo is empty and the name is unpublished → shim under the owner's category..
obix-sdk-core
| Old name | Is |
|---|---|
| LifecycleHook | obix-core-runtime.LifecycleHook |
| ObixRuntime | obix-core-runtime.ObixRuntime |
| PolicyEngine | obix-core-runtime.PolicyEngine |
| StateHaltEngine | obix-core-runtime.StateHaltEngine |
Types: Action, ComponentDefinition, ComponentInstance, ComponentLogic, HaltRecommendation, LifecycleHandler, Policy, PolicyResult, RenderFn, StateHaltConfig.
Verification
test/shim.test.mjs imports both packages and asserts, for every entry point: each old name is identical (===) to the owner's export (or, for the derived renderX, behaves as renderWith(createX)); the shim exports exactly these names and nothing else; every excluded name is absent. Verified on Node 26.7 only.
Installation
npm install obix-sdk-coreAPI surface
obix-sdk-core— 4 value exports:LifecycleHook,ObixRuntime,PolicyEngine,StateHaltEngine- Type declarations:
./dist/index.d.ts(and a declaration next to every JS entry point).
Architecture role
obix-sdk-core is a compatibility package: it keeps an old name resolving and contains no logic — every export is the export of obix-core-runtime. New code imports from obix-core-runtime (or from the umbrella obix).
The architecture of OBIX — the package families and which packages are public API — is indexed in the umbrella: docs/architecture.md.
Package relationships
- Depends on (OBIX):
obix-core-runtime. - Used by (OBIX): no other OBIX package.
Testing
- 1 test file ships in the npm package (
test/): the evidence of the package's contract, published so that its verification can be inspected — not runtime code (no entry point reaches it). - Standalone: 1 of 1 — it reads nothing outside the package.
- Run them with
npm test(node --test "test/*.test.mjs") in the OBIX monorepo, which provides the test tooling (Node's test runner, TypeScript) and the harness.
Documentation
- CHANGELOG.md
- The OBIX architecture index: obix/docs/architecture.md
Repository
- https://github.com/obinexus/obix-sdk-core —
[email protected]:obinexus/obix-sdk-core.git - Issues: https://github.com/obinexus/obix-sdk-core/issues
- The repository is a clean export of the package from the OBIX monorepo. Its lineage — the sources it was recovered from and its earlier names — is
PROVENANCE.json, shipped in this package; the repository's copy also records the monorepo commit it was exported from.
License
MIT — see LICENSE.
