@adminiumjs/manifest 0.3.16 → 0.3.18-rc.0

package/dist/adjust.d.ts

@@ -0,0 +1,322 @@
+/**
+ * THE PRICE QUESTION.
+ *
+ * An order's price may be lowered by an add-on that keeps offers, discount
+ * codes and vouchers. The host says where the question is asked and where
+ * the answer goes — `adjust`, on the order's table: which rows are its lines,
+ * which columns hold a line's price, quantity and discount, who the customer
+ * is, which codes were typed. The add-on says what it reads to answer —
+ * `addOn.adjuster`: its offers, its codes, the rows it keeps of what was
+ * applied.
+ *
+ * Adminium asks, checks the answer and writes it: every discount column is
+ * Adminium's own, and no browser ever sets one.
+ *
+ * This file holds the words and what one manifest can check of them. Pure,
+ * and nothing imported from the manifest's own schema file.
+ */
+import { z } from 'zod';
+import { type Posting } from './ledgers.js';
+import { type ReferenceIssue } from './refs.js';
+/** The most line parts one price rule reads. */
+export declare const ADJUST_PARTS_MAX = 3;
+export declare const adjustPartSchema: z.ZodUnion<readonly [z.ZodObject<{
+    table: z.ZodString;
+    via: z.ZodString;
+    price: z.ZodString;
+    quantity: z.ZodOptional<z.ZodString>;
+    discount: z.ZodString;
+    what: z.ZodArray<z.ZodObject<{
+        column: z.ZodString;
+        as: z.ZodEnum<{
+            type: "type";
+            item: "item";
+            category: "category";
+            tag: "tag";
+        }>;
+    }, z.core.$strict>>;
+    excludes: z.ZodOptional<z.ZodObject<{
+        column: z.ZodString;
+        set: z.ZodLiteral<true>;
+    }, z.core.$strict>>;
+    paidBy: z.ZodOptional<z.ZodObject<{
+        column: z.ZodString;
+    }, z.core.$strict>>;
+    only: z.ZodOptional<z.ZodUnion<readonly [z.ZodObject<{
+        column: z.ZodString;
+        eq: z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean]>;
+    }, z.core.$strict>, z.ZodObject<{
+        column: z.ZodString;
+        in: z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean]>>;
+    }, z.core.$strict>]>>;
+    unlessSet: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>, z.ZodObject<{
+    self: z.ZodLiteral<true>;
+    price: z.ZodString;
+    quantity: z.ZodOptional<z.ZodString>;
+    discount: z.ZodString;
+    what: z.ZodArray<z.ZodObject<{
+        column: z.ZodString;
+        as: z.ZodEnum<{
+            type: "type";
+            item: "item";
+            category: "category";
+            tag: "tag";
+        }>;
+    }, z.core.$strict>>;
+    nights: z.ZodOptional<z.ZodObject<{
+        from: z.ZodString;
+        to: z.ZodString;
+        rate: z.ZodString;
+    }, z.core.$strict>>;
+}, z.core.$strict>]>;
+export type AdjustPart = z.infer<typeof adjustPartSchema>;
+export declare const adjustSchema: z.ZodObject<{
+    by: z.ZodObject<{
+        addOn: z.ZodString;
+    }, z.core.$strict>;
+    needs: z.ZodOptional<z.ZodString>;
+    lines: z.ZodArray<z.ZodUnion<readonly [z.ZodObject<{
+        table: z.ZodString;
+        via: z.ZodString;
+        price: z.ZodString;
+        quantity: z.ZodOptional<z.ZodString>;
+        discount: z.ZodString;
+        what: z.ZodArray<z.ZodObject<{
+            column: z.ZodString;
+            as: z.ZodEnum<{
+                type: "type";
+                item: "item";
+                category: "category";
+                tag: "tag";
+            }>;
+        }, z.core.$strict>>;
+        excludes: z.ZodOptional<z.ZodObject<{
+            column: z.ZodString;
+            set: z.ZodLiteral<true>;
+        }, z.core.$strict>>;
+        paidBy: z.ZodOptional<z.ZodObject<{
+            column: z.ZodString;
+        }, z.core.$strict>>;
+        only: z.ZodOptional<z.ZodUnion<readonly [z.ZodObject<{
+            column: z.ZodString;
+            eq: z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean]>;
+        }, z.core.$strict>, z.ZodObject<{
+            column: z.ZodString;
+            in: z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean]>>;
+        }, z.core.$strict>]>>;
+        unlessSet: z.ZodOptional<z.ZodString>;
+    }, z.core.$strict>, z.ZodObject<{
+        self: z.ZodLiteral<true>;
+        price: z.ZodString;
+        quantity: z.ZodOptional<z.ZodString>;
+        discount: z.ZodString;
+        what: z.ZodArray<z.ZodObject<{
+            column: z.ZodString;
+            as: z.ZodEnum<{
+                type: "type";
+                item: "item";
+                category: "category";
+                tag: "tag";
+            }>;
+        }, z.core.$strict>>;
+        nights: z.ZodOptional<z.ZodObject<{
+            from: z.ZodString;
+            to: z.ZodString;
+            rate: z.ZodString;
+        }, z.core.$strict>>;
+    }, z.core.$strict>]>>;
+    order: z.ZodObject<{
+        discount: z.ZodString;
+        customer: z.ZodOptional<z.ZodObject<{
+            link: z.ZodString;
+            address: z.ZodString;
+            proved: z.ZodString;
+            counts: z.ZodOptional<z.ZodObject<{
+                column: z.ZodString;
+                in: z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean]>>;
+            }, z.core.$strict>>;
+        }, z.core.$strict>>;
+        staff: z.ZodOptional<z.ZodObject<{
+            kind: z.ZodString;
+            value: z.ZodString;
+            reason: z.ZodString;
+            by: z.ZodString;
+        }, z.core.$strict>>;
+        currency: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
+            row: z.ZodLiteral<true>;
+        }, z.core.$strict>, z.ZodObject<{
+            parent: z.ZodString;
+        }, z.core.$strict>, z.ZodObject<{
+            setting: z.ZodString;
+        }, z.core.$strict>, z.ZodObject<{
+            value: z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean]>;
+        }, z.core.$strict>]>>;
+    }, z.core.$strict>;
+    codes: z.ZodOptional<z.ZodObject<{
+        table: z.ZodString;
+        via: z.ZodString;
+        typed: z.ZodString;
+        code: z.ZodString;
+        voucher: z.ZodString;
+        removed: z.ZodOptional<z.ZodString>;
+    }, z.core.$strict>>;
+    uses: z.ZodOptional<z.ZodString>;
+    frozen: z.ZodOptional<z.ZodUnion<readonly [z.ZodObject<{
+        to: z.ZodArray<z.ZodString>;
+    }, z.core.$strict>, z.ZodObject<{
+        column: z.ZodString;
+        in: z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean]>>;
+    }, z.core.$strict>, z.ZodObject<{
+        column: z.ZodString;
+        set: z.ZodLiteral<true>;
+    }, z.core.$strict>]>>;
+    expect: z.ZodOptional<z.ZodString>;
+    refunds: z.ZodOptional<z.ZodObject<{
+        table: z.ZodString;
+        via: z.ZodString;
+        amount: z.ZodString;
+        tax: z.ZodOptional<z.ZodString>;
+        of: z.ZodString;
+        taxOf: z.ZodOptional<z.ZodString>;
+        against: z.ZodOptional<z.ZodString>;
+        lines: z.ZodOptional<z.ZodObject<{
+            table: z.ZodString;
+            via: z.ZodString;
+            line: z.ZodString;
+            quantity: z.ZodString;
+        }, z.core.$strict>>;
+    }, z.core.$strict>>;
+}, z.core.$strict>;
+export type Adjust = z.infer<typeof adjustSchema>;
+/** A read of the adjuster's own tables: a ledger read, whose keys may also be the moment (`now`) or the typed codes (`input.codes`). */
+export declare const adjusterReadSchema: z.ZodObject<{
+    table: z.ZodString;
+    as: z.ZodString;
+    where: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        column: z.ZodString;
+        eq: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean]>>;
+        in: z.ZodOptional<z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean]>>>;
+    }, z.core.$strict>>>;
+    limit: z.ZodOptional<z.ZodNumber>;
+    by: z.ZodArray<z.ZodObject<{
+        column: z.ZodString;
+        from: z.ZodUnion<readonly [z.ZodString, z.ZodLiteral<"now">, z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodLiteral<"now">]>>]>;
+    }, z.core.$strict>>;
+}, z.core.$strict>;
+export declare const adjusterSchema: z.ZodObject<{
+    offers: z.ZodArray<z.ZodObject<{
+        table: z.ZodString;
+        as: z.ZodString;
+        where: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            column: z.ZodString;
+            eq: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean]>>;
+            in: z.ZodOptional<z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean]>>>;
+        }, z.core.$strict>>>;
+        limit: z.ZodOptional<z.ZodNumber>;
+        by: z.ZodArray<z.ZodObject<{
+            column: z.ZodString;
+            from: z.ZodUnion<readonly [z.ZodString, z.ZodLiteral<"now">, z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodLiteral<"now">]>>]>;
+        }, z.core.$strict>>;
+    }, z.core.$strict>>;
+    codes: z.ZodObject<{
+        table: z.ZodString;
+        column: z.ZodString;
+        where: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            column: z.ZodString;
+            eq: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean]>>;
+            in: z.ZodOptional<z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean]>>>;
+        }, z.core.$strict>>>;
+        reserved: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    }, z.core.$strict>;
+    vouchers: z.ZodObject<{
+        table: z.ZodString;
+        column: z.ZodString;
+        prefixes: z.ZodArray<z.ZodString>;
+    }, z.core.$strict>;
+    applied: z.ZodObject<{
+        table: z.ZodString;
+        source: z.ZodObject<{
+            table: z.ZodString;
+            row: z.ZodString;
+            line: z.ZodString;
+        }, z.core.$strict>;
+        columns: z.ZodObject<{
+            offer: z.ZodString;
+            code: z.ZodString;
+            voucher: z.ZodString;
+            name: z.ZodString;
+            kind: z.ZodString;
+            amount: z.ZodString;
+            reason: z.ZodString;
+            typed: z.ZodString;
+            at: z.ZodString;
+        }, z.core.$strict>;
+    }, z.core.$strict>;
+    person: z.ZodOptional<z.ZodObject<{
+        groups: z.ZodObject<{
+            table: z.ZodString;
+            member: z.ZodString;
+            group: z.ZodString;
+        }, z.core.$strict>;
+        uses: z.ZodObject<{
+            table: z.ZodString;
+            customer: z.ZodString;
+            offer: z.ZodString;
+            state: z.ZodString;
+            counted: z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean]>>;
+        }, z.core.$strict>;
+        orders: z.ZodOptional<z.ZodLiteral<true>>;
+    }, z.core.$strict>>;
+    ceilings: z.ZodOptional<z.ZodObject<{
+        table: z.ZodString;
+        role: z.ZodString;
+        maxPercent: z.ZodString;
+        maxAmount: z.ZodString;
+        comp: z.ZodOptional<z.ZodString>;
+    }, z.core.$strict>>;
+    customerKey: z.ZodLiteral<"hash">;
+}, z.core.$strict>;
+export type Adjuster = z.infer<typeof adjusterSchema>;
+/** What the checks read of a table. */
+export interface AdjustTableShape {
+    ref: string;
+    columns: readonly {
+        ref: string;
+        type: string;
+        role?: string | undefined;
+        nullable?: boolean | undefined;
+        enum?: readonly string[] | undefined;
+        references?: string | undefined;
+        maxLength?: number | undefined;
+        scale?: number | 'currency' | undefined;
+        default?: unknown;
+        rules?: Readonly<Record<string, unknown>> | undefined;
+    }[];
+    states?: unknown;
+    capacity?: unknown;
+    postings?: readonly Posting[] | undefined;
+    adjust?: Adjust | undefined;
+}
+/**
+ * The columns a price rule makes Adminium's own, by table: the order's
+ * discount, who gave a staff reduction, whether the customer was proved;
+ * each line's discount; the links a typed code fills; a refund's amount and
+ * tax.
+ */
+export declare function adjustDecidedColumns(table: string, adjust: Adjust): Map<string, string[]>;
+/** Everything wrong with a table's price rule that this manifest can see. */
+export declare function adjustIssues(table: AdjustTableShape, adjust: Adjust, ctx: {
+    key: string;
+    kind: 'app' | 'add-on';
+    tables: ReadonlyMap<string, AdjustTableShape>;
+    named: ReadonlySet<string>;
+    features: ReadonlyMap<string, readonly string[]>;
+    /** The columns of a table a formula column reads, by column. */
+    formulaReads: (table: string, column: string) => readonly string[] | null;
+    /** The public entries' writable columns, by table. */
+    publicWritable: (table: string) => ReadonlySet<string>;
+}, at: (...rest: (string | number)[]) => (string | number)[]): ReferenceIssue[];
+/** Everything wrong with an add-on's `adjuster` that its own manifest can see. */
+export declare function adjusterIssues(adjuster: Adjuster, tables: ReadonlyMap<string, AdjustTableShape>): ReferenceIssue[];
+//# sourceMappingURL=adjust.d.ts.map

package/dist/adjust.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"adjust.d.ts","sourceRoot":"","sources":["../src/adjust.ts"],"names":[],"mappings":"AACA;;;;;;;;;;;;;;;;GAgBG;AACH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAA0D,KAAK,OAAO,EAAE,MAAM,cAAc,CAAC;AACpG,OAAO,EAA2B,KAAK,cAAc,EAAE,MAAM,WAAW,CAAC;AAKzE,gDAAgD;AAChD,eAAO,MAAM,gBAAgB,IAAI,CAAC;AA2ClC,eAAO,MAAM,gBAAgB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;oBAA6C,CAAC;AAC3E,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAE1D,eAAO,MAAM,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBA8CmI,CAAC;AAC7J,MAAM,MAAM,MAAM,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,YAAY,CAAC,CAAC;AAIlD,wIAAwI;AACxI,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;kBAGpB,CAAC;AAIZ,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBAgChB,CAAC;AACZ,MAAM,MAAM,QAAQ,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,cAAc,CAAC,CAAC;AAItD,uCAAuC;AACvC,MAAM,WAAW,gBAAgB;IAC/B,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,QAAQ,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;QAC/B,IAAI,CAAC,EAAE,SAAS,MAAM,EAAE,GAAG,SAAS,CAAC;QACrC,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;QAChC,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;QAC/B,KAAK,CAAC,EAAE,MAAM,GAAG,UAAU,GAAG,SAAS,CAAC;QACxC,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,KAAK,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC;KACvD,EAAE,CAAC;IACJ,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,QAAQ,CAAC,EAAE,SAAS,OAAO,EAAE,GAAG,SAAS,CAAC;IAC1C,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC7B;AAKD;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAmBzF;AAED,6EAA6E;AAC7E,wBAAgB,YAAY,CAC1B,KAAK,EAAE,gBAAgB,EACvB,MAAM,EAAE,MAAM,EACd,GAAG,EAAE;IACH,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,KAAK,GAAG,QAAQ,CAAC;IACvB,MAAM,EAAE,WAAW,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;IAC9C,KAAK,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC;IAC3B,QAAQ,EAAE,WAAW,CAAC,MAAM,EAAE,SAAS,MAAM,EAAE,CAAC,CAAC;IACjD,gEAAgE;IAChE,YAAY,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,KAAK,SAAS,MAAM,EAAE,GAAG,IAAI,CAAC;IAC1E,sDAAsD;IACtD,cAAc,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,WAAW,CAAC,MAAM,CAAC,CAAC;CACxD,EACD,EAAE,EAAE,CAAC,GAAG,IAAI,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,GACxD,cAAc,EAAE,CA0NlB;AAED,kFAAkF;AAClF,wBAAgB,cAAc,CAAC,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,WAAW,CAAC,MAAM,EAAE,gBAAgB,CAAC,GAAG,cAAc,EAAE,CAqElH"}