@miragon/pulse-widget-shell 0.0.0-bootstrap.0 → 0.21.0

package/dist/shell-settings.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=shell-settings.test.d.ts.map

package/dist/shell-settings.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"shell-settings.test.d.ts","sourceRoot":"","sources":["../src/shell-settings.test.ts"],"names":[],"mappings":""}

package/dist/shell-settings.test.js

@@ -0,0 +1,115 @@
+import { describe, expect, it, vi } from "vitest";
+import { createInMemoryProfileStore } from "./profile-store.js";
+import { runWithMcpRequestInfo } from "./request-context.js";
+import { createShellPlugin } from "./shell-catalogue.js";
+import { SHELL_SAVE_SETTINGS, SHELL_SETTINGS_DATA, SHELL_SHOW_SETTINGS, } from "./shell-settings-contract.js";
+import { registerShellSettingsTools } from "./shell-settings.js";
+/**
+ * The shell owns the record-level language and the settings page (#346):
+ * the triple reads and saves `language` on the shared record, never a
+ * module slice, and the save exists only where the composition root allows
+ * framework writes.
+ */
+/** A signed-in caller's handler ctx (mcp-use's flattened `ctx.auth`). */
+const CTX = { auth: { user: { id: "user-1" } } };
+function register(allowSave, store = createInMemoryProfileStore()) {
+    const tool = vi.fn();
+    registerShellSettingsTools({ tool }, { profileStore: store, allowSave });
+    const call = (name) => tool.mock.calls.find((c) => c[0].name === name);
+    return {
+        store,
+        names: tool.mock.calls.map((c) => c[0].name),
+        definition: (name) => call(name)?.[0],
+        handler: (name) => call(name)?.[1],
+    };
+}
+const dataOf = async (handler, ctx) => JSON.parse((await handler({}, ctx)).content[0]?.text ?? "null");
+describe("the shell's settings triple", () => {
+    it("registers the save only where framework writes are allowed", () => {
+        expect(register(true).names).toEqual([
+            SHELL_SHOW_SETTINGS,
+            SHELL_SETTINGS_DATA,
+            SHELL_SAVE_SETTINGS,
+        ]);
+        expect(register(false).names).toEqual([SHELL_SHOW_SETTINGS, SHELL_SETTINGS_DATA]);
+    });
+    it("states every hint: the views read, the save writes and destroys nothing", () => {
+        const { definition } = register(true);
+        expect(definition(SHELL_SHOW_SETTINGS).annotations).toMatchObject({ readOnlyHint: true });
+        expect(definition(SHELL_SETTINGS_DATA).annotations).toMatchObject({ readOnlyHint: true });
+        expect(definition(SHELL_SAVE_SETTINGS).annotations).toEqual({
+            readOnlyHint: false,
+            destructiveHint: false,
+            idempotentHint: true,
+            openWorldHint: false,
+        });
+    });
+    it("reads the defaults, read-only, for a request without a caller", async () => {
+        const { handler } = register(true);
+        expect(await dataOf(handler(SHELL_SETTINGS_DATA))).toEqual({
+            language: "system",
+            canSave: false,
+            readOnlyReason: "noSignIn",
+        });
+    });
+    it("names the deployment as the reason when a signed-in caller still cannot save", async () => {
+        const { handler } = register(false);
+        expect(await dataOf(handler(SHELL_SETTINGS_DATA), CTX)).toEqual({
+            language: "system",
+            canSave: false,
+            readOnlyReason: "readOnly",
+        });
+    });
+    it("saves the language on the record, leaves module slices alone and reads it back", async () => {
+        const { handler, store } = register(true);
+        await store.save("user-1", { modules: { analytics: { defaultPeriod: "30d" } } });
+        const saved = await handler(SHELL_SAVE_SETTINGS)({ language: "de" }, CTX);
+        expect(saved.content[0]?.text).toBe("Sprache der Oberfläche gespeichert: Deutsch.");
+        expect(saved.structuredContent).toEqual({ language: "de", canSave: true, readOnlyReason: null });
+        const record = await store.get("user-1");
+        expect(record?.language).toBe("de");
+        expect(record?.userId).toBe("user-1");
+        expect(record?.modules).toEqual({ analytics: { defaultPeriod: "30d" } });
+        expect(await dataOf(handler(SHELL_SETTINGS_DATA), CTX)).toMatchObject({
+            language: "de",
+            canSave: true,
+        });
+    });
+    it("refuses a save without a caller instead of writing a shared record", async () => {
+        const { handler, store } = register(true);
+        const result = (await handler(SHELL_SAVE_SETTINGS)({ language: "de" }));
+        expect(result.isError).toBe(true);
+        expect(await store.get("anonymous")).toBeUndefined();
+    });
+    it("renders the page, titled and summarized in the profile's language", async () => {
+        const { handler, store } = register(true);
+        await store.save("user-1", { language: "de" });
+        const result = await runWithMcpRequestInfo({}, () => handler(SHELL_SHOW_SETTINGS)({}, CTX));
+        expect(result.content[0]?.text).toBe("Einstellungen: Sprache der Oberfläche Deutsch, danach der Abschnitt jedes Moduls. Du kannst sie auf der Seite ändern oder den Chat darum bitten.");
+        expect(JSON.stringify(result.structuredContent)).toContain('"shell:settings-page"');
+        expect(result.structuredContent?.title).toBe("Einstellungen");
+    });
+    it("sets no title over the page while the profile follows the chat app", async () => {
+        const { handler } = register(false);
+        const result = await handler(SHELL_SHOW_SETTINGS)({}, CTX);
+        expect(result.structuredContent?.title).toBeUndefined();
+        expect(result.content[0]?.text).toBe("Settings page: UI language automatic (follows the chat app), then each module's settings section. Settings can't be saved on this server.");
+    });
+});
+describe("createShellPlugin", () => {
+    it("registers no tools without a profile store", () => {
+        expect(createShellPlugin().registerWidgetTools).toBeUndefined();
+    });
+    it("registers the triple with one", () => {
+        const tool = vi.fn();
+        createShellPlugin({
+            profileStore: createInMemoryProfileStore(),
+            allowSave: false,
+        }).registerWidgetTools?.({ tool });
+        expect(tool.mock.calls.map((c) => c[0].name)).toEqual([
+            SHELL_SHOW_SETTINGS,
+            SHELL_SETTINGS_DATA,
+        ]);
+    });
+});
+//# sourceMappingURL=shell-settings.test.js.map

package/dist/shell-settings.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"shell-settings.test.js","sourceRoot":"","sources":["../src/shell-settings.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAA;AAEjD,OAAO,EAAE,0BAA0B,EAAqB,MAAM,oBAAoB,CAAA;AAClF,OAAO,EAAE,qBAAqB,EAAE,MAAM,sBAAsB,CAAA;AAC5D,OAAO,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAA;AACxD,OAAO,EACL,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,GACpB,MAAM,8BAA8B,CAAA;AACrC,OAAO,EAAE,0BAA0B,EAAE,MAAM,qBAAqB,CAAA;AAEhE;;;;;GAKG;AAEH,yEAAyE;AACzE,MAAM,GAAG,GAAG,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAA;AAUhD,SAAS,QAAQ,CAAC,SAAkB,EAAE,QAAsB,0BAA0B,EAAE;IACtF,MAAM,IAAI,GAAG,EAAE,CAAC,EAAE,EAAE,CAAA;IACpB,0BAA0B,CAAC,EAAE,IAAI,EAA0B,EAAE,EAAE,YAAY,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAA;IAChG,MAAM,IAAI,GAAG,CAAC,IAAY,EAAE,EAAE,CAC5B,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAE,CAAC,CAAC,CAAC,CAAsB,CAAC,IAAI,KAAK,IAAI,CAAC,CAAA;IACvE,OAAO;QACL,KAAK;QACL,KAAK,EAAE,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAE,CAAC,CAAC,CAAC,CAAsB,CAAC,IAAI,CAAC;QAClE,UAAU,EAAE,CAAC,IAAY,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAA4B;QACxE,OAAO,EAAE,CAAC,IAAY,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAY;KACtD,CAAA;AACH,CAAC;AAED,MAAM,MAAM,GAAG,KAAK,EAAE,OAAgB,EAAE,GAAa,EAAE,EAAE,CACvD,IAAI,CAAC,KAAK,CAAC,CAAC,MAAM,OAAO,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,IAAI,IAAI,MAAM,CAA4B,CAAA;AAE5F,QAAQ,CAAC,6BAA6B,EAAE,GAAG,EAAE;IAC3C,EAAE,CAAC,4DAA4D,EAAE,GAAG,EAAE;QACpE,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC;YACnC,mBAAmB;YACnB,mBAAmB;YACnB,mBAAmB;SACpB,CAAC,CAAA;QACF,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,mBAAmB,EAAE,mBAAmB,CAAC,CAAC,CAAA;IACnF,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,yEAAyE,EAAE,GAAG,EAAE;QACjF,MAAM,EAAE,UAAU,EAAE,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAA;QACrC,MAAM,CAAC,UAAU,CAAC,mBAAmB,CAAC,CAAC,WAAW,CAAC,CAAC,aAAa,CAAC,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC,CAAA;QACzF,MAAM,CAAC,UAAU,CAAC,mBAAmB,CAAC,CAAC,WAAW,CAAC,CAAC,aAAa,CAAC,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC,CAAA;QACzF,MAAM,CAAC,UAAU,CAAC,mBAAmB,CAAC,CAAC,WAAW,CAAC,CAAC,OAAO,CAAC;YAC1D,YAAY,EAAE,KAAK;YACnB,eAAe,EAAE,KAAK;YACtB,cAAc,EAAE,IAAI;YACpB,aAAa,EAAE,KAAK;SACrB,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,+DAA+D,EAAE,KAAK,IAAI,EAAE;QAC7E,MAAM,EAAE,OAAO,EAAE,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAA;QAClC,MAAM,CAAC,MAAM,MAAM,CAAC,OAAO,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;YACzD,QAAQ,EAAE,QAAQ;YAClB,OAAO,EAAE,KAAK;YACd,cAAc,EAAE,UAAU;SAC3B,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,8EAA8E,EAAE,KAAK,IAAI,EAAE;QAC5F,MAAM,EAAE,OAAO,EAAE,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAA;QACnC,MAAM,CAAC,MAAM,MAAM,CAAC,OAAO,CAAC,mBAAmB,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC;YAC9D,QAAQ,EAAE,QAAQ;YAClB,OAAO,EAAE,KAAK;YACd,cAAc,EAAE,UAAU;SAC3B,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,gFAAgF,EAAE,KAAK,IAAI,EAAE;QAC9F,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAA;QACzC,MAAM,KAAK,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAE,OAAO,EAAE,EAAE,SAAS,EAAE,EAAE,aAAa,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,CAAA;QAEhF,MAAM,KAAK,GAAG,MAAM,OAAO,CAAC,mBAAmB,CAAC,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,EAAE,GAAG,CAAC,CAAA;QAEzE,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,8CAA8C,CAAC,CAAA;QACnF,MAAM,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC,OAAO,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,EAAE,CAAC,CAAA;QAChG,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAA;QACxC,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QACnC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;QACrC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,OAAO,CAAC,EAAE,SAAS,EAAE,EAAE,aAAa,EAAE,KAAK,EAAE,EAAE,CAAC,CAAA;QACxE,MAAM,CAAC,MAAM,MAAM,CAAC,OAAO,CAAC,mBAAmB,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,aAAa,CAAC;YACpE,QAAQ,EAAE,IAAI;YACd,OAAO,EAAE,IAAI;SACd,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,oEAAoE,EAAE,KAAK,IAAI,EAAE;QAClF,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAA;QACzC,MAAM,MAAM,GAAG,CAAC,MAAM,OAAO,CAAC,mBAAmB,CAAC,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAA0B,CAAA;QAChG,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QACjC,MAAM,CAAC,MAAM,KAAK,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,aAAa,EAAE,CAAA;IACtD,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,mEAAmE,EAAE,KAAK,IAAI,EAAE;QACjF,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAA;QACzC,MAAM,KAAK,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAA;QAE9C,MAAM,MAAM,GAAG,MAAM,qBAAqB,CAAC,EAAE,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,mBAAmB,CAAC,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC,CAAA;QAE3F,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,IAAI,CAClC,kJAAkJ,CACnJ,CAAA;QACD,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC,CAAC,SAAS,CAAC,uBAAuB,CAAC,CAAA;QACnF,MAAM,CAAC,MAAM,CAAC,iBAAiB,EAAE,KAAK,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,CAAA;IAC/D,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,oEAAoE,EAAE,KAAK,IAAI,EAAE;QAClF,MAAM,EAAE,OAAO,EAAE,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAA;QACnC,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,mBAAmB,CAAC,CAAC,EAAE,EAAE,GAAG,CAAC,CAAA;QAC1D,MAAM,CAAC,MAAM,CAAC,iBAAiB,EAAE,KAAK,CAAC,CAAC,aAAa,EAAE,CAAA;QACvD,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,IAAI,CAClC,2IAA2I,CAC5I,CAAA;IACH,CAAC,CAAC,CAAA;AACJ,CAAC,CAAC,CAAA;AAEF,QAAQ,CAAC,mBAAmB,EAAE,GAAG,EAAE;IACjC,EAAE,CAAC,4CAA4C,EAAE,GAAG,EAAE;QACpD,MAAM,CAAC,iBAAiB,EAAE,CAAC,mBAAmB,CAAC,CAAC,aAAa,EAAE,CAAA;IACjE,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,+BAA+B,EAAE,GAAG,EAAE;QACvC,MAAM,IAAI,GAAG,EAAE,CAAC,EAAE,EAAE,CAAA;QACpB,iBAAiB,CAAC;YAChB,YAAY,EAAE,0BAA0B,EAAE;YAC1C,SAAS,EAAE,KAAK;SACjB,CAAC,CAAC,mBAAmB,EAAE,CAAC,EAAE,IAAI,EAA0B,CAAC,CAAA;QAC1D,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAE,CAAC,CAAC,CAAC,CAAsB,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC;YAC1E,mBAAmB;YACnB,mBAAmB;SACpB,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;AACJ,CAAC,CAAC,CAAA"}

package/dist/testing/catalog-text.d.ts

@@ -0,0 +1,53 @@
+/**
+ * The catalog text test: the machine-checkable rules of the Miragon voice
+ * (brand-tone; brand-review A1, A2, A10) applied to a message catalog. brand-
+ * lint reads Markdown, not strings inside `.ts` modules, so every catalog
+ * runs this in its own test:
+ *
+ *   expect(catalogTextFindings(de, { language: "de" })).toEqual([])
+ *
+ * German follows brand-tone fully (du, AI, CIB seven, no dash connector);
+ * English takes the transferable rules. Function entries are rendered with
+ * every parameter set to 1 (and 2), so a "1 incidents" surfaces.
+ *
+ * Formal address counts at the start of an entry and of a sentence too, which
+ * is exactly where a UI catalog puts it ("Ihre Sitzung ist abgelaufen.").
+ * The rare sentence-initial she/it/its that reads the same ("Ihre Variablen
+ * bleiben erhalten" about an instance) takes an `allow` entry with a reason.
+ */
+export type CatalogLanguage = "de" | "en";
+export type CatalogRule = "dash-connector" | "ki" | "cib-seven" | "formal-address" | "impersonal-man" | "plural" | "render-error" | "unused-allowance";
+export interface CatalogTextFinding {
+    key: string;
+    rule: CatalogRule;
+    text: string;
+}
+/** One accepted finding: the entry's dotted key, the rule, and why it is fine there. */
+export interface CatalogAllowance {
+    key: string;
+    rule: CatalogRule;
+    /** Required: why this entry may break the rule (e.g. "Ihre = the instance's"). */
+    reason: string;
+}
+export interface CatalogTextOptions {
+    language: CatalogLanguage;
+    /**
+     * Parameters for function entries that need real shapes (an array, an
+     * object) instead of the default "every parameter is the number n".
+     */
+    params?: Readonly<Record<string, unknown>>;
+    /**
+     * Findings a reviewer accepted, each with its reason. A shrink-only list:
+     * an allowance that no longer matches a finding comes back as
+     * `unused-allowance`, so a fixed entry drops off it.
+     */
+    allow?: readonly CatalogAllowance[];
+}
+/**
+ * Every rule violation in a catalog. Nested objects are walked with dotted
+ * keys; non-string, non-function leaves are ignored. A finding listed in
+ * `options.allow` is dropped, an allowance that matches nothing comes back as
+ * `unused-allowance`, and an allowance without a reason throws.
+ */
+export declare function catalogTextFindings(catalog: object, options: CatalogTextOptions): CatalogTextFinding[];
+//# sourceMappingURL=catalog-text.d.ts.map

package/dist/testing/catalog-text.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"catalog-text.d.ts","sourceRoot":"","sources":["../../src/testing/catalog-text.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AAEH,MAAM,MAAM,eAAe,GAAG,IAAI,GAAG,IAAI,CAAA;AAEzC,MAAM,MAAM,WAAW,GACnB,gBAAgB,GAChB,IAAI,GACJ,WAAW,GACX,gBAAgB,GAChB,gBAAgB,GAChB,QAAQ,GACR,cAAc,GACd,kBAAkB,CAAA;AAEtB,MAAM,WAAW,kBAAkB;IACjC,GAAG,EAAE,MAAM,CAAA;IACX,IAAI,EAAE,WAAW,CAAA;IACjB,IAAI,EAAE,MAAM,CAAA;CACb;AAED,wFAAwF;AACxF,MAAM,WAAW,gBAAgB;IAC/B,GAAG,EAAE,MAAM,CAAA;IACX,IAAI,EAAE,WAAW,CAAA;IACjB,kFAAkF;IAClF,MAAM,EAAE,MAAM,CAAA;CACf;AAED,MAAM,WAAW,kBAAkB;IACjC,QAAQ,EAAE,eAAe,CAAA;IACzB;;;OAGG;IACH,MAAM,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAA;IAC1C;;;;OAIG;IACH,KAAK,CAAC,EAAE,SAAS,gBAAgB,EAAE,CAAA;CACpC;AAuHD;;;;;GAKG;AACH,wBAAgB,mBAAmB,CACjC,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,kBAAkB,GAC1B,kBAAkB,EAAE,CAiBtB"}

package/dist/testing/catalog-text.js

@@ -0,0 +1,146 @@
+/**
+ * The catalog text test: the machine-checkable rules of the Miragon voice
+ * (brand-tone; brand-review A1, A2, A10) applied to a message catalog. brand-
+ * lint reads Markdown, not strings inside `.ts` modules, so every catalog
+ * runs this in its own test:
+ *
+ *   expect(catalogTextFindings(de, { language: "de" })).toEqual([])
+ *
+ * German follows brand-tone fully (du, AI, CIB seven, no dash connector);
+ * English takes the transferable rules. Function entries are rendered with
+ * every parameter set to 1 (and 2), so a "1 incidents" surfaces.
+ *
+ * Formal address counts at the start of an entry and of a sentence too, which
+ * is exactly where a UI catalog puts it ("Ihre Sitzung ist abgelaufen.").
+ * The rare sentence-initial she/it/its that reads the same ("Ihre Variablen
+ * bleiben erhalten" about an instance) takes an `allow` entry with a reason.
+ */
+/** A stand-in parameter object: every property and its own primitive value is `n`. */
+function sampleParams(n) {
+    return new Proxy(Object.create(null), {
+        get: (_target, prop) => {
+            if (prop === Symbol.toPrimitive)
+                return (hint) => (hint === "number" ? n : String(n));
+            if (prop === "toString" || prop === "valueOf")
+                return () => String(n);
+            return n;
+        },
+    });
+}
+/** Render one entry: strings as they are (`{param}` → n), functions called with sample params. */
+function render(value, n, params) {
+    if (typeof value === "string")
+        return value.replace(/\{\w+\}/g, String(n));
+    if (typeof value === "function") {
+        const out = value(params ?? sampleParams(n));
+        return typeof out === "string" ? out : undefined;
+    }
+    return undefined;
+}
+const SIE = /(?<![\p{L}\p{N}_])(Sie|Ihnen|Ihr|Ihre|Ihren|Ihrem|Ihrer|Ihres)(?![\p{L}\p{N}_])/gu;
+/** Whether a match opens the entry or a sentence (quotes and markup before it skipped). */
+function atSentenceStart(text, pos) {
+    const before = text.slice(0, pos).replace(/[\s*_([„"'«]+$/u, "");
+    return before === "" || /[.!?:…\n]$/.test(before);
+}
+/** A plural, i.e. formal, verb form right after "Sie": haben, können, sind, ändern, tun … */
+const PLURAL_VERB = /^\s+(?:sind|tun|[a-zäöüß]+(?:en|eln|ern))(?![\p{L}\p{N}_])/u;
+/** The team's "ihr" (brand-tone allows it): the ihr-form of a verb follows (habt, könnt, seid). */
+const IHR_VERB = /^\s+(?:seid|[a-zäöüß]+t)(?![\p{L}\p{N}_])/u;
+/**
+ * Whether a Sie/Ihr/Ihnen match addresses the reader. Mid-sentence the
+ * capital says so. At the start of an entry or a sentence, "Ihnen" and
+ * "Ihre/Ihren/Ihrem/Ihrer/Ihres" count as address, "Sie" when a plural verb
+ * follows ("Sie haben", not "Sie ist") and "Ihr" unless the ihr-form of a
+ * verb follows ("Ihr Team", not "Ihr könnt").
+ */
+function isFormalAddress(text, match) {
+    if (!atSentenceStart(text, match.index))
+        return true;
+    const rest = text.slice(match.index + match[0].length);
+    if (match[0] === "Sie")
+        return PLURAL_VERB.test(rest);
+    if (match[0] === "Ihr")
+        return !IHR_VERB.test(rest);
+    return true;
+}
+/** English: "1 incidents", "1 engines" (a plural noun right after the number one). */
+const EN_PLURAL_AFTER_ONE = /(?<![\d.,])\b1\s+([a-z]+s)\b/g;
+const EN_NOT_PLURAL = /(ss|us|is|ics|news)$|^(has|was|does|its|this|yes|plus|always)$/;
+/** German: the counted nouns of this product, in their plural form. */
+const DE_PLURAL_AFTER_ONE = /(?<![\d.,])\b1\s+(Incidents|Instanzen|Engines|Jobs|Prozesse|Prozessdefinitionen|Definitionen|Versionen|Tage|Stunden|Minuten|Sekunden|Wochen|Versuche|Einträge|Aufgaben|Tasks|Variablen|Elemente|Aktivitäten|Umgebungen|Deployments)\b/u;
+const checks = [
+    // A2: no em dash as a connector; a bare "—" (the empty-value placeholder) is fine.
+    (text) => (text.trim() !== "—" && text.includes("—")) || / –(?=[\s,;.:!?)]|$)/.test(text)
+        ? ["dash-connector"]
+        : [],
+    // A10: AI, never KI; CIB seven, never CIB Seven.
+    (text) => (/(?<![\p{L}])KI(?![\p{L}])/u.test(text) ? ["ki"] : []),
+    (text) => (/\bCIB[\s-]*(Seven|SEVEN)\b/.test(text) ? ["cib-seven"] : []),
+    // A1: du, never Sie; no impersonal "man".
+    (text, language) => language === "de" && [...text.matchAll(SIE)].some((m) => isFormalAddress(text, m))
+        ? ["formal-address"]
+        : [],
+    (text, language) => language === "de" && /(?<![\p{L}])[Mm]an(?![\p{L}])/u.test(text) ? ["impersonal-man"] : [],
+];
+function pluralFindings(one, language) {
+    if (language === "de")
+        return DE_PLURAL_AFTER_ONE.test(one);
+    return [...one.matchAll(EN_PLURAL_AFTER_ONE)].some((m) => !EN_NOT_PLURAL.test(m[1]));
+}
+function entryFindings(key, value, options) {
+    let one;
+    let two;
+    try {
+        one = render(value, 1, options.params?.[key]);
+        two = render(value, 2, options.params?.[key]);
+    }
+    catch {
+        return [{ key, rule: "render-error", text: "pass params for this entry" }];
+    }
+    if (one === undefined || two === undefined)
+        return [];
+    const findings = new Set();
+    for (const text of [one, two]) {
+        for (const rule of checks.flatMap((check) => check(text, options.language)))
+            findings.add(rule);
+    }
+    if (pluralFindings(one, options.language))
+        findings.add("plural");
+    return [...findings].map((rule) => ({ key, rule, text: one }));
+}
+/** Every rule violation of a (nested) catalog, keys dotted from `prefix`. */
+function walk(catalog, options, prefix) {
+    return Object.entries(catalog).flatMap(([name, value]) => {
+        const key = prefix + name;
+        if (value !== null && typeof value === "object")
+            return walk(value, options, `${key}.`);
+        return entryFindings(key, value, options);
+    });
+}
+const allows = (allowance, finding) => allowance.key === finding.key && allowance.rule === finding.rule;
+/**
+ * Every rule violation in a catalog. Nested objects are walked with dotted
+ * keys; non-string, non-function leaves are ignored. A finding listed in
+ * `options.allow` is dropped, an allowance that matches nothing comes back as
+ * `unused-allowance`, and an allowance without a reason throws.
+ */
+export function catalogTextFindings(catalog, options) {
+    const allow = options.allow ?? [];
+    for (const allowance of allow) {
+        if (!allowance.reason.trim()) {
+            throw new Error(`The allowance for ${allowance.key} (${allowance.rule}) needs a reason`);
+        }
+    }
+    const findings = walk(catalog, options, "");
+    const unused = allow.filter((allowance) => !findings.some((f) => allows(allowance, f)));
+    return [
+        ...findings.filter((f) => !allow.some((allowance) => allows(allowance, f))),
+        ...unused.map((allowance) => ({
+            key: allowance.key,
+            rule: "unused-allowance",
+            text: `${allowance.rule}: ${allowance.reason}`,
+        })),
+    ];
+}
+//# sourceMappingURL=catalog-text.js.map

package/dist/testing/catalog-text.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"catalog-text.js","sourceRoot":"","sources":["../../src/testing/catalog-text.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AA2CH,sFAAsF;AACtF,SAAS,YAAY,CAAC,CAAS;IAC7B,OAAO,IAAI,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAW,EAAE;QAC9C,GAAG,EAAE,CAAC,OAAO,EAAE,IAAI,EAAE,EAAE;YACrB,IAAI,IAAI,KAAK,MAAM,CAAC,WAAW;gBAAE,OAAO,CAAC,IAAY,EAAE,EAAE,CAAC,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAA;YAC7F,IAAI,IAAI,KAAK,UAAU,IAAI,IAAI,KAAK,SAAS;gBAAE,OAAO,GAAG,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,CAAA;YACrE,OAAO,CAAC,CAAA;QACV,CAAC;KACF,CAAC,CAAA;AACJ,CAAC;AAED,kGAAkG;AAClG,SAAS,MAAM,CAAC,KAAc,EAAE,CAAS,EAAE,MAAe;IACxD,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAC,OAAO,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAA;IAC1E,IAAI,OAAO,KAAK,KAAK,UAAU,EAAE,CAAC;QAChC,MAAM,GAAG,GAAa,KAAiC,CAAC,MAAM,IAAI,YAAY,CAAC,CAAC,CAAC,CAAC,CAAA;QAClF,OAAO,OAAO,GAAG,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS,CAAA;IAClD,CAAC;IACD,OAAO,SAAS,CAAA;AAClB,CAAC;AAED,MAAM,GAAG,GAAG,mFAAmF,CAAA;AAE/F,2FAA2F;AAC3F,SAAS,eAAe,CAAC,IAAY,EAAE,GAAW;IAChD,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,iBAAiB,EAAE,EAAE,CAAC,CAAA;IAChE,OAAO,MAAM,KAAK,EAAE,IAAI,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;AACnD,CAAC;AAED,6FAA6F;AAC7F,MAAM,WAAW,GAAG,6DAA6D,CAAA;AAEjF,mGAAmG;AACnG,MAAM,QAAQ,GAAG,4CAA4C,CAAA;AAE7D;;;;;;GAMG;AACH,SAAS,eAAe,CAAC,IAAY,EAAE,KAAsB;IAC3D,IAAI,CAAC,eAAe,CAAC,IAAI,EAAE,KAAK,CAAC,KAAK,CAAC;QAAE,OAAO,IAAI,CAAA;IACpD,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAA;IACtD,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,KAAK;QAAE,OAAO,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IACrD,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,KAAK;QAAE,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IACnD,OAAO,IAAI,CAAA;AACb,CAAC;AAED,sFAAsF;AACtF,MAAM,mBAAmB,GAAG,+BAA+B,CAAA;AAC3D,MAAM,aAAa,GAAG,gEAAgE,CAAA;AAEtF,uEAAuE;AACvE,MAAM,mBAAmB,GACvB,wOAAwO,CAAA;AAI1O,MAAM,MAAM,GAAY;IACtB,mFAAmF;IACnF,CAAC,IAAI,EAAE,EAAE,CACP,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,GAAG,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,IAAI,qBAAqB,CAAC,IAAI,CAAC,IAAI,CAAC;QAC7E,CAAC,CAAC,CAAC,gBAAgB,CAAC;QACpB,CAAC,CAAC,EAAE;IACR,iDAAiD;IACjD,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,4BAA4B,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IACjE,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,4BAA4B,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IACxE,0CAA0C;IAC1C,CAAC,IAAI,EAAE,QAAQ,EAAE,EAAE,CACjB,QAAQ,KAAK,IAAI,IAAI,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,eAAe,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;QAChF,CAAC,CAAC,CAAC,gBAAgB,CAAC;QACpB,CAAC,CAAC,EAAE;IACR,CAAC,IAAI,EAAE,QAAQ,EAAE,EAAE,CACjB,QAAQ,KAAK,IAAI,IAAI,gCAAgC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,EAAE;CAC7F,CAAA;AAED,SAAS,cAAc,CAAC,GAAW,EAAE,QAAyB;IAC5D,IAAI,QAAQ,KAAK,IAAI;QAAE,OAAO,mBAAmB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;IAC3D,OAAO,CAAC,GAAG,GAAG,CAAC,QAAQ,CAAC,mBAAmB,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;AACtF,CAAC;AAED,SAAS,aAAa,CACpB,GAAW,EACX,KAAc,EACd,OAA2B;IAE3B,IAAI,GAAuB,CAAA;IAC3B,IAAI,GAAuB,CAAA;IAC3B,IAAI,CAAC;QACH,GAAG,GAAG,MAAM,CAAC,KAAK,EAAE,CAAC,EAAE,OAAO,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAA;QAC7C,GAAG,GAAG,MAAM,CAAC,KAAK,EAAE,CAAC,EAAE,OAAO,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAA;IAC/C,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,CAAC,EAAE,GAAG,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,EAAE,4BAA4B,EAAE,CAAC,CAAA;IAC5E,CAAC;IACD,IAAI,GAAG,KAAK,SAAS,IAAI,GAAG,KAAK,SAAS;QAAE,OAAO,EAAE,CAAA;IACrD,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAe,CAAA;IACvC,KAAK,MAAM,IAAI,IAAI,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,CAAC;QAC9B,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC;YAAE,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;IACjG,CAAC;IACD,IAAI,cAAc,CAAC,GAAG,EAAE,OAAO,CAAC,QAAQ,CAAC;QAAE,QAAQ,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAA;IACjE,OAAO,CAAC,GAAG,QAAQ,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC,CAAC,CAAA;AAChE,CAAC;AAED,6EAA6E;AAC7E,SAAS,IAAI,CAAC,OAAe,EAAE,OAA2B,EAAE,MAAc;IACxE,OAAO,MAAM,CAAC,OAAO,CAAC,OAAkC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,EAAE;QAClF,MAAM,GAAG,GAAG,MAAM,GAAG,IAAI,CAAA;QACzB,IAAI,KAAK,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ;YAAE,OAAO,IAAI,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,GAAG,GAAG,CAAC,CAAA;QACvF,OAAO,aAAa,CAAC,GAAG,EAAE,KAAK,EAAE,OAAO,CAAC,CAAA;IAC3C,CAAC,CAAC,CAAA;AACJ,CAAC;AAED,MAAM,MAAM,GAAG,CAAC,SAA2B,EAAE,OAA2B,EAAE,EAAE,CAC1E,SAAS,CAAC,GAAG,KAAK,OAAO,CAAC,GAAG,IAAI,SAAS,CAAC,IAAI,KAAK,OAAO,CAAC,IAAI,CAAA;AAElE;;;;;GAKG;AACH,MAAM,UAAU,mBAAmB,CACjC,OAAe,EACf,OAA2B;IAE3B,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,IAAI,EAAE,CAAA;IACjC,KAAK,MAAM,SAAS,IAAI,KAAK,EAAE,CAAC;QAC9B,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,CAAC;YAC7B,MAAM,IAAI,KAAK,CAAC,qBAAqB,SAAS,CAAC,GAAG,KAAK,SAAS,CAAC,IAAI,kBAAkB,CAAC,CAAA;QAC1F,CAAC;IACH,CAAC;IACD,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,EAAE,OAAO,EAAE,EAAE,CAAC,CAAA;IAC3C,MAAM,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,CAAC,CAAA;IACvF,OAAO;QACL,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,CAAC;QAC3E,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;YAC5B,GAAG,EAAE,SAAS,CAAC,GAAG;YAClB,IAAI,EAAE,kBAA2B;YACjC,IAAI,EAAE,GAAG,SAAS,CAAC,IAAI,KAAK,SAAS,CAAC,MAAM,EAAE;SAC/C,CAAC,CAAC;KACJ,CAAA;AACH,CAAC"}

package/dist/testing/catalog-text.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=catalog-text.test.d.ts.map

package/dist/testing/catalog-text.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"catalog-text.test.d.ts","sourceRoot":"","sources":["../../src/testing/catalog-text.test.ts"],"names":[],"mappings":""}

package/dist/testing/catalog-text.test.js

@@ -0,0 +1,137 @@
+import { describe, expect, it } from "vitest";
+import { catalogTextFindings } from "./catalog-text.js";
+const rules = (catalog, language = "de") => catalogTextFindings(catalog, { language }).map((f) => `${f.key}:${f.rule}`);
+describe("catalogTextFindings — the voice rules over a message catalog", () => {
+    it("passes a clean catalog in both languages", () => {
+        const de = {
+            a: "Die Liste konnte nicht aktualisiert werden. Du siehst das vorherige Ergebnis.",
+            b: ({ count }) => `${count} ${count === 1 ? "Incident" : "Incidents"}`,
+            c: "1–2 Versuche",
+            d: "—",
+            e: "Sie ist erledigt.",
+            f: "In CIB seven öffnen",
+            g: 42,
+        };
+        const en = {
+            a: "Open in CIB seven",
+            b: "1 process",
+            c: "Status: 1 class",
+            d: "{count} of 1 has run",
+        };
+        expect(rules(de)).toEqual([]);
+        expect(rules(en, "en")).toEqual([]);
+    });
+    it("flags an em dash as a connector, spaced or glued, and a spaced en dash", () => {
+        expect(rules({
+            spaced: "Fehler — bitte erneut versuchen",
+            glued: "Fehler—bitte",
+            enSpaced: "Fehler – bitte",
+            enEnd: "Fehler –",
+            placeholder: " — ",
+        }, "en")).toEqual([
+            "spaced:dash-connector",
+            "glued:dash-connector",
+            "enSpaced:dash-connector",
+            "enEnd:dash-connector",
+        ]);
+    });
+    it("flags KI and CIB Seven in both languages", () => {
+        expect(rules({ ki: "KI-gestützt", ok: "Kiel", cib: "CIB Seven", caps: "CIB SEVEN" }, "en")).toEqual(["ki:ki", "cib:cib-seven", "caps:cib-seven"]);
+    });
+    it("flags Sie/Ihr/Ihnen as address in German, mid-sentence", () => {
+        expect(rules({
+            ihnen: "Wir zeigen Ihnen die Liste.",
+            ihr: "Speichere Ihre Einstellungen.",
+            sie: "Möchten Sie fortfahren?",
+        })).toEqual(["ihnen:formal-address", "ihr:formal-address", "sie:formal-address"]);
+        expect(rules({ en: "Sie Ihnen" }, "en")).toEqual([]);
+    });
+    it("flags formal address at the start of an entry or a sentence too", () => {
+        // In a UI catalog the start of an entry is exactly where address sits.
+        expect(rules({
+            expired: "Ihre Sitzung ist abgelaufen.",
+            noRight: "Sie haben keine Berechtigung für diese Aktion.",
+            missing: "Ihnen fehlt die Berechtigung.",
+            retry: "Die Liste konnte nicht geladen werden. Sie können es erneut versuchen.",
+            afterColon: "Hinweis: Sie sind abgemeldet.",
+            possessive: "Ihr Team sieht das.",
+            adjective: "Ihr neuer Bericht ist fertig.",
+            quotedVerb: "„Sie haben“ steht da.",
+        })).toEqual([
+            "expired:formal-address",
+            "noRight:formal-address",
+            "missing:formal-address",
+            "retry:formal-address",
+            "afterColon:formal-address",
+            "possessive:formal-address",
+            "adjective:formal-address",
+            "quotedVerb:formal-address",
+        ]);
+    });
+    it("leaves a sentence-initial she/it and the team's ihr alone", () => {
+        expect(rules({
+            she: "Fertig. Sie ist gespeichert.",
+            modal: "Sie kann nicht geladen werden.",
+            past: "Sie wurde gelöscht.",
+            team: "Ihr könnt das gemeinsam ansehen.",
+            teamSeid: "Ihr seid fertig.",
+            quoted: "„Sie“ steht in Anführungszeichen.",
+        })).toEqual([]);
+    });
+    it("takes an allowance per key and rule, with a reason, and reports a stale one", () => {
+        const catalog = {
+            kept: "Die Instanz läuft weiter. Ihre Variablen bleiben erhalten.",
+            clean: "Die Liste ist leer.",
+        };
+        const its = { key: "kept", rule: "formal-address", reason: "Ihre = the instance's" };
+        expect(rules(catalog)).toEqual(["kept:formal-address"]);
+        expect(catalogTextFindings(catalog, { language: "de", allow: [its] })).toEqual([]);
+        expect(catalogTextFindings(catalog, {
+            language: "de",
+            allow: [its, { key: "clean", rule: "formal-address", reason: "was formal once" }],
+        })).toEqual([{ key: "clean", rule: "unused-allowance", text: "formal-address: was formal once" }]);
+        expect(() => catalogTextFindings(catalog, {
+            language: "de",
+            allow: [{ key: "kept", rule: "formal-address", reason: " " }],
+        })).toThrow(/reason/);
+    });
+    it("flags an impersonal man in German only", () => {
+        expect(rules({ man: "Hier kann man filtern.", Man: "Man sieht nichts.", ok: "Manche" })).toEqual(["man:impersonal-man", "Man:impersonal-man"]);
+        expect(rules({ man: "man" }, "en")).toEqual([]);
+    });
+    it("renders function entries with 1 and 2 and flags a missing singular", () => {
+        expect(rules({
+            plural: ({ count }) => `${count} incidents`,
+            ok: ({ count }) => `${count} incident${count === 1 ? "" : "s"}`,
+            template: "{count} engines configured",
+            message: (message) => `Failed: ${message}`,
+        }, "en")).toEqual(["plural:plural", "template:plural"]);
+        expect(rules({
+            tage: "{n} Tage",
+            tag: ({ n }) => (n === 1 ? "1 Tag" : `${n} Tage`),
+            fehler: "{n} Fehler",
+        })).toEqual(["tage:plural"]);
+    });
+    it("walks nested objects with dotted keys and reports an entry it cannot render", () => {
+        const nested = {
+            group: { inner: "KI", deeper: { leaf: "CIB Seven" } },
+            broken: (p) => p.list.join(", "),
+        };
+        expect(rules(nested)).toEqual([
+            "group.inner:ki",
+            "group.deeper.leaf:cib-seven",
+            "broken:render-error",
+        ]);
+        const withParams = catalogTextFindings(nested, {
+            language: "de",
+            params: { broken: { list: ["a", "b"] } },
+        });
+        expect(withParams.map((f) => f.key)).toEqual(["group.inner", "group.deeper.leaf"]);
+    });
+    it("reports the rendered text of the finding", () => {
+        expect(catalogTextFindings({ k: "{count} jobs" }, { language: "en" })).toEqual([
+            { key: "k", rule: "plural", text: "1 jobs" },
+        ]);
+    });
+});
+//# sourceMappingURL=catalog-text.test.js.map

package/dist/testing/catalog-text.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"catalog-text.test.js","sourceRoot":"","sources":["../../src/testing/catalog-text.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAA;AAC7C,OAAO,EAAE,mBAAmB,EAAE,MAAM,mBAAmB,CAAA;AAEvD,MAAM,KAAK,GAAG,CAAC,OAAgC,EAAE,WAAwB,IAAI,EAAE,EAAE,CAC/E,mBAAmB,CAAC,OAAO,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,IAAI,EAAE,CAAC,CAAA;AAE7E,QAAQ,CAAC,8DAA8D,EAAE,GAAG,EAAE;IAC5E,EAAE,CAAC,0CAA0C,EAAE,GAAG,EAAE;QAClD,MAAM,EAAE,GAAG;YACT,CAAC,EAAE,+EAA+E;YAClF,CAAC,EAAE,CAAC,EAAE,KAAK,EAAqB,EAAE,EAAE,CAAC,GAAG,KAAK,IAAI,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,WAAW,EAAE;YACzF,CAAC,EAAE,cAAc;YACjB,CAAC,EAAE,GAAG;YACN,CAAC,EAAE,mBAAmB;YACtB,CAAC,EAAE,qBAAqB;YACxB,CAAC,EAAE,EAAE;SACN,CAAA;QACD,MAAM,EAAE,GAAG;YACT,CAAC,EAAE,mBAAmB;YACtB,CAAC,EAAE,WAAW;YACd,CAAC,EAAE,iBAAiB;YACpB,CAAC,EAAE,sBAAsB;SAC1B,CAAA;QACD,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;QAC7B,MAAM,CAAC,KAAK,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;IACrC,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,wEAAwE,EAAE,GAAG,EAAE;QAChF,MAAM,CACJ,KAAK,CACH;YACE,MAAM,EAAE,iCAAiC;YACzC,KAAK,EAAE,cAAc;YACrB,QAAQ,EAAE,gBAAgB;YAC1B,KAAK,EAAE,UAAU;YACjB,WAAW,EAAE,KAAK;SACnB,EACD,IAAI,CACL,CACF,CAAC,OAAO,CAAC;YACR,uBAAuB;YACvB,sBAAsB;YACtB,yBAAyB;YACzB,sBAAsB;SACvB,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,0CAA0C,EAAE,GAAG,EAAE;QAClD,MAAM,CACJ,KAAK,CAAC,EAAE,EAAE,EAAE,aAAa,EAAE,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,WAAW,EAAE,IAAI,EAAE,WAAW,EAAE,EAAE,IAAI,CAAC,CACpF,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,eAAe,EAAE,gBAAgB,CAAC,CAAC,CAAA;IACzD,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,wDAAwD,EAAE,GAAG,EAAE;QAChE,MAAM,CACJ,KAAK,CAAC;YACJ,KAAK,EAAE,6BAA6B;YACpC,GAAG,EAAE,+BAA+B;YACpC,GAAG,EAAE,yBAAyB;SAC/B,CAAC,CACH,CAAC,OAAO,CAAC,CAAC,sBAAsB,EAAE,oBAAoB,EAAE,oBAAoB,CAAC,CAAC,CAAA;QAC/E,MAAM,CAAC,KAAK,CAAC,EAAE,EAAE,EAAE,WAAW,EAAE,EAAE,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;IACtD,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,iEAAiE,EAAE,GAAG,EAAE;QACzE,uEAAuE;QACvE,MAAM,CACJ,KAAK,CAAC;YACJ,OAAO,EAAE,8BAA8B;YACvC,OAAO,EAAE,gDAAgD;YACzD,OAAO,EAAE,+BAA+B;YACxC,KAAK,EAAE,wEAAwE;YAC/E,UAAU,EAAE,+BAA+B;YAC3C,UAAU,EAAE,qBAAqB;YACjC,SAAS,EAAE,+BAA+B;YAC1C,UAAU,EAAE,uBAAuB;SACpC,CAAC,CACH,CAAC,OAAO,CAAC;YACR,wBAAwB;YACxB,wBAAwB;YACxB,wBAAwB;YACxB,sBAAsB;YACtB,2BAA2B;YAC3B,2BAA2B;YAC3B,0BAA0B;YAC1B,2BAA2B;SAC5B,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,2DAA2D,EAAE,GAAG,EAAE;QACnE,MAAM,CACJ,KAAK,CAAC;YACJ,GAAG,EAAE,8BAA8B;YACnC,KAAK,EAAE,gCAAgC;YACvC,IAAI,EAAE,qBAAqB;YAC3B,IAAI,EAAE,kCAAkC;YACxC,QAAQ,EAAE,kBAAkB;YAC5B,MAAM,EAAE,mCAAmC;SAC5C,CAAC,CACH,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;IACf,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,6EAA6E,EAAE,GAAG,EAAE;QACrF,MAAM,OAAO,GAAG;YACd,IAAI,EAAE,4DAA4D;YAClE,KAAK,EAAE,qBAAqB;SAC7B,CAAA;QACD,MAAM,GAAG,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,gBAAgB,EAAE,MAAM,EAAE,uBAAuB,EAAW,CAAA;QAC7F,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAA;QACvD,MAAM,CAAC,mBAAmB,CAAC,OAAO,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;QAClF,MAAM,CACJ,mBAAmB,CAAC,OAAO,EAAE;YAC3B,QAAQ,EAAE,IAAI;YACd,KAAK,EAAE,CAAC,GAAG,EAAE,EAAE,GAAG,EAAE,OAAO,EAAE,IAAI,EAAE,gBAAgB,EAAE,MAAM,EAAE,iBAAiB,EAAE,CAAC;SAClF,CAAC,CACH,CAAC,OAAO,CAAC,CAAC,EAAE,GAAG,EAAE,OAAO,EAAE,IAAI,EAAE,kBAAkB,EAAE,IAAI,EAAE,iCAAiC,EAAE,CAAC,CAAC,CAAA;QAChG,MAAM,CAAC,GAAG,EAAE,CACV,mBAAmB,CAAC,OAAO,EAAE;YAC3B,QAAQ,EAAE,IAAI;YACd,KAAK,EAAE,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,gBAAgB,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC;SAC9D,CAAC,CACH,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAA;IACrB,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,wCAAwC,EAAE,GAAG,EAAE;QAChD,MAAM,CACJ,KAAK,CAAC,EAAE,GAAG,EAAE,wBAAwB,EAAE,GAAG,EAAE,mBAAmB,EAAE,EAAE,EAAE,QAAQ,EAAE,CAAC,CACjF,CAAC,OAAO,CAAC,CAAC,oBAAoB,EAAE,oBAAoB,CAAC,CAAC,CAAA;QACvD,MAAM,CAAC,KAAK,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,EAAE,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;IACjD,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,oEAAoE,EAAE,GAAG,EAAE;QAC5E,MAAM,CACJ,KAAK,CACH;YACE,MAAM,EAAE,CAAC,EAAE,KAAK,EAAqB,EAAE,EAAE,CAAC,GAAG,KAAK,YAAY;YAC9D,EAAE,EAAE,CAAC,EAAE,KAAK,EAAqB,EAAE,EAAE,CAAC,GAAG,KAAK,YAAY,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,EAAE;YAClF,QAAQ,EAAE,4BAA4B;YACtC,OAAO,EAAE,CAAC,OAAe,EAAE,EAAE,CAAC,WAAW,OAAO,EAAE;SACnD,EACD,IAAI,CACL,CACF,CAAC,OAAO,CAAC,CAAC,eAAe,EAAE,iBAAiB,CAAC,CAAC,CAAA;QAC/C,MAAM,CACJ,KAAK,CAAC;YACJ,IAAI,EAAE,UAAU;YAChB,GAAG,EAAE,CAAC,EAAE,CAAC,EAAiB,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC;YAChE,MAAM,EAAE,YAAY;SACrB,CAAC,CACH,CAAC,OAAO,CAAC,CAAC,aAAa,CAAC,CAAC,CAAA;IAC5B,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,6EAA6E,EAAE,GAAG,EAAE;QACrF,MAAM,MAAM,GAAG;YACb,KAAK,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,WAAW,EAAE,EAAE;YACrD,MAAM,EAAE,CAAC,CAAqB,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;SACrD,CAAA;QACD,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC;YAC5B,gBAAgB;YAChB,6BAA6B;YAC7B,qBAAqB;SACtB,CAAC,CAAA;QACF,MAAM,UAAU,GAAG,mBAAmB,CAAC,MAAM,EAAE;YAC7C,QAAQ,EAAE,IAAI;YACd,MAAM,EAAE,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,EAAE;SACzC,CAAC,CAAA;QACF,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,aAAa,EAAE,mBAAmB,CAAC,CAAC,CAAA;IACpF,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,0CAA0C,EAAE,GAAG,EAAE;QAClD,MAAM,CAAC,mBAAmB,CAAC,EAAE,CAAC,EAAE,cAAc,EAAE,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC;YAC7E,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,QAAQ,EAAE;SAC7C,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;AACJ,CAAC,CAAC,CAAA"}

package/dist/testing/colors.d.ts

@@ -0,0 +1,34 @@
+export interface ColorFinding {
+    file: string;
+    line: number;
+    /** The palette class, hex value or colour function found. */
+    match: string;
+    text: string;
+}
+/** Every palette class and raw colour in the string and template literals of one source file. */
+export declare function colorFindings(source: string, file: string): ColorFinding[];
+/**
+ * Every raw colour (hex, `rgb()`, `oklch()` …) and every reference to a
+ * retired accent variable (`var(--m-blue)`) in a stylesheet's rules —
+ * comments are skipped, so a commented-out example may hold the values a
+ * customer is meant to fill in. A consumer stylesheet imports the toolkit's
+ * theme and overrides role variables; a brand value it does set belongs in
+ * that override block and its own allowance, never in a component rule.
+ */
+export declare function stylesheetColorFindings(css: string, file: string): ColorFinding[];
+export interface ScanColorsOptions {
+    /**
+     * Files (relative to the scanned dir, "/"-separated) that may hold raw
+     * colours, each with its reason (e.g. the BPMN paper is always light). A
+     * shrink-only list: an entry whose file no longer has a finding, or no
+     * longer exists, comes back as an "unused allowance".
+     */
+    allow?: Readonly<Record<string, string>>;
+}
+/**
+ * Scan every `.ts`/`.tsx` source under `dir` (tests and declarations
+ * excluded) for palette classes and raw colours. Findings carry
+ * "/"-separated paths relative to `dir`.
+ */
+export declare function scanColors(dir: string, options?: ScanColorsOptions): ColorFinding[];
+//# sourceMappingURL=colors.d.ts.map

package/dist/testing/colors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"colors.d.ts","sourceRoot":"","sources":["../../src/testing/colors.ts"],"names":[],"mappings":"AAoEA,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;IACZ,6DAA6D;IAC7D,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,MAAM,CAAA;CACb;AAED,iGAAiG;AACjG,wBAAgB,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,YAAY,EAAE,CAc1E;AAqBD;;;;;;;GAOG;AACH,wBAAgB,uBAAuB,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,YAAY,EAAE,CAajF;AAED,MAAM,WAAW,iBAAiB;IAChC;;;;;OAKG;IACH,KAAK,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAA;CACzC;AAED;;;;GAIG;AACH,wBAAgB,UAAU,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,GAAE,iBAAsB,GAAG,YAAY,EAAE,CAavF"}