@vidispine/vdt-js 22.4.0 → 23.1.0-pre.2

package/dist/index.d.ts

@@ -13,7 +13,7 @@ declare const parseKeyValuePairTypes: (keyValuePairTypes: KeyValuePairType[]) =>
 };
 
 /**
- * Object with all name of roles in VidiCore
+ * Const object with VidiCore role names
  *
  * @category Auth
  */
@@ -127,7 +127,8 @@ declare const ROLE_NAMES: {
     readonly USER: "_user";
     readonly VXA: "_vxa";
     readonly VXA_READ: "_vxa_read";
-};
+};
+type RoleNameTypes = keyof typeof ROLE_NAMES;
 
 type InputValueTypes = string | boolean | number | Date;
 /** Possible input values for the field value */
@@ -445,17 +446,19 @@ type MetadataTypeToWebVttOptions = {
 declare const metadataTypeToWebVtt: (metadataType: MetadataType, options?: MetadataTypeToWebVttOptions) => string;
 
 /**
- * Array with all available metadata group attributes
+ * Array with all available VidiCore system/default field group names
  *
  * @category Metadata
  */
-declare const GROUP_ATTRIBUTE_KEYS: (keyof MetadataGroupValueType)[];
+declare const SYSTEM_FIELDGROUPS: readonly ["stl_subtitle", "stl_tti", "stl_gsi", "mrk_marker", "pho_validation", "pho_resource", "pho_error", "facedetect_rect", "facedetect_face", "originalTrackFilename", "stl_gsiHeader"];
+
 /**
- * Array with all available metadata group attributes
+ * Array with all available VidiCore system/default field names (including transient)
  *
  * @category Metadata
  */
-declare const FIELD_ATTRIBUTE_KEYS: (keyof MetadataFieldValueType)[];
+declare const SYSTEM_FIELDS: readonly ["title", "user", "shapeTag", "representativeThumbnail", "representativeThumbnailNoAuth", "representativeItems", "itemId", "collectionId", "mediaType", "mimeType", "created", "startTimeCode", "startSeconds", "fieldValidationError", "schemaValidationError", "originalFilename", "originalUri", "originalAudioCodec", "originalVideoCodec", "originalHeight", "originalWidth", "originalFormat", "durationSeconds", "durationTimeCode", "solr-index", "__user", "__collection", "__collection_size", "__ancestor_collection", "__ancestor_collection_size", "__shape", "__shape_size", "__shape_last_added", "__placeholder_shape_size", "__version", "__version_count", "__storage", "__storage_size", "__shapetag_{tag}_hash_{hash}", "__storage_{tag}", "__storage_{tag}_size", "__storagegroup", "__storagegroup_size", "__sequence", "__sequence_size", "__metadata_last_modified", "__external_id", "__deletion_lock_id", "__deletion_lock_expiry", "__child_collection", "__child_collection_size", "__parent_collection", "__parent_collection_size", "__items_size", "stl_text", "stl_justification", "stl_xrelative", "stl_yrelative", "stl_vertical", "stl_verticalbase", "stl_horizontalbase", "stl_sizerelative", "stl_color", "stl_outline", "stl_outlinecolor", "stl_outlinesize", "stl_font", "stl_service", "stl_tti", "stl_gsi", "cct", "tcd", "tcf", "oet", "cd", "mnc", "cpn", "dfc", "tcp", "tcs", "tet", "tnb", "tnd", "en", "co", "tng", "rd", "mnr", "dsc", "opt", "lc", "tpt", "tn", "slr", "tns", "rn", "pub", "dsn", "ecd", "mrk_zerolength", "mrk_text", "mrk_color", "pho_resource_name", "pho_error_level", "pho_error_code", "pho_error_description", "facedetect_rect_width", "facedetect_rect_height", "facedetect_rect_y", "facedetect_rect_x", "facedetect_pid", "facedetect_rect", "trackId", "eidr_actor", "eidr_alternateId", "eidr_countryOfOrigin", "eidr_director", "eidr_id", "eidr_referentType", "eidr_releaseDate", "eidr_resourceName", "eidr_status", "eidr_sync", "ttml_div", "ttml_root", "vxa_collection_id", "vxaId", "vxaLocalPath", "tco", "cs", "ebn", "tf", "cf", "sgn", "tci", "jc", "vp", "sn"];
+
 /**
  * Array with all available metadata field value attributes
  *
@@ -464,17 +467,18 @@ declare const FIELD_ATTRIBUTE_KEYS: (keyof MetadataFieldValueType)[];
 declare const FIELD_VALUE_ATTRIBUTE_KEYS: (keyof MetadataValueType)[];
 
 /**
- * Array with all available VidiCore system/default field group names
+ * Array with all available metadata field attributes
  *
  * @category Metadata
  */
-declare const SYSTEM_FIELDGROUPS: readonly ["stl_subtitle", "stl_tti", "stl_gsi", "mrk_marker", "pho_validation", "pho_resource", "pho_error", "facedetect_rect", "facedetect_face", "originalTrackFilename", "stl_gsiHeader"];
+declare const FIELD_ATTRIBUTE_KEYS: (keyof MetadataFieldValueType)[];
+
 /**
- * Array with all available VidiCore system/default field group names
+ * Array with all available metadata group attributes
  *
  * @category Metadata
  */
-declare const SYSTEM_FIELDS: readonly ["title", "user", "shapeTag", "representativeThumbnail", "representativeThumbnailNoAuth", "representativeItems", "itemId", "collectionId", "mediaType", "mimeType", "created", "startTimeCode", "startSeconds", "fieldValidationError", "schemaValidationError", "originalFilename", "originalUri", "originalAudioCodec", "originalVideoCodec", "originalHeight", "originalWidth", "originalFormat", "durationSeconds", "durationTimeCode", "solr-index", "__user", "__collection", "__collection_size", "__ancestor_collection", "__ancestor_collection_size", "__shape", "__shape_size", "__shape_last_added", "__placeholder_shape_size", "__version", "__version_count", "__storage", "__storage_size", "__shapetag_{tag}_hash_{hash}", "__storage_{tag}", "__storage_{tag}_size", "__storagegroup", "__storagegroup_size", "__sequence", "__sequence_size", "__metadata_last_modified", "__external_id", "__deletion_lock_id", "__deletion_lock_expiry", "__child_collection", "__child_collection_size", "__parent_collection", "__parent_collection_size", "__items_size", "stl_text", "stl_justification", "stl_xrelative", "stl_yrelative", "stl_vertical", "stl_verticalbase", "stl_horizontalbase", "stl_sizerelative", "stl_color", "stl_outline", "stl_outlinecolor", "stl_outlinesize", "stl_font", "stl_service", "stl_tti", "stl_gsi", "cct", "tcd", "tcf", "oet", "cd", "mnc", "cpn", "dfc", "tcp", "tcs", "tet", "tnb", "tnd", "en", "co", "tng", "rd", "mnr", "dsc", "opt", "lc", "tpt", "tn", "slr", "tns", "rn", "pub", "dsn", "ecd", "mrk_zerolength", "mrk_text", "mrk_color", "pho_resource_name", "pho_error_level", "pho_error_code", "pho_error_description", "facedetect_rect_width", "facedetect_rect_height", "facedetect_rect_y", "facedetect_rect_x", "facedetect_pid", "facedetect_rect", "trackId", "eidr_actor", "eidr_alternateId", "eidr_countryOfOrigin", "eidr_director", "eidr_id", "eidr_referentType", "eidr_releaseDate", "eidr_resourceName", "eidr_status", "eidr_sync", "ttml_div", "ttml_root", "vxa_collection_id", "vxaId", "vxaLocalPath", "tco", "cs", "ebn", "tf", "cf", "sgn", "tci", "jc", "vp", "sn"];
+declare const GROUP_ATTRIBUTE_KEYS: (keyof MetadataGroupValueType)[];
 
 type CreateFacetTypeFieldList = string[];
 type CreateFacetTypeOptions = {
@@ -550,6 +554,19 @@ type ParseHighlightTimespanListOptions = {
  */
 declare const parseHighlightTimespanList: (highlightTimespanList?: SearchResultEntryTimespanType[], options?: ParseHighlightTimespanListOptions) => ParsedHighlightTimespan | ParsedHighlightTimespan[];
 
+/**
+ * Parse Vidicore "NOW" constants to a date object
+ *
+ * Format: `NOW[+/-][number][HOUR/DAY/MONTH/YEAR(s)]` (e.g. "NOW-2HOURS")
+ *
+ * @remarks
+ * Returns an approximate date since it's created client side
+ *
+ * @param value A "NOW" constant
+ * @returns A date from the NOW constant
+ *
+ * @category Search
+ */
 declare const parseNowDate: (value?: string) => Date;
 
 type ParsedBaseMediaInfoType = {
@@ -572,6 +589,7 @@ type ParsedAudioComponentType = {
     audioSamplerateSamples?: number;
     audioBitDepth?: string;
     audioBitrate?: string;
+    audioBitrateKbps?: number;
     audioBitRateMode?: string;
     audioChannels?: number;
     audioMetadata?: {
@@ -615,6 +633,9 @@ type ParsedFileType = {
 /**
  * Parses a VidiCore file object
  *
+ * @remarks
+ * File sizes are parsed with JEDEC standard (base 2)
+ *
  * @param fileType VidiCore file object
  * @returns A parsed file object
  *
@@ -679,6 +700,7 @@ declare class TimeBase {
      *
      * @remarks
      * Default format: denominator(:numerator if > 1)
+     *
      * `constant` has precedence over `fraction` if both are true (e.g. NTSC > 30000:1001)
      *
      * @param options For how to display it as text
@@ -698,6 +720,7 @@ declare class TimeBase {
      * - `number` gives that amount of decimal places
      *
      * Default format: rate with two decimals if needed (i.e. decimals are > 0)
+     *
      * Option precedence (when all true): `constant` > `rounded` > `fixed`
      *
      * @param options For how to display it as rate
@@ -822,6 +845,7 @@ declare class TimeCode {
      *
      * @remarks
      * Default format: samples@denominator(:numerator if > 1)
+     *
      * `constant` has precedence over `fraction` if both are true
      *
      * @param options Options for how to format text
@@ -917,7 +941,9 @@ type FormatTimeCodeSecondsOptions = {
 } & TimeCodeInputOptions;
 /**
  * Format seconds to TimeCode object
- * Input time base is always 1:1 since it expects seconds as input
+ *
+ * @remarks
+ * Input time base is always considered as 1:1 since it expects seconds as input
  *
  * Note: Max 15 digits accuracy (double precision float64), e.g.
  * - 10^6 seconds can have 10^9 decimals (nanosecond) precision
@@ -1000,6 +1026,7 @@ type ParsedVideoComponentType = {
     videoCodec?: string;
     smpte?: string;
     videoBitrate?: string;
+    videoBitrateMbps?: number;
     fieldOrder?: string;
     colorSpace?: string;
     chromaSubsampling?: string;
@@ -1040,13 +1067,32 @@ type ParsedShapeType = {
  */
 declare const parseShapeType: (shapeType?: ShapeType) => ParsedShapeType;
 
+/**
+ * Const object with document types
+ *
+ * @category Shape
+ */
 declare const DOCUMENT_TYPES: {
     readonly PDF: "PDF";
     readonly TEXT: "TEXT";
     readonly MSWORD: "MSWORD";
     readonly JSON: "JSON";
     readonly XML: "XML";
-};
+};
+
+/**
+ * Const object with media types
+ *
+ * @category Shape
+ */
+declare const SHAPE_MEDIA_TYPES: {
+    readonly IMAGE: "IMAGE";
+    readonly AUDIO: "AUDIO";
+    readonly VIDEO: "VIDEO";
+    readonly DOCUMENT: "DOCUMENT";
+    readonly BINARY: "BINARY";
+};
+
 type DocumentType = keyof typeof DOCUMENT_TYPES;
 /**
  * Return a const for the document type of a shape (looks at mimeType)
@@ -1085,13 +1131,6 @@ type FilterShapeSourceOption = {
  */
 declare const filterShapeSource: (itemType: ItemType, options: FilterShapeSourceOption) => FilteredShapeListObject[];
 
-declare const SHAPE_MEDIA_TYPES: {
-    readonly IMAGE: "IMAGE";
-    readonly AUDIO: "AUDIO";
-    readonly VIDEO: "VIDEO";
-    readonly DOCUMENT: "DOCUMENT";
-    readonly BINARY: "BINARY";
-};
 type ShapeMediaType = keyof typeof SHAPE_MEDIA_TYPES;
 /**
  * Returns a const for which media type a shape has
@@ -1103,6 +1142,38 @@ type ShapeMediaType = keyof typeof SHAPE_MEDIA_TYPES;
  */
 declare const getShapeMediaType: (shape: ShapeType) => ShapeMediaType;
 
+/**
+ * Const object with all file states in VidiCore
+ * (see https://apidoc.vidispine.com/latest/storage/storage.html#file-states for more info)
+ *
+ * @category File
+ */
+declare const FILE_STATES: {
+    /** Just created, not used. */
+    readonly NONE: "NONE";
+    /** Discovered or created, not yet marked as finished. */
+    readonly OPEN: "OPEN";
+    /** File does no longer grow. */
+    readonly CLOSED: "CLOSED";
+    /** The current state is not known. */
+    readonly UNKNOWN: "UNKNOWN";
+    /** File is missing from the file system/storage. */
+    readonly MISSING: "MISSING";
+    /** File has been missing for a longer period. Candidate for restoration from archive. */
+    readonly LOST: "LOST";
+    /** File will appear on file system/storage, transfer subsystem or transcoder will create it. */
+    readonly TO_APPEAR: "TO_APPEAR";
+    /** The file is no longer in use, and will be deleted at the next clean-up sweep. */
+    readonly TO_BE_DELETED: "TO_BE_DELETED";
+    /** File is in use by transfer subsystem or transcoder. */
+    readonly BEING_READ: "BEING_READ";
+    /** File is archived. */
+    readonly ARCHIVED: "ARCHIVED";
+    /** File will be synchronized by multi-site agent. */
+    readonly AWAITING_SYNC: "AWAITING_SYNC";
+};
+type FileStateTypes = keyof typeof FILE_STATES;
+
 /**
  * Find the thumbnail uri in a VidiCore item object that's nearest a timeCode
  *
@@ -1175,4 +1246,4 @@ type ParsedTranscodePreset = {
  */
 declare const parseTranscodePreset: (transcodePresetType: TranscodePresetType) => ParsedTranscodePreset;
 
-export { CreateFacetTypeFieldList, CreateFacetTypeOptions, CreateMetadataTypeInput, CreateTimeCodeOptions, DocumentType, FIELD_ATTRIBUTE_KEYS, FIELD_VALUE_ATTRIBUTE_KEYS, FilterShapeSourceOption, FilteredShapeListObject, FormatTimeCodeSecondsOptions, FormatTimeCodeSmpteOptions, FormatTimeCodeTextOptions, GROUP_ATTRIBUTE_KEYS, InputField, InputFieldObject, InputFieldValue, InputGroup, InputGroupsOrFields, InputTimespan, InputValue, InputValueObject, InputValueTypes, MetadataTypeToWebVttOptions, ParseFieldListOptions, ParseFieldOptions, ParseGroupListOptions, ParseGroupOptions, ParseHighlightTimespanListOptions, ParseHighlightTimespanOptions, ParseMetadataTypeOptions, ParseTimespanListOptions, ParseTimespanOptions, ParseValueListOptions, ParseValueOptions, ParsedAudioComponentType, ParsedAudioMediaInfoType, ParsedBaseMediaInfoType, ParsedBinaryComponentType, ParsedBinaryMediaInfoType, ParsedContainerComponentType, ParsedFacetType, ParsedFacetTypeCount, ParsedField, ParsedFieldAttributes, ParsedFieldList, ParsedFieldObject, ParsedFileType, ParsedGroup, ParsedGroupAttributes, ParsedGroupList, ParsedHighlightTimespan, ParsedMediaConvertTranscodePreset, ParsedMetadataAttributes, ParsedMetadataType, ParsedShapeType, ParsedTimespan, ParsedTimespanAttributes, ParsedTimespanList, ParsedTranscodePreset, ParsedValue, ParsedValueAttributes, ParsedValueList, ParsedVideoComponentType, ParsedVideoMediaInfoType, ROLE_NAMES, SYSTEM_FIELDGROUPS, SYSTEM_FIELDS, ShapeMediaType, TimeBase, TimeBaseInput, TimeCode, TimeCodeInput, TimeCodeInputOptions, createFacetType, createMetadataType, createTimeBase, createTimeCode, filterShapeSource, findNearestThumbnail, formatTimeBaseText, formatTimeBaseType, formatTimeCodeSeconds, formatTimeCodeSmpte, formatTimeCodeText, formatTimeCodeType, getShapeDocumentType, getShapeMediaType, metadataTypeToWebVtt, parseAudioComponent, parseBinaryComponent, parseContainerComponent, parseFacetType, parseFieldList, parseFileType, parseGroupList, parseHighlightTimespan, parseHighlightTimespanList, parseKeyValuePairTypes as parseKeyValuePairType, parseMediaConvertPreset, parseMetadataType, parseNowDate, parseShapeType, parseSimpleMetadataType, parseTimespan, parseTimespanList, parseTranscodePreset, parseVideoComponent };
+export { CreateFacetTypeFieldList, CreateFacetTypeOptions, CreateMetadataTypeInput, CreateTimeCodeOptions, DOCUMENT_TYPES, DocumentType, FIELD_ATTRIBUTE_KEYS, FIELD_VALUE_ATTRIBUTE_KEYS, FILE_STATES, FileStateTypes, FilterShapeSourceOption, FilteredShapeListObject, FormatTimeCodeSecondsOptions, FormatTimeCodeSmpteOptions, FormatTimeCodeTextOptions, GROUP_ATTRIBUTE_KEYS, InputField, InputFieldObject, InputFieldValue, InputGroup, InputGroupsOrFields, InputTimespan, InputValue, InputValueObject, InputValueTypes, MetadataTypeToWebVttOptions, ParseFieldListOptions, ParseFieldOptions, ParseGroupListOptions, ParseGroupOptions, ParseHighlightTimespanListOptions, ParseHighlightTimespanOptions, ParseMetadataTypeOptions, ParseTimespanListOptions, ParseTimespanOptions, ParseValueListOptions, ParseValueOptions, ParsedAudioComponentType, ParsedAudioMediaInfoType, ParsedBaseMediaInfoType, ParsedBinaryComponentType, ParsedBinaryMediaInfoType, ParsedContainerComponentType, ParsedFacetType, ParsedFacetTypeCount, ParsedField, ParsedFieldAttributes, ParsedFieldList, ParsedFieldObject, ParsedFileType, ParsedGroup, ParsedGroupAttributes, ParsedGroupList, ParsedHighlightTimespan, ParsedMediaConvertTranscodePreset, ParsedMetadataAttributes, ParsedMetadataType, ParsedShapeType, ParsedTimespan, ParsedTimespanAttributes, ParsedTimespanList, ParsedTranscodePreset, ParsedValue, ParsedValueAttributes, ParsedValueList, ParsedVideoComponentType, ParsedVideoMediaInfoType, ROLE_NAMES, RoleNameTypes, SHAPE_MEDIA_TYPES, SYSTEM_FIELDGROUPS, SYSTEM_FIELDS, ShapeMediaType, TimeBase, TimeBaseInput, TimeCode, TimeCodeInput, TimeCodeInputOptions, createFacetType, createMetadataType, createTimeBase, createTimeCode, filterShapeSource, findNearestThumbnail, formatTimeBaseText, formatTimeBaseType, formatTimeCodeSeconds, formatTimeCodeSmpte, formatTimeCodeText, formatTimeCodeType, getShapeDocumentType, getShapeMediaType, metadataTypeToWebVtt, parseAudioComponent, parseBinaryComponent, parseContainerComponent, parseFacetType, parseFieldList, parseFileType, parseGroupList, parseHighlightTimespan, parseHighlightTimespanList, parseKeyValuePairTypes as parseKeyValuePairType, parseMediaConvertPreset, parseMetadataType, parseNowDate, parseShapeType, parseSimpleMetadataType, parseTimespan, parseTimespanList, parseTranscodePreset, parseVideoComponent };