@frockbot/plugin-custom-models 0.0.0 → 0.3.12

package/src/model-resolution.test.ts

@@ -0,0 +1,151 @@
+import { describe, expect, test } from "bun:test";
+import {
+  resolveEffectiveBotModelV1,
+  type BotSettingsViewV1,
+  type ExecutionPackageDefinition,
+  type ModelBindingV1,
+  type UserSettingsViewV1,
+} from "@frockbot/configuration-core";
+import { decodeFrockBotManifest } from "@frockbot/kernel-composition";
+import rawManifest from "../frockbot.json" with { type: "json" };
+
+const platformModel: ModelBindingV1 = {
+  connectionId: "flock-ai",
+  providerModelId: "@frock/auto",
+};
+const accountModel: ModelBindingV1 = {
+  connectionId: "flock-ai",
+  providerModelId: "@frock/manual",
+};
+const botModel: ModelBindingV1 = {
+  connectionId: "flock-ai",
+  providerModelId: "@frock/bot",
+};
+
+const customManifest = decodeFrockBotManifest(rawManifest);
+const packages: ExecutionPackageDefinition[] = [
+  {
+    packageId: "provider-flock-ai",
+    version: "0.0.1",
+    settings: [],
+    capabilities: [
+      {
+        id: "flock-ai-models",
+        kind: "model",
+        connectionTypes: ["flock-ai-account"],
+      },
+    ],
+    connectionTypes: [
+      { id: "flock-ai-account", capabilities: ["flock-ai-models"] },
+    ],
+  },
+  {
+    packageId: customManifest.id,
+    version: customManifest.version,
+    settings: customManifest.configuration?.settings ?? [],
+    capabilities: [],
+    connectionTypes: [],
+  },
+];
+
+function user(state: "disabled" | "installed"): UserSettingsViewV1 {
+  return {
+    schemaVersion: 1,
+    revision: 1,
+    profile: { name: "User" },
+    packages: [
+      {
+        packageId: "provider-flock-ai",
+        version: "0.0.1",
+        state: "installed",
+      },
+      {
+        packageId: "custom-models",
+        version: "0.0.1",
+        state,
+        values: { "account-model": accountModel },
+      },
+    ],
+    connections: [
+      {
+        connectionId: "flock-ai",
+        packageId: "provider-flock-ai",
+        connectionTypeId: "flock-ai-account",
+        displayName: "Frock AI",
+        state: "ready",
+        providerType: "flock-ai",
+        modelCatalog: {
+          schemaVersion: 1,
+          generation: "catalog-1",
+          state: "fresh",
+          models: [platformModel, accountModel, botModel].map((model) => ({
+            providerModelId: model.providerModelId,
+            displayName: model.providerModelId,
+            capabilities: { tools: true, vision: false, reasoning: true },
+            source: "discovered" as const,
+          })),
+        },
+        safeMetadata: {},
+      },
+    ],
+    platformModel,
+  };
+}
+
+function bot(): BotSettingsViewV1 {
+  return {
+    schemaVersion: 1,
+    botId: "scout",
+    revision: 1,
+    profile: { name: "Scout" },
+    notifications: { enabled: true },
+    packageValues: { "custom-models": { model: botModel } },
+  };
+}
+
+describe("Custom models resolution", () => {
+  test("ignores preserved Custom models values while disabled and restores Bot-over-account precedence when re-enabled", () => {
+    const disabledUser = user("disabled");
+    const configuredBot = bot();
+    const storedAccountValues = structuredClone(
+      disabledUser.packages[1]?.values,
+    );
+    const storedBotValues = structuredClone(configuredBot.packageValues);
+
+    expect(
+      resolveEffectiveBotModelV1({
+        bot: configuredBot,
+        user: disabledUser,
+        packages,
+      }),
+    ).toMatchObject({ source: "platform", model: platformModel });
+    expect(disabledUser.packages[1]?.values).toEqual(storedAccountValues);
+    expect(configuredBot.packageValues).toEqual(storedBotValues);
+
+    const enabledUser = user("installed");
+    expect(
+      resolveEffectiveBotModelV1({
+        bot: configuredBot,
+        user: enabledUser,
+        packages,
+      }),
+    ).toMatchObject({ source: "bot", model: botModel });
+    expect(
+      resolveEffectiveBotModelV1({
+        bot: { packageValues: {} },
+        user: enabledUser,
+        packages,
+      }),
+    ).toMatchObject({ source: "account", model: accountModel });
+
+    const withoutAccount = user("installed");
+    delete withoutAccount.packages[1]?.values;
+    expect(
+      resolveEffectiveBotModelV1({
+        bot: { packageValues: {} },
+        user: withoutAccount,
+        packages,
+      }),
+    ).toMatchObject({ source: "platform", model: platformModel });
+  });
+});

package/src/model-settings.ts

@@ -0,0 +1,19 @@
+import {
+  decodeModelBindingV1,
+  type ModelBindingV1,
+} from "@frockbot/configuration-core";
+
+export const ACCOUNT_MODEL_SETTING_ID_V1 = "account-model";
+export const BOT_MODEL_SETTING_ID_V1 = "model";
+
+/** A model-role value has already crossed a decoded settings seam; be defensive when reading an absent or stale value. */
+export function storedModelBindingV1(
+  value: unknown,
+): ModelBindingV1 | undefined {
+  if (value === undefined) return undefined;
+  try {
+    return decodeModelBindingV1(value);
+  } catch {
+    return undefined;
+  }
+}

package/tsconfig.json

@@ -0,0 +1,15 @@
+{
+  "compilerOptions": {
+    "target": "ES2023",
+    "module": "ESNext",
+    "moduleResolution": "Bundler",
+    "allowImportingTsExtensions": true,
+    "resolveJsonModule": true,
+    "strict": true,
+    "noEmit": true,
+    "skipLibCheck": true,
+    "lib": ["ES2023", "DOM", "DOM.Iterable"],
+    "types": ["bun", "vite/client"]
+  },
+  "include": ["src/**/*.ts", "src/**/*.vue"]
+}

package/vite.config.ts

@@ -0,0 +1,32 @@
+import { fileURLToPath } from "node:url";
+import vue from "@vitejs/plugin-vue";
+import { defineConfig } from "vite";
+
+export default defineConfig({
+  plugins: [vue()],
+  build: {
+    outDir: fileURLToPath(new URL("./dist", import.meta.url)),
+    emptyOutDir: true,
+    manifest: "manifest.json",
+    cssCodeSplit: false,
+    assetsInlineLimit: Number.POSITIVE_INFINITY,
+    lib: {
+      entry: fileURLToPath(new URL("./src/client/index.ts", import.meta.url)),
+      formats: ["es"],
+    },
+    rollupOptions: {
+      external: [
+        "vue",
+        "@frockbot/client-core",
+        "@frockbot/client-ui",
+        "@frockbot/plugin-shell/shared",
+        "@frockbot/plugin-settings/client",
+      ],
+      output: {
+        entryFileNames: "assets/custom-models-[hash].js",
+        chunkFileNames: "assets/chunk-[hash].js",
+        assetFileNames: "assets/[name]-[hash][extname]",
+      },
+    },
+  },
+});

package/README.md

@@ -1,3 +0,0 @@
-# @frockbot/plugin-custom-models
-
-Placeholder reserving this name. See https://github.com/timoconnellaus/frockbot.