@loradb/lora-graphql 0.23.0 → 0.24.0

package/dist/lora-graphql.d.ts

@@ -1,331 +1,17 @@
-import { ExecutionArgs, DocumentNode, ExecutionResult, GraphQLSchema, GraphQLFieldResolver, GraphQLScalarType, ValidationRule } from 'graphql';
-import { CypherFinding } from './analyze/cypher-check.js';
+import { ExecutionArgs, DocumentNode, ExecutionResult, GraphQLSchema, ValidationRule } from 'graphql';
 import { SchemaRequirement } from './analyze/indexes.js';
 import { PlanReport } from './analyze/plans.js';
-import { AccessEntry, OperationAccess } from './analyze/access.js';
+import { OperationAccess } from './analyze/access.js';
+import { AccessEntry } from './analyze/verdicts.js';
 import { Statistics } from './analyze/statistics.js';
-import { CompiledRead, ReadSet } from './compile/read.js';
-import { LoraDriver, Statement } from './driver.js';
+import { CompiledRead, ReadSet } from './compile/read/types.js';
 import { WriteChange } from './execute/changes.js';
 import { LoraTransaction } from './execute/transaction.js';
-import { PopulatedByCallback } from './execute/mutate.js';
 import { OperationManifest } from './codegen.js';
-import { envelopPlugin, DocumentGuards } from './guards.js';
-import { ModelOptions } from './model/build.js';
-import { ObservabilityOptions } from './observe.js';
-import { GraphModel, ModelWarning } from './model/types.js';
-export interface LoraGraphQLOptions extends ModelOptions, ObservabilityOptions {
-    /** Annotated SDL: the graph model and the API in one document. */
-    typeDefs: string | DocumentNode;
-    driver: LoraDriver;
-    /** Timeout for every statement, in milliseconds. Default 10 000; 0 disables. */
-    timeoutMs?: number;
-    /**
-     * Time budget for all root fields of one query, in milliseconds: past
-     * it, the operation's statements are aborted and its unfinished fields
-     * fail with TIMEOUT. Default twice `timeoutMs` (20 000); 0 disables.
-     * Subscriptions are not bounded by it; mutations keep `timeoutMs` per
-     * statement.
-     */
-    operationTimeoutMs?: number;
-    /**
-     * Statements one operation runs at once: aliased root fields queue for
-     * a slot instead of taking every libuv worker, so one request cannot
-     * starve the others. Default 2.
-     */
-    maxConcurrentStatements?: number;
-    /**
-     * Approximate bytes the compile cache may hold, and again the parsed
-     * document cache: entries are evicted oldest first past it, besides the
-     * entry caps. Requests with more than 16 KiB of variables a field uses
-     * (long `in:` lists, embedding vectors) are compiled but not cached.
-     * Default 64 MiB.
-     */
-    compileCacheBytes?: number;
-    /**
-     * Reject a root field whose estimated rows touched exceed this, before
-     * it runs. The estimate multiplies page sizes through nested lists,
-     * capped by relationship degrees from `analyze()` or `@cardinality`,
-     * and charges each filter the rows it examines: a label scan when no
-     * index answers it, the related nodes of every relationship it follows.
-     * Default 50 000; `Infinity` disables.
-     */
-    maxCost?: number;
-    /**
-     * The cost limit for one request, from its context (for example by
-     * user or plan). Undefined falls back to `maxCost`.
-     */
-    budget?: (context: unknown) => number | undefined;
-    /** Called with every root field's cost estimate, before it runs. */
-    onCost?: (event: CostEvent) => void;
-    /**
-     * The request's verified claims, from the GraphQL context. Default:
-     * `context.jwt`. The library never verifies tokens: do that in the
-     * server and put the claims in the context.
-     */
-    jwt?: (context: unknown) => Record<string, unknown> | undefined;
-    /**
-     * Most nodes one mutation may create, update or delete, nested ones
-     * included (and ten times as many relationships written). Default 1000: larger imports belong in a Cypher load, not a GraphQL
-     * request. Also the default `limit` of bulk updates and deletes.
-     */
-    maxBatch?: number;
-    /**
-     * Most items a list argument of a `@cypher` field takes, unless its
-     * `@size(max:)` says otherwise. More is BAD_USER_INPUT before the
-     * statement runs. Default 1000.
-     */
-    maxListArgument?: number;
-    /**
-     * Relationship levels one `where` may nest: quantifiers (`some`,
-     * `none`, `all`, `single`, `count`, `aggregate`), connection filters,
-     * `<field>Exists` and filters through a single relationship each count
-     * one. Deeper is BAD_USER_INPUT before anything runs: each level
-     * multiplies the work by the relationship's degree. Default 2.
-     */
-    maxFilterDepth?: number;
-    /**
-     * Items an `in` filter operand may hold. More is BAD_USER_INPUT before
-     * anything runs. Default 1000.
-     */
-    maxListFilter?: number;
-    /**
-     * Characters a string filter operand (`eq`, `contains`, an `in` item, …)
-     * may hold. More is BAD_USER_INPUT before anything runs. Default 10 000.
-     */
-    maxStringFilter?: number;
-    /**
-     * Changes a `changes()` consumer or subscriber may fall behind before it
-     * is ended with an error. Default 1000.
-     */
-    maxQueuedChanges?: number;
-    /**
-     * Live subscriptions one scope (see `subscriptionScope`) may hold; one
-     * more is LIMIT_EXCEEDED. Default 100.
-     */
-    maxSubscriptions?: number;
-    /**
-     * What `maxSubscriptions` counts per: by default the context object, so
-     * a server that reuses one context per connection (graphql-ws) limits
-     * each connection. Return the connection (or user) otherwise.
-     */
-    subscriptionScope?: (context: unknown) => object | undefined;
-    /**
-     * How deep relationship filters may nest in a subscription's `where`,
-     * which runs on every change. Deeper is LIMIT_EXCEEDED. Default 1.
-     */
-    maxSubscriptionFilterDepth?: number;
-    /**
-     * Per statement a subscription runs to check a change (visibility,
-     * `where`, related nodes). Default 2000, or `timeoutMs` when lower.
-     */
-    subscriptionTimeoutMs?: number;
-    /** Named callbacks for `@populatedBy(callback:)`. */
-    callbacks?: Record<string, PopulatedByCallback>;
-    /**
-     * Implementations of custom scalars declared with `@storedAs`, e.g. one
-     * that validates e-mail addresses. Without one a scalar passes through.
-     */
-    scalars?: Record<string, GraphQLScalarType>;
-    /**
-     * Feed subscriptions and `changes()` from the engine's committed change
-     * feed (lora-node `db.changes()`): every write to the database, from
-     * any path in the process that owns it, in commit order. `onWrite`
-     * still reports this instance's mutations, and `previousState` needs
-     * them. Default false.
-     */
-    changeFeed?: boolean;
-    /**
-     * Resolvers of `@customResolver` fields, by type and field name. The
-     * source holds the node's selected fields plus the field's `requires`.
-     */
-    resolvers?: Record<string, Record<string, GraphQLFieldResolver<Record<string, unknown>, unknown>>>;
-    /** Called with every statement before it runs; for logging and tests. */
-    onStatement?: (event: StatementEvent) => void;
-    /**
-     * Hide database error details from clients: they get
-     * `extensions.code` `DATABASE_ERROR` and an `id`, and `onError` gets the
-     * engine's message. Default: on when `NODE_ENV` is `production`.
-     */
-    maskErrors?: boolean;
-    /** Called with every database error, masked or not. */
-    onError?: (event: DatabaseErrorEvent) => void;
-    /**
-     * Limits on the documents `execute()`, `subscribe()` and `persist()`
-     * accept: depth,
-     * aliases, root fields, tokens, introspection. `false` turns them off.
-     * For other servers use `validationRules()` or `envelopPlugin()`.
-     */
-    guards?: DocumentGuards | false;
-    /**
-     * Make `execute()` and `subscribe()` refuse `source` and run only
-     * persisted operations by `id`. Default false.
-     */
-    persistedOnly?: boolean;
-    /**
-     * How `execute()` commits a mutation with several root fields.
-     * `"field"` (the default): each root field in its own transaction, so a
-     * later failure leaves the earlier ones committed. `"operation"`: every
-     * root field in one transaction, committed only when the operation
-     * reports no error, rolled back (with `data: null`) otherwise. A
-     * `transaction` in the context takes precedence. Envelop / Yoga servers
-     * on `getSchema()` get the same with `lora.envelopPlugin()`; other
-     * servers calling graphql-js directly put a `lora.begin()` transaction
-     * in the context (without one, a one-time warning says each root field
-     * committed on its own).
-     */
-    mutationTransaction?: "field" | "operation";
-    /**
-     * Add `extensions.timing` to `execute()` results: the request's total
-     * time, the time spent in LoraDB, and both per root field, in
-     * milliseconds. `true` for every request, or a function deciding per
-     * request from the GraphQL context (for example only for admins or in
-     * development). Default off: timings sent to clients can act as a
-     * timing side channel.
-     */
-    timing?: boolean | ((context: unknown) => boolean);
-}
-/** `extensions.timing` of an `execute()` result (see the `timing` option). */
-export interface ExecutionTiming {
-    /** The whole `execute()` call: parse, validation, execution. */
-    totalMs: number;
-    /** Time spent running statements in LoraDB. */
-    databaseMs: number;
-    /** Per root field, by response key (alias or name). */
-    fields: Record<string, {
-        totalMs: number;
-        databaseMs: number;
-    }>;
-}
-export interface CostEvent {
-    field: string;
-    /** Estimated rows this root field touches. */
-    cost: number;
-    /** Estimated rows of the operation so far, this field included. */
-    total: number;
-    /** The limit that applies: `budget(context)` or `maxCost`. */
-    limit: number;
-    context: unknown;
-}
-export interface DatabaseErrorEvent {
-    /** Correlation id, also in the client error's `extensions.id`. */
-    id: string;
-    /**
-     * The root field that failed, or `changeFeed` for a failure of the
-     * change feed (it reopens from where it stopped after a backoff).
-     */
-    field: string;
-    /** The engine's message, which may name labels, properties and Cypher. */
-    message: string;
-    /** The error as thrown by the driver. */
-    error: unknown;
-}
-export interface StatementEvent {
-    field: string;
-    statement: Statement;
-}
-/** Per-request options read from the GraphQL context, when present. */
-export interface LoraGraphQLContext {
-    /** Verified claims; enables @authentication and @authorization. */
-    jwt?: Record<string, unknown>;
-    /** Cancels the request's statements when aborted. */
-    signal?: AbortSignal;
-    /**
-     * Run in this transaction (from `lora.begin()`) instead of one per
-     * field: the caller commits, together with its own Cypher.
-     */
-    transaction?: LoraTransaction;
-}
-export interface AssertSchemaOptions {
-    /** Create what is missing instead of only reporting it. */
-    create?: boolean;
-}
-export interface SchemaAssertion {
-    required: SchemaRequirement[];
-    missing: SchemaRequirement[];
-    created: SchemaRequirement[];
-    /**
-     * Full-text and vector indexes present under their name but defined
-     * differently (labels, properties, kind): search would keep using the
-     * old definition. Without `create`; with it they are re-created.
-     */
-    mismatched: SchemaRequirement[];
-    /** Indexes `create` dropped and created again with the model's definition. */
-    recreated: SchemaRequirement[];
-}
-export interface CheckOptions {
-    /**
-     * Flag statements whose largest engine row estimate (from graph
-     * statistics) exceeds this. Off by default: estimates ignore a LIMIT
-     * that stops an index-ordered scan early.
-     */
-    rowBudget?: number;
-    /**
-     * Operations to compile and plan-check (S2), with example variables and
-     * the GraphQL context to compile them under (e.g. `{ jwt }`, so rules
-     * compile as they do for a signed-in caller). Without one, an operation
-     * compiles as an anonymous request would.
-     */
-    operations?: Array<{
-        name?: string;
-        document: string | DocumentNode;
-        variables?: Record<string, unknown>;
-        context?: unknown;
-    }>;
-}
-export interface CheckReport {
-    /** True when nothing below is a failure. */
-    ok: boolean;
-    /** Model warnings, e.g. an unused @cypher argument. */
-    warnings: readonly ModelWarning[];
-    /** @cypher statements the engine rejects or that write from a query. */
-    cypher: CypherFinding[];
-    /** Constraints and indexes the database lacks. */
-    missing: SchemaRequirement[];
-    /** Indexes the database has that no part of the API needs. */
-    unused: Array<{
-        name: string;
-        type: string;
-        labels: string[];
-        properties: string[];
-    }>;
-    /** Schema lint: valid but costly or risky choices (not failures). */
-    lint: readonly ModelWarning[];
-    /**
-     * `@mutation` types with writes no rule guards (failures): declare them
-     * with `@authorization(public: [...])` when that is intended.
-     */
-    security: readonly ModelWarning[];
-    /** Plan findings per operation and root field. */
-    plans: Array<{
-        operation: string;
-        field: string;
-        reports: PlanReport[];
-    }>;
-    /** Operations that failed to compile. */
-    errors: Array<{
-        operation: string;
-        message: string;
-    }>;
-}
-export interface ExecuteArgs {
-    /** The document, or `id` of a persisted operation. */
-    source?: string;
-    id?: string;
-    variables?: Record<string, unknown>;
-    operationName?: string;
-    context?: unknown;
-    /**
-     * Attach the operation's read-set to the result as a non-enumerable
-     * `readSet` property (never serialized to the client), for a response
-     * cache to invalidate with `lora.affects(result.readSet, change)`.
-     */
-    readSet?: boolean;
-}
-/** `execute()`'s result; `readSet` is there when `ExecuteArgs.readSet` asked. */
-export type LoraExecutionResult = ExecutionResult & {
-    readonly readSet?: ReadSet;
-};
+import { envelopPlugin } from './guards.js';
+import { GraphModel } from './model/types.js';
+import { AssertSchemaOptions, CheckOptions, ExecuteArgs, LoraGraphQLOptions } from './options.js';
+import { CheckReport, LoraExecutionResult, SchemaAssertion } from './results.js';
 export declare class LoraGraphQL {
     #private;
     readonly model: GraphModel;
@@ -374,10 +60,6 @@ export declare class LoraGraphQL {
     /** Use statistics gathered earlier, e.g. by the CLI. */
     useStatistics(stats: Statistics): void;
     get statistics(): Statistics | undefined;
-    /**
-     * The CI gate: @cypher statements plan, the database has what the API
-     * needs, and each operation's statements seek where they should.
-     */
     /**
      * Who may do what: for every type and guarded field, each operation as
      * each kind of caller (anonymous, authenticated, and each role the rules
@@ -393,6 +75,10 @@ export declare class LoraGraphQL {
      * several operations.
      */
     operationAccess(document: string | DocumentNode, operationName?: string): OperationAccess;
+    /**
+     * The CI gate: @cypher statements plan, the database has what the API
+     * needs, and each operation's statements seek where they should.
+     */
     check(options?: CheckOptions): Promise<CheckReport>;
     /**
      * Compile a query without running it: one entry per root field, with its

package/dist/model/build/authorization.d.ts

@@ -0,0 +1,31 @@
+import { AuthOperation, Authorization, RelationshipField } from '../types.js';
+export declare function authOps(args: Record<string, unknown> | undefined): Set<AuthOperation> | undefined;
+/**
+ * Field-level rules on a relationship or @cypher field: READ validate rules
+ * only, checked for each row that reads (or filters on) the field.
+ */
+export declare function readOnlyRules(args: Record<string, unknown> | undefined, at: (message: string) => void, relationship?: boolean): Authorization | undefined;
+/**
+ * `@authorization` on a Query or Mutation @cypher field: validate rules
+ * guarding the call, tested before the statement runs. There is no node,
+ * so they test claims (`jwt`) and the caller's node (`viewer`); their
+ * `operations` and `when` do not matter.
+ */
+export declare function rootFieldRules(args: Record<string, unknown> | undefined, at: (message: string) => void): Authorization | undefined;
+export declare function readAuthorization(args: Record<string, unknown> | undefined): Authorization | undefined;
+export declare const PROPERTY_OPS: Set<AuthOperation>;
+/** Keys of a rule that are not claim tests: `node`, `viewer`, … */
+/**
+ * Whether a request without a token could pass the rule: some branch
+ * reads no claim. A claim read without a token denies its branch (and
+ * the whole rule under NOT), so those branches never pass.
+ */
+export declare function passableWithoutClaims(where: unknown): boolean;
+export declare function claimsOnlyViolations(where: unknown, path?: string): string[];
+/** The relationship operations a field's rules cover. */
+export declare function relationshipRuleOperations(f: RelationshipField): Set<AuthOperation>;
+/** A rule over a relationship's source, target and edge. */
+export declare const isRelationshipRule: (rule: {
+    operations: ReadonlySet<AuthOperation>;
+}) => boolean;
+export declare const isRecord: (x: unknown) => x is Record<string, unknown>;

package/dist/model/build/cypher-field.d.ts

@@ -0,0 +1,11 @@
+import { GraphQLDirective, GraphQLField, GraphQLSchema } from 'graphql';
+import { ModelProblem } from '../../errors.js';
+import { CypherField, ModelWarning } from '../types.js';
+export declare function buildCypherField(owner: string, f: GraphQLField<unknown, unknown>, d: (n: string) => GraphQLDirective, problems: ModelProblem[], warnings: ModelWarning[], ctx: {
+    nodeNames: Set<string>;
+    plainNames: Set<string>;
+    schema: GraphQLSchema;
+    root: "Query" | "Mutation" | undefined;
+    /** Whether the @jwt type has a @viewer claim (enables `$viewer`). */
+    viewer: boolean;
+}): CypherField | undefined;

package/dist/model/build/directive-args.d.ts

@@ -0,0 +1,16 @@
+import { ConstDirectiveNode, GraphQLDirective } from 'graphql';
+export declare function directive(def: GraphQLDirective, node: {
+    astNode?: unknown;
+    extensionASTNodes?: unknown;
+}, at: (message: string) => void): Record<string, unknown> | undefined;
+/**
+ * Every use of the directive `name` on `node`: its definition's, then each
+ * extension's, with where it was written (for messages).
+ */
+export declare function directiveNodes(name: string, node: {
+    astNode?: unknown;
+    extensionASTNodes?: unknown;
+}): Array<{
+    node: ConstDirectiveNode;
+    place: string;
+}>;

package/dist/model/build/limits.d.ts

@@ -0,0 +1,18 @@
+import { ModelProblem } from '../../errors.js';
+import { PageLimit } from '../types.js';
+export interface ModelOptions {
+    /** Page size used when a list or connection gets no `limit` / `first`. */
+    defaultLimit?: number;
+    /** Hard cap on any page size; `@limit(max:)` may only lower it. */
+    maxLimit?: number;
+    /**
+     * Sign cursors with HMAC-SHA-256 under this secret, and reject cursors
+     * whose signature does not match. Without it cursors are only tagged
+     * with their sort. Changing the secret invalidates every cursor.
+     */
+    cursorSecret?: string;
+}
+export declare const DEFAULT_LIMIT = 25;
+export declare const MAX_LIMIT = 100;
+export declare function resolveGlobalLimit(options: ModelOptions): PageLimit;
+export declare function resolveLimit(args: Record<string, unknown> | undefined, global: PageLimit, type: string, field: string | undefined, problems: ModelProblem[]): PageLimit;

package/dist/model/build/relationship-field.d.ts

@@ -0,0 +1,11 @@
+import { GraphQLDirective, GraphQLField, GraphQLObjectType } from 'graphql';
+import { ModelProblem } from '../../errors.js';
+import { DeclaredRelationship, NodeType, PageLimit, RelationshipField } from '../types.js';
+/**
+ * An interface field under `@declareRelationship`: every implementation
+ * must declare a relationship field of that name with the same target and
+ * shape (the relationship type and direction may differ). Returns the
+ * problem when one does not.
+ */
+export declare function declareRelationship(iface: string, f: GraphQLField<unknown, unknown>, members: readonly string[], nodes: ReadonlyMap<string, NodeType>): DeclaredRelationship | string;
+export declare function buildRelationshipField(t: GraphQLObjectType, f: GraphQLField<unknown, unknown>, d: (n: string) => GraphQLDirective, problems: ModelProblem[], propsNames: Set<string>, globalLimit: PageLimit): RelationshipField | undefined;

package/dist/model/build/rule-checks.d.ts

@@ -0,0 +1,23 @@
+import { ModelProblem } from '../../errors.js';
+import { AbstractType, NodeType, RelationshipPropertiesType } from '../types.js';
+/** Check an `@authorization` where against the model, at startup. */
+export declare function checkAuthorizationWhere(nodes: ReadonlyMap<string, NodeType>, props: ReadonlyMap<string, RelationshipPropertiesType>, node: NodeType, where: unknown, problems: ModelProblem[], jwtShape?: ReadonlyMap<string, string>, viewerNode?: NodeType): void;
+/**
+ * Check a rule's where. Without `node` (a relationship property's rules)
+ * only claims may be tested: a @relationshipProperties type can sit under
+ * several relationship fields, from either end, so `node` would be
+ * ambiguous.
+ */
+/** The ends a relationship field's rule tests, for its checks. */
+export interface RuleEnds {
+    source: NodeType;
+    target: NodeType;
+    edge: RelationshipPropertiesType | undefined;
+}
+export declare function checkRuleWhere(nodes: ReadonlyMap<string, NodeType>, props: ReadonlyMap<string, RelationshipPropertiesType>, node: NodeType | undefined, type: string, field: string | undefined, where: unknown, problems: ModelProblem[], jwtShape?: ReadonlyMap<string, string>, viewerNode?: NodeType, ends?: RuleEnds, nodeless?: string): void;
+export declare function checkNodeWhere(nodes: ReadonlyMap<string, NodeType>, props: ReadonlyMap<string, RelationshipPropertiesType>, node: NodeType, where: unknown, path: string, at: (message: string) => void): void;
+/**
+ * Interfaces and unions of a model being built, by its node map: the rule
+ * checks below receive the node map only.
+ */
+export declare const abstractsOf: WeakMap<ReadonlyMap<string, NodeType>, ReadonlyMap<string, AbstractType>>;

package/dist/model/build/rule-references.d.ts

@@ -0,0 +1,28 @@
+import { NodeType, RelationshipPropertiesType } from '../types.js';
+/**
+ * Claim names referenced anywhere in a value: as "$jwt.name…" strings and
+ * as ${jwt.name…} placeholders.
+ */
+export declare function claimRefs(value: unknown): string[];
+/**
+ * Malformed claim and context references in a rule's strings: a whole
+ * string "$jwt.path" names a path and nothing else; any `${` starts a
+ * `${jwt.path}` or `${context.path}` placeholder.
+ */
+/** `${viewer.field}` placeholders need @viewer, a scalar field, a string operand. */
+export declare function viewerRefProblems(value: unknown, viewerNode: NodeType | undefined, inList?: boolean): string[];
+/** What a rule's `${node.…}`, `${source.…}`, `${target.…}`, `${edge.…}` may read. */
+export interface RuleReferences {
+    node?: NodeType;
+    source?: NodeType;
+    target?: NodeType;
+    edge?: RelationshipPropertiesType | undefined;
+}
+/**
+ * `${node.path}`-style placeholders: the source must be available where
+ * the string stands (`node` in a type's rules, `source` / `target` /
+ * `edge` in a relationship field's), the path must reach a scalar through
+ * single relationships to node types, and it stands for one value.
+ */
+export declare function ruleReferenceProblems(value: unknown, refs: RuleReferences, nodes: ReadonlyMap<string, NodeType>, inList?: boolean): string[];
+export declare function ruleStringProblems(value: unknown): string[];

package/dist/model/build/scalar-field.d.ts

@@ -0,0 +1,7 @@
+import { GraphQLDirective, GraphQLField, GraphQLObjectType } from 'graphql';
+import { ModelProblem } from '../../errors.js';
+import { ScalarField, ScalarType } from '../types.js';
+export declare function buildScalarField(t: GraphQLObjectType, f: GraphQLField<unknown, unknown>, d: (n: string) => GraphQLDirective, problems: ModelProblem[], opts: {
+    allowKey: boolean;
+}): ScalarField | undefined;
+export declare function defaultMatches(type: ScalarType, list: boolean, value: unknown): boolean;

package/dist/model/build/search.d.ts

@@ -0,0 +1,4 @@
+import { ModelProblem } from '../../errors.js';
+import { SearchIndex, ScalarField } from '../types.js';
+export declare const vectorQueryNames: WeakMap<ScalarField, string>;
+export declare function readSearch(typeName: string, label: string, defaultName: string, plural: string | undefined, scalars: ScalarField[], fulltext: Record<string, unknown> | undefined, problems: ModelProblem[]): SearchIndex[];

package/dist/model/build/shapes.d.ts

@@ -0,0 +1,18 @@
+import { GraphQLNamedType, GraphQLInputType, GraphQLOutputType, GraphQLSchema } from 'graphql';
+import { TypeShape, ScalarType } from '../types.js';
+export declare const BUILTIN_SCALARS: Record<string, ScalarType>;
+export declare function unwrap(type: GraphQLOutputType): {
+    required: boolean;
+    list: boolean;
+    itemRequired: boolean;
+    depth: number;
+};
+export declare function isScalarLike(name: string, schema: GraphQLSchema): boolean;
+/** A custom scalar's storage type, from its `@storedAs(type:)`. */
+export declare function storageOf(t: GraphQLNamedType): ScalarType | undefined;
+export declare function lowerFirst(s: string): string;
+export declare function defaultPlural(typeName: string): string;
+export declare function shapeOf(shape: ReturnType<typeof unwrap>): Omit<TypeShape, "named">;
+export declare function unwrapInput(type: GraphQLInputType): Omit<TypeShape, "named">;
+export declare function upperFirst(s: string): string;
+export declare function snakeCase(s: string): string;

package/dist/model/build/unique-together.d.ts

@@ -0,0 +1,5 @@
+import { GraphQLDirective, GraphQLObjectType } from 'graphql';
+import { ModelProblem } from '../../errors.js';
+import { NodeType, RelationshipPropertiesType, UniqueTogether } from '../types.js';
+/** Every `@uniqueTogether` of a node type (repeatable), checked. */
+export declare function readUniqueTogether(t: GraphQLObjectType, node: NodeType, nodes: ReadonlyMap<string, NodeType>, props: ReadonlyMap<string, RelationshipPropertiesType>, d: (name: string) => GraphQLDirective, problems: ModelProblem[]): UniqueTogether[];

package/dist/model/build.d.ts

@@ -1,25 +1,8 @@
-import { DocumentNode, GraphQLNamedType } from 'graphql';
-import { GraphModel, ScalarType } from './types.js';
-export interface ModelOptions {
-    /** Page size used when a list or connection gets no `limit` / `first`. */
-    defaultLimit?: number;
-    /** Hard cap on any page size; `@limit(max:)` may only lower it. */
-    maxLimit?: number;
-    /**
-     * Sign cursors with HMAC-SHA-256 under this secret, and reject cursors
-     * whose signature does not match. Without it cursors are only tagged
-     * with their sort. Changing the secret invalidates every cursor.
-     */
-    cursorSecret?: string;
-}
-export declare const DEFAULT_LIMIT = 25;
-export declare const MAX_LIMIT = 100;
+import { DocumentNode } from 'graphql';
+import { GraphModel } from './types.js';
+import { ModelOptions } from './build/limits.js';
 /**
  * Parse and validate annotated type definitions into a `GraphModel`.
  * Throws a `ModelError` listing every problem found.
  */
 export declare function buildModel(typeDefs: string | DocumentNode, options?: ModelOptions): GraphModel;
-/** A custom scalar's storage type, from its `@storedAs(type:)`. */
-export declare function storageOf(t: GraphQLNamedType): ScalarType | undefined;
-export declare function lowerFirst(s: string): string;
-export declare function defaultPlural(typeName: string): string;

package/dist/model/directives.d.ts

@@ -1,3 +1,3 @@
-export declare const directiveTypeDefs = "\n  \"A node label set. Defaults to the type name.\"\n  directive @node(labels: [String!], plural: String) on OBJECT\n\n  \"Natural key: required, unique and immutable; the tie-breaker of every sort and the anchor of cursors, global ids, updates and deletes. With generate: true, creates fill it with a UUID when the input leaves it out.\"\n  directive @key(\n    generate: Boolean = false\n    \"VIEWER: a created key must start with the caller's @viewer claim and the separator (lou:tomorrowland).\"\n    scope: KeyScope\n    separator: String = \":\"\n  ) on FIELD_DEFINITION\n\n  enum KeyScope {\n    VIEWER\n  }\n\n  \"On an interface field: every implementation declares this relationship (with @relationship, possibly of different types or directions), so clients can select it on the interface.\"\n  directive @declareRelationship on FIELD_DEFINITION\n\n  \"Offer this field as a grouping key of <plural>Grouped (needs @query(aggregate: true)).\"\n  directive @groupBy on FIELD_DEFINITION\n\n  \"A field computed in JavaScript by the resolver passed in the resolvers option. requires is a selection on this type (for example name capacity) fetched in the same statement, so the resolver reads it from its source.\"\n  directive @customResolver(requires: String) on FIELD_DEFINITION\n\n  \"On a custom scalar: how its values are stored. Filters, sorts and indexes follow the storage type; the scalar is passed through unless the scalars option supplies an implementation.\"\n  directive @storedAs(type: StorageType!) on SCALAR\n\n  enum StorageType {\n    STRING\n    INT\n    FLOAT\n    BOOLEAN\n    DATETIME\n    DATE\n  }\n\n  \"A uniqueness constraint.\"\n  directive @unique on FIELD_DEFINITION\n\n  \"No two nodes of this type (among those matching where) share the values of fields: scalar fields, single relationships (by the target's @key) and at most one list relationship (by the set of target keys). Enforced by every generated mutation, for every caller.\"\n  directive @uniqueTogether(\n    fields: [String!]!\n    where: NodeWhere\n  ) repeatable on OBJECT\n\n  \"An explicit index. Usually unnecessary: inferred from @filterable and @sortable.\"\n  directive @index(kind: IndexKind!) on FIELD_DEFINITION\n\n  \"An edge. The target type is the field's type.\"\n  directive @relationship(\n    type: String!\n    direction: RelationshipDirection!\n    properties: String\n    \"UNDIRECTED reads follow the relationship both ways; writes use direction.\"\n    queryDirection: QueryDirection = DIRECTED\n    \"What deleting this node does to nodes reached through the field.\"\n    onDelete: OnDelete = DETACH\n    \"Which nested writes mutation inputs offer for the field.\"\n    nestedOperations: [NestedOperation!] = [\n      CREATE\n      CONNECT\n      DISCONNECT\n      UPDATE\n      DELETE\n    ]\n    \"false: no aggregate on the field's connection and no aggregate filter.\"\n    aggregate: Boolean = true\n  ) on FIELD_DEFINITION\n\n  \"UPDATE changes a connected node and its relationship properties in place; UPDATE_EDGE only the properties.\"\n  enum NestedOperation {\n    CREATE\n    CONNECT\n    DISCONNECT\n    UPDATE\n    UPDATE_EDGE\n    DELETE\n  }\n\n  enum QueryDirection {\n    DIRECTED\n    UNDIRECTED\n  }\n\n  \"DETACH removes the relationships; CASCADE deletes the related nodes too; RESTRICT refuses while any exist.\"\n  enum OnDelete {\n    DETACH\n    CASCADE\n    RESTRICT\n  }\n\n  \"Which mutations may set the field. @readonly is onCreate: false, onUpdate: false.\"\n  directive @settable(\n    onCreate: Boolean = true\n    onUpdate: Boolean = true\n  ) on FIELD_DEFINITION\n\n  \"Whether the field can be read (onRead: false makes it write-only) or aggregated.\"\n  directive @selectable(\n    onRead: Boolean = true\n    onAggregate: Boolean = true\n  ) on FIELD_DEFINITION\n\n  \"Set by a callback passed to LoraGraphQL({ callbacks }) on these operations. Client-settable only with an explicit @settable(onCreate: true) or (onUpdate: true) and a field-level @authorization(validate:) rule for that operation.\"\n  directive @populatedBy(\n    callback: String!\n    operations: [TimestampOperation!]! = [CREATE, UPDATE]\n  ) on FIELD_DEFINITION\n\n  \"The shape of the request's claims. Rules may only test declared claims.\"\n  directive @jwt on OBJECT\n\n  \"Where a declared claim lives in the token, e.g. app_metadata.roles.\"\n  directive @jwtClaim(path: String!) on FIELD_DEFINITION\n\n  \"The claim that identifies the caller: the node of `type` whose `field` (a @key or @unique field) equals it. Enables isViewer and viewer in rules.\"\n  directive @viewer(type: String!, field: String!) on FIELD_DEFINITION\n\n  \"Properties carried by a relationship type.\"\n  directive @relationshipProperties on OBJECT\n\n  \"API name differs from the stored property.\"\n  directive @alias(property: String!) on FIELD_DEFINITION\n\n  \"Stored, never exposed.\"\n  directive @private on FIELD_DEFINITION\n\n  \"Declared upper bound on a relationship's fan-out, used by cost estimates.\"\n  directive @cardinality(max: Int!) on FIELD_DEFINITION\n\n  \"The most items a list argument of a @cypher field takes; more is BAD_USER_INPUT before the statement runs. Without it, maxListArgument applies.\"\n  directive @size(max: Int!) on ARGUMENT_DEFINITION\n\n  \"Bounds of an Int or Float argument of a @cypher field (each item, for a list); a value outside them is BAD_USER_INPUT before the statement runs.\"\n  directive @range(min: Float, max: Float) on ARGUMENT_DEFINITION\n\n  \"Generated read operations for a node type. Reads are on by default.\"\n  directive @query(\n    read: Boolean = true\n    aggregate: Boolean = false\n  ) on OBJECT | INTERFACE | UNION\n\n  \"The plural of an interface or union, for its root field.\"\n  directive @plural(value: String!) on INTERFACE | UNION\n\n  \"Filter operators for a field. Without arguments: EQ and IN. On a relationship field: enables relationship filters.\"\n  directive @filterable(byValue: [FilterOperator!]) on FIELD_DEFINITION\n\n  \"Sort and keyset-paginate on this field.\"\n  directive @sortable on FIELD_DEFINITION\n\n  \"Page size bounds for lists of this type.\"\n  directive @limit(\n    default: Int\n    max: Int\n  ) on OBJECT | INTERFACE | UNION | FIELD_DEFINITION\n\n  \"Expose an opaque global id derived from this @key field.\"\n  directive @relayId on FIELD_DEFINITION\n\n  \"Full-text search over String fields: a FULLTEXT index and a search root field per entry.\"\n  directive @fulltext(indexes: [FulltextIndex!]!) on OBJECT\n\n  \"A vector embedding ([Float!]): a VECTOR index and a similarity root field.\"\n  directive @vector(\n    dimensions: Int!\n    similarity: VectorSimilarity = COSINE\n    queryName: String\n  ) on FIELD_DEFINITION\n\n  input FulltextIndex {\n    \"Index name. Default: <label>_search for the first, required after.\"\n    name: String\n    fields: [String!]!\n    analyzer: FulltextAnalyzer = STANDARD\n    \"Root field name. Default: search<Plural>, or search<Plural>By<Name>.\"\n    queryName: String\n  }\n\n  enum FulltextAnalyzer {\n    STANDARD\n    SIMPLE\n  }\n\n  enum VectorSimilarity {\n    COSINE\n    EUCLIDEAN\n  }\n\n  \"Generated subscriptions to changes made through the library. None without this directive.\"\n  directive @subscription(\n    operations: [MutationOperation!]! = [CREATE, UPDATE, DELETE]\n    \"Also send CONNECT and DISCONNECT events for the type's relationships.\"\n    relationships: Boolean = false\n    \"Send the stored values before an update or delete (one extra read per write).\"\n    previousState: Boolean = false\n  ) on OBJECT\n\n  \"Generated mutations for a node type. None without this directive.\"\n  directive @mutation(\n    operations: [MutationOperation!]! = [CREATE, UPDATE, DELETE]\n  ) on OBJECT\n\n  \"Value stored on create when the input leaves the field out.\"\n  directive @default(value: DefaultValue!) on FIELD_DEFINITION\n\n  \"Set to the current time by the listed operations. Client-settable only with an explicit @settable(onCreate: true) or (onUpdate: true) and a field-level @authorization(validate:) rule for that operation.\"\n  directive @timestamp(\n    operations: [TimestampOperation!]! = [CREATE, UPDATE]\n  ) on FIELD_DEFINITION\n\n  \"Readable but never client-settable.\"\n  directive @readonly on FIELD_DEFINITION\n\n  \"A field backed by a Cypher statement. `this` is the parent node; arguments are $parameters, $jwt holds the request's claims, and $viewer the caller's @viewer node key.\"\n  directive @cypher(statement: String!, columnName: String) on FIELD_DEFINITION\n\n  \"Require an authenticated request (a jwt in the context) for these operations.\"\n  directive @authentication(\n    operations: [AuthOperation!]! = [\n      READ\n      CREATE\n      UPDATE\n      DELETE\n      CREATE_RELATIONSHIP\n      DELETE_RELATIONSHIP\n      SUBSCRIBE\n    ]\n    \"Claims the request must also satisfy, such as a role in roles.\"\n    jwt: AuthorizationWhere\n  ) on OBJECT | FIELD_DEFINITION\n\n  \"Row-level rules over the node and the request's claims, compiled into the statements.\"\n  directive @authorization(\n    filter: [AuthorizationFilterRule!]\n    validate: [AuthorizationValidateRule!]\n    \"On a type: false keeps the schema's bypass (see @authorizationDefaults) from skipping this type's rules; true lets it skip them, as without the argument, and tells check() that was meant.\"\n    bypass: Boolean\n    \"On a @mutation type: operations deliberately open to every caller, so check() does not report them as unguarded.\"\n    public: [AuthOperation!]\n    \"On a scalar field: a row failing unless reads the field as value (null when left out) instead of failing the request.\"\n    mask: [AuthorizationMask!]\n  ) on OBJECT | FIELD_DEFINITION\n\n  \"Named rules over claims, usable in any rule as { rule: name }, on `extend schema`.\"\n  directive @authorizationRules(\n    rules: [AuthorizationRuleDefinition!]!\n  ) on SCHEMA\n\n  input AuthorizationRuleDefinition {\n    name: String!\n    where: AuthorizationWhere!\n  }\n\n  \"A named rule of this type, usable in its rules as { rule: name } and through a relationship to it as { rel: { rule: name } }.\"\n  directive @authorizationRule(\n    name: String!\n    where: AuthorizationWhere!\n  ) repeatable on OBJECT\n\n  \"Schema-wide authorization settings, on `extend schema`.\"\n  directive @authorizationDefaults(\n    \"A claims-only test (jwt, AND, OR, NOT): a request passing it skips every filter and validate rule (not @authentication).\"\n    bypass: AuthorizationWhere\n    \"The write rule of every @mutation type that declares no CREATE, UPDATE or DELETE rule of its own.\"\n    mutations: AuthorizationWhere\n  ) on SCHEMA\n\n  input AuthorizationMask {\n    unless: AuthorizationWhere!\n    value: DefaultValue\n  }\n\n  input AuthorizationFilterRule {\n    operations: [AuthOperation!]! = [READ, UPDATE, DELETE]\n    \"Default true: without a token the rule denies.\"\n    requireAuthentication: Boolean\n    where: AuthorizationWhere!\n  }\n\n  input AuthorizationValidateRule {\n    operations: [AuthOperation!]! = [READ, CREATE, UPDATE, DELETE]\n    when: [AuthorizationWhen!]! = [BEFORE, AFTER]\n    \"Default true: without a token the rule denies.\"\n    requireAuthentication: Boolean\n    where: AuthorizationWhere!\n  }\n\n  enum MutationOperation {\n    CREATE\n    UPDATE\n    DELETE\n  }\n\n  enum TimestampOperation {\n    CREATE\n    UPDATE\n  }\n\n  enum AuthOperation {\n    READ\n    CREATE\n    UPDATE\n    DELETE\n    CREATE_RELATIONSHIP\n    DELETE_RELATIONSHIP\n    SUBSCRIBE\n    \"On a relationship field: creating one of its relationships (connect, nested create).\"\n    CONNECT\n    \"On a relationship field: removing one of its relationships (disconnect).\"\n    DISCONNECT\n    \"On a relationship field: setting properties on an existing relationship (edge update, re-connect).\"\n    UPDATE_EDGE\n    \"On a relationship field: reading, filtering, sorting or aggregating its properties.\"\n    READ_EDGE\n  }\n\n  enum AuthorizationWhen {\n    BEFORE\n    AFTER\n  }\n\n  \"Any literal.\"\n  scalar DefaultValue\n\n  \"{ node: <Type>Where-shaped filter, jwt: claim filter, AND, OR, NOT }. String values starting with $jwt. are replaced by claims.\"\n  scalar AuthorizationWhere\n\n  \"A <Type>Where-shaped filter over the type the directive is on.\"\n  scalar NodeWhere\n\n  enum IndexKind {\n    RANGE\n    TEXT\n    POINT\n  }\n\n  enum RelationshipDirection {\n    IN\n    OUT\n  }\n\n  enum FilterOperator {\n    EQ\n    IN\n    LT\n    LTE\n    GT\n    GTE\n    CONTAINS\n    STARTS_WITH\n    ENDS_WITH\n    WITHIN_BBOX\n    DISTANCE\n    INCLUDES\n    IS_NULL\n    CASE_INSENSITIVE\n  }\n\n  scalar BigInt\n  scalar Date\n  scalar Time\n  scalar LocalTime\n  scalar DateTime\n  scalar LocalDateTime\n  scalar Duration\n\n  type Point {\n    longitude: Float!\n    latitude: Float!\n    height: Float\n    srid: Int!\n    crs: String!\n  }\n\n  type CartesianPoint {\n    x: Float!\n    y: Float!\n    z: Float\n    srid: Int!\n    crs: String!\n  }\n";
+export declare const directiveTypeDefs = "\n  \"A node label set. Defaults to the type name.\"\n  directive @node(labels: [String!], plural: String) on OBJECT\n\n  \"Natural key: required, unique and immutable; the tie-breaker of every sort and the anchor of cursors, global ids, updates and deletes. With generate: true, creates fill it with a UUID when the input leaves it out.\"\n  directive @key(\n    generate: Boolean = false\n    \"VIEWER: a created key must start with the caller's @viewer claim and the separator (lou:tomorrowland).\"\n    scope: KeyScope\n    separator: String = \":\"\n  ) on FIELD_DEFINITION\n\n  enum KeyScope {\n    VIEWER\n  }\n\n  \"On an interface field: every implementation declares this relationship (with @relationship, possibly of different types or directions), so clients can select it on the interface.\"\n  directive @declareRelationship on FIELD_DEFINITION\n\n  \"Offer this field as a grouping key of <plural>Grouped (needs @query(aggregate: true)).\"\n  directive @groupBy on FIELD_DEFINITION\n\n  \"A field computed in JavaScript by the resolver passed in the resolvers option. requires is a selection on this type (for example name capacity) fetched in the same statement, so the resolver reads it from its source.\"\n  directive @customResolver(requires: String) on FIELD_DEFINITION\n\n  \"On a custom scalar: how its values are stored. Filters, sorts and indexes follow the storage type; the scalar is passed through unless the scalars option supplies an implementation.\"\n  directive @storedAs(type: StorageType!) on SCALAR\n\n  enum StorageType {\n    STRING\n    INT\n    FLOAT\n    BOOLEAN\n    DATETIME\n    DATE\n  }\n\n  \"A uniqueness constraint.\"\n  directive @unique on FIELD_DEFINITION\n\n  \"No two nodes of this type (among those matching where) share the values of fields: scalar fields, single relationships (by the target's @key) and at most one list relationship (by the set of target keys). Enforced by every generated mutation, for every caller.\"\n  directive @uniqueTogether(\n    fields: [String!]!\n    where: NodeWhere\n  ) repeatable on OBJECT\n\n  \"An explicit index. Usually unnecessary: inferred from @filterable and @sortable.\"\n  directive @index(kind: IndexKind!) on FIELD_DEFINITION\n\n  \"An edge. The target type is the field's type.\"\n  directive @relationship(\n    type: String!\n    direction: RelationshipDirection!\n    properties: String\n    \"UNDIRECTED reads follow the relationship both ways; writes use direction.\"\n    queryDirection: QueryDirection = DIRECTED\n    \"What deleting this node does to nodes reached through the field.\"\n    onDelete: OnDelete = DETACH\n    \"Which nested writes mutation inputs offer for the field.\"\n    nestedOperations: [NestedOperation!] = [\n      CREATE\n      CONNECT\n      DISCONNECT\n      UPDATE\n      DELETE\n    ]\n    \"false: no aggregate on the field's connection and no aggregate filter.\"\n    aggregate: Boolean = true\n  ) on FIELD_DEFINITION\n\n  \"UPDATE changes a connected node and its relationship properties in place; UPDATE_EDGE only the properties.\"\n  enum NestedOperation {\n    CREATE\n    CONNECT\n    DISCONNECT\n    UPDATE\n    UPDATE_EDGE\n    DELETE\n  }\n\n  enum QueryDirection {\n    DIRECTED\n    UNDIRECTED\n  }\n\n  \"DETACH removes the relationships; CASCADE deletes the related nodes too; RESTRICT refuses while any exist.\"\n  enum OnDelete {\n    DETACH\n    CASCADE\n    RESTRICT\n  }\n\n  \"Which mutations may set the field. @readonly is onCreate: false, onUpdate: false.\"\n  directive @settable(\n    onCreate: Boolean = true\n    onUpdate: Boolean = true\n  ) on FIELD_DEFINITION\n\n  \"Whether the field can be read (onRead: false makes it write-only) or aggregated.\"\n  directive @selectable(\n    onRead: Boolean = true\n    onAggregate: Boolean = true\n  ) on FIELD_DEFINITION\n\n  \"Set by a callback passed to LoraGraphQL({ callbacks }) on these operations. Client-settable only with an explicit @settable(onCreate: true) or (onUpdate: true) and a field-level @authorization(validate:) rule for that operation.\"\n  directive @populatedBy(\n    callback: String!\n    operations: [TimestampOperation!]! = [CREATE, UPDATE]\n  ) on FIELD_DEFINITION\n\n  \"The shape of the request's claims. Rules may only test declared claims.\"\n  directive @jwt on OBJECT\n\n  \"Where a declared claim lives in the token, e.g. app_metadata.roles.\"\n  directive @jwtClaim(path: String!) on FIELD_DEFINITION\n\n  \"The claim that identifies the caller: the node of `type` whose `field` (a @key or @unique field) equals it. Enables isViewer and viewer in rules.\"\n  directive @viewer(type: String!, field: String!) on FIELD_DEFINITION\n\n  \"Properties carried by a relationship type.\"\n  directive @relationshipProperties on OBJECT\n\n  \"API name differs from the stored property.\"\n  directive @alias(property: String!) on FIELD_DEFINITION\n\n  \"Stored, never exposed.\"\n  directive @private on FIELD_DEFINITION\n\n  \"Declared upper bound on a relationship's fan-out, used by cost estimates.\"\n  directive @cardinality(max: Int!) on FIELD_DEFINITION\n\n  \"The most items a list argument of a @cypher field takes; more is BAD_USER_INPUT before the statement runs. Without it, maxListArgument applies.\"\n  directive @size(max: Int!) on ARGUMENT_DEFINITION\n\n  \"Bounds of an Int or Float argument of a @cypher field (each item, for a list); a value outside them is BAD_USER_INPUT before the statement runs.\"\n  directive @range(min: Float, max: Float) on ARGUMENT_DEFINITION\n\n  \"Generated read operations for a node type. Reads are on by default.\"\n  directive @query(\n    read: Boolean = true\n    aggregate: Boolean = false\n  ) on OBJECT | INTERFACE | UNION\n\n  \"The plural of an interface or union, for its root field.\"\n  directive @plural(value: String!) on INTERFACE | UNION\n\n  \"Filter operators for a field. Without arguments: EQ and IN. On a relationship field: enables relationship filters.\"\n  directive @filterable(byValue: [FilterOperator!]) on FIELD_DEFINITION\n\n  \"Sort and keyset-paginate on this field.\"\n  directive @sortable on FIELD_DEFINITION\n\n  \"Page size bounds for lists of this type.\"\n  directive @limit(\n    default: Int\n    max: Int\n  ) on OBJECT | INTERFACE | UNION | FIELD_DEFINITION\n\n  \"Expose an opaque global id derived from this @key field.\"\n  directive @relayId on FIELD_DEFINITION\n\n  \"Full-text search over String fields: a FULLTEXT index and a search root field per entry.\"\n  directive @fulltext(indexes: [FulltextIndex!]!) on OBJECT\n\n  \"A vector embedding ([Float!]): a VECTOR index and a similarity root field.\"\n  directive @vector(\n    dimensions: Int!\n    similarity: VectorSimilarity = COSINE\n    queryName: String\n  ) on FIELD_DEFINITION\n\n  input FulltextIndex {\n    \"Index name. Default: <label>_search for the first, required after.\"\n    name: String\n    fields: [String!]!\n    analyzer: FulltextAnalyzer = STANDARD\n    \"Root field name. Default: search<Plural>, or search<Plural>By<Name>.\"\n    queryName: String\n  }\n\n  enum FulltextAnalyzer {\n    STANDARD\n    SIMPLE\n  }\n\n  enum VectorSimilarity {\n    COSINE\n    EUCLIDEAN\n  }\n\n  \"Generated subscriptions to changes made through the library. None without this directive.\"\n  directive @subscription(\n    operations: [MutationOperation!]! = [CREATE, UPDATE, DELETE]\n    \"Also send CONNECT and DISCONNECT events for the type's relationships.\"\n    relationships: Boolean = false\n    \"Send the stored values before an update or delete (one extra read per write).\"\n    previousState: Boolean = false\n  ) on OBJECT\n\n  \"Generated mutations for a node type. None without this directive.\"\n  directive @mutation(\n    operations: [MutationOperation!]! = [CREATE, UPDATE, DELETE]\n  ) on OBJECT\n\n  \"Value stored on create when the input leaves the field out.\"\n  directive @default(value: DefaultValue!) on FIELD_DEFINITION\n\n  \"Set to the current time by the listed operations. Client-settable only with an explicit @settable(onCreate: true) or (onUpdate: true) and a field-level @authorization(validate:) rule for that operation.\"\n  directive @timestamp(\n    operations: [TimestampOperation!]! = [CREATE, UPDATE]\n  ) on FIELD_DEFINITION\n\n  \"Readable but never client-settable.\"\n  directive @readonly on FIELD_DEFINITION\n\n  \"A field backed by a Cypher statement. `this` is the parent node; arguments are $parameters, $jwt holds the request's claims, and $viewer the caller's @viewer node key.\"\n  directive @cypher(statement: String!, columnName: String) on FIELD_DEFINITION\n\n  \"Require an authenticated request (a jwt in the context) for these operations.\"\n  directive @authentication(\n    operations: [AuthOperation!]! = [\n      READ\n      CREATE\n      UPDATE\n      DELETE\n      CREATE_RELATIONSHIP\n      DELETE_RELATIONSHIP\n      SUBSCRIBE\n    ]\n    \"Claims the request must also satisfy, such as a role in roles.\"\n    jwt: AuthorizationWhere\n  ) on OBJECT | FIELD_DEFINITION\n\n  \"Row-level rules over the node and the request's claims, compiled into the statements.\"\n  directive @authorization(\n    filter: [AuthorizationFilterRule!]\n    validate: [AuthorizationValidateRule!]\n    \"On a type: false keeps the schema's bypass (see @authorizationDefaults) from skipping this type's rules; true lets it skip them, as without the argument, and tells check() that was meant.\"\n    bypass: Boolean\n    \"On a @mutation type: operations deliberately open to every caller, so check() does not report them as unguarded.\"\n    public: [AuthOperation!]\n    \"On a scalar field: a row failing unless reads the field as value (null when left out) instead of failing the request.\"\n    mask: [AuthorizationMask!]\n  ) on OBJECT | FIELD_DEFINITION\n\n  \"Named rules over claims, usable in any rule as { rule: name }, on `extend schema`.\"\n  directive @authorizationRules(\n    rules: [AuthorizationRuleDefinition!]!\n  ) on SCHEMA\n\n  input AuthorizationRuleDefinition {\n    name: String!\n    where: AuthorizationWhere!\n  }\n\n  \"A named rule of this type, usable in its rules as { rule: name } and through a relationship to it as { rel: { rule: name } }.\"\n  directive @authorizationRule(\n    name: String!\n    where: AuthorizationWhere!\n  ) repeatable on OBJECT\n\n  \"Schema-wide authorization settings, on `extend schema`.\"\n  directive @authorizationDefaults(\n    \"A claims-only test (jwt, AND, OR, NOT): a request passing it skips every filter and validate rule (not @authentication).\"\n    bypass: AuthorizationWhere\n    \"The write rule of every @mutation type that declares no CREATE, UPDATE or DELETE rule of its own.\"\n    mutations: AuthorizationWhere\n    \"Default true: without a token every rule denies. false: a rule with a branch that reads no claims decides that branch for anonymous requests too; a rule that needs claims still asks for a token.\"\n    requireAuthentication: Boolean\n  ) on SCHEMA\n\n  input AuthorizationMask {\n    unless: AuthorizationWhere!\n    value: DefaultValue\n  }\n\n  input AuthorizationFilterRule {\n    operations: [AuthOperation!]! = [READ, UPDATE, DELETE]\n    where: AuthorizationWhere!\n  }\n\n  input AuthorizationValidateRule {\n    operations: [AuthOperation!]! = [READ, CREATE, UPDATE, DELETE]\n    when: [AuthorizationWhen!]! = [BEFORE, AFTER]\n    where: AuthorizationWhere!\n  }\n\n  enum MutationOperation {\n    CREATE\n    UPDATE\n    DELETE\n  }\n\n  enum TimestampOperation {\n    CREATE\n    UPDATE\n  }\n\n  enum AuthOperation {\n    READ\n    CREATE\n    UPDATE\n    DELETE\n    CREATE_RELATIONSHIP\n    DELETE_RELATIONSHIP\n    SUBSCRIBE\n    \"On a relationship field: creating one of its relationships (connect, nested create).\"\n    CONNECT\n    \"On a relationship field: removing one of its relationships (disconnect).\"\n    DISCONNECT\n    \"On a relationship field: setting properties on an existing relationship (edge update, re-connect).\"\n    UPDATE_EDGE\n    \"On a relationship field: reading, filtering, sorting or aggregating its properties.\"\n    READ_EDGE\n  }\n\n  enum AuthorizationWhen {\n    BEFORE\n    AFTER\n  }\n\n  \"Any literal.\"\n  scalar DefaultValue\n\n  \"{ node: <Type>Where-shaped filter, jwt: claim filter, AND, OR, NOT }. String values starting with $jwt. are replaced by claims.\"\n  scalar AuthorizationWhere\n\n  \"A <Type>Where-shaped filter over the type the directive is on.\"\n  scalar NodeWhere\n\n  enum IndexKind {\n    RANGE\n    TEXT\n    POINT\n  }\n\n  enum RelationshipDirection {\n    IN\n    OUT\n  }\n\n  enum FilterOperator {\n    EQ\n    IN\n    LT\n    LTE\n    GT\n    GTE\n    CONTAINS\n    STARTS_WITH\n    ENDS_WITH\n    WITHIN_BBOX\n    DISTANCE\n    INCLUDES\n    IS_NULL\n    CASE_INSENSITIVE\n  }\n\n  scalar BigInt\n  scalar Date\n  scalar Time\n  scalar LocalTime\n  scalar DateTime\n  scalar LocalDateTime\n  scalar Duration\n\n  type Point {\n    longitude: Float!\n    latitude: Float!\n    height: Float\n    srid: Int!\n    crs: String!\n  }\n\n  type CartesianPoint {\n    x: Float!\n    y: Float!\n    z: Float\n    srid: Int!\n    crs: String!\n  }\n";
 /** Names defined by the prelude; never treated as user types. */
 export declare const PRELUDE_TYPES: Set<string>;