sdoc-editor-cli 0.9.2

package/dist/schemas/sdoc.schema.json

@@ -0,0 +1,559 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://sdoc.dev/schema/v1.0.json",
+  "title": "Structured Document (.sdoc / .tiptap.json)",
+  "description": "Schema for .sdoc and .tiptap.json files — a structured document format based on a tree of typed nodes with optional marks and attributes.",
+  "type": "object",
+  "required": ["sdoc", "doc"],
+  "properties": {
+    "sdoc": {
+      "type": "string",
+      "description": "Schema version of this .sdoc/.tiptap.json file.",
+      "enum": ["1.0"]
+    },
+    "meta": {
+      "$ref": "#/definitions/metadata"
+    },
+    "doc": {
+      "$ref": "#/definitions/docNode"
+    }
+  },
+  "additionalProperties": false,
+
+  "definitions": {
+    "metadata": {
+      "type": "object",
+      "description": "Document metadata for management and traceability.",
+      "properties": {
+        "title": { "type": "string", "description": "Document title." },
+        "author": { "type": "string", "description": "Author name or identifier." },
+        "version": { "type": "string", "description": "Document version string (e.g. '1.0', '2.3')." },
+        "created": { "type": "string", "format": "date-time", "description": "ISO 8601 creation timestamp." },
+        "modified": { "type": "string", "format": "date-time", "description": "ISO 8601 last-modified timestamp." },
+        "settings": { "$ref": "#/definitions/documentSettings" },
+        "template": { "$ref": "#/definitions/templateMetadata" }
+      },
+      "additionalProperties": true
+    },
+
+    "templateMetadata": {
+      "type": "object",
+      "description": "Reusable template catalog metadata. Personal templates additionally require a user:<uuid> id at the catalog boundary.",
+      "properties": {
+        "id": { "type": "string", "maxLength": 128 },
+        "name": { "type": "string", "maxLength": 200 },
+        "description": { "type": "string", "maxLength": 2000 },
+        "category": { "type": "string", "maxLength": 100 },
+        "titleNodeId": { "type": "string", "maxLength": 200 }
+      },
+      "additionalProperties": true
+    },
+
+    "documentSettings": {
+      "type": "object",
+      "description": "Per-document settings that override workspace defaults.",
+      "properties": {
+        "headingNumbering": { "type": "boolean", "description": "Enable automatic heading numbering." },
+        "headingStartNumber": { "type": "integer", "minimum": 0, "description": "Starting number for automatic H1 heading numbering." },
+        "headingDecoration": { "type": "boolean", "description": "Enable heading border-bottom decoration." },
+        "headingH1Color": { "type": "string", "pattern": "^#[0-9a-fA-F]{3,8}$", "description": "H1 heading number color." },
+        "headingH2Color": { "type": "string", "pattern": "^#[0-9a-fA-F]{3,8}$", "description": "H2 heading number color." },
+        "headingH3Color": { "type": "string", "pattern": "^#[0-9a-fA-F]{3,8}$", "description": "H3 heading number color." },
+        "headingH4Color": { "type": "string", "pattern": "^#[0-9a-fA-F]{3,8}$", "description": "H4 heading number color." },
+        "headingH5Color": { "type": "string", "pattern": "^#[0-9a-fA-F]{3,8}$", "description": "H5 heading number color." },
+        "headingH6Color": { "type": "string", "pattern": "^#[0-9a-fA-F]{3,8}$", "description": "H6 heading number color." },
+        "captionStyle": { "type": "string", "enum": ["ieee", "iso", "modern", "korean"], "description": "Caption formatting preset." },
+        "captionNumbering": { "type": "string", "enum": ["sequential", "hierarchical"], "description": "Caption numbering mode." },
+        "equationNumbering": { "type": "string", "enum": ["sequential", "hierarchical"], "description": "Equation numbering mode." },
+        "crossRefIncludeCaption": { "type": "boolean", "description": "Include caption text in generated cross-reference labels." },
+        "slideCssPath": { "type": "string" },
+        "htmlCssPath": { "type": "string" },
+        "pdfScale": { "type": "number", "minimum": 10, "maximum": 200 },
+        "selfContained": { "type": "string", "enum": ["none", "images-only", "full"] },
+        "slideBreakLevel": { "type": "string", "enum": ["h1-only", "h1-h2-vertical"] },
+        "slideTransition": { "type": "string", "enum": ["none", "fade", "slide", "convex", "concave", "zoom"] },
+        "showTitleSlide": { "type": "boolean" },
+        "outputDir": { "type": "string" }
+      },
+      "additionalProperties": false
+    },
+
+    "docNode": {
+      "type": "object",
+      "required": ["type"],
+      "properties": {
+        "type": { "const": "doc" },
+        "content": {
+          "type": "array",
+          "items": { "$ref": "#/definitions/blockNode" }
+        }
+      },
+      "additionalProperties": false
+    },
+
+    "blockNode": {
+      "oneOf": [
+        { "$ref": "#/definitions/headingNode" },
+        { "$ref": "#/definitions/paragraphNode" },
+        { "$ref": "#/definitions/bulletListNode" },
+        { "$ref": "#/definitions/orderedListNode" },
+        { "$ref": "#/definitions/taskListNode" },
+        { "$ref": "#/definitions/codeBlockNode" },
+        { "$ref": "#/definitions/tableNode" },
+        { "$ref": "#/definitions/imageNode" },
+        { "$ref": "#/definitions/mathBlockNode" },
+        { "$ref": "#/definitions/diagramNode" },
+        { "$ref": "#/definitions/blockquoteNode" },
+        { "$ref": "#/definitions/calloutNode" },
+        { "$ref": "#/definitions/horizontalRuleNode" },
+        { "$ref": "#/definitions/hardBreakNode" }
+      ]
+    },
+
+    "inlineNode": {
+      "oneOf": [
+        { "$ref": "#/definitions/textNode" },
+        { "$ref": "#/definitions/mathInlineNode" },
+        { "$ref": "#/definitions/hardBreakNode" }
+      ]
+    },
+
+    "headingNode": {
+      "type": "object",
+      "required": ["type", "attrs"],
+      "properties": {
+        "type": { "const": "heading" },
+        "attrs": {
+          "type": "object",
+          "required": ["level"],
+          "properties": {
+            "level": { "type": "integer", "minimum": 1, "maximum": 6 },
+            "id": { "type": ["string", "null"], "description": "Anchor id for cross-references." },
+            "textAlign": { "type": ["string", "null"], "enum": ["left", "center", "right", "justify", null] },
+            "numbered": { "type": ["boolean", "null"], "description": "false면 자동 번호 매김에서 제외 (예: Introduction, Glossary, References). 생략 또는 null이면 번호 매김 대상." }
+          },
+          "additionalProperties": false
+        },
+        "content": {
+          "type": "array",
+          "items": { "$ref": "#/definitions/inlineNode" }
+        }
+      },
+      "additionalProperties": false
+    },
+
+    "paragraphNode": {
+      "type": "object",
+      "required": ["type"],
+      "properties": {
+        "type": { "const": "paragraph" },
+        "attrs": {
+          "type": "object",
+          "properties": {
+            "textAlign": { "type": ["string", "null"], "enum": ["left", "center", "right", "justify", null] }
+          },
+          "additionalProperties": false
+        },
+        "content": {
+          "type": "array",
+          "items": { "$ref": "#/definitions/inlineNode" }
+        }
+      },
+      "additionalProperties": false
+    },
+
+    "bulletListNode": {
+      "type": "object",
+      "required": ["type"],
+      "properties": {
+        "type": { "const": "bulletList" },
+        "content": {
+          "type": "array",
+          "items": { "$ref": "#/definitions/listItemNode" }
+        }
+      },
+      "additionalProperties": false
+    },
+
+    "orderedListNode": {
+      "type": "object",
+      "required": ["type"],
+      "properties": {
+        "type": { "const": "orderedList" },
+        "attrs": {
+          "type": "object",
+          "properties": {
+            "start": { "type": ["integer", "null"], "default": 1 },
+            "type": { "type": ["string", "null"] }
+          },
+          "additionalProperties": false
+        },
+        "content": {
+          "type": "array",
+          "items": { "$ref": "#/definitions/listItemNode" }
+        }
+      },
+      "additionalProperties": false
+    },
+
+    "listItemNode": {
+      "type": "object",
+      "required": ["type"],
+      "properties": {
+        "type": { "const": "listItem" },
+        "content": {
+          "type": "array",
+          "items": { "$ref": "#/definitions/blockNode" }
+        }
+      },
+      "additionalProperties": false
+    },
+
+    "taskListNode": {
+      "type": "object",
+      "required": ["type"],
+      "properties": {
+        "type": { "const": "taskList" },
+        "content": {
+          "type": "array",
+          "items": { "$ref": "#/definitions/taskItemNode" }
+        }
+      },
+      "additionalProperties": false
+    },
+
+    "taskItemNode": {
+      "type": "object",
+      "required": ["type"],
+      "properties": {
+        "type": { "const": "taskItem" },
+        "attrs": {
+          "type": "object",
+          "properties": {
+            "checked": { "type": "boolean" }
+          }
+        },
+        "content": {
+          "type": "array",
+          "items": { "$ref": "#/definitions/blockNode" }
+        }
+      },
+      "additionalProperties": false
+    },
+
+    "codeBlockNode": {
+      "type": "object",
+      "required": ["type"],
+      "properties": {
+        "type": { "const": "codeBlock" },
+        "attrs": {
+          "type": "object",
+          "properties": {
+            "language": { "type": ["string", "null"] }
+          },
+          "additionalProperties": false
+        },
+        "content": {
+          "type": "array",
+          "items": { "$ref": "#/definitions/textNode" }
+        }
+      },
+      "additionalProperties": false
+    },
+
+    "tableNode": {
+      "type": "object",
+      "required": ["type"],
+      "properties": {
+        "type": { "const": "table" },
+        "attrs": {
+          "type": "object",
+          "properties": {
+            "caption": { "type": ["string", "null"], "description": "Table caption text." },
+            "align": { "type": "string", "enum": ["left", "center", "right"], "default": "left" },
+            "width": { "type": "string", "description": "CSS width value (e.g., '100%', '50%', 'auto').", "default": "auto" },
+            "id": { "type": ["string", "null"], "description": "Anchor id for cross-references." }
+          },
+          "additionalProperties": false
+        },
+        "content": {
+          "type": "array",
+          "items": { "$ref": "#/definitions/tableRowNode" }
+        }
+      },
+      "additionalProperties": false
+    },
+
+    "tableRowNode": {
+      "type": "object",
+      "required": ["type"],
+      "properties": {
+        "type": { "const": "tableRow" },
+        "content": {
+          "type": "array",
+          "items": {
+            "oneOf": [
+              { "$ref": "#/definitions/tableCellNode" },
+              { "$ref": "#/definitions/tableHeaderNode" }
+            ]
+          }
+        }
+      },
+      "additionalProperties": false
+    },
+
+    "tableCellNode": {
+      "type": "object",
+      "required": ["type"],
+      "properties": {
+        "type": { "const": "tableCell" },
+        "attrs": {
+          "type": "object",
+          "properties": {
+            "colspan": { "type": "integer", "minimum": 1, "default": 1 },
+            "rowspan": { "type": "integer", "minimum": 1, "default": 1 },
+            "colwidth": { "type": ["array", "null"], "items": { "type": "integer" } },
+            "align": { "type": ["string", "null"], "enum": ["left", "center", "right", null] }
+          },
+          "additionalProperties": false
+        },
+        "content": {
+          "type": "array",
+          "items": { "$ref": "#/definitions/blockNode" }
+        }
+      },
+      "additionalProperties": false
+    },
+
+    "tableHeaderNode": {
+      "type": "object",
+      "required": ["type"],
+      "properties": {
+        "type": { "const": "tableHeader" },
+        "attrs": {
+          "type": "object",
+          "properties": {
+            "colspan": { "type": "integer", "minimum": 1, "default": 1 },
+            "rowspan": { "type": "integer", "minimum": 1, "default": 1 },
+            "colwidth": { "type": ["array", "null"], "items": { "type": "integer" } },
+            "align": { "type": ["string", "null"], "enum": ["left", "center", "right", null] }
+          },
+          "additionalProperties": false
+        },
+        "content": {
+          "type": "array",
+          "items": { "$ref": "#/definitions/blockNode" }
+        }
+      },
+      "additionalProperties": false
+    },
+
+    "imageNode": {
+      "type": "object",
+      "required": ["type"],
+      "properties": {
+        "type": { "const": "image" },
+        "attrs": {
+          "type": "object",
+          "properties": {
+            "src": { "type": "string", "description": "Relative path to the image file (e.g., './images/photo.png')." },
+            "alt": { "type": ["string", "null"], "description": "Alternative text for accessibility." },
+            "title": { "type": ["string", "null"], "description": "Image title (tooltip)." },
+            "caption": { "type": ["string", "null"], "description": "Image caption text." },
+            "align": { "type": "string", "enum": ["left", "center", "right"], "default": "center" },
+            "width": { "type": ["string", "number", "null"] },
+            "height": { "type": ["string", "number", "null"] },
+            "id": { "type": ["string", "null"], "description": "Anchor id for cross-references." }
+          },
+          "additionalProperties": false
+        }
+      },
+      "additionalProperties": false
+    },
+
+    "mathBlockNode": {
+      "type": "object",
+      "required": ["type"],
+      "properties": {
+        "type": { "const": "mathBlock" },
+        "attrs": {
+          "type": "object",
+          "required": ["latex"],
+          "properties": {
+            "latex": { "type": "string", "description": "LaTeX math expression." },
+            "id": { "type": ["string", "null"], "description": "Anchor id for cross-references." }
+          },
+          "additionalProperties": false
+        }
+      },
+      "additionalProperties": false
+    },
+
+    "mathInlineNode": {
+      "type": "object",
+      "required": ["type"],
+      "properties": {
+        "type": { "const": "mathInline" },
+        "attrs": {
+          "type": "object",
+          "required": ["latex"],
+          "properties": {
+            "latex": { "type": "string", "description": "LaTeX math expression." }
+          },
+          "additionalProperties": false
+        }
+      },
+      "additionalProperties": false
+    },
+
+    "diagramNode": {
+      "type": "object",
+      "required": ["type"],
+      "properties": {
+        "type": { "const": "diagram" },
+        "attrs": {
+          "type": "object",
+          "required": ["language", "code"],
+          "properties": {
+            "language": { "type": "string", "description": "Diagram language, e.g. mermaid, plantuml, d2." },
+            "code": { "type": "string", "description": "Diagram source code." }
+          },
+          "additionalProperties": false
+        }
+      },
+      "additionalProperties": false
+    },
+
+    "hardBreakNode": {
+      "type": "object",
+      "required": ["type"],
+      "properties": {
+        "type": { "const": "hardBreak" }
+      },
+      "additionalProperties": false
+    },
+
+    "horizontalRuleNode": {
+      "type": "object",
+      "required": ["type"],
+      "properties": {
+        "type": { "const": "horizontalRule" },
+        "attrs": {
+          "type": "object",
+          "properties": {
+            "id": {
+              "type": ["string", "null"],
+              "pattern": "^[A-Za-z][A-Za-z0-9._:-]*$"
+            }
+          },
+          "additionalProperties": false
+        }
+      },
+      "additionalProperties": false
+    },
+
+    "blockquoteNode": {
+      "type": "object",
+      "required": ["type"],
+      "properties": {
+        "type": { "const": "blockquote" },
+        "content": {
+          "type": "array",
+          "items": { "$ref": "#/definitions/blockNode" }
+        }
+      },
+      "additionalProperties": false
+    },
+
+    "calloutNode": {
+      "type": "object",
+      "required": ["type"],
+      "properties": {
+        "type": { "const": "callout" },
+        "attrs": {
+          "type": "object",
+          "properties": {
+            "variant": {
+              "type": "string",
+              "enum": ["note", "info", "tip", "warning", "danger"],
+              "description": "Visual style of the callout block."
+            }
+          },
+          "additionalProperties": false
+        },
+        "content": {
+          "type": "array",
+          "items": { "$ref": "#/definitions/blockNode" }
+        }
+      },
+      "additionalProperties": false
+    },
+
+    "textNode": {
+      "type": "object",
+      "required": ["type"],
+      "properties": {
+        "type": { "const": "text" },
+        "text": { "type": "string" },
+        "marks": {
+          "type": "array",
+          "items": { "$ref": "#/definitions/mark" }
+        }
+      },
+      "additionalProperties": false
+    },
+
+    "mark": {
+      "type": "object",
+      "required": ["type"],
+      "properties": {
+        "type": {
+          "type": "string",
+          "enum": ["bold", "italic", "underline", "strike", "code", "link", "textStyle", "highlight", "subscript", "superscript"]
+        },
+        "attrs": {
+          "type": "object",
+          "description": "Mark-specific attributes (e.g., href for link).",
+          "properties": {
+            "href": { "type": ["string", "null"] },
+            "target": { "type": ["string", "null"] },
+            "rel": { "type": ["string", "null"] },
+            "class": { "type": ["string", "null"] },
+            "title": { "type": ["string", "null"] },
+            "color": { "type": "string" }
+          },
+          "additionalProperties": false
+        }
+      },
+      "additionalProperties": false
+    },
+
+    "anyNode": {
+      "type": "object",
+      "description": "A generic Tiptap JSON node for contracts that carry node fragments. Persisted documents continue to use the more specific node definitions above.",
+      "required": ["type"],
+      "properties": {
+        "type": { "type": "string", "minLength": 1 },
+        "attrs": { "type": "object" },
+        "content": {
+          "type": "array",
+          "items": { "$ref": "#/definitions/anyNode" }
+        },
+        "marks": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "required": ["type"],
+            "properties": {
+              "type": { "type": "string", "minLength": 1 },
+              "attrs": { "type": "object" }
+            },
+            "additionalProperties": true
+          }
+        },
+        "text": { "type": "string" }
+      },
+      "additionalProperties": true
+    }
+  }
+}