@ttoss/graphql-api 0.8.3 → 0.8.4

package/README.md

@@ -25,7 +25,7 @@ pnpm add @ttoss/graphql-api graphql
 
 ## Usage
 
-This library uses [`graphql-compose`](https://graphql-compose.github.io/) to create the GraphQL schema. It re-export all the [`graphql-compose`](https://graphql-compose.github.io/) types and methods, so you can use it directly from this package.
+This library uses [`graphql-compose`](https://graphql-compose.github.io/) to create the GraphQL schema. It re-exports all the [`graphql-compose`](https://graphql-compose.github.io/) types and methods, so you can use it directly from this package.
 
 ### Type Creation
 
@@ -43,7 +43,7 @@ const UserTC = schemaComposer.createObjectTC({
 });
 ```
 
-This library uses the `tsconfig.json` file from the target package it is being applied on. If you are using relative imports in your package you can skip this section, but, if you use path aliases in your typescript code by leveraging the [`paths`](https://www.typescriptlang.org/tsconfig#paths) property, the [`baseUrl`](https://www.typescriptlang.org/tsconfig#baseUrl) must be filled accordingly.This is needed because in order to interpret the path aliases, `ts-node` uses [`tsconfig-paths`](https://github.com/dividab/tsconfig-paths) to resolve the modules that uses this config, and `tsconfig-paths` needs both `baseUrl` and `paths` values to be non-null. A `tsconfig.json` example that follows such recommendations is given below:
+This library uses the `tsconfig.json` file from the target package it is being applied on. If you are using relative imports in your package you can skip this section, but, if you use path aliases in your typescript code by leveraging the [`paths`](https://www.typescriptlang.org/tsconfig#paths) property, the [`baseUrl`](https://www.typescriptlang.org/tsconfig#baseUrl) must be filled accordingly. This is needed because in order to interpret the path aliases, `ts-node` uses [`tsconfig-paths`](https://github.com/dividab/tsconfig-paths) to resolve the modules that uses this config, and `tsconfig-paths` needs both `baseUrl` and `paths` values to be non-null. A `tsconfig.json` example that follows such recommendations is given below:
 
 ```json
 {
@@ -58,7 +58,23 @@ This library uses the `tsconfig.json` file from the target package it is being a
 
 ### Resolvers
 
-TODO
+#### Creating Resolvers
+
+Resolvers are functions that resolve a value for a type or field in your schema. Here’s a simple example of how to create a resolver for the `User` type:
+
+```ts
+UserTC.addResolver({
+  name: 'findById',
+  type: UserTC,
+  args: {
+    id: 'String!',
+  },
+  resolve: async ({ args }) => {
+    // Implement your logic to find a user by ID
+    return await findUserById(args.id);
+  },
+});
+```
 
 ### Integrate All Modules
 
@@ -171,7 +187,7 @@ _We inspired ourselves on [graphql-compose-relay](https://graphql-compose.github
 
 ### Connections
 
-This packages provides the method `composeWithConnection` to create a connection type and queries for a given type, based on [graphql-compose-connection](https://graphql-compose.github.io/docs/plugins/plugin-connection.html) plugin and following the [Relay Connection Specification](https://facebook.github.io/relay/graphql/connections.htm).
+This package provides the method `composeWithConnection` to create a connection type and queries for a given type, based on [graphql-compose-connection](https://graphql-compose.github.io/docs/plugins/plugin-connection.html) plugin and following the [Relay Connection Specification](https://facebook.github.io/relay/graphql/connections.htm).
 
 ```typescript
 import { composeWithConnection } from '@ttoss/graphql-api';
@@ -276,40 +292,10 @@ The resolver that will be used to find the nodes. It receives the following argu
         name: 'String',
         book: 'String',
       },
+      // other args
     },
-    resolve: async ({
-      args,
-    }: {
-      args: {
-        first?: number;
-        after?: string;
-        last?: number;
-        before?: string;
-        /**
-         * It's the `first` or `last` argument plus one.
-         */
-        limit: number;
-        /**
-         * The `filter` argument, if provided on the query.
-         */
-        filter?: {
-          name: string;
-          book: string;
-        };
-        /**
-         * The `sort` argument, if provided on the query as
-         * they keys of the `sort` object. In our example
-         * above, it's `ASC` and `DESC`. `scanIndexForward`
-         * is the value of the `value` property on the sort
-         * object. In our example above, it's `true` for
-         * `ASC` and `false` for `DESC`.
-         */
-        sort: {
-          scanIndexForward: boolean;
-        };
-      };
-    }) => {
-      //
+    resolve: async ({ args }) => {
+      // find many
     },
   });
   ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ttoss/graphql-api",
-  "version": "0.8.3",
+  "version": "0.8.4",
   "description": "A library for building GraphQL APIs using ttoss ecosystem.",
   "license": "MIT",
   "author": "ttoss",
@@ -35,7 +35,7 @@
     "graphql-middleware": "^6.1.35",
     "graphql-shield": "^7.6.5",
     "npmlog": "^7.0.1",
-    "@ttoss/ids": "^0.3.2"
+    "@ttoss/ids": "^0.3.3"
   },
   "peerDependencies": {
     "graphql": "^16.6.0"
@@ -44,7 +44,7 @@
     "graphql": "^16.9.0",
     "jest": "^29.7.0",
     "tsup": "^8.3.5",
-    "@ttoss/config": "^1.35.2"
+    "@ttoss/config": "^1.35.3"
   },
   "keywords": [
     "api",