@loradb/lora-graphql 0.23.0 → 0.24.1

package/dist/compile/read.d.ts

@@ -1,102 +0,0 @@
-import { FieldNode, SelectionSetNode } from 'graphql';
-import { QueryResult, Statement } from '../driver.js';
-import { AbstractType, CypherField, NodeType, SearchIndex, PageLimit } from '../model/types.js';
-import { CompileContext } from './context.js';
-import { Clause, Expr } from './cypher.js';
-export type RootKind = "list" | "single" | "connection" | "aggregate" | "grouped";
-/** How the plan of a statement is expected to find its first rows (S2). */
-export interface SeekExpectation {
-    statement: number;
-    label: string;
-    access: "exact" | "range" | "text" | "point";
-    reason: string;
-}
-export interface ReadSet {
-    labels: string[];
-    relationships: string[];
-    /**
-     * A `@cypher` statement (or a mutation) is part of the read: it may
-     * read anything, so every change affects it.
-     */
-    opaque?: boolean;
-}
-export interface CompiledRead {
-    statements: Statement[];
-    /** Turns the statements' results into the root field's value. */
-    shape: (results: QueryResult[]) => unknown;
-    /** Result columns the first statement must produce. */
-    columns: string[];
-    reads: ReadSet;
-    expectations: SeekExpectation[];
-    /** Estimated rows touched: the bound the cost limit checks. */
-    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. */
-export interface RawConnection {
-    __rows: RawEdge[];
-    __first: number;
-    /** A cursor (`after` or `before`) was given. */
-    __after: boolean;
-    /** `last` / `before`: rows arrive in reverse and are flipped back. */
-    __backward: boolean;
-    __sort: string;
-    __totalCount?: number;
-}
-export interface RawEdge {
-    node: unknown;
-    properties?: unknown;
-    __cursor: unknown[];
-}
-export declare function compileRoot(ctx: CompileContext, kind: RootKind, node: NodeType, args: Args, fieldNodes: readonly FieldNode[]): CompiledRead;
-export declare function finish(ctx: CompileContext, clauses: Clause[], columns: string[], shape: CompiledRead["shape"], expectation: Omit<SeekExpectation, "statement"> | undefined, extra?: Statement[], mode?: "read" | "write"): CompiledRead;
-export declare function readSet(ctx: CompileContext): ReadSet;
-/**
- * A root `@cypher` field on Query or Mutation: the statement runs in a
- * `CALL { }`, and returned nodes are projected like any other read.
- */
-export declare function compileCypherRoot(ctx: CompileContext, field: CypherField, args: Args, fieldNodes: readonly FieldNode[]): CompiledRead;
-/** `events(where, sort, limit)` over an interface's implementations or a union's members. */
-export declare function compileAbstractRoot(ctx: CompileContext, abstract: AbstractType, args: Args, fieldNodes: readonly FieldNode[]): CompiledRead;
-/** A search root field's value: nodes with their scores. */
-export interface SearchResult {
-    node: unknown;
-    score: number;
-}
-/**
- * A search as a connection (`connection: true`): pages forward by keyset
- * on (score DESC, key ASC). A vector index returns its top candidates
- * before any filter, so vector connections page within a fixed pool of
- * `4 × @limit(max:)` candidates.
- */
-export declare function compileSearch(ctx: CompileContext, node: NodeType, index: SearchIndex, args: Args, fieldNodes: readonly FieldNode[], connection?: boolean): CompiledRead;
-/**
- * Nodes by @key, in one statement, for mutation payloads: the read runs
- * inside the mutation's transaction and sees its writes.
- */
-export declare function compileByKeys(ctx: CompileContext, node: NodeType, keys: unknown[], sets: SelectionSetNode[]): CompiledRead;
-export declare function keyOf(value: unknown): string;
-/** The statement text with its parameters renamed to bound `$pN`s. */
-export declare function bindStatement(ctx: CompileContext, field: CypherField, args: Args): string;
-/** Default `maxListArgument`: the most items a @cypher list argument takes. */
-export declare const MAX_LIST_ARGUMENT = 1000;
-export declare function resolveLimit(value: unknown, limit: PageLimit, argument: string): number;
-export interface Projection {
-    /** Subqueries that must run before the projection is evaluated. */
-    pre: Clause[];
-    expr: Expr;
-}
-/**
- * Project `variable` (a `node`) with the selection sets. `rows` is how
- * many parents this projection runs for, for the cost estimate.
- */
-export declare function projectNode(ctx: CompileContext, node: NodeType, variable: string, sets: SelectionSetNode[], rows: number): Projection;
-export {};

package/dist/diff-B9iDdELF.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"diff-B9iDdELF.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    previousValue: () => null,\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,eAAe,MAAM;AAAA,IACrB,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;"}