@contentauth/c2pa-web 0.2.0 → 0.2.2

package/dist/lib/c2pa.d.ts

@@ -10,8 +10,14 @@ export interface Config {
      */
     settings?: Settings;
 }
-interface C2paSdk {
+export interface C2paSdk {
+    /**
+     * Contains methods for creating Reader objects.
+     */
     reader: ReaderFactory;
+    /**
+     * Terminates the SDK's underlying web worker.
+     */
     dispose: () => void;
 }
 /**
@@ -28,5 +34,4 @@ interface C2paSdk {
  * ```
  */
 export declare function createC2pa(config: Config): Promise<C2paSdk>;
-export {};
 //# sourceMappingURL=c2pa.d.ts.map

package/dist/lib/c2pa.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"c2pa.d.ts","sourceRoot":"","sources":["../../src/lib/c2pa.ts"],"names":[],"mappings":"AASA,OAAO,EAAuB,aAAa,EAAE,MAAM,aAAa,CAAC;AAEjE,OAAO,EAAE,QAAQ,EAAsB,MAAM,eAAe,CAAC;AAE7D,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,OAAO,EAAE,MAAM,GAAG,WAAW,CAAC,MAAM,CAAC;IAErC;;OAEG;IACH,QAAQ,CAAC,EAAE,QAAQ,CAAC;CACrB;AAED,UAAU,OAAO;IACf,MAAM,EAAE,aAAa,CAAC;IACtB,OAAO,EAAE,MAAM,IAAI,CAAC;CACrB;AAED;;;;;;;;;;;;GAYG;AACH,wBAAsB,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAcjE"}
+{"version":3,"file":"c2pa.d.ts","sourceRoot":"","sources":["../../src/lib/c2pa.ts"],"names":[],"mappings":"AASA,OAAO,EAAuB,aAAa,EAAE,MAAM,aAAa,CAAC;AAEjE,OAAO,EAAE,QAAQ,EAAsB,MAAM,eAAe,CAAC;AAE7D,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,OAAO,EAAE,MAAM,GAAG,WAAW,CAAC,MAAM,CAAC;IAErC;;OAEG;IACH,QAAQ,CAAC,EAAE,QAAQ,CAAC;CACrB;AAED,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,MAAM,EAAE,aAAa,CAAC;IAEtB;;OAEG;IACH,OAAO,EAAE,MAAM,IAAI,CAAC;CACrB;AAED;;;;;;;;;;;;GAYG;AACH,wBAAsB,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAcjE"}

package/dist/lib/reader.d.ts

@@ -1,6 +1,9 @@
 import { Manifest, ManifestStore } from '@contentauth/c2pa-types';
 import { WorkerManager } from './worker/workerManager.js';
 export declare const MAX_SIZE_IN_BYTES: number;
+/**
+ * A collection of functions that permit the creation of Reader objects from various sources.
+ */
 export interface ReaderFactory {
     /**
      * Create a Reader from an asset's format and a blob of its bytes.
@@ -12,6 +15,16 @@ export interface ReaderFactory {
     fromBlob: (format: string, blob: Blob) => Promise<Reader>;
     fromBlobFragment: (format: string, init: Blob, fragment: Blob) => Promise<Reader>;
 }
+/**
+ * Exposes methods for reading C2PA data out of an asset.
+ *
+ * @example Getting an asset's active manifest:
+ * ```
+ * const reader = await c2pa.reader.fromBlob(blob.type, blob);
+ *
+ * const activeManifest = await reader.activeManfiest();
+ * ```
+ */
 export interface Reader {
     /**
      * @returns The label of the active manifest.
@@ -38,6 +51,15 @@ export interface Reader {
      *
      * @param uri URI of the binary object to resolve.
      * @returns An array buffer of the resource's bytes.
+     *
+     * @example Retrieving a thumbnail from the resource store:
+     * ```
+     * const reader = await c2pa.reader.fromBlob(blob.type, blob);
+     *
+     * const activeManifest = await reader.activeManifest();
+     *
+     * const thumbnailBuffer = await reader.resourceToBuffer(activeManifest.thumbnail!.identifier);
+     * ```
      */
     resourceToBuffer: (uri: string) => Promise<ArrayBuffer>;
     /**

package/dist/lib/reader.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"reader.d.ts","sourceRoot":"","sources":["../../src/lib/reader.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AAGlE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAG/D,eAAO,MAAM,iBAAiB,QAAU,CAAC;AAEzC,MAAM,WAAW,aAAa;IAC5B;;;;;;OAMG;IACH,QAAQ,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;IAE1D,gBAAgB,EAAE,CAChB,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,IAAI,EACV,QAAQ,EAAE,IAAI,KACX,OAAO,CAAC,MAAM,CAAC,CAAC;CACtB;AAED,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,WAAW,EAAE,MAAM,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;IAE1C;;;;OAIG;IACH,aAAa,EAAE,MAAM,OAAO,CAAC,aAAa,CAAC,CAAC;IAE5C;;;;OAIG;IACH,cAAc,EAAE,MAAM,OAAO,CAAC,QAAQ,CAAC,CAAC;IAExC;;OAEG;IACH,IAAI,EAAE,MAAM,OAAO,CAAC,GAAG,CAAC,CAAC;IAEzB;;;;;OAKG;IACH,gBAAgB,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,CAAC,WAAW,CAAC,CAAC;IAExD;;OAEG;IACH,IAAI,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;CAC3B;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,aAAa,GAAG,aAAa,CAoDxE"}
+{"version":3,"file":"reader.d.ts","sourceRoot":"","sources":["../../src/lib/reader.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AAGlE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAG/D,eAAO,MAAM,iBAAiB,QAAU,CAAC;AAEzC;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;;;;;OAMG;IACH,QAAQ,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;IAE1D,gBAAgB,EAAE,CAChB,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,IAAI,EACV,QAAQ,EAAE,IAAI,KACX,OAAO,CAAC,MAAM,CAAC,CAAC;CACtB;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,WAAW,EAAE,MAAM,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;IAE1C;;;;OAIG;IACH,aAAa,EAAE,MAAM,OAAO,CAAC,aAAa,CAAC,CAAC;IAE5C;;;;OAIG;IACH,cAAc,EAAE,MAAM,OAAO,CAAC,QAAQ,CAAC,CAAC;IAExC;;OAEG;IACH,IAAI,EAAE,MAAM,OAAO,CAAC,GAAG,CAAC,CAAC;IAEzB;;;;;;;;;;;;;;OAcG;IACH,gBAAgB,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,CAAC,WAAW,CAAC,CAAC;IAExD;;OAEG;IACH,IAAI,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;CAC3B;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,aAAa,GAAG,aAAa,CAoDxE"}

package/dist/lib/settings.d.ts

@@ -6,23 +6,46 @@
  * accordance with the terms of the Adobe license agreement accompanying
  * it.
  */
+/**
+ * Settings used to configure the SDK's behavior.
+ */
 export interface Settings {
+    /**
+     * Trust configuration for C2PA claim validation.
+     */
     trust?: TrustSettings;
+    /**
+     * Trust configuration for CAWG identity valdation.
+     */
     cawgTrust?: TrustSettings;
     verify?: VerifySettings;
 }
-interface TrustSettings {
+export interface TrustSettings {
+    /**
+     * "User" trust anchors. Any asset validated off of this trust list will will have a "signingCredential.trusted" result with an explanation noting the trust source is a "User" anchor.
+     */
     userAnchors?: string;
+    /**
+     * "System" trust anchors. Any asset validated off of this trust list will will have a "signingCredential.trusted" result with an explanation noting the trust source is a "System" anchor.
+     */
     trustAnchors?: string;
+    /**
+     * Trust store
+     */
     trustConfig?: string;
+    /**
+     * End-entity certificates.
+     */
     allowedList?: string;
 }
-interface VerifySettings {
+export interface VerifySettings {
+    /**
+     * Enable trust list validation.
+     */
     verifyTrust?: boolean;
 }
 /**
  * Converts a settings object to a JSON string of the structure expected by c2pa-rs.
  */
 export declare function settingsToWasmJson(settings: Settings): string;
-export {};
 //# sourceMappingURL=settings.d.ts.map

package/dist/lib/settings.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"settings.d.ts","sourceRoot":"","sources":["../../src/lib/settings.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,MAAM,WAAW,QAAQ;IACvB,KAAK,CAAC,EAAE,aAAa,CAAC;IACtB,SAAS,CAAC,EAAE,aAAa,CAAC;IAC1B,MAAM,CAAC,EAAE,cAAc,CAAC;CACzB;AAED,UAAU,aAAa;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,UAAU,cAAc;IACtB,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB;AAMD;;GAEG;AACH,wBAAgB,kBAAkB,CAAC,QAAQ,EAAE,QAAQ,UAEpD"}
+{"version":3,"file":"settings.d.ts","sourceRoot":"","sources":["../../src/lib/settings.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,KAAK,CAAC,EAAE,aAAa,CAAC;IACtB;;OAEG;IACH,SAAS,CAAC,EAAE,aAAa,CAAC;IAC1B,MAAM,CAAC,EAAE,cAAc,CAAC;CACzB;AAED,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB;AAMD;;GAEG;AACH,wBAAgB,kBAAkB,CAAC,QAAQ,EAAE,QAAQ,UAEpD"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentauth/c2pa-web",
-  "version": "0.2.0",
+  "version": "0.2.2",
   "license": "MIT",
   "type": "module",
   "module": "./dist/index.js",
@@ -15,17 +15,25 @@
       "types": "./dist/index.d.ts",
       "import": "./dist/index.js",
       "default": "./dist/index.js"
+    },
+    "./inline": {
+      "types": "./dist/inline.d.ts",
+      "import": "./dist/inline.js",
+      "default": "./dist/inline.js"
     }
   },
   "dependencies": {
-    "@contentauth/c2pa-wasm": "0.2.0",
-    "@contentauth/c2pa-types": "0.2.0"
+    "@contentauth/c2pa-types": "0.2.1",
+    "@contentauth/c2pa-wasm": "0.2.1"
   },
   "devDependencies": {
     "@playwright/test": "^1.55.0",
     "@types/ssri": "^7.1.5",
     "@vitest/browser": "^3.2.4",
+    "typedoc": "^0.28.12",
     "rimraf": "^6.0.1"
   },
-  "scripts": {}
+  "scripts": {
+    "build:docs": "typedoc src/index.ts src/inline.ts"
+  }
 }