@makerx/graphql-core 2.1.0 → 2.2.1

package/package.json

@@ -1,14 +1,16 @@
 {
-  "main": "index.js",
-  "types": "index.d.ts",
+  "scripts": {},
+  "files": [
+    "**"
+  ],
   "name": "@makerx/graphql-core",
-  "version": "2.1.0",
+  "version": "2.2.1",
   "private": false,
   "description": "A set of core GraphQL utilities that MakerX uses to build GraphQL APIs",
   "author": "MakerX",
   "license": "MIT",
   "engines": {
-    "node": ">=16.0"
+    "node": ">=20.0"
   },
   "bugs": {
     "url": "https://github.com/MakerXStudio/graphql-core/issues"
@@ -19,16 +21,15 @@
     "url": "git+https://github.com/MakerXStudio/graphql-core.git"
   },
   "dependencies": {
-    "@makerx/node-common": "^1.2.0",
-    "lodash.omitby": "^4.6.0",
-    "lodash.pick": "^4.4.0"
+    "@makerx/node-common": "^1.4.0"
   },
   "peerDependencies": {
     "@apollo/client": "*",
     "express": "*",
+    "graphql": "*",
     "graphql-shield": "*",
     "graphql-ws": "*",
-    "graphql": "*",
+    "lodash": "*",
     "ws": "*"
   },
   "peerDependenciesMeta": {
@@ -42,8 +43,25 @@
       "optional": true
     }
   },
-  "overrides": {
-    "@typescript-eslint/eslint-plugin": "^6.0.0",
-    "@typescript-eslint/parser": "^6.0.0"
+  "main": "./index.js",
+  "module": "./index.mjs",
+  "types": "./index.d.ts",
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./index.d.ts",
+      "import": "./index.mjs",
+      "require": "./index.js"
+    },
+    "./testing": {
+      "types": "./testing.d.ts",
+      "import": "./testing.mjs",
+      "require": "./testing.js"
+    },
+    "./subscriptions": {
+      "types": "./subscriptions/index.d.ts",
+      "import": "./subscriptions/index.mjs",
+      "require": "./subscriptions/index.js"
+    }
   }
 }

package/schema-util.d.ts

@@ -1,4 +1,4 @@
-import { GraphQLSchema } from 'graphql';
+import type { GraphQLSchema } from 'graphql';
 /**
  * It is possible to register a custom scalar with apollo server without defining an explicit resolver (a default resolver is used in
  * this case), but it is rarely desirable. This function, when provided with your built schema, will ensure any registered scalar types
@@ -7,4 +7,3 @@ import { GraphQLSchema } from 'graphql';
  * @param schema A schema object, the result of calling `makeExecutableSchema` from `@graphql-tools/schema`
  */
 export declare function requireExplicitResolversForScalars(schema: GraphQLSchema, ...scalarsToIgnore: string[]): void;
-//# sourceMappingURL=schema-util.d.ts.map

package/schema-util.js

@@ -1,7 +1,7 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.requireExplicitResolversForScalars = void 0;
-const graphql_1 = require("graphql");
+'use strict';
+
+var graphql = require('graphql');
+
 /**
  * It is possible to register a custom scalar with apollo server without defining an explicit resolver (a default resolver is used in
  * this case), but it is rarely desirable. This function, when provided with your built schema, will ensure any registered scalar types
@@ -11,7 +11,7 @@ const graphql_1 = require("graphql");
  */
 function requireExplicitResolversForScalars(schema, ...scalarsToIgnore) {
     const testSymbol = Symbol('testSymbol');
-    const scalars = Object.values(schema.getTypeMap()).filter((t) => t instanceof graphql_1.GraphQLScalarType);
+    const scalars = Object.values(schema.getTypeMap()).filter((t) => t instanceof graphql.GraphQLScalarType);
     for (const scalar of scalars) {
         if (scalar.name === 'Void' || scalar.name === 'JSON' || scalarsToIgnore.includes(scalar.name))
             continue;
@@ -26,5 +26,6 @@ function requireExplicitResolversForScalars(schema, ...scalarsToIgnore) {
             "If you're satisfied with this scalar you can ignore it in the call to `requireExplicitResolversForScalars`.");
     }
 }
+
 exports.requireExplicitResolversForScalars = requireExplicitResolversForScalars;
-//# sourceMappingURL=schema-util.js.map
+//# sourceMappingURL=schema-util.js.map

package/schema-util.js.map

@@ -1 +1 @@
-{"version":3,"file":"schema-util.js","sourceRoot":"","sources":["../src/schema-util.ts"],"names":[],"mappings":";;;AAAA,qCAA0D;AAE1D;;;;;;GAMG;AACH,SAAgB,kCAAkC,CAAC,MAAqB,EAAE,GAAG,eAAyB;IACpG,MAAM,UAAU,GAAG,MAAM,CAAC,YAAY,CAAC,CAAA;IACvC,MAAM,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAA0B,EAAE,CAAC,CAAC,YAAY,2BAAiB,CAAC,CAAA;IACxH,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE;QAC5B,IAAI,MAAM,CAAC,IAAI,KAAK,MAAM,IAAI,MAAM,CAAC,IAAI,KAAK,MAAM,IAAI,eAAe,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC;YAAE,SAAQ;QACvG,IAAI;YACF,MAAM,CAAC,UAAU,CAAC,UAAU,CAAC,CAAA;SAC9B;QAAC,MAAM;YACN,yEAAyE;YACzE,SAAQ;SACT;QACD,MAAM,IAAI,KAAK,CACb,UAAU,MAAM,CAAC,IAAI,gHAAgH;YACnI,6GAA6G,CAChH,CAAA;KACF;AACH,CAAC;AAhBD,gFAgBC"}
+{"version":3,"file":"schema-util.js","sources":["../src/schema-util.ts"],"sourcesContent":["import type { GraphQLSchema } from 'graphql'\nimport { GraphQLScalarType } from 'graphql'\n\n/**\n * It is possible to register a custom scalar with apollo server without defining an explicit resolver (a default resolver is used in\n * this case), but it is rarely desirable. This function, when provided with your built schema, will ensure any registered scalar types\n * provide at least a base level of validation by failing to parse a Symbol instance. The default resolver does not pass this test\n * meaning any scalars that are falling back to the default resolver will fail.\n * @param schema A schema object, the result of calling `makeExecutableSchema` from `@graphql-tools/schema`\n */\nexport function requireExplicitResolversForScalars(schema: GraphQLSchema, ...scalarsToIgnore: string[]) {\n  const testSymbol = Symbol('testSymbol')\n  const scalars = Object.values(schema.getTypeMap()).filter((t): t is GraphQLScalarType => t instanceof GraphQLScalarType)\n  for (const scalar of scalars) {\n    if (scalar.name === 'Void' || scalar.name === 'JSON' || scalarsToIgnore.includes(scalar.name)) continue\n    try {\n      scalar.parseValue(testSymbol)\n    } catch {\n      // We expect that a good parser should throw when parsing a random symbol\n      continue\n    }\n    throw new Error(\n      `Scalar ${scalar.name} does not appear to have an explicit resolver, or is not performing sufficient validation when parsing input. ` +\n        \"If you're satisfied with this scalar you can ignore it in the call to `requireExplicitResolversForScalars`.\",\n    )\n  }\n}\n"],"names":["GraphQLScalarType"],"mappings":";;;;AAGA;;;;;;AAMG;SACa,kCAAkC,CAAC,MAAqB,EAAE,GAAG,eAAyB,EAAA;AACpG,IAAA,MAAM,UAAU,GAAG,MAAM,CAAC,YAAY,CAAC,CAAA;IACvC,MAAM,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,KAA6B,CAAC,YAAYA,yBAAiB,CAAC,CAAA;AACxH,IAAA,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE;AAC5B,QAAA,IAAI,MAAM,CAAC,IAAI,KAAK,MAAM,IAAI,MAAM,CAAC,IAAI,KAAK,MAAM,IAAI,eAAe,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC;YAAE,SAAQ;AACvG,QAAA,IAAI;AACF,YAAA,MAAM,CAAC,UAAU,CAAC,UAAU,CAAC,CAAA;SAC9B;AAAC,QAAA,MAAM;;YAEN,SAAQ;SACT;AACD,QAAA,MAAM,IAAI,KAAK,CACb,UAAU,MAAM,CAAC,IAAI,CAAgH,8GAAA,CAAA;AACnI,YAAA,6GAA6G,CAChH,CAAA;KACF;AACH;;;;"}

package/schema-util.mjs

@@ -0,0 +1,29 @@
+import { GraphQLScalarType } from 'graphql';
+
+/**
+ * It is possible to register a custom scalar with apollo server without defining an explicit resolver (a default resolver is used in
+ * this case), but it is rarely desirable. This function, when provided with your built schema, will ensure any registered scalar types
+ * provide at least a base level of validation by failing to parse a Symbol instance. The default resolver does not pass this test
+ * meaning any scalars that are falling back to the default resolver will fail.
+ * @param schema A schema object, the result of calling `makeExecutableSchema` from `@graphql-tools/schema`
+ */
+function requireExplicitResolversForScalars(schema, ...scalarsToIgnore) {
+    const testSymbol = Symbol('testSymbol');
+    const scalars = Object.values(schema.getTypeMap()).filter((t) => t instanceof GraphQLScalarType);
+    for (const scalar of scalars) {
+        if (scalar.name === 'Void' || scalar.name === 'JSON' || scalarsToIgnore.includes(scalar.name))
+            continue;
+        try {
+            scalar.parseValue(testSymbol);
+        }
+        catch {
+            // We expect that a good parser should throw when parsing a random symbol
+            continue;
+        }
+        throw new Error(`Scalar ${scalar.name} does not appear to have an explicit resolver, or is not performing sufficient validation when parsing input. ` +
+            "If you're satisfied with this scalar you can ignore it in the call to `requireExplicitResolversForScalars`.");
+    }
+}
+
+export { requireExplicitResolversForScalars };
+//# sourceMappingURL=schema-util.mjs.map

package/schema-util.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema-util.mjs","sources":["../src/schema-util.ts"],"sourcesContent":["import type { GraphQLSchema } from 'graphql'\nimport { GraphQLScalarType } from 'graphql'\n\n/**\n * It is possible to register a custom scalar with apollo server without defining an explicit resolver (a default resolver is used in\n * this case), but it is rarely desirable. This function, when provided with your built schema, will ensure any registered scalar types\n * provide at least a base level of validation by failing to parse a Symbol instance. The default resolver does not pass this test\n * meaning any scalars that are falling back to the default resolver will fail.\n * @param schema A schema object, the result of calling `makeExecutableSchema` from `@graphql-tools/schema`\n */\nexport function requireExplicitResolversForScalars(schema: GraphQLSchema, ...scalarsToIgnore: string[]) {\n  const testSymbol = Symbol('testSymbol')\n  const scalars = Object.values(schema.getTypeMap()).filter((t): t is GraphQLScalarType => t instanceof GraphQLScalarType)\n  for (const scalar of scalars) {\n    if (scalar.name === 'Void' || scalar.name === 'JSON' || scalarsToIgnore.includes(scalar.name)) continue\n    try {\n      scalar.parseValue(testSymbol)\n    } catch {\n      // We expect that a good parser should throw when parsing a random symbol\n      continue\n    }\n    throw new Error(\n      `Scalar ${scalar.name} does not appear to have an explicit resolver, or is not performing sufficient validation when parsing input. ` +\n        \"If you're satisfied with this scalar you can ignore it in the call to `requireExplicitResolversForScalars`.\",\n    )\n  }\n}\n"],"names":[],"mappings":";;AAGA;;;;;;AAMG;SACa,kCAAkC,CAAC,MAAqB,EAAE,GAAG,eAAyB,EAAA;AACpG,IAAA,MAAM,UAAU,GAAG,MAAM,CAAC,YAAY,CAAC,CAAA;IACvC,MAAM,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,KAA6B,CAAC,YAAY,iBAAiB,CAAC,CAAA;AACxH,IAAA,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE;AAC5B,QAAA,IAAI,MAAM,CAAC,IAAI,KAAK,MAAM,IAAI,MAAM,CAAC,IAAI,KAAK,MAAM,IAAI,eAAe,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC;YAAE,SAAQ;AACvG,QAAA,IAAI;AACF,YAAA,MAAM,CAAC,UAAU,CAAC,UAAU,CAAC,CAAA;SAC9B;AAAC,QAAA,MAAM;;YAEN,SAAQ;SACT;AACD,QAAA,MAAM,IAAI,KAAK,CACb,UAAU,MAAM,CAAC,IAAI,CAAgH,8GAAA,CAAA;AACnI,YAAA,6GAA6G,CAChH,CAAA;KACF;AACH;;;;"}

package/shield.d.ts

@@ -1,8 +1,9 @@
-import { ShieldRule } from 'graphql-shield/typings/types';
-import { Primitive } from './models';
-import { and, chain, or, race } from 'graphql-shield';
+import type { and, chain, or, race } from 'graphql-shield';
+import { allow } from 'graphql-shield';
+import type { Primitive } from './models';
 type RuleCombinator = typeof chain | typeof race | typeof or | typeof and;
-export declare const createRule: <TContext, TParent = unknown, TArgs = unknown>(logic: (parent: TParent, args: TArgs, ctx: TContext) => boolean | Promise<boolean> | Error, cache?: 'contextual' | 'strict') => import("graphql-shield/typings/rules").Rule;
+export type ShieldRule = ReturnType<(typeof allow)['getRules']>[number];
+export declare const createRule: <TContext, TParent = unknown, TArgs = unknown>(logic: (parent: TParent, args: TArgs, ctx: TContext) => boolean | Promise<boolean> | Error, cache?: 'contextual' | 'strict') => ShieldRule;
 /**
  * Combines a given rule with all existing defined rules using the provided combinator
  * @param schema The existing shield schema with rules
@@ -40,4 +41,3 @@ export type ShieldSchema<TResolver> = TResolver extends Primitive ? ShieldRule :
     '*'?: ShieldRule;
 };
 export {};
-//# sourceMappingURL=shield.d.ts.map

package/shield.js

@@ -1,9 +1,8 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createShieldSchema = exports.combineRuleWithAll = exports.createRule = void 0;
-const graphql_shield_1 = require("graphql-shield");
-const createRule = (logic, cache = 'strict') => (0, graphql_shield_1.rule)({ cache })(async (parent, args, ctx) => logic(parent, args, ctx));
-exports.createRule = createRule;
+'use strict';
+
+var graphqlShield = require('graphql-shield');
+
+const createRule = (logic, cache = 'strict') => graphqlShield.rule({ cache })(async (parent, args, ctx) => logic(parent, args, ctx));
 /**
  * Combines a given rule with all existing defined rules using the provided combinator
  * @param schema The existing shield schema with rules
@@ -22,7 +21,6 @@ function combineRuleWithAll(schema, rule, combinator) {
         return [key, combineRuleWithAll(value, rule, combinator)];
     }));
 }
-exports.combineRuleWithAll = combineRuleWithAll;
 /**
  * Creates graphql shield middleware making use of generics to type the definition of the rules.
  * @param schema A mapping of schema objects to the shield rules that define the access to that object
@@ -42,11 +40,14 @@ exports.combineRuleWithAll = combineRuleWithAll;
  *
  * schema = applyMiddleware(schema, shieldSchema)
  */
-function createShieldSchema(schema, fallbackRule = graphql_shield_1.allow) {
-    return (0, graphql_shield_1.shield)(schema, {
+function createShieldSchema(schema, fallbackRule = graphqlShield.allow) {
+    return graphqlShield.shield(schema, {
         allowExternalErrors: true,
         fallbackRule: fallbackRule,
     });
 }
+
+exports.combineRuleWithAll = combineRuleWithAll;
+exports.createRule = createRule;
 exports.createShieldSchema = createShieldSchema;
-//# sourceMappingURL=shield.js.map
+//# sourceMappingURL=shield.js.map

package/shield.js.map

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

package/shield.mjs

@@ -0,0 +1,49 @@
+import { rule, shield, allow } from 'graphql-shield';
+
+const createRule = (logic, cache = 'strict') => rule({ cache })(async (parent, args, ctx) => logic(parent, args, ctx));
+/**
+ * Combines a given rule with all existing defined rules using the provided combinator
+ * @param schema The existing shield schema with rules
+ * @param rule The rule to be combined with existing rules
+ * @param combinator The combinator to use. Eg. and | or | chain | race
+ *
+ * Usage:
+ *
+ * const updatedSchema = combineRuleWithAll(shieldSchema, rules.accountNotBlocked, chain)
+ */
+function combineRuleWithAll(schema, rule, combinator) {
+    return Object.fromEntries(Object.entries(schema).map(([key, value]) => {
+        if (value.constructor.name !== 'Object') {
+            return [key, combinator(rule, value)];
+        }
+        return [key, combineRuleWithAll(value, rule, combinator)];
+    }));
+}
+/**
+ * Creates graphql shield middleware making use of generics to type the definition of the rules.
+ * @param schema A mapping of schema objects to the shield rules that define the access to that object
+ * @param fallbackRule A fallback rule to apply to any object or property which doesn't have a defined rule.
+ *
+ * Usage:
+ * import { Resolvers } from '../generated/types'
+ *
+ * const shieldSchema = createShieldSchema<Resolvers>({
+ *   Query: {
+ *     getThings: allow,
+ *     dontGetThings: deny,
+ *   }
+ * })
+ *
+ * let schema = makeExecutableSchema({...})
+ *
+ * schema = applyMiddleware(schema, shieldSchema)
+ */
+function createShieldSchema(schema, fallbackRule = allow) {
+    return shield(schema, {
+        allowExternalErrors: true,
+        fallbackRule: fallbackRule,
+    });
+}
+
+export { combineRuleWithAll, createRule, createShieldSchema };
+//# sourceMappingURL=shield.mjs.map

package/shield.mjs.map

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

package/subscriptions/context.d.ts

@@ -2,7 +2,7 @@
 import type { Logger } from '@makerx/node-common';
 import type { IncomingMessage } from 'http';
 import { User } from '../User';
-import { CreateRequestLogger, GraphQLContext, JwtPayload, RequestInfo } from '../context';
+import type { CreateRequestLogger, GraphQLContext, JwtPayload, RequestInfo } from '../context';
 export interface SubscriptionContextInput {
     connectRequest: IncomingMessage;
     connectionParams?: Readonly<Record<string, unknown>>;
@@ -20,4 +20,3 @@ export interface CreateSubscriptionContextConfig<TContext = GraphQLContext> {
     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.js

@@ -1,10 +1,10 @@
-"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");
+'use strict';
+
+var crypto = require('crypto');
+var lodash = require('lodash');
+var User = require('../User.js');
+var utils = require('./utils.js');
+
 const createSubscriptionContextFactory = ({ requestLogger, augmentRequestInfo, claimsToLog, createUser = defaultCreateUser, requestInfoToLog, augmentContext, }) => {
     // the function that creates the GraphQL context
     return async (input) => {
@@ -13,7 +13,7 @@ const createSubscriptionContextFactory = ({ requestLogger, augmentRequestInfo, c
         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)(),
+            requestId: req.headers['x-request-id']?.toString() ?? crypto.randomUUID(),
             protocol: 'ws',
             host: host ?? '',
             method: req.method ?? '',
@@ -32,10 +32,10 @@ const createSubscriptionContextFactory = ({ requestLogger, augmentRequestInfo, c
             const requestLoggerMetadata = {};
             // add request info to log
             if (requestInfoToLog?.length)
-                requestLoggerMetadata.request = (0, lodash_1.pick)(requestInfo, requestInfoToLog);
+                requestLoggerMetadata.request = lodash.pick(requestInfo, requestInfoToLog);
             // add user claims to log
             if (claims && claimsToLog?.length)
-                requestLoggerMetadata.user = (0, lodash_1.pick)(claims, claimsToLog);
+                requestLoggerMetadata.user = lodash.pick(claims, claimsToLog);
             // build the request logger
             logger = requestLogger(requestLoggerMetadata);
         }
@@ -53,11 +53,12 @@ const createSubscriptionContextFactory = ({ requestLogger, augmentRequestInfo, c
         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 ?? ''));
+    const accessToken = utils.extractTokenFromConnectionParams(connectionParams);
+    return Promise.resolve(new User.User(claims, accessToken ?? ''));
 };
-//# sourceMappingURL=context.js.map
+
+exports.createSubscriptionContextFactory = createSubscriptionContextFactory;
+//# sourceMappingURL=context.js.map

package/subscriptions/context.js.map

@@ -1 +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"}
+{"version":3,"file":"context.js","sources":["../../src/subscriptions/context.ts"],"sourcesContent":["import type { Logger } from '@makerx/node-common'\nimport { randomUUID } from 'crypto'\nimport type { IncomingMessage } from 'http'\nimport { pick } from 'lodash'\nimport { User } from '../User'\nimport type { CreateRequestLogger, GraphQLContext, JwtPayload, RequestInfo } from '../context'\nimport { extractTokenFromConnectionParams } from './utils'\n\nexport interface SubscriptionContextInput {\n  connectRequest: IncomingMessage\n  connectionParams?: Readonly<Record<string, unknown>>\n  claims?: JwtPayload\n}\n\nexport type CreateSubscriptionUser<T = User | undefined> = (input: SubscriptionContextInput) => Promise<T>\nexport type CreateSubscriptionContext<TContext = GraphQLContext> = (input: SubscriptionContextInput) => Promise<TContext>\nexport type AugmentSubscriptionRequestInfo = (input: SubscriptionContextInput) => Record<string, unknown>\n\nexport interface CreateSubscriptionContextConfig<TContext = GraphQLContext> {\n  requestLogger: CreateRequestLogger | Logger\n  augmentRequestInfo?: AugmentSubscriptionRequestInfo\n  claimsToLog?: string[]\n  createUser?: CreateSubscriptionUser\n  requestInfoToLog?: Array<keyof RequestInfo>\n  augmentContext?: (context: TContext) => Record<string, unknown> | Promise<Record<string, unknown>>\n}\n\nexport const createSubscriptionContextFactory = <TContext extends GraphQLContext = GraphQLContext>({\n  requestLogger,\n  augmentRequestInfo,\n  claimsToLog,\n  createUser = defaultCreateUser,\n  requestInfoToLog,\n  augmentContext,\n}: CreateSubscriptionContextConfig<TContext>): CreateSubscriptionContext<TContext> => {\n  // the function that creates the GraphQL context\n  return async (input: SubscriptionContextInput) => {\n    const { connectRequest: req, claims } = input\n\n    const xForwardedFor = req.headers['x-forwarded-for']\n    const host = Array.isArray(xForwardedFor) ? xForwardedFor[0] : xForwardedFor ?? req.headers.host\n\n    // build request info from the connect request and socket\n    const requestInfo: RequestInfo = {\n      requestId: req.headers['x-request-id']?.toString() ?? randomUUID(),\n      protocol: 'ws',\n      host: host ?? '',\n      method: req.method ?? '',\n      url: req.url ?? '',\n      origin: req.headers['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      ...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: await createUser(input),\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\nconst defaultCreateUser: CreateSubscriptionUser<User | undefined> = ({ claims, connectionParams }) => {\n  if (!claims) return Promise.resolve(undefined)\n  const accessToken = extractTokenFromConnectionParams(connectionParams)\n  return Promise.resolve(new User(claims, accessToken ?? ''))\n}\n"],"names":["randomUUID","pick","extractTokenFromConnectionParams","User"],"mappings":";;;;;;;MA2Ba,gCAAgC,GAAG,CAAmD,EACjG,aAAa,EACb,kBAAkB,EAClB,WAAW,EACX,UAAU,GAAG,iBAAiB,EAC9B,gBAAgB,EAChB,cAAc,GAC4B,KAAyC;;AAEnF,IAAA,OAAO,OAAO,KAA+B,KAAI;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,GAAG,aAAa,CAAC,CAAC,CAAC,GAAG,aAAa,IAAI,GAAG,CAAC,OAAO,CAAC,IAAI,CAAA;;AAGhG,QAAA,MAAM,WAAW,GAAgB;AAC/B,YAAA,SAAS,EAAE,GAAG,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE,QAAQ,EAAE,IAAIA,iBAAU,EAAE;AAClE,YAAA,QAAQ,EAAE,IAAI;YACd,IAAI,EAAE,IAAI,IAAI,EAAE;AAChB,YAAA,MAAM,EAAE,GAAG,CAAC,MAAM,IAAI,EAAE;AACxB,YAAA,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;AAC9D,YAAA,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;AACvE,YAAA,GAAG,kBAAkB,GAAG,KAAK,CAAC;SAC/B,CAAA;;AAGD,QAAA,IAAI,MAAc,CAAA;AAClB,QAAA,IAAI,OAAO,aAAa,KAAK,UAAU,EAAE;;YAEvC,MAAM,qBAAqB,GAA4B,EAAE,CAAA;;YAEzD,IAAI,gBAAgB,EAAE,MAAM;gBAAE,qBAAqB,CAAC,OAAO,GAAGC,WAAI,CAAC,WAAW,EAAE,gBAAgB,CAAC,CAAA;;AAEjG,YAAA,IAAI,MAAM,IAAI,WAAW,EAAE,MAAM;gBAAE,qBAAqB,CAAC,IAAI,GAAGA,WAAI,CAAC,MAAM,EAAE,WAAW,CAAC,CAAA;;AAEzF,YAAA,MAAM,GAAG,aAAa,CAAC,qBAAqB,CAAC,CAAA;SAC9C;;YAAM,MAAM,GAAG,aAAa,CAAA;AAE7B,QAAA,MAAM,cAAc,GAAmB;YACrC,WAAW;YACX,MAAM;AACN,YAAA,IAAI,EAAE,MAAM,UAAU,CAAC,KAAK,CAAC;AAC7B,YAAA,OAAO,EAAE,IAAI,CAAC,GAAG,EAAE;SACpB,CAAA;QAED,MAAM,uBAAuB,GAAG,cAAc;AAC5C,cAAE,EAAE,GAAG,cAAc,EAAE,IAAI,MAAM,cAAc,CAAC,cAA0B,CAAC,GAAG;cAC5E,cAAc,CAAA;AAElB,QAAA,OAAO,uBAAmC,CAAA;AAC5C,KAAC,CAAA;AACH,EAAC;AAED,MAAM,iBAAiB,GAA6C,CAAC,EAAE,MAAM,EAAE,gBAAgB,EAAE,KAAI;AACnG,IAAA,IAAI,CAAC,MAAM;AAAE,QAAA,OAAO,OAAO,CAAC,OAAO,CAAC,SAAS,CAAC,CAAA;AAC9C,IAAA,MAAM,WAAW,GAAGC,sCAAgC,CAAC,gBAAgB,CAAC,CAAA;AACtE,IAAA,OAAO,OAAO,CAAC,OAAO,CAAC,IAAIC,SAAI,CAAC,MAAM,EAAE,WAAW,IAAI,EAAE,CAAC,CAAC,CAAA;AAC7D,CAAC;;;;"}

package/subscriptions/context.mjs

@@ -0,0 +1,62 @@
+import { randomUUID } from 'crypto';
+import { pick } from 'lodash';
+import { User } from '../User.mjs';
+import { extractTokenFromConnectionParams } from './utils.mjs';
+
+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() ?? 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 = pick(requestInfo, requestInfoToLog);
+            // add user claims to log
+            if (claims && claimsToLog?.length)
+                requestLoggerMetadata.user = 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;
+    };
+};
+const defaultCreateUser = ({ claims, connectionParams }) => {
+    if (!claims)
+        return Promise.resolve(undefined);
+    const accessToken = extractTokenFromConnectionParams(connectionParams);
+    return Promise.resolve(new User(claims, accessToken ?? ''));
+};
+
+export { createSubscriptionContextFactory };
+//# sourceMappingURL=context.mjs.map

package/subscriptions/context.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"context.mjs","sources":["../../src/subscriptions/context.ts"],"sourcesContent":["import type { Logger } from '@makerx/node-common'\nimport { randomUUID } from 'crypto'\nimport type { IncomingMessage } from 'http'\nimport { pick } from 'lodash'\nimport { User } from '../User'\nimport type { CreateRequestLogger, GraphQLContext, JwtPayload, RequestInfo } from '../context'\nimport { extractTokenFromConnectionParams } from './utils'\n\nexport interface SubscriptionContextInput {\n  connectRequest: IncomingMessage\n  connectionParams?: Readonly<Record<string, unknown>>\n  claims?: JwtPayload\n}\n\nexport type CreateSubscriptionUser<T = User | undefined> = (input: SubscriptionContextInput) => Promise<T>\nexport type CreateSubscriptionContext<TContext = GraphQLContext> = (input: SubscriptionContextInput) => Promise<TContext>\nexport type AugmentSubscriptionRequestInfo = (input: SubscriptionContextInput) => Record<string, unknown>\n\nexport interface CreateSubscriptionContextConfig<TContext = GraphQLContext> {\n  requestLogger: CreateRequestLogger | Logger\n  augmentRequestInfo?: AugmentSubscriptionRequestInfo\n  claimsToLog?: string[]\n  createUser?: CreateSubscriptionUser\n  requestInfoToLog?: Array<keyof RequestInfo>\n  augmentContext?: (context: TContext) => Record<string, unknown> | Promise<Record<string, unknown>>\n}\n\nexport const createSubscriptionContextFactory = <TContext extends GraphQLContext = GraphQLContext>({\n  requestLogger,\n  augmentRequestInfo,\n  claimsToLog,\n  createUser = defaultCreateUser,\n  requestInfoToLog,\n  augmentContext,\n}: CreateSubscriptionContextConfig<TContext>): CreateSubscriptionContext<TContext> => {\n  // the function that creates the GraphQL context\n  return async (input: SubscriptionContextInput) => {\n    const { connectRequest: req, claims } = input\n\n    const xForwardedFor = req.headers['x-forwarded-for']\n    const host = Array.isArray(xForwardedFor) ? xForwardedFor[0] : xForwardedFor ?? req.headers.host\n\n    // build request info from the connect request and socket\n    const requestInfo: RequestInfo = {\n      requestId: req.headers['x-request-id']?.toString() ?? randomUUID(),\n      protocol: 'ws',\n      host: host ?? '',\n      method: req.method ?? '',\n      url: req.url ?? '',\n      origin: req.headers['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      ...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: await createUser(input),\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\nconst defaultCreateUser: CreateSubscriptionUser<User | undefined> = ({ claims, connectionParams }) => {\n  if (!claims) return Promise.resolve(undefined)\n  const accessToken = extractTokenFromConnectionParams(connectionParams)\n  return Promise.resolve(new User(claims, accessToken ?? ''))\n}\n"],"names":[],"mappings":";;;;;MA2Ba,gCAAgC,GAAG,CAAmD,EACjG,aAAa,EACb,kBAAkB,EAClB,WAAW,EACX,UAAU,GAAG,iBAAiB,EAC9B,gBAAgB,EAChB,cAAc,GAC4B,KAAyC;;AAEnF,IAAA,OAAO,OAAO,KAA+B,KAAI;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,GAAG,aAAa,CAAC,CAAC,CAAC,GAAG,aAAa,IAAI,GAAG,CAAC,OAAO,CAAC,IAAI,CAAA;;AAGhG,QAAA,MAAM,WAAW,GAAgB;AAC/B,YAAA,SAAS,EAAE,GAAG,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE,QAAQ,EAAE,IAAI,UAAU,EAAE;AAClE,YAAA,QAAQ,EAAE,IAAI;YACd,IAAI,EAAE,IAAI,IAAI,EAAE;AAChB,YAAA,MAAM,EAAE,GAAG,CAAC,MAAM,IAAI,EAAE;AACxB,YAAA,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;AAC9D,YAAA,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;AACvE,YAAA,GAAG,kBAAkB,GAAG,KAAK,CAAC;SAC/B,CAAA;;AAGD,QAAA,IAAI,MAAc,CAAA;AAClB,QAAA,IAAI,OAAO,aAAa,KAAK,UAAU,EAAE;;YAEvC,MAAM,qBAAqB,GAA4B,EAAE,CAAA;;YAEzD,IAAI,gBAAgB,EAAE,MAAM;gBAAE,qBAAqB,CAAC,OAAO,GAAG,IAAI,CAAC,WAAW,EAAE,gBAAgB,CAAC,CAAA;;AAEjG,YAAA,IAAI,MAAM,IAAI,WAAW,EAAE,MAAM;gBAAE,qBAAqB,CAAC,IAAI,GAAG,IAAI,CAAC,MAAM,EAAE,WAAW,CAAC,CAAA;;AAEzF,YAAA,MAAM,GAAG,aAAa,CAAC,qBAAqB,CAAC,CAAA;SAC9C;;YAAM,MAAM,GAAG,aAAa,CAAA;AAE7B,QAAA,MAAM,cAAc,GAAmB;YACrC,WAAW;YACX,MAAM;AACN,YAAA,IAAI,EAAE,MAAM,UAAU,CAAC,KAAK,CAAC;AAC7B,YAAA,OAAO,EAAE,IAAI,CAAC,GAAG,EAAE;SACpB,CAAA;QAED,MAAM,uBAAuB,GAAG,cAAc;AAC5C,cAAE,EAAE,GAAG,cAAc,EAAE,IAAI,MAAM,cAAc,CAAC,cAA0B,CAAC,GAAG;cAC5E,cAAc,CAAA;AAElB,QAAA,OAAO,uBAAmC,CAAA;AAC5C,KAAC,CAAA;AACH,EAAC;AAED,MAAM,iBAAiB,GAA6C,CAAC,EAAE,MAAM,EAAE,gBAAgB,EAAE,KAAI;AACnG,IAAA,IAAI,CAAC,MAAM;AAAE,QAAA,OAAO,OAAO,CAAC,OAAO,CAAC,SAAS,CAAC,CAAA;AAC9C,IAAA,MAAM,WAAW,GAAG,gCAAgC,CAAC,gBAAgB,CAAC,CAAA;AACtE,IAAA,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,MAAM,EAAE,WAAW,IAAI,EAAE,CAAC,CAAC,CAAA;AAC7D,CAAC;;;;"}

package/subscriptions/index.d.ts

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

package/subscriptions/index.js

@@ -1,22 +1,12 @@
-"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
+'use strict';
+
+var context = require('./context.js');
+var server = require('./server.js');
+var utils = require('./utils.js');
+
+
+
+exports.createSubscriptionContextFactory = context.createSubscriptionContextFactory;
+exports.useSubscriptionsServer = server.useSubscriptionsServer;
+exports.extractTokenFromConnectionParams = utils.extractTokenFromConnectionParams;
+//# sourceMappingURL=index.js.map

package/subscriptions/index.js.map

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

package/subscriptions/index.mjs

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

package/subscriptions/index.mjs.map

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

package/subscriptions/server.d.ts

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