@intuned/browser-dev 2.2.3-unify-sdks.20

package/dist/optimized-extractors/validators.js

@@ -0,0 +1,152 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.strategySchema = exports.simpleObjectJsonSchema = exports.simpleArrayItemJsonSchema = exports.extractObjectOptimizedInputSchema = exports.extractArrayOptimizedInputSchema = void 0;
+var _zod = require("zod");
+var _aiModelsValidation = require("./types/aiModelsValidation");
+const htmlStrategySchema = _zod.z.object({
+  model: _zod.z.enum(_aiModelsValidation.SUPPORTED_TEXT_MODELS, {
+    required_error: "strategy model is required",
+    invalid_type_error: "strategy model is invalid"
+  }),
+  type: _zod.z.literal("HTML", {
+    required_error: "strategy type is required",
+    invalid_type_error: "strategy type is invalid"
+  })
+});
+const imageStrategySchema = _zod.z.object({
+  model: _zod.z.enum(_aiModelsValidation.SUPPORTED_VISION_MODELS, {
+    required_error: "strategy model is required",
+    invalid_type_error: "strategy model is invalid"
+  }),
+  type: _zod.z.literal("IMAGE", {
+    required_error: "strategy type is required",
+    invalid_type_error: "strategy type is invalid"
+  })
+});
+const simpleStringSchema = _zod.z.object({
+  type: _zod.z.literal("string", {
+    required_error: "property type is required",
+    invalid_type_error: "optimized extractors only support string types"
+  }),
+  description: _zod.z.string({
+    required_error: "property description is required",
+    invalid_type_error: "property description must be a string"
+  }).optional()
+});
+const simpleArrayStringSchema = simpleStringSchema.extend({
+  primary: _zod.z.boolean().optional()
+});
+const simpleObjectJsonSchema = exports.simpleObjectJsonSchema = _zod.z.object({
+  type: _zod.z.literal("object", {
+    errorMap: () => ({
+      message: 'schema type is required, and must have the value "object"'
+    })
+  }),
+  description: _zod.z.string().optional(),
+  properties: _zod.z.record(_zod.z.string(), simpleStringSchema, {
+    required_error: "properties is required in object schemas"
+  }),
+  required: _zod.z.array(_zod.z.string(), {
+    required_error: "required must be an array of strings",
+    invalid_type_error: "required must be an array of strings"
+  }).min(1, {
+    message: "at least one property must be required"
+  })
+}, {
+  required_error: "schema is required"
+}).refine(data => {
+  return data.required.every(key => Object.keys(data.properties).includes(key));
+}, {
+  message: "All required keys must be defined in the properties object"
+}).refine(data => {
+  return Object.keys(data.properties).length > 0;
+}, {
+  message: "you must have at least one property in the properties object"
+});
+const simpleArrayItemJsonSchema = exports.simpleArrayItemJsonSchema = _zod.z.object({
+  type: _zod.z.literal("object", {
+    errorMap: () => ({
+      message: 'schema type is required, and must have the value "object"'
+    })
+  }),
+  description: _zod.z.string().optional(),
+  properties: _zod.z.record(_zod.z.string(), simpleArrayStringSchema, {
+    required_error: "properties is required in object schemas"
+  }),
+  required: _zod.z.array(_zod.z.string(), {
+    required_error: "required must be an array of strings",
+    invalid_type_error: "required must be an array of strings"
+  }).min(1, {
+    message: "at least one property must be required"
+  })
+}, {
+  required_error: "schema is required"
+}).refine(data => {
+  return data.required.every(key => Object.keys(data.properties).includes(key));
+}, {
+  message: "All required keys must be defined in the properties object"
+}).refine(data => {
+  const primaryField = Object.entries(data.properties).find(([k, v]) => v.primary);
+  return primaryField;
+}, {
+  message: "you must have one primary property"
+}).refine(data => {
+  const primaryField = Object.entries(data.properties).find(([k, v]) => v.primary);
+  if (!primaryField) {
+    return false;
+  }
+  return data.required.includes(primaryField[0]);
+}, {
+  message: "The primary field must be required"
+});
+const strategySchema = exports.strategySchema = _zod.z.union([htmlStrategySchema, imageStrategySchema], {
+  errorMap: (err, context) => {
+    if (err.code === "invalid_union" && context.data.model === "gpt3.5-turbo" && context.data.type === "IMAGE") {
+      return {
+        message: "gpt3.5-turbo does not support IMAGE strategy"
+      };
+    }
+    return {
+      message: err.message ?? "invalid strategy configuration"
+    };
+  }
+}).optional().default({
+  model: "claude-3-haiku",
+  type: "HTML"
+});
+const labelSchema = _zod.z.string({
+  invalid_type_error: "label must be a string",
+  required_error: "label is required"
+}).min(1, "label must be at least 1 character long");
+const entityNameSchema = _zod.z.string().min(1, {
+  message: "entity name must be at least 1 character long."
+}).max(50, {
+  message: "entity name must be no more than 50 characters long."
+}).regex(/^[a-zA-Z0-9_-]+$/, {
+  message: "entity name can only contain letters, digits, underscores, and hyphens."
+});
+const extractObjectOptimizedInputSchema = exports.extractObjectOptimizedInputSchema = _zod.z.object({
+  label: labelSchema,
+  strategy: strategySchema,
+  entityName: entityNameSchema,
+  entitySchema: simpleObjectJsonSchema,
+  variantKey: _zod.z.string().optional().default("about:blank"),
+  prompt: _zod.z.string().optional(),
+  optionalPropertiesInvalidator: _zod.z.function().returns(_zod.z.array(_zod.z.string())).optional().default(() => () => []),
+  apiKey: _zod.z.string().optional()
+}, {
+  required_error: "extractObjectOptimized function missing configurations"
+});
+const extractArrayOptimizedInputSchema = exports.extractArrayOptimizedInputSchema = _zod.z.object({
+  label: labelSchema,
+  strategy: strategySchema,
+  prompt: _zod.z.string().optional(),
+  itemEntityName: entityNameSchema,
+  itemEntitySchema: simpleArrayItemJsonSchema,
+  variantKey: _zod.z.string().optional(),
+  optionalPropertiesInvalidator: _zod.z.function().returns(_zod.z.array(_zod.z.string())).optional().default(() => () => []),
+  apiKey: _zod.z.string().optional()
+});

package/dist/vite-env.d.js

@@ -0,0 +1 @@
+"use strict";

package/dist/vite-env.d.ts

@@ -0,0 +1,9 @@
+interface ImportMetaEnv {
+  readonly VITE_S3_BUCKET: string;
+  readonly VITE_AWS_REGION?: string;
+  readonly VITE_API_URL?: string;
+}
+
+interface ImportMeta {
+  readonly env: ImportMetaEnv;
+}

package/docs.md

@@ -0,0 +1,14 @@
+to generate all docs run:
+  ```bash
+  yarn generate-all-docs
+  ```
+
+or run:
+```bash
+  yarn generate-docs <input.d.tx> [outputdir]
+```
+These commands will go to all export.d.ts file of the 5 namespaces and generate their docs.
+The script in ./scripts/generate-docs reads the JSDOCs in the directories and passes them to the markdown converters. And outputs functions in outputdir/functions and Interfaces at outputdir/interfaces
+The markdown converters scripts parse JSDOCs into a Mintlify compatable format.
+
+To write a jsdoc, follow the conventions found in any export.d.ts file, especially the one in `helpers/export.d.ts`.

package/how-to-run-tests.md

@@ -0,0 +1,10 @@
+## How to create a test file
+
+- use "src/helpers/tests/extendedTest.ts", this uses vitest by default, import all test requirmenets from it and start writing your test.
+
+## How to run tests
+
+- run `npx vitest` to run all tests
+- `npx vitest --ui` to view live test reports on a webpage.
+- `npx vitest --ui path/to/test.spec.t`s to run test from a specific file
+- `npx vitest --ui -t="test description" (or --testNamePattern="test description")` to run a specific test by its description.

package/intuned-runtime-setup.md

@@ -0,0 +1,13 @@
+## Setting Up the TypeScript SDK and Runtime
+
+First, ensure you have Node.js and Yarn installed on your system, then run `yarn install` to set up the project dependencies.
+
+During development, you'll need to create a symlink to use your local version of `@intuned/runtime`.
+
+To set up the symlink:
+
+1. Navigate to `apps/typescript-runtime` and run `yarn build` after `yarn install` to build the runtime
+2. In the same directory, run `yarn link`
+3. Navigate to `apps/typescript-sdk` and run `yarn link "@intuned/runtime"`
+
+Note: Whenever you make changes to the runtime code, remember to run `yarn build` in the runtime directory for the changes to reflect in the SDK.

package/package.json

@@ -0,0 +1,124 @@
+{
+  "name": "@intuned/browser-dev",
+  "version": "2.2.3-unify-sdks.20",
+  "description": "runner package for intuned functions",
+  "types": "./dist/index.d.ts",
+  "typesVersions": {
+    "*": {
+      "ai-extractors": [
+        "./dist/ai-extractors/index.d.ts"
+      ],
+      "optimized-extractors": [
+        "./dist/optimized-extractors/index.d.ts"
+      ],
+      "browser": [
+        "./dist/browser/index.d.ts"
+      ]
+    }
+  },
+  "exports": {
+    ".": "./dist/index.js",
+    "./ai-extractors": "./dist/ai-extractors/index.js",
+    "./optimized-extractors": "./dist/optimized-extractors/index.js",
+    "./dist/common/settingsSchema": "./dist/common/settingsSchema.js",
+    "./dist/common/getPlaywrightConstructs": "./dist/common/getPlaywrightConstructs.js",
+    "./dist/common/contextStorageStateHelpers": "./dist/common/contextStorageStateHelpers.js",
+    "./dist/common/types": "./dist/common/types.js",
+    "./dist/common/requestMoreInfo": "./dist/common/requestMoreInfo.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/commands/common/getFirstLineNumber": "./dist/commands/common/getFirstLineNumber.js",
+    "./dist/commands/common/constants": "./dist/commands/common/constants.js",
+    "./dist/files/FileUploadAndDownload/utils": "./dist/files/FileUploadAndDownload/utils.js"
+  },
+  "author": "Intuned Team",
+  "license": "Elastic-2.0",
+  "scripts": {
+    "build": "rm -rf dist && tsc -p tsconfig.json  && yarn copy-dts && cp src/common/browser_scripts.js dist/common/ && babel src --out-dir dist --extensions '.ts' && node scripts/ensure-index-types.js",
+    "ensure-types": "node scripts/ensure-index-types.js",
+    "test": "vitest run",
+    "test:dev": "vitest",
+    "test:watch": "vitest",
+    "clean-declarations": "find ./types-package -name \"*.d.ts\" -type f -delete",
+    "lint": "eslint .",
+    "fix": "eslint . --fix",
+    "generate-docs": "npx tsx ./scripts/generate-docs.ts",
+    "generate-all-docs": "npx tsx ./scripts/generate-docs.ts ./src/ai-extractors/export.d.ts ./docs/ai-extractors && npx tsx ./scripts/generate-docs.ts ./src/optimized-extractors/export.d.ts ./docs/optimized-extractors && npx tsx ./scripts/generate-docs.ts ./src/playwright/export.d.ts ./docs/playwright && npx tsx ./scripts/generate-docs.ts ./src/files/export.d.ts ./docs/files && npx tsx ./scripts/generate-docs.ts ./src/helpers/export.d.ts ./docs/helpers && npx tsx ./scripts/generate-docs.ts ./src/runtime/export.d.ts ./docs/runtime",
+    "build-browser-scripts": "rollup -c ./src/common/browserScripts/rollup.config.mjs",
+    "copy-dts": "copyfiles -u 1 \"src/**/*.d.ts\" dist"
+  },
+  "dependencies": {
+    "@ai-sdk/anthropic": "2.0.1",
+    "@ai-sdk/google": "1.0.12",
+    "@ai-sdk/openai": "2.0.4",
+    "@ai-sdk/provider": "2.0.0",
+    "@anthropic-ai/sdk": "0.22.0",
+    "@aws-sdk/client-s3": "3.821.0",
+    "@aws-sdk/s3-request-presigner": "3.821.0",
+    "@intuned/runtime": "^1.1.3",
+    "ai": "5.0.15",
+    "ajv": "8.13.0",
+    "ajv-formats": "2.1.1",
+    "async-mutex": "0.5.0",
+    "async-retry": "1.3.3",
+    "chalk": "4.1.2",
+    "chrono-node": "2.8.3",
+    "copyfiles": "2.4.1",
+    "date-fns": "4.1.0",
+    "doctrine": "3.0.0",
+    "dom-to-semantic-markdown": "1.2.14",
+    "dotenv": "^16.3.1",
+    "file-type": "16.5.4",
+    "fs-extra": "11.1.1",
+    "https-proxy-agent": "7.0.5",
+    "image-size": "1.1.1",
+    "lodash": "4.17.21",
+    "neverthrow": "6.1.0",
+    "node-html-parser": "7.0.1",
+    "node-xlsx": "0.23.0",
+    "openai": "4.77.3",
+    "pdfjs-dist": "2.1.266",
+    "read-chunk": "3.2.0",
+    "stack-utils": "2.0.6",
+    "tslib": "2.6.0",
+    "zod": "^3.25.76",
+    "zod-validation-error": "3.0.3"
+  },
+  "devDependencies": {
+    "@babel/cli": "^7.23.4",
+    "@babel/core": "^7.23.7",
+    "@babel/plugin-transform-export-namespace-from": "^7.24.1",
+    "@babel/preset-env": "^7.23.7",
+    "@babel/preset-typescript": "^7.23.3",
+    "@rollup/plugin-commonjs": "^25.0.2",
+    "@rollup/plugin-node-resolve": "15.1.0",
+    "@rollup/plugin-typescript": "11.1.2",
+    "@types/async-retry": "1.4.8",
+    "@types/fs-extra": "11.0.1",
+    "@types/jest": "^30.0.0",
+    "@types/lodash": "4.14.200",
+    "@types/node": "^24.1.0",
+    "@typescript-eslint/eslint-plugin": "^5.47.1",
+    "@typescript-eslint/parser": "^7.5.0",
+    "@vitest/ui": "^1.1.3",
+    "babel-plugin-macros": "^3.1.0",
+    "eslint": "7.32.0",
+    "eslint-plugin-deprecation": "^1.3.3",
+    "eslint-plugin-prettier": "^4.2.1",
+    "jest": "^30.0.4",
+    "msw": "^2.1.2",
+    "playwright": "^1.55.0",
+    "prettier": "^2.8.8",
+    "rollup": "3.26.2",
+    "ts-jest": "^29.4.0",
+    "typescript": "5.4.4",
+    "vite": "^5.4.12",
+    "vite-plugin-babel-macros": "^1.0.6",
+    "vitest": "^1.1.3"
+  },
+  "peerDependencies": {
+    "@intuned/runtime": "*"
+  }
+}

package/tsconfig.eslint.json

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

package/tsconfig.json

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