@loradb/lora-graphql 0.21.0 → 0.22.0

package/dist/driver.d.ts

@@ -52,6 +52,8 @@ export interface LoraDriver {
      * Open an interactive transaction. Needed for mutations, which check
      * their writes (connect targets, cardinality, authorization) before
      * committing. Optional: the WASM binding has none, so it serves reads.
+     * A write transaction waits for the writer lock: the wait must honour
+     * `timeoutMs` and `signal` (`loraDriver` bounds it).
      */
     begin?(options: RunOptions): Promise<DriverTransaction>;
     /** Plan a statement without running it. Optional: the WASM binding has no `explain()`. */

package/dist/errors.d.ts

@@ -15,6 +15,34 @@ export declare class ModelError extends Error {
     constructor(problems: ModelProblem[]);
 }
 export declare function formatProblem(p: ModelProblem): string;
-export type LoraGraphQLErrorCode = "BAD_USER_INPUT" | "INVALID_CURSOR" | "LIMIT_EXCEEDED" | "COST_EXCEEDED" | "UNAUTHENTICATED" | "FORBIDDEN" | "NOT_FOUND" | "CONSTRAINT_VIOLATION" | "DATABASE_ERROR" | "PERSISTED_QUERY_ONLY" | "WRONG_OPERATION_TYPE";
+/**
+ * Every `extensions.code` a request-time error of this library carries, in
+ * a stable order. Use it to exhaustively map codes (HTTP status, client
+ * copy) or to test membership at runtime.
+ */
+export declare const LORA_GRAPHQL_ERROR_CODES: readonly ["BAD_USER_INPUT", "INVALID_CURSOR", "LIMIT_EXCEEDED", "COST_EXCEEDED", "TIMEOUT", "UNAUTHENTICATED", "FORBIDDEN", "NOT_FOUND", "CONSTRAINT_VIOLATION", "DATABASE_ERROR", "PERSISTED_QUERY_ONLY", "WRONG_OPERATION_TYPE"];
+export type LoraGraphQLErrorCode = (typeof LORA_GRAPHQL_ERROR_CODES)[number];
+/**
+ * Whether `err` is a request-time error raised by this library: a
+ * GraphQL error (or a plain `{ extensions: { code } }` from a serialized
+ * response) whose `extensions.code` is one of `LORA_GRAPHQL_ERROR_CODES`.
+ * Duck-typed, so it also recognizes errors built by another copy of
+ * `graphql`.
+ */
+export declare function isLoraGraphQLError(err: unknown): err is {
+    message: string;
+    extensions: {
+        code: LoraGraphQLErrorCode;
+    };
+};
 /** A request-time error with a stable `extensions.code`. */
 export declare function requestError(code: LoraGraphQLErrorCode, message: string, cause?: unknown, extensions?: Record<string, unknown>): GraphQLError;
+/**
+ * One error per field path pattern: errors with the same message and code
+ * at paths that differ only in list indices (a field every row of a list
+ * refuses, such as an @authentication field read anonymously) become one
+ * error at the first path, with `extensions.count` and
+ * `extensions.pathPattern` (indices as `"*"`). A page of 100 x 100 rows
+ * otherwise answers with 10 000 copies of one error.
+ */
+export declare function collapseErrors(errors: readonly GraphQLError[]): GraphQLError[];

package/dist/execute/budget.d.ts

@@ -0,0 +1,22 @@
+/** Default `maxConcurrentStatements`. */
+export declare const MAX_CONCURRENT_STATEMENTS = 2;
+/** Default `operationTimeoutMs`, as a multiple of `timeoutMs`. */
+export declare const OPERATION_TIMEOUT_FACTOR = 2;
+export declare class OperationBudget {
+    #private;
+    /** Root fields of the operation in flight. */
+    active: number;
+    constructor(timeoutMs: number, maxConcurrent: number);
+    get signal(): AbortSignal;
+    /** Milliseconds left before the deadline (Infinity without one). */
+    remaining(): number;
+    /**
+     * Run `fn` once a statement slot is free, failing with TIMEOUT when the
+     * deadline passes first (the statement keeps its own abort signal).
+     */
+    run<T>(fn: (signal: AbortSignal) => Promise<T>): Promise<T>;
+    /** Stop the deadline timer: the operation is over. */
+    dispose(): void;
+}
+/** One signal aborted when either is; `b` alone when `a` is absent. */
+export declare function anySignal(a: AbortSignal | undefined, b: AbortSignal): AbortSignal;

package/dist/execute/changes.d.ts

@@ -53,6 +53,8 @@ export interface WriteChange {
 export interface ReadSetLike {
     labels: readonly string[];
     relationships: readonly string[];
+    /** Reads nobody can name (a `@cypher` statement): every change affects it. */
+    opaque?: boolean | undefined;
 }
 /**
  * Whether a read with this read-set may observe the change. Label-level:

package/dist/execute/cypher-mutation.d.ts

@@ -1,4 +1,7 @@
 import { FieldNode } from 'graphql';
+import { Statement } from '../driver.js';
 import { CypherField } from '../model/types.js';
 import { MutationEnv } from './mutate.js';
-export declare function executeCypherMutation(env: MutationEnv, field: CypherField, args: Record<string, unknown>, fieldNodes: readonly FieldNode[]): Promise<unknown>;
+export declare function executeCypherMutation(env: MutationEnv, field: CypherField, args: Record<string, unknown>, fieldNodes: readonly FieldNode[], 
+/** The field's `viewer` rules, checked in the transaction first. */
+guard?: Statement): Promise<unknown>;

package/dist/execute/mutate.d.ts

@@ -1,4 +1,5 @@
 import { FieldNode } from 'graphql';
+import { Statistics } from '../analyze/statistics.js';
 import { SelectionContext } from '../compile/selection.js';
 import { DriverTransaction, LoraDriver, QueryResult, Statement } from '../driver.js';
 import { GraphModel, NodeType } from '../model/types.js';
@@ -28,8 +29,21 @@ export interface MutationEnv {
     timeoutMs: number;
     signal: AbortSignal | undefined;
     degrees: ReadonlyMap<string, number>;
-    /** Most nodes one mutation may create or delete, nested ones included. */
+    /**
+     * Most nodes one mutation may create, update or delete, nested ones
+     * included; relationships written, ten times as many.
+     */
     maxBatch: number;
+    /** Most items a @cypher list argument takes without `@size(max:)`. */
+    maxListArgument?: number | undefined;
+    /** Relationship levels one `where` may nest. */
+    maxFilterDepth?: number | undefined;
+    /** Items an `in` filter operand may hold. */
+    maxListFilter?: number | undefined;
+    /** Characters a string filter operand may hold. */
+    maxStringFilter?: number | undefined;
+    /** Statistics from `analyze()`, for filter costs. */
+    statistics?: Statistics | undefined;
     callbacks: Readonly<Record<string, PopulatedByCallback>>;
     /**
      * A caller-owned transaction: run inside it and leave the commit to the
@@ -40,6 +54,15 @@ export interface MutationEnv {
     onStatement?: ((statement: Statement) => void) | undefined;
     /** Runs a statement under timing, tracing and metrics, when configured. */
     observe?: ((statement: Statement, run: () => Promise<QueryResult>) => Promise<QueryResult>) | undefined;
+    /**
+     * Called inside the transaction once a delete knows every node it
+     * removes, before any is removed: subscribers' checks of the nodes as
+     * they were (a deleted node cannot be checked after the commit).
+     */
+    beforeDelete?: ((change: WriteChange, doomed: ReadonlyArray<{
+        node: NodeType;
+        keys: unknown[];
+    }>, run: (statement: Statement) => Promise<QueryResult>) => Promise<void>) | undefined;
 }
 /** Run `statement` in `tx`, reporting it before and observing it during. */
 export declare function runStatement(env: MutationEnv, tx: DriverTransaction, statement: Statement): Promise<QueryResult>;
@@ -50,6 +73,11 @@ export interface MutationInfo {
     relationshipsCreated: number;
     relationshipsDeleted: number;
 }
+/**
+ * `@uniqueTogether` after a write whose write-set is unknown (a `@cypher`
+ * mutation): every node of each type in `nodes` is compared, in `tx`.
+ */
+export declare function checkUniqueTogetherOf(env: MutationEnv, tx: DriverTransaction, nodes: readonly NodeType[]): Promise<void>;
 export interface MutationResult {
     payload: unknown;
     change: WriteChange;

package/dist/guards.d.ts

@@ -41,8 +41,15 @@ export declare function parseOptions(guards?: DocumentGuards): ParseOptions;
  * The guards as an Envelop plugin, for GraphQL Yoga and other Envelop
  * servers: the token limit wraps `parse`, the rest are validation rules.
  * Typed structurally, so the package does not depend on Envelop.
+ *
+ * It also checks, once, that the server runs the same `graphql` copy as
+ * this library (see `graphqlRealmProblem`), and reports a mismatch
+ * through `onRealmMismatch` (default: `console.error`).
  */
-export declare function envelopPlugin(guards?: DocumentGuards): {
+export declare function envelopPlugin(guards?: DocumentGuards, onRealmMismatch?: (message: string) => void): {
+    onSchemaChange({ schema }: {
+        schema: unknown;
+    }): void;
     onParse({ parseFn, setParseFn, }: {
         parseFn: (source: unknown, options?: ParseOptions) => unknown;
         setParseFn: (fn: (source: unknown, options?: ParseOptions) => unknown) => void;
@@ -51,4 +58,15 @@ export declare function envelopPlugin(guards?: DocumentGuards): {
         addValidationRule: (rule: ValidationRule) => void;
     }): void;
 };
+type RealmProbe = "schema" | "validation";
+/**
+ * When `value` (a schema, or the context a validation rule receives)
+ * comes from a different `graphql` module than the one this library
+ * imports, the message explaining it; otherwise undefined. Two copies
+ * break `instanceof GraphQLError`, so servers such as Yoga mask the
+ * library's errors (FORBIDDEN, BAD_USER_INPUT, ...) as "Unexpected
+ * error".
+ */
+export declare function graphqlRealmProblem(value: unknown, what: RealmProbe): string | undefined;
 export declare function nodeEnv(): string | undefined;
+export {};

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-export { LoraGraphQL, type AssertSchemaOptions, type CheckOptions, type CheckReport, type CostEvent, type DatabaseErrorEvent, type ExecuteArgs, type ExecutionTiming, type LoraGraphQLContext, type LoraGraphQLOptions, type SchemaAssertion, type StatementEvent, } from './lora-graphql.js';
+export { LoraGraphQL, type AssertSchemaOptions, type CheckOptions, type CheckReport, type CostEvent, type DatabaseErrorEvent, type ExecuteArgs, type ExecutionTiming, type LoraGraphQLContext, type LoraGraphQLOptions, type LoraExecutionResult, type SchemaAssertion, type StatementEvent, } from './lora-graphql.js';
 export { loraDriver, type DriverTransaction, type LoraDatabaseLike, type LoraDriver, type QueryPlan, type QueryResult, type RunOptions, type Statement, } from './driver.js';
 export { directiveTypeDefs } from './model/directives.js';
 export { buildModel, type ModelOptions } from './model/build.js';
@@ -6,7 +6,7 @@ export type * from './model/types.js';
 export { inferRequirements, requirementDdl, type SchemaRequirement, } from './analyze/indexes.js';
 export { checkPlans, scanExpands, type PlanFinding, type PlanReport, } from './analyze/plans.js';
 export type { DegreeStats, Statistics } from './analyze/statistics.js';
-export type { AccessEntry, AccessVerdict } from './analyze/access.js';
+export type { AccessEntry, AccessVerdict, OperationAccess, RootFieldAccess, } from './analyze/access.js';
 export type { CypherFinding } from './analyze/cypher-check.js';
 export { diffSchemas, type ApiChange, type SchemaDiff, } from './analyze/diff.js';
 export type { CompiledRead, ReadSet, SeekExpectation } from './compile/read.js';
@@ -15,7 +15,7 @@ export type { MutationInfo, PopulatedByCallback } from './execute/mutate.js';
 export type { MutationKind } from './schema/mutations.js';
 export type { ChangeEvent } from './schema/build.js';
 export { LoraTransaction } from './execute/transaction.js';
-export { ModelError, formatProblem, type LoraGraphQLErrorCode, type ModelProblem, } from './errors.js';
+export { ModelError, formatProblem, isLoraGraphQLError, LORA_GRAPHQL_ERROR_CODES, type LoraGraphQLErrorCode, type ModelProblem, } from './errors.js';
 export { toGlobalId, fromGlobalId } from './schema/global-id.js';
 export type { Attributes, MetricsLike, ObservabilityOptions, SpanLike, StatementEndEvent, TracerLike, } from './observe.js';
 export { schemaHash, type ManifestOperation, type OperationManifest, } from './codegen.js';

package/dist/index.js

@@ -1,24 +1,26 @@
-import { D as e, L as r, a as o, M as l, b as i, c as d, d as n, e as t, f, g as m, i as p, l as c, p as h, r as D, s as b, h as u, t as v, v as L } from "./driver-DAtBEMWj.js";
-import { d as x } from "./diff-CcRU-3_p.js";
+import { D as r, L as e, a as o, b as l, M as i, c as d, d as n, e as t, f as p, g as f, h as m, i as L, j as c, l as R, p as h, r as D, s as E, k as G, t as b, v as u } from "./driver-C5dSoSD8.js";
+import { d as A } from "./diff-B9iDdELF.js";
 export {
-  e as DEFAULT_GUARDS,
-  r as LoraGraphQL,
-  o as LoraTransaction,
-  l as ModelError,
-  i as buildModel,
-  d as checkPlans,
-  x as diffSchemas,
-  n as directiveTypeDefs,
-  t as envelopPlugin,
+  r as DEFAULT_GUARDS,
+  e as LORA_GRAPHQL_ERROR_CODES,
+  o as LoraGraphQL,
+  l as LoraTransaction,
+  i as ModelError,
+  d as buildModel,
+  n as checkPlans,
+  A as diffSchemas,
+  t as directiveTypeDefs,
+  p as envelopPlugin,
   f as formatProblem,
   m as fromGlobalId,
-  p as inferRequirements,
-  c as loraDriver,
+  L as inferRequirements,
+  c as isLoraGraphQLError,
+  R as loraDriver,
   h as parseOptions,
   D as requirementDdl,
-  b as scanExpands,
-  u as schemaHash,
-  v as toGlobalId,
-  L as validationRules
+  E as scanExpands,
+  G as schemaHash,
+  b as toGlobalId,
+  u as validationRules
 };
 //# sourceMappingURL=index.js.map

package/dist/lora-graphql.d.ts

@@ -1,8 +1,8 @@
-import { DocumentNode, ExecutionResult, GraphQLSchema, GraphQLFieldResolver, GraphQLScalarType, ValidationRule } from 'graphql';
+import { ExecutionArgs, DocumentNode, ExecutionResult, GraphQLSchema, GraphQLFieldResolver, GraphQLScalarType, ValidationRule } from 'graphql';
 import { CypherFinding } from './analyze/cypher-check.js';
 import { SchemaRequirement } from './analyze/indexes.js';
 import { PlanReport } from './analyze/plans.js';
-import { AccessEntry } from './analyze/access.js';
+import { AccessEntry, OperationAccess } from './analyze/access.js';
 import { Statistics } from './analyze/statistics.js';
 import { CompiledRead, ReadSet } from './compile/read.js';
 import { LoraDriver, Statement } from './driver.js';
@@ -20,10 +20,34 @@ export interface LoraGraphQLOptions extends ModelOptions, ObservabilityOptions {
     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`.
+     * 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;
@@ -41,16 +65,61 @@ export interface LoraGraphQLOptions extends ModelOptions, ObservabilityOptions {
      */
     jwt?: (context: unknown) => Record<string, unknown> | undefined;
     /**
-     * Most nodes one mutation may create or delete, nested ones included.
-     * Default 1000: larger imports belong in a Cypher load, not a GraphQL
+     * 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>;
     /**
@@ -99,9 +168,11 @@ export interface LoraGraphQLOptions extends ModelOptions, ObservabilityOptions {
      * 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. Servers that call
-     * graphql-js on `getSchema()` directly get per-operation atomicity by
-     * putting a `lora.begin()` transaction in the context.
+     * `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";
     /**
@@ -244,15 +315,41 @@ export interface ExecuteArgs {
     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;
+};
 export declare class LoraGraphQL {
     #private;
     readonly model: GraphModel;
     constructor(options: LoraGraphQLOptions);
     /** The configured document guards as validation rules. */
     validationRules(): ValidationRule[];
-    /** The configured document guards as an Envelop / Yoga plugin. */
-    envelopPlugin(): ReturnType<typeof envelopPlugin>;
+    /**
+     * The configured document guards as an Envelop / Yoga plugin. With
+     * `mutationTransaction: "operation"` it also runs a mutation with
+     * several root fields in one transaction, and it collapses identical
+     * errors across list indices, as `execute()` does.
+     */
+    envelopPlugin(): ReturnType<typeof envelopPlugin> & {
+        onExecute(payload: {
+            args: ExecutionArgs;
+            executeFn: (args: ExecutionArgs) => unknown;
+            setExecuteFn: (fn: (args: ExecutionArgs) => unknown) => void;
+        }): {
+            onExecuteDone(payload: {
+                result: unknown;
+                setResult: (result: ExecutionResult) => void;
+            }): void;
+        };
+    };
     /** The executable schema, for any graphql-js server. */
     getSchema(): GraphQLSchema;
     /** The client-facing SDL: generated types only, no model directives. */
@@ -266,8 +363,10 @@ export declare class LoraGraphQL {
      */
     assertSchema(options?: AssertSchemaOptions): Promise<SchemaAssertion>;
     /**
-     * Sample node counts and relationship degrees (S6). Cost estimates then
-     * use each relationship's p99 degree instead of its page limit.
+     * Count nodes and measure relationship degrees (S6). Cost estimates then
+     * use each relationship's maximum degree, capped by its page limit,
+     * instead of the page limit alone; filters use node counts and mean
+     * degrees (see `src/compile/cost.ts`).
      */
     analyze(options?: {
         sample?: number;
@@ -286,6 +385,14 @@ export declare class LoraGraphQL {
      * model; stable, so it can be snapshotted and reviewed as a diff.
      */
     accessMatrix(): AccessEntry[];
+    /**
+     * Who may run an operation: per root field, the verdict for each kind
+     * of caller, from the same rules as `accessMatrix()`, plus the most
+     * restrictive verdict per caller. Takes a document (source or parsed)
+     * or the id of a persisted operation; `operationName` picks one of
+     * several operations.
+     */
+    operationAccess(document: string | DocumentNode, operationName?: string): OperationAccess;
     check(options?: CheckOptions): Promise<CheckReport>;
     /**
      * Compile a query without running it: one entry per root field, with its
@@ -332,7 +439,7 @@ export declare class LoraGraphQL {
      * subscription runs with {@link LoraGraphQL.subscribe}; given one, this
      * returns a `WRONG_OPERATION_TYPE` error.
      */
-    execute(args: ExecuteArgs): Promise<ExecutionResult>;
+    execute(args: ExecuteArgs): Promise<LoraExecutionResult>;
     /**
      * Run a subscription: an async iterable of results, one per event, or a
      * single result with the errors when it cannot start (an unknown id, a

package/dist/model/desugar.d.ts

@@ -41,3 +41,13 @@ export declare function desugarRule(ctx: DesugarContext, owner: NodeType | undef
 export declare function desugarNode(ctx: DesugarContext, node: NodeType, where: unknown): unknown;
 /** Model problems for a `@viewer` mapping, once the node types are built. */
 export declare function checkViewer(viewer: ViewerMapping, nodes: ReadonlyMap<string, NodeType>, jwtType: string, problems: ModelProblem[]): void;
+/**
+ * The parts a rule tests at its top level, through AND, OR and NOT:
+ * `node`, `jwt`, `viewer`, `source`, `target`, `edge`.
+ */
+export declare function ruleParts(where: unknown, out?: Set<string>): Set<string>;
+/**
+ * A relationship property's rule that tests the relationship's ends or
+ * edge (`source`, `target`, `edge`): decided per relationship.
+ */
+export declare function testsRelationshipEnds(where: unknown): boolean;

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  \"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  enum NestedOperation {\n    CREATE\n    CONNECT\n    DISCONNECT\n    UPDATE\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; never client-settable.\"\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  \"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; never client-settable.\"\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, and $jwt holds the request's claims.\"\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.\"\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  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  ) 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";
 /** Names defined by the prelude; never treated as user types. */
 export declare const PRELUDE_TYPES: Set<string>;

package/dist/model/inputs.d.ts

@@ -10,3 +10,12 @@ export declare function isUpdatable(model: GraphModel, node: NodeType, seen?: Se
 export declare function offersNested(model: GraphModel, rel: RelationshipField, update: boolean, seen?: Set<string>): boolean;
 /** Whether any property of a @relationshipProperties type is settable on `op`. */
 export declare function hasSettable(props: RelationshipPropertiesType, op: "CREATE" | "UPDATE"): boolean;
+/**
+ * The first value in `value` (each item, for a list) outside `range`, or
+ * undefined. Null and absent values are not checked: nullability is the
+ * type's business.
+ */
+export declare function outOfRange(value: unknown, range: {
+    min?: number | undefined;
+    max?: number | undefined;
+}): number | undefined;

package/dist/model/types.d.ts

@@ -84,7 +84,11 @@ export interface ScalarField extends FieldBase {
     } | undefined;
     description: string | undefined;
 }
-export type NestedOperation = "CREATE" | "CONNECT" | "DISCONNECT" | "UPDATE" | "DELETE";
+export type NestedOperation = "CREATE" | "CONNECT" | "DISCONNECT"
+/** `update: [{ key, edge, node }]`: the connected node and the properties. */
+ | "UPDATE"
+/** `update: [{ key, edge }]`: the relationship's properties only. */
+ | "UPDATE_EDGE" | "DELETE";
 export interface RelationshipField extends FieldBase {
     kind: "relationship";
     name: string;
@@ -140,6 +144,13 @@ export interface CypherArgument {
     type: TypeShape;
     defaultValue: unknown;
     description: string | undefined;
+    /** `@size(max:)`: the most items a list argument takes. */
+    maxItems?: number | undefined;
+    /** `@range(min:, max:)`: bounds of an Int or Float argument. */
+    range?: {
+        min?: number | undefined;
+        max?: number | undefined;
+    } | undefined;
 }
 export interface CypherField extends FieldBase {
     kind: "cypher";
@@ -180,8 +191,15 @@ export interface CustomField extends FieldBase {
     description: string | undefined;
 }
 export type Field = ScalarField | RelationshipField | CypherField | CustomField;
-/** A `${jwt.path}` / `${context.path}` placeholder inside a rule string. */
+/**
+ * A placeholder inside a rule string: `${jwt.path}`, `${context.path}`,
+ * `${viewer.field}`, or a value of the node the rule is about:
+ * `${node.path}` in a type's rules, `${source.path}` / `${target.path}` /
+ * `${edge.property}` in a relationship field's rules.
+ */
 export declare const PLACEHOLDER: RegExp;
+/** The placeholder sources that name a node (or edge) of the rule itself. */
+export declare const RULE_REFERENCES: Set<string>;
 /** `{ node, jwt, AND, OR, NOT }`, as written in `@authorization`. */
 export type AuthorizationWhere = Record<string, unknown>;
 export interface AuthorizationFilterRule {
@@ -202,7 +220,10 @@ export interface AuthorizationValidateRule {
 export interface Authorization {
     filter: readonly AuthorizationFilterRule[];
     validate: readonly AuthorizationValidateRule[];
-    /** `bypass: false`: the schema's bypass does not skip these rules. */
+    /**
+     * `bypass: false`: the schema's bypass does not skip these rules.
+     * `true`: it does, as when left out, and `check()` does not note it.
+     */
     bypass?: boolean;
     /** `public:` operations deliberately open to every caller. */
     public?: ReadonlySet<AuthOperation>;
@@ -248,8 +269,28 @@ export interface NodeType {
     search: readonly SearchIndex[];
     /** Interfaces the type implements. */
     interfaces: readonly string[];
+    /** `@uniqueTogether`: combinations no two nodes of the type may share. */
+    uniqueTogether: readonly UniqueTogether[];
     description: string | undefined;
 }
+/**
+ * `@uniqueTogether(fields:, where:)`: no two nodes of the type (among those
+ * matching `where`) hold the same value of every field. A combination
+ * with a null scalar, a missing single relationship or an empty set is
+ * exempt, as a null is in a unique index.
+ */
+export interface UniqueTogether {
+    /** The fields as declared, for messages. */
+    fields: readonly string[];
+    /** Scalar fields, compared by stored value. */
+    scalars: readonly ScalarField[];
+    /** Single relationships, compared by the target's @key. */
+    singles: readonly RelationshipField[];
+    /** At most one list relationship, compared as the set of target keys. */
+    set: RelationshipField | undefined;
+    /** A `<Type>Where`-shaped filter: only nodes matching it are compared. */
+    where: Record<string, unknown> | undefined;
+}
 export type SearchIndex = {
     kind: "fulltext";
     name: string;
@@ -346,6 +387,8 @@ export interface GraphModel {
     } | undefined;
     /** Secret cursors are signed with, when configured. */
     cursorSecret: string | undefined;
+    /** The global page-size cap (`maxLimit`); also caps `nodes(ids:)`. */
+    maxLimit?: number | undefined;
 }
 export interface ModelWarning {
     type: string;

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

@@ -0,0 +1,3 @@
+import { GraphModel, NodeType } from './types.js';
+/** The `@uniqueTogether` types `statement` may write. */
+export declare function uniqueTogetherTouched(model: GraphModel, statement: string): NodeType[];