@ttoss/graphql-api 0.5.1 → 0.5.3

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
@@ -369,9 +382,28 @@ const permissions = shield(
   }
 );
 
+/**
+ * Apply middlewares to all resolvers.
+ */
+const logInput = async (resolve, source, args, context, info) => {
+  console.log(`1. logInput: ${JSON.stringify(args)}`)
+  const result = await resolve(source, args, context, info)
+  console.log(`5. logInput`)
+  return result
+}
+
+/**
+ * Apply middlewares only to a specific resolver.
+ */
+const logOnQueryMe = {
+  Query: {
+    me: logInput
+  }
+}
+
 const schema = buildSchema({
   schemaComposer,
-  middlewares; [permissions],
+  middlewares; [permissions, logInput, logOnQueryMe],
 })
 ```
 

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/dist/esm/index.js

@@ -6,27 +6,7 @@ import { ObjectTypeComposer } from "graphql-compose";
 
 // src/composeWithRelay/nodeFieldConfig.ts
 import { getProjectionFromAST } from "graphql-compose";
-
-// src/composeWithRelay/globalId.ts
-var base64 = i => {
-  return Buffer.from(i, "ascii").toString("base64");
-};
-var unbase64 = i => {
-  return Buffer.from(i, "base64").toString("ascii");
-};
-var toGlobalId = (type, recordId) => {
-  return base64([type, recordId].join(":"));
-};
-var fromGlobalId = globalId => {
-  const unbasedGlobalId = unbase64(globalId);
-  const [type, recordId] = unbasedGlobalId.split(":");
-  return {
-    type,
-    recordId
-  };
-};
-
-// src/composeWithRelay/nodeFieldConfig.ts
+import { fromGlobalId } from "@ttoss/ids";
 var getNodeFieldConfig = (typeMapForRelayNode, nodeInterface) => {
   return {
     description: "Fetches an object that has globally unique ID among all types",
@@ -37,6 +17,7 @@ var getNodeFieldConfig = (typeMapForRelayNode, nodeInterface) => {
         description: "The globally unique ID among all types"
       }
     },
+    // eslint-disable-next-line max-params
     resolve: (source, args, context, info) => {
       if (!args.id || !(typeof args.id === "string")) {
         return null;
@@ -73,7 +54,9 @@ var getNodeFieldConfig = (typeMapForRelayNode, nodeInterface) => {
           info,
           projection
         }).then(res => {
-          if (!res) return res;
+          if (!res) {
+            return res;
+          }
           res.__nodeType = graphqlType;
           return res;
         });
@@ -108,6 +91,7 @@ var getNodeInterface = sc => {
 };
 
 // src/composeWithRelay/composeWithRelay.ts
+import { toGlobalId } from "@ttoss/ids";
 var TypeMapForRelayNode = {};
 var composeWithRelay = tc => {
   if (!(tc instanceof ObjectTypeComposer)) {
@@ -138,7 +122,7 @@ var composeWithRelay = tc => {
       type: "ID!",
       description: "The globally unique ID among all types",
       resolve: source => {
-        return toGlobalId(tc.getTypeName(), tc.getRecordId(source));
+        return toGlobalId(tc.getTypeName(), tc.getRecordId(source).toString());
       }
     }
   });
@@ -174,4 +158,4 @@ var buildSchema = ({
   }
   return schema;
 };
-export { buildSchema, default2 as composeWithConnection, composeWithRelay, fromGlobalId, toGlobalId };
+export { buildSchema, default2 as composeWithConnection, composeWithRelay };

package/dist/index.d.mts

@@ -3,28 +3,14 @@ export * from 'graphql-compose';
 export { default as composeWithConnection } from 'graphql-compose-connection';
 import { GraphQLSchema } from 'graphql';
 import { IMiddleware, IMiddlewareGenerator } from 'graphql-middleware';
+export { IMiddleware as Middleware } from 'graphql-middleware';
 
 declare const composeWithRelay: <TContext>(tc: ObjectTypeComposer<any, TContext>) => ObjectTypeComposer<any, TContext>;
 
-type ResolvedGlobalId = {
-    type: string;
-    recordId: string;
-};
-/**
- * Takes a type name and an ID specific to that type name, and returns a
- * "global ID" that is unique among all types.
- */
-declare const toGlobalId: (type: string, recordId: string | number) => string;
-/**
- * Takes the "global ID" created by toGlobalID, and returns the type name and ID
- * used to create it.
- */
-declare const fromGlobalId: (globalId: string) => ResolvedGlobalId;
-
-type BuildSchemaInput<TContext = any> = {
+type BuildSchemaInput<TContext = unknown> = {
     schemaComposer: SchemaComposer<TContext>;
-    middlewares?: (IMiddleware | IMiddlewareGenerator<any, TContext, any>)[];
+    middlewares?: (IMiddleware | IMiddlewareGenerator<unknown, TContext, unknown>)[];
 };
 declare const buildSchema: ({ schemaComposer, middlewares, }: BuildSchemaInput) => GraphQLSchema;
 
-export { type BuildSchemaInput, buildSchema, composeWithRelay, fromGlobalId, toGlobalId };
+export { type BuildSchemaInput, buildSchema, composeWithRelay };

package/dist/index.d.ts

@@ -3,28 +3,14 @@ export * from 'graphql-compose';
 export { default as composeWithConnection } from 'graphql-compose-connection';
 import { GraphQLSchema } from 'graphql';
 import { IMiddleware, IMiddlewareGenerator } from 'graphql-middleware';
+export { IMiddleware as Middleware } from 'graphql-middleware';
 
 declare const composeWithRelay: <TContext>(tc: ObjectTypeComposer<any, TContext>) => ObjectTypeComposer<any, TContext>;
 
-type ResolvedGlobalId = {
-    type: string;
-    recordId: string;
-};
-/**
- * Takes a type name and an ID specific to that type name, and returns a
- * "global ID" that is unique among all types.
- */
-declare const toGlobalId: (type: string, recordId: string | number) => string;
-/**
- * Takes the "global ID" created by toGlobalID, and returns the type name and ID
- * used to create it.
- */
-declare const fromGlobalId: (globalId: string) => ResolvedGlobalId;
-
-type BuildSchemaInput<TContext = any> = {
+type BuildSchemaInput<TContext = unknown> = {
     schemaComposer: SchemaComposer<TContext>;
-    middlewares?: (IMiddleware | IMiddlewareGenerator<any, TContext, any>)[];
+    middlewares?: (IMiddleware | IMiddlewareGenerator<unknown, TContext, unknown>)[];
 };
 declare const buildSchema: ({ schemaComposer, middlewares, }: BuildSchemaInput) => GraphQLSchema;
 
-export { type BuildSchemaInput, buildSchema, composeWithRelay, fromGlobalId, toGlobalId };
+export { type BuildSchemaInput, buildSchema, composeWithRelay };

package/dist/index.js

@@ -41,9 +41,7 @@ var src_exports = {};
 __export(src_exports, {
   buildSchema: () => buildSchema,
   composeWithConnection: () => import_graphql_compose_connection.default,
-  composeWithRelay: () => composeWithRelay,
-  fromGlobalId: () => fromGlobalId,
-  toGlobalId: () => toGlobalId
+  composeWithRelay: () => composeWithRelay
 });
 module.exports = __toCommonJS(src_exports);
 
@@ -52,27 +50,7 @@ var import_graphql_compose3 = require("graphql-compose");
 
 // src/composeWithRelay/nodeFieldConfig.ts
 var import_graphql_compose = require("graphql-compose");
-
-// src/composeWithRelay/globalId.ts
-var base64 = i => {
-  return Buffer.from(i, "ascii").toString("base64");
-};
-var unbase64 = i => {
-  return Buffer.from(i, "base64").toString("ascii");
-};
-var toGlobalId = (type, recordId) => {
-  return base64([type, recordId].join(":"));
-};
-var fromGlobalId = globalId => {
-  const unbasedGlobalId = unbase64(globalId);
-  const [type, recordId] = unbasedGlobalId.split(":");
-  return {
-    type,
-    recordId
-  };
-};
-
-// src/composeWithRelay/nodeFieldConfig.ts
+var import_ids = require("@ttoss/ids");
 var getNodeFieldConfig = (typeMapForRelayNode, nodeInterface) => {
   return {
     description: "Fetches an object that has globally unique ID among all types",
@@ -83,13 +61,14 @@ var getNodeFieldConfig = (typeMapForRelayNode, nodeInterface) => {
         description: "The globally unique ID among all types"
       }
     },
+    // eslint-disable-next-line max-params
     resolve: (source, args, context, info) => {
       if (!args.id || !(typeof args.id === "string")) {
         return null;
       }
       const {
         type
-      } = fromGlobalId(args.id);
+      } = (0, import_ids.fromGlobalId)(args.id);
       if (!typeMapForRelayNode[type]) {
         return null;
       }
@@ -119,7 +98,9 @@ var getNodeFieldConfig = (typeMapForRelayNode, nodeInterface) => {
           info,
           projection
         }).then(res => {
-          if (!res) return res;
+          if (!res) {
+            return res;
+          }
           res.__nodeType = graphqlType;
           return res;
         });
@@ -154,6 +135,7 @@ var getNodeInterface = sc => {
 };
 
 // src/composeWithRelay/composeWithRelay.ts
+var import_ids2 = require("@ttoss/ids");
 var TypeMapForRelayNode = {};
 var composeWithRelay = tc => {
   if (!(tc instanceof import_graphql_compose3.ObjectTypeComposer)) {
@@ -184,7 +166,7 @@ var composeWithRelay = tc => {
       type: "ID!",
       description: "The globally unique ID among all types",
       resolve: source => {
-        return toGlobalId(tc.getTypeName(), tc.getRecordId(source));
+        return (0, import_ids2.toGlobalId)(tc.getTypeName(), tc.getRecordId(source).toString());
       }
     }
   });
@@ -225,7 +207,5 @@ var buildSchema = ({
   buildSchema,
   composeWithConnection,
   composeWithRelay,
-  fromGlobalId,
-  toGlobalId,
   ...require("graphql-compose")
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ttoss/graphql-api",
-  "version": "0.5.1",
+  "version": "0.5.3",
   "description": "A library for building GraphQL APIs using ttoss ecosystem.",
   "author": "ttoss",
   "contributors": [
@@ -32,15 +32,17 @@
   ],
   "sideEffects": false,
   "dependencies": {
-    "@graphql-codegen/core": "^4.0.0",
-    "@graphql-codegen/typescript": "^4.0.1",
+    "@graphql-codegen/core": "^4.0.2",
+    "@graphql-codegen/typescript": "^4.0.6",
     "graphql-compose": "^9.0.10",
     "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",
-    "yargs": "^17.7.2"
+    "tsconfig-paths": "^4.2.0",
+    "yargs": "^17.7.2",
+    "@ttoss/ids": "^0.1.1"
   },
   "peerDependencies": {
     "graphql": "^16.6.0"

package/src/buildSchema.ts

@@ -1,16 +1,19 @@
 import { type GraphQLSchema } from 'graphql';
 import {
-  type IMiddleware,
-  type IMiddlewareGenerator,
+  type IMiddleware as Middleware,
+  type IMiddlewareGenerator as MiddlewareGenerator,
   applyMiddleware,
 } from 'graphql-middleware';
 import { type SchemaComposer } from 'graphql-compose';
 
-export type { IMiddleware, IMiddlewareGenerator };
+export type { Middleware, MiddlewareGenerator };
 
-export type BuildSchemaInput<TContext = any> = {
+export type BuildSchemaInput<TContext = unknown> = {
   schemaComposer: SchemaComposer<TContext>;
-  middlewares?: (IMiddleware | IMiddlewareGenerator<any, TContext, any>)[];
+  middlewares?: (
+    | Middleware
+    | MiddlewareGenerator<unknown, TContext, unknown>
+  )[];
 };
 
 export const buildSchema = ({
@@ -30,10 +33,13 @@ export const buildSchema = ({
         /**
          * https://github.com/dimatill/graphql-middleware/issues/433#issuecomment-1170187160
          */
-        if ((middleware as IMiddlewareGenerator<any, any, any>).generate) {
-          return (middleware as IMiddlewareGenerator<any, any, any>).generate(
-            schema
-          );
+        if (
+          (middleware as MiddlewareGenerator<unknown, unknown, unknown>)
+            .generate
+        ) {
+          return (
+            middleware as MiddlewareGenerator<unknown, unknown, unknown>
+          ).generate(schema);
         }
 
         return middleware;

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!');
 };
 

package/src/composeWithRelay/composeWithRelay.ts

@@ -1,7 +1,8 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
 import { ObjectTypeComposer } from 'graphql-compose';
 import { getNodeFieldConfig } from './nodeFieldConfig';
 import { getNodeInterface } from './nodeInterface';
-import { toGlobalId } from './globalId';
+import { toGlobalId } from '@ttoss/ids';
 
 // all wrapped typeComposers with Relay, stored in this variable
 // for futher type resolving via NodeInterface.resolveType method
@@ -56,7 +57,7 @@ export const composeWithRelay = <TContext>(
       type: 'ID!',
       description: 'The globally unique ID among all types',
       resolve: (source) => {
-        return toGlobalId(tc.getTypeName(), tc.getRecordId(source));
+        return toGlobalId(tc.getTypeName(), tc.getRecordId(source).toString());
       },
     },
   });

package/src/composeWithRelay/index.ts

@@ -4,4 +4,3 @@ import { schemaComposer } from 'graphql-compose';
 composeWithRelay(schemaComposer.Query);
 
 export { composeWithRelay };
-export { fromGlobalId, toGlobalId } from './globalId';

package/src/composeWithRelay/nodeFieldConfig.ts

@@ -1,9 +1,10 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
 import {
   type InterfaceTypeComposer,
   type ObjectTypeComposerFieldConfigDefinition,
   getProjectionFromAST,
 } from 'graphql-compose';
-import { fromGlobalId } from './globalId';
+import { fromGlobalId } from '@ttoss/ids';
 import type { GraphQLResolveInfo } from 'graphql-compose/lib/graphql';
 import type { ObjectTypeComposer, Resolver } from 'graphql-compose';
 
@@ -29,6 +30,7 @@ export const getNodeFieldConfig = (
         description: 'The globally unique ID among all types',
       },
     },
+    // eslint-disable-next-line max-params
     resolve: (
       source: any,
       args: { [argName: string]: any },
@@ -70,7 +72,9 @@ export const getNodeFieldConfig = (
             projection,
           })
           .then((res: any) => {
-            if (!res) return res;
+            if (!res) {
+              return res;
+            }
             res.__nodeType = graphqlType;
             return res;
           });

package/src/index.ts

@@ -1,4 +1,8 @@
-export { composeWithRelay, toGlobalId, fromGlobalId } from './composeWithRelay';
+export { composeWithRelay } from './composeWithRelay';
 export { default as composeWithConnection } from 'graphql-compose-connection';
 export * from 'graphql-compose';
-export { buildSchema, type BuildSchemaInput } from './buildSchema';
+export {
+  buildSchema,
+  type BuildSchemaInput,
+  type Middleware,
+} from './buildSchema';

package/src/composeWithRelay/globalId.ts

@@ -1,32 +0,0 @@
-export type Base64String = string;
-
-export type ResolvedGlobalId = {
-  type: string;
-  recordId: string;
-};
-
-export const base64 = (i: string): Base64String => {
-  return Buffer.from(i, 'ascii').toString('base64');
-};
-
-export const unbase64 = (i: Base64String): string => {
-  return Buffer.from(i, 'base64').toString('ascii');
-};
-
-/**
- * Takes a type name and an ID specific to that type name, and returns a
- * "global ID" that is unique among all types.
- */
-export const toGlobalId = (type: string, recordId: string | number): string => {
-  return base64([type, recordId].join(':'));
-};
-
-/**
- * Takes the "global ID" created by toGlobalID, and returns the type name and ID
- * used to create it.
- */
-export const fromGlobalId = (globalId: string): ResolvedGlobalId => {
-  const unbasedGlobalId = unbase64(globalId);
-  const [type, recordId] = unbasedGlobalId.split(':');
-  return { type, recordId };
-};