@nest-boot/graphql 7.1.2 → 7.1.3

package/dist/decorators/args-type.decorator.d.ts

@@ -1,6 +1,6 @@
 /**
  * Decorator that marks a class as a resolver arguments type.
  *
- * @publicApi
+ * @public
  */
 export declare function ArgsType(name?: string): ClassDecorator;

package/dist/decorators/args-type.decorator.js

@@ -8,7 +8,7 @@ const add_class_type_metadata_util_1 = require("@nestjs/graphql/dist/utils/add-c
 /**
  * Decorator that marks a class as a resolver arguments type.
  *
- * @publicApi
+ * @public
  */
 function ArgsType(name) {
     // eslint-disable-next-line @typescript-eslint/no-unsafe-function-type

package/dist/graphql.exception-filter.d.ts

@@ -2,10 +2,33 @@ import { type ArgumentsHost, Logger } from "@nestjs/common";
 import { BaseExceptionFilter } from "@nestjs/core";
 import { GqlExceptionFilter } from "@nestjs/graphql";
 import { GraphQLError } from "graphql";
+/**
+ * Global exception filter for GraphQL and HTTP contexts.
+ *
+ * @remarks
+ * Catches all exceptions and converts them to appropriate GraphQL errors
+ * or delegates to the base HTTP exception filter. In production, internal
+ * error details are hidden from the response.
+ */
 export declare class GraphQLExceptionFilter extends BaseExceptionFilter implements GqlExceptionFilter {
     private readonly logger;
+    /** Whether to include debug information (stack traces, error details) in responses. */
     private readonly debug;
+    /** Creates a new GraphQLExceptionFilter instance.
+     * @param logger - NestJS logger for logging exceptions
+     */
     constructor(logger: Logger);
+    /**
+     * Catches and handles exceptions from both GraphQL and HTTP contexts.
+     * @param error - The caught exception
+     * @param host - The execution context arguments
+     * @returns A GraphQL error for GraphQL contexts, or delegates to HTTP handler
+     */
     catch(error: Error, host: ArgumentsHost): GraphQLError | undefined;
+    /**
+     * Transforms a generic error into a GraphQL error.
+     * @param error - The original error
+     * @returns A standardized GraphQL error with appropriate extensions
+     */
     transform(error: Error): GraphQLError;
 }

package/dist/graphql.exception-filter.js

@@ -13,12 +13,30 @@ exports.GraphQLExceptionFilter = void 0;
 const common_1 = require("@nestjs/common");
 const core_1 = require("@nestjs/core");
 const graphql_1 = require("graphql");
+/**
+ * Global exception filter for GraphQL and HTTP contexts.
+ *
+ * @remarks
+ * Catches all exceptions and converts them to appropriate GraphQL errors
+ * or delegates to the base HTTP exception filter. In production, internal
+ * error details are hidden from the response.
+ */
 let GraphQLExceptionFilter = class GraphQLExceptionFilter extends core_1.BaseExceptionFilter {
+    /** Creates a new GraphQLExceptionFilter instance.
+     * @param logger - NestJS logger for logging exceptions
+     */
     constructor(logger) {
         super();
         this.logger = logger;
+        /** Whether to include debug information (stack traces, error details) in responses. */
         this.debug = process.env.NODE_ENV !== "production";
     }
+    /**
+     * Catches and handles exceptions from both GraphQL and HTTP contexts.
+     * @param error - The caught exception
+     * @param host - The execution context arguments
+     * @returns A GraphQL error for GraphQL contexts, or delegates to HTTP handler
+     */
     catch(error, host) {
         if (host.getType() === "graphql") {
             const graphqlError = this.transform(error);
@@ -30,12 +48,15 @@ let GraphQLExceptionFilter = class GraphQLExceptionFilter extends core_1.BaseExc
             super.catch(error, host);
         }
     }
+    /**
+     * Transforms a generic error into a GraphQL error.
+     * @param error - The original error
+     * @returns A standardized GraphQL error with appropriate extensions
+     */
     transform(error) {
-        // 如果是 GraphQL 错误，直接返回
         if (error instanceof graphql_1.GraphQLError) {
             return error;
         }
-        // 如果是 Http 错误，转换为 Apollo 错误
         if (error instanceof common_1.HttpException) {
             const status = error.getStatus();
             const response = error.getResponse();

package/dist/graphql.exception-filter.js.map

@@ -1 +1 @@
-{"version":3,"file":"graphql.exception-filter.js","sourceRoot":"","sources":["../src/graphql.exception-filter.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,2CAOwB;AACxB,uCAAmD;AAEnD,qCAAuC;AAGhC,IAAM,sBAAsB,GAA5B,MAAM,sBACX,SAAQ,0BAAmB;IAK3B,YAA6B,MAAc;QACzC,KAAK,EAAE,CAAC;QADmB,WAAM,GAAN,MAAM,CAAQ;QAF1B,UAAK,GAAG,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,YAAY,CAAC;IAI/D,CAAC;IAED,KAAK,CAAC,KAAY,EAAE,IAAmB;QACrC,IAAI,IAAI,CAAC,OAAO,EAA2B,KAAK,SAAS,EAAE,CAAC;YAC1D,MAAM,YAAY,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;YAC3C,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,OAAO,EAAE,EAAE,GAAG,EAAE,YAAY,EAAE,CAAC,CAAC;YAC/D,OAAO,YAAY,CAAC;QACtB,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,EAAE,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC,CAAC;YACjD,KAAK,CAAC,KAAK,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;QAC3B,CAAC;IACH,CAAC;IAED,SAAS,CAAC,KAAY;QACpB,sBAAsB;QACtB,IAAI,KAAK,YAAY,sBAAY,EAAE,CAAC;YAClC,OAAO,KAAK,CAAC;QACf,CAAC;QAED,4BAA4B;QAC5B,IAAI,KAAK,YAAY,sBAAa,EAAE,CAAC;YACnC,MAAM,MAAM,GAAG,KAAK,CAAC,SAAS,EAAE,CAAC;YACjC,MAAM,QAAQ,GAAQ,KAAK,CAAC,WAAW,EAAE,CAAC;YAC1C,MAAM,OAAO,GACX,OAAO,QAAQ,KAAK,QAAQ;gBAC1B,CAAC,CAAC,QAAQ;gBACV,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,IAAI,QAAQ,CAAC,MAAM,IAAI,uBAAuB,CAAC,CAAC;YAEvE,OAAO,IAAI,sBAAY,CACrB,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC,SAAS,EAAE,KAAK,GAAG;gBACrC,CAAC,CAAC,OAAO;gBACT,CAAC,CAAC,uBAAuB,EAC3B;gBACE,UAAU,EAAE;oBACV,IAAI,EAAE,mBAAU,CAAC,MAAM,CAAC;oBACxB,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;iBAC9C;aACF,CACF,CAAC;QACJ,CAAC;QAED,OAAO,IAAI,sBAAY,CACrB,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,uBAAuB,EACpD;YACE,UAAU,EAAE;gBACV,IAAI,EAAE,uBAAuB;gBAC7B,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;aAC9C;SACF,CACF,CAAC;IACJ,CAAC;CACF,CAAA;AA3DY,wDAAsB;iCAAtB,sBAAsB;IADlC,IAAA,cAAK,GAAE;qCAO+B,eAAM;GANhC,sBAAsB,CA2DlC"}
+{"version":3,"file":"graphql.exception-filter.js","sourceRoot":"","sources":["../src/graphql.exception-filter.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,2CAOwB;AACxB,uCAAmD;AAEnD,qCAAuC;AAEvC;;;;;;;GAOG;AAEI,IAAM,sBAAsB,GAA5B,MAAM,sBACX,SAAQ,0BAAmB;IAM3B;;OAEG;IACH,YAA6B,MAAc;QACzC,KAAK,EAAE,CAAC;QADmB,WAAM,GAAN,MAAM,CAAQ;QAN3C,uFAAuF;QACtE,UAAK,GAAG,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,YAAY,CAAC;IAO/D,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,KAAY,EAAE,IAAmB;QACrC,IAAI,IAAI,CAAC,OAAO,EAA2B,KAAK,SAAS,EAAE,CAAC;YAC1D,MAAM,YAAY,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;YAC3C,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,OAAO,EAAE,EAAE,GAAG,EAAE,YAAY,EAAE,CAAC,CAAC;YAC/D,OAAO,YAAY,CAAC;QACtB,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,EAAE,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC,CAAC;YACjD,KAAK,CAAC,KAAK,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;QAC3B,CAAC;IACH,CAAC;IAED;;;;OAIG;IACH,SAAS,CAAC,KAAY;QACpB,IAAI,KAAK,YAAY,sBAAY,EAAE,CAAC;YAClC,OAAO,KAAK,CAAC;QACf,CAAC;QAED,IAAI,KAAK,YAAY,sBAAa,EAAE,CAAC;YACnC,MAAM,MAAM,GAAG,KAAK,CAAC,SAAS,EAAE,CAAC;YACjC,MAAM,QAAQ,GAAQ,KAAK,CAAC,WAAW,EAAE,CAAC;YAC1C,MAAM,OAAO,GACX,OAAO,QAAQ,KAAK,QAAQ;gBAC1B,CAAC,CAAC,QAAQ;gBACV,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,IAAI,QAAQ,CAAC,MAAM,IAAI,uBAAuB,CAAC,CAAC;YAEvE,OAAO,IAAI,sBAAY,CACrB,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC,SAAS,EAAE,KAAK,GAAG;gBACrC,CAAC,CAAC,OAAO;gBACT,CAAC,CAAC,uBAAuB,EAC3B;gBACE,UAAU,EAAE;oBACV,IAAI,EAAE,mBAAU,CAAC,MAAM,CAAC;oBACxB,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;iBAC9C;aACF,CACF,CAAC;QACJ,CAAC;QAED,OAAO,IAAI,sBAAY,CACrB,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,uBAAuB,EACpD;YACE,UAAU,EAAE;gBACV,IAAI,EAAE,uBAAuB;gBAC7B,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;aAC9C;SACF,CACF,CAAC;IACJ,CAAC;CACF,CAAA;AAxEY,wDAAsB;iCAAtB,sBAAsB;IADlC,IAAA,cAAK,GAAE;qCAW+B,eAAM;GAVhC,sBAAsB,CAwElC"}

package/dist/graphql.module-definition.d.ts

@@ -1,2 +1,2 @@
 export declare const MODULE_OPTIONS_TOKEN: unique symbol;
-export declare const ConfigurableModuleClass: import("@nestjs/common").ConfigurableModuleCls<import("@nestjs/apollo").ApolloDriverConfig, "forRoot", "create", {}>, BASE_MODULE_OPTIONS_TOKEN: string | symbol;
+export declare const ConfigurableModuleClass: import("@nestjs/common").ConfigurableModuleCls<import("@nestjs/apollo").ApolloDriverConfig, "forRoot", "create", {}>, BASE_MODULE_OPTIONS_TOKEN: string | symbol, OPTIONS_TYPE: import("@nestjs/apollo").ApolloDriverConfig & Partial<{}>, ASYNC_OPTIONS_TYPE: import("@nestjs/common").ConfigurableModuleAsyncOptions<import("@nestjs/apollo").ApolloDriverConfig, "create"> & Partial<{}>;

package/dist/graphql.module-definition.js

@@ -1,10 +1,10 @@
 "use strict";
 var _a;
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.BASE_MODULE_OPTIONS_TOKEN = exports.ConfigurableModuleClass = exports.MODULE_OPTIONS_TOKEN = void 0;
+exports.ASYNC_OPTIONS_TYPE = exports.OPTIONS_TYPE = exports.BASE_MODULE_OPTIONS_TOKEN = exports.ConfigurableModuleClass = exports.MODULE_OPTIONS_TOKEN = void 0;
 const common_1 = require("@nestjs/common");
 exports.MODULE_OPTIONS_TOKEN = Symbol("GraphQLModuleOptions");
 _a = new common_1.ConfigurableModuleBuilder()
     .setClassMethodName("forRoot")
-    .build(), exports.ConfigurableModuleClass = _a.ConfigurableModuleClass, exports.BASE_MODULE_OPTIONS_TOKEN = _a.MODULE_OPTIONS_TOKEN;
+    .build(), exports.ConfigurableModuleClass = _a.ConfigurableModuleClass, exports.BASE_MODULE_OPTIONS_TOKEN = _a.MODULE_OPTIONS_TOKEN, exports.OPTIONS_TYPE = _a.OPTIONS_TYPE, exports.ASYNC_OPTIONS_TYPE = _a.ASYNC_OPTIONS_TYPE;
 //# sourceMappingURL=graphql.module-definition.js.map

package/dist/graphql.module-definition.js.map

@@ -1 +1 @@
-{"version":3,"file":"graphql.module-definition.js","sourceRoot":"","sources":["../src/graphql.module-definition.ts"],"names":[],"mappings":";;;;AAAA,2CAA2D;AAI9C,QAAA,oBAAoB,GAAG,MAAM,CAAC,sBAAsB,CAAC,CAAC;AAEtD,KAGT,IAAI,kCAAyB,EAAwB;KACtD,kBAAkB,CAAC,SAAS,CAAC;KAC7B,KAAK,EAAE,EAJR,+BAAuB,+BACD,iCAAyB,2BAGtC"}
+{"version":3,"file":"graphql.module-definition.js","sourceRoot":"","sources":["../src/graphql.module-definition.ts"],"names":[],"mappings":";;;;AAAA,2CAA2D;AAI9C,QAAA,oBAAoB,GAAG,MAAM,CAAC,sBAAsB,CAAC,CAAC;AAEtD,KAKT,IAAI,kCAAyB,EAAwB;KACtD,kBAAkB,CAAC,SAAS,CAAC;KAC7B,KAAK,EAAE,EANR,+BAAuB,+BACD,iCAAyB,4BAC/C,oBAAY,oBACZ,0BAAkB,yBAGT"}

package/dist/graphql.module.d.ts

@@ -1,3 +1,23 @@
-import { ConfigurableModuleClass } from "./graphql.module-definition";
+import { type DynamicModule } from "@nestjs/common";
+import { ASYNC_OPTIONS_TYPE, ConfigurableModuleClass, OPTIONS_TYPE } from "./graphql.module-definition";
+/**
+ * GraphQL module powered by Apollo Server.
+ *
+ * @remarks
+ * Wraps `@nestjs/graphql` with Apollo driver, providing schema-first
+ * auto-generation, playground support, and global exception filtering.
+ */
 export declare class GraphQLModule extends ConfigurableModuleClass {
+    /**
+     * Registers the GraphQLModule with the given options.
+     * @param options - Apollo Server configuration options
+     * @returns Dynamic module configuration
+     */
+    static forRoot(options: typeof OPTIONS_TYPE): DynamicModule;
+    /**
+     * Registers the GraphQLModule asynchronously with factory functions.
+     * @param options - Async configuration options
+     * @returns Dynamic module configuration
+     */
+    static forRootAsync(options: typeof ASYNC_OPTIONS_TYPE): DynamicModule;
 }

package/dist/graphql.module.js

@@ -14,7 +14,30 @@ const core_1 = require("@nestjs/core");
 const graphql_1 = require("@nestjs/graphql");
 const graphql_exception_filter_1 = require("./graphql.exception-filter");
 const graphql_module_definition_1 = require("./graphql.module-definition");
+/**
+ * GraphQL module powered by Apollo Server.
+ *
+ * @remarks
+ * Wraps `@nestjs/graphql` with Apollo driver, providing schema-first
+ * auto-generation, playground support, and global exception filtering.
+ */
 let GraphQLModule = class GraphQLModule extends graphql_module_definition_1.ConfigurableModuleClass {
+    /**
+     * Registers the GraphQLModule with the given options.
+     * @param options - Apollo Server configuration options
+     * @returns Dynamic module configuration
+     */
+    static forRoot(options) {
+        return super.forRoot(options);
+    }
+    /**
+     * Registers the GraphQLModule asynchronously with factory functions.
+     * @param options - Async configuration options
+     * @returns Dynamic module configuration
+     */
+    static forRootAsync(options) {
+        return super.forRootAsync(options);
+    }
 };
 exports.GraphQLModule = GraphQLModule;
 exports.GraphQLModule = GraphQLModule = __decorate([

package/dist/graphql.module.js.map

@@ -1 +1 @@
-{"version":3,"file":"graphql.module.js","sourceRoot":"","sources":["../src/graphql.module.ts"],"names":[],"mappings":";;;;;;;;;AAAA,uEAAsG;AACtG,2CAA8C;AAC9C,2CAAwD;AACxD,uCAA0C;AAC1C,6CAAqE;AAErE,yEAAoE;AACpE,2EAIqC;AAwC9B,IAAM,aAAa,GAAnB,MAAM,aAAc,SAAQ,mDAAuB;CAAG,CAAA;AAAhD,sCAAa;wBAAb,aAAa;IArCzB,IAAA,eAAM,GAAE;IACR,IAAA,eAAM,EAAC;QACN,OAAO,EAAE;YACP,uBAAiB,CAAC,YAAY,CAAC;gBAC7B,MAAM,EAAE,qBAAY;gBACpB,MAAM,EAAE,CAAC,gDAAoB,CAAC;gBAC9B,UAAU,EAAE,CAAC,OAA6B,EAAE,EAAE;oBAC5C,OAAO;wBACL,IAAI,EAAE,cAAc;wBACpB,cAAc,EAAE,YAAY;wBAC5B,UAAU,EAAE,IAAI;wBAChB,UAAU,EAAE,KAAK;wBACjB,GAAG,OAAO;wBACV,OAAO,EAAE;4BACP,GAAG,CAAC,OAAO,CAAC,UAAU,KAAK,KAAK;gCAC9B,CAAC,CAAC,EAAE;gCACJ,CAAC,CAAC,CAAC,IAAA,mDAAyC,GAAE,CAAC,CAAC;4BAClD,GAAG,CAAC,OAAO,CAAC,OAAO,IAAI,EAAE,CAAC;yBAC3B;qBACF,CAAC;gBACJ,CAAC;aACF,CAAC;SACH;QACD,SAAS,EAAE;YACT,eAAM;YACN;gBACE,OAAO,EAAE,iBAAU;gBACnB,QAAQ,EAAE,iDAAsB;aACjC;YACD;gBACE,OAAO,EAAE,gDAAoB;gBAC7B,MAAM,EAAE,CAAC,EAAE,KAAK,EAAE,qDAAyB,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;gBAC9D,UAAU,EAAE,CAAC,OAA8B,EAAE,EAAE,CAAC,OAAO,IAAI,EAAE;aAC9D;SACF;QACD,OAAO,EAAE,CAAC,gDAAoB,CAAC;KAChC,CAAC;GACW,aAAa,CAAmC"}
+{"version":3,"file":"graphql.module.js","sourceRoot":"","sources":["../src/graphql.module.ts"],"names":[],"mappings":";;;;;;;;;AAAA,uEAAsG;AACtG,2CAA8C;AAC9C,2CAA4E;AAC5E,uCAA0C;AAC1C,6CAAqE;AAErE,yEAAoE;AACpE,2EAMqC;AAGrC;;;;;;GAMG;AAsCI,IAAM,aAAa,GAAnB,MAAM,aAAc,SAAQ,mDAAuB;IACxD;;;;OAIG;IACH,MAAM,CAAU,OAAO,CAAC,OAA4B;QAClD,OAAO,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IAChC,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAU,YAAY,CAC1B,OAAkC;QAElC,OAAO,KAAK,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;IACrC,CAAC;CACF,CAAA;AApBY,sCAAa;wBAAb,aAAa;IArCzB,IAAA,eAAM,GAAE;IACR,IAAA,eAAM,EAAC;QACN,OAAO,EAAE;YACP,uBAAiB,CAAC,YAAY,CAAC;gBAC7B,MAAM,EAAE,qBAAY;gBACpB,MAAM,EAAE,CAAC,gDAAoB,CAAC;gBAC9B,UAAU,EAAE,CAAC,OAA6B,EAAE,EAAE;oBAC5C,OAAO;wBACL,IAAI,EAAE,cAAc;wBACpB,cAAc,EAAE,YAAY;wBAC5B,UAAU,EAAE,IAAI;wBAChB,UAAU,EAAE,KAAK;wBACjB,GAAG,OAAO;wBACV,OAAO,EAAE;4BACP,GAAG,CAAC,OAAO,CAAC,UAAU,KAAK,KAAK;gCAC9B,CAAC,CAAC,EAAE;gCACJ,CAAC,CAAC,CAAC,IAAA,mDAAyC,GAAE,CAAC,CAAC;4BAClD,GAAG,CAAC,OAAO,CAAC,OAAO,IAAI,EAAE,CAAC;yBAC3B;qBACF,CAAC;gBACJ,CAAC;aACF,CAAC;SACH;QACD,SAAS,EAAE;YACT,eAAM;YACN;gBACE,OAAO,EAAE,iBAAU;gBACnB,QAAQ,EAAE,iDAAsB;aACjC;YACD;gBACE,OAAO,EAAE,gDAAoB;gBAC7B,MAAM,EAAE,CAAC,EAAE,KAAK,EAAE,qDAAyB,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;gBAC9D,UAAU,EAAE,CAAC,OAA8B,EAAE,EAAE,CAAC,OAAO,IAAI,EAAE;aAC9D;SACF;QACD,OAAO,EAAE,CAAC,gDAAoB,CAAC;KAChC,CAAC;GACW,aAAa,CAoBzB"}