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

package/README.md

@@ -10,41 +10,45 @@ Note: See explanation on \*Express peer dependency below.
 
 `createContextFactory` returns a function that creates your GraphQL context using a standard (extensible) representation, including:
 
-- `logger`: a logger instance to use downstream of resolvers, usually logging some request metadata to assist correlating log entries (for example the X-Correlation-Id header value)
-- `requestInfo`: useful request info, for example to define per-request behaviour (multi-tenant apps), pass through correlation headers to downstream services etc
-- `user`: an object representing the user or system identity (see definition below, defaults to creating a `User` based on JWT claims)
-- anything else you wish to add to the context
+- `logger`: a logger instance to use downstream of resolvers, built by your `requestLogger` factory, which receives both the resolved request metadata and the resolved `user` so you can enrich log output with user-derived fields (see [Request logger](#request-logger))
+- `requestInfo`: useful request info — `source` (`http` or `subscription`), `protocol` (`http`/`https`/`ws`/`wss`), `host`, `baseUrl`, `url`, correlation/client headers, etc. Use it for per-request behaviour (multi-tenant apps), passing correlation headers downstream, etc. See [Request info](#request-info)
+- `user`: an object representing the user or system identity (see [User](#user); defaults to a `User` built from JWT claims when `createUser` is omitted)
+- anything else you wish to add to the context via `augmentContext`
 
 ### Step 1 - Define your context + creation
 
 context.ts
 
 ```ts
-// define the base context type, setting the logger type
-type BaseContext = GraphQLContextBase<Logger>
 // define the extra stuff added to our app's context
 type ExtraContext = {
   services: Services
   loaders: Loaders
 }
-// our app's context type, returned from the createContext function
-export type GraphQLContext = BaseContext & ExtraContext
 
 // configure the createContext function
-export const createContext = createContextFactory<GraphQLContext>({
-  // set the keys of the user claims (JWT payload) we want added to the request metadata passed to the requestLogger factory
+// TUser is inferred from `createUser`, TAugment is inferred from `augmentContext`'s return type
+export const createContext = createContextFactory({
+  // keys of the user claims (JWT payload) to include in the request metadata passed to the requestLogger factory
   claimsToLog: ['oid', 'aud', 'tid', 'azp', 'iss', 'scp', 'roles'],
-  // set the keys of the request info we want added to the request metadata passed to the requestLogger factory
+  // keys of the request info to include in the request metadata passed to the requestLogger factory
   requestInfoToLog: ['origin', 'requestId', 'correlationId'],
-  // use a winston child logger to add metadata to log output
-  requestLogger: (requestMetadata) => logger.child(requestMetadata),
-  // build the rest of the app context
+  // build the per-request logger; receives the request metadata and the resolved user
+  // e.g. enrich log output with user-derived fields like multi-tenant `instance`
+  requestLogger: (requestMetadata, user) => logger.child({ ...requestMetadata, instance: user?.instance }),
+  // resolve the user for each request — optional; omit to use the default User-from-JWT behaviour
+  // (required when you supply a narrower TUser generic)
+  createUser: async ({ claims }) => new AppUser(claims),
+  // build the rest of the app context — annotate the return type to lock in inference
   augmentContext: (context): ExtraContext => {
     const services = createServices(context)
     const loaders = createLoaders(services)
     return { services, loaders }
   },
 })
+
+// derive the full context type from the factory's return type
+export type GraphQLContext = Awaited<ReturnType<typeof createContext>>
 ```
 
 ### Step 2 - Map the context creation to implementation
@@ -83,6 +87,50 @@ const graphqlServer = createServer({
 })
 ```
 
+## Request info
+
+`context.requestInfo` is built for every request — both HTTP and websocket subscription connects — so downstream code can distinguish sources, rebuild URLs, pass through correlation headers, etc.
+
+| Field           | Description                                                                                                                                                                   |
+| --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `requestId`     | `x-request-id` header if present, otherwise a freshly generated UUID.                                                                                                         |
+| `source`        | `'http'` for regular requests, `'subscription'` for websocket connects.                                                                                                       |
+| `protocol`      | `'http'` / `'https'` for HTTP, `'ws'` / `'wss'` for subscriptions (resolved via `x-forwarded-proto` or TLS socket encryption).                                                |
+| `host`          | Hostname only (no port). Prefers `x-forwarded-host`, falls back to the `Host` header, then `req.hostname` (Express only).                                                     |
+| `port`          | Port parsed from `x-forwarded-host` / `Host` header when present; `undefined` otherwise.                                                                                      |
+| `baseUrl`       | Fully-qualified origin (`scheme://host[:port]`) with default ports stripped. For subscriptions the scheme is normalised to `http(s)` so the value composes with relative URLs. |
+| `url`           | `req.originalUrl` for HTTP, `req.url` for subscription connects.                                                                                                              |
+| `origin`        | `Origin` header.                                                                                                                                                              |
+| `referer`       | `Referer` header.                                                                                                                                                             |
+| `correlationId` | `x-correlation-id` header.                                                                                                                                                    |
+| `arrLogId`      | `x-arr-log-id` header (Azure Front Door / ARR).                                                                                                                               |
+| `clientIp`      | First value from `x-forwarded-for`, falling back to `socket.remoteAddress`.                                                                                                   |
+| `userAgent`     | `User-Agent` header.                                                                                                                                                          |
+
+You can add more via `augmentRequestInfo(input)`. Lambda deployments also get `functionName` and `awsRequestId` when a `LambdaContext` is supplied.
+
+Helpers are exported for custom wiring: `buildBaseRequestInfo(req)` (Express), `buildConnectRequestInfo(req)` (websocket `IncomingMessage`), and `requestBaseUrl` / `connectRequestBaseUrl`.
+
+## Request logger
+
+The `requestLogger` config accepts either a pre-built `Logger` or a factory `(requestMetadata, user) => Logger`.
+
+The factory form runs per request and receives:
+
+- `requestMetadata` — an object containing `request` (the subset of `requestInfo` selected by `requestInfoToLog`) and `user` (the subset of claims selected by `claimsToLog`)
+- `user` — the resolved `user` value returned by `createUser` (typed as your `TUser`)
+
+This lets you enrich log output with fields derived from the resolved user, for example a multi-tenant instance id or an internal user id from your database, that aren't present on the raw JWT claims:
+
+```ts
+requestLogger: (requestMetadata, user) =>
+  logger.child({
+    ...requestMetadata,
+    instance: user?.instance,
+    userId: user?.id,
+  }),
+```
+
 ## User
 
 By default, if `claims` (decoded token `JwtPayload`) are available, the `GraphQLContext.user` property will be set by constructing a `User` instance.
@@ -140,29 +188,36 @@ This library includes a `subscriptions` module to provide simple setup using the
    Example showing both normal context + subscription context creation:
 
    ```ts
-   const augmentContext = (context: GraphQLContext) => {
+   type ExtraContext = { services: Services; dataSource: DataSource; dataLoaders: DataLoaders }
+
+   // the `context` arg is typed `GraphQLContext<Logger, RequestInfo, AppUser | undefined>` here —
+   // TUser flows through from `createUser`, so just annotate the return type and let inference do the rest
+   const augmentContext = (context: GraphQLContext<Logger, RequestInfo, AppUser | undefined>): ExtraContext => {
      const services = createServices(context)
      const dataLoaders = createDataLoaders()
      return { services, dataSource, dataLoaders }
    }
 
-   // create a context using request based input
-   const createContext = createContextFactory<GraphQLContext>({
+   // create a context using request based input — TUser / TAugment inferred from the config
+   const createContext = createContextFactory({
      claimsToLog,
      requestInfoToLog,
-     requestLogger: (requestMetadata) => logger.child(requestMetadata),
+     requestLogger: (requestMetadata, user) => logger.child({ ...requestMetadata, instance: user?.instance }),
      createUser: ({ claims, req }) => findUpdateOrCreateUser(claims, req.headers.authorization?.substring(7)),
      augmentContext,
    })
 
    // create a context using graphql-ws Server#context callback input
-   const createSubscriptionContext = createSubscriptionContextFactory<GraphQLContext>({
-     claimsToLog
+   const createSubscriptionContext = createSubscriptionContextFactory({
+     claimsToLog,
      requestInfoToLog,
-     requestLogger: (requestMetadata) => logger.child(requestMetadata),
+     requestLogger: (requestMetadata, user) => logger.child({ ...requestMetadata, instance: user?.instance }),
      createUser: ({ claims, connectionParams }) => findUpdateOrCreateUser(claims, extractTokenFromConnectionParams(connectionParams)),
      augmentContext,
    })
+
+   // share one context type between query and subscription paths
+   export type GraphQLContext = Awaited<ReturnType<typeof createContext>>
    ```
 
 1. Create a subscriptions server, using the ws-server cleanup function in your server lifecycle.
@@ -204,85 +259,6 @@ 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.
 
-## Testing
-
-The testing submodule exports utility functions for easily constructing ApolloClient instances for integration testing on NodeJS. The `errorPolicy` is set to `all` so that returned errors can be checked.
-
-### Setup
-
-If you use this module, you need to install `@apollo/client`:
-
-```
-npm install --save-dev @apollo/client
-```
-
-### Usage
-
-- `createTestClient` accepts a url and optional accessToken.
-- `createTestClientWithClientCredentials` accepts a url and client credentials config and will fetch and attach an access token to each request.
-
-testing.ts
-
-```ts
-export const testClient = createTestClientWithClientCredentials(process.env.INTEGRATION_TEST_URL, clientCredentialsConfig)
-
-export const unauthenticatedClient = createTestClient(process.env.INTEGRATION_TEST_URL)
-```
-
-tweets.spec.ts
-
-```ts
-describe('tweets query', () => {
-  const tweetsQuery = gql`
-    query Tweets($input: TweetsWhere) {
-      tweets(input: $input) {
-        data {
-          text
-          createdAt
-        }
-      }
-    }
-  `
-
-  it('returns tweets with sensible default limit', async () => {
-    const {
-      data: { tweets },
-      errors,
-    } = await testClient.query<TweetsQuery>({
-      query: tweetsQuery,
-    })
-
-    expect(errors).toBeUndefined()
-    expect(tweets).toBeDefined()
-    expect(tweets?.data?.length).toBe(10)
-  })
-
-  it('guards against high limit', async () => {
-    const tooHighLimit = 101
-    await expect(async () => {
-      await testClient.query<TweetsQuery, TweetsQueryVariables>({
-        query: tweetsQuery,
-        variables: {
-          input: {
-            maxResults: tooHighLimit,
-          },
-        },
-      })
-    }).rejects.toThrowErrorMatchingInlineSnapshot(`"Response not successful: Received status code 400"`)
-  })
-
-  it('requires authorisation', async () => {
-    const { data, errors } = await unauthenticatedClient.query<TweetsQuery, TweetsQueryVariables>({
-      query: tweetsQuery,
-    })
-
-    expect(data.tweets).toBeNull()
-    expect(errors?.length).toBe(1)
-    expect(errors?.[0].message).toMatchInlineSnapshot(`"User is not authorized to access Query.tweets"`)
-  })
-})
-```
-
 ## Utils
 
 - `isIntrospectionQuery`: indicates whether the query is an introspection query, based on the operation name or query content.

package/context.d.ts

@@ -1,5 +1,6 @@
 import type { Logger } from '@makerx/node-common';
 import type { Request } from 'express';
+import { type BaseRequestInfo } from './request-info';
 import { User } from './User';
 export interface GraphQLContext<TLogger extends Logger = Logger, TRequestInfo extends BaseRequestInfo = RequestInfo, TUser = User | undefined> {
     logger: TLogger;
@@ -8,19 +9,6 @@ export interface GraphQLContext<TLogger extends Logger = Logger, TRequestInfo ex
     started: number;
 }
 export type AnyGraphqlContext = GraphQLContext<any, any, any>;
-export interface BaseRequestInfo extends Record<string, unknown> {
-    requestId: string;
-    protocol: 'http' | 'https' | 'ws';
-    host: string;
-    method: string;
-    url: string;
-    origin: string;
-    referer?: string;
-    correlationId?: string;
-    arrLogId?: string;
-    clientIp?: string;
-    userAgent?: string;
-}
 export interface LambdaContext {
     functionName?: string;
     awsRequestId?: string;
@@ -28,6 +16,10 @@ export interface LambdaContext {
 export type LambdaEvent = never;
 export type LambdaRequestInfo = BaseRequestInfo & LambdaContext;
 export type RequestInfo = BaseRequestInfo | LambdaRequestInfo;
+type KnownKeys<T> = keyof {
+    [K in keyof T as string extends K ? never : number extends K ? never : K]: T[K];
+};
+export type RequestInfoLogKey = KnownKeys<BaseRequestInfo> | keyof LambdaContext | (string & {});
 export interface JwtPayload {
     [key: string]: unknown;
     name?: string | undefined;
@@ -57,16 +49,19 @@ export interface ContextInput {
     event?: LambdaEvent;
 }
 export type CreateContext<TContext = GraphQLContext> = (input: ContextInput) => Promise<TContext>;
-export type CreateRequestLogger = (requestMetadata: Record<string, unknown>) => Logger;
+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 interface CreateContextConfig<TContext extends AnyGraphqlContext = GraphQLContext> {
-    requestLogger: CreateRequestLogger | Logger;
+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[];
-    createUser: CreateUser<InferUserFromContext<TContext>>;
-    requestInfoToLog?: Array<keyof RequestInfo>;
-    augmentContext?: (context: TContext) => Record<string, unknown> | Promise<Record<string, unknown>>;
-}
-export declare const buildBaseRequestInfo: (req: Request) => BaseRequestInfo;
-export declare const createContextFactory: <TContext extends AnyGraphqlContext = GraphQLContext>({ requestLogger, augmentRequestInfo, claimsToLog, createUser, requestInfoToLog, augmentContext, }: CreateContextConfig<TContext>) => CreateContext<TContext>;
+    requestInfoToLog?: Array<RequestInfoLogKey>;
+    augmentContext?: (context: GraphQLContext<TLogger, RequestInfo, TUser>) => TAugment | Promise<TAugment>;
+} & ([User | undefined] extends [TUser] ? {
+    createUser?: CreateUser<TUser>;
+} : {
+    createUser: CreateUser<TUser>;
+});
+export declare const createContextFactory: <TUser = User | undefined, TAugment extends Record<string, unknown> = Record<string, never>, TLogger extends Logger = Logger>(config: CreateContextConfig<TUser, TAugment, TLogger>) => CreateContext<GraphQLContext<TLogger, RequestInfo, TUser> & TAugment>;
 export declare const defaultCreateUser: CreateUser<User | undefined>;
+export {};

package/context.js

@@ -1,28 +1,18 @@
 'use strict';
 
-var crypto = require('crypto');
-var lodash = require('lodash');
+var compat = require('es-toolkit/compat');
+var requestInfo = require('./request-info.js');
 var User = require('./User.js');
 
-const buildBaseRequestInfo = (req) => ({
-    requestId: req.headers['x-request-id']?.toString() ?? crypto.randomUUID(),
-    protocol: req.protocol,
-    host: req.hostname ?? '',
-    method: req.method ?? '',
-    url: req.originalUrl,
-    origin: req.get('Origin') ?? '',
-    referer: req.headers.referer?.toString() ?? '',
-    arrLogId: req.headers['x-arr-log-id']?.toString() ?? undefined,
-    clientIp: req.headers['x-forwarded-for']?.toString() ?? req.socket.remoteAddress,
-    correlationId: req.headers['x-correlation-id']?.toString() ?? undefined,
-    userAgent: req.headers['user-agent']?.toString() ?? undefined,
-});
-const createContextFactory = ({ requestLogger, augmentRequestInfo, claimsToLog, createUser, requestInfoToLog, augmentContext, }) => {
-    // the function that creates the GraphQL context
+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);
     return async (input) => {
         const { req, claims, context } = input;
         // build base request info from the request
-        const baseRequestInfo = buildBaseRequestInfo(req);
+        const baseRequestInfo = requestInfo.buildBaseRequestInfo(req);
         // add lambda info from the context, if present
         let lambdaRequestInfo;
         if (context) {
@@ -34,12 +24,13 @@ const createContextFactory = ({ requestLogger, augmentRequestInfo, claimsToLog,
             };
         }
         // augment request info with the supplied function, if present
-        let requestInfo = lambdaRequestInfo ?? baseRequestInfo;
+        let requestInfo$1 = lambdaRequestInfo ?? baseRequestInfo;
         if (augmentRequestInfo)
-            requestInfo = {
-                ...requestInfo,
+            requestInfo$1 = {
+                ...requestInfo$1,
                 ...augmentRequestInfo(input),
             };
+        const user = await createUser(input);
         // create request logger
         let logger;
         if (typeof requestLogger === 'function') {
@@ -47,24 +38,22 @@ const createContextFactory = ({ requestLogger, augmentRequestInfo, claimsToLog,
             const requestLoggerMetadata = {};
             // add request info to log
             if (requestInfoToLog?.length)
-                requestLoggerMetadata.request = lodash.pick(requestInfo, requestInfoToLog);
+                requestLoggerMetadata.request = compat.pick(requestInfo$1, requestInfoToLog);
             // add user claims to log
             if (claims && claimsToLog?.length)
-                requestLoggerMetadata.user = lodash.pick(claims, claimsToLog);
+                requestLoggerMetadata.user = compat.pick(claims, claimsToLog);
             // build the request logger
-            logger = requestLogger(requestLoggerMetadata);
+            logger = requestLogger(requestLoggerMetadata, user);
         }
         else
             logger = requestLogger;
         const graphqlContext = {
-            requestInfo,
+            requestInfo: requestInfo$1,
             logger,
-            user: createUser ? await createUser(input) : undefined,
+            user,
             started: Date.now(),
         };
-        const augmentedGraphQLContext = augmentContext
-            ? { ...graphqlContext, ...(await augmentContext(graphqlContext)) }
-            : graphqlContext;
+        const augmentedGraphQLContext = augmentContext ? { ...graphqlContext, ...(await augmentContext(graphqlContext)) } : graphqlContext;
         return augmentedGraphQLContext;
     };
 };
@@ -75,7 +64,6 @@ const defaultCreateUser = ({ req, claims }) => {
     return Promise.resolve(new User.User(claims, accessToken));
 };
 
-exports.buildBaseRequestInfo = buildBaseRequestInfo;
 exports.createContextFactory = createContextFactory;
 exports.defaultCreateUser = defaultCreateUser;
 //# sourceMappingURL=context.js.map

package/context.js.map

@@ -1 +1 @@
-{"version":3,"file":"context.js","sources":["../src/context.ts"],"sourcesContent":["import type { Logger } from '@makerx/node-common'\nimport { randomUUID } from 'crypto'\nimport type { Request } from 'express'\nimport { pick } from 'lodash'\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 BaseRequestInfo extends Record<string, unknown> {\n  requestId: string\n  protocol: 'http' | 'https' | 'ws'\n  host: string\n  method: string\n  url: string\n  origin: string\n  referer?: string\n  correlationId?: string\n  arrLogId?: string\n  clientIp?: string\n  userAgent?: string\n}\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// 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 = (requestMetadata: Record<string, unknown>) => Logger\nexport type AugmentRequestInfo = (input: ContextInput) => Record<string, unknown>\n\nexport interface CreateContextConfig<TContext extends AnyGraphqlContext = GraphQLContext> {\n  requestLogger: CreateRequestLogger | Logger\n  augmentRequestInfo?: AugmentRequestInfo\n  claimsToLog?: string[]\n  createUser: CreateUser<InferUserFromContext<TContext>>\n  requestInfoToLog?: Array<keyof RequestInfo>\n  augmentContext?: (context: TContext) => Record<string, unknown> | Promise<Record<string, unknown>>\n}\n\nexport const buildBaseRequestInfo = (req: Request): BaseRequestInfo => ({\n  requestId: req.headers['x-request-id']?.toString() ?? randomUUID(),\n  protocol: req.protocol as 'http' | 'https',\n  host: req.hostname ?? '',\n  method: req.method ?? '',\n  url: req.originalUrl,\n  origin: req.get('Origin') ?? '',\n  referer: req.headers.referer?.toString() ?? '',\n  arrLogId: req.headers['x-arr-log-id']?.toString() ?? undefined,\n  clientIp: req.headers['x-forwarded-for']?.toString() ?? req.socket.remoteAddress,\n  correlationId: req.headers['x-correlation-id']?.toString() ?? undefined,\n  userAgent: req.headers['user-agent']?.toString() ?? undefined,\n})\n\nexport const createContextFactory = <TContext extends AnyGraphqlContext = GraphQLContext>({\n  requestLogger,\n  augmentRequestInfo,\n  claimsToLog,\n  createUser,\n  requestInfoToLog,\n  augmentContext,\n}: CreateContextConfig<TContext>): CreateContext<TContext> => {\n  // the function that creates the GraphQL context\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    // create request logger\n    let logger: Logger\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)\n    } else logger = requestLogger\n\n    const graphqlContext: GraphQLContext = {\n      requestInfo,\n      logger,\n      user: createUser ? await createUser(input) : undefined,\n      started: Date.now(),\n    }\n\n    const augmentedGraphQLContext = augmentContext\n      ? { ...graphqlContext, ...(await augmentContext(graphqlContext as TContext)) }\n      : graphqlContext\n\n    return augmentedGraphQLContext as TContext\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":["randomUUID","pick","User"],"mappings":";;;;;;MAqFa,oBAAoB,GAAG,CAAC,GAAY,MAAuB;AACtE,IAAA,SAAS,EAAE,GAAG,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE,QAAQ,EAAE,IAAIA,iBAAU,EAAE;IAClE,QAAQ,EAAE,GAAG,CAAC,QAA4B;AAC1C,IAAA,IAAI,EAAE,GAAG,CAAC,QAAQ,IAAI,EAAE;AACxB,IAAA,MAAM,EAAE,GAAG,CAAC,MAAM,IAAI,EAAE;IACxB,GAAG,EAAE,GAAG,CAAC,WAAW;IACpB,MAAM,EAAE,GAAG,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,EAAE;IAC/B,OAAO,EAAE,GAAG,CAAC,OAAO,CAAC,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE;IAC9C,QAAQ,EAAE,GAAG,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE,QAAQ,EAAE,IAAI,SAAS;AAC9D,IAAA,QAAQ,EAAE,GAAG,CAAC,OAAO,CAAC,iBAAiB,CAAC,EAAE,QAAQ,EAAE,IAAI,GAAG,CAAC,MAAM,CAAC,aAAa;IAChF,aAAa,EAAE,GAAG,CAAC,OAAO,CAAC,kBAAkB,CAAC,EAAE,QAAQ,EAAE,IAAI,SAAS;IACvE,SAAS,EAAE,GAAG,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,QAAQ,EAAE,IAAI,SAAS;AAC9D,CAAA;AAEM,MAAM,oBAAoB,GAAG,CAAsD,EACxF,aAAa,EACb,kBAAkB,EAClB,WAAW,EACX,UAAU,EACV,gBAAgB,EAChB,cAAc,GACgB,KAA6B;;AAE3D,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;;AAGH,QAAA,IAAI,MAAc;AAClB,QAAA,IAAI,OAAO,aAAa,KAAK,UAAU,EAAE;;YAEvC,MAAM,qBAAqB,GAA4B,EAAE;;YAEzD,IAAI,gBAAgB,EAAE,MAAM;gBAAE,qBAAqB,CAAC,OAAO,GAAGC,WAAI,CAAC,WAAW,EAAE,gBAAgB,CAAC;;AAEjG,YAAA,IAAI,MAAM,IAAI,WAAW,EAAE,MAAM;gBAAE,qBAAqB,CAAC,IAAI,GAAGA,WAAI,CAAC,MAAM,EAAE,WAAW,CAAC;;AAEzF,YAAA,MAAM,GAAG,aAAa,CAAC,qBAAqB,CAAC;QAC/C;;YAAO,MAAM,GAAG,aAAa;AAE7B,QAAA,MAAM,cAAc,GAAmB;YACrC,WAAW;YACX,MAAM;AACN,YAAA,IAAI,EAAE,UAAU,GAAG,MAAM,UAAU,CAAC,KAAK,CAAC,GAAG,SAAS;AACtD,YAAA,OAAO,EAAE,IAAI,CAAC,GAAG,EAAE;SACpB;QAED,MAAM,uBAAuB,GAAG;AAC9B,cAAE,EAAE,GAAG,cAAc,EAAE,IAAI,MAAM,cAAc,CAAC,cAA0B,CAAC,CAAC;cAC1E,cAAc;AAElB,QAAA,OAAO,uBAAmC;AAC5C,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,IAAIC,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>\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;;;;;"}

package/context.mjs

@@ -1,22 +1,12 @@
-import { randomUUID } from 'crypto';
-import { pick } from 'lodash';
+import { pick } from 'es-toolkit/compat';
+import { buildBaseRequestInfo } from './request-info.mjs';
 import { User } from './User.mjs';
 
-const buildBaseRequestInfo = (req) => ({
-    requestId: req.headers['x-request-id']?.toString() ?? randomUUID(),
-    protocol: req.protocol,
-    host: req.hostname ?? '',
-    method: req.method ?? '',
-    url: req.originalUrl,
-    origin: req.get('Origin') ?? '',
-    referer: req.headers.referer?.toString() ?? '',
-    arrLogId: req.headers['x-arr-log-id']?.toString() ?? undefined,
-    clientIp: req.headers['x-forwarded-for']?.toString() ?? req.socket.remoteAddress,
-    correlationId: req.headers['x-correlation-id']?.toString() ?? undefined,
-    userAgent: req.headers['user-agent']?.toString() ?? undefined,
-});
-const createContextFactory = ({ requestLogger, augmentRequestInfo, claimsToLog, createUser, requestInfoToLog, augmentContext, }) => {
-    // the function that creates the GraphQL context
+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);
     return async (input) => {
         const { req, claims, context } = input;
         // build base request info from the request
@@ -38,6 +28,7 @@ const createContextFactory = ({ requestLogger, augmentRequestInfo, claimsToLog,
                 ...requestInfo,
                 ...augmentRequestInfo(input),
             };
+        const user = await createUser(input);
         // create request logger
         let logger;
         if (typeof requestLogger === 'function') {
@@ -50,19 +41,17 @@ const createContextFactory = ({ requestLogger, augmentRequestInfo, claimsToLog,
             if (claims && claimsToLog?.length)
                 requestLoggerMetadata.user = pick(claims, claimsToLog);
             // build the request logger
-            logger = requestLogger(requestLoggerMetadata);
+            logger = requestLogger(requestLoggerMetadata, user);
         }
         else
             logger = requestLogger;
         const graphqlContext = {
             requestInfo,
             logger,
-            user: createUser ? await createUser(input) : undefined,
+            user,
             started: Date.now(),
         };
-        const augmentedGraphQLContext = augmentContext
-            ? { ...graphqlContext, ...(await augmentContext(graphqlContext)) }
-            : graphqlContext;
+        const augmentedGraphQLContext = augmentContext ? { ...graphqlContext, ...(await augmentContext(graphqlContext)) } : graphqlContext;
         return augmentedGraphQLContext;
     };
 };
@@ -73,5 +62,5 @@ const defaultCreateUser = ({ req, claims }) => {
     return Promise.resolve(new User(claims, accessToken));
 };
 
-export { buildBaseRequestInfo, createContextFactory, defaultCreateUser };
+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 { randomUUID } from 'crypto'\nimport type { Request } from 'express'\nimport { pick } from 'lodash'\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 BaseRequestInfo extends Record<string, unknown> {\n  requestId: string\n  protocol: 'http' | 'https' | 'ws'\n  host: string\n  method: string\n  url: string\n  origin: string\n  referer?: string\n  correlationId?: string\n  arrLogId?: string\n  clientIp?: string\n  userAgent?: string\n}\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// 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 = (requestMetadata: Record<string, unknown>) => Logger\nexport type AugmentRequestInfo = (input: ContextInput) => Record<string, unknown>\n\nexport interface CreateContextConfig<TContext extends AnyGraphqlContext = GraphQLContext> {\n  requestLogger: CreateRequestLogger | Logger\n  augmentRequestInfo?: AugmentRequestInfo\n  claimsToLog?: string[]\n  createUser: CreateUser<InferUserFromContext<TContext>>\n  requestInfoToLog?: Array<keyof RequestInfo>\n  augmentContext?: (context: TContext) => Record<string, unknown> | Promise<Record<string, unknown>>\n}\n\nexport const buildBaseRequestInfo = (req: Request): BaseRequestInfo => ({\n  requestId: req.headers['x-request-id']?.toString() ?? randomUUID(),\n  protocol: req.protocol as 'http' | 'https',\n  host: req.hostname ?? '',\n  method: req.method ?? '',\n  url: req.originalUrl,\n  origin: req.get('Origin') ?? '',\n  referer: req.headers.referer?.toString() ?? '',\n  arrLogId: req.headers['x-arr-log-id']?.toString() ?? undefined,\n  clientIp: req.headers['x-forwarded-for']?.toString() ?? req.socket.remoteAddress,\n  correlationId: req.headers['x-correlation-id']?.toString() ?? undefined,\n  userAgent: req.headers['user-agent']?.toString() ?? undefined,\n})\n\nexport const createContextFactory = <TContext extends AnyGraphqlContext = GraphQLContext>({\n  requestLogger,\n  augmentRequestInfo,\n  claimsToLog,\n  createUser,\n  requestInfoToLog,\n  augmentContext,\n}: CreateContextConfig<TContext>): CreateContext<TContext> => {\n  // the function that creates the GraphQL context\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    // create request logger\n    let logger: Logger\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)\n    } else logger = requestLogger\n\n    const graphqlContext: GraphQLContext = {\n      requestInfo,\n      logger,\n      user: createUser ? await createUser(input) : undefined,\n      started: Date.now(),\n    }\n\n    const augmentedGraphQLContext = augmentContext\n      ? { ...graphqlContext, ...(await augmentContext(graphqlContext as TContext)) }\n      : graphqlContext\n\n    return augmentedGraphQLContext as TContext\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":";;;;MAqFa,oBAAoB,GAAG,CAAC,GAAY,MAAuB;AACtE,IAAA,SAAS,EAAE,GAAG,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE,QAAQ,EAAE,IAAI,UAAU,EAAE;IAClE,QAAQ,EAAE,GAAG,CAAC,QAA4B;AAC1C,IAAA,IAAI,EAAE,GAAG,CAAC,QAAQ,IAAI,EAAE;AACxB,IAAA,MAAM,EAAE,GAAG,CAAC,MAAM,IAAI,EAAE;IACxB,GAAG,EAAE,GAAG,CAAC,WAAW;IACpB,MAAM,EAAE,GAAG,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,EAAE;IAC/B,OAAO,EAAE,GAAG,CAAC,OAAO,CAAC,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE;IAC9C,QAAQ,EAAE,GAAG,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE,QAAQ,EAAE,IAAI,SAAS;AAC9D,IAAA,QAAQ,EAAE,GAAG,CAAC,OAAO,CAAC,iBAAiB,CAAC,EAAE,QAAQ,EAAE,IAAI,GAAG,CAAC,MAAM,CAAC,aAAa;IAChF,aAAa,EAAE,GAAG,CAAC,OAAO,CAAC,kBAAkB,CAAC,EAAE,QAAQ,EAAE,IAAI,SAAS;IACvE,SAAS,EAAE,GAAG,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,QAAQ,EAAE,IAAI,SAAS;AAC9D,CAAA;AAEM,MAAM,oBAAoB,GAAG,CAAsD,EACxF,aAAa,EACb,kBAAkB,EAClB,WAAW,EACX,UAAU,EACV,gBAAgB,EAChB,cAAc,GACgB,KAA6B;;AAE3D,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;;AAGH,QAAA,IAAI,MAAc;AAClB,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,CAAC;QAC/C;;YAAO,MAAM,GAAG,aAAa;AAE7B,QAAA,MAAM,cAAc,GAAmB;YACrC,WAAW;YACX,MAAM;AACN,YAAA,IAAI,EAAE,UAAU,GAAG,MAAM,UAAU,CAAC,KAAK,CAAC,GAAG,SAAS;AACtD,YAAA,OAAO,EAAE,IAAI,CAAC,GAAG,EAAE;SACpB;QAED,MAAM,uBAAuB,GAAG;AAC9B,cAAE,EAAE,GAAG,cAAc,EAAE,IAAI,MAAM,cAAc,CAAC,cAA0B,CAAC,CAAC;cAC1E,cAAc;AAElB,QAAA,OAAO,uBAAmC;AAC5C,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>\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;;;;"}

package/index.d.ts

@@ -1,7 +1,7 @@
 export * from './context';
-export * from './User';
-export * from './utils';
 export * from './logging';
+export * from './request-info';
 export * from './schema-util';
-export * from './shield';
-export * from './models';
+export * from './type-utils';
+export * from './User';
+export * from './utils';

package/index.js

@@ -1,25 +1,25 @@
 'use strict';
 
 var context = require('./context.js');
-var User = require('./User.js');
-var utils = require('./utils.js');
 var logging = require('./logging.js');
+var requestInfo = require('./request-info.js');
 var schemaUtil = require('./schema-util.js');
-var shield = require('./shield.js');
+var User = require('./User.js');
+var utils = require('./utils.js');
 
 
 
-exports.buildBaseRequestInfo = context.buildBaseRequestInfo;
 exports.createContextFactory = context.createContextFactory;
 exports.defaultCreateUser = context.defaultCreateUser;
+exports.logGraphQLOperation = logging.logGraphQLOperation;
+exports.logSubscriptionOperation = logging.logSubscriptionOperation;
+exports.buildBaseRequestInfo = requestInfo.buildBaseRequestInfo;
+exports.buildConnectRequestInfo = requestInfo.buildConnectRequestInfo;
+exports.connectRequestBaseUrl = requestInfo.connectRequestBaseUrl;
+exports.requestBaseUrl = requestInfo.requestBaseUrl;
+exports.requireExplicitResolversForScalars = schemaUtil.requireExplicitResolversForScalars;
 exports.User = User.User;
 exports.isIntrospectionQuery = utils.isIntrospectionQuery;
 exports.isNil = utils.isNil;
 exports.isNotNil = utils.isNotNil;
-exports.logGraphQLOperation = logging.logGraphQLOperation;
-exports.logSubscriptionOperation = logging.logSubscriptionOperation;
-exports.requireExplicitResolversForScalars = schemaUtil.requireExplicitResolversForScalars;
-exports.combineRuleWithAll = shield.combineRuleWithAll;
-exports.createRule = shield.createRule;
-exports.createShieldSchema = shield.createShieldSchema;
 //# sourceMappingURL=index.js.map

package/index.mjs

@@ -1,7 +1,7 @@
-export { buildBaseRequestInfo, createContextFactory, defaultCreateUser } from './context.mjs';
-export { User } from './User.mjs';
-export { isIntrospectionQuery, isNil, isNotNil } from './utils.mjs';
+export { createContextFactory, defaultCreateUser } from './context.mjs';
 export { logGraphQLOperation, logSubscriptionOperation } from './logging.mjs';
+export { buildBaseRequestInfo, buildConnectRequestInfo, connectRequestBaseUrl, requestBaseUrl } from './request-info.mjs';
 export { requireExplicitResolversForScalars } from './schema-util.mjs';
-export { combineRuleWithAll, createRule, createShieldSchema } from './shield.mjs';
+export { User } from './User.mjs';
+export { isIntrospectionQuery, isNil, isNotNil } from './utils.mjs';
 //# sourceMappingURL=index.mjs.map