@ductape/sdk 0.0.4-v4 → 0.0.4-v41

package/dist/index.d.ts

@@ -1,6 +1,212 @@
-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, IFetchFilesFilter } 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, IRegisterWebhook, 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';
+/**
+ * @typedef {Object} IProduct
+ * @property {string} tag - Unique product tag.
+ * @property {string} name - Product name.
+ * @property {string} [description] - Optional product description.
+ * @property {Array<IProductApp>} [apps] - Associated apps.
+ * @property {Array<IProductSession>} [sessions] - Product sessions.
+ * @property {Array<IProductFeature>} [features] - Product features.
+ * @property {Array<IProductQuota>} [quotas] - Product quotas.
+ * @property {Array<IProductFallback>} [fallbacks] - Product fallbacks.
+ * @property {Array<IProductEnv>} [environments] - Product environments.
+ * @property {Array<IProductStorage>} [storages] - Product storages.
+ * @property {Array<IProductMessageBroker>} [messageBrokers] - Product message brokers.
+ * @property {Array<IProductNotification>} [notifications] - Product notifications.
+ * @property {Array<IProductDatabase>} [databases] - Product databases.
+ * @property {Array<IProductJobs>} [jobs] - Product jobs.
+ * @property {Array<IProductCache>} [caches] - Product caches.
+ * @property {Array<IProductFunction>} [functions] - Product functions.
+ * @see ts/src/types/productsBuilder.types.ts
+ */
+/**
+ * @typedef {Object} IApp
+ * @property {string} tag - Unique app tag.
+ * @property {string} name - App name.
+ * @property {string} [description] - Optional app description.
+ * @property {Array<IAppVariables>} [variables] - App variables.
+ * @property {Array<IAppConstants>} [constants] - App constants.
+ * @property {Array<IAppWebhook>} [webhooks] - App webhooks.
+ * @property {Array<IAppEnv>} [environments] - App environments.
+ * @property {Array<IAppAction>} [actions] - App actions.
+ * @property {Array<IAppAuth>} [auths] - App authentication configs.
+ * @see ts/src/types/appBuilder.types.ts
+ */
+/**
+ * @typedef {Object} IProductSession
+ * @property {string} tag - Session tag.
+ * @property {string} token - Session token.
+ * @property {string} [user_id] - Associated user ID.
+ * @property {string} [product_tag] - Associated product tag.
+ * @property {Record<string, unknown>} [data] - Session data.
+ * @see ts/src/types/productsBuilder.types.ts
+ */
+/**
+ * @typedef {Object} IProductApp
+ * @property {string} tag - App tag.
+ * @property {string} name - App name.
+ * @property {string} [description] - App description.
+ * @property {Array<IAppEnv>} [environments] - App environments.
+ * @see ts/src/types/productsBuilder.types.ts
+ */
+/**
+ * @typedef {Object} IProductFeature
+ * @property {string} tag - Feature tag.
+ * @property {string} name - Feature name.
+ * @property {string} [description] - Feature description.
+ * @property {Array<any>} [actions] - Feature actions.
+ * @see ts/src/types/productsBuilder.types.ts
+ */
+/**
+ * @typedef {Object} IProductQuota
+ * @property {string} tag - Quota tag.
+ * @property {string} name - Quota name.
+ * @property {number} [limit] - Quota limit.
+ * @property {string} [period] - Quota period.
+ * @see ts/src/types/productsBuilder.types.ts
+ */
+/**
+ * @typedef {Object} IProductFallback
+ * @property {string} tag - Fallback tag.
+ * @property {string} name - Fallback name.
+ * @property {string} [description] - Fallback description.
+ * @see ts/src/types/productsBuilder.types.ts
+ */
+/**
+ * @typedef {Object} IProductEnv
+ * @property {string} slug - Environment slug.
+ * @property {string} [name] - Environment name.
+ * @property {string} [description] - Environment description.
+ * @see ts/src/types/productsBuilder.types.ts
+ */
+/**
+ * @typedef {Object} IProductStorage
+ * @property {string} tag - Storage tag.
+ * @property {string} name - Storage name.
+ * @property {string} [description] - Storage description.
+ * @see ts/src/types/productsBuilder.types.ts
+ */
+/**
+ * @typedef {Object} IProductMessageBroker
+ * @property {string} tag - Message broker tag.
+ * @property {string} name - Message broker name.
+ * @property {string} [description] - Message broker description.
+ * @property {Array<IProductMessageBrokerTopic>} [topics] - Message broker topics.
+ * @see ts/src/types/productsBuilder.types.ts
+ */
+/**
+ * @typedef {Object} IProductNotification
+ * @property {string} tag - Notification tag.
+ * @property {string} name - Notification name.
+ * @property {string} [description] - Notification description.
+ * @property {Array<IProductNotificationTemplate>} [messages] - Notification messages.
+ * @see ts/src/types/productsBuilder.types.ts
+ */
+/**
+ * @typedef {Object} IProductDatabase
+ * @property {string} tag - Database tag.
+ * @property {string} name - Database name.
+ * @property {string} [description] - Database description.
+ * @property {Array<IProductDatabaseAction>} [actions] - Database actions.
+ * @property {Array<IProductDatabaseMigration>} [migrations] - Database migrations.
+ * @see ts/src/types/productsBuilder.types.ts
+ */
+/**
+ * @typedef {Object} IProductJobs
+ * @property {string} tag - Job tag.
+ * @property {string} name - Job name.
+ * @property {string} [description] - Job description.
+ * @see ts/src/types/productsBuilder.types.ts
+ */
+/**
+ * @typedef {Object} IProductCache
+ * @property {string} tag - Cache tag.
+ * @property {string} name - Cache name.
+ * @property {string} [description] - Cache description.
+ * @see ts/src/types/productsBuilder.types.ts
+ */
+/**
+ * @typedef {Object} IProductFunction
+ * @property {string} tag - Function tag.
+ * @property {string} name - Function name.
+ * @property {string} [description] - Function description.
+ * @see ts/src/types/productsBuilder.types.ts
+ */
+/**
+ * @typedef {Object} IAppVariables
+ * @property {string} tag - Variable tag.
+ * @property {string} name - Variable name.
+ * @property {string} [description] - Variable description.
+ * @see ts/src/types/appBuilder.types.ts
+ */
+/**
+ * @typedef {Object} IAppConstants
+ * @property {string} tag - Constant tag.
+ * @property {string} name - Constant name.
+ * @property {string} [description] - Constant description.
+ * @see ts/src/types/appBuilder.types.ts
+ */
+/**
+ * @typedef {Object} IAppWebhook
+ * @property {string} tag - Webhook tag.
+ * @property {string} url - Webhook URL.
+ * @property {string} [description] - Webhook description.
+ * @property {Array<IAppWebhookEvent>} [events] - Webhook events.
+ * @see ts/src/types/appBuilder.types.ts
+ */
+/**
+ * @typedef {Object} IAppWebhookEvent
+ * @property {string} tag - Webhook event tag.
+ * @property {string} name - Webhook event name.
+ * @property {string} [description] - Webhook event description.
+ * @see ts/src/types/appBuilder.types.ts
+ */
+/**
+ * @typedef {Object} IAppEnv
+ * @property {string} slug - Environment slug.
+ * @property {string} [name] - Environment name.
+ * @property {string} [description] - Environment description.
+ * @see ts/src/types/appBuilder.types.ts
+ */
+/**
+ * @typedef {Object} IAppAction
+ * @property {string} tag - Action tag.
+ * @property {string} name - Action name.
+ * @property {string} [description] - Action description.
+ * @see ts/src/types/appBuilder.types.ts
+ */
+/**
+ * @typedef {Object} IAppAuth
+ * @property {string} tag - Auth tag.
+ * @property {string} name - Auth name.
+ * @property {string} [description] - Auth description.
+ * @see ts/src/types/appBuilder.types.ts
+ */
+/**
+ * @typedef {Object} IProductAppHealth
+ * @property {string} name - Health check name.
+ * @property {string} description - Health check description.
+ * @property {string} tag - Health check tag.
+ * @property {string} app - App access tag.
+ * @property {string} action - Action to execute for health check.
+ * @property {number} checkIntervals - Interval between health checks in milliseconds.
+ * @property {number} retries - Number of retry attempts.
+ * @property {Array<CheckEnvStatus>} envs - Environment-specific health check configurations.
+ * @see ts/src/types/productsBuilder.types.ts
+ */
+/**
+ * @typedef {Object} CheckEnvStatus
+ * @property {string} slug - Environment slug.
+ * @property {string} [status] - Current health status.
+ * @property {string} [lastAvailable] - Last available timestamp.
+ * @property {string} [lastChecked] - Last check timestamp.
+ * @property {string} [lastLatency] - Last response latency.
+ * @property {string} [averageLatency] - Average response latency.
+ * @property {any} input - Health check input data.
+ * @see ts/src/types/productsBuilder.types.ts
+ */
 export interface IDuctape {
 }
 export default class Ductape implements IDuctape {
@@ -25,193 +231,850 @@ export default class Ductape implements IDuctape {
     private environment;
     private redis_url;
     private redisClient?;
+    private jobsQueue;
+    private healthCheckQueue;
+    private healthCheckUpdaterQueue;
+    jobsWorker: any;
+    healthCheckWorker: any;
+    healthCheckUpdaterWorker: any;
     private loadRedis;
     constructor({ workspace_id, private_key, user_id, env_type, redis_url }: IDuctapeInit);
-    connectRedis(): Promise<void>;
+    private loadBullMQ;
+    /**
+     * Connects to Redis and initializes job and health check queues and workers.
+     * @throws {Error} If called in a browser environment or if Redis URL is missing.
+     * @returns {Promise<void>} Resolves when Redis and queues are initialized.
+     */
+    monitor(): Promise<void>;
+    /**
+     * Schedules all healthcheck jobs for all products and environments.
+     */
+    private scheduleAllHealthcheckJobs;
+    /**
+     * Schedules a single healthcheck job with the given interval (ms).
+     * If interval is not provided, defaults to 60s.
+     */
+    private scheduleHealthcheckJob;
+    /**
+     * Sets the authentication token for API requests.
+     * @param {string} token - The authentication token.
+     */
     setToken(token: string): void;
+    /**
+     * Sets the public key for API requests.
+     * @param {string} public_key - The public key.
+     */
     setPublicKey(public_key: string): void;
     private initProduct;
     private initApp;
     private checkProductInit;
     private checkAppInit;
+    /**
+     * Product-related operations for managing products, sessions, apps, quotas, and fallbacks.
+     */
     product: {
+        /**
+         * Creates a new product.
+         * @param {IProduct} data - The product data.
+         * @returns {Promise<void>} Resolves when the product is created. Throws on error.
+         */
         create: (data: IProduct) => Promise<void>;
+        /**
+         * Fetches a product by tag.
+         * @param {string} tag - The product tag.
+         * @returns {Promise<IProduct|null>} The fetched product, or null if not found.
+         */
         fetch: (tag: string) => Promise<IProduct>;
+        /**
+         * Updates a product by tag.
+         * @param {string} tag - The product tag.
+         * @param {Partial<IProduct>} data - The product data to update.
+         * @returns {Promise<void>} Resolves when the product is updated. Throws on error.
+         */
         update: (tag: string, data: Partial<IProduct>) => Promise<void>;
+        /**
+         * Initializes a product by tag.
+         * @param {string} productTag - The product tag.
+         * @returns {Promise<void>} Resolves when initialization is complete. Throws on error.
+         */
         init: (productTag: string) => Promise<void>;
         sessions: {
+            /**
+             * Creates a new product session.
+             * @param {IProductSession} payload - The session payload.
+             * @returns {Promise<void>} Resolves when the session is created. Throws on error.
+             */
             create: (payload: IProductSession) => Promise<void>;
+            /**
+             * Updates a product session by tag.
+             * @param {string} tag - The session tag.
+             * @param {Partial<IProductSession>} payload - The session data to update.
+             * @returns {Promise<void>} Resolves when the session is updated. Throws on error.
+             */
             update: (tag: string, payload: Partial<IProductSession>) => Promise<void>;
-            fetchAll: () => IProductSession[];
-            fetch: (tag: string) => IProductSession;
+            /**
+             * Fetches all product sessions.
+             * @returns {IProductSession[]} The list of sessions.
+             */
+            fetchAll: () => Promise<IProductSession[]>;
+            /**
+             * Fetches a product session by tag.
+             * @param {string} tag - The session tag.
+             * @returns {IProductSession|null} The fetched session, or null if not found.
+             */
+            fetch: (tag: string) => Promise<IProductSession>;
+            /**
+             * Fetches users for a session.
+             * @param {IFetchUsersPayload} data - The user fetch payload.
+             * @returns {Promise<any[]>} The users for the session.
+             */
+            users: (data: IFetchUsersPayload) => Promise<import("./types").IFileURLPayload[]>;
         };
         apps: {
+            /**
+             * Connects an app to a product by app tag.
+             * @param {string} appTag - The app tag.
+             * @returns {Promise<IAppAccess>} The result of the connection.
+             */
             connect: (appTag: string) => Promise<import("./types").IAppAccess>;
+            /**
+             * Adds an app to a product.
+             * @param {IProductApp} app - The app data.
+             * @returns {Promise<void>} Resolves when the app is added. Throws on error.
+             */
             add: (app: IProductApp) => Promise<void>;
+            /**
+             * Fetches all apps for a product.
+             * @returns {IProductApp[]} The list of apps.
+             */
             fetchAll: () => Promise<IProductApp[]>;
+            /**
+             * Fetches an app by tag.
+             * @param {string} tag - The app tag.
+             * @returns {IProductApp|null} The fetched app, or null if not found.
+             */
             fetch: (tag: string) => Promise<IProductApp>;
+            /**
+             * Updates an app by access tag.
+             * @param {string} accessTag - The app access tag.
+             * @param {Partial<IProductApp>} data - The app data to update.
+             * @returns {Promise<void>} Resolves when the app is updated. Throws on error.
+             */
             update: (accessTag: string, data: Partial<IProductApp>) => Promise<void>;
             webhooks: {
+                /**
+                 * Fetches all webhooks for an app by access tag.
+                 * @param {string} accessTag - The app access tag.
+                 * @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.
+                 * @returns {Promise<string>} The generated webhook link.
+                 */
                 generateLink: (data: IGenerateWebhookLink) => Promise<string>;
             };
+            health: {
+                /**
+                 * Creates a health check for an app.
+                 * @param {Partial<IProductAppHealth>} data - The health check data.
+                 * @returns {Promise<void>} Resolves when the health check is created. Throws on error.
+                 */
+                create: (data: Partial<IProductAppHealth>) => Promise<void>;
+                /**
+                 * Updates a health check by tag.
+                 * @param {string} tag - The health check tag.
+                 * @param {Partial<IProductAppHealth>} data - The health check data to update.
+                 * @returns {Promise<void>} Resolves when the health check is updated. Throws on error.
+                 */
+                update: (tag: string, data: Partial<IProductAppHealth>) => Promise<void>;
+                /**
+                 * Fetches a health check by access tag and tag.
+                 * @param {string} access_tag - The app access tag.
+                 * @param {string} tag - The health check tag.
+                 * @returns {Promise<IProductAppHealth|null>} The fetched health check, or null if not found.
+                 */
+                fetch: (access_tag: string, tag: string) => Promise<IProductAppHealth>;
+                /**
+                 * Fetches all health checks for an app by access tag.
+                 * @param {string} access_tag - The app access tag.
+                 * @returns {Promise<IProductAppHealth[]>} The list of health checks.
+                 */
+                fetchAll: (access_tag: string) => Promise<IProductAppHealth[]>;
+            };
         };
+        /**
+         * Creates a quota for a product.
+         * @param {Partial<IProductQuota>} data - The quota data.
+         * @returns {Promise<void>} Resolves when the quota is created. Throws on error.
+         */
         quota: {
             create: (data: Partial<IProductQuota>) => Promise<void>;
-            fetch: (tag: string) => IProductQuota;
-            fetchAll: () => IProductQuota[];
+            /**
+             * Fetches a quota by tag.
+             * @param {string} tag - The quota tag.
+             * @returns {IProductQuota|null} The fetched quota, or null if not found.
+             */
+            fetch: (tag: string) => Promise<IProductQuota>;
+            /**
+             * Fetches all quotas for a product.
+             * @returns {IProductQuota[]} The list of quotas.
+             */
+            fetchAll: () => Promise<IProductQuota[]>;
+            /**
+             * Updates a quota by tag.
+             * @param {string} tag - The quota tag.
+             * @param {Partial<IProductQuota>} data - The quota data to update.
+             * @returns {Promise<void>} Resolves when the quota is updated. Throws on error.
+             */
             update: (tag: string, data: Partial<IProductQuota>) => Promise<void>;
         };
+        /**
+         * Creates a fallback for a product.
+         * @param {Partial<IProductFallback>} data - The fallback data.
+         * @returns {Promise<void>} Resolves when the fallback is created. Throws on error.
+         */
         fallback: {
             create: (data: Partial<IProductFallback>) => Promise<void>;
-            fetch: (tag: string) => IProductFallback;
-            fetchAll: () => IProductFallback[];
+            /**
+             * Fetches a fallback by tag.
+             * @param {string} tag - The fallback tag.
+             * @returns {IProductFallback|null} The fetched fallback, or null if not found.
+             */
+            fetch: (tag: string) => Promise<IProductFallback>;
+            /**
+             * Fetches all fallbacks for a product.
+             * @returns {IProductFallback[]} The list of fallbacks.
+             */
+            fetchAll: () => Promise<IProductFallback[]>;
+            /**
+             * Updates a fallback by tag.
+             * @param {string} tag - The fallback tag.
+             * @param {Partial<IProductFallback>} data - The fallback data to update.
+             * @returns {Promise<void>} Resolves when the fallback is updated. Throws on error.
+             */
             update: (tag: string, data: Partial<IProductFallback>) => Promise<void>;
         };
+        /**
+         * Updates data validation for a product.
+         * @param {string} tag - The product tag.
+         * @param {Partial<IParsedSample>} update - The update data.
+         * @returns {Promise<void>} Resolves when the validation is updated. Throws on error.
+         */
         updateValidation: (tag: string, update: Partial<IParsedSample>) => Promise<boolean>;
         environments: {
+            /**
+             * Creates an environment for a product.
+             * @param {IProductEnv} data - The environment data.
+             * @returns {Promise<void>} Resolves when the environment is created. Throws on error.
+             */
             create: (data: IProductEnv) => Promise<void>;
-            fetchAll: () => IProductEnv[];
-            fetch: (slug: string) => IProductEnv;
+            /**
+             * Fetches all environments for a product.
+             * @returns {IAppEnv[]} The list of environments.
+             */
+            fetchAll: () => Promise<IProductEnv[]>;
+            /**
+             * Fetches an environment by slug.
+             * @param {string} slug - The environment slug.
+             * @returns {IAppEnv|null} The fetched environment, or null if not found.
+             */
+            fetch: (slug: string) => Promise<IProductEnv>;
+            /**
+             * Updates an environment by slug.
+             * @param {string} slug - The environment slug.
+             * @param {Partial<IProductEnv>} data - The environment data to update.
+             * @returns {Promise<void>} Resolves when the environment is updated. Throws on error.
+             */
             update: (slug: string, data: Partial<IProductEnv>) => Promise<void>;
         };
         storage: {
+            /**
+             * Creates a storage for a product.
+             * @param {IProductStorage} data - The storage data.
+             * @returns {Promise<void>} Resolves when the storage is created. Throws on error.
+             */
             create: (data: IProductStorage) => Promise<void>;
-            fetchAll: () => IProductStorage[];
-            fetch: (tag: string) => IProductStorage;
+            /**
+             * Fetches all storages for a product.
+             * @returns {IProductStorage[]} The list of storages.
+             */
+            fetchAll: () => Promise<IProductStorage[]>;
+            /**
+             * Fetches a storage by tag.
+             * @param {string} tag - The storage tag.
+             * @returns {IProductStorage|null} The fetched storage, or null if not found.
+             */
+            fetch: (tag: string) => Promise<IProductStorage>;
+            /**
+             * Updates a storage by tag.
+             * @param {string} tag - The storage tag.
+             * @param {Partial<IProductStorage>} data - The storage data to update.
+             * @returns {Promise<void>} Resolves when the storage is updated. Throws on error.
+             */
             update: (tag: string, data: Partial<IProductStorage>) => Promise<void>;
-            files: (data: IFetchFilesFilter) => Promise<import("./types").IFileURLPayload[]>;
+            /**
+             * Fetches storage files for a product.
+             * @param {IFetchFilesPayload} data - The fetch files payload.
+             * @returns {Promise<void>} Resolves when the storage files are fetched. Throws on error.
+             */
+            files: (data: IFetchFilesPayload) => Promise<import("./types").IFileURLPayload[]>;
         };
         messageBrokers: {
+            /**
+             * Creates a message broker for a product.
+             * @param {Partial<IProductMessageBroker>} data - The message broker data.
+             * @returns {Promise<void>} Resolves when the message broker is created. Throws on error.
+             */
             create: (data: Partial<IProductMessageBroker>) => Promise<void>;
-            fetchAll: () => IProductMessageBroker[];
-            fetch: (tag: string) => IProductMessageBroker;
+            /**
+             * Fetches all message brokers for a product.
+             * @returns {IProductMessageBroker[]} The list of message brokers.
+             */
+            fetchAll: () => Promise<IProductMessageBroker[]>;
+            /**
+             * Fetches a message broker by tag.
+             * @param {string} tag - The message broker tag.
+             * @returns {IProductMessageBroker|null} The fetched message broker, or null if not found.
+             */
+            fetch: (tag: string) => Promise<IProductMessageBroker>;
+            /**
+             * Updates a message broker by tag.
+             * @param {string} tag - The message broker tag.
+             * @param {Partial<IProductMessageBroker>} data - The message broker data to update.
+             * @returns {Promise<void>} Resolves when the message broker is updated. Throws on error.
+             */
             update: (tag: string, data: Partial<IProductMessageBroker>) => Promise<void>;
             topics: {
+                /**
+                 * Creates a message broker topic for a product.
+                 * @param {IProductMessageBrokerTopic} data - The message broker topic data.
+                 * @returns {Promise<void>} Resolves when the message broker topic is created. Throws on error.
+                 */
                 create: (data: IProductMessageBrokerTopic) => Promise<void>;
-                fetchAll: (messageBrokerTag: string) => IProductMessageBrokerTopic[];
-                fetch: (tag: string) => IProductMessageBrokerTopic;
+                /**
+                 * Fetches all message broker topics for a message broker by tag.
+                 * @param {string} messageBrokerTag - The message broker tag.
+                 * @returns {IProductMessageBrokerTopic[]} The list of message broker topics.
+                 */
+                fetchAll: (messageBrokerTag: string) => Promise<IProductMessageBrokerTopic[]>;
+                /**
+                 * Fetches a message broker topic by tag.
+                 * @param {string} tag - The message broker topic tag.
+                 * @returns {IProductMessageBrokerTopic|null} The fetched message broker topic, or null if not found.
+                 */
+                fetch: (tag: string) => Promise<IProductMessageBrokerTopic>;
+                /**
+                 * Updates a message broker topic by tag.
+                 * @param {string} tag - The message broker topic tag.
+                 * @param {Partial<IProductMessageBrokerTopic>} data - The message broker topic data to update.
+                 * @returns {Promise<void>} Resolves when the message broker topic is updated. Throws on error.
+                 */
                 update: (tag: string, data: Partial<IProductMessageBrokerTopic>) => Promise<void>;
             };
         };
         notifications: {
+            /**
+             * Creates a notification for a product.
+             * @param {IProductNotification} data - The notification data.
+             * @returns {Promise<void>} Resolves when the notification is created. Throws on error.
+             */
             create: (data: IProductNotification) => Promise<void>;
-            fetchAll: () => IProductNotification[];
-            fetch: (tag: string) => IProductNotification;
+            /**
+             * Fetches all notifications for a product.
+             * @returns {IProductNotification[]} The list of notifications.
+             */
+            fetchAll: () => Promise<IProductNotification[]>;
+            /**
+             * Fetches a notification by tag.
+             * @param {string} tag - The notification tag.
+             * @returns {IProductNotification|null} The fetched notification, or null if not found.
+             */
+            fetch: (tag: string) => Promise<IProductNotification>;
+            /**
+             * Updates a notification by tag.
+             * @param {string} tag - The notification tag.
+             * @param {Partial<IProductNotification>} data - The notification data to update.
+             * @returns {Promise<void>} Resolves when the notification is updated. Throws on error.
+             */
             update: (tag: string, data: Partial<IProductNotification>) => Promise<void>;
             messages: {
+                /**
+                 * Creates a notification message for a product.
+                 * @param {IProductNotificationTemplate} data - The notification message data.
+                 * @returns {Promise<void>} Resolves when the notification message is created. Throws on error.
+                 */
                 create: (data: IProductNotificationTemplate) => Promise<void>;
-                fetchAll: (notificationTag: string) => IProductNotificationTemplate[];
-                fetch: (tag: string) => IProductNotificationTemplate;
+                /**
+                 * Fetches all notification messages for a notification by tag.
+                 * @param {string} notificationTag - The notification tag.
+                 * @returns {IProductNotificationTemplate[]} The list of notification messages.
+                 */
+                fetchAll: (notificationTag: string) => Promise<IProductNotificationTemplate[]>;
+                /**
+                 * Fetches a notification message by tag.
+                 * @param {string} tag - The notification message tag.
+                 * @returns {IProductNotificationTemplate|null} The fetched notification message, or null if not found.
+                 */
+                fetch: (tag: string) => Promise<IProductNotificationTemplate>;
+                /**
+                 * Updates a notification message by tag.
+                 * @param {string} tag - The notification message tag.
+                 * @param {Partial<IProductNotificationTemplate>} data - The notification message data to update.
+                 * @returns {Promise<void>} Resolves when the notification message is updated. Throws on error.
+                 */
                 update: (tag: string, data: Partial<IProductNotificationTemplate>) => Promise<void>;
             };
         };
         databases: {
+            /**
+             * Creates a database for a product.
+             * @param {IProductDatabase} data - The database data.
+             * @returns {Promise<void>} Resolves when the database is created. Throws on error.
+             */
             create: (data: IProductDatabase) => Promise<void>;
-            fetchAll: () => IProductDatabase[];
-            fetch: (tag: string) => IProductDatabase;
+            /**
+             * Fetches all databases for a product.
+             * @returns {IProductDatabase[]} The list of databases.
+             */
+            fetchAll: () => Promise<IProductDatabase[]>;
+            /**
+             * Fetches a database by tag.
+             * @param {string} tag - The database tag.
+             * @returns {IProductDatabase|null} The fetched database, or null if not found.
+             */
+            fetch: (tag: string) => Promise<IProductDatabase>;
+            /**
+             * Updates a database by tag.
+             * @param {string} tag - The database tag.
+             * @param {Partial<IProductDatabase>} data - The database data to update.
+             * @returns {Promise<void>} Resolves when the database is updated. Throws on error.
+             */
             update: (tag: string, data: Partial<IProductDatabase>) => Promise<void>;
             actions: {
+                /**
+                 * Creates a database action for a product.
+                 * @param {IProductDatabaseAction} data - The database action data.
+                 * @returns {Promise<void>} Resolves when the database action is created. Throws on error.
+                 */
                 create: (data: IProductDatabaseAction) => Promise<void>;
-                fetchAll: (databaseTag: string) => IProductDatabaseAction[];
-                fetch: (tag: string) => IProductDatabaseAction;
+                /**
+                 * Fetches all database actions for a product.
+                 * @param {string} databaseTag - The database tag.
+                 * @returns {IProductDatabaseAction[]} The list of database actions.
+                 */
+                fetchAll: (databaseTag: string) => Promise<IProductDatabaseAction[]>;
+                /**
+                 * Fetches a database action by tag.
+                 * @param {string} tag - The database action tag.
+                 * @returns {IProductDatabaseAction|null} The fetched database action, or null if not found.
+                 */
+                fetch: (tag: string) => Promise<IProductDatabaseAction>;
+                /**
+                 * Updates a database action by tag.
+                 * @param {string} tag - The database action tag.
+                 * @param {Partial<IProductDatabaseAction>} data - The database action data to update.
+                 * @returns {Promise<void>} Resolves when the database action is updated. Throws on error.
+                 */
                 update: (tag: string, data: Partial<IProductDatabaseAction>) => Promise<void>;
             };
             migrations: {
+                /**
+                 * Creates a database migration for a product.
+                 * @param {IProductDatabaseMigration} data - The database migration data.
+                 * @returns {void} Resolves when the database migration is created. Throws on error.
+                 */
                 create: (data: IProductDatabaseMigration) => Promise<void>;
-                fetchAll: (databaseTag: string) => IProductDatabaseMigration[];
-                fetch: (tag: string) => IProductDatabaseMigration;
+                /**
+                 * Fetches all database migrations for a product.
+                 * @param {string} databaseTag - The database tag.
+                 * @returns {IProductDatabaseMigration[]} The list of database migrations.
+                 */
+                fetchAll: (databaseTag: string) => Promise<IProductDatabaseMigration[]>;
+                /**
+                 * Fetches a database migration by tag.
+                 * @param {string} tag - The database migration tag.
+                 * @returns {IProductDatabaseMigration|null} The fetched database migration, or null if not found.
+                 */
+                fetch: (tag: string) => Promise<IProductDatabaseMigration>;
+                /**
+                 * Updates a database migration by tag.
+                 * @param {string} tag - The database migration tag.
+                 * @param {Partial<IProductDatabaseMigration>} data - The database migration data to update.
+                 * @returns {void} Resolves when the database migration is updated. Throws on error.
+                 */
                 update: (tag: string, data: Partial<IProductDatabaseMigration>) => Promise<void>;
             };
         };
         jobs: {
+            /**
+             * Creates a job for a product.
+             * @param {Partial<IProductJobs>} data - The job data.
+             * @returns {Promise<void>} Resolves when the job is created. Throws on error.
+             */
             create: (data: Partial<IProductJobs>) => Promise<void>;
-            fetchAll: () => IProductJobs[];
-            fetch: (tag: string) => IProductJobs;
+            /**
+             * Fetches all jobs for a product.
+             * @returns {IProductJobs[]} The list of jobs.
+             */
+            fetchAll: () => Promise<IProductJobs[]>;
+            /**
+             * Fetches a job by tag.
+             * @param {string} tag - The job tag.
+             * @returns {IProductJobs|null} The fetched job, or null if not found.
+             */
+            fetch: (tag: string) => Promise<IProductJobs>;
+            /**
+             * Updates a job by tag.
+             * @param {string} tag - The job tag.
+             * @param {Partial<IProductJobs>} data - The job data to update.
+             * @returns {Promise<void>} Resolves when the job is updated. Throws on error.
+             */
             update: (tag: string, data: Partial<IProductJobs>) => Promise<void>;
         };
         caches: {
+            /**
+             * Creates a cache for a product.
+             * @param {IProductCache} data - The cache data.
+             * @returns {Promise<void>} Resolves when the cache is created. Throws on error.
+             */
             create: (data: IProductCache) => Promise<void>;
-            fetchAll: () => IProductCache[];
-            fetch: (tag: string) => IProductCache;
+            /**
+             * Fetches all caches for a product.
+             * @returns {IProductCache[]} The list of caches.
+             */
+            fetchAll: () => Promise<IProductCache[]>;
+            /**
+             * Fetches a cache by tag.
+             * @param {string} tag - The cache tag.
+             * @returns {IProductCache|null} The fetched cache, or null if not found.
+             */
+            fetch: (tag: string) => Promise<IProductCache>;
+            /**
+             * Updates a cache by tag.
+             * @param {string} tag - The cache tag.
+             * @param {Partial<IProductCache>} data - The cache data to update.
+             * @returns {Promise<void>} Resolves when the cache is updated. Throws on error.
+             */
             update: (tag: string, data: Partial<IProductCache>) => Promise<void>;
             values: (data: FetchRemoteCachePayload) => Promise<import("./types").IRemoteCache[]>;
         };
         features: {
+            /**
+             * Creates a feature for a product.
+             * @param {Partial<IProductFeature>} data - The feature data.
+             * @returns {Promise<void>} Resolves when the feature is created. Throws on error.
+             */
             create: (data: Partial<IProductFeature>) => Promise<void>;
-            fetchAll: () => IProductFeature[];
-            fetch: (tag: string) => IProductFeature;
+            /**
+             * Fetches all features for a product.
+             * @returns {IProductFeature[]} The list of features.
+             */
+            fetchAll: () => Promise<IProductFeature[]>;
+            /**
+             * Fetches a feature by tag.
+             * @param {string} tag - The feature tag.
+             * @returns {IProductFeature|null} The fetched feature, or null if not found.
+             */
+            fetch: (tag: string) => Promise<IProductFeature>;
+            /**
+             * Updates a feature by tag.
+             * @param {string} tag - The feature tag.
+             * @param {Partial<IProductCache>} data - The feature data to update.
+             * @returns {Promise<void>} Resolves when the feature is updated. Throws on error.
+             */
             update: (tag: string, data: Partial<IProductCache>) => Promise<void>;
         };
     };
+    /**
+     * App-related operations for managing apps, variables, constants, actions, auths, webhooks, environments, and validation.
+     */
     app: {
+        /**
+         * Creates a new app.
+         * @param {ICreateAppBuilder} data - The app data.
+         * @returns {Promise<{ app_id: string }>} The ID of the created app.
+         */
         create: (data: ICreateAppBuilder) => Promise<{
             app_id: string;
         }>;
+        /**
+         * Fetches an app by tag.
+         * @param {string} tag - The app tag.
+         * @returns {Promise<IApp|null>} The fetched app, or null if not found.
+         */
         fetch: (tag: string) => Promise<IApp>;
+        /**
+         * Updates an app by tag.
+         * @param {string} tag - The app tag.
+         * @param {Partial<IApp>} data - The app data to update.
+         * @returns {Promise<void>} Resolves when the app is updated. Throws on error.
+         */
         update: (tag: string, data: Partial<IApp>) => Promise<void>;
+        /**
+         * Initializes an app by tag.
+         * @param {string} appTag - The app tag.
+         * @returns {Promise<void>} Resolves when initialization is complete. Throws on error.
+         */
         init: (appTag: string) => Promise<void>;
         variables: {
+            /**
+             * Creates a variable for an app.
+             * @param {IAppVariables} data - The variable data.
+             * @returns {Promise<void>} Resolves when the variable is created. Throws on error.
+             */
             create: (data: IAppVariables) => Promise<void>;
-            fetchAll: () => IAppVariables[];
-            fetch: (tag: string) => IAppVariables;
+            /**
+             * Fetches all variables for an app.
+             * @returns {IAppVariables[]} The list of variables.
+             */
+            fetchAll: () => Promise<IAppVariables[]>;
+            /**
+             * Fetches a variable by tag.
+             * @param {string} tag - The variable tag.
+             * @returns {IAppVariables|null} The fetched variable, or null if not found.
+             */
+            fetch: (tag: string) => Promise<IAppVariables>;
+            /**
+             * Updates a variable by tag.
+             * @param {string} tag - The variable tag.
+             * @param {Partial<IAppVariables>} data - The variable data to update.
+             * @returns {Promise<void>} Resolves when the variable is updated. Throws on error.
+             */
             update: (tag: string, data: Partial<IAppVariables>) => Promise<void>;
         };
         constants: {
+            /**
+             * Creates a constant for an app.
+             * @param {IAppConstants} data - The constant data.
+             * @returns {Promise<void>} Resolves when the constant is created. Throws on error.
+             */
             create: (data: IAppConstants) => Promise<void>;
-            fetchAll: () => IAppConstants[];
-            fetch: (tag: string) => IAppConstants;
+            /**
+             * Fetches all constants for an app.
+             * @returns {IAppConstants[]} The list of constants.
+             */
+            fetchAll: () => Promise<IAppConstants[]>;
+            /**
+             * Fetches a constant by tag.
+             * @param {string} tag - The constant tag.
+             * @returns {IAppConstants|null} The fetched constant, or null if not found.
+             */
+            fetch: (tag: string) => Promise<IAppConstants>;
+            /**
+             * Updates a constant by tag.
+             * @param {string} tag - The constant tag.
+             * @param {Partial<IAppVariables>} data - The constant data to update.
+             * @returns {Promise<void>} Resolves when the constant is updated. Throws on error.
+             */
             update: (tag: string, data: Partial<IAppVariables>) => Promise<void>;
         };
         actions: {
-            import: ({ file, type, version, appTag, updateIfExists, }: {
+            /**
+             * Imports actions for an app from a file.
+             * @param {Object} params - The import parameters.
+             * @param {Buffer} params.file - The file buffer.
+             * @param {ImportDocsTypes} params.type - The import type.
+             * @param {string} params.version - The version.
+             * @param {string} [params.appTag] - The app tag (optional).
+             * @param {boolean} [params.updateIfExists] - Whether to update if actions exist (optional).
+             * @returns {Promise<void>} Resolves when the import is complete. Throws on error.
+             */
+            import: ({ file, type, version, appTag, updateIfExists, isAdminImport, }: {
                 file: Buffer;
                 type: ImportDocsTypes;
                 version: string;
                 appTag?: string;
                 updateIfExists?: boolean;
+                isAdminImport?: boolean;
             }) => Promise<void>;
+            /**
+             * Updates an action by tag.
+             * @param {string} tag - The action tag.
+             * @param {Partial<IActionUpdate>} data - The action data to update.
+             * @returns {Promise<void>} Resolves when the action is updated. Throws on error.
+             */
             update: (tag: string, data: Partial<IActionUpdate>) => Promise<void>;
-            fetchAll: () => IAppAction[];
-            fetch: (tag: string) => IAppAction;
+            /**
+             * Updates an action by tag.
+             * @param {string} tag - The action tag.
+             * @param {Partial<IActionUpdate>} data - The action data to update.
+             * @returns {Promise<void>} Resolves when the action is updated. Throws on error.
+             */
+            create: (data: Partial<IActionUpdate> & {
+                tag: string;
+                name: string;
+                resource: string;
+                method: string;
+            }) => Promise<void>;
+            /**
+             * Fetches all actions for an app.
+             * @returns {IAppAction[]} The list of actions.
+             */
+            fetchAll: () => Promise<IAppAction[]>;
+            /**
+             * Fetches an action by tag.
+             * @param {string} tag - The action tag.
+             * @returns {IAppAction|null} The fetched action, or null if not found.
+             */
+            fetch: (tag: string) => Promise<IAppAction>;
         };
         auths: {
+            /**
+             * Creates an auth for an app.
+             * @param {IAppAuth} data - The auth data.
+             * @returns {Promise<void>} Resolves when the auth is created. Throws on error.
+             */
             create: (data: IAppAuth) => Promise<void>;
-            fetchAll: () => IAppAuth[];
-            fetch: (tag: string) => IAppAuth;
+            /**
+             * Fetches all auths for an app.
+             * @returns {IAppAuth[]} The list of auths.
+             */
+            fetchAll: () => Promise<IAppAuth[]>;
+            /**
+             * Fetches an auth by tag.
+             * @param {string} tag - The auth tag.
+             * @returns {IAppAuth|null} The fetched auth, or null if not found.
+             */
+            fetch: (tag: string) => Promise<IAppAuth>;
+            /**
+             * Updates an auth by tag.
+             * @param {string} tag - The auth tag.
+             * @param {Partial<IAppAuth>} data - The auth data to update.
+             * @returns {Promise<void>} Resolves when the auth is updated. Throws on error.
+             */
             update: (tag: string, data: Partial<IAppAuth>) => Promise<void>;
         };
         webhooks: {
+            /**
+             * Creates a webhook for an app.
+             * @param {Partial<IAppWebhook>} data - The webhook data.
+             * @returns {Promise<void>} Resolves when the webhook is created. Throws on error.
+             */
             create: (data: Partial<IAppWebhook>) => Promise<void>;
-            fetchAll: () => IAppWebhook[];
-            fetch: (tag: string) => IAppWebhook;
+            /**
+             * Fetches all webhooks for an app.
+             * @returns {IAppWebhook[]} The list of webhooks.
+             */
+            fetchAll: () => Promise<IAppWebhook[]>;
+            /**
+             * Fetches a webhook by tag.
+             * @param {string} tag - The webhook tag.
+             * @returns {IAppWebhook|null} The fetched webhook, or null if not found.
+             */
+            fetch: (tag: string) => Promise<IAppWebhook>;
+            /**
+             * Updates a webhook by tag.
+             * @param {string} tag - The webhook tag.
+             * @param {Partial<IAppWebhook>} data - The webhook data to update.
+             * @returns {Promise<void>} Resolves when the webhook is updated. Throws on error.
+             */
             update: (tag: string, data: Partial<IAppWebhook>) => Promise<void>;
             events: {
+                /**
+                 * Creates a webhook event for an app.
+                 * @param {IAppWebhookEvent} data - The webhook event data.
+                 * @returns {Promise<void>} Resolves when the webhook event is created. Throws on error.
+                 */
                 create: (data: IAppWebhookEvent) => Promise<void>;
-                fetchAll: (webhookTag: string) => IAppWebhookEvent[];
-                fetch: (tag: string) => IAppWebhookEvent;
+                /**
+                 * Fetches all webhook events for a webhook by tag.
+                 * @param {string} webhookTag - The webhook tag.
+                 * @returns {IAppWebhookEvent[]} The list of webhook events.
+                 */
+                fetchAll: (webhookTag: string) => Promise<IAppWebhookEvent[]>;
+                /**
+                 * Fetches a webhook event by tag.
+                 * @param {string} tag - The webhook event tag.
+                 * @returns {IAppWebhookEvent|null} The fetched webhook event, or null if not found.
+                 */
+                fetch: (tag: string) => Promise<IAppWebhookEvent>;
+                /**
+                 * Updates a webhook event by tag.
+                 * @param {string} tag - The webhook event tag.
+                 * @param {Partial<IAppWebhookEvent>} data - The webhook event data to update.
+                 * @returns {Promise<void>} Resolves when the webhook event is updated. Throws on error.
+                 */
                 update: (tag: string, data: Partial<IAppWebhookEvent>) => Promise<void>;
             };
         };
         environments: {
+            /**
+             * Creates an environment for an app.
+             * @param {IAppEnv} data - The environment data.
+             * @returns {Promise<void>} Resolves when the environment is created. Throws on error.
+             */
             create: (data: IAppEnv) => Promise<void>;
-            fetchAll: () => IAppEnv[];
-            fetch: (slug: string) => IAppEnv;
+            /**
+             * Fetches all environments for an app.
+             * @returns {IAppEnv[]} The list of environments.
+             */
+            fetchAll: () => Promise<IAppEnv[]>;
+            /**
+             * Fetches an environment by slug.
+             * @param {string} slug - The environment slug.
+             * @returns {IAppEnv|null} The fetched environment, or null if not found.
+             */
+            fetch: (slug: string) => Promise<IAppEnv>;
+            /**
+             * Updates an environment by slug.
+             * @param {string} slug - The environment slug.
+             * @param {Partial<IAppEnv>} data - The environment data to update.
+             * @returns {Promise<void>} Resolves when the environment is updated. Throws on error.
+             */
             update: (slug: string, data: Partial<IAppEnv>) => Promise<void>;
         };
+        /**
+         * Updates data validation for an app.
+         * @param {string} selector - The selector for the data validation.
+         * @param {Partial<IParsedSample>} update - The update data.
+         * @returns {Promise<void>} Resolves when the validation is updated. Throws on error.
+         */
         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.
+     */
     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.
+             * @param {IDBActionProcessorInput} data - The database action processor input.
+             * @returns {Promise<any>} The result of the database action processing.
+             */
             execute: (data: IDBActionProcessorInput) => Promise<any>;
             migration: {
+                /**
+                 * Runs a database migration.
+                 * @param {Object} params - The migration parameters.
+                 * @param {string} params.migration - The migration name.
+                 * @param {string} params.env - The environment.
+                 * @param {string} params.product - The product name.
+                 * @returns {Promise<any>} The result of the migration.
+                 */
                 run: ({ migration, env, product }: {
                     migration: string;
                     env: string;
@@ -219,6 +1082,14 @@ export default class Ductape implements IDuctape {
                 }) => Promise<{
                     process_id: string;
                 }>;
+                /**
+                 * Rolls back a database migration.
+                 * @param {Object} params - The migration parameters.
+                 * @param {string} params.migration - The migration name.
+                 * @param {string} params.env - The environment.
+                 * @param {string} params.product - The product name.
+                 * @returns {Promise<any>} The result of the rollback.
+                 */
                 rollback: ({ migration, env, product }: {
                     migration: string;
                     env: string;
@@ -229,12 +1100,39 @@ export default class Ductape implements IDuctape {
             };
         };
         sessions: {
-            generate: (data: ISessionInput) => Promise<import("./types").ISessionOutput>;
+            /**
+             * 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;
@@ -251,83 +1149,99 @@ export default class Ductape implements IDuctape {
                 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;
             }>;
         };
     };
+    /**
+     * Logs-related operations for initializing and fetching logs.
+     */
     logs: {
+        /**
+         * Initializes the logger service for a product or app.
+         * @param {string} [productTag] - The product tag (optional).
+         * @param {string} [appTag] - The app tag (optional).
+         * @throws {Error} If neither productTag nor appTag is provided.
+         * @returns {Promise<void>} Resolves when logger is initialized.
+         */
         init: (productTag?: string, appTag?: string) => Promise<void>;
         add: () => Promise<void>;
         /**
-         * Fetches logs based on provded query parameters.
-         *
-         * @param params.component - Required. Specifies the component type ('app' or 'product')
-         * @param params.type - Optional. Type of analysis ('apps', 'process', 'feature', 'integrations', etc.)
-         * @param params.groupBy - Optional. Time period for grouping ('day', 'week', 'month', 'year')
-         * @param params.search - Optional. Search term for filtering logs
-         * @param params.page - Optional. Page number for pagination (≥ 1)
-         * @param params.limit - Optional. Number of items per page (≥ 1)
-         * @param params.status - Optional. Filter by status ('success', 'processing', 'fail')
-         *
-         * For component='app':
-         * @param params.tag - Optional. Tag identifier (only valid when type='actions')
-         * @param params.env - Optional. Environment filter
-         * @param params.name - Optional. Name filter
-         * @param params.action - Optional. Specific action filter
-         *
-         * For component='product':
-         * @param params.env - Optional. Environment filter
-         * @param params.name - Optional. Name filter
-         * @param params.action - Optional. Specific action filter
-         *
-         * @throws {Error} If logger service is not initialized
-         * @throws {Error} If required parameters are missing or invalid
-         * @throws {Error} If API request fails
-         *
-         * @returns {Promise<any>} The fetched log data
-         *
-         * @example
-         * // Fetch app logs
-         * const appLogs = await logs.fetch({
-         *   component: 'app',
-         *   type: 'actions',
-         *   groupBy: 'day',
-         *   limit: 20
-         * });
-         *
-         * // Fetch product logs
-         * const productLogs = await logs.fetch({
-         *   component: 'product',
-         *   type: 'database',
-         *   status: 'success'
-         * });
+         * Fetches logs based on provided query parameters.
+         * @param {LogQueryParams} params - The log query parameters.
+         * @returns {Promise<any>} The fetched log data.
          */
         fetch: (params: LogQueryParams) => Promise<any>;
         publish: () => Promise<void>;
@@ -344,4 +1258,8 @@ export default class Ductape implements IDuctape {
     private refreshUserAccessToken;
     fetchWorkspaceApps(status: PublicStates): Promise<Array<IApp>>;
     fetchWorkspaceProjects(status: PublicStates): Promise<Array<IProduct>>;
+    /**
+     * Fetches the latest healthcheck status for a product/env from Redis cache via processor service.
+     */
+    getHealthcheckStatus(productTag: string, envSlug: string): Promise<any>;
 }