@makerx/graphql-core 3.3.0 → 3.5.0

package/README.md

@@ -137,15 +137,15 @@ By default, if `claims` (decoded token `JwtPayload`) are available, the `GraphQL
 
 The User class adds some handy getters over raw claims (decodedJWT payload) and provides access to the JWT (access token) for on-behalf-of downstream authentication flows. Note this may represent a user or service principal (system) identity.
 
-| Property | Description                                                                                                         |
-| -------- | ------------------------------------------------------------------------------------------------------------------- |
-| claims   | The decoded JWT payload, set via the RequestInput.user field.                                                       |
-| token    | The bearer token from the request authorization header.                                                             |
-| email    | The user's email via coalesced claim values: email, emails, preferred_username, unique_name, upn.                   |
-| name     | The user's name (via the name or given_name and family_name claims).                                                |
-| id       | The user's unique and immutable ID, useful for contextual differentiation e.g. session keys (the oid or sub claim). |
-| scopes   | The user's scopes, via the scp claim split into an array of scopes.                                                 |
-| roles    | The user's roles (via the roles claim).                                                                             |
+| Property | Description                                                                                                                 |
+| -------- | --------------------------------------------------------------------------------------------------------------------------- |
+| claims   | The decoded JWT payload, set via the RequestInput.user field.                                                               |
+| token    | The access token. By default, the bearer token from the `Authorization` header (see [Token extraction](#token-extraction)). |
+| email    | The user's email via coalesced claim values: email, emails, preferred_username, unique_name, upn.                           |
+| name     | The user's name (via the name or given_name and family_name claims).                                                        |
+| id       | The user's unique and immutable ID, useful for contextual differentiation e.g. session keys (the oid or sub claim).         |
+| scopes   | The user's scopes, via the scp claim split into an array of scopes.                                                         |
+| roles    | The user's roles (via the roles claim).                                                                                     |
 
 ### Custom user
 
@@ -163,6 +163,19 @@ const graphqlServer = createServer({
 })
 ```
 
+### Token extraction
+
+The default `createUser` sets `User.token` to the bearer token from the `Authorization` header. If clients authenticate another way, for example with a JWT assertion header that a proxy adds to the request, supply `extractToken` to return the token:
+
+```ts
+const createContext = createContextFactory({
+  requestLogger,
+  extractToken: ({ req }) => req.headers['x-goog-iap-jwt-assertion'] as string | undefined,
+})
+```
+
+`extractToken` is not called when you supply `createUser`. For subscriptions, see [GraphQL subscriptions](#graphql-subscriptions).
+
 ## Shield (authorization)
 
 The `shield` module provides typed helpers around [graphql-shield](https://the-guild.dev/graphql/shield) for defining authorization middleware against your generated `Resolvers` type.
@@ -363,12 +376,30 @@ This library includes a `subscriptions` module to provide simple setup using the
 1. Create a subscriptions server, using the ws-server cleanup function in your server lifecycle.
 
    The `useSubscriptionsServer` function sets up:
-   - Auth token validation as part of establishing (or rejecting) the connection (behaviour defined by `verifyToken` and `requireAuth` args)
+   - Auth token validation as part of establishing (or rejecting) the connection (behaviour defined by `verifyToken`, `extractToken` and `requireAuth` args)
    - GraphQL context creation
    - Logging from the server `onConnect`, `onDisconnect`, `onOperation`, `onNext` and `onError` callbacks
 
    Pass `includeDeprecatedElements: true` to add [deprecation usage](#collectdeprecatedelementusage) to the operation log entry as `deprecatedElements`. It is collected once, when the subscription is established, rather than per emitted payload — the usage is a property of the operation, not of each event.
 
+   By default a connection's token is verified when the connection is established, and again each time the client subscribes on it. A token that no longer verifies then closes the connection with `4403 Forbidden`, and the operation is not run. Subscriptions already running continue until that happens.
+
+   To give connections a set lifetime instead, pass `connectionExpiry`. It receives the claims `verifyToken` returned and returns the time the connection ends, in milliseconds since the epoch (or `undefined` for the default behaviour). At that time the connection is closed with `4403`, which ends every subscription running on it, and a time already past refuses the connection. Until then the client may subscribe again without the token being verified again: a connection's token cannot change.
+
+   ```ts
+   // End each connection when its token expires
+   connectionExpiry: (claims) => (claims.exp === undefined ? undefined : claims.exp * 1000)
+
+   // A short-lived token (such as a proxy's assertion) that proves a longer session: connections last an hour from when the token was issued
+   connectionExpiry: (claims) => (claims.iat === undefined ? undefined : (claims.iat + 3600) * 1000)
+   ```
+
+   With a lifetime longer than the token's, a revoked session is noticed only when the connection ends.
+
+   graphql-ws clients retry `4403` by default, but a retry succeeds only with a fresh token: pass `connectionParams` to `createClient` as a function that returns a current token, or authenticate the upgrade request afresh (by a cookie and a proxy, for example). A client that sends the same expired token fails again until its `retryAttempts` run out, and its subscriptions then end with an error.
+
+   `keepAlive` sets the milliseconds between the server's websocket pings (default 12 seconds, graphql-ws's default; `0` turns them off). A connection that has not answered a ping by the time the next one is due is terminated. The pings also stop proxies and load balancers from closing an idle connection, so keep the interval below their idle timeouts.
+
    Example for Apollo Server (`wsServerCleanup` called in the `drainServer` plugin callback):
 
    ```ts
@@ -400,6 +431,17 @@ 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.
 
+   If the token arrives another way, supply an `extractToken` function to both `useSubscriptionsServer` (which passes the token to `verifyToken`) and `createSubscriptionContextFactory` (which sets it as `User.token`). It receives the `connectRequest` (the HTTP upgrade request) and the `connectionParams`, and returns the token or `undefined`. For example, to read a JWT assertion header that a proxy adds to the upgrade request (browsers cannot set custom headers on a websocket request):
+
+   ```ts
+   const extractToken: ExtractSubscriptionToken = ({ connectRequest }) =>
+     connectRequest.headers['x-goog-iap-jwt-assertion'] as string | undefined
+
+   const createSubscriptionContext = createSubscriptionContextFactory({ requestLogger, extractToken })
+
+   useSubscriptionsServer({ schema, httpServer, logger, createSubscriptionContext, extractToken, requireAuth: true, verifyToken })
+   ```
+
 ### wrapSubscriptionIterator
 
 Wraps an `AsyncIterableIterator` (e.g. one returned by a pubsub `asyncIterableIterator(...)` call) with two optional behaviours:

package/context.d.cts

@@ -51,12 +51,19 @@ export interface ContextInput {
 export type CreateContext<TContext = GraphQLContext> = (input: ContextInput) => Promise<TContext>;
 export type CreateRequestLogger<TUser = User | undefined, TLogger extends Logger = Logger> = (requestMetadata: Record<string, unknown>, user: TUser) => TLogger;
 export type AugmentRequestInfo = (input: ContextInput) => Record<string, unknown>;
+export type ExtractToken = (input: ContextInput) => string | undefined;
 export type CreateContextConfig<TUser = User | undefined, TAugment extends Record<string, unknown> = Record<string, never>, TLogger extends Logger = Logger> = {
     requestLogger: CreateRequestLogger<TUser, TLogger> | TLogger;
     augmentRequestInfo?: AugmentRequestInfo;
     claimsToLog?: string[];
     requestInfoToLog?: Array<RequestInfoLogKey>;
     augmentContext?: (context: GraphQLContext<TLogger, RequestInfo, TUser>) => TAugment | Promise<TAugment>;
+    /**
+     * Returns the token that the default `createUser` sets as `User.token`, e.g. from a JWT assertion
+     * header. Not called when you supply `createUser`. Defaults to the bearer token in the
+     * `Authorization` header.
+     */
+    extractToken?: ExtractToken;
 } & ([User | undefined] extends [TUser] ? {
     createUser?: CreateUser<TUser>;
 } : {

package/context.d.mts

@@ -51,12 +51,19 @@ export interface ContextInput {
 export type CreateContext<TContext = GraphQLContext> = (input: ContextInput) => Promise<TContext>;
 export type CreateRequestLogger<TUser = User | undefined, TLogger extends Logger = Logger> = (requestMetadata: Record<string, unknown>, user: TUser) => TLogger;
 export type AugmentRequestInfo = (input: ContextInput) => Record<string, unknown>;
+export type ExtractToken = (input: ContextInput) => string | undefined;
 export type CreateContextConfig<TUser = User | undefined, TAugment extends Record<string, unknown> = Record<string, never>, TLogger extends Logger = Logger> = {
     requestLogger: CreateRequestLogger<TUser, TLogger> | TLogger;
     augmentRequestInfo?: AugmentRequestInfo;
     claimsToLog?: string[];
     requestInfoToLog?: Array<RequestInfoLogKey>;
     augmentContext?: (context: GraphQLContext<TLogger, RequestInfo, TUser>) => TAugment | Promise<TAugment>;
+    /**
+     * Returns the token that the default `createUser` sets as `User.token`, e.g. from a JWT assertion
+     * header. Not called when you supply `createUser`. Defaults to the bearer token in the
+     * `Authorization` header.
+     */
+    extractToken?: ExtractToken;
 } & ([User | undefined] extends [TUser] ? {
     createUser?: CreateUser<TUser>;
 } : {

package/context.d.ts

@@ -51,12 +51,19 @@ export interface ContextInput {
 export type CreateContext<TContext = GraphQLContext> = (input: ContextInput) => Promise<TContext>;
 export type CreateRequestLogger<TUser = User | undefined, TLogger extends Logger = Logger> = (requestMetadata: Record<string, unknown>, user: TUser) => TLogger;
 export type AugmentRequestInfo = (input: ContextInput) => Record<string, unknown>;
+export type ExtractToken = (input: ContextInput) => string | undefined;
 export type CreateContextConfig<TUser = User | undefined, TAugment extends Record<string, unknown> = Record<string, never>, TLogger extends Logger = Logger> = {
     requestLogger: CreateRequestLogger<TUser, TLogger> | TLogger;
     augmentRequestInfo?: AugmentRequestInfo;
     claimsToLog?: string[];
     requestInfoToLog?: Array<RequestInfoLogKey>;
     augmentContext?: (context: GraphQLContext<TLogger, RequestInfo, TUser>) => TAugment | Promise<TAugment>;
+    /**
+     * Returns the token that the default `createUser` sets as `User.token`, e.g. from a JWT assertion
+     * header. Not called when you supply `createUser`. Defaults to the bearer token in the
+     * `Authorization` header.
+     */
+    extractToken?: ExtractToken;
 } & ([User | undefined] extends [TUser] ? {
     createUser?: CreateUser<TUser>;
 } : {

package/context.js

@@ -8,7 +8,7 @@ const createContextFactory = (config) => {
     const { requestLogger, augmentRequestInfo, claimsToLog, requestInfoToLog, augmentContext } = config;
     // The conditional type on CreateContextConfig guarantees `createUser` is provided when TUser is
     // narrower than `User | undefined`, so defaulting to defaultCreateUser is sound here.
-    const createUser = (config.createUser ?? defaultCreateUser);
+    const createUser = (config.createUser ?? buildDefaultCreateUser(config.extractToken ?? defaultExtractToken));
     return async (input) => {
         const { req, claims, context } = input;
         // build base request info from the request
@@ -57,12 +57,13 @@ const createContextFactory = (config) => {
         return augmentedGraphQLContext;
     };
 };
-const defaultCreateUser = ({ req, claims }) => {
-    if (!claims)
+const defaultExtractToken = ({ req }) => req.headers.authorization?.startsWith('Bearer') ? req.headers.authorization.substring(7) : undefined;
+const buildDefaultCreateUser = (extractToken) => (input) => {
+    if (!input.claims)
         return Promise.resolve(undefined);
-    const accessToken = req.headers.authorization?.startsWith('Bearer') ? (req.headers.authorization?.substring(7) ?? '') : '';
-    return Promise.resolve(new User.User(claims, accessToken));
+    return Promise.resolve(new User.User(input.claims, extractToken(input) ?? ''));
 };
+const defaultCreateUser = buildDefaultCreateUser(defaultExtractToken);
 
 exports.createContextFactory = createContextFactory;
 exports.defaultCreateUser = defaultCreateUser;

package/context.js.map

@@ -1 +1 @@
-{"version":3,"file":"context.js","sources":["../src/context.ts"],"sourcesContent":["import type { Logger } from '@makerx/node-common'\nimport { pick } from 'es-toolkit/compat'\nimport type { Request } from 'express'\nimport { buildBaseRequestInfo, type BaseRequestInfo } from './request-info'\nimport { User } from './User'\n\nexport interface GraphQLContext<\n  TLogger extends Logger = Logger,\n  TRequestInfo extends BaseRequestInfo = RequestInfo,\n  TUser = User | undefined,\n> {\n  logger: TLogger\n  requestInfo: TRequestInfo\n  user: TUser\n  started: number\n}\n\nexport type AnyGraphqlContext = GraphQLContext<any, any, any>\n\nexport interface LambdaContext {\n  functionName?: string\n  awsRequestId?: string\n}\nexport type LambdaEvent = never\nexport type LambdaRequestInfo = BaseRequestInfo & LambdaContext\nexport type RequestInfo = BaseRequestInfo | LambdaRequestInfo\n\n// Strips the `[key: string]: unknown` index signature so `keyof` returns only the declared keys.\ntype KnownKeys<T> = keyof {\n  [K in keyof T as string extends K ? never : number extends K ? never : K]: T[K]\n}\n// Known keys for autocomplete, plus `(string & {})` to keep arbitrary augmented fields assignable.\nexport type RequestInfoLogKey = KnownKeys<BaseRequestInfo> | keyof LambdaContext | (string & {})\n\n// standard claims https://datatracker.ietf.org/doc/html/rfc7519#section-4.1\nexport interface JwtPayload {\n  [key: string]: unknown\n  name?: string | undefined\n  email?: string | undefined\n  given_name?: string | undefined\n  family_name?: string | undefined\n  preferred_username?: string | undefined\n  upn?: string | undefined\n  unique_name?: string | undefined\n  oid?: string | undefined\n  iss?: string | undefined\n  sub?: string | undefined\n  aud?: string | string[] | undefined\n  roles?: string[] | undefined\n  scp?: string | undefined\n  exp?: number | undefined\n  nbf?: number | undefined\n  iat?: number | undefined\n  jti?: string | undefined\n}\n\nexport type InferUserFromContext<TContext extends AnyGraphqlContext> =\n  TContext extends GraphQLContext<any, any, infer TUser> ? TUser : never\nexport type CreateUser<T = User | undefined> = (input: Omit<ContextInput, 'createUser'>) => Promise<T> | T\nexport interface ContextInput {\n  req: Request\n  claims?: JwtPayload\n  context?: LambdaContext\n  event?: LambdaEvent\n}\nexport type CreateContext<TContext = GraphQLContext> = (input: ContextInput) => Promise<TContext>\nexport type CreateRequestLogger<TUser = User | undefined, TLogger extends Logger = Logger> = (\n  requestMetadata: Record<string, unknown>,\n  user: TUser,\n) => TLogger\nexport type AugmentRequestInfo = (input: ContextInput) => Record<string, unknown>\n\n// `createUser` is optional when TUser is compatible with the default `User | undefined`\n// (i.e. `defaultCreateUser` can satisfy it), and required when TUser is narrower.\nexport type CreateContextConfig<\n  TUser = User | undefined,\n  TAugment extends Record<string, unknown> = Record<string, never>,\n  TLogger extends Logger = Logger,\n> = {\n  requestLogger: CreateRequestLogger<TUser, TLogger> | TLogger\n  augmentRequestInfo?: AugmentRequestInfo\n  claimsToLog?: string[]\n  requestInfoToLog?: Array<RequestInfoLogKey>\n  augmentContext?: (context: GraphQLContext<TLogger, RequestInfo, TUser>) => TAugment | Promise<TAugment>\n} & ([User | undefined] extends [TUser] ? { createUser?: CreateUser<TUser> } : { createUser: CreateUser<TUser> })\n\nexport const createContextFactory = <\n  TUser = User | undefined,\n  TAugment extends Record<string, unknown> = Record<string, never>,\n  TLogger extends Logger = Logger,\n>(\n  config: CreateContextConfig<TUser, TAugment, TLogger>,\n): CreateContext<GraphQLContext<TLogger, RequestInfo, TUser> & TAugment> => {\n  const { requestLogger, augmentRequestInfo, claimsToLog, requestInfoToLog, augmentContext } = config\n  // The conditional type on CreateContextConfig guarantees `createUser` is provided when TUser is\n  // narrower than `User | undefined`, so defaulting to defaultCreateUser is sound here.\n  const createUser = (config.createUser ?? defaultCreateUser) as CreateUser<TUser>\n\n  return async (input: ContextInput) => {\n    const { req, claims, context } = input\n\n    // build base request info from the request\n    const baseRequestInfo: BaseRequestInfo = buildBaseRequestInfo(req)\n\n    // add lambda info from the context, if present\n    let lambdaRequestInfo: LambdaRequestInfo | undefined\n    if (context) {\n      const { awsRequestId, functionName } = context\n      lambdaRequestInfo = {\n        awsRequestId,\n        functionName,\n        ...baseRequestInfo,\n      }\n    }\n\n    // augment request info with the supplied function, if present\n    let requestInfo: RequestInfo = lambdaRequestInfo ?? baseRequestInfo\n    if (augmentRequestInfo)\n      requestInfo = {\n        ...requestInfo,\n        ...augmentRequestInfo(input),\n      }\n\n    const user = await createUser(input)\n\n    // create request logger\n    let logger: TLogger\n    if (typeof requestLogger === 'function') {\n      // build request logger metadata\n      const requestLoggerMetadata: Record<string, unknown> = {}\n      // add request info to log\n      if (requestInfoToLog?.length) requestLoggerMetadata.request = pick(requestInfo, requestInfoToLog)\n      // add user claims to log\n      if (claims && claimsToLog?.length) requestLoggerMetadata.user = pick(claims, claimsToLog)\n      // build the request logger\n      logger = requestLogger(requestLoggerMetadata, user)\n    } else logger = requestLogger\n\n    const graphqlContext: GraphQLContext<TLogger, RequestInfo, TUser> = {\n      requestInfo,\n      logger,\n      user,\n      started: Date.now(),\n    }\n\n    const augmentedGraphQLContext = augmentContext ? { ...graphqlContext, ...(await augmentContext(graphqlContext)) } : graphqlContext\n\n    return augmentedGraphQLContext as GraphQLContext<TLogger, RequestInfo, TUser> & TAugment\n  }\n}\n\nexport const defaultCreateUser: CreateUser<User | undefined> = ({ req, claims }) => {\n  if (!claims) return Promise.resolve(undefined)\n  const accessToken = req.headers.authorization?.startsWith('Bearer') ? (req.headers.authorization?.substring(7) ?? '') : ''\n  return Promise.resolve(new User(claims, accessToken))\n}\n"],"names":["buildBaseRequestInfo","requestInfo","pick","User"],"mappings":";;;;;;AAsFO,MAAM,oBAAoB,GAAG,CAKlC,MAAqD,KACoB;AACzE,IAAA,MAAM,EAAE,aAAa,EAAE,kBAAkB,EAAE,WAAW,EAAE,gBAAgB,EAAE,cAAc,EAAE,GAAG,MAAM;;;IAGnG,MAAM,UAAU,IAAI,MAAM,CAAC,UAAU,IAAI,iBAAiB,CAAsB;AAEhF,IAAA,OAAO,OAAO,KAAmB,KAAI;QACnC,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,KAAK;;AAGtC,QAAA,MAAM,eAAe,GAAoBA,gCAAoB,CAAC,GAAG,CAAC;;AAGlE,QAAA,IAAI,iBAAgD;QACpD,IAAI,OAAO,EAAE;AACX,YAAA,MAAM,EAAE,YAAY,EAAE,YAAY,EAAE,GAAG,OAAO;AAC9C,YAAA,iBAAiB,GAAG;gBAClB,YAAY;gBACZ,YAAY;AACZ,gBAAA,GAAG,eAAe;aACnB;QACH;;AAGA,QAAA,IAAIC,aAAW,GAAgB,iBAAiB,IAAI,eAAe;AACnE,QAAA,IAAI,kBAAkB;AACpB,YAAAA,aAAW,GAAG;AACZ,gBAAA,GAAGA,aAAW;gBACd,GAAG,kBAAkB,CAAC,KAAK,CAAC;aAC7B;AAEH,QAAA,MAAM,IAAI,GAAG,MAAM,UAAU,CAAC,KAAK,CAAC;;AAGpC,QAAA,IAAI,MAAe;AACnB,QAAA,IAAI,OAAO,aAAa,KAAK,UAAU,EAAE;;YAEvC,MAAM,qBAAqB,GAA4B,EAAE;;YAEzD,IAAI,gBAAgB,EAAE,MAAM;gBAAE,qBAAqB,CAAC,OAAO,GAAGC,WAAI,CAACD,aAAW,EAAE,gBAAgB,CAAC;;AAEjG,YAAA,IAAI,MAAM,IAAI,WAAW,EAAE,MAAM;gBAAE,qBAAqB,CAAC,IAAI,GAAGC,WAAI,CAAC,MAAM,EAAE,WAAW,CAAC;;AAEzF,YAAA,MAAM,GAAG,aAAa,CAAC,qBAAqB,EAAE,IAAI,CAAC;QACrD;;YAAO,MAAM,GAAG,aAAa;AAE7B,QAAA,MAAM,cAAc,GAAgD;yBAClED,aAAW;YACX,MAAM;YACN,IAAI;AACJ,YAAA,OAAO,EAAE,IAAI,CAAC,GAAG,EAAE;SACpB;QAED,MAAM,uBAAuB,GAAG,cAAc,GAAG,EAAE,GAAG,cAAc,EAAE,IAAI,MAAM,cAAc,CAAC,cAAc,CAAC,CAAC,EAAE,GAAG,cAAc;AAElI,QAAA,OAAO,uBAAiF;AAC1F,IAAA,CAAC;AACH;AAEO,MAAM,iBAAiB,GAAiC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,KAAI;AACjF,IAAA,IAAI,CAAC,MAAM;AAAE,QAAA,OAAO,OAAO,CAAC,OAAO,CAAC,SAAS,CAAC;AAC9C,IAAA,MAAM,WAAW,GAAG,GAAG,CAAC,OAAO,CAAC,aAAa,EAAE,UAAU,CAAC,QAAQ,CAAC,IAAI,GAAG,CAAC,OAAO,CAAC,aAAa,EAAE,SAAS,CAAC,CAAC,CAAC,IAAI,EAAE,IAAI,EAAE;AAC1H,IAAA,OAAO,OAAO,CAAC,OAAO,CAAC,IAAIE,SAAI,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;AACvD;;;;;"}
+{"version":3,"file":"context.js","sources":["../src/context.ts"],"sourcesContent":["import type { Logger } from '@makerx/node-common'\nimport { pick } from 'es-toolkit/compat'\nimport type { Request } from 'express'\nimport { buildBaseRequestInfo, type BaseRequestInfo } from './request-info'\nimport { User } from './User'\n\nexport interface GraphQLContext<\n  TLogger extends Logger = Logger,\n  TRequestInfo extends BaseRequestInfo = RequestInfo,\n  TUser = User | undefined,\n> {\n  logger: TLogger\n  requestInfo: TRequestInfo\n  user: TUser\n  started: number\n}\n\nexport type AnyGraphqlContext = GraphQLContext<any, any, any>\n\nexport interface LambdaContext {\n  functionName?: string\n  awsRequestId?: string\n}\nexport type LambdaEvent = never\nexport type LambdaRequestInfo = BaseRequestInfo & LambdaContext\nexport type RequestInfo = BaseRequestInfo | LambdaRequestInfo\n\n// Strips the `[key: string]: unknown` index signature so `keyof` returns only the declared keys.\ntype KnownKeys<T> = keyof {\n  [K in keyof T as string extends K ? never : number extends K ? never : K]: T[K]\n}\n// Known keys for autocomplete, plus `(string & {})` to keep arbitrary augmented fields assignable.\nexport type RequestInfoLogKey = KnownKeys<BaseRequestInfo> | keyof LambdaContext | (string & {})\n\n// standard claims https://datatracker.ietf.org/doc/html/rfc7519#section-4.1\nexport interface JwtPayload {\n  [key: string]: unknown\n  name?: string | undefined\n  email?: string | undefined\n  given_name?: string | undefined\n  family_name?: string | undefined\n  preferred_username?: string | undefined\n  upn?: string | undefined\n  unique_name?: string | undefined\n  oid?: string | undefined\n  iss?: string | undefined\n  sub?: string | undefined\n  aud?: string | string[] | undefined\n  roles?: string[] | undefined\n  scp?: string | undefined\n  exp?: number | undefined\n  nbf?: number | undefined\n  iat?: number | undefined\n  jti?: string | undefined\n}\n\nexport type InferUserFromContext<TContext extends AnyGraphqlContext> =\n  TContext extends GraphQLContext<any, any, infer TUser> ? TUser : never\nexport type CreateUser<T = User | undefined> = (input: Omit<ContextInput, 'createUser'>) => Promise<T> | T\nexport interface ContextInput {\n  req: Request\n  claims?: JwtPayload\n  context?: LambdaContext\n  event?: LambdaEvent\n}\nexport type CreateContext<TContext = GraphQLContext> = (input: ContextInput) => Promise<TContext>\nexport type CreateRequestLogger<TUser = User | undefined, TLogger extends Logger = Logger> = (\n  requestMetadata: Record<string, unknown>,\n  user: TUser,\n) => TLogger\nexport type AugmentRequestInfo = (input: ContextInput) => Record<string, unknown>\nexport type ExtractToken = (input: ContextInput) => string | undefined\n\n// `createUser` is optional when TUser is compatible with the default `User | undefined`\n// (i.e. `defaultCreateUser` can satisfy it), and required when TUser is narrower.\nexport type CreateContextConfig<\n  TUser = User | undefined,\n  TAugment extends Record<string, unknown> = Record<string, never>,\n  TLogger extends Logger = Logger,\n> = {\n  requestLogger: CreateRequestLogger<TUser, TLogger> | TLogger\n  augmentRequestInfo?: AugmentRequestInfo\n  claimsToLog?: string[]\n  requestInfoToLog?: Array<RequestInfoLogKey>\n  augmentContext?: (context: GraphQLContext<TLogger, RequestInfo, TUser>) => TAugment | Promise<TAugment>\n  /**\n   * Returns the token that the default `createUser` sets as `User.token`, e.g. from a JWT assertion\n   * header. Not called when you supply `createUser`. Defaults to the bearer token in the\n   * `Authorization` header.\n   */\n  extractToken?: ExtractToken\n} & ([User | undefined] extends [TUser] ? { createUser?: CreateUser<TUser> } : { createUser: CreateUser<TUser> })\n\nexport const createContextFactory = <\n  TUser = User | undefined,\n  TAugment extends Record<string, unknown> = Record<string, never>,\n  TLogger extends Logger = Logger,\n>(\n  config: CreateContextConfig<TUser, TAugment, TLogger>,\n): CreateContext<GraphQLContext<TLogger, RequestInfo, TUser> & TAugment> => {\n  const { requestLogger, augmentRequestInfo, claimsToLog, requestInfoToLog, augmentContext } = config\n  // The conditional type on CreateContextConfig guarantees `createUser` is provided when TUser is\n  // narrower than `User | undefined`, so defaulting to defaultCreateUser is sound here.\n  const createUser = (config.createUser ?? buildDefaultCreateUser(config.extractToken ?? defaultExtractToken)) as CreateUser<TUser>\n\n  return async (input: ContextInput) => {\n    const { req, claims, context } = input\n\n    // build base request info from the request\n    const baseRequestInfo: BaseRequestInfo = buildBaseRequestInfo(req)\n\n    // add lambda info from the context, if present\n    let lambdaRequestInfo: LambdaRequestInfo | undefined\n    if (context) {\n      const { awsRequestId, functionName } = context\n      lambdaRequestInfo = {\n        awsRequestId,\n        functionName,\n        ...baseRequestInfo,\n      }\n    }\n\n    // augment request info with the supplied function, if present\n    let requestInfo: RequestInfo = lambdaRequestInfo ?? baseRequestInfo\n    if (augmentRequestInfo)\n      requestInfo = {\n        ...requestInfo,\n        ...augmentRequestInfo(input),\n      }\n\n    const user = await createUser(input)\n\n    // create request logger\n    let logger: TLogger\n    if (typeof requestLogger === 'function') {\n      // build request logger metadata\n      const requestLoggerMetadata: Record<string, unknown> = {}\n      // add request info to log\n      if (requestInfoToLog?.length) requestLoggerMetadata.request = pick(requestInfo, requestInfoToLog)\n      // add user claims to log\n      if (claims && claimsToLog?.length) requestLoggerMetadata.user = pick(claims, claimsToLog)\n      // build the request logger\n      logger = requestLogger(requestLoggerMetadata, user)\n    } else logger = requestLogger\n\n    const graphqlContext: GraphQLContext<TLogger, RequestInfo, TUser> = {\n      requestInfo,\n      logger,\n      user,\n      started: Date.now(),\n    }\n\n    const augmentedGraphQLContext = augmentContext ? { ...graphqlContext, ...(await augmentContext(graphqlContext)) } : graphqlContext\n\n    return augmentedGraphQLContext as GraphQLContext<TLogger, RequestInfo, TUser> & TAugment\n  }\n}\n\nconst defaultExtractToken: ExtractToken = ({ req }) =>\n  req.headers.authorization?.startsWith('Bearer') ? req.headers.authorization.substring(7) : undefined\n\nconst buildDefaultCreateUser =\n  (extractToken: ExtractToken): CreateUser<User | undefined> =>\n  (input) => {\n    if (!input.claims) return Promise.resolve(undefined)\n    return Promise.resolve(new User(input.claims, extractToken(input) ?? ''))\n  }\n\nexport const defaultCreateUser = buildDefaultCreateUser(defaultExtractToken)\n"],"names":["buildBaseRequestInfo","requestInfo","pick","User"],"mappings":";;;;;;AA6FO,MAAM,oBAAoB,GAAG,CAKlC,MAAqD,KACoB;AACzE,IAAA,MAAM,EAAE,aAAa,EAAE,kBAAkB,EAAE,WAAW,EAAE,gBAAgB,EAAE,cAAc,EAAE,GAAG,MAAM;;;AAGnG,IAAA,MAAM,UAAU,IAAI,MAAM,CAAC,UAAU,IAAI,sBAAsB,CAAC,MAAM,CAAC,YAAY,IAAI,mBAAmB,CAAC,CAAsB;AAEjI,IAAA,OAAO,OAAO,KAAmB,KAAI;QACnC,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,KAAK;;AAGtC,QAAA,MAAM,eAAe,GAAoBA,gCAAoB,CAAC,GAAG,CAAC;;AAGlE,QAAA,IAAI,iBAAgD;QACpD,IAAI,OAAO,EAAE;AACX,YAAA,MAAM,EAAE,YAAY,EAAE,YAAY,EAAE,GAAG,OAAO;AAC9C,YAAA,iBAAiB,GAAG;gBAClB,YAAY;gBACZ,YAAY;AACZ,gBAAA,GAAG,eAAe;aACnB;QACH;;AAGA,QAAA,IAAIC,aAAW,GAAgB,iBAAiB,IAAI,eAAe;AACnE,QAAA,IAAI,kBAAkB;AACpB,YAAAA,aAAW,GAAG;AACZ,gBAAA,GAAGA,aAAW;gBACd,GAAG,kBAAkB,CAAC,KAAK,CAAC;aAC7B;AAEH,QAAA,MAAM,IAAI,GAAG,MAAM,UAAU,CAAC,KAAK,CAAC;;AAGpC,QAAA,IAAI,MAAe;AACnB,QAAA,IAAI,OAAO,aAAa,KAAK,UAAU,EAAE;;YAEvC,MAAM,qBAAqB,GAA4B,EAAE;;YAEzD,IAAI,gBAAgB,EAAE,MAAM;gBAAE,qBAAqB,CAAC,OAAO,GAAGC,WAAI,CAACD,aAAW,EAAE,gBAAgB,CAAC;;AAEjG,YAAA,IAAI,MAAM,IAAI,WAAW,EAAE,MAAM;gBAAE,qBAAqB,CAAC,IAAI,GAAGC,WAAI,CAAC,MAAM,EAAE,WAAW,CAAC;;AAEzF,YAAA,MAAM,GAAG,aAAa,CAAC,qBAAqB,EAAE,IAAI,CAAC;QACrD;;YAAO,MAAM,GAAG,aAAa;AAE7B,QAAA,MAAM,cAAc,GAAgD;yBAClED,aAAW;YACX,MAAM;YACN,IAAI;AACJ,YAAA,OAAO,EAAE,IAAI,CAAC,GAAG,EAAE;SACpB;QAED,MAAM,uBAAuB,GAAG,cAAc,GAAG,EAAE,GAAG,cAAc,EAAE,IAAI,MAAM,cAAc,CAAC,cAAc,CAAC,CAAC,EAAE,GAAG,cAAc;AAElI,QAAA,OAAO,uBAAiF;AAC1F,IAAA,CAAC;AACH;AAEA,MAAM,mBAAmB,GAAiB,CAAC,EAAE,GAAG,EAAE,KAChD,GAAG,CAAC,OAAO,CAAC,aAAa,EAAE,UAAU,CAAC,QAAQ,CAAC,GAAG,GAAG,CAAC,OAAO,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,SAAS;AAEtG,MAAM,sBAAsB,GAC1B,CAAC,YAA0B,KAC3B,CAAC,KAAK,KAAI;IACR,IAAI,CAAC,KAAK,CAAC,MAAM;AAAE,QAAA,OAAO,OAAO,CAAC,OAAO,CAAC,SAAS,CAAC;AACpD,IAAA,OAAO,OAAO,CAAC,OAAO,CAAC,IAAIE,SAAI,CAAC,KAAK,CAAC,MAAM,EAAE,YAAY,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC;AAC3E,CAAC;MAEU,iBAAiB,GAAG,sBAAsB,CAAC,mBAAmB;;;;;"}

package/context.mjs

@@ -6,7 +6,7 @@ const createContextFactory = (config) => {
     const { requestLogger, augmentRequestInfo, claimsToLog, requestInfoToLog, augmentContext } = config;
     // The conditional type on CreateContextConfig guarantees `createUser` is provided when TUser is
     // narrower than `User | undefined`, so defaulting to defaultCreateUser is sound here.
-    const createUser = (config.createUser ?? defaultCreateUser);
+    const createUser = (config.createUser ?? buildDefaultCreateUser(config.extractToken ?? defaultExtractToken));
     return async (input) => {
         const { req, claims, context } = input;
         // build base request info from the request
@@ -55,12 +55,13 @@ const createContextFactory = (config) => {
         return augmentedGraphQLContext;
     };
 };
-const defaultCreateUser = ({ req, claims }) => {
-    if (!claims)
+const defaultExtractToken = ({ req }) => req.headers.authorization?.startsWith('Bearer') ? req.headers.authorization.substring(7) : undefined;
+const buildDefaultCreateUser = (extractToken) => (input) => {
+    if (!input.claims)
         return Promise.resolve(undefined);
-    const accessToken = req.headers.authorization?.startsWith('Bearer') ? (req.headers.authorization?.substring(7) ?? '') : '';
-    return Promise.resolve(new User(claims, accessToken));
+    return Promise.resolve(new User(input.claims, extractToken(input) ?? ''));
 };
+const defaultCreateUser = buildDefaultCreateUser(defaultExtractToken);
 
 export { createContextFactory, defaultCreateUser };
 //# sourceMappingURL=context.mjs.map

package/context.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"context.mjs","sources":["../src/context.ts"],"sourcesContent":["import type { Logger } from '@makerx/node-common'\nimport { pick } from 'es-toolkit/compat'\nimport type { Request } from 'express'\nimport { buildBaseRequestInfo, type BaseRequestInfo } from './request-info'\nimport { User } from './User'\n\nexport interface GraphQLContext<\n  TLogger extends Logger = Logger,\n  TRequestInfo extends BaseRequestInfo = RequestInfo,\n  TUser = User | undefined,\n> {\n  logger: TLogger\n  requestInfo: TRequestInfo\n  user: TUser\n  started: number\n}\n\nexport type AnyGraphqlContext = GraphQLContext<any, any, any>\n\nexport interface LambdaContext {\n  functionName?: string\n  awsRequestId?: string\n}\nexport type LambdaEvent = never\nexport type LambdaRequestInfo = BaseRequestInfo & LambdaContext\nexport type RequestInfo = BaseRequestInfo | LambdaRequestInfo\n\n// Strips the `[key: string]: unknown` index signature so `keyof` returns only the declared keys.\ntype KnownKeys<T> = keyof {\n  [K in keyof T as string extends K ? never : number extends K ? never : K]: T[K]\n}\n// Known keys for autocomplete, plus `(string & {})` to keep arbitrary augmented fields assignable.\nexport type RequestInfoLogKey = KnownKeys<BaseRequestInfo> | keyof LambdaContext | (string & {})\n\n// standard claims https://datatracker.ietf.org/doc/html/rfc7519#section-4.1\nexport interface JwtPayload {\n  [key: string]: unknown\n  name?: string | undefined\n  email?: string | undefined\n  given_name?: string | undefined\n  family_name?: string | undefined\n  preferred_username?: string | undefined\n  upn?: string | undefined\n  unique_name?: string | undefined\n  oid?: string | undefined\n  iss?: string | undefined\n  sub?: string | undefined\n  aud?: string | string[] | undefined\n  roles?: string[] | undefined\n  scp?: string | undefined\n  exp?: number | undefined\n  nbf?: number | undefined\n  iat?: number | undefined\n  jti?: string | undefined\n}\n\nexport type InferUserFromContext<TContext extends AnyGraphqlContext> =\n  TContext extends GraphQLContext<any, any, infer TUser> ? TUser : never\nexport type CreateUser<T = User | undefined> = (input: Omit<ContextInput, 'createUser'>) => Promise<T> | T\nexport interface ContextInput {\n  req: Request\n  claims?: JwtPayload\n  context?: LambdaContext\n  event?: LambdaEvent\n}\nexport type CreateContext<TContext = GraphQLContext> = (input: ContextInput) => Promise<TContext>\nexport type CreateRequestLogger<TUser = User | undefined, TLogger extends Logger = Logger> = (\n  requestMetadata: Record<string, unknown>,\n  user: TUser,\n) => TLogger\nexport type AugmentRequestInfo = (input: ContextInput) => Record<string, unknown>\n\n// `createUser` is optional when TUser is compatible with the default `User | undefined`\n// (i.e. `defaultCreateUser` can satisfy it), and required when TUser is narrower.\nexport type CreateContextConfig<\n  TUser = User | undefined,\n  TAugment extends Record<string, unknown> = Record<string, never>,\n  TLogger extends Logger = Logger,\n> = {\n  requestLogger: CreateRequestLogger<TUser, TLogger> | TLogger\n  augmentRequestInfo?: AugmentRequestInfo\n  claimsToLog?: string[]\n  requestInfoToLog?: Array<RequestInfoLogKey>\n  augmentContext?: (context: GraphQLContext<TLogger, RequestInfo, TUser>) => TAugment | Promise<TAugment>\n} & ([User | undefined] extends [TUser] ? { createUser?: CreateUser<TUser> } : { createUser: CreateUser<TUser> })\n\nexport const createContextFactory = <\n  TUser = User | undefined,\n  TAugment extends Record<string, unknown> = Record<string, never>,\n  TLogger extends Logger = Logger,\n>(\n  config: CreateContextConfig<TUser, TAugment, TLogger>,\n): CreateContext<GraphQLContext<TLogger, RequestInfo, TUser> & TAugment> => {\n  const { requestLogger, augmentRequestInfo, claimsToLog, requestInfoToLog, augmentContext } = config\n  // The conditional type on CreateContextConfig guarantees `createUser` is provided when TUser is\n  // narrower than `User | undefined`, so defaulting to defaultCreateUser is sound here.\n  const createUser = (config.createUser ?? defaultCreateUser) as CreateUser<TUser>\n\n  return async (input: ContextInput) => {\n    const { req, claims, context } = input\n\n    // build base request info from the request\n    const baseRequestInfo: BaseRequestInfo = buildBaseRequestInfo(req)\n\n    // add lambda info from the context, if present\n    let lambdaRequestInfo: LambdaRequestInfo | undefined\n    if (context) {\n      const { awsRequestId, functionName } = context\n      lambdaRequestInfo = {\n        awsRequestId,\n        functionName,\n        ...baseRequestInfo,\n      }\n    }\n\n    // augment request info with the supplied function, if present\n    let requestInfo: RequestInfo = lambdaRequestInfo ?? baseRequestInfo\n    if (augmentRequestInfo)\n      requestInfo = {\n        ...requestInfo,\n        ...augmentRequestInfo(input),\n      }\n\n    const user = await createUser(input)\n\n    // create request logger\n    let logger: TLogger\n    if (typeof requestLogger === 'function') {\n      // build request logger metadata\n      const requestLoggerMetadata: Record<string, unknown> = {}\n      // add request info to log\n      if (requestInfoToLog?.length) requestLoggerMetadata.request = pick(requestInfo, requestInfoToLog)\n      // add user claims to log\n      if (claims && claimsToLog?.length) requestLoggerMetadata.user = pick(claims, claimsToLog)\n      // build the request logger\n      logger = requestLogger(requestLoggerMetadata, user)\n    } else logger = requestLogger\n\n    const graphqlContext: GraphQLContext<TLogger, RequestInfo, TUser> = {\n      requestInfo,\n      logger,\n      user,\n      started: Date.now(),\n    }\n\n    const augmentedGraphQLContext = augmentContext ? { ...graphqlContext, ...(await augmentContext(graphqlContext)) } : graphqlContext\n\n    return augmentedGraphQLContext as GraphQLContext<TLogger, RequestInfo, TUser> & TAugment\n  }\n}\n\nexport const defaultCreateUser: CreateUser<User | undefined> = ({ req, claims }) => {\n  if (!claims) return Promise.resolve(undefined)\n  const accessToken = req.headers.authorization?.startsWith('Bearer') ? (req.headers.authorization?.substring(7) ?? '') : ''\n  return Promise.resolve(new User(claims, accessToken))\n}\n"],"names":[],"mappings":";;;;AAsFO,MAAM,oBAAoB,GAAG,CAKlC,MAAqD,KACoB;AACzE,IAAA,MAAM,EAAE,aAAa,EAAE,kBAAkB,EAAE,WAAW,EAAE,gBAAgB,EAAE,cAAc,EAAE,GAAG,MAAM;;;IAGnG,MAAM,UAAU,IAAI,MAAM,CAAC,UAAU,IAAI,iBAAiB,CAAsB;AAEhF,IAAA,OAAO,OAAO,KAAmB,KAAI;QACnC,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,KAAK;;AAGtC,QAAA,MAAM,eAAe,GAAoB,oBAAoB,CAAC,GAAG,CAAC;;AAGlE,QAAA,IAAI,iBAAgD;QACpD,IAAI,OAAO,EAAE;AACX,YAAA,MAAM,EAAE,YAAY,EAAE,YAAY,EAAE,GAAG,OAAO;AAC9C,YAAA,iBAAiB,GAAG;gBAClB,YAAY;gBACZ,YAAY;AACZ,gBAAA,GAAG,eAAe;aACnB;QACH;;AAGA,QAAA,IAAI,WAAW,GAAgB,iBAAiB,IAAI,eAAe;AACnE,QAAA,IAAI,kBAAkB;AACpB,YAAA,WAAW,GAAG;AACZ,gBAAA,GAAG,WAAW;gBACd,GAAG,kBAAkB,CAAC,KAAK,CAAC;aAC7B;AAEH,QAAA,MAAM,IAAI,GAAG,MAAM,UAAU,CAAC,KAAK,CAAC;;AAGpC,QAAA,IAAI,MAAe;AACnB,QAAA,IAAI,OAAO,aAAa,KAAK,UAAU,EAAE;;YAEvC,MAAM,qBAAqB,GAA4B,EAAE;;YAEzD,IAAI,gBAAgB,EAAE,MAAM;gBAAE,qBAAqB,CAAC,OAAO,GAAG,IAAI,CAAC,WAAW,EAAE,gBAAgB,CAAC;;AAEjG,YAAA,IAAI,MAAM,IAAI,WAAW,EAAE,MAAM;gBAAE,qBAAqB,CAAC,IAAI,GAAG,IAAI,CAAC,MAAM,EAAE,WAAW,CAAC;;AAEzF,YAAA,MAAM,GAAG,aAAa,CAAC,qBAAqB,EAAE,IAAI,CAAC;QACrD;;YAAO,MAAM,GAAG,aAAa;AAE7B,QAAA,MAAM,cAAc,GAAgD;YAClE,WAAW;YACX,MAAM;YACN,IAAI;AACJ,YAAA,OAAO,EAAE,IAAI,CAAC,GAAG,EAAE;SACpB;QAED,MAAM,uBAAuB,GAAG,cAAc,GAAG,EAAE,GAAG,cAAc,EAAE,IAAI,MAAM,cAAc,CAAC,cAAc,CAAC,CAAC,EAAE,GAAG,cAAc;AAElI,QAAA,OAAO,uBAAiF;AAC1F,IAAA,CAAC;AACH;AAEO,MAAM,iBAAiB,GAAiC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,KAAI;AACjF,IAAA,IAAI,CAAC,MAAM;AAAE,QAAA,OAAO,OAAO,CAAC,OAAO,CAAC,SAAS,CAAC;AAC9C,IAAA,MAAM,WAAW,GAAG,GAAG,CAAC,OAAO,CAAC,aAAa,EAAE,UAAU,CAAC,QAAQ,CAAC,IAAI,GAAG,CAAC,OAAO,CAAC,aAAa,EAAE,SAAS,CAAC,CAAC,CAAC,IAAI,EAAE,IAAI,EAAE;AAC1H,IAAA,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;AACvD;;;;"}
+{"version":3,"file":"context.mjs","sources":["../src/context.ts"],"sourcesContent":["import type { Logger } from '@makerx/node-common'\nimport { pick } from 'es-toolkit/compat'\nimport type { Request } from 'express'\nimport { buildBaseRequestInfo, type BaseRequestInfo } from './request-info'\nimport { User } from './User'\n\nexport interface GraphQLContext<\n  TLogger extends Logger = Logger,\n  TRequestInfo extends BaseRequestInfo = RequestInfo,\n  TUser = User | undefined,\n> {\n  logger: TLogger\n  requestInfo: TRequestInfo\n  user: TUser\n  started: number\n}\n\nexport type AnyGraphqlContext = GraphQLContext<any, any, any>\n\nexport interface LambdaContext {\n  functionName?: string\n  awsRequestId?: string\n}\nexport type LambdaEvent = never\nexport type LambdaRequestInfo = BaseRequestInfo & LambdaContext\nexport type RequestInfo = BaseRequestInfo | LambdaRequestInfo\n\n// Strips the `[key: string]: unknown` index signature so `keyof` returns only the declared keys.\ntype KnownKeys<T> = keyof {\n  [K in keyof T as string extends K ? never : number extends K ? never : K]: T[K]\n}\n// Known keys for autocomplete, plus `(string & {})` to keep arbitrary augmented fields assignable.\nexport type RequestInfoLogKey = KnownKeys<BaseRequestInfo> | keyof LambdaContext | (string & {})\n\n// standard claims https://datatracker.ietf.org/doc/html/rfc7519#section-4.1\nexport interface JwtPayload {\n  [key: string]: unknown\n  name?: string | undefined\n  email?: string | undefined\n  given_name?: string | undefined\n  family_name?: string | undefined\n  preferred_username?: string | undefined\n  upn?: string | undefined\n  unique_name?: string | undefined\n  oid?: string | undefined\n  iss?: string | undefined\n  sub?: string | undefined\n  aud?: string | string[] | undefined\n  roles?: string[] | undefined\n  scp?: string | undefined\n  exp?: number | undefined\n  nbf?: number | undefined\n  iat?: number | undefined\n  jti?: string | undefined\n}\n\nexport type InferUserFromContext<TContext extends AnyGraphqlContext> =\n  TContext extends GraphQLContext<any, any, infer TUser> ? TUser : never\nexport type CreateUser<T = User | undefined> = (input: Omit<ContextInput, 'createUser'>) => Promise<T> | T\nexport interface ContextInput {\n  req: Request\n  claims?: JwtPayload\n  context?: LambdaContext\n  event?: LambdaEvent\n}\nexport type CreateContext<TContext = GraphQLContext> = (input: ContextInput) => Promise<TContext>\nexport type CreateRequestLogger<TUser = User | undefined, TLogger extends Logger = Logger> = (\n  requestMetadata: Record<string, unknown>,\n  user: TUser,\n) => TLogger\nexport type AugmentRequestInfo = (input: ContextInput) => Record<string, unknown>\nexport type ExtractToken = (input: ContextInput) => string | undefined\n\n// `createUser` is optional when TUser is compatible with the default `User | undefined`\n// (i.e. `defaultCreateUser` can satisfy it), and required when TUser is narrower.\nexport type CreateContextConfig<\n  TUser = User | undefined,\n  TAugment extends Record<string, unknown> = Record<string, never>,\n  TLogger extends Logger = Logger,\n> = {\n  requestLogger: CreateRequestLogger<TUser, TLogger> | TLogger\n  augmentRequestInfo?: AugmentRequestInfo\n  claimsToLog?: string[]\n  requestInfoToLog?: Array<RequestInfoLogKey>\n  augmentContext?: (context: GraphQLContext<TLogger, RequestInfo, TUser>) => TAugment | Promise<TAugment>\n  /**\n   * Returns the token that the default `createUser` sets as `User.token`, e.g. from a JWT assertion\n   * header. Not called when you supply `createUser`. Defaults to the bearer token in the\n   * `Authorization` header.\n   */\n  extractToken?: ExtractToken\n} & ([User | undefined] extends [TUser] ? { createUser?: CreateUser<TUser> } : { createUser: CreateUser<TUser> })\n\nexport const createContextFactory = <\n  TUser = User | undefined,\n  TAugment extends Record<string, unknown> = Record<string, never>,\n  TLogger extends Logger = Logger,\n>(\n  config: CreateContextConfig<TUser, TAugment, TLogger>,\n): CreateContext<GraphQLContext<TLogger, RequestInfo, TUser> & TAugment> => {\n  const { requestLogger, augmentRequestInfo, claimsToLog, requestInfoToLog, augmentContext } = config\n  // The conditional type on CreateContextConfig guarantees `createUser` is provided when TUser is\n  // narrower than `User | undefined`, so defaulting to defaultCreateUser is sound here.\n  const createUser = (config.createUser ?? buildDefaultCreateUser(config.extractToken ?? defaultExtractToken)) as CreateUser<TUser>\n\n  return async (input: ContextInput) => {\n    const { req, claims, context } = input\n\n    // build base request info from the request\n    const baseRequestInfo: BaseRequestInfo = buildBaseRequestInfo(req)\n\n    // add lambda info from the context, if present\n    let lambdaRequestInfo: LambdaRequestInfo | undefined\n    if (context) {\n      const { awsRequestId, functionName } = context\n      lambdaRequestInfo = {\n        awsRequestId,\n        functionName,\n        ...baseRequestInfo,\n      }\n    }\n\n    // augment request info with the supplied function, if present\n    let requestInfo: RequestInfo = lambdaRequestInfo ?? baseRequestInfo\n    if (augmentRequestInfo)\n      requestInfo = {\n        ...requestInfo,\n        ...augmentRequestInfo(input),\n      }\n\n    const user = await createUser(input)\n\n    // create request logger\n    let logger: TLogger\n    if (typeof requestLogger === 'function') {\n      // build request logger metadata\n      const requestLoggerMetadata: Record<string, unknown> = {}\n      // add request info to log\n      if (requestInfoToLog?.length) requestLoggerMetadata.request = pick(requestInfo, requestInfoToLog)\n      // add user claims to log\n      if (claims && claimsToLog?.length) requestLoggerMetadata.user = pick(claims, claimsToLog)\n      // build the request logger\n      logger = requestLogger(requestLoggerMetadata, user)\n    } else logger = requestLogger\n\n    const graphqlContext: GraphQLContext<TLogger, RequestInfo, TUser> = {\n      requestInfo,\n      logger,\n      user,\n      started: Date.now(),\n    }\n\n    const augmentedGraphQLContext = augmentContext ? { ...graphqlContext, ...(await augmentContext(graphqlContext)) } : graphqlContext\n\n    return augmentedGraphQLContext as GraphQLContext<TLogger, RequestInfo, TUser> & TAugment\n  }\n}\n\nconst defaultExtractToken: ExtractToken = ({ req }) =>\n  req.headers.authorization?.startsWith('Bearer') ? req.headers.authorization.substring(7) : undefined\n\nconst buildDefaultCreateUser =\n  (extractToken: ExtractToken): CreateUser<User | undefined> =>\n  (input) => {\n    if (!input.claims) return Promise.resolve(undefined)\n    return Promise.resolve(new User(input.claims, extractToken(input) ?? ''))\n  }\n\nexport const defaultCreateUser = buildDefaultCreateUser(defaultExtractToken)\n"],"names":[],"mappings":";;;;AA6FO,MAAM,oBAAoB,GAAG,CAKlC,MAAqD,KACoB;AACzE,IAAA,MAAM,EAAE,aAAa,EAAE,kBAAkB,EAAE,WAAW,EAAE,gBAAgB,EAAE,cAAc,EAAE,GAAG,MAAM;;;AAGnG,IAAA,MAAM,UAAU,IAAI,MAAM,CAAC,UAAU,IAAI,sBAAsB,CAAC,MAAM,CAAC,YAAY,IAAI,mBAAmB,CAAC,CAAsB;AAEjI,IAAA,OAAO,OAAO,KAAmB,KAAI;QACnC,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,KAAK;;AAGtC,QAAA,MAAM,eAAe,GAAoB,oBAAoB,CAAC,GAAG,CAAC;;AAGlE,QAAA,IAAI,iBAAgD;QACpD,IAAI,OAAO,EAAE;AACX,YAAA,MAAM,EAAE,YAAY,EAAE,YAAY,EAAE,GAAG,OAAO;AAC9C,YAAA,iBAAiB,GAAG;gBAClB,YAAY;gBACZ,YAAY;AACZ,gBAAA,GAAG,eAAe;aACnB;QACH;;AAGA,QAAA,IAAI,WAAW,GAAgB,iBAAiB,IAAI,eAAe;AACnE,QAAA,IAAI,kBAAkB;AACpB,YAAA,WAAW,GAAG;AACZ,gBAAA,GAAG,WAAW;gBACd,GAAG,kBAAkB,CAAC,KAAK,CAAC;aAC7B;AAEH,QAAA,MAAM,IAAI,GAAG,MAAM,UAAU,CAAC,KAAK,CAAC;;AAGpC,QAAA,IAAI,MAAe;AACnB,QAAA,IAAI,OAAO,aAAa,KAAK,UAAU,EAAE;;YAEvC,MAAM,qBAAqB,GAA4B,EAAE;;YAEzD,IAAI,gBAAgB,EAAE,MAAM;gBAAE,qBAAqB,CAAC,OAAO,GAAG,IAAI,CAAC,WAAW,EAAE,gBAAgB,CAAC;;AAEjG,YAAA,IAAI,MAAM,IAAI,WAAW,EAAE,MAAM;gBAAE,qBAAqB,CAAC,IAAI,GAAG,IAAI,CAAC,MAAM,EAAE,WAAW,CAAC;;AAEzF,YAAA,MAAM,GAAG,aAAa,CAAC,qBAAqB,EAAE,IAAI,CAAC;QACrD;;YAAO,MAAM,GAAG,aAAa;AAE7B,QAAA,MAAM,cAAc,GAAgD;YAClE,WAAW;YACX,MAAM;YACN,IAAI;AACJ,YAAA,OAAO,EAAE,IAAI,CAAC,GAAG,EAAE;SACpB;QAED,MAAM,uBAAuB,GAAG,cAAc,GAAG,EAAE,GAAG,cAAc,EAAE,IAAI,MAAM,cAAc,CAAC,cAAc,CAAC,CAAC,EAAE,GAAG,cAAc;AAElI,QAAA,OAAO,uBAAiF;AAC1F,IAAA,CAAC;AACH;AAEA,MAAM,mBAAmB,GAAiB,CAAC,EAAE,GAAG,EAAE,KAChD,GAAG,CAAC,OAAO,CAAC,aAAa,EAAE,UAAU,CAAC,QAAQ,CAAC,GAAG,GAAG,CAAC,OAAO,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,SAAS;AAEtG,MAAM,sBAAsB,GAC1B,CAAC,YAA0B,KAC3B,CAAC,KAAK,KAAI;IACR,IAAI,CAAC,KAAK,CAAC,MAAM;AAAE,QAAA,OAAO,OAAO,CAAC,OAAO,CAAC,SAAS,CAAC;AACpD,IAAA,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,YAAY,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC;AAC3E,CAAC;MAEU,iBAAiB,GAAG,sBAAsB,CAAC,mBAAmB;;;;"}

package/package.json

@@ -4,7 +4,7 @@
     "**"
   ],
   "name": "@makerx/graphql-core",
-  "version": "3.3.0",
+  "version": "3.5.0",
   "private": false,
   "description": "A set of core GraphQL utilities that MakerX uses to build GraphQL APIs",
   "author": "MakerX",
@@ -42,7 +42,8 @@
     }
   },
   "overrides": {
-    "esbuild": "^0.28.1"
+    "esbuild": "^0.28.1",
+    "@graphql-tools/utils": "12.0.1"
   },
   "main": "./index.js",
   "module": "./index.mjs",

package/subscriptions/context.d.cts

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

package/subscriptions/context.d.mts

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

package/subscriptions/context.d.ts

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

package/subscriptions/context.js

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

package/subscriptions/context.js.map

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

package/subscriptions/context.mjs

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

package/subscriptions/context.mjs.map

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

package/subscriptions/server.d.cts

@@ -1,9 +1,9 @@
 import type { Logger } from '@makerx/node-common';
-import type { GraphQLSchema } from 'graphql';
+import { type GraphQLSchema } from 'graphql';
 import type { Server } from 'http';
 import type { GraphQLContext, JwtPayload } from '../context';
-import type { CreateSubscriptionContext } from './context';
-export declare function useSubscriptionsServer<TLogger extends Logger = Logger>({ schema, httpServer, createSubscriptionContext, logger, operationLogLevel, path, verifyToken, requireAuth, jwtClaimsToLog, resolveSubscriptionOperationLogger, includeDeprecatedElements, }: {
+import type { CreateSubscriptionContext, ExtractSubscriptionToken } from './context';
+export declare function useSubscriptionsServer<TLogger extends Logger = Logger>({ schema, httpServer, createSubscriptionContext, logger, operationLogLevel, path, verifyToken, extractToken, requireAuth, jwtClaimsToLog, resolveSubscriptionOperationLogger, includeDeprecatedElements, connectionExpiry, keepAlive, }: {
     schema: GraphQLSchema;
     httpServer: Server;
     createSubscriptionContext: CreateSubscriptionContext;
@@ -11,6 +11,12 @@ export declare function useSubscriptionsServer<TLogger extends Logger = Logger>(
     operationLogLevel?: keyof TLogger;
     path?: string;
     verifyToken?: (host: string, token: string) => Promise<JwtPayload>;
+    /**
+     * Returns the token to pass to `verifyToken`, e.g. from a JWT assertion header that a proxy adds
+     * to the connect request. Defaults to the bearer token in the `authorization` or `Authorization`
+     * connection parameter. Pass the same function to `createSubscriptionContextFactory`.
+     */
+    extractToken?: ExtractSubscriptionToken;
     requireAuth?: boolean;
     jwtClaimsToLog?: string[];
     resolveSubscriptionOperationLogger?: (context: GraphQLContext) => TLogger;
@@ -19,4 +25,39 @@ export declare function useSubscriptionsServer<TLogger extends Logger = Logger>(
      * established. Not collected per emitted payload: the usage is a property of the operation.
      */
     includeDeprecatedElements?: boolean;
+    /**
+     * Returns the time a connection ends, in milliseconds since the epoch, from the claims `verifyToken`
+     * returned when it was established. `undefined` keeps the default behaviour below.
+     *
+     * When it returns a time:
+     * - A time already past refuses the connection with `4403 Forbidden`, as an invalid token does.
+     * - Otherwise at that time the connection is closed with `4403`, which ends every subscription
+     *   running on it.
+     * - Until then the client may subscribe again on the connection, and the token is not verified
+     *   again: it was verified when the connection was established, and it cannot change for the life
+     *   of the connection.
+     *
+     * To end a connection when its token expires: `(claims) => (claims.exp === undefined ? undefined : claims.exp * 1000)`.
+     * When the token is short-lived proof of a longer session, such as an assertion that a proxy adds to
+     * the upgrade request, a later time keeps subscriptions from being cut off every few minutes:
+     * `(claims) => (claims.iat === undefined ? undefined : (claims.iat + 3600) * 1000)`. A connection then
+     * outlives its token, so a revoked session is noticed only when the connection ends.
+     *
+     * By default a connection has no set end. Its token is verified again each time the client
+     * subscribes, and a token that no longer verifies closes the connection with `4403` then.
+     * Subscriptions already running continue until that happens.
+     *
+     * graphql-ws clients retry `4403` by default, but a retry succeeds only with a fresh token: the
+     * client's `connectionParams` must be a function that returns a current token, or the upgrade
+     * request must be authenticated afresh (by a cookie and a proxy, for example). A client that sends
+     * the same expired token fails again until its `retryAttempts` run out, and its subscriptions then
+     * end with an error.
+     */
+    connectionExpiry?: (claims: JwtPayload) => number | undefined;
+    /**
+     * Milliseconds between the server's websocket pings. A connection that has not answered a ping by
+     * the time the next one is due is terminated. `0` turns the pings off. Defaults to graphql-ws's 12
+     * seconds.
+     */
+    keepAlive?: number;
 }): import("graphql-ws").Disposable;