@vidispine/types 23.2.0-pre.2 → 23.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/dist/index.d.ts +189 -31
  2. package/package.json +8 -8
package/dist/index.d.ts CHANGED
@@ -116,10 +116,17 @@ export declare type AccessKeyType = {
116
116
  id?: string;
117
117
  name?: string;
118
118
  secret?: string;
119
- status: 'ACTIVE' | 'INACTIVE';
119
+ status: AccessKeyType.status;
120
120
  created: string;
121
121
  };
122
122
 
123
+ export declare namespace AccessKeyType {
124
+ export enum status {
125
+ ACTIVE = "ACTIVE",
126
+ INACTIVE = "INACTIVE"
127
+ }
128
+ }
129
+
123
130
  export declare type add = SolrAddType;
124
131
 
125
132
  export declare type AddressPortType = {
@@ -345,7 +352,10 @@ export declare type AutoImportRuleType = {
345
352
  resourceId?: SiteIdType;
346
353
  };
347
354
 
348
- export declare type AutoProjectionInputFilterType = 'oldMetadata' | 'shapeDocument';
355
+ export declare enum AutoProjectionInputFilterType {
356
+ OLD_METADATA = "oldMetadata",
357
+ SHAPE_DOCUMENT = "shapeDocument"
358
+ }
349
359
 
350
360
  export declare type AutoProjectionRuleDocument = AutoProjectionRuleType;
351
361
 
@@ -367,7 +377,11 @@ export declare type AutoProjectionStepType = {
367
377
  description?: string;
368
378
  };
369
379
 
370
- export declare type AutoProjectionTriggerType = 'shapeMetadata' | 'itemMetadata' | 'bulkyMetadata';
380
+ export declare enum AutoProjectionTriggerType {
381
+ SHAPE_METADATA = "shapeMetadata",
382
+ ITEM_METADATA = "itemMetadata",
383
+ BULKY_METADATA = "bulkyMetadata"
384
+ }
371
385
 
372
386
  export declare type BaseMediaInfoType = {
373
387
  Bit_rate_mode?: string;
@@ -584,9 +598,18 @@ export declare type CodecType = {
584
598
  name?: string;
585
599
  };
586
600
 
587
- export declare type CollectionContentEntityTypeType = 'item' | 'library' | 'collection';
601
+ export declare enum CollectionContentEntityTypeType {
602
+ ITEM = "item",
603
+ LIBRARY = "library",
604
+ COLLECTION = "collection"
605
+ }
588
606
 
589
- export declare type CollectionContentModeType = 'add' | 'remove' | 'move' | 'update';
607
+ export declare enum CollectionContentModeType {
608
+ ADD = "add",
609
+ REMOVE = "remove",
610
+ MOVE = "move",
611
+ UPDATE = "update"
612
+ }
590
613
 
591
614
  export declare type CollectionContentType = {
592
615
  id?: string;
@@ -886,7 +909,13 @@ export declare type ComponentType = {
886
909
  metadata?: Array<KeyValuePairType>;
887
910
  };
888
911
 
889
- export declare type ComponentTypeType = 'AUDIO_COMPONENT' | 'VIDEO_COMPONENT' | 'CONTAINER_COMPONENT' | 'BINARY_COMPONENT' | 'DESCRIPTOR_COMPONENT';
912
+ export declare enum ComponentTypeType {
913
+ AUDIO_COMPONENT = "AUDIO_COMPONENT",
914
+ VIDEO_COMPONENT = "VIDEO_COMPONENT",
915
+ CONTAINER_COMPONENT = "CONTAINER_COMPONENT",
916
+ BINARY_COMPONENT = "BINARY_COMPONENT",
917
+ DESCRIPTOR_COMPONENT = "DESCRIPTOR_COMPONENT"
918
+ }
890
919
 
891
920
  export declare type CompType = {
892
921
  name: string;
@@ -1341,7 +1370,10 @@ export declare type ExportTemplateArchive = ExportTemplateType & {
1341
1370
  method: ExportTemplateArchiveType;
1342
1371
  };
1343
1372
 
1344
- export declare type ExportTemplateArchiveType = 'ZIP' | 'TAR';
1373
+ export declare enum ExportTemplateArchiveType {
1374
+ ZIP = "ZIP",
1375
+ TAR = "TAR"
1376
+ }
1345
1377
 
1346
1378
  export declare type ExportTemplateCollection = ExportTemplateType & {
1347
1379
  collectionId?: Array<SiteIdType>;
@@ -1355,7 +1387,10 @@ export declare type ExportTemplateCompress = ExportTemplateType & {
1355
1387
  method: ExportTemplateCompressType;
1356
1388
  };
1357
1389
 
1358
- export declare type ExportTemplateCompressType = 'GZ' | 'BZIP2';
1390
+ export declare enum ExportTemplateCompressType {
1391
+ GZ = "GZ",
1392
+ BZIP2 = "BZIP2"
1393
+ }
1359
1394
 
1360
1395
  export declare type ExportTemplateDocument = ExportTemplateType;
1361
1396
 
@@ -2020,7 +2055,18 @@ export declare type JobLogEntryType = {
2020
2055
  value?: string;
2021
2056
  };
2022
2057
 
2023
- export declare type jobNotificationContentFilter = 'jobId' | 'jobState' | 'user' | 'startTime' | 'jobType' | 'jobData' | 'errorMessage' | 'itemId' | 'totalSteps' | 'currentStep';
2058
+ export declare enum jobNotificationContentFilter {
2059
+ JOB_ID = "jobId",
2060
+ JOB_STATE = "jobState",
2061
+ USER = "user",
2062
+ START_TIME = "startTime",
2063
+ JOB_TYPE = "jobType",
2064
+ JOB_DATA = "jobData",
2065
+ ERROR_MESSAGE = "errorMessage",
2066
+ ITEM_ID = "itemId",
2067
+ TOTAL_STEPS = "totalSteps",
2068
+ CURRENT_STEP = "currentStep"
2069
+ }
2024
2070
 
2025
2071
  export declare type JobPoolDocument = JobPoolType;
2026
2072
 
@@ -2133,7 +2179,10 @@ export declare type JobTaskProgressType = {
2133
2179
  value?: number;
2134
2180
  };
2135
2181
 
2136
- export declare type JobTaskProgressType_unit = 'bytes' | 'percent';
2182
+ export declare enum JobTaskProgressType_unit {
2183
+ BYTES = "bytes",
2184
+ PERCENT = "percent"
2185
+ }
2137
2186
 
2138
2187
  export declare type JobTaskType = {
2139
2188
  step: number;
@@ -2507,7 +2556,11 @@ export declare type MetadataFieldGroupType = {
2507
2556
  inheritance?: string;
2508
2557
  };
2509
2558
 
2510
- export declare type MetadataFieldIndexType = 'noindex' | 'index' | 'extend';
2559
+ export declare enum MetadataFieldIndexType {
2560
+ NOINDEX = "noindex",
2561
+ INDEX = "index",
2562
+ EXTEND = "extend"
2563
+ }
2511
2564
 
2512
2565
  export declare type MetadataFieldIntegerType = {
2513
2566
  minInclusive?: number;
@@ -2588,7 +2641,28 @@ export declare type MetadataFieldType = {
2588
2641
  inheritance?: string;
2589
2642
  };
2590
2643
 
2591
- 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';
2644
+ export declare enum MetadataFieldTypeType {
2645
+ DATE = "date",
2646
+ DATE_NOINDEX = "date-noindex",
2647
+ DATE_SORTABLE = "date-sortable",
2648
+ FLOAT = "float",
2649
+ FLOAT_NOINDEX = "float-noindex",
2650
+ FLOAT_SORTABLE = "float-sortable",
2651
+ INTEGER = "integer",
2652
+ INTEGER_NOINDEX = "integer-noindex",
2653
+ INTEGER_SORTABLE = "integer-sortable",
2654
+ LONG = "long",
2655
+ LONG_NOINDEX = "long-noindex",
2656
+ STRING = "string",
2657
+ STRING_SORTABLE = "string-sortable",
2658
+ STRING_EXACT = "string-exact",
2659
+ STRING_EXACT_SORTABLE = "string-exact-sortable",
2660
+ STRING_NOINDEX = "string-noindex",
2661
+ BOOLEAN = "boolean",
2662
+ BOOLEAN_NOINDEX = "boolean-noindex",
2663
+ TIME_CODE = "timeCode",
2664
+ TIME_CODE_NOINDEX = "timeCode-noindex"
2665
+ }
2592
2666
 
2593
2667
  export declare type MetadataFieldValidationDocument = MetadataFieldValidationType;
2594
2668
 
@@ -2636,6 +2710,7 @@ export declare type MetadataGroupSearchType = {
2636
2710
  text?: Array<ItemSearchTextValueType>;
2637
2711
  field?: Array<SearchFieldType>;
2638
2712
  operator?: MetadataGroupSearchOperatorType;
2713
+ item?: ItemCriterionType;
2639
2714
  filter?: Array<SearchFilterType>;
2640
2715
  facetFilter?: Array<FacetFilterType>;
2641
2716
  facet?: Array<SearchFacetType>;
@@ -2682,7 +2757,10 @@ export declare type MetadataLockType = {
2682
2757
  field?: Array<string>;
2683
2758
  };
2684
2759
 
2685
- export declare type MetadataModeType = 'add' | 'remove';
2760
+ export declare enum MetadataModeType {
2761
+ ADD = "add",
2762
+ REMOVE = "remove"
2763
+ }
2686
2764
 
2687
2765
  export declare type MetadataReferencedType = {
2688
2766
  id: string;
@@ -3146,7 +3224,16 @@ export declare type OAuth2ConfigurationType = {
3146
3224
  publicKey?: Array<string>;
3147
3225
  };
3148
3226
 
3149
- export declare type OSName = 'DEBIAN32' | 'DEBIAN64' | 'REDHAT32' | 'REDHAT64' | 'WINDOWS32' | 'WINDOWS64' | 'MACOSX32' | 'MACOSX64';
3227
+ export declare enum OSName {
3228
+ DEBIAN32 = "DEBIAN32",
3229
+ DEBIAN64 = "DEBIAN64",
3230
+ REDHAT32 = "REDHAT32",
3231
+ REDHAT64 = "REDHAT64",
3232
+ WINDOWS32 = "WINDOWS32",
3233
+ WINDOWS64 = "WINDOWS64",
3234
+ MACOSX32 = "MACOSX32",
3235
+ MACOSX64 = "MACOSX64"
3236
+ }
3150
3237
 
3151
3238
  export declare type OtifConfigurationDocument = OtifConfigurationType;
3152
3239
 
@@ -3197,7 +3284,10 @@ export declare type OtifOSType = {
3197
3284
  file: Array<string>;
3198
3285
  };
3199
3286
 
3200
- export declare type OtifPluginType = 'audio' | 'video';
3287
+ export declare enum OtifPluginType {
3288
+ AUDIO = "audio",
3289
+ VIDEO = "video"
3290
+ }
3201
3291
 
3202
3292
  export declare type OtifPresetDocument = OtifPresetType;
3203
3293
 
@@ -3384,7 +3474,10 @@ export declare type QuotaFilterType = {
3384
3474
  exceeded?: boolean;
3385
3475
  };
3386
3476
 
3387
- export declare type QuotaResourceType = 'item' | 'storage';
3477
+ export declare enum QuotaResourceType {
3478
+ ITEM = "item",
3479
+ STORAGE = "storage"
3480
+ }
3388
3481
 
3389
3482
  export declare type QuotaRuleDocument = QuotaRuleType;
3390
3483
 
@@ -3415,7 +3508,11 @@ export declare type RationalType = {
3415
3508
  denominator: number;
3416
3509
  };
3417
3510
 
3418
- export declare type REDDecoderType = 'CPU' | 'CUDA' | 'OPENCL';
3511
+ export declare enum REDDecoderType {
3512
+ CPU = "CPU",
3513
+ CUDA = "CUDA",
3514
+ OPENCL = "OPENCL"
3515
+ }
3419
3516
 
3420
3517
  export declare type ReindexRequestDocument = ReindexRequestType;
3421
3518
 
@@ -3429,9 +3526,20 @@ export declare type ReindexRequestType = {
3429
3526
  indexesTotal?: number;
3430
3527
  };
3431
3528
 
3432
- export declare type RelationType = 'child' | 'parent' | 'descendant' | 'ancestor';
3529
+ export declare enum RelationType {
3530
+ CHILD = "child",
3531
+ PARENT = "parent",
3532
+ DESCENDANT = "descendant",
3533
+ ANCESTOR = "ancestor"
3534
+ }
3433
3535
 
3434
- export declare type Reply = {};
3536
+ export declare type Reply = {
3537
+ JobInfo?: CarbonJobInfoType;
3538
+ GUID?: GUIDType;
3539
+ Success: string;
3540
+ Error?: string;
3541
+ 'NrOfJobs.DWD'?: number;
3542
+ };
3435
3543
 
3436
3544
  export declare type ResolutionType = {
3437
3545
  width: number;
@@ -3479,7 +3587,11 @@ export declare type ResourceTypeListType = {
3479
3587
  }>;
3480
3588
  };
3481
3589
 
3482
- export declare type S3CredentialType = 'none' | 'temporary' | 'secretkey';
3590
+ export declare enum S3CredentialType {
3591
+ NONE = "none",
3592
+ TEMPORARY = "temporary",
3593
+ SECRETKEY = "secretkey"
3594
+ }
3483
3595
 
3484
3596
  export declare type ScalingType = {
3485
3597
  width?: number;
@@ -3587,9 +3699,17 @@ export declare type SearchHistoryType = {
3587
3699
  query: ItemSearchType;
3588
3700
  };
3589
3701
 
3590
- export declare type SearchIntervalsType = 'all' | 'generic' | 'timed';
3702
+ export declare enum SearchIntervalsType {
3703
+ ALL = "all",
3704
+ GENERIC = "generic",
3705
+ TIMED = "timed"
3706
+ }
3591
3707
 
3592
- export declare type SearchOperationType = 'AND' | 'OR' | 'NOT';
3708
+ export declare enum SearchOperationType {
3709
+ AND = "AND",
3710
+ OR = "OR",
3711
+ NOT = "NOT"
3712
+ }
3593
3713
 
3594
3714
  export declare type SearchOperatorType = {
3595
3715
  text?: Array<ItemSearchTextValueType>;
@@ -3605,7 +3725,10 @@ export declare type SearchOperatorType = {
3605
3725
  operation: SearchOperationType;
3606
3726
  };
3607
3727
 
3608
- export declare type SearchPermissionType = 'WRITE' | 'READ';
3728
+ export declare enum SearchPermissionType {
3729
+ WRITE = "WRITE",
3730
+ READ = "READ"
3731
+ }
3609
3732
 
3610
3733
  export declare type SearchResultDocument = SearchResultType;
3611
3734
 
@@ -3646,7 +3769,11 @@ export declare type SearchResultType = {
3646
3769
  nextCursor?: string;
3647
3770
  };
3648
3771
 
3649
- export declare type SearchTargetType = 'item' | 'shape' | 'file';
3772
+ export declare enum SearchTargetType {
3773
+ ITEM = "item",
3774
+ SHAPE = "shape",
3775
+ FILE = "file"
3776
+ }
3650
3777
 
3651
3778
  export declare type SegmentationJobDocument = SegmentationJobType;
3652
3779
 
@@ -3864,7 +3991,11 @@ export declare type SimpleSearchFieldType = {
3864
3991
  value: string;
3865
3992
  };
3866
3993
 
3867
- export declare type SimpleSearchOperationType = 'AND' | 'OR' | 'NOT';
3994
+ export declare enum SimpleSearchOperationType {
3995
+ AND = "AND",
3996
+ OR = "OR",
3997
+ NOT = "NOT"
3998
+ }
3868
3999
 
3869
4000
  export declare type SimpleSearchOperatorType = {
3870
4001
  field?: Array<SimpleSearchFieldType>;
@@ -4003,7 +4134,10 @@ export declare type SolrDocumentType = {
4003
4134
  }>;
4004
4135
  };
4005
4136
 
4006
- export declare type SortingOrderType = 'ascending' | 'descending';
4137
+ export declare enum SortingOrderType {
4138
+ ASCENDING = "ascending",
4139
+ DESCENDING = "descending"
4140
+ }
4007
4141
 
4008
4142
  export declare type StatsDRecieverType = {
4009
4143
  destination: AddressPortType;
@@ -4017,7 +4151,10 @@ export declare type StatsdReporterType = MetricsReporterType & {
4017
4151
  tags?: boolean;
4018
4152
  };
4019
4153
 
4020
- export declare type StorageCriteriaType = 'bandwidth' | 'capacity';
4154
+ export declare enum StorageCriteriaType {
4155
+ BANDWIDTH = "bandwidth",
4156
+ CAPACITY = "capacity"
4157
+ }
4021
4158
 
4022
4159
  export declare type StorageDocument = StorageType;
4023
4160
 
@@ -4191,7 +4328,10 @@ export declare type SupportedProtocolsType = {
4191
4328
  }>;
4192
4329
  };
4193
4330
 
4194
- export declare type SyncPolicyType = 'ONDEMAND' | 'ALWAYS';
4331
+ export declare enum SyncPolicyType {
4332
+ ONDEMAND = "ONDEMAND",
4333
+ ALWAYS = "ALWAYS"
4334
+ }
4195
4335
 
4196
4336
  export declare type SystemInfoType = {
4197
4337
  macaddress?: Array<string>;
@@ -4509,7 +4649,7 @@ export declare type TranscoderLicenseStatusType = {
4509
4649
  };
4510
4650
 
4511
4651
  export declare type TranscoderType = {
4512
- type?: 'TRANSCODER' | 'DIRECTORY';
4652
+ type?: TranscoderType.type;
4513
4653
  url: string;
4514
4654
  version?: string;
4515
4655
  reverseAddress?: string;
@@ -4524,6 +4664,13 @@ export declare type TranscoderType = {
4524
4664
  resourceTag?: Array<KeyValuePairType>;
4525
4665
  };
4526
4666
 
4667
+ export declare namespace TranscoderType {
4668
+ export enum type {
4669
+ TRANSCODER = "TRANSCODER",
4670
+ DIRECTORY = "DIRECTORY"
4671
+ }
4672
+ }
4673
+
4527
4674
  export declare type TranscoderVersionDocument = TranscoderVersionType;
4528
4675
 
4529
4676
  export declare type TranscoderVersionType = {
@@ -4815,7 +4962,10 @@ export declare type VXAListType = {
4815
4962
  vxa?: Array<VXAType>;
4816
4963
  };
4817
4964
 
4818
- export declare type VXAStatus = 'OFFLINE' | 'ONLINE';
4965
+ export declare enum VXAStatus {
4966
+ OFFLINE = "OFFLINE",
4967
+ ONLINE = "ONLINE"
4968
+ }
4819
4969
 
4820
4970
  export declare type VXAStorageCapacityDocument = VXAStorageCapacityType;
4821
4971
 
@@ -4919,7 +5069,15 @@ export declare type WebsocketUpdateType = {
4919
5069
  vxa?: VXAUpdateType;
4920
5070
  };
4921
5071
 
4922
- export declare type WeekDayType = 'MONDAY' | 'TUESDAY' | 'WEDNESDAY' | 'THURSDAY' | 'FRIDAY' | 'SATURDAY' | 'SUNDAY';
5072
+ export declare enum WeekDayType {
5073
+ MONDAY = "MONDAY",
5074
+ TUESDAY = "TUESDAY",
5075
+ WEDNESDAY = "WEDNESDAY",
5076
+ THURSDAY = "THURSDAY",
5077
+ FRIDAY = "FRIDAY",
5078
+ SATURDAY = "SATURDAY",
5079
+ SUNDAY = "SUNDAY"
5080
+ }
4923
5081
 
4924
5082
  export declare type XMPJobDocument = XMPJobType;
4925
5083
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@vidispine/types",
3
- "version": "23.2.0-pre.2",
3
+ "version": "23.2.0",
4
4
  "license": "SEE LICENSE IN LICENSE.md",
5
5
  "publishConfig": {
6
6
  "access": "public"
@@ -18,18 +18,18 @@
18
18
  "build": "yarn vite build",
19
19
  "build:watch": "yarn vite build --watch --mode development",
20
20
  "format": "prettier . --check",
21
- "lint": "eslint . --max-warnings=0 --ext .js,.jsx,.ts,.tsx,.md,.mdx"
21
+ "lint": "eslint . --cache --max-warnings=0 --ext .js,.jsx,.ts,.tsx,.md,.mdx"
22
22
  },
23
23
  "devDependencies": {
24
- "@vidispine/eslint-config-base": "23.2.0-pre.2",
25
- "@vidispine/eslint-config-mdx": "23.2.0-pre.2",
26
- "@vidispine/eslint-config-typescript": "23.2.0-pre.2",
27
- "@vidispine/prettier-config": "23.2.0-pre.2",
24
+ "@vidispine/eslint-config-base": "23.2.0",
25
+ "@vidispine/eslint-config-mdx": "23.2.0",
26
+ "@vidispine/eslint-config-typescript": "23.2.0",
27
+ "@vidispine/prettier-config": "23.2.0",
28
28
  "eslint": "8.34.0",
29
29
  "prettier": "2.8.4",
30
30
  "typescript": "4.9.5",
31
- "vite": "4.2.0",
32
- "vite-plugin-dts": "2.1.0"
31
+ "vite": "4.3.1",
32
+ "vite-plugin-dts": "2.3.0"
33
33
  },
34
34
  "eslintConfig": {
35
35
  "extends": [