feat: add typed manifestStore and activeManifest APIs

Author: emensch

packages/c2pa-types/Cargo.toml

@@ -4,6 +4,6 @@ version = "0.1.0"
 edition = "2024"
 
 [dependencies]
-c2pa = { version = "0.58.0", features = ["pdf", "rust_native_crypto", "json_schema"], default-features = false }
+c2pa = { version = "0.62.0", features = ["pdf", "rust_native_crypto", "json_schema"], default-features = false }
 schemars = "0.8.21"
 serde_json = "1.0.143"

packages/c2pa-types/index.d.ts

@@ -10,6 +10,7 @@
 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';

packages/c2pa-types/src/main.rs

@@ -5,7 +5,11 @@ use schemars::{schema::RootSchema, schema_for};
 
 fn main() {
     let output_dir = Path::new("./schemas");
-    fs::remove_dir_all(output_dir).expect("Could not clear existing schema directory");
+
+    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);

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"

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>),
 }

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> {

packages/c2pa-web/src/lib/c2pa.spec.ts

@@ -35,7 +35,7 @@ describe('c2pa', () => {
 
       const reader = await c2pa.reader.fromBlob(blob.type, blob);
 
-      const manifestStore = await reader.manifestStore();
+      const manifestStore = await reader.json();
 
       expect(manifestStore).toEqual(C_with_CAWG_data_ManifestStore);
 
@@ -49,11 +49,11 @@ describe('c2pa', () => {
 
       const reader = await c2pa.reader.fromBlob(blob.type, blob);
 
-      const manifestStore = await reader.manifestStore();
+      const manifestStore = await reader.json();
 
       const activeManifest =
-        manifestStore.manifests[manifestStore.active_manifest];
-      const thumbnailId = activeManifest.thumbnail.identifier;
+        manifestStore.manifests[manifestStore.active_manifest!];
+      const thumbnailId = activeManifest.thumbnail!.identifier;
 
       const thumbnailBuffer = await reader.resourceToBuffer(thumbnailId);
       const thumbnail = new Uint8Array(thumbnailBuffer!);
@@ -100,7 +100,7 @@ describe('c2pa', () => {
 
       const reader = await c2pa.reader.fromBlob(blob.type, blob);
 
-      const manifestStore = await reader.manifestStore();
+      const manifestStore = await reader.json();
 
       expect(manifestStore).toEqual(C_with_CAWG_data_trusted_ManifestStore);
 
@@ -123,7 +123,7 @@ describe('c2pa', () => {
 
       const reader = await c2pa.reader.fromBlob(blob.type, blob);
 
-      const manifestStore = await reader.manifestStore();
+      const manifestStore = await reader.json();
 
       expect(manifestStore).toEqual(C_with_CAWG_data_untrusted_ManifestStore);
 
@@ -142,7 +142,7 @@ describe('c2pa', () => {
         fragmentBlob
       );
 
-      const manifestStore = await reader.manifestStore();
+      const manifestStore = await reader.json();
 
       expect(manifestStore).toEqual(dashinit_ManifestStore);
 
@@ -159,7 +159,7 @@ describe('c2pa', () => {
 
       await reader.free();
 
-      await expect(reader.manifestStore()).rejects.toThrowError();
+      await expect(reader.json()).rejects.toThrowError();
     });
   });
 });

packages/c2pa-web/src/lib/reader.ts

@@ -7,6 +7,7 @@
  * it.
  */
 
+import { Manifest, ManifestStore } from '@contentauth/c2pa-types';
 import { AssetTooLargeError, UnsupportedFormatError } from './error.js';
 import { isSupportedReaderFormat } from './supportedFormats.js';
 import type { WorkerManager } from './worker/workerManager.js';
@@ -32,15 +33,29 @@ export interface ReaderFactory {
 }
 
 export interface Reader {
+  /**
+   * @returns The label of the active manifest.
+   */
+  activeLabel: () => Promise<string | null>;
+
   /**
    * @returns The asset's full manifest store containing all its manifests, validation statuses, and the URI of the active manifest.
+   *
+   * NOTE: At the moment, the manifest store returned by this method will not include decoded CAWG data. Use Reader.json() if CAWG is a requirement.
    */
-  manifestStore: () => Promise<any>;
+  manifestStore: () => Promise<ManifestStore>;
 
   /**
-   * @returns The label of the active manifest.
+   * @returns The asset's active manifest.
+   *
+   * NOTE: At the moment, the manifest returned by this method will not include decoded CAWG data. Use Reader.json() if CAWG is a requirement.
    */
-  activeLabel: () => Promise<string | null>;
+  activeManifest: () => Promise<Manifest>;
+
+  /**
+   * @returns The asset's full manifest store, including decoded CAWG data.
+   */
+  json: () => Promise<any>;
 
   /**
    * Resolves a URI reference to a binary object (e.g. a thumbnail) in the resource store.
@@ -121,21 +136,35 @@ function createReader(
   onFree: () => void
 ): Reader {
   return {
-    // TODO: manifest type
-    async manifestStore(): Promise<any> {
-      const json = await worker.execute({ method: 'reader_json', args: [id] });
-
-      const manifestStore = JSON.parse(json);
-
-      return manifestStore;
-    },
     async activeLabel(): Promise<string | null> {
       const label = await worker.execute({
         method: 'reader_activeLabel',
         args: [id],
       });
       return label;
     },
+    async manifestStore(): Promise<ManifestStore> {
+      const manifestStore = await worker.execute({
+        method: 'reader_manifestStore',
+        args: [id],
+      });
+      return manifestStore;
+    },
+    async activeManifest(): Promise<Manifest> {
+      const activeManifest = await worker.execute({
+        method: 'reader_activeManifest',
+        args: [id],
+      });
+
+      return activeManifest;
+    },
+    async json(): Promise<any> {
+      const json = await worker.execute({ method: 'reader_json', args: [id] });
+
+      const manifestStore = JSON.parse(json);
+
+      return manifestStore;
+    },
     async resourceToBuffer(uri: string): Promise<ArrayBuffer> {
       return worker.execute({
         method: 'reader_resourceToBuffer',

packages/c2pa-web/src/lib/worker.ts

@@ -49,14 +49,22 @@ const workerFunctions = {
   },
 
   // Reader object methods
-  reader_json(readerId: number): WorkerResponse<string> {
-    const reader = readerMap.get(readerId);
-    return { data: reader.json() };
-  },
   reader_activeLabel(readerId: number): WorkerResponse<string | null> {
     const reader = readerMap.get(readerId);
     return { data: reader.activeLabel() ?? null };
   },
+  reader_manifestStore(readerId: number): WorkerResponse<any> {
+    const reader = readerMap.get(readerId);
+    return { data: reader.manifestStore() };
+  },
+  reader_activeManifest(readerId: number): WorkerResponse<any> {
+    const reader = readerMap.get(readerId);
+    return { data: reader.activeManifest() };
+  },
+  reader_json(readerId: number): WorkerResponse<string> {
+    const reader = readerMap.get(readerId);
+    return { data: reader.json() };
+  },
   reader_resourceToBuffer(
     readerId: number,
     uri: string