@openbrf/plugin-sdk 0.0.0-stage → 1.0.0

package/dist/catalog.d.ts

@@ -0,0 +1,315 @@
+import { z } from "zod";
+/** A tarball and the digest its bytes must hash to. */
+export declare const catalogArtifactSchema: z.ZodObject<{
+    url: z.ZodString;
+    sha512: z.ZodString;
+    bytes: z.ZodOptional<z.ZodInt>;
+}, z.core.$strict>;
+export type CatalogArtifact = z.infer<typeof catalogArtifactSchema>;
+/** Text a curator writes in both languages the interface is offered in. */
+declare const localizedTextSchema: z.ZodObject<{
+    sv: z.ZodString;
+    en: z.ZodString;
+}, z.core.$strict>;
+export type LocalizedText = z.infer<typeof localizedTextSchema>;
+export declare const catalogPluginEntrySchema: z.ZodObject<{
+    id: z.ZodString;
+    version: z.ZodString;
+    name: z.ZodObject<{
+        sv: z.ZodString;
+        en: z.ZodString;
+    }, z.core.$strict>;
+    description: z.ZodObject<{
+        sv: z.ZodString;
+        en: z.ZodString;
+    }, z.core.$strict>;
+    artifact: z.ZodObject<{
+        url: z.ZodString;
+        sha512: z.ZodString;
+        bytes: z.ZodOptional<z.ZodInt>;
+    }, z.core.$strict>;
+    homepage: z.ZodOptional<z.ZodString>;
+    deprecated: z.ZodDefault<z.ZodBoolean>;
+    type: z.ZodLiteral<"plugin">;
+    packageName: z.ZodString;
+    apiVersion: z.ZodInt;
+    permissions: z.ZodDefault<z.ZodArray<z.ZodEnum<{
+        "addressBook:read": "addressBook:read";
+        "addressBook:readContact": "addressBook:readContact";
+        "jobs:schedule": "jobs:schedule";
+        "mail:send": "mail:send";
+        "sms:send": "sms:send";
+    }>>>;
+    personalData: z.ZodDefault<z.ZodArray<z.ZodEnum<{
+        apartment: "apartment";
+        email: "email";
+        name: "name";
+        phone: "phone";
+        residency: "residency";
+    }>>>;
+    actions: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        capability: z.ZodString;
+        effect: z.ZodEnum<{
+            delete: "delete";
+            read: "read";
+            write: "write";
+        }>;
+        personalData: z.ZodDefault<z.ZodArray<z.ZodEnum<{
+            account: "account";
+            apartment: "apartment";
+            auditTrail: "auditTrail";
+            email: "email";
+            financial: "financial";
+            freeText: "freeText";
+            health: "health";
+            name: "name";
+            personalIdentityNumber: "personalIdentityNumber";
+            phone: "phone";
+            photograph: "photograph";
+            postalAddress: "postalAddress";
+            protected: "protected";
+            residency: "residency";
+        }>>>;
+        surfaces: z.ZodDefault<z.ZodArray<z.ZodEnum<{
+            ai: "ai";
+            mcp: "mcp";
+            ui: "ui";
+        }>>>;
+    }, z.core.$strict>>>;
+    oauthProtectedResource: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>;
+/**
+ * A theme entry. Themes install through the same download-and-verify path and
+ * are listed in the same index; what happens after the bytes are verified is
+ * the theme installer's business, not this schema's.
+ *
+ * No package name: a theme is data read out of its archive, never an npm
+ * package, and nothing that installs one keys on a package name.
+ */
+export declare const catalogThemeEntrySchema: z.ZodObject<{
+    id: z.ZodString;
+    version: z.ZodString;
+    name: z.ZodObject<{
+        sv: z.ZodString;
+        en: z.ZodString;
+    }, z.core.$strict>;
+    description: z.ZodObject<{
+        sv: z.ZodString;
+        en: z.ZodString;
+    }, z.core.$strict>;
+    artifact: z.ZodObject<{
+        url: z.ZodString;
+        sha512: z.ZodString;
+        bytes: z.ZodOptional<z.ZodInt>;
+    }, z.core.$strict>;
+    homepage: z.ZodOptional<z.ZodString>;
+    deprecated: z.ZodDefault<z.ZodBoolean>;
+    type: z.ZodLiteral<"theme">;
+    contract: z.ZodOptional<z.ZodString>;
+    extends: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>;
+export declare const catalogEntrySchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    id: z.ZodString;
+    version: z.ZodString;
+    name: z.ZodObject<{
+        sv: z.ZodString;
+        en: z.ZodString;
+    }, z.core.$strict>;
+    description: z.ZodObject<{
+        sv: z.ZodString;
+        en: z.ZodString;
+    }, z.core.$strict>;
+    artifact: z.ZodObject<{
+        url: z.ZodString;
+        sha512: z.ZodString;
+        bytes: z.ZodOptional<z.ZodInt>;
+    }, z.core.$strict>;
+    homepage: z.ZodOptional<z.ZodString>;
+    deprecated: z.ZodDefault<z.ZodBoolean>;
+    type: z.ZodLiteral<"plugin">;
+    packageName: z.ZodString;
+    apiVersion: z.ZodInt;
+    permissions: z.ZodDefault<z.ZodArray<z.ZodEnum<{
+        "addressBook:read": "addressBook:read";
+        "addressBook:readContact": "addressBook:readContact";
+        "jobs:schedule": "jobs:schedule";
+        "mail:send": "mail:send";
+        "sms:send": "sms:send";
+    }>>>;
+    personalData: z.ZodDefault<z.ZodArray<z.ZodEnum<{
+        apartment: "apartment";
+        email: "email";
+        name: "name";
+        phone: "phone";
+        residency: "residency";
+    }>>>;
+    actions: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        capability: z.ZodString;
+        effect: z.ZodEnum<{
+            delete: "delete";
+            read: "read";
+            write: "write";
+        }>;
+        personalData: z.ZodDefault<z.ZodArray<z.ZodEnum<{
+            account: "account";
+            apartment: "apartment";
+            auditTrail: "auditTrail";
+            email: "email";
+            financial: "financial";
+            freeText: "freeText";
+            health: "health";
+            name: "name";
+            personalIdentityNumber: "personalIdentityNumber";
+            phone: "phone";
+            photograph: "photograph";
+            postalAddress: "postalAddress";
+            protected: "protected";
+            residency: "residency";
+        }>>>;
+        surfaces: z.ZodDefault<z.ZodArray<z.ZodEnum<{
+            ai: "ai";
+            mcp: "mcp";
+            ui: "ui";
+        }>>>;
+    }, z.core.$strict>>>;
+    oauthProtectedResource: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>, z.ZodObject<{
+    id: z.ZodString;
+    version: z.ZodString;
+    name: z.ZodObject<{
+        sv: z.ZodString;
+        en: z.ZodString;
+    }, z.core.$strict>;
+    description: z.ZodObject<{
+        sv: z.ZodString;
+        en: z.ZodString;
+    }, z.core.$strict>;
+    artifact: z.ZodObject<{
+        url: z.ZodString;
+        sha512: z.ZodString;
+        bytes: z.ZodOptional<z.ZodInt>;
+    }, z.core.$strict>;
+    homepage: z.ZodOptional<z.ZodString>;
+    deprecated: z.ZodDefault<z.ZodBoolean>;
+    type: z.ZodLiteral<"theme">;
+    contract: z.ZodOptional<z.ZodString>;
+    extends: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>], "type">;
+export type CatalogPluginEntry = z.infer<typeof catalogPluginEntrySchema>;
+export type CatalogThemeEntry = z.infer<typeof catalogThemeEntrySchema>;
+export type CatalogEntry = z.infer<typeof catalogEntrySchema>;
+export declare const catalogSchema: z.ZodObject<{
+    version: z.ZodLiteral<1>;
+    entries: z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
+        id: z.ZodString;
+        version: z.ZodString;
+        name: z.ZodObject<{
+            sv: z.ZodString;
+            en: z.ZodString;
+        }, z.core.$strict>;
+        description: z.ZodObject<{
+            sv: z.ZodString;
+            en: z.ZodString;
+        }, z.core.$strict>;
+        artifact: z.ZodObject<{
+            url: z.ZodString;
+            sha512: z.ZodString;
+            bytes: z.ZodOptional<z.ZodInt>;
+        }, z.core.$strict>;
+        homepage: z.ZodOptional<z.ZodString>;
+        deprecated: z.ZodDefault<z.ZodBoolean>;
+        type: z.ZodLiteral<"plugin">;
+        packageName: z.ZodString;
+        apiVersion: z.ZodInt;
+        permissions: z.ZodDefault<z.ZodArray<z.ZodEnum<{
+            "addressBook:read": "addressBook:read";
+            "addressBook:readContact": "addressBook:readContact";
+            "jobs:schedule": "jobs:schedule";
+            "mail:send": "mail:send";
+            "sms:send": "sms:send";
+        }>>>;
+        personalData: z.ZodDefault<z.ZodArray<z.ZodEnum<{
+            apartment: "apartment";
+            email: "email";
+            name: "name";
+            phone: "phone";
+            residency: "residency";
+        }>>>;
+        actions: z.ZodDefault<z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            capability: z.ZodString;
+            effect: z.ZodEnum<{
+                delete: "delete";
+                read: "read";
+                write: "write";
+            }>;
+            personalData: z.ZodDefault<z.ZodArray<z.ZodEnum<{
+                account: "account";
+                apartment: "apartment";
+                auditTrail: "auditTrail";
+                email: "email";
+                financial: "financial";
+                freeText: "freeText";
+                health: "health";
+                name: "name";
+                personalIdentityNumber: "personalIdentityNumber";
+                phone: "phone";
+                photograph: "photograph";
+                postalAddress: "postalAddress";
+                protected: "protected";
+                residency: "residency";
+            }>>>;
+            surfaces: z.ZodDefault<z.ZodArray<z.ZodEnum<{
+                ai: "ai";
+                mcp: "mcp";
+                ui: "ui";
+            }>>>;
+        }, z.core.$strict>>>;
+        oauthProtectedResource: z.ZodOptional<z.ZodString>;
+    }, z.core.$strict>, z.ZodObject<{
+        id: z.ZodString;
+        version: z.ZodString;
+        name: z.ZodObject<{
+            sv: z.ZodString;
+            en: z.ZodString;
+        }, z.core.$strict>;
+        description: z.ZodObject<{
+            sv: z.ZodString;
+            en: z.ZodString;
+        }, z.core.$strict>;
+        artifact: z.ZodObject<{
+            url: z.ZodString;
+            sha512: z.ZodString;
+            bytes: z.ZodOptional<z.ZodInt>;
+        }, z.core.$strict>;
+        homepage: z.ZodOptional<z.ZodString>;
+        deprecated: z.ZodDefault<z.ZodBoolean>;
+        type: z.ZodLiteral<"theme">;
+        contract: z.ZodOptional<z.ZodString>;
+        extends: z.ZodOptional<z.ZodString>;
+    }, z.core.$strict>], "type">>;
+}, z.core.$strict>;
+export type Catalog = z.infer<typeof catalogSchema>;
+export type CatalogParseResult = {
+    ok: true;
+    value: Catalog;
+} | {
+    ok: false;
+    issues: readonly string[];
+};
+/**
+ * Parses a catalog index.
+ *
+ * A single malformed entry rejects the whole index rather than being dropped
+ * quietly. A board that installs from a catalog which silently lost an entry
+ * has no way to tell that from an entry that was delisted on purpose, and the
+ * two mean opposite things.
+ *
+ * Returns a result rather than throwing, as `parsePluginPackage` does, so a
+ * catalog's own check can list every problem at once.
+ */
+export declare function parseCatalogIndex(input: unknown): CatalogParseResult;
+export {};
+//# sourceMappingURL=catalog.d.ts.map

package/dist/catalog.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"catalog.d.ts","sourceRoot":"","sources":["../src/catalog.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAqDxB,uDAAuD;AACvD,eAAO,MAAM,qBAAqB;;;;kBAyBhC,CAAC;AAEH,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAC;AAEpE,2EAA2E;AAC3E,QAAA,MAAM,mBAAmB;;;kBAGvB,CAAC;AAEH,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAmBhE,eAAO,MAAM,wBAAwB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBA6CnC,CAAC;AAEH;;;;;;;GAOG;AACH,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;;;;;;;;;kBAMlC,CAAC;AAEH,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;4BAG7B,CAAC;AAEH,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAC;AAC1E,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAC;AACxE,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAE9D,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBA0BtB,CAAC;AAEL,MAAM,MAAM,OAAO,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,CAAC;AAEpD,MAAM,MAAM,kBAAkB,GAC5B;IAAE,EAAE,EAAE,IAAI,CAAC;IAAC,KAAK,EAAE,OAAO,CAAA;CAAE,GAAG;IAAE,EAAE,EAAE,KAAK,CAAC;IAAC,MAAM,EAAE,SAAS,MAAM,EAAE,CAAA;CAAE,CAAC;AAE1E;;;;;;;;;;GAUG;AACH,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,OAAO,GAAG,kBAAkB,CAWpE"}

package/dist/catalog.js

@@ -0,0 +1,203 @@
+import { z } from "zod";
+import { IntegrityError, parseSha512 } from "./integrity.js";
+import { declaredActionsSchema, pluginActionSchema, pluginIdSchema, pluginManifestSchema, } from "./manifest.js";
+import { PLUGIN_PERMISSIONS, PLUGIN_PERSONAL_DATA_CATEGORIES, } from "./permissions.js";
+/**
+ * The catalog index.
+ *
+ * One file listing everything an instance may install: plugins and themes
+ * alike, since both are distributed the same way and the board browses one
+ * screen per kind rather than one source per kind. Delisting is a commit
+ * against the index, which is why an instance re-reads it rather than caching
+ * it across installs.
+ *
+ * Exported so the index is checked by the same schema wherever it is read: by
+ * the instance before it offers an entry to a board, and by the catalog's own
+ * check before a listing is merged.
+ *
+ * Entries are parsed strictly. The index arrives over the network, and an
+ * entry the instance does not fully understand is an entry it must not offer
+ * to a board for consent - the consent screen's whole job is to say precisely
+ * what is being agreed to.
+ *
+ * Every object in it is strict as well: a field this version of the index does
+ * not define is refused, never dropped. Dropped, a misspelled field of the
+ * declaration would be replaced by its default before the consent screen or
+ * any check of the manifest saw it. The index carries its version for exactly
+ * this, so a new field is a new index version rather than a key an older
+ * instance ignores.
+ */
+/** Whether `declared` is a digest `parseSha512` can read. */
+function isReadableSha512(declared) {
+    try {
+        parseSha512(declared);
+        return true;
+    }
+    catch (error) {
+        if (error instanceof IntegrityError) {
+            return false;
+        }
+        throw error;
+    }
+}
+/** A tarball and the digest its bytes must hash to. */
+export const catalogArtifactSchema = z.strictObject({
+    /**
+     * Direct URL.
+     *
+     * https on a curated instance, and nothing else: the shape is checked here
+     * but the destination is decided at fetch time, where http: and file: are
+     * refused unless the instance has opted out of curation. That is what keeps
+     * an entry - which is data fetched from elsewhere - from naming a `file:`
+     * path and having the instance read its own disk, or a plain-http address
+     * inside the network the instance sits in.
+     */
+    url: z.string().min(1).max(2000),
+    /**
+     * "sha512-<base64>" or 128 hex characters.
+     *
+     * Read through the same `parseSha512` the instance verifies a download with,
+     * so an entry the catalog's check lets through is one the instance can read,
+     * and an index with a badly spelled digest is refused by `parseCatalogIndex`
+     * alone.
+     */
+    sha512: z.string().min(1).max(200).refine(isReadableSha512, {
+        error: 'Expected a digest written as "sha512-<base64>" or 128 hex characters.',
+    }),
+    bytes: z.int().min(1).optional(),
+});
+/** Text a curator writes in both languages the interface is offered in. */
+const localizedTextSchema = z.strictObject({
+    sv: z.string().min(1).max(500),
+    en: z.string().min(1).max(500),
+});
+/** Strict, and `.extend()` keeps it so for both kinds of entry. */
+const baseEntrySchema = z.strictObject({
+    /**
+     * Unique across the whole index, whatever the entry's type: an install
+     * looks an entry up by id alone.
+     */
+    id: pluginIdSchema,
+    version: z.string().min(1).max(64),
+    /** The curator's text, in both languages the interface is offered in. */
+    name: localizedTextSchema,
+    description: localizedTextSchema,
+    artifact: catalogArtifactSchema,
+    homepage: z.string().max(2000).optional(),
+    /** Set on an entry that is still listed but should not be installed anew. */
+    deprecated: z.boolean().default(false),
+});
+export const catalogPluginEntrySchema = baseEntrySchema.extend({
+    type: z.literal("plugin"),
+    /**
+     * The npm package name the tarball unpacks as. Needed because the installer
+     * writes a dependency set for npm, which keys on the package name and not on
+     * the catalog id.
+     */
+    packageName: z.string().min(1).max(214),
+    /** Gated against the host's own contract version before an install starts. */
+    apiVersion: z.int().min(1),
+    /**
+     * Repeated from the plugin's manifest so the consent screen can be shown
+     * before anything is downloaded. The installed manifest is authoritative:
+     * the loader compares the two and refuses a plugin that asks for more than
+     * the board consented to.
+     */
+    permissions: z.array(z.enum(PLUGIN_PERMISSIONS)).max(16).default([]),
+    personalData: z
+        .array(z.enum(PLUGIN_PERSONAL_DATA_CATEGORIES))
+        .max(16)
+        .default([]),
+    /**
+     * The actions the plugin proposes, on the same terms as the two above.
+     *
+     * The widest part of the declaration, and so the part the consent screen
+     * most needs before anything is downloaded: an action names a capability and
+     * offers it to callers the board decides on.
+     *
+     * The manifest's own action fields and its own uniqueness rule, not a
+     * second array of the same thing: the rule on the ids has to hold at
+     * whichever boundary is read first, and two copies is two places for it to
+     * stop holding. Read strictly here, as everything in the index is.
+     */
+    actions: declaredActionsSchema(pluginActionSchema.strict()).default([]),
+    /**
+     * The route that serves MCP, repeated on the same terms as the three above.
+     *
+     * Both rules about it are decided before anything is downloaded - a second
+     * plugin declaring it is refused, and the reserved id `mcp-connector` may be
+     * taken only by a plugin that does declare it - so the index has to carry it.
+     * The manifest's own field schema rather than a second spelling of it: the
+     * value becomes a URL an unauthenticated caller is pointed at, and one
+     * definition of what it may contain is the point of that schema.
+     */
+    oauthProtectedResource: pluginManifestSchema.shape.oauthProtectedResource,
+});
+/**
+ * A theme entry. Themes install through the same download-and-verify path and
+ * are listed in the same index; what happens after the bytes are verified is
+ * the theme installer's business, not this schema's.
+ *
+ * No package name: a theme is data read out of its archive, never an npm
+ * package, and nothing that installs one keys on a package name.
+ */
+export const catalogThemeEntrySchema = baseEntrySchema.extend({
+    type: z.literal("theme"),
+    /** The token contract range the theme was authored against. */
+    contract: z.string().min(1).max(64).optional(),
+    /** The theme it inherits from, as its manifest names it. */
+    extends: z.string().min(1).max(64).optional(),
+});
+export const catalogEntrySchema = z.discriminatedUnion("type", [
+    catalogPluginEntrySchema,
+    catalogThemeEntrySchema,
+]);
+export const catalogSchema = z
+    .strictObject({
+    /** Index format version, so a future shape can be recognised and refused. */
+    version: z.literal(1),
+    entries: z.array(catalogEntrySchema).max(500),
+})
+    .superRefine((catalog, ctx) => {
+    /*
+     * An id names one entry in the whole index, not one per type. An install
+     * finds its entry by id and then refuses one of the wrong type, so a theme
+     * sharing a plugin's id would leave that plugin impossible to install, and
+     * which of the two a board got would depend on the order of the file.
+     */
+    const firstIndexById = new Map();
+    for (const [index, entry] of catalog.entries.entries()) {
+        const first = firstIndexById.get(entry.id);
+        if (first === undefined) {
+            firstIndexById.set(entry.id, index);
+            continue;
+        }
+        ctx.addIssue({
+            code: "custom",
+            path: ["entries", index, "id"],
+            message: `"${entry.id}" is already the id of entry ${String(first)}; an id appears once in the index`,
+        });
+    }
+});
+/**
+ * Parses a catalog index.
+ *
+ * A single malformed entry rejects the whole index rather than being dropped
+ * quietly. A board that installs from a catalog which silently lost an entry
+ * has no way to tell that from an entry that was delisted on purpose, and the
+ * two mean opposite things.
+ *
+ * Returns a result rather than throwing, as `parsePluginPackage` does, so a
+ * catalog's own check can list every problem at once.
+ */
+export function parseCatalogIndex(input) {
+    const result = catalogSchema.safeParse(input);
+    if (result.success) {
+        return { ok: true, value: result.data };
+    }
+    return {
+        ok: false,
+        issues: result.error.issues.map((issue) => `${issue.path.join(".") || "(root)"}: ${issue.message}`),
+    };
+}
+//# sourceMappingURL=catalog.js.map

package/dist/catalog.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"catalog.js","sourceRoot":"","sources":["../src/catalog.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7D,OAAO,EACL,qBAAqB,EACrB,kBAAkB,EAClB,cAAc,EACd,oBAAoB,GACrB,MAAM,eAAe,CAAC;AACvB,OAAO,EACL,kBAAkB,EAClB,+BAA+B,GAChC,MAAM,kBAAkB,CAAC;AAE1B;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AAEH,6DAA6D;AAC7D,SAAS,gBAAgB,CAAC,QAAgB;IACxC,IAAI,CAAC;QACH,WAAW,CAAC,QAAQ,CAAC,CAAC;QACtB,OAAO,IAAI,CAAC;IACd,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,YAAY,cAAc,EAAE,CAAC;YACpC,OAAO,KAAK,CAAC;QACf,CAAC;QACD,MAAM,KAAK,CAAC;IACd,CAAC;AACH,CAAC;AAED,uDAAuD;AACvD,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,CAAC,YAAY,CAAC;IAClD;;;;;;;;;OASG;IACH,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC;IAChC;;;;;;;OAOG;IACH,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,gBAAgB,EAAE;QAC1D,KAAK,EACH,uEAAuE;KAC1E,CAAC;IACF,KAAK,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE;CACjC,CAAC,CAAC;AAIH,2EAA2E;AAC3E,MAAM,mBAAmB,GAAG,CAAC,CAAC,YAAY,CAAC;IACzC,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC;IAC9B,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC;CAC/B,CAAC,CAAC;AAIH,mEAAmE;AACnE,MAAM,eAAe,GAAG,CAAC,CAAC,YAAY,CAAC;IACrC;;;OAGG;IACH,EAAE,EAAE,cAAc;IAClB,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC;IAClC,yEAAyE;IACzE,IAAI,EAAE,mBAAmB;IACzB,WAAW,EAAE,mBAAmB;IAChC,QAAQ,EAAE,qBAAqB;IAC/B,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE;IACzC,6EAA6E;IAC7E,UAAU,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC;CACvC,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,wBAAwB,GAAG,eAAe,CAAC,MAAM,CAAC;IAC7D,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC;IACzB;;;;OAIG;IACH,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC;IACvC,8EAA8E;IAC9E,UAAU,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IAC1B;;;;;OAKG;IACH,WAAW,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC;IACpE,YAAY,EAAE,CAAC;SACZ,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,+BAA+B,CAAC,CAAC;SAC9C,GAAG,CAAC,EAAE,CAAC;SACP,OAAO,CAAC,EAAE,CAAC;IACd;;;;;;;;;;;OAWG;IACH,OAAO,EAAE,qBAAqB,CAAC,kBAAkB,CAAC,MAAM,EAAE,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC;IACvE;;;;;;;;;OASG;IACH,sBAAsB,EAAE,oBAAoB,CAAC,KAAK,CAAC,sBAAsB;CAC1E,CAAC,CAAC;AAEH;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,eAAe,CAAC,MAAM,CAAC;IAC5D,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC;IACxB,+DAA+D;IAC/D,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,QAAQ,EAAE;IAC9C,4DAA4D;IAC5D,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,QAAQ,EAAE;CAC9C,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,CAAC,kBAAkB,CAAC,MAAM,EAAE;IAC7D,wBAAwB;IACxB,uBAAuB;CACxB,CAAC,CAAC;AAMH,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC;KAC3B,YAAY,CAAC;IACZ,6EAA6E;IAC7E,OAAO,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;IACrB,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC;CAC9C,CAAC;KACD,WAAW,CAAC,CAAC,OAAO,EAAE,GAAG,EAAE,EAAE;IAC5B;;;;;OAKG;IACH,MAAM,cAAc,GAAG,IAAI,GAAG,EAAkB,CAAC;IACjD,KAAK,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,IAAI,OAAO,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC;QACvD,MAAM,KAAK,GAAG,cAAc,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QAC3C,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,cAAc,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;YACpC,SAAS;QACX,CAAC;QACD,GAAG,CAAC,QAAQ,CAAC;YACX,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,CAAC,SAAS,EAAE,KAAK,EAAE,IAAI,CAAC;YAC9B,OAAO,EAAE,IAAI,KAAK,CAAC,EAAE,gCAAgC,MAAM,CAAC,KAAK,CAAC,mCAAmC;SACtG,CAAC,CAAC;IACL,CAAC;AACH,CAAC,CAAC,CAAC;AAOL;;;;;;;;;;GAUG;AACH,MAAM,UAAU,iBAAiB,CAAC,KAAc;IAC9C,MAAM,MAAM,GAAG,aAAa,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;IAC9C,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;QACnB,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,CAAC,IAAI,EAAE,CAAC;IAC1C,CAAC;IACD,OAAO;QACL,EAAE,EAAE,KAAK;QACT,MAAM,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAC7B,CAAC,KAAK,EAAE,EAAE,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,QAAQ,KAAK,KAAK,CAAC,OAAO,EAAE,CACnE;KACF,CAAC;AACJ,CAAC"}

package/dist/define-plugin.d.ts

@@ -0,0 +1,14 @@
+import type { PluginModuleFactory } from "./module.ts";
+/**
+ * Declares a plugin's server entry point.
+ *
+ * Deliberately an identity function. ADR 0003 requires a plugin to ship a
+ * prebuilt CJS bundle whose only externals are host packages, so anything
+ * this helper did at runtime would either have to be bundled into every
+ * plugin or would make the SDK a runtime dependency the host has to resolve
+ * for it. Being identity means a bundler inlines it to nothing and the value
+ * the helper adds - the type of the factory, checked at the author's build
+ * time - costs the running instance nothing.
+ */
+export declare function definePlugin(factory: PluginModuleFactory): PluginModuleFactory;
+//# sourceMappingURL=define-plugin.d.ts.map

package/dist/define-plugin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"define-plugin.d.ts","sourceRoot":"","sources":["../src/define-plugin.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC;AAEvD;;;;;;;;;;GAUG;AACH,wBAAgB,YAAY,CAC1B,OAAO,EAAE,mBAAmB,GAC3B,mBAAmB,CAErB"}

package/dist/define-plugin.js

@@ -0,0 +1,15 @@
+/**
+ * Declares a plugin's server entry point.
+ *
+ * Deliberately an identity function. ADR 0003 requires a plugin to ship a
+ * prebuilt CJS bundle whose only externals are host packages, so anything
+ * this helper did at runtime would either have to be bundled into every
+ * plugin or would make the SDK a runtime dependency the host has to resolve
+ * for it. Being identity means a bundler inlines it to nothing and the value
+ * the helper adds - the type of the factory, checked at the author's build
+ * time - costs the running instance nothing.
+ */
+export function definePlugin(factory) {
+    return factory;
+}
+//# sourceMappingURL=define-plugin.js.map

package/dist/define-plugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"define-plugin.js","sourceRoot":"","sources":["../src/define-plugin.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;AACH,MAAM,UAAU,YAAY,CAC1B,OAA4B;IAE5B,OAAO,OAAO,CAAC;AACjB,CAAC"}

package/dist/findings.d.ts

@@ -0,0 +1,67 @@
+/**
+ * Why a plugin on the data volume is not running.
+ *
+ * A finding travels as one of these codes plus the values its sentence needs,
+ * never as a sentence composed by the host. The interface is Swedish by
+ * default and this package is English, so what a board reads has to be a
+ * translation of the code: a sentence written where the finding is produced
+ * reaches the board panel in the language the server happens to be written in.
+ *
+ * Listed as values rather than as a bare union so a caller can walk them and
+ * prove it has a sentence for each. Part of the contract rather than an
+ * implementation detail - docs/plugin-contract.md lists the same set, and a
+ * plugin author reading why their package was skipped is reading one of these.
+ */
+export declare const PLUGIN_FINDING_REASONS: readonly [
+/** The `openbrf` field failed validation. */
+"manifest-invalid", 
+/** Built against a contract version this instance does not implement. */
+"api-version-unsupported", 
+/** A declared entry file is not in the package. */
+"entry-missing", 
+/** The server bundle does not export `createPlugin`. */
+"entry-invalid", 
+/** `createPlugin` returned no NestJS dynamic module. */
+"module-invalid", 
+/** Its module declares behaviour a plugin may not register. */
+"module-refused", 
+/** Its module could not be built into the application. */
+"module-failed", 
+/** The package carries its own copy of a host package it must share. */
+"module-identity", 
+/** It asks for more than was consented to. */
+"permissions-widened", 
+/** It handles a personal-data category that was not consented to. */
+"personal-data-widened", 
+/** On the volume with no record of consent. */
+"not-consented", 
+/** Switched off in the admin interface. */
+"disabled", 
+/** It threw while being loaded. */
+"load-failed", 
+/** Recorded as installed but not present. */
+"not-on-volume", 
+/** The installed version declares an action the board did not consent to. */
+"actions-widened", 
+/** An action the manifest declares could not be registered. */
+"action-refused", 
+/** One of its providers reaches for a core service a plugin may not hold. */
+"forbidden-injection", 
+/**
+ * It declares the OAuth protected resource, and another installed plugin
+ * already does. The one installed first keeps it: the resource URL is the
+ * audience every issued token carries, so moving it would strand them all.
+ */
+"oauth-resource-conflict"];
+export type PluginFindingReason = (typeof PLUGIN_FINDING_REASONS)[number];
+/**
+ * The values a finding's sentence is completed with.
+ *
+ * Identifiers, paths, numbers and what a thrown error said - never a sentence,
+ * and never personal data. A list stays a list rather than being joined here,
+ * because its members can have sentences of their own: a board told that a
+ * package handles a category it never agreed to has to read that category in
+ * its own language, not as `residency`.
+ */
+export type PluginFindingDetail = Readonly<Record<string, string | number | readonly string[]>>;
+//# sourceMappingURL=findings.d.ts.map

package/dist/findings.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"findings.d.ts","sourceRoot":"","sources":["../src/findings.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,sBAAsB;AACjC,6CAA6C;AAC7C,kBAAkB;AAClB,yEAAyE;AACzE,yBAAyB;AACzB,mDAAmD;AACnD,eAAe;AACf,wDAAwD;AACxD,eAAe;AACf,wDAAwD;AACxD,gBAAgB;AAChB,+DAA+D;AAC/D,gBAAgB;AAChB,0DAA0D;AAC1D,eAAe;AACf,wEAAwE;AACxE,iBAAiB;AACjB,8CAA8C;AAC9C,qBAAqB;AACrB,qEAAqE;AACrE,uBAAuB;AACvB,+CAA+C;AAC/C,eAAe;AACf,2CAA2C;AAC3C,UAAU;AACV,mCAAmC;AACnC,aAAa;AACb,6CAA6C;AAC7C,eAAe;AACf,6EAA6E;AAC7E,iBAAiB;AACjB,+DAA+D;AAC/D,gBAAgB;AAChB,6EAA6E;AAC7E,qBAAqB;AACrB;;;;GAIG;AACH,yBAAyB,CACjB,CAAC;AAEX,MAAM,MAAM,mBAAmB,GAAG,CAAC,OAAO,sBAAsB,CAAC,CAAC,MAAM,CAAC,CAAC;AAE1E;;;;;;;;GAQG;AACH,MAAM,MAAM,mBAAmB,GAAG,QAAQ,CACxC,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,MAAM,EAAE,CAAC,CACpD,CAAC"}