@aglyn/plugins-commerce 1.0.0-beta.278 → 1.0.0-beta.282

package/src/lib/declarations.js

@@ -0,0 +1,34 @@
+/**
+ * @license
+ * Copyright 2026 Aglyn LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */ import { registerPluginPermissions } from "@aglyn/aglyn/plugin-manager/plugin-permissions";
+import { COMMERCE_PERMISSIONS } from "./model/plugin-permissions.js";
+let declared = false;
+/**
+ * The plugin's DECLARATIONS (AGL-4047): its permission keys (the point of sale key (`managePos`)), which
+ * the one permission catalog lists beside the core keys. Loaded eagerly by
+ * the console (client and server) and the tenant's server through the
+ * generated declarations manifest, so the role editor offers the keys, a
+ * custom role or a per-member override keeps them, and a route resolves
+ * them whether or not a request has touched the plugin yet. Light by
+ * construction: nothing here reaches a provider, Firestore or React.
+ */ export function registerCommerceDeclarations() {
+    if (declared) return;
+    declared = true;
+    registerPluginPermissions(COMMERCE_PERMISSIONS);
+}
+registerCommerceDeclarations();
+
+//# sourceMappingURL=declarations.js.map

package/src/lib/declarations.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../../../libs/plugins/commerce/src/lib/declarations.ts"],"sourcesContent":["/**\n * @license\n * Copyright 2026 Aglyn LLC\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *   http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { registerPluginPermissions } from '@aglyn/aglyn/plugin-manager/plugin-permissions'\nimport { COMMERCE_PERMISSIONS } from './model/plugin-permissions'\n\nlet declared = false\n\n/**\n * The plugin's DECLARATIONS (AGL-4047): its permission keys (the point of sale key (`managePos`)), which\n * the one permission catalog lists beside the core keys. Loaded eagerly by\n * the console (client and server) and the tenant's server through the\n * generated declarations manifest, so the role editor offers the keys, a\n * custom role or a per-member override keeps them, and a route resolves\n * them whether or not a request has touched the plugin yet. Light by\n * construction: nothing here reaches a provider, Firestore or React.\n */\nexport function registerCommerceDeclarations(): void {\n  if (declared) return\n  declared = true\n  registerPluginPermissions(COMMERCE_PERMISSIONS)\n}\n\nregisterCommerceDeclarations()\n"],"names":["registerPluginPermissions","COMMERCE_PERMISSIONS","declared","registerCommerceDeclarations"],"mappings":"AAAA;;;;;;;;;;;;;;;CAeC,GAED,SAASA,yBAAyB,QAAQ,iDAAgD;AAC1F,SAASC,oBAAoB,QAAQ,gCAA4B;AAEjE,IAAIC,WAAW;AAEf;;;;;;;;CAQC,GACD,OAAO,SAASC;IACd,IAAID,UAAU;IACdA,WAAW;IACXF,0BAA0BC;AAC5B;AAEAE"}

package/src/lib/model/commerce-check-in-product.d.ts

@@ -0,0 +1,37 @@
+/**
+ * @license
+ * Copyright 2026 Aglyn LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+ * The product and variant check-in setting (AGL-4043): whether an item needs
+ * check-in and how many people one item admits. It has no imports, so the
+ * native contracts and the console read the same shape and rules.
+ */
+/** The most people one item admits. */
+export declare const CHECK_IN_MAX_HEADCOUNT = 50;
+/**
+ * Whether a product (or one variant) needs check-in (AGL-4043), and how
+ * many people one item admits. On a product it is the default for every
+ * variant; on a variant it overrides the product's.
+ */
+export interface ProductCheckIn {
+    enabled: boolean;
+    /** People one item admits, 1–{@link CHECK_IN_MAX_HEADCOUNT}; absent is 1. */
+    headcount?: number;
+}
+/** A stored check-in setting made safe, or `undefined` when it says nothing. */
+export declare function normalizeProductCheckIn(value: unknown): ProductCheckIn | undefined;
+/** Why a check-in setting cannot be saved, or `null`. */
+export declare function productCheckInProblem(value: unknown): string | null;

package/src/lib/model/commerce-check-in-product.js

@@ -0,0 +1,49 @@
+/**
+ * @license
+ * Copyright 2026 Aglyn LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */ /**
+ * The product and variant check-in setting (AGL-4043): whether an item needs
+ * check-in and how many people one item admits. It has no imports, so the
+ * native contracts and the console read the same shape and rules.
+ */ /** The most people one item admits. */ export const CHECK_IN_MAX_HEADCOUNT = 50;
+function headcountOf(value) {
+    const count = Math.round(Number(value));
+    return Number.isFinite(count) && count >= 1 ? Math.min(count, CHECK_IN_MAX_HEADCOUNT) : 1;
+}
+/** A stored check-in setting made safe, or `undefined` when it says nothing. */ export function normalizeProductCheckIn(value) {
+    if (!value || typeof value !== 'object') return undefined;
+    const raw = value;
+    if (typeof raw['enabled'] !== 'boolean') return undefined;
+    return raw['enabled'] ? {
+        enabled: true,
+        headcount: headcountOf(raw['headcount'])
+    } : {
+        enabled: false
+    };
+}
+/** Why a check-in setting cannot be saved, or `null`. */ export function productCheckInProblem(value) {
+    if (value === undefined || value === null) return null;
+    if (typeof value !== 'object' || typeof value.enabled !== 'boolean') {
+        return 'Check-in must be on or off';
+    }
+    const headcount = value.headcount;
+    if (headcount === undefined) return null;
+    if (!Number.isInteger(headcount) || headcount < 1 || headcount > CHECK_IN_MAX_HEADCOUNT) {
+        return `People per item must be a whole number from 1 to ${CHECK_IN_MAX_HEADCOUNT}`;
+    }
+    return null;
+}
+
+//# sourceMappingURL=commerce-check-in-product.js.map

package/src/lib/model/commerce-check-in-product.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../../../../libs/plugins/commerce/src/lib/model/commerce-check-in-product.ts"],"sourcesContent":["/**\n * @license\n * Copyright 2026 Aglyn LLC\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *   http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\n/**\n * The product and variant check-in setting (AGL-4043): whether an item needs\n * check-in and how many people one item admits. It has no imports, so the\n * native contracts and the console read the same shape and rules.\n */\n\n/** The most people one item admits. */\nexport const CHECK_IN_MAX_HEADCOUNT = 50\n\n/**\n * Whether a product (or one variant) needs check-in (AGL-4043), and how\n * many people one item admits. On a product it is the default for every\n * variant; on a variant it overrides the product's.\n */\nexport interface ProductCheckIn {\n  enabled: boolean\n  /** People one item admits, 1–{@link CHECK_IN_MAX_HEADCOUNT}; absent is 1. */\n  headcount?: number\n}\n\nfunction headcountOf(value: unknown): number {\n  const count = Math.round(Number(value))\n  return Number.isFinite(count) && count >= 1 ? Math.min(count, CHECK_IN_MAX_HEADCOUNT) : 1\n}\n\n/** A stored check-in setting made safe, or `undefined` when it says nothing. */\nexport function normalizeProductCheckIn(value: unknown): ProductCheckIn | undefined {\n  if (!value || typeof value !== 'object') return undefined\n  const raw = value as Record<string, unknown>\n  if (typeof raw['enabled'] !== 'boolean') return undefined\n  return raw['enabled']\n    ? { enabled: true, headcount: headcountOf(raw['headcount']) }\n    : { enabled: false }\n}\n\n/** Why a check-in setting cannot be saved, or `null`. */\nexport function productCheckInProblem(value: unknown): string | null {\n  if (value === undefined || value === null) return null\n  if (typeof value !== 'object' || typeof (value as ProductCheckIn).enabled !== 'boolean') {\n    return 'Check-in must be on or off'\n  }\n  const headcount = (value as ProductCheckIn).headcount\n  if (headcount === undefined) return null\n  if (!Number.isInteger(headcount) || headcount < 1 || headcount > CHECK_IN_MAX_HEADCOUNT) {\n    return `People per item must be a whole number from 1 to ${CHECK_IN_MAX_HEADCOUNT}`\n  }\n  return null\n}\n"],"names":["CHECK_IN_MAX_HEADCOUNT","headcountOf","value","count","Math","round","Number","isFinite","min","normalizeProductCheckIn","undefined","raw","enabled","headcount","productCheckInProblem","isInteger"],"mappings":"AAAA;;;;;;;;;;;;;;;CAeC,GAED;;;;CAIC,GAED,qCAAqC,GACrC,OAAO,MAAMA,yBAAyB,GAAE;AAaxC,SAASC,YAAYC,KAAc;IACjC,MAAMC,QAAQC,KAAKC,KAAK,CAACC,OAAOJ;IAChC,OAAOI,OAAOC,QAAQ,CAACJ,UAAUA,SAAS,IAAIC,KAAKI,GAAG,CAACL,OAAOH,0BAA0B;AAC1F;AAEA,8EAA8E,GAC9E,OAAO,SAASS,wBAAwBP,KAAc;IACpD,IAAI,CAACA,SAAS,OAAOA,UAAU,UAAU,OAAOQ;IAChD,MAAMC,MAAMT;IACZ,IAAI,OAAOS,GAAG,CAAC,UAAU,KAAK,WAAW,OAAOD;IAChD,OAAOC,GAAG,CAAC,UAAU,GACjB;QAAEC,SAAS;QAAMC,WAAWZ,YAAYU,GAAG,CAAC,YAAY;IAAE,IAC1D;QAAEC,SAAS;IAAM;AACvB;AAEA,uDAAuD,GACvD,OAAO,SAASE,sBAAsBZ,KAAc;IAClD,IAAIA,UAAUQ,aAAaR,UAAU,MAAM,OAAO;IAClD,IAAI,OAAOA,UAAU,YAAY,OAAO,AAACA,MAAyBU,OAAO,KAAK,WAAW;QACvF,OAAO;IACT;IACA,MAAMC,YAAY,AAACX,MAAyBW,SAAS;IACrD,IAAIA,cAAcH,WAAW,OAAO;IACpC,IAAI,CAACJ,OAAOS,SAAS,CAACF,cAAcA,YAAY,KAAKA,YAAYb,wBAAwB;QACvF,OAAO,CAAC,iDAAiD,EAAEA,wBAAwB;IACrF;IACA,OAAO;AACT"}

package/src/lib/model/commerce-check-in.d.ts

@@ -0,0 +1,187 @@
+import type { ProductVariant } from './commerce';
+import { type HostOrder, type OrderChannel } from './commerce-orders';
+import type { HostReservation } from './commerce-reservations';
+export { CHECK_IN_MAX_HEADCOUNT, normalizeProductCheckIn, productCheckInProblem, type ProductCheckIn, } from './commerce-check-in-product';
+export declare const POS_CHECK_IN_ROUTE = "/api/commerce/pos-check-in";
+/** The most check-ins one order line makes, whatever its quantity. */
+export declare const CHECK_IN_MAX_UNITS_PER_LINE = 200;
+/** The most check-ins, orders or stays one day reads. */
+export declare const CHECK_IN_DAY_CEILING = 3000;
+/** The most check-in rows one search reads. */
+export declare const CHECK_IN_SEARCH_ROWS = 100;
+/** The most customers one search answers. */
+export declare const CHECK_IN_SEARCH_CUSTOMERS = 20;
+/** The most check-ins one tap records. */
+export declare const CHECK_IN_BATCH_MAX = 50;
+/** A wristband's number or color, at most this many characters. */
+export declare const CHECK_IN_WRISTBAND_MAX = 24;
+/** Colors offered as quick picks for a wristband. Any word is accepted. */
+export declare const CHECK_IN_WRISTBAND_COLORS: readonly ["Red", "Orange", "Yellow", "Green", "Blue", "Purple", "Pink", "White", "Black"];
+/** The order statuses whose check-in lines are due. */
+export declare const CHECK_IN_ORDER_STATUSES: readonly ["paid", "partially_fulfilled", "fulfilled", "delivered"];
+/** The stay statuses whose days are due. */
+export declare const CHECK_IN_RESERVATION_STATUSES: readonly ["confirmed", "checked_in"];
+export type CheckInStatus = 'expected' | 'checked_in';
+export interface CheckInWristband {
+    number: string | null;
+    color: string | null;
+}
+/** `hosts/{hostId}/checkIns/{id}`: one person due on one day. Server-written only. */
+export interface HostCheckIn {
+    source: 'order' | 'reservation';
+    orderId: string | null;
+    /** The order's number as the console shows it (`#1042`), or null for a stay. */
+    orderLabel: string | null;
+    /** Where the order was sold, or `reservation`. */
+    channel: OrderChannel | 'reservation';
+    reservationId: string | null;
+    lineIndex: number | null;
+    /** This person's place among the line's or stay's check-ins, from 0. */
+    unitIndex: number;
+    /** How many check-ins the line or stay makes that day. */
+    unitCount: number;
+    productId: string | null;
+    variantId: string | null;
+    itemName: string;
+    variantLabel: string | null;
+    /** The day, `YYYY-MM-DD` in the site's time zone. */
+    dayKey: string;
+    /** Who the check-in is for, as one key: the address, else the contact, else the name, else the order. */
+    customerKey: string;
+    customerName: string | null;
+    customerEmail: string | null;
+    customerEmailLower: string | null;
+    customerPhone: string | null;
+    /** The contact the register attached to the sale, when it was one. */
+    contactId: string | null;
+    /** The name's, the address's, the phone's and the order number's search prefixes. */
+    searchTokens: string[];
+    status: CheckInStatus;
+    checkedInAtMs: number | null;
+    checkedInBy: string | null;
+    checkedInByName: string | null;
+    wristband: CheckInWristband | null;
+    /** The attempt that checked this person in, so a retried tap is not "already checked in". */
+    checkInAttempt: string | null;
+    /** The last undo, kept so a reversed check-in still says who reversed it. */
+    undoneAtMs: number | null;
+    undoneBy: string | null;
+    createdAtMs: number;
+    updatedAtMs: number;
+}
+/** One check-in as the routes answer it. */
+export type CheckInRow = HostCheckIn & {
+    id: string;
+};
+/** A customer with something due on a day, as the search lists them. */
+export interface CheckInCustomer {
+    customerKey: string;
+    name: string | null;
+    email: string | null;
+    phone: string | null;
+    contactId: string | null;
+    /** Every check-in the customer has on the day. */
+    unitsDue: number;
+    unitsCheckedIn: number;
+    /** What the check-ins are for, item names once each. */
+    items: string[];
+}
+/**
+ * Whether one variant of a product needs check-in, and for how many people
+ * per item: the variant's own setting, else the product's; `null` when not.
+ */
+export declare function productCheckInFor(product: {
+    checkIn?: unknown;
+    variants?: ReadonlyArray<Pick<ProductVariant, 'id'> & {
+        checkIn?: unknown;
+    }>;
+} | null | undefined, variantId: string | null | undefined): {
+    headcount: number;
+} | null;
+/** Whether any variant of a product needs check-in. */
+export declare function productNeedsCheckIn(product: Parameters<typeof productCheckInFor>[0]): boolean;
+/** The digits of a phone number, without a leading US/Canada 1 when it has eleven. */
+export declare function checkInPhoneDigits(phone: string | null | undefined): string;
+/** The tokens a check-in is found by. */
+export declare function checkInSearchTokens(input: {
+    name?: string | null;
+    email?: string | null;
+    phone?: string | null;
+    orderNumber?: number | null;
+    orderId?: string | null;
+}): string[];
+/**
+ * What a typed search asks the index for: the phone's digits when it is a
+ * number, else the first word's prefix (a name, an address, `#1042`).
+ */
+export declare function checkInSearchToken(typed: string): string;
+/** One key per customer: the address, else the contact, else the name, else the source. */
+export declare function checkInCustomerKey(input: {
+    email?: string | null;
+    contactId?: string | null;
+    name?: string | null;
+    fallback: string;
+}): string;
+/** A check-in's document id, from its unit's identity. */
+export declare function orderCheckInId(orderId: string, lineIndex: number, unitIndex: number): string;
+export declare function reservationCheckInId(reservationId: string, dayKey: string, unitIndex?: number): string;
+/** A due check-in before the server stamps its times and status. */
+export type DueCheckIn = Omit<HostCheckIn, 'status' | 'checkedInAtMs' | 'checkedInBy' | 'checkedInByName' | 'wristband' | 'checkInAttempt' | 'undoneAtMs' | 'undoneBy' | 'createdAtMs' | 'updatedAtMs'>;
+/** The customer fields a due check-in copies from its source, which a later read may refresh. */
+export declare const CHECK_IN_CUSTOMER_FIELDS: readonly ["customerKey", "customerName", "customerEmail", "customerEmailLower", "customerPhone", "contactId", "searchTokens"];
+/** Whether an order's lines are due at all. */
+export declare function orderIsDueForCheckIn(order: Pick<HostOrder, 'status'> | null | undefined): boolean;
+/**
+ * The check-ins an order makes on its day, keyed by document id. `products`
+ * holds the products its lines name, as stored now: the setting is read at
+ * the window, so turning it on covers passes already sold today.
+ */
+export declare function dueCheckInsForOrder(input: {
+    orderId: string;
+    order: Partial<HostOrder>;
+    products: ReadonlyMap<string, Parameters<typeof productCheckInFor>[0]>;
+    dayKey: string;
+}): Map<string, DueCheckIn>;
+/** UTC midnight of a `YYYY-MM-DD` day, as a stay's days are stored. */
+export declare function checkInDayMs(dayKey: string): number | null;
+/** The check-in a stay makes on a day it covers; empty on any other day. */
+export declare function dueCheckInsForReservation(input: {
+    reservationId: string;
+    reservation: Partial<HostReservation>;
+    resourceName: string | null;
+    dayKey: string;
+}): Map<string, DueCheckIn>;
+/** A due check-in as first written. */
+export declare function newCheckInDocument(due: DueCheckIn, nowMs: number): HostCheckIn;
+/** The customer fields of a stored check-in that its source now says otherwise. */
+export declare function changedCheckInCustomerFields(stored: Partial<HostCheckIn>, due: DueCheckIn): Partial<DueCheckIn> | null;
+/**
+ * A wristband as typed, made safe: a number (letters, digits, a dash) and a
+ * color word, each optional. `null` with neither; an error for junk.
+ */
+export declare function normalizeWristband(value: unknown): {
+    ok: true;
+    wristband: CheckInWristband | null;
+} | {
+    ok: false;
+    error: string;
+};
+/** A wristband as one line: "Blue #214". */
+export declare function describeWristband(wristband: CheckInWristband | null | undefined): string;
+/** The customers a set of check-ins is for, most due first, then by name. */
+export declare function checkInCustomers(rows: ReadonlyArray<CheckInRow>): CheckInCustomer[];
+/** A day's check-ins in the order the window reads them: by name, then item, then unit. */
+export declare function sortCheckInRows<T extends Pick<CheckInRow, 'customerName' | 'customerEmail' | 'itemName' | 'unitIndex' | 'id'>>(rows: ReadonlyArray<T>): T[];
+export interface CheckInDayTotals {
+    expected: number;
+    checkedIn: number;
+}
+export declare function checkInDayTotals(rows: ReadonlyArray<Pick<CheckInRow, 'status'>>): CheckInDayTotals;
+/** A time on the site's clock: "9:14 AM". */
+export declare function checkInTimeLabel(ms: number | null | undefined, timeZone: string): string;
+/** "Already checked in at 9:14 AM by Sam". */
+export declare function alreadyCheckedInLabel(row: Pick<CheckInRow, 'checkedInAtMs' | 'checkedInByName'>, timeZone: string): string;
+/** One person's line, as the list and the spreadsheet name it: "Day pass · Adult (2 of 3)". */
+export declare function checkInItemLabel(row: Pick<CheckInRow, 'itemName' | 'variantLabel' | 'unitIndex' | 'unitCount'>): string;
+/** The day's check-ins as a spreadsheet, one row per person. */
+export declare function checkInDayCsv(rows: ReadonlyArray<CheckInRow>, timeZone: string): string;