@ductape/sdk 0.0.4-v43 → 0.0.4-v45

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import { DatabaseService } from './database/database.service';
-import { ImportDocsTypes, IApp, IAppConstants, IAppEnv, IAppVariables, IAppWebhook, IAppWebhookEvent, ICreateAppBuilder, IProduct, IProductApp, IProductCache, IProductDatabase, IProductDatabaseAction, IProductEnv, IProductFeature, IProductJobs, IProductStorage, IProcessorInput, IActionProcessorInput, IDBActionProcessorInput, IProductMessageBroker, IProductNotification, INotificationProcessorInput, IProductNotificationTemplate, IStorageProcessorInput, IParsedSample, IRegisterWebhook, IGenerateWebhookLink, IAppAuth, IMessageBrokerPublishInput, IMessageBrokerSubscribeInput, IProductMessageBrokerTopic, IAppAction, IProductDatabaseMigration, LogQueryParams, IProductQuota, FetchRemoteCachePayload, IFileReadResult, IProductSession, ISessionInput, IActionUpdate, IProductFallback, IFetchFilesPayload, ISessionPayload, ISessionRefreshPayload, IFetchUsersPayload, IProductAppHealth } from './types';
+import { ImportDocsTypes, IApp, IAppConstants, IAppEnv, IAppVariables, IAppWebhook, IAppWebhookEvent, ICreateAppBuilder, IProduct, IProductApp, IProductCache, IProductDatabase, IProductDatabaseAction, IProductEnv, IProductFeature, IProductJobs, IProductStorage, IProcessorInput, IActionProcessorInput, IDBActionProcessorInput, IProductMessageBroker, IProductNotification, INotificationProcessorInput, IProductNotificationTemplate, IStorageProcessorInput, IParsedSample, IGenerateWebhookLink, IAppAuth, IMessageBrokerPublishInput, IMessageBrokerSubscribeInput, IProductMessageBrokerTopic, IAppAction, IProductDatabaseMigration, LogQueryParams, IProductQuota, FetchRemoteCachePayload, IFileReadResult, IProductSession, ISessionInput, IActionUpdate, IProductFallback, IFetchFilesPayload, ISessionPayload, ISessionRefreshPayload, IFetchUsersPayload, IProductAppHealth } from './types';
 import { IDuctapeInit } from './types/index.types';
 import { PublicStates } from './types/enums';
 /**
@@ -370,12 +370,6 @@ export default class Ductape implements IDuctape {
                  * @returns {Promise<IAppWebhook[]>} The list of webhooks.
                  */
                 fetchAll: (accessTag: string) => Promise<IAppWebhook[]>;
-                /**
-                 * Enables a webhook for an app.
-                 * @param {IRegisterWebhook} data - The webhook registration data.
-                 * @returns {Promise<void>} Resolves when the webhook is enabled. Throws on error.
-                 */
-                enable: (data: IRegisterWebhook) => Promise<void>;
                 /**
                  * Generates a webhook link for an app.
                  * @param {IGenerateWebhookLink} data - The webhook link data.
@@ -1055,25 +1049,177 @@ export default class Ductape implements IDuctape {
         validation: (selector: string, update: Partial<IParsedSample>) => Promise<void>;
     };
     /**
-     * Processor-related operations for running jobs, actions, database actions, sessions, features, quotas, fallbacks, notifications, storage, and message broker.
+     * Job-related operations for scheduling jobs.
+     */
+    job: {
+        /**
+         * Schedules a job for a product.
+         * @param {IProduct} data - The product data.
+         * @returns {Promise<any>} The result of the job scheduling.
+         */
+        schedule: (data: IProduct) => Promise<void>;
+    };
+    /**
+     * Action-related operations for running actions.
+     */
+    action: {
+        /**
+         * Runs an action processor.
+         * @param {IActionProcessorInput} data - The action processor input.
+         * @returns {Promise<any>} The result of the action processing.
+         */
+        run: (data: IActionProcessorInput) => Promise<any>;
+    };
+    /**
+     * Session-related operations for creating, validating, and refreshing sessions.
+     */
+    sessions: {
+        /**
+         * Starts a new session.
+         * @param {ISessionInput} data - The session input data.
+         * @returns {Promise<any>} The result of the session generation.
+         */
+        create: (data: ISessionInput) => Promise<import("./types").ISessionOutput>;
+        /**
+         * Decrypts a session.
+         * @param {ISessionPayload} data - The session payload.
+         * @returns {Promise<any>} The decrypted session.
+         */
+        validate: (data: ISessionPayload) => Promise<any>;
+        /**
+         * Refreshes a session.
+         * @param {ISessionRefreshPayload} data - The session refresh payload.
+         * @returns {Promise<any>} The refreshed session.
+         */
+        refresh: (data: ISessionRefreshPayload) => Promise<import("./types").ISessionOutput>;
+    };
+    /**
+     * Feature-related operations for running, replaying, and resuming features.
+     */
+    feature: {
+        /**
+         * Runs a feature processor.
+         * @param {IProcessorInput} data - The feature processor input.
+         * @returns {Promise<any>} The result of the feature processing.
+         */
+        run: (data: IProcessorInput) => Promise<{
+            process_id: string;
+        }>;
+        /**
+         * Generates output for a process by ID.
+         * @param {string} process_id - The process ID.
+         * @returns {Promise<any>} The generated output.
+         */
+        output: (process_id: string) => Promise<{
+            process_id: string;
+            status: import("./types").LogEventStatus;
+            data: Record<string, unknown>;
+            errors?: undefined;
+        } | {
+            process_id: string;
+            status: import("./types").LogEventStatus;
+            errors: string[];
+            data?: undefined;
+        } | {
+            process_id: string;
+            status: import("./types").LogEventStatus;
+            data?: undefined;
+            errors?: undefined;
+        }>;
+        /**
+         * Replays a process by ID.
+         * @param {string} process_id - The process ID.
+         * @returns {Promise<any>} The result of the replay.
+         */
+        replay: (process_id: string) => Promise<{
+            process_id: string;
+        }>;
+        /**
+         * Resumes a process by ID.
+         * @param {string} process_id - The process ID.
+         * @returns {Promise<any>} The result of the resume.
+         */
+        resume: (process_id: string) => Promise<{
+            process_id: string;
+        }>;
+    };
+    /**
+     * Quota-related operations for running quota processors.
+     */
+    quota: {
+        /**
+         * Runs a quota processor.
+         * @param {IProcessorInput} data - The quota processor input.
+         * @returns {Promise<any>} The result of the quota processing.
+         */
+        run: (data: IProcessorInput) => Promise<any>;
+    };
+    /**
+     * Fallback-related operations for running fallback processors.
+     */
+    fallback: {
+        /**
+         * Runs a fallback processor.
+         * @param {IProcessorInput} data - The fallback processor input.
+         * @returns {Promise<any>} The result of the fallback processing.
+         */
+        run: (data: IProcessorInput) => Promise<any>;
+    };
+    /**
+     * Notification-related operations for sending notifications.
+     */
+    notification: {
+        /**
+         * Sends a notification using the notification processor.
+         * @param {INotificationProcessorInput} data - The notification processor input.
+         * @returns {Promise<any>} The result of the notification processing.
+         */
+        send: (data: INotificationProcessorInput) => Promise<{
+            process_id: string;
+        }>;
+    };
+    /**
+     * Storage-related operations for reading and saving files.
+     */
+    storage: {
+        /**
+         * Reads a file from storage.
+         * @param {string} path - The file path.
+         * @returns {Promise<IFileReadResult>} The file read result.
+         */
+        read: (path: string) => Promise<IFileReadResult>;
+        /**
+         * Saves data to storage using the storage processor.
+         * @param {IStorageProcessorInput} data - The storage processor input.
+         * @returns {Promise<any>} The result of the storage processing.
+         */
+        save: (data: IStorageProcessorInput) => Promise<any>;
+    };
+    /**
+     * Message broker-related operations for publishing and subscribing to topics.
+     */
+    broker: {
+        /**
+         * Publishes a message using the message broker processor.
+         * @param {IMessageBrokerPublishInput} data - The publish input.
+         * @returns {Promise<any>} The result of the publish operation.
+         */
+        publish: (data: IMessageBrokerPublishInput) => Promise<void | {
+            process_id: string;
+        }>;
+        /**
+         * Subscribes to a message broker topic.
+         * @param {IMessageBrokerSubscribeInput} data - The subscribe input.
+         * @returns {Promise<any>} The result of the subscribe operation.
+         */
+        subcribe: (data: IMessageBrokerSubscribeInput) => Promise<void | {
+            process_id: string;
+        }>;
+    };
+    /**
+     * Processor-related operations for database actions only.
      */
     processor: {
-        job: {
-            /**
-             * Schedules a job for a product.
-             * @param {IProduct} data - The product data.
-             * @returns {Promise<any>} The result of the job scheduling.
-             */
-            schedule: (data: IProduct) => Promise<void>;
-        };
-        action: {
-            /**
-             * Runs an action processor.
-             * @param {IActionProcessorInput} data - The action processor input.
-             * @returns {Promise<any>} The result of the action processing.
-             */
-            run: (data: IActionProcessorInput) => Promise<any>;
-        };
         db: {
             /**
              * Executes a database action processor.
@@ -1114,131 +1260,6 @@ export default class Ductape implements IDuctape {
                 }>;
             };
         };
-        sessions: {
-            /**
-             * Starts a new session.
-             * @param {ISessionInput} data - The session input data.
-             * @returns {Promise<any>} The result of the session generation.
-             */
-            start: (data: ISessionInput) => Promise<import("./types").ISessionOutput>;
-            /**
-             * Decrypts a session.
-             * @param {ISessionPayload} data - The session payload.
-             * @returns {Promise<any>} The decrypted session.
-             */
-            decrypt: (data: ISessionPayload) => Promise<any>;
-            /**
-             * Refreshes a session.
-             * @param {ISessionRefreshPayload} data - The session refresh payload.
-             * @returns {Promise<any>} The refreshed session.
-             */
-            refresh: (data: ISessionRefreshPayload) => Promise<import("./types").ISessionOutput>;
-        };
-        feature: {
-            /**
-             * Runs a feature processor.
-             * @param {IProcessorInput} data - The feature processor input.
-             * @returns {Promise<any>} The result of the feature processing.
-             */
-            run: (data: IProcessorInput) => Promise<{
-                process_id: string;
-            }>;
-            /**
-             * Generates output for a process by ID.
-             * @param {string} process_id - The process ID.
-             * @returns {Promise<any>} The generated output.
-             */
-            output: (process_id: string) => Promise<{
-                process_id: string;
-                status: import("./types").LogEventStatus;
-                data: Record<string, unknown>;
-                errors?: undefined;
-            } | {
-                process_id: string;
-                status: import("./types").LogEventStatus;
-                errors: string[];
-                data?: undefined;
-            } | {
-                process_id: string;
-                status: import("./types").LogEventStatus;
-                data?: undefined;
-                errors?: undefined;
-            }>;
-            /**
-             * Replays a process by ID.
-             * @param {string} process_id - The process ID.
-             * @returns {Promise<any>} The result of the replay.
-             */
-            replay: (process_id: string) => Promise<{
-                process_id: string;
-            }>;
-            /**
-             * Resumes a process by ID.
-             * @param {string} process_id - The process ID.
-             * @returns {Promise<any>} The result of the resume.
-             */
-            resume: (process_id: string) => Promise<{
-                process_id: string;
-            }>;
-        };
-        quota: {
-            /**
-             * Runs a quota processor.
-             * @param {IProcessorInput} data - The quota processor input.
-             * @returns {Promise<any>} The result of the quota processing.
-             */
-            run: (data: IProcessorInput) => Promise<any>;
-        };
-        fallback: {
-            /**
-             * Runs a fallback processor.
-             * @param {IProcessorInput} data - The fallback processor input.
-             * @returns {Promise<any>} The result of the fallback processing.
-             */
-            run: (data: IProcessorInput) => Promise<any>;
-        };
-        notification: {
-            /**
-             * Sends a notification using the notification processor.
-             * @param {INotificationProcessorInput} data - The notification processor input.
-             * @returns {Promise<any>} The result of the notification processing.
-             */
-            send: (data: INotificationProcessorInput) => Promise<{
-                process_id: string;
-            }>;
-        };
-        storage: {
-            /**
-             * Reads a file from storage.
-             * @param {string} path - The file path.
-             * @returns {Promise<IFileReadResult>} The file read result.
-             */
-            readFile: (path: string) => Promise<IFileReadResult>;
-            /**
-             * Saves data to storage using the storage processor.
-             * @param {IStorageProcessorInput} data - The storage processor input.
-             * @returns {Promise<any>} The result of the storage processing.
-             */
-            save: (data: IStorageProcessorInput) => Promise<any>;
-        };
-        messageBroker: {
-            /**
-             * Publishes a message using the message broker processor.
-             * @param {IMessageBrokerPublishInput} data - The publish input.
-             * @returns {Promise<any>} The result of the publish operation.
-             */
-            publish: (data: IMessageBrokerPublishInput) => Promise<void | {
-                process_id: string;
-            }>;
-            /**
-             * Subscribes to a message broker topic.
-             * @param {IMessageBrokerSubscribeInput} data - The subscribe input.
-             * @returns {Promise<any>} The result of the subscribe operation.
-             */
-            subcribe: (data: IMessageBrokerSubscribeInput) => Promise<void | {
-                process_id: string;
-            }>;
-        };
     };
     /**
      * Database operations for querying, inserting, updating, and managing databases.