@voyant-travel/allotments 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,42 @@
+/**
+ * The canonical allotment lifecycle — held inventory with an option/cutoff/
+ * release lifecycle and live pickup counters. Identical whether the unit is a
+ * hotel room (accommodations room blocks), m² of function space (operations
+ * space blocks), a coach seat, etc. — only the unit and the type-specific
+ * tables differ.
+ *
+ * This package owns the SHARED CONTRACT (state machine + counter math + slot
+ * enumeration + ledger status), reused by type-specific tables. There is no
+ * single polymorphic table. See RFC voyant#1489 §4.3 / §9-Q2.
+ *
+ * Pure logic only — no DB or Drizzle dependency. Each consumer keeps its own
+ * thin transactional service that maintains its counters in the same
+ * transaction as each ledger write, guarded by table CHECK constraints.
+ */
+/** Block header lifecycle stages (negotiation, NOT pickup progress). */
+export declare const ALLOTMENT_STATUSES: readonly ["inquiry", "held", "confirmed", "released", "cancelled", "expired"];
+export type AllotmentStatus = (typeof ALLOTMENT_STATUSES)[number];
+/** Statuses that can no longer accrue pickups. */
+export declare const CLOSED_ALLOTMENT_STATUSES: readonly ["released", "cancelled", "expired"];
+export declare function isClosedAllotmentStatus(status: string): boolean;
+/** The append-only pickup ledger is compensated (reversed), never deleted. */
+export declare const ALLOTMENT_PICKUP_STATUSES: readonly ["active", "reversed"];
+export type AllotmentPickupStatus = (typeof ALLOTMENT_PICKUP_STATUSES)[number];
+/** Per-slot counters: held − pickedUp − released = remaining. */
+export interface AllotmentCounters {
+    held: number;
+    pickedUp: number;
+    released: number;
+}
+export declare function allotmentRemaining(counters: AllotmentCounters): number;
+/** Pickup progress is DERIVED from counters at read time — never stored. */
+export type PickupProgress = "none" | "partial" | "full";
+export declare function allotmentPickupProgress(counters: AllotmentCounters): PickupProgress;
+/**
+ * The slot dates a stay/hold occupies: each date from `start` (inclusive) to
+ * `end` (exclusive). Dates are `YYYY-MM-DD`, parsed as UTC to avoid timezone
+ * drift across the day boundary. One date = one allotment slot (a hotel night,
+ * a space-day, …). Returns `[]` for an invalid or non-positive range.
+ */
+export declare function eachDateInRange(start: string, end: string): string[];
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,wEAAwE;AACxE,eAAO,MAAM,kBAAkB,+EAOrB,CAAA;AAEV,MAAM,MAAM,eAAe,GAAG,CAAC,OAAO,kBAAkB,CAAC,CAAC,MAAM,CAAC,CAAA;AAEjE,kDAAkD;AAClD,eAAO,MAAM,yBAAyB,+CAAgD,CAAA;AAEtF,wBAAgB,uBAAuB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAE/D;AAED,8EAA8E;AAC9E,eAAO,MAAM,yBAAyB,iCAAkC,CAAA;AACxE,MAAM,MAAM,qBAAqB,GAAG,CAAC,OAAO,yBAAyB,CAAC,CAAC,MAAM,CAAC,CAAA;AAE9E,iEAAiE;AACjE,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,MAAM,CAAA;CACjB;AAED,wBAAgB,kBAAkB,CAAC,QAAQ,EAAE,iBAAiB,GAAG,MAAM,CAEtE;AAED,4EAA4E;AAC5E,MAAM,MAAM,cAAc,GAAG,MAAM,GAAG,SAAS,GAAG,MAAM,CAAA;AAExD,wBAAgB,uBAAuB,CAAC,QAAQ,EAAE,iBAAiB,GAAG,cAAc,CAGnF;AAED;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,CASpE"}

package/dist/index.js

@@ -0,0 +1,56 @@
+/**
+ * The canonical allotment lifecycle — held inventory with an option/cutoff/
+ * release lifecycle and live pickup counters. Identical whether the unit is a
+ * hotel room (accommodations room blocks), m² of function space (operations
+ * space blocks), a coach seat, etc. — only the unit and the type-specific
+ * tables differ.
+ *
+ * This package owns the SHARED CONTRACT (state machine + counter math + slot
+ * enumeration + ledger status), reused by type-specific tables. There is no
+ * single polymorphic table. See RFC voyant#1489 §4.3 / §9-Q2.
+ *
+ * Pure logic only — no DB or Drizzle dependency. Each consumer keeps its own
+ * thin transactional service that maintains its counters in the same
+ * transaction as each ledger write, guarded by table CHECK constraints.
+ */
+/** Block header lifecycle stages (negotiation, NOT pickup progress). */
+export const ALLOTMENT_STATUSES = [
+    "inquiry",
+    "held",
+    "confirmed",
+    "released",
+    "cancelled",
+    "expired",
+];
+/** Statuses that can no longer accrue pickups. */
+export const CLOSED_ALLOTMENT_STATUSES = ["released", "cancelled", "expired"];
+export function isClosedAllotmentStatus(status) {
+    return CLOSED_ALLOTMENT_STATUSES.includes(status);
+}
+/** The append-only pickup ledger is compensated (reversed), never deleted. */
+export const ALLOTMENT_PICKUP_STATUSES = ["active", "reversed"];
+export function allotmentRemaining(counters) {
+    return counters.held - counters.pickedUp - counters.released;
+}
+export function allotmentPickupProgress(counters) {
+    if (counters.pickedUp === 0)
+        return "none";
+    return allotmentRemaining(counters) === 0 ? "full" : "partial";
+}
+/**
+ * The slot dates a stay/hold occupies: each date from `start` (inclusive) to
+ * `end` (exclusive). Dates are `YYYY-MM-DD`, parsed as UTC to avoid timezone
+ * drift across the day boundary. One date = one allotment slot (a hotel night,
+ * a space-day, …). Returns `[]` for an invalid or non-positive range.
+ */
+export function eachDateInRange(start, end) {
+    const from = new Date(`${start}T00:00:00Z`);
+    const to = new Date(`${end}T00:00:00Z`);
+    if (Number.isNaN(from.getTime()) || Number.isNaN(to.getTime()))
+        return [];
+    const dates = [];
+    for (let d = from; d < to; d.setUTCDate(d.getUTCDate() + 1)) {
+        dates.push(d.toISOString().slice(0, 10));
+    }
+    return dates;
+}

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "@voyant-travel/allotments",
+  "version": "0.1.0",
+  "license": "Apache-2.0",
+  "type": "module",
+  "exports": {
+    ".": "./src/index.ts"
+  },
+  "scripts": {
+    "typecheck": "tsc --noEmit",
+    "lint": "biome check src/",
+    "test": "vitest run --passWithNoTests",
+    "build": "tsc -p tsconfig.json",
+    "clean": "rm -rf dist tsconfig.tsbuildinfo",
+    "prepack": "pnpm run build"
+  },
+  "devDependencies": {
+    "@voyant-travel/voyant-typescript-config": "workspace:^",
+    "typescript": "^6.0.2",
+    "vitest": "^4.1.2"
+  },
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public",
+    "exports": {
+      ".": {
+        "types": "./dist/index.d.ts",
+        "import": "./dist/index.js",
+        "default": "./dist/index.js"
+      }
+    },
+    "main": "./dist/index.js",
+    "types": "./dist/index.d.ts"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/voyant-travel/voyant.git",
+    "directory": "packages/allotments"
+  }
+}