@deenruv/core 1.0.0

package/dist/api/decorators/allow.decorator.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Allow = exports.PERMISSIONS_METADATA_KEY = void 0;
+const common_1 = require("@nestjs/common");
+exports.PERMISSIONS_METADATA_KEY = "__permissions__";
+/**
+ * @description
+ * Attaches metadata to the resolver defining which permissions are required to execute the
+ * operation, using one or more {@link Permission} values.
+ *
+ * In a GraphQL context, it can be applied to top-level queries and mutations as well as field resolvers.
+ *
+ * For REST controllers, it can be applied to route handler.
+ *
+ * ## Allow and Sessions
+ * The `@Allow()` decorator is closely linked to the way Deenruv manages sessions. For any operation or route that is decorated
+ * with `@Allow()`, there must be an authenticated session in progress, which would have been created during a prior authentication
+ * step.
+ *
+ * The exception to this is when the operation is decorated with `@Allow(Permission.Owner)`. This is a special permission which is designed
+ * to give access to certain resources to potentially un-authenticated users. For this reason, any operation decorated with this permission
+ * will always have an anonymous session created if no session is currently in progress.
+ *
+ * For more information see [Understanding Permission.Owner](/reference/typescript-api/common/permission/#understanding-permissionowner).
+ *
+ * @example
+ * ```ts
+ *  \@Allow(Permission.SuperAdmin)
+ *  \@Query()
+ *  getAdministrators() {
+ *      // ...
+ *  }
+ * ```
+ *
+ * @docsCategory request
+ * @docsPage Allow Decorator
+ */
+const Allow = (...permissions) => (0, common_1.SetMetadata)(exports.PERMISSIONS_METADATA_KEY, permissions);
+exports.Allow = Allow;
+//# sourceMappingURL=allow.decorator.js.map

package/dist/api/decorators/allow.decorator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"allow.decorator.js","sourceRoot":"","sources":["../../../src/api/decorators/allow.decorator.ts"],"names":[],"mappings":";;;AAAA,2CAA6C;AAGhC,QAAA,wBAAwB,GAAG,iBAAiB,CAAC;AAE1D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACI,MAAM,KAAK,GAAG,CAAC,GAAG,WAAyB,EAAE,EAAE,CACpD,IAAA,oBAAW,EAAC,gCAAwB,EAAE,WAAW,CAAC,CAAC;AADxC,QAAA,KAAK,SACmC"}

package/dist/api/decorators/api.decorator.d.ts

@@ -0,0 +1,21 @@
+/**
+ * @description
+ * Resolver param decorator which returns which Api the request came though.
+ * This is useful because sometimes the same resolver will have different behaviour
+ * depending whether it is being called from the shop API or the admin API.
+ *
+ * Returns a string of type {@link ApiType}.
+ *
+ * @example
+ * ```ts
+ *  \@Query()
+ *  getAdministrators(\@Api() apiType: ApiType) {
+ *    if (apiType === 'admin') {
+ *      // ...
+ *    }
+ *  }
+ * ```
+ * @docsCategory request
+ * @docsPage Api Decorator
+ */
+export declare const Api: (...dataOrPipes: any[]) => ParameterDecorator;

package/dist/api/decorators/api.decorator.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Api = void 0;
+const common_1 = require("@nestjs/common");
+const get_api_type_1 = require("../common/get-api-type");
+/**
+ * @description
+ * Resolver param decorator which returns which Api the request came though.
+ * This is useful because sometimes the same resolver will have different behaviour
+ * depending whether it is being called from the shop API or the admin API.
+ *
+ * Returns a string of type {@link ApiType}.
+ *
+ * @example
+ * ```ts
+ *  \@Query()
+ *  getAdministrators(\@Api() apiType: ApiType) {
+ *    if (apiType === 'admin') {
+ *      // ...
+ *    }
+ *  }
+ * ```
+ * @docsCategory request
+ * @docsPage Api Decorator
+ */
+exports.Api = (0, common_1.createParamDecorator)((data, ctx) => {
+    const info = ctx.getArgByIndex(3);
+    return (0, get_api_type_1.getApiType)(info);
+});
+//# sourceMappingURL=api.decorator.js.map

package/dist/api/decorators/api.decorator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api.decorator.js","sourceRoot":"","sources":["../../../src/api/decorators/api.decorator.ts"],"names":[],"mappings":";;;AAAA,2CAAwE;AAGxE,yDAAoD;AAEpD;;;;;;;;;;;;;;;;;;;GAmBG;AACU,QAAA,GAAG,GAAG,IAAA,6BAAoB,EAAC,CAAC,IAAI,EAAE,GAAqB,EAAE,EAAE;IACtE,MAAM,IAAI,GAAG,GAAG,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;IAClC,OAAO,IAAA,yBAAU,EAAC,IAAI,CAAC,CAAC;AAC1B,CAAC,CAAC,CAAC"}

package/dist/api/decorators/relations.decorator.d.ts

@@ -0,0 +1,116 @@
+import { Type } from "@deenruv/common/lib/shared-types";
+import { EntityRelationPaths } from "../../common/types/entity-relation-paths";
+import { DeenruvEntity } from "../../entity/base/base.entity";
+export type RelationPaths<T extends DeenruvEntity> = Array<EntityRelationPaths<T>>;
+export type FieldsDecoratorConfig<T extends DeenruvEntity> = Type<T> | {
+    entity: Type<T>;
+    depth?: number;
+    omit?: RelationPaths<T>;
+};
+/**
+ * @description
+ * Resolver param decorator which returns an array of relation paths which can be passed through
+ * to the TypeORM data layer in order to join only the required relations. This works by inspecting
+ * the GraphQL `info` object, examining the field selection, and then comparing this with information
+ * about the return type's relations.
+ *
+ * In addition to analyzing the field selection, this decorator also checks for any `@Calculated()`
+ * properties on the entity, and additionally includes relations from the `relations` array of the calculated
+ * metadata, if defined.
+ *
+ * So if, for example, the query only selects the `id` field of an Order, then no other relations need
+ * be joined in the resulting SQL query. This can massively speed up execution time for queries which do
+ * not include many deep nested relations.
+ *
+ * @example
+ * ```ts
+ * \@Query()
+ * \@Allow(Permission.ReadOrder)
+ * orders(
+ *     \@Ctx() ctx: RequestContext,
+ *     \@Args() args: QueryOrdersArgs,
+ *     \@Relations(Order) relations: RelationPaths<Order>,
+ * ): Promise<PaginatedList<Order>> {
+ *     return this.orderService.findAll(ctx, args.options || undefined, relations);
+ * }
+ * ```
+ *
+ * In the above example, given the following query:
+ *
+ * @example
+ * ```GraphQL
+ * {
+ *   orders(options: { take: 10 }) {
+ *     items {
+ *       id
+ *       customer {
+ *         id
+ *         firstName
+ *         lastName
+ *       }
+ *       totalQuantity
+ *       totalWithTax
+ *     }
+ *   }
+ * }
+ * ```
+ * then the value of `relations` will be
+ *
+ * ```
+ * ['customer', 'lines'']
+ * ```
+ * The `'customer'` comes from the fact that the query is nesting the "customer" object, and the `'lines'` is taken
+ * from the `Order` entity's `totalQuantity` property, which uses {@link Calculated} decorator and defines those relations as dependencies
+ * for deriving the calculated value.
+ *
+ * ## Depth
+ *
+ * By default, when inspecting the GraphQL query, the Relations decorator will look 3 levels deep in any nested fields. So, e.g. if
+ * the above `orders` query were changed to:
+ *
+ * @example
+ * ```GraphQL
+ * {
+ *   orders(options: { take: 10 }) {
+ *     items {
+ *       id
+ *       lines {
+ *         productVariant {
+ *           product {
+ *             featuredAsset {
+ *               preview
+ *             }
+ *           }
+ *         }
+ *       }
+ *     }
+ *   }
+ * }
+ * ```
+ * then the `relations` array would include `'lines'`, `'lines.productVariant'`, & `'lines.productVariant.product'` - 3 levels deep - but it would
+ * _not_ include `'lines.productVariant.product.featuredAsset'` since that exceeds the default depth. To specify a custom depth, you would
+ * use the decorator like this:
+ *
+ * @example
+ * ```ts
+ * \@Relations({ entity: Order, depth: 2 }) relations: RelationPaths<Order>,
+ * ```
+ *
+ * ## Omit
+ *
+ * The `omit` option is used to explicitly omit certain relations from the calculated relations array. This is useful in certain
+ * cases where we know for sure that we need to run the field resolver _anyway_. A good example is the `Collection.productVariants` relation.
+ * When a GraphQL query comes in for a Collection and also requests its `productVariants` field, there is no point using a lookahead to eagerly
+ * join that relation, because we will throw that data away anyway when the `productVariants` field resolver executes, since it returns a
+ * PaginatedList query rather than a simple array.
+ *
+ * @example
+ * ```ts
+ * \@Relations({ entity: Collection, omit: ['productVariant'] }) relations: RelationPaths<Collection>,
+ * ```
+ *
+ * @docsCategory request
+ * @docsPage Relations Decorator
+ * @since 1.6.0
+ */
+export declare const Relations: <T extends DeenruvEntity>(data: FieldsDecoratorConfig<T>) => ParameterDecorator;

package/dist/api/decorators/relations.decorator.js

@@ -0,0 +1,214 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Relations = void 0;
+const common_1 = require("@nestjs/common");
+const unique_1 = require("@deenruv/common/lib/unique");
+const graphql_1 = require("graphql");
+const typeorm_1 = require("typeorm");
+const calculated_decorator_1 = require("../../common/calculated-decorator");
+const errors_1 = require("../../common/error/errors");
+const ttl_cache_1 = require("../../common/ttl-cache");
+const graphqlFields = require("graphql-fields");
+const DEFAULT_DEPTH = 3;
+const cache = new ttl_cache_1.TtlCache({ cacheSize: 500, ttl: 5 * 60 * 1000 });
+/**
+ * @description
+ * Resolver param decorator which returns an array of relation paths which can be passed through
+ * to the TypeORM data layer in order to join only the required relations. This works by inspecting
+ * the GraphQL `info` object, examining the field selection, and then comparing this with information
+ * about the return type's relations.
+ *
+ * In addition to analyzing the field selection, this decorator also checks for any `@Calculated()`
+ * properties on the entity, and additionally includes relations from the `relations` array of the calculated
+ * metadata, if defined.
+ *
+ * So if, for example, the query only selects the `id` field of an Order, then no other relations need
+ * be joined in the resulting SQL query. This can massively speed up execution time for queries which do
+ * not include many deep nested relations.
+ *
+ * @example
+ * ```ts
+ * \@Query()
+ * \@Allow(Permission.ReadOrder)
+ * orders(
+ *     \@Ctx() ctx: RequestContext,
+ *     \@Args() args: QueryOrdersArgs,
+ *     \@Relations(Order) relations: RelationPaths<Order>,
+ * ): Promise<PaginatedList<Order>> {
+ *     return this.orderService.findAll(ctx, args.options || undefined, relations);
+ * }
+ * ```
+ *
+ * In the above example, given the following query:
+ *
+ * @example
+ * ```GraphQL
+ * {
+ *   orders(options: { take: 10 }) {
+ *     items {
+ *       id
+ *       customer {
+ *         id
+ *         firstName
+ *         lastName
+ *       }
+ *       totalQuantity
+ *       totalWithTax
+ *     }
+ *   }
+ * }
+ * ```
+ * then the value of `relations` will be
+ *
+ * ```
+ * ['customer', 'lines'']
+ * ```
+ * The `'customer'` comes from the fact that the query is nesting the "customer" object, and the `'lines'` is taken
+ * from the `Order` entity's `totalQuantity` property, which uses {@link Calculated} decorator and defines those relations as dependencies
+ * for deriving the calculated value.
+ *
+ * ## Depth
+ *
+ * By default, when inspecting the GraphQL query, the Relations decorator will look 3 levels deep in any nested fields. So, e.g. if
+ * the above `orders` query were changed to:
+ *
+ * @example
+ * ```GraphQL
+ * {
+ *   orders(options: { take: 10 }) {
+ *     items {
+ *       id
+ *       lines {
+ *         productVariant {
+ *           product {
+ *             featuredAsset {
+ *               preview
+ *             }
+ *           }
+ *         }
+ *       }
+ *     }
+ *   }
+ * }
+ * ```
+ * then the `relations` array would include `'lines'`, `'lines.productVariant'`, & `'lines.productVariant.product'` - 3 levels deep - but it would
+ * _not_ include `'lines.productVariant.product.featuredAsset'` since that exceeds the default depth. To specify a custom depth, you would
+ * use the decorator like this:
+ *
+ * @example
+ * ```ts
+ * \@Relations({ entity: Order, depth: 2 }) relations: RelationPaths<Order>,
+ * ```
+ *
+ * ## Omit
+ *
+ * The `omit` option is used to explicitly omit certain relations from the calculated relations array. This is useful in certain
+ * cases where we know for sure that we need to run the field resolver _anyway_. A good example is the `Collection.productVariants` relation.
+ * When a GraphQL query comes in for a Collection and also requests its `productVariants` field, there is no point using a lookahead to eagerly
+ * join that relation, because we will throw that data away anyway when the `productVariants` field resolver executes, since it returns a
+ * PaginatedList query rather than a simple array.
+ *
+ * @example
+ * ```ts
+ * \@Relations({ entity: Collection, omit: ['productVariant'] }) relations: RelationPaths<Collection>,
+ * ```
+ *
+ * @docsCategory request
+ * @docsPage Relations Decorator
+ * @since 1.6.0
+ */
+exports.Relations = (0, common_1.createParamDecorator)((data, ctx) => {
+    var _a, _b, _c;
+    const info = ctx.getArgByIndex(3);
+    if (data == null) {
+        throw new errors_1.InternalServerError("The @Relations() decorator requires an entity type argument");
+    }
+    if (!isGraphQLResolveInfo(info)) {
+        return [];
+    }
+    const cacheKey = info.fieldName + "__" + ctx.getArgByIndex(2).req.body.query;
+    const cachedResult = cache.get(cacheKey);
+    if (cachedResult) {
+        return cachedResult;
+    }
+    const fields = graphqlFields(info);
+    const targetFields = isPaginatedListQuery(info)
+        ? ((_a = fields.items) !== null && _a !== void 0 ? _a : {})
+        : fields;
+    const entity = typeof data === "function" ? data : data.entity;
+    const maxDepth = typeof data === "function"
+        ? DEFAULT_DEPTH
+        : ((_b = data.depth) !== null && _b !== void 0 ? _b : DEFAULT_DEPTH);
+    const omit = typeof data === "function" ? [] : ((_c = data.omit) !== null && _c !== void 0 ? _c : []);
+    const relationFields = getRelationPaths(targetFields, entity, maxDepth);
+    let result = (0, unique_1.unique)(relationFields);
+    for (const omitPath of omit) {
+        result = result.filter((resultPath) => !resultPath.startsWith(omitPath));
+    }
+    cache.set(cacheKey, result);
+    return result;
+});
+function getRelationPaths(fields, entity, maxDepth, depth = 1) {
+    var _a, _b;
+    const relations = (0, typeorm_1.getMetadataArgsStorage)().filterRelations(entity);
+    const metadata = (0, typeorm_1.getMetadataArgsStorage)();
+    const relationPaths = [];
+    for (const [property, value] of Object.entries(fields)) {
+        if (property === "customFields") {
+            const customFieldEntity = (_a = metadata
+                .filterEmbeddeds(entity)
+                .find((e) => e.propertyName === "customFields")) === null || _a === void 0 ? void 0 : _a.type();
+            if (customFieldEntity) {
+                if (depth < maxDepth) {
+                    depth++;
+                    const subPaths = getRelationPaths(value, customFieldEntity, maxDepth, depth);
+                    depth--;
+                    for (const subPath of subPaths) {
+                        relationPaths.push([property, subPath].join("."));
+                    }
+                }
+            }
+        }
+        else {
+            const relationMetadata = relations.find((r) => r.propertyName === property);
+            if (relationMetadata) {
+                relationPaths.push(property);
+                const relatedEntity = typeof relationMetadata.type === "function"
+                    ? // https://github.com/microsoft/TypeScript/issues/37663
+                        relationMetadata.type()
+                    : relationMetadata.type;
+                if (depth < maxDepth) {
+                    depth++;
+                    const subPaths = getRelationPaths(value, relatedEntity, maxDepth, depth);
+                    depth--;
+                    for (const subPath of subPaths) {
+                        relationPaths.push([property, subPath].join("."));
+                    }
+                }
+            }
+            const calculatedProperties = (_b = Object.getPrototypeOf(new entity())[calculated_decorator_1.CALCULATED_PROPERTIES]) !== null && _b !== void 0 ? _b : [];
+            const selectedFields = new Set(Object.keys(fields));
+            const dependencyRelations = calculatedProperties
+                .filter((p) => {
+                var _a, _b;
+                return selectedFields.has(p.name) &&
+                    ((_b = (_a = p.listQuery) === null || _a === void 0 ? void 0 : _a.relations) === null || _b === void 0 ? void 0 : _b.length);
+            })
+                .map((p) => { var _a, _b; return (_b = (_a = p.listQuery) === null || _a === void 0 ? void 0 : _a.relations) !== null && _b !== void 0 ? _b : []; })
+                .flat();
+            relationPaths.push(...dependencyRelations);
+        }
+    }
+    return relationPaths;
+}
+function isGraphQLResolveInfo(input) {
+    return !!(input &&
+        typeof input === "object" &&
+        input.schema instanceof graphql_1.GraphQLSchema);
+}
+function isPaginatedListQuery(info) {
+    const returnType = (0, graphql_1.getNamedType)(info.returnType);
+    return ((0, graphql_1.isObjectType)(returnType) &&
+        !!returnType.getInterfaces().find((i) => i.name === "PaginatedList"));
+}
+//# sourceMappingURL=relations.decorator.js.map

package/dist/api/decorators/relations.decorator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"relations.decorator.js","sourceRoot":"","sources":["../../../src/api/decorators/relations.decorator.ts"],"names":[],"mappings":";;;AAAA,2CAAwE;AAExE,uDAAoD;AACpD,qCAKiB;AACjB,qCAAiD;AAEjD,4EAG2C;AAC3C,sDAAgE;AAChE,sDAAkD;AAIlD,MAAM,aAAa,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC;AAchD,MAAM,aAAa,GAAG,CAAC,CAAC;AAExB,MAAM,KAAK,GAAG,IAAI,oBAAQ,CAAC,EAAE,SAAS,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,GAAG,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC;AAEnE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyGG;AACU,QAAA,SAAS,GAEI,IAAA,6BAAoB,EAC5C,CAAC,IAAI,EAAE,GAAqB,EAAE,EAAE;;IAC9B,MAAM,IAAI,GAAG,GAAG,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;IAClC,IAAI,IAAI,IAAI,IAAI,EAAE,CAAC;QACjB,MAAM,IAAI,4BAAmB,CAC3B,6DAA6D,CAC9D,CAAC;IACJ,CAAC;IACD,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,EAAE,CAAC;QAChC,OAAO,EAAE,CAAC;IACZ,CAAC;IACD,MAAM,QAAQ,GACZ,IAAI,CAAC,SAAS,GAAG,IAAI,GAAI,GAAG,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,KAAgB,CAAC;IAC1E,MAAM,YAAY,GAAG,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IACzC,IAAI,YAAY,EAAE,CAAC;QACjB,OAAO,YAAY,CAAC;IACtB,CAAC;IACD,MAAM,MAAM,GAAG,aAAa,CAAC,IAAI,CAAC,CAAC;IACnC,MAAM,YAAY,GAAG,oBAAoB,CAAC,IAAI,CAAC;QAC7C,CAAC,CAAC,CAAC,MAAA,MAAM,CAAC,KAAK,mCAAI,EAAE,CAAC;QACtB,CAAC,CAAC,MAAM,CAAC;IACX,MAAM,MAAM,GAAG,OAAO,IAAI,KAAK,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC;IAC/D,MAAM,QAAQ,GACZ,OAAO,IAAI,KAAK,UAAU;QACxB,CAAC,CAAC,aAAa;QACf,CAAC,CAAC,CAAC,MAAA,IAAI,CAAC,KAAK,mCAAI,aAAa,CAAC,CAAC;IACpC,MAAM,IAAI,GAAG,OAAO,IAAI,KAAK,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,MAAA,IAAI,CAAC,IAAI,mCAAI,EAAE,CAAC,CAAC;IACjE,MAAM,cAAc,GAAG,gBAAgB,CAAC,YAAY,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;IACxE,IAAI,MAAM,GAAG,IAAA,eAAM,EAAC,cAAc,CAAC,CAAC;IACpC,KAAK,MAAM,QAAQ,IAAI,IAAI,EAAE,CAAC;QAC5B,MAAM,GAAG,MAAM,CAAC,MAAM,CACpB,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC,UAAU,CAAC,UAAU,CAAC,QAAkB,CAAC,CAC3D,CAAC;IACJ,CAAC;IACD,KAAK,CAAC,GAAG,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IAC5B,OAAO,MAAM,CAAC;AAChB,CAAC,CACF,CAAC;AAEF,SAAS,gBAAgB,CACvB,MAA2C,EAC3C,MAA2B,EAC3B,QAAgB,EAChB,KAAK,GAAG,CAAC;;IAET,MAAM,SAAS,GAAG,IAAA,gCAAsB,GAAE,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;IACnE,MAAM,QAAQ,GAAG,IAAA,gCAAsB,GAAE,CAAC;IAC1C,MAAM,aAAa,GAAa,EAAE,CAAC;IACnC,KAAK,MAAM,CAAC,QAAQ,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QACvD,IAAI,QAAQ,KAAK,cAAc,EAAE,CAAC;YAChC,MAAM,iBAAiB,GAAG,MAAA,QAAQ;iBAC/B,eAAe,CAAC,MAAM,CAAC;iBACvB,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,YAAY,KAAK,cAAc,CAAC,0CAC7C,IAAI,EAAE,CAAC;YACX,IAAI,iBAAiB,EAAE,CAAC;gBACtB,IAAI,KAAK,GAAG,QAAQ,EAAE,CAAC;oBACrB,KAAK,EAAE,CAAC;oBACR,MAAM,QAAQ,GAAG,gBAAgB,CAC/B,KAAK,EACL,iBAAwC,EACxC,QAAQ,EACR,KAAK,CACN,CAAC;oBACF,KAAK,EAAE,CAAC;oBACR,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;wBAC/B,aAAa,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;oBACpD,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;aAAM,CAAC;YACN,MAAM,gBAAgB,GAAG,SAAS,CAAC,IAAI,CACrC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,YAAY,KAAK,QAAQ,CACnC,CAAC;YACF,IAAI,gBAAgB,EAAE,CAAC;gBACrB,aAAa,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;gBAC7B,MAAM,aAAa,GACjB,OAAO,gBAAgB,CAAC,IAAI,KAAK,UAAU;oBACzC,CAAC,CAAC,uDAAuD;wBACtD,gBAAgB,CAAC,IAAY,EAAE;oBAClC,CAAC,CAAC,gBAAgB,CAAC,IAAI,CAAC;gBAC5B,IAAI,KAAK,GAAG,QAAQ,EAAE,CAAC;oBACrB,KAAK,EAAE,CAAC;oBACR,MAAM,QAAQ,GAAG,gBAAgB,CAC/B,KAAK,EACL,aAAoC,EACpC,QAAQ,EACR,KAAK,CACN,CAAC;oBACF,KAAK,EAAE,CAAC;oBACR,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;wBAC/B,aAAa,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;oBACpD,CAAC;gBACH,CAAC;YACH,CAAC;YACD,MAAM,oBAAoB,GACxB,MAAA,MAAM,CAAC,cAAc,CAAC,IAAI,MAAM,EAAE,CAAC,CAAC,4CAAqB,CAAC,mCAAI,EAAE,CAAC;YACnE,MAAM,cAAc,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;YACpD,MAAM,mBAAmB,GAAG,oBAAoB;iBAC7C,MAAM,CACL,CAAC,CAAC,EAAE,EAAE;;gBACJ,OAAA,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC,IAAc,CAAC;qBACpC,MAAA,MAAA,CAAC,CAAC,SAAS,0CAAE,SAAS,0CAAE,MAAM,CAAA,CAAA;aAAA,CACjC;iBACA,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,eAAC,OAAA,MAAA,MAAA,CAAC,CAAC,SAAS,0CAAE,SAAS,mCAAI,EAAE,CAAA,EAAA,CAAC;iBACxC,IAAI,EAAE,CAAC;YACV,aAAa,CAAC,IAAI,CAAC,GAAG,mBAAmB,CAAC,CAAC;QAC7C,CAAC;IACH,CAAC;IACD,OAAO,aAAa,CAAC;AACvB,CAAC;AAED,SAAS,oBAAoB,CAAC,KAAc;IAC1C,OAAO,CAAC,CAAC,CACP,KAAK;QACL,OAAO,KAAK,KAAK,QAAQ;QACxB,KAAa,CAAC,MAAM,YAAY,uBAAa,CAC/C,CAAC;AACJ,CAAC;AAED,SAAS,oBAAoB,CAAC,IAAwB;IACpD,MAAM,UAAU,GAAG,IAAA,sBAAY,EAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IACjD,OAAO,CACL,IAAA,sBAAY,EAAC,UAAU,CAAC;QACxB,CAAC,CAAC,UAAU,CAAC,aAAa,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,eAAe,CAAC,CACrE,CAAC;AACJ,CAAC"}

package/dist/api/decorators/request-context.decorator.d.ts

@@ -0,0 +1,17 @@
+/**
+ * @description
+ * Resolver param decorator which extracts the {@link RequestContext} from the incoming
+ * request object.
+ *
+ * @example
+ * ```ts
+ *  \@Query()
+ *  getAdministrators(\@Ctx() ctx: RequestContext) {
+ *      // ...
+ *  }
+ * ```
+ *
+ * @docsCategory request
+ * @docsPage Ctx Decorator
+ */
+export declare const Ctx: (...dataOrPipes: any[]) => ParameterDecorator;

package/dist/api/decorators/request-context.decorator.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Ctx = void 0;
+const common_1 = require("@nestjs/common");
+const constants_1 = require("../../common/constants");
+/**
+ * @description
+ * Resolver param decorator which extracts the {@link RequestContext} from the incoming
+ * request object.
+ *
+ * @example
+ * ```ts
+ *  \@Query()
+ *  getAdministrators(\@Ctx() ctx: RequestContext) {
+ *      // ...
+ *  }
+ * ```
+ *
+ * @docsCategory request
+ * @docsPage Ctx Decorator
+ */
+exports.Ctx = (0, common_1.createParamDecorator)((data, ctx) => {
+    const getContext = (req) => {
+        const map = req[constants_1.REQUEST_CONTEXT_MAP_KEY];
+        // If a map contains associated transactional context with this handler
+        // we have to use it. It means that this handler was wrapped with @Transaction decorator.
+        // Otherwise use default context.
+        return (map === null || map === void 0 ? void 0 : map.get(ctx.getHandler())) || req[constants_1.REQUEST_CONTEXT_KEY];
+    };
+    if (ctx.getType() === "graphql") {
+        // GraphQL request
+        return getContext(ctx.getArgByIndex(2).req);
+    }
+    else {
+        // REST request
+        return getContext(ctx.switchToHttp().getRequest());
+    }
+});
+//# sourceMappingURL=request-context.decorator.js.map

package/dist/api/decorators/request-context.decorator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"request-context.decorator.js","sourceRoot":"","sources":["../../../src/api/decorators/request-context.decorator.ts"],"names":[],"mappings":";;;AAAA,2CAIwB;AAExB,sDAGgC;AAEhC;;;;;;;;;;;;;;;GAeG;AACU,QAAA,GAAG,GAAG,IAAA,6BAAoB,EAAC,CAAC,IAAI,EAAE,GAAqB,EAAE,EAAE;IACtE,MAAM,UAAU,GAAG,CAAC,GAAQ,EAAE,EAAE;QAC9B,MAAM,GAAG,GAAmC,GAAG,CAAC,mCAAuB,CAAC,CAAC;QAEzE,uEAAuE;QACvE,yFAAyF;QACzF,iCAAiC;QACjC,OAAO,CAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,GAAG,CAAC,GAAG,CAAC,UAAU,EAAE,CAAC,KAAI,GAAG,CAAC,+BAAmB,CAAC,CAAC;IAChE,CAAC,CAAC;IAEF,IAAI,GAAG,CAAC,OAAO,EAA2B,KAAK,SAAS,EAAE,CAAC;QACzD,kBAAkB;QAClB,OAAO,UAAU,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;IAC9C,CAAC;SAAM,CAAC;QACN,eAAe;QACf,OAAO,UAAU,CAAC,GAAG,CAAC,YAAY,EAAE,CAAC,UAAU,EAAE,CAAC,CAAC;IACrD,CAAC;AACH,CAAC,CAAC,CAAC"}

package/dist/api/decorators/transaction.decorator.d.ts

@@ -0,0 +1,71 @@
+export declare const TRANSACTION_MODE_METADATA_KEY = "__transaction_mode__";
+/**
+ * @description
+ * The Transaction decorator can handle transactions automatically (which is the default) or be set to
+ * "manual" mode, where the {@link TransactionalConnection} `.startTransaction()` and `.commitOpenTransaction()`
+ * methods must them be used.
+ *
+ * @example
+ * ```ts
+ * // in a GraphQL resolver file
+ *
+ * \@Transaction('manual')
+ * async myMutation(\@Ctx() ctx: RequestContext) {
+ *   await this.connection.startTransaction(ctx);
+ *   const result = this.myService.createThing(ctx);
+ *   const thing = this.myService.updateOtherThing(ctx, result.id);
+ *   await this.connection.commitOpenTransaction(ctx);
+ *   return thing;
+ * }
+ * ```
+ * Note that even in manual mode, a rollback will be automatically performed in
+ * the case that an uncaught error is thrown within the resolver.
+ *
+ * @default 'auto'
+ * @docsCategory request
+ * @docsPage Transaction Decorator
+ */
+export type TransactionMode = "auto" | "manual";
+export declare const TRANSACTION_ISOLATION_LEVEL_METADATA_KEY = "__transaction_isolation_level__";
+/**
+ * @description
+ * Transactions can be run at different isolation levels. The default is undefined, which
+ * falls back to the default of your database. See the documentation of your database for more
+ * information on available isolation levels.
+ *
+ * @default undefined
+ * @docsCategory request
+ * @docsPage Transaction Decorator
+ */
+export type TransactionIsolationLevel = "READ UNCOMMITTED" | "READ COMMITTED" | "REPEATABLE READ" | "SERIALIZABLE";
+/**
+ * @description
+ * Runs the decorated method in a TypeORM transaction. It works by creating a transactional
+ * QueryRunner which gets attached to the RequestContext object. When the RequestContext
+ * is the passed to the {@link TransactionalConnection} `getRepository()` method, this
+ * QueryRunner is used to execute the queries within this transaction.
+ *
+ * Essentially, the entire resolver function is wrapped in a try-catch block which commits the
+ * transaction on successful completion of the method, or rolls back the transaction in an unhandled
+ * error is thrown.
+ *
+ * @example
+ * ```ts
+ * // in a GraphQL resolver file
+ *
+ * \@Transaction()
+ * async myMutation(\@Ctx() ctx: RequestContext) {
+ *   // as long as the `ctx` object is passed in to
+ *   // all database operations, the entire mutation
+ *   // will be run as an atomic transaction, and rolled
+ *   // back if an error is thrown.
+ *   const result = this.myService.createThing(ctx);
+ *   return this.myService.updateOtherThing(ctx, result.id);
+ * }
+ * ```
+ *
+ * @docsCategory request
+ * @docsPage Transaction Decorator
+ * @docsWeight 0
+ */
+export declare const Transaction: (transactionMode?: TransactionMode, transactionIsolationLevel?: TransactionIsolationLevel) => <TFunction extends Function, Y>(target: object | TFunction, propertyKey?: string | symbol | undefined, descriptor?: TypedPropertyDescriptor<Y> | undefined) => void;

package/dist/api/decorators/transaction.decorator.js

@@ -0,0 +1,42 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Transaction = exports.TRANSACTION_ISOLATION_LEVEL_METADATA_KEY = exports.TRANSACTION_MODE_METADATA_KEY = void 0;
+const common_1 = require("@nestjs/common");
+const transaction_interceptor_1 = require("../middleware/transaction-interceptor");
+exports.TRANSACTION_MODE_METADATA_KEY = "__transaction_mode__";
+exports.TRANSACTION_ISOLATION_LEVEL_METADATA_KEY = "__transaction_isolation_level__";
+/**
+ * @description
+ * Runs the decorated method in a TypeORM transaction. It works by creating a transactional
+ * QueryRunner which gets attached to the RequestContext object. When the RequestContext
+ * is the passed to the {@link TransactionalConnection} `getRepository()` method, this
+ * QueryRunner is used to execute the queries within this transaction.
+ *
+ * Essentially, the entire resolver function is wrapped in a try-catch block which commits the
+ * transaction on successful completion of the method, or rolls back the transaction in an unhandled
+ * error is thrown.
+ *
+ * @example
+ * ```ts
+ * // in a GraphQL resolver file
+ *
+ * \@Transaction()
+ * async myMutation(\@Ctx() ctx: RequestContext) {
+ *   // as long as the `ctx` object is passed in to
+ *   // all database operations, the entire mutation
+ *   // will be run as an atomic transaction, and rolled
+ *   // back if an error is thrown.
+ *   const result = this.myService.createThing(ctx);
+ *   return this.myService.updateOtherThing(ctx, result.id);
+ * }
+ * ```
+ *
+ * @docsCategory request
+ * @docsPage Transaction Decorator
+ * @docsWeight 0
+ */
+const Transaction = (transactionMode = "auto", transactionIsolationLevel) => {
+    return (0, common_1.applyDecorators)((0, common_1.SetMetadata)(exports.TRANSACTION_MODE_METADATA_KEY, transactionMode), (0, common_1.SetMetadata)(exports.TRANSACTION_ISOLATION_LEVEL_METADATA_KEY, transactionIsolationLevel), (0, common_1.UseInterceptors)(transaction_interceptor_1.TransactionInterceptor));
+};
+exports.Transaction = Transaction;
+//# sourceMappingURL=transaction.decorator.js.map

package/dist/api/decorators/transaction.decorator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"transaction.decorator.js","sourceRoot":"","sources":["../../../src/api/decorators/transaction.decorator.ts"],"names":[],"mappings":";;;AAAA,2CAA+E;AAE/E,mFAA+E;AAElE,QAAA,6BAA6B,GAAG,sBAAsB,CAAC;AA6BvD,QAAA,wCAAwC,GACnD,iCAAiC,CAAC;AAiBpC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACI,MAAM,WAAW,GAAG,CACzB,kBAAmC,MAAM,EACzC,yBAAqD,EACrD,EAAE;IACF,OAAO,IAAA,wBAAe,EACpB,IAAA,oBAAW,EAAC,qCAA6B,EAAE,eAAe,CAAC,EAC3D,IAAA,oBAAW,EACT,gDAAwC,EACxC,yBAAyB,CAC1B,EACD,IAAA,wBAAe,EAAC,gDAAsB,CAAC,CACxC,CAAC;AACJ,CAAC,CAAC;AAZW,QAAA,WAAW,eAYtB"}

package/dist/api/index.d.ts

@@ -0,0 +1,12 @@
+export { ApiType } from "./common/get-api-type";
+export * from "./common/request-context";
+export * from "./common/extract-session-token";
+export * from "./decorators/allow.decorator";
+export * from "./decorators/transaction.decorator";
+export * from "./decorators/api.decorator";
+export * from "./decorators/relations.decorator";
+export * from "./decorators/request-context.decorator";
+export * from "./resolvers/admin/search.resolver";
+export * from "./middleware/auth-guard";
+export * from "./middleware/exception-logger.filter";
+export * from "./middleware/id-interceptor";

package/dist/api/index.js

@@ -0,0 +1,28 @@
+"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("./common/request-context"), exports);
+__exportStar(require("./common/extract-session-token"), exports);
+__exportStar(require("./decorators/allow.decorator"), exports);
+__exportStar(require("./decorators/transaction.decorator"), exports);
+__exportStar(require("./decorators/api.decorator"), exports);
+__exportStar(require("./decorators/relations.decorator"), exports);
+__exportStar(require("./decorators/request-context.decorator"), exports);
+__exportStar(require("./resolvers/admin/search.resolver"), exports);
+__exportStar(require("./middleware/auth-guard"), exports);
+__exportStar(require("./middleware/exception-logger.filter"), exports);
+__exportStar(require("./middleware/id-interceptor"), exports);
+//# sourceMappingURL=index.js.map

package/dist/api/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/api/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AACA,2DAAyC;AACzC,iEAA+C;AAC/C,+DAA6C;AAC7C,qEAAmD;AACnD,6DAA2C;AAC3C,mEAAiD;AACjD,yEAAuD;AACvD,oEAAkD;AAClD,0DAAwC;AACxC,uEAAqD;AACrD,8DAA4C"}