@contentauth/c2pa-types 0.3.1 → 0.4.1

package/index.d.ts

@@ -30,16 +30,12 @@ export type {
   ManifestAssertion,
   ManifestAssertionKind,
   Range,
-  RangeType,
   Reader,
   RegionOfInterest,
-  Relationship,
   ResourceRef,
-  ResourceStore,
   ReviewRating,
   Role,
   Shape,
-  ShapeType,
   SignatureInfo,
   SigningAlg,
   StatusCodes,
@@ -47,8 +43,6 @@ export type {
   TextSelector,
   TextSelectorRange,
   Time,
-  TimeType,
-  UnitType,
   UriOrResource,
   ValidationResults,
   ValidationState,
@@ -65,3 +59,5 @@ export type {
   BuilderIntent,
   DigitalSourceType,
 } from './types/Builder.js';
+
+export type { Action } from './types/Action.js';

package/package.json

@@ -2,7 +2,7 @@
   "name": "@contentauth/c2pa-types",
   "description": "Typescript types generated from c2pa-rs",
   "type": "module",
-  "version": "0.3.1",
+  "version": "0.4.1",
   "types": "index.d.ts",
   "files": [
     "index.d.ts",
@@ -13,7 +13,7 @@
     "rimraf": "^6.0.1"
   },
   "scripts": {
-    "test": "echo \"No tests to run\" && exit 0",
+    "test": "tsc",
     "build": "pnpm clean && json2ts -i schemas/ -o types/",
     "clean": "rimraf types"
   }

package/types/Action.d.ts

@@ -0,0 +1,551 @@
+/* eslint-disable */
+/**
+ * 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 DateT = string;
+/**
+ * We use this to allow SourceAgent to be either a string or a ClaimGeneratorInfo
+ */
+export type SoftwareAgent = string | ClaimGeneratorInfo;
+export type UriOrResource = ResourceRef | HashedUri;
+/**
+ * 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";
+/**
+ * Description of the source of an asset.
+ *
+ * The full list of possible digital source types are found below:
+ * <https://spec.c2pa.org/specifications/specifications/2.2/specs/C2PA_Specification.html#_digital_source_type>
+ * <https://cv.iptc.org/newscodes/digitalsourcetype>
+ */
+export type DigitalSourceType =
+  | "http://c2pa.org/digitalsourcetype/empty"
+  | "http://c2pa.org/digitalsourcetype/trainedAlgorithmicData"
+  | "http://cv.iptc.org/newscodes/digitalsourcetype/digitalCapture"
+  | "http://cv.iptc.org/newscodes/digitalsourcetype/computationalCapture"
+  | "http://cv.iptc.org/newscodes/digitalsourcetype/negativeFilm"
+  | "http://cv.iptc.org/newscodes/digitalsourcetype/positiveFilm"
+  | "http://cv.iptc.org/newscodes/digitalsourcetype/print"
+  | "http://cv.iptc.org/newscodes/digitalsourcetype/minorHumanEdits"
+  | "http://cv.iptc.org/newscodes/digitalsourcetype/humanEdits"
+  | "http://cv.iptc.org/newscodes/digitalsourcetype/compositeWithTrainedAlgorithmicMedia"
+  | "http://cv.iptc.org/newscodes/digitalsourcetype/algorithmicallyEnhanced"
+  | "http://cv.iptc.org/newscodes/digitalsourcetype/softwareImage"
+  | "http://cv.iptc.org/newscodes/digitalsourcetype/digitalArt"
+  | "http://cv.iptc.org/newscodes/digitalsourcetype/digitalCreation"
+  | "http://cv.iptc.org/newscodes/digitalsourcetype/dataDrivenMedia"
+  | "http://cv.iptc.org/newscodes/digitalsourcetype/trainedAlgorithmicMedia"
+  | "http://cv.iptc.org/newscodes/digitalsourcetype/algorithmicMedia"
+  | "http://cv.iptc.org/newscodes/digitalsourcetype/screenCapture"
+  | "http://cv.iptc.org/newscodes/digitalsourcetype/virtualRecording"
+  | "http://cv.iptc.org/newscodes/digitalsourcetype/composite"
+  | "http://cv.iptc.org/newscodes/digitalsourcetype/compositeCapture"
+  | "http://cv.iptc.org/newscodes/digitalsourcetype/compositeSynthetic"
+  | string;
+
+/**
+ * Defines a single action taken on an asset.
+ *
+ * An [`Action`] describes what took place on the asset, when it took place,
+ * along with possible other information such as what software performed
+ * the action.
+ *
+ * See <https://c2pa.org/specifications/specifications/2.2/specs/C2PA_Specification.html#_actions>.
+ */
+export interface Action {
+  /**
+   * The label associated with this action. See ([`c2pa_action`]).
+   */
+  action: string;
+  /**
+   * Timestamp of when the action occurred.
+   */
+  when?: DateT | null;
+  /**
+   * The software agent that performed the action.
+   */
+  softwareAgent?: SoftwareAgent | null;
+  /**
+   * 0-based index into the softwareAgents array
+   */
+  softwareAgentIndex?: number | null;
+  /**
+   * A semicolon-delimited list of the parts of the resource that were changed since the previous event history.
+   */
+  changed?: string | null;
+  /**
+   * A list of the regions of interest of the resource that were changed.
+   *
+   * If not present, presumed to be undefined.
+   * When tracking changes and the scope of the changed components is unknown,
+   * it should be assumed that anything might have changed.
+   */
+  changes?: RegionOfInterest[] | null;
+  /**
+   * @deprecated
+   * This is NOT the instanceID in the spec
+   * It is now deprecated but was previously used to map the action to an ingredient
+   */
+  instance_id?: string | null;
+  /**
+   * Additional parameters of the action. These vary by the type of action.
+   */
+  parameters?: ActionParameters | null;
+  /**
+   * An array of the creators that undertook this action.
+   */
+  actors?: Actor[] | null;
+  /**
+   * One of the defined URI values at `<https://cv.iptc.org/newscodes/digitalsourcetype/>`
+   */
+  digitalSourceType?: DigitalSourceType | null;
+  /**
+   * List of related actions.
+   */
+  related?: Action[] | null;
+  reason?: string | null;
+  description?: string | 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 [§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 {
+  /**
+   * 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;
+}
+/**
+ * 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;
+}
+/**
+ * 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 <https://c2pa.org/specifications/specifications/2.2/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;
+}
+/**
+ * Additional parameters of the action.
+ */
+export interface ActionParameters {
+  /**
+   * A hashed-uri to the ingredient assertion that this action acts on.
+   */
+  ingredient?: HashedUri | null;
+  /**
+   * Additional description of the action.
+   */
+  description?: string | null;
+  /**
+   * A JUMBF URI to the redacted assertion, required when the action is `c2pa.redacted`.
+   */
+  redacted?: string | null;
+  /**
+   * A list of hashed JUMBF URI(s) to the ingredient (v2 or v3) assertion(s) that this action acts on.
+   */
+  ingredients?: HashedUri[] | null;
+  /**
+   * BCP-47 code of the source language of a `c2pa.translated` action.
+   */
+  sourceLanguage?: string | null;
+  /**
+   * BCP-47 code of the target language of a `c2pa.translated` action.
+   */
+  targetLanguage?: string | null;
+  /**
+   * Was this action performed multiple times.
+   */
+  multipleInstances?: boolean | null;
+  [k: string]: unknown;
+}