@ttoss/graphql-api-cli 0.8.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024, Terezinha Tech Operations (ttoss)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,49 @@
+# @ttoss/graphql-api-cli
+
+This package generates schema and TypeScript types for your GraphQL API.
+
+## ESM Only
+
+This package is [ESM only](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c).
+
+## Installation
+
+```bash
+pnpm add -D @ttoss/graphql-api-cli
+```
+
+## Usage
+
+As Relay needs an introspection query to work, this package provides a way to build the GraphQL schema by running `ttoss-graphql-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-graphql-api build-schema
+```
+
+You can add the `build-schema` script to your `package.json`:
+
+```json
+{
+  "scripts": {
+    "build-schema": "ttoss-graphql-api build-schema"
+  }
+}
+```
+
+## Options
+
+### `--directory`/`-d`
+
+If your `schemaComposer` is in a different directory, you can pass the `--directory`/`-d` option to `ttoss-graphql-api build-schema` command:
+
+```bash
+ttoss-graphql-api build-schema -d tests
+```
+
+### `--external`
+
+External dependencies to ignore during build. If you don't set this option, the `build-schema` command will use the `dependencies` from your `package.json` file.
+
+```bash
+ttoss-graphql-api build-schema --external graphql-compose,graphql
+```

package/bin/cli.js

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+import '../dist/esm/index.js';

package/dist/esm/index.js

@@ -0,0 +1,148 @@
+/** Powered by @ttoss/config. https://ttoss.dev/docs/modules/packages/config/ */
+
+// src/index.ts
+import * as esbuild from "esbuild";
+import * as fs from "node:fs";
+import * as path from "node:path";
+import * as typescriptPlugin from "@graphql-codegen/typescript";
+import { Command } from "commander";
+import { codegen } from "@graphql-codegen/core";
+import { parse } from "graphql";
+import log from "npmlog";
+
+// package.json
+var package_default = {
+  name: "@ttoss/graphql-api-cli",
+  version: "0.8.1",
+  description: "A library for building GraphQL APIs types and schema.",
+  license: "MIT",
+  author: "ttoss",
+  contributors: ["Pedro Arantes <pedro@arantespp.com> (https://arantespp.com)"],
+  repository: {
+    type: "git",
+    url: "https://github.com/ttoss/ttoss.git",
+    directory: "packages/graphql-api-cli"
+  },
+  type: "module",
+  bin: {
+    "ttoss-graphql-api": "./bin/cli.js"
+  },
+  files: ["dist"],
+  scripts: {
+    "build-config": "tsup-node"
+  },
+  sideEffects: false,
+  peerDependencies: {
+    graphql: "^16.6.0"
+  },
+  devDependencies: {
+    "@graphql-codegen/core": "^4.0.2",
+    "@graphql-codegen/typescript": "^4.1.2",
+    "@ttoss/config": "workspace:^",
+    commander: "^12.1.0",
+    esbuild: "^0.24.0",
+    graphql: "^16.9.0",
+    npmlog: "^7.0.1",
+    tsup: "^8.3.5"
+  },
+  keywords: ["api", "graphql"],
+  publishConfig: {
+    access: "public",
+    provenance: true
+  }
+};
+
+// src/index.ts
+var logPrefix = "graphql-api";
+var importSchemaComposer = async ({
+  external,
+  schemaComposerPath
+}) => {
+  const lastEntryPointName = schemaComposerPath.split("/").pop();
+  const filename = lastEntryPointName?.split(".")[0];
+  const outfile = path.resolve(process.cwd(), "out", filename + ".js");
+  const packageJsonPath = path.resolve(process.cwd(), "package.json");
+  const packageJson = await fs.promises.readFile(packageJsonPath, "utf-8");
+  const dependencies = Object.keys(JSON.parse(packageJson).dependencies).filter(dependency => {
+    if (dependency.startsWith("@ttoss/")) {
+      return false;
+    }
+    if (dependency === "graphql") {
+      return false;
+    }
+    return true;
+  });
+  const result = await esbuild.build({
+    bundle: true,
+    entryPoints: [schemaComposerPath],
+    external: external || dependencies,
+    format: "esm",
+    outfile,
+    platform: "node",
+    target: "ES2023",
+    treeShaking: true
+  });
+  if (result.errors.length > 0) {
+    console.error("Error building config file: ", filename);
+    throw result.errors;
+  }
+  try {
+    return await import(outfile);
+  } catch (error) {
+    console.error("Failed importing build config file: ", filename);
+    throw error;
+  }
+};
+var buildSchema = async ({
+  directory,
+  external
+}) => {
+  log.info(logPrefix, "Building schema...");
+  await fs.promises.mkdir("schema", {
+    recursive: true
+  });
+  try {
+    await fs.promises.access("schema/types.ts");
+  } catch {
+    await fs.promises.writeFile("schema/types.ts", "");
+  }
+  const schemaComposerPath = path.resolve(process.cwd(), directory, "schemaComposer.ts");
+  const {
+    schemaComposer
+  } = await importSchemaComposer({
+    external,
+    schemaComposerPath
+  });
+  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.writeFile("schema/schema.graphql", sdl);
+  log.info(logPrefix, "Generating types...");
+  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!");
+};
+var program = new Command();
+program.name("ttoss-graphql-api").version(package_default.version, "-v, --version", "Output the current version of the GraphQL API");
+program.command("build-schema").option("-d, --directory <directory>", "Schema composer directory", "src").option("--external <external...>", "External dependencies to ignore during build").action(options => {
+  return buildSchema(options);
+});
+program.parse(process.argv);

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+
+export {  }

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "@ttoss/graphql-api-cli",
+  "version": "0.8.1",
+  "description": "A library for building GraphQL APIs types and schema.",
+  "license": "MIT",
+  "author": "ttoss",
+  "contributors": [
+    "Pedro Arantes <pedro@arantespp.com> (https://arantespp.com)"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ttoss/ttoss.git",
+    "directory": "packages/graphql-api-cli"
+  },
+  "type": "module",
+  "bin": {
+    "ttoss-graphql-api": "./bin/cli.js"
+  },
+  "files": [
+    "dist"
+  ],
+  "sideEffects": false,
+  "peerDependencies": {
+    "graphql": "^16.6.0"
+  },
+  "devDependencies": {
+    "@graphql-codegen/core": "^4.0.2",
+    "@graphql-codegen/typescript": "^4.1.2",
+    "commander": "^12.1.0",
+    "esbuild": "^0.24.0",
+    "graphql": "^16.9.0",
+    "npmlog": "^7.0.1",
+    "tsup": "^8.3.5",
+    "@ttoss/config": "^1.35.0"
+  },
+  "keywords": [
+    "api",
+    "graphql"
+  ],
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
+  "scripts": {
+    "build-config": "tsup-node"
+  }
+}