@acmekit/types 2.13.1

package/dist/event-bus/common.d.ts

@@ -0,0 +1,58 @@
+import { Context } from "../shared-context";
+export type Subscriber<TData = unknown> = (data: Event<TData>) => Promise<void>;
+export type SubscriberContext = {
+    /**
+     * The ID of the subscriber. Useful when retrying failed subscribers.
+     */
+    subscriberId: string;
+};
+export type SubscriberDescriptor = {
+    id: string;
+    subscriber: Subscriber;
+};
+export type EventMetadata = Record<string, unknown> & {
+    /**
+     * The ID of the event's group. Grouped events are useful when you have distributed transactions
+     * where you need to explicitly group, release and clear events upon lifecycle events of a transaction.
+     *
+     * When set, you must release the grouped events using the Event Module's `releaseGroupedEvents` method to emit the events.
+     */
+    eventGroupId?: string;
+};
+export type Event<TData = unknown> = {
+    /**
+     * The event's name.
+     *
+     * @example
+     * user.created
+     */
+    name: string;
+    /**
+     * Additional meadata to pass with the event.
+     */
+    metadata?: EventMetadata;
+    /**
+     * The data payload that subscribers receive. For example, the ID or IDs of the created user. (e.g. { id: "123" } or { ids: ["123", "456"] })
+     */
+    data: TData;
+};
+/**
+ * The details of an event to emit.
+ */
+export type Message<TData = unknown> = Event<TData> & {
+    options?: Record<string, unknown>;
+};
+export type RawMessageFormat<TData = any> = {
+    eventName: string;
+    data: TData;
+    source: string;
+    object: string;
+    action?: string;
+    context?: Pick<Context, "eventGroupId">;
+    options?: Record<string, any>;
+};
+export type InterceptorSubscriber<T = unknown> = (message: Message<T>, context?: {
+    isGrouped?: boolean;
+    eventGroupId?: string;
+}) => Promise<void> | void;
+//# sourceMappingURL=common.d.ts.map

package/dist/event-bus/common.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../../src/event-bus/common.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAwB3C,MAAM,MAAM,UAAU,CAAC,KAAK,GAAG,OAAO,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,KAAK,CAAC,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;AAE/E,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;OAEG;IACH,YAAY,EAAE,MAAM,CAAA;CACrB,CAAA;AAED,MAAM,MAAM,oBAAoB,GAAG;IACjC,EAAE,EAAE,MAAM,CAAA;IACV,UAAU,EAAE,UAAU,CAAA;CACvB,CAAA;AAED,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG;IACpD;;;;;OAKG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB,CAAA;AAED,MAAM,MAAM,KAAK,CAAC,KAAK,GAAG,OAAO,IAAI;IACnC;;;;;OAKG;IACH,IAAI,EAAE,MAAM,CAAA;IACZ;;OAEG;IACH,QAAQ,CAAC,EAAE,aAAa,CAAA;IACxB;;OAEG;IACH,IAAI,EAAE,KAAK,CAAA;CACZ,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,OAAO,CAAC,KAAK,GAAG,OAAO,IAAI,KAAK,CAAC,KAAK,CAAC,GAAG;IACpD,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAClC,CAAA;AAED,MAAM,MAAM,gBAAgB,CAAC,KAAK,GAAG,GAAG,IAAI;IAC1C,SAAS,EAAE,MAAM,CAAA;IACjB,IAAI,EAAE,KAAK,CAAA;IACX,MAAM,EAAE,MAAM,CAAA;IACd,MAAM,EAAE,MAAM,CAAA;IACd,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,OAAO,CAAC,EAAE,IAAI,CAAC,OAAO,EAAE,cAAc,CAAC,CAAA;IACvC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CAC9B,CAAA;AAED,MAAM,MAAM,qBAAqB,CAAC,CAAC,GAAG,OAAO,IAAI,CAC/C,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,EACnB,OAAO,CAAC,EAAE;IAAE,SAAS,CAAC,EAAE,OAAO,CAAC;IAAC,YAAY,CAAC,EAAE,MAAM,CAAA;CAAE,KACrD,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAA"}

package/dist/event-bus/common.js

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

package/dist/event-bus/common.js.map

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

package/dist/event-bus/event-bus-module.d.ts

@@ -0,0 +1,97 @@
+import { InterceptorSubscriber, Message, Subscriber, SubscriberContext } from "./common";
+export interface IEventBusModuleService {
+    /**
+     * This method emits one or more events. Subscribers listening to the event(s) are executed asynchronously.
+     *
+     * @param data - The details of the events to emit.
+     * @param options - Additional options for the event.
+     *
+     * @example
+     * await eventModuleService.emit({
+     *   name: "user.created",
+     *   data: {
+     *     user_id: "user_123"
+     *   }
+     * })
+     */
+    emit<T>(data: Message<T> | Message<T>[], options?: Record<string, unknown>): Promise<void>;
+    /**
+     * This method adds a subscriber to an event. It's mainly used internally to register subscribers.
+     *
+     * @param eventName - The name of the event to subscribe to.
+     * @param subscriber - The subscriber function to execute when the event is emitted.
+     * @param context - The context of the subscriber.
+     * @returns The instance of the Event Module
+     *
+     * @example
+     * eventModuleService.subscribe("user.created", async (data) => {
+     *   console.log("User created", data)
+     * })
+     */
+    subscribe(eventName: string | symbol, subscriber: Subscriber, context?: SubscriberContext): this;
+    /**
+     * This method removes a subscriber from an event. It's mainly used internally to unregister subscribers.
+     *
+     * @param eventName - The name of the event to unsubscribe from.
+     * @param subscriber - The subscriber function to remove.
+     * @param context - The context of the subscriber.
+     * @returns The instance of the Event Module
+     *
+     * @example
+     * eventModuleService.unsubscribe("user.created", async (data) => {
+     *   console.log("User created", data)
+     * })
+     */
+    unsubscribe(eventName: string | symbol, subscriber: Subscriber, context?: SubscriberContext): this;
+    /**
+     * This method emits all events in the specified group. Grouped events are useful when you have distributed transactions
+     * where you need to explicitly group, release and clear events upon lifecycle events of a transaction.
+     *
+     * @param eventGroupId - The ID of the event group.
+     *
+     * @example
+     * await eventModuleService.releaseGroupedEvents("group_123")
+     */
+    releaseGroupedEvents(eventGroupId: string): Promise<void>;
+    /**
+     * This method removes all events in the specified group. Grouped events are useful when you have distributed transactions
+     * where you need to explicitly group, release and clear events upon lifecycle events of a transaction.
+     *
+     * @param eventGroupId - The ID of the event group.
+     * @param options - Additional options for the event.
+     * @param options.eventNames - The names of the events to clear. If not provided, The group will
+     * be entirely cleared.
+     *
+     * @example
+     * await eventModuleService.clearGroupedEvents("group_123")
+     */
+    clearGroupedEvents(eventGroupId: string, options?: {
+        eventNames?: string[];
+    }): Promise<void>;
+    /**
+     * This method adds an interceptor to the event bus. This means that the interceptor will be
+     * called before the event is emitted.
+     *
+     * @param interceptor - The interceptor to add.
+     * @returns The instance of the Event Module
+     *
+     * @example
+     * eventModuleService.addInterceptor((message, context) => {
+     *   console.log("Interceptor", message, context)
+     * })
+     */
+    addInterceptor?(interceptor: InterceptorSubscriber): this;
+    /**
+     * This method removes an interceptor from the event bus.
+     *
+     * @param interceptor - The interceptor to remove.
+     * @returns The instance of the Event Module
+     *
+     * @example
+     * eventModuleService.removeInterceptor((message, context) => {
+     *   console.log("Interceptor", message, context)
+     * })
+     */
+    removeInterceptor?(interceptor: InterceptorSubscriber): this;
+}
+//# sourceMappingURL=event-bus-module.d.ts.map

package/dist/event-bus/event-bus-module.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"event-bus-module.d.ts","sourceRoot":"","sources":["../../src/event-bus/event-bus-module.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,qBAAqB,EACrB,OAAO,EACP,UAAU,EACV,iBAAiB,EAClB,MAAM,UAAU,CAAA;AAEjB,MAAM,WAAW,sBAAsB;IACrC;;;;;;;;;;;;;OAaG;IACH,IAAI,CAAC,CAAC,EACJ,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,EAAE,EAC/B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAChC,OAAO,CAAC,IAAI,CAAC,CAAA;IAEhB;;;;;;;;;;;;OAYG;IACH,SAAS,CACP,SAAS,EAAE,MAAM,GAAG,MAAM,EAC1B,UAAU,EAAE,UAAU,EACtB,OAAO,CAAC,EAAE,iBAAiB,GAC1B,IAAI,CAAA;IAEP;;;;;;;;;;;;OAYG;IACH,WAAW,CACT,SAAS,EAAE,MAAM,GAAG,MAAM,EAC1B,UAAU,EAAE,UAAU,EACtB,OAAO,CAAC,EAAE,iBAAiB,GAC1B,IAAI,CAAA;IAEP;;;;;;;;OAQG;IACH,oBAAoB,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IACzD;;;;;;;;;;;OAWG;IACH,kBAAkB,CAChB,YAAY,EAAE,MAAM,EACpB,OAAO,CAAC,EAAE;QACR,UAAU,CAAC,EAAE,MAAM,EAAE,CAAA;KACtB,GACA,OAAO,CAAC,IAAI,CAAC,CAAA;IAEhB;;;;;;;;;;;OAWG;IACH,cAAc,CAAC,CAAC,WAAW,EAAE,qBAAqB,GAAG,IAAI,CAAA;IAEzD;;;;;;;;;;OAUG;IACH,iBAAiB,CAAC,CAAC,WAAW,EAAE,qBAAqB,GAAG,IAAI,CAAA;CAC7D"}

package/dist/event-bus/event-bus-module.js

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

package/dist/event-bus/event-bus-module.js.map

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

package/dist/event-bus/event-bus.d.ts

@@ -0,0 +1,8 @@
+import { ITransactionBaseService } from "../transaction-base";
+import { Message, Subscriber, SubscriberContext } from "./common";
+export interface IEventBusService extends ITransactionBaseService {
+    subscribe(eventName: string | symbol, subscriber: Subscriber, context?: SubscriberContext): this;
+    unsubscribe(eventName: string | symbol, subscriber: Subscriber, context?: SubscriberContext): this;
+    emit<T>(data: Message<T> | Message<T>[]): Promise<unknown | void>;
+}
+//# sourceMappingURL=event-bus.d.ts.map

package/dist/event-bus/event-bus.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"event-bus.d.ts","sourceRoot":"","sources":["../../src/event-bus/event-bus.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,uBAAuB,EAAE,MAAM,qBAAqB,CAAA;AAC7D,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAA;AAEjE,MAAM,WAAW,gBAAiB,SAAQ,uBAAuB;IAC/D,SAAS,CACP,SAAS,EAAE,MAAM,GAAG,MAAM,EAC1B,UAAU,EAAE,UAAU,EACtB,OAAO,CAAC,EAAE,iBAAiB,GAC1B,IAAI,CAAA;IAEP,WAAW,CACT,SAAS,EAAE,MAAM,GAAG,MAAM,EAC1B,UAAU,EAAE,UAAU,EACtB,OAAO,CAAC,EAAE,iBAAiB,GAC1B,IAAI,CAAA;IAEP,IAAI,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,EAAE,GAAG,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC,CAAA;CAClE"}

package/dist/event-bus/event-bus.js

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

package/dist/event-bus/event-bus.js.map

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

package/dist/event-bus/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./common";
+export * from "./event-bus";
+export * from "./event-bus-module";
+//# sourceMappingURL=index.d.ts.map

package/dist/event-bus/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/event-bus/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAA;AACxB,cAAc,aAAa,CAAA;AAC3B,cAAc,oBAAoB,CAAA"}

package/dist/event-bus/index.js

@@ -0,0 +1,20 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./common"), exports);
+__exportStar(require("./event-bus"), exports);
+__exportStar(require("./event-bus-module"), exports);
+//# sourceMappingURL=index.js.map

package/dist/event-bus/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/event-bus/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2CAAwB;AACxB,8CAA2B;AAC3B,qDAAkC"}

package/dist/feature-flag/common.d.ts

@@ -0,0 +1,31 @@
+export interface IFlagRouter {
+    isFeatureEnabled: (key: string) => boolean;
+    listFlags: () => FeatureFlagsResponse;
+}
+/**
+ * @schema FeatureFlagsResponse
+ * type: array
+ * items:
+ *   type: object
+ *   required:
+ *     - key
+ *     - value
+ *   properties:
+ *     key:
+ *       description: The key of the feature flag.
+ *       type: string
+ *     value:
+ *       description: The value of the feature flag.
+ *       type: boolean
+ */
+export type FeatureFlagsResponse = {
+    key: string;
+    value: boolean | Record<string, boolean>;
+}[];
+export type FlagSettings = {
+    key: string;
+    description: string;
+    env_key: string;
+    default_val: boolean;
+};
+//# sourceMappingURL=common.d.ts.map

package/dist/feature-flag/common.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../../src/feature-flag/common.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,WAAW;IAC1B,gBAAgB,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,CAAA;IAC1C,SAAS,EAAE,MAAM,oBAAoB,CAAA;CACtC;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC,GAAG,EAAE,MAAM,CAAA;IACX,KAAK,EAAE,OAAO,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACzC,EAAE,CAAA;AAEH,MAAM,MAAM,YAAY,GAAG;IACzB,GAAG,EAAE,MAAM,CAAA;IACX,WAAW,EAAE,MAAM,CAAA;IACnB,OAAO,EAAE,MAAM,CAAA;IACf,WAAW,EAAE,OAAO,CAAA;CACrB,CAAA"}

package/dist/feature-flag/common.js

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

package/dist/feature-flag/common.js.map

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

package/dist/feature-flag/index.d.ts

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

package/dist/feature-flag/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/feature-flag/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAA"}

package/dist/feature-flag/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./common"), exports);
+//# sourceMappingURL=index.js.map

package/dist/feature-flag/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/feature-flag/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2CAAwB"}

package/dist/file/common.d.ts

@@ -0,0 +1,45 @@
+/**
+ * The access level of the file.
+ */
+export type FileAccessPermission = "public" | "private";
+/**
+ * The File details.
+ */
+export interface FileDTO {
+    /**
+     * The ID of the file. You can use this ID later to
+     * retrieve or delete the file.
+     */
+    id: string;
+    /**
+     * The URL of the file.
+     */
+    url: string;
+}
+/**
+ * @interface
+ *
+ * Filters to apply on a currency.
+ */
+export interface FilterableFileProps {
+    /**
+     * The file ID to filter by.
+     */
+    id?: string;
+}
+export interface UploadFileUrlDTO {
+    /**
+     * The URL of the file.
+     */
+    url: string;
+    /**
+     * The file's key allowing you to later
+     * identify the file in the third-party
+     * system. For example, the S3 Module Provider
+     * returns the file's key in S3, whereas the
+     * Local File Module Provider returns the file's
+     * path.
+     */
+    key: string;
+}
+//# sourceMappingURL=common.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../../src/file/common.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,QAAQ,GAAG,SAAS,CAAA;AAEvD;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB;;;OAGG;IACH,EAAE,EAAE,MAAM,CAAA;IACV;;OAEG;IACH,GAAG,EAAE,MAAM,CAAA;CACZ;AAED;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAA;CACZ;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,GAAG,EAAE,MAAM,CAAA;IACX;;;;;;;OAOG;IACH,GAAG,EAAE,MAAM,CAAA;CACZ"}

package/dist/file/common.js

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

package/dist/file/common.js.map

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

package/dist/file/index.d.ts

@@ -0,0 +1,6 @@
+export * from "./common";
+export * from "./mutations";
+export * from "./service";
+export * from "./provider";
+export * from "./providers";
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/file/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAA;AACxB,cAAc,aAAa,CAAA;AAC3B,cAAc,WAAW,CAAA;AACzB,cAAc,YAAY,CAAA;AAC1B,cAAc,aAAa,CAAA"}

package/dist/file/index.js

@@ -0,0 +1,22 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./common"), exports);
+__exportStar(require("./mutations"), exports);
+__exportStar(require("./service"), exports);
+__exportStar(require("./provider"), exports);
+__exportStar(require("./providers"), exports);
+//# sourceMappingURL=index.js.map

package/dist/file/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/file/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2CAAwB;AACxB,8CAA2B;AAC3B,4CAAyB;AACzB,6CAA0B;AAC1B,8CAA2B"}

package/dist/file/mutations.d.ts

@@ -0,0 +1,40 @@
+import { FileAccessPermission } from "./common";
+/**
+ * The File to be created.
+ */
+export interface CreateFileDTO {
+    /**
+     * The name of the uploaded file
+     */
+    filename: string;
+    /**
+     * The mimetype of the uploaded file
+     *
+     * @example
+     * image/png
+     */
+    mimeType: string;
+    /**
+     * The file content as a base64-encoded string.
+     */
+    content: string;
+    /**
+     * The access level of the file. Defaults to private if not passed
+     */
+    access?: FileAccessPermission;
+}
+export interface GetUploadFileUrlDTO {
+    /**
+     * The name of the file to be uploaded
+     */
+    filename: string;
+    /**
+     * The mimetype of the file to be uploaded
+     */
+    mimeType?: string;
+    /**
+     * The access level of the file to be uploaded. Defaults to private if not passed
+     */
+    access?: FileAccessPermission;
+}
+//# sourceMappingURL=mutations.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"mutations.d.ts","sourceRoot":"","sources":["../../src/file/mutations.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,UAAU,CAAA;AAE/C;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAEhB;;;;;OAKG;IACH,QAAQ,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAA;IAEf;;OAEG;IACH,MAAM,CAAC,EAAE,oBAAoB,CAAA;CAC9B;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IAEjB;;OAEG;IACH,MAAM,CAAC,EAAE,oBAAoB,CAAA;CAC9B"}

package/dist/file/mutations.js

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

package/dist/file/mutations.js.map

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

package/dist/file/provider.d.ts

@@ -0,0 +1,189 @@
+import { Readable, Writable } from "stream";
+import { FileAccessPermission } from "./common";
+/**
+ * @interface
+ *
+ * Details of a file upload's result.
+ */
+export type ProviderFileResultDTO = {
+    /**
+     * The file's URL that users or systems
+     * can use to access the file.
+     */
+    url: string;
+    /**
+     * The file's key allowing you to later
+     * identify the file in the third-party
+     * system. For example, the S3 Module Provider
+     * returns the file's key in S3, whereas the
+     * Local File Module Provider returns the file's
+     * path.
+     */
+    key: string;
+};
+/**
+ * @interface
+ *
+ * The details of a file to retrieve.
+ */
+export type ProviderGetFileDTO = {
+    /**
+     * The file's key allowing you to later
+     * identify the file in the third-party
+     * system. For example, the S3 Module Provider
+     * returns the file's key in S3, whereas the
+     * Local File Module Provider returns the file's
+     * path.
+     */
+    fileKey: string;
+    [x: string]: unknown;
+};
+/**
+ * @interface
+ *
+ * The details of the file to remove.
+ */
+export type ProviderDeleteFileDTO = {
+    /**
+     * 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 to create.
+ */
+export type ProviderUploadFileDTO = {
+    /**
+     * The filename of the uploaded file
+     */
+    filename: string;
+    /**
+     * The mimetype of the uploaded file
+     */
+    mimeType: string;
+    /**
+     * The file content as a base64-encoded string
+     */
+    content: string;
+    /**
+     * The access level of the file. Defaults to private if not passed
+     */
+    access?: FileAccessPermission;
+};
+/**
+ * @interface
+ *
+ * The details of the file to get a presigned upload URL for.
+ */
+export type ProviderGetPresignedUploadUrlDTO = {
+    /**
+     * The filename of the file to get a presigned upload URL for.
+     */
+    filename: string;
+    /**
+     * The mimetype of the file to get a presigned upload URL for.
+     */
+    mimeType?: string;
+    /**
+     * The access level of the file to get a presigned upload URL for.
+     */
+    access?: FileAccessPermission;
+    /**
+     * The validity of the presigned upload URL in seconds.
+     */
+    expiresIn?: number;
+};
+/**
+ * @interface
+ *
+ * The details of the file to upload via a stream.
+ */
+export type ProviderUploadStreamDTO = {
+    /**
+     * The filename of the uploaded file
+     */
+    filename: string;
+    /**
+     * The mimetype of the uploaded file
+     */
+    mimeType: string;
+    /**
+     * The access level of the file. Defaults to private if not passed
+     */
+    access?: FileAccessPermission;
+};
+export interface IFileProvider {
+    /**
+     * This method is used to upload a file
+     *
+     * @param {ProviderUploadFileDTO} file - The contents and metadata of the file.
+     * Among the file’s details, you can access the file’s path in the `path` property of the file object.
+     * @returns {Promise<ProviderFileResultDTO>} The details of the upload's result.
+     *
+     */
+    upload(file: ProviderUploadFileDTO): Promise<ProviderFileResultDTO>;
+    /**
+     * This method is used to delete one or more files from the storage
+     *
+     * @param {ProviderDeleteFileDTO | ProviderDeleteFileDTO[]} fileData - The details of the files to remove.
+     * @returns {Promise<void>} Resolves when the file is deleted successfully.
+     *
+     */
+    delete(fileData: ProviderDeleteFileDTO | ProviderDeleteFileDTO[]): Promise<void>;
+    /**
+     * This method is used to retrieve a download URL of the file. For some file services, such as S3, a presigned URL indicates a temporary URL to get access to a file.
+     *
+     * If your file service doesn’t perform or offer a similar functionality, you can just return the URL to download the file.
+     *
+     * @param {ProviderGetFileDTO} fileData - The details of the file.
+     * @returns {Promise<string>} The presigned URL to download the file
+     *
+     */
+    getPresignedDownloadUrl(fileData: ProviderGetFileDTO): Promise<string>;
+    /**
+     * This method is used to get a presigned upload URL for a file. For some providers,
+     * such as S3, a presigned URL indicates a temporary URL to get upload a file.
+     *
+     * If your provider doesn’t perform or offer a similar functionality, you don't have to
+     * implement this method. Instead, an error is thrown when the method is called.
+     *
+     * @param {ProviderGetPresignedUploadUrlDTO} fileData - The details of the file to get a presigned upload URL for.
+     * @returns {Promise<ProviderFileResultDTO>} The presigned URL and file key to upload the file to
+     *
+     * @example
+     * class MyFileProviderService extends AbstractFileProviderService {
+     *   // ...
+     *   async getPresignedUploadUrl(
+     *     fileData: ProviderGetPresignedUploadUrlDTO
+     *   ): Promise<ProviderFileResultDTO> {
+     *     // TODO logic to get the presigned upload URL
+     *     // for example:
+     *     return this.client.getPresignedUploadUrl(fileData.filename, fileData.mimeType)
+     *   }
+     * }
+     *
+     */
+    getPresignedUploadUrl?(fileData: ProviderGetPresignedUploadUrlDTO): Promise<ProviderFileResultDTO>;
+    /**
+     * Get the file contents as a readable stream.
+     */
+    getDownloadStream(fileData: ProviderGetFileDTO): Promise<Readable>;
+    /**
+     * Get the file contents as a Node.js Buffer
+     */
+    getAsBuffer(fileData: ProviderGetFileDTO): Promise<Buffer>;
+    /**
+     * Get a writeable stream to upload a file.
+     */
+    getUploadStream(fileData: ProviderUploadStreamDTO): Promise<{
+        writeStream: Writable;
+        promise: Promise<ProviderFileResultDTO>;
+        url: string;
+        fileKey: string;
+    }>;
+}
+//# sourceMappingURL=provider.d.ts.map