@nest-boot/graphql-logger 7.0.2 → 7.0.3

package/dist/graphql-logger-module-options.interface.d.ts

@@ -1,2 +1,3 @@
+/** Configuration options for the GraphQL logger module (reserved for future use). */
 export interface GraphQLLoggerModuleOptions {
 }

package/dist/graphql-logger-module-options.interface.js

@@ -1,3 +1,4 @@
 "use strict";
+/* eslint-disable @typescript-eslint/no-empty-object-type */
 Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=graphql-logger-module-options.interface.js.map

package/dist/graphql-logger-module-options.interface.js.map

@@ -1 +1 @@
-{"version":3,"file":"graphql-logger-module-options.interface.js","sourceRoot":"","sources":["../src/graphql-logger-module-options.interface.ts"],"names":[],"mappings":""}
+{"version":3,"file":"graphql-logger-module-options.interface.js","sourceRoot":"","sources":["../src/graphql-logger-module-options.interface.ts"],"names":[],"mappings":";AAAA,4DAA4D"}

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

@@ -1,2 +1,2 @@
 import { type GraphQLLoggerModuleOptions } from "./graphql-logger-module-options.interface";
-export declare const ConfigurableModuleClass: import("@nestjs/common").ConfigurableModuleCls<GraphQLLoggerModuleOptions, "forRoot", "create", {}>, MODULE_OPTIONS_TOKEN: string | symbol;
+export declare const ConfigurableModuleClass: import("@nestjs/common").ConfigurableModuleCls<GraphQLLoggerModuleOptions, "forRoot", "create", {}>, MODULE_OPTIONS_TOKEN: string | symbol, OPTIONS_TYPE: GraphQLLoggerModuleOptions & Partial<{}>, ASYNC_OPTIONS_TYPE: import("@nestjs/common").ConfigurableModuleAsyncOptions<GraphQLLoggerModuleOptions, "create"> & Partial<{}>;

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

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

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

@@ -1 +1 @@
-{"version":3,"file":"graphql-logger.module-definition.js","sourceRoot":"","sources":["../src/graphql-logger.module-definition.ts"],"names":[],"mappings":";;;;AAAA,2CAA2D;AAI9C,KACX,IAAI,kCAAyB,EAA8B;KACxD,kBAAkB,CAAC,SAAS,CAAC;KAC7B,KAAK,EAAE,EAHG,+BAAuB,+BAAE,4BAAoB,2BAG/C"}
+{"version":3,"file":"graphql-logger.module-definition.js","sourceRoot":"","sources":["../src/graphql-logger.module-definition.ts"],"names":[],"mappings":";;;;AAAA,2CAA2D;AAI9C,KAKT,IAAI,kCAAyB,EAA8B;KAC5D,kBAAkB,CAAC,SAAS,CAAC;KAC7B,KAAK,EAAE,EANR,+BAAuB,+BACvB,4BAAoB,4BACpB,oBAAY,oBACZ,0BAAkB,yBAGT"}

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

@@ -1,3 +1,23 @@
-import { ConfigurableModuleClass } from "./graphql-logger.module-definition";
+import { type DynamicModule } from "@nestjs/common";
+import { ASYNC_OPTIONS_TYPE, ConfigurableModuleClass, OPTIONS_TYPE } from "./graphql-logger.module-definition";
+/**
+ * GraphQL request logging module.
+ *
+ * @remarks
+ * Provides an Apollo Server plugin that logs GraphQL operations
+ * including query details, variables, and execution timing.
+ */
 export declare class GraphQLLoggerModule extends ConfigurableModuleClass {
+    /**
+     * Registers the GraphQLLoggerModule with the given options.
+     * @param options - Configuration options for GraphQL logging
+     * @returns Dynamic module configuration
+     */
+    static forRoot(options: typeof OPTIONS_TYPE): DynamicModule;
+    /**
+     * Registers the GraphQLLoggerModule asynchronously with factory functions.
+     * @param options - Async configuration options
+     * @returns Dynamic module configuration
+     */
+    static forRootAsync(options: typeof ASYNC_OPTIONS_TYPE): DynamicModule;
 }

package/dist/graphql-logger.module.js

@@ -10,7 +10,30 @@ exports.GraphQLLoggerModule = void 0;
 const common_1 = require("@nestjs/common");
 const graphql_logger_module_definition_1 = require("./graphql-logger.module-definition");
 const graphql_logger_plugin_1 = require("./graphql-logger.plugin");
+/**
+ * GraphQL request logging module.
+ *
+ * @remarks
+ * Provides an Apollo Server plugin that logs GraphQL operations
+ * including query details, variables, and execution timing.
+ */
 let GraphQLLoggerModule = class GraphQLLoggerModule extends graphql_logger_module_definition_1.ConfigurableModuleClass {
+    /**
+     * Registers the GraphQLLoggerModule with the given options.
+     * @param options - Configuration options for GraphQL logging
+     * @returns Dynamic module configuration
+     */
+    static forRoot(options) {
+        return super.forRoot(options);
+    }
+    /**
+     * Registers the GraphQLLoggerModule asynchronously with factory functions.
+     * @param options - Async configuration options
+     * @returns Dynamic module configuration
+     */
+    static forRootAsync(options) {
+        return super.forRootAsync(options);
+    }
 };
 exports.GraphQLLoggerModule = GraphQLLoggerModule;
 exports.GraphQLLoggerModule = GraphQLLoggerModule = __decorate([

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

@@ -1 +1 @@
-{"version":3,"file":"graphql-logger.module.js","sourceRoot":"","sources":["../src/graphql-logger.module.ts"],"names":[],"mappings":";;;;;;;;;AAAA,2CAAgD;AAEhD,yFAA6E;AAC7E,mEAA8D;AAMvD,IAAM,mBAAmB,GAAzB,MAAM,mBAAoB,SAAQ,0DAAuB;CAAG,CAAA;AAAtD,kDAAmB;8BAAnB,mBAAmB;IAJ/B,IAAA,eAAM,GAAE;IACR,IAAA,eAAM,EAAC;QACN,SAAS,EAAE,CAAC,2CAAmB,CAAC;KACjC,CAAC;GACW,mBAAmB,CAAmC"}
+{"version":3,"file":"graphql-logger.module.js","sourceRoot":"","sources":["../src/graphql-logger.module.ts"],"names":[],"mappings":";;;;;;;;;AAAA,2CAAoE;AAEpE,yFAI4C;AAC5C,mEAA8D;AAE9D;;;;;;GAMG;AAKI,IAAM,mBAAmB,GAAzB,MAAM,mBAAoB,SAAQ,0DAAuB;IAC9D;;;;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,kDAAmB;8BAAnB,mBAAmB;IAJ/B,IAAA,eAAM,GAAE;IACR,IAAA,eAAM,EAAC;QACN,SAAS,EAAE,CAAC,2CAAmB,CAAC;KACjC,CAAC;GACW,mBAAmB,CAoB/B"}

package/dist/graphql-logger.plugin.d.ts

@@ -1,7 +1,21 @@
 import { type ApolloServerPlugin, type BaseContext, type GraphQLRequestListener } from "@apollo/server";
 import { Logger } from "@nest-boot/logger";
+/**
+ * Apollo Server plugin that logs GraphQL operation metadata.
+ *
+ * @remarks
+ * Adds operation ID, name, and type (query/mutation/subscription)
+ * to the structured logger on each resolved operation.
+ */
 export declare class GraphQLLoggerPlugin implements ApolloServerPlugin {
     private readonly logger;
+    /** Creates a new GraphQLLoggerPlugin instance.
+     * @param logger - Structured logger for recording operation metadata
+     */
     constructor(logger: Logger);
+    /**
+     * Hook invoked when a GraphQL request starts processing.
+     * @returns A request listener that logs operation metadata after resolution
+     */
     requestDidStart(): Promise<GraphQLRequestListener<BaseContext>>;
 }

package/dist/graphql-logger.plugin.js

@@ -13,10 +13,24 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.GraphQLLoggerPlugin = void 0;
 const logger_1 = require("@nest-boot/logger");
 const apollo_1 = require("@nestjs/apollo");
+/**
+ * Apollo Server plugin that logs GraphQL operation metadata.
+ *
+ * @remarks
+ * Adds operation ID, name, and type (query/mutation/subscription)
+ * to the structured logger on each resolved operation.
+ */
 let GraphQLLoggerPlugin = class GraphQLLoggerPlugin {
+    /** Creates a new GraphQLLoggerPlugin instance.
+     * @param logger - Structured logger for recording operation metadata
+     */
     constructor(logger) {
         this.logger = logger;
     }
+    /**
+     * Hook invoked when a GraphQL request starts processing.
+     * @returns A request listener that logs operation metadata after resolution
+     */
     async requestDidStart() {
         return {
             didResolveOperation: async (ctx) => {

package/dist/graphql-logger.plugin.js.map

@@ -1 +1 @@
-{"version":3,"file":"graphql-logger.plugin.js","sourceRoot":"","sources":["../src/graphql-logger.plugin.ts"],"names":[],"mappings":";AAAA,qDAAqD;;;;;;;;;;;;AAOrD,8CAA2C;AAC3C,2CAAwC;AAGjC,IAAM,mBAAmB,GAAzB,MAAM,mBAAmB;IAC9B,YAA6B,MAAc;QAAd,WAAM,GAAN,MAAM,CAAQ;IAAG,CAAC;IAE/C,KAAK,CAAC,eAAe;QACnB,OAAO;YACL,mBAAmB,EAAE,KAAK,EAAE,GAAG,EAAE,EAAE;gBACjC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC;oBACjB,SAAS,EAAE;wBACT,EAAE,EAAE,GAAG,CAAC,SAAS;wBACjB,IAAI,EAAE,GAAG,CAAC,aAAa;wBACvB,IAAI,EAAE,GAAG,CAAC,SAAS,EAAE,SAAS;qBAC/B;iBACF,CAAC,CAAC;YACL,CAAC;SACF,CAAC;IACJ,CAAC;CACF,CAAA;AAhBY,kDAAmB;8BAAnB,mBAAmB;IAD/B,IAAA,eAAM,GAAE;qCAE8B,eAAM;GADhC,mBAAmB,CAgB/B"}
+{"version":3,"file":"graphql-logger.plugin.js","sourceRoot":"","sources":["../src/graphql-logger.plugin.ts"],"names":[],"mappings":";AAAA,qDAAqD;;;;;;;;;;;;AAOrD,8CAA2C;AAC3C,2CAAwC;AAExC;;;;;;GAMG;AAEI,IAAM,mBAAmB,GAAzB,MAAM,mBAAmB;IAC9B;;OAEG;IACH,YAA6B,MAAc;QAAd,WAAM,GAAN,MAAM,CAAQ;IAAG,CAAC;IAE/C;;;OAGG;IACH,KAAK,CAAC,eAAe;QACnB,OAAO;YACL,mBAAmB,EAAE,KAAK,EAAE,GAAG,EAAE,EAAE;gBACjC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC;oBACjB,SAAS,EAAE;wBACT,EAAE,EAAE,GAAG,CAAC,SAAS;wBACjB,IAAI,EAAE,GAAG,CAAC,aAAa;wBACvB,IAAI,EAAE,GAAG,CAAC,SAAS,EAAE,SAAS;qBAC/B;iBACF,CAAC,CAAC;YACL,CAAC;SACF,CAAC;IACJ,CAAC;CACF,CAAA;AAvBY,kDAAmB;8BAAnB,mBAAmB;IAD/B,IAAA,eAAM,GAAE;qCAK8B,eAAM;GAJhC,mBAAmB,CAuB/B"}