@loradb/lora-graphql 0.16.2

package/dist/testing.js

@@ -0,0 +1,56 @@
+import { graphql as h } from "graphql";
+import { L as w, l as u } from "./driver-C8vA5fV-.js";
+async function L(l) {
+  let s;
+  try {
+    ({ createDatabase: s } = await import("@loradb/lora-node"));
+  } catch {
+    throw new Error(
+      "createTestLoraGraphQL needs @loradb/lora-node: npm install --save-dev @loradb/lora-node"
+    );
+  }
+  const t = await s(), n = [], { seed: a, onStatement: i, ...c } = l, r = new w({
+    ...c,
+    driver: u(t),
+    onStatement: (e) => {
+      n.push(e), i?.(e);
+    }
+  });
+  if (await r.assertSchema({ create: !0 }), typeof a == "function") await a(t);
+  else
+    for (const e of typeof a == "string" ? [a] : a ?? [])
+      await t.execute(e);
+  const o = r.getSchema(), m = (e, p = {}, d = {}) => h({ schema: o, source: e, variableValues: p, contextValue: d });
+  return {
+    lora: r,
+    db: t,
+    schema: o,
+    statements: n,
+    run: m,
+    data: async (e, p, d) => {
+      const f = await m(e, p, d);
+      if (f.errors) throw f.errors[0];
+      return f.data;
+    },
+    close: () => t.dispose?.()
+  };
+}
+async function b(l, s, t = {}, n = {}) {
+  const i = (await l.explain(s, t, n)).flatMap(
+    (c) => c.reports.flatMap(
+      (r) => r.findings.map((o) => `${c.field}: ${o.message}
+  ${o.statement}`)
+    )
+  );
+  if (i.length > 0)
+    throw new Error(
+      `expected every root field to seek:
+${i.join(`
+`)}`
+    );
+}
+export {
+  L as createTestLoraGraphQL,
+  b as expectSeeks
+};
+//# sourceMappingURL=testing.js.map

package/dist/testing.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"testing.js","sources":["../src/testing.ts"],"sourcesContent":["// Test helpers: an in-memory LoraDB with the schema asserted, and a plan\n// assertion. Import from `@loradb/lora-graphql/testing`; needs\n// `@loradb/lora-node`. Framework-agnostic: failures throw plain errors.\n\nimport {\n  graphql,\n  type DocumentNode,\n  type ExecutionResult,\n  type GraphQLSchema,\n} from \"graphql\";\nimport { loraDriver, type LoraDatabaseLike } from \"./driver.js\";\nimport {\n  LoraGraphQL,\n  type LoraGraphQLOptions,\n  type StatementEvent,\n} from \"./lora-graphql.js\";\n\n/** The node binding's database, as far as tests use it. */\nexport type TestDatabase = LoraDatabaseLike & {\n  execute(query: string, params?: never): Promise<unknown>;\n  dispose?(): void;\n};\n\nexport interface TestLoraGraphQLOptions extends Omit<\n  LoraGraphQLOptions,\n  \"driver\"\n> {\n  /** Cypher to run after the schema is asserted, or a function given the database. */\n  seed?: string | string[] | ((db: TestDatabase) => Promise<void>);\n}\n\nexport interface TestLoraGraphQL {\n  lora: LoraGraphQL;\n  db: TestDatabase;\n  schema: GraphQLSchema;\n  /** Every statement run so far (clear with `statements.length = 0`). */\n  statements: StatementEvent[];\n  /** Execute a document; errors stay in the result. */\n  run: (\n    source: string,\n    variables?: Record<string, unknown>,\n    context?: Record<string, unknown>,\n  ) => Promise<ExecutionResult>;\n  /** Execute a document and return its data; throws on the first error. */\n  data: <T = Record<string, unknown>>(\n    source: string,\n    variables?: Record<string, unknown>,\n    context?: Record<string, unknown>,\n  ) => Promise<T>;\n  /** Release the database. */\n  close: () => void;\n}\n\n/** A LoraGraphQL over a fresh in-memory database, schema asserted and seeded. */\nexport async function createTestLoraGraphQL(\n  options: TestLoraGraphQLOptions,\n): Promise<TestLoraGraphQL> {\n  let createDatabase: () => Promise<TestDatabase>;\n  try {\n    ({ createDatabase } = (await import(\"@loradb/lora-node\")) as unknown as {\n      createDatabase: typeof createDatabase;\n    });\n  } catch {\n    throw new Error(\n      \"createTestLoraGraphQL needs @loradb/lora-node: npm install --save-dev @loradb/lora-node\",\n    );\n  }\n  const db = await createDatabase();\n  const statements: StatementEvent[] = [];\n  const { seed, onStatement, ...rest } = options;\n  const lora = new LoraGraphQL({\n    ...rest,\n    driver: loraDriver(db),\n    onStatement: (event) => {\n      statements.push(event);\n      onStatement?.(event);\n    },\n  });\n  await lora.assertSchema({ create: true });\n  if (typeof seed === \"function\") await seed(db);\n  else {\n    for (const text of typeof seed === \"string\" ? [seed] : (seed ?? [])) {\n      await db.execute(text);\n    }\n  }\n  const schema = lora.getSchema();\n  const run = (\n    source: string,\n    variables: Record<string, unknown> = {},\n    contextValue: Record<string, unknown> = {},\n  ) => graphql({ schema, source, variableValues: variables, contextValue });\n  return {\n    lora,\n    db,\n    schema,\n    statements,\n    run,\n    data: async <T>(\n      source: string,\n      variables?: Record<string, unknown>,\n      context?: Record<string, unknown>,\n    ) => {\n      const r = await run(source, variables, context);\n      if (r.errors) throw r.errors[0];\n      return r.data as T;\n    },\n    close: () => db.dispose?.(),\n  };\n}\n\n/**\n * Assert that every statement of a query's root fields uses the index\n * access it was compiled for (no label scans where a seek was expected,\n * no mutating plans, no row-budget excess). Throws listing each finding.\n */\nexport async function expectSeeks(\n  lora: LoraGraphQL,\n  document: string | DocumentNode,\n  variables: Record<string, unknown> = {},\n  options: { rowBudget?: number; context?: unknown } = {},\n): Promise<void> {\n  const fields = await lora.explain(document, variables, options);\n  const findings = fields.flatMap((f) =>\n    f.reports.flatMap((r) =>\n      r.findings.map((x) => `${f.field}: ${x.message}\\n  ${x.statement}`),\n    ),\n  );\n  if (findings.length > 0) {\n    throw new Error(\n      `expected every root field to seek:\\n${findings.join(\"\\n\")}`,\n    );\n  }\n}\n"],"names":["createTestLoraGraphQL","options","createDatabase","db","statements","seed","onStatement","rest","lora","LoraGraphQL","loraDriver","event","text","schema","run","source","variables","contextValue","graphql","context","r","expectSeeks","document","findings","f","x"],"mappings":";;AAsDA,eAAsBA,EACpBC,GAC0B;AAC1B,MAAIC;AACJ,MAAI;AACF,KAAC,EAAE,gBAAAA,EAAA,IAAoB,MAAM,OAAO,mBAAmB;AAAA,EAGzD,QAAQ;AACN,UAAM,IAAI;AAAA,MACR;AAAA,IAAA;AAAA,EAEJ;AACA,QAAMC,IAAK,MAAMD,EAAA,GACXE,IAA+B,CAAA,GAC/B,EAAE,MAAAC,GAAM,aAAAC,GAAa,GAAGC,MAASN,GACjCO,IAAO,IAAIC,EAAY;AAAA,IAC3B,GAAGF;AAAA,IACH,QAAQG,EAAWP,CAAE;AAAA,IACrB,aAAa,CAACQ,MAAU;AACtB,MAAAP,EAAW,KAAKO,CAAK,GACrBL,IAAcK,CAAK;AAAA,IACrB;AAAA,EAAA,CACD;AAED,MADA,MAAMH,EAAK,aAAa,EAAE,QAAQ,IAAM,GACpC,OAAOH,KAAS,WAAY,OAAMA,EAAKF,CAAE;AAAA;AAE3C,eAAWS,KAAQ,OAAOP,KAAS,WAAW,CAACA,CAAI,IAAKA,KAAQ;AAC9D,YAAMF,EAAG,QAAQS,CAAI;AAGzB,QAAMC,IAASL,EAAK,UAAA,GACdM,IAAM,CACVC,GACAC,IAAqC,CAAA,GACrCC,IAAwC,CAAA,MACrCC,EAAQ,EAAE,QAAAL,GAAQ,QAAAE,GAAQ,gBAAgBC,GAAW,cAAAC,GAAc;AACxE,SAAO;AAAA,IACL,MAAAT;AAAA,IACA,IAAAL;AAAA,IACA,QAAAU;AAAA,IACA,YAAAT;AAAA,IACA,KAAAU;AAAA,IACA,MAAM,OACJC,GACAC,GACAG,MACG;AACH,YAAMC,IAAI,MAAMN,EAAIC,GAAQC,GAAWG,CAAO;AAC9C,UAAIC,EAAE,OAAQ,OAAMA,EAAE,OAAO,CAAC;AAC9B,aAAOA,EAAE;AAAA,IACX;AAAA,IACA,OAAO,MAAMjB,EAAG,UAAA;AAAA,EAAU;AAE9B;AAOA,eAAsBkB,EACpBb,GACAc,GACAN,IAAqC,CAAA,GACrCf,IAAqD,IACtC;AAEf,QAAMsB,KADS,MAAMf,EAAK,QAAQc,GAAUN,GAAWf,CAAO,GACtC;AAAA,IAAQ,CAACuB,MAC/BA,EAAE,QAAQ;AAAA,MAAQ,CAAC,MACjB,EAAE,SAAS,IAAI,CAACC,MAAM,GAAGD,EAAE,KAAK,KAAKC,EAAE,OAAO;AAAA,IAAOA,EAAE,SAAS,EAAE;AAAA,IAAA;AAAA,EACpE;AAEF,MAAIF,EAAS,SAAS;AACpB,UAAM,IAAI;AAAA,MACR;AAAA,EAAuCA,EAAS,KAAK;AAAA,CAAI,CAAC;AAAA,IAAA;AAGhE;"}

package/package.json

@@ -0,0 +1,85 @@
+{
+  "name": "@loradb/lora-graphql",
+  "version": "0.16.2",
+  "description": "Schema-first GraphQL for LoraDB: one annotated SDL becomes an executable, index-aware GraphQL API that compiles every operation to a single Cypher statement.",
+  "license": "BUSL-1.1",
+  "packageManager": "yarn@4.5.1",
+  "author": "LoraDB, Inc.",
+  "homepage": "https://github.com/lora-db/lora/tree/main/packages/lora-graphql#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/lora-db/lora.git",
+    "directory": "packages/lora-graphql"
+  },
+  "bugs": {
+    "url": "https://github.com/lora-db/lora/issues"
+  },
+  "keywords": [
+    "lora",
+    "loradb",
+    "graphql",
+    "cypher",
+    "graph",
+    "database"
+  ],
+  "type": "module",
+  "main": "dist/index.js",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    },
+    "./testing": {
+      "types": "./dist/testing.d.ts",
+      "import": "./dist/testing.js",
+      "default": "./dist/testing.js"
+    }
+  },
+  "bin": "./dist/cli.js",
+  "files": [
+    "dist/",
+    "README.md",
+    "LICENSE"
+  ],
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "engines": {
+    "node": ">=20"
+  },
+  "scripts": {
+    "build": "vite build",
+    "typecheck": "tsc -p tsconfig.json --noEmit",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "lint": "eslint src test bench",
+    "lint:fix": "eslint src test bench --fix",
+    "format": "prettier --write src test",
+    "format:check": "prettier --check src test",
+    "bench": "vitest bench --run"
+  },
+  "peerDependencies": {
+    "@loradb/lora-node": "^0.16.2",
+    "graphql": "^16.8.0 || ^17.0.0"
+  },
+  "devDependencies": {
+    "@loradb/lora-node": "workspace:*",
+    "@types/node": "^22.0.0",
+    "eslint": "^9.15.0",
+    "fast-check": "^4.10.2",
+    "graphql": "^16.9.0",
+    "typescript": "^5.6.0",
+    "vite": "^5.4.0",
+    "vite-plugin-dts": "^4.2.0",
+    "vitest": "^2.1.0"
+  },
+  "peerDependenciesMeta": {
+    "@loradb/lora-node": {
+      "optional": true
+    }
+  }
+}