@openpresentation/opf-render 0.0.1
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 +21 -0
- package/README.md +44 -0
- package/dist/index.d.ts +15 -0
- package/dist/index.js +15 -0
- package/package.json +44 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 OpenPresentation
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
# OPF Render
|
|
2
|
+
|
|
3
|
+
Deterministic local renderer for Open Presentation Format documents. This repo is the Phase 1 toolkit lane for SVG, PNG, and PDF output.
|
|
4
|
+
|
|
5
|
+
## Scope
|
|
6
|
+
|
|
7
|
+
- Package: `@openpresentation/opf-render`
|
|
8
|
+
- Repository: `OpenPresentation/opf-render`
|
|
9
|
+
- License: MIT
|
|
10
|
+
- Compatibility target: `@openpresentation/opf`
|
|
11
|
+
- Planned public API: `renderSvg(opf, opts)`, `svgToPng(svg, opts)`, and `svgToPdf(svgs, opts)`
|
|
12
|
+
|
|
13
|
+
Feature implementation is intentionally not in this provisioning slice. The first implementation task owns validation, catalog resolution, placeholder binding, SVG emission, and deterministic golden tests.
|
|
14
|
+
|
|
15
|
+
## Runtime Policy
|
|
16
|
+
|
|
17
|
+
The package runtime must stay local and deterministic:
|
|
18
|
+
|
|
19
|
+
- No hosted service in the critical path
|
|
20
|
+
- No telemetry or hidden analytics
|
|
21
|
+
- No commercial SDK dependency in the critical path
|
|
22
|
+
- No required network calls
|
|
23
|
+
- No clock, locale, random, or system-font fallback drift in render output
|
|
24
|
+
- Host applications own auth, storage, queues, analytics, collaboration, and product workflow
|
|
25
|
+
|
|
26
|
+
## Development
|
|
27
|
+
|
|
28
|
+
```sh
|
|
29
|
+
npm ci
|
|
30
|
+
npm run build
|
|
31
|
+
npm run validate
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
## Release Lane
|
|
35
|
+
|
|
36
|
+
Public npm package publication is handled by `.github/workflows/release.yml` with npm provenance.
|
|
37
|
+
|
|
38
|
+
Required first-publish setup:
|
|
39
|
+
|
|
40
|
+
1. An npm owner for the `@openpresentation` scope must run the first publish or reserve/grant the `@openpresentation/opf-render` package.
|
|
41
|
+
2. Configure npm Trusted Publishing for GitHub repository `OpenPresentation/opf-render` and workflow `.github/workflows/release.yml`.
|
|
42
|
+
3. Publish by creating a GitHub Release or manually running the Release workflow after CI passes.
|
|
43
|
+
|
|
44
|
+
This repo does not require an npm automation token when Trusted Publishing is configured.
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
export declare const packageName = "@openpresentation/opf-render";
|
|
2
|
+
|
|
3
|
+
export declare const releaseLane: Readonly<{
|
|
4
|
+
githubRepository: "OpenPresentation/opf-render";
|
|
5
|
+
npmPackage: "@openpresentation/opf-render";
|
|
6
|
+
compatibilityPackage: "@openpresentation/opf";
|
|
7
|
+
}>;
|
|
8
|
+
|
|
9
|
+
export declare const runtimePolicy: Readonly<{
|
|
10
|
+
hostedServiceInCriticalPath: false;
|
|
11
|
+
telemetry: false;
|
|
12
|
+
commercialSdkInCriticalPath: false;
|
|
13
|
+
requiredNetworkCalls: false;
|
|
14
|
+
deterministicLocalExecution: true;
|
|
15
|
+
}>;
|
package/dist/index.js
ADDED
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
export const packageName = "@openpresentation/opf-render";
|
|
2
|
+
|
|
3
|
+
export const releaseLane = Object.freeze({
|
|
4
|
+
githubRepository: "OpenPresentation/opf-render",
|
|
5
|
+
npmPackage: "@openpresentation/opf-render",
|
|
6
|
+
compatibilityPackage: "@openpresentation/opf"
|
|
7
|
+
});
|
|
8
|
+
|
|
9
|
+
export const runtimePolicy = Object.freeze({
|
|
10
|
+
hostedServiceInCriticalPath: false,
|
|
11
|
+
telemetry: false,
|
|
12
|
+
commercialSdkInCriticalPath: false,
|
|
13
|
+
requiredNetworkCalls: false,
|
|
14
|
+
deterministicLocalExecution: true
|
|
15
|
+
});
|
package/package.json
ADDED
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@openpresentation/opf-render",
|
|
3
|
+
"version": "0.0.1",
|
|
4
|
+
"description": "Deterministic local OPF renderer for SVG, PNG, and PDF output.",
|
|
5
|
+
"license": "MIT",
|
|
6
|
+
"type": "module",
|
|
7
|
+
"private": false,
|
|
8
|
+
"engines": {
|
|
9
|
+
"node": ">=20"
|
|
10
|
+
},
|
|
11
|
+
"repository": {
|
|
12
|
+
"type": "git",
|
|
13
|
+
"url": "git+https://github.com/OpenPresentation/opf-render.git"
|
|
14
|
+
},
|
|
15
|
+
"bugs": {
|
|
16
|
+
"url": "https://github.com/OpenPresentation/opf-render/issues"
|
|
17
|
+
},
|
|
18
|
+
"homepage": "https://github.com/OpenPresentation/opf-render#readme",
|
|
19
|
+
"publishConfig": {
|
|
20
|
+
"access": "public"
|
|
21
|
+
},
|
|
22
|
+
"files": [
|
|
23
|
+
"dist",
|
|
24
|
+
"README.md",
|
|
25
|
+
"LICENSE"
|
|
26
|
+
],
|
|
27
|
+
"exports": {
|
|
28
|
+
".": {
|
|
29
|
+
"types": "./dist/index.d.ts",
|
|
30
|
+
"default": "./dist/index.js"
|
|
31
|
+
},
|
|
32
|
+
"./package.json": "./package.json"
|
|
33
|
+
},
|
|
34
|
+
"types": "./dist/index.d.ts",
|
|
35
|
+
"sideEffects": false,
|
|
36
|
+
"scripts": {
|
|
37
|
+
"build": "node scripts/build.mjs",
|
|
38
|
+
"validate": "node scripts/validate-package.mjs",
|
|
39
|
+
"prepack": "npm run build"
|
|
40
|
+
},
|
|
41
|
+
"dependencies": {
|
|
42
|
+
"@openpresentation/opf": "^0.2.2"
|
|
43
|
+
}
|
|
44
|
+
}
|