@jskit-ai/assistant 0.1.32 → 0.1.35

package/{src/client/composables/useAssistantWorkspaceRuntime.js → templates/src/local-package/client/composables/useAssistantRuntime.js}

@@ -2,24 +2,27 @@ import { computed, ref, watch } from "vue";
 import { useQueryClient } from "@tanstack/vue-query";
 import { getClientAppConfig } from "@jskit-ai/kernel/client";
 import { normalizeObject, normalizeText } from "@jskit-ai/kernel/shared/support/normalize";
-import { useRealtimeEvent } from "@jskit-ai/realtime/client/composables/useRealtimeEvent";
-import { useShellWebErrorRuntime } from "@jskit-ai/shell-web/client/error";
-import { useWorkspaceRouteContext } from "@jskit-ai/users-web/client/composables/useWorkspaceRouteContext";
-import { usePagedCollection } from "@jskit-ai/users-web/client/composables/usePagedCollection";
+import { buildAssistantApiPath } from "@jskit-ai/assistant-core/shared";
 import {
-  MAX_INPUT_CHARS,
   ASSISTANT_STREAM_EVENT_TYPES,
   MAX_HISTORY_MESSAGES,
+  MAX_INPUT_CHARS,
   assistantConversationMessagesQueryKey,
   assistantConversationsListQueryKey,
-  assistantWorkspaceScopeQueryKey,
+  assistantScopeQueryKey,
   normalizeAssistantStreamEventType,
   normalizeConversationStatus as normalizeAssistantConversationStatus,
   parseJsonObject,
   toPositiveInteger
-} from "../../shared/index.js";
-import { assistantHttpClient } from "../lib/assistantHttpClient.js";
-import { createAssistantWorkspaceApi } from "../lib/assistantApi.js";
+} from "@jskit-ai/assistant-core/shared";
+import {
+  assistantHttpClient,
+  createAssistantApi
+} from "@jskit-ai/assistant-core/client";
+import { useShellWebErrorRuntime } from "@jskit-ai/shell-web/client/error";
+import { usePagedCollection } from "@jskit-ai/users-web/client/composables/usePagedCollection";
+import { useWorkspaceRouteContext } from "@jskit-ai/users-web/client/composables/useWorkspaceRouteContext";
+import { assistantRuntimeConfig } from "../../shared/assistantRuntimeConfig.js";
 
 const DEFAULT_STREAM_TIMEOUT_MS = 120_000;
 const DEFAULT_HISTORY_PAGE_SIZE = 20;
@@ -36,43 +39,31 @@ function toNonNegativeInteger(value, fallback = 0) {
   return parsed;
 }
 
-function buildActiveConversationStorageKey(workspaceSlug) {
-  const normalizedWorkspaceSlug = normalizeText(workspaceSlug);
-  if (!normalizedWorkspaceSlug) {
-    return "";
-  }
-
-  return `assistant.activeConversationId:${normalizedWorkspaceSlug}`;
+function buildScopeStorageKey(scope = {}) {
+  const runtimeSurfaceId = normalizeText(scope?.targetSurfaceId).toLowerCase() || "assistant";
+  const workspaceSlug = normalizeText(scope?.workspaceSlug).toLowerCase() || "global";
+  return `assistant.activeConversationId:${runtimeSurfaceId}:${workspaceSlug}`;
 }
 
-function readStoredActiveConversationId(workspaceSlug) {
+function readStoredActiveConversationId(scope = {}) {
   if (typeof window === "undefined" || !window.sessionStorage) {
     return 0;
   }
 
-  const storageKey = buildActiveConversationStorageKey(workspaceSlug);
-  if (!storageKey) {
-    return 0;
-  }
-
   try {
-    return toPositiveInteger(window.sessionStorage.getItem(storageKey), 0);
+    return toPositiveInteger(window.sessionStorage.getItem(buildScopeStorageKey(scope)), 0);
   } catch {
     return 0;
   }
 }
 
-function writeStoredActiveConversationId(workspaceSlug, conversationId) {
+function writeStoredActiveConversationId(scope = {}, conversationId) {
   if (typeof window === "undefined" || !window.sessionStorage) {
     return;
   }
 
-  const storageKey = buildActiveConversationStorageKey(workspaceSlug);
-  if (!storageKey) {
-    return;
-  }
-
   const normalizedConversationId = toPositiveInteger(conversationId, 0);
+  const storageKey = buildScopeStorageKey(scope);
   try {
     if (normalizedConversationId > 0) {
       window.sessionStorage.setItem(storageKey, String(normalizedConversationId));
@@ -213,19 +204,6 @@ function mapTranscriptEntriesToAssistantState(entries) {
   };
 }
 
-function resolveWorkspaceScope(bootstrapData = {}, workspaceSlug = "") {
-  const activeWorkspace = bootstrapData?.workspace && typeof bootstrapData.workspace === "object"
-    ? bootstrapData.workspace
-    : bootstrapData?.activeWorkspace && typeof bootstrapData.activeWorkspace === "object"
-      ? bootstrapData.activeWorkspace
-    : null;
-
-  return {
-    workspaceSlug: normalizeText(workspaceSlug),
-    workspaceId: toPositiveInteger(activeWorkspace?.id, 0)
-  };
-}
-
 function resolveRuntimePolicy() {
   const appConfig = getClientAppConfig();
   const assistantConfig = normalizeObject(appConfig?.assistant);
@@ -238,27 +216,24 @@ function resolveRuntimePolicy() {
   });
 }
 
-function createRuntimeApi({ overrideApi = null, resolveSurfaceId = null } = {}) {
+function createRuntimeApi({ overrideApi = null, resolveBasePath, resolveSurfaceId = null } = {}) {
   if (overrideApi && typeof overrideApi.streamChat === "function") {
     return overrideApi;
   }
 
-  return createAssistantWorkspaceApi({
+  return createAssistantApi({
     request: assistantHttpClient.request,
     requestStream: assistantHttpClient.requestStream,
+    resolveBasePath,
     resolveSurfaceId
   });
 }
 
-function useAssistantWorkspaceRuntime({ api = null } = {}) {
+function useAssistantRuntime({ api = null } = {}) {
   const runtimePolicy = resolveRuntimePolicy();
   const queryClient = useQueryClient();
   const errorRuntime = useShellWebErrorRuntime();
-  const { workspaceSlugFromRoute, currentSurfaceId, placementContext } = useWorkspaceRouteContext();
-  const runtimeApi = createRuntimeApi({
-    overrideApi: api,
-    resolveSurfaceId: () => normalizeText(currentSurfaceId.value).toLowerCase()
-  });
+  const { placementContext, currentSurfaceId, workspaceSlugFromRoute } = useWorkspaceRouteContext();
 
   const messages = ref([]);
   const input = ref("");
@@ -270,12 +245,45 @@ function useAssistantWorkspaceRuntime({ api = null } = {}) {
   const abortController = ref(null);
 
   const placementSnapshot = computed(() => normalizeObject(placementContext.value));
-  const workspaceScope = computed(() => resolveWorkspaceScope(placementSnapshot.value, workspaceSlugFromRoute.value));
-  const hasWorkspaceScope = computed(() => Boolean(workspaceScope.value.workspaceSlug));
+  const runtimeScope = computed(() => {
+    const workspaceSlug = assistantRuntimeConfig.runtimeSurfaceRequiresWorkspace
+      ? normalizeText(workspaceSlugFromRoute.value).toLowerCase()
+      : "";
+
+    return {
+      targetSurfaceId: assistantRuntimeConfig.runtimeSurfaceId,
+      workspaceSlug,
+      workspaceId: assistantRuntimeConfig.runtimeSurfaceRequiresWorkspace
+        ? toPositiveInteger(placementSnapshot.value?.workspace?.id, 0)
+        : 0
+    };
+  });
+  const hasRuntimeScope = computed(() =>
+    assistantRuntimeConfig.runtimeSurfaceRequiresWorkspace ? Boolean(runtimeScope.value.workspaceSlug) : true
+  );
+
+  const runtimeApi = createRuntimeApi({
+    overrideApi: api,
+    resolveBasePath: () =>
+      buildAssistantApiPath({
+        requiresWorkspace: assistantRuntimeConfig.runtimeSurfaceRequiresWorkspace,
+        workspaceSlug: runtimeScope.value.workspaceSlug,
+        suffix: "/"
+      }),
+    resolveSurfaceId: () => normalizeText(currentSurfaceId.value).toLowerCase()
+  });
+
   const activeConversationId = computed(() => normalizeText(conversationId.value));
-  const isAdminSurface = computed(() => currentSurfaceId.value === "admin");
-  const canSend = computed(() => !isStreaming.value && !isRestoringConversation.value && Boolean(normalizeText(input.value)));
-  const canStartNewConversation = computed(() => !isStreaming.value);
+  const isAdminSurface = computed(() => normalizeText(currentSurfaceId.value).toLowerCase() === "admin");
+  const canSend = computed(() => {
+    return Boolean(
+      hasRuntimeScope.value &&
+        !isStreaming.value &&
+        !isRestoringConversation.value &&
+        normalizeText(input.value)
+    );
+  });
+  const canStartNewConversation = computed(() => Boolean(hasRuntimeScope.value && !isStreaming.value));
 
   function setRuntimeError(message, dedupeKey = "") {
     const normalizedMessage = normalizeText(message);
@@ -285,23 +293,23 @@ function useAssistantWorkspaceRuntime({ api = null } = {}) {
     }
 
     errorRuntime.report({
-      source: "assistant.workspace-runtime",
+      source: "assistant.runtime",
       message: normalizedMessage,
       severity: "error",
       channel: "banner",
-      dedupeKey: dedupeKey || `assistant.workspace-runtime:error:${normalizedMessage}`,
+      dedupeKey: dedupeKey || `assistant.runtime:error:${normalizedMessage}`,
       dedupeWindowMs: 3000
     });
   }
 
   const conversationHistoryCollection = usePagedCollection({
     queryKey: computed(() =>
-      assistantConversationsListQueryKey(workspaceScope.value, {
+      assistantConversationsListQueryKey(runtimeScope.value, {
         limit: runtimePolicy.historyPageSize
       })
     ),
     queryFn: ({ pageParam = null }) =>
-      runtimeApi.listConversations(workspaceScope.value.workspaceSlug, {
+      runtimeApi.listConversations({
         cursor: pageParam,
         limit: runtimePolicy.historyPageSize
       }),
@@ -310,7 +318,7 @@ function useAssistantWorkspaceRuntime({ api = null } = {}) {
       const conversationNumericId = toPositiveInteger(entry?.id, 0);
       return conversationNumericId > 0 ? String(conversationNumericId) : normalizeText(entry?.id);
     },
-    enabled: computed(() => hasWorkspaceScope.value),
+    enabled: computed(() => hasRuntimeScope.value),
     queryOptions: {
       staleTime: runtimePolicy.historyStaleTimeMs,
       refetchOnMount: false,
@@ -328,46 +336,45 @@ function useAssistantWorkspaceRuntime({ api = null } = {}) {
   const conversationHistoryError = conversationHistoryCollection.loadError;
 
   watch(conversationId, (nextConversationId, previousConversationId) => {
-    const workspaceSlug = workspaceScope.value.workspaceSlug;
-    if (!workspaceSlug) {
+    if (!hasRuntimeScope.value) {
       return;
     }
 
     const nextConversationNumericId = toPositiveInteger(nextConversationId, 0);
     if (nextConversationNumericId > 0) {
-      writeStoredActiveConversationId(workspaceSlug, nextConversationNumericId);
+      writeStoredActiveConversationId(runtimeScope.value, nextConversationNumericId);
       return;
     }
 
     const previousConversationNumericId = toPositiveInteger(previousConversationId, 0);
     if (previousConversationNumericId > 0) {
-      writeStoredActiveConversationId(workspaceSlug, 0);
+      writeStoredActiveConversationId(runtimeScope.value, 0);
     }
   });
 
   watch(
     [
-      hasWorkspaceScope,
+      hasRuntimeScope,
       conversationHistoryLoading,
-      workspaceScope,
+      runtimeScope,
       conversationId,
       conversationHistory,
       isRestoringConversation
     ],
     async ([
-      nextHasWorkspaceScope,
+      nextHasRuntimeScope,
       nextConversationHistoryLoading,
-      nextWorkspaceScope,
+      nextRuntimeScope,
       nextConversationId,
       nextConversationHistory,
       nextIsRestoringConversation
     ]) => {
-      if (!nextHasWorkspaceScope || nextConversationHistoryLoading || nextIsRestoringConversation) {
+      if (!nextHasRuntimeScope || nextConversationHistoryLoading || nextIsRestoringConversation) {
         return;
       }
 
-      const activeConversationId = toPositiveInteger(nextConversationId, 0);
-      if (activeConversationId > 0) {
+      const activeConversationNumericId = toPositiveInteger(nextConversationId, 0);
+      if (activeConversationNumericId > 0) {
         return;
       }
 
@@ -376,7 +383,7 @@ function useAssistantWorkspaceRuntime({ api = null } = {}) {
         return;
       }
 
-      const storedConversationId = readStoredActiveConversationId(nextWorkspaceScope?.workspaceSlug);
+      const storedConversationId = readStoredActiveConversationId(nextRuntimeScope);
       if (!storedConversationId) {
         return;
       }
@@ -385,7 +392,7 @@ function useAssistantWorkspaceRuntime({ api = null } = {}) {
         (entry) => toPositiveInteger(entry?.id, 0) === storedConversationId
       );
       if (!hasStoredConversation) {
-        writeStoredActiveConversationId(nextWorkspaceScope?.workspaceSlug, 0);
+        writeStoredActiveConversationId(nextRuntimeScope, 0);
         return;
       }
 
@@ -419,17 +426,17 @@ function useAssistantWorkspaceRuntime({ api = null } = {}) {
   }
 
   async function invalidateConversationScope() {
-    if (!hasWorkspaceScope.value) {
+    if (!hasRuntimeScope.value) {
       return;
     }
 
     await queryClient.invalidateQueries({
-      queryKey: assistantWorkspaceScopeQueryKey(workspaceScope.value)
+      queryKey: assistantScopeQueryKey(runtimeScope.value)
     });
   }
 
   async function refreshConversationHistory() {
-    if (!hasWorkspaceScope.value) {
+    if (!hasRuntimeScope.value) {
       return;
     }
 
@@ -442,7 +449,7 @@ function useAssistantWorkspaceRuntime({ api = null } = {}) {
 
   async function selectConversationById(nextConversationId) {
     const normalizedConversationId = normalizeText(nextConversationId);
-    if (!normalizedConversationId || isStreaming.value || isRestoringConversation.value || !hasWorkspaceScope.value) {
+    if (!normalizedConversationId || isStreaming.value || isRestoringConversation.value || !hasRuntimeScope.value) {
       return;
     }
 
@@ -458,12 +465,12 @@ function useAssistantWorkspaceRuntime({ api = null } = {}) {
 
     try {
       const response = await queryClient.fetchQuery({
-        queryKey: assistantConversationMessagesQueryKey(workspaceScope.value, parsedConversationId, {
+        queryKey: assistantConversationMessagesQueryKey(runtimeScope.value, parsedConversationId, {
           page: RESTORE_MESSAGES_PAGE,
           pageSize: runtimePolicy.restoreMessagesPageSize
         }),
         queryFn: () =>
-          runtimeApi.getConversationMessages(workspaceScope.value.workspaceSlug, parsedConversationId, {
+          runtimeApi.getConversationMessages(parsedConversationId, {
             page: RESTORE_MESSAGES_PAGE,
             pageSize: runtimePolicy.restoreMessagesPageSize
           })
@@ -495,7 +502,7 @@ function useAssistantWorkspaceRuntime({ api = null } = {}) {
     input.value = "";
     setRuntimeError("");
     conversationId.value = null;
-    writeStoredActiveConversationId(workspaceScope.value.workspaceSlug, 0);
+    writeStoredActiveConversationId(runtimeScope.value, 0);
     isStreaming.value = false;
     isRestoringConversation.value = false;
     abortController.value = null;
@@ -527,7 +534,7 @@ function useAssistantWorkspaceRuntime({ api = null } = {}) {
 
   async function sendMessage() {
     const normalizedInput = normalizeText(input.value).slice(0, MAX_INPUT_CHARS);
-    if (!normalizedInput || isStreaming.value || isRestoringConversation.value || !hasWorkspaceScope.value) {
+    if (!normalizedInput || isStreaming.value || isRestoringConversation.value || !hasRuntimeScope.value) {
       return;
     }
 
@@ -567,7 +574,6 @@ function useAssistantWorkspaceRuntime({ api = null } = {}) {
 
     try {
       await runtimeApi.streamChat(
-        workspaceScope.value.workspaceSlug,
         {
           messageId,
           ...(parsedConversationId > 0 ? { conversationId: parsedConversationId } : {}),
@@ -645,7 +651,7 @@ function useAssistantWorkspaceRuntime({ api = null } = {}) {
             if (eventType === ASSISTANT_STREAM_EVENT_TYPES.ERROR) {
               setRuntimeError(
                 normalizeText(event?.message) || "Assistant request failed.",
-                "assistant.workspace-runtime:stream-event-error"
+                "assistant.runtime:stream-event-error"
               );
               updateMessage(assistantMessageId, {
                 status: "error"
@@ -664,7 +670,7 @@ function useAssistantWorkspaceRuntime({ api = null } = {}) {
       const assistantMessageText = normalizeText(assistantMessage?.text);
       if (!assistantMessageText && streamDoneStatus !== "aborted") {
         if (!error.value) {
-          setRuntimeError("Assistant returned no output.", "assistant.workspace-runtime:empty-output");
+          setRuntimeError("Assistant returned no output.", "assistant.runtime:empty-output");
         }
         updateMessage(assistantMessageId, {
           status: "error"
@@ -698,35 +704,6 @@ function useAssistantWorkspaceRuntime({ api = null } = {}) {
     }
   }
 
-  useRealtimeEvent({
-    event: "assistant.transcript.changed",
-    enabled: computed(() => hasWorkspaceScope.value),
-    matches({ payload }) {
-      if (!payload || typeof payload !== "object") {
-        return true;
-      }
-
-      const scope = payload.scope && typeof payload.scope === "object" ? payload.scope : {};
-      const workspaceIdFromEvent = toPositiveInteger(scope.id || scope.workspaceId, 0);
-      const workspaceId = toPositiveInteger(workspaceScope.value.workspaceId, 0);
-      if (workspaceIdFromEvent > 0 && workspaceId > 0) {
-        return workspaceIdFromEvent === workspaceId;
-      }
-
-      return true;
-    },
-    async onEvent({ payload }) {
-      await invalidateConversationScope();
-      const incomingConversationId = toPositiveInteger(payload?.conversationId, 0);
-      const activeId = toPositiveInteger(conversationId.value, 0);
-      if (!incomingConversationId || incomingConversationId !== activeId || !activeId) {
-        return;
-      }
-
-      await selectConversationById(activeId);
-    }
-  });
-
   const viewer = computed(() => {
     const user = normalizeObject(placementSnapshot.value.user);
 
@@ -774,4 +751,4 @@ function useAssistantWorkspaceRuntime({ api = null } = {}) {
   });
 }
 
-export { useAssistantWorkspaceRuntime };
+export { useAssistantRuntime };

package/templates/src/local-package/client/index.js

@@ -0,0 +1,3 @@
+export { default as AssistantSurfaceClientElement } from "./components/AssistantSurfaceClientElement.vue";
+export { default as AssistantSettingsClientElement } from "./components/AssistantSettingsClientElement.vue";
+export { useAssistantRuntime } from "./composables/useAssistantRuntime.js";

package/templates/src/local-package/client/providers/AssistantClientProvider.js

@@ -0,0 +1,16 @@
+import AssistantSettingsClientElement from "../components/AssistantSettingsClientElement.vue";
+
+class AssistantClientProvider {
+  static id = "assistant.web.client";
+  static dependsOn = ["users.web.client"];
+
+  register(app) {
+    if (!app || typeof app.singleton !== "function") {
+      throw new Error("AssistantClientProvider requires application singleton().");
+    }
+
+    app.singleton("assistant.web.settings.element", () => AssistantSettingsClientElement);
+  }
+}
+
+export { AssistantClientProvider };

package/templates/src/local-package/package.descriptor.mjs

@@ -0,0 +1,85 @@
+export default Object.freeze({
+  packageVersion: 1,
+  packageId: "@local/assistant",
+  version: "0.1.0",
+  kind: "runtime",
+  description: "App-local generated assistant runtime.",
+  dependsOn: [
+    "@jskit-ai/assistant-core",
+    "@jskit-ai/database-runtime",
+    "@jskit-ai/http-runtime",
+    "@jskit-ai/shell-web",
+    "@jskit-ai/users-core",
+    "@jskit-ai/users-web"
+  ],
+  capabilities: {
+    provides: ["assistant.runtime"],
+    requires: [
+      "runtime.actions",
+      "runtime.database",
+      "auth.policy",
+      "runtime.http-client",
+      "users.core",
+      "users.web"
+    ]
+  },
+  runtime: {
+    server: {
+      providers: [
+        {
+          entrypoint: "src/server/AssistantProvider.js",
+          export: "AssistantProvider"
+        }
+      ]
+    },
+    client: {
+      providers: [
+        {
+          entrypoint: "src/client/providers/AssistantClientProvider.js",
+          export: "AssistantClientProvider"
+        }
+      ]
+    }
+  },
+  metadata: {
+    apiSummary: {
+      surfaces: [
+        {
+          subpath: "./server/actionIds",
+          summary: "Generated assistant action identifiers."
+        },
+        {
+          subpath: "./client",
+          summary: "Generated assistant client wrappers."
+        },
+        {
+          subpath: "./shared",
+          summary: "Generated assistant runtime configuration."
+        }
+      ],
+      containerTokens: {
+        server: [
+          "assistant.config.repository",
+          "assistant.conversation.repository",
+          "assistant.message.repository",
+          "assistant.ai.client",
+          "assistant.service.tool-catalog"
+        ],
+        client: [
+          "assistant.web.settings.element"
+        ]
+      }
+    }
+  },
+  mutations: {
+    dependencies: {
+      runtime: {},
+      dev: {}
+    },
+    packageJson: {
+      scripts: {}
+    },
+    procfile: {},
+    files: []
+  }
+});

package/templates/src/local-package/package.json

@@ -0,0 +1,11 @@
+{
+  "name": "@local/assistant",
+  "version": "0.1.0",
+  "private": true,
+  "type": "module",
+  "exports": {
+    "./client": "./src/client/index.js",
+    "./shared": "./src/shared/index.js",
+    "./server/actionIds": "./src/server/actionIds.js"
+  }
+}