create-ailk 0.22.0 → 0.23.0

package/templates/apps/api/src/services/offerings/__tests__/fixtures.ts

@@ -0,0 +1,416 @@
+/**
+ * The Offerings fixture and seed (#8876, spec
+ * docs/specs/8876-the-offerings-data-model-typed-spec.md D9, AC 3) — what a
+ * test needs to build a workspace's shown set with no Stripe call and no
+ * Admin UI. Test-only: `apps/api/tsconfig.json` excludes `__tests__`, and
+ * jest runs only `*.test.ts`, so nothing here ships.
+ *
+ * Route suites in Epics 3, 4 and 6 import it from their own `__tests__`, as
+ * they import `createInMemoryPrisma`. `seedOfferings` writes through the
+ * Prisma delegates, so it works against that double and a real client alike,
+ * and refuses to run outside jest.
+ *
+ * The ids are valid ADR-0031 ids outside the sentinel range, so no fixture
+ * Organization reads as the deployment's default. The connection's
+ * ciphertext is a placeholder in the envelope shape that decrypts under no
+ * key: no real or key-shaped secret appears here.
+ */
+import { normalizeCatalog, type CatalogPrice, type CatalogProduct, type OfferingsSourceFor } from "../index.js";
+import type { WorkspaceShownSet } from "@working-theory/validation";
+
+export const FIXTURE_ORG = "org_01920000-8876-7000-8000-0000000000a1";
+/** The fixture Organization's workspace that shows Offerings. */
+export const FIXTURE_WS = "wksp_01920000-8876-7000-8000-0000000000b1";
+/** A second workspace of the same Organization, with no Offerings row. */
+export const FIXTURE_WS_2 = "wksp_01920000-8876-7000-8000-0000000000b2";
+/** A second Organization, with no connection. */
+export const FIXTURE_ORG_2 = "org_01920000-8876-7000-8000-0000000000a2";
+/** The second Organization's workspace, with a selection but no connection. */
+export const FIXTURE_ORG_2_WS = "wksp_01920000-8876-7000-8000-0000000000c1";
+
+/** Envelope-shaped (`v1.<iv>.<tag>.<ct>`), decrypting under no key. */
+export const FIXTURE_CIPHERTEXT_PLACEHOLDER = "v1.Zml4dHVyZWl2ODg3.Zml4dHVyZS10YWctODg3Ng.Y2lwaGVydGV4dA";
+/** A 43-character base64url routing token. */
+export const FIXTURE_WEBHOOK_TOKEN = "fixtureWebhookToken8876abcdefghijklmnopqrst";
+export const FIXTURE_KEY_LAST4 = "4242";
+
+const recurring = (interval: "month" | "year", count = 1) => ({
+  interval,
+  interval_count: count,
+  usage_type: "licensed",
+});
+
+/**
+ * Stripe-shaped Products and Prices covering the contract's worked examples:
+ * `growth` (plan, Monthly and Yearly), `basic` (plan, one-time), `seo-audit`
+ * (add-on, Monthly), a quarterly Price (held `needs_lookup_key`), a Product
+ * with no `ailk_group` (held `group_invalid`), and one whose name carries a
+ * bidi override and markup (normalized, never rendered).
+ */
+export const OFFERINGS_FIXTURE_CATALOG: { products: CatalogProduct[]; prices: CatalogPrice[] } = {
+  products: [
+    {
+      id: "prod_fixture_growth",
+      active: true,
+      name: "Growth",
+      description: "For a growing practice.\nEverything in Basic.",
+      marketing_features: [{ name: "Unlimited pages" }, { name: "Priority support" }],
+      unit_label: null,
+      images: ["https://example.com/growth.png"],
+      url: "https://example.com/growth",
+      metadata: { ailk_group: "plan", ailk_order: "10", ailk_terms_note: "Billed in advance." },
+    } as CatalogProduct,
+    {
+      id: "prod_fixture_basic",
+      active: true,
+      name: "Basic",
+      description: "One site, set up once.",
+      marketing_features: [{ name: "Five pages" }],
+      unit_label: "site",
+      metadata: { ailk_group: "plan", ailk_order: "5" },
+    },
+    {
+      id: "prod_fixture_seo_audit",
+      active: true,
+      name: "SEO audit",
+      description: null,
+      marketing_features: [],
+      unit_label: null,
+      metadata: { ailk_group: "addon", ailk_order: "1", ailk_note: "Delivered within a week." },
+    },
+    {
+      id: "prod_fixture_quarterly",
+      active: true,
+      name: "Pro quarterly",
+      description: "Billed every three months.",
+      marketing_features: [],
+      unit_label: null,
+      metadata: { ailk_group: "plan" },
+    },
+    {
+      id: "prod_fixture_legacy",
+      active: true,
+      name: "Legacy retainer",
+      description: null,
+      marketing_features: [],
+      unit_label: null,
+      metadata: {},
+    },
+    {
+      id: "prod_fixture_bidi",
+      active: true,
+      name: "‮Audit‬ <b>plus</b>",
+      description: null,
+      marketing_features: [],
+      unit_label: null,
+      metadata: { ailk_group: "addon" },
+    },
+  ],
+  prices: [
+    {
+      id: "price_fixture_growth_monthly",
+      active: true,
+      product: "prod_fixture_growth",
+      lookup_key: "growth_monthly",
+      type: "recurring",
+      recurring: recurring("month"),
+      billing_scheme: "per_unit",
+      unit_amount: 4900,
+      currency: "usd",
+      nickname: "Monthly",
+    } as CatalogPrice,
+    {
+      id: "price_fixture_growth_yearly",
+      active: true,
+      product: "prod_fixture_growth",
+      lookup_key: "growth_yearly",
+      type: "recurring",
+      recurring: recurring("year"),
+      billing_scheme: "per_unit",
+      unit_amount: 49000,
+      currency: "usd",
+    },
+    {
+      id: "price_fixture_basic_once",
+      active: true,
+      product: "prod_fixture_basic",
+      lookup_key: "basic_once",
+      type: "one_time",
+      recurring: null,
+      billing_scheme: "per_unit",
+      unit_amount: 9900,
+      currency: "usd",
+    },
+    {
+      id: "price_fixture_seo_audit_monthly",
+      active: true,
+      product: "prod_fixture_seo_audit",
+      lookup_key: "seo-audit_monthly",
+      type: "recurring",
+      recurring: recurring("month"),
+      billing_scheme: "per_unit",
+      unit_amount: 1500,
+      currency: "usd",
+    },
+    {
+      id: "price_fixture_pro_quarterly",
+      active: true,
+      product: "prod_fixture_quarterly",
+      lookup_key: "pro_quarterly",
+      type: "recurring",
+      recurring: recurring("month", 3),
+      billing_scheme: "per_unit",
+      unit_amount: 12000,
+      currency: "usd",
+    },
+    {
+      id: "price_fixture_legacy",
+      active: true,
+      product: "prod_fixture_legacy",
+      lookup_key: "wendi_retainer",
+      type: "recurring",
+      recurring: recurring("month"),
+      billing_scheme: "per_unit",
+      unit_amount: 200000,
+      currency: "usd",
+    },
+    {
+      id: "price_fixture_bidi_monthly",
+      active: true,
+      product: "prod_fixture_bidi",
+      lookup_key: "audit-plus_monthly",
+      type: "recurring",
+      recurring: recurring("month"),
+      billing_scheme: "per_unit",
+      unit_amount: 900,
+      currency: "usd",
+    },
+  ],
+};
+
+const growthPrices = [
+  {
+    priceId: "price_fixture_growth_monthly",
+    lookupKey: "growth_monthly",
+    plan: "growth",
+    period: "monthly",
+    interval: "month",
+    amount: 4900,
+    currency: "usd",
+  },
+  {
+    priceId: "price_fixture_growth_yearly",
+    lookupKey: "growth_yearly",
+    plan: "growth",
+    period: "yearly",
+    interval: "year",
+    amount: 49000,
+    currency: "usd",
+  },
+] as const;
+
+/** What `normalizeCatalog(OFFERINGS_FIXTURE_CATALOG)` answers, in D5's order. */
+export const EXPECTED_FIXTURE_OFFERINGS = [
+  {
+    productId: "prod_fixture_basic",
+    plan: "basic",
+    name: "Basic",
+    description: "One site, set up once.",
+    marketingFeatures: ["Five pages"],
+    unitLabel: "site",
+    note: null,
+    termsNote: null,
+    ailkGroup: "plan",
+    ailkOrder: 5,
+    prices: [
+      {
+        priceId: "price_fixture_basic_once",
+        lookupKey: "basic_once",
+        plan: "basic",
+        period: "once",
+        interval: null,
+        amount: 9900,
+        currency: "usd",
+      },
+    ],
+  },
+  {
+    productId: "prod_fixture_growth",
+    plan: "growth",
+    name: "Growth",
+    description: "For a growing practice.\nEverything in Basic.",
+    marketingFeatures: ["Unlimited pages", "Priority support"],
+    unitLabel: null,
+    note: null,
+    termsNote: "Billed in advance.",
+    ailkGroup: "plan",
+    ailkOrder: 10,
+    prices: [...growthPrices],
+  },
+  {
+    productId: "prod_fixture_seo_audit",
+    plan: "seo-audit",
+    name: "SEO audit",
+    description: null,
+    marketingFeatures: [],
+    unitLabel: null,
+    note: "Delivered within a week.",
+    termsNote: null,
+    ailkGroup: "addon",
+    ailkOrder: 1,
+    prices: [
+      {
+        priceId: "price_fixture_seo_audit_monthly",
+        lookupKey: "seo-audit_monthly",
+        plan: "seo-audit",
+        period: "monthly",
+        interval: "month",
+        amount: 1500,
+        currency: "usd",
+      },
+    ],
+  },
+  {
+    productId: "prod_fixture_bidi",
+    plan: "audit-plus",
+    name: "Audit <b>plus</b>",
+    description: null,
+    marketingFeatures: [],
+    unitLabel: null,
+    note: null,
+    termsNote: null,
+    ailkGroup: "addon",
+    ailkOrder: null,
+    prices: [
+      {
+        priceId: "price_fixture_bidi_monthly",
+        lookupKey: "audit-plus_monthly",
+        plan: "audit-plus",
+        period: "monthly",
+        interval: "month",
+        amount: 900,
+        currency: "usd",
+      },
+    ],
+  },
+];
+
+/** The held list, in catalog order. */
+export const EXPECTED_FIXTURE_HELD = [
+  { productId: "prod_fixture_quarterly", name: "Pro quarterly", reason: "needs_lookup_key" },
+  { productId: "prod_fixture_legacy", name: "Legacy retainer", reason: "group_invalid" },
+];
+
+/** The Organization's enabled set: every offering but the bidi add-on. */
+export const FIXTURE_ENABLED_PRODUCT_IDS = [
+  "prod_fixture_growth",
+  "prod_fixture_basic",
+  "prod_fixture_seo_audit",
+];
+/** The first workspace's shown set (growth Recommended). */
+export const FIXTURE_SHOWN_PRODUCT_IDS = [
+  "prod_fixture_growth",
+  "prod_fixture_basic",
+  "prod_fixture_seo_audit",
+];
+
+/** A `sourceFor` whose source answers the fixture catalog. */
+export const fixtureSourceFor: OfferingsSourceFor = () => ({
+  listActiveCatalog: async () => structuredClone(OFFERINGS_FIXTURE_CATALOG),
+});
+
+/** A `sourceFor` that fails the test on any call. */
+export const refusingSourceFor: OfferingsSourceFor = (organizationId) => {
+  throw new Error(`refusingSourceFor: no catalog source may be built (asked for ${organizationId})`);
+};
+
+type Delegate = {
+  create(args: { data: Record<string, unknown> }): Promise<unknown>;
+};
+
+/**
+ * Seed the fixture rows through the Prisma delegates: two Organizations and
+ * three Workspaces, one `test` connection on the first Organization, its
+ * enabled set, and the first workspace's shown set (Recommended `growth`)
+ * with its snapshot built by `normalizeCatalog` at `now`. Refuses to run
+ * outside jest, so it can never be pointed at a dev or production database.
+ */
+export async function seedOfferings(
+  prisma: unknown,
+  { now = new Date() }: { now?: Date } = {},
+): Promise<void> {
+  if (!process.env.JEST_WORKER_ID) {
+    throw new Error("seedOfferings runs only under jest");
+  }
+  const db = prisma as Record<string, Delegate>;
+  for (const [id, slug] of [
+    [FIXTURE_ORG, "fixture-8876-a"],
+    [FIXTURE_ORG_2, "fixture-8876-b"],
+  ] as const) {
+    await db.organization!.create({ data: { id, name: slug, slug } });
+  }
+  for (const [id, organizationId, slug] of [
+    [FIXTURE_WS, FIXTURE_ORG, "one"],
+    [FIXTURE_WS_2, FIXTURE_ORG, "two"],
+    [FIXTURE_ORG_2_WS, FIXTURE_ORG_2, "one"],
+  ] as const) {
+    await db.workspace!.create({ data: { id, organizationId, name: slug, slug } });
+  }
+  await db.stripeConnection!.create({
+    data: {
+      organizationId: FIXTURE_ORG,
+      mode: "test",
+      keyLast4: FIXTURE_KEY_LAST4,
+      credentialCiphertext: FIXTURE_CIPHERTEXT_PLACEHOLDER,
+      webhookToken: FIXTURE_WEBHOOK_TOKEN,
+      webhookSecretCiphertext: null,
+      liveAt: null,
+    },
+  });
+  await db.organizationOfferings!.create({
+    data: { organizationId: FIXTURE_ORG, enabledProductIds: [...FIXTURE_ENABLED_PRODUCT_IDS] },
+  });
+  const { offerings } = normalizeCatalog(OFFERINGS_FIXTURE_CATALOG);
+  const shown = new Set(FIXTURE_SHOWN_PRODUCT_IDS);
+  await db.workspaceOfferings!.create({
+    data: {
+      workspaceId: FIXTURE_WS,
+      shownProductIds: [...FIXTURE_SHOWN_PRODUCT_IDS],
+      recommendedPlanProductId: "prod_fixture_growth",
+      recommendedAddonProductId: null,
+      snapshot: { v: 1, offerings: offerings.filter((o) => shown.has(o.productId)) },
+      snapshotAt: now,
+    },
+  });
+  // The second Organization's workspace has a selection, but its
+  // Organization has no connection, so it serves nothing.
+  await db.workspaceOfferings!.create({
+    data: {
+      workspaceId: FIXTURE_ORG_2_WS,
+      shownProductIds: ["prod_fixture_growth"],
+      recommendedPlanProductId: null,
+      recommendedAddonProductId: null,
+      snapshot: null,
+      snapshotAt: null,
+    },
+  });
+}
+
+/** What `getWorkspaceShownSet(FIXTURE_WS, { now })` answers for the seed. */
+export function expectedShownSet(now: Date): WorkspaceShownSet {
+  return {
+    workspaceId: FIXTURE_WS,
+    organizationId: FIXTURE_ORG,
+    productIds: [...FIXTURE_SHOWN_PRODUCT_IDS],
+    recommended: { plan: "prod_fixture_growth", addon: null },
+    offerings: EXPECTED_FIXTURE_OFFERINGS.filter((o) =>
+      FIXTURE_SHOWN_PRODUCT_IDS.includes(o.productId),
+    ).map((o) => ({ ...o, recommended: o.productId === "prod_fixture_growth" })) as WorkspaceShownSet["offerings"],
+    state: "current",
+    snapshotAt: now.toISOString(),
+  };
+}
+
+/** The seed's shown set at a fixed `now`, for suites that pin the clock. */
+export const FIXTURE_NOW = new Date("2026-10-20T12:00:00.000Z");
+export const EXPECTED_SHOWN_SET: WorkspaceShownSet = expectedShownSet(FIXTURE_NOW);