@sixtyninecommerce/admin 0.10.0 → 0.11.0

package/dist/pos/quick-keys.d.ts

@@ -0,0 +1,103 @@
+import type { Transport } from '@sixtyninecommerce/core';
+import type { Call } from '../types.js';
+/**
+ * A store's quick keys (POS sprint 13): the till's favourite-product buttons, on named, coloured
+ * pages, one layout per store, shown on every till of the store. The limits and the palette are
+ * the engine's (`vendure-plugin-pos` `services/quick-key-layout.ts`), pinned by
+ * `pos-quick-keys.spec.ts`.
+ */
+/** The quick key palette; anything else is refused `POS_QUICK_KEYS_INVALID`. */
+export declare const POS_QUICK_KEY_COLORS: readonly ["slate", "red", "orange", "amber", "green", "teal", "sky", "blue", "violet", "pink"];
+export type PosQuickKeyColor = (typeof POS_QUICK_KEY_COLORS)[number];
+/** At most 10 pages of at most 40 keys; a page name of 1-20 and a label of up to 30 characters. */
+export declare const POS_QUICK_KEY_LIMITS: {
+    readonly pages: 10;
+    readonly keysPerPage: 40;
+    readonly pageNameLength: 20;
+    readonly labelLength: 30;
+};
+/** Whether the till shows a key; only `available` keys are on the till. More may come. */
+export type PosQuickKeyState = 'available' | 'product_disabled' | 'product_gone' | 'variant_disabled' | 'variant_gone' | 'no_sellable_variant' | (string & {});
+export interface PosQuickKey {
+    /** Send it back to keep the key, also when it moves to another page. */
+    id: string;
+    productId: string;
+    /** The one variant the key adds; null for a product key (one variant adds, several open the picker). */
+    variantId: string | null;
+    /** The store's button text; null shows the product's (or the variant's) own name. */
+    label: string | null;
+    /** A palette colour, or a newer engine's; null for none. */
+    color: string | null;
+    state: PosQuickKeyState;
+    /** The catalogue's name now (the variant's for a variant key); null when it is gone. */
+    name: string | null;
+    /** The variant's SKU for a variant key; null otherwise. */
+    sku: string | null;
+    featuredAsset: {
+        id: string;
+        preview: string;
+    } | null;
+}
+export interface PosQuickKeyPage {
+    /** Send it back to keep the page. */
+    id: string;
+    name: string;
+    color: string | null;
+    keys: PosQuickKey[];
+}
+export interface PosQuickKeyLayout {
+    /** Raised by every save that changes the layout; 0 before the first. Send it as `expectedVersion`. */
+    version: number;
+    /** When a save last changed the layout (ISO-8601); null before the first. */
+    updatedAt: string | null;
+    pages: PosQuickKeyPage[];
+}
+export interface PosQuickKeyInput {
+    /** A stored key's id keeps the key; omit it for a new key. */
+    id?: string;
+    productId: string;
+    /** Pin the key to one variant of the product; omit for the product. */
+    variantId?: string | null;
+    /** Blank shows the product's (or the variant's) own name. */
+    label?: string | null;
+    /**
+     * A palette colour, or null for none. A colour this SDK does not list is sent as read (sprint
+     * 27: a back office keeps an engine colour it does not know); the engine refuses one IT does not
+     * know (`POS_QUICK_KEYS_INVALID`, `color_unknown`).
+     */
+    color?: PosQuickKeyColor | (string & {}) | null;
+}
+export interface PosQuickKeyPageInput {
+    /** A stored page's id keeps the page; omit it for a new page. */
+    id?: string;
+    name: string;
+    /**
+     * A palette colour, or null for none. A colour this SDK does not list is sent as read (sprint
+     * 27: a back office keeps an engine colour it does not know); the engine refuses one IT does not
+     * know (`POS_QUICK_KEYS_INVALID`, `color_unknown`).
+     */
+    color?: PosQuickKeyColor | (string & {}) | null;
+    keys: PosQuickKeyInput[];
+}
+export interface SetPosQuickKeyLayoutInput {
+    /** The `version` the editor read. */
+    expectedVersion: number;
+    pages: PosQuickKeyPageInput[];
+}
+/** Read needs UpdateSettings or ManagePosDevices; set needs UpdateSettings. */
+export interface PosQuickKeysModule {
+    /** The store's quick keys, every page and key in order, each key's `state` saying whether the till shows it. */
+    get(options?: Call): Promise<PosQuickKeyLayout>;
+    /**
+     * Replace them (the whole layout). Refusals: `POS_QUICK_KEYS_CONFLICT` (`ConflictError`, 409:
+     * changed since `expectedVersion`; read again), `POS_QUICK_KEYS_INVALID` (`ValidationError`, 400;
+     * `error.details[0].field` is a JSON Pointer into the input), `POS_QUICK_KEYS_PRODUCT_NOT_FOUND`
+     * (`NotFoundError`, 404), `POS_QUICK_KEYS_FORMAT_UNSUPPORTED` (`BusinessRuleError`, 422),
+     * `ORGANIZATION_WORKSPACE_NOT_A_STORE`. Sending what is stored again is never refused, whatever
+     * `expectedVersion` says.
+     */
+    set(input: SetPosQuickKeyLayoutInput, options?: Call): Promise<PosQuickKeyLayout>;
+}
+export declare const POS_QUICK_KEY_LAYOUT_QUERY = "query PosQuickKeyLayout { posQuickKeyLayout { version updatedAt pages { id name color keys { id productId variantId label color state name sku featuredAsset { id preview } } } } }";
+export declare const SET_POS_QUICK_KEY_LAYOUT_MUTATION = "mutation SetPosQuickKeyLayout($input: SetPosQuickKeyLayoutInput!) { setPosQuickKeyLayout(input: $input) { version updatedAt pages { id name color keys { id productId variantId label color state name sku featuredAsset { id preview } } } } }";
+export declare function createPosQuickKeysModule(transport: Transport): PosQuickKeysModule;

package/dist/pos/quick-keys.js

@@ -0,0 +1,45 @@
+/**
+ * A store's quick keys (POS sprint 13): the till's favourite-product buttons, on named, coloured
+ * pages, one layout per store, shown on every till of the store. The limits and the palette are
+ * the engine's (`vendure-plugin-pos` `services/quick-key-layout.ts`), pinned by
+ * `pos-quick-keys.spec.ts`.
+ */
+/** The quick key palette; anything else is refused `POS_QUICK_KEYS_INVALID`. */
+export const POS_QUICK_KEY_COLORS = [
+    'slate',
+    'red',
+    'orange',
+    'amber',
+    'green',
+    'teal',
+    'sky',
+    'blue',
+    'violet',
+    'pink',
+];
+/** At most 10 pages of at most 40 keys; a page name of 1-20 and a label of up to 30 characters. */
+export const POS_QUICK_KEY_LIMITS = {
+    pages: 10,
+    keysPerPage: 40,
+    pageNameLength: 20,
+    labelLength: 30,
+};
+const LAYOUT_FIELDS = 'version updatedAt pages { id name color keys { id productId variantId label color state name sku featuredAsset { id preview } } }';
+export const POS_QUICK_KEY_LAYOUT_QUERY = `query PosQuickKeyLayout { posQuickKeyLayout { ${LAYOUT_FIELDS} } }`;
+export const SET_POS_QUICK_KEY_LAYOUT_MUTATION = `mutation SetPosQuickKeyLayout($input: SetPosQuickKeyLayoutInput!) { setPosQuickKeyLayout(input: $input) { ${LAYOUT_FIELDS} } }`;
+export function createPosQuickKeysModule(transport) {
+    const gql = async (query, variables, options) => transport.graphql({ api: 'admin', query, variables }, options);
+    return {
+        async get(options) {
+            const data = await gql(POS_QUICK_KEY_LAYOUT_QUERY, {}, options);
+            return data.posQuickKeyLayout;
+        },
+        async set(input, options) {
+            if (!Number.isInteger(input.expectedVersion) || input.expectedVersion < 0) {
+                throw new TypeError('quickKeys.set needs expectedVersion: the whole-number version the layout was read at (0 before the first save).');
+            }
+            const data = await gql(SET_POS_QUICK_KEY_LAYOUT_MUTATION, { input }, options);
+            return data.setPosQuickKeyLayout;
+        },
+    };
+}

package/dist/pos/reports.d.ts

@@ -0,0 +1,360 @@
+import { type Page, type Transport } from '@sixtyninecommerce/core';
+import type { Call, ListOptions } from '../types.js';
+/**
+ * The back office's POS reports (engine sprint 28): every figure computed by the engine from the
+ * drawers' records, never summed by the caller. One read, `posReport(input)`, whose sections are
+ * fields; each method here selects ONE section (plus the report's header), so a page reads only
+ * what it shows.
+ *
+ * - Days are BUSINESS days: the label each drawer was stamped with when it opened, in its
+ *   location's zone (a bar's 01:30 sale is the day before's). `fromDay`/`toDay` are inclusive
+ *   `YYYY-MM-DD`, both today in the store's zone when omitted, at most 31 days apart.
+ * - Every day reconciles to its Z reports: `net = inZ + notInZ + unexplained + live −
+ *   refundsAfterClose` (`PosReportZCheck`). A card refund made after its sale's drawer closed is
+ *   in no Z: it counts on the day it was made. Open drawers are in, live (`openDrawerCount`).
+ * - A sale is credited to the cashier who completed it; who rang each line is not recorded.
+ * - Money is integer minor units of the drawer currency (the store's default); a sale in another
+ *   currency is in no figure (`otherCurrencySaleCount`). Exchange credit and returns without a
+ *   receipt are memos, never money.
+ *
+ * Needs `UpdateSettings` or `ManagePosDevices`; a location-restricted caller names one of its
+ * locations (`LOCATION_NOT_ALLOWED`). Refused `POS_LIST_RANGE_INVALID` (`extensions.reason`),
+ * `POS_REGISTER_NOT_FOUND`, `POS_REPORT_TIMED_OUT` (narrow the days or pick a location). Each
+ * method is its own document: an engine before 28 refuses it at validation, nothing else.
+ */
+export interface PosReportInput {
+    fromDay?: string;
+    toDay?: string;
+    /** One stock location; every location of the store when omitted. */
+    stockLocationId?: string;
+    /** One register (standing at `stockLocationId` when both are given). */
+    registerId?: string;
+}
+/** What every section answers beside it: the window and the drawers it covers. */
+export interface PosReportHeader {
+    fromDay: string;
+    toDay: string;
+    currencyCode: string;
+    stockLocationId: string | null;
+    registerId: string | null;
+    generatedAt: string;
+    drawerCount: number;
+    /** Drawers still open: their figures can still change. */
+    openDrawerCount: number;
+    /** Completed sales in another currency than the drawer's: in no figure. */
+    otherCurrencySaleCount: number;
+}
+export interface PosReportFigures {
+    saleCount: number;
+    itemCount: number;
+    salesTotal: number;
+    cash: number;
+    card: number;
+    other: number;
+    cashRefunds: number;
+    cardRefunds: number;
+    otherRefunds: number;
+    /** Card and other refunds made after their sale's drawer had closed (in no Z). */
+    refundsAfterClose: number;
+    net: number;
+    /** Signed; never part of `net`. */
+    cashRounding: number;
+    /** Not money: never in a tender or in `net`. */
+    exchangeCredit: number;
+    /** Returns without a receipt, both payouts; their cash is also in `cashRefunds`. */
+    noReceiptReturns: number;
+    /** Of which gift cards sold: a memo already inside cash, card and other; never taken off net. */
+    giftCardsSold: number;
+    giftCardsSoldCount: number;
+    /** Store credit issued on returns instead of a refund: a memo, in no refund and not in net. */
+    storeCreditIssued: number;
+    storeCreditIssuedCount: number;
+}
+export interface PosReportZCheck {
+    inZ: number;
+    notInZ: number;
+    live: number;
+    refundsAfterClose: number;
+    /** 0 unless a closed drawer's cash changed. */
+    unexplained: number;
+    recomputedZCount: number;
+}
+export interface PosReportDay {
+    businessDay: string;
+    drawerCount: number;
+    openDrawerCount: number;
+    uncountedDrawerCount: number;
+    figures: PosReportFigures;
+    zCheck: PosReportZCheck;
+    /** With one location: `open`, `closed` or `reopened` (more may come); null otherwise. */
+    storeDayStatus: string | null;
+    storeDayMismatch: boolean;
+}
+export interface PosReportReconciliation {
+    salesTotal: number;
+    paymentsBySale: number;
+    uncompletedCartPayments: number;
+    cashElsewhere: number;
+}
+export interface PosReportSummary extends PosReportHeader {
+    totals: PosReportFigures;
+    totalsCheck: PosReportZCheck;
+    days: PosReportDay[];
+    reconciliation: PosReportReconciliation;
+}
+export interface PosReportTenderRow {
+    /** `cash`, `card` or `other`. */
+    kind: string;
+    method: string;
+    methodName: string;
+    /** The store's stored-value method: part of other. */
+    storedValue: boolean;
+    paymentCount: number;
+    payments: number;
+    refunds: number;
+    refundsAfterClose: number;
+    net: number;
+}
+export interface PosReportDrawer {
+    openingFloats: number;
+    cashSales: number;
+    cashRefunds: number;
+    cashRounding: number;
+    paidIn: number;
+    paidOut: number;
+    safeDrops: number;
+    floatAdjustments: number;
+    noSaleCount: number;
+    expectedCash: number;
+    countedDrawerCount: number;
+    countedCash: number;
+    variance: number;
+    uncountedDrawerCount: number;
+    pendingApprovalCount: number;
+}
+export interface PosReportTenders extends PosReportHeader {
+    tenders: {
+        rows: PosReportTenderRow[];
+        drawer: PosReportDrawer;
+    };
+}
+export interface PosReportRegister {
+    registerId: string;
+    registerName: string | null;
+    drawerCount: number;
+    openDrawerCount: number;
+    uncountedDrawerCount: number;
+    figures: PosReportFigures;
+    variance: number;
+}
+export interface PosReportLocation {
+    stockLocationId: string | null;
+    name: string | null;
+    figures: PosReportFigures;
+    variance: number;
+    registers: PosReportRegister[];
+}
+export interface PosReportLocations extends PosReportHeader {
+    locations: PosReportLocation[];
+}
+export interface PosReportHour {
+    /** 0-23 in each drawer's own time zone. */
+    hour: number;
+    saleCount: number;
+    itemCount: number;
+    salesTotal: number;
+}
+export interface PosReportHours extends PosReportHeader {
+    hours: PosReportHour[];
+}
+export interface PosReportCashier extends PosReportCashierActivity {
+    staffId: string | null;
+    name: string | null;
+    /** A connected system's own reference for the person, as it gave it. */
+    externalRef: string | null;
+    saleCount: number;
+    itemCount: number;
+    salesTotal: number;
+    cashRefundCount: number;
+    cashRefunds: number;
+}
+export interface PosReportCashiers extends PosReportHeader {
+    cashiers: {
+        rows: PosReportCashier[];
+        refundsNotAttributed: number;
+    };
+}
+export interface PosReportCashierActivity {
+    /** Returns, voids and exchanges processed (returns without a receipt included). */
+    returnCount: number;
+    returnGross: number;
+    /** Returns approved as the manager. */
+    returnApprovalCount: number;
+    /** Till discounts the store's discount log names this staff member for. */
+    tillDiscountCount: number;
+    tillDiscountGross: number;
+}
+/** How a product page is sorted, each descending. */
+export type PosReportProductSort = 'NET_GROSS' | 'QUANTITY' | 'RETURNED';
+export interface PosReportProductOptions extends ListOptions {
+    sort?: PosReportProductSort;
+}
+export interface PosReportProduct {
+    productVariantId: string;
+    productId: string | null;
+    /** "Custom items" for the custom item carrier. */
+    name: string;
+    sku: string | null;
+    customItems: boolean;
+    soldQuantity: number;
+    returnedQuantity: number;
+    netQuantity: number;
+    listGross: number;
+    /** Promotions, coupons and till discounts on the sold lines. */
+    discounts: number;
+    salesGross: number;
+    returnedGross: number;
+    netGross: number;
+    netOfTax: number;
+    tax: number;
+}
+export interface PosReportProductTotals {
+    soldQuantity: number;
+    returnedQuantity: number;
+    listGross: number;
+    discounts: number;
+    salesGross: number;
+    returnedGross: number;
+    netGross: number;
+    netOfTax: number;
+    tax: number;
+}
+/** A page of product rows, with the report's header and the totals over every row. */
+export interface PosReportProductsPage extends Page<PosReportProduct> {
+    report: PosReportHeader;
+    totals: PosReportProductTotals;
+}
+export interface PosReportTaxRow {
+    description: string;
+    taxRate: number;
+    pricesIncludeTax: boolean | null;
+    salesGross: number;
+    salesNet: number;
+    salesTax: number;
+    returnsGross: number;
+    returnsNet: number;
+    returnsTax: number;
+    /** Money-only refunds, apportioned over the refunded sale's rates. */
+    apportionedRefundsGross: number;
+    apportionedRefundsNet: number;
+    apportionedRefundsTax: number;
+    netGross: number;
+    netNet: number;
+    /** The tax to file: Σ per receipt. */
+    netTax: number;
+    taxOnTotal: number | null;
+    rounding: number | null;
+}
+export interface PosReportTax extends PosReportHeader {
+    tax: {
+        rows: PosReportTaxRow[];
+        days: Array<{
+            businessDay: string;
+            rows: PosReportTaxRow[];
+        }>;
+        lineAllocationRounding: number;
+    };
+}
+export interface PosReportReturns extends PosReportHeader {
+    returns: {
+        /** False: the store keeps no returns record (only returns without a receipt count). */
+        available: boolean;
+        /** `return`, `void`, `exchange`, `back_office`, `no_receipt`; more may come. */
+        kinds: Array<{
+            kind: string;
+            returnCount: number;
+            gross: number;
+        }>;
+        reasons: Array<{
+            reasonCode: string;
+            lineCount: number;
+            quantity: number;
+            gross: number;
+        }>;
+        restockedQuantity: number;
+        writtenOffQuantity: number;
+        gross: number;
+        awaitingSettlementCount: number;
+        awaitingSettlementGross: number;
+        noReceiptCount: number;
+        noReceiptGross: number;
+        noReceiptCashGross: number;
+        noReceiptStoreCreditGross: number;
+    };
+}
+export interface PosReportDiscounts extends PosReportHeader {
+    discounts: {
+        tillGross: number;
+        tillNet: number;
+        tillSaleCount: number;
+        /** False: the store keeps no discount log. */
+        reasonsAvailable: boolean;
+        reasons: Array<{
+            reasonCode: string | null;
+            reasonName: string | null;
+            count: number;
+            gross: number;
+            net: number;
+        }>;
+        /** Till discounts no log row names. */
+        notLoggedGross: number;
+        promotions: Array<{
+            description: string;
+            lineCount: number;
+            gross: number;
+            net: number;
+        }>;
+        promotionsGross: number;
+    };
+}
+export interface PosReportsModule {
+    /** By business day, reconciled to the Zs, with the range's totals and reconciliation. */
+    summary(input?: PosReportInput, options?: Call): Promise<PosReportSummary>;
+    /** By tender (each payment method), and the drawers' cash. */
+    tenders(input?: PosReportInput, options?: Call): Promise<PosReportTenders>;
+    /** By location, each register under it. */
+    locations(input?: PosReportInput, options?: Call): Promise<PosReportLocations>;
+    /** 24 rows, each drawer's sales in its own zone's hour. */
+    hours(input?: PosReportInput, options?: Call): Promise<PosReportHours>;
+    /** By the cashier who completed each sale. */
+    cashiers(input?: PosReportInput, options?: Call): Promise<PosReportCashiers>;
+    /**
+     * By product and variant, returns netted, a page at a time (`limit` 1-200, 50 by default;
+     * `after` an offset cursor), with the totals over every row. `POS_REPORT_TOO_LARGE` above
+     * 250,000 sold lines: choose fewer days or one location.
+     */
+    products(input?: PosReportInput, options?: PosReportProductOptions): Promise<PosReportProductsPage>;
+    /** By tax rate, per business day and for the window (`POS_REPORT_TOO_LARGE` as products). */
+    tax(input?: PosReportInput, options?: Call): Promise<PosReportTax>;
+    /** Returns and voids, returns without a receipt. */
+    returns(input?: PosReportInput, options?: Call): Promise<PosReportReturns>;
+    /** Till discounts by reason, promotions by description (`POS_REPORT_TOO_LARGE` as products). */
+    discounts(input?: PosReportInput, options?: Call): Promise<PosReportDiscounts>;
+}
+export declare const POS_REPORT_FIGURES_FIELDS = "saleCount itemCount salesTotal cash card other cashRefunds cardRefunds otherRefunds refundsAfterClose net cashRounding exchangeCredit noReceiptReturns giftCardsSold giftCardsSoldCount storeCreditIssued storeCreditIssuedCount";
+export declare const POS_REPORT_SUMMARY_QUERY: string;
+export declare const POS_REPORT_TENDERS_QUERY: string;
+export declare const POS_REPORT_LOCATIONS_QUERY: string;
+export declare const POS_REPORT_HOURS_QUERY: string;
+export declare const POS_REPORT_CASHIERS_QUERY: string;
+export declare const POS_REPORT_PRODUCTS_QUERY = "query PosReportProducts($input: PosReportInput, $products: PosReportProductsInput) { posReport(input: $input) { fromDay toDay currencyCode stockLocationId registerId generatedAt drawerCount openDrawerCount otherCurrencySaleCount products(input: $products) { items { productVariantId productId name sku customItems netQuantity soldQuantity returnedQuantity listGross discounts salesGross returnedGross netGross netOfTax tax } totalItems totals { soldQuantity returnedQuantity listGross discounts salesGross returnedGross netGross netOfTax tax } } } }";
+export declare const POS_REPORT_TAX_QUERY: string;
+export declare const POS_REPORT_RETURNS_QUERY: string;
+export declare const POS_REPORT_DISCOUNTS_QUERY: string;
+/** A product page: at most this many rows. */
+export declare const POS_REPORT_PRODUCTS_MAX_PAGE = 200;
+/** ... and this many when `limit` is omitted. */
+export declare const POS_REPORT_PRODUCTS_DEFAULT_PAGE = 50;
+/** `{ input }` when there is one, else nothing: the engine's defaults apply to an absent input. */
+export declare function reportVariables(input: PosReportInput | undefined): Record<string, unknown>;
+export declare function createPosReportsModule(transport: Transport): PosReportsModule;

package/dist/pos/reports.js

@@ -0,0 +1,62 @@
+import { pageFromVendureList, readOffsetCursor, } from '@sixtyninecommerce/core';
+const HEADER = 'fromDay toDay currencyCode stockLocationId registerId generatedAt drawerCount openDrawerCount otherCurrencySaleCount';
+export const POS_REPORT_FIGURES_FIELDS = 'saleCount itemCount salesTotal cash card other cashRefunds cardRefunds otherRefunds refundsAfterClose net cashRounding exchangeCredit noReceiptReturns giftCardsSold giftCardsSoldCount storeCreditIssued storeCreditIssuedCount';
+const ZCHECK = 'inZ notInZ live refundsAfterClose unexplained recomputedZCount';
+function reportQuery(name, section) {
+    return `query ${name}($input: PosReportInput) { posReport(input: $input) { ${HEADER} ${section} } }`;
+}
+export const POS_REPORT_SUMMARY_QUERY = reportQuery('PosReportSummary', `totals { ${POS_REPORT_FIGURES_FIELDS} } totalsCheck { ${ZCHECK} } days { businessDay drawerCount openDrawerCount uncountedDrawerCount figures { ${POS_REPORT_FIGURES_FIELDS} } zCheck { ${ZCHECK} } storeDayStatus storeDayMismatch } reconciliation { salesTotal paymentsBySale uncompletedCartPayments cashElsewhere }`);
+export const POS_REPORT_TENDERS_QUERY = reportQuery('PosReportTenders', 'tenders { rows { kind method methodName storedValue paymentCount payments refunds refundsAfterClose net } drawer { openingFloats cashSales cashRefunds cashRounding paidIn paidOut safeDrops floatAdjustments noSaleCount expectedCash countedDrawerCount countedCash variance uncountedDrawerCount pendingApprovalCount } }');
+export const POS_REPORT_LOCATIONS_QUERY = reportQuery('PosReportLocations', `locations { stockLocationId name figures { ${POS_REPORT_FIGURES_FIELDS} } variance registers { registerId registerName drawerCount openDrawerCount uncountedDrawerCount figures { ${POS_REPORT_FIGURES_FIELDS} } variance } }`);
+export const POS_REPORT_HOURS_QUERY = reportQuery('PosReportHours', 'hours { hour saleCount itemCount salesTotal }');
+export const POS_REPORT_CASHIERS_QUERY = reportQuery('PosReportCashiers', 'cashiers { rows { staffId name externalRef saleCount itemCount salesTotal cashRefundCount cashRefunds returnCount returnGross returnApprovalCount tillDiscountCount tillDiscountGross } refundsNotAttributed }');
+const PRODUCT_FIGURES = 'soldQuantity returnedQuantity listGross discounts salesGross returnedGross netGross netOfTax tax';
+export const POS_REPORT_PRODUCTS_QUERY = `query PosReportProducts($input: PosReportInput, $products: PosReportProductsInput) { posReport(input: $input) { ${HEADER} products(input: $products) { items { productVariantId productId name sku customItems netQuantity ${PRODUCT_FIGURES} } totalItems totals { ${PRODUCT_FIGURES} } } } }`;
+const TAX_ROW = 'description taxRate pricesIncludeTax salesGross salesNet salesTax returnsGross returnsNet returnsTax apportionedRefundsGross apportionedRefundsNet apportionedRefundsTax netGross netNet netTax taxOnTotal rounding';
+export const POS_REPORT_TAX_QUERY = reportQuery('PosReportTax', `tax { rows { ${TAX_ROW} } days { businessDay rows { ${TAX_ROW} } } lineAllocationRounding }`);
+export const POS_REPORT_RETURNS_QUERY = reportQuery('PosReportReturns', 'returns { available kinds { kind returnCount gross } reasons { reasonCode lineCount quantity gross } restockedQuantity writtenOffQuantity gross awaitingSettlementCount awaitingSettlementGross noReceiptCount noReceiptGross noReceiptCashGross noReceiptStoreCreditGross }');
+export const POS_REPORT_DISCOUNTS_QUERY = reportQuery('PosReportDiscounts', 'discounts { tillGross tillNet tillSaleCount reasonsAvailable reasons { reasonCode reasonName count gross net } notLoggedGross promotions { description lineCount gross net } promotionsGross }');
+/** A product page: at most this many rows. */
+export const POS_REPORT_PRODUCTS_MAX_PAGE = 200;
+/** ... and this many when `limit` is omitted. */
+export const POS_REPORT_PRODUCTS_DEFAULT_PAGE = 50;
+/** `{ input }` when there is one, else nothing: the engine's defaults apply to an absent input. */
+export function reportVariables(input) {
+    if (!input)
+        return {};
+    const sent = Object.fromEntries(Object.entries(input).filter(([, value]) => value !== undefined && value !== ''));
+    return Object.keys(sent).length === 0 ? {} : { input: sent };
+}
+export function createPosReportsModule(transport) {
+    const read = async (query, input, options) => {
+        const data = await transport.graphql({ api: 'admin', query, variables: reportVariables(input) }, options);
+        return data.posReport;
+    };
+    return {
+        summary: (input, options) => read(POS_REPORT_SUMMARY_QUERY, input, options),
+        tenders: (input, options) => read(POS_REPORT_TENDERS_QUERY, input, options),
+        locations: (input, options) => read(POS_REPORT_LOCATIONS_QUERY, input, options),
+        hours: (input, options) => read(POS_REPORT_HOURS_QUERY, input, options),
+        cashiers: (input, options) => read(POS_REPORT_CASHIERS_QUERY, input, options),
+        tax: (input, options) => read(POS_REPORT_TAX_QUERY, input, options),
+        returns: (input, options) => read(POS_REPORT_RETURNS_QUERY, input, options),
+        discounts: (input, options) => read(POS_REPORT_DISCOUNTS_QUERY, input, options),
+        products: (input, options) => {
+            const take = Math.min(Math.max(Math.trunc(options?.limit ?? POS_REPORT_PRODUCTS_DEFAULT_PAGE), 1), POS_REPORT_PRODUCTS_MAX_PAGE);
+            const page = async (skip) => {
+                const data = await transport.graphql({
+                    api: 'admin',
+                    query: POS_REPORT_PRODUCTS_QUERY,
+                    variables: {
+                        ...reportVariables(input),
+                        products: { skip, take, ...(options?.sort ? { sort: options.sort } : {}) },
+                    },
+                }, options);
+                const { products, ...report } = data.posReport;
+                const listed = pageFromVendureList(products, skip, take, (cursor) => page(readOffsetCursor(cursor)));
+                return Object.assign(listed, { report, totals: products.totals });
+            };
+            return page(options?.after === undefined ? 0 : readOffsetCursor(options.after));
+        },
+    };
+}