@pptx-studio/validate 0.1.0

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 ADDED
@@ -0,0 +1,23 @@
1
+ # @pptx-studio/validate
2
+
3
+ ## 0.1.0
4
+
5
+ ### Minor Changes
6
+
7
+ - 7d905f4: First release.
8
+
9
+ `@pptx-studio/render-svg` turns a slide into an SVG string, and `pptx-studio render`
10
+ does it from the command line with no browser and no LibreOffice — text included,
11
+ measured out of the font's own tables. The other nine packages are what those two
12
+ are built on and are published because they have to be, not because their surface
13
+ is settled.
14
+
15
+ Everything here is pre-1.0 and the API will change. What will not change without a
16
+ very good reason is what the writer does to a package it was not asked to edit: a
17
+ part nobody touched is re-emitted byte for byte, across all 54 decks in the corpus.
18
+
19
+ ### Patch Changes
20
+
21
+ - Updated dependencies [7d905f4]
22
+ - @pptx-studio/opc@0.1.0
23
+ - @pptx-studio/xml@0.1.0
package/LICENSE ADDED
@@ -0,0 +1,202 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright 2026 Dewiride Technologies
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
package/NOTICE ADDED
@@ -0,0 +1,43 @@
1
+ PPTX Studio
2
+ Copyright 2026 Dewiride Technologies
3
+
4
+ This product includes software developed at Dewiride Technologies
5
+ (https://github.com/Dewiride-Open-Source/Dewiride-PPTX-Studio).
6
+
7
+ --------------------------------------------------------------------------------
8
+ Third-party material redistributed in this repository
9
+ --------------------------------------------------------------------------------
10
+
11
+ Entries are added here at the moment the material lands, not at release time.
12
+
13
+ * Apache POI
14
+ Copyright The Apache Software Foundation
15
+ Licensed under the Apache License, Version 2.0.
16
+ https://poi.apache.org/
17
+
18
+ @pptx-studio/geometry contains the 187 DrawingML preset shape definitions,
19
+ transcoded at build time from POI's presetShapeDefinitions.xml by
20
+ tools/geometry-codegen. The transcoded form is a re-encoding of that file's
21
+ content and carries POI's copyright.
22
+
23
+ The file itself is not redistributed in this repository. The generated
24
+ modules in packages/geometry/src/presets record the SHA-256 of the exact
25
+ input they were produced from:
26
+
27
+ presetShapeDefinitions.xml, 538970 bytes
28
+ sha256 4a762444d8d85876881c02a5b1dedf6f73006fcd8acb7b4e393435615b37c780
29
+
30
+ --------------------------------------------------------------------------------
31
+ Attributions the plan commits us to, listed so the obligation is visible before
32
+ the code arrives
33
+ --------------------------------------------------------------------------------
34
+
35
+ * Pattern fill tiles (sub-phase 2.7) are generated from Mono libgdiplus.
36
+ libgdiplus - Copyright Novell, Inc. and contributors - MIT
37
+
38
+ * Metric-compatible substitute fonts ship in a separate package,
39
+ @pptx-studio/fonts-metric-compat, under SIL OFL 1.1 with its own
40
+ OFL.txt and reserved-font-name handling. They are deliberately kept out
41
+ of this Apache-2.0 tree so the licence boundary is a package boundary.
42
+
43
+ See LEGAL.md for the clean-room record and the reimplementation basis.
package/README.md ADDED
@@ -0,0 +1,131 @@
1
+ # @pptx-studio/validate
2
+
3
+ **The repair firewall.** Twenty-nine rules a `.pptx` must not break, checked
4
+ before any bytes are handed over, each finding carrying the part and the XPath.
5
+
6
+ Apache-2.0 · browser and Web Worker only, no Node · part of
7
+ [PPTX Studio](https://github.com/Dewiride-Open-Source/Dewiride-PPTX-Studio).
8
+
9
+ ```ts
10
+ import { assertValid, formatReport, validatePackage } from '@pptx-studio/validate';
11
+
12
+ // Diagnosing a file somebody sent you.
13
+ const report = validatePackage({ bytes });
14
+ console.log(formatReport(report, { explain: true }));
15
+
16
+ // The export gate: throws unless the package is safe to hand over.
17
+ assertValid({ store, baseline, bytes: store.write() });
18
+ ```
19
+
20
+ ## Why this exists
21
+
22
+ PowerPoint emits no diagnostic log. When it refuses a file the message names no
23
+ part, no element and no line — "PowerPoint could not open the file", or
24
+ `0x80070570`, "the file or directory is corrupted and unreadable". When it
25
+ _repairs_ one it says even less, and the user is left holding a deck that has
26
+ quietly lost something.
27
+
28
+ So this is not a schema validator with a nice report. It is the only feedback
29
+ loop that exists, and it runs on every export in development and in production.
30
+
31
+ ## Twenty-nine rules, in two halves
32
+
33
+ Roughly half come from ECMA-376: content-type coverage, `xsd:sequence` child
34
+ order, `minOccurs`, the four identifier ranges. Those are derivable, and one of
35
+ them literally is — the ordering table is generated from the Transitional
36
+ schemas and checked against 194 148 elements PowerPoint wrote.
37
+
38
+ The other half cannot be derived from anything. Each is the record of a package
39
+ built with **one** change in it, opened in PowerPoint 16.0.20326, and declined:
40
+
41
+ | | |
42
+ | ------ | ---------------------------------------------------------------------------------------------- |
43
+ | `V022` | a `p:ph type="hdr"` on a slide. The other seven content types all open. |
44
+ | `V023` | a geometry guide referenced but never defined. `ST_GeomGuideName` is an unconstrained token. |
45
+ | `V024` | a `c:strLit` inside a series `c:tx`, two elements away from where the literal forms are legal. |
46
+ | `V025` | a `p:control`, in all eight forms tried. An empty `p:controls` is accepted. |
47
+ | `V026` | a `cs:chartStyle` with thirty of its thirty-one entries. No chart style at all is fine. |
48
+ | `V019` | a master id colliding with a layout id. They are one number space and no schema says so. |
49
+ | `V020` | a `p:cNvPr/@id` between 2147483648 and 4294967294. 4294967295 opens; it is minus one. |
50
+ | `V009` | a slide without exactly one layout relationship; a `cx:chartSpace` with no `.rels`. |
51
+ | `V004` | a percent-escape of an _unreserved_ character in a part name. `0x808D1005`. |
52
+ | `V012` | an `a:ahXY` directly under `a:custGeom`, without its `a:ahLst` wrapper. |
53
+
54
+ Every rule carries a `why` recording what was tried and what opened, so whoever
55
+ eventually contradicts one knows what they are contradicting.
56
+
57
+ ## It answers "did _we_ break it", not "is this valid"
58
+
59
+ A fatal finding in a file the user imported ten seconds ago is information. The
60
+ same finding in a file they just edited is a bug in us, and handing over the
61
+ bytes would give them a repair prompt with no explanation.
62
+
63
+ Refusing both would be the strict-looking choice and it is the wrong one: a deck
64
+ with one pre-existing defect — a dangling image relationship, common in files
65
+ that have been through three other tools — could then be opened here and never
66
+ saved again. The editor would be refusing to give somebody back their own file
67
+ over a problem it did not cause.
68
+
69
+ So every finding carries an `origin`, and only `introduced` ones refuse an
70
+ export. It is computed rather than judged per rule: the rules run a second time
71
+ against the package **as it was opened** and the two reports are differenced.
72
+ That second pass happens only when the first found something fatal, so a clean
73
+ export pays nothing for it.
74
+
75
+ ## Nothing is silently skipped
76
+
77
+ Three rules compare against the package as it was opened, and one reads the
78
+ archive rather than the part store. Given neither, they do not run — and the
79
+ report lists them under `skipped` with the reason, because a preservation rule
80
+ that reports nothing because it had nothing to compare against looks exactly
81
+ like one that found nothing. Parts that would not parse land in `problems` for
82
+ the same reason.
83
+
84
+ ## How it is verified
85
+
86
+ Two suites that check opposite things, and neither substitutes for the other.
87
+
88
+ **It fires.** `validate.test.ts` breaks a minimal deck twenty-nine ways, one per
89
+ rule, and asserts each rule reports the right part and the right XPath.
90
+
91
+ **It is quiet.** `tools/corpus/suites/validate.test.ts` runs all fifty-two committed
92
+ corpus decks through it and asserts no fatal finding. Every deck in that corpus
93
+ opens in PowerPoint, so a rule that fires on one is a bug and there is no third
94
+ possibility. Three rules were narrowed by exactly that run: `V012` was reporting
95
+ `mc:AlternateContent` and other extension markup the ordering table simply has
96
+ never read; `V020` was reporting shape ids reused across the two branches of one
97
+ `mc:AlternateContent`, which are alternatives and may collide; and it found a
98
+ real defect in our own `a20-tables`, which wrote a table style's fill without its
99
+ `a:fill` wrapper in thirteen places.
100
+
101
+ **And it fires on the right things.** `corpus/reject/` holds seventeen packages
102
+ PowerPoint refuses, one measured finding each, and `C-REJECT` asserts each is
103
+ caught by the rule its manifest names. Four rules have no instance anywhere in
104
+ the good corpus — every file containing one is a file PowerPoint refuses — and
105
+ without those fixtures they would be enforced entirely on trust.
106
+
107
+ ## What passing does not mean
108
+
109
+ Necessary, not sufficient. PowerPoint rejects some schema-legal markup for
110
+ reasons nobody has enumerated, and this package knows the ones we have found.
111
+ The strongest defence is architectural — _never synthesize markup we did not
112
+ read_. The second strongest is `cli bisect` (sub-phase 1.5), which reduces a deck
113
+ PowerPoint refused until the smallest reproducing change is left, and whose
114
+ output is how the measured rules above got here.
115
+
116
+ ## API
117
+
118
+ | | |
119
+ | ------------------------------------------ | -------------------------------------------------------------------------- |
120
+ | `validatePackage(options)` | check a package; returns a `Report`, never throws for a finding |
121
+ | `assertValid(options)` | the same, but throws `ValidateError` when something we introduced is fatal |
122
+ | `formatReport(report, options)` | the report as text, grouped by part |
123
+ | `RULES`, `ruleById`, `RULE_IDS` | the table, with `title`, `why`, `evidence` and `severity` |
124
+ | `xpathOf`, `elementLocation`, `lineColumn` | locations, for a caller building its own report |
125
+
126
+ `ValidateOptions` takes `store` (the package about to be written), `bytes` (the
127
+ archive, for the two rules that read it), `baseline` (the package as it was
128
+ opened) and `rules` (a subset). On an export, `store` must be the store the
129
+ writer emitted from and not one re-opened from the written bytes — a re-opened
130
+ store thinks every part came from the archive, and `V027` would then have no
131
+ history to ask about.