@vantreeseba/drizzle-graphql 7.3.0 → 7.4.0

package/dist/index.d.cts

@@ -632,27 +632,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 +672,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 +682,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 +740,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 +759,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 +770,7 @@ type SchemaFeatures = {
      *
      * @default false
      */
-    requireWhere?: boolean;
+    requireWhere?: FeatureSwitch;
 };
 /**
  * Per-field cost hints for `graphql-query-complexity` (or any estimator that reads
@@ -912,11 +924,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 +942,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 +1082,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 +1296,25 @@ 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;
+};
+
 /**
  * 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
@@ -1264,4 +1332,4 @@ declare const GraphQLDecimalString: GraphQLScalarType<string, string>;
 
 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 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 };

package/dist/index.d.ts

@@ -632,27 +632,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 +672,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 +682,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 +740,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 +759,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 +770,7 @@ type SchemaFeatures = {
      *
      * @default false
      */
-    requireWhere?: boolean;
+    requireWhere?: FeatureSwitch;
 };
 /**
  * Per-field cost hints for `graphql-query-complexity` (or any estimator that reads
@@ -912,11 +924,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 +942,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 +1082,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 +1296,25 @@ 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;
+};
+
 /**
  * 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
@@ -1264,4 +1332,4 @@ declare const GraphQLDecimalString: GraphQLScalarType<string, string>;
 
 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 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 };