@ttoss/graphql-api 0.7.8 → 0.8.1

package/README.md

@@ -1,12 +1,21 @@
 # @ttoss/graphql-api
 
-This package provides an opinionated way to create an GraphQL API using ttoss ecosystem modules. The main goal of this package is to provide a resilient way to create a complex GraphQL API to meet the following goals:
+This package offers an opinionated approach to building a GraphQL API using the **ttoss ecosystem modules**. It is designed to provide a resilient and scalable solution for creating complex GraphQL APIs while focusing on the following goals:
 
-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.
+1. **Modular Design**:  
+   Build your GraphQL API using modules to simplify and organize the development of large, complex APIs.
+
+1. **Relay Compatibility**:  
+   As **Relay** is the primary GraphQL client in the ttoss ecosystem, this package implements the [Relay Server Specification](https://relay.dev/docs/guides/graphql-server-specification/) for seamless client-server interaction.
+
+1. **Schema Building**:  
+   Generate the GraphQL schema required for Relay's introspection queries with [@ttoss/graphql-api-cli](https://ttoss.dev/docs/modules/packages/graphql-api-cli/).
+
+1. **TypeScript Types Generation**:
+   Automatically generate TypeScript types for your GraphQL schema with [@ttoss/graphql-api-cli](https://ttoss.dev/docs/modules/packages/graphql-api-cli/).
+
+1. **AWS AppSync Support**:
+   Create GraphQL APIs compatible with AWS AppSync. Additionally, this package includes support for running a local GraphQL API server for development and testing purposes.
 
 ## Installation
 
@@ -429,27 +438,7 @@ import { allow, deny, shield } from '@ttoss/graphql-api/shield';
 
 ## Building Schema and Types
 
-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 `build-schema` script to your `package.json`:
-
-```json
-{
-  "scripts": {
-    "build-schema": "ttoss-graphl-api build-schema"
-  }
-}
-```
-
-If your `schemaComposer` is in a different directory, you can pass the `--directory`/`-d` option to `ttoss-graphl-api build-schema` command:
-
-```bash
-ttoss-graphl-api build-schema -d tests
-```
+Check [@ttoss/graphql-api-cli](https://ttoss.dev/docs/modules/packages/graphql-api-cli/) for more information about how to build the schema and types.
 
 ## How to Create Tests
 

package/dist/esm/index.js

@@ -1,5 +1,4 @@
 /** Powered by @ttoss/config. https://ttoss.dev/docs/modules/packages/config/ */
-import "./chunk-NT3ZWSM6.js";
 
 // src/composeWithRelay/composeWithRelay.ts
 import { ObjectTypeComposer } from "graphql-compose";
@@ -135,7 +134,7 @@ import { schemaComposer } from "graphql-compose";
 composeWithRelay(schemaComposer.Query);
 
 // src/index.ts
-import { default as default2 } from "graphql-compose-connection";
+import { composeWithConnection } from "graphql-compose-connection";
 export * from "graphql-compose";
 
 // src/buildSchema.ts
@@ -158,4 +157,4 @@ var buildSchema = ({
   }
   return schema;
 };
-export { buildSchema, default2 as composeWithConnection, composeWithRelay };
+export { buildSchema, composeWithConnection, composeWithRelay };

package/dist/{index.d.mts → index.d.cts}

@@ -1,6 +1,6 @@
 import { ObjectTypeComposer, SchemaComposer } from 'graphql-compose';
 export * from 'graphql-compose';
-export { default as composeWithConnection } from 'graphql-compose-connection';
+export { composeWithConnection } from 'graphql-compose-connection';
 import { GraphQLSchema } from 'graphql';
 import { IMiddleware, IMiddlewareGenerator } from 'graphql-middleware';
 export { IMiddleware as Middleware } from 'graphql-middleware';

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import { ObjectTypeComposer, SchemaComposer } from 'graphql-compose';
 export * from 'graphql-compose';
-export { default as composeWithConnection } from 'graphql-compose-connection';
+export { composeWithConnection } from 'graphql-compose-connection';
 import { GraphQLSchema } from 'graphql';
 import { IMiddleware, IMiddlewareGenerator } from 'graphql-middleware';
 export { IMiddleware as Middleware } from 'graphql-middleware';

package/dist/index.js

@@ -1,11 +1,9 @@
 /** Powered by @ttoss/config. https://ttoss.dev/docs/modules/packages/config/ */
 "use strict";
 
-var __create = Object.create;
 var __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
 var __getOwnPropNames = Object.getOwnPropertyNames;
-var __getProtoOf = Object.getPrototypeOf;
 var __hasOwnProp = Object.prototype.hasOwnProperty;
 var __export = (target, all) => {
   for (var name in all) __defProp(target, name, {
@@ -23,15 +21,6 @@ var __copyProps = (to, from, except, desc) => {
   return to;
 };
 var __reExport = (target, mod, secondTarget) => (__copyProps(target, mod, "default"), secondTarget && __copyProps(secondTarget, mod, "default"));
-var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
-// If the importer is in node compatibility mode or this is not an ESM
-// file that has been converted to a CommonJS file using a Babel-
-// compatible transform (i.e. "__esModule" has not been set), then set
-// "default" to the CommonJS "module.exports" for node compatibility.
-isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", {
-  value: mod,
-  enumerable: true
-}) : target, mod));
 var __toCommonJS = mod => __copyProps(__defProp({}, "__esModule", {
   value: true
 }), mod);
@@ -40,7 +29,7 @@ var __toCommonJS = mod => __copyProps(__defProp({}, "__esModule", {
 var src_exports = {};
 __export(src_exports, {
   buildSchema: () => buildSchema,
-  composeWithConnection: () => import_graphql_compose_connection.default,
+  composeWithConnection: () => import_graphql_compose_connection.composeWithConnection,
   composeWithRelay: () => composeWithRelay
 });
 module.exports = __toCommonJS(src_exports);
@@ -179,7 +168,7 @@ var import_graphql_compose4 = require("graphql-compose");
 composeWithRelay(import_graphql_compose4.schemaComposer.Query);
 
 // src/index.ts
-var import_graphql_compose_connection = __toESM(require("graphql-compose-connection"));
+var import_graphql_compose_connection = require("graphql-compose-connection");
 __reExport(src_exports, require("graphql-compose"), module.exports);
 
 // src/buildSchema.ts

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ttoss/graphql-api",
-  "version": "0.7.8",
+  "version": "0.8.1",
   "description": "A library for building GraphQL APIs using ttoss ecosystem.",
   "license": "MIT",
   "author": "ttoss",
@@ -12,6 +12,7 @@
     "url": "https://github.com/ttoss/ttoss.git",
     "directory": "packages/graphql-api"
   },
+  "type": "module",
   "exports": {
     ".": {
       "import": "./dist/esm/index.js",
@@ -24,35 +25,26 @@
       "types": "./dist/shield.d.ts"
     }
   },
-  "bin": {
-    "ttoss-graphql-api": "./bin/cli.js"
-  },
   "files": [
     "dist"
   ],
   "sideEffects": false,
   "dependencies": {
-    "@graphql-codegen/core": "^4.0.2",
-    "@graphql-codegen/typescript": "^4.0.6",
-    "graphql-compose": "^9.0.10",
+    "graphql-compose": "^9.0.11",
     "graphql-compose-connection": "^8.2.1",
     "graphql-middleware": "^6.1.35",
     "graphql-shield": "^7.6.5",
     "npmlog": "^7.0.1",
-    "ts-node": "^10.9.2",
-    "tsconfig-paths": "^4.2.0",
-    "yargs": "^17.7.2",
-    "@ttoss/ids": "^0.2.14"
+    "@ttoss/ids": "^0.3.0"
   },
   "peerDependencies": {
     "graphql": "^16.6.0"
   },
   "devDependencies": {
-    "@types/yargs": "^17.0.33",
-    "graphql": "^16.8.1",
+    "graphql": "^16.9.0",
     "jest": "^29.7.0",
     "tsup": "^8.3.5",
-    "@ttoss/config": "^1.34.2"
+    "@ttoss/config": "^1.35.0"
   },
   "keywords": [
     "api",
@@ -63,7 +55,7 @@
     "provenance": true
   },
   "scripts": {
-    "build-config": "tsup-node",
-    "test": "jest"
+    "build": "tsup",
+    "test": "jest --projects tests/unit"
   }
 }

package/bin/cli.js

@@ -1,2 +0,0 @@
-#!/usr/bin/env node
-require('../dist/cli.js');

package/dist/cli.d.mts

@@ -1,2 +0,0 @@
-import 'graphql-shield';
-import 'graphql-middleware';

package/dist/cli.d.ts

@@ -1,2 +0,0 @@
-import 'graphql-shield';
-import 'graphql-middleware';

package/dist/cli.js

@@ -1,120 +0,0 @@
-/** Powered by @ttoss/config. https://ttoss.dev/docs/modules/packages/config/ */
-"use strict";
-
-var __create = Object.create;
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __getProtoOf = Object.getPrototypeOf;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from)) if (!__hasOwnProp.call(to, key) && key !== except) __defProp(to, key, {
-      get: () => from[key],
-      enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable
-    });
-  }
-  return to;
-};
-var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
-// If the importer is in node compatibility mode or this is not an ESM
-// file that has been converted to a CommonJS file using a Babel-
-// compatible transform (i.e. "__esModule" has not been set), then set
-// "default" to the CommonJS "module.exports" for node compatibility.
-isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", {
-  value: mod,
-  enumerable: true
-}) : target, mod));
-
-// 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_helpers = require("yargs/helpers");
-var import_graphql = require("graphql");
-var import_ts_node = require("ts-node");
-var import_tsconfig_paths = require("tsconfig-paths");
-var import_npmlog = __toESM(require("npmlog"));
-var import_yargs = __toESM(require("yargs"));
-var logPrefix = "graphql-api";
-var tsConfig = require(path.resolve(process.cwd(), "tsconfig.json"));
-var cleanup = () => {};
-try {
-  const baseUrl = tsConfig?.compilerOptions?.baseUrl;
-  const paths = tsConfig?.compilerOptions?.paths;
-  if (baseUrl && !paths || !baseUrl && paths) {
-    throw new Error("tsconfig.json must have 'baseUrl' and 'paths' properties.");
-  }
-  if (baseUrl && paths) {
-    cleanup = (0, import_tsconfig_paths.register)({
-      baseUrl: tsConfig.compilerOptions.baseUrl,
-      paths: tsConfig.compilerOptions.paths
-    });
-  }
-} catch (error) {
-  error instanceof Error && import_npmlog.default.error(logPrefix, error.message);
-  process.exit(1);
-}
-(0, import_ts_node.register)({
-  transpileOnly: true,
-  compilerOptions: {
-    module: "NodeNext",
-    moduleResolution: "NodeNext"
-  }
-});
-var buildSchema = async ({
-  directory
-}) => {
-  import_npmlog.default.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 {
-    schemaComposer
-  } = require(path.resolve(process.cwd(), directory, "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.writeFile("schema/schema.graphql", sdl);
-  import_npmlog.default.info(logPrefix, "Generating types...");
-  const typesOutput = await (0, import_core.codegen)(codegenConfig);
-  const typesOutputIgnore = ["/* eslint-disable */"].join("\n");
-  await fs.promises.writeFile("schema/types.ts", `${typesOutputIgnore}
-${typesOutput}`);
-  cleanup();
-  import_npmlog.default.info(logPrefix, "Schema and types generated!");
-};
-(0, import_yargs.default)((0, import_helpers.hideBin)(process.argv)).command("build-schema", "fetch the contents of the URL", yargs2 => {
-  return yargs2.options({
-    directory: {
-      alias: ["d"],
-      type: "string",
-      describe: "Schema composer directory relative to the project root",
-      default: "src"
-    }
-  });
-}, argv => {
-  return buildSchema(argv);
-}).demandCommand(1).strictOptions().parse();

package/dist/esm/chunk-NT3ZWSM6.js

@@ -1,8 +0,0 @@
-/** Powered by @ttoss/config. https://ttoss.dev/docs/modules/packages/config/ */
-var __require = /* @__PURE__ */(x => typeof require !== "undefined" ? require : typeof Proxy !== "undefined" ? new Proxy(x, {
-  get: (a, b) => (typeof require !== "undefined" ? require : a)[b]
-}) : x)(function (x) {
-  if (typeof require !== "undefined") return require.apply(this, arguments);
-  throw Error('Dynamic require of "' + x + '" is not supported');
-});
-export { __require };

package/dist/esm/cli.js

@@ -1,95 +0,0 @@
-/** Powered by @ttoss/config. https://ttoss.dev/docs/modules/packages/config/ */
-import { __require } from "./chunk-NT3ZWSM6.js";
-
-// src/cli.ts
-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 { hideBin } from "yargs/helpers";
-import { parse } from "graphql";
-import { register } from "ts-node";
-import { register as registerTsPaths } from "tsconfig-paths";
-import log from "npmlog";
-import yargs from "yargs";
-var logPrefix = "graphql-api";
-var tsConfig = __require(path.resolve(process.cwd(), "tsconfig.json"));
-var cleanup = () => {};
-try {
-  const baseUrl = tsConfig?.compilerOptions?.baseUrl;
-  const paths = tsConfig?.compilerOptions?.paths;
-  if (baseUrl && !paths || !baseUrl && paths) {
-    throw new Error("tsconfig.json must have 'baseUrl' and 'paths' properties.");
-  }
-  if (baseUrl && paths) {
-    cleanup = registerTsPaths({
-      baseUrl: tsConfig.compilerOptions.baseUrl,
-      paths: tsConfig.compilerOptions.paths
-    });
-  }
-} catch (error) {
-  error instanceof Error && log.error(logPrefix, error.message);
-  process.exit(1);
-}
-register({
-  transpileOnly: true,
-  compilerOptions: {
-    module: "NodeNext",
-    moduleResolution: "NodeNext"
-  }
-});
-var buildSchema = async ({
-  directory
-}) => {
-  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 {
-    schemaComposer
-  } = __require(path.resolve(process.cwd(), directory, "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.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}`);
-  cleanup();
-  log.info(logPrefix, "Schema and types generated!");
-};
-yargs(hideBin(process.argv)).command("build-schema", "fetch the contents of the URL", yargs2 => {
-  return yargs2.options({
-    directory: {
-      alias: ["d"],
-      type: "string",
-      describe: "Schema composer directory relative to the project root",
-      default: "src"
-    }
-  });
-}, argv => {
-  return buildSchema(argv);
-}).demandCommand(1).strictOptions().parse();