@openbrf/plugin-sdk 0.0.0-stage → 1.0.0

package/LICENSE-EXCEPTION.md

@@ -0,0 +1,28 @@
+# Open BRF Module Exception
+
+Version 1.0
+
+## The exception
+
+As an additional permission under section 7 of the GNU Affero General Public License, version 3 ("AGPL-3.0"), the copyright holders of Open BRF give you permission to combine Open BRF with modules.
+
+A "module" is a plugin, theme, or other extension package that interacts with the Open BRF core exclusively through the documented public extension interfaces: the plugin API, the theme/token contract, the public HTTP API, and the extension points declared in the module manifest format (together, the "Module API").
+
+If you create and convey a module:
+
+1. The module is **not** considered a work based on Open BRF for the purposes of AGPL-3.0, regardless of the linking or loading mechanism.
+2. You may license the module under terms of your own choosing, including proprietary terms; nothing requires you to convey the module's source code.
+3. Running a combined work consisting of an unmodified Open BRF core and one or more modules, including offering it to users over a network, does not extend the obligations of AGPL-3.0 (including section 13) to the modules.
+
+This exception does **not** apply to:
+
+- Modifications of the Open BRF core itself, which remain governed by AGPL-3.0 in full. A "module" that patches, replaces, or bundles modified core code is a modification of the core, not a module.
+- The obligations of AGPL-3.0 regarding the core: anyone conveying or network-hosting a modified core must still offer its Corresponding Source.
+
+As provided by section 7 of AGPL-3.0, you may remove this additional permission from your copy, but you may not add further restrictions.
+
+## Why this exists
+
+The legal status of in-process plugins to (A)GPL software is a decades-old gray zone. Rather than relying on it, Open BRF states the rule explicitly, in both directions: the core is and remains copyleft, and the module ecosystem - community and commercial alike - is legally safe to build in. Vendure pioneered this model for GPL; Open BRF applies it to AGPL.
+
+This exception is granted by Apteo AB as copyright holder of Open BRF. Contributions are accepted under a [CLA](CLA.md) precisely so that this grant remains valid for the whole codebase.

package/dist/action-schema.d.ts

@@ -0,0 +1,42 @@
+import { z } from "zod";
+import type { StandardSchemaV1 } from "./standard-schema.ts";
+/**
+ * An action's schemas, as the JSON Schema a caller is published.
+ *
+ * The only call to `z.toJSONSchema` in the product. Every option here is set
+ * against a failure that would otherwise be silent, so they are worth reading
+ * one at a time.
+ *
+ * `io: "input"` because output mode makes a key with a default REQUIRED, and a
+ * model reading that will dutifully supply a value for every field the platform
+ * was perfectly happy to choose itself.
+ *
+ * `cycles: "throw"` because a self-referential schema has no JSON Schema
+ * without `$ref`, and a silently emitted `$ref` to a positional name is worse
+ * than a refusal at registration.
+ *
+ * `reused: "inline"` because `$defs` invents names from the position a schema
+ * happens to hold, and those names would reach a committed artefact and a
+ * third-party client. Inlining costs bytes and keeps the document stable.
+ *
+ * The function form of `unrepresentable` because the default error names
+ * neither the action nor the path, and a build failing with "unrepresentable
+ * type" and nothing else is a half hour of searching.
+ *
+ * One property is worth stating because it is NOT what one would assume: a bare
+ * `.transform()` does not throw under input mode - it is erased and the
+ * pre-transform type is emitted. The guarantee is placed where it is real, on
+ * the output helper, which does throw. So an action whose pair is converted at
+ * registration cannot carry a transform anywhere.
+ *
+ * `.refine()`, `.check()`, `.superRefine()` and `.brand()` are erased with no
+ * marker under both modes. That is why the rule for a published schema is
+ * structural constraints first: what the document says has to be at least as
+ * strict as what the runtime enforces, or a caller is told a value is
+ * acceptable that the service will refuse.
+ */
+/** Refuses a schema built with a second copy of zod, whose internals differ. */
+export declare function isHostZodSchema(schema: unknown): schema is z.ZodType;
+export declare function actionInputJsonSchema(schema: StandardSchemaV1<unknown, unknown>, actionName: string): Record<string, unknown>;
+export declare function actionOutputJsonSchema(schema: StandardSchemaV1<unknown, unknown>, actionName: string): Record<string, unknown>;
+//# sourceMappingURL=action-schema.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"action-schema.d.ts","sourceRoot":"","sources":["../src/action-schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAE7D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AAEH,gFAAgF;AAChF,wBAAgB,eAAe,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,IAAI,CAAC,CAAC,OAAO,CAOpE;AAyBD,wBAAgB,qBAAqB,CACnC,MAAM,EAAE,gBAAgB,CAAC,OAAO,EAAE,OAAO,CAAC,EAC1C,UAAU,EAAE,MAAM,GACjB,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAEzB;AAED,wBAAgB,sBAAsB,CACpC,MAAM,EAAE,gBAAgB,CAAC,OAAO,EAAE,OAAO,CAAC,EAC1C,UAAU,EAAE,MAAM,GACjB,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAEzB"}

package/dist/action-schema.js

@@ -0,0 +1,64 @@
+import { z } from "zod";
+/**
+ * An action's schemas, as the JSON Schema a caller is published.
+ *
+ * The only call to `z.toJSONSchema` in the product. Every option here is set
+ * against a failure that would otherwise be silent, so they are worth reading
+ * one at a time.
+ *
+ * `io: "input"` because output mode makes a key with a default REQUIRED, and a
+ * model reading that will dutifully supply a value for every field the platform
+ * was perfectly happy to choose itself.
+ *
+ * `cycles: "throw"` because a self-referential schema has no JSON Schema
+ * without `$ref`, and a silently emitted `$ref` to a positional name is worse
+ * than a refusal at registration.
+ *
+ * `reused: "inline"` because `$defs` invents names from the position a schema
+ * happens to hold, and those names would reach a committed artefact and a
+ * third-party client. Inlining costs bytes and keeps the document stable.
+ *
+ * The function form of `unrepresentable` because the default error names
+ * neither the action nor the path, and a build failing with "unrepresentable
+ * type" and nothing else is a half hour of searching.
+ *
+ * One property is worth stating because it is NOT what one would assume: a bare
+ * `.transform()` does not throw under input mode - it is erased and the
+ * pre-transform type is emitted. The guarantee is placed where it is real, on
+ * the output helper, which does throw. So an action whose pair is converted at
+ * registration cannot carry a transform anywhere.
+ *
+ * `.refine()`, `.check()`, `.superRefine()` and `.brand()` are erased with no
+ * marker under both modes. That is why the rule for a published schema is
+ * structural constraints first: what the document says has to be at least as
+ * strict as what the runtime enforces, or a caller is told a value is
+ * acceptable that the service will refuse.
+ */
+/** Refuses a schema built with a second copy of zod, whose internals differ. */
+export function isHostZodSchema(schema) {
+    return (typeof schema === "object" &&
+        schema !== null &&
+        "_zod" in schema &&
+        schema._zod !== undefined);
+}
+function convert(schema, actionName, io) {
+    if (!isHostZodSchema(schema)) {
+        throw new Error(`${actionName}: an action schema must be built with the host's zod.`);
+    }
+    return z.toJSONSchema(schema, {
+        target: "draft-2020-12",
+        io,
+        cycles: "throw",
+        reused: "inline",
+        unrepresentable: ({ path, message }) => {
+            throw new Error(`${actionName}: ${message} at ${[io, ...path.map(String)].join(".")}`);
+        },
+    });
+}
+export function actionInputJsonSchema(schema, actionName) {
+    return convert(schema, actionName, "input");
+}
+export function actionOutputJsonSchema(schema, actionName) {
+    return convert(schema, actionName, "output");
+}
+//# sourceMappingURL=action-schema.js.map

package/dist/action-schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"action-schema.js","sourceRoot":"","sources":["../src/action-schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAIxB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AAEH,gFAAgF;AAChF,MAAM,UAAU,eAAe,CAAC,MAAe;IAC7C,OAAO,CACL,OAAO,MAAM,KAAK,QAAQ;QAC1B,MAAM,KAAK,IAAI;QACf,MAAM,IAAI,MAAM;QACf,MAA6B,CAAC,IAAI,KAAK,SAAS,CAClD,CAAC;AACJ,CAAC;AAED,SAAS,OAAO,CACd,MAAe,EACf,UAAkB,EAClB,EAAsB;IAEtB,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,EAAE,CAAC;QAC7B,MAAM,IAAI,KAAK,CACb,GAAG,UAAU,uDAAuD,CACrE,CAAC;IACJ,CAAC;IACD,OAAO,CAAC,CAAC,YAAY,CAAC,MAAM,EAAE;QAC5B,MAAM,EAAE,eAAe;QACvB,EAAE;QACF,MAAM,EAAE,OAAO;QACf,MAAM,EAAE,QAAQ;QAChB,eAAe,EAAE,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,EAAE,EAAE;YACrC,MAAM,IAAI,KAAK,CACb,GAAG,UAAU,KAAK,OAAO,OAAO,CAAC,EAAE,EAAE,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CACtE,CAAC;QACJ,CAAC;KACF,CAA4B,CAAC;AAChC,CAAC;AAED,MAAM,UAAU,qBAAqB,CACnC,MAA0C,EAC1C,UAAkB;IAElB,OAAO,OAAO,CAAC,MAAM,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC;AAC9C,CAAC;AAED,MAAM,UAAU,sBAAsB,CACpC,MAA0C,EAC1C,UAAkB;IAElB,OAAO,OAAO,CAAC,MAAM,EAAE,UAAU,EAAE,QAAQ,CAAC,CAAC;AAC/C,CAAC"}

package/dist/actions.d.ts

@@ -0,0 +1,199 @@
+import type { StandardSchemaV1 } from "./standard-schema.ts";
+/**
+ * What the platform can be asked to do, declared once and dispatched through
+ * one place: an action (atgard).
+ *
+ * An action is a name, an input schema, the single capability it needs, what it
+ * does to the records, which categories of personal data it can touch, and which
+ * surfaces it may be offered on. The registry checks the calling person's
+ * capability on every call rather than trusting the caller, so registering an
+ * action is never a permission of its own - it is a way of reaching something
+ * the caller could already do.
+ *
+ * A core feature registers its own. A plugin registers the ones its manifest
+ * declared and the board consented to, and they disappear with the plugin.
+ *
+ * Swedish domain terms follow GLOSSARY.md.
+ */
+export declare const ACTION_EFFECTS: readonly ["read", "write", "delete"];
+export type ActionEffect = (typeof ACTION_EFFECTS)[number];
+/**
+ * Where an action may be offered.
+ *
+ * "ui" means in-process only: the platform's own screens and a plugin's own
+ * route. The other two are the ones a board switches on deliberately.
+ */
+export declare const ACTION_SURFACES: readonly ["ui", "mcp", "ai"];
+export type ActionSurface = (typeof ACTION_SURFACES)[number];
+/**
+ * What an action can touch.
+ *
+ * The first thirteen are PERSONAL_DATA_CATEGORIES from @openbrf/shared, in
+ * order, which this package deliberately does not depend on; the API side
+ * asserts the prefix equality, because it is the only place that can import
+ * both. "protected" is this list's own and marks an action that can return a
+ * field of a person carrying protected personal data (skyddade
+ * personuppgifter): it is the value the registry refuses to expose to a
+ * connected app or to the AI package at all.
+ */
+export declare const ACTION_PERSONAL_DATA: readonly ["name", "apartment", "residency", "email", "phone", "postalAddress", "personalIdentityNumber", "account", "financial", "health", "photograph", "freeText", "auditTrail", "protected"];
+export type ActionPersonalData = (typeof ACTION_PERSONAL_DATA)[number];
+/**
+ * What a public action name may look like.
+ *
+ * The intersection of three separate limits: what an MCP tools/list entry
+ * allows, what a model API allows (no dots), and what stays readable in a
+ * directory review (64 characters).
+ */
+export declare const ACTION_NAME_PATTERN: RegExp;
+/** What a refusal means for a caller that is a model rather than a person. */
+export interface ActionErrorSpec {
+    /** The machine-readable reason the handler raises. */
+    readonly reason: string;
+    /** Whether trying again could ever work, and after what. */
+    readonly retry: "never" | "after-edit" | "after-backoff";
+    /** The sentence a person is shown, as an i18n key. */
+    readonly messageKey: string;
+}
+/**
+ * The request a plugin's own route received.
+ *
+ * Opaque on purpose: the host reads a symbol on it that only the host writes,
+ * so a plugin passes the request it was handed straight through and cannot
+ * construct one. That is what stops a plugin naming a person it was not given.
+ */
+export type ActionRequest = object;
+/** The lowercase channel vocabulary. The registry maps it to the audit channel. */
+export declare const ACTION_CHANNELS: readonly ["web", "mcp", "ai", "system", "plugin"];
+export type ActionChannel = (typeof ACTION_CHANNELS)[number];
+/**
+ * Who is acting.
+ *
+ * The person, and the capabilities the registry re-derived for this call. No
+ * email, no name, no roles: a handler that needs to decide what an audience may
+ * see reads the capability list, and a handler that does not need it is not
+ * given a person's details to leak.
+ */
+export interface ActionPrincipal {
+    readonly personId: string;
+    readonly capabilities: readonly string[];
+}
+/** The connected app that acted, when one did. Both hosts, never the token. */
+export interface ActionClient {
+    readonly clientId: string;
+    readonly clientHost: string | null;
+}
+/** What a handler is told about the call. Built by the host, never by a caller. */
+export interface ActionContext {
+    readonly principal: ActionPrincipal;
+    readonly channel: ActionChannel;
+    readonly client?: ActionClient;
+    readonly requestId: string;
+    readonly now: Date;
+}
+export interface ActionDefinition<Input = unknown, Output = unknown> {
+    readonly name: string;
+    readonly titleKey: string;
+    readonly descriptionKey: string;
+    readonly group: string;
+    readonly groupTitleKey: string;
+    /** Exactly one core capability, by name. */
+    readonly capability: string;
+    readonly effect: ActionEffect;
+    readonly idempotent: boolean;
+    /**
+     * True when the act adds and overwrites nothing a person wrote.
+     *
+     * It is what separates a create from an update, and the annotation mapping
+     * reads it: MCP's destructiveHint defaults to true, so a non-read action has
+     * to say for itself that it destroys nothing.
+     */
+    readonly additive: boolean;
+    readonly needsConfirmation: boolean;
+    /** True when the handler reaches a system outside this instance. */
+    readonly openWorld: boolean;
+    /** Never empty by convention: an action that touches none says []. */
+    readonly personalData: readonly ActionPersonalData[];
+    /** Opt-in allowlist. An empty array means the action is offered nowhere. */
+    readonly surfaces: readonly ActionSurface[];
+    /** Every domain refusal the handler can raise, for the caller to act on. */
+    readonly errors: readonly ActionErrorSpec[];
+    readonly deprecatedAliases?: readonly string[];
+    /** Every object in it, at every depth, must refuse unknown keys. */
+    readonly input: StandardSchemaV1<unknown, Input>;
+    readonly output: StandardSchemaV1<unknown, Output>;
+    readonly handler: (input: Input, context: ActionContext) => Promise<Output>;
+}
+/**
+ * What a plugin hands the host: the id its manifest declared, and the rest.
+ *
+ * The capability, the effect, the personal-data categories and the surfaces are
+ * manifest data and are not repeated here. The loader's rule is that nothing
+ * which can refuse a plugin may run after the code that executes it, and the
+ * install consent screen renders from the catalog before anything is
+ * downloaded - so what the board consents to cannot come from the bundle.
+ */
+export interface PluginActionRegistration {
+    readonly id: string;
+    readonly definition: Omit<ActionDefinition, "capability" | "effect" | "personalData" | "surfaces">;
+}
+/** Narrows what a plugin's route offers the request it is serving. */
+export interface PluginActionFilter {
+    readonly surface?: ActionSurface;
+    readonly group?: string;
+}
+/** One action as a caller sees it, with its text already in the right language. */
+export interface ActionSummary {
+    readonly name: string;
+    readonly title: string;
+    readonly description: string;
+    readonly titleKey: string;
+    readonly descriptionKey: string;
+    readonly group: string;
+    readonly groupTitle: string;
+    /**
+     * The key behind `groupTitle`, alongside the two above.
+     *
+     * Both forms travel for the reason `titleKey` does: the resolved string is
+     * for a caller with no translations of its own - a connected app, a model -
+     * while a screen in this product translates the key itself. The interface's
+     * language and the language a request happens to declare are not the same
+     * thing, so a screen rendering the resolved string can show one heading in
+     * the browser's language above a page in the association's.
+     */
+    readonly groupTitleKey: string;
+    readonly capability: string;
+    readonly effect: ActionEffect;
+    readonly idempotent: boolean;
+    readonly additive: boolean;
+    readonly needsConfirmation: boolean;
+    readonly openWorld: boolean;
+    readonly personalData: readonly ActionPersonalData[];
+    readonly surfaces: readonly ActionSurface[];
+    readonly errors: readonly ActionErrorSpec[];
+}
+export interface PluginActions {
+    /**
+     * Registers an action the manifest declared.
+     *
+     * Callable from the module factory onwards: a call made that early is
+     * buffered until the application is built, because the host object is not
+     * bound yet.
+     *
+     * It does not throw for a registration the host will refuse. An id the
+     * manifest never declared, or a schema that cannot be published, is found
+     * when the buffer is flushed - long after this call returned - and reaches
+     * the board as an `action-refused` finding rather than as an error the
+     * factory could have caught. A plugin that wants to know sooner validates
+     * its own manifest in its own build.
+     */
+    register: (registration: PluginActionRegistration) => void;
+    /** What this plugin's route may offer the request it is serving. */
+    list: (request: ActionRequest, filter?: PluginActionFilter) => Promise<ActionSummary[]>;
+    /**
+     * Dispatch. The person, the channel and the connected app all come from the
+     * request the host authenticated, never from an argument.
+     */
+    invoke: <Output>(request: ActionRequest, name: string, input: unknown) => Promise<Output>;
+}
+//# sourceMappingURL=actions.d.ts.map

package/dist/actions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"actions.d.ts","sourceRoot":"","sources":["../src/actions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAE7D;;;;;;;;;;;;;;;GAeG;AAEH,eAAO,MAAM,cAAc,YAAI,MAAM,EAAE,OAAO,EAAE,QAAQ,CAAU,CAAC;AACnE,MAAM,MAAM,YAAY,GAAG,CAAC,OAAO,cAAc,CAAC,CAAC,MAAM,CAAC,CAAC;AAE3D;;;;;GAKG;AACH,eAAO,MAAM,eAAe,YAAI,IAAI,EAAE,KAAK,EAAE,IAAI,CAAU,CAAC;AAC5D,MAAM,MAAM,aAAa,GAAG,CAAC,OAAO,eAAe,CAAC,CAAC,MAAM,CAAC,CAAC;AAE7D;;;;;;;;;;GAUG;AACH,eAAO,MAAM,oBAAoB,YAC/B,MAAM,EACN,WAAW,EACX,WAAW,EACX,OAAO,EACP,OAAO,EACP,eAAe,EACf,wBAAwB,EACxB,SAAS,EACT,WAAW,EACX,QAAQ,EACR,YAAY,EACZ,UAAU,EACV,YAAY,EACZ,WAAW,CACH,CAAC;AACX,MAAM,MAAM,kBAAkB,GAAG,CAAC,OAAO,oBAAoB,CAAC,CAAC,MAAM,CAAC,CAAC;AAEvE;;;;;;GAMG;AACH,eAAO,MAAM,mBAAmB,QAA2B,CAAC;AAE5D,8EAA8E;AAC9E,MAAM,WAAW,eAAe;IAC9B,sDAAsD;IACtD,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,4DAA4D;IAC5D,QAAQ,CAAC,KAAK,EAAE,OAAO,GAAG,YAAY,GAAG,eAAe,CAAC;IACzD,sDAAsD;IACtD,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;CAC7B;AAED;;;;;;GAMG;AACH,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC;AAEnC,mFAAmF;AACnF,eAAO,MAAM,eAAe,YAC1B,KAAK,EACL,KAAK,EACL,IAAI,EACJ,QAAQ,EACR,QAAQ,CACA,CAAC;AACX,MAAM,MAAM,aAAa,GAAG,CAAC,OAAO,eAAe,CAAC,CAAC,MAAM,CAAC,CAAC;AAE7D;;;;;;;GAOG;AACH,MAAM,WAAW,eAAe;IAC9B,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,YAAY,EAAE,SAAS,MAAM,EAAE,CAAC;CAC1C;AAED,+EAA+E;AAC/E,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;CACpC;AAED,mFAAmF;AACnF,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,SAAS,EAAE,eAAe,CAAC;IACpC,QAAQ,CAAC,OAAO,EAAE,aAAa,CAAC;IAChC,QAAQ,CAAC,MAAM,CAAC,EAAE,YAAY,CAAC;IAC/B,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,GAAG,EAAE,IAAI,CAAC;CACpB;AAED,MAAM,WAAW,gBAAgB,CAAC,KAAK,GAAG,OAAO,EAAE,MAAM,GAAG,OAAO;IACjE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC;IAChC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC;IAC/B,4CAA4C;IAC5C,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,MAAM,EAAE,YAAY,CAAC;IAC9B,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAC;IAC7B;;;;;;OAMG;IACH,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC;IAC3B,QAAQ,CAAC,iBAAiB,EAAE,OAAO,CAAC;IACpC,oEAAoE;IACpE,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC;IAC5B,sEAAsE;IACtE,QAAQ,CAAC,YAAY,EAAE,SAAS,kBAAkB,EAAE,CAAC;IACrD,4EAA4E;IAC5E,QAAQ,CAAC,QAAQ,EAAE,SAAS,aAAa,EAAE,CAAC;IAC5C,4EAA4E;IAC5E,QAAQ,CAAC,MAAM,EAAE,SAAS,eAAe,EAAE,CAAC;IAC5C,QAAQ,CAAC,iBAAiB,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IAC/C,oEAAoE;IACpE,QAAQ,CAAC,KAAK,EAAE,gBAAgB,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IACjD,QAAQ,CAAC,MAAM,EAAE,gBAAgB,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;IACnD,QAAQ,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,aAAa,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;CAC7E;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,wBAAwB;IACvC,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,UAAU,EAAE,IAAI,CACvB,gBAAgB,EAChB,YAAY,GAAG,QAAQ,GAAG,cAAc,GAAG,UAAU,CACtD,CAAC;CACH;AAED,sEAAsE;AACtE,MAAM,WAAW,kBAAkB;IACjC,QAAQ,CAAC,OAAO,CAAC,EAAE,aAAa,CAAC;IACjC,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,mFAAmF;AACnF,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC;IAChC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B;;;;;;;;;OASG;IACH,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC;IAC/B,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,MAAM,EAAE,YAAY,CAAC;IAC9B,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAC;IAC7B,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC;IAC3B,QAAQ,CAAC,iBAAiB,EAAE,OAAO,CAAC;IACpC,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC;IAC5B,QAAQ,CAAC,YAAY,EAAE,SAAS,kBAAkB,EAAE,CAAC;IACrD,QAAQ,CAAC,QAAQ,EAAE,SAAS,aAAa,EAAE,CAAC;IAC5C,QAAQ,CAAC,MAAM,EAAE,SAAS,eAAe,EAAE,CAAC;CAC7C;AAED,MAAM,WAAW,aAAa;IAC5B;;;;;;;;;;;;;OAaG;IACH,QAAQ,EAAE,CAAC,YAAY,EAAE,wBAAwB,KAAK,IAAI,CAAC;IAE3D,oEAAoE;IACpE,IAAI,EAAE,CACJ,OAAO,EAAE,aAAa,EACtB,MAAM,CAAC,EAAE,kBAAkB,KACxB,OAAO,CAAC,aAAa,EAAE,CAAC,CAAC;IAE9B;;;OAGG;IACH,MAAM,EAAE,CAAC,MAAM,EACb,OAAO,EAAE,aAAa,EACtB,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,OAAO,KACX,OAAO,CAAC,MAAM,CAAC,CAAC;CACtB"}

package/dist/actions.js

@@ -0,0 +1,68 @@
+/**
+ * What the platform can be asked to do, declared once and dispatched through
+ * one place: an action (atgard).
+ *
+ * An action is a name, an input schema, the single capability it needs, what it
+ * does to the records, which categories of personal data it can touch, and which
+ * surfaces it may be offered on. The registry checks the calling person's
+ * capability on every call rather than trusting the caller, so registering an
+ * action is never a permission of its own - it is a way of reaching something
+ * the caller could already do.
+ *
+ * A core feature registers its own. A plugin registers the ones its manifest
+ * declared and the board consented to, and they disappear with the plugin.
+ *
+ * Swedish domain terms follow GLOSSARY.md.
+ */
+export const ACTION_EFFECTS = ["read", "write", "delete"];
+/**
+ * Where an action may be offered.
+ *
+ * "ui" means in-process only: the platform's own screens and a plugin's own
+ * route. The other two are the ones a board switches on deliberately.
+ */
+export const ACTION_SURFACES = ["ui", "mcp", "ai"];
+/**
+ * What an action can touch.
+ *
+ * The first thirteen are PERSONAL_DATA_CATEGORIES from @openbrf/shared, in
+ * order, which this package deliberately does not depend on; the API side
+ * asserts the prefix equality, because it is the only place that can import
+ * both. "protected" is this list's own and marks an action that can return a
+ * field of a person carrying protected personal data (skyddade
+ * personuppgifter): it is the value the registry refuses to expose to a
+ * connected app or to the AI package at all.
+ */
+export const ACTION_PERSONAL_DATA = [
+    "name",
+    "apartment",
+    "residency",
+    "email",
+    "phone",
+    "postalAddress",
+    "personalIdentityNumber",
+    "account",
+    "financial",
+    "health",
+    "photograph",
+    "freeText",
+    "auditTrail",
+    "protected",
+];
+/**
+ * What a public action name may look like.
+ *
+ * The intersection of three separate limits: what an MCP tools/list entry
+ * allows, what a model API allows (no dots), and what stays readable in a
+ * directory review (64 characters).
+ */
+export const ACTION_NAME_PATTERN = /^[a-z][a-z0-9_]{2,63}$/;
+/** The lowercase channel vocabulary. The registry maps it to the audit channel. */
+export const ACTION_CHANNELS = [
+    "web",
+    "mcp",
+    "ai",
+    "system",
+    "plugin",
+];
+//# sourceMappingURL=actions.js.map

package/dist/actions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"actions.js","sourceRoot":"","sources":["../src/actions.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;;GAeG;AAEH,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,MAAM,EAAE,OAAO,EAAE,QAAQ,CAAU,CAAC;AAGnE;;;;;GAKG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,CAAU,CAAC;AAG5D;;;;;;;;;;GAUG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG;IAClC,MAAM;IACN,WAAW;IACX,WAAW;IACX,OAAO;IACP,OAAO;IACP,eAAe;IACf,wBAAwB;IACxB,SAAS;IACT,WAAW;IACX,QAAQ;IACR,YAAY;IACZ,UAAU;IACV,YAAY;IACZ,WAAW;CACH,CAAC;AAGX;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,wBAAwB,CAAC;AAqB5D,mFAAmF;AACnF,MAAM,CAAC,MAAM,eAAe,GAAG;IAC7B,KAAK;IACL,KAAK;IACL,IAAI;IACJ,QAAQ;IACR,QAAQ;CACA,CAAC"}

package/dist/api-version.d.ts

@@ -0,0 +1,23 @@
+/**
+ * The plugin API version.
+ *
+ * A single integer rather than a semver range, because the gate it guards is
+ * binary: a plugin either speaks the contract this host implements or it does
+ * not get loaded. A range would invite a plugin to claim ">=1" and then fail
+ * at the first call to a method version 2 removed, which is exactly the class
+ * of breakage the gate exists to prevent.
+ *
+ * Additive changes - a new optional manifest field, a new SDK method - keep
+ * the number. Anything a plugin built against the old contract could notice
+ * raises it, and the host may then support more than one version at a time by
+ * listing them in SUPPORTED_PLUGIN_API_VERSIONS.
+ */
+export declare const PLUGIN_API_VERSION = 1;
+/**
+ * Every version this contract can still load. Kept as a list so a host can
+ * carry an old version through a deprecation window without a plugin having
+ * to be republished on the day the new one lands.
+ */
+export declare const SUPPORTED_PLUGIN_API_VERSIONS: readonly number[];
+export declare function isSupportedApiVersion(apiVersion: number): boolean;
+//# sourceMappingURL=api-version.d.ts.map

package/dist/api-version.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-version.d.ts","sourceRoot":"","sources":["../src/api-version.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,kBAAkB,IAAI,CAAC;AAEpC;;;;GAIG;AACH,eAAO,MAAM,6BAA6B,EAAE,SAAS,MAAM,EAE1D,CAAC;AAEF,wBAAgB,qBAAqB,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAEjE"}

package/dist/api-version.js

@@ -0,0 +1,27 @@
+/**
+ * The plugin API version.
+ *
+ * A single integer rather than a semver range, because the gate it guards is
+ * binary: a plugin either speaks the contract this host implements or it does
+ * not get loaded. A range would invite a plugin to claim ">=1" and then fail
+ * at the first call to a method version 2 removed, which is exactly the class
+ * of breakage the gate exists to prevent.
+ *
+ * Additive changes - a new optional manifest field, a new SDK method - keep
+ * the number. Anything a plugin built against the old contract could notice
+ * raises it, and the host may then support more than one version at a time by
+ * listing them in SUPPORTED_PLUGIN_API_VERSIONS.
+ */
+export const PLUGIN_API_VERSION = 1;
+/**
+ * Every version this contract can still load. Kept as a list so a host can
+ * carry an old version through a deprecation window without a plugin having
+ * to be republished on the day the new one lands.
+ */
+export const SUPPORTED_PLUGIN_API_VERSIONS = [
+    PLUGIN_API_VERSION,
+];
+export function isSupportedApiVersion(apiVersion) {
+    return SUPPORTED_PLUGIN_API_VERSIONS.includes(apiVersion);
+}
+//# sourceMappingURL=api-version.js.map

package/dist/api-version.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-version.js","sourceRoot":"","sources":["../src/api-version.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,CAAC;AAEpC;;;;GAIG;AACH,MAAM,CAAC,MAAM,6BAA6B,GAAsB;IAC9D,kBAAkB;CACnB,CAAC;AAEF,MAAM,UAAU,qBAAqB,CAAC,UAAkB;IACtD,OAAO,6BAA6B,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;AAC5D,CAAC"}