@vantreeseba/drizzle-graphql 13.1.0 → 13.1.1

package/README.md

@@ -1623,9 +1623,27 @@ mutation {
 -   Both return `Int!` — the number of rows the write affected — and add no new output type
     to the schema
 -   Arguments are exactly the plural mutation's, so a client swaps one field name for the
-    other; `features.requireWhere` applies to them the same way
+    other; `features.requireWhere` applies to them the same way, and on a soft-deleting
+    table that opted into `hardDelete` the delete takes `hard` too
 -   They follow the feature switch of the write they mirror: `updateCount` needs
     `features.update`, `deleteCount` needs `features.delete`
+-   They obey the same row policies as the plural write — only the answer differs:
+    -   [`scope`](#row-scoping-and-multi-tenancy) is ANDed into the `where`, so they reach,
+        and count, only in-scope rows
+    -   on a [soft-deleting](#soft-delete) table `delete<Table>Count` marks the rows rather
+        than removing them, and neither mutation reaches a row that is already marked
+    -   a [`contextValues`](#row-scoping-and-multi-tenancy) column is never reassigned by the
+        update
+    -   [`onWrite`](#write-hooks) hooks run `before` and `after`, in a transaction, with the
+        plural write's payload (`operation: 'update'` / `'delete'`, `single: false`). An
+        `after` hook is handed rows, so a table with one gives up the returnless write: the
+        statement `RETURNING`s the hook's `columns`, or just the primary key when it names
+        none (every column, on a table without a key), and the count is the number of rows
+        returned. Without an `after` hook there is no `RETURNING` at all. On MySQL the hook
+        gets `rows: []`, as it does on every MySQL mutation
+-   Their [`extensions.drizzle`](#identifying-generated-fields) is the plural write's
+    (`operation: 'update'` / `'delete'`, `targetArg: 'where'`) plus `count: true`, so a
+    wrapper that gates writes on `operation` covers them too
 -   **MySQL** gets them too, and they are arguably most useful there: MySQL's other mutations
     return only `MutationReturn { isSuccess }`, so a row count is strictly more information
 -   `update<Table>Count` **rejects** nested writes with a `GraphQLError` — a nested write
@@ -2122,6 +2140,9 @@ onWrite: {
     works.
 -   The columns are added to `RETURNING` for every write the hook is attached to: insert, upsert,
     update, `updateMany`, delete and restore. A delete's rows are the rows it removed.
+-   The [count mutations](#row-counts-instead-of-rows) fire the hooks as `update` / `delete`.
+    The client selects nothing there, so an `after` hook's rows hold exactly its `columns`, or
+    just the primary key when it names none — the one `RETURNING` those mutations pay for.
 -   **The client's response is unchanged.** Columns the hook asked for but the client did not
     select are taken back off before the rows are mapped, so they reach neither the response nor
     a custom resolver calling the generated one. The hook gets its own copy of the rows.
@@ -2329,7 +2350,9 @@ the check to make before treating a field as one of ours. Relation fields (and
 naming the relation's **target** — so `Users.posts` reads as
 `{ table: 'Posts', parentTable: 'Users', relation: 'posts' }`. Object types carry
 `{ table, kind: 'type', primaryKey }`, which is what a stitching layer needs to map a type
-back to its source.
+back to its source. The [count mutations](#row-counts-instead-of-rows) carry their plural
+write's `operation` plus `count: true` — they write the same rows but resolve to an `Int!`, so
+a wrapper that reads the result as rows should check `count` first.
 
 Because the row identity of a mutation lives in a different argument for every operation,
 `identifyRows` reads whichever one applies and hands back primary-key values:

package/dist/index.cjs

@@ -3748,6 +3748,145 @@ const runMutation = async (db, context, info, txCtx, body, forceTx) => {
 	return runOnSharedTx(state, body);
 };
 //#endregion
+//#region src/util/builders/common/write-hooks.ts
+/**
+* Normalizes the two registration shapes: a bare function is the `after` hook — the position
+* that has rows, and the one the common audit/outbox case wants — while `{ before, after }`
+* names them explicitly.
+*/
+const normalizeWriteHooks = (hooks, tableColumns, where) => {
+	if (!hooks) return;
+	if (typeof hooks === "function") return { after: hooks };
+	const resolved = {
+		before: hooks.before,
+		after: hooks.after
+	};
+	if (hooks.columns !== void 0) resolved.columns = resolveHookColumns(hooks.columns, !!hooks.after, tableColumns, where);
+	return resolved.before || resolved.after ? resolved : void 0;
+};
+/**
+* Resolves a hook's `columns` against the table it runs on. `where` names the registration
+* (`config.onWrite.posts`) and, for a top-level one, the table, so the error says which.
+*/
+const resolveHookColumns = (spec, hasAfter, tableColumns, where) => {
+	if (!hasAfter) throw new Error(`Drizzle-GraphQL Error: ${where}.columns only applies to an 'after' hook, and none is registered.`);
+	if (spec === "all") return { ...tableColumns };
+	if (!Array.isArray(spec)) throw new Error(`Drizzle-GraphQL Error: ${where}.columns must be an array of column names or 'all'.`);
+	const resolved = {};
+	for (const name of spec) {
+		const column = typeof name === "string" && Object.keys(tableColumns).includes(name) ? tableColumns[name] : void 0;
+		if (!column) throw new Error(`Drizzle-GraphQL Error: ${where}.columns names '${String(name)}', which is not a column of that table.`);
+		resolved[name] = column;
+	}
+	return resolved;
+};
+/**
+* Adds a hook's `columns` to a RETURNING column map, and reports which keys it added — the
+* ones the client never asked for, which have to come back off before the rows are mapped.
+* Returns the map untouched, and no keys, when the hook named none or the selection already
+* covers them.
+*/
+const withHookColumns = (hooks, columns) => {
+	const hookColumns = hooks?.columns;
+	if (!hookColumns) return {
+		returning: columns,
+		added: void 0
+	};
+	const selected = new Set(Object.keys(columns));
+	const added = Object.keys(hookColumns).filter((key) => !selected.has(key));
+	if (!added.length) return {
+		returning: columns,
+		added: void 0
+	};
+	const returning = { ...columns };
+	for (const key of added) returning[key] = hookColumns[key];
+	return {
+		returning,
+		added
+	};
+};
+/**
+* The rows with the hook-only keys taken off, as fresh objects: the hook was handed the
+* originals and may still hold them, so they are not mutated under it.
+*/
+const omitHookColumns = (rows, added) => {
+	if (!added) return rows;
+	return rows.map((row) => {
+		const copy = { ...row };
+		for (const key of added) delete copy[key];
+		return copy;
+	});
+};
+/**
+* Invokes one position of a field's hooks. Returns `undefined` rather than a resolved promise
+* when nothing is registered, so the awaiting call site costs nothing on an unhooked build.
+*/
+const runWriteHook = (hooks, position, payload) => {
+	const hook = position === "before" ? hooks?.before : hooks?.after;
+	if (!hook) return;
+	return Promise.resolve(hook({
+		...payload,
+		position,
+		rows: payload.rows ?? []
+	}));
+};
+//#endregion
+//#region src/util/builders/common/write-scaffold.ts
+/**
+* Wraps one mutation body in the scaffolding above and returns the field it becomes.
+*
+* A field carrying a hook is forced into a transaction even when it would have run straight
+* on `db`: a hook exists to write atomically with the mutation, and one that ran outside the
+* transaction could not roll anything back.
+*/
+const writeResolver = ({ db, tableName, operation, single, fieldName, args: queryArgs, txCtx, policies, run }) => {
+	const hooks = policies?.onWrite?.(tableName, operation);
+	const errorCtx = {
+		table: tableName,
+		operation,
+		field: fieldName
+	};
+	return {
+		name: fieldName,
+		resolver: async (_source, args, context, info) => {
+			try {
+				return await runMutation(db, context, info, txCtx, (executor) => {
+					const payload = {
+						table: tableName,
+						operation,
+						single,
+						args,
+						context,
+						info,
+						tx: executor
+					};
+					let added;
+					return run({
+						executor,
+						args,
+						context,
+						info,
+						before: () => runWriteHook(hooks, "before", payload),
+						after: (rows) => runWriteHook(hooks, "after", {
+							...payload,
+							rows: rows ?? []
+						}),
+						returning: (columns) => {
+							const withHook = withHookColumns(hooks, columns);
+							added = withHook.added;
+							return withHook.returning;
+						},
+						output: (rows) => omitHookColumns(rows, added)
+					});
+				}, !!hooks);
+			} catch (e) {
+				throw withErrorContext(toGraphQLError(e), errorCtx);
+			}
+		},
+		args: queryArgs
+	};
+};
+//#endregion
 //#region src/util/builders/common/mutation-helpers.ts
 /**
 * The `hard` argument on the delete mutations of a soft-deleting table that opted into
@@ -3891,54 +4030,79 @@ const assertSingleMatch = async (executor, table, filters) => {
 * The plural `update` and `delete` always `RETURNING *`, which is the wrong shape for
 * "archive everything older than a year": the caller pays to ship rows it does not want, and
 * on a large match that cost is the whole mutation. These return `Int!` instead — how many
-* rows the write touched, as the driver reported it, with no RETURNING clause at all.
+* rows the write touched.
 *
-* Dialect-independent: drizzle's update/delete builders take the same calls everywhere, and
-* the drivers' disagreement about how to spell the row count is handled by
-* {@link rowsAffected}.
-*/
-const generateWriteCount = ({ db, tableName, table, kind, setArgs, filterArgs, fieldName, requireWhere, filterCtx, txCtx, nested }) => {
+* Leaving the payload off changes nothing else: the write obeys every rule of the plural
+* mutation it mirrors, through the same {@link writeResolver} scaffolding.
+*
+* - `scope` (and the soft-delete marker) is ANDed into the `where`, so only rows the plural
+*   write could reach are counted and written.
+* - On a soft-deleting table the delete is the marking `UPDATE`, not a `DELETE`, and rows that
+*   are already marked are not matched; the update skips marked rows too. `hard: true` exists
+*   exactly where the plural delete takes it.
+* - Context-derived columns are stripped from the update's `set`, as the plural update does.
+* - `onWrite` hooks run `before` and `after`, inside a transaction. The `after` hook is handed
+*   rows, so a table with one pays for a `RETURNING` — of the columns the hook names in
+*   `columns`, or of the primary key when it names none (the whole row on a table without a
+*   key) — and the count is the number of rows returned. Every other write, and every write on
+*   MySQL (no `RETURNING`; its hooks see `rows: []` as on every MySQL mutation), skips the
+*   `RETURNING` and reads the count off the driver's result via {@link rowsAffected}.
+*/
+const generateWriteCount = ({ db, tableName, table, kind, setArgs, filterArgs, fieldName, requireWhere, filterCtx, txCtx, nested, policies, pkNames = [], returnsRows }) => {
+	const softDelete = kind === "delete" ? policies?.softDelete?.(tableName) : void 0;
+	const canHardDelete = softDelete?.hardDelete === true;
 	const queryArgs = {
 		...setArgs ? { set: { type: new graphql.GraphQLNonNull(setArgs) } } : {},
-		where: { type: requireWhere ? new graphql.GraphQLNonNull(filterArgs) : filterArgs }
+		where: { type: requireWhere ? new graphql.GraphQLNonNull(filterArgs) : filterArgs },
+		...canHardDelete ? { hard: hardDeleteArg } : {}
 	};
-	const errorCtx = {
-		table: tableName,
+	const readsRows = returnsRows && !!policies?.onWrite?.(tableName, kind)?.after;
+	const allColumns = (0, drizzle_orm.getColumns)(table);
+	const keyColumns = pkNames.length ? Object.fromEntries(pkNames.map((name) => [name, allColumns[name]])) : allColumns;
+	return writeResolver({
+		db,
+		tableName,
 		operation: kind,
-		field: fieldName
-	};
-	return {
-		name: fieldName,
-		resolver: async (_source, args, context, info) => {
-			try {
-				return await runMutation(db, context, info, txCtx, async (executor) => {
-					const { where, set } = args;
-					const filters = scopedWhere({
-						scope: void 0,
-						tableName,
-						table,
-						where,
-						relationCtx: relationFilterCtx(filterCtx, tableName),
-						required: requireWhere
-					});
-					let query;
-					if (kind === "delete") query = executor.delete(table);
-					else {
-						const entry = nested?.enabled(tableName) ? nested.split(tableName, set) : void 0;
-						if (entry && nested.hasOps(entry.ops)) throw drizzleError("This mutation does not support nested writes — use the one that returns the rows instead.", { code: "DRIZZLE_NESTED_WRITES_UNSUPPORTED" });
-						const values = remapUpdateInput(entry ? entry.columns : set, table, tableName);
-						if (!Object.keys(values).length) throw drizzleError("Unable to update with no values specified!", { code: "DRIZZLE_NO_VALUES" });
-						query = executor.update(table).set(values);
-					}
-					if (filters) query = query.where(filters);
-					return rowsAffected(await query);
-				});
-			} catch (e) {
-				throw withErrorContext(toGraphQLError(e), errorCtx);
+		single: false,
+		fieldName,
+		txCtx,
+		policies,
+		args: queryArgs,
+		run: async ({ executor, args, context, before, after, returning }) => {
+			const { where, set } = args;
+			const hard = canHardDelete && args.hard === true;
+			const scope = policies?.scope?.(context);
+			await before();
+			let query;
+			if (kind === "delete") query = softDelete && !hard ? executor.update(table).set({ [softDelete.columnName]: softDelete.writeDeleted() }) : executor.delete(table);
+			else {
+				const entry = nested?.enabled(tableName) ? nested.split(tableName, set) : void 0;
+				if (entry && nested.hasOps(entry.ops)) throw drizzleError("This mutation does not support nested writes — use the one that returns the rows instead.", { code: "DRIZZLE_NESTED_WRITES_UNSUPPORTED" });
+				const values = stripContextValues(remapUpdateInput(entry ? entry.columns : set, table, tableName), policies?.contextValues?.(tableName));
+				if (!Object.keys(values).length) throw drizzleError("Unable to update with no values specified!", { code: "DRIZZLE_NO_VALUES" });
+				query = executor.update(table).set(values);
 			}
-		},
-		args: queryArgs
-	};
+			const filters = scopedWhere({
+				scope,
+				tableName,
+				table,
+				where,
+				relationCtx: relationFilterCtx(filterCtx, tableName),
+				required: requireWhere,
+				deleted: hard ? "INCLUDE" : void 0
+			});
+			if (filters) query = query.where(filters);
+			if (!readsRows) {
+				const result = await query;
+				await after();
+				return rowsAffected(result);
+			}
+			const named = returning({});
+			const rows = await query.returning(Object.keys(named).length ? named : keyColumns);
+			await after(rows);
+			return rows.length;
+		}
+	});
 };
 //#endregion
 //#region src/util/batch-loader/index.ts
@@ -4876,145 +5040,6 @@ const generateTableTypes = (tableName, tables, relationMap, withReturning, relat
 	};
 };
 //#endregion
-//#region src/util/builders/common/write-hooks.ts
-/**
-* Normalizes the two registration shapes: a bare function is the `after` hook — the position
-* that has rows, and the one the common audit/outbox case wants — while `{ before, after }`
-* names them explicitly.
-*/
-const normalizeWriteHooks = (hooks, tableColumns, where) => {
-	if (!hooks) return;
-	if (typeof hooks === "function") return { after: hooks };
-	const resolved = {
-		before: hooks.before,
-		after: hooks.after
-	};
-	if (hooks.columns !== void 0) resolved.columns = resolveHookColumns(hooks.columns, !!hooks.after, tableColumns, where);
-	return resolved.before || resolved.after ? resolved : void 0;
-};
-/**
-* Resolves a hook's `columns` against the table it runs on. `where` names the registration
-* (`config.onWrite.posts`) and, for a top-level one, the table, so the error says which.
-*/
-const resolveHookColumns = (spec, hasAfter, tableColumns, where) => {
-	if (!hasAfter) throw new Error(`Drizzle-GraphQL Error: ${where}.columns only applies to an 'after' hook, and none is registered.`);
-	if (spec === "all") return { ...tableColumns };
-	if (!Array.isArray(spec)) throw new Error(`Drizzle-GraphQL Error: ${where}.columns must be an array of column names or 'all'.`);
-	const resolved = {};
-	for (const name of spec) {
-		const column = typeof name === "string" && Object.keys(tableColumns).includes(name) ? tableColumns[name] : void 0;
-		if (!column) throw new Error(`Drizzle-GraphQL Error: ${where}.columns names '${String(name)}', which is not a column of that table.`);
-		resolved[name] = column;
-	}
-	return resolved;
-};
-/**
-* Adds a hook's `columns` to a RETURNING column map, and reports which keys it added — the
-* ones the client never asked for, which have to come back off before the rows are mapped.
-* Returns the map untouched, and no keys, when the hook named none or the selection already
-* covers them.
-*/
-const withHookColumns = (hooks, columns) => {
-	const hookColumns = hooks?.columns;
-	if (!hookColumns) return {
-		returning: columns,
-		added: void 0
-	};
-	const selected = new Set(Object.keys(columns));
-	const added = Object.keys(hookColumns).filter((key) => !selected.has(key));
-	if (!added.length) return {
-		returning: columns,
-		added: void 0
-	};
-	const returning = { ...columns };
-	for (const key of added) returning[key] = hookColumns[key];
-	return {
-		returning,
-		added
-	};
-};
-/**
-* The rows with the hook-only keys taken off, as fresh objects: the hook was handed the
-* originals and may still hold them, so they are not mutated under it.
-*/
-const omitHookColumns = (rows, added) => {
-	if (!added) return rows;
-	return rows.map((row) => {
-		const copy = { ...row };
-		for (const key of added) delete copy[key];
-		return copy;
-	});
-};
-/**
-* Invokes one position of a field's hooks. Returns `undefined` rather than a resolved promise
-* when nothing is registered, so the awaiting call site costs nothing on an unhooked build.
-*/
-const runWriteHook = (hooks, position, payload) => {
-	const hook = position === "before" ? hooks?.before : hooks?.after;
-	if (!hook) return;
-	return Promise.resolve(hook({
-		...payload,
-		position,
-		rows: payload.rows ?? []
-	}));
-};
-//#endregion
-//#region src/util/builders/common/write-scaffold.ts
-/**
-* Wraps one mutation body in the scaffolding above and returns the field it becomes.
-*
-* A field carrying a hook is forced into a transaction even when it would have run straight
-* on `db`: a hook exists to write atomically with the mutation, and one that ran outside the
-* transaction could not roll anything back.
-*/
-const writeResolver = ({ db, tableName, operation, single, fieldName, args: queryArgs, txCtx, policies, run }) => {
-	const hooks = policies?.onWrite?.(tableName, operation);
-	const errorCtx = {
-		table: tableName,
-		operation,
-		field: fieldName
-	};
-	return {
-		name: fieldName,
-		resolver: async (_source, args, context, info) => {
-			try {
-				return await runMutation(db, context, info, txCtx, (executor) => {
-					const payload = {
-						table: tableName,
-						operation,
-						single,
-						args,
-						context,
-						info,
-						tx: executor
-					};
-					let added;
-					return run({
-						executor,
-						args,
-						context,
-						info,
-						before: () => runWriteHook(hooks, "before", payload),
-						after: (rows) => runWriteHook(hooks, "after", {
-							...payload,
-							rows: rows ?? []
-						}),
-						returning: (columns) => {
-							const withHook = withHookColumns(hooks, columns);
-							added = withHook.added;
-							return withHook.returning;
-						},
-						output: (rows) => omitHookColumns(rows, added)
-					});
-				}, !!hooks);
-			} catch (e) {
-				throw withErrorContext(toGraphQLError(e), errorCtx);
-			}
-		},
-		args: queryArgs
-	};
-};
-//#endregion
 //#region src/util/features.ts
 /**
 * What a table generates when the config says nothing. Everything is on except the opt-in
@@ -7016,7 +7041,9 @@ const generateSchemaData$2 = (db, schema, relations, options) => {
 			fieldName: updateCountFieldName,
 			requireWhere: tableFeatures.requireWhere,
 			filterCtx,
-			txCtx: mutationTxCtx
+			txCtx: mutationTxCtx,
+			policies,
+			returnsRows: false
 		}) : void 0;
 		const deleteCountGenerated = tableFeatures.delete && tableFeatures.countMutations ? generateWriteCount({
 			db,
@@ -7027,7 +7054,9 @@ const generateSchemaData$2 = (db, schema, relations, options) => {
 			fieldName: deleteCountFieldName,
 			requireWhere: tableFeatures.requireWhere,
 			filterCtx,
-			txCtx: mutationTxCtx
+			txCtx: mutationTxCtx,
+			policies,
+			returnsRows: false
 		}) : void 0;
 		const hardDeleteMeta = softDeleteInfo?.hardDelete ? { hardDelete: true } : {};
 		const withMeta = (generated, meta) => ({
@@ -7097,12 +7126,25 @@ const generateSchemaData$2 = (db, schema, relations, options) => {
 				{
 					generated: updateCountGenerated,
 					type: new graphql.GraphQLNonNull(graphql.GraphQLInt),
+					meta: {
+						operation: "update",
+						single: false,
+						targetArg: "where",
+						count: true
+					},
 					description: "How many rows the update touched. The rows themselves are not read back, which is the point of this mutation."
 				},
 				{
 					generated: deleteCountGenerated,
 					type: new graphql.GraphQLNonNull(graphql.GraphQLInt),
-					description: "How many rows the delete removed. The rows themselves are not read back, which is the point of this mutation."
+					meta: {
+						operation: "delete",
+						single: false,
+						targetArg: "where",
+						count: true,
+						...hardDeleteMeta
+					},
+					description: "How many rows the delete removed — or, on a soft-deleting table, marked deleted. The rows themselves are not read back, which is the point of this mutation."
 				}
 			],
 			onConflictInput,
@@ -7603,7 +7645,10 @@ const createSchemaDataGenerator = (adapter) => {
 				requireWhere: tableFeatures.requireWhere,
 				filterCtx,
 				txCtx: mutationTxCtx,
-				nested: nestedRuntime
+				nested: nestedRuntime,
+				policies,
+				pkNames: primaryKeyPropNames(schema[tableName]),
+				returnsRows: true
 			}) : void 0;
 			const deleteCountGenerated = tableFeatures.delete && tableFeatures.countMutations ? generateWriteCount({
 				db,
@@ -7614,7 +7659,10 @@ const createSchemaDataGenerator = (adapter) => {
 				fieldName: deleteCountFieldName,
 				requireWhere: tableFeatures.requireWhere,
 				filterCtx,
-				txCtx: mutationTxCtx
+				txCtx: mutationTxCtx,
+				policies,
+				pkNames: primaryKeyPropNames(schema[tableName]),
+				returnsRows: true
 			}) : void 0;
 			const hardDeleteMeta = softDeleteInfo?.hardDelete ? { hardDelete: true } : {};
 			return {
@@ -7724,12 +7772,25 @@ const createSchemaDataGenerator = (adapter) => {
 					{
 						generated: updateCountGenerated,
 						type: new graphql.GraphQLNonNull(graphql.GraphQLInt),
+						meta: {
+							operation: "update",
+							single: false,
+							targetArg: "where",
+							count: true
+						},
 						description: "How many rows the update touched. The rows themselves are not read back, which is the point of this mutation."
 					},
 					{
 						generated: deleteCountGenerated,
 						type: new graphql.GraphQLNonNull(graphql.GraphQLInt),
-						description: "How many rows the delete removed. The rows themselves are not read back, which is the point of this mutation."
+						meta: {
+							operation: "delete",
+							single: false,
+							targetArg: "where",
+							count: true,
+							...hardDeleteMeta
+						},
+						description: "How many rows the delete removed — or, on a soft-deleting table, marked deleted. The rows themselves are not read back, which is the point of this mutation."
 					}
 				],
 				onConflictInput,