npm - @tokenoftrust/storefront-runner - Versions diffs - 1.3.2 - Mend

@tokenoftrust/storefront-runner 1.3.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (310) hide show

package/apps/storefront/env.d.ts ADDED Viewed

@@ -0,0 +1,162 @@
+/// <reference path="./.astro/types.d.ts" />
+/// <reference types="astro/client" />
+import type {
+  TenantConfig,
+  CustomizationEnv,
+  TenantFeatures,
+  ResolvedFoxyCommerce,
+  CapabilityConfig,
+} from "@tot/public-runtime";
+import type { ToTClient } from "@/lib/tot/ToTClient";
+import type { ContentProvider } from "@/lib/storyblok/provider";
+/**
+ * Minimal binding shapes. We intentionally do NOT depend on
+ * @cloudflare/workers-types (not installed); these cover what Phase 1 touches.
+ * Widen them when real KV/R2 calls are added.
+ */
+interface KVNamespaceLike {
+  get(key: string, opts?: { cacheTtl?: number }): Promise<string | null>;
+  put(key: string, value: string, opts?: Record<string, unknown>): Promise<void>;
+  list(opts?: { prefix?: string; cursor?: string; limit?: number }): Promise<{
+    keys: { name: string }[];
+    list_complete: boolean;
+    cursor?: string;
+  }>;
+  delete(key: string): Promise<void>;
+}
+interface R2BucketLike {
+  get(key: string): Promise<unknown>;
+  put(key: string, value: unknown): Promise<unknown>;
+}
+interface CloudflareEnv {
+  /** Astro session store (adapter default). */
+  SESSION?: KVNamespaceLike;
+  /** Tenant config + catalog cache KV. */
+  TENANT_CACHE?: KVNamespaceLike;
+  /** Rehosted product images. */
+  PRODUCT_IMAGES?: R2BucketLike;
+  /**
+   * Versioned tenant static assets (`public/**`), keyed
+   * `tenants/<id>/<versionId>/<rel>`. Served by src/pages/tenants/[id]/[...path].
+   */
+  TENANT_ASSETS?: R2BucketLike;
+  // Secrets / vars surfaced at runtime.
+  TOT_CATALOG_BASE_URL?: string;
+  TOT_API_KEY?: string;
+  TOT_SECRET_KEY?: string;
+  TOT_ACCESS_TOKEN?: string;
+  PUBLIC_CF_ANALYTICS_TOKEN?: string;
+  /** HMAC secret for signing/verifying customization preview tokens (D4). */
+  CUSTOMIZATION_PREVIEW_SECRET?: string;
+  /**
+   * FoxyCart (Track A). `FOXY_STORE_SUBDOMAIN` overrides the tenant's default
+   * demo store subdomain (swap the demo store with zero code change).
+   * `FOXY_CART_SECRET` is the store's cart-validation secret for signed mode —
+   * absent in the unsigned demo (validation OFF), present on preview/live.
+   */
+  FOXY_STORE_SUBDOMAIN?: string;
+  /** Branded custom checkout domain override (e.g. checkout.preview.tokenoftrust.com). */
+  FOXY_STORE_DOMAIN?: string;
+  FOXY_CART_SECRET?: string;
+  /**
+   * Order READ API bearer (U2) — the tenant's ToT `partnerApi.apiKey`, sent as
+   * `Authorization: Bearer` to tot-foxycart `GET /commerce/orders`. Server-side
+   * only (never shipped to the browser). Absent → the Orders route reports
+   * `not_provisioned` (503).
+   */
+  FOXY_ORDER_API_KEY?: string;
+}
+declare global {
+  // Alias used elsewhere.
+  type KVNamespace = KVNamespaceLike;
+  type R2Bucket = R2BucketLike;
+  namespace App {
+    interface Locals {
+      /** Tenant resolved from the request Host by src/middleware. */
+      tenant: TenantConfig;
+      /**
+       * Effective capability flags for the resolved tenant (commerce defaults
+       * unless siteType:"marketing"/explicit features). Chrome, layout islands,
+       * sitemap, and commerce routes gate on these — no tenant-identity checks.
+       */
+      features: TenantFeatures;
+      /** Catalog client bound to the resolved tenant's data scope. */
+      tot: ToTClient;
+      /**
+       * Content provider for this request — overlays any published "Own Your
+       * Look" content for the resolved customizationEnv over Storyblok/local.
+       */
+      content: ContentProvider;
+      /** Inline CSS-variable theme block already serialized for <head>. */
+      themeStyle: string;
+      /** Absolute canonical base for this request. */
+      canonicalBase: string;
+      /**
+       * Path prefix the request was routed under: "" for host-routed requests,
+       * or "/<domain>" when a `/<domain>/*` path segment selected the tenant
+       * (DNS-free local/preview routing). The Layout keeps root-absolute links
+       * inside this prefix on the client.
+       */
+      basePath: string;
+      /**
+       * Which customization environment to serve (D4). "live" on production
+       * hosts; "test" only behind a valid, tenant-bound preview token on a
+       * preview host. Downstream theme/content selection reads this.
+       */
+      customizationEnv: CustomizationEnv;
+      /**
+       * Per-request CSP nonce (D2). Placed on the platform's own inline
+       * <style>/<script is:inline> tags so a strict CSP can allow them without
+       * `unsafe-inline`.
+       */
+      cspNonce: string;
+      /**
+       * Resolved FoxyCart cart/checkout facts for this request (loader src, cart
+       * URL, mode). Present only for commerce tenants with a FoxyCart store;
+       * undefined for marketing tenants or when no store is configured.
+       */
+      commerce?: ResolvedFoxyCommerce;
+      /**
+       * Effective, per-environment capability switches (cart/checkout, age
+       * verification, excise tax) for this request. Resolved from the tenant's
+       * build-time default overridden by the published capabilities artifact for
+       * the current customizationEnv — so the value reflects exactly what a PR
+       * promoted to THIS environment.
+       */
+      capabilities: CapabilityConfig;
+      /**
+       * Signed-in viewer for a login-gated preview host (set by the demo login
+       * gate once a valid, resource-bound `tot_session` cookie is present). Carries
+       * the email + the role(s)/capability tot20 resolved on this tenant, so chrome
+       * can show "signed in as … — owner/developer/staff". Absent on open or
+       * password-gated hosts.
+       */
+      viewer?: {
+        email: string;
+        roles: string[];
+        capability: string;
+      };
+      /** Cloudflare runtime (env bindings) — provided by the adapter on Workers. */
+      runtime?: { env: CloudflareEnv };
+    }
+  }
+}
+interface ImportMetaEnv {
+  readonly TOT_CATALOG_BASE_URL?: string;
+  readonly TOT_API_KEY?: string;
+  readonly TOT_SECRET_KEY?: string;
+  readonly TOT_ACCESS_TOKEN?: string;
+  readonly PUBLIC_CF_ANALYTICS_TOKEN?: string;
+  readonly CUSTOMIZATION_PREVIEW_SECRET?: string;
+}
+interface ImportMeta {
+  readonly env: ImportMetaEnv;
+}
+export {};

package/apps/storefront/migrations/0000_baseline.sql ADDED Viewed

@@ -0,0 +1,54 @@
+CREATE TABLE `collections` (
+	`handle` text PRIMARY KEY NOT NULL,
+	`title` text NOT NULL,
+	`position` integer DEFAULT 99 NOT NULL,
+	`data` text NOT NULL
+);
+--> statement-breakpoint
+CREATE TABLE `customization_pointers` (
+	`tenant_id` text PRIMARY KEY NOT NULL,
+	`rev` integer NOT NULL,
+	`live` text NOT NULL,
+	`test` text NOT NULL
+);
+--> statement-breakpoint
+CREATE TABLE `customization_versions` (
+	`tenant_id` text NOT NULL,
+	`path` text NOT NULL,
+	`version_id` text NOT NULL,
+	`size` integer NOT NULL,
+	`created_at` text NOT NULL,
+	`content` text NOT NULL,
+	PRIMARY KEY(`tenant_id`, `path`, `version_id`)
+);
+--> statement-breakpoint
+CREATE TABLE `product_collections` (
+	`handle` text NOT NULL,
+	`collection` text NOT NULL
+);
+--> statement-breakpoint
+CREATE INDEX `idx_pc_collection` ON `product_collections` (`collection`);--> statement-breakpoint
+CREATE TABLE `product_facets` (
+	`handle` text NOT NULL,
+	`name` text NOT NULL,
+	`value` text NOT NULL
+);
+--> statement-breakpoint
+CREATE INDEX `idx_pf_name` ON `product_facets` (`name`,`value`);--> statement-breakpoint
+CREATE TABLE `products` (
+	`handle` text PRIMARY KEY NOT NULL,
+	`title` text NOT NULL,
+	`vendor` text,
+	`product_type` text,
+	`tags` text DEFAULT '[]' NOT NULL,
+	`description_text` text DEFAULT '' NOT NULL,
+	`price_min` real NOT NULL,
+	`price_max` real NOT NULL,
+	`currency` text NOT NULL,
+	`image` text,
+	`available` integer DEFAULT 0 NOT NULL,
+	`status` text NOT NULL,
+	`position` integer DEFAULT 0 NOT NULL,
+	`created_at` text,
+	`data` text NOT NULL
+);

package/apps/storefront/migrations/0001_products_fts.sql ADDED Viewed

@@ -0,0 +1,9 @@
+-- Custom SQL migration file, put your code below! --
+-- FTS5 (trigram) virtual table for typo-tolerant product search. Drizzle can't model
+-- CREATE VIRTUAL TABLE, so this is hand-maintained — keep it in step with
+-- CATALOG_D1_SCHEMA in @tot/private-controlplane (the structural equivalence test in
+-- src/lib/d1/schema.test.ts enforces that the migrations reproduce that contract).
+CREATE VIRTUAL TABLE IF NOT EXISTS products_fts USING fts5 (
+  handle UNINDEXED, title, vendor, product_type, tags, description_text,
+  tokenize = 'trigram'
+);

package/apps/storefront/migrations/README.md ADDED Viewed

@@ -0,0 +1,54 @@
+# D1 provision migrations (Drizzle Kit)
+The catalog + customization D1 schema as numbered migrations, applied by `provision.sh`
+(the **provision** lifecycle phase — never `deploy`, never runtime). Generated by
+**Drizzle Kit** (ADR-0002), applied by `wrangler d1 migrations apply`.
+## Source of truth
+- **`src/lib/d1/schema.ts`** (Drizzle schema) is the source of truth for migration
+  *generation*. `drizzle-kit generate` diffs it into numbered `migrations/*.sql`
+  (+ `meta/` journal) and owns the SQLite table-rebuild logic for `ALTER`s.
+- **`products_fts`** (FTS5 virtual table) can't be modelled by Drizzle — it's a custom
+  migration (`0001_products_fts.sql`), hand-maintained.
+- The raw-SQL read model + ETL still consume `CATALOG_D1_SCHEMA`/`CUSTOMIZATION_D1_SCHEMA`
+  (`@tot/private-controlplane`). A **structural** equivalence test (`src/lib/d1/schema.test.ts`,
+  PRAGMA-based) asserts the migrations reproduce that contract, so generator and read
+  model can't drift.
+## Safety (D1 has no rollback)
+`src/lib/d1/migrationSafety.ts` + its test **fail CI** on any unmarked `DROP TABLE` /
+`DROP COLUMN` (which also catches SQLite column-dropping rebuilds), because the
+equivalence test only proves *end-state* correctness, not a safe transition. An
+*intended* destructive change must opt in, in the migration file:
+```sql
+-- allow-destructive: <why this data loss is intended>
+```
+## Workflows
+**Regular change (add/alter a column, table):**
+1. Edit `src/lib/d1/schema.ts`.
+2. `pnpm --filter @tot/storefront gen:migrations` (Drizzle emits the next numbered SQL,
+   including SQLite table-rebuilds for unsupported `ALTER`s).
+3. If a column was removed, add `-- allow-destructive: <reason>` to the generated file.
+4. Update the matching `@tot/private-controlplane` const so the equivalence test stays green; commit
+   schema + generated `.sql` + journal together.
+**Custom SQL (e.g. a new FTS table, trigger):**
+`pnpm --filter @tot/storefront gen:migrations:custom` → fill in the emitted file.
+Never renumber or rewrite a *shipped* id (`wrangler` tracks applied ids); only append.
+## Applying
+`provision.sh --env=<env>` runs, after creating the D1 database:
+```sh
+wrangler d1 migrations apply CATALOG_DB --env <env> [--remote|--local]
+```
+> Catalog + customization tables share the **one** `CATALOG_DB` binding (one edge DB),
+> per `src/lib/customization/d1Store.ts`.

package/apps/storefront/migrations/meta/0000_snapshot.json ADDED Viewed

@@ -0,0 +1,347 @@
+{
+  "version": "6",
+  "dialect": "sqlite",
+  "id": "3667f8d8-a1ba-49ac-809a-c06004bad5d6",
+  "prevId": "00000000-0000-0000-0000-000000000000",
+  "tables": {
+    "collections": {
+      "name": "collections",
+      "columns": {
+        "handle": {
+          "name": "handle",
+          "type": "text",
+          "primaryKey": true,
+          "notNull": true,
+          "autoincrement": false
+        },
+        "title": {
+          "name": "title",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": true,
+          "autoincrement": false
+        },
+        "position": {
+          "name": "position",
+          "type": "integer",
+          "primaryKey": false,
+          "notNull": true,
+          "autoincrement": false,
+          "default": 99
+        },
+        "data": {
+          "name": "data",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": true,
+          "autoincrement": false
+        }
+      },
+      "indexes": {},
+      "foreignKeys": {},
+      "compositePrimaryKeys": {},
+      "uniqueConstraints": {},
+      "checkConstraints": {}
+    },
+    "customization_pointers": {
+      "name": "customization_pointers",
+      "columns": {
+        "tenant_id": {
+          "name": "tenant_id",
+          "type": "text",
+          "primaryKey": true,
+          "notNull": true,
+          "autoincrement": false
+        },
+        "rev": {
+          "name": "rev",
+          "type": "integer",
+          "primaryKey": false,
+          "notNull": true,
+          "autoincrement": false
+        },
+        "live": {
+          "name": "live",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": true,
+          "autoincrement": false
+        },
+        "test": {
+          "name": "test",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": true,
+          "autoincrement": false
+        }
+      },
+      "indexes": {},
+      "foreignKeys": {},
+      "compositePrimaryKeys": {},
+      "uniqueConstraints": {},
+      "checkConstraints": {}
+    },
+    "customization_versions": {
+      "name": "customization_versions",
+      "columns": {
+        "tenant_id": {
+          "name": "tenant_id",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": true,
+          "autoincrement": false
+        },
+        "path": {
+          "name": "path",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": true,
+          "autoincrement": false
+        },
+        "version_id": {
+          "name": "version_id",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": true,
+          "autoincrement": false
+        },
+        "size": {
+          "name": "size",
+          "type": "integer",
+          "primaryKey": false,
+          "notNull": true,
+          "autoincrement": false
+        },
+        "created_at": {
+          "name": "created_at",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": true,
+          "autoincrement": false
+        },
+        "content": {
+          "name": "content",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": true,
+          "autoincrement": false
+        }
+      },
+      "indexes": {},
+      "foreignKeys": {},
+      "compositePrimaryKeys": {
+        "customization_versions_tenant_id_path_version_id_pk": {
+          "columns": [
+            "tenant_id",
+            "path",
+            "version_id"
+          ],
+          "name": "customization_versions_tenant_id_path_version_id_pk"
+        }
+      },
+      "uniqueConstraints": {},
+      "checkConstraints": {}
+    },
+    "product_collections": {
+      "name": "product_collections",
+      "columns": {
+        "handle": {
+          "name": "handle",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": true,
+          "autoincrement": false
+        },
+        "collection": {
+          "name": "collection",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": true,
+          "autoincrement": false
+        }
+      },
+      "indexes": {
+        "idx_pc_collection": {
+          "name": "idx_pc_collection",
+          "columns": [
+            "collection"
+          ],
+          "isUnique": false
+        }
+      },
+      "foreignKeys": {},
+      "compositePrimaryKeys": {},
+      "uniqueConstraints": {},
+      "checkConstraints": {}
+    },
+    "product_facets": {
+      "name": "product_facets",
+      "columns": {
+        "handle": {
+          "name": "handle",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": true,
+          "autoincrement": false
+        },
+        "name": {
+          "name": "name",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": true,
+          "autoincrement": false
+        },
+        "value": {
+          "name": "value",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": true,
+          "autoincrement": false
+        }
+      },
+      "indexes": {
+        "idx_pf_name": {
+          "name": "idx_pf_name",
+          "columns": [
+            "name",
+            "value"
+          ],
+          "isUnique": false
+        }
+      },
+      "foreignKeys": {},
+      "compositePrimaryKeys": {},
+      "uniqueConstraints": {},
+      "checkConstraints": {}
+    },
+    "products": {
+      "name": "products",
+      "columns": {
+        "handle": {
+          "name": "handle",
+          "type": "text",
+          "primaryKey": true,
+          "notNull": true,
+          "autoincrement": false
+        },
+        "title": {
+          "name": "title",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": true,
+          "autoincrement": false
+        },
+        "vendor": {
+          "name": "vendor",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": false,
+          "autoincrement": false
+        },
+        "product_type": {
+          "name": "product_type",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": false,
+          "autoincrement": false
+        },
+        "tags": {
+          "name": "tags",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": true,
+          "autoincrement": false,
+          "default": "'[]'"
+        },
+        "description_text": {
+          "name": "description_text",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": true,
+          "autoincrement": false,
+          "default": "''"
+        },
+        "price_min": {
+          "name": "price_min",
+          "type": "real",
+          "primaryKey": false,
+          "notNull": true,
+          "autoincrement": false
+        },
+        "price_max": {
+          "name": "price_max",
+          "type": "real",
+          "primaryKey": false,
+          "notNull": true,
+          "autoincrement": false
+        },
+        "currency": {
+          "name": "currency",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": true,
+          "autoincrement": false
+        },
+        "image": {
+          "name": "image",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": false,
+          "autoincrement": false
+        },
+        "available": {
+          "name": "available",
+          "type": "integer",
+          "primaryKey": false,
+          "notNull": true,
+          "autoincrement": false,
+          "default": 0
+        },
+        "status": {
+          "name": "status",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": true,
+          "autoincrement": false
+        },
+        "position": {
+          "name": "position",
+          "type": "integer",
+          "primaryKey": false,
+          "notNull": true,
+          "autoincrement": false,
+          "default": 0
+        },
+        "created_at": {
+          "name": "created_at",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": false,
+          "autoincrement": false
+        },
+        "data": {
+          "name": "data",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": true,
+          "autoincrement": false
+        }
+      },
+      "indexes": {},
+      "foreignKeys": {},
+      "compositePrimaryKeys": {},
+      "uniqueConstraints": {},
+      "checkConstraints": {}
+    }
+  },
+  "views": {},
+  "enums": {},
+  "_meta": {
+    "schemas": {},
+    "tables": {},
+    "columns": {}
+  },
+  "internal": {
+    "indexes": {}
+  }
+}