@vantreeseba/drizzle-graphql 7.7.0 → 7.8.0

package/dist/index.d.cts

@@ -237,6 +237,43 @@ type RelationResolverFactory = (params: {
  * both end up loaded in one process.
  */
 declare const drizzleExecutorKey: unique symbol;
+/** The write a hook is attached to. `restore` only exists for a soft-deleting table. */
+type WriteOperation = 'insert' | 'update' | 'updateMany' | 'upsert' | 'delete' | 'restore';
+/** What a write hook is handed. See {@link BuildSchemaConfig.onWrite}. */
+type WriteHookPayload = {
+    /** Drizzle schema key of the table being written. */
+    table: string;
+    operation: WriteOperation;
+    /** `'before'` runs ahead of the statement, `'after'` once it has returned. */
+    position: 'before' | 'after';
+    /** Whether the field writes a single row (`createUsersSingle`) or a list. */
+    single: boolean;
+    /** The field's GraphQL arguments, exactly as the resolver received them. */
+    args: any;
+    /**
+     * 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.
+     */
+    rows: any[];
+    context: any;
+    info: any;
+    /** The executor the mutation itself ran on. Throwing from the hook rolls it back. */
+    tx: any;
+};
+type WriteHook = (payload: WriteHookPayload) => void | Promise<void>;
+type WriteHookPositions = {
+    before?: WriteHook;
+    after?: WriteHook;
+};
+type WriteHooks = WriteHook | WriteHookPositions;
+/** Resolved, per-field hooks: `undefined` when the table registered none. */
+type ResolvedWriteHooks = {
+    before?: WriteHook;
+    after?: WriteHook;
+};
+/** Build-time lookup of a table's hooks, installed on {@link TablePolicies}. */
+type WriteHookFor = (tableName: string, operation: WriteOperation) => ResolvedWriteHooks | undefined;
 /**
  * Creates a RelationResolverFactory that generates field-level resolvers for each relation.
  * Each resolver:
@@ -360,6 +397,8 @@ type TablePolicies = {
     contextValues?: ContextValuesFor;
     /** See `BuildSchemaConfig.softDelete`. */
     softDelete?: SoftDeleteFor;
+    /** See `BuildSchemaConfig.onWrite`. */
+    onWrite?: WriteHookFor;
 };
 /**
  * Where a dialect's default sort places NULLs relative to non-NULL values:
@@ -759,8 +798,14 @@ type SchemaFeatures = {
      * Each relation field offers `create` and `connect`; the update input adds `disconnect`
      * and, for a to-many relation, `set` (replace the whole set). `disconnect` and `set` are
      * generated only when the foreign key is nullable — there is no way to detach a row whose
-     * key is NOT NULL — and many-to-many (`.through()`) relations are not written through at
-     * all. Nesting is one level deep: the row a nested `create` inserts takes columns only.
+     * key is NOT NULL. Nesting is one level deep: the row a nested `create` inserts takes
+     * columns only.
+     *
+     * A many-to-many (`.through()`) relation is written as junction rows: `connect` on the
+     * create input, and `connect` / `disconnect` / `set` on the update input, all
+     * unconditional, since unlinking deletes a junction row rather than nulling a column.
+     * It offers no `create` — inserting a row and linking it are two writes to two tables —
+     * and `set: []` clears the relation.
      *
      * The whole tree runs in one transaction (a savepoint when the request already carries
      * one), and a column a relation fills in (`authorId`, when `author: { create: … }` is
@@ -923,6 +968,13 @@ type SoftDeleteColumn = string | {
      */
     restoredValue?: any;
 };
+
+/**
+ * Write hooks, either applied to every table (a bare function, or an object naming the
+ * positions) or registered per table by Drizzle schema key. See
+ * {@link BuildSchemaConfig.onWrite}.
+ */
+type OnWriteConfig = WriteHooks | Record<string, WriteHooks>;
 /**
  * Per-table soft-delete declarations, either keyed by Drizzle schema key or as a rule applied
  * to every table. See {@link BuildSchemaConfig.softDelete}.
@@ -1265,6 +1317,39 @@ type BuildSchemaConfig = {
      * Marking a parent deleted does not mark its children — a cascade is a schema decision.
      */
     softDelete?: SoftDeleteConfig;
+    /**
+     * A hook that runs **inside the mutation's transaction**, so its writes commit or roll back
+     * with the mutation itself — the position an audit row, an outbox row, or a denormalized
+     * counter needs, and the one a `graphql-middleware` wrapper cannot occupy.
+     *
+     * ```ts
+     * buildSchema(db, {
+     *   onWrite: {
+     *     posts: async ({ table, operation, rows, tx }) => {
+     *       await tx.insert(auditLog).values(rows.map((row) => ({ table, operation, rowId: row.id })));
+     *     },
+     *   },
+     * });
+     * ```
+     *
+     * A bare function is the **`after`** hook — the position that has rows. `{ before, after }`
+     * names them explicitly; `before` receives the field's args ahead of the statement, for a
+     * check that has to read inside the same snapshot. Registering a bare function (or a
+     * positions object) at the top level applies it to every table; anything else is read as a
+     * table map keyed by Drizzle schema key, and an unknown name fails the build.
+     *
+     * - **`tx` is the executor the mutation ran on** — a caller-supplied executor under
+     *   `drizzleExecutorKey`, the request's auto-transaction, or, for a field that would
+     *   otherwise have run unwrapped, a transaction opened for it because the hook is there.
+     * - **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.
+     * - 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.
+     *
+     * Off by default, and a build without it opens exactly the transactions it did before.
+     */
+    onWrite?: OnWriteConfig;
     /**
      * Tables and columns to leave out of the generated schema entirely.
      *
@@ -1727,4 +1812,4 @@ declare const resolveSelection: (info: GraphQLResolveInfo | ResolveTree, options
 
 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 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 SoftDeleteColumn, type SoftDeleteConfig, 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 };
+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 OnWriteConfig, 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 SoftDeleteColumn, type SoftDeleteConfig, type TableDescriber, type TableLimitPolicy, type TableNamedRelations, 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, drizzleExecutorKey, drizzleExtension, extractFilters, extractOrderBy, extractRelationJoinColumns, identifyRows, isDrizzleFieldExtension, resolveSelection, selectionToWith, singularizeMapper };

package/dist/index.d.ts

@@ -237,6 +237,43 @@ type RelationResolverFactory = (params: {
  * both end up loaded in one process.
  */
 declare const drizzleExecutorKey: unique symbol;
+/** The write a hook is attached to. `restore` only exists for a soft-deleting table. */
+type WriteOperation = 'insert' | 'update' | 'updateMany' | 'upsert' | 'delete' | 'restore';
+/** What a write hook is handed. See {@link BuildSchemaConfig.onWrite}. */
+type WriteHookPayload = {
+    /** Drizzle schema key of the table being written. */
+    table: string;
+    operation: WriteOperation;
+    /** `'before'` runs ahead of the statement, `'after'` once it has returned. */
+    position: 'before' | 'after';
+    /** Whether the field writes a single row (`createUsersSingle`) or a list. */
+    single: boolean;
+    /** The field's GraphQL arguments, exactly as the resolver received them. */
+    args: any;
+    /**
+     * 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.
+     */
+    rows: any[];
+    context: any;
+    info: any;
+    /** The executor the mutation itself ran on. Throwing from the hook rolls it back. */
+    tx: any;
+};
+type WriteHook = (payload: WriteHookPayload) => void | Promise<void>;
+type WriteHookPositions = {
+    before?: WriteHook;
+    after?: WriteHook;
+};
+type WriteHooks = WriteHook | WriteHookPositions;
+/** Resolved, per-field hooks: `undefined` when the table registered none. */
+type ResolvedWriteHooks = {
+    before?: WriteHook;
+    after?: WriteHook;
+};
+/** Build-time lookup of a table's hooks, installed on {@link TablePolicies}. */
+type WriteHookFor = (tableName: string, operation: WriteOperation) => ResolvedWriteHooks | undefined;
 /**
  * Creates a RelationResolverFactory that generates field-level resolvers for each relation.
  * Each resolver:
@@ -360,6 +397,8 @@ type TablePolicies = {
     contextValues?: ContextValuesFor;
     /** See `BuildSchemaConfig.softDelete`. */
     softDelete?: SoftDeleteFor;
+    /** See `BuildSchemaConfig.onWrite`. */
+    onWrite?: WriteHookFor;
 };
 /**
  * Where a dialect's default sort places NULLs relative to non-NULL values:
@@ -759,8 +798,14 @@ type SchemaFeatures = {
      * Each relation field offers `create` and `connect`; the update input adds `disconnect`
      * and, for a to-many relation, `set` (replace the whole set). `disconnect` and `set` are
      * generated only when the foreign key is nullable — there is no way to detach a row whose
-     * key is NOT NULL — and many-to-many (`.through()`) relations are not written through at
-     * all. Nesting is one level deep: the row a nested `create` inserts takes columns only.
+     * key is NOT NULL. Nesting is one level deep: the row a nested `create` inserts takes
+     * columns only.
+     *
+     * A many-to-many (`.through()`) relation is written as junction rows: `connect` on the
+     * create input, and `connect` / `disconnect` / `set` on the update input, all
+     * unconditional, since unlinking deletes a junction row rather than nulling a column.
+     * It offers no `create` — inserting a row and linking it are two writes to two tables —
+     * and `set: []` clears the relation.
      *
      * The whole tree runs in one transaction (a savepoint when the request already carries
      * one), and a column a relation fills in (`authorId`, when `author: { create: … }` is
@@ -923,6 +968,13 @@ type SoftDeleteColumn = string | {
      */
     restoredValue?: any;
 };
+
+/**
+ * Write hooks, either applied to every table (a bare function, or an object naming the
+ * positions) or registered per table by Drizzle schema key. See
+ * {@link BuildSchemaConfig.onWrite}.
+ */
+type OnWriteConfig = WriteHooks | Record<string, WriteHooks>;
 /**
  * Per-table soft-delete declarations, either keyed by Drizzle schema key or as a rule applied
  * to every table. See {@link BuildSchemaConfig.softDelete}.
@@ -1265,6 +1317,39 @@ type BuildSchemaConfig = {
      * Marking a parent deleted does not mark its children — a cascade is a schema decision.
      */
     softDelete?: SoftDeleteConfig;
+    /**
+     * A hook that runs **inside the mutation's transaction**, so its writes commit or roll back
+     * with the mutation itself — the position an audit row, an outbox row, or a denormalized
+     * counter needs, and the one a `graphql-middleware` wrapper cannot occupy.
+     *
+     * ```ts
+     * buildSchema(db, {
+     *   onWrite: {
+     *     posts: async ({ table, operation, rows, tx }) => {
+     *       await tx.insert(auditLog).values(rows.map((row) => ({ table, operation, rowId: row.id })));
+     *     },
+     *   },
+     * });
+     * ```
+     *
+     * A bare function is the **`after`** hook — the position that has rows. `{ before, after }`
+     * names them explicitly; `before` receives the field's args ahead of the statement, for a
+     * check that has to read inside the same snapshot. Registering a bare function (or a
+     * positions object) at the top level applies it to every table; anything else is read as a
+     * table map keyed by Drizzle schema key, and an unknown name fails the build.
+     *
+     * - **`tx` is the executor the mutation ran on** — a caller-supplied executor under
+     *   `drizzleExecutorKey`, the request's auto-transaction, or, for a field that would
+     *   otherwise have run unwrapped, a transaction opened for it because the hook is there.
+     * - **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.
+     * - 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.
+     *
+     * Off by default, and a build without it opens exactly the transactions it did before.
+     */
+    onWrite?: OnWriteConfig;
     /**
      * Tables and columns to leave out of the generated schema entirely.
      *
@@ -1727,4 +1812,4 @@ declare const resolveSelection: (info: GraphQLResolveInfo | ResolveTree, options
 
 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 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 SoftDeleteColumn, type SoftDeleteConfig, 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 };
+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 OnWriteConfig, 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 SoftDeleteColumn, type SoftDeleteConfig, type TableDescriber, type TableLimitPolicy, type TableNamedRelations, 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, drizzleExecutorKey, drizzleExtension, extractFilters, extractOrderBy, extractRelationJoinColumns, identifyRows, isDrizzleFieldExtension, resolveSelection, selectionToWith, singularizeMapper };