Skip to content

Interface: StorageManifest

Makaio Framework


Makaio Framework / contracts/extension / StorageManifest

Defined in: ../../../packages/contracts/src/extension/manifest.ts:279

Describes the storage requirements of an extension.

Serializable metadata that the runtime uses to run migrations before starting the extension’s service. The migrations path is relative to the extension root and resolved to an absolute path by the composition root. Bundled hosts may also provide a stable migrationSourceId so migration identity does not collapse onto packaged output paths.

readonly optional migrations?: string

Defined in: ../../../packages/contracts/src/extension/manifest.ts:290

Path to the Drizzle migration folder, relative to the extension root.

The runtime resolves this to an absolute path and passes it to the host-supplied runMigrations callback before any extension services are started. The callback is responsible for applying pending migrations against the shared database using a per-extension tracking table to avoid filename collisions.

'drizzle'

readonly optional migrationSourceId?: string

Defined in: ../../../packages/contracts/src/extension/manifest.ts:298

Stable runtime identity for the migration bundle.

Hosts use this to key deduplication, ledger tables, and bundled migration lookup independently of the on-disk discovery path. When omitted, the resolved migration folder path remains the identity.