@intuned/runtime-dev 0.1.0-test.10 → 0.1.0-test.12

package/dist/runtime/RunError.ts

@@ -0,0 +1,12 @@
+export class RunError extends Error {
+  constructor(message, options) {
+    super(message);
+    this.message = message;
+    this.name = "USER_GENERATED_ERROR";
+    this.options = options ?? {
+      retryable: false
+    };
+    Object.setPrototypeOf(this, RunError.prototype);
+  }
+}
+new RunError("", {});

package/dist/runtime/downloadDirectory.js

@@ -1,19 +1,13 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.getDownloadDirectoryPath = getDownloadDirectoryPath;
-var _ = require("..");
-var _fsExtra = require("fs-extra");
-function getDownloadDirectoryPath() {
-  const context = (0, _.getExecutionContext)();
-  if (!context) {
-    throw new Error("ExecutionContext not found");
-  }
-  const path = `/tmp/downloads/${context.runId}`;
-  (0, _fsExtra.ensureDirSync)(path, {
-    mode: 0o2775
-  });
-  return path;
-}
+import { getExecutionContext } from "..";
+import { ensureDirSync } from "fs-extra";
+export function getDownloadDirectoryPath() {
+    const context = getExecutionContext();
+    if (!context) {
+        throw new Error("ExecutionContext not found");
+    }
+    const path = `/tmp/downloads/${context.runId}`;
+    ensureDirSync(path, {
+        mode: 0o2775,
+    });
+    return path;
+}

package/dist/runtime/downloadDirectory.ts

@@ -0,0 +1,13 @@
+import { getExecutionContext } from "..";
+import { ensureDirSync } from "fs-extra";
+export function getDownloadDirectoryPath() {
+  const context = getExecutionContext();
+  if (!context) {
+    throw new Error("ExecutionContext not found");
+  }
+  const path = `/tmp/downloads/${context.runId}`;
+  ensureDirSync(path, {
+    mode: 0o2775
+  });
+  return path;
+}

package/dist/runtime/enums.d.ts

@@ -1,11 +1 @@
-export declare enum RunEnvironment {
-  IDE = "IDE",
-  DEPLOYED = "DEPLOYED",
-}
-
-export declare enum RunType {
-  SYNC = "SYNC",
-  ASYNC = "ASYNC",
-  JOB = "JOB",
-  QUEUE = "QUEUE",
-}
+export {};

package/dist/runtime/enums.js

@@ -1,18 +1,12 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.RunType = exports.RunEnvironment = void 0;
-let RunEnvironment = exports.RunEnvironment = function (RunEnvironment) {
-  RunEnvironment["IDE"] = "IDE";
-  RunEnvironment["DEPLOYED"] = "DEPLOYED";
-  return RunEnvironment;
-}({});
-let RunType = exports.RunType = function (RunType) {
-  RunType["SYNC"] = "SYNC";
-  RunType["ASYNC"] = "ASYNC";
-  RunType["JOB"] = "JOB";
-  RunType["QUEUE"] = "QUEUE";
-  return RunType;
-}({});
+export var RunEnvironment;
+(function (RunEnvironment) {
+    RunEnvironment["IDE"] = "IDE";
+    RunEnvironment["DEPLOYED"] = "DEPLOYED";
+})(RunEnvironment || (RunEnvironment = {}));
+export var RunType;
+(function (RunType) {
+    RunType["SYNC"] = "SYNC";
+    RunType["ASYNC"] = "ASYNC";
+    RunType["JOB"] = "JOB";
+    RunType["QUEUE"] = "QUEUE";
+})(RunType || (RunType = {}));

package/dist/runtime/enums.ts

@@ -0,0 +1,12 @@
+export let RunEnvironment = function (RunEnvironment) {
+  RunEnvironment["IDE"] = "IDE";
+  RunEnvironment["DEPLOYED"] = "DEPLOYED";
+  return RunEnvironment;
+}({});
+export let RunType = function (RunType) {
+  RunType["SYNC"] = "SYNC";
+  RunType["ASYNC"] = "ASYNC";
+  RunType["JOB"] = "JOB";
+  RunType["QUEUE"] = "QUEUE";
+  return RunType;
+}({});

package/dist/runtime/executionHelpers.test.ts

@@ -0,0 +1,51 @@
+import { describe, expect, it } from "vitest";
+import { getExecutionContext, runWithContext } from "../common/asyncLocalStorage";
+import { extendPayload, runInfo } from "./index.js";
+import { RunEnvironment } from "./enums.js";
+describe("Execution Helpers", () => {
+  it("should be able to get execution info", () => {
+    runWithContext({
+      runEnvironment: RunEnvironment.IDE,
+      runId: "test-run-id",
+      extendedPayloads: []
+    }, () => {
+      expect(runInfo().runId).toEqual("test-run-id");
+    });
+  });
+  it("should be able to mutate extendedPayloads and get the accmulated value at the end ", () => {
+    const context = {
+      extendedPayloads: [],
+      runId: "test-run-id"
+    };
+    runWithContext({
+      runEnvironment: RunEnvironment.IDE,
+      runId: "test-run-id",
+      extendedPayloads: []
+    }, () => {
+      var _getExecutionContext, _getExecutionContext2;
+      expect((_getExecutionContext = getExecutionContext()) === null || _getExecutionContext === void 0 ? void 0 : _getExecutionContext.extendedPayloads).toEqual([]);
+      extendPayload({
+        api: "test-api",
+        parameters: {}
+      });
+      expect((_getExecutionContext2 = getExecutionContext()) === null || _getExecutionContext2 === void 0 ? void 0 : _getExecutionContext2.extendedPayloads).toEqual([{
+        api: "test-api",
+        parameters: {}
+      }]);
+      extendPayload({
+        api: "test-api",
+        parameters: {}
+      });
+      extendPayload({
+        api: "test-api",
+        parameters: {}
+      });
+      extendPayload({
+        api: "test-api",
+        parameters: {}
+      });
+      const context = getExecutionContext();
+      expect(context === null || context === void 0 ? void 0 : context.extendedPayloads).toHaveLength(4);
+    });
+  });
+});

package/dist/runtime/export.d.ts

@@ -1,202 +1 @@
-import { RunEnvironment } from "./enums";
-
-/**
- * ## Description
- * In the context of a job, extendTimeout will increase the timeout of the currently executing payload.
- * This is useful when the payload is expected to take a long time. For example, when running pagination code.
- *
- * @example
- * ```typescript Example
- * import { extendTimeout } from "@intuned/sdk/runtime"
- *
- * extendTimeout();
- * ```
- *
- */
-export declare function extendTimeout(): void;
-
-/**
- * ## Description
- * In the context of a job or queue execution, extendPayload appends new payloads to the end of the queue of job.
- * Calling extendPayload will also call extendTimeout.
- *
- * @param {Payload | Payload[]} payload - The payload or array of payloads to extend. you can specify the api name and what parameters you want to pass it, the new added apis will use the same proxy and auth-session settings as the api that extended them
- *
- * @example
- * ```typescript Single payload
- * import { extendPayload } from "@intuned/sdk/runtime"
- *
- * // this function will append the exampleApi to the end of the queue or job it's executing in.
- * extendPayload({ api: 'exampleApi', parameters: { key: 'value' } });
- * ```
- *
- * @example
- * ```typescript Array of payloads
- * import { extendPayload } from "@intuned/sdk/runtime"
- *
- * const payloadArray: Payload[] = [
- *   { api: 'exampleApi1', parameters: { key1: 'value1' } },
- *   { api: 'exampleApi2', parameters: { key2: 'value2' } }
- * ];
- *
- * // this function will append 2 apis to the end of the queue or job it's executing in.
- * extendPayload(payloadArray);
- * ```
- */
-export declare function extendPayload(payload: Payload | Payload[]): void;
-
-/**
- * @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'
- *   }
- * };
- * ```
- */
-export interface Payload {
-  api: string;
-  parameters: Record<string, any>;
-}
-
-/**
- * Retrieves information about the current run environment.
- *
- * @returns {RunInfo} An object containing details about the run environment and the run ID.
- *
- * @example
- * ```typescript runInfo
- * import { runInfo } from "@intuned/sdk/runtime"
- *
- * const info = runInfo();
- * console.log(info.runEnvironment); // Outputs the run environment, IDE or DEPLOYED
- * console.log(info.runId); // Outputs the run ID, if available, in IDE run id will be undefined
- * ```
- */
-export declare function runInfo(): RunInfo;
-
-/**
- * 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
- */
-export interface RunInfo {
-  runEnvironment: RunEnvironment;
-  runId?: string;
-  jobId?: string;
-  jobRunId?: string;
-  queueId?: string;
-  proxy?: 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'
- * };
- * ```
- */
-export interface RunErrorOptions {
-  retryable?: boolean;
-  status_code?: number;
-  error_code?: string;
-}
-
-/**
- * Represents an error that occurs during a run.
- *
- * @class
- * @extends Error
- *
- * @param {string} message - The error message.
- * @param {RunErrorOptions} [options] - Optional. Additional options for the error.
- *
- * @property {RunErrorOptions} options - The options associated with the error.
- *
- * @example
- * ```typescript RunError
- * import { RunError } from "@intuned/sdk/runtime"
- *
- * throw new RunError('An error occurred', {
- *   retryable: true,
- *   status_code: 500,
- *   error_code: 'SERVER_ERROR'
- * });
- *
- * ```
- */
-export declare class RunError extends Error {
-  constructor(message: string, options?: RunErrorOptions);
-  options: RunErrorOptions;
-}
-
-/**
- * in the create auth session flow, you might to need a multiple choice answer from the user, requestMultipleChoice prompts the user with the question and possible options and returns their selection.
- *
- * **Note:** This function is currently in beta and may be subject to changes.
- *
- * @param {string} message - The message to display to the user.
- * @param {string[]} choices - An array of choices to present to the user.
- *
- * @example
- * ```typescript requestMultipleChoice
- * // in auth-sessions/create.ts
- *
- * import { requestMultipleChoice } from "@intuned/sdk/runtime"
- *
- * const message = "What is your favorite color?";
- * const choices = ["Red", "Blue", "Green", "Yellow"];
- *
- * const selectedChoice = yield requestMultipleChoice(message, choices);
- *
- * console.log(selectedChoice);
- * ```
- */
-export declare function requestMultipleChoice(
-  message: string,
-  choices: string[]
-): unknown;
-
-/**
- * **Note:** This function is currently in beta and may be subject to changes.
- *
- * requestOTP help you to ask the user for an otp in the create auth-session flow.
- *
- * @param {string} message - The message to display to the user.
- *
- * @example
- * ```typescript requestOTP
- * // in auth-sessions/create.ts
- *
- * import { requestOTP } from "@intuned/sdk/runtime"
- *
- * const message = "please submit and OTP from your authenticator app";
- *
- * const otp = yield requestOTP(message);
- *
- * console.log(otp);
- * ```
- */
-export declare function requestOTP(message: string): unknown;
+export {};

package/dist/runtime/extendPayload.d.ts

@@ -1,2 +1,2 @@
-import { Payload } from "./export";
+import { Payload } from "./export.js";
 export declare function extendPayload(payload: Payload | Payload[]): void;

package/dist/runtime/extendPayload.js

@@ -1,21 +1,15 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.extendPayload = extendPayload;
-var _asyncLocalStorage = require("../common/asyncLocalStorage");
-var _extendTimeout = require("./extendTimeout");
-function extendPayload(payload) {
-  const context = (0, _asyncLocalStorage.getExecutionContext)();
-  if (!context) {
-    throw new Error("extendPayload failed due to an internal error.");
-  }
-  const items = Array.isArray(payload) ? payload : [payload];
-  if (!context.extendedPayloads) {
-    context.extendedPayloads = [...items];
-    return;
-  }
-  context === null || context === void 0 || context.extendedPayloads.push(...items);
-  (0, _extendTimeout.extendTimeout)();
-}
+import { getExecutionContext } from "../common/asyncLocalStorage";
+import { extendTimeout } from "./extendTimeout.js";
+export function extendPayload(payload) {
+    const context = getExecutionContext();
+    if (!context) {
+        throw new Error("extendPayload failed due to an internal error.");
+    }
+    const items = Array.isArray(payload) ? payload : [payload];
+    if (!context.extendedPayloads) {
+        context.extendedPayloads = [...items];
+        return;
+    }
+    context?.extendedPayloads.push(...items);
+    extendTimeout();
+}

package/dist/runtime/extendPayload.ts

@@ -0,0 +1,15 @@
+import { getExecutionContext } from "../common/asyncLocalStorage";
+import { extendTimeout } from "./extendTimeout.js";
+export function extendPayload(payload) {
+  const context = getExecutionContext();
+  if (!context) {
+    throw new Error("extendPayload failed due to an internal error.");
+  }
+  const items = Array.isArray(payload) ? payload : [payload];
+  if (!context.extendedPayloads) {
+    context.extendedPayloads = [...items];
+    return;
+  }
+  context === null || context === void 0 || context.extendedPayloads.push(...items);
+  extendTimeout();
+}

package/dist/runtime/extendTimeout.js

@@ -1,30 +1,23 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.extendTimeout = extendTimeout;
-var _asyncLocalStorage = require("../common/asyncLocalStorage");
+import { getExecutionContext } from "../common/asyncLocalStorage";
 const _DEBOUNCE_TIME = 60_000;
-function extendTimeout() {
-  const context = (0, _asyncLocalStorage.getExecutionContext)();
-  if (!context) {
-    throw new Error("extendTimeout failed due to an internal error.");
-  }
-  const {
-    timeoutInfo
-  } = context;
-  if (!timeoutInfo) {
-    return;
-  }
-  if (timeoutInfo.timeoutTimestamp !== undefined && timeoutInfo.timeoutDuration !== undefined) {
-    const newTimeoutStamp = Date.now() + timeoutInfo.timeoutDuration;
-    if (newTimeoutStamp - timeoutInfo.timeoutTimestamp < _DEBOUNCE_TIME) {
-      return;
+export function extendTimeout() {
+    const context = getExecutionContext();
+    if (!context) {
+        throw new Error("extendTimeout failed due to an internal error.");
     }
-    timeoutInfo.timeoutTimestamp = newTimeoutStamp;
-  }
-  if (timeoutInfo.extendTimeoutCallback !== undefined) {
-    void timeoutInfo.extendTimeoutCallback().catch(() => undefined);
-  }
-}
+    const { timeoutInfo } = context;
+    if (!timeoutInfo) {
+        return;
+    }
+    if (timeoutInfo.timeoutTimestamp !== undefined &&
+        timeoutInfo.timeoutDuration !== undefined) {
+        const newTimeoutStamp = Date.now() + timeoutInfo.timeoutDuration;
+        if (newTimeoutStamp - timeoutInfo.timeoutTimestamp < _DEBOUNCE_TIME) {
+            return;
+        }
+        timeoutInfo.timeoutTimestamp = newTimeoutStamp;
+    }
+    if (timeoutInfo.extendTimeoutCallback !== undefined) {
+        void timeoutInfo.extendTimeoutCallback().catch(() => undefined);
+    }
+}

package/dist/runtime/extendTimeout.ts

@@ -0,0 +1,24 @@
+import { getExecutionContext } from "../common/asyncLocalStorage";
+const _DEBOUNCE_TIME = 60_000;
+export function extendTimeout() {
+  const context = getExecutionContext();
+  if (!context) {
+    throw new Error("extendTimeout failed due to an internal error.");
+  }
+  const {
+    timeoutInfo
+  } = context;
+  if (!timeoutInfo) {
+    return;
+  }
+  if (timeoutInfo.timeoutTimestamp !== undefined && timeoutInfo.timeoutDuration !== undefined) {
+    const newTimeoutStamp = Date.now() + timeoutInfo.timeoutDuration;
+    if (newTimeoutStamp - timeoutInfo.timeoutTimestamp < _DEBOUNCE_TIME) {
+      return;
+    }
+    timeoutInfo.timeoutTimestamp = newTimeoutStamp;
+  }
+  if (timeoutInfo.extendTimeoutCallback !== undefined) {
+    void timeoutInfo.extendTimeoutCallback().catch(() => undefined);
+  }
+}

package/dist/runtime/index.d.ts

@@ -1,7 +1,7 @@
-export { extendPayload } from "./extendPayload";
-export { extendTimeout } from "./extendTimeout";
-export { runInfo } from "./runInfo";
-export { RunError } from "./RunError";
-export { requestMultipleChoice, requestOTP } from "./requestMoreInfo";
-export type { RequestMoreInfoDetails } from "./requestMoreInfo";
-export { getDownloadDirectoryPath } from "./downloadDirectory";
+export { extendPayload } from "./extendPayload.js";
+export { extendTimeout } from "./extendTimeout.js";
+export { runInfo } from "./runInfo.js";
+export { RunError } from "./RunError.js";
+export { requestMultipleChoice, requestOTP } from "./requestMoreInfo.js";
+export type { RequestMoreInfoDetails } from "./requestMoreInfo.js";
+export { getDownloadDirectoryPath } from "./downloadDirectory.js";

package/dist/runtime/index.js

@@ -1,53 +1,6 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-Object.defineProperty(exports, "RunError", {
-  enumerable: true,
-  get: function () {
-    return _RunError.RunError;
-  }
-});
-Object.defineProperty(exports, "extendPayload", {
-  enumerable: true,
-  get: function () {
-    return _extendPayload.extendPayload;
-  }
-});
-Object.defineProperty(exports, "extendTimeout", {
-  enumerable: true,
-  get: function () {
-    return _extendTimeout.extendTimeout;
-  }
-});
-Object.defineProperty(exports, "getDownloadDirectoryPath", {
-  enumerable: true,
-  get: function () {
-    return _downloadDirectory.getDownloadDirectoryPath;
-  }
-});
-Object.defineProperty(exports, "requestMultipleChoice", {
-  enumerable: true,
-  get: function () {
-    return _requestMoreInfo.requestMultipleChoice;
-  }
-});
-Object.defineProperty(exports, "requestOTP", {
-  enumerable: true,
-  get: function () {
-    return _requestMoreInfo.requestOTP;
-  }
-});
-Object.defineProperty(exports, "runInfo", {
-  enumerable: true,
-  get: function () {
-    return _runInfo.runInfo;
-  }
-});
-var _extendPayload = require("./extendPayload");
-var _extendTimeout = require("./extendTimeout");
-var _runInfo = require("./runInfo");
-var _RunError = require("./RunError");
-var _requestMoreInfo = require("./requestMoreInfo");
-var _downloadDirectory = require("./downloadDirectory");
+export { extendPayload } from "./extendPayload.js";
+export { extendTimeout } from "./extendTimeout.js";
+export { runInfo } from "./runInfo.js";
+export { RunError } from "./RunError.js";
+export { requestMultipleChoice, requestOTP } from "./requestMoreInfo.js";
+export { getDownloadDirectoryPath } from "./downloadDirectory.js";

package/dist/runtime/index.ts

@@ -0,0 +1,6 @@
+export { extendPayload } from "./extendPayload.js";
+export { extendTimeout } from "./extendTimeout.js";
+export { runInfo } from "./runInfo.js";
+export { RunError } from "./RunError.js";
+export { requestMultipleChoice, requestOTP } from "./requestMoreInfo.js";
+export { getDownloadDirectoryPath } from "./downloadDirectory.js";

package/dist/runtime/requestMoreInfo.js

@@ -1,25 +1,18 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.requestMultipleChoice = requestMultipleChoice;
-exports.requestOTP = requestOTP;
 const REQUEST_MORE_INFO_KEY = Symbol("REQUEST_MORE_INFO");
-function requestOTP(messageToUser) {
-  return {
-    [REQUEST_MORE_INFO_KEY]: true,
-    action: "request_more_info",
-    messageToUser,
-    requestType: "otp"
-  };
+export function requestOTP(messageToUser) {
+    return {
+        [REQUEST_MORE_INFO_KEY]: true,
+        action: "request_more_info",
+        messageToUser,
+        requestType: "otp",
+    };
+}
+export function requestMultipleChoice(messageToUser, choices) {
+    return {
+        [REQUEST_MORE_INFO_KEY]: true,
+        action: "request_more_info",
+        messageToUser,
+        requestType: "multiple_choice",
+        choices,
+    };
 }
-function requestMultipleChoice(messageToUser, choices) {
-  return {
-    [REQUEST_MORE_INFO_KEY]: true,
-    action: "request_more_info",
-    messageToUser,
-    requestType: "multiple_choice",
-    choices
-  };
-}

package/dist/runtime/requestMoreInfo.ts

@@ -0,0 +1,18 @@
+const REQUEST_MORE_INFO_KEY = Symbol("REQUEST_MORE_INFO");
+export function requestOTP(messageToUser) {
+  return {
+    [REQUEST_MORE_INFO_KEY]: true,
+    action: "request_more_info",
+    messageToUser,
+    requestType: "otp"
+  };
+}
+export function requestMultipleChoice(messageToUser, choices) {
+  return {
+    [REQUEST_MORE_INFO_KEY]: true,
+    action: "request_more_info",
+    messageToUser,
+    requestType: "multiple_choice",
+    choices
+  };
+}

package/dist/runtime/runInfo.d.ts

@@ -1,2 +1,2 @@
-import { RunInfo } from "./export";
+import { RunInfo } from "./export.js";
 export declare function runInfo(): RunInfo;