@deenruv/core 1.0.0

package/dist/api/config/generate-list-options.js

@@ -0,0 +1,218 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateListOptions = void 0;
+const shared_utils_1 = require("@deenruv/common/lib/shared-utils");
+const index_js_1 = require("graphql/index.js");
+// Using require here to prevent issues when running vitest tests also.
+const { stitchSchemas, ValidationLevel } = require("@graphql-tools/stitch");
+/**
+ * Generates ListOptions inputs for queries which return PaginatedList types.
+ */
+function generateListOptions(typeDefsOrSchema) {
+    const schema = typeof typeDefsOrSchema === "string"
+        ? (0, index_js_1.buildSchema)(typeDefsOrSchema)
+        : typeDefsOrSchema;
+    const queryType = schema.getQueryType();
+    if (!queryType) {
+        return schema;
+    }
+    const logicalOperatorEnum = schema.getType("LogicalOperator");
+    const objectTypes = Object.values(schema.getTypeMap()).filter(index_js_1.isObjectType);
+    const allFields = objectTypes.reduce((fields, type) => {
+        const typeFields = Object.values(type.getFields()).filter((f) => isListQueryType(f.type));
+        return [...fields, ...typeFields];
+    }, []);
+    const generatedTypes = [];
+    for (const query of allFields) {
+        const targetTypeName = unwrapNonNullType(query.type)
+            .toString()
+            .replace(/List$/, "");
+        const targetType = schema.getType(targetTypeName);
+        if (targetType && (0, index_js_1.isObjectType)(targetType)) {
+            const sortParameter = createSortParameter(schema, targetType);
+            const filterParameter = createFilterParameter(schema, targetType);
+            const existingListOptions = schema.getType(`${targetTypeName}ListOptions`);
+            const generatedListOptions = new index_js_1.GraphQLInputObjectType({
+                name: `${targetTypeName}ListOptions`,
+                fields: Object.assign(Object.assign({ skip: {
+                        type: index_js_1.GraphQLInt,
+                        description: "Skips the first n results, for use in pagination",
+                    }, take: {
+                        type: index_js_1.GraphQLInt,
+                        description: "Takes n results, for use in pagination",
+                    }, sort: {
+                        type: sortParameter,
+                        description: "Specifies which properties to sort the results by",
+                    }, filter: {
+                        type: filterParameter,
+                        description: "Allows the results to be filtered",
+                    } }, (logicalOperatorEnum
+                    ? {
+                        filterOperator: {
+                            type: logicalOperatorEnum,
+                            description: 'Specifies whether multiple top-level "filter" fields should be combined ' +
+                                "with a logical AND or OR operation. Defaults to AND.",
+                        },
+                    }
+                    : {})), (existingListOptions ? existingListOptions.getFields() : {})),
+            });
+            if (!query.args.find((a) => a.type.toString() === `${targetTypeName}ListOptions`)) {
+                query.args = [
+                    ...query.args,
+                    {
+                        name: "options",
+                        type: generatedListOptions,
+                        description: null,
+                        defaultValue: null,
+                        extensions: {},
+                        astNode: null,
+                        deprecationReason: null,
+                    },
+                ];
+            }
+            generatedTypes.push(filterParameter);
+            generatedTypes.push(sortParameter);
+            generatedTypes.push(generatedListOptions);
+        }
+    }
+    return stitchSchemas({
+        subschemas: [schema],
+        types: generatedTypes,
+        typeMergingOptions: {
+            validationSettings: { validationLevel: ValidationLevel.Off },
+        },
+    });
+}
+exports.generateListOptions = generateListOptions;
+function isListQueryType(type) {
+    const innerType = unwrapNonNullType(type);
+    return ((0, index_js_1.isObjectType)(innerType) &&
+        !!innerType.getInterfaces().find((i) => i.name === "PaginatedList"));
+}
+function createSortParameter(schema, targetType) {
+    const fields = Object.values(targetType.getFields());
+    const targetTypeName = targetType.name;
+    const SortOrder = schema.getType("SortOrder");
+    const inputName = `${targetTypeName}SortParameter`;
+    const existingInput = schema.getType(inputName);
+    if ((0, index_js_1.isInputObjectType)(existingInput)) {
+        fields.push(...Object.values(existingInput.getFields()));
+    }
+    const sortableTypes = ["ID", "String", "Int", "Float", "DateTime", "Money"];
+    return new index_js_1.GraphQLInputObjectType({
+        name: inputName,
+        fields: fields
+            .map((field) => {
+            if (unwrapNonNullType(field.type) === SortOrder) {
+                return field;
+            }
+            else {
+                const innerType = unwrapNonNullType(field.type);
+                if ((0, index_js_1.isListType)(innerType)) {
+                    return;
+                }
+                return sortableTypes.includes(innerType.name) ? field : undefined;
+            }
+        })
+            .filter(shared_utils_1.notNullOrUndefined)
+            .reduce((result, field) => {
+            const fieldConfig = {
+                type: SortOrder,
+            };
+            return Object.assign(Object.assign({}, result), { [field.name]: fieldConfig });
+        }, {}),
+    });
+}
+function createFilterParameter(schema, targetType) {
+    const fields = Object.values(targetType.getFields());
+    const targetTypeName = targetType.name;
+    const { StringOperators, BooleanOperators, NumberOperators, DateOperators, IDOperators, } = getCommonTypes(schema);
+    const inputName = `${targetTypeName}FilterParameter`;
+    const existingInput = schema.getType(inputName);
+    if ((0, index_js_1.isInputObjectType)(existingInput)) {
+        fields.push(...Object.values(existingInput.getFields()));
+    }
+    function getFilterType(field) {
+        const innerType = unwrapNonNullType(field.type);
+        if ((0, index_js_1.isListType)(innerType)) {
+            return;
+        }
+        if ((0, index_js_1.isEnumType)(innerType)) {
+            return StringOperators;
+        }
+        switch (innerType.name) {
+            case "String":
+                return StringOperators;
+            case "Boolean":
+                return BooleanOperators;
+            case "Int":
+            case "Float":
+            case "Money":
+                return NumberOperators;
+            case "DateTime":
+                return DateOperators;
+            case "ID":
+                return IDOperators;
+            default:
+                return;
+        }
+    }
+    const FilterInputType = new index_js_1.GraphQLInputObjectType({
+        name: inputName,
+        fields: () => {
+            const namedFields = fields.reduce((result, field) => {
+                const fieldType = field.type;
+                const filterType = (0, index_js_1.isInputObjectType)(fieldType)
+                    ? fieldType
+                    : getFilterType(field);
+                if (!filterType) {
+                    return result;
+                }
+                const fieldConfig = {
+                    type: filterType,
+                };
+                return Object.assign(Object.assign({}, result), { [field.name]: fieldConfig });
+            }, {});
+            return Object.assign(Object.assign({}, namedFields), { _and: { type: new index_js_1.GraphQLList(new index_js_1.GraphQLNonNull(FilterInputType)) }, _or: { type: new index_js_1.GraphQLList(new index_js_1.GraphQLNonNull(FilterInputType)) } });
+        },
+    });
+    return FilterInputType;
+}
+function getCommonTypes(schema) {
+    const SortOrder = schema.getType("SortOrder");
+    const StringOperators = schema.getType("StringOperators");
+    const BooleanOperators = schema.getType("BooleanOperators");
+    const NumberRange = schema.getType("NumberRange");
+    const NumberOperators = schema.getType("NumberOperators");
+    const DateRange = schema.getType("DateRange");
+    const DateOperators = schema.getType("DateOperators");
+    const IDOperators = schema.getType("IDOperators");
+    if (!SortOrder ||
+        !StringOperators ||
+        !BooleanOperators ||
+        !NumberRange ||
+        !NumberOperators ||
+        !DateRange ||
+        !DateOperators ||
+        !IDOperators) {
+        throw new Error("A common type was not defined");
+    }
+    return {
+        SortOrder,
+        StringOperators,
+        BooleanOperators,
+        NumberOperators,
+        DateOperators,
+        IDOperators,
+    };
+}
+/**
+ * Unwraps the inner type if it is inside a non-nullable type
+ */
+function unwrapNonNullType(type) {
+    if ((0, index_js_1.isNonNullType)(type)) {
+        return type.ofType;
+    }
+    return type;
+}
+//# sourceMappingURL=generate-list-options.js.map

package/dist/api/config/generate-list-options.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generate-list-options.js","sourceRoot":"","sources":["../../../src/api/config/generate-list-options.ts"],"names":[],"mappings":";;;AAAA,mEAAsE;AACtE,+CAuB0B;AAE1B,uEAAuE;AAEvE,MAAM,EAAE,aAAa,EAAE,eAAe,EAAE,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAAC;AAE5E;;GAEG;AACH,SAAgB,mBAAmB,CACjC,gBAAwC;IAExC,MAAM,MAAM,GACV,OAAO,gBAAgB,KAAK,QAAQ;QAClC,CAAC,CAAC,IAAA,sBAAW,EAAC,gBAAgB,CAAC;QAC/B,CAAC,CAAC,gBAAgB,CAAC;IACvB,MAAM,SAAS,GAAG,MAAM,CAAC,YAAY,EAAE,CAAC;IACxC,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,OAAO,MAAM,CAAC;IAChB,CAAC;IACD,MAAM,mBAAmB,GAAG,MAAM,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC;IAC9D,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC,CAAC,MAAM,CAAC,uBAAY,CAAC,CAAC;IAC5E,MAAM,SAAS,GAAG,WAAW,CAAC,MAAM,CAClC,CAAC,MAAM,EAAE,IAAI,EAAE,EAAE;QACf,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAC9D,eAAe,CAAC,CAAC,CAAC,IAAI,CAAC,CACxB,CAAC;QACF,OAAO,CAAC,GAAG,MAAM,EAAE,GAAG,UAAU,CAAC,CAAC;IACpC,CAAC,EACD,EAAmC,CACpC,CAAC;IACF,MAAM,cAAc,GAAuB,EAAE,CAAC;IAE9C,KAAK,MAAM,KAAK,IAAI,SAAS,EAAE,CAAC;QAC9B,MAAM,cAAc,GAAG,iBAAiB,CAAC,KAAK,CAAC,IAAI,CAAC;aACjD,QAAQ,EAAE;aACV,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;QACxB,MAAM,UAAU,GAAG,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;QAClD,IAAI,UAAU,IAAI,IAAA,uBAAY,EAAC,UAAU,CAAC,EAAE,CAAC;YAC3C,MAAM,aAAa,GAAG,mBAAmB,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;YAC9D,MAAM,eAAe,GAAG,qBAAqB,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;YAClE,MAAM,mBAAmB,GAAG,MAAM,CAAC,OAAO,CACxC,GAAG,cAAc,aAAa,CACE,CAAC;YACnC,MAAM,oBAAoB,GAAG,IAAI,iCAAsB,CAAC;gBACtD,IAAI,EAAE,GAAG,cAAc,aAAa;gBACpC,MAAM,gCACJ,IAAI,EAAE;wBACJ,IAAI,EAAE,qBAAU;wBAChB,WAAW,EAAE,kDAAkD;qBAChE,EACD,IAAI,EAAE;wBACJ,IAAI,EAAE,qBAAU;wBAChB,WAAW,EAAE,wCAAwC;qBACtD,EACD,IAAI,EAAE;wBACJ,IAAI,EAAE,aAAa;wBACnB,WAAW,EAAE,mDAAmD;qBACjE,EACD,MAAM,EAAE;wBACN,IAAI,EAAE,eAAe;wBACrB,WAAW,EAAE,mCAAmC;qBACjD,IACE,CAAC,mBAAmB;oBACrB,CAAC,CAAC;wBACE,cAAc,EAAE;4BACd,IAAI,EAAE,mBAAsC;4BAC5C,WAAW,EACT,0EAA0E;gCAC1E,sDAAsD;yBACzD;qBACF;oBACH,CAAC,CAAC,EAAE,CAAC,GACJ,CAAC,mBAAmB,CAAC,CAAC,CAAC,mBAAmB,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAChE;aACF,CAAC,CAAC;YAEH,IACE,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CACd,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,GAAG,cAAc,aAAa,CAC5D,EACD,CAAC;gBACD,KAAK,CAAC,IAAI,GAAG;oBACX,GAAG,KAAK,CAAC,IAAI;oBACb;wBACE,IAAI,EAAE,SAAS;wBACf,IAAI,EAAE,oBAAoB;wBAC1B,WAAW,EAAE,IAAI;wBACjB,YAAY,EAAE,IAAI;wBAClB,UAAU,EAAE,EAAE;wBACd,OAAO,EAAE,IAAI;wBACb,iBAAiB,EAAE,IAAI;qBACxB;iBACF,CAAC;YACJ,CAAC;YAED,cAAc,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;YACrC,cAAc,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;YACnC,cAAc,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;QAC5C,CAAC;IACH,CAAC;IACD,OAAO,aAAa,CAAC;QACnB,UAAU,EAAE,CAAC,MAAM,CAAC;QACpB,KAAK,EAAE,cAAc;QACrB,kBAAkB,EAAE;YAClB,kBAAkB,EAAE,EAAE,eAAe,EAAE,eAAe,CAAC,GAAG,EAAE;SAC7D;KACF,CAAC,CAAC;AACL,CAAC;AAnGD,kDAmGC;AAED,SAAS,eAAe,CAAC,IAAuB;IAC9C,MAAM,SAAS,GAAG,iBAAiB,CAAC,IAAI,CAAC,CAAC;IAC1C,OAAO,CACL,IAAA,uBAAY,EAAC,SAAS,CAAC;QACvB,CAAC,CAAC,SAAS,CAAC,aAAa,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,eAAe,CAAC,CACpE,CAAC;AACJ,CAAC;AAED,SAAS,mBAAmB,CAC1B,MAAqB,EACrB,UAA6B;IAE7B,MAAM,MAAM,GACV,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,SAAS,EAAE,CAAC,CAAC;IACxC,MAAM,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IACvC,MAAM,SAAS,GAAG,MAAM,CAAC,OAAO,CAAC,WAAW,CAAoB,CAAC;IAEjE,MAAM,SAAS,GAAG,GAAG,cAAc,eAAe,CAAC;IACnD,MAAM,aAAa,GAAG,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IAChD,IAAI,IAAA,4BAAiB,EAAC,aAAa,CAAC,EAAE,CAAC;QACrC,MAAM,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC;IAC3D,CAAC;IAED,MAAM,aAAa,GAAG,CAAC,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,OAAO,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC;IAC5E,OAAO,IAAI,iCAAsB,CAAC;QAChC,IAAI,EAAE,SAAS;QACf,MAAM,EAAE,MAAM;aACX,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;YACb,IAAI,iBAAiB,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,SAAS,EAAE,CAAC;gBAChD,OAAO,KAAK,CAAC;YACf,CAAC;iBAAM,CAAC;gBACN,MAAM,SAAS,GAAG,iBAAiB,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;gBAChD,IAAI,IAAA,qBAAU,EAAC,SAAS,CAAC,EAAE,CAAC;oBAC1B,OAAO;gBACT,CAAC;gBACD,OAAO,aAAa,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;YACpE,CAAC;QACH,CAAC,CAAC;aACD,MAAM,CAAC,iCAAkB,CAAC;aAC1B,MAAM,CAAC,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE;YACxB,MAAM,WAAW,GAA4B;gBAC3C,IAAI,EAAE,SAAS;aAChB,CAAC;YACF,uCACK,MAAM,KACT,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,WAAW,IACzB;QACJ,CAAC,EAAE,EAAgC,CAAC;KACvC,CAAC,CAAC;AACL,CAAC;AAED,SAAS,qBAAqB,CAC5B,MAAqB,EACrB,UAA6B;IAE7B,MAAM,MAAM,GACV,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,SAAS,EAAE,CAAC,CAAC;IACxC,MAAM,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IACvC,MAAM,EACJ,eAAe,EACf,gBAAgB,EAChB,eAAe,EACf,aAAa,EACb,WAAW,GACZ,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC;IAE3B,MAAM,SAAS,GAAG,GAAG,cAAc,iBAAiB,CAAC;IACrD,MAAM,aAAa,GAAG,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IAChD,IAAI,IAAA,4BAAiB,EAAC,aAAa,CAAC,EAAE,CAAC;QACrC,MAAM,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC;IAC3D,CAAC;IAED,SAAS,aAAa,CACpB,KAAiD;QAEjD,MAAM,SAAS,GAAG,iBAAiB,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAChD,IAAI,IAAA,qBAAU,EAAC,SAAS,CAAC,EAAE,CAAC;YAC1B,OAAO;QACT,CAAC;QACD,IAAI,IAAA,qBAAU,EAAC,SAAS,CAAC,EAAE,CAAC;YAC1B,OAAO,eAAe,CAAC;QACzB,CAAC;QACD,QAAQ,SAAS,CAAC,IAAI,EAAE,CAAC;YACvB,KAAK,QAAQ;gBACX,OAAO,eAAe,CAAC;YACzB,KAAK,SAAS;gBACZ,OAAO,gBAAgB,CAAC;YAC1B,KAAK,KAAK,CAAC;YACX,KAAK,OAAO,CAAC;YACb,KAAK,OAAO;gBACV,OAAO,eAAe,CAAC;YACzB,KAAK,UAAU;gBACb,OAAO,aAAa,CAAC;YACvB,KAAK,IAAI;gBACP,OAAO,WAAW,CAAC;YACrB;gBACE,OAAO;QACX,CAAC;IACH,CAAC;IAED,MAAM,eAAe,GAA2B,IAAI,iCAAsB,CAAC;QACzE,IAAI,EAAE,SAAS;QACf,MAAM,EAAE,GAAG,EAAE;YACX,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE;gBAClD,MAAM,SAAS,GAAG,KAAK,CAAC,IAAI,CAAC;gBAC7B,MAAM,UAAU,GAAG,IAAA,4BAAiB,EAAC,SAAS,CAAC;oBAC7C,CAAC,CAAC,SAAS;oBACX,CAAC,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;gBACzB,IAAI,CAAC,UAAU,EAAE,CAAC;oBAChB,OAAO,MAAM,CAAC;gBAChB,CAAC;gBACD,MAAM,WAAW,GAA4B;oBAC3C,IAAI,EAAE,UAAU;iBACjB,CAAC;gBACF,uCACK,MAAM,KACT,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,WAAW,IACzB;YACJ,CAAC,EAAE,EAAgC,CAAC,CAAC;YACrC,uCACK,WAAW,KACd,IAAI,EAAE,EAAE,IAAI,EAAE,IAAI,sBAAW,CAAC,IAAI,yBAAc,CAAC,eAAe,CAAC,CAAC,EAAE,EACpE,GAAG,EAAE,EAAE,IAAI,EAAE,IAAI,sBAAW,CAAC,IAAI,yBAAc,CAAC,eAAe,CAAC,CAAC,EAAE,IACnE;QACJ,CAAC;KACF,CAAC,CAAC;IAEH,OAAO,eAAe,CAAC;AACzB,CAAC;AAED,SAAS,cAAc,CAAC,MAAqB;IAC3C,MAAM,SAAS,GAAG,MAAM,CAAC,OAAO,CAAC,WAAW,CAA2B,CAAC;IACxE,MAAM,eAAe,GAAG,MAAM,CAAC,OAAO,CACpC,iBAAiB,CACS,CAAC;IAC7B,MAAM,gBAAgB,GAAG,MAAM,CAAC,OAAO,CACrC,kBAAkB,CACQ,CAAC;IAC7B,MAAM,WAAW,GAAG,MAAM,CAAC,OAAO,CAAC,aAAa,CAA4B,CAAC;IAC7E,MAAM,eAAe,GAAG,MAAM,CAAC,OAAO,CACpC,iBAAiB,CACS,CAAC;IAC7B,MAAM,SAAS,GAAG,MAAM,CAAC,OAAO,CAAC,WAAW,CAA4B,CAAC;IACzE,MAAM,aAAa,GAAG,MAAM,CAAC,OAAO,CAClC,eAAe,CACW,CAAC;IAC7B,MAAM,WAAW,GAAG,MAAM,CAAC,OAAO,CAAC,aAAa,CAA4B,CAAC;IAC7E,IACE,CAAC,SAAS;QACV,CAAC,eAAe;QAChB,CAAC,gBAAgB;QACjB,CAAC,WAAW;QACZ,CAAC,eAAe;QAChB,CAAC,SAAS;QACV,CAAC,aAAa;QACd,CAAC,WAAW,EACZ,CAAC;QACD,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAC;IACnD,CAAC;IACD,OAAO;QACL,SAAS;QACT,eAAe;QACf,gBAAgB;QAChB,eAAe;QACf,aAAa;QACb,WAAW;KACZ,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,SAAS,iBAAiB,CACxB,IAA0C;IAE1C,IAAI,IAAA,wBAAa,EAAC,IAAI,CAAC,EAAE,CAAC;QACxB,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC"}

package/dist/api/config/generate-permissions.d.ts

@@ -0,0 +1,6 @@
+import { GraphQLSchema } from "graphql";
+import { PermissionDefinition } from "../../common/permission-definition";
+/**
+ * Generates the `Permission` GraphQL enum based on the default & custom permission definitions.
+ */
+export declare function generatePermissionEnum(schema: GraphQLSchema, customPermissions: PermissionDefinition[]): GraphQLSchema;

package/dist/api/config/generate-permissions.js

@@ -0,0 +1,65 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generatePermissionEnum = void 0;
+const stitch_1 = require("@graphql-tools/stitch");
+const graphql_1 = require("graphql");
+const constants_1 = require("../../common/constants");
+const PERMISSION_DESCRIPTION = `@description
+Permissions for administrators and customers. Used to control access to
+GraphQL resolvers via the {@link Allow} decorator.
+
+## Understanding Permission.Owner
+
+\`Permission.Owner\` is a special permission which is used in some Deenruv resolvers to indicate that that resolver should only
+be accessible to the "owner" of that resource.
+
+For example, the Shop API \`activeCustomer\` query resolver should only return the Customer object for the "owner" of that Customer, i.e.
+based on the activeUserId of the current session. As a result, the resolver code looks like this:
+
+@example
+\`\`\`TypeScript
+\\@Query()
+\\@Allow(Permission.Owner)
+async activeCustomer(\\@Ctx() ctx: RequestContext): Promise<Customer | undefined> {
+  const userId = ctx.activeUserId;
+  if (userId) {
+    return this.customerService.findOneByUserId(ctx, userId);
+  }
+}
+\`\`\`
+
+Here we can see that the "ownership" must be enforced by custom logic inside the resolver. Since "ownership" cannot be defined generally
+nor statically encoded at build-time, any resolvers using \`Permission.Owner\` **must** include logic to enforce that only the owner
+of the resource has access. If not, then it is the equivalent of using \`Permission.Public\`.
+
+
+@docsCategory common`;
+/**
+ * Generates the `Permission` GraphQL enum based on the default & custom permission definitions.
+ */
+function generatePermissionEnum(schema, customPermissions) {
+    const allPermissionsMetadata = (0, constants_1.getAllPermissionsMetadata)(customPermissions);
+    const values = {};
+    let i = 0;
+    for (const entry of allPermissionsMetadata) {
+        values[entry.name] = {
+            value: i,
+            description: entry.description,
+        };
+        i++;
+    }
+    const permissionsEnum = new graphql_1.GraphQLEnumType({
+        name: "Permission",
+        description: PERMISSION_DESCRIPTION,
+        values,
+    });
+    return (0, stitch_1.stitchSchemas)({
+        subschemas: [schema],
+        types: [permissionsEnum],
+        typeMergingOptions: {
+            validationSettings: { validationLevel: stitch_1.ValidationLevel.Off },
+        },
+    });
+}
+exports.generatePermissionEnum = generatePermissionEnum;
+//# sourceMappingURL=generate-permissions.js.map

package/dist/api/config/generate-permissions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generate-permissions.js","sourceRoot":"","sources":["../../../src/api/config/generate-permissions.ts"],"names":[],"mappings":";;;AAAA,kDAAuE;AACvE,qCAAyD;AAGzD,sDAAmE;AAGnE,MAAM,sBAAsB,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;qBA6BV,CAAC;AAEtB;;GAEG;AACH,SAAgB,sBAAsB,CACpC,MAAqB,EACrB,iBAAyC;IAEzC,MAAM,sBAAsB,GAAG,IAAA,qCAAyB,EAAC,iBAAiB,CAAC,CAAC;IAC5E,MAAM,MAAM,GAA8B,EAAE,CAAC;IAC7C,IAAI,CAAC,GAAG,CAAC,CAAC;IACV,KAAK,MAAM,KAAK,IAAI,sBAAsB,EAAE,CAAC;QAC3C,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG;YACnB,KAAK,EAAE,CAAC;YACR,WAAW,EAAE,KAAK,CAAC,WAAW;SAC/B,CAAC;QACF,CAAC,EAAE,CAAC;IACN,CAAC;IAED,MAAM,eAAe,GAAG,IAAI,yBAAe,CAAC;QAC1C,IAAI,EAAE,YAAY;QAClB,WAAW,EAAE,sBAAsB;QACnC,MAAM;KACP,CAAC,CAAC;IAEH,OAAO,IAAA,sBAAa,EAAC;QACnB,UAAU,EAAE,CAAC,MAAM,CAAC;QACpB,KAAK,EAAE,CAAC,eAAe,CAAC;QACxB,kBAAkB,EAAE;YAClB,kBAAkB,EAAE,EAAE,eAAe,EAAE,wBAAe,CAAC,GAAG,EAAE;SAC7D;KACF,CAAC,CAAC;AACL,CAAC;AA5BD,wDA4BC"}

package/dist/api/config/generate-resolvers.d.ts

@@ -0,0 +1,211 @@
+import { GraphQLSchema } from "graphql";
+import { ErrorResult } from "../../common/error/generated-graphql-admin-errors";
+import { ConfigService } from "../../config/config.service";
+import { Region } from "../../entity/region/region.entity";
+import { CustomFieldRelationResolverService } from "../common/custom-field-relation-resolver.service";
+import { ApiType } from "../common/get-api-type";
+/**
+ * @description
+ * Generates additional resolvers required for things like resolution of union types,
+ * custom scalars and "relation"-type custom fields.
+ */
+export declare function generateResolvers(configService: ConfigService, customFieldRelationResolverService: CustomFieldRelationResolverService, apiType: ApiType, schema: GraphQLSchema): Promise<{
+    AddFulfillmentToOrderResult: {
+        __resolveType(value: any): any;
+    };
+    UpdateOrderItemsResult: {
+        __resolveType(value: any): any;
+    };
+    AddManualPaymentToOrderResult: {
+        __resolveType(value: any): any;
+    };
+    ApplyCouponCodeResult: {
+        __resolveType(value: any): any;
+    };
+    AuthenticationResult: {
+        __resolveType(value: any): any;
+    };
+    CancelOrderResult: {
+        __resolveType(value: any): any;
+    };
+    CancelPaymentResult: {
+        __resolveType(value: any): any;
+    };
+    CreateAssetResult: {
+        __resolveType(value: any): any;
+    };
+    CreateChannelResult: {
+        __resolveType(value: any): any;
+    };
+    CreateCustomerResult: {
+        __resolveType(value: any): any;
+    };
+    CreatePromotionResult: {
+        __resolveType(value: any): any;
+    };
+    DuplicateEntityResult: {
+        __resolveType(value: any): any;
+    };
+    NativeAuthenticationResult: {
+        __resolveType(value: any): any;
+    };
+    ModifyOrderResult: {
+        __resolveType(value: any): any;
+    };
+    RefundOrderResult: {
+        __resolveType(value: any): any;
+    };
+    RemoveOrderItemsResult: {
+        __resolveType(value: any): any;
+    };
+    RemoveFacetFromChannelResult: {
+        __resolveType(value: any): any;
+    };
+    RemoveOptionGroupFromProductResult: {
+        __resolveType(value: any): any;
+    };
+    SetCustomerForDraftOrderResult: {
+        __resolveType(value: any): any;
+    };
+    SetOrderShippingMethodResult: {
+        __resolveType(value: any): any;
+    };
+    SettlePaymentResult: {
+        __resolveType(value: any): any;
+    };
+    SettleRefundResult: {
+        __resolveType(value: any): any;
+    };
+    TransitionFulfillmentToStateResult: {
+        __resolveType(value: any): any;
+    };
+    TransitionOrderToStateResult: {
+        __resolveType(value: any): any;
+    };
+    TransitionPaymentToStateResult: {
+        __resolveType(value: any): any;
+    };
+    UpdateChannelResult: {
+        __resolveType(value: any): any;
+    };
+    UpdateCustomerResult: {
+        __resolveType(value: any): any;
+    };
+    UpdateGlobalSettingsResult: {
+        __resolveType(value: any): any;
+    };
+    UpdatePromotionResult: {
+        __resolveType(value: any): any;
+    };
+    StockMovementItem: {
+        __resolveType(value: any): "StockAdjustment" | "Allocation" | "Sale" | "Cancellation" | "Return" | "Release" | undefined;
+    };
+    StockMovement: {
+        __resolveType(value: any): "StockAdjustment" | "Allocation" | "Sale" | "Cancellation" | "Return" | "Release" | undefined;
+    };
+    JSON: import("graphql").GraphQLScalarType<any, any>;
+    DateTime: import("graphql").GraphQLScalarType<Date, Date>;
+    Money: import("graphql").GraphQLScalarType<number, number>;
+    Node: {
+        __resolveType(): null;
+    };
+    PaginatedList: {
+        __resolveType(): null;
+    };
+    Upload: import("graphql").GraphQLScalarType<Promise<import("graphql-upload/processRequest.mjs", { with: { "resolution-mode": "import" } }).FileUpload>, never>;
+    SearchResultPrice: {
+        __resolveType(value: any): "SinglePrice" | "PriceRange";
+    };
+    CustomFieldConfig: {
+        __resolveType(value: any): "TextCustomFieldConfig" | "RelationCustomFieldConfig" | "LocaleTextCustomFieldConfig" | "BooleanCustomFieldConfig" | "StringCustomFieldConfig" | "LocaleStringCustomFieldConfig" | "IntCustomFieldConfig" | "FloatCustomFieldConfig" | "DateTimeCustomFieldConfig" | undefined;
+    };
+    CustomField: {
+        __resolveType(value: any): "TextCustomFieldConfig" | "RelationCustomFieldConfig" | "LocaleTextCustomFieldConfig" | "BooleanCustomFieldConfig" | "StringCustomFieldConfig" | "LocaleStringCustomFieldConfig" | "IntCustomFieldConfig" | "FloatCustomFieldConfig" | "DateTimeCustomFieldConfig" | undefined;
+    };
+    ErrorResult: {
+        __resolveType(value: ErrorResult): string;
+    };
+    Region: {
+        __resolveType(value: Region): "Country" | "Province";
+    };
+} | {
+    UpdateOrderItemsResult: {
+        __resolveType(value: any): any;
+    };
+    AddPaymentToOrderResult: {
+        __resolveType(value: any): any;
+    };
+    ApplyCouponCodeResult: {
+        __resolveType(value: any): any;
+    };
+    AuthenticationResult: {
+        __resolveType(value: any): any;
+    };
+    NativeAuthenticationResult: {
+        __resolveType(value: any): any;
+    };
+    RefreshCustomerVerificationResult: {
+        __resolveType(value: any): any;
+    };
+    RegisterCustomerAccountResult: {
+        __resolveType(value: any): any;
+    };
+    RemoveOrderItemsResult: {
+        __resolveType(value: any): any;
+    };
+    RequestPasswordResetResult: {
+        __resolveType(value: any): any;
+    };
+    RequestUpdateCustomerEmailAddressResult: {
+        __resolveType(value: any): any;
+    };
+    ResetPasswordResult: {
+        __resolveType(value: any): any;
+    };
+    SetCustomerForOrderResult: {
+        __resolveType(value: any): any;
+    };
+    ActiveOrderResult: {
+        __resolveType(value: any): any;
+    };
+    SetOrderShippingMethodResult: {
+        __resolveType(value: any): any;
+    };
+    TransitionOrderToStateResult: {
+        __resolveType(value: any): any;
+    };
+    UpdateCustomerEmailAddressResult: {
+        __resolveType(value: any): any;
+    };
+    UpdateCustomerPasswordResult: {
+        __resolveType(value: any): any;
+    };
+    VerifyCustomerAccountResult: {
+        __resolveType(value: any): any;
+    };
+    JSON: import("graphql").GraphQLScalarType<any, any>;
+    DateTime: import("graphql").GraphQLScalarType<Date, Date>;
+    Money: import("graphql").GraphQLScalarType<number, number>;
+    Node: {
+        __resolveType(): null;
+    };
+    PaginatedList: {
+        __resolveType(): null;
+    };
+    Upload: import("graphql").GraphQLScalarType<Promise<import("graphql-upload/processRequest.mjs", { with: { "resolution-mode": "import" } }).FileUpload>, never>;
+    SearchResultPrice: {
+        __resolveType(value: any): "SinglePrice" | "PriceRange";
+    };
+    CustomFieldConfig: {
+        __resolveType(value: any): "TextCustomFieldConfig" | "RelationCustomFieldConfig" | "LocaleTextCustomFieldConfig" | "BooleanCustomFieldConfig" | "StringCustomFieldConfig" | "LocaleStringCustomFieldConfig" | "IntCustomFieldConfig" | "FloatCustomFieldConfig" | "DateTimeCustomFieldConfig" | undefined;
+    };
+    CustomField: {
+        __resolveType(value: any): "TextCustomFieldConfig" | "RelationCustomFieldConfig" | "LocaleTextCustomFieldConfig" | "BooleanCustomFieldConfig" | "StringCustomFieldConfig" | "LocaleStringCustomFieldConfig" | "IntCustomFieldConfig" | "FloatCustomFieldConfig" | "DateTimeCustomFieldConfig" | undefined;
+    };
+    ErrorResult: {
+        __resolveType(value: ErrorResult): string;
+    };
+    Region: {
+        __resolveType(value: Region): "Country" | "Province";
+    };
+}>;