Skip to main content

c2pa-types

Exports TypeScript types used by c2pa-web that are auto-generated from c2pa-rs structs.

Prerequisites​

Ensure the repo-wide prerequisites are installed:

See the c2pa-js README for details.

Building​

To build the types:

nx build c2pa-types

The types are built as follows:

  1. Specific structs (example) from c2pa-rs are annotated with the schemars::JsonSchema attribute.
  2. JSON schema files are generated by calling schemars::schema_for and saved to the schemas/ directory.
  3. Schema files are read by json-schema-to-typescript and used to generate TypeScript types, saved to the types/ directory.
  4. Types are "gathered" and exported from the index.d.ts file.