@m1212e/rumble 0.12.12 → 0.12.14

package/README.md

@@ -129,10 +129,10 @@ rumble({
 ## Helpers
 Rumble offers various helpers to make it easy and fast to implement your api. Ofcourse you can write your api by hand using the provided `schemaBuilder` from the rumble initiator, but since this might get repetitive, the provided helpers automate a lot of this work for you while also automatically applying the concepts of rumble directly into your api.
 
-### arg
-`arg` is a helper to implement query arguments for filtering the results of a query for certain results. In many cases you would implement arguments for a query with something as `matchUsername: t.arg.string()` which is supposed to restrict the query to users which have that username. The arg helper implements such a filter tailored to the specific entity which you then can directly pass on to the database query.
+### whereArg
+`whereArg` is a helper to implement query arguments for filtering the results of a query for certain results. In many cases you would implement arguments for a query with something as `matchUsername: t.arg.string()` which is supposed to restrict the query to users which have that username. The whereArg helper implements such a filter tailored to the specific entity which you then can directly pass on to the database query.
 ```ts
-const WhereArgs = arg({
+const WhereArgs = whereArg({
  table: "posts",
 });
 
@@ -210,6 +210,9 @@ const enumRef = enum_({
 ```
 > The enum parameter allows other fields to be used to reference an enum. This is largely due to how this is used internally. Because of the way how drizzle handles enums, we are not able to provide type safety with enums. In case you actually need to use it, the above way is the recommended approach.
 
+### and more...
+See [the example file](./example/src/main.ts) or clone it and let intellisense guide you. Rumble offers various other helpers which might become handy!
+
 ## Running the server
 In case you directly want to run a server from your rumble instance, you can do so by using the `createYoga` function. It returns a graphql `yoga` instance which can be used to provide a graphql api in [a multitude of ways](https://the-guild.dev/graphql/yoga-server/docs/integrations/z-other-environments).
 ```ts
@@ -242,7 +245,9 @@ await clientCreator({
   // to point to your custom client
 });
 ```
-> The client uses [urql](https://nearform.com/open-source/urql/docs/basics/core/) under the hood. If you would like more info on how the internals work, please see the docs.
+> The client uses [urql](https://nearform.com/open-source/urql/docs/basics/core/) under the hood. If you would like more info on how the internals work, please see their docs.
+
+This way of generating code is especially helpful in monorepos, where it is convenient to output client code when running the server during development. If you do not use a monorepo and want to decouple the generation process, see below.
 
 An example usage might look like this:
 ```ts
@@ -272,7 +277,7 @@ users.subscribe((s) => s?.at(0));
 // you can directly access the values of an awaited result
 console.log(users.firstName)
 ```
-### Alternative
+### Alternative decoupled client generation
 As an alternative to use the client generator with a fully instanciated rumble instance, you can also import the `generateFromSchema` function from rumble and pass it a standard `GraphQLSchema` object to generate the client:
 ```ts
 import { generateFromSchema } from "@m1212e/rumble";

package/out/index.cjs

@@ -22,35 +22,21 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
 
 //#endregion
 let node_fs_promises = require("node:fs/promises");
-node_fs_promises = __toESM(node_fs_promises);
 let node_path = require("node:path");
-node_path = __toESM(node_path);
 let graphql = require("graphql");
-graphql = __toESM(graphql);
 let es_toolkit = require("es-toolkit");
-es_toolkit = __toESM(es_toolkit);
 let wonka = require("wonka");
-wonka = __toESM(wonka);
 let __escape_tech_graphql_armor = require("@escape.tech/graphql-armor");
-__escape_tech_graphql_armor = __toESM(__escape_tech_graphql_armor);
 let __graphql_yoga_plugin_disable_introspection = require("@graphql-yoga/plugin-disable-introspection");
-__graphql_yoga_plugin_disable_introspection = __toESM(__graphql_yoga_plugin_disable_introspection);
 let graphql_yoga = require("graphql-yoga");
-graphql_yoga = __toESM(graphql_yoga);
 let sofa_api = require("sofa-api");
-sofa_api = __toESM(sofa_api);
 let drizzle_orm = require("drizzle-orm");
-drizzle_orm = __toESM(drizzle_orm);
 let drizzle_orm_casing = require("drizzle-orm/casing");
-drizzle_orm_casing = __toESM(drizzle_orm_casing);
 let drizzle_orm_pg_core = require("drizzle-orm/pg-core");
-drizzle_orm_pg_core = __toESM(drizzle_orm_pg_core);
 let pluralize = require("pluralize");
 pluralize = __toESM(pluralize);
 let drizzle_orm_mysql_core = require("drizzle-orm/mysql-core");
-drizzle_orm_mysql_core = __toESM(drizzle_orm_mysql_core);
 let drizzle_orm_sqlite_core = require("drizzle-orm/sqlite-core");
-drizzle_orm_sqlite_core = __toESM(drizzle_orm_sqlite_core);
 let __pothos_core = require("@pothos/core");
 __pothos_core = __toESM(__pothos_core);
 let __pothos_plugin_drizzle = require("@pothos/plugin-drizzle");
@@ -58,7 +44,6 @@ __pothos_plugin_drizzle = __toESM(__pothos_plugin_drizzle);
 let __pothos_plugin_smart_subscriptions = require("@pothos/plugin-smart-subscriptions");
 __pothos_plugin_smart_subscriptions = __toESM(__pothos_plugin_smart_subscriptions);
 let graphql_scalars = require("graphql-scalars");
-graphql_scalars = __toESM(graphql_scalars);
 
 //#region lib/client/generate/client.ts
 function generateClient({ apiUrl, rumbleImportPath, useExternalUrqlClient, availableSubscriptions }) {
@@ -259,25 +244,21 @@ function makeGraphQLQuery({ queryName, input, client, enableSubscription = false
 	const argsString = stringifyArgumentObjectToGraphqlList(input[argsKey] ?? {});
 	const operationString = (operationVerb) => `${operationVerb} ${otwQueryName} { ${queryName}${argsString} { ${stringifySelection(input)} }}`;
 	let awaitedReturnValueReference;
-	const response = (0, wonka.pipe)((0, wonka.merge)([client.query(operationString("query"), {}), enableSubscription ? client.subscription(operationString("subscription"), {}) : wonka.empty]), (0, wonka.map)((v) => {
+	const observable = (0, wonka.pipe)((0, wonka.merge)([client.query(operationString("query"), {}), enableSubscription ? client.subscription(operationString("subscription"), {}) : wonka.empty]), (0, wonka.map)((v) => {
 		const data = v.data?.[queryName];
 		if (!data && v.error) throw v.error;
 		return data;
 	}), (0, wonka.onPush)((data) => {
 		if (awaitedReturnValueReference) Object.assign(awaitedReturnValueReference, data);
-	}));
+	}), wonka.toObservable);
 	const promise = new Promise((resolve) => {
-		const unsub = (0, wonka.toObservable)(response).subscribe((v) => {
+		const unsub = observable.subscribe((v) => {
 			unsub();
-			const newObservableWithAwaitedValue = (0, wonka.pipe)((0, wonka.merge)([response, (0, wonka.fromValue)(v)]), wonka.toObservable);
-			awaitedReturnValueReference = {
-				...v,
-				...newObservableWithAwaitedValue
-			};
+			awaitedReturnValueReference = Object.assign(v, observable);
 			resolve(awaitedReturnValueReference);
 		}).unsubscribe;
 	});
-	Object.assign(promise, (0, wonka.toObservable)(response));
+	Object.assign(promise, observable);
 	return promise;
 }
 function makeGraphQLMutation({ mutationName, input, client }) {
@@ -716,6 +697,8 @@ function tableHelper({ db, table }) {
 	if (!foundRelation) throw new RumbleError(`Could not find schema for ${JSON.stringify(table)}`);
 	const foundSchema = Object.values(db._.schema).find((schema) => schema.dbName === foundRelation.table[drizzleOriginalNameSymbol]);
 	if (!foundSchema) throw new RumbleError(`Could not find schema for ${JSON.stringify(table)}`);
+	const fullSchema = db._.fullSchema?.[foundSchema.tsName];
+	if (!fullSchema) throw new RumbleError(`Could not find full schema for ${JSON.stringify(table)}`);
 	return {
 		columns: foundSchema.columns,
 		primaryKey: foundSchema.primaryKey,
@@ -723,7 +706,8 @@ function tableHelper({ db, table }) {
 		dbName: foundSchema.dbName,
 		tsName: foundSchema.tsName,
 		foundSchema,
-		foundRelation
+		foundRelation,
+		fullSchema
 	};
 }
 
@@ -1078,6 +1062,7 @@ const createWhereArgImplementer = ({ db, schemaBuilder, enumImplementer }) => {
 const clientCreatorImplementer = ({ builtSchema }) => {
 	if (process.env.NODE_ENV !== "development") console.warn("Running rumble client generation in non development mode. Are you sure this is correct?");
 	const clientCreator = async ({ apiUrl, outputPath, rumbleImportPath, useExternalUrqlClient }) => {
+		if (process.env.NODE_ENV !== "development") console.warn("Running rumble client generation in non development mode. Are you sure this is correct?");
 		await generateFromSchema({
 			schema: builtSchema(),
 			outputPath,
@@ -1102,6 +1087,56 @@ const createContextFunction = ({ context: makeUserContext, abilityBuilder }) =>
 	};
 };
 
+//#endregion
+//#region lib/helpers/protoMapper.ts
+function deepSetProto(obj, proto = Object.prototype, seen = /* @__PURE__ */ new WeakSet()) {
+	if (obj === null || typeof obj !== "object") return;
+	if (seen.has(obj)) return;
+	seen.add(obj);
+	Object.setPrototypeOf(obj, proto);
+	for (const key of Object.keys(obj)) deepSetProto(obj[key], proto, seen);
+}
+
+//#endregion
+//#region lib/countQuery.ts
+const createCountQueryImplementer = ({ db, schemaBuilder, whereArgImplementer, makePubSubInstance }) => {
+	return ({ table, listAction = "read", isAllowed }) => {
+		const WhereArg = whereArgImplementer({ table });
+		const { registerOnInstance } = makePubSubInstance({ table });
+		const tableSchema = tableHelper({
+			db,
+			table
+		});
+		return schemaBuilder.queryFields((t) => {
+			return { [`${pluralize.default.plural(table.toString())}Count`]: t.field({
+				type: "Int",
+				nullable: false,
+				smartSubscription: true,
+				description: `Count all ${pluralize.default.plural(table.toString())}`,
+				subscribe: (subscriptions, _root, _args, _ctx, _info) => {
+					registerOnInstance({
+						instance: subscriptions,
+						action: "created"
+					});
+					registerOnInstance({
+						instance: subscriptions,
+						action: "removed"
+					});
+				},
+				args: { where: t.arg({
+					type: WhereArg,
+					required: false
+				}) },
+				resolve: async (root, args, ctx, info) => {
+					if (isAllowed && !await isAllowed(ctx)) throw new RumbleErrorSafe("Not allowed to perform this action");
+					deepSetProto(args);
+					return db.select({ count: (0, drizzle_orm.count)() }).from(tableSchema.fullSchema).where(ctx.abilities[table].filter(listAction).merge(mapNullFieldsToUndefined(args)).sql.where).then(assertFirstEntryExists).then((r) => r.count);
+				}
+			}) };
+		});
+	};
+};
+
 //#endregion
 //#region lib/helpers/sofaOpenAPIWebhookDocs.ts
 const sofaOpenAPIWebhookDocs = {
@@ -1550,7 +1585,7 @@ const createQueryImplementer = ({ db, schemaBuilder, search, whereArgImplementer
 					},
 					args: manyArgs,
 					resolve: (query, _root, args, ctx, _info) => {
-						Object.setPrototypeOf(args, Object.prototype);
+						deepSetProto(args);
 						adjustQueryArgsForSearch({
 							search,
 							args,
@@ -1573,7 +1608,7 @@ const createQueryImplementer = ({ db, schemaBuilder, search, whereArgImplementer
 					description: `Get a single ${pluralize.default.singular(table.toString())} by ID`,
 					args: { id: t.arg.id({ required: true }) },
 					resolve: (query, _root, args, ctx, _info) => {
-						Object.setPrototypeOf(args, Object.prototype);
+						deepSetProto(args);
 						const filter = ctx.abilities[table].filter(readAction).merge({ where: { [primaryKeyField.name]: args.id } }).query.single;
 						const q = query(filter);
 						if (filter.columns) q.columns = filter.columns;
@@ -1849,6 +1884,12 @@ export const db = drizzle(
 		orderArgImplementer: orderArg,
 		makePubSubInstance
 	});
+	const countQuery = createCountQueryImplementer({
+		...rumbleInput,
+		schemaBuilder,
+		whereArgImplementer: whereArg,
+		makePubSubInstance
+	});
 	const builtSchema = lazy(() => schemaBuilder.toSchema());
 	const createYoga = (args) => {
 		const enableApiDocs = args?.enableApiDocs ?? process?.env?.NODE_ENV === "development";
@@ -1882,7 +1923,8 @@ export const db = drizzle(
 		clientCreator: clientCreatorImplementer({
 			...rumbleInput,
 			builtSchema
-		})
+		}),
+		countQuery
 	};
 };