Rename ai-ui-vue package to ai-foundation-sdk

ruibaby · ruibaby · commit 8200c2a00cc1 · 2026-06-15T16:02:01.000+08:00
Rename the publishable Vue/UI package from @halo-dev/ai-ui-vue to @halo-dev/ai-foundation-sdk across the repo. Updated imports in UI code, tests, README, and dev docs (dev/ui-message-stream.md); updated OpenSpec files and task lists to reference the new package name; adjusted ui/package.json workspace dependency and tsconfig path alias; and updated pnpm lock entries to reflect the workspace package rename. The package source location and runtime APIs remain the same—this change is a repo-wide rename of the package identity and references.
diff --git a/dev/ui-message-stream.md b/dev/ui-message-stream.md
@@ -156,10 +156,10 @@ Map<String, Object> requestMap =
 
 ## Vue 前端接入
 
-Vue 前端可以使用 `@halo-dev/ai-ui-vue` 直接消费 Halo UIMessage SSE 协议：
+Vue 前端可以使用 `@halo-dev/ai-foundation-sdk` 直接消费 Halo UIMessage SSE 协议：
 
 ```ts
-import { DefaultChatTransport, useChat } from '@halo-dev/ai-ui-vue'
+import { DefaultChatTransport, useChat } from '@halo-dev/ai-foundation-sdk'
 
 const chat = useChat({
   id: 'conversation-1',
@@ -202,7 +202,7 @@ X-Halo-AI-UI-Message-Stream: v1
 前端可以为流式接收阶段配置运行时 schema 钩子：
 
 ```ts
-import { DefaultChatTransport, useChat } from '@halo-dev/ai-ui-vue'
+import { DefaultChatTransport, useChat } from '@halo-dev/ai-foundation-sdk'
 
 const chat = useChat({
   id: 'conversation-1',
@@ -245,7 +245,7 @@ HTTP 请求、消息状态、Pinia 状态存储、Web Worker 或其他非 Vue 
 UIMessage SSE 并聚合 assistant 消息，可以使用 `readUIMessageStream`。
 
 ```ts
-import { readUIMessageStream, type UIMessage } from '@halo-dev/ai-ui-vue'
+import { readUIMessageStream, type UIMessage } from '@halo-dev/ai-foundation-sdk'
 
 const response = await fetch('/apis/example.halo.run/v1alpha1/chat/stream', {
   method: 'POST',
@@ -316,10 +316,10 @@ assistant 的文本消息片段，但不会提供工具、reasoning、data、来
 
 ## Completion 与对象流
 
-`@halo-dev/ai-ui-vue` 还提供两个文本流组合式函数：
+`@halo-dev/ai-foundation-sdk` 还提供两个文本流组合式函数：
 
 ```ts
-import { experimental_useObject, jsonSchema, useCompletion } from '@halo-dev/ai-ui-vue'
+import { experimental_useObject, jsonSchema, useCompletion } from '@halo-dev/ai-foundation-sdk'
 
 const completion = useCompletion({
   api: '/apis/example.halo.run/v1alpha1/completion/stream',
@@ -367,15 +367,15 @@ OpenAPI 生成客户端适合生成类型、路径、headers 和请求体，但
 响应抽象成 `Promise`，不适合作为浏览器端 `ReadableStream` / SSE 的消费入口。推荐模式是：
 
 1. 使用 OpenAPI 生成的参数构造器构造请求参数。
-2. 使用 `fromOpenAPIRequestArgs(...)` 转成 `@halo-dev/ai-ui-vue` 的预处理请求。
+2. 使用 `fromOpenAPIRequestArgs(...)` 转成 `@halo-dev/ai-foundation-sdk` 的预处理请求。
 3. 仍由 `DefaultChatTransport`、`useCompletion` 或 `experimental_useObject` 负责读取流。
 
 ```ts
 import {
   DefaultChatTransport,
   fromOpenAPIRequestArgs,
   useChat,
-} from '@halo-dev/ai-ui-vue'
+} from '@halo-dev/ai-foundation-sdk'
 import { ConsoleApiAifoundationHaloRunV1alpha1ModelApiAxiosParamCreator } from './api/generated'
 
 const paramCreator = ConsoleApiAifoundationHaloRunV1alpha1ModelApiAxiosParamCreator()
diff --git a/openspec/changes/archive/2026-06-09-add-ai-ui-vue-package/design.md b/openspec/changes/archive/2026-06-09-add-ai-ui-vue-package/design.md
@@ -10,7 +10,7 @@ The new package must be publishable for external Vue users and reusable by the c
 
 **Goals:**
 
-- Add `@halo-dev/ai-ui-vue` as a publishable Vue runtime package at `ui/packages/ai-ui-vue`.
+- Add `@halo-dev/ai-foundation-sdk` as a publishable Vue runtime package at `ui/packages/ai-ui-vue`.
 - Implement `useChat`, `useCompletion`, and `experimental_useObject` for Vue.
 - Include framework-neutral runtime primitives in the package: `Chat`, transports, stream readers, reducers, shared stores, tool continuation helpers, and TypeScript wire-contract types.
 - Make `Chat` independent from Vue by using a state adapter and callbacks; Vue composables provide refs and lifecycle cleanup.
@@ -22,7 +22,7 @@ The new package must be publishable for external Vue users and reusable by the c
 
 **Non-Goals:**
 
-- Do not add visual UI components to `@halo-dev/ai-ui-vue`.
+- Do not add visual UI components to `@halo-dev/ai-foundation-sdk`.
 - Do not depend on Halo Console-only packages or the generated console API client from the package.
 - Do not implement Vercel/AI SDK data-stream compatibility in the first release.
 - Do not add direct server-side Java SDK transports.
@@ -33,7 +33,7 @@ The new package must be publishable for external Vue users and reusable by the c
 
 ### Package Layout
 
-Create `ui/packages/ai-ui-vue` and extend `ui/pnpm-workspace.yaml` to include packages. The package name is `@halo-dev/ai-ui-vue`, version `0.1.0`, ESM-only, with explicit `exports`, generated `.d.ts`, and `files: ["dist"]`.
+Create `ui/packages/ai-ui-vue` and extend `ui/pnpm-workspace.yaml` to include packages. The package name is `@halo-dev/ai-foundation-sdk`, version `0.1.0`, ESM-only, with explicit `exports`, generated `.d.ts`, and `files: ["dist"]`.
 
 Rationale: this keeps npm-package code separate from plugin console code while allowing the console UI to consume it through the workspace. It also follows the package shape used by other `@halo-dev` frontend packages.
 
diff --git a/openspec/changes/archive/2026-06-09-add-ai-ui-vue-package/proposal.md b/openspec/changes/archive/2026-06-09-add-ai-ui-vue-package/proposal.md
@@ -4,7 +4,7 @@ Halo AI Foundation already provides backend UI message streams and structured ou
 
 ## What Changes
 
-- Add a publishable `@halo-dev/ai-ui-vue` package under `ui/packages/ai-ui-vue`.
+- Add a publishable `@halo-dev/ai-foundation-sdk` package under `ui/packages/ai-ui-vue`.
 - Provide Vue composables and supporting runtime APIs equivalent in scope to AI SDK UI for Vue: `useChat`, `useCompletion`, and `experimental_useObject`.
 - Provide framework-neutral chat core primitives inside the package, including `Chat`, Halo chat transports, stream readers, message reducers, tool continuation helpers, and public TypeScript types for Halo UI messages.
 - Support Halo UIMessage SSE streams and text streams as the package transport protocols.
diff --git a/openspec/changes/archive/2026-06-09-add-ai-ui-vue-package/specs/ai-ui-vue-package/spec.md b/openspec/changes/archive/2026-06-09-add-ai-ui-vue-package/specs/ai-ui-vue-package/spec.md
@@ -1,7 +1,7 @@
 ## ADDED Requirements
 
 ### Requirement: Publishable Vue runtime package
-The system SHALL provide a publishable `@halo-dev/ai-ui-vue` package that is separate from the plugin console UI.
+The system SHALL provide a publishable `@halo-dev/ai-foundation-sdk` package that is separate from the plugin console UI.
 
 #### Scenario: Package is separate from console source
 - **WHEN** the frontend workspace is installed
diff --git a/openspec/changes/archive/2026-06-09-add-ai-ui-vue-package/specs/model-test-workbench/spec.md b/openspec/changes/archive/2026-06-09-add-ai-ui-vue-package/specs/model-test-workbench/spec.md
@@ -1,7 +1,7 @@
 ## ADDED Requirements
 
 ### Requirement: Workbench dogfoods ai-ui-vue chat runtime
-The model test workbench SHALL use `@halo-dev/ai-ui-vue` for its UIMessage chat stream state and parsing path while preserving the existing console UI.
+The model test workbench SHALL use `@halo-dev/ai-foundation-sdk` for its UIMessage chat stream state and parsing path while preserving the existing console UI.
 
 #### Scenario: Workbench uses package chat transport
 - **WHEN** the administrator sends a chat test message through the workbench
diff --git a/openspec/changes/archive/2026-06-09-add-ai-ui-vue-package/specs/structured-output-generation/spec.md b/openspec/changes/archive/2026-06-09-add-ai-ui-vue-package/specs/structured-output-generation/spec.md
@@ -1,7 +1,7 @@
 ## ADDED Requirements
 
 ### Requirement: Object streaming endpoint contract
-The system SHALL support frontend object generation endpoints that consume `@halo-dev/ai-ui-vue` object requests and stream JSON text.
+The system SHALL support frontend object generation endpoints that consume `@halo-dev/ai-foundation-sdk` object requests and stream JSON text.
 
 #### Scenario: Endpoint derives object output from schema
 - **WHEN** an object streaming request contains `schema` and omits `output`
diff --git a/openspec/changes/archive/2026-06-09-add-ai-ui-vue-package/specs/ui-message-stream/spec.md b/openspec/changes/archive/2026-06-09-add-ai-ui-vue-package/specs/ui-message-stream/spec.md
@@ -1,7 +1,7 @@
 ## ADDED Requirements
 
 ### Requirement: Frontend package can consume UI message streams
-The Halo UI message stream protocol SHALL be consumable by the `@halo-dev/ai-ui-vue` default chat transport without backend-specific adapters in the frontend.
+The Halo UI message stream protocol SHALL be consumable by the `@halo-dev/ai-foundation-sdk` default chat transport without backend-specific adapters in the frontend.
 
 #### Scenario: SSE events contain UI message chunks
 - **WHEN** a backend endpoint returns a Halo UI message stream response
@@ -19,7 +19,7 @@ The Halo UI message stream protocol SHALL be consumable by the `@halo-dev/ai-ui-
 - **AND** the trigger values SHALL include `submit-message` and `regenerate-message`
 
 ### Requirement: Frontend package documentation for UI message streams
-Consumer documentation SHALL explain how Halo plugin authors expose endpoints for `@halo-dev/ai-ui-vue`.
+Consumer documentation SHALL explain how Halo plugin authors expose endpoints for `@halo-dev/ai-foundation-sdk`.
 
 #### Scenario: Chat endpoint example
 - **WHEN** a plugin author reads `dev/ui-message-stream.md`
diff --git a/openspec/changes/archive/2026-06-09-add-ai-ui-vue-package/tasks.md b/openspec/changes/archive/2026-06-09-add-ai-ui-vue-package/tasks.md
@@ -1,7 +1,7 @@
 ## 1. Package Setup
 
 - [x] 1.1 Extend `ui/pnpm-workspace.yaml` to include `ui/packages/*`.
-- [x] 1.2 Create `ui/packages/ai-ui-vue` with package metadata for `@halo-dev/ai-ui-vue@0.1.0`.
+- [x] 1.2 Create `ui/packages/ai-ui-vue` with package metadata for `@halo-dev/ai-foundation-sdk@0.1.0`.
 - [x] 1.3 Configure package TypeScript, build, exports, declaration output, and test setup.
 - [x] 1.4 Verify the selected build tool can produce ESM and `.d.ts` output without console-only dependencies.
 
@@ -43,7 +43,7 @@
 
 ## 6. Workbench Dogfood
 
-- [x] 6.1 Add the local workspace dependency from the console UI to `@halo-dev/ai-ui-vue`.
+- [x] 6.1 Add the local workspace dependency from the console UI to `@halo-dev/ai-foundation-sdk`.
 - [x] 6.2 Migrate the model test workbench chat UIMessage stream state and parsing path to the package runtime.
 - [x] 6.3 Preserve existing console layout, Chinese UI text, Markdown rendering, model attribution, parameter handling, and Halo components.
 - [x] 6.4 Preserve stop behavior, reasoning display separation, external tool result/error continuation, and approval response continuation.
@@ -52,7 +52,7 @@
 ## 7. Documentation
 
 - [x] 7.1 Write the package README with install instructions, exports, `useChat`, `useCompletion`, `experimental_useObject`, transports, and backend protocol examples.
-- [x] 7.2 Update `dev/ui-message-stream.md` with `@halo-dev/ai-ui-vue` chat endpoint integration guidance.
+- [x] 7.2 Update `dev/ui-message-stream.md` with `@halo-dev/ai-foundation-sdk` chat endpoint integration guidance.
 - [x] 7.3 Document object streaming request shape and final validation responsibilities in `dev/ui-message-stream.md`.
 - [x] 7.4 Ensure docs use Halo-owned wording and avoid presenting the package as an AI SDK-branded wrapper.
 
@@ -62,4 +62,4 @@
 - [x] 8.2 Run frontend type-check and relevant workbench tests.
 - [x] 8.3 Run backend tests for changed endpoint behavior when backend code changes.
 - [x] 8.4 Run `git diff --check` (raw check reports regenerated client whitespace; non-generated diff check passes).
-- [x] 8.5 Review package dependency tree to confirm no console-only dependencies are bundled into `@halo-dev/ai-ui-vue`.
+- [x] 8.5 Review package dependency tree to confirm no console-only dependencies are bundled into `@halo-dev/ai-foundation-sdk`.
diff --git a/openspec/changes/archive/2026-06-11-add-ui-message-stream-reader/proposal.md b/openspec/changes/archive/2026-06-11-add-ui-message-stream-reader/proposal.md
@@ -4,7 +4,7 @@ Callers that do not want to use `Chat` or `useChat` currently have to manually c
 
 ## What Changes
 
-- Add a public `readUIMessageStream` helper to `@halo-dev/ai-ui-vue` for reading an existing Halo UIMessage stream into an assistant message result.
+- Add a public `readUIMessageStream` helper to `@halo-dev/ai-foundation-sdk` for reading an existing Halo UIMessage stream into an assistant message result.
 - Support `AsyncIterable<UIMessageChunk>`, UIMessage SSE `ReadableStream<Uint8Array>`, and `Response` inputs.
 - Reuse the existing reducer, runtime schema hooks, data callback semantics, and one-time tool-call notification semantics.
 - Return structured lifecycle results including final message, terminal information, status, error flags, and optional errors.
diff --git a/openspec/changes/archive/2026-06-11-add-ui-message-stream-reader/specs/ai-ui-vue-package/spec.md b/openspec/changes/archive/2026-06-11-add-ui-message-stream-reader/specs/ai-ui-vue-package/spec.md
@@ -21,7 +21,7 @@ The package SHALL expose a public `readUIMessageStream` helper for callers that
 - **AND** it SHALL NOT parse non-stream HTTP error bodies
 
 #### Scenario: Reader is exported
-- **WHEN** a caller imports from `@halo-dev/ai-ui-vue`
+- **WHEN** a caller imports from `@halo-dev/ai-foundation-sdk`
 - **THEN** `readUIMessageStream` and its public option/result/status types SHALL be exported from the package entrypoint
 
 ### Requirement: Reader message creation options
diff --git a/openspec/changes/archive/2026-06-11-stabilize-ui-message-runtime/proposal.md b/openspec/changes/archive/2026-06-11-stabilize-ui-message-runtime/proposal.md
@@ -10,7 +10,7 @@ The current UI message runtime covers the first usable chat path, but its protoc
 - Add a single tool lifecycle model with `input-streaming`, `input-available`, `approval-requested`, `output-available`, and `output-error` states.
 - Add `onData`, `onToolCall`, `addToolOutput`, `rejectToolCall`, and a helper for automatic continuation when the last assistant message's tools are complete.
 - Split Java UI message responsibilities into focused model, identity, validation, reduction, codec, reader/writer, conversion, and chat handling classes.
-- Update `@halo-dev/ai-ui-vue` around a framework-neutral `Chat` core and Vue-only adapter, including `disconnected` status.
+- Update `@halo-dev/ai-foundation-sdk` around a framework-neutral `Chat` core and Vue-only adapter, including `disconnected` status.
 - Keep `useCompletion` and `experimental_useObject` as lightweight helpers, with small API cleanup only.
 - Dogfood the new runtime in the model test workbench without redesigning the UI.
 - Update `dev/ui-message-stream.md` as the detailed integration guide for consumer plugins.
diff --git a/openspec/changes/archive/2026-06-11-stabilize-ui-message-runtime/tasks.md b/openspec/changes/archive/2026-06-11-stabilize-ui-message-runtime/tasks.md
@@ -62,6 +62,6 @@
 
 - [x] 10.1 Run OpenSpec validation for `stabilize-ui-message-runtime`.
 - [x] 10.2 Run focused Java tests for UI message model, reducer, validation, conversion, and chat handling.
-- [x] 10.3 Run frontend package typecheck and tests for `@halo-dev/ai-ui-vue`.
+- [x] 10.3 Run frontend package typecheck and tests for `@halo-dev/ai-foundation-sdk`.
 - [x] 10.4 Run workbench-related frontend typecheck after dogfood wiring.
 - [x] 10.5 Run a final search for removed old tool API references and update any remaining caller paths.
diff --git a/openspec/changes/archive/2026-06-12-complete-ui-message-protocol-and-persistence-helpers/tasks.md b/openspec/changes/archive/2026-06-12-complete-ui-message-protocol-and-persistence-helpers/tasks.md
@@ -33,5 +33,5 @@
 - [x] 5.1 Update `dev/ui-message-stream.md` and package documentation to describe canonical tool stream chunks, final dynamic tool parts, `start-step`, persistence helpers, and throttle behavior.
 - [x] 5.2 Ensure docs explicitly defer stream resume, `source-document`, file expansion, and npm-side model-message conversion.
 - [x] 5.3 Run focused backend tests for UI message stream mapping/codec/reducer behavior.
-- [x] 5.4 Run package tests for `@halo-dev/ai-ui-vue`.
+- [x] 5.4 Run package tests for `@halo-dev/ai-foundation-sdk`.
 - [x] 5.5 Run `git diff --check`.
diff --git a/openspec/specs/ai-ui-vue-package/spec.md b/openspec/specs/ai-ui-vue-package/spec.md
@@ -3,7 +3,7 @@
 Define the publishable Vue runtime package for building Halo AI chat, completion, and structured object streaming interfaces.
 ## Requirements
 ### Requirement: Publishable Vue runtime package
-The system SHALL provide a publishable `@halo-dev/ai-ui-vue` package that is separate from the plugin console UI.
+The system SHALL provide a publishable `@halo-dev/ai-foundation-sdk` package that is separate from the plugin console UI.
 
 #### Scenario: Package is separate from console source
 - **WHEN** the frontend workspace is installed
@@ -419,7 +419,7 @@ The package SHALL expose a public `readUIMessageStream` helper for callers that
 - **AND** it SHALL NOT parse non-stream HTTP error bodies
 
 #### Scenario: Reader is exported
-- **WHEN** a caller imports from `@halo-dev/ai-ui-vue`
+- **WHEN** a caller imports from `@halo-dev/ai-foundation-sdk`
 - **THEN** `readUIMessageStream` and its public option/result/status types SHALL be exported from the package entrypoint
 
 ### Requirement: Reader message creation options
diff --git a/openspec/specs/model-test-workbench/spec.md b/openspec/specs/model-test-workbench/spec.md
@@ -188,7 +188,7 @@ The model test workbench SHALL provide a focused end-to-end flow for exercising
 - **AND** it SHALL NOT configure repair logic for the test request
 
 ### Requirement: Workbench dogfoods ai-ui-vue chat runtime
-The model test workbench SHALL use `@halo-dev/ai-ui-vue` for its UIMessage chat stream state and parsing path while preserving the existing console UI.
+The model test workbench SHALL use `@halo-dev/ai-foundation-sdk` for its UIMessage chat stream state and parsing path while preserving the existing console UI.
 
 #### Scenario: Workbench uses package chat runtime
 - **WHEN** the administrator sends a chat test message through the workbench with the UIMessage protocol selected
diff --git a/openspec/specs/structured-output-generation/spec.md b/openspec/specs/structured-output-generation/spec.md
@@ -204,7 +204,7 @@ The system SHALL map provider-neutral structured output requests to Spring AI 2.
 - **AND** structured output parsing SHALL apply to the final answer step as before the Spring AI upgrade
 
 ### Requirement: Object streaming endpoint contract
-The system SHALL support frontend object generation endpoints that consume `@halo-dev/ai-ui-vue` object requests and stream JSON text.
+The system SHALL support frontend object generation endpoints that consume `@halo-dev/ai-foundation-sdk` object requests and stream JSON text.
 
 #### Scenario: Endpoint derives object output from schema
 - **WHEN** an object streaming request contains `schema` and omits `output`
diff --git a/openspec/specs/ui-message-stream/spec.md b/openspec/specs/ui-message-stream/spec.md
@@ -364,7 +364,7 @@ The SDK SHALL expose complete UI message finish context from stream creation opt
 - **THEN** the finish result marks `isContinuation` true and replaces the last original message
 
 ### Requirement: Frontend package can consume UI message streams
-The Halo UI message stream protocol SHALL be consumable by the `@halo-dev/ai-ui-vue` default chat transport without backend-specific adapters in the frontend.
+The Halo UI message stream protocol SHALL be consumable by the `@halo-dev/ai-foundation-sdk` default chat transport without backend-specific adapters in the frontend.
 
 #### Scenario: SSE events contain UI message chunks
 - **WHEN** a backend endpoint returns a Halo UI message stream response
@@ -382,7 +382,7 @@ The Halo UI message stream protocol SHALL be consumable by the `@halo-dev/ai-ui-
 - **AND** the trigger values SHALL include `submit-message` and `regenerate-message`
 
 ### Requirement: Frontend package documentation for UI message streams
-Consumer documentation SHALL explain how Halo plugin authors expose endpoints for `@halo-dev/ai-ui-vue`.
+Consumer documentation SHALL explain how Halo plugin authors expose endpoints for `@halo-dev/ai-foundation-sdk`.
 
 #### Scenario: Chat endpoint example
 - **WHEN** a plugin author reads `dev/ui-message-stream.md`
diff --git a/ui/package.json b/ui/package.json
@@ -24,7 +24,7 @@
     "@formkit/core": "2.1.0",
     "@formkit/vue": "2.1.0",
     "@halo-dev/api-client": "^2.25.1",
-    "@halo-dev/ai-ui-vue": "workspace:*",
+    "@halo-dev/ai-foundation-sdk": "workspace:*",
     "@halo-dev/components": "^2.25.1",
     "@halo-dev/ui-shared": "^2.25.1",
     "@tanstack/vue-query": "^4.44.0",
diff --git a/ui/packages/sdk/README.md b/ui/packages/sdk/README.md
diff --git a/ui/pnpm-lock.yaml b/ui/pnpm-lock.yaml
diff --git a/ui/src/utils/model-test-workbench.test.ts b/ui/src/utils/model-test-workbench.test.ts
diff --git a/ui/src/utils/model-test-workbench.ts b/ui/src/utils/model-test-workbench.ts
diff --git a/ui/src/views/ModelTestWorkbenchView.vue b/ui/src/views/ModelTestWorkbenchView.vue
diff --git a/ui/tsconfig.json b/ui/tsconfig.json
