@ttoss/graphql-api 0.3.6 → 0.4.1

package/README.md

@@ -5,6 +5,7 @@ This package provides an opinionated way to create an GraphQL API using ttoss ec
 1. **Modular**: you can create your GraphQL API using modules, so you can reduce the complexity of a big GraphQL API.
 1. **Relay**: ttoss uses Relay as the main GraphQL client, so this package implements the [Relay Server Specification](https://relay.dev/docs/guides/graphql-server-specification/).
 1. **Build Schema**: as Relay needs an introspection query to work, this package provides a way to build the GraphQL schema by running `ttoss-graphl-api build-schema`.
+1. **Build TypeScript Types**: this package provides a way to build the TypeScript types for your GraphQL schema by running `ttoss-graphl-api build-schema`.
 1. **AppSync Support**: this package provides a way to create a GraphQL API that works with AWS AppSync, besides you can also create a local GraphQL API server.
 
 ## Installation
@@ -211,18 +212,18 @@ import { allow, deny, shield } from '@ttoss/graphql-api/shield';
 
 ## Building Schema
 
-As Relay needs an introspection query to work, this package provides a way to build the GraphQL schema by running `ttoss-graphl-api build-schema`.
+As Relay needs an introspection query to work, this package provides a way to build the GraphQL schema by running `ttoss-graphl-api build-schema`. It build the schema using the `schemaComposer` from `src/schemaComposer.ts` file and save the schema in `schema/schema.graphql` file and TypeScript types in `schema/types.ts` file.
 
 ```bash
 ttoss-graphl-api build-schema
 ```
 
-You can add the `schema` script to your `package.json`:
+You can add the `build` script to your `package.json`:
 
 ```json
 {
   "scripts": {
-    "schema": "ttoss-graphl-api build-schema"
+    "build": "ttoss-graphl-api build-schema"
   }
 }
 ```

package/dist/cli.js

@@ -29,6 +29,9 @@ isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", {
 // src/cli.ts
 var fs = __toESM(require("fs"));
 var path = __toESM(require("path"));
+var typescriptPlugin = __toESM(require("@graphql-codegen/typescript"));
+var import_core = require("@graphql-codegen/core");
+var import_graphql = require("graphql");
 var import_ts_node = require("ts-node");
 var import_npmlog = __toESM(require("npmlog"));
 var import_yargs = __toESM(require("yargs"));
@@ -37,15 +40,39 @@ var logPrefix = "graphql-api";
   transpileOnly: true
 });
 var argv = (0, import_yargs.default)(process.argv.slice(2)).argv;
-if (argv._.includes("build-schema")) {
-  import_npmlog.default.info(logPrefix, "Building schema...");
-  const {
-    schemaComposer
-  } = require(path.resolve(process.cwd(), "src", "schemaComposer.ts"));
-  const sdl = schemaComposer.toSDL();
-  fs.mkdirSync("schema", {
-    recursive: true
-  });
-  fs.writeFileSync("schema/schema.graphql", sdl);
-  import_npmlog.default.info(logPrefix, "Schema built.");
-}
+(async () => {
+  if (argv._.includes("build-schema")) {
+    import_npmlog.default.info(logPrefix, "Building schema...");
+    const {
+      schemaComposer
+    } = require(path.resolve(process.cwd(), "src", "schemaComposer.ts"));
+    const sdl = schemaComposer.toSDL();
+    const codegenConfig = {
+      documents: [],
+      config: {
+        declarationKind: {
+          type: "interface",
+          interface: "interface"
+        },
+        namingConvention: "keep"
+      },
+      filename: "schema/types.ts",
+      schema: (0, import_graphql.parse)(sdl),
+      plugins: [{
+        typescript: {}
+      }],
+      pluginMap: {
+        typescript: typescriptPlugin
+      }
+    };
+    await fs.promises.mkdir("schema", {
+      recursive: true
+    });
+    await fs.promises.writeFile("schema/schema.graphql", sdl);
+    const typesOutput = await (0, import_core.codegen)(codegenConfig);
+    const typesOutputIgnore = ["/* eslint-disable */"].join("\n");
+    await fs.promises.writeFile("schema/types.ts", `${typesOutputIgnore}
+${typesOutput}`);
+    import_npmlog.default.info(logPrefix, "Schema and types generated!");
+  }
+})();

package/dist/esm/cli.js

@@ -4,6 +4,9 @@ import { __require } from "./chunk-O4CP4YC5.js";
 // src/cli.ts
 import * as fs from "fs";
 import * as path from "path";
+import * as typescriptPlugin from "@graphql-codegen/typescript";
+import { codegen } from "@graphql-codegen/core";
+import { parse } from "graphql";
 import { register } from "ts-node";
 import log from "npmlog";
 import yargs from "yargs";
@@ -12,15 +15,39 @@ register({
   transpileOnly: true
 });
 var argv = yargs(process.argv.slice(2)).argv;
-if (argv._.includes("build-schema")) {
-  log.info(logPrefix, "Building schema...");
-  const {
-    schemaComposer
-  } = __require(path.resolve(process.cwd(), "src", "schemaComposer.ts"));
-  const sdl = schemaComposer.toSDL();
-  fs.mkdirSync("schema", {
-    recursive: true
-  });
-  fs.writeFileSync("schema/schema.graphql", sdl);
-  log.info(logPrefix, "Schema built.");
-}
+(async () => {
+  if (argv._.includes("build-schema")) {
+    log.info(logPrefix, "Building schema...");
+    const {
+      schemaComposer
+    } = __require(path.resolve(process.cwd(), "src", "schemaComposer.ts"));
+    const sdl = schemaComposer.toSDL();
+    const codegenConfig = {
+      documents: [],
+      config: {
+        declarationKind: {
+          type: "interface",
+          interface: "interface"
+        },
+        namingConvention: "keep"
+      },
+      filename: "schema/types.ts",
+      schema: parse(sdl),
+      plugins: [{
+        typescript: {}
+      }],
+      pluginMap: {
+        typescript: typescriptPlugin
+      }
+    };
+    await fs.promises.mkdir("schema", {
+      recursive: true
+    });
+    await fs.promises.writeFile("schema/schema.graphql", sdl);
+    const typesOutput = await codegen(codegenConfig);
+    const typesOutputIgnore = ["/* eslint-disable */"].join("\n");
+    await fs.promises.writeFile("schema/types.ts", `${typesOutputIgnore}
+${typesOutput}`);
+    log.info(logPrefix, "Schema and types generated!");
+  }
+})();

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ttoss/graphql-api",
-  "version": "0.3.6",
-  "description": "A library for building GraphQL APIs.",
+  "version": "0.4.1",
+  "description": "A library for building GraphQL APIs using ttoss ecosystem.",
   "author": "ttoss",
   "contributors": [
     "Pedro Arantes <pedro@arantespp.com> (https://arantespp.com)"
@@ -33,9 +33,11 @@
   "sideEffects": false,
   "typings": "dist/index.d.ts",
   "dependencies": {
+    "@graphql-codegen/core": "^4.0.0",
+    "@graphql-codegen/typescript": "^4.0.1",
     "graphql-compose": "^9.0.10",
     "graphql-compose-connection": "^8.2.1",
-    "graphql-middleware": "^6.1.34",
+    "graphql-middleware": "^6.1.35",
     "graphql-shield": "^7.6.5",
     "npmlog": "^7.0.1",
     "ts-node": "^10.9.1",
@@ -46,7 +48,7 @@
   },
   "devDependencies": {
     "@types/yargs": "^17.0.24",
-    "graphql": "^16.6.0",
+    "graphql": "^16.8.1",
     "jest": "^29.6.2",
     "tsup": "^7.1.0",
     "@ttoss/config": "^1.30.6"

package/src/cli.ts

@@ -1,5 +1,8 @@
-import * as fs from 'fs';
-import * as path from 'path';
+import * as fs from 'node:fs';
+import * as path from 'node:path';
+import * as typescriptPlugin from '@graphql-codegen/typescript';
+import { codegen } from '@graphql-codegen/core';
+import { parse } from 'graphql';
 import { register } from 'ts-node';
 import log from 'npmlog';
 import yargs from 'yargs';
@@ -10,26 +13,62 @@ register({
   transpileOnly: true,
 });
 
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
 const argv: any = yargs(process.argv.slice(2)).argv;
 
-if (argv._.includes('build-schema')) {
-  log.info(logPrefix, 'Building schema...');
+(async () => {
+  if (argv._.includes('build-schema')) {
+    log.info(logPrefix, 'Building schema...');
 
-  // eslint-disable-next-line @typescript-eslint/no-var-requires
-  const { schemaComposer } = require(path.resolve(
-    process.cwd(),
-    'src',
-    'schemaComposer.ts'
-  ));
+    // eslint-disable-next-line @typescript-eslint/no-var-requires
+    const { schemaComposer } = require(path.resolve(
+      process.cwd(),
+      'src',
+      'schemaComposer.ts'
+    ));
 
-  const sdl = schemaComposer.toSDL();
+    const sdl = schemaComposer.toSDL();
 
-  /**
-   * Save to schema/schema.graphql. schema folder might not exist.
-   */
-  fs.mkdirSync('schema', { recursive: true });
+    /**
+     * https://the-guild.dev/graphql/codegen/docs/advanced/programmatic-usage
+     */
+    const codegenConfig = {
+      documents: [],
+      config: {
+        declarationKind: {
+          type: 'interface',
+          interface: 'interface',
+        },
+        namingConvention: 'keep',
+      },
+      filename: 'schema/types.ts',
+      schema: parse(sdl),
+      plugins: [
+        {
+          typescript: {},
+        },
+      ],
+      pluginMap: {
+        typescript: typescriptPlugin,
+      },
+    };
 
-  fs.writeFileSync('schema/schema.graphql', sdl);
+    /**
+     * Save to schema/schema.graphql. schema folder might not exist.
+     */
+    await fs.promises.mkdir('schema', { recursive: true });
 
-  log.info(logPrefix, 'Schema built.');
-}
+    await fs.promises.writeFile('schema/schema.graphql', sdl);
+
+    const typesOutput = await codegen(codegenConfig);
+
+    const typesOutputIgnore = ['/* eslint-disable */'].join('\n');
+
+    await fs.promises.writeFile(
+      'schema/types.ts',
+      `${typesOutputIgnore}\n${typesOutput}`
+    );
+
+    log.info(logPrefix, 'Schema and types generated!');
+  }
+})();