@aglyn/plugins-commerce 1.0.0-beta.262 → 1.0.0-beta.263

package/src/lib/server/order-figures.js

@@ -15,7 +15,7 @@ import { _ as _extends } from "@swc/helpers/_/_extends";
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */ import { PLUGIN_FIGURE_MAX_ROWS, pluginFigureChange, pluginFigureWindows, registerPluginFigureReader } from "@aglyn/aglyn/plugin-manager/plugin-figures";
-import { figureCount, figureHasColumn, figurePlural, figureRanked, figureWithChange } from "@aglyn/aglyn/app-utils/weekly-summary";
+import { figureCount, figureHasColumn, figureRanked, figureStat } from "@aglyn/aglyn/app-utils/weekly-summary";
 import { BUNDLE_ID } from "../constants/bundle-common.js";
 import { orderWindowFigures, productSales } from "../model/order-figures.js";
 /** Orders one window reads; a store past it is told its figures read low. */ export const ORDER_FIGURES_WINDOW_CEILING = 1000;
@@ -76,23 +76,26 @@ export function orderFigureReaders(firestore) {
             feature: 'commerceAnalytics',
             weeklySummary: {
                 order: 70,
-                lines: (table)=>{
+                summarize: (table)=>{
                     const week = table.rows[0];
-                    if (!week || !figureHasColumn(table, 'revenue')) return [];
-                    const orders = figureCount(week['orders']);
-                    if (!orders && !figureCount(week['revenue'])) return [];
-                    return [
-                        `Sales: ${figureWithChange(table, week, 'revenue', 'revenueChange')} from ${figurePlural(orders, 'order', 'orders')}`
-                    ];
-                },
-                headline: (table)=>{
-                    var _table_rows_;
-                    const count = figureCount((_table_rows_ = table.rows[0]) == null ? void 0 : _table_rows_['orders']);
-                    return count ? {
-                        count,
-                        one: 'order',
-                        many: 'orders'
-                    } : null;
+                    if (!week || !figureHasColumn(table, 'revenue')) return null;
+                    if (!figureCount(week['orders']) && !figureCount(week['revenue'])) return null;
+                    return {
+                        title: 'Sales',
+                        stats: [
+                            figureStat(table, week, 'revenue', 'Revenue', {
+                                change: 'revenueChange'
+                            }),
+                            figureStat(table, week, 'orders', 'Orders', {
+                                change: 'ordersChange',
+                                total: {
+                                    one: 'order',
+                                    many: 'orders'
+                                }
+                            }),
+                            figureStat(table, week, 'averageOrder', 'Average order')
+                        ]
+                    };
                 }
             },
             read: async (request)=>{
@@ -183,11 +186,14 @@ export function orderFigureReaders(firestore) {
             feature: 'commerceAnalytics',
             weeklySummary: {
                 order: 80,
-                lines: (table)=>{
-                    const top = figureHasColumn(table, 'units') ? figureRanked(table, 'product', 'units', 'sold') : null;
-                    return top ? [
-                        `Top products: ${top}`
-                    ] : [];
+                summarize: (table)=>{
+                    const rows = figureHasColumn(table, 'units') ? figureRanked(table, 'product', 'units') : [];
+                    return rows.length ? {
+                        title: 'Top products',
+                        rows: rows.map((row)=>_extends({}, row, {
+                                value: `${row.value} sold`
+                            }))
+                    } : null;
                 }
             },
             read: async (request)=>{

package/src/lib/server/order-figures.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../../../../../libs/plugins/commerce/src/lib/server/order-figures.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 {\n  PLUGIN_FIGURE_MAX_ROWS,\n  pluginFigureChange,\n  pluginFigureWindows,\n  registerPluginFigureReader,\n  type PluginFigureReader,\n  type PluginFigureRequest,\n} from '@aglyn/aglyn/plugin-manager/plugin-figures'\nimport {\n  figureCount,\n  figureHasColumn,\n  figurePlural,\n  figureRanked,\n  figureWithChange,\n} from '@aglyn/aglyn/app-utils/weekly-summary'\nimport { BUNDLE_ID } from '../constants/bundle-common'\nimport {\n  orderWindowFigures,\n  productSales,\n  type OrderFigureSource,\n} from '../model/order-figures'\n\n/**\n * The store's sales figures for another plugin to read (AGL-2915): what the\n * Analytics tab's card shows, as tables on the `plugin-figures` seam. The\n * insight job reads them by id and never reads an order.\n *\n * A table carries sums and counts and product names — never a buyer, an\n * address or an order. Sold under `commerceAnalytics`, the entitlement the\n * card is sold under.\n */\n\ntype Firestore = FirebaseFirestore.Firestore\n\n/** Orders one window reads; a store past it is told its figures read low. */\nexport const ORDER_FIGURES_WINDOW_CEILING = 1_000\n\nconst WINDOWS: readonly number[] = [7, 14, 30, 90]\n\nconst SOURCE = { label: 'Store analytics', path: 'products/analytics' }\n\nasync function ordersBetween(\n  firestore: Firestore,\n  hostId: string,\n  startMs: number,\n  endMs: number,\n): Promise<{ orders: OrderFigureSource[]; truncated: boolean }> {\n  // `createdAtMs` is the field every order writer stamps and the one the\n  // orders group is indexed on; range and order on it need no composite index.\n  const snapshot = await firestore\n    .collection('hosts')\n    .doc(hostId)\n    .collection('orders')\n    .where('createdAtMs', '>=', startMs)\n    .where('createdAtMs', '<', endMs)\n    .orderBy('createdAtMs', 'desc')\n    .limit(ORDER_FIGURES_WINDOW_CEILING + 1)\n    .get()\n  const orders = snapshot.docs.map((doc) => ({ ...(doc.data() ?? {}), $id: doc.id }) as OrderFigureSource)\n  return {\n    orders: orders.slice(0, ORDER_FIGURES_WINDOW_CEILING),\n    truncated: orders.length > ORDER_FIGURES_WINDOW_CEILING,\n  }\n}\n\nconst dollars = (cents: number): number => Math.round(cents) / 100\n\nfunction ceilingNote(truncated: boolean): string[] {\n  return truncated\n    ? [\n        `The store took more than ${ORDER_FIGURES_WINDOW_CEILING.toLocaleString('en-US')} orders in a window, so its figures are summed over the most recent ${ORDER_FIGURES_WINDOW_CEILING.toLocaleString('en-US')} and read low.`,\n      ]\n    : []\n}\n\nfunction refusal(request: PluginFigureRequest) {\n  if (!request.hostId) return { ok: false as const, status: 400 as const, error: 'Open a site to read its sales' }\n  if (!WINDOWS.includes(request.days)) {\n    return { ok: false as const, status: 400 as const, error: 'That window is not one sales are read over' }\n  }\n  return null\n}\n\nexport function orderFigureReaders(firestore: () => Firestore): PluginFigureReader[] {\n  return [\n    {\n      id: 'commerce.sales',\n      label: 'Sales',\n      description:\n        'The store’s revenue, orders and average order over the window and the window before it, with the change in revenue and in orders. Pending, canceled and test orders are left out, and refunds come off.',\n      scope: 'site',\n      windows: WINDOWS,\n      feature: 'commerceAnalytics',\n      weeklySummary: {\n        order: 70,\n        lines: (table) => {\n          const week = table.rows[0]\n          if (!week || !figureHasColumn(table, 'revenue')) return []\n          const orders = figureCount(week['orders'])\n          if (!orders && !figureCount(week['revenue'])) return []\n          return [\n            `Sales: ${figureWithChange(table, week, 'revenue', 'revenueChange')} from ${figurePlural(orders, 'order', 'orders')}`,\n          ]\n        },\n        headline: (table) => {\n          const count = figureCount(table.rows[0]?.['orders'])\n          return count ? { count, one: 'order', many: 'orders' } : null\n        },\n      },\n      read: async (request) => {\n        const refused = refusal(request)\n        if (refused) return refused\n        const hostId = request.hostId as string\n        const { current, previous } = pluginFigureWindows(request.now, request.days)\n        const [now, before] = await Promise.all([\n          ordersBetween(firestore(), hostId, current.startMs, current.endMs),\n          ordersBetween(firestore(), hostId, previous.startMs, previous.endMs),\n        ])\n        const a = orderWindowFigures(now.orders, current.startMs, current.endMs)\n        const b = orderWindowFigures(before.orders, previous.startMs, previous.endMs)\n        return {\n          ok: true,\n          table: {\n            title: 'Sales',\n            source: SOURCE,\n            period: { from: current.from, to: current.to, days: request.days },\n            columns: [\n              { key: 'window', label: 'Window', kind: 'text' },\n              { key: 'revenue', label: 'Revenue', kind: 'money', currency: 'USD' },\n              { key: 'orders', label: 'Orders', kind: 'count' },\n              { key: 'averageOrder', label: 'Average order', kind: 'money', currency: 'USD' },\n              { key: 'revenueChange', label: 'Revenue change', kind: 'change' },\n              { key: 'ordersChange', label: 'Orders change', kind: 'change' },\n            ],\n            rows: [\n              {\n                window: `${current.from} to ${current.to}`,\n                revenue: dollars(a.revenueCents),\n                orders: a.orders,\n                averageOrder: dollars(a.averageCents),\n                revenueChange: pluginFigureChange(a.revenueCents, b.revenueCents),\n                ordersChange: pluginFigureChange(a.orders, b.orders),\n              },\n              {\n                window: `${previous.from} to ${previous.to}`,\n                revenue: dollars(b.revenueCents),\n                orders: b.orders,\n                averageOrder: dollars(b.averageCents),\n                revenueChange: null,\n                ordersChange: null,\n              },\n            ],\n            omitted: 0,\n            notes: ceilingNote(now.truncated || before.truncated),\n          },\n        }\n      },\n    },\n    {\n      id: 'commerce.products',\n      label: 'Top products',\n      description: 'The products that brought in the most over the window, with units sold and line revenue.',\n      scope: 'site',\n      windows: WINDOWS,\n      feature: 'commerceAnalytics',\n      weeklySummary: {\n        order: 80,\n        lines: (table) => {\n          const top = figureHasColumn(table, 'units') ? figureRanked(table, 'product', 'units', 'sold') : null\n          return top ? [`Top products: ${top}`] : []\n        },\n      },\n      read: async (request) => {\n        const refused = refusal(request)\n        if (refused) return refused\n        const { current } = pluginFigureWindows(request.now, request.days)\n        const window = await ordersBetween(firestore(), request.hostId as string, current.startMs, current.endMs)\n        const sales = productSales(window.orders)\n        return {\n          ok: true,\n          table: {\n            title: 'Top products',\n            source: SOURCE,\n            period: { from: current.from, to: current.to, days: request.days },\n            columns: [\n              { key: 'product', label: 'Product', kind: 'text' },\n              { key: 'units', label: 'Units', kind: 'count' },\n              { key: 'revenue', label: 'Line revenue', kind: 'money', currency: 'USD' },\n            ],\n            rows: sales\n              .slice(0, PLUGIN_FIGURE_MAX_ROWS)\n              .map((entry) => ({ product: entry.name, units: entry.units, revenue: dollars(entry.cents) })),\n            omitted: Math.max(0, sales.length - PLUGIN_FIGURE_MAX_ROWS),\n            notes: [\n              'Line revenue is each line’s price times its quantity, before discounts, shipping and tax.',\n              ...ceilingNote(window.truncated),\n            ],\n          },\n        }\n      },\n    },\n  ]\n}\n\n/** Registers the sales readers from the console surface, where insight jobs run. */\nexport function registerOrderFigureReaders(firestore: () => Firestore): void {\n  for (const reader of orderFigureReaders(firestore)) {\n    registerPluginFigureReader(reader, { pluginId: BUNDLE_ID })\n  }\n}\n"],"names":["PLUGIN_FIGURE_MAX_ROWS","pluginFigureChange","pluginFigureWindows","registerPluginFigureReader","figureCount","figureHasColumn","figurePlural","figureRanked","figureWithChange","BUNDLE_ID","orderWindowFigures","productSales","ORDER_FIGURES_WINDOW_CEILING","WINDOWS","SOURCE","label","path","ordersBetween","firestore","hostId","startMs","endMs","snapshot","collection","doc","where","orderBy","limit","get","orders","docs","map","data","$id","id","slice","truncated","length","dollars","cents","Math","round","ceilingNote","toLocaleString","refusal","request","ok","status","error","includes","days","orderFigureReaders","description","scope","windows","feature","weeklySummary","order","lines","table","week","rows","headline","count","one","many","read","refused","current","previous","now","before","Promise","all","a","b","title","source","period","from","to","columns","key","kind","currency","window","revenue","revenueCents","averageOrder","averageCents","revenueChange","ordersChange","omitted","notes","top","sales","entry","product","name","units","max","registerOrderFigureReaders","reader","pluginId"],"mappings":";AAAA;;;;;;;;;;;;;;;CAeC,GAED,SACEA,sBAAsB,EACtBC,kBAAkB,EAClBC,mBAAmB,EACnBC,0BAA0B,QAGrB,6CAA4C;AACnD,SACEC,WAAW,EACXC,eAAe,EACfC,YAAY,EACZC,YAAY,EACZC,gBAAgB,QACX,wCAAuC;AAC9C,SAASC,SAAS,QAAQ,gCAA4B;AACtD,SACEC,kBAAkB,EAClBC,YAAY,QAEP,4BAAwB;AAc/B,2EAA2E,GAC3E,OAAO,MAAMC,+BAA+B,KAAK;AAEjD,MAAMC,UAA6B;IAAC;IAAG;IAAI;IAAI;CAAG;AAElD,MAAMC,SAAS;IAAEC,OAAO;IAAmBC,MAAM;AAAqB;AAEtE,eAAeC,cACbC,SAAoB,EACpBC,MAAc,EACdC,OAAe,EACfC,KAAa;IAEb,uEAAuE;IACvE,6EAA6E;IAC7E,MAAMC,WAAW,MAAMJ,UACpBK,UAAU,CAAC,SACXC,GAAG,CAACL,QACJI,UAAU,CAAC,UACXE,KAAK,CAAC,eAAe,MAAML,SAC3BK,KAAK,CAAC,eAAe,KAAKJ,OAC1BK,OAAO,CAAC,eAAe,QACvBC,KAAK,CAACf,+BAA+B,GACrCgB,GAAG;IACN,MAAMC,SAASP,SAASQ,IAAI,CAACC,GAAG,CAAC,CAACP;YAAeA;eAAN,cAAMA,YAAAA,IAAIQ,IAAI,cAARR,YAAc,CAAC;YAAIS,KAAKT,IAAIU,EAAE;;;IAC/E,OAAO;QACLL,QAAQA,OAAOM,KAAK,CAAC,GAAGvB;QACxBwB,WAAWP,OAAOQ,MAAM,GAAGzB;IAC7B;AACF;AAEA,MAAM0B,UAAU,CAACC,QAA0BC,KAAKC,KAAK,CAACF,SAAS;AAE/D,SAASG,YAAYN,SAAkB;IACrC,OAAOA,YACH;QACE,CAAC,yBAAyB,EAAExB,6BAA6B+B,cAAc,CAAC,SAAS,oEAAoE,EAAE/B,6BAA6B+B,cAAc,CAAC,SAAS,cAAc,CAAC;KAC5N,GACD,EAAE;AACR;AAEA,SAASC,QAAQC,OAA4B;IAC3C,IAAI,CAACA,QAAQ1B,MAAM,EAAE,OAAO;QAAE2B,IAAI;QAAgBC,QAAQ;QAAcC,OAAO;IAAgC;IAC/G,IAAI,CAACnC,QAAQoC,QAAQ,CAACJ,QAAQK,IAAI,GAAG;QACnC,OAAO;YAAEJ,IAAI;YAAgBC,QAAQ;YAAcC,OAAO;QAA6C;IACzG;IACA,OAAO;AACT;AAEA,OAAO,SAASG,mBAAmBjC,SAA0B;IAC3D,OAAO;QACL;YACEgB,IAAI;YACJnB,OAAO;YACPqC,aACE;YACFC,OAAO;YACPC,SAASzC;YACT0C,SAAS;YACTC,eAAe;gBACbC,OAAO;gBACPC,OAAO,CAACC;oBACN,MAAMC,OAAOD,MAAME,IAAI,CAAC,EAAE;oBAC1B,IAAI,CAACD,QAAQ,CAACvD,gBAAgBsD,OAAO,YAAY,OAAO,EAAE;oBAC1D,MAAM9B,SAASzB,YAAYwD,IAAI,CAAC,SAAS;oBACzC,IAAI,CAAC/B,UAAU,CAACzB,YAAYwD,IAAI,CAAC,UAAU,GAAG,OAAO,EAAE;oBACvD,OAAO;wBACL,CAAC,OAAO,EAAEpD,iBAAiBmD,OAAOC,MAAM,WAAW,iBAAiB,MAAM,EAAEtD,aAAauB,QAAQ,SAAS,WAAW;qBACtH;gBACH;gBACAiC,UAAU,CAACH;wBACiBA;oBAA1B,MAAMI,QAAQ3D,aAAYuD,eAAAA,MAAME,IAAI,CAAC,EAAE,qBAAbF,YAAe,CAAC,SAAS;oBACnD,OAAOI,QAAQ;wBAAEA;wBAAOC,KAAK;wBAASC,MAAM;oBAAS,IAAI;gBAC3D;YACF;YACAC,MAAM,OAAOrB;gBACX,MAAMsB,UAAUvB,QAAQC;gBACxB,IAAIsB,SAAS,OAAOA;gBACpB,MAAMhD,SAAS0B,QAAQ1B,MAAM;gBAC7B,MAAM,EAAEiD,OAAO,EAAEC,QAAQ,EAAE,GAAGnE,oBAAoB2C,QAAQyB,GAAG,EAAEzB,QAAQK,IAAI;gBAC3E,MAAM,CAACoB,KAAKC,OAAO,GAAG,MAAMC,QAAQC,GAAG,CAAC;oBACtCxD,cAAcC,aAAaC,QAAQiD,QAAQhD,OAAO,EAAEgD,QAAQ/C,KAAK;oBACjEJ,cAAcC,aAAaC,QAAQkD,SAASjD,OAAO,EAAEiD,SAAShD,KAAK;iBACpE;gBACD,MAAMqD,IAAIhE,mBAAmB4D,IAAIzC,MAAM,EAAEuC,QAAQhD,OAAO,EAAEgD,QAAQ/C,KAAK;gBACvE,MAAMsD,IAAIjE,mBAAmB6D,OAAO1C,MAAM,EAAEwC,SAASjD,OAAO,EAAEiD,SAAShD,KAAK;gBAC5E,OAAO;oBACLyB,IAAI;oBACJa,OAAO;wBACLiB,OAAO;wBACPC,QAAQ/D;wBACRgE,QAAQ;4BAAEC,MAAMX,QAAQW,IAAI;4BAAEC,IAAIZ,QAAQY,EAAE;4BAAE9B,MAAML,QAAQK,IAAI;wBAAC;wBACjE+B,SAAS;4BACP;gCAAEC,KAAK;gCAAUnE,OAAO;gCAAUoE,MAAM;4BAAO;4BAC/C;gCAAED,KAAK;gCAAWnE,OAAO;gCAAWoE,MAAM;gCAASC,UAAU;4BAAM;4BACnE;gCAAEF,KAAK;gCAAUnE,OAAO;gCAAUoE,MAAM;4BAAQ;4BAChD;gCAAED,KAAK;gCAAgBnE,OAAO;gCAAiBoE,MAAM;gCAASC,UAAU;4BAAM;4BAC9E;gCAAEF,KAAK;gCAAiBnE,OAAO;gCAAkBoE,MAAM;4BAAS;4BAChE;gCAAED,KAAK;gCAAgBnE,OAAO;gCAAiBoE,MAAM;4BAAS;yBAC/D;wBACDtB,MAAM;4BACJ;gCACEwB,QAAQ,GAAGjB,QAAQW,IAAI,CAAC,IAAI,EAAEX,QAAQY,EAAE,EAAE;gCAC1CM,SAAShD,QAAQoC,EAAEa,YAAY;gCAC/B1D,QAAQ6C,EAAE7C,MAAM;gCAChB2D,cAAclD,QAAQoC,EAAEe,YAAY;gCACpCC,eAAezF,mBAAmByE,EAAEa,YAAY,EAAEZ,EAAEY,YAAY;gCAChEI,cAAc1F,mBAAmByE,EAAE7C,MAAM,EAAE8C,EAAE9C,MAAM;4BACrD;4BACA;gCACEwD,QAAQ,GAAGhB,SAASU,IAAI,CAAC,IAAI,EAAEV,SAASW,EAAE,EAAE;gCAC5CM,SAAShD,QAAQqC,EAAEY,YAAY;gCAC/B1D,QAAQ8C,EAAE9C,MAAM;gCAChB2D,cAAclD,QAAQqC,EAAEc,YAAY;gCACpCC,eAAe;gCACfC,cAAc;4BAChB;yBACD;wBACDC,SAAS;wBACTC,OAAOnD,YAAY4B,IAAIlC,SAAS,IAAImC,OAAOnC,SAAS;oBACtD;gBACF;YACF;QACF;QACA;YACEF,IAAI;YACJnB,OAAO;YACPqC,aAAa;YACbC,OAAO;YACPC,SAASzC;YACT0C,SAAS;YACTC,eAAe;gBACbC,OAAO;gBACPC,OAAO,CAACC;oBACN,MAAMmC,MAAMzF,gBAAgBsD,OAAO,WAAWpD,aAAaoD,OAAO,WAAW,SAAS,UAAU;oBAChG,OAAOmC,MAAM;wBAAC,CAAC,cAAc,EAAEA,KAAK;qBAAC,GAAG,EAAE;gBAC5C;YACF;YACA5B,MAAM,OAAOrB;gBACX,MAAMsB,UAAUvB,QAAQC;gBACxB,IAAIsB,SAAS,OAAOA;gBACpB,MAAM,EAAEC,OAAO,EAAE,GAAGlE,oBAAoB2C,QAAQyB,GAAG,EAAEzB,QAAQK,IAAI;gBACjE,MAAMmC,SAAS,MAAMpE,cAAcC,aAAa2B,QAAQ1B,MAAM,EAAYiD,QAAQhD,OAAO,EAAEgD,QAAQ/C,KAAK;gBACxG,MAAM0E,QAAQpF,aAAa0E,OAAOxD,MAAM;gBACxC,OAAO;oBACLiB,IAAI;oBACJa,OAAO;wBACLiB,OAAO;wBACPC,QAAQ/D;wBACRgE,QAAQ;4BAAEC,MAAMX,QAAQW,IAAI;4BAAEC,IAAIZ,QAAQY,EAAE;4BAAE9B,MAAML,QAAQK,IAAI;wBAAC;wBACjE+B,SAAS;4BACP;gCAAEC,KAAK;gCAAWnE,OAAO;gCAAWoE,MAAM;4BAAO;4BACjD;gCAAED,KAAK;gCAASnE,OAAO;gCAASoE,MAAM;4BAAQ;4BAC9C;gCAAED,KAAK;gCAAWnE,OAAO;gCAAgBoE,MAAM;gCAASC,UAAU;4BAAM;yBACzE;wBACDvB,MAAMkC,MACH5D,KAAK,CAAC,GAAGnC,wBACT+B,GAAG,CAAC,CAACiE,QAAW,CAAA;gCAAEC,SAASD,MAAME,IAAI;gCAAEC,OAAOH,MAAMG,KAAK;gCAAEb,SAAShD,QAAQ0D,MAAMzD,KAAK;4BAAE,CAAA;wBAC5FqD,SAASpD,KAAK4D,GAAG,CAAC,GAAGL,MAAM1D,MAAM,GAAGrC;wBACpC6F,OAAO;4BACL;+BACGnD,YAAY2C,OAAOjD,SAAS;yBAChC;oBACH;gBACF;YACF;QACF;KACD;AACH;AAEA,kFAAkF,GAClF,OAAO,SAASiE,2BAA2BnF,SAA0B;IACnE,KAAK,MAAMoF,UAAUnD,mBAAmBjC,WAAY;QAClDf,2BAA2BmG,QAAQ;YAAEC,UAAU9F;QAAU;IAC3D;AACF"}
+{"version":3,"sources":["../../../../../../../libs/plugins/commerce/src/lib/server/order-figures.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 {\n  PLUGIN_FIGURE_MAX_ROWS,\n  pluginFigureChange,\n  pluginFigureWindows,\n  registerPluginFigureReader,\n  type PluginFigureReader,\n  type PluginFigureRequest,\n} from '@aglyn/aglyn/plugin-manager/plugin-figures'\nimport { figureCount, figureHasColumn, figureRanked, figureStat } from '@aglyn/aglyn/app-utils/weekly-summary'\nimport { BUNDLE_ID } from '../constants/bundle-common'\nimport {\n  orderWindowFigures,\n  productSales,\n  type OrderFigureSource,\n} from '../model/order-figures'\n\n/**\n * The store's sales figures for another plugin to read (AGL-2915): what the\n * Analytics tab's card shows, as tables on the `plugin-figures` seam. The\n * insight job reads them by id and never reads an order.\n *\n * A table carries sums and counts and product names — never a buyer, an\n * address or an order. Sold under `commerceAnalytics`, the entitlement the\n * card is sold under.\n */\n\ntype Firestore = FirebaseFirestore.Firestore\n\n/** Orders one window reads; a store past it is told its figures read low. */\nexport const ORDER_FIGURES_WINDOW_CEILING = 1_000\n\nconst WINDOWS: readonly number[] = [7, 14, 30, 90]\n\nconst SOURCE = { label: 'Store analytics', path: 'products/analytics' }\n\nasync function ordersBetween(\n  firestore: Firestore,\n  hostId: string,\n  startMs: number,\n  endMs: number,\n): Promise<{ orders: OrderFigureSource[]; truncated: boolean }> {\n  // `createdAtMs` is the field every order writer stamps and the one the\n  // orders group is indexed on; range and order on it need no composite index.\n  const snapshot = await firestore\n    .collection('hosts')\n    .doc(hostId)\n    .collection('orders')\n    .where('createdAtMs', '>=', startMs)\n    .where('createdAtMs', '<', endMs)\n    .orderBy('createdAtMs', 'desc')\n    .limit(ORDER_FIGURES_WINDOW_CEILING + 1)\n    .get()\n  const orders = snapshot.docs.map((doc) => ({ ...(doc.data() ?? {}), $id: doc.id }) as OrderFigureSource)\n  return {\n    orders: orders.slice(0, ORDER_FIGURES_WINDOW_CEILING),\n    truncated: orders.length > ORDER_FIGURES_WINDOW_CEILING,\n  }\n}\n\nconst dollars = (cents: number): number => Math.round(cents) / 100\n\nfunction ceilingNote(truncated: boolean): string[] {\n  return truncated\n    ? [\n        `The store took more than ${ORDER_FIGURES_WINDOW_CEILING.toLocaleString('en-US')} orders in a window, so its figures are summed over the most recent ${ORDER_FIGURES_WINDOW_CEILING.toLocaleString('en-US')} and read low.`,\n      ]\n    : []\n}\n\nfunction refusal(request: PluginFigureRequest) {\n  if (!request.hostId) return { ok: false as const, status: 400 as const, error: 'Open a site to read its sales' }\n  if (!WINDOWS.includes(request.days)) {\n    return { ok: false as const, status: 400 as const, error: 'That window is not one sales are read over' }\n  }\n  return null\n}\n\nexport function orderFigureReaders(firestore: () => Firestore): PluginFigureReader[] {\n  return [\n    {\n      id: 'commerce.sales',\n      label: 'Sales',\n      description:\n        'The store’s revenue, orders and average order over the window and the window before it, with the change in revenue and in orders. Pending, canceled and test orders are left out, and refunds come off.',\n      scope: 'site',\n      windows: WINDOWS,\n      feature: 'commerceAnalytics',\n      weeklySummary: {\n        order: 70,\n        summarize: (table) => {\n          const week = table.rows[0]\n          if (!week || !figureHasColumn(table, 'revenue')) return null\n          if (!figureCount(week['orders']) && !figureCount(week['revenue'])) return null\n          return {\n            title: 'Sales',\n            stats: [\n              figureStat(table, week, 'revenue', 'Revenue', { change: 'revenueChange' }),\n              figureStat(table, week, 'orders', 'Orders', { change: 'ordersChange', total: { one: 'order', many: 'orders' } }),\n              figureStat(table, week, 'averageOrder', 'Average order'),\n            ],\n          }\n        },\n      },\n      read: async (request) => {\n        const refused = refusal(request)\n        if (refused) return refused\n        const hostId = request.hostId as string\n        const { current, previous } = pluginFigureWindows(request.now, request.days)\n        const [now, before] = await Promise.all([\n          ordersBetween(firestore(), hostId, current.startMs, current.endMs),\n          ordersBetween(firestore(), hostId, previous.startMs, previous.endMs),\n        ])\n        const a = orderWindowFigures(now.orders, current.startMs, current.endMs)\n        const b = orderWindowFigures(before.orders, previous.startMs, previous.endMs)\n        return {\n          ok: true,\n          table: {\n            title: 'Sales',\n            source: SOURCE,\n            period: { from: current.from, to: current.to, days: request.days },\n            columns: [\n              { key: 'window', label: 'Window', kind: 'text' },\n              { key: 'revenue', label: 'Revenue', kind: 'money', currency: 'USD' },\n              { key: 'orders', label: 'Orders', kind: 'count' },\n              { key: 'averageOrder', label: 'Average order', kind: 'money', currency: 'USD' },\n              { key: 'revenueChange', label: 'Revenue change', kind: 'change' },\n              { key: 'ordersChange', label: 'Orders change', kind: 'change' },\n            ],\n            rows: [\n              {\n                window: `${current.from} to ${current.to}`,\n                revenue: dollars(a.revenueCents),\n                orders: a.orders,\n                averageOrder: dollars(a.averageCents),\n                revenueChange: pluginFigureChange(a.revenueCents, b.revenueCents),\n                ordersChange: pluginFigureChange(a.orders, b.orders),\n              },\n              {\n                window: `${previous.from} to ${previous.to}`,\n                revenue: dollars(b.revenueCents),\n                orders: b.orders,\n                averageOrder: dollars(b.averageCents),\n                revenueChange: null,\n                ordersChange: null,\n              },\n            ],\n            omitted: 0,\n            notes: ceilingNote(now.truncated || before.truncated),\n          },\n        }\n      },\n    },\n    {\n      id: 'commerce.products',\n      label: 'Top products',\n      description: 'The products that brought in the most over the window, with units sold and line revenue.',\n      scope: 'site',\n      windows: WINDOWS,\n      feature: 'commerceAnalytics',\n      weeklySummary: {\n        order: 80,\n        summarize: (table) => {\n          const rows = figureHasColumn(table, 'units') ? figureRanked(table, 'product', 'units') : []\n          return rows.length ? { title: 'Top products', rows: rows.map((row) => ({ ...row, value: `${row.value} sold` })) } : null\n        },\n      },\n      read: async (request) => {\n        const refused = refusal(request)\n        if (refused) return refused\n        const { current } = pluginFigureWindows(request.now, request.days)\n        const window = await ordersBetween(firestore(), request.hostId as string, current.startMs, current.endMs)\n        const sales = productSales(window.orders)\n        return {\n          ok: true,\n          table: {\n            title: 'Top products',\n            source: SOURCE,\n            period: { from: current.from, to: current.to, days: request.days },\n            columns: [\n              { key: 'product', label: 'Product', kind: 'text' },\n              { key: 'units', label: 'Units', kind: 'count' },\n              { key: 'revenue', label: 'Line revenue', kind: 'money', currency: 'USD' },\n            ],\n            rows: sales\n              .slice(0, PLUGIN_FIGURE_MAX_ROWS)\n              .map((entry) => ({ product: entry.name, units: entry.units, revenue: dollars(entry.cents) })),\n            omitted: Math.max(0, sales.length - PLUGIN_FIGURE_MAX_ROWS),\n            notes: [\n              'Line revenue is each line’s price times its quantity, before discounts, shipping and tax.',\n              ...ceilingNote(window.truncated),\n            ],\n          },\n        }\n      },\n    },\n  ]\n}\n\n/** Registers the sales readers from the console surface, where insight jobs run. */\nexport function registerOrderFigureReaders(firestore: () => Firestore): void {\n  for (const reader of orderFigureReaders(firestore)) {\n    registerPluginFigureReader(reader, { pluginId: BUNDLE_ID })\n  }\n}\n"],"names":["PLUGIN_FIGURE_MAX_ROWS","pluginFigureChange","pluginFigureWindows","registerPluginFigureReader","figureCount","figureHasColumn","figureRanked","figureStat","BUNDLE_ID","orderWindowFigures","productSales","ORDER_FIGURES_WINDOW_CEILING","WINDOWS","SOURCE","label","path","ordersBetween","firestore","hostId","startMs","endMs","snapshot","collection","doc","where","orderBy","limit","get","orders","docs","map","data","$id","id","slice","truncated","length","dollars","cents","Math","round","ceilingNote","toLocaleString","refusal","request","ok","status","error","includes","days","orderFigureReaders","description","scope","windows","feature","weeklySummary","order","summarize","table","week","rows","title","stats","change","total","one","many","read","refused","current","previous","now","before","Promise","all","a","b","source","period","from","to","columns","key","kind","currency","window","revenue","revenueCents","averageOrder","averageCents","revenueChange","ordersChange","omitted","notes","row","value","sales","entry","product","name","units","max","registerOrderFigureReaders","reader","pluginId"],"mappings":";AAAA;;;;;;;;;;;;;;;CAeC,GAED,SACEA,sBAAsB,EACtBC,kBAAkB,EAClBC,mBAAmB,EACnBC,0BAA0B,QAGrB,6CAA4C;AACnD,SAASC,WAAW,EAAEC,eAAe,EAAEC,YAAY,EAAEC,UAAU,QAAQ,wCAAuC;AAC9G,SAASC,SAAS,QAAQ,gCAA4B;AACtD,SACEC,kBAAkB,EAClBC,YAAY,QAEP,4BAAwB;AAc/B,2EAA2E,GAC3E,OAAO,MAAMC,+BAA+B,KAAK;AAEjD,MAAMC,UAA6B;IAAC;IAAG;IAAI;IAAI;CAAG;AAElD,MAAMC,SAAS;IAAEC,OAAO;IAAmBC,MAAM;AAAqB;AAEtE,eAAeC,cACbC,SAAoB,EACpBC,MAAc,EACdC,OAAe,EACfC,KAAa;IAEb,uEAAuE;IACvE,6EAA6E;IAC7E,MAAMC,WAAW,MAAMJ,UACpBK,UAAU,CAAC,SACXC,GAAG,CAACL,QACJI,UAAU,CAAC,UACXE,KAAK,CAAC,eAAe,MAAML,SAC3BK,KAAK,CAAC,eAAe,KAAKJ,OAC1BK,OAAO,CAAC,eAAe,QACvBC,KAAK,CAACf,+BAA+B,GACrCgB,GAAG;IACN,MAAMC,SAASP,SAASQ,IAAI,CAACC,GAAG,CAAC,CAACP;YAAeA;eAAN,cAAMA,YAAAA,IAAIQ,IAAI,cAARR,YAAc,CAAC;YAAIS,KAAKT,IAAIU,EAAE;;;IAC/E,OAAO;QACLL,QAAQA,OAAOM,KAAK,CAAC,GAAGvB;QACxBwB,WAAWP,OAAOQ,MAAM,GAAGzB;IAC7B;AACF;AAEA,MAAM0B,UAAU,CAACC,QAA0BC,KAAKC,KAAK,CAACF,SAAS;AAE/D,SAASG,YAAYN,SAAkB;IACrC,OAAOA,YACH;QACE,CAAC,yBAAyB,EAAExB,6BAA6B+B,cAAc,CAAC,SAAS,oEAAoE,EAAE/B,6BAA6B+B,cAAc,CAAC,SAAS,cAAc,CAAC;KAC5N,GACD,EAAE;AACR;AAEA,SAASC,QAAQC,OAA4B;IAC3C,IAAI,CAACA,QAAQ1B,MAAM,EAAE,OAAO;QAAE2B,IAAI;QAAgBC,QAAQ;QAAcC,OAAO;IAAgC;IAC/G,IAAI,CAACnC,QAAQoC,QAAQ,CAACJ,QAAQK,IAAI,GAAG;QACnC,OAAO;YAAEJ,IAAI;YAAgBC,QAAQ;YAAcC,OAAO;QAA6C;IACzG;IACA,OAAO;AACT;AAEA,OAAO,SAASG,mBAAmBjC,SAA0B;IAC3D,OAAO;QACL;YACEgB,IAAI;YACJnB,OAAO;YACPqC,aACE;YACFC,OAAO;YACPC,SAASzC;YACT0C,SAAS;YACTC,eAAe;gBACbC,OAAO;gBACPC,WAAW,CAACC;oBACV,MAAMC,OAAOD,MAAME,IAAI,CAAC,EAAE;oBAC1B,IAAI,CAACD,QAAQ,CAACtD,gBAAgBqD,OAAO,YAAY,OAAO;oBACxD,IAAI,CAACtD,YAAYuD,IAAI,CAAC,SAAS,KAAK,CAACvD,YAAYuD,IAAI,CAAC,UAAU,GAAG,OAAO;oBAC1E,OAAO;wBACLE,OAAO;wBACPC,OAAO;4BACLvD,WAAWmD,OAAOC,MAAM,WAAW,WAAW;gCAAEI,QAAQ;4BAAgB;4BACxExD,WAAWmD,OAAOC,MAAM,UAAU,UAAU;gCAAEI,QAAQ;gCAAgBC,OAAO;oCAAEC,KAAK;oCAASC,MAAM;gCAAS;4BAAE;4BAC9G3D,WAAWmD,OAAOC,MAAM,gBAAgB;yBACzC;oBACH;gBACF;YACF;YACAQ,MAAM,OAAOvB;gBACX,MAAMwB,UAAUzB,QAAQC;gBACxB,IAAIwB,SAAS,OAAOA;gBACpB,MAAMlD,SAAS0B,QAAQ1B,MAAM;gBAC7B,MAAM,EAAEmD,OAAO,EAAEC,QAAQ,EAAE,GAAGpE,oBAAoB0C,QAAQ2B,GAAG,EAAE3B,QAAQK,IAAI;gBAC3E,MAAM,CAACsB,KAAKC,OAAO,GAAG,MAAMC,QAAQC,GAAG,CAAC;oBACtC1D,cAAcC,aAAaC,QAAQmD,QAAQlD,OAAO,EAAEkD,QAAQjD,KAAK;oBACjEJ,cAAcC,aAAaC,QAAQoD,SAASnD,OAAO,EAAEmD,SAASlD,KAAK;iBACpE;gBACD,MAAMuD,IAAIlE,mBAAmB8D,IAAI3C,MAAM,EAAEyC,QAAQlD,OAAO,EAAEkD,QAAQjD,KAAK;gBACvE,MAAMwD,IAAInE,mBAAmB+D,OAAO5C,MAAM,EAAE0C,SAASnD,OAAO,EAAEmD,SAASlD,KAAK;gBAC5E,OAAO;oBACLyB,IAAI;oBACJa,OAAO;wBACLG,OAAO;wBACPgB,QAAQhE;wBACRiE,QAAQ;4BAAEC,MAAMV,QAAQU,IAAI;4BAAEC,IAAIX,QAAQW,EAAE;4BAAE/B,MAAML,QAAQK,IAAI;wBAAC;wBACjEgC,SAAS;4BACP;gCAAEC,KAAK;gCAAUpE,OAAO;gCAAUqE,MAAM;4BAAO;4BAC/C;gCAAED,KAAK;gCAAWpE,OAAO;gCAAWqE,MAAM;gCAASC,UAAU;4BAAM;4BACnE;gCAAEF,KAAK;gCAAUpE,OAAO;gCAAUqE,MAAM;4BAAQ;4BAChD;gCAAED,KAAK;gCAAgBpE,OAAO;gCAAiBqE,MAAM;gCAASC,UAAU;4BAAM;4BAC9E;gCAAEF,KAAK;gCAAiBpE,OAAO;gCAAkBqE,MAAM;4BAAS;4BAChE;gCAAED,KAAK;gCAAgBpE,OAAO;gCAAiBqE,MAAM;4BAAS;yBAC/D;wBACDvB,MAAM;4BACJ;gCACEyB,QAAQ,GAAGhB,QAAQU,IAAI,CAAC,IAAI,EAAEV,QAAQW,EAAE,EAAE;gCAC1CM,SAASjD,QAAQsC,EAAEY,YAAY;gCAC/B3D,QAAQ+C,EAAE/C,MAAM;gCAChB4D,cAAcnD,QAAQsC,EAAEc,YAAY;gCACpCC,eAAezF,mBAAmB0E,EAAEY,YAAY,EAAEX,EAAEW,YAAY;gCAChEI,cAAc1F,mBAAmB0E,EAAE/C,MAAM,EAAEgD,EAAEhD,MAAM;4BACrD;4BACA;gCACEyD,QAAQ,GAAGf,SAASS,IAAI,CAAC,IAAI,EAAET,SAASU,EAAE,EAAE;gCAC5CM,SAASjD,QAAQuC,EAAEW,YAAY;gCAC/B3D,QAAQgD,EAAEhD,MAAM;gCAChB4D,cAAcnD,QAAQuC,EAAEa,YAAY;gCACpCC,eAAe;gCACfC,cAAc;4BAChB;yBACD;wBACDC,SAAS;wBACTC,OAAOpD,YAAY8B,IAAIpC,SAAS,IAAIqC,OAAOrC,SAAS;oBACtD;gBACF;YACF;QACF;QACA;YACEF,IAAI;YACJnB,OAAO;YACPqC,aAAa;YACbC,OAAO;YACPC,SAASzC;YACT0C,SAAS;YACTC,eAAe;gBACbC,OAAO;gBACPC,WAAW,CAACC;oBACV,MAAME,OAAOvD,gBAAgBqD,OAAO,WAAWpD,aAAaoD,OAAO,WAAW,WAAW,EAAE;oBAC3F,OAAOE,KAAKxB,MAAM,GAAG;wBAAEyB,OAAO;wBAAgBD,MAAMA,KAAK9B,GAAG,CAAC,CAACgE,MAAS,aAAKA;gCAAKC,OAAO,GAAGD,IAAIC,KAAK,CAAC,KAAK,CAAC;;oBAAK,IAAI;gBACtH;YACF;YACA5B,MAAM,OAAOvB;gBACX,MAAMwB,UAAUzB,QAAQC;gBACxB,IAAIwB,SAAS,OAAOA;gBACpB,MAAM,EAAEC,OAAO,EAAE,GAAGnE,oBAAoB0C,QAAQ2B,GAAG,EAAE3B,QAAQK,IAAI;gBACjE,MAAMoC,SAAS,MAAMrE,cAAcC,aAAa2B,QAAQ1B,MAAM,EAAYmD,QAAQlD,OAAO,EAAEkD,QAAQjD,KAAK;gBACxG,MAAM4E,QAAQtF,aAAa2E,OAAOzD,MAAM;gBACxC,OAAO;oBACLiB,IAAI;oBACJa,OAAO;wBACLG,OAAO;wBACPgB,QAAQhE;wBACRiE,QAAQ;4BAAEC,MAAMV,QAAQU,IAAI;4BAAEC,IAAIX,QAAQW,EAAE;4BAAE/B,MAAML,QAAQK,IAAI;wBAAC;wBACjEgC,SAAS;4BACP;gCAAEC,KAAK;gCAAWpE,OAAO;gCAAWqE,MAAM;4BAAO;4BACjD;gCAAED,KAAK;gCAASpE,OAAO;gCAASqE,MAAM;4BAAQ;4BAC9C;gCAAED,KAAK;gCAAWpE,OAAO;gCAAgBqE,MAAM;gCAASC,UAAU;4BAAM;yBACzE;wBACDxB,MAAMoC,MACH9D,KAAK,CAAC,GAAGlC,wBACT8B,GAAG,CAAC,CAACmE,QAAW,CAAA;gCAAEC,SAASD,MAAME,IAAI;gCAAEC,OAAOH,MAAMG,KAAK;gCAAEd,SAASjD,QAAQ4D,MAAM3D,KAAK;4BAAE,CAAA;wBAC5FsD,SAASrD,KAAK8D,GAAG,CAAC,GAAGL,MAAM5D,MAAM,GAAGpC;wBACpC6F,OAAO;4BACL;+BACGpD,YAAY4C,OAAOlD,SAAS;yBAChC;oBACH;gBACF;YACF;QACF;KACD;AACH;AAEA,kFAAkF,GAClF,OAAO,SAASmE,2BAA2BrF,SAA0B;IACnE,KAAK,MAAMsF,UAAUrD,mBAAmBjC,WAAY;QAClDd,2BAA2BoG,QAAQ;YAAEC,UAAUhG;QAAU;IAC3D;AACF"}