@vantreeseba/drizzle-graphql 13.0.0 → 13.1.0

package/dist/index.d.cts

@@ -566,6 +566,23 @@ type EnumNameInfo = {
  * `BuildSchemaConfig.enumNameMapper`.
  */
 type EnumNameMapper = (info: EnumNameInfo) => string | undefined;
+/**
+ * Everything an {@link EnumValueNameMapper} needs to name one value of a generated enum: the
+ * value itself, plus the same context an {@link EnumNameMapper} gets for the enum around it.
+ */
+type EnumValueNameInfo = EnumNameInfo & {
+  /** The stored value being named. It stays the GraphQL value's internal `value` either way. */
+  value: string;
+  /** The value's position in {@link EnumNameInfo.values}. */
+  index: number;
+  /** The GraphQL type name the enum was given — after `enumNameMapper`, if there is one. */
+  typeName: string;
+};
+/**
+ * Names one value of a generated GraphQL enum. Return `undefined` to keep the default name.
+ * See `BuildSchemaConfig.enumValueNameMapper`.
+ */
+type EnumValueNameMapper = (info: EnumValueNameInfo) => string | undefined;
 /** Context handed to the documentation and deprecation hooks alongside the column itself. */
 type ColumnDocInfo = {
   /** The table's key in the Drizzle schema object. */
@@ -802,6 +819,10 @@ type WriteHookPayload = {
    * The rows the write produced, as the database returned them — before the output mapper,
    * so values are database-shaped. Empty at the `before` position, and on MySQL, whose
    * mutations return no rows.
+   *
+   * Each row holds the columns the client's selection asked for (plus any key a relation or
+   * nested write needed), **and** every column the hook names in `columns`. A column the
+   * client did not select and the hook did not name is absent.
    */
   rows: any[];
   context: any;
@@ -813,12 +834,26 @@ type WriteHook = (payload: WriteHookPayload) => void | Promise<void>;
 type WriteHookPositions = {
   before?: WriteHook;
   after?: WriteHook;
+  /**
+   * Columns the `after` hook's `rows` always carry, whatever the client selected: a list of
+   * column keys (the table object's property names, as `rows` is keyed), or `'all'` for
+   * every column of the table. They are added to the statement's `RETURNING` and taken back
+   * off before the result is mapped, so the client's response is unchanged.
+   *
+   * An unknown column fails the build, and so does `columns` without an `after` hook. On a
+   * top-level (every-table) registration a named column must exist on every table.
+   */
+  columns?: readonly string[] | 'all';
 };
 type WriteHooks = WriteHook | WriteHookPositions;
-/** Resolved, per-field hooks: `undefined` when the table registered none. */
+/**
+ * Resolved, per-field hooks: `undefined` when the table registered none. `columns` is the
+ * hook's `columns` resolved against the table, or `undefined` when it named none.
+ */
 type ResolvedWriteHooks = {
   before?: WriteHook;
   after?: WriteHook;
+  columns?: Record<string, Column>;
 };
 /** Build-time lookup of a table's hooks, installed on {@link TablePolicies}. */
 type WriteHookFor = (tableName: string, operation: WriteOperation) => ResolvedWriteHooks | undefined;
@@ -2038,8 +2073,12 @@ type BuildSchemaConfig = {
    * ```ts
    * buildSchema(db, {
    *   onWrite: {
-   *     posts: async ({ table, operation, rows, tx }) => {
-   *       await tx.insert(auditLog).values(rows.map((row) => ({ table, operation, rowId: row.id })));
+   *     posts: {
+   *       after: async ({ table, operation, rows, tx }) => {
+   *         await tx.insert(auditLog).values(rows.map((row) => ({ table, operation, rowId: row.id })));
+   *       },
+   *       // `rows` always carries `id`, whether or not the client selected it.
+   *       columns: ['id'],
    *     },
    *   },
    * });
@@ -2057,6 +2096,13 @@ type BuildSchemaConfig = {
    * - **Throwing rolls the mutation back.** That is the point of the position.
    * - **`rows` are the post-write rows as the database returned them**, before the output
    *   mapper. Empty at the `before` position, and on MySQL, whose mutations return no rows.
+   * - **A row holds the columns the client selected**, because `RETURNING` is built from the
+   *   selection — plus every column the registration names in `columns` (column keys, or
+   *   `'all'`). Those are added to `RETURNING` for insert, upsert, update, `updateMany`, delete
+   *   and restore, and taken back off before the result is mapped, so the client's response
+   *   is unchanged. An unknown column, or `columns` with no `after` hook, fails the build; on
+   *   a top-level registration a named column must exist on every table. MySQL returns no
+   *   rows, so `columns` has no effect there.
    * - The hook fires for the **mutation field's own table**. Rows a nested write creates in
    *   another table do not fire that table's hook.
    *
@@ -2380,6 +2426,35 @@ type BuildSchemaConfig = {
    * Return `undefined` to keep the default name.
    */
   enumNameMapper?: EnumNameMapper;
+  /**
+   * Names the *values* of the generated GraphQL enum types.
+   *
+   * By default a value's GraphQL name is the stored value itself (`'running'` → `running`),
+   * or `Option<index>` when the stored value is not a usable GraphQL name. This hook overrides
+   * that per value — most often to follow GraphQL's SCREAMING_CASE convention while the
+   * database keeps its lowercase values:
+   *
+   * ```ts
+   * buildSchema(db, {
+   *   enumValueNameMapper: ({ value }) => value.toUpperCase(),
+   * });
+   * // enum RunsStatusEnum { RUNNING OK ERROR STOPPED }
+   * ```
+   *
+   * Only the GraphQL name changes. Each value's internal `value` stays the stored string, so
+   * filters, create/update inputs, outputs and resolvers keep sending and receiving exactly
+   * what the database stores; the generated TypeScript types keep the stored values too.
+   *
+   * Pass the string `'constant'` for the built-in preset, which CONSTANT_CASEs every value
+   * (`inProgress` / `in-progress` → `IN_PROGRESS`).
+   *
+   * The mapper receives the stored `value`, its `index`, the enum's GraphQL `typeName` (after
+   * `enumNameMapper`), and everything `enumNameMapper` receives. Return `undefined` to keep the
+   * default name for that value. The build throws when a returned name is not a valid GraphQL
+   * enum value name, when two values of one enum map to the same name, or when columns sharing
+   * one enum type would name its values differently.
+   */
+  enumValueNameMapper?: 'constant' | EnumValueNameMapper;
 };
 //#endregion
 //#region src/util/case-ops/index.d.ts
@@ -2499,5 +2574,5 @@ declare const resolveSelection: (info: GraphQLResolveInfo | ResolveTree, options
 //#region src/index.d.ts
 declare const buildSchema: <TDbClient extends AnyDrizzleDB<any>, TConfig extends BuildSchemaConfig = BuildSchemaConfig>(db: TDbClient, config?: TConfig) => GeneratedData<TDbClient, NamingOf<TConfig>>;
 //#endregion
-export { type AggregateResolver, type AnyDrizzleDB, type BuildSchemaConfig, type ColumnDeprecator, type ColumnDescriber, type ColumnDocInfo, type ColumnTypeMapper, type ColumnTypeMapperInfo, type ComplexityConfig, type ContextValuesConfig, type DefaultOrderByEntry, type DefaultsConfig, type DeleteResolver, type DeleteSingleResolver, type DerivedTypeNameMapper, type DrizzleErrorCode, type DrizzleErrorContext, 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 FieldsByTypeName, type GeneratedData, type GeneratedEntities, type GeneratedInputs, type GeneratedOutputs, type GeneratedTypeInfo, type GeneratedTypeKind, GraphQLBigIntString, GraphQLDate, GraphQLDateTime, GraphQLDecimalString, GraphQLJSON, GraphQLUUID, type IdentifiedRows, type InsertArrResolver, type InsertResolver, type LimitsConfig, type MutationReturnlessResult, type MutationsCore, type NamingOf, type OnWriteConfig, type ParseResolveInfoOptions, type Pluralize, type QueriesCore, type RelationDescriber, type RelationResolverFactory, type ResolveSelectionOptions, type ResolveTree, type RowScope, type RowScopeFilter, type ScalarOverride, type ScalarOverridesConfig, type SchemaDocs, type SchemaExclusions, type SchemaFeatures, type ScopeConfig, type SelectResolver, type SelectSingleResolver, type SelectionOptions, type Singularize, type SoftDeleteColumn, type SoftDeleteConfig, type TableDefaults, type TableDescriber, type TableLimitPolicy, type TableNamedRelations, type TypeNameMapper, type TypeNaming, type UpdateManyArgs, type UpdateManyEntry, type UpdateManyResolver, type UpdateResolver, type UpdateSingleResolver, type UpsertArgs, type UpsertArrResolver, type UpsertConflictArgs, type UpsertResolver, type WriteHook, type WriteHookPayload, type WriteHookPositions, type WriteHooks, type WriteOperation, buildSchema, createRelationResolverFactory, defaultErrorMapper, drizzleError, drizzleExecutorKey, drizzleExtension, extractFilters, extractOrderBy, extractRelationJoinColumns, identifyRows, isDrizzleFieldExtension, parseResolveInfo, resolveSelection, selectionToWith, singularizeMapper };
+export { type AggregateResolver, type AnyDrizzleDB, type BuildSchemaConfig, type ColumnDeprecator, type ColumnDescriber, type ColumnDocInfo, type ColumnTypeMapper, type ColumnTypeMapperInfo, type ComplexityConfig, type ContextValuesConfig, type DefaultOrderByEntry, type DefaultsConfig, type DeleteResolver, type DeleteSingleResolver, type DerivedTypeNameMapper, type DrizzleErrorCode, type DrizzleErrorContext, type DrizzleExtension, type DrizzleFieldExtension, type DrizzleFieldKind, type DrizzleFieldOperation, type DrizzleTargetArg, type DrizzleTypeExtension, type EnumNameInfo, type EnumNameMapper, type EnumValueNameInfo, type EnumValueNameMapper, type ExtractRelations, type ExtractTableByName, type ExtractTableRelations, type ExtractTables, type FeatureSwitch, type FieldsByTypeName, type GeneratedData, type GeneratedEntities, type GeneratedInputs, type GeneratedOutputs, type GeneratedTypeInfo, type GeneratedTypeKind, GraphQLBigIntString, GraphQLDate, GraphQLDateTime, GraphQLDecimalString, GraphQLJSON, GraphQLUUID, type IdentifiedRows, type InsertArrResolver, type InsertResolver, type LimitsConfig, type MutationReturnlessResult, type MutationsCore, type NamingOf, type OnWriteConfig, type ParseResolveInfoOptions, type Pluralize, type QueriesCore, type RelationDescriber, type RelationResolverFactory, type ResolveSelectionOptions, type ResolveTree, type RowScope, type RowScopeFilter, type ScalarOverride, type ScalarOverridesConfig, type SchemaDocs, type SchemaExclusions, type SchemaFeatures, type ScopeConfig, type SelectResolver, type SelectSingleResolver, type SelectionOptions, type Singularize, type SoftDeleteColumn, type SoftDeleteConfig, type TableDefaults, type TableDescriber, type TableLimitPolicy, type TableNamedRelations, type TypeNameMapper, type TypeNaming, type UpdateManyArgs, type UpdateManyEntry, type UpdateManyResolver, type UpdateResolver, type UpdateSingleResolver, type UpsertArgs, type UpsertArrResolver, type UpsertConflictArgs, type UpsertResolver, type WriteHook, type WriteHookPayload, type WriteHookPositions, type WriteHooks, type WriteOperation, buildSchema, createRelationResolverFactory, defaultErrorMapper, drizzleError, drizzleExecutorKey, drizzleExtension, extractFilters, extractOrderBy, extractRelationJoinColumns, identifyRows, isDrizzleFieldExtension, parseResolveInfo, resolveSelection, selectionToWith, singularizeMapper };
 //# sourceMappingURL=index.d.cts.map

package/dist/index.d.ts

@@ -566,6 +566,23 @@ type EnumNameInfo = {
  * `BuildSchemaConfig.enumNameMapper`.
  */
 type EnumNameMapper = (info: EnumNameInfo) => string | undefined;
+/**
+ * Everything an {@link EnumValueNameMapper} needs to name one value of a generated enum: the
+ * value itself, plus the same context an {@link EnumNameMapper} gets for the enum around it.
+ */
+type EnumValueNameInfo = EnumNameInfo & {
+  /** The stored value being named. It stays the GraphQL value's internal `value` either way. */
+  value: string;
+  /** The value's position in {@link EnumNameInfo.values}. */
+  index: number;
+  /** The GraphQL type name the enum was given — after `enumNameMapper`, if there is one. */
+  typeName: string;
+};
+/**
+ * Names one value of a generated GraphQL enum. Return `undefined` to keep the default name.
+ * See `BuildSchemaConfig.enumValueNameMapper`.
+ */
+type EnumValueNameMapper = (info: EnumValueNameInfo) => string | undefined;
 /** Context handed to the documentation and deprecation hooks alongside the column itself. */
 type ColumnDocInfo = {
   /** The table's key in the Drizzle schema object. */
@@ -802,6 +819,10 @@ type WriteHookPayload = {
    * The rows the write produced, as the database returned them — before the output mapper,
    * so values are database-shaped. Empty at the `before` position, and on MySQL, whose
    * mutations return no rows.
+   *
+   * Each row holds the columns the client's selection asked for (plus any key a relation or
+   * nested write needed), **and** every column the hook names in `columns`. A column the
+   * client did not select and the hook did not name is absent.
    */
   rows: any[];
   context: any;
@@ -813,12 +834,26 @@ type WriteHook = (payload: WriteHookPayload) => void | Promise<void>;
 type WriteHookPositions = {
   before?: WriteHook;
   after?: WriteHook;
+  /**
+   * Columns the `after` hook's `rows` always carry, whatever the client selected: a list of
+   * column keys (the table object's property names, as `rows` is keyed), or `'all'` for
+   * every column of the table. They are added to the statement's `RETURNING` and taken back
+   * off before the result is mapped, so the client's response is unchanged.
+   *
+   * An unknown column fails the build, and so does `columns` without an `after` hook. On a
+   * top-level (every-table) registration a named column must exist on every table.
+   */
+  columns?: readonly string[] | 'all';
 };
 type WriteHooks = WriteHook | WriteHookPositions;
-/** Resolved, per-field hooks: `undefined` when the table registered none. */
+/**
+ * Resolved, per-field hooks: `undefined` when the table registered none. `columns` is the
+ * hook's `columns` resolved against the table, or `undefined` when it named none.
+ */
 type ResolvedWriteHooks = {
   before?: WriteHook;
   after?: WriteHook;
+  columns?: Record<string, Column>;
 };
 /** Build-time lookup of a table's hooks, installed on {@link TablePolicies}. */
 type WriteHookFor = (tableName: string, operation: WriteOperation) => ResolvedWriteHooks | undefined;
@@ -2038,8 +2073,12 @@ type BuildSchemaConfig = {
    * ```ts
    * buildSchema(db, {
    *   onWrite: {
-   *     posts: async ({ table, operation, rows, tx }) => {
-   *       await tx.insert(auditLog).values(rows.map((row) => ({ table, operation, rowId: row.id })));
+   *     posts: {
+   *       after: async ({ table, operation, rows, tx }) => {
+   *         await tx.insert(auditLog).values(rows.map((row) => ({ table, operation, rowId: row.id })));
+   *       },
+   *       // `rows` always carries `id`, whether or not the client selected it.
+   *       columns: ['id'],
    *     },
    *   },
    * });
@@ -2057,6 +2096,13 @@ type BuildSchemaConfig = {
    * - **Throwing rolls the mutation back.** That is the point of the position.
    * - **`rows` are the post-write rows as the database returned them**, before the output
    *   mapper. Empty at the `before` position, and on MySQL, whose mutations return no rows.
+   * - **A row holds the columns the client selected**, because `RETURNING` is built from the
+   *   selection — plus every column the registration names in `columns` (column keys, or
+   *   `'all'`). Those are added to `RETURNING` for insert, upsert, update, `updateMany`, delete
+   *   and restore, and taken back off before the result is mapped, so the client's response
+   *   is unchanged. An unknown column, or `columns` with no `after` hook, fails the build; on
+   *   a top-level registration a named column must exist on every table. MySQL returns no
+   *   rows, so `columns` has no effect there.
    * - The hook fires for the **mutation field's own table**. Rows a nested write creates in
    *   another table do not fire that table's hook.
    *
@@ -2380,6 +2426,35 @@ type BuildSchemaConfig = {
    * Return `undefined` to keep the default name.
    */
   enumNameMapper?: EnumNameMapper;
+  /**
+   * Names the *values* of the generated GraphQL enum types.
+   *
+   * By default a value's GraphQL name is the stored value itself (`'running'` → `running`),
+   * or `Option<index>` when the stored value is not a usable GraphQL name. This hook overrides
+   * that per value — most often to follow GraphQL's SCREAMING_CASE convention while the
+   * database keeps its lowercase values:
+   *
+   * ```ts
+   * buildSchema(db, {
+   *   enumValueNameMapper: ({ value }) => value.toUpperCase(),
+   * });
+   * // enum RunsStatusEnum { RUNNING OK ERROR STOPPED }
+   * ```
+   *
+   * Only the GraphQL name changes. Each value's internal `value` stays the stored string, so
+   * filters, create/update inputs, outputs and resolvers keep sending and receiving exactly
+   * what the database stores; the generated TypeScript types keep the stored values too.
+   *
+   * Pass the string `'constant'` for the built-in preset, which CONSTANT_CASEs every value
+   * (`inProgress` / `in-progress` → `IN_PROGRESS`).
+   *
+   * The mapper receives the stored `value`, its `index`, the enum's GraphQL `typeName` (after
+   * `enumNameMapper`), and everything `enumNameMapper` receives. Return `undefined` to keep the
+   * default name for that value. The build throws when a returned name is not a valid GraphQL
+   * enum value name, when two values of one enum map to the same name, or when columns sharing
+   * one enum type would name its values differently.
+   */
+  enumValueNameMapper?: 'constant' | EnumValueNameMapper;
 };
 //#endregion
 //#region src/util/case-ops/index.d.ts
@@ -2499,5 +2574,5 @@ declare const resolveSelection: (info: GraphQLResolveInfo | ResolveTree, options
 //#region src/index.d.ts
 declare const buildSchema: <TDbClient extends AnyDrizzleDB<any>, TConfig extends BuildSchemaConfig = BuildSchemaConfig>(db: TDbClient, config?: TConfig) => GeneratedData<TDbClient, NamingOf<TConfig>>;
 //#endregion
-export { type AggregateResolver, type AnyDrizzleDB, type BuildSchemaConfig, type ColumnDeprecator, type ColumnDescriber, type ColumnDocInfo, type ColumnTypeMapper, type ColumnTypeMapperInfo, type ComplexityConfig, type ContextValuesConfig, type DefaultOrderByEntry, type DefaultsConfig, type DeleteResolver, type DeleteSingleResolver, type DerivedTypeNameMapper, type DrizzleErrorCode, type DrizzleErrorContext, 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 FieldsByTypeName, type GeneratedData, type GeneratedEntities, type GeneratedInputs, type GeneratedOutputs, type GeneratedTypeInfo, type GeneratedTypeKind, GraphQLBigIntString, GraphQLDate, GraphQLDateTime, GraphQLDecimalString, GraphQLJSON, GraphQLUUID, type IdentifiedRows, type InsertArrResolver, type InsertResolver, type LimitsConfig, type MutationReturnlessResult, type MutationsCore, type NamingOf, type OnWriteConfig, type ParseResolveInfoOptions, type Pluralize, type QueriesCore, type RelationDescriber, type RelationResolverFactory, type ResolveSelectionOptions, type ResolveTree, type RowScope, type RowScopeFilter, type ScalarOverride, type ScalarOverridesConfig, type SchemaDocs, type SchemaExclusions, type SchemaFeatures, type ScopeConfig, type SelectResolver, type SelectSingleResolver, type SelectionOptions, type Singularize, type SoftDeleteColumn, type SoftDeleteConfig, type TableDefaults, type TableDescriber, type TableLimitPolicy, type TableNamedRelations, type TypeNameMapper, type TypeNaming, type UpdateManyArgs, type UpdateManyEntry, type UpdateManyResolver, type UpdateResolver, type UpdateSingleResolver, type UpsertArgs, type UpsertArrResolver, type UpsertConflictArgs, type UpsertResolver, type WriteHook, type WriteHookPayload, type WriteHookPositions, type WriteHooks, type WriteOperation, buildSchema, createRelationResolverFactory, defaultErrorMapper, drizzleError, drizzleExecutorKey, drizzleExtension, extractFilters, extractOrderBy, extractRelationJoinColumns, identifyRows, isDrizzleFieldExtension, parseResolveInfo, resolveSelection, selectionToWith, singularizeMapper };
+export { type AggregateResolver, type AnyDrizzleDB, type BuildSchemaConfig, type ColumnDeprecator, type ColumnDescriber, type ColumnDocInfo, type ColumnTypeMapper, type ColumnTypeMapperInfo, type ComplexityConfig, type ContextValuesConfig, type DefaultOrderByEntry, type DefaultsConfig, type DeleteResolver, type DeleteSingleResolver, type DerivedTypeNameMapper, type DrizzleErrorCode, type DrizzleErrorContext, type DrizzleExtension, type DrizzleFieldExtension, type DrizzleFieldKind, type DrizzleFieldOperation, type DrizzleTargetArg, type DrizzleTypeExtension, type EnumNameInfo, type EnumNameMapper, type EnumValueNameInfo, type EnumValueNameMapper, type ExtractRelations, type ExtractTableByName, type ExtractTableRelations, type ExtractTables, type FeatureSwitch, type FieldsByTypeName, type GeneratedData, type GeneratedEntities, type GeneratedInputs, type GeneratedOutputs, type GeneratedTypeInfo, type GeneratedTypeKind, GraphQLBigIntString, GraphQLDate, GraphQLDateTime, GraphQLDecimalString, GraphQLJSON, GraphQLUUID, type IdentifiedRows, type InsertArrResolver, type InsertResolver, type LimitsConfig, type MutationReturnlessResult, type MutationsCore, type NamingOf, type OnWriteConfig, type ParseResolveInfoOptions, type Pluralize, type QueriesCore, type RelationDescriber, type RelationResolverFactory, type ResolveSelectionOptions, type ResolveTree, type RowScope, type RowScopeFilter, type ScalarOverride, type ScalarOverridesConfig, type SchemaDocs, type SchemaExclusions, type SchemaFeatures, type ScopeConfig, type SelectResolver, type SelectSingleResolver, type SelectionOptions, type Singularize, type SoftDeleteColumn, type SoftDeleteConfig, type TableDefaults, type TableDescriber, type TableLimitPolicy, type TableNamedRelations, type TypeNameMapper, type TypeNaming, type UpdateManyArgs, type UpdateManyEntry, type UpdateManyResolver, type UpdateResolver, type UpdateSingleResolver, type UpsertArgs, type UpsertArrResolver, type UpsertConflictArgs, type UpsertResolver, type WriteHook, type WriteHookPayload, type WriteHookPositions, type WriteHooks, type WriteOperation, buildSchema, createRelationResolverFactory, defaultErrorMapper, drizzleError, drizzleExecutorKey, drizzleExtension, extractFilters, extractOrderBy, extractRelationJoinColumns, identifyRows, isDrizzleFieldExtension, parseResolveInfo, resolveSelection, selectionToWith, singularizeMapper };
 //# sourceMappingURL=index.d.ts.map