chore(workflow): build the package shared with rslib

EAGzzyCSL · EAGzzyCSL · commit 5503a4a1a796 · 2025-08-12T22:46:28.000+08:00
diff --git a/.gitignore b/.gitignore
@@ -119,4 +119,5 @@ CLAUDE.md
 **/CLAUDE.md
 .cursor/rules/nx-rules.mdc
 .github/instructions/nx.instructions.md
-.gemini-clipboard
+.gemini-clipboard
+tsconfig.build.tsbuildinfo
diff --git a/apps/android-playground/package.json b/apps/android-playground/package.json
@@ -29,6 +29,7 @@
     "@rsbuild/plugin-node-polyfill": "1.3.0",
     "@rsbuild/plugin-react": "^1.3.1",
     "@rsbuild/plugin-svgr": "^1.1.1",
+    "@rsbuild/plugin-type-check": "1.2.3",
     "@types/react": "^18.3.1",
     "@types/react-dom": "^18.3.1",
     "archiver": "^6.0.0",
diff --git a/apps/android-playground/rsbuild.config.ts b/apps/android-playground/rsbuild.config.ts
@@ -67,6 +67,9 @@ export default defineConfig({
       'react-dom': path.resolve(__dirname, 'node_modules/react-dom'),
     },
   },
+  output: {
+    externals: ['sharp'],
+  },
   plugins: [
     pluginReact(),
     pluginNodePolyfill(),
diff --git a/apps/chrome-extension/package.json b/apps/chrome-extension/package.json
@@ -43,6 +43,7 @@
     "archiver": "^6.0.0",
     "less": "^4.2.0",
     "tailwindcss": "4.1.11",
-    "typescript": "^5.8.3"
+    "typescript": "^5.8.3",
+    "openai": "4.81.0"
   }
 }
diff --git a/apps/chrome-extension/src/extension/recorder/utils.ts b/apps/chrome-extension/src/extension/recorder/utils.ts
@@ -8,6 +8,7 @@ import type { ChromeRecordedEvent } from '@midscene/recorder';
 import { message } from 'antd';
 import { saveAs } from 'file-saver';
 import JSZip from 'jszip';
+import type { ChatCompletionContentPart } from 'openai/resources/index';
 import type { RecordingSession } from '../../store';
 import { recordLogger } from './logger';
 import { isChromeExtension, safeChromeAPI } from './types';
@@ -278,7 +279,7 @@ export const generateRecordTitle = async (
       const screenshots = getScreenshotsForLLM(events);
 
       // Create the message content
-      const messageContent: Array<string | Record<string, any>> = [
+      const messageContent: ChatCompletionContentPart[] = [
         {
           type: 'text',
           text: `Generate a concise title (5-7 words) and brief description (1-2 sentences) for a browser recording session with the following events:\n\n${JSON.stringify(summary, null, 2)}\n\nRespond with a JSON object containing "title" and "description" fields. The title should be action-oriented and highlight the main task accomplished. The description should provide slightly more detail about what was done.`,
@@ -313,7 +314,7 @@ export const generateRecordTitle = async (
           role: 'user',
           content: messageContent,
         },
-      ];
+      ] as const;
 
       const response = await callAiFn(
         [prompt[0], prompt[1]],
diff --git a/biome.json b/biome.json
@@ -29,7 +29,8 @@
       "**/page-data/**",
       "**/dump.json",
       "**/dump-with-invisible.json",
-      "**/dump-for-utils-test.json"
+      "**/dump-for-utils-test.json",
+      "**/.rslib"
     ]
   },
   "javascript": {
diff --git a/packages/android-playground/tsconfig.json b/packages/android-playground/tsconfig.json
@@ -9,7 +9,7 @@
     "isolatedModules": true,
     "jsx": "preserve",
     "lib": ["DOM", "ESNext"],
-    "moduleResolution": "node",
+    "moduleResolution": "bundler",
     "resolveJsonModule": true,
     "rootDir": "src",
     "skipLibCheck": true,
diff --git a/packages/android/tsconfig.json b/packages/android/tsconfig.json
@@ -9,7 +9,7 @@
     "isolatedModules": true,
     "jsx": "preserve",
     "lib": ["DOM", "ESNext"],
-    "moduleResolution": "node",
+    "moduleResolution": "bundler",
     "resolveJsonModule": true,
     "rootDir": "src",
     "skipLibCheck": true,
diff --git a/packages/cli/tsconfig.json b/packages/cli/tsconfig.json
@@ -8,15 +8,22 @@
     "isolatedModules": true,
     "jsx": "preserve",
     "lib": ["ESNext", "DOM"],
-    "moduleResolution": "node",
+    "moduleResolution": "bundler",
+    "module": "esnext",
     "paths": {
       "@/*": ["./src/*"]
     },
     "resolveJsonModule": true,
     "rootDir": ".",
     "skipLibCheck": true,
-    "strict": true
+    "strict": true,
+    "composite": true
   },
   "exclude": ["**/node_modules"],
-  "include": ["src", "tests"]
+  "include": ["src", "tests"],
+  "references": [
+    {
+      "path": "../shared"
+    }
+  ]
 }
diff --git a/packages/core/src/ai-model/common.ts b/packages/core/src/ai-model/common.ts
@@ -15,7 +15,7 @@ import { assert } from '@midscene/shared/utils';
 import type {
   ChatCompletionSystemMessageParam,
   ChatCompletionUserMessageParam,
-} from 'openai/resources';
+} from 'openai/resources/index';
 import {
   call,
   callToGetJSONObject,
diff --git a/packages/core/src/ai-model/index.ts b/packages/core/src/ai-model/index.ts
@@ -17,7 +17,7 @@ export {
   generateYamlTestStream,
 } from './prompt/yaml-generator';
 
-export type { ChatCompletionMessageParam } from 'openai/resources';
+export type { ChatCompletionMessageParam } from 'openai/resources/index';
 
 export {
   AiLocateElement,
diff --git a/packages/core/src/ai-model/inspect.ts b/packages/core/src/ai-model/inspect.ts
@@ -30,7 +30,7 @@ import { assert } from '@midscene/shared/utils';
 import type {
   ChatCompletionSystemMessageParam,
   ChatCompletionUserMessageParam,
-} from 'openai/resources';
+} from 'openai/resources/index';
 import {
   AIActionType,
   adaptBboxToRect,
diff --git a/packages/core/src/ai-model/prompt/assertion.ts b/packages/core/src/ai-model/prompt/assertion.ts
@@ -1,5 +1,5 @@
 import { getPreferredLanguage } from '@midscene/shared/env';
-import type { ResponseFormatJSONSchema } from 'openai/resources';
+import type { ResponseFormatJSONSchema } from 'openai/resources/index';
 
 const defaultAssertionPrompt =
   'You are a senior testing engineer. User will give an assertion and a screenshot of a page. By carefully viewing the screenshot, please tell whether the assertion is truthy.';
diff --git a/packages/core/src/ai-model/prompt/extraction.ts b/packages/core/src/ai-model/prompt/extraction.ts
@@ -1,5 +1,5 @@
 import { PromptTemplate } from '@langchain/core/prompts';
-import type { ResponseFormatJSONSchema } from 'openai/resources';
+import type { ResponseFormatJSONSchema } from 'openai/resources/index';
 
 export function systemPromptToExtract() {
   return `
diff --git a/packages/core/src/ai-model/prompt/llm-locator.ts b/packages/core/src/ai-model/prompt/llm-locator.ts
@@ -1,6 +1,6 @@
 import { PromptTemplate } from '@langchain/core/prompts';
 import type { vlLocateMode } from '@midscene/shared/env';
-import type { ResponseFormatJSONSchema } from 'openai/resources';
+import type { ResponseFormatJSONSchema } from 'openai/resources/index';
 import { bboxDescription } from './common';
 export function systemPromptToLocateElement(
   vlMode: ReturnType<typeof vlLocateMode>,
diff --git a/packages/core/src/ai-model/prompt/llm-planning.ts b/packages/core/src/ai-model/prompt/llm-planning.ts
@@ -2,7 +2,7 @@ import assert from 'node:assert';
 import type { DeviceAction } from '@/types';
 import { PromptTemplate } from '@langchain/core/prompts';
 import type { vlLocateMode } from '@midscene/shared/env';
-import type { ResponseFormatJSONSchema } from 'openai/resources';
+import type { ResponseFormatJSONSchema } from 'openai/resources/index';
 import { bboxDescription } from './common';
 
 // Note: put the log field first to trigger the CoT
diff --git a/packages/core/src/ai-model/prompt/playwright-generator.ts b/packages/core/src/ai-model/prompt/playwright-generator.ts
@@ -3,7 +3,7 @@ import type {
   StreamingCodeGenerationOptions,
 } from '@/types';
 import { PLAYWRIGHT_EXAMPLE_CODE } from '@midscene/shared/constants';
-import type { ChatCompletionMessageParam } from 'openai/resources';
+import type { ChatCompletionMessageParam } from 'openai/resources/index';
 import { AIActionType, callAi } from '../index';
 
 // Import shared utilities and types from yaml-generator
diff --git a/packages/core/src/ai-model/service-caller/index.ts b/packages/core/src/ai-model/service-caller/index.ts
@@ -39,7 +39,7 @@ import { ifInBrowser } from '@midscene/shared/utils';
 import { HttpsProxyAgent } from 'https-proxy-agent';
 import { jsonrepair } from 'jsonrepair';
 import OpenAI, { AzureOpenAI } from 'openai';
-import type { ChatCompletionMessageParam } from 'openai/resources';
+import type { ChatCompletionMessageParam } from 'openai/resources/index';
 import type { Stream } from 'openai/streaming';
 import { SocksProxyAgent } from 'socks-proxy-agent';
 import { AIActionType, type AIArgs } from '../common';
diff --git a/packages/core/src/ai-model/ui-tars-planning.ts b/packages/core/src/ai-model/ui-tars-planning.ts
@@ -10,11 +10,11 @@ import {
   vlLocateMode,
 } from '@midscene/shared/env';
 import { resizeImgBase64 } from '@midscene/shared/img';
-import { transformHotkeyInput } from '@midscene/shared/keyboard-layout';
 import { getDebug } from '@midscene/shared/logger';
+import { transformHotkeyInput } from '@midscene/shared/us-keyboard-layout';
 import { assert } from '@midscene/shared/utils';
 import { actionParser } from '@ui-tars/action-parser';
-import type { ChatCompletionMessageParam } from 'openai/resources';
+import type { ChatCompletionMessageParam } from 'openai/resources/index';
 import { AIActionType } from './common';
 import { getSummary, getUiTarsPlanningPrompt } from './prompt/ui-tars-planning';
 import { call } from './service-caller/index';
diff --git a/packages/core/src/types.ts b/packages/core/src/types.ts
@@ -7,7 +7,7 @@ import type {
   Rect,
   Size,
 } from '@midscene/shared/types';
-import type { ChatCompletionMessageParam } from 'openai/resources';
+import type { ChatCompletionMessageParam } from 'openai/resources/index';
 import type {
   DetailedLocateParam,
   MidsceneYamlFlowItem,
diff --git a/packages/core/src/utils.ts b/packages/core/src/utils.ts
@@ -14,7 +14,7 @@ import {
   getAIConfig,
   getAIConfigInJson,
 } from '@midscene/shared/env';
-import { getRunningPkgInfo } from '@midscene/shared/fs';
+import { getRunningPkgInfo } from '@midscene/shared/node';
 import { assert, logMsg } from '@midscene/shared/utils';
 import {
   escapeScriptTag,
diff --git a/packages/core/tsconfig.json b/packages/core/tsconfig.json
@@ -9,7 +9,7 @@
     "isolatedModules": true,
     "jsx": "preserve",
     "lib": ["DOM", "ESNext"],
-    "moduleResolution": "node",
+    "moduleResolution": "bundler",
     "paths": {
       "@/*": ["./src/*"]
     },
@@ -18,8 +18,14 @@
     "skipLibCheck": true,
     "strict": true,
     "module": "ESNext",
-    "target": "es2018"
+    "target": "es2018",
+    "composite": true
   },
   "exclude": ["**/node_modules"],
-  "include": ["src", "report"]
+  "include": ["src", "report"],
+  "references": [
+    {
+      "path": "../shared"
+    }
+  ]
 }
diff --git a/packages/shared/package.json b/packages/shared/package.json
@@ -9,67 +9,31 @@
   "exports": {
     ".": {
       "types": "./dist/types/index.d.ts",
-      "default": "./dist/lib/index.js"
+      "default": "./dist/es/index.js"
     },
     "./constants": {
-      "types": "./dist/types/constants.d.ts",
-      "default": "./dist/lib/constants.js"
-    },
-    "./fs": {
-      "types": "./dist/types/fs.d.ts",
-      "default": "./dist/lib/fs.js"
-    },
-    "./img": {
-      "types": "./dist/types/img.d.ts",
-      "default": "./dist/lib/img.js"
-    },
-    "./utils": {
-      "types": "./dist/types/utils.d.ts",
-      "default": "./dist/lib/utils.js"
+      "types": "./dist/types/constants/index.d.ts",
+      "default": "./dist/es/constants/index.js"
     },
     "./extractor": {
-      "types": "./dist/types/extractor.d.ts",
-      "default": "./dist/lib/extractor.js"
-    },
-    "./extractor-debug": {
-      "types": "./dist/types/extractor-debug.d.ts",
-      "default": "./dist/lib/extractor-debug.js"
-    },
-    "./keyboard-layout": {
-      "types": "./dist/types/us-keyboard-layout.d.ts",
-      "default": "./dist/lib/us-keyboard-layout.js"
+      "types": "./dist/types/extractor/index.d.ts",
+      "default": "./dist/es/extractor/index.js"
     },
-    "./logger": {
-      "types": "./dist/types/logger.d.ts",
-      "default": "./dist/lib/logger.js"
-    },
-    "./common": {
-      "types": "./dist/types/common.d.ts",
-      "default": "./dist/lib/common.js"
+    "./img": {
+      "types": "./dist/types/img/index.d.ts",
+      "default": "./dist/es/img/index.js"
     },
-    "./env": {
-      "types": "./dist/types/env.d.ts",
-      "default": "./dist/lib/env.js"
+    "./node": {
+      "types": "./dist/types/node/index.d.ts",
+      "default": "./dist/es/node/index.js"
     },
     "./types": {
-      "types": "./dist/types/types.d.ts",
-      "default": "./dist/lib/types.js"
-    }
-  },
-  "typesVersions": {
-    "*": {
-      ".": ["./dist/types/index.d.ts"],
-      "constants": ["./dist/types/constants.d.ts"],
-      "img": ["./dist/types/img.d.ts"],
-      "fs": ["./dist/types/fs.d.ts"],
-      "utils": ["./dist/types/utils.d.ts"],
-      "extractor": ["./dist/types/extractor.d.ts"],
-      "extractor-debug": ["./dist/types/extractor-debug.d.ts"],
-      "keyboard-layout": ["./dist/types/us-keyboard-layout.d.ts"],
-      "logger": ["./dist/types/logger.d.ts"],
-      "common": ["./dist/types/common.d.ts"],
-      "env": ["./dist/types/env.d.ts"],
-      "types": ["./dist/types/types.d.ts"]
+      "types": "./dist/types/types/index.d.ts",
+      "default": "./dist/es/types/index.js"
+    },
+    "./*": {
+      "types": "./dist/types/*.d.ts",
+      "default": "./dist/es/*.js"
     }
   },
   "files": ["dist", "src", "README.md"],
@@ -100,7 +64,6 @@
     "sharp": "^0.34.3"
   },
   "devDependencies": {
-    "@microsoft/api-extractor": "^7.52.10",
     "@rslib/core": "^0.11.2",
     "@types/debug": "4.1.12",
     "@types/node": "^18.0.0",
diff --git a/packages/shared/rslib.config.ts b/packages/shared/rslib.config.ts
@@ -18,6 +18,7 @@ export default defineConfig({
       autoExtension: false,
       format: 'cjs',
       syntax: 'es2020',
+      bundle: false,
     },
     {
       output: {
@@ -26,29 +27,13 @@ export default defineConfig({
         },
       },
       autoExtension: false,
-      dts: {
-        bundle: true,
-        distPath: 'dist/types',
-      },
       format: 'esm',
       syntax: 'es2020',
+      bundle: false,
+      dts: true,
     },
   ],
   source: {
-    entry: {
-      index: './src/index.ts',
-      img: './src/img/index.ts',
-      constants: './src/constants/index.ts',
-      extractor: './src/extractor/index.ts',
-      'extractor-debug': './src/extractor/debug.ts',
-      fs: './src/node/fs.ts',
-      utils: './src/utils.ts',
-      logger: './src/logger.ts',
-      common: './src/common.ts',
-      'us-keyboard-layout': './src/us-keyboard-layout.ts',
-      env: './src/env.ts',
-      types: './src/types/index.ts',
-    },
     define: {
       __HTML_ELEMENT_SCRIPT__: JSON.stringify(scriptStr),
     },
diff --git a/packages/shared/rslib.inspect.config.ts b/packages/shared/rslib.inspect.config.ts
@@ -18,7 +18,7 @@ export default defineConfig({
           htmlElementDebug: 'src/extractor/debug.ts',
         },
       },
-      syntax: 'es6',
+      syntax: 'esnext',
       tools: {
         rspack: {
           output: {
diff --git a/packages/shared/src/node/index.ts b/packages/shared/src/node/index.ts
@@ -0,0 +1 @@
+export * from './fs';
diff --git a/packages/shared/tsconfig.json b/packages/shared/tsconfig.json
diff --git a/packages/visualizer/tsconfig.json b/packages/visualizer/tsconfig.json
diff --git a/packages/web-integration/src/chrome-extension/cdpInput.ts b/packages/web-integration/src/chrome-extension/cdpInput.ts
diff --git a/packages/web-integration/src/puppeteer/base-page.ts b/packages/web-integration/src/puppeteer/base-page.ts
diff --git a/packages/web-integration/tsconfig.json b/packages/web-integration/tsconfig.json
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml

Original file line number	Diff line number	Diff line change
`@@ -43,6 +43,7 @@`
`43`	`43`	`"archiver": "^6.0.0",`
`44`	`44`	`"less": "^4.2.0",`
`45`	`45`	`"tailwindcss": "4.1.11",`
`46`		`- "typescript": "^5.8.3"`
	`46`	`+ "typescript": "^5.8.3",`
	`47`	`+ "openai": "4.81.0"`
`47`	`48`	`}`
`48`	`49`	`}`