@frockbot/plugin-settings 0.1.3 → 0.2.0

package/src/client/UserSettingsSurface.vue

@@ -88,9 +88,12 @@ async function save(): Promise<void> {
     >
       <p class="field-hint">
         Settings of the Packages you have enabled. Model providers are
-        configured in Models and accounts in Connections.
+        configured in Models and accounts in Connectors.
       </p>
       <PackageSettingsSection />
+      <UiButton type="button" @click="surfaces.open('plugins')">
+        Open Plugins
+      </UiButton>
     </UiAnchor>
     <p v-if="web.settingsError" class="settings-error" role="alert">
       {{ web.settingsError }}
@@ -174,23 +177,6 @@ async function save(): Promise<void> {
   font-size: var(--frock-text-sm);
 }
 
-.model-empty {
-  display: flex;
-  flex-direction: column;
-  align-items: flex-start;
-  gap: 10px;
-  padding: 12px;
-  border: 1px solid var(--frock-border);
-  border-radius: var(--frock-radius-card);
-  background: var(--frock-surface-subtle);
-}
-
-.model-empty p {
-  margin: 0;
-  color: var(--frock-text-muted);
-  font-size: var(--frock-text-sm);
-}
-
 .settings-error {
   margin: 0;
   color: var(--frock-danger-text);

package/src/client/bot-settings.test.ts

@@ -1,183 +1,94 @@
 import { describe, expect, test } from "bun:test";
 import {
   decodeModelSelection,
-  describeModelAssignment,
+  describeModelBinding,
   encodeModelSelection,
   eligibleModelConnections,
   isModelConnectionEligible,
   modelSelectOptions,
-  resolveBotSettingsModel,
 } from "./bot-settings.js";
 
-describe("Bot settings model selection", () => {
-  test("excludes model Connections owned by disabled Packages", () => {
-    const connection = {
-      connectionId: "ollama-1",
-      packageId: "provider-ollama-cloud",
-      connectionTypeId: "ollama-cloud-account",
-      displayName: "Work",
-      state: "ready" as const,
-      providerType: "ollama-cloud",
-      generation: "generation-1",
-      safeMetadata: {},
-    };
-    const catalog = [
+const catalog = [
+  {
+    packageId: "provider-ollama-cloud",
+    displayName: "Ollama Cloud",
+    version: "0.0.1",
+    capabilities: [
       {
-        packageId: "provider-ollama-cloud",
-        displayName: "Ollama Cloud",
-        version: "0.0.1",
-        capabilities: [
-          {
-            id: "ollama-cloud-models",
-            kind: "model" as const,
-            connectionTypes: ["ollama-cloud-account"],
-          },
-        ],
-        connectionTypes: [
-          {
-            id: "ollama-cloud-account",
-            displayName: "Ollama Cloud account",
-            allowMultiple: true,
-            authorizationKind: "api-key" as const,
-            capabilities: ["ollama-cloud-models"],
-          },
-        ],
+        id: "ollama-cloud-models",
+        kind: "model" as const,
+        connectionTypes: ["ollama-cloud-account"],
       },
-    ];
+    ],
+    connectionTypes: [
+      {
+        id: "ollama-cloud-account",
+        displayName: "Ollama Cloud account",
+        allowMultiple: true,
+        authorizationKind: "api-key" as const,
+        capabilities: ["ollama-cloud-models"],
+      },
+    ],
+  },
+];
+const packages = [
+  {
+    packageId: "provider-ollama-cloud",
+    version: "0.0.1",
+    state: "installed" as const,
+  },
+];
+const connections = [
+  {
+    connectionId: "ollama-1",
+    packageId: "provider-ollama-cloud",
+    connectionTypeId: "ollama-cloud-account",
+    displayName: "Work",
+    state: "ready" as const,
+    providerType: "ollama-cloud",
+    modelCatalog: {
+      schemaVersion: 1 as const,
+      generation: "catalog-1",
+      state: "fresh" as const,
+      models: [
+        {
+          providerModelId: "llama-3:cloud",
+          displayName: "Llama 3",
+          capabilities: { tools: true, vision: false, reasoning: false },
+          source: "discovered" as const,
+        },
+      ],
+    },
+    safeMetadata: {},
+  },
+  {
+    connectionId: "ollama-2",
+    packageId: "provider-ollama-cloud",
+    connectionTypeId: "ollama-cloud-account",
+    displayName: "Revoked",
+    state: "revoked" as const,
+    safeMetadata: {},
+  },
+];
 
+describe("shared model option building", () => {
+  test("requires an enabled model provider Package", () => {
     expect(
       isModelConnectionEligible({
-        connection,
-        packages: [
-          {
-            packageId: "provider-ollama-cloud",
-            version: "0.0.1",
-            state: "disabled",
-          },
-        ],
+        connection: connections[0]!,
+        packages: [{ ...packages[0]!, state: "disabled" }],
         catalog,
       }),
     ).toBe(false);
     expect(
       isModelConnectionEligible({
-        connection,
-        packages: [
-          {
-            packageId: "provider-ollama-cloud",
-            version: "0.0.1",
-            state: "installed",
-          },
-        ],
+        connection: connections[0]!,
+        packages,
         catalog,
       }),
     ).toBe(true);
   });
 
-  test("preserves a model-less Bot while unrelated settings save", () => {
-    expect(
-      resolveBotSettingsModel({
-        useExactModel: false,
-        selectedModel: "",
-        exactConnectionId: "",
-        exactProviderModelId: "",
-      }),
-    ).toBeUndefined();
-  });
-
-  test("rejects malformed model selections before settings mutate", () => {
-    expect(() =>
-      resolveBotSettingsModel({
-        useExactModel: false,
-        selectedModel: "not-json",
-        exactConnectionId: "",
-        exactProviderModelId: "",
-      }),
-    ).toThrow("A Connection and model ID are required");
-  });
-
-  test("preserves an existing binding without a new selection", () => {
-    expect(
-      resolveBotSettingsModel({
-        current: {
-          connectionId: "ollama-1",
-          providerModelId: "glm:cloud",
-        },
-        useExactModel: false,
-        selectedModel: "",
-        exactConnectionId: "",
-        exactProviderModelId: "",
-      }),
-    ).toEqual({
-      connectionId: "ollama-1",
-      providerModelId: "glm:cloud",
-    });
-  });
-});
-
-describe("shared model option building", () => {
-  const catalog = [
-    {
-      packageId: "provider-ollama-cloud",
-      displayName: "Ollama Cloud",
-      version: "0.0.1",
-      capabilities: [
-        {
-          id: "ollama-cloud-models",
-          kind: "model" as const,
-          connectionTypes: ["ollama-cloud-account"],
-        },
-      ],
-      connectionTypes: [
-        {
-          id: "ollama-cloud-account",
-          displayName: "Ollama Cloud account",
-          allowMultiple: true,
-          authorizationKind: "api-key" as const,
-          capabilities: ["ollama-cloud-models"],
-        },
-      ],
-    },
-  ];
-  const packages = [
-    {
-      packageId: "provider-ollama-cloud",
-      version: "0.0.1",
-      state: "installed" as const,
-    },
-  ];
-  const connections = [
-    {
-      connectionId: "ollama-1",
-      packageId: "provider-ollama-cloud",
-      connectionTypeId: "ollama-cloud-account",
-      displayName: "Work",
-      state: "ready" as const,
-      providerType: "ollama-cloud",
-      modelCatalog: {
-        schemaVersion: 1 as const,
-        generation: "catalog-1",
-        state: "fresh" as const,
-        models: [
-          {
-            providerModelId: "llama-3:cloud",
-            displayName: "Llama 3",
-            capabilities: { tools: true, vision: false, reasoning: false },
-            source: "discovered" as const,
-          },
-        ],
-      },
-      safeMetadata: {},
-    },
-    {
-      connectionId: "ollama-2",
-      packageId: "provider-ollama-cloud",
-      connectionTypeId: "ollama-cloud-account",
-      displayName: "Revoked",
-      state: "revoked" as const,
-      safeMetadata: {},
-    },
-  ];
-
   test("offers one option per advertised model of an eligible Connection", () => {
     const eligible = eligibleModelConnections({
       connections,
@@ -195,7 +106,7 @@ describe("shared model option building", () => {
     ]);
   });
 
-  test("round-trips a selection and names it for prose", () => {
+  test("round-trips a binding and names it for prose", () => {
     const model = {
       connectionId: "ollama-1",
       providerModelId: "llama-3:cloud",
@@ -206,13 +117,13 @@ describe("shared model option building", () => {
     expect(() => decodeModelSelection("not-json")).toThrow(
       "A Connection and model ID are required",
     );
-    expect(describeModelAssignment(model, connections)).toBe("Llama 3 — Work");
+    expect(describeModelBinding(model, connections)).toBe("Llama 3 — Work");
     expect(
-      describeModelAssignment(
+      describeModelBinding(
         { connectionId: "ollama-1", providerModelId: "custom:cloud" },
         connections,
       ),
     ).toBe("custom:cloud — Work");
-    expect(describeModelAssignment(undefined, connections)).toBeUndefined();
+    expect(describeModelBinding(undefined, connections)).toBeUndefined();
   });
 });

package/src/client/bot-settings.ts

@@ -1,6 +1,6 @@
 import type {
   ConnectionView,
-  ModelAssignment,
+  ModelBindingV1,
   PackageInstallationView,
 } from "@frockbot/configuration-core";
 import type { PluginCatalogItem } from "@frockbot/plugin-shell/shared";
@@ -31,43 +31,6 @@ export function isModelConnectionEligible(input: {
   );
 }
 
-export function resolveBotSettingsModel(input: {
-  current?: ModelAssignment;
-  useExactModel: boolean;
-  selectedModel: string;
-  exactConnectionId: string;
-  exactProviderModelId: string;
-}): ModelAssignment | undefined {
-  if (input.useExactModel) {
-    const selected = {
-      connectionId: input.exactConnectionId,
-      providerModelId: input.exactProviderModelId.trim(),
-    };
-    if (!selected.connectionId || !selected.providerModelId) {
-      throw new Error("A Connection and model ID are required");
-    }
-    return selected;
-  }
-  if (!input.selectedModel) return input.current;
-  let value: unknown;
-  try {
-    value = JSON.parse(input.selectedModel);
-  } catch {
-    throw new Error("A Connection and model ID are required");
-  }
-  if (
-    !Array.isArray(value) ||
-    value.length !== 2 ||
-    typeof value[0] !== "string" ||
-    value[0].length === 0 ||
-    typeof value[1] !== "string" ||
-    value[1].length === 0
-  ) {
-    throw new Error("A Connection and model ID are required");
-  }
-  return { connectionId: value[0], providerModelId: value[1] };
-}
-
 export interface ModelSelectOption {
   value: string;
   label: string;
@@ -103,15 +66,15 @@ export function modelSelectOptions(
   );
 }
 
-export function encodeModelSelection(model?: ModelAssignment): string {
+export function encodeModelSelection(model?: ModelBindingV1): string {
   return model
     ? JSON.stringify([model.connectionId, model.providerModelId])
     : "";
 }
 
 /** How a bound model reads in prose, e.g. "Llama 3 — Work". */
-export function describeModelAssignment(
-  model: ModelAssignment | undefined,
+export function describeModelBinding(
+  model: ModelBindingV1 | undefined,
   connections: readonly ConnectionView[],
 ): string | undefined {
   if (!model) return undefined;
@@ -128,7 +91,7 @@ export function describeModelAssignment(
 /** The inverse of {@link encodeModelSelection}; an empty value means no model. */
 export function decodeModelSelection(
   value: string,
-): ModelAssignment | undefined {
+): ModelBindingV1 | undefined {
   if (!value) return undefined;
   let parsed: unknown;
   try {

package/src/client/index.test.ts

@@ -5,50 +5,10 @@ import {
   type ClientSlotRegistration,
 } from "@frockbot/client-core";
 import { createClientSurfaceRegistry } from "@frockbot/client-ui";
+import manifest from "../../frockbot.json";
 import { settingsClientPlugin } from "./index.js";
-import {
-  assignmentHasPendingOperation,
-  projectAssignmentOperations,
-} from "./assignment-operations.js";
 
 describe("settings client contribution", () => {
-  it("projects every Assignment operation without catalog ownership", () => {
-    const operations = [
-      {
-        commandId: "assign-1",
-        kind: "assigning" as const,
-        assignmentId: "orphan-assign",
-        state: "retrying" as const,
-        target: {
-          assignmentId: "orphan-assign",
-          packageId: "missing-package",
-          capabilityId: "missing-capability",
-        },
-      },
-      {
-        commandId: "replace-1",
-        kind: "replacing" as const,
-        assignmentId: "orphan-replace",
-        state: "pending" as const,
-      },
-      {
-        commandId: "unassign-1",
-        kind: "unassigning" as const,
-        assignmentId: "orphan-unassign",
-        state: "retrying" as const,
-      },
-    ];
-    const projected = projectAssignmentOperations({
-      assignmentOperations: operations,
-    });
-    expect(projected).toEqual(operations);
-    expect(projected).not.toBe(operations);
-    expect(assignmentHasPendingOperation(projected, "orphan-unassign")).toBe(
-      true,
-    );
-    expect(assignmentHasPendingOperation(projected, "stable")).toBe(false);
-  });
-
   it("registers feature surfaces and shell-owned trigger seats", () => {
     const surfaces = createClientSurfaceRegistry();
     const slots: ClientSlotRegistration[] = [];
@@ -95,6 +55,12 @@ describe("settings client contribution", () => {
     ]) {
       expect(surfaces.has(id)).toBe(true);
     }
+    surfaces.open("connections");
+    expect(surfaces.active.value?.title).toBe("Connectors");
+    surfaces.close();
+    expect(manifest.contributions.client.outlets).toContain(
+      "frockbot.models-sections",
+    );
 
     for (const dispose of result.toReversed()) dispose();
     expect(slots).toEqual([]);

package/src/client/index.ts

@@ -7,11 +7,11 @@ import {
 import BotPanel from "./BotPanel.vue";
 import BotSettingsSurface from "./BotSettingsSurface.vue";
 import BotSettingsTrigger from "./BotSettingsTrigger.vue";
+import ConnectorsTrigger from "./ConnectorsTrigger.vue";
 import ConnectionsSurface from "./ConnectionsSurface.vue";
 import ModelsSurface from "./ModelsSurface.vue";
 import PluginsSurface from "./PluginsSurface.vue";
 import PackageCatalogSurface from "./PackageCatalogSurface.vue";
-import PluginsTrigger from "./PluginsTrigger.vue";
 import UserProfileTrigger from "./UserProfileTrigger.vue";
 import UserSettingsSurface from "./UserSettingsSurface.vue";
 
@@ -25,8 +25,8 @@ export const settingsClientPlugin: ClientPlugin = (ctx) => {
       placement: "panel",
     }),
     // Enablement and configuration are separate surfaces: Plugins turns a
-    // Package on and off, Models configures model providers and picks the
-    // model, and Connections authorizes the accounts a Bot may be given.
+    // Package on and off, Models hosts opt-in model configuration, and
+    // Connectors authorizes Connections for every Bot the User owns.
     surfaces.register({
       id: "plugins",
       title: "Plugins",
@@ -39,7 +39,7 @@ export const settingsClientPlugin: ClientPlugin = (ctx) => {
     }),
     surfaces.register({
       id: "connections",
-      title: "Connections",
+      title: "Connectors",
       component: ConnectionsSurface,
     }),
     surfaces.register({
@@ -55,7 +55,7 @@ export const settingsClientPlugin: ClientPlugin = (ctx) => {
     ctx.slot({
       slot: "frockbot.sidebar-actions",
       order: 10,
-      component: PluginsTrigger,
+      component: ConnectorsTrigger,
     }),
     ctx.slot({
       slot: "frockbot.user-profile",
@@ -75,4 +75,14 @@ export const settingsClientPlugin: ClientPlugin = (ctx) => {
   ];
 };
 
+export {
+  decodeModelSelection,
+  describeModelBinding,
+  eligibleModelConnections,
+  encodeModelSelection,
+  isModelConnectionEligible,
+  modelSelectOptions,
+  type ModelSelectOption,
+} from "./bot-settings.js";
+
 export default settingsClientPlugin;

package/src/client/package-surfaces.test.ts

@@ -72,12 +72,33 @@ const settingsOnly = catalogItem({
   ] as PluginCatalogItem["settings"],
 });
 
+const customModels = catalogItem({
+  packageId: "custom-models",
+  settings: [
+    {
+      id: "model",
+      schemaVersion: 1,
+      scopes: ["user", "bot"],
+      role: "model",
+      schema: {
+        type: "object",
+        properties: {
+          connectionId: { type: "string" },
+          providerModelId: { type: "string" },
+        },
+        required: ["connectionId", "providerModelId"],
+        additionalProperties: false,
+      },
+    },
+  ],
+});
+
 const plain = catalogItem({
   packageId: "web",
   capabilities: [{ id: "web-tools", kind: "tool", connectionTypes: [] }],
 });
 
-const catalog = [provider, connector, settingsOnly, plain];
+const catalog = [provider, connector, settingsOnly, customModels, plain];
 
 function installation(
   packageId: string,
@@ -91,6 +112,7 @@ describe("Package configuration homes", () => {
     expect(packageConfigurationHome(provider)).toBe("models");
     expect(packageConfigurationHome(connector)).toBe("connections");
     expect(packageConfigurationHome(settingsOnly)).toBe("user-settings");
+    expect(packageConfigurationHome(customModels)).toBe("models");
     // Nothing declared is nothing to configure: the Package appears in Plugins
     // to be enabled and disabled, and on no configuration surface at all.
     expect(packageConfigurationHome(plain)).toBe("none");
@@ -103,11 +125,15 @@ describe("Package configuration homes", () => {
       ["provider-ollama-cloud", "models"],
       ["composio", "connections"],
       ["image", "user-settings"],
+      ["custom-models", "models"],
     ]);
   });
 
   test("a model provider that declares Connections is Models', not Connections'", () => {
-    expect(packagesForHome(catalog, "models")).toEqual([provider]);
+    expect(packagesForHome(catalog, "models")).toEqual([
+      provider,
+      customModels,
+    ]);
     expect(packagesForHome(catalog, "connections")).toEqual([connector]);
     expect(packagesForHome(catalog, "user-settings")).toEqual([settingsOnly]);
   });
@@ -138,7 +164,7 @@ describe("Package configuration homes", () => {
 
   test("names the surface a Plugins row points at", () => {
     expect(configurationHomeLabel("models")).toBe("Models");
-    expect(configurationHomeLabel("connections")).toBe("Connections");
+    expect(configurationHomeLabel("connections")).toBe("Connectors");
     expect(configurationHomeLabel("user-settings")).toBe(
       "Application settings",
     );

package/src/client/package-surfaces.ts

@@ -26,9 +26,18 @@ export function declaresConnections(item: PluginCatalogItem): boolean {
 export function packageConfigurationHome(
   item: PluginCatalogItem,
 ): PackageConfigurationHome {
-  if (isModelProviderPackage(item)) return "models";
+  if (
+    isModelProviderPackage(item) ||
+    item.settings?.some((setting) => setting.role === "model")
+  )
+    return "models";
   if (declaresConnections(item)) return "connections";
-  if ((item.settings ?? []).length > 0) return "user-settings";
+  if (
+    item.settings?.some(
+      (setting) => setting.role !== "model" && setting.scopes.includes("user"),
+    )
+  )
+    return "user-settings";
   return "none";
 }
 
@@ -87,7 +96,7 @@ export function configurationHomeLabel(
   home: PackageConfigurationHome,
 ): string | undefined {
   if (home === "models") return "Models";
-  if (home === "connections") return "Connections";
+  if (home === "connections") return "Connectors";
   if (home === "user-settings") return "Application settings";
   return undefined;
 }