@voyant-travel/inventory 0.2.0 → 0.3.0

package/dist/routes-brochure.d.ts

@@ -0,0 +1,56 @@
+/**
+ * Product brochure generation route, owned by `@voyant-travel/inventory`.
+ *
+ *   POST /:id/brochure/generate   — generate + store a product brochure PDF
+ *
+ * The route registers a RELATIVE path; a deployment mounts the returned `Hono`
+ * at `/v1/admin/products`. The brochure task (`generateAndStoreProductBrochure`)
+ * already lives in this package; this factory only wires it to an HTTP surface.
+ *
+ * The deployment supplies the storage-backed specifics via `options`:
+ *   - `resolveStorage(c)` — the R2-backed `StorageProvider` to upload into (or
+ *     `null` when storage isn't configured → 503),
+ *   - `resolvePrinter(c)` — an optional PDF printer (e.g. a browser-rendering
+ *     service); when omitted the default pdf-lib printer is used,
+ *   - `template` / `keyPrefix` / `maxSizeBytes` overrides.
+ *
+ * Keeping these injected means inventory never imports the deployment's R2
+ * binding or cloud client.
+ */
+import type { StorageProvider } from "@voyant-travel/storage";
+import { type Context, Hono } from "hono";
+import type { Env } from "./route-env.js";
+import { type ProductBrochurePrinter, type ProductBrochureTemplateDefinition } from "./tasks/index.js";
+/**
+ * Deployment-supplied options for the product brochure route. Structural only —
+ * the injected functions encapsulate the deployment's storage binding and
+ * (optional) PDF renderer so this package stays free of those static imports.
+ */
+export interface ProductBrochureRoutesOptions {
+    /**
+     * Resolve the storage provider to upload the generated brochure into, or
+     * `null` when storage isn't configured (the route then responds `503`).
+     */
+    resolveStorage(c: Context): StorageProvider | null;
+    /**
+     * Resolve an optional PDF printer for this request (e.g. a browser-rendering
+     * service). When omitted, the brochure task falls back to its built-in
+     * pdf-lib printer.
+     */
+    resolvePrinter?(c: Context): ProductBrochurePrinter | null;
+    /**
+     * The brochure template. Defaults to {@link createDefaultProductBrochureTemplate}.
+     */
+    template?: ProductBrochureTemplateDefinition;
+    /** Storage key prefix builder. Defaults to `brochures/products/:id`. */
+    keyPrefix?(productId: string): string;
+    /** Max generated PDF size in bytes before rejecting with 413. */
+    maxSizeBytes?: number;
+}
+/**
+ * Build the product brochure route (relative path; mount at
+ * `/v1/admin/products`). Storage + the optional printer are injected via
+ * `options`.
+ */
+export declare function createProductBrochureRoutes(options: ProductBrochureRoutesOptions): Hono<Env>;
+//# sourceMappingURL=routes-brochure.d.ts.map

package/dist/routes-brochure.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"routes-brochure.d.ts","sourceRoot":"","sources":["../src/routes-brochure.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AAEH,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAA;AAC7D,OAAO,EAAE,KAAK,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAAA;AAGzC,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,gBAAgB,CAAA;AACzC,OAAO,EAGL,KAAK,sBAAsB,EAC3B,KAAK,iCAAiC,EACvC,MAAM,kBAAkB,CAAA;AAKzB;;;;GAIG;AACH,MAAM,WAAW,4BAA4B;IAC3C;;;OAGG;IACH,cAAc,CAAC,CAAC,EAAE,OAAO,GAAG,eAAe,GAAG,IAAI,CAAA;IAClD;;;;OAIG;IACH,cAAc,CAAC,CAAC,CAAC,EAAE,OAAO,GAAG,sBAAsB,GAAG,IAAI,CAAA;IAC1D;;OAEG;IACH,QAAQ,CAAC,EAAE,iCAAiC,CAAA;IAC5C,wEAAwE;IACxE,SAAS,CAAC,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,CAAA;IACrC,iEAAiE;IACjE,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB;AAED;;;;GAIG;AACH,wBAAgB,2BAA2B,CAAC,OAAO,EAAE,4BAA4B,GAAG,IAAI,CAAC,GAAG,CAAC,CAiD5F"}

package/dist/routes-brochure.js

@@ -0,0 +1,73 @@
+/**
+ * Product brochure generation route, owned by `@voyant-travel/inventory`.
+ *
+ *   POST /:id/brochure/generate   — generate + store a product brochure PDF
+ *
+ * The route registers a RELATIVE path; a deployment mounts the returned `Hono`
+ * at `/v1/admin/products`. The brochure task (`generateAndStoreProductBrochure`)
+ * already lives in this package; this factory only wires it to an HTTP surface.
+ *
+ * The deployment supplies the storage-backed specifics via `options`:
+ *   - `resolveStorage(c)` — the R2-backed `StorageProvider` to upload into (or
+ *     `null` when storage isn't configured → 503),
+ *   - `resolvePrinter(c)` — an optional PDF printer (e.g. a browser-rendering
+ *     service); when omitted the default pdf-lib printer is used,
+ *   - `template` / `keyPrefix` / `maxSizeBytes` overrides.
+ *
+ * Keeping these injected means inventory never imports the deployment's R2
+ * binding or cloud client.
+ */
+import { Hono } from "hono";
+import { emitProductContentChanged } from "./events.js";
+import { createDefaultProductBrochureTemplate, generateAndStoreProductBrochure, } from "./tasks/index.js";
+/** 5 MiB cap on a generated brochure PDF before it's rejected with 413. */
+const DEFAULT_MAX_BROCHURE_PDF_BYTES = 5 * 1024 * 1024;
+/**
+ * Build the product brochure route (relative path; mount at
+ * `/v1/admin/products`). Storage + the optional printer are injected via
+ * `options`.
+ */
+export function createProductBrochureRoutes(options) {
+    const hono = new Hono();
+    const maxSizeBytes = options.maxSizeBytes ?? DEFAULT_MAX_BROCHURE_PDF_BYTES;
+    hono.post("/:id/brochure/generate", async (c) => {
+        const storage = options.resolveStorage(c);
+        if (!storage) {
+            return c.json({ error: "Storage not configured" }, 503);
+        }
+        const productId = c.req.param("id");
+        if (!productId)
+            return c.json({ error: "id route param is required" }, 400);
+        const printer = options.resolvePrinter?.(c) ?? null;
+        const keyPrefix = options.keyPrefix?.(productId) ?? `brochures/products/${productId}`;
+        let generated;
+        try {
+            generated = await generateAndStoreProductBrochure(c.get("db"), productId, {
+                storage,
+                template: options.template ?? createDefaultProductBrochureTemplate(),
+                ...(printer ? { printer } : {}),
+                keyPrefix,
+                filename: ({ productId: generatedProductId, filename }) => `brochure-${generatedProductId}-${Date.now()}-${filename}`,
+                maxSizeBytes,
+            });
+        }
+        catch (err) {
+            const message = err instanceof Error ? err.message : String(err);
+            if (message.includes("Generated brochure is too large")) {
+                return c.json({ error: message }, 413);
+            }
+            throw err;
+        }
+        await emitProductContentChanged(c.get("eventBus"), { id: productId, axis: "media" });
+        return c.json({
+            data: generated.brochure,
+            metadata: {
+                filename: generated.filename,
+                sizeBytes: generated.sizeBytes,
+                storageKey: generated.storageKey,
+                url: generated.url,
+            },
+        });
+    });
+    return hono;
+}

package/dist/routes-brochure.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=routes-brochure.test.d.ts.map

package/dist/routes-brochure.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"routes-brochure.test.d.ts","sourceRoot":"","sources":["../src/routes-brochure.test.ts"],"names":[],"mappings":""}

package/dist/routes-brochure.test.js

@@ -0,0 +1,92 @@
+// @vitest-environment node
+import { Hono } from "hono";
+import { beforeEach, describe, expect, it, vi } from "vitest";
+const brochures = vi.hoisted(() => ({
+    generateAndStoreProductBrochure: vi.fn(),
+    createDefaultProductBrochureTemplate: vi.fn(() => ({ id: "default" })),
+}));
+vi.mock("./tasks/index.js", () => brochures);
+import { createProductBrochureRoutes } from "./routes-brochure.js";
+function storageStub() {
+    return {
+        name: "stub",
+        upload: vi.fn(async () => ({ key: "k", url: "/u" })),
+        delete: vi.fn(async () => { }),
+        signedUrl: vi.fn(async () => "/signed"),
+        get: vi.fn(async () => null),
+    };
+}
+function mountApp(resolveStorage, db = {}) {
+    const app = new Hono();
+    app.use("*", async (c, next) => {
+        c.set("db", db);
+        await next();
+    });
+    app.route("/v1/admin/products", createProductBrochureRoutes({ resolveStorage }));
+    return app;
+}
+describe("product brochure routes", () => {
+    beforeEach(() => {
+        vi.clearAllMocks();
+    });
+    it("responds 503 when storage is unconfigured", async () => {
+        const app = mountApp(() => null);
+        const response = await app.request("/v1/admin/products/prod_1/brochure/generate", {
+            method: "POST",
+        });
+        expect(response.status).toBe(503);
+        expect(brochures.generateAndStoreProductBrochure).not.toHaveBeenCalled();
+    });
+    it("generates + stores a brochure and returns metadata", async () => {
+        brochures.generateAndStoreProductBrochure.mockResolvedValue({
+            brochure: { id: "brch_1" },
+            filename: "brochure-prod_1.pdf",
+            sizeBytes: 1234,
+            storageKey: "brochures/products/prod_1/brochure-prod_1.pdf",
+            url: "/api/v1/media/brochures/products/prod_1/brochure-prod_1.pdf",
+        });
+        const storage = storageStub();
+        const app = mountApp(() => storage);
+        const response = await app.request("/v1/admin/products/prod_1/brochure/generate", {
+            method: "POST",
+        });
+        expect(response.status).toBe(200);
+        const body = (await response.json());
+        expect(body.data.id).toBe("brch_1");
+        expect(body.metadata.sizeBytes).toBe(1234);
+        expect(brochures.generateAndStoreProductBrochure).toHaveBeenCalledWith(expect.anything(), "prod_1", expect.objectContaining({
+            storage,
+            keyPrefix: "brochures/products/prod_1",
+            maxSizeBytes: 5 * 1024 * 1024,
+        }));
+    });
+    it("maps an oversized brochure to 413", async () => {
+        brochures.generateAndStoreProductBrochure.mockRejectedValue(new Error("Generated brochure is too large (9000000 bytes). Max allowed is 5242880 bytes."));
+        const app = mountApp(() => storageStub());
+        const response = await app.request("/v1/admin/products/prod_1/brochure/generate", {
+            method: "POST",
+        });
+        expect(response.status).toBe(413);
+    });
+    it("passes an injected printer through to the task", async () => {
+        brochures.generateAndStoreProductBrochure.mockResolvedValue({
+            brochure: { id: "brch_1" },
+            filename: "f.pdf",
+            sizeBytes: 1,
+            storageKey: "brochures/products/prod_1/f.pdf",
+            url: "/u",
+        });
+        const printer = vi.fn();
+        const app = new Hono();
+        app.use("*", async (c, next) => {
+            c.set("db", {});
+            await next();
+        });
+        app.route("/v1/admin/products", createProductBrochureRoutes({
+            resolveStorage: () => storageStub(),
+            resolvePrinter: () => printer,
+        }));
+        await app.request("/v1/admin/products/prod_1/brochure/generate", { method: "POST" });
+        expect(brochures.generateAndStoreProductBrochure).toHaveBeenCalledWith(expect.anything(), "prod_1", expect.objectContaining({ printer }));
+    });
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@voyant-travel/inventory",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "license": "Apache-2.0",
   "type": "module",
   "exports": {
@@ -24,6 +24,11 @@
       "import": "./dist/routes.js",
       "default": "./dist/routes.js"
     },
+    "./routes-brochure": {
+      "types": "./dist/routes-brochure.d.ts",
+      "import": "./dist/routes-brochure.js",
+      "default": "./dist/routes-brochure.js"
+    },
     "./action-ledger-drift": {
       "types": "./dist/action-ledger-drift.d.ts",
       "import": "./dist/action-ledger-drift.js",
@@ -157,17 +162,17 @@
     "pdf-lib": "^1.17.1",
     "sanitize-html": "^2.17.4",
     "zod": "^4.3.6",
-    "@voyant-travel/action-ledger": "^0.104.11",
-    "@voyant-travel/catalog": "^0.118.0",
+    "@voyant-travel/action-ledger": "^0.105.0",
+    "@voyant-travel/catalog": "^0.119.0",
     "@voyant-travel/core": "^0.109.0",
-    "@voyant-travel/db": "^0.108.0",
+    "@voyant-travel/db": "^0.108.1",
     "@voyant-travel/extras-contracts": "^0.104.2",
-    "@voyant-travel/hono": "^0.110.0",
-    "@voyant-travel/commerce": "^0.2.0",
-    "@voyant-travel/products-contracts": "^0.105.4",
-    "@voyant-travel/storage": "^0.104.1",
-    "@voyant-travel/utils": "^0.105.1",
-    "@voyant-travel/operations": "^0.1.0"
+    "@voyant-travel/hono": "^0.111.0",
+    "@voyant-travel/commerce": "^0.3.0",
+    "@voyant-travel/products-contracts": "^0.105.5",
+    "@voyant-travel/storage": "^0.105.0",
+    "@voyant-travel/utils": "^0.105.2",
+    "@voyant-travel/operations": "^0.1.1"
   },
   "devDependencies": {
     "@types/sanitize-html": "^2.16.1",