@contentauth/c2pa-types 0.3.1 → 0.4.1

package/types/Ingredient.d.ts

@@ -6,22 +6,6 @@
  */
 
 export type DateT = string;
-/**
- * The type of shape for the range.
- */
-export type ShapeType = "rectangle" | "circle" | "polygon";
-/**
- * The type of unit for the range.
- */
-export type UnitType = "pixel" | "percent";
-/**
- * The type of time.
- */
-export type TimeType = "npt";
-/**
- * The type of range for the region of interest.
- */
-export type RangeType = "spatial" | "temporal" | "frame" | "textual" | "identified";
 /**
  * A role describing the region.
  */
@@ -35,101 +19,98 @@ export type Role =
   | "c2pa.deleted"
   | "c2pa.styled"
   | "c2pa.watermarked";
-/**
- * The relationship of the ingredient to the current asset.
- */
-export type Relationship = "parentOf" | "componentOf" | "inputTo";
 
 /**
  * An `Ingredient` is any external asset that has been used in the creation of an asset.
  */
 export interface Ingredient {
   /**
-   * 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
+   * A human-readable title, generally source filename.
    */
-  active_manifest?: string | null;
+  title?: string | null;
   /**
-   * A reference to the actual data of the ingredient.
+   * The format of the source file as a MIME type.
    */
-  data?: ResourceRef | null;
+  format?: string | null;
   /**
-   * Additional information about the data's type to the ingredient V2 structure.
+   * Document ID from `xmpMM:DocumentID` in XMP metadata.
    */
-  data_types?: AssetType[] | null;
+  document_id?: string | null;
   /**
-   * Additional description of the ingredient.
+   * Instance ID from `xmpMM:InstanceID` in XMP metadata.
    */
-  description?: string | null;
+  instance_id?: string | null;
   /**
-   * Document ID from `xmpMM:DocumentID` in XMP metadata.
+   * URI from `dcterms:provenance` in XMP metadata.
    */
-  document_id?: string | null;
+  provenance?: string | null;
   /**
-   * The format of the source file as a MIME type.
+   * 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.
    */
-  format?: string | null;
+  thumbnail?: ResourceRef | null;
   /**
    * An optional hash of the asset to prevent duplicates.
    */
   hash?: string | null;
   /**
-   * URI to an informational page about the ingredient or its data.
+   * Set to `ParentOf` if this is the parent ingredient.
+   *
+   * There can only be one parent ingredient in the ingredients.
    */
-  informational_URI?: string | null;
+  relationship?: "parentOf" | "componentOf" | "inputTo";
   /**
-   * Instance ID from `xmpMM:InstanceID` in XMP metadata.
+   * 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
    */
-  instance_id?: string | null;
+  active_manifest?: string | null;
   /**
-   * The ingredient's label as assigned in the manifest.
+   * Validation status (Ingredient v1 & v2)
    */
-  label?: string | null;
+  validation_status?: ValidationStatus[] | null;
   /**
-   * A [`ManifestStore`] from the source asset extracted as a binary C2PA blob.
-   *
-   * [`ManifestStore`]: crate::ManifestStore
+   * Validation results (Ingredient.V3)
    */
-  manifest_data?: ResourceRef | null;
+  validation_results?: ValidationResults | null;
   /**
-   * Any additional [`Metadata`] as defined in the C2PA spec.
-   *
-   * [`Metadata`]: crate::Metadata
+   * A reference to the actual data of the ingredient.
    */
-  metadata?: AssertionMetadata | null;
-  ocsp_responses?: ResourceRef[] | null;
+  data?: ResourceRef | null;
   /**
-   * URI from `dcterms:provenance` in XMP metadata.
+   * Additional description of the ingredient.
    */
-  provenance?: string | null;
+  description?: string | null;
   /**
-   * Set to `ParentOf` if this is the parent ingredient.
-   *
-   * There can only be one parent ingredient in the ingredients.
+   * URI to an informational page about the ingredient or its data.
    */
-  relationship?: Relationship & string;
-  resources?: ResourceStore;
+  informational_URI?: string | null;
   /**
-   * A thumbnail image capturing the visual state at the time of import.
+   * Any additional [`Metadata`] as defined in the C2PA spec.
    *
-   * A tuple of thumbnail MIME format (for example `image/jpeg`) and binary bits of the image.
+   * [`Metadata`]: crate::Metadata
    */
-  thumbnail?: ResourceRef | null;
+  metadata?: AssertionMetadata | null;
   /**
-   * A human-readable title, generally source filename.
+   * Additional information about the data's type to the ingredient V2 structure.
    */
-  title?: string | null;
+  data_types?: AssetType[] | null;
   /**
-   * Validation results (Ingredient.V3)
+   * A [`ManifestStore`] from the source asset extracted as a binary C2PA blob.
+   *
+   * [`ManifestStore`]: crate::ManifestStore
    */
-  validation_results?: ValidationResults | null;
+  manifest_data?: ResourceRef | null;
   /**
-   * Validation status (Ingredient v1 & v2)
+   * The ingredient's label as assigned in the manifest.
    */
-  validation_status?: ValidationStatus[] | null;
+  label?: string | null;
+  ocsp_responses?: ResourceRef[] | null;
   [k: string]: unknown;
 }
 /**
@@ -139,27 +120,29 @@ export interface Ingredient {
  */
 export interface ResourceRef {
   /**
-   * The algorithm used to hash the resource (if applicable).
+   * The mime type of the referenced resource.
    */
-  alg?: string | null;
+  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 mime type of the referenced resource.
+   * The algorithm used to hash the resource (if applicable).
    */
-  format: string;
+  alg?: string | null;
   /**
    * The hash of the resource (if applicable).
    */
   hash?: string | null;
-  /**
-   * 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;
   [k: string]: unknown;
 }
 export interface AssetType {
@@ -167,12 +150,87 @@ export interface AssetType {
   version?: string | null;
   [k: string]: unknown;
 }
+/**
+ * A `ValidationStatus` struct describes the validation status of a
+ * specific part of a manifest.
+ *
+ * See <https://c2pa.org/specifications/specifications/2.2/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;
+}
 /**
  * The AssertionMetadata structure can be used as part of other assertions or on its own to reference others
  */
 export interface AssertionMetadata {
-  dataSource?: DataSource | null;
+  reviewRatings?: ReviewRating[] | null;
   dateTime?: DateT | null;
+  reference?: HashedUri | null;
+  dataSource?: DataSource | null;
   localizations?:
     | {
         [k: string]: {
@@ -180,101 +238,117 @@ export interface AssertionMetadata {
         };
       }[]
     | null;
-  reference?: HashedUri | null;
   regionOfInterest?: RegionOfInterest | null;
-  reviewRatings?: ReviewRating[] | null;
   [k: string]: unknown;
 }
 /**
- * A description of the source for assertion data
+ * A rating on an Assertion.
+ *
+ * See <https://c2pa.org/specifications/specifications/2.2/specs/C2PA_Specification.html#_review_ratings>.
  */
-export interface DataSource {
+export interface ReviewRating {
+  explanation: string;
+  code?: string | null;
+  value: number;
+  [k: string]: unknown;
+}
+/**
+ * A `HashedUri` provides a reference to content available within the same
+ * manifest store.
+ *
+ * This is described in [§8.3, URI References], of the C2PA Technical
+ * Specification.
+ *
+ * [§8.3, URI References]: https://c2pa.org/specifications/specifications/2.1/specs/C2PA_Specification.html#_uri_references
+ */
+export interface HashedUri {
   /**
-   * A list of [`Actor`]s associated with this source.
+   * JUMBF URI reference
    */
-  actors?: Actor[] | null;
+  url: string;
   /**
-   * A human-readable string giving details about the source of the assertion data.
+   * A string identifying the cryptographic hash algorithm used to compute
+   * the hash
    */
-  details?: string | null;
+  alg?: string | null;
   /**
-   * A value from among the enumerated list indicating the source of the assertion.
+   * Byte string containing the hash value
    */
-  type: string;
+  hash: number[];
   [k: string]: unknown;
 }
 /**
- * Identifies a person responsible for an action.
+ * A description of the source for assertion data
  */
-export interface Actor {
+export interface DataSource {
   /**
-   * List of references to W3C Verifiable Credentials.
+   * A value from among the enumerated list indicating the source of the assertion.
    */
-  credentials?: HashedUri[] | null;
+  type: string;
   /**
-   * An identifier for a human actor, used when the "type" is `humanEntry.identified`.
+   * A human-readable string giving details about the source of the assertion data.
    */
-  identifier?: string | null;
+  details?: string | null;
+  /**
+   * A list of [`Actor`]s associated with this source.
+   */
+  actors?: Actor[] | null;
   [k: string]: unknown;
 }
 /**
- * A `HashedUri` provides a reference to content available within the same manifest store.
- *
- * This is described in [§8.3, URI References], of the C2PA Technical Specification.
- *
- * [§8.3, URI References]: https://c2pa.org/specifications/specifications/2.1/specs/C2PA_Specification.html#_uri_references
+ * Identifies a person responsible for an action.
  */
-export interface HashedUri {
-  /**
-   * A string identifying the cryptographic hash algorithm used to compute the hash
-   */
-  alg?: string | null;
+export interface Actor {
   /**
-   * Byte string containing the hash value
+   * An identifier for a human actor, used when the "type" is `humanEntry.identified`.
    */
-  hash: number[];
+  identifier?: string | null;
   /**
-   * JUMBF URI reference
+   * List of references to W3C Verifiable Credentials.
    */
-  url: string;
+  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].
+ * 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 free-text string.
+   * A range describing the region of interest for the specific asset.
    */
-  description?: string | null;
+  region: Range[];
   /**
-   * A free-text string representing a machine-readable, unique to this assertion, identifier for the region.
+   * A free-text string representing a human-readable name for the region which might be used in a user interface.
    */
-  identifier?: string | null;
+  name?: string | null;
   /**
-   * Additional information about the asset.
+   * A free-text string representing a machine-readable, unique to this assertion, identifier for the region.
    */
-  metadata?: AssertionMetadata | null;
+  identifier?: string | null;
   /**
-   * A free-text string representing a human-readable name for the region which might be used in a user interface.
+   * 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`.
    */
-  name?: string | null;
+  type?: string | null;
   /**
-   * A range describing the region of interest for the specific asset.
+   * 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.
    */
-  region: Range[];
+  role?: Role | 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.
+   * A free-text string.
    */
-  role?: Role | null;
+  description?: 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`.
+   * Additional information about the asset.
    */
-  type?: string | null;
+  metadata?: AssertionMetadata | null;
   [k: string]: unknown;
 }
 /**
@@ -282,67 +356,50 @@ export interface RegionOfInterest {
  */
 export interface Range {
   /**
-   * A frame range.
-   */
-  frame?: Frame | null;
-  /**
-   * A item identifier.
+   * The type of range of interest.
    */
-  item?: Item | null;
+  type: "spatial" | "temporal" | "frame" | "textual" | "identified";
   /**
    * A spatial range.
    */
   shape?: Shape | null;
-  /**
-   * A textual range.
-   */
-  text?: Text | null;
   /**
    * A temporal range.
    */
   time?: Time | null;
   /**
-   * The type of range of interest.
+   * A frame range.
    */
-  type: RangeType;
-  [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 {
+  frame?: Frame | null;
   /**
-   * The end of the frame inclusive or the end of the asset if not present.
+   * A textual range.
    */
-  end?: number | null;
+  text?: Text | null;
   /**
-   * The start of the frame or the end of the asset if not present.
-   *
-   * The first frame/page starts at 0.
+   * A item identifier.
    */
-  start?: number | null;
+  item?: Item | null;
   [k: string]: unknown;
 }
 /**
- * Description of the boundaries of an identified range.
+ * A spatial range representing rectangle, circle, or a polygon.
  */
-export interface Item {
+export interface Shape {
   /**
-   * The container-specific term used to identify items, such as "track_id" for MP4 or "item_ID" for HEIF.
+   * The type of shape.
    */
-  identifier: string;
+  type: "rectangle" | "circle" | "polygon";
   /**
-   * The value of the identifier, e.g. a value of "2" for an identifier of "track_id" would imply track 2 of the asset.
+   * The type of unit for the shape range.
    */
-  value: string;
-  [k: string]: unknown;
-}
-/**
- * A spatial range representing rectangle, circle, or a polygon.
- */
-export interface Shape {
+  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.
    *
@@ -355,34 +412,16 @@ export interface Shape {
    * The default value is true.
    */
   inside?: boolean | null;
-  /**
-   * THe origin of the coordinate in the shape.
-   */
-  origin: Coordinate;
-  /**
-   * The type of shape.
-   */
-  type: ShapeType;
-  /**
-   * The type of unit for the shape range.
-   */
-  unit: UnitType;
   /**
    * The vertices of the polygon.
    *
    * This field can be ignored for rectangles and circles.
    */
-  vertices?: Coordinate[] | null;
-  /**
-   * The width for rectangles or diameter for circles.
-   *
-   * This field can be ignored for polygons.
-   */
-  width?: number | null;
+  vertices?: Coordinate1[] | null;
   [k: string]: unknown;
 }
 /**
- * An x, y coordinate used for specifying vertices in polygons.
+ * THe origin of the coordinate in the shape.
  */
 export interface Coordinate {
   /**
@@ -396,47 +435,17 @@ export interface Coordinate {
   [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 {
-  /**
-   * The end of the text range.
-   */
-  end?: TextSelector | null;
-  /**
-   * The start (or entire) text range.
-   */
-  selector: TextSelector;
-  [k: string]: unknown;
-}
-/**
- * Selects a range of text via a fragment identifier.
- *
- * This is modeled after the W3C Web Annotation selector model.
+ * An x, y coordinate used for specifying vertices in polygons.
  */
-export interface TextSelector {
-  /**
-   * The end character offset or the end of the fragment if not present.
-   */
-  end?: number | null;
+export interface Coordinate1 {
   /**
-   * Fragment identifier as per RFC3023 (XML) or ISO 32000-2 (PDF), Annex O.
+   * The coordinate along the x-axis.
    */
-  fragment: string;
+  x: number;
   /**
-   * The start character offset or the start of the fragment if not present.
+   * The coordinate along the y-axis.
    */
-  start?: number | null;
+  y: number;
   [k: string]: unknown;
 }
 /**
@@ -444,82 +453,107 @@ export interface TextSelector {
  */
 export interface Time {
   /**
-   * The end time or the end of the asset if not present.
+   * The type of time.
    */
-  end?: string | null;
+  type?: "npt";
   /**
    * The start time or the start of the asset if not present.
    */
   start?: string | null;
   /**
-   * The type of time.
+   * The end time or the end of the asset if not present.
    */
-  type?: TimeType & string;
+  end?: string | null;
   [k: string]: unknown;
 }
 /**
- * A rating on an Assertion.
+ * A frame range representing starting and ending frames or pages.
  *
- * See <https://c2pa.org/specifications/specifications/2.2/specs/C2PA_Specification.html#_review_ratings>.
+ * If both `start` and `end` are missing, the frame will span the entire asset.
  */
-export interface ReviewRating {
-  code?: string | null;
-  explanation: string;
-  value: number;
+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;
 }
 /**
- * Resource store to contain binary objects referenced from JSON serializable structures
+ * A textual range representing multiple (possibly discontinuous) ranges of text.
  */
-export interface ResourceStore {
-  label?: string | null;
-  resources: {
-    [k: string]: number[];
-  };
+export interface Text {
+  /**
+   * The ranges of text to select.
+   */
+  selectors: TextSelectorRange[];
   [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
+ * One or two [`TextSelector`][TextSelector] identifiying the range to select.
  */
-export interface ValidationResults {
-  activeManifest?: StatusCodes | null;
-  ingredientDeltas?: IngredientDeltaValidationResult[] | null;
+export interface TextSelectorRange {
+  selector: TextSelector;
+  /**
+   * The end of the text range.
+   */
+  end?: TextSelector1 | null;
   [k: string]: unknown;
 }
 /**
- * Contains a set of success, informational, and failure validation status codes.
+ * The start (or entire) text range.
  */
-export interface StatusCodes {
-  failure: ValidationStatus[];
-  informational: ValidationStatus[];
-  success: ValidationStatus[];
+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;
 }
 /**
- * A `ValidationStatus` struct describes the validation status of a specific part of a manifest.
+ * Selects a range of text via a fragment identifier.
  *
- * See <https://c2pa.org/specifications/specifications/2.2/specs/C2PA_Specification.html#_existing_manifests>.
+ * This is modeled after the W3C Web Annotation selector model.
  */
-export interface ValidationStatus {
-  code: string;
-  explanation?: string | null;
-  success?: boolean | null;
-  url?: string | null;
+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;
 }
 /**
- * Represents any changes or deltas between the current and previous validation results for an ingredient's manifest.
+ * Description of the boundaries of an identified range.
  */
-export interface IngredientDeltaValidationResult {
+export interface Item {
   /**
-   * JUMBF URI reference to the ingredient assertion
+   * The container-specific term used to identify items, such as "track_id" for MP4 or "item_ID" for HEIF.
    */
-  ingredientAssertionURI: string;
+  identifier: string;
   /**
-   * Validation results for the ingredient's active manifest
+   * The value of the identifier, e.g. a value of "2" for an identifier of "track_id" would imply track 2 of the asset.
    */
-  validationDeltas: StatusCodes;
+  value: string;
   [k: string]: unknown;
 }