Skip to content

SDK

asteby/metacore-sdk is the TypeScript half of Metacore: the manifest schema, the bundle format, the React runtime, the CLI, and a set of UI primitives that read kernel metadata and render typed components.

What it provides

The SDK ships 16 npm packages under the @asteby/metacore-* scope. They split along three axes:

Contracts

PackageWhat it is
@asteby/metacore-manifestThe manifest schema (Zod), validators, types
@asteby/metacore-bundleBundle format, signing, verification
@asteby/metacore-typesShared TypeScript types used across the runtime and the CLI

Runtime (browser)

PackageWhat it is
@asteby/metacore-runtime-coreFramework-agnostic client: HTTP, WebSocket, query layer
@asteby/metacore-runtime-reactReact bindings: provider, hooks, <DynamicTable>, <DynamicForm> and friends
@asteby/metacore-formsForm primitives + the dynamic form renderer
@asteby/metacore-tablesTable primitives + the dynamic table renderer
@asteby/metacore-dialogsModal / drawer primitives wired to action / confirm flows
@asteby/metacore-navigationSidebar / breadcrumb / route helpers driven by addon metadata
@asteby/metacore-chartsChart primitives consuming dynamic-CRUD aggregations
@asteby/metacore-iconsIcon set used by the rest of the SDK
@asteby/metacore-themeDesign tokens, dark mode, Tailwind v4 source export
@asteby/metacore-i18nTranslation helpers; addons declare strings, the runtime resolves them
@asteby/metacore-realtimeWebSocket subscription helpers, used by the React hooks

Authoring

PackageWhat it is
@asteby/metacore-cliThe metacore-sdk command — scaffold, build, sign, publish addons
@asteby/metacore-test-utilsTest harnesses for addons (mock kernel, fixture data)

(Exact package count + names track the SDK docs — this table is a high-level inventory.)

What you reach for

For most app builders, only two packages are direct dependencies:

bash
pnpm add @asteby/metacore-runtime-react @asteby/metacore-runtime-core

Everything else is a transitive dep, reached through the runtime's exports.

CLI quickstart

bash
pnpm dlx @asteby/metacore-cli init my-addon --template=basic
pnpm metacore-sdk build
pnpm metacore-sdk install ./dist/my-addon-0.1.0.mcbundle --host=http://localhost:8080

See Build an addon for the full walkthrough.

Stack

  • TypeScript 5.5+
  • React 18+
  • Zod for runtime schema validation
  • TanStack Query under the hood for data fetching
  • Vite as the reference build tool for hosts (the SDK itself is framework-agnostic at the core layer)
  • Tailwind v4 compatible — the theme package exports @source directives

Where the deep documentation lives

The SDK ships its own VitePress docs site with:

  • Full manifest spec (every field, every column type, every validator)
  • Every package's API reference (TypeDoc-generated)
  • Every component's props
  • Every hook's signature
  • Recipes (forms, tables, navigation, real-time, custom slots)

SDK docs ↗

Repository

Metacore is open-source. Apache-2.0.