@makerx/graphql-core 3.2.0 → 3.4.0

package/logging.d.cts

@@ -3,6 +3,7 @@ import type { ExecutionArgs, GraphQLFormattedError } from 'graphql';
 import { OperationTypeNode } from 'graphql';
 import type { ExecutionResult } from 'graphql-ws';
 import type { GraphQLContext } from './context';
+import type { DeprecatedElementUsage } from './deprecation';
 type LogFunction = Logger['info'];
 export type LoggerLogFunctions<T extends Logger> = {
     [Property in keyof T]: LogFunction;
@@ -57,6 +58,16 @@ export interface GraphQLLogOperationInfo<TLogger extends Logger = Logger> extend
      * Whether the operation is a subsequent payload of an incremental response.
      */
     isSubsequentPayload?: boolean;
+    /**
+     * Deprecated schema elements the operation used, as returned by `collectDeprecatedElementUsage`.
+     * Omitted from the log entry when empty.
+     */
+    deprecatedElements?: DeprecatedElementUsage[];
+    /**
+     * Whether a limit stopped deprecated element collection, meaning `deprecatedElements` may be
+     * incomplete. Omitted from the log entry when false.
+     */
+    deprecatedElementsTruncated?: boolean;
     /**
      * The logger to use.
      */
@@ -70,13 +81,17 @@ export interface GraphQLLogOperationInfo<TLogger extends Logger = Logger> extend
  * Logs a GraphQL operation in a consistent format with the option of including any additional data.
  * Top level and result entries with null or undefined values will be omitted.
  */
-export declare const logGraphQLOperation: <TLogger extends Logger = Logger>({ message, started, type, operationName, query, variables, result, logger, logLevel, ...rest }: GraphQLLogOperationInfo<TLogger>) => void;
-export declare const logSubscriptionOperation: <TLogger extends Logger = Logger>({ id, args, result, message, logLevel, resolveLogger, }: {
+export declare const logGraphQLOperation: <TLogger extends Logger = Logger>({ message, started, type, operationName, query, variables, result, deprecatedElements, deprecatedElementsTruncated, logger, logLevel, ...rest }: GraphQLLogOperationInfo<TLogger>) => void;
+export declare const logSubscriptionOperation: <TLogger extends Logger = Logger>({ id, args, result, message, logLevel, resolveLogger, includeDeprecatedElements, }: {
     id?: string;
     args: ExecutionArgs;
     result?: ExecutionResult;
     message?: string;
     logLevel?: keyof LoggerLogFunctions<TLogger>;
     resolveLogger?: (context: GraphQLContext) => TLogger;
+    /**
+     * If true, deprecated schema elements the operation uses are collected and logged.
+     */
+    includeDeprecatedElements?: boolean;
 }) => void;
 export {};

package/logging.d.mts

@@ -3,6 +3,7 @@ import type { ExecutionArgs, GraphQLFormattedError } from 'graphql';
 import { OperationTypeNode } from 'graphql';
 import type { ExecutionResult } from 'graphql-ws';
 import type { GraphQLContext } from './context.mjs';
+import type { DeprecatedElementUsage } from './deprecation.mjs';
 type LogFunction = Logger['info'];
 export type LoggerLogFunctions<T extends Logger> = {
     [Property in keyof T]: LogFunction;
@@ -57,6 +58,16 @@ export interface GraphQLLogOperationInfo<TLogger extends Logger = Logger> extend
      * Whether the operation is a subsequent payload of an incremental response.
      */
     isSubsequentPayload?: boolean;
+    /**
+     * Deprecated schema elements the operation used, as returned by `collectDeprecatedElementUsage`.
+     * Omitted from the log entry when empty.
+     */
+    deprecatedElements?: DeprecatedElementUsage[];
+    /**
+     * Whether a limit stopped deprecated element collection, meaning `deprecatedElements` may be
+     * incomplete. Omitted from the log entry when false.
+     */
+    deprecatedElementsTruncated?: boolean;
     /**
      * The logger to use.
      */
@@ -70,13 +81,17 @@ export interface GraphQLLogOperationInfo<TLogger extends Logger = Logger> extend
  * Logs a GraphQL operation in a consistent format with the option of including any additional data.
  * Top level and result entries with null or undefined values will be omitted.
  */
-export declare const logGraphQLOperation: <TLogger extends Logger = Logger>({ message, started, type, operationName, query, variables, result, logger, logLevel, ...rest }: GraphQLLogOperationInfo<TLogger>) => void;
-export declare const logSubscriptionOperation: <TLogger extends Logger = Logger>({ id, args, result, message, logLevel, resolveLogger, }: {
+export declare const logGraphQLOperation: <TLogger extends Logger = Logger>({ message, started, type, operationName, query, variables, result, deprecatedElements, deprecatedElementsTruncated, logger, logLevel, ...rest }: GraphQLLogOperationInfo<TLogger>) => void;
+export declare const logSubscriptionOperation: <TLogger extends Logger = Logger>({ id, args, result, message, logLevel, resolveLogger, includeDeprecatedElements, }: {
     id?: string;
     args: ExecutionArgs;
     result?: ExecutionResult;
     message?: string;
     logLevel?: keyof LoggerLogFunctions<TLogger>;
     resolveLogger?: (context: GraphQLContext) => TLogger;
+    /**
+     * If true, deprecated schema elements the operation uses are collected and logged.
+     */
+    includeDeprecatedElements?: boolean;
 }) => void;
 export {};

package/logging.d.ts

@@ -3,6 +3,7 @@ import type { ExecutionArgs, GraphQLFormattedError } from 'graphql';
 import { OperationTypeNode } from 'graphql';
 import type { ExecutionResult } from 'graphql-ws';
 import type { GraphQLContext } from './context';
+import type { DeprecatedElementUsage } from './deprecation';
 type LogFunction = Logger['info'];
 export type LoggerLogFunctions<T extends Logger> = {
     [Property in keyof T]: LogFunction;
@@ -57,6 +58,16 @@ export interface GraphQLLogOperationInfo<TLogger extends Logger = Logger> extend
      * Whether the operation is a subsequent payload of an incremental response.
      */
     isSubsequentPayload?: boolean;
+    /**
+     * Deprecated schema elements the operation used, as returned by `collectDeprecatedElementUsage`.
+     * Omitted from the log entry when empty.
+     */
+    deprecatedElements?: DeprecatedElementUsage[];
+    /**
+     * Whether a limit stopped deprecated element collection, meaning `deprecatedElements` may be
+     * incomplete. Omitted from the log entry when false.
+     */
+    deprecatedElementsTruncated?: boolean;
     /**
      * The logger to use.
      */
@@ -70,13 +81,17 @@ export interface GraphQLLogOperationInfo<TLogger extends Logger = Logger> extend
  * Logs a GraphQL operation in a consistent format with the option of including any additional data.
  * Top level and result entries with null or undefined values will be omitted.
  */
-export declare const logGraphQLOperation: <TLogger extends Logger = Logger>({ message, started, type, operationName, query, variables, result, logger, logLevel, ...rest }: GraphQLLogOperationInfo<TLogger>) => void;
-export declare const logSubscriptionOperation: <TLogger extends Logger = Logger>({ id, args, result, message, logLevel, resolveLogger, }: {
+export declare const logGraphQLOperation: <TLogger extends Logger = Logger>({ message, started, type, operationName, query, variables, result, deprecatedElements, deprecatedElementsTruncated, logger, logLevel, ...rest }: GraphQLLogOperationInfo<TLogger>) => void;
+export declare const logSubscriptionOperation: <TLogger extends Logger = Logger>({ id, args, result, message, logLevel, resolveLogger, includeDeprecatedElements, }: {
     id?: string;
     args: ExecutionArgs;
     result?: ExecutionResult;
     message?: string;
     logLevel?: keyof LoggerLogFunctions<TLogger>;
     resolveLogger?: (context: GraphQLContext) => TLogger;
+    /**
+     * If true, deprecated schema elements the operation uses are collected and logged.
+     */
+    includeDeprecatedElements?: boolean;
 }) => void;
 export {};

package/logging.js

@@ -3,6 +3,7 @@
 var nodeCommon = require('@makerx/node-common');
 var compat = require('es-toolkit/compat');
 var graphql = require('graphql');
+var deprecation = require('./deprecation.js');
 var operation = require('./operation.js');
 var utils = require('./utils.js');
 
@@ -10,7 +11,7 @@ var utils = require('./utils.js');
  * Logs a GraphQL operation in a consistent format with the option of including any additional data.
  * Top level and result entries with null or undefined values will be omitted.
  */
-const logGraphQLOperation = ({ message = 'GraphQL operation', started, type, operationName, query, variables, result, logger, logLevel = 'info', ...rest }) => {
+const logGraphQLOperation = ({ message = 'GraphQL operation', started, type, operationName, query, variables, result, deprecatedElements, deprecatedElementsTruncated, logger, logLevel = 'info', ...rest }) => {
     const isIntrospection = query && operation.isIntrospectionQuery(query);
     if (nodeCommon.isLocalDev && isIntrospection)
         return;
@@ -22,17 +23,32 @@ const logGraphQLOperation = ({ message = 'GraphQL operation', started, type, ope
         duration: started ? Date.now() - started : undefined,
         result: result ? compat.omitBy(result, utils.isNil) : undefined,
         isIntrospectionQuery: isIntrospection || undefined,
+        deprecatedElements: deprecatedElements?.length ? deprecatedElements : undefined,
+        deprecatedElementsTruncated: deprecatedElementsTruncated || undefined,
         ...compat.omitBy(rest, utils.isNil),
     }, utils.isNil));
 };
-const logSubscriptionOperation = ({ id, args, result, message, logLevel, resolveLogger, }) => {
+const logSubscriptionOperation = ({ id, args, result, message, logLevel, resolveLogger, includeDeprecatedElements, }) => {
     const logger = resolveLogger
         ? resolveLogger(args.contextValue)
         : args.contextValue.logger;
     if (!logger)
         return;
-    const { operationName, variableValues, document } = args;
+    const { operationName, variableValues, document, schema } = args;
     const { data, ...resultWithoutData } = result ?? {};
+    let deprecatedElements;
+    let deprecatedElementsTruncated;
+    if (includeDeprecatedElements) {
+        try {
+            const usage = deprecation.collectDeprecatedElementUsage({ schema, document, operationName, variables: variableValues });
+            deprecatedElements = usage.elements;
+            deprecatedElementsTruncated = usage.truncated;
+        }
+        catch (error) {
+            // Telemetry must never take down the subscription that produced it.
+            logger.warn('Failed to collect deprecated schema element usage', { error, operationName });
+        }
+    }
     logGraphQLOperation({
         message,
         type: graphql.OperationTypeNode.SUBSCRIPTION,
@@ -41,6 +57,8 @@ const logSubscriptionOperation = ({ id, args, result, message, logLevel, resolve
         query: graphql.print(document),
         variables: variableValues,
         result: resultWithoutData,
+        deprecatedElements,
+        deprecatedElementsTruncated,
         logger,
         logLevel,
     });

package/logging.js.map

@@ -1 +1 @@
-{"version":3,"file":"logging.js","sources":["../src/logging.ts"],"sourcesContent":["import type { Logger } from '@makerx/node-common'\nimport { isLocalDev } from '@makerx/node-common'\nimport { omitBy } from 'es-toolkit/compat'\nimport type { ExecutionArgs, GraphQLFormattedError } from 'graphql'\nimport { OperationTypeNode, print } from 'graphql'\nimport type { ExecutionResult } from 'graphql-ws'\nimport type { GraphQLContext } from './context'\nimport { isIntrospectionQuery } from './operation'\nimport { isNil } from './utils'\n\ntype LogFunction = Logger['info']\nexport type LoggerLogFunctions<T extends Logger> = {\n  [Property in keyof T]: LogFunction\n}\n\n/**\n * Info for logging a GraphQL operation in a consistent format with the option of including any additional data.\n */\nexport interface GraphQLLogOperationInfo<TLogger extends Logger = Logger> extends Record<string, unknown> {\n  /**\n   * The message to log, defaults to 'GraphQL operation'.\n   */\n  message?: string\n  /**\n   * The timestamp when the operation started, if supplied, the duration will be logged.\n   */\n  started?: number\n  /**\n   * The type of GraphQL operation.\n   */\n  type?: OperationTypeNode | null\n  /**\n   * The name of the GraphQL operation.\n   */\n  operationName?: string | null\n  /**\n   * The formatted GraphQL query.\n   */\n  query?: string | null\n  /**\n   * The GraphQL variables.\n   */\n  variables?: Record<string, unknown> | null\n  /**\n   * The result of the GraphQL operation.\n   * Generally, we don't log the data or extensions, just errors.\n   */\n  result?: {\n    data?: Record<string, unknown> | null\n    errors?: readonly GraphQLFormattedError[] | null\n    extensions?: Record<string, unknown> | null\n    hasNext?: boolean\n  }\n  /**\n   * Whether the operation is an introspection query.\n   */\n  isIntrospectionQuery?: boolean\n  /**\n   * Whether the operation is part of an incremental response.\n   */\n  isIncrementalResponse?: boolean\n  /**\n   * Whether the operation is a subsequent payload of an incremental response.\n   */\n  isSubsequentPayload?: boolean\n  /**\n   * The logger to use.\n   */\n  logger: TLogger\n  /**\n   * The logger function to use, defaults to 'info'.\n   */\n  logLevel?: keyof LoggerLogFunctions<TLogger>\n}\n\n/**\n * Logs a GraphQL operation in a consistent format with the option of including any additional data.\n * Top level and result entries with null or undefined values will be omitted.\n */\nexport const logGraphQLOperation = <TLogger extends Logger = Logger>({\n  message = 'GraphQL operation',\n  started,\n  type,\n  operationName,\n  query,\n  variables,\n  result,\n  logger,\n  logLevel = 'info',\n  ...rest\n}: GraphQLLogOperationInfo<TLogger>) => {\n  const isIntrospection = query && isIntrospectionQuery(query)\n  if (isLocalDev && isIntrospection) return\n  logger[logLevel as keyof Logger](\n    message,\n    omitBy(\n      {\n        type,\n        operationName,\n        query,\n        variables: variables && Object.keys(variables).length > 0 ? variables : undefined,\n        duration: started ? Date.now() - started : undefined,\n        result: result ? omitBy(result, isNil) : undefined,\n        isIntrospectionQuery: isIntrospection || undefined,\n        ...omitBy(rest, isNil),\n      },\n      isNil,\n    ),\n  )\n}\n\nexport const logSubscriptionOperation = <TLogger extends Logger = Logger>({\n  id,\n  args,\n  result,\n  message,\n  logLevel,\n  resolveLogger,\n}: {\n  id?: string\n  args: ExecutionArgs\n  result?: ExecutionResult\n  message?: string\n  logLevel?: keyof LoggerLogFunctions<TLogger>\n  resolveLogger?: (context: GraphQLContext) => TLogger\n}) => {\n  const logger = resolveLogger\n    ? resolveLogger(args.contextValue as GraphQLContext)\n    : ((args.contextValue as GraphQLContext).logger as TLogger)\n  if (!logger) return\n\n  const { operationName, variableValues, document } = args\n  const { data, ...resultWithoutData } = result ?? {}\n\n  logGraphQLOperation({\n    message,\n    type: OperationTypeNode.SUBSCRIPTION,\n    subscriptionId: id,\n    operationName,\n    query: print(document),\n    variables: variableValues,\n    result: resultWithoutData,\n    logger,\n    logLevel,\n  })\n}\n"],"names":["isIntrospectionQuery","isLocalDev","omitBy","isNil","OperationTypeNode","print"],"mappings":";;;;;;;;AA2EA;;;AAGG;AACI,MAAM,mBAAmB,GAAG,CAAkC,EACnE,OAAO,GAAG,mBAAmB,EAC7B,OAAO,EACP,IAAI,EACJ,aAAa,EACb,KAAK,EACL,SAAS,EACT,MAAM,EACN,MAAM,EACN,QAAQ,GAAG,MAAM,EACjB,GAAG,IAAI,EAC0B,KAAI;IACrC,MAAM,eAAe,GAAG,KAAK,IAAIA,8BAAoB,CAAC,KAAK,CAAC;IAC5D,IAAIC,qBAAU,IAAI,eAAe;QAAE;AACnC,IAAA,MAAM,CAAC,QAAwB,CAAC,CAC9B,OAAO,EACPC,aAAM,CACJ;QACE,IAAI;QACJ,aAAa;QACb,KAAK;QACL,SAAS,EAAE,SAAS,IAAI,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,MAAM,GAAG,CAAC,GAAG,SAAS,GAAG,SAAS;AACjF,QAAA,QAAQ,EAAE,OAAO,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,OAAO,GAAG,SAAS;AACpD,QAAA,MAAM,EAAE,MAAM,GAAGA,aAAM,CAAC,MAAM,EAAEC,WAAK,CAAC,GAAG,SAAS;QAClD,oBAAoB,EAAE,eAAe,IAAI,SAAS;AAClD,QAAA,GAAGD,aAAM,CAAC,IAAI,EAAEC,WAAK,CAAC;KACvB,EACDA,WAAK,CACN,CACF;AACH;AAEO,MAAM,wBAAwB,GAAG,CAAkC,EACxE,EAAE,EACF,IAAI,EACJ,MAAM,EACN,OAAO,EACP,QAAQ,EACR,aAAa,GAQd,KAAI;IACH,MAAM,MAAM,GAAG;AACb,UAAE,aAAa,CAAC,IAAI,CAAC,YAA8B;AACnD,UAAI,IAAI,CAAC,YAA+B,CAAC,MAAkB;AAC7D,IAAA,IAAI,CAAC,MAAM;QAAE;IAEb,MAAM,EAAE,aAAa,EAAE,cAAc,EAAE,QAAQ,EAAE,GAAG,IAAI;IACxD,MAAM,EAAE,IAAI,EAAE,GAAG,iBAAiB,EAAE,GAAG,MAAM,IAAI,EAAE;AAEnD,IAAA,mBAAmB,CAAC;QAClB,OAAO;QACP,IAAI,EAAEC,yBAAiB,CAAC,YAAY;AACpC,QAAA,cAAc,EAAE,EAAE;QAClB,aAAa;AACb,QAAA,KAAK,EAAEC,aAAK,CAAC,QAAQ,CAAC;AACtB,QAAA,SAAS,EAAE,cAAc;AACzB,QAAA,MAAM,EAAE,iBAAiB;QACzB,MAAM;QACN,QAAQ;AACT,KAAA,CAAC;AACJ;;;;;"}
+{"version":3,"file":"logging.js","sources":["../src/logging.ts"],"sourcesContent":["import type { Logger } from '@makerx/node-common'\nimport { isLocalDev } from '@makerx/node-common'\nimport { omitBy } from 'es-toolkit/compat'\nimport type { ExecutionArgs, GraphQLFormattedError } from 'graphql'\nimport { OperationTypeNode, print } from 'graphql'\nimport type { ExecutionResult } from 'graphql-ws'\nimport type { GraphQLContext } from './context'\nimport type { DeprecatedElementUsage } from './deprecation'\nimport { collectDeprecatedElementUsage } from './deprecation'\nimport { isIntrospectionQuery } from './operation'\nimport { isNil } from './utils'\n\ntype LogFunction = Logger['info']\nexport type LoggerLogFunctions<T extends Logger> = {\n  [Property in keyof T]: LogFunction\n}\n\n/**\n * Info for logging a GraphQL operation in a consistent format with the option of including any additional data.\n */\nexport interface GraphQLLogOperationInfo<TLogger extends Logger = Logger> extends Record<string, unknown> {\n  /**\n   * The message to log, defaults to 'GraphQL operation'.\n   */\n  message?: string\n  /**\n   * The timestamp when the operation started, if supplied, the duration will be logged.\n   */\n  started?: number\n  /**\n   * The type of GraphQL operation.\n   */\n  type?: OperationTypeNode | null\n  /**\n   * The name of the GraphQL operation.\n   */\n  operationName?: string | null\n  /**\n   * The formatted GraphQL query.\n   */\n  query?: string | null\n  /**\n   * The GraphQL variables.\n   */\n  variables?: Record<string, unknown> | null\n  /**\n   * The result of the GraphQL operation.\n   * Generally, we don't log the data or extensions, just errors.\n   */\n  result?: {\n    data?: Record<string, unknown> | null\n    errors?: readonly GraphQLFormattedError[] | null\n    extensions?: Record<string, unknown> | null\n    hasNext?: boolean\n  }\n  /**\n   * Whether the operation is an introspection query.\n   */\n  isIntrospectionQuery?: boolean\n  /**\n   * Whether the operation is part of an incremental response.\n   */\n  isIncrementalResponse?: boolean\n  /**\n   * Whether the operation is a subsequent payload of an incremental response.\n   */\n  isSubsequentPayload?: boolean\n  /**\n   * Deprecated schema elements the operation used, as returned by `collectDeprecatedElementUsage`.\n   * Omitted from the log entry when empty.\n   */\n  deprecatedElements?: DeprecatedElementUsage[]\n  /**\n   * Whether a limit stopped deprecated element collection, meaning `deprecatedElements` may be\n   * incomplete. Omitted from the log entry when false.\n   */\n  deprecatedElementsTruncated?: boolean\n  /**\n   * The logger to use.\n   */\n  logger: TLogger\n  /**\n   * The logger function to use, defaults to 'info'.\n   */\n  logLevel?: keyof LoggerLogFunctions<TLogger>\n}\n\n/**\n * Logs a GraphQL operation in a consistent format with the option of including any additional data.\n * Top level and result entries with null or undefined values will be omitted.\n */\nexport const logGraphQLOperation = <TLogger extends Logger = Logger>({\n  message = 'GraphQL operation',\n  started,\n  type,\n  operationName,\n  query,\n  variables,\n  result,\n  deprecatedElements,\n  deprecatedElementsTruncated,\n  logger,\n  logLevel = 'info',\n  ...rest\n}: GraphQLLogOperationInfo<TLogger>) => {\n  const isIntrospection = query && isIntrospectionQuery(query)\n  if (isLocalDev && isIntrospection) return\n  logger[logLevel as keyof Logger](\n    message,\n    omitBy(\n      {\n        type,\n        operationName,\n        query,\n        variables: variables && Object.keys(variables).length > 0 ? variables : undefined,\n        duration: started ? Date.now() - started : undefined,\n        result: result ? omitBy(result, isNil) : undefined,\n        isIntrospectionQuery: isIntrospection || undefined,\n        deprecatedElements: deprecatedElements?.length ? deprecatedElements : undefined,\n        deprecatedElementsTruncated: deprecatedElementsTruncated || undefined,\n        ...omitBy(rest, isNil),\n      },\n      isNil,\n    ),\n  )\n}\n\nexport const logSubscriptionOperation = <TLogger extends Logger = Logger>({\n  id,\n  args,\n  result,\n  message,\n  logLevel,\n  resolveLogger,\n  includeDeprecatedElements,\n}: {\n  id?: string\n  args: ExecutionArgs\n  result?: ExecutionResult\n  message?: string\n  logLevel?: keyof LoggerLogFunctions<TLogger>\n  resolveLogger?: (context: GraphQLContext) => TLogger\n  /**\n   * If true, deprecated schema elements the operation uses are collected and logged.\n   */\n  includeDeprecatedElements?: boolean\n}) => {\n  const logger = resolveLogger\n    ? resolveLogger(args.contextValue as GraphQLContext)\n    : ((args.contextValue as GraphQLContext).logger as TLogger)\n  if (!logger) return\n\n  const { operationName, variableValues, document, schema } = args\n  const { data, ...resultWithoutData } = result ?? {}\n\n  let deprecatedElements: DeprecatedElementUsage[] | undefined\n  let deprecatedElementsTruncated: boolean | undefined\n  if (includeDeprecatedElements) {\n    try {\n      const usage = collectDeprecatedElementUsage({ schema, document, operationName, variables: variableValues })\n      deprecatedElements = usage.elements\n      deprecatedElementsTruncated = usage.truncated\n    } catch (error) {\n      // Telemetry must never take down the subscription that produced it.\n      logger.warn('Failed to collect deprecated schema element usage', { error, operationName })\n    }\n  }\n\n  logGraphQLOperation({\n    message,\n    type: OperationTypeNode.SUBSCRIPTION,\n    subscriptionId: id,\n    operationName,\n    query: print(document),\n    variables: variableValues,\n    result: resultWithoutData,\n    deprecatedElements,\n    deprecatedElementsTruncated,\n    logger,\n    logLevel,\n  })\n}\n"],"names":["isIntrospectionQuery","isLocalDev","omitBy","isNil","collectDeprecatedElementUsage","OperationTypeNode","print"],"mappings":";;;;;;;;;AAuFA;;;AAGG;AACI,MAAM,mBAAmB,GAAG,CAAkC,EACnE,OAAO,GAAG,mBAAmB,EAC7B,OAAO,EACP,IAAI,EACJ,aAAa,EACb,KAAK,EACL,SAAS,EACT,MAAM,EACN,kBAAkB,EAClB,2BAA2B,EAC3B,MAAM,EACN,QAAQ,GAAG,MAAM,EACjB,GAAG,IAAI,EAC0B,KAAI;IACrC,MAAM,eAAe,GAAG,KAAK,IAAIA,8BAAoB,CAAC,KAAK,CAAC;IAC5D,IAAIC,qBAAU,IAAI,eAAe;QAAE;AACnC,IAAA,MAAM,CAAC,QAAwB,CAAC,CAC9B,OAAO,EACPC,aAAM,CACJ;QACE,IAAI;QACJ,aAAa;QACb,KAAK;QACL,SAAS,EAAE,SAAS,IAAI,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,MAAM,GAAG,CAAC,GAAG,SAAS,GAAG,SAAS;AACjF,QAAA,QAAQ,EAAE,OAAO,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,OAAO,GAAG,SAAS;AACpD,QAAA,MAAM,EAAE,MAAM,GAAGA,aAAM,CAAC,MAAM,EAAEC,WAAK,CAAC,GAAG,SAAS;QAClD,oBAAoB,EAAE,eAAe,IAAI,SAAS;QAClD,kBAAkB,EAAE,kBAAkB,EAAE,MAAM,GAAG,kBAAkB,GAAG,SAAS;QAC/E,2BAA2B,EAAE,2BAA2B,IAAI,SAAS;AACrE,QAAA,GAAGD,aAAM,CAAC,IAAI,EAAEC,WAAK,CAAC;KACvB,EACDA,WAAK,CACN,CACF;AACH;MAEa,wBAAwB,GAAG,CAAkC,EACxE,EAAE,EACF,IAAI,EACJ,MAAM,EACN,OAAO,EACP,QAAQ,EACR,aAAa,EACb,yBAAyB,GAY1B,KAAI;IACH,MAAM,MAAM,GAAG;AACb,UAAE,aAAa,CAAC,IAAI,CAAC,YAA8B;AACnD,UAAI,IAAI,CAAC,YAA+B,CAAC,MAAkB;AAC7D,IAAA,IAAI,CAAC,MAAM;QAAE;IAEb,MAAM,EAAE,aAAa,EAAE,cAAc,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,IAAI;IAChE,MAAM,EAAE,IAAI,EAAE,GAAG,iBAAiB,EAAE,GAAG,MAAM,IAAI,EAAE;AAEnD,IAAA,IAAI,kBAAwD;AAC5D,IAAA,IAAI,2BAAgD;IACpD,IAAI,yBAAyB,EAAE;AAC7B,QAAA,IAAI;AACF,YAAA,MAAM,KAAK,GAAGC,yCAA6B,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,aAAa,EAAE,SAAS,EAAE,cAAc,EAAE,CAAC;AAC3G,YAAA,kBAAkB,GAAG,KAAK,CAAC,QAAQ;AACnC,YAAA,2BAA2B,GAAG,KAAK,CAAC,SAAS;QAC/C;QAAE,OAAO,KAAK,EAAE;;YAEd,MAAM,CAAC,IAAI,CAAC,mDAAmD,EAAE,EAAE,KAAK,EAAE,aAAa,EAAE,CAAC;QAC5F;IACF;AAEA,IAAA,mBAAmB,CAAC;QAClB,OAAO;QACP,IAAI,EAAEC,yBAAiB,CAAC,YAAY;AACpC,QAAA,cAAc,EAAE,EAAE;QAClB,aAAa;AACb,QAAA,KAAK,EAAEC,aAAK,CAAC,QAAQ,CAAC;AACtB,QAAA,SAAS,EAAE,cAAc;AACzB,QAAA,MAAM,EAAE,iBAAiB;QACzB,kBAAkB;QAClB,2BAA2B;QAC3B,MAAM;QACN,QAAQ;AACT,KAAA,CAAC;AACJ;;;;;"}

package/logging.mjs

@@ -1,6 +1,7 @@
 import { isLocalDev } from '@makerx/node-common';
 import { omitBy } from 'es-toolkit/compat';
 import { print, OperationTypeNode } from 'graphql';
+import { collectDeprecatedElementUsage } from './deprecation.mjs';
 import { isIntrospectionQuery } from './operation.mjs';
 import { isNil } from './utils.mjs';
 
@@ -8,7 +9,7 @@ import { isNil } from './utils.mjs';
  * Logs a GraphQL operation in a consistent format with the option of including any additional data.
  * Top level and result entries with null or undefined values will be omitted.
  */
-const logGraphQLOperation = ({ message = 'GraphQL operation', started, type, operationName, query, variables, result, logger, logLevel = 'info', ...rest }) => {
+const logGraphQLOperation = ({ message = 'GraphQL operation', started, type, operationName, query, variables, result, deprecatedElements, deprecatedElementsTruncated, logger, logLevel = 'info', ...rest }) => {
     const isIntrospection = query && isIntrospectionQuery(query);
     if (isLocalDev && isIntrospection)
         return;
@@ -20,17 +21,32 @@ const logGraphQLOperation = ({ message = 'GraphQL operation', started, type, ope
         duration: started ? Date.now() - started : undefined,
         result: result ? omitBy(result, isNil) : undefined,
         isIntrospectionQuery: isIntrospection || undefined,
+        deprecatedElements: deprecatedElements?.length ? deprecatedElements : undefined,
+        deprecatedElementsTruncated: deprecatedElementsTruncated || undefined,
         ...omitBy(rest, isNil),
     }, isNil));
 };
-const logSubscriptionOperation = ({ id, args, result, message, logLevel, resolveLogger, }) => {
+const logSubscriptionOperation = ({ id, args, result, message, logLevel, resolveLogger, includeDeprecatedElements, }) => {
     const logger = resolveLogger
         ? resolveLogger(args.contextValue)
         : args.contextValue.logger;
     if (!logger)
         return;
-    const { operationName, variableValues, document } = args;
+    const { operationName, variableValues, document, schema } = args;
     const { data, ...resultWithoutData } = result ?? {};
+    let deprecatedElements;
+    let deprecatedElementsTruncated;
+    if (includeDeprecatedElements) {
+        try {
+            const usage = collectDeprecatedElementUsage({ schema, document, operationName, variables: variableValues });
+            deprecatedElements = usage.elements;
+            deprecatedElementsTruncated = usage.truncated;
+        }
+        catch (error) {
+            // Telemetry must never take down the subscription that produced it.
+            logger.warn('Failed to collect deprecated schema element usage', { error, operationName });
+        }
+    }
     logGraphQLOperation({
         message,
         type: OperationTypeNode.SUBSCRIPTION,
@@ -39,6 +55,8 @@ const logSubscriptionOperation = ({ id, args, result, message, logLevel, resolve
         query: print(document),
         variables: variableValues,
         result: resultWithoutData,
+        deprecatedElements,
+        deprecatedElementsTruncated,
         logger,
         logLevel,
     });

package/logging.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"logging.mjs","sources":["../src/logging.ts"],"sourcesContent":["import type { Logger } from '@makerx/node-common'\nimport { isLocalDev } from '@makerx/node-common'\nimport { omitBy } from 'es-toolkit/compat'\nimport type { ExecutionArgs, GraphQLFormattedError } from 'graphql'\nimport { OperationTypeNode, print } from 'graphql'\nimport type { ExecutionResult } from 'graphql-ws'\nimport type { GraphQLContext } from './context'\nimport { isIntrospectionQuery } from './operation'\nimport { isNil } from './utils'\n\ntype LogFunction = Logger['info']\nexport type LoggerLogFunctions<T extends Logger> = {\n  [Property in keyof T]: LogFunction\n}\n\n/**\n * Info for logging a GraphQL operation in a consistent format with the option of including any additional data.\n */\nexport interface GraphQLLogOperationInfo<TLogger extends Logger = Logger> extends Record<string, unknown> {\n  /**\n   * The message to log, defaults to 'GraphQL operation'.\n   */\n  message?: string\n  /**\n   * The timestamp when the operation started, if supplied, the duration will be logged.\n   */\n  started?: number\n  /**\n   * The type of GraphQL operation.\n   */\n  type?: OperationTypeNode | null\n  /**\n   * The name of the GraphQL operation.\n   */\n  operationName?: string | null\n  /**\n   * The formatted GraphQL query.\n   */\n  query?: string | null\n  /**\n   * The GraphQL variables.\n   */\n  variables?: Record<string, unknown> | null\n  /**\n   * The result of the GraphQL operation.\n   * Generally, we don't log the data or extensions, just errors.\n   */\n  result?: {\n    data?: Record<string, unknown> | null\n    errors?: readonly GraphQLFormattedError[] | null\n    extensions?: Record<string, unknown> | null\n    hasNext?: boolean\n  }\n  /**\n   * Whether the operation is an introspection query.\n   */\n  isIntrospectionQuery?: boolean\n  /**\n   * Whether the operation is part of an incremental response.\n   */\n  isIncrementalResponse?: boolean\n  /**\n   * Whether the operation is a subsequent payload of an incremental response.\n   */\n  isSubsequentPayload?: boolean\n  /**\n   * The logger to use.\n   */\n  logger: TLogger\n  /**\n   * The logger function to use, defaults to 'info'.\n   */\n  logLevel?: keyof LoggerLogFunctions<TLogger>\n}\n\n/**\n * Logs a GraphQL operation in a consistent format with the option of including any additional data.\n * Top level and result entries with null or undefined values will be omitted.\n */\nexport const logGraphQLOperation = <TLogger extends Logger = Logger>({\n  message = 'GraphQL operation',\n  started,\n  type,\n  operationName,\n  query,\n  variables,\n  result,\n  logger,\n  logLevel = 'info',\n  ...rest\n}: GraphQLLogOperationInfo<TLogger>) => {\n  const isIntrospection = query && isIntrospectionQuery(query)\n  if (isLocalDev && isIntrospection) return\n  logger[logLevel as keyof Logger](\n    message,\n    omitBy(\n      {\n        type,\n        operationName,\n        query,\n        variables: variables && Object.keys(variables).length > 0 ? variables : undefined,\n        duration: started ? Date.now() - started : undefined,\n        result: result ? omitBy(result, isNil) : undefined,\n        isIntrospectionQuery: isIntrospection || undefined,\n        ...omitBy(rest, isNil),\n      },\n      isNil,\n    ),\n  )\n}\n\nexport const logSubscriptionOperation = <TLogger extends Logger = Logger>({\n  id,\n  args,\n  result,\n  message,\n  logLevel,\n  resolveLogger,\n}: {\n  id?: string\n  args: ExecutionArgs\n  result?: ExecutionResult\n  message?: string\n  logLevel?: keyof LoggerLogFunctions<TLogger>\n  resolveLogger?: (context: GraphQLContext) => TLogger\n}) => {\n  const logger = resolveLogger\n    ? resolveLogger(args.contextValue as GraphQLContext)\n    : ((args.contextValue as GraphQLContext).logger as TLogger)\n  if (!logger) return\n\n  const { operationName, variableValues, document } = args\n  const { data, ...resultWithoutData } = result ?? {}\n\n  logGraphQLOperation({\n    message,\n    type: OperationTypeNode.SUBSCRIPTION,\n    subscriptionId: id,\n    operationName,\n    query: print(document),\n    variables: variableValues,\n    result: resultWithoutData,\n    logger,\n    logLevel,\n  })\n}\n"],"names":[],"mappings":";;;;;;AA2EA;;;AAGG;AACI,MAAM,mBAAmB,GAAG,CAAkC,EACnE,OAAO,GAAG,mBAAmB,EAC7B,OAAO,EACP,IAAI,EACJ,aAAa,EACb,KAAK,EACL,SAAS,EACT,MAAM,EACN,MAAM,EACN,QAAQ,GAAG,MAAM,EACjB,GAAG,IAAI,EAC0B,KAAI;IACrC,MAAM,eAAe,GAAG,KAAK,IAAI,oBAAoB,CAAC,KAAK,CAAC;IAC5D,IAAI,UAAU,IAAI,eAAe;QAAE;AACnC,IAAA,MAAM,CAAC,QAAwB,CAAC,CAC9B,OAAO,EACP,MAAM,CACJ;QACE,IAAI;QACJ,aAAa;QACb,KAAK;QACL,SAAS,EAAE,SAAS,IAAI,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,MAAM,GAAG,CAAC,GAAG,SAAS,GAAG,SAAS;AACjF,QAAA,QAAQ,EAAE,OAAO,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,OAAO,GAAG,SAAS;AACpD,QAAA,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,GAAG,SAAS;QAClD,oBAAoB,EAAE,eAAe,IAAI,SAAS;AAClD,QAAA,GAAG,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC;KACvB,EACD,KAAK,CACN,CACF;AACH;AAEO,MAAM,wBAAwB,GAAG,CAAkC,EACxE,EAAE,EACF,IAAI,EACJ,MAAM,EACN,OAAO,EACP,QAAQ,EACR,aAAa,GAQd,KAAI;IACH,MAAM,MAAM,GAAG;AACb,UAAE,aAAa,CAAC,IAAI,CAAC,YAA8B;AACnD,UAAI,IAAI,CAAC,YAA+B,CAAC,MAAkB;AAC7D,IAAA,IAAI,CAAC,MAAM;QAAE;IAEb,MAAM,EAAE,aAAa,EAAE,cAAc,EAAE,QAAQ,EAAE,GAAG,IAAI;IACxD,MAAM,EAAE,IAAI,EAAE,GAAG,iBAAiB,EAAE,GAAG,MAAM,IAAI,EAAE;AAEnD,IAAA,mBAAmB,CAAC;QAClB,OAAO;QACP,IAAI,EAAE,iBAAiB,CAAC,YAAY;AACpC,QAAA,cAAc,EAAE,EAAE;QAClB,aAAa;AACb,QAAA,KAAK,EAAE,KAAK,CAAC,QAAQ,CAAC;AACtB,QAAA,SAAS,EAAE,cAAc;AACzB,QAAA,MAAM,EAAE,iBAAiB;QACzB,MAAM;QACN,QAAQ;AACT,KAAA,CAAC;AACJ;;;;"}
+{"version":3,"file":"logging.mjs","sources":["../src/logging.ts"],"sourcesContent":["import type { Logger } from '@makerx/node-common'\nimport { isLocalDev } from '@makerx/node-common'\nimport { omitBy } from 'es-toolkit/compat'\nimport type { ExecutionArgs, GraphQLFormattedError } from 'graphql'\nimport { OperationTypeNode, print } from 'graphql'\nimport type { ExecutionResult } from 'graphql-ws'\nimport type { GraphQLContext } from './context'\nimport type { DeprecatedElementUsage } from './deprecation'\nimport { collectDeprecatedElementUsage } from './deprecation'\nimport { isIntrospectionQuery } from './operation'\nimport { isNil } from './utils'\n\ntype LogFunction = Logger['info']\nexport type LoggerLogFunctions<T extends Logger> = {\n  [Property in keyof T]: LogFunction\n}\n\n/**\n * Info for logging a GraphQL operation in a consistent format with the option of including any additional data.\n */\nexport interface GraphQLLogOperationInfo<TLogger extends Logger = Logger> extends Record<string, unknown> {\n  /**\n   * The message to log, defaults to 'GraphQL operation'.\n   */\n  message?: string\n  /**\n   * The timestamp when the operation started, if supplied, the duration will be logged.\n   */\n  started?: number\n  /**\n   * The type of GraphQL operation.\n   */\n  type?: OperationTypeNode | null\n  /**\n   * The name of the GraphQL operation.\n   */\n  operationName?: string | null\n  /**\n   * The formatted GraphQL query.\n   */\n  query?: string | null\n  /**\n   * The GraphQL variables.\n   */\n  variables?: Record<string, unknown> | null\n  /**\n   * The result of the GraphQL operation.\n   * Generally, we don't log the data or extensions, just errors.\n   */\n  result?: {\n    data?: Record<string, unknown> | null\n    errors?: readonly GraphQLFormattedError[] | null\n    extensions?: Record<string, unknown> | null\n    hasNext?: boolean\n  }\n  /**\n   * Whether the operation is an introspection query.\n   */\n  isIntrospectionQuery?: boolean\n  /**\n   * Whether the operation is part of an incremental response.\n   */\n  isIncrementalResponse?: boolean\n  /**\n   * Whether the operation is a subsequent payload of an incremental response.\n   */\n  isSubsequentPayload?: boolean\n  /**\n   * Deprecated schema elements the operation used, as returned by `collectDeprecatedElementUsage`.\n   * Omitted from the log entry when empty.\n   */\n  deprecatedElements?: DeprecatedElementUsage[]\n  /**\n   * Whether a limit stopped deprecated element collection, meaning `deprecatedElements` may be\n   * incomplete. Omitted from the log entry when false.\n   */\n  deprecatedElementsTruncated?: boolean\n  /**\n   * The logger to use.\n   */\n  logger: TLogger\n  /**\n   * The logger function to use, defaults to 'info'.\n   */\n  logLevel?: keyof LoggerLogFunctions<TLogger>\n}\n\n/**\n * Logs a GraphQL operation in a consistent format with the option of including any additional data.\n * Top level and result entries with null or undefined values will be omitted.\n */\nexport const logGraphQLOperation = <TLogger extends Logger = Logger>({\n  message = 'GraphQL operation',\n  started,\n  type,\n  operationName,\n  query,\n  variables,\n  result,\n  deprecatedElements,\n  deprecatedElementsTruncated,\n  logger,\n  logLevel = 'info',\n  ...rest\n}: GraphQLLogOperationInfo<TLogger>) => {\n  const isIntrospection = query && isIntrospectionQuery(query)\n  if (isLocalDev && isIntrospection) return\n  logger[logLevel as keyof Logger](\n    message,\n    omitBy(\n      {\n        type,\n        operationName,\n        query,\n        variables: variables && Object.keys(variables).length > 0 ? variables : undefined,\n        duration: started ? Date.now() - started : undefined,\n        result: result ? omitBy(result, isNil) : undefined,\n        isIntrospectionQuery: isIntrospection || undefined,\n        deprecatedElements: deprecatedElements?.length ? deprecatedElements : undefined,\n        deprecatedElementsTruncated: deprecatedElementsTruncated || undefined,\n        ...omitBy(rest, isNil),\n      },\n      isNil,\n    ),\n  )\n}\n\nexport const logSubscriptionOperation = <TLogger extends Logger = Logger>({\n  id,\n  args,\n  result,\n  message,\n  logLevel,\n  resolveLogger,\n  includeDeprecatedElements,\n}: {\n  id?: string\n  args: ExecutionArgs\n  result?: ExecutionResult\n  message?: string\n  logLevel?: keyof LoggerLogFunctions<TLogger>\n  resolveLogger?: (context: GraphQLContext) => TLogger\n  /**\n   * If true, deprecated schema elements the operation uses are collected and logged.\n   */\n  includeDeprecatedElements?: boolean\n}) => {\n  const logger = resolveLogger\n    ? resolveLogger(args.contextValue as GraphQLContext)\n    : ((args.contextValue as GraphQLContext).logger as TLogger)\n  if (!logger) return\n\n  const { operationName, variableValues, document, schema } = args\n  const { data, ...resultWithoutData } = result ?? {}\n\n  let deprecatedElements: DeprecatedElementUsage[] | undefined\n  let deprecatedElementsTruncated: boolean | undefined\n  if (includeDeprecatedElements) {\n    try {\n      const usage = collectDeprecatedElementUsage({ schema, document, operationName, variables: variableValues })\n      deprecatedElements = usage.elements\n      deprecatedElementsTruncated = usage.truncated\n    } catch (error) {\n      // Telemetry must never take down the subscription that produced it.\n      logger.warn('Failed to collect deprecated schema element usage', { error, operationName })\n    }\n  }\n\n  logGraphQLOperation({\n    message,\n    type: OperationTypeNode.SUBSCRIPTION,\n    subscriptionId: id,\n    operationName,\n    query: print(document),\n    variables: variableValues,\n    result: resultWithoutData,\n    deprecatedElements,\n    deprecatedElementsTruncated,\n    logger,\n    logLevel,\n  })\n}\n"],"names":[],"mappings":";;;;;;;AAuFA;;;AAGG;AACI,MAAM,mBAAmB,GAAG,CAAkC,EACnE,OAAO,GAAG,mBAAmB,EAC7B,OAAO,EACP,IAAI,EACJ,aAAa,EACb,KAAK,EACL,SAAS,EACT,MAAM,EACN,kBAAkB,EAClB,2BAA2B,EAC3B,MAAM,EACN,QAAQ,GAAG,MAAM,EACjB,GAAG,IAAI,EAC0B,KAAI;IACrC,MAAM,eAAe,GAAG,KAAK,IAAI,oBAAoB,CAAC,KAAK,CAAC;IAC5D,IAAI,UAAU,IAAI,eAAe;QAAE;AACnC,IAAA,MAAM,CAAC,QAAwB,CAAC,CAC9B,OAAO,EACP,MAAM,CACJ;QACE,IAAI;QACJ,aAAa;QACb,KAAK;QACL,SAAS,EAAE,SAAS,IAAI,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,MAAM,GAAG,CAAC,GAAG,SAAS,GAAG,SAAS;AACjF,QAAA,QAAQ,EAAE,OAAO,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,OAAO,GAAG,SAAS;AACpD,QAAA,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,GAAG,SAAS;QAClD,oBAAoB,EAAE,eAAe,IAAI,SAAS;QAClD,kBAAkB,EAAE,kBAAkB,EAAE,MAAM,GAAG,kBAAkB,GAAG,SAAS;QAC/E,2BAA2B,EAAE,2BAA2B,IAAI,SAAS;AACrE,QAAA,GAAG,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC;KACvB,EACD,KAAK,CACN,CACF;AACH;MAEa,wBAAwB,GAAG,CAAkC,EACxE,EAAE,EACF,IAAI,EACJ,MAAM,EACN,OAAO,EACP,QAAQ,EACR,aAAa,EACb,yBAAyB,GAY1B,KAAI;IACH,MAAM,MAAM,GAAG;AACb,UAAE,aAAa,CAAC,IAAI,CAAC,YAA8B;AACnD,UAAI,IAAI,CAAC,YAA+B,CAAC,MAAkB;AAC7D,IAAA,IAAI,CAAC,MAAM;QAAE;IAEb,MAAM,EAAE,aAAa,EAAE,cAAc,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,IAAI;IAChE,MAAM,EAAE,IAAI,EAAE,GAAG,iBAAiB,EAAE,GAAG,MAAM,IAAI,EAAE;AAEnD,IAAA,IAAI,kBAAwD;AAC5D,IAAA,IAAI,2BAAgD;IACpD,IAAI,yBAAyB,EAAE;AAC7B,QAAA,IAAI;AACF,YAAA,MAAM,KAAK,GAAG,6BAA6B,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,aAAa,EAAE,SAAS,EAAE,cAAc,EAAE,CAAC;AAC3G,YAAA,kBAAkB,GAAG,KAAK,CAAC,QAAQ;AACnC,YAAA,2BAA2B,GAAG,KAAK,CAAC,SAAS;QAC/C;QAAE,OAAO,KAAK,EAAE;;YAEd,MAAM,CAAC,IAAI,CAAC,mDAAmD,EAAE,EAAE,KAAK,EAAE,aAAa,EAAE,CAAC;QAC5F;IACF;AAEA,IAAA,mBAAmB,CAAC;QAClB,OAAO;QACP,IAAI,EAAE,iBAAiB,CAAC,YAAY;AACpC,QAAA,cAAc,EAAE,EAAE;QAClB,aAAa;AACb,QAAA,KAAK,EAAE,KAAK,CAAC,QAAQ,CAAC;AACtB,QAAA,SAAS,EAAE,cAAc;AACzB,QAAA,MAAM,EAAE,iBAAiB;QACzB,kBAAkB;QAClB,2BAA2B;QAC3B,MAAM;QACN,QAAQ;AACT,KAAA,CAAC;AACJ;;;;"}

package/package.json

@@ -4,7 +4,7 @@
     "**"
   ],
   "name": "@makerx/graphql-core",
-  "version": "3.2.0",
+  "version": "3.4.0",
   "private": false,
   "description": "A set of core GraphQL utilities that MakerX uses to build GraphQL APIs",
   "author": "MakerX",

package/subscriptions/context.d.cts

@@ -10,12 +10,19 @@ export interface SubscriptionContextInput {
 export type CreateSubscriptionUser<T = User | undefined> = (input: SubscriptionContextInput) => Promise<T> | T;
 export type CreateSubscriptionContext<TContext = GraphQLContext> = (input: SubscriptionContextInput) => Promise<TContext>;
 export type AugmentSubscriptionRequestInfo = (input: SubscriptionContextInput) => Record<string, unknown>;
+export type ExtractSubscriptionToken = (input: Omit<SubscriptionContextInput, 'claims'>) => string | undefined;
 export type CreateSubscriptionContextConfig<TUser = User | undefined, TAugment extends Record<string, unknown> = Record<string, never>, TLogger extends Logger = Logger> = {
     requestLogger: CreateRequestLogger<TUser, TLogger> | TLogger;
     augmentRequestInfo?: AugmentSubscriptionRequestInfo;
     claimsToLog?: string[];
     requestInfoToLog?: Array<RequestInfoLogKey>;
     augmentContext?: (context: GraphQLContext<TLogger, RequestInfo, TUser>) => TAugment | Promise<TAugment>;
+    /**
+     * Returns the token that the default `createUser` sets as `User.token`. Use the same function as
+     * the `useSubscriptionsServer` `extractToken` option. Not called when you supply `createUser`.
+     * Defaults to the bearer token in the `authorization` or `Authorization` connection parameter.
+     */
+    extractToken?: ExtractSubscriptionToken;
 } & ([User | undefined] extends [TUser] ? {
     createUser?: CreateSubscriptionUser<TUser>;
 } : {

package/subscriptions/context.d.mts

@@ -10,12 +10,19 @@ export interface SubscriptionContextInput {
 export type CreateSubscriptionUser<T = User | undefined> = (input: SubscriptionContextInput) => Promise<T> | T;
 export type CreateSubscriptionContext<TContext = GraphQLContext> = (input: SubscriptionContextInput) => Promise<TContext>;
 export type AugmentSubscriptionRequestInfo = (input: SubscriptionContextInput) => Record<string, unknown>;
+export type ExtractSubscriptionToken = (input: Omit<SubscriptionContextInput, 'claims'>) => string | undefined;
 export type CreateSubscriptionContextConfig<TUser = User | undefined, TAugment extends Record<string, unknown> = Record<string, never>, TLogger extends Logger = Logger> = {
     requestLogger: CreateRequestLogger<TUser, TLogger> | TLogger;
     augmentRequestInfo?: AugmentSubscriptionRequestInfo;
     claimsToLog?: string[];
     requestInfoToLog?: Array<RequestInfoLogKey>;
     augmentContext?: (context: GraphQLContext<TLogger, RequestInfo, TUser>) => TAugment | Promise<TAugment>;
+    /**
+     * Returns the token that the default `createUser` sets as `User.token`. Use the same function as
+     * the `useSubscriptionsServer` `extractToken` option. Not called when you supply `createUser`.
+     * Defaults to the bearer token in the `authorization` or `Authorization` connection parameter.
+     */
+    extractToken?: ExtractSubscriptionToken;
 } & ([User | undefined] extends [TUser] ? {
     createUser?: CreateSubscriptionUser<TUser>;
 } : {

package/subscriptions/context.d.ts

@@ -10,12 +10,19 @@ export interface SubscriptionContextInput {
 export type CreateSubscriptionUser<T = User | undefined> = (input: SubscriptionContextInput) => Promise<T> | T;
 export type CreateSubscriptionContext<TContext = GraphQLContext> = (input: SubscriptionContextInput) => Promise<TContext>;
 export type AugmentSubscriptionRequestInfo = (input: SubscriptionContextInput) => Record<string, unknown>;
+export type ExtractSubscriptionToken = (input: Omit<SubscriptionContextInput, 'claims'>) => string | undefined;
 export type CreateSubscriptionContextConfig<TUser = User | undefined, TAugment extends Record<string, unknown> = Record<string, never>, TLogger extends Logger = Logger> = {
     requestLogger: CreateRequestLogger<TUser, TLogger> | TLogger;
     augmentRequestInfo?: AugmentSubscriptionRequestInfo;
     claimsToLog?: string[];
     requestInfoToLog?: Array<RequestInfoLogKey>;
     augmentContext?: (context: GraphQLContext<TLogger, RequestInfo, TUser>) => TAugment | Promise<TAugment>;
+    /**
+     * Returns the token that the default `createUser` sets as `User.token`. Use the same function as
+     * the `useSubscriptionsServer` `extractToken` option. Not called when you supply `createUser`.
+     * Defaults to the bearer token in the `authorization` or `Authorization` connection parameter.
+     */
+    extractToken?: ExtractSubscriptionToken;
 } & ([User | undefined] extends [TUser] ? {
     createUser?: CreateSubscriptionUser<TUser>;
 } : {

package/subscriptions/context.js

@@ -9,7 +9,8 @@ const createSubscriptionContextFactory = (config) => {
     const { requestLogger, augmentRequestInfo, claimsToLog, requestInfoToLog, augmentContext } = config;
     // The conditional type on CreateSubscriptionContextConfig guarantees `createUser` is provided
     // when TUser is narrower than `User | undefined`, so defaulting is sound here.
-    const createUser = (config.createUser ?? defaultCreateUser);
+    const createUser = (config.createUser ??
+        buildDefaultCreateUser(config.extractToken ?? utils.defaultExtractSubscriptionToken));
     return async (input) => {
         const { connectRequest: req, claims } = input;
         // build request info from the connect request and socket
@@ -44,11 +45,10 @@ const createSubscriptionContextFactory = (config) => {
         return augmentedGraphQLContext;
     };
 };
-const defaultCreateUser = ({ claims, connectionParams }) => {
-    if (!claims)
+const buildDefaultCreateUser = (extractToken) => (input) => {
+    if (!input.claims)
         return Promise.resolve(undefined);
-    const accessToken = utils.extractTokenFromConnectionParams(connectionParams);
-    return Promise.resolve(new User.User(claims, accessToken ?? ''));
+    return Promise.resolve(new User.User(input.claims, extractToken(input) ?? ''));
 };
 
 exports.createSubscriptionContextFactory = createSubscriptionContextFactory;

package/subscriptions/context.js.map

@@ -1 +1 @@
-{"version":3,"file":"context.js","sources":["../../src/subscriptions/context.ts"],"sourcesContent":["import type { Logger } from '@makerx/node-common'\nimport { pick } from 'es-toolkit/compat'\nimport type { IncomingMessage } from 'http'\nimport { User } from '../User'\nimport type { CreateRequestLogger, GraphQLContext, JwtPayload, RequestInfo, RequestInfoLogKey } from '../context'\nimport { buildConnectRequestInfo } from '../request-info'\nimport { extractTokenFromConnectionParams } from './utils'\n\nexport interface SubscriptionContextInput {\n  connectRequest: IncomingMessage\n  connectionParams?: Readonly<Record<string, unknown>>\n  claims?: JwtPayload\n}\n\nexport type CreateSubscriptionUser<T = User | undefined> = (input: SubscriptionContextInput) => Promise<T> | T\nexport type CreateSubscriptionContext<TContext = GraphQLContext> = (input: SubscriptionContextInput) => Promise<TContext>\nexport type AugmentSubscriptionRequestInfo = (input: SubscriptionContextInput) => Record<string, unknown>\n\n// `createUser` is optional when TUser is compatible with the default `User | undefined`\n// (i.e. defaultCreateUser can satisfy it), and required when TUser is narrower.\nexport type CreateSubscriptionContextConfig<\n  TUser = User | undefined,\n  TAugment extends Record<string, unknown> = Record<string, never>,\n  TLogger extends Logger = Logger,\n> = {\n  requestLogger: CreateRequestLogger<TUser, TLogger> | TLogger\n  augmentRequestInfo?: AugmentSubscriptionRequestInfo\n  claimsToLog?: string[]\n  requestInfoToLog?: Array<RequestInfoLogKey>\n  augmentContext?: (context: GraphQLContext<TLogger, RequestInfo, TUser>) => TAugment | Promise<TAugment>\n} & ([User | undefined] extends [TUser] ? { createUser?: CreateSubscriptionUser<TUser> } : { createUser: CreateSubscriptionUser<TUser> })\n\nexport const createSubscriptionContextFactory = <\n  TUser = User | undefined,\n  TAugment extends Record<string, unknown> = Record<string, never>,\n  TLogger extends Logger = Logger,\n>(\n  config: CreateSubscriptionContextConfig<TUser, TAugment, TLogger>,\n): CreateSubscriptionContext<GraphQLContext<TLogger, RequestInfo, TUser> & TAugment> => {\n  const { requestLogger, augmentRequestInfo, claimsToLog, requestInfoToLog, augmentContext } = config\n  // The conditional type on CreateSubscriptionContextConfig guarantees `createUser` is provided\n  // when TUser is narrower than `User | undefined`, so defaulting is sound here.\n  const createUser = (config.createUser ?? defaultCreateUser) as CreateSubscriptionUser<TUser>\n\n  return async (input: SubscriptionContextInput) => {\n    const { connectRequest: req, claims } = input\n\n    // build request info from the connect request and socket\n    const requestInfo: RequestInfo = {\n      ...buildConnectRequestInfo(req),\n      ...augmentRequestInfo?.(input),\n    }\n\n    const user = await createUser(input)\n\n    // create request logger\n    let logger: TLogger\n    if (typeof requestLogger === 'function') {\n      // build request logger metadata\n      const requestLoggerMetadata: Record<string, unknown> = {}\n      // add request info to log\n      if (requestInfoToLog?.length) requestLoggerMetadata.request = pick(requestInfo, requestInfoToLog)\n      // add user claims to log\n      if (claims && claimsToLog?.length) requestLoggerMetadata.user = pick(claims, claimsToLog)\n      // build the request logger\n      logger = requestLogger(requestLoggerMetadata, user)\n    } else logger = requestLogger\n\n    const graphqlContext: GraphQLContext<TLogger, RequestInfo, TUser> = {\n      requestInfo,\n      logger,\n      user,\n      started: Date.now(),\n    }\n\n    const augmentedGraphQLContext = augmentContext ? { ...graphqlContext, ...(await augmentContext(graphqlContext)) } : graphqlContext\n\n    return augmentedGraphQLContext as GraphQLContext<TLogger, RequestInfo, TUser> & TAugment\n  }\n}\n\nconst defaultCreateUser: CreateSubscriptionUser<User | undefined> = ({ claims, connectionParams }) => {\n  if (!claims) return Promise.resolve(undefined)\n  const accessToken = extractTokenFromConnectionParams(connectionParams)\n  return Promise.resolve(new User(claims, accessToken ?? ''))\n}\n"],"names":["requestInfo","buildConnectRequestInfo","pick","extractTokenFromConnectionParams","User"],"mappings":";;;;;;;AAgCO,MAAM,gCAAgC,GAAG,CAK9C,MAAiE,KACoB;AACrF,IAAA,MAAM,EAAE,aAAa,EAAE,kBAAkB,EAAE,WAAW,EAAE,gBAAgB,EAAE,cAAc,EAAE,GAAG,MAAM;;;IAGnG,MAAM,UAAU,IAAI,MAAM,CAAC,UAAU,IAAI,iBAAiB,CAAkC;AAE5F,IAAA,OAAO,OAAO,KAA+B,KAAI;QAC/C,MAAM,EAAE,cAAc,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,KAAK;;AAG7C,QAAA,MAAMA,aAAW,GAAgB;YAC/B,GAAGC,mCAAuB,CAAC,GAAG,CAAC;AAC/B,YAAA,GAAG,kBAAkB,GAAG,KAAK,CAAC;SAC/B;AAED,QAAA,MAAM,IAAI,GAAG,MAAM,UAAU,CAAC,KAAK,CAAC;;AAGpC,QAAA,IAAI,MAAe;AACnB,QAAA,IAAI,OAAO,aAAa,KAAK,UAAU,EAAE;;YAEvC,MAAM,qBAAqB,GAA4B,EAAE;;YAEzD,IAAI,gBAAgB,EAAE,MAAM;gBAAE,qBAAqB,CAAC,OAAO,GAAGC,WAAI,CAACF,aAAW,EAAE,gBAAgB,CAAC;;AAEjG,YAAA,IAAI,MAAM,IAAI,WAAW,EAAE,MAAM;gBAAE,qBAAqB,CAAC,IAAI,GAAGE,WAAI,CAAC,MAAM,EAAE,WAAW,CAAC;;AAEzF,YAAA,MAAM,GAAG,aAAa,CAAC,qBAAqB,EAAE,IAAI,CAAC;QACrD;;YAAO,MAAM,GAAG,aAAa;AAE7B,QAAA,MAAM,cAAc,GAAgD;yBAClEF,aAAW;YACX,MAAM;YACN,IAAI;AACJ,YAAA,OAAO,EAAE,IAAI,CAAC,GAAG,EAAE;SACpB;QAED,MAAM,uBAAuB,GAAG,cAAc,GAAG,EAAE,GAAG,cAAc,EAAE,IAAI,MAAM,cAAc,CAAC,cAAc,CAAC,CAAC,EAAE,GAAG,cAAc;AAElI,QAAA,OAAO,uBAAiF;AAC1F,IAAA,CAAC;AACH;AAEA,MAAM,iBAAiB,GAA6C,CAAC,EAAE,MAAM,EAAE,gBAAgB,EAAE,KAAI;AACnG,IAAA,IAAI,CAAC,MAAM;AAAE,QAAA,OAAO,OAAO,CAAC,OAAO,CAAC,SAAS,CAAC;AAC9C,IAAA,MAAM,WAAW,GAAGG,sCAAgC,CAAC,gBAAgB,CAAC;AACtE,IAAA,OAAO,OAAO,CAAC,OAAO,CAAC,IAAIC,SAAI,CAAC,MAAM,EAAE,WAAW,IAAI,EAAE,CAAC,CAAC;AAC7D,CAAC;;;;"}
+{"version":3,"file":"context.js","sources":["../../src/subscriptions/context.ts"],"sourcesContent":["import type { Logger } from '@makerx/node-common'\nimport { pick } from 'es-toolkit/compat'\nimport type { IncomingMessage } from 'http'\nimport { User } from '../User'\nimport type { CreateRequestLogger, GraphQLContext, JwtPayload, RequestInfo, RequestInfoLogKey } from '../context'\nimport { buildConnectRequestInfo } from '../request-info'\nimport { defaultExtractSubscriptionToken } from './utils'\n\nexport interface SubscriptionContextInput {\n  connectRequest: IncomingMessage\n  connectionParams?: Readonly<Record<string, unknown>>\n  claims?: JwtPayload\n}\n\nexport type CreateSubscriptionUser<T = User | undefined> = (input: SubscriptionContextInput) => Promise<T> | T\nexport type CreateSubscriptionContext<TContext = GraphQLContext> = (input: SubscriptionContextInput) => Promise<TContext>\nexport type AugmentSubscriptionRequestInfo = (input: SubscriptionContextInput) => Record<string, unknown>\n// The token is extracted before the connection is authenticated, so the input has no claims.\nexport type ExtractSubscriptionToken = (input: Omit<SubscriptionContextInput, 'claims'>) => string | undefined\n\n// `createUser` is optional when TUser is compatible with the default `User | undefined`\n// (i.e. defaultCreateUser can satisfy it), and required when TUser is narrower.\nexport type CreateSubscriptionContextConfig<\n  TUser = User | undefined,\n  TAugment extends Record<string, unknown> = Record<string, never>,\n  TLogger extends Logger = Logger,\n> = {\n  requestLogger: CreateRequestLogger<TUser, TLogger> | TLogger\n  augmentRequestInfo?: AugmentSubscriptionRequestInfo\n  claimsToLog?: string[]\n  requestInfoToLog?: Array<RequestInfoLogKey>\n  augmentContext?: (context: GraphQLContext<TLogger, RequestInfo, TUser>) => TAugment | Promise<TAugment>\n  /**\n   * Returns the token that the default `createUser` sets as `User.token`. Use the same function as\n   * the `useSubscriptionsServer` `extractToken` option. Not called when you supply `createUser`.\n   * Defaults to the bearer token in the `authorization` or `Authorization` connection parameter.\n   */\n  extractToken?: ExtractSubscriptionToken\n} & ([User | undefined] extends [TUser] ? { createUser?: CreateSubscriptionUser<TUser> } : { createUser: CreateSubscriptionUser<TUser> })\n\nexport const createSubscriptionContextFactory = <\n  TUser = User | undefined,\n  TAugment extends Record<string, unknown> = Record<string, never>,\n  TLogger extends Logger = Logger,\n>(\n  config: CreateSubscriptionContextConfig<TUser, TAugment, TLogger>,\n): CreateSubscriptionContext<GraphQLContext<TLogger, RequestInfo, TUser> & TAugment> => {\n  const { requestLogger, augmentRequestInfo, claimsToLog, requestInfoToLog, augmentContext } = config\n  // The conditional type on CreateSubscriptionContextConfig guarantees `createUser` is provided\n  // when TUser is narrower than `User | undefined`, so defaulting is sound here.\n  const createUser = (config.createUser ??\n    buildDefaultCreateUser(config.extractToken ?? defaultExtractSubscriptionToken)) as CreateSubscriptionUser<TUser>\n\n  return async (input: SubscriptionContextInput) => {\n    const { connectRequest: req, claims } = input\n\n    // build request info from the connect request and socket\n    const requestInfo: RequestInfo = {\n      ...buildConnectRequestInfo(req),\n      ...augmentRequestInfo?.(input),\n    }\n\n    const user = await createUser(input)\n\n    // create request logger\n    let logger: TLogger\n    if (typeof requestLogger === 'function') {\n      // build request logger metadata\n      const requestLoggerMetadata: Record<string, unknown> = {}\n      // add request info to log\n      if (requestInfoToLog?.length) requestLoggerMetadata.request = pick(requestInfo, requestInfoToLog)\n      // add user claims to log\n      if (claims && claimsToLog?.length) requestLoggerMetadata.user = pick(claims, claimsToLog)\n      // build the request logger\n      logger = requestLogger(requestLoggerMetadata, user)\n    } else logger = requestLogger\n\n    const graphqlContext: GraphQLContext<TLogger, RequestInfo, TUser> = {\n      requestInfo,\n      logger,\n      user,\n      started: Date.now(),\n    }\n\n    const augmentedGraphQLContext = augmentContext ? { ...graphqlContext, ...(await augmentContext(graphqlContext)) } : graphqlContext\n\n    return augmentedGraphQLContext as GraphQLContext<TLogger, RequestInfo, TUser> & TAugment\n  }\n}\n\nconst buildDefaultCreateUser =\n  (extractToken: ExtractSubscriptionToken): CreateSubscriptionUser<User | undefined> =>\n  (input) => {\n    if (!input.claims) return Promise.resolve(undefined)\n    return Promise.resolve(new User(input.claims, extractToken(input) ?? ''))\n  }\n"],"names":["defaultExtractSubscriptionToken","requestInfo","buildConnectRequestInfo","pick","User"],"mappings":";;;;;;;AAwCO,MAAM,gCAAgC,GAAG,CAK9C,MAAiE,KACoB;AACrF,IAAA,MAAM,EAAE,aAAa,EAAE,kBAAkB,EAAE,WAAW,EAAE,gBAAgB,EAAE,cAAc,EAAE,GAAG,MAAM;;;AAGnG,IAAA,MAAM,UAAU,IAAI,MAAM,CAAC,UAAU;QACnC,sBAAsB,CAAC,MAAM,CAAC,YAAY,IAAIA,qCAA+B,CAAC,CAAkC;AAElH,IAAA,OAAO,OAAO,KAA+B,KAAI;QAC/C,MAAM,EAAE,cAAc,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,KAAK;;AAG7C,QAAA,MAAMC,aAAW,GAAgB;YAC/B,GAAGC,mCAAuB,CAAC,GAAG,CAAC;AAC/B,YAAA,GAAG,kBAAkB,GAAG,KAAK,CAAC;SAC/B;AAED,QAAA,MAAM,IAAI,GAAG,MAAM,UAAU,CAAC,KAAK,CAAC;;AAGpC,QAAA,IAAI,MAAe;AACnB,QAAA,IAAI,OAAO,aAAa,KAAK,UAAU,EAAE;;YAEvC,MAAM,qBAAqB,GAA4B,EAAE;;YAEzD,IAAI,gBAAgB,EAAE,MAAM;gBAAE,qBAAqB,CAAC,OAAO,GAAGC,WAAI,CAACF,aAAW,EAAE,gBAAgB,CAAC;;AAEjG,YAAA,IAAI,MAAM,IAAI,WAAW,EAAE,MAAM;gBAAE,qBAAqB,CAAC,IAAI,GAAGE,WAAI,CAAC,MAAM,EAAE,WAAW,CAAC;;AAEzF,YAAA,MAAM,GAAG,aAAa,CAAC,qBAAqB,EAAE,IAAI,CAAC;QACrD;;YAAO,MAAM,GAAG,aAAa;AAE7B,QAAA,MAAM,cAAc,GAAgD;yBAClEF,aAAW;YACX,MAAM;YACN,IAAI;AACJ,YAAA,OAAO,EAAE,IAAI,CAAC,GAAG,EAAE;SACpB;QAED,MAAM,uBAAuB,GAAG,cAAc,GAAG,EAAE,GAAG,cAAc,EAAE,IAAI,MAAM,cAAc,CAAC,cAAc,CAAC,CAAC,EAAE,GAAG,cAAc;AAElI,QAAA,OAAO,uBAAiF;AAC1F,IAAA,CAAC;AACH;AAEA,MAAM,sBAAsB,GAC1B,CAAC,YAAsC,KACvC,CAAC,KAAK,KAAI;IACR,IAAI,CAAC,KAAK,CAAC,MAAM;AAAE,QAAA,OAAO,OAAO,CAAC,OAAO,CAAC,SAAS,CAAC;AACpD,IAAA,OAAO,OAAO,CAAC,OAAO,CAAC,IAAIG,SAAI,CAAC,KAAK,CAAC,MAAM,EAAE,YAAY,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC;AAC3E,CAAC;;;;"}

package/subscriptions/context.mjs

@@ -1,13 +1,14 @@
 import { pick } from 'es-toolkit/compat';
 import { User } from '../User.mjs';
 import { buildConnectRequestInfo } from '../request-info.mjs';
-import { extractTokenFromConnectionParams } from './utils.mjs';
+import { defaultExtractSubscriptionToken } from './utils.mjs';
 
 const createSubscriptionContextFactory = (config) => {
     const { requestLogger, augmentRequestInfo, claimsToLog, requestInfoToLog, augmentContext } = config;
     // The conditional type on CreateSubscriptionContextConfig guarantees `createUser` is provided
     // when TUser is narrower than `User | undefined`, so defaulting is sound here.
-    const createUser = (config.createUser ?? defaultCreateUser);
+    const createUser = (config.createUser ??
+        buildDefaultCreateUser(config.extractToken ?? defaultExtractSubscriptionToken));
     return async (input) => {
         const { connectRequest: req, claims } = input;
         // build request info from the connect request and socket
@@ -42,11 +43,10 @@ const createSubscriptionContextFactory = (config) => {
         return augmentedGraphQLContext;
     };
 };
-const defaultCreateUser = ({ claims, connectionParams }) => {
-    if (!claims)
+const buildDefaultCreateUser = (extractToken) => (input) => {
+    if (!input.claims)
         return Promise.resolve(undefined);
-    const accessToken = extractTokenFromConnectionParams(connectionParams);
-    return Promise.resolve(new User(claims, accessToken ?? ''));
+    return Promise.resolve(new User(input.claims, extractToken(input) ?? ''));
 };
 
 export { createSubscriptionContextFactory };

package/subscriptions/context.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"context.mjs","sources":["../../src/subscriptions/context.ts"],"sourcesContent":["import type { Logger } from '@makerx/node-common'\nimport { pick } from 'es-toolkit/compat'\nimport type { IncomingMessage } from 'http'\nimport { User } from '../User'\nimport type { CreateRequestLogger, GraphQLContext, JwtPayload, RequestInfo, RequestInfoLogKey } from '../context'\nimport { buildConnectRequestInfo } from '../request-info'\nimport { extractTokenFromConnectionParams } from './utils'\n\nexport interface SubscriptionContextInput {\n  connectRequest: IncomingMessage\n  connectionParams?: Readonly<Record<string, unknown>>\n  claims?: JwtPayload\n}\n\nexport type CreateSubscriptionUser<T = User | undefined> = (input: SubscriptionContextInput) => Promise<T> | T\nexport type CreateSubscriptionContext<TContext = GraphQLContext> = (input: SubscriptionContextInput) => Promise<TContext>\nexport type AugmentSubscriptionRequestInfo = (input: SubscriptionContextInput) => Record<string, unknown>\n\n// `createUser` is optional when TUser is compatible with the default `User | undefined`\n// (i.e. defaultCreateUser can satisfy it), and required when TUser is narrower.\nexport type CreateSubscriptionContextConfig<\n  TUser = User | undefined,\n  TAugment extends Record<string, unknown> = Record<string, never>,\n  TLogger extends Logger = Logger,\n> = {\n  requestLogger: CreateRequestLogger<TUser, TLogger> | TLogger\n  augmentRequestInfo?: AugmentSubscriptionRequestInfo\n  claimsToLog?: string[]\n  requestInfoToLog?: Array<RequestInfoLogKey>\n  augmentContext?: (context: GraphQLContext<TLogger, RequestInfo, TUser>) => TAugment | Promise<TAugment>\n} & ([User | undefined] extends [TUser] ? { createUser?: CreateSubscriptionUser<TUser> } : { createUser: CreateSubscriptionUser<TUser> })\n\nexport const createSubscriptionContextFactory = <\n  TUser = User | undefined,\n  TAugment extends Record<string, unknown> = Record<string, never>,\n  TLogger extends Logger = Logger,\n>(\n  config: CreateSubscriptionContextConfig<TUser, TAugment, TLogger>,\n): CreateSubscriptionContext<GraphQLContext<TLogger, RequestInfo, TUser> & TAugment> => {\n  const { requestLogger, augmentRequestInfo, claimsToLog, requestInfoToLog, augmentContext } = config\n  // The conditional type on CreateSubscriptionContextConfig guarantees `createUser` is provided\n  // when TUser is narrower than `User | undefined`, so defaulting is sound here.\n  const createUser = (config.createUser ?? defaultCreateUser) as CreateSubscriptionUser<TUser>\n\n  return async (input: SubscriptionContextInput) => {\n    const { connectRequest: req, claims } = input\n\n    // build request info from the connect request and socket\n    const requestInfo: RequestInfo = {\n      ...buildConnectRequestInfo(req),\n      ...augmentRequestInfo?.(input),\n    }\n\n    const user = await createUser(input)\n\n    // create request logger\n    let logger: TLogger\n    if (typeof requestLogger === 'function') {\n      // build request logger metadata\n      const requestLoggerMetadata: Record<string, unknown> = {}\n      // add request info to log\n      if (requestInfoToLog?.length) requestLoggerMetadata.request = pick(requestInfo, requestInfoToLog)\n      // add user claims to log\n      if (claims && claimsToLog?.length) requestLoggerMetadata.user = pick(claims, claimsToLog)\n      // build the request logger\n      logger = requestLogger(requestLoggerMetadata, user)\n    } else logger = requestLogger\n\n    const graphqlContext: GraphQLContext<TLogger, RequestInfo, TUser> = {\n      requestInfo,\n      logger,\n      user,\n      started: Date.now(),\n    }\n\n    const augmentedGraphQLContext = augmentContext ? { ...graphqlContext, ...(await augmentContext(graphqlContext)) } : graphqlContext\n\n    return augmentedGraphQLContext as GraphQLContext<TLogger, RequestInfo, TUser> & TAugment\n  }\n}\n\nconst defaultCreateUser: CreateSubscriptionUser<User | undefined> = ({ claims, connectionParams }) => {\n  if (!claims) return Promise.resolve(undefined)\n  const accessToken = extractTokenFromConnectionParams(connectionParams)\n  return Promise.resolve(new User(claims, accessToken ?? ''))\n}\n"],"names":[],"mappings":";;;;;AAgCO,MAAM,gCAAgC,GAAG,CAK9C,MAAiE,KACoB;AACrF,IAAA,MAAM,EAAE,aAAa,EAAE,kBAAkB,EAAE,WAAW,EAAE,gBAAgB,EAAE,cAAc,EAAE,GAAG,MAAM;;;IAGnG,MAAM,UAAU,IAAI,MAAM,CAAC,UAAU,IAAI,iBAAiB,CAAkC;AAE5F,IAAA,OAAO,OAAO,KAA+B,KAAI;QAC/C,MAAM,EAAE,cAAc,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,KAAK;;AAG7C,QAAA,MAAM,WAAW,GAAgB;YAC/B,GAAG,uBAAuB,CAAC,GAAG,CAAC;AAC/B,YAAA,GAAG,kBAAkB,GAAG,KAAK,CAAC;SAC/B;AAED,QAAA,MAAM,IAAI,GAAG,MAAM,UAAU,CAAC,KAAK,CAAC;;AAGpC,QAAA,IAAI,MAAe;AACnB,QAAA,IAAI,OAAO,aAAa,KAAK,UAAU,EAAE;;YAEvC,MAAM,qBAAqB,GAA4B,EAAE;;YAEzD,IAAI,gBAAgB,EAAE,MAAM;gBAAE,qBAAqB,CAAC,OAAO,GAAG,IAAI,CAAC,WAAW,EAAE,gBAAgB,CAAC;;AAEjG,YAAA,IAAI,MAAM,IAAI,WAAW,EAAE,MAAM;gBAAE,qBAAqB,CAAC,IAAI,GAAG,IAAI,CAAC,MAAM,EAAE,WAAW,CAAC;;AAEzF,YAAA,MAAM,GAAG,aAAa,CAAC,qBAAqB,EAAE,IAAI,CAAC;QACrD;;YAAO,MAAM,GAAG,aAAa;AAE7B,QAAA,MAAM,cAAc,GAAgD;YAClE,WAAW;YACX,MAAM;YACN,IAAI;AACJ,YAAA,OAAO,EAAE,IAAI,CAAC,GAAG,EAAE;SACpB;QAED,MAAM,uBAAuB,GAAG,cAAc,GAAG,EAAE,GAAG,cAAc,EAAE,IAAI,MAAM,cAAc,CAAC,cAAc,CAAC,CAAC,EAAE,GAAG,cAAc;AAElI,QAAA,OAAO,uBAAiF;AAC1F,IAAA,CAAC;AACH;AAEA,MAAM,iBAAiB,GAA6C,CAAC,EAAE,MAAM,EAAE,gBAAgB,EAAE,KAAI;AACnG,IAAA,IAAI,CAAC,MAAM;AAAE,QAAA,OAAO,OAAO,CAAC,OAAO,CAAC,SAAS,CAAC;AAC9C,IAAA,MAAM,WAAW,GAAG,gCAAgC,CAAC,gBAAgB,CAAC;AACtE,IAAA,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,MAAM,EAAE,WAAW,IAAI,EAAE,CAAC,CAAC;AAC7D,CAAC;;;;"}
+{"version":3,"file":"context.mjs","sources":["../../src/subscriptions/context.ts"],"sourcesContent":["import type { Logger } from '@makerx/node-common'\nimport { pick } from 'es-toolkit/compat'\nimport type { IncomingMessage } from 'http'\nimport { User } from '../User'\nimport type { CreateRequestLogger, GraphQLContext, JwtPayload, RequestInfo, RequestInfoLogKey } from '../context'\nimport { buildConnectRequestInfo } from '../request-info'\nimport { defaultExtractSubscriptionToken } from './utils'\n\nexport interface SubscriptionContextInput {\n  connectRequest: IncomingMessage\n  connectionParams?: Readonly<Record<string, unknown>>\n  claims?: JwtPayload\n}\n\nexport type CreateSubscriptionUser<T = User | undefined> = (input: SubscriptionContextInput) => Promise<T> | T\nexport type CreateSubscriptionContext<TContext = GraphQLContext> = (input: SubscriptionContextInput) => Promise<TContext>\nexport type AugmentSubscriptionRequestInfo = (input: SubscriptionContextInput) => Record<string, unknown>\n// The token is extracted before the connection is authenticated, so the input has no claims.\nexport type ExtractSubscriptionToken = (input: Omit<SubscriptionContextInput, 'claims'>) => string | undefined\n\n// `createUser` is optional when TUser is compatible with the default `User | undefined`\n// (i.e. defaultCreateUser can satisfy it), and required when TUser is narrower.\nexport type CreateSubscriptionContextConfig<\n  TUser = User | undefined,\n  TAugment extends Record<string, unknown> = Record<string, never>,\n  TLogger extends Logger = Logger,\n> = {\n  requestLogger: CreateRequestLogger<TUser, TLogger> | TLogger\n  augmentRequestInfo?: AugmentSubscriptionRequestInfo\n  claimsToLog?: string[]\n  requestInfoToLog?: Array<RequestInfoLogKey>\n  augmentContext?: (context: GraphQLContext<TLogger, RequestInfo, TUser>) => TAugment | Promise<TAugment>\n  /**\n   * Returns the token that the default `createUser` sets as `User.token`. Use the same function as\n   * the `useSubscriptionsServer` `extractToken` option. Not called when you supply `createUser`.\n   * Defaults to the bearer token in the `authorization` or `Authorization` connection parameter.\n   */\n  extractToken?: ExtractSubscriptionToken\n} & ([User | undefined] extends [TUser] ? { createUser?: CreateSubscriptionUser<TUser> } : { createUser: CreateSubscriptionUser<TUser> })\n\nexport const createSubscriptionContextFactory = <\n  TUser = User | undefined,\n  TAugment extends Record<string, unknown> = Record<string, never>,\n  TLogger extends Logger = Logger,\n>(\n  config: CreateSubscriptionContextConfig<TUser, TAugment, TLogger>,\n): CreateSubscriptionContext<GraphQLContext<TLogger, RequestInfo, TUser> & TAugment> => {\n  const { requestLogger, augmentRequestInfo, claimsToLog, requestInfoToLog, augmentContext } = config\n  // The conditional type on CreateSubscriptionContextConfig guarantees `createUser` is provided\n  // when TUser is narrower than `User | undefined`, so defaulting is sound here.\n  const createUser = (config.createUser ??\n    buildDefaultCreateUser(config.extractToken ?? defaultExtractSubscriptionToken)) as CreateSubscriptionUser<TUser>\n\n  return async (input: SubscriptionContextInput) => {\n    const { connectRequest: req, claims } = input\n\n    // build request info from the connect request and socket\n    const requestInfo: RequestInfo = {\n      ...buildConnectRequestInfo(req),\n      ...augmentRequestInfo?.(input),\n    }\n\n    const user = await createUser(input)\n\n    // create request logger\n    let logger: TLogger\n    if (typeof requestLogger === 'function') {\n      // build request logger metadata\n      const requestLoggerMetadata: Record<string, unknown> = {}\n      // add request info to log\n      if (requestInfoToLog?.length) requestLoggerMetadata.request = pick(requestInfo, requestInfoToLog)\n      // add user claims to log\n      if (claims && claimsToLog?.length) requestLoggerMetadata.user = pick(claims, claimsToLog)\n      // build the request logger\n      logger = requestLogger(requestLoggerMetadata, user)\n    } else logger = requestLogger\n\n    const graphqlContext: GraphQLContext<TLogger, RequestInfo, TUser> = {\n      requestInfo,\n      logger,\n      user,\n      started: Date.now(),\n    }\n\n    const augmentedGraphQLContext = augmentContext ? { ...graphqlContext, ...(await augmentContext(graphqlContext)) } : graphqlContext\n\n    return augmentedGraphQLContext as GraphQLContext<TLogger, RequestInfo, TUser> & TAugment\n  }\n}\n\nconst buildDefaultCreateUser =\n  (extractToken: ExtractSubscriptionToken): CreateSubscriptionUser<User | undefined> =>\n  (input) => {\n    if (!input.claims) return Promise.resolve(undefined)\n    return Promise.resolve(new User(input.claims, extractToken(input) ?? ''))\n  }\n"],"names":[],"mappings":";;;;;AAwCO,MAAM,gCAAgC,GAAG,CAK9C,MAAiE,KACoB;AACrF,IAAA,MAAM,EAAE,aAAa,EAAE,kBAAkB,EAAE,WAAW,EAAE,gBAAgB,EAAE,cAAc,EAAE,GAAG,MAAM;;;AAGnG,IAAA,MAAM,UAAU,IAAI,MAAM,CAAC,UAAU;QACnC,sBAAsB,CAAC,MAAM,CAAC,YAAY,IAAI,+BAA+B,CAAC,CAAkC;AAElH,IAAA,OAAO,OAAO,KAA+B,KAAI;QAC/C,MAAM,EAAE,cAAc,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,KAAK;;AAG7C,QAAA,MAAM,WAAW,GAAgB;YAC/B,GAAG,uBAAuB,CAAC,GAAG,CAAC;AAC/B,YAAA,GAAG,kBAAkB,GAAG,KAAK,CAAC;SAC/B;AAED,QAAA,MAAM,IAAI,GAAG,MAAM,UAAU,CAAC,KAAK,CAAC;;AAGpC,QAAA,IAAI,MAAe;AACnB,QAAA,IAAI,OAAO,aAAa,KAAK,UAAU,EAAE;;YAEvC,MAAM,qBAAqB,GAA4B,EAAE;;YAEzD,IAAI,gBAAgB,EAAE,MAAM;gBAAE,qBAAqB,CAAC,OAAO,GAAG,IAAI,CAAC,WAAW,EAAE,gBAAgB,CAAC;;AAEjG,YAAA,IAAI,MAAM,IAAI,WAAW,EAAE,MAAM;gBAAE,qBAAqB,CAAC,IAAI,GAAG,IAAI,CAAC,MAAM,EAAE,WAAW,CAAC;;AAEzF,YAAA,MAAM,GAAG,aAAa,CAAC,qBAAqB,EAAE,IAAI,CAAC;QACrD;;YAAO,MAAM,GAAG,aAAa;AAE7B,QAAA,MAAM,cAAc,GAAgD;YAClE,WAAW;YACX,MAAM;YACN,IAAI;AACJ,YAAA,OAAO,EAAE,IAAI,CAAC,GAAG,EAAE;SACpB;QAED,MAAM,uBAAuB,GAAG,cAAc,GAAG,EAAE,GAAG,cAAc,EAAE,IAAI,MAAM,cAAc,CAAC,cAAc,CAAC,CAAC,EAAE,GAAG,cAAc;AAElI,QAAA,OAAO,uBAAiF;AAC1F,IAAA,CAAC;AACH;AAEA,MAAM,sBAAsB,GAC1B,CAAC,YAAsC,KACvC,CAAC,KAAK,KAAI;IACR,IAAI,CAAC,KAAK,CAAC,MAAM;AAAE,QAAA,OAAO,OAAO,CAAC,OAAO,CAAC,SAAS,CAAC;AACpD,IAAA,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,YAAY,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC;AAC3E,CAAC;;;;"}

package/subscriptions/server.d.cts

@@ -2,8 +2,8 @@ import type { Logger } from '@makerx/node-common';
 import type { GraphQLSchema } from 'graphql';
 import type { Server } from 'http';
 import type { GraphQLContext, JwtPayload } from '../context';
-import type { CreateSubscriptionContext } from './context';
-export declare function useSubscriptionsServer<TLogger extends Logger = Logger>({ schema, httpServer, createSubscriptionContext, logger, operationLogLevel, path, verifyToken, requireAuth, jwtClaimsToLog, resolveSubscriptionOperationLogger, }: {
+import type { CreateSubscriptionContext, ExtractSubscriptionToken } from './context';
+export declare function useSubscriptionsServer<TLogger extends Logger = Logger>({ schema, httpServer, createSubscriptionContext, logger, operationLogLevel, path, verifyToken, extractToken, requireAuth, jwtClaimsToLog, resolveSubscriptionOperationLogger, includeDeprecatedElements, }: {
     schema: GraphQLSchema;
     httpServer: Server;
     createSubscriptionContext: CreateSubscriptionContext;
@@ -11,7 +11,18 @@ export declare function useSubscriptionsServer<TLogger extends Logger = Logger>(
     operationLogLevel?: keyof TLogger;
     path?: string;
     verifyToken?: (host: string, token: string) => Promise<JwtPayload>;
+    /**
+     * Returns the token to pass to `verifyToken`, e.g. from a JWT assertion header that a proxy adds
+     * to the connect request. Defaults to the bearer token in the `authorization` or `Authorization`
+     * connection parameter. Pass the same function to `createSubscriptionContextFactory`.
+     */
+    extractToken?: ExtractSubscriptionToken;
     requireAuth?: boolean;
     jwtClaimsToLog?: string[];
     resolveSubscriptionOperationLogger?: (context: GraphQLContext) => TLogger;
+    /**
+     * If true, deprecated schema elements a subscription uses are collected and logged when it is
+     * established. Not collected per emitted payload: the usage is a property of the operation.
+     */
+    includeDeprecatedElements?: boolean;
 }): import("graphql-ws").Disposable;

package/subscriptions/server.d.mts

@@ -2,8 +2,8 @@ import type { Logger } from '@makerx/node-common';
 import type { GraphQLSchema } from 'graphql';
 import type { Server } from 'http';
 import type { GraphQLContext, JwtPayload } from '../context.mjs';
-import type { CreateSubscriptionContext } from './context.mjs';
-export declare function useSubscriptionsServer<TLogger extends Logger = Logger>({ schema, httpServer, createSubscriptionContext, logger, operationLogLevel, path, verifyToken, requireAuth, jwtClaimsToLog, resolveSubscriptionOperationLogger, }: {
+import type { CreateSubscriptionContext, ExtractSubscriptionToken } from './context.mjs';
+export declare function useSubscriptionsServer<TLogger extends Logger = Logger>({ schema, httpServer, createSubscriptionContext, logger, operationLogLevel, path, verifyToken, extractToken, requireAuth, jwtClaimsToLog, resolveSubscriptionOperationLogger, includeDeprecatedElements, }: {
     schema: GraphQLSchema;
     httpServer: Server;
     createSubscriptionContext: CreateSubscriptionContext;
@@ -11,7 +11,18 @@ export declare function useSubscriptionsServer<TLogger extends Logger = Logger>(
     operationLogLevel?: keyof TLogger;
     path?: string;
     verifyToken?: (host: string, token: string) => Promise<JwtPayload>;
+    /**
+     * Returns the token to pass to `verifyToken`, e.g. from a JWT assertion header that a proxy adds
+     * to the connect request. Defaults to the bearer token in the `authorization` or `Authorization`
+     * connection parameter. Pass the same function to `createSubscriptionContextFactory`.
+     */
+    extractToken?: ExtractSubscriptionToken;
     requireAuth?: boolean;
     jwtClaimsToLog?: string[];
     resolveSubscriptionOperationLogger?: (context: GraphQLContext) => TLogger;
+    /**
+     * If true, deprecated schema elements a subscription uses are collected and logged when it is
+     * established. Not collected per emitted payload: the usage is a property of the operation.
+     */
+    includeDeprecatedElements?: boolean;
 }): import("graphql-ws").Disposable;

package/subscriptions/server.d.ts

@@ -2,8 +2,8 @@ import type { Logger } from '@makerx/node-common';
 import type { GraphQLSchema } from 'graphql';
 import type { Server } from 'http';
 import type { GraphQLContext, JwtPayload } from '../context';
-import type { CreateSubscriptionContext } from './context';
-export declare function useSubscriptionsServer<TLogger extends Logger = Logger>({ schema, httpServer, createSubscriptionContext, logger, operationLogLevel, path, verifyToken, requireAuth, jwtClaimsToLog, resolveSubscriptionOperationLogger, }: {
+import type { CreateSubscriptionContext, ExtractSubscriptionToken } from './context';
+export declare function useSubscriptionsServer<TLogger extends Logger = Logger>({ schema, httpServer, createSubscriptionContext, logger, operationLogLevel, path, verifyToken, extractToken, requireAuth, jwtClaimsToLog, resolveSubscriptionOperationLogger, includeDeprecatedElements, }: {
     schema: GraphQLSchema;
     httpServer: Server;
     createSubscriptionContext: CreateSubscriptionContext;
@@ -11,7 +11,18 @@ export declare function useSubscriptionsServer<TLogger extends Logger = Logger>(
     operationLogLevel?: keyof TLogger;
     path?: string;
     verifyToken?: (host: string, token: string) => Promise<JwtPayload>;
+    /**
+     * Returns the token to pass to `verifyToken`, e.g. from a JWT assertion header that a proxy adds
+     * to the connect request. Defaults to the bearer token in the `authorization` or `Authorization`
+     * connection parameter. Pass the same function to `createSubscriptionContextFactory`.
+     */
+    extractToken?: ExtractSubscriptionToken;
     requireAuth?: boolean;
     jwtClaimsToLog?: string[];
     resolveSubscriptionOperationLogger?: (context: GraphQLContext) => TLogger;
+    /**
+     * If true, deprecated schema elements a subscription uses are collected and logged when it is
+     * established. Not collected per emitted payload: the usage is a property of the operation.
+     */
+    includeDeprecatedElements?: boolean;
 }): import("graphql-ws").Disposable;