@adminiumjs/add-on-contracts 0.3.16 → 0.3.18-rc.0

package/dist/price-adjust.d.ts

@@ -0,0 +1,274 @@
+/**
+ * `price-adjust@1` — what an order's lines are reduced by.
+ *
+ * An add-on that keeps offers, discount codes and vouchers provides this
+ * contract once. Adminium calls `adjust(input)` with the order's lines, the
+ * codes typed on it (each already looked up), who is buying when that was
+ * proved, what staff took off by hand, and the offers it read; and writes
+ * what comes back itself — one reduction per line, the rows that say what was
+ * applied — inside the save.
+ *
+ * The provider reads nothing, writes nothing and keeps no clock: `now`,
+ * `today`, `weekday`, `time` and `zone` are inputs. The same input gives the
+ * same output. The call is synchronous.
+ */
+import { z } from 'zod';
+import type { PostingScalar, PostingUse } from './posting-rows.js';
+/** The most lines, typed codes and offers one question carries. */
+export declare const ADJUST_LINES_MAX = 200;
+export declare const ADJUST_CODES_MAX = 12;
+export declare const ADJUST_OFFERS_MAX = 500;
+/** `save` and `dry` price an order; `try` is staff's preview of an offer not yet saved; `refund` prices the lines kept. */
+export declare const ADJUST_MODES: readonly ["save", "dry", "try", "refund"];
+export type AdjustMode = (typeof ADJUST_MODES)[number];
+/** Why a typed code, or a reduction staff gave, is refused. Adminium decides what the public is told of each. */
+export declare const ADJUST_REASONS: readonly ["unknown", "used-up", "needs-minimum", "not-for-these-items", "needs-sign-in", "needs-customer", "over-ceiling", "expired", "inactive", "void", "not-yet", "over-limit"];
+export type AdjustReason = (typeof ADJUST_REASONS)[number];
+/** The reasons a guest is told by name; every other reason leaves as `unknown`. */
+export declare const ADJUST_PUBLIC_REASONS: readonly ["unknown", "used-up", "needs-minimum", "not-for-these-items", "needs-sign-in"];
+/** Why an offer did not apply, in staff's "why not" view. */
+export declare const ADJUST_EXPLAIN_REASONS: readonly ["unknown", "used-up", "needs-minimum", "not-for-these-items", "needs-sign-in", "needs-customer", "over-ceiling", "expired", "inactive", "void", "not-yet", "over-limit", "not-combinable", "outside-hours", "outside-days", "needs-quantity", "not-in-group", "not-first-order", "ended", "paused", "draft", "no-code-typed"];
+export type ExplainReason = (typeof ADJUST_EXPLAIN_REASONS)[number];
+export declare const ADJUST_KINDS: readonly ["offer", "code", "voucher", "pack", "staff"];
+export type AdjustKind = (typeof ADJUST_KINDS)[number];
+export interface AdjustLine {
+    /** The line's key as text; the order's own key for a line that is the order itself. */
+    key: string;
+    /** Which line part of the host's rule the line belongs to, and its place in it. */
+    part: number;
+    index: number;
+    /** Decimals as text, at `AdjustInput.scale`. `amount` is price × quantity. */
+    price: string;
+    quantity: string;
+    amount: string;
+    /** What the line sells, each as a table's stored name and a row's key. */
+    what: {
+        as: 'item' | 'category' | 'type' | 'tag';
+        table: string;
+        row: string;
+    }[];
+    /** No offer reduces it (a gift card being loaded). */
+    excluded: boolean;
+    /** The code that pays for the line, or null. */
+    paidBy: string | null;
+    /** False for a line being returned (mode `refund`). */
+    kept: boolean;
+    /** A stay's nights, each with its own price. */
+    nights?: {
+        date: string;
+        price: string;
+    }[];
+}
+export interface AdjustCode {
+    /** As the customer typed it. */
+    typed: string;
+    /** Which of the add-on's tables the row came from; null when no row was found. */
+    kind: 'code' | 'voucher' | null;
+    row: Record<string, PostingScalar | null> | null;
+}
+/** One use of an offer, a code or a voucher, recorded once where the order is posted. */
+export type AdjustUse = PostingUse;
+export interface AdjustInput {
+    contract: 'price-adjust@1';
+    mode: AdjustMode;
+    /** `line`: a line was written; `post`: the order reached its posting point, and uses are reported. */
+    point: 'line' | 'post';
+    origin: 'staff' | 'public' | 'system';
+    now: string;
+    today: string;
+    weekday: 0 | 1 | 2 | 3 | 4 | 5 | 6;
+    time: string;
+    zone: string;
+    currency: string | null;
+    /** The decimals of every amount. */
+    scale: number;
+    locale: string;
+    lines: AdjustLine[];
+    /** In the order typed. */
+    codes: AdjustCode[];
+    /** The buyer, when their identity was proved: a keyed hash, never an address. */
+    customer: {
+        key: string;
+        groups: string[];
+        orders: number;
+        uses: Record<string, number>;
+    } | null;
+    /** True when no identity was proved. */
+    guest: boolean;
+    /** What staff took off by hand, with the ceiling Adminium read for whoever gave it. */
+    staff: {
+        kind: 'percent' | 'amount' | 'comp';
+        value: string;
+        reason: string | null;
+        ceiling: {
+            percent: string;
+            amount: string;
+        } | null;
+        judge: boolean;
+    } | null;
+    /** The adjuster's declared reads, by name. */
+    offers: Record<string, Record<string, PostingScalar | null>[]>;
+    /** The add-on's settings row. */
+    settings: Record<string, PostingScalar | null>;
+    /** The rows the order's own open round holds, so its own held use is not counted against it. */
+    held?: Record<string, Record<string, PostingScalar | null>[]>;
+    /** Mode `try` only: an offer not saved yet, considered with the stored ones. */
+    draft?: Record<string, PostingScalar | null>;
+    /** Whether to say, for every offer, whether it applies and why not. */
+    explain: boolean;
+    /** The add-on's installed version. */
+    version: string;
+}
+export interface AdjustApplied {
+    /** The line it reduces. */
+    line: string;
+    offer: string | null;
+    code: string | null;
+    voucher: string | null;
+    /** What it is called: per locale, or one string. */
+    name: Record<string, string> | string;
+    kind: AdjustKind;
+    amount: string;
+    /** Whether the customer typed it. */
+    typed: boolean;
+    reason?: string;
+}
+export interface AdjustOutput {
+    /** One entry for every line of the input, and no other: its reduction, as text, zero or more. */
+    lines: {
+        key: string;
+        discount: string;
+    }[];
+    /** The sum of the lines'. */
+    order: {
+        discount: string;
+    };
+    applied: AdjustApplied[];
+    /** Point `post` only. */
+    uses: AdjustUse[];
+    refused: {
+        typed: string;
+        reason: AdjustReason;
+        params?: {
+            amount?: string;
+            max?: string;
+            name?: string;
+        };
+    }[];
+    /** Said beside a typed code that was not needed. */
+    told?: {
+        typed: string;
+        note: 'better-offer-applied';
+        name: string;
+    }[];
+    /** With `explain`: every offer handed in (or `draft`). */
+    explain?: {
+        offer: string;
+        applies: boolean;
+        reason?: ExplainReason;
+        amount?: string;
+    }[];
+}
+/** What an add-on's server file exports under `adjust`. Synchronous. */
+export interface PriceAdjustProvider {
+    adjust(input: AdjustInput): AdjustOutput;
+}
+export declare const adjustOutputSchema: z.ZodObject<{
+    lines: z.ZodArray<z.ZodObject<{
+        key: z.ZodString;
+        discount: z.ZodString;
+    }, z.core.$strict>>;
+    order: z.ZodObject<{
+        discount: z.ZodString;
+    }, z.core.$strict>;
+    applied: z.ZodArray<z.ZodObject<{
+        line: z.ZodString;
+        offer: z.ZodNullable<z.ZodString>;
+        code: z.ZodNullable<z.ZodString>;
+        voucher: z.ZodNullable<z.ZodString>;
+        name: z.ZodUnion<readonly [z.ZodString, z.ZodRecord<z.ZodString, z.ZodString>]>;
+        kind: z.ZodEnum<{
+            code: "code";
+            staff: "staff";
+            offer: "offer";
+            voucher: "voucher";
+            pack: "pack";
+        }>;
+        amount: z.ZodString;
+        typed: z.ZodBoolean;
+        reason: z.ZodOptional<z.ZodString>;
+    }, z.core.$strict>>;
+    uses: z.ZodArray<z.ZodObject<{
+        offer: z.ZodNullable<z.ZodString>;
+        code: z.ZodNullable<z.ZodString>;
+        voucher: z.ZodNullable<z.ZodString>;
+        amount: z.ZodString;
+        units: z.ZodOptional<z.ZodNumber>;
+        customer: z.ZodOptional<z.ZodString>;
+    }, z.core.$strict>>;
+    refused: z.ZodArray<z.ZodObject<{
+        typed: z.ZodString;
+        reason: z.ZodEnum<{
+            void: "void";
+            unknown: "unknown";
+            expired: "expired";
+            inactive: "inactive";
+            "used-up": "used-up";
+            "over-limit": "over-limit";
+            "needs-customer": "needs-customer";
+            "needs-minimum": "needs-minimum";
+            "not-for-these-items": "not-for-these-items";
+            "needs-sign-in": "needs-sign-in";
+            "over-ceiling": "over-ceiling";
+            "not-yet": "not-yet";
+        }>;
+        params: z.ZodOptional<z.ZodObject<{
+            amount: z.ZodOptional<z.ZodString>;
+            max: z.ZodOptional<z.ZodString>;
+            name: z.ZodOptional<z.ZodString>;
+        }, z.core.$strict>>;
+    }, z.core.$strict>>;
+    told: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        typed: z.ZodString;
+        note: z.ZodLiteral<"better-offer-applied">;
+        name: z.ZodString;
+    }, z.core.$strict>>>;
+    explain: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        offer: z.ZodString;
+        applies: z.ZodBoolean;
+        reason: z.ZodOptional<z.ZodEnum<{
+            void: "void";
+            unknown: "unknown";
+            expired: "expired";
+            inactive: "inactive";
+            "used-up": "used-up";
+            "over-limit": "over-limit";
+            "needs-customer": "needs-customer";
+            "needs-minimum": "needs-minimum";
+            "not-for-these-items": "not-for-these-items";
+            "needs-sign-in": "needs-sign-in";
+            "over-ceiling": "over-ceiling";
+            "not-yet": "not-yet";
+            "not-combinable": "not-combinable";
+            "outside-hours": "outside-hours";
+            "outside-days": "outside-days";
+            "needs-quantity": "needs-quantity";
+            "not-in-group": "not-in-group";
+            "not-first-order": "not-first-order";
+            ended: "ended";
+            paused: "paused";
+            draft: "draft";
+            "no-code-typed": "no-code-typed";
+        }>>;
+        amount: z.ZodOptional<z.ZodString>;
+    }, z.core.$strict>>>;
+}, z.core.$strict>;
+/**
+ * What is wrong with an answer for this input, beyond its shape: a line
+ * missing or invented, a reduction larger than its line or finer than the
+ * scale, an excluded line reduced, an order total that is not the lines'
+ * sum, uses reported where none are due, a reason a guest is never told.
+ * Adminium runs the same check before it writes.
+ */
+export declare function adjustAnswerIssues(input: AdjustInput, output: AdjustOutput): string[];
+//# sourceMappingURL=price-adjust.d.ts.map

package/dist/price-adjust.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"price-adjust.d.ts","sourceRoot":"","sources":["../src/price-adjust.ts"],"names":[],"mappings":"AACA;;;;;;;;;;;;;GAaG;AACH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,KAAK,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAEnE,mEAAmE;AACnE,eAAO,MAAM,gBAAgB,MAAM,CAAC;AACpC,eAAO,MAAM,gBAAgB,KAAK,CAAC;AACnC,eAAO,MAAM,iBAAiB,MAAM,CAAC;AAErC,2HAA2H;AAC3H,eAAO,MAAM,YAAY,2CAA4C,CAAC;AACtE,MAAM,MAAM,UAAU,GAAG,CAAC,OAAO,YAAY,CAAC,CAAC,MAAM,CAAC,CAAC;AAEvD,iHAAiH;AACjH,eAAO,MAAM,cAAc,oLAajB,CAAC;AACX,MAAM,MAAM,YAAY,GAAG,CAAC,OAAO,cAAc,CAAC,CAAC,MAAM,CAAC,CAAC;AAE3D,mFAAmF;AACnF,eAAO,MAAM,qBAAqB,0FAA2F,CAAC;AAE9H,6DAA6D;AAC7D,eAAO,MAAM,sBAAsB,yUAYzB,CAAC;AACX,MAAM,MAAM,aAAa,GAAG,CAAC,OAAO,sBAAsB,CAAC,CAAC,MAAM,CAAC,CAAC;AAEpE,eAAO,MAAM,YAAY,wDAAyD,CAAC;AACnF,MAAM,MAAM,UAAU,GAAG,CAAC,OAAO,YAAY,CAAC,CAAC,MAAM,CAAC,CAAC;AAEvD,MAAM,WAAW,UAAU;IACzB,uFAAuF;IACvF,GAAG,EAAE,MAAM,CAAC;IACZ,mFAAmF;IACnF,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,8EAA8E;IAC9E,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,0EAA0E;IAC1E,IAAI,EAAE;QAAE,EAAE,EAAE,MAAM,GAAG,UAAU,GAAG,MAAM,GAAG,KAAK,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;IACjF,sDAAsD;IACtD,QAAQ,EAAE,OAAO,CAAC;IAClB,gDAAgD;IAChD,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,uDAAuD;IACvD,IAAI,EAAE,OAAO,CAAC;IACd,gDAAgD;IAChD,MAAM,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;CAC5C;AAED,MAAM,WAAW,UAAU;IACzB,gCAAgC;IAChC,KAAK,EAAE,MAAM,CAAC;IACd,kFAAkF;IAClF,IAAI,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI,CAAC;IAChC,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;CAClD;AAED,yFAAyF;AACzF,MAAM,MAAM,SAAS,GAAG,UAAU,CAAC;AAEnC,MAAM,WAAW,WAAW;IAC1B,QAAQ,EAAE,gBAAgB,CAAC;IAC3B,IAAI,EAAE,UAAU,CAAC;IACjB,sGAAsG;IACtG,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC;IACvB,MAAM,EAAE,OAAO,GAAG,QAAQ,GAAG,QAAQ,CAAC;IACtC,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IACnC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,oCAAoC;IACpC,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,UAAU,EAAE,CAAC;IACpB,0BAA0B;IAC1B,KAAK,EAAE,UAAU,EAAE,CAAC;IACpB,iFAAiF;IACjF,QAAQ,EAAE;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,EAAE,CAAC;QAAC,MAAM,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;KAAE,GAAG,IAAI,CAAC;IACjG,wCAAwC;IACxC,KAAK,EAAE,OAAO,CAAC;IACf,uFAAuF;IACvF,KAAK,EAAE;QAAE,IAAI,EAAE,SAAS,GAAG,QAAQ,GAAG,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;QAAC,OAAO,EAAE;YAAE,OAAO,EAAE,MAAM,CAAC;YAAC,MAAM,EAAE,MAAM,CAAA;SAAE,GAAG,IAAI,CAAC;QAAC,KAAK,EAAE,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IACjK,8CAA8C;IAC9C,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,GAAG,IAAI,CAAC,EAAE,CAAC,CAAC;IAC/D,iCAAiC;IACjC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,GAAG,IAAI,CAAC,CAAC;IAC/C,gGAAgG;IAChG,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,GAAG,IAAI,CAAC,EAAE,CAAC,CAAC;IAC9D,gFAAgF;IAChF,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,GAAG,IAAI,CAAC,CAAC;IAC7C,uEAAuE;IACvE,OAAO,EAAE,OAAO,CAAC;IACjB,sCAAsC;IACtC,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,aAAa;IAC5B,2BAA2B;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,oDAAoD;IACpD,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,MAAM,CAAC;IACtC,IAAI,EAAE,UAAU,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,qCAAqC;IACrC,KAAK,EAAE,OAAO,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,YAAY;IAC3B,iGAAiG;IACjG,KAAK,EAAE;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;IAC3C,6BAA6B;IAC7B,KAAK,EAAE;QAAE,QAAQ,EAAE,MAAM,CAAA;KAAE,CAAC;IAC5B,OAAO,EAAE,aAAa,EAAE,CAAC;IACzB,yBAAyB;IACzB,IAAI,EAAE,SAAS,EAAE,CAAC;IAClB,OAAO,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,YAAY,CAAC;QAAC,MAAM,CAAC,EAAE;YAAE,MAAM,CAAC,EAAE,MAAM,CAAC;YAAC,GAAG,CAAC,EAAE,MAAM,CAAC;YAAC,IAAI,CAAC,EAAE,MAAM,CAAA;SAAE,CAAA;KAAE,EAAE,CAAC;IAC9G,oDAAoD;IACpD,IAAI,CAAC,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,sBAAsB,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;IACvE,0DAA0D;IAC1D,OAAO,CAAC,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,OAAO,CAAC;QAAC,MAAM,CAAC,EAAE,aAAa,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;CAC1F;AAED,wEAAwE;AACxE,MAAM,WAAW,mBAAmB;IAClC,MAAM,CAAC,KAAK,EAAE,WAAW,GAAG,YAAY,CAAC;CAC1C;AAOD,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBA4BpB,CAAC;AAQZ;;;;;;GAMG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,WAAW,EAAE,MAAM,EAAE,YAAY,GAAG,MAAM,EAAE,CAiCrF"}

package/dist/price-adjust.js

@@ -0,0 +1,145 @@
+// SPDX-License-Identifier: AGPL-3.0-only
+/**
+ * `price-adjust@1` — what an order's lines are reduced by.
+ *
+ * An add-on that keeps offers, discount codes and vouchers provides this
+ * contract once. Adminium calls `adjust(input)` with the order's lines, the
+ * codes typed on it (each already looked up), who is buying when that was
+ * proved, what staff took off by hand, and the offers it read; and writes
+ * what comes back itself — one reduction per line, the rows that say what was
+ * applied — inside the save.
+ *
+ * The provider reads nothing, writes nothing and keeps no clock: `now`,
+ * `today`, `weekday`, `time` and `zone` are inputs. The same input gives the
+ * same output. The call is synchronous.
+ */
+import { z } from 'zod';
+/** The most lines, typed codes and offers one question carries. */
+export const ADJUST_LINES_MAX = 200;
+export const ADJUST_CODES_MAX = 12;
+export const ADJUST_OFFERS_MAX = 500;
+/** `save` and `dry` price an order; `try` is staff's preview of an offer not yet saved; `refund` prices the lines kept. */
+export const ADJUST_MODES = ['save', 'dry', 'try', 'refund'];
+/** Why a typed code, or a reduction staff gave, is refused. Adminium decides what the public is told of each. */
+export const ADJUST_REASONS = [
+    'unknown',
+    'used-up',
+    'needs-minimum',
+    'not-for-these-items',
+    'needs-sign-in',
+    'needs-customer',
+    'over-ceiling',
+    'expired',
+    'inactive',
+    'void',
+    'not-yet',
+    'over-limit',
+];
+/** The reasons a guest is told by name; every other reason leaves as `unknown`. */
+export const ADJUST_PUBLIC_REASONS = ['unknown', 'used-up', 'needs-minimum', 'not-for-these-items', 'needs-sign-in'];
+/** Why an offer did not apply, in staff's "why not" view. */
+export const ADJUST_EXPLAIN_REASONS = [
+    ...ADJUST_REASONS,
+    'not-combinable',
+    'outside-hours',
+    'outside-days',
+    'needs-quantity',
+    'not-in-group',
+    'not-first-order',
+    'ended',
+    'paused',
+    'draft',
+    'no-code-typed',
+];
+export const ADJUST_KINDS = ['offer', 'code', 'voucher', 'pack', 'staff'];
+// ── the shape Adminium checks before it reads an answer ──────────────────────
+const amount = z.string().regex(/^\d+(\.\d+)?$/, 'an amount as text, zero or more');
+const id = z.string().min(1).max(64);
+export const adjustOutputSchema = z
+    .object({
+    lines: z.array(z.object({ key: z.string().max(64), discount: amount }).strict()).max(ADJUST_LINES_MAX),
+    order: z.object({ discount: amount }).strict(),
+    applied: z
+        .array(z
+        .object({
+        line: z.string().max(64),
+        offer: id.nullable(),
+        code: id.nullable(),
+        voucher: id.nullable(),
+        name: z.union([z.string().max(200), z.record(z.string(), z.string().max(200))]),
+        kind: z.enum(ADJUST_KINDS),
+        amount,
+        typed: z.boolean(),
+        reason: z.string().max(200).optional(),
+    })
+        .strict())
+        .max(ADJUST_LINES_MAX * 4),
+    uses: z.array(z.object({ offer: id.nullable(), code: id.nullable(), voucher: id.nullable(), amount, units: z.number().int().min(0).optional(), customer: z.string().max(64).optional() }).strict()).max(ADJUST_OFFERS_MAX),
+    refused: z
+        .array(z.object({ typed: z.string().max(64), reason: z.enum(ADJUST_REASONS), params: z.object({ amount: amount.optional(), max: amount.optional(), name: z.string().max(200).optional() }).strict().optional() }).strict())
+        .max(ADJUST_CODES_MAX + 1),
+    told: z.array(z.object({ typed: z.string().max(64), note: z.literal('better-offer-applied'), name: z.string().max(200) }).strict()).max(ADJUST_CODES_MAX).optional(),
+    explain: z.array(z.object({ offer: id, applies: z.boolean(), reason: z.enum(ADJUST_EXPLAIN_REASONS).optional(), amount: amount.optional() }).strict()).max(ADJUST_OFFERS_MAX + 1).optional(),
+})
+    .strict();
+/** An amount as a whole number of the smallest unit at `scale`, so sums are exact. */
+function units(text, scale) {
+    const [whole = '0', fraction = ''] = text.split('.');
+    return BigInt(whole) * 10n ** BigInt(scale) + BigInt((fraction + '0'.repeat(scale)).slice(0, scale) || '0');
+}
+/**
+ * What is wrong with an answer for this input, beyond its shape: a line
+ * missing or invented, a reduction larger than its line or finer than the
+ * scale, an excluded line reduced, an order total that is not the lines'
+ * sum, uses reported where none are due, a reason a guest is never told.
+ * Adminium runs the same check before it writes.
+ */
+export function adjustAnswerIssues(input, output) {
+    const out = [];
+    const wanted = new Map(input.lines.map((line) => [line.key, line]));
+    const seen = new Set();
+    let sum = 0n;
+    for (const [i, line] of output.lines.entries()) {
+        const asked = wanted.get(line.key);
+        if (asked === undefined) {
+            out.push(`lines.${String(i)}: "${line.key}" is not a line of the question`);
+            continue;
+        }
+        if (seen.has(line.key))
+            out.push(`lines.${String(i)}: "${line.key}" is answered twice`);
+        seen.add(line.key);
+        if ((line.discount.split('.')[1] ?? '').length > input.scale)
+            out.push(`lines.${String(i)}: "${line.discount}" is finer than the order's ${String(input.scale)} decimals`);
+        const reduction = units(line.discount, input.scale);
+        if (reduction > units(asked.amount, input.scale))
+            out.push(`lines.${String(i)}: a reduction of ${line.discount} is more than the line's ${asked.amount}`);
+        if (asked.excluded && reduction !== 0n)
+            out.push(`lines.${String(i)}: "${line.key}" is excluded, so nothing reduces it`);
+        sum += reduction;
+    }
+    for (const key of wanted.keys())
+        if (!seen.has(key))
+            out.push(`lines: the line "${key}" has no answer`);
+    if (units(output.order.discount, input.scale) !== sum)
+        out.push(`order.discount: ${output.order.discount} is not the sum of the lines' reductions`);
+    if (input.point !== 'post' && output.uses.length > 0)
+        out.push('uses: uses are reported only where the order is posted');
+    for (const [i, applied] of output.applied.entries()) {
+        if (!wanted.has(applied.line))
+            out.push(`applied.${String(i)}: "${applied.line}" is not a line of the question`);
+        if (applied.kind === 'staff' && input.staff === null)
+            out.push(`applied.${String(i)}: staff took nothing off this order`);
+    }
+    for (const [i, refused] of output.refused.entries()) {
+        if (refused.reason === 'over-ceiling' && input.staff === null)
+            out.push(`refused.${String(i)}: "over-ceiling" is said of a reduction staff gave, and there is none`);
+        if (refused.reason === 'needs-sign-in' && !input.guest)
+            out.push(`refused.${String(i)}: "needs-sign-in" is said to a guest, and this customer is known`);
+        if (refused.reason === 'needs-customer' && input.origin !== 'staff')
+            out.push(`refused.${String(i)}: "needs-customer" is said to staff`);
+    }
+    if (input.explain && output.explain === undefined)
+        out.push('explain: the question asked why each offer applies or not');
+    return out;
+}
+//# sourceMappingURL=price-adjust.js.map

package/dist/price-adjust.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"price-adjust.js","sourceRoot":"","sources":["../src/price-adjust.ts"],"names":[],"mappings":"AAAA,yCAAyC;AACzC;;;;;;;;;;;;;GAaG;AACH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAIxB,mEAAmE;AACnE,MAAM,CAAC,MAAM,gBAAgB,GAAG,GAAG,CAAC;AACpC,MAAM,CAAC,MAAM,gBAAgB,GAAG,EAAE,CAAC;AACnC,MAAM,CAAC,MAAM,iBAAiB,GAAG,GAAG,CAAC;AAErC,2HAA2H;AAC3H,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,QAAQ,CAAU,CAAC;AAGtE,iHAAiH;AACjH,MAAM,CAAC,MAAM,cAAc,GAAG;IAC5B,SAAS;IACT,SAAS;IACT,eAAe;IACf,qBAAqB;IACrB,eAAe;IACf,gBAAgB;IAChB,cAAc;IACd,SAAS;IACT,UAAU;IACV,MAAM;IACN,SAAS;IACT,YAAY;CACJ,CAAC;AAGX,mFAAmF;AACnF,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,SAAS,EAAE,SAAS,EAAE,eAAe,EAAE,qBAAqB,EAAE,eAAe,CAAU,CAAC;AAE9H,6DAA6D;AAC7D,MAAM,CAAC,MAAM,sBAAsB,GAAG;IACpC,GAAG,cAAc;IACjB,gBAAgB;IAChB,eAAe;IACf,cAAc;IACd,gBAAgB;IAChB,cAAc;IACd,iBAAiB;IACjB,OAAO;IACP,QAAQ;IACR,OAAO;IACP,eAAe;CACP,CAAC;AAGX,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,CAAU,CAAC;AA6GnF,gFAAgF;AAEhF,MAAM,MAAM,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,eAAe,EAAE,iCAAiC,CAAC,CAAC;AACpF,MAAM,EAAE,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;AAErC,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC;KAChC,MAAM,CAAC;IACN,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,GAAG,CAAC,gBAAgB,CAAC;IACtG,KAAK,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE;IAC9C,OAAO,EAAE,CAAC;SACP,KAAK,CACJ,CAAC;SACE,MAAM,CAAC;QACN,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC;QACxB,KAAK,EAAE,EAAE,CAAC,QAAQ,EAAE;QACpB,IAAI,EAAE,EAAE,CAAC,QAAQ,EAAE;QACnB,OAAO,EAAE,EAAE,CAAC,QAAQ,EAAE;QACtB,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QAC/E,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC;QAC1B,MAAM;QACN,KAAK,EAAE,CAAC,CAAC,OAAO,EAAE;QAClB,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE;KACvC,CAAC;SACD,MAAM,EAAE,CACZ;SACA,GAAG,CAAC,gBAAgB,GAAG,CAAC,CAAC;IAC5B,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,EAAE,CAAC,QAAQ,EAAE,EAAE,IAAI,EAAE,EAAE,CAAC,QAAQ,EAAE,EAAE,OAAO,EAAE,EAAE,CAAC,QAAQ,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,GAAG,CAAC,iBAAiB,CAAC;IAC1N,OAAO,EAAE,CAAC;SACP,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,QAAQ,EAAE,EAAE,GAAG,EAAE,MAAM,CAAC,QAAQ,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC;SAC1N,GAAG,CAAC,gBAAgB,GAAG,CAAC,CAAC;IAC5B,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,sBAAsB,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC,QAAQ,EAAE;IACpK,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,sBAAsB,CAAC,CAAC,QAAQ,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,GAAG,CAAC,iBAAiB,GAAG,CAAC,CAAC,CAAC,QAAQ,EAAE;CAC7L,CAAC;KACD,MAAM,EAAE,CAAC;AAEZ,sFAAsF;AACtF,SAAS,KAAK,CAAC,IAAY,EAAE,KAAa;IACxC,MAAM,CAAC,KAAK,GAAG,GAAG,EAAE,QAAQ,GAAG,EAAE,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACrD,OAAO,MAAM,CAAC,KAAK,CAAC,GAAG,GAAG,IAAI,MAAM,CAAC,KAAK,CAAC,GAAG,MAAM,CAAC,CAAC,QAAQ,GAAG,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,IAAI,GAAG,CAAC,CAAC;AAC9G,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,kBAAkB,CAAC,KAAkB,EAAE,MAAoB;IACzE,MAAM,GAAG,GAAa,EAAE,CAAC;IACzB,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;IACpE,MAAM,IAAI,GAAG,IAAI,GAAG,EAAU,CAAC;IAC/B,IAAI,GAAG,GAAG,EAAE,CAAC;IACb,KAAK,MAAM,CAAC,CAAC,EAAE,IAAI,CAAC,IAAI,MAAM,CAAC,KAAK,CAAC,OAAO,EAAE,EAAE,CAAC;QAC/C,MAAM,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACnC,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,GAAG,CAAC,IAAI,CAAC,SAAS,MAAM,CAAC,CAAC,CAAC,MAAM,IAAI,CAAC,GAAG,iCAAiC,CAAC,CAAC;YAC5E,SAAS;QACX,CAAC;QACD,IAAI,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC;YAAE,GAAG,CAAC,IAAI,CAAC,SAAS,MAAM,CAAC,CAAC,CAAC,MAAM,IAAI,CAAC,GAAG,qBAAqB,CAAC,CAAC;QACxF,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACnB,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,MAAM,GAAG,KAAK,CAAC,KAAK;YAAE,GAAG,CAAC,IAAI,CAAC,SAAS,MAAM,CAAC,CAAC,CAAC,MAAM,IAAI,CAAC,QAAQ,+BAA+B,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;QAC3K,MAAM,SAAS,GAAG,KAAK,CAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC;QACpD,IAAI,SAAS,GAAG,KAAK,CAAC,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,KAAK,CAAC;YAAE,GAAG,CAAC,IAAI,CAAC,SAAS,MAAM,CAAC,CAAC,CAAC,oBAAoB,IAAI,CAAC,QAAQ,4BAA4B,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC;QAC1J,IAAI,KAAK,CAAC,QAAQ,IAAI,SAAS,KAAK,EAAE;YAAE,GAAG,CAAC,IAAI,CAAC,SAAS,MAAM,CAAC,CAAC,CAAC,MAAM,IAAI,CAAC,GAAG,sCAAsC,CAAC,CAAC;QACzH,GAAG,IAAI,SAAS,CAAC;IACnB,CAAC;IACD,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,EAAE;QAAE,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC;YAAE,GAAG,CAAC,IAAI,CAAC,oBAAoB,GAAG,iBAAiB,CAAC,CAAC;IACxG,IAAI,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,EAAE,KAAK,CAAC,KAAK,CAAC,KAAK,GAAG;QAAE,GAAG,CAAC,IAAI,CAAC,mBAAmB,MAAM,CAAC,KAAK,CAAC,QAAQ,0CAA0C,CAAC,CAAC;IACpJ,IAAI,KAAK,CAAC,KAAK,KAAK,MAAM,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC;QAAE,GAAG,CAAC,IAAI,CAAC,wDAAwD,CAAC,CAAC;IACzH,KAAK,MAAM,CAAC,CAAC,EAAE,OAAO,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC;QACpD,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC;YAAE,GAAG,CAAC,IAAI,CAAC,WAAW,MAAM,CAAC,CAAC,CAAC,MAAM,OAAO,CAAC,IAAI,iCAAiC,CAAC,CAAC;QACjH,IAAI,OAAO,CAAC,IAAI,KAAK,OAAO,IAAI,KAAK,CAAC,KAAK,KAAK,IAAI;YAAE,GAAG,CAAC,IAAI,CAAC,WAAW,MAAM,CAAC,CAAC,CAAC,qCAAqC,CAAC,CAAC;IAC5H,CAAC;IACD,KAAK,MAAM,CAAC,CAAC,EAAE,OAAO,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC;QACpD,IAAI,OAAO,CAAC,MAAM,KAAK,cAAc,IAAI,KAAK,CAAC,KAAK,KAAK,IAAI;YAAE,GAAG,CAAC,IAAI,CAAC,WAAW,MAAM,CAAC,CAAC,CAAC,uEAAuE,CAAC,CAAC;QACrK,IAAI,OAAO,CAAC,MAAM,KAAK,eAAe,IAAI,CAAC,KAAK,CAAC,KAAK;YAAE,GAAG,CAAC,IAAI,CAAC,WAAW,MAAM,CAAC,CAAC,CAAC,kEAAkE,CAAC,CAAC;QACzJ,IAAI,OAAO,CAAC,MAAM,KAAK,gBAAgB,IAAI,KAAK,CAAC,MAAM,KAAK,OAAO;YAAE,GAAG,CAAC,IAAI,CAAC,WAAW,MAAM,CAAC,CAAC,CAAC,qCAAqC,CAAC,CAAC;IAC3I,CAAC;IACD,IAAI,KAAK,CAAC,OAAO,IAAI,MAAM,CAAC,OAAO,KAAK,SAAS;QAAE,GAAG,CAAC,IAAI,CAAC,2DAA2D,CAAC,CAAC;IACzH,OAAO,GAAG,CAAC;AACb,CAAC"}

package/dist/record-tabs.d.ts

@@ -0,0 +1,141 @@
+/**
+ * A RECORD TAB — an add-on's rows shown on another table's record page.
+ *
+ * An add-on keeps rows that belong to rows of tables it does not own: the
+ * stock links of a menu item, the cards used on an order. It finds them by a
+ * pair it stores on each row — a table's stored name and a row's key — and a
+ * record tab is how those rows appear where their owner is looked at: a tab
+ * on that record's page, listing the add-on's rows for it.
+ *
+ * The tab is declared, not coded: which of the add-on's tables, which two
+ * columns hold the pair, which columns to show and which may be edited there.
+ * Adminium draws it with the page's own parts and the reader's own grants.
+ *
+ * This file is the shape, and the checks an add-on's manifest can make of it
+ * by itself.
+ */
+import { z } from 'zod';
+/** The most tabs one add-on declares, and the most columns one tab shows. */
+export declare const RECORD_TABS_MAX = 6;
+export declare const RECORD_TAB_COLUMNS_MAX = 8;
+export declare const recordTabSchema: z.ZodObject<{
+    id: z.ZodString;
+    label: z.ZodObject<{
+        key: z.ZodString;
+        fallback: z.ZodString;
+    }, z.core.$strict>;
+    labels: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+    table: z.ZodString;
+    match: z.ZodObject<{
+        table: z.ZodString;
+        row: z.ZodString;
+    }, z.core.$strict>;
+    on: z.ZodUnion<readonly [z.ZodLiteral<"linked">, z.ZodArray<z.ZodString>]>;
+    columns: z.ZodArray<z.ZodString>;
+    edit: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    add: z.ZodOptional<z.ZodObject<{
+        pick: z.ZodUnion<readonly [z.ZodObject<{
+            table: z.ZodString;
+            label: z.ZodString;
+        }, z.core.$strict>, z.ZodArray<z.ZodObject<{
+            table: z.ZodString;
+            label: z.ZodString;
+        }, z.core.$strict>>]>;
+    }, z.core.$strict>>;
+    remove: z.ZodOptional<z.ZodLiteral<true>>;
+    form: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    empty: z.ZodOptional<z.ZodObject<{
+        key: z.ZodString;
+        fallback: z.ZodString;
+    }, z.core.$strict>>;
+    empties: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+    summary: z.ZodOptional<z.ZodObject<{
+        words: z.ZodString;
+    }, z.core.$strict>>;
+    actions: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        label: z.ZodObject<{
+            key: z.ZodString;
+            fallback: z.ZodString;
+        }, z.core.$strict>;
+        labels: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+        child: z.ZodObject<{
+            table: z.ZodString;
+            form: z.ZodArray<z.ZodString>;
+        }, z.core.$strict>;
+    }, z.core.$strict>>>;
+}, z.core.$strict>;
+export type RecordTab = z.infer<typeof recordTabSchema>;
+export declare const recordTabsSchema: z.ZodArray<z.ZodObject<{
+    id: z.ZodString;
+    label: z.ZodObject<{
+        key: z.ZodString;
+        fallback: z.ZodString;
+    }, z.core.$strict>;
+    labels: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+    table: z.ZodString;
+    match: z.ZodObject<{
+        table: z.ZodString;
+        row: z.ZodString;
+    }, z.core.$strict>;
+    on: z.ZodUnion<readonly [z.ZodLiteral<"linked">, z.ZodArray<z.ZodString>]>;
+    columns: z.ZodArray<z.ZodString>;
+    edit: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    add: z.ZodOptional<z.ZodObject<{
+        pick: z.ZodUnion<readonly [z.ZodObject<{
+            table: z.ZodString;
+            label: z.ZodString;
+        }, z.core.$strict>, z.ZodArray<z.ZodObject<{
+            table: z.ZodString;
+            label: z.ZodString;
+        }, z.core.$strict>>]>;
+    }, z.core.$strict>>;
+    remove: z.ZodOptional<z.ZodLiteral<true>>;
+    form: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    empty: z.ZodOptional<z.ZodObject<{
+        key: z.ZodString;
+        fallback: z.ZodString;
+    }, z.core.$strict>>;
+    empties: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+    summary: z.ZodOptional<z.ZodObject<{
+        words: z.ZodString;
+    }, z.core.$strict>>;
+    actions: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        label: z.ZodObject<{
+            key: z.ZodString;
+            fallback: z.ZodString;
+        }, z.core.$strict>;
+        labels: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+        child: z.ZodObject<{
+            table: z.ZodString;
+            form: z.ZodArray<z.ZodString>;
+        }, z.core.$strict>;
+    }, z.core.$strict>>>;
+}, z.core.$strict>>;
+/** What the checks read of one of the add-on's tables. */
+export interface RecordTabTable {
+    ref: string;
+    columns: readonly {
+        ref: string;
+        type: string;
+        role?: string | undefined;
+        references?: string | undefined;
+        rules?: Readonly<Record<string, unknown>> | undefined;
+    }[];
+}
+/**
+ * Everything wrong with an add-on's record tabs that its own manifest can
+ * see: a table or a column that is not its own, a pair that is not a stored
+ * table name and a row's key, a column edited that Adminium decides, a picker
+ * the table does not link to, a summary that names no words.
+ */
+export declare function recordTabIssues(m: {
+    tabs: readonly RecordTab[];
+    tables: readonly RecordTabTable[];
+    words: readonly string[];
+}): {
+    path: (string | number)[];
+    message: string;
+}[];
+//# sourceMappingURL=record-tabs.d.ts.map

package/dist/record-tabs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"record-tabs.d.ts","sourceRoot":"","sources":["../src/record-tabs.ts"],"names":[],"mappings":"AACA;;;;;;;;;;;;;;;GAeG;AACH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAOxB,6EAA6E;AAC7E,eAAO,MAAM,eAAe,IAAI,CAAC;AACjC,eAAO,MAAM,sBAAsB,IAAI,CAAC;AAQxC,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBA8BjB,CAAC;AACZ,MAAM,MAAM,SAAS,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,eAAe,CAAC,CAAC;AAExD,eAAO,MAAM,gBAAgB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;mBAI2F,CAAC;AAEzH,0DAA0D;AAC1D,MAAM,WAAW,cAAc;IAC7B,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,EAAE,SAAS;QAChB,GAAG,EAAE,MAAM,CAAC;QACZ,IAAI,EAAE,MAAM,CAAC;QACb,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;QAC1B,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;QAChC,KAAK,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC;KACvD,EAAE,CAAC;CACL;AAKD;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,CAAC,EAAE;IAAE,IAAI,EAAE,SAAS,SAAS,EAAE,CAAC;IAAC,MAAM,EAAE,SAAS,cAAc,EAAE,CAAC;IAAC,KAAK,EAAE,SAAS,MAAM,EAAE,CAAA;CAAE,GAAG;IAAE,IAAI,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,EAAE,CAiFhL"}