@deenruv/core 1.0.0

package/dist/service/services/administrator.service.d.ts

@@ -0,0 +1,92 @@
+import { CreateAdministratorInput, DeletionResult, UpdateAdministratorInput } from "@deenruv/common/lib/generated-types";
+import { ID, PaginatedList } from "@deenruv/common/lib/shared-types";
+import { RequestContext } from "../../api/common/request-context";
+import { RelationPaths } from "../../api/decorators/relations.decorator";
+import { ListQueryOptions } from "../../common/types/common-types";
+import { ConfigService } from "../../config";
+import { TransactionalConnection } from "../../connection/transactional-connection";
+import { Administrator } from "../../entity/administrator/administrator.entity";
+import { EventBus } from "../../event-bus";
+import { CustomFieldRelationService } from "../helpers/custom-field-relation/custom-field-relation.service";
+import { ListQueryBuilder } from "../helpers/list-query-builder/list-query-builder";
+import { PasswordCipher } from "../helpers/password-cipher/password-cipher";
+import { RequestContextService } from "../helpers/request-context/request-context.service";
+import { RoleService } from "./role.service";
+import { UserService } from "./user.service";
+/**
+ * @description
+ * Contains methods relating to {@link Administrator} entities.
+ *
+ * @docsCategory services
+ */
+export declare class AdministratorService {
+    private connection;
+    private configService;
+    private listQueryBuilder;
+    private passwordCipher;
+    private userService;
+    private roleService;
+    private customFieldRelationService;
+    private eventBus;
+    private requestContextService;
+    constructor(connection: TransactionalConnection, configService: ConfigService, listQueryBuilder: ListQueryBuilder, passwordCipher: PasswordCipher, userService: UserService, roleService: RoleService, customFieldRelationService: CustomFieldRelationService, eventBus: EventBus, requestContextService: RequestContextService);
+    /** @internal */
+    initAdministrators(): Promise<void>;
+    /**
+     * @description
+     * Get a paginated list of Administrators.
+     */
+    findAll(ctx: RequestContext, options?: ListQueryOptions<Administrator>, relations?: RelationPaths<Administrator>): Promise<PaginatedList<Administrator>>;
+    /**
+     * @description
+     * Get an Administrator by id.
+     */
+    findOne(ctx: RequestContext, administratorId: ID, relations?: RelationPaths<Administrator>): Promise<Administrator | undefined>;
+    /**
+     * @description
+     * Get an Administrator based on the User id.
+     */
+    findOneByUserId(ctx: RequestContext, userId: ID, relations?: RelationPaths<Administrator>): Promise<Administrator | undefined>;
+    /**
+     * @description
+     * Create a new Administrator.
+     */
+    create(ctx: RequestContext, input: CreateAdministratorInput): Promise<Administrator>;
+    /**
+     * @description
+     * Update an existing Administrator.
+     */
+    update(ctx: RequestContext, input: UpdateAdministratorInput): Promise<Administrator>;
+    /**
+     * @description
+     * Checks that the active user is allowed to grant the specified Roles when creating or
+     * updating an Administrator.
+     */
+    private checkActiveUserCanGrantRoles;
+    /**
+     * @description
+     * Assigns a Role to the Administrator's User entity.
+     */
+    assignRole(ctx: RequestContext, administratorId: ID, roleId: ID): Promise<Administrator>;
+    /**
+     * @description
+     * Soft deletes an Administrator (sets the `deletedAt` field).
+     */
+    softDelete(ctx: RequestContext, id: ID): Promise<{
+        result: DeletionResult;
+    }>;
+    /**
+     * @description
+     * Resolves to `true` if the administrator ID belongs to the only Administrator
+     * with SuperAdmin permissions.
+     */
+    private isSoleSuperadmin;
+    /**
+     * @description
+     * There must always exist a SuperAdmin, otherwise full administration via API will
+     * no longer be possible.
+     *
+     * @internal
+     */
+    private ensureSuperAdminExists;
+}

package/dist/service/services/administrator.service.js

@@ -0,0 +1,347 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AdministratorService = void 0;
+const common_1 = require("@nestjs/common");
+const generated_types_1 = require("@deenruv/common/lib/generated-types");
+const typeorm_1 = require("typeorm");
+const errors_1 = require("../../common/error/errors");
+const utils_1 = require("../../common/utils");
+const config_1 = require("../../config");
+const transactional_connection_1 = require("../../connection/transactional-connection");
+const administrator_entity_1 = require("../../entity/administrator/administrator.entity");
+const native_authentication_method_entity_1 = require("../../entity/authentication-method/native-authentication-method.entity");
+const role_entity_1 = require("../../entity/role/role.entity");
+const user_entity_1 = require("../../entity/user/user.entity");
+const event_bus_1 = require("../../event-bus");
+const administrator_event_1 = require("../../event-bus/events/administrator-event");
+const role_change_event_1 = require("../../event-bus/events/role-change-event");
+const custom_field_relation_service_1 = require("../helpers/custom-field-relation/custom-field-relation.service");
+const list_query_builder_1 = require("../helpers/list-query-builder/list-query-builder");
+const password_cipher_1 = require("../helpers/password-cipher/password-cipher");
+const request_context_service_1 = require("../helpers/request-context/request-context.service");
+const get_user_channels_permissions_1 = require("../helpers/utils/get-user-channels-permissions");
+const patch_entity_1 = require("../helpers/utils/patch-entity");
+const role_service_1 = require("./role.service");
+const user_service_1 = require("./user.service");
+/**
+ * @description
+ * Contains methods relating to {@link Administrator} entities.
+ *
+ * @docsCategory services
+ */
+let AdministratorService = class AdministratorService {
+    constructor(connection, configService, listQueryBuilder, passwordCipher, userService, roleService, customFieldRelationService, eventBus, requestContextService) {
+        this.connection = connection;
+        this.configService = configService;
+        this.listQueryBuilder = listQueryBuilder;
+        this.passwordCipher = passwordCipher;
+        this.userService = userService;
+        this.roleService = roleService;
+        this.customFieldRelationService = customFieldRelationService;
+        this.eventBus = eventBus;
+        this.requestContextService = requestContextService;
+    }
+    /** @internal */
+    async initAdministrators() {
+        await this.ensureSuperAdminExists();
+    }
+    /**
+     * @description
+     * Get a paginated list of Administrators.
+     */
+    findAll(ctx, options, relations) {
+        return this.listQueryBuilder
+            .build(administrator_entity_1.Administrator, options, {
+            relations: relations !== null && relations !== void 0 ? relations : ["user", "user.roles"],
+            where: { deletedAt: (0, typeorm_1.IsNull)() },
+            ctx,
+        })
+            .getManyAndCount()
+            .then(([items, totalItems]) => ({
+            items,
+            totalItems,
+        }));
+    }
+    /**
+     * @description
+     * Get an Administrator by id.
+     */
+    findOne(ctx, administratorId, relations) {
+        return this.connection
+            .getRepository(ctx, administrator_entity_1.Administrator)
+            .findOne({
+            relations: relations !== null && relations !== void 0 ? relations : ["user", "user.roles"],
+            where: {
+                id: administratorId,
+                deletedAt: (0, typeorm_1.IsNull)(),
+            },
+        })
+            .then((result) => result !== null && result !== void 0 ? result : undefined);
+    }
+    /**
+     * @description
+     * Get an Administrator based on the User id.
+     */
+    findOneByUserId(ctx, userId, relations) {
+        return this.connection
+            .getRepository(ctx, administrator_entity_1.Administrator)
+            .findOne({
+            relations,
+            where: {
+                user: { id: userId },
+                deletedAt: (0, typeorm_1.IsNull)(),
+            },
+        })
+            .then((result) => result !== null && result !== void 0 ? result : undefined);
+    }
+    /**
+     * @description
+     * Create a new Administrator.
+     */
+    async create(ctx, input) {
+        await this.checkActiveUserCanGrantRoles(ctx, input.roleIds);
+        const administrator = new administrator_entity_1.Administrator(input);
+        administrator.emailAddress = (0, utils_1.normalizeEmailAddress)(input.emailAddress);
+        administrator.user = await this.userService.createAdminUser(ctx, input.emailAddress, input.password);
+        let createdAdministrator = await this.connection
+            .getRepository(ctx, administrator_entity_1.Administrator)
+            .save(administrator);
+        for (const roleId of input.roleIds) {
+            createdAdministrator = await this.assignRole(ctx, createdAdministrator.id, roleId);
+        }
+        await this.customFieldRelationService.updateRelations(ctx, administrator_entity_1.Administrator, input, createdAdministrator);
+        await this.eventBus.publish(new administrator_event_1.AdministratorEvent(ctx, createdAdministrator, "created", input));
+        return createdAdministrator;
+    }
+    /**
+     * @description
+     * Update an existing Administrator.
+     */
+    async update(ctx, input) {
+        const administrator = await this.findOne(ctx, input.id);
+        if (!administrator) {
+            throw new errors_1.EntityNotFoundError("Administrator", input.id);
+        }
+        if (input.roleIds) {
+            await this.checkActiveUserCanGrantRoles(ctx, input.roleIds);
+        }
+        let updatedAdministrator = (0, patch_entity_1.patchEntity)(administrator, input);
+        await this.connection
+            .getRepository(ctx, administrator_entity_1.Administrator)
+            .save(administrator, { reload: false });
+        if (input.emailAddress) {
+            updatedAdministrator.user.identifier = input.emailAddress;
+            await this.connection
+                .getRepository(ctx, user_entity_1.User)
+                .save(updatedAdministrator.user);
+        }
+        if (input.password) {
+            const user = await this.userService.getUserById(ctx, administrator.user.id);
+            if (user) {
+                const nativeAuthMethod = user.getNativeAuthenticationMethod();
+                nativeAuthMethod.passwordHash = await this.passwordCipher.hash(input.password);
+                await this.connection
+                    .getRepository(ctx, native_authentication_method_entity_1.NativeAuthenticationMethod)
+                    .save(nativeAuthMethod);
+            }
+        }
+        if (input.roleIds) {
+            const isSoleSuperAdmin = await this.isSoleSuperadmin(ctx, input.id);
+            if (isSoleSuperAdmin) {
+                const superAdminRole = await this.roleService.getSuperAdminRole(ctx);
+                if (!input.roleIds.find((id) => (0, utils_1.idsAreEqual)(id, superAdminRole.id))) {
+                    throw new errors_1.InternalServerError("error.superadmin-must-have-superadmin-role");
+                }
+            }
+            const removeIds = administrator.user.roles
+                .map((role) => role.id)
+                .filter((roleId) => input.roleIds.indexOf(roleId) === -1);
+            const addIds = input.roleIds.filter((roleId) => !administrator.user.roles.some((role) => role.id === roleId));
+            administrator.user.roles = [];
+            await this.connection
+                .getRepository(ctx, user_entity_1.User)
+                .save(administrator.user, { reload: false });
+            for (const roleId of input.roleIds) {
+                updatedAdministrator = await this.assignRole(ctx, administrator.id, roleId);
+            }
+            await this.eventBus.publish(new role_change_event_1.RoleChangeEvent(ctx, administrator, addIds, "assigned"));
+            await this.eventBus.publish(new role_change_event_1.RoleChangeEvent(ctx, administrator, removeIds, "removed"));
+        }
+        await this.customFieldRelationService.updateRelations(ctx, administrator_entity_1.Administrator, input, updatedAdministrator);
+        await this.eventBus.publish(new administrator_event_1.AdministratorEvent(ctx, administrator, "updated", input));
+        return updatedAdministrator;
+    }
+    /**
+     * @description
+     * Checks that the active user is allowed to grant the specified Roles when creating or
+     * updating an Administrator.
+     */
+    async checkActiveUserCanGrantRoles(ctx, roleIds) {
+        const roles = await this.connection.getRepository(ctx, role_entity_1.Role).find({
+            where: { id: (0, typeorm_1.In)(roleIds) },
+            relations: { channels: true },
+        });
+        const permissionsRequired = (0, get_user_channels_permissions_1.getChannelPermissions)(roles);
+        for (const channelPermissions of permissionsRequired) {
+            const activeUserHasRequiredPermissions = await this.roleService.userHasAllPermissionsOnChannel(ctx, channelPermissions.id, channelPermissions.permissions);
+            if (!activeUserHasRequiredPermissions) {
+                throw new errors_1.UserInputError("error.active-user-does-not-have-sufficient-permissions");
+            }
+        }
+    }
+    /**
+     * @description
+     * Assigns a Role to the Administrator's User entity.
+     */
+    async assignRole(ctx, administratorId, roleId) {
+        const administrator = await this.findOne(ctx, administratorId);
+        if (!administrator) {
+            throw new errors_1.EntityNotFoundError("Administrator", administratorId);
+        }
+        const role = await this.roleService.findOne(ctx, roleId);
+        if (!role) {
+            throw new errors_1.EntityNotFoundError("Role", roleId);
+        }
+        administrator.user.roles.push(role);
+        await this.connection
+            .getRepository(ctx, user_entity_1.User)
+            .save(administrator.user, { reload: false });
+        return administrator;
+    }
+    /**
+     * @description
+     * Soft deletes an Administrator (sets the `deletedAt` field).
+     */
+    async softDelete(ctx, id) {
+        const administrator = await this.connection.getEntityOrThrow(ctx, administrator_entity_1.Administrator, id, {
+            relations: ["user"],
+        });
+        const isSoleSuperadmin = await this.isSoleSuperadmin(ctx, id);
+        if (isSoleSuperadmin) {
+            throw new errors_1.InternalServerError("error.cannot-delete-sole-superadmin");
+        }
+        await this.connection
+            .getRepository(ctx, administrator_entity_1.Administrator)
+            .update({ id }, { deletedAt: new Date() });
+        await this.userService.softDelete(ctx, administrator.user.id);
+        await this.eventBus.publish(new administrator_event_1.AdministratorEvent(ctx, administrator, "deleted", id));
+        return {
+            result: generated_types_1.DeletionResult.DELETED,
+        };
+    }
+    /**
+     * @description
+     * Resolves to `true` if the administrator ID belongs to the only Administrator
+     * with SuperAdmin permissions.
+     */
+    async isSoleSuperadmin(ctx, id) {
+        const superAdminRole = await this.roleService.getSuperAdminRole(ctx);
+        const allAdmins = await this.connection
+            .getRepository(ctx, administrator_entity_1.Administrator)
+            .find({
+            relations: ["user", "user.roles"],
+        });
+        const superAdmins = allAdmins.filter((admin) => !!admin.user.roles.find((r) => r.id === superAdminRole.id));
+        if (1 < superAdmins.length) {
+            return false;
+        }
+        else {
+            return (0, utils_1.idsAreEqual)(superAdmins[0].id, id);
+        }
+    }
+    /**
+     * @description
+     * There must always exist a SuperAdmin, otherwise full administration via API will
+     * no longer be possible.
+     *
+     * @internal
+     */
+    async ensureSuperAdminExists() {
+        const { superadminCredentials } = this.configService.authOptions;
+        const superAdminUser = await this.connection.rawConnection
+            .getRepository(user_entity_1.User)
+            .findOne({
+            where: {
+                identifier: superadminCredentials.identifier,
+            },
+        });
+        if (!superAdminUser) {
+            const ctx = await this.requestContextService.create({ apiType: "admin" });
+            const superAdminRole = await this.roleService.getSuperAdminRole();
+            const administrator = new administrator_entity_1.Administrator({
+                emailAddress: superadminCredentials.identifier,
+                firstName: "Super",
+                lastName: "Admin",
+            });
+            administrator.user = await this.userService.createAdminUser(ctx, superadminCredentials.identifier, superadminCredentials.password);
+            const { id } = await this.connection
+                .getRepository(ctx, administrator_entity_1.Administrator)
+                .save(administrator);
+            const createdAdministrator = await (0, utils_1.assertFound)(this.findOne(ctx, id));
+            createdAdministrator.user.roles.push(superAdminRole);
+            await this.connection
+                .getRepository(ctx, user_entity_1.User)
+                .save(createdAdministrator.user, { reload: false });
+        }
+        else {
+            const superAdministrator = await this.connection.rawConnection
+                .getRepository(administrator_entity_1.Administrator)
+                .findOne({
+                where: {
+                    user: {
+                        id: superAdminUser.id,
+                    },
+                },
+            });
+            if (!superAdministrator) {
+                const administrator = new administrator_entity_1.Administrator({
+                    emailAddress: superadminCredentials.identifier,
+                    firstName: "Super",
+                    lastName: "Admin",
+                });
+                const createdAdministrator = await this.connection.rawConnection
+                    .getRepository(administrator_entity_1.Administrator)
+                    .save(administrator);
+                createdAdministrator.user = superAdminUser;
+                await this.connection.rawConnection
+                    .getRepository(administrator_entity_1.Administrator)
+                    .save(createdAdministrator);
+            }
+            else if (superAdministrator.deletedAt != null) {
+                superAdministrator.deletedAt = null;
+                await this.connection.rawConnection
+                    .getRepository(administrator_entity_1.Administrator)
+                    .save(superAdministrator);
+            }
+            if (superAdminUser.deletedAt != null) {
+                superAdminUser.deletedAt = null;
+                await this.connection.rawConnection
+                    .getRepository(user_entity_1.User)
+                    .save(superAdminUser);
+            }
+        }
+    }
+};
+exports.AdministratorService = AdministratorService;
+exports.AdministratorService = AdministratorService = __decorate([
+    (0, common_1.Injectable)(),
+    __metadata("design:paramtypes", [transactional_connection_1.TransactionalConnection,
+        config_1.ConfigService,
+        list_query_builder_1.ListQueryBuilder,
+        password_cipher_1.PasswordCipher,
+        user_service_1.UserService,
+        role_service_1.RoleService,
+        custom_field_relation_service_1.CustomFieldRelationService,
+        event_bus_1.EventBus,
+        request_context_service_1.RequestContextService])
+], AdministratorService);
+//# sourceMappingURL=administrator.service.js.map

package/dist/service/services/administrator.service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"administrator.service.js","sourceRoot":"","sources":["../../../src/service/services/administrator.service.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,2CAA4C;AAC5C,yEAI6C;AAE7C,qCAAqC;AAIrC,sDAImC;AAEnC,8CAI4B;AAC5B,yCAA6C;AAC7C,wFAAoF;AACpF,0FAAgF;AAChF,gIAAoH;AACpH,+DAAqD;AACrD,+DAAqD;AACrD,+CAA2C;AAC3C,oFAAgF;AAChF,gFAA2E;AAC3E,kHAA4G;AAC5G,yFAAoF;AACpF,gFAA4E;AAC5E,gGAA2F;AAC3F,kGAAuF;AACvF,gEAA4D;AAE5D,iDAA6C;AAC7C,iDAA6C;AAE7C;;;;;GAKG;AAEI,IAAM,oBAAoB,GAA1B,MAAM,oBAAoB;IAC/B,YACU,UAAmC,EACnC,aAA4B,EAC5B,gBAAkC,EAClC,cAA8B,EAC9B,WAAwB,EACxB,WAAwB,EACxB,0BAAsD,EACtD,QAAkB,EAClB,qBAA4C;QAR5C,eAAU,GAAV,UAAU,CAAyB;QACnC,kBAAa,GAAb,aAAa,CAAe;QAC5B,qBAAgB,GAAhB,gBAAgB,CAAkB;QAClC,mBAAc,GAAd,cAAc,CAAgB;QAC9B,gBAAW,GAAX,WAAW,CAAa;QACxB,gBAAW,GAAX,WAAW,CAAa;QACxB,+BAA0B,GAA1B,0BAA0B,CAA4B;QACtD,aAAQ,GAAR,QAAQ,CAAU;QAClB,0BAAqB,GAArB,qBAAqB,CAAuB;IACnD,CAAC;IAEJ,gBAAgB;IAChB,KAAK,CAAC,kBAAkB;QACtB,MAAM,IAAI,CAAC,sBAAsB,EAAE,CAAC;IACtC,CAAC;IAED;;;OAGG;IACH,OAAO,CACL,GAAmB,EACnB,OAAyC,EACzC,SAAwC;QAExC,OAAO,IAAI,CAAC,gBAAgB;aACzB,KAAK,CAAC,oCAAa,EAAE,OAAO,EAAE;YAC7B,SAAS,EAAE,SAAS,aAAT,SAAS,cAAT,SAAS,GAAI,CAAC,MAAM,EAAE,YAAY,CAAC;YAC9C,KAAK,EAAE,EAAE,SAAS,EAAE,IAAA,gBAAM,GAAE,EAAE;YAC9B,GAAG;SACJ,CAAC;aACD,eAAe,EAAE;aACjB,IAAI,CAAC,CAAC,CAAC,KAAK,EAAE,UAAU,CAAC,EAAE,EAAE,CAAC,CAAC;YAC9B,KAAK;YACL,UAAU;SACX,CAAC,CAAC,CAAC;IACR,CAAC;IAED;;;OAGG;IACH,OAAO,CACL,GAAmB,EACnB,eAAmB,EACnB,SAAwC;QAExC,OAAO,IAAI,CAAC,UAAU;aACnB,aAAa,CAAC,GAAG,EAAE,oCAAa,CAAC;aACjC,OAAO,CAAC;YACP,SAAS,EAAE,SAAS,aAAT,SAAS,cAAT,SAAS,GAAI,CAAC,MAAM,EAAE,YAAY,CAAC;YAC9C,KAAK,EAAE;gBACL,EAAE,EAAE,eAAe;gBACnB,SAAS,EAAE,IAAA,gBAAM,GAAE;aACpB;SACF,CAAC;aACD,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,SAAS,CAAC,CAAC;IAC3C,CAAC;IAED;;;OAGG;IACH,eAAe,CACb,GAAmB,EACnB,MAAU,EACV,SAAwC;QAExC,OAAO,IAAI,CAAC,UAAU;aACnB,aAAa,CAAC,GAAG,EAAE,oCAAa,CAAC;aACjC,OAAO,CAAC;YACP,SAAS;YACT,KAAK,EAAE;gBACL,IAAI,EAAE,EAAE,EAAE,EAAE,MAAM,EAAE;gBACpB,SAAS,EAAE,IAAA,gBAAM,GAAE;aACpB;SACF,CAAC;aACD,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,SAAS,CAAC,CAAC;IAC3C,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,MAAM,CACV,GAAmB,EACnB,KAA+B;QAE/B,MAAM,IAAI,CAAC,4BAA4B,CAAC,GAAG,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;QAC5D,MAAM,aAAa,GAAG,IAAI,oCAAa,CAAC,KAAK,CAAC,CAAC;QAC/C,aAAa,CAAC,YAAY,GAAG,IAAA,6BAAqB,EAAC,KAAK,CAAC,YAAY,CAAC,CAAC;QACvE,aAAa,CAAC,IAAI,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,eAAe,CACzD,GAAG,EACH,KAAK,CAAC,YAAY,EAClB,KAAK,CAAC,QAAQ,CACf,CAAC;QACF,IAAI,oBAAoB,GAAG,MAAM,IAAI,CAAC,UAAU;aAC7C,aAAa,CAAC,GAAG,EAAE,oCAAa,CAAC;aACjC,IAAI,CAAC,aAAa,CAAC,CAAC;QACvB,KAAK,MAAM,MAAM,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC;YACnC,oBAAoB,GAAG,MAAM,IAAI,CAAC,UAAU,CAC1C,GAAG,EACH,oBAAoB,CAAC,EAAE,EACvB,MAAM,CACP,CAAC;QACJ,CAAC;QACD,MAAM,IAAI,CAAC,0BAA0B,CAAC,eAAe,CACnD,GAAG,EACH,oCAAa,EACb,KAAK,EACL,oBAAoB,CACrB,CAAC;QACF,MAAM,IAAI,CAAC,QAAQ,CAAC,OAAO,CACzB,IAAI,wCAAkB,CAAC,GAAG,EAAE,oBAAoB,EAAE,SAAS,EAAE,KAAK,CAAC,CACpE,CAAC;QACF,OAAO,oBAAoB,CAAC;IAC9B,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,MAAM,CACV,GAAmB,EACnB,KAA+B;QAE/B,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,CAAC,CAAC;QACxD,IAAI,CAAC,aAAa,EAAE,CAAC;YACnB,MAAM,IAAI,4BAAmB,CAAC,eAAe,EAAE,KAAK,CAAC,EAAE,CAAC,CAAC;QAC3D,CAAC;QACD,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC;YAClB,MAAM,IAAI,CAAC,4BAA4B,CAAC,GAAG,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;QAC9D,CAAC;QACD,IAAI,oBAAoB,GAAG,IAAA,0BAAW,EAAC,aAAa,EAAE,KAAK,CAAC,CAAC;QAC7D,MAAM,IAAI,CAAC,UAAU;aAClB,aAAa,CAAC,GAAG,EAAE,oCAAa,CAAC;aACjC,IAAI,CAAC,aAAa,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;QAE1C,IAAI,KAAK,CAAC,YAAY,EAAE,CAAC;YACvB,oBAAoB,CAAC,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC,YAAY,CAAC;YAC1D,MAAM,IAAI,CAAC,UAAU;iBAClB,aAAa,CAAC,GAAG,EAAE,kBAAI,CAAC;iBACxB,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC;QACrC,CAAC;QACD,IAAI,KAAK,CAAC,QAAQ,EAAE,CAAC;YACnB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,WAAW,CAC7C,GAAG,EACH,aAAa,CAAC,IAAI,CAAC,EAAE,CACtB,CAAC;YACF,IAAI,IAAI,EAAE,CAAC;gBACT,MAAM,gBAAgB,GAAG,IAAI,CAAC,6BAA6B,EAAE,CAAC;gBAC9D,gBAAgB,CAAC,YAAY,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,IAAI,CAC5D,KAAK,CAAC,QAAQ,CACf,CAAC;gBACF,MAAM,IAAI,CAAC,UAAU;qBAClB,aAAa,CAAC,GAAG,EAAE,gEAA0B,CAAC;qBAC9C,IAAI,CAAC,gBAAgB,CAAC,CAAC;YAC5B,CAAC;QACH,CAAC;QACD,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC;YAClB,MAAM,gBAAgB,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,CAAC,CAAC;YACpE,IAAI,gBAAgB,EAAE,CAAC;gBACrB,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC;gBACrE,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,IAAA,mBAAW,EAAC,EAAE,EAAE,cAAc,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC;oBACpE,MAAM,IAAI,4BAAmB,CAC3B,4CAA4C,CAC7C,CAAC;gBACJ,CAAC;YACH,CAAC;YACD,MAAM,SAAS,GAAG,aAAa,CAAC,IAAI,CAAC,KAAK;iBACvC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;iBACtB,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAE,KAAK,CAAC,OAAgB,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YAEtE,MAAM,MAAM,GAAI,KAAK,CAAC,OAAgB,CAAC,MAAM,CAC3C,CAAC,MAAM,EAAE,EAAE,CACT,CAAC,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,MAAM,CAAC,CAC/D,CAAC;YAEF,aAAa,CAAC,IAAI,CAAC,KAAK,GAAG,EAAE,CAAC;YAC9B,MAAM,IAAI,CAAC,UAAU;iBAClB,aAAa,CAAC,GAAG,EAAE,kBAAI,CAAC;iBACxB,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;YAC/C,KAAK,MAAM,MAAM,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC;gBACnC,oBAAoB,GAAG,MAAM,IAAI,CAAC,UAAU,CAC1C,GAAG,EACH,aAAa,CAAC,EAAE,EAChB,MAAM,CACP,CAAC;YACJ,CAAC;YACD,MAAM,IAAI,CAAC,QAAQ,CAAC,OAAO,CACzB,IAAI,mCAAe,CAAC,GAAG,EAAE,aAAa,EAAE,MAAM,EAAE,UAAU,CAAC,CAC5D,CAAC;YACF,MAAM,IAAI,CAAC,QAAQ,CAAC,OAAO,CACzB,IAAI,mCAAe,CAAC,GAAG,EAAE,aAAa,EAAE,SAAS,EAAE,SAAS,CAAC,CAC9D,CAAC;QACJ,CAAC;QACD,MAAM,IAAI,CAAC,0BAA0B,CAAC,eAAe,CACnD,GAAG,EACH,oCAAa,EACb,KAAK,EACL,oBAAoB,CACrB,CAAC;QACF,MAAM,IAAI,CAAC,QAAQ,CAAC,OAAO,CACzB,IAAI,wCAAkB,CAAC,GAAG,EAAE,aAAa,EAAE,SAAS,EAAE,KAAK,CAAC,CAC7D,CAAC;QACF,OAAO,oBAAoB,CAAC;IAC9B,CAAC;IAED;;;;OAIG;IACK,KAAK,CAAC,4BAA4B,CACxC,GAAmB,EACnB,OAAa;QAEb,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC,GAAG,EAAE,kBAAI,CAAC,CAAC,IAAI,CAAC;YAChE,KAAK,EAAE,EAAE,EAAE,EAAE,IAAA,YAAE,EAAC,OAAO,CAAC,EAAE;YAC1B,SAAS,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE;SAC9B,CAAC,CAAC;QACH,MAAM,mBAAmB,GAAG,IAAA,qDAAqB,EAAC,KAAK,CAAC,CAAC;QACzD,KAAK,MAAM,kBAAkB,IAAI,mBAAmB,EAAE,CAAC;YACrD,MAAM,gCAAgC,GACpC,MAAM,IAAI,CAAC,WAAW,CAAC,8BAA8B,CACnD,GAAG,EACH,kBAAkB,CAAC,EAAE,EACrB,kBAAkB,CAAC,WAAW,CAC/B,CAAC;YACJ,IAAI,CAAC,gCAAgC,EAAE,CAAC;gBACtC,MAAM,IAAI,uBAAc,CACtB,wDAAwD,CACzD,CAAC;YACJ,CAAC;QACH,CAAC;IACH,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,UAAU,CACd,GAAmB,EACnB,eAAmB,EACnB,MAAU;QAEV,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,eAAe,CAAC,CAAC;QAC/D,IAAI,CAAC,aAAa,EAAE,CAAC;YACnB,MAAM,IAAI,4BAAmB,CAAC,eAAe,EAAE,eAAe,CAAC,CAAC;QAClE,CAAC;QACD,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;QACzD,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,MAAM,IAAI,4BAAmB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAChD,CAAC;QACD,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACpC,MAAM,IAAI,CAAC,UAAU;aAClB,aAAa,CAAC,GAAG,EAAE,kBAAI,CAAC;aACxB,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;QAC/C,OAAO,aAAa,CAAC;IACvB,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,UAAU,CAAC,GAAmB,EAAE,EAAM;QAC1C,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,gBAAgB,CAC1D,GAAG,EACH,oCAAa,EACb,EAAE,EACF;YACE,SAAS,EAAE,CAAC,MAAM,CAAC;SACpB,CACF,CAAC;QACF,MAAM,gBAAgB,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;QAC9D,IAAI,gBAAgB,EAAE,CAAC;YACrB,MAAM,IAAI,4BAAmB,CAAC,qCAAqC,CAAC,CAAC;QACvE,CAAC;QACD,MAAM,IAAI,CAAC,UAAU;aAClB,aAAa,CAAC,GAAG,EAAE,oCAAa,CAAC;aACjC,MAAM,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,SAAS,EAAE,IAAI,IAAI,EAAE,EAAE,CAAC,CAAC;QAE7C,MAAM,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,GAAG,EAAE,aAAa,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAC9D,MAAM,IAAI,CAAC,QAAQ,CAAC,OAAO,CACzB,IAAI,wCAAkB,CAAC,GAAG,EAAE,aAAa,EAAE,SAAS,EAAE,EAAE,CAAC,CAC1D,CAAC;QACF,OAAO;YACL,MAAM,EAAE,gCAAc,CAAC,OAAO;SAC/B,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACK,KAAK,CAAC,gBAAgB,CAAC,GAAmB,EAAE,EAAM;QACxD,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC;QACrE,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,UAAU;aACpC,aAAa,CAAC,GAAG,EAAE,oCAAa,CAAC;aACjC,IAAI,CAAC;YACJ,SAAS,EAAE,CAAC,MAAM,EAAE,YAAY,CAAC;SAClC,CAAC,CAAC;QACL,MAAM,WAAW,GAAG,SAAS,CAAC,MAAM,CAClC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,cAAc,CAAC,EAAE,CAAC,CACtE,CAAC;QACF,IAAI,CAAC,GAAG,WAAW,CAAC,MAAM,EAAE,CAAC;YAC3B,OAAO,KAAK,CAAC;QACf,CAAC;aAAM,CAAC;YACN,OAAO,IAAA,mBAAW,EAAC,WAAW,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;QAC5C,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACK,KAAK,CAAC,sBAAsB;QAClC,MAAM,EAAE,qBAAqB,EAAE,GAAG,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC;QAEjE,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,aAAa;aACvD,aAAa,CAAC,kBAAI,CAAC;aACnB,OAAO,CAAC;YACP,KAAK,EAAE;gBACL,UAAU,EAAE,qBAAqB,CAAC,UAAU;aAC7C;SACF,CAAC,CAAC;QAEL,IAAI,CAAC,cAAc,EAAE,CAAC;YACpB,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,qBAAqB,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC;YAC1E,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,iBAAiB,EAAE,CAAC;YAClE,MAAM,aAAa,GAAG,IAAI,oCAAa,CAAC;gBACtC,YAAY,EAAE,qBAAqB,CAAC,UAAU;gBAC9C,SAAS,EAAE,OAAO;gBAClB,QAAQ,EAAE,OAAO;aAClB,CAAC,CAAC;YACH,aAAa,CAAC,IAAI,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,eAAe,CACzD,GAAG,EACH,qBAAqB,CAAC,UAAU,EAChC,qBAAqB,CAAC,QAAQ,CAC/B,CAAC;YACF,MAAM,EAAE,EAAE,EAAE,GAAG,MAAM,IAAI,CAAC,UAAU;iBACjC,aAAa,CAAC,GAAG,EAAE,oCAAa,CAAC;iBACjC,IAAI,CAAC,aAAa,CAAC,CAAC;YACvB,MAAM,oBAAoB,GAAG,MAAM,IAAA,mBAAW,EAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,CAAC;YACtE,oBAAoB,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;YACrD,MAAM,IAAI,CAAC,UAAU;iBAClB,aAAa,CAAC,GAAG,EAAE,kBAAI,CAAC;iBACxB,IAAI,CAAC,oBAAoB,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;QACxD,CAAC;aAAM,CAAC;YACN,MAAM,kBAAkB,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,aAAa;iBAC3D,aAAa,CAAC,oCAAa,CAAC;iBAC5B,OAAO,CAAC;gBACP,KAAK,EAAE;oBACL,IAAI,EAAE;wBACJ,EAAE,EAAE,cAAc,CAAC,EAAE;qBACtB;iBACF;aACF,CAAC,CAAC;YACL,IAAI,CAAC,kBAAkB,EAAE,CAAC;gBACxB,MAAM,aAAa,GAAG,IAAI,oCAAa,CAAC;oBACtC,YAAY,EAAE,qBAAqB,CAAC,UAAU;oBAC9C,SAAS,EAAE,OAAO;oBAClB,QAAQ,EAAE,OAAO;iBAClB,CAAC,CAAC;gBACH,MAAM,oBAAoB,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,aAAa;qBAC7D,aAAa,CAAC,oCAAa,CAAC;qBAC5B,IAAI,CAAC,aAAa,CAAC,CAAC;gBACvB,oBAAoB,CAAC,IAAI,GAAG,cAAc,CAAC;gBAC3C,MAAM,IAAI,CAAC,UAAU,CAAC,aAAa;qBAChC,aAAa,CAAC,oCAAa,CAAC;qBAC5B,IAAI,CAAC,oBAAoB,CAAC,CAAC;YAChC,CAAC;iBAAM,IAAI,kBAAkB,CAAC,SAAS,IAAI,IAAI,EAAE,CAAC;gBAChD,kBAAkB,CAAC,SAAS,GAAG,IAAI,CAAC;gBACpC,MAAM,IAAI,CAAC,UAAU,CAAC,aAAa;qBAChC,aAAa,CAAC,oCAAa,CAAC;qBAC5B,IAAI,CAAC,kBAAkB,CAAC,CAAC;YAC9B,CAAC;YAED,IAAI,cAAc,CAAC,SAAS,IAAI,IAAI,EAAE,CAAC;gBACrC,cAAc,CAAC,SAAS,GAAG,IAAI,CAAC;gBAChC,MAAM,IAAI,CAAC,UAAU,CAAC,aAAa;qBAChC,aAAa,CAAC,kBAAI,CAAC;qBACnB,IAAI,CAAC,cAAc,CAAC,CAAC;YAC1B,CAAC;QACH,CAAC;IACH,CAAC;CACF,CAAA;AAxYY,oDAAoB;+BAApB,oBAAoB;IADhC,IAAA,mBAAU,GAAE;qCAGW,kDAAuB;QACpB,sBAAa;QACV,qCAAgB;QAClB,gCAAc;QACjB,0BAAW;QACX,0BAAW;QACI,0DAA0B;QAC5C,oBAAQ;QACK,+CAAqB;GAV3C,oBAAoB,CAwYhC"}

package/dist/service/services/asset.service.d.ts

@@ -0,0 +1,134 @@
+/// <reference types="node" />
+/// <reference types="node" />
+import { AssetListOptions, AssignAssetsToChannelInput, CreateAssetInput, CreateAssetResult, DeletionResponse, UpdateAssetInput } from "@deenruv/common/lib/generated-types";
+import { ID, PaginatedList } from "@deenruv/common/lib/shared-types";
+import { ReadStream } from "fs-extra";
+import { Readable } from "stream";
+import { RequestContext } from "../../api/common/request-context";
+import { RelationPaths } from "../../api/decorators/relations.decorator";
+import { ConfigService } from "../../config/config.service";
+import { TransactionalConnection } from "../../connection/transactional-connection";
+import { Asset } from "../../entity/asset/asset.entity";
+import { OrderableAsset } from "../../entity/asset/orderable-asset.entity";
+import { DeenruvEntity } from "../../entity/base/base.entity";
+import { EventBus } from "../../event-bus/event-bus";
+import { CustomFieldRelationService } from "../helpers/custom-field-relation/custom-field-relation.service";
+import { ListQueryBuilder } from "../helpers/list-query-builder/list-query-builder";
+import { ChannelService } from "./channel.service";
+import { RoleService } from "./role.service";
+import { TagService } from "./tag.service";
+/**
+ * @description
+ * Certain entities (Product, ProductVariant, Collection) use this interface
+ * to model a featured asset and then a list of assets with a defined order.
+ *
+ * @docsCategory services
+ * @docsPage AssetService
+ */
+export interface EntityWithAssets extends DeenruvEntity {
+    featuredAsset: Asset | null;
+    assets: OrderableAsset[];
+}
+/**
+ * @description
+ * Used when updating entities which implement {@link EntityWithAssets}.
+ *
+ * @docsCategory services
+ * @docsPage AssetService
+ */
+export interface EntityAssetInput {
+    assetIds?: ID[] | null;
+    featuredAssetId?: ID | null;
+}
+/**
+ * @description
+ * Contains methods relating to {@link Asset} entities.
+ *
+ * @docsCategory services
+ * @docsWeight 0
+ */
+export declare class AssetService {
+    private connection;
+    private configService;
+    private listQueryBuilder;
+    private eventBus;
+    private tagService;
+    private channelService;
+    private roleService;
+    private customFieldRelationService;
+    private permittedMimeTypes;
+    constructor(connection: TransactionalConnection, configService: ConfigService, listQueryBuilder: ListQueryBuilder, eventBus: EventBus, tagService: TagService, channelService: ChannelService, roleService: RoleService, customFieldRelationService: CustomFieldRelationService);
+    findOne(ctx: RequestContext, id: ID, relations?: RelationPaths<Asset>): Promise<Asset | undefined>;
+    findAll(ctx: RequestContext, options?: AssetListOptions, relations?: RelationPaths<Asset>): Promise<PaginatedList<Asset>>;
+    getFeaturedAsset<T extends Omit<EntityWithAssets, "assets">>(ctx: RequestContext, entity: T): Promise<Asset | undefined>;
+    /**
+     * @description
+     * Returns the Assets of an entity which has a well-ordered list of Assets, such as Product,
+     * ProductVariant or Collection.
+     */
+    getEntityAssets<T extends EntityWithAssets>(ctx: RequestContext, entity: T): Promise<Asset[] | undefined>;
+    updateFeaturedAsset<T extends EntityWithAssets>(ctx: RequestContext, entity: T, input: EntityAssetInput): Promise<T>;
+    /**
+     * @description
+     * Updates the assets / featuredAsset of an entity, ensuring that only valid assetIds are used.
+     */
+    updateEntityAssets<T extends EntityWithAssets>(ctx: RequestContext, entity: T, input: EntityAssetInput): Promise<T>;
+    /**
+     * @description
+     * Create an Asset based on a file uploaded via the GraphQL API. The file should be uploaded
+     * using the [GraphQL multipart request specification](https://github.com/jaydenseric/graphql-multipart-request-spec),
+     * e.g. using the [apollo-upload-client](https://github.com/jaydenseric/apollo-upload-client) npm package.
+     *
+     * See the [Uploading Files docs](/guides/developer-guide/uploading-files) for an example of usage.
+     */
+    create(ctx: RequestContext, input: CreateAssetInput | {
+        filename: string;
+        mimetype: string;
+        tags?: CreateAssetInput["tags"];
+        customFields?: CreateAssetInput["customFields"];
+    }): Promise<CreateAssetResult>;
+    /**
+     * @description
+     * Updates the name, focalPoint, tags & custom fields of an Asset.
+     */
+    update(ctx: RequestContext, input: UpdateAssetInput): Promise<Asset>;
+    /**
+     * @description
+     * Deletes an Asset after performing checks to ensure that the Asset is not currently in use
+     * by a Product, ProductVariant or Collection.
+     */
+    delete(ctx: RequestContext, ids: ID[], force?: boolean, deleteFromAllChannels?: boolean): Promise<DeletionResponse>;
+    assignToChannel(ctx: RequestContext, input: AssignAssetsToChannelInput): Promise<Asset[]>;
+    /**
+     * @description
+     * Create an Asset from a file stream, for example to create an Asset during data import.
+     */
+    createFromFileStream(stream: ReadStream, ctx?: RequestContext): Promise<CreateAssetResult>;
+    createFromFileStream(stream: Readable, filePath: string, ctx?: RequestContext): Promise<CreateAssetResult>;
+    private getMimeType;
+    /**
+     * @description
+     * Unconditionally delete given assets.
+     * Does not remove assets from channels
+     */
+    private deleteUnconditional;
+    /**
+     * Check if current user has permissions to delete assets from all channels
+     */
+    private hasDeletePermissionForChannels;
+    private createAssetInternal;
+    private getSourceFileName;
+    private getPreviewFileName;
+    private generateUniqueName;
+    private getDimensions;
+    private createOrderableAssets;
+    private getOrderableAsset;
+    private removeExistingOrderableAssets;
+    private getOrderableAssetType;
+    private getHostEntityIdProperty;
+    private validateMimeType;
+    /**
+     * Find the entities which reference the given Asset as a featuredAsset.
+     */
+    private findAssetUsages;
+}