@plasius/gpu-model-core 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/LICENSE ADDED
@@ -0,0 +1,203 @@
1
+ Copyright 2025 Plasius LTD
2
+
3
+ Apache License
4
+ Version 2.0, January 2004
5
+ http://www.apache.org/licenses/
6
+
7
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
8
+
9
+ 1. Definitions.
10
+
11
+ "License" shall mean the terms and conditions for use, reproduction,
12
+ and distribution as defined by Sections 1 through 9 of this document.
13
+
14
+ "Licensor" shall mean the copyright owner or entity authorized by
15
+ the copyright owner that is granting the License.
16
+
17
+ "Legal Entity" shall mean the union of the acting entity and all
18
+ other entities that control, are controlled by, or are under common
19
+ control with that entity. For the purposes of this definition,
20
+ "control" means (i) the power, direct or indirect, to cause the
21
+ direction or management of such entity, whether by contract or
22
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
23
+ outstanding shares, or (iii) beneficial ownership of such entity.
24
+
25
+ "You" (or "Your") shall mean an individual or Legal Entity
26
+ exercising permissions granted by this License.
27
+
28
+ "Source" form shall mean the preferred form for making modifications,
29
+ including but not limited to software source code, documentation
30
+ source, and configuration files.
31
+
32
+ "Object" form shall mean any form resulting from mechanical
33
+ transformation or translation of a Source form, including but
34
+ not limited to compiled object code, generated documentation,
35
+ and conversions to other media types.
36
+
37
+ "Work" shall mean the work of authorship, whether in Source or
38
+ Object form, made available under the License, as indicated by a
39
+ copyright notice that is included in or attached to the work
40
+ (an example is provided in the Appendix below).
41
+
42
+ "Derivative Works" shall mean any work, whether in Source or Object
43
+ form, that is based on (or derived from) the Work and for which the
44
+ editorial revisions, annotations, elaborations, or other modifications
45
+ represent, as a whole, an original work of authorship. For the purposes
46
+ of this License, Derivative Works shall not include works that remain
47
+ separable from, or merely link (or bind by name) to the interfaces of,
48
+ the Work and Derivative Works thereof.
49
+
50
+ "Contribution" shall mean any work of authorship, including
51
+ the original version of the Work and any modifications or additions
52
+ to that Work or Derivative Works thereof, that is intentionally
53
+ submitted to Licensor for inclusion in the Work by the copyright owner
54
+ or by an individual or Legal Entity authorized to submit on behalf of
55
+ the copyright owner. For the purposes of this definition, "submitted"
56
+ means any form of electronic, verbal, or written communication sent
57
+ to the Licensor or its representatives, including but not limited to
58
+ communication on electronic mailing lists, source code control systems,
59
+ and issue tracking systems that are managed by, or on behalf of, the
60
+ Licensor for the purpose of discussing and improving the Work, but
61
+ excluding communication that is conspicuously marked or otherwise
62
+ designated in writing by the copyright owner as "Not a Contribution."
63
+
64
+ "Contributor" shall mean Licensor and any individual or Legal Entity
65
+ on behalf of whom a Contribution has been received by Licensor and
66
+ subsequently incorporated within the Work.
67
+
68
+ 2. Grant of Copyright License. Subject to the terms and conditions of
69
+ this License, each Contributor hereby grants to You a perpetual,
70
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
71
+ copyright license to reproduce, prepare Derivative Works of,
72
+ publicly display, publicly perform, sublicense, and distribute the
73
+ Work and such Derivative Works in Source or Object form.
74
+
75
+ 3. Grant of Patent License. Subject to the terms and conditions of
76
+ this License, each Contributor hereby grants to You a perpetual,
77
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
78
+ (except as stated in this section) patent license to make, have made,
79
+ use, offer to sell, sell, import, and otherwise transfer the Work,
80
+ where such license applies only to those patent claims licensable
81
+ by such Contributor that are necessarily infringed by their
82
+ Contribution(s) alone or by combination of their Contribution(s)
83
+ with the Work to which such Contribution(s) was submitted. If You
84
+ institute patent litigation against any entity (including a
85
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
86
+ or a Contribution incorporated within the Work constitutes direct
87
+ or contributory patent infringement, then any patent licenses
88
+ granted to You under this License for that Work shall terminate
89
+ as of the date such litigation is filed.
90
+
91
+ 4. Redistribution. You may reproduce and distribute copies of the
92
+ Work or Derivative Works thereof in any medium, with or without
93
+ modifications, and in Source or Object form, provided that You
94
+ meet the following conditions:
95
+
96
+ (a) You must give any other recipients of the Work or
97
+ Derivative Works a copy of this License; and
98
+
99
+ (b) You must cause any modified files to carry prominent notices
100
+ stating that You changed the files; and
101
+
102
+ (c) You must retain, in the Source form of any Derivative Works
103
+ that You distribute, all copyright, patent, trademark, and
104
+ attribution notices from the Source form of the Work,
105
+ excluding those notices that do not pertain to any part of
106
+ the Derivative Works; and
107
+
108
+ (d) If the Work includes a "NOTICE" text file as part of its
109
+ distribution, then any Derivative Works that You distribute must
110
+ include a readable copy of the attribution notices contained
111
+ within such NOTICE file, excluding those notices that do not
112
+ pertain to any part of the Derivative Works, in at least one
113
+ of the following places: within a NOTICE text file distributed
114
+ as part of the Derivative Works; within the Source form or
115
+ documentation, if provided along with the Derivative Works; or,
116
+ within a display generated by the Derivative Works, if and
117
+ wherever such third-party notices normally appear. The contents
118
+ of the NOTICE file are for informational purposes only and
119
+ do not modify the License. You may add Your own attribution
120
+ notices within Derivative Works that You distribute, alongside
121
+ or as an addendum to the NOTICE text from the Work, provided
122
+ that such additional attribution notices cannot be construed
123
+ as modifying the License.
124
+
125
+ You may add Your own copyright statement to Your modifications and
126
+ may provide additional or different license terms and conditions
127
+ for use, reproduction, or distribution of Your modifications, or
128
+ for any such Derivative Works as a whole, provided Your use,
129
+ reproduction, and distribution of the Work otherwise complies with
130
+ the conditions stated in this License.
131
+
132
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
133
+ any Contribution intentionally submitted for inclusion in the Work
134
+ by You to the Licensor shall be under the terms and conditions of
135
+ this License, without any additional terms or conditions.
136
+ Notwithstanding the above, nothing herein shall supersede or modify
137
+ the terms of any separate license agreement you may have executed
138
+ with Licensor regarding such Contributions.
139
+
140
+ 6. Trademarks. This License does not grant permission to use the trade
141
+ names, trademarks, service marks, or product names of the Licensor,
142
+ except as required for reasonable and customary use in describing the
143
+ origin of the Work and reproducing the content of the NOTICE file.
144
+
145
+ 7. Disclaimer of Warranty. Unless required by applicable law or
146
+ agreed to in writing, Licensor provides the Work (and each
147
+ Contributor provides its Contributions) on an "AS IS" BASIS,
148
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
149
+ implied, including, without limitation, any warranties or conditions
150
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
151
+ PARTICULAR PURPOSE. You are solely responsible for determining the
152
+ appropriateness of using or redistributing the Work and assume any
153
+ risks associated with Your exercise of permissions under this License.
154
+
155
+ 8. Limitation of Liability. In no event and under no legal theory,
156
+ whether in tort (including negligence), contract, or otherwise,
157
+ unless required by applicable law (such as deliberate and grossly
158
+ negligent acts) or agreed to in writing, shall any Contributor be
159
+ liable to You for damages, including any direct, indirect, special,
160
+ incidental, or consequential damages of any character arising as a
161
+ result of this License or out of the use or inability to use the
162
+ Work (including but not limited to damages for loss of goodwill,
163
+ work stoppage, computer failure or malfunction, or any and all
164
+ other commercial damages or losses), even if such Contributor
165
+ has been advised of the possibility of such damages.
166
+
167
+ 9. Accepting Warranty or Additional Liability. While redistributing
168
+ the Work or Derivative Works thereof, You may choose to offer,
169
+ and charge a fee for, acceptance of support, warranty, indemnity,
170
+ or other liability obligations and/or rights consistent with this
171
+ License. However, in accepting such obligations, You may act only
172
+ on Your own behalf and on Your sole responsibility, not on behalf
173
+ of any other Contributor, and only if You agree to indemnify,
174
+ defend, and hold each Contributor harmless for any liability
175
+ incurred by, or claims asserted against, such Contributor by reason
176
+ of your accepting any such warranty or additional liability.
177
+
178
+ END OF TERMS AND CONDITIONS
179
+
180
+ APPENDIX: How to apply the Apache License to your work.
181
+
182
+ To apply the Apache License to your work, attach the following
183
+ boilerplate notice, with the fields enclosed by brackets "[]"
184
+ replaced with your own identifying information. (Don't include
185
+ the brackets!) The text should be enclosed in the appropriate
186
+ comment syntax for the file format. We also recommend that a
187
+ file or class name and description of purpose be included on the
188
+ same "printed page" as the copyright notice for easier
189
+ identification within third-party archives.
190
+
191
+ Copyright [yyyy] [name of copyright owner]
192
+
193
+ Licensed under the Apache License, Version 2.0 (the "License");
194
+ you may not use this file except in compliance with the License.
195
+ You may obtain a copy of the License at
196
+
197
+ http://www.apache.org/licenses/LICENSE-2.0
198
+
199
+ Unless required by applicable law or agreed to in writing, software
200
+ distributed under the License is distributed on an "AS IS" BASIS,
201
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
202
+ See the License for the specific language governing permissions and
203
+ limitations under the License.
package/README.md ADDED
@@ -0,0 +1,185 @@
1
+ # @plasius/gpu-model-core
2
+
3
+ Canonical model document, resource graph, diagnostics, and adapter contracts.
4
+
5
+ This repository is the dedicated package boundary defined by ADR 0094.
6
+
7
+ ## Implementation tracker
8
+
9
+ The canonical conversion architecture is defined by [ADR 0094 in `plasius-ltd-site`](https://github.com/Plasius-LTD/plasius-ltd-site/blob/main/docs/adrs/adr-0094-gpu-model-family-and-canonical-proxy-conversion.md). The package implementation work is split into Project-tracked Tasks:
10
+
11
+ - [Bootstrap package boundary](https://github.com/Plasius-LTD/gpu-model-core/issues/1)
12
+ - [Canonical GPU model document schema](https://github.com/Plasius-LTD/gpu-model-core/issues/3)
13
+ - [Diagnostics and repair contracts](https://github.com/Plasius-LTD/gpu-model-core/issues/4)
14
+ - [Canonical model resource graph](https://github.com/Plasius-LTD/gpu-model-core/issues/5)
15
+ - [Adapter capability and conversion registry contracts](https://github.com/Plasius-LTD/gpu-model-core/issues/6)
16
+ - [Verified static-model document for the ChatGPT PVOX demo](https://github.com/Plasius-LTD/gpu-model-core/issues/13)
17
+
18
+ The general package Tasks inherit `gpu.model.conversion.enabled` from Feature
19
+ #1148 and remain independent of format-specific loaders and renderers. Task #13
20
+ is an additive dependent slice under Feature #2012 and also requires
21
+ `asset.pipeline.pvox-models.enabled` before its compiler projection can run.
22
+
23
+ ## Canonical document v1
24
+
25
+ `GpuModelDocument` is the immutable, renderer-neutral hand-off between source
26
+ format adapters, model processing, and render bridges. Raw resources cross an
27
+ asynchronous verification boundary before document construction: an injected
28
+ worker port streams every `Blob` through payload inspection and SHA-256 digest
29
+ verification. Only privately attested resources are accepted by the synchronous
30
+ factory. This prevents a shape-compatible object, forged digest string, or
31
+ structured clone from claiming that bytes were verified.
32
+
33
+ ```ts
34
+ import {
35
+ CANONICAL_GPU_MODEL_COORDINATE_SYSTEM,
36
+ GPU_MODEL_DOCUMENT_SCHEMA_VERSION,
37
+ createAndVerifyGpuModelDocument,
38
+ type GpuModelResourceVerificationPort,
39
+ } from "@plasius/gpu-model-core";
40
+
41
+ declare const untrustedAdapterOutput: unknown;
42
+ declare const verificationPort: GpuModelResourceVerificationPort;
43
+ const document = await createAndVerifyGpuModelDocument(
44
+ untrustedAdapterOutput,
45
+ verificationPort,
46
+ );
47
+
48
+ document.schemaVersion === GPU_MODEL_DOCUMENT_SCHEMA_VERSION; // true
49
+ document.coordinateSystem === CANONICAL_GPU_MODEL_COORDINATE_SYSTEM; // true
50
+ ```
51
+
52
+ Adapter output includes roots, nodes, verified resources, accessors, meshes,
53
+ materials, first-class texture fidelity nodes, distinct skeletons, joints and
54
+ skins, blend shapes, animation clips, analytic geometry, bounds, provenance,
55
+ diagnostics, and bounded JSON metadata. Material texture transforms, colour
56
+ space, usage, extension payloads, authored rig weights, clip timing, and source
57
+ metadata survive the canonical boundary.
58
+
59
+ Verification applies non-raiseable defaults of 100 MiB per resource, 164 MiB
60
+ aggregate resources, 64 MiB aggregate images, and 4096 pixels per image axis.
61
+ It verifies detected MIME and image dimensions before hashing that image, then
62
+ constructs the returned `Blob` from the exact digest-verified byte snapshot.
63
+ One internal deadline signal is propagated to both worker-port calls and every
64
+ stream chunk. Re-verifying an attested resource or document is idempotent, but
65
+ still honours cancellation and re-applies any tighter byte/image/aggregate
66
+ limits using retained inspection evidence.
67
+
68
+ The document validator then reads only the private snapshot to reject
69
+ non-finite accessor data, false min/max claims, out-of-range indices and skin
70
+ joint indices, mismatched weights, texture bindings whose required
71
+ `TEXCOORD_n` is absent from a material-using primitive, and bounds that do not
72
+ match canonical `POSITION` bytes under affine world transforms. Payload,
73
+ index, and instanced world-geometry work has aggregate ceilings; accessor
74
+ evidence, mesh primitive/position indexes, and repeated position/index scans
75
+ are cached within one validation. Scene ancestry uses one bounded interval
76
+ index rather than per-joint parent walks. Blend-shape delta/accessor work is
77
+ bounded across the document and reuses the verified payload evidence.
78
+
79
+ `createGpuModelDocument` remains available for trusted composition code that
80
+ already holds privately verified resources. `isGpuModelDocument` narrows only
81
+ values returned by a factory; `canCreateGpuModelDocument` is the non-narrowing
82
+ probe. A structured clone deliberately loses private attestation and must pass
83
+ through `createAndVerifyGpuModelDocument` again. Format parsing, renderer
84
+ uploads, catalogue rights, promotion identity, tolerant repair, and target loss
85
+ reporting stay outside this Task's package boundary.
86
+
87
+ ## Bounded static PVOX demo projection
88
+
89
+ Task #13 adds a deliberately narrower compiler hand-off without changing the
90
+ general document owned by Task #3. Consumers first create a privately verified
91
+ `GpuModelDocument`, evaluate the remote
92
+ `asset.pipeline.pvox-models.enabled` flag, and then request a compiler-safe
93
+ world-triangle projection:
94
+
95
+ ```ts
96
+ import {
97
+ createGpuModelStaticDemoCompilerInput,
98
+ type GpuModelDocument,
99
+ } from "@plasius/gpu-model-core";
100
+
101
+ declare const verifiedDocument: GpuModelDocument;
102
+ declare const pvoxModelsEnabled: boolean; // remote flag evaluation
103
+
104
+ const compilerInput = await createGpuModelStaticDemoCompilerInput(
105
+ verifiedDocument,
106
+ { pvoxModelsEnabled },
107
+ );
108
+
109
+ compilerInput.canonicalDocumentHash; // SHA-256 of canonical document bytes
110
+ compilerInput.worldTriangles; // verified positions, normals, bounds and regions
111
+ ```
112
+
113
+ The profile accepts at most 200,000 explicit world-space triangles, 4,096
114
+ nodes, 16,384 primitives, 4,096 fixed-factor materials, and 16 MiB of verified
115
+ buffer resources. Every world-space coordinate additionally has a fixed,
116
+ non-raiseable magnitude ceiling of 1,048,576 metres, with consistent axis
117
+ extent and diagonal bounds. The compiler also checks every computed triangle
118
+ coordinate against that ceiling; security bounds use tight absolute equality
119
+ instead of coordinate-relative tolerance. It accepts only rigid `triangles`, opaque texture-free
120
+ metallic-roughness or unlit materials, invertible transforms, and geometry
121
+ whose verified bounds prove metre/Y-up/-Z-forward/floor-centred normalization.
122
+ Skins, animation, morphs, analytic geometry, images, texture bindings, custom
123
+ material workflows, strips, lines, and points fail closed.
124
+
125
+ `encodeGpuModelDocumentCanonical` sorts object keys while preserving semantic
126
+ array order. Verified resource bytes are bound through their privately checked
127
+ SHA-256 identities, so canonical encoding does not duplicate source payloads.
128
+ `hashGpuModelDocumentCanonical` provides the stable whole-document identity.
129
+ The projection retains safe source/converter hashes and material-region IDs,
130
+ but deliberately excludes source URLs and arbitrary metadata from the PVOX
131
+ compiler surface.
132
+
133
+ The dependency flow is:
134
+
135
+ ```text
136
+ strict source adapter
137
+ -> createAndVerifyGpuModelDocument (Task #3 / Feature #1148)
138
+ -> createGpuModelStaticDemoCompilerInput (Task #13 / Feature #2012)
139
+ -> @plasius/gpu-model-voxel
140
+ ```
141
+
142
+ This bounded demo contract does not implement provider acquisition, general
143
+ source repair, native sparse GPU traversal, deformation, destruction, or the
144
+ full production Partner-to-PVOX acceptance plan. See the
145
+ [static demo compiler-input design](docs/design/static-demo-compiler-input.md).
146
+
147
+ ## Rollout
148
+
149
+ - Canonical-document feature flag: `gpu.model.conversion.enabled`
150
+ - Static PVOX demo feature flag: `asset.pipeline.pvox-models.enabled`
151
+ - Capability: none for this package-only layer
152
+ - Rollback: disable `asset.pipeline.pvox-models.enabled` to stop new demo projections, disable `gpu.model.conversion.enabled` for the broader conversion boundary, and keep consumers pinned to the last validated package release
153
+
154
+ ## Development
155
+
156
+ Requires Node.js 24 and npm.
157
+
158
+ ```bash
159
+ npm ci
160
+ npm run typecheck
161
+ npm test
162
+ npm run lint
163
+ npm run build
164
+ npm run pack:check
165
+ ```
166
+
167
+ ## License
168
+
169
+ Apache-2.0. See LICENSE, SECURITY.md, and the files under legal/.
170
+
171
+ <!-- BEGIN PLASIUS RELEASE INTEGRITY -->
172
+ ## Release integrity
173
+
174
+ CI keeps the administrative contributor registry outside Git and npm package
175
+ artifacts using normalized path checks and sealed-tar revalidation. The
176
+ GitHub-hosted Node.js 24.18.0 release path follows the released
177
+ `@plasius/schema` v1.4.2 template: release metadata lands through a protected
178
+ pull request, exact-main CI must pass, and the immutable tarball is published
179
+ through npm OIDC. Package-specific adaptations are limited to GitHub-hosted CI
180
+ while the organisation runner is unavailable, current Node-24-compatible action
181
+ majors with best-effort Codecov CLI upload, and a protected-merge retry when
182
+ repository auto-merge is unavailable. Version `0.1.0` may use the explicit,
183
+ time-limited `bootstrap_first_publish` production gate only while the package is absent;
184
+ that credential is removed after the npm trusted publisher binding is active.
185
+ <!-- END PLASIUS RELEASE INTEGRITY -->