@makerx/graphql-core 1.0.0

package/README.md

@@ -0,0 +1,305 @@
+# GraphQL Core
+
+A set of core GraphQL utilities that MakerX uses to build GraphQL APIs.
+
+These utilities avoid dependencies on any particular GraphQL server or logging implementation, providing a standard set of behaviours to use across varying implementations.
+
+Note: See explanation on \*Express peer dependency below.
+
+## Context
+
+`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
+
+### 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
+  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
+  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
+  augmentContext: (context): ExtraContext => {
+    const services = createServices(context)
+    const loaders = createLoaders(services)
+    return { services, loaders }
+  },
+})
+```
+
+### Step 2 - Map the context creation to implementation
+
+These examples show how you might map implementation-specific context functions to your implementation-agnostic context creation function (from step 1).
+Note: examples assume that a JWT auth middleware has set `req.user` to the decoded token payload (claims). This is optional.
+
+app.ts
+
+```ts
+// wire up the createContext function, providing `ContextInput` for apollo-server-express implementation)
+const server = new ApolloServer({
+  ...apolloServerConfig,
+  context: ({ req }) => createContext({ req, claims: req.user }),
+})
+```
+
+lambda.ts
+
+```ts
+// wire up the createContext function, providing `ContextInput` for apollo-server-lambda implementation
+const server = new ApolloServer({
+  ...apolloServerConfig,
+  context: ({ event, context, express: { req } }) =>
+    createContext({ req, claims: req.user, event: event as LambdaEvent, context: context as LambdaContext }),
+})
+```
+
+yoga.ts
+
+```ts
+// wire up the createContext function, providing `ContextInput` for graphql-yoga implementation
+const graphqlServer = createServer({
+  ...yogaServerConfig,
+  context: ({ req }) => createContext({ req, claims: req.user }),
+})
+```
+
+## User
+
+By default, if `claims` (decoded token `JwtPayload`) are available, the `GraphQLContext.user` property will be set by constructing a `User` instance.
+
+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).                                                                             |
+
+### Custom user
+
+If you wish to customise your `GraphQLContext.user` object, provide a `createUser` function to override the default `User` creation.
+
+```ts
+const createUser: CreateUser = async ({ claims }) => {
+  const roles = await loadRoles(claims.email)
+  return { name: claims.name, email: claims.email, roles }
+}
+
+const graphqlServer = createServer({
+  ...config,
+  context: ({ req }) => createContext({ req, claims: req.user, createUser }),
+})
+```
+
+## Logging
+
+### logGraphQLOperation
+
+The `logGraphQLOperation` function will log:
+
+- `operationName`: the operation name, if supplied
+- `query`: the formatted graphql query or mutation, or 'IntrospectionQuery'
+- `variables`: the graphql request variables
+- `duration`: the duration of request processing
+- `errors`: the graphql response errors, if any
+
+Notes:
+
+- null or undefined values will be omitted
+- introspection queries will not be logged outside of production
+
+This function can be used across implementations, e.g. in a [GraphQL Envelop plugin](https://www.envelop.dev/docs/plugins) or [ApolloServer plugin](https://www.apollographql.com/docs/apollo-server/integrations/plugins/).
+
+### logGraphQLExecutionArgs
+
+The `logGraphQLExecutionArgs` will log `operationName`, `query` and `variables` params from the GraphQL `ExecutionArgs`.
+
+This can be used when logging from execution callbacks, e.g. graphql-ws Server [onOperation](https://the-guild.dev/graphql/ws/docs/interfaces/server.ServerOptions#onoperation) and [onNext](https://the-guild.dev/graphql/ws/docs/interfaces/server.ServerOptions#onnext).
+
+## GraphQL subscriptions
+
+This library includes a `subscriptions` module to provide simple setup using the [GraphQL WS](https://the-guild.dev/graphql/ws) package.
+
+1. Install subscriptions dependencies (optional peer dependencies of this package):
+   ```
+   npm i graphql-ws ws
+   ```
+1. Subscription context setup:
+
+   `createSubscriptionContextFactory` returns a function that creates an equivalent GraphQL context using input supplied to the [graphql-ws Server context callback](https://the-guild.dev/graphql/ws/docs/interfaces/server.ServerOptions#onconnect).
+
+   Example showing both normal context + subscription context creation:
+
+   ```ts
+   const augmentContext = (context: GraphQLContext) => {
+     const services = createServices(context)
+     const dataLoaders = createDataLoaders()
+     return { services, dataSource, dataLoaders }
+   }
+
+   // create a context using request based input
+   const createContext = createContextFactory<GraphQLContext>({
+     claimsToLog,
+     requestInfoToLog,
+     requestLogger: (requestMetadata) => logger.child(requestMetadata),
+     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
+     requestInfoToLog,
+     requestLogger: (requestMetadata) => logger.child(requestMetadata),
+     createUser: ({ claims, connectionParams }) => findUpdateOrCreateUser(claims, extractTokenFromConnectionParams(connectionParams)),
+     augmentContext,
+   })
+   ```
+
+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)
+   - GraphQL context creation
+   - Logging from the server `onConnect`, `onDisconnect`, `onOperation`, `onNext` and `onError` callbacks
+
+   Example for Apollo Server (`wsServerCleanup` called in the `drainServer` plugin callback):
+
+   ```ts
+    export const startApolloServer = async (app: Express, httpServer: http.Server) => {
+      logger.info('Building schema')
+      const schema = createSchema()
+
+      logger.info('Initialising subscriptions websocket server')
+      const wsServerCleanup = useSubscriptionsServer({
+        schema,
+        httpServer,
+        logger,
+        createSubscriptionContext,
+        jwtClaimsToLog: config.get('logging.userClaimsToLog'),
+        requireAuth: true,
+        verifyToken: (host, token) => verifyForHost(host, token, config.get('auth.bearer')),
+      })
+
+      logger.info('Starting apollo server')
+      const server = new ApolloServer<GraphQLContext>({
+        schema,
+        plugins: plugins(httpServer, wsServerCleanup),
+        introspection: true,
+        csrfPrevention: true,
+      })
+      await server.start()
+
+   ```
+
+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.
+
+- `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.
+
+## \*Express peer dependency
+
+ApolloServer v3 standardises on the Express request representation.
+
+GraphQL Yoga uses the NodeJS http request representation, plus adds the Express version when using an Express server.
+
+This library therefore takes a peer dependency on Express as the standard (common) request representation.
+
+The ApolloServer [v4 roadmap](https://github.com/apollographql/apollo-server/blob/main/ROADMAP.md#replace-9-core-maintained-bindings-with-a-stable-http-abstraction) will standardise on the NodeJS http request representation.
+
+This library may swap to the NodeJS http representation in a future version.

package/User.d.ts

@@ -0,0 +1,14 @@
+import { JwtPayload } from './context';
+export declare class User {
+    readonly token: string;
+    readonly claims: JwtPayload;
+    constructor(claims: JwtPayload, accessToken: string);
+    get email(): string | undefined;
+    get name(): string | undefined;
+    get id(): string;
+    get scopes(): string[];
+    get roles(): string[];
+    private first;
+    private firstOrThrow;
+}
+//# sourceMappingURL=User.d.ts.map

package/User.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"User.d.ts","sourceRoot":"","sources":["../src/User.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAA;AAGtC,qBAAa,IAAI;IACf,SAAgB,KAAK,EAAE,MAAM,CAAA;IAC7B,SAAgB,MAAM,EAAE,UAAU,CAAA;gBAEtB,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM;IAKnD,IAAI,KAAK,IAAI,MAAM,GAAG,SAAS,CAQ9B;IAED,IAAI,IAAI,IAAI,MAAM,GAAG,SAAS,CAK7B;IAED,IAAI,EAAE,IAAI,MAAM,CAEf;IAED,IAAI,MAAM,IAAI,MAAM,EAAE,CAErB;IAED,IAAI,KAAK,IAAI,MAAM,EAAE,CAEpB;IAED,OAAO,CAAC,KAAK;IAOb,OAAO,CAAC,YAAY;CAKrB"}

package/User.js

@@ -0,0 +1,49 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.User = void 0;
+const utils_1 = require("./utils");
+class User {
+    constructor(claims, accessToken) {
+        this.claims = claims;
+        this.token = accessToken;
+    }
+    get email() {
+        return (this.claims.email ??
+            this.claims.emails?.[0] ??
+            this.claims.preferred_username ??
+            this.claims.unique_name ??
+            this.claims.upn);
+    }
+    get name() {
+        if (this.claims.name)
+            return this.claims.name;
+        const otherNames = [this.claims.given_name, this.claims.family_name].filter(utils_1.isNotNil);
+        if (otherNames.length > 0)
+            return otherNames.join(' ');
+        return undefined;
+    }
+    get id() {
+        return this.firstOrThrow('oid', 'sub');
+    }
+    get scopes() {
+        return this.claims.scp ? this.claims.scp.split(' ') : [];
+    }
+    get roles() {
+        return this.claims.roles ?? [];
+    }
+    first(...claims) {
+        for (const key of claims) {
+            if (this.claims[key])
+                return this.claims[key];
+        }
+        return undefined;
+    }
+    firstOrThrow(...claims) {
+        const first = this.first(...claims);
+        if (!first)
+            throw new Error(`claims do not include any of: ${claims.join(', ')}`);
+        return first;
+    }
+}
+exports.User = User;
+//# sourceMappingURL=User.js.map

package/User.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"User.js","sourceRoot":"","sources":["../src/User.ts"],"names":[],"mappings":";;;AACA,mCAAkC;AAElC,MAAa,IAAI;IAIf,YAAY,MAAkB,EAAE,WAAmB;QACjD,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QACpB,IAAI,CAAC,KAAK,GAAG,WAAW,CAAA;IAC1B,CAAC;IAED,IAAI,KAAK;QACP,OAAO,CACL,IAAI,CAAC,MAAM,CAAC,KAAK;YAChB,IAAI,CAAC,MAAM,CAAC,MAA+B,EAAE,CAAC,CAAC,CAAC;YACjD,IAAI,CAAC,MAAM,CAAC,kBAAkB;YAC9B,IAAI,CAAC,MAAM,CAAC,WAAW;YACvB,IAAI,CAAC,MAAM,CAAC,GAAG,CAChB,CAAA;IACH,CAAC;IAED,IAAI,IAAI;QACN,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI;YAAE,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAA;QAC7C,MAAM,UAAU,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,MAAM,CAAC,gBAAQ,CAAC,CAAA;QACrF,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC;YAAE,OAAO,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;QACtD,OAAO,SAAS,CAAA;IAClB,CAAC;IAED,IAAI,EAAE;QACJ,OAAO,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,KAAK,CAAC,CAAA;IACxC,CAAC;IAED,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAA;IAC1D,CAAC;IAED,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,IAAI,EAAE,CAAA;IAChC,CAAC;IAEO,KAAK,CAAC,GAAG,MAA+B;QAC9C,KAAK,MAAM,GAAG,IAAI,MAAM,EAAE;YACxB,IAAI,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC;gBAAE,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAW,CAAA;SACxD;QACD,OAAO,SAAS,CAAA;IAClB,CAAC;IAEO,YAAY,CAAC,GAAG,MAA+B;QACrD,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,MAAM,CAAC,CAAA;QACnC,IAAI,CAAC,KAAK;YAAE,MAAM,IAAI,KAAK,CAAC,iCAAiC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;QACjF,OAAO,KAAK,CAAA;IACd,CAAC;CACF;AAlDD,oBAkDC"}

package/context.d.ts

@@ -0,0 +1,68 @@
+import { Logger } from '@makerx/node-common';
+import type { Request } from 'express';
+import { User } from './User';
+export interface GraphQLContext<TLogger extends Logger = Logger, TRequestInfo extends BaseRequestInfo = RequestInfo, TUser = User | undefined> {
+    logger: TLogger;
+    requestInfo: TRequestInfo;
+    user: TUser;
+    started: number;
+}
+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;
+}
+export interface LambdaContext {
+    functionName?: string;
+    awsRequestId?: string;
+}
+export type LambdaEvent = never;
+export type LambdaRequestInfo = BaseRequestInfo & LambdaContext;
+export type RequestInfo = BaseRequestInfo | LambdaRequestInfo;
+export interface JwtPayload {
+    [key: string]: unknown;
+    name?: string | undefined;
+    email?: string | undefined;
+    given_name?: string | undefined;
+    family_name?: string | undefined;
+    preferred_username?: string | undefined;
+    upn?: string | undefined;
+    unique_name?: string | undefined;
+    oid?: string | undefined;
+    iss?: string | undefined;
+    sub?: string | undefined;
+    aud?: string | string[] | undefined;
+    roles?: string[] | undefined;
+    scp?: string | undefined;
+    exp?: number | undefined;
+    nbf?: number | undefined;
+    iat?: number | undefined;
+    jti?: string | undefined;
+}
+export type CreateUser<T = User | undefined> = (input: Omit<ContextInput, 'createUser'>) => Promise<T>;
+export interface ContextInput {
+    req: Request;
+    claims?: JwtPayload;
+    context?: LambdaContext;
+    event?: LambdaEvent;
+}
+export type CreateContext<TContext = GraphQLContext> = (input: ContextInput) => Promise<TContext>;
+export type CreateRequestLogger = (requestMetadata: Record<string, unknown>) => Logger;
+export type AugmentRequestInfo = (input: ContextInput) => Record<string, unknown>;
+export interface CreateContextConfig<TContext = GraphQLContext> {
+    requestLogger: CreateRequestLogger | Logger;
+    augmentRequestInfo?: AugmentRequestInfo;
+    claimsToLog?: string[];
+    createUser?: CreateUser;
+    requestInfoToLog?: Array<keyof RequestInfo>;
+    augmentContext?: (context: TContext) => Record<string, unknown> | Promise<Record<string, unknown>>;
+}
+export declare const createContextFactory: <TContext extends GraphQLContext<Logger, RequestInfo, User | undefined> = GraphQLContext<Logger, RequestInfo, User | undefined>>({ requestLogger, augmentRequestInfo, claimsToLog, createUser, requestInfoToLog, augmentContext, }: CreateContextConfig<TContext>) => CreateContext<TContext>;
+//# sourceMappingURL=context.d.ts.map

package/context.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"context.d.ts","sourceRoot":"","sources":["../src/context.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAA;AAE5C,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,SAAS,CAAA;AAEtC,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAA;AAE7B,MAAM,WAAW,cAAc,CAC7B,OAAO,SAAS,MAAM,GAAG,MAAM,EAC/B,YAAY,SAAS,eAAe,GAAG,WAAW,EAClD,KAAK,GAAG,IAAI,GAAG,SAAS;IAExB,MAAM,EAAE,OAAO,CAAA;IACf,WAAW,EAAE,YAAY,CAAA;IACzB,IAAI,EAAE,KAAK,CAAA;IACX,OAAO,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,WAAW,eAAgB,SAAQ,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAC9D,SAAS,EAAE,MAAM,CAAA;IACjB,QAAQ,EAAE,MAAM,GAAG,OAAO,GAAG,IAAI,CAAA;IACjC,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,MAAM,CAAA;IACd,GAAG,EAAE,MAAM,CAAA;IACX,MAAM,EAAE,MAAM,CAAA;IACd,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB;AAED,MAAM,WAAW,aAAa;IAC5B,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB;AACD,MAAM,MAAM,WAAW,GAAG,KAAK,CAAA;AAC/B,MAAM,MAAM,iBAAiB,GAAG,eAAe,GAAG,aAAa,CAAA;AAC/D,MAAM,MAAM,WAAW,GAAG,eAAe,GAAG,iBAAiB,CAAA;AAG7D,MAAM,WAAW,UAAU;IACzB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;IACtB,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACzB,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAC1B,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAC/B,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAChC,kBAAkB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACvC,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACxB,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAChC,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACxB,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACxB,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACxB,GAAG,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,SAAS,CAAA;IACnC,KAAK,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAA;IAC5B,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACxB,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACxB,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACxB,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACxB,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;CACzB;AAED,MAAM,MAAM,UAAU,CAAC,CAAC,GAAG,IAAI,GAAG,SAAS,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,YAAY,EAAE,YAAY,CAAC,KAAK,OAAO,CAAC,CAAC,CAAC,CAAA;AACtG,MAAM,WAAW,YAAY;IAC3B,GAAG,EAAE,OAAO,CAAA;IACZ,MAAM,CAAC,EAAE,UAAU,CAAA;IACnB,OAAO,CAAC,EAAE,aAAa,CAAA;IACvB,KAAK,CAAC,EAAE,WAAW,CAAA;CACpB;AACD,MAAM,MAAM,aAAa,CAAC,QAAQ,GAAG,cAAc,IAAI,CAAC,KAAK,EAAE,YAAY,KAAK,OAAO,CAAC,QAAQ,CAAC,CAAA;AACjG,MAAM,MAAM,mBAAmB,GAAG,CAAC,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,MAAM,CAAA;AACtF,MAAM,MAAM,kBAAkB,GAAG,CAAC,KAAK,EAAE,YAAY,KAAK,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;AAEjF,MAAM,WAAW,mBAAmB,CAAC,QAAQ,GAAG,cAAc;IAC5D,aAAa,EAAE,mBAAmB,GAAG,MAAM,CAAA;IAC3C,kBAAkB,CAAC,EAAE,kBAAkB,CAAA;IACvC,WAAW,CAAC,EAAE,MAAM,EAAE,CAAA;IACtB,UAAU,CAAC,EAAE,UAAU,CAAA;IACvB,gBAAgB,CAAC,EAAE,KAAK,CAAC,MAAM,WAAW,CAAC,CAAA;IAC3C,cAAc,CAAC,EAAE,CAAC,OAAO,EAAE,QAAQ,KAAK,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAA;CACnG;AAED,eAAO,MAAM,oBAAoB,+RAuEhC,CAAA"}

package/context.js

@@ -0,0 +1,79 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createContextFactory = void 0;
+const crypto_1 = require("crypto");
+const lodash_pick_1 = __importDefault(require("lodash.pick"));
+const User_1 = require("./User");
+const createContextFactory = ({ requestLogger, augmentRequestInfo, claimsToLog, createUser = defaultCreateUser, requestInfoToLog, augmentContext, }) => {
+    // the function that creates the GraphQL context
+    return async (input) => {
+        const { req, claims, context } = input;
+        // build base request info from the request
+        const baseRequestInfo = {
+            requestId: req.headers['x-request-id']?.toString() ?? (0, crypto_1.randomUUID)(),
+            protocol: req.protocol,
+            host: req.get('Host') ?? '',
+            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,
+        };
+        // add lambda info from the context, if present
+        let lambdaRequestInfo;
+        if (context) {
+            const { awsRequestId, functionName } = context;
+            lambdaRequestInfo = {
+                awsRequestId,
+                functionName,
+                ...baseRequestInfo,
+            };
+        }
+        // augment request info with the supplied function, if present
+        let requestInfo = lambdaRequestInfo ?? baseRequestInfo;
+        if (augmentRequestInfo)
+            requestInfo = {
+                ...requestInfo,
+                ...augmentRequestInfo(input),
+            };
+        // create request logger
+        let logger;
+        if (typeof requestLogger === 'function') {
+            // build request logger metadata
+            const requestLoggerMetadata = {};
+            // add request info to log
+            if (requestInfoToLog?.length)
+                requestLoggerMetadata.request = (0, lodash_pick_1.default)(requestInfo, requestInfoToLog);
+            // add user claims to log
+            if (claims && claimsToLog?.length)
+                requestLoggerMetadata.user = (0, lodash_pick_1.default)(claims, claimsToLog);
+            // build the request logger
+            logger = requestLogger(requestLoggerMetadata);
+        }
+        else
+            logger = requestLogger;
+        const graphqlContext = {
+            requestInfo,
+            logger,
+            user: createUser ? await createUser(input) : undefined,
+            started: Date.now(),
+        };
+        const augmentedGraphQLContext = augmentContext
+            ? { ...graphqlContext, ...(await augmentContext(graphqlContext)) }
+            : graphqlContext;
+        return augmentedGraphQLContext;
+    };
+};
+exports.createContextFactory = createContextFactory;
+const defaultCreateUser = ({ req, claims }) => {
+    if (!claims)
+        return Promise.resolve(undefined);
+    const accessToken = req.headers.authorization?.startsWith('Bearer') ? req.headers.authorization?.substring(7) ?? '' : '';
+    return Promise.resolve(new User_1.User(claims, accessToken));
+};
+//# sourceMappingURL=context.js.map

package/context.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"context.js","sourceRoot":"","sources":["../src/context.ts"],"names":[],"mappings":";;;;;;AACA,mCAAmC;AAEnC,8DAA8B;AAC9B,iCAA6B;AA4EtB,MAAM,oBAAoB,GAAG,CAAmD,EACrF,aAAa,EACb,kBAAkB,EAClB,WAAW,EACX,UAAU,GAAG,iBAAiB,EAC9B,gBAAgB,EAChB,cAAc,GACgB,EAA2B,EAAE;IAC3D,gDAAgD;IAChD,OAAO,KAAK,EAAE,KAAmB,EAAE,EAAE;QACnC,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,KAAK,CAAA;QAEtC,2CAA2C;QAC3C,MAAM,eAAe,GAAoB;YACvC,SAAS,EAAE,GAAG,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE,QAAQ,EAAE,IAAI,IAAA,mBAAU,GAAE;YAClE,QAAQ,EAAE,GAAG,CAAC,QAA4B;YAC1C,IAAI,EAAE,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,EAAE;YAC3B,MAAM,EAAE,GAAG,CAAC,MAAM,IAAI,EAAE;YACxB,GAAG,EAAE,GAAG,CAAC,WAAW;YACpB,MAAM,EAAE,GAAG,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,EAAE;YAC/B,OAAO,EAAE,GAAG,CAAC,OAAO,CAAC,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE;YAC9C,QAAQ,EAAE,GAAG,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE,QAAQ,EAAE,IAAI,SAAS;YAC9D,QAAQ,EAAE,GAAG,CAAC,OAAO,CAAC,iBAAiB,CAAC,EAAE,QAAQ,EAAE,IAAI,GAAG,CAAC,MAAM,CAAC,aAAa;YAChF,aAAa,EAAE,GAAG,CAAC,OAAO,CAAC,kBAAkB,CAAC,EAAE,QAAQ,EAAE,IAAI,SAAS;SACxE,CAAA;QAED,+CAA+C;QAC/C,IAAI,iBAAgD,CAAA;QACpD,IAAI,OAAO,EAAE;YACX,MAAM,EAAE,YAAY,EAAE,YAAY,EAAE,GAAG,OAAO,CAAA;YAC9C,iBAAiB,GAAG;gBAClB,YAAY;gBACZ,YAAY;gBACZ,GAAG,eAAe;aACnB,CAAA;SACF;QAED,8DAA8D;QAC9D,IAAI,WAAW,GAAgB,iBAAiB,IAAI,eAAe,CAAA;QACnE,IAAI,kBAAkB;YACpB,WAAW,GAAG;gBACZ,GAAG,WAAW;gBACd,GAAG,kBAAkB,CAAC,KAAK,CAAC;aAC7B,CAAA;QAEH,wBAAwB;QACxB,IAAI,MAAc,CAAA;QAClB,IAAI,OAAO,aAAa,KAAK,UAAU,EAAE;YACvC,gCAAgC;YAChC,MAAM,qBAAqB,GAA4B,EAAE,CAAA;YACzD,0BAA0B;YAC1B,IAAI,gBAAgB,EAAE,MAAM;gBAAE,qBAAqB,CAAC,OAAO,GAAG,IAAA,qBAAI,EAAC,WAAW,EAAE,gBAAgB,CAAC,CAAA;YACjG,yBAAyB;YACzB,IAAI,MAAM,IAAI,WAAW,EAAE,MAAM;gBAAE,qBAAqB,CAAC,IAAI,GAAG,IAAA,qBAAI,EAAC,MAAM,EAAE,WAAW,CAAC,CAAA;YACzF,2BAA2B;YAC3B,MAAM,GAAG,aAAa,CAAC,qBAAqB,CAAC,CAAA;SAC9C;;YAAM,MAAM,GAAG,aAAa,CAAA;QAE7B,MAAM,cAAc,GAAmB;YACrC,WAAW;YACX,MAAM;YACN,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,MAAM,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS;YACtD,OAAO,EAAE,IAAI,CAAC,GAAG,EAAE;SACpB,CAAA;QAED,MAAM,uBAAuB,GAAG,cAAc;YAC5C,CAAC,CAAC,EAAE,GAAG,cAAc,EAAE,GAAG,CAAC,MAAM,cAAc,CAAC,cAA0B,CAAC,CAAC,EAAE;YAC9E,CAAC,CAAC,cAAc,CAAA;QAElB,OAAO,uBAAmC,CAAA;IAC5C,CAAC,CAAA;AACH,CAAC,CAAA;AAvEY,QAAA,oBAAoB,wBAuEhC;AAED,MAAM,iBAAiB,GAAiC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,EAAE,EAAE;IAC1E,IAAI,CAAC,MAAM;QAAE,OAAO,OAAO,CAAC,OAAO,CAAC,SAAS,CAAC,CAAA;IAC9C,MAAM,WAAW,GAAG,GAAG,CAAC,OAAO,CAAC,aAAa,EAAE,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,aAAa,EAAE,SAAS,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAA;IACxH,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,WAAI,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC,CAAA;AACvD,CAAC,CAAA"}

package/index.d.ts

@@ -0,0 +1,6 @@
+export * from './context';
+export * from './User';
+export * from './utils';
+export * from './logging';
+export * from './subscriptions';
+//# sourceMappingURL=index.d.ts.map

package/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAA;AACzB,cAAc,QAAQ,CAAA;AACtB,cAAc,SAAS,CAAA;AACvB,cAAc,WAAW,CAAA;AACzB,cAAc,iBAAiB,CAAA"}

package/index.js

@@ -0,0 +1,22 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./context"), exports);
+__exportStar(require("./User"), exports);
+__exportStar(require("./utils"), exports);
+__exportStar(require("./logging"), exports);
+__exportStar(require("./subscriptions"), exports);
+//# sourceMappingURL=index.js.map

package/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,4CAAyB;AACzB,yCAAsB;AACtB,0CAAuB;AACvB,4CAAyB;AACzB,kDAA+B"}

package/logging.d.ts

@@ -0,0 +1,21 @@
+import { Logger } from '@makerx/node-common';
+import { ExecutionArgs, GraphQLFormattedError } from 'graphql';
+interface GraphQLLogOperationInfo {
+    started: number;
+    operationName?: string | null;
+    query?: string | null;
+    variables?: Record<string, unknown> | null;
+    result: {
+        data?: Record<string, unknown> | null;
+        errors?: readonly GraphQLFormattedError[] | null;
+    };
+    logger: Logger;
+}
+export declare const logGraphQLOperation: ({ started, operationName, query, variables, result: { errors }, logger }: GraphQLLogOperationInfo) => void;
+/**
+ * Logs `operationName`, `query` and `variables` params from the GraphQL `ExecutionArgs`.
+ * If `args.contextValue` has a `logger` property, it will be used, otherwise the `logger` param will be used.
+ */
+export declare const logGraphQLExecutionArgs: (args: ExecutionArgs, message: string, logger?: Logger) => void;
+export {};
+//# sourceMappingURL=logging.d.ts.map

package/logging.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"logging.d.ts","sourceRoot":"","sources":["../src/logging.ts"],"names":[],"mappings":"AAAA,OAAO,EAAc,MAAM,EAAE,MAAM,qBAAqB,CAAA;AACxD,OAAO,EAAE,aAAa,EAAE,qBAAqB,EAAS,MAAM,SAAS,CAAA;AAKrE,UAAU,uBAAuB;IAC/B,OAAO,EAAE,MAAM,CAAA;IACf,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC7B,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IAC1C,MAAM,EAAE;QACN,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;QACrC,MAAM,CAAC,EAAE,SAAS,qBAAqB,EAAE,GAAG,IAAI,CAAA;KACjD,CAAA;IACD,MAAM,EAAE,MAAM,CAAA;CACf;AAED,eAAO,MAAM,mBAAmB,6EAA8E,uBAAuB,SAgBpI,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,uBAAuB,SAAU,aAAa,WAAW,MAAM,WAAW,MAAM,SAc5F,CAAA"}

package/logging.js

@@ -0,0 +1,38 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.logGraphQLExecutionArgs = exports.logGraphQLOperation = void 0;
+const node_common_1 = require("@makerx/node-common");
+const graphql_1 = require("graphql");
+const lodash_omitby_1 = __importDefault(require("lodash.omitby"));
+const utils_1 = require("./utils");
+const logGraphQLOperation = ({ started, operationName, query, variables, result: { errors }, logger }) => {
+    const isIntrospection = query && (0, utils_1.isIntrospectionQuery)(query);
+    if (node_common_1.isLocalDev && isIntrospection)
+        return;
+    logger.info('GraphQL operation', (0, lodash_omitby_1.default)({
+        operationName,
+        query: isIntrospection ? 'IntrospectionQuery' : query,
+        variables: variables && Object.keys(variables).length > 0 ? variables : undefined,
+        duration: Date.now() - started,
+        errors,
+    }, utils_1.isNil));
+};
+exports.logGraphQLOperation = logGraphQLOperation;
+/**
+ * Logs `operationName`, `query` and `variables` params from the GraphQL `ExecutionArgs`.
+ * If `args.contextValue` has a `logger` property, it will be used, otherwise the `logger` param will be used.
+ */
+const logGraphQLExecutionArgs = (args, message, logger) => {
+    const { operationName, variableValues, document } = args;
+    const contextLogger = args.contextValue.logger ?? logger;
+    contextLogger?.info(message, (0, lodash_omitby_1.default)({
+        operationName,
+        query: (0, graphql_1.print)(document),
+        variables: variableValues,
+    }, utils_1.isNil));
+};
+exports.logGraphQLExecutionArgs = logGraphQLExecutionArgs;
+//# sourceMappingURL=logging.js.map

package/logging.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"logging.js","sourceRoot":"","sources":["../src/logging.ts"],"names":[],"mappings":";;;;;;AAAA,qDAAwD;AACxD,qCAAqE;AACrE,kEAAkC;AAClC,mCAAqD;AAe9C,MAAM,mBAAmB,GAAG,CAAC,EAAE,OAAO,EAAE,aAAa,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,EAAE,MAAM,EAA2B,EAAE,EAAE;IACvI,MAAM,eAAe,GAAG,KAAK,IAAI,IAAA,4BAAoB,EAAC,KAAK,CAAC,CAAA;IAC5D,IAAI,wBAAU,IAAI,eAAe;QAAE,OAAM;IACzC,MAAM,CAAC,IAAI,CACT,mBAAmB,EACnB,IAAA,uBAAM,EACJ;QACE,aAAa;QACb,KAAK,EAAE,eAAe,CAAC,CAAC,CAAC,oBAAoB,CAAC,CAAC,CAAC,KAAK;QACrD,SAAS,EAAE,SAAS,IAAI,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS;QACjF,QAAQ,EAAE,IAAI,CAAC,GAAG,EAAE,GAAG,OAAO;QAC9B,MAAM;KACP,EACD,aAAK,CACN,CACF,CAAA;AACH,CAAC,CAAA;AAhBY,QAAA,mBAAmB,uBAgB/B;AAED;;;GAGG;AACI,MAAM,uBAAuB,GAAG,CAAC,IAAmB,EAAE,OAAe,EAAE,MAAe,EAAE,EAAE;IAC/F,MAAM,EAAE,aAAa,EAAE,cAAc,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAA;IACxD,MAAM,aAAa,GAAI,IAAI,CAAC,YAAwC,CAAC,MAAM,IAAI,MAAM,CAAA;IACrF,aAAa,EAAE,IAAI,CACjB,OAAO,EACP,IAAA,uBAAM,EACJ;QACE,aAAa;QACb,KAAK,EAAE,IAAA,eAAK,EAAC,QAAQ,CAAC;QACtB,SAAS,EAAE,cAAc;KAC1B,EACD,aAAK,CACN,CACF,CAAA;AACH,CAAC,CAAA;AAdY,QAAA,uBAAuB,2BAcnC"}

package/package.json

@@ -0,0 +1,43 @@
+{
+  "main": "index.js",
+  "types": "index.d.ts",
+  "name": "@makerx/graphql-core",
+  "version": "1.0.0",
+  "private": false,
+  "description": "A set of core GraphQL utilities that MakerX uses to build GraphQL APIs",
+  "author": "MakerX",
+  "license": "MIT",
+  "engines": {
+    "node": ">=16.0"
+  },
+  "bugs": {
+    "url": "https://github.com/MakerXStudio/graphql-core/issues"
+  },
+  "homepage": "https://github.com/MakerXStudio/graphql-core#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/MakerXStudio/graphql-core.git"
+  },
+  "dependencies": {
+    "@makerx/node-common": "^1.0.3",
+    "lodash.omitby": "^4.6.0",
+    "lodash.pick": "^4.4.0"
+  },
+  "peerDependencies": {
+    "express": "*",
+    "graphql": "*",
+    "graphql-ws": "*",
+    "ws": "*"
+  },
+  "peerDependenciesMeta": {
+    "graphql-ws": {
+      "optional": true
+    },
+    "ws": {
+      "optional": true
+    }
+  },
+  "overrides": {
+    "semver": "^7.5.3"
+  }
+}

package/subscriptions/context.d.ts

@@ -0,0 +1,23 @@
+/// <reference types="node" />
+import type { Logger } from '@makerx/node-common';
+import type { IncomingMessage } from 'http';
+import { User } from '../User';
+import { CreateRequestLogger, GraphQLContext, JwtPayload, RequestInfo } from '../context';
+export interface SubscriptionContextInput {
+    connectRequest: IncomingMessage;
+    connectionParams?: Readonly<Record<string, unknown>>;
+    claims?: JwtPayload;
+}
+export type CreateSubscriptionUser<T = User | undefined> = (input: SubscriptionContextInput) => Promise<T>;
+export type CreateSubscriptionContext<TContext = GraphQLContext> = (input: SubscriptionContextInput) => Promise<TContext>;
+export type AugmentSubscriptionRequestInfo = (input: SubscriptionContextInput) => Record<string, unknown>;
+export interface CreateSubscriptionContextConfig<TContext = GraphQLContext> {
+    requestLogger: CreateRequestLogger | Logger;
+    augmentRequestInfo?: AugmentSubscriptionRequestInfo;
+    claimsToLog?: string[];
+    createUser?: CreateSubscriptionUser;
+    requestInfoToLog?: Array<keyof RequestInfo>;
+    augmentContext?: (context: TContext) => Record<string, unknown> | Promise<Record<string, unknown>>;
+}
+export declare const createSubscriptionContextFactory: <TContext extends GraphQLContext<Logger, RequestInfo, User | undefined> = GraphQLContext<Logger, RequestInfo, User | undefined>>({ requestLogger, augmentRequestInfo, claimsToLog, createUser, requestInfoToLog, augmentContext, }: CreateSubscriptionContextConfig<TContext>) => CreateSubscriptionContext<TContext>;
+//# sourceMappingURL=context.d.ts.map

package/subscriptions/context.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"context.d.ts","sourceRoot":"","sources":["../../src/subscriptions/context.ts"],"names":[],"mappings":";AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAA;AAEjD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,MAAM,CAAA;AAE3C,OAAO,EAAE,IAAI,EAAE,MAAM,SAAS,CAAA;AAC9B,OAAO,EAAE,mBAAmB,EAAE,cAAc,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,YAAY,CAAA;AAGzF,MAAM,WAAW,wBAAwB;IACvC,cAAc,EAAE,eAAe,CAAA;IAC/B,gBAAgB,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAA;IACpD,MAAM,CAAC,EAAE,UAAU,CAAA;CACpB;AAED,MAAM,MAAM,sBAAsB,CAAC,CAAC,GAAG,IAAI,GAAG,SAAS,IAAI,CAAC,KAAK,EAAE,wBAAwB,KAAK,OAAO,CAAC,CAAC,CAAC,CAAA;AAC1G,MAAM,MAAM,yBAAyB,CAAC,QAAQ,GAAG,cAAc,IAAI,CAAC,KAAK,EAAE,wBAAwB,KAAK,OAAO,CAAC,QAAQ,CAAC,CAAA;AACzH,MAAM,MAAM,8BAA8B,GAAG,CAAC,KAAK,EAAE,wBAAwB,KAAK,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;AAEzG,MAAM,WAAW,+BAA+B,CAAC,QAAQ,GAAG,cAAc;IACxE,aAAa,EAAE,mBAAmB,GAAG,MAAM,CAAA;IAC3C,kBAAkB,CAAC,EAAE,8BAA8B,CAAA;IACnD,WAAW,CAAC,EAAE,MAAM,EAAE,CAAA;IACtB,UAAU,CAAC,EAAE,sBAAsB,CAAA;IACnC,gBAAgB,CAAC,EAAE,KAAK,CAAC,MAAM,WAAW,CAAC,CAAA;IAC3C,cAAc,CAAC,EAAE,CAAC,OAAO,EAAE,QAAQ,KAAK,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAA;CACnG;AAED,eAAO,MAAM,gCAAgC,uTAwD5C,CAAA"}

package/subscriptions/context.js

@@ -0,0 +1,63 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createSubscriptionContextFactory = void 0;
+const crypto_1 = require("crypto");
+const lodash_1 = require("lodash");
+const User_1 = require("../User");
+const utils_1 = require("./utils");
+const createSubscriptionContextFactory = ({ requestLogger, augmentRequestInfo, claimsToLog, createUser = defaultCreateUser, requestInfoToLog, augmentContext, }) => {
+    // the function that creates the GraphQL context
+    return async (input) => {
+        const { connectRequest: req, claims } = input;
+        const xForwardedFor = req.headers['x-forwarded-for'];
+        const host = Array.isArray(xForwardedFor) ? xForwardedFor[0] : xForwardedFor ?? req.headers.host;
+        // build request info from the connect request and socket
+        const requestInfo = {
+            requestId: req.headers['x-request-id']?.toString() ?? (0, crypto_1.randomUUID)(),
+            protocol: 'ws',
+            host: host ?? '',
+            method: req.method ?? '',
+            url: req.url ?? '',
+            origin: req.headers['origin'] ?? '',
+            referer: req.headers.referer?.toString() ?? '',
+            arrLogId: req.headers['x-arr-log-id']?.toString() ?? undefined,
+            clientIp: req.headers['x-forwarded-for']?.toString() ?? req.socket.remoteAddress,
+            correlationId: req.headers['x-correlation-id']?.toString() ?? undefined,
+            ...augmentRequestInfo?.(input),
+        };
+        // create request logger
+        let logger;
+        if (typeof requestLogger === 'function') {
+            // build request logger metadata
+            const requestLoggerMetadata = {};
+            // add request info to log
+            if (requestInfoToLog?.length)
+                requestLoggerMetadata.request = (0, lodash_1.pick)(requestInfo, requestInfoToLog);
+            // add user claims to log
+            if (claims && claimsToLog?.length)
+                requestLoggerMetadata.user = (0, lodash_1.pick)(claims, claimsToLog);
+            // build the request logger
+            logger = requestLogger(requestLoggerMetadata);
+        }
+        else
+            logger = requestLogger;
+        const graphqlContext = {
+            requestInfo,
+            logger,
+            user: await createUser(input),
+            started: Date.now(),
+        };
+        const augmentedGraphQLContext = augmentContext
+            ? { ...graphqlContext, ...(await augmentContext(graphqlContext)) }
+            : graphqlContext;
+        return augmentedGraphQLContext;
+    };
+};
+exports.createSubscriptionContextFactory = createSubscriptionContextFactory;
+const defaultCreateUser = ({ claims, connectionParams }) => {
+    if (!claims)
+        return Promise.resolve(undefined);
+    const accessToken = (0, utils_1.extractTokenFromConnectionParams)(connectionParams);
+    return Promise.resolve(new User_1.User(claims, accessToken ?? ''));
+};
+//# sourceMappingURL=context.js.map

package/subscriptions/context.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"context.js","sourceRoot":"","sources":["../../src/subscriptions/context.ts"],"names":[],"mappings":";;;AACA,mCAAmC;AAEnC,mCAA6B;AAC7B,kCAA8B;AAE9B,mCAA0D;AAqBnD,MAAM,gCAAgC,GAAG,CAAmD,EACjG,aAAa,EACb,kBAAkB,EAClB,WAAW,EACX,UAAU,GAAG,iBAAiB,EAC9B,gBAAgB,EAChB,cAAc,GAC4B,EAAuC,EAAE;IACnF,gDAAgD;IAChD,OAAO,KAAK,EAAE,KAA+B,EAAE,EAAE;QAC/C,MAAM,EAAE,cAAc,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,KAAK,CAAA;QAE7C,MAAM,aAAa,GAAG,GAAG,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAA;QACpD,MAAM,IAAI,GAAG,KAAK,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,aAAa,IAAI,GAAG,CAAC,OAAO,CAAC,IAAI,CAAA;QAEhG,yDAAyD;QACzD,MAAM,WAAW,GAAgB;YAC/B,SAAS,EAAE,GAAG,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE,QAAQ,EAAE,IAAI,IAAA,mBAAU,GAAE;YAClE,QAAQ,EAAE,IAAI;YACd,IAAI,EAAE,IAAI,IAAI,EAAE;YAChB,MAAM,EAAE,GAAG,CAAC,MAAM,IAAI,EAAE;YACxB,GAAG,EAAE,GAAG,CAAC,GAAG,IAAI,EAAE;YAClB,MAAM,EAAE,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,EAAE;YACnC,OAAO,EAAE,GAAG,CAAC,OAAO,CAAC,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE;YAC9C,QAAQ,EAAE,GAAG,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE,QAAQ,EAAE,IAAI,SAAS;YAC9D,QAAQ,EAAE,GAAG,CAAC,OAAO,CAAC,iBAAiB,CAAC,EAAE,QAAQ,EAAE,IAAI,GAAG,CAAC,MAAM,CAAC,aAAa;YAChF,aAAa,EAAE,GAAG,CAAC,OAAO,CAAC,kBAAkB,CAAC,EAAE,QAAQ,EAAE,IAAI,SAAS;YACvE,GAAG,kBAAkB,EAAE,CAAC,KAAK,CAAC;SAC/B,CAAA;QAED,wBAAwB;QACxB,IAAI,MAAc,CAAA;QAClB,IAAI,OAAO,aAAa,KAAK,UAAU,EAAE;YACvC,gCAAgC;YAChC,MAAM,qBAAqB,GAA4B,EAAE,CAAA;YACzD,0BAA0B;YAC1B,IAAI,gBAAgB,EAAE,MAAM;gBAAE,qBAAqB,CAAC,OAAO,GAAG,IAAA,aAAI,EAAC,WAAW,EAAE,gBAAgB,CAAC,CAAA;YACjG,yBAAyB;YACzB,IAAI,MAAM,IAAI,WAAW,EAAE,MAAM;gBAAE,qBAAqB,CAAC,IAAI,GAAG,IAAA,aAAI,EAAC,MAAM,EAAE,WAAW,CAAC,CAAA;YACzF,2BAA2B;YAC3B,MAAM,GAAG,aAAa,CAAC,qBAAqB,CAAC,CAAA;SAC9C;;YAAM,MAAM,GAAG,aAAa,CAAA;QAE7B,MAAM,cAAc,GAAmB;YACrC,WAAW;YACX,MAAM;YACN,IAAI,EAAE,MAAM,UAAU,CAAC,KAAK,CAAC;YAC7B,OAAO,EAAE,IAAI,CAAC,GAAG,EAAE;SACpB,CAAA;QAED,MAAM,uBAAuB,GAAG,cAAc;YAC5C,CAAC,CAAC,EAAE,GAAG,cAAc,EAAE,GAAG,CAAC,MAAM,cAAc,CAAC,cAA0B,CAAC,CAAC,EAAE;YAC9E,CAAC,CAAC,cAAc,CAAA;QAElB,OAAO,uBAAmC,CAAA;IAC5C,CAAC,CAAA;AACH,CAAC,CAAA;AAxDY,QAAA,gCAAgC,oCAwD5C;AAED,MAAM,iBAAiB,GAA6C,CAAC,EAAE,MAAM,EAAE,gBAAgB,EAAE,EAAE,EAAE;IACnG,IAAI,CAAC,MAAM;QAAE,OAAO,OAAO,CAAC,OAAO,CAAC,SAAS,CAAC,CAAA;IAC9C,MAAM,WAAW,GAAG,IAAA,wCAAgC,EAAC,gBAAgB,CAAC,CAAA;IACtE,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,WAAI,CAAC,MAAM,EAAE,WAAW,IAAI,EAAE,CAAC,CAAC,CAAA;AAC7D,CAAC,CAAA"}

package/subscriptions/index.d.ts

@@ -0,0 +1,4 @@
+export * from './context';
+export * from './server';
+export { extractTokenFromConnectionParams } from './utils';
+//# sourceMappingURL=index.d.ts.map

package/subscriptions/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/subscriptions/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAA;AACzB,cAAc,UAAU,CAAA;AACxB,OAAO,EAAE,gCAAgC,EAAE,MAAM,SAAS,CAAA"}

package/subscriptions/index.js

@@ -0,0 +1,22 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.extractTokenFromConnectionParams = void 0;
+__exportStar(require("./context"), exports);
+__exportStar(require("./server"), exports);
+var utils_1 = require("./utils");
+Object.defineProperty(exports, "extractTokenFromConnectionParams", { enumerable: true, get: function () { return utils_1.extractTokenFromConnectionParams; } });
+//# sourceMappingURL=index.js.map

package/subscriptions/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/subscriptions/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,4CAAyB;AACzB,2CAAwB;AACxB,iCAA0D;AAAjD,yHAAA,gCAAgC,OAAA"}

package/subscriptions/server.d.ts

@@ -0,0 +1,17 @@
+/// <reference types="node" />
+import { Logger } from '@makerx/node-common';
+import { GraphQLSchema } from 'graphql';
+import type { Server } from 'http';
+import { JwtPayload } from '../context';
+import { CreateSubscriptionContext } from './context';
+export declare function useSubscriptionsServer({ schema, httpServer, createSubscriptionContext, logger, path, verifyToken, requireAuth, jwtClaimsToLog, }: {
+    schema: GraphQLSchema;
+    httpServer: Server;
+    createSubscriptionContext: CreateSubscriptionContext;
+    logger: Logger;
+    path?: string;
+    verifyToken?: (host: string, token: string) => Promise<JwtPayload>;
+    requireAuth?: boolean;
+    jwtClaimsToLog?: string[];
+}): import("graphql-ws/lib/common").Disposable;
+//# sourceMappingURL=server.d.ts.map

package/subscriptions/server.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"server.d.ts","sourceRoot":"","sources":["../../src/subscriptions/server.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAA;AAC5C,OAAO,EAAE,aAAa,EAAE,MAAM,SAAS,CAAA;AAEvC,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,MAAM,CAAA;AAGlC,OAAO,EAAE,UAAU,EAAE,MAAM,YAAY,CAAA;AAEvC,OAAO,EAAE,yBAAyB,EAAE,MAAM,WAAW,CAAA;AAGrD,wBAAgB,sBAAsB,CAAC,EACrC,MAAM,EACN,UAAU,EACV,yBAAyB,EACzB,MAAM,EACN,IAAiB,EACjB,WAAW,EACX,WAAW,EACX,cAA+B,GAChC,EAAE;IACD,MAAM,EAAE,aAAa,CAAA;IACrB,UAAU,EAAE,MAAM,CAAA;IAClB,yBAAyB,EAAE,yBAAyB,CAAA;IACpD,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,WAAW,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,KAAK,OAAO,CAAC,UAAU,CAAC,CAAA;IAClE,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,cAAc,CAAC,EAAE,MAAM,EAAE,CAAA;CAC1B,8CA8DA"}

package/subscriptions/server.js

@@ -0,0 +1,71 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useSubscriptionsServer = void 0;
+const ws_1 = require("graphql-ws/lib/use/ws");
+const lodash_pick_1 = __importDefault(require("lodash.pick"));
+const ws_2 = require("ws");
+const logging_1 = require("../logging");
+const utils_1 = require("./utils");
+function useSubscriptionsServer({ schema, httpServer, createSubscriptionContext, logger, path = '/graphql', verifyToken, requireAuth, jwtClaimsToLog = ['oid', 'iss'], }) {
+    if (requireAuth && !verifyToken)
+        throw new Error('verifyToken must be supplied when requireAuth is true');
+    const wsServer = new ws_2.WebSocketServer({
+        server: httpServer,
+        path,
+    });
+    return (0, ws_1.useServer)({
+        schema,
+        onError(_ctx, message, errors) {
+            logger.error('GraphQL subscriptions server error', { message, errors });
+        },
+        onConnect: async (ctx) => {
+            const connectionEstablished = 'Subscription connection established';
+            if (!verifyToken) {
+                logger.info(connectionEstablished);
+                return true;
+            }
+            const token = (0, utils_1.extractTokenFromConnectionParams)(ctx.connectionParams);
+            if (!token) {
+                if (requireAuth) {
+                    logger.error('No authorization parameter was supplied via websocket connection params');
+                    return false;
+                }
+                logger.info(connectionEstablished);
+                return true;
+            }
+            try {
+                const claims = await verifyToken((0, utils_1.getHost)(ctx.extra.request), token);
+                ctx.extra.claims = claims;
+                logger.info(connectionEstablished, {
+                    claims: (0, lodash_pick_1.default)(claims, jwtClaimsToLog),
+                });
+                return true;
+            }
+            catch (error) {
+                logger.error('Failed to verify subscription connection auth token', { error });
+                return false;
+            }
+        },
+        onDisconnect({ extra: { claims } }) {
+            logger.info('Subscription connection disconnected', { claims: (0, lodash_pick_1.default)(claims, jwtClaimsToLog) });
+        },
+        context: async (ctx) => {
+            return createSubscriptionContext({
+                connectRequest: ctx.extra.request,
+                connectionParams: ctx.connectionParams,
+                claims: ctx.extra.claims,
+            });
+        },
+        onOperation(_ctx, _message, args) {
+            (0, logging_1.logGraphQLExecutionArgs)(args, 'GraphQL subscription operation');
+        },
+        onNext(_ctx, _message, args, _result) {
+            (0, logging_1.logGraphQLExecutionArgs)(args, 'GraphQL subscription result');
+        },
+    }, wsServer);
+}
+exports.useSubscriptionsServer = useSubscriptionsServer;
+//# sourceMappingURL=server.js.map

package/subscriptions/server.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"server.js","sourceRoot":"","sources":["../../src/subscriptions/server.ts"],"names":[],"mappings":";;;;;;AAEA,8CAAiD;AAEjD,8DAA8B;AAC9B,2BAAoC;AAEpC,wCAAoD;AAEpD,mCAAmE;AAEnE,SAAgB,sBAAsB,CAAC,EACrC,MAAM,EACN,UAAU,EACV,yBAAyB,EACzB,MAAM,EACN,IAAI,GAAG,UAAU,EACjB,WAAW,EACX,WAAW,EACX,cAAc,GAAG,CAAC,KAAK,EAAE,KAAK,CAAC,GAUhC;IACC,IAAI,WAAW,IAAI,CAAC,WAAW;QAAE,MAAM,IAAI,KAAK,CAAC,uDAAuD,CAAC,CAAA;IAEzG,MAAM,QAAQ,GAAG,IAAI,oBAAe,CAAC;QACnC,MAAM,EAAE,UAAU;QAClB,IAAI;KACL,CAAC,CAAA;IAEF,OAAO,IAAA,cAAS,EACd;QACE,MAAM;QACN,OAAO,CAAC,IAAI,EAAE,OAAO,EAAE,MAAM;YAC3B,MAAM,CAAC,KAAK,CAAC,oCAAoC,EAAE,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC,CAAA;QACzE,CAAC;QACD,SAAS,EAAE,KAAK,EAAE,GAAG,EAAE,EAAE;YACvB,MAAM,qBAAqB,GAAG,qCAAqC,CAAA;YACnE,IAAI,CAAC,WAAW,EAAE;gBAChB,MAAM,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAA;gBAClC,OAAO,IAAI,CAAA;aACZ;YAED,MAAM,KAAK,GAAG,IAAA,wCAAgC,EAAC,GAAG,CAAC,gBAAgB,CAAC,CAAA;YACpE,IAAI,CAAC,KAAK,EAAE;gBACV,IAAI,WAAW,EAAE;oBACf,MAAM,CAAC,KAAK,CAAC,yEAAyE,CAAC,CAAA;oBACvF,OAAO,KAAK,CAAA;iBACb;gBACD,MAAM,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAA;gBAClC,OAAO,IAAI,CAAA;aACZ;YAED,IAAI;gBACF,MAAM,MAAM,GAAG,MAAM,WAAW,CAAC,IAAA,eAAO,EAAC,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,KAAK,CAAC,CAAA;gBACnE,GAAG,CAAC,KAAK,CAAC,MAAM,GAAG,MAA8B,CAAA;gBACjD,MAAM,CAAC,IAAI,CAAC,qBAAqB,EAAE;oBACjC,MAAM,EAAE,IAAA,qBAAI,EAAC,MAAM,EAAE,cAAc,CAAC;iBACrC,CAAC,CAAA;gBACF,OAAO,IAAI,CAAA;aACZ;YAAC,OAAO,KAAK,EAAE;gBACd,MAAM,CAAC,KAAK,CAAC,qDAAqD,EAAE,EAAE,KAAK,EAAE,CAAC,CAAA;gBAC9E,OAAO,KAAK,CAAA;aACb;QACH,CAAC;QACD,YAAY,CAAC,EAAE,KAAK,EAAE,EAAE,MAAM,EAAE,EAAE;YAChC,MAAM,CAAC,IAAI,CAAC,sCAAsC,EAAE,EAAE,MAAM,EAAE,IAAA,qBAAI,EAAC,MAAM,EAAE,cAAc,CAAC,EAAE,CAAC,CAAA;QAC/F,CAAC;QACD,OAAO,EAAE,KAAK,EAAE,GAAG,EAAE,EAAE;YACrB,OAAO,yBAAyB,CAAC;gBAC/B,cAAc,EAAE,GAAG,CAAC,KAAK,CAAC,OAAO;gBACjC,gBAAgB,EAAE,GAAG,CAAC,gBAAgB;gBACtC,MAAM,EAAE,GAAG,CAAC,KAAK,CAAC,MAAgC;aACnD,CAAC,CAAA;QACJ,CAAC;QACD,WAAW,CAAC,IAAI,EAAE,QAAQ,EAAE,IAAI;YAC9B,IAAA,iCAAuB,EAAC,IAAI,EAAE,gCAAgC,CAAC,CAAA;QACjE,CAAC;QACD,MAAM,CAAC,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO;YAClC,IAAA,iCAAuB,EAAC,IAAI,EAAE,6BAA6B,CAAC,CAAA;QAC9D,CAAC;KACF,EACD,QAAQ,CACT,CAAA;AACH,CAAC;AAhFD,wDAgFC"}

package/subscriptions/utils.d.ts

@@ -0,0 +1,12 @@
+/// <reference types="node" />
+import type { IncomingMessage } from 'http';
+/**
+ * Extracts a token from a connection parameter named `authorization` or `Authorization`.
+ * The expected format of the parameter value is: Bearer <token>, consistent with an HTTP Authorization header.
+ * Apollo Sandbox sets an `Authorization` connection parameter when you specify an HTTP Authorization header via the UI.
+ * @param connectionParams
+ * @returns
+ */
+export declare function extractTokenFromConnectionParams(connectionParams?: Readonly<Record<string, unknown>>): string | undefined;
+export declare function getHost(request: IncomingMessage): string;
+//# sourceMappingURL=utils.d.ts.map

package/subscriptions/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/subscriptions/utils.ts"],"names":[],"mappings":";AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,MAAM,CAAA;AAE3C;;;;;;GAMG;AACH,wBAAgB,gCAAgC,CAAC,gBAAgB,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,sBAIpG;AAED,wBAAgB,OAAO,CAAC,OAAO,EAAE,eAAe,UAI/C"}

package/subscriptions/utils.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getHost = exports.extractTokenFromConnectionParams = void 0;
+/**
+ * Extracts a token from a connection parameter named `authorization` or `Authorization`.
+ * The expected format of the parameter value is: Bearer <token>, consistent with an HTTP Authorization header.
+ * Apollo Sandbox sets an `Authorization` connection parameter when you specify an HTTP Authorization header via the UI.
+ * @param connectionParams
+ * @returns
+ */
+function extractTokenFromConnectionParams(connectionParams) {
+    const bearerTokenValue = (connectionParams?.authorization ?? connectionParams?.Authorization);
+    if (!bearerTokenValue?.startsWith('Bearer '))
+        return undefined;
+    return bearerTokenValue.substring(7);
+}
+exports.extractTokenFromConnectionParams = extractTokenFromConnectionParams;
+function getHost(request) {
+    const proxyHostHeader = request.headers['x-forwarded-host'];
+    const host = Array.isArray(proxyHostHeader) ? proxyHostHeader[0] ?? undefined : proxyHostHeader ?? request.headers.host ?? undefined;
+    return host ?? 'subscriptions';
+}
+exports.getHost = getHost;
+//# sourceMappingURL=utils.js.map

package/subscriptions/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/subscriptions/utils.ts"],"names":[],"mappings":";;;AAEA;;;;;;GAMG;AACH,SAAgB,gCAAgC,CAAC,gBAAoD;IACnG,MAAM,gBAAgB,GAAG,CAAC,gBAAgB,EAAE,aAAa,IAAI,gBAAgB,EAAE,aAAa,CAAuB,CAAA;IACnH,IAAI,CAAC,gBAAgB,EAAE,UAAU,CAAC,SAAS,CAAC;QAAE,OAAO,SAAS,CAAA;IAC9D,OAAO,gBAAgB,CAAC,SAAS,CAAC,CAAC,CAAC,CAAA;AACtC,CAAC;AAJD,4EAIC;AAED,SAAgB,OAAO,CAAC,OAAwB;IAC9C,MAAM,eAAe,GAAG,OAAO,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAA;IAC3D,MAAM,IAAI,GAAG,KAAK,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,IAAI,SAAS,CAAC,CAAC,CAAC,eAAe,IAAI,OAAO,CAAC,OAAO,CAAC,IAAI,IAAI,SAAS,CAAA;IACpI,OAAO,IAAI,IAAI,eAAe,CAAA;AAChC,CAAC;AAJD,0BAIC"}

package/testing.d.ts

@@ -0,0 +1,7 @@
+import { ApolloClient, NormalizedCacheObject } from '@apollo/client/core';
+import { ClientCredentialsConfig } from '@makerx/node-common';
+import { ApolloClientOptions } from '@apollo/client/core/ApolloClient';
+export * from '@apollo/client/core';
+export declare const createTestClient: (url: string, accessToken?: string, options?: Partial<ApolloClientOptions<NormalizedCacheObject>>) => ApolloClient<NormalizedCacheObject>;
+export declare const createTestClientWithClientCredentials: (url: string, clientCredentialsConfig: ClientCredentialsConfig, options?: Partial<ApolloClientOptions<NormalizedCacheObject>>) => ApolloClient<NormalizedCacheObject>;
+//# sourceMappingURL=testing.d.ts.map

package/testing.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"testing.d.ts","sourceRoot":"","sources":["../src/testing.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAuC,qBAAqB,EAAE,MAAM,qBAAqB,CAAA;AAG9G,OAAO,EAAuB,uBAAuB,EAA6B,MAAM,qBAAqB,CAAA;AAC7G,OAAO,EAAE,mBAAmB,EAAE,MAAM,kCAAkC,CAAA;AAEtE,cAAc,qBAAqB,CAAA;AAuCnC,eAAO,MAAM,gBAAgB,QACtB,MAAM,gBACG,MAAM,YACV,QAAQ,oBAAoB,qBAAqB,CAAC,CAAC,KAC5D,aAAa,qBAAqB,CAUjC,CAAA;AAEJ,eAAO,MAAM,qCAAqC,QAC3C,MAAM,2BACc,uBAAuB,YACtC,QAAQ,oBAAoB,qBAAqB,CAAC,CAAC,KAC5D,aAAa,qBAAqB,CAUjC,CAAA"}

package/testing.js

@@ -0,0 +1,81 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createTestClientWithClientCredentials = exports.createTestClient = void 0;
+const core_1 = require("@apollo/client/core");
+const context_1 = require("@apollo/client/link/context");
+const node_fetch_1 = __importDefault(require("node-fetch"));
+const node_common_1 = require("@makerx/node-common");
+__exportStar(require("@apollo/client/core"), exports);
+const bearerTokenLink = (accessToken) => (0, context_1.setContext)((_, { headers }) => {
+    if (accessToken)
+        return {
+            headers: {
+                ...headers,
+                authorization: `Bearer ${accessToken}`,
+            },
+        };
+    return {
+        headers,
+    };
+});
+const clientCredentialsLink = (clientCredentialsConfig) => {
+    let promise;
+    return (0, context_1.setContext)(async () => {
+        if (!promise)
+            promise = (0, node_common_1.getClientCredentialsToken)(clientCredentialsConfig);
+        let tokenResponse = await promise;
+        if (tokenResponse.isExpired) {
+            promise = (0, node_common_1.getClientCredentialsToken)(clientCredentialsConfig);
+            tokenResponse = await promise;
+        }
+        return {
+            headers: {
+                authorization: `Bearer ${tokenResponse.access_token}`,
+            },
+        };
+    });
+};
+const httpLink = (url) => (0, core_1.createHttpLink)({
+    uri: url,
+    fetch: node_fetch_1.default,
+});
+const createTestClient = (url, accessToken, options) => new core_1.ApolloClient({
+    link: (0, core_1.from)([bearerTokenLink(accessToken), httpLink(url)]),
+    cache: new core_1.InMemoryCache(),
+    defaultOptions: {
+        query: {
+            errorPolicy: 'all',
+        },
+    },
+    ...options,
+});
+exports.createTestClient = createTestClient;
+const createTestClientWithClientCredentials = (url, clientCredentialsConfig, options) => new core_1.ApolloClient({
+    link: (0, core_1.from)([clientCredentialsLink(clientCredentialsConfig), httpLink(url)]),
+    cache: new core_1.InMemoryCache(),
+    defaultOptions: {
+        query: {
+            errorPolicy: 'all',
+        },
+    },
+    ...options,
+});
+exports.createTestClientWithClientCredentials = createTestClientWithClientCredentials;
+//# sourceMappingURL=testing.js.map

package/testing.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"testing.js","sourceRoot":"","sources":["../src/testing.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA,8CAA8G;AAC9G,yDAAwD;AACxD,4DAA8B;AAC9B,qDAA6G;AAG7G,sDAAmC;AAEnC,MAAM,eAAe,GAAG,CAAC,WAAoB,EAAE,EAAE,CAC/C,IAAA,oBAAU,EAAC,CAAC,CAAC,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE;IAC5B,IAAI,WAAW;QACb,OAAO;YACL,OAAO,EAAE;gBACP,GAAG,OAAO;gBACV,aAAa,EAAE,UAAU,WAAW,EAAE;aACvC;SACF,CAAA;IACH,OAAO;QACL,OAAO;KACR,CAAA;AACH,CAAC,CAAC,CAAA;AAEJ,MAAM,qBAAqB,GAAG,CAAC,uBAAgD,EAAE,EAAE;IACjF,IAAI,OAAiD,CAAA;IACrD,OAAO,IAAA,oBAAU,EAAC,KAAK,IAAI,EAAE;QAC3B,IAAI,CAAC,OAAO;YAAE,OAAO,GAAG,IAAA,uCAAyB,EAAC,uBAAuB,CAAC,CAAA;QAC1E,IAAI,aAAa,GAAG,MAAM,OAAO,CAAA;QACjC,IAAI,aAAa,CAAC,SAAS,EAAE;YAC3B,OAAO,GAAG,IAAA,uCAAyB,EAAC,uBAAuB,CAAC,CAAA;YAC5D,aAAa,GAAG,MAAM,OAAO,CAAA;SAC9B;QACD,OAAO;YACL,OAAO,EAAE;gBACP,aAAa,EAAE,UAAU,aAAa,CAAC,YAAY,EAAE;aACtD;SACF,CAAA;IACH,CAAC,CAAC,CAAA;AACJ,CAAC,CAAA;AAED,MAAM,QAAQ,GAAG,CAAC,GAAW,EAAE,EAAE,CAC/B,IAAA,qBAAc,EAAC;IACb,GAAG,EAAE,GAAG;IACR,KAAK,EAAE,oBAA2C;CACnD,CAAC,CAAA;AAEG,MAAM,gBAAgB,GAAG,CAC9B,GAAW,EACX,WAAoB,EACpB,OAA6D,EACxB,EAAE,CACvC,IAAI,mBAAY,CAAC;IACf,IAAI,EAAE,IAAA,WAAI,EAAC,CAAC,eAAe,CAAC,WAAW,CAAC,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;IACzD,KAAK,EAAE,IAAI,oBAAa,EAAE;IAC1B,cAAc,EAAE;QACd,KAAK,EAAE;YACL,WAAW,EAAE,KAAK;SACnB;KACF;IACD,GAAG,OAAO;CACX,CAAC,CAAA;AAdS,QAAA,gBAAgB,oBAczB;AAEG,MAAM,qCAAqC,GAAG,CACnD,GAAW,EACX,uBAAgD,EAChD,OAA6D,EACxB,EAAE,CACvC,IAAI,mBAAY,CAAC;IACf,IAAI,EAAE,IAAA,WAAI,EAAC,CAAC,qBAAqB,CAAC,uBAAuB,CAAC,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;IAC3E,KAAK,EAAE,IAAI,oBAAa,EAAE;IAC1B,cAAc,EAAE;QACd,KAAK,EAAE;YACL,WAAW,EAAE,KAAK;SACnB;KACF;IACD,GAAG,OAAO;CACX,CAAC,CAAA;AAdS,QAAA,qCAAqC,yCAc9C"}

package/utils.d.ts

@@ -0,0 +1,4 @@
+export declare const isIntrospectionQuery: (query?: string) => boolean | undefined;
+export declare const isNil: (value: unknown) => value is null | undefined;
+export declare const isNotNil: <T>(value: T) => value is Exclude<T, null | undefined>;
+//# sourceMappingURL=utils.d.ts.map

package/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,oBAAoB,WAAY,MAAM,wBAAgC,CAAA;AACnF,eAAO,MAAM,KAAK,UAAW,OAAO,8BAAqE,CAAA;AACzG,eAAO,MAAM,QAAQ,wDAAwE,CAAA"}

package/utils.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isNotNil = exports.isNil = exports.isIntrospectionQuery = void 0;
+const isIntrospectionQuery = (query) => query?.includes('__schema');
+exports.isIntrospectionQuery = isIntrospectionQuery;
+const isNil = (value) => value === null || value === undefined;
+exports.isNil = isNil;
+const isNotNil = (value) => !(0, exports.isNil)(value);
+exports.isNotNil = isNotNil;
+//# sourceMappingURL=utils.js.map

package/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":";;;AAAO,MAAM,oBAAoB,GAAG,CAAC,KAAc,EAAE,EAAE,CAAC,KAAK,EAAE,QAAQ,CAAC,UAAU,CAAC,CAAA;AAAtE,QAAA,oBAAoB,wBAAkD;AAC5E,MAAM,KAAK,GAAG,CAAC,KAAc,EAA6B,EAAE,CAAC,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS,CAAA;AAA5F,QAAA,KAAK,SAAuF;AAClG,MAAM,QAAQ,GAAG,CAAI,KAAQ,EAAyC,EAAE,CAAC,CAAC,IAAA,aAAK,EAAC,KAAK,CAAC,CAAA;AAAhF,QAAA,QAAQ,YAAwE"}