@vidispine/vdt-js 22.4.0-pre.9 → 22.4.0

package/dist/index.d.ts

@@ -129,34 +129,34 @@ declare const ROLE_NAMES: {
     readonly VXA_READ: "_vxa_read";
 };
 
-declare type InputValueTypes = string | boolean | number | Date;
+type InputValueTypes = string | boolean | number | Date;
 /** Possible input values for the field value */
-declare type InputValue = InputValueTypes | InputValueTypes[];
+type InputValue = InputValueTypes | InputValueTypes[];
 /** Input value object for the field value */
-declare type InputValueObject = {
+type InputValueObject = {
     value: string | InputValue;
 } & Omit<MetadataValueType, 'value'>;
-declare type InputFieldValue = InputValueObject | InputValue | InputValueObject[] | InputValue[];
+type InputFieldValue = InputValueObject | InputValue | InputValueObject[] | InputValue[];
 /** Input object to create field of */
-declare type InputFieldObject = {
+type InputFieldObject = {
     value: InputFieldValue;
 } & MetadataFieldValueType;
 /** Input to create a field of */
-declare type InputField = InputFieldValue | InputFieldObject;
+type InputField = InputFieldValue | InputFieldObject;
 /** Input to create one or multiple groups and/or fields of */
-declare type InputGroupsOrFields = InputGroup | InputGroup[] | InputField | InputField[];
+type InputGroupsOrFields = InputGroup | InputGroup[] | InputField | InputField[];
 /** Input object to create group of */
-declare type InputGroup = {
+type InputGroup = {
     [groupOrFieldName: string]: InputGroupsOrFields;
 } & Partial<MetadataGroupValueType>;
 /** Input to create a timespan of */
-declare type InputTimespan = {
+type InputTimespan = {
     start?: string | number;
     end?: string | number;
     base?: string;
     [groupOrFieldName: string]: InputGroupsOrFields;
 };
-declare type CreateMetadataTypeInput = InputTimespan | InputTimespan[];
+type CreateMetadataTypeInput = InputTimespan | InputTimespan[];
 /**
  * Create a VidiCore metadata object from a more dense/simplified structure
  *
@@ -167,44 +167,44 @@ declare type CreateMetadataTypeInput = InputTimespan | InputTimespan[];
  */
 declare const createMetadataType: (input: CreateMetadataTypeInput) => MetadataType;
 
-declare type ParsedValueAttributes = Partial<Omit<MetadataValueType, 'value'>>;
-declare type ParsedValue<TOptions> = TOptions extends {
+type ParsedValueAttributes = Partial<Omit<MetadataValueType, 'value'>>;
+type ParsedValue<TOptions> = TOptions extends {
     includeValueAttributes?: false;
 } ? string : {
     value: string;
 } & ParsedValueAttributes;
-declare type ParseValueOptions = {
+type ParseValueOptions = {
     includeValueAttributes?: boolean | (keyof ParsedValueAttributes)[];
 };
 
-declare type ParsedValueList<TOptions> = TOptions extends {
+type ParsedValueList<TOptions> = TOptions extends {
     joinValue?: string;
     includeValueAttributes?: false;
 } ? string : TOptions extends {
     arrayOnSingleValue?: true;
 } ? ParsedValue<TOptions>[] : ParsedValue<TOptions> | ParsedValue<TOptions>[];
-declare type ParseValueListOptions = {
+type ParseValueListOptions = {
     joinValue?: string;
     arrayOnSingleValue?: boolean;
 } & ParseValueOptions;
 
-declare type ParsedFieldAttributes = Partial<Omit<MetadataFieldValueType, 'value'>>;
-declare type ParsedFieldObject<TOptions> = {
+type ParsedFieldAttributes = Partial<Omit<MetadataFieldValueType, 'value'>>;
+type ParsedFieldObject<TOptions> = {
     value: ParsedValueList<TOptions>;
 } & ParsedFieldAttributes;
-declare type ParsedField<TOptions> = TOptions extends {
+type ParsedField<TOptions> = TOptions extends {
     includeFieldAttributes?: false;
 } ? ParsedValueList<TOptions> : ParsedFieldObject<TOptions>;
-declare type ParseFieldOptions = {
+type ParseFieldOptions = {
     includeFieldAttributes?: boolean | (keyof ParsedFieldAttributes)[];
 } & ParseValueListOptions;
 
-declare type ParseFieldListOptions = {
+type ParseFieldListOptions = {
     fieldAsList?: boolean;
     arrayOnSingleField?: boolean;
     overrideField?: boolean;
 } & ParseFieldOptions;
-declare type ParsedFieldList<TOptions> = TOptions extends {
+type ParsedFieldList<TOptions> = TOptions extends {
     fieldAsList?: true;
 } ? ParsedField<TOptions>[] : TOptions extends {
     arrayOnSingle?: true;
@@ -227,13 +227,12 @@ declare type ParsedFieldList<TOptions> = TOptions extends {
  * Parse a metadata field list according to selected options
  *
  * @remarks
- * Duplicate fields (same field name in the same field list) are usually not the data model we'd advise using.
- * Since VidiCore supports multiple values in one fields, it's typically advised to store them as such.
- * But, given duplicated fields when parsing it will:
- * - with default options, merge duplicated field values to one field value array
- * - with `fieldAsList` enabled, separate fields in the list/array (as usual, even if not duplicate)
- * - with `includeFieldAttributes` enabled, return an array of field objects
- * - with `overrideField` enabled - Override so it returns the latest "duplicated" field it parses
+ * When parsing duplicate fields (same field name in the same field list) it will:
+ * - with default options: combine field values to one array within the same field name key
+ * - with `joinValue` enabled: join values within each field (returns array with string for each field value)
+ * - with `fieldAsList` enabled: separate fields in the list/array (as usual, even if not duplicate)
+ * - with `includeFieldAttributes` enabled: return an array of field objects
+ * - with `overrideField` enabled: return the latest duplicated field it parses
  *
  * @param fieldList Field list to parse
  * @param [options=defaultOptions] Options for how to parse the field list
@@ -243,14 +242,14 @@ declare type ParsedFieldList<TOptions> = TOptions extends {
  */
 declare const parseFieldList: <TOptions extends ParseFieldListOptions = ParseFieldListOptions>(fieldList: MetadataFieldValueType[], options?: TOptions) => ParsedFieldList<TOptions>;
 
-declare type ParsedGroupAttributes = Omit<MetadataGroupValueType, 'field' | 'group'>;
-declare type ParseGroupOptions = {
+type ParsedGroupAttributes = Omit<MetadataGroupValueType, 'field' | 'group'>;
+type ParseGroupOptions = {
     includeGroupAttributes?: boolean | (keyof ParsedGroupAttributes)[];
     groupAsList?: boolean;
     arrayOnSingleGroup?: boolean;
     overrideGroup?: boolean;
 } & ParseFieldListOptions;
-declare type ParsedGroup<TOptions> = ((TOptions extends {
+type ParsedGroup<TOptions> = ((TOptions extends {
     groupAsList?: true;
 } ? {
     group?: ParsedGroupList<TOptions>;
@@ -263,8 +262,8 @@ declare type ParsedGroup<TOptions> = ((TOptions extends {
 } : {
     [name: string]: ParsedFieldList<TOptions>;
 })) & ParsedGroupAttributes;
-declare type ParseGroupListOptions = ParseGroupOptions;
-declare type ParsedGroupList<TOptions> = TOptions extends {
+type ParseGroupListOptions = ParseGroupOptions;
+type ParsedGroupList<TOptions> = TOptions extends {
     groupAsList?: true;
 } ? ParsedGroup<TOptions>[] : TOptions extends {
     arrayOnSingle?: true;
@@ -287,10 +286,10 @@ declare type ParsedGroupList<TOptions> = TOptions extends {
  * Parse a metadata group list according to selected options
  *
  * @remarks
- * Parsing duplicate groups (with identical name) in the same group list will return:
- * - with default options, an array of group objects
- * - with `groupAsList` enabled, separate group objects in the list/array (as usual, even if not duplicate)
- * - with `overrideGroup` enabled, return the latest duplicated group it parses
+ * Parsing duplicate groups (same group name in the same group list) it will:
+ * - with default options: combine group objects to one array within the same group name key
+ * - with `groupAsList` enabled: return separate group objects in a list/array (as usual, even if not duplicate)
+ * - with `overrideGroup` enabled: return the latest duplicated group it parses
  *
  * @param groupList Group list to parse
  * @param options options for how to parse list
@@ -300,7 +299,7 @@ declare type ParsedGroupList<TOptions> = TOptions extends {
  */
 declare const parseGroupList: <TOptions extends ParseGroupOptions = ParseGroupOptions>(groupList: MetadataGroupValueType[], options?: TOptions) => ParsedGroupList<TOptions>;
 
-declare type ParsedTimespanAttributes = Omit<MetadataType['timespan'][number], 'field' | 'group'>;
+type ParsedTimespanAttributes = Omit<MetadataType['timespan'][number], 'field' | 'group'>;
 /**
  * __includeTimespanAttributes__:
  * Include attributes on timespan
@@ -314,12 +313,12 @@ declare type ParsedTimespanAttributes = Omit<MetadataType['timespan'][number], '
  *
  * @defaultValue `{ includeTimespanAttributes: false, arrayOnSingle: true, flat: false }`
  */
-declare type ParseTimespanOptions = {
+type ParseTimespanOptions = {
     includeTimespanAttributes?: boolean | (keyof ParsedTimespanAttributes)[];
     arrayOnSingle?: boolean;
     flat?: boolean;
 } & ParseGroupListOptions;
-declare type ParsedTimespan<TOptions> = ((TOptions extends {
+type ParsedTimespan<TOptions> = ((TOptions extends {
     groupAsList?: true;
 } ? {
     group?: ParsedGroupList<TOptions>;
@@ -349,7 +348,7 @@ declare type ParsedTimespan<TOptions> = ((TOptions extends {
  */
 declare const parseTimespan: <TOptions extends ParseTimespanOptions = ParseTimespanOptions>(timespan: MetadataType['timespan'][number], options?: TOptions) => ParsedTimespan<TOptions>;
 
-declare type ParsedTimespanList<TOptions> = TOptions extends {
+type ParsedTimespanList<TOptions> = TOptions extends {
     timespanAsList?: true;
 } ? ParsedTimespan<TOptions>[] : TOptions extends {
     flat?: true;
@@ -359,7 +358,7 @@ declare type ParsedTimespanList<TOptions> = TOptions extends {
 } ? ParsedTimespan<TOptions> : {
     [timespanKey: string]: ParsedTimespan<TOptions>[];
 };
-declare type ParseTimespanListOptions = {
+type ParseTimespanListOptions = {
     timespanAsList?: boolean;
     joinTimespan?: string;
     sortTimespan?: boolean;
@@ -380,10 +379,10 @@ declare type ParseTimespanListOptions = {
  */
 declare const parseTimespanList: <TOptions extends ParseTimespanListOptions = ParseTimespanListOptions>(timespanList: MetadataType['timespan'], options?: TOptions) => ParsedTimespanList<TOptions>;
 
-declare type ParsedMetadataAttributes = Partial<Omit<MetadataType, 'timespan' | 'revision'> & {
+type ParsedMetadataAttributes = Partial<Omit<MetadataType, 'timespan' | 'revision'> & {
     revision?: string[];
 }>;
-declare type ParsedMetadataType<TOptions> = (TOptions extends {
+type ParsedMetadataType<TOptions> = (TOptions extends {
     timespanAsList?: true;
 } ? {
     timespan: ParsedTimespanList<TOptions>;
@@ -394,7 +393,7 @@ declare type ParsedMetadataType<TOptions> = (TOptions extends {
 }) & (TOptions extends {
     includeMetadataAttributes?: true | string[];
 } ? ParsedMetadataAttributes : {});
-declare type ParseMetadataTypeOptions = {
+type ParseMetadataTypeOptions = {
     includeMetadataAttributes?: boolean | (keyof ParsedMetadataAttributes)[];
     flat?: boolean;
 } & ParseTimespanListOptions;
@@ -430,7 +429,7 @@ declare const parseSimpleMetadataType: (simpleMetadataType: SimpleMetadataType)
     [key: string]: string;
 };
 
-declare type MetadataTypeToWebVttOptions = {
+type MetadataTypeToWebVttOptions = {
     subtitleGroup?: string;
     subtitleField?: string;
 };
@@ -477,8 +476,8 @@ declare const SYSTEM_FIELDGROUPS: readonly ["stl_subtitle", "stl_tti", "stl_gsi"
  */
 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 type CreateFacetTypeFieldList = string[];
-declare type CreateFacetTypeOptions = {
+type CreateFacetTypeFieldList = string[];
+type CreateFacetTypeOptions = {
     count: boolean;
 };
 /**
@@ -497,11 +496,11 @@ declare const createFacetType: (fieldList?: CreateFacetTypeFieldList, options?:
     exclude: CreateFacetTypeFieldList;
 }[];
 
-declare type ParsedFacetTypeCount = {
+type ParsedFacetTypeCount = {
     [fieldValue: string]: number;
 };
 /** Parsed facet type */
-declare type ParsedFacetType = {
+type ParsedFacetType = {
     [fieldName: string]: ParsedFacetTypeCount;
 };
 /**
@@ -514,12 +513,12 @@ declare type ParsedFacetType = {
  */
 declare const parseFacetType: (facetType?: FacetType[]) => ParsedFacetType;
 
-declare type ParseHighlightTimespanOptions = {
+type ParseHighlightTimespanOptions = {
     arrayOnSingle?: boolean;
     timespanAsList?: boolean;
     joinValue?: string;
 };
-declare type ParsedHighlightTimespan = {
+type ParsedHighlightTimespan = {
     start?: string;
     end?: string;
     [key: string]: string | string[];
@@ -534,7 +533,7 @@ declare type ParsedHighlightTimespan = {
  */
 declare const parseHighlightTimespan: (timespan: SearchResultEntryTimespanType, options: ParseHighlightTimespanOptions) => ParsedHighlightTimespan;
 
-declare type ParseHighlightTimespanListOptions = {
+type ParseHighlightTimespanListOptions = {
     timespanAsList?: boolean;
     joinTimespan?: string;
     flat?: boolean;
@@ -553,20 +552,20 @@ declare const parseHighlightTimespanList: (highlightTimespanList?: SearchResultE
 
 declare const parseNowDate: (value?: string) => Date;
 
-declare type ParsedBaseMediaInfoType = {
+type ParsedBaseMediaInfoType = {
     Bit_rate_mode?: string;
     Source?: string;
 } & {
     [key: string]: string;
 };
-declare type ParsedAudioMediaInfoType = ParsedBaseMediaInfoType;
-declare type ParsedBinaryMediaInfoType = ParsedBaseMediaInfoType;
-declare type ParsedVideoMediaInfoType = ParsedBaseMediaInfoType & {
+type ParsedAudioMediaInfoType = ParsedBaseMediaInfoType;
+type ParsedBinaryMediaInfoType = ParsedBaseMediaInfoType;
+type ParsedVideoMediaInfoType = ParsedBaseMediaInfoType & {
     Format_Settings_GOP?: string;
     intra_dc_precision?: string;
 };
 
-declare type ParsedAudioComponentType = {
+type ParsedAudioComponentType = {
     audioFormat?: string;
     audioCodec?: string;
     audioSamplerate?: string;
@@ -589,7 +588,7 @@ declare type ParsedAudioComponentType = {
  */
 declare const parseAudioComponent: (audioComponentType: AudioComponentType) => ParsedAudioComponentType;
 
-declare type ParsedBinaryComponentType = {
+type ParsedBinaryComponentType = {
     binaryMetadata?: {
         [key: string]: string;
     };
@@ -604,7 +603,7 @@ declare type ParsedBinaryComponentType = {
  */
 declare const parseBinaryComponent: (binaryComponentType?: BinaryComponentType) => ParsedBinaryComponentType;
 
-declare type ParsedFileType = {
+type ParsedFileType = {
     uri?: string;
     hash?: string;
     fileSize?: string;
@@ -626,7 +625,7 @@ declare const parseFileType: (fileType: FileType) => ParsedFileType;
 /**
  * Parsed container component
  */
-declare type ParsedContainerComponentType = {
+type ParsedContainerComponentType = {
     containerFormat?: string;
     videoFormat?: string;
     audioFormat?: string;
@@ -650,7 +649,7 @@ declare type ParsedContainerComponentType = {
  */
 declare const parseContainerComponent: (containerComponentType?: ContainerComponentType) => ParsedContainerComponentType;
 
-declare type TimeBaseInput = {
+type TimeBaseInput = {
     numerator?: number | string;
     denominator?: number | string;
 };
@@ -755,11 +754,11 @@ declare const formatTimeBaseText: (timeBaseText?: string | number) => TimeBase;
  */
 declare const formatTimeBaseType: (timeBase: TimeBaseInput) => TimeBase;
 
-declare type TimeCodeInput = {
+type TimeCodeInput = {
     samples?: number | string;
     timeBase?: string | TimeBaseInput | TimeBase;
 };
-declare type TimeCodeInputOptions = {
+type TimeCodeInputOptions = {
     dropFrame?: boolean;
     frameSeparator?: string;
 };
@@ -912,7 +911,7 @@ declare class TimeCode {
     };
 }
 
-declare type FormatTimeCodeSecondsOptions = {
+type FormatTimeCodeSecondsOptions = {
     timeBase?: number | string | TimeBaseInput;
     useGCD?: boolean;
 } & TimeCodeInputOptions;
@@ -933,7 +932,7 @@ declare type FormatTimeCodeSecondsOptions = {
  */
 declare const formatTimeCodeSeconds: (seconds: string | number, options?: FormatTimeCodeSecondsOptions) => TimeCode;
 
-declare type FormatTimeCodeSmpteOptions = {
+type FormatTimeCodeSmpteOptions = {
     timeBase?: number | string | TimeBaseInput;
     exceedingMode?: 'add' | 'ignore' | 'error';
     dropFrame?: boolean;
@@ -955,7 +954,7 @@ declare type FormatTimeCodeSmpteOptions = {
  */
 declare const formatTimeCodeSmpte: (smpte: string, options?: FormatTimeCodeSmpteOptions) => TimeCode;
 
-declare type FormatTimeCodeTextOptions = {
+type FormatTimeCodeTextOptions = {
     timeBase?: number | string | TimeBaseInput;
 } & TimeCodeInputOptions;
 /**
@@ -967,7 +966,7 @@ declare type FormatTimeCodeTextOptions = {
  */
 declare const formatTimeCodeText: (timeCodeText?: number | string, options?: FormatTimeCodeTextOptions) => TimeCode;
 
-declare type CreateTimeCodeOptions = TimeCodeInputOptions | FormatTimeCodeSmpteOptions | FormatTimeCodeSecondsOptions | FormatTimeCodeTextOptions;
+type CreateTimeCodeOptions = TimeCodeInputOptions | FormatTimeCodeSmpteOptions | FormatTimeCodeSecondsOptions | FormatTimeCodeTextOptions;
 /**
  * Create a TimeCode instance from smpte, seconds/samples, timeCode object or string
  *
@@ -990,7 +989,7 @@ declare const createTimeCode: (timeCode: TimeCodeInput | string | number, option
  */
 declare const formatTimeCodeType: (timeCode: TimeCodeInput, options?: TimeCodeInputOptions) => TimeCode;
 
-declare type ParsedVideoComponentType = {
+type ParsedVideoComponentType = {
     videoFormat?: string;
     dimension?: string;
     frameRate?: string | number;
@@ -1020,7 +1019,7 @@ declare type ParsedVideoComponentType = {
  */
 declare const parseVideoComponent: (videoComponentType?: VideoComponentType) => ParsedVideoComponentType;
 
-declare type ParsedShapeType = {
+type ParsedShapeType = {
     uri?: string;
     tag?: string;
     mimeType?: string;
@@ -1048,7 +1047,7 @@ declare const DOCUMENT_TYPES: {
     readonly JSON: "JSON";
     readonly XML: "XML";
 };
-declare type DocumentType = keyof typeof DOCUMENT_TYPES;
+type DocumentType = keyof typeof DOCUMENT_TYPES;
 /**
  * Return a const for the document type of a shape (looks at mimeType)
  *
@@ -1059,14 +1058,14 @@ declare type DocumentType = keyof typeof DOCUMENT_TYPES;
  */
 declare const getShapeDocumentType: (shape?: ShapeType) => DocumentType;
 
-declare type FilteredShapeListObject = {
+type FilteredShapeListObject = {
     src: string;
     type: string;
     shape: ShapeType;
     parsedShape: ParsedShapeType;
     [key: string]: string | ParsedShapeType | ShapeType;
 };
-declare type FilterShapeSourceOption = {
+type FilterShapeSourceOption = {
     sortPriority?: Function;
     allowedMimeTypes?: string[];
     allowedMethods?: string[];
@@ -1093,7 +1092,7 @@ declare const SHAPE_MEDIA_TYPES: {
     readonly DOCUMENT: "DOCUMENT";
     readonly BINARY: "BINARY";
 };
-declare type ShapeMediaType = keyof typeof SHAPE_MEDIA_TYPES;
+type ShapeMediaType = keyof typeof SHAPE_MEDIA_TYPES;
 /**
  * Returns a const for which media type a shape has
  *
@@ -1121,7 +1120,7 @@ declare const findNearestThumbnail: (itemType: ItemType, timeCode: TimeCode | Ti
 /**
  * TODO
  */
-declare type ParsedMediaConvertTranscodePreset = {
+type ParsedMediaConvertTranscodePreset = {
     description?: string;
     containerFormat?: any;
     videoFormat?: string;
@@ -1148,10 +1147,7 @@ declare type ParsedMediaConvertTranscodePreset = {
  */
 declare const parseMediaConvertPreset: (mediaconvert: TranscodePresetType['mediaconvert']) => ParsedMediaConvertTranscodePreset;
 
-/**
- * TODO
- */
-declare type ParsedTranscodePreset = {
+type ParsedTranscodePreset = {
     description?: string;
     containerFormat?: any;
     videoFormat?: string;
@@ -1170,10 +1166,10 @@ declare type ParsedTranscodePreset = {
     audioChannels?: number;
 };
 /**
- * TODO
+ * Parse a VidiCore transcode preset
  *
- * @param transcodePresetType
- * @returns
+ * @param transcodePresetType a VidiCore transcode preset
+ * @returns A parsed transcode preset
  *
  * @category Transcode
  */