@makerx/graphql-core 3.0.0-beta.7 → 3.0.0

package/README.md

@@ -366,9 +366,44 @@ This library includes a `subscriptions` module to provide simple setup using the
 
 1. For authorisation, clients can include a connection parameter named `authorization` or `Authorization` using the HTTP header format `Bearer <token>`. Note: [Apollo Sandbox](https://studio.apollographql.com/sandbox/explorer) will include an `Authorization` connection parameter when you specify an HTTP `Authorization` header via the UI.
 
+### wrapSubscriptionIterator
+
+Wraps an `AsyncIterableIterator` (e.g. one returned by a pubsub `asyncIterableIterator(...)` call) with two optional behaviours:
+
+- `initialPayload` — a single event or array of events yielded before the wrapped iterator's events. Useful when a client subscribes after a state change has already happened, so they don't miss the current state while waiting for the next event.
+- `eventIsFinal` — a predicate that ends iteration eagerly when it returns `true` for an event. The final event is still yielded, then `wrapped.return()` is called to release resources. Only applied to events from the wrapped iterator, not to entries in `initialPayload`.
+
+Typical use is in a subscription resolver that needs to bridge a "current state" (cache or other persisted state lookup) with a live event stream, and close the subscription once a terminal event arrives:
+
+```ts
+const eventIsFinal = (data: BackgroundJobTopicData) =>
+  [BackgroundJobStatus.Completed, BackgroundJobStatus.Failed].includes(data.event.status)
+
+export const subscribeToBackgroundJobEvents = async (
+  args: SubscriptionBackgroundJobEventArgs,
+): Promise<AsyncIterator<BackgroundJobTopicData> & AsyncIterable<BackgroundJobTopicData>> => {
+  const initialPayload = await getJobFinishedEventFromCache(args.jobId)
+  const iterator = pubsub().asyncIterableIterator<BackgroundJobTopicData>(`${BACKGROUND_JOB_TOPIC}.${args.jobId}`)
+  return wrapSubscriptionIterator({
+    iterator,
+    initialPayload: initialPayload ? [initialPayload] : undefined,
+    eventIsFinal,
+  })
+}
+```
+
+The returned value is both an `AsyncIterator` and `AsyncIterable`, so it can be consumed via `for await` or by manual `next()` calls. `return()` and `throw()` are forwarded to the wrapped iterator when present.
+
 ## Utils
 
 - `isIntrospectionQuery`: indicates whether the query is an introspection query, based on the operation name or query content.
+- `extractAnonymousOperationName`: derives a synthetic operation name from a query source that has no explicit name, by combining the operation type with the first top-level selection — handy for logging/observability when clients send anonymous operations. Returns `undefined` if no top-level field can be found.
+
+  ```ts
+  extractAnonymousOperationName('{ users { id } }') // 'query users'
+  extractAnonymousOperationName('mutation { createUser { id } }') // 'mutation createUser'
+  extractAnonymousOperationName('subscription { onUpdate { id } }') // 'subscription onUpdate'
+  ```
 
 ## \*Express peer dependency
 

package/User.d.mts

@@ -1,4 +1,4 @@
-import type { JwtPayload } from './context.js';
+import type { JwtPayload } from './context.mjs';
 export declare class User {
     readonly token: string;
     readonly claims: JwtPayload;

package/context.d.mts

@@ -1,7 +1,7 @@
 import type { Logger } from '@makerx/node-common';
 import type { Request } from 'express';
-import { type BaseRequestInfo } from './request-info.js';
-import { User } from './User.js';
+import { type BaseRequestInfo } from './request-info.mjs';
+import { User } from './User.mjs';
 export interface GraphQLContext<TLogger extends Logger = Logger, TRequestInfo extends BaseRequestInfo = RequestInfo, TUser = User | undefined> {
     logger: TLogger;
     requestInfo: TRequestInfo;

package/index.d.cts

@@ -1,5 +1,6 @@
 export * from './context';
 export * from './logging';
+export * from './operation';
 export * from './request-info';
 export * from './schema-util';
 export * from './type-utils';

package/index.d.mts

@@ -1,8 +1,9 @@
-export * from './context.js';
-export * from './logging.js';
-export * from './request-info.js';
-export * from './schema-util.js';
-export * from './type-utils.js';
-export * from './unauthorised.js';
-export * from './User.js';
-export * from './utils.js';
+export * from './context.mjs';
+export * from './logging.mjs';
+export * from './operation.mjs';
+export * from './request-info.mjs';
+export * from './schema-util.mjs';
+export * from './type-utils.mjs';
+export * from './unauthorised.mjs';
+export * from './User.mjs';
+export * from './utils.mjs';

package/index.d.ts

@@ -1,5 +1,6 @@
 export * from './context';
 export * from './logging';
+export * from './operation';
 export * from './request-info';
 export * from './schema-util';
 export * from './type-utils';

package/index.js

@@ -2,6 +2,7 @@
 
 var context = require('./context.js');
 var logging = require('./logging.js');
+var operation = require('./operation.js');
 var requestInfo = require('./request-info.js');
 var schemaUtil = require('./schema-util.js');
 var unauthorised = require('./unauthorised.js');
@@ -14,6 +15,8 @@ exports.createContextFactory = context.createContextFactory;
 exports.defaultCreateUser = context.defaultCreateUser;
 exports.logGraphQLOperation = logging.logGraphQLOperation;
 exports.logSubscriptionOperation = logging.logSubscriptionOperation;
+exports.extractAnonymousOperationName = operation.extractAnonymousOperationName;
+exports.isIntrospectionQuery = operation.isIntrospectionQuery;
 exports.buildBaseRequestInfo = requestInfo.buildBaseRequestInfo;
 exports.buildConnectRequestInfo = requestInfo.buildConnectRequestInfo;
 exports.connectRequestBaseUrl = requestInfo.connectRequestBaseUrl;
@@ -23,7 +26,6 @@ exports.permissionInvariant = unauthorised.permissionInvariant;
 exports.throwUnauthorised = unauthorised.throwUnauthorised;
 exports.unauthorisedError = unauthorised.unauthorisedError;
 exports.User = User.User;
-exports.isIntrospectionQuery = utils.isIntrospectionQuery;
 exports.isNil = utils.isNil;
 exports.isNotNil = utils.isNotNil;
 //# sourceMappingURL=index.js.map

package/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;"}
+{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}

package/index.mjs

@@ -1,8 +1,9 @@
 export { createContextFactory, defaultCreateUser } from './context.mjs';
 export { logGraphQLOperation, logSubscriptionOperation } from './logging.mjs';
+export { extractAnonymousOperationName, isIntrospectionQuery } from './operation.mjs';
 export { buildBaseRequestInfo, buildConnectRequestInfo, connectRequestBaseUrl, requestBaseUrl } from './request-info.mjs';
 export { requireExplicitResolversForScalars } from './schema-util.mjs';
 export { permissionInvariant, throwUnauthorised, unauthorisedError } from './unauthorised.mjs';
 export { User } from './User.mjs';
-export { isIntrospectionQuery, isNil, isNotNil } from './utils.mjs';
+export { isNil, isNotNil } from './utils.mjs';
 //# sourceMappingURL=index.mjs.map

package/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;"}
+{"version":3,"file":"index.mjs","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;"}

package/logging.d.mts

@@ -2,7 +2,7 @@ import type { Logger } from '@makerx/node-common';
 import type { ExecutionArgs, GraphQLFormattedError } from 'graphql';
 import { OperationTypeNode } from 'graphql';
 import type { ExecutionResult } from 'graphql-ws';
-import type { GraphQLContext } from './context.js';
+import type { GraphQLContext } from './context.mjs';
 type LogFunction = Logger['info'];
 export type LoggerLogFunctions<T extends Logger> = {
     [Property in keyof T]: LogFunction;

package/logging.js

@@ -1,8 +1,9 @@
 'use strict';
 
 var nodeCommon = require('@makerx/node-common');
-var graphql = require('graphql');
 var compat = require('es-toolkit/compat');
+var graphql = require('graphql');
+var operation = require('./operation.js');
 var utils = require('./utils.js');
 
 /**
@@ -10,7 +11,7 @@ var utils = require('./utils.js');
  * 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 isIntrospection = query && utils.isIntrospectionQuery(query);
+    const isIntrospection = query && operation.isIntrospectionQuery(query);
     if (nodeCommon.isLocalDev && isIntrospection)
         return;
     logger[logLevel](message, compat.omitBy({

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 '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  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":";;;;;;;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,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 { 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;;;;;"}

package/logging.mjs

@@ -1,7 +1,8 @@
 import { isLocalDev } from '@makerx/node-common';
-import { print, OperationTypeNode } from 'graphql';
 import { omitBy } from 'es-toolkit/compat';
-import { isIntrospectionQuery, isNil } from './utils.mjs';
+import { print, OperationTypeNode } from 'graphql';
+import { isIntrospectionQuery } from './operation.mjs';
+import { isNil } from './utils.mjs';
 
 /**
  * Logs a GraphQL operation in a consistent format with the option of including any additional data.

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 '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  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":";;;;;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,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 { 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;;;;"}

package/operation.d.cts

@@ -0,0 +1,2 @@
+export declare function extractAnonymousOperationName(source: string): string | undefined;
+export declare const isIntrospectionQuery: (query?: string) => boolean | undefined;

package/operation.d.mts

@@ -0,0 +1,2 @@
+export declare function extractAnonymousOperationName(source: string): string | undefined;
+export declare const isIntrospectionQuery: (query?: string) => boolean | undefined;

package/operation.d.ts

@@ -0,0 +1,2 @@
+export declare function extractAnonymousOperationName(source: string): string | undefined;
+export declare const isIntrospectionQuery: (query?: string) => boolean | undefined;

package/operation.js

@@ -0,0 +1,17 @@
+'use strict';
+
+const anonOperationMatch = /(query|mutation|subscription)?(\s*)({)(\s*)(\w*)/im;
+function extractAnonymousOperationName(source) {
+    const match = source.match(anonOperationMatch);
+    if (match && match[5]) {
+        const type = match[1] ?? 'query';
+        const name = match[5];
+        return `${type} ${name}`;
+    }
+    return undefined;
+}
+const isIntrospectionQuery = (query) => query?.includes('__schema');
+
+exports.extractAnonymousOperationName = extractAnonymousOperationName;
+exports.isIntrospectionQuery = isIntrospectionQuery;
+//# sourceMappingURL=operation.js.map

package/operation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"operation.js","sources":["../src/operation.ts"],"sourcesContent":["const anonOperationMatch = /(query|mutation|subscription)?(\\s*)({)(\\s*)(\\w*)/im\n\nexport function extractAnonymousOperationName(source: string) {\n  const match = source.match(anonOperationMatch)\n  if (match && match[5]) {\n    const type = match[1] ?? 'query'\n    const name = match[5]\n    return `${type} ${name}`\n  }\n  return undefined\n}\n\nexport const isIntrospectionQuery = (query?: string) => query?.includes('__schema')\n"],"names":[],"mappings":";;AAAA,MAAM,kBAAkB,GAAG,oDAAoD;AAEzE,SAAU,6BAA6B,CAAC,MAAc,EAAA;IAC1D,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,kBAAkB,CAAC;AAC9C,IAAA,IAAI,KAAK,IAAI,KAAK,CAAC,CAAC,CAAC,EAAE;QACrB,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,IAAI,OAAO;AAChC,QAAA,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC;AACrB,QAAA,OAAO,CAAA,EAAG,IAAI,CAAA,CAAA,EAAI,IAAI,EAAE;IAC1B;AACA,IAAA,OAAO,SAAS;AAClB;AAEO,MAAM,oBAAoB,GAAG,CAAC,KAAc,KAAK,KAAK,EAAE,QAAQ,CAAC,UAAU;;;;;"}

package/operation.mjs

@@ -0,0 +1,14 @@
+const anonOperationMatch = /(query|mutation|subscription)?(\s*)({)(\s*)(\w*)/im;
+function extractAnonymousOperationName(source) {
+    const match = source.match(anonOperationMatch);
+    if (match && match[5]) {
+        const type = match[1] ?? 'query';
+        const name = match[5];
+        return `${type} ${name}`;
+    }
+    return undefined;
+}
+const isIntrospectionQuery = (query) => query?.includes('__schema');
+
+export { extractAnonymousOperationName, isIntrospectionQuery };
+//# sourceMappingURL=operation.mjs.map

package/operation.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"operation.mjs","sources":["../src/operation.ts"],"sourcesContent":["const anonOperationMatch = /(query|mutation|subscription)?(\\s*)({)(\\s*)(\\w*)/im\n\nexport function extractAnonymousOperationName(source: string) {\n  const match = source.match(anonOperationMatch)\n  if (match && match[5]) {\n    const type = match[1] ?? 'query'\n    const name = match[5]\n    return `${type} ${name}`\n  }\n  return undefined\n}\n\nexport const isIntrospectionQuery = (query?: string) => query?.includes('__schema')\n"],"names":[],"mappings":"AAAA,MAAM,kBAAkB,GAAG,oDAAoD;AAEzE,SAAU,6BAA6B,CAAC,MAAc,EAAA;IAC1D,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,kBAAkB,CAAC;AAC9C,IAAA,IAAI,KAAK,IAAI,KAAK,CAAC,CAAC,CAAC,EAAE;QACrB,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,IAAI,OAAO;AAChC,QAAA,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC;AACrB,QAAA,OAAO,CAAA,EAAG,IAAI,CAAA,CAAA,EAAI,IAAI,EAAE;IAC1B;AACA,IAAA,OAAO,SAAS;AAClB;AAEO,MAAM,oBAAoB,GAAG,CAAC,KAAc,KAAK,KAAK,EAAE,QAAQ,CAAC,UAAU;;;;"}

package/package.json

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

package/shield.d.mts

@@ -1,7 +1,7 @@
 import type { GraphQLResolveInfo } from 'graphql';
 import type { allow, and, chain, or, race } from 'graphql-shield';
 import { rule, shield } from 'graphql-shield';
-import type { Primitive } from './type-utils.js';
+import type { Primitive } from './type-utils.mjs';
 export type ShieldOptions = NonNullable<Parameters<typeof shield>[1]>;
 type RuleCombinator = typeof chain | typeof race | typeof or | typeof and;
 export type ShieldRule = ReturnType<(typeof allow)['getRules']>[number];

package/subscriptions/context.d.mts

@@ -1,7 +1,7 @@
 import type { Logger } from '@makerx/node-common';
 import type { IncomingMessage } from 'http';
-import { User } from '../User.js';
-import type { CreateRequestLogger, GraphQLContext, JwtPayload, RequestInfo, RequestInfoLogKey } from '../context.js';
+import { User } from '../User.mjs';
+import type { CreateRequestLogger, GraphQLContext, JwtPayload, RequestInfo, RequestInfoLogKey } from '../context.mjs';
 export interface SubscriptionContextInput {
     connectRequest: IncomingMessage;
     connectionParams?: Readonly<Record<string, unknown>>;

package/subscriptions/index.d.cts

@@ -1,3 +1,4 @@
 export * from './context';
+export { wrapSubscriptionIterator } from './subscription-iterator';
 export * from './server';
 export { extractTokenFromConnectionParams } from './utils';

package/subscriptions/index.d.mts

@@ -1,3 +1,4 @@
-export * from './context.js';
-export * from './server.js';
-export { extractTokenFromConnectionParams } from './utils.js';
+export * from './context.mjs';
+export { wrapSubscriptionIterator } from './subscription-iterator.mjs';
+export * from './server.mjs';
+export { extractTokenFromConnectionParams } from './utils.mjs';

package/subscriptions/index.d.ts

@@ -1,3 +1,4 @@
 export * from './context';
+export { wrapSubscriptionIterator } from './subscription-iterator';
 export * from './server';
 export { extractTokenFromConnectionParams } from './utils';

package/subscriptions/index.js

@@ -1,12 +1,14 @@
 'use strict';
 
 var context = require('./context.js');
+var subscriptionIterator = require('./subscription-iterator.js');
 var server = require('./server.js');
 var utils = require('./utils.js');
 
 
 
 exports.createSubscriptionContextFactory = context.createSubscriptionContextFactory;
+exports.wrapSubscriptionIterator = subscriptionIterator.wrapSubscriptionIterator;
 exports.useSubscriptionsServer = server.useSubscriptionsServer;
 exports.extractTokenFromConnectionParams = utils.extractTokenFromConnectionParams;
 //# sourceMappingURL=index.js.map

package/subscriptions/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;"}
+{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;"}

package/subscriptions/index.mjs

@@ -1,4 +1,5 @@
 export { createSubscriptionContextFactory } from './context.mjs';
+export { wrapSubscriptionIterator } from './subscription-iterator.mjs';
 export { useSubscriptionsServer } from './server.mjs';
 export { extractTokenFromConnectionParams } from './utils.mjs';
 //# sourceMappingURL=index.mjs.map

package/subscriptions/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","sources":[],"sourcesContent":[],"names":[],"mappings":";;"}
+{"version":3,"file":"index.mjs","sources":[],"sourcesContent":[],"names":[],"mappings":";;;"}

package/subscriptions/server.d.mts

@@ -1,8 +1,8 @@
 import type { Logger } from '@makerx/node-common';
 import type { GraphQLSchema } from 'graphql';
 import type { Server } from 'http';
-import type { GraphQLContext, JwtPayload } from '../context.js';
-import type { CreateSubscriptionContext } from './context.js';
+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, }: {
     schema: GraphQLSchema;
     httpServer: Server;

package/subscriptions/subscription-iterator.d.cts

@@ -0,0 +1,21 @@
+/**
+ * Wraps an async iterator with options for:
+ *  - returning an initial payload (e.g. current state)
+ *  - eagerly ending iteration when a final event is received
+ *
+ * Providing an initial payload helps avoid race conditions when clients subscribe to events but miss recent state changes,
+ *  by providing an initial payload to be immediately returned, before subsequent events stream in.
+ *
+ * Eagerly ending iteration when a final event ensures subscriptions do not continue unnecessarily.
+ *
+ * @param iterator The async iterator to wrap.
+ * @param initialPayload An optional initial payload to return on the first iteration. May be a single event or an array.
+ * @param eventIsFinal An optional function to determine if an event is final (and iteration should end).
+ *   Note: only applied to events from the wrapped iterator, not to entries in `initialPayload`.
+ * @returns An async iterator for the event data.
+ */
+export declare function wrapSubscriptionIterator<TEventData>({ iterator: wrapped, initialPayload, eventIsFinal, }: {
+    iterator: AsyncIterableIterator<TEventData>;
+    initialPayload?: TEventData | TEventData[];
+    eventIsFinal?: (event: TEventData) => boolean;
+}): AsyncIterator<TEventData> & AsyncIterable<TEventData>;

package/subscriptions/subscription-iterator.d.mts

@@ -0,0 +1,21 @@
+/**
+ * Wraps an async iterator with options for:
+ *  - returning an initial payload (e.g. current state)
+ *  - eagerly ending iteration when a final event is received
+ *
+ * Providing an initial payload helps avoid race conditions when clients subscribe to events but miss recent state changes,
+ *  by providing an initial payload to be immediately returned, before subsequent events stream in.
+ *
+ * Eagerly ending iteration when a final event ensures subscriptions do not continue unnecessarily.
+ *
+ * @param iterator The async iterator to wrap.
+ * @param initialPayload An optional initial payload to return on the first iteration. May be a single event or an array.
+ * @param eventIsFinal An optional function to determine if an event is final (and iteration should end).
+ *   Note: only applied to events from the wrapped iterator, not to entries in `initialPayload`.
+ * @returns An async iterator for the event data.
+ */
+export declare function wrapSubscriptionIterator<TEventData>({ iterator: wrapped, initialPayload, eventIsFinal, }: {
+    iterator: AsyncIterableIterator<TEventData>;
+    initialPayload?: TEventData | TEventData[];
+    eventIsFinal?: (event: TEventData) => boolean;
+}): AsyncIterator<TEventData> & AsyncIterable<TEventData>;

package/subscriptions/subscription-iterator.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Wraps an async iterator with options for:
+ *  - returning an initial payload (e.g. current state)
+ *  - eagerly ending iteration when a final event is received
+ *
+ * Providing an initial payload helps avoid race conditions when clients subscribe to events but miss recent state changes,
+ *  by providing an initial payload to be immediately returned, before subsequent events stream in.
+ *
+ * Eagerly ending iteration when a final event ensures subscriptions do not continue unnecessarily.
+ *
+ * @param iterator The async iterator to wrap.
+ * @param initialPayload An optional initial payload to return on the first iteration. May be a single event or an array.
+ * @param eventIsFinal An optional function to determine if an event is final (and iteration should end).
+ *   Note: only applied to events from the wrapped iterator, not to entries in `initialPayload`.
+ * @returns An async iterator for the event data.
+ */
+export declare function wrapSubscriptionIterator<TEventData>({ iterator: wrapped, initialPayload, eventIsFinal, }: {
+    iterator: AsyncIterableIterator<TEventData>;
+    initialPayload?: TEventData | TEventData[];
+    eventIsFinal?: (event: TEventData) => boolean;
+}): AsyncIterator<TEventData> & AsyncIterable<TEventData>;

package/subscriptions/subscription-iterator.js

@@ -0,0 +1,56 @@
+'use strict';
+
+/**
+ * Wraps an async iterator with options for:
+ *  - returning an initial payload (e.g. current state)
+ *  - eagerly ending iteration when a final event is received
+ *
+ * Providing an initial payload helps avoid race conditions when clients subscribe to events but miss recent state changes,
+ *  by providing an initial payload to be immediately returned, before subsequent events stream in.
+ *
+ * Eagerly ending iteration when a final event ensures subscriptions do not continue unnecessarily.
+ *
+ * @param iterator The async iterator to wrap.
+ * @param initialPayload An optional initial payload to return on the first iteration. May be a single event or an array.
+ * @param eventIsFinal An optional function to determine if an event is final (and iteration should end).
+ *   Note: only applied to events from the wrapped iterator, not to entries in `initialPayload`.
+ * @returns An async iterator for the event data.
+ */
+function wrapSubscriptionIterator({ iterator: wrapped, initialPayload, eventIsFinal, }) {
+    let done = false;
+    const initialQueue = initialPayload === undefined ? [] : Array.isArray(initialPayload) ? [...initialPayload] : [initialPayload];
+    const iterator = {
+        next: async () => {
+            if (done)
+                return { done: true, value: undefined };
+            if (initialQueue.length > 0) {
+                const value = initialQueue.shift();
+                return { done: false, value };
+            }
+            const next = await wrapped.next();
+            if (!next.done && eventIsFinal && eventIsFinal(next.value)) {
+                done = true;
+                await wrapped.return?.();
+            }
+            return next;
+        },
+        return: async (value) => {
+            done = true;
+            initialQueue.length = 0;
+            if (wrapped.return)
+                return wrapped.return(value);
+            return { done: true, value: value };
+        },
+        throw: async (err) => {
+            done = true;
+            initialQueue.length = 0;
+            if (wrapped.throw)
+                return wrapped.throw(err);
+            throw err;
+        },
+    };
+    return { ...iterator, [Symbol.asyncIterator]: () => iterator };
+}
+
+exports.wrapSubscriptionIterator = wrapSubscriptionIterator;
+//# sourceMappingURL=subscription-iterator.js.map

package/subscriptions/subscription-iterator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"subscription-iterator.js","sources":["../../src/subscriptions/subscription-iterator.ts"],"sourcesContent":["/**\n * Wraps an async iterator with options for:\n *  - returning an initial payload (e.g. current state)\n *  - eagerly ending iteration when a final event is received\n *\n * Providing an initial payload helps avoid race conditions when clients subscribe to events but miss recent state changes,\n *  by providing an initial payload to be immediately returned, before subsequent events stream in.\n *\n * Eagerly ending iteration when a final event ensures subscriptions do not continue unnecessarily.\n *\n * @param iterator The async iterator to wrap.\n * @param initialPayload An optional initial payload to return on the first iteration. May be a single event or an array.\n * @param eventIsFinal An optional function to determine if an event is final (and iteration should end).\n *   Note: only applied to events from the wrapped iterator, not to entries in `initialPayload`.\n * @returns An async iterator for the event data.\n */\nexport function wrapSubscriptionIterator<TEventData>({\n  iterator: wrapped,\n  initialPayload,\n  eventIsFinal,\n}: {\n  iterator: AsyncIterableIterator<TEventData>\n  initialPayload?: TEventData | TEventData[]\n  eventIsFinal?: (event: TEventData) => boolean\n}): AsyncIterator<TEventData> & AsyncIterable<TEventData> {\n  let done = false\n  const initialQueue: TEventData[] =\n    initialPayload === undefined ? [] : Array.isArray(initialPayload) ? [...initialPayload] : [initialPayload]\n\n  const iterator: AsyncIterator<TEventData> = {\n    next: async () => {\n      if (done) return { done: true, value: undefined }\n\n      if (initialQueue.length > 0) {\n        const value = initialQueue.shift() as TEventData\n        return { done: false, value }\n      }\n\n      const next = await wrapped.next()\n      if (!next.done && eventIsFinal && eventIsFinal(next.value)) {\n        done = true\n        await wrapped.return?.()\n      }\n      return next\n    },\n    return: async (value) => {\n      done = true\n      initialQueue.length = 0\n      if (wrapped.return) return wrapped.return(value)\n      return { done: true, value: value as TEventData }\n    },\n    throw: async (err) => {\n      done = true\n      initialQueue.length = 0\n      if (wrapped.throw) return wrapped.throw(err)\n      throw err\n    },\n  }\n\n  return { ...iterator, [Symbol.asyncIterator]: () => iterator }\n}\n"],"names":[],"mappings":";;AAAA;;;;;;;;;;;;;;;AAeG;AACG,SAAU,wBAAwB,CAAa,EACnD,QAAQ,EAAE,OAAO,EACjB,cAAc,EACd,YAAY,GAKb,EAAA;IACC,IAAI,IAAI,GAAG,KAAK;AAChB,IAAA,MAAM,YAAY,GAChB,cAAc,KAAK,SAAS,GAAG,EAAE,GAAG,KAAK,CAAC,OAAO,CAAC,cAAc,CAAC,GAAG,CAAC,GAAG,cAAc,CAAC,GAAG,CAAC,cAAc,CAAC;AAE5G,IAAA,MAAM,QAAQ,GAA8B;QAC1C,IAAI,EAAE,YAAW;AACf,YAAA,IAAI,IAAI;gBAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,SAAS,EAAE;AAEjD,YAAA,IAAI,YAAY,CAAC,MAAM,GAAG,CAAC,EAAE;AAC3B,gBAAA,MAAM,KAAK,GAAG,YAAY,CAAC,KAAK,EAAgB;AAChD,gBAAA,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE;YAC/B;AAEA,YAAA,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,IAAI,EAAE;AACjC,YAAA,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,YAAY,IAAI,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE;gBAC1D,IAAI,GAAG,IAAI;AACX,gBAAA,MAAM,OAAO,CAAC,MAAM,IAAI;YAC1B;AACA,YAAA,OAAO,IAAI;QACb,CAAC;AACD,QAAA,MAAM,EAAE,OAAO,KAAK,KAAI;YACtB,IAAI,GAAG,IAAI;AACX,YAAA,YAAY,CAAC,MAAM,GAAG,CAAC;YACvB,IAAI,OAAO,CAAC,MAAM;AAAE,gBAAA,OAAO,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC;YAChD,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,KAAmB,EAAE;QACnD,CAAC;AACD,QAAA,KAAK,EAAE,OAAO,GAAG,KAAI;YACnB,IAAI,GAAG,IAAI;AACX,YAAA,YAAY,CAAC,MAAM,GAAG,CAAC;YACvB,IAAI,OAAO,CAAC,KAAK;AAAE,gBAAA,OAAO,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC;AAC5C,YAAA,MAAM,GAAG;QACX,CAAC;KACF;AAED,IAAA,OAAO,EAAE,GAAG,QAAQ,EAAE,CAAC,MAAM,CAAC,aAAa,GAAG,MAAM,QAAQ,EAAE;AAChE;;;;"}

package/subscriptions/subscription-iterator.mjs

@@ -0,0 +1,54 @@
+/**
+ * Wraps an async iterator with options for:
+ *  - returning an initial payload (e.g. current state)
+ *  - eagerly ending iteration when a final event is received
+ *
+ * Providing an initial payload helps avoid race conditions when clients subscribe to events but miss recent state changes,
+ *  by providing an initial payload to be immediately returned, before subsequent events stream in.
+ *
+ * Eagerly ending iteration when a final event ensures subscriptions do not continue unnecessarily.
+ *
+ * @param iterator The async iterator to wrap.
+ * @param initialPayload An optional initial payload to return on the first iteration. May be a single event or an array.
+ * @param eventIsFinal An optional function to determine if an event is final (and iteration should end).
+ *   Note: only applied to events from the wrapped iterator, not to entries in `initialPayload`.
+ * @returns An async iterator for the event data.
+ */
+function wrapSubscriptionIterator({ iterator: wrapped, initialPayload, eventIsFinal, }) {
+    let done = false;
+    const initialQueue = initialPayload === undefined ? [] : Array.isArray(initialPayload) ? [...initialPayload] : [initialPayload];
+    const iterator = {
+        next: async () => {
+            if (done)
+                return { done: true, value: undefined };
+            if (initialQueue.length > 0) {
+                const value = initialQueue.shift();
+                return { done: false, value };
+            }
+            const next = await wrapped.next();
+            if (!next.done && eventIsFinal && eventIsFinal(next.value)) {
+                done = true;
+                await wrapped.return?.();
+            }
+            return next;
+        },
+        return: async (value) => {
+            done = true;
+            initialQueue.length = 0;
+            if (wrapped.return)
+                return wrapped.return(value);
+            return { done: true, value: value };
+        },
+        throw: async (err) => {
+            done = true;
+            initialQueue.length = 0;
+            if (wrapped.throw)
+                return wrapped.throw(err);
+            throw err;
+        },
+    };
+    return { ...iterator, [Symbol.asyncIterator]: () => iterator };
+}
+
+export { wrapSubscriptionIterator };
+//# sourceMappingURL=subscription-iterator.mjs.map

package/subscriptions/subscription-iterator.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"subscription-iterator.mjs","sources":["../../src/subscriptions/subscription-iterator.ts"],"sourcesContent":["/**\n * Wraps an async iterator with options for:\n *  - returning an initial payload (e.g. current state)\n *  - eagerly ending iteration when a final event is received\n *\n * Providing an initial payload helps avoid race conditions when clients subscribe to events but miss recent state changes,\n *  by providing an initial payload to be immediately returned, before subsequent events stream in.\n *\n * Eagerly ending iteration when a final event ensures subscriptions do not continue unnecessarily.\n *\n * @param iterator The async iterator to wrap.\n * @param initialPayload An optional initial payload to return on the first iteration. May be a single event or an array.\n * @param eventIsFinal An optional function to determine if an event is final (and iteration should end).\n *   Note: only applied to events from the wrapped iterator, not to entries in `initialPayload`.\n * @returns An async iterator for the event data.\n */\nexport function wrapSubscriptionIterator<TEventData>({\n  iterator: wrapped,\n  initialPayload,\n  eventIsFinal,\n}: {\n  iterator: AsyncIterableIterator<TEventData>\n  initialPayload?: TEventData | TEventData[]\n  eventIsFinal?: (event: TEventData) => boolean\n}): AsyncIterator<TEventData> & AsyncIterable<TEventData> {\n  let done = false\n  const initialQueue: TEventData[] =\n    initialPayload === undefined ? [] : Array.isArray(initialPayload) ? [...initialPayload] : [initialPayload]\n\n  const iterator: AsyncIterator<TEventData> = {\n    next: async () => {\n      if (done) return { done: true, value: undefined }\n\n      if (initialQueue.length > 0) {\n        const value = initialQueue.shift() as TEventData\n        return { done: false, value }\n      }\n\n      const next = await wrapped.next()\n      if (!next.done && eventIsFinal && eventIsFinal(next.value)) {\n        done = true\n        await wrapped.return?.()\n      }\n      return next\n    },\n    return: async (value) => {\n      done = true\n      initialQueue.length = 0\n      if (wrapped.return) return wrapped.return(value)\n      return { done: true, value: value as TEventData }\n    },\n    throw: async (err) => {\n      done = true\n      initialQueue.length = 0\n      if (wrapped.throw) return wrapped.throw(err)\n      throw err\n    },\n  }\n\n  return { ...iterator, [Symbol.asyncIterator]: () => iterator }\n}\n"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;AAeG;AACG,SAAU,wBAAwB,CAAa,EACnD,QAAQ,EAAE,OAAO,EACjB,cAAc,EACd,YAAY,GAKb,EAAA;IACC,IAAI,IAAI,GAAG,KAAK;AAChB,IAAA,MAAM,YAAY,GAChB,cAAc,KAAK,SAAS,GAAG,EAAE,GAAG,KAAK,CAAC,OAAO,CAAC,cAAc,CAAC,GAAG,CAAC,GAAG,cAAc,CAAC,GAAG,CAAC,cAAc,CAAC;AAE5G,IAAA,MAAM,QAAQ,GAA8B;QAC1C,IAAI,EAAE,YAAW;AACf,YAAA,IAAI,IAAI;gBAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,SAAS,EAAE;AAEjD,YAAA,IAAI,YAAY,CAAC,MAAM,GAAG,CAAC,EAAE;AAC3B,gBAAA,MAAM,KAAK,GAAG,YAAY,CAAC,KAAK,EAAgB;AAChD,gBAAA,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE;YAC/B;AAEA,YAAA,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,IAAI,EAAE;AACjC,YAAA,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,YAAY,IAAI,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE;gBAC1D,IAAI,GAAG,IAAI;AACX,gBAAA,MAAM,OAAO,CAAC,MAAM,IAAI;YAC1B;AACA,YAAA,OAAO,IAAI;QACb,CAAC;AACD,QAAA,MAAM,EAAE,OAAO,KAAK,KAAI;YACtB,IAAI,GAAG,IAAI;AACX,YAAA,YAAY,CAAC,MAAM,GAAG,CAAC;YACvB,IAAI,OAAO,CAAC,MAAM;AAAE,gBAAA,OAAO,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC;YAChD,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,KAAmB,EAAE;QACnD,CAAC;AACD,QAAA,KAAK,EAAE,OAAO,GAAG,KAAI;YACnB,IAAI,GAAG,IAAI;AACX,YAAA,YAAY,CAAC,MAAM,GAAG,CAAC;YACvB,IAAI,OAAO,CAAC,KAAK;AAAE,gBAAA,OAAO,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC;AAC5C,YAAA,MAAM,GAAG;QACX,CAAC;KACF;AAED,IAAA,OAAO,EAAE,GAAG,QAAQ,EAAE,CAAC,MAAM,CAAC,aAAa,GAAG,MAAM,QAAQ,EAAE;AAChE;;;;"}

package/utils.d.cts

@@ -1,3 +1,2 @@
-export declare const isIntrospectionQuery: (query?: string) => boolean | undefined;
 export declare const isNil: (value: unknown) => value is null | undefined;
 export declare const isNotNil: <T>(value: T) => value is Exclude<T, undefined | null>;

package/utils.d.mts

@@ -1,3 +1,2 @@
-export declare const isIntrospectionQuery: (query?: string) => boolean | undefined;
 export declare const isNil: (value: unknown) => value is null | undefined;
 export declare const isNotNil: <T>(value: T) => value is Exclude<T, undefined | null>;

package/utils.d.ts

@@ -1,3 +1,2 @@
-export declare const isIntrospectionQuery: (query?: string) => boolean | undefined;
 export declare const isNil: (value: unknown) => value is null | undefined;
 export declare const isNotNil: <T>(value: T) => value is Exclude<T, undefined | null>;

package/utils.js

@@ -1,10 +1,8 @@
 'use strict';
 
-const isIntrospectionQuery = (query) => query?.includes('__schema');
 const isNil = (value) => value === null || value === undefined;
 const isNotNil = (value) => !isNil(value);
 
-exports.isIntrospectionQuery = isIntrospectionQuery;
 exports.isNil = isNil;
 exports.isNotNil = isNotNil;
 //# sourceMappingURL=utils.js.map

package/utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"utils.js","sources":["../src/utils.ts"],"sourcesContent":["export const isIntrospectionQuery = (query?: string) => query?.includes('__schema')\nexport const isNil = (value: unknown): value is null | undefined => value === null || value === undefined\nexport const isNotNil = <T>(value: T): value is Exclude<T, undefined | null> => !isNil(value)\n"],"names":[],"mappings":";;AAAO,MAAM,oBAAoB,GAAG,CAAC,KAAc,KAAK,KAAK,EAAE,QAAQ,CAAC,UAAU;AAC3E,MAAM,KAAK,GAAG,CAAC,KAAc,KAAgC,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK;AACzF,MAAM,QAAQ,GAAG,CAAI,KAAQ,KAA4C,CAAC,KAAK,CAAC,KAAK;;;;;;"}
+{"version":3,"file":"utils.js","sources":["../src/utils.ts"],"sourcesContent":["export const isNil = (value: unknown): value is null | undefined => value === null || value === undefined\nexport const isNotNil = <T>(value: T): value is Exclude<T, undefined | null> => !isNil(value)\n"],"names":[],"mappings":";;AAAO,MAAM,KAAK,GAAG,CAAC,KAAc,KAAgC,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK;AACzF,MAAM,QAAQ,GAAG,CAAI,KAAQ,KAA4C,CAAC,KAAK,CAAC,KAAK;;;;;"}

package/utils.mjs

@@ -1,6 +1,5 @@
-const isIntrospectionQuery = (query) => query?.includes('__schema');
 const isNil = (value) => value === null || value === undefined;
 const isNotNil = (value) => !isNil(value);
 
-export { isIntrospectionQuery, isNil, isNotNil };
+export { isNil, isNotNil };
 //# sourceMappingURL=utils.mjs.map

package/utils.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"utils.mjs","sources":["../src/utils.ts"],"sourcesContent":["export const isIntrospectionQuery = (query?: string) => query?.includes('__schema')\nexport const isNil = (value: unknown): value is null | undefined => value === null || value === undefined\nexport const isNotNil = <T>(value: T): value is Exclude<T, undefined | null> => !isNil(value)\n"],"names":[],"mappings":"AAAO,MAAM,oBAAoB,GAAG,CAAC,KAAc,KAAK,KAAK,EAAE,QAAQ,CAAC,UAAU;AAC3E,MAAM,KAAK,GAAG,CAAC,KAAc,KAAgC,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK;AACzF,MAAM,QAAQ,GAAG,CAAI,KAAQ,KAA4C,CAAC,KAAK,CAAC,KAAK;;;;"}
+{"version":3,"file":"utils.mjs","sources":["../src/utils.ts"],"sourcesContent":["export const isNil = (value: unknown): value is null | undefined => value === null || value === undefined\nexport const isNotNil = <T>(value: T): value is Exclude<T, undefined | null> => !isNil(value)\n"],"names":[],"mappings":"AAAO,MAAM,KAAK,GAAG,CAAC,KAAc,KAAgC,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK;AACzF,MAAM,QAAQ,GAAG,CAAI,KAAQ,KAA4C,CAAC,KAAK,CAAC,KAAK;;;;"}