@loradb/lora-graphql 0.17.0 → 0.19.0

package/README.md

@@ -389,7 +389,14 @@ mutation {
   is an error that writes nothing, and an empty `where` is refused.
 - **`upsertFestivals`** creates the inputs whose key is new and updates the
   rest; fields required on create are required only for new keys. A key the
-  caller may not see reads as taken.
+  caller may not see is never updated, and never reported as taken: it gets
+  the answer a free key would (see below).
+- **Creating under a hidden key** (`createFestivals`, `upsertFestivals`, a
+  nested `create`) answers as if the key were free: whatever error the free
+  key would get, and where it would be created, `FORBIDDEN` ("not allowed to
+  create"), never a `CONSTRAINT_VIOLATION` that would confirm the key
+  exists. A key held by a node the caller can read is still reported as
+  taken. See `docs/design/graphql-threat-model.md`.
 - **Deletes** follow `onDelete`: `DETACH` (default) removes the
   relationships, `CASCADE` deletes what the field reaches (checking the
   caller may delete each node), `RESTRICT` refuses while related nodes
@@ -598,7 +605,7 @@ type Post
   with their `sub` and `:`. The claim must be a string, number or boolean;
   otherwise the rule denies. Pick a separator no `sub` contains: with `-`,
   user `a` could take `a-b-…`, the key space of user `a-b`. See
-  [docs/design/graphql-claim-interpolation.md](../../docs/design/graphql-claim-interpolation.md).
+  [docs/design/graphql-threat-model.md](../../docs/design/graphql-threat-model.md).
 - **Claim tests run in JavaScript at compile time**, so an admin's
   statement carries no filter at all. Statements stay specialised and
   index-friendly.
@@ -620,8 +627,12 @@ type Post
 - Field-level `@authorization(validate:)` guards one field: reading it on a
   row that fails is `FORBIDDEN`, filtering by it only matches rows that
   pass, sorting or aggregating by it is refused, and writing it checks the
-  rule. Field-level `@authentication` also guards filtering, sorting and
-  aggregating on the field.
+  rule. A write is what the input sets: a create that leaves the field out
+  is not checked against it, even when `@default` or `@populatedBy` fills
+  it, so a CREATE rule can keep a `verified: Boolean! @default(value: false)`
+  settable by admins only while anyone creates the node. Field-level
+  `@authentication` also guards filtering, sorting and aggregating on the
+  field.
 - Reading a guarded field is checked per row, token or not: without the
   token a rule needs, each row reads the field as `UNAUTHENTICATED`. The
   statement has the same shape either way, so `compile()`, `explain()`,
@@ -693,7 +704,10 @@ operations; the CLI does it in CI.
 **S3: compile once.** `lora.persist({ id: source })` parses and validates
 persisted operations at startup, and `lora.execute({ id, variables, context })`
 runs them with no parsing or validation. Ad hoc documents passed to
-`execute({ source })` are cached too. Translation itself takes about 0.13 ms
+`execute({ source })` are cached too. A subscription runs the same way with
+`lora.subscribe({ id | source, variables, context })`, which returns an
+async iterable of results (end it with `context.signal`); `execute()` answers
+a subscription with an error pointing there. Translation itself takes about 0.13 ms
 for a nested page, and statement text depends only on the shape of the
 input, so LoraDB's own plan cache is hit for every repeat.
 
@@ -901,9 +915,12 @@ Both need `@loradb/lora-node` and work with any test runner.
 ## Drivers, limits and errors
 
 `loraDriver(db)` adapts a `Database` from `@loradb/lora-node` or
-`@loradb/lora-wasm`. Single-statement reads stream; multi-statement reads
-run in one read-only transaction; mutations need interactive transactions,
-which only the Node binding has, so the WASM binding serves reads.
+`@loradb/lora-wasm`. A read of one statement runs with `execute()` (with
+lora-node, on a libuv worker, not the JavaScript thread), except a lookup
+by `@key` that selects only stored fields, which streams its single row
+synchronously; a read of several statements runs in one read-only
+transaction. Mutations need interactive transactions, which only the Node
+binding has, so the WASM binding serves reads.
 `explain()`, and so plan checks, need the Node binding too.
 
 | Option                       | Default       | Meaning                                             |
@@ -920,7 +937,7 @@ which only the Node binding has, so the WASM binding serves reads.
 | `maskErrors`                 | production    | Clients get `DATABASE_ERROR` and an `id` only       |
 | `onError`                    |               | Receives each database error's detail and `id`      |
 | `guards`                     | see below     | Document limits; `false` turns them off             |
-| `persistedOnly`              | false         | `execute()` runs persisted operations only          |
+| `persistedOnly`              | false         | `execute()`, `subscribe()` run persisted ops only   |
 | `budget`                     |               | Cost limit per request, from the context            |
 | `onCost`                     |               | Each root field's estimate, total and limit         |
 | `onStatementEnd`             |               | Duration, rows and error of every statement call    |
@@ -930,21 +947,24 @@ which only the Node binding has, so the WASM binding serves reads.
 Errors carry `extensions.code`: `BAD_USER_INPUT`, `INVALID_CURSOR`,
 `LIMIT_EXCEEDED`, `COST_EXCEEDED`, `UNAUTHENTICATED`, `FORBIDDEN`,
 `NOT_FOUND`, `CONSTRAINT_VIOLATION` (with `type` and `field`),
-`DATABASE_ERROR` (with an `id`, also given to `onError`) and
-`PERSISTED_QUERY_ONLY` (`execute()` got a document under `persistedOnly`). An invalid SDL
+`DATABASE_ERROR` (with an `id`, also given to `onError`),
+`PERSISTED_QUERY_ONLY` (`execute()` or `subscribe()` got a document under
+`persistedOnly`) and `WRONG_OPERATION_TYPE` (`execute()` got a
+subscription, or `subscribe()` a query or mutation). An invalid SDL
 throws one `ModelError` listing every problem, each located by type and
 field.
 
 ### Security defaults
 
 `maxCost` bounds the rows an operation touches; the document guards bound
-the document before that. `execute()` and `persist()` apply them, and
+the document before that. `execute()`, `subscribe()` and `persist()` apply them, and
 `lora.validationRules()` / `lora.envelopPlugin()` bring them to any other
 server (GraphQL Yoga takes the plugin as is):
 
 | Guard           | Default    | Limit                                    |
 | --------------- | ---------- | ---------------------------------------- |
 | `maxDepth`      | 12         | Field nesting, through fragments         |
+| `maxIntrospectionDepth` | 20 | Nesting under `__schema` / `__type`      |
 | `maxAliases`    | 30         | Aliased fields per document              |
 | `maxRootFields` | 20         | Root fields per operation                |
 | `maxTokens`     | 5000       | Lexer tokens per document, while parsing |
@@ -1003,7 +1023,7 @@ Measured on LoraDB 0.15 over 20 000 festivals and 100 000 relationships
 
 | Rule                                                                                 | Why                                                                                  |
 | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
-| Relationship filters as `size([… \| 1])`; aggregates of related values with `reduce` | No `OPTIONAL MATCH`; `EXISTS { }` does not parse; aggregates nest safely             |
+| Relationship filters as `size([… \| 1])`; aggregates of related values with `reduce` | No `OPTIONAL MATCH`; aggregates nest safely                                          |
 | `CALL { }` for nested lists, nested connections, `@cypher` and interface members     | The only way to sort, limit and aggregate per parent                                 |
 | Ordered by an always-present string: `WHERE s >= ""`                                 | The planner walks the index in order and stops at the limit: 0.03 ms instead of 7 ms |
 | Mutation statements seek the key in their own `MATCH`, then expand                   | The plan no longer depends on the optimizer finding the seek: 0.06 ms per connect    |
@@ -1028,7 +1048,7 @@ Measured on LoraDB 0.15 over 20 000 festivals and 100 000 relationships
 | `@authorization` rules evaluated in Cypher                  | Claim checks folded in JavaScript; node rules compiled           |
 | You pick indexes                                            | Inferred from the API, and verified with `explain()`             |
 | Unbounded lists; complexity left to you                     | Every list bounded; a cost limit per operation                   |
-| Subscriptions over CDC                                      | `@subscription`, from library-made writes                        |
+| Subscriptions over CDC                                      | `@subscription`, from library-made writes or, with `changeFeed: true`, every committed write |
 | Interfaces and unions with `UNION`                          | Per-member subqueries merged by sort, each using its own indexes |
 | Federation                                                  | Not supported                                                    |
 
@@ -1048,7 +1068,7 @@ before a following `SET`, list comparison (`[a, b] > $list`) and
 | An aggregate nested in a call (`head(collect(x))`, `collect(x)[0..2]`) is not aggregated | `WITH collect(x) AS c RETURN head(c)`; `reduce` for per-parent aggregates |
 | `max`, `sum` and `avg` over durations are wrong                                          | Duration aggregates are folded with `reduce`                              |
 | Integer division returns a float; negative list slices (`l[..-1]`) return `[]`           | `toInteger(a / b)` for Int fields; `l[..size(l) - n]`                     |
-| `COUNT { … RETURN DISTINCT x }`, `EXISTS { }` and `UNION` inside `CALL` do not parse     | `reduce` for distinct counts; comprehensions; per-member subqueries       |
+| `COUNT { … RETURN DISTINCT x }` and `UNION` inside `CALL` do not parse                   | `reduce` for distinct counts; per-member subqueries                       |
 
 ## Development
 

package/dist/cli.js

@@ -2,8 +2,8 @@
 import { stat as z, readdir as oe, readFile as ie, mkdir as re, writeFile as _ } from "node:fs/promises";
 import { join as $, relative as ce } from "node:path";
 import { parse as q, Kind as p, visit as H, print as Q, typeFromAST as ue, isNonNullType as F, isListType as le, getNamedType as fe, isEnumType as de, isInputObjectType as pe } from "graphql";
-import { d as me } from "./diff-8nsBSSNP.js";
-import { m as V, d as he, M as ge, L as M, l as Y, f as J, o as Z, b as ve, i as we, r as Te, u as Ee } from "./driver-BmnRtkpd.js";
+import { d as me } from "./diff-BH4Na9pC.js";
+import { m as V, d as he, M as ge, L as M, l as Y, f as J, o as Z, b as ve, i as we, r as Te, u as Ee } from "./driver-CuXOoYWT.js";
 const be = /* @__PURE__ */ new Set(["Query", "Mutation", "Subscription"]), W = {
   coalesce: "@coalesce is not supported: it hides predicates from indexes; store a value instead",
   subscriptionsAuthorization: "@subscriptionsAuthorization is not supported: SUBSCRIBE rules go in @authorization",

package/dist/compile/read.d.ts

@@ -27,6 +27,12 @@ export interface CompiledRead {
     cost: number;
     /** `read` for queries; `write` for @cypher mutations. */
     mode: "read" | "write";
+    /**
+     * At most one row, found by an exact @key seek, projecting only stored
+     * properties: no relationship, @cypher field or rule traversal. Cheap
+     * enough for a driver to run synchronously.
+     */
+    bounded?: boolean;
 }
 type Args = Record<string, unknown>;
 /** A connection value before its resolvers turn it into edges/pageInfo. */

package/dist/{diff-8nsBSSNP.js → diff-BH4Na9pC.js}

@@ -1,5 +1,5 @@
 import * as w from "graphql";
-import { b as $, i as b, r as E, j as N, n as i, k as S } from "./driver-BmnRtkpd.js";
+import { b as $, i as b, r as E, j as N, n as i, k as S } from "./driver-CuXOoYWT.js";
 function k(t, n, o = {}) {
   const s = $(t, o), r = $(n, o), l = N, u = new Map(b(s).map((e) => [l(e), e])), c = new Map(b(r).map((e) => [l(e), e])), p = [...c].filter(([e]) => !u.has(e)).map(([, e]) => e), h = [...u].filter(([e]) => !c.has(e)).map(([, e]) => e), d = [], f = [];
   C(s, r, d, f);
@@ -96,4 +96,4 @@ function M(t, n) {
 export {
   k as d
 };
-//# sourceMappingURL=diff-8nsBSSNP.js.map
+//# sourceMappingURL=diff-BH4Na9pC.js.map

package/dist/{diff-8nsBSSNP.js.map → diff-BH4Na9pC.js.map}

@@ -1 +1 @@
-{"version":3,"file":"diff-8nsBSSNP.js","sources":["../src/analyze/diff.ts"],"sourcesContent":["// S7: one SDL, two diffs. A change to the annotated SDL changes both the\n// database (constraints, indexes, labels, property names) and the public\n// API; `diffSchemas` reports both from the same two documents.\n\nimport * as graphql from \"graphql\";\nimport type { DocumentNode, GraphQLSchema } from \"graphql\";\nimport { name } from \"../compile/cypher.js\";\nimport { buildModel, type ModelOptions } from \"../model/build.js\";\nimport type { Field, GraphModel, ScalarField } from \"../model/types.js\";\nimport { buildSchema } from \"../schema/build.js\";\nimport {\n  inferRequirements,\n  requirementDdl,\n  requirementId,\n  type SchemaRequirement,\n} from \"./indexes.js\";\n\nexport interface ApiChange {\n  /** graphql-js change type, e.g. `FIELD_REMOVED`. */\n  type: string;\n  description: string;\n}\n\nexport interface SchemaDiff {\n  database: {\n    create: SchemaRequirement[];\n    drop: SchemaRequirement[];\n    /**\n     * Statements in the order to run them. Drops and data migrations are\n     * destructive: review them before running.\n     */\n    statements: Array<{ text: string; destructive: boolean; reason: string }>;\n  };\n  api: {\n    /** Changes that break existing clients. */\n    breaking: ApiChange[];\n    /** Changes that may change behaviour for existing clients. */\n    dangerous: ApiChange[];\n  };\n  /** Consequences worth a human look, e.g. a rename kept by @alias. */\n  notes: string[];\n}\n\nexport function diffSchemas(\n  before: string | DocumentNode,\n  after: string | DocumentNode,\n  options: ModelOptions = {},\n): SchemaDiff {\n  const oldModel = buildModel(before, options);\n  const newModel = buildModel(after, options);\n\n  const id = requirementId;\n  const oldReqs = new Map(inferRequirements(oldModel).map((r) => [id(r), r]));\n  const newReqs = new Map(inferRequirements(newModel).map((r) => [id(r), r]));\n  const create = [...newReqs]\n    .filter(([k]) => !oldReqs.has(k))\n    .map(([, r]) => r);\n  const drop = [...oldReqs].filter(([k]) => !newReqs.has(k)).map(([, r]) => r);\n\n  const statements: SchemaDiff[\"database\"][\"statements\"] = [];\n  const notes: string[] = [];\n  migrations(oldModel, newModel, statements, notes);\n  for (const r of drop) {\n    statements.push({\n      text: `DROP ${r.kind === \"constraint\" ? \"CONSTRAINT\" : \"INDEX\"} \\`${r.name.replace(/`/g, \"``\")}\\` IF EXISTS`,\n      destructive: true,\n      reason: `no longer needed: ${r.reason}`,\n    });\n  }\n  for (const r of create) {\n    statements.push({\n      text: requirementDdl(r),\n      destructive: false,\n      reason: r.reason,\n    });\n  }\n\n  const api = apiChanges(publicSchema(oldModel), publicSchema(newModel));\n  return { database: { create, drop, statements }, api, notes };\n}\n\n/** Relabelled types and renamed properties need their data moved. */\nfunction migrations(\n  before: GraphModel,\n  after: GraphModel,\n  statements: SchemaDiff[\"database\"][\"statements\"],\n  notes: string[],\n) {\n  for (const [typeName, oldNode] of before.nodes) {\n    const newNode = after.nodes.get(typeName);\n    if (!newNode) {\n      notes.push(\n        `${typeName} was removed; its :${oldNode.labels[0]} nodes stay in the database`,\n      );\n      continue;\n    }\n    const oldLabel = oldNode.labels[0]!;\n    const newLabel = newNode.labels[0]!;\n    if (oldLabel !== newLabel) {\n      statements.push({\n        text: `MATCH (n:${name(oldLabel)}) SET n:${name(newLabel)} REMOVE n:${name(oldLabel)}`,\n        destructive: true,\n        reason: `${typeName}'s label changed from ${oldLabel} to ${newLabel}`,\n      });\n    }\n    const oldFields = scalars(oldNode.fields);\n    const newFields = scalars(newNode.fields);\n    for (const [fieldName, oldField] of oldFields) {\n      const newField = newFields.get(fieldName);\n      if (newField && newField.property !== oldField.property) {\n        statements.push({\n          text: `MATCH (n:${name(newLabel)}) WHERE n.${name(oldField.property)} IS NOT NULL SET n.${name(newField.property)} = n.${name(oldField.property)} REMOVE n.${name(oldField.property)}`,\n          destructive: true,\n          reason: `${typeName}.${fieldName} now stores \\`${newField.property}\\` instead of \\`${oldField.property}\\``,\n        });\n      }\n      if (!newField) {\n        const renamed = [...newFields.values()].find(\n          (f) => f.property === oldField.property && !oldFields.has(f.name),\n        );\n        if (renamed) {\n          notes.push(\n            `${typeName}.${fieldName} is now ${typeName}.${renamed.name} over the same property \\`${oldField.property}\\`: an API break with no data migration`,\n          );\n        }\n      }\n    }\n  }\n}\n\nfunction scalars(fields: ReadonlyMap<string, Field>): Map<string, ScalarField> {\n  const out = new Map<string, ScalarField>();\n  for (const f of fields.values()) if (f.kind === \"scalar\") out.set(f.name, f);\n  return out;\n}\n\nfunction publicSchema(model: GraphModel): GraphQLSchema {\n  const never = () => Promise.reject(new Error(\"not connected\"));\n  return buildSchema(model, {\n    customResolver: () => () => null,\n    resolveSearch: never,\n    resolveAbstract: never,\n    subscribe: () => {\n      throw new Error(\"not connected\");\n    },\n    resolveChangedNode: never,\n    resolveRoot: never,\n    resolveNode: never,\n    resolveCypher: never,\n    resolveMutation: never,\n  });\n}\n\ntype ChangeFinder = (\n  a: GraphQLSchema,\n  b: GraphQLSchema,\n) => Array<{ type: string; description: string }>;\n\nfunction apiChanges(\n  before: GraphQLSchema,\n  after: GraphQLSchema,\n): SchemaDiff[\"api\"] {\n  // graphql-js 16 ships these; 17 removed them.\n  const lib = graphql as unknown as {\n    findBreakingChanges?: ChangeFinder;\n    findDangerousChanges?: ChangeFinder;\n  };\n  if (!lib.findBreakingChanges || !lib.findDangerousChanges) {\n    return {\n      breaking: [\n        {\n          type: \"UNSUPPORTED\",\n          description:\n            \"this graphql version has no findBreakingChanges; compare printPublicSchema() output with @graphql-inspector/core\",\n        },\n      ],\n      dangerous: [],\n    };\n  }\n  const pick = (c: { type: string; description: string }) => ({\n    type: c.type,\n    description: c.description,\n  });\n  return {\n    breaking: lib.findBreakingChanges(before, after).map(pick),\n    dangerous: lib.findDangerousChanges(before, after).map(pick),\n  };\n}\n"],"names":["diffSchemas","before","after","options","oldModel","buildModel","newModel","id","requirementId","oldReqs","inferRequirements","r","newReqs","create","k","drop","statements","notes","migrations","requirementDdl","api","apiChanges","publicSchema","typeName","oldNode","newNode","oldLabel","newLabel","name","oldFields","scalars","newFields","fieldName","oldField","newField","renamed","f","fields","out","model","never","buildSchema","lib","graphql","pick","c"],"mappings":";;AA2CO,SAASA,EACdC,GACAC,GACAC,IAAwB,CAAA,GACZ;AACZ,QAAMC,IAAWC,EAAWJ,GAAQE,CAAO,GACrCG,IAAWD,EAAWH,GAAOC,CAAO,GAEpCI,IAAKC,GACLC,IAAU,IAAI,IAAIC,EAAkBN,CAAQ,EAAE,IAAI,CAACO,MAAM,CAACJ,EAAGI,CAAC,GAAGA,CAAC,CAAC,CAAC,GACpEC,IAAU,IAAI,IAAIF,EAAkBJ,CAAQ,EAAE,IAAI,CAACK,MAAM,CAACJ,EAAGI,CAAC,GAAGA,CAAC,CAAC,CAAC,GACpEE,IAAS,CAAC,GAAGD,CAAO,EACvB,OAAO,CAAC,CAACE,CAAC,MAAM,CAACL,EAAQ,IAAIK,CAAC,CAAC,EAC/B,IAAI,CAAC,CAAA,EAAGH,CAAC,MAAMA,CAAC,GACbI,IAAO,CAAC,GAAGN,CAAO,EAAE,OAAO,CAAC,CAACK,CAAC,MAAM,CAACF,EAAQ,IAAIE,CAAC,CAAC,EAAE,IAAI,CAAC,CAAA,EAAGH,CAAC,MAAMA,CAAC,GAErEK,IAAmD,CAAA,GACnDC,IAAkB,CAAA;AACxB,EAAAC,EAAWd,GAAUE,GAAUU,GAAYC,CAAK;AAChD,aAAWN,KAAKI;AACd,IAAAC,EAAW,KAAK;AAAA,MACd,MAAM,QAAQL,EAAE,SAAS,eAAe,eAAe,OAAO,MAAMA,EAAE,KAAK,QAAQ,MAAM,IAAI,CAAC;AAAA,MAC9F,aAAa;AAAA,MACb,QAAQ,qBAAqBA,EAAE,MAAM;AAAA,IAAA,CACtC;AAEH,aAAWA,KAAKE;AACd,IAAAG,EAAW,KAAK;AAAA,MACd,MAAMG,EAAeR,CAAC;AAAA,MACtB,aAAa;AAAA,MACb,QAAQA,EAAE;AAAA,IAAA,CACX;AAGH,QAAMS,IAAMC,EAAWC,EAAalB,CAAQ,GAAGkB,EAAahB,CAAQ,CAAC;AACrE,SAAO,EAAE,UAAU,EAAE,QAAAO,GAAQ,MAAAE,GAAM,YAAAC,EAAA,GAAc,KAAAI,GAAK,OAAAH,EAAA;AACxD;AAGA,SAASC,EACPjB,GACAC,GACAc,GACAC,GACA;AACA,aAAW,CAACM,GAAUC,CAAO,KAAKvB,EAAO,OAAO;AAC9C,UAAMwB,IAAUvB,EAAM,MAAM,IAAIqB,CAAQ;AACxC,QAAI,CAACE,GAAS;AACZ,MAAAR,EAAM;AAAA,QACJ,GAAGM,CAAQ,sBAAsBC,EAAQ,OAAO,CAAC,CAAC;AAAA,MAAA;AAEpD;AAAA,IACF;AACA,UAAME,IAAWF,EAAQ,OAAO,CAAC,GAC3BG,IAAWF,EAAQ,OAAO,CAAC;AACjC,IAAIC,MAAaC,KACfX,EAAW,KAAK;AAAA,MACd,MAAM,YAAYY,EAAKF,CAAQ,CAAC,WAAWE,EAAKD,CAAQ,CAAC,aAAaC,EAAKF,CAAQ,CAAC;AAAA,MACpF,aAAa;AAAA,MACb,QAAQ,GAAGH,CAAQ,yBAAyBG,CAAQ,OAAOC,CAAQ;AAAA,IAAA,CACpE;AAEH,UAAME,IAAYC,EAAQN,EAAQ,MAAM,GAClCO,IAAYD,EAAQL,EAAQ,MAAM;AACxC,eAAW,CAACO,GAAWC,CAAQ,KAAKJ,GAAW;AAC7C,YAAMK,IAAWH,EAAU,IAAIC,CAAS;AAQxC,UAPIE,KAAYA,EAAS,aAAaD,EAAS,YAC7CjB,EAAW,KAAK;AAAA,QACd,MAAM,YAAYY,EAAKD,CAAQ,CAAC,aAAaC,EAAKK,EAAS,QAAQ,CAAC,sBAAsBL,EAAKM,EAAS,QAAQ,CAAC,QAAQN,EAAKK,EAAS,QAAQ,CAAC,aAAaL,EAAKK,EAAS,QAAQ,CAAC;AAAA,QACpL,aAAa;AAAA,QACb,QAAQ,GAAGV,CAAQ,IAAIS,CAAS,iBAAiBE,EAAS,QAAQ,mBAAmBD,EAAS,QAAQ;AAAA,MAAA,CACvG,GAEC,CAACC,GAAU;AACb,cAAMC,IAAU,CAAC,GAAGJ,EAAU,OAAA,CAAQ,EAAE;AAAA,UACtC,CAACK,MAAMA,EAAE,aAAaH,EAAS,YAAY,CAACJ,EAAU,IAAIO,EAAE,IAAI;AAAA,QAAA;AAElE,QAAID,KACFlB,EAAM;AAAA,UACJ,GAAGM,CAAQ,IAAIS,CAAS,WAAWT,CAAQ,IAAIY,EAAQ,IAAI,6BAA6BF,EAAS,QAAQ;AAAA,QAAA;AAAA,MAG/G;AAAA,IACF;AAAA,EACF;AACF;AAEA,SAASH,EAAQO,GAA8D;AAC7E,QAAMC,wBAAU,IAAA;AAChB,aAAWF,KAAKC,EAAO,OAAA,EAAU,CAAID,EAAE,SAAS,YAAUE,EAAI,IAAIF,EAAE,MAAMA,CAAC;AAC3E,SAAOE;AACT;AAEA,SAAShB,EAAaiB,GAAkC;AACtD,QAAMC,IAAQ,MAAM,QAAQ,OAAO,IAAI,MAAM,eAAe,CAAC;AAC7D,SAAOC,EAAYF,GAAO;AAAA,IACxB,gBAAgB,MAAM,MAAM;AAAA,IAC5B,eAAeC;AAAA,IACf,iBAAiBA;AAAA,IACjB,WAAW,MAAM;AACf,YAAM,IAAI,MAAM,eAAe;AAAA,IACjC;AAAA,IACA,oBAAoBA;AAAA,IACpB,aAAaA;AAAA,IACb,aAAaA;AAAA,IACb,eAAeA;AAAA,IACf,iBAAiBA;AAAA,EAAA,CAClB;AACH;AAOA,SAASnB,EACPpB,GACAC,GACmB;AAEnB,QAAMwC,IAAMC;AAIZ,MAAI,CAACD,EAAI,uBAAuB,CAACA,EAAI;AACnC,WAAO;AAAA,MACL,UAAU;AAAA,QACR;AAAA,UACE,MAAM;AAAA,UACN,aACE;AAAA,QAAA;AAAA,MACJ;AAAA,MAEF,WAAW,CAAA;AAAA,IAAC;AAGhB,QAAME,IAAO,CAACC,OAA8C;AAAA,IAC1D,MAAMA,EAAE;AAAA,IACR,aAAaA,EAAE;AAAA,EAAA;AAEjB,SAAO;AAAA,IACL,UAAUH,EAAI,oBAAoBzC,GAAQC,CAAK,EAAE,IAAI0C,CAAI;AAAA,IACzD,WAAWF,EAAI,qBAAqBzC,GAAQC,CAAK,EAAE,IAAI0C,CAAI;AAAA,EAAA;AAE/D;"}
+{"version":3,"file":"diff-BH4Na9pC.js","sources":["../src/analyze/diff.ts"],"sourcesContent":["// S7: one SDL, two diffs. A change to the annotated SDL changes both the\n// database (constraints, indexes, labels, property names) and the public\n// API; `diffSchemas` reports both from the same two documents.\n\nimport * as graphql from \"graphql\";\nimport type { DocumentNode, GraphQLSchema } from \"graphql\";\nimport { name } from \"../compile/cypher.js\";\nimport { buildModel, type ModelOptions } from \"../model/build.js\";\nimport type { Field, GraphModel, ScalarField } from \"../model/types.js\";\nimport { buildSchema } from \"../schema/build.js\";\nimport {\n  inferRequirements,\n  requirementDdl,\n  requirementId,\n  type SchemaRequirement,\n} from \"./indexes.js\";\n\nexport interface ApiChange {\n  /** graphql-js change type, e.g. `FIELD_REMOVED`. */\n  type: string;\n  description: string;\n}\n\nexport interface SchemaDiff {\n  database: {\n    create: SchemaRequirement[];\n    drop: SchemaRequirement[];\n    /**\n     * Statements in the order to run them. Drops and data migrations are\n     * destructive: review them before running.\n     */\n    statements: Array<{ text: string; destructive: boolean; reason: string }>;\n  };\n  api: {\n    /** Changes that break existing clients. */\n    breaking: ApiChange[];\n    /** Changes that may change behaviour for existing clients. */\n    dangerous: ApiChange[];\n  };\n  /** Consequences worth a human look, e.g. a rename kept by @alias. */\n  notes: string[];\n}\n\nexport function diffSchemas(\n  before: string | DocumentNode,\n  after: string | DocumentNode,\n  options: ModelOptions = {},\n): SchemaDiff {\n  const oldModel = buildModel(before, options);\n  const newModel = buildModel(after, options);\n\n  const id = requirementId;\n  const oldReqs = new Map(inferRequirements(oldModel).map((r) => [id(r), r]));\n  const newReqs = new Map(inferRequirements(newModel).map((r) => [id(r), r]));\n  const create = [...newReqs]\n    .filter(([k]) => !oldReqs.has(k))\n    .map(([, r]) => r);\n  const drop = [...oldReqs].filter(([k]) => !newReqs.has(k)).map(([, r]) => r);\n\n  const statements: SchemaDiff[\"database\"][\"statements\"] = [];\n  const notes: string[] = [];\n  migrations(oldModel, newModel, statements, notes);\n  for (const r of drop) {\n    statements.push({\n      text: `DROP ${r.kind === \"constraint\" ? \"CONSTRAINT\" : \"INDEX\"} \\`${r.name.replace(/`/g, \"``\")}\\` IF EXISTS`,\n      destructive: true,\n      reason: `no longer needed: ${r.reason}`,\n    });\n  }\n  for (const r of create) {\n    statements.push({\n      text: requirementDdl(r),\n      destructive: false,\n      reason: r.reason,\n    });\n  }\n\n  const api = apiChanges(publicSchema(oldModel), publicSchema(newModel));\n  return { database: { create, drop, statements }, api, notes };\n}\n\n/** Relabelled types and renamed properties need their data moved. */\nfunction migrations(\n  before: GraphModel,\n  after: GraphModel,\n  statements: SchemaDiff[\"database\"][\"statements\"],\n  notes: string[],\n) {\n  for (const [typeName, oldNode] of before.nodes) {\n    const newNode = after.nodes.get(typeName);\n    if (!newNode) {\n      notes.push(\n        `${typeName} was removed; its :${oldNode.labels[0]} nodes stay in the database`,\n      );\n      continue;\n    }\n    const oldLabel = oldNode.labels[0]!;\n    const newLabel = newNode.labels[0]!;\n    if (oldLabel !== newLabel) {\n      statements.push({\n        text: `MATCH (n:${name(oldLabel)}) SET n:${name(newLabel)} REMOVE n:${name(oldLabel)}`,\n        destructive: true,\n        reason: `${typeName}'s label changed from ${oldLabel} to ${newLabel}`,\n      });\n    }\n    const oldFields = scalars(oldNode.fields);\n    const newFields = scalars(newNode.fields);\n    for (const [fieldName, oldField] of oldFields) {\n      const newField = newFields.get(fieldName);\n      if (newField && newField.property !== oldField.property) {\n        statements.push({\n          text: `MATCH (n:${name(newLabel)}) WHERE n.${name(oldField.property)} IS NOT NULL SET n.${name(newField.property)} = n.${name(oldField.property)} REMOVE n.${name(oldField.property)}`,\n          destructive: true,\n          reason: `${typeName}.${fieldName} now stores \\`${newField.property}\\` instead of \\`${oldField.property}\\``,\n        });\n      }\n      if (!newField) {\n        const renamed = [...newFields.values()].find(\n          (f) => f.property === oldField.property && !oldFields.has(f.name),\n        );\n        if (renamed) {\n          notes.push(\n            `${typeName}.${fieldName} is now ${typeName}.${renamed.name} over the same property \\`${oldField.property}\\`: an API break with no data migration`,\n          );\n        }\n      }\n    }\n  }\n}\n\nfunction scalars(fields: ReadonlyMap<string, Field>): Map<string, ScalarField> {\n  const out = new Map<string, ScalarField>();\n  for (const f of fields.values()) if (f.kind === \"scalar\") out.set(f.name, f);\n  return out;\n}\n\nfunction publicSchema(model: GraphModel): GraphQLSchema {\n  const never = () => Promise.reject(new Error(\"not connected\"));\n  return buildSchema(model, {\n    customResolver: () => () => null,\n    resolveSearch: never,\n    resolveAbstract: never,\n    subscribe: () => {\n      throw new Error(\"not connected\");\n    },\n    resolveChangedNode: never,\n    resolveRoot: never,\n    resolveNode: never,\n    resolveCypher: never,\n    resolveMutation: never,\n  });\n}\n\ntype ChangeFinder = (\n  a: GraphQLSchema,\n  b: GraphQLSchema,\n) => Array<{ type: string; description: string }>;\n\nfunction apiChanges(\n  before: GraphQLSchema,\n  after: GraphQLSchema,\n): SchemaDiff[\"api\"] {\n  // graphql-js 16 ships these; 17 removed them.\n  const lib = graphql as unknown as {\n    findBreakingChanges?: ChangeFinder;\n    findDangerousChanges?: ChangeFinder;\n  };\n  if (!lib.findBreakingChanges || !lib.findDangerousChanges) {\n    return {\n      breaking: [\n        {\n          type: \"UNSUPPORTED\",\n          description:\n            \"this graphql version has no findBreakingChanges; compare printPublicSchema() output with @graphql-inspector/core\",\n        },\n      ],\n      dangerous: [],\n    };\n  }\n  const pick = (c: { type: string; description: string }) => ({\n    type: c.type,\n    description: c.description,\n  });\n  return {\n    breaking: lib.findBreakingChanges(before, after).map(pick),\n    dangerous: lib.findDangerousChanges(before, after).map(pick),\n  };\n}\n"],"names":["diffSchemas","before","after","options","oldModel","buildModel","newModel","id","requirementId","oldReqs","inferRequirements","r","newReqs","create","k","drop","statements","notes","migrations","requirementDdl","api","apiChanges","publicSchema","typeName","oldNode","newNode","oldLabel","newLabel","name","oldFields","scalars","newFields","fieldName","oldField","newField","renamed","f","fields","out","model","never","buildSchema","lib","graphql","pick","c"],"mappings":";;AA2CO,SAASA,EACdC,GACAC,GACAC,IAAwB,CAAA,GACZ;AACZ,QAAMC,IAAWC,EAAWJ,GAAQE,CAAO,GACrCG,IAAWD,EAAWH,GAAOC,CAAO,GAEpCI,IAAKC,GACLC,IAAU,IAAI,IAAIC,EAAkBN,CAAQ,EAAE,IAAI,CAACO,MAAM,CAACJ,EAAGI,CAAC,GAAGA,CAAC,CAAC,CAAC,GACpEC,IAAU,IAAI,IAAIF,EAAkBJ,CAAQ,EAAE,IAAI,CAACK,MAAM,CAACJ,EAAGI,CAAC,GAAGA,CAAC,CAAC,CAAC,GACpEE,IAAS,CAAC,GAAGD,CAAO,EACvB,OAAO,CAAC,CAACE,CAAC,MAAM,CAACL,EAAQ,IAAIK,CAAC,CAAC,EAC/B,IAAI,CAAC,CAAA,EAAGH,CAAC,MAAMA,CAAC,GACbI,IAAO,CAAC,GAAGN,CAAO,EAAE,OAAO,CAAC,CAACK,CAAC,MAAM,CAACF,EAAQ,IAAIE,CAAC,CAAC,EAAE,IAAI,CAAC,CAAA,EAAGH,CAAC,MAAMA,CAAC,GAErEK,IAAmD,CAAA,GACnDC,IAAkB,CAAA;AACxB,EAAAC,EAAWd,GAAUE,GAAUU,GAAYC,CAAK;AAChD,aAAWN,KAAKI;AACd,IAAAC,EAAW,KAAK;AAAA,MACd,MAAM,QAAQL,EAAE,SAAS,eAAe,eAAe,OAAO,MAAMA,EAAE,KAAK,QAAQ,MAAM,IAAI,CAAC;AAAA,MAC9F,aAAa;AAAA,MACb,QAAQ,qBAAqBA,EAAE,MAAM;AAAA,IAAA,CACtC;AAEH,aAAWA,KAAKE;AACd,IAAAG,EAAW,KAAK;AAAA,MACd,MAAMG,EAAeR,CAAC;AAAA,MACtB,aAAa;AAAA,MACb,QAAQA,EAAE;AAAA,IAAA,CACX;AAGH,QAAMS,IAAMC,EAAWC,EAAalB,CAAQ,GAAGkB,EAAahB,CAAQ,CAAC;AACrE,SAAO,EAAE,UAAU,EAAE,QAAAO,GAAQ,MAAAE,GAAM,YAAAC,EAAA,GAAc,KAAAI,GAAK,OAAAH,EAAA;AACxD;AAGA,SAASC,EACPjB,GACAC,GACAc,GACAC,GACA;AACA,aAAW,CAACM,GAAUC,CAAO,KAAKvB,EAAO,OAAO;AAC9C,UAAMwB,IAAUvB,EAAM,MAAM,IAAIqB,CAAQ;AACxC,QAAI,CAACE,GAAS;AACZ,MAAAR,EAAM;AAAA,QACJ,GAAGM,CAAQ,sBAAsBC,EAAQ,OAAO,CAAC,CAAC;AAAA,MAAA;AAEpD;AAAA,IACF;AACA,UAAME,IAAWF,EAAQ,OAAO,CAAC,GAC3BG,IAAWF,EAAQ,OAAO,CAAC;AACjC,IAAIC,MAAaC,KACfX,EAAW,KAAK;AAAA,MACd,MAAM,YAAYY,EAAKF,CAAQ,CAAC,WAAWE,EAAKD,CAAQ,CAAC,aAAaC,EAAKF,CAAQ,CAAC;AAAA,MACpF,aAAa;AAAA,MACb,QAAQ,GAAGH,CAAQ,yBAAyBG,CAAQ,OAAOC,CAAQ;AAAA,IAAA,CACpE;AAEH,UAAME,IAAYC,EAAQN,EAAQ,MAAM,GAClCO,IAAYD,EAAQL,EAAQ,MAAM;AACxC,eAAW,CAACO,GAAWC,CAAQ,KAAKJ,GAAW;AAC7C,YAAMK,IAAWH,EAAU,IAAIC,CAAS;AAQxC,UAPIE,KAAYA,EAAS,aAAaD,EAAS,YAC7CjB,EAAW,KAAK;AAAA,QACd,MAAM,YAAYY,EAAKD,CAAQ,CAAC,aAAaC,EAAKK,EAAS,QAAQ,CAAC,sBAAsBL,EAAKM,EAAS,QAAQ,CAAC,QAAQN,EAAKK,EAAS,QAAQ,CAAC,aAAaL,EAAKK,EAAS,QAAQ,CAAC;AAAA,QACpL,aAAa;AAAA,QACb,QAAQ,GAAGV,CAAQ,IAAIS,CAAS,iBAAiBE,EAAS,QAAQ,mBAAmBD,EAAS,QAAQ;AAAA,MAAA,CACvG,GAEC,CAACC,GAAU;AACb,cAAMC,IAAU,CAAC,GAAGJ,EAAU,OAAA,CAAQ,EAAE;AAAA,UACtC,CAACK,MAAMA,EAAE,aAAaH,EAAS,YAAY,CAACJ,EAAU,IAAIO,EAAE,IAAI;AAAA,QAAA;AAElE,QAAID,KACFlB,EAAM;AAAA,UACJ,GAAGM,CAAQ,IAAIS,CAAS,WAAWT,CAAQ,IAAIY,EAAQ,IAAI,6BAA6BF,EAAS,QAAQ;AAAA,QAAA;AAAA,MAG/G;AAAA,IACF;AAAA,EACF;AACF;AAEA,SAASH,EAAQO,GAA8D;AAC7E,QAAMC,wBAAU,IAAA;AAChB,aAAWF,KAAKC,EAAO,OAAA,EAAU,CAAID,EAAE,SAAS,YAAUE,EAAI,IAAIF,EAAE,MAAMA,CAAC;AAC3E,SAAOE;AACT;AAEA,SAAShB,EAAaiB,GAAkC;AACtD,QAAMC,IAAQ,MAAM,QAAQ,OAAO,IAAI,MAAM,eAAe,CAAC;AAC7D,SAAOC,EAAYF,GAAO;AAAA,IACxB,gBAAgB,MAAM,MAAM;AAAA,IAC5B,eAAeC;AAAA,IACf,iBAAiBA;AAAA,IACjB,WAAW,MAAM;AACf,YAAM,IAAI,MAAM,eAAe;AAAA,IACjC;AAAA,IACA,oBAAoBA;AAAA,IACpB,aAAaA;AAAA,IACb,aAAaA;AAAA,IACb,eAAeA;AAAA,IACf,iBAAiBA;AAAA,EAAA,CAClB;AACH;AAOA,SAASnB,EACPpB,GACAC,GACmB;AAEnB,QAAMwC,IAAMC;AAIZ,MAAI,CAACD,EAAI,uBAAuB,CAACA,EAAI;AACnC,WAAO;AAAA,MACL,UAAU;AAAA,QACR;AAAA,UACE,MAAM;AAAA,UACN,aACE;AAAA,QAAA;AAAA,MACJ;AAAA,MAEF,WAAW,CAAA;AAAA,IAAC;AAGhB,QAAME,IAAO,CAACC,OAA8C;AAAA,IAC1D,MAAMA,EAAE;AAAA,IACR,aAAaA,EAAE;AAAA,EAAA;AAEjB,SAAO;AAAA,IACL,UAAUH,EAAI,oBAAoBzC,GAAQC,CAAK,EAAE,IAAI0C,CAAI;AAAA,IACzD,WAAWF,EAAI,qBAAqBzC,GAAQC,CAAK,EAAE,IAAI0C,CAAI;AAAA,EAAA;AAE/D;"}