Add Core module to schema transformation implicitly

.changeset/cool-panthers-impress.md

@@ -0,0 +1,5 @@
+---
+"@frontside/hydraphql": minor
+---
+
+Change a way of declaring GraphQL schema mappers

.changeset/healthy-pants-remain.md

@@ -0,0 +1,5 @@
+---
+"@frontside/hydraphql": patch
+---
+
+#4 Add `Core` module to schema transformation implicitly

package.json

@@ -56,7 +56,6 @@
     "graphql-relay": "^0.10.0",
     "lodash": "^4.17.21",
     "pascal-case": "^3.1.2",
-    "reflect-metadata": "^0.1.13",
     "tslib": "^2.6.2"
   },
   "devDependencies": {

src/__testUtils__/createApi.ts

@@ -5,18 +5,17 @@ import { envelop, useEngine } from "@envelop/core";
 import { useDataLoader } from "@envelop/dataloader";
 import { useGraphQLModules } from "@envelop/graphql-modules";
 import { createGraphQLApp } from "../createGraphQLApp.js";
-import type { GraphQLContext } from "../types.js";
-import { CoreSync } from "../core/core.js";
+import type { GraphQLContext, GraphQLModule } from "../types.js";
 
 export async function createGraphQLAPI(
-  TestModule: Module,
+  TestModule: GraphQLModule | Module,
   loader: (
     context: Record<string, unknown> & GraphQLContext,
   ) => DataLoader<string, unknown>,
   generateOpaqueTypes?: boolean,
 ) {
   const application = await createGraphQLApp({
-    modules: [CoreSync(), TestModule],
+    modules: [TestModule],
     generateOpaqueTypes,
   });
 

src/core/core.ts

@@ -1,17 +1,18 @@
-import { loadFiles, loadFilesSync } from "@graphql-tools/load-files";
+import { loadFilesSync } from "@graphql-tools/load-files";
 import { createModule } from "graphql-modules";
-import type { TypeDefs } from "graphql-modules";
-import { createDirectiveMapperProvider } from "../mapperProvider.js";
-import type { ResolverContext } from "../types.js";
+import type { GraphQLModule, ResolverContext } from "../types.js";
 import { fieldDirectiveMapper } from "./fieldDirectiveMapper.js";
 import { resolveDirectiveMapper } from "./resolveDirectiveMapper.js";
 import { coreSchemaPath } from "./coreSchemaPath.cjs";
 
-/** @public */
-export const CoreSync = (typeDefs: TypeDefs = loadFilesSync(coreSchemaPath)) =>
-  createModule({
+export const CoreSync = (): GraphQLModule => ({
+  mappers: {
+    field: fieldDirectiveMapper,
+    resolve: resolveDirectiveMapper,
+  },
+  module: createModule({
     id: "core",
-    typeDefs,
+    typeDefs: loadFilesSync(coreSchemaPath),
     resolvers: {
       Node: {
         id: async (
@@ -30,11 +31,5 @@ export const CoreSync = (typeDefs: TypeDefs = loadFilesSync(coreSchemaPath)) =>
           ids.map((id) => ({ id })),
       },
     },
-    providers: [
-      createDirectiveMapperProvider("field", fieldDirectiveMapper),
-      createDirectiveMapperProvider("resolve", resolveDirectiveMapper),
-    ],
-  });
-
-/** @public */
-export const Core = async () => CoreSync(await loadFiles(coreSchemaPath));
+  }),
+});

src/createGraphQLApp.ts

@@ -2,15 +2,14 @@ import { createApplication } from "graphql-modules";
 import type { Module } from "graphql-modules";
 import { transformSchema } from "./transformSchema.js";
 import { loadSchema } from "./loadSchema.js";
+import { GraphQLModule } from "./types.js";
 
-/** @public */
 export interface createGraphQLAppOptions {
   schema?: string | string[];
-  modules?: Module[];
+  modules?: (GraphQLModule | Module)[];
   generateOpaqueTypes?: boolean;
 }
 
-/** @public */
 export async function createGraphQLApp(options: createGraphQLAppOptions) {
   const modules = options.modules ?? [];
   if (options.schema) {
@@ -21,6 +20,6 @@ export async function createGraphQLApp(options: createGraphQLAppOptions) {
   });
   return createApplication({
     schemaBuilder: () => schema,
-    modules,
+    modules: modules.map((m) => ("id" in m ? m : m.module)),
   });
 }

src/createLoader.ts

@@ -4,7 +4,6 @@ import { GraphQLError } from "graphql";
 import type { BatchLoadFn, NodeQuery, GraphQLContext } from "./types.js";
 import { decodeId } from "./helpers.js";
 
-/** @public */
 export const createLoader = <TContext extends Record<string, unknown>>(
   loaders: Record<string, BatchLoadFn<TContext & GraphQLContext>>,
   options?: Options<string, unknown>,

src/helpers.ts

@@ -14,12 +14,10 @@ import {
 import type { GraphQLNamedType, GraphQLOutputType } from "graphql";
 import type { NodeId, NodeQuery } from "./types.js";
 
-/** @public */
 export function encodeId({ source, typename, query }: NodeId): string {
   return `${typename}@${source}@${JSON.stringify(query ?? {})}`;
 }
 
-/** @public */
 export function decodeId(id: string): NodeId {
   const [typename, source, ...query] = id.split("@");
   const parsedQuery: unknown = JSON.parse(query.join("@"));
@@ -29,7 +27,6 @@ export function decodeId(id: string): NodeId {
   return { typename, source, query: parsedQuery };
 }
 
-/** @public */
 export function unboxNamedType(type: GraphQLOutputType): GraphQLNamedType {
   if (isNonNullType(type)) {
     return unboxNamedType(type.ofType);

src/index.ts

@@ -3,7 +3,6 @@ export * from "./createGraphQLApp.js";
 export * from "./core/core.js";
 export * from "./helpers.js";
 export { transformSchema } from "./transformSchema.js";
-export { createDirectiveMapperProvider } from "./mapperProvider.js";
 export type {
   GraphQLContext,
   ResolverContext,

src/mapDirectives.test.ts

@@ -5,7 +5,6 @@ import { createModule, gql } from "graphql-modules";
 import { createGraphQLAPI } from "./__testUtils__/createApi.js";
 import { transformSchema } from "./transformSchema.js";
 import type { NodeId } from "./types.js";
-import { CoreSync } from "./core/core.js";
 import { decodeId, encodeId } from "./helpers.js";
 import { createLoader } from "./createLoader.js";
 import { describe, test } from "node:test";
@@ -15,7 +14,6 @@ describe("mapDirectives", () => {
   const transform = (source: DocumentNode, generateOpaqueTypes?: boolean) =>
     transformSchema(
       [
-        CoreSync(),
         createModule({
           id: "mapDirectives",
           typeDefs: source,

src/schema.ts

@@ -1,5 +1,4 @@
 import { printSchemaWithDirectives } from "@graphql-tools/utils";
 import { transformSchema } from "./transformSchema.js";
-import { CoreSync } from "./core/core.js";
 
-export const schema = printSchemaWithDirectives(transformSchema([CoreSync()]));
+export const schema = printSchemaWithDirectives(transformSchema());

src/transformSchema.ts

@@ -4,35 +4,32 @@ import { makeExecutableSchema } from "@graphql-tools/schema";
 import { validateSchema } from "graphql";
 import type { Module, Resolvers } from "graphql-modules";
 import { mapDirectives } from "./mapDirectives.js";
-import type { FieldDirectiveMapper } from "./types.js";
-import { toPrivateProp } from "./mapperProvider.js";
+import type { FieldDirectiveMapper, GraphQLModule } from "./types.js";
+import { CoreSync } from "./index.js";
 
-/** @public */
 export function transformSchema(
-  modules: Module[] = [],
+  additionalModules: (GraphQLModule | Module)[] = [],
   { generateOpaqueTypes }: { generateOpaqueTypes?: boolean } = {},
 ) {
+  const modules = [CoreSync(), ...additionalModules];
   const directiveMappers: Record<string, FieldDirectiveMapper> = {};
-  const typeDefs: DocumentNode[] = modules.flatMap((gqlModule) => {
+  const typeDefs: DocumentNode[] = modules.flatMap((m) => {
+    const { module: gqlModule, mappers = {} } = "id" in m ? { module: m } : m;
     const documents = gqlModule.typeDefs;
     documents.forEach((document) => {
       document.definitions.forEach((definition) => {
         if (definition.kind !== Kind.DIRECTIVE_DEFINITION) return;
         const directiveName = definition.name.value;
-        const provider = gqlModule.providers?.find(
-          (p) => toPrivateProp(directiveName) in p,
-        );
-        if (provider)
-          directiveMappers[directiveName] = (
-            provider as unknown as Record<string, FieldDirectiveMapper>
-          )[toPrivateProp(directiveName)];
+        const mapper = mappers?.[directiveName];
+        if (mapper) directiveMappers[directiveName] = mapper;
       });
     });
     return documents;
   });
-  const resolvers: Resolvers = modules.flatMap(
-    ({ config }) => config.resolvers ?? [],
-  );
+  const resolvers: Resolvers = modules.flatMap((m) => {
+    const { config } = "id" in m ? m : m.module;
+    return config.resolvers ?? [];
+  });
 
   const schema = mapDirectives(makeExecutableSchema({ typeDefs, resolvers }), {
     directiveMappers,

src/types.ts

@@ -5,46 +5,39 @@ import type {
   GraphQLNamedType,
   GraphQLObjectType,
 } from "graphql";
-import type { Application } from "graphql-modules";
+import type { Application, Module } from "graphql-modules";
 
-/** @public */
 export interface NodeQuery {
   ref?: string;
   args?: Record<string, unknown>;
 }
 
-/** @public */
 export interface NodeId {
   source: string;
   typename: string;
   query?: NodeQuery;
 }
 
-/** @public */
 export type BatchLoadFn<Context extends GraphQLContext> = (
   keys: readonly (NodeQuery | undefined)[],
   context: Context,
 ) => PromiseLike<ArrayLike<unknown>>;
 
-/** @public */
 export interface GraphQLContext {
   application: Application;
 }
 
-/** @public */
 export interface ResolverContext extends GraphQLContext {
   loader: DataLoader<string, unknown>;
 }
 
-/** @public */
 export type OmitFirst<T extends unknown[]> = T extends [
   x: unknown,
   ...args: infer R,
 ]
   ? R
   : [];
 
-/** @public */
 export interface DirectiveMapperAPI {
   getImplementingTypes: (interfaceName: string) => GraphQLObjectType[];
   getDirective: (
@@ -53,7 +46,6 @@ export interface DirectiveMapperAPI {
   typeMap: Partial<Record<string, GraphQLNamedType>>;
 }
 
-/** @public */
 export type FieldDirectiveMapper = (
   fieldName: string,
   field: GraphQLFieldConfig<
@@ -69,3 +61,8 @@ export interface NamedType {
   implements: string | null;
   discriminates: Set<string>;
 }
+
+export interface GraphQLModule {
+  mappers?: Record<string, FieldDirectiveMapper>;
+  module: Module;
+}

yarn.lock

@@ -1243,7 +1243,6 @@ __metadata:
     pascal-case: ^3.1.2
     pinst: ^3.0.0
     prettier: ^3.0.3
-    reflect-metadata: ^0.1.13
     tslib: ^2.6.2
     tsx: ^3.12.7
     typescript: ^5.2.2
@@ -6559,13 +6558,6 @@ __metadata:
   languageName: node
   linkType: hard
 
-"reflect-metadata@npm:^0.1.13":
-  version: 0.1.13
-  resolution: "reflect-metadata@npm:0.1.13"
-  checksum: 798d379a7b6f6455501145419505c97dd11cbc23857a386add2b9ef15963ccf15a48d9d15507afe01d4cd74116df8a213247200bac00320bd7c11ddeaa5e8fb4
-  languageName: node
-  linkType: hard
-
 "regenerator-runtime@npm:^0.14.0":
   version: 0.14.0
   resolution: "regenerator-runtime@npm:0.14.0"