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

package/src/lib/server/pos-check-in.d.ts

@@ -0,0 +1,49 @@
+import type { PluginApiHandler, PluginApiRequest } from '@aglyn/aglyn/server';
+import { type PosOpsDeps } from './pos-ops-gate';
+import { type PosSaleCompletedEvent } from './pos-sale';
+/** How stale a day's reconcile may be before a search or the list redoes it. */
+export declare const CHECK_IN_RECONCILE_MS = 30000;
+type Outcome = {
+    status: number;
+    body: Record<string, unknown>;
+} | {
+    status: 200;
+    csv: string;
+    filename: string;
+};
+export interface CheckInDay {
+    dayKey: string;
+    startMs: number;
+    endMs: number;
+    timeZone: string;
+}
+/** The day asked for, in the site's zone; today there when absent. */
+export declare function readCheckInDay(deps: PosOpsDeps, hostRef: FirebaseFirestore.DocumentReference, org: Record<string, any> | null, rawDay: unknown): Promise<({
+    ok: true;
+} & CheckInDay) | {
+    ok: false;
+    error: string;
+}>;
+/**
+ * Brings a day's check-ins in line with its orders and stays, at most every
+ * {@link CHECK_IN_RECONCILE_MS} unless `force`. Answers whether a source
+ * held more than one day reads.
+ */
+export declare function reconcileCheckInDay(deps: PosOpsDeps, hostRef: FirebaseFirestore.DocumentReference, day: CheckInDay, options?: {
+    force?: boolean;
+    onlyIfUsed?: boolean;
+}): Promise<{
+    truncated: boolean;
+}>;
+/**
+ * The check-ins a register sale makes, written the moment it completes so
+ * the person who just paid at the window is found on the next search. The
+ * day is the sale's own, in the site's zone.
+ */
+export declare function recordSaleCheckIns(deps: PosOpsDeps, event: PosSaleCompletedEvent): Promise<number>;
+/** Writes a register sale's check-ins as it completes. Never throws into the sale. */
+export declare function registerPosSaleCheckIns(): void;
+export declare function handlePosCheckIn(deps: PosOpsDeps, req: PluginApiRequest): Promise<Outcome>;
+export declare function createPosCheckInHandler(deps?: () => PosOpsDeps): PluginApiHandler;
+export declare const posCheckInHandler: PluginApiHandler;
+export {};