@intuned/runtime-dev 1.3.18-interface.12 → 1.3.18-interface.2

package/.babelrc

@@ -0,0 +1,21 @@
+{
+  "presets": [
+    [
+      "@babel/preset-env",
+      {
+        "targets": {
+          "chrome": 130,
+          "node": "20"
+        },
+        "modules": "commonjs"
+      }
+    ],
+    "@babel/preset-typescript"
+  ],
+  "plugins": [
+    "babel-plugin-macros",
+    "@babel/plugin-transform-export-namespace-from"
+  ],
+  "sourceMaps": false,
+  "comments": false
+}

package/.eslintignore

@@ -0,0 +1,10 @@
+node_modules
+dist
+.eslintrc.js
+*.test.ts
+*.js
+types-package
+vite.config.ts
+reports
+intuned
+**/*.d.ts

package/.eslintrc.js

@@ -0,0 +1,39 @@
+module.exports = {
+  root: true,
+  parser: "@typescript-eslint/parser",
+  parserOptions: {
+    project: "./tsconfig.eslint.json",
+    tsconfigRootDir: __dirname,
+  },
+  plugins: ["@typescript-eslint", "deprecation", "prettier"],
+  ignorePatterns: ["src/common/browserScripts/rollup.config.mjs"],
+  extends: [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/eslint-recommended",
+    "plugin:@typescript-eslint/recommended",
+  ],
+  rules: {
+    "@next/next/no-html-link-for-pages": 0,
+    "prettier/prettier": "error",
+
+    // recommended for safety
+    "@typescript-eslint/no-floating-promises": "error", // forgetting to await Activities and Workflow APIs is bad
+    "deprecation/deprecation": "warn",
+
+    // code style preference
+    "object-shorthand": ["warn", "always"],
+
+    // relaxed rules, for convenience
+    "@typescript-eslint/no-unused-vars": [
+      "warn",
+      {
+        argsIgnorePattern: "^_",
+        varsIgnorePattern: "^_",
+      },
+    ],
+    "@typescript-eslint/no-explicit-any": "off",
+    "@typescript-eslint/no-empty-interface": "off",
+    "@typescript-eslint/ban-ts-comment": "warn",
+    "no-empty": "warn",
+  },
+};

package/InterfaceTemplate/__utils.ts

@@ -0,0 +1,61 @@
+import type { ImportFunction } from "@intuned/runtime/dist/common/runApi";
+import { err, ok } from "neverthrow";
+
+export const importModule: ImportFunction = async (path: string) => {
+  const [folderName, ...functionNameParts] = path.split("/");
+  const functionNameDepth = functionNameParts.length;
+
+  // string literals should be inline
+  // currently we support only 5 levels of depth
+  // rollup dynamic import does not support multiple levels of dynamic imports so we need to specify the possible paths explicitly
+  let imported: any = undefined;
+  try {
+    switch (functionNameDepth) {
+      case 1:
+        imported = await import(`./${folderName}/${functionNameParts[0]}.ts`);
+        break;
+      case 2:
+        imported = await import(
+          `./${folderName}/${functionNameParts[0]}/${functionNameParts[1]}.ts`
+        );
+        break;
+      case 3:
+        imported = await import(
+          `./${folderName}/${functionNameParts[0]}/${functionNameParts[1]}/${functionNameParts[2]}.ts`
+        );
+        break;
+      case 4:
+        imported = await import(
+          `./${folderName}/${functionNameParts[0]}/${functionNameParts[1]}/${functionNameParts[2]}/${functionNameParts[3]}.ts`
+        );
+        break;
+      case 5:
+        imported = await import(
+          `./${folderName}/${functionNameParts[0]}/${functionNameParts[1]}/${functionNameParts[2]}/${functionNameParts[3]}/${functionNameParts[4]}.ts`
+        );
+        break;
+      default:
+        return err({
+          type: "other",
+          error: new Error(
+            `intuned supports maximum 5 levels of depth in the api folder`
+          ),
+        });
+    }
+    return ok(imported);
+  } catch (e: any) {
+    if (
+      "message" in e &&
+      typeof e.message === "string" &&
+      e.message.includes("Unknown variable dynamic import")
+    ) {
+      return err({
+        type: "not_found",
+      });
+    }
+    return err({
+      type: "other",
+      error: e,
+    });
+  }
+};

package/InterfaceTemplate/index.playwright.ts

@@ -0,0 +1,6 @@
+require("@intuned/runtime/dist/common/binStartupScript");
+import { runAutomationCLI } from "@intuned/runtime/dist/commands/interface/run";
+
+import { importModule } from "./__utils";
+
+runAutomationCLI(importModule);

package/api/sample.ts

@@ -0,0 +1,4 @@
+export default async function handler(_, page) {
+  await page.goto("https://wikipedia.org/wiki/Special:Random");
+  return { title: await page.title() };
+}

package/package.json

@@ -1,81 +1,25 @@
 {
   "name": "@intuned/runtime-dev",
-  "version": "1.3.18-interface.12",
+  "version": "1.3.18-interface.2",
   "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"
-  ],
+  "types": "./dist/index.d.ts",
   "author": "Intuned Team",
   "license": "Elastic-2.0",
   "scripts": {
@@ -89,7 +33,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' &&  cp -r ./src/common/assets dist/common/assets",
     "test": "vitest run",
     "test:watch": "vitest",
     "e2e": "yarn playwright test --config ./playwright.config.ts",
@@ -164,7 +108,6 @@
     "@babel/plugin-transform-export-namespace-from": "^7.24.1",
     "@babel/preset-env": "^7.23.7",
     "@babel/preset-typescript": "^7.23.3",
-    "@intuned/runtime-interface": "0.0.1",
     "@jest/globals": "^29.6.2",
     "@ngneat/falso": "^7.2.0",
     "@types/jest": "^29.5.3",
@@ -187,7 +130,6 @@
     "eslint-plugin-prettier": "^4.2.1",
     "msw": "^2.1.2",
     "playwright": "^1.55.0",
-    "tsup": "^8.3.5",
     "typedoc": "^0.25.13",
     "typedoc-plugin-frontmatter": "^1.0.0",
     "typedoc-plugin-markdown": "^4.0.2",

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/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/commands/api/run.d.ts

@@ -1,8 +0,0 @@
-#!/usr/bin/env node
-declare function executeCLI(apiName: string, mode: "vanilla" | "playwright" | "playwright-standalone" | "playwright-headless", inputData: object | null | undefined, options: {
-    cdpAddress: string;
-    authSessionPath: undefined | string;
-    outputFileId: string | undefined;
-}): Promise<void>;
-
-export { executeCLI };