@contentauth/c2pa-web 0.2.1 → 0.2.2

package/README.md

@@ -12,14 +12,55 @@ npm install @contentauth/c2pa-web
 
 ## Quickstart
 
+### Importing
+
+Due to [specific requirements](https://developer.mozilla.org/en-US/docs/WebAssembly/Guides/Loading_and_running) around handling WASM modules, there are two methods of importing the library. One optimizes for performance, the other for convenience.
+
+#### With a separate WASM binary (performance)
+
+The recommended method of using the library requires that the WASM binary be hosted separately, to be fetched over the network at runtime.
+
+With Vite:
+
+```typescript
+import { createC2pa } from '@contentauth/c2pa-web';
+
+import wasmSrc from '@contentauth/c2pa-web/resources/c2pa.wasm?url';
+
+const c2pa = createC2pa({ wasmSrc });
+```
+
+Use a solution appropriate to your tooling. Alternatively, the binary can be requested from a CDN:
+
+```typescript
+import { createC2pa } from '@contentauth/c2pa-web';
+
+// Ensure that [PACKAGE VERSION] matches the currently-installed version of @contentauth/c2pa-web.
+const c2pa = await createC2pa({
+  wasmSrc:
+    'https://cdn.jsdelivr.net/npm/@contentauth/c2pa-web@[PACKAGE VERSION]/dist/resources/c2pa_bg.wasm',
+});
+```
+
+#### With an inlined WASM binary (convenience)
+
+In environments where it is not possible or not convenient to request a separate resource over the network, the "inline" SDK can be used. The WASM binary is encoded as a base64 string and included in the JavaScript file, so no (additional) network request is necessary. However, this adds _significant_ size to the JavaScript bundle, and cannot take advantage of the higher-performance
+[`WebAssembly.compileStreaming()`](https://developer.mozilla.org/en-US/docs/WebAssembly/Reference/JavaScript_interface/compileStreaming_static) API.
+
 ```typescript
-import { createC2pa } from "@contentauth/c2pa-web";
+import { createC2pa } from '@contentauth/c2pa-web/inline';
+
+const c2pa = await createC2pa();
+```
+
+### Use
 
-// Using vite's ?url query parameter - use a solution appropriate to your tooling. 
-// This resolves to a WASM binary that must be available for the library to fetch at runtime.
-import wasmSrc from "@contentauth/c2pa-web/resources/c2pa.wasm?url";
+Fetch an image and provide it to the `Reader`:
 
-const response = await fetch("https://spec.c2pa.org/public-testfiles/image/jpeg/adobe-20220124-C.jpg");
+```typescript
+const response = await fetch(
+  'https://spec.c2pa.org/public-testfiles/image/jpeg/adobe-20220124-C.jpg'
+);
 const blob = await response.blob();
 
 const reader = await c2pa.reader.fromBlob(blob.type, blob);
@@ -31,15 +72,16 @@ console.log(manifestStore);
 
 ## Development
 
-### Prerequsities 
+### Prerequsities
 
-Ensure the repo-wide prerequisites [NX](https://nx.dev/getting-started/intro) and [pnpm](https://pnpm.io/) are installed. 
+Ensure the repo-wide prerequisites [NX](https://nx.dev/getting-started/intro) and [pnpm](https://pnpm.io/) are installed.
 
 [`c2pa-wasm`'s prerequisites](https://github.com/contentauth/c2pa-js-v2/tree/main/packages/c2pa-wasm) must also be installed.
 
 ### Building
 
 To build the library:
+
 ```sh
 nx build c2pa-web
 ```
@@ -47,11 +89,13 @@ nx build c2pa-web
 ### Testing
 
 This library relies on [Vitest](https://vitest.dev/) to run its tests in a headless browser. Before the tests can be run, the test browser binaries must be installed:
+
 ```sh
 pnpx playwright install
 ```
 
 To run the tests:
+
 ```
 nx test c2pa-web
 ```

package/dist/common.d.ts

@@ -0,0 +1,14 @@
+/**
+ * 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 type * from './lib/c2pa.js';
+export type { Reader, ReaderFactory } from './lib/reader.js';
+export { isSupportedReaderFormat, READER_SUPPORTED_FORMATS, } from './lib/supportedFormats.js';
+export type { Settings, VerifySettings, TrustSettings, } from './lib/settings.js';
+export type * from '@contentauth/c2pa-types';
+//# sourceMappingURL=common.d.ts.map

package/dist/common.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../src/common.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,mBAAmB,eAAe,CAAC;AAEnC,YAAY,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAE7D,OAAO,EACL,uBAAuB,EACvB,wBAAwB,GACzB,MAAM,2BAA2B,CAAC;AAEnC,YAAY,EACV,QAAQ,EACR,cAAc,EACd,aAAa,GACd,MAAM,mBAAmB,CAAC;AAG3B,mBAAmB,yBAAyB,CAAC"}

package/dist/index.d.ts

@@ -6,9 +6,6 @@
  * accordance with the terms of the Adobe license agreement accompanying
  * it.
  */
-export * from './lib/c2pa.js';
-export type { Reader, ReaderFactory } from './lib/reader.js';
-export { isSupportedReaderFormat, READER_SUPPORTED_FORMATS, } from './lib/supportedFormats.js';
-export type { Settings, VerifySettings, TrustSettings } from './lib/settings.js';
-export type * from '@contentauth/c2pa-types';
+export { createC2pa } from './lib/c2pa.js';
+export * from './common.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,cAAc,eAAe,CAAC;AAE9B,YAAY,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAE7D,OAAO,EACL,uBAAuB,EACvB,wBAAwB,GACzB,MAAM,2BAA2B,CAAC;AAEnC,YAAY,EAAE,QAAQ,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAGjF,mBAAmB,yBAAyB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAE3C,cAAc,aAAa,CAAC"}

package/dist/inline.d.ts

@@ -0,0 +1,20 @@
+import { Config } from './lib/c2pa.js';
+export type InlineConfig = Omit<Config, 'wasmSrc'>;
+/**
+ * Creates a new instance of c2pa-web by setting up a web worker and preparing a WASM binary.
+ *
+ * This is the "inline" version which compiles the WASM binary from an inlined, base64-encoded string.
+ *
+ * @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();
+ *
+ * const reader = await c2pa.reader.fromBlob(imageBlob.type, imageBlob);
+ * ```
+ */
+export declare function createC2pa(config?: InlineConfig): Promise<import('./common.js').C2paSdk>;
+export * from './common.js';
+//# sourceMappingURL=inline.d.ts.map

package/dist/inline.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"inline.d.ts","sourceRoot":"","sources":["../src/inline.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,EAAgC,MAAM,EAAE,MAAM,eAAe,CAAC;AAGrE,MAAM,MAAM,YAAY,GAAG,IAAI,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;AAEnD;;;;;;;;;;;;;;GAcG;AACH,wBAAsB,UAAU,CAAC,MAAM,CAAC,EAAE,YAAY,0CAOrD;AAED,cAAc,aAAa,CAAC"}