@aigne/doc-smith 0.8.14-beta → 0.8.14-beta.1

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## [0.8.14-beta.1](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.8.14-beta...v0.8.14-beta.1) (2025-10-17)
+
+
+### Bug Fixes
+
+* doc review and update ([#199](https://github.com/AIGNE-io/aigne-doc-smith/issues/199)) ([0061323](https://github.com/AIGNE-io/aigne-doc-smith/commit/006132345a17a7fae10a803656b731144ecc54c9))
+* respect env vars for publish and improve reliability ([#204](https://github.com/AIGNE-io/aigne-doc-smith/issues/204)) ([bd14c2a](https://github.com/AIGNE-io/aigne-doc-smith/commit/bd14c2af54ebca89c8edb5861e3b1a6e3f76e92e))
+
 ## [0.8.14-beta](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.8.13...v0.8.14-beta) (2025-10-16)
 
 

package/agents/generate/check-diagram.mjs

@@ -1,8 +1,8 @@
 import { checkContent } from "../../utils/d2-utils.mjs";
 
-export default async function checkD2DiagramIsValid({ output }) {
+export default async function checkD2DiagramIsValid({ diagramSourceCode }) {
   try {
-    await checkContent({ content: output });
+    await checkContent({ content: diagramSourceCode });
     return {
       isValid: true,
     };
@@ -17,12 +17,12 @@ export default async function checkD2DiagramIsValid({ output }) {
 checkD2DiagramIsValid.input_schema = {
   type: "object",
   properties: {
-    output: {
+    diagramSourceCode: {
       type: "string",
       description: "Source code of d2 diagram",
     },
   },
-  required: ["output"],
+  required: ["diagramSourceCode"],
 };
 checkD2DiagramIsValid.output_schema = {
   type: "object",

package/agents/generate/wrap-diagram-code.mjs

@@ -4,11 +4,11 @@ export default async function wrapDiagramCode({ diagramSourceCode }) {
   try {
     const result = await wrapCode({ content: diagramSourceCode });
     return {
-      output: result,
+      diagramSourceCode: result,
     };
   } catch {
     return {
-      output: diagramSourceCode,
+      diagramSourceCode,
     };
   }
 }
@@ -26,10 +26,10 @@ wrapDiagramCode.input_schema = {
 wrapDiagramCode.output_schema = {
   type: "object",
   properties: {
-    output: {
+    diagramSourceCode: {
       type: "string",
       description: "Source code of d2 diagram",
     },
   },
-  required: ["output"],
+  required: ["diagramSourceCode"],
 };

package/agents/publish/publish-docs.mjs

@@ -57,29 +57,27 @@ export default async function publishDocs(
 
     // ----------------- main publish process flow -----------------------------
     // Check if DOC_DISCUSS_KIT_URL is set in environment variables
-    const envAppUrl = process.env.DOC_DISCUSS_KIT_URL;
-    const useEnvAppUrl = !!envAppUrl;
-
-    // Use environment variable if available, otherwise use the provided appUrl
-    if (useEnvAppUrl) {
-      appUrl = envAppUrl;
-    }
+    const useEnvAppUrl = !!(process.env.DOC_DISCUSS_KIT_URL || appUrl);
 
     // Check if appUrl is default and not saved in config (only when not using env variable)
     const config = await loadConfigFromFile();
-    const isDefaultAppUrl = appUrl === CLOUD_SERVICE_URL_PROD;
-    const hasAppUrlInConfig = config?.appUrl;
+    appUrl = process.env.DOC_DISCUSS_KIT_URL || appUrl || config?.appUrl;
+    const hasInputAppUrl = !!appUrl;
 
+    let shouldSyncBranding = void 0;
     let token = "";
+    let client = null;
+    let authToken = null;
+    let sessionId = null;
 
-    if (!useEnvAppUrl && isDefaultAppUrl && !hasAppUrlInConfig) {
-      const authToken = await getOfficialAccessToken(BASE_URL, false);
+    if (!hasInputAppUrl) {
+      authToken = await getOfficialAccessToken(BASE_URL, false);
 
-      let sessionId = "";
+      sessionId = "";
       let paymentLink = "";
 
       if (authToken) {
-        const client = new BrokerClient({ baseUrl: BASE_URL, authToken });
+        client = new BrokerClient({ baseUrl: BASE_URL, authToken });
         const info = await client.checkCacheSession({
           needShortUrl: true,
           sessionId: config?.checkoutId,
@@ -135,29 +133,60 @@ export default async function publishDocs(
         // Ensure appUrl has protocol
         appUrl = userInput.includes("://") ? userInput : `https://${userInput}`;
       } else if (["new-instance", "new-instance-continue"].includes(choice)) {
-        if (options?.prompts?.confirm) {
-          shouldWithBranding = await options.prompts.confirm({
-            message: "Would you like to update the project branding (title, description, logo)?",
-            default: true,
-          });
-        }
-        // Deploy a new Discuss Kit service
-        let id = "";
-        let paymentUrl = "";
+        // resume previous website setup
         if (choice === "new-instance-continue") {
-          id = sessionId;
-          paymentUrl = paymentLink;
-          console.log(`\nResuming your previous website setup...`);
-        } else {
-          console.log(`\nCreating a new website for your documentation...`);
+          shouldSyncBranding = config?.shouldSyncBranding ?? void 0;
+          if (shouldSyncBranding !== void 0) {
+            shouldWithBranding = shouldWithBranding ?? shouldSyncBranding;
+          }
         }
-        const { appUrl: homeUrl, token: ltToken } = (await deploy(id, paymentUrl)) || {};
 
-        appUrl = homeUrl;
-        token = ltToken;
+        if (options?.prompts?.confirm) {
+          if (shouldSyncBranding === void 0) {
+            shouldSyncBranding = await options.prompts.confirm({
+              message: "Would you like to update the project branding (title, description, logo)?",
+              default: true,
+            });
+            await saveValueToConfig(
+              "shouldSyncBranding",
+              shouldSyncBranding,
+              "Should sync branding for documentation",
+            );
+            shouldWithBranding = shouldSyncBranding;
+          } else {
+            console.log(
+              `Would you like to update the project branding (title, description, logo)? ${chalk.cyan(shouldSyncBranding ? "Yes" : "No")}`,
+            );
+          }
+        }
+
+        try {
+          let id = "";
+          if (choice === "new-instance-continue") {
+            id = sessionId;
+            console.log(`\nResuming your previous website setup...`);
+          } else {
+            console.log(`\nCreating a new website for your documentation...`);
+          }
+          const { appUrl: homeUrl, token: ltToken } = (await deploy(id, paymentLink)) || {};
+
+          appUrl = homeUrl;
+          token = ltToken;
+        } catch (error) {
+          const errorMsg = error?.message || "Unknown error occurred";
+          return { message: `${chalk.red("❌ Failed to create website:")} ${errorMsg}` };
+        }
       }
     }
 
+    if (sessionId) {
+      authToken = await getOfficialAccessToken(BASE_URL, false);
+      client = client || new BrokerClient({ baseUrl: BASE_URL, authToken });
+
+      const { vendors } = await client.getSessionDetail(sessionId, false);
+      token = vendors?.find((vendor) => vendor.vendorType === "launcher" && vendor.token)?.token;
+    }
+
     console.log(`\nPublishing your documentation to ${chalk.cyan(appUrl)}\n`);
 
     const accessToken = await getAccessToken(appUrl, token);
@@ -237,6 +266,7 @@ export default async function publishDocs(
       }
       message = `✅ Documentation published successfully!`;
       await saveValueToConfig("checkoutId", "", "Checkout ID for document deployment service");
+      await saveValueToConfig("shouldSyncBranding", "", "Should sync branding for documentation");
     } else {
       // If the error is 401 or 403, it means the access token is invalid
       if (error?.includes("401") || error?.includes("403")) {
@@ -271,7 +301,6 @@ publishDocs.input_schema = {
     appUrl: {
       type: "string",
       description: "The URL of the app.",
-      default: CLOUD_SERVICE_URL_PROD,
     },
     boardId: {
       type: "string",

package/agents/utils/update-branding.mjs

@@ -25,6 +25,18 @@ export default async function updateBranding({ appUrl, projectInfo, accessToken,
     const componentInfo = await getComponentInfoWithMountPoint(origin, DISCUSS_KIT_DID);
     const mountPoint = componentInfo.mountPoint || "/";
 
+    if (projectInfo.name.length > 40) {
+      console.warn(
+        `⚠️ Name is too long, it should be less than 40 characters\nWill be truncated to 40 characters`,
+      );
+    }
+
+    if (projectInfo.description.length > 160) {
+      console.warn(
+        `⚠️ Description is too long, it should be less than 160 characters\nWill be truncated to 160 characters`,
+      );
+    }
+
     const res = await requestWithAuthToken(
       joinURL(origin, mountPoint, "/api/branding"),
       {
@@ -33,8 +45,8 @@ export default async function updateBranding({ appUrl, projectInfo, accessToken,
           "Content-Type": "application/json",
         },
         body: JSON.stringify({
-          appName: projectInfo.name,
-          appDescription: projectInfo.description,
+          appName: projectInfo.name.slice(0, 40),
+          appDescription: projectInfo.description.slice(0, 160),
         }),
       },
       accessToken,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aigne/doc-smith",
-  "version": "0.8.14-beta",
+  "version": "0.8.14-beta.1",
   "description": "AI-driven documentation generation tool built on the AIGNE Framework",
   "publishConfig": {
     "access": "public"

package/utils/deploy.mjs

@@ -42,11 +42,6 @@ export async function deploy(id, cachedUrl) {
           sessionId,
           "Checkout ID for document deployment website",
         );
-        await saveValueToConfig(
-          "paymentUrl",
-          paymentUrl,
-          "Payment URL for document deployment website",
-        );
 
         if (!isResuming) {
           await open(paymentUrl);