@jskit-ai/assistant 0.1.41 → 0.1.42

package/package.descriptor.mjs

@@ -1,7 +1,7 @@
 export default Object.freeze({
   packageVersion: 1,
   packageId: "@jskit-ai/assistant",
-  version: "0.1.41",
+  version: "0.1.42",
   kind: "generator",
   description: "Install assistant runtime/config for one surface and scaffold assistant pages at explicit target files.",
   options: {
@@ -19,8 +19,7 @@ export default Object.freeze({
       inputType: "text",
       validationType: "enabled-surface-id",
       defaultValue: "",
-      promptLabel: "Settings surface",
-      promptHint: "Enabled settings host surface id used by assistant setup.",
+      promptLabel: "Which enabled surface should host the assistant settings UI?",
       helpHint: "Surface that hosts the settings UI for the selected assistant runtime."
     },
     "config-scope": {
@@ -69,7 +68,7 @@ export default Object.freeze({
     "ai-config-prefix": {
       required: false,
       inputType: "text",
-      defaultValue: "",
+      defaultFromOptionTemplate: "${option:surface|snake|upper}_ASSISTANT",
       promptLabel: "AI config prefix",
       promptHint: "Optional env/config prefix override. Defaults to <SURFACE>_ASSISTANT."
     },
@@ -87,8 +86,7 @@ export default Object.freeze({
       promptHint: "Leave empty to keep the assistant disabled until you add a key."
     },
     "ai-base-url": {
-      required: true,
-      allowEmpty: true,
+      required: false,
       defaultValue: "",
       promptLabel: "AI base URL",
       promptHint: "Optional provider-compatible base URL override."
@@ -289,19 +287,40 @@ export default Object.freeze({
         }
       },
       {
-        op: "append-text",
         file: ".env",
-        position: "bottom",
-        skipIfContains: "__ASSISTANT_AI_CONFIG_PREFIX___AI_PROVIDER=",
-        value:
-          "\n__ASSISTANT_AI_CONFIG_PREFIX___AI_PROVIDER=${option:ai-provider}\n__ASSISTANT_AI_CONFIG_PREFIX___AI_API_KEY=${option:ai-api-key}\n__ASSISTANT_AI_CONFIG_PREFIX___AI_BASE_URL=${option:ai-base-url}\n__ASSISTANT_AI_CONFIG_PREFIX___AI_TIMEOUT_MS=${option:ai-timeout-ms}\n",
-        reason: "Append assistant AI env defaults for the generated surface prefix.",
+        op: "upsert-env",
+        key: "${option:ai-config-prefix}_AI_PROVIDER",
+        value: "${option:ai-provider}",
+        reason: "Configure the assistant AI provider for the selected surface.",
         category: "runtime-config",
-        id: "assistant-ai-prefixed-env",
-        templateContext: {
-          entrypoint: "src/server/buildTemplateContext.js",
-          export: "buildTemplateContext"
-        }
+        id: "assistant-ai-provider"
+      },
+      {
+        file: ".env",
+        op: "upsert-env",
+        key: "${option:ai-config-prefix}_AI_API_KEY",
+        value: "${option:ai-api-key}",
+        reason: "Configure the assistant AI API key for the selected surface.",
+        category: "runtime-config",
+        id: "assistant-ai-api-key"
+      },
+      {
+        file: ".env",
+        op: "upsert-env",
+        key: "${option:ai-config-prefix}_AI_BASE_URL",
+        value: "${option:ai-base-url}",
+        reason: "Configure the optional assistant AI base URL override for the selected surface.",
+        category: "runtime-config",
+        id: "assistant-ai-base-url"
+      },
+      {
+        file: ".env",
+        op: "upsert-env",
+        key: "${option:ai-config-prefix}_AI_TIMEOUT_MS",
+        value: "${option:ai-timeout-ms}",
+        reason: "Configure the assistant AI timeout for the selected surface.",
+        category: "runtime-config",
+        id: "assistant-ai-timeout-ms"
       }
     ]
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jskit-ai/assistant",
-  "version": "0.1.41",
+  "version": "0.1.42",
   "type": "module",
   "scripts": {
     "test": "node --test"
@@ -9,6 +9,6 @@
     "./server/buildTemplateContext": "./src/server/buildTemplateContext.js"
   },
   "dependencies": {
-    "@jskit-ai/kernel": "0.1.32"
+    "@jskit-ai/kernel": "0.1.33"
   }
 }

package/src/server/pageSupport.js

@@ -94,7 +94,7 @@ function renderAssistantPageLinkPlacementBlock({
 
 function renderAssistantPageSummary(
   pageTarget = {},
-  { pageAlreadyExisted = false, pageOverwritten = false, placementChanged = false } = {}
+  { pageAlreadyExisted = false, pageOverwritten = false } = {}
 ) {
   if (!pageAlreadyExisted) {
     return `Generated assistant page "${String(pageTarget?.routeUrlSuffix || "")}".`;
@@ -102,10 +102,7 @@ function renderAssistantPageSummary(
   if (pageOverwritten) {
     return `Regenerated assistant page "${String(pageTarget?.routeUrlSuffix || "")}".`;
   }
-  if (placementChanged) {
-    return `Updated assistant page link placement for "${String(pageTarget?.routeUrlSuffix || "")}".`;
-  }
-  return `Assistant page "${String(pageTarget?.routeUrlSuffix || "")}" is already up to date.`;
+  return `Generated assistant page "${String(pageTarget?.routeUrlSuffix || "")}".`;
 }
 
 export {

package/src/server/subcommands/page.js

@@ -96,8 +96,7 @@ async function runGeneratorSubcommand({
     touchedFiles: [...touchedFiles].sort((left, right) => left.localeCompare(right)),
     summary: renderAssistantPageSummary(pageTarget, {
       pageAlreadyExisted,
-      pageOverwritten: pageAlreadyExisted && forceOverwrite,
-      placementChanged: placementApplied.changed
+      pageOverwritten: pageAlreadyExisted && forceOverwrite
     })
   };
 }

package/src/server/subcommands/settingsPage.js

@@ -100,8 +100,7 @@ async function runGeneratorSubcommand({
     touchedFiles: [...touchedFiles].sort((left, right) => left.localeCompare(right)),
     summary: renderAssistantPageSummary(pageTarget, {
       pageAlreadyExisted,
-      pageOverwritten: pageAlreadyExisted && forceOverwrite,
-      placementChanged: placementApplied.changed
+      pageOverwritten: pageAlreadyExisted && forceOverwrite
     })
   };
 }

package/test/packageDescriptor.test.js

@@ -15,8 +15,13 @@ test("assistant descriptor exposes setup as the primary command and still depend
   assert.equal(descriptor.options?.["settings-surface"]?.required, true);
   assert.equal(descriptor.options?.["settings-surface"]?.validationType, "enabled-surface-id");
   assert.equal(descriptor.options?.["config-scope"]?.defaultValue, "global");
+  assert.equal(
+    descriptor.options?.["ai-config-prefix"]?.defaultFromOptionTemplate,
+    "${option:surface|snake|upper}_ASSISTANT"
+  );
   assert.equal(descriptor.options?.name?.required, false);
   assert.equal(descriptor.options?.["link-placement"]?.required, false);
+  assert.equal(descriptor.options?.["ai-base-url"]?.required, false);
   assert.deepEqual(descriptor.dependsOn, ["@jskit-ai/assistant-runtime"]);
 });
 
@@ -34,16 +39,30 @@ test("assistant descriptor defines explicit page subcommands and setup-only muta
   assert.equal(fileMutations.length, 0);
 });
 
-test("assistant descriptor appends only setup config and env entries", () => {
+test("assistant descriptor appends setup config and upserts assistant env entries", () => {
   const publicConfig = findTextMutation("assistant-public-surface-config");
   const serverConfig = findTextMutation("assistant-server-surface-config");
-  const envBlock = findTextMutation("assistant-ai-prefixed-env");
+  const envProvider = findTextMutation("assistant-ai-provider");
+  const envApiKey = findTextMutation("assistant-ai-api-key");
+  const envBaseUrl = findTextMutation("assistant-ai-base-url");
+  const envTimeout = findTextMutation("assistant-ai-timeout-ms");
   const textMutations = Array.isArray(descriptor?.mutations?.text) ? descriptor.mutations.text : [];
 
-  assert.equal(textMutations.length, 3);
+  assert.equal(textMutations.length, 6);
   assert.match(String(publicConfig?.value || ""), /config\.assistantSurfaces\.\$\{option:surface\|lower\} = \{/);
   assert.match(String(publicConfig?.value || ""), /settingsSurfaceId: "__ASSISTANT_SETTINGS_SURFACE_ID__"/);
   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\}/);
+  assert.equal(envProvider?.op, "upsert-env");
+  assert.equal(envProvider?.key, "${option:ai-config-prefix}_AI_PROVIDER");
+  assert.equal(envProvider?.value, "${option:ai-provider}");
+  assert.equal(envApiKey?.op, "upsert-env");
+  assert.equal(envApiKey?.key, "${option:ai-config-prefix}_AI_API_KEY");
+  assert.equal(envApiKey?.value, "${option:ai-api-key}");
+  assert.equal(envBaseUrl?.op, "upsert-env");
+  assert.equal(envBaseUrl?.key, "${option:ai-config-prefix}_AI_BASE_URL");
+  assert.equal(envBaseUrl?.value, "${option:ai-base-url}");
+  assert.equal(envTimeout?.op, "upsert-env");
+  assert.equal(envTimeout?.key, "${option:ai-config-prefix}_AI_TIMEOUT_MS");
+  assert.equal(envTimeout?.value, "${option:ai-timeout-ms}");
 });

package/test/subcommands.test.js

@@ -87,6 +87,7 @@ test("assistant page subcommand creates a runtime page at an explicit target fil
     });
 
     assert.deepEqual(result.touchedFiles, [toPagePath(targetFile), "src/placement.js"]);
+    assert.equal(result.summary, 'Generated assistant page "/ops/copilot".');
 
     const pageSource = await readFile(path.join(appRoot, toPagePath(targetFile)), "utf8");
     assert.match(pageSource, /<AssistantSurfaceClientElement surface-id="admin" \/>/);
@@ -129,6 +130,7 @@ test("assistant settings-page subcommand uses the target assistant surface and i
     });
 
     assert.deepEqual(result.touchedFiles, [toPagePath(targetFile), "src/placement.js"]);
+    assert.equal(result.summary, 'Generated assistant page "/settings/assistant".');
 
     const pageSource = await readFile(path.join(appRoot, toPagePath(targetFile)), "utf8");
     assert.match(pageSource, /<AssistantSettingsClientElement target-surface-id="console" \/>/);