kindy-editor 1.0.1 → 2.0.0

package/openapi/document-api.yaml

@@ -0,0 +1,267 @@
+openapi: 3.1.0
+info:
+  title: Kindy Document Library API
+  version: 2.0.0
+  description: Host-side contract consumed by kindy-editor. Authentication is intentionally application-defined.
+servers:
+  - url: https://document-api.example.com
+tags:
+  - name: Documents
+  - name: Versions
+  - name: Artifacts
+paths:
+  /documents:
+    get:
+      tags: [Documents]
+      operationId: listDocuments
+      parameters:
+        - $ref: '#/components/parameters/Search'
+        - $ref: '#/components/parameters/FolderId'
+        - $ref: '#/components/parameters/Page'
+        - $ref: '#/components/parameters/PageSize'
+      responses:
+        '200': { description: Document page, content: { application/json: { schema: { $ref: '#/components/schemas/DocumentPage' } } } }
+    post:
+      tags: [Documents]
+      operationId: createDocument
+      requestBody: { required: true, content: { application/json: { schema: { $ref: '#/components/schemas/CreateDocumentInput' } } } }
+      responses:
+        '201': { description: Created, content: { application/json: { schema: { $ref: '#/components/schemas/DocumentRecord' } } } }
+  /documents/import:
+    post:
+      tags: [Documents]
+      operationId: importDocument
+      requestBody:
+        required: true
+        content:
+          multipart/form-data:
+            schema:
+              type: object
+              required: [file, metadata, state]
+              properties:
+                file: { type: string, contentMediaType: application/vnd.openxmlformats-officedocument.wordprocessingml.document, contentEncoding: binary }
+                metadata: { type: string, description: JSON encoded CreateDocumentInput }
+                state: { type: string, description: JSON encoded KindyDocumentState }
+                compatibilityReport: { type: string, description: JSON encoded CompatibilityReport }
+      responses:
+        '201': { description: Imported, content: { application/json: { schema: { $ref: '#/components/schemas/DocumentRecord' } } } }
+        '422': { $ref: '#/components/responses/Error' }
+  /documents/{documentId}:
+    parameters: [{ $ref: '#/components/parameters/DocumentId' }]
+    get:
+      tags: [Documents]
+      operationId: getDocument
+      responses:
+        '200': { description: Document, content: { application/json: { schema: { $ref: '#/components/schemas/DocumentRecord' } } } }
+        '404': { $ref: '#/components/responses/Error' }
+    patch:
+      tags: [Documents]
+      operationId: updateDocument
+      requestBody: { required: true, content: { application/json: { schema: { type: object, additionalProperties: true } } } }
+      responses:
+        '200': { description: Updated document, content: { application/json: { schema: { $ref: '#/components/schemas/DocumentRecord' } } } }
+  /documents/{documentId}/state:
+    parameters: [{ $ref: '#/components/parameters/DocumentId' }]
+    get:
+      tags: [Documents]
+      operationId: loadDocumentState
+      parameters: [{ name: versionId, in: query, schema: { type: string } }]
+      responses:
+        '200': { description: Snapshot, content: { application/json: { schema: { $ref: '#/components/schemas/DocumentSnapshot' } } } }
+        '404': { $ref: '#/components/responses/Error' }
+    put:
+      tags: [Documents]
+      operationId: saveDocumentState
+      requestBody: { required: true, content: { application/json: { schema: { $ref: '#/components/schemas/SaveStateInput' } } } }
+      responses:
+        '200': { description: Save result, content: { application/json: { schema: { $ref: '#/components/schemas/SaveResult' } } } }
+        '409': { description: Base revision no longer current, content: { application/json: { schema: { $ref: '#/components/schemas/Error' } } } }
+  /documents/{documentId}/versions:
+    parameters: [{ $ref: '#/components/parameters/DocumentId' }]
+    get:
+      tags: [Versions]
+      operationId: listDocumentVersions
+      parameters: [{ $ref: '#/components/parameters/Page' }, { $ref: '#/components/parameters/PageSize' }]
+      responses:
+        '200': { description: Version page, content: { application/json: { schema: { $ref: '#/components/schemas/VersionPage' } } } }
+  /documents/{documentId}/versions/{versionId}/restore:
+    parameters: [{ $ref: '#/components/parameters/DocumentId' }, { $ref: '#/components/parameters/VersionId' }]
+    post:
+      tags: [Versions]
+      operationId: restoreDocumentVersion
+      responses:
+        '200': { description: Restored snapshot, content: { application/json: { schema: { $ref: '#/components/schemas/DocumentSnapshot' } } } }
+        '404': { $ref: '#/components/responses/Error' }
+  /documents/{documentId}/artifacts:
+    parameters: [{ $ref: '#/components/parameters/DocumentId' }]
+    post:
+      tags: [Artifacts]
+      operationId: storeDocumentArtifact
+      requestBody:
+        required: true
+        content:
+          multipart/form-data:
+            schema:
+              type: object
+              required: [file, format]
+              properties:
+                file: { type: string, contentEncoding: binary }
+                fileName: { type: string, description: Explicit filename for transports that do not preserve multipart Content-Disposition }
+                format: { $ref: '#/components/schemas/ArtifactFormat' }
+                versionId: { type: string }
+                compatibilityReport: { type: string }
+      responses:
+        '201': { description: Artifact, content: { application/json: { schema: { $ref: '#/components/schemas/DocumentArtifact' } } } }
+  /documents/{documentId}/artifacts/{artifactId}:
+    parameters: [{ $ref: '#/components/parameters/DocumentId' }, { name: artifactId, in: path, required: true, schema: { type: string } }]
+    get:
+      tags: [Artifacts]
+      operationId: getDocumentArtifact
+      responses:
+        '200': { description: Artifact metadata with a URL or an application-defined retrieval representation, content: { application/json: { schema: { $ref: '#/components/schemas/DocumentArtifact' } } } }
+        '404': { $ref: '#/components/responses/Error' }
+  /folders:
+    get:
+      operationId: listFolders
+      parameters: [{ $ref: '#/components/parameters/Search' }]
+      responses:
+        '200': { description: Folders, content: { application/json: { schema: { type: array, items: { $ref: '#/components/schemas/Folder' } } } } }
+  /templates:
+    get:
+      operationId: listTemplates
+      parameters: [{ $ref: '#/components/parameters/Search' }, { $ref: '#/components/parameters/Page' }, { $ref: '#/components/parameters/PageSize' }]
+      responses:
+        '200': { description: Template page, content: { application/json: { schema: { $ref: '#/components/schemas/DocumentPage' } } } }
+components:
+  parameters:
+    DocumentId: { name: documentId, in: path, required: true, schema: { type: string } }
+    VersionId: { name: versionId, in: path, required: true, schema: { type: string } }
+    Search: { name: search, in: query, schema: { type: string } }
+    FolderId: { name: folderId, in: query, schema: { type: string } }
+    Page: { name: page, in: query, schema: { type: integer, minimum: 1, default: 1 } }
+    PageSize: { name: pageSize, in: query, schema: { type: integer, minimum: 1, maximum: 200, default: 20 } }
+  responses:
+    Error: { description: Error, content: { application/json: { schema: { $ref: '#/components/schemas/Error' } } } }
+  schemas:
+    JsonContent: { type: object, additionalProperties: true }
+    KindyPageState:
+      type: object
+      required: [size, orientation, margin]
+      properties:
+        size: { type: object, required: [width, height], properties: { width: { type: number }, height: { type: number } } }
+        orientation: { enum: [portrait, landscape] }
+        margin: { type: object, required: [top, right, bottom, left], properties: { top: { type: number }, right: { type: number }, bottom: { type: number }, left: { type: number } } }
+        background: { type: string }
+        watermark: { type: object, additionalProperties: true }
+        sections: { type: array, items: { type: object, additionalProperties: true } }
+      additionalProperties: true
+    KindyDocumentState:
+      type: object
+      required: [schemaVersion, content, page, assets]
+      properties:
+        schemaVersion: { const: '2.0' }
+        content: { $ref: '#/components/schemas/JsonContent' }
+        page: { $ref: '#/components/schemas/KindyPageState' }
+        assets: { type: array, items: { type: object, required: [id, kind], properties: { id: { type: string }, kind: { type: string }, url: { type: string }, mimeType: { type: string } }, additionalProperties: true } }
+    DocumentRecord:
+      type: object
+      required: [id, title, fileName, updatedAt]
+      properties:
+        id: { type: string }
+        title: { type: string }
+        fileName: { type: string }
+        folderId: { type: [string, 'null'] }
+        tags: { type: array, items: { type: string } }
+        currentVersionId: { type: string }
+        currentRevisionId: { type: string }
+        isTemplate: { type: boolean }
+        createdAt: { type: string, format: date-time }
+        updatedAt: { type: string, format: date-time }
+        metadata: { type: object, additionalProperties: true }
+        capabilities: { type: object, additionalProperties: { type: boolean } }
+        originalSource:
+          $ref: '#/components/schemas/OriginalDocxSource'
+    OriginalDocxSource:
+      type: object
+      required: [artifactId, revisionId, format, fileName]
+      properties:
+        artifactId: { type: string }
+        revisionId: { type: string }
+        format: { const: original-docx }
+        fileName: { type: string }
+        compatibilityReport: { type: object, additionalProperties: true }
+    CreateDocumentInput:
+      type: object
+      required: [title]
+      properties:
+        title: { type: string }
+        fileName: { type: string }
+        folderId: { type: [string, 'null'] }
+        tags: { type: array, items: { type: string } }
+        templateId: { type: string }
+        state: { $ref: '#/components/schemas/KindyDocumentState' }
+        metadata: { type: object, additionalProperties: true }
+    DocumentVersion:
+      type: object
+      required: [id, documentId, number, revisionId, reason, createdAt]
+      properties:
+        id: { type: string }
+        documentId: { type: string }
+        number: { type: integer }
+        revisionId: { type: string }
+        reason: { enum: [create, import, autosave, manual, restore, template] }
+        createdAt: { type: string, format: date-time }
+        label: { type: string }
+    DocumentSnapshot:
+      type: object
+      required: [document, state, revisionId]
+      properties:
+        document: { $ref: '#/components/schemas/DocumentRecord' }
+        state: { $ref: '#/components/schemas/KindyDocumentState' }
+        revisionId: { type: string }
+        version: { $ref: '#/components/schemas/DocumentVersion' }
+    SaveStateInput:
+      type: object
+      required: [state, baseRevisionId, reason, clientMutationId]
+      properties:
+        state: { $ref: '#/components/schemas/KindyDocumentState' }
+        baseRevisionId: { type: string }
+        reason: { enum: [autosave, manual] }
+        clientMutationId: { type: string }
+    SaveResult:
+      type: object
+      required: [revisionId, savedAt]
+      properties:
+        revisionId: { type: string }
+        savedAt: { type: string, format: date-time }
+        version: { $ref: '#/components/schemas/DocumentVersion' }
+    ArtifactFormat: { enum: [docx, pdf, original-docx] }
+    DocumentArtifact:
+      type: object
+      required: [id, documentId, format, fileName, mimeType, createdAt]
+      properties:
+        id: { type: string }
+        documentId: { type: string }
+        versionId: { type: string }
+        format: { $ref: '#/components/schemas/ArtifactFormat' }
+        fileName: { type: string }
+        mimeType: { type: string }
+        size: { type: integer }
+        url: { type: string, format: uri }
+        createdAt: { type: string, format: date-time }
+    Folder:
+      type: object
+      required: [id, name]
+      properties: { id: { type: string }, name: { type: string }, parentId: { type: [string, 'null'] } }
+    DocumentPage:
+      type: object
+      required: [items, total, page, pageSize]
+      properties: { items: { type: array, items: { $ref: '#/components/schemas/DocumentRecord' } }, total: { type: integer }, page: { type: integer }, pageSize: { type: integer } }
+    VersionPage:
+      type: object
+      required: [items, total, page, pageSize]
+      properties: { items: { type: array, items: { $ref: '#/components/schemas/DocumentVersion' } }, total: { type: integer }, page: { type: integer }, pageSize: { type: integer } }
+    Error:
+      type: object
+      required: [code, message]
+      properties: { code: { type: string }, message: { type: string }, details: {} }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "kindy-editor",
-  "version": "1.0.1",
-  "description": "A powerful document editor based on Vue3 and Tiptap3. Forked from Umo Editor and customized for personal use.",
+  "version": "2.0.0",
+  "description": "DOCX document library SDK and Vue 3 editor with a headless TypeScript core, powered by Tiptap/ProseMirror.",
   "keywords": [
     "docs editor",
     "document editor",
@@ -34,7 +34,19 @@
     "url": "https://github.com/hotienky/editor.git"
   },
   "files": [
-    "dist"
+    "dist",
+    "docs/README.md",
+    "docs/getting-started.md",
+    "docs/ui-engine.md",
+    "docs/api-reference.md",
+    "docs/performance.md",
+    "docs/plugin-development.md",
+    "docs/completion-roadmap.md",
+    "openapi",
+    "CHANGELOG.md",
+    "GUIDE.md",
+    "CAPABILITIES.md",
+    "MIGRATION.md"
   ],
   "main": "./dist/kindy-editor.cjs",
   "module": "./dist/kindy-editor.js",
@@ -51,15 +63,38 @@
     },
     "./style": {
       "default": "./dist/kindy-editor.css"
+    },
+    "./core": {
+      "types": "./dist/types/core/index.d.ts",
+      "import": "./dist/kindy-core.js",
+      "require": "./dist/kindy-core.cjs"
+    },
+    "./openapi": {
+      "default": "./openapi/document-api.yaml"
     }
   },
   "scripts": {
-    "build": "vite build",
+    "build": "node scripts/build.mjs",
+    "build:demo": "vite build --config vite.demo.config.js",
     "dev": "vite --port 9000 --open --force",
+    "preview": "vite preview",
+    "preview:demo": "vite preview --config vite.demo.config.js",
+    "docs:dev": "vitepress dev docs --port 9001 --open",
+    "docs:build": "vitepress build docs",
+    "docs:preview": "vitepress preview docs",
+    "test": "vitest run",
+    "test:e2e": "playwright test",
+    "test:package": "node scripts/test-packed-consumer.mjs",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage",
+    "benchmark:long-doc": "node scripts/benchmark-long-document.mjs",
+    "benchmark:ci": "node scripts/benchmark-long-document.mjs --assert --output=.artifacts/long-document.json",
+    "typecheck": "tsc --noEmit",
     "format": "oxfmt --write .",
     "lint": "oxlint --fix src",
+    "lint:check": "oxlint src",
+    "test:libreoffice": "KINDY_TEST_LIBREOFFICE=1 vitest run src/codecs/__tests__/libreoffice.test.js",
     "analyzer": "vite-bundle-visualizer",
-    "prepare": "husky",
     "prepublishOnly": "npm run build"
   },
   "dependencies": {
@@ -67,6 +102,7 @@
     "@floating-ui/dom": "1.7.5",
     "@tiptap/core": "3.20.0",
     "@tiptap/extension-bold": "3.20.0",
+    "@tiptap/extension-bubble-menu": "3.20.0",
     "@tiptap/extension-code-block": "3.20.0",
     "@tiptap/extension-code-block-lowlight": "3.20.0",
     "@tiptap/extension-collaboration": "3.20.0",
@@ -74,6 +110,7 @@
     "@tiptap/extension-document": "3.20.0",
     "@tiptap/extension-drag-handle": "3.16.0",
     "@tiptap/extension-drag-handle-vue-3": "3.16.0",
+    "@tiptap/extension-floating-menu": "3.20.0",
     "@tiptap/extension-horizontal-rule": "3.20.0",
     "@tiptap/extension-image": "3.20.0",
     "@tiptap/extension-invisible-characters": "3.20.0",
@@ -97,17 +134,18 @@
     "@tiptap/vue-3": "3.20.0",
     "@tiptap/y-tiptap": "3.0.2",
     "@tool-belt/type-predicates": "1.4.1",
-    "@umoteam/editor-external": "10.1.0",
     "@vueuse/core": "14.2.1",
     "cropperjs": "^2.1.1",
+    "docx": "^9.7.1",
     "dom-to-image-more": "3.7.2",
     "es-drager": "1.2.11",
-    "fast-glob": "3.3.3",
+    "fflate": "^0.8.3",
     "file-saver": "2.0.5",
     "hotkeys-js": "4.0.2",
     "jsbarcode": "3.12.3",
     "katex": "0.16.33",
     "lowlight": "3.3.0",
+    "mammoth": "^1.12.0",
     "nzh": "1.0.14",
     "pretty-bytes": "7.1.0",
     "pure-svg-code": "1.0.6",
@@ -118,9 +156,12 @@
     "yjs": "13.6.29"
   },
   "devDependencies": {
+    "@playwright/test": "^1.62.1",
     "@vitejs/plugin-vue": "^6.0.4",
     "@vue-macros/reactivity-transform": "^3.1.2",
+    "@vue/test-utils": "^2.4.11",
     "esbuild": "^0.28.1",
+    "happy-dom": "^20.11.2",
     "husky": "^9.1.7",
     "less": "^4.5.1",
     "less-loader": "^12.3.1",
@@ -130,17 +171,26 @@
     "postcss": "^8.5.6",
     "postcss-html": "^1.8.1",
     "tdesign-vue-next": "1.18.2",
+    "typescript": "^5.9.2",
     "unplugin-auto-import": "^21.0.0",
     "unplugin-vue": "^7.1.1",
     "unplugin-vue-components": "^31.0.0",
     "unplugin-vue-macros": "^2.14.5",
     "vite": "^7.3.1",
     "vite-bundle-visualizer": "^1.2.1",
-    "vite-plugin-svg-icons": "^2.0.1",
+    "vitepress": "^1.6.4",
+    "vitest": "^4.1.10",
     "vue": "^3.5.29"
   },
   "overrides": {
-    "rolldown": "^1.1.3"
+    "rolldown": "^1.1.3",
+    "uuid": "^11.1.1",
+    "postcss": {
+      "nanoid": "^3.3.18"
+    }
+  },
+  "peerDependencies": {
+    "vue": "^3.5.0"
   },
   "lint-staged": {
     "*.{js,vue,less}": [