@intuned/runtime-dev 1.3.8-jsonl.0 → 1.3.9-dev1

package/package/dist/common/telemetry.js

@@ -0,0 +1,32 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getTelemetryClient = getTelemetryClient;
+exports.initializeAppInsights = initializeAppInsights;
+var appInsights = _interopRequireWildcard(require("applicationinsights"));
+function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function (e) { return e ? t : r; })(e); }
+function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
+function gracefulShutdown() {
+  console.log("Shutting down, so flushing app insights.");
+  appInsights.defaultClient.flush();
+  process.exit();
+}
+function initializeAppInsights() {
+  const appInsightsConnectionString = process.env.APPINSIGHTS_CONNECTION_STRING;
+  if (appInsightsConnectionString) {
+    console.log("Initializing app insights.");
+    appInsights.setup(appInsightsConnectionString).setAutoCollectConsole(true, true).setAutoCollectDependencies(true).setAutoCollectExceptions(true).setAutoCollectHeartbeat(true).setAutoCollectPerformance(true, true).setAutoCollectRequests(true).setAutoDependencyCorrelation(true).setDistributedTracingMode(appInsights.DistributedTracingModes.AI_AND_W3C).setSendLiveMetrics(true).setUseDiskRetryCaching(true);
+    appInsights.defaultClient.context.tags[appInsights.defaultClient.context.keys.cloudRole] = "@intuned/sdk";
+    if (process.env.FLY_APP_NAME) {
+      appInsights.defaultClient.context.tags[appInsights.defaultClient.context.keys.cloudRoleInstance] = process.env.FLY_APP_NAME;
+    }
+    process.on("SIGTERM", gracefulShutdown);
+    process.on("SIGINT", gracefulShutdown);
+    appInsights.start();
+  }
+}
+function getTelemetryClient() {
+  return appInsights.defaultClient;
+}

package/package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export { extendPayload, extendTimeout, runInfo, RunError, getAuthSessionParameters, attemptStore, } from "./runtime";
+export { runWithContext, getExecutionContext, } from "./common/asyncLocalStorage";
+export { getDownloadDirectoryPath } from "./runtime/downloadDirectory";
+export { withPlaywrightContext } from "./common/playwrightContext";

package/package/dist/index.js

@@ -0,0 +1,69 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "RunError", {
+  enumerable: true,
+  get: function () {
+    return _runtime.RunError;
+  }
+});
+Object.defineProperty(exports, "attemptStore", {
+  enumerable: true,
+  get: function () {
+    return _runtime.attemptStore;
+  }
+});
+Object.defineProperty(exports, "extendPayload", {
+  enumerable: true,
+  get: function () {
+    return _runtime.extendPayload;
+  }
+});
+Object.defineProperty(exports, "extendTimeout", {
+  enumerable: true,
+  get: function () {
+    return _runtime.extendTimeout;
+  }
+});
+Object.defineProperty(exports, "getAuthSessionParameters", {
+  enumerable: true,
+  get: function () {
+    return _runtime.getAuthSessionParameters;
+  }
+});
+Object.defineProperty(exports, "getDownloadDirectoryPath", {
+  enumerable: true,
+  get: function () {
+    return _downloadDirectory.getDownloadDirectoryPath;
+  }
+});
+Object.defineProperty(exports, "getExecutionContext", {
+  enumerable: true,
+  get: function () {
+    return _asyncLocalStorage.getExecutionContext;
+  }
+});
+Object.defineProperty(exports, "runInfo", {
+  enumerable: true,
+  get: function () {
+    return _runtime.runInfo;
+  }
+});
+Object.defineProperty(exports, "runWithContext", {
+  enumerable: true,
+  get: function () {
+    return _asyncLocalStorage.runWithContext;
+  }
+});
+Object.defineProperty(exports, "withPlaywrightContext", {
+  enumerable: true,
+  get: function () {
+    return _playwrightContext.withPlaywrightContext;
+  }
+});
+var _runtime = require("./runtime");
+var _asyncLocalStorage = require("./common/asyncLocalStorage");
+var _downloadDirectory = require("./runtime/downloadDirectory");
+var _playwrightContext = require("./common/playwrightContext");

package/package/dist/runtime/RunError.d.ts

@@ -0,0 +1,5 @@
+import { RunErrorOptions } from "./export";
+export declare class RunError extends Error {
+    options: RunErrorOptions;
+    constructor(message: string, options?: RunErrorOptions);
+}

package/package/dist/runtime/RunError.js

@@ -0,0 +1,19 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.RunError = void 0;
+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);
+  }
+}
+exports.RunError = RunError;
+new RunError("", {});

package/package/dist/runtime/attemptStore.d.ts

@@ -0,0 +1,2 @@
+import { Store } from "./export";
+export declare const attemptStore: Store;

package/package/dist/runtime/attemptStore.js

@@ -0,0 +1,23 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.attemptStore = void 0;
+var _asyncLocalStorage = require("../common/asyncLocalStorage");
+const attemptStore = exports.attemptStore = Object.freeze({
+  get: key => {
+    const context = (0, _asyncLocalStorage.getExecutionContext)();
+    return context?.store ? context.store[key] : undefined;
+  },
+  set: (key, value) => {
+    const context = (0, _asyncLocalStorage.getExecutionContext)();
+    if (!context) {
+      throw new Error("store.set failed due to an internal error.");
+    }
+    if (!context.store) {
+      context.store = {};
+    }
+    context.store[key] = value;
+  }
+});

package/package/dist/runtime/downloadDirectory.d.ts

@@ -0,0 +1 @@
+export declare function getDownloadDirectoryPath(): string;

package/package/dist/runtime/downloadDirectory.js

@@ -0,0 +1,19 @@
+"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;
+}

package/package/dist/runtime/enums.d.js

@@ -0,0 +1,5 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});

package/package/dist/runtime/enums.d.ts

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

package/package/dist/runtime/enums.js

@@ -0,0 +1,18 @@
+"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;
+}({});

package/package/dist/runtime/executionHelpers.test.js

@@ -0,0 +1,52 @@
+"use strict";
+
+var _vitest = require("vitest");
+var _asyncLocalStorage = require("../common/asyncLocalStorage");
+var _ = require(".");
+var _enums = require("./enums");
+(0, _vitest.describe)("Execution Helpers", () => {
+  (0, _vitest.it)("should be able to get execution info", () => {
+    (0, _asyncLocalStorage.runWithContext)({
+      runEnvironment: _enums.RunEnvironment.IDE,
+      runId: "test-run-id",
+      extendedPayloads: []
+    }, () => {
+      (0, _vitest.expect)((0, _.runInfo)().runId).toEqual("test-run-id");
+    });
+  });
+  (0, _vitest.it)("should be able to mutate extendedPayloads and get the accmulated value at the end ", () => {
+    const context = {
+      extendedPayloads: [],
+      runId: "test-run-id"
+    };
+    (0, _asyncLocalStorage.runWithContext)({
+      runEnvironment: _enums.RunEnvironment.IDE,
+      runId: "test-run-id",
+      extendedPayloads: []
+    }, () => {
+      (0, _vitest.expect)((0, _asyncLocalStorage.getExecutionContext)()?.extendedPayloads).toEqual([]);
+      (0, _.extendPayload)({
+        api: "test-api",
+        parameters: {}
+      });
+      (0, _vitest.expect)((0, _asyncLocalStorage.getExecutionContext)()?.extendedPayloads).toEqual([{
+        api: "test-api",
+        parameters: {}
+      }]);
+      (0, _.extendPayload)({
+        api: "test-api",
+        parameters: {}
+      });
+      (0, _.extendPayload)({
+        api: "test-api",
+        parameters: {}
+      });
+      (0, _.extendPayload)({
+        api: "test-api",
+        parameters: {}
+      });
+      const context = (0, _asyncLocalStorage.getExecutionContext)();
+      (0, _vitest.expect)(context?.extendedPayloads).toHaveLength(4);
+    });
+  });
+});

package/package/dist/runtime/export.d.js

@@ -0,0 +1,5 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});

package/package/dist/runtime/export.d.ts

@@ -0,0 +1,228 @@
+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;
+  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'
+ * };
+ * ```
+ */
+export interface RunErrorOptions {
+  retryable?: boolean;
+  status_code?: number;
+  error_code?: string;
+}
+
+/**
+ * @deprecated This error is deprecated. it will be treated like any normal error
+ *
+ * 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;
+}
+
+/**
+ * Retrieves the parameters for the authentication session currently being used.
+ *
+ * @returns {AuthSessionParameters} An object containing the parameters for the current authentication session.
+ *
+ * @example
+ * ```typescript getAuthSessionParameters
+ * import { getAuthSessionParameters } from "@intuned/sdk/runtime"
+ *
+ * const authSessionParams = getAuthSessionParameters();
+ * console.log(authSessionParams);
+ * ```
+ */
+export declare function getAuthSessionParameters(): Promise<any>;
+
+/**
+ * @interface Store
+ * @property {function} get - Retrieves a value from the store by key
+ * @property {function} set - Sets a value in the store by key
+ *
+ * @example
+ * ```typescript Store usage
+ * import { store } from "@intuned/sdk/runtime"
+ *
+ * // Set a value in the store
+ * store.set('userPreference', { theme: 'dark' });
+ *
+ * // Get a value from the store
+ * const preference = store.get('userPreference');
+ * ```
+ */
+export interface Store {
+  /**
+   * 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;
+}
+
+/**
+ * ## Description
+ * A persistent key-value store that maintains data within the execution context.
+ * This store allows you to share data between different parts of your API execution.
+ *
+ * @example
+ * ```typescript Store usage
+ * import { store } from "@intuned/sdk/runtime"
+ *
+ * // Set a value in the store
+ * store.set('sessionData', { userId: '123', token: 'abc' });
+ *
+ * // Get a value from the store
+ * const sessionData = store.get('sessionData');
+ * console.log(sessionData.userId); // '123'
+ *
+ * // Handle missing values
+ * const missingData = store.get('nonexistent'); // undefined
+ * ```
+ */
+export declare const attemptStore: Store;

package/package/dist/runtime/extendPayload.d.ts

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

package/package/dist/runtime/extendPayload.js

@@ -0,0 +1,21 @@
+"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?.extendedPayloads.push(...items);
+  (0, _extendTimeout.extendTimeout)();
+}

package/package/dist/runtime/extendTimeout.d.ts

@@ -0,0 +1 @@
+export declare function extendTimeout(): void;

package/package/dist/runtime/extendTimeout.js

@@ -0,0 +1,23 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.extendTimeout = extendTimeout;
+var _asyncLocalStorage = require("../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.extendTimeoutCallback !== undefined) {
+    void timeoutInfo.extendTimeoutCallback().catch(() => undefined);
+  }
+}

package/package/dist/runtime/getAuthSessionParameters.d.ts

@@ -0,0 +1 @@
+export declare function getAuthSessionParameters(): Promise<any>;

package/package/dist/runtime/getAuthSessionParameters.js

@@ -0,0 +1,20 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getAuthSessionParameters = getAuthSessionParameters;
+var _asyncLocalStorage = require("../common/asyncLocalStorage");
+async function getAuthSessionParameters() {
+  const context = (0, _asyncLocalStorage.getExecutionContext)();
+  if (!context) {
+    throw new Error("getAuthSessionParameters failed due to an internal error (context was not found).");
+  }
+  const {
+    getAuthSessionParameters
+  } = context;
+  if (!getAuthSessionParameters) {
+    throw new Error("getAuthSessionParameters failed due to an internal error (helper was not found on context).");
+  }
+  return await getAuthSessionParameters();
+}

package/package/dist/runtime/index.d.ts

@@ -0,0 +1,7 @@
+export { extendPayload } from "./extendPayload";
+export { extendTimeout } from "./extendTimeout";
+export { attemptStore } from "./attemptStore";
+export { getAuthSessionParameters } from "./getAuthSessionParameters";
+export { runInfo } from "./runInfo";
+export { RunError } from "./RunError";
+export { getDownloadDirectoryPath } from "./downloadDirectory";

package/package/dist/runtime/index.js

@@ -0,0 +1,54 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "RunError", {
+  enumerable: true,
+  get: function () {
+    return _RunError.RunError;
+  }
+});
+Object.defineProperty(exports, "attemptStore", {
+  enumerable: true,
+  get: function () {
+    return _attemptStore.attemptStore;
+  }
+});
+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, "getAuthSessionParameters", {
+  enumerable: true,
+  get: function () {
+    return _getAuthSessionParameters.getAuthSessionParameters;
+  }
+});
+Object.defineProperty(exports, "getDownloadDirectoryPath", {
+  enumerable: true,
+  get: function () {
+    return _downloadDirectory.getDownloadDirectoryPath;
+  }
+});
+Object.defineProperty(exports, "runInfo", {
+  enumerable: true,
+  get: function () {
+    return _runInfo.runInfo;
+  }
+});
+var _extendPayload = require("./extendPayload");
+var _extendTimeout = require("./extendTimeout");
+var _attemptStore = require("./attemptStore");
+var _getAuthSessionParameters = require("./getAuthSessionParameters");
+var _runInfo = require("./runInfo");
+var _RunError = require("./RunError");
+var _downloadDirectory = require("./downloadDirectory");

package/package/dist/runtime/runInfo.d.ts

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

package/package/dist/runtime/runInfo.js

@@ -0,0 +1,21 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.runInfo = runInfo;
+var _asyncLocalStorage = require("../common/asyncLocalStorage");
+var _enums = require("./enums");
+function runInfo() {
+  const context = (0, _asyncLocalStorage.getExecutionContext)();
+  if (!context) {
+    return {
+      runEnvironment: _enums.RunEnvironment.IDE
+    };
+  }
+  const {
+    extendedPayloads: _extendedPayloads,
+    ...rest
+  } = context;
+  return rest;
+}