@dxos/protocols 0.8.4-main.72ec0f3 → 0.8.4-main.765dc60934

package/dist/src/edge/registry.d.ts

@@ -0,0 +1,212 @@
+import * as Schema from 'effect/Schema';
+/**
+ * Hydrated plugin metadata, mirroring the @dxos/app-framework `Plugin.Meta` shape.
+ *
+ * Defined locally rather than imported from @dxos/app-framework to keep the protocols
+ * package free of UI/runtime dependencies. Consumers can treat decoded values as
+ * `Plugin.Meta` directly.
+ */
+export declare const PluginMetaSchema: Schema.Struct<{
+    id: Schema.filter<typeof Schema.String>;
+    name: Schema.filter<typeof Schema.String>;
+    description: Schema.optional<typeof Schema.String>;
+    author: Schema.optional<typeof Schema.String>;
+    homePage: Schema.optional<typeof Schema.String>;
+    source: Schema.optional<typeof Schema.String>;
+    screenshots: Schema.optional<Schema.Array$<typeof Schema.String>>;
+    tags: Schema.optional<Schema.Array$<typeof Schema.String>>;
+    icon: Schema.optional<typeof Schema.String>;
+    iconHue: Schema.optional<typeof Schema.String>;
+}>;
+export type PluginMeta = Schema.Schema.Type<typeof PluginMetaSchema>;
+/**
+ * Health signal the registry service attaches to a hydrated entry when a refresh fails.
+ * Clients surface the appropriate badge or filter entries based on this field.
+ */
+export declare const PluginHealthSchema: Schema.Literal<["ok", "release-missing", "manifest-invalid", "repo-unavailable"]>;
+export type PluginHealth = Schema.Schema.Type<typeof PluginHealthSchema>;
+/**
+ * Filename of the entry module every plugin must publish at the root of its bundle.
+ * The host dynamic-imports `<manifest URL base>/index.mjs` directly — no per-plugin
+ * configuration. `composerPlugin` outputs the bundle under this name so plugin authors
+ * never have to think about it.
+ */
+export declare const PLUGIN_ENTRY_FILENAME = "index.mjs";
+/**
+ * Shape of the manifest-asset JSON the registry service fetches from each plugin's latest release.
+ *
+ * Emitted by `@dxos/app-framework/vite-plugin`'s `composerPlugin` (see
+ * `MANIFEST_ASSET_NAME`). Lists every file the plugin needs at runtime — the entry
+ * module ({@link PLUGIN_ENTRY_FILENAME}) plus any sibling CSS, code-split chunks,
+ * fonts, etc. — so the host can eagerly precache the whole bundle for offline use.
+ * Paths in `assets` are relative to the manifest's URL.
+ */
+export declare const PluginManifestSchema: Schema.Struct<{
+    id: Schema.filter<typeof Schema.String>;
+    name: Schema.filter<typeof Schema.String>;
+    description: Schema.optional<typeof Schema.String>;
+    author: Schema.optional<typeof Schema.String>;
+    homePage: Schema.optional<typeof Schema.String>;
+    source: Schema.optional<typeof Schema.String>;
+    screenshots: Schema.optional<Schema.Array$<typeof Schema.String>>;
+    tags: Schema.optional<Schema.Array$<typeof Schema.String>>;
+    icon: Schema.optional<typeof Schema.String>;
+    iconHue: Schema.optional<typeof Schema.String>;
+    /** Plugin version (semver). Sourced from the publishing project's `package.json`. */
+    version: Schema.filter<typeof Schema.String>;
+    /**
+     * Relative paths of every file the plugin needs at runtime, including the entry.
+     * Must include {@link PLUGIN_ENTRY_FILENAME}; consumers verify on parse.
+     */
+    assets: Schema.filter<Schema.Array$<typeof Schema.String>>;
+}>;
+export type PluginManifest = Schema.Schema.Type<typeof PluginManifestSchema>;
+/**
+ * Single hydrated plugin entry returned by the registry service.
+ */
+export declare const PluginEntrySchema: Schema.Struct<{
+    /** GitHub repository in `owner/name` form. Empty string for entries sourced from a `manifestUrl`. */
+    repo: typeof Schema.String;
+    /** Plugin metadata from the repo's latest-release `manifest.json`. */
+    meta: Schema.Struct<{
+        id: Schema.filter<typeof Schema.String>;
+        name: Schema.filter<typeof Schema.String>;
+        description: Schema.optional<typeof Schema.String>;
+        author: Schema.optional<typeof Schema.String>;
+        homePage: Schema.optional<typeof Schema.String>;
+        source: Schema.optional<typeof Schema.String>;
+        screenshots: Schema.optional<Schema.Array$<typeof Schema.String>>;
+        tags: Schema.optional<Schema.Array$<typeof Schema.String>>;
+        icon: Schema.optional<typeof Schema.String>;
+        iconHue: Schema.optional<typeof Schema.String>;
+    }>;
+    /**
+     * URL of the plugin's `manifest.json`. Composer's URL loader fetches this, eagerly caches
+     * every declared asset via the platform `PluginAssetCache`, then dynamic-imports the entry.
+     * The URL must be CORS-safe and have its declared assets reachable as siblings.
+     */
+    moduleUrl: typeof Schema.String;
+    /** Release tag the entry was resolved from (e.g. `v0.1.0`). Empty string for `manifestUrl` entries. */
+    releaseTag: typeof Schema.String;
+    /** Health signal set by the service when an entry fails to refresh. */
+    health: Schema.Literal<["ok", "release-missing", "manifest-invalid", "repo-unavailable"]>;
+    /** Unix ms when this entry was last successfully hydrated. */
+    hydratedAt: typeof Schema.Number;
+}>;
+export type PluginEntry = Schema.Schema.Type<typeof PluginEntrySchema>;
+/**
+ * Response body of `GET /registry/plugins`.
+ */
+export declare const GetPluginsResponseBodySchema: Schema.Struct<{
+    /** Wire-format schema version, pinned to 1. */
+    version: Schema.Literal<[1]>;
+    /** Hydrated entries. Order matches the order in the upstream catalog manifest. */
+    plugins: Schema.Array$<Schema.Struct<{
+        /** GitHub repository in `owner/name` form. Empty string for entries sourced from a `manifestUrl`. */
+        repo: typeof Schema.String;
+        /** Plugin metadata from the repo's latest-release `manifest.json`. */
+        meta: Schema.Struct<{
+            id: Schema.filter<typeof Schema.String>;
+            name: Schema.filter<typeof Schema.String>;
+            description: Schema.optional<typeof Schema.String>;
+            author: Schema.optional<typeof Schema.String>;
+            homePage: Schema.optional<typeof Schema.String>;
+            source: Schema.optional<typeof Schema.String>;
+            screenshots: Schema.optional<Schema.Array$<typeof Schema.String>>;
+            tags: Schema.optional<Schema.Array$<typeof Schema.String>>;
+            icon: Schema.optional<typeof Schema.String>;
+            iconHue: Schema.optional<typeof Schema.String>;
+        }>;
+        /**
+         * URL of the plugin's `manifest.json`. Composer's URL loader fetches this, eagerly caches
+         * every declared asset via the platform `PluginAssetCache`, then dynamic-imports the entry.
+         * The URL must be CORS-safe and have its declared assets reachable as siblings.
+         */
+        moduleUrl: typeof Schema.String;
+        /** Release tag the entry was resolved from (e.g. `v0.1.0`). Empty string for `manifestUrl` entries. */
+        releaseTag: typeof Schema.String;
+        /** Health signal set by the service when an entry fails to refresh. */
+        health: Schema.Literal<["ok", "release-missing", "manifest-invalid", "repo-unavailable"]>;
+        /** Unix ms when this entry was last successfully hydrated. */
+        hydratedAt: typeof Schema.Number;
+    }>>;
+    /** Unix ms timestamp of the most recent successful refresh cycle. */
+    refreshedAt: typeof Schema.Number;
+}>;
+export type GetPluginsResponseBody = Schema.Schema.Type<typeof GetPluginsResponseBodySchema>;
+/**
+ * A single published version of a plugin, as returned by the registry service's
+ * versions endpoint. Sourced from the publishing project's GitHub releases.
+ *
+ * The host treats `tag` opaquely; ordering — newest first — is the service's
+ * responsibility (typically reverse-chronological by release date).
+ */
+export declare const PluginVersionSchema: Schema.Struct<{
+    /** Release tag (e.g. `v0.1.21`). Stable identifier for this version. */
+    tag: Schema.filter<typeof Schema.String>;
+    /**
+     * URL of this version's `manifest.json`. Matches the shape of {@link PluginEntrySchema.fields.moduleUrl}
+     * but pinned to a specific release rather than the latest. Composer's URL loader fetches
+     * this when the user installs / rolls back to this version.
+     */
+    moduleUrl: Schema.filter<typeof Schema.String>;
+    /** Unix ms when the version was released. Optional — services that lack this signal can omit. */
+    releasedAt: Schema.optional<typeof Schema.Number>;
+}>;
+export type PluginVersion = Schema.Schema.Type<typeof PluginVersionSchema>;
+/**
+ * Response body of `GET /registry/plugins/:repo/versions`.
+ *
+ * `:repo` is the GitHub `owner/name` form, URL-encoded (so `/` is escaped).
+ * Returns all hydratable releases for the repo, newest first; clients display them
+ * in the version picker for install / roll-back. Unauthenticated; same surface area
+ * as `GET /registry/plugins`.
+ */
+export declare const GetPluginVersionsResponseBodySchema: Schema.Struct<{
+    /** Wire-format schema version, pinned to 1. */
+    version: Schema.Literal<[1]>;
+    /** Available versions for the requested repo, newest first. */
+    versions: Schema.Array$<Schema.Struct<{
+        /** Release tag (e.g. `v0.1.21`). Stable identifier for this version. */
+        tag: Schema.filter<typeof Schema.String>;
+        /**
+         * URL of this version's `manifest.json`. Matches the shape of {@link PluginEntrySchema.fields.moduleUrl}
+         * but pinned to a specific release rather than the latest. Composer's URL loader fetches
+         * this when the user installs / rolls back to this version.
+         */
+        moduleUrl: Schema.filter<typeof Schema.String>;
+        /** Unix ms when the version was released. Optional — services that lack this signal can omit. */
+        releasedAt: Schema.optional<typeof Schema.Number>;
+    }>>;
+    /** Unix ms timestamp of the most recent successful refresh cycle for this repo. */
+    refreshedAt: typeof Schema.Number;
+}>;
+export type GetPluginVersionsResponseBody = Schema.Schema.Type<typeof GetPluginVersionsResponseBodySchema>;
+/**
+ * A catalog entry. Two flavours:
+ *  - `{ repo }`: the registry service hydrates from the GitHub repo's latest release.
+ *    Used by the production catalog.
+ *  - `{ manifestUrl }`: the registry service skips GitHub and fetches the manifest directly.
+ *    Used for local development against an in-progress plugin (e.g. served by `vite preview`)
+ *    so authors can iterate without publishing a release.
+ */
+export declare const RegistryEntrySchema: Schema.Union<[Schema.Struct<{
+    repo: Schema.filter<typeof Schema.String>;
+}>, Schema.Struct<{
+    manifestUrl: Schema.filter<typeof Schema.String>;
+}>]>;
+export type RegistryEntry = Schema.Schema.Type<typeof RegistryEntrySchema>;
+/**
+ * Shape of the catalog manifest published in the upstream community-plugins repo.
+ * Extra keys (e.g. `$schema`) are permitted.
+ */
+export declare const RegistryManifestSchema: Schema.TypeLiteral<{
+    version: Schema.Literal<[1]>;
+    plugins: Schema.Array$<Schema.Union<[Schema.Struct<{
+        repo: Schema.filter<typeof Schema.String>;
+    }>, Schema.Struct<{
+        manifestUrl: Schema.filter<typeof Schema.String>;
+    }>]>>;
+}, readonly [Schema.Record$<typeof Schema.String, typeof Schema.Unknown>]>;
+export type RegistryManifest = Schema.Schema.Type<typeof RegistryManifestSchema>;
+//# sourceMappingURL=registry.d.ts.map

package/dist/src/edge/registry.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"registry.d.ts","sourceRoot":"","sources":["../../../src/edge/registry.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AAExC;;;;;;GAMG;AACH,eAAO,MAAM,gBAAgB;;;;;;;;;;;EAW3B,CAAC;AACH,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAErE;;;GAGG;AACH,eAAO,MAAM,kBAAkB,mFAAkF,CAAC;AAClH,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAEzE;;;;;GAKG;AACH,eAAO,MAAM,qBAAqB,cAAc,CAAC;AAEjD;;;;;;;;GAQG;AACH,eAAO,MAAM,oBAAoB;;;;;;;;;;;IAE/B,qFAAqF;;IAErF;;;OAGG;;EAEH,CAAC;AACH,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,oBAAoB,CAAC,CAAC;AAE7E;;GAEG;AACH,eAAO,MAAM,iBAAiB;IAC5B,qGAAqG;;IAErG,sEAAsE;;;;;;;;;;;;;IAEtE;;;;OAIG;;IAEH,uGAAuG;;IAEvG,uEAAuE;;IAEvE,8DAA8D;;EAE9D,CAAC;AACH,MAAM,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAEvE;;GAEG;AACH,eAAO,MAAM,4BAA4B;IACvC,+CAA+C;;IAE/C,kFAAkF;;QAzBlF,qGAAqG;;QAErG,sEAAsE;;;;;;;;;;;;;QAEtE;;;;WAIG;;QAEH,uGAAuG;;QAEvG,uEAAuE;;QAEvE,8DAA8D;;;IAa9D,qEAAqE;;EAErE,CAAC;AACH,MAAM,MAAM,sBAAsB,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,4BAA4B,CAAC,CAAC;AAE7F;;;;;;GAMG;AACH,eAAO,MAAM,mBAAmB;IAC9B,wEAAwE;;IAExE;;;;OAIG;;IAEH,iGAAiG;;EAEjG,CAAC;AACH,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAE3E;;;;;;;GAOG;AACH,eAAO,MAAM,mCAAmC;IAC9C,+CAA+C;;IAE/C,+DAA+D;;QAxB/D,wEAAwE;;QAExE;;;;WAIG;;QAEH,iGAAiG;;;IAkBjG,mFAAmF;;EAEnF,CAAC;AACH,MAAM,MAAM,6BAA6B,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,mCAAmC,CAAC,CAAC;AAE3G;;;;;;;GAOG;AACH,eAAO,MAAM,mBAAmB;;;;IAG/B,CAAC;AACF,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAE3E;;;GAGG;AACH,eAAO,MAAM,sBAAsB;;;;;;;0EAMlC,CAAC;AACF,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,sBAAsB,CAAC,CAAC"}

package/dist/src/edge/registry.js

@@ -0,0 +1,139 @@
+//
+// Copyright 2026 DXOS.org
+//
+import * as Schema from 'effect/Schema';
+/**
+ * Hydrated plugin metadata, mirroring the @dxos/app-framework `Plugin.Meta` shape.
+ *
+ * Defined locally rather than imported from @dxos/app-framework to keep the protocols
+ * package free of UI/runtime dependencies. Consumers can treat decoded values as
+ * `Plugin.Meta` directly.
+ */
+export const PluginMetaSchema = Schema.Struct({
+    id: Schema.String.pipe(Schema.nonEmptyString()),
+    name: Schema.String.pipe(Schema.nonEmptyString()),
+    description: Schema.optional(Schema.String),
+    author: Schema.optional(Schema.String),
+    homePage: Schema.optional(Schema.String),
+    source: Schema.optional(Schema.String),
+    screenshots: Schema.optional(Schema.Array(Schema.String)),
+    tags: Schema.optional(Schema.Array(Schema.String)),
+    icon: Schema.optional(Schema.String),
+    iconHue: Schema.optional(Schema.String),
+});
+/**
+ * Health signal the registry service attaches to a hydrated entry when a refresh fails.
+ * Clients surface the appropriate badge or filter entries based on this field.
+ */
+export const PluginHealthSchema = Schema.Literal('ok', 'release-missing', 'manifest-invalid', 'repo-unavailable');
+/**
+ * Filename of the entry module every plugin must publish at the root of its bundle.
+ * The host dynamic-imports `<manifest URL base>/index.mjs` directly — no per-plugin
+ * configuration. `composerPlugin` outputs the bundle under this name so plugin authors
+ * never have to think about it.
+ */
+export const PLUGIN_ENTRY_FILENAME = 'index.mjs';
+/**
+ * Shape of the manifest-asset JSON the registry service fetches from each plugin's latest release.
+ *
+ * Emitted by `@dxos/app-framework/vite-plugin`'s `composerPlugin` (see
+ * `MANIFEST_ASSET_NAME`). Lists every file the plugin needs at runtime — the entry
+ * module ({@link PLUGIN_ENTRY_FILENAME}) plus any sibling CSS, code-split chunks,
+ * fonts, etc. — so the host can eagerly precache the whole bundle for offline use.
+ * Paths in `assets` are relative to the manifest's URL.
+ */
+export const PluginManifestSchema = Schema.Struct({
+    ...PluginMetaSchema.fields,
+    /** Plugin version (semver). Sourced from the publishing project's `package.json`. */
+    version: Schema.String.pipe(Schema.nonEmptyString()),
+    /**
+     * Relative paths of every file the plugin needs at runtime, including the entry.
+     * Must include {@link PLUGIN_ENTRY_FILENAME}; consumers verify on parse.
+     */
+    assets: Schema.Array(Schema.String).pipe(Schema.minItems(1)),
+});
+/**
+ * Single hydrated plugin entry returned by the registry service.
+ */
+export const PluginEntrySchema = Schema.Struct({
+    /** GitHub repository in `owner/name` form. Empty string for entries sourced from a `manifestUrl`. */
+    repo: Schema.String,
+    /** Plugin metadata from the repo's latest-release `manifest.json`. */
+    meta: PluginMetaSchema,
+    /**
+     * URL of the plugin's `manifest.json`. Composer's URL loader fetches this, eagerly caches
+     * every declared asset via the platform `PluginAssetCache`, then dynamic-imports the entry.
+     * The URL must be CORS-safe and have its declared assets reachable as siblings.
+     */
+    moduleUrl: Schema.String,
+    /** Release tag the entry was resolved from (e.g. `v0.1.0`). Empty string for `manifestUrl` entries. */
+    releaseTag: Schema.String,
+    /** Health signal set by the service when an entry fails to refresh. */
+    health: PluginHealthSchema,
+    /** Unix ms when this entry was last successfully hydrated. */
+    hydratedAt: Schema.Number,
+});
+/**
+ * Response body of `GET /registry/plugins`.
+ */
+export const GetPluginsResponseBodySchema = Schema.Struct({
+    /** Wire-format schema version, pinned to 1. */
+    version: Schema.Literal(1),
+    /** Hydrated entries. Order matches the order in the upstream catalog manifest. */
+    plugins: Schema.Array(PluginEntrySchema),
+    /** Unix ms timestamp of the most recent successful refresh cycle. */
+    refreshedAt: Schema.Number,
+});
+/**
+ * A single published version of a plugin, as returned by the registry service's
+ * versions endpoint. Sourced from the publishing project's GitHub releases.
+ *
+ * The host treats `tag` opaquely; ordering — newest first — is the service's
+ * responsibility (typically reverse-chronological by release date).
+ */
+export const PluginVersionSchema = Schema.Struct({
+    /** Release tag (e.g. `v0.1.21`). Stable identifier for this version. */
+    tag: Schema.String.pipe(Schema.nonEmptyString()),
+    /**
+     * URL of this version's `manifest.json`. Matches the shape of {@link PluginEntrySchema.fields.moduleUrl}
+     * but pinned to a specific release rather than the latest. Composer's URL loader fetches
+     * this when the user installs / rolls back to this version.
+     */
+    moduleUrl: Schema.String.pipe(Schema.nonEmptyString()),
+    /** Unix ms when the version was released. Optional — services that lack this signal can omit. */
+    releasedAt: Schema.optional(Schema.Number),
+});
+/**
+ * Response body of `GET /registry/plugins/:repo/versions`.
+ *
+ * `:repo` is the GitHub `owner/name` form, URL-encoded (so `/` is escaped).
+ * Returns all hydratable releases for the repo, newest first; clients display them
+ * in the version picker for install / roll-back. Unauthenticated; same surface area
+ * as `GET /registry/plugins`.
+ */
+export const GetPluginVersionsResponseBodySchema = Schema.Struct({
+    /** Wire-format schema version, pinned to 1. */
+    version: Schema.Literal(1),
+    /** Available versions for the requested repo, newest first. */
+    versions: Schema.Array(PluginVersionSchema),
+    /** Unix ms timestamp of the most recent successful refresh cycle for this repo. */
+    refreshedAt: Schema.Number,
+});
+/**
+ * A catalog entry. Two flavours:
+ *  - `{ repo }`: the registry service hydrates from the GitHub repo's latest release.
+ *    Used by the production catalog.
+ *  - `{ manifestUrl }`: the registry service skips GitHub and fetches the manifest directly.
+ *    Used for local development against an in-progress plugin (e.g. served by `vite preview`)
+ *    so authors can iterate without publishing a release.
+ */
+export const RegistryEntrySchema = Schema.Union(Schema.Struct({ repo: Schema.String.pipe(Schema.nonEmptyString()) }), Schema.Struct({ manifestUrl: Schema.String.pipe(Schema.nonEmptyString()) }));
+/**
+ * Shape of the catalog manifest published in the upstream community-plugins repo.
+ * Extra keys (e.g. `$schema`) are permitted.
+ */
+export const RegistryManifestSchema = Schema.Struct({
+    version: Schema.Literal(1),
+    plugins: Schema.Array(RegistryEntrySchema),
+}, Schema.Record({ key: Schema.String, value: Schema.Unknown }));
+//# sourceMappingURL=registry.js.map

package/dist/src/edge/registry.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"registry.js","sourceRoot":"","sources":["../../../src/edge/registry.ts"],"names":[],"mappings":"AAAA,EAAE;AACF,0BAA0B;AAC1B,EAAE;AAEF,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AAExC;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,MAAM,CAAC,MAAM,CAAC;IAC5C,EAAE,EAAE,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,cAAc,EAAE,CAAC;IAC/C,IAAI,EAAE,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,cAAc,EAAE,CAAC;IACjD,WAAW,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC;IAC3C,MAAM,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC;IACtC,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC;IACxC,MAAM,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC;IACtC,WAAW,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IACzD,IAAI,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IAClD,IAAI,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC;IACpC,OAAO,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC;CACxC,CAAC,CAAC;AAGH;;;GAGG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,kBAAkB,CAAC,CAAC;AAGlH;;;;;GAKG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,WAAW,CAAC;AAEjD;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,MAAM,CAAC,MAAM,CAAC;IAChD,GAAG,gBAAgB,CAAC,MAAM;IAC1B,qFAAqF;IACrF,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,cAAc,EAAE,CAAC;IACpD;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;CAC7D,CAAC,CAAC;AAGH;;GAEG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,MAAM,CAAC,MAAM,CAAC;IAC7C,qGAAqG;IACrG,IAAI,EAAE,MAAM,CAAC,MAAM;IACnB,sEAAsE;IACtE,IAAI,EAAE,gBAAgB;IACtB;;;;OAIG;IACH,SAAS,EAAE,MAAM,CAAC,MAAM;IACxB,uGAAuG;IACvG,UAAU,EAAE,MAAM,CAAC,MAAM;IACzB,uEAAuE;IACvE,MAAM,EAAE,kBAAkB;IAC1B,8DAA8D;IAC9D,UAAU,EAAE,MAAM,CAAC,MAAM;CAC1B,CAAC,CAAC;AAGH;;GAEG;AACH,MAAM,CAAC,MAAM,4BAA4B,GAAG,MAAM,CAAC,MAAM,CAAC;IACxD,+CAA+C;IAC/C,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC;IAC1B,kFAAkF;IAClF,OAAO,EAAE,MAAM,CAAC,KAAK,CAAC,iBAAiB,CAAC;IACxC,qEAAqE;IACrE,WAAW,EAAE,MAAM,CAAC,MAAM;CAC3B,CAAC,CAAC;AAGH;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,MAAM,CAAC,MAAM,CAAC;IAC/C,wEAAwE;IACxE,GAAG,EAAE,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,cAAc,EAAE,CAAC;IAChD;;;;OAIG;IACH,SAAS,EAAE,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,cAAc,EAAE,CAAC;IACtD,iGAAiG;IACjG,UAAU,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC;CAC3C,CAAC,CAAC;AAGH;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,mCAAmC,GAAG,MAAM,CAAC,MAAM,CAAC;IAC/D,+CAA+C;IAC/C,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC;IAC1B,+DAA+D;IAC/D,QAAQ,EAAE,MAAM,CAAC,KAAK,CAAC,mBAAmB,CAAC;IAC3C,mFAAmF;IACnF,WAAW,EAAE,MAAM,CAAC,MAAM;CAC3B,CAAC,CAAC;AAGH;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,MAAM,CAAC,KAAK,CAC7C,MAAM,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,cAAc,EAAE,CAAC,EAAE,CAAC,EACpE,MAAM,CAAC,MAAM,CAAC,EAAE,WAAW,EAAE,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,cAAc,EAAE,CAAC,EAAE,CAAC,CAC5E,CAAC;AAGF;;;GAGG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,MAAM,CAAC,MAAM,CACjD;IACE,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC;IAC1B,OAAO,EAAE,MAAM,CAAC,KAAK,CAAC,mBAAmB,CAAC;CAC3C,EACD,MAAM,CAAC,MAAM,CAAC,EAAE,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,EAAE,MAAM,CAAC,OAAO,EAAE,CAAC,CAC7D,CAAC"}

package/dist/src/errors/base-errors.d.ts

@@ -2,26 +2,104 @@
  * NOTE: Messages should be sentences (Start with a capital letter and end with a period).
  * Errors can optionally include a JSON context object.
  */
-export declare class BaseError extends Error {
-    readonly code: string;
-    readonly context?: Record<string, any> | undefined;
-    constructor(code: string, message?: string, context?: Record<string, any> | undefined);
-}
+import { BaseError } from '@dxos/errors';
+declare const ApiError_base: {
+    new (options?: import("@dxos/errors").BaseErrorOptions): {
+        cause?: unknown;
+        stack?: string;
+        name: "ApiError";
+        context: Record<string, unknown>;
+        readonly message: string;
+        readonly _tag: "ApiError";
+    };
+    isError(error: unknown): error is Error;
+    name: "ApiError";
+    is(error: unknown): error is BaseError;
+    wrap(options?: Omit<import("@dxos/errors").BaseErrorOptions, 'cause'> & {
+        ifTypeDiffers?: boolean;
+    }): (error: unknown) => {
+        cause?: unknown;
+        stack?: string;
+        name: "ApiError";
+        context: Record<string, unknown>;
+        readonly message: string;
+        readonly _tag: "ApiError";
+    };
+    extend<Name extends string = string>(name: Name, message?: string): any;
+    captureStackTrace(targetObject: object, constructorOpt?: Function): void;
+    prepareStackTrace?: ((err: Error, stackTraces: NodeJS.CallSite[]) => any) | undefined;
+    stackTraceLimit: number;
+};
 /**
  * User facing API Errors.
  * E.g., something was misconfigured.
  */
-export declare class ApiError extends BaseError {
+export declare class ApiError extends ApiError_base {
 }
+declare const SystemError_base: {
+    new (options?: import("@dxos/errors").BaseErrorOptions): {
+        cause?: unknown;
+        stack?: string;
+        name: "SystemError";
+        context: Record<string, unknown>;
+        readonly message: string;
+        readonly _tag: "SystemError";
+    };
+    isError(error: unknown): error is Error;
+    name: "SystemError";
+    is(error: unknown): error is BaseError;
+    wrap(options?: Omit<import("@dxos/errors").BaseErrorOptions, 'cause'> & {
+        ifTypeDiffers?: boolean;
+    }): (error: unknown) => {
+        cause?: unknown;
+        stack?: string;
+        name: "SystemError";
+        context: Record<string, unknown>;
+        readonly message: string;
+        readonly _tag: "SystemError";
+    };
+    extend<Name extends string = string>(name: Name, message?: string): any;
+    captureStackTrace(targetObject: object, constructorOpt?: Function): void;
+    prepareStackTrace?: ((err: Error, stackTraces: NodeJS.CallSite[]) => any) | undefined;
+    stackTraceLimit: number;
+};
 /**
  * Internal system errors.
  * E.g., unexpected/unrecoverable runtime error.
  */
-export declare class SystemError extends BaseError {
+export declare class SystemError extends SystemError_base {
 }
+declare const DatabaseError_base: {
+    new (options?: import("@dxos/errors").BaseErrorOptions): {
+        cause?: unknown;
+        stack?: string;
+        name: "DatabaseError";
+        context: Record<string, unknown>;
+        readonly message: string;
+        readonly _tag: "DatabaseError";
+    };
+    isError(error: unknown): error is Error;
+    name: "DatabaseError";
+    is(error: unknown): error is BaseError;
+    wrap(options?: Omit<import("@dxos/errors").BaseErrorOptions, 'cause'> & {
+        ifTypeDiffers?: boolean;
+    }): (error: unknown) => {
+        cause?: unknown;
+        stack?: string;
+        name: "DatabaseError";
+        context: Record<string, unknown>;
+        readonly message: string;
+        readonly _tag: "DatabaseError";
+    };
+    extend<Name extends string = string>(name: Name, message?: string): any;
+    captureStackTrace(targetObject: object, constructorOpt?: Function): void;
+    prepareStackTrace?: ((err: Error, stackTraces: NodeJS.CallSite[]) => any) | undefined;
+    stackTraceLimit: number;
+};
 /**
  * Database errors.
  */
-export declare class DatabaseError extends BaseError {
+export declare class DatabaseError extends DatabaseError_base {
 }
+export {};
 //# sourceMappingURL=base-errors.d.ts.map

package/dist/src/errors/base-errors.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"base-errors.d.ts","sourceRoot":"","sources":["../../../src/errors/base-errors.ts"],"names":[],"mappings":"AAMA;;;GAGG;AACH,qBAAa,SAAU,SAAQ,KAAK;IAEhC,QAAQ,CAAC,IAAI,EAAE,MAAM;IAErB,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;gBAF7B,IAAI,EAAE,MAAM,EACrB,OAAO,CAAC,EAAE,MAAM,EACP,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,YAAA;CAQzC;AAKD;;;GAGG;AACH,qBAAa,QAAS,SAAQ,SAAS;CAAG;AAE1C;;;GAGG;AACH,qBAAa,WAAY,SAAQ,SAAS;CAAG;AAE7C;;GAEG;AAEH,qBAAa,aAAc,SAAQ,SAAS;CAAG"}
+{"version":3,"file":"base-errors.d.ts","sourceRoot":"","sources":["../../../src/errors/base-errors.ts"],"names":[],"mappings":"AAIA;;;GAGG;AACH,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEzC;;;GAGG;AACH,qBAAa,QAAS,SAAQ,aAA4B;CAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAE7D;;;GAGG;AACH,qBAAa,WAAY,SAAQ,gBAA+B;CAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEnE;;GAEG;AACH,qBAAa,aAAc,SAAQ,kBAAiC;CAAG"}

package/dist/src/errors/base-errors.js

@@ -1,42 +1,26 @@
 //
 // Copyright 2021 DXOS.org
 //
-// TODO(dmaretskyi): Reconcile with @dxos/errors
 /**
  * NOTE: Messages should be sentences (Start with a capital letter and end with a period).
  * Errors can optionally include a JSON context object.
  */
-export class BaseError extends Error {
-    code;
-    context;
-    constructor(code, message, context) {
-        // TODO(dmaretskyi): Error.cause.
-        super(message ?? code);
-        this.code = code;
-        this.context = context;
-        this.name = code;
-        // NOTE: Restores prototype chain (https://stackoverflow.com/a/48342359).
-        Object.setPrototypeOf(this, new.target.prototype);
-    }
-}
-// TODO(dmaretskyi): Consider common error classes with error codes:
-// throw new SystemError(ERROR_CODE_OUT_OF_MEMORY, 'Out of memory', { a: 1, b: 2 });
+import { BaseError } from '@dxos/errors';
 /**
  * User facing API Errors.
  * E.g., something was misconfigured.
  */
-export class ApiError extends BaseError {
+export class ApiError extends BaseError.extend('ApiError') {
 }
 /**
  * Internal system errors.
  * E.g., unexpected/unrecoverable runtime error.
  */
-export class SystemError extends BaseError {
+export class SystemError extends BaseError.extend('SystemError') {
 }
 /**
  * Database errors.
  */
-// TODO(wittjosiah): Same as ApiError?
-export class DatabaseError extends BaseError {
+export class DatabaseError extends BaseError.extend('DatabaseError') {
 }
 //# sourceMappingURL=base-errors.js.map

package/dist/src/errors/base-errors.js.map

@@ -1 +1 @@
-{"version":3,"file":"base-errors.js","sourceRoot":"","sources":["../../../src/errors/base-errors.ts"],"names":[],"mappings":"AAAA,EAAE;AACF,0BAA0B;AAC1B,EAAE;AAEF,gDAAgD;AAEhD;;;GAGG;AACH,MAAM,OAAO,SAAU,SAAQ,KAAK;IAEvB;IAEA;IAHX,YACW,IAAY,EACrB,OAAgB,EACP,OAA6B;QAEtC,iCAAiC;QACjC,KAAK,CAAC,OAAO,IAAI,IAAI,CAAC,CAAC;QALd,SAAI,GAAJ,IAAI,CAAQ;QAEZ,YAAO,GAAP,OAAO,CAAsB;QAItC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,yEAAyE;QACzE,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IACpD,CAAC;CACF;AAED,oEAAoE;AACpE,oFAAoF;AAEpF;;;GAGG;AACH,MAAM,OAAO,QAAS,SAAQ,SAAS;CAAG;AAE1C;;;GAGG;AACH,MAAM,OAAO,WAAY,SAAQ,SAAS;CAAG;AAE7C;;GAEG;AACH,sCAAsC;AACtC,MAAM,OAAO,aAAc,SAAQ,SAAS;CAAG"}
+{"version":3,"file":"base-errors.js","sourceRoot":"","sources":["../../../src/errors/base-errors.ts"],"names":[],"mappings":"AAAA,EAAE;AACF,0BAA0B;AAC1B,EAAE;AAEF;;;GAGG;AACH,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAEzC;;;GAGG;AACH,MAAM,OAAO,QAAS,SAAQ,SAAS,CAAC,MAAM,CAAC,UAAU,CAAC;CAAG;AAE7D;;;GAGG;AACH,MAAM,OAAO,WAAY,SAAQ,SAAS,CAAC,MAAM,CAAC,aAAa,CAAC;CAAG;AAEnE;;GAEG;AACH,MAAM,OAAO,aAAc,SAAQ,SAAS,CAAC,MAAM,CAAC,eAAe,CAAC;CAAG"}

package/dist/src/errors/encoding.d.ts

@@ -1,7 +1,7 @@
-import { type Error as SerializedErrorProto } from '../proto/gen/dxos/error.js';
+import { type Error as SerializedErrorProto } from '../proto/gen/dxos/error.ts';
 export declare const encodeError: (err: any) => SerializedErrorProto;
 export type DecodeOptions = {
     appendStack?: string;
 };
-export declare const decodeError: (err: SerializedErrorProto, { appendStack }?: DecodeOptions) => Error;
+export declare const decodeError: (err: SerializedErrorProto, { appendStack }?: DecodeOptions) => import("@dxos/errors").BaseError<string> | Error;
 //# sourceMappingURL=encoding.d.ts.map

package/dist/src/errors/encoding.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"encoding.d.ts","sourceRoot":"","sources":["../../../src/errors/encoding.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,KAAK,IAAI,oBAAoB,EAAE,MAAM,4BAA4B,CAAC;AAIhF,eAAO,MAAM,WAAW,GAAI,KAAK,GAAG,KAAG,oBAiBtC,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,eAAO,MAAM,WAAW,GAAI,KAAK,oBAAoB,EAAE,kBAAiB,aAAkB,UASzF,CAAC"}
+{"version":3,"file":"encoding.d.ts","sourceRoot":"","sources":["../../../src/errors/encoding.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,KAAK,IAAI,oBAAoB,EAAE,MAAM,4BAA4B,CAAC;AAGhF,eAAO,MAAM,WAAW,QAAS,GAAG,KAAG,oBAiBtC,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,eAAO,MAAM,WAAW,QAAS,oBAAoB,oBAAmB,aAAa,qDASpF,CAAC"}

package/dist/src/errors/encoding.js.map

@@ -1 +1 @@
-{"version":3,"file":"encoding.js","sourceRoot":"","sources":["../../../src/errors/encoding.ts"],"names":[],"mappings":"AAAA,EAAE;AACF,0BAA0B;AAC1B,EAAE;AAIF,OAAO,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAEhD,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,GAAQ,EAAwB,EAAE;IAC5D,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,EAAE,OAAO,EAAE,CAAC;QAC5C,OAAO;YACL,IAAI,EAAE,GAAG,CAAC,IAAI;YACd,OAAO,EAAE,GAAG,CAAC,OAAO;YACpB,OAAO,EAAE,GAAG,CAAC,OAAO;YACpB,KAAK,EAAE,GAAG,CAAC,KAAK;SACjB,CAAC;IACJ,CAAC;SAAM,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;QACnC,OAAO;YACL,OAAO,EAAE,GAAG;SACb,CAAC;IACJ,CAAC;SAAM,CAAC;QACN,OAAO;YACL,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC;SAC7B,CAAC;IACJ,CAAC;AACH,CAAC,CAAC;AAMF,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,GAAyB,EAAE,EAAE,WAAW,KAAoB,EAAE,EAAE,EAAE;IAC5F,MAAM,KAAK,GAAG,gBAAgB,CAAC,GAAG,CAAC,CAAC;IACpC,IAAI,WAAW,EAAE,CAAC;QAChB,KAAK,CAAC,KAAK,GAAG,CAAC,GAAG,CAAC,KAAK,IAAI,GAAG,KAAK,CAAC,OAAO,IAAI,CAAC,GAAG,WAAW,CAAC;IAClE,CAAC;SAAM,CAAC;QACN,KAAK,CAAC,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC;IAC1B,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC,CAAC"}
+{"version":3,"file":"encoding.js","sourceRoot":"","sources":["../../../src/errors/encoding.ts"],"names":[],"mappings":"AAAA,EAAE;AACF,0BAA0B;AAC1B,EAAE;AAGF,OAAO,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAEhD,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,GAAQ,EAAwB,EAAE;IAC5D,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,EAAE,OAAO,EAAE,CAAC;QAC5C,OAAO;YACL,IAAI,EAAE,GAAG,CAAC,IAAI;YACd,OAAO,EAAE,GAAG,CAAC,OAAO;YACpB,OAAO,EAAE,GAAG,CAAC,OAAO;YACpB,KAAK,EAAE,GAAG,CAAC,KAAK;SACjB,CAAC;IACJ,CAAC;SAAM,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;QACnC,OAAO;YACL,OAAO,EAAE,GAAG;SACb,CAAC;IACJ,CAAC;SAAM,CAAC;QACN,OAAO;YACL,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC;SAC7B,CAAC;IACJ,CAAC;AACH,CAAC,CAAC;AAMF,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,GAAyB,EAAE,EAAE,WAAW,EAAE,GAAkB,EAAE,EAAE,EAAE;IAC5F,MAAM,KAAK,GAAG,gBAAgB,CAAC,GAAG,CAAC,CAAC;IACpC,IAAI,WAAW,EAAE,CAAC;QAChB,KAAK,CAAC,KAAK,GAAG,CAAC,GAAG,CAAC,KAAK,IAAI,GAAG,KAAK,CAAC,OAAO,IAAI,CAAC,GAAG,WAAW,CAAC;IAClE,CAAC;SAAM,CAAC;QACN,KAAK,CAAC,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC;IAC1B,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC,CAAC"}