@intuned/runtime 1.3.17 → 1.3.18-interface.7

package/dist/export.d-BAUMB-lG.d.mts

@@ -0,0 +1,140 @@
+declare enum RunEnvironment {
+  IDE = "IDE",
+  DEPLOYED = "DEPLOYED",
+}
+
+/**
+ * @interface Payload
+ * @property {string} api - The API path you want to extend.
+ * @property {Record<string, any>} parameters - A record of key-value pairs representing the parameters to be sent to the API
+ *
+ * @example
+ *
+ * ```typescript payload
+ * import { Payload } from "@intuned/sdk/runtime"
+ *
+ * const payload: Payload = {
+ *   api: 'exampleApi',
+ *   parameters: {
+ *     key1: 'value1',
+ *     key2: 'value2'
+ *   }
+ * };
+ * ```
+ */
+interface Payload {
+  api: string;
+  parameters: Record<string, any>;
+}
+
+/**
+ * Represents information about the current run.
+ *
+ * @interface RunInfo
+ * @property {RunEnvironment} runEnvironment - the run environment `IDE` or `DEPLOYED`
+ * @property {string} [runId] - Optional. The ID of the current run, in IDE environment, run id will be undefined
+ */
+interface RunInfo {
+  runEnvironment: RunEnvironment;
+  runId?: string;
+  jobId?: string;
+  jobRunId?: string;
+  queueId?: string;
+  proxy?: string;
+  authSessionId?: string;
+}
+
+/**
+ * @interface RunErrorOptions
+ * @property {boolean} [retryable] - Optional. Indicates whether the error is retryable.
+ * @property {number} [status_code] - Optional. The HTTP status code associated with the error.
+ * @property {string} [error_code] - Optional. A specific error code to identify the type of error.
+ *
+ * @example
+ * ```typescript RunErrorOptions
+ * import { RunErrorOptions } from "@intuned/sdk/runtime"
+ *
+ * const options: RunErrorOptions = {
+ *   retryable: true,
+ *   status_code: 500,
+ *   error_code: 'SERVER_ERROR'
+ * };
+ * ```
+ */
+interface RunErrorOptions {
+  retryable?: boolean;
+  status_code?: number;
+  error_code?: string;
+}
+
+/**
+ * @interface AttemptStore
+ * @property {function} get - Retrieves a value from the store by key
+ * @property {function} set - Sets a value in the store by key
+ *
+ * @example
+ * ```typescript AttemptStore usage
+ * import { attemptStore } from "@intuned/sdk/runtime"
+ *
+ * // Set a value in the store
+ * attemptStore.set('openAiClient', openaiClient);
+ *
+ * // Get a value from the store
+ * const openAiClient = attemptStore.get('openAiClient');
+ * ```
+ */
+interface AttemptStore {
+  /**
+   * Retrieves a value from the store by key.
+   *
+   * @param {string} key - The key to retrieve the value for
+   * @returns {any} The value associated with the key, or undefined if not found
+   */
+  get(key: string): any;
+
+  /**
+   * Sets a value in the store by key.
+   *
+   * @param {string} key - The key to set the value for
+   * @param {any} value - The value to store
+   * @throws {Error} Throws an error if the store operation fails
+   */
+  set(key: string, value: any): void;
+}
+
+/**
+ * @interface PersistentStore
+ * @property {function} get - Retrieves a value from the store by key
+ * @property {function} set - Sets a value in the store by key
+ *
+ * @example
+ * ```typescript PersistentStore usage
+ * import { persistentStore } from "@intuned/sdk/runtime"
+ *
+ * // Set a value in the store
+ * persistentStore.set('data', { foo: 'bar' });
+ *
+ * // Get a value from the store
+ * await persistentStore.get('data');
+ * ```
+ */
+interface PersistentStore {
+  /**
+   * Retrieves a value from the store by key.
+   *
+   * @param {string} key - The key to retrieve the value for
+   * @returns {any} The value associated with the key, or undefined if not found
+   */
+  get(key: string): Promise<any>;
+
+  /**
+   * Sets a value in the store by key.
+   *
+   * @param {string} key - The key to set the value for
+   * @param {any} value - The value to store
+   * @throws {Error} Throws an error if the store operation fails
+   */
+  set(key: string, value: any): Promise<void>;
+}
+
+export type { AttemptStore as A, Payload as P, RunInfo as R, PersistentStore as a, RunErrorOptions as b };

package/dist/export.d-BAUMB-lG.d.ts

@@ -0,0 +1,140 @@
+declare enum RunEnvironment {
+  IDE = "IDE",
+  DEPLOYED = "DEPLOYED",
+}
+
+/**
+ * @interface Payload
+ * @property {string} api - The API path you want to extend.
+ * @property {Record<string, any>} parameters - A record of key-value pairs representing the parameters to be sent to the API
+ *
+ * @example
+ *
+ * ```typescript payload
+ * import { Payload } from "@intuned/sdk/runtime"
+ *
+ * const payload: Payload = {
+ *   api: 'exampleApi',
+ *   parameters: {
+ *     key1: 'value1',
+ *     key2: 'value2'
+ *   }
+ * };
+ * ```
+ */
+interface Payload {
+  api: string;
+  parameters: Record<string, any>;
+}
+
+/**
+ * Represents information about the current run.
+ *
+ * @interface RunInfo
+ * @property {RunEnvironment} runEnvironment - the run environment `IDE` or `DEPLOYED`
+ * @property {string} [runId] - Optional. The ID of the current run, in IDE environment, run id will be undefined
+ */
+interface RunInfo {
+  runEnvironment: RunEnvironment;
+  runId?: string;
+  jobId?: string;
+  jobRunId?: string;
+  queueId?: string;
+  proxy?: string;
+  authSessionId?: string;
+}
+
+/**
+ * @interface RunErrorOptions
+ * @property {boolean} [retryable] - Optional. Indicates whether the error is retryable.
+ * @property {number} [status_code] - Optional. The HTTP status code associated with the error.
+ * @property {string} [error_code] - Optional. A specific error code to identify the type of error.
+ *
+ * @example
+ * ```typescript RunErrorOptions
+ * import { RunErrorOptions } from "@intuned/sdk/runtime"
+ *
+ * const options: RunErrorOptions = {
+ *   retryable: true,
+ *   status_code: 500,
+ *   error_code: 'SERVER_ERROR'
+ * };
+ * ```
+ */
+interface RunErrorOptions {
+  retryable?: boolean;
+  status_code?: number;
+  error_code?: string;
+}
+
+/**
+ * @interface AttemptStore
+ * @property {function} get - Retrieves a value from the store by key
+ * @property {function} set - Sets a value in the store by key
+ *
+ * @example
+ * ```typescript AttemptStore usage
+ * import { attemptStore } from "@intuned/sdk/runtime"
+ *
+ * // Set a value in the store
+ * attemptStore.set('openAiClient', openaiClient);
+ *
+ * // Get a value from the store
+ * const openAiClient = attemptStore.get('openAiClient');
+ * ```
+ */
+interface AttemptStore {
+  /**
+   * Retrieves a value from the store by key.
+   *
+   * @param {string} key - The key to retrieve the value for
+   * @returns {any} The value associated with the key, or undefined if not found
+   */
+  get(key: string): any;
+
+  /**
+   * Sets a value in the store by key.
+   *
+   * @param {string} key - The key to set the value for
+   * @param {any} value - The value to store
+   * @throws {Error} Throws an error if the store operation fails
+   */
+  set(key: string, value: any): void;
+}
+
+/**
+ * @interface PersistentStore
+ * @property {function} get - Retrieves a value from the store by key
+ * @property {function} set - Sets a value in the store by key
+ *
+ * @example
+ * ```typescript PersistentStore usage
+ * import { persistentStore } from "@intuned/sdk/runtime"
+ *
+ * // Set a value in the store
+ * persistentStore.set('data', { foo: 'bar' });
+ *
+ * // Get a value from the store
+ * await persistentStore.get('data');
+ * ```
+ */
+interface PersistentStore {
+  /**
+   * Retrieves a value from the store by key.
+   *
+   * @param {string} key - The key to retrieve the value for
+   * @returns {any} The value associated with the key, or undefined if not found
+   */
+  get(key: string): Promise<any>;
+
+  /**
+   * Sets a value in the store by key.
+   *
+   * @param {string} key - The key to set the value for
+   * @param {any} value - The value to store
+   * @throws {Error} Throws an error if the store operation fails
+   */
+  set(key: string, value: any): Promise<void>;
+}
+
+export type { AttemptStore as A, Payload as P, RunInfo as R, PersistentStore as a, RunErrorOptions as b };

package/dist/index.d.mts

@@ -0,0 +1,6 @@
+export { RunError, attemptStore, extendPayload, extendTimeout, getAiGatewayConfig, getAuthSessionParameters, getDownloadDirectoryPath, onCaptchaEvent, onceCaptchaEvent, pauseCaptchaSolver, persistentStore, removeCaptchaEventListener, resumeCaptchaSolver, runInfo, waitForCaptchaSolve, withWaitForCaptchaSolve } from './runtime/index.mjs';
+export { getExecutionContext, runWithContext } from './common/asyncLocalStorage/index.mjs';
+import './export.d-BAUMB-lG.mjs';
+import 'playwright';
+import 'zod';
+import 'node:async_hooks';

package/dist/index.d.ts

@@ -1,5 +1,6 @@
-export { extendPayload, extendTimeout, runInfo, RunError, getAuthSessionParameters, attemptStore, persistentStore, getAiGatewayConfig, } from "./runtime";
-export { runWithContext, getExecutionContext, } from "./common/asyncLocalStorage";
-export { getDownloadDirectoryPath } from "./runtime/downloadDirectory";
-export { withPlaywrightContext } from "./common/playwrightContext";
-export { waitForCaptchaSolve, withWaitForCaptchaSolve, onCaptchaEvent, onceCaptchaEvent, removeCaptchaEventListener, pauseCaptchaSolver, resumeCaptchaSolver, } from "./runtime/captcha";
+export { RunError, attemptStore, extendPayload, extendTimeout, getAiGatewayConfig, getAuthSessionParameters, getDownloadDirectoryPath, onCaptchaEvent, onceCaptchaEvent, pauseCaptchaSolver, persistentStore, removeCaptchaEventListener, resumeCaptchaSolver, runInfo, waitForCaptchaSolve, withWaitForCaptchaSolve } from './runtime/index.js';
+export { getExecutionContext, runWithContext } from './common/asyncLocalStorage/index.js';
+import './export.d-BAUMB-lG.js';
+import 'playwright';
+import 'zod';
+import 'node:async_hooks';