{isConnected && (
diff --git a/core/http/react-ui/src/pages/talk.css b/addons/talk/ui/src/pages/talk.css
similarity index 99%
rename from core/http/react-ui/src/pages/talk.css
rename to addons/talk/ui/src/pages/talk.css
index b3735b76e..03aec8fd5 100644
--- a/core/http/react-ui/src/pages/talk.css
+++ b/addons/talk/ui/src/pages/talk.css
@@ -10,7 +10,6 @@
.talk-page a:focus-visible,
.talk-page input:focus-visible { outline: 2px solid var(--dk-accent-text); outline-offset: 2px; }
.talk-hd { display: flex; align-items: center; gap: 12px; min-height: 56px; padding: 8px 0; }
-.talk-hd h1 { margin: 0; font-family: var(--font-sans); font-size: 20px; font-weight: 650; letter-spacing: -.01em; }
.talk-hd__sub { color: var(--dk-muted); font-family: var(--font-mono); font-size: 12px; }
.talk-hd__acts { display: flex; align-items: center; gap: 2px; margin-left: auto; }
.talk-icobtn {
diff --git a/addons/talk/ui/src/style.css b/addons/talk/ui/src/style.css
new file mode 100644
index 000000000..9d3339f14
--- /dev/null
+++ b/addons/talk/ui/src/style.css
@@ -0,0 +1 @@
+/* Styles of the Talk add-on. The page style sheet (pages/talk.css) is added by the build. */
diff --git a/addons/talk/ui/test/parity.test.mjs b/addons/talk/ui/test/parity.test.mjs
new file mode 100644
index 000000000..7a8d77059
--- /dev/null
+++ b/addons/talk/ui/test/parity.test.mjs
@@ -0,0 +1,39 @@
+import test from 'node:test'
+import assert from 'node:assert/strict'
+import { readFileSync } from 'node:fs'
+import { dirname, join } from 'node:path'
+import { fileURLToPath } from 'node:url'
+import { hasKey, iconLiterals, iconNames, literalKeys, sourceFiles, spriteNames, text, unresolvedImports } from '../../../internal/host-compat/test/parity.mjs'
+
+const here = dirname(fileURLToPath(import.meta.url))
+const src = join(here, '../src')
+const files = sourceFiles(src)
+
+test('every literal key the page reads is in the English talk locale', () => {
+ const en = JSON.parse(readFileSync(join(src, 'i18n/talk.en.json'), 'utf8'))
+ const keys = literalKeys(text(files))
+ assert.ok(keys.size > 40, `found only ${keys.size} literal keys`)
+ assert.deepEqual([...keys].filter((k) => !hasKey(en, k)), [])
+})
+
+test('every icon the page names is one the SDK allows', async () => {
+ const allowed = await iconNames()
+ const sprite = spriteNames()
+ const used = iconLiterals(text(files))
+ assert.ok(used.size > 5, `found only ${used.size} icons`)
+ assert.deepEqual([...used].filter((n) => !sprite.has(n) || !allowed.has(n)), [])
+})
+
+test('the source imports only its own files, the compat stand-ins and the modules they answer', () => {
+ assert.deepEqual(unresolvedImports(src), [])
+})
+
+test('the source holds no direct network call', () => {
+ const direct = []
+ for (const f of files) {
+ for (const line of readFileSync(f, 'utf8').split('\n')) {
+ if (/\bfetch\(/.test(line) && !/^\s*\/\//.test(line)) direct.push(`${f.slice(src.length)}: ${line.trim()}`)
+ }
+ }
+ assert.deepEqual(direct, [])
+})
diff --git a/addons/talk/ui/test/render.test.mjs b/addons/talk/ui/test/render.test.mjs
new file mode 100644
index 000000000..e434e14d0
--- /dev/null
+++ b/addons/talk/ui/test/render.test.mjs
@@ -0,0 +1,55 @@
+import test from 'node:test'
+import assert from 'node:assert/strict'
+import { readFileSync } from 'node:fs'
+import { dirname, join } from 'node:path'
+import { fileURLToPath, pathToFileURL } from 'node:url'
+import { build } from '../build.mjs'
+import { React, renderToString, makeSdk } from '../../../internal/host-compat/test/host.mjs'
+
+const here = dirname(fileURLToPath(import.meta.url))
+
+async function load(overrides) {
+ const dir = await build()
+ const mod = await import(pathToFileURL(join(dir, 'ui/talk.js')).href + `?t=${Date.now()}`)
+ const host = await makeSdk({ addonId: 'talk', pages: ['talk'], overrides })
+ return { mod, ...host }
+}
+
+test('render: createAddon returns a page component and dispose', async () => {
+ const { mod, sdk, controller } = await load()
+ const addon = await mod.createAddon(sdk)
+ assert.equal(typeof addon.Component, 'function')
+ assert.equal(typeof addon.dispose, 'function')
+ addon.dispose()
+ controller.abort('done')
+})
+
+test('render: an unknown page draws nothing', async () => {
+ const { mod, sdk } = await load()
+ const addon = await mod.createAddon(sdk)
+ assert.equal(renderToString(React.createElement(addon.Component, { page: 'nope', path: '', search: '' })), '')
+})
+
+test('render: the page draws its title from the talk locale and no key', async () => {
+ const { mod, sdk } = await load()
+ const addon = await mod.createAddon(sdk)
+ const html = renderToString(React.createElement(addon.Component, { page: 'talk', path: '', search: '' }))
+ assert.ok(html.length > 200, 'the page drew something')
+ assert.doesNotMatch(html, />(stage|picker|view|controls|transcript|settings|toasts)\.[A-Za-z.]+ {
+ const { mod, sdk } = await load()
+ const old = Object.freeze({ ...sdk, ui: Object.freeze({}) })
+ await assert.rejects(mod.createAddon(old), /needs a newer LocalAI/)
+})
+
+test('render: the manifest declares one page, the main page and SDK 2', () => {
+ const m = JSON.parse(readFileSync(join(here, '../../manifest.json'), 'utf8'))
+ assert.equal(m.id, 'talk')
+ assert.deepEqual(m.capabilities.ui.pages, ['talk'])
+ assert.deepEqual(m.capabilities.ui.navigation, ['talk'])
+ assert.equal(m.capabilities.ui.mainPage, 'talk')
+ assert.deepEqual(m.capabilities.ui.sdk, { min: 2, max: 2 })
+ assert.deepEqual(m.capabilities.tools ?? [], [])
+})
diff --git a/addons/talk/ui/test/run.mjs b/addons/talk/ui/test/run.mjs
new file mode 100644
index 000000000..f92501cb4
--- /dev/null
+++ b/addons/talk/ui/test/run.mjs
@@ -0,0 +1,23 @@
+// Runs the node unit tests of the Talk UI package and prints one JSON line
+// per test, the same shape as the host's runner (core/http/react-ui/tests/unit):
+// {"case":"unit:
","status":"passed"|"failed"|"skipped"}
+import { run } from 'node:test'
+import { readdirSync } from 'node:fs'
+import { dirname, join } from 'node:path'
+import { fileURLToPath } from 'node:url'
+
+const here = dirname(fileURLToPath(import.meta.url))
+const names = readdirSync(here).filter(f => f.endsWith('.test.mjs')).sort()
+let failed = false
+const stream = run({ files: names.map(f => join(here, f)), concurrency: 1 })
+stream.on('test:pass', ({ name, skip, todo, nesting }) => {
+ if (nesting > 0) return
+ console.log(JSON.stringify({ case: `unit: ${name}`, status: skip || todo ? 'skipped' : 'passed' }))
+})
+stream.on('test:fail', ({ name, nesting, details }) => {
+ if (nesting > 0) return
+ failed = true
+ console.log(JSON.stringify({ case: `unit: ${name}`, status: 'failed', error: String(details && details.error && details.error.message || 'failed').slice(0, 400) }))
+})
+stream.on('end', () => { process.exit(failed ? 1 : 0) })
+stream.resume()
diff --git a/core/application/addon_pin_sweep_test.go b/core/application/addon_pin_sweep_test.go
index 7934deb39..4e93d3f77 100644
--- a/core/application/addon_pin_sweep_test.go
+++ b/core/application/addon_pin_sweep_test.go
@@ -8,6 +8,7 @@ import (
"testing"
"time"
+ "github.com/mudler/LocalAI/core/services/addons/builtin"
"github.com/mudler/LocalAI/core/services/addons/pins"
)
@@ -32,15 +33,20 @@ func pinnedIDs(t *testing.T, s pins.Store, user string) []string {
}
func TestSweepNeverDeletesTheBuiltinPins(t *testing.T) {
+ // No page is built in today, so the test makes up two.
+ defer builtin.SetCatalogForTest([]builtin.Entry{
+ {ID: "guide", Kind: builtin.KindPage, TitleKey: "items.chat", Icon: "chat", MainPath: "/app/chat"},
+ {ID: "help", Kind: builtin.KindPage, TitleKey: "items.models", Icon: "boxes", MainPath: "/app/models"},
+ })()
ctx := context.Background()
s, _ := pins.NewFileStore("")
- _ = s.Replace(ctx, "u1", []string{"studio", "talk", "notes"})
+ _ = s.Replace(ctx, "u1", []string{"guide", "help", "notes"})
t0 := time.Date(2026, 10, 1, 0, 0, 0, 0, time.UTC)
owner := fakeOwner{ids: []string{}}
sweepAddonPins(ctx, s, owner, t0)
sweepAddonPins(ctx, s, owner, t0.Add(pins.Retention+time.Hour))
// notes is not installed and expired; the built-ins are always present.
- if got := pinnedIDs(t, s, "u1"); !slices.Equal(got, []string{"studio", "talk"}) {
+ if got := pinnedIDs(t, s, "u1"); !slices.Equal(got, []string{"guide", "help"}) {
t.Fatalf("unexpected pins %v", got)
}
}
diff --git a/core/http/endpoints/addons/builtin.go b/core/http/endpoints/addons/builtin.go
index 4aab5f111..17b4bc3ad 100644
--- a/core/http/endpoints/addons/builtin.go
+++ b/core/http/endpoints/addons/builtin.go
@@ -27,7 +27,7 @@ func builtinViewer(c echo.Context, db *gorm.DB) (builtin.Viewer, bool) {
// ListBuiltin lists the built-in page add-ons the caller may open.
// @Summary List the built-in add-ons the caller may open
-// @Description Returns the page add-ons that ship with LocalAI (Studio and Talk). Each entry carries only its own gate: the route needs an authenticated caller and no `addons` feature, so a user who reaches Studio today still reaches it from the Add-ons drawer.
+// @Description Returns the page add-ons that ship inside the web bundle. The list is empty today: Studio and Talk are packaged add-ons that a person installs from the Add-ons drawer. Each entry carries only its own gate: the route needs an authenticated caller and no `addons` feature.
// @Tags AddonNavigation
// @Produce json
// @Success 200 {object} map[string][]builtin.Entry "Entries the caller may open"
diff --git a/core/http/endpoints/addons/builtin_test.go b/core/http/endpoints/addons/builtin_test.go
index 4a0a420a8..55bdda7d7 100644
--- a/core/http/endpoints/addons/builtin_test.go
+++ b/core/http/endpoints/addons/builtin_test.go
@@ -8,9 +8,11 @@ import (
"testing"
"github.com/labstack/echo/v4"
+ "github.com/mudler/LocalAI/core/services/addons/builtin"
)
-func TestListBuiltinWithoutAnAccountDatabaseListsEveryEntry(t *testing.T) {
+func listBuiltin(t *testing.T) (*httptest.ResponseRecorder, []string) {
+ t.Helper()
e := echo.New()
e.GET("/api/addons/builtin", ListBuiltin(nil))
rec := httptest.NewRecorder()
@@ -26,7 +28,30 @@ func TestListBuiltinWithoutAnAccountDatabaseListsEveryEntry(t *testing.T) {
if err := json.Unmarshal(rec.Body.Bytes(), &body); err != nil {
t.Fatal(err)
}
- if len(body.Builtin) != 2 || body.Builtin[0].ID != "studio" || body.Builtin[1].ID != "talk" {
+ ids := []string{}
+ for _, e := range body.Builtin {
+ ids = append(ids, e.ID)
+ }
+ return rec, ids
+}
+
+func TestListBuiltinIsEmptyBecauseStudioAndTalkArePackagedAddOns(t *testing.T) {
+ rec, ids := listBuiltin(t)
+ if len(ids) != 0 {
+ t.Fatalf("no page is built in, got %v", ids)
+ }
+ if rec.Header().Get("Cache-Control") != "private, no-store" {
+ t.Fatalf("the list depends on the caller and must not be cached, got %q", rec.Header().Get("Cache-Control"))
+ }
+}
+
+func TestListBuiltinWithoutAnAccountDatabaseListsEveryEntry(t *testing.T) {
+ defer builtin.SetCatalogForTest([]builtin.Entry{
+ {ID: "guide", Kind: builtin.KindPage, TitleKey: "items.chat", Icon: "chat", MainPath: "/app/chat"},
+ {ID: "notes-page", Kind: builtin.KindPage, TitleKey: "items.models", Icon: "boxes", MainPath: "/app/models"},
+ })()
+ rec, ids := listBuiltin(t)
+ if len(ids) != 2 || ids[0] != "guide" || ids[1] != "notes-page" {
t.Fatalf("unexpected body %s", rec.Body.String())
}
if rec.Header().Get("Cache-Control") != "private, no-store" {
diff --git a/core/http/endpoints/addons/pins_test.go b/core/http/endpoints/addons/pins_test.go
index 2520e0562..7fcec17d8 100644
--- a/core/http/endpoints/addons/pins_test.go
+++ b/core/http/endpoints/addons/pins_test.go
@@ -11,19 +11,31 @@ import (
"github.com/labstack/echo/v4"
"github.com/mudler/LocalAI/core/http/auth"
+ "github.com/mudler/LocalAI/core/services/addons/builtin"
"github.com/mudler/LocalAI/core/services/addons/pins"
)
+// No page is built in today, so these tests make up two built-in pages to check
+// how the routes filter and keep pins.
+func madeUpPages(t *testing.T) {
+ t.Helper()
+ t.Cleanup(builtin.SetCatalogForTest([]builtin.Entry{
+ {ID: "guide", Kind: builtin.KindPage, TitleKey: "items.chat", Icon: "chat", MainPath: "/app/chat"},
+ {ID: "help", Kind: builtin.KindPage, TitleKey: "items.models", Icon: "boxes", MainPath: "/app/models"},
+ }))
+}
+
// pinsApp builds the two routes over a store. With seeded set, the upgrade seed
// has run for the local owner, as it does at start in a deployment that
// existed before this release.
func pinsApp(t *testing.T, seeded bool) *echo.Echo {
+ madeUpPages(t)
store, err := pins.NewFileStore("")
if err != nil {
t.Fatal(err)
}
if seeded {
- if _, err := store.SeedExisting(context.Background(), []string{auth.AddonLocalOwnerID}, pins.SeedIDs); err != nil {
+ if _, err := store.SeedExisting(context.Background(), []string{auth.AddonLocalOwnerID}, []string{"guide", "help"}); err != nil {
t.Fatal(err)
}
}
@@ -55,23 +67,23 @@ func TestAnAccountCreatedAfterTheUpgradeGetsNoPins(t *testing.T) {
func TestPinsRoundTripForTheLocalOwner(t *testing.T) {
e := pinsApp(t, true)
code, got := call(e, http.MethodGet, "")
- if code != 200 || len(got) != 2 || got[0] != "studio" || got[1] != "talk" {
+ if code != 200 || len(got) != 2 || got[0] != "guide" || got[1] != "help" {
t.Fatalf("seed: %d %v", code, got)
}
- code, got = call(e, http.MethodPut, `["talk","studio"]`)
- if code != 200 || got[0] != "talk" {
+ code, got = call(e, http.MethodPut, `["help","guide"]`)
+ if code != 200 || got[0] != "help" {
t.Fatalf("put: %d %v", code, got)
}
_, got = call(e, http.MethodGet, "")
- if len(got) != 2 || got[0] != "talk" {
+ if len(got) != 2 || got[0] != "help" {
t.Fatalf("round trip: %v", got)
}
}
func TestPutDropsIDsTheCallerCannotSee(t *testing.T) {
e := pinsApp(t, false)
- _, got := call(e, http.MethodPut, `["studio","not-installed"]`)
- if len(got) != 1 || got[0] != "studio" {
+ _, got := call(e, http.MethodPut, `["guide","not-installed"]`)
+ if len(got) != 1 || got[0] != "guide" {
t.Fatalf("an unknown id must be dropped without a hint: %v", got)
}
}
@@ -89,9 +101,19 @@ func TestPutRejectsAListOverTheHardLimit(t *testing.T) {
e := pinsApp(t, false)
items := make([]string, pins.HardLimit+1)
for i := range items {
- items[i] = `"studio"`
+ items[i] = `"guide"`
}
if code, _ := call(e, http.MethodPut, "["+strings.Join(items, ",")+"]"); code != 400 {
t.Fatalf("want 400, got %d", code)
}
}
+
+func TestStudioAndTalkAreNotVisiblePinsWithoutTheAddOns(t *testing.T) {
+ // Studio and Talk are packaged add-ons: the routes list them only for a
+ // caller whose owner lists them as installed, never as built-in pages.
+ e := pinsApp(t, false)
+ _, got := call(e, http.MethodPut, `["studio","talk","guide"]`)
+ if len(got) != 1 || got[0] != "guide" {
+ t.Fatalf("studio and talk are not built in, so they are dropped: %v", got)
+ }
+}
diff --git a/core/http/react-ui/inline-style-baseline.txt b/core/http/react-ui/inline-style-baseline.txt
index aa34eab5f..960e7a870 100644
--- a/core/http/react-ui/inline-style-baseline.txt
+++ b/core/http/react-ui/inline-style-baseline.txt
@@ -1 +1 @@
-199
+182
diff --git a/core/http/react-ui/public/locales/de/nav.json b/core/http/react-ui/public/locales/de/nav.json
index c2ee5f143..5c19954c5 100644
--- a/core/http/react-ui/public/locales/de/nav.json
+++ b/core/http/react-ui/public/locales/de/nav.json
@@ -13,7 +13,6 @@
"account": "Konto",
"accountFor": "Konto: {{name}}",
"sections": {
- "create": "Erstellen",
"recognition": "Erkennung",
"build": "Entwickeln",
"operate": "Betrieb",
@@ -33,8 +32,6 @@
"home": "Start",
"models": "Models",
"chat": "Chat",
- "studio": "Studio",
- "talk": "Sprechen",
"fineTune": "Fine-Tuning (Experimentell)",
"quantize": "Quantisierung (Experimentell)",
"faces": "Gesichter",
diff --git a/core/http/react-ui/public/locales/en/nav.json b/core/http/react-ui/public/locales/en/nav.json
index b8e6c7976..e57397aa0 100644
--- a/core/http/react-ui/public/locales/en/nav.json
+++ b/core/http/react-ui/public/locales/en/nav.json
@@ -13,7 +13,6 @@
"account": "Account",
"accountFor": "Account: {{name}}",
"sections": {
- "create": "Create",
"recognition": "Recognition",
"build": "Build",
"operate": "Operate",
@@ -34,8 +33,6 @@
"home": "Home",
"models": "Models",
"chat": "Chat",
- "studio": "Studio",
- "talk": "Talk",
"fineTune": "Fine-Tune",
"quantize": "Quantize",
"faces": "Faces",
diff --git a/core/http/react-ui/public/locales/es/nav.json b/core/http/react-ui/public/locales/es/nav.json
index 249cd2463..546f2d943 100644
--- a/core/http/react-ui/public/locales/es/nav.json
+++ b/core/http/react-ui/public/locales/es/nav.json
@@ -13,7 +13,6 @@
"account": "Cuenta",
"accountFor": "Cuenta: {{name}}",
"sections": {
- "create": "Crear",
"recognition": "Reconocimiento",
"build": "Construir",
"operate": "Operar",
@@ -33,8 +32,6 @@
"home": "Inicio",
"models": "Models",
"chat": "Chat",
- "studio": "Studio",
- "talk": "Hablar",
"fineTune": "Ajuste fino (Experimental)",
"quantize": "Cuantización (Experimental)",
"faces": "Rostros",
diff --git a/core/http/react-ui/public/locales/id/nav.json b/core/http/react-ui/public/locales/id/nav.json
index b8fec31b7..aa3ac639e 100644
--- a/core/http/react-ui/public/locales/id/nav.json
+++ b/core/http/react-ui/public/locales/id/nav.json
@@ -13,7 +13,6 @@
"account": "Akun",
"accountFor": "Akun: {{name}}",
"sections": {
- "create": "Buat",
"recognition": "Pengenalan",
"build": "Bangun",
"operate": "Operasikan",
@@ -33,8 +32,6 @@
"home": "Beranda",
"models": "Models",
"chat": "Obrolan",
- "studio": "Studio",
- "talk": "Bicara",
"fineTune": "Fine-Tune (Eksperimental)",
"quantize": "Kuantisasi (Eksperimental)",
"faces": "Wajah",
diff --git a/core/http/react-ui/public/locales/it/nav.json b/core/http/react-ui/public/locales/it/nav.json
index cc6388bc4..9a3b22c8f 100644
--- a/core/http/react-ui/public/locales/it/nav.json
+++ b/core/http/react-ui/public/locales/it/nav.json
@@ -13,7 +13,6 @@
"account": "Account",
"accountFor": "Account: {{name}}",
"sections": {
- "create": "Crea",
"recognition": "Riconoscimento",
"build": "Costruisci",
"operate": "Gestione",
@@ -33,8 +32,6 @@
"home": "Home",
"models": "Models",
"chat": "Chat",
- "studio": "Studio",
- "talk": "Conversazione",
"fineTune": "Fine-Tuning (Sperimentale)",
"quantize": "Quantizzazione (Sperimentale)",
"faces": "Volti",
diff --git a/core/http/react-ui/public/locales/ko/nav.json b/core/http/react-ui/public/locales/ko/nav.json
index d351801e5..48420181e 100644
--- a/core/http/react-ui/public/locales/ko/nav.json
+++ b/core/http/react-ui/public/locales/ko/nav.json
@@ -13,7 +13,6 @@
"account": "계정",
"accountFor": "계정: {{name}}",
"sections": {
- "create": "만들기",
"recognition": "인식",
"build": "구축",
"operate": "운영",
@@ -33,8 +32,6 @@
"home": "홈",
"models": "Models",
"chat": "채팅",
- "studio": "스튜디오",
- "talk": "대화",
"fineTune": "파인튜닝 (실험적)",
"quantize": "양자화 (실험적)",
"faces": "얼굴",
diff --git a/core/http/react-ui/public/locales/pt-BR/nav.json b/core/http/react-ui/public/locales/pt-BR/nav.json
index 7f4326ec7..8533d8e2e 100644
--- a/core/http/react-ui/public/locales/pt-BR/nav.json
+++ b/core/http/react-ui/public/locales/pt-BR/nav.json
@@ -13,7 +13,6 @@
"account": "Conta",
"accountFor": "Conta: {{name}}",
"sections": {
- "create": "Criar",
"recognition": "Reconhecimento",
"build": "Construir",
"operate": "Operar",
@@ -33,8 +32,6 @@
"home": "Início",
"models": "Models",
"chat": "Chat",
- "studio": "Studio",
- "talk": "Falar",
"fineTune": "Ajuste Fino",
"quantize": "Quantizar",
"faces": "Rostos",
diff --git a/core/http/react-ui/public/locales/zh-CN/nav.json b/core/http/react-ui/public/locales/zh-CN/nav.json
index e210536ac..a26c1293d 100644
--- a/core/http/react-ui/public/locales/zh-CN/nav.json
+++ b/core/http/react-ui/public/locales/zh-CN/nav.json
@@ -13,7 +13,6 @@
"account": "账户",
"accountFor": "账户：{{name}}",
"sections": {
- "create": "创建",
"recognition": "识别",
"build": "构建",
"operate": "运维",
@@ -33,8 +32,6 @@
"home": "首页",
"models": "Models",
"chat": "聊天",
- "studio": "工作室",
- "talk": "通话",
"fineTune": "微调（实验性）",
"quantize": "量化（实验性）",
"faces": "人脸",
diff --git a/core/http/react-ui/src/addons/useAddonPage.js b/core/http/react-ui/src/addons/useAddonPage.js
new file mode 100644
index 000000000..e805ba80b
--- /dev/null
+++ b/core/http/react-ui/src/addons/useAddonPage.js
@@ -0,0 +1,16 @@
+import { useEffect } from 'react'
+import { useAddonRegistry } from './useAddonRegistry'
+import { appStatus } from './registryState'
+
+// The address of a page of an installed add-on, or null while the add-on is
+// absent, disabled, failed or unusable. A caller that links to an add-on page
+// (a command, a button) shows the link only when this answers an address, so a
+// person who has not installed the add-on never sees a dead end.
+export function useAddonPage(addonId, page) {
+ const { apps, acquire, allowed } = useAddonRegistry()
+ // The list is read only for a user the server lets see add-ons.
+ useEffect(() => (allowed ? acquire() : undefined), [acquire, allowed])
+ const app = apps.find(a => a.id === addonId)
+ const ready = appStatus(app) === 'ready' && Array.isArray(app.ui.pages) && app.ui.pages.includes(page)
+ return ready ? `/app/addons/${encodeURIComponent(addonId)}/${encodeURIComponent(page)}` : null
+}
diff --git a/core/http/react-ui/src/components/Sidebar.jsx b/core/http/react-ui/src/components/Sidebar.jsx
index a4aa9499b..6bebba8a5 100644
--- a/core/http/react-ui/src/components/Sidebar.jsx
+++ b/core/http/react-ui/src/components/Sidebar.jsx
@@ -8,7 +8,7 @@ import { useBranding } from '../contexts/BrandingContext'
import { apiUrl } from '../utils/basePath'
import { preloadRoute } from '../router'
import { hubs, hubEntryPath, hubOwnsPath } from './hub/hubConfig'
-import { topDestinations, createDestinations } from '../utils/destinations'
+import { topDestinations } from '../utils/destinations'
import { primaryDestinations, visiblePrimary } from '../utils/navigationModel'
import { useNavigation } from '../context/NavigationContext'
import PinnedNav from './PinnedNav'
@@ -21,18 +21,13 @@ const SECTIONS_KEY = 'localai_sidebar_sections'
// The sidebar has two layouts. The four-item layout shows Home, Chat, Models
// and Add-ons, the Pinned section, and Build and Operate under
// Workspace. With the legacy switch on (features.addon_navigation === false)
-// it shows Home and Models, the Create group (Chat, Studio, Talk) and
-// Workspace. Build and Operate are single entries; each opens a hub whose tab
-// bar lives in hub/hubConfig.js (shared with HubLayout). The legacy entries
-// are shared with the 404 page, which lists the same destinations.
+// it shows Home, Models and Chat, and Workspace. Build and Operate are single
+// entries; each opens a hub whose tab bar lives in hub/hubConfig.js (shared
+// with HubLayout). The legacy entries are shared with the 404 page, which
+// lists the same destinations.
const topItems = topDestinations
const sections = [
- {
- id: 'create',
- titleKey: 'sections.create',
- items: createDestinations,
- },
// Items come from the hubs (hubConfig.js) and carry their own gating.
{ id: 'workspace', titleKey: 'sections.workspace', hubs: true },
]
@@ -180,8 +175,8 @@ export default function Sidebar({ isOpen, onClose }) {
const failedOps = operations.filter((op) => op.error).length
const activeOps = operations.length
- // Create carries no gating beyond filterItem. Workspace lists one entry per
- // hub the viewer can use; its target is the hub's overview.
+ // Workspace lists one entry per hub the viewer can use; its target is the
+ // hub's overview.
const getVisibleSectionItems = (section) => {
if (!section.hubs) return section.items.filter(filterItem)
return hubs.flatMap(hub => {
diff --git a/core/http/react-ui/src/components/home/homeActions.js b/core/http/react-ui/src/components/home/homeActions.js
index a5b175bb8..03f8eb9ec 100644
--- a/core/http/react-ui/src/components/home/homeActions.js
+++ b/core/http/react-ui/src/components/home/homeActions.js
@@ -1,7 +1,8 @@
// The slash actions on the Home command bar. Every entry has a destination in
// the product today; the page decides what each one does (navigate, open the
// model list, start a chat). `needs` hides an action the person cannot use:
-// the admin pages, the assistant, or stopping a model when none is loaded.
+// the admin pages, the assistant, stopping a model when none is loaded, or
+// Studio while that add-on is not installed.
export const SLASH_GROUPS = ['chat', 'models', 'go']
@@ -14,18 +15,19 @@ export const SLASH_ACTIONS = [
{ id: 'installed', cmd: '/installed', icon: 'boxes', group: 'models', needs: 'admin' },
{ id: 'import', cmd: '/import', icon: 'upload', group: 'models', needs: 'admin' },
{ id: 'stop', cmd: '/stop', icon: 'stop', group: 'models', needs: 'loaded' },
- { id: 'studio', cmd: '/studio', icon: 'palette', group: 'go' },
+ { id: 'studio', cmd: '/studio', icon: 'palette', group: 'go', needs: 'studio' },
{ id: 'settings', cmd: '/settings', icon: 'settings', group: 'go', needs: 'admin' },
{ id: 'docs', cmd: '/docs', icon: 'book', group: 'go' },
]
-// `ctx`: { isAdmin, assistantAvailable, hasModels, loadedCount }
+// `ctx`: { isAdmin, assistantAvailable, hasModels, loadedCount, studioInstalled }
export function availableActions(ctx) {
return SLASH_ACTIONS.filter(a => {
if (a.needs === 'admin') return ctx.isAdmin
if (a.needs === 'assistant') return ctx.isAdmin && ctx.assistantAvailable
if (a.needs === 'models') return ctx.hasModels
if (a.needs === 'loaded') return ctx.isAdmin && ctx.loadedCount > 0
+ if (a.needs === 'studio') return ctx.studioInstalled === true
return true
})
}
diff --git a/core/http/react-ui/src/i18n/index.js b/core/http/react-ui/src/i18n/index.js
index 4dd66df7e..ce45237e1 100644
--- a/core/http/react-ui/src/i18n/index.js
+++ b/core/http/react-ui/src/i18n/index.js
@@ -22,8 +22,6 @@ export const NAMESPACES = [
'auth',
'home',
'chat',
- 'talk',
- 'studio',
'models',
'agents',
'skills',
diff --git a/core/http/react-ui/src/pages/Home.jsx b/core/http/react-ui/src/pages/Home.jsx
index 3d743b2cf..139413ce5 100644
--- a/core/http/react-ui/src/pages/Home.jsx
+++ b/core/http/react-ui/src/pages/Home.jsx
@@ -26,6 +26,7 @@ import HomeUndoToast from '../components/home/HomeUndoToast'
import { useResources } from '../hooks/useResources'
import { usePolling } from '../hooks/usePolling'
import { useOperations } from '../hooks/useOperations'
+import { useAddonPage } from '../addons/useAddonPage'
import { fileToBase64, backendControlApi, systemApi, modelsApi, mcpApi, nodesApi } from '../utils/api'
import { readAttachmentText, renderPdfPages, PdfNoTextError } from '../utils/pdf'
import { greetingKey } from '../utils/greeting'
@@ -448,9 +449,11 @@ export default function Home() {
const stripBusy = !!stagingOp || !!failedOp
useEffect(() => { if (stripBusy) setStripOpen(true) }, [stripBusy])
+ // Studio is an add-on: its command is offered only while it is installed.
+ const studioPage = useAddonPage('studio', 'studio')
const slashContext = useMemo(
- () => ({ isAdmin, assistantAvailable, hasModels: hasModels && !firstRun, loadedCount }),
- [isAdmin, assistantAvailable, hasModels, firstRun, loadedCount],
+ () => ({ isAdmin, assistantAvailable, hasModels: hasModels && !firstRun, loadedCount, studioInstalled: Boolean(studioPage) }),
+ [isAdmin, assistantAvailable, hasModels, firstRun, loadedCount, studioPage],
)
const runAction = useCallback((id) => {
@@ -466,12 +469,12 @@ export default function Home() {
setStripOpen(true)
stripRef.current?.scrollIntoView?.({ block: 'nearest', behavior: reducedMotion() ? 'auto' : 'smooth' })
break
- case 'studio': navigate('/app/studio'); break
+ case 'studio': if (studioPage) navigate(studioPage); break
case 'settings': navigate('/app/settings'); break
case 'docs': window.open(DOCS_URL, '_blank', 'noopener,noreferrer'); break
default: break
}
- }, [navigate, openNewChat, openAssistantChat])
+ }, [navigate, openNewChat, openAssistantChat, studioPage])
// "/" from anywhere that is not a text field starts a command.
useEffect(() => {
@@ -671,7 +674,7 @@ export default function Home() {
onDelete={requestDelete}
emptyHint={(
- {(isAdmin ? ['/gallery', '/import'] : []).concat(isAdmin && assistantAvailable ? ['/assistant'] : [], ['/studio']).map(c => (
+ {(isAdmin ? ['/gallery', '/import'] : []).concat(isAdmin && assistantAvailable ? ['/assistant'] : [], studioPage ? ['/studio'] : []).map(c => (
{c}
))}
diff --git a/core/http/react-ui/src/router.jsx b/core/http/react-ui/src/router.jsx
index 60ce5be12..48073d8b0 100644
--- a/core/http/react-ui/src/router.jsx
+++ b/core/http/react-ui/src/router.jsx
@@ -84,14 +84,6 @@ const Home = page('', () => import('./pages/Home'))
const Chat = page('chat', () => import('./pages/Chat'))
const Models = page('models', () => import('./pages/Models'))
const ManageRedirect = page('manage', () => import('./pages/ManageRedirect'))
-page('image', () => import('./pages/ImageGen'))
-page('video', () => import('./pages/VideoGen'))
-page('3d', () => import('./pages/ThreeDGen'))
-page('tts', () => import('./pages/TTS'))
-page('sound', () => import('./pages/Sound'))
-page('diarization', () => import('./pages/Diarization'))
-page('transform', () => import('./pages/AudioTransform'))
-const Talk = page('talk', () => import('./pages/Talk'))
// Referenced only from JSX below — same blind spot as Activity further down.
// eslint-disable-next-line no-unused-vars
const OperateOverview = page('operate', () => import('./pages/OperateOverview'))
@@ -128,7 +120,6 @@ const Explorer = page(null, () => import('./pages/Explorer'))
const Login = page(null, () => import('./pages/Login'))
const FineTune = page('fine-tune', () => import('./pages/FineTune'))
const Quantize = page('quantize', () => import('./pages/Quantize'))
-const Studio = page('studio', () => import('./pages/Studio'))
const FaceRecognition = page('face', () => import('./pages/FaceRecognition'))
const VoiceRecognition = page('voice', () => import('./pages/VoiceRecognition'))
const VoiceProfileCreate = page(null, () => import('./pages/VoiceProfileCreate'))
@@ -170,7 +161,7 @@ import HubLayout from './components/hub/HubLayout'
import { AddonRegistryProvider } from './addons/registry'
import { useAuth } from './context/AuthContext'
import { NavigationProvider, useNavigation } from './context/NavigationContext'
-import { studioRedirect } from './utils/legacyRoutes'
+import { studioAddress, studioRedirect, talkAddress } from './utils/legacyRoutes'
import { buildHub, operateHub } from './components/hub/hubConfig'
import { useHubAuth } from './components/hub/useHubAuth'
@@ -183,14 +174,27 @@ function AgentChatRedirect() {
return
}
-// An old generator link opens the same generator inside Studio. The model,
-// the query string and the hash are kept.
+// An old generator link opens the same generator inside the Studio add-on. The
+// model, the query string and the hash are kept.
function StudioTabRedirect({ legacy }) {
const { model } = useParams()
const { search, hash } = useLocation()
return
}
+// /app/studio[/tab[/model]] is a page of the Studio add-on now.
+function StudioRedirect() {
+ const { tab, model } = useParams()
+ const { search, hash } = useLocation()
+ return
+}
+
+// /app/talk is a page of the Talk add-on now.
+function TalkRedirect() {
+ const { search, hash } = useLocation()
+ return
+}
+
function BrowseRedirect() {
const { '*': splat } = useParams()
return
@@ -264,17 +268,16 @@ const appChildren = [
{ path: 'diarization/:model', element: },
{ path: 'transform', element: },
{ path: 'transform/:model', element: },
- { path: 'studio', element: },
- // Tabs are path segments, not a query parameter: switching generator is
- // navigation, and ?tab= reads like a filter. Legacy ?tab= links redirect.
- { path: 'studio/:tab', element: },
+ // Studio and Talk are add-ons; the old addresses open them. When the add-on
+ // is not installed the add-on page says so.
+ { path: 'studio', element: },
+ { path: 'studio/:tab', element: },
// A generator opened on one model: /app/studio/images/.
- { path: 'studio/:tab/:model', element: },
- { path: 'talk', element: },
+ { path: 'studio/:tab/:model', element: },
+ { path: 'talk', element: },
{ path: 'account', element: },
// The Add-ons drawer. A viewer without the addons feature still reaches it
- // when a built-in tile (Studio, Talk) is theirs to open, so no one loses a
- // page they can open today.
+ // when a built-in tile is theirs to open (the built-in list is empty today).
// With the legacy switch on, both routes sit in the Build hub again, under
// its Add-ons tab, and need the addons feature as they did before.
{
diff --git a/core/http/react-ui/src/utils/destinations.js b/core/http/react-ui/src/utils/destinations.js
index b6e81c5ba..f2a770bb6 100644
--- a/core/http/react-ui/src/utils/destinations.js
+++ b/core/http/react-ui/src/utils/destinations.js
@@ -4,15 +4,12 @@
import { hubs, hubEntryPath } from '../components/hub/hubConfig'
import { primaryDestinations, visiblePrimary } from './navigationModel.js'
+// Studio and Talk are add-ons: they are listed in the Add-ons drawer when they
+// are installed, not here.
export const topDestinations = [
{ path: '/app', icon: 'home', labelKey: 'items.home' },
{ path: '/app/models', icon: 'boxes', labelKey: 'items.models', adminOnly: true },
-]
-
-export const createDestinations = [
{ path: '/app/chat', icon: 'chat', labelKey: 'items.chat' },
- { path: '/app/studio', icon: 'palette', labelKey: 'items.studio' },
- { path: '/app/talk', icon: 'phone', labelKey: 'items.talk' },
]
function visible(item, { isAdmin, authEnabled, hasFeature, features }) {
@@ -23,7 +20,7 @@ function visible(item, { isAdmin, authEnabled, hasFeature, features }) {
return true
}
-// Home, Models, Chat, Studio, Talk and the hubs, in the sidebar's order.
+// Home, Models, Chat and the hubs, in the sidebar's order.
export function destinationsFor(auth) {
const hubItems = hubs.flatMap(hub => {
const path = hubEntryPath(hub, auth)
@@ -31,7 +28,6 @@ export function destinationsFor(auth) {
})
return [
...topDestinations.filter(i => visible(i, auth)),
- ...createDestinations.filter(i => visible(i, auth)),
...hubItems,
]
}
diff --git a/core/http/react-ui/src/utils/legacyRoutes.js b/core/http/react-ui/src/utils/legacyRoutes.js
index 1b1c8d3c7..cd2818dbb 100644
--- a/core/http/react-ui/src/utils/legacyRoutes.js
+++ b/core/http/react-ui/src/utils/legacyRoutes.js
@@ -1,7 +1,7 @@
// The old routes of the migration table and where they go now. Redirects stay
// in the app until a separate decision removes them.
-// Old generator route segment -> Studio tab key (pages/Studio.jsx MODALITIES).
+// Old generator route segment -> Studio tab key (the tabs of the Studio add-on).
export const STUDIO_TABS = Object.freeze({
image: 'images',
video: 'video',
@@ -12,29 +12,51 @@ export const STUDIO_TABS = Object.freeze({
transform: 'transform',
})
-// The target of an old generator route. The model segment, the query string
-// and the hash are kept as they came.
+// Studio and Talk are add-ons. Their pages live under /app/addons//;
+// the tab is one path segment and the model travels as ?model=, because
+// an add-on path segment cannot hold "/" or ":" (see resolveSubpath in the SDK).
+export const STUDIO_PAGE = '/app/addons/studio/studio'
+export const TALK_PAGE = '/app/addons/talk/talk'
+
+function addonAddress(base, { tab, model, search = '', hash = '' } = {}) {
+ const params = new URLSearchParams(search)
+ if (model) params.set('model', model)
+ const query = params.toString()
+ return `${base}${tab ? `/${encodeURIComponent(tab)}` : ''}${query ? `?${query}` : ''}${hash}`
+}
+
+// Where an old /app/studio[/tab[/model]] link opens now. The model, the query
+// string and the hash are kept.
+export function studioAddress(args) {
+ return addonAddress(STUDIO_PAGE, args)
+}
+
+// Where an old /app/talk link opens now.
+export function talkAddress(args) {
+ return addonAddress(TALK_PAGE, args)
+}
+
+// The target of an old generator route.
export function studioRedirect(legacy, model, search = '', hash = '') {
- const tab = STUDIO_TABS[legacy]
- const tail = model ? `/${encodeURIComponent(model)}` : ''
- return `/app/studio/${tab}${tail}${search}${hash}`
+ return studioAddress({ tab: STUDIO_TABS[legacy], model, search, hash })
}
// One row per old route of the spec's migration table that changes or keeps
-// its path. `kind` is 'same' (no redirect), 'studio-tab' or 'addon-page'.
+// its path. `kind` is 'same' (no redirect), 'studio-tab' (a Studio tab) or
+// 'addon-page' (a page of an add-on).
export const MIGRATION_ROUTES = Object.freeze([
{ from: '/app/chat', to: '/app/chat', kind: 'same' },
{ from: '/app/models', to: '/app/models', kind: 'same' },
{ from: '/app/settings', to: '/app/settings', kind: 'same' },
- { from: '/app/studio', to: '/app/studio', kind: 'same' },
- { from: '/app/talk', to: '/app/talk', kind: 'same' },
- { from: '/app/image', to: '/app/studio/images', kind: 'studio-tab' },
- { from: '/app/video', to: '/app/studio/video', kind: 'studio-tab' },
- { from: '/app/3d', to: '/app/studio/threed', kind: 'studio-tab' },
- { from: '/app/tts', to: '/app/studio/tts', kind: 'studio-tab' },
- { from: '/app/sound', to: '/app/studio/sound', kind: 'studio-tab' },
- { from: '/app/diarization', to: '/app/studio/diarization', kind: 'studio-tab' },
- { from: '/app/transform', to: '/app/studio/transform', kind: 'studio-tab' },
+ { from: '/app/studio', to: '/app/addons/studio/studio', kind: 'addon-page' },
+ { from: '/app/talk', to: '/app/addons/talk/talk', kind: 'addon-page' },
+ { from: '/app/image', to: '/app/addons/studio/studio/images', kind: 'studio-tab' },
+ { from: '/app/video', to: '/app/addons/studio/studio/video', kind: 'studio-tab' },
+ { from: '/app/3d', to: '/app/addons/studio/studio/threed', kind: 'studio-tab' },
+ { from: '/app/tts', to: '/app/addons/studio/studio/tts', kind: 'studio-tab' },
+ { from: '/app/sound', to: '/app/addons/studio/studio/sound', kind: 'studio-tab' },
+ { from: '/app/diarization', to: '/app/addons/studio/studio/diarization', kind: 'studio-tab' },
+ { from: '/app/transform', to: '/app/addons/studio/studio/transform', kind: 'studio-tab' },
{ from: '/app/face', to: '/app/addons/face/recognition', kind: 'addon-page' },
{ from: '/app/voice', to: '/app/addons/voice/recognition', kind: 'addon-page' },
{ from: '/app/voice-library', to: '/app/addons/voice/library', kind: 'addon-page' },
diff --git a/core/http/react-ui/tests/unit/legacyroutes.test.mjs b/core/http/react-ui/tests/unit/legacyroutes.test.mjs
index ccaf8c2e7..6d13b93fc 100644
--- a/core/http/react-ui/tests/unit/legacyroutes.test.mjs
+++ b/core/http/react-ui/tests/unit/legacyroutes.test.mjs
@@ -3,15 +3,24 @@ import assert from 'node:assert/strict'
import { readFileSync } from 'node:fs'
import { dirname, join } from 'node:path'
import { fileURLToPath } from 'node:url'
-import { STUDIO_TABS, studioRedirect, MIGRATION_ROUTES } from '../../src/utils/legacyRoutes.js'
+import { STUDIO_TABS, studioAddress, studioRedirect, talkAddress, MIGRATION_ROUTES } from '../../src/utils/legacyRoutes.js'
const here = dirname(fileURLToPath(import.meta.url))
const router = readFileSync(join(here, '../../src/router.jsx'), 'utf8')
-test('studioRedirect keeps the model, the query and the hash', () => {
- assert.equal(studioRedirect('image', 'stable/diffusion', '?x=1', '#top'), '/app/studio/images/stable%2Fdiffusion?x=1#top')
- assert.equal(studioRedirect('3d', undefined, '', ''), '/app/studio/threed')
- assert.equal(studioRedirect('tts', 'piper', '?voice=a', ''), '/app/studio/tts/piper?voice=a')
+test('studioRedirect opens the Studio add-on and keeps the model, the query and the hash', () => {
+ // A model id may hold "/" or ":", which an add-on path segment cannot, so it travels as ?model=.
+ assert.equal(studioRedirect('image', 'stable/diffusion', '?x=1', '#top'), '/app/addons/studio/studio/images?x=1&model=stable%2Fdiffusion#top')
+ assert.equal(studioRedirect('3d', undefined, '', ''), '/app/addons/studio/studio/threed')
+ assert.equal(studioRedirect('tts', 'piper', '?voice=a', ''), '/app/addons/studio/studio/tts?voice=a&model=piper')
+})
+
+test('studioAddress and talkAddress build the add-on page addresses', () => {
+ assert.equal(studioAddress(), '/app/addons/studio/studio')
+ assert.equal(studioAddress({ tab: 'images', model: 'a b', search: '?work=1' }), '/app/addons/studio/studio/images?work=1&model=a+b')
+ assert.equal(studioAddress({ search: '?work=w%201' }), '/app/addons/studio/studio?work=w+1')
+ assert.equal(talkAddress(), '/app/addons/talk/talk')
+ assert.equal(talkAddress({ search: '?model=x', hash: '#h' }), '/app/addons/talk/talk?model=x#h')
})
test('every standalone generator route maps to a Studio tab', () => {
@@ -39,8 +48,17 @@ test('each moved route has its own redirect entry, plain and with a model, bound
}
})
-test('Studio has a route that carries a model', () => {
- assert.ok(router.includes("path: 'studio/:tab/:model'"))
+test('the Studio and Talk routes redirect to their add-ons, with or without a tab and a model', () => {
+ for (const path of ["path: 'studio'", "path: 'studio/:tab'", "path: 'studio/:tab/:model'"]) {
+ assert.ok(router.includes(`{ ${path}, element: }`), `no StudioRedirect for ${path}`)
+ }
+ assert.ok(router.includes("{ path: 'talk', element: }"))
+ assert.ok(MIGRATION_ROUTES.some(r => r.from === '/app/studio' && r.to === '/app/addons/studio/studio' && r.kind === 'addon-page'))
+ assert.ok(MIGRATION_ROUTES.some(r => r.from === '/app/talk' && r.to === '/app/addons/talk/talk' && r.kind === 'addon-page'))
+})
+
+test('the router imports no Studio or Talk page: both are add-ons', () => {
+ assert.ok(!/pages\/(Studio|Talk|ImageGen|VideoGen|ThreeDGen|TTS|Sound|Diarization|AudioTransform)'/.test(router))
})
test('the same-path routes need no redirect', () => {
@@ -48,7 +66,8 @@ test('the same-path routes need no redirect', () => {
})
test('moved biometric routes are wrapped in MovedPage in the router', () => {
- for (const r of MIGRATION_ROUTES.filter(x => x.kind === 'addon-page')) {
+ // Studio and Talk have no core page to fall back to; they redirect (see above).
+ for (const r of MIGRATION_ROUTES.filter(x => x.kind === 'addon-page' && !['/app/studio', '/app/talk'].includes(x.from))) {
const [, , , addon, page] = r.to.split('/')
assert.ok(router.includes(``) || router.includes(``), `router.jsx does not wrap ${r.from}`)
}
diff --git a/core/http/react-ui/tests/unit/navigation.test.mjs b/core/http/react-ui/tests/unit/navigation.test.mjs
index b832983de..b1cc9efce 100644
--- a/core/http/react-ui/tests/unit/navigation.test.mjs
+++ b/core/http/react-ui/tests/unit/navigation.test.mjs
@@ -44,11 +44,13 @@ test('tileFromApp: the title falls back to the id', () => {
})
test('buildTiles: built-in first, then apps by id, a built-in id wins', () => {
- const builtin = [{ id: 'studio', titleKey: 'items.studio', icon: 'palette', mainPath: '/app/studio' }]
- const tiles = buildTiles([app({ id: 'zed' }), app({ id: 'studio' }), app({ id: 'abc' })], builtin)
- assert.deepEqual(tiles.map(t => t.id), ['studio', 'abc', 'zed'])
+ // No add-on is built in today (Studio and Talk are packaged add-ons), so the
+ // rule is checked with an entry the test makes up.
+ const builtin = [{ id: 'guide', titleKey: 'items.guide', icon: 'book', mainPath: '/app/guide' }]
+ const tiles = buildTiles([app({ id: 'zed' }), app({ id: 'guide' }), app({ id: 'abc' })], builtin)
+ assert.deepEqual(tiles.map(t => t.id), ['guide', 'abc', 'zed'])
assert.equal(tiles[0].source, 'builtin')
- assert.equal(tiles[0].target, '/app/studio')
+ assert.equal(tiles[0].target, '/app/guide')
})
test('filterTiles matches title and description, case-insensitive', () => {
@@ -98,13 +100,13 @@ test('pins api: reads and writes arrays, sends JSON, never throws on a malformed
const calls = []
const fetchImpl = async (url, init) => {
calls.push([url, init?.method || 'GET', init?.body])
- if (url.endsWith('/api/addons/builtin')) return { ok: true, json: async () => ({ builtin: [{ id: 'studio' }] }) }
- return { ok: true, json: async () => (init?.method === 'PUT' ? JSON.parse(init.body) : ['studio', 7, null]) }
+ if (url.endsWith('/api/addons/builtin')) return { ok: true, json: async () => ({ builtin: [{ id: 'guide' }] }) }
+ return { ok: true, json: async () => (init?.method === 'PUT' ? JSON.parse(init.body) : ['guide', 7, null]) }
}
const api = createPinsApi({ base: (p) => `/base${p}`, fetchImpl })
- assert.deepEqual(await api.listPins(), ['studio'])
+ assert.deepEqual(await api.listPins(), ['guide'])
assert.deepEqual(await api.putPins(['a', 'b']), ['a', 'b'])
- assert.deepEqual(await api.listBuiltin(), [{ id: 'studio' }])
+ assert.deepEqual(await api.listBuiltin(), [{ id: 'guide' }])
assert.equal(calls[1][0], '/base/api/addons/pins')
assert.equal(calls[1][1], 'PUT')
assert.equal(calls[1][2], '["a","b"]')
diff --git a/core/services/addons/builtin/builtin.go b/core/services/addons/builtin/builtin.go
index d8f7c52cf..37e58c244 100644
--- a/core/services/addons/builtin/builtin.go
+++ b/core/services/addons/builtin/builtin.go
@@ -1,10 +1,11 @@
// SPDX-License-Identifier: MIT
// Package builtin lists the page add-ons that ship inside the LocalAI web
-// bundle: Studio and Talk. Voice, Face, fine-tuning and quantization are
-// packaged add-ons and are not listed here. Page add-ons have
-// no process and no lifecycle of their own. The catalog is the one place that
-// says who may see each of them, so the pin routes and the drawer agree.
+// bundle. None does today: Studio, Talk, Voice, Face, fine-tuning and
+// quantization are packaged add-ons that a person installs and removes, so the
+// catalog is empty. The package stays because it is the one place that says
+// who may see a built-in page, so the pin routes and the drawer agree on it the
+// day one is added. Page add-ons have no process and no lifecycle of their own.
package builtin
import "slices"
@@ -45,9 +46,16 @@ func (v Viewer) allows(e Entry) bool {
return true
}
-var catalog = []Entry{
- {ID: "studio", Kind: KindPage, TitleKey: "items.studio", Icon: "palette", MainPath: "/app/studio"},
- {ID: "talk", Kind: KindPage, TitleKey: "items.talk", Icon: "phone", MainPath: "/app/talk"},
+var catalog = []Entry{}
+
+// SetCatalogForTest replaces the catalog and returns a function that puts the
+// old one back. No page is built in today, so the tests of the packages that
+// read the catalog (the pin and list routes, the pin sweep) use it to check
+// the rules against entries they make up. It is not safe for concurrent use.
+func SetCatalogForTest(entries []Entry) (restore func()) {
+ old := catalog
+ catalog = slices.Clone(entries)
+ return func() { catalog = old }
}
// Catalog returns a copy of every entry, in display order.
diff --git a/core/services/addons/builtin/builtin_test.go b/core/services/addons/builtin/builtin_test.go
index c6fb3bd7d..e5242e97f 100644
--- a/core/services/addons/builtin/builtin_test.go
+++ b/core/services/addons/builtin/builtin_test.go
@@ -14,10 +14,25 @@ func ids(es []Entry) []string {
return out
}
-func TestStudioAndTalkAreVisibleWithoutAnyFeature(t *testing.T) {
- got := ids(Visible(Viewer{Admin: false, Has: func(string) bool { return false }}))
- if !slices.Equal(got, []string{"studio", "talk"}) {
- t.Fatalf("a viewer with no feature must still see studio and talk, got %v", got)
+func TestNoAddonIsBuiltIn(t *testing.T) {
+ // Studio and Talk are packaged add-ons, installed and removed like the
+ // others, so nothing is listed for a viewer, whatever the viewer holds.
+ if got := ids(Visible(Viewer{Admin: true})); len(got) != 0 {
+ t.Fatalf("no add-on is built in, got %v", got)
+ }
+ if got := ids(Visible(Viewer{Has: func(string) bool { return true }})); len(got) != 0 {
+ t.Fatalf("no add-on is built in, got %v", got)
+ }
+ if len(IDs()) != 0 || len(Catalog()) != 0 {
+ t.Fatalf("the catalog must be empty, got %v", IDs())
+ }
+}
+
+func TestStudioAndTalkAreNotBuiltIn(t *testing.T) {
+ for _, id := range []string{"studio", "talk"} {
+ if slices.Contains(IDs(), id) {
+ t.Fatalf("%s is a packaged add-on and must not be in the built-in catalog", id)
+ }
}
}
diff --git a/gallery/addons/README.md b/gallery/addons/README.md
index e2e017a54..5a3bb343c 100644
--- a/gallery/addons/README.md
+++ b/gallery/addons/README.md
@@ -3,7 +3,7 @@
This directory holds the template of the catalog entries of the first-party add-ons.
It holds no live URL, registry or namespace. The registry and repository are inputs of
the release workflow (`ADDON_OCI_REPOSITORY`). Each first-party add-on has its own
-template (`tables`, `voice`, `face`, `fine-tuning`, `quantization`) and its own release
+template (`tables`, `voice`, `face`, `fine-tuning`, `quantization`, `studio`, `talk`) and its own release
platform matrix, `addons//package/platforms.yaml`. The templates differ in `name:` only.
## Render entries
@@ -31,7 +31,7 @@ go run ./scripts/addons/cmd/addonpkg catalog \
--merged ... # the other flags as above
```
-Use `face`, `fine-tuning` or `quantization` in place of `voice` for the other packages.
+Use `face`, `fine-tuning`, `quantization`, `studio` or `talk` in place of `voice` for the other packages.
Each package has its own repository, so pass the repository of that package.
The add-on packages live in `quay.io/go-skynet/local-ai-addons`; the template itself holds
diff --git a/gallery/addons/studio.yaml.tmpl b/gallery/addons/studio.yaml.tmpl
new file mode 100644
index 000000000..ceb333a93
--- /dev/null
+++ b/gallery/addons/studio.yaml.tmpl
@@ -0,0 +1,18 @@
+addonId: "{{addon}}"
+name: Studio
+description: "{{description}}"
+version: "{{version}}"
+channel: "{{channel}}"
+artifact: "oci://{{repository}}:{{tag}}"
+digest: "{{digest}}"
+os: "{{os}}"
+arch: "{{arch}}"
+policy:
+ requireSignature: true
+ issuer: "{{issuer}}"
+ identity: "{{identity}}"
+ui:
+ title: "{{title}}"
+ description: "{{description}}"
+ mainPage: "{{main_page}}"
+ icon: "{{icon}}"
diff --git a/gallery/addons/talk.yaml.tmpl b/gallery/addons/talk.yaml.tmpl
new file mode 100644
index 000000000..282b5940a
--- /dev/null
+++ b/gallery/addons/talk.yaml.tmpl
@@ -0,0 +1,18 @@
+addonId: "{{addon}}"
+name: Talk
+description: "{{description}}"
+version: "{{version}}"
+channel: "{{channel}}"
+artifact: "oci://{{repository}}:{{tag}}"
+digest: "{{digest}}"
+os: "{{os}}"
+arch: "{{arch}}"
+policy:
+ requireSignature: true
+ issuer: "{{issuer}}"
+ identity: "{{identity}}"
+ui:
+ title: "{{title}}"
+ description: "{{description}}"
+ mainPage: "{{main_page}}"
+ icon: "{{icon}}"
diff --git a/pkg/addons/packaging/packaging_test.go b/pkg/addons/packaging/packaging_test.go
index ce47cedd0..416a59e01 100644
--- a/pkg/addons/packaging/packaging_test.go
+++ b/pkg/addons/packaging/packaging_test.go
@@ -869,7 +869,7 @@ var _ = Describe("catalog template", func() {
Expect(entries[0].Arch).NotTo(Equal(entries[1].Arch))
})
It("renders an entry for every first-party add-on from its own template", func() {
- for _, id := range []string{"tables", "voice", "face", "fine-tuning", "quantization"} {
+ for _, id := range []string{"tables", "voice", "face", "fine-tuning", "quantization", "studio", "talk"} {
p := newProjectFor(id, both)
m := p.merged("1.2.3", rev, nil)
repoName := newRegistry().repo("addons/" + id)
@@ -1038,7 +1038,7 @@ var _ = Describe("workflow policy", func() {
})
It("rejects a workflow that names one add-on by path or skips an add-on in the matrix", func() {
expect(mutate("node \"addons/$ADDON/ui/build.mjs\"\n - name: Fill", "node addons/tables/ui/build.mjs\n - name: Fill"), "P_ADDON_PATH")
- expect(mutate(" addon: [tables, voice, face, fine-tuning, quantization]\n", " platform: [x]\n"), "P_MATRIX")
+ expect(mutate(" addon: [tables, voice, face, fine-tuning, quantization, studio, talk]\n", " platform: [x]\n"), "P_MATRIX")
})
It("rejects a plan that does not refuse an add-on without an enabled platform", func() {
expect(mutate("has no enabled platform; refusing to publish", "has no platform"), "P_FAIL_CLOSED")
@@ -1089,7 +1089,7 @@ var _ = Describe("workflow policy", func() {
// firstPartyAddons are the add-ons the release workflow packages. The list is
// written out so a new add-on is a deliberate change here and in the workflow.
-var firstPartyAddons = []string{"tables", "voice", "face", "fine-tuning", "quantization"}
+var firstPartyAddons = []string{"tables", "voice", "face", "fine-tuning", "quantization", "studio", "talk"}
func readWorkflow(t *testing.T) string {
t.Helper()
diff --git a/pkg/addons/packaging/platforms_test.go b/pkg/addons/packaging/platforms_test.go
index 9bda7235e..d6c2e2797 100644
--- a/pkg/addons/packaging/platforms_test.go
+++ b/pkg/addons/packaging/platforms_test.go
@@ -24,7 +24,7 @@ var releasePlatforms = map[string]string{
// request. Enabling without this record, or recording without enabling, fails.
var nativeChecked = map[string]bool{"linux/amd64": true, "linux/arm64": true, "darwin/arm64": true, "darwin/amd64": true}
-var packagedAddons = []string{"voice", "face", "fine-tuning", "quantization"}
+var packagedAddons = []string{"voice", "face", "fine-tuning", "quantization", "studio", "talk"}
func TestEveryPackagedAddonListsEveryReleasePlatformWithItsRunner(t *testing.T) {
for _, id := range packagedAddons {
diff --git a/scripts/addons/package_test.sh b/scripts/addons/package_test.sh
index 32e36cbd8..348413604 100755
--- a/scripts/addons/package_test.sh
+++ b/scripts/addons/package_test.sh
@@ -88,7 +88,7 @@ test -f "$work/voice/receipt.json"
case_ok 'package.sh builds and verifies the voice add-on for the host'
# A platform other than the host is refused for every add-on, whatever the config.
if [ "$host" = linux/amd64 ]; then foreign=linux/arm64; else foreign=linux/amd64; fi
-for id in tables voice face fine-tuning quantization; do
+for id in tables voice face fine-tuning quantization studio talk; do
expect_fail "package.sh refuses a foreign platform without an executable: $id" 'is not this host' sh scripts/addons/package.sh --config "addons/$id/package/platforms.yaml" --layout "$work/foreign-$id" --version 1.2.3 --platform "$foreign" --local-check
done
case_ok 'package.sh refuses a foreign platform without an executable for every add-on'
@@ -114,11 +114,11 @@ exec "$realgo" "\$@"
STUB
chmod 755 "$work/stubbin/go"
: >"$work/gobuild.log"
-for id in tables voice face fine-tuning quantization; do
+for id in tables voice face fine-tuning quantization studio talk; do
PATH="$work/stubbin:$PATH" sh scripts/addons/package.sh --config "addons/$id/package/platforms.yaml" --layout "$work/stub-$id" --version 1.2.3 --platform "$host" --local-check >"$work/out" 2>&1 || { cat "$work/out" >&2; exit 1; }
done
grep -x './addons/tables/cmd/tables CGO_ENABLED=1' "$work/gobuild.log" >/dev/null
-for id in voice face fine-tuning quantization; do
+for id in voice face fine-tuning quantization studio talk; do
grep -x "./addons/$id/cmd/$id CGO_ENABLED=0" "$work/gobuild.log" >/dev/null || { echo "FAIL: $id is not built with CGO_ENABLED=0" >&2; cat "$work/gobuild.log" >&2; exit 1; }
done
case_ok 'package.sh builds Tables with cgo and the pure Go add-ons without'
diff --git a/scripts/addons/suites.json b/scripts/addons/suites.json
index 3968a04ce..f259668e2 100644
--- a/scripts/addons/suites.json
+++ b/scripts/addons/suites.json
@@ -3292,6 +3292,8 @@
"package.sh refuses a foreign platform without an executable: face",
"package.sh refuses a foreign platform without an executable: fine-tuning",
"package.sh refuses a foreign platform without an executable: quantization",
+ "package.sh refuses a foreign platform without an executable: studio",
+ "package.sh refuses a foreign platform without an executable: talk",
"package.sh refuses a foreign platform without an executable for every add-on",
"package.sh builds Tables with cgo and the pure Go add-ons without",
"matrix fails closed while no platform is enabled",
diff --git a/swagger/docs.go b/swagger/docs.go
index ab46f9d33..2dc4ac1a6 100644
--- a/swagger/docs.go
+++ b/swagger/docs.go
@@ -476,7 +476,7 @@ const docTemplate = `{
},
"/api/addons/builtin": {
"get": {
- "description": "Returns the page add-ons that ship with LocalAI (Studio and Talk). Each entry carries only its own gate: the route needs an authenticated caller and no ` + "`" + `addons` + "`" + ` feature, so a user who reaches Studio today still reaches it from the Add-ons drawer.",
+ "description": "Returns the page add-ons that ship inside the web bundle. The list is empty today: Studio and Talk are packaged add-ons that a person installs from the Add-ons drawer. Each entry carries only its own gate: the route needs an authenticated caller and no ` + "`" + `addons` + "`" + ` feature.",
"produces": [
"application/json"
],
diff --git a/swagger/swagger.json b/swagger/swagger.json
index 96044d790..4415ed23f 100644
--- a/swagger/swagger.json
+++ b/swagger/swagger.json
@@ -473,7 +473,7 @@
},
"/api/addons/builtin": {
"get": {
- "description": "Returns the page add-ons that ship with LocalAI (Studio and Talk). Each entry carries only its own gate: the route needs an authenticated caller and no `addons` feature, so a user who reaches Studio today still reaches it from the Add-ons drawer.",
+ "description": "Returns the page add-ons that ship inside the web bundle. The list is empty today: Studio and Talk are packaged add-ons that a person installs from the Add-ons drawer. Each entry carries only its own gate: the route needs an authenticated caller and no `addons` feature.",
"produces": [
"application/json"
],
diff --git a/swagger/swagger.yaml b/swagger/swagger.yaml
index 0239d2773..2fd17daa9 100644
--- a/swagger/swagger.yaml
+++ b/swagger/swagger.yaml
@@ -6224,10 +6224,10 @@ paths:
- Addons
/api/addons/builtin:
get:
- description: 'Returns the page add-ons that ship with LocalAI (Studio and Talk).
- Each entry carries only its own gate: the route needs an authenticated caller
- and no `addons` feature, so a user who reaches Studio today still reaches
- it from the Add-ons drawer.'
+ description: 'Returns the page add-ons that ship inside the web bundle. The
+ list is empty today: Studio and Talk are packaged add-ons that a person installs
+ from the Add-ons drawer. Each entry carries only its own gate: the route needs
+ an authenticated caller and no `addons` feature.'
produces:
- application/json
responses: