dsh-crwu-workbench 0.0.10
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +1516 -0
- package/LICENSE +26 -0
- package/README.en.md +204 -0
- package/README.md +521 -0
- package/SECURITY.md +39 -0
- package/bin/darwin-arm64/crwu +0 -0
- package/bin/darwin-arm64/dws +0 -0
- package/bin/darwin-arm64/ossutil +0 -0
- package/bin/manifest.json +82 -0
- package/bin/win32-x64/crwu.exe +0 -0
- package/bin/win32-x64/dws.exe +4 -0
- package/bin/win32-x64/ossutil.exe +0 -0
- package/common/skills/.synced.json +8 -0
- package/common/skills/crwu-dws/SKILL.md +208 -0
- package/common/skills/crwu-dws/references/00-/347/233/256/345/275/225/345/277/253/347/205/247schema.md +113 -0
- package/common/skills/crwu-dws/references/01-/345/256/241/346/240/270/344/270/213/350/275/275/344/270/216manifest/350/247/204/350/214/203.md +115 -0
- package/common/skills/crwu-dws/references/02-/347/274/223/345/255/230/344/270/216/345/205/234/345/272/225/346/237/245/346/211/276/350/247/204/350/214/203.md +119 -0
- package/common/skills/crwu-dws/scripts/test_dws_source_contract.py +493 -0
- package/common/skills/crwu-h3yun-login/SKILL.md +130 -0
- package/common/skills/crwu-h3yun-query/SKILL.md +192 -0
- package/config/crwu-workbench.yml +26 -0
- package/cordis.patch.yml +46 -0
- package/lib/client.js +10346 -0
- package/lib/index.js +11584 -0
- package/package.json +119 -0
- package/scripts/prepare.mjs +59 -0
- package/skills/README.md +26 -0
- package/skills/crwu/crwu-audit/SKILL.md +152 -0
- package/skills/crwu/crwu-audit/references/00-input-and-route-profile.md +232 -0
- package/skills/crwu/crwu-audit/references/01-report-id-resolution.md +13 -0
- package/skills/crwu/crwu-audit/references/02-scope-classification.md +25 -0
- package/skills/crwu/crwu-audit/references/03-asset-classification.md +27 -0
- package/skills/crwu/crwu-audit/references/04-business-classification.md +63 -0
- package/skills/crwu/crwu-audit/references/05-method-classification.md +66 -0
- package/skills/crwu/crwu-audit/references/06-overlay-classification.md +42 -0
- package/skills/crwu/crwu-audit/references/07-skill-registry.md +57 -0
- package/skills/crwu/crwu-audit/references/08-union-dispatch-rules.md +142 -0
- package/skills/crwu/crwu-audit/references/09-review-risk-classification.md +85 -0
- package/skills/crwu/crwu-audit/references/10-capability-gap-proposal.md +68 -0
- package/skills/crwu/crwu-audit/references/11-html-delivery-spec.md +881 -0
- package/skills/crwu/crwu-audit/references/12-leaf-common-contract.md +202 -0
- package/skills/crwu/crwu-audit/references/13-dingtalk-result-publish.md +88 -0
- package/skills/crwu/crwu-audit/references/14-orchestration-workflow.md +52 -0
- package/skills/crwu/crwu-audit/references/99-maintenance.md +62 -0
- package/skills/crwu/crwu-audit/scripts/README.md +157 -0
- package/skills/crwu/crwu-audit/scripts/audit_delivery.py +2736 -0
- package/skills/crwu/crwu-audit/scripts/audit_result.schema.json +1659 -0
- package/skills/crwu/crwu-audit/scripts/examples/audit-result.sample.json +739 -0
- package/skills/crwu/crwu-audit/scripts/fetch_review_records.py +85 -0
- package/skills/crwu/crwu-audit/scripts/media_extract.py +513 -0
- package/skills/crwu/crwu-audit/scripts/prepare_materials.py +1252 -0
- package/skills/crwu/crwu-audit/scripts/test_audit_delivery.py +1678 -0
- package/skills/crwu/crwu-audit/scripts/test_audit_multiaxis_router.py +1339 -0
- package/skills/crwu/crwu-audit/scripts/test_fetch_review_records.py +77 -0
- package/skills/crwu/crwu-audit/scripts/test_media_extract.py +332 -0
- package/skills/crwu/crwu-audit/scripts/test_prepare_materials.py +1081 -0
- package/skills/crwu/crwu-audit/template/audit-report.html +435 -0
- package/skills/crwu/crwu-audit-asset-asset-group-goodwill/SKILL.md +38 -0
- package/skills/crwu/crwu-audit-asset-asset-group-goodwill/references/00-applicability.md +28 -0
- package/skills/crwu/crwu-audit-asset-asset-group-goodwill/references/01-kb-assembly.md +31 -0
- package/skills/crwu/crwu-audit-asset-asset-group-goodwill/references/02-review-focus.md +21 -0
- package/skills/crwu/crwu-audit-asset-asset-group-goodwill/references/03-common-contract.md +202 -0
- package/skills/crwu/crwu-audit-asset-debt/SKILL.md +38 -0
- package/skills/crwu/crwu-audit-asset-debt/references/00-applicability.md +40 -0
- package/skills/crwu/crwu-audit-asset-debt/references/01-kb-assembly.md +41 -0
- package/skills/crwu/crwu-audit-asset-debt/references/02-review-focus.md +54 -0
- package/skills/crwu/crwu-audit-asset-debt/references/03-common-contract.md +202 -0
- package/skills/crwu/crwu-audit-asset-enterprise-value/SKILL.md +38 -0
- package/skills/crwu/crwu-audit-asset-enterprise-value/references/00-applicability.md +31 -0
- package/skills/crwu/crwu-audit-asset-enterprise-value/references/01-kb-assembly.md +35 -0
- package/skills/crwu/crwu-audit-asset-enterprise-value/references/02-review-focus.md +33 -0
- package/skills/crwu/crwu-audit-asset-enterprise-value/references/03-common-contract.md +202 -0
- package/skills/crwu/crwu-audit-asset-equipment/SKILL.md +38 -0
- package/skills/crwu/crwu-audit-asset-equipment/references/00-applicability.md +40 -0
- package/skills/crwu/crwu-audit-asset-equipment/references/01-kb-assembly.md +39 -0
- package/skills/crwu/crwu-audit-asset-equipment/references/02-review-focus.md +52 -0
- package/skills/crwu/crwu-audit-asset-equipment/references/03-common-contract.md +202 -0
- package/skills/crwu/crwu-audit-asset-intangible/SKILL.md +38 -0
- package/skills/crwu/crwu-audit-asset-intangible/references/00-applicability.md +36 -0
- package/skills/crwu/crwu-audit-asset-intangible/references/01-kb-assembly.md +40 -0
- package/skills/crwu/crwu-audit-asset-intangible/references/02-review-focus.md +68 -0
- package/skills/crwu/crwu-audit-asset-intangible/references/03-common-contract.md +202 -0
- package/skills/crwu/crwu-audit-asset-inventory/SKILL.md +38 -0
- package/skills/crwu/crwu-audit-asset-inventory/references/00-applicability.md +28 -0
- package/skills/crwu/crwu-audit-asset-inventory/references/01-kb-assembly.md +31 -0
- package/skills/crwu/crwu-audit-asset-inventory/references/02-review-focus.md +21 -0
- package/skills/crwu/crwu-audit-asset-inventory/references/03-common-contract.md +202 -0
- package/skills/crwu/crwu-audit-asset-mining-right/SKILL.md +38 -0
- package/skills/crwu/crwu-audit-asset-mining-right/references/00-applicability.md +31 -0
- package/skills/crwu/crwu-audit-asset-mining-right/references/01-kb-assembly.md +35 -0
- package/skills/crwu/crwu-audit-asset-mining-right/references/02-review-focus.md +33 -0
- package/skills/crwu/crwu-audit-asset-mining-right/references/03-common-contract.md +202 -0
- package/skills/crwu/crwu-audit-asset-other/SKILL.md +38 -0
- package/skills/crwu/crwu-audit-asset-other/references/00-applicability.md +28 -0
- package/skills/crwu/crwu-audit-asset-other/references/01-kb-assembly.md +31 -0
- package/skills/crwu/crwu-audit-asset-other/references/02-review-focus.md +21 -0
- package/skills/crwu/crwu-audit-asset-other/references/03-common-contract.md +202 -0
- package/skills/crwu/crwu-audit-asset-portfolio/SKILL.md +38 -0
- package/skills/crwu/crwu-audit-asset-portfolio/references/00-applicability.md +28 -0
- package/skills/crwu/crwu-audit-asset-portfolio/references/01-kb-assembly.md +31 -0
- package/skills/crwu/crwu-audit-asset-portfolio/references/02-review-focus.md +21 -0
- package/skills/crwu/crwu-audit-asset-portfolio/references/03-common-contract.md +202 -0
- package/skills/crwu/crwu-audit-asset-realestate/SKILL.md +38 -0
- package/skills/crwu/crwu-audit-asset-realestate/references/00-applicability.md +43 -0
- package/skills/crwu/crwu-audit-asset-realestate/references/01-kb-assembly.md +75 -0
- package/skills/crwu/crwu-audit-asset-realestate/references/02-review-focus.md +93 -0
- package/skills/crwu/crwu-audit-asset-realestate/references/03-common-contract.md +202 -0
- package/skills/crwu/crwu-audit-asset-scrap-materials/SKILL.md +38 -0
- package/skills/crwu/crwu-audit-asset-scrap-materials/references/00-applicability.md +28 -0
- package/skills/crwu/crwu-audit-asset-scrap-materials/references/01-kb-assembly.md +31 -0
- package/skills/crwu/crwu-audit-asset-scrap-materials/references/02-review-focus.md +21 -0
- package/skills/crwu/crwu-audit-asset-scrap-materials/references/03-common-contract.md +202 -0
- package/skills/crwu/crwu-audit-asset-transport-equipment/SKILL.md +38 -0
- package/skills/crwu/crwu-audit-asset-transport-equipment/references/00-applicability.md +31 -0
- package/skills/crwu/crwu-audit-asset-transport-equipment/references/01-kb-assembly.md +35 -0
- package/skills/crwu/crwu-audit-asset-transport-equipment/references/02-review-focus.md +33 -0
- package/skills/crwu/crwu-audit-asset-transport-equipment/references/03-common-contract.md +202 -0
- package/skills/crwu/crwu-audit-biz-asset-operation/SKILL.md +38 -0
- package/skills/crwu/crwu-audit-biz-asset-operation/references/00-applicability.md +30 -0
- package/skills/crwu/crwu-audit-biz-asset-operation/references/01-kb-assembly.md +32 -0
- package/skills/crwu/crwu-audit-biz-asset-operation/references/02-review-focus.md +42 -0
- package/skills/crwu/crwu-audit-biz-asset-operation/references/03-common-contract.md +202 -0
- package/skills/crwu/crwu-audit-biz-consulting-review/SKILL.md +38 -0
- package/skills/crwu/crwu-audit-biz-consulting-review/references/00-applicability.md +30 -0
- package/skills/crwu/crwu-audit-biz-consulting-review/references/01-kb-assembly.md +32 -0
- package/skills/crwu/crwu-audit-biz-consulting-review/references/02-review-focus.md +40 -0
- package/skills/crwu/crwu-audit-biz-consulting-review/references/03-common-contract.md +202 -0
- package/skills/crwu/crwu-audit-biz-financial-reporting/SKILL.md +38 -0
- package/skills/crwu/crwu-audit-biz-financial-reporting/references/00-applicability.md +41 -0
- package/skills/crwu/crwu-audit-biz-financial-reporting/references/01-kb-assembly.md +40 -0
- package/skills/crwu/crwu-audit-biz-financial-reporting/references/02-review-focus.md +64 -0
- package/skills/crwu/crwu-audit-biz-financial-reporting/references/03-common-contract.md +202 -0
- package/skills/crwu/crwu-audit-biz-financing-debt/SKILL.md +38 -0
- package/skills/crwu/crwu-audit-biz-financing-debt/references/00-applicability.md +31 -0
- package/skills/crwu/crwu-audit-biz-financing-debt/references/01-kb-assembly.md +34 -0
- package/skills/crwu/crwu-audit-biz-financing-debt/references/02-review-focus.md +47 -0
- package/skills/crwu/crwu-audit-biz-financing-debt/references/03-common-contract.md +202 -0
- package/skills/crwu/crwu-audit-biz-investment-capital/SKILL.md +38 -0
- package/skills/crwu/crwu-audit-biz-investment-capital/references/00-applicability.md +31 -0
- package/skills/crwu/crwu-audit-biz-investment-capital/references/01-kb-assembly.md +34 -0
- package/skills/crwu/crwu-audit-biz-investment-capital/references/02-review-focus.md +47 -0
- package/skills/crwu/crwu-audit-biz-investment-capital/references/03-common-contract.md +202 -0
- package/skills/crwu/crwu-audit-biz-judicial-liquidation-compensation/SKILL.md +38 -0
- package/skills/crwu/crwu-audit-biz-judicial-liquidation-compensation/references/00-applicability.md +30 -0
- package/skills/crwu/crwu-audit-biz-judicial-liquidation-compensation/references/01-kb-assembly.md +32 -0
- package/skills/crwu/crwu-audit-biz-judicial-liquidation-compensation/references/02-review-focus.md +40 -0
- package/skills/crwu/crwu-audit-biz-judicial-liquidation-compensation/references/03-common-contract.md +202 -0
- package/skills/crwu/crwu-audit-biz-tax-history/SKILL.md +38 -0
- package/skills/crwu/crwu-audit-biz-tax-history/references/00-applicability.md +29 -0
- package/skills/crwu/crwu-audit-biz-tax-history/references/01-kb-assembly.md +30 -0
- package/skills/crwu/crwu-audit-biz-tax-history/references/02-review-focus.md +33 -0
- package/skills/crwu/crwu-audit-biz-tax-history/references/03-common-contract.md +202 -0
- package/skills/crwu/crwu-audit-biz-transaction-disposal/SKILL.md +38 -0
- package/skills/crwu/crwu-audit-biz-transaction-disposal/references/00-applicability.md +31 -0
- package/skills/crwu/crwu-audit-biz-transaction-disposal/references/01-kb-assembly.md +34 -0
- package/skills/crwu/crwu-audit-biz-transaction-disposal/references/02-review-focus.md +47 -0
- package/skills/crwu/crwu-audit-biz-transaction-disposal/references/03-common-contract.md +202 -0
- package/skills/crwu/crwu-audit-datacheck/SKILL.md +59 -0
- package/skills/crwu/crwu-audit-datacheck/references/00-KB/350/243/205/351/205/215/350/241/250.md +25 -0
- package/skills/crwu/crwu-audit-datacheck/references/01-runtime-and-check-catalog.md +139 -0
- package/skills/crwu/crwu-audit-datacheck/scripts/recalc_check.py +521 -0
- package/skills/crwu/crwu-audit-datacheck/scripts/test_recalc_check.py +419 -0
- package/skills/crwu/crwu-audit-datacheck/scripts/test_skill_self_containment.py +44 -0
- package/skills/crwu/crwu-audit-external-data/SKILL.md +73 -0
- package/skills/crwu/crwu-audit-external-data/references/00-KB/350/243/205/351/205/215/350/241/250.md +38 -0
- package/skills/crwu/crwu-audit-external-data/references/01-connector-access.md +116 -0
- package/skills/crwu/crwu-audit-external-data/references/02-verification-workflow.md +78 -0
- package/skills/crwu/crwu-audit-external-data/scripts/connector_probe.py +374 -0
- package/skills/crwu/crwu-audit-external-data/scripts/test_connector_probe.py +264 -0
- package/skills/crwu/crwu-audit-output-filter/SKILL.md +34 -0
- package/skills/crwu/crwu-audit-output-filter/references/00-applicability.md +7 -0
- package/skills/crwu/crwu-audit-output-filter/references/01-kb-assembly.md +11 -0
- package/skills/crwu/crwu-audit-output-filter/references/02-review-focus.md +25 -0
- package/skills/crwu/crwu-audit-public-general-standards/SKILL.md +46 -0
- package/skills/crwu/crwu-audit-public-general-standards/references/00-applicability.md +41 -0
- package/skills/crwu/crwu-audit-public-general-standards/references/01-kb-assembly.md +66 -0
- package/skills/crwu/crwu-audit-public-general-standards/references/02-review-focus.md +111 -0
- package/skills/crwu/crwu-audit-public-general-standards/references/03-execution-contract.md +89 -0
- package/skills/crwu/crwu-dev-audit-optimize/SKILL.md +98 -0
- package/skills/crwu/crwu-dev-audit-optimize/references/00-/344/274/230/345/214/226/350/247/204/350/214/203/344/270/216/346/226/207/344/273/266/350/220/275/347/202/271.md +132 -0
- package/skills/crwu/crwu-dev-audit-optimize/references/01-/345/217/215/351/246/210/345/256/232/344/275/215/344/270/216/347/224/273/345/203/217/346/265/201/347/250/213.md +108 -0
- package/skills/crwu/crwu-dev-audit-optimize/references/02-/346/226/271/346/241/210/346/250/241/346/235/277/344/270/216/347/241/256/350/256/244/351/227/250/347/246/201.md +92 -0
- package/skills/crwu/crwu-dev-audit-optimize/references/03-AI/344/272/272/345/267/245/345/267/256/350/267/235/345/210/206/346/236/220/346/265/201/347/250/213.md +95 -0
- package/skills/crwu/crwu-dev-audit-optimize/scripts/examples/gap-analysis.sample.json +116 -0
- package/skills/crwu/crwu-dev-audit-optimize/scripts/gap_analysis.schema.json +33 -0
- package/skills/crwu/crwu-dev-audit-optimize/scripts/gap_analysis_delivery.py +475 -0
- package/skills/crwu/crwu-dev-audit-optimize/scripts/test_gap_analysis_delivery.py +855 -0
- package/skills/crwu/crwu-dev-audit-optimize/template/NOTICE.echarts.txt +7 -0
- package/skills/crwu/crwu-dev-audit-optimize/template/echarts.min.js +45 -0
- package/skills/crwu/crwu-dev-audit-optimize/template/gap-analysis-report.html +71 -0
- package/skills/crwu/crwu-dev-audit-skill-maintainer/SKILL.md +74 -0
- package/skills/crwu/crwu-dev-audit-skill-maintainer/references/00-responsibility-and-modes.md +62 -0
- package/skills/crwu/crwu-dev-audit-skill-maintainer/references/01-kb-source-discovery.md +89 -0
- package/skills/crwu/crwu-dev-audit-skill-maintainer/references/02-child-skill-contract.md +99 -0
- package/skills/crwu/crwu-dev-audit-skill-maintainer/references/03-review-item-execution-contract.md +51 -0
- package/skills/crwu/crwu-dev-audit-skill-maintainer/references/04-registry-and-mapping-update.md +73 -0
- package/skills/crwu/crwu-dev-audit-skill-maintainer/references/05-validation-and-delivery.md +127 -0
- package/skills/crwu/crwu-dev-audit-skill-maintainer/references/06-live-routing-reconciliation.md +136 -0
- package/skills/crwu/crwu-dev-audit-skill-maintainer/references/07-kb-skill-map.md +411 -0
- package/skills/crwu/crwu-dev-audit-skill-maintainer/scripts/README.md +200 -0
- package/skills/crwu/crwu-dev-audit-skill-maintainer/scripts/check_audit_skill_mappings.py +2477 -0
- package/skills/crwu/crwu-dev-audit-skill-maintainer/scripts/kb_tool.py +577 -0
- package/skills/crwu/crwu-dev-audit-skill-maintainer/scripts/test_audit_skill_maintainer.py +5097 -0
- package/skills/dws/LICENSE +178 -0
- package/skills/dws/NOTICE +17 -0
- package/skills/dws/dingtalk-aisearch/SKILL.md +83 -0
- package/skills/dws/dingtalk-aisearch/references/aisearch.md +249 -0
- package/skills/dws/dingtalk-aisearch/references/intent-guide.md +15 -0
- package/skills/dws/dingtalk-aisearch/references/lite-recipes.md +31 -0
- package/skills/dws/dingtalk-aitable/SKILL.md +139 -0
- package/skills/dws/dingtalk-aitable/references/06-data-analytics.md +11 -0
- package/skills/dws/dingtalk-aitable/references/aitable/aitable-advperm.md +251 -0
- package/skills/dws/dingtalk-aitable/references/aitable/aitable-attachment.md +49 -0
- package/skills/dws/dingtalk-aitable/references/aitable/aitable-best-practices.md +48 -0
- package/skills/dws/dingtalk-aitable/references/aitable/aitable-cell-value.md +346 -0
- package/skills/dws/dingtalk-aitable/references/aitable/aitable-dashboard-chart.md +46 -0
- package/skills/dws/dingtalk-aitable/references/aitable/aitable-data-analysis-sop.md +131 -0
- package/skills/dws/dingtalk-aitable/references/aitable/aitable-datasource.md +272 -0
- package/skills/dws/dingtalk-aitable/references/aitable/aitable-error-recovery.md +128 -0
- package/skills/dws/dingtalk-aitable/references/aitable/aitable-export-import.md +113 -0
- package/skills/dws/dingtalk-aitable/references/aitable/aitable-field-properties.md +238 -0
- package/skills/dws/dingtalk-aitable/references/aitable/aitable-field.md +186 -0
- package/skills/dws/dingtalk-aitable/references/aitable/aitable-filter-sort.md +135 -0
- package/skills/dws/dingtalk-aitable/references/aitable/aitable-form.md +130 -0
- package/skills/dws/dingtalk-aitable/references/aitable/aitable-formula-guide.md +224 -0
- package/skills/dws/dingtalk-aitable/references/aitable/aitable-primary-doc.md +58 -0
- package/skills/dws/dingtalk-aitable/references/aitable/aitable-record-create.md +52 -0
- package/skills/dws/dingtalk-aitable/references/aitable/aitable-record-delete.md +20 -0
- package/skills/dws/dingtalk-aitable/references/aitable/aitable-record-history.md +97 -0
- package/skills/dws/dingtalk-aitable/references/aitable/aitable-record-name-key.md +47 -0
- package/skills/dws/dingtalk-aitable/references/aitable/aitable-record-query.md +120 -0
- package/skills/dws/dingtalk-aitable/references/aitable/aitable-record-share.md +54 -0
- package/skills/dws/dingtalk-aitable/references/aitable/aitable-record-stats.md +59 -0
- package/skills/dws/dingtalk-aitable/references/aitable/aitable-record-update.md +66 -0
- package/skills/dws/dingtalk-aitable/references/aitable/aitable-record-upsert.md +89 -0
- package/skills/dws/dingtalk-aitable/references/aitable/aitable-view-config.md +140 -0
- package/skills/dws/dingtalk-aitable/references/aitable/aitable-view-extras.md +195 -0
- package/skills/dws/dingtalk-aitable/references/aitable/aitable-view-types.md +95 -0
- package/skills/dws/dingtalk-aitable/references/aitable/aitable-workflow.md +384 -0
- package/skills/dws/dingtalk-aitable/references/aitable-record-ops.md +80 -0
- package/skills/dws/dingtalk-aitable/references/aitable-section.md +30 -0
- package/skills/dws/dingtalk-aitable/references/aitable.md +59 -0
- package/skills/dws/dingtalk-aitable/references/field-rules.md +17 -0
- package/skills/dws/dingtalk-aitable/references/intent-guide.md +17 -0
- package/skills/dws/dingtalk-aitable/references/recipes/conventions.md +44 -0
- package/skills/dws/dingtalk-aitable/references/url-patterns.md +144 -0
- package/skills/dws/dingtalk-aitable/scripts/aitable_export_via_task.py +210 -0
- package/skills/dws/dingtalk-aitable/scripts/aitable_import_via_task.py +173 -0
- package/skills/dws/dingtalk-aitable/scripts/bulk_add_fields.py +273 -0
- package/skills/dws/dingtalk-aitable/scripts/import_records.py +333 -0
- package/skills/dws/dingtalk-aitable/scripts/upload_attachment.py +190 -0
- package/skills/dws/dingtalk-calendar/SKILL.md +137 -0
- package/skills/dws/dingtalk-calendar/references/03-meeting.md +56 -0
- package/skills/dws/dingtalk-calendar/references/calendar.md +760 -0
- package/skills/dws/dingtalk-calendar/references/intent-guide.md +9 -0
- package/skills/dws/dingtalk-calendar/references/lite-recipes.md +25 -0
- package/skills/dws/dingtalk-calendar/scripts/calendar_free_slot_finder.py +199 -0
- package/skills/dws/dingtalk-calendar/scripts/calendar_schedule_meeting.py +233 -0
- package/skills/dws/dingtalk-calendar/scripts/calendar_today_agenda.py +139 -0
- package/skills/dws/dingtalk-chat/SKILL.md +127 -0
- package/skills/dws/dingtalk-chat/references/01-messaging.md +103 -0
- package/skills/dws/dingtalk-chat/references/card/callback.md +10 -0
- package/skills/dws/dingtalk-chat/references/card/create.md +27 -0
- package/skills/dws/dingtalk-chat/references/card/schema.md +14 -0
- package/skills/dws/dingtalk-chat/references/card/update.md +13 -0
- package/skills/dws/dingtalk-chat/references/chat/chat-bot.md +187 -0
- package/skills/dws/dingtalk-chat/references/chat/chat-conversation.md +165 -0
- package/skills/dws/dingtalk-chat/references/chat/group-admin.md +144 -0
- package/skills/dws/dingtalk-chat/references/chat/group-discovery.md +121 -0
- package/skills/dws/dingtalk-chat/references/chat/message-actions.md +132 -0
- package/skills/dws/dingtalk-chat/references/chat/message-media.md +76 -0
- package/skills/dws/dingtalk-chat/references/chat/message-query.md +135 -0
- package/skills/dws/dingtalk-chat/references/chat/thread.md +46 -0
- package/skills/dws/dingtalk-chat/references/chat-emoji-list.md +216 -0
- package/skills/dws/dingtalk-chat/references/chat.md +140 -0
- package/skills/dws/dingtalk-chat/references/contracts.md +70 -0
- package/skills/dws/dingtalk-chat/references/intent-guide.md +56 -0
- package/skills/dws/dingtalk-contact/SKILL.md +122 -0
- package/skills/dws/dingtalk-contact/references/08-directory.md +51 -0
- package/skills/dws/dingtalk-contact/references/contact.md +595 -0
- package/skills/dws/dingtalk-contact/references/intent-guide.md +14 -0
- package/skills/dws/dingtalk-contact/references/lite-recipes.md +30 -0
- package/skills/dws/dingtalk-contact/references/recipes/conventions.md +44 -0
- package/skills/dws/dingtalk-contact/scripts/contact_dept_members.py +130 -0
- package/skills/dws/dingtalk-doc/SKILL.md +112 -0
- package/skills/dws/dingtalk-doc/references/04-document.md +57 -0
- package/skills/dws/dingtalk-doc/references/contracts.md +40 -0
- package/skills/dws/dingtalk-doc/references/doc/doc-block.md +39 -0
- package/skills/dws/dingtalk-doc/references/doc/doc-comment.md +29 -0
- package/skills/dws/dingtalk-doc/references/doc/doc-create.md +54 -0
- package/skills/dws/dingtalk-doc/references/doc/doc-export.md +30 -0
- package/skills/dws/dingtalk-doc/references/doc/doc-import.md +28 -0
- package/skills/dws/dingtalk-doc/references/doc/doc-info.md +12 -0
- package/skills/dws/dingtalk-doc/references/doc/doc-media.md +46 -0
- package/skills/dws/dingtalk-doc/references/doc/doc-read.md +56 -0
- package/skills/dws/dingtalk-doc/references/doc/doc-update.md +87 -0
- package/skills/dws/dingtalk-doc/references/doc/format/doc-jsonml-cookbook.md +469 -0
- package/skills/dws/dingtalk-doc/references/doc/format/doc-jsonml-schema.json +526 -0
- package/skills/dws/dingtalk-doc/references/doc/format/doc-jsonml-schema.md +711 -0
- package/skills/dws/dingtalk-doc/references/doc/style/doc-create-workflow.md +414 -0
- package/skills/dws/dingtalk-doc/references/doc/style/doc-style-guideline.md +404 -0
- package/skills/dws/dingtalk-doc/references/doc/style/doc-update-workflow.md +316 -0
- package/skills/dws/dingtalk-doc/references/doc.md +82 -0
- package/skills/dws/dingtalk-doc/references/intent-guide.md +20 -0
- package/skills/dws/dingtalk-drive/SKILL.md +128 -0
- package/skills/dws/dingtalk-drive/references/drive.md +126 -0
- package/skills/dws/dingtalk-drive/references/folder-sync.md +40 -0
- package/skills/dws/dingtalk-drive/references/intent-guide.md +22 -0
- package/skills/dws/dingtalk-drive/references/lite-recipes.md +39 -0
- package/skills/dws/dingtalk-event/SKILL.md +106 -0
- package/skills/dws/dingtalk-event/references/event-im-keys.md +54 -0
- package/skills/dws/dingtalk-event/references/event-im-lifecycle.md +35 -0
- package/skills/dws/dingtalk-event/references/event-im-operations.md +52 -0
- package/skills/dws/dingtalk-event/references/event-im-output.md +39 -0
- package/skills/dws/dingtalk-event/references/event-im.md +58 -0
- package/skills/dws/dingtalk-event/references/event-oa.md +155 -0
- package/skills/dws/dingtalk-event/references/event-todo.md +50 -0
- package/skills/dws/dingtalk-event/references/event-voip.md +69 -0
- package/skills/dws/dingtalk-mail/SKILL.md +113 -0
- package/skills/dws/dingtalk-mail/references/09-mail.md +45 -0
- package/skills/dws/dingtalk-mail/references/intent-guide.md +8 -0
- package/skills/dws/dingtalk-mail/references/lite-recipes.md +45 -0
- package/skills/dws/dingtalk-mail/references/mail.md +1889 -0
- package/skills/dws/dingtalk-mail/references/recipes/conventions.md +44 -0
- package/skills/dws/dingtalk-mail/scripts/mail_send_with_cc.py +122 -0
- package/skills/dws/dingtalk-mail/scripts/mail_unread_summary.py +114 -0
- package/skills/dws/dingtalk-minutes/SKILL.md +116 -0
- package/skills/dws/dingtalk-minutes/references/07-minutes.md +149 -0
- package/skills/dws/dingtalk-minutes/references/10-minutes-speaker-match.md +32 -0
- package/skills/dws/dingtalk-minutes/references/11-minutes-speaker-correct.md +40 -0
- package/skills/dws/dingtalk-minutes/references/intent-guide.md +79 -0
- package/skills/dws/dingtalk-minutes/references/lite-recipes.md +25 -0
- package/skills/dws/dingtalk-minutes/references/minutes.md +210 -0
- package/skills/dws/dingtalk-minutes/references/recipes/conventions.md +33 -0
- package/skills/dws/dingtalk-minutes/scripts/minutes_recent_summary.py +196 -0
- package/skills/dws/dingtalk-minutes/scripts/test_minutes_scripts.py +222 -0
- package/skills/dws/dingtalk-misc/SKILL.md +55 -0
- package/skills/dws/dingtalk-misc/references/05-reporting.md +29 -0
- package/skills/dws/dingtalk-misc/references/agoal.md +302 -0
- package/skills/dws/dingtalk-misc/references/attendance-intent-guide.md +7 -0
- package/skills/dws/dingtalk-misc/references/attendance-report.md +109 -0
- package/skills/dws/dingtalk-misc/references/attendance-schedule.md +115 -0
- package/skills/dws/dingtalk-misc/references/attendance-vacation.md +129 -0
- package/skills/dws/dingtalk-misc/references/attendance.md +149 -0
- package/skills/dws/dingtalk-misc/references/dev/app.md +42 -0
- package/skills/dws/dingtalk-misc/references/dev/connect.md +108 -0
- package/skills/dws/dingtalk-misc/references/dev/credentials.md +26 -0
- package/skills/dws/dingtalk-misc/references/dev/dev-index.md +13 -0
- package/skills/dws/dingtalk-misc/references/dev/event.md +47 -0
- package/skills/dws/dingtalk-misc/references/dev/mcp.md +106 -0
- package/skills/dws/dingtalk-misc/references/dev/member.md +19 -0
- package/skills/dws/dingtalk-misc/references/dev/permission.md +56 -0
- package/skills/dws/dingtalk-misc/references/dev/recipes.md +58 -0
- package/skills/dws/dingtalk-misc/references/dev/robot.md +74 -0
- package/skills/dws/dingtalk-misc/references/dev/security.md +21 -0
- package/skills/dws/dingtalk-misc/references/dev/version.md +99 -0
- package/skills/dws/dingtalk-misc/references/dev/webapp.md +22 -0
- package/skills/dws/dingtalk-misc/references/devapp.md +148 -0
- package/skills/dws/dingtalk-misc/references/devdoc-intent-guide.md +7 -0
- package/skills/dws/dingtalk-misc/references/devdoc.md +42 -0
- package/skills/dws/dingtalk-misc/references/ding.md +184 -0
- package/skills/dws/dingtalk-misc/references/hrbrain.md +67 -0
- package/skills/dws/dingtalk-misc/references/live.md +23 -0
- package/skills/dws/dingtalk-misc/references/markdown.md +167 -0
- package/skills/dws/dingtalk-misc/references/oa/oa-form-components.md +345 -0
- package/skills/dws/dingtalk-misc/references/oa/oa-process-nodes.md +374 -0
- package/skills/dws/dingtalk-misc/references/oa.md +1014 -0
- package/skills/dws/dingtalk-misc/references/openapi-explorer.md +47 -0
- package/skills/dws/dingtalk-misc/references/pat.md +52 -0
- package/skills/dws/dingtalk-misc/references/profile.md +41 -0
- package/skills/dws/dingtalk-misc/references/recruit.md +89 -0
- package/skills/dws/dingtalk-misc/references/report-conventions.md +44 -0
- package/skills/dws/dingtalk-misc/references/report-intent-guide.md +11 -0
- package/skills/dws/dingtalk-misc/references/report-lite-recipes.md +25 -0
- package/skills/dws/dingtalk-misc/references/report.md +109 -0
- package/skills/dws/dingtalk-misc/references/sheet/sheet-batch-operations.md +104 -0
- package/skills/dws/dingtalk-misc/references/sheet/sheet-chart.md +69 -0
- package/skills/dws/dingtalk-misc/references/sheet/sheet-comment.md +166 -0
- package/skills/dws/dingtalk-misc/references/sheet/sheet-conditional-format.md +59 -0
- package/skills/dws/dingtalk-misc/references/sheet/sheet-dimension-operations.md +60 -0
- package/skills/dws/dingtalk-misc/references/sheet/sheet-dropdown.md +103 -0
- package/skills/dws/dingtalk-misc/references/sheet/sheet-export.md +135 -0
- package/skills/dws/dingtalk-misc/references/sheet/sheet-filter-view.md +51 -0
- package/skills/dws/dingtalk-misc/references/sheet/sheet-filter.md +181 -0
- package/skills/dws/dingtalk-misc/references/sheet/sheet-formula.md +192 -0
- package/skills/dws/dingtalk-misc/references/sheet/sheet-import.md +76 -0
- package/skills/dws/dingtalk-misc/references/sheet/sheet-media-image.md +263 -0
- package/skills/dws/dingtalk-misc/references/sheet/sheet-pivot-table.md +292 -0
- package/skills/dws/dingtalk-misc/references/sheet/sheet-range-operations.md +161 -0
- package/skills/dws/dingtalk-misc/references/sheet/sheet-read-data.md +60 -0
- package/skills/dws/dingtalk-misc/references/sheet/sheet-revision-changeset.md +46 -0
- package/skills/dws/dingtalk-misc/references/sheet/sheet-search-replace.md +120 -0
- package/skills/dws/dingtalk-misc/references/sheet/sheet-style-format.md +71 -0
- package/skills/dws/dingtalk-misc/references/sheet/sheet-version.md +84 -0
- package/skills/dws/dingtalk-misc/references/sheet/sheet-workbook.md +59 -0
- package/skills/dws/dingtalk-misc/references/sheet/sheet-write-data.md +93 -0
- package/skills/dws/dingtalk-misc/references/sheet-conventions.md +44 -0
- package/skills/dws/dingtalk-misc/references/sheet-intent-guide.md +12 -0
- package/skills/dws/dingtalk-misc/references/sheet.md +166 -0
- package/skills/dws/dingtalk-misc/references/skill.md +98 -0
- package/skills/dws/dingtalk-misc/references/unsupported-scripts.md +49 -0
- package/skills/dws/dingtalk-misc/references/url-patterns.md +144 -0
- package/skills/dws/dingtalk-misc/references/whiteboard/compose.md +200 -0
- package/skills/dws/dingtalk-misc/references/whiteboard/open-nodes-v1/01-overview.md +57 -0
- package/skills/dws/dingtalk-misc/references/whiteboard/open-nodes-v1/02-query.md +288 -0
- package/skills/dws/dingtalk-misc/references/whiteboard/open-nodes-v1/03-update.md +249 -0
- package/skills/dws/dingtalk-misc/references/whiteboard/open-nodes-v1/04-text-style.md +395 -0
- package/skills/dws/dingtalk-misc/references/whiteboard/open-nodes-v1/05-shape-frame-group-connector.md +186 -0
- package/skills/dws/dingtalk-misc/references/whiteboard/open-nodes-v1/06-vector-icon-path.md +313 -0
- package/skills/dws/dingtalk-misc/references/whiteboard/open-nodes-v1/07-examples-errors-write-support.md +270 -0
- package/skills/dws/dingtalk-misc/references/whiteboard/open-nodes-v1/08-catalogs.md +61 -0
- package/skills/dws/dingtalk-misc/references/whiteboard/open-nodes-v1.md +54 -0
- package/skills/dws/dingtalk-misc/references/whiteboard/replace.md +41 -0
- package/skills/dws/dingtalk-misc/references/whiteboard/vector.md +51 -0
- package/skills/dws/dingtalk-misc/references/whiteboard.md +115 -0
- package/skills/dws/dingtalk-misc/scripts/aiapp_create_and_poll.py +138 -0
- package/skills/dws/dingtalk-misc/scripts/attendance_my_record.py +91 -0
- package/skills/dws/dingtalk-misc/scripts/attendance_report_checkin.py +440 -0
- package/skills/dws/dingtalk-misc/scripts/attendance_report_common.py +1698 -0
- package/skills/dws/dingtalk-misc/scripts/attendance_report_daily.py +558 -0
- package/skills/dws/dingtalk-misc/scripts/attendance_report_detail.py +809 -0
- package/skills/dws/dingtalk-misc/scripts/attendance_report_monthly.py +758 -0
- package/skills/dws/dingtalk-misc/scripts/attendance_report_record.py +947 -0
- package/skills/dws/dingtalk-misc/scripts/attendance_schedule_export.py +344 -0
- package/skills/dws/dingtalk-misc/scripts/attendance_schedule_import.py +498 -0
- package/skills/dws/dingtalk-misc/scripts/attendance_team_shift.py +89 -0
- package/skills/dws/dingtalk-misc/scripts/attendance_vacation_balance.py +617 -0
- package/skills/dws/dingtalk-misc/scripts/finance_daily_cashflow.py +70 -0
- package/skills/dws/dingtalk-misc/scripts/finance_expense_flow.py +138 -0
- package/skills/dws/dingtalk-misc/scripts/oa_batch_approve.py +158 -0
- package/skills/dws/dingtalk-misc/scripts/oa_pending_review.py +132 -0
- package/skills/dws/dingtalk-misc/scripts/report_received_today.py +315 -0
- package/skills/dws/dingtalk-misc/scripts/yida_custom_page_update.py +401 -0
- package/skills/dws/dingtalk-misc/scripts/yida_form_builder.py +526 -0
- package/skills/dws/dingtalk-misc/scripts/yida_form_fields.py +315 -0
- package/skills/dws/dingtalk-misc/scripts/yida_form_inspector.py +311 -0
- package/skills/dws/dingtalk-misc/scripts/yida_form_update.py +185 -0
- package/skills/dws/dingtalk-misc/scripts/yida_jsx_pipeline.py +1588 -0
- package/skills/dws/dingtalk-misc/scripts/yida_page_compiler.py +1441 -0
- package/skills/dws/dingtalk-misc/scripts/yida_page_generate.py +514 -0
- package/skills/dws/dingtalk-misc/scripts/yida_page_schema.py +519 -0
- package/skills/dws/dingtalk-misc/scripts/yida_page_self_check.py +398 -0
- package/skills/dws/dingtalk-misc/scripts/yida_process_flow.py +1478 -0
- package/skills/dws/dingtalk-misc/scripts/yida_process_update.py +589 -0
- package/skills/dws/dingtalk-misc/scripts/yida_report_builder.py +494 -0
- package/skills/dws/dingtalk-misc/scripts/yida_report_charts.py +1434 -0
- package/skills/dws/dingtalk-misc/scripts/yida_report_update.py +244 -0
- package/skills/dws/dingtalk-misc/scripts/yida_schema_common.py +340 -0
- package/skills/dws/dingtalk-shared/SKILL.md +83 -0
- package/skills/dws/dingtalk-shared/references/capability-limits.md +31 -0
- package/skills/dws/dingtalk-shared/references/channel-login.md +26 -0
- package/skills/dws/dingtalk-shared/references/confirmation.md +59 -0
- package/skills/dws/dingtalk-shared/references/error-codes.md +155 -0
- package/skills/dws/dingtalk-shared/references/global-reference.md +122 -0
- package/skills/dws/dingtalk-shared/references/intent-guide.md +537 -0
- package/skills/dws/dingtalk-shared/references/recipes/conventions.md +45 -0
- package/skills/dws/dingtalk-shared/references/recipes/lite-catalog.md +275 -0
- package/skills/dws/dingtalk-shared/references/recipes/meta.md +67 -0
- package/skills/dws/dingtalk-shared/references/routing.md +52 -0
- package/skills/dws/dingtalk-shared/references/runtime-contract.md +11 -0
- package/skills/dws/dingtalk-shared/references/schema-usage.md +88 -0
- package/skills/dws/dingtalk-shared/references/url-patterns.md +144 -0
- package/skills/dws/dingtalk-shared/references/workflow-routing.md +45 -0
- package/skills/dws/dingtalk-todo/SKILL.md +119 -0
- package/skills/dws/dingtalk-todo/references/02-task.md +70 -0
- package/skills/dws/dingtalk-todo/references/intent-guide.md +15 -0
- package/skills/dws/dingtalk-todo/references/lite-recipes.md +68 -0
- package/skills/dws/dingtalk-todo/references/recipes/conventions.md +44 -0
- package/skills/dws/dingtalk-todo/references/todo.md +517 -0
- package/skills/dws/dingtalk-todo/scripts/todo_batch_create.py +354 -0
- package/skills/dws/dingtalk-todo/scripts/todo_daily_summary.py +153 -0
- package/skills/dws/dingtalk-todo/scripts/todo_overdue_check.py +101 -0
- package/skills/dws/dingtalk-wiki/SKILL.md +117 -0
- package/skills/dws/dingtalk-wiki/references/intent-guide.md +14 -0
- package/skills/dws/dingtalk-wiki/references/lite-recipes.md +44 -0
- package/skills/dws/dingtalk-wiki/references/wiki-members.md +32 -0
- package/skills/dws/dingtalk-wiki/references/wiki-node-ops.md +46 -0
- package/skills/dws/dingtalk-wiki/references/wiki.md +65 -0
- package/skills/dws/provenance.json +27 -0
|
@@ -0,0 +1,711 @@
|
|
|
1
|
+
# 文档 JSONML 节点结构参考
|
|
2
|
+
|
|
3
|
+
> **权威定义**:合法节点类型、允许的子节点和属性约束以 `wukong/products/jsonml-schema-v2.json` 为准。本文为可读版摘要,若与 schema-v2.json 冲突以后者为准。
|
|
4
|
+
|
|
5
|
+
本文档定义钉钉文档 body JSONML 中所有节点类型的结构,供 agent 编辑文档时参考。
|
|
6
|
+
**写法范例**见 [doc-jsonml-cookbook.md](./doc-jsonml-cookbook.md);本文聚焦字段定义、枚举与约束。
|
|
7
|
+
|
|
8
|
+
## 格式说明
|
|
9
|
+
|
|
10
|
+
JSONML 是文档内容树的序列化格式:
|
|
11
|
+
|
|
12
|
+
```
|
|
13
|
+
[tag, attrs?, ...children]
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
- `tag` — 字符串,节点类型标识
|
|
17
|
+
- `attrs` — 可选对象,节点属性(写入时**强烈建议**始终传 `{}` 而非省略)
|
|
18
|
+
- `children` — 子节点数组;可以是嵌套节点或(仅 inline 上下文中)字符串
|
|
19
|
+
|
|
20
|
+
文档 body 是一个以 `"root"` 为根的 JSONML 节点,`dws doc read --content-format jsonml` 返回此格式:
|
|
21
|
+
|
|
22
|
+
```json
|
|
23
|
+
["root", {"sectPr": {"pgSz": {"w": 11906, "h": 16838}}},
|
|
24
|
+
["p", {"uuid": "p1"}, ["span", {"data-type": "text"}, ["span", {"data-type": "leaf"}, "第一段"]]],
|
|
25
|
+
["p", {"uuid": "p2"}, ["span", {"data-type": "text"}, ["span", {"data-type": "leaf"}, "第二段"]]]
|
|
26
|
+
]
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
- 第一个元素固定为 `"root"`
|
|
30
|
+
- 第二个元素为文档级属性对象(如 `sectPr` 页面设置),可选
|
|
31
|
+
- 后续元素为块级节点(每个 block 节点应带 `uuid`)
|
|
32
|
+
|
|
33
|
+
全量覆写(overwrite)时,CLI 要求 body 必须以 `["root", ...]` 为根节点:
|
|
34
|
+
|
|
35
|
+
1. `["root", {sectPr}, ...blocks]` — 服务端 canonical 形式,`doc read` 输出
|
|
36
|
+
2. `["root", {}, ...blocks]` — 无页面设置时用空 attrs
|
|
37
|
+
|
|
38
|
+
## CLI 行为概览(validator)
|
|
39
|
+
|
|
40
|
+
写入端(`doc create/update`、`block insert/update`)走 **validate** 一步,不做结构修复:
|
|
41
|
+
|
|
42
|
+
| 行为 | 缺省 | `--fix-jsonml` |
|
|
43
|
+
|------|------|----------------|
|
|
44
|
+
| JSON 语法修复(括号/逗号补全) | ✗ | ✓(打印 `[FIX]`) |
|
|
45
|
+
| validator 阻断(HasErrors → 拒绝发送) | ✓ | ✓ |
|
|
46
|
+
| validator 警告(warnings → 仅 stderr) | ✓ | ✓ |
|
|
47
|
+
| root 校验(仅 doc create/update) | ✓ | ✓ |
|
|
48
|
+
|
|
49
|
+
> `doc create/update` 要求 body 必须以 `["root", {attrs?}, ...blocks]` 为根节点。缺少 root 会报错而非自动包装。`doc block insert/update` 不要求 root。
|
|
50
|
+
|
|
51
|
+
报错格式(面向 agent):
|
|
52
|
+
|
|
53
|
+
```
|
|
54
|
+
$[2][2]: paragraph child must be span wrapper, got raw string.
|
|
55
|
+
Suggestion: ["span",{"data-type":"text"},["span",{"data-type":"leaf"},"<your text>"]]
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
`$` 表示输入根,`[i]` 是数组下标,`.attrs.k` 是属性名。
|
|
59
|
+
|
|
60
|
+
## 文本节点(Text)
|
|
61
|
+
|
|
62
|
+
**Canonical 形式**(服务端 serialize 输出、`doc read --content-format jsonml` 返回的就是这个):
|
|
63
|
+
|
|
64
|
+
```json
|
|
65
|
+
["span", {"data-type": "text"},
|
|
66
|
+
["span", {"data-type": "leaf", "bold": true}, "加粗文本"],
|
|
67
|
+
["span", {"data-type": "leaf"}, "普通文本"]
|
|
68
|
+
]
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
- **text 容器**:`["span", {"data-type": "text"}, ...leaves]` — 包裹所有 leaf
|
|
72
|
+
- **leaf 节点**:`["span", {"data-type": "leaf", ...marks}, "<文本>"]` — 实际承载文字与样式
|
|
73
|
+
- 一个 block 通常只有一个 text 容器,可以含多个 leaf(不同样式片段)
|
|
74
|
+
- text 容器与 `["a", ...]`、`["img", ...]`、`["tag", ...]` 等其他 inline 节点**并列**作为 block 的子节点
|
|
75
|
+
|
|
76
|
+
### 文本样式属性(Marks,写在 leaf 的 attrs 上)
|
|
77
|
+
|
|
78
|
+
所有 marks 均为 optional,按需组合。
|
|
79
|
+
|
|
80
|
+
| 属性 | 类型 | 格式/枚举 | 说明 |
|
|
81
|
+
|------|------|-----------|------|
|
|
82
|
+
| `bold` | `boolean` | `true` / `false` | 加粗。`false` 可反向取消继承 |
|
|
83
|
+
| `italic` | `boolean` | `true` | 斜体 |
|
|
84
|
+
| `strike` | `boolean` | `true` / `false` | 单删除线 |
|
|
85
|
+
| `dstrike` | `boolean` | `true` / `false` | 双删除线(独立于 strike) |
|
|
86
|
+
| `underline` | `object` | `{value, color?}` | 下划线。value: `"single"` \| `"dash"` \| `"wave"` \| `"double"` \| `"none"` |
|
|
87
|
+
| `color` | `string` | `"#rrggbb"` | 文字颜色 |
|
|
88
|
+
| `highlight` | `string` | CSS 颜色 | 文字高亮背景色 |
|
|
89
|
+
| `shd` | `object` | `{val?, color?, fill?}` | OOXML 底纹(Word 导入保留) |
|
|
90
|
+
| `sz` | `number` | 数值 | 字号,配合 `szUnit` |
|
|
91
|
+
| `szUnit` | `string` | `"px"` \| `"pt"` | 字号单位,默认 `"px"` |
|
|
92
|
+
| `fonts` | `object` | `{ascii, hAnsi, cs, eastAsia}` | OOXML 四分区字体,值为 font-family 名称(如 `SimHei`),不能写中文名 |
|
|
93
|
+
| `vertAlign` | `string` | `"superscript"` \| `"subscript"` \| `"baseline"` | 上标/下标/基线 |
|
|
94
|
+
| `spacing` | `number` | 数值(pt) | 字间距 |
|
|
95
|
+
|
|
96
|
+
示例:
|
|
97
|
+
|
|
98
|
+
```json
|
|
99
|
+
["span", {"data-type": "text"},
|
|
100
|
+
["span", {"data-type": "leaf", "bold": true, "italic": true, "color": "#1a73e8"}, "加粗斜体蓝字"]
|
|
101
|
+
]
|
|
102
|
+
["span", {"data-type": "text"},
|
|
103
|
+
["span", {"data-type": "leaf", "underline": {"value": "single", "color": "#ff0000"}, "sz": 14, "szUnit": "px"}, "红色下划线"]
|
|
104
|
+
]
|
|
105
|
+
["span", {"data-type": "text"},
|
|
106
|
+
["span", {"data-type": "leaf", "strike": true, "color": "#9E9E9E"}, "删除线灰字"]
|
|
107
|
+
]
|
|
108
|
+
["span", {"data-type": "text"},
|
|
109
|
+
["span", {"data-type": "leaf", "fonts": {"ascii": "Arial", "eastAsia": "SimSun"}, "sz": 12, "szUnit": "pt"}, "指定字体"]
|
|
110
|
+
]
|
|
111
|
+
["span", {"data-type": "text"},
|
|
112
|
+
["span", {"data-type": "leaf"}, "H"],
|
|
113
|
+
["span", {"data-type": "leaf", "vertAlign": "subscript"}, "2"],
|
|
114
|
+
["span", {"data-type": "leaf"}, "O"]
|
|
115
|
+
]
|
|
116
|
+
```
|
|
117
|
+
|
|
118
|
+
### 历史/兼容形式
|
|
119
|
+
|
|
120
|
+
| 写法 | validator | 服务端 | 建议 |
|
|
121
|
+
|------|-----------|--------|------|
|
|
122
|
+
| `["span", {"data-type":"text"}, ["span", {"data-type":"leaf"}, "x"]]` | ✓ canonical | ✓ | ✅ 新内容首选 |
|
|
123
|
+
| `["text", {marks}, "x"]` | ✓(`text` 在 inline 白名单中) | ✓(兼容) | ⚠️ 历史 inline tag。`doc read` 不会输出这种形式;如需复制粘贴回写、保持与现有内容一致,建议改写为 canonical |
|
|
124
|
+
| `"raw string"` 作为 block 子节点 | ✗ 报错 `段落子节点不能是裸字符串` | — | 不要直接写。validator 会报错,请手动包成 canonical 形式 |
|
|
125
|
+
|
|
126
|
+
> Marks 表的属性集对 canonical 的 leaf 和 legacy 的 text 都适用;差别仅在承载位置(leaf 的 attrs vs text 的 attrs)。
|
|
127
|
+
|
|
128
|
+
---
|
|
129
|
+
|
|
130
|
+
## 块级节点
|
|
131
|
+
|
|
132
|
+
所有 block 节点的 tag 白名单(validator `validBlockTags`):
|
|
133
|
+
`p` / `h1` / `h2` / `h3` / `h4` / `h5` / `h6` / `hr` / `table` / `code` / `container` / `embed` / `onlineVideo` / `card` / `toc` / `refblock` / `cangjie-voidblock` / `cangjie-container`
|
|
134
|
+
|
|
135
|
+
未在白名单的 tag 会触发 `未知的块级 tag` 警告,并给出基于编辑距离 (Levenshtein ≤2) 的最接近建议(如 `"containr"` → `did you mean "container"?`)。
|
|
136
|
+
|
|
137
|
+
### paragraph(段落)
|
|
138
|
+
|
|
139
|
+
- **tag**: `"p"`
|
|
140
|
+
- **attrs**(全部 optional):
|
|
141
|
+
- `jc?: "left" | "center" | "right" | "both" | "distribute" | "justify"` — 对齐
|
|
142
|
+
- `ind?` — 缩进
|
|
143
|
+
- `left?: number`, `right?: number`, `firstLine?: number`, `firstLineChars?: number`, `hanging?: number`
|
|
144
|
+
- `spacing?` — 行间距(`lineRule=auto` 时 `line` 为倍数:1=单倍、1.5=1.5倍、2=双倍;`before`/`after` 单位 pt)
|
|
145
|
+
- `line?: number`, `before?: number`, `after?: number`
|
|
146
|
+
- `lineRule?: "atLeast" | "auto" | "exact"`
|
|
147
|
+
- `shd?: {val?, fill?, color?}` — 底纹
|
|
148
|
+
- `quote?: boolean` — 引用标识(注:服务端也接受 `blockquote: true` 的别名)
|
|
149
|
+
- `list?: object` — 列表标识(见下方 list 节点)
|
|
150
|
+
- `refs?: string[]` — 脚注引用 ID(footnote 标识)
|
|
151
|
+
- **children**: 一个 text 容器 + 可选的 inline 节点(link/img/tag/mention 等)
|
|
152
|
+
- **示例**:
|
|
153
|
+
|
|
154
|
+
```json
|
|
155
|
+
["p", {"uuid": "p1"}, ["span", {"data-type": "text"}, ["span", {"data-type": "leaf"}, "普通段落"]]]
|
|
156
|
+
["p", {"uuid": "p2", "jc": "center"}, ["span", {"data-type": "text"}, ["span", {"data-type": "leaf"}, "居中段落"]]]
|
|
157
|
+
["p", {"uuid": "p3", "ind": {"firstLine": 32}}, ["span", {"data-type": "text"}, ["span", {"data-type": "leaf"}, "首行缩进段落"]]]
|
|
158
|
+
["p", {"uuid": "p4", "spacing": {"line": 1.5, "lineRule": "auto"}}, ["span", {"data-type": "text"}, ["span", {"data-type": "leaf"}, "1.5倍行距"]]]
|
|
159
|
+
```
|
|
160
|
+
|
|
161
|
+
### heading(标题)
|
|
162
|
+
|
|
163
|
+
- **tag**: `"h1"` | `"h2"` | `"h3"` | `"h4"` | `"h5"` | `"h6"`
|
|
164
|
+
- **attrs**: 同 paragraph
|
|
165
|
+
- **children**: 同 paragraph
|
|
166
|
+
- **示例**:
|
|
167
|
+
|
|
168
|
+
```json
|
|
169
|
+
["h1", {"uuid": "h1a"}, ["span", {"data-type": "text"}, ["span", {"data-type": "leaf"}, "一级标题"]]]
|
|
170
|
+
["h3", {"uuid": "h3a", "jc": "center"}, ["span", {"data-type": "text"}, ["span", {"data-type": "leaf"}, "居中三级标题"]]]
|
|
171
|
+
```
|
|
172
|
+
|
|
173
|
+
### blockquote(引用)
|
|
174
|
+
|
|
175
|
+
- **tag**: `"p"` 或 `"h1"`~`"h6"`(不是独立 tag,是属性装饰)
|
|
176
|
+
- **标识**: `attrs.quote: true`(也接受 `blockquote: true`)
|
|
177
|
+
- **示例**:
|
|
178
|
+
|
|
179
|
+
```json
|
|
180
|
+
["p", {"uuid": "q1", "quote": true}, ["span", {"data-type": "text"}, ["span", {"data-type": "leaf"}, "这是一段引用"]]]
|
|
181
|
+
["h2", {"uuid": "q2", "quote": true}, ["span", {"data-type": "text"}, ["span", {"data-type": "leaf"}, "引用标题"]]]
|
|
182
|
+
```
|
|
183
|
+
|
|
184
|
+
### list(列表)
|
|
185
|
+
|
|
186
|
+
- **tag**: `"p"`(列表项在 JSONML 层面是扁平的段落,通过 `attrs.list` 标识)
|
|
187
|
+
- **attrs.list**:
|
|
188
|
+
- `listId: string` — **必传**。同一列表的项共享相同 ID。validator 报错:`必传字段缺失`
|
|
189
|
+
- `level: number` — **必传**。缩进层级(0-based,≥0)。validator 报错:`必传字段缺失` / `必须 ≥0`
|
|
190
|
+
- `isOrdered?: boolean` — 是否有序,默认 `false`
|
|
191
|
+
- `isTaskList?: boolean` — 是否任务列表,默认 `false`
|
|
192
|
+
- `isChecked?: boolean` — 任务是否完成(仅 isTaskList=true 时有意义)
|
|
193
|
+
- `isCanceled?: boolean` — 任务是否取消
|
|
194
|
+
- `start?: number` — 有序列表起始序号(≥1)。**仅在列表第一项设置**,后续项不设置此字段(系统自动递增)。validator 报错:`必须 ≥1`
|
|
195
|
+
- `listStyleType?: string` — 样式类型(31 种预设)
|
|
196
|
+
- `hideSymbol?: boolean` — 隐藏列表符号
|
|
197
|
+
- **示例**:
|
|
198
|
+
|
|
199
|
+
```json
|
|
200
|
+
["p", {"uuid": "li1", "list": {"listId": "abc", "level": 0, "isOrdered": false}},
|
|
201
|
+
["span", {"data-type": "text"}, ["span", {"data-type": "leaf"}, "无序列表项"]]]
|
|
202
|
+
["p", {"uuid": "li2", "list": {"listId": "def", "level": 0, "isOrdered": true, "start": 1}},
|
|
203
|
+
["span", {"data-type": "text"}, ["span", {"data-type": "leaf"}, "有序第一项"]]]
|
|
204
|
+
["p", {"uuid": "li2b", "list": {"listId": "def", "level": 0, "isOrdered": true}},
|
|
205
|
+
["span", {"data-type": "text"}, ["span", {"data-type": "leaf"}, "有序第二项(不设 start,自动编号 2)"]]]
|
|
206
|
+
["p", {"uuid": "li3", "list": {"listId": "ghi", "level": 1, "isOrdered": false}},
|
|
207
|
+
["span", {"data-type": "text"}, ["span", {"data-type": "leaf"}, "二级缩进"]]]
|
|
208
|
+
["p", {"uuid": "li4", "list": {"listId": "jkl", "level": 0, "isTaskList": true, "isChecked": false}},
|
|
209
|
+
["span", {"data-type": "text"}, ["span", {"data-type": "leaf"}, "待办事项"]]]
|
|
210
|
+
```
|
|
211
|
+
|
|
212
|
+
- **注意**: 列表是扁平结构,不是嵌套的 ol/ul/li
|
|
213
|
+
|
|
214
|
+
### hr(分割线)
|
|
215
|
+
|
|
216
|
+
- **tag**: `"hr"`
|
|
217
|
+
- **attrs**(全部 optional):
|
|
218
|
+
- `type?: TLineStyle` — 16 种枚举(`"single"` / `"dotted"` / `"dashed"` / `"double"` / `"wave"` 等),默认 `"single"`
|
|
219
|
+
- `sz?: number` — 粗细(px),默认 `1`
|
|
220
|
+
- `color?: string` — 颜色
|
|
221
|
+
- **children**: 构造时无需传子节点;服务端返回的真实文档中可能含内部配置数据子节点
|
|
222
|
+
- **示例**:
|
|
223
|
+
|
|
224
|
+
```json
|
|
225
|
+
["hr", {"uuid": "hr1"}]
|
|
226
|
+
["hr", {"uuid": "hr2", "type": "dashed", "color": "#ccc", "sz": 2}]
|
|
227
|
+
```
|
|
228
|
+
|
|
229
|
+
### table(表格)
|
|
230
|
+
|
|
231
|
+
- **tag**: `"table"`
|
|
232
|
+
- **attrs**:
|
|
233
|
+
- `colsWidth: number[]` — 列宽(语义必传)。缺失时 validator 警告 `table 应提供 colsWidth`
|
|
234
|
+
- 默认模式:值为各列绝对宽度,单位 **pt**(如 `[325, 325]` 总和≈页宽 650pt)
|
|
235
|
+
- 比例模式(配合 `tblW: {"type": "pct"}`):值为百分比权重(如 `[33.3, 33.3, 33.4]` 总和=100)
|
|
236
|
+
- `tblW?: {w?: number, type?: string}` — 表格宽度模式。`type: "pct"` 时 colsWidth 按比例解析
|
|
237
|
+
- `sr?: boolean` — `true` 表示这是分栏布局(columns),不是普通表格
|
|
238
|
+
- `jc?: string` — 对齐(源码注释"目前无消费")
|
|
239
|
+
- **children**: `["tr", ...]` 行节点
|
|
240
|
+
- **示例**:
|
|
241
|
+
|
|
242
|
+
```json
|
|
243
|
+
["table", {"uuid": "tb1", "colsWidth": [200, 200]},
|
|
244
|
+
["tr", {"uuid": "tr1"},
|
|
245
|
+
["tc", {"uuid": "tc1", "colSpan": 1, "rowSpan": 1},
|
|
246
|
+
["p", {"uuid": "tcp1"}, ["span", {"data-type": "text"}, ["span", {"data-type": "leaf"}, "单元格1"]]]],
|
|
247
|
+
["tc", {"uuid": "tc2", "colSpan": 1, "rowSpan": 1},
|
|
248
|
+
["p", {"uuid": "tcp2"}, ["span", {"data-type": "text"}, ["span", {"data-type": "leaf"}, "单元格2"]]]]
|
|
249
|
+
]
|
|
250
|
+
]
|
|
251
|
+
```
|
|
252
|
+
|
|
253
|
+
#### tr(表格行)
|
|
254
|
+
|
|
255
|
+
- **tag**: `"tr"`
|
|
256
|
+
- **attrs**: `{h?: number, isTblHeader?: boolean}`
|
|
257
|
+
|
|
258
|
+
#### tc(表格单元格)
|
|
259
|
+
|
|
260
|
+
- **tag**: `"tc"`
|
|
261
|
+
- **attrs**:
|
|
262
|
+
- `colSpan?: number` — 横跨列数,默认 `1`。validator 报错:`必须 ≥1`
|
|
263
|
+
- `rowSpan?: number` — 横跨行数,默认 `1`。validator 报错:`必须 ≥1`
|
|
264
|
+
- `fill?: string` — 填充色
|
|
265
|
+
- `vAlign?: "top" | "middle" | "bottom"` — 垂直对齐,默认 `"middle"`。validator 报错枚举不符(注意 `"center"` 不是合法值,应用 `"middle"`)
|
|
266
|
+
- `bdr?: object` — 单元格边框
|
|
267
|
+
- **children**: 任意块级节点数组;**至少包含一个 `p`**(即使空),否则单元格无法渲染光标
|
|
268
|
+
|
|
269
|
+
### code(代码块)
|
|
270
|
+
|
|
271
|
+
- **tag**: `"code"`
|
|
272
|
+
- **attrs**(全部 optional):
|
|
273
|
+
- `code?: string` — 代码内容,默认 `""`
|
|
274
|
+
- `syntax?: string` — 语言标识,默认 `"plaintext"`
|
|
275
|
+
- `theme?: string` — 主题枚举:`"default"` / `"light"` / `"dracula"` / `"github"` / `"cobalt"` / `"atomOneDark"` / `"oneLightPro"` / `"nightOwl"` / `"githubDark"` / `"realDracula"`。未知值 validator 警告 `未知主题`
|
|
276
|
+
- `wrap?: boolean` — 自动换行,默认 `true`
|
|
277
|
+
- `showLineNumber?: boolean` — 显示行号,默认 `true`
|
|
278
|
+
- `title?: string` — 标题(≤1000 字符)
|
|
279
|
+
- `fold?: boolean` — 是否折叠,默认 `false`
|
|
280
|
+
- **children**: 构造时无需传子节点(代码存在 `attrs.code` 中)
|
|
281
|
+
- **示例**:
|
|
282
|
+
|
|
283
|
+
```json
|
|
284
|
+
["code", {"uuid": "cd1", "syntax": "javascript", "code": "console.log('hello');"}]
|
|
285
|
+
["code", {"uuid": "cd2", "syntax": "python", "code": "print('hello')", "theme": "dracula"}]
|
|
286
|
+
```
|
|
287
|
+
|
|
288
|
+
### container(容器/高亮块)
|
|
289
|
+
|
|
290
|
+
- **tag**: `"container"`
|
|
291
|
+
- **attrs**:
|
|
292
|
+
- `subType: string` — **必传**。callout 为 `"colorBlocks"`。缺失时 validator 报错 `container 必须包含 subType`
|
|
293
|
+
- `metadata?: object` — 自定义元数据(callout 用 `{bgcolor, border}`)
|
|
294
|
+
- **children**: 任意块级节点
|
|
295
|
+
- **示例(callout)**:
|
|
296
|
+
|
|
297
|
+
```json
|
|
298
|
+
["container", {"uuid": "co1", "subType": "colorBlocks", "metadata": {"bgcolor": "#E8F2FE", "border": "#B3D4FC"}},
|
|
299
|
+
["p", {"uuid": "co1p1"}, ["span", {"data-type": "text"}, ["span", {"data-type": "leaf"}, "这是一段提示内容"]]]
|
|
300
|
+
]
|
|
301
|
+
```
|
|
302
|
+
|
|
303
|
+
### columns(分栏布局)
|
|
304
|
+
|
|
305
|
+
- **tag**: `"table"`(复用 table tag,通过 `sr: true` 区分)
|
|
306
|
+
- **attrs**:
|
|
307
|
+
- `sr: true` — 固定标识
|
|
308
|
+
- `colsWidth?: number[]` — 各列宽度(pt),前端按比例换算为页面宽度
|
|
309
|
+
- `spacing?: number` — 栏间距
|
|
310
|
+
- **children**: 单个 `["tr", ...]`,内含多个 `["tc", ...]`
|
|
311
|
+
- **示例**:
|
|
312
|
+
|
|
313
|
+
```json
|
|
314
|
+
["table", {"uuid": "col1", "sr": true, "colsWidth": [300, 300]},
|
|
315
|
+
["tr", {"uuid": "colr"},
|
|
316
|
+
["tc", {"uuid": "colc1"},
|
|
317
|
+
["p", {"uuid": "colp1"}, ["span", {"data-type": "text"}, ["span", {"data-type": "leaf"}, "左栏"]]]],
|
|
318
|
+
["tc", {"uuid": "colc2"},
|
|
319
|
+
["p", {"uuid": "colp2"}, ["span", {"data-type": "text"}, ["span", {"data-type": "leaf"}, "右栏"]]]]
|
|
320
|
+
]
|
|
321
|
+
]
|
|
322
|
+
```
|
|
323
|
+
|
|
324
|
+
### embed(嵌入文件)
|
|
325
|
+
|
|
326
|
+
- **tag**: `"embed"`(void 块)
|
|
327
|
+
- **attrs**:
|
|
328
|
+
- `src?: string` — 文件来源 URL(语义必传)
|
|
329
|
+
- `name?: string` — 文件名
|
|
330
|
+
- `type?: string` — 文件类型(`"pdf"` / `"xlsx"` / `"html"` / `"file"` 等)
|
|
331
|
+
- `size?: number` — 文件大小
|
|
332
|
+
- `viewType?: string` — 视图类型(如 `"preview"`)
|
|
333
|
+
- `previewSize?: {height: number}` — 预览高度(px)
|
|
334
|
+
- **children**: 无
|
|
335
|
+
- **示例**:
|
|
336
|
+
|
|
337
|
+
```json
|
|
338
|
+
["embed", {"uuid": "em1", "name": "report.pdf", "type": "pdf", "src": "https://example.com/report.pdf", "size": 2048, "viewType": "preview", "previewSize": {"height": 600}}]
|
|
339
|
+
```
|
|
340
|
+
|
|
341
|
+
### onlineVideo(在线视频)
|
|
342
|
+
|
|
343
|
+
- **tag**: `"onlineVideo"`(void 块)
|
|
344
|
+
- **attrs**(全部 optional,但 src 语义必传):
|
|
345
|
+
- `src?: string` — 视频地址
|
|
346
|
+
- `type?: string` — 平台标识(`"bilibili"` / `"youku"` / `"mp4"` 等)
|
|
347
|
+
- `poster?: string` — 封面图 URL
|
|
348
|
+
- **children**: 无
|
|
349
|
+
- **示例**:
|
|
350
|
+
|
|
351
|
+
```json
|
|
352
|
+
["onlineVideo", {"uuid": "ov1", "src": "https://example.com/video.mp4"}]
|
|
353
|
+
["onlineVideo", {"uuid": "ov2", "src": "https://player.bilibili.com/player.html?aid=1", "type": "bilibili", "poster": "https://example.com/poster.jpg"}]
|
|
354
|
+
```
|
|
355
|
+
|
|
356
|
+
### card(河图组件 / 富卡片)
|
|
357
|
+
|
|
358
|
+
- **tag**: `"card"`
|
|
359
|
+
- **attrs**:
|
|
360
|
+
- `cardType: string` — 卡片类型标识(如 `"groupChatCard"`、`"vote"`)
|
|
361
|
+
- `metadata: {id: string, ...}` — 组件元数据,必须包含 id
|
|
362
|
+
- `height?: number`
|
|
363
|
+
- **children**: 服务端 serialize 通常返回带一个空的 span/leaf 占位子节点,写入时建议保留以避免反序列化差异
|
|
364
|
+
- **示例**:
|
|
365
|
+
|
|
366
|
+
```json
|
|
367
|
+
["card", {"uuid": "cd1", "cardType": "vote", "metadata": {"id": "card_abc123"}},
|
|
368
|
+
["span", {"data-type": "text"}, ["span", {"data-type": "leaf"}, ""]]]
|
|
369
|
+
```
|
|
370
|
+
|
|
371
|
+
- **注意**: card 节点的重数据存储在独立 parts 层,body 中只存轻量引用
|
|
372
|
+
|
|
373
|
+
### toc(目录)
|
|
374
|
+
|
|
375
|
+
- **tag**: `"toc"`(void 块)
|
|
376
|
+
- **attrs**(全部 **required**,缺失逐个 validator 报错):
|
|
377
|
+
- `title: string` — 目录标题
|
|
378
|
+
- `mode: "outline" | "column"` — 展示模式(其他值 validator 报错 `无效值`)
|
|
379
|
+
- `styles: object` — 样式配置
|
|
380
|
+
- `styles.global: {maxLevel: number, bgColor: string, css: object}`
|
|
381
|
+
- `styles.title: {font: string, color: string, numbering: boolean, css: object}`
|
|
382
|
+
- `styles.item: {symbol: "disc" | "none", css: object}`
|
|
383
|
+
- `content: TocItem[]` — 目录条目数组;**写入时填 `[]` 即可**,服务端基于文档 heading 自动重建
|
|
384
|
+
- 每项: `{uuid, anchorId: string|null, level, children: TocItem[]}`
|
|
385
|
+
- **children**: 无
|
|
386
|
+
- **示例**:
|
|
387
|
+
|
|
388
|
+
```json
|
|
389
|
+
["toc", {"uuid": "toc1", "title": "目录", "mode": "outline",
|
|
390
|
+
"styles": {
|
|
391
|
+
"global": {"maxLevel": 5, "bgColor": "#F0EBF7", "css": {}},
|
|
392
|
+
"title": {"font": "", "color": "#000", "numbering": false, "css": {}},
|
|
393
|
+
"item": {"symbol": "disc", "css": {}}
|
|
394
|
+
},
|
|
395
|
+
"content": []
|
|
396
|
+
}]
|
|
397
|
+
```
|
|
398
|
+
|
|
399
|
+
### refblock(引用块)
|
|
400
|
+
|
|
401
|
+
- **tag**: `"refblock"`
|
|
402
|
+
- **attrs**:
|
|
403
|
+
- `docKey?: string` — 所属/被引文档标识(语义必传)
|
|
404
|
+
- `refblockUUID?: string` — 引用块唯一标识(语义必传)
|
|
405
|
+
- **children**: 块级节点(降级显示快照;真实内容由服务端按 docKey/refblockUUID 拉取覆写)
|
|
406
|
+
- **示例**:
|
|
407
|
+
|
|
408
|
+
```json
|
|
409
|
+
["refblock", {"uuid": "rb1", "docKey": "doc123", "refblockUUID": "block456"},
|
|
410
|
+
["p", {"uuid": "rb1p1"}, ["span", {"data-type": "text"}, ["span", {"data-type": "leaf"}, "(引用预览内容,服务端会回填)"]]]
|
|
411
|
+
]
|
|
412
|
+
```
|
|
413
|
+
|
|
414
|
+
- **注意**: 主块 (host):`docKey === refblockUUID`;副块 (copy):`docKey !== refblockUUID`
|
|
415
|
+
|
|
416
|
+
---
|
|
417
|
+
|
|
418
|
+
## Inline 节点
|
|
419
|
+
|
|
420
|
+
所有 inline 节点 tag 白名单(validator `validInlineTags`):
|
|
421
|
+
`text`(legacy) / `a` / `img` / `span` / `tag` / `inlineCode` / `br` / `cangjie-textinline` / `cangjie-voidinline`
|
|
422
|
+
|
|
423
|
+
block tag 也可出现在 inline 上下文(如 `img` 既是 block 又是 inline)。未在白名单的 tag 会触发警告并给出 Levenshtein 建议。
|
|
424
|
+
|
|
425
|
+
### a(链接)
|
|
426
|
+
|
|
427
|
+
- **tag**: `"a"`
|
|
428
|
+
- **attrs**(全部 optional,但 href 语义必传):
|
|
429
|
+
- `href?: string` — 链接地址(缺失时 validator 警告 `link 缺少 href`)
|
|
430
|
+
- `cardInfo?: object` — 链接卡片信息
|
|
431
|
+
- `cardInfo.displayType?: "link" | "card"` — 展示模式
|
|
432
|
+
- `cardInfo.title?: string`, `cardInfo.desc?: string`, `cardInfo.imgURL?: string`
|
|
433
|
+
- `metadata?: object` — 扩展业务信息
|
|
434
|
+
- **children**: 链接的展示文本(直接字符串,与 block 上下文不同)
|
|
435
|
+
- **示例**(作为 paragraph 的 inline 子节点):
|
|
436
|
+
|
|
437
|
+
```json
|
|
438
|
+
["p", {"uuid": "p1"},
|
|
439
|
+
["span", {"data-type": "text"}, ["span", {"data-type": "leaf"}, "请访问"]],
|
|
440
|
+
["a", {"href": "https://example.com"}, "链接文字"]
|
|
441
|
+
]
|
|
442
|
+
```
|
|
443
|
+
|
|
444
|
+
### img(图片)
|
|
445
|
+
|
|
446
|
+
- **tag**: `"img"`(既可作 block 也可作 inline 子节点)
|
|
447
|
+
- **attrs**(全部 optional,但 src 语义必传):
|
|
448
|
+
- `src?: string` — 图片地址
|
|
449
|
+
- `width?: number` — 宽度(px)
|
|
450
|
+
- `height?: number` — 高度(px)
|
|
451
|
+
- `rectClip?: {left?, right?, top?, bottom?}` — 裁剪比例(0-1)
|
|
452
|
+
- `rotation?: number` — 旋转角度
|
|
453
|
+
- `radius?: number` — 圆角(px)
|
|
454
|
+
- `shadow?: string` — CSS shadow
|
|
455
|
+
- `outline?: {width?, type?, color?}` — 边框
|
|
456
|
+
- **children**: 构造时无需传子节点;真实文档中可能含内部配置数据
|
|
457
|
+
- **示例**:
|
|
458
|
+
|
|
459
|
+
```json
|
|
460
|
+
["img", {"uuid": "img1", "src": "https://example.com/photo.png", "width": 400, "height": 300}]
|
|
461
|
+
```
|
|
462
|
+
|
|
463
|
+
- **注意**:
|
|
464
|
+
- 不存在 `layout` 属性,布局由 UI 层控制
|
|
465
|
+
- `img` 是 inline 元素,必须包裹在 `p` 段落中
|
|
466
|
+
|
|
467
|
+
### mention(@提及)
|
|
468
|
+
|
|
469
|
+
- **tag**: `"span"`
|
|
470
|
+
- **attrs**:
|
|
471
|
+
- `data-type: "mention"` — **必传**,固定标识
|
|
472
|
+
- `id?: string` — 被@用户 ID(语义必传)
|
|
473
|
+
- `name?: string` — 被@用户名(语义必传)
|
|
474
|
+
- `login?: string` — 登录名
|
|
475
|
+
- `metadata?: object` — 扩展元数据
|
|
476
|
+
- **children**: 显示文本
|
|
477
|
+
- **示例**:
|
|
478
|
+
|
|
479
|
+
```json
|
|
480
|
+
["span", {"data-type": "mention", "id": "user123", "name": "张三"}, "@张三"]
|
|
481
|
+
```
|
|
482
|
+
|
|
483
|
+
### tag(通用标签节点)
|
|
484
|
+
|
|
485
|
+
- **tag**: `"tag"`
|
|
486
|
+
- **attrs**:
|
|
487
|
+
- `tagType: string` — **必传**。子类型标识(如 `"formula"` / `"imTag"`)
|
|
488
|
+
- 其他属性依 tagType 而异
|
|
489
|
+
- **示例**:
|
|
490
|
+
|
|
491
|
+
```json
|
|
492
|
+
["tag", {"tagType": "imTag", "text": "#标签名"}]
|
|
493
|
+
```
|
|
494
|
+
|
|
495
|
+
### formula(公式)— `tag` 节点的特化
|
|
496
|
+
|
|
497
|
+
- **tag**: `"tag"`
|
|
498
|
+
- **attrs**:
|
|
499
|
+
- `tagType: "formula"` — **必传**,固定值
|
|
500
|
+
- `metadata: {formula: string}` — **必传**。LaTeX 代码(空串表示空公式)。缺失或类型错时 validator 报错
|
|
501
|
+
- **children**: 无
|
|
502
|
+
- **示例**:
|
|
503
|
+
|
|
504
|
+
```json
|
|
505
|
+
["tag", {"tagType": "formula", "metadata": {"formula": "E=mc^2"}}]
|
|
506
|
+
```
|
|
507
|
+
|
|
508
|
+
### sticker(表情贴纸)
|
|
509
|
+
|
|
510
|
+
- **tag**: `"span"`
|
|
511
|
+
- **attrs**:
|
|
512
|
+
- `data-type: "emoji"` — **必传**(注意:`"emoji"` 不是 `"sticker"`)
|
|
513
|
+
- `code?: string` — 表情纯文本标识(如 `"[微笑]"`)
|
|
514
|
+
- `newCode?: IEmoji` — 完整表情对象,5 种子类型:
|
|
515
|
+
- `{type: "dingding", id, name, url}`
|
|
516
|
+
- `{type: "unicode", value}`
|
|
517
|
+
- `{type: "custom", url}`
|
|
518
|
+
- `{type: "icon", id, color?}`
|
|
519
|
+
- `{type: "svg", id, url, color?}`
|
|
520
|
+
- **children**: 无或空文本
|
|
521
|
+
- **示例**:
|
|
522
|
+
|
|
523
|
+
```json
|
|
524
|
+
["span", {"data-type": "emoji", "code": "[微笑]", "newCode": {"type": "unicode", "value": "😊"}}]
|
|
525
|
+
```
|
|
526
|
+
|
|
527
|
+
### inlineCode(行内代码)
|
|
528
|
+
|
|
529
|
+
- **tag**: `"inlineCode"`
|
|
530
|
+
- **attrs**: `{bgColor?: string}` 或 `{}`
|
|
531
|
+
- **children**: 文本(inline 子节点)
|
|
532
|
+
- **示例**:
|
|
533
|
+
|
|
534
|
+
```json
|
|
535
|
+
["inlineCode", {}, "const x = 1"]
|
|
536
|
+
```
|
|
537
|
+
|
|
538
|
+
### br(换行符)
|
|
539
|
+
|
|
540
|
+
- **tag**: `"br"`(void inline)
|
|
541
|
+
- **attrs**: `{}`
|
|
542
|
+
- **children**: 空文本占位
|
|
543
|
+
- **示例**:
|
|
544
|
+
|
|
545
|
+
```json
|
|
546
|
+
["br", {}, ""]
|
|
547
|
+
```
|
|
548
|
+
|
|
549
|
+
### refer(行内引用)
|
|
550
|
+
|
|
551
|
+
- **tag**: `"span"`
|
|
552
|
+
- **attrs**:
|
|
553
|
+
- `data-type: "refer"` — 固定标识
|
|
554
|
+
- 其他业务属性(自由 key-value)
|
|
555
|
+
- **示例**:
|
|
556
|
+
|
|
557
|
+
```json
|
|
558
|
+
["span", {"data-type": "refer", "docId": "xxx", "blockId": "yyy"}, "引用内容"]
|
|
559
|
+
```
|
|
560
|
+
|
|
561
|
+
---
|
|
562
|
+
|
|
563
|
+
## Cangjie 系列(扩展块)
|
|
564
|
+
|
|
565
|
+
### attachment(附件)
|
|
566
|
+
|
|
567
|
+
- **tag**: `"cangjie-voidblock"` 或 `"cangjie-voidinline"`
|
|
568
|
+
- **attrs**:
|
|
569
|
+
- `subType: "attachment"` — 固定标识
|
|
570
|
+
- `data.viewType: "preview" | "abstractCard"` — 视图类型
|
|
571
|
+
- `data.fileData: {name?, src?, size?, fileType?, category: "media" | "file"}` — 文件数据
|
|
572
|
+
- `data.previewSize?: {width?, height?}` — 预览尺寸
|
|
573
|
+
- **children**: 无
|
|
574
|
+
- **示例**:
|
|
575
|
+
|
|
576
|
+
```json
|
|
577
|
+
["cangjie-voidblock", {"subType": "attachment", "data": {"viewType": "abstractCard", "fileData": {"name": "report.pdf", "src": "https://...", "size": 2048, "category": "file"}}}]
|
|
578
|
+
```
|
|
579
|
+
|
|
580
|
+
- **注意**: 反序列化时匹配 `"embed"` tag 并转换为 attachment
|
|
581
|
+
|
|
582
|
+
### footnote(脚注)
|
|
583
|
+
|
|
584
|
+
- **tag**: 宿主节点 tag(`"p"` / `"h1"`~`"h6"`),不是独立节点
|
|
585
|
+
- **标识**: `attrs.refs: string[]`(脚注引用 ID 数组)
|
|
586
|
+
- **示例**:
|
|
587
|
+
|
|
588
|
+
```json
|
|
589
|
+
["p", {"uuid": "fn1", "refs": ["footnote-id-1"]},
|
|
590
|
+
["span", {"data-type": "text"}, ["span", {"data-type": "leaf"}, "正文文本"]]]
|
|
591
|
+
```
|
|
592
|
+
|
|
593
|
+
- **注意**: footnote 将 `refs` 属性注入到宿主 block 节点中,类似 blockquote 的属性装饰模式
|
|
594
|
+
|
|
595
|
+
### calendar(日程)
|
|
596
|
+
|
|
597
|
+
- **tag**: `"cangjie-voidinline"` 或 `"cangjie-voidblock"`
|
|
598
|
+
- **attrs**:
|
|
599
|
+
- `subType: "calendar"` — 固定标识
|
|
600
|
+
- `data.viewType: "inlineCalendar" | "blockCalendar"` — 形态
|
|
601
|
+
- `data.calendarId: string` — 日程 ID
|
|
602
|
+
- `data.subject: string` — 日程名称
|
|
603
|
+
- `data.detailUrl: string` — 日程详情链接
|
|
604
|
+
- **示例**:
|
|
605
|
+
|
|
606
|
+
```json
|
|
607
|
+
["cangjie-voidinline", {"subType": "calendar", "data": {"viewType": "inlineCalendar", "calendarId": "cal-001", "subject": "周会", "detailUrl": "https://..."}}]
|
|
608
|
+
```
|
|
609
|
+
|
|
610
|
+
### label(标签)
|
|
611
|
+
|
|
612
|
+
- **tag**: `"cangjie-textinline"`
|
|
613
|
+
- **attrs**:
|
|
614
|
+
- `subType: "label"` — 固定标识
|
|
615
|
+
- `data.bgColor?: string` — 标签背景色
|
|
616
|
+
- `data.color?: string` — 标签文字颜色
|
|
617
|
+
- `data.labelType?: "normal" | "note" | "spoiler"` — 标签模式
|
|
618
|
+
- **children**: 文本内容
|
|
619
|
+
- **示例**:
|
|
620
|
+
|
|
621
|
+
```json
|
|
622
|
+
["cangjie-textinline", {"subType": "label", "data": {"bgColor": "#FFE8CC", "color": "#D46B08", "labelType": "normal"}}, "重要"]
|
|
623
|
+
```
|
|
624
|
+
|
|
625
|
+
### templateButton(模板按钮)
|
|
626
|
+
|
|
627
|
+
- **tag**: `"cangjie-container"`
|
|
628
|
+
- **attrs**:
|
|
629
|
+
- `subType: "templateButton"` — 固定标识
|
|
630
|
+
- `metadata.direction: "top" | "bottom"` — 按钮方向
|
|
631
|
+
- `metadata.isOnce: boolean` — 是否一次性
|
|
632
|
+
- `metadata.title: string` — 按钮标题
|
|
633
|
+
- **children**: 块级节点数组
|
|
634
|
+
- **示例**:
|
|
635
|
+
|
|
636
|
+
```json
|
|
637
|
+
["cangjie-container", {"subType": "templateButton", "metadata": {"direction": "bottom", "isOnce": false, "title": "添加待办"}},
|
|
638
|
+
["p", {"uuid": "tb1p1", "list": {"level": 0, "isChecked": false, "isOrdered": false, "isTaskList": true, "listId": "abc"}},
|
|
639
|
+
["span", {"data-type": "text"}, ["span", {"data-type": "leaf"}, ""]]]
|
|
640
|
+
]
|
|
641
|
+
```
|
|
642
|
+
|
|
643
|
+
### textSlot(文本插槽)
|
|
644
|
+
|
|
645
|
+
- **tag**: `"cangjie-textinline"`
|
|
646
|
+
- **attrs**:
|
|
647
|
+
- `subType: "textSlot"` — 固定标识
|
|
648
|
+
- `data.slotInfo.style.color: string` — 文字颜色(支持渐变色)
|
|
649
|
+
- **children**: 文本内容
|
|
650
|
+
- **示例**:
|
|
651
|
+
|
|
652
|
+
```json
|
|
653
|
+
["cangjie-textinline", {"subType": "textSlot", "data": {"slotInfo": {"style": {"color": "#1890ff"}}}}, "插槽文本"]
|
|
654
|
+
```
|
|
655
|
+
|
|
656
|
+
---
|
|
657
|
+
|
|
658
|
+
## 完整文档示例
|
|
659
|
+
|
|
660
|
+
```json
|
|
661
|
+
["root", {"sectPr": {"pgSz": {"w": 11906, "h": 16838}}},
|
|
662
|
+
["h1", {"uuid": "h1"},
|
|
663
|
+
["span", {"data-type": "text"}, ["span", {"data-type": "leaf"}, "文档标题"]]],
|
|
664
|
+
|
|
665
|
+
["p", {"uuid": "p1"},
|
|
666
|
+
["span", {"data-type": "text"},
|
|
667
|
+
["span", {"data-type": "leaf"}, "这是一段普通文本,包含"],
|
|
668
|
+
["span", {"data-type": "leaf", "bold": true}, "加粗"],
|
|
669
|
+
["span", {"data-type": "leaf"}, "和"]],
|
|
670
|
+
["a", {"href": "https://example.com"}, "链接"],
|
|
671
|
+
["span", {"data-type": "text"}, ["span", {"data-type": "leaf"}, "。"]]],
|
|
672
|
+
|
|
673
|
+
["h2", {"uuid": "h2"},
|
|
674
|
+
["span", {"data-type": "text"}, ["span", {"data-type": "leaf"}, "列表示例"]]],
|
|
675
|
+
["p", {"uuid": "li1", "list": {"listId": "l1", "level": 0, "isOrdered": true, "start": 1}},
|
|
676
|
+
["span", {"data-type": "text"}, ["span", {"data-type": "leaf"}, "第一项"]]],
|
|
677
|
+
["p", {"uuid": "li2", "list": {"listId": "l1", "level": 0, "isOrdered": true}},
|
|
678
|
+
["span", {"data-type": "text"}, ["span", {"data-type": "leaf"}, "第二项"]]],
|
|
679
|
+
["p", {"uuid": "li3", "list": {"listId": "l1", "level": 1, "isOrdered": false}},
|
|
680
|
+
["span", {"data-type": "text"}, ["span", {"data-type": "leaf"}, "子项"]]],
|
|
681
|
+
|
|
682
|
+
["hr", {"uuid": "hr1"}],
|
|
683
|
+
|
|
684
|
+
["code", {"uuid": "cd1", "syntax": "javascript", "code": "function hello() {\n return 'world';\n}"}],
|
|
685
|
+
|
|
686
|
+
["container", {"uuid": "co1", "subType": "colorBlocks", "metadata": {"bgcolor": "#E8F2FE"}},
|
|
687
|
+
["p", {"uuid": "co1p1"},
|
|
688
|
+
["span", {"data-type": "text"}, ["span", {"data-type": "leaf"}, "这是一个提示块"]]]],
|
|
689
|
+
|
|
690
|
+
["table", {"uuid": "tb1", "colsWidth": [200, 200]},
|
|
691
|
+
["tr", {"uuid": "tr1"},
|
|
692
|
+
["tc", {"uuid": "tc1", "colSpan": 1, "rowSpan": 1},
|
|
693
|
+
["p", {"uuid": "tcp1"}, ["span", {"data-type": "text"}, ["span", {"data-type": "leaf"}, "A"]]]],
|
|
694
|
+
["tc", {"uuid": "tc2", "colSpan": 1, "rowSpan": 1},
|
|
695
|
+
["p", {"uuid": "tcp2"}, ["span", {"data-type": "text"}, ["span", {"data-type": "leaf"}, "B"]]]]
|
|
696
|
+
]
|
|
697
|
+
]
|
|
698
|
+
]
|
|
699
|
+
```
|
|
700
|
+
|
|
701
|
+
## 设计要点
|
|
702
|
+
|
|
703
|
+
1. **Canonical 文本是 span/leaf**:每段文字 = `["span", {"data-type":"text"}, ["span", {"data-type":"leaf", ...marks}, "..."]]`。legacy `["text", {marks}, "..."]` 仍被接受但不建议新写。
|
|
704
|
+
2. **裸字符串作 block 子节点违法**:validator 报错,请手动包成 canonical 形式。
|
|
705
|
+
3. **每个 block 必带 `uuid`**:手写 JSONML 时建议每个 block 自带 `uuid`(base32 alphanumeric,dws CLI 用 `dws` 前缀)。
|
|
706
|
+
4. **扁平列表**: 列表不嵌套,通过 `listId` + `level` 表达层级。
|
|
707
|
+
5. **属性装饰**: blockquote / list / footnote 不是独立 tag,是 paragraph 的属性。
|
|
708
|
+
6. **Void 节点**: hr / code / img / card / toc / embed / onlineVideo 在构造时不需要传子节点;服务端返回的真实文档中这些节点**可能包含内部配置数据子节点**,解析时应兼容。
|
|
709
|
+
7. **columns = table + sr:true**: 分栏复用表格结构。
|
|
710
|
+
8. **card 轻引用**: body 中只存 cardType + metadata.id,重数据在 parts 层。
|
|
711
|
+
9. **root 节点**: 服务端返回的完整 body 以 `["root", {sectPr...}, ...blocks]` 包裹。`doc create/update` 写入时必须以 root 为根节点,缺少会报错。`doc block insert/update` 不要求 root。
|