@vidispine/types 23.2.0-pre.2 → 23.3.0-pre.1

package/dist/index.d.ts

@@ -116,10 +116,17 @@ export declare type AccessKeyType = {
     id?: string;
     name?: string;
     secret?: string;
-    status: 'ACTIVE' | 'INACTIVE';
+    status: AccessKeyType.status;
     created: string;
 };
 
+export declare namespace AccessKeyType {
+    export enum status {
+        ACTIVE = "ACTIVE",
+        INACTIVE = "INACTIVE"
+    }
+}
+
 export declare type add = SolrAddType;
 
 export declare type AddressPortType = {
@@ -345,7 +352,10 @@ export declare type AutoImportRuleType = {
     resourceId?: SiteIdType;
 };
 
-export declare type AutoProjectionInputFilterType = 'oldMetadata' | 'shapeDocument';
+export declare enum AutoProjectionInputFilterType {
+    OLD_METADATA = "oldMetadata",
+    SHAPE_DOCUMENT = "shapeDocument"
+}
 
 export declare type AutoProjectionRuleDocument = AutoProjectionRuleType;
 
@@ -367,7 +377,11 @@ export declare type AutoProjectionStepType = {
     description?: string;
 };
 
-export declare type AutoProjectionTriggerType = 'shapeMetadata' | 'itemMetadata' | 'bulkyMetadata';
+export declare enum AutoProjectionTriggerType {
+    SHAPE_METADATA = "shapeMetadata",
+    ITEM_METADATA = "itemMetadata",
+    BULKY_METADATA = "bulkyMetadata"
+}
 
 export declare type BaseMediaInfoType = {
     Bit_rate_mode?: string;
@@ -584,9 +598,18 @@ export declare type CodecType = {
     name?: string;
 };
 
-export declare type CollectionContentEntityTypeType = 'item' | 'library' | 'collection';
+export declare enum CollectionContentEntityTypeType {
+    ITEM = "item",
+    LIBRARY = "library",
+    COLLECTION = "collection"
+}
 
-export declare type CollectionContentModeType = 'add' | 'remove' | 'move' | 'update';
+export declare enum CollectionContentModeType {
+    ADD = "add",
+    REMOVE = "remove",
+    MOVE = "move",
+    UPDATE = "update"
+}
 
 export declare type CollectionContentType = {
     id?: string;
@@ -886,7 +909,13 @@ export declare type ComponentType = {
     metadata?: Array<KeyValuePairType>;
 };
 
-export declare type ComponentTypeType = 'AUDIO_COMPONENT' | 'VIDEO_COMPONENT' | 'CONTAINER_COMPONENT' | 'BINARY_COMPONENT' | 'DESCRIPTOR_COMPONENT';
+export declare enum ComponentTypeType {
+    AUDIO_COMPONENT = "AUDIO_COMPONENT",
+    VIDEO_COMPONENT = "VIDEO_COMPONENT",
+    CONTAINER_COMPONENT = "CONTAINER_COMPONENT",
+    BINARY_COMPONENT = "BINARY_COMPONENT",
+    DESCRIPTOR_COMPONENT = "DESCRIPTOR_COMPONENT"
+}
 
 export declare type CompType = {
     name: string;
@@ -1341,7 +1370,10 @@ export declare type ExportTemplateArchive = ExportTemplateType & {
     method: ExportTemplateArchiveType;
 };
 
-export declare type ExportTemplateArchiveType = 'ZIP' | 'TAR';
+export declare enum ExportTemplateArchiveType {
+    ZIP = "ZIP",
+    TAR = "TAR"
+}
 
 export declare type ExportTemplateCollection = ExportTemplateType & {
     collectionId?: Array<SiteIdType>;
@@ -1355,7 +1387,10 @@ export declare type ExportTemplateCompress = ExportTemplateType & {
     method: ExportTemplateCompressType;
 };
 
-export declare type ExportTemplateCompressType = 'GZ' | 'BZIP2';
+export declare enum ExportTemplateCompressType {
+    GZ = "GZ",
+    BZIP2 = "BZIP2"
+}
 
 export declare type ExportTemplateDocument = ExportTemplateType;
 
@@ -2020,7 +2055,18 @@ export declare type JobLogEntryType = {
     value?: string;
 };
 
-export declare type jobNotificationContentFilter = 'jobId' | 'jobState' | 'user' | 'startTime' | 'jobType' | 'jobData' | 'errorMessage' | 'itemId' | 'totalSteps' | 'currentStep';
+export declare enum jobNotificationContentFilter {
+    JOB_ID = "jobId",
+    JOB_STATE = "jobState",
+    USER = "user",
+    START_TIME = "startTime",
+    JOB_TYPE = "jobType",
+    JOB_DATA = "jobData",
+    ERROR_MESSAGE = "errorMessage",
+    ITEM_ID = "itemId",
+    TOTAL_STEPS = "totalSteps",
+    CURRENT_STEP = "currentStep"
+}
 
 export declare type JobPoolDocument = JobPoolType;
 
@@ -2133,7 +2179,10 @@ export declare type JobTaskProgressType = {
     value?: number;
 };
 
-export declare type JobTaskProgressType_unit = 'bytes' | 'percent';
+export declare enum JobTaskProgressType_unit {
+    BYTES = "bytes",
+    PERCENT = "percent"
+}
 
 export declare type JobTaskType = {
     step: number;
@@ -2507,7 +2556,11 @@ export declare type MetadataFieldGroupType = {
     inheritance?: string;
 };
 
-export declare type MetadataFieldIndexType = 'noindex' | 'index' | 'extend';
+export declare enum MetadataFieldIndexType {
+    NOINDEX = "noindex",
+    INDEX = "index",
+    EXTEND = "extend"
+}
 
 export declare type MetadataFieldIntegerType = {
     minInclusive?: number;
@@ -2588,7 +2641,28 @@ export declare type MetadataFieldType = {
     inheritance?: string;
 };
 
-export declare type MetadataFieldTypeType = 'date' | 'date-noindex' | 'date-sortable' | 'float' | 'float-noindex' | 'float-sortable' | 'integer' | 'integer-noindex' | 'integer-sortable' | 'long' | 'long-noindex' | 'string' | 'string-sortable' | 'string-exact' | 'string-exact-sortable' | 'string-noindex' | 'boolean' | 'boolean-noindex' | 'timeCode' | 'timeCode-noindex';
+export declare enum MetadataFieldTypeType {
+    DATE = "date",
+    DATE_NOINDEX = "date-noindex",
+    DATE_SORTABLE = "date-sortable",
+    FLOAT = "float",
+    FLOAT_NOINDEX = "float-noindex",
+    FLOAT_SORTABLE = "float-sortable",
+    INTEGER = "integer",
+    INTEGER_NOINDEX = "integer-noindex",
+    INTEGER_SORTABLE = "integer-sortable",
+    LONG = "long",
+    LONG_NOINDEX = "long-noindex",
+    STRING = "string",
+    STRING_SORTABLE = "string-sortable",
+    STRING_EXACT = "string-exact",
+    STRING_EXACT_SORTABLE = "string-exact-sortable",
+    STRING_NOINDEX = "string-noindex",
+    BOOLEAN = "boolean",
+    BOOLEAN_NOINDEX = "boolean-noindex",
+    TIME_CODE = "timeCode",
+    TIME_CODE_NOINDEX = "timeCode-noindex"
+}
 
 export declare type MetadataFieldValidationDocument = MetadataFieldValidationType;
 
@@ -2636,6 +2710,7 @@ export declare type MetadataGroupSearchType = {
     text?: Array<ItemSearchTextValueType>;
     field?: Array<SearchFieldType>;
     operator?: MetadataGroupSearchOperatorType;
+    item?: ItemCriterionType;
     filter?: Array<SearchFilterType>;
     facetFilter?: Array<FacetFilterType>;
     facet?: Array<SearchFacetType>;
@@ -2682,7 +2757,10 @@ export declare type MetadataLockType = {
     field?: Array<string>;
 };
 
-export declare type MetadataModeType = 'add' | 'remove';
+export declare enum MetadataModeType {
+    ADD = "add",
+    REMOVE = "remove"
+}
 
 export declare type MetadataReferencedType = {
     id: string;
@@ -3146,7 +3224,16 @@ export declare type OAuth2ConfigurationType = {
     publicKey?: Array<string>;
 };
 
-export declare type OSName = 'DEBIAN32' | 'DEBIAN64' | 'REDHAT32' | 'REDHAT64' | 'WINDOWS32' | 'WINDOWS64' | 'MACOSX32' | 'MACOSX64';
+export declare enum OSName {
+    DEBIAN32 = "DEBIAN32",
+    DEBIAN64 = "DEBIAN64",
+    REDHAT32 = "REDHAT32",
+    REDHAT64 = "REDHAT64",
+    WINDOWS32 = "WINDOWS32",
+    WINDOWS64 = "WINDOWS64",
+    MACOSX32 = "MACOSX32",
+    MACOSX64 = "MACOSX64"
+}
 
 export declare type OtifConfigurationDocument = OtifConfigurationType;
 
@@ -3197,7 +3284,10 @@ export declare type OtifOSType = {
     file: Array<string>;
 };
 
-export declare type OtifPluginType = 'audio' | 'video';
+export declare enum OtifPluginType {
+    AUDIO = "audio",
+    VIDEO = "video"
+}
 
 export declare type OtifPresetDocument = OtifPresetType;
 
@@ -3384,7 +3474,10 @@ export declare type QuotaFilterType = {
     exceeded?: boolean;
 };
 
-export declare type QuotaResourceType = 'item' | 'storage';
+export declare enum QuotaResourceType {
+    ITEM = "item",
+    STORAGE = "storage"
+}
 
 export declare type QuotaRuleDocument = QuotaRuleType;
 
@@ -3415,7 +3508,11 @@ export declare type RationalType = {
     denominator: number;
 };
 
-export declare type REDDecoderType = 'CPU' | 'CUDA' | 'OPENCL';
+export declare enum REDDecoderType {
+    CPU = "CPU",
+    CUDA = "CUDA",
+    OPENCL = "OPENCL"
+}
 
 export declare type ReindexRequestDocument = ReindexRequestType;
 
@@ -3429,9 +3526,20 @@ export declare type ReindexRequestType = {
     indexesTotal?: number;
 };
 
-export declare type RelationType = 'child' | 'parent' | 'descendant' | 'ancestor';
+export declare enum RelationType {
+    CHILD = "child",
+    PARENT = "parent",
+    DESCENDANT = "descendant",
+    ANCESTOR = "ancestor"
+}
 
-export declare type Reply = {};
+export declare type Reply = {
+    JobInfo?: CarbonJobInfoType;
+    GUID?: GUIDType;
+    Success: string;
+    Error?: string;
+    'NrOfJobs.DWD'?: number;
+};
 
 export declare type ResolutionType = {
     width: number;
@@ -3479,7 +3587,11 @@ export declare type ResourceTypeListType = {
     }>;
 };
 
-export declare type S3CredentialType = 'none' | 'temporary' | 'secretkey';
+export declare enum S3CredentialType {
+    NONE = "none",
+    TEMPORARY = "temporary",
+    SECRETKEY = "secretkey"
+}
 
 export declare type ScalingType = {
     width?: number;
@@ -3587,9 +3699,17 @@ export declare type SearchHistoryType = {
     query: ItemSearchType;
 };
 
-export declare type SearchIntervalsType = 'all' | 'generic' | 'timed';
+export declare enum SearchIntervalsType {
+    ALL = "all",
+    GENERIC = "generic",
+    TIMED = "timed"
+}
 
-export declare type SearchOperationType = 'AND' | 'OR' | 'NOT';
+export declare enum SearchOperationType {
+    AND = "AND",
+    OR = "OR",
+    NOT = "NOT"
+}
 
 export declare type SearchOperatorType = {
     text?: Array<ItemSearchTextValueType>;
@@ -3605,7 +3725,10 @@ export declare type SearchOperatorType = {
     operation: SearchOperationType;
 };
 
-export declare type SearchPermissionType = 'WRITE' | 'READ';
+export declare enum SearchPermissionType {
+    WRITE = "WRITE",
+    READ = "READ"
+}
 
 export declare type SearchResultDocument = SearchResultType;
 
@@ -3646,7 +3769,24 @@ export declare type SearchResultType = {
     nextCursor?: string;
 };
 
-export declare type SearchTargetType = 'item' | 'shape' | 'file';
+export declare enum SearchTargetType {
+    ITEM = "item",
+    SHAPE = "shape",
+    FILE = "file"
+}
+
+export declare type SecretDocument = SecretType;
+
+export declare type SecretListDocument = SecretListType;
+
+export declare type SecretListType = {
+    secret?: Array<SecretType>;
+};
+
+export declare type SecretType = {
+    alias: string;
+    key?: Array<string>;
+};
 
 export declare type SegmentationJobDocument = SegmentationJobType;
 
@@ -3864,7 +4004,11 @@ export declare type SimpleSearchFieldType = {
     value: string;
 };
 
-export declare type SimpleSearchOperationType = 'AND' | 'OR' | 'NOT';
+export declare enum SimpleSearchOperationType {
+    AND = "AND",
+    OR = "OR",
+    NOT = "NOT"
+}
 
 export declare type SimpleSearchOperatorType = {
     field?: Array<SimpleSearchFieldType>;
@@ -4003,7 +4147,10 @@ export declare type SolrDocumentType = {
     }>;
 };
 
-export declare type SortingOrderType = 'ascending' | 'descending';
+export declare enum SortingOrderType {
+    ASCENDING = "ascending",
+    DESCENDING = "descending"
+}
 
 export declare type StatsDRecieverType = {
     destination: AddressPortType;
@@ -4017,7 +4164,10 @@ export declare type StatsdReporterType = MetricsReporterType & {
     tags?: boolean;
 };
 
-export declare type StorageCriteriaType = 'bandwidth' | 'capacity';
+export declare enum StorageCriteriaType {
+    BANDWIDTH = "bandwidth",
+    CAPACITY = "capacity"
+}
 
 export declare type StorageDocument = StorageType;
 
@@ -4191,7 +4341,10 @@ export declare type SupportedProtocolsType = {
     }>;
 };
 
-export declare type SyncPolicyType = 'ONDEMAND' | 'ALWAYS';
+export declare enum SyncPolicyType {
+    ONDEMAND = "ONDEMAND",
+    ALWAYS = "ALWAYS"
+}
 
 export declare type SystemInfoType = {
     macaddress?: Array<string>;
@@ -4314,6 +4467,18 @@ export declare type ThumbnailInfoType = {
     uri: string;
 };
 
+export declare type ThumbnailMultiDocument = ThumbnailMultiType;
+
+export declare type ThumbnailMultiType = {
+    thumbnail?: Array<{
+        version?: number;
+        type?: string;
+        image: string;
+        timecode?: TimeCodeType;
+        tc?: string;
+    }>;
+};
+
 export declare type ThumbnailServiceType = {
     path: string;
     state: string;
@@ -4509,7 +4674,7 @@ export declare type TranscoderLicenseStatusType = {
 };
 
 export declare type TranscoderType = {
-    type?: 'TRANSCODER' | 'DIRECTORY';
+    type?: TranscoderType.type;
     url: string;
     version?: string;
     reverseAddress?: string;
@@ -4524,6 +4689,13 @@ export declare type TranscoderType = {
     resourceTag?: Array<KeyValuePairType>;
 };
 
+export declare namespace TranscoderType {
+    export enum type {
+        TRANSCODER = "TRANSCODER",
+        DIRECTORY = "DIRECTORY"
+    }
+}
+
 export declare type TranscoderVersionDocument = TranscoderVersionType;
 
 export declare type TranscoderVersionType = {
@@ -4815,7 +4987,10 @@ export declare type VXAListType = {
     vxa?: Array<VXAType>;
 };
 
-export declare type VXAStatus = 'OFFLINE' | 'ONLINE';
+export declare enum VXAStatus {
+    OFFLINE = "OFFLINE",
+    ONLINE = "ONLINE"
+}
 
 export declare type VXAStorageCapacityDocument = VXAStorageCapacityType;
 
@@ -4919,7 +5094,15 @@ export declare type WebsocketUpdateType = {
     vxa?: VXAUpdateType;
 };
 
-export declare type WeekDayType = 'MONDAY' | 'TUESDAY' | 'WEDNESDAY' | 'THURSDAY' | 'FRIDAY' | 'SATURDAY' | 'SUNDAY';
+export declare enum WeekDayType {
+    MONDAY = "MONDAY",
+    TUESDAY = "TUESDAY",
+    WEDNESDAY = "WEDNESDAY",
+    THURSDAY = "THURSDAY",
+    FRIDAY = "FRIDAY",
+    SATURDAY = "SATURDAY",
+    SUNDAY = "SUNDAY"
+}
 
 export declare type XMPJobDocument = XMPJobType;
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vidispine/types",
-  "version": "23.2.0-pre.2",
+  "version": "23.3.0-pre.1",
   "license": "SEE LICENSE IN LICENSE.md",
   "publishConfig": {
     "access": "public"
@@ -18,18 +18,18 @@
     "build": "yarn vite build",
     "build:watch": "yarn vite build --watch --mode development",
     "format": "prettier . --check",
-    "lint": "eslint . --max-warnings=0 --ext .js,.jsx,.ts,.tsx,.md,.mdx"
+    "lint": "eslint . --cache --max-warnings=0 --ext .js,.jsx,.ts,.tsx,.md,.mdx"
   },
   "devDependencies": {
-    "@vidispine/eslint-config-base": "23.2.0-pre.2",
-    "@vidispine/eslint-config-mdx": "23.2.0-pre.2",
-    "@vidispine/eslint-config-typescript": "23.2.0-pre.2",
-    "@vidispine/prettier-config": "23.2.0-pre.2",
+    "@vidispine/eslint-config-base": "23.3.0-pre.1",
+    "@vidispine/eslint-config-mdx": "23.3.0-pre.1",
+    "@vidispine/eslint-config-typescript": "23.3.0-pre.1",
+    "@vidispine/prettier-config": "23.3.0-pre.1",
     "eslint": "8.34.0",
     "prettier": "2.8.4",
     "typescript": "4.9.5",
-    "vite": "4.2.0",
-    "vite-plugin-dts": "2.1.0"
+    "vite": "4.3.1",
+    "vite-plugin-dts": "2.3.0"
   },
   "eslintConfig": {
     "extends": [