@openbrf/plugin-sdk 1.0.0 → 1.2.0

package/dist/catalog.js

@@ -1,7 +1,9 @@
 import { z } from "zod";
 import { IntegrityError, parseSha512 } from "./integrity.js";
-import { declaredActionsSchema, pluginActionSchema, pluginIdSchema, pluginManifestSchema, } from "./manifest.js";
+import { localizedTextSchema } from "./localized-text.js";
+import { declaredActionsSchema, declaredExtensionPointsSchema, declaredExtensionsSchema, extensionGroupRefusals, extensionHostPersonalDataRefused, extensionPermissionsRefused, extensionPointRefusal, extensionRuleIssues, pluginExtensionPointSchema, pluginExtensionSchema, declaredDeviceRoutesSchema, deviceRouteRuleIssues, pluginActionSchema, pluginDeviceRouteSchema, pluginIdSchema, pluginManifestSchema, proposeImportPersonalDataIssues, } from "./manifest.js";
 import { PLUGIN_PERMISSIONS, PLUGIN_PERSONAL_DATA_CATEGORIES, } from "./permissions.js";
+import { declaredRecipientsSchema, pluginRecipientSchema, recipientCategoryIssues, } from "./recipients.js";
 /**
  * The catalog index.
  *
@@ -66,11 +68,20 @@ export const catalogArtifactSchema = z.strictObject({
     }),
     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),
-});
+/**
+ * An extension point as the index lists it: the manifest's fields, and the
+ * curator's title and description in both languages.
+ *
+ * The text is the curator's rather than the plugin's own, as an entry's `name`
+ * is, because an addon's consent screen has to name the point before the host
+ * plugin's locale files exist on the instance (ADR 0030).
+ */
+export const catalogExtensionPointSchema = pluginExtensionPointSchema
+    .extend({
+    title: localizedTextSchema,
+    description: localizedTextSchema,
+})
+    .strict();
 /** Strict, and `.extend()` keeps it so for both kinds of entry. */
 const baseEntrySchema = z.strictObject({
     /**
@@ -87,7 +98,8 @@ const baseEntrySchema = z.strictObject({
     /** Set on an entry that is still listed but should not be installed anew. */
     deprecated: z.boolean().default(false),
 });
-export const catalogPluginEntrySchema = baseEntrySchema.extend({
+export const catalogPluginEntrySchema = baseEntrySchema
+    .extend({
     type: z.literal("plugin"),
     /**
      * The npm package name the tarball unpacks as. Needed because the installer
@@ -132,6 +144,86 @@ export const catalogPluginEntrySchema = baseEntrySchema.extend({
      * definition of what it may contain is the point of that schema.
      */
     oauthProtectedResource: pluginManifestSchema.shape.oauthProtectedResource,
+    /**
+     * The extension points the plugin offers, repeated from the manifest with
+     * the curator's text, so the host plugin's consent screen can say what its
+     * points accept before anything is downloaded (ADR 0030).
+     *
+     * In version 2 of the index only; see `catalogSchema`. Left without a
+     * default, so that a version 1 index carrying the key, even empty, can be
+     * told from one that does not.
+     */
+    extensionPoints: declaredExtensionPointsSchema(catalogExtensionPointSchema).optional(),
+    /**
+     * The extension points of other plugins it extends, repeated on the same
+     * terms, so an addon's consent screen can say what it extends and what it
+     * hands over. Version 2 only.
+     */
+    extends: declaredExtensionsSchema(pluginExtensionSchema.strict()).optional(),
+    /**
+     * Where the plugin connects to, repeated on the same terms as the
+     * declaration above it (ADR 0037).
+     *
+     * A field version 1 of the index does not define, so only an index of
+     * version 2 may carry it, and an index of version 1 that does is refused.
+     * Absent rather than defaulted, so that rule can tell an entry that left it
+     * out from one that declared none; a reader takes absent as none.
+     */
+    recipients: declaredRecipientsSchema(pluginRecipientSchema.strict()).optional(),
+    /**
+     * The routes a device reaches with a device token, repeated on the same
+     * terms (ADR 0031).
+     *
+     * The consent screen names them - "can be reached by devices holding a token
+     * the board issues" - before anything is downloaded. In version 2 of the
+     * index only; see `catalogSchema`. Left without a default, so that a version 1
+     * index carrying the key, even empty, can be told from one that does not.
+     */
+    deviceRoutes: declaredDeviceRoutesSchema(pluginDeviceRouteSchema.strict()).optional(),
+    /**
+     * That the plugin is an AI package, repeated on the same terms.
+     *
+     * It decides what the plugin's dispatch reaches and how the audit log names
+     * its writes, so the board reads it on the consent screen, and the install
+     * echo compares it, before anything is downloaded.
+     *
+     * Added within version 1 of the index rather than as a new version, because
+     * absent means the same as false: an index that lists no AI package need not
+     * carry the field and stays one an older instance reads. One that lists an
+     * AI package is refused whole by an older instance, which is the rule above
+     * doing its work - that instance would otherwise offer the plugin for
+     * consent without saying what it is, and dispatch it as a plain plugin.
+     */
+    ai: pluginManifestSchema.shape.ai,
+    /**
+     * The licence a paid plugin reads, repeated on the same terms (ADR 0042).
+     *
+     * Above all its `audiences`: the services the plugin may present the
+     * association's licence to are a grant the board consents to, as it does
+     * `permissions`, so the consent screen states them and the install echo
+     * compares them before anything is downloaded. The manifest's own strict
+     * schema, so a misspelled field is refused here as it is there.
+     *
+     * Added within version 1 of the index on the `ai` field's terms: absent
+     * means the plugin reads no licence, and an index that lists a licensed
+     * plugin is refused whole by an instance from before the field.
+     */
+    licence: pluginManifestSchema.shape.licence,
+    /**
+     * The day the release was published, which the update screen compares with
+     * the `updatesUntil` of the licence the instance holds. Required with
+     * `licence`, as in the manifest.
+     */
+    released: pluginManifestSchema.shape.released,
+})
+    .superRefine((entry, ctx) => {
+    if (entry.licence !== undefined && entry.released === undefined) {
+        ctx.addIssue({
+            code: "custom",
+            path: ["released"],
+            message: "an entry that declares a licence must say when it was released",
+        });
+    }
 });
 /**
  * A theme entry. Themes install through the same download-and-verify path and
@@ -152,13 +244,226 @@ export const catalogEntrySchema = z.discriminatedUnion("type", [
     catalogPluginEntrySchema,
     catalogThemeEntrySchema,
 ]);
+/**
+ * The index versions this package reads.
+ *
+ * Version 2 adds the fields ADR 0030 lists: `extensionPoints` and `extends`
+ * (ADR 0030), `recipients` (ADR 0037) and `deviceRoutes` (ADR 0031). An
+ * instance reads both, and the catalog serves version 1, without the entries
+ * that need version 2, to instances that have not upgraded.
+ */
+export const CATALOG_INDEX_VERSIONS = [1, 2];
 export const catalogSchema = z
     .strictObject({
     /** Index format version, so a future shape can be recognised and refused. */
-    version: z.literal(1),
+    version: z.literal(CATALOG_INDEX_VERSIONS),
     entries: z.array(catalogEntrySchema).max(500),
 })
     .superRefine((catalog, ctx) => {
+    const plugins = new Map();
+    const pluginIndex = new Map();
+    for (const [index, entry] of catalog.entries.entries()) {
+        if (entry.type === "plugin" && !plugins.has(entry.id)) {
+            plugins.set(entry.id, entry);
+            pluginIndex.set(entry.id, index);
+        }
+    }
+    /** The addons already refused beside a plugin they extend. */
+    const pairRefused = new Set();
+    for (const [index, entry] of catalog.entries.entries()) {
+        if (entry.type !== "plugin") {
+            continue;
+        }
+        // The manifest's rule, so an entry the loader would refuse is never
+        // offered for consent.
+        for (const issue of proposeImportPersonalDataIssues(entry)) {
+            ctx.addIssue({
+                code: "custom",
+                path: ["entries", index, "personalData"],
+                message: issue.message,
+            });
+        }
+        /*
+         * A field version 1 does not define is refused there as any unknown key
+         * is, so an older instance and this one read the same index the same
+         * way.
+         */
+        if (catalog.version === 1) {
+            for (const field of [
+                "extensionPoints",
+                "extends",
+                "deviceRoutes",
+            ]) {
+                if (entry[field] !== undefined) {
+                    ctx.addIssue({
+                        code: "custom",
+                        path: ["entries", index, field],
+                        message: `${field} needs version 2 of the index`,
+                    });
+                }
+            }
+            continue;
+        }
+        // The manifest's own rules, so an entry whose own declaration breaks
+        // one is never offered for consent.
+        for (const issue of extensionRuleIssues({
+            id: entry.id,
+            permissions: entry.permissions,
+            personalData: entry.personalData,
+            extensionPoints: entry.extensionPoints ?? [],
+            extends: entry.extends ?? [],
+        })) {
+            ctx.addIssue({
+                code: "custom",
+                path: ["entries", index, ...issue.path],
+                message: issue.message,
+            });
+        }
+        for (const issue of deviceRouteRuleIssues({
+            deviceRoutes: entry.deviceRoutes ?? [],
+            oauthProtectedResource: entry.oauthProtectedResource,
+            permissions: entry.permissions,
+        })) {
+            ctx.addIssue({
+                code: "custom",
+                path: ["entries", index, ...issue.path],
+                message: issue.message,
+            });
+        }
+        /*
+         * The rule between an addon and a plugin it extends, where the index
+         * lists both, read from the two entries. One it does not list is held to
+         * it by the loader, which reads the installed manifests, as it holds
+         * one it lists.
+         */
+        for (const [position, extension] of (entry.extends ?? []).entries()) {
+            const host = plugins.get(extension.plugin);
+            if (host === undefined) {
+                continue;
+            }
+            const named = {
+                addon: entry.id,
+                plugin: extension.plugin,
+                point: extension.point,
+            };
+            const unserved = extensionPointRefusal(extension, host.extensionPoints ?? []);
+            if (unserved !== null) {
+                pairRefused.add(entry.id);
+                const { field, message, detail } = unservedIssue(extension, unserved);
+                ctx.addIssue({
+                    code: "custom",
+                    path: ["entries", index, "extends", position, field],
+                    message,
+                    params: {
+                        refusal: {
+                            code: unserved.reason,
+                            detail: { ...named, ...detail },
+                        },
+                    },
+                });
+                continue;
+            }
+            const refused = extensionPermissionsRefused(entry, host);
+            if (refused.length > 0) {
+                pairRefused.add(entry.id);
+                ctx.addIssue({
+                    code: "custom",
+                    path: ["entries", index, "extends", position, "plugin"],
+                    message: host.permissions.includes("site:blocks")
+                        ? `${extension.plugin} asks for "site:blocks", so a plugin that extends it may not read the register or propose imports: ${refused.join(", ")}`
+                        : `${extension.plugin} reads the register or proposes imports, so a plugin that asks for "site:blocks" may not extend it: ${refused.join(", ")}`,
+                    params: {
+                        refusal: {
+                            code: "extension-permission-refused",
+                            detail: { ...named, permissions: refused },
+                        },
+                    },
+                });
+                continue;
+            }
+            const categories = extensionHostPersonalDataRefused(entry, host);
+            if (categories.length > 0) {
+                pairRefused.add(entry.id);
+                ctx.addIssue({
+                    code: "custom",
+                    path: ["entries", index, "extends", position, "plugin"],
+                    message: `${extension.plugin} handles personal data, so a plugin that asks for "site:blocks" may not extend it: ${categories.join(", ")}`,
+                    params: {
+                        refusal: {
+                            code: "extension-host-personal-data-refused",
+                            detail: { ...named, categories },
+                        },
+                    },
+                });
+            }
+        }
+    }
+    /*
+     * And the rule on the plugins joined by extensions, among those the index
+     * lists, as the loader reads it: beside the addons the rule above has not
+     * already refused.
+     */
+    if (catalog.version === 2) {
+        const members = [...plugins.values()]
+            .filter((entry) => !pairRefused.has(entry.id))
+            .map((entry) => ({
+            id: entry.id,
+            permissions: entry.permissions,
+            extends: entry.extends ?? [],
+        }));
+        for (const [id, refusal] of extensionGroupRefusals(members)) {
+            ctx.addIssue({
+                code: "custom",
+                path: ["entries", pluginIndex.get(id) ?? 0, "extends"],
+                message: `the plugins it is joined to by extensions would hold one that asks for "site:blocks" (${refusal.website.join(", ")}) and one that reads the register or proposes imports (${refusal.register.join(", ")})`,
+                params: {
+                    refusal: {
+                        code: "extension-group-refused",
+                        detail: {
+                            addon: id,
+                            website: refusal.website,
+                            register: refusal.register,
+                        },
+                    },
+                },
+            });
+        }
+    }
+    /*
+     * A field is in the version that defines it and in no earlier one: an
+     * instance that reads only version 1 would refuse the entry, and an index
+     * claiming version 1 while carrying it is not one such an instance could
+     * read.
+     */
+    if (catalog.version === 1) {
+        for (const [index, entry] of catalog.entries.entries()) {
+            if (entry.type === "plugin" && entry.recipients !== undefined) {
+                ctx.addIssue({
+                    code: "custom",
+                    path: ["entries", index, "recipients"],
+                    message: "recipients is not in version 1 of the index; an entry that declares them is listed in version 2",
+                });
+            }
+        }
+    }
+    /*
+     * The manifest's rule on what a recipient may receive, so an entry the
+     * loader would refuse is not offered for consent with a category the
+     * plugin does not declare it handles. The comparison with the installed
+     * manifest comes later; this holds the entry to itself.
+     */
+    for (const [index, entry] of catalog.entries.entries()) {
+        if (entry.type !== "plugin" || entry.recipients === undefined) {
+            continue;
+        }
+        for (const issue of recipientCategoryIssues(entry.recipients, entry.personalData)) {
+            ctx.addIssue({
+                code: "custom",
+                path: ["entries", index, ...issue.path],
+                message: issue.message,
+            });
+        }
+    }
     /*
      * 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
@@ -179,6 +484,24 @@ export const catalogSchema = z
         });
     }
 });
+/**
+ * The refusals of an index that its reader is told in their own language.
+ *
+ * What the schema says about one entry's field is English for the catalog's
+ * curator, who fixes the index from it. These hold one entry against another,
+ * an addon against the plugin it extends or against the plugins joined to it,
+ * and are the loader's own refusals of the same pair, under the same codes. So
+ * the refusal carries its code and the values its sentence is completed with
+ * beside the English line, and whoever shows it translates the code.
+ */
+export const CATALOG_REFUSALS = [
+    "extension-point-unknown",
+    "extension-version-unsupported",
+    "extension-personal-data-refused",
+    "extension-permission-refused",
+    "extension-host-personal-data-refused",
+    "extension-group-refused",
+];
 /**
  * Parses a catalog index.
  *
@@ -195,9 +518,50 @@ export function parseCatalogIndex(input) {
     if (result.success) {
         return { ok: true, value: result.data };
     }
+    const diagnostics = result.error.issues.map((issue) => ({
+        issue: `${issue.path.join(".") || "(root)"}: ${issue.message}`,
+        refusal: catalogRefusalOf(issue),
+    }));
     return {
         ok: false,
-        issues: result.error.issues.map((issue) => `${issue.path.join(".") || "(root)"}: ${issue.message}`),
+        issues: diagnostics.map((diagnostic) => diagnostic.issue),
+        diagnostics,
     };
 }
+function catalogRefusalOf(issue) {
+    if (issue.code !== "custom" || typeof issue.params !== "object") {
+        return null;
+    }
+    const refusal = issue.params
+        ?.refusal;
+    return refusal !== undefined && CATALOG_REFUSALS.includes(refusal.code)
+        ? refusal
+        : null;
+}
+/** The field, the curator's line and the values of a point's refusal. */
+function unservedIssue(extension, unserved) {
+    switch (unserved.reason) {
+        case "extension-point-unknown":
+            return {
+                field: "point",
+                message: `${extension.plugin} declares no extension point "${extension.point}"`,
+                detail: {},
+            };
+        case "extension-version-unsupported":
+            return {
+                field: "version",
+                message: `"${extension.point}" of ${extension.plugin} is at version ${String(unserved.supported)}, not ${String(extension.version)}`,
+                detail: {
+                    version: extension.version,
+                    supported: unserved.supported,
+                },
+            };
+        case "extension-personal-data-refused":
+            return {
+                field: "personalData",
+                message: `"${extension.point}" of ${extension.plugin} does not accept ${unserved.categories.join(", ")}`,
+                detail: { categories: unserved.categories },
+            };
+    }
+}
 //# sourceMappingURL=catalog.js.map

package/dist/catalog.js.map

@@ -1 +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"}
+{"version":3,"file":"catalog.js","sourceRoot":"","sources":["../src/catalog.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7D,OAAO,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAC;AAC1D,OAAO,EACL,qBAAqB,EACrB,6BAA6B,EAC7B,wBAAwB,EACxB,sBAAsB,EACtB,gCAAgC,EAChC,2BAA2B,EAC3B,qBAAqB,EAErB,mBAAmB,EACnB,0BAA0B,EAC1B,qBAAqB,EACrB,0BAA0B,EAC1B,qBAAqB,EACrB,kBAAkB,EAClB,uBAAuB,EACvB,cAAc,EACd,oBAAoB,EACpB,+BAA+B,GAChC,MAAM,eAAe,CAAC;AACvB,OAAO,EACL,kBAAkB,EAClB,+BAA+B,GAChC,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EACL,wBAAwB,EACxB,qBAAqB,EACrB,uBAAuB,GACxB,MAAM,iBAAiB,CAAC;AAEzB;;;;;;;;;;;;;;;;;;;;;;;;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;AAMH;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,2BAA2B,GAAG,0BAA0B;KAClE,MAAM,CAAC;IACN,KAAK,EAAE,mBAAmB;IAC1B,WAAW,EAAE,mBAAmB;CACjC,CAAC;KACD,MAAM,EAAE,CAAC;AAIZ,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;KACpD,MAAM,CAAC;IACN,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;IACzE;;;;;;;;OAQG;IACH,eAAe,EAAE,6BAA6B,CAC5C,2BAA2B,CAC5B,CAAC,QAAQ,EAAE;IACZ;;;;OAIG;IACH,OAAO,EAAE,wBAAwB,CAC/B,qBAAqB,CAAC,MAAM,EAAE,CAC/B,CAAC,QAAQ,EAAE;IACZ;;;;;;;;OAQG;IACH,UAAU,EAAE,wBAAwB,CAClC,qBAAqB,CAAC,MAAM,EAAE,CAC/B,CAAC,QAAQ,EAAE;IACZ;;;;;;;;OAQG;IACH,YAAY,EAAE,0BAA0B,CACtC,uBAAuB,CAAC,MAAM,EAAE,CACjC,CAAC,QAAQ,EAAE;IACZ;;;;;;;;;;;;;OAaG;IACH,EAAE,EAAE,oBAAoB,CAAC,KAAK,CAAC,EAAE;IACjC;;;;;;;;;;;;OAYG;IACH,OAAO,EAAE,oBAAoB,CAAC,KAAK,CAAC,OAAO;IAC3C;;;;OAIG;IACH,QAAQ,EAAE,oBAAoB,CAAC,KAAK,CAAC,QAAQ;CAC9C,CAAC;KACD,WAAW,CAAC,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;IAC1B,IAAI,KAAK,CAAC,OAAO,KAAK,SAAS,IAAI,KAAK,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;QAChE,GAAG,CAAC,QAAQ,CAAC;YACX,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,CAAC,UAAU,CAAC;YAClB,OAAO,EACL,gEAAgE;SACnE,CAAC,CAAC;IACL,CAAC;AACH,CAAC,CAAC,CAAC;AAEL;;;;;;;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;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,CAAC,EAAE,CAAC,CAAU,CAAC;AAEtD,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC;KAC3B,YAAY,CAAC;IACZ,6EAA6E;IAC7E,OAAO,EAAE,CAAC,CAAC,OAAO,CAAC,sBAAsB,CAAC;IAC1C,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,MAAM,OAAO,GAAG,IAAI,GAAG,EAA8B,CAAC;IACtD,MAAM,WAAW,GAAG,IAAI,GAAG,EAAkB,CAAC;IAC9C,KAAK,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,IAAI,OAAO,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC;QACvD,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,CAAC;YACtD,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;YAC7B,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;QACnC,CAAC;IACH,CAAC;IACD,8DAA8D;IAC9D,MAAM,WAAW,GAAG,IAAI,GAAG,EAAU,CAAC;IACtC,KAAK,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,IAAI,OAAO,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC;QACvD,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC5B,SAAS;QACX,CAAC;QACD,oEAAoE;QACpE,uBAAuB;QACvB,KAAK,MAAM,KAAK,IAAI,+BAA+B,CAAC,KAAK,CAAC,EAAE,CAAC;YAC3D,GAAG,CAAC,QAAQ,CAAC;gBACX,IAAI,EAAE,QAAQ;gBACd,IAAI,EAAE,CAAC,SAAS,EAAE,KAAK,EAAE,cAAc,CAAC;gBACxC,OAAO,EAAE,KAAK,CAAC,OAAO;aACvB,CAAC,CAAC;QACL,CAAC;QACD;;;;WAIG;QACH,IAAI,OAAO,CAAC,OAAO,KAAK,CAAC,EAAE,CAAC;YAC1B,KAAK,MAAM,KAAK,IAAI;gBAClB,iBAAiB;gBACjB,SAAS;gBACT,cAAc;aACN,EAAE,CAAC;gBACX,IAAI,KAAK,CAAC,KAAK,CAAC,KAAK,SAAS,EAAE,CAAC;oBAC/B,GAAG,CAAC,QAAQ,CAAC;wBACX,IAAI,EAAE,QAAQ;wBACd,IAAI,EAAE,CAAC,SAAS,EAAE,KAAK,EAAE,KAAK,CAAC;wBAC/B,OAAO,EAAE,GAAG,KAAK,+BAA+B;qBACjD,CAAC,CAAC;gBACL,CAAC;YACH,CAAC;YACD,SAAS;QACX,CAAC;QACD,qEAAqE;QACrE,oCAAoC;QACpC,KAAK,MAAM,KAAK,IAAI,mBAAmB,CAAC;YACtC,EAAE,EAAE,KAAK,CAAC,EAAE;YACZ,WAAW,EAAE,KAAK,CAAC,WAAW;YAC9B,YAAY,EAAE,KAAK,CAAC,YAAY;YAChC,eAAe,EAAE,KAAK,CAAC,eAAe,IAAI,EAAE;YAC5C,OAAO,EAAE,KAAK,CAAC,OAAO,IAAI,EAAE;SAC7B,CAAC,EAAE,CAAC;YACH,GAAG,CAAC,QAAQ,CAAC;gBACX,IAAI,EAAE,QAAQ;gBACd,IAAI,EAAE,CAAC,SAAS,EAAE,KAAK,EAAE,GAAG,KAAK,CAAC,IAAI,CAAC;gBACvC,OAAO,EAAE,KAAK,CAAC,OAAO;aACvB,CAAC,CAAC;QACL,CAAC;QACD,KAAK,MAAM,KAAK,IAAI,qBAAqB,CAAC;YACxC,YAAY,EAAE,KAAK,CAAC,YAAY,IAAI,EAAE;YACtC,sBAAsB,EAAE,KAAK,CAAC,sBAAsB;YACpD,WAAW,EAAE,KAAK,CAAC,WAAW;SAC/B,CAAC,EAAE,CAAC;YACH,GAAG,CAAC,QAAQ,CAAC;gBACX,IAAI,EAAE,QAAQ;gBACd,IAAI,EAAE,CAAC,SAAS,EAAE,KAAK,EAAE,GAAG,KAAK,CAAC,IAAI,CAAC;gBACvC,OAAO,EAAE,KAAK,CAAC,OAAO;aACvB,CAAC,CAAC;QACL,CAAC;QACD;;;;;WAKG;QACH,KAAK,MAAM,CAAC,QAAQ,EAAE,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC;YACpE,MAAM,IAAI,GAAG,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;YAC3C,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;gBACvB,SAAS;YACX,CAAC;YACD,MAAM,KAAK,GAAG;gBACZ,KAAK,EAAE,KAAK,CAAC,EAAE;gBACf,MAAM,EAAE,SAAS,CAAC,MAAM;gBACxB,KAAK,EAAE,SAAS,CAAC,KAAK;aACvB,CAAC;YACF,MAAM,QAAQ,GAAG,qBAAqB,CACpC,SAAS,EACT,IAAI,CAAC,eAAe,IAAI,EAAE,CAC3B,CAAC;YACF,IAAI,QAAQ,KAAK,IAAI,EAAE,CAAC;gBACtB,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;gBAC1B,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,aAAa,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;gBACtE,GAAG,CAAC,QAAQ,CAAC;oBACX,IAAI,EAAE,QAAQ;oBACd,IAAI,EAAE,CAAC,SAAS,EAAE,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,KAAK,CAAC;oBACpD,OAAO;oBACP,MAAM,EAAE;wBACN,OAAO,EAAE;4BACP,IAAI,EAAE,QAAQ,CAAC,MAAM;4BACrB,MAAM,EAAE,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,EAAE;yBACP;qBAC3B;iBACF,CAAC,CAAC;gBACH,SAAS;YACX,CAAC;YACD,MAAM,OAAO,GAAG,2BAA2B,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;YACzD,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACvB,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;gBAC1B,GAAG,CAAC,QAAQ,CAAC;oBACX,IAAI,EAAE,QAAQ;oBACd,IAAI,EAAE,CAAC,SAAS,EAAE,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,QAAQ,CAAC;oBACvD,OAAO,EAAE,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,aAAa,CAAC;wBAC/C,CAAC,CAAC,GAAG,SAAS,CAAC,MAAM,sGAAsG,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;wBAC/I,CAAC,CAAC,GAAG,SAAS,CAAC,MAAM,uGAAuG,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;oBAClJ,MAAM,EAAE;wBACN,OAAO,EAAE;4BACP,IAAI,EAAE,8BAA8B;4BACpC,MAAM,EAAE,EAAE,GAAG,KAAK,EAAE,WAAW,EAAE,OAAO,EAAE;yBAClB;qBAC3B;iBACF,CAAC,CAAC;gBACH,SAAS;YACX,CAAC;YACD,MAAM,UAAU,GAAG,gCAAgC,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;YACjE,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBAC1B,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;gBAC1B,GAAG,CAAC,QAAQ,CAAC;oBACX,IAAI,EAAE,QAAQ;oBACd,IAAI,EAAE,CAAC,SAAS,EAAE,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,QAAQ,CAAC;oBACvD,OAAO,EAAE,GAAG,SAAS,CAAC,MAAM,sFAAsF,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;oBACzI,MAAM,EAAE;wBACN,OAAO,EAAE;4BACP,IAAI,EAAE,sCAAsC;4BAC5C,MAAM,EAAE,EAAE,GAAG,KAAK,EAAE,UAAU,EAAE;yBACR;qBAC3B;iBACF,CAAC,CAAC;YACL,CAAC;QACH,CAAC;IACH,CAAC;IAED;;;;OAIG;IACH,IAAI,OAAO,CAAC,OAAO,KAAK,CAAC,EAAE,CAAC;QAC1B,MAAM,OAAO,GAAG,CAAC,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;aAClC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;aAC7C,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;YACf,EAAE,EAAE,KAAK,CAAC,EAAE;YACZ,WAAW,EAAE,KAAK,CAAC,WAAW;YAC9B,OAAO,EAAE,KAAK,CAAC,OAAO,IAAI,EAAE;SAC7B,CAAC,CAAC,CAAC;QACN,KAAK,MAAM,CAAC,EAAE,EAAE,OAAO,CAAC,IAAI,sBAAsB,CAAC,OAAO,CAAC,EAAE,CAAC;YAC5D,GAAG,CAAC,QAAQ,CAAC;gBACX,IAAI,EAAE,QAAQ;gBACd,IAAI,EAAE,CAAC,SAAS,EAAE,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,SAAS,CAAC;gBACtD,OAAO,EAAE,yFAAyF,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,0DAA0D,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG;gBACpN,MAAM,EAAE;oBACN,OAAO,EAAE;wBACP,IAAI,EAAE,yBAAyB;wBAC/B,MAAM,EAAE;4BACN,KAAK,EAAE,EAAE;4BACT,OAAO,EAAE,OAAO,CAAC,OAAO;4BACxB,QAAQ,EAAE,OAAO,CAAC,QAAQ;yBAC3B;qBACuB;iBAC3B;aACF,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACH,IAAI,OAAO,CAAC,OAAO,KAAK,CAAC,EAAE,CAAC;QAC1B,KAAK,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,IAAI,OAAO,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC;YACvD,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ,IAAI,KAAK,CAAC,UAAU,KAAK,SAAS,EAAE,CAAC;gBAC9D,GAAG,CAAC,QAAQ,CAAC;oBACX,IAAI,EAAE,QAAQ;oBACd,IAAI,EAAE,CAAC,SAAS,EAAE,KAAK,EAAE,YAAY,CAAC;oBACtC,OAAO,EACL,iGAAiG;iBACpG,CAAC,CAAC;YACL,CAAC;QACH,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACH,KAAK,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,IAAI,OAAO,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC;QACvD,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ,IAAI,KAAK,CAAC,UAAU,KAAK,SAAS,EAAE,CAAC;YAC9D,SAAS;QACX,CAAC;QACD,KAAK,MAAM,KAAK,IAAI,uBAAuB,CACzC,KAAK,CAAC,UAAU,EAChB,KAAK,CAAC,YAAY,CACnB,EAAE,CAAC;YACF,GAAG,CAAC,QAAQ,CAAC;gBACX,IAAI,EAAE,QAAQ;gBACd,IAAI,EAAE,CAAC,SAAS,EAAE,KAAK,EAAE,GAAG,KAAK,CAAC,IAAI,CAAC;gBACvC,OAAO,EAAE,KAAK,CAAC,OAAO;aACvB,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED;;;;;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;AAIL;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG;IAC9B,yBAAyB;IACzB,+BAA+B;IAC/B,iCAAiC;IACjC,8BAA8B;IAC9B,sCAAsC;IACtC,yBAAyB;CACwB,CAAC;AA+BpD;;;;;;;;;;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,MAAM,WAAW,GAAG,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QACtD,KAAK,EAAE,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,QAAQ,KAAK,KAAK,CAAC,OAAO,EAAE;QAC9D,OAAO,EAAE,gBAAgB,CAAC,KAAK,CAAC;KACjC,CAAC,CAAC,CAAC;IACJ,OAAO;QACL,EAAE,EAAE,KAAK;QACT,MAAM,EAAE,WAAW,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,KAAK,CAAC;QACzD,WAAW;KACZ,CAAC;AACJ,CAAC;AAED,SAAS,gBAAgB,CAAC,KAGzB;IACC,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ,IAAI,OAAO,KAAK,CAAC,MAAM,KAAK,QAAQ,EAAE,CAAC;QAChE,OAAO,IAAI,CAAC;IACd,CAAC;IACD,MAAM,OAAO,GAAI,KAAK,CAAC,MAA8C;QACnE,EAAE,OAAO,CAAC;IACZ,OAAO,OAAO,KAAK,SAAS,IAAI,gBAAgB,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC;QACrE,CAAC,CAAC,OAAO;QACT,CAAC,CAAC,IAAI,CAAC;AACX,CAAC;AAED,yEAAyE;AACzE,SAAS,aAAa,CACpB,SAIC,EACD,QAA+B;IAE/B,QAAQ,QAAQ,CAAC,MAAM,EAAE,CAAC;QACxB,KAAK,yBAAyB;YAC5B,OAAO;gBACL,KAAK,EAAE,OAAO;gBACd,OAAO,EAAE,GAAG,SAAS,CAAC,MAAM,iCAAiC,SAAS,CAAC,KAAK,GAAG;gBAC/E,MAAM,EAAE,EAAE;aACX,CAAC;QACJ,KAAK,+BAA+B;YAClC,OAAO;gBACL,KAAK,EAAE,SAAS;gBAChB,OAAO,EAAE,IAAI,SAAS,CAAC,KAAK,QAAQ,SAAS,CAAC,MAAM,kBAAkB,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAC,SAAS,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE;gBACpI,MAAM,EAAE;oBACN,OAAO,EAAE,SAAS,CAAC,OAAO;oBAC1B,SAAS,EAAE,QAAQ,CAAC,SAAS;iBAC9B;aACF,CAAC;QACJ,KAAK,iCAAiC;YACpC,OAAO;gBACL,KAAK,EAAE,cAAc;gBACrB,OAAO,EAAE,IAAI,SAAS,CAAC,KAAK,QAAQ,SAAS,CAAC,MAAM,oBAAoB,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;gBACxG,MAAM,EAAE,EAAE,UAAU,EAAE,QAAQ,CAAC,UAAU,EAAE;aAC5C,CAAC;IACN,CAAC;AACH,CAAC"}

package/dist/entitlements.d.ts

@@ -0,0 +1,117 @@
+/**
+ * What a paid plugin reads about its licence (ADR 0042).
+ *
+ * The host holds the licences the board entered and verifies them offline,
+ * against the keys the plugin's manifest declares and the instance's own id
+ * and key, on the association's calendar day. A plugin gets the finding and
+ * never the file, and decides for itself what it withholds without an active
+ * entitlement: the host loads and serves it either way.
+ */
+/** The version of the licence file format this contract reads. */
+export declare const LICENCE_FORMAT = "openbrf-licence/1";
+/** The version of the presentation format `present()` writes. */
+export declare const LICENCE_PRESENTATION_FORMAT = "openbrf-licence-presentation/1";
+/** The largest licence file the host accepts, in bytes. */
+export declare const LICENCE_FILE_MAX_BYTES = 16384;
+/** The largest presentation a service has to read, in bytes. */
+export declare const LICENCE_PRESENTATION_MAX_BYTES = 24576;
+/**
+ * The finding for the entitlement the manifest names, judged today.
+ *
+ * Dates are `YYYY-MM-DD` on the association's calendar day, and inclusive: a
+ * licence valid until a day is active through the whole of it.
+ *
+ * - `active`: a licence one of the plugin's keys verified names the
+ *   entitlement, is bound to this instance, and covers today and this release.
+ * - `absent`: no licence the plugin's keys verified names the entitlement.
+ * - `expired`: today is after its `validUntil`.
+ * - `version-not-covered`: this release was published after its
+ *   `updatesUntil`. An earlier release stays covered.
+ * - `wrong-instance`: it was issued to another instance, by id or by key.
+ * - `tampered`: it verified when it was entered and no longer does.
+ * - `not-yet-valid`: it was issued after today, which is a wrong clock on
+ *   one side or the other.
+ *
+ * Without an active licence the finding is that of the licence entered most
+ * recently, so a board that has just entered the wrong file is told about
+ * that file.
+ */
+export type EntitlementState = {
+    status: "active";
+    licenceId: string;
+    validUntil: string | null;
+    updatesUntil: string | null;
+} | {
+    status: "absent";
+} | {
+    status: "expired";
+    licenceId: string;
+    validUntil: string;
+} | {
+    status: "version-not-covered";
+    licenceId: string;
+    updatesUntil: string;
+    released: string;
+} | {
+    status: "wrong-instance";
+    licenceId: string;
+} | {
+    status: "tampered";
+} | {
+    status: "not-yet-valid";
+    licenceId: string;
+    issuedOn: string;
+};
+export type EntitlementStatus = EntitlementState["status"];
+export declare const ENTITLEMENT_STATUSES: readonly ["active", "absent", "expired", "version-not-covered", "wrong-instance", "tampered", "not-yet-valid"];
+/**
+ * A licensed plugin's view of its entitlement.
+ *
+ * Read on every call rather than once at boot, so a licence the board enters,
+ * one that ends, and the next one taking over all reach a running plugin
+ * without a restart.
+ */
+export interface PluginEntitlements {
+    /** The entitlement the manifest names, judged today. */
+    get(): Promise<EntitlementState>;
+    /**
+     * The active licence with a fresh signature by the instance key, for one of
+     * the audiences the manifest declares, as the text to send that service.
+     * Null without an active licence.
+     *
+     * Signed without a network call; sending it is the plugin's. A presentation
+     * is good at its audience for five minutes and once, so make one per
+     * request rather than keeping one.
+     *
+     * Throws a RangeError for an audience the manifest does not declare, since
+     * that is a defect in the plugin rather than a state of the licence.
+     */
+    present(audience: string): Promise<string | null>;
+}
+export interface TestEntitlementsOptions {
+    /** What `get()` answers. */
+    state: EntitlementState;
+    /** The manifest's `licence.audiences`. None by default. */
+    audiences?: readonly string[];
+    /** What `present()` answers while the state is active. */
+    presentation?: (audience: string) => string;
+}
+/**
+ * A stand-in for `host.entitlements` in a plugin's own tests.
+ *
+ * It answers with the state it was given and keeps the host's two rules about
+ * presenting: an undeclared audience is refused, and nothing is presented
+ * without an active licence. A plugin that wants to test the service end of a
+ * presentation signs licences with a throwaway key generated in the test;
+ * nothing here needs one.
+ */
+export declare function createTestEntitlements(options: TestEntitlementsOptions): PluginEntitlements & {
+    state: EntitlementState;
+};
+/**
+ * The refusal of an audience the manifest does not declare, worded once for
+ * the host and its test double. The audience is left out: it is whatever the
+ * plugin passed.
+ */
+export declare function undeclaredAudienceError(): RangeError;
+//# sourceMappingURL=entitlements.d.ts.map

package/dist/entitlements.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"entitlements.d.ts","sourceRoot":"","sources":["../src/entitlements.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,kEAAkE;AAClE,eAAO,MAAM,cAAc,sBAAsB,CAAC;AAElD,iEAAiE;AACjE,eAAO,MAAM,2BAA2B,mCAAmC,CAAC;AAE5E,2DAA2D;AAC3D,eAAO,MAAM,sBAAsB,QAAS,CAAC;AAE7C,gEAAgE;AAChE,eAAO,MAAM,8BAA8B,QAAS,CAAC;AAErD;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,MAAM,gBAAgB,GACxB;IACE,MAAM,EAAE,QAAQ,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;CAC7B,GACD;IAAE,MAAM,EAAE,QAAQ,CAAA;CAAE,GACpB;IAAE,MAAM,EAAE,SAAS,CAAC;IAAC,SAAS,EAAE,MAAM,CAAC;IAAC,UAAU,EAAE,MAAM,CAAA;CAAE,GAC5D;IACE,MAAM,EAAE,qBAAqB,CAAC;IAC9B,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE,MAAM,CAAC;IACrB,QAAQ,EAAE,MAAM,CAAC;CAClB,GACD;IAAE,MAAM,EAAE,gBAAgB,CAAC;IAAC,SAAS,EAAE,MAAM,CAAA;CAAE,GAC/C;IAAE,MAAM,EAAE,UAAU,CAAA;CAAE,GACtB;IAAE,MAAM,EAAE,eAAe,CAAC;IAAC,SAAS,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,CAAC;AAErE,MAAM,MAAM,iBAAiB,GAAG,gBAAgB,CAAC,QAAQ,CAAC,CAAC;AAE3D,eAAO,MAAM,oBAAoB,gHAQgB,CAAC;AAElD;;;;;;GAMG;AACH,MAAM,WAAW,kBAAkB;IACjC,wDAAwD;IACxD,GAAG,IAAI,OAAO,CAAC,gBAAgB,CAAC,CAAC;IACjC;;;;;;;;;;;OAWG;IACH,OAAO,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;CACnD;AAED,MAAM,WAAW,uBAAuB;IACtC,4BAA4B;IAC5B,KAAK,EAAE,gBAAgB,CAAC;IACxB,2DAA2D;IAC3D,SAAS,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IAC9B,0DAA0D;IAC1D,YAAY,CAAC,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,MAAM,CAAC;CAC7C;AAED;;;;;;;;GAQG;AACH,wBAAgB,sBAAsB,CACpC,OAAO,EAAE,uBAAuB,GAC/B,kBAAkB,GAAG;IAAE,KAAK,EAAE,gBAAgB,CAAA;CAAE,CAkBlD;AAED;;;;GAIG;AACH,wBAAgB,uBAAuB,IAAI,UAAU,CAKpD"}

package/dist/entitlements.js

@@ -0,0 +1,62 @@
+/**
+ * What a paid plugin reads about its licence (ADR 0042).
+ *
+ * The host holds the licences the board entered and verifies them offline,
+ * against the keys the plugin's manifest declares and the instance's own id
+ * and key, on the association's calendar day. A plugin gets the finding and
+ * never the file, and decides for itself what it withholds without an active
+ * entitlement: the host loads and serves it either way.
+ */
+/** The version of the licence file format this contract reads. */
+export const LICENCE_FORMAT = "openbrf-licence/1";
+/** The version of the presentation format `present()` writes. */
+export const LICENCE_PRESENTATION_FORMAT = "openbrf-licence-presentation/1";
+/** The largest licence file the host accepts, in bytes. */
+export const LICENCE_FILE_MAX_BYTES = 16_384;
+/** The largest presentation a service has to read, in bytes. */
+export const LICENCE_PRESENTATION_MAX_BYTES = 24_576;
+export const ENTITLEMENT_STATUSES = [
+    "active",
+    "absent",
+    "expired",
+    "version-not-covered",
+    "wrong-instance",
+    "tampered",
+    "not-yet-valid",
+];
+/**
+ * A stand-in for `host.entitlements` in a plugin's own tests.
+ *
+ * It answers with the state it was given and keeps the host's two rules about
+ * presenting: an undeclared audience is refused, and nothing is presented
+ * without an active licence. A plugin that wants to test the service end of a
+ * presentation signs licences with a throwaway key generated in the test;
+ * nothing here needs one.
+ */
+export function createTestEntitlements(options) {
+    const audiences = new Set(options.audiences ?? []);
+    const double = {
+        state: options.state,
+        get: () => Promise.resolve(double.state),
+        present: (audience) => {
+            if (!audiences.has(audience)) {
+                return Promise.reject(undeclaredAudienceError());
+            }
+            if (double.state.status !== "active") {
+                return Promise.resolve(null);
+            }
+            return Promise.resolve(options.presentation?.(audience) ?? `test-presentation:${audience}`);
+        },
+    };
+    return double;
+}
+/**
+ * The refusal of an audience the manifest does not declare, worded once for
+ * the host and its test double. The audience is left out: it is whatever the
+ * plugin passed.
+ */
+export function undeclaredAudienceError() {
+    return new RangeError("present() was asked for an audience the plugin's manifest does not " +
+        "declare under licence.audiences.");
+}
+//# sourceMappingURL=entitlements.js.map

package/dist/entitlements.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"entitlements.js","sourceRoot":"","sources":["../src/entitlements.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,kEAAkE;AAClE,MAAM,CAAC,MAAM,cAAc,GAAG,mBAAmB,CAAC;AAElD,iEAAiE;AACjE,MAAM,CAAC,MAAM,2BAA2B,GAAG,gCAAgC,CAAC;AAE5E,2DAA2D;AAC3D,MAAM,CAAC,MAAM,sBAAsB,GAAG,MAAM,CAAC;AAE7C,gEAAgE;AAChE,MAAM,CAAC,MAAM,8BAA8B,GAAG,MAAM,CAAC;AA4CrD,MAAM,CAAC,MAAM,oBAAoB,GAAG;IAClC,QAAQ;IACR,QAAQ;IACR,SAAS;IACT,qBAAqB;IACrB,gBAAgB;IAChB,UAAU;IACV,eAAe;CACgC,CAAC;AAoClD;;;;;;;;GAQG;AACH,MAAM,UAAU,sBAAsB,CACpC,OAAgC;IAEhC,MAAM,SAAS,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,SAAS,IAAI,EAAE,CAAC,CAAC;IACnD,MAAM,MAAM,GAAG;QACb,KAAK,EAAE,OAAO,CAAC,KAAK;QACpB,GAAG,EAAE,GAA8B,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC;QACnE,OAAO,EAAE,CAAC,QAAgB,EAA0B,EAAE;YACpD,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC;gBAC7B,OAAO,OAAO,CAAC,MAAM,CAAC,uBAAuB,EAAE,CAAC,CAAC;YACnD,CAAC;YACD,IAAI,MAAM,CAAC,KAAK,CAAC,MAAM,KAAK,QAAQ,EAAE,CAAC;gBACrC,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YAC/B,CAAC;YACD,OAAO,OAAO,CAAC,OAAO,CACpB,OAAO,CAAC,YAAY,EAAE,CAAC,QAAQ,CAAC,IAAI,qBAAqB,QAAQ,EAAE,CACpE,CAAC;QACJ,CAAC;KACF,CAAC;IACF,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,uBAAuB;IACrC,OAAO,IAAI,UAAU,CACnB,qEAAqE;QACnE,kCAAkC,CACrC,CAAC;AACJ,CAAC"}