@openbrf/plugin-sdk 1.0.0 → 1.4.0

package/dist/records.d.ts

@@ -0,0 +1,130 @@
+/**
+ * A plugin's own records (ADR 0033).
+ *
+ * A small keyed store: JSON values under a collection and a key, belonging to
+ * the plugin and to nothing else. It is for what a plugin has of its own to
+ * remember and cannot fit into a settings form - a list of screens, each with
+ * its own layout and rotation - and never for people. The data subject access
+ * report, purging, erasure and restriction all read the core's own tables, and
+ * a plugin's JSON is opaque to every one of them, so a name, an email address
+ * or anything copied out of the register kept here would be data the
+ * association holds and cannot report, purge or restrict. The host cannot tell
+ * a name from a label, so the rule is declared rather than enforced, with one
+ * exception: a personal identity number is refused on every write.
+ *
+ * The errors below are thrown by the host's copy of this package. A plugin
+ * imports the SDK for its types only, so it tells them apart by `name` rather
+ * than with `instanceof`.
+ */
+/** A value JSON can carry. */
+export type JsonValue = null | boolean | number | string | readonly JsonValue[] | {
+    readonly [key: string]: JsonValue;
+};
+/**
+ * A collection: lowercase letters, digits and single hyphens, at most 32
+ * characters, starting and ending with a letter or a digit.
+ */
+export declare const PLUGIN_RECORD_COLLECTION_PATTERN: RegExp;
+/** A key: 1 to 128 letters, digits, `.`, `_`, `:` or `-`. */
+export declare const PLUGIN_RECORD_KEY_PATTERN: RegExp;
+/** What one plugin may hold, and the most one call reads. */
+export declare const PLUGIN_RECORD_LIMITS: {
+    /** Bytes of one value, serialised as JSON in UTF-8. */
+    readonly valueBytes: number;
+    /** Records per plugin, across every collection. */
+    readonly records: 10000;
+    /** Bytes per plugin, across every collection, counted as for one value. */
+    readonly totalBytes: number;
+    /** Records one `list` returns, and its default. */
+    readonly listLimit: 200;
+    /**
+     * Writes of one plugin the host holds at once, the one under way and those
+     * waiting for their turn. A write sent past it is refused, not held.
+     */
+    readonly queuedWrites: 100;
+};
+export interface PluginRecord<Value extends JsonValue = JsonValue> {
+    readonly collection: string;
+    readonly key: string;
+    readonly value: Value;
+    /**
+     * A counter, 1 when the record is written first and one more on every write
+     * after that. Not `updatedAt`, because two writes inside one millisecond
+     * carry the same time.
+     */
+    readonly revision: number;
+    /** When the record was last written, as an ISO 8601 instant. */
+    readonly updatedAt: string;
+}
+/**
+ * The plugin's own records. Needs no permission, and refuses while the plugin
+ * is switched off, as every host service does.
+ *
+ * A collection or a key outside its pattern is refused with a RangeError, and a
+ * value JSON cannot carry exactly - `undefined`, a function, `NaN`, a `Date`, a
+ * class instance, a lone surrogate or a NUL character - with a TypeError.
+ */
+export interface PluginRecords {
+    get<Value extends JsonValue>(collection: string, key: string): Promise<PluginRecord<Value> | null>;
+    /**
+     * In key order, from after `after` when it is given. At most 200 per call,
+     * which is also the default.
+     */
+    list<Value extends JsonValue>(collection: string, options?: {
+        after?: string;
+        limit?: number;
+    }): Promise<readonly PluginRecord<Value>[]>;
+    /**
+     * Writes a value. With `expectedRevision`, only over that revision, and
+     * `null` means only where there is no record yet; otherwise it throws
+     * PluginRecordConflictError.
+     *
+     * A value carrying a personal identity number, in a string, a property name
+     * or a number, is refused with PluginRecordIdentityNumberError. A value
+     * over 64 KiB, and a write that would take the plugin past 10 000 records
+     * or 16 MiB, is refused with PluginRecordLimitError, and so is any write,
+     * an overwrite too, sent while 100 of the plugin's writes are already held,
+     * the one under way and those waiting.
+     */
+    put<Value extends JsonValue>(collection: string, key: string, value: Value, options?: {
+        expectedRevision?: number | null;
+    }): Promise<PluginRecord<Value>>;
+    /**
+     * True when there was a record to delete. With `expectedRevision`, only that
+     * revision is deleted, and another one throws PluginRecordConflictError; no
+     * record at all is still `false`.
+     */
+    delete(collection: string, key: string, options?: {
+        expectedRevision?: number;
+    }): Promise<boolean>;
+}
+/** A write's `expectedRevision` did not match the record it found. */
+export declare class PluginRecordConflictError extends Error {
+    readonly pluginId: string;
+    /** The revision the store holds, or null when it holds no record. */
+    readonly actualRevision: number | null;
+    constructor(pluginId: string, 
+    /** The revision the store holds, or null when it holds no record. */
+    actualRevision: number | null);
+}
+export type PluginRecordLimit = "valueBytes" | "records" | "totalBytes" | "queuedWrites";
+/**
+ * A write, or a delete queued behind the writes, was past one of
+ * {@link PLUGIN_RECORD_LIMITS}, and nothing was changed.
+ */
+export declare class PluginRecordLimitError extends Error {
+    readonly pluginId: string;
+    readonly limit: PluginRecordLimit;
+    constructor(pluginId: string, limit: PluginRecordLimit);
+}
+/**
+ * A write carried a personal identity number.
+ *
+ * Neither the collection, the key nor the number is in the message: the error
+ * reaches the log, and the number is what the refusal is keeping out of it.
+ */
+export declare class PluginRecordIdentityNumberError extends Error {
+    readonly pluginId: string;
+    constructor(pluginId: string);
+}
+//# sourceMappingURL=records.d.ts.map

package/dist/records.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"records.d.ts","sourceRoot":"","sources":["../src/records.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAEH,8BAA8B;AAC9B,MAAM,MAAM,SAAS,GACjB,IAAI,GACJ,OAAO,GACP,MAAM,GACN,MAAM,GACN,SAAS,SAAS,EAAE,GACpB;IAAE,QAAQ,EAAE,GAAG,EAAE,MAAM,GAAG,SAAS,CAAA;CAAE,CAAC;AAE1C;;;GAGG;AACH,eAAO,MAAM,gCAAgC,QACH,CAAC;AAE3C,6DAA6D;AAC7D,eAAO,MAAM,yBAAyB,QAA6B,CAAC;AAEpE,6DAA6D;AAC7D,eAAO,MAAM,oBAAoB;IAC/B,uDAAuD;aACvD,UAAU;IACV,mDAAmD;aACnD,OAAO,EAAE,KAAM;IACf,2EAA2E;aAC3E,UAAU;IACV,mDAAmD;aACnD,SAAS,EAAE,GAAG;IACd;;;OAGG;aACH,YAAY,EAAE,GAAG;CACT,CAAC;AAEX,MAAM,WAAW,YAAY,CAAC,KAAK,SAAS,SAAS,GAAG,SAAS;IAC/D,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC;IACtB;;;;OAIG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,gEAAgE;IAChE,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;CAC5B;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,aAAa;IAC5B,GAAG,CAAC,KAAK,SAAS,SAAS,EACzB,UAAU,EAAE,MAAM,EAClB,GAAG,EAAE,MAAM,GACV,OAAO,CAAC,YAAY,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,CAAC;IAEvC;;;OAGG;IACH,IAAI,CAAC,KAAK,SAAS,SAAS,EAC1B,UAAU,EAAE,MAAM,EAClB,OAAO,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,GAC3C,OAAO,CAAC,SAAS,YAAY,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IAE3C;;;;;;;;;;;OAWG;IACH,GAAG,CAAC,KAAK,SAAS,SAAS,EACzB,UAAU,EAAE,MAAM,EAClB,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,KAAK,EACZ,OAAO,CAAC,EAAE;QAAE,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;KAAE,GAC7C,OAAO,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC;IAEhC;;;;OAIG;IACH,MAAM,CACJ,UAAU,EAAE,MAAM,EAClB,GAAG,EAAE,MAAM,EACX,OAAO,CAAC,EAAE;QAAE,gBAAgB,CAAC,EAAE,MAAM,CAAA;KAAE,GACtC,OAAO,CAAC,OAAO,CAAC,CAAC;CACrB;AAED,sEAAsE;AACtE,qBAAa,yBAA0B,SAAQ,KAAK;IAEhD,QAAQ,CAAC,QAAQ,EAAE,MAAM;IACzB,qEAAqE;IACrE,QAAQ,CAAC,cAAc,EAAE,MAAM,GAAG,IAAI;IAHxC,YACW,QAAQ,EAAE,MAAM;IACzB,qEAAqE;IAC5D,cAAc,EAAE,MAAM,GAAG,IAAI,EAMvC;CACF;AAED,MAAM,MAAM,iBAAiB,GAC3B,YAAY,GAAG,SAAS,GAAG,YAAY,GAAG,cAAc,CAAC;AAE3D;;;GAGG;AACH,qBAAa,sBAAuB,SAAQ,KAAK;IAE7C,QAAQ,CAAC,QAAQ,EAAE,MAAM;IACzB,QAAQ,CAAC,KAAK,EAAE,iBAAiB;IAFnC,YACW,QAAQ,EAAE,MAAM,EAChB,KAAK,EAAE,iBAAiB,EAOlC;CACF;AAED;;;;;GAKG;AACH,qBAAa,+BAAgC,SAAQ,KAAK;IAC5C,QAAQ,CAAC,QAAQ,EAAE,MAAM;IAArC,YAAqB,QAAQ,EAAE,MAAM,EAMpC;CACF"}

package/dist/records.js

@@ -0,0 +1,85 @@
+/**
+ * A plugin's own records (ADR 0033).
+ *
+ * A small keyed store: JSON values under a collection and a key, belonging to
+ * the plugin and to nothing else. It is for what a plugin has of its own to
+ * remember and cannot fit into a settings form - a list of screens, each with
+ * its own layout and rotation - and never for people. The data subject access
+ * report, purging, erasure and restriction all read the core's own tables, and
+ * a plugin's JSON is opaque to every one of them, so a name, an email address
+ * or anything copied out of the register kept here would be data the
+ * association holds and cannot report, purge or restrict. The host cannot tell
+ * a name from a label, so the rule is declared rather than enforced, with one
+ * exception: a personal identity number is refused on every write.
+ *
+ * The errors below are thrown by the host's copy of this package. A plugin
+ * imports the SDK for its types only, so it tells them apart by `name` rather
+ * than with `instanceof`.
+ */
+/**
+ * A collection: lowercase letters, digits and single hyphens, at most 32
+ * characters, starting and ending with a letter or a digit.
+ */
+export const PLUGIN_RECORD_COLLECTION_PATTERN = /^(?=.{1,32}$)[a-z0-9]+(?:-[a-z0-9]+)*$/;
+/** A key: 1 to 128 letters, digits, `.`, `_`, `:` or `-`. */
+export const PLUGIN_RECORD_KEY_PATTERN = /^[A-Za-z0-9._:-]{1,128}$/;
+/** What one plugin may hold, and the most one call reads. */
+export const PLUGIN_RECORD_LIMITS = {
+    /** Bytes of one value, serialised as JSON in UTF-8. */
+    valueBytes: 64 * 1024,
+    /** Records per plugin, across every collection. */
+    records: 10_000,
+    /** Bytes per plugin, across every collection, counted as for one value. */
+    totalBytes: 16 * 1024 * 1024,
+    /** Records one `list` returns, and its default. */
+    listLimit: 200,
+    /**
+     * Writes of one plugin the host holds at once, the one under way and those
+     * waiting for their turn. A write sent past it is refused, not held.
+     */
+    queuedWrites: 100,
+};
+/** A write's `expectedRevision` did not match the record it found. */
+export class PluginRecordConflictError extends Error {
+    pluginId;
+    actualRevision;
+    constructor(pluginId, 
+    /** The revision the store holds, or null when it holds no record. */
+    actualRevision) {
+        super(`Plugin "${pluginId}" wrote a record over a revision it no longer has.`);
+        this.pluginId = pluginId;
+        this.actualRevision = actualRevision;
+        this.name = "PluginRecordConflictError";
+    }
+}
+/**
+ * A write, or a delete queued behind the writes, was past one of
+ * {@link PLUGIN_RECORD_LIMITS}, and nothing was changed.
+ */
+export class PluginRecordLimitError extends Error {
+    pluginId;
+    limit;
+    constructor(pluginId, limit) {
+        super(`Plugin "${pluginId}" was refused a record operation past its ${limit} ` +
+            `limit of ${String(PLUGIN_RECORD_LIMITS[limit])}.`);
+        this.pluginId = pluginId;
+        this.limit = limit;
+        this.name = "PluginRecordLimitError";
+    }
+}
+/**
+ * A write carried a personal identity number.
+ *
+ * Neither the collection, the key nor the number is in the message: the error
+ * reaches the log, and the number is what the refusal is keeping out of it.
+ */
+export class PluginRecordIdentityNumberError extends Error {
+    pluginId;
+    constructor(pluginId) {
+        super(`Plugin "${pluginId}" wrote a record carrying a personal identity ` +
+            "number, which a plugin's records may not hold.");
+        this.pluginId = pluginId;
+        this.name = "PluginRecordIdentityNumberError";
+    }
+}
+//# sourceMappingURL=records.js.map

package/dist/records.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"records.js","sourceRoot":"","sources":["../src/records.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAWH;;;GAGG;AACH,MAAM,CAAC,MAAM,gCAAgC,GAC3C,wCAAwC,CAAC;AAE3C,6DAA6D;AAC7D,MAAM,CAAC,MAAM,yBAAyB,GAAG,0BAA0B,CAAC;AAEpE,6DAA6D;AAC7D,MAAM,CAAC,MAAM,oBAAoB,GAAG;IAClC,uDAAuD;IACvD,UAAU,EAAE,EAAE,GAAG,IAAI;IACrB,mDAAmD;IACnD,OAAO,EAAE,MAAM;IACf,2EAA2E;IAC3E,UAAU,EAAE,EAAE,GAAG,IAAI,GAAG,IAAI;IAC5B,mDAAmD;IACnD,SAAS,EAAE,GAAG;IACd;;;OAGG;IACH,YAAY,EAAE,GAAG;CACT,CAAC;AAsEX,sEAAsE;AACtE,MAAM,OAAO,yBAA0B,SAAQ,KAAK;IAEvC,QAAQ;IAER,cAAc;IAHzB,YACW,QAAgB;IACzB,qEAAqE;IAC5D,cAA6B;QAEtC,KAAK,CACH,WAAW,QAAQ,oDAAoD,CACxE,CAAC;wBANO,QAAQ;8BAER,cAAc;QAKvB,IAAI,CAAC,IAAI,GAAG,2BAA2B,CAAC;IAC1C,CAAC;CACF;AAKD;;;GAGG;AACH,MAAM,OAAO,sBAAuB,SAAQ,KAAK;IAEpC,QAAQ;IACR,KAAK;IAFhB,YACW,QAAgB,EAChB,KAAwB;QAEjC,KAAK,CACH,WAAW,QAAQ,6CAA6C,KAAK,GAAG;YACtE,YAAY,MAAM,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC,GAAG,CACrD,CAAC;wBANO,QAAQ;qBACR,KAAK;QAMd,IAAI,CAAC,IAAI,GAAG,wBAAwB,CAAC;IACvC,CAAC;CACF;AAED;;;;;GAKG;AACH,MAAM,OAAO,+BAAgC,SAAQ,KAAK;IACnC,QAAQ;IAA7B,YAAqB,QAAgB;QACnC,KAAK,CACH,WAAW,QAAQ,gDAAgD;YACjE,gDAAgD,CACnD,CAAC;wBAJiB,QAAQ;QAK3B,IAAI,CAAC,IAAI,GAAG,iCAAiC,CAAC;IAChD,CAAC;CACF"}

package/dist/require-capability.d.ts

@@ -0,0 +1,37 @@
+/**
+ * Raising a plugin route above the capability floor the host gives it.
+ *
+ * The host reads one metadata key off a controller and off each of its routes,
+ * and answers a request only for a person who holds every capability listed
+ * there. A plugin's controllers get a floor from the plugin's own permissions
+ * (see "Routes" in the plugin contract); `RequireCapability` is how a route
+ * asks for more.
+ *
+ * Written without `@nestjs/common` on purpose, for the reason `definePlugin` is
+ * an identity function: the SDK is bundled into the plugin, and an import of
+ * its own would have to be resolved from the data volume. NestJS's
+ * `SetMetadata` does no more than this, on the same global `Reflect` the host's
+ * copy of NestJS writes to.
+ */
+/** The metadata key the host reads a route's or a controller's capabilities from. */
+export declare const REQUIRED_CAPABILITIES_KEY = "openbrf:required-capabilities";
+/**
+ * Every capability name the host knows, which is what a route may require.
+ *
+ * Listed here, not derived, because the SDK cannot import the host. The host
+ * checks the list against its own capabilities in a test, so a capability
+ * added there is not missing here for long; until the SDK is released with it,
+ * a plugin that needs the new name is a type error rather than a typo caught
+ * at request time.
+ */
+export declare const PLUGIN_ROUTE_CAPABILITIES: readonly ["association:manage", "association:read", "addressBook:read", "addressBook:write", "memberRegister:read", "apartmentRegister:read", "protectedData:reveal", "registerReport:export", "invitation:send", "signupRequest:decide", "self:manage", "residentDirectory:read", "issues:handle", "issues:report", "issues:configure", "documents:manage", "site:manage", "news:comment", "boardPosition:manage", "bookings:book", "bookings:manage", "bookings:configure", "events:manage", "events:attend", "systemRole:manage", "motions:submit", "motions:handle", "meetings:manage", "memberCharges:manage", "fees:manage", "dataProtection:manage", "boardMailbox:handle", "sublets:apply", "sublets:handle", "keyOrders:place", "keyOrders:handle", "chat:participate", "chat:moderate", "apartmentBinder:manage"];
+/** A capability name a plugin route may require. */
+export type PluginRouteCapability = (typeof PLUGIN_ROUTE_CAPABILITIES)[number];
+/**
+ * Declares the capabilities a route requires. Several are combined with AND.
+ *
+ * Applied to a controller it covers every route in it. It can only add to the
+ * floor the host gives the plugin: a route cannot require less.
+ */
+export declare function RequireCapability(...capabilities: PluginRouteCapability[]): MethodDecorator & ClassDecorator;
+//# sourceMappingURL=require-capability.d.ts.map

package/dist/require-capability.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"require-capability.d.ts","sourceRoot":"","sources":["../src/require-capability.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,qFAAqF;AACrF,eAAO,MAAM,yBAAyB,kCAAkC,CAAC;AAEzE;;;;;;;;GAQG;AACH,eAAO,MAAM,yBAAyB,YACpC,oBAAoB,EACpB,kBAAkB,EAClB,kBAAkB,EAClB,mBAAmB,EACnB,qBAAqB,EACrB,wBAAwB,EACxB,sBAAsB,EACtB,uBAAuB,EACvB,iBAAiB,EACjB,sBAAsB,EACtB,aAAa,EACb,wBAAwB,EACxB,eAAe,EACf,eAAe,EACf,kBAAkB,EAClB,kBAAkB,EAClB,aAAa,EACb,cAAc,EACd,sBAAsB,EACtB,eAAe,EACf,iBAAiB,EACjB,oBAAoB,EACpB,eAAe,EACf,eAAe,EACf,mBAAmB,EACnB,gBAAgB,EAChB,gBAAgB,EAChB,iBAAiB,EACjB,sBAAsB,EACtB,aAAa,EACb,uBAAuB,EACvB,qBAAqB,EACrB,eAAe,EACf,gBAAgB,EAChB,iBAAiB,EACjB,kBAAkB,EAClB,kBAAkB,EAClB,eAAe,EACf,wBAAwB,CAChB,CAAC;AAEX,oDAAoD;AACpD,MAAM,MAAM,qBAAqB,GAAG,CAAC,OAAO,yBAAyB,CAAC,CAAC,MAAM,CAAC,CAAC;AAO/E;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAC/B,GAAG,YAAY,EAAE,qBAAqB,EAAE,GACvC,eAAe,GAAG,cAAc,CAmBlC"}

package/dist/require-capability.js

@@ -0,0 +1,88 @@
+/**
+ * Raising a plugin route above the capability floor the host gives it.
+ *
+ * The host reads one metadata key off a controller and off each of its routes,
+ * and answers a request only for a person who holds every capability listed
+ * there. A plugin's controllers get a floor from the plugin's own permissions
+ * (see "Routes" in the plugin contract); `RequireCapability` is how a route
+ * asks for more.
+ *
+ * Written without `@nestjs/common` on purpose, for the reason `definePlugin` is
+ * an identity function: the SDK is bundled into the plugin, and an import of
+ * its own would have to be resolved from the data volume. NestJS's
+ * `SetMetadata` does no more than this, on the same global `Reflect` the host's
+ * copy of NestJS writes to.
+ */
+/** The metadata key the host reads a route's or a controller's capabilities from. */
+export const REQUIRED_CAPABILITIES_KEY = "openbrf:required-capabilities";
+/**
+ * Every capability name the host knows, which is what a route may require.
+ *
+ * Listed here, not derived, because the SDK cannot import the host. The host
+ * checks the list against its own capabilities in a test, so a capability
+ * added there is not missing here for long; until the SDK is released with it,
+ * a plugin that needs the new name is a type error rather than a typo caught
+ * at request time.
+ */
+export const PLUGIN_ROUTE_CAPABILITIES = [
+    "association:manage",
+    "association:read",
+    "addressBook:read",
+    "addressBook:write",
+    "memberRegister:read",
+    "apartmentRegister:read",
+    "protectedData:reveal",
+    "registerReport:export",
+    "invitation:send",
+    "signupRequest:decide",
+    "self:manage",
+    "residentDirectory:read",
+    "issues:handle",
+    "issues:report",
+    "issues:configure",
+    "documents:manage",
+    "site:manage",
+    "news:comment",
+    "boardPosition:manage",
+    "bookings:book",
+    "bookings:manage",
+    "bookings:configure",
+    "events:manage",
+    "events:attend",
+    "systemRole:manage",
+    "motions:submit",
+    "motions:handle",
+    "meetings:manage",
+    "memberCharges:manage",
+    "fees:manage",
+    "dataProtection:manage",
+    "boardMailbox:handle",
+    "sublets:apply",
+    "sublets:handle",
+    "keyOrders:place",
+    "keyOrders:handle",
+    "chat:participate",
+    "chat:moderate",
+    "apartmentBinder:manage",
+];
+/**
+ * Declares the capabilities a route requires. Several are combined with AND.
+ *
+ * Applied to a controller it covers every route in it. It can only add to the
+ * floor the host gives the plugin: a route cannot require less.
+ */
+export function RequireCapability(...capabilities) {
+    return ((target, _key, descriptor) => {
+        const define = Reflect.defineMetadata;
+        if (define === undefined) {
+            throw new Error("RequireCapability needs reflect-metadata, which @nestjs/common loads: import it before the controller.");
+        }
+        if (descriptor !== undefined) {
+            define(REQUIRED_CAPABILITIES_KEY, capabilities, descriptor.value);
+            return descriptor;
+        }
+        define(REQUIRED_CAPABILITIES_KEY, capabilities, target);
+        return target;
+    });
+}
+//# sourceMappingURL=require-capability.js.map

package/dist/require-capability.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"require-capability.js","sourceRoot":"","sources":["../src/require-capability.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,qFAAqF;AACrF,MAAM,CAAC,MAAM,yBAAyB,GAAG,+BAA+B,CAAC;AAEzE;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG;IACvC,oBAAoB;IACpB,kBAAkB;IAClB,kBAAkB;IAClB,mBAAmB;IACnB,qBAAqB;IACrB,wBAAwB;IACxB,sBAAsB;IACtB,uBAAuB;IACvB,iBAAiB;IACjB,sBAAsB;IACtB,aAAa;IACb,wBAAwB;IACxB,eAAe;IACf,eAAe;IACf,kBAAkB;IAClB,kBAAkB;IAClB,aAAa;IACb,cAAc;IACd,sBAAsB;IACtB,eAAe;IACf,iBAAiB;IACjB,oBAAoB;IACpB,eAAe;IACf,eAAe;IACf,mBAAmB;IACnB,gBAAgB;IAChB,gBAAgB;IAChB,iBAAiB;IACjB,sBAAsB;IACtB,aAAa;IACb,uBAAuB;IACvB,qBAAqB;IACrB,eAAe;IACf,gBAAgB;IAChB,iBAAiB;IACjB,kBAAkB;IAClB,kBAAkB;IAClB,eAAe;IACf,wBAAwB;CAChB,CAAC;AAUX;;;;;GAKG;AACH,MAAM,UAAU,iBAAiB,CAC/B,GAAG,YAAqC;IAExC,OAAO,CAAC,CACN,MAAc,EACd,IAAsB,EACtB,UAA+B,EAC/B,EAAE;QACF,MAAM,MAAM,GAAI,OAAsC,CAAC,cAAc,CAAC;QACtE,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;YACzB,MAAM,IAAI,KAAK,CACb,wGAAwG,CACzG,CAAC;QACJ,CAAC;QACD,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;YAC7B,MAAM,CAAC,yBAAyB,EAAE,YAAY,EAAE,UAAU,CAAC,KAAK,CAAC,CAAC;YAClE,OAAO,UAAU,CAAC;QACpB,CAAC;QACD,MAAM,CAAC,yBAAyB,EAAE,YAAY,EAAE,MAAM,CAAC,CAAC;QACxD,OAAO,MAAM,CAAC;IAChB,CAAC,CAAqC,CAAC;AACzC,CAAC"}

package/dist/settings-schema.d.ts

@@ -36,6 +36,14 @@ export declare const pluginSettingsFieldSchema: z.ZodDiscriminatedUnion<[z.ZodOb
         value: z.ZodString;
         labelKey: z.ZodString;
     }, z.core.$strip>>;
+}, z.core.$strip>, z.ZodObject<{
+    key: z.ZodString;
+    labelKey: z.ZodString;
+    hintKey: z.ZodOptional<z.ZodString>;
+    required: z.ZodDefault<z.ZodBoolean>;
+    type: z.ZodLiteral<"secret">;
+    minLength: z.ZodOptional<z.ZodInt>;
+    maxLength: z.ZodOptional<z.ZodInt>;
 }, z.core.$strip>], "type">;
 export type PluginSettingsField = z.infer<typeof pluginSettingsFieldSchema>;
 export declare const pluginSettingsSchema: z.ZodObject<{
@@ -76,10 +84,33 @@ export declare const pluginSettingsSchema: z.ZodObject<{
             value: z.ZodString;
             labelKey: z.ZodString;
         }, z.core.$strip>>;
+    }, z.core.$strip>, z.ZodObject<{
+        key: z.ZodString;
+        labelKey: z.ZodString;
+        hintKey: z.ZodOptional<z.ZodString>;
+        required: z.ZodDefault<z.ZodBoolean>;
+        type: z.ZodLiteral<"secret">;
+        minLength: z.ZodOptional<z.ZodInt>;
+        maxLength: z.ZodOptional<z.ZodInt>;
     }, z.core.$strip>], "type">>;
 }, z.core.$strip>;
 export type PluginSettingsSchema = z.infer<typeof pluginSettingsSchema>;
 export type PluginSettingsValues = Record<string, string | number | boolean>;
+/**
+ * The declaration without its secret fields: what the admin screen is given
+ * values for, and what the host validates the stored plain values against.
+ */
+export declare function withoutSecretFields(schema: PluginSettingsSchema): PluginSettingsSchema;
+/**
+ * The validator for one secret value, as it is written.
+ *
+ * The bounds the field declares, and never the empty string: a secret is
+ * cleared by saying so rather than by storing nothing as a value, so a
+ * plugin reading it is never handed "" where it expects a key.
+ */
+export declare function secretValueValidator(field: Extract<PluginSettingsField, {
+    type: "secret";
+}>): z.ZodString;
 /**
  * Builds the validator for one settings declaration.
  *
@@ -88,6 +119,10 @@ export type PluginSettingsValues = Record<string, string | number | boolean>;
  * about what is acceptable. Unknown keys are stripped: a plugin that drops a
  * setting in a new version must not leave the old value behind to be handed
  * back to it as something it no longer understands.
+ *
+ * A secret field reads as a string, which is how `host.settings.read()` hands
+ * it to the plugin. What the admin screen writes it with is the host's own
+ * rule, since the screen never holds the value it would be validating.
  */
 export declare function settingsValidator(schema: PluginSettingsSchema): z.ZodType<PluginSettingsValues>;
 /** The values a fresh installation starts with, from the declared defaults. */

package/dist/settings-schema.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"settings-schema.d.ts","sourceRoot":"","sources":["../src/settings-schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAsExB,eAAO,MAAM,yBAAyB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;2BAKpC,CAAC;AAEH,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAC;AA0F5E,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAe7B,CAAC;AAEL,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAC;AAExE,MAAM,MAAM,oBAAoB,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,CAAC;AAE7E;;;;;;;;GAQG;AACH,wBAAgB,iBAAiB,CAC/B,MAAM,EAAE,oBAAoB,GAC3B,CAAC,CAAC,OAAO,CAAC,oBAAoB,CAAC,CAQjC;AAqDD,+EAA+E;AAC/E,wBAAgB,eAAe,CAC7B,MAAM,EAAE,oBAAoB,GAC3B,oBAAoB,CAQtB"}
+{"version":3,"file":"settings-schema.d.ts","sourceRoot":"","sources":["../src/settings-schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAsFxB,eAAO,MAAM,yBAAyB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;2BAMpC,CAAC;AAEH,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAC;AAoG5E,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAe7B,CAAC;AAEL,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAC;AAExE,MAAM,MAAM,oBAAoB,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,CAAC;AAE7E;;;GAGG;AACH,wBAAgB,mBAAmB,CACjC,MAAM,EAAE,oBAAoB,GAC3B,oBAAoB,CAItB;AAED;;;;;;GAMG;AACH,wBAAgB,oBAAoB,CAClC,KAAK,EAAE,OAAO,CAAC,mBAAmB,EAAE;IAAE,IAAI,EAAE,QAAQ,CAAA;CAAE,CAAC,GACtD,CAAC,CAAC,SAAS,CAMb;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,iBAAiB,CAC/B,MAAM,EAAE,oBAAoB,GAC3B,CAAC,CAAC,OAAO,CAAC,oBAAoB,CAAC,CAQjC;AAuDD,+EAA+E;AAC/E,wBAAgB,eAAe,CAC7B,MAAM,EAAE,oBAAoB,GAC3B,oBAAoB,CAQtB"}

package/dist/settings-schema.js

@@ -57,11 +57,27 @@ const selectFieldSchema = baseFieldSchema.extend({
         .min(1)
         .max(50),
 });
+/**
+ * A credential: an API key, a token, a customer number the plugin signs in
+ * with (ADR 0037).
+ *
+ * Write-only from the admin screen: the host never returns the value to the
+ * browser, only whether one is set, and the board replaces or clears it. It is
+ * stored encrypted, apart from the other values, and handed back in clear only
+ * by `host.settings.read()` on the server. No default, because a credential
+ * written in a published manifest is not a secret.
+ */
+const secretFieldSchema = baseFieldSchema.extend({
+    type: z.literal("secret"),
+    minLength: z.int().min(1).optional(),
+    maxLength: z.int().min(1).max(10_000).optional(),
+});
 export const pluginSettingsFieldSchema = z.discriminatedUnion("type", [
     textFieldSchema,
     numberFieldSchema,
     booleanFieldSchema,
     selectFieldSchema,
+    secretFieldSchema,
 ]);
 /**
  * Checks a field's bounds against each other and against its default.
@@ -131,6 +147,14 @@ function checkFieldConstraints(field, index, ctx) {
             }
             return;
         }
+        case "secret": {
+            if (field.minLength !== undefined &&
+                field.maxLength !== undefined &&
+                field.minLength > field.maxLength) {
+                reject("minLength must not be greater than maxLength", "minLength");
+            }
+            return;
+        }
         case "boolean":
             return;
     }
@@ -147,6 +171,29 @@ export const pluginSettingsSchema = z
         checkFieldConstraints(field, index, ctx);
     });
 });
+/**
+ * The declaration without its secret fields: what the admin screen is given
+ * values for, and what the host validates the stored plain values against.
+ */
+export function withoutSecretFields(schema) {
+    return {
+        fields: schema.fields.filter((field) => field.type !== "secret"),
+    };
+}
+/**
+ * The validator for one secret value, as it is written.
+ *
+ * The bounds the field declares, and never the empty string: a secret is
+ * cleared by saying so rather than by storing nothing as a value, so a
+ * plugin reading it is never handed "" where it expects a key.
+ */
+export function secretValueValidator(field) {
+    let secret = z.string().min(Math.max(1, field.minLength ?? 1));
+    if (field.maxLength !== undefined) {
+        secret = secret.max(field.maxLength);
+    }
+    return secret;
+}
 /**
  * Builds the validator for one settings declaration.
  *
@@ -155,6 +202,10 @@ export const pluginSettingsSchema = z
  * about what is acceptable. Unknown keys are stripped: a plugin that drops a
  * setting in a new version must not leave the old value behind to be handed
  * back to it as something it no longer understands.
+ *
+ * A secret field reads as a string, which is how `host.settings.read()` hands
+ * it to the plugin. What the admin screen writes it with is the host's own
+ * rule, since the screen never holds the value it would be validating.
  */
 export function settingsValidator(schema) {
     const shape = {};
@@ -192,6 +243,8 @@ function fieldValidator(field) {
             return optionality(z.boolean(), field);
         case "select":
             return optionality(z.enum(field.options.map((option) => option.value)), field);
+        case "secret":
+            return optionality(secretValueValidator(field), field);
     }
 }
 /**
@@ -201,7 +254,7 @@ function fieldValidator(field) {
  * is why it is applied before the optional wrapper rather than after.
  */
 function optionality(validator, field) {
-    if (field.default !== undefined) {
+    if ("default" in field && field.default !== undefined) {
         return validator.default(field.default);
     }
     return field.required ? validator : validator.optional();
@@ -210,7 +263,7 @@ function optionality(validator, field) {
 export function defaultSettings(schema) {
     const values = {};
     for (const field of schema.fields) {
-        if (field.default !== undefined) {
+        if ("default" in field && field.default !== undefined) {
             values[field.key] = field.default;
         }
     }

package/dist/settings-schema.js.map

@@ -1 +1 @@
-{"version":3,"file":"settings-schema.js","sourceRoot":"","sources":["../src/settings-schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;;;;;;;;;;;;GAaG;AAEH,MAAM,iBAAiB,GAAG,CAAC;KACxB,MAAM,EAAE;KACR,GAAG,CAAC,CAAC,CAAC;KACN,GAAG,CAAC,EAAE,CAAC;IACR,6EAA6E;IAC7E,uEAAuE;IACvE,qDAAqD;KACpD,KAAK,CAAC,sBAAsB,EAAE,qCAAqC,CAAC,CAAC;AAExE,MAAM,oBAAoB,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;AAExD,MAAM,eAAe,GAAG,CAAC,CAAC,MAAM,CAAC;IAC/B,GAAG,EAAE,iBAAiB;IACtB,QAAQ,EAAE,oBAAoB;IAC9B,0EAA0E;IAC1E,OAAO,EAAE,oBAAoB,CAAC,QAAQ,EAAE;IACxC,QAAQ,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC;CACrC,CAAC,CAAC;AAEH,MAAM,eAAe,GAAG,eAAe,CAAC,MAAM,CAAC;IAC7C,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC;IACvB,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC9B,SAAS,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE;IACpC,SAAS,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAE;CACjD,CAAC,CAAC;AAEH,MAAM,iBAAiB,GAAG,eAAe,CAAC,MAAM,CAAC;IAC/C,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC;IACzB,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC9B,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC1B,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC1B,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC;CACpC,CAAC,CAAC;AAEH,MAAM,kBAAkB,GAAG,eAAe,CAAC,MAAM,CAAC;IAChD,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC;IAC1B,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;CAChC,CAAC,CAAC;AAEH,MAAM,iBAAiB,GAAG,eAAe,CAAC,MAAM,CAAC;IAC/C,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC;IACzB,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC9B,OAAO,EAAE,CAAC;SACP,KAAK,CACJ,CAAC,CAAC,MAAM,CAAC;QACP,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC;QACjC,QAAQ,EAAE,oBAAoB;KAC/B,CAAC,CACH;SACA,GAAG,CAAC,CAAC,CAAC;SACN,GAAG,CAAC,EAAE,CAAC;CACX,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,CAAC,kBAAkB,CAAC,MAAM,EAAE;IACpE,eAAe;IACf,iBAAiB;IACjB,kBAAkB;IAClB,iBAAiB;CAClB,CAAC,CAAC;AAIH;;;;;;;;;;;;GAYG;AACH,SAAS,qBAAqB,CAC5B,KAA0B,EAC1B,KAAa,EACb,GAAoB;IAEpB,MAAM,MAAM,GAAG,CAAC,OAAe,EAAE,GAAW,EAAQ,EAAE;QACpD,GAAG,CAAC,QAAQ,CAAC;YACX,IAAI,EAAE,QAAQ;YACd,OAAO;YACP,IAAI,EAAE,CAAC,QAAQ,EAAE,KAAK,EAAE,GAAG,CAAC;SAC7B,CAAC,CAAC;IACL,CAAC,CAAC;IAEF,QAAQ,KAAK,CAAC,IAAI,EAAE,CAAC;QACnB,KAAK,MAAM,EAAE,CAAC;YACZ,IACE,KAAK,CAAC,SAAS,KAAK,SAAS;gBAC7B,KAAK,CAAC,SAAS,KAAK,SAAS;gBAC7B,KAAK,CAAC,SAAS,GAAG,KAAK,CAAC,SAAS,EACjC,CAAC;gBACD,MAAM,CAAC,8CAA8C,EAAE,WAAW,CAAC,CAAC;YACtE,CAAC;YACD,IAAI,KAAK,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;gBAChC,OAAO;YACT,CAAC;YACD,IACE,KAAK,CAAC,SAAS,KAAK,SAAS;gBAC7B,KAAK,CAAC,OAAO,CAAC,MAAM,GAAG,KAAK,CAAC,SAAS,EACtC,CAAC;gBACD,MAAM,CAAC,uCAAuC,EAAE,SAAS,CAAC,CAAC;YAC7D,CAAC;YACD,IACE,KAAK,CAAC,SAAS,KAAK,SAAS;gBAC7B,KAAK,CAAC,OAAO,CAAC,MAAM,GAAG,KAAK,CAAC,SAAS,EACtC,CAAC;gBACD,MAAM,CAAC,sCAAsC,EAAE,SAAS,CAAC,CAAC;YAC5D,CAAC;YACD,OAAO;QACT,CAAC;QACD,KAAK,QAAQ,EAAE,CAAC;YACd,IACE,KAAK,CAAC,GAAG,KAAK,SAAS;gBACvB,KAAK,CAAC,GAAG,KAAK,SAAS;gBACvB,KAAK,CAAC,GAAG,GAAG,KAAK,CAAC,GAAG,EACrB,CAAC;gBACD,MAAM,CAAC,kCAAkC,EAAE,KAAK,CAAC,CAAC;YACpD,CAAC;YACD,IAAI,KAAK,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;gBAChC,OAAO;YACT,CAAC;YACD,IAAI,KAAK,CAAC,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC;gBACtD,MAAM,CAAC,+BAA+B,EAAE,SAAS,CAAC,CAAC;YACrD,CAAC;YACD,IAAI,KAAK,CAAC,GAAG,KAAK,SAAS,IAAI,KAAK,CAAC,OAAO,GAAG,KAAK,CAAC,GAAG,EAAE,CAAC;gBACzD,MAAM,CAAC,0BAA0B,EAAE,SAAS,CAAC,CAAC;YAChD,CAAC;YACD,IAAI,KAAK,CAAC,GAAG,KAAK,SAAS,IAAI,KAAK,CAAC,OAAO,GAAG,KAAK,CAAC,GAAG,EAAE,CAAC;gBACzD,MAAM,CAAC,0BAA0B,EAAE,SAAS,CAAC,CAAC;YAChD,CAAC;YACD,OAAO;QACT,CAAC;QACD,KAAK,QAAQ,EAAE,CAAC;YACd,IACE,KAAK,CAAC,OAAO,KAAK,SAAS;gBAC3B,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,KAAK,KAAK,CAAC,OAAO,CAAC,EAC/D,CAAC;gBACD,MAAM,CAAC,gDAAgD,EAAE,SAAS,CAAC,CAAC;YACtE,CAAC;YACD,OAAO;QACT,CAAC;QACD,KAAK,SAAS;YACZ,OAAO;IACX,CAAC;AACH,CAAC;AAED,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC;KAClC,MAAM,CAAC;IACN,MAAM,EAAE,CAAC;SACN,KAAK,CAAC,yBAAyB,CAAC;SAChC,GAAG,CAAC,EAAE,CAAC;SACP,MAAM,CACL,CAAC,MAAM,EAAE,EAAE,CACT,IAAI,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,KAAK,MAAM,CAAC,MAAM,EAClE,EAAE,OAAO,EAAE,2BAA2B,EAAE,CACzC;CACJ,CAAC;KACD,WAAW,CAAC,CAAC,WAAW,EAAE,GAAG,EAAE,EAAE;IAChC,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;QAC1C,qBAAqB,CAAC,KAAK,EAAE,KAAK,EAAE,GAAG,CAAC,CAAC;IAC3C,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAML;;;;;;;;GAQG;AACH,MAAM,UAAU,iBAAiB,CAC/B,MAA4B;IAE5B,MAAM,KAAK,GAAiC,EAAE,CAAC;IAE/C,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;QAClC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,cAAc,CAAC,KAAK,CAAC,CAAC;IAC3C,CAAC;IAED,OAAO,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,KAAK,EAAgD,CAAC;AAC/E,CAAC;AAED,SAAS,cAAc,CAAC,KAA0B;IAChD,QAAQ,KAAK,CAAC,IAAI,EAAE,CAAC;QACnB,KAAK,MAAM,EAAE,CAAC;YACZ,IAAI,IAAI,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC;YACtB,IAAI,KAAK,CAAC,SAAS,KAAK,SAAS,EAAE,CAAC;gBAClC,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;YACnC,CAAC;YACD,IAAI,KAAK,CAAC,SAAS,KAAK,SAAS,EAAE,CAAC;gBAClC,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;YACnC,CAAC;YACD,sEAAsE;YACtE,qEAAqE;YACrE,mDAAmD;YACnD,OAAO,WAAW,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QACjE,CAAC;QACD,KAAK,QAAQ,EAAE,CAAC;YACd,IAAI,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;YAC3D,IAAI,KAAK,CAAC,GAAG,KAAK,SAAS,EAAE,CAAC;gBAC5B,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YACjC,CAAC;YACD,IAAI,KAAK,CAAC,GAAG,KAAK,SAAS,EAAE,CAAC;gBAC5B,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YACjC,CAAC;YACD,OAAO,WAAW,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;QACpC,CAAC;QACD,KAAK,SAAS;YACZ,OAAO,WAAW,CAAC,CAAC,CAAC,OAAO,EAAE,EAAE,KAAK,CAAC,CAAC;QACzC,KAAK,QAAQ;YACX,OAAO,WAAW,CAChB,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EACnD,KAAK,CACN,CAAC;IACN,CAAC;AACH,CAAC;AAED;;;;;GAKG;AACH,SAAS,WAAW,CAClB,SAAuB,EACvB,KAA0B;IAE1B,IAAI,KAAK,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;QAChC,OAAO,SAAS,CAAC,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAC1C,CAAC;IACD,OAAO,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC;AAC3D,CAAC;AAED,+EAA+E;AAC/E,MAAM,UAAU,eAAe,CAC7B,MAA4B;IAE5B,MAAM,MAAM,GAAyB,EAAE,CAAC;IACxC,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;QAClC,IAAI,KAAK,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;YAChC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,OAAO,CAAC;QACpC,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC"}
+{"version":3,"file":"settings-schema.js","sourceRoot":"","sources":["../src/settings-schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;;;;;;;;;;;;GAaG;AAEH,MAAM,iBAAiB,GAAG,CAAC;KACxB,MAAM,EAAE;KACR,GAAG,CAAC,CAAC,CAAC;KACN,GAAG,CAAC,EAAE,CAAC;IACR,6EAA6E;IAC7E,uEAAuE;IACvE,qDAAqD;KACpD,KAAK,CAAC,sBAAsB,EAAE,qCAAqC,CAAC,CAAC;AAExE,MAAM,oBAAoB,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;AAExD,MAAM,eAAe,GAAG,CAAC,CAAC,MAAM,CAAC;IAC/B,GAAG,EAAE,iBAAiB;IACtB,QAAQ,EAAE,oBAAoB;IAC9B,0EAA0E;IAC1E,OAAO,EAAE,oBAAoB,CAAC,QAAQ,EAAE;IACxC,QAAQ,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC;CACrC,CAAC,CAAC;AAEH,MAAM,eAAe,GAAG,eAAe,CAAC,MAAM,CAAC;IAC7C,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC;IACvB,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC9B,SAAS,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE;IACpC,SAAS,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAE;CACjD,CAAC,CAAC;AAEH,MAAM,iBAAiB,GAAG,eAAe,CAAC,MAAM,CAAC;IAC/C,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC;IACzB,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC9B,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC1B,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC1B,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC;CACpC,CAAC,CAAC;AAEH,MAAM,kBAAkB,GAAG,eAAe,CAAC,MAAM,CAAC;IAChD,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC;IAC1B,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;CAChC,CAAC,CAAC;AAEH,MAAM,iBAAiB,GAAG,eAAe,CAAC,MAAM,CAAC;IAC/C,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC;IACzB,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC9B,OAAO,EAAE,CAAC;SACP,KAAK,CACJ,CAAC,CAAC,MAAM,CAAC;QACP,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC;QACjC,QAAQ,EAAE,oBAAoB;KAC/B,CAAC,CACH;SACA,GAAG,CAAC,CAAC,CAAC;SACN,GAAG,CAAC,EAAE,CAAC;CACX,CAAC,CAAC;AAEH;;;;;;;;;GASG;AACH,MAAM,iBAAiB,GAAG,eAAe,CAAC,MAAM,CAAC;IAC/C,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC;IACzB,SAAS,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE;IACpC,SAAS,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAE;CACjD,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,CAAC,kBAAkB,CAAC,MAAM,EAAE;IACpE,eAAe;IACf,iBAAiB;IACjB,kBAAkB;IAClB,iBAAiB;IACjB,iBAAiB;CAClB,CAAC,CAAC;AAIH;;;;;;;;;;;;GAYG;AACH,SAAS,qBAAqB,CAC5B,KAA0B,EAC1B,KAAa,EACb,GAAoB;IAEpB,MAAM,MAAM,GAAG,CAAC,OAAe,EAAE,GAAW,EAAQ,EAAE;QACpD,GAAG,CAAC,QAAQ,CAAC;YACX,IAAI,EAAE,QAAQ;YACd,OAAO;YACP,IAAI,EAAE,CAAC,QAAQ,EAAE,KAAK,EAAE,GAAG,CAAC;SAC7B,CAAC,CAAC;IACL,CAAC,CAAC;IAEF,QAAQ,KAAK,CAAC,IAAI,EAAE,CAAC;QACnB,KAAK,MAAM,EAAE,CAAC;YACZ,IACE,KAAK,CAAC,SAAS,KAAK,SAAS;gBAC7B,KAAK,CAAC,SAAS,KAAK,SAAS;gBAC7B,KAAK,CAAC,SAAS,GAAG,KAAK,CAAC,SAAS,EACjC,CAAC;gBACD,MAAM,CAAC,8CAA8C,EAAE,WAAW,CAAC,CAAC;YACtE,CAAC;YACD,IAAI,KAAK,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;gBAChC,OAAO;YACT,CAAC;YACD,IACE,KAAK,CAAC,SAAS,KAAK,SAAS;gBAC7B,KAAK,CAAC,OAAO,CAAC,MAAM,GAAG,KAAK,CAAC,SAAS,EACtC,CAAC;gBACD,MAAM,CAAC,uCAAuC,EAAE,SAAS,CAAC,CAAC;YAC7D,CAAC;YACD,IACE,KAAK,CAAC,SAAS,KAAK,SAAS;gBAC7B,KAAK,CAAC,OAAO,CAAC,MAAM,GAAG,KAAK,CAAC,SAAS,EACtC,CAAC;gBACD,MAAM,CAAC,sCAAsC,EAAE,SAAS,CAAC,CAAC;YAC5D,CAAC;YACD,OAAO;QACT,CAAC;QACD,KAAK,QAAQ,EAAE,CAAC;YACd,IACE,KAAK,CAAC,GAAG,KAAK,SAAS;gBACvB,KAAK,CAAC,GAAG,KAAK,SAAS;gBACvB,KAAK,CAAC,GAAG,GAAG,KAAK,CAAC,GAAG,EACrB,CAAC;gBACD,MAAM,CAAC,kCAAkC,EAAE,KAAK,CAAC,CAAC;YACpD,CAAC;YACD,IAAI,KAAK,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;gBAChC,OAAO;YACT,CAAC;YACD,IAAI,KAAK,CAAC,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC;gBACtD,MAAM,CAAC,+BAA+B,EAAE,SAAS,CAAC,CAAC;YACrD,CAAC;YACD,IAAI,KAAK,CAAC,GAAG,KAAK,SAAS,IAAI,KAAK,CAAC,OAAO,GAAG,KAAK,CAAC,GAAG,EAAE,CAAC;gBACzD,MAAM,CAAC,0BAA0B,EAAE,SAAS,CAAC,CAAC;YAChD,CAAC;YACD,IAAI,KAAK,CAAC,GAAG,KAAK,SAAS,IAAI,KAAK,CAAC,OAAO,GAAG,KAAK,CAAC,GAAG,EAAE,CAAC;gBACzD,MAAM,CAAC,0BAA0B,EAAE,SAAS,CAAC,CAAC;YAChD,CAAC;YACD,OAAO;QACT,CAAC;QACD,KAAK,QAAQ,EAAE,CAAC;YACd,IACE,KAAK,CAAC,OAAO,KAAK,SAAS;gBAC3B,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,KAAK,KAAK,CAAC,OAAO,CAAC,EAC/D,CAAC;gBACD,MAAM,CAAC,gDAAgD,EAAE,SAAS,CAAC,CAAC;YACtE,CAAC;YACD,OAAO;QACT,CAAC;QACD,KAAK,QAAQ,EAAE,CAAC;YACd,IACE,KAAK,CAAC,SAAS,KAAK,SAAS;gBAC7B,KAAK,CAAC,SAAS,KAAK,SAAS;gBAC7B,KAAK,CAAC,SAAS,GAAG,KAAK,CAAC,SAAS,EACjC,CAAC;gBACD,MAAM,CAAC,8CAA8C,EAAE,WAAW,CAAC,CAAC;YACtE,CAAC;YACD,OAAO;QACT,CAAC;QACD,KAAK,SAAS;YACZ,OAAO;IACX,CAAC;AACH,CAAC;AAED,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC;KAClC,MAAM,CAAC;IACN,MAAM,EAAE,CAAC;SACN,KAAK,CAAC,yBAAyB,CAAC;SAChC,GAAG,CAAC,EAAE,CAAC;SACP,MAAM,CACL,CAAC,MAAM,EAAE,EAAE,CACT,IAAI,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,KAAK,MAAM,CAAC,MAAM,EAClE,EAAE,OAAO,EAAE,2BAA2B,EAAE,CACzC;CACJ,CAAC;KACD,WAAW,CAAC,CAAC,WAAW,EAAE,GAAG,EAAE,EAAE;IAChC,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;QAC1C,qBAAqB,CAAC,KAAK,EAAE,KAAK,EAAE,GAAG,CAAC,CAAC;IAC3C,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAML;;;GAGG;AACH,MAAM,UAAU,mBAAmB,CACjC,MAA4B;IAE5B,OAAO;QACL,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,KAAK,QAAQ,CAAC;KACjE,CAAC;AACJ,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,oBAAoB,CAClC,KAAuD;IAEvD,IAAI,MAAM,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,CAAC,SAAS,IAAI,CAAC,CAAC,CAAC,CAAC;IAC/D,IAAI,KAAK,CAAC,SAAS,KAAK,SAAS,EAAE,CAAC;QAClC,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;IACvC,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,iBAAiB,CAC/B,MAA4B;IAE5B,MAAM,KAAK,GAAiC,EAAE,CAAC;IAE/C,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;QAClC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,cAAc,CAAC,KAAK,CAAC,CAAC;IAC3C,CAAC;IAED,OAAO,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,KAAK,EAAgD,CAAC;AAC/E,CAAC;AAED,SAAS,cAAc,CAAC,KAA0B;IAChD,QAAQ,KAAK,CAAC,IAAI,EAAE,CAAC;QACnB,KAAK,MAAM,EAAE,CAAC;YACZ,IAAI,IAAI,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC;YACtB,IAAI,KAAK,CAAC,SAAS,KAAK,SAAS,EAAE,CAAC;gBAClC,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;YACnC,CAAC;YACD,IAAI,KAAK,CAAC,SAAS,KAAK,SAAS,EAAE,CAAC;gBAClC,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;YACnC,CAAC;YACD,sEAAsE;YACtE,qEAAqE;YACrE,mDAAmD;YACnD,OAAO,WAAW,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QACjE,CAAC;QACD,KAAK,QAAQ,EAAE,CAAC;YACd,IAAI,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;YAC3D,IAAI,KAAK,CAAC,GAAG,KAAK,SAAS,EAAE,CAAC;gBAC5B,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YACjC,CAAC;YACD,IAAI,KAAK,CAAC,GAAG,KAAK,SAAS,EAAE,CAAC;gBAC5B,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YACjC,CAAC;YACD,OAAO,WAAW,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;QACpC,CAAC;QACD,KAAK,SAAS;YACZ,OAAO,WAAW,CAAC,CAAC,CAAC,OAAO,EAAE,EAAE,KAAK,CAAC,CAAC;QACzC,KAAK,QAAQ;YACX,OAAO,WAAW,CAChB,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EACnD,KAAK,CACN,CAAC;QACJ,KAAK,QAAQ;YACX,OAAO,WAAW,CAAC,oBAAoB,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC,CAAC;IAC3D,CAAC;AACH,CAAC;AAED;;;;;GAKG;AACH,SAAS,WAAW,CAClB,SAAuB,EACvB,KAA0B;IAE1B,IAAI,SAAS,IAAI,KAAK,IAAI,KAAK,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;QACtD,OAAO,SAAS,CAAC,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAC1C,CAAC;IACD,OAAO,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC;AAC3D,CAAC;AAED,+EAA+E;AAC/E,MAAM,UAAU,eAAe,CAC7B,MAA4B;IAE5B,MAAM,MAAM,GAAyB,EAAE,CAAC;IACxC,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;QAClC,IAAI,SAAS,IAAI,KAAK,IAAI,KAAK,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;YACtD,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,OAAO,CAAC;QACpC,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openbrf/plugin-sdk",
-  "version": "1.0.0",
+  "version": "1.4.0",
   "description": "The public plugin contract for Open BRF: manifest schema, permission set and host service interfaces.",
   "license": "AGPL-3.0-only",
   "type": "module",
@@ -11,9 +11,9 @@
     }
   },
   "devDependencies": {
-    "@nestjs/common": "^12.1.3",
+    "@nestjs/common": "^12.2.0",
     "typescript": "^7.0.2",
-    "vite-plus": "1.2.0",
+    "vite-plus": "1.3.0",
     "zod": "^4.6.7"
   },
   "main": "./dist/index.js",
@@ -52,7 +52,7 @@
   "scripts": {
     "build": "tsc -p tsconfig.json",
     "lint": "vp lint .",
-    "typecheck": "tsc -p tsconfig.json --noEmit",
+    "typecheck": "tsc -p tsconfig.json --noEmit && tsc -p type-tests/tsconfig.dom.json && tsc -p type-tests/tsconfig.language.json",
     "test": "vp test run"
   }
 }

package/src/abort-signal.ts

@@ -0,0 +1,22 @@
+/**
+ * The `AbortSignal` the host hands a plugin, and takes from one.
+ *
+ * The host passes a real `AbortSignal`. This package compiles against the
+ * language alone and cannot name the platform's type, so it is looked up in
+ * the plugin's own program: where that has an `AbortSignal`, from the DOM
+ * library or from Node's types, this is it, and the signal can be passed on to
+ * `fetch` and to anything else that takes one. Where it has none, this is the
+ * part of one a plugin can use without them.
+ */
+export type PluginAbortSignal = typeof globalThis extends {
+  readonly AbortSignal: { readonly prototype: infer Signal };
+}
+  ? Signal
+  : PluginAbortSignalShape;
+
+/** What every `AbortSignal` has, for a program without the platform's types. */
+interface PluginAbortSignalShape {
+  readonly aborted: boolean;
+  addEventListener(type: "abort", listener: () => void): void;
+  removeEventListener(type: "abort", listener: () => void): void;
+}