@jskit-ai/assistant 0.1.38 → 0.1.39

package/test/buildTemplateContext.test.js

@@ -22,7 +22,8 @@ async function withTempApp(run) {
     app: { id: "app", enabled: true, requiresWorkspace: false, accessPolicyId: "authenticated" },
     admin: { id: "admin", enabled: true, requiresWorkspace: true, accessPolicyId: "workspace_member" },
     console: { id: "console", enabled: true, requiresWorkspace: false, accessPolicyId: "console_owner" }
-  }
+  },
+  assistantSurfaces: {}
 };
 `,
       "utf8"
@@ -45,12 +46,12 @@ async function withTempApp(run) {
   }
 }
 
-test("buildTemplateContext derives runtime, settings, and table placeholders from explicit surfaces", async () => {
+test("buildTemplateContext derives per-surface placeholders from explicit surfaces", async () => {
   await withTempApp(async (appRoot) => {
     const context = await buildTemplateContext({
       appRoot,
       options: {
-        "runtime-surface": "app",
+        surface: "app",
         "settings-surface": "console",
         "config-scope": "global",
         placement: "shell-layout:primary-menu",
@@ -58,55 +59,69 @@ test("buildTemplateContext derives runtime, settings, and table placeholders fro
       }
     });
 
-    assert.equal(context.__ASSISTANT_RUNTIME_SURFACE_ID__, "app");
+    assert.equal(context.__ASSISTANT_SURFACE_ID__, "app");
     assert.equal(context.__ASSISTANT_SETTINGS_SURFACE_ID__, "console");
-    assert.equal(context.__ASSISTANT_RUNTIME_SURFACE_REQUIRES_WORKSPACE__, "false");
-    assert.equal(context.__ASSISTANT_SETTINGS_SURFACE_REQUIRES_WORKSPACE__, "false");
-    assert.equal(context.__ASSISTANT_SETTINGS_SURFACE_REQUIRES_CONSOLE_OWNER__, "true");
     assert.equal(context.__ASSISTANT_CONFIG_SCOPE__, "global");
     assert.equal(context.__ASSISTANT_SETTINGS_HOST__, "console-settings");
-    assert.equal(context.__ASSISTANT_CONVERSATIONS_TABLE__, "assistant_app_conversations");
-    assert.equal(context.__ASSISTANT_MESSAGES_TABLE__, "assistant_app_messages");
+    assert.equal(context.__ASSISTANT_AI_CONFIG_PREFIX__, "APP_ASSISTANT");
     assert.equal(context.__ASSISTANT_MENU_PLACEMENT_HOST__, "shell-layout");
     assert.equal(context.__ASSISTANT_MENU_PLACEMENT_POSITION__, "primary-menu");
     assert.equal(context.__ASSISTANT_MENU_LABEL__, "Copilot");
+    assert.equal(context.__ASSISTANT_SETTINGS_MENU_WORKSPACE_SUFFIX__, "/settings/assistant");
+    assert.equal(context.__ASSISTANT_SETTINGS_MENU_NON_WORKSPACE_SUFFIX__, "/settings/assistant");
   });
 });
 
-test("buildTemplateContext rejects workspace config scope for non-workspace surfaces", async () => {
+test("buildTemplateContext rejects workspace config scope for a non-workspace assistant surface", async () => {
   await withTempApp(async (appRoot) => {
     await assert.rejects(
       () =>
         buildTemplateContext({
           appRoot,
           options: {
-            "runtime-surface": "app",
+            surface: "app",
             "settings-surface": "console",
             "config-scope": "workspace",
             placement: "shell-layout:primary-menu"
           }
         }),
-      /config-scope "workspace" requires runtime surface "app" with requiresWorkspace=true/
+      /config-scope "workspace" requires surface "app" with requiresWorkspace=true/
     );
   });
 });
 
-test("buildTemplateContext accepts workspace config scope when both surfaces require workspace", async () => {
+test("buildTemplateContext rejects duplicate assistant surfaces already configured in public config", async () => {
   await withTempApp(async (appRoot) => {
-    const context = await buildTemplateContext({
-      appRoot,
-      options: {
-        "runtime-surface": "admin",
-        "settings-surface": "admin",
-        "config-scope": "workspace",
-        placement: "shell-layout:top-right"
-      }
-    });
+    await writeFile(
+      path.join(appRoot, "config", "public.js"),
+      `export const config = {
+  surfaceDefinitions: {
+    app: { id: "app", enabled: true, requiresWorkspace: false, accessPolicyId: "authenticated" },
+    console: { id: "console", enabled: true, requiresWorkspace: false, accessPolicyId: "console_owner" }
+  },
+  assistantSurfaces: {
+    app: {
+      settingsSurfaceId: "console",
+      configScope: "global"
+    }
+  }
+};
+`,
+      "utf8"
+    );
 
-    assert.equal(context.__ASSISTANT_RUNTIME_SURFACE_REQUIRES_WORKSPACE__, "true");
-    assert.equal(context.__ASSISTANT_SETTINGS_SURFACE_REQUIRES_WORKSPACE__, "true");
-    assert.equal(context.__ASSISTANT_SETTINGS_HOST__, "admin-settings");
-    assert.equal(context.__ASSISTANT_CONVERSATIONS_TABLE__, "assistant_admin_conversations");
-    assert.equal(context.__ASSISTANT_MESSAGES_TABLE__, "assistant_admin_messages");
+    await assert.rejects(
+      () =>
+        buildTemplateContext({
+          appRoot,
+          options: {
+            surface: "app",
+            "settings-surface": "console",
+            "config-scope": "global",
+            placement: "shell-layout:primary-menu"
+          }
+        }),
+      /already has an assistant configured/
+    );
   });
 });

package/test/packageDescriptor.test.js

@@ -1,6 +1,4 @@
 import assert from "node:assert/strict";
-import { readFile } from "node:fs/promises";
-import path from "node:path";
 import test from "node:test";
 import descriptor from "../package.descriptor.mjs";
 
@@ -14,69 +12,42 @@ function findTextMutation(id) {
   return mutations.find((entry) => String(entry?.id || "") === id) || null;
 }
 
-test("assistant descriptor exposes generator options for runtime surface, settings surface, and config scope", () => {
+test("assistant descriptor exposes per-surface generation options and depends on assistant-runtime", () => {
   assert.equal(descriptor.kind, "generator");
-  assert.equal(descriptor.metadata?.generatorPrimarySubcommand, "install");
-  assert.equal(descriptor.options?.["runtime-surface"]?.required, true);
+  assert.equal(descriptor.options?.surface?.required, true);
   assert.equal(descriptor.options?.["settings-surface"]?.required, true);
   assert.equal(descriptor.options?.["config-scope"]?.defaultValue, "global");
+  assert.equal(descriptor.options?.["ai-config-prefix"]?.required, false);
+  assert.deepEqual(descriptor.dependsOn, ["@jskit-ai/assistant-runtime"]);
 });
 
-test("assistant descriptor publishes install examples for the supported runtime/settings shapes", () => {
-  const installMetadata = descriptor.metadata?.generatorSubcommands?.install || {};
-  const examples = Array.isArray(installMetadata.examples) ? installMetadata.examples : [];
-  const labels = examples.map((entry) => String(entry?.label || ""));
-
-  assert.equal(examples.length, 4);
-  assert.deepEqual(labels, [
-    "App runtime, console settings, global config",
-    "App runtime, app settings, global config",
-    "Workspace runtime, console settings, global config",
-    "Workspace runtime, workspace settings, workspace config"
-  ]);
-});
-
-test("assistant descriptor installs generated local runtime files instead of shipping a framework runtime", () => {
+test("assistant descriptor generates only assistant runtime/settings pages and no local runtime package", () => {
   const runtimePage = findFileMutation("assistant-page-runtime");
-  const localPackageDescriptor = findFileMutation("assistant-local-package-descriptor");
-  const configMigration = findFileMutation("assistant-config-initial-schema");
-  const transcriptMigration = findFileMutation("assistant-transcripts-initial-schema");
+  const settingsPageStandard = findFileMutation("assistant-page-settings-standard");
+  const settingsPageAdmin = findFileMutation("assistant-page-settings-admin");
+  const fileMutations = Array.isArray(descriptor?.mutations?.files) ? descriptor.mutations.files : [];
 
-  assert.equal(runtimePage?.toSurface, "${option:runtime-surface|lower}");
+  assert.equal(runtimePage?.toSurface, "${option:surface|lower}");
   assert.equal(runtimePage?.toSurfacePath, "assistant/index.vue");
-  assert.equal(localPackageDescriptor?.to, "packages/assistant/package.descriptor.mjs");
-  assert.equal(configMigration?.from, "templates/migrations/assistant_config_initial.cjs");
-  assert.equal(transcriptMigration?.from, "templates/migrations/assistant_transcripts_initial.cjs");
+  assert.equal(settingsPageStandard?.toSurfacePath, "settings/${option:settings-route-path|path}/index.vue");
+  assert.equal(settingsPageAdmin?.toSurfacePath, "workspace/settings/${option:settings-route-path|path}/index.vue");
+  assert.equal(fileMutations.length, 3);
 });
 
-test("assistant descriptor targets runtime and settings placements through explicit surface options", () => {
+test("assistant descriptor appends menu placement, settings menu placement, and per-surface config entries", () => {
   const menuPlacement = findTextMutation("assistant-placement-menu");
-  const settingsPlacement = findTextMutation("assistant-settings-form-placement");
-
-  assert.match(String(menuPlacement?.value || ""), /surfaces: \["\$\{option:runtime-surface\|lower\}"\]/);
-  assert.match(String(menuPlacement?.value || ""), /workspaceSuffix: "__ASSISTANT_MENU_WORKSPACE_SUFFIX__"/);
-  assert.match(String(menuPlacement?.value || ""), /nonWorkspaceSuffix: "__ASSISTANT_MENU_NON_WORKSPACE_SUFFIX__"/);
+  const settingsPlacement = findTextMutation("assistant-settings-menu-placement");
+  const publicConfig = findTextMutation("assistant-public-surface-config");
+  const serverConfig = findTextMutation("assistant-server-surface-config");
+  const envBlock = findTextMutation("assistant-ai-prefixed-env");
+
+  assert.match(String(menuPlacement?.value || ""), /assistant\.generated\.menu:\$\{option:surface\|lower\}/);
+  assert.match(String(menuPlacement?.value || ""), /surfaces: \["\$\{option:surface\|lower\}"\]/);
+  assert.match(String(settingsPlacement?.value || ""), /assistant\.generated\.settings\.menu:\$\{option:surface\|lower\}/);
   assert.match(String(settingsPlacement?.value || ""), /host: "__ASSISTANT_SETTINGS_HOST__"/);
-  assert.match(String(settingsPlacement?.value || ""), /surfaces: \["\$\{option:settings-surface\|lower\}"\]/);
-  assert.match(String(settingsPlacement?.value || ""), /componentToken: "assistant.web.settings.element"/);
-});
-
-test("assistant descriptor runtime deps use assistant-core and avoid workspace package coupling", () => {
-  const runtimeDeps = descriptor?.mutations?.dependencies?.runtime || {};
-  const assistantCorePackageJsonPath = path.resolve(
-    path.dirname(new URL(import.meta.url).pathname),
-    "..",
-    "..",
-    "assistant-core",
-    "package.json"
-  );
-
-  return readFile(assistantCorePackageJsonPath, "utf8").then((source) => {
-    const assistantCorePackageJson = JSON.parse(source);
-
-    assert.equal(runtimeDeps["@local/assistant"], "file:packages/assistant");
-    assert.equal(runtimeDeps["@jskit-ai/assistant-core"], assistantCorePackageJson.version);
-    assert.equal(Object.hasOwn(runtimeDeps, "@jskit-ai/workspaces-core"), false);
-    assert.equal(Object.hasOwn(runtimeDeps, "@jskit-ai/workspaces-web"), false);
-  });
+  assert.match(String(settingsPlacement?.value || ""), /position: "primary-menu"/);
+  assert.match(String(publicConfig?.value || ""), /config\.assistantSurfaces\.\$\{option:surface\|lower\} = \{/);
+  assert.match(String(serverConfig?.value || ""), /config\.assistantServer\.\$\{option:surface\|lower\} = \{/);
+  assert.match(String(serverConfig?.value || ""), /aiConfigPrefix: "__ASSISTANT_AI_CONFIG_PREFIX__"/);
+  assert.match(String(envBlock?.value || ""), /__ASSISTANT_AI_CONFIG_PREFIX___AI_PROVIDER=\$\{option:ai-provider\}/);
 });

package/test/templateContracts.test.js

@@ -9,14 +9,16 @@ async function readTemplateFile(relativePath) {
   return readFile(path.join(packageRoot, relativePath), "utf8");
 }
 
-test("generated assistant client index exports the descriptor-declared client provider", async () => {
-  const source = await readTemplateFile("templates/src/local-package/client/index.js");
+test("assistant page template renders the shared runtime client element with an explicit surface id", async () => {
+  const source = await readTemplateFile("templates/src/pages/assistant/index.vue");
 
-  assert.match(source, /export \{ AssistantClientProvider \} from "\.\/providers\/AssistantClientProvider\.js";/);
+  assert.match(source, /<AssistantSurfaceClientElement surface-id="__ASSISTANT_SURFACE_ID__" \/>/);
+  assert.match(source, /from "@jskit-ai\/assistant-runtime\/client"/);
 });
 
-test("generated assistant actions do not emit legacy action visibility fields", async () => {
-  const source = await readTemplateFile("templates/src/local-package/server/actions.js");
+test("assistant settings page template renders the shared runtime settings client element with the target surface id", async () => {
+  const source = await readTemplateFile("templates/src/pages/settings/assistant/index.vue");
 
-  assert.doesNotMatch(source, /\bvisibility:/);
+  assert.match(source, /<AssistantSettingsClientElement target-surface-id="__ASSISTANT_SURFACE_ID__" \/>/);
+  assert.match(source, /from "@jskit-ai\/assistant-runtime\/client"/);
 });

package/templates/migrations/assistant_config_initial.cjs

@@ -1,25 +0,0 @@
-exports.up = async function up(knex) {
-  const hasTable = await knex.schema.hasTable("__ASSISTANT_CONFIG_TABLE__");
-  if (!hasTable) {
-    await knex.schema.createTable("__ASSISTANT_CONFIG_TABLE__", (table) => {
-      table.increments("id").unsigned().primary();
-      table.string("target_surface_id", 64).notNullable();
-      table.string("scope_key", 160).notNullable();
-      table.integer("workspace_id").unsigned().nullable();
-      if ("__ASSISTANT_CONFIG_SCOPE__" === "workspace") {
-        table.foreign("workspace_id").references("id").inTable("workspaces").onDelete("CASCADE");
-      }
-      table.text("system_prompt").notNullable().defaultTo("");
-      table.timestamp("created_at").notNullable().defaultTo(knex.fn.now());
-      table.timestamp("updated_at").notNullable().defaultTo(knex.fn.now());
-
-      table.unique(["target_surface_id", "scope_key"], "uq___ASSISTANT_CONFIG_TABLE___target_surface_scope");
-      table.index(["target_surface_id"], "idx___ASSISTANT_CONFIG_TABLE___target_surface");
-      table.index(["workspace_id"], "idx___ASSISTANT_CONFIG_TABLE___workspace");
-    });
-  }
-};
-
-exports.down = async function down(knex) {
-  await knex.schema.dropTableIfExists("__ASSISTANT_CONFIG_TABLE__");
-};

package/templates/migrations/assistant_transcripts_initial.cjs

@@ -1,56 +0,0 @@
-exports.up = async function up(knex) {
-  const hasConversationsTable = await knex.schema.hasTable("__ASSISTANT_CONVERSATIONS_TABLE__");
-  if (!hasConversationsTable) {
-    await knex.schema.createTable("__ASSISTANT_CONVERSATIONS_TABLE__", (table) => {
-      table.increments("id").unsigned().primary();
-      table.integer("workspace_id").unsigned().nullable();
-      if (__ASSISTANT_RUNTIME_SURFACE_REQUIRES_WORKSPACE__) {
-        table.foreign("workspace_id").references("id").inTable("workspaces").onDelete("CASCADE");
-      }
-      table.integer("created_by_user_id").unsigned().nullable().references("id").inTable("users").onDelete("SET NULL").index();
-      table.string("title", 160).notNullable().defaultTo("New conversation");
-      table.string("status", 32).notNullable().defaultTo("active");
-      table.string("provider", 64).notNullable().defaultTo("");
-      table.string("model", 128).notNullable().defaultTo("");
-      table.string("surface_id", 32).notNullable().defaultTo("__ASSISTANT_RUNTIME_SURFACE_ID__");
-      table.integer("message_count").unsigned().notNullable().defaultTo(0);
-      table.text("metadata_json").nullable();
-      table.timestamp("started_at").notNullable().defaultTo(knex.fn.now());
-      table.timestamp("ended_at").nullable();
-      table.timestamp("created_at").notNullable().defaultTo(knex.fn.now());
-      table.timestamp("updated_at").notNullable().defaultTo(knex.fn.now());
-
-      table.index(["workspace_id", "started_at"], "idx___ASSISTANT_CONVERSATIONS_TABLE___workspace_started_at");
-      table.index(["created_by_user_id", "started_at"], "idx___ASSISTANT_CONVERSATIONS_TABLE___creator_started_at");
-    });
-  }
-
-  const hasMessagesTable = await knex.schema.hasTable("__ASSISTANT_MESSAGES_TABLE__");
-  if (!hasMessagesTable) {
-    await knex.schema.createTable("__ASSISTANT_MESSAGES_TABLE__", (table) => {
-      table.increments("id").unsigned().primary();
-      table.integer("conversation_id").unsigned().notNullable().references("id").inTable("__ASSISTANT_CONVERSATIONS_TABLE__").onDelete("CASCADE");
-      table.integer("workspace_id").unsigned().nullable();
-      if (__ASSISTANT_RUNTIME_SURFACE_REQUIRES_WORKSPACE__) {
-        table.foreign("workspace_id").references("id").inTable("workspaces").onDelete("CASCADE");
-      }
-      table.integer("seq").unsigned().notNullable();
-      table.string("role", 32).notNullable();
-      table.string("kind", 32).notNullable().defaultTo("chat");
-      table.string("client_message_sid", 128).notNullable().defaultTo("");
-      table.integer("actor_user_id").unsigned().nullable().references("id").inTable("users").onDelete("SET NULL").index();
-      table.text("content_text").nullable();
-      table.text("metadata_json").nullable();
-      table.timestamp("created_at").notNullable().defaultTo(knex.fn.now());
-
-      table.unique(["conversation_id", "seq"], "uq___ASSISTANT_MESSAGES_TABLE___conversation_seq");
-      table.index(["conversation_id", "created_at"], "idx___ASSISTANT_MESSAGES_TABLE___conversation_created_at");
-      table.index(["workspace_id"], "idx___ASSISTANT_MESSAGES_TABLE___workspace");
-    });
-  }
-};
-
-exports.down = async function down(knex) {
-  await knex.schema.dropTableIfExists("__ASSISTANT_MESSAGES_TABLE__");
-  await knex.schema.dropTableIfExists("__ASSISTANT_CONVERSATIONS_TABLE__");
-};

package/templates/src/local-package/client/components/AssistantSettingsClientElement.vue

@@ -1,88 +0,0 @@
-<template>
-  <AssistantSettingsFormCard
-    root-class="assistant-settings-client-element"
-    title="Assistant settings"
-    :subtitle="subtitle"
-    no-permission-message="You do not have permission to view assistant settings."
-    save-label="Save assistant settings"
-    :add-edit="addEdit"
-    :show-form-skeleton="showFormSkeleton"
-  >
-    <v-textarea
-      v-model="form.systemPrompt"
-      label="System prompt"
-      variant="outlined"
-      density="comfortable"
-      rows="8"
-      auto-grow
-      :readonly="!addEdit.canSave || addEdit.isSaving || addEdit.isRefetching"
-      :error-messages="addEdit.fieldErrors.systemPrompt ? [addEdit.fieldErrors.systemPrompt] : []"
-    />
-  </AssistantSettingsFormCard>
-</template>
-
-<script setup>
-import { computed, reactive } from "vue";
-import { validateOperationSection } from "@jskit-ai/http-runtime/shared/validators/operationValidation";
-import { AssistantSettingsFormCard } from "@jskit-ai/assistant-core/client";
-import {
-  assistantConfigResource,
-  assistantSettingsQueryKey
-} from "@jskit-ai/assistant-core/shared";
-import { useAddEdit } from "@jskit-ai/users-web/client/composables/useAddEdit";
-import { assistantRuntimeConfig } from "../../shared/assistantRuntimeConfig.js";
-
-const form = reactive({
-  systemPrompt: ""
-});
-
-const subtitle = computed(() => {
-  if (assistantRuntimeConfig.configScope === "workspace") {
-    return `Configure the prompt used on the ${assistantRuntimeConfig.runtimeSurfaceId} surface for this workspace.`;
-  }
-
-  return `Configure the prompt used on the ${assistantRuntimeConfig.runtimeSurfaceId} surface.`;
-});
-
-const addEdit = useAddEdit({
-  ownershipFilter: assistantRuntimeConfig.settingsSurfaceRequiresWorkspace ? "workspace" : "public",
-  surfaceId: assistantRuntimeConfig.settingsSurfaceId,
-  access: "auto",
-  resource: assistantConfigResource,
-  apiSuffix: "/assistant/settings",
-  queryKeyFactory: (_surfaceId = "", workspaceSlug = "") =>
-    assistantSettingsQueryKey({
-      targetSurfaceId: assistantRuntimeConfig.runtimeSurfaceId,
-      workspaceSlug
-    }),
-  viewPermissions: assistantRuntimeConfig.settingsSurfaceRequiresWorkspace
-    ? ["workspace.settings.view", "workspace.settings.update"]
-    : [],
-  savePermissions: assistantRuntimeConfig.settingsSurfaceRequiresWorkspace
-    ? ["workspace.settings.update"]
-    : [],
-  writeMethod: "PATCH",
-  placementSource: "assistant.settings-view",
-  fallbackLoadError: "Unable to load assistant settings.",
-  fallbackSaveError: "Unable to update assistant settings.",
-  fieldErrorKeys: ["systemPrompt"],
-  model: form,
-  parseInput: (rawPayload) =>
-    validateOperationSection({
-      operation: assistantConfigResource.operations.patch,
-      section: "bodyValidator",
-      value: rawPayload
-    }),
-  mapLoadedToModel(model, payload = {}) {
-    const settings = payload?.settings && typeof payload.settings === "object" ? payload.settings : {};
-    model.systemPrompt = String(settings.systemPrompt || "");
-  },
-  buildRawPayload(model) {
-    return {
-      systemPrompt: model.systemPrompt
-    };
-  }
-});
-
-const showFormSkeleton = computed(() => Boolean(addEdit.isInitialLoading));
-</script>

package/templates/src/local-package/client/components/AssistantSurfaceClientElement.vue

@@ -1,10 +0,0 @@
-<template>
-  <AssistantClientElement v-bind="runtime" />
-</template>
-
-<script setup>
-import { AssistantClientElement } from "@jskit-ai/assistant-core/client";
-import { useAssistantRuntime } from "../composables/useAssistantRuntime.js";
-
-const runtime = useAssistantRuntime();
-</script>