@contentauth/c2pa-web 0.1.1 → 0.2.0

package/src/lib/c2pa.ts

@@ -1,65 +0,0 @@
-/**
- * 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 { createWorkerManager } from './worker/workerManager.js';
-import { createReaderFactory, ReaderFactory } from './reader.js';
-import { WASM_SRI } from '@contentauth/c2pa-wasm';
-import { Settings, settingsToWasmJson } from './settings.js';
-
-export interface Config {
-  /**
-   * URL to fetch the WASM binary or an already-instantiated WASM module.
-   */
-  wasmSrc: string | WebAssembly.Module;
-
-  /**
-   * Settings for the SDK.
-   */
-  settings?: Settings;
-}
-
-interface C2paSdk {
-  reader: ReaderFactory;
-  dispose: () => void;
-}
-
-/**
- * Creates a new instance of c2pa-web by setting up a web worker and preparing a WASM binary.
- *
- * @param config - SDK configuration object.
- * @returns An object providing access to factory methods for creating new reader objects.
- *
- * @example Creating a new SDK instance and reader:
- * ```
- * const c2pa = await createC2pa({ wasmSrc: 'url/hosting/wasm/binary' });
- *
- * const reader = await c2pa.reader.fromBlob(imageBlob.type, imageBlob);
- * ```
- */
-export async function createC2pa(config: Config): Promise<C2paSdk> {
-  const { wasmSrc, settings } = config;
-
-  const wasm =
-    typeof wasmSrc === 'string' ? await fetchAndCompileWasm(wasmSrc) : wasmSrc;
-
-  const settingsString = settings ? settingsToWasmJson(settings) : undefined;
-
-  const worker = await createWorkerManager({ wasm, settingsString });
-
-  return {
-    reader: createReaderFactory(worker),
-    dispose: worker.terminate,
-  };
-}
-
-async function fetchAndCompileWasm(src: string) {
-  const response = await fetch(src, { integrity: WASM_SRI });
-  const wasm = await WebAssembly.compileStreaming(response);
-
-  return wasm;
-}

package/src/lib/error.ts

@@ -1,26 +0,0 @@
-/**
- * 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 { MAX_SIZE_IN_BYTES } from './reader.js';
-
-export class AssetTooLargeError extends Error {
-  constructor(size: number) {
-    super(
-      `The provided asset was too large. Size: ${size} bytes. Maximum: ${MAX_SIZE_IN_BYTES}.`
-    );
-    this.name = 'AssetTooLargeError';
-  }
-}
-
-export class UnsupportedFormatError extends Error {
-  constructor(format: string) {
-    super(`Unsupported format: ${format}.`);
-    this.name = 'UnsupportedFormatError';
-  }
-}

package/src/lib/reader.ts

@@ -1,150 +0,0 @@
-/**
- * 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 { AssetTooLargeError, UnsupportedFormatError } from './error.js';
-import { isSupportedReaderFormat } from './supportedFormats.js';
-import type { WorkerManager } from './worker/workerManager.js';
-
-// 1 GB
-export const MAX_SIZE_IN_BYTES = 10 ** 9;
-
-export interface ReaderFactory {
-  /**
-   * Create a Reader from an asset's format and a blob of its bytes.
-   *
-   * @param format Asset format
-   * @param blob Blob of asset bytes
-   * @returns An object that provides methods for reading C2PA data from the provided asset.
-   */
-  fromBlob: (format: string, blob: Blob) => Promise<Reader>;
-
-  fromBlobFragment: (
-    format: string,
-    init: Blob,
-    fragment: Blob
-  ) => Promise<Reader>;
-}
-
-export interface Reader {
-  /**
-   * @returns The asset's full manifest store containing all its manifests, validation statuses, and the URI of the active manifest.
-   */
-  manifestStore: () => Promise<any>;
-
-  /**
-   * @returns The label of the active manifest.
-   */
-  activeLabel: () => Promise<string | null>;
-
-  /**
-   * Resolves a URI reference to a binary object (e.g. a thumbnail) in the resource store.
-   *
-   * @param uri URI of the binary object to resolve.
-   * @returns An array buffer of the resource's bytes.
-   */
-  resourceToBuffer: (uri: string) => Promise<ArrayBuffer>;
-
-  /**
-   * Dispose of this Reader, freeing the memory it occupied and preventing further use. Call this whenever the Reader is no longer needed.
-   */
-  free: () => Promise<void>;
-}
-
-/**
- *
- * @param worker - Worker (via WorkerManager) to be associated with this reader factory
- * @returns Object containing reader creation methods
- */
-export function createReaderFactory(worker: WorkerManager): ReaderFactory {
-  const registry = new FinalizationRegistry<number>((id) => {
-    worker.execute({ method: 'reader_free', args: [id] });
-  });
-
-  return {
-    async fromBlob(format: string, blob: Blob): Promise<Reader> {
-      if (!isSupportedReaderFormat(format)) {
-        throw new UnsupportedFormatError(format);
-      }
-
-      if (blob.size > MAX_SIZE_IN_BYTES) {
-        throw new AssetTooLargeError(blob.size);
-      }
-
-      const readerId = await worker.execute({
-        method: 'reader_fromBlob',
-        args: [format, blob],
-      });
-
-      const unregisterToken = Symbol(readerId);
-      const reader = createReader(worker, readerId, () => {
-        registry.unregister(unregisterToken);
-      });
-      registry.register(reader, readerId, unregisterToken);
-
-      return reader;
-    },
-
-    async fromBlobFragment(format: string, init: Blob, fragment: Blob) {
-      if (!isSupportedReaderFormat(format)) {
-        throw new UnsupportedFormatError(format);
-      }
-
-      if (init.size > MAX_SIZE_IN_BYTES) {
-        throw new AssetTooLargeError(init.size);
-      }
-
-      const readerId = await worker.execute({
-        method: 'reader_fromBlobFragment',
-        args: [format, init, fragment],
-      });
-
-      const unregisterToken = Symbol(readerId);
-      const reader = createReader(worker, readerId, () => {
-        registry.unregister(unregisterToken);
-      });
-      registry.register(reader, readerId, unregisterToken);
-
-      return reader;
-    },
-  };
-}
-
-function createReader(
-  worker: WorkerManager,
-  id: number,
-  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 resourceToBuffer(uri: string): Promise<ArrayBuffer> {
-      return worker.execute({
-        method: 'reader_resourceToBuffer',
-        args: [id, uri],
-      });
-    },
-    async free(): Promise<void> {
-      onFree();
-      return worker.execute({ method: 'reader_free', args: [id] });
-    },
-  };
-}

package/src/lib/settings.ts

@@ -1,52 +0,0 @@
-/**
- * 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.
- */
-
-export interface Settings {
-  trust?: TrustSettings;
-  verify?: VerifySettings;
-}
-
-interface TrustSettings {
-  userAnchors?: string;
-  trustAnchors?: string;
-  trustConfig?: string;
-  allowedList?: string;
-}
-
-interface VerifySettings {
-  verifyTrust?: boolean;
-}
-
-type SettingsObjectType = {
-  [k: string]: string | boolean | SettingsObjectType;
-};
-
-/**
- * Converts a settings object to a JSON string of the structure expected by c2pa-rs.
- */
-export function settingsToWasmJson(settings: Settings) {
-  return JSON.stringify(snakeCaseify(settings as SettingsObjectType));
-}
-
-function snakeCaseify(object: SettingsObjectType): SettingsObjectType {
-  const formattedObject = Object.entries(object).reduce(
-    (formattedObject, [key, val]) => {
-      formattedObject[snakeCase(key)] =
-        typeof val === 'object' ? snakeCaseify(val) : val;
-      return formattedObject;
-    },
-    {} as SettingsObjectType
-  );
-
-  return formattedObject;
-}
-
-function snakeCase(str: string): string {
-  return str.replace(/[A-Z]/g, (letter) => `_${letter.toLowerCase()}`);
-}

package/src/lib/supportedFormats.ts

@@ -1,72 +0,0 @@
-/**
- * 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.
- */
-
-export const READER_SUPPORTED_FORMATS = [
-  'jpg',
-  'video/mp4',
-  'image/heif',
-  'video/x-msvideo',
-  'pdf',
-  'image/png',
-  'application/c2pa',
-  'video/quicktime',
-  'video/avi',
-  'image/gif',
-  'application/xml',
-  'text/xml',
-  'application/xhtml+xml',
-  'tiff',
-  'audio/wave',
-  'mp4',
-  'image/avif',
-  'image/dng',
-  'png',
-  'dng',
-  'image/svg+xml',
-  'image/heic',
-  'application/mp4',
-  'image/x-nikon-nef',
-  'video/msvideo',
-  'tif',
-  'wav',
-  'xml',
-  'audio/vnd.wave',
-  'xhtml',
-  'gif',
-  'application/x-troff-msvideo',
-  'webp',
-  'heic',
-  'application/pdf',
-  'audio/mpeg',
-  'application/x-c2pa-manifest-store',
-  'jpeg',
-  'image/x-adobe-dng',
-  'audio/wav',
-  'mp3',
-  'mov',
-  'image/tiff',
-  'audio/mp4',
-  'application/svg+xml',
-  'arw',
-  'c2pa',
-  'svg',
-  'avi',
-  'audio/x-wav',
-  'm4a',
-  'image/x-sony-arw',
-  'image/jpeg',
-  'avif',
-  'image/webp',
-  'nef',
-  'heif',
-];
-
-export function isSupportedReaderFormat(format: string): boolean {
-  return READER_SUPPORTED_FORMATS.includes(format);
-}

package/src/lib/worker/setupWorker.ts

@@ -1,53 +0,0 @@
-/**
- * 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 { postError, postSuccess } from './workerResponse.js';
-
-export interface WorkerRequest<T, K> {
-  method: T;
-  args: K;
-  transfer?: Transferable[];
-}
-
-type WorkerRequestPayload = Omit<WorkerRequest<any, any>, 'transfer'>;
-
-export interface WorkerResponse<T> {
-  data: T;
-  transfer?: Transferable[];
-}
-
-export type WorkerFunctions = Record<
-  string,
-  (
-    ...args: any[]
-  ) => void | Promise<void> | WorkerResponse<any> | Promise<WorkerResponse<any>>
->;
-
-/**
- * Prepares a worker with a list of functions to expose via postMessage and an initialization function
- *
- * @param functions Map of functions keyed by name
- * @param init Initialization function to be called once when the worker is set up
- */
-export function setupWorker(functions: WorkerFunctions) {
-  onmessage = async (e: MessageEvent<WorkerRequestPayload>) => {
-    try {
-      const { args, method } = e.data;
-      const result = await functions[method](...args);
-
-      if (result?.data !== undefined) {
-        postSuccess(result.data, result.transfer);
-      } else {
-        postSuccess();
-      }
-    } catch (e) {
-      postError(e);
-    }
-  };
-}

package/src/lib/worker/workerManager.ts

@@ -1,64 +0,0 @@
-/**
- * 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 { WorkerDefinition } from '../worker.js';
-import Worker from '../worker?worker&inline';
-import { WorkerRequest, WorkerResponse } from './setupWorker.js';
-import { handleWorkerResponse } from './workerResponse.js';
-
-export interface WorkerManager {
-  execute: <T extends keyof WorkerDefinition, K extends WorkerDefinition[T]>(
-    request: WorkerRequest<T, Parameters<K>>
-  ) => Promise<
-    Awaited<ReturnType<K>> extends WorkerResponse<infer Data>
-      ? Data
-      : Awaited<ReturnType<K>>
-  >;
-  terminate: () => void;
-}
-
-export interface CreateWorkerManagerConfig {
-  wasm: WebAssembly.Module;
-  settingsString?: string;
-}
-
-/**
- * Creates a new web worker and performs initialization steps:
- * - Compile WASM
- * - Load settings (if provided)
- *
- * @param config - configuration object
- * @returns Facade providing convenient control over worker functions
- */
-export async function createWorkerManager(
-  config: CreateWorkerManagerConfig
-): Promise<WorkerManager> {
-  const { wasm, settingsString } = config;
-
-  const worker = new Worker();
-
-  const execute: WorkerManager['execute'] = (request) => {
-    return new Promise((resolve, reject) => {
-      handleWorkerResponse(worker, {
-        onSuccess: (data) => resolve(data),
-        onError: (error) => reject(error),
-      });
-
-      const { method, args, transfer } = request;
-      worker.postMessage({ method, args }, transfer ?? []);
-    });
-  };
-
-  await execute({ method: 'initWorker', args: [wasm, settingsString] });
-
-  return {
-    execute,
-    terminate: () => worker.terminate(),
-  };
-}

package/src/lib/worker/workerObjectMap.ts

@@ -1,35 +0,0 @@
-/**
- * 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.
- */
-
-export function createWorkerObjectMap<T>() {
-  let objId = 0;
-  const objectMap = new Map<number, T>();
-
-  return {
-    add(object: T): number {
-      const id = objId++;
-      objectMap.set(id, object);
-      return id;
-    },
-
-    get(id: number): T {
-      const maybeObject = objectMap.get(id);
-
-      if (!maybeObject) {
-        throw new Error('Attempted to use an object that has been freed');
-      }
-
-      return maybeObject;
-    },
-
-    remove(id: number): boolean {
-      return objectMap.delete(id);
-    },
-  };
-}

package/src/lib/worker/workerResponse.ts

@@ -1,50 +0,0 @@
-/**
- * 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.
- */
-
-export function postSuccess(payload?: any, transfer?: Transferable[]): void {
-  const responseObject = {
-    type: 'success',
-    ...(payload !== undefined ? { payload } : {}),
-  };
-
-  postMessage(responseObject, transfer ?? []);
-}
-
-export function postError(error: unknown): void {
-  postMessage({ type: 'error', error });
-}
-
-export interface ResponseHandlers {
-  onSuccess: (data?: any) => void;
-  onError: (error?: any) => void;
-}
-
-export function handleWorkerResponse(
-  worker: Worker,
-  responseHandlers: ResponseHandlers
-) {
-  worker.onmessage = (event) => {
-    const { data } = event;
-
-    if (data.type === 'success') {
-      responseHandlers.onSuccess(data?.payload);
-    } else {
-      responseHandlers.onError(data?.error);
-    }
-  };
-
-  // @TODO: should these have their own error handlers?
-  worker.onerror = (event) => {
-    responseHandlers.onError(event.error);
-  };
-
-  worker.onmessageerror = (event) => {
-    responseHandlers.onError(event.data);
-  };
-}

package/src/lib/worker.ts

@@ -1,77 +0,0 @@
-/**
- * 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.
- */
-
-/// <reference lib="webworker" />
-
-import { WasmReader, initSync, loadSettings } from '@contentauth/c2pa-wasm';
-import {
-  setupWorker,
-  WorkerFunctions,
-  WorkerResponse,
-} from './worker/setupWorker.js';
-import { createWorkerObjectMap } from './worker/workerObjectMap.js';
-
-const readerMap = createWorkerObjectMap<WasmReader>();
-
-const workerFunctions = {
-  async initWorker(module: WebAssembly.Module, settings?: string) {
-    initSync(module);
-
-    if (settings) {
-      loadSettings(settings);
-    }
-  },
-
-  // Reader creation methods
-  async reader_fromBlob(
-    format: string,
-    blob: Blob
-  ): Promise<WorkerResponse<number>> {
-    const reader = await WasmReader.fromBlob(format, blob);
-    const readerId = readerMap.add(reader);
-    return { data: readerId };
-  },
-
-  async reader_fromBlobFragment(
-    format: string,
-    init: Blob,
-    fragment: Blob
-  ): Promise<WorkerResponse<number>> {
-    const reader = await WasmReader.fromBlobFragment(format, init, fragment);
-    const readerId = readerMap.add(reader);
-    return { data: readerId };
-  },
-
-  // 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_resourceToBuffer(
-    readerId: number,
-    uri: string
-  ): WorkerResponse<ArrayBuffer> {
-    const reader = readerMap.get(readerId);
-    const buffer = reader.resourceToBuffer(uri);
-    return { data: buffer, transfer: [buffer] };
-  },
-  reader_free(readerId: number) {
-    const reader = readerMap.get(readerId);
-    reader.free();
-    readerMap.remove(readerId);
-  },
-} satisfies WorkerFunctions;
-
-export type WorkerDefinition = typeof workerFunctions;
-
-setupWorker(workerFunctions);