Add c2pa-types + typed activeManifest and manifestStore APIs (#11)

emensch · web-flow · commit f21c81d6148e · 2025-09-09T18:37:15.000-04:00
* feat: add c2pa-types package with automatic type generation

* feat: add typed manifestStore and activeManifest APIs

* chore: changeset

* chore: add copyright header
diff --git a/.changeset/five-rice-raise.md b/.changeset/five-rice-raise.md
@@ -0,0 +1,7 @@
+---
+'@contentauth/c2pa-types': minor
+'@contentauth/c2pa-wasm': minor
+'@contentauth/c2pa-web': minor
+---
+
+Added reader.manifestStore() and reader.activeManifest() APIs
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -3,6 +3,7 @@
 resolver = '2'
 members = [
 	'packages/c2pa-wasm',
+	'packages/c2pa-types',
 ]
 
 [profile.release]
diff --git a/packages/c2pa-types/.gitignore b/packages/c2pa-types/.gitignore
@@ -0,0 +1,2 @@
+schemas
+types
diff --git a/packages/c2pa-types/Cargo.toml b/packages/c2pa-types/Cargo.toml
@@ -0,0 +1,9 @@
+[package]
+name = "c2pa-types"
+version = "0.1.0"
+edition = "2024"
+
+[dependencies]
+c2pa = { version = "0.62.0", features = ["pdf", "rust_native_crypto", "json_schema"], default-features = false }
+schemars = "0.8.21"
+serde_json = "1.0.143"
diff --git a/packages/c2pa-types/index.d.ts b/packages/c2pa-types/index.d.ts
@@ -0,0 +1,16 @@
+/**
+ * Copyright 2025 Adobe
+ * All Rights Reserved.
+ *
+ * NOTICE: Adobe permits you to use, modify, and distribute this file in
+ * accordance with the terms of the Adobe license agreement accompanying
+ * it.
+ */
+
+import type { Reader } from './types/ManifestStore.js';
+
+// Renames the auto-generated "Reader" type to the more appropriate "ManifestStore"
+// eslint-disable-next-line @typescript-eslint/no-empty-interface, @typescript-eslint/no-empty-object-type
+export interface ManifestStore extends Reader {}
+
+export type { Manifest } from './types/ManifestStore.js';
diff --git a/packages/c2pa-types/package.json b/packages/c2pa-types/package.json
@@ -0,0 +1,17 @@
+{
+  "name": "@contentauth/c2pa-types",
+  "description": "Typescript types generated from c2pa-rs",
+  "type": "module",
+  "version": "0.1.1",
+  "types": "index.d.ts",
+  "scripts": {
+    "test": "echo \"No tests to run\" && exit 0",
+    "build": "pnpm clean && json2ts -i schemas/ -o types/",
+    "clean": "rimraf types"
+  },
+  "files": ["index.d.ts", "types/**/*"],
+  "dependencies": {
+    "json-schema-to-typescript": "^15.0.4",
+    "rimraf": "^6.0.1"
+  }
+}
diff --git a/packages/c2pa-types/project.json b/packages/c2pa-types/project.json
@@ -0,0 +1,26 @@
+{
+  "name": "c2pa-types",
+  "$schema": "../../node_modules/nx/schemas/project-schema.json",
+  "tags": ["lib"],
+  "projectType": "library",
+  "sourceRoot": "packages/c2pa-types/src",
+  "targets": {
+    "build": {
+      "cache": true,
+      "inputs": [
+        "{projectRoot}/**/*",
+        "!{projectRoot}/schemas/**/*",
+        "!{projectRoot}/types/**/*"
+      ],
+      "executor": "nx:run-commands",
+      "options": {
+        "commands": [
+          "cargo run",
+          "pnpm build"
+        ],
+        "parallel": false,
+        "cwd": "{projectRoot}"
+      }
+    }
+  }
+}
diff --git a/packages/c2pa-types/src/main.rs b/packages/c2pa-types/src/main.rs
@@ -0,0 +1,31 @@
+// Copyright 2025 Adobe
+// All Rights Reserved.
+//
+// NOTICE: Adobe permits you to use, modify, and distribute this file in
+// accordance with the terms of the Adobe license agreement accompanying
+// it.
+
+use std::{fs, path::Path};
+
+use c2pa::Reader;
+use schemars::{schema::RootSchema, schema_for};
+
+fn main() {
+    let output_dir = Path::new("./schemas");
+
+    if fs::exists(output_dir).unwrap() {
+        fs::remove_dir_all(output_dir).expect("Could not clear existing schema directory");
+    }
+
+    fs::create_dir_all(output_dir).expect("Could not create schema directory");
+
+    write_schema(&schema_for!(Reader), &"ManifestStore", output_dir);
+}
+
+fn write_schema(schema: &RootSchema, name: &str, output_dir: &Path) {
+    println!("Exporting JSON schema for {name}");
+    let output_path = output_dir.join(format!("{name}.json"));
+    let output = serde_json::to_string_pretty(schema).expect("Failed to serialize schema");
+    fs::write(&output_path, output).expect("Unable to write schema");
+    println!("Wrote schema to {}", output_path.display());
+}
diff --git a/packages/c2pa-wasm/Cargo.toml b/packages/c2pa-wasm/Cargo.toml
@@ -25,6 +25,8 @@ wasm-bindgen-futures = "0.4.50"
 c2pa = { version = "0.62.0", features = ["pdf", "rust_native_crypto", "fetch_remote_manifests"], default-features = false }
 async-trait = "0.1.88"
 thiserror = "2.0.12"
+serde-wasm-bindgen = "0.6.5"
+serde = "1.0.219"
 
 [dependencies.web-sys]
 version = "0.3.77"
diff --git a/packages/c2pa-wasm/src/error.rs b/packages/c2pa-wasm/src/error.rs
@@ -14,6 +14,9 @@ pub enum WasmError {
     #[error(transparent)]
     C2pa(#[from] c2pa::Error),
 
+    #[error(transparent)]
+    Serde(#[from] serde_wasm_bindgen::Error),
+
     #[error(transparent)]
     Other(Box<dyn Error>),
 }
diff --git a/packages/c2pa-wasm/src/wasm_reader.rs b/packages/c2pa-wasm/src/wasm_reader.rs
@@ -9,6 +9,8 @@ use std::io::{Cursor, Read, Seek};
 
 use c2pa::{identity::validator::CawgValidator, Reader};
 use js_sys::{ArrayBuffer, Error as JsError, Uint8Array};
+use serde::Serialize;
+use serde_wasm_bindgen::Serializer;
 use wasm_bindgen::prelude::*;
 use web_sys::Blob;
 
@@ -18,6 +20,7 @@ use crate::{error::WasmError, stream::BlobStream};
 #[wasm_bindgen]
 pub struct WasmReader {
     reader: Reader,
+    serializer: Serializer,
 }
 
 #[wasm_bindgen]
@@ -33,17 +36,11 @@ impl WasmReader {
         format: &str,
         stream: impl Read + Seek + Send,
     ) -> Result<WasmReader, JsError> {
-        let mut reader = Reader::from_stream_async(format, stream)
+        let reader = Reader::from_stream_async(format, stream)
             .await
             .map_err(WasmError::from)?;
 
-        // This will be removed once CawgValidation is rolled into the reader
-        reader
-            .post_validate_async(&CawgValidator {})
-            .await
-            .map_err(WasmError::other)?;
-
-        Ok(WasmReader { reader })
+        Ok(WasmReader::from_reader(reader).await?)
     }
 
     /// Attempts to create a new `WasmReader` from an asset format, a `Blob` of the bytes of the initial segment, and a fragment `Blob`.
@@ -64,23 +61,23 @@ impl WasmReader {
         init: impl Read + Seek + Send,
         fragment: impl Read + Seek + Send,
     ) -> Result<WasmReader, JsError> {
-        let mut reader = Reader::from_fragment_async(format, init, fragment)
+        let reader = Reader::from_fragment_async(format, init, fragment)
             .await
             .map_err(WasmError::other)?;
 
+        Ok(WasmReader::from_reader(reader).await?)
+    }
+
+    async fn from_reader(mut reader: Reader) -> Result<WasmReader, JsError> {
+        let serializer = Serializer::new().serialize_maps_as_objects(true);
+
         // This will be removed once CawgValidation is rolled into the reader
         reader
             .post_validate_async(&CawgValidator {})
             .await
             .map_err(WasmError::other)?;
 
-        Ok(WasmReader { reader })
-    }
-
-    /// Returns a JSON representation of the asset's manifest store.
-    #[wasm_bindgen]
-    pub fn json(&self) -> String {
-        self.reader.json()
+        Ok(WasmReader { reader, serializer })
     }
 
     /// Returns the label of the asset's active manifest.
@@ -89,6 +86,37 @@ impl WasmReader {
         self.reader.active_label().map(|val| val.to_owned())
     }
 
+    /// Returns the asset's manifest store.
+    /// NOTE: at the moment, CAWG data is not decoded via this function. Use WasmReader::json() if CAWG is a requirement.
+    #[wasm_bindgen(js_name = manifestStore)]
+    pub fn manifest_store(&self) -> Result<JsValue, JsError> {
+        let manifest_store = self
+            .reader
+            .serialize(&self.serializer)
+            .map_err(WasmError::from)?;
+
+        Ok(manifest_store)
+    }
+
+    /// Returns the asset's active manifest.
+    /// NOTE: at the moment, CAWG data is not decoded via this function. Use WasmReader::json() if CAWG is a requirement.
+    #[wasm_bindgen(js_name = activeManifest)]
+    pub fn active_manifest(&self) -> Result<JsValue, JsError> {
+        let active_manifest = self
+            .reader
+            .active_manifest()
+            .serialize(&self.serializer)
+            .map_err(WasmError::from)?;
+
+        Ok(active_manifest)
+    }
+
+    /// Returns a JSON representation of the asset's manifest store.
+    #[wasm_bindgen]
+    pub fn json(&self) -> String {
+        self.reader.json()
+    }
+
     /// Accepts a URI reference to a binary object in the resource store and returns a `js_sys::ArrayBuffer` containing the resource's bytes.
     #[wasm_bindgen(js_name = resourceToBuffer)]
     pub fn resource_to_buffer(&self, uri: &str) -> Result<ArrayBuffer, JsError> {
diff --git a/packages/c2pa-web/package.json b/packages/c2pa-web/package.json
@@ -30,7 +30,8 @@
     }
   },
   "dependencies": {
-    "@contentauth/c2pa-wasm": "workspace:*"
+    "@contentauth/c2pa-wasm": "workspace:*",
+    "@contentauth/c2pa-types": "workspace:*"
   },
   "devDependencies": {
     "@playwright/test": "^1.55.0",
diff --git a/packages/c2pa-web/src/index.ts b/packages/c2pa-web/src/index.ts
@@ -8,8 +8,13 @@
  */
 
 export * from './lib/c2pa.js';
+
 export {
   isSupportedReaderFormat,
   READER_SUPPORTED_FORMATS,
 } from './lib/supportedFormats.js';
+
 export { type Settings } from './lib/settings.js';
+
+// Re-export types from c2pa-types for convenience.
+export type * from '@contentauth/c2pa-types';
diff --git a/packages/c2pa-web/src/lib/c2pa.spec.ts b/packages/c2pa-web/src/lib/c2pa.spec.ts
diff --git a/packages/c2pa-web/src/lib/reader.ts b/packages/c2pa-web/src/lib/reader.ts
diff --git a/packages/c2pa-web/src/lib/worker.ts b/packages/c2pa-web/src/lib/worker.ts
diff --git a/packages/c2pa-web/vite.config.ts b/packages/c2pa-web/vite.config.ts
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml

Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,7 @@`
`3`	`3`	`resolver = '2'`
`4`	`4`	`members = [`
`5`	`5`	`'packages/c2pa-wasm',`
	`6`	`+ 'packages/c2pa-types',`
`6`	`7`	`]`
`7`	`8`
`8`	`9`	`[profile.release]`