@aigne/doc-smith 0.9.10 → 0.9.11-beta

package/agents/create/document-structure-tools/add-document.mjs

@@ -1,85 +0,0 @@
-import {
-  getAddDocumentInputJsonSchema,
-  getAddDocumentOutputJsonSchema,
-  validateAddDocumentInput,
-} from "../../../types/document-structure-schema.mjs";
-import streamlineDocumentTitlesIfNeeded from "../../utils/streamline-document-titles-if-needed.mjs";
-
-export default async function addDocument(input, options) {
-  // Validate input using Zod schema
-  const validation = validateAddDocumentInput(input);
-  if (!validation.success) {
-    const errorMessage = `Cannot add document: ${validation.error}`;
-    console.log(`⚠️  ${errorMessage}`);
-    return {
-      documentStructure: input.documentStructure,
-      error: { message: errorMessage },
-    };
-  }
-
-  const { title, description, path, parentId, sourceIds } = validation.data;
-  let documentStructure = options?.context?.userContext?.currentStructure;
-
-  if (!documentStructure) {
-    documentStructure = input.documentStructure;
-  }
-
-  // Validate parent exists if parentId is provided
-  if (parentId && parentId !== "null") {
-    const parentExists = documentStructure.some((item) => item.path === parentId);
-    if (!parentExists) {
-      const errorMessage = `Cannot add document: Parent document '${parentId}' not found.`;
-      console.log(`⚠️  ${errorMessage}`);
-      return {
-        documentStructure,
-        error: { message: errorMessage },
-      };
-    }
-  }
-
-  // Check if document with same path already exists
-  const existingDocument = documentStructure.find((item) => item.path === path);
-  if (existingDocument) {
-    const errorMessage = `Cannot add document: A document with path '${path}' already exists. Choose a different path.`;
-    console.log(`⚠️  ${errorMessage}`);
-    return {
-      documentStructure,
-      error: { message: errorMessage },
-    };
-  }
-
-  // Create new document object
-  const newDocument = {
-    title,
-    description,
-    path,
-    parentId: parentId || null,
-    sourceIds: [...sourceIds], // Create a copy of the array
-  };
-
-  // Streamline document titles if needed (will streamline the new document if title > 18 characters)
-  await streamlineDocumentTitlesIfNeeded({ documentStructure: [newDocument] }, options);
-
-  // Add the document to the structure
-  const updatedStructure = [...documentStructure, newDocument];
-
-  const successMessage = `addDocument executed successfully.
-  Successfully added document '${title}' with path '${path}'.
-  Check if the latest version of documentStructure meets user feedback, if so, just return 'success'.`;
-
-  // update shared document structure
-  if (options?.context?.userContext) {
-    options.context.userContext.currentStructure = updatedStructure;
-  }
-
-  return {
-    documentStructure: updatedStructure,
-    message: successMessage,
-    addedDocument: newDocument,
-  };
-}
-
-addDocument.taskTitle = "Add document";
-addDocument.description = "Add a document to the documentation structure";
-addDocument.inputSchema = getAddDocumentInputJsonSchema();
-addDocument.outputSchema = getAddDocumentOutputJsonSchema();

package/agents/create/document-structure-tools/delete-document.mjs

@@ -1,116 +0,0 @@
-import {
-  getDeleteDocumentInputJsonSchema,
-  getDeleteDocumentOutputJsonSchema,
-  validateDeleteDocumentInput,
-} from "../../../types/document-structure-schema.mjs";
-import { userContextAt } from "../../../utils/utils.mjs";
-
-export default async function deleteDocument(input, options) {
-  // Validate input using Zod schema
-  const validation = validateDeleteDocumentInput(input);
-  if (!validation.success) {
-    const errorMessage = `Cannot delete document: ${validation.error}`;
-    console.log(`⚠️  ${errorMessage}`);
-    return {
-      documentStructure: input.documentStructure,
-      error: { message: errorMessage },
-    };
-  }
-
-  const { path, recursive = false } = validation.data;
-  let documentStructure = options?.context?.userContext?.currentStructure;
-
-  if (!documentStructure) {
-    documentStructure = input.documentStructure;
-  }
-
-  const deletedPathsContext = userContextAt(options, "deletedPaths");
-  const deletedPaths = deletedPathsContext.get() || [];
-
-  // Check if path has already been deleted
-  if (recursive) {
-    if (deletedPaths.includes(path)) {
-      const message = `Skipping duplicate deletion. Document '${path}' has already been deleted.`;
-      return {
-        documentStructure,
-        message,
-        deletedDocuments: [],
-      };
-    }
-  }
-
-  // Find the document to delete
-  const documentIndex = documentStructure.findIndex((item) => item.path === path);
-  if (documentIndex === -1) {
-    const errorMessage = `Cannot delete document: Document '${path}' does not exist. Please choose an existing document to delete.`;
-    console.log(`⚠️  ${errorMessage}`);
-    return {
-      documentStructure,
-      error: { message: errorMessage },
-    };
-  }
-
-  const documentToDelete = documentStructure[documentIndex];
-
-  // Find all child documents (direct and indirect)
-  const findAllChildren = (parentPath, structure) => {
-    const children = structure.filter((item) => item.parentId === parentPath);
-    const allChildren = [...children];
-    for (const child of children) {
-      allChildren.push(...findAllChildren(child.path, structure));
-    }
-    return allChildren;
-  };
-
-  const childDocuments = findAllChildren(path, documentStructure);
-
-  // If recursive is false and there are child documents, return error
-  if (!recursive && childDocuments.length > 0) {
-    const errorMessage = `Cannot delete document: Document '${path}' has ${
-      childDocuments.length
-    } child document(s): ${childDocuments
-      .map((p) => p.path)
-      .join(
-        ", ",
-      )}. Please first move or delete these child documents, or set recursive=true to delete them all.`;
-    console.log(`⚠️  ${errorMessage}`);
-    return {
-      documentStructure,
-      error: { message: errorMessage },
-    };
-  }
-
-  // Collect all documents to delete (children first, then parent)
-  const documentsToDelete = recursive ? [...childDocuments, documentToDelete] : [documentToDelete];
-  const pathsToDelete = new Set(documentsToDelete.map((doc) => doc.path));
-  const deletedCount = pathsToDelete.size - 1;
-
-  // Remove all documents from the structure
-  const updatedStructure = documentStructure.filter((item) => !pathsToDelete.has(item.path));
-
-  // Add paths to deleted paths
-  if (recursive) {
-    deletedPathsContext.set(deletedPaths.concat(Array.from(pathsToDelete)));
-  }
-
-  // Build success message
-  const successMessage = `deleteDocument executed successfully.
-  Successfully deleted document '${documentToDelete.title}' with path '${path}'${recursive && deletedCount > 0 ? ` along with ${deletedCount} child document(s)` : ""}.
-  Check if the latest version of documentStructure meets user feedback, if so, just return 'success'.`;
-
-  // update shared document structure
-  if (options?.context?.userContext) {
-    options.context.userContext.currentStructure = updatedStructure;
-  }
-
-  return {
-    documentStructure: updatedStructure,
-    message: successMessage,
-    deletedDocuments: documentsToDelete,
-  };
-}
-
-deleteDocument.taskTitle = "Delete document";
-deleteDocument.description = "Remove a document from the documentation structure";
-deleteDocument.inputSchema = getDeleteDocumentInputJsonSchema();
-deleteDocument.outputSchema = getDeleteDocumentOutputJsonSchema();

package/agents/create/document-structure-tools/move-document.mjs

@@ -1,109 +0,0 @@
-import {
-  getMoveDocumentInputJsonSchema,
-  getMoveDocumentOutputJsonSchema,
-  validateMoveDocumentInput,
-} from "../../../types/document-structure-schema.mjs";
-
-export default async function moveDocument(input, options) {
-  // Validate input using Zod schema
-  const validation = validateMoveDocumentInput(input);
-  if (!validation.success) {
-    const errorMessage = `Cannot move document: ${validation.error}`;
-    console.log(`⚠️  ${errorMessage}`);
-    return {
-      documentStructure: input.documentStructure,
-      error: { message: errorMessage },
-    };
-  }
-
-  const { path, newParentId } = validation.data;
-  let documentStructure = options?.context?.userContext?.currentStructure;
-
-  if (!documentStructure) {
-    documentStructure = input.documentStructure;
-  }
-
-  // Find the document to move
-  const documentIndex = documentStructure.findIndex((item) => item.path === path);
-  if (documentIndex === -1) {
-    const errorMessage = `Cannot move document: Document '${path}' does not exist. Please select an existing document to move.`;
-    console.log(`⚠️  ${errorMessage}`);
-    return {
-      documentStructure,
-      error: { message: errorMessage },
-    };
-  }
-
-  const documentToMove = documentStructure[documentIndex];
-
-  // Validate new parent exists if newParentId is provided
-  if (
-    newParentId !== null &&
-    newParentId !== undefined &&
-    newParentId !== "null" &&
-    newParentId !== ""
-  ) {
-    const newParentExists = documentStructure.some((item) => item.path === newParentId);
-    if (!newParentExists) {
-      const errorMessage = `Cannot move document: Target parent document '${newParentId}' does not exist. Please select an existing parent document.`;
-      console.log(`⚠️  ${errorMessage}`);
-      return {
-        documentStructure,
-        error: { message: errorMessage },
-      };
-    }
-
-    // Check for circular dependency: the new parent cannot be a descendant of the document being moved
-    const isDescendant = (parentPath, childPath) => {
-      const children = documentStructure.filter((item) => item.parentId === parentPath);
-      for (const child of children) {
-        if (child.path === childPath || isDescendant(child.path, childPath)) {
-          return true;
-        }
-      }
-      return false;
-    };
-
-    if (isDescendant(path, newParentId)) {
-      const errorMessage = `Cannot move document: Moving '${path}' under '${newParentId}' would create an invalid hierarchy. Please select a parent that is not nested under the document being moved.`;
-      console.log(`⚠️  ${errorMessage}`);
-      return {
-        documentStructure,
-        error: { message: errorMessage },
-      };
-    }
-  }
-
-  // Create updated document object with new parent
-  const updatedDocument = {
-    ...documentToMove,
-    parentId: newParentId || null,
-  };
-
-  // Update the document's position in the structure
-  const updatedStructure = [...documentStructure];
-  updatedStructure[documentIndex] = updatedDocument;
-
-  const newParentText = newParentId ? `'${newParentId}'` : "root level";
-  const successMessage = `moveDocument executed successfully.
-  Successfully moved document '${documentToMove.title}' to ${newParentText}.
-  Check if the latest version of documentStructure meets user feedback, if so, just return 'success'.`;
-
-  // update shared document structure
-  if (options?.context?.userContext) {
-    options.context.userContext.currentStructure = updatedStructure;
-  }
-
-  return {
-    documentStructure: updatedStructure,
-    message: successMessage,
-    originalDocument: documentToMove,
-    updatedDocument: updatedDocument,
-  };
-}
-
-moveDocument.taskTitle = "Move document";
-moveDocument.description =
-  "Relocate a document to a different parent in the documentation structure";
-moveDocument.inputSchema = getMoveDocumentInputJsonSchema();
-moveDocument.outputSchema = getMoveDocumentOutputJsonSchema();

package/agents/create/document-structure-tools/update-document.mjs

@@ -1,84 +0,0 @@
-import {
-  getUpdateDocumentInputJsonSchema,
-  getUpdateDocumentOutputJsonSchema,
-  validateUpdateDocumentInput,
-} from "../../../types/document-structure-schema.mjs";
-import streamlineDocumentTitlesIfNeeded from "../../utils/streamline-document-titles-if-needed.mjs";
-
-export default async function updateDocument(input, options) {
-  // Validate input using Zod schema
-  const validation = validateUpdateDocumentInput(input);
-  if (!validation.success) {
-    const errorMessage = `Cannot update document: ${validation.error}`;
-    console.log(`⚠️  ${errorMessage}`);
-    return {
-      documentStructure: input.documentStructure,
-      error: { message: errorMessage },
-    };
-  }
-
-  const { path, title, description, sourceIds } = validation.data;
-  let documentStructure = options?.context?.userContext?.currentStructure;
-
-  if (!documentStructure) {
-    documentStructure = input.documentStructure;
-  }
-
-  // Find the document to update
-  const documentIndex = documentStructure.findIndex((item) => item.path === path);
-  if (documentIndex === -1) {
-    const errorMessage = `Cannot update document: Document '${path}' does not exist. Choose an existing document to update.`;
-    console.log(`⚠️  ${errorMessage}`);
-    return {
-      documentStructure,
-      error: { message: errorMessage },
-    };
-  }
-
-  const originalDocument = documentStructure[documentIndex];
-
-  // Create updated document object
-  const updatedDocument = {
-    ...originalDocument,
-    ...(title !== undefined && { title }),
-    ...(description !== undefined && { description }),
-    ...(sourceIds !== undefined && { sourceIds: [...sourceIds] }), // Create a copy of the array
-  };
-
-  if (!options.context.userContext.streamlinedDocumentTitles) {
-    // Streamline document titles if needed (will streamline the updated document if title > 18 characters)
-    await streamlineDocumentTitlesIfNeeded({ documentStructure: [updatedDocument] }, options);
-    options.context.userContext.streamlinedDocumentTitles = true;
-  }
-
-  // Update the document in the structure
-  const updatedStructure = [...documentStructure];
-  updatedStructure[documentIndex] = updatedDocument;
-
-  const updates = [];
-  if (title !== undefined) updates.push(`title to '${title}'`);
-  if (description !== undefined) updates.push("description");
-  if (sourceIds !== undefined) updates.push("sourceIds");
-  const updatesText = updates.length > 0 ? updates.join(", ") : "properties";
-
-  const successMessage = `updateDocument executed successfully.
-  Successfully updated ${updatesText} for document '${path}'.
-  Check if the latest version of documentStructure meets user feedback, if so, just return 'success'.`;
-
-  // update shared document structure
-  if (options?.context?.userContext) {
-    options.context.userContext.currentStructure = updatedStructure;
-  }
-
-  return {
-    documentStructure: updatedStructure,
-    message: successMessage,
-    originalDocument: originalDocument,
-    updatedDocument: updatedDocument,
-  };
-}
-
-updateDocument.taskTitle = "Update document";
-updateDocument.description = "Modify properties of a document in the documentation structure";
-updateDocument.inputSchema = getUpdateDocumentInputJsonSchema();
-updateDocument.outputSchema = getUpdateDocumentOutputJsonSchema();

package/agents/create/generate-diagram-image.yaml

@@ -1,91 +0,0 @@
-type: image
-name: generateDiagramImage
-image_model:
-  model: google/gemini-3-pro-image-preview
-  #  The cues that come with thought patterns are actually not obvious
-  # thinkingConfig: 
-  #   includeThoughts: true      
-  # responseModalities: 
-  #   - 'TEXT'
-  #   - 'IMAGE'
-  imageConfig:
-    imageSize:
-      $get: size
-    aspectRatio:
-      $get: ratio
-
-instructions:
-  - role: system
-    url: ../../prompts/detail/diagram/generate-image-system.md
-  - role: user
-    url: ../../prompts/detail/diagram/generate-image-user.md
-
-# Support image-to-image generation by passing existing image via input_file_key
-# If existingImage is provided (array of mediaFile objects), it will be passed to the model
-input_file_key: existingImage
-
-input_schema:
-  type: object
-  properties:
-    documentContent:
-      type: string
-      description: The full original document content
-    documentSummary:
-      type: string
-      description: A comprehensive summary of the document content for diagram generation (preferred over documentContent if available)
-    diagramType:
-      type: string
-      description: The type of diagram to generate (architecture, flowchart, guide, intro, sequence, network)
-    diagramStyle:
-      type: string
-      description: The visual style for the diagram (modern, standard, hand-drawn, anthropomorphic, flat, minimalist, 3d)
-    locale:
-      type: string
-      description: Language for diagram labels
-      default: en
-    size:
-      type: string
-      description: Size of the generated image (e.g., "1K", "2K")
-      default: "1K"
-    ratio:
-      type: string
-      description: Aspect ratio of the generated image (must match content flow direction)
-      enum: ["1:1", "5:4", "4:3", "3:2", "16:9", "21:9"]
-    aspectRatio:
-      type: string
-      description: Aspect ratio of the generated image (alias for ratio, used in prompt templates)
-      enum: ["1:1", "5:4", "4:3", "3:2", "16:9", "21:9"]
-    existingImage:
-      type: array
-      nullable: true
-      description: Array of mediaFile objects for existing diagram image (for image-to-image generation). If provided, the model will use this as reference and update based on document content and feedback.
-      items:
-        type: object
-        properties:
-          type:
-            type: string
-            description: File type, should be "local"
-          path:
-            type: string
-            description: Absolute path to the image file
-          filename:
-            type: string
-            description: Image filename
-          mimeType:
-            type: string
-            description: MIME type of the image (e.g., "image/png", "image/jpeg")
-    useImageToImage:
-      type: boolean
-      description: Whether to use image-to-image generation mode. If true and existingImage is provided, the model will update the existing image based on document content and feedback.
-      default: false
-    feedback:
-      type: string
-      description: User feedback for diagram updates. Used in image-to-image mode to guide modifications.
-      default: ""
-  required:
-    - documentContent
-    - diagramType
-    - diagramStyle
-    - ratio
-include_input_in_output: true
-

package/agents/create/generate-structure.yaml

@@ -1,106 +0,0 @@
-type: team
-name: generateStructure
-description: Generate the structure and organization of your documentation
-skills:
-  - type: team
-    name: generateStructureWorker
-    iterate_on: dataSources
-    skills:
-      - type: ai
-        instructions:
-          - role: system
-            url: ../../prompts/structure/generate/system-prompt.md
-          - role: user
-            url: ../../prompts/structure/generate/user-prompt.md
-        task_render_mode: collapse
-        task_title: Generate the structure of the documentation
-        tool_calls_concurrency: 5
-        input_schema:
-          type: object
-          properties:
-            rules:
-              type: string
-              description: Your specific requirements for documentation structure
-            locale:
-              type: string
-              description: Primary language for documentation (e.g., zh, en, ja)
-            dataSourceChunk:
-              type: string
-              description: Project content and context to help generate documentation structure
-            targetAudience:
-              type: string
-              description: Target audience for the documentation
-            nodeName:
-              type: string
-              description: Specific section or page name to focus on
-            glossary:
-              type: string
-              description: Glossary for consistent terminology
-            feedback:
-              type: string
-              description: Tell us how to improve the documentation structure
-            userPreferences:
-              type: string
-              description: Your saved preferences for structure and documentation style
-            docsType:
-              type: string
-              description: "Documentation type (options: general, getting-started, reference, faq)"
-              default: general
-          required:
-            - rules
-            - dataSourceChunk
-        output_schema:
-          type: object
-          properties:
-            projectName:
-              type: string
-              description: Project name identified from your content sources. Max 40 characters (any language, each character = 1). Leading/trailing spaces removed. Generate complete name within limit.
-            projectDesc:
-              type: string
-              description: Brief project description from content analysis. Max 160 characters (any language, each character = 1). Leading/trailing spaces removed. Generate complete description within limit.
-            structures:
-              type: array
-              description: List of document structure items to add or update
-              items: ../schema/document-structure-item.yaml
-
-      - ./utils/merge-document-structures.mjs
-
-  - ./aggregate-document-structure.mjs
-
-  - type: ai
-    name: refineStructure
-    instructions:
-      - role: system
-        url: ../../prompts/structure/review/structure-review-system.md
-    output_schema:
-      type: object
-      properties:
-        structures:
-          type: array
-          description: Document structure items that need to be updated or changed
-          items: ../schema/document-structure-refine-item.yaml
-      required:
-        - structures
-
-  - type: function
-    name: finalizeDocumentStructure
-    process: |
-      return {
-        projectName: input.projectName,
-        projectDesc: input.projectDesc,
-        documentStructure: input.structures.map(refinedItem => {
-          // Find original item to get sourceIds and other fields
-          const originalItem = input.documentStructure.find(orig => orig.id === refinedItem.id)
-
-          const newItem = {
-            title: refinedItem.title,
-            description: refinedItem.description,
-            path: refinedItem.path,
-            parentId: refinedItem.parentPath || null,  // Convert parentPath to parentId
-            sourceIds: originalItem?.sourceIds || [],
-            ...(refinedItem.icon && { icon: refinedItem.icon }), // Preserve icon if updated during refinement
-          }
-
-          return newItem
-        })
-      }

package/agents/create/index.yaml

@@ -1,45 +0,0 @@
-type: team
-name: create
-alias:
-  - generate
-  - gen
-description: Create complete documentation for your project
-skills:
-  - url: ../init/index.mjs
-    default_input:
-      skipIfExists: true
-  - ../utils/load-sources.mjs
-  - ./check-need-generate-structure.mjs
-  - url: ../utils/save-output.mjs
-    default_input:
-      saveKey: documentStructure
-      savePath:
-        $get: outputDir
-      fileName: structure-plan.json
-  - ./user-review-document-structure.mjs
-  - url: ../utils/save-output.mjs
-    default_input:
-      saveKey: documentStructure
-      savePath:
-        $get: outputDir
-      fileName: structure-plan.json
-  - ../utils/save-sidebar.mjs
-  - ../utils/ensure-document-icons.mjs
-  - ../utils/format-document-structure.mjs
-  - ../media/load-media-description.mjs
-  - ../update/batch-generate-document.yaml
-  - url: ../utils/check-feedback-refiner.mjs
-    default_input:
-      stage: document_structure
-  - ../utils/post-generate.mjs
-
-input_schema:
-  type: object
-  properties:
-    glossary:
-      type: string
-      description: Glossary file for consistent terminology (use @filename.md)
-    forceRegenerate:
-      type: boolean
-      description: Rebuild all documentation from scratch
-mode: sequential

package/agents/create/refine-document-structure.yaml

@@ -1,12 +0,0 @@
-type: team
-name: refineDocumentStructure
-description: A team of agents that generate the structure of the documentation.
-skills:
-  - generate-structure.yaml
-task_title: Generate the structure of the documentation
-task_render_mode: collapse
-reflection:
-  reviewer: check-document-structure.yaml
-  is_approved: isValid
-  max_iterations: 3
-  return_last_on_max_iterations: true