@adminiumjs/manifest 0.3.0-rc.4 → 0.3.1

package/dist/add-ons.d.ts

@@ -0,0 +1,63 @@
+/**
+ * `addOns` — the add-ons an app needs, and the ones it works better with.
+ *
+ * ```json
+ * "addOns": {
+ *   "requires": [{ "key": "invoices", "range": ">=1.1.0",
+ *                  "reason": { "en-US": "Proposals, invoices and receipts are made by this add-on." } }],
+ *   "suggests": [{ "key": "holiday-calendars", "range": ">=1.1.0", "checked": true,
+ *                  "reason": { "en-US": "Marks public holidays as days off." } }],
+ *   "features": [{ "id": "capacity-holidays", "label": { "en-US": "Holidays in Capacity" },
+ *                  "requires": ["holiday-calendars"] }]
+ * }
+ * ```
+ *
+ * Installing the app installs (or connects) every add-on it `requires`,
+ * before its own tables; one that is missing and cannot be had refuses the
+ * install before anything is written, and an add-on an installed app
+ * requires cannot be removed. A `suggests` entry is offered with the app,
+ * ticked when `checked`. A `feature` names what stops working without its
+ * add-ons, so a page may say `"feature": "<id>"` and stay hidden until they
+ * are there.
+ *
+ * Every `range` is a semver range over the add-on's version (`>=1.1.0`,
+ * `^1.1.0`); the reasons and labels are in every language the app speaks,
+ * US English always among them.
+ */
+import { z } from 'zod';
+import { type ReferenceIssue } from './refs.js';
+export declare const addOnsSchema: z.ZodObject<{
+    requires: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        key: z.ZodString;
+        range: z.ZodString;
+        reason: z.ZodRecord<z.ZodString, z.ZodString>;
+    }, z.core.$strict>>>;
+    suggests: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        key: z.ZodString;
+        range: z.ZodString;
+        reason: z.ZodRecord<z.ZodString, z.ZodString>;
+        checked: z.ZodOptional<z.ZodBoolean>;
+    }, z.core.$strict>>>;
+    features: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        label: z.ZodRecord<z.ZodString, z.ZodString>;
+        requires: z.ZodArray<z.ZodString>;
+    }, z.core.$strict>>>;
+}, z.core.$strict>;
+export type AddOnNeeds = z.infer<typeof addOnsSchema>;
+/** The add-ons an app names at all: required first, then suggested. */
+export declare function namedAddOns(needs: AddOnNeeds | undefined): {
+    key: string;
+    need: 'requires' | 'suggests';
+}[];
+/** Whether the app requires this add-on (so it is always there when the app runs). */
+export declare function requiresAddOn(needs: AddOnNeeds | undefined, key: string): boolean;
+/** Everything wrong with an app's `addOns` and the pages that name a feature. */
+export declare function addOnNeedsIssues(m: {
+    key: string;
+    addOns?: AddOnNeeds | undefined;
+    pages?: readonly {
+        feature?: string | undefined;
+    }[] | undefined;
+}): ReferenceIssue[];
+//# sourceMappingURL=add-ons.d.ts.map

package/dist/add-ons.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"add-ons.d.ts","sourceRoot":"","sources":["../src/add-ons.ts"],"names":[],"mappings":"AACA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAAgB,KAAK,cAAc,EAAE,MAAM,WAAW,CAAC;AAa9D,eAAO,MAAM,YAAY;;;;;;;;;;;;;;;;;kBAkBd,CAAC;AACZ,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,YAAY,CAAC,CAAC;AAEtD,uEAAuE;AACvE,wBAAgB,WAAW,CAAC,KAAK,EAAE,UAAU,GAAG,SAAS,GAAG;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,UAAU,GAAG,UAAU,CAAA;CAAE,EAAE,CAK3G;AAED,sFAAsF;AACtF,wBAAgB,aAAa,CAAC,KAAK,EAAE,UAAU,GAAG,SAAS,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAEjF;AAED,iFAAiF;AACjF,wBAAgB,gBAAgB,CAAC,CAAC,EAAE;IAClC,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,CAAC,EAAE,UAAU,GAAG,SAAS,CAAC;IAChC,KAAK,CAAC,EAAE,SAAS;QAAE,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;KAAE,EAAE,GAAG,SAAS,CAAC;CACjE,GAAG,cAAc,EAAE,CA6BnB"}

package/dist/add-ons.js

@@ -0,0 +1,100 @@
+// SPDX-License-Identifier: AGPL-3.0-only
+/**
+ * `addOns` — the add-ons an app needs, and the ones it works better with.
+ *
+ * ```json
+ * "addOns": {
+ *   "requires": [{ "key": "invoices", "range": ">=1.1.0",
+ *                  "reason": { "en-US": "Proposals, invoices and receipts are made by this add-on." } }],
+ *   "suggests": [{ "key": "holiday-calendars", "range": ">=1.1.0", "checked": true,
+ *                  "reason": { "en-US": "Marks public holidays as days off." } }],
+ *   "features": [{ "id": "capacity-holidays", "label": { "en-US": "Holidays in Capacity" },
+ *                  "requires": ["holiday-calendars"] }]
+ * }
+ * ```
+ *
+ * Installing the app installs (or connects) every add-on it `requires`,
+ * before its own tables; one that is missing and cannot be had refuses the
+ * install before anything is written, and an add-on an installed app
+ * requires cannot be removed. A `suggests` entry is offered with the app,
+ * ticked when `checked`. A `feature` names what stops working without its
+ * add-ons, so a page may say `"feature": "<id>"` and stay hidden until they
+ * are there.
+ *
+ * Every `range` is a semver range over the add-on's version (`>=1.1.0`,
+ * `^1.1.0`); the reasons and labels are in every language the app speaks,
+ * US English always among them.
+ */
+import { z } from 'zod';
+import { labelsSchema } from './refs.js';
+import { parseSemverRange } from './semver.js';
+const addOnKeySchema = z.string().regex(/^[a-z][a-z0-9-]{1,79}$/, 'an add-on key');
+const rangeSchema = z
+    .string()
+    .min(1)
+    .max(120)
+    .refine((range) => parseSemverRange(range) !== null, { message: 'a semver range such as ">=1.1.0" or "^1.1.0"' });
+const needSchema = z.object({ key: addOnKeySchema, range: rangeSchema, reason: labelsSchema }).strict();
+export const addOnsSchema = z
+    .object({
+    requires: z.array(needSchema).min(1).max(8).optional(),
+    suggests: z.array(needSchema.extend({ checked: z.boolean().optional() }).strict()).min(1).max(8).optional(),
+    features: z
+        .array(z
+        .object({
+        id: z.string().regex(/^[a-z][a-z0-9-]{0,39}$/, 'a feature id is kebab-case'),
+        label: labelsSchema,
+        requires: z.array(addOnKeySchema).min(1).max(4),
+    })
+        .strict())
+        .min(1)
+        .max(16)
+        .optional(),
+})
+    .strict();
+/** The add-ons an app names at all: required first, then suggested. */
+export function namedAddOns(needs) {
+    return [
+        ...(needs?.requires ?? []).map((n) => ({ key: n.key, need: 'requires' })),
+        ...(needs?.suggests ?? []).map((n) => ({ key: n.key, need: 'suggests' })),
+    ];
+}
+/** Whether the app requires this add-on (so it is always there when the app runs). */
+export function requiresAddOn(needs, key) {
+    return (needs?.requires ?? []).some((n) => n.key === key);
+}
+/** Everything wrong with an app's `addOns` and the pages that name a feature. */
+export function addOnNeedsIssues(m) {
+    const out = [];
+    const needs = m.addOns;
+    const seen = new Map();
+    for (const list of ['requires', 'suggests']) {
+        (needs?.[list] ?? []).forEach((need, i) => {
+            const at = ['addOns', list, i, 'key'];
+            if (need.key === m.key)
+                out.push({ path: at, message: 'an app does not need itself' });
+            const earlier = seen.get(need.key);
+            if (earlier !== undefined)
+                out.push({ path: at, message: `"${need.key}" is already named in ${earlier}` });
+            seen.set(need.key, list);
+        });
+    }
+    const features = new Set();
+    (needs?.features ?? []).forEach((feature, f) => {
+        if (features.has(feature.id))
+            out.push({ path: ['addOns', 'features', f, 'id'], message: `"${feature.id}" is declared twice` });
+        features.add(feature.id);
+        feature.requires.forEach((key, k) => {
+            if (!seen.has(key)) {
+                out.push({ path: ['addOns', 'features', f, 'requires', k], message: `"${key}" is neither required nor suggested by the app` });
+            }
+        });
+    });
+    (m.pages ?? []).forEach((page, p) => {
+        if (page.feature !== undefined && !features.has(page.feature)) {
+            out.push({ path: ['pages', p, 'feature'], message: `"${page.feature}" is not one of the app's addOns.features` });
+        }
+    });
+    return out;
+}
+//# sourceMappingURL=add-ons.js.map

package/dist/add-ons.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"add-ons.js","sourceRoot":"","sources":["../src/add-ons.ts"],"names":[],"mappings":"AAAA,yCAAyC;AACzC;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAAE,YAAY,EAAuB,MAAM,WAAW,CAAC;AAC9D,OAAO,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAE/C,MAAM,cAAc,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,wBAAwB,EAAE,eAAe,CAAC,CAAC;AAEnF,MAAM,WAAW,GAAG,CAAC;KAClB,MAAM,EAAE;KACR,GAAG,CAAC,CAAC,CAAC;KACN,GAAG,CAAC,GAAG,CAAC;KACR,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,gBAAgB,CAAC,KAAK,CAAC,KAAK,IAAI,EAAE,EAAE,OAAO,EAAE,8CAA8C,EAAE,CAAC,CAAC;AAEpH,MAAM,UAAU,GAAG,CAAC,CAAC,MAAM,CAAC,EAAE,GAAG,EAAE,cAAc,EAAE,KAAK,EAAE,WAAW,EAAE,MAAM,EAAE,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC;AAExG,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC;KAC1B,MAAM,CAAC;IACN,QAAQ,EAAE,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE;IACtD,QAAQ,EAAE,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE;IAC3G,QAAQ,EAAE,CAAC;SACR,KAAK,CACJ,CAAC;SACE,MAAM,CAAC;QACN,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,wBAAwB,EAAE,4BAA4B,CAAC;QAC5E,KAAK,EAAE,YAAY;QACnB,QAAQ,EAAE,CAAC,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;KAChD,CAAC;SACD,MAAM,EAAE,CACZ;SACA,GAAG,CAAC,CAAC,CAAC;SACN,GAAG,CAAC,EAAE,CAAC;SACP,QAAQ,EAAE;CACd,CAAC;KACD,MAAM,EAAE,CAAC;AAGZ,uEAAuE;AACvE,MAAM,UAAU,WAAW,CAAC,KAA6B;IACvD,OAAO;QACL,GAAG,CAAC,KAAK,EAAE,QAAQ,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,GAAG,EAAE,IAAI,EAAE,UAAmB,EAAE,CAAC,CAAC;QAClF,GAAG,CAAC,KAAK,EAAE,QAAQ,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,GAAG,EAAE,IAAI,EAAE,UAAmB,EAAE,CAAC,CAAC;KACnF,CAAC;AACJ,CAAC;AAED,sFAAsF;AACtF,MAAM,UAAU,aAAa,CAAC,KAA6B,EAAE,GAAW;IACtE,OAAO,CAAC,KAAK,EAAE,QAAQ,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,KAAK,GAAG,CAAC,CAAC;AAC5D,CAAC;AAED,iFAAiF;AACjF,MAAM,UAAU,gBAAgB,CAAC,CAIhC;IACC,MAAM,GAAG,GAAqB,EAAE,CAAC;IACjC,MAAM,KAAK,GAAG,CAAC,CAAC,MAAM,CAAC;IACvB,MAAM,IAAI,GAAG,IAAI,GAAG,EAAkB,CAAC;IACvC,KAAK,MAAM,IAAI,IAAI,CAAC,UAAU,EAAE,UAAU,CAAU,EAAE,CAAC;QACrD,CAAC,KAAK,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,CAAC,EAAE,EAAE;YACxC,MAAM,EAAE,GAAG,CAAC,QAAQ,EAAE,IAAI,EAAE,CAAC,EAAE,KAAK,CAAC,CAAC;YACtC,IAAI,IAAI,CAAC,GAAG,KAAK,CAAC,CAAC,GAAG;gBAAE,GAAG,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,OAAO,EAAE,6BAA6B,EAAE,CAAC,CAAC;YACvF,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACnC,IAAI,OAAO,KAAK,SAAS;gBAAE,GAAG,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,OAAO,EAAE,IAAI,IAAI,CAAC,GAAG,yBAAyB,OAAO,EAAE,EAAE,CAAC,CAAC;YAC3G,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;QAC3B,CAAC,CAAC,CAAC;IACL,CAAC;IACD,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAU,CAAC;IACnC,CAAC,KAAK,EAAE,QAAQ,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,CAAC,EAAE,EAAE;QAC7C,IAAI,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC;YAAE,GAAG,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,CAAC,QAAQ,EAAE,UAAU,EAAE,CAAC,EAAE,IAAI,CAAC,EAAE,OAAO,EAAE,IAAI,OAAO,CAAC,EAAE,qBAAqB,EAAE,CAAC,CAAC;QAChI,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QACzB,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE;YAClC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;gBACnB,GAAG,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,CAAC,QAAQ,EAAE,UAAU,EAAE,CAAC,EAAE,UAAU,EAAE,CAAC,CAAC,EAAE,OAAO,EAAE,IAAI,GAAG,gDAAgD,EAAE,CAAC,CAAC;YACjI,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IACH,CAAC,CAAC,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,CAAC,EAAE,EAAE;QAClC,IAAI,IAAI,CAAC,OAAO,KAAK,SAAS,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;YAC9D,GAAG,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC,EAAE,SAAS,CAAC,EAAE,OAAO,EAAE,IAAI,IAAI,CAAC,OAAO,2CAA2C,EAAE,CAAC,CAAC;QACpH,CAAC;IACH,CAAC,CAAC,CAAC;IACH,OAAO,GAAG,CAAC;AACb,CAAC"}

package/dist/booking.d.ts

@@ -0,0 +1,100 @@
+/**
+ * `table.booking` — booking PEOPLE rather than tables: a row takes a resource
+ * (a clinician) for its own length, and two counted rows of one resource may
+ * never overlap.
+ *
+ * Beside `capacity`, not folded into it. Capacity adds up a party per start
+ * time; booking forbids overlap per resource, within that resource's hours,
+ * breaks and closures. They are different questions, and a table carries one
+ * or the other.
+ *
+ * Every table the rule names is the app's own, by ref. With `prefixed`
+ * install the server maps each of them — nested ones included — to the real
+ * table name.
+ */
+import { z } from 'zod';
+import { type ReferenceIssue, type TableIndex, type TableShape } from './refs.js';
+/** The weekday values an hours table's weekday enum must hold, in this order. */
+export declare const BOOKING_WEEKDAYS: readonly ["mon", "tue", "wed", "thu", "fri", "sat", "sun"];
+export declare const bookingSchema: z.ZodObject<{
+    start: z.ZodString;
+    minutes: z.ZodString;
+    resource: z.ZodString;
+    kind: z.ZodString;
+    countWhere: z.ZodObject<{
+        column: z.ZodString;
+        values: z.ZodArray<z.ZodString>;
+    }, z.core.$strict>;
+    eligible: z.ZodObject<{
+        table: z.ZodString;
+        resource: z.ZodString;
+        kind: z.ZodString;
+        order: z.ZodOptional<z.ZodObject<{
+            table: z.ZodString;
+            column: z.ZodString;
+            active: z.ZodOptional<z.ZodString>;
+            public: z.ZodOptional<z.ZodString>;
+        }, z.core.$strict>>;
+    }, z.core.$strict>;
+    hours: z.ZodObject<{
+        practice: z.ZodObject<{
+            weekday: z.ZodString;
+            opens: z.ZodString;
+            closes: z.ZodString;
+            breakStart: z.ZodOptional<z.ZodString>;
+            breakEnd: z.ZodOptional<z.ZodString>;
+            table: z.ZodString;
+            open: z.ZodOptional<z.ZodString>;
+        }, z.core.$strict>;
+        own: z.ZodOptional<z.ZodObject<{
+            weekday: z.ZodString;
+            opens: z.ZodString;
+            closes: z.ZodString;
+            breakStart: z.ZodOptional<z.ZodString>;
+            breakEnd: z.ZodOptional<z.ZodString>;
+            table: z.ZodString;
+            resource: z.ZodString;
+        }, z.core.$strict>>;
+    }, z.core.$strict>;
+    closures: z.ZodOptional<z.ZodObject<{
+        table: z.ZodString;
+        from: z.ZodString;
+        to: z.ZodString;
+        resource: z.ZodOptional<z.ZodString>;
+        active: z.ZodOptional<z.ZodString>;
+    }, z.core.$strict>>;
+    grid: z.ZodUnion<readonly [z.ZodNumber, z.ZodObject<{
+        table: z.ZodString;
+        column: z.ZodString;
+    }, z.core.$strict>]>;
+    windowDays: z.ZodOptional<z.ZodUnion<readonly [z.ZodNumber, z.ZodObject<{
+        table: z.ZodString;
+        column: z.ZodString;
+    }, z.core.$strict>]>>;
+    noticeMinutes: z.ZodOptional<z.ZodUnion<readonly [z.ZodNumber, z.ZodObject<{
+        table: z.ZodString;
+        column: z.ZodString;
+    }, z.core.$strict>]>>;
+    cancel: z.ZodOptional<z.ZodObject<{
+        hours: z.ZodUnion<readonly [z.ZodNumber, z.ZodObject<{
+            table: z.ZodString;
+            column: z.ZodString;
+        }, z.core.$strict>]>;
+        mode: z.ZodEnum<{
+            refuse: "refuse";
+            flag: "flag";
+        }>;
+        flag: z.ZodOptional<z.ZodString>;
+        when: z.ZodObject<{
+            column: z.ZodString;
+            to: z.ZodString;
+        }, z.core.$strict>;
+    }, z.core.$strict>>;
+}, z.core.$strict>;
+export type BookingRule = z.infer<typeof bookingSchema>;
+/**
+ * Everything in a table's booking rule that names something the manifest does
+ * not declare, or a column of the wrong kind.
+ */
+export declare function bookingIssues(table: TableShape, rule: BookingRule, index: TableIndex, at: (...rest: (string | number)[]) => (string | number)[]): ReferenceIssue[];
+//# sourceMappingURL=booking.d.ts.map

package/dist/booking.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"booking.d.ts","sourceRoot":"","sources":["../src/booking.ts"],"names":[],"mappings":"AACA;;;;;;;;;;;;;GAaG;AACH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAOL,KAAK,cAAc,EACnB,KAAK,UAAU,EACf,KAAK,UAAU,EAChB,MAAM,WAAW,CAAC;AAEnB,iFAAiF;AACjF,eAAO,MAAM,gBAAgB,4DAA6D,CAAC;AAU3F,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBA4Ef,CAAC;AACZ,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,CAAC;AAExD;;;GAGG;AACH,wBAAgB,aAAa,CAC3B,KAAK,EAAE,UAAU,EACjB,IAAI,EAAE,WAAW,EACjB,KAAK,EAAE,UAAU,EACjB,EAAE,EAAE,CAAC,GAAG,IAAI,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,GACxD,cAAc,EAAE,CAoIlB"}

package/dist/booking.js

@@ -0,0 +1,237 @@
+// SPDX-License-Identifier: AGPL-3.0-only
+/**
+ * `table.booking` — booking PEOPLE rather than tables: a row takes a resource
+ * (a clinician) for its own length, and two counted rows of one resource may
+ * never overlap.
+ *
+ * Beside `capacity`, not folded into it. Capacity adds up a party per start
+ * time; booking forbids overlap per resource, within that resource's hours,
+ * breaks and closures. They are different questions, and a table carries one
+ * or the other.
+ *
+ * Every table the rule names is the app's own, by ref. With `prefixed`
+ * install the server maps each of them — nested ones included — to the real
+ * table name.
+ */
+import { z } from 'zod';
+import { NUMERIC_TYPES, numberOrSetting, refSchema, settingRefSchema, valueFits, } from './refs.js';
+/** The weekday values an hours table's weekday enum must hold, in this order. */
+export const BOOKING_WEEKDAYS = ['mon', 'tue', 'wed', 'thu', 'fri', 'sat', 'sun'];
+const hoursColumns = {
+    weekday: refSchema,
+    opens: refSchema,
+    closes: refSchema,
+    breakStart: refSchema.optional(),
+    breakEnd: refSchema.optional(),
+};
+export const bookingSchema = z
+    .object({
+    /** When the row starts: a `timestamptz`, read in the venue's zone. */
+    start: refSchema,
+    /** How long it lasts: an int column on the row (copied from the kind). */
+    minutes: refSchema,
+    /** Whose time it takes: a foreign key. Empty on a create means "anyone" — Adminium picks. */
+    resource: refSchema,
+    /** What it is: a foreign key, which decides who may be booked for it. */
+    kind: refSchema,
+    /** Only rows whose column holds one of these take time (a cancelled visit takes none). */
+    countWhere: z.object({ column: refSchema, values: z.array(z.string().min(1)).min(1) }).strict(),
+    /** Who does what: a link table of (resource, kind), and the resources' own order and switches. */
+    eligible: z
+        .object({
+        table: refSchema,
+        resource: refSchema,
+        kind: refSchema,
+        order: z
+            .object({
+            table: refSchema,
+            column: refSchema,
+            /** A resource whose column is false is never booked. */
+            active: refSchema.optional(),
+            /** A resource whose column is false is never booked through the public API. */
+            public: refSchema.optional(),
+        })
+            .strict()
+            .optional(),
+    })
+        .strict(),
+    /**
+     * Weekly hours as `HH:MM` text, one row per weekday. A resource with rows
+     * of its own follows them; one without follows the practice's.
+     */
+    hours: z
+        .object({
+        practice: z.object({ table: refSchema, open: refSchema.optional(), ...hoursColumns }).strict(),
+        own: z.object({ table: refSchema, resource: refSchema, ...hoursColumns }).strict().optional(),
+    })
+        .strict(),
+    /** Dated closures, for everyone (resource empty) or one resource. */
+    closures: z
+        .object({
+        table: refSchema,
+        from: refSchema,
+        to: refSchema,
+        resource: refSchema.optional(),
+        active: refSchema.optional(),
+    })
+        .strict()
+        .optional(),
+    /** The minutes between bookable starts. */
+    grid: numberOrSetting,
+    /** How many working days ahead a booking may be made. */
+    windowDays: numberOrSetting.optional(),
+    /** How far ahead a public booking must be. Staff are never held to it. */
+    noticeMinutes: numberOrSetting.optional(),
+    /**
+     * A cancellation inside `hours` of the start. `refuse` turns a public
+     * one away; `flag` lets it through and sets `flag`. Staff are never refused.
+     */
+    cancel: z
+        .object({
+        hours: numberOrSetting,
+        mode: z.enum(['refuse', 'flag']),
+        flag: refSchema.optional(),
+        when: z.object({ column: refSchema, to: z.string().min(1) }).strict(),
+    })
+        .strict()
+        .refine((c) => (c.mode === 'flag') === (c.flag !== undefined), {
+        message: 'a flag names its column, and only mode "flag" has one',
+        path: ['flag'],
+    })
+        .optional(),
+})
+    .strict();
+/**
+ * Everything in a table's booking rule that names something the manifest does
+ * not declare, or a column of the wrong kind.
+ */
+export function bookingIssues(table, rule, index, at) {
+    const out = [];
+    const here = (...rest) => at('booking', ...rest);
+    /** The column, when it exists and is one of `types`; an issue otherwise. */
+    const want = (tableRef, column, types, path, what) => {
+        if (index.table(tableRef) === undefined) {
+            out.push({ path, message: `"${tableRef}" is not a table of this app` });
+            return undefined;
+        }
+        const found = index.column(tableRef, column);
+        if (found === undefined) {
+            out.push({ path, message: `"${tableRef}" has no column "${column}"` });
+            return undefined;
+        }
+        if (!types.includes(found.type)) {
+            out.push({ path, message: `"${tableRef}.${column}" must be ${what}` });
+            return undefined;
+        }
+        return found;
+    };
+    /** A foreign key pointing at `target` (any target when omitted). */
+    const wantFk = (tableRef, column, target, path) => {
+        const found = want(tableRef, column, ['fk'], path, 'a foreign key');
+        if (found !== undefined && target !== undefined && found.references !== target) {
+            out.push({ path, message: `"${tableRef}.${column}" does not point at "${target}"` });
+        }
+        return found;
+    };
+    const setting = (value, path) => {
+        const parsed = settingRefSchema.safeParse(value);
+        if (parsed.success)
+            want(parsed.data.table, parsed.data.column, NUMERIC_TYPES, path, 'a number');
+    };
+    want(table.ref, rule.start, ['timestamptz'], here('start'), 'a timestamptz');
+    want(table.ref, rule.minutes, ['int', 'bigint'], here('minutes'), 'an int');
+    const resource = wantFk(table.ref, rule.resource, undefined, here('resource'));
+    const kind = wantFk(table.ref, rule.kind, undefined, here('kind'));
+    const resourceTable = resource?.references;
+    const kindTable = kind?.references;
+    const counted = index.column(table.ref, rule.countWhere.column);
+    if (counted === undefined) {
+        out.push({ path: here('countWhere', 'column'), message: `"${table.ref}" has no column "${rule.countWhere.column}"` });
+    }
+    else {
+        for (const value of rule.countWhere.values) {
+            if (!valueFits(counted, value)) {
+                out.push({ path: here('countWhere', 'values'), message: `"${value}" is not a value of "${table.ref}.${counted.ref}"` });
+            }
+        }
+    }
+    const eligible = rule.eligible;
+    wantFk(eligible.table, eligible.resource, resourceTable, here('eligible', 'resource'));
+    wantFk(eligible.table, eligible.kind, kindTable, here('eligible', 'kind'));
+    if (eligible.order !== undefined) {
+        const order = eligible.order;
+        if (resourceTable !== undefined && order.table !== resourceTable) {
+            out.push({ path: here('eligible', 'order', 'table'), message: `the order is kept on "${resourceTable}", the table "${rule.resource}" points at` });
+        }
+        want(order.table, order.column, NUMERIC_TYPES, here('eligible', 'order', 'column'), 'a number');
+        for (const name of ['active', 'public']) {
+            const column = order[name];
+            if (column !== undefined)
+                want(order.table, column, ['bool'], here('eligible', 'order', name), 'a bool');
+        }
+    }
+    const weekday = (tableRef, column, path) => {
+        const found = want(tableRef, column, ['enum'], path, `an enum of ${BOOKING_WEEKDAYS.join(', ')}`);
+        if (found !== undefined && (found.enum ?? []).join(',') !== BOOKING_WEEKDAYS.join(',')) {
+            out.push({ path, message: `"${tableRef}.${column}" must be an enum of ${BOOKING_WEEKDAYS.join(', ')}` });
+        }
+    };
+    const times = (tableRef, hours, path) => {
+        for (const name of ['opens', 'closes', 'breakStart', 'breakEnd']) {
+            const column = hours[name];
+            if (column !== undefined)
+                want(tableRef, column, ['text'], [...path, name], 'a text column holding HH:MM');
+        }
+        if ((hours['breakStart'] === undefined) !== (hours['breakEnd'] === undefined)) {
+            out.push({ path, message: 'a break names both its start and its end' });
+        }
+    };
+    const practice = rule.hours.practice;
+    weekday(practice.table, practice.weekday, here('hours', 'practice', 'weekday'));
+    times(practice.table, practice, here('hours', 'practice'));
+    if (practice.open !== undefined)
+        want(practice.table, practice.open, ['bool'], here('hours', 'practice', 'open'), 'a bool');
+    const own = rule.hours.own;
+    if (own !== undefined) {
+        wantFk(own.table, own.resource, resourceTable, here('hours', 'own', 'resource'));
+        weekday(own.table, own.weekday, here('hours', 'own', 'weekday'));
+        times(own.table, own, here('hours', 'own'));
+    }
+    const closures = rule.closures;
+    if (closures !== undefined) {
+        want(closures.table, closures.from, ['date'], here('closures', 'from'), 'a date');
+        want(closures.table, closures.to, ['date'], here('closures', 'to'), 'a date');
+        if (closures.resource !== undefined) {
+            const column = wantFk(closures.table, closures.resource, resourceTable, here('closures', 'resource'));
+            if (column !== undefined && column.nullable !== true) {
+                out.push({ path: here('closures', 'resource'), message: `"${closures.table}.${closures.resource}" must be nullable: an empty one closes for everyone` });
+            }
+        }
+        if (closures.active !== undefined)
+            want(closures.table, closures.active, ['bool'], here('closures', 'active'), 'a bool');
+    }
+    setting(rule.grid, here('grid'));
+    if (typeof rule.grid === 'number' && rule.grid === 0)
+        out.push({ path: here('grid'), message: 'the grid is at least one minute' });
+    setting(rule.windowDays, here('windowDays'));
+    setting(rule.noticeMinutes, here('noticeMinutes'));
+    if (rule.cancel !== undefined) {
+        const cancel = rule.cancel;
+        setting(cancel.hours, here('cancel', 'hours'));
+        if (cancel.flag !== undefined)
+            want(table.ref, cancel.flag, ['bool'], here('cancel', 'flag'), 'a bool');
+        if (cancel.when.column !== rule.countWhere.column) {
+            out.push({ path: here('cancel', 'when', 'column'), message: `a cancellation is a change of "${rule.countWhere.column}", the column that decides what counts` });
+        }
+        else if (counted !== undefined) {
+            if (!valueFits(counted, cancel.when.to)) {
+                out.push({ path: here('cancel', 'when', 'to'), message: `"${cancel.when.to}" is not a value of "${table.ref}.${counted.ref}"` });
+            }
+            else if (rule.countWhere.values.includes(cancel.when.to)) {
+                out.push({ path: here('cancel', 'when', 'to'), message: `"${cancel.when.to}" still counts, so it frees no time` });
+            }
+        }
+    }
+    return out;
+}
+//# sourceMappingURL=booking.js.map

package/dist/booking.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"booking.js","sourceRoot":"","sources":["../src/booking.ts"],"names":[],"mappings":"AAAA,yCAAyC;AACzC;;;;;;;;;;;;;GAaG;AACH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EACL,aAAa,EACb,eAAe,EACf,SAAS,EACT,gBAAgB,EAChB,SAAS,GAKV,MAAM,WAAW,CAAC;AAEnB,iFAAiF;AACjF,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,CAAU,CAAC;AAE3F,MAAM,YAAY,GAAG;IACnB,OAAO,EAAE,SAAS;IAClB,KAAK,EAAE,SAAS;IAChB,MAAM,EAAE,SAAS;IACjB,UAAU,EAAE,SAAS,CAAC,QAAQ,EAAE;IAChC,QAAQ,EAAE,SAAS,CAAC,QAAQ,EAAE;CAC/B,CAAC;AAEF,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC;KAC3B,MAAM,CAAC;IACN,sEAAsE;IACtE,KAAK,EAAE,SAAS;IAChB,0EAA0E;IAC1E,OAAO,EAAE,SAAS;IAClB,6FAA6F;IAC7F,QAAQ,EAAE,SAAS;IACnB,yEAAyE;IACzE,IAAI,EAAE,SAAS;IACf,0FAA0F;IAC1F,UAAU,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE;IAC/F,kGAAkG;IAClG,QAAQ,EAAE,CAAC;SACR,MAAM,CAAC;QACN,KAAK,EAAE,SAAS;QAChB,QAAQ,EAAE,SAAS;QACnB,IAAI,EAAE,SAAS;QACf,KAAK,EAAE,CAAC;aACL,MAAM,CAAC;YACN,KAAK,EAAE,SAAS;YAChB,MAAM,EAAE,SAAS;YACjB,wDAAwD;YACxD,MAAM,EAAE,SAAS,CAAC,QAAQ,EAAE;YAC5B,+EAA+E;YAC/E,MAAM,EAAE,SAAS,CAAC,QAAQ,EAAE;SAC7B,CAAC;aACD,MAAM,EAAE;aACR,QAAQ,EAAE;KACd,CAAC;SACD,MAAM,EAAE;IACX;;;OAGG;IACH,KAAK,EAAE,CAAC;SACL,MAAM,CAAC;QACN,QAAQ,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,SAAS,CAAC,QAAQ,EAAE,EAAE,GAAG,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE;QAC9F,GAAG,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,SAAS,EAAE,GAAG,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;KAC9F,CAAC;SACD,MAAM,EAAE;IACX,qEAAqE;IACrE,QAAQ,EAAE,CAAC;SACR,MAAM,CAAC;QACN,KAAK,EAAE,SAAS;QAChB,IAAI,EAAE,SAAS;QACf,EAAE,EAAE,SAAS;QACb,QAAQ,EAAE,SAAS,CAAC,QAAQ,EAAE;QAC9B,MAAM,EAAE,SAAS,CAAC,QAAQ,EAAE;KAC7B,CAAC;SACD,MAAM,EAAE;SACR,QAAQ,EAAE;IACb,2CAA2C;IAC3C,IAAI,EAAE,eAAe;IACrB,yDAAyD;IACzD,UAAU,EAAE,eAAe,CAAC,QAAQ,EAAE;IACtC,0EAA0E;IAC1E,aAAa,EAAE,eAAe,CAAC,QAAQ,EAAE;IACzC;;;OAGG;IACH,MAAM,EAAE,CAAC;SACN,MAAM,CAAC;QACN,KAAK,EAAE,eAAe;QACtB,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;QAChC,IAAI,EAAE,SAAS,CAAC,QAAQ,EAAE;QAC1B,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE;KACtE,CAAC;SACD,MAAM,EAAE;SACR,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,KAAK,SAAS,CAAC,EAAE;QAC7D,OAAO,EAAE,uDAAuD;QAChE,IAAI,EAAE,CAAC,MAAM,CAAC;KACf,CAAC;SACD,QAAQ,EAAE;CACd,CAAC;KACD,MAAM,EAAE,CAAC;AAGZ;;;GAGG;AACH,MAAM,UAAU,aAAa,CAC3B,KAAiB,EACjB,IAAiB,EACjB,KAAiB,EACjB,EAAyD;IAEzD,MAAM,GAAG,GAAqB,EAAE,CAAC;IACjC,MAAM,IAAI,GAAG,CAAC,GAAG,IAAyB,EAAE,EAAE,CAAC,EAAE,CAAC,SAAS,EAAE,GAAG,IAAI,CAAC,CAAC;IAEtE,4EAA4E;IAC5E,MAAM,IAAI,GAAG,CACX,QAAgB,EAChB,MAAc,EACd,KAAwB,EACxB,IAAyB,EACzB,IAAY,EACa,EAAE;QAC3B,IAAI,KAAK,CAAC,KAAK,CAAC,QAAQ,CAAC,KAAK,SAAS,EAAE,CAAC;YACxC,GAAG,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,QAAQ,8BAA8B,EAAE,CAAC,CAAC;YACxE,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,MAAM,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;QAC7C,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,GAAG,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,QAAQ,oBAAoB,MAAM,GAAG,EAAE,CAAC,CAAC;YACvE,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;YAChC,GAAG,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,QAAQ,IAAI,MAAM,aAAa,IAAI,EAAE,EAAE,CAAC,CAAC;YACvE,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC,CAAC;IACF,oEAAoE;IACpE,MAAM,MAAM,GAAG,CAAC,QAAgB,EAAE,MAAc,EAAE,MAA0B,EAAE,IAAyB,EAAE,EAAE;QACzG,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,EAAE,MAAM,EAAE,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,eAAe,CAAC,CAAC;QACpE,IAAI,KAAK,KAAK,SAAS,IAAI,MAAM,KAAK,SAAS,IAAI,KAAK,CAAC,UAAU,KAAK,MAAM,EAAE,CAAC;YAC/E,GAAG,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,QAAQ,IAAI,MAAM,wBAAwB,MAAM,GAAG,EAAE,CAAC,CAAC;QACvF,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC,CAAC;IACF,MAAM,OAAO,GAAG,CAAC,KAAc,EAAE,IAAyB,EAAE,EAAE;QAC5D,MAAM,MAAM,GAAG,gBAAgB,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;QACjD,IAAI,MAAM,CAAC,OAAO;YAAE,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,aAAa,EAAE,IAAI,EAAE,UAAU,CAAC,CAAC;IACnG,CAAC,CAAC;IAEF,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE,IAAI,CAAC,KAAK,EAAE,CAAC,aAAa,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC,EAAE,eAAe,CAAC,CAAC;IAC7E,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,QAAQ,CAAC,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,QAAQ,CAAC,CAAC;IAC5E,MAAM,QAAQ,GAAG,MAAM,CAAC,KAAK,CAAC,GAAG,EAAE,IAAI,CAAC,QAAQ,EAAE,SAAS,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC;IAC/E,MAAM,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,EAAE,SAAS,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;IACnE,MAAM,aAAa,GAAG,QAAQ,EAAE,UAAU,CAAC;IAC3C,MAAM,SAAS,GAAG,IAAI,EAAE,UAAU,CAAC;IAEnC,MAAM,OAAO,GAAG,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,EAAE,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;IAChE,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;QAC1B,GAAG,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,YAAY,EAAE,QAAQ,CAAC,EAAE,OAAO,EAAE,IAAI,KAAK,CAAC,GAAG,oBAAoB,IAAI,CAAC,UAAU,CAAC,MAAM,GAAG,EAAE,CAAC,CAAC;IACxH,CAAC;SAAM,CAAC;QACN,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC;YAC3C,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,KAAK,CAAC,EAAE,CAAC;gBAC/B,GAAG,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,YAAY,EAAE,QAAQ,CAAC,EAAE,OAAO,EAAE,IAAI,KAAK,wBAAwB,KAAK,CAAC,GAAG,IAAI,OAAO,CAAC,GAAG,GAAG,EAAE,CAAC,CAAC;YAC1H,CAAC;QACH,CAAC;IACH,CAAC;IAED,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;IAC/B,MAAM,CAAC,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC,QAAQ,EAAE,aAAa,EAAE,IAAI,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC,CAAC;IACvF,MAAM,CAAC,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC,IAAI,EAAE,SAAS,EAAE,IAAI,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC,CAAC;IAC3E,IAAI,QAAQ,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;QACjC,MAAM,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC;QAC7B,IAAI,aAAa,KAAK,SAAS,IAAI,KAAK,CAAC,KAAK,KAAK,aAAa,EAAE,CAAC;YACjE,GAAG,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,UAAU,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,OAAO,EAAE,yBAAyB,aAAa,iBAAiB,IAAI,CAAC,QAAQ,aAAa,EAAE,CAAC,CAAC;QACrJ,CAAC;QACD,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,CAAC,MAAM,EAAE,aAAa,EAAE,IAAI,CAAC,UAAU,EAAE,OAAO,EAAE,QAAQ,CAAC,EAAE,UAAU,CAAC,CAAC;QAChG,KAAK,MAAM,IAAI,IAAI,CAAC,QAAQ,EAAE,QAAQ,CAAU,EAAE,CAAC;YACjD,MAAM,MAAM,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC;YAC3B,IAAI,MAAM,KAAK,SAAS;gBAAE,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,CAAC,MAAM,CAAC,EAAE,IAAI,CAAC,UAAU,EAAE,OAAO,EAAE,IAAI,CAAC,EAAE,QAAQ,CAAC,CAAC;QAC3G,CAAC;IACH,CAAC;IAED,MAAM,OAAO,GAAG,CAAC,QAAgB,EAAE,MAAc,EAAE,IAAyB,EAAE,EAAE;QAC9E,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,EAAE,MAAM,EAAE,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,cAAc,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAClG,IAAI,KAAK,KAAK,SAAS,IAAI,CAAC,KAAK,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,gBAAgB,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;YACvF,GAAG,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,QAAQ,IAAI,MAAM,wBAAwB,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC;QAC3G,CAAC;IACH,CAAC,CAAC;IACF,MAAM,KAAK,GAAG,CAAC,QAAgB,EAAE,KAAyC,EAAE,IAAyB,EAAE,EAAE;QACvG,KAAK,MAAM,IAAI,IAAI,CAAC,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,UAAU,CAAC,EAAE,CAAC;YACjE,MAAM,MAAM,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC;YAC3B,IAAI,MAAM,KAAK,SAAS;gBAAE,IAAI,CAAC,QAAQ,EAAE,MAAM,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,IAAI,CAAC,EAAE,6BAA6B,CAAC,CAAC;QAC7G,CAAC;QACD,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,KAAK,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,UAAU,CAAC,KAAK,SAAS,CAAC,EAAE,CAAC;YAC9E,GAAG,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,0CAA0C,EAAE,CAAC,CAAC;QAC1E,CAAC;IACH,CAAC,CAAC;IACF,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC;IACrC,OAAO,CAAC,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,UAAU,EAAE,SAAS,CAAC,CAAC,CAAC;IAChF,KAAK,CAAC,QAAQ,CAAC,KAAK,EAAE,QAAQ,EAAE,IAAI,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC,CAAC;IAC3D,IAAI,QAAQ,CAAC,IAAI,KAAK,SAAS;QAAE,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC,IAAI,EAAE,CAAC,MAAM,CAAC,EAAE,IAAI,CAAC,OAAO,EAAE,UAAU,EAAE,MAAM,CAAC,EAAE,QAAQ,CAAC,CAAC;IAC5H,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC;IAC3B,IAAI,GAAG,KAAK,SAAS,EAAE,CAAC;QACtB,MAAM,CAAC,GAAG,CAAC,KAAK,EAAE,GAAG,CAAC,QAAQ,EAAE,aAAa,EAAE,IAAI,CAAC,OAAO,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC;QACjF,OAAO,CAAC,GAAG,CAAC,KAAK,EAAE,GAAG,CAAC,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,KAAK,EAAE,SAAS,CAAC,CAAC,CAAC;QACjE,KAAK,CAAC,GAAG,CAAC,KAAK,EAAE,GAAG,EAAE,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC;IAC9C,CAAC;IAED,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;IAC/B,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;QAC3B,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC,IAAI,EAAE,CAAC,MAAM,CAAC,EAAE,IAAI,CAAC,UAAU,EAAE,MAAM,CAAC,EAAE,QAAQ,CAAC,CAAC;QAClF,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,EAAE,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,EAAE,QAAQ,CAAC,CAAC;QAC9E,IAAI,QAAQ,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;YACpC,MAAM,MAAM,GAAG,MAAM,CAAC,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC,QAAQ,EAAE,aAAa,EAAE,IAAI,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC,CAAC;YACtG,IAAI,MAAM,KAAK,SAAS,IAAI,MAAM,CAAC,QAAQ,KAAK,IAAI,EAAE,CAAC;gBACrD,GAAG,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,UAAU,EAAE,UAAU,CAAC,EAAE,OAAO,EAAE,IAAI,QAAQ,CAAC,KAAK,IAAI,QAAQ,CAAC,QAAQ,sDAAsD,EAAE,CAAC,CAAC;YAC3J,CAAC;QACH,CAAC;QACD,IAAI,QAAQ,CAAC,MAAM,KAAK,SAAS;YAAE,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC,MAAM,EAAE,CAAC,MAAM,CAAC,EAAE,IAAI,CAAC,UAAU,EAAE,QAAQ,CAAC,EAAE,QAAQ,CAAC,CAAC;IAC3H,CAAC;IAED,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;IACjC,IAAI,OAAO,IAAI,CAAC,IAAI,KAAK,QAAQ,IAAI,IAAI,CAAC,IAAI,KAAK,CAAC;QAAE,GAAG,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE,iCAAiC,EAAE,CAAC,CAAC;IACnI,OAAO,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC;IAC7C,OAAO,CAAC,IAAI,CAAC,aAAa,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC;IAEnD,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;QAC9B,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAC3B,OAAO,CAAC,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC;QAC/C,IAAI,MAAM,CAAC,IAAI,KAAK,SAAS;YAAE,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE,MAAM,CAAC,IAAI,EAAE,CAAC,MAAM,CAAC,EAAE,IAAI,CAAC,QAAQ,EAAE,MAAM,CAAC,EAAE,QAAQ,CAAC,CAAC;QACxG,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,KAAK,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC;YAClD,GAAG,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,OAAO,EAAE,kCAAkC,IAAI,CAAC,UAAU,CAAC,MAAM,wCAAwC,EAAE,CAAC,CAAC;QAClK,CAAC;aAAM,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;YACjC,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC;gBACxC,GAAG,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,OAAO,EAAE,IAAI,MAAM,CAAC,IAAI,CAAC,EAAE,wBAAwB,KAAK,CAAC,GAAG,IAAI,OAAO,CAAC,GAAG,GAAG,EAAE,CAAC,CAAC;YACnI,CAAC;iBAAM,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC;gBAC3D,GAAG,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,OAAO,EAAE,IAAI,MAAM,CAAC,IAAI,CAAC,EAAE,qCAAqC,EAAE,CAAC,CAAC;YACrH,CAAC;QACH,CAAC;IACH,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC"}

package/dist/documents.d.ts

@@ -0,0 +1,100 @@
+/**
+ * Document profiles an app ships: which of its columns make a printed
+ * document (an invoice, a receipt, a statement), drawn by an add-on that
+ * renders documents.
+ *
+ * ```json
+ * "documents": [{
+ *   "kind": "receipt", "addOn": "invoices", "table": "sales",
+ *   "name": { "en-US": "Till receipt" },
+ *   "mapping": {
+ *     "number": { "column": "number" },
+ *     "customerName": { "via": "customer_id", "column": "name" },
+ *     "lines": { "collection": { "table": "sale_lines", "via": "sale_id", "orderBy": "position",
+ *                                "columns": { "description": "name", "qty": "qty", "amount": "amount" } } }
+ *   }
+ * }]
+ * ```
+ *
+ * A slot reads a column of the row, a column of a row a foreign key points at
+ * (`via`), or a list of child rows in order. The slots themselves are the
+ * add-on's words; Adminium checks the columns here and the slots against the
+ * add-on when the profile is made at install. A profile is the app's: made
+ * with real table names when the app is installed, removed with it.
+ *
+ * A statement is a document over one row (a client) and a period: it lists
+ * the documents and payments that point at that row, so it names them
+ * instead of one child list.
+ */
+import { z } from 'zod';
+import { type ReferenceIssue, type TableIndex } from './refs.js';
+export declare const slotMappingSchema: z.ZodUnion<readonly [z.ZodObject<{
+    column: z.ZodString;
+}, z.core.$strict>, z.ZodObject<{
+    via: z.ZodString;
+    column: z.ZodString;
+}, z.core.$strict>, z.ZodObject<{
+    collection: z.ZodObject<{
+        table: z.ZodString;
+        via: z.ZodString;
+        orderBy: z.ZodOptional<z.ZodString>;
+        columns: z.ZodRecord<z.ZodString, z.ZodString>;
+    }, z.core.$strict>;
+}, z.core.$strict>]>;
+export type SlotMapping = z.infer<typeof slotMappingSchema>;
+export declare const appDocumentSchema: z.ZodObject<{
+    kind: z.ZodString;
+    addOn: z.ZodString;
+    table: z.ZodString;
+    name: z.ZodUnion<readonly [z.ZodString, z.ZodRecord<z.ZodString, z.ZodString>]>;
+    mapping: z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodObject<{
+        column: z.ZodString;
+    }, z.core.$strict>, z.ZodObject<{
+        via: z.ZodString;
+        column: z.ZodString;
+    }, z.core.$strict>, z.ZodObject<{
+        collection: z.ZodObject<{
+            table: z.ZodString;
+            via: z.ZodString;
+            orderBy: z.ZodOptional<z.ZodString>;
+            columns: z.ZodRecord<z.ZodString, z.ZodString>;
+        }, z.core.$strict>;
+    }, z.core.$strict>]>>;
+    statement: z.ZodOptional<z.ZodObject<{
+        documents: z.ZodObject<{
+            table: z.ZodString;
+            via: z.ZodString;
+            date: z.ZodString;
+            amount: z.ZodString;
+            number: z.ZodOptional<z.ZodString>;
+            where: z.ZodOptional<z.ZodObject<{
+                column: z.ZodString;
+                in: z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean]>>;
+            }, z.core.$strict>>;
+            unless: z.ZodOptional<z.ZodString>;
+        }, z.core.$strict>;
+        payments: z.ZodObject<{
+            table: z.ZodString;
+            via: z.ZodString;
+            date: z.ZodString;
+            amount: z.ZodString;
+            number: z.ZodOptional<z.ZodString>;
+            where: z.ZodOptional<z.ZodObject<{
+                column: z.ZodString;
+                in: z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean]>>;
+            }, z.core.$strict>>;
+            unless: z.ZodOptional<z.ZodString>;
+        }, z.core.$strict>;
+    }, z.core.$strict>>;
+    feature: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>;
+export type AppDocument = z.infer<typeof appDocumentSchema>;
+/** Every column a mapping names, against the manifest's tables. */
+export declare function mappingIssues(table: string, mapping: Readonly<Record<string, SlotMapping>>, index: TableIndex, at: (...rest: (string | number)[]) => (string | number)[]): ReferenceIssue[];
+/** Everything wrong with an app's `documents` against its tables and add-on needs. */
+export declare function appDocumentIssues(documents: readonly AppDocument[], ctx: {
+    index: TableIndex;
+    addOns: ReadonlySet<string>;
+    features: ReadonlySet<string>;
+}): ReferenceIssue[];
+//# sourceMappingURL=documents.d.ts.map

package/dist/documents.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"documents.d.ts","sourceRoot":"","sources":["../src/documents.ts"],"names":[],"mappings":"AACA;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAA2B,KAAK,cAAc,EAAE,KAAK,UAAU,EAAE,MAAM,WAAW,CAAC;AAI1F,eAAO,MAAM,iBAAiB;;;;;;;;;;;;oBAe5B,CAAC;AACH,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAiB5D,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBAWnB,CAAC;AACZ,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAE5D,mEAAmE;AACnE,wBAAgB,aAAa,CAC3B,KAAK,EAAE,MAAM,EACb,OAAO,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC,EAC9C,KAAK,EAAE,UAAU,EACjB,EAAE,EAAE,CAAC,GAAG,IAAI,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,GACxD,cAAc,EAAE,CA2BlB;AAED,sFAAsF;AACtF,wBAAgB,iBAAiB,CAC/B,SAAS,EAAE,SAAS,WAAW,EAAE,EACjC,GAAG,EAAE;IAAE,KAAK,EAAE,UAAU,CAAC;IAAC,MAAM,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC;IAAC,QAAQ,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;CAAE,GACrF,cAAc,EAAE,CAgClB"}