@contentauth/c2pa-types 0.4.1 → 0.4.3

package/dist/types/ManifestStore.d.ts

@@ -0,0 +1,740 @@
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+export type UriOrResource = ResourceRef | HashedUri;
+export type DateT = string;
+/**
+ * A role describing the region.
+ */
+export type Role = "c2pa.areaOfInterest" | "c2pa.cropped" | "c2pa.edited" | "c2pa.placed" | "c2pa.redacted" | "c2pa.subjectArea" | "c2pa.deleted" | "c2pa.styled" | "c2pa.watermarked";
+/**
+ * Assertions in C2PA can be stored in several formats
+ */
+export type ManifestAssertionKind = "Cbor" | "Json" | "Binary" | "Uri";
+/**
+ * Describes the digital signature algorithms allowed by the C2PA spec.
+ *
+ * Per [§13.2, “Digital Signatures”]:
+ *
+ * > All digital signatures applied as per the technical requirements of this
+ * > specification shall be generated using one of the digital signature
+ * > algorithms and key types listed as described in this section.
+ *
+ * [§13.2, “Digital Signatures”]: https://spec.c2pa.org/specifications/specifications/2.3/specs/C2PA_Specification.html#_digital_signatures
+ */
+export type SigningAlg = "Es256" | "Es384" | "Es512" | "Ps256" | "Ps384" | "Ps512" | "Ed25519";
+/**
+ * Represents the levels of assurance a manifest store achives when evaluated against the C2PA
+ * specifications structural, cryptographic, and trust requirements.
+ *
+ * See [Validation states - C2PA Technical Specification](https://spec.c2pa.org/specifications/specifications/2.3/specs/C2PA_Specification.html#_validation_states).
+ */
+export type ValidationState = "Invalid" | "Valid" | "Trusted";
+/**
+ * Use a Reader to read and validate a manifest store.
+ */
+export interface Reader {
+    /**
+     * A label for the active (most recent) manifest in the store
+     */
+    active_manifest?: string | null;
+    /**
+     * A HashMap of Manifests
+     */
+    manifests?: {
+        [k: string]: Manifest;
+    };
+    /**
+     * ValidationStatus generated when loading the ManifestStore from an asset
+     */
+    validation_status?: ValidationStatus[] | null;
+    /**
+     * ValidationStatus generated when loading the ManifestStore from an asset
+     */
+    validation_results?: ValidationResults | null;
+    /**
+     * The validation state of the manifest store
+     */
+    validation_state?: ValidationState | null;
+    [k: string]: unknown;
+}
+/**
+ * A Manifest represents all the information in a c2pa manifest
+ */
+export interface Manifest {
+    /**
+     * Optional prefix added to the generated Manifest label.
+     * This is typically an internet domain name for the vendor (i.e. `adobe`).
+     */
+    vendor?: string | null;
+    /**
+     * A User Agent formatted string identifying the software/hardware/system produced this claim
+     * Spaces are not allowed in names, versions can be specified with product/1.0 syntax.
+     */
+    claim_generator?: string | null;
+    /**
+     * A list of claim generator info data identifying the software/hardware/system produced this claim.
+     */
+    claim_generator_info?: ClaimGeneratorInfo[] | null;
+    /**
+     * A list of user metadata for this claim.
+     */
+    metadata?: AssertionMetadata[] | null;
+    /**
+     * A human-readable title, generally source filename.
+     */
+    title?: string | null;
+    /**
+     * The format of the source file as a MIME type.
+     */
+    format?: string | null;
+    /**
+     * Instance ID from `xmpMM:InstanceID` in XMP metadata.
+     */
+    instance_id?: string;
+    thumbnail?: ResourceRef | null;
+    /**
+     * A List of ingredients
+     */
+    ingredients?: Ingredient[];
+    /**
+     * A List of verified credentials
+     */
+    credentials?: unknown[] | null;
+    /**
+     * A list of assertions
+     */
+    assertions?: ManifestAssertion[];
+    /**
+     * A list of redactions - URIs to a redacted assertions
+     */
+    redactions?: string[] | null;
+    /**
+     * Signature data (only used for reporting)
+     */
+    signature_info?: SignatureInfo | null;
+    label?: string | null;
+    /**
+     * The version of the claim, parsed from the claim label.
+     *
+     * For example:
+     * - `c2pa.claim.v2` -> 2
+     * - `c2pa.claim` -> 1
+     */
+    claim_version?: number | null;
+    [k: string]: unknown;
+}
+/**
+ * Description of the claim generator, or the software used in generating the claim.
+ *
+ * This structure is also used for actions softwareAgent
+ */
+export interface ClaimGeneratorInfo {
+    /**
+     * A human readable string naming the claim_generator
+     */
+    name: string;
+    /**
+     * A human readable string of the product's version
+     */
+    version?: string | null;
+    /**
+     * hashed URI to the icon (either embedded or remote)
+     */
+    icon?: UriOrResource | null;
+    /**
+     * A human readable string of the OS the claim generator is running on
+     */
+    operating_system?: string | null;
+    [k: string]: unknown;
+}
+/**
+ * A reference to a resource to be used in JSON serialization.
+ *
+ * The underlying data can be read as a stream via [`Reader::resource_to_stream`][crate::Reader::resource_to_stream].
+ */
+export interface ResourceRef {
+    /**
+     * The mime type of the referenced resource.
+     */
+    format: string;
+    /**
+     * A URI that identifies the resource as referenced from the manifest.
+     *
+     * This may be a JUMBF URI, a file path, a URL or any other string.
+     * Relative JUMBF URIs will be resolved with the manifest label.
+     * Relative file paths will be resolved with the base path if provided.
+     */
+    identifier: string;
+    /**
+     * More detailed data types as defined in the C2PA spec.
+     */
+    data_types?: AssetType[] | null;
+    /**
+     * The algorithm used to hash the resource (if applicable).
+     */
+    alg?: string | null;
+    /**
+     * The hash of the resource (if applicable).
+     */
+    hash?: string | null;
+    [k: string]: unknown;
+}
+export interface AssetType {
+    type: string;
+    version?: string | null;
+    [k: string]: unknown;
+}
+/**
+ * A `HashedUri` provides a reference to content available within the same
+ * manifest store.
+ *
+ * This is described in [URI References in the C2PA Technical
+ * Specification](https://spec.c2pa.org/specifications/specifications/2.3/specs/C2PA_Specification.html#_uri_references).
+ */
+export interface HashedUri {
+    /**
+     * JUMBF URI reference
+     */
+    url: string;
+    /**
+     * A string identifying the cryptographic hash algorithm used to compute
+     * the hash
+     */
+    alg?: string | null;
+    /**
+     * Byte string containing the hash value
+     */
+    hash: number[];
+    [k: string]: unknown;
+}
+/**
+ * The AssertionMetadata structure can be used as part of other assertions or on its own to reference others
+ */
+export interface AssertionMetadata {
+    reviewRatings?: ReviewRating[] | null;
+    dateTime?: DateT | null;
+    reference?: HashedUri | null;
+    dataSource?: DataSource | null;
+    localizations?: {
+        [k: string]: {
+            [k: string]: string;
+        };
+    }[] | null;
+    regionOfInterest?: RegionOfInterest | null;
+    [k: string]: unknown;
+}
+/**
+ * A rating on an Assertion.
+ *
+ * See [C2PA Specification - Review Ratings](https://spec.c2pa.org/specifications/specifications/2.3/specs/C2PA_Specification.html#_review_ratings).
+ */
+export interface ReviewRating {
+    explanation: string;
+    code?: string | null;
+    value: number;
+    [k: string]: unknown;
+}
+/**
+ * A description of the source for assertion data
+ */
+export interface DataSource {
+    /**
+     * A value from among the enumerated list indicating the source of the assertion.
+     */
+    type: string;
+    /**
+     * A human-readable string giving details about the source of the assertion data.
+     */
+    details?: string | null;
+    /**
+     * A list of [`Actor`]s associated with this source.
+     */
+    actors?: Actor[] | null;
+    [k: string]: unknown;
+}
+/**
+ * Identifies a person responsible for an action.
+ */
+export interface Actor {
+    /**
+     * An identifier for a human actor, used when the "type" is `humanEntry.identified`.
+     */
+    identifier?: string | null;
+    /**
+     * List of references to W3C Verifiable Credentials.
+     */
+    credentials?: HashedUri[] | null;
+    [k: string]: unknown;
+}
+/**
+ * A region of interest within an asset describing the change.
+ *
+ * This struct can be used from [`Action::changes`][crate::assertions::Action::changes],
+ * [`AssertionMetadata::region_of_interest`][crate::assertions::AssertionMetadata::region_of_interest], or
+ * [`SoftBindingScope::region`][crate::assertions::soft_binding::SoftBindingScope::region].
+ */
+export interface RegionOfInterest {
+    /**
+     * A range describing the region of interest for the specific asset.
+     */
+    region: Range[];
+    /**
+     * A free-text string representing a human-readable name for the region which might be used in a user interface.
+     */
+    name?: string | null;
+    /**
+     * A free-text string representing a machine-readable, unique to this assertion, identifier for the region.
+     */
+    identifier?: string | null;
+    /**
+     * A value from a controlled vocabulary such as <https://cv.iptc.org/newscodes/imageregiontype/> or an entity-specific
+     * value (e.g., com.litware.newType) that represents the type of thing(s) depicted by a region.
+     *
+     * Note this field serializes/deserializes into the name `type`.
+     */
+    type?: string | null;
+    /**
+     * A value from our controlled vocabulary or an entity-specific value (e.g., com.litware.coolArea) that represents
+     * the role of a region among other regions.
+     */
+    role?: Role | null;
+    /**
+     * A free-text string.
+     */
+    description?: string | null;
+    /**
+     * Additional information about the asset.
+     */
+    metadata?: AssertionMetadata | null;
+    [k: string]: unknown;
+}
+/**
+ * A spatial, temporal, frame, or textual range describing the region of interest.
+ */
+export interface Range {
+    /**
+     * The type of range of interest.
+     */
+    type: "spatial" | "temporal" | "frame" | "textual" | "identified";
+    /**
+     * A spatial range.
+     */
+    shape?: Shape | null;
+    /**
+     * A temporal range.
+     */
+    time?: Time | null;
+    /**
+     * A frame range.
+     */
+    frame?: Frame | null;
+    /**
+     * A textual range.
+     */
+    text?: Text | null;
+    /**
+     * A item identifier.
+     */
+    item?: Item | null;
+    [k: string]: unknown;
+}
+/**
+ * A spatial range representing rectangle, circle, or a polygon.
+ */
+export interface Shape {
+    /**
+     * The type of shape.
+     */
+    type: "rectangle" | "circle" | "polygon";
+    /**
+     * The type of unit for the shape range.
+     */
+    unit: "pixel" | "percent";
+    origin: Coordinate;
+    /**
+     * The width for rectangles or diameter for circles.
+     *
+     * This field can be ignored for polygons.
+     */
+    width?: number | null;
+    /**
+     * The height of a rectnagle.
+     *
+     * This field can be ignored for circles and polygons.
+     */
+    height?: number | null;
+    /**
+     * If the range is inside the shape.
+     *
+     * The default value is true.
+     */
+    inside?: boolean | null;
+    /**
+     * The vertices of the polygon.
+     *
+     * This field can be ignored for rectangles and circles.
+     */
+    vertices?: Coordinate1[] | null;
+    [k: string]: unknown;
+}
+/**
+ * THe origin of the coordinate in the shape.
+ */
+export interface Coordinate {
+    /**
+     * The coordinate along the x-axis.
+     */
+    x: number;
+    /**
+     * The coordinate along the y-axis.
+     */
+    y: number;
+    [k: string]: unknown;
+}
+/**
+ * An x, y coordinate used for specifying vertices in polygons.
+ */
+export interface Coordinate1 {
+    /**
+     * The coordinate along the x-axis.
+     */
+    x: number;
+    /**
+     * The coordinate along the y-axis.
+     */
+    y: number;
+    [k: string]: unknown;
+}
+/**
+ * A temporal range representing a starting time to an ending time.
+ */
+export interface Time {
+    /**
+     * The type of time.
+     */
+    type?: "npt";
+    /**
+     * The start time or the start of the asset if not present.
+     */
+    start?: string | null;
+    /**
+     * The end time or the end of the asset if not present.
+     */
+    end?: string | null;
+    [k: string]: unknown;
+}
+/**
+ * A frame range representing starting and ending frames or pages.
+ *
+ * If both `start` and `end` are missing, the frame will span the entire asset.
+ */
+export interface Frame {
+    /**
+     * The start of the frame or the end of the asset if not present.
+     *
+     * The first frame/page starts at 0.
+     */
+    start?: number | null;
+    /**
+     * The end of the frame inclusive or the end of the asset if not present.
+     */
+    end?: number | null;
+    [k: string]: unknown;
+}
+/**
+ * A textual range representing multiple (possibly discontinuous) ranges of text.
+ */
+export interface Text {
+    /**
+     * The ranges of text to select.
+     */
+    selectors: TextSelectorRange[];
+    [k: string]: unknown;
+}
+/**
+ * One or two [`TextSelector`][TextSelector] identifiying the range to select.
+ */
+export interface TextSelectorRange {
+    selector: TextSelector;
+    /**
+     * The end of the text range.
+     */
+    end?: TextSelector1 | null;
+    [k: string]: unknown;
+}
+/**
+ * The start (or entire) text range.
+ */
+export interface TextSelector {
+    /**
+     * Fragment identifier as per RFC3023 (XML) or ISO 32000-2 (PDF), Annex O.
+     */
+    fragment: string;
+    /**
+     * The start character offset or the start of the fragment if not present.
+     */
+    start?: number | null;
+    /**
+     * The end character offset or the end of the fragment if not present.
+     */
+    end?: number | null;
+    [k: string]: unknown;
+}
+/**
+ * Selects a range of text via a fragment identifier.
+ *
+ * This is modeled after the W3C Web Annotation selector model.
+ */
+export interface TextSelector1 {
+    /**
+     * Fragment identifier as per RFC3023 (XML) or ISO 32000-2 (PDF), Annex O.
+     */
+    fragment: string;
+    /**
+     * The start character offset or the start of the fragment if not present.
+     */
+    start?: number | null;
+    /**
+     * The end character offset or the end of the fragment if not present.
+     */
+    end?: number | null;
+    [k: string]: unknown;
+}
+/**
+ * Description of the boundaries of an identified range.
+ */
+export interface Item {
+    /**
+     * The container-specific term used to identify items, such as "track_id" for MP4 or "item_ID" for HEIF.
+     */
+    identifier: string;
+    /**
+     * The value of the identifier, e.g. a value of "2" for an identifier of "track_id" would imply track 2 of the asset.
+     */
+    value: string;
+    [k: string]: unknown;
+}
+/**
+ * An `Ingredient` is any external asset that has been used in the creation of an asset.
+ */
+export interface Ingredient {
+    /**
+     * A human-readable title, generally source filename.
+     */
+    title?: string | null;
+    /**
+     * The format of the source file as a MIME type.
+     */
+    format?: string | null;
+    /**
+     * Document ID from `xmpMM:DocumentID` in XMP metadata.
+     */
+    document_id?: string | null;
+    /**
+     * Instance ID from `xmpMM:InstanceID` in XMP metadata.
+     */
+    instance_id?: string | null;
+    /**
+     * URI from `dcterms:provenance` in XMP metadata.
+     */
+    provenance?: string | null;
+    /**
+     * A thumbnail image capturing the visual state at the time of import.
+     *
+     * A tuple of thumbnail MIME format (for example `image/jpeg`) and binary bits of the image.
+     */
+    thumbnail?: ResourceRef | null;
+    /**
+     * An optional hash of the asset to prevent duplicates.
+     */
+    hash?: string | null;
+    /**
+     * Set to `ParentOf` if this is the parent ingredient.
+     *
+     * There can only be one parent ingredient in the ingredients.
+     */
+    relationship?: "parentOf" | "componentOf" | "inputTo";
+    /**
+     * The active manifest label (if one exists).
+     *
+     * If this ingredient has a [`ManifestStore`],
+     * this will hold the label of the active [`Manifest`].
+     *
+     * [`Manifest`]: crate::Manifest
+     * [`ManifestStore`]: crate::ManifestStore
+     */
+    active_manifest?: string | null;
+    /**
+     * Validation status (Ingredient v1 & v2)
+     */
+    validation_status?: ValidationStatus[] | null;
+    /**
+     * Validation results (Ingredient.V3)
+     */
+    validation_results?: ValidationResults | null;
+    /**
+     * A reference to the actual data of the ingredient.
+     */
+    data?: ResourceRef | null;
+    /**
+     * Additional description of the ingredient.
+     */
+    description?: string | null;
+    /**
+     * URI to an informational page about the ingredient or its data.
+     */
+    informational_URI?: string | null;
+    /**
+     * Any additional [`Metadata`] as defined in the C2PA spec.
+     *
+     * [`Metadata`]: crate::Metadata
+     */
+    metadata?: AssertionMetadata | null;
+    /**
+     * Additional information about the data's type to the ingredient V2 structure.
+     */
+    data_types?: AssetType[] | null;
+    /**
+     * A [`ManifestStore`] from the source asset extracted as a binary C2PA blob.
+     *
+     * [`ManifestStore`]: crate::ManifestStore
+     */
+    manifest_data?: ResourceRef | null;
+    /**
+     * The ingredient's label as assigned in the manifest.
+     */
+    label?: string | null;
+    ocsp_responses?: ResourceRef[] | null;
+    [k: string]: unknown;
+}
+/**
+ * A `ValidationStatus` struct describes the validation status of a
+ * specific part of a manifest.
+ *
+ * See [Existing Manifests - C2PA Technical Specification](https://spec.c2pa.org/specifications/specifications/2.3/specs/C2PA_Specification.html#_existing_manifests).
+ */
+export interface ValidationStatus {
+    code: string;
+    url?: string | null;
+    explanation?: string | null;
+    success?: boolean | null;
+    [k: string]: unknown;
+}
+/**
+ * A map of validation results for a manifest store.
+ *
+ * The map contains the validation results for the active manifest and any ingredient deltas.
+ * It is normal for there to be many
+ */
+export interface ValidationResults {
+    /**
+     * Validation status codes for the ingredient's active manifest. Present if ingredient is a C2PA
+     * asset. Not present if the ingredient is not a C2PA asset.
+     */
+    activeManifest?: StatusCodes | null;
+    /**
+     * List of any changes/deltas between the current and previous validation results for each ingredient's
+     * manifest. Present if the the ingredient is a C2PA asset.
+     */
+    ingredientDeltas?: IngredientDeltaValidationResult[] | null;
+    [k: string]: unknown;
+}
+/**
+ * Contains a set of success, informational, and failure validation status codes.
+ */
+export interface StatusCodes {
+    /**
+     * An array of validation success codes. May be empty.
+     */
+    success: ValidationStatus[];
+    /**
+     * An array of validation informational codes. May be empty.
+     */
+    informational: ValidationStatus[];
+    failure: ValidationStatus[];
+    [k: string]: unknown;
+}
+/**
+ * Represents any changes or deltas between the current and previous validation results for an ingredient's manifest.
+ */
+export interface IngredientDeltaValidationResult {
+    /**
+     * JUMBF URI reference to the ingredient assertion
+     */
+    ingredientAssertionURI: string;
+    validationDeltas: StatusCodes1;
+    [k: string]: unknown;
+}
+/**
+ * Contains a set of success, informational, and failure validation status codes.
+ */
+export interface StatusCodes1 {
+    /**
+     * An array of validation success codes. May be empty.
+     */
+    success: ValidationStatus[];
+    /**
+     * An array of validation informational codes. May be empty.
+     */
+    informational: ValidationStatus[];
+    failure: ValidationStatus[];
+    [k: string]: unknown;
+}
+/**
+ * A labeled container for an Assertion value in a Manifest
+ */
+export interface ManifestAssertion {
+    /**
+     * An assertion label in reverse domain format
+     */
+    label: string;
+    data: unknown;
+    /**
+     * There can be more than one assertion for any label
+     */
+    instance?: number | null;
+    /**
+     * The [ManifestAssertionKind] for this assertion (as stored in c2pa content)
+     */
+    kind?: ManifestAssertionKind | null;
+    /**
+     * True if this assertion is attributed to the signer
+     * This maps to a created vs a gathered assertion. (defaults to false)
+     */
+    created?: boolean;
+    [k: string]: unknown;
+}
+/**
+ * Holds information about a signature
+ */
+export interface SignatureInfo {
+    /**
+     * Human-readable issuing authority for this signature.
+     */
+    alg?: SigningAlg | null;
+    /**
+     * Human-readable issuing authority for this signature.
+     */
+    issuer?: string | null;
+    /**
+     * Human-readable for common name of this certificate.
+     */
+    common_name?: string | null;
+    /**
+     * The serial number of the certificate.
+     */
+    cert_serial_number?: string | null;
+    /**
+     * The time the signature was created.
+     */
+    time?: string | null;
+    /**
+     * Revocation status of the certificate.
+     */
+    revocation_status?: boolean | null;
+    [k: string]: unknown;
+}
+//# sourceMappingURL=ManifestStore.d.ts.map