@acmekit/types 2.13.1

package/dist/file/provider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"provider.d.ts","sourceRoot":"","sources":["../../src/file/provider.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,QAAQ,CAAA;AAC3C,OAAO,EAAE,oBAAoB,EAAE,MAAM,UAAU,CAAA;AAE/C;;;;GAIG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC;;;OAGG;IACH,GAAG,EAAE,MAAM,CAAA;IACX;;;;;;;OAOG;IACH,GAAG,EAAE,MAAM,CAAA;CACZ,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;;;;;;OAOG;IACH,OAAO,EAAE,MAAM,CAAA;IACf,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAA;CACrB,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAA;IACf,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAA;CACrB,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAA;IAEf;;OAEG;IACH,MAAM,CAAC,EAAE,oBAAoB,CAAA;CAC9B,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,gCAAgC,GAAG;IAC7C;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IAEjB;;OAEG;IACH,MAAM,CAAC,EAAE,oBAAoB,CAAA;IAE7B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,uBAAuB,GAAG;IACpC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,oBAAoB,CAAA;CAC9B,CAAA;AAED,MAAM,WAAW,aAAa;IAC5B;;;;;;;OAOG;IACH,MAAM,CAAC,IAAI,EAAE,qBAAqB,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAAA;IAEnE;;;;;;OAMG;IACH,MAAM,CACJ,QAAQ,EAAE,qBAAqB,GAAG,qBAAqB,EAAE,GACxD,OAAO,CAAC,IAAI,CAAC,CAAA;IAEhB;;;;;;;;OAQG;IACH,uBAAuB,CAAC,QAAQ,EAAE,kBAAkB,GAAG,OAAO,CAAC,MAAM,CAAC,CAAA;IAEtE;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,qBAAqB,CAAC,CACpB,QAAQ,EAAE,gCAAgC,GACzC,OAAO,CAAC,qBAAqB,CAAC,CAAA;IAEjC;;OAEG;IACH,iBAAiB,CAAC,QAAQ,EAAE,kBAAkB,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAA;IAElE;;OAEG;IACH,WAAW,CAAC,QAAQ,EAAE,kBAAkB,GAAG,OAAO,CAAC,MAAM,CAAC,CAAA;IAE1D;;OAEG;IACH,eAAe,CAAC,QAAQ,EAAE,uBAAuB,GAAG,OAAO,CAAC;QAC1D,WAAW,EAAE,QAAQ,CAAA;QACrB,OAAO,EAAE,OAAO,CAAC,qBAAqB,CAAC,CAAA;QACvC,GAAG,EAAE,MAAM,CAAA;QACX,OAAO,EAAE,MAAM,CAAA;KAChB,CAAC,CAAA;CACH"}

package/dist/file/provider.js

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

package/dist/file/provider.js.map

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

package/dist/file/providers/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./s3";
+export * from "./local";
+//# sourceMappingURL=index.d.ts.map

package/dist/file/providers/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/file/providers/index.ts"],"names":[],"mappings":"AAAA,cAAc,MAAM,CAAA;AACpB,cAAc,SAAS,CAAA"}

package/dist/file/providers/index.js

@@ -0,0 +1,19 @@
+"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("./s3"), exports);
+__exportStar(require("./local"), exports);
+//# sourceMappingURL=index.js.map

package/dist/file/providers/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/file/providers/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,uCAAoB;AACpB,0CAAuB"}

package/dist/file/providers/local.d.ts

@@ -0,0 +1,6 @@
+export interface LocalFileServiceOptions {
+    upload_dir?: string;
+    private_upload_dir?: string;
+    backend_url?: string;
+}
+//# sourceMappingURL=local.d.ts.map

package/dist/file/providers/local.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"local.d.ts","sourceRoot":"","sources":["../../../src/file/providers/local.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,uBAAuB;IACtC,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,kBAAkB,CAAC,EAAE,MAAM,CAAA;IAC3B,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB"}

package/dist/file/providers/local.js

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

package/dist/file/providers/local.js.map

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

package/dist/file/providers/s3.d.ts

@@ -0,0 +1,14 @@
+export interface S3FileServiceOptions {
+    file_url: string;
+    access_key_id?: string;
+    secret_access_key?: string;
+    authentication_method?: "access-key" | "s3-iam-role";
+    region: string;
+    bucket: string;
+    prefix?: string;
+    endpoint?: string;
+    cache_control?: string;
+    download_file_duration?: number;
+    additional_client_config?: Record<string, any>;
+}
+//# sourceMappingURL=s3.d.ts.map

package/dist/file/providers/s3.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"s3.d.ts","sourceRoot":"","sources":["../../../src/file/providers/s3.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,oBAAoB;IACnC,QAAQ,EAAE,MAAM,CAAA;IAChB,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,iBAAiB,CAAC,EAAE,MAAM,CAAA;IAC1B,qBAAqB,CAAC,EAAE,YAAY,GAAG,aAAa,CAAA;IACpD,MAAM,EAAE,MAAM,CAAA;IACd,MAAM,EAAE,MAAM,CAAA;IACd,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,sBAAsB,CAAC,EAAE,MAAM,CAAA;IAC/B,wBAAwB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CAC/C"}

package/dist/file/providers/s3.js

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

package/dist/file/providers/s3.js.map

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

package/dist/file/service.d.ts

@@ -0,0 +1,182 @@
+import type { Writable } from "stream";
+import { Readable } from "stream";
+import { FindConfig } from "../common";
+import { IModuleService } from "../modules-sdk";
+import { Context } from "../shared-context";
+import { FileDTO, FilterableFileProps, UploadFileUrlDTO } from "./common";
+import { CreateFileDTO, GetUploadFileUrlDTO } from "./mutations";
+import { IFileProvider, ProviderFileResultDTO, ProviderUploadStreamDTO } from "./provider";
+export interface IFileModuleService extends IModuleService {
+    /**
+     * This method returns the service of the configured File Module Provider in `acmekit-config.ts`. This is useful
+     * if you want to execute custom methods defined in the provider's service or you need direct access to it.
+     *
+     * @returns {IFileProvider} An instance of the File Module Provider's service.
+     *
+     * @example
+     * const s3ProviderService = fileModuleService.getProvider()
+     * // TODO: perform custom actions with the provider
+     */
+    getProvider(): IFileProvider;
+    /**
+     * This method uploads files to the designated file storage system.
+     *
+     * @param {CreateFileDTO[]} data - The files to be created.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<FileDTO[]>} The created files.
+     *
+     * @example
+     * const [file] = await fileModuleService.createFiles([{
+     *   filename: "product.png",
+     *   mimeType: "image/png",
+     *   content: "somecontent" // base64 string
+     * }])
+     */
+    createFiles(data: CreateFileDTO[], sharedContext?: Context): Promise<FileDTO[]>;
+    /**
+     * This method uploads a file to the designated file storage system.
+     *
+     * @param {CreateFileDTO} data - The file to be created.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<FileDTO>} The created file.
+     *
+     * @example
+     * const file = await fileModuleService.createFiles({
+     *   filename: "product.png",
+     *   mimeType: "image/png",
+     *   content: "somecontent" // base64 string
+     * })
+     */
+    createFiles(data: CreateFileDTO, sharedContext?: Context): Promise<FileDTO>;
+    /**
+     * This method gets the upload URL for a file.
+     *
+     * @param {GetUploadFileUrlDTO} data - The file information to get the upload URL for.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<UploadFileUrlDTO>} The upload URL for the file.
+     *
+     * @example
+     * const uploadInfo = await fileModuleService.getUploadFileUrls({
+     *   filename: "product.png",
+     *   mimeType: "image/png",
+     * })
+     */
+    getUploadFileUrls(data: GetUploadFileUrlDTO, sharedContext?: Context): Promise<UploadFileUrlDTO>;
+    /**
+     * This method uploads files to the designated file storage system.
+     *
+     * @param {GetUploadFileUrlDTO[]} data - The file information to get the upload URL for.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<UploadFileUrlDTO[]>} The upload URLs for the files.
+     *
+     * @example
+     * const [uploadInfo] = await fileModuleService.getUploadFileUrls([{
+     *   filename: "product.png",
+     *   mimeType: "image/png",
+     * }])
+     */
+    getUploadFileUrls(data: GetUploadFileUrlDTO[], sharedContext?: Context): Promise<UploadFileUrlDTO[]>;
+    /**
+     * This method deletes files by their IDs.
+     *
+     * @param {string[]} ids - The IDs of the files.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<void>} Resolves when the files are deleted successfully.
+     *
+     * @example
+     * await fileModuleService.deleteFiles(["file_123"])
+     */
+    deleteFiles(ids: string[], sharedContext?: Context): Promise<void>;
+    /**
+     * This method deletes a file by its ID.
+     *
+     * @param {string} id - The ID of the file.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<void>} Resolves when the file is deleted successfully.
+     *
+     * @example
+     * await fileModuleService.deleteFiles("file_123")
+     */
+    deleteFiles(id: string, sharedContext?: Context): Promise<void>;
+    /**
+     * This method retrieves a file with a downloadable URL by its ID.
+     *
+     * @param {string} id - The ID of the file.
+     * @param {FindConfig<FileDTO>} config - The configurations determining how the file is retrieved. Its properties, such as `select` or `relations`, accept the
+     * attributes or relations associated with a file.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<FileDTO>} The retrieved file.
+     *
+     * @example
+     * const file = await fileModuleService.retrieveFile("file_123")
+     */
+    retrieveFile(id: string, config?: FindConfig<FileDTO>, sharedContext?: Context): Promise<FileDTO>;
+    /**
+     * This method is used to list files. It only supports filtering by ID.
+     *
+     * @param {FilterableFileProps} filters - The filters to apply on the retrieved files.
+     * @param {FindConfig<FileDTO>} config -
+     * The configurations determining how the files are retrieved. Its properties, such as `select` or `relations`, accept the
+     * attributes or relations associated with a file.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<FileDTO[]>} The list of files.
+     *
+     * @example
+     * const files = await fileModuleService.listFiles({ id: ["file_123", "file_456"] })
+     */
+    listFiles(filters?: FilterableFileProps, config?: FindConfig<FileDTO>, sharedContext?: Context): Promise<FileDTO[]>;
+    /**
+     * This method is used to list files and their count. It only supports filtering by ID.
+     *
+     * @param {FilterableFileProps} filters - The filters to apply on the retrieved files.
+     * @param {FindConfig<FileDTO>} config -
+     * The configurations determining how the files are retrieved. Its properties, such as `select` or `relations`, accept the
+     * attributes or relations associated with a file.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<[FileDTO[], number]>} The list of files and their count.
+     *
+     * @example
+     * const [files] = await fileModuleService.listAndCountFiles({ id: "file_123" })
+     */
+    listAndCountFiles(filters?: FilterableFileProps, config?: FindConfig<FileDTO>, sharedContext?: Context): Promise<[FileDTO[], number]>;
+    /**
+     * This method retrieves a file by its ID and returns a stream to download the file. Under the hood, it will use the
+     * file provider that was used to upload the file to retrievethe stream.
+     *
+     * @since 2.8.0
+     *
+     * @param {string} id - The ID of the file.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<Readable>} A readable stream of the file contents.
+     *
+     * @example
+     * const stream = await fileModuleService.getDownloadStream("file_123")
+     * writeable.pipe(stream)
+     */
+    getDownloadStream(id: string, sharedContext?: Context): Promise<Readable>;
+    /**
+     * This method retrieves a file by its ID and returns the file contents as a buffer. Under the hood, it will use the
+     * file provider that was used to upload the file to retrieve the buffer.
+     *
+     * @since 2.8.0
+     *
+     * @param {string} id - The ID of the file.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<Buffer>} A buffer of the file contents.
+     *
+     * @example
+     * const contents = await fileModuleService.getAsBuffer("file_123")
+     * contents.toString('utf-8')
+     */
+    getAsBuffer(id: string, sharedContext?: Context): Promise<Buffer>;
+    /**
+     * Get a writeable stream to upload a file.
+     */
+    getUploadStream(fileData: ProviderUploadStreamDTO): Promise<{
+        writeStream: Writable;
+        promise: Promise<ProviderFileResultDTO>;
+        url: string;
+        fileKey: string;
+    }>;
+}
+//# sourceMappingURL=service.d.ts.map

package/dist/file/service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"service.d.ts","sourceRoot":"","sources":["../../src/file/service.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,QAAQ,CAAA;AACtC,OAAO,EAAE,QAAQ,EAAE,MAAM,QAAQ,CAAA;AACjC,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAA;AACtC,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAA;AAC/C,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAC3C,OAAO,EAAE,OAAO,EAAE,mBAAmB,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAA;AACzE,OAAO,EAAE,aAAa,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAA;AAChE,OAAO,EACL,aAAa,EACb,qBAAqB,EACrB,uBAAuB,EACxB,MAAM,YAAY,CAAA;AAEnB,MAAM,WAAW,kBAAmB,SAAQ,cAAc;IACxD;;;;;;;;;OASG;IACH,WAAW,IAAI,aAAa,CAAA;IAE5B;;;;;;;;;;;;;OAaG;IACH,WAAW,CACT,IAAI,EAAE,aAAa,EAAE,EACrB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,OAAO,EAAE,CAAC,CAAA;IAErB;;;;;;;;;;;;;OAaG;IAEH,WAAW,CAAC,IAAI,EAAE,aAAa,EAAE,aAAa,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;IAE3E;;;;;;;;;;;;OAYG;IAEH,iBAAiB,CACf,IAAI,EAAE,mBAAmB,EACzB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,gBAAgB,CAAC,CAAA;IAE5B;;;;;;;;;;;;OAYG;IACH,iBAAiB,CACf,IAAI,EAAE,mBAAmB,EAAE,EAC3B,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAAA;IAE9B;;;;;;;;;OASG;IACH,WAAW,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE,aAAa,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAElE;;;;;;;;;OASG;IACH,WAAW,CAAC,EAAE,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAE/D;;;;;;;;;;;OAWG;IACH,YAAY,CACV,EAAE,EAAE,MAAM,EACV,MAAM,CAAC,EAAE,UAAU,CAAC,OAAO,CAAC,EAC5B,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,OAAO,CAAC,CAAA;IAEnB;;;;;;;;;;;;OAYG;IACH,SAAS,CACP,OAAO,CAAC,EAAE,mBAAmB,EAC7B,MAAM,CAAC,EAAE,UAAU,CAAC,OAAO,CAAC,EAC5B,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,OAAO,EAAE,CAAC,CAAA;IAErB;;;;;;;;;;;;OAYG;IACH,iBAAiB,CACf,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,CAAA;IAE/B;;;;;;;;;;;;;OAaG;IACH,iBAAiB,CAAC,EAAE,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAA;IAEzE;;;;;;;;;;;;;OAaG;IACH,WAAW,CAAC,EAAE,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,CAAA;IAEjE;;OAEG;IACH,eAAe,CAAC,QAAQ,EAAE,uBAAuB,GAAG,OAAO,CAAC;QAC1D,WAAW,EAAE,QAAQ,CAAA;QACrB,OAAO,EAAE,OAAO,CAAC,qBAAqB,CAAC,CAAA;QACvC,GAAG,EAAE,MAAM,CAAA;QACX,OAAO,EAAE,MAAM,CAAA;KAChB,CAAC,CAAA;CACH"}

package/dist/file/service.js

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

package/dist/file/service.js.map

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

package/dist/file-service/index.d.ts

@@ -0,0 +1,91 @@
+import stream from "stream";
+/**
+ * @interface
+ *
+ * Details of a file upload's result.
+ */
+export type FileServiceUploadResult = {
+    /**
+     * The file's URL.
+     */
+    url: string;
+    /**
+     * The file's key. This key is used in other operations,
+     * such as deleting a file.
+     */
+    key: string;
+};
+/**
+ * @interface
+ *
+ * The relevant details to upload a file through a stream.
+ */
+export type FileServiceGetUploadStreamResult = {
+    /**
+     * A [PassThrough](https://nodejs.org/api/stream.html#class-streampassthrough) write stream object to be used to write the file.
+     */
+    writeStream: stream.PassThrough;
+    /**
+     * A promise that should resolved when the writing process is done to finish the upload.
+     */
+    promise: Promise<any>;
+    /**
+     * The URL of the file once it’s uploaded.
+     */
+    url: string;
+    /**
+     * The identifier of the file in the storage. For example, for a local file service, this can be the file's name.
+     */
+    fileKey: string;
+    [x: string]: unknown;
+};
+/**
+ * @interface
+ *
+ * The details of a file to retrieve.
+ */
+export type GetUploadedFileType = {
+    /**
+     * The file's key.
+     */
+    fileKey: string;
+    /**
+     * Whether the file is private.
+     */
+    isPrivate?: boolean;
+    [x: string]: unknown;
+};
+/**
+ * @interface
+ *
+ * The details of the file to remove.
+ */
+export type DeleteFileType = {
+    /**
+     * The file's key. When uploading a file, the
+     * returned key is used here.
+     */
+    fileKey: string;
+    [x: string]: unknown;
+};
+/**
+ * @interface
+ *
+ * The details of the file being uploaded through a stream.
+ */
+export type UploadStreamDescriptorType = {
+    /**
+     * The name of the file.
+     */
+    name: string;
+    /**
+     * The extension of the file.
+     */
+    ext?: string;
+    /**
+     * Whether the file should be uploaded to a private bucket or location. By convention, the default value of this property is `true`.
+     */
+    isPrivate?: boolean;
+    [x: string]: unknown;
+};
+//# sourceMappingURL=index.d.ts.map

package/dist/file-service/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/file-service/index.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,MAAM,QAAQ,CAAA;AAE3B;;;;GAIG;AACH,MAAM,MAAM,uBAAuB,GAAG;IACpC;;OAEG;IACH,GAAG,EAAE,MAAM,CAAA;IACX;;;OAGG;IACH,GAAG,EAAE,MAAM,CAAA;CACZ,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,gCAAgC,GAAG;IAC7C;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC,WAAW,CAAA;IAC/B;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,CAAA;IACrB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAA;IACX;;OAEG;IACH,OAAO,EAAE,MAAM,CAAA;IACf,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAA;CACrB,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAA;IACf;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAA;IACnB,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAA;CACrB,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAA;IACf,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAA;CACrB,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,0BAA0B,GAAG;IACvC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IACZ;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAA;IACnB,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAA;CACrB,CAAA"}

package/dist/file-service/index.js

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

package/dist/file-service/index.js.map

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

package/dist/fulfillment/common/address.d.ts

@@ -0,0 +1,70 @@
+/**
+ * The fulfillment address details.
+ */
+export interface FulfillmentAddressDTO {
+    /**
+     * The ID of the address.
+     */
+    id: string;
+    /**
+     * The associated fulfillment's ID.
+     */
+    fulfillment_id: string | null;
+    /**
+     * The company of the address.
+     */
+    company: string | null;
+    /**
+     * The first name of the address.
+     */
+    first_name: string | null;
+    /**
+     * The last name of the address.
+     */
+    last_name: string | null;
+    /**
+     * The first line of the address.
+     */
+    address_1: string | null;
+    /**
+     * The second line of the address.
+     */
+    address_2: string | null;
+    /**
+     * The city of the address.
+     */
+    city: string | null;
+    /**
+     * The ISO 2 character country code of the address.
+     */
+    country_code: string | null;
+    /**
+     * The lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province of the address.
+     */
+    province: string | null;
+    /**
+     * The postal code of the address.
+     */
+    postal_code: string | null;
+    /**
+     * The phone of the address.
+     */
+    phone: string | null;
+    /**
+     * Holds custom data in key-value pairs.
+     */
+    metadata: Record<string, unknown> | null;
+    /**
+     * The creation date of the address.
+     */
+    created_at: Date;
+    /**
+     * The update date of the address.
+     */
+    updated_at: Date;
+    /**
+     * The deletion date of the address.
+     */
+    deleted_at: Date | null;
+}
+//# sourceMappingURL=address.d.ts.map

package/dist/fulfillment/common/address.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"address.d.ts","sourceRoot":"","sources":["../../../src/fulfillment/common/address.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAA;IAE7B;;OAEG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAA;IAEtB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IAEzB;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IAExB;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IAExB;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IAExB;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;IAEnB;;OAEG;IACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAA;IAE3B;;OAEG;IACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IAEvB;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAA;IAE1B;;OAEG;IACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;IAEpB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IAExC;;OAEG;IACH,UAAU,EAAE,IAAI,CAAA;IAEhB;;OAEG;IACH,UAAU,EAAE,IAAI,CAAA;IAEhB;;OAEG;IACH,UAAU,EAAE,IAAI,GAAG,IAAI,CAAA;CACxB"}

package/dist/fulfillment/common/address.js

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

package/dist/fulfillment/common/address.js.map

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

package/dist/fulfillment/common/cart.d.ts

@@ -0,0 +1,89 @@
+import { CartDTO } from "../..";
+/**
+ * A cart's details relevant for fulfillment.
+ */
+export type CartPropsForFulfillment = {
+    /**
+     * The cart's ID.
+     */
+    id: CartDTO["id"];
+    /**
+     * The cart's shipping address.
+     */
+    shipping_address: CartDTO["shipping_address"];
+    /**
+     * The cart's items
+     */
+    items: CartDTO["items"] & {
+        /**
+         * The item's variant.
+         */
+        variant: {
+            /**
+             * The variant's ID.
+             */
+            id: string;
+            /**
+             * The variant's weight.
+             */
+            weight: number;
+            /**
+             * The variant's length.
+             */
+            length: number;
+            /**
+             * The variant's height.
+             */
+            height: number;
+            /**
+             * The variant's width.
+             */
+            width: number;
+            /**
+             * The variant's material.
+             */
+            material: string;
+            /**
+             * The variant's associated product.
+             */
+            product: {
+                /**
+                 * The product's ID.
+                 */
+                id: string;
+            };
+        };
+        /**
+         * The item's product.
+         */
+        product: {
+            /**
+             * The product's ID.
+             */
+            id: string;
+            /**
+             * The ID of the collection that the product belongs to.
+             */
+            collection_id: string;
+            /**
+             * The product's categories.
+             */
+            categories: {
+                /**
+                 * The category's ID.
+                 */
+                id: string;
+            }[];
+            /**
+             * The product's tags.
+             */
+            tags: {
+                /**
+                 * The tag's ID.
+                 */
+                id: string;
+            }[];
+        };
+    };
+};
+//# sourceMappingURL=cart.d.ts.map

package/dist/fulfillment/common/cart.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cart.d.ts","sourceRoot":"","sources":["../../../src/fulfillment/common/cart.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,OAAO,CAAA;AAE/B;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG;IACpC;;OAEG;IACH,EAAE,EAAE,OAAO,CAAC,IAAI,CAAC,CAAA;IACjB;;OAEG;IACH,gBAAgB,EAAE,OAAO,CAAC,kBAAkB,CAAC,CAAA;IAC7C;;OAEG;IACH,KAAK,EAAE,OAAO,CAAC,OAAO,CAAC,GAAG;QACxB;;WAEG;QACH,OAAO,EAAE;YACP;;eAEG;YACH,EAAE,EAAE,MAAM,CAAA;YACV;;eAEG;YACH,MAAM,EAAE,MAAM,CAAA;YACd;;eAEG;YACH,MAAM,EAAE,MAAM,CAAA;YACd;;eAEG;YACH,MAAM,EAAE,MAAM,CAAA;YACd;;eAEG;YACH,KAAK,EAAE,MAAM,CAAA;YACb;;eAEG;YACH,QAAQ,EAAE,MAAM,CAAA;YAChB;;eAEG;YACH,OAAO,EAAE;gBACP;;mBAEG;gBACH,EAAE,EAAE,MAAM,CAAA;aACX,CAAA;SACF,CAAA;QACD;;WAEG;QACH,OAAO,EAAE;YACP;;eAEG;YACH,EAAE,EAAE,MAAM,CAAA;YACV;;eAEG;YACH,aAAa,EAAE,MAAM,CAAA;YACrB;;eAEG;YACH,UAAU,EAAE;gBACV;;mBAEG;gBACH,EAAE,EAAE,MAAM,CAAA;aACX,EAAE,CAAA;YACH;;eAEG;YACH,IAAI,EAAE;gBACJ;;mBAEG;gBACH,EAAE,EAAE,MAAM,CAAA;aACX,EAAE,CAAA;SACJ,CAAA;KACF,CAAA;CACF,CAAA"}

package/dist/fulfillment/common/cart.js

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

package/dist/fulfillment/common/cart.js.map

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

package/dist/fulfillment/common/fulfillment-item.d.ts

@@ -0,0 +1,55 @@
+import { FulfillmentDTO } from "./fulfillment";
+/**
+ * The fulfillment item details.
+ */
+export interface FulfillmentItemDTO {
+    /**
+     * The ID of the fulfillment item.
+     */
+    id: string;
+    /**
+     * The title of the fulfillment item.
+     */
+    title: string;
+    /**
+     * The quantity of the fulfillment item.
+     */
+    quantity: number;
+    /**
+     * The sku of the fulfillment item.
+     */
+    sku: string;
+    /**
+     * The barcode of the fulfillment item.
+     */
+    barcode: string;
+    /**
+     * The associated line item's ID.
+     */
+    line_item_id: string | null;
+    /**
+     * The associated inventory item's ID.
+     */
+    inventory_item_id: string | null;
+    /**
+     * The associated fulfillment's ID.
+     */
+    fulfillment_id: string;
+    /**
+     * The associated fulfillment.
+     */
+    fulfillment: FulfillmentDTO;
+    /**
+     * The creation date of the fulfillment item.
+     */
+    created_at: Date;
+    /**
+     * The update date of the fulfillment item.
+     */
+    updated_at: Date;
+    /**
+     * The deletion date of the fulfillment item.
+     */
+    deleted_at: Date | null;
+}
+//# sourceMappingURL=fulfillment-item.d.ts.map

package/dist/fulfillment/common/fulfillment-item.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fulfillment-item.d.ts","sourceRoot":"","sources":["../../../src/fulfillment/common/fulfillment-item.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,eAAe,CAAA;AAE9C;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAA;IAEX;;OAEG;IACH,OAAO,EAAE,MAAM,CAAA;IAEf;;OAEG;IACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAA;IAE3B;;OAEG;IACH,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAA;IAEhC;;OAEG;IACH,cAAc,EAAE,MAAM,CAAA;IAEtB;;OAEG;IACH,WAAW,EAAE,cAAc,CAAA;IAE3B;;OAEG;IACH,UAAU,EAAE,IAAI,CAAA;IAEhB;;OAEG;IACH,UAAU,EAAE,IAAI,CAAA;IAEhB;;OAEG;IACH,UAAU,EAAE,IAAI,GAAG,IAAI,CAAA;CACxB"}

package/dist/fulfillment/common/fulfillment-item.js

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

package/dist/fulfillment/common/fulfillment-item.js.map

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