@adminiumjs/add-on-contracts 0.3.39 → 0.3.41

package/dist/forms/parse.js

@@ -0,0 +1,93 @@
+import { formDefinitionSchema, SCALE_OF } from './definition.js';
+import { formSettingsSchema, keepsNames } from './settings.js';
+/** Codes the settings are refused with, beside the definition's and Zod's own. */
+export const FORM_SETTINGS_CODES = [
+    /** A survey says how it is answered (`survey`). */
+    'survey-settings-missing',
+    /** A form has no survey settings. */
+    'survey-settings-on-form',
+    /** An anonymous survey keeps no names, so it cannot link answers to them. */
+    'survey-anonymous-names',
+    /** The map names a question the form does not have. */
+    'becomes-question-unknown',
+    /** A file or a tick fills no column: files are kept with the answer, a tick is a consent. */
+    'becomes-question-kind',
+    /** Two questions, or a question and the source, fill one column. */
+    'becomes-column-twice',
+    /** A survey that keeps no names becomes no row: the row would say who answered. */
+    'becomes-anonymous',
+    'tell-duplicate',
+    /** The low-score tell names no score or star question of the form. */
+    'tell-when-question',
+    /** The low-score tell's number is beyond its question's scale. */
+    'tell-when-range',
+];
+function issuesOf(error, under) {
+    return error.issues.map((issue) => {
+        const own = issue.params?.code;
+        return {
+            path: [under, ...issue.path.map((part) => (typeof part === 'symbol' ? String(part) : part))],
+            code: issue.code === 'custom' && typeof own === 'string' ? own : issue.code,
+        };
+    });
+}
+/** The rules that need the definition and the settings together. */
+function settingsIssues(definition, settings) {
+    const out = [];
+    const report = (code, ...path) => out.push({ path: ['settings', ...path], code });
+    const questions = new Map(definition.questions.map((question) => [question.id, question]));
+    if (definition.kind === 'survey' && settings.survey === undefined)
+        report('survey-settings-missing', 'survey');
+    if (definition.kind === 'form' && settings.survey !== undefined)
+        report('survey-settings-on-form', 'survey');
+    if (settings.survey?.mode === 'anonymous' && settings.survey.linkNames)
+        report('survey-anonymous-names', 'survey', 'linkNames');
+    const becomes = settings.becomes;
+    if (becomes !== null) {
+        if (definition.kind === 'survey' && !keepsNames(settings))
+            report('becomes-anonymous', 'becomes');
+        const filled = new Set();
+        for (const [id, column] of Object.entries(becomes.map)) {
+            const question = questions.get(id);
+            if (question === undefined)
+                report('becomes-question-unknown', 'becomes', 'map', id);
+            else if (question.kind === 'file' || question.kind === 'tick')
+                report('becomes-question-kind', 'becomes', 'map', id);
+            if (filled.has(column))
+                report('becomes-column-twice', 'becomes', 'map', id);
+            filled.add(column);
+        }
+        if (becomes.source !== undefined && filled.has(becomes.source.column))
+            report('becomes-column-twice', 'becomes', 'source', 'column');
+    }
+    const told = new Set();
+    settings.tell.forEach((tell, t) => {
+        const key = `${tell.kind}\u0000${tell.id}`;
+        if (told.has(key))
+            report('tell-duplicate', 'tell', t);
+        told.add(key);
+    });
+    if (settings.tellWhen !== undefined) {
+        const question = questions.get(settings.tellWhen.question);
+        if (question === undefined || (question.kind !== 'score' && question.kind !== 'stars'))
+            report('tell-when-question', 'tellWhen', 'question');
+        else if (settings.tellWhen.atMost < SCALE_OF[question.kind].min || settings.tellWhen.atMost > SCALE_OF[question.kind].max)
+            report('tell-when-range', 'tellWhen', 'atMost');
+    }
+    return out;
+}
+/**
+ * A form from its stored definition and settings, or every reason it is not
+ * one. The definition's issues come first; the rules across the two are
+ * checked only when both parse.
+ */
+export function parseForm(definition, settings) {
+    const d = formDefinitionSchema.safeParse(definition);
+    const s = formSettingsSchema.safeParse(settings);
+    const issues = [...(d.success ? [] : issuesOf(d.error, 'definition')), ...(s.success ? [] : issuesOf(s.error, 'settings'))];
+    if (!d.success || !s.success)
+        return { ok: false, issues };
+    const across = settingsIssues(d.data, s.data);
+    return across.length === 0 ? { ok: true, form: { definition: d.data, settings: s.data } } : { ok: false, issues: across };
+}
+//# sourceMappingURL=parse.js.map

package/dist/forms/parse.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"parse.js","sourceRoot":"","sources":["../../src/forms/parse.ts"],"names":[],"mappings":"AAUA,OAAO,EAAE,oBAAoB,EAAE,QAAQ,EAAuB,MAAM,iBAAiB,CAAC;AACtF,OAAO,EAAE,kBAAkB,EAAE,UAAU,EAAqB,MAAM,eAAe,CAAC;AAQlF,kFAAkF;AAClF,MAAM,CAAC,MAAM,mBAAmB,GAAG;IACjC,mDAAmD;IACnD,yBAAyB;IACzB,qCAAqC;IACrC,yBAAyB;IACzB,6EAA6E;IAC7E,wBAAwB;IACxB,uDAAuD;IACvD,0BAA0B;IAC1B,6FAA6F;IAC7F,uBAAuB;IACvB,oEAAoE;IACpE,sBAAsB;IACtB,mFAAmF;IACnF,mBAAmB;IACnB,gBAAgB;IAChB,sEAAsE;IACtE,oBAAoB;IACpB,kEAAkE;IAClE,iBAAiB;CACT,CAAC;AAYX,SAAS,QAAQ,CAAC,KAAiB,EAAE,KAAa;IAChD,OAAO,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;QAChC,MAAM,GAAG,GAAI,KAAyC,CAAC,MAAM,EAAE,IAAI,CAAC;QACpE,OAAO;YACL,IAAI,EAAE,CAAC,KAAK,EAAE,GAAG,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;YAC5F,IAAI,EAAE,KAAK,CAAC,IAAI,KAAK,QAAQ,IAAI,OAAO,GAAG,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI;SAC5E,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC;AAED,oEAAoE;AACpE,SAAS,cAAc,CAAC,UAA0B,EAAE,QAAsB;IACxE,MAAM,GAAG,GAAgB,EAAE,CAAC;IAC5B,MAAM,MAAM,GAAG,CAAC,IAAsB,EAAE,GAAG,IAAyB,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,CAAC,UAAU,EAAE,GAAG,IAAI,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC;IACzH,MAAM,SAAS,GAAG,IAAI,GAAG,CAAC,UAAU,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,QAAQ,CAAC,EAAE,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC;IAE3F,IAAI,UAAU,CAAC,IAAI,KAAK,QAAQ,IAAI,QAAQ,CAAC,MAAM,KAAK,SAAS;QAAE,MAAM,CAAC,yBAAyB,EAAE,QAAQ,CAAC,CAAC;IAC/G,IAAI,UAAU,CAAC,IAAI,KAAK,MAAM,IAAI,QAAQ,CAAC,MAAM,KAAK,SAAS;QAAE,MAAM,CAAC,yBAAyB,EAAE,QAAQ,CAAC,CAAC;IAC7G,IAAI,QAAQ,CAAC,MAAM,EAAE,IAAI,KAAK,WAAW,IAAI,QAAQ,CAAC,MAAM,CAAC,SAAS;QAAE,MAAM,CAAC,wBAAwB,EAAE,QAAQ,EAAE,WAAW,CAAC,CAAC;IAEhI,MAAM,OAAO,GAAG,QAAQ,CAAC,OAAO,CAAC;IACjC,IAAI,OAAO,KAAK,IAAI,EAAE,CAAC;QACrB,IAAI,UAAU,CAAC,IAAI,KAAK,QAAQ,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC;YAAE,MAAM,CAAC,mBAAmB,EAAE,SAAS,CAAC,CAAC;QAClG,MAAM,MAAM,GAAG,IAAI,GAAG,EAAU,CAAC;QACjC,KAAK,MAAM,CAAC,EAAE,EAAE,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;YACvD,MAAM,QAAQ,GAAG,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;YACnC,IAAI,QAAQ,KAAK,SAAS;gBAAE,MAAM,CAAC,0BAA0B,EAAE,SAAS,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC;iBAChF,IAAI,QAAQ,CAAC,IAAI,KAAK,MAAM,IAAI,QAAQ,CAAC,IAAI,KAAK,MAAM;gBAAE,MAAM,CAAC,uBAAuB,EAAE,SAAS,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC;YACrH,IAAI,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC;gBAAE,MAAM,CAAC,sBAAsB,EAAE,SAAS,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC;YAC7E,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QACrB,CAAC;QACD,IAAI,OAAO,CAAC,MAAM,KAAK,SAAS,IAAI,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC;YAAE,MAAM,CAAC,sBAAsB,EAAE,SAAS,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;IACvI,CAAC;IAED,MAAM,IAAI,GAAG,IAAI,GAAG,EAAU,CAAC;IAC/B,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,CAAC,EAAE,EAAE;QAChC,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,IAAI,SAAS,IAAI,CAAC,EAAE,EAAE,CAAC;QAC3C,IAAI,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC;YAAE,MAAM,CAAC,gBAAgB,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;QACvD,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAChB,CAAC,CAAC,CAAC;IACH,IAAI,QAAQ,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;QACpC,MAAM,QAAQ,GAAG,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QAC3D,IAAI,QAAQ,KAAK,SAAS,IAAI,CAAC,QAAQ,CAAC,IAAI,KAAK,OAAO,IAAI,QAAQ,CAAC,IAAI,KAAK,OAAO,CAAC;YAAE,MAAM,CAAC,oBAAoB,EAAE,UAAU,EAAE,UAAU,CAAC,CAAC;aACxI,IAAI,QAAQ,CAAC,QAAQ,CAAC,MAAM,GAAG,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,GAAG,IAAI,QAAQ,CAAC,QAAQ,CAAC,MAAM,GAAG,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,GAAG;YAAE,MAAM,CAAC,iBAAiB,EAAE,UAAU,EAAE,QAAQ,CAAC,CAAC;IAC7K,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,SAAS,CAAC,UAAmB,EAAE,QAAiB;IAC9D,MAAM,CAAC,GAAG,oBAAoB,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;IACrD,MAAM,CAAC,GAAG,kBAAkB,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;IACjD,MAAM,MAAM,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC;IAC5H,IAAI,CAAC,CAAC,CAAC,OAAO,IAAI,CAAC,CAAC,CAAC,OAAO;QAAE,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC;IAC3D,MAAM,MAAM,GAAG,cAAc,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC;IAC9C,OAAO,MAAM,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,UAAU,EAAE,CAAC,CAAC,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC;AAC5H,CAAC"}

package/dist/forms/scales.d.ts

@@ -0,0 +1,34 @@
+/**
+ * The few values and rules the answer's check shares with the schemas,
+ * kept apart from them: no schema here, so a page that checks answers in
+ * the browser (`@adminium/add-on-contracts/forms/check`) carries the check
+ * and none of the schemas.
+ *
+ * Pure: no I/O, no import but types.
+ */
+/** The most files one file question takes when it takes several. */
+export declare const FORM_FILES_MAX = 5;
+/** The values a question of a scale holds: 0–10 for a score, 1–5 for stars. */
+export declare const SCALE_OF: {
+    readonly score: {
+        readonly min: 0;
+        readonly max: 10;
+    };
+    readonly stars: {
+        readonly min: 1;
+        readonly max: 5;
+    };
+};
+/** Whether a survey keeps who answered: a named one that links answers to names. Every form does. */
+/**
+ * The part of a form's settings this reads, spelled out here rather than imported: the settings' schema builds on the
+ * definition, which takes these limits, so an import back would close a loop.
+ */
+export interface SurveyNaming {
+    survey?: {
+        mode: 'named' | 'anonymous';
+        linkNames: boolean;
+    } | undefined;
+}
+export declare function keepsNames(settings: SurveyNaming): boolean;
+//# sourceMappingURL=scales.d.ts.map

package/dist/forms/scales.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"scales.d.ts","sourceRoot":"","sources":["../../src/forms/scales.ts"],"names":[],"mappings":"AACA;;;;;;;GAOG;AAEH,oEAAoE;AACpE,eAAO,MAAM,cAAc,IAAI,CAAC;AAEhC,+EAA+E;AAC/E,eAAO,MAAM,QAAQ;;;;;;;;;CAAqE,CAAC;AAE3F,qGAAqG;AACrG;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC3B,MAAM,CAAC,EAAE;QAAE,IAAI,EAAE,OAAO,GAAG,WAAW,CAAC;QAAC,SAAS,EAAE,OAAO,CAAA;KAAE,GAAG,SAAS,CAAC;CAC1E;AAED,wBAAgB,UAAU,CAAC,QAAQ,EAAE,YAAY,GAAG,OAAO,CAE1D"}

package/dist/forms/scales.js

@@ -0,0 +1,17 @@
+// SPDX-License-Identifier: AGPL-3.0-only
+/**
+ * The few values and rules the answer's check shares with the schemas,
+ * kept apart from them: no schema here, so a page that checks answers in
+ * the browser (`@adminium/add-on-contracts/forms/check`) carries the check
+ * and none of the schemas.
+ *
+ * Pure: no I/O, no import but types.
+ */
+/** The most files one file question takes when it takes several. */
+export const FORM_FILES_MAX = 5;
+/** The values a question of a scale holds: 0–10 for a score, 1–5 for stars. */
+export const SCALE_OF = { score: { min: 0, max: 10 }, stars: { min: 1, max: 5 } };
+export function keepsNames(settings) {
+    return settings.survey === undefined || (settings.survey.mode === 'named' && settings.survey.linkNames);
+}
+//# sourceMappingURL=scales.js.map

package/dist/forms/scales.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"scales.js","sourceRoot":"","sources":["../../src/forms/scales.ts"],"names":[],"mappings":"AAAA,yCAAyC;AACzC;;;;;;;GAOG;AAEH,oEAAoE;AACpE,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,CAAC;AAEhC,+EAA+E;AAC/E,MAAM,CAAC,MAAM,QAAQ,GAAG,EAAE,KAAK,EAAE,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,EAAW,CAAC;AAW3F,MAAM,UAAU,UAAU,CAAC,QAAsB;IAC/C,OAAO,QAAQ,CAAC,MAAM,KAAK,SAAS,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,KAAK,OAAO,IAAI,QAAQ,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;AAC1G,CAAC"}

package/dist/forms/settings.d.ts

@@ -0,0 +1,77 @@
+/**
+ * A FORM'S SETTINGS: what the owner sets beside the questions (comp M-4,
+ * "Form settings"). What an answer becomes, who is told, the limits, and a
+ * survey's three settings.
+ *
+ * "Becomes" names a table and fills its columns from answers. Which tables a
+ * form may write, and which of their columns, is the app's to say through its
+ * `publicAccess` entry under the key `forms`: the engine holds the map to that
+ * entry when the form is published and on every answer. This file checks only
+ * what the form itself can see: that the map names its own questions, of
+ * kinds an answer can be written from, each into a column of its own.
+ *
+ * Pure: no I/O.
+ */
+import { z } from 'zod';
+/** A column of an app's table, by the manifest's ref. */
+export declare const formColumnRefSchema: z.ZodString;
+/** The most people and roles one form tells. */
+export declare const FORM_TELL_MAX = 10;
+/** The hourly cap a form starts with, and the most it may be raised to. */
+export declare const FORM_PER_HOUR_DEFAULT = 200;
+export declare const FORM_PER_HOUR_MAX = 1000;
+/** How many days after each invitation a survey takes answers, by default. */
+export declare const SURVEY_STOP_AFTER_DAYS_DEFAULT = 30;
+export declare const formBecomesSchema: z.ZodObject<{
+    table: z.ZodString;
+    map: z.ZodRecord<z.ZodString, z.ZodString>;
+    source: z.ZodOptional<z.ZodObject<{
+        column: z.ZodString;
+        value: z.ZodString;
+    }, z.core.$strict>>;
+}, z.core.$strict>;
+export type FormBecomes = z.infer<typeof formBecomesSchema>;
+export declare const formTellSchema: z.ZodObject<{
+    kind: z.ZodEnum<{
+        role: "role";
+        person: "person";
+    }>;
+    id: z.ZodString;
+}, z.core.$strict>;
+export declare const formSettingsSchema: z.ZodObject<{
+    becomes: z.ZodDefault<z.ZodNullable<z.ZodObject<{
+        table: z.ZodString;
+        map: z.ZodRecord<z.ZodString, z.ZodString>;
+        source: z.ZodOptional<z.ZodObject<{
+            column: z.ZodString;
+            value: z.ZodString;
+        }, z.core.$strict>>;
+    }, z.core.$strict>>>;
+    tell: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        kind: z.ZodEnum<{
+            role: "role";
+            person: "person";
+        }>;
+        id: z.ZodString;
+    }, z.core.$strict>>>;
+    tellWhen: z.ZodOptional<z.ZodObject<{
+        question: z.ZodString;
+        atMost: z.ZodNumber;
+    }, z.core.$strict>>;
+    limits: z.ZodDefault<z.ZodObject<{
+        perHour: z.ZodDefault<z.ZodNumber>;
+        harder: z.ZodDefault<z.ZodBoolean>;
+    }, z.core.$strict>>;
+    survey: z.ZodOptional<z.ZodObject<{
+        mode: z.ZodEnum<{
+            named: "named";
+            anonymous: "anonymous";
+        }>;
+        linkNames: z.ZodBoolean;
+        stopAfterDays: z.ZodDefault<z.ZodNumber>;
+    }, z.core.$strict>>;
+}, z.core.$strict>;
+export type FormSettings = z.infer<typeof formSettingsSchema>;
+export type FormSettingsInput = z.input<typeof formSettingsSchema>;
+export { keepsNames } from './scales.js';
+//# sourceMappingURL=settings.d.ts.map

package/dist/forms/settings.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"settings.d.ts","sourceRoot":"","sources":["../../src/forms/settings.ts"],"names":[],"mappings":"AACA;;;;;;;;;;;;;GAaG;AACH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAIxB,yDAAyD;AACzD,eAAO,MAAM,mBAAmB,aAA6D,CAAC;AAE9F,gDAAgD;AAChD,eAAO,MAAM,aAAa,KAAK,CAAC;AAChC,2EAA2E;AAC3E,eAAO,MAAM,qBAAqB,MAAM,CAAC;AACzC,eAAO,MAAM,iBAAiB,OAAO,CAAC;AACtC,8EAA8E;AAC9E,eAAO,MAAM,8BAA8B,KAAK,CAAC;AAEjD,eAAO,MAAM,iBAAiB;;;;;;;kBASnB,CAAC;AACZ,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAE5D,eAAO,MAAM,cAAc;;;;;;kBAAyF,CAAC;AAErH,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBA4BpB,CAAC;AACZ,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAC9D,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAEnE,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC"}

package/dist/forms/settings.js

@@ -0,0 +1,68 @@
+// SPDX-License-Identifier: AGPL-3.0-only
+/**
+ * A FORM'S SETTINGS: what the owner sets beside the questions (comp M-4,
+ * "Form settings"). What an answer becomes, who is told, the limits, and a
+ * survey's three settings.
+ *
+ * "Becomes" names a table and fills its columns from answers. Which tables a
+ * form may write, and which of their columns, is the app's to say through its
+ * `publicAccess` entry under the key `forms`: the engine holds the map to that
+ * entry when the form is published and on every answer. This file checks only
+ * what the form itself can see: that the map names its own questions, of
+ * kinds an answer can be written from, each into a column of its own.
+ *
+ * Pure: no I/O.
+ */
+import { z } from 'zod';
+import { questionIdSchema } from './definition.js';
+/** A column of an app's table, by the manifest's ref. */
+export const formColumnRefSchema = z.string().regex(/^[a-z][a-z0-9_]{0,62}$/, 'a column ref');
+/** The most people and roles one form tells. */
+export const FORM_TELL_MAX = 10;
+/** The hourly cap a form starts with, and the most it may be raised to. */
+export const FORM_PER_HOUR_DEFAULT = 200;
+export const FORM_PER_HOUR_MAX = 1000;
+/** How many days after each invitation a survey takes answers, by default. */
+export const SURVEY_STOP_AFTER_DAYS_DEFAULT = 30;
+export const formBecomesSchema = z
+    .object({
+    /** The app table, by the id the kit names it with. */
+    table: z.string().min(1).max(200),
+    /** Which question fills which column. */
+    map: z.record(questionIdSchema, formColumnRefSchema),
+    /** A fixed value the row gets whoever answers ("Source → Showroom form"). */
+    source: z.object({ column: formColumnRefSchema, value: z.string().min(1).max(200) }).strict().optional(),
+})
+    .strict();
+export const formTellSchema = z.object({ kind: z.enum(['role', 'person']), id: z.string().min(1).max(64) }).strict();
+export const formSettingsSchema = z
+    .object({
+    /** A new row in an app's table, or nothing but the answer (`null`). */
+    becomes: formBecomesSchema.nullable().default(null),
+    /** Who gets a bell and an e-mail for each answer. */
+    tell: z.array(formTellSchema).max(FORM_TELL_MAX).default([]),
+    /** Only when this score or star answer is at most this (a survey's low-score tell). */
+    tellWhen: z.object({ question: questionIdSchema, atMost: z.number().int().min(0).max(10) }).strict().optional(),
+    limits: z
+        .object({
+        perHour: z.number().int().min(1).max(FORM_PER_HOUR_MAX).default(FORM_PER_HOUR_DEFAULT),
+        /** A harder human check: the challenge's difficulty goes up. */
+        harder: z.boolean().default(false),
+    })
+        .strict()
+        .default({ perHour: FORM_PER_HOUR_DEFAULT, harder: false }),
+    /** A survey's own settings; required on a survey and refused on a form. */
+    survey: z
+        .object({
+        /** Named: invitations only. Anonymous: an open link, and no names kept. */
+        mode: z.enum(['named', 'anonymous']),
+        /** Link answers to names (off: the answers are anonymous). */
+        linkNames: z.boolean(),
+        stopAfterDays: z.number().int().min(1).max(365).default(SURVEY_STOP_AFTER_DAYS_DEFAULT),
+    })
+        .strict()
+        .optional(),
+})
+    .strict();
+export { keepsNames } from './scales.js';
+//# sourceMappingURL=settings.js.map

package/dist/forms/settings.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"settings.js","sourceRoot":"","sources":["../../src/forms/settings.ts"],"names":[],"mappings":"AAAA,yCAAyC;AACzC;;;;;;;;;;;;;GAaG;AACH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AAEnD,yDAAyD;AACzD,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,wBAAwB,EAAE,cAAc,CAAC,CAAC;AAE9F,gDAAgD;AAChD,MAAM,CAAC,MAAM,aAAa,GAAG,EAAE,CAAC;AAChC,2EAA2E;AAC3E,MAAM,CAAC,MAAM,qBAAqB,GAAG,GAAG,CAAC;AACzC,MAAM,CAAC,MAAM,iBAAiB,GAAG,IAAI,CAAC;AACtC,8EAA8E;AAC9E,MAAM,CAAC,MAAM,8BAA8B,GAAG,EAAE,CAAC;AAEjD,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC;KAC/B,MAAM,CAAC;IACN,sDAAsD;IACtD,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC;IACjC,yCAAyC;IACzC,GAAG,EAAE,CAAC,CAAC,MAAM,CAAC,gBAAgB,EAAE,mBAAmB,CAAC;IACpD,6EAA6E;IAC7E,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,mBAAmB,EAAE,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CACzG,CAAC;KACD,MAAM,EAAE,CAAC;AAGZ,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC;AAErH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC;KAChC,MAAM,CAAC;IACN,uEAAuE;IACvE,OAAO,EAAE,iBAAiB,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC;IACnD,qDAAqD;IACrD,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC;IAC5D,uFAAuF;IACvF,QAAQ,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,QAAQ,EAAE,gBAAgB,EAAE,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC/G,MAAM,EAAE,CAAC;SACN,MAAM,CAAC;QACN,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC,OAAO,CAAC,qBAAqB,CAAC;QACtF,gEAAgE;QAChE,MAAM,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC;KACnC,CAAC;SACD,MAAM,EAAE;SACR,OAAO,CAAC,EAAE,OAAO,EAAE,qBAAqB,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC;IAC7D,2EAA2E;IAC3E,MAAM,EAAE,CAAC;SACN,MAAM,CAAC;QACN,2EAA2E;QAC3E,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;QACpC,8DAA8D;QAC9D,SAAS,EAAE,CAAC,CAAC,OAAO,EAAE;QACtB,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,8BAA8B,CAAC;KACxF,CAAC;SACD,MAAM,EAAE;SACR,QAAQ,EAAE;CACd,CAAC;KACD,MAAM,EAAE,CAAC;AAIZ,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC"}

package/dist/forms/slug.d.ts

@@ -0,0 +1,23 @@
+/**
+ * A FORM'S SLUG: the last part of its address (`/x/forms/<slug>`).
+ *
+ * One rule, held by the engine's door (a slug that breaks it is never
+ * served) and by the forms add-on's builder (which refuses it as it is
+ * typed), so a form the builder lets through is a form the door serves.
+ *
+ *  - lower-case letters, digits and dashes, 1 to 80 characters, with no dash
+ *    at either end;
+ *  - never one of the words the addresses themselves use: `api` (the
+ *    form's own reads, `/x/forms/api/<slug>`), and `surveys` (the staff
+ *    page's own path to a survey, `/add-ons/<key>/<key>/surveys/<slug>`,
+ *    beside a form's `/add-ons/<key>/<key>/<slug>`).
+ */
+/** A slug as a form's address may carry one: lower-case letters, digits and dashes. */
+export declare const FORM_SLUG: RegExp;
+/** The longest a slug is. */
+export declare const FORM_SLUG_MAX = 80;
+/** The slugs no form may have: words the addresses themselves use. */
+export declare const FORM_SLUGS_RESERVED: readonly string[];
+/** Whether a form may have this slug: it keeps the rule, and is no reserved word. */
+export declare function isFormSlug(slug: unknown): slug is string;
+//# sourceMappingURL=slug.d.ts.map

package/dist/forms/slug.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"slug.d.ts","sourceRoot":"","sources":["../../src/forms/slug.ts"],"names":[],"mappings":"AACA;;;;;;;;;;;;;GAaG;AAEH,uFAAuF;AACvF,eAAO,MAAM,SAAS,QAA2C,CAAC;AAElE,6BAA6B;AAC7B,eAAO,MAAM,aAAa,KAAK,CAAC;AAEhC,sEAAsE;AACtE,eAAO,MAAM,mBAAmB,EAAE,SAAS,MAAM,EAAuB,CAAC;AAEzE,qFAAqF;AACrF,wBAAgB,UAAU,CAAC,IAAI,EAAE,OAAO,GAAG,IAAI,IAAI,MAAM,CAExD"}

package/dist/forms/slug.js

@@ -0,0 +1,26 @@
+// SPDX-License-Identifier: AGPL-3.0-only
+/**
+ * A FORM'S SLUG: the last part of its address (`/x/forms/<slug>`).
+ *
+ * One rule, held by the engine's door (a slug that breaks it is never
+ * served) and by the forms add-on's builder (which refuses it as it is
+ * typed), so a form the builder lets through is a form the door serves.
+ *
+ *  - lower-case letters, digits and dashes, 1 to 80 characters, with no dash
+ *    at either end;
+ *  - never one of the words the addresses themselves use: `api` (the
+ *    form's own reads, `/x/forms/api/<slug>`), and `surveys` (the staff
+ *    page's own path to a survey, `/add-ons/<key>/<key>/surveys/<slug>`,
+ *    beside a form's `/add-ons/<key>/<key>/<slug>`).
+ */
+/** A slug as a form's address may carry one: lower-case letters, digits and dashes. */
+export const FORM_SLUG = /^[a-z0-9](?:[a-z0-9-]{0,78}[a-z0-9])?$/;
+/** The longest a slug is. */
+export const FORM_SLUG_MAX = 80;
+/** The slugs no form may have: words the addresses themselves use. */
+export const FORM_SLUGS_RESERVED = ['api', 'surveys'];
+/** Whether a form may have this slug: it keeps the rule, and is no reserved word. */
+export function isFormSlug(slug) {
+    return typeof slug === 'string' && FORM_SLUG.test(slug) && !FORM_SLUGS_RESERVED.includes(slug);
+}
+//# sourceMappingURL=slug.js.map

package/dist/forms/slug.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"slug.js","sourceRoot":"","sources":["../../src/forms/slug.ts"],"names":[],"mappings":"AAAA,yCAAyC;AACzC;;;;;;;;;;;;;GAaG;AAEH,uFAAuF;AACvF,MAAM,CAAC,MAAM,SAAS,GAAG,wCAAwC,CAAC;AAElE,6BAA6B;AAC7B,MAAM,CAAC,MAAM,aAAa,GAAG,EAAE,CAAC;AAEhC,sEAAsE;AACtE,MAAM,CAAC,MAAM,mBAAmB,GAAsB,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;AAEzE,qFAAqF;AACrF,MAAM,UAAU,UAAU,CAAC,IAAa;IACtC,OAAO,OAAO,IAAI,KAAK,QAAQ,IAAI,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,mBAAmB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;AACjG,CAAC"}

package/dist/forms/summary.d.ts

@@ -0,0 +1,60 @@
+/**
+ * A form's results, counted: per choice, per score, per star, the recommend
+ * score and the stars' average, how many answered each question, and how
+ * many answers came in each language. Every language's answers are counted
+ * together (one form, a version per language). Numbers only: the dashboard
+ * words them.
+ *
+ * The answers are what the engine stored, read back: a value that does not
+ * fit its question (a form changed since) is left out of that question's
+ * counts rather than counted wrong.
+ *
+ * Pure: no I/O.
+ */
+import { type FormQuestionKind } from './definition.js';
+import type { Form } from './parse.js';
+import { type FormLanguage } from './words.js';
+/** What is counted of one question. */
+export type QuestionSummary = {
+    kind: 'one' | 'several';
+    answered: number;
+    choices: Record<string, number>;
+} | {
+    kind: 'score';
+    answered: number;
+    /** How many gave each score, index = score (0–10). */
+    counts: number[];
+    /** 9–10, 7–8 and 0–6. */
+    promoters: number;
+    passives: number;
+    detractors: number;
+    /** Promoters' share minus detractors', a whole-number percentage with its sign; null with no answer. */
+    recommendScore: number | null;
+} | {
+    kind: 'stars';
+    answered: number;
+    /** How many gave each number of stars, index 0 = one star. */
+    counts: number[];
+    /** To one decimal; null with no answer. */
+    average: number | null;
+} | {
+    kind: Exclude<FormQuestionKind, 'one' | 'several' | 'score' | 'stars'>;
+    answered: number;
+};
+export interface FormSummary {
+    /** Every answer counted. */
+    total: number;
+    /** Answers per language: every language the form lists, and any other an answer came in. */
+    byLanguage: Partial<Record<FormLanguage, number>>;
+    /** The survey's recommend question's score; null when it has none or nobody gave one. */
+    recommendScore: number | null;
+    questions: Record<string, QuestionSummary>;
+}
+/** The recommend score of counts per score 0–10: promoters' share minus detractors', as a whole-number percentage. */
+export declare function recommendScoreOf(counts: readonly number[]): number | null;
+/** A form's answers, counted. */
+export declare function summarise(form: Pick<Form, 'definition'>, answers: readonly {
+    values: Readonly<Record<string, unknown>>;
+    language: string;
+}[]): FormSummary;
+//# sourceMappingURL=summary.d.ts.map

package/dist/forms/summary.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"summary.d.ts","sourceRoot":"","sources":["../../src/forms/summary.ts"],"names":[],"mappings":"AACA;;;;;;;;;;;;GAYG;AACH,OAAO,EAAY,KAAK,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AAClE,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,YAAY,CAAC;AACvC,OAAO,EAAkB,KAAK,YAAY,EAAE,MAAM,YAAY,CAAC;AAE/D,uCAAuC;AACvC,MAAM,MAAM,eAAe,GACvB;IAAE,IAAI,EAAE,KAAK,GAAG,SAAS,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CAAE,GAC9E;IACE,IAAI,EAAE,OAAO,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;IACjB,sDAAsD;IACtD,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,yBAAyB;IACzB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,wGAAwG;IACxG,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;CAC/B,GACD;IACE,IAAI,EAAE,OAAO,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;IACjB,8DAA8D;IAC9D,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,2CAA2C;IAC3C,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB,GACD;IAAE,IAAI,EAAE,OAAO,CAAC,gBAAgB,EAAE,KAAK,GAAG,SAAS,GAAG,OAAO,GAAG,OAAO,CAAC,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,CAAC;AAEjG,MAAM,WAAW,WAAW;IAC1B,4BAA4B;IAC5B,KAAK,EAAE,MAAM,CAAC;IACd,4FAA4F;IAC5F,UAAU,EAAE,OAAO,CAAC,MAAM,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC,CAAC;IAClD,yFAAyF;IACzF,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;CAC5C;AAED,sHAAsH;AACtH,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,SAAS,MAAM,EAAE,GAAG,MAAM,GAAG,IAAI,CAQzE;AAID,iCAAiC;AACjC,wBAAgB,SAAS,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,YAAY,CAAC,EAAE,OAAO,EAAE,SAAS;IAAE,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,EAAE,GAAG,WAAW,CAsD1J"}

package/dist/forms/summary.js

@@ -0,0 +1,91 @@
+// SPDX-License-Identifier: AGPL-3.0-only
+/**
+ * A form's results, counted: per choice, per score, per star, the recommend
+ * score and the stars' average, how many answered each question, and how
+ * many answers came in each language. Every language's answers are counted
+ * together (one form, a version per language). Numbers only: the dashboard
+ * words them.
+ *
+ * The answers are what the engine stored, read back: a value that does not
+ * fit its question (a form changed since) is left out of that question's
+ * counts rather than counted wrong.
+ *
+ * Pure: no I/O.
+ */
+import { SCALE_OF } from './definition.js';
+import { FORM_LANGUAGES } from './words.js';
+/** The recommend score of counts per score 0–10: promoters' share minus detractors', as a whole-number percentage. */
+export function recommendScoreOf(counts) {
+    const answered = counts.reduce((sum, n) => sum + n, 0);
+    if (answered === 0)
+        return null;
+    const promoters = (counts[9] ?? 0) + (counts[10] ?? 0);
+    const detractors = counts.slice(0, 7).reduce((sum, n) => sum + n, 0);
+    const score = Math.round(((promoters - detractors) * 100) / answered);
+    // Never "-0".
+    return score === 0 ? 0 : score;
+}
+const isLanguage = (value) => typeof value === 'string' && FORM_LANGUAGES.includes(value);
+/** A form's answers, counted. */
+export function summarise(form, answers) {
+    const { definition } = form;
+    const byLanguage = Object.fromEntries(definition.languages.map((language) => [language, 0]));
+    for (const answer of answers)
+        if (isLanguage(answer.language))
+            byLanguage[answer.language] = (byLanguage[answer.language] ?? 0) + 1;
+    const questions = {};
+    let recommendScore = null;
+    for (const question of definition.questions) {
+        const given = answers.map((answer) => answer.values[question.id]).filter((value) => value !== undefined && value !== null && value !== '');
+        switch (question.kind) {
+            case 'one':
+            case 'several': {
+                const choices = Object.fromEntries(question.choices.map((choice) => [choice.id, 0]));
+                let answered = 0;
+                for (const value of given) {
+                    const picks = (question.kind === 'one' ? [value] : Array.isArray(value) ? value : []).filter((pick) => typeof pick === 'string' && pick in choices);
+                    if (picks.length === 0)
+                        continue;
+                    answered += 1;
+                    for (const pick of new Set(picks))
+                        choices[pick] = (choices[pick] ?? 0) + 1;
+                }
+                questions[question.id] = { kind: question.kind, answered, choices };
+                break;
+            }
+            case 'score':
+            case 'stars': {
+                const scale = SCALE_OF[question.kind];
+                const counts = Array.from({ length: scale.max - scale.min + 1 }, () => 0);
+                for (const value of given) {
+                    if (typeof value === 'number' && Number.isInteger(value) && value >= scale.min && value <= scale.max)
+                        counts[value - scale.min] += 1;
+                }
+                const answered = counts.reduce((sum, n) => sum + n, 0);
+                if (question.kind === 'score') {
+                    const score = recommendScoreOf(counts);
+                    questions[question.id] = {
+                        kind: 'score',
+                        answered,
+                        counts,
+                        promoters: counts[9] + counts[10],
+                        passives: counts[7] + counts[8],
+                        detractors: counts.slice(0, 7).reduce((sum, n) => sum + n, 0),
+                        recommendScore: score,
+                    };
+                    if (question.recommend === true)
+                        recommendScore = score;
+                }
+                else {
+                    const total = counts.reduce((sum, n, i) => sum + n * (i + 1), 0);
+                    questions[question.id] = { kind: 'stars', answered, counts, average: answered === 0 ? null : Math.round((total * 10) / answered) / 10 };
+                }
+                break;
+            }
+            default:
+                questions[question.id] = { kind: question.kind, answered: given.length };
+        }
+    }
+    return { total: answers.length, byLanguage, recommendScore, questions };
+}
+//# sourceMappingURL=summary.js.map

package/dist/forms/summary.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"summary.js","sourceRoot":"","sources":["../../src/forms/summary.ts"],"names":[],"mappings":"AAAA,yCAAyC;AACzC;;;;;;;;;;;;GAYG;AACH,OAAO,EAAE,QAAQ,EAAyB,MAAM,iBAAiB,CAAC;AAElE,OAAO,EAAE,cAAc,EAAqB,MAAM,YAAY,CAAC;AAqC/D,sHAAsH;AACtH,MAAM,UAAU,gBAAgB,CAAC,MAAyB;IACxD,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,GAAG,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC;IACvD,IAAI,QAAQ,KAAK,CAAC;QAAE,OAAO,IAAI,CAAC;IAChC,MAAM,SAAS,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC;IACvD,MAAM,UAAU,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,GAAG,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC;IACrE,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,GAAG,UAAU,CAAC,GAAG,GAAG,CAAC,GAAG,QAAQ,CAAC,CAAC;IACtE,cAAc;IACd,OAAO,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;AACjC,CAAC;AAED,MAAM,UAAU,GAAG,CAAC,KAAc,EAAyB,EAAE,CAAC,OAAO,KAAK,KAAK,QAAQ,IAAK,cAAoC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;AAEjJ,iCAAiC;AACjC,MAAM,UAAU,SAAS,CAAC,IAA8B,EAAE,OAAmF;IAC3I,MAAM,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC;IAC5B,MAAM,UAAU,GAA0C,MAAM,CAAC,WAAW,CAAC,UAAU,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;IACpI,KAAK,MAAM,MAAM,IAAI,OAAO;QAAE,IAAI,UAAU,CAAC,MAAM,CAAC,QAAQ,CAAC;YAAE,UAAU,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,UAAU,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC;IAEpI,MAAM,SAAS,GAAoC,EAAE,CAAC;IACtD,IAAI,cAAc,GAAkB,IAAI,CAAC;IACzC,KAAK,MAAM,QAAQ,IAAI,UAAU,CAAC,SAAS,EAAE,CAAC;QAC5C,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,EAAE,CAAC,CAAC;QAC3I,QAAQ,QAAQ,CAAC,IAAI,EAAE,CAAC;YACtB,KAAK,KAAK,CAAC;YACX,KAAK,SAAS,CAAC,CAAC,CAAC;gBACf,MAAM,OAAO,GAA2B,MAAM,CAAC,WAAW,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;gBAC7G,IAAI,QAAQ,GAAG,CAAC,CAAC;gBACjB,KAAK,MAAM,KAAK,IAAI,KAAK,EAAE,CAAC;oBAC1B,MAAM,KAAK,GAAG,CAAC,QAAQ,CAAC,IAAI,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,EAAkB,EAAE,CAAC,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,IAAI,OAAO,CAAC,CAAC;oBACpK,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;wBAAE,SAAS;oBACjC,QAAQ,IAAI,CAAC,CAAC;oBACd,KAAK,MAAM,IAAI,IAAI,IAAI,GAAG,CAAC,KAAK,CAAC;wBAAE,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC;gBAC9E,CAAC;gBACD,SAAS,CAAC,QAAQ,CAAC,EAAE,CAAC,GAAG,EAAE,IAAI,EAAE,QAAQ,CAAC,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC;gBACpE,MAAM;YACR,CAAC;YACD,KAAK,OAAO,CAAC;YACb,KAAK,OAAO,CAAC,CAAC,CAAC;gBACb,MAAM,KAAK,GAAG,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;gBACtC,MAAM,MAAM,GAAG,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,GAAG,GAAG,KAAK,CAAC,GAAG,GAAG,CAAC,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC;gBAC1E,KAAK,MAAM,KAAK,IAAI,KAAK,EAAE,CAAC;oBAC1B,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,KAAK,IAAI,KAAK,CAAC,GAAG,IAAI,KAAK,IAAI,KAAK,CAAC,GAAG;wBAAE,MAAM,CAAC,KAAK,GAAG,KAAK,CAAC,GAAG,CAAE,IAAI,CAAC,CAAC;gBACxI,CAAC;gBACD,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,GAAG,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC;gBACvD,IAAI,QAAQ,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;oBAC9B,MAAM,KAAK,GAAG,gBAAgB,CAAC,MAAM,CAAC,CAAC;oBACvC,SAAS,CAAC,QAAQ,CAAC,EAAE,CAAC,GAAG;wBACvB,IAAI,EAAE,OAAO;wBACb,QAAQ;wBACR,MAAM;wBACN,SAAS,EAAE,MAAM,CAAC,CAAC,CAAE,GAAG,MAAM,CAAC,EAAE,CAAE;wBACnC,QAAQ,EAAE,MAAM,CAAC,CAAC,CAAE,GAAG,MAAM,CAAC,CAAC,CAAE;wBACjC,UAAU,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,GAAG,GAAG,CAAC,EAAE,CAAC,CAAC;wBAC7D,cAAc,EAAE,KAAK;qBACtB,CAAC;oBACF,IAAI,QAAQ,CAAC,SAAS,KAAK,IAAI;wBAAE,cAAc,GAAG,KAAK,CAAC;gBAC1D,CAAC;qBAAM,CAAC;oBACN,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;oBACjE,SAAS,CAAC,QAAQ,CAAC,EAAE,CAAC,GAAG,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,KAAK,GAAG,EAAE,CAAC,GAAG,QAAQ,CAAC,GAAG,EAAE,EAAE,CAAC;gBAC1I,CAAC;gBACD,MAAM;YACR,CAAC;YACD;gBACE,SAAS,CAAC,QAAQ,CAAC,EAAE,CAAC,GAAG,EAAE,IAAI,EAAE,QAAQ,CAAC,IAAI,EAAE,QAAQ,EAAE,KAAK,CAAC,MAAM,EAAE,CAAC;QAC7E,CAAC;IACH,CAAC;IACD,OAAO,EAAE,KAAK,EAAE,OAAO,CAAC,MAAM,EAAE,UAAU,EAAE,cAAc,EAAE,SAAS,EAAE,CAAC;AAC1E,CAAC"}

package/dist/forms/websites.d.ts

@@ -0,0 +1,54 @@
+/**
+ * "YOUR WEBSITES": the check each line of the add box is held to.
+ *
+ * The owner lists the websites that may show a form in a frame. Each line
+ * is one website, reduced to its origin (`https://shop.example`: lower
+ * case, no path, no trailing slash, no default port). The Privacy page
+ * checks every line as it is typed and the server checks the same lines on
+ * save with this one function, so the two can never disagree.
+ *
+ * The checks, in this order, the first that fails naming the line:
+ *
+ *   one-per-line  empty, or holds a space, a comma or a `*`
+ *   https         does not start with `https://`
+ *   address       not a website address once read (no host, a user name in
+ *                 it, longer than an origin may be)
+ *   path          names a path, a query or a fragment beyond the origin
+ *   self          this server's own address
+ *   listed        already on the list (or an earlier line of the same batch)
+ *   ok            ready to add
+ *
+ * Pure: no I/O, no schema, no `node:` import, so a page carries it lightly.
+ */
+/** The most websites the list holds. */
+export declare const WEBSITES_MAX = 50;
+/** The longest origin kept (as the server's own public address). */
+export declare const WEBSITE_ORIGIN_MAX = 255;
+/** The longest line read: anything longer is refused before it is parsed. */
+export declare const WEBSITE_LINE_MAX = 300;
+export declare const WEBSITE_LINE_CODES: readonly ["one-per-line", "https", "address", "path", "self", "listed", "ok"];
+export type WebsiteLineCode = (typeof WEBSITE_LINE_CODES)[number];
+/** One line, checked: its code, and its origin once it was read as one. */
+export interface WebsiteLine {
+    line: string;
+    code: WebsiteLineCode;
+    /** The origin the line reduces to; null when it did not read as an address. */
+    origin: string | null;
+}
+export interface WebsiteCheckContext {
+    /** This server's public address (`system.publicOrigin`), or null when none is set. */
+    self: string | null;
+    /** The origins already listed. */
+    listed: readonly string[];
+}
+/** One line, checked against the list and this server's own address. */
+export declare function checkWebsiteLine(line: string, ctx: WebsiteCheckContext): WebsiteLine;
+/**
+ * Every line of a batch, checked in order: a line naming the same origin as
+ * an earlier line of the batch is "already on the list" too, so a batch
+ * never adds one website twice.
+ */
+export declare function checkWebsiteLines(lines: readonly string[], ctx: WebsiteCheckContext): WebsiteLine[];
+/** Whether a stored value is a listed website's origin as this check makes one. */
+export declare function isWebsiteOrigin(value: string): boolean;
+//# sourceMappingURL=websites.d.ts.map

package/dist/forms/websites.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"websites.d.ts","sourceRoot":"","sources":["../../src/forms/websites.ts"],"names":[],"mappings":"AACA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAEH,wCAAwC;AACxC,eAAO,MAAM,YAAY,KAAK,CAAC;AAE/B,oEAAoE;AACpE,eAAO,MAAM,kBAAkB,MAAM,CAAC;AAEtC,6EAA6E;AAC7E,eAAO,MAAM,gBAAgB,MAAM,CAAC;AAEpC,eAAO,MAAM,kBAAkB,+EAAgF,CAAC;AAChH,MAAM,MAAM,eAAe,GAAG,CAAC,OAAO,kBAAkB,CAAC,CAAC,MAAM,CAAC,CAAC;AAElE,2EAA2E;AAC3E,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,eAAe,CAAC;IACtB,+EAA+E;IAC/E,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,MAAM,WAAW,mBAAmB;IAClC,sFAAsF;IACtF,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,kCAAkC;IAClC,MAAM,EAAE,SAAS,MAAM,EAAE,CAAC;CAC3B;AA4BD,wEAAwE;AACxE,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,mBAAmB,GAAG,WAAW,CAUpF;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,SAAS,MAAM,EAAE,EAAE,GAAG,EAAE,mBAAmB,GAAG,WAAW,EAAE,CAOnG;AAED,mFAAmF;AACnF,wBAAgB,eAAe,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAGtD"}