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

package/types/document-structure-schema.mjs

@@ -1,261 +0,0 @@
-import { z } from "zod";
-import { zodToJsonSchema } from "zod-to-json-schema";
-
-// Document item schema - represents a single document in the structure
-export const documentItemSchema = z.object({
-  title: z.string().min(1, "Title is required"),
-  description: z.string().min(1, "Description is required"),
-  path: z.string().startsWith("/", 'Path must start with "/"'),
-  parentId: z.string().nullish(),
-  sourceIds: z.array(z.string()).min(1, "At least one source ID is required"),
-  icon: z.string().optional(), // Lucide icon name (e.g., lucide:book) for root-level documents
-});
-
-// Documentation structure schema - represents the entire documentation structure array
-export const documentStructureSchema = z.array(documentItemSchema);
-
-// Add document schemas
-export const addDocumentInputSchema = z.object({
-  title: z.string().min(1, "Title is required"),
-  description: z.string().min(1, "Description is required"),
-  path: z.string().startsWith("/", 'Path must start with "/"'),
-  parentId: z.string().nullish(),
-  sourceIds: z.array(z.string()).min(1, "At least one source ID is required"),
-});
-
-export const addDocumentOutputSchema = z.object({
-  documentStructure: documentStructureSchema,
-  message: z.string().optional(),
-  addedDocument: documentItemSchema.optional(),
-  error: z.object({ message: z.string() }).optional(),
-});
-
-// Delete document schemas
-export const deleteDocumentInputSchema = z.object({
-  path: z.string().min(1, "Path is required"),
-  recursive: z.boolean().optional(),
-});
-
-export const deleteDocumentOutputSchema = z.object({
-  documentStructure: documentStructureSchema,
-  message: z.string().optional(),
-  deletedDocuments: z.array(documentItemSchema).optional(),
-  error: z.object({ message: z.string() }).optional(),
-});
-
-// Move document schemas
-export const moveDocumentInputSchema = z.object({
-  path: z.string().min(1, "Path is required"),
-  newParentId: z.string().nullish(),
-});
-
-export const moveDocumentOutputSchema = z.object({
-  documentStructure: documentStructureSchema,
-  message: z.string().optional(),
-  originalDocument: documentItemSchema.optional(),
-  updatedDocument: documentItemSchema.optional(),
-  error: z.object({ message: z.string() }).optional(),
-});
-
-// Update document schemas
-export const updateDocumentInputSchema = z
-  .object({
-    path: z.string().min(1, "Path is required"),
-    title: z.string().min(1).optional(),
-    description: z.string().min(1).optional(),
-    sourceIds: z.array(z.string()).min(1).optional(),
-  })
-  .refine(
-    (data) =>
-      data.title !== undefined || data.description !== undefined || data.sourceIds !== undefined,
-    {
-      message: "At least one field (title, description, or sourceIds) must be provided for update",
-    },
-  );
-
-export const updateDocumentOutputSchema = z.object({
-  documentStructure: documentStructureSchema,
-  message: z.string().optional(),
-  originalDocument: documentItemSchema.optional(),
-  updatedDocument: documentItemSchema.optional(),
-  error: z.object({ message: z.string() }).optional(),
-});
-
-// JSON Schema conversion functions using zodToJsonSchema
-export const getAddDocumentInputJsonSchema = () => {
-  const schema = zodToJsonSchema(addDocumentInputSchema);
-  // Add custom descriptions
-  if (schema.properties) {
-    schema.properties.title.description = "Title of the new document";
-    schema.properties.description.description = "Description of the new document";
-    schema.properties.path.description = "URL path for the new document (must start with '/')";
-    schema.properties.parentId.description =
-      "Parent document path (leave empty for top-level documents)";
-    schema.properties.sourceIds.description =
-      "Source references from associated data sources (required)";
-  }
-  return schema;
-};
-
-export const getAddDocumentOutputJsonSchema = () => {
-  const schema = zodToJsonSchema(addDocumentOutputSchema);
-  if (schema.properties) {
-    schema.properties.documentStructure.description =
-      "Updated documentation structure array with the new document added";
-    schema.properties.message.description = "Success message describing the operation result";
-    schema.properties.addedDocument.description = "The newly added document object";
-    schema.properties.error.description =
-      "Error object containing error message if operation failed";
-  }
-  return schema;
-};
-
-export const getDeleteDocumentInputJsonSchema = () => {
-  const schema = zodToJsonSchema(deleteDocumentInputSchema);
-  if (schema.properties) {
-    schema.properties.path.description = "URL path of the document to delete";
-    schema.properties.recursive.description =
-      "If true, recursively delete all child documents. If false or not provided, deletion will fail if child documents exist.";
-  }
-  return schema;
-};
-
-export const getDeleteDocumentOutputJsonSchema = () => {
-  const schema = zodToJsonSchema(deleteDocumentOutputSchema);
-  if (schema.properties) {
-    schema.properties.documentStructure.description =
-      "Updated documentation structure array with the document removed";
-    schema.properties.message.description = "Success message describing the operation result";
-    schema.properties.deletedDocuments.description =
-      "Array of deleted document objects (includes all recursively deleted child documents if recursive=true)";
-    schema.properties.error.description =
-      "Error object containing error message if operation failed";
-  }
-  return schema;
-};
-
-export const getMoveDocumentInputJsonSchema = () => {
-  const schema = zodToJsonSchema(moveDocumentInputSchema);
-  if (schema.properties) {
-    schema.properties.path.description = "URL path of the document to move";
-    schema.properties.newParentId.description =
-      "Path of the new parent document (leave empty for top-level)";
-  }
-  return schema;
-};
-
-export const getMoveDocumentOutputJsonSchema = () => {
-  const schema = zodToJsonSchema(moveDocumentOutputSchema);
-  if (schema.properties) {
-    schema.properties.documentStructure.description =
-      "Updated documentation structure array with the document moved";
-    schema.properties.message.description = "Success message describing the operation result";
-    schema.properties.originalDocument.description = "The original document object before moving";
-    schema.properties.updatedDocument.description = "The updated document object after moving";
-    schema.properties.error.description =
-      "Error object containing error message if operation failed";
-  }
-  return schema;
-};
-
-export const getUpdateDocumentInputJsonSchema = () => {
-  const schema = zodToJsonSchema(updateDocumentInputSchema);
-  if (schema.properties) {
-    schema.properties.path.description = "URL path of the document to update";
-    schema.properties.title.description = "New title for the document (optional)";
-    schema.properties.description.description = "New description for the document (optional)";
-    schema.properties.sourceIds.description =
-      "New source references for the document (optional, cannot be empty if provided)";
-  }
-  // Add anyOf constraint for at least one update field
-  schema.anyOf = [
-    { required: ["title"] },
-    { required: ["description"] },
-    { required: ["sourceIds"] },
-  ];
-  return schema;
-};
-
-export const getUpdateDocumentOutputJsonSchema = () => {
-  const schema = zodToJsonSchema(updateDocumentOutputSchema);
-  if (schema.properties) {
-    schema.properties.documentStructure.description =
-      "Updated documentation structure array with the document modified";
-    schema.properties.message.description = "Success message describing the operation result";
-    schema.properties.originalDocument.description = "The original document object before update";
-    schema.properties.updatedDocument.description =
-      "The updated document object after modification";
-    schema.properties.error.description =
-      "Error object containing error message if operation failed";
-  }
-  return schema;
-};
-
-// Validation helper functions
-export const validateAddDocumentInput = (input) => {
-  try {
-    return {
-      success: true,
-      data: addDocumentInputSchema.parse(input),
-    };
-  } catch (error) {
-    return {
-      success: false,
-      error:
-        error.errors?.map((err) => `${err.path.join(".")}: ${err.message}`).join(", ") ||
-        error.message,
-    };
-  }
-};
-
-export const validateDeleteDocumentInput = (input) => {
-  try {
-    return {
-      success: true,
-      data: deleteDocumentInputSchema.parse(input),
-    };
-  } catch (error) {
-    return {
-      success: false,
-      error:
-        error.errors?.map((err) => `${err.path.join(".")}: ${err.message}`).join(", ") ||
-        error.message,
-    };
-  }
-};
-
-export const validateMoveDocumentInput = (input) => {
-  try {
-    return {
-      success: true,
-      data: moveDocumentInputSchema.parse(input),
-    };
-  } catch (error) {
-    return {
-      success: false,
-      error:
-        error.errors?.map((err) => `${err.path.join(".")}: ${err.message}`).join(", ") ||
-        error.message,
-    };
-  }
-};
-
-export const validateUpdateDocumentInput = (input) => {
-  try {
-    return {
-      success: true,
-      data: updateDocumentInputSchema.parse(input),
-    };
-  } catch (error) {
-    return {
-      success: false,
-      error:
-        error.errors?.map((err) => `${err.path.join(".")}: ${err.message}`).join(", ") ||
-        error.message,
-    };
-  }
-};
-
-// Type inference helpers for better IDE support
-export const createDocumentItem = (data) => documentItemSchema.parse(data);
-export const createDocumentStructure = (data) => documentStructureSchema.parse(data);

package/utils/auth-utils.mjs

@@ -1,275 +0,0 @@
-import { existsSync, mkdirSync } from "node:fs";
-import { homedir } from "node:os";
-import { join } from "node:path";
-import { createConnect } from "@aigne/cli/utils/aigne-hub/credential.js";
-import chalk from "chalk";
-import open from "open";
-import { joinURL, withQuery } from "ufo";
-import {
-  ComponentNotFoundError,
-  getComponentMountPoint,
-  InvalidBlockletError,
-} from "./blocklet.mjs";
-import {
-  BLOCKLET_ADD_COMPONENT_DOCS,
-  CLOUD_SERVICE_URL_PROD,
-  CLOUD_SERVICE_URL_STAGING,
-  DISCUSS_KIT_DID,
-  DISCUSS_KIT_STORE_URL,
-  PAYMENT_KIT_DID,
-} from "./constants/index.mjs";
-import { createStore } from "./store/index.mjs";
-
-const WELLKNOWN_SERVICE_PATH_PREFIX = "/.well-known/service";
-
-const TIMEOUT_MINUTES = 5; // Just wait 5 min
-const FETCH_INTERVAL = 3000; // 3 seconds
-
-const RETRY_COUNT = (TIMEOUT_MINUTES * 60 * 1000) / FETCH_INTERVAL;
-
-/**
- * Get access token from environment, config file, or prompt user for authorization
- * @param {string} baseUrl - The application URL
- * @returns {Promise<string>} - The access token
- */
-export async function getCachedAccessToken(baseUrl) {
-  const { hostname: targetHostname } = new URL(baseUrl);
-  const store = await createStore();
-
-  let accessToken =
-    process.env.DOC_SMITH_PUBLISH_ACCESS_TOKEN || process.env.DOC_DISCUSS_KIT_ACCESS_TOKEN;
-
-  // Check if access token exists in environment or config file
-  if (!accessToken) {
-    try {
-      const storeItem = await store.getItem(targetHostname);
-      accessToken = storeItem?.DOC_DISCUSS_KIT_ACCESS_TOKEN;
-    } catch (error) {
-      console.warn("Could not read the configuration file:", error.message);
-    }
-  }
-
-  return accessToken;
-}
-
-export const getDiscussKitMountPoint = async (origin) => {
-  try {
-    const mountPoint = await getComponentMountPoint(origin, DISCUSS_KIT_DID);
-    return mountPoint;
-  } catch (error) {
-    const storeLink = chalk.cyan(DISCUSS_KIT_STORE_URL);
-    if (error instanceof InvalidBlockletError) {
-      throw new Error(
-        `${chalk.yellow("⚠️  The provided URL is not a valid ArcBlock-powered website.")}\n\n` +
-          `${chalk.bold("💡 Solution:")} To host your documentation, you can get a website from the ArcBlock store:\n${storeLink}\n\n`,
-      );
-    } else if (error instanceof ComponentNotFoundError) {
-      const docsLink = chalk.cyan(BLOCKLET_ADD_COMPONENT_DOCS);
-      throw new Error(
-        `${chalk.yellow("⚠️ This website is missing the required components for publishing.")}\n\n` +
-          `${chalk.bold(
-            "💡 Solution:",
-          )} Please refer to the documentation to add the Discuss Kit component:\n${docsLink}\n\n`,
-      );
-    } else {
-      throw new Error(
-        `❌ Could not connect to: ${chalk.cyan(origin)}\n\n` +
-          `${chalk.bold("Possible causes:")}\n` +
-          `• There may be a network issue.\n` +
-          `• The server may be temporarily unavailable.\n` +
-          `• The URL may be incorrect.\n\n` +
-          `${chalk.green("Suggestion:")} Please check your network connection and the URL, then try again.`,
-      );
-    }
-  }
-};
-
-/**
- * Get access token from environment, config file, or prompt user for authorization
- * @param {string} appUrl - The application URL
- * @returns {Promise<string>} - The access token
- */
-export async function getAccessToken(appUrl, ltToken = "", locale = "en") {
-  const { hostname: targetHostname, origin: targetOrigin } = new URL(appUrl);
-
-  let accessToken = await getCachedAccessToken(targetOrigin);
-
-  // If still no access token, prompt user to authorize
-  if (accessToken) {
-    return accessToken;
-  }
-
-  const connectUrl = joinURL(targetOrigin, WELLKNOWN_SERVICE_PATH_PREFIX);
-
-  try {
-    const result = await createConnect({
-      connectUrl: connectUrl,
-      connectAction: "gen-simple-access-key",
-      source: `AIGNE DocSmith connect to website`,
-      closeOnSuccess: true,
-      appName: "AIGNE DocSmith",
-      appLogo: "https://docsmith.aigne.io/image-bin/uploads/9645caf64b4232699982c4d940b03b90.svg",
-      retry: RETRY_COUNT,
-      fetchInterval: FETCH_INTERVAL,
-      openPage: async (pageUrl) => {
-        const url = new URL(pageUrl);
-        const isOfficial = [CLOUD_SERVICE_URL_PROD, CLOUD_SERVICE_URL_STAGING].includes(url.origin);
-        if (!isOfficial) {
-          url.searchParams.set("required_roles", "owner,admin");
-        }
-        if (ltToken) {
-          url.searchParams.set("__lt", ltToken);
-        }
-        url.searchParams.set("locale", locale);
-
-        let connectUrl = url.toString();
-        open(connectUrl);
-
-        try {
-          const officialBaseUrl = process.env.DOC_SMITH_BASE_URL || CLOUD_SERVICE_URL_PROD;
-          const mountPoint = await getComponentMountPoint(officialBaseUrl, PAYMENT_KIT_DID);
-          const response = await fetch(
-            withQuery(joinURL(officialBaseUrl, mountPoint, "/api/tool/short-connect-url"), {
-              url: connectUrl,
-              locale,
-            }),
-          );
-          const data = await response.json();
-          if (data.url) {
-            connectUrl = data.url;
-          }
-        } catch {
-          // Ignore error
-        }
-
-        console.log(
-          "🔗 Please open the following URL in your browser to authorize access:",
-          chalk.cyan(connectUrl),
-          "\n",
-        );
-      },
-    });
-
-    accessToken = result.accessKeySecret;
-    process.env.DOC_SMITH_PUBLISH_ACCESS_TOKEN = accessToken;
-    process.env.DOC_DISCUSS_KIT_ACCESS_TOKEN = accessToken;
-
-    // Save the access token to config file
-    await saveTokenToConfigFile(targetHostname, { DOC_DISCUSS_KIT_ACCESS_TOKEN: accessToken });
-  } catch {
-    throw new Error(
-      `${chalk.yellow("⚠️ Failed to obtain access token. This may be due to network issues or authorization timeout.")}\n\n` +
-        `${chalk.bold("💡 Solution:")}\n` +
-        `  • Step 1: Ensure your network can access the service URL: ${chalk.cyan(targetOrigin)}\n` +
-        `  • Step 2: Run ${chalk.cyan("aigne doc publish")} again\n` +
-        `  • Step 3: If prompted, select ${chalk.cyan("Resume previous website setup")} to continue from where you left off\n\n`,
-    );
-  }
-
-  return accessToken;
-}
-
-/**
- * Gets the official access token from the environment, config file, or prompts the user to authorize.
- * @param {string} baseUrl - The official service URL.
- * @returns {Promise<string>} The access token.
- */
-export async function getOfficialAccessToken(baseUrl, openPage = true, locale = "en") {
-  if (!baseUrl) {
-    throw new Error("The baseUrl parameter is required for getOfficialAccessToken.");
-  }
-
-  // Parse URL once and reuse
-  const { hostname: targetHostname, origin: targetOrigin } = new URL(baseUrl);
-
-  // 1. Check environment variable
-  let accessToken = await getCachedAccessToken(targetOrigin);
-
-  // If token is found, return it
-  if (accessToken || !openPage) {
-    return accessToken;
-  }
-
-  // Generate new access token
-  const connectUrl = joinURL(targetOrigin, WELLKNOWN_SERVICE_PATH_PREFIX);
-
-  try {
-    const result = await createConnect({
-      connectUrl,
-      connectAction: "gen-simple-access-key",
-      source: "AIGNE DocSmith connect to official service",
-      closeOnSuccess: true,
-      retry: RETRY_COUNT,
-      fetchInterval: FETCH_INTERVAL,
-      appName: "AIGNE DocSmith",
-      appLogo: "https://docsmith.aigne.io/image-bin/uploads/9645caf64b4232699982c4d940b03b90.svg",
-      openPage: async (pageUrl) => {
-        const url = new URL(pageUrl);
-        if (locale) {
-          url.searchParams.set("locale", locale);
-        }
-
-        let connectUrl = url.toString();
-        open(connectUrl);
-        try {
-          const officialBaseUrl = process.env.DOC_SMITH_BASE_URL || CLOUD_SERVICE_URL_PROD;
-          const mountPoint = await getComponentMountPoint(officialBaseUrl, PAYMENT_KIT_DID);
-          const response = await fetch(
-            withQuery(joinURL(officialBaseUrl, mountPoint, "/api/tool/short-connect-url"), {
-              url: connectUrl,
-              locale,
-            }),
-          );
-          const data = await response.json();
-          if (data.url) {
-            connectUrl = data.url;
-          }
-        } catch {
-          // Ignore error
-        }
-
-        console.log(
-          "🔗 Please open the following URL in your browser to authorize access:",
-          chalk.cyan(connectUrl),
-          "\n",
-        );
-      },
-    });
-
-    accessToken = result.accessKeySecret;
-
-    // Save the access token to config file
-    await saveTokenToConfigFile(targetHostname, { DOC_DISCUSS_KIT_ACCESS_TOKEN: accessToken });
-  } catch {
-    throw new Error(
-      `${chalk.yellow("⚠️ Failed to obtain official access token. This may be due to network issues or authorization timeout.")}\n\n` +
-        `${chalk.bold("💡 Solution:")}\n` +
-        `  • Step 1: Ensure your network can access the official service URL: ${chalk.cyan(targetOrigin)}\n` +
-        `  • Step 2: Run ${chalk.cyan("aigne doc publish")} again\n\n`,
-    );
-  }
-
-  return accessToken;
-}
-
-/**
- * Saves the access token and related fields to the configuration file.
- * @param {string} configFile - The path to the config file.
- * @param {string} hostname - The hostname key.
- * @param {Object} fields - Fields to save (e.g., { DOC_DISCUSS_KIT_ACCESS_TOKEN: "..." }).
- */
-async function saveTokenToConfigFile(hostname, fields) {
-  try {
-    const store = await createStore();
-
-    const aigneDir = join(homedir(), ".aigne");
-    if (!existsSync(aigneDir)) {
-      mkdirSync(aigneDir, { recursive: true });
-    }
-
-    await store.setItem(hostname, fields);
-  } catch (error) {
-    console.warn(`Could not save the token to the configuration file: ${error.message}`, error);
-    // The token is already in the environment, so we don't need to throw an error here.
-  }
-}

package/utils/blocklet.mjs

@@ -1,104 +0,0 @@
-import { joinURL } from "ufo";
-
-/**
- * Custom error class for invalid blocklet application URLs.
- */
-export class InvalidBlockletError extends Error {
-  constructor(url, status, statusText) {
-    super(`The application URL "${url}" is invalid. I was unable to fetch the configuration.`);
-    this.name = "InvalidBlockletError";
-    this.url = url;
-    this.status = status;
-    this.statusText = statusText;
-  }
-}
-
-/**
- * Custom error class for missing component mount points.
- */
-export class ComponentNotFoundError extends Error {
-  constructor(did, appUrl) {
-    super(`Your website "${appUrl}" is missing a required component to host your documentation.`);
-    this.name = "ComponentNotFoundError";
-    this.did = did;
-    this.appUrl = appUrl;
-  }
-}
-
-const BLOCKLET_INFO_CACHE = {};
-
-// Export for testing purposes
-export function clearBlockletCache() {
-  Object.keys(BLOCKLET_INFO_CACHE).forEach((key) => {
-    delete BLOCKLET_INFO_CACHE[key];
-  });
-}
-
-export async function getComponentInfo(appUrl) {
-  const blockletJsUrl = joinURL(appUrl, "__blocklet__.js?type=json");
-
-  const cacheInfo = BLOCKLET_INFO_CACHE[appUrl];
-
-  // Cache for 10 min
-  if (cacheInfo) {
-    if (Date.now() > cacheInfo.__blocklet_info_cache_timestamp + 1000 * 60 * 10) {
-      delete BLOCKLET_INFO_CACHE[appUrl];
-    } else {
-      // Return a copy without the cache timestamp
-      const { __blocklet_info_cache_timestamp, ...config } = cacheInfo;
-      return config;
-    }
-  }
-
-  let blockletJs;
-  try {
-    blockletJs = await fetch(blockletJsUrl, {
-      method: "GET",
-      headers: { Accept: "application/json" },
-    });
-  } catch (error) {
-    throw new InvalidBlockletError(appUrl, null, error.message);
-  }
-
-  if (!blockletJs.ok) {
-    throw new InvalidBlockletError(appUrl, blockletJs.status, blockletJs.statusText);
-  }
-
-  let config;
-  try {
-    config = await blockletJs.json();
-    BLOCKLET_INFO_CACHE[appUrl] = {
-      ...config,
-      __blocklet_info_cache_timestamp: Date.now(),
-    };
-  } catch {
-    throw new InvalidBlockletError(appUrl, null, "The server returned an invalid JSON response.");
-  }
-
-  return config;
-}
-
-export async function getComponentMountPoint(appUrl, did) {
-  const config = await getComponentInfo(appUrl);
-
-  const component = config.componentMountPoints?.find((component) => component.did === did);
-  if (!component) {
-    throw new ComponentNotFoundError(did, appUrl);
-  }
-
-  return component.mountPoint;
-}
-
-export async function getComponentInfoWithMountPoint(appUrl, did) {
-  const config = await getComponentInfo(appUrl);
-
-  const component = config.componentMountPoints?.find((component) => component.did === did);
-  if (!component) {
-    throw new ComponentNotFoundError(did, appUrl);
-  }
-
-  return {
-    ...config,
-    mountPoint: component.mountPoint,
-  };
-}