@ttoss/graphql-api 0.9.11 → 0.10.0

package/README.md

@@ -549,6 +549,40 @@ The resolver `connection` has the following arguments based on the [Relay Connec
   });
   ```
 
+#### `ConnectionArgs` type
+
+To type a connection resolver in TypeScript, import the generic `ConnectionArgs<TFilter, TSort>` helper. It captures all of the standard pagination arguments (`first`, `after`, `last`, `before`, `limit`, `skip`, `sort`, `filter`) and lets you specify only the connection-specific parts:
+
+```ts
+import {
+  type ConnectionArgs,
+  type ResolverResolveParams,
+} from '@ttoss/graphql-api';
+
+type NotificationFilter = {
+  isRead?: boolean | null;
+  kind?: string | null;
+};
+
+NotificationTC.addResolver({
+  name: 'findMany',
+  type: [NotificationTC.NonNull],
+  resolve: async ({
+    args,
+  }: ResolverResolveParams<
+    unknown,
+    ResolverContext,
+    ConnectionArgs<NotificationFilter>
+  >) => {
+    return findManyNotifications({
+      first: args.first,
+      after: args.after,
+      filter: args.filter,
+    });
+  },
+});
+```
+
 To configure `composeWithConnection`, you need to provide the following options:
 
 #### `findManyResolver`

package/dist/index.d.cts

@@ -13,4 +13,35 @@ declare const buildSchema: ({ schemaComposer, middlewares, }: BuildSchemaInput)
 
 declare const composeWithRelay: <TContext>(tc: ObjectTypeComposer<any, TContext>) => ObjectTypeComposer<any, TContext>;
 
-export { type BuildSchemaInput, buildSchema, composeWithRelay };
+/**
+ * Standard connection arguments used by resolvers created with `composeWithConnection`.
+ *
+ * @typeParam TFilter - Shape of the connection-specific filter object. Defaults to `unknown`.
+ * @typeParam TSort   - Shape of the sort value. Defaults to `unknown`.
+ *
+ * @example
+ * ```ts
+ * import { type ConnectionArgs, type ResolverResolveParams } from '@ttoss/graphql-api';
+ *
+ * type NotificationFilter = { isRead?: boolean | null };
+ *
+ * NotificationTC.addResolver({
+ *   name: 'findMany',
+ *   resolve: async ({ args }: ResolverResolveParams<unknown, Context, ConnectionArgs<NotificationFilter>>) => {
+ *     return findMany({ first: args.first, after: args.after, filter: args.filter });
+ *   },
+ * });
+ * ```
+ */
+type ConnectionArgs<TFilter = unknown, TSort = unknown> = {
+    first?: number | null;
+    after?: string | null;
+    last?: number | null;
+    before?: string | null;
+    limit?: number | null;
+    skip?: number | null;
+    sort?: TSort;
+    filter?: TFilter | null;
+};
+
+export { type BuildSchemaInput, type ConnectionArgs, buildSchema, composeWithRelay };

package/dist/index.d.ts

@@ -13,4 +13,35 @@ declare const buildSchema: ({ schemaComposer, middlewares, }: BuildSchemaInput)
 
 declare const composeWithRelay: <TContext>(tc: ObjectTypeComposer<any, TContext>) => ObjectTypeComposer<any, TContext>;
 
-export { type BuildSchemaInput, buildSchema, composeWithRelay };
+/**
+ * Standard connection arguments used by resolvers created with `composeWithConnection`.
+ *
+ * @typeParam TFilter - Shape of the connection-specific filter object. Defaults to `unknown`.
+ * @typeParam TSort   - Shape of the sort value. Defaults to `unknown`.
+ *
+ * @example
+ * ```ts
+ * import { type ConnectionArgs, type ResolverResolveParams } from '@ttoss/graphql-api';
+ *
+ * type NotificationFilter = { isRead?: boolean | null };
+ *
+ * NotificationTC.addResolver({
+ *   name: 'findMany',
+ *   resolve: async ({ args }: ResolverResolveParams<unknown, Context, ConnectionArgs<NotificationFilter>>) => {
+ *     return findMany({ first: args.first, after: args.after, filter: args.filter });
+ *   },
+ * });
+ * ```
+ */
+type ConnectionArgs<TFilter = unknown, TSort = unknown> = {
+    first?: number | null;
+    after?: string | null;
+    last?: number | null;
+    before?: string | null;
+    limit?: number | null;
+    skip?: number | null;
+    sort?: TSort;
+    filter?: TFilter | null;
+};
+
+export { type BuildSchemaInput, type ConnectionArgs, buildSchema, composeWithRelay };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ttoss/graphql-api",
-  "version": "0.9.11",
+  "version": "0.10.0",
   "description": "A library for building GraphQL APIs using ttoss ecosystem.",
   "license": "MIT",
   "author": "ttoss",