From 7b4735a7ab0847b2761cc35ae224d05e4d7811f7 Mon Sep 17 00:00:00 2001 From: Rand McKinney Date: Wed, 8 Nov 2023 15:46:16 -0800 Subject: [PATCH 01/11] Update README.md --- README.md | 68 +++++++++++++++++++++++++++++++++++++++++++------------ 1 file changed, 53 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 0520496..9ad54d1 100644 --- a/README.md +++ b/README.md @@ -1,36 +1,74 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [c2pa-node](#c2pa-node) + - [Installing c2pa-node](#installing-c2pa-node) + - [Installing for usage in a client app](#installing-for-usage-in-a-client-app) + - [Building custom binaries](#building-custom-binaries) + - [Installing for development / contributions](#installing-for-development--contributions) + - [Quick start](#quick-start) + - [Creating a `c2pa` object](#creating-a-c2pa-object) + - [Reading a manifest](#reading-a-manifest) + - [Creating a manifest](#creating-a-manifest) + - [Adding an ingredient](#adding-an-ingredient) + - [Signing a manifest](#signing-a-manifest) + - [Signing buffers](#signing-buffers) + - [Signing files](#signing-files) + - [Local signing](#local-signing) + - [Remote signing](#remote-signing) + - [API documentation](#api-documentation) + - [Testing](#testing) + + + # c2pa-node -**c2pa-node:** Node.js bindings for C2PA +This library implements a Node.js API that: +- Read and validate C2PA data from media files in [supported formats](https://opensource.contentauthenticity.org/docs/rust-sdk/#supported-file-formats). +- Add signed manifests to media files in [supported formats](https://opensource.contentauthenticity.org/docs/rust-sdk/#supported-file-formats). + +**WARNING**: This is an early prerelease version of this library. There may be bugs and unimplemented features, and the API is subject to change. + +## Installation + +### Prerequisites -## Installing c2pa-node +You must install: +- A [supported version of Node](https://github.com/neon-bindings/neon#platform-support). +- [Rust](https://www.rust-lang.org/tools/install) -Installing c2pa-node requires a [supported version of Node and Rust](https://github.com/neon-bindings/neon#platform-support). -[nvm](https://github.com/nvm-sh/nvm) is a good tool for managing multiple versions of Node on your machine, and you can install -Rust by [visiting this link](https://www.rust-lang.org/tools/install). +Use a tool such as [nvm](https://github.com/nvm-sh/nvm) if you need to manage multiple versions of Node on your machine. ### Installing for usage in a client app +Using npm: + ```sh -# npm $ npm install c2pa-node -# yarn +``` + +Using Yarn: + +```sh $ yarn add c2pa-node -# pnpm +``` + +Using pnpm: + +```sh $ pnpm add c2pa-node ``` -This will pull down the latest Rust SDK and build it as a binding locally, hence the need for Rust to be locally installed. +This downloads the latest Rust SDK and builds it as a binding locally (which is why Rust must be locally installed). -**Note:** We will be working on creating binary releases so that you will not need Rust installed on your machine in the future. +**Note**: In the future, CAI may create binary releases so you won't need to install Rust on your machine. -#### Building custom binaries +### Building custom binaries -You may need to build custom binaries for platforms or architectures that do not have Rust tooling installed. You can -prebuild a binary on the platform or architecture you would like to run on. To do this, you can run the following -on the system or VM you want to build the binary for (this needs to have the [Rust toolchain installed](https://www.rust-lang.org/tools/install)): +For platforms or architectures that do not have Rust tooling installed, you may need to build custom binaries. To pre-build a binary, [install the Rust toolchain](https://www.rust-lang.org/tools/install) and then run the following commands on the target system or VM: ```sh -# in c2pa-node $ cd c2pa-node $ pnpm install $ pnpm build:rust From 047384c6f0452ce9fd46e4880b926925a29baa06 Mon Sep 17 00:00:00 2001 From: Rand McKinney Date: Wed, 8 Nov 2023 15:46:57 -0800 Subject: [PATCH 02/11] Update README.md --- README.md | 33 ++++++++++++++++----------------- 1 file changed, 16 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 9ad54d1..c87649f 100644 --- a/README.md +++ b/README.md @@ -2,23 +2,22 @@ **Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* -- [c2pa-node](#c2pa-node) - - [Installing c2pa-node](#installing-c2pa-node) - - [Installing for usage in a client app](#installing-for-usage-in-a-client-app) - - [Building custom binaries](#building-custom-binaries) - - [Installing for development / contributions](#installing-for-development--contributions) - - [Quick start](#quick-start) - - [Creating a `c2pa` object](#creating-a-c2pa-object) - - [Reading a manifest](#reading-a-manifest) - - [Creating a manifest](#creating-a-manifest) - - [Adding an ingredient](#adding-an-ingredient) - - [Signing a manifest](#signing-a-manifest) - - [Signing buffers](#signing-buffers) - - [Signing files](#signing-files) - - [Local signing](#local-signing) - - [Remote signing](#remote-signing) - - [API documentation](#api-documentation) - - [Testing](#testing) +- [Installing c2pa-node](#installing-c2pa-node) + - [Installing for usage in a client app](#installing-for-usage-in-a-client-app) + - [Building custom binaries](#building-custom-binaries) + - [Installing for development / contributions](#installing-for-development--contributions) +- [Quick start](#quick-start) + - [Creating a `c2pa` object](#creating-a-c2pa-object) + - [Reading a manifest](#reading-a-manifest) + - [Creating a manifest](#creating-a-manifest) + - [Adding an ingredient](#adding-an-ingredient) + - [Signing a manifest](#signing-a-manifest) + - [Signing buffers](#signing-buffers) + - [Signing files](#signing-files) + - [Local signing](#local-signing) + - [Remote signing](#remote-signing) +- [API documentation](#api-documentation) +- [Testing](#testing) From d85ea4a311c95af26908e7b1f943ec55f8d429ac Mon Sep 17 00:00:00 2001 From: Rand McKinney Date: Mon, 13 Nov 2023 14:08:51 -0800 Subject: [PATCH 03/11] Initial README edit --- README.md | 79 ++++---- docs/README.md | 520 +++++++++++++++++++------------------------------ 2 files changed, 238 insertions(+), 361 deletions(-) diff --git a/README.md b/README.md index c87649f..f541c50 100644 --- a/README.md +++ b/README.md @@ -1,33 +1,26 @@ - - +# c2pa-node + +This library implements a Node.js API that can: +- Read and validate C2PA data from media files in [supported formats](https://opensource.contentauthenticity.org/docs/rust-sdk/#supported-file-formats). +- Add signed manifests to media files in [supported formats](https://opensource.contentauthenticity.org/docs/rust-sdk/#supported-file-formats). + +**WARNING**: This is an early prerelease version of this library. There may be bugs and unimplemented features, and the API is subject to change. + +
**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* -- [Installing c2pa-node](#installing-c2pa-node) - - [Installing for usage in a client app](#installing-for-usage-in-a-client-app) - - [Building custom binaries](#building-custom-binaries) - - [Installing for development / contributions](#installing-for-development--contributions) -- [Quick start](#quick-start) +- [Installation](#installation) + - [Installing for use in a client app](#installing-for-use-in-a-client-app) + - [Installing for project contributions](#installing-for-project-contributions) +- [Usage](#usage) - [Creating a `c2pa` object](#creating-a-c2pa-object) - [Reading a manifest](#reading-a-manifest) - [Creating a manifest](#creating-a-manifest) - [Adding an ingredient](#adding-an-ingredient) - [Signing a manifest](#signing-a-manifest) - - [Signing buffers](#signing-buffers) - - [Signing files](#signing-files) - - [Local signing](#local-signing) - - [Remote signing](#remote-signing) - [API documentation](#api-documentation) - [Testing](#testing) - - - -# c2pa-node - -This library implements a Node.js API that: -- Read and validate C2PA data from media files in [supported formats](https://opensource.contentauthenticity.org/docs/rust-sdk/#supported-file-formats). -- Add signed manifests to media files in [supported formats](https://opensource.contentauthenticity.org/docs/rust-sdk/#supported-file-formats). - -**WARNING**: This is an early prerelease version of this library. There may be bugs and unimplemented features, and the API is subject to change. +
## Installation @@ -37,9 +30,9 @@ You must install: - A [supported version of Node](https://github.com/neon-bindings/neon#platform-support). - [Rust](https://www.rust-lang.org/tools/install) -Use a tool such as [nvm](https://github.com/nvm-sh/nvm) if you need to manage multiple versions of Node on your machine. +If you need to manage multiple versions of Node on your machine, use a tool such as [nvm](https://github.com/nvm-sh/nvm). -### Installing for usage in a client app +### Installing for use in a client app Using npm: @@ -76,7 +69,7 @@ $ pnpm build:rust Then, you can copy the binary to a place that is accessible by your application (in this example, it is `/path/to/my/application/resources`) and set the path to the `c2pa.node` module via the `C2PA_LIBRARY_PATH` environment variable: ```sh -# in your application using c2pa-node +# In your application that uses c2pa-node $ cd /path/to/my/application $ mkdir resources $ cp /path/to/c2pa-node/generated/c2pa.node resources/c2pa.node @@ -85,11 +78,11 @@ $ npm install c2pa-node $ npm start ``` -**Important:** `C2PA_LIBRARY_PATH` _must_ be set while both **installing** or **adding** c2pa-node to your app to avoid building the Rust code. It is _also_ required to be set while **running** your app so that it loads the bindings from the correct location. +**Important:** `C2PA_LIBRARY_PATH` _must_ be set while both **installing** or **adding** c2pa-node to your app to avoid building the Rust code. It must _also_ be set while **running** your app so that it loads the bindings from the correct location. -### Installing for development / contributions +### Installing for project contributions -You can install the project with npm. In the project directory, run: +If you want to contribute to this project, install the project with npm. In the project directory, run: ```sh # Switch to the supported version of Node.js for building @@ -102,11 +95,11 @@ $ pnpm install $ pnpm run build ``` -## Quick start +## Usage ### Creating a `c2pa` object -You will need to instantiate a `c2pa` object by using [`createC2pa()`](docs/modules.md#createc2pa): +Instantiate a `c2pa` object by using [`createC2pa()`](https://github.com/contentauth/c2pa-node/blob/main/docs/modules.md#createc2pa): ```ts import { createC2pa } from 'c2pa-node'; @@ -116,7 +109,7 @@ const c2pa = createC2pa(); ### Reading a manifest -You can read a manifest by using the `c2pa.read()` function: +Read a manifest by using the `c2pa.read()` function; for example: ```ts import { createC2pa } from 'c2pa-node'; @@ -141,7 +134,7 @@ read('my-c2pa-file.jpg', 'image/jpeg'); ### Creating a manifest -To create a manifest, you can pass in the claim information to a [`ManifestBuilder`](docs/classes//ManifestBuilder.md). +To create a manifest, pass the claim information to the [`ManifestBuilder`](https://github.com/contentauth/c2pa-node/blob/main/docs/classes/ManifestBuilder.md) object constructor; for example: ```ts import { ManifestBuilder } from 'c2pa-node'; @@ -174,8 +167,7 @@ const manifest = new ManifestBuilder({ ### Adding an ingredient -You can use `c2pa.createIngredient()` to load ingredient data for inclusion into a manifest. This can be stored on a backend -if necessary and loaded in at signing time without the need for the original ingredient if it is no longer available. +Use `c2pa.createIngredient()` to load ingredient data for inclusion into a manifest. This can be stored on a backend if necessary and loaded at signing time without the need for the original ingredient if it is no longer available. ```ts // Create the ingredient asset from a buffer @@ -183,7 +175,7 @@ const ingredientAssetFromBuffer = { buffer: await readFile('my-ingredient.jpg'), mimeType: 'image/jpeg', }; -// or from a file +// Or load from a file const ingredientAssetFromFile = { path: resolve('my-ingredient.jpg'), }; @@ -199,15 +191,13 @@ manifest.addIngredient(ingredient); ### Signing a manifest -You can use the `c2pa.sign()` method to sign an ingredient, either locally if you have a signing certificate and key -available, or by using a remote signing API. +Use the `c2pa.sign()` method to sign an ingredient, either locally if you have a signing certificate and key available, or by using a remote signing API. #### Signing buffers -If you have file data loaded into memory, you can sign them using a buffer. +If you have an asset file's data loaded into memory, you can sign the the asset using a buffer. -**Note:** This is currently only supported for `image/jpeg` and `image/png` data. All other file types should use -the file-based approach below. +**NOTE**: Signing using a buffer is currently supported only for `image/jpeg` and `image/png` data. For all other file types, use the file-based approach below. ```ts import { readFile } from 'node:fs/promises'; @@ -232,8 +222,7 @@ sign(asset, manifest); #### Signing files -You can pass in a file path to be signed to avoid loading entire assets into memory, or if a certain file type doesn't -have in-memory support. +To avoid loading the entire asset into memory (or for file types other than JPEG and PNG that don't support in-memory signing), pass in the file path to the asset file to sign it; for example: ```ts import { resolve } from 'node:path'; @@ -263,7 +252,7 @@ sign(asset, manifest); #### Local signing -If you have a signing certificate and key, you can sign locally using a local signer: +If you have a signing certificate and key, you can sign locally using a local signer; for example: ```ts import { readFile } from 'node:fs/promises'; @@ -303,7 +292,7 @@ sign(asset, manifest); #### Remote signing -If you have a service that you want to use for signing, you can use that to sign remotely: +If you have access to a web service that performs signing, you can use it to sign remotely; for example: ```ts import { readFile } from 'node:fs/promises'; @@ -352,11 +341,11 @@ sign(asset, manifest); ## API documentation -[Click here](docs/modules.md) to view the API documentation. +For the API documentation, see [`/docs/` directory](https://github.com/contentauth/c2pa-node/blob/main/docs/README.md). ## Testing -After installation, you can run the test suite by running: +After installation, run the test suite by entering this command: ```sh $ pnpm test diff --git a/docs/README.md b/docs/README.md index cdb627b..1ff61f8 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,328 +1,216 @@ -c2pa-node / [Exports](modules.md) +# API documentation for c2pa-node -# c2pa-node +
+For installation and usage information, see the main [README](../README.md). +
-**c2pa-node:** Node.js bindings for C2PA +**Namespaces**: -## Installing c2pa-node +- [types](modules/types.md) -Installing c2pa-node requires a [supported version of Node and Rust](https://github.com/neon-bindings/neon#platform-support). -[nvm](https://github.com/nvm-sh/nvm) is a good tool for managing multiple versions of Node on your machine, and you can install -Rust by [visiting this link](https://www.rust-lang.org/tools/install). +**Enumerations**: -### Installing for usage in a client app +- [SigningAlgorithm](enums/SigningAlgorithm.md) -```sh -# npm -$ npm install c2pa-node -# yarn -$ yarn add c2pa-node -# pnpm -$ pnpm add c2pa-node -``` +**Classes**: -This will pull down the latest Rust SDK and build it as a binding locally, hence the need for Rust to be locally installed. +- [ManifestBuilder](classes/ManifestBuilder.md) -**Note:** We will be working on creating binary releases so that you will not need Rust installed on your machine in the future. +**Interfaces**: -#### Building custom binaries +- [BufferAsset](interfaces/BufferAsset.md) +- [CreateIngredientProps](interfaces/CreateIngredientProps.md) +- [FileAsset](interfaces/FileAsset.md) +- [LocalSigner](interfaces/LocalSigner.md) +- [RemoteSigner](interfaces/RemoteSigner.md) +- [ResolvedIngredient](interfaces/ResolvedIngredient.md) +- [ResolvedManifest](interfaces/ResolvedManifest.md) +- [ResolvedManifestStore](interfaces/ResolvedManifestStore.md) +- [ResolvedResource](interfaces/ResolvedResource.md) +- [ResolvedSignatureInfo](interfaces/ResolvedSignatureInfo.md) +- [SignClaimBytesProps](interfaces/SignClaimBytesProps.md) +- [SignInput](interfaces/SignInput.md) +- [SignOptions](interfaces/SignOptions.md) +- [StorableIngredient](interfaces/StorableIngredient.md) +- [ThumbnailOptions](interfaces/ThumbnailOptions.md) -You may need to build custom binaries for platforms or architectures that do not have Rust tooling installed. You can -prebuild a binary on the platform or architecture you would like to run on. To do this, you can run the following -on the system or VM you want to build the binary for (this needs to have the [Rust toolchain installed](https://www.rust-lang.org/tools/install)): +**Type Aliases**: -```sh -# in c2pa-node -$ cd c2pa-node -$ pnpm install -$ pnpm build:rust -``` - -Then, you can copy the binary to a place that is accessible by your application (in this example, it is `/path/to/my/application/resources`) and set the path to the `c2pa.node` module via the `C2PA_LIBRARY_PATH` environment variable: +- [Asset](modules.md#asset) +- [BaseManifestDefinition](modules.md#basemanifestdefinition) +- [C2pa](modules.md#c2pa) +- [C2paOptions](modules.md#c2paoptions) +- [HashAlgorithm](modules.md#hashalgorithm) +- [IngredientResourceStore](modules.md#ingredientresourcestore) +- [SignOutput](modules.md#signoutput) +- [SignProps](modules.md#signprops) +- [Signer](modules.md#signer) -```sh -# in your application using c2pa-node -$ cd /path/to/my/application -$ mkdir resources -$ cp /path/to/c2pa-node/generated/c2pa.node resources/c2pa.node -$ export C2PA_LIBRARY_PATH=resources/c2pa.node -$ npm install c2pa-node -$ npm start -``` - -**Important:** `C2PA_LIBRARY_PATH` _must_ be set while both **installing** or **adding** c2pa-node to your app to avoid building the Rust code. It is _also_ required to be set while **running** your app so that it loads the bindings from the correct location. - -### Installing for development / contributions - -You can install the project with npm. In the project directory, run: - -```sh -# Switch to the supported version of Node.js for building -$ nvm use -# Install pnpm -$ npm install -g pnpm -# Install dependencies -$ pnpm install -# Build the SDK -$ pnpm run build -``` - -## Quick start - -### Creating a `c2pa` object - -You will need to instantiate a `c2pa` object by using [`createC2pa()`](docs/modules.md#createc2pa): - -```ts -import { createC2pa } from 'c2pa-node'; - -const c2pa = createC2pa(); -``` - -### Reading a manifest - -You can read a manifest by using the `c2pa.read()` function: - -```ts -import { createC2pa } from 'c2pa-node'; -import { readFile } from 'node:fs/promises'; - -const c2pa = createC2pa(); - -async function read(path, mimeType) { - const buffer = await readFile(path); - const result = await c2pa.read({ buffer }); - - if (result) { - const { active_manifest, manifests, validation_status } = result; - console.log(active_manifest); - } else { - console.log('No claim found'); - } -} - -read('my-c2pa-file.jpg', 'image/jpeg'); -``` - -### Creating a manifest - -To create a manifest, you can pass in the claim information to a [`ManifestBuilder`](docs/classes//ManifestBuilder.md). - -```ts -import { ManifestBuilder } from 'c2pa-node'; - -const manifest = new ManifestBuilder({ - claim_generator: 'my-app/1.0.0', - format: 'image/jpeg', - title: 'node_test_local_signer.jpg', - assertions: [ - { - label: 'c2pa.actions', - data: { - actions: [ - { - action: 'c2pa.created', - }, - ], - }, - }, - { - label: 'com.custom.my-assertion', - data: { - description: 'My custom test assertion', - version: '1.0.0', - }, - }, - ], -}); -``` - -### Adding an ingredient - -You can use `c2pa.createIngredient()` to load ingredient data for inclusion into a manifest. This can be stored on a backend -if necessary and loaded in at signing time without the need for the original ingredient if it is no longer available. - -```ts -// Create the ingredient asset from a buffer -const ingredientAssetFromBuffer = { - buffer: await readFile('my-ingredient.jpg'), - mimeType: 'image/jpeg', -}; -// or from a file -const ingredientAssetFromFile = { - path: resolve('my-ingredient.jpg'), -}; - -// Create the ingredient -const ingredient = await c2pa.createIngredient({ - asset: ingredientAssetFromBuffer, - title: 'ingredient.jpg', -}); -// Add it to the manifest -manifest.addIngredient(ingredient); -``` - -### Signing a manifest - -You can use the `c2pa.sign()` method to sign an ingredient, either locally if you have a signing certificate and key -available, or by using a remote signing API. - -#### Signing buffers - -If you have file data loaded into memory, you can sign them using a buffer. - -**Note:** This is currently only supported for `image/jpeg` and `image/png` data. All other file types should use -the file-based approach below. - -```ts -import { readFile } from 'node:fs/promises'; -import { createC2pa, createTestSigner } from 'c2pa-node'; - -async function sign(asset, manifest) { - const buffer = await readFile('to-be-signed.jpg'); - const asset: Asset = { buffer, mimeType: 'image/jpeg' }; - const signer = createTestSigner(); - const c2pa = createC2pa({ - signer, - }); - - const { signedAsset, signedManifest } = await c2pa.sign({ - asset, - manifest, - }); -} - -sign(asset, manifest); -``` - -#### Signing files - -You can pass in a file path to be signed to avoid loading entire assets into memory, or if a certain file type doesn't -have in-memory support. - -```ts -import { resolve } from 'node:path'; -import { createC2pa, createTestSigner } from 'c2pa-node'; - -async function sign(asset, manifest) { - const asset = { - path: resolve('to-be-signed.jpg'), - }; - const outputPath = resolve('signed.jpg'); - const signer = createTestSigner(); - const c2pa = createC2pa({ - signer, - }); - - const { signedAsset, signedManifest } = await c2pa.sign({ - manifest, - asset, - options: { - outputPath, - }, - }); -} - -sign(asset, manifest); -``` - -#### Local signing - -If you have a signing certificate and key, you can sign locally using a local signer: - -```ts -import { readFile } from 'node:fs/promises'; -import { SigningAlgorithm } from 'c2pa-node'; - -async function createLocalSigner() { - const [certificate, privateKey] = await Promise.all([ - readFile('tests/fixtures/certs/es256.pem'), - readFile('tests/fixtures/certs/es256.pub'), - ]); - - return { - type: 'local', - certificate, - privateKey, - algorithm: SigningAlgorithm.ES256, - tsaUrl: 'http://timestamp.digicert.com', - }; -} - -async function sign(asset, manifest) { - const buffer = await readFile('to-be-signed.jpg'); - const asset: Asset = { buffer, mimeType: 'image/jpeg' }; - const signer = await createLocalSigner(); - const c2pa = createC2pa({ - signer, - }); - - const { signedAsset, signedManifest } = await c2pa.sign({ - asset, - manifest, - }); -} - -sign(asset, manifest); -``` - -#### Remote signing - -If you have a service that you want to use for signing, you can use that to sign remotely: - -```ts -import { readFile } from 'node:fs/promises'; -import { fetch, Headers } from 'node-fetch'; -import { createC2pa, SigningAlgorithm } from 'c2pa-node'; - -function createRemoteSigner() { - return { - type: 'remote', - async reserveSize() { - const url = `https://my.signing.service/box-size`; - const res = await fetch(url); - const data = (await res.json()) as { boxSize: number }; - return data.boxSize; - }, - async sign({ reserveSize, toBeSigned }) { - const url = `https://my.signing.service/sign?boxSize=${reserveSize}`; - const res = await fetch(url, { - method: 'POST', - headers: new Headers({ - 'Content-Type': 'application/octet-stream', - }), - body: toBeSigned, - }); - return res.buffer(); - }, - }; -} - -async function sign(asset, manifest) { - const buffer = await readFile('to-be-signed.jpg'); - const asset: Asset = { buffer, mimeType: 'image/jpeg' }; - const signer = createRemoteSigner(); - const c2pa = createC2pa({ - signer, - }); - - const { signedAsset, signedManifest } = await c2pa.sign({ - asset, - manifest, - }); -} - -sign(asset, manifest); -``` - -## API documentation - -[Click here](docs/modules.md) to view the API documentation. - -## Testing - -After installation, you can run the test suite by running: - -```sh -$ pnpm test -``` +**Functions**: + +- [createC2pa](modules.md#createc2pa) +- [createTestSigner](modules.md#createtestsigner) + +## Type Aliases + +### Asset + +Ƭ **Asset**: [`BufferAsset`](interfaces/BufferAsset.md) \| [`FileAsset`](interfaces/FileAsset.md) + +An asset that can either be in memory or on disk + +#### Defined in + +[bindings.ts:154](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/bindings.ts#L154) + +___ + +### BaseManifestDefinition + +Ƭ **BaseManifestDefinition**: `Omit`<`ManifestDefinition`, ``"thumbnail"`` \| ``"ingredients"``\> & `RequiredFields` + +#### Defined in + +[lib/manifestBuilder.ts:21](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/lib/manifestBuilder.ts#L21) + +___ + +### C2pa + +Ƭ **C2pa**: `ReturnType` & { `createIngredient`: `ReturnType` ; `read`: typeof `read` } + +#### Defined in + +[index.ts:28](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/index.ts#L28) + +___ + +### C2paOptions + +Ƭ **C2paOptions**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `ingredientHashAlgorithm?` | [`HashAlgorithm`](modules.md#hashalgorithm) | +| `signer?` | [`Signer`](modules.md#signer) | +| `thumbnail?` | [`ThumbnailOptions`](interfaces/ThumbnailOptions.md) \| ``false`` \| ``null`` | + +#### Defined in + +[index.ts:18](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/index.ts#L18) + +___ + +### HashAlgorithm + +Ƭ **HashAlgorithm**: ``"sha256"`` \| ``"sha384"`` \| ``"sha512"`` + +#### Defined in + +[lib/hash.ts:17](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/lib/hash.ts#L17) + +___ + +### IngredientResourceStore + +Ƭ **IngredientResourceStore**: `Record`<`string`, `Buffer`\> + +#### Defined in + +[bindings.ts:353](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/bindings.ts#L353) + +___ + +### SignOutput + +Ƭ **SignOutput**<`AssetType`\>: `AssetType` extends [`BufferAsset`](interfaces/BufferAsset.md) ? `SignOutputData`<[`BufferAsset`](interfaces/BufferAsset.md)\> : `AssetType` extends [`FileAsset`](interfaces/FileAsset.md) ? `SignOutputData`<[`FileAsset`](interfaces/FileAsset.md)\> : `never` + +#### Type parameters + +| Name | +| :------ | +| `AssetType` | + +#### Defined in + +[bindings.ts:225](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/bindings.ts#L225) + +___ + +### SignProps + +Ƭ **SignProps**<`AssetType`\>: `Object` + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `AssetType` | extends [`Asset`](modules.md#asset) | + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `asset` | `AssetType` | +| `manifest` | [`ManifestBuilder`](classes/ManifestBuilder.md) | +| `options?` | [`SignOptions`](interfaces/SignOptions.md) | +| `signer?` | [`Signer`](modules.md#signer) | +| `thumbnail?` | [`BufferAsset`](interfaces/BufferAsset.md) \| ``false`` | + +#### Defined in + +[bindings.ts:201](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/bindings.ts#L201) + +___ + +### Signer + +Ƭ **Signer**: [`LocalSigner`](interfaces/LocalSigner.md) \| [`RemoteSigner`](interfaces/RemoteSigner.md) + +#### Defined in + +[lib/signer.ts:50](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/lib/signer.ts#L50) + +## Functions + +### createC2pa + +▸ **createC2pa**(`options?`): [`C2pa`](modules.md#c2pa) + +Creates an instance of the SDK that encompasses a set of global options + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `options?` | [`C2paOptions`](modules.md#c2paoptions) | Global options for the C2PA instance | + +#### Returns + +[`C2pa`](modules.md#c2pa) + +#### Defined in + +[index.ts:38](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/index.ts#L38) + +___ + +### createTestSigner + +▸ **createTestSigner**(`«destructured»?`): `Promise`<[`LocalSigner`](interfaces/LocalSigner.md)\> + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `«destructured»` | `TestSignerOptions` | `defaultTestSignerOptions` | + +#### Returns + +`Promise`<[`LocalSigner`](interfaces/LocalSigner.md)\> + +#### Defined in + +[lib/signer.ts:64](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/lib/signer.ts#L64) From ea342574b2204c81339d68ada6df6512f9f1e534 Mon Sep 17 00:00:00 2001 From: Rand McKinney Date: Mon, 13 Nov 2023 14:19:11 -0800 Subject: [PATCH 04/11] Add newline to fix mdx parsing --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index f541c50..1a5be9b 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,6 @@ This library implements a Node.js API that can: **WARNING**: This is an early prerelease version of this library. There may be bugs and unimplemented features, and the API is subject to change.
-**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* - [Installation](#installation) - [Installing for use in a client app](#installing-for-use-in-a-client-app) @@ -20,6 +19,7 @@ This library implements a Node.js API that can: - [Signing a manifest](#signing-a-manifest) - [API documentation](#api-documentation) - [Testing](#testing) +
## Installation From ea79c2becbce985ac5ae531d98471128b9e7985f Mon Sep 17 00:00:00 2001 From: Rand McKinney Date: Mon, 13 Nov 2023 14:25:54 -0800 Subject: [PATCH 05/11] cleanup --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 1a5be9b..0213973 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ This library implements a Node.js API that can: - [Installing for use in a client app](#installing-for-use-in-a-client-app) - [Installing for project contributions](#installing-for-project-contributions) - [Usage](#usage) - - [Creating a `c2pa` object](#creating-a-c2pa-object) + - [Creating a c2pa object](#creating-a-c2pa-object) - [Reading a manifest](#reading-a-manifest) - [Creating a manifest](#creating-a-manifest) - [Adding an ingredient](#adding-an-ingredient) @@ -97,7 +97,7 @@ $ pnpm run build ## Usage -### Creating a `c2pa` object +### Creating a c2pa object Instantiate a `c2pa` object by using [`createC2pa()`](https://github.com/contentauth/c2pa-node/blob/main/docs/modules.md#createc2pa): @@ -109,7 +109,7 @@ const c2pa = createC2pa(); ### Reading a manifest -Read a manifest by using the `c2pa.read()` function; for example: +Use the `c2pa.read()` function to read a manifest; for example: ```ts import { createC2pa } from 'c2pa-node'; @@ -167,7 +167,7 @@ const manifest = new ManifestBuilder({ ### Adding an ingredient -Use `c2pa.createIngredient()` to load ingredient data for inclusion into a manifest. This can be stored on a backend if necessary and loaded at signing time without the need for the original ingredient if it is no longer available. +Use `c2pa.createIngredient()` to load ingredient data for inclusion into a manifest. You can store the ingredient data on the backend and load it at signing time if necessary (for example if the original ingredient is no longer available); for example: ```ts // Create the ingredient asset from a buffer @@ -341,7 +341,7 @@ sign(asset, manifest); ## API documentation -For the API documentation, see [`/docs/` directory](https://github.com/contentauth/c2pa-node/blob/main/docs/README.md). +For the API documentation, see the [`/docs/` directory](https://github.com/contentauth/c2pa-node/blob/main/docs/README.md). ## Testing From 64c917b7c18867a79c3b86f3e4222dcf407a43e9 Mon Sep 17 00:00:00 2001 From: Rand McKinney Date: Wed, 15 Nov 2023 14:18:59 -0800 Subject: [PATCH 06/11] Update README.md --- docs/README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/README.md b/docs/README.md index 1ff61f8..6479306 100644 --- a/docs/README.md +++ b/docs/README.md @@ -2,6 +2,7 @@
For installation and usage information, see the main [README](../README.md). +
**Namespaces**: From 416ce57aa0b925a72157533a0c03263293888305 Mon Sep 17 00:00:00 2001 From: Rand McKinney Date: Wed, 15 Nov 2023 14:19:21 -0800 Subject: [PATCH 07/11] Update README.md --- docs/README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/README.md b/docs/README.md index 6479306..c0d30a9 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,6 +1,7 @@ # API documentation for c2pa-node
+ For installation and usage information, see the main [README](../README.md).
From 84f535c40b1434ac56cc3a0a7b153778da0fe356 Mon Sep 17 00:00:00 2001 From: Rand McKinney Date: Wed, 15 Nov 2023 14:19:41 -0800 Subject: [PATCH 08/11] Update README.md --- docs/README.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/docs/README.md b/docs/README.md index c0d30a9..d95377f 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,10 +1,6 @@ # API documentation for c2pa-node -
- For installation and usage information, see the main [README](../README.md). - -
**Namespaces**: From 156492df61c3feb70354b1beff5a304bc6d2a766 Mon Sep 17 00:00:00 2001 From: Rand McKinney Date: Wed, 15 Nov 2023 14:22:14 -0800 Subject: [PATCH 09/11] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 0213973..008b19b 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -# c2pa-node +# C2PA Node.js -This library implements a Node.js API that can: +The [c2pa-node(https://github.com/contentauth/c2pa-node) repository implements a Node.js API that can: - Read and validate C2PA data from media files in [supported formats](https://opensource.contentauthenticity.org/docs/rust-sdk/#supported-file-formats). - Add signed manifests to media files in [supported formats](https://opensource.contentauthenticity.org/docs/rust-sdk/#supported-file-formats). From 34230bbab9f4bebeb68827243c7274a470b19e9a Mon Sep 17 00:00:00 2001 From: Rand McKinney Date: Wed, 15 Nov 2023 14:22:42 -0800 Subject: [PATCH 10/11] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 008b19b..58d470b 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # C2PA Node.js -The [c2pa-node(https://github.com/contentauth/c2pa-node) repository implements a Node.js API that can: +The [c2pa-node](https://github.com/contentauth/c2pa-node) repository implements a Node.js API that can: - Read and validate C2PA data from media files in [supported formats](https://opensource.contentauthenticity.org/docs/rust-sdk/#supported-file-formats). - Add signed manifests to media files in [supported formats](https://opensource.contentauthenticity.org/docs/rust-sdk/#supported-file-formats). From 67ad05a1860391ff5bf69f39b45e351faf39e757 Mon Sep 17 00:00:00 2001 From: Rand McKinney Date: Wed, 15 Nov 2023 14:45:42 -0800 Subject: [PATCH 11/11] Regenerate API docs --- docs/README.md | 70 +++---- docs/classes/ManifestBuilder.md | 32 +-- docs/enums/SigningAlgorithm.md | 16 +- docs/enums/types.ManifestAssertionKind.md | 10 +- docs/enums/types.Relationship.md | 6 +- docs/interfaces/BufferAsset.md | 6 +- docs/interfaces/CreateIngredientProps.md | 12 +- docs/interfaces/FileAsset.md | 6 +- docs/interfaces/LocalSigner.md | 12 +- docs/interfaces/RemoteSigner.md | 8 +- docs/interfaces/ResolvedIngredient.md | 6 +- docs/interfaces/ResolvedManifest.md | 8 +- docs/interfaces/ResolvedManifestStore.md | 6 +- docs/interfaces/ResolvedResource.md | 6 +- docs/interfaces/ResolvedSignatureInfo.md | 8 +- docs/interfaces/SignClaimBytesProps.md | 10 +- docs/interfaces/SignInput.md | 6 +- docs/interfaces/SignOptions.md | 8 +- docs/interfaces/StorableIngredient.md | 8 +- docs/interfaces/ThumbnailOptions.md | 6 +- docs/interfaces/types.Actor.md | 6 +- docs/interfaces/types.DataSource.md | 8 +- docs/interfaces/types.HashedURI.md | 8 +- docs/interfaces/types.Ingredient.md | 28 +-- docs/interfaces/types.Manifest.md | 30 +-- docs/interfaces/types.ManifestAssertion.md | 10 +- docs/interfaces/types.ManifestStore.md | 8 +- docs/interfaces/types.Metadata.md | 10 +- docs/interfaces/types.ResourceRef.md | 6 +- docs/interfaces/types.ResourceStore.md | 6 +- docs/interfaces/types.ReviewRating.md | 8 +- docs/interfaces/types.SignatureInfo.md | 6 +- docs/interfaces/types.ValidationStatus.md | 8 +- docs/modules.md | 216 --------------------- docs/modules/types.md | 2 +- package.json | 2 +- 36 files changed, 198 insertions(+), 414 deletions(-) delete mode 100644 docs/modules.md diff --git a/docs/README.md b/docs/README.md index d95377f..e0b8f00 100644 --- a/docs/README.md +++ b/docs/README.md @@ -2,19 +2,19 @@ For installation and usage information, see the main [README](../README.md). -**Namespaces**: +### Namespaces - [types](modules/types.md) -**Enumerations**: +### Enumerations - [SigningAlgorithm](enums/SigningAlgorithm.md) -**Classes**: +### Classes - [ManifestBuilder](classes/ManifestBuilder.md) -**Interfaces**: +### Interfaces - [BufferAsset](interfaces/BufferAsset.md) - [CreateIngredientProps](interfaces/CreateIngredientProps.md) @@ -32,22 +32,22 @@ For installation and usage information, see the main [README](../README.md). - [StorableIngredient](interfaces/StorableIngredient.md) - [ThumbnailOptions](interfaces/ThumbnailOptions.md) -**Type Aliases**: +### Type Aliases -- [Asset](modules.md#asset) -- [BaseManifestDefinition](modules.md#basemanifestdefinition) -- [C2pa](modules.md#c2pa) -- [C2paOptions](modules.md#c2paoptions) -- [HashAlgorithm](modules.md#hashalgorithm) -- [IngredientResourceStore](modules.md#ingredientresourcestore) -- [SignOutput](modules.md#signoutput) -- [SignProps](modules.md#signprops) -- [Signer](modules.md#signer) +- [Asset](README.md#asset) +- [BaseManifestDefinition](README.md#basemanifestdefinition) +- [C2pa](README.md#c2pa) +- [C2paOptions](README.md#c2paoptions) +- [HashAlgorithm](README.md#hashalgorithm) +- [IngredientResourceStore](README.md#ingredientresourcestore) +- [SignOutput](README.md#signoutput) +- [SignProps](README.md#signprops) +- [Signer](README.md#signer) -**Functions**: +### Functions -- [createC2pa](modules.md#createc2pa) -- [createTestSigner](modules.md#createtestsigner) +- [createC2pa](README.md#createc2pa) +- [createTestSigner](README.md#createtestsigner) ## Type Aliases @@ -59,7 +59,7 @@ An asset that can either be in memory or on disk #### Defined in -[bindings.ts:154](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/bindings.ts#L154) +[bindings.ts:154](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/bindings.ts#L154) ___ @@ -69,7 +69,7 @@ ___ #### Defined in -[lib/manifestBuilder.ts:21](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/lib/manifestBuilder.ts#L21) +[lib/manifestBuilder.ts:21](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/lib/manifestBuilder.ts#L21) ___ @@ -79,7 +79,7 @@ ___ #### Defined in -[index.ts:28](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/index.ts#L28) +[index.ts:28](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/index.ts#L28) ___ @@ -91,13 +91,13 @@ ___ | Name | Type | | :------ | :------ | -| `ingredientHashAlgorithm?` | [`HashAlgorithm`](modules.md#hashalgorithm) | -| `signer?` | [`Signer`](modules.md#signer) | +| `ingredientHashAlgorithm?` | [`HashAlgorithm`](README.md#hashalgorithm) | +| `signer?` | [`Signer`](README.md#signer) | | `thumbnail?` | [`ThumbnailOptions`](interfaces/ThumbnailOptions.md) \| ``false`` \| ``null`` | #### Defined in -[index.ts:18](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/index.ts#L18) +[index.ts:18](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/index.ts#L18) ___ @@ -107,7 +107,7 @@ ___ #### Defined in -[lib/hash.ts:17](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/lib/hash.ts#L17) +[lib/hash.ts:17](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/lib/hash.ts#L17) ___ @@ -117,7 +117,7 @@ ___ #### Defined in -[bindings.ts:353](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/bindings.ts#L353) +[bindings.ts:353](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/bindings.ts#L353) ___ @@ -133,7 +133,7 @@ ___ #### Defined in -[bindings.ts:225](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/bindings.ts#L225) +[bindings.ts:225](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/bindings.ts#L225) ___ @@ -145,7 +145,7 @@ ___ | Name | Type | | :------ | :------ | -| `AssetType` | extends [`Asset`](modules.md#asset) | +| `AssetType` | extends [`Asset`](README.md#asset) | #### Type declaration @@ -154,12 +154,12 @@ ___ | `asset` | `AssetType` | | `manifest` | [`ManifestBuilder`](classes/ManifestBuilder.md) | | `options?` | [`SignOptions`](interfaces/SignOptions.md) | -| `signer?` | [`Signer`](modules.md#signer) | +| `signer?` | [`Signer`](README.md#signer) | | `thumbnail?` | [`BufferAsset`](interfaces/BufferAsset.md) \| ``false`` | #### Defined in -[bindings.ts:201](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/bindings.ts#L201) +[bindings.ts:201](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/bindings.ts#L201) ___ @@ -169,13 +169,13 @@ ___ #### Defined in -[lib/signer.ts:50](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/lib/signer.ts#L50) +[lib/signer.ts:50](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/lib/signer.ts#L50) ## Functions ### createC2pa -▸ **createC2pa**(`options?`): [`C2pa`](modules.md#c2pa) +▸ **createC2pa**(`options?`): [`C2pa`](README.md#c2pa) Creates an instance of the SDK that encompasses a set of global options @@ -183,15 +183,15 @@ Creates an instance of the SDK that encompasses a set of global options | Name | Type | Description | | :------ | :------ | :------ | -| `options?` | [`C2paOptions`](modules.md#c2paoptions) | Global options for the C2PA instance | +| `options?` | [`C2paOptions`](README.md#c2paoptions) | Global options for the C2PA instance | #### Returns -[`C2pa`](modules.md#c2pa) +[`C2pa`](README.md#c2pa) #### Defined in -[index.ts:38](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/index.ts#L38) +[index.ts:38](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/index.ts#L38) ___ @@ -211,4 +211,4 @@ ___ #### Defined in -[lib/signer.ts:64](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/lib/signer.ts#L64) +[lib/signer.ts:64](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/lib/signer.ts#L64) diff --git a/docs/classes/ManifestBuilder.md b/docs/classes/ManifestBuilder.md index fa55f2c..367241d 100644 --- a/docs/classes/ManifestBuilder.md +++ b/docs/classes/ManifestBuilder.md @@ -1,4 +1,4 @@ -[c2pa-node](../README.md) / [Exports](../modules.md) / ManifestBuilder +[c2pa-node](../README.md) / ManifestBuilder # Class: ManifestBuilder @@ -37,12 +37,12 @@ | Name | Type | | :------ | :------ | -| `baseDefinition` | [`BaseManifestDefinition`](../modules.md#basemanifestdefinition) | +| `baseDefinition` | [`BaseManifestDefinition`](../README.md#basemanifestdefinition) | | `options?` | `ManifestBuilderOptions` | #### Defined in -[lib/manifestBuilder.ts:41](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/lib/manifestBuilder.ts#L41) +[lib/manifestBuilder.ts:41](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/lib/manifestBuilder.ts#L41) ## Properties @@ -52,7 +52,7 @@ #### Defined in -[lib/manifestBuilder.ts:35](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/lib/manifestBuilder.ts#L35) +[lib/manifestBuilder.ts:35](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/lib/manifestBuilder.ts#L35) ___ @@ -62,7 +62,7 @@ ___ #### Defined in -[lib/manifestBuilder.ts:39](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/lib/manifestBuilder.ts#L39) +[lib/manifestBuilder.ts:39](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/lib/manifestBuilder.ts#L39) ___ @@ -72,7 +72,7 @@ ___ #### Defined in -[lib/manifestBuilder.ts:37](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/lib/manifestBuilder.ts#L37) +[lib/manifestBuilder.ts:37](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/lib/manifestBuilder.ts#L37) ___ @@ -82,7 +82,7 @@ ___ #### Defined in -[lib/manifestBuilder.ts:33](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/lib/manifestBuilder.ts#L33) +[lib/manifestBuilder.ts:33](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/lib/manifestBuilder.ts#L33) ## Accessors @@ -96,21 +96,21 @@ ___ #### Defined in -[lib/manifestBuilder.ts:105](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/lib/manifestBuilder.ts#L105) +[lib/manifestBuilder.ts:105](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/lib/manifestBuilder.ts#L105) ___ ### sendableIngredients -• `get` **sendableIngredients**(): { `ingredient`: `string` ; `resources`: [`IngredientResourceStore`](../modules.md#ingredientresourcestore) }[] +• `get` **sendableIngredients**(): { `ingredient`: `string` ; `resources`: [`IngredientResourceStore`](../README.md#ingredientresourcestore) }[] #### Returns -{ `ingredient`: `string` ; `resources`: [`IngredientResourceStore`](../modules.md#ingredientresourcestore) }[] +{ `ingredient`: `string` ; `resources`: [`IngredientResourceStore`](../README.md#ingredientresourcestore) }[] #### Defined in -[lib/manifestBuilder.ts:109](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/lib/manifestBuilder.ts#L109) +[lib/manifestBuilder.ts:109](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/lib/manifestBuilder.ts#L109) ## Methods @@ -130,7 +130,7 @@ ___ #### Defined in -[lib/manifestBuilder.ts:72](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/lib/manifestBuilder.ts#L72) +[lib/manifestBuilder.ts:72](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/lib/manifestBuilder.ts#L72) ___ @@ -150,7 +150,7 @@ ___ #### Defined in -[lib/manifestBuilder.ts:86](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/lib/manifestBuilder.ts#L86) +[lib/manifestBuilder.ts:86](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/lib/manifestBuilder.ts#L86) ___ @@ -164,13 +164,13 @@ ___ | Name | Type | | :------ | :------ | -| `ingredients` | { `ingredient`: `string` ; `resources`: [`IngredientResourceStore`](../modules.md#ingredientresourcestore) }[] | +| `ingredients` | { `ingredient`: `string` ; `resources`: [`IngredientResourceStore`](../README.md#ingredientresourcestore) }[] | | `manifest` | `string` | | `resourceStore` | `Record`<`string`, `Buffer`\> | #### Defined in -[lib/manifestBuilder.ts:118](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/lib/manifestBuilder.ts#L118) +[lib/manifestBuilder.ts:118](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/lib/manifestBuilder.ts#L118) ___ @@ -190,4 +190,4 @@ ___ #### Defined in -[lib/manifestBuilder.ts:95](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/lib/manifestBuilder.ts#L95) +[lib/manifestBuilder.ts:95](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/lib/manifestBuilder.ts#L95) diff --git a/docs/enums/SigningAlgorithm.md b/docs/enums/SigningAlgorithm.md index ce2456a..ac28862 100644 --- a/docs/enums/SigningAlgorithm.md +++ b/docs/enums/SigningAlgorithm.md @@ -1,4 +1,4 @@ -[c2pa-node](../README.md) / [Exports](../modules.md) / SigningAlgorithm +[c2pa-node](../README.md) / SigningAlgorithm # Enumeration: SigningAlgorithm @@ -22,7 +22,7 @@ #### Defined in -[lib/signer.ts:16](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/lib/signer.ts#L16) +[lib/signer.ts:16](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/lib/signer.ts#L16) ___ @@ -32,7 +32,7 @@ ___ #### Defined in -[lib/signer.ts:18](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/lib/signer.ts#L18) +[lib/signer.ts:18](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/lib/signer.ts#L18) ___ @@ -42,7 +42,7 @@ ___ #### Defined in -[lib/signer.ts:20](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/lib/signer.ts#L20) +[lib/signer.ts:20](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/lib/signer.ts#L20) ___ @@ -52,7 +52,7 @@ ___ #### Defined in -[lib/signer.ts:28](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/lib/signer.ts#L28) +[lib/signer.ts:28](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/lib/signer.ts#L28) ___ @@ -62,7 +62,7 @@ ___ #### Defined in -[lib/signer.ts:22](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/lib/signer.ts#L22) +[lib/signer.ts:22](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/lib/signer.ts#L22) ___ @@ -72,7 +72,7 @@ ___ #### Defined in -[lib/signer.ts:24](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/lib/signer.ts#L24) +[lib/signer.ts:24](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/lib/signer.ts#L24) ___ @@ -82,4 +82,4 @@ ___ #### Defined in -[lib/signer.ts:26](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/lib/signer.ts#L26) +[lib/signer.ts:26](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/lib/signer.ts#L26) diff --git a/docs/enums/types.ManifestAssertionKind.md b/docs/enums/types.ManifestAssertionKind.md index 3697736..32ee612 100644 --- a/docs/enums/types.ManifestAssertionKind.md +++ b/docs/enums/types.ManifestAssertionKind.md @@ -1,4 +1,4 @@ -[c2pa-node](../README.md) / [Exports](../modules.md) / [types](../modules/types.md) / ManifestAssertionKind +[c2pa-node](../README.md) / [types](../modules/types.md) / ManifestAssertionKind # Enumeration: ManifestAssertionKind @@ -23,7 +23,7 @@ Assertions in C2PA can be stored in several formats #### Defined in -[types.d.ts:112](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/types.d.ts#L112) +[types.d.ts:112](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/types.d.ts#L112) ___ @@ -33,7 +33,7 @@ ___ #### Defined in -[types.d.ts:113](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/types.d.ts#L113) +[types.d.ts:113](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/types.d.ts#L113) ___ @@ -43,7 +43,7 @@ ___ #### Defined in -[types.d.ts:114](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/types.d.ts#L114) +[types.d.ts:114](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/types.d.ts#L114) ___ @@ -53,4 +53,4 @@ ___ #### Defined in -[types.d.ts:115](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/types.d.ts#L115) +[types.d.ts:115](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/types.d.ts#L115) diff --git a/docs/enums/types.Relationship.md b/docs/enums/types.Relationship.md index c3a65ae..c2961b6 100644 --- a/docs/enums/types.Relationship.md +++ b/docs/enums/types.Relationship.md @@ -1,4 +1,4 @@ -[c2pa-node](../README.md) / [Exports](../modules.md) / [types](../modules/types.md) / Relationship +[c2pa-node](../README.md) / [types](../modules/types.md) / Relationship # Enumeration: Relationship @@ -23,7 +23,7 @@ There can only be one parent ingredient in the ingredients. #### Defined in -[types.d.ts:272](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/types.d.ts#L272) +[types.d.ts:272](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/types.d.ts#L272) ___ @@ -33,4 +33,4 @@ ___ #### Defined in -[types.d.ts:273](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/types.d.ts#L273) +[types.d.ts:273](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/types.d.ts#L273) diff --git a/docs/interfaces/BufferAsset.md b/docs/interfaces/BufferAsset.md index 88357ec..652ff43 100644 --- a/docs/interfaces/BufferAsset.md +++ b/docs/interfaces/BufferAsset.md @@ -1,4 +1,4 @@ -[c2pa-node](../README.md) / [Exports](../modules.md) / BufferAsset +[c2pa-node](../README.md) / BufferAsset # Interface: BufferAsset @@ -17,7 +17,7 @@ #### Defined in -[bindings.ts:138](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/bindings.ts#L138) +[bindings.ts:138](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/bindings.ts#L138) ___ @@ -27,4 +27,4 @@ ___ #### Defined in -[bindings.ts:140](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/bindings.ts#L140) +[bindings.ts:140](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/bindings.ts#L140) diff --git a/docs/interfaces/CreateIngredientProps.md b/docs/interfaces/CreateIngredientProps.md index 0c7813f..0565028 100644 --- a/docs/interfaces/CreateIngredientProps.md +++ b/docs/interfaces/CreateIngredientProps.md @@ -1,4 +1,4 @@ -[c2pa-node](../README.md) / [Exports](../modules.md) / CreateIngredientProps +[c2pa-node](../README.md) / CreateIngredientProps # Interface: CreateIngredientProps @@ -15,11 +15,11 @@ ### asset -• **asset**: [`Asset`](../modules.md#asset) +• **asset**: [`Asset`](../README.md#asset) #### Defined in -[bindings.ts:363](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/bindings.ts#L363) +[bindings.ts:363](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/bindings.ts#L363) ___ @@ -29,7 +29,7 @@ ___ #### Defined in -[bindings.ts:370](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/bindings.ts#L370) +[bindings.ts:370](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/bindings.ts#L370) ___ @@ -39,7 +39,7 @@ ___ #### Defined in -[bindings.ts:368](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/bindings.ts#L368) +[bindings.ts:368](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/bindings.ts#L368) ___ @@ -49,4 +49,4 @@ ___ #### Defined in -[bindings.ts:365](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/bindings.ts#L365) +[bindings.ts:365](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/bindings.ts#L365) diff --git a/docs/interfaces/FileAsset.md b/docs/interfaces/FileAsset.md index eff088a..c312665 100644 --- a/docs/interfaces/FileAsset.md +++ b/docs/interfaces/FileAsset.md @@ -1,4 +1,4 @@ -[c2pa-node](../README.md) / [Exports](../modules.md) / FileAsset +[c2pa-node](../README.md) / FileAsset # Interface: FileAsset @@ -17,7 +17,7 @@ #### Defined in -[bindings.ts:148](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/bindings.ts#L148) +[bindings.ts:148](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/bindings.ts#L148) ___ @@ -27,4 +27,4 @@ ___ #### Defined in -[bindings.ts:145](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/bindings.ts#L145) +[bindings.ts:145](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/bindings.ts#L145) diff --git a/docs/interfaces/LocalSigner.md b/docs/interfaces/LocalSigner.md index 3efb4a2..98bf30c 100644 --- a/docs/interfaces/LocalSigner.md +++ b/docs/interfaces/LocalSigner.md @@ -1,4 +1,4 @@ -[c2pa-node](../README.md) / [Exports](../modules.md) / LocalSigner +[c2pa-node](../README.md) / LocalSigner # Interface: LocalSigner @@ -20,7 +20,7 @@ #### Defined in -[lib/signer.ts:35](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/lib/signer.ts#L35) +[lib/signer.ts:35](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/lib/signer.ts#L35) ___ @@ -30,7 +30,7 @@ ___ #### Defined in -[lib/signer.ts:33](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/lib/signer.ts#L33) +[lib/signer.ts:33](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/lib/signer.ts#L33) ___ @@ -40,7 +40,7 @@ ___ #### Defined in -[lib/signer.ts:34](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/lib/signer.ts#L34) +[lib/signer.ts:34](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/lib/signer.ts#L34) ___ @@ -50,7 +50,7 @@ ___ #### Defined in -[lib/signer.ts:36](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/lib/signer.ts#L36) +[lib/signer.ts:36](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/lib/signer.ts#L36) ___ @@ -60,4 +60,4 @@ ___ #### Defined in -[lib/signer.ts:32](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/lib/signer.ts#L32) +[lib/signer.ts:32](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/lib/signer.ts#L32) diff --git a/docs/interfaces/RemoteSigner.md b/docs/interfaces/RemoteSigner.md index c01184d..4ec8e76 100644 --- a/docs/interfaces/RemoteSigner.md +++ b/docs/interfaces/RemoteSigner.md @@ -1,4 +1,4 @@ -[c2pa-node](../README.md) / [Exports](../modules.md) / RemoteSigner +[c2pa-node](../README.md) / RemoteSigner # Interface: RemoteSigner @@ -26,7 +26,7 @@ #### Defined in -[lib/signer.ts:46](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/lib/signer.ts#L46) +[lib/signer.ts:46](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/lib/signer.ts#L46) ___ @@ -50,7 +50,7 @@ ___ #### Defined in -[lib/signer.ts:47](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/lib/signer.ts#L47) +[lib/signer.ts:47](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/lib/signer.ts#L47) ___ @@ -60,4 +60,4 @@ ___ #### Defined in -[lib/signer.ts:45](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/lib/signer.ts#L45) +[lib/signer.ts:45](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/lib/signer.ts#L45) diff --git a/docs/interfaces/ResolvedIngredient.md b/docs/interfaces/ResolvedIngredient.md index 6a4b128..5bf6019 100644 --- a/docs/interfaces/ResolvedIngredient.md +++ b/docs/interfaces/ResolvedIngredient.md @@ -1,4 +1,4 @@ -[c2pa-node](../README.md) / [Exports](../modules.md) / ResolvedIngredient +[c2pa-node](../README.md) / ResolvedIngredient # Interface: ResolvedIngredient @@ -23,7 +23,7 @@ #### Defined in -[bindings.ts:79](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/bindings.ts#L79) +[bindings.ts:79](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/bindings.ts#L79) ___ @@ -33,4 +33,4 @@ ___ #### Defined in -[bindings.ts:80](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/bindings.ts#L80) +[bindings.ts:80](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/bindings.ts#L80) diff --git a/docs/interfaces/ResolvedManifest.md b/docs/interfaces/ResolvedManifest.md index d42097f..d778afd 100644 --- a/docs/interfaces/ResolvedManifest.md +++ b/docs/interfaces/ResolvedManifest.md @@ -1,4 +1,4 @@ -[c2pa-node](../README.md) / [Exports](../modules.md) / ResolvedManifest +[c2pa-node](../README.md) / ResolvedManifest # Interface: ResolvedManifest @@ -24,7 +24,7 @@ #### Defined in -[bindings.ts:52](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/bindings.ts#L52) +[bindings.ts:52](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/bindings.ts#L52) ___ @@ -34,7 +34,7 @@ ___ #### Defined in -[bindings.ts:54](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/bindings.ts#L54) +[bindings.ts:54](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/bindings.ts#L54) ___ @@ -44,4 +44,4 @@ ___ #### Defined in -[bindings.ts:53](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/bindings.ts#L53) +[bindings.ts:53](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/bindings.ts#L53) diff --git a/docs/interfaces/ResolvedManifestStore.md b/docs/interfaces/ResolvedManifestStore.md index 8368459..e542e8a 100644 --- a/docs/interfaces/ResolvedManifestStore.md +++ b/docs/interfaces/ResolvedManifestStore.md @@ -1,4 +1,4 @@ -[c2pa-node](../README.md) / [Exports](../modules.md) / ResolvedManifestStore +[c2pa-node](../README.md) / ResolvedManifestStore # Interface: ResolvedManifestStore @@ -23,7 +23,7 @@ #### Defined in -[bindings.ts:59](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/bindings.ts#L59) +[bindings.ts:59](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/bindings.ts#L59) ___ @@ -33,4 +33,4 @@ ___ #### Defined in -[bindings.ts:60](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/bindings.ts#L60) +[bindings.ts:60](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/bindings.ts#L60) diff --git a/docs/interfaces/ResolvedResource.md b/docs/interfaces/ResolvedResource.md index e54a62e..dcccfad 100644 --- a/docs/interfaces/ResolvedResource.md +++ b/docs/interfaces/ResolvedResource.md @@ -1,4 +1,4 @@ -[c2pa-node](../README.md) / [Exports](../modules.md) / ResolvedResource +[c2pa-node](../README.md) / ResolvedResource # Interface: ResolvedResource @@ -17,7 +17,7 @@ #### Defined in -[bindings.ts:43](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/bindings.ts#L43) +[bindings.ts:43](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/bindings.ts#L43) ___ @@ -27,4 +27,4 @@ ___ #### Defined in -[bindings.ts:42](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/bindings.ts#L42) +[bindings.ts:42](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/bindings.ts#L42) diff --git a/docs/interfaces/ResolvedSignatureInfo.md b/docs/interfaces/ResolvedSignatureInfo.md index 9dffd72..6e37c86 100644 --- a/docs/interfaces/ResolvedSignatureInfo.md +++ b/docs/interfaces/ResolvedSignatureInfo.md @@ -1,4 +1,4 @@ -[c2pa-node](../README.md) / [Exports](../modules.md) / ResolvedSignatureInfo +[c2pa-node](../README.md) / ResolvedSignatureInfo # Interface: ResolvedSignatureInfo @@ -32,7 +32,7 @@ human readable issuing authority for this signature #### Defined in -[types.d.ts:308](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/types.d.ts#L308) +[types.d.ts:308](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/types.d.ts#L308) ___ @@ -48,7 +48,7 @@ the time the signature was created #### Defined in -[types.d.ts:312](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/types.d.ts#L312) +[types.d.ts:312](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/types.d.ts#L312) ___ @@ -58,4 +58,4 @@ ___ #### Defined in -[bindings.ts:47](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/bindings.ts#L47) +[bindings.ts:47](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/bindings.ts#L47) diff --git a/docs/interfaces/SignClaimBytesProps.md b/docs/interfaces/SignClaimBytesProps.md index dd65252..b2b8727 100644 --- a/docs/interfaces/SignClaimBytesProps.md +++ b/docs/interfaces/SignClaimBytesProps.md @@ -1,4 +1,4 @@ -[c2pa-node](../README.md) / [Exports](../modules.md) / SignClaimBytesProps +[c2pa-node](../README.md) / SignClaimBytesProps # Interface: SignClaimBytesProps @@ -18,7 +18,7 @@ #### Defined in -[bindings.ts:215](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/bindings.ts#L215) +[bindings.ts:215](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/bindings.ts#L215) ___ @@ -28,14 +28,14 @@ ___ #### Defined in -[bindings.ts:216](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/bindings.ts#L216) +[bindings.ts:216](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/bindings.ts#L216) ___ ### signer -• **signer**: [`Signer`](../modules.md#signer) +• **signer**: [`Signer`](../README.md#signer) #### Defined in -[bindings.ts:217](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/bindings.ts#L217) +[bindings.ts:217](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/bindings.ts#L217) diff --git a/docs/interfaces/SignInput.md b/docs/interfaces/SignInput.md index 9c809a5..9071332 100644 --- a/docs/interfaces/SignInput.md +++ b/docs/interfaces/SignInput.md @@ -1,4 +1,4 @@ -[c2pa-node](../README.md) / [Exports](../modules.md) / SignInput +[c2pa-node](../README.md) / SignInput # Interface: SignInput @@ -17,7 +17,7 @@ #### Defined in -[lib/signer.ts:40](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/lib/signer.ts#L40) +[lib/signer.ts:40](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/lib/signer.ts#L40) ___ @@ -27,4 +27,4 @@ ___ #### Defined in -[lib/signer.ts:41](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/lib/signer.ts#L41) +[lib/signer.ts:41](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/lib/signer.ts#L41) diff --git a/docs/interfaces/SignOptions.md b/docs/interfaces/SignOptions.md index 03490e3..d028dc3 100644 --- a/docs/interfaces/SignOptions.md +++ b/docs/interfaces/SignOptions.md @@ -1,4 +1,4 @@ -[c2pa-node](../README.md) / [Exports](../modules.md) / SignOptions +[c2pa-node](../README.md) / SignOptions # Interface: SignOptions @@ -18,7 +18,7 @@ #### Defined in -[bindings.ts:196](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/bindings.ts#L196) +[bindings.ts:196](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/bindings.ts#L196) ___ @@ -28,7 +28,7 @@ ___ #### Defined in -[bindings.ts:197](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/bindings.ts#L197) +[bindings.ts:197](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/bindings.ts#L197) ___ @@ -38,4 +38,4 @@ ___ #### Defined in -[bindings.ts:198](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/bindings.ts#L198) +[bindings.ts:198](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/bindings.ts#L198) diff --git a/docs/interfaces/StorableIngredient.md b/docs/interfaces/StorableIngredient.md index 4878b27..e7219cb 100644 --- a/docs/interfaces/StorableIngredient.md +++ b/docs/interfaces/StorableIngredient.md @@ -1,4 +1,4 @@ -[c2pa-node](../README.md) / [Exports](../modules.md) / StorableIngredient +[c2pa-node](../README.md) / StorableIngredient # Interface: StorableIngredient @@ -17,14 +17,14 @@ #### Defined in -[bindings.ts:356](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/bindings.ts#L356) +[bindings.ts:356](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/bindings.ts#L356) ___ ### resources -• **resources**: [`IngredientResourceStore`](../modules.md#ingredientresourcestore) +• **resources**: [`IngredientResourceStore`](../README.md#ingredientresourcestore) #### Defined in -[bindings.ts:357](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/bindings.ts#L357) +[bindings.ts:357](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/bindings.ts#L357) diff --git a/docs/interfaces/ThumbnailOptions.md b/docs/interfaces/ThumbnailOptions.md index 064a525..59394c2 100644 --- a/docs/interfaces/ThumbnailOptions.md +++ b/docs/interfaces/ThumbnailOptions.md @@ -1,4 +1,4 @@ -[c2pa-node](../README.md) / [Exports](../modules.md) / ThumbnailOptions +[c2pa-node](../README.md) / ThumbnailOptions # Interface: ThumbnailOptions @@ -17,7 +17,7 @@ #### Defined in -[lib/thumbnail.ts:15](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/lib/thumbnail.ts#L15) +[lib/thumbnail.ts:15](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/lib/thumbnail.ts#L15) ___ @@ -27,4 +27,4 @@ ___ #### Defined in -[lib/thumbnail.ts:16](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/lib/thumbnail.ts#L16) +[lib/thumbnail.ts:16](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/lib/thumbnail.ts#L16) diff --git a/docs/interfaces/types.Actor.md b/docs/interfaces/types.Actor.md index a571369..4836535 100644 --- a/docs/interfaces/types.Actor.md +++ b/docs/interfaces/types.Actor.md @@ -1,4 +1,4 @@ -[c2pa-node](../README.md) / [Exports](../modules.md) / [types](../modules/types.md) / Actor +[c2pa-node](../README.md) / [types](../modules/types.md) / Actor # Interface: Actor @@ -27,7 +27,7 @@ List of references to W3C Verifiable Credentials. #### Defined in -[types.d.ts:234](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/types.d.ts#L234) +[types.d.ts:234](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/types.d.ts#L234) ___ @@ -39,4 +39,4 @@ An identifier for a human actor, used when the "type" is `humanEntry.identified` #### Defined in -[types.d.ts:238](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/types.d.ts#L238) +[types.d.ts:238](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/types.d.ts#L238) diff --git a/docs/interfaces/types.DataSource.md b/docs/interfaces/types.DataSource.md index e88f018..c1dac97 100644 --- a/docs/interfaces/types.DataSource.md +++ b/docs/interfaces/types.DataSource.md @@ -1,4 +1,4 @@ -[c2pa-node](../README.md) / [Exports](../modules.md) / [types](../modules/types.md) / DataSource +[c2pa-node](../README.md) / [types](../modules/types.md) / DataSource # Interface: DataSource @@ -28,7 +28,7 @@ A list of [`Actor`]s associated with this source. #### Defined in -[types.d.ts:215](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/types.d.ts#L215) +[types.d.ts:215](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/types.d.ts#L215) ___ @@ -40,7 +40,7 @@ A human-readable string giving details about the source of the assertion data. #### Defined in -[types.d.ts:219](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/types.d.ts#L219) +[types.d.ts:219](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/types.d.ts#L219) ___ @@ -52,4 +52,4 @@ A value from among the enumerated list indicating the source of the assertion. #### Defined in -[types.d.ts:223](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/types.d.ts#L223) +[types.d.ts:223](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/types.d.ts#L223) diff --git a/docs/interfaces/types.HashedURI.md b/docs/interfaces/types.HashedURI.md index ce2f0bc..a2aa9f9 100644 --- a/docs/interfaces/types.HashedURI.md +++ b/docs/interfaces/types.HashedURI.md @@ -1,4 +1,4 @@ -[c2pa-node](../README.md) / [Exports](../modules.md) / [types](../modules/types.md) / HashedURI +[c2pa-node](../README.md) / [types](../modules/types.md) / HashedURI # Interface: HashedURI @@ -27,7 +27,7 @@ tagged cbor serialization #### Defined in -[types.d.ts:247](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/types.d.ts#L247) +[types.d.ts:247](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/types.d.ts#L247) ___ @@ -37,7 +37,7 @@ ___ #### Defined in -[types.d.ts:248](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/types.d.ts#L248) +[types.d.ts:248](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/types.d.ts#L248) ___ @@ -47,4 +47,4 @@ ___ #### Defined in -[types.d.ts:249](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/types.d.ts#L249) +[types.d.ts:249](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/types.d.ts#L249) diff --git a/docs/interfaces/types.Ingredient.md b/docs/interfaces/types.Ingredient.md index 2c50ceb..ff9b1df 100644 --- a/docs/interfaces/types.Ingredient.md +++ b/docs/interfaces/types.Ingredient.md @@ -1,4 +1,4 @@ -[c2pa-node](../README.md) / [Exports](../modules.md) / [types](../modules/types.md) / Ingredient +[c2pa-node](../README.md) / [types](../modules/types.md) / Ingredient # Interface: Ingredient @@ -43,7 +43,7 @@ If this ingredient has a [`ManifestStore`], this will hold the label of the acti #### Defined in -[types.d.ts:130](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/types.d.ts#L130) +[types.d.ts:130](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/types.d.ts#L130) ___ @@ -55,7 +55,7 @@ Document ID from `xmpMM:DocumentID` in XMP metadata. #### Defined in -[types.d.ts:134](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/types.d.ts#L134) +[types.d.ts:134](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/types.d.ts#L134) ___ @@ -67,7 +67,7 @@ The format of the source file as a MIME type. #### Defined in -[types.d.ts:138](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/types.d.ts#L138) +[types.d.ts:138](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/types.d.ts#L138) ___ @@ -79,7 +79,7 @@ An optional hash of the asset to prevent duplicates. #### Defined in -[types.d.ts:142](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/types.d.ts#L142) +[types.d.ts:142](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/types.d.ts#L142) ___ @@ -91,7 +91,7 @@ Instance ID from `xmpMM:InstanceID` in XMP metadata. #### Defined in -[types.d.ts:146](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/types.d.ts#L146) +[types.d.ts:146](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/types.d.ts#L146) ___ @@ -105,7 +105,7 @@ A [`ManifestStore`] from the source asset extracted as a binary C2PA blob. #### Defined in -[types.d.ts:152](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/types.d.ts#L152) +[types.d.ts:152](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/types.d.ts#L152) ___ @@ -119,7 +119,7 @@ Any additional [`Metadata`] as defined in the C2PA spec. #### Defined in -[types.d.ts:158](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/types.d.ts#L158) +[types.d.ts:158](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/types.d.ts#L158) ___ @@ -131,7 +131,7 @@ URI from `dcterms:provenance` in XMP metadata. #### Defined in -[types.d.ts:162](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/types.d.ts#L162) +[types.d.ts:162](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/types.d.ts#L162) ___ @@ -145,7 +145,7 @@ There can only be one parent ingredient in the ingredients. #### Defined in -[types.d.ts:168](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/types.d.ts#L168) +[types.d.ts:168](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/types.d.ts#L168) ___ @@ -155,7 +155,7 @@ ___ #### Defined in -[types.d.ts:169](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/types.d.ts#L169) +[types.d.ts:169](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/types.d.ts#L169) ___ @@ -169,7 +169,7 @@ A tuple of thumbnail MIME format (i.e. `image/jpeg`) and binary bits of the imag #### Defined in -[types.d.ts:175](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/types.d.ts#L175) +[types.d.ts:175](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/types.d.ts#L175) ___ @@ -181,7 +181,7 @@ A human-readable title, generally source filename. #### Defined in -[types.d.ts:179](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/types.d.ts#L179) +[types.d.ts:179](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/types.d.ts#L179) ___ @@ -193,4 +193,4 @@ Validation results. #### Defined in -[types.d.ts:183](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/types.d.ts#L183) +[types.d.ts:183](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/types.d.ts#L183) diff --git a/docs/interfaces/types.Manifest.md b/docs/interfaces/types.Manifest.md index 63b15bb..d4debc8 100644 --- a/docs/interfaces/types.Manifest.md +++ b/docs/interfaces/types.Manifest.md @@ -1,4 +1,4 @@ -[c2pa-node](../README.md) / [Exports](../modules.md) / [types](../modules/types.md) / Manifest +[c2pa-node](../README.md) / [types](../modules/types.md) / Manifest # Interface: Manifest @@ -39,7 +39,7 @@ A list of assertions #### Defined in -[types.d.ts:36](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/types.d.ts#L36) +[types.d.ts:36](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/types.d.ts#L36) ___ @@ -52,7 +52,7 @@ claim Spaces are not allowed in names, versions can be specified with product/1. #### Defined in -[types.d.ts:41](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/types.d.ts#L41) +[types.d.ts:41](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/types.d.ts#L41) ___ @@ -62,7 +62,7 @@ ___ #### Defined in -[types.d.ts:42](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/types.d.ts#L42) +[types.d.ts:42](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/types.d.ts#L42) ___ @@ -74,7 +74,7 @@ A List of verified credentials #### Defined in -[types.d.ts:46](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/types.d.ts#L46) +[types.d.ts:46](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/types.d.ts#L46) ___ @@ -86,7 +86,7 @@ The format of the source file as a MIME type. #### Defined in -[types.d.ts:50](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/types.d.ts#L50) +[types.d.ts:50](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/types.d.ts#L50) ___ @@ -98,7 +98,7 @@ A List of ingredients #### Defined in -[types.d.ts:54](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/types.d.ts#L54) +[types.d.ts:54](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/types.d.ts#L54) ___ @@ -110,7 +110,7 @@ Instance ID from `xmpMM:InstanceID` in XMP metadata. #### Defined in -[types.d.ts:58](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/types.d.ts#L58) +[types.d.ts:58](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/types.d.ts#L58) ___ @@ -120,7 +120,7 @@ ___ #### Defined in -[types.d.ts:59](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/types.d.ts#L59) +[types.d.ts:59](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/types.d.ts#L59) ___ @@ -132,7 +132,7 @@ A list of redactions - URIs to a redacted assertions #### Defined in -[types.d.ts:63](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/types.d.ts#L63) +[types.d.ts:63](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/types.d.ts#L63) ___ @@ -144,7 +144,7 @@ container for binary assets (like thumbnails) #### Defined in -[types.d.ts:67](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/types.d.ts#L67) +[types.d.ts:67](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/types.d.ts#L67) ___ @@ -156,7 +156,7 @@ Signature data (only used for reporting) #### Defined in -[types.d.ts:71](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/types.d.ts#L71) +[types.d.ts:71](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/types.d.ts#L71) ___ @@ -166,7 +166,7 @@ ___ #### Defined in -[types.d.ts:72](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/types.d.ts#L72) +[types.d.ts:72](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/types.d.ts#L72) ___ @@ -178,7 +178,7 @@ A human-readable title, generally source filename. #### Defined in -[types.d.ts:76](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/types.d.ts#L76) +[types.d.ts:76](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/types.d.ts#L76) ___ @@ -191,4 +191,4 @@ name for the vendor (i.e. `adobe`) #### Defined in -[types.d.ts:81](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/types.d.ts#L81) +[types.d.ts:81](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/types.d.ts#L81) diff --git a/docs/interfaces/types.ManifestAssertion.md b/docs/interfaces/types.ManifestAssertion.md index a84e595..28c6b2c 100644 --- a/docs/interfaces/types.ManifestAssertion.md +++ b/docs/interfaces/types.ManifestAssertion.md @@ -1,4 +1,4 @@ -[c2pa-node](../README.md) / [Exports](../modules.md) / [types](../modules/types.md) / ManifestAssertion +[c2pa-node](../README.md) / [types](../modules/types.md) / ManifestAssertion # Interface: ManifestAssertion @@ -29,7 +29,7 @@ The data of the assertion as Value #### Defined in -[types.d.ts:92](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/types.d.ts#L92) +[types.d.ts:92](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/types.d.ts#L92) ___ @@ -41,7 +41,7 @@ There can be more than one assertion for any label #### Defined in -[types.d.ts:96](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/types.d.ts#L96) +[types.d.ts:96](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/types.d.ts#L96) ___ @@ -53,7 +53,7 @@ The [ManifestAssertionKind] for this assertion (as stored in c2pa content) #### Defined in -[types.d.ts:100](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/types.d.ts#L100) +[types.d.ts:100](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/types.d.ts#L100) ___ @@ -65,4 +65,4 @@ An assertion label in reverse domain format #### Defined in -[types.d.ts:104](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/types.d.ts#L104) +[types.d.ts:104](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/types.d.ts#L104) diff --git a/docs/interfaces/types.ManifestStore.md b/docs/interfaces/types.ManifestStore.md index 7556ac5..4a45609 100644 --- a/docs/interfaces/types.ManifestStore.md +++ b/docs/interfaces/types.ManifestStore.md @@ -1,4 +1,4 @@ -[c2pa-node](../README.md) / [Exports](../modules.md) / [types](../modules/types.md) / ManifestStore +[c2pa-node](../README.md) / [types](../modules/types.md) / ManifestStore # Interface: ManifestStore @@ -28,7 +28,7 @@ A label for the active (most recent) manifest in the store #### Defined in -[types.d.ts:17](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/types.d.ts#L17) +[types.d.ts:17](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/types.d.ts#L17) ___ @@ -44,7 +44,7 @@ A HashMap of Manifests #### Defined in -[types.d.ts:21](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/types.d.ts#L21) +[types.d.ts:21](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/types.d.ts#L21) ___ @@ -56,4 +56,4 @@ ValidationStatus generated when loading the ManifestStore from an asset #### Defined in -[types.d.ts:25](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/types.d.ts#L25) +[types.d.ts:25](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/types.d.ts#L25) diff --git a/docs/interfaces/types.Metadata.md b/docs/interfaces/types.Metadata.md index a7d6123..ed640c7 100644 --- a/docs/interfaces/types.Metadata.md +++ b/docs/interfaces/types.Metadata.md @@ -1,4 +1,4 @@ -[c2pa-node](../README.md) / [Exports](../modules.md) / [types](../modules/types.md) / Metadata +[c2pa-node](../README.md) / [types](../modules/types.md) / Metadata # Interface: Metadata @@ -28,7 +28,7 @@ others #### Defined in -[types.d.ts:201](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/types.d.ts#L201) +[types.d.ts:201](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/types.d.ts#L201) ___ @@ -38,7 +38,7 @@ ___ #### Defined in -[types.d.ts:202](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/types.d.ts#L202) +[types.d.ts:202](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/types.d.ts#L202) ___ @@ -48,7 +48,7 @@ ___ #### Defined in -[types.d.ts:203](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/types.d.ts#L203) +[types.d.ts:203](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/types.d.ts#L203) ___ @@ -58,4 +58,4 @@ ___ #### Defined in -[types.d.ts:204](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/types.d.ts#L204) +[types.d.ts:204](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/types.d.ts#L204) diff --git a/docs/interfaces/types.ResourceRef.md b/docs/interfaces/types.ResourceRef.md index fa8ca7d..983170e 100644 --- a/docs/interfaces/types.ResourceRef.md +++ b/docs/interfaces/types.ResourceRef.md @@ -1,4 +1,4 @@ -[c2pa-node](../README.md) / [Exports](../modules.md) / [types](../modules/types.md) / ResourceRef +[c2pa-node](../README.md) / [types](../modules/types.md) / ResourceRef # Interface: ResourceRef @@ -25,7 +25,7 @@ A reference to a resource to be used in JSON serialization #### Defined in -[types.d.ts:191](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/types.d.ts#L191) +[types.d.ts:191](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/types.d.ts#L191) ___ @@ -35,4 +35,4 @@ ___ #### Defined in -[types.d.ts:192](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/types.d.ts#L192) +[types.d.ts:192](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/types.d.ts#L192) diff --git a/docs/interfaces/types.ResourceStore.md b/docs/interfaces/types.ResourceStore.md index ecaf291..08ae1d5 100644 --- a/docs/interfaces/types.ResourceStore.md +++ b/docs/interfaces/types.ResourceStore.md @@ -1,4 +1,4 @@ -[c2pa-node](../README.md) / [Exports](../modules.md) / [types](../modules/types.md) / ResourceStore +[c2pa-node](../README.md) / [types](../modules/types.md) / ResourceStore # Interface: ResourceStore @@ -27,7 +27,7 @@ container for binary assets (like thumbnails) #### Defined in -[types.d.ts:282](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/types.d.ts#L282) +[types.d.ts:282](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/types.d.ts#L282) ___ @@ -41,4 +41,4 @@ ___ #### Defined in -[types.d.ts:283](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/types.d.ts#L283) +[types.d.ts:283](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/types.d.ts#L283) diff --git a/docs/interfaces/types.ReviewRating.md b/docs/interfaces/types.ReviewRating.md index 002acbf..be4ea64 100644 --- a/docs/interfaces/types.ReviewRating.md +++ b/docs/interfaces/types.ReviewRating.md @@ -1,4 +1,4 @@ -[c2pa-node](../README.md) / [Exports](../modules.md) / [types](../modules/types.md) / ReviewRating +[c2pa-node](../README.md) / [types](../modules/types.md) / ReviewRating # Interface: ReviewRating @@ -29,7 +29,7 @@ See #### Defined in -[types.d.ts:260](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/types.d.ts#L260) +[types.d.ts:260](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/types.d.ts#L260) ___ @@ -39,7 +39,7 @@ ___ #### Defined in -[types.d.ts:261](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/types.d.ts#L261) +[types.d.ts:261](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/types.d.ts#L261) ___ @@ -49,4 +49,4 @@ ___ #### Defined in -[types.d.ts:262](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/types.d.ts#L262) +[types.d.ts:262](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/types.d.ts#L262) diff --git a/docs/interfaces/types.SignatureInfo.md b/docs/interfaces/types.SignatureInfo.md index b78bd2d..9df18e5 100644 --- a/docs/interfaces/types.SignatureInfo.md +++ b/docs/interfaces/types.SignatureInfo.md @@ -1,4 +1,4 @@ -[c2pa-node](../README.md) / [Exports](../modules.md) / [types](../modules/types.md) / SignatureInfo +[c2pa-node](../README.md) / [types](../modules/types.md) / SignatureInfo # Interface: SignatureInfo @@ -33,7 +33,7 @@ human readable issuing authority for this signature #### Defined in -[types.d.ts:308](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/types.d.ts#L308) +[types.d.ts:308](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/types.d.ts#L308) ___ @@ -45,4 +45,4 @@ the time the signature was created #### Defined in -[types.d.ts:312](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/types.d.ts#L312) +[types.d.ts:312](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/types.d.ts#L312) diff --git a/docs/interfaces/types.ValidationStatus.md b/docs/interfaces/types.ValidationStatus.md index f4c2530..3c7f2a1 100644 --- a/docs/interfaces/types.ValidationStatus.md +++ b/docs/interfaces/types.ValidationStatus.md @@ -1,4 +1,4 @@ -[c2pa-node](../README.md) / [Exports](../modules.md) / [types](../modules/types.md) / ValidationStatus +[c2pa-node](../README.md) / [types](../modules/types.md) / ValidationStatus # Interface: ValidationStatus @@ -30,7 +30,7 @@ See #### Defined in -[types.d.ts:295](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/types.d.ts#L295) +[types.d.ts:295](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/types.d.ts#L295) ___ @@ -40,7 +40,7 @@ ___ #### Defined in -[types.d.ts:296](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/types.d.ts#L296) +[types.d.ts:296](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/types.d.ts#L296) ___ @@ -50,4 +50,4 @@ ___ #### Defined in -[types.d.ts:297](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/types.d.ts#L297) +[types.d.ts:297](https://github.com/crandmck/c2pa-node/blob/34230bb/js-src/types.d.ts#L297) diff --git a/docs/modules.md b/docs/modules.md deleted file mode 100644 index c111aff..0000000 --- a/docs/modules.md +++ /dev/null @@ -1,216 +0,0 @@ -[c2pa-node](README.md) / Exports - -# c2pa-node - -## Table of contents - -### Namespaces - -- [types](modules/types.md) - -### Enumerations - -- [SigningAlgorithm](enums/SigningAlgorithm.md) - -### Classes - -- [ManifestBuilder](classes/ManifestBuilder.md) - -### Interfaces - -- [BufferAsset](interfaces/BufferAsset.md) -- [CreateIngredientProps](interfaces/CreateIngredientProps.md) -- [FileAsset](interfaces/FileAsset.md) -- [LocalSigner](interfaces/LocalSigner.md) -- [RemoteSigner](interfaces/RemoteSigner.md) -- [ResolvedIngredient](interfaces/ResolvedIngredient.md) -- [ResolvedManifest](interfaces/ResolvedManifest.md) -- [ResolvedManifestStore](interfaces/ResolvedManifestStore.md) -- [ResolvedResource](interfaces/ResolvedResource.md) -- [ResolvedSignatureInfo](interfaces/ResolvedSignatureInfo.md) -- [SignClaimBytesProps](interfaces/SignClaimBytesProps.md) -- [SignInput](interfaces/SignInput.md) -- [SignOptions](interfaces/SignOptions.md) -- [StorableIngredient](interfaces/StorableIngredient.md) -- [ThumbnailOptions](interfaces/ThumbnailOptions.md) - -### Type Aliases - -- [Asset](modules.md#asset) -- [BaseManifestDefinition](modules.md#basemanifestdefinition) -- [C2pa](modules.md#c2pa) -- [C2paOptions](modules.md#c2paoptions) -- [HashAlgorithm](modules.md#hashalgorithm) -- [IngredientResourceStore](modules.md#ingredientresourcestore) -- [SignOutput](modules.md#signoutput) -- [SignProps](modules.md#signprops) -- [Signer](modules.md#signer) - -### Functions - -- [createC2pa](modules.md#createc2pa) -- [createTestSigner](modules.md#createtestsigner) - -## Type Aliases - -### Asset - -Ƭ **Asset**: [`BufferAsset`](interfaces/BufferAsset.md) \| [`FileAsset`](interfaces/FileAsset.md) - -An asset that can either be in memory or on disk - -#### Defined in - -[bindings.ts:154](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/bindings.ts#L154) - -___ - -### BaseManifestDefinition - -Ƭ **BaseManifestDefinition**: `Omit`<`ManifestDefinition`, ``"thumbnail"`` \| ``"ingredients"``\> & `RequiredFields` - -#### Defined in - -[lib/manifestBuilder.ts:21](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/lib/manifestBuilder.ts#L21) - -___ - -### C2pa - -Ƭ **C2pa**: `ReturnType` & { `createIngredient`: `ReturnType` ; `read`: typeof `read` } - -#### Defined in - -[index.ts:28](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/index.ts#L28) - -___ - -### C2paOptions - -Ƭ **C2paOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `ingredientHashAlgorithm?` | [`HashAlgorithm`](modules.md#hashalgorithm) | -| `signer?` | [`Signer`](modules.md#signer) | -| `thumbnail?` | [`ThumbnailOptions`](interfaces/ThumbnailOptions.md) \| ``false`` \| ``null`` | - -#### Defined in - -[index.ts:18](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/index.ts#L18) - -___ - -### HashAlgorithm - -Ƭ **HashAlgorithm**: ``"sha256"`` \| ``"sha384"`` \| ``"sha512"`` - -#### Defined in - -[lib/hash.ts:17](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/lib/hash.ts#L17) - -___ - -### IngredientResourceStore - -Ƭ **IngredientResourceStore**: `Record`<`string`, `Buffer`\> - -#### Defined in - -[bindings.ts:353](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/bindings.ts#L353) - -___ - -### SignOutput - -Ƭ **SignOutput**<`AssetType`\>: `AssetType` extends [`BufferAsset`](interfaces/BufferAsset.md) ? `SignOutputData`<[`BufferAsset`](interfaces/BufferAsset.md)\> : `AssetType` extends [`FileAsset`](interfaces/FileAsset.md) ? `SignOutputData`<[`FileAsset`](interfaces/FileAsset.md)\> : `never` - -#### Type parameters - -| Name | -| :------ | -| `AssetType` | - -#### Defined in - -[bindings.ts:225](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/bindings.ts#L225) - -___ - -### SignProps - -Ƭ **SignProps**<`AssetType`\>: `Object` - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `AssetType` | extends [`Asset`](modules.md#asset) | - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `asset` | `AssetType` | -| `manifest` | [`ManifestBuilder`](classes/ManifestBuilder.md) | -| `options?` | [`SignOptions`](interfaces/SignOptions.md) | -| `signer?` | [`Signer`](modules.md#signer) | -| `thumbnail?` | [`BufferAsset`](interfaces/BufferAsset.md) \| ``false`` | - -#### Defined in - -[bindings.ts:201](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/bindings.ts#L201) - -___ - -### Signer - -Ƭ **Signer**: [`LocalSigner`](interfaces/LocalSigner.md) \| [`RemoteSigner`](interfaces/RemoteSigner.md) - -#### Defined in - -[lib/signer.ts:50](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/lib/signer.ts#L50) - -## Functions - -### createC2pa - -▸ **createC2pa**(`options?`): [`C2pa`](modules.md#c2pa) - -Creates an instance of the SDK that encompasses a set of global options - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `options?` | [`C2paOptions`](modules.md#c2paoptions) | Global options for the C2PA instance | - -#### Returns - -[`C2pa`](modules.md#c2pa) - -#### Defined in - -[index.ts:38](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/index.ts#L38) - -___ - -### createTestSigner - -▸ **createTestSigner**(`«destructured»?`): `Promise`<[`LocalSigner`](interfaces/LocalSigner.md)\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `«destructured»` | `TestSignerOptions` | `defaultTestSignerOptions` | - -#### Returns - -`Promise`<[`LocalSigner`](interfaces/LocalSigner.md)\> - -#### Defined in - -[lib/signer.ts:64](https://github.com/contentauth/c2pa-node/blob/fb1d732/js-src/lib/signer.ts#L64) diff --git a/docs/modules/types.md b/docs/modules/types.md index cfb1a79..227f82b 100644 --- a/docs/modules/types.md +++ b/docs/modules/types.md @@ -1,4 +1,4 @@ -[c2pa-node](../README.md) / [Exports](../modules.md) / types +[c2pa-node](../README.md) / types # Namespace: types diff --git a/package.json b/package.json index 06c119f..af06813 100644 --- a/package.json +++ b/package.json @@ -21,7 +21,7 @@ "build:rust": "cargo-cp-artifact -nc generated/c2pa.node -- cargo build --message-format=json-render-diagnostics --release", "build:ts": "tsc -b && cpy js-src/types.d.ts dist", "build:assets": "cpy src Cargo.* generated dist", - "build:docs": "typedoc --plugin typedoc-plugin-markdown --out docs js-src/index.ts", + "build:docs": "typedoc --plugin typedoc-plugin-markdown --readme none --out docs js-src/index.ts", "build": "run-s build:rust build:ts build:docs build:assets", "postinstall": "node ./scripts/postinstall.js", "download-test-certs": "node ./scripts/download-test-certs.js",