@web-ppt/edit-core 0.5.0-beta.1 → 0.5.0-beta.7

package/schemas/describe.schema.json

@@ -0,0 +1,479 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$ref": "#/definitions/PresentationDescription",
+  "definitions": {
+    "PresentationDescription": {
+      "type": "object",
+      "properties": {
+        "version": {
+          "type": "number",
+          "const": 1
+        },
+        "source": {
+          "type": "string",
+          "enum": [
+            "pptx",
+            "ppt"
+          ]
+        },
+        "width": {
+          "type": "number"
+        },
+        "height": {
+          "type": "number"
+        },
+        "totalSlides": {
+          "type": "number"
+        },
+        "totalElements": {
+          "type": "number",
+          "description": "按页面计数，同一个设计对象在不同页面出现时分别计入。"
+        },
+        "slides": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/DescriptionSlide"
+          }
+        },
+        "truncation": {
+          "type": "object",
+          "properties": {
+            "reason": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "enum": [
+                "max-chars",
+                "max-tokens",
+                null
+              ]
+            },
+            "omittedSlides": {
+              "type": "number"
+            },
+            "omittedElements": {
+              "type": "number"
+            },
+            "next": {
+              "anyOf": [
+                {
+                  "type": "object",
+                  "properties": {
+                    "slideNumber": {
+                      "type": "number"
+                    },
+                    "elementId": {
+                      "type": [
+                        "string",
+                        "null"
+                      ]
+                    }
+                  },
+                  "required": [
+                    "slideNumber",
+                    "elementId"
+                  ],
+                  "additionalProperties": false
+                },
+                {
+                  "type": "null"
+                }
+              ],
+              "description": "elementId 为 null 时，截断发生在整页元数据之前。"
+            }
+          },
+          "required": [
+            "reason",
+            "omittedSlides",
+            "omittedElements",
+            "next"
+          ],
+          "additionalProperties": false
+        }
+      },
+      "required": [
+        "version",
+        "source",
+        "width",
+        "height",
+        "totalSlides",
+        "totalElements",
+        "slides",
+        "truncation"
+      ],
+      "additionalProperties": false
+    },
+    "DescriptionSlide": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string"
+        },
+        "number": {
+          "type": "number",
+          "description": "面向使用者的页码，从 1 开始，包含隐藏页。"
+        },
+        "hidden": {
+          "type": "boolean"
+        },
+        "layout": {
+          "anyOf": [
+            {
+              "$ref": "#/definitions/DescriptionReference"
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
+        "master": {
+          "anyOf": [
+            {
+              "$ref": "#/definitions/DescriptionReference"
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
+        "section": {
+          "anyOf": [
+            {
+              "$ref": "#/definitions/DescriptionReference"
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
+        "notes": {
+          "type": "string"
+        },
+        "elements": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/DescriptionElement"
+          }
+        }
+      },
+      "required": [
+        "id",
+        "number",
+        "hidden",
+        "layout",
+        "master",
+        "section",
+        "notes",
+        "elements"
+      ],
+      "additionalProperties": false
+    },
+    "DescriptionReference": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string"
+        },
+        "name": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "id",
+        "name"
+      ],
+      "additionalProperties": false
+    },
+    "DescriptionElement": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string"
+        },
+        "kind": {
+          "type": "string",
+          "enum": [
+            "shape",
+            "image",
+            "group",
+            "table",
+            "unsupported"
+          ]
+        },
+        "name": {
+          "type": "string"
+        },
+        "altText": {
+          "type": "object",
+          "properties": {
+            "title": {
+              "type": "string"
+            },
+            "description": {
+              "type": "string"
+            }
+          },
+          "required": [
+            "title",
+            "description"
+          ],
+          "additionalProperties": false
+        },
+        "path": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "根到自身的稳定 ID；先序截断后仍能解析每个已返回元素的祖先。"
+        },
+        "canvas": {
+          "type": "object",
+          "properties": {
+            "kind": {
+              "type": "string",
+              "enum": [
+                "slide",
+                "layout",
+                "master"
+              ]
+            },
+            "id": {
+              "type": "string"
+            }
+          },
+          "required": [
+            "kind",
+            "id"
+          ],
+          "additionalProperties": false
+        },
+        "bounds": {
+          "type": "object",
+          "properties": {
+            "x": {
+              "type": "number"
+            },
+            "y": {
+              "type": "number"
+            },
+            "width": {
+              "type": "number"
+            },
+            "height": {
+              "type": "number"
+            }
+          },
+          "required": [
+            "x",
+            "y",
+            "width",
+            "height"
+          ],
+          "additionalProperties": false
+        },
+        "editable": {
+          "type": "string",
+          "enum": [
+            "full",
+            "frame",
+            "none"
+          ]
+        },
+        "hidden": {
+          "type": "boolean"
+        },
+        "locked": {
+          "type": "boolean"
+        },
+        "placeholder": {
+          "anyOf": [
+            {
+              "$ref": "#/definitions/DescriptionPlaceholder"
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
+        "paragraphs": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/DescriptionParagraph"
+          }
+        }
+      },
+      "required": [
+        "id",
+        "kind",
+        "name",
+        "altText",
+        "path",
+        "canvas",
+        "bounds",
+        "editable",
+        "hidden",
+        "locked",
+        "placeholder",
+        "paragraphs"
+      ],
+      "additionalProperties": false
+    },
+    "DescriptionPlaceholder": {
+      "type": "object",
+      "properties": {
+        "type": {
+          "type": "string"
+        },
+        "index": {
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "layout": {
+          "anyOf": [
+            {
+              "type": "object",
+              "properties": {
+                "id": {
+                  "type": "string"
+                },
+                "elementId": {
+                  "type": "string"
+                }
+              },
+              "required": [
+                "id",
+                "elementId"
+              ],
+              "additionalProperties": false
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
+        "master": {
+          "anyOf": [
+            {
+              "type": "object",
+              "properties": {
+                "id": {
+                  "type": "string"
+                },
+                "elementId": {
+                  "type": "string"
+                }
+              },
+              "required": [
+                "id",
+                "elementId"
+              ],
+              "additionalProperties": false
+            },
+            {
+              "type": "null"
+            }
+          ]
+        }
+      },
+      "required": [
+        "type",
+        "index",
+        "layout",
+        "master"
+      ],
+      "additionalProperties": false
+    },
+    "DescriptionParagraph": {
+      "type": "object",
+      "properties": {
+        "text": {
+          "type": "string"
+        },
+        "level": {
+          "type": "number"
+        },
+        "bullet": {
+          "type": "object",
+          "properties": {
+            "kind": {
+              "type": "string",
+              "enum": [
+                "none",
+                "text",
+                "image"
+              ]
+            },
+            "text": {
+              "type": [
+                "string",
+                "null"
+              ]
+            },
+            "numbering": {
+              "anyOf": [
+                {
+                  "type": "object",
+                  "properties": {
+                    "type": {
+                      "type": "string"
+                    },
+                    "startAt": {
+                      "type": "number"
+                    }
+                  },
+                  "required": [
+                    "type",
+                    "startAt"
+                  ],
+                  "additionalProperties": false
+                },
+                {
+                  "type": "null"
+                }
+              ]
+            }
+          },
+          "required": [
+            "kind",
+            "text",
+            "numbering"
+          ],
+          "additionalProperties": false
+        },
+        "cell": {
+          "anyOf": [
+            {
+              "type": "object",
+              "properties": {
+                "row": {
+                  "type": "number"
+                },
+                "column": {
+                  "type": "number"
+                }
+              },
+              "required": [
+                "row",
+                "column"
+              ],
+              "additionalProperties": false
+            },
+            {
+              "type": "null"
+            }
+          ]
+        }
+      },
+      "required": [
+        "text",
+        "level",
+        "bullet",
+        "cell"
+      ],
+      "additionalProperties": false
+    }
+  }
+}

package/schemas/lint.schema.json

@@ -0,0 +1,145 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$ref": "#/definitions/LayoutLintReport",
+  "definitions": {
+    "LayoutLintReport": {
+      "type": "object",
+      "properties": {
+        "version": {
+          "type": "number",
+          "const": 1
+        },
+        "checks": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/LayoutCheck"
+          }
+        },
+        "totalSlides": {
+          "type": "number"
+        },
+        "totalElements": {
+          "type": "number"
+        },
+        "issues": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/LayoutIssue"
+          }
+        }
+      },
+      "required": [
+        "version",
+        "checks",
+        "totalSlides",
+        "totalElements",
+        "issues"
+      ],
+      "additionalProperties": false
+    },
+    "LayoutCheck": {
+      "type": "string",
+      "enum": [
+        "text-overflow",
+        "element-overlap",
+        "off-canvas",
+        "low-contrast",
+        "missing-font",
+        "placeholder-prompt-left",
+        "image-distorted"
+      ]
+    },
+    "LayoutIssue": {
+      "type": "object",
+      "properties": {
+        "reason": {
+          "$ref": "#/definitions/LayoutCheck"
+        },
+        "slideNumber": {
+          "type": "number"
+        },
+        "elementId": {
+          "type": "string"
+        },
+        "bounds": {
+          "type": "object",
+          "properties": {
+            "x": {
+              "type": "number"
+            },
+            "y": {
+              "type": "number"
+            },
+            "width": {
+              "type": "number"
+            },
+            "height": {
+              "type": "number"
+            }
+          },
+          "required": [
+            "x",
+            "y",
+            "width",
+            "height"
+          ],
+          "additionalProperties": false
+        },
+        "cell": {
+          "anyOf": [
+            {
+              "type": "object",
+              "properties": {
+                "row": {
+                  "type": "number"
+                },
+                "column": {
+                  "type": "number"
+                }
+              },
+              "required": [
+                "row",
+                "column"
+              ],
+              "additionalProperties": false
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
+        "measurements": {
+          "type": "object",
+          "additionalProperties": {
+            "anyOf": [
+              {
+                "type": "number"
+              },
+              {
+                "type": "string"
+              },
+              {
+                "type": "boolean"
+              },
+              {
+                "type": "array",
+                "items": {
+                  "type": "string"
+                }
+              }
+            ]
+          }
+        }
+      },
+      "required": [
+        "reason",
+        "slideNumber",
+        "elementId",
+        "bounds",
+        "cell",
+        "measurements"
+      ],
+      "additionalProperties": false
+    }
+  }
+}