@vantreeseba/drizzle-graphql 7.3.0 → 7.5.0

package/dist/index.d.ts

@@ -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
@@ -632,27 +638,39 @@ type GeneratedData<TDatabase extends AnyDrizzleDB<any>> = {
     entities: GeneratedEntities<TDatabase>;
 };
 /**
- * Per-feature switches for what `buildSchema` generates. Every flag defaults to `true`.
+ * A feature switch. `true` / `false` decides for the whole build; a predicate decides per
+ * table, receiving the table's key in the Drizzle schema.
+ *
+ * ```ts
+ * features: { delete: (table) => table !== 'auditLog' }
+ * ```
+ */
+type FeatureSwitch = boolean | ((tableName: string) => boolean);
+/**
+ * Per-feature switches for what `buildSchema` generates. Every flag defaults to `true` except
+ * `upsert`, `nestedWrites`, `fieldUpdateOperations`, `countMutations` and `requireWhere`.
+ * Each one takes a boolean or a per-table predicate, apart from `nestedWrites`, which is
+ * build-wide.
  * See {@link BuildSchemaConfig.features}.
  */
 type SchemaFeatures = {
     /** `<plural>Aggregate` root queries and the aggregate output types. @default true */
-    aggregates?: boolean;
+    aggregates?: FeatureSwitch;
     /**
      * `<plural>GroupBy` root queries — the same aggregates, one row per group. Requires
      * `aggregates`, whose output types the grouped result reuses.
      *
      * @default true
      */
-    groupBy?: boolean;
+    groupBy?: FeatureSwitch;
     /** `<relation>Aggregate` fields on object types, for to-many relations. @default true */
-    relationAggregates?: boolean;
+    relationAggregates?: FeatureSwitch;
     /** The `distinct` argument on list queries. @default true */
-    distinct?: boolean;
+    distinct?: FeatureSwitch;
     /** `create<Table>` / `create<Table>Single` mutations. @default true */
-    insert?: boolean;
+    insert?: FeatureSwitch;
     /** `update<Table>` / `update<Table>Single` mutations. @default true */
-    update?: boolean;
+    update?: FeatureSwitch;
     /**
      * `update<Table>Many` mutations — batch update with a per-entry `set` and `where`,
      * executed inside one transaction. Only generated when `update` is also enabled,
@@ -660,9 +678,9 @@ type SchemaFeatures = {
      *
      * @default true
      */
-    updateMany?: boolean;
+    updateMany?: FeatureSwitch;
     /** `delete<Table>` / `delete<Table>Single` mutations. @default true */
-    delete?: boolean;
+    delete?: FeatureSwitch;
     /**
      * `upsert<Table>` / `upsert<Table>Single` mutations — insert, or update the row that
      * already holds the same unique key. Off unless asked for, so an existing schema does
@@ -670,7 +688,7 @@ type SchemaFeatures = {
      *
      * @default false
      */
-    upsert?: boolean;
+    upsert?: FeatureSwitch;
     /**
      * Relation fields on `Create<Table>Input` and `Update<Table>Input`, so a parent row and
      * the rows it is related to can be written in one mutation. Off unless asked for: it adds
@@ -728,7 +746,7 @@ type SchemaFeatures = {
      *
      * @default false
      */
-    fieldUpdateOperations?: boolean;
+    fieldUpdateOperations?: FeatureSwitch;
     /**
      * `update<Table>Count` / `delete<Table>Count` mutations — the same write as the plural
      * `update<Table>` / `delete<Table>`, returning the number of rows affected instead of the
@@ -747,7 +765,7 @@ type SchemaFeatures = {
      *
      * @default false
      */
-    countMutations?: boolean;
+    countMutations?: FeatureSwitch;
     /**
      * Makes `where` non-null on the plural `update<Table>` / `delete<Table>` mutations, and
      * rejects a `where` that collapses to no filters (e.g. `where: {}`), so a schema can rule
@@ -758,7 +776,7 @@ type SchemaFeatures = {
      *
      * @default false
      */
-    requireWhere?: boolean;
+    requireWhere?: FeatureSwitch;
 };
 /**
  * Per-field cost hints for `graphql-query-complexity` (or any estimator that reads
@@ -912,11 +930,11 @@ type BuildSchemaConfig = {
      */
     complexity?: boolean | ComplexityConfig;
     /**
-     * Turns individual generated features off.
+     * Turns individual generated features off, for the whole build or per table.
      *
-     * Every flag defaults to `true` except `upsert`, which is opt-in: a build with no
-     * `features` block generates exactly what it generated before this option existed.
-     * Turning one off removes both the schema surface it adds and the work behind it.
+     * Every flag defaults to `true` except `upsert` and `nestedWrites`, which are opt-in: a
+     * build with no `features` block generates exactly what it generated before this option
+     * existed. Turning one off removes both the schema surface it adds and the work behind it.
      *
      * ```ts
      * buildSchema(db, {
@@ -930,9 +948,34 @@ type BuildSchemaConfig = {
      * });
      * ```
      *
-     * Turning off every mutation feature omits the `Mutation` type entirely, exactly as
-     * `mutations: false` does. Query-side features can all be off — the list and single
-     * queries are always generated, so `Query` is never empty.
+     * Any flag may instead be a predicate, which is asked once per table with the table's key
+     * in the Drizzle schema — the usual case, where a handful of tables must not be written
+     * through the API and the rest want the full set:
+     *
+     * ```ts
+     * buildSchema(db, {
+     *   features: {
+     *     delete: (table) => table !== 'auditLog',
+     *     update: (table) => !ownedByCustomResolver.has(table),
+     *     upsert: (table) => table === 'settings',
+     *   },
+     * });
+     * ```
+     *
+     * A table that generates nothing at all belongs in {@link BuildSchemaConfig.exclude}; this
+     * decides which operations a table that *is* in the schema offers. `nestedWrites` is the one
+     * flag that stays build-wide: its plans are computed once over the whole relation graph, and
+     * a nested write reaches a second table by definition.
+     *
+     * Some operations are built out of others — an upsert writes through insert and update, a
+     * batch update reuses the update input, a grouped query reuses the aggregate types. Flags
+     * that contradict those implications warn on the console at build time (naming the tables)
+     * rather than leaving a second write path past the operation you turned off to be found
+     * later.
+     *
+     * Turning off every mutation feature for every table omits the `Mutation` type entirely,
+     * exactly as `mutations: false` does. Query-side features can all be off — the list and
+     * single queries are always generated, so `Query` is never empty.
      */
     features?: SchemaFeatures;
     /**
@@ -1045,11 +1088,23 @@ type BuildSchemaConfig = {
      * Example: `(name) => name === 'users' ? { singular: 'user', plural: 'users' } : undefined`
      * produces type `User`, queries `users` / `user`, mutations `createUsers` / `createUser` for
      * the `users` table, and leaves other tables with their default names.
+     *
+     * Pass the string `'singularize'` for the built-in preset, which derives both forms of every
+     * table key with the library's own `pluralize` — the mapper most schemas with plural table
+     * keys would otherwise write by hand:
+     *
+     * ```ts
+     * buildSchema(db, { typeNameMapper: 'singularize' });
+     * // tasks -> type Task, queries `tasks` / `task`, mutations `createTasks` / `createTask`
+     * ```
+     *
+     * The same function is exported as `singularizeMapper` for wrapping — e.g. to keep one
+     * table's names as they are: `(t) => (t === 'audit_log' ? undefined : singularizeMapper(t))`.
      */
-    typeNameMapper?: (tableName: string) => {
+    typeNameMapper?: 'singularize' | ((tableName: string) => {
         singular: string;
         plural: string;
-    } | undefined;
+    } | undefined);
     /**
      * Controls whether a relation is eagerly pre-fetched via Drizzle's `with:` clause
      * when its parent is loaded through a generated query or mutation.
@@ -1247,6 +1302,129 @@ type BuildSchemaConfig = {
     enumNameMapper?: EnumNameMapper;
 };
 
+/**
+ * The `typeNameMapper` preset behind `typeNameMapper: 'singularize'`.
+ *
+ * Derives the singular and plural forms of a table key with the library's own `pluralize`,
+ * which is what nearly every consumer with plural table keys (`export const tasks =
+ * pgTable('tasks', …)`) was writing by hand — and adding `pluralize` to their own
+ * dependencies to write.
+ *
+ * `tasks` becomes type `Task`, queries `tasks` / `task`, mutations `createTasks` /
+ * `createTask`. A key that is already singular is pluralized for the list side, so `task`
+ * yields the same names, and a capitalized key (`Tasks`) yields them too — the field forms
+ * are uncapitalized so the generated names follow GraphQL's camelCase convention whatever
+ * the schema key looks like. The type name is capitalized by the generator either way.
+ */
+declare const singularizeMapper: (tableName: string) => {
+    singular: 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
@@ -1262,6 +1440,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 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 };
+export { type AggregateResolver, type AnyDrizzleDB, type BuildSchemaConfig, type ColumnDeprecator, type ColumnDescriber, type ColumnDocInfo, type ColumnTypeMapper, type ColumnTypeMapperInfo, type ComplexityConfig, 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 ScalarOverride, type ScalarOverridesConfig, type SchemaDocs, type SchemaExclusions, type SchemaFeatures, 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 };