@vantreeseba/drizzle-graphql 7.4.0 → 7.6.0

package/dist/index.d.cts

@@ -3,6 +3,7 @@ import { MySqlDatabase } from 'drizzle-orm/mysql-core';
 import { PgAsyncDatabase } from 'drizzle-orm/pg-core';
 import { BaseSQLiteDatabase } from 'drizzle-orm/sqlite-core';
 import { GraphQLScalarType, GraphQLOutputType, GraphQLInputType, GraphQLFieldResolver, GraphQLResolveInfo, GraphQLSchema, GraphQLInputObjectType, GraphQLObjectType, GraphQLNonNull, GraphQLList, GraphQLEnumType } from 'graphql';
+import { ResolveTree } from 'graphql-parse-resolve-info';
 export { GraphQLDate, GraphQLDateTime, GraphQLJSON, GraphQLUUID } from 'graphql-scalars';
 
 /**
@@ -197,6 +198,11 @@ type OrderByArgs<TTable extends Table> = {
     };
 };
 
+/** Optional mapper from table key to singular/plural name pair. Return undefined to use default naming for a table. */
+type TypeNameMapper = (tableName: string) => {
+    singular: string;
+    plural: string;
+} | undefined;
 /**
  * Extracts the join column info from a drizzle-orm v1 Relation object.
  * Returns the JS property name of the local column on the parent table and the
@@ -245,7 +251,7 @@ declare const drizzleExecutorKey: unique symbol;
  * each dialect builder states it: `'nulls-largest'` for PostgreSQL, `'nulls-smallest'` for
  * MySQL and SQLite.
  */
-declare const createRelationResolverFactory: (db: any, tables: Record<string, Table>, nullOrdering: NullOrdering, filterCtx?: RelationFilterBase, limits?: LimitPolicyFor) => RelationResolverFactory;
+declare const createRelationResolverFactory: (db: any, tables: Record<string, Table>, nullOrdering: NullOrdering, filterCtx?: RelationFilterBase, limits?: LimitPolicyFor, scopes?: ScopeFor) => RelationResolverFactory;
 /** {@link BuildSchemaConfig.limits} resolved for one table. `undefined` means no policy. */
 type ResolvedLimitPolicy = {
     defaultLimit: number | undefined;
@@ -301,6 +307,20 @@ interface RelationFilterContext {
  */
 type RelationFilterBase = Pick<RelationFilterContext, 'tables' | 'relationMap'>;
 declare const extractFilters: <TTable extends Table>(table: TTable, tableName: string, filters: Filters<TTable>, relationCtx?: RelationFilterContext) => SQL | undefined;
+/**
+ * A table's row-level scope: the predicate every generated read, update and delete on that
+ * table is narrowed by. See `BuildSchemaConfig.scope`.
+ *
+ * `table` is the table the predicate must be built against. On the relational-query path
+ * drizzle hands its callbacks an *aliased* proxy (`d0`, `d1`, …), so a predicate built from
+ * the imported schema table would reference a name that isn't in the query — always build
+ * from the argument. Returning a filter object instead (the same shape as the field's
+ * `where`) sidesteps aliasing entirely, and is the only form that can reach through a
+ * relation — which is what ownership through a join table needs.
+ */
+type ScopeHook<TContext = any> = (context: TContext, table: any) => SQL | Record<string, any> | undefined | null;
+/** Build-time lookup: the scope configured for a table, if any. */
+type ScopeFor = (tableName: string) => ScopeHook | undefined;
 /**
  * Where a dialect's default sort places NULLs relative to non-NULL values:
  * - `nulls-largest` — PostgreSQL: NULLs sort as the largest values (last in ASC, first in DESC).
@@ -815,6 +835,34 @@ type LimitsConfig = TableLimitPolicy & {
     /** Per-table overrides, keyed by the table's key in the Drizzle schema. */
     tables?: Record<string, TableLimitPolicy>;
 };
+/**
+ * What a {@link RowScope} may return: a Drizzle `SQL` expression, a filter object in the same
+ * shape as the generated `where` argument, or `undefined`/`null` for "no restriction".
+ *
+ * The filter-object form is compiled with the same code that compiles a client `where`, so it
+ * supports relation filters — `{ author: { orgId: { eq: 1 } } }` scopes a table through a join
+ * rather than a column it owns.
+ */
+type RowScopeFilter = Record<string, any> | undefined | null;
+/**
+ * A per-table row scope: given the GraphQL context, the predicate every read and write of that
+ * table is confined to.
+ *
+ * `table` is the table instance the current statement runs against. For a relational read that
+ * is Drizzle's *aliased* copy of the table, so build the predicate from this argument rather
+ * than from the imported table object — `eq(table.orgId, ctx.orgId)` is always correct, while
+ * `eq(users.orgId, ctx.orgId)` refers to the wrong alias inside a nested read.
+ *
+ * See {@link BuildSchemaConfig.scope}.
+ */
+type RowScope<TContext = any> = (context: TContext, table: any) => RowScopeFilter | object;
+/** {@link BuildSchemaConfig.scope} — a row scope per table, keyed by the Drizzle schema key. */
+type ScopeConfig<TContext = any> = Record<string, RowScope<TContext>>;
+/**
+ * {@link BuildSchemaConfig.contextValues} — columns whose value the server derives from the
+ * request context, keyed by Drizzle schema key and then by column property name.
+ */
+type ContextValuesConfig<TContext = any> = Record<string, Record<string, (context: TContext) => any>>;
 /**
  * {@link BuildSchemaConfig.exclude} — tables and columns to keep out of the generated schema.
  *
@@ -1043,6 +1091,66 @@ type BuildSchemaConfig = {
      *   agree.
      */
     limits?: LimitsConfig;
+    /**
+     * Row-level scoping: a predicate, derived from the GraphQL context, that every read and
+     * write of a table is confined to. This is the multi-tenancy / ownership knob — the one
+     * rule a wrapper cannot enforce from outside, because a nested relation field never passes
+     * through a root resolver.
+     *
+     * ```ts
+     * import { and, eq } from 'drizzle-orm';
+     *
+     * buildSchema(db, {
+     *   scope: {
+     *     posts: (ctx, table) => eq(table.orgId, ctx.orgId),
+     *     // A filter object works too, and can scope through a relation:
+     *     comments: (ctx) => ({ post: { orgId: { eq: ctx.orgId } } }),
+     *   },
+     * });
+     * ```
+     *
+     * - The predicate is ANDed on **last**, after the client's `where`, so a client filter can
+     *   only ever narrow the scope, never widen it.
+     * - It applies to every path that reads the table: list and single queries, aggregates and
+     *   `groupBy`, relation fields (batched and eager), relation aggregates, and cursor pages.
+     * - It applies to every path that writes it: `update`, `updateMany`, `delete`, the
+     *   conflict-update half of an upsert (PostgreSQL and SQLite), and the rows a nested
+     *   `connect` / `disconnect` / `set` is allowed to reach. An out-of-scope row is simply not
+     *   matched — a scoped `delete` reports zero rows rather than refusing.
+     * - It cannot apply to a plain `insert`: there is no existing row to filter. Use
+     *   {@link BuildSchemaConfig.contextValues} to stamp the owning column on the way in.
+     * - `table` is the table the current statement runs against, which for a relational read is
+     *   Drizzle's aliased copy — always build the predicate from that argument.
+     * - Returning `undefined` means "no restriction for this context", so a hook can let an
+     *   admin through. A table with no entry is unscoped.
+     * - MySQL's `ON DUPLICATE KEY UPDATE` takes no predicate, so a MySQL upsert cannot be
+     *   scoped on the conflict path; scope the table's `update` and rely on `contextValues`
+     *   for the insert half.
+     */
+    scope?: ScopeConfig;
+    /**
+     * Columns whose value the server derives from the request context rather than accepting
+     * from the client — the write-side half of {@link BuildSchemaConfig.scope}.
+     *
+     * ```ts
+     * buildSchema(db, {
+     *   contextValues: {
+     *     posts: {
+     *       orgId: (ctx) => ctx.orgId,
+     *       authorId: (ctx) => ctx.userId,
+     *     },
+     *   },
+     * });
+     * ```
+     *
+     * - The column is removed from the generated insert and update inputs, so a client cannot
+     *   send it at all — the schema itself documents that it is server-owned.
+     * - Every insert stamps it, including the rows created by a nested `create`.
+     * - Updates never write it: an update cannot hand a row to another owner.
+     * - Keyed by the Drizzle schema key, then by the column's property name (not its database
+     *   name), the same keying {@link BuildSchemaConfig.exclude} uses.
+     */
+    contextValues?: ContextValuesConfig;
     /**
      * Tables and columns to leave out of the generated schema entirely.
      *
@@ -1315,6 +1423,110 @@ declare const singularizeMapper: (tableName: string) => {
     plural: string;
 };
 
+/**
+ * The identity a generated field publishes about itself, under `extensions.drizzle`.
+ *
+ * Every field this library generates carries one, so a wrapper — `graphql-middleware`,
+ * envelop, `graphql-shield`, an audit log, a cache invalidator — can ask the schema what a
+ * field is instead of reverse-engineering its name. Names are configurable (`prefixes`,
+ * `suffixes`, `typeNameMapper`), so name parsing is ambiguous by construction; this is not.
+ *
+ * This shape is stable API: fields are only ever added to it, never removed or repurposed.
+ */
+/** What family of field this is. */
+type DrizzleFieldKind = 'query' | 'mutation' | 'relation' | 'aggregate' | 'type';
+/**
+ * What the field does. Arity is carried separately by `single`, so `select` covers both
+ * the list query and its `…Single` sibling rather than being spelled twice.
+ */
+type DrizzleFieldOperation = 'select' | 'insert' | 'update' | 'updateMany' | 'upsert' | 'delete' | 'aggregate' | 'groupBy' | 'relation' | 'relationAggregate';
+/** The argument holding the rows a field is about, when it has one. */
+type DrizzleTargetArg = 'where' | 'values' | 'updates';
+/** `extensions.drizzle` on a generated field. */
+type DrizzleFieldExtension = {
+    /** The Drizzle schema key of the table the field reads or writes. */
+    table: string;
+    kind: Exclude<DrizzleFieldKind, 'type'>;
+    operation: DrizzleFieldOperation;
+    /** Whether the field resolves to one row (or one aggregate) rather than a list. */
+    single: boolean;
+    /**
+     * Which argument names the rows: `where` for select/update/delete/aggregate, `values`
+     * for insert and upsert, `updates` for the batch update's per-entry `{ where, set }`.
+     * Absent when the field takes no such argument.
+     */
+    targetArg?: DrizzleTargetArg;
+    /**
+     * Primary-key property names of `table`, in schema order. Empty when the table declares
+     * no primary key. Carried here so {@link identifyRows} works from the field alone.
+     */
+    primaryKey: readonly string[];
+    /** For `kind: 'relation'` and `operation: 'relationAggregate'`: the relation's name. */
+    relation?: string;
+    /** For `kind: 'relation'` and `operation: 'relationAggregate'`: the table it hangs off. */
+    parentTable?: string;
+};
+/** `extensions.drizzle` on a generated object type. */
+type DrizzleTypeExtension = {
+    /** The Drizzle schema key this type was generated from. */
+    table: string;
+    kind: 'type';
+    /** Primary-key property names of `table`, in schema order. Empty when there is none. */
+    primaryKey: readonly string[];
+};
+type DrizzleExtension = DrizzleFieldExtension | DrizzleTypeExtension;
+/** Anything carrying GraphQL `extensions` — a field config, a field, or a named type. */
+type WithExtensions = {
+    extensions?: {
+        drizzle?: unknown;
+    } | null;
+} | null | undefined;
+/**
+ * Reads the `drizzle` extension off a field or type, typed. Returns `undefined` for
+ * anything this library did not generate, which is the check a wrapper wants before it
+ * treats a field as one of ours.
+ */
+declare const drizzleExtension: (target: WithExtensions) => DrizzleExtension | undefined;
+/** Narrows to the field form — object types carry `kind: 'type'` and no operation. */
+declare const isDrizzleFieldExtension: (value: DrizzleExtension | undefined) => value is DrizzleFieldExtension;
+/** The rows a field's arguments name. */
+type IdentifiedRows = {
+    /** The Drizzle schema key of the table being read or written. */
+    table: string;
+    /** Primary-key property names, in schema order. */
+    primaryKey: readonly string[];
+    /** One entry per identified row: the primary-key values, keyed by property name. */
+    rows: Record<string, unknown>[];
+    /**
+     * Whether `rows` is exactly the set the operation affects.
+     *
+     * `false` means the arguments do not pin the rows down — an insert whose key the
+     * database generates, a `where` that filters on something other than the primary key,
+     * a plural update with no filter at all, or a table with no primary key. `rows` is then
+     * a best-effort subset-free superset: every entry in it is a row the key values name,
+     * but other filters may narrow the real set further, and it may be empty.
+     */
+    complete: boolean;
+};
+/**
+ * The rows a generated field's arguments are about, as primary-key values.
+ *
+ * The row identity of a mutation lives in a different argument for every operation —
+ * `where` for update and delete, `values` for insert and upsert, a per-entry `where` inside
+ * `updates` for the batch update — and each of those has both a one-row and a many-row
+ * spelling. This reads whichever one applies:
+ *
+ * ```ts
+ * const field = info.parentType.getFields()[info.fieldName];
+ * const target = identifyRows(field, args);
+ * if (target?.complete) await invalidate(target.table, target.rows);
+ * ```
+ *
+ * Returns `undefined` for a field this library did not generate, or an object type. Check
+ * `complete` before treating `rows` as the affected set — see {@link IdentifiedRows}.
+ */
+declare const identifyRows: (field: WithExtensions, args: Record<string, unknown> | undefined) => IdentifiedRows | undefined;
+
 /**
  * A 64-bit integer. Always transported as a decimal string, in both directions, so no value
  * is ever silently rounded by JSON's double-precision numbers. `graphql-scalars`' own
@@ -1330,6 +1542,75 @@ declare const GraphQLBigIntString: GraphQLScalarType<string, string>;
  */
 declare const GraphQLDecimalString: GraphQLScalarType<string, string>;
 
+/** Options shared by {@link selectionToWith} and {@link resolveSelection}. */
+type SelectionOptions = {
+    /** The drizzle instance the schema was built from. */
+    db: AnyDrizzleDB<any>;
+    /** The Drizzle schema key of the table the selection is rooted at. */
+    table: string;
+    /**
+     * The `typeNameMapper` the schema was built with, when one was configured. The translation
+     * matches selections against GraphQL type names, so a build that renames its types has to
+     * pass the same mapper here or nothing will match.
+     */
+    typeNameMapper?: TypeNameMapper;
+};
+/**
+ * Translates a GraphQL selection set into the relational query builder's `with` tree — the
+ * same translation the generated resolvers use for their own queries.
+ *
+ * A resolver that replaces a generated one has to return a row shaped like the type it
+ * replaced, and the field resolvers underneath only fill in relations the parent did not
+ * already provide. Reproducing that by hand means resolving fragments against
+ * `info.fragments`, intersecting selection names against the relations config (so scalars
+ * and consumer-added fields drop out instead of becoming invalid `with` keys), following
+ * aliases, compiling each relation's `where` / `orderBy` / `limit` / `offset` arguments into
+ * its nested entry, and leaving `<relation>Aggregate` selections out — they are not `with`
+ * entries at all. This does all of it.
+ *
+ * ```ts
+ * const withTree = selectionToWith(info, { db, table: 'Users' });
+ * const row = await tx.query.Users.findFirst({ where: { id: { eq } }, with: withTree });
+ * ```
+ *
+ * Returns `undefined` when the selection asks for no relations, which is the value the
+ * query builder wants for "no `with` clause".
+ */
+declare const selectionToWith: (info: GraphQLResolveInfo | ResolveTree, options: SelectionOptions) => Record<string, any> | undefined;
+/** Options for {@link resolveSelection} — the selection options plus the read itself. */
+type ResolveSelectionOptions = SelectionOptions & {
+    /**
+     * The transaction (or other drizzle executor) to read on. Defaults to `db`, so an override
+     * that has opened its own transaction passes it here to see its own uncommitted writes.
+     */
+    executor?: any;
+    /** Whether to return one row or a list. A single read ignores `limit`. */
+    single?: boolean;
+    /** The generated `where` argument, in the schema's filter DSL — compiled the same way. */
+    where?: any;
+    /** The generated `orderBy` argument. */
+    orderBy?: any;
+    limit?: number;
+    offset?: number;
+    /** The generated `after` cursor argument, for keyset pagination. */
+    after?: string;
+};
+/**
+ * Runs the read a generated select resolver would have run, against whichever executor is
+ * given — the whole body, not just the `with` tree: selected columns, relation arguments,
+ * eager loading, cursor pagination, and the transport remapping of the result.
+ *
+ * This is what an override usually wants after it has done its own work:
+ *
+ * ```ts
+ * const rows = await resolveSelection(info, { db, table: 'Users', where, executor: tx });
+ * ```
+ *
+ * Relation arguments and aggregate fields keep behaving as they do in the generated schema,
+ * because it is the generated schema's own code path.
+ */
+declare const resolveSelection: (info: GraphQLResolveInfo | ResolveTree, options: ResolveSelectionOptions) => Promise<any>;
+
 declare const buildSchema: <TDbClient extends AnyDrizzleDB<any>>(db: TDbClient, config?: BuildSchemaConfig) => GeneratedData<TDbClient>;
 
-export { type AggregateResolver, type AnyDrizzleDB, type BuildSchemaConfig, type ColumnDeprecator, type ColumnDescriber, type ColumnDocInfo, type ColumnTypeMapper, type ColumnTypeMapperInfo, type ComplexityConfig, type DeleteResolver, type DeleteSingleResolver, type EnumNameInfo, type EnumNameMapper, type ExtractRelations, type ExtractTableByName, type ExtractTableRelations, type ExtractTables, type FeatureSwitch, type GeneratedData, type GeneratedEntities, type GeneratedInputs, type GeneratedOutputs, GraphQLBigIntString, GraphQLDecimalString, type InsertArrResolver, type InsertResolver, type LimitsConfig, type MutationReturnlessResult, type MutationsCore, type QueriesCore, type RelationDescriber, type RelationResolverFactory, type ScalarOverride, type ScalarOverridesConfig, type SchemaDocs, type SchemaExclusions, type SchemaFeatures, type SelectResolver, type SelectSingleResolver, type TableDescriber, type TableLimitPolicy, type TableNamedRelations, type UpdateManyArgs, type UpdateManyEntry, type UpdateManyResolver, type UpdateResolver, type UpdateSingleResolver, type UpsertArgs, type UpsertArrResolver, type UpsertConflictArgs, type UpsertResolver, buildSchema, createRelationResolverFactory, defaultErrorMapper, drizzleExecutorKey, extractFilters, extractOrderBy, extractRelationJoinColumns, singularizeMapper };
+export { type AggregateResolver, type AnyDrizzleDB, type BuildSchemaConfig, type ColumnDeprecator, type ColumnDescriber, type ColumnDocInfo, type ColumnTypeMapper, type ColumnTypeMapperInfo, type ComplexityConfig, type ContextValuesConfig, type DeleteResolver, type DeleteSingleResolver, type DrizzleExtension, type DrizzleFieldExtension, type DrizzleFieldKind, type DrizzleFieldOperation, type DrizzleTargetArg, type DrizzleTypeExtension, type EnumNameInfo, type EnumNameMapper, type ExtractRelations, type ExtractTableByName, type ExtractTableRelations, type ExtractTables, type FeatureSwitch, type GeneratedData, type GeneratedEntities, type GeneratedInputs, type GeneratedOutputs, GraphQLBigIntString, GraphQLDecimalString, type IdentifiedRows, type InsertArrResolver, type InsertResolver, type LimitsConfig, type MutationReturnlessResult, type MutationsCore, type QueriesCore, type RelationDescriber, type RelationResolverFactory, type ResolveSelectionOptions, type RowScope, type RowScopeFilter, type ScalarOverride, type ScalarOverridesConfig, type SchemaDocs, type SchemaExclusions, type SchemaFeatures, type ScopeConfig, type SelectResolver, type SelectSingleResolver, type SelectionOptions, type TableDescriber, type TableLimitPolicy, type TableNamedRelations, type UpdateManyArgs, type UpdateManyEntry, type UpdateManyResolver, type UpdateResolver, type UpdateSingleResolver, type UpsertArgs, type UpsertArrResolver, type UpsertConflictArgs, type UpsertResolver, buildSchema, createRelationResolverFactory, defaultErrorMapper, drizzleExecutorKey, drizzleExtension, extractFilters, extractOrderBy, extractRelationJoinColumns, identifyRows, isDrizzleFieldExtension, resolveSelection, selectionToWith, singularizeMapper };