@loradb/lora-graphql 0.20.0 → 0.20.1

package/README.md

@@ -124,7 +124,7 @@ Model:
 | `@private`                                                                                                 | field             | Stored, never exposed                                                                                                                                                                                                                      |
 | `@readonly`                                                                                                | field             | Exposed, never client-settable; on a relationship, absent from create and update inputs                                                                                                                                                    |
 | `@settable(onCreate:, onUpdate:)`                                                                          | field             | Which mutations may set it, e.g. set once on create; on a relationship, whether the inputs offer it (an upsert of an existing node keeps it); on a relationship property, `onUpdate: false` also refuses a re-connect that would change it |
-| `@selectable(onRead:, onAggregate:)`                                                                       | field             | `onRead: false` makes a field write-only; on a relationship property, it leaves the edge type too (`onAggregate: false`, the edge aggregates)                                                                                              |
+| `@selectable(onRead:, onAggregate:)`                                                                       | field             | `onRead: false` makes a field write-only; on a relationship property, it leaves the edge type too (`onAggregate: false`, the edge aggregates); with every property hidden, the edge has no `properties`                                    |
 | `@default(value:)`                                                                                         | field             | Stored on create when the input omits it; on a relationship property, when the relationship is created                                                                                                                                     |
 | `@timestamp(operations: [CREATE, UPDATE])`                                                                 | field             | Set to the current time; never client-settable. On a relationship property: CREATE when the relationship is created, UPDATE on edge updates and re-connects that set properties                                                            |
 | `@populatedBy(callback:, operations:)`                                                                     | field             | Computed by a named callback on write                                                                                                                                                                                                      |
@@ -634,7 +634,18 @@ type Post
 { eq: true } }` tests the caller's own node: one seek by the claim. Both
   are unknown without the claim, so `NOT { isViewer: true }` never grants a
   signed-out caller. `isViewer` takes `true` only; use `NOT` for the
-  opposite.
+  opposite. It works through relationships and union members
+  (`author: { Person: { isViewer: true } }`); in a filter over an
+  interface it is a model error, since there is no single type to expand
+  against. In rule strings, `"${viewer.key}"` (any scalar field of the
+  viewer type) is the caller's own value: the claim itself for the field
+  `@viewer` maps to, otherwise read with one seek by the claim. Use it
+  for keys built from the caller's key while the claim is an opaque
+  subject: `key: { endsWith: ":${viewer.key}" }`, `key: { eq:
+  "${viewer.key}" }`. It stands for one value, not inside a list.
+- A whole string starting with `$` must be a placeholder (`$jwt.<claim>`,
+  `$context.<path>`): a misspelt one (`"$jtw.sub"`) is a model error, not
+  a literal. Write a literal `$…` as `"\\$…"`.
 - Inside a longer string, write `${jwt.path}` or `${context.path}`:
   `key: { startsWith: "${jwt.sub}:" }` confines a user to keys that begin
   with their `sub` and `:`. The claim must be a string, number or boolean;
@@ -643,7 +654,11 @@ type Post
   [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.
+  index-friendly. A write whose rules the claims alone refuse is refused
+  before any statement runs.
+- A create under CREATE rules answers the same whether a `@unique` value
+  (or the key) is taken by a node the caller may not create: what a free
+  value gets. A create that would succeed answers `CONSTRAINT_VIOLATION`.
 - **A test that needs a claim or context value the request lacks is
   unknown**: false where it stands, and a `NOT` over it is false too, so
   negation can never turn a missing claim into a grant. Node conditions
@@ -690,8 +705,11 @@ type Post
   is checked before any statement runs, so `FORBIDDEN` for `bob:x` reads
   the same whether `bob:x` exists or not. A claim containing the
   separator is refused, so user `a` cannot write into the key space of
-  user `a:b`. It needs `@viewer`; the schema's bypass skips it. Keys shared
-  by two owners (`f1:lou`) stay hand-written rules.
+  user `a:b`. It needs `@viewer`; the schema's bypass skips it. When
+  `@viewer` maps to a non-key field (an opaque subject), the key space is
+  the caller's node's `@key`, looked up once by the claim before anything
+  is written; a token naming no node creates nothing. Keys shared by two
+  owners (`f1:lou`) stay hand-written rules, with `${viewer.key}`.
 - **Masks.** A field-level READ rule fails the row; a mask substitutes a
   value instead:
 
@@ -892,8 +910,12 @@ index the API needs, with the reason for each:
 | `WITHIN_BBOX`, `DISTANCE`              | POINT index                             |
 | `@fulltext`, `@vector`                 | FULLTEXT and VECTOR indexes, by name    |
 
-`assertSchema()` reports what the database lacks;
-`assertSchema({ create: true })` creates it, idempotently.
+`assertSchema()` reports what the database lacks (`missing`), and a
+full-text or vector index present under its name but defined differently
+(labels, fields, analyzer: `mismatched`), since search would keep using the
+old definition. `assertSchema({ create: true })` creates what is missing
+and drops and re-creates what is mismatched (`created`, `recreated`),
+idempotently. `check()` fails on either.
 
 **S2: plans are checked.** Every compiled statement records the access path
 it was written for. `lora.explain(query, variables)` plans each statement and

package/dist/cli.js

@@ -2,8 +2,8 @@
 import { stat as H, readdir as oe, readFile as ie, mkdir as re, writeFile as _ } from "node:fs/promises";
 import { join as D, relative as ce } from "node:path";
 import { parse as q, Kind as p, visit as Q, print as V, typeFromAST as ue, isNonNullType as W, isListType as le, getNamedType as fe, isEnumType as de, isInputObjectType as pe } from "graphql";
-import { d as me } from "./diff-DUOLUgrI.js";
-import { m as Y, d as he, M as ge, L as M, l as Z, f as C, o as K, b as ve, i as we, r as Ee, u as Te } from "./driver-C7a5NkfH.js";
+import { d as me } from "./diff-BO2igqdY.js";
+import { m as Y, d as he, M as ge, L as M, l as Z, f as C, o as K, b as ve, i as we, r as Ee, u as Te } from "./driver-XeJM24iP.js";
 const be = /* @__PURE__ */ new Set(["Query", "Mutation", "Subscription"]), B = {
   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/auth.d.ts

@@ -92,7 +92,12 @@ export declare function maskSettled(ctx: CompileContext, node: NodeType, field:
  * A claim containing the separator is refused: it could reach into
  * another caller's key space (`a` taking `a:b:…` from `a:b`).
  */
-export declare function checkKeyScope(ctx: CompileContext, node: NodeType, key: unknown): void;
+export declare function checkKeyScope(ctx: CompileContext, node: NodeType, key: unknown, 
+/**
+ * The caller's node's `@key`, looked up by the claim when `@viewer` maps
+ * to another field (an opaque subject); null when there is no such node.
+ */
+viewerKey?: unknown): void;
 /**
  * Rules on relationship fields for `op` on relationships of `rel`, with
  * the statement's owner-side, target-side and relationship variables. The

package/dist/compile/context.d.ts

@@ -50,6 +50,15 @@ export declare function newContext(base: SelectionContext, model: GraphModel, op
 /** Record that the compile read the claim at `path` (see `claimReads`). */
 export declare function noteClaim(ctx: CompileContext, path: string, value: unknown, bound: boolean): void;
 /** Bind a value as the next positional parameter `$pN`. */
+/**
+ * A rule value that is an expression, not a parameter: a string with
+ * `${viewer.field}` placeholders, read from the caller's node in the
+ * statement. `bind` returns the expression as is.
+ */
+export declare const EXPR: unique symbol;
+export declare function exprValue(expr: Expr): {
+    [EXPR]: Expr;
+};
 export declare function bind(ctx: CompileContext, value: unknown): Expr;
 /** A variable name derived from `base`, unique within the statement. */
 export declare function freshVar(ctx: CompileContext, base: string): string;

package/dist/{diff-DUOLUgrI.js → diff-BO2igqdY.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-C7a5NkfH.js";
+import { b as $, i as b, r as E, j as N, n as i, k as S } from "./driver-XeJM24iP.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-DUOLUgrI.js.map
+//# sourceMappingURL=diff-BO2igqdY.js.map

package/dist/{diff-DUOLUgrI.js.map → diff-BO2igqdY.js.map}

@@ -1 +1 @@
-{"version":3,"file":"diff-DUOLUgrI.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-BO2igqdY.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;"}