@acmekit/file 2.13.1

package/README.md

@@ -0,0 +1 @@
+# File Module

package/dist/index.d.ts

@@ -0,0 +1,7 @@
+import "./types";
+import { FileModuleService } from "./services";
+declare const _default: import("@acmekit/types").ModuleExports<typeof FileModuleService> & {
+    linkable: Record<string, any>;
+};
+export default _default;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,CAAA;AAChB,OAAO,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAA;;;;AAI7C,wBAGE"}

package/dist/index.js

@@ -0,0 +1,14 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+require("./types");
+const _services_1 = require("./services");
+const providers_1 = __importDefault(require("./loaders/providers"));
+const utils_1 = require("@acmekit/framework/utils");
+exports.default = (0, utils_1.Module)(utils_1.Modules.FILE, {
+    service: _services_1.FileModuleService,
+    loaders: [providers_1.default],
+});
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;AAAA,mBAAgB;AAChB,yCAA6C;AAC7C,oEAA+C;AAC/C,oDAA0D;AAE1D,kBAAe,IAAA,cAAM,EAAC,eAAO,CAAC,IAAI,EAAE;IAClC,OAAO,EAAE,6BAAiB;IAC1B,OAAO,EAAE,CAAC,mBAAa,CAAC;CACzB,CAAC,CAAA"}

package/dist/joiner-config.d.ts

@@ -0,0 +1,2 @@
+export declare const joinerConfig: Omit<import("@acmekit/types").ModuleJoinerConfig, "serviceName" | "primaryKeys" | "alias" | "linkableKeys"> & Required<Pick<import("@acmekit/types").ModuleJoinerConfig, "serviceName" | "primaryKeys" | "alias" | "linkableKeys">>;
+//# sourceMappingURL=joiner-config.d.ts.map

package/dist/joiner-config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"joiner-config.d.ts","sourceRoot":"","sources":["../src/joiner-config.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,YAAY,qOAEvB,CAAA"}

package/dist/joiner-config.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.joinerConfig = void 0;
+const utils_1 = require("@acmekit/framework/utils");
+exports.joinerConfig = (0, utils_1.defineJoinerConfig)(utils_1.Modules.FILE, {
+    models: [{ name: "File" }],
+});
+//# sourceMappingURL=joiner-config.js.map

package/dist/joiner-config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"joiner-config.js","sourceRoot":"","sources":["../src/joiner-config.ts"],"names":[],"mappings":";;;AAAA,oDAAsE;AAEzD,QAAA,YAAY,GAAG,IAAA,0BAAkB,EAAC,eAAO,CAAC,IAAI,EAAE;IAC3D,MAAM,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;CAC3B,CAAC,CAAA"}

package/dist/loaders/providers.d.ts

@@ -0,0 +1,6 @@
+import { LoaderOptions, ModuleProvider, ModulesSdkTypes } from "@acmekit/framework/types";
+declare const _default: ({ container, options, }: LoaderOptions<(ModulesSdkTypes.ModuleServiceInitializeOptions | ModulesSdkTypes.ModuleServiceInitializeCustomDataLayerOptions) & {
+    providers: ModuleProvider[];
+}>) => Promise<void>;
+export default _default;
+//# sourceMappingURL=providers.d.ts.map

package/dist/loaders/providers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"providers.d.ts","sourceRoot":"","sources":["../../src/loaders/providers.ts"],"names":[],"mappings":"AACA,OAAO,EACL,aAAa,EACb,cAAc,EACd,eAAe,EAChB,MAAM,0BAA0B,CAAA;yBA0BX,yBAGnB,aAAa,CACd,CACI,eAAe,CAAC,8BAA8B,GAC9C,eAAe,CAAC,6CAA6C,CAChE,GAAG;IAAE,SAAS,EAAE,cAAc,EAAE,CAAA;CAAE,CACpC,KAAG,OAAO,CAAC,IAAI,CAAC;AARjB,wBAcC"}

package/dist/loaders/providers.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const modules_sdk_1 = require("@acmekit/framework/modules-sdk");
+const _services_1 = require("../services");
+const _types_1 = require("../types");
+const awilix_1 = require("@acmekit/framework/awilix");
+const registrationFn = async (klass, container, pluginOptions) => {
+    const key = _services_1.FileProviderService.getRegistrationIdentifier(klass, pluginOptions.id);
+    container.register({
+        [_types_1.FileProviderRegistrationPrefix + key]: (0, awilix_1.asFunction)((cradle) => new klass(cradle, pluginOptions.options ?? {}), {
+            lifetime: klass.LIFE_TIME || awilix_1.Lifetime.SINGLETON,
+        }),
+    });
+    container.registerAdd(_types_1.FileProviderIdentifierRegistrationName, (0, awilix_1.asValue)(key));
+};
+exports.default = async ({ container, options, }) => {
+    await (0, modules_sdk_1.moduleProviderLoader)({
+        container,
+        providers: options?.providers || [],
+        registerServiceFn: registrationFn,
+    });
+};
+//# sourceMappingURL=providers.js.map

package/dist/loaders/providers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"providers.js","sourceRoot":"","sources":["../../src/loaders/providers.ts"],"names":[],"mappings":";;AAAA,gEAAqE;AAMrE,yCAA+C;AAC/C,mCAGe;AACf,sDAAyE;AAEzE,MAAM,cAAc,GAAG,KAAK,EAAE,KAAK,EAAE,SAAS,EAAE,aAAa,EAAE,EAAE;IAC/D,MAAM,GAAG,GAAG,+BAAmB,CAAC,yBAAyB,CACvD,KAAK,EACL,aAAa,CAAC,EAAE,CACjB,CAAA;IAED,SAAS,CAAC,QAAQ,CAAC;QACjB,CAAC,uCAA8B,GAAG,GAAG,CAAC,EAAE,IAAA,mBAAU,EAChD,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,KAAK,CAAC,MAAM,EAAE,aAAa,CAAC,OAAO,IAAI,EAAE,CAAC,EAC1D;YACE,QAAQ,EAAE,KAAK,CAAC,SAAS,IAAI,iBAAQ,CAAC,SAAS;SAChD,CACF;KACF,CAAC,CAAA;IAEF,SAAS,CAAC,WAAW,CAAC,+CAAsC,EAAE,IAAA,gBAAO,EAAC,GAAG,CAAC,CAAC,CAAA;AAC7E,CAAC,CAAA;AAED,kBAAe,KAAK,EAAE,EACpB,SAAS,EACT,OAAO,GAMR,EAAiB,EAAE;IAClB,MAAM,IAAA,kCAAoB,EAAC;QACzB,SAAS;QACT,SAAS,EAAE,OAAO,EAAE,SAAS,IAAI,EAAE;QACnC,iBAAiB,EAAE,cAAc;KAClC,CAAC,CAAA;AACJ,CAAC,CAAA"}

package/dist/services/file-module-service.d.ts

@@ -0,0 +1,57 @@
+import { Context, CreateFileDTO, FileDTO, FileTypes, FilterableFileProps, FindConfig, GetUploadFileUrlDTO, ModuleJoinerConfig, UploadFileUrlDTO } from "@acmekit/framework/types";
+import type { Readable, Writable } from "stream";
+import FileProviderService from "./file-provider-service";
+type InjectedDependencies = {
+    fileProviderService: FileProviderService;
+};
+export default class FileModuleService implements FileTypes.IFileModuleService {
+    protected readonly fileProviderService_: FileProviderService;
+    constructor({ fileProviderService }: InjectedDependencies);
+    __joinerConfig(): ModuleJoinerConfig;
+    getProvider(): FileProviderService;
+    createFiles(data: CreateFileDTO[], sharedContext?: Context): Promise<FileDTO[]>;
+    createFiles(data: CreateFileDTO, sharedContext?: Context): Promise<FileDTO>;
+    getUploadFileUrls(data: GetUploadFileUrlDTO[], sharedContext?: Context): Promise<UploadFileUrlDTO[]>;
+    getUploadFileUrls(data: GetUploadFileUrlDTO, sharedContext?: Context): Promise<UploadFileUrlDTO>;
+    deleteFiles(ids: string[], sharedContext?: Context): Promise<void>;
+    deleteFiles(id: string, sharedContext?: Context): Promise<void>;
+    retrieveFile(id: string): Promise<FileDTO>;
+    listFiles(filters?: FilterableFileProps, config?: FindConfig<FileDTO>, sharedContext?: Context): Promise<FileDTO[]>;
+    listAndCountFiles(filters?: FilterableFileProps, config?: FindConfig<FileDTO>, sharedContext?: Context): Promise<[FileDTO[], number]>;
+    /**
+     * Get the file contents as a readable stream.
+     *
+     * @example
+     * const stream = await fileModuleService.getAsStream("file_123")
+     * writeable.pipe(stream)
+     */
+    getDownloadStream(id: string): Promise<Readable>;
+    /**
+     * Get the file contents as a Node.js Buffer
+     *
+     * @example
+     * const contents = await fileModuleService.getAsBuffer("file_123")
+     * contents.toString('utf-8')
+     */
+    getAsBuffer(id: string): Promise<Buffer>;
+    /**
+     * Get a writeable stream to upload a file.
+     *
+     * @example
+     * const { writeStream, promise } = await fileModuleService.getUploadStream({
+     *   filename: "test.csv",
+     *   mimeType: "text/csv",
+     * })
+     *
+     * stream.pipe(writeStream)
+     * const result = await promise
+     */
+    getUploadStream(data: FileTypes.ProviderUploadStreamDTO): Promise<{
+        writeStream: Writable;
+        promise: Promise<FileTypes.ProviderFileResultDTO>;
+        url: string;
+        fileKey: string;
+    }>;
+}
+export {};
+//# sourceMappingURL=file-module-service.d.ts.map

package/dist/services/file-module-service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"file-module-service.d.ts","sourceRoot":"","sources":["../../src/services/file-module-service.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,OAAO,EACP,aAAa,EACb,OAAO,EACP,SAAS,EACT,mBAAmB,EACnB,UAAU,EACV,mBAAmB,EACnB,kBAAkB,EAClB,gBAAgB,EACjB,MAAM,0BAA0B,CAAA;AACjC,OAAO,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,QAAQ,CAAA;AAIhD,OAAO,mBAAmB,MAAM,yBAAyB,CAAA;AAEzD,KAAK,oBAAoB,GAAG;IAC1B,mBAAmB,EAAE,mBAAmB,CAAA;CACzC,CAAA;AAED,MAAM,CAAC,OAAO,OAAO,iBAAkB,YAAW,SAAS,CAAC,kBAAkB;IAC5E,SAAS,CAAC,QAAQ,CAAC,oBAAoB,EAAE,mBAAmB,CAAA;gBAChD,EAAE,mBAAmB,EAAE,EAAE,oBAAoB;IAIzD,cAAc,IAAI,kBAAkB;IAIpC,WAAW;IAIX,WAAW,CACT,IAAI,EAAE,aAAa,EAAE,EACrB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,OAAO,EAAE,CAAC;IACrB,WAAW,CAAC,IAAI,EAAE,aAAa,EAAE,aAAa,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IAmB3E,iBAAiB,CACf,IAAI,EAAE,mBAAmB,EAAE,EAC3B,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,gBAAgB,EAAE,CAAC;IAC9B,iBAAiB,CACf,IAAI,EAAE,mBAAmB,EACzB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,gBAAgB,CAAC;IActB,WAAW,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE,aAAa,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAClE,WAAW,CAAC,EAAE,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAU/D,YAAY,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAW1C,SAAS,CACb,OAAO,CAAC,EAAE,mBAAmB,EAC7B,MAAM,CAAC,EAAE,UAAU,CAAC,OAAO,CAAC,EAC5B,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,OAAO,EAAE,CAAC;IAsBf,iBAAiB,CACrB,OAAO,CAAC,EAAE,mBAAmB,EAC7B,MAAM,CAAC,EAAE,UAAU,CAAC,OAAO,CAAC,EAC5B,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,MAAM,CAAC,CAAC;IAsB/B;;;;;;OAMG;IACH,iBAAiB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IAIhD;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAIxC;;;;;;;;;;;OAWG;IACH,eAAe,CAAC,IAAI,EAAE,SAAS,CAAC,uBAAuB,GAAG,OAAO,CAAC;QAChE,WAAW,EAAE,QAAQ,CAAA;QACrB,OAAO,EAAE,OAAO,CAAC,SAAS,CAAC,qBAAqB,CAAC,CAAA;QACjD,GAAG,EAAE,MAAM,CAAA;QACX,OAAO,EAAE,MAAM,CAAA;KAChB,CAAC;CAGH"}

package/dist/services/file-module-service.js

@@ -0,0 +1,108 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const utils_1 = require("@acmekit/framework/utils");
+const joiner_config_1 = require("../joiner-config");
+class FileModuleService {
+    constructor({ fileProviderService }) {
+        this.fileProviderService_ = fileProviderService;
+    }
+    __joinerConfig() {
+        return joiner_config_1.joinerConfig;
+    }
+    getProvider() {
+        return this.fileProviderService_;
+    }
+    async createFiles(data) {
+        const input = Array.isArray(data) ? data : [data];
+        // TODO: Validate file mime type, have config for allowed types
+        const files = await Promise.all(input.map((file) => this.fileProviderService_.upload(file)));
+        const result = files.map((file) => ({
+            id: file.key,
+            url: file.url,
+        }));
+        return Array.isArray(data) ? result : result[0];
+    }
+    async getUploadFileUrls(data) {
+        const input = Array.isArray(data) ? data : [data];
+        const result = await Promise.all(input.map((file) => this.fileProviderService_.getPresignedUploadUrl(file)));
+        return Array.isArray(data) ? result : result[0];
+    }
+    async deleteFiles(ids) {
+        const input = Array.isArray(ids) ? ids : [ids];
+        await this.fileProviderService_.delete(input.map((id) => {
+            return { fileKey: id };
+        }));
+    }
+    async retrieveFile(id) {
+        const res = await this.fileProviderService_.getPresignedDownloadUrl({
+            fileKey: id,
+        });
+        return {
+            id,
+            url: res,
+        };
+    }
+    async listFiles(filters, config, sharedContext) {
+        if (!filters?.id) {
+            throw new utils_1.AcmeKitError(utils_1.AcmeKitError.Types.INVALID_DATA, "Listing of files is only supported when filtering by ID.");
+        }
+        const ids = Array.isArray(filters?.id) ? filters?.id : [filters?.id];
+        const res = await Promise.all(ids.map(async (id) => {
+            const res = await this.fileProviderService_.getPresignedDownloadUrl({
+                fileKey: id,
+            });
+            return { id, url: res };
+        }));
+        return res;
+    }
+    async listAndCountFiles(filters, config, sharedContext) {
+        if (!filters?.id) {
+            throw new utils_1.AcmeKitError(utils_1.AcmeKitError.Types.INVALID_DATA, "Listing of files is only supported when filtering by ID.");
+        }
+        const ids = Array.isArray(filters?.id) ? filters?.id : [filters?.id];
+        const res = await Promise.all(ids.map(async (id) => {
+            const res = await this.fileProviderService_.getPresignedDownloadUrl({
+                fileKey: id,
+            });
+            return { id, url: res };
+        }));
+        return [res, res.length];
+    }
+    /**
+     * Get the file contents as a readable stream.
+     *
+     * @example
+     * const stream = await fileModuleService.getAsStream("file_123")
+     * writeable.pipe(stream)
+     */
+    getDownloadStream(id) {
+        return this.fileProviderService_.getDownloadStream({ fileKey: id });
+    }
+    /**
+     * Get the file contents as a Node.js Buffer
+     *
+     * @example
+     * const contents = await fileModuleService.getAsBuffer("file_123")
+     * contents.toString('utf-8')
+     */
+    getAsBuffer(id) {
+        return this.fileProviderService_.getAsBuffer({ fileKey: id });
+    }
+    /**
+     * Get a writeable stream to upload a file.
+     *
+     * @example
+     * const { writeStream, promise } = await fileModuleService.getUploadStream({
+     *   filename: "test.csv",
+     *   mimeType: "text/csv",
+     * })
+     *
+     * stream.pipe(writeStream)
+     * const result = await promise
+     */
+    getUploadStream(data) {
+        return this.fileProviderService_.getUploadStream(data);
+    }
+}
+exports.default = FileModuleService;
+//# sourceMappingURL=file-module-service.js.map

package/dist/services/file-module-service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"file-module-service.js","sourceRoot":"","sources":["../../src/services/file-module-service.ts"],"names":[],"mappings":";;AAaA,oDAAuD;AACvD,oDAA+C;AAO/C,MAAqB,iBAAiB;IAEpC,YAAY,EAAE,mBAAmB,EAAwB;QACvD,IAAI,CAAC,oBAAoB,GAAG,mBAAmB,CAAA;IACjD,CAAC;IAED,cAAc;QACZ,OAAO,4BAAY,CAAA;IACrB,CAAC;IAED,WAAW;QACT,OAAO,IAAI,CAAC,oBAAoB,CAAA;IAClC,CAAC;IAQD,KAAK,CAAC,WAAW,CACf,IAAqC;QAErC,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAA;QACjD,+DAA+D;QAE/D,MAAM,KAAK,GAAG,MAAM,OAAO,CAAC,GAAG,CAC7B,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,oBAAoB,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAC5D,CAAA;QACD,MAAM,MAAM,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;YAClC,EAAE,EAAE,IAAI,CAAC,GAAG;YACZ,GAAG,EAAE,IAAI,CAAC,GAAG;SACd,CAAC,CAAC,CAAA;QAEH,OAAO,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAA;IACjD,CAAC;IAWD,KAAK,CAAC,iBAAiB,CACrB,IAAiD;QAEjD,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAA;QAEjD,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,GAAG,CAC9B,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,oBAAoB,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAC,CAC3E,CAAA;QAED,OAAO,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAA;IACjD,CAAC;IAID,KAAK,CAAC,WAAW,CAAC,GAAsB;QACtC,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAA;QAC9C,MAAM,IAAI,CAAC,oBAAoB,CAAC,MAAM,CACpC,KAAK,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE;YACf,OAAO,EAAE,OAAO,EAAE,EAAE,EAAE,CAAA;QACxB,CAAC,CAAC,CACH,CAAA;IACH,CAAC;IAED,KAAK,CAAC,YAAY,CAAC,EAAU;QAC3B,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,oBAAoB,CAAC,uBAAuB,CAAC;YAClE,OAAO,EAAE,EAAE;SACZ,CAAC,CAAA;QAEF,OAAO;YACL,EAAE;YACF,GAAG,EAAE,GAAG;SACT,CAAA;IACH,CAAC;IAED,KAAK,CAAC,SAAS,CACb,OAA6B,EAC7B,MAA4B,EAC5B,aAAuB;QAEvB,IAAI,CAAC,OAAO,EAAE,EAAE,EAAE,CAAC;YACjB,MAAM,IAAI,oBAAY,CACpB,oBAAY,CAAC,KAAK,CAAC,YAAY,EAC/B,0DAA0D,CAC3D,CAAA;QACH,CAAC;QAED,MAAM,GAAG,GAAG,KAAK,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAA;QAEpE,MAAM,GAAG,GAAG,MAAM,OAAO,CAAC,GAAG,CAC3B,GAAG,CAAC,GAAG,CAAC,KAAK,EAAE,EAAE,EAAE,EAAE;YACnB,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,oBAAoB,CAAC,uBAAuB,CAAC;gBAClE,OAAO,EAAE,EAAE;aACZ,CAAC,CAAA;YACF,OAAO,EAAE,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,CAAA;QACzB,CAAC,CAAC,CACH,CAAA;QAED,OAAO,GAAG,CAAA;IACZ,CAAC;IAED,KAAK,CAAC,iBAAiB,CACrB,OAA6B,EAC7B,MAA4B,EAC5B,aAAuB;QAEvB,IAAI,CAAC,OAAO,EAAE,EAAE,EAAE,CAAC;YACjB,MAAM,IAAI,oBAAY,CACpB,oBAAY,CAAC,KAAK,CAAC,YAAY,EAC/B,0DAA0D,CAC3D,CAAA;QACH,CAAC;QAED,MAAM,GAAG,GAAG,KAAK,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAA;QAEpE,MAAM,GAAG,GAAG,MAAM,OAAO,CAAC,GAAG,CAC3B,GAAG,CAAC,GAAG,CAAC,KAAK,EAAE,EAAE,EAAE,EAAE;YACnB,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,oBAAoB,CAAC,uBAAuB,CAAC;gBAClE,OAAO,EAAE,EAAE;aACZ,CAAC,CAAA;YACF,OAAO,EAAE,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,CAAA;QACzB,CAAC,CAAC,CACH,CAAA;QAED,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;IAC1B,CAAC;IAED;;;;;;OAMG;IACH,iBAAiB,CAAC,EAAU;QAC1B,OAAO,IAAI,CAAC,oBAAoB,CAAC,iBAAiB,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC,CAAA;IACrE,CAAC;IAED;;;;;;OAMG;IACH,WAAW,CAAC,EAAU;QACpB,OAAO,IAAI,CAAC,oBAAoB,CAAC,WAAW,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC,CAAA;IAC/D,CAAC;IAED;;;;;;;;;;;OAWG;IACH,eAAe,CAAC,IAAuC;QAMrD,OAAO,IAAI,CAAC,oBAAoB,CAAC,eAAe,CAAC,IAAI,CAAC,CAAA;IACxD,CAAC;CACF;AA9KD,oCA8KC"}

package/dist/services/file-provider-service.d.ts

@@ -0,0 +1,25 @@
+import { Constructor, FileTypes } from "@acmekit/framework/types";
+import { FileProviderRegistrationPrefix } from "../types";
+import type { Readable, Writable } from "stream";
+type InjectedDependencies = {
+    [key: `${typeof FileProviderRegistrationPrefix}${string}`]: FileTypes.IFileProvider;
+};
+export default class FileProviderService {
+    protected readonly fileProvider_: FileTypes.IFileProvider;
+    constructor(container: InjectedDependencies);
+    static getRegistrationIdentifier(providerClass: Constructor<FileTypes.IFileProvider>, optionName?: string): string;
+    upload(file: FileTypes.ProviderUploadFileDTO): Promise<FileTypes.ProviderFileResultDTO>;
+    delete(fileData: FileTypes.ProviderDeleteFileDTO | FileTypes.ProviderDeleteFileDTO[]): Promise<void>;
+    getPresignedDownloadUrl(fileData: FileTypes.ProviderGetFileDTO): Promise<string>;
+    getPresignedUploadUrl(fileData: FileTypes.ProviderGetPresignedUploadUrlDTO): Promise<FileTypes.ProviderFileResultDTO>;
+    getDownloadStream(fileData: FileTypes.ProviderGetFileDTO): Promise<Readable>;
+    getAsBuffer(fileData: FileTypes.ProviderGetFileDTO): Promise<Buffer>;
+    getUploadStream(fileData: FileTypes.ProviderUploadStreamDTO): Promise<{
+        writeStream: Writable;
+        promise: Promise<FileTypes.ProviderFileResultDTO>;
+        url: string;
+        fileKey: string;
+    }>;
+}
+export {};
+//# sourceMappingURL=file-provider-service.d.ts.map

package/dist/services/file-provider-service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"file-provider-service.d.ts","sourceRoot":"","sources":["../../src/services/file-provider-service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAA;AAEjE,OAAO,EAAE,8BAA8B,EAAE,MAAM,QAAQ,CAAA;AACvD,OAAO,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,QAAQ,CAAA;AAEhD,KAAK,oBAAoB,GAAG;IAC1B,CACE,GAAG,EAAE,GAAG,OAAO,8BAA8B,GAAG,MAAM,EAAE,GACvD,SAAS,CAAC,aAAa,CAAA;CAC3B,CAAA;AAED,MAAM,CAAC,OAAO,OAAO,mBAAmB;IACtC,SAAS,CAAC,QAAQ,CAAC,aAAa,EAAE,SAAS,CAAC,aAAa,CAAA;gBAE7C,SAAS,EAAE,oBAAoB;IAe3C,MAAM,CAAC,yBAAyB,CAC9B,aAAa,EAAE,WAAW,CAAC,SAAS,CAAC,aAAa,CAAC,EACnD,UAAU,CAAC,EAAE,MAAM;IAKrB,MAAM,CACJ,IAAI,EAAE,SAAS,CAAC,qBAAqB,GACpC,OAAO,CAAC,SAAS,CAAC,qBAAqB,CAAC;IAI3C,MAAM,CACJ,QAAQ,EACJ,SAAS,CAAC,qBAAqB,GAC/B,SAAS,CAAC,qBAAqB,EAAE,GACpC,OAAO,CAAC,IAAI,CAAC;IAIhB,uBAAuB,CACrB,QAAQ,EAAE,SAAS,CAAC,kBAAkB,GACrC,OAAO,CAAC,MAAM,CAAC;IAIlB,qBAAqB,CACnB,QAAQ,EAAE,SAAS,CAAC,gCAAgC,GACnD,OAAO,CAAC,SAAS,CAAC,qBAAqB,CAAC;IAkB3C,iBAAiB,CAAC,QAAQ,EAAE,SAAS,CAAC,kBAAkB,GAAG,OAAO,CAAC,QAAQ,CAAC;IAI5E,WAAW,CAAC,QAAQ,EAAE,SAAS,CAAC,kBAAkB,GAAG,OAAO,CAAC,MAAM,CAAC;IAIpE,eAAe,CAAC,QAAQ,EAAE,SAAS,CAAC,uBAAuB,GAAG,OAAO,CAAC;QACpE,WAAW,EAAE,QAAQ,CAAA;QACrB,OAAO,EAAE,OAAO,CAAC,SAAS,CAAC,qBAAqB,CAAC,CAAA;QACjD,GAAG,EAAE,MAAM,CAAA;QACX,OAAO,EAAE,MAAM,CAAA;KAChB,CAAC;CAGH"}

package/dist/services/file-provider-service.js

@@ -0,0 +1,45 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const utils_1 = require("@acmekit/framework/utils");
+const _types_1 = require("../types");
+class FileProviderService {
+    constructor(container) {
+        const fileProviderKeys = Object.keys(container).filter((k) => k.startsWith(_types_1.FileProviderRegistrationPrefix));
+        if (fileProviderKeys.length !== 1) {
+            throw new utils_1.AcmeKitError(utils_1.AcmeKitError.Types.INVALID_DATA, `File module should be initialized with exactly one provider`);
+        }
+        this.fileProvider_ = container[fileProviderKeys[0]];
+    }
+    static getRegistrationIdentifier(providerClass, optionName) {
+        return `${providerClass.identifier}_${optionName}`;
+    }
+    upload(file) {
+        return this.fileProvider_.upload(file);
+    }
+    delete(fileData) {
+        return this.fileProvider_.delete(fileData);
+    }
+    getPresignedDownloadUrl(fileData) {
+        return this.fileProvider_.getPresignedDownloadUrl(fileData);
+    }
+    getPresignedUploadUrl(fileData) {
+        if (!this.fileProvider_.getPresignedUploadUrl) {
+            throw new utils_1.AcmeKitError(utils_1.AcmeKitError.Types.INVALID_DATA, "Provider does not support presigned upload URLs");
+        }
+        if (!fileData.filename) {
+            throw new utils_1.AcmeKitError(utils_1.AcmeKitError.Types.INVALID_DATA, "File name is required to get a presigned upload URL");
+        }
+        return this.fileProvider_.getPresignedUploadUrl(fileData);
+    }
+    getDownloadStream(fileData) {
+        return this.fileProvider_.getDownloadStream(fileData);
+    }
+    getAsBuffer(fileData) {
+        return this.fileProvider_.getAsBuffer(fileData);
+    }
+    getUploadStream(fileData) {
+        return this.fileProvider_.getUploadStream(fileData);
+    }
+}
+exports.default = FileProviderService;
+//# sourceMappingURL=file-provider-service.js.map

package/dist/services/file-provider-service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"file-provider-service.js","sourceRoot":"","sources":["../../src/services/file-provider-service.ts"],"names":[],"mappings":";;AACA,oDAAuD;AACvD,mCAAuD;AASvD,MAAqB,mBAAmB;IAGtC,YAAY,SAA+B;QACzC,MAAM,gBAAgB,GAAG,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAC3D,CAAC,CAAC,UAAU,CAAC,uCAA8B,CAAC,CAC7C,CAAA;QAED,IAAI,gBAAgB,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAClC,MAAM,IAAI,oBAAY,CACpB,oBAAY,CAAC,KAAK,CAAC,YAAY,EAC/B,6DAA6D,CAC9D,CAAA;QACH,CAAC;QAED,IAAI,CAAC,aAAa,GAAG,SAAS,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAAA;IACrD,CAAC;IAED,MAAM,CAAC,yBAAyB,CAC9B,aAAmD,EACnD,UAAmB;QAEnB,OAAO,GAAI,aAAqB,CAAC,UAAU,IAAI,UAAU,EAAE,CAAA;IAC7D,CAAC;IAED,MAAM,CACJ,IAAqC;QAErC,OAAO,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;IACxC,CAAC;IAED,MAAM,CACJ,QAEqC;QAErC,OAAO,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAA;IAC5C,CAAC;IAED,uBAAuB,CACrB,QAAsC;QAEtC,OAAO,IAAI,CAAC,aAAa,CAAC,uBAAuB,CAAC,QAAQ,CAAC,CAAA;IAC7D,CAAC;IAED,qBAAqB,CACnB,QAAoD;QAEpD,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,qBAAqB,EAAE,CAAC;YAC9C,MAAM,IAAI,oBAAY,CACpB,oBAAY,CAAC,KAAK,CAAC,YAAY,EAC/B,iDAAiD,CAClD,CAAA;QACH,CAAC;QAED,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC;YACvB,MAAM,IAAI,oBAAY,CACpB,oBAAY,CAAC,KAAK,CAAC,YAAY,EAC/B,qDAAqD,CACtD,CAAA;QACH,CAAC;QAED,OAAO,IAAI,CAAC,aAAa,CAAC,qBAAqB,CAAC,QAAQ,CAAC,CAAA;IAC3D,CAAC;IAED,iBAAiB,CAAC,QAAsC;QACtD,OAAO,IAAI,CAAC,aAAa,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAA;IACvD,CAAC;IAED,WAAW,CAAC,QAAsC;QAChD,OAAO,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAA;IACjD,CAAC;IAED,eAAe,CAAC,QAA2C;QAMzD,OAAO,IAAI,CAAC,aAAa,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAA;IACrD,CAAC;CACF;AAjFD,sCAiFC"}

package/dist/services/index.d.ts

@@ -0,0 +1,3 @@
+export { default as FileModuleService } from "./file-module-service";
+export { default as FileProviderService } from "./file-provider-service";
+//# sourceMappingURL=index.d.ts.map

package/dist/services/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/services/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,iBAAiB,EAAE,MAAM,uBAAuB,CAAA;AACpE,OAAO,EAAE,OAAO,IAAI,mBAAmB,EAAE,MAAM,yBAAyB,CAAA"}

package/dist/services/index.js

@@ -0,0 +1,11 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FileProviderService = exports.FileModuleService = void 0;
+var file_module_service_1 = require("./file-module-service");
+Object.defineProperty(exports, "FileModuleService", { enumerable: true, get: function () { return __importDefault(file_module_service_1).default; } });
+var file_provider_service_1 = require("./file-provider-service");
+Object.defineProperty(exports, "FileProviderService", { enumerable: true, get: function () { return __importDefault(file_provider_service_1).default; } });
+//# sourceMappingURL=index.js.map

package/dist/services/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/services/index.ts"],"names":[],"mappings":";;;;;;AAAA,6DAAoE;AAA3D,yIAAA,OAAO,OAAqB;AACrC,iEAAwE;AAA/D,6IAAA,OAAO,OAAuB"}

package/dist/tsconfig.tsbuildinfo

@@ -0,0 +1 @@
+{"root":["../src/index.ts","../src/joiner-config.ts","../src/loaders/providers.ts","../src/services/file-module-service.ts","../src/services/file-provider-service.ts","../src/services/index.ts","../src/services/__tests__/file.spec.ts","../src/types/index.ts"],"version":"5.9.3"}

package/dist/types/index.d.ts

@@ -0,0 +1,29 @@
+import { ModuleProviderExports, ModuleServiceInitializeOptions } from "@acmekit/framework/types";
+export declare const FileProviderIdentifierRegistrationName = "file_providers_identifier";
+export declare const FileProviderRegistrationPrefix = "fs_";
+export type FileModuleOptions = Partial<ModuleServiceInitializeOptions> & {
+    /**
+     * Providers to be registered
+     */
+    provider?: {
+        /**
+         * The module provider to be registered
+         */
+        resolve: string | ModuleProviderExports;
+        /**
+         * The id of the provider
+         */
+        id: string;
+        /**
+         * key value pair of the configuration to be passed to the provider constructor
+         */
+        options?: Record<string, unknown>;
+    };
+};
+declare module "@acmekit/types" {
+    interface ModuleOptions {
+        "@acmekit/file": FileModuleOptions;
+        "@acmekit/acmekit/file": FileModuleOptions;
+    }
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,qBAAqB,EACrB,8BAA8B,EAC/B,MAAM,0BAA0B,CAAA;AAEjC,eAAO,MAAM,sCAAsC,8BACtB,CAAA;AAE7B,eAAO,MAAM,8BAA8B,QAAQ,CAAA;AAEnD,MAAM,MAAM,iBAAiB,GAAG,OAAO,CAAC,8BAA8B,CAAC,GAAG;IACxE;;OAEG;IACH,QAAQ,CAAC,EAAE;QACT;;WAEG;QACH,OAAO,EAAE,MAAM,GAAG,qBAAqB,CAAA;QACvC;;WAEG;QACH,EAAE,EAAE,MAAM,CAAA;QACV;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;KAClC,CAAA;CACF,CAAA;AAED,OAAO,QAAQ,gBAAgB,CAAC;IAC9B,UAAU,aAAa;QACrB,eAAe,EAAE,iBAAiB,CAAA;QAClC,uBAAuB,EAAE,iBAAiB,CAAA;KAC3C;CACF"}

package/dist/types/index.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FileProviderRegistrationPrefix = exports.FileProviderIdentifierRegistrationName = void 0;
+exports.FileProviderIdentifierRegistrationName = "file_providers_identifier";
+exports.FileProviderRegistrationPrefix = "fs_";
+//# sourceMappingURL=index.js.map

package/dist/types/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":";;;AAKa,QAAA,sCAAsC,GACjD,2BAA2B,CAAA;AAEhB,QAAA,8BAA8B,GAAG,KAAK,CAAA"}

package/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "@acmekit/file",
+  "version": "2.13.1",
+  "description": "AcmeKit File module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist",
+    "!dist/**/__tests__",
+    "!dist/**/__mocks__",
+    "!dist/**/__fixtures__"
+  ],
+  "engines": {
+    "node": ">=20"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/acmekit/acmekit",
+    "directory": "packages/modules/file"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "author": "AcmeKit",
+  "license": "MIT",
+  "scripts": {
+    "watch": "yarn run -T tsc --build --watch",
+    "watch:test": "yarn run -T tsc --build tsconfig.spec.json --watch",
+    "resolve:aliases": "yarn run -T tsc --showConfig -p tsconfig.json > tsconfig.resolved.json && yarn run -T tsc-alias -p tsconfig.resolved.json && yarn run -T rimraf tsconfig.resolved.json",
+    "build": "yarn run -T rimraf dist && yarn run -T tsc --build && npm run resolve:aliases",
+    "test": "../../../node_modules/.bin/jest --passWithNoTests --bail --forceExit --testPathPattern=src",
+    "test:integration": "../../../node_modules/.bin/jest --passWithNoTests --forceExit --testPathPattern=\"integration-tests/__tests__/.*\\.ts\"",
+    "migration:initial": "MIKRO_ORM_CLI_CONFIG=./mikro-orm.config.dev.ts MIKRO_ORM_ALLOW_GLOBAL_CLI=true acmekit-mikro-orm migration:create --initial",
+    "migration:create": "MIKRO_ORM_CLI_CONFIG=./mikro-orm.config.dev.ts MIKRO_ORM_ALLOW_GLOBAL_CLI=true acmekit-mikro-orm migration:create",
+    "migration:up": "MIKRO_ORM_CLI_CONFIG=./mikro-orm.config.dev.ts MIKRO_ORM_ALLOW_GLOBAL_CLI=true acmekit-mikro-orm migration:up",
+    "orm:cache:clear": "MIKRO_ORM_CLI_CONFIG=./mikro-orm.config.dev.ts MIKRO_ORM_ALLOW_GLOBAL_CLI=true acmekit-mikro-orm cache:clear"
+  },
+  "devDependencies": {
+    "@acmekit/framework": "2.13.1",
+    "@acmekit/test-utils": "2.13.1"
+  },
+  "peerDependencies": {
+    "@acmekit/framework": "2.13.1"
+  }
+}