@sixtyninecommerce/admin 0.10.0 → 0.11.0

package/dist/quotes/index.js

@@ -0,0 +1,439 @@
+/**
+ * `admin.quotes`: B2B quotes, from the draft a sales rep builds to the order it converts into
+ * (headless spec §9.2 `quotes`; plan W10-35a).
+ *
+ * A quote is a store's offer to one customer, in one currency (`currencyCode`, one of the store's
+ * currencies). Staff build it (`createDraft`, `lines.*`, `setPricing`), move it through its
+ * statuses (`submit`, `approve`, `decline`, `cancel`) and turn an approved one into an order
+ * awaiting payment (`convertToOrder`). A customer can also request one from the storefront; it
+ * arrives `requested`.
+ *
+ * **The engine answers what can be done.** `Quote.editable` says whether the lines and prices may
+ * still change (every line and pricing method refuses `QUOTE_NOT_EDITABLE` exactly when it is
+ * false), and `Quote.convertible` whether `convertToOrder` would create the order now. Show the
+ * buttons from them; never re-derive either from the status.
+ *
+ * **Money** is an integer in minor units of the QUOTE's `currencyCode`. A line's `unitPrice`, its
+ * fixed discount, `discountAmount` and `effectiveUnitPrice` are in the store's primary tax mode
+ * (gross on a store whose prices include tax, net otherwise); `lineTotal` / `lineTotalWithTax`
+ * are the explicit net and gross halves. A percentage discount is in basis points (1000 = 10%).
+ * Every figure is the engine's own maths: the quote PDF and the converted order use the same.
+ *
+ * **Refusals** (`PlatformError`, by `code`): `QUOTE_NOT_FOUND` (404) for a quote or line the store
+ * does not have, another store's included; `QUOTE_LINE_INVALID` (400, `details[0].field` names the
+ * input) for a quantity, unit price, variant or pricing line it refuses; `QUOTE_DISCOUNT_INVALID`
+ * (400); `QUOTE_NOT_EDITABLE` (422); `QUOTE_CONVERT_STATE_INVALID` (422); `QUOTE_CURRENCY_MISMATCH`,
+ * `CURRENCY_NOT_AVAILABLE`, `ORDER_LINE_VARIANT_UNPRICED` (a line priced from the catalogue for a
+ * variant the store has no price for) and `HUB_HAS_NO_ORDERS` / `ORGANIZATION_WORKSPACE_NOT_A_STORE`
+ * (an organization workspace keeps no quotes). Each passes through as the engine sent it.
+ *
+ * Every value set below grows over time: treat a status this version does not name as one with
+ * no action (the engine's `editable` / `convertible` stay authoritative).
+ */
+import { idempotencyKey as mintIdempotencyKey, UpstreamError, } from '@sixtyninecommerce/core';
+import { fieldOf } from '../catalog/types.js';
+import { redactionWatcher } from '../customer-data-redaction.js';
+export const QUOTE_STATUSES = [
+    'draft',
+    'requested',
+    'in_review',
+    'approved',
+    'declined',
+    'expired',
+    'converted_to_order',
+    'cancelled',
+];
+const LINE_FIELDS = /* GraphQL */ `
+  id
+  productVariantId
+  quantity
+  unitPrice
+  discountType
+  discountValue
+  discountLabel
+  position
+  discountAmount
+  effectiveUnitPrice
+  lineTotal
+  lineTotalWithTax
+  taxAmount
+  taxRate
+  createdAt
+  updatedAt
+  productVariant {
+    id
+    name
+    sku
+    storePrice {
+      price
+      priceWithTax
+    }
+    product {
+      id
+      name
+      featuredAsset {
+        id
+        preview
+      }
+    }
+  }
+`;
+const DOCUMENT_FIELDS = /* GraphQL */ `
+  id
+  documentNumber
+  fileSize
+  generatedAt
+  lastSentAt
+`;
+export const QUOTE_FIELDS = /* GraphQL */ `
+  id
+  code
+  customerId
+  currencyCode
+  status
+  editable
+  convertible
+  expiresAt
+  validUntil
+  salesRepUserId
+  customerNotes
+  internalNotes
+  convertedOrderId
+  createdAt
+  updatedAt
+  customer {
+    id
+    firstName
+    lastName
+    emailAddress
+    addresses {
+      company
+      defaultBillingAddress
+      defaultShippingAddress
+    }
+  }
+  salesRep {
+    id
+    userId
+    firstName
+    lastName
+    emailAddress
+  }
+  lines {
+    ${LINE_FIELDS}
+  }
+  document {
+    ${DOCUMENT_FIELDS}
+  }
+`;
+export const QUOTES_LIST_QUERY = /* GraphQL */ `
+  query QuotesList($options: AdminQuoteListOptions) {
+    quotes(options: $options) {
+      items {
+        ${QUOTE_FIELDS}
+      }
+      totalItems
+    }
+  }
+`;
+/**
+ * The detail read adds what costs per read: the signed PDF link (a storage round trip) and each
+ * line's price-list suggestion (the price-list strategy per line). The list never selects them.
+ */
+export const QUOTE_GET_QUERY = /* GraphQL */ `
+  query QuotesGet($id: ID!) {
+    quote(id: $id) {
+      ${QUOTE_FIELDS}
+      document {
+        downloadUrl
+      }
+      lines {
+        id
+        suggestedUnitPrice
+      }
+      statusLogs {
+        id
+        status
+        createdAt
+        actorUserId
+        metadata
+      }
+    }
+  }
+`;
+export const QUOTE_CREATE_DRAFT_MUTATION = /* GraphQL */ `
+  mutation QuotesCreateDraft($input: CreateDraftQuoteInput!) {
+    createDraftQuote(input: $input) {
+      ${QUOTE_FIELDS}
+    }
+  }
+`;
+export const QUOTE_ADD_LINE_MUTATION = /* GraphQL */ `
+  mutation QuotesAddLine($quoteId: ID!, $input: AddQuoteLineInput!) {
+    addQuoteLine(quoteId: $quoteId, input: $input) {
+      ${QUOTE_FIELDS}
+    }
+  }
+`;
+export const QUOTE_UPDATE_LINE_MUTATION = /* GraphQL */ `
+  mutation QuotesUpdateLine($lineId: ID!, $input: UpdateQuoteLineInput!) {
+    updateQuoteLine(lineId: $lineId, input: $input) {
+      ${QUOTE_FIELDS}
+    }
+  }
+`;
+export const QUOTE_REMOVE_LINE_MUTATION = /* GraphQL */ `
+  mutation QuotesRemoveLine($lineId: ID!) {
+    removeQuoteLine(lineId: $lineId) {
+      ${QUOTE_FIELDS}
+    }
+  }
+`;
+export const QUOTE_SET_PRICING_MUTATION = /* GraphQL */ `
+  mutation QuotesSetPricing($quoteId: ID!, $input: SetQuotePricingInput!) {
+    setQuotePricing(quoteId: $quoteId, input: $input) {
+      ${QUOTE_FIELDS}
+    }
+  }
+`;
+export const QUOTE_EXTEND_VALIDITY_MUTATION = /* GraphQL */ `
+  mutation QuotesExtendValidity($quoteId: ID!, $input: ExtendQuoteValidityInput!) {
+    extendQuoteValidity(quoteId: $quoteId, input: $input) {
+      ${QUOTE_FIELDS}
+    }
+  }
+`;
+export const QUOTE_ASSIGN_SALES_REP_MUTATION = /* GraphQL */ `
+  mutation QuotesAssignSalesRep($quoteId: ID!, $salesRepUserId: ID) {
+    assignQuoteSalesRep(quoteId: $quoteId, salesRepUserId: $salesRepUserId) {
+      ${QUOTE_FIELDS}
+    }
+  }
+`;
+export const QUOTE_SALES_REPRESENTATIVES_QUERY = /* GraphQL */ `
+  query QuotesSalesRepresentatives($search: String) {
+    quoteSalesRepresentatives(search: $search) {
+      id
+      userId
+      firstName
+      lastName
+      emailAddress
+    }
+  }
+`;
+export const QUOTE_SUBMIT_MUTATION = /* GraphQL */ `
+  mutation QuotesSubmit($quoteId: ID!) {
+    submitQuoteForReview(quoteId: $quoteId) {
+      ${QUOTE_FIELDS}
+    }
+  }
+`;
+export const QUOTE_APPROVE_MUTATION = /* GraphQL */ `
+  mutation QuotesApprove($quoteId: ID!) {
+    approveQuote(quoteId: $quoteId) {
+      ${QUOTE_FIELDS}
+    }
+  }
+`;
+export const QUOTE_DECLINE_MUTATION = /* GraphQL */ `
+  mutation QuotesDecline($quoteId: ID!, $reason: String!) {
+    declineQuote(quoteId: $quoteId, reason: $reason) {
+      ${QUOTE_FIELDS}
+    }
+  }
+`;
+export const QUOTE_CANCEL_MUTATION = /* GraphQL */ `
+  mutation QuotesCancel($quoteId: ID!, $reason: String) {
+    cancelQuote(quoteId: $quoteId, reason: $reason) {
+      ${QUOTE_FIELDS}
+    }
+  }
+`;
+export const QUOTE_CONVERT_MUTATION = /* GraphQL */ `
+  mutation QuotesConvertToOrder($quoteId: ID!, $idempotencyKey: String) {
+    convertQuoteToOrder(quoteId: $quoteId, idempotencyKey: $idempotencyKey) {
+      id
+      code
+      state
+      currencyCode
+      totalWithTax
+    }
+  }
+`;
+export const QUOTE_GENERATE_DOCUMENT_MUTATION = /* GraphQL */ `
+  mutation QuotesGenerateDocument($quoteId: ID!) {
+    generateQuoteDocument(quoteId: $quoteId) {
+      ${DOCUMENT_FIELDS}
+    }
+  }
+`;
+export const QUOTE_SEND_TO_CUSTOMER_MUTATION = /* GraphQL */ `
+  mutation QuotesSendToCustomer($quoteId: ID!) {
+    sendQuoteToCustomer(quoteId: $quoteId)
+  }
+`;
+const QUOTE_CONFIG_FIELDS = /* GraphQL */ `
+  id
+  channelId
+  numberPrefix
+  numberSuffix
+  numberDigits
+  yearFormat
+  yearReset
+  lastResetYear
+  documentTitle
+  footerText
+  validityNoticeTemplate
+  columnProduct
+  columnSku
+  columnQuantity
+  columnUnitPriceExcl
+  columnUnitPriceDiscount
+  columnUnitPriceIncl
+  columnUnitPriceAfterDiscount
+  columnLineTotal
+  columnLineDiscount
+  columnTaxRate
+  columnTaxAmount
+  columnTotal
+  showLogo
+  defaultLanguage
+  termsTitle
+  termsBody
+  acceptanceInstructions
+`;
+export const QUOTE_CONFIG_QUERY = /* GraphQL */ `
+  query QuotesConfig {
+    quoteConfig {
+      ${QUOTE_CONFIG_FIELDS}
+    }
+  }
+`;
+export const QUOTE_UPDATE_CONFIG_MUTATION = /* GraphQL */ `
+  mutation QuotesUpdateConfig($input: UpdateQuoteConfigInput!) {
+    updateQuoteConfig(input: $input) {
+      ${QUOTE_CONFIG_FIELDS}
+    }
+  }
+`;
+export const QUOTE_SETTINGS_QUERY = /* GraphQL */ `
+  query QuotesSettings {
+    activeChannel {
+      id
+      defaultCurrencyCode
+      availableCurrencyCodes
+      customFields {
+        quotesEnabled
+      }
+    }
+  }
+`;
+function unexpected(field) {
+    return new UpstreamError({
+        code: 'UNEXPECTED_RESPONSE',
+        message: `The engine answered without "${field}".`,
+        status: 502,
+        service: 'vendure',
+    });
+}
+/** The key a caller retries under, on an error of a call whose key it did not choose. */
+function withAttemptKey(error, key) {
+    if (error !== null && typeof error === 'object' && !('idempotencyKey' in error)) {
+        Object.defineProperty(error, 'idempotencyKey', { value: key, enumerable: true });
+    }
+    return error;
+}
+export function createQuotesModule(transport) {
+    /** One quote-answering call: the redaction stamp, and the field required. */
+    async function quoteCall(document, field, variables, options) {
+        const redaction = redactionWatcher();
+        const data = await transport.graphql({ api: 'admin', query: document, variables, onExtensions: redaction.onExtensions }, options);
+        const quote = data?.[field];
+        if (quote == null)
+            throw unexpected(field);
+        return redaction.mark(quote);
+    }
+    const lines = {
+        add: (quoteId, input, options) => quoteCall(QUOTE_ADD_LINE_MUTATION, 'addQuoteLine', { quoteId, input }, options),
+        update: (lineId, input, options) => quoteCall(QUOTE_UPDATE_LINE_MUTATION, 'updateQuoteLine', { lineId, input }, options),
+        remove: (lineId, options) => quoteCall(QUOTE_REMOVE_LINE_MUTATION, 'removeQuoteLine', { lineId }, options),
+    };
+    const config = {
+        get: (options) => fieldOf(transport, QUOTE_CONFIG_QUERY, 'quoteConfig', {}, options),
+        update: (input, options) => fieldOf(transport, QUOTE_UPDATE_CONFIG_MUTATION, 'updateQuoteConfig', { input }, options),
+    };
+    const settings = {
+        async get(options) {
+            const channel = await fieldOf(transport, QUOTE_SETTINGS_QUERY, 'activeChannel', {}, options);
+            if (!channel)
+                throw unexpected('activeChannel');
+            return {
+                quotesEnabled: channel.customFields?.quotesEnabled === true,
+                defaultCurrencyCode: channel.defaultCurrencyCode,
+                availableCurrencyCodes: channel.availableCurrencyCodes ?? [channel.defaultCurrencyCode],
+            };
+        },
+    };
+    return {
+        async list(options) {
+            const { take, skip, status, customerId, code, ...call } = options ?? {};
+            const redaction = redactionWatcher();
+            const data = await transport.graphql({
+                api: 'admin',
+                query: QUOTES_LIST_QUERY,
+                variables: { options: { take, skip, status, customerId, code } },
+                onExtensions: redaction.onExtensions,
+            }, call);
+            if (data?.quotes == null)
+                throw unexpected('quotes');
+            return {
+                items: data.quotes.items.map((quote) => redaction.mark(quote)),
+                totalItems: data.quotes.totalItems,
+            };
+        },
+        async get(quoteId, options) {
+            const redaction = redactionWatcher();
+            const data = await transport.graphql({
+                api: 'admin',
+                query: QUOTE_GET_QUERY,
+                variables: { id: quoteId },
+                onExtensions: redaction.onExtensions,
+            }, options);
+            const quote = data?.quote ?? null;
+            // `document` and `lines` are selected twice; GraphQL merges each into one object.
+            return quote ? redaction.mark(quote) : null;
+        },
+        createDraft: (input, options) => quoteCall(QUOTE_CREATE_DRAFT_MUTATION, 'createDraftQuote', { input }, options),
+        lines,
+        setPricing: (quoteId, input, options) => quoteCall(QUOTE_SET_PRICING_MUTATION, 'setQuotePricing', { quoteId, input }, options),
+        extendValidity: (quoteId, input, options) => quoteCall(QUOTE_EXTEND_VALIDITY_MUTATION, 'extendQuoteValidity', { quoteId, input }, options),
+        assignSalesRep: (quoteId, salesRepUserId, options) => quoteCall(QUOTE_ASSIGN_SALES_REP_MUTATION, 'assignQuoteSalesRep', { quoteId, salesRepUserId }, options),
+        salesRepresentatives: (term, options) => fieldOf(transport, QUOTE_SALES_REPRESENTATIVES_QUERY, 'quoteSalesRepresentatives', { search: term?.trim() ? term.trim() : null }, options),
+        submit: (quoteId, options) => quoteCall(QUOTE_SUBMIT_MUTATION, 'submitQuoteForReview', { quoteId }, options),
+        approve: (quoteId, options) => quoteCall(QUOTE_APPROVE_MUTATION, 'approveQuote', { quoteId }, options),
+        decline: (quoteId, reason, options) => quoteCall(QUOTE_DECLINE_MUTATION, 'declineQuote', { quoteId, reason }, options),
+        cancel: (quoteId, reason, options) => quoteCall(QUOTE_CANCEL_MUTATION, 'cancelQuote', { quoteId, reason: reason ?? null }, options),
+        async convertToOrder(quoteId, options) {
+            const key = options?.idempotencyKey ?? mintIdempotencyKey();
+            try {
+                const data = await transport.graphql({
+                    api: 'admin',
+                    query: QUOTE_CONVERT_MUTATION,
+                    variables: { quoteId, idempotencyKey: key },
+                }, { ...options, idempotencyKey: key });
+                if (data?.convertQuoteToOrder == null)
+                    throw unexpected('convertQuoteToOrder');
+                return { ...data.convertQuoteToOrder, idempotencyKey: key };
+            }
+            catch (error) {
+                throw withAttemptKey(error, key);
+            }
+        },
+        generateDocument: (quoteId, options) => fieldOf(transport, QUOTE_GENERATE_DOCUMENT_MUTATION, 'generateQuoteDocument', { quoteId }, options),
+        async sendToCustomer(quoteId, options) {
+            await fieldOf(transport, QUOTE_SEND_TO_CUSTOMER_MUTATION, 'sendQuoteToCustomer', { quoteId }, options);
+        },
+        config,
+        settings,
+    };
+}

package/dist/reports/index.d.ts

@@ -1,5 +1,6 @@
 import { type OrderScope, type Page, type Transport } from '@sixtyninecommerce/core';
 import type { BulkModule, BulkOperation } from '../bulk/index.js';
+import { type FoundVariant } from '../catalog/variant-find.js';
 import type { JobHandle, JobsModule } from '../jobs/index.js';
 import type { Call, ListOptions } from '../types.js';
 /**
@@ -19,8 +20,22 @@ export interface ReportPeriod {
     from: string;
     to: string;
 }
+/**
+ * The last `lastDays` days of the STORE's calendar, ending on the store's today:
+ * the day it is now in the store's time zone (`Channel.customFields.timezone`,
+ * else Europe/Amsterdam), never yours, never UTC. `{ lastDays: 1 }` is the
+ * store's today so far. Whole local days, so a DST day is 23 or 25 hours long;
+ * compared against the `lastDays` days before. A whole number from 1 to 366.
+ *
+ * Needs an engine that knows `lastDays` (vendure-server deployed with it); an
+ * older one refuses the request as a GraphQL validation error.
+ */
+export interface ReportLastDays {
+    lastDays: number;
+}
 export interface ReportOverviewInput {
-    period: ReportPeriod;
+    /** A `from`/`to` range, or the store's last N days. */
+    period: ReportPeriod | ReportLastDays;
     /**
      * One stock location of this store (`stockLocationId`). Keeps the orders whose
      * stock was allocated or sold there, or that stated it at entry; an order
@@ -100,11 +115,12 @@ export interface PopularVariantsInput {
     /** 1–3650, default 90. */
     sinceDays?: number;
 }
-export interface PopularVariant {
-    id: string;
+/**
+ * A best-selling variant, as a picker shows it: `catalog.variants.find`'s variant (store price,
+ * stock, product), plus its `productId`.
+ */
+export interface PopularVariant extends FoundVariant {
     productId: string;
-    name: string;
-    sku: string;
 }
 export interface LowStockInput extends ListOptions {
     /** Rows whose `available` is at or below this; a whole number, 0–1,000,000. */
@@ -166,12 +182,27 @@ export type ReportExport = Omit<BulkOperation, 'entity'> & {
  * `admin.platform.reports.fleet` (SuperAdmin session only).
  */
 export interface ReportsModule {
-    /** Orders, revenue and customers of a period, by the store's own days. */
+    /**
+     * Orders, revenue and customers of a period, by the store's own days. Needs `ReadOrder`.
+     *
+     * Refused before anything is asked, `INVALID_REPORT_PERIOD` (`ValidationError`, 400):
+     * `lastDays` that is not a whole number from 1 to 366, or a period carrying both `lastDays`
+     * and `from`/`to`. The engine refuses the same, and a malformed `from`/`to`.
+     *
+     * @effect read
+     */
     overview(input: ReportOverviewInput, options?: Call): Promise<ReportOverview>;
     /**
      * Variants ranked by units sold in placed orders of the last `sinceDays`
      * days, most first. A `Page` because every list is one; it is always a
      * single, final page.
+     *
+     * Each variant carries what a picker shows: its store price (null when the store has none,
+     * priced in the call's `tenant.currency` when one is named), its stock and its product. A
+     * hidden carrier variant is never ranked, and a variant the store no longer holds is left out,
+     * so the list can be shorter than `take`. Needs `ReadOrder`.
+     *
+     * @effect read
      */
     popularVariants(input?: PopularVariantsInput, options?: Call): Promise<Page<PopularVariant>>;
     /**
@@ -189,10 +220,42 @@ export interface ReportsModule {
      * restriction withholds.
      */
     export(kind: ReportExportKind, filter: ReportExportFilter, options?: Call): Promise<JobHandle<ReportExport>>;
+    /**
+     * Accounts-receivable aging: every customer who owes on an AR invoice, their outstanding split
+     * into buckets by days past due (against the store's today), one row per customer and
+     * currency, never summed across currencies. An ERP-linked customer's figures come from the
+     * ERP's mirrored invoices (`erpLinked`). Needs `ReadOrder`.
+     *
+     * @effect read
+     * @permission ReadOrder
+     */
+    arAging(options?: Call): Promise<ArAgingRow[]>;
 }
+/** One customer's outstanding AR, in one currency, by days past due. Minor units. */
+export interface ArAgingRow {
+    customerId: string;
+    customerName: string;
+    /** Not yet due. */
+    current: number;
+    d1_30: number;
+    d31_60: number;
+    d61_90: number;
+    d90_plus: number;
+    /** The sum of the buckets. */
+    total: number;
+    currencyCode: string;
+    /** True when the figures are the ERP's. */
+    erpLinked: boolean;
+}
+export declare const AR_AGING_QUERY = "\n  query ArAgingReport {\n    b2bArAgingReport {\n      customerId\n      customerName\n      current\n      d1_30\n      d31_60\n      d61_90\n      d90_plus\n      total\n      currencyCode\n      erpLinked\n    }\n  }\n";
 /** Only the §9.3 generation is selected — never the deprecated Float/String fields. */
-export declare const REPORT_OVERVIEW_QUERY = "\n  query ReportOverview($range: ReportPeriodInput!, $locationId: ID, $orderScope: OrderScope) {\n    commerceOverviewMetrics(range: $range, locationId: $locationId, orderScope: $orderScope) {\n      currencyCode\n      timeZone\n      from\n      to\n      previousFrom\n      previousTo\n      current { \n  orderCount\n  cancelledCount\n  revenueMinor\n  revenueNetMinor\n  averageOrderValueMinor\n  averageOrderValueNetMinor\n  ordersInOtherCurrencies\n }\n      previous { \n  orderCount\n  cancelledCount\n  revenueMinor\n  revenueNetMinor\n  averageOrderValueMinor\n  averageOrderValueNetMinor\n  ordersInOtherCurrencies\n }\n      revenueSeries { startsAt valueMinor valueNetMinor }\n      orderSeries { startsAt value }\n      newCustomers\n      previousNewCustomers\n      awaitingFulfillment\n      statusBreakdown { state count }\n      topProducts { productVariantId productId name sku unitsSold }\n    }\n  }\n";
-export declare const POPULAR_VARIANTS_QUERY = "\n  query ReportPopularVariants($take: Int, $sinceDays: Int) {\n    popularProductVariantsInChannel(take: $take, sinceDays: $sinceDays) {\n      id\n      productId\n      name\n      sku\n    }\n  }\n";
+export declare const REPORT_OVERVIEW_QUERY = "\n  query ReportOverview($range: ReportPeriodInput!, $locationId: ID, $orderScope: OrderScope) {\n    commerceOverviewMetrics(range: $range, locationId: $locationId, orderScope: $orderScope) {\n      \n      currencyCode\n      timeZone\n      from\n      to\n      previousFrom\n      previousTo\n      current { \n  orderCount\n  cancelledCount\n  revenueMinor\n  revenueNetMinor\n  averageOrderValueMinor\n  averageOrderValueNetMinor\n  ordersInOtherCurrencies\n }\n      previous { \n  orderCount\n  cancelledCount\n  revenueMinor\n  revenueNetMinor\n  averageOrderValueMinor\n  averageOrderValueNetMinor\n  ordersInOtherCurrencies\n }\n      revenueSeries { startsAt valueMinor valueNetMinor }\n      orderSeries { startsAt value }\n      newCustomers\n      previousNewCustomers\n      awaitingFulfillment\n      statusBreakdown { state count }\n      topProducts { productVariantId productId name sku unitsSold }\n\n    }\n  }\n";
+/**
+ * `lastDays` has a document of its own, so a `from`/`to` caller never sends an
+ * argument an engine without `lastDays` would refuse (each service deploys alone).
+ */
+export declare const REPORT_OVERVIEW_LAST_DAYS_QUERY = "\n  query ReportOverviewLastDays($lastDays: Int!, $locationId: ID, $orderScope: OrderScope) {\n    commerceOverviewMetrics(lastDays: $lastDays, locationId: $locationId, orderScope: $orderScope) {\n      \n      currencyCode\n      timeZone\n      from\n      to\n      previousFrom\n      previousTo\n      current { \n  orderCount\n  cancelledCount\n  revenueMinor\n  revenueNetMinor\n  averageOrderValueMinor\n  averageOrderValueNetMinor\n  ordersInOtherCurrencies\n }\n      previous { \n  orderCount\n  cancelledCount\n  revenueMinor\n  revenueNetMinor\n  averageOrderValueMinor\n  averageOrderValueNetMinor\n  ordersInOtherCurrencies\n }\n      revenueSeries { startsAt valueMinor valueNetMinor }\n      orderSeries { startsAt value }\n      newCustomers\n      previousNewCustomers\n      awaitingFulfillment\n      statusBreakdown { state count }\n      topProducts { productVariantId productId name sku unitsSold }\n\n    }\n  }\n";
+export declare const POPULAR_VARIANTS_QUERY = "\n  query ReportPopularVariants($take: Int, $sinceDays: Int) {\n    popularProductVariantsInChannel(take: $take, sinceDays: $sinceDays) {\n      productId\n      \n  \n  id\n  name\n  sku\n  enabled\n  storePrice {\n    price\n    priceWithTax\n    currencyCode\n  }\n  trackInventory\n  outOfStockThreshold\n  useGlobalOutOfStockThreshold\n  stockOnHand\n  stockAllocated\n  stockLevels {\n    stockLocationId\n    stockOnHand\n    stockAllocated\n    stockLocation {\n      id\n      name\n    }\n  }\n\n  product {\n    \n  id\n  name\n  slug\n  featuredAsset {\n    id\n    preview\n  }\n\n  }\n\n    }\n  }\n";
 export declare const LOW_STOCK_QUERY = "\n  query ReportLowStock($threshold: Int!, $locationId: ID, $options: LowStockVariantListOptions) {\n    lowStockVariants(threshold: $threshold, locationId: $locationId, options: $options) {\n      items {\n        productVariantId\n        productId\n        sku\n        name\n        stockLocationId\n        stockLocationName\n        stockOnHand\n        stockAllocated\n        reserved\n        available\n      }\n      totalItems\n    }\n  }\n";
 export declare function createReportsModule(transport: Transport, bulk: BulkModule, jobs: JobsModule, 
 /** The client's `tenant.location`, read per call (a derived client has its own). */

package/dist/reports/index.js

@@ -1,4 +1,23 @@
-import { createPage, pageFromVendureList, readOffsetCursor, } from '@sixtyninecommerce/core';
+import { createPage, pageFromVendureList, readOffsetCursor, ValidationError, } from '@sixtyninecommerce/core';
+import { FOUND_VARIANT_WITH_PRODUCT_FIELDS, toFoundVariant, } from '../catalog/variant-find.js';
+/** The longest period a report covers, in days (the engine's bound). */
+const MAX_REPORT_DAYS = 366;
+export const AR_AGING_QUERY = /* GraphQL */ `
+  query ArAgingReport {
+    b2bArAgingReport {
+      customerId
+      customerName
+      current
+      d1_30
+      d31_60
+      d61_90
+      d90_plus
+      total
+      currencyCode
+      erpLinked
+    }
+  }
+`;
 const TOTALS_FIELDS = /* GraphQL */ `
   orderCount
   cancelledCount
@@ -8,10 +27,7 @@ const TOTALS_FIELDS = /* GraphQL */ `
   averageOrderValueNetMinor
   ordersInOtherCurrencies
 `;
-/** Only the §9.3 generation is selected — never the deprecated Float/String fields. */
-export const REPORT_OVERVIEW_QUERY = /* GraphQL */ `
-  query ReportOverview($range: ReportPeriodInput!, $locationId: ID, $orderScope: OrderScope) {
-    commerceOverviewMetrics(range: $range, locationId: $locationId, orderScope: $orderScope) {
+const OVERVIEW_FIELDS = /* GraphQL */ `
       currencyCode
       timeZone
       from
@@ -27,16 +43,31 @@ export const REPORT_OVERVIEW_QUERY = /* GraphQL */ `
       awaitingFulfillment
       statusBreakdown { state count }
       topProducts { productVariantId productId name sku unitsSold }
+`;
+/** Only the §9.3 generation is selected — never the deprecated Float/String fields. */
+export const REPORT_OVERVIEW_QUERY = /* GraphQL */ `
+  query ReportOverview($range: ReportPeriodInput!, $locationId: ID, $orderScope: OrderScope) {
+    commerceOverviewMetrics(range: $range, locationId: $locationId, orderScope: $orderScope) {
+      ${OVERVIEW_FIELDS}
+    }
+  }
+`;
+/**
+ * `lastDays` has a document of its own, so a `from`/`to` caller never sends an
+ * argument an engine without `lastDays` would refuse (each service deploys alone).
+ */
+export const REPORT_OVERVIEW_LAST_DAYS_QUERY = /* GraphQL */ `
+  query ReportOverviewLastDays($lastDays: Int!, $locationId: ID, $orderScope: OrderScope) {
+    commerceOverviewMetrics(lastDays: $lastDays, locationId: $locationId, orderScope: $orderScope) {
+      ${OVERVIEW_FIELDS}
     }
   }
 `;
 export const POPULAR_VARIANTS_QUERY = /* GraphQL */ `
   query ReportPopularVariants($take: Int, $sinceDays: Int) {
     popularProductVariantsInChannel(take: $take, sinceDays: $sinceDays) {
-      id
       productId
-      name
-      sku
+      ${FOUND_VARIANT_WITH_PRODUCT_FIELDS}
     }
   }
 `;
@@ -60,6 +91,32 @@ export const LOW_STOCK_QUERY = /* GraphQL */ `
   }
 `;
 const DEFAULT_LOW_STOCK_PAGE = 50;
+function invalidPeriod(message) {
+    return new ValidationError({
+        code: 'INVALID_REPORT_PERIOD',
+        message,
+        status: 400,
+        service: 'vendure',
+    });
+}
+/** The overview's request for its period form, refused at the boundary like the engine would. */
+function overviewRequest(period) {
+    const given = (period ?? {});
+    if (given.lastDays === undefined) {
+        return {
+            query: REPORT_OVERVIEW_QUERY,
+            variables: { range: { from: given.from, to: given.to } },
+        };
+    }
+    if (given.from !== undefined || given.to !== undefined) {
+        throw invalidPeriod('Give either `lastDays` or `from`/`to`, not both: each one names the whole period.');
+    }
+    const { lastDays } = given;
+    if (!Number.isInteger(lastDays) || lastDays < 1 || lastDays > MAX_REPORT_DAYS) {
+        throw invalidPeriod(`\`lastDays\` must be a whole number from 1 to ${MAX_REPORT_DAYS}.`);
+    }
+    return { query: REPORT_OVERVIEW_LAST_DAYS_QUERY, variables: { lastDays } };
+}
 /** The bulk entity a report kind is exported as. */
 const EXPORT_ENTITY = { overview: 'report_overview' };
 /** Filter keys travel as the service spells them — see `bulk/index.ts`'s `FILTER_PASSTHROUGH`. */
@@ -79,13 +136,19 @@ clientLocation = () => undefined) {
         }, input);
         return pageFromVendureList(data.lowStockVariants, skip, take, (cursor) => lowStockPage(input, readOffsetCursor(cursor), take));
     };
+    const arAging = async (options) => {
+        const data = await transport.graphql({ api: 'admin', query: AR_AGING_QUERY }, options);
+        return data.b2bArAgingReport;
+    };
     return {
+        arAging,
         async overview(input, options) {
+            const request = overviewRequest(input.period);
             const data = await transport.graphql({
                 api: 'admin',
-                query: REPORT_OVERVIEW_QUERY,
+                query: request.query,
                 variables: {
-                    range: { from: input.period.from, to: input.period.to },
+                    ...request.variables,
                     locationId: input.locationId ?? null,
                     orderScope: input.orderScope ?? null,
                 },
@@ -111,7 +174,7 @@ clientLocation = () => undefined) {
                 query: POPULAR_VARIANTS_QUERY,
                 variables: { take: input?.take ?? null, sinceDays: input?.sinceDays ?? null },
             }, options);
-            const items = data.popularProductVariantsInChannel;
+            const items = data.popularProductVariantsInChannel.map((row) => ({ ...toFoundVariant(row), productId: row.productId }));
             return createPage(items, { nextCursor: null, hasNext: false, total: items.length }, () => {
                 // Unreachable while `hasNext` is false — `Page.next()` short-circuits.
                 throw new Error('popularVariants returns one ranked list; there is no next page');