@aigne/doc-smith 0.9.8-alpha.3 → 0.9.8-alpha.5

package/agents/publish/publish-docs.mjs

@@ -1,356 +0,0 @@
-import { basename, join } from "node:path";
-import { publishDocs as publishDocsFn } from "@aigne/publish-docs";
-import { BrokerClient } from "@blocklet/payment-broker-client/node";
-import chalk from "chalk";
-import fs from "fs-extra";
-
-import {
-  getAccessToken,
-  getCachedAccessToken,
-  getDiscussKitMountPoint,
-} from "../../utils/auth-utils.mjs";
-import {
-  CLOUD_SERVICE_URL_PROD,
-  DISCUSS_KIT_STORE_URL,
-  DOC_SMITH_DIR,
-  TMP_DIR,
-  TMP_DOCS_DIR,
-} from "../../utils/constants/index.mjs";
-import { ensureTmpDir } from "../../utils/d2-utils.mjs";
-import { deploy } from "../../utils/deploy.mjs";
-import { getGithubRepoUrl, loadConfigFromFile, saveValueToConfig } from "../../utils/utils.mjs";
-import updateBranding from "../utils/update-branding.mjs";
-import { isRemoteFile, downloadAndUploadImage } from "../../utils/file-utils.mjs";
-import { joinURL } from "ufo";
-
-const BASE_URL = process.env.DOC_SMITH_BASE_URL || CLOUD_SERVICE_URL_PROD;
-
-export default async function publishDocs(
-  {
-    docsDir: rawDocsDir,
-    appUrl,
-    boardId,
-    projectName,
-    projectDesc,
-    projectLogo,
-    translatedMetadata,
-    originalDocumentStructure,
-    "with-branding": withBrandingOption,
-  },
-  options,
-) {
-  let message;
-  let shouldWithBranding = withBrandingOption || false;
-
-  try {
-    // move work dir to tmp-dir
-    await ensureTmpDir();
-
-    const docsDir = join(DOC_SMITH_DIR, TMP_DIR, TMP_DOCS_DIR);
-    await fs.rm(docsDir, { recursive: true, force: true });
-    await fs.mkdir(docsDir, {
-      recursive: true,
-    });
-    await fs.cp(rawDocsDir, docsDir, { recursive: true });
-
-    // ----------------- main publish process flow -----------------------------
-    // Check if DOC_DISCUSS_KIT_URL is set in environment variables
-    const useEnvAppUrl = !!(
-      process.env.DOC_SMITH_PUBLISH_URL ||
-      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();
-    appUrl =
-      process.env.DOC_SMITH_PUBLISH_URL ||
-      process.env.DOC_DISCUSS_KIT_URL ||
-      appUrl ||
-      config?.appUrl;
-    const hasInputAppUrl = !!appUrl;
-
-    let shouldSyncBranding = void 0;
-    let token = "";
-    let client = null;
-    let sessionId = null;
-    let locale = config?.locale;
-
-    if (!hasInputAppUrl) {
-      const officialAccessToken = await getCachedAccessToken(BASE_URL);
-
-      sessionId = "";
-      if (officialAccessToken) {
-        client = new BrokerClient({ baseUrl: BASE_URL, authToken: officialAccessToken });
-        const info = await client.checkCacheSession({
-          needShortUrl: true,
-          sessionId: config?.checkoutId,
-        });
-        sessionId = info.sessionId;
-      }
-
-      const choice = await options.prompts.select({
-        message: "Please select a platform to publish your documents:",
-        choices: [
-          ...(sessionId
-            ? [
-                {
-                  name: `${chalk.yellow("Resume previous website setup")} - ${chalk.green("Already paid.")} Continue where you left off. Your payment has already been processed.`,
-                  value: "new-instance-continue",
-                },
-              ]
-            : []),
-          {
-            name: `${chalk.blue("DocSmith Cloud (docsmith.aigne.io)")} – ${chalk.green("Free")} hosting. Your documents will be publicly accessible. Best for open-source projects or community sharing.`,
-            value: "default",
-          },
-          {
-            name: `${chalk.blue("Your existing website")} - Integrate and publish directly on your current site (setup required)`,
-            value: "custom",
-          },
-          {
-            name: `${chalk.blue("New website")} - ${chalk.yellow("Paid service.")} We'll help you set up a brand-new website with custom domain and hosting. Great if you want a professional presence.`,
-            value: "new-instance",
-          },
-        ],
-      });
-
-      if (choice === "custom") {
-        console.log(
-          `${chalk.bold("\n💡 Tips")}\n\n` +
-            `Start here to run your own website:\n${chalk.cyan(DISCUSS_KIT_STORE_URL)}\n`,
-        );
-        const userInput = await options.prompts.input({
-          message: "Please enter the URL of your website:",
-          validate: (input) => {
-            try {
-              // Check if input contains protocol, if not, prepend https://
-              const urlWithProtocol = input.includes("://") ? input : `https://${input}`;
-              new URL(urlWithProtocol);
-              return true;
-            } catch {
-              return "Please enter a valid URL";
-            }
-          },
-        });
-        // Ensure appUrl has protocol
-        appUrl = userInput.includes("://") ? userInput : `https://${userInput}`;
-      } else if (["new-instance", "new-instance-continue"].includes(choice)) {
-        // resume previous website setup
-        const isNewInstance = choice === "new-instance";
-        if (!isNewInstance) {
-          shouldSyncBranding = config?.shouldSyncBranding ?? void 0;
-          if (shouldSyncBranding !== void 0) {
-            shouldWithBranding = shouldWithBranding ?? shouldSyncBranding;
-          }
-        }
-
-        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 (!isNewInstance) {
-            id = sessionId;
-            console.log(`\nResuming your previous website setup...`);
-          } else {
-            console.log(`\nCreating a new website for your documentation...`);
-          }
-          const {
-            appUrl: homeUrl,
-            token: ltToken,
-            sessionId: newSessionId,
-            data,
-          } = (await deploy(id, isNewInstance ? locale : undefined)) || {};
-
-          sessionId = newSessionId;
-          appUrl = homeUrl;
-          token = ltToken;
-          locale = data?.preferredLocale || locale;
-        } catch (error) {
-          const errorMsg = error?.message || "Unknown error occurred";
-          return { message: `${chalk.red("❌ Failed to create website:")} ${errorMsg}` };
-        }
-      }
-    }
-
-    appUrl = appUrl ?? CLOUD_SERVICE_URL_PROD;
-
-    const appUrlInfo = new URL(appUrl);
-
-    const discussKitMountPoint = await getDiscussKitMountPoint(appUrlInfo.origin);
-    const discussKitUrl = joinURL(appUrlInfo.origin, discussKitMountPoint);
-
-    console.log(`\nPublishing your documentation to ${chalk.cyan(discussKitUrl)}`);
-
-    const accessToken = await getAccessToken(appUrlInfo.origin, token, locale);
-
-    process.env.DOC_ROOT_DIR = docsDir;
-
-    const sidebarPath = join(docsDir, "_sidebar.md");
-    const publishCacheFilePath = join(DOC_SMITH_DIR, "upload-cache.yaml");
-
-    // Get project info from config
-    const projectInfo = {
-      name: projectName || config?.projectName || basename(process.cwd()),
-      description: projectDesc || config?.projectDesc || "",
-      icon: projectLogo || config?.projectLogo || "",
-    };
-    let finalPath = null;
-
-    console.log(`Publishing docs collection: ${chalk.cyan(projectInfo.name || boardId)}\n`);
-
-    // Handle project logo download if it's a URL
-    if (projectInfo.icon && isRemoteFile(projectInfo.icon)) {
-      const { url: uploadedImageUrl, downloadFinalPath } = await downloadAndUploadImage(
-        projectInfo.icon,
-        docsDir,
-        discussKitUrl,
-        accessToken,
-      );
-      projectInfo.icon = uploadedImageUrl;
-      finalPath = downloadFinalPath;
-    }
-
-    if (shouldWithBranding) {
-      updateBranding({ appUrl: discussKitUrl, projectInfo, accessToken, finalPath });
-    }
-
-    const iconMap = {};
-    for (const item of originalDocumentStructure) {
-      if (item.icon) {
-        iconMap[item.title] = item.icon;
-      }
-    }
-
-    // Construct boardMeta object
-    const boardMeta = {
-      category: config?.documentPurpose || [],
-      githubRepoUrl: getGithubRepoUrl(),
-      commitSha: config?.lastGitHead || "",
-      languages: [
-        ...(config?.locale ? [config.locale] : []),
-        ...(config?.translateLanguages || []),
-      ].filter((lang, index, arr) => arr.indexOf(lang) === index), // Remove duplicates
-    };
-    if (translatedMetadata) {
-      boardMeta.translation = translatedMetadata;
-    }
-    const {
-      success,
-      boardId: newBoardId,
-      error,
-      docsUrl,
-    } = await publishDocsFn({
-      sidebarPath,
-      accessToken,
-      appUrl: discussKitUrl,
-      boardId,
-      autoCreateBoard: true,
-      // Pass additional project information if available
-      boardName: projectInfo.name,
-      boardDesc: projectInfo.description,
-      boardCover: projectInfo.icon,
-      mediaFolder: rawDocsDir,
-      cacheFilePath: publishCacheFilePath,
-      boardMeta,
-      iconMap,
-    });
-
-    // Save values to config.yaml if publish was successful
-    if (success) {
-      // Save appUrl to config only when not using environment variable
-      if (!useEnvAppUrl) {
-        await saveValueToConfig("appUrl", appUrlInfo.origin);
-      }
-
-      // Save boardId to config if it was auto-created
-      if (boardId !== newBoardId) {
-        await saveValueToConfig("boardId", newBoardId);
-      }
-      message = `✅ Documentation published successfully!\n📖 Docs available at: ${chalk.cyan(docsUrl)}`;
-
-      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
-      try {
-        const obj = JSON.parse(error);
-        message = `❌ Publishing failed with error: \n💡 ${obj.message || error}`;
-      } catch {
-        if (error?.includes("401")) {
-          message = `❌ Publishing failed due to an authorization error: \n💡 Please run ${chalk.cyan("aigne doc clear")} to reset your credentials and try again.`;
-        } else if (error?.includes("403")) {
-          message = `❌ Publishing failed due to an authorization error: \n💡 You’re not the creator of this document (Board ID: ${boardId}). You can change the board ID and try again. \n💡  Or run ${chalk.cyan("aigne doc clear")} to reset your credentials and try again.`;
-        }
-      }
-    }
-
-    // clean up tmp work dir
-    await fs.rm(docsDir, { recursive: true, force: true });
-  } catch (error) {
-    message = `❌ Sorry, I encountered an error while publishing your documentation: \n\n${error.message}`;
-
-    // clean up tmp work dir in case of error
-    try {
-      const docsDir = join(DOC_SMITH_DIR, TMP_DIR, TMP_DOCS_DIR);
-      await fs.rm(docsDir, { recursive: true, force: true });
-    } catch {
-      // Ignore cleanup errors
-    }
-  }
-
-  return message ? { message } : {};
-}
-
-publishDocs.input_schema = {
-  type: "object",
-  properties: {
-    docsDir: {
-      type: "string",
-      description: "The directory of the documentation.",
-    },
-    appUrl: {
-      type: "string",
-      description: "The URL of the app.",
-    },
-    boardId: {
-      type: "string",
-      description: "The ID of the board.",
-    },
-    "with-branding": {
-      type: "boolean",
-      description: "Update the website branding (title, description, and logo).",
-    },
-    projectName: {
-      type: "string",
-      description: "The name of the project.",
-    },
-    projectDesc: {
-      type: "string",
-      description: "A description of the project.",
-    },
-    projectLogo: {
-      type: "string",
-      description: "The logo or icon of the project.",
-    },
-  },
-};
-
-publishDocs.description = "Publish the documentation to a website";

package/agents/publish/translate-meta.mjs

@@ -1,103 +0,0 @@
-import { join } from "node:path";
-
-import { AIAgent } from "@aigne/core";
-import fs from "fs-extra";
-import { parse as yamlParse, stringify as yamlStringify } from "yaml";
-import z from "zod";
-
-import { DOC_SMITH_DIR } from "../../utils/constants/index.mjs";
-
-export default async function translateMeta(
-  { projectName, projectDesc, locale, translateLanguages = [] },
-  options,
-) {
-  const languages = [...new Set([...(locale ? [locale] : []), ...(translateLanguages || [])])];
-
-  const translationCacheFilePath = join(DOC_SMITH_DIR, "translation-cache.yaml");
-  await fs.ensureFile(translationCacheFilePath);
-  const translationCache = await fs.readFile(translationCacheFilePath, "utf-8");
-  const parsedTranslationCache = yamlParse(translationCache || "{}");
-
-  const titleTranslation = parsedTranslationCache[projectName] || {};
-  const descTranslation = parsedTranslationCache[projectDesc] || {};
-
-  const titleLanguages = languages.filter((lang) => !titleTranslation[lang]);
-  const descLanguages = languages.filter((lang) => !descTranslation[lang]);
-  const titleTranslationSchema = z.object(
-    titleLanguages.reduce((shape, lang) => {
-      shape[lang] = z.string();
-      return shape;
-    }, {}),
-  );
-  const descTranslationSchema = z.object(
-    descLanguages.reduce((shape, lang) => {
-      shape[lang] = z.string();
-      return shape;
-    }, {}),
-  );
-
-  const agent = AIAgent.from({
-    name: "translateMeta",
-    instructions:
-      "You are an **Elite Polyglot Localization and Translation Specialist** with extensive professional experience across multiple domains. Your core mission is to produce translations that are not only **100% accurate** to the source meaning but are also **natively fluent, highly readable, and culturally appropriate** in the target language.",
-    inputKey: "message",
-    outputSchema: z.object({
-      title: titleTranslationSchema.describe("Translated titles with language codes as keys"),
-      desc: descTranslationSchema.describe("Translated descriptions with language codes as keys"),
-    }),
-  });
-  if (titleLanguages.length > 0 || descLanguages.length > 0) {
-    const translatedMetadata = await options.context.invoke(agent, {
-      message: `Translate the following title and description into all target languages except the source language. Provide the translations in a JSON object with the language codes as keys. If the project title or description is empty, return an empty string for that field.
-
-Project Title: ${projectName || ""}
-Project Description: ${projectDesc || ""}
-
-Target Languages: { title: ${titleLanguages.join(", ")}, desc: ${descLanguages.join(", ")} }
-Source Language: ${locale}
-
-Respond with a JSON object in the following format:
-{
-  "title": {
-    "fr": "Translated Project Title in French",
-    "es": "Translated Project Title in Spanish",
-    ...
-  },
-  "desc": {
-    "fr": "Translated Project Description in French",
-    "es": "Translated Project Description in Spanish",
-    ...
-  }
-}
-
-If no translation is needed, respond with:
-{
-  "title": {},
-  "desc": {}
-}`,
-    });
-    Object.keys(translatedMetadata.title || {}).forEach((lang) => {
-      if (translatedMetadata.title[lang]) {
-        titleTranslation[lang] = translatedMetadata.title[lang];
-      }
-    });
-    Object.keys(translatedMetadata.desc || {}).forEach((lang) => {
-      if (translatedMetadata.desc[lang]) {
-        descTranslation[lang] = translatedMetadata.desc[lang];
-      }
-    });
-  }
-  const saveResult = {
-    ...parsedTranslationCache,
-    [projectName]: titleTranslation,
-    [projectDesc]: descTranslation,
-  };
-  await fs.writeFile(translationCacheFilePath, yamlStringify(saveResult), { encoding: "utf8" });
-
-  return {
-    translatedMetadata: {
-      title: saveResult[projectName] || {},
-      desc: saveResult[projectDesc] || {},
-    },
-  };
-}

package/agents/schema/document-structure-item.yaml

@@ -1,26 +0,0 @@
-type: object
-description: Document structure item representing a node in the document hierarchy
-properties:
-  title:
-    type: string
-  description:
-    type: string
-  path:
-    type: string
-    description: Path in URL format, cannot be empty, cannot contain spaces or special characters, must start with /, no need to include language level, e.g., /zh/about should return /about
-  parentPath:
-    type: string
-    description: Parent node path, if null indicates it is a top-level node
-  sourceIds:
-    type: array
-    description: Associated sourceId from `<data_sources>` for subsequent translation and content generation, must come from sourceId in `<data_sources>`, cannot have fake ids, **cannot be empty**
-    items:
-      type: string
-  icon:
-    type: string
-    description: Lucide icon name for root-level documents (just support lucide:icon-name, not support other icon collections)
-required:
-  - title
-  - description
-  - path
-  - sourceIds

package/agents/schema/document-structure-refine-item.yaml

@@ -1,23 +0,0 @@
-type: object
-description: Document structure item representing a node in the document hierarchy
-properties:
-  id:
-    type: string
-    description: Unique identifier for the document structure item
-  title:
-    type: string
-  description:
-    type: string
-  path:
-    type: string
-    description: Path in URL format, cannot be empty, cannot contain spaces or special characters, must start with /, no need to include language level, e.g., /zh/about should return /about
-  parentPath:
-    type: string
-    description: Parent node path, if null indicates it is a top-level node
-  icon: 
-    type: string
-    description: Iconify icon name, e.g., lucide:book, lucide:rocket, lucide:* etc.
-required:
-  - title
-  - description
-  - path

package/agents/schema/document-structure.yaml

@@ -1,29 +0,0 @@
-type: array
-items:
-  type: object
-  properties:
-    title:
-      type: string
-    description:
-      type: string
-    path:
-      type: string
-      description: Path in URL format, cannot be empty, cannot contain spaces or special characters, must start with /, no need to include language level, e.g., /zh/about should return /about
-    parentId:
-      type:
-        - string
-        - "null"
-      description: Parent node path, if null indicates it is a top-level node
-    sourceIds:
-      type: array
-      description: Associated sourceId from `<data_sources>` for subsequent translation and content generation, must come from sourceId in `<data_sources>`, cannot have fake ids, **cannot be empty**
-      items:
-        type: string
-    icon:
-      type: string
-      description: Lucide icon name for root-level documents (just support lucide:icon-name, not support other icon collections)
-  required:
-    - title
-    - description
-    - path
-    - sourceIds

package/agents/update/batch-generate-document.yaml

@@ -1,27 +0,0 @@
-type: team
-name: batchGenerateDocument
-description: Batch generate document details
-skills:
-  - ./check-document.mjs
-input_schema:
-  type: object
-  properties:
-    detailDataSource:
-      type: string
-      description: Context for documentation structure generation, used to assist generate documentation structure
-    documentStructure: ../schema/document-structure.yaml
-    translates:
-      type: array
-      items:
-        type: object
-        properties:
-          language:
-            type: string
-      description: List of languages to translate documents to
-    modifiedFiles:
-      type: array
-      items: { type: string }
-      description: Array of modified files since last generation
-iterate_on: documentStructure
-concurrency: 5
-mode: sequential

package/agents/update/batch-update-document.yaml

@@ -1,7 +0,0 @@
-
-type: team
-name: batchUpdateDocument
-skills:
-  - ../update/handle-document-update.yaml
-iterate_on: selectedDocs
-concurrency: 5

package/agents/update/check-diagram-flag.mjs

@@ -1,116 +0,0 @@
-/**
- * Check if --diagram or --diagram-all flag is set via command line arguments or environment variable
- * Returns the flag values and passes through all input
- *
- * --diagram: Filter to show only documents with diagrams, let user select
- * --diagram-all: Auto-select all documents with diagrams, no user selection
- */
-export default function checkDiagramFlag(input) {
-  let shouldUpdateDiagrams = false;
-  let shouldAutoSelectDiagrams = false;
-
-  // Priority order: command line args > input params > environment variables
-  // Check command line arguments first (highest priority)
-  if (process.argv) {
-    // Check for --diagram-all or -da (exact match)
-    const hasDiagramAllFlag = process.argv.some((arg) => arg === "--diagram-all" || arg === "-da");
-
-    const hasDiagramFlag = process.argv.some((arg) => arg === "--diagram" || arg === "-d");
-
-    if (hasDiagramAllFlag) {
-      shouldUpdateDiagrams = true;
-      shouldAutoSelectDiagrams = true;
-      // Return early if CLI arg found (highest priority)
-      return {
-        ...input,
-        shouldUpdateDiagrams,
-        shouldAutoSelectDiagrams,
-      };
-    } else if (hasDiagramFlag) {
-      shouldUpdateDiagrams = true;
-      shouldAutoSelectDiagrams = false;
-      // Return early if CLI arg found (highest priority)
-      return {
-        ...input,
-        shouldUpdateDiagrams,
-        shouldAutoSelectDiagrams,
-      };
-    }
-  }
-
-  // Check input parameter (second priority - CLI framework might parse --diagram-all as separate parameter)
-  if (input["diagram-all"] === true || input["diagram-all"] === "true") {
-    shouldUpdateDiagrams = true;
-    shouldAutoSelectDiagrams = true;
-    // Return early if input param found (second priority)
-    return {
-      ...input,
-      shouldUpdateDiagrams,
-      shouldAutoSelectDiagrams,
-    };
-  } else if (input.diagram === true || input.diagram === "true") {
-    shouldUpdateDiagrams = true;
-    shouldAutoSelectDiagrams = false;
-    // Return early if input param found (second priority)
-    return {
-      ...input,
-      shouldUpdateDiagrams,
-      shouldAutoSelectDiagrams,
-    };
-  }
-
-  // Check environment variable (lowest priority)
-  if (
-    process.env.DOC_SMITH_UPDATE_DIAGRAMS === "all" ||
-    process.env.DOC_SMITH_UPDATE_DIAGRAMS_ALL === "true" ||
-    process.env.DOC_SMITH_UPDATE_DIAGRAMS_ALL === "1"
-  ) {
-    shouldUpdateDiagrams = true;
-    shouldAutoSelectDiagrams = true;
-  } else if (
-    process.env.DOC_SMITH_UPDATE_DIAGRAMS === "true" ||
-    process.env.DOC_SMITH_UPDATE_DIAGRAMS === "1"
-  ) {
-    shouldUpdateDiagrams = true;
-    shouldAutoSelectDiagrams = false;
-  }
-
-  // Return all input plus the flags
-  return {
-    ...input,
-    shouldUpdateDiagrams,
-    shouldAutoSelectDiagrams,
-  };
-}
-
-checkDiagramFlag.input_schema = {
-  type: "object",
-  properties: {
-    diagram: {
-      type: ["boolean", "string"],
-      description:
-        "Flag to trigger diagram update: true for user selection (can also use --diagram CLI arg)",
-    },
-    "diagram-all": {
-      type: ["boolean", "string"],
-      description:
-        "Flag to auto-select all documents with diagrams (can also use --diagram-all CLI arg)",
-    },
-  },
-};
-
-checkDiagramFlag.output_schema = {
-  type: "object",
-  properties: {
-    shouldUpdateDiagrams: {
-      type: "boolean",
-      description: "Whether to filter and update diagrams",
-    },
-    shouldAutoSelectDiagrams: {
-      type: "boolean",
-      description:
-        "Whether to auto-select all documents with diagrams (true for --diagram-all, false for --diagram)",
-    },
-  },
-  required: ["shouldUpdateDiagrams", "shouldAutoSelectDiagrams"],
-};