@withpotter/lib 0.13.0-next.103 → 0.13.0-next.105

package/dist/admin-pos-api.d.ts

@@ -1,5 +1,5 @@
 import { type ShiftFilters, type TerminalFilters } from './admin-pos-query';
-import type { PosPage, PosShift, PosSummary, PosTerminal, PosTerminalDetail, PosTerminalHistory, PosWindow, TenantPos } from './admin-pos-types';
+import type { PosPage, PosPaymentsPage, PosRosterEntry, PosTillRequest, PosShift, PosSummary, PosTerminal, PosTerminalDetail, PosTerminalHistory, PosWindow, TenantPos } from './admin-pos-types';
 export type TerminalAct = 'suspend' | 'resume' | 'revoke';
 export declare const adminPosApi: {
     summary: (w?: PosWindow) => Promise<PosSummary>;
@@ -9,6 +9,28 @@ export declare const adminPosApi: {
     history: (terminalId: string) => Promise<PosTerminalHistory>;
     shifts: (filters?: ShiftFilters) => Promise<PosPage<PosShift>>;
     tenant: (tenantId: string, w?: PosWindow) => Promise<TenantPos>;
+    /** A business's whole till roster, removed people marked. */
+    roster: (tenantId: string) => Promise<PosRosterEntry[]>;
+    /** A business's requests for terminals, newest first. */
+    tillRequests: (tenantId: string) => Promise<PosTillRequest[]>;
+    /** Card payments, newest first, one business when given; `cursor` is the last page's `nextCursor`. */
+    payments: (filters?: {
+        tenantId?: string;
+        deviceId?: string;
+        cursor?: string;
+        limit?: number;
+    }) => Promise<PosPaymentsPage>;
+    /**
+     * What the business sees from Olive, read live under its own Olive login. Read-only; each call is
+     * written to the admin audit log. The bodies are Olive's own, so they go through `admin-pos-olive`.
+     * A 400 says the business has not connected Olive.
+     */
+    olive: {
+        account: (tenantId: string) => Promise<unknown>;
+        accountTransactions: (tenantId: string, query?: Record<string, string>) => Promise<unknown>;
+        outlets: (tenantId: string) => Promise<unknown>;
+        outletTerminals: (tenantId: string, outletId: string) => Promise<unknown>;
+    };
     /** 409 when the terminal's status no longer allows it. */
     setTerminalStatus: (terminalId: string, act: TerminalAct, reason: string) => Promise<PosTerminalDetail>;
     /** Signs the shift out at its till. 409 when it is no longer open. */

package/dist/admin-pos-api.js

@@ -8,6 +8,7 @@ const BASE = "/platform-admin/v1/pos";
 const id = (value) => encodeURIComponent(value);
 const post = (path, body) => apiFetch(path, { method: "POST", body: JSON.stringify(body) });
 const windowQuery = (w = {}) => toQuery({ from: w.from, to: w.to });
+const tenantBase = (tenantId) => `/platform-admin/v1/tenants/${id(tenantId)}/pos`;
 const adminPosApi = {
   summary: (w) => apiFetch(`${BASE}/summary${windowQuery(w)}`),
   terminals: (filters) => apiFetch(
@@ -22,6 +23,29 @@ const adminPosApi = {
   tenant: (tenantId, w) => apiFetch(
     `/platform-admin/v1/tenants/${id(tenantId)}/pos${windowQuery(w)}`
   ),
+  /** A business's whole till roster, removed people marked. */
+  roster: (tenantId) => apiFetch(`${tenantBase(tenantId)}/operators`),
+  /** A business's requests for terminals, newest first. */
+  tillRequests: (tenantId) => apiFetch(
+    `/platform-admin/v1/till-requests${toQuery({ tenantId })}`
+  ),
+  /** Card payments, newest first, one business when given; `cursor` is the last page's `nextCursor`. */
+  payments: (filters = {}) => apiFetch(`${BASE}/payments${toQuery(filters)}`),
+  /**
+   * What the business sees from Olive, read live under its own Olive login. Read-only; each call is
+   * written to the admin audit log. The bodies are Olive's own, so they go through `admin-pos-olive`.
+   * A 400 says the business has not connected Olive.
+   */
+  olive: {
+    account: (tenantId) => apiFetch(`${tenantBase(tenantId)}/olive/account`),
+    accountTransactions: (tenantId, query = {}) => apiFetch(
+      `${tenantBase(tenantId)}/olive/account/transactions${toQuery(query)}`
+    ),
+    outlets: (tenantId) => apiFetch(`${tenantBase(tenantId)}/olive/outlets`),
+    outletTerminals: (tenantId, outletId) => apiFetch(
+      `${tenantBase(tenantId)}/olive/outlets/${id(outletId)}/terminals`
+    )
+  },
   /** 409 when the terminal's status no longer allows it. */
   setTerminalStatus: (terminalId, act, reason) => post(`${BASE}/terminals/${id(terminalId)}/${act}`, {
     reason

package/dist/admin-pos-api.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/admin-pos-api.ts"],"sourcesContent":["import { apiFetch } from './api';\nimport {\n  shiftsQuery,\n  terminalsQuery,\n  toQuery,\n  type ShiftFilters,\n  type TerminalFilters,\n} from './admin-pos-query';\nimport type {\n  PosPage,\n  PosShift,\n  PosSummary,\n  PosTerminal,\n  PosTerminalDetail,\n  PosTerminalHistory,\n  PosWindow,\n  TenantPos,\n} from './admin-pos-types';\n\n/**\n * Terminals and till shifts across every business, as the platform desk\n * works them. Same `apiFetch` and cookie session as the rest of the console;\n * reads need `pos.read`, every action `pos.manage` and a reason. Shapes:\n * `admin-pos-types.ts`.\n */\n\nconst BASE = '/platform-admin/v1/pos';\n\nconst id = (value: string) => encodeURIComponent(value);\n\nconst post = <T>(path: string, body: unknown) =>\n  apiFetch<T>(path, { method: 'POST', body: JSON.stringify(body) });\n\nconst windowQuery = (w: PosWindow = {}) => toQuery({ from: w.from, to: w.to });\n\nexport type TerminalAct = 'suspend' | 'resume' | 'revoke';\n\nexport const adminPosApi = {\n  summary: (w?: PosWindow) =>\n    apiFetch<PosSummary>(`${BASE}/summary${windowQuery(w)}`),\n\n  terminals: (filters?: TerminalFilters) =>\n    apiFetch<PosPage<PosTerminal>>(\n      `${BASE}/terminals${terminalsQuery(filters)}`,\n    ),\n\n  /** 404 when there is no such terminal. */\n  terminal: (terminalId: string, w?: PosWindow) =>\n    apiFetch<PosTerminalDetail>(\n      `${BASE}/terminals/${id(terminalId)}${windowQuery(w)}`,\n    ),\n\n  history: (terminalId: string) =>\n    apiFetch<PosTerminalHistory>(`${BASE}/terminals/${id(terminalId)}/history`),\n\n  shifts: (filters?: ShiftFilters) =>\n    apiFetch<PosPage<PosShift>>(`${BASE}/shifts${shiftsQuery(filters)}`),\n\n  tenant: (tenantId: string, w?: PosWindow) =>\n    apiFetch<TenantPos>(\n      `/platform-admin/v1/tenants/${id(tenantId)}/pos${windowQuery(w)}`,\n    ),\n\n  /** 409 when the terminal's status no longer allows it. */\n  setTerminalStatus: (terminalId: string, act: TerminalAct, reason: string) =>\n    post<PosTerminalDetail>(`${BASE}/terminals/${id(terminalId)}/${act}`, {\n      reason,\n    }),\n\n  /** Signs the shift out at its till. 409 when it is no longer open. */\n  closeShift: (shiftId: string, reason: string) =>\n    post<PosShift>(`${BASE}/shifts/${id(shiftId)}/close`, { reason }),\n};\n"],"mappings":"AAAA,SAAS,gBAAgB;AACzB;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,OAGK;AAmBP,MAAM,OAAO;AAEb,MAAM,KAAK,CAAC,UAAkB,mBAAmB,KAAK;AAEtD,MAAM,OAAO,CAAI,MAAc,SAC7B,SAAY,MAAM,EAAE,QAAQ,QAAQ,MAAM,KAAK,UAAU,IAAI,EAAE,CAAC;AAElE,MAAM,cAAc,CAAC,IAAe,CAAC,MAAM,QAAQ,EAAE,MAAM,EAAE,MAAM,IAAI,EAAE,GAAG,CAAC;AAItE,MAAM,cAAc;AAAA,EACzB,SAAS,CAAC,MACR,SAAqB,GAAG,IAAI,WAAW,YAAY,CAAC,CAAC,EAAE;AAAA,EAEzD,WAAW,CAAC,YACV;AAAA,IACE,GAAG,IAAI,aAAa,eAAe,OAAO,CAAC;AAAA,EAC7C;AAAA;AAAA,EAGF,UAAU,CAAC,YAAoB,MAC7B;AAAA,IACE,GAAG,IAAI,cAAc,GAAG,UAAU,CAAC,GAAG,YAAY,CAAC,CAAC;AAAA,EACtD;AAAA,EAEF,SAAS,CAAC,eACR,SAA6B,GAAG,IAAI,cAAc,GAAG,UAAU,CAAC,UAAU;AAAA,EAE5E,QAAQ,CAAC,YACP,SAA4B,GAAG,IAAI,UAAU,YAAY,OAAO,CAAC,EAAE;AAAA,EAErE,QAAQ,CAAC,UAAkB,MACzB;AAAA,IACE,8BAA8B,GAAG,QAAQ,CAAC,OAAO,YAAY,CAAC,CAAC;AAAA,EACjE;AAAA;AAAA,EAGF,mBAAmB,CAAC,YAAoB,KAAkB,WACxD,KAAwB,GAAG,IAAI,cAAc,GAAG,UAAU,CAAC,IAAI,GAAG,IAAI;AAAA,IACpE;AAAA,EACF,CAAC;AAAA;AAAA,EAGH,YAAY,CAAC,SAAiB,WAC5B,KAAe,GAAG,IAAI,WAAW,GAAG,OAAO,CAAC,UAAU,EAAE,OAAO,CAAC;AACpE;","names":[]}
+{"version":3,"sources":["../src/admin-pos-api.ts"],"sourcesContent":["import { apiFetch } from './api';\nimport {\n  shiftsQuery,\n  terminalsQuery,\n  toQuery,\n  type ShiftFilters,\n  type TerminalFilters,\n} from './admin-pos-query';\nimport type {\n  PosPage,\n  PosPaymentsPage,\n  PosRosterEntry,\n  PosTillRequest,\n  PosShift,\n  PosSummary,\n  PosTerminal,\n  PosTerminalDetail,\n  PosTerminalHistory,\n  PosWindow,\n  TenantPos,\n} from './admin-pos-types';\n\n/**\n * Terminals and till shifts across every business, as the platform desk\n * works them. Same `apiFetch` and cookie session as the rest of the console;\n * reads need `pos.read`, every action `pos.manage` and a reason. Shapes:\n * `admin-pos-types.ts`.\n */\n\nconst BASE = '/platform-admin/v1/pos';\n\nconst id = (value: string) => encodeURIComponent(value);\n\nconst post = <T>(path: string, body: unknown) =>\n  apiFetch<T>(path, { method: 'POST', body: JSON.stringify(body) });\n\nconst windowQuery = (w: PosWindow = {}) => toQuery({ from: w.from, to: w.to });\n\nconst tenantBase = (tenantId: string) =>\n  `/platform-admin/v1/tenants/${id(tenantId)}/pos`;\n\nexport type TerminalAct = 'suspend' | 'resume' | 'revoke';\n\nexport const adminPosApi = {\n  summary: (w?: PosWindow) =>\n    apiFetch<PosSummary>(`${BASE}/summary${windowQuery(w)}`),\n\n  terminals: (filters?: TerminalFilters) =>\n    apiFetch<PosPage<PosTerminal>>(\n      `${BASE}/terminals${terminalsQuery(filters)}`,\n    ),\n\n  /** 404 when there is no such terminal. */\n  terminal: (terminalId: string, w?: PosWindow) =>\n    apiFetch<PosTerminalDetail>(\n      `${BASE}/terminals/${id(terminalId)}${windowQuery(w)}`,\n    ),\n\n  history: (terminalId: string) =>\n    apiFetch<PosTerminalHistory>(`${BASE}/terminals/${id(terminalId)}/history`),\n\n  shifts: (filters?: ShiftFilters) =>\n    apiFetch<PosPage<PosShift>>(`${BASE}/shifts${shiftsQuery(filters)}`),\n\n  tenant: (tenantId: string, w?: PosWindow) =>\n    apiFetch<TenantPos>(\n      `/platform-admin/v1/tenants/${id(tenantId)}/pos${windowQuery(w)}`,\n    ),\n\n  /** A business's whole till roster, removed people marked. */\n  roster: (tenantId: string) =>\n    apiFetch<PosRosterEntry[]>(`${tenantBase(tenantId)}/operators`),\n\n  /** A business's requests for terminals, newest first. */\n  tillRequests: (tenantId: string) =>\n    apiFetch<PosTillRequest[]>(\n      `/platform-admin/v1/till-requests${toQuery({ tenantId })}`,\n    ),\n\n  /** Card payments, newest first, one business when given; `cursor` is the last page's `nextCursor`. */\n  payments: (\n    filters: {\n      tenantId?: string;\n      deviceId?: string;\n      cursor?: string;\n      limit?: number;\n    } = {},\n  ) => apiFetch<PosPaymentsPage>(`${BASE}/payments${toQuery(filters)}`),\n\n  /**\n   * What the business sees from Olive, read live under its own Olive login. Read-only; each call is\n   * written to the admin audit log. The bodies are Olive's own, so they go through `admin-pos-olive`.\n   * A 400 says the business has not connected Olive.\n   */\n  olive: {\n    account: (tenantId: string) =>\n      apiFetch<unknown>(`${tenantBase(tenantId)}/olive/account`),\n    accountTransactions: (\n      tenantId: string,\n      query: Record<string, string> = {},\n    ) =>\n      apiFetch<unknown>(\n        `${tenantBase(tenantId)}/olive/account/transactions${toQuery(query)}`,\n      ),\n    outlets: (tenantId: string) =>\n      apiFetch<unknown>(`${tenantBase(tenantId)}/olive/outlets`),\n    outletTerminals: (tenantId: string, outletId: string) =>\n      apiFetch<unknown>(\n        `${tenantBase(tenantId)}/olive/outlets/${id(outletId)}/terminals`,\n      ),\n  },\n\n  /** 409 when the terminal's status no longer allows it. */\n  setTerminalStatus: (terminalId: string, act: TerminalAct, reason: string) =>\n    post<PosTerminalDetail>(`${BASE}/terminals/${id(terminalId)}/${act}`, {\n      reason,\n    }),\n\n  /** Signs the shift out at its till. 409 when it is no longer open. */\n  closeShift: (shiftId: string, reason: string) =>\n    post<PosShift>(`${BASE}/shifts/${id(shiftId)}/close`, { reason }),\n};\n"],"mappings":"AAAA,SAAS,gBAAgB;AACzB;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,OAGK;AAsBP,MAAM,OAAO;AAEb,MAAM,KAAK,CAAC,UAAkB,mBAAmB,KAAK;AAEtD,MAAM,OAAO,CAAI,MAAc,SAC7B,SAAY,MAAM,EAAE,QAAQ,QAAQ,MAAM,KAAK,UAAU,IAAI,EAAE,CAAC;AAElE,MAAM,cAAc,CAAC,IAAe,CAAC,MAAM,QAAQ,EAAE,MAAM,EAAE,MAAM,IAAI,EAAE,GAAG,CAAC;AAE7E,MAAM,aAAa,CAAC,aAClB,8BAA8B,GAAG,QAAQ,CAAC;AAIrC,MAAM,cAAc;AAAA,EACzB,SAAS,CAAC,MACR,SAAqB,GAAG,IAAI,WAAW,YAAY,CAAC,CAAC,EAAE;AAAA,EAEzD,WAAW,CAAC,YACV;AAAA,IACE,GAAG,IAAI,aAAa,eAAe,OAAO,CAAC;AAAA,EAC7C;AAAA;AAAA,EAGF,UAAU,CAAC,YAAoB,MAC7B;AAAA,IACE,GAAG,IAAI,cAAc,GAAG,UAAU,CAAC,GAAG,YAAY,CAAC,CAAC;AAAA,EACtD;AAAA,EAEF,SAAS,CAAC,eACR,SAA6B,GAAG,IAAI,cAAc,GAAG,UAAU,CAAC,UAAU;AAAA,EAE5E,QAAQ,CAAC,YACP,SAA4B,GAAG,IAAI,UAAU,YAAY,OAAO,CAAC,EAAE;AAAA,EAErE,QAAQ,CAAC,UAAkB,MACzB;AAAA,IACE,8BAA8B,GAAG,QAAQ,CAAC,OAAO,YAAY,CAAC,CAAC;AAAA,EACjE;AAAA;AAAA,EAGF,QAAQ,CAAC,aACP,SAA2B,GAAG,WAAW,QAAQ,CAAC,YAAY;AAAA;AAAA,EAGhE,cAAc,CAAC,aACb;AAAA,IACE,mCAAmC,QAAQ,EAAE,SAAS,CAAC,CAAC;AAAA,EAC1D;AAAA;AAAA,EAGF,UAAU,CACR,UAKI,CAAC,MACF,SAA0B,GAAG,IAAI,YAAY,QAAQ,OAAO,CAAC,EAAE;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOpE,OAAO;AAAA,IACL,SAAS,CAAC,aACR,SAAkB,GAAG,WAAW,QAAQ,CAAC,gBAAgB;AAAA,IAC3D,qBAAqB,CACnB,UACA,QAAgC,CAAC,MAEjC;AAAA,MACE,GAAG,WAAW,QAAQ,CAAC,8BAA8B,QAAQ,KAAK,CAAC;AAAA,IACrE;AAAA,IACF,SAAS,CAAC,aACR,SAAkB,GAAG,WAAW,QAAQ,CAAC,gBAAgB;AAAA,IAC3D,iBAAiB,CAAC,UAAkB,aAClC;AAAA,MACE,GAAG,WAAW,QAAQ,CAAC,kBAAkB,GAAG,QAAQ,CAAC;AAAA,IACvD;AAAA,EACJ;AAAA;AAAA,EAGA,mBAAmB,CAAC,YAAoB,KAAkB,WACxD,KAAwB,GAAG,IAAI,cAAc,GAAG,UAAU,CAAC,IAAI,GAAG,IAAI;AAAA,IACpE;AAAA,EACF,CAAC;AAAA;AAAA,EAGH,YAAY,CAAC,SAAiB,WAC5B,KAAe,GAAG,IAAI,WAAW,GAAG,OAAO,CAAC,UAAU,EAAE,OAAO,CAAC;AACpE;","names":[]}

package/dist/admin-pos-olive.d.ts

@@ -0,0 +1,44 @@
+/**
+ * Olive's merchant API answers in its own shapes, which Box does not own, so these read them the way the
+ * merchant's own POS page does: tolerant of a `data` wrapper, of a list under one of several names, and of
+ * a field under one of several keys. Pure, so the guesses are tested rather than discovered on a live account.
+ */
+export type OliveResource = Record<string, unknown>;
+/** The object an answer carries: its `data` when that is an object, else the answer itself. */
+export declare function oliveObject(body: unknown): OliveResource;
+/** The list an answer carries, wherever Olive put it; empty when there is none. */
+export declare function oliveList(body: unknown): OliveResource[];
+/** The first of these keys that holds text or a number, as text; null when none does. */
+export declare function oliveText(r: OliveResource, ...keys: string[]): string | null;
+export interface OliveOutlet {
+    id: string;
+    name: string;
+    address: string | null;
+    contact: string | null;
+    terminalCount: number | null;
+    active: boolean;
+    createdAt: string | null;
+}
+/** An outlet row; an entry with no id is left out, as the merchant's page does. */
+export declare function oliveOutlets(body: unknown): OliveOutlet[];
+export interface OliveBalance {
+    /** The balance as Olive sent it, in kobo (minor units); null when the answer has none. */
+    balanceMinor: number | null;
+    accountNumber: string | null;
+    accountName: string | null;
+}
+export declare function oliveBalance(body: unknown): OliveBalance;
+/** Whether a ledger line is money in or out, by the words Olive uses; null when it says neither. */
+export declare function directionOf(t: OliveResource): 'in' | 'out' | null;
+export interface OliveTransaction {
+    id: string;
+    at: string | null;
+    summary: string;
+    /** Kobo (minor units), as Olive sends it. */
+    amountMinor: number | null;
+    direction: 'in' | 'out' | null;
+    status: string | null;
+    reference: string | null;
+}
+/** Account ledger lines, in the order Olive sent them. Amounts are kobo. */
+export declare function oliveTransactions(body: unknown): OliveTransaction[];

package/dist/admin-pos-olive.js

@@ -0,0 +1,93 @@
+const isObject = (v) => Boolean(v) && typeof v === "object" && !Array.isArray(v);
+const LIST_KEYS = [
+  "items",
+  "results",
+  "transactions",
+  "branches",
+  "terminals",
+  "data"
+];
+function oliveObject(body) {
+  if (!isObject(body)) return {};
+  return isObject(body.data) ? body.data : body;
+}
+function oliveList(body) {
+  if (Array.isArray(body)) return body.filter(isObject);
+  const root = oliveObject(body);
+  for (const key of LIST_KEYS) {
+    const found = root[key];
+    if (Array.isArray(found)) return found.filter(isObject);
+  }
+  return [];
+}
+function oliveText(r, ...keys) {
+  for (const key of keys) {
+    const v = r[key];
+    if (typeof v === "number") return String(v);
+    if (typeof v === "string" && v.trim()) return v.trim();
+  }
+  return null;
+}
+function oliveOutlets(body) {
+  return oliveList(body).flatMap((o, i) => {
+    const id = oliveText(o, "branchId", "id");
+    if (!id) return [];
+    const contact = [
+      oliveText(o, "contactFullName"),
+      oliveText(o, "contactNumber")
+    ].filter(Boolean).join(" \xB7 ");
+    const count = Number(o.terminalCount);
+    return [
+      {
+        id,
+        name: oliveText(o, "name", "branchName", "outletName", "label") ?? `Outlet ${i + 1}`,
+        address: oliveText(o, "address"),
+        contact: contact || null,
+        terminalCount: o.terminalCount == null || !Number.isFinite(count) ? null : count,
+        active: o.isActive !== false,
+        createdAt: oliveText(o, "createdAt")
+      }
+    ];
+  });
+}
+function oliveBalance(body) {
+  const a = oliveObject(body);
+  const raw = a.availableBalance ?? a.balance;
+  const n = typeof raw === "string" && raw.trim() === "" ? Number.NaN : Number(raw);
+  return {
+    balanceMinor: raw == null || !Number.isFinite(n) ? null : n,
+    accountNumber: oliveText(a, "accountNumber"),
+    accountName: oliveText(a, "accountName", "name")
+  };
+}
+function directionOf(t) {
+  const raw = (oliveText(t, "direction", "type", "transactionType", "entryType") ?? "").toLowerCase();
+  if (/\b(credit|inflow|deposit|received|collection)\b/.test(raw)) return "in";
+  if (/\b(debit|outflow|withdrawal|payout|transfer)\b/.test(raw)) return "out";
+  return null;
+}
+function oliveTransactions(body) {
+  return oliveList(body).map((t, i) => {
+    const raw = t.amount ?? t.transactionAmount;
+    const n = Number(raw);
+    return {
+      id: oliveText(t, "id", "transactionId", "reference") ?? `row-${i}`,
+      at: oliveText(t, "createdAt", "transactionDate", "date"),
+      summary: oliveText(t, "narration", "description", "type") ?? "Transaction",
+      amountMinor: raw == null || raw === "" || !Number.isFinite(n) ? null : n,
+      direction: directionOf(t),
+      status: oliveText(t, "status"),
+      reference: oliveText(t, "reference", "transactionReference")
+    };
+  });
+}
+export {
+  directionOf,
+  oliveBalance,
+  oliveList,
+  oliveObject,
+  oliveOutlets,
+  oliveText,
+  oliveTransactions
+};
+//# sourceMappingURL=admin-pos-olive.js.map

package/dist/admin-pos-olive.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/admin-pos-olive.ts"],"sourcesContent":["/**\n * Olive's merchant API answers in its own shapes, which Box does not own, so these read them the way the\n * merchant's own POS page does: tolerant of a `data` wrapper, of a list under one of several names, and of\n * a field under one of several keys. Pure, so the guesses are tested rather than discovered on a live account.\n */\n\nexport type OliveResource = Record<string, unknown>;\n\nconst isObject = (v: unknown): v is OliveResource =>\n  Boolean(v) && typeof v === 'object' && !Array.isArray(v);\n\nconst LIST_KEYS = [\n  'items',\n  'results',\n  'transactions',\n  'branches',\n  'terminals',\n  'data',\n];\n\n/** The object an answer carries: its `data` when that is an object, else the answer itself. */\nexport function oliveObject(body: unknown): OliveResource {\n  if (!isObject(body)) return {};\n\n  return isObject(body.data) ? body.data : body;\n}\n\n/** The list an answer carries, wherever Olive put it; empty when there is none. */\nexport function oliveList(body: unknown): OliveResource[] {\n  if (Array.isArray(body)) return body.filter(isObject);\n\n  const root = oliveObject(body);\n\n  for (const key of LIST_KEYS) {\n    const found = root[key];\n\n    if (Array.isArray(found)) return found.filter(isObject);\n  }\n\n  return [];\n}\n\n/** The first of these keys that holds text or a number, as text; null when none does. */\nexport function oliveText(r: OliveResource, ...keys: string[]): string | null {\n  for (const key of keys) {\n    const v = r[key];\n\n    if (typeof v === 'number') return String(v);\n\n    if (typeof v === 'string' && v.trim()) return v.trim();\n  }\n\n  return null;\n}\n\nexport interface OliveOutlet {\n  id: string;\n  name: string;\n  address: string | null;\n  contact: string | null;\n  terminalCount: number | null;\n  active: boolean;\n  createdAt: string | null;\n}\n\n/** An outlet row; an entry with no id is left out, as the merchant's page does. */\nexport function oliveOutlets(body: unknown): OliveOutlet[] {\n  return oliveList(body).flatMap((o, i) => {\n    const id = oliveText(o, 'branchId', 'id');\n\n    if (!id) return [];\n\n    const contact = [\n      oliveText(o, 'contactFullName'),\n      oliveText(o, 'contactNumber'),\n    ]\n      .filter(Boolean)\n      .join(' · ');\n    const count = Number(o.terminalCount);\n\n    return [\n      {\n        id,\n        name:\n          oliveText(o, 'name', 'branchName', 'outletName', 'label') ??\n          `Outlet ${i + 1}`,\n        address: oliveText(o, 'address'),\n        contact: contact || null,\n        terminalCount:\n          o.terminalCount == null || !Number.isFinite(count) ? null : count,\n        active: o.isActive !== false,\n        createdAt: oliveText(o, 'createdAt'),\n      },\n    ];\n  });\n}\n\nexport interface OliveBalance {\n  /** The balance as Olive sent it, in kobo (minor units); null when the answer has none. */\n  balanceMinor: number | null;\n  accountNumber: string | null;\n  accountName: string | null;\n}\n\nexport function oliveBalance(body: unknown): OliveBalance {\n  const a = oliveObject(body);\n  const raw = a.availableBalance ?? a.balance;\n  const n =\n    typeof raw === 'string' && raw.trim() === '' ? Number.NaN : Number(raw);\n\n  return {\n    balanceMinor: raw == null || !Number.isFinite(n) ? null : n,\n    accountNumber: oliveText(a, 'accountNumber'),\n    accountName: oliveText(a, 'accountName', 'name'),\n  };\n}\n\n/** Whether a ledger line is money in or out, by the words Olive uses; null when it says neither. */\nexport function directionOf(t: OliveResource): 'in' | 'out' | null {\n  const raw = (\n    oliveText(t, 'direction', 'type', 'transactionType', 'entryType') ?? ''\n  ).toLowerCase();\n\n  if (/\\b(credit|inflow|deposit|received|collection)\\b/.test(raw)) return 'in';\n\n  if (/\\b(debit|outflow|withdrawal|payout|transfer)\\b/.test(raw)) return 'out';\n\n  return null;\n}\n\nexport interface OliveTransaction {\n  id: string;\n  at: string | null;\n  summary: string;\n  /** Kobo (minor units), as Olive sends it. */\n  amountMinor: number | null;\n  direction: 'in' | 'out' | null;\n  status: string | null;\n  reference: string | null;\n}\n\n/** Account ledger lines, in the order Olive sent them. Amounts are kobo. */\nexport function oliveTransactions(body: unknown): OliveTransaction[] {\n  return oliveList(body).map((t, i) => {\n    const raw = t.amount ?? t.transactionAmount;\n    const n = Number(raw);\n\n    return {\n      id: oliveText(t, 'id', 'transactionId', 'reference') ?? `row-${i}`,\n      at: oliveText(t, 'createdAt', 'transactionDate', 'date'),\n      summary:\n        oliveText(t, 'narration', 'description', 'type') ?? 'Transaction',\n      amountMinor: raw == null || raw === '' || !Number.isFinite(n) ? null : n,\n      direction: directionOf(t),\n      status: oliveText(t, 'status'),\n      reference: oliveText(t, 'reference', 'transactionReference'),\n    };\n  });\n}\n"],"mappings":"AAQA,MAAM,WAAW,CAAC,MAChB,QAAQ,CAAC,KAAK,OAAO,MAAM,YAAY,CAAC,MAAM,QAAQ,CAAC;AAEzD,MAAM,YAAY;AAAA,EAChB;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF;AAGO,SAAS,YAAY,MAA8B;AACxD,MAAI,CAAC,SAAS,IAAI,EAAG,QAAO,CAAC;AAE7B,SAAO,SAAS,KAAK,IAAI,IAAI,KAAK,OAAO;AAC3C;AAGO,SAAS,UAAU,MAAgC;AACxD,MAAI,MAAM,QAAQ,IAAI,EAAG,QAAO,KAAK,OAAO,QAAQ;AAEpD,QAAM,OAAO,YAAY,IAAI;AAE7B,aAAW,OAAO,WAAW;AAC3B,UAAM,QAAQ,KAAK,GAAG;AAEtB,QAAI,MAAM,QAAQ,KAAK,EAAG,QAAO,MAAM,OAAO,QAAQ;AAAA,EACxD;AAEA,SAAO,CAAC;AACV;AAGO,SAAS,UAAU,MAAqB,MAA+B;AAC5E,aAAW,OAAO,MAAM;AACtB,UAAM,IAAI,EAAE,GAAG;AAEf,QAAI,OAAO,MAAM,SAAU,QAAO,OAAO,CAAC;AAE1C,QAAI,OAAO,MAAM,YAAY,EAAE,KAAK,EAAG,QAAO,EAAE,KAAK;AAAA,EACvD;AAEA,SAAO;AACT;AAaO,SAAS,aAAa,MAA8B;AACzD,SAAO,UAAU,IAAI,EAAE,QAAQ,CAAC,GAAG,MAAM;AACvC,UAAM,KAAK,UAAU,GAAG,YAAY,IAAI;AAExC,QAAI,CAAC,GAAI,QAAO,CAAC;AAEjB,UAAM,UAAU;AAAA,MACd,UAAU,GAAG,iBAAiB;AAAA,MAC9B,UAAU,GAAG,eAAe;AAAA,IAC9B,EACG,OAAO,OAAO,EACd,KAAK,QAAK;AACb,UAAM,QAAQ,OAAO,EAAE,aAAa;AAEpC,WAAO;AAAA,MACL;AAAA,QACE;AAAA,QACA,MACE,UAAU,GAAG,QAAQ,cAAc,cAAc,OAAO,KACxD,UAAU,IAAI,CAAC;AAAA,QACjB,SAAS,UAAU,GAAG,SAAS;AAAA,QAC/B,SAAS,WAAW;AAAA,QACpB,eACE,EAAE,iBAAiB,QAAQ,CAAC,OAAO,SAAS,KAAK,IAAI,OAAO;AAAA,QAC9D,QAAQ,EAAE,aAAa;AAAA,QACvB,WAAW,UAAU,GAAG,WAAW;AAAA,MACrC;AAAA,IACF;AAAA,EACF,CAAC;AACH;AASO,SAAS,aAAa,MAA6B;AACxD,QAAM,IAAI,YAAY,IAAI;AAC1B,QAAM,MAAM,EAAE,oBAAoB,EAAE;AACpC,QAAM,IACJ,OAAO,QAAQ,YAAY,IAAI,KAAK,MAAM,KAAK,OAAO,MAAM,OAAO,GAAG;AAExE,SAAO;AAAA,IACL,cAAc,OAAO,QAAQ,CAAC,OAAO,SAAS,CAAC,IAAI,OAAO;AAAA,IAC1D,eAAe,UAAU,GAAG,eAAe;AAAA,IAC3C,aAAa,UAAU,GAAG,eAAe,MAAM;AAAA,EACjD;AACF;AAGO,SAAS,YAAY,GAAuC;AACjE,QAAM,OACJ,UAAU,GAAG,aAAa,QAAQ,mBAAmB,WAAW,KAAK,IACrE,YAAY;AAEd,MAAI,kDAAkD,KAAK,GAAG,EAAG,QAAO;AAExE,MAAI,iDAAiD,KAAK,GAAG,EAAG,QAAO;AAEvE,SAAO;AACT;AAcO,SAAS,kBAAkB,MAAmC;AACnE,SAAO,UAAU,IAAI,EAAE,IAAI,CAAC,GAAG,MAAM;AACnC,UAAM,MAAM,EAAE,UAAU,EAAE;AAC1B,UAAM,IAAI,OAAO,GAAG;AAEpB,WAAO;AAAA,MACL,IAAI,UAAU,GAAG,MAAM,iBAAiB,WAAW,KAAK,OAAO,CAAC;AAAA,MAChE,IAAI,UAAU,GAAG,aAAa,mBAAmB,MAAM;AAAA,MACvD,SACE,UAAU,GAAG,aAAa,eAAe,MAAM,KAAK;AAAA,MACtD,aAAa,OAAO,QAAQ,QAAQ,MAAM,CAAC,OAAO,SAAS,CAAC,IAAI,OAAO;AAAA,MACvE,WAAW,YAAY,CAAC;AAAA,MACxB,QAAQ,UAAU,GAAG,QAAQ;AAAA,MAC7B,WAAW,UAAU,GAAG,aAAa,sBAAsB;AAAA,IAC7D;AAAA,EACF,CAAC;AACH;","names":[]}

package/dist/admin-pos-types.d.ts

@@ -120,3 +120,46 @@ export interface PosWindow {
     from?: string;
     to?: string;
 }
+/** One person on a business's till roster (`GET /tenants/:id/pos/operators`). */
+export interface PosRosterEntry {
+    id: string;
+    /** The name they sign in with at the till. */
+    signIn: string;
+    name: string;
+    role: string;
+    active: boolean;
+    shiftLimitMinutes: number;
+    updatedAt: string;
+}
+export type TillRequestStatus = 'pending' | 'approved' | 'rejected' | 'fulfilled';
+/** A request for terminals (`GET /till-requests?tenantId=`). */
+export interface PosTillRequest {
+    id: string;
+    tenantId: string;
+    quantity: number;
+    note: string | null;
+    status: TillRequestStatus;
+    decidedBy: string | null;
+    decisionNote: string | null;
+    decidedAt: string | null;
+    /** The system that decides it (`olive`), or null when an admin does. */
+    source: string | null;
+    createdAt: string;
+}
+/** One card payment (`GET /pos/payments`). `amountMinor` is in the currency's minor units. */
+export interface PosPayment {
+    id: string;
+    tenantId: string;
+    deviceId: string | null;
+    deviceLabel: string | null;
+    direction: 'in' | 'out';
+    amountMinor: string;
+    currency: string;
+    status: string;
+    reference: string | null;
+    at: string;
+}
+export interface PosPaymentsPage {
+    rows: PosPayment[];
+    nextCursor: string | null;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@withpotter/lib",
-  "version": "0.13.0-next.103",
+  "version": "0.13.0-next.105",
   "description": "Box dashboard foundation: API client, contexts, types, intent config, and utilities.",
   "license": "UNLICENSED",
   "sideEffects": false,