The JSON representation of the action
Add CBOR assertion to the builder
The label of the assertion
The assertion, should be a string if the type is JSON, otherwise a JS Object
OptionalassertionKind: ManifestAssertionKindThe type of assertion
Add an ingredient to the manifest
The JSON representation of the ingredient
Optionalingredient: SourceAssetOptional source asset (buffer or file) for the ingredient
Add an ingredient to the manifest from a Reader
The Reader object of the ingredient
Redact an assertion from an ingredient manifest and record the reason.
Adds the URI to definition.redactions and appends a c2pa.redacted action
with parameters.redacted pointing to the same URI.
JUMBF URI of the assertion to redact (e.g. self#jumbf=/c2pa/{label}/c2pa.assertions/{name})
Why the assertion is being redacted. Use "c2pa.PII.present" for PII removal.
Add a resource from a buffer or file
The URI of the resource
The source and format of the resource
Get the internal handle for use with Neon bindings
Getter for the builder's manifest definition
The manifest definition
An intent lets the API know what kind of manifest to create.
Intents are Create, Edit, or Update.
This allows the API to check that you are doing the right thing.
It can also do things for you, like add parent ingredients from the source asset
and automatically add required c2pa.created or c2pa.opened actions.
Create requires a DigitalSourceType. It is used for assets without a parent ingredient.
Edit requires a parent ingredient and is used for most assets that are being edited.
Update is a special case with many restrictions but is more compact than Edit.
The intent of the manifest
Set the no embed flag of the manifest
The no embed flag of the manifest
Set the remote URL of the manifest
Sign an asset from a buffer or file
The local signer to use
the bytes of the c2pa_manifest that was embedded
Sign an asset from a buffer or file asynchronously, using a CallbackSigner
the bytes of the c2pa_manifest that was embedded
Sign an asset from a buffer or file asynchronously, using a callback and not passing a private key
The callback function to sign the asset
The configuration for the signer
the bytes of the c2pa_manifest that was embedded
Produce a signed embeddable manifest from a pre-computed DataHash.
Unlike sign, this does not require the asset bytes at sign time —
the caller has already computed the hash externally. The returned
manifest binary can be embedded by the caller, or shipped as a sidecar
/ referenced via a remote-manifest URL.
Typical use: sidecar / remote-manifest signing where only the SHA-256 digest of
the asset is available. With exclusions: [] and alg: "sha256",
c2pa.hash.data.hash in the resulting manifest equals SHA-256(asset),
which a verifier can recompute from the original file.
The local signer
The pre-computed data hash
MIME type of the target asset (e.g. "image/jpeg")
The signed c2pa_manifest bytes (preformatted for format)
Async variant of signDataHashedEmbeddable that uses a CallbackSigner
(e.g. for KMS-backed or otherwise asynchronous signing).
The callback signer
The pre-computed data hash
MIME type of the target asset
The signed c2pa_manifest bytes
Embed a signed manifest into a stream using the LocalSigner
The local signer to use
the bytes of the c2pa_manifest that was embedded
Convert the Builder into a archive formatted buffer or file
The file or buffer for the archive
Update a string property of the manifest
The manifest definition
StaticfromOptionalsettings: C2paSettingsStaticnewOptionalsettings: C2paSettingsStaticwithOptionalsettings: C2paSettings
Add a single action to the manifest. This is a convenience method for adding an action to the
Actionsassertion.