@makerx/graphql-core 1.0.0 → 1.1.0

package/index.d.ts

@@ -3,4 +3,7 @@ export * from './User';
 export * from './utils';
 export * from './logging';
 export * from './subscriptions';
+export * from './schema-util';
+export * from './shield';
+export * from './models';
 //# sourceMappingURL=index.d.ts.map

package/index.d.ts.map

@@ -1 +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"}
+{"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;AAC/B,cAAc,eAAe,CAAA;AAC7B,cAAc,UAAU,CAAA;AACxB,cAAc,UAAU,CAAA"}

package/index.js

@@ -19,4 +19,7 @@ __exportStar(require("./User"), exports);
 __exportStar(require("./utils"), exports);
 __exportStar(require("./logging"), exports);
 __exportStar(require("./subscriptions"), exports);
+__exportStar(require("./schema-util"), exports);
+__exportStar(require("./shield"), exports);
+__exportStar(require("./models"), exports);
 //# sourceMappingURL=index.js.map

package/index.js.map

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

package/models.d.ts

@@ -0,0 +1,5 @@
+export type Primitive = string | number | symbol | bigint | boolean | null | undefined | Date;
+type ScalarPropsInternal<T, TKey extends keyof T, TAdditionalScalars = never> = TKey extends any ? T[TKey] extends Primitive | TAdditionalScalars ? TKey : never : never;
+export type ScalarProps<T, TAdditionalScalars = never> = Pick<T, ScalarPropsInternal<T, keyof T, TAdditionalScalars>>;
+export {};
+//# sourceMappingURL=models.d.ts.map

package/models.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"models.d.ts","sourceRoot":"","sources":["../src/models.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,SAAS,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,GAAG,SAAS,GAAG,IAAI,CAAA;AAG7F,KAAK,mBAAmB,CAAC,CAAC,EAAE,IAAI,SAAS,MAAM,CAAC,EAAE,kBAAkB,GAAG,KAAK,IAAI,IAAI,SAAS,GAAG,GAC5F,CAAC,CAAC,IAAI,CAAC,SAAS,SAAS,GAAG,kBAAkB,GAC5C,IAAI,GACJ,KAAK,GACP,KAAK,CAAA;AACT,MAAM,MAAM,WAAW,CAAC,CAAC,EAAE,kBAAkB,GAAG,KAAK,IAAI,IAAI,CAAC,CAAC,EAAE,mBAAmB,CAAC,CAAC,EAAE,MAAM,CAAC,EAAE,kBAAkB,CAAC,CAAC,CAAA"}

package/models.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=models.js.map

package/models.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"models.js","sourceRoot":"","sources":["../src/models.ts"],"names":[],"mappings":""}

package/package.json

@@ -2,7 +2,7 @@
   "main": "index.js",
   "types": "index.d.ts",
   "name": "@makerx/graphql-core",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "private": false,
   "description": "A set of core GraphQL utilities that MakerX uses to build GraphQL APIs",
   "author": "MakerX",
@@ -24,6 +24,7 @@
     "lodash.pick": "^4.4.0"
   },
   "peerDependencies": {
+    "graphql-shield": "*",
     "express": "*",
     "graphql": "*",
     "graphql-ws": "*",
@@ -38,6 +39,7 @@
     }
   },
   "overrides": {
-    "semver": "^7.5.3"
+    "@typescript-eslint/eslint-plugin": "^6.0.0",
+    "@typescript-eslint/parser": "^6.0.0"
   }
 }

package/schema-util.d.ts

@@ -0,0 +1,10 @@
+import { 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
+ * 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`
+ */
+export declare function requireExplicitResolversForScalars(schema: GraphQLSchema): void;
+//# sourceMappingURL=schema-util.d.ts.map

package/schema-util.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema-util.d.ts","sourceRoot":"","sources":["../src/schema-util.ts"],"names":[],"mappings":"AAAA,OAAO,EAAqB,aAAa,EAAE,MAAM,SAAS,CAAA;AAE1D;;;;;;GAMG;AACH,wBAAgB,kCAAkC,CAAC,MAAM,EAAE,aAAa,QAevE"}

package/schema-util.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.requireExplicitResolversForScalars = void 0;
+const graphql_1 = 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
+ * 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) {
+    const testSymbol = Symbol('testSymbol');
+    const scalars = Object.values(schema.getTypeMap()).filter((t) => t instanceof graphql_1.GraphQLScalarType);
+    for (const scalar of scalars) {
+        if (scalar.name === 'Void')
+            continue;
+        try {
+            scalar.parseValue(testSymbol);
+        }
+        catch {
+            // We expect that a parser should not handle parsing a 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`);
+    }
+}
+exports.requireExplicitResolversForScalars = requireExplicitResolversForScalars;
+//# sourceMappingURL=schema-util.js.map

package/schema-util.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema-util.js","sourceRoot":"","sources":["../src/schema-util.ts"],"names":[],"mappings":";;;AAAA,qCAA0D;AAE1D;;;;;;GAMG;AACH,SAAgB,kCAAkC,CAAC,MAAqB;IACtE,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;YAAE,SAAQ;QACpC,IAAI;YACF,MAAM,CAAC,UAAU,CAAC,UAAU,CAAC,CAAA;SAC9B;QAAC,MAAM;YACN,6DAA6D;YAC7D,SAAQ;SACT;QACD,MAAM,IAAI,KAAK,CACb,UAAU,MAAM,CAAC,IAAI,8GAA8G,CACpI,CAAA;KACF;AACH,CAAC;AAfD,gFAeC"}

package/shield.d.ts

@@ -0,0 +1,43 @@
+import { ShieldRule } from 'graphql-shield/typings/types';
+import { Primitive } from './models';
+import { and, chain, or, race } from 'graphql-shield';
+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;
+/**
+ * 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)
+ */
+export declare function combineRuleWithAll<T>(schema: ShieldSchema<T>, rule: ShieldRule, combinator: RuleCombinator): ShieldSchema<T>;
+/**
+ * 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)
+ */
+export declare function createShieldSchema<TRootResolvers>(schema: ShieldSchema<TRootResolvers>, fallbackRule?: ShieldRule): import("graphql-middleware").IMiddlewareGenerator<any, any, any>;
+export type ShieldSchema<TResolver> = TResolver extends Primitive ? ShieldRule : {
+    [key in keyof TResolver]?: ShieldSchema<TResolver[key]> | ShieldRule;
+} & {
+    '*'?: ShieldRule;
+};
+export {};
+//# sourceMappingURL=shield.d.ts.map

package/shield.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"shield.d.ts","sourceRoot":"","sources":["../src/shield.ts"],"names":[],"mappings":"AAAA,OAAO,EAAU,UAAU,EAAE,MAAM,8BAA8B,CAAA;AACjE,OAAO,EAAE,SAAS,EAAE,MAAM,UAAU,CAAA;AACpC,OAAO,EAAS,GAAG,EAAE,KAAK,EAAE,EAAE,EAAE,IAAI,EAAgB,MAAM,gBAAgB,CAAA;AAE1E,KAAK,cAAc,GAAG,OAAO,KAAK,GAAG,OAAO,IAAI,GAAG,OAAO,EAAE,GAAG,OAAO,GAAG,CAAA;AAEzE,eAAO,MAAM,UAAU,yGACmC,OAAO,GAAG,QAAQ,OAAO,CAAC,GAAG,KAAK,UACnF,YAAY,GAAG,QAAQ,gDAC2C,CAAA;AAE3E;;;;;;;;;GASG;AACH,wBAAgB,kBAAkB,CAAC,CAAC,EAAE,MAAM,EAAE,YAAY,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,UAAU,EAAE,cAAc,GAAG,YAAY,CAAC,CAAC,CAAC,CAS5H;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,kBAAkB,CAAC,cAAc,EAAE,MAAM,EAAE,YAAY,CAAC,cAAc,CAAC,EAAE,YAAY,GAAE,UAAkB,oEAKxH;AAED,MAAM,MAAM,YAAY,CAAC,SAAS,IAAI,SAAS,SAAS,SAAS,GAC7D,UAAU,GACV;KACG,GAAG,IAAI,MAAM,SAAS,CAAC,CAAC,EAAE,YAAY,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,GAAG,UAAU;CACrE,GAAG;IACF,GAAG,CAAC,EAAE,UAAU,CAAA;CACjB,CAAA"}

package/shield.js

@@ -0,0 +1,52 @@
+"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;
+/**
+ * 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)];
+    }));
+}
+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
+ * @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 = graphql_shield_1.allow) {
+    return (0, graphql_shield_1.shield)(schema, {
+        allowExternalErrors: true,
+        fallbackRule: fallbackRule,
+    });
+}
+exports.createShieldSchema = createShieldSchema;
+//# sourceMappingURL=shield.js.map

package/shield.js.map

@@ -0,0 +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"}