@contentauth/c2pa-types 0.4.4 → 0.4.5
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/README.md +14 -6
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,10 +1,18 @@
|
|
|
1
1
|
# c2pa-types
|
|
2
2
|
|
|
3
|
-
Exports TypeScript types
|
|
3
|
+
Exports TypeScript types used by c2pa-web that are auto-generated from [c2pa-rs](https://github.com/contentauth/c2pa-rs) structs.
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
## Prerequisites
|
|
6
6
|
|
|
7
|
-
Ensure the repo-wide prerequisites
|
|
7
|
+
Ensure the repo-wide prerequisites are installed:
|
|
8
|
+
|
|
9
|
+
- [Node.js](https://nodejs.org/) v22+
|
|
10
|
+
- [NX](https://nx.dev/getting-started/intro)
|
|
11
|
+
- [pnpm](https://pnpm.io/)
|
|
12
|
+
|
|
13
|
+
See the [c2pa-js README](../../README.md#prerequisites) for details.
|
|
14
|
+
|
|
15
|
+
## Building
|
|
8
16
|
|
|
9
17
|
To build the types:
|
|
10
18
|
|
|
@@ -15,6 +23,6 @@ nx build c2pa-types
|
|
|
15
23
|
The types are built as follows:
|
|
16
24
|
|
|
17
25
|
1. Specific structs ([example](https://github.com/contentauth/c2pa-rs/blob/main/sdk/src/manifest.rs#L55)) from c2pa-rs are annotated with the `schemars::JsonSchema` attribute.
|
|
18
|
-
2. JSON schema files are generated by calling `schemars::schema_for` and saved to the `schemas/` directory
|
|
19
|
-
3. Schema files are read by `json-schema-to-typescript` and used to generate TypeScript types, saved to the `types/` directory
|
|
20
|
-
4. Types are "gathered" and exported from the `index.d.ts` file
|
|
26
|
+
2. JSON schema files are generated by calling `schemars::schema_for` and saved to the `schemas/` directory.
|
|
27
|
+
3. Schema files are read by `json-schema-to-typescript` and used to generate TypeScript types, saved to the `types/` directory.
|
|
28
|
+
4. Types are "gathered" and exported from the `index.d.ts` file.
|