@openbrf/plugin-sdk 0.0.0-stage → 1.2.0

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

@@ -0,0 +1,130 @@
+import { z } from "zod";
+export declare const pluginSettingsFieldSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    key: z.ZodString;
+    labelKey: z.ZodString;
+    hintKey: z.ZodOptional<z.ZodString>;
+    required: z.ZodDefault<z.ZodBoolean>;
+    type: z.ZodLiteral<"text">;
+    default: z.ZodOptional<z.ZodString>;
+    minLength: z.ZodOptional<z.ZodInt>;
+    maxLength: z.ZodOptional<z.ZodInt>;
+}, z.core.$strip>, z.ZodObject<{
+    key: z.ZodString;
+    labelKey: z.ZodString;
+    hintKey: z.ZodOptional<z.ZodString>;
+    required: z.ZodDefault<z.ZodBoolean>;
+    type: z.ZodLiteral<"number">;
+    default: z.ZodOptional<z.ZodNumber>;
+    min: z.ZodOptional<z.ZodNumber>;
+    max: z.ZodOptional<z.ZodNumber>;
+    integer: z.ZodDefault<z.ZodBoolean>;
+}, z.core.$strip>, z.ZodObject<{
+    key: z.ZodString;
+    labelKey: z.ZodString;
+    hintKey: z.ZodOptional<z.ZodString>;
+    required: z.ZodDefault<z.ZodBoolean>;
+    type: z.ZodLiteral<"boolean">;
+    default: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strip>, z.ZodObject<{
+    key: z.ZodString;
+    labelKey: z.ZodString;
+    hintKey: z.ZodOptional<z.ZodString>;
+    required: z.ZodDefault<z.ZodBoolean>;
+    type: z.ZodLiteral<"select">;
+    default: z.ZodOptional<z.ZodString>;
+    options: z.ZodArray<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">;
+export type PluginSettingsField = z.infer<typeof pluginSettingsFieldSchema>;
+export declare const pluginSettingsSchema: z.ZodObject<{
+    fields: z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
+        key: z.ZodString;
+        labelKey: z.ZodString;
+        hintKey: z.ZodOptional<z.ZodString>;
+        required: z.ZodDefault<z.ZodBoolean>;
+        type: z.ZodLiteral<"text">;
+        default: z.ZodOptional<z.ZodString>;
+        minLength: z.ZodOptional<z.ZodInt>;
+        maxLength: z.ZodOptional<z.ZodInt>;
+    }, z.core.$strip>, z.ZodObject<{
+        key: z.ZodString;
+        labelKey: z.ZodString;
+        hintKey: z.ZodOptional<z.ZodString>;
+        required: z.ZodDefault<z.ZodBoolean>;
+        type: z.ZodLiteral<"number">;
+        default: z.ZodOptional<z.ZodNumber>;
+        min: z.ZodOptional<z.ZodNumber>;
+        max: z.ZodOptional<z.ZodNumber>;
+        integer: z.ZodDefault<z.ZodBoolean>;
+    }, z.core.$strip>, z.ZodObject<{
+        key: z.ZodString;
+        labelKey: z.ZodString;
+        hintKey: z.ZodOptional<z.ZodString>;
+        required: z.ZodDefault<z.ZodBoolean>;
+        type: z.ZodLiteral<"boolean">;
+        default: z.ZodOptional<z.ZodBoolean>;
+    }, z.core.$strip>, z.ZodObject<{
+        key: z.ZodString;
+        labelKey: z.ZodString;
+        hintKey: z.ZodOptional<z.ZodString>;
+        required: z.ZodDefault<z.ZodBoolean>;
+        type: z.ZodLiteral<"select">;
+        default: z.ZodOptional<z.ZodString>;
+        options: z.ZodArray<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.
+ *
+ * Produced from the declaration rather than written by the plugin, so the
+ * form the host renders and the values the host stores can never disagree
+ * 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. */
+export declare function defaultSettings(schema: PluginSettingsSchema): PluginSettingsValues;
+//# sourceMappingURL=settings-schema.d.ts.map

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

@@ -0,0 +1 @@
+{"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

@@ -0,0 +1,272 @@
+import { z } from "zod";
+/**
+ * A plugin's settings form, declared rather than drawn.
+ *
+ * The host renders it, validates against it, and stores the result. A plugin
+ * therefore never ships a settings screen of its own, which is what keeps
+ * plugin settings looking like the rest of the product and keeps the values
+ * validated on the server rather than only in a form the plugin drew.
+ *
+ * Labels are i18n KEYS, resolved in the plugin's own namespace
+ * (`plugin-<id>`, merged at runtime from its locales/{sv,en}.json). Inline
+ * label text is deliberately not accepted: a manifest carrying English prose
+ * would put an untranslatable string on a Swedish-first screen, and the
+ * runtime merge already exists to hold that text.
+ */
+const settingsKeySchema = z
+    .string()
+    .min(1)
+    .max(64)
+    // A settings key becomes a JSON object key and a form field name. Keeping it
+    // to an identifier shape means a stored value can never collide with a
+    // prototype member or need escaping in either place.
+    .regex(/^[a-z][a-zA-Z0-9_]*$/, "must be a lowerCamelCase identifier");
+const translationKeySchema = z.string().min(1).max(200);
+const baseFieldSchema = z.object({
+    key: settingsKeySchema,
+    labelKey: translationKeySchema,
+    /** Help text under the field. Never the only carrier of a requirement. */
+    hintKey: translationKeySchema.optional(),
+    required: z.boolean().default(false),
+});
+const textFieldSchema = baseFieldSchema.extend({
+    type: z.literal("text"),
+    default: z.string().optional(),
+    minLength: z.int().min(0).optional(),
+    maxLength: z.int().min(1).max(10_000).optional(),
+});
+const numberFieldSchema = baseFieldSchema.extend({
+    type: z.literal("number"),
+    default: z.number().optional(),
+    min: z.number().optional(),
+    max: z.number().optional(),
+    integer: z.boolean().default(false),
+});
+const booleanFieldSchema = baseFieldSchema.extend({
+    type: z.literal("boolean"),
+    default: z.boolean().optional(),
+});
+const selectFieldSchema = baseFieldSchema.extend({
+    type: z.literal("select"),
+    default: z.string().optional(),
+    options: z
+        .array(z.object({
+        value: z.string().min(1).max(200),
+        labelKey: translationKeySchema,
+    }))
+        .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.
+ *
+ * Done while the manifest is parsed rather than left to the validator, because
+ * neither of the two paths a default takes goes through the field's
+ * constraints. `.default(value)` short-circuits an absent value and returns it
+ * without applying anything downstream, and `defaultSettings` reads the
+ * declaration directly. A number field declaring `min: 10, default: 5` would
+ * otherwise hand the plugin a 5 it said it would never see, and
+ * `minLength: 10, maxLength: 2` would declare a field no submitted value can
+ * satisfy - both of which are the plugin's mistake to hear about at install
+ * time rather than the board's to discover at a save.
+ */
+function checkFieldConstraints(field, index, ctx) {
+    const reject = (message, key) => {
+        ctx.addIssue({
+            code: "custom",
+            message,
+            path: ["fields", index, key],
+        });
+    };
+    switch (field.type) {
+        case "text": {
+            if (field.minLength !== undefined &&
+                field.maxLength !== undefined &&
+                field.minLength > field.maxLength) {
+                reject("minLength must not be greater than maxLength", "minLength");
+            }
+            if (field.default === undefined) {
+                return;
+            }
+            if (field.minLength !== undefined &&
+                field.default.length < field.minLength) {
+                reject("the default is shorter than minLength", "default");
+            }
+            if (field.maxLength !== undefined &&
+                field.default.length > field.maxLength) {
+                reject("the default is longer than maxLength", "default");
+            }
+            return;
+        }
+        case "number": {
+            if (field.min !== undefined &&
+                field.max !== undefined &&
+                field.min > field.max) {
+                reject("min must not be greater than max", "min");
+            }
+            if (field.default === undefined) {
+                return;
+            }
+            if (field.integer && !Number.isInteger(field.default)) {
+                reject("the default is not an integer", "default");
+            }
+            if (field.min !== undefined && field.default < field.min) {
+                reject("the default is below min", "default");
+            }
+            if (field.max !== undefined && field.default > field.max) {
+                reject("the default is above max", "default");
+            }
+            return;
+        }
+        case "select": {
+            if (field.default !== undefined &&
+                !field.options.some((option) => option.value === field.default)) {
+                reject("the default is not one of the declared options", "default");
+            }
+            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;
+    }
+}
+export const pluginSettingsSchema = z
+    .object({
+    fields: z
+        .array(pluginSettingsFieldSchema)
+        .max(50)
+        .refine((fields) => new Set(fields.map((field) => field.key)).size === fields.length, { message: "field keys must be unique" }),
+})
+    .superRefine((declaration, ctx) => {
+    declaration.fields.forEach((field, index) => {
+        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.
+ *
+ * Produced from the declaration rather than written by the plugin, so the
+ * form the host renders and the values the host stores can never disagree
+ * 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 = {};
+    for (const field of schema.fields) {
+        shape[field.key] = fieldValidator(field);
+    }
+    return z.object(shape).strip();
+}
+function fieldValidator(field) {
+    switch (field.type) {
+        case "text": {
+            let text = z.string();
+            if (field.minLength !== undefined) {
+                text = text.min(field.minLength);
+            }
+            if (field.maxLength !== undefined) {
+                text = text.max(field.maxLength);
+            }
+            // A required text field rejects the empty string. Without this a form
+            // submitted with the field untouched would satisfy "required" with a
+            // value the plugin has to treat as missing anyway.
+            return optionality(field.required ? text.min(1) : text, field);
+        }
+        case "number": {
+            let number = field.integer ? z.number().int() : z.number();
+            if (field.min !== undefined) {
+                number = number.min(field.min);
+            }
+            if (field.max !== undefined) {
+                number = number.max(field.max);
+            }
+            return optionality(number, field);
+        }
+        case "boolean":
+            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);
+    }
+}
+/**
+ * Applies the declared default and, for an optional field, tolerates absence.
+ *
+ * A default makes the field satisfied whether or not it was submitted, which
+ * is why it is applied before the optional wrapper rather than after.
+ */
+function optionality(validator, field) {
+    if ("default" in field && field.default !== undefined) {
+        return validator.default(field.default);
+    }
+    return field.required ? validator : validator.optional();
+}
+/** The values a fresh installation starts with, from the declared defaults. */
+export function defaultSettings(schema) {
+    const values = {};
+    for (const field of schema.fields) {
+        if ("default" in field && field.default !== undefined) {
+            values[field.key] = field.default;
+        }
+    }
+    return values;
+}
+//# sourceMappingURL=settings-schema.js.map

package/dist/settings-schema.js.map

@@ -0,0 +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;;;;;;;;;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/dist/standard-schema.d.ts

@@ -0,0 +1,43 @@
+/**
+ * The Standard Schema interface, version 1, as this package needs it.
+ *
+ * Declared here rather than imported, for the reason the rest of this package
+ * declares its own types: what an action's input and output are validated by is
+ * the host's business, and naming a validator in the published contract would
+ * make every plugin author's build depend on the one the host happens to use
+ * today. A structural interface says what the host requires - something that can
+ * validate an unknown value and report issues - and any library implementing the
+ * standard satisfies it, zod included.
+ *
+ * It is a subset: the parts the registry actually calls. `validate` is the one
+ * that matters, and note that it RETURNS its issues rather than throwing, which
+ * is the difference between this and a validator's own `parse`.
+ *
+ * The full specification is at standardschema.dev.
+ */
+export interface StandardSchemaV1<Input = unknown, Output = Input> {
+    readonly "~standard": {
+        /** The version of the standard this schema implements. */
+        readonly version: 1;
+        /** The library that produced the schema, for diagnostics. */
+        readonly vendor: string;
+        readonly validate: (value: unknown) => StandardSchemaResult<Output> | Promise<StandardSchemaResult<Output>>;
+        readonly types?: {
+            readonly input: Input;
+            readonly output: Output;
+        } | undefined;
+    };
+}
+export type StandardSchemaResult<Output> = {
+    readonly value: Output;
+    readonly issues?: undefined;
+} | {
+    readonly issues: readonly StandardSchemaIssue[];
+};
+export interface StandardSchemaIssue {
+    readonly message: string;
+    readonly path?: readonly (PropertyKey | {
+        readonly key: PropertyKey;
+    })[];
+}
+//# sourceMappingURL=standard-schema.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"standard-schema.d.ts","sourceRoot":"","sources":["../src/standard-schema.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,WAAW,gBAAgB,CAAC,KAAK,GAAG,OAAO,EAAE,MAAM,GAAG,KAAK;IAC/D,QAAQ,CAAC,WAAW,EAAE;QACpB,0DAA0D;QAC1D,QAAQ,CAAC,OAAO,EAAE,CAAC,CAAC;QACpB,6DAA6D;QAC7D,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;QACxB,QAAQ,CAAC,QAAQ,EAAE,CACjB,KAAK,EAAE,OAAO,KACX,oBAAoB,CAAC,MAAM,CAAC,GAAG,OAAO,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC,CAAC;QAC1E,QAAQ,CAAC,KAAK,CAAC,EACb;YAAE,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC;YAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;SAAE,GAAG,SAAS,CAAC;KAClE,CAAC;CACH;AAED,MAAM,MAAM,oBAAoB,CAAC,MAAM,IACnC;IAAE,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,SAAS,CAAA;CAAE,GACvD;IAAE,QAAQ,CAAC,MAAM,EAAE,SAAS,mBAAmB,EAAE,CAAA;CAAE,CAAC;AAExD,MAAM,WAAW,mBAAmB;IAClC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,IAAI,CAAC,EAAE,SAAS,CAAC,WAAW,GAAG;QAAE,QAAQ,CAAC,GAAG,EAAE,WAAW,CAAA;KAAE,CAAC,EAAE,CAAC;CAC1E"}

package/dist/standard-schema.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=standard-schema.js.map

package/dist/standard-schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"standard-schema.js","sourceRoot":"","sources":["../src/standard-schema.ts"],"names":[],"mappings":""}

package/package.json

@@ -1,6 +1,58 @@
 {
   "name": "@openbrf/plugin-sdk",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "1.2.0",
+  "description": "The public plugin contract for Open BRF: manifest schema, permission set and host service interfaces.",
+  "license": "AGPL-3.0-only",
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "devDependencies": {
+    "@nestjs/common": "^12.2.0",
+    "typescript": "^7.0.2",
+    "vite-plus": "1.3.0",
+    "zod": "^4.6.7"
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist",
+    "src",
+    "!src/**/*.spec.ts",
+    "LICENSE",
+    "LICENSE-EXCEPTION.md"
+  ],
+  "publishConfig": {
+    "access": "public",
+    "provenance": true,
+    "registry": "https://registry.npmjs.org/"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/openbrf/openbrf.git",
+    "directory": "packages/plugin-sdk"
+  },
+  "peerDependencies": {
+    "@nestjs/common": "^12.0.0"
+  },
+  "peerDependenciesMeta": {
+    "@nestjs/common": {
+      "optional": true
+    }
+  },
+  "dependencies": {
+    "zod": "^4.6.7"
+  },
+  "bugs": {
+    "url": "https://github.com/openbrf/openbrf/issues"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "lint": "vp lint .",
+    "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;
+}