@prisma-idb/family-idb 0.0.0

package/dist/preflight-4jDCNvS0.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"preflight-4jDCNvS0.mjs","names":[],"sources":["../src/core/preflight.ts"],"sourcesContent":["import { readdir, readFile } from \"node:fs/promises\";\nimport { IDBFactory } from \"fake-indexeddb\";\nimport type { MigrationMetadata } from \"@prisma/orm-toolchain/migration-tools/metadata\";\nimport { computeMigrationHash } from \"@prisma/orm-toolchain/migration-tools/hash\";\nimport { chainOrderByMetadata, type ChainablePackage } from \"./chain-order\";\nimport { applyOneDdlOp, isIdbDdlOp, type IdbDdlOp } from \"@prisma-idb/target-idb/migration\";\nimport { join } from \"pathe\";\n\nexport interface PreflightOptions {\n  readonly migrationsDir: string;\n  /** Output sinks. Default to `process.stdout`/`process.stderr`. */\n  readonly out?: (line: string) => void;\n  readonly err?: (line: string) => void;\n}\n\n/**\n * Walk every migration package under `<migrationsDir>/app/` in chain order,\n * applying each package's `ops.json` against a fresh `fake-indexeddb`\n * instance inside an `upgradeneeded` callback. Reports per-step status to\n * stdout and the final outcome via exit code.\n *\n * **Why this exists**: a dedicated preflight command avoids three failure modes\n * of inlining this into `db update`: (a) `fake-indexeddb` disagrees with real\n * browsers on some edge cases and is not a reliable production oracle; (b) it\n * would substitute a runtime check for proper test coverage; (c) it would ship\n * a test-only package on a production path. Running it in CI gives the gate\n * without the workflow tax on every author.\n *\n * **Scope vs runtime**: this command catches \"the chain doesn't apply\n * cleanly\" — a structural issue. It does NOT catch \"the chain produces\n * the wrong schema\" (that's `verifySchema` against the head's contract,\n * resolvable via `migrations/snapshots/<hash>/contract.json` since Phase\n * 8.9 — still deferred to a follow-up).\n *\n * Exit codes: 0 on full chain success; 1 on any failure.\n */\nexport async function runPreflight(opts: PreflightOptions): Promise<number> {\n  const out = opts.out ?? ((line: string) => process.stdout.write(line));\n  const err = opts.err ?? ((line: string) => process.stderr.write(line));\n  const migrationsDir = opts.migrationsDir;\n  const appDir = join(migrationsDir, \"app\");\n\n  const packages = await loadPackages(appDir);\n  if (packages.length === 0) {\n    out(\"No migration packages found. Nothing to preflight.\\n\");\n    return 0;\n  }\n\n  out(`Preflighting ${packages.length} migration(s) against fake-indexeddb…\\n`);\n\n  const factory = new IDBFactory();\n  const dbName = \"__preflight__\";\n\n  let currentVersion = 0;\n  for (const pkg of packages) {\n    out(`  ${pkg.dirName} … `);\n    try {\n      currentVersion += 1;\n      await applyPackage({ factory, dbName, targetVersion: currentVersion, ops: pkg.ops });\n      out(\"ok\\n\");\n    } catch (applyErr) {\n      out(\"FAILED\\n\");\n      err(`    ${applyErr instanceof Error ? applyErr.message : String(applyErr)}\\n`);\n      err(\"\\nPreflight failed.\\n\");\n      return 1;\n    }\n  }\n\n  out(\"\\nPreflight passed: every migration in the chain applies cleanly.\\n\");\n  return 0;\n}\n\ninterface LoadedPackage extends ChainablePackage {\n  readonly metadata: MigrationMetadata;\n  readonly ops: readonly IdbDdlOp[];\n}\n\nasync function loadPackages(appDir: string): Promise<LoadedPackage[]> {\n  let dirs: string[];\n  try {\n    dirs = (await readdir(appDir, { withFileTypes: true })).filter((d) => d.isDirectory()).map((d) => d.name);\n  } catch (err) {\n    if ((err as NodeJS.ErrnoException).code === \"ENOENT\") return [];\n    throw err;\n  }\n\n  // Load all packages unordered, then derive chain order by walking\n  // metadata.from/to edges. Directory name sort is unreliable when\n  // timestamp formats mix between hand-authored baselines and CLI-emitted\n  // additions (e.g. T120000 vs T0337).\n  const unordered = new Map<string, LoadedPackage>();\n  for (const dirName of dirs) {\n    const metaRaw = await readFile(join(appDir, dirName, \"migration.json\"), \"utf-8\");\n    const opsRaw = await readFile(join(appDir, dirName, \"ops.json\"), \"utf-8\");\n    const metadata = JSON.parse(metaRaw) as MigrationMetadata;\n    const opsParsed = JSON.parse(opsRaw) as unknown[];\n    const ops: IdbDdlOp[] = [];\n    for (const op of opsParsed) {\n      if (!isIdbDdlOp(op as never)) {\n        throw new Error(`Non-IDB op found in ${dirName}/ops.json: ${JSON.stringify(op)}`);\n      }\n      ops.push(op as IdbDdlOp);\n    }\n    const computedHash = computeMigrationHash(metadata, ops as unknown as Parameters<typeof computeMigrationHash>[1]);\n    if (computedHash !== metadata.migrationHash) {\n      throw new Error(\n        `Migration hash mismatch in ${dirName}: stored migrationHash ${metadata.migrationHash} ` +\n          `does not match computed hash ${computedHash}`\n      );\n    }\n    unordered.set(dirName, { dirName, metadata, ops });\n  }\n\n  return chainOrderByMetadata(unordered);\n}\n\nfunction applyPackage(input: {\n  readonly factory: IDBFactory;\n  readonly dbName: string;\n  readonly targetVersion: number;\n  readonly ops: readonly IdbDdlOp[];\n}): Promise<void> {\n  return new Promise((resolve, reject) => {\n    const req = input.factory.open(input.dbName, input.targetVersion);\n    req.onupgradeneeded = (event) => {\n      const target = event.target as IDBOpenDBRequest;\n      const db = target.result;\n      const tx = target.transaction;\n      if (tx === null) {\n        reject(new Error(\"upgradeneeded fired with null version-change transaction\"));\n        return;\n      }\n      try {\n        for (const op of input.ops) {\n          applyOneDdlOp(db, tx, op);\n        }\n      } catch (err) {\n        reject(err);\n      }\n    };\n    req.onsuccess = () => {\n      req.result.close();\n      resolve();\n    };\n    req.onerror = () => reject(req.error ?? new Error(\"preflight open request failed\"));\n  });\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAoCA,eAAsB,aAAa,MAAyC;CAC1E,MAAM,MAAM,KAAK,SAAS,SAAiB,QAAQ,OAAO,MAAM,IAAI;CACpE,MAAM,MAAM,KAAK,SAAS,SAAiB,QAAQ,OAAO,MAAM,IAAI;CACpE,MAAM,gBAAgB,KAAK;CAG3B,MAAM,WAAW,MAAM,aAFR,KAAK,eAAe,KAEM,CAAC;CAC1C,IAAI,SAAS,WAAW,GAAG;EACzB,IAAI,sDAAsD;EAC1D,OAAO;CACT;CAEA,IAAI,gBAAgB,SAAS,OAAO,wCAAwC;CAE5E,MAAM,UAAU,IAAI,WAAW;CAC/B,MAAM,SAAS;CAEf,IAAI,iBAAiB;CACrB,KAAK,MAAM,OAAO,UAAU;EAC1B,IAAI,KAAK,IAAI,QAAQ,IAAI;EACzB,IAAI;GACF,kBAAkB;GAClB,MAAM,aAAa;IAAE;IAAS;IAAQ,eAAe;IAAgB,KAAK,IAAI;GAAI,CAAC;GACnF,IAAI,MAAM;EACZ,SAAS,UAAU;GACjB,IAAI,UAAU;GACd,IAAI,OAAO,oBAAoB,QAAQ,SAAS,UAAU,OAAO,QAAQ,EAAE,GAAG;GAC9E,IAAI,uBAAuB;GAC3B,OAAO;EACT;CACF;CAEA,IAAI,qEAAqE;CACzE,OAAO;AACT;AAOA,eAAe,aAAa,QAA0C;CACpE,IAAI;CACJ,IAAI;EACF,QAAQ,MAAM,QAAQ,QAAQ,EAAE,eAAe,KAAK,CAAC,EAAA,CAAG,QAAQ,MAAM,EAAE,YAAY,CAAC,CAAC,CAAC,KAAK,MAAM,EAAE,IAAI;CAC1G,SAAS,KAAK;EACZ,IAAK,IAA8B,SAAS,UAAU,OAAO,CAAC;EAC9D,MAAM;CACR;CAMA,MAAM,4BAAY,IAAI,IAA2B;CACjD,KAAK,MAAM,WAAW,MAAM;EAC1B,MAAM,UAAU,MAAM,SAAS,KAAK,QAAQ,SAAS,gBAAgB,GAAG,OAAO;EAC/E,MAAM,SAAS,MAAM,SAAS,KAAK,QAAQ,SAAS,UAAU,GAAG,OAAO;EACxE,MAAM,WAAW,KAAK,MAAM,OAAO;EACnC,MAAM,YAAY,KAAK,MAAM,MAAM;EACnC,MAAM,MAAkB,CAAC;EACzB,KAAK,MAAM,MAAM,WAAW;GAC1B,IAAI,CAAC,WAAW,EAAW,GACzB,MAAM,IAAI,MAAM,uBAAuB,QAAQ,aAAa,KAAK,UAAU,EAAE,GAAG;GAElF,IAAI,KAAK,EAAc;EACzB;EACA,MAAM,eAAe,qBAAqB,UAAU,GAA4D;EAChH,IAAI,iBAAiB,SAAS,eAC5B,MAAM,IAAI,MACR,8BAA8B,QAAQ,yBAAyB,SAAS,cAAc,gCACpD,cACpC;EAEF,UAAU,IAAI,SAAS;GAAE;GAAS;GAAU;EAAI,CAAC;CACnD;CAEA,OAAO,qBAAqB,SAAS;AACvC;AAEA,SAAS,aAAa,OAKJ;CAChB,OAAO,IAAI,SAAS,SAAS,WAAW;EACtC,MAAM,MAAM,MAAM,QAAQ,KAAK,MAAM,QAAQ,MAAM,aAAa;EAChE,IAAI,mBAAmB,UAAU;GAC/B,MAAM,SAAS,MAAM;GACrB,MAAM,KAAK,OAAO;GAClB,MAAM,KAAK,OAAO;GAClB,IAAI,OAAO,MAAM;IACf,uBAAO,IAAI,MAAM,0DAA0D,CAAC;IAC5E;GACF;GACA,IAAI;IACF,KAAK,MAAM,MAAM,MAAM,KACrB,cAAc,IAAI,IAAI,EAAE;GAE5B,SAAS,KAAK;IACZ,OAAO,GAAG;GACZ;EACF;EACA,IAAI,kBAAkB;GACpB,IAAI,OAAO,MAAM;GACjB,QAAQ;EACV;EACA,IAAI,gBAAgB,OAAO,IAAI,yBAAS,IAAI,MAAM,+BAA+B,CAAC;CACpF,CAAC;AACH"}

package/dist/psl-interpreter-C0suaXu2.d.mts

@@ -0,0 +1,45 @@
+import { Contract } from "@prisma/orm-framework/contract/types";
+import { Result } from "@prisma/orm-framework/utils/result";
+import { SymbolTable } from "@prisma/orm-framework/psl-parser";
+import { ContractSourceDiagnostics } from "@prisma/orm-framework/config/config-types";
+import { IdbStorage } from "@prisma-idb/target-idb/pack";
+//#region src/core/psl-interpreter.d.ts
+/**
+ * `"full"` interprets the schema as-is (today's behavior, unchanged — this is
+ * the server-facing shape). `"client"` additionally strips anything marked
+ * `@idb.exclude`/`@@idb.exclude`, producing the projected client contract.
+ *
+ * A surviving model's relation (any cardinality, required or optional) to an
+ * excluded model is dropped (with a warning), keeping the underlying FK
+ * scalar field — the model itself is never excluded as a result (ADR 013;
+ * see its §"Why we don't cascade on requiredness"). Field-level excludes
+ * that entangle with a relation (excluding an FK column, or the relation
+ * field itself) remain unsupported and are reported as diagnostics — a
+ * different, still out-of-scope case ADR 013 doesn't cover.
+ */
+type ContractProjection = "full" | "client";
+/**
+ * Interprets a PSL symbol table (`buildSymbolTable` from `@prisma/orm-toolchain`)
+ * and produces an IDB `Contract`.
+ *
+ * This is the IDB equivalent of `interpretPslDocumentToSqlContract` from the
+ * SQL family. It handles IDB-specific constraints:
+ *
+ * - No namespace blocks (IDB has a single implicit `__unbound__` namespace)
+ * - No compound primary keys (IDB `keyPath` must be a single field)
+ * - Relations are FK-side (`@relation`) + backrelation list fields
+ * - Indexes map directly to `IDBObjectStore.createIndex()` calls
+ *
+ * `options.projection: "client"` additionally strips models/fields marked
+ * `@@idb.exclude`/`@idb.exclude`, producing the projected client contract
+ * (ADR 012). Call this twice — once per projection — to emit both the full
+ * and client `Contract`s from the same schema.
+ */
+interface InterpretPslOptions {
+  /** @default "full" */
+  readonly projection?: ContractProjection;
+}
+declare function interpretPslDocumentToIdbContract(table: SymbolTable, sourceId: string, options?: InterpretPslOptions): Result<Contract<IdbStorage>, ContractSourceDiagnostics>;
+//#endregion
+export { InterpretPslOptions as n, interpretPslDocumentToIdbContract as r, ContractProjection as t };
+//# sourceMappingURL=psl-interpreter-C0suaXu2.d.mts.map

package/dist/psl-interpreter-C0suaXu2.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"psl-interpreter-C0suaXu2.d.mts","names":[],"sources":["../src/core/psl-interpreter.ts"],"mappings":";;;;;;;;;;;;;;;;;;;KAmLY;;;;;;;;;;;;;;;;;;UAksBK;;WAEN,aAAa;;iBAGR,kCACd,OAAO,aACP,kBACA,UAAU,sBACT,OAAO,SAAS,aAAa"}