@jskit-ai/assistant 0.1.32 → 0.1.35

package/src/server/buildTemplateContext.js

@@ -0,0 +1,107 @@
+import path from "node:path";
+import { pathToFileURL } from "node:url";
+import {
+  loadAppConfigFromModuleUrl,
+  resolveShellOutletPlacementTargetFromApp
+} from "@jskit-ai/kernel/server/support";
+import { normalizeSurfaceId } from "@jskit-ai/kernel/shared/surface/registry";
+import { normalizeText } from "@jskit-ai/kernel/shared/support/normalize";
+import { toSnakeCase } from "@jskit-ai/kernel/shared/support/stringCase";
+
+const DEFAULT_MENU_COMPONENT_TOKEN = "users.web.shell.surface-aware-menu-link-item";
+
+function normalizeConfigScope(value = "") {
+  const normalized = normalizeText(value).toLowerCase();
+  if (normalized === "global" || normalized === "workspace") {
+    return normalized;
+  }
+
+  throw new Error('assistant generator option "config-scope" must be "global" or "workspace".');
+}
+
+async function loadAppConfig(appRoot = "") {
+  const publicConfigUrl = pathToFileURL(path.join(appRoot, "config", "public.js")).href;
+  return loadAppConfigFromModuleUrl({
+    moduleUrl: publicConfigUrl
+  });
+}
+
+function resolveSurfaceDefinition(appConfig = {}, surfaceId = "", optionName = "surface") {
+  const normalizedSurfaceId = normalizeSurfaceId(surfaceId);
+  if (!normalizedSurfaceId) {
+    throw new Error(`assistant generator requires --${optionName}.`);
+  }
+
+  const sourceDefinitions = appConfig && typeof appConfig.surfaceDefinitions === "object" && !Array.isArray(appConfig.surfaceDefinitions)
+    ? appConfig.surfaceDefinitions
+    : {};
+  const rawDefinition = sourceDefinitions[normalizedSurfaceId];
+  if (!rawDefinition || typeof rawDefinition !== "object" || Array.isArray(rawDefinition)) {
+    throw new Error(`assistant generator surface "${normalizedSurfaceId}" is not defined in config/public.js.`);
+  }
+  if (rawDefinition.enabled === false) {
+    throw new Error(`assistant generator surface "${normalizedSurfaceId}" is disabled in config/public.js.`);
+  }
+
+  return Object.freeze({
+    id: normalizedSurfaceId,
+    requiresWorkspace: rawDefinition.requiresWorkspace === true,
+    accessPolicyId: normalizeText(rawDefinition.accessPolicyId).toLowerCase()
+  });
+}
+
+function resolveTableSuffix(surfaceId = "") {
+  return toSnakeCase(surfaceId) || "assistant";
+}
+
+async function resolveMenuPlacementTarget(appRoot = "", options = {}) {
+  return resolveShellOutletPlacementTargetFromApp({
+    appRoot,
+    context: "assistant-generator",
+    placement: normalizeText(options?.placement)
+  });
+}
+
+async function buildTemplateContext({ appRoot, options } = {}) {
+  const appConfig = await loadAppConfig(appRoot);
+  const runtimeSurface = resolveSurfaceDefinition(appConfig, options?.["runtime-surface"], "runtime-surface");
+  const settingsSurface = resolveSurfaceDefinition(appConfig, options?.["settings-surface"], "settings-surface");
+  const configScope = normalizeConfigScope(options?.["config-scope"]);
+
+  if (configScope === "workspace" && runtimeSurface.requiresWorkspace !== true) {
+    throw new Error(
+      `assistant generator config-scope "workspace" requires runtime surface "${runtimeSurface.id}" with requiresWorkspace=true.`
+    );
+  }
+  if (configScope === "workspace" && settingsSurface.requiresWorkspace !== true) {
+    throw new Error(
+      `assistant generator config-scope "workspace" requires settings surface "${settingsSurface.id}" with requiresWorkspace=true.`
+    );
+  }
+
+  const placementTarget = await resolveMenuPlacementTarget(appRoot, options);
+  const tableSuffix = resolveTableSuffix(runtimeSurface.id);
+  const menuComponentToken = normalizeText(options?.["placement-component-token"]) || DEFAULT_MENU_COMPONENT_TOKEN;
+
+  return Object.freeze({
+    "__ASSISTANT_RUNTIME_SURFACE_ID__": runtimeSurface.id,
+    "__ASSISTANT_SETTINGS_SURFACE_ID__": settingsSurface.id,
+    "__ASSISTANT_RUNTIME_SURFACE_REQUIRES_WORKSPACE__": runtimeSurface.requiresWorkspace ? "true" : "false",
+    "__ASSISTANT_SETTINGS_SURFACE_REQUIRES_WORKSPACE__": settingsSurface.requiresWorkspace ? "true" : "false",
+    "__ASSISTANT_SETTINGS_SURFACE_REQUIRES_CONSOLE_OWNER__":
+      settingsSurface.accessPolicyId === "console_owner" ? "true" : "false",
+    "__ASSISTANT_CONFIG_SCOPE__": configScope,
+    "__ASSISTANT_SETTINGS_HOST__": `${settingsSurface.id}-settings`,
+    "__ASSISTANT_CONFIG_TABLE__": "assistant_config",
+    "__ASSISTANT_CONVERSATIONS_TABLE__": `assistant_${tableSuffix}_conversations`,
+    "__ASSISTANT_MESSAGES_TABLE__": `assistant_${tableSuffix}_messages`,
+    "__ASSISTANT_MENU_PLACEMENT_HOST__": placementTarget.host,
+    "__ASSISTANT_MENU_PLACEMENT_POSITION__": placementTarget.position,
+    "__ASSISTANT_MENU_COMPONENT_TOKEN__": menuComponentToken,
+    "__ASSISTANT_MENU_LABEL__": normalizeText(options?.["menu-label"]) || "Assistant",
+    "__ASSISTANT_MENU_WORKSPACE_SUFFIX__": "/assistant",
+    "__ASSISTANT_MENU_NON_WORKSPACE_SUFFIX__": "/assistant"
+  });
+}
+
+export { buildTemplateContext };

package/templates/migrations/assistant_config_initial.cjs

@@ -0,0 +1,25 @@
+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,15 +1,18 @@
 exports.up = async function up(knex) {
-  const hasConversationsTable = await knex.schema.hasTable("ai_conversations");
+  const hasConversationsTable = await knex.schema.hasTable("__ASSISTANT_CONVERSATIONS_TABLE__");
   if (!hasConversationsTable) {
-    await knex.schema.createTable("ai_conversations", (table) => {
+    await knex.schema.createTable("__ASSISTANT_CONVERSATIONS_TABLE__", (table) => {
       table.increments("id").unsigned().primary();
-      table.integer("workspace_id").unsigned().notNullable().references("id").inTable("workspaces").onDelete("CASCADE").index();
+      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_sid", 32).notNullable().defaultTo("admin");
+      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());
@@ -17,17 +20,20 @@ exports.up = async function up(knex) {
       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_ai_conversations_workspace_started_at");
-      table.index(["workspace_id", "created_by_user_id"], "idx_ai_conversations_workspace_creator");
+      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("ai_messages");
+  const hasMessagesTable = await knex.schema.hasTable("__ASSISTANT_MESSAGES_TABLE__");
   if (!hasMessagesTable) {
-    await knex.schema.createTable("ai_messages", (table) => {
+    await knex.schema.createTable("__ASSISTANT_MESSAGES_TABLE__", (table) => {
       table.increments("id").unsigned().primary();
-      table.integer("conversation_id").unsigned().notNullable().references("id").inTable("ai_conversations").onDelete("CASCADE");
-      table.integer("workspace_id").unsigned().notNullable().references("id").inTable("workspaces").onDelete("CASCADE").index();
+      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");
@@ -37,13 +43,14 @@ exports.up = async function up(knex) {
       table.text("metadata_json").nullable();
       table.timestamp("created_at").notNullable().defaultTo(knex.fn.now());
 
-      table.unique(["conversation_id", "seq"], "uq_ai_messages_conversation_seq");
-      table.index(["conversation_id", "created_at"], "idx_ai_messages_conversation_created_at");
+      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("ai_messages");
-  await knex.schema.dropTableIfExists("ai_conversations");
+  await knex.schema.dropTableIfExists("__ASSISTANT_MESSAGES_TABLE__");
+  await knex.schema.dropTableIfExists("__ASSISTANT_CONVERSATIONS_TABLE__");
 };

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

@@ -0,0 +1,88 @@
+<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

@@ -0,0 +1,10 @@
+<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>