@makerx/graphql-core 2.3.0 → 3.0.0-beta.1

package/logging.js

@@ -2,7 +2,7 @@
 
 var nodeCommon = require('@makerx/node-common');
 var graphql = require('graphql');
-var lodash = require('lodash');
+var compat = require('es-toolkit/compat');
 var utils = require('./utils.js');
 
 /**
@@ -13,15 +13,15 @@ const logGraphQLOperation = ({ message = 'GraphQL operation', started, type, ope
     const isIntrospection = query && utils.isIntrospectionQuery(query);
     if (nodeCommon.isLocalDev && isIntrospection)
         return;
-    logger[logLevel](message, lodash.omitBy({
+    logger[logLevel](message, compat.omitBy({
         type,
         operationName,
         query,
         variables: variables && Object.keys(variables).length > 0 ? variables : undefined,
         duration: started ? Date.now() - started : undefined,
-        result: result ? lodash.omitBy(result, utils.isNil) : undefined,
+        result: result ? compat.omitBy(result, utils.isNil) : undefined,
         isIntrospectionQuery: isIntrospection || undefined,
-        ...lodash.omitBy(rest, utils.isNil),
+        ...compat.omitBy(rest, utils.isNil),
     }, utils.isNil));
 };
 const logSubscriptionOperation = ({ args, result, message, logLevel, resolveLogger, }) => {

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 type { ExecutionArgs, GraphQLFormattedError } from 'graphql'\nimport { OperationTypeNode, print } from 'graphql'\nimport type { ExecutionResult } from 'graphql-ws'\nimport { omitBy } from 'lodash'\nimport type { GraphQLContext } from './context'\nimport { isIntrospectionQuery, 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  args,\n  result,\n  message,\n  logLevel,\n  resolveLogger,\n}: {\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    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":";;;;;;;AA0EA;;;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,0BAAoB,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,IAAI,EACJ,MAAM,EACN,OAAO,EACP,QAAQ,EACR,aAAa,GAOd,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;QACpC,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 type { ExecutionArgs, GraphQLFormattedError } from 'graphql'\nimport { OperationTypeNode, print } from 'graphql'\nimport type { ExecutionResult } from 'graphql-ws'\nimport { omitBy } from 'es-toolkit/compat'\nimport type { GraphQLContext } from './context'\nimport { isIntrospectionQuery, 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  args,\n  result,\n  message,\n  logLevel,\n  resolveLogger,\n}: {\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    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":";;;;;;;AA0EA;;;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,0BAAoB,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,IAAI,EACJ,MAAM,EACN,OAAO,EACP,QAAQ,EACR,aAAa,GAOd,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;QACpC,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;;;;;"}

package/logging.mjs

@@ -1,6 +1,6 @@
 import { isLocalDev } from '@makerx/node-common';
 import { print, OperationTypeNode } from 'graphql';
-import { omitBy } from 'lodash';
+import { omitBy } from 'es-toolkit/compat';
 import { isIntrospectionQuery, isNil } from './utils.mjs';
 
 /**

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 type { ExecutionArgs, GraphQLFormattedError } from 'graphql'\nimport { OperationTypeNode, print } from 'graphql'\nimport type { ExecutionResult } from 'graphql-ws'\nimport { omitBy } from 'lodash'\nimport type { GraphQLContext } from './context'\nimport { isIntrospectionQuery, 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  args,\n  result,\n  message,\n  logLevel,\n  resolveLogger,\n}: {\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    operationName,\n    query: print(document),\n    variables: variableValues,\n    result: resultWithoutData,\n    logger,\n    logLevel,\n  })\n}\n"],"names":[],"mappings":";;;;;AA0EA;;;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,IAAI,EACJ,MAAM,EACN,OAAO,EACP,QAAQ,EACR,aAAa,GAOd,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;QACpC,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 type { ExecutionArgs, GraphQLFormattedError } from 'graphql'\nimport { OperationTypeNode, print } from 'graphql'\nimport type { ExecutionResult } from 'graphql-ws'\nimport { omitBy } from 'es-toolkit/compat'\nimport type { GraphQLContext } from './context'\nimport { isIntrospectionQuery, 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  args,\n  result,\n  message,\n  logLevel,\n  resolveLogger,\n}: {\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    operationName,\n    query: print(document),\n    variables: variableValues,\n    result: resultWithoutData,\n    logger,\n    logLevel,\n  })\n}\n"],"names":[],"mappings":";;;;;AA0EA;;;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,IAAI,EACJ,MAAM,EACN,OAAO,EACP,QAAQ,EACR,aAAa,GAOd,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;QACpC,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;;;;"}

package/package.json

@@ -4,7 +4,7 @@
     "**"
   ],
   "name": "@makerx/graphql-core",
-  "version": "2.3.0",
+  "version": "3.0.0-beta.1",
   "private": false,
   "description": "A set of core GraphQL utilities that MakerX uses to build GraphQL APIs",
   "author": "MakerX",
@@ -24,18 +24,14 @@
     "@makerx/node-common": "^1.5.0"
   },
   "peerDependencies": {
-    "@apollo/client": "*",
+    "es-toolkit": ">=1",
     "express": "*",
     "graphql": "*",
     "graphql-shield": "*",
     "graphql-ws": "*",
-    "lodash": "*",
     "ws": "*"
   },
   "peerDependenciesMeta": {
-    "@apollo/client": {
-      "optional": true
-    },
     "graphql-ws": {
       "optional": true
     },
@@ -53,10 +49,10 @@
       "import": "./index.mjs",
       "require": "./index.js"
     },
-    "./testing": {
-      "types": "./testing.d.ts",
-      "import": "./testing.mjs",
-      "require": "./testing.js"
+    "./shield": {
+      "types": "./shield.d.ts",
+      "import": "./shield.mjs",
+      "require": "./shield.js"
     },
     "./subscriptions": {
       "types": "./subscriptions/index.d.ts",

package/request-info.d.ts

@@ -0,0 +1,38 @@
+import type { Request } from 'express';
+import type { IncomingMessage } from 'http';
+export interface BaseRequestInfo extends Record<string, unknown> {
+    requestId: string;
+    source: 'http' | 'subscription';
+    protocol: 'http' | 'https' | 'ws' | 'wss';
+    host: string;
+    port?: number;
+    method: string;
+    baseUrl: string;
+    url: string;
+    origin: string;
+    referer?: string;
+    correlationId?: string;
+    arrLogId?: string;
+    clientIp?: string;
+    userAgent?: string;
+}
+/**
+ * Builds the base URL (`protocol://host[:port]`) for an Express HTTP request, using the request's
+ * protocol and resolving the host/port from forwarding headers with the Express hostname as fallback.
+ * The port is omitted when it matches the default for the protocol (80 for http, 443 for https).
+ * @param req The Express request.
+ * @returns The base URL string.
+ */
+export declare const requestBaseUrl: (req: Request) => string;
+/**
+ * Builds the base URL (`http(s)://host[:port]`) for a raw WebSocket upgrade (connect) request.
+ * Returns an `https` URL when the connection is TLS-encrypted or `x-forwarded-proto` indicates a
+ * secure scheme, otherwise `http`. Throws if no host can be determined from the request headers,
+ * since upgrade requests have no Express `hostname` fallback.
+ * @param req The incoming upgrade request.
+ * @returns The base URL string.
+ * @throws Error when the host cannot be resolved from the request.
+ */
+export declare const connectRequestBaseUrl: (req: IncomingMessage) => string;
+export declare const buildBaseRequestInfo: (req: Request) => BaseRequestInfo;
+export declare const buildConnectRequestInfo: (req: IncomingMessage) => BaseRequestInfo;

package/request-info.js

@@ -0,0 +1,101 @@
+'use strict';
+
+var crypto = require('crypto');
+
+const isDefaultPort = (protocol, port) => port == null || (protocol === 'http' && port === 80) || (protocol === 'https' && port === 443);
+const formatBaseUrl = (protocol, hostname, port) => isDefaultPort(protocol, port) ? `${protocol}://${hostname}` : `${protocol}://${hostname}:${port}`;
+const firstHeaderValue = (value) => {
+    const raw = Array.isArray(value) ? value[0] : value;
+    return raw?.split(',')[0]?.trim() || undefined;
+};
+const parseHostHeader = (hostHeader) => {
+    const url = new URL(`http://${hostHeader}`);
+    return { hostname: url.hostname, port: url.port ? Number(url.port) : undefined };
+};
+const isEncryptedSocket = (req) => 'encrypted' in req.socket && req.socket.encrypted === true;
+const isEncryptedConnect = (req) => {
+    const forwarded = firstHeaderValue(req.headers['x-forwarded-proto'])?.toLowerCase();
+    if (forwarded === 'https' || forwarded === 'wss')
+        return true;
+    if (forwarded === 'http' || forwarded === 'ws')
+        return false;
+    return isEncryptedSocket(req);
+};
+const resolveForwardedHost = (req) => firstHeaderValue(req.headers['x-forwarded-host']);
+const resolveHostAndPort = (req, fallbackHostname) => {
+    const headerValue = resolveForwardedHost(req) ?? req.headers.host;
+    if (headerValue) {
+        const { hostname, port } = parseHostHeader(headerValue);
+        return { host: hostname, port };
+    }
+    return { host: fallbackHostname ?? '', port: undefined };
+};
+/**
+ * Builds the base URL (`protocol://host[:port]`) for an Express HTTP request, using the request's
+ * protocol and resolving the host/port from forwarding headers with the Express hostname as fallback.
+ * The port is omitted when it matches the default for the protocol (80 for http, 443 for https).
+ * @param req The Express request.
+ * @returns The base URL string.
+ */
+const requestBaseUrl = (req) => {
+    const { host, port } = resolveHostAndPort(req, req.hostname);
+    return formatBaseUrl(req.protocol, host, port);
+};
+/**
+ * Builds the base URL (`http(s)://host[:port]`) for a raw WebSocket upgrade (connect) request.
+ * Returns an `https` URL when the connection is TLS-encrypted or `x-forwarded-proto` indicates a
+ * secure scheme, otherwise `http`. Throws if no host can be determined from the request headers,
+ * since upgrade requests have no Express `hostname` fallback.
+ * @param req The incoming upgrade request.
+ * @returns The base URL string.
+ * @throws Error when the host cannot be resolved from the request.
+ */
+const connectRequestBaseUrl = (req) => {
+    const { host, port } = resolveHostAndPort(req);
+    if (!host)
+        throw new Error('Cannot determine base URL from websocket connect request');
+    return formatBaseUrl(isEncryptedConnect(req) ? 'https' : 'http', host, port);
+};
+const buildSharedRequestInfo = (req) => ({
+    requestId: req.headers['x-request-id']?.toString() ?? crypto.randomUUID(),
+    method: req.method ?? '',
+    origin: req.headers.origin ?? '',
+    referer: req.headers.referer?.toString() ?? '',
+    arrLogId: req.headers['x-arr-log-id']?.toString() ?? undefined,
+    clientIp: firstHeaderValue(req.headers['x-forwarded-for']) ?? req.socket.remoteAddress,
+    correlationId: req.headers['x-correlation-id']?.toString() ?? undefined,
+    userAgent: req.headers['user-agent']?.toString() ?? undefined,
+});
+const buildBaseRequestInfo = (req) => {
+    const { host, port } = resolveHostAndPort(req, req.hostname);
+    return {
+        ...buildSharedRequestInfo(req),
+        source: 'http',
+        protocol: req.protocol,
+        host,
+        port,
+        baseUrl: formatBaseUrl(req.protocol, host, port),
+        url: req.originalUrl,
+    };
+};
+const buildConnectRequestInfo = (req) => {
+    const { host, port } = resolveHostAndPort(req);
+    const protocol = isEncryptedConnect(req) ? 'wss' : 'ws';
+    if (!host)
+        throw new Error('Cannot determine base URL from websocket connect request');
+    return {
+        ...buildSharedRequestInfo(req),
+        source: 'subscription',
+        protocol,
+        host,
+        port,
+        baseUrl: formatBaseUrl(protocol === 'wss' ? 'https' : 'http', host, port),
+        url: req.url ?? '',
+    };
+};
+
+exports.buildBaseRequestInfo = buildBaseRequestInfo;
+exports.buildConnectRequestInfo = buildConnectRequestInfo;
+exports.connectRequestBaseUrl = connectRequestBaseUrl;
+exports.requestBaseUrl = requestBaseUrl;
+//# sourceMappingURL=request-info.js.map

package/request-info.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"request-info.js","sources":["../src/request-info.ts"],"sourcesContent":["import { randomUUID } from 'crypto'\nimport type { Request } from 'express'\nimport type { IncomingMessage } from 'http'\nimport type { TLSSocket } from 'tls'\n\nexport interface BaseRequestInfo extends Record<string, unknown> {\n  requestId: string\n  source: 'http' | 'subscription'\n  protocol: 'http' | 'https' | 'ws' | 'wss'\n  host: string\n  port?: number\n  method: string\n  baseUrl: string\n  url: string\n  origin: string\n  referer?: string\n  correlationId?: string\n  arrLogId?: string\n  clientIp?: string\n  userAgent?: string\n}\n\nconst isDefaultPort = (protocol: string, port: number | undefined): boolean =>\n  port == null || (protocol === 'http' && port === 80) || (protocol === 'https' && port === 443)\n\nconst formatBaseUrl = (protocol: string, hostname: string, port: number | undefined): string =>\n  isDefaultPort(protocol, port) ? `${protocol}://${hostname}` : `${protocol}://${hostname}:${port}`\n\nconst firstHeaderValue = (value: string | string[] | undefined): string | undefined => {\n  const raw = Array.isArray(value) ? value[0] : value\n  return raw?.split(',')[0]?.trim() || undefined\n}\n\nconst parseHostHeader = (hostHeader: string): { hostname: string; port: number | undefined } => {\n  const url = new URL(`http://${hostHeader}`)\n  return { hostname: url.hostname, port: url.port ? Number(url.port) : undefined }\n}\n\nconst isEncryptedSocket = (req: IncomingMessage): boolean => 'encrypted' in req.socket && (req.socket as TLSSocket).encrypted === true\n\nconst isEncryptedConnect = (req: IncomingMessage): boolean => {\n  const forwarded = firstHeaderValue(req.headers['x-forwarded-proto'])?.toLowerCase()\n  if (forwarded === 'https' || forwarded === 'wss') return true\n  if (forwarded === 'http' || forwarded === 'ws') return false\n  return isEncryptedSocket(req)\n}\n\nconst resolveForwardedHost = (req: IncomingMessage): string | undefined => firstHeaderValue(req.headers['x-forwarded-host'])\n\nconst resolveHostAndPort = (req: IncomingMessage, fallbackHostname?: string): { host: string; port: number | undefined } => {\n  const headerValue = resolveForwardedHost(req) ?? req.headers.host\n  if (headerValue) {\n    const { hostname, port } = parseHostHeader(headerValue)\n    return { host: hostname, port }\n  }\n  return { host: fallbackHostname ?? '', port: undefined }\n}\n\n/**\n * Builds the base URL (`protocol://host[:port]`) for an Express HTTP request, using the request's\n * protocol and resolving the host/port from forwarding headers with the Express hostname as fallback.\n * The port is omitted when it matches the default for the protocol (80 for http, 443 for https).\n * @param req The Express request.\n * @returns The base URL string.\n */\nexport const requestBaseUrl = (req: Request): string => {\n  const { host, port } = resolveHostAndPort(req, req.hostname)\n  return formatBaseUrl(req.protocol, host, port)\n}\n\n/**\n * Builds the base URL (`http(s)://host[:port]`) for a raw WebSocket upgrade (connect) request.\n * Returns an `https` URL when the connection is TLS-encrypted or `x-forwarded-proto` indicates a\n * secure scheme, otherwise `http`. Throws if no host can be determined from the request headers,\n * since upgrade requests have no Express `hostname` fallback.\n * @param req The incoming upgrade request.\n * @returns The base URL string.\n * @throws Error when the host cannot be resolved from the request.\n */\nexport const connectRequestBaseUrl = (req: IncomingMessage): string => {\n  const { host, port } = resolveHostAndPort(req)\n  if (!host) throw new Error('Cannot determine base URL from websocket connect request')\n  return formatBaseUrl(isEncryptedConnect(req) ? 'https' : 'http', host, port)\n}\n\nconst buildSharedRequestInfo = (req: IncomingMessage) => ({\n  requestId: req.headers['x-request-id']?.toString() ?? randomUUID(),\n  method: req.method ?? '',\n  origin: req.headers.origin ?? '',\n  referer: req.headers.referer?.toString() ?? '',\n  arrLogId: req.headers['x-arr-log-id']?.toString() ?? undefined,\n  clientIp: firstHeaderValue(req.headers['x-forwarded-for']) ?? req.socket.remoteAddress,\n  correlationId: req.headers['x-correlation-id']?.toString() ?? undefined,\n  userAgent: req.headers['user-agent']?.toString() ?? undefined,\n})\n\nexport const buildBaseRequestInfo = (req: Request): BaseRequestInfo => {\n  const { host, port } = resolveHostAndPort(req, req.hostname)\n  return {\n    ...buildSharedRequestInfo(req),\n    source: 'http',\n    protocol: req.protocol as 'http' | 'https',\n    host,\n    port,\n    baseUrl: formatBaseUrl(req.protocol, host, port),\n    url: req.originalUrl,\n  }\n}\n\nexport const buildConnectRequestInfo = (req: IncomingMessage): BaseRequestInfo => {\n  const { host, port } = resolveHostAndPort(req)\n  const protocol = isEncryptedConnect(req) ? 'wss' : 'ws'\n  if (!host) throw new Error('Cannot determine base URL from websocket connect request')\n  return {\n    ...buildSharedRequestInfo(req),\n    source: 'subscription',\n    protocol,\n    host,\n    port,\n    baseUrl: formatBaseUrl(protocol === 'wss' ? 'https' : 'http', host, port),\n    url: req.url ?? '',\n  }\n}\n"],"names":["randomUUID"],"mappings":";;;;AAsBA,MAAM,aAAa,GAAG,CAAC,QAAgB,EAAE,IAAwB,KAC/D,IAAI,IAAI,IAAI,KAAK,QAAQ,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC,KAAK,QAAQ,KAAK,OAAO,IAAI,IAAI,KAAK,GAAG,CAAC;AAEhG,MAAM,aAAa,GAAG,CAAC,QAAgB,EAAE,QAAgB,EAAE,IAAwB,KACjF,aAAa,CAAC,QAAQ,EAAE,IAAI,CAAC,GAAG,CAAA,EAAG,QAAQ,CAAA,GAAA,EAAM,QAAQ,EAAE,GAAG,CAAA,EAAG,QAAQ,CAAA,GAAA,EAAM,QAAQ,CAAA,CAAA,EAAI,IAAI,EAAE;AAEnG,MAAM,gBAAgB,GAAG,CAAC,KAAoC,KAAwB;AACpF,IAAA,MAAM,GAAG,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,GAAG,KAAK;AACnD,IAAA,OAAO,GAAG,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,SAAS;AAChD,CAAC;AAED,MAAM,eAAe,GAAG,CAAC,UAAkB,KAAoD;IAC7F,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,CAAA,OAAA,EAAU,UAAU,CAAA,CAAE,CAAC;IAC3C,OAAO,EAAE,QAAQ,EAAE,GAAG,CAAC,QAAQ,EAAE,IAAI,EAAE,GAAG,CAAC,IAAI,GAAG,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,SAAS,EAAE;AAClF,CAAC;AAED,MAAM,iBAAiB,GAAG,CAAC,GAAoB,KAAc,WAAW,IAAI,GAAG,CAAC,MAAM,IAAK,GAAG,CAAC,MAAoB,CAAC,SAAS,KAAK,IAAI;AAEtI,MAAM,kBAAkB,GAAG,CAAC,GAAoB,KAAa;AAC3D,IAAA,MAAM,SAAS,GAAG,gBAAgB,CAAC,GAAG,CAAC,OAAO,CAAC,mBAAmB,CAAC,CAAC,EAAE,WAAW,EAAE;AACnF,IAAA,IAAI,SAAS,KAAK,OAAO,IAAI,SAAS,KAAK,KAAK;AAAE,QAAA,OAAO,IAAI;AAC7D,IAAA,IAAI,SAAS,KAAK,MAAM,IAAI,SAAS,KAAK,IAAI;AAAE,QAAA,OAAO,KAAK;AAC5D,IAAA,OAAO,iBAAiB,CAAC,GAAG,CAAC;AAC/B,CAAC;AAED,MAAM,oBAAoB,GAAG,CAAC,GAAoB,KAAyB,gBAAgB,CAAC,GAAG,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;AAE5H,MAAM,kBAAkB,GAAG,CAAC,GAAoB,EAAE,gBAAyB,KAAgD;AACzH,IAAA,MAAM,WAAW,GAAG,oBAAoB,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,OAAO,CAAC,IAAI;IACjE,IAAI,WAAW,EAAE;QACf,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,GAAG,eAAe,CAAC,WAAW,CAAC;AACvD,QAAA,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE;IACjC;IACA,OAAO,EAAE,IAAI,EAAE,gBAAgB,IAAI,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;AAC1D,CAAC;AAED;;;;;;AAMG;AACI,MAAM,cAAc,GAAG,CAAC,GAAY,KAAY;AACrD,IAAA,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,kBAAkB,CAAC,GAAG,EAAE,GAAG,CAAC,QAAQ,CAAC;IAC5D,OAAO,aAAa,CAAC,GAAG,CAAC,QAAQ,EAAE,IAAI,EAAE,IAAI,CAAC;AAChD;AAEA;;;;;;;;AAQG;AACI,MAAM,qBAAqB,GAAG,CAAC,GAAoB,KAAY;IACpE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,kBAAkB,CAAC,GAAG,CAAC;AAC9C,IAAA,IAAI,CAAC,IAAI;AAAE,QAAA,MAAM,IAAI,KAAK,CAAC,0DAA0D,CAAC;AACtF,IAAA,OAAO,aAAa,CAAC,kBAAkB,CAAC,GAAG,CAAC,GAAG,OAAO,GAAG,MAAM,EAAE,IAAI,EAAE,IAAI,CAAC;AAC9E;AAEA,MAAM,sBAAsB,GAAG,CAAC,GAAoB,MAAM;AACxD,IAAA,SAAS,EAAE,GAAG,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE,QAAQ,EAAE,IAAIA,iBAAU,EAAE;AAClE,IAAA,MAAM,EAAE,GAAG,CAAC,MAAM,IAAI,EAAE;AACxB,IAAA,MAAM,EAAE,GAAG,CAAC,OAAO,CAAC,MAAM,IAAI,EAAE;IAChC,OAAO,EAAE,GAAG,CAAC,OAAO,CAAC,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE;IAC9C,QAAQ,EAAE,GAAG,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE,QAAQ,EAAE,IAAI,SAAS;AAC9D,IAAA,QAAQ,EAAE,gBAAgB,CAAC,GAAG,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC,IAAI,GAAG,CAAC,MAAM,CAAC,aAAa;IACtF,aAAa,EAAE,GAAG,CAAC,OAAO,CAAC,kBAAkB,CAAC,EAAE,QAAQ,EAAE,IAAI,SAAS;IACvE,SAAS,EAAE,GAAG,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,QAAQ,EAAE,IAAI,SAAS;AAC9D,CAAA,CAAC;AAEK,MAAM,oBAAoB,GAAG,CAAC,GAAY,KAAqB;AACpE,IAAA,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,kBAAkB,CAAC,GAAG,EAAE,GAAG,CAAC,QAAQ,CAAC;IAC5D,OAAO;QACL,GAAG,sBAAsB,CAAC,GAAG,CAAC;AAC9B,QAAA,MAAM,EAAE,MAAM;QACd,QAAQ,EAAE,GAAG,CAAC,QAA4B;QAC1C,IAAI;QACJ,IAAI;QACJ,OAAO,EAAE,aAAa,CAAC,GAAG,CAAC,QAAQ,EAAE,IAAI,EAAE,IAAI,CAAC;QAChD,GAAG,EAAE,GAAG,CAAC,WAAW;KACrB;AACH;AAEO,MAAM,uBAAuB,GAAG,CAAC,GAAoB,KAAqB;IAC/E,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,kBAAkB,CAAC,GAAG,CAAC;AAC9C,IAAA,MAAM,QAAQ,GAAG,kBAAkB,CAAC,GAAG,CAAC,GAAG,KAAK,GAAG,IAAI;AACvD,IAAA,IAAI,CAAC,IAAI;AAAE,QAAA,MAAM,IAAI,KAAK,CAAC,0DAA0D,CAAC;IACtF,OAAO;QACL,GAAG,sBAAsB,CAAC,GAAG,CAAC;AAC9B,QAAA,MAAM,EAAE,cAAc;QACtB,QAAQ;QACR,IAAI;QACJ,IAAI;AACJ,QAAA,OAAO,EAAE,aAAa,CAAC,QAAQ,KAAK,KAAK,GAAG,OAAO,GAAG,MAAM,EAAE,IAAI,EAAE,IAAI,CAAC;AACzE,QAAA,GAAG,EAAE,GAAG,CAAC,GAAG,IAAI,EAAE;KACnB;AACH;;;;;;;"}

package/request-info.mjs

@@ -0,0 +1,96 @@
+import { randomUUID } from 'crypto';
+
+const isDefaultPort = (protocol, port) => port == null || (protocol === 'http' && port === 80) || (protocol === 'https' && port === 443);
+const formatBaseUrl = (protocol, hostname, port) => isDefaultPort(protocol, port) ? `${protocol}://${hostname}` : `${protocol}://${hostname}:${port}`;
+const firstHeaderValue = (value) => {
+    const raw = Array.isArray(value) ? value[0] : value;
+    return raw?.split(',')[0]?.trim() || undefined;
+};
+const parseHostHeader = (hostHeader) => {
+    const url = new URL(`http://${hostHeader}`);
+    return { hostname: url.hostname, port: url.port ? Number(url.port) : undefined };
+};
+const isEncryptedSocket = (req) => 'encrypted' in req.socket && req.socket.encrypted === true;
+const isEncryptedConnect = (req) => {
+    const forwarded = firstHeaderValue(req.headers['x-forwarded-proto'])?.toLowerCase();
+    if (forwarded === 'https' || forwarded === 'wss')
+        return true;
+    if (forwarded === 'http' || forwarded === 'ws')
+        return false;
+    return isEncryptedSocket(req);
+};
+const resolveForwardedHost = (req) => firstHeaderValue(req.headers['x-forwarded-host']);
+const resolveHostAndPort = (req, fallbackHostname) => {
+    const headerValue = resolveForwardedHost(req) ?? req.headers.host;
+    if (headerValue) {
+        const { hostname, port } = parseHostHeader(headerValue);
+        return { host: hostname, port };
+    }
+    return { host: fallbackHostname ?? '', port: undefined };
+};
+/**
+ * Builds the base URL (`protocol://host[:port]`) for an Express HTTP request, using the request's
+ * protocol and resolving the host/port from forwarding headers with the Express hostname as fallback.
+ * The port is omitted when it matches the default for the protocol (80 for http, 443 for https).
+ * @param req The Express request.
+ * @returns The base URL string.
+ */
+const requestBaseUrl = (req) => {
+    const { host, port } = resolveHostAndPort(req, req.hostname);
+    return formatBaseUrl(req.protocol, host, port);
+};
+/**
+ * Builds the base URL (`http(s)://host[:port]`) for a raw WebSocket upgrade (connect) request.
+ * Returns an `https` URL when the connection is TLS-encrypted or `x-forwarded-proto` indicates a
+ * secure scheme, otherwise `http`. Throws if no host can be determined from the request headers,
+ * since upgrade requests have no Express `hostname` fallback.
+ * @param req The incoming upgrade request.
+ * @returns The base URL string.
+ * @throws Error when the host cannot be resolved from the request.
+ */
+const connectRequestBaseUrl = (req) => {
+    const { host, port } = resolveHostAndPort(req);
+    if (!host)
+        throw new Error('Cannot determine base URL from websocket connect request');
+    return formatBaseUrl(isEncryptedConnect(req) ? 'https' : 'http', host, port);
+};
+const buildSharedRequestInfo = (req) => ({
+    requestId: req.headers['x-request-id']?.toString() ?? randomUUID(),
+    method: req.method ?? '',
+    origin: req.headers.origin ?? '',
+    referer: req.headers.referer?.toString() ?? '',
+    arrLogId: req.headers['x-arr-log-id']?.toString() ?? undefined,
+    clientIp: firstHeaderValue(req.headers['x-forwarded-for']) ?? req.socket.remoteAddress,
+    correlationId: req.headers['x-correlation-id']?.toString() ?? undefined,
+    userAgent: req.headers['user-agent']?.toString() ?? undefined,
+});
+const buildBaseRequestInfo = (req) => {
+    const { host, port } = resolveHostAndPort(req, req.hostname);
+    return {
+        ...buildSharedRequestInfo(req),
+        source: 'http',
+        protocol: req.protocol,
+        host,
+        port,
+        baseUrl: formatBaseUrl(req.protocol, host, port),
+        url: req.originalUrl,
+    };
+};
+const buildConnectRequestInfo = (req) => {
+    const { host, port } = resolveHostAndPort(req);
+    const protocol = isEncryptedConnect(req) ? 'wss' : 'ws';
+    if (!host)
+        throw new Error('Cannot determine base URL from websocket connect request');
+    return {
+        ...buildSharedRequestInfo(req),
+        source: 'subscription',
+        protocol,
+        host,
+        port,
+        baseUrl: formatBaseUrl(protocol === 'wss' ? 'https' : 'http', host, port),
+        url: req.url ?? '',
+    };
+};
+
+export { buildBaseRequestInfo, buildConnectRequestInfo, connectRequestBaseUrl, requestBaseUrl };
+//# sourceMappingURL=request-info.mjs.map

package/request-info.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"request-info.mjs","sources":["../src/request-info.ts"],"sourcesContent":["import { randomUUID } from 'crypto'\nimport type { Request } from 'express'\nimport type { IncomingMessage } from 'http'\nimport type { TLSSocket } from 'tls'\n\nexport interface BaseRequestInfo extends Record<string, unknown> {\n  requestId: string\n  source: 'http' | 'subscription'\n  protocol: 'http' | 'https' | 'ws' | 'wss'\n  host: string\n  port?: number\n  method: string\n  baseUrl: string\n  url: string\n  origin: string\n  referer?: string\n  correlationId?: string\n  arrLogId?: string\n  clientIp?: string\n  userAgent?: string\n}\n\nconst isDefaultPort = (protocol: string, port: number | undefined): boolean =>\n  port == null || (protocol === 'http' && port === 80) || (protocol === 'https' && port === 443)\n\nconst formatBaseUrl = (protocol: string, hostname: string, port: number | undefined): string =>\n  isDefaultPort(protocol, port) ? `${protocol}://${hostname}` : `${protocol}://${hostname}:${port}`\n\nconst firstHeaderValue = (value: string | string[] | undefined): string | undefined => {\n  const raw = Array.isArray(value) ? value[0] : value\n  return raw?.split(',')[0]?.trim() || undefined\n}\n\nconst parseHostHeader = (hostHeader: string): { hostname: string; port: number | undefined } => {\n  const url = new URL(`http://${hostHeader}`)\n  return { hostname: url.hostname, port: url.port ? Number(url.port) : undefined }\n}\n\nconst isEncryptedSocket = (req: IncomingMessage): boolean => 'encrypted' in req.socket && (req.socket as TLSSocket).encrypted === true\n\nconst isEncryptedConnect = (req: IncomingMessage): boolean => {\n  const forwarded = firstHeaderValue(req.headers['x-forwarded-proto'])?.toLowerCase()\n  if (forwarded === 'https' || forwarded === 'wss') return true\n  if (forwarded === 'http' || forwarded === 'ws') return false\n  return isEncryptedSocket(req)\n}\n\nconst resolveForwardedHost = (req: IncomingMessage): string | undefined => firstHeaderValue(req.headers['x-forwarded-host'])\n\nconst resolveHostAndPort = (req: IncomingMessage, fallbackHostname?: string): { host: string; port: number | undefined } => {\n  const headerValue = resolveForwardedHost(req) ?? req.headers.host\n  if (headerValue) {\n    const { hostname, port } = parseHostHeader(headerValue)\n    return { host: hostname, port }\n  }\n  return { host: fallbackHostname ?? '', port: undefined }\n}\n\n/**\n * Builds the base URL (`protocol://host[:port]`) for an Express HTTP request, using the request's\n * protocol and resolving the host/port from forwarding headers with the Express hostname as fallback.\n * The port is omitted when it matches the default for the protocol (80 for http, 443 for https).\n * @param req The Express request.\n * @returns The base URL string.\n */\nexport const requestBaseUrl = (req: Request): string => {\n  const { host, port } = resolveHostAndPort(req, req.hostname)\n  return formatBaseUrl(req.protocol, host, port)\n}\n\n/**\n * Builds the base URL (`http(s)://host[:port]`) for a raw WebSocket upgrade (connect) request.\n * Returns an `https` URL when the connection is TLS-encrypted or `x-forwarded-proto` indicates a\n * secure scheme, otherwise `http`. Throws if no host can be determined from the request headers,\n * since upgrade requests have no Express `hostname` fallback.\n * @param req The incoming upgrade request.\n * @returns The base URL string.\n * @throws Error when the host cannot be resolved from the request.\n */\nexport const connectRequestBaseUrl = (req: IncomingMessage): string => {\n  const { host, port } = resolveHostAndPort(req)\n  if (!host) throw new Error('Cannot determine base URL from websocket connect request')\n  return formatBaseUrl(isEncryptedConnect(req) ? 'https' : 'http', host, port)\n}\n\nconst buildSharedRequestInfo = (req: IncomingMessage) => ({\n  requestId: req.headers['x-request-id']?.toString() ?? randomUUID(),\n  method: req.method ?? '',\n  origin: req.headers.origin ?? '',\n  referer: req.headers.referer?.toString() ?? '',\n  arrLogId: req.headers['x-arr-log-id']?.toString() ?? undefined,\n  clientIp: firstHeaderValue(req.headers['x-forwarded-for']) ?? req.socket.remoteAddress,\n  correlationId: req.headers['x-correlation-id']?.toString() ?? undefined,\n  userAgent: req.headers['user-agent']?.toString() ?? undefined,\n})\n\nexport const buildBaseRequestInfo = (req: Request): BaseRequestInfo => {\n  const { host, port } = resolveHostAndPort(req, req.hostname)\n  return {\n    ...buildSharedRequestInfo(req),\n    source: 'http',\n    protocol: req.protocol as 'http' | 'https',\n    host,\n    port,\n    baseUrl: formatBaseUrl(req.protocol, host, port),\n    url: req.originalUrl,\n  }\n}\n\nexport const buildConnectRequestInfo = (req: IncomingMessage): BaseRequestInfo => {\n  const { host, port } = resolveHostAndPort(req)\n  const protocol = isEncryptedConnect(req) ? 'wss' : 'ws'\n  if (!host) throw new Error('Cannot determine base URL from websocket connect request')\n  return {\n    ...buildSharedRequestInfo(req),\n    source: 'subscription',\n    protocol,\n    host,\n    port,\n    baseUrl: formatBaseUrl(protocol === 'wss' ? 'https' : 'http', host, port),\n    url: req.url ?? '',\n  }\n}\n"],"names":[],"mappings":";;AAsBA,MAAM,aAAa,GAAG,CAAC,QAAgB,EAAE,IAAwB,KAC/D,IAAI,IAAI,IAAI,KAAK,QAAQ,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC,KAAK,QAAQ,KAAK,OAAO,IAAI,IAAI,KAAK,GAAG,CAAC;AAEhG,MAAM,aAAa,GAAG,CAAC,QAAgB,EAAE,QAAgB,EAAE,IAAwB,KACjF,aAAa,CAAC,QAAQ,EAAE,IAAI,CAAC,GAAG,CAAA,EAAG,QAAQ,CAAA,GAAA,EAAM,QAAQ,EAAE,GAAG,CAAA,EAAG,QAAQ,CAAA,GAAA,EAAM,QAAQ,CAAA,CAAA,EAAI,IAAI,EAAE;AAEnG,MAAM,gBAAgB,GAAG,CAAC,KAAoC,KAAwB;AACpF,IAAA,MAAM,GAAG,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,GAAG,KAAK;AACnD,IAAA,OAAO,GAAG,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,SAAS;AAChD,CAAC;AAED,MAAM,eAAe,GAAG,CAAC,UAAkB,KAAoD;IAC7F,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,CAAA,OAAA,EAAU,UAAU,CAAA,CAAE,CAAC;IAC3C,OAAO,EAAE,QAAQ,EAAE,GAAG,CAAC,QAAQ,EAAE,IAAI,EAAE,GAAG,CAAC,IAAI,GAAG,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,SAAS,EAAE;AAClF,CAAC;AAED,MAAM,iBAAiB,GAAG,CAAC,GAAoB,KAAc,WAAW,IAAI,GAAG,CAAC,MAAM,IAAK,GAAG,CAAC,MAAoB,CAAC,SAAS,KAAK,IAAI;AAEtI,MAAM,kBAAkB,GAAG,CAAC,GAAoB,KAAa;AAC3D,IAAA,MAAM,SAAS,GAAG,gBAAgB,CAAC,GAAG,CAAC,OAAO,CAAC,mBAAmB,CAAC,CAAC,EAAE,WAAW,EAAE;AACnF,IAAA,IAAI,SAAS,KAAK,OAAO,IAAI,SAAS,KAAK,KAAK;AAAE,QAAA,OAAO,IAAI;AAC7D,IAAA,IAAI,SAAS,KAAK,MAAM,IAAI,SAAS,KAAK,IAAI;AAAE,QAAA,OAAO,KAAK;AAC5D,IAAA,OAAO,iBAAiB,CAAC,GAAG,CAAC;AAC/B,CAAC;AAED,MAAM,oBAAoB,GAAG,CAAC,GAAoB,KAAyB,gBAAgB,CAAC,GAAG,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;AAE5H,MAAM,kBAAkB,GAAG,CAAC,GAAoB,EAAE,gBAAyB,KAAgD;AACzH,IAAA,MAAM,WAAW,GAAG,oBAAoB,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,OAAO,CAAC,IAAI;IACjE,IAAI,WAAW,EAAE;QACf,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,GAAG,eAAe,CAAC,WAAW,CAAC;AACvD,QAAA,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE;IACjC;IACA,OAAO,EAAE,IAAI,EAAE,gBAAgB,IAAI,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;AAC1D,CAAC;AAED;;;;;;AAMG;AACI,MAAM,cAAc,GAAG,CAAC,GAAY,KAAY;AACrD,IAAA,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,kBAAkB,CAAC,GAAG,EAAE,GAAG,CAAC,QAAQ,CAAC;IAC5D,OAAO,aAAa,CAAC,GAAG,CAAC,QAAQ,EAAE,IAAI,EAAE,IAAI,CAAC;AAChD;AAEA;;;;;;;;AAQG;AACI,MAAM,qBAAqB,GAAG,CAAC,GAAoB,KAAY;IACpE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,kBAAkB,CAAC,GAAG,CAAC;AAC9C,IAAA,IAAI,CAAC,IAAI;AAAE,QAAA,MAAM,IAAI,KAAK,CAAC,0DAA0D,CAAC;AACtF,IAAA,OAAO,aAAa,CAAC,kBAAkB,CAAC,GAAG,CAAC,GAAG,OAAO,GAAG,MAAM,EAAE,IAAI,EAAE,IAAI,CAAC;AAC9E;AAEA,MAAM,sBAAsB,GAAG,CAAC,GAAoB,MAAM;AACxD,IAAA,SAAS,EAAE,GAAG,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE,QAAQ,EAAE,IAAI,UAAU,EAAE;AAClE,IAAA,MAAM,EAAE,GAAG,CAAC,MAAM,IAAI,EAAE;AACxB,IAAA,MAAM,EAAE,GAAG,CAAC,OAAO,CAAC,MAAM,IAAI,EAAE;IAChC,OAAO,EAAE,GAAG,CAAC,OAAO,CAAC,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE;IAC9C,QAAQ,EAAE,GAAG,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE,QAAQ,EAAE,IAAI,SAAS;AAC9D,IAAA,QAAQ,EAAE,gBAAgB,CAAC,GAAG,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC,IAAI,GAAG,CAAC,MAAM,CAAC,aAAa;IACtF,aAAa,EAAE,GAAG,CAAC,OAAO,CAAC,kBAAkB,CAAC,EAAE,QAAQ,EAAE,IAAI,SAAS;IACvE,SAAS,EAAE,GAAG,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,QAAQ,EAAE,IAAI,SAAS;AAC9D,CAAA,CAAC;AAEK,MAAM,oBAAoB,GAAG,CAAC,GAAY,KAAqB;AACpE,IAAA,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,kBAAkB,CAAC,GAAG,EAAE,GAAG,CAAC,QAAQ,CAAC;IAC5D,OAAO;QACL,GAAG,sBAAsB,CAAC,GAAG,CAAC;AAC9B,QAAA,MAAM,EAAE,MAAM;QACd,QAAQ,EAAE,GAAG,CAAC,QAA4B;QAC1C,IAAI;QACJ,IAAI;QACJ,OAAO,EAAE,aAAa,CAAC,GAAG,CAAC,QAAQ,EAAE,IAAI,EAAE,IAAI,CAAC;QAChD,GAAG,EAAE,GAAG,CAAC,WAAW;KACrB;AACH;AAEO,MAAM,uBAAuB,GAAG,CAAC,GAAoB,KAAqB;IAC/E,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,kBAAkB,CAAC,GAAG,CAAC;AAC9C,IAAA,MAAM,QAAQ,GAAG,kBAAkB,CAAC,GAAG,CAAC,GAAG,KAAK,GAAG,IAAI;AACvD,IAAA,IAAI,CAAC,IAAI;AAAE,QAAA,MAAM,IAAI,KAAK,CAAC,0DAA0D,CAAC;IACtF,OAAO;QACL,GAAG,sBAAsB,CAAC,GAAG,CAAC;AAC9B,QAAA,MAAM,EAAE,cAAc;QACtB,QAAQ;QACR,IAAI;QACJ,IAAI;AACJ,QAAA,OAAO,EAAE,aAAa,CAAC,QAAQ,KAAK,KAAK,GAAG,OAAO,GAAG,MAAM,EAAE,IAAI,EAAE,IAAI,CAAC;AACzE,QAAA,GAAG,EAAE,GAAG,CAAC,GAAG,IAAI,EAAE;KACnB;AACH;;;;"}

package/shield.d.ts

@@ -1,6 +1,6 @@
 import type { and, chain, or, race } from 'graphql-shield';
 import { allow } from 'graphql-shield';
-import type { Primitive } from './models';
+import type { Primitive } from './type-utils';
 type RuleCombinator = typeof chain | typeof race | typeof or | typeof and;
 export type ShieldRule = ReturnType<(typeof allow)['getRules']>[number];
 export declare const createRule: <TContext, TParent = unknown, TArgs = unknown>(logic: (parent: TParent, args: TArgs, ctx: TContext) => boolean | Promise<boolean> | Error, cache?: "contextual" | "strict") => ShieldRule;

package/shield.js.map

@@ -1 +1 @@
-{"version":3,"file":"shield.js","sources":["../src/shield.ts"],"sourcesContent":["import type { and, chain, or, race } from 'graphql-shield'\nimport { allow, rule, shield } from 'graphql-shield'\nimport type { IRules } from 'graphql-shield'\nimport type { Primitive } from './models'\n\ntype RuleCombinator = typeof chain | typeof race | typeof or | typeof and\n// For whatever reason, graphql-shield doesn't export this type, but we can extract if from\n// what it does export.\nexport type ShieldRule = ReturnType<(typeof allow)['getRules']>[number]\nexport const createRule = <TContext, TParent = unknown, TArgs = unknown>(\n  logic: (parent: TParent, args: TArgs, ctx: TContext) => boolean | Promise<boolean> | Error,\n  cache: 'contextual' | 'strict' = 'strict',\n): ShieldRule => rule({ cache })(async (parent, args, ctx) => logic(parent, args, ctx))\n\n/**\n * Combines a given rule with all existing defined rules using the provided combinator\n * @param schema The existing shield schema with rules\n * @param rule The rule to be combined with existing rules\n * @param combinator The combinator to use. Eg. and | or | chain | race\n *\n * Usage:\n *\n * const updatedSchema = combineRuleWithAll(shieldSchema, rules.accountNotBlocked, chain)\n */\nexport function combineRuleWithAll<T>(schema: ShieldSchema<T>, rule: ShieldRule, combinator: RuleCombinator): ShieldSchema<T> {\n  return Object.fromEntries(\n    Object.entries(schema).map(([key, value]) => {\n      if (value.constructor.name !== 'Object') {\n        return [key, combinator(rule, value)]\n      }\n      return [key, combineRuleWithAll(value, rule, combinator)]\n    }),\n  ) as ShieldSchema<T>\n}\n\n/**\n * Creates graphql shield middleware making use of generics to type the definition of the rules.\n * @param schema A mapping of schema objects to the shield rules that define the access to that object\n * @param fallbackRule A fallback rule to apply to any object or property which doesn't have a defined rule.\n *\n * Usage:\n * import { Resolvers } from '../generated/types'\n *\n * const shieldSchema = createShieldSchema<Resolvers>({\n *   Query: {\n *     getThings: allow,\n *     dontGetThings: deny,\n *   }\n * })\n *\n * let schema = makeExecutableSchema({...})\n *\n * schema = applyMiddleware(schema, shieldSchema)\n */\nexport function createShieldSchema<TRootResolvers>(schema: ShieldSchema<TRootResolvers>, fallbackRule: ShieldRule = allow) {\n  return shield(schema as IRules, {\n    allowExternalErrors: true,\n    fallbackRule: fallbackRule,\n  })\n}\n\nexport type ShieldSchema<TResolver> = TResolver extends Primitive\n  ? ShieldRule\n  : {\n      [key in keyof TResolver]?: ShieldSchema<TResolver[key]> | ShieldRule\n    } & {\n      '*'?: ShieldRule\n    }\n"],"names":["rule","allow","shield"],"mappings":";;;;AASO,MAAM,UAAU,GAAG,CACxB,KAA0F,EAC1F,KAAA,GAAiC,QAAQ,KAC1BA,kBAAI,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,OAAO,MAAM,EAAE,IAAI,EAAE,GAAG,KAAK,KAAK,CAAC,MAAM,EAAE,IAAI,EAAE,GAAG,CAAC;AAEtF;;;;;;;;;AASG;SACa,kBAAkB,CAAI,MAAuB,EAAE,IAAgB,EAAE,UAA0B,EAAA;IACzG,OAAO,MAAM,CAAC,WAAW,CACvB,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,KAAI;QAC1C,IAAI,KAAK,CAAC,WAAW,CAAC,IAAI,KAAK,QAAQ,EAAE;YACvC,OAAO,CAAC,GAAG,EAAE,UAAU,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QACvC;AACA,QAAA,OAAO,CAAC,GAAG,EAAE,kBAAkB,CAAC,KAAK,EAAE,IAAI,EAAE,UAAU,CAAC,CAAC;IAC3D,CAAC,CAAC,CACgB;AACtB;AAEA;;;;;;;;;;;;;;;;;;AAkBG;SACa,kBAAkB,CAAiB,MAAoC,EAAE,eAA2BC,mBAAK,EAAA;IACvH,OAAOC,oBAAM,CAAC,MAAgB,EAAE;AAC9B,QAAA,mBAAmB,EAAE,IAAI;AACzB,QAAA,YAAY,EAAE,YAAY;AAC3B,KAAA,CAAC;AACJ;;;;;;"}
+{"version":3,"file":"shield.js","sources":["../src/shield.ts"],"sourcesContent":["import type { and, chain, IRules, or, race } from 'graphql-shield'\nimport { allow, rule, shield } from 'graphql-shield'\nimport type { Primitive } from './type-utils'\n\ntype RuleCombinator = typeof chain | typeof race | typeof or | typeof and\n// For whatever reason, graphql-shield doesn't export this type, but we can extract if from\n// what it does export.\nexport type ShieldRule = ReturnType<(typeof allow)['getRules']>[number]\nexport const createRule = <TContext, TParent = unknown, TArgs = unknown>(\n  logic: (parent: TParent, args: TArgs, ctx: TContext) => boolean | Promise<boolean> | Error,\n  cache: 'contextual' | 'strict' = 'strict',\n): ShieldRule => rule({ cache })(async (parent, args, ctx) => logic(parent, args, ctx))\n\n/**\n * Combines a given rule with all existing defined rules using the provided combinator\n * @param schema The existing shield schema with rules\n * @param rule The rule to be combined with existing rules\n * @param combinator The combinator to use. Eg. and | or | chain | race\n *\n * Usage:\n *\n * const updatedSchema = combineRuleWithAll(shieldSchema, rules.accountNotBlocked, chain)\n */\nexport function combineRuleWithAll<T>(schema: ShieldSchema<T>, rule: ShieldRule, combinator: RuleCombinator): ShieldSchema<T> {\n  return Object.fromEntries(\n    Object.entries(schema).map(([key, value]) => {\n      if (value.constructor.name !== 'Object') {\n        return [key, combinator(rule, value)]\n      }\n      return [key, combineRuleWithAll(value, rule, combinator)]\n    }),\n  ) as ShieldSchema<T>\n}\n\n/**\n * Creates graphql shield middleware making use of generics to type the definition of the rules.\n * @param schema A mapping of schema objects to the shield rules that define the access to that object\n * @param fallbackRule A fallback rule to apply to any object or property which doesn't have a defined rule.\n *\n * Usage:\n * import { Resolvers } from '../generated/types'\n *\n * const shieldSchema = createShieldSchema<Resolvers>({\n *   Query: {\n *     getThings: allow,\n *     dontGetThings: deny,\n *   }\n * })\n *\n * let schema = makeExecutableSchema({...})\n *\n * schema = applyMiddleware(schema, shieldSchema)\n */\nexport function createShieldSchema<TRootResolvers>(schema: ShieldSchema<TRootResolvers>, fallbackRule: ShieldRule = allow) {\n  return shield(schema as IRules, {\n    allowExternalErrors: true,\n    fallbackRule: fallbackRule,\n  })\n}\n\nexport type ShieldSchema<TResolver> = TResolver extends Primitive\n  ? ShieldRule\n  : {\n      [key in keyof TResolver]?: ShieldSchema<TResolver[key]> | ShieldRule\n    } & {\n      '*'?: ShieldRule\n    }\n"],"names":["rule","allow","shield"],"mappings":";;;;AAQO,MAAM,UAAU,GAAG,CACxB,KAA0F,EAC1F,KAAA,GAAiC,QAAQ,KAC1BA,kBAAI,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,OAAO,MAAM,EAAE,IAAI,EAAE,GAAG,KAAK,KAAK,CAAC,MAAM,EAAE,IAAI,EAAE,GAAG,CAAC;AAEtF;;;;;;;;;AASG;SACa,kBAAkB,CAAI,MAAuB,EAAE,IAAgB,EAAE,UAA0B,EAAA;IACzG,OAAO,MAAM,CAAC,WAAW,CACvB,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,KAAI;QAC1C,IAAI,KAAK,CAAC,WAAW,CAAC,IAAI,KAAK,QAAQ,EAAE;YACvC,OAAO,CAAC,GAAG,EAAE,UAAU,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QACvC;AACA,QAAA,OAAO,CAAC,GAAG,EAAE,kBAAkB,CAAC,KAAK,EAAE,IAAI,EAAE,UAAU,CAAC,CAAC;IAC3D,CAAC,CAAC,CACgB;AACtB;AAEA;;;;;;;;;;;;;;;;;;AAkBG;SACa,kBAAkB,CAAiB,MAAoC,EAAE,eAA2BC,mBAAK,EAAA;IACvH,OAAOC,oBAAM,CAAC,MAAgB,EAAE;AAC9B,QAAA,mBAAmB,EAAE,IAAI;AACzB,QAAA,YAAY,EAAE,YAAY;AAC3B,KAAA,CAAC;AACJ;;;;;;"}

package/shield.mjs

@@ -1,4 +1,4 @@
-import { rule, allow, shield } from 'graphql-shield';
+import { allow, rule, shield } from 'graphql-shield';
 
 const createRule = (logic, cache = 'strict') => rule({ cache })(async (parent, args, ctx) => logic(parent, args, ctx));
 /**

package/shield.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"shield.mjs","sources":["../src/shield.ts"],"sourcesContent":["import type { and, chain, or, race } from 'graphql-shield'\nimport { allow, rule, shield } from 'graphql-shield'\nimport type { IRules } from 'graphql-shield'\nimport type { Primitive } from './models'\n\ntype RuleCombinator = typeof chain | typeof race | typeof or | typeof and\n// For whatever reason, graphql-shield doesn't export this type, but we can extract if from\n// what it does export.\nexport type ShieldRule = ReturnType<(typeof allow)['getRules']>[number]\nexport const createRule = <TContext, TParent = unknown, TArgs = unknown>(\n  logic: (parent: TParent, args: TArgs, ctx: TContext) => boolean | Promise<boolean> | Error,\n  cache: 'contextual' | 'strict' = 'strict',\n): ShieldRule => rule({ cache })(async (parent, args, ctx) => logic(parent, args, ctx))\n\n/**\n * Combines a given rule with all existing defined rules using the provided combinator\n * @param schema The existing shield schema with rules\n * @param rule The rule to be combined with existing rules\n * @param combinator The combinator to use. Eg. and | or | chain | race\n *\n * Usage:\n *\n * const updatedSchema = combineRuleWithAll(shieldSchema, rules.accountNotBlocked, chain)\n */\nexport function combineRuleWithAll<T>(schema: ShieldSchema<T>, rule: ShieldRule, combinator: RuleCombinator): ShieldSchema<T> {\n  return Object.fromEntries(\n    Object.entries(schema).map(([key, value]) => {\n      if (value.constructor.name !== 'Object') {\n        return [key, combinator(rule, value)]\n      }\n      return [key, combineRuleWithAll(value, rule, combinator)]\n    }),\n  ) as ShieldSchema<T>\n}\n\n/**\n * Creates graphql shield middleware making use of generics to type the definition of the rules.\n * @param schema A mapping of schema objects to the shield rules that define the access to that object\n * @param fallbackRule A fallback rule to apply to any object or property which doesn't have a defined rule.\n *\n * Usage:\n * import { Resolvers } from '../generated/types'\n *\n * const shieldSchema = createShieldSchema<Resolvers>({\n *   Query: {\n *     getThings: allow,\n *     dontGetThings: deny,\n *   }\n * })\n *\n * let schema = makeExecutableSchema({...})\n *\n * schema = applyMiddleware(schema, shieldSchema)\n */\nexport function createShieldSchema<TRootResolvers>(schema: ShieldSchema<TRootResolvers>, fallbackRule: ShieldRule = allow) {\n  return shield(schema as IRules, {\n    allowExternalErrors: true,\n    fallbackRule: fallbackRule,\n  })\n}\n\nexport type ShieldSchema<TResolver> = TResolver extends Primitive\n  ? ShieldRule\n  : {\n      [key in keyof TResolver]?: ShieldSchema<TResolver[key]> | ShieldRule\n    } & {\n      '*'?: ShieldRule\n    }\n"],"names":[],"mappings":";;AASO,MAAM,UAAU,GAAG,CACxB,KAA0F,EAC1F,KAAA,GAAiC,QAAQ,KAC1B,IAAI,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,OAAO,MAAM,EAAE,IAAI,EAAE,GAAG,KAAK,KAAK,CAAC,MAAM,EAAE,IAAI,EAAE,GAAG,CAAC;AAEtF;;;;;;;;;AASG;SACa,kBAAkB,CAAI,MAAuB,EAAE,IAAgB,EAAE,UAA0B,EAAA;IACzG,OAAO,MAAM,CAAC,WAAW,CACvB,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,KAAI;QAC1C,IAAI,KAAK,CAAC,WAAW,CAAC,IAAI,KAAK,QAAQ,EAAE;YACvC,OAAO,CAAC,GAAG,EAAE,UAAU,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QACvC;AACA,QAAA,OAAO,CAAC,GAAG,EAAE,kBAAkB,CAAC,KAAK,EAAE,IAAI,EAAE,UAAU,CAAC,CAAC;IAC3D,CAAC,CAAC,CACgB;AACtB;AAEA;;;;;;;;;;;;;;;;;;AAkBG;SACa,kBAAkB,CAAiB,MAAoC,EAAE,eAA2B,KAAK,EAAA;IACvH,OAAO,MAAM,CAAC,MAAgB,EAAE;AAC9B,QAAA,mBAAmB,EAAE,IAAI;AACzB,QAAA,YAAY,EAAE,YAAY;AAC3B,KAAA,CAAC;AACJ;;;;"}
+{"version":3,"file":"shield.mjs","sources":["../src/shield.ts"],"sourcesContent":["import type { and, chain, IRules, or, race } from 'graphql-shield'\nimport { allow, rule, shield } from 'graphql-shield'\nimport type { Primitive } from './type-utils'\n\ntype RuleCombinator = typeof chain | typeof race | typeof or | typeof and\n// For whatever reason, graphql-shield doesn't export this type, but we can extract if from\n// what it does export.\nexport type ShieldRule = ReturnType<(typeof allow)['getRules']>[number]\nexport const createRule = <TContext, TParent = unknown, TArgs = unknown>(\n  logic: (parent: TParent, args: TArgs, ctx: TContext) => boolean | Promise<boolean> | Error,\n  cache: 'contextual' | 'strict' = 'strict',\n): ShieldRule => rule({ cache })(async (parent, args, ctx) => logic(parent, args, ctx))\n\n/**\n * Combines a given rule with all existing defined rules using the provided combinator\n * @param schema The existing shield schema with rules\n * @param rule The rule to be combined with existing rules\n * @param combinator The combinator to use. Eg. and | or | chain | race\n *\n * Usage:\n *\n * const updatedSchema = combineRuleWithAll(shieldSchema, rules.accountNotBlocked, chain)\n */\nexport function combineRuleWithAll<T>(schema: ShieldSchema<T>, rule: ShieldRule, combinator: RuleCombinator): ShieldSchema<T> {\n  return Object.fromEntries(\n    Object.entries(schema).map(([key, value]) => {\n      if (value.constructor.name !== 'Object') {\n        return [key, combinator(rule, value)]\n      }\n      return [key, combineRuleWithAll(value, rule, combinator)]\n    }),\n  ) as ShieldSchema<T>\n}\n\n/**\n * Creates graphql shield middleware making use of generics to type the definition of the rules.\n * @param schema A mapping of schema objects to the shield rules that define the access to that object\n * @param fallbackRule A fallback rule to apply to any object or property which doesn't have a defined rule.\n *\n * Usage:\n * import { Resolvers } from '../generated/types'\n *\n * const shieldSchema = createShieldSchema<Resolvers>({\n *   Query: {\n *     getThings: allow,\n *     dontGetThings: deny,\n *   }\n * })\n *\n * let schema = makeExecutableSchema({...})\n *\n * schema = applyMiddleware(schema, shieldSchema)\n */\nexport function createShieldSchema<TRootResolvers>(schema: ShieldSchema<TRootResolvers>, fallbackRule: ShieldRule = allow) {\n  return shield(schema as IRules, {\n    allowExternalErrors: true,\n    fallbackRule: fallbackRule,\n  })\n}\n\nexport type ShieldSchema<TResolver> = TResolver extends Primitive\n  ? ShieldRule\n  : {\n      [key in keyof TResolver]?: ShieldSchema<TResolver[key]> | ShieldRule\n    } & {\n      '*'?: ShieldRule\n    }\n"],"names":[],"mappings":";;AAQO,MAAM,UAAU,GAAG,CACxB,KAA0F,EAC1F,KAAA,GAAiC,QAAQ,KAC1B,IAAI,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,OAAO,MAAM,EAAE,IAAI,EAAE,GAAG,KAAK,KAAK,CAAC,MAAM,EAAE,IAAI,EAAE,GAAG,CAAC;AAEtF;;;;;;;;;AASG;SACa,kBAAkB,CAAI,MAAuB,EAAE,IAAgB,EAAE,UAA0B,EAAA;IACzG,OAAO,MAAM,CAAC,WAAW,CACvB,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,KAAI;QAC1C,IAAI,KAAK,CAAC,WAAW,CAAC,IAAI,KAAK,QAAQ,EAAE;YACvC,OAAO,CAAC,GAAG,EAAE,UAAU,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QACvC;AACA,QAAA,OAAO,CAAC,GAAG,EAAE,kBAAkB,CAAC,KAAK,EAAE,IAAI,EAAE,UAAU,CAAC,CAAC;IAC3D,CAAC,CAAC,CACgB;AACtB;AAEA;;;;;;;;;;;;;;;;;;AAkBG;SACa,kBAAkB,CAAiB,MAAoC,EAAE,eAA2B,KAAK,EAAA;IACvH,OAAO,MAAM,CAAC,MAAgB,EAAE;AAC9B,QAAA,mBAAmB,EAAE,IAAI;AACzB,QAAA,YAAY,EAAE,YAAY;AAC3B,KAAA,CAAC;AACJ;;;;"}

package/subscriptions/context.d.ts

@@ -1,21 +1,24 @@
 import type { Logger } from '@makerx/node-common';
 import type { IncomingMessage } from 'http';
 import { User } from '../User';
-import type { CreateRequestLogger, GraphQLContext, JwtPayload, RequestInfo } from '../context';
+import type { CreateRequestLogger, GraphQLContext, JwtPayload, RequestInfo, RequestInfoLogKey } from '../context';
 export interface SubscriptionContextInput {
     connectRequest: IncomingMessage;
     connectionParams?: Readonly<Record<string, unknown>>;
     claims?: JwtPayload;
 }
-export type CreateSubscriptionUser<T = User | undefined> = (input: SubscriptionContextInput) => Promise<T>;
+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 interface CreateSubscriptionContextConfig<TContext = GraphQLContext> {
-    requestLogger: CreateRequestLogger | Logger;
+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[];
-    createUser?: CreateSubscriptionUser;
-    requestInfoToLog?: Array<keyof RequestInfo>;
-    augmentContext?: (context: TContext) => Record<string, unknown> | Promise<Record<string, unknown>>;
-}
-export declare const createSubscriptionContextFactory: <TContext extends GraphQLContext = GraphQLContext>({ requestLogger, augmentRequestInfo, claimsToLog, createUser, requestInfoToLog, augmentContext, }: CreateSubscriptionContextConfig<TContext>) => CreateSubscriptionContext<TContext>;
+    requestInfoToLog?: Array<RequestInfoLogKey>;
+    augmentContext?: (context: GraphQLContext<TLogger, RequestInfo, TUser>) => TAugment | Promise<TAugment>;
+} & ([User | undefined] extends [TUser] ? {
+    createUser?: CreateSubscriptionUser<TUser>;
+} : {
+    createUser: CreateSubscriptionUser<TUser>;
+});
+export declare const createSubscriptionContextFactory: <TUser = User | undefined, TAugment extends Record<string, unknown> = Record<string, never>, TLogger extends Logger = Logger>(config: CreateSubscriptionContextConfig<TUser, TAugment, TLogger>) => CreateSubscriptionContext<GraphQLContext<TLogger, RequestInfo, TUser> & TAugment>;

package/subscriptions/context.js

@@ -1,30 +1,23 @@
 'use strict';
 
-var crypto = require('crypto');
-var lodash = require('lodash');
+var compat = require('es-toolkit/compat');
 var User = require('../User.js');
+var requestInfo = require('../request-info.js');
 var utils = require('./utils.js');
 
-const createSubscriptionContextFactory = ({ requestLogger, augmentRequestInfo, claimsToLog, createUser = defaultCreateUser, requestInfoToLog, augmentContext, }) => {
-    // the function that creates the GraphQL context
+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);
     return async (input) => {
         const { connectRequest: req, claims } = input;
-        const xForwardedFor = req.headers['x-forwarded-for'];
-        const host = Array.isArray(xForwardedFor) ? xForwardedFor[0] : (xForwardedFor ?? req.headers.host);
         // build request info from the connect request and socket
-        const requestInfo = {
-            requestId: req.headers['x-request-id']?.toString() ?? crypto.randomUUID(),
-            protocol: 'ws',
-            host: host ?? '',
-            method: req.method ?? '',
-            url: req.url ?? '',
-            origin: req.headers['origin'] ?? '',
-            referer: req.headers.referer?.toString() ?? '',
-            arrLogId: req.headers['x-arr-log-id']?.toString() ?? undefined,
-            clientIp: req.headers['x-forwarded-for']?.toString() ?? req.socket.remoteAddress,
-            correlationId: req.headers['x-correlation-id']?.toString() ?? undefined,
+        const requestInfo$1 = {
+            ...requestInfo.buildConnectRequestInfo(req),
             ...augmentRequestInfo?.(input),
         };
+        const user = await createUser(input);
         // create request logger
         let logger;
         if (typeof requestLogger === 'function') {
@@ -32,24 +25,22 @@ const createSubscriptionContextFactory = ({ requestLogger, augmentRequestInfo, c
             const requestLoggerMetadata = {};
             // add request info to log
             if (requestInfoToLog?.length)
-                requestLoggerMetadata.request = lodash.pick(requestInfo, requestInfoToLog);
+                requestLoggerMetadata.request = compat.pick(requestInfo$1, requestInfoToLog);
             // add user claims to log
             if (claims && claimsToLog?.length)
-                requestLoggerMetadata.user = lodash.pick(claims, claimsToLog);
+                requestLoggerMetadata.user = compat.pick(claims, claimsToLog);
             // build the request logger
-            logger = requestLogger(requestLoggerMetadata);
+            logger = requestLogger(requestLoggerMetadata, user);
         }
         else
             logger = requestLogger;
         const graphqlContext = {
-            requestInfo,
+            requestInfo: requestInfo$1,
             logger,
-            user: await createUser(input),
+            user,
             started: Date.now(),
         };
-        const augmentedGraphQLContext = augmentContext
-            ? { ...graphqlContext, ...(await augmentContext(graphqlContext)) }
-            : graphqlContext;
+        const augmentedGraphQLContext = augmentContext ? { ...graphqlContext, ...(await augmentContext(graphqlContext)) } : graphqlContext;
         return augmentedGraphQLContext;
     };
 };