@tinkerstack/graphql-annotation 0.0.3 → 0.0.6

package/src/modules/core/annotation.module.ts

@@ -1,47 +1,47 @@
-import { DynamicModule, Module } from "@nestjs/common";
-import { DiscoveryModule } from "@nestjs/core";
-import { GraphQLAnnotationResolver } from "./annotation.resolver";
-import { GraphQLAnnotatedSchemaLoader } from "./annotation.loader";
-import { ResolverDiscoveryService } from "./resolver.explorer";
-import {
-  ANNOTATION_RESOLVER_METADATA,
-  GraphQLAnnotationResolverMetadata,
-} from "./annotation.constants";
-
-@Module({})
-export class GraphQLAnnotationModule {
-  static forRoot(opts?: { serveAnnotations?: false }): DynamicModule;
-  static forRoot(opts: {
-    serveAnnotations: true;
-    serveConfig: GraphQLAnnotationResolverMetadata;
-  }): DynamicModule;
-  static forRoot(opts?: {
-    serveAnnotations?: boolean;
-    serveConfig?: GraphQLAnnotationResolverMetadata;
-  }): DynamicModule {
-    if (opts?.serveAnnotations)
-      return {
-        global: true,
-        module: GraphQLAnnotationModule,
-        imports: [DiscoveryModule],
-        providers: [
-          ResolverDiscoveryService,
-          GraphQLAnnotatedSchemaLoader,
-          {
-            provide: ANNOTATION_RESOLVER_METADATA,
-            useValue: opts.serveConfig!,
-          },
-          GraphQLAnnotationResolver,
-        ],
-        exports: [GraphQLAnnotatedSchemaLoader],
-      };
-
-    return {
-      global: true,
-      module: GraphQLAnnotationModule,
-      imports: [DiscoveryModule],
-      providers: [ResolverDiscoveryService, GraphQLAnnotatedSchemaLoader],
-      exports: [GraphQLAnnotatedSchemaLoader],
-    };
-  }
-}
+import { DynamicModule, Module } from "@nestjs/common";
+import { DiscoveryModule } from "@nestjs/core";
+import { GraphQLAnnotationResolver } from "./annotation.resolver";
+import { GraphQLAnnotatedSchemaLoader } from "./annotation.loader";
+import { ResolverDiscoveryService } from "./resolver.explorer";
+import {
+  ANNOTATION_RESOLVER_METADATA,
+  GraphQLAnnotationResolverMetadata,
+} from "./annotation.constants";
+
+@Module({})
+export class GraphQLAnnotationModule {
+  static forRoot(opts?: { serveAnnotations?: false }): DynamicModule;
+  static forRoot(opts: {
+    serveAnnotations: true;
+    serveConfig: GraphQLAnnotationResolverMetadata;
+  }): DynamicModule;
+  static forRoot(opts?: {
+    serveAnnotations?: boolean;
+    serveConfig?: GraphQLAnnotationResolverMetadata;
+  }): DynamicModule {
+    if (opts?.serveAnnotations)
+      return {
+        global: true,
+        module: GraphQLAnnotationModule,
+        imports: [DiscoveryModule],
+        providers: [
+          ResolverDiscoveryService,
+          GraphQLAnnotatedSchemaLoader,
+          {
+            provide: ANNOTATION_RESOLVER_METADATA,
+            useValue: opts.serveConfig!,
+          },
+          GraphQLAnnotationResolver,
+        ],
+        exports: [GraphQLAnnotatedSchemaLoader],
+      };
+
+    return {
+      global: true,
+      module: GraphQLAnnotationModule,
+      imports: [DiscoveryModule],
+      providers: [ResolverDiscoveryService, GraphQLAnnotatedSchemaLoader],
+      exports: [GraphQLAnnotatedSchemaLoader],
+    };
+  }
+}

package/src/modules/core/annotation.resolver.ts

@@ -1,87 +1,87 @@
-import { Inject, Injectable, Logger, OnModuleInit } from "@nestjs/common";
-import { MetadataScanner } from "@nestjs/core";
-import { Field, ObjectType, Query, Resolver } from "@nestjs/graphql";
-import { GraphQLJSONObject } from "graphql-scalars";
-import "reflect-metadata";
-import type {
-  AnnotationInfo,
-  GraphQLAnnotationResolverMetadata,
-  GraphQLResolversAnnotations,
-} from "./annotation.constants";
-import {
-  ANNOTATION_METADATA,
-  ANNOTATION_RESOLVER_METADATA,
-} from "./annotation.constants";
-import { ResolverDiscoveryService } from "./resolver.explorer";
-
-@ObjectType()
-export class GraphQLAnnotationMeta {
-  @Field(() => String)
-  name: string;
-
-  @Field(() => GraphQLJSONObject, { name: "resolvers" })
-  resolvers: GraphQLResolversAnnotations;
-}
-
-export const ANNOTATION_QUERY_NAME = "_annotations";
-
-@Resolver()
-@Injectable()
-export class GraphQLAnnotationResolver implements OnModuleInit {
-  private _logger = new Logger("GraphQLAnnotationModule");
-
-  constructor(
-    private readonly metadataScanner: MetadataScanner,
-    private readonly resolverDiscoveryService: ResolverDiscoveryService,
-    @Inject(ANNOTATION_RESOLVER_METADATA)
-    private readonly meta: GraphQLAnnotationResolverMetadata,
-  ) {}
-
-  @Query(() => GraphQLAnnotationMeta, {
-    name: ANNOTATION_QUERY_NAME,
-  })
-  async getGraphQLAnnotations() {
-    return {
-      ...this.meta,
-      resolvers: this.resolverAnnotations,
-    } satisfies GraphQLAnnotationMeta;
-  }
-
-  private resolverAnnotations = {} as GraphQLResolversAnnotations;
-  async onModuleInit() {
-    this.resolverAnnotations = this.compileResolversAnnotations();
-  }
-
-  private compileResolversAnnotations() {
-    const instances = this.resolverDiscoveryService.explore();
-    const resolversAnnotations = {} as GraphQLResolversAnnotations;
-
-    for (const { instance } of instances)
-      for (const methodName of this.metadataScanner.getAllMethodNames(
-        Object.getPrototypeOf(instance),
-      )) {
-        const annotations = [
-          ...Object.values(
-            Reflect.getMetadata(ANNOTATION_METADATA, instance[methodName]) ??
-              {},
-          ),
-          ...Object.values(
-            Reflect.getMetadata(
-              ANNOTATION_METADATA,
-              instance.constructor,
-              methodName,
-            ) ?? {},
-          ),
-        ] as AnnotationInfo[];
-
-        if (annotations.length <= 0) continue;
-
-        resolversAnnotations[methodName] = annotations;
-        this._logger.log(
-          `Discovered annotated resolver "${instance.constructor.name}.${methodName}" with ${annotations.length} annotation(s)`,
-        );
-      }
-
-    return resolversAnnotations;
-  }
-}
+import { Inject, Injectable, Logger, OnModuleInit } from "@nestjs/common";
+import { MetadataScanner } from "@nestjs/core";
+import { Field, ObjectType, Query, Resolver } from "@nestjs/graphql";
+import { GraphQLJSONObject } from "graphql-scalars";
+import "reflect-metadata";
+import type {
+  AnnotationInfo,
+  GraphQLAnnotationResolverMetadata,
+  GraphQLResolversAnnotations,
+} from "./annotation.constants";
+import {
+  ANNOTATION_METADATA,
+  ANNOTATION_RESOLVER_METADATA,
+} from "./annotation.constants";
+import { ResolverDiscoveryService } from "./resolver.explorer";
+
+@ObjectType()
+export class GraphQLAnnotationMeta {
+  @Field(() => String)
+  name: string;
+
+  @Field(() => GraphQLJSONObject, { name: "resolvers" })
+  resolvers: GraphQLResolversAnnotations;
+}
+
+export const ANNOTATION_QUERY_NAME = "_annotations";
+
+@Resolver()
+@Injectable()
+export class GraphQLAnnotationResolver implements OnModuleInit {
+  private _logger = new Logger("GraphQLAnnotationModule");
+
+  constructor(
+    private readonly metadataScanner: MetadataScanner,
+    private readonly resolverDiscoveryService: ResolverDiscoveryService,
+    @Inject(ANNOTATION_RESOLVER_METADATA)
+    private readonly meta: GraphQLAnnotationResolverMetadata,
+  ) {}
+
+  @Query(() => GraphQLAnnotationMeta, {
+    name: ANNOTATION_QUERY_NAME,
+  })
+  async getGraphQLAnnotations() {
+    return {
+      ...this.meta,
+      resolvers: this.resolverAnnotations,
+    } satisfies GraphQLAnnotationMeta;
+  }
+
+  private resolverAnnotations = {} as GraphQLResolversAnnotations;
+  async onModuleInit() {
+    this.resolverAnnotations = this.compileResolversAnnotations();
+  }
+
+  private compileResolversAnnotations() {
+    const instances = this.resolverDiscoveryService.explore();
+    const resolversAnnotations = {} as GraphQLResolversAnnotations;
+
+    for (const { instance } of instances)
+      for (const methodName of this.metadataScanner.getAllMethodNames(
+        Object.getPrototypeOf(instance),
+      )) {
+        const annotations = [
+          ...Object.values(
+            Reflect.getMetadata(ANNOTATION_METADATA, instance[methodName]) ??
+              {},
+          ),
+          ...Object.values(
+            Reflect.getMetadata(
+              ANNOTATION_METADATA,
+              instance.constructor,
+              methodName,
+            ) ?? {},
+          ),
+        ] as AnnotationInfo[];
+
+        if (annotations.length <= 0) continue;
+
+        resolversAnnotations[methodName] = annotations;
+        this._logger.log(
+          `Discovered annotated resolver "${instance.constructor.name}.${methodName}" with ${annotations.length} annotation(s)`,
+        );
+      }
+
+    return resolversAnnotations;
+  }
+}

package/src/modules/core/annotation.utils.ts

@@ -1,48 +1,48 @@
-import { buildHTTPExecutor } from "@graphql-tools/executor-http";
-import { schemaFromExecutor } from "@graphql-tools/wrap";
-import type { SubschemaConfig } from "@graphql-tools/delegate";
-
-export async function loadGraphQLSchema(url: string) {
-  const executor = buildHTTPExecutor({
-    endpoint: url,
-  });
-  return {
-    schema: await schemaFromExecutor(executor),
-    executor, // Has to be included.
-  } as SubschemaConfig;
-}
-
-export function split<TItem, TFilteredItem extends TItem = TItem>(
-  array: Array<TItem>,
-  predicate: (item: TItem) => item is TFilteredItem,
-) {
-  const match = [] as TItem[];
-  const rest = [] as TItem[];
-  array.forEach((item) => {
-    const matchedPredicate = predicate(item);
-    const target = matchedPredicate ? match : rest;
-    target.push(item);
-  });
-
-  return [
-    match as TFilteredItem[],
-    rest as Exclude<TItem, TFilteredItem>[],
-  ] as const;
-}
-
-export function shallowMerge<TObj extends Record<string, any>[]>(
-  objects: [...TObj],
-) {
-  type MergeObjectTuples<T> = T extends [infer THead, ...infer TRest]
-    ? THead & MergeObjectTuples<TRest>
-    : unknown;
-
-  const res = {} as TObj;
-  objects.forEach((o) => Object.assign(res, o));
-  return res as MergeObjectTuples<TObj>;
-}
-
-export function isPlainObject(obj: any): obj is Record<PropertyKey, any> {
-  const prototype = Object.getPrototypeOf(obj);
-  return prototype === Object.getPrototypeOf({}) || prototype === null;
-}
+import { buildHTTPExecutor } from "@graphql-tools/executor-http";
+import { schemaFromExecutor } from "@graphql-tools/wrap";
+import type { SubschemaConfig } from "@graphql-tools/delegate";
+
+export async function loadGraphQLSchema(url: string) {
+  const executor = buildHTTPExecutor({
+    endpoint: url,
+  });
+  return {
+    schema: await schemaFromExecutor(executor),
+    executor, // Has to be included.
+  } as SubschemaConfig;
+}
+
+export function split<TItem, TFilteredItem extends TItem = TItem>(
+  array: Array<TItem>,
+  predicate: (item: TItem) => item is TFilteredItem,
+) {
+  const match = [] as TItem[];
+  const rest = [] as TItem[];
+  array.forEach((item) => {
+    const matchedPredicate = predicate(item);
+    const target = matchedPredicate ? match : rest;
+    target.push(item);
+  });
+
+  return [
+    match as TFilteredItem[],
+    rest as Exclude<TItem, TFilteredItem>[],
+  ] as const;
+}
+
+export function shallowMerge<TObj extends Record<string, any>[]>(
+  objects: [...TObj],
+) {
+  type MergeObjectTuples<T> = T extends [infer THead, ...infer TRest]
+    ? THead & MergeObjectTuples<TRest>
+    : unknown;
+
+  const res = {} as TObj;
+  objects.forEach((o) => Object.assign(res, o));
+  return res as MergeObjectTuples<TObj>;
+}
+
+export function isPlainObject(obj: any): obj is Record<PropertyKey, any> {
+  const prototype = Object.getPrototypeOf(obj);
+  return prototype === Object.getPrototypeOf({}) || prototype === null;
+}

package/src/modules/core/index.ts

@@ -1,4 +1,4 @@
-export * from "./annotation.decorators";
-export * from "./annotation.constants";
-export * from "./annotation.loader";
-export * from "./annotation.module";
+export * from "./annotation.decorators";
+export * from "./annotation.constants";
+export * from "./annotation.loader";
+export * from "./annotation.module";

package/src/modules/core/resolver.explorer.ts

@@ -1,31 +1,31 @@
-import { Injectable } from "@nestjs/common";
-import { DiscoveryService } from "@nestjs/core";
-import { InstanceWrapper } from "@nestjs/core/injector/instance-wrapper";
-import { RESOLVER_TYPE_METADATA } from "@nestjs/graphql";
-
-@Injectable()
-export class ResolverDiscoveryService {
-  constructor(
-    // NOTE: use `ModulesContainer` if robust module exclusion is needed
-    private readonly discoveryService: DiscoveryService,
-  ) {}
-
-  public explore() {
-    // Discovery logic is derived from https://github.com/nestjs/graphql/blob/51d3e1cbc827124a8b0e79370e26abfc5d9bd154/packages/graphql/lib/services/resolvers-explorer.service.ts#L47
-    const wrappedProviders = this.discoveryService.getProviders();
-    return wrappedProviders.flatMap((wrapped) => {
-      const { instance } = wrapped;
-      if (!instance) return []; // Otherwise will error on `getMetadata` due to `undefined`
-
-      // Don't get because the name can be `undefined`
-      // Not sure how on their lib still function even in case of `undefined`, probably in filtering
-      const isResolver = Reflect.hasMetadata(
-        RESOLVER_TYPE_METADATA,
-        instance.constructor,
-      );
-      if (!isResolver) return []; // Skip non-resolvers
-
-      return wrapped;
-    }) as InstanceWrapper[];
-  }
-}
+import { Injectable } from "@nestjs/common";
+import { DiscoveryService } from "@nestjs/core";
+import { InstanceWrapper } from "@nestjs/core/injector/instance-wrapper";
+import { RESOLVER_TYPE_METADATA } from "@nestjs/graphql";
+
+@Injectable()
+export class ResolverDiscoveryService {
+  constructor(
+    // NOTE: use `ModulesContainer` if robust module exclusion is needed
+    private readonly discoveryService: DiscoveryService,
+  ) {}
+
+  public explore() {
+    // Discovery logic is derived from https://github.com/nestjs/graphql/blob/51d3e1cbc827124a8b0e79370e26abfc5d9bd154/packages/graphql/lib/services/resolvers-explorer.service.ts#L47
+    const wrappedProviders = this.discoveryService.getProviders();
+    return wrappedProviders.flatMap((wrapped) => {
+      const { instance } = wrapped;
+      if (!instance) return []; // Otherwise will error on `getMetadata` due to `undefined`
+
+      // Don't get because the name can be `undefined`
+      // Not sure how on their lib still function even in case of `undefined`, probably in filtering
+      const isResolver = Reflect.hasMetadata(
+        RESOLVER_TYPE_METADATA,
+        instance.constructor,
+      );
+      if (!isResolver) return []; // Skip non-resolvers
+
+      return wrapped;
+    }) as InstanceWrapper[];
+  }
+}

package/src/modules/index.ts

@@ -1 +1 @@
-export * from "./core";
+export * from "./core";

package/tsconfig.build.json

@@ -1,5 +1,5 @@
-{
-  "extends": "./tsconfig.json",
-  "compilerOptions": { "incremental": false },
-  "exclude": ["node_modules", "test", "dist", "**/*spec.ts", "src/example"]
-}
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": { "incremental": false },
+  "exclude": ["node_modules", "test", "dist", "**/*spec.ts", "src/example"]
+}

package/tsconfig.json

@@ -1,30 +1,30 @@
-{
-  "ts-node": {
-    "require": ["tsconfig-paths/register"] // configuration for typeorm migration
-  },
-  "compilerOptions": {
-    "jsx": "react",
-    "module": "commonjs",
-    "declaration": true,
-    "removeComments": true,
-    "emitDecoratorMetadata": true,
-    "experimentalDecorators": true,
-    "allowSyntheticDefaultImports": true,
-    "target": "ES2022",
-    "sourceMap": true,
-    "outDir": "./dist",
-    "baseUrl": "./",
-    "incremental": true,
-    "skipLibCheck": true,
-    "strictNullChecks": true,
-    "noImplicitAny": false,
-    "strictBindCallApply": false,
-    "forceConsistentCasingInFileNames": false,
-    "noFallthroughCasesInSwitch": false,
-    "esModuleInterop": true,
-    "importHelpers": true,
-    "paths": {
-      "@/*": ["src/*"]
-    }
-  }
-}
+{
+  "ts-node": {
+    "require": ["tsconfig-paths/register"] // configuration for typeorm migration
+  },
+  "compilerOptions": {
+    "jsx": "react",
+    "module": "commonjs",
+    "declaration": true,
+    "removeComments": true,
+    "emitDecoratorMetadata": true,
+    "experimentalDecorators": true,
+    "allowSyntheticDefaultImports": true,
+    "target": "ES2022",
+    "sourceMap": true,
+    "outDir": "./dist",
+    "baseUrl": "./",
+    "incremental": true,
+    "skipLibCheck": true,
+    "strictNullChecks": true,
+    "noImplicitAny": false,
+    "strictBindCallApply": false,
+    "forceConsistentCasingInFileNames": false,
+    "noFallthroughCasesInSwitch": false,
+    "esModuleInterop": true,
+    "importHelpers": true,
+    "paths": {
+      "@/*": ["src/*"]
+    }
+  }
+}

package/tsup.config.ts

@@ -1,10 +1,10 @@
-import { defineConfig } from "tsup";
-
-export default defineConfig({
-  tsconfig: "tsconfig.build.json",
-  entry: ["src/index.ts"],
-  format: ["esm", "cjs"],
-  outDir: "dist",
-  dts: true,
-  clean: true,
-});
+import { defineConfig } from "tsup";
+
+export default defineConfig({
+  tsconfig: "tsconfig.build.json",
+  entry: ["src/index.ts"],
+  format: ["esm", "cjs"],
+  outDir: "dist",
+  dts: true,
+  clean: true,
+});

package/.turbo/turbo-build.log

@@ -1,20 +0,0 @@
-
-> @tinkerstack/graphql-annotation@0.0.2 build C:\Users\mori\Documents\Work\tinkerstack\packages\graphql-annotation
-> tsup
-
-CLI Building entry: src/index.ts
-CLI Using tsconfig: tsconfig.build.json
-CLI tsup v8.5.1
-CLI Using tsup config: C:\Users\mori\Documents\Work\tinkerstack\packages\graphql-annotation\tsup.config.ts
-CLI Target: es2022
-CLI Cleaning output folder
-ESM Build start
-CJS Build start
-CJS dist\index.js 21.17 KB
-CJS ⚡️ Build success in 645ms
-ESM dist\index.mjs 19.24 KB
-ESM ⚡️ Build success in 646ms
-DTS Build start
-DTS ⚡️ Build success in 2927ms
-DTS dist\index.d.mts 2.89 KB
-DTS dist\index.d.ts  2.89 KB