@ttoss/graphql-api 0.5.2 → 0.6.0

package/README.md

@@ -34,6 +34,19 @@ 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:
+
+```json
+{
+  "compilerOptions": {
+    "baseUrl": ".",
+    "paths": {
+      "src/*": ["src/*"]
+    }
+  }
+}
+```
+
 ### Resolvers
 
 ### Integrate All Modules

package/dist/cli.js

@@ -34,9 +34,28 @@ 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: {
@@ -84,6 +103,7 @@ var buildSchema = async ({
   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 => {

package/dist/esm/cli.js

@@ -9,9 +9,28 @@ 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: {
@@ -59,6 +78,7 @@ var buildSchema = async ({
   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 => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ttoss/graphql-api",
-  "version": "0.5.2",
+  "version": "0.6.0",
   "description": "A library for building GraphQL APIs using ttoss ecosystem.",
   "author": "ttoss",
   "contributors": [
@@ -40,8 +40,9 @@
     "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.1.1"
+    "@ttoss/ids": "^0.2.0"
   },
   "peerDependencies": {
     "graphql": "^16.6.0"
@@ -51,7 +52,7 @@
     "graphql": "^16.8.1",
     "jest": "^29.7.0",
     "tsup": "^8.0.2",
-    "@ttoss/config": "^1.31.5"
+    "@ttoss/config": "^1.32.0"
   },
   "keywords": [
     "api",

package/src/cli.ts

@@ -5,10 +5,32 @@ 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';
 
 const logPrefix = 'graphql-api';
+// eslint-disable-next-line @typescript-eslint/no-var-requires
+const tsConfig = require(path.resolve(process.cwd(), 'tsconfig.json'));
+let 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: unknown) {
+  error instanceof Error && log.error(logPrefix, error.message);
+  process.exit(1);
+}
 
 register({
   transpileOnly: true,
@@ -77,7 +99,7 @@ const buildSchema = async ({ directory }: { directory: string }) => {
     'schema/types.ts',
     `${typesOutputIgnore}\n${typesOutput}`
   );
-
+  cleanup();
   log.info(logPrefix, 'Schema and types generated!');
 };