@intuned/runtime-dev 1.3.18-interface.13 → 1.3.18-interface.16

package/package.json

@@ -1,82 +1,27 @@
 {
   "name": "@intuned/runtime-dev",
-  "version": "1.3.18-interface.13",
+  "version": "1.3.18-interface.16",
   "description": "Intuned runtime",
   "packageManager": "yarn@4.12.0",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "exports": {
-    ".": {
-      "types": "./dist/index.d.ts",
-      "require": "./dist/index.js"
-    },
-    "./dist/runtime": {
-      "types": "./dist/runtime/index.d.ts",
-      "require": "./dist/runtime/index.js"
-    },
-    "./dist/common/runApi": {
-      "types": "./dist/common/runApi/index.d.ts",
-      "require": "./dist/common/runApi/index.js"
-    },
-    "./dist/common/settingsSchema": {
-      "types": "./dist/common/settingsSchema.d.ts",
-      "require": "./dist/common/settingsSchema.js"
-    },
-    "./dist/common/contextStorageStateHelpers": {
-      "types": "./dist/common/contextStorageStateHelpers.d.ts",
-      "require": "./dist/common/contextStorageStateHelpers.js"
-    },
-    "./dist/common/telemetry": {
-      "types": "./dist/common/telemetry.d.ts",
-      "require": "./dist/common/telemetry.js"
-    },
-    "./dist/common/jwtTokenManager": {
-      "types": "./dist/common/jwtTokenManager.d.ts",
-      "require": "./dist/common/jwtTokenManager.js"
-    },
-    "./dist/common/asyncLocalStorage": {
-      "types": "./dist/common/asyncLocalStorage/index.d.ts",
-      "require": "./dist/common/asyncLocalStorage/index.js"
-    },
-    "./dist/common/cleanEnvironmentVariables": {
-      "types": "./dist/common/cleanEnvironmentVariables.d.ts",
-      "require": "./dist/common/cleanEnvironmentVariables.js"
-    },
-    "./dist/common/constants": {
-      "types": "./dist/common/constants.d.ts",
-      "require": "./dist/common/constants.js"
-    },
-    "./dist/commands/interface/run": {
-      "types": "./dist/commands/interface/run.d.ts",
-      "require": "./dist/commands/interface/run.js"
-    },
-    "./dist/commands/build": {
-      "types": "./dist/commands/build.d.ts",
-      "require": "./dist/commands/build.js"
-    },
-    "./dist/common/binStartupScript": {
-      "types": "./dist/common/binStartupScript.d.ts",
-      "require": "./dist/common/binStartupScript.js"
-    },
-    "./dist/commands/common/tsNodeImport": {
-      "types": "./dist/commands/common/tsNodeImport.d.ts",
-      "require": "./dist/commands/common/tsNodeImport.js"
-    },
-    "./dist/commands/intuned-cli/main.js": "./dist/commands/intuned-cli/main.js",
-    "./dist/commands/api/run.js": "./dist/commands/api/run.js",
-    "./dist/commands/auth-sessions/run-check.js": "./dist/commands/auth-sessions/run-check.js",
-    "./dist/commands/auth-sessions/run-create.js": "./dist/commands/auth-sessions/run-create.js",
-    "./dist/commands/auth-sessions/load.js": "./dist/commands/auth-sessions/load.js",
-    "./dist/commands/browser/save-state.js": "./dist/commands/browser/save-state.js",
-    "./dist/commands/browser/start-browser.js": "./dist/commands/browser/start-browser.js",
-    "./dist/commands/get-headless-user-agent.js": "./dist/commands/get-headless-user-agent.js",
-    "./dist/commands/ts-check.js": "./dist/commands/ts-check.js"
+    ".": "./dist/index.js",
+    "./dist/runtime": "./dist/runtime/index.js",
+    "./dist/common/runApi": "./dist/common/runApi/index.js",
+    "./dist/common/settingsSchema": "./dist/common/settingsSchema.js",
+    "./dist/common/contextStorageStateHelpers": "./dist/common/contextStorageStateHelpers.js",
+    "./dist/common/telemetry": "./dist/common/telemetry.js",
+    "./dist/common/jwtTokenManager": "./dist/common/jwtTokenManager.js",
+    "./dist/common/asyncLocalStorage": "./dist/common/asyncLocalStorage/index.js",
+    "./dist/common/cleanEnvironmentVariables": "./dist/common/cleanEnvironmentVariables.js",
+    "./dist/common/constants": "./dist/common/constants.js",
+    "./dist/commands/interface/run": "./dist/commands/interface/run.js",
+    "./interface": "./dist/commands/interface/index.js",
+    "./dist/commands/intuned-run/intuned-run": "./dist/commands/intuned-run/intuned-run.js",
+    "./dist/common/binStartupScript": "./dist/common/binStartupScript.js",
+    "./dist/commands/common/utils/interfaceClient": "./dist/commands/common/utils/interfaceClient.js"
   },
-  "files": [
-    "dist",
-    "bin",
-    "InterfaceTemplate"
-  ],
   "author": "Intuned Team",
   "license": "Elastic-2.0",
   "scripts": {
@@ -90,7 +35,7 @@
     "intuned-ts-check": "yarn prepublishOnly && vite-node ./src/commands/ts-check.ts",
     "intuned": "vite-node ./src/commands/intuned-cli/main.ts",
     "intuned-get-headless-user-agent": "vite-node ./src/commands/get-headless-user-agent.ts",
-    "build": "rm -rf ./dist && tsup && cp -r ./src/common/assets dist/common/assets",
+    "build": "rm -rf dist && tsc -p tsconfig.json && yarn copy-dts && babel src --out-dir dist --extensions '.ts' && tsup && cp -r ./src/common/assets dist/common/assets",
     "test": "vitest run",
     "test:watch": "vitest",
     "e2e": "yarn playwright test --config ./playwright.config.ts",
@@ -179,6 +124,7 @@
     "@typescript-eslint/parser": "^7.5.0",
     "@vitest/ui": "^1.1.3",
     "babel-plugin-macros": "^3.1.0",
+    "babel-plugin-module-resolver": "^5.0.2",
     "babel-preset-minify": "^0.5.2",
     "copyfiles": "^2.4.1",
     "dts-bundle-generator": "^8.0.1",

package/template.tsconfig.json

@@ -0,0 +1,11 @@
+{
+  "compilerOptions": {
+    "target": "ES2021",
+    "lib": ["dom", "es2021"],
+    "resolveJsonModule": true,
+    "esModuleInterop": true,
+    "moduleResolution": "bundler",
+    "module": "esnext",
+    "skipLibCheck": true
+  }
+}

package/tsconfig.eslint.json

@@ -0,0 +1,5 @@
+{
+  "extends": "./tsconfig.json",
+  "include": ["**/*.ts", "**/*.d.ts"],
+  "exclude": ["node_modules"]
+}

package/tsconfig.json

@@ -0,0 +1,25 @@
+{
+  "compilerOptions": {
+    "target": "es2021",
+    "module": "esnext",
+    "esModuleInterop": true,
+    "moduleResolution": "bundler",
+    "resolveJsonModule": true,
+    "outDir": "./dist",
+    "strict": false,
+    "strictNullChecks": true,
+    "rootDir": "./src",
+    "sourceMap": false,
+    "declaration": true,
+    "emitDeclarationOnly": false,
+    "skipLibCheck": true,
+    "types": ["vitest/globals"]
+  },
+  "include": [
+    "src/**/*.ts",
+    "src/**/*.d.ts",
+    "types-package/noEmpty.ts",
+    "src/assets/**/*"
+  ],
+  "exclude": ["node_modules", "**/*.test.ts", "**/__tests__/*"]
+}

package/tsup.config.ts

@@ -0,0 +1,11 @@
+import { defineConfig } from "tsup";
+
+export default defineConfig({
+  entry: ["src/vendor/runtime-interface.ts"],
+  format: ["cjs"],
+  dts: true,
+  outDir: "dist/vendor",
+  clean: false, // Don't clean - babel handles dist cleanup
+  sourcemap: false,
+  target: "node20",
+});

package/typedoc.json

@@ -0,0 +1,49 @@
+{
+  // base config
+  "out": "docs/content",
+  "tsconfig": "./types-package/tsconfig.json",
+  "entryPoints": ["./types-package/ai-extractors/index.d.ts"],
+
+  // specific inclusions and exclusions
+  // "excludeProtected": true,
+  // "excludeNotDocumented": true,
+
+  "exclude": [
+    "./src.ts/_admin/**/*",
+    "./src.ts/_tests/**/*",
+    "./src.ts/testcases/**/*"
+  ],
+
+  // plugins
+  "plugin": [
+    // "./plugins/reorderSections.mjs",
+    "typedoc-plugin-remove-references", // remove additional references that clutter documentation
+    "typedoc-plugin-markdown", // generate markdown files
+    "typedoc-plugin-frontmatter", // add frontmatter to markdown files, prereq for the below custom plugin
+    "./docs/plugins/typedoc-plugin-mintlify-frontmatter.mjs", // formats frontmatter to match mintlify
+    "./docs/plugins/typedoc-plugin-navigation-output.mjs" // formats navigation to match mintlify
+  ],
+
+  // formatting + mintlify compatibility
+  "fileExtension": ".mdx", // use mdx files for mintlfiy compatibility
+  "entryFileName": "index.mdx", // rename entry from "README.md" to "index.mdx"
+  "hidePageHeader": true, // hide page header, conflicts with mintlify
+  "hidePageTitle": true, // hide page title, conflicts with mintlify
+  "hideBreadcrumbs": true, // hide breadcrumbs, conflicts with mintlify
+  "useCodeBlocks": true, // makes API definitions more readable
+
+  "expandObjects": false,
+  // "parametersFormat": "table", // readability
+  // "propertiesFormat": "table", // readability
+  "navigation": {
+    "includeCategories": true,
+    "includeGroups": false
+  },
+  "disableSources": true,
+  "hideParameterTypesInTitle": false,
+  // "membersWithOwnFile": ["Class", "Enum", "Interface", "Function"],
+  // "hideParameterTypesInTitle": true,
+  "readme": "none",
+  "githubPages": false,
+  "excludeExternals": true
+}

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

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