@vidispine/types 23.1.0 → 23.2.0-pre.2

package/src/models/MetadataEntrySyncType.ts

@@ -1,21 +0,0 @@
-import type { SiteIdType } from './SiteIdType';
-
-export type MetadataEntrySyncType = {
-  value: string;
-  id?: SiteIdType;
-  start?: string;
-  end?: string;
-  name?: string;
-  parentUuid?: string;
-  reference?: boolean;
-  removed?: boolean;
-  timestamp?: number;
-  type?: string;
-  user?: string;
-  valueUuid?: string;
-  version?: number;
-  metadataId?: SiteIdType;
-  metadataLeafId?: SiteIdType;
-  track?: string;
-  language?: string;
-};

package/src/models/MetadataEntryType.ts

@@ -1,14 +0,0 @@
-import type { MetadataFieldValueType } from './MetadataFieldValueType';
-import type { MetadataGroupValueType } from './MetadataGroupValueType';
-import type { MetadataValueType } from './MetadataValueType';
-
-export type MetadataEntryType = {
-  group?: MetadataGroupValueType;
-  field?: MetadataFieldValueType;
-  value?: MetadataValueType;
-  source?: {
-    id: string;
-    type: string;
-    loc: string;
-  };
-};

package/src/models/MetadataFieldAccessControlDocument.ts

@@ -1,3 +0,0 @@
-import type { MetadataFieldAccessControlType } from './MetadataFieldAccessControlType';
-
-export type MetadataFieldAccessControlDocument = MetadataFieldAccessControlType;

package/src/models/MetadataFieldAccessControlListDocument.ts

@@ -1,3 +0,0 @@
-import type { MetadataFieldAccessControlListType } from './MetadataFieldAccessControlListType';
-
-export type MetadataFieldAccessControlListDocument = MetadataFieldAccessControlListType;

package/src/models/MetadataFieldAccessControlListType.ts

@@ -1,5 +0,0 @@
-import type { MetadataFieldAccessControlType } from './MetadataFieldAccessControlType';
-
-export type MetadataFieldAccessControlListType = {
-  access?: Array<MetadataFieldAccessControlType>;
-};

package/src/models/MetadataFieldAccessControlType.ts

@@ -1,10 +0,0 @@
-import type { SiteIdType } from './SiteIdType';
-
-export type MetadataFieldAccessControlType = {
-  id?: SiteIdType;
-  user?: string;
-  group?: string;
-  permission: string;
-  field?: string;
-  fieldGroup?: string;
-};

package/src/models/MetadataFieldDocument.ts

@@ -1,3 +0,0 @@
-import type { MetadataFieldType } from './MetadataFieldType';
-
-export type MetadataFieldDocument = MetadataFieldType;

package/src/models/MetadataFieldFloatType.ts

@@ -1,4 +0,0 @@
-export type MetadataFieldFloatType = {
-  minInclusive?: number;
-  maxInclusive?: number;
-};

package/src/models/MetadataFieldGroupDocument.ts

@@ -1,3 +0,0 @@
-import type { MetadataFieldGroupType } from './MetadataFieldGroupType';
-
-export type MetadataFieldGroupDocument = MetadataFieldGroupType;

package/src/models/MetadataFieldGroupListDocument.ts

@@ -1,3 +0,0 @@
-import type { MetadataFieldGroupListType } from './MetadataFieldGroupListType';
-
-export type MetadataFieldGroupListDocument = MetadataFieldGroupListType;

package/src/models/MetadataFieldGroupListType.ts

@@ -1,5 +0,0 @@
-import type { MetadataFieldGroupType } from './MetadataFieldGroupType';
-
-export type MetadataFieldGroupListType = {
-  group?: Array<MetadataFieldGroupType>;
-};

package/src/models/MetadataFieldGroupPermissionType.ts

@@ -1,9 +0,0 @@
-import type { MetadataFieldPermissionType } from './MetadataFieldPermissionType';
-
-export type MetadataFieldGroupPermissionType = {
-  name: string;
-  permission: string;
-  fieldGroup?: Array<MetadataFieldGroupPermissionType>;
-  field?: Array<MetadataFieldPermissionType>;
-  username: string;
-};

package/src/models/MetadataFieldGroupSearchDocument.ts

@@ -1,3 +0,0 @@
-import type { ItemSearchType } from './ItemSearchType';
-
-export type MetadataFieldGroupSearchDocument = ItemSearchType;

package/src/models/MetadataFieldGroupType.ts

@@ -1,16 +0,0 @@
-import type { KeyValuePairType } from './KeyValuePairType';
-import type { MetadataFieldAccessControlType } from './MetadataFieldAccessControlType';
-import type { MetadataFieldType } from './MetadataFieldType';
-import type { MetadataSchemaElementType } from './MetadataSchemaElementType';
-
-export type MetadataFieldGroupType = {
-  name?: string;
-  schema?: MetadataSchemaElementType;
-  data?: Array<KeyValuePairType>;
-  field?: Array<MetadataFieldType>;
-  group?: Array<MetadataFieldGroupType>;
-  access?: Array<MetadataFieldAccessControlType>;
-  externalId?: Array<string>;
-  origin?: string;
-  inheritance?: string;
-};

package/src/models/MetadataFieldIndexType.ts

@@ -1 +0,0 @@
-export type MetadataFieldIndexType = 'noindex' | 'index' | 'extend';

package/src/models/MetadataFieldIntegerType.ts

@@ -1,4 +0,0 @@
-export type MetadataFieldIntegerType = {
-  minInclusive?: number;
-  maxInclusive?: number;
-};

package/src/models/MetadataFieldListDocument.ts

@@ -1,3 +0,0 @@
-import type { MetadataFieldListType } from './MetadataFieldListType';
-
-export type MetadataFieldListDocument = MetadataFieldListType;

package/src/models/MetadataFieldListType.ts

@@ -1,7 +0,0 @@
-import type { MetadataFieldAccessControlType } from './MetadataFieldAccessControlType';
-import type { MetadataFieldType } from './MetadataFieldType';
-
-export type MetadataFieldListType = {
-  access?: Array<MetadataFieldAccessControlType>;
-  field?: Array<MetadataFieldType>;
-};

package/src/models/MetadataFieldLongType.ts

@@ -1,4 +0,0 @@
-export type MetadataFieldLongType = {
-  minInclusive?: number;
-  maxInclusive?: number;
-};

package/src/models/MetadataFieldPermissionType.ts

@@ -1,5 +0,0 @@
-export type MetadataFieldPermissionType = {
-  name: string;
-  permission: string;
-  username: string;
-};

package/src/models/MetadataFieldResultDocument.ts

@@ -1,3 +0,0 @@
-import type { MetadataFieldResultType } from './MetadataFieldResultType';
-
-export type MetadataFieldResultDocument = MetadataFieldResultType;

package/src/models/MetadataFieldResultType.ts

@@ -1,19 +0,0 @@
-import type { MetadataFieldGroupType } from './MetadataFieldGroupType';
-import type { MetadataGroupValueType } from './MetadataGroupValueType';
-
-export type MetadataFieldResultType = {
-  hits: number;
-  group?: Array<{
-    value?: MetadataGroupValueType;
-    definition?: MetadataFieldGroupType;
-    source?: {
-      id: string;
-      type: string;
-      loc: string;
-    };
-    name: string;
-    uuid: string;
-    start: string;
-    end: string;
-  }>;
-};

package/src/models/MetadataFieldStringType.ts

@@ -1,5 +0,0 @@
-export type MetadataFieldStringType = {
-  minLength?: number;
-  maxLength?: number;
-  pattern?: string;
-};

package/src/models/MetadataFieldType.ts

@@ -1,40 +0,0 @@
-import type { KeyValuePairType } from './KeyValuePairType';
-import type { MetadataFieldFloatType } from './MetadataFieldFloatType';
-import type { MetadataFieldIndexType } from './MetadataFieldIndexType';
-import type { MetadataFieldIntegerType } from './MetadataFieldIntegerType';
-import type { MetadataFieldLongType } from './MetadataFieldLongType';
-import type { MetadataFieldStringType } from './MetadataFieldStringType';
-import type { MetadataFieldTypeType } from './MetadataFieldTypeType';
-import type { MetadataSchemaElementType } from './MetadataSchemaElementType';
-import type { SimpleMetadataType } from './SimpleMetadataType';
-
-export type MetadataFieldType = {
-  name?: string;
-  schema?: MetadataSchemaElementType;
-  type?: MetadataFieldTypeType;
-  index?: MetadataFieldIndexType;
-  fullText?: boolean;
-  caseSensitiveSorting?: boolean;
-  constraint?: {
-    dataset: string;
-    levelProperty: string;
-    levelValue: string;
-    value: string;
-    validationGroup?: string;
-    parent?: string;
-    extraData?: string;
-  };
-  data?: Array<KeyValuePairType>;
-  values?: SimpleMetadataType;
-  defaultValue?: string;
-  externalId?: Array<string>;
-  origin?: string;
-  boost?: number;
-  floatRestriction?: MetadataFieldFloatType;
-  integerRestriction?: MetadataFieldIntegerType;
-  longRestriction?: MetadataFieldLongType;
-  stringRestriction?: MetadataFieldStringType;
-  system?: string;
-  sortable?: boolean;
-  inheritance?: string;
-};

package/src/models/MetadataFieldTypeType.ts

@@ -1,21 +0,0 @@
-export 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';

package/src/models/MetadataFieldValidationDocument.ts

@@ -1,3 +0,0 @@
-import type { MetadataFieldValidationType } from './MetadataFieldValidationType';
-
-export type MetadataFieldValidationDocument = MetadataFieldValidationType;

package/src/models/MetadataFieldValidationType.ts

@@ -1,8 +0,0 @@
-import type { MetadataFieldValueType } from './MetadataFieldValueType';
-
-export type MetadataFieldValidationType = {
-  field?: MetadataFieldValueType;
-  constraint?: {
-    field?: Array<MetadataFieldValueType>;
-  };
-};

package/src/models/MetadataFieldValueConstraintListDocument.ts

@@ -1,3 +0,0 @@
-import type { MetadataFieldValueConstraintListType } from './MetadataFieldValueConstraintListType';
-
-export type MetadataFieldValueConstraintListDocument = MetadataFieldValueConstraintListType;

package/src/models/MetadataFieldValueConstraintListType.ts

@@ -1,5 +0,0 @@
-import type { MetadataFieldValueConstraintType } from './MetadataFieldValueConstraintType';
-
-export type MetadataFieldValueConstraintListType = {
-  constraint?: Array<MetadataFieldValueConstraintType>;
-};

package/src/models/MetadataFieldValueConstraintType.ts

@@ -1,5 +0,0 @@
-export type MetadataFieldValueConstraintType = {
-  field?: string;
-  value?: string;
-  id?: string;
-};

package/src/models/MetadataFieldValueType.ts

@@ -1,18 +0,0 @@
-import type { KeyValuePairType } from './KeyValuePairType';
-import type { MetadataFieldType } from './MetadataFieldType';
-import type { MetadataReferencedType } from './MetadataReferencedType';
-import type { MetadataReferenceType } from './MetadataReferenceType';
-import type { MetadataValueAttributes } from './MetadataValueAttributes';
-import type { MetadataValueType } from './MetadataValueType';
-
-export type MetadataFieldValueType = MetadataValueAttributes & {
-  name?: string;
-  id?: Array<string>;
-  referenced?: MetadataReferencedType;
-  data?: Array<KeyValuePairType>;
-  type?: MetadataFieldType;
-  value?: Array<MetadataValueType>;
-  reference?: MetadataReferenceType;
-  track?: string;
-  inheritance?: string;
-};

package/src/models/MetadataGroupSearchDocument.ts

@@ -1,3 +0,0 @@
-import type { MetadataGroupSearchType } from './MetadataGroupSearchType';
-
-export type MetadataGroupSearchDocument = MetadataGroupSearchType;

package/src/models/MetadataGroupSearchOperatorType.ts

@@ -1,10 +0,0 @@
-import type { ItemSearchTextValueType } from './ItemSearchTextValueType';
-import type { SearchFieldType } from './SearchFieldType';
-import type { SearchOperationType } from './SearchOperationType';
-
-export type MetadataGroupSearchOperatorType = {
-  text?: Array<ItemSearchTextValueType>;
-  operator?: Array<MetadataGroupSearchOperatorType>;
-  field?: Array<SearchFieldType>;
-  operation: SearchOperationType;
-};

package/src/models/MetadataGroupSearchType.ts

@@ -1,22 +0,0 @@
-import type { FacetFilterType } from './FacetFilterType';
-import type { ItemSearchTextValueType } from './ItemSearchTextValueType';
-import type { MetadataGroupSearchOperatorType } from './MetadataGroupSearchOperatorType';
-import type { SearchFacetType } from './SearchFacetType';
-import type { SearchFieldType } from './SearchFieldType';
-import type { SearchFilterType } from './SearchFilterType';
-import type { SearchHighlightType } from './SearchHighlightType';
-import type { SortingOrderType } from './SortingOrderType';
-
-export type MetadataGroupSearchType = {
-  text?: Array<ItemSearchTextValueType>;
-  field?: Array<SearchFieldType>;
-  operator?: MetadataGroupSearchOperatorType;
-  filter?: Array<SearchFilterType>;
-  facetFilter?: Array<FacetFilterType>;
-  facet?: Array<SearchFacetType>;
-  highlight?: SearchHighlightType;
-  sort?: Array<{
-    field: string;
-    order: SortingOrderType;
-  }>;
-};

package/src/models/MetadataGroupValueType.ts

@@ -1,17 +0,0 @@
-import type { KeyValuePairType } from './KeyValuePairType';
-import type { MetadataFieldValueType } from './MetadataFieldValueType';
-import type { MetadataReferencedType } from './MetadataReferencedType';
-import type { MetadataReferenceType } from './MetadataReferenceType';
-import type { MetadataValueAttributes } from './MetadataValueAttributes';
-
-export type MetadataGroupValueType = MetadataValueAttributes & {
-  name?: string;
-  id?: Array<string>;
-  referenced?: MetadataReferencedType;
-  data?: Array<KeyValuePairType>;
-  field?: Array<MetadataFieldValueType>;
-  group?: Array<MetadataGroupValueType>;
-  reference?: MetadataReferenceType;
-  inheritance?: string;
-  cycle?: boolean;
-};

package/src/models/MetadataListDocument.ts

@@ -1,3 +0,0 @@
-import type { MetadataListType } from './MetadataListType';
-
-export type MetadataListDocument = MetadataListType;

package/src/models/MetadataListType.ts

@@ -1,9 +0,0 @@
-import type { MetadataType } from './MetadataType';
-import type { SiteIdType } from './SiteIdType';
-
-export type MetadataListType = {
-  item?: Array<{
-    metadata?: MetadataType;
-    id?: SiteIdType;
-  }>;
-};

package/src/models/MetadataLockDocument.ts

@@ -1,3 +0,0 @@
-import type { MetadataLockType } from './MetadataLockType';
-
-export type MetadataLockDocument = MetadataLockType;

package/src/models/MetadataLockListDocument.ts

@@ -1,3 +0,0 @@
-import type { MetadataLockListType } from './MetadataLockListType';
-
-export type MetadataLockListDocument = MetadataLockListType;

package/src/models/MetadataLockListType.ts

@@ -1,5 +0,0 @@
-import type { MetadataLockType } from './MetadataLockType';
-
-export type MetadataLockListType = {
-  lock?: Array<MetadataLockType>;
-};

package/src/models/MetadataLockType.ts

@@ -1,6 +0,0 @@
-export type MetadataLockType = {
-  id: string;
-  user: string;
-  expires: string;
-  field?: Array<string>;
-};

package/src/models/MetadataModeType.ts

@@ -1 +0,0 @@
-export type MetadataModeType = 'add' | 'remove';

package/src/models/MetadataReferenceType.ts

@@ -1 +0,0 @@
-export type MetadataReferenceType = string;

package/src/models/MetadataReferencedType.ts

@@ -1,5 +0,0 @@
-export type MetadataReferencedType = {
-  id: string;
-  uuid: string;
-  type: string;
-};

package/src/models/MetadataSchemaAttributes.ts

@@ -1,5 +0,0 @@
-export type MetadataSchemaAttributes = {
-  min: number;
-  max: number;
-  name?: string;
-};

package/src/models/MetadataSchemaDeleteOperationType.ts

@@ -1,6 +0,0 @@
-import type { MetadataSchemaHierarchyType } from './MetadataSchemaHierarchyType';
-
-export type MetadataSchemaDeleteOperationType = {
-  target: MetadataSchemaHierarchyType;
-  type?: string;
-};

package/src/models/MetadataSchemaDocument.ts

@@ -1,3 +0,0 @@
-import type { MetadataSchemaType } from './MetadataSchemaType';
-
-export type MetadataSchemaDocument = MetadataSchemaType;

package/src/models/MetadataSchemaElementType.ts

@@ -1,5 +0,0 @@
-import type { MetadataSchemaAttributes } from './MetadataSchemaAttributes';
-
-export type MetadataSchemaElementType = MetadataSchemaAttributes & {
-  reference?: boolean;
-};

package/src/models/MetadataSchemaGroupDocument.ts

@@ -1,3 +0,0 @@
-import type { MetadataSchemaGroupType } from './MetadataSchemaGroupType';
-
-export type MetadataSchemaGroupDocument = MetadataSchemaGroupType;

package/src/models/MetadataSchemaGroupType.ts

@@ -1,7 +0,0 @@
-import type { MetadataSchemaAttributes } from './MetadataSchemaAttributes';
-import type { MetadataSchemaElementType } from './MetadataSchemaElementType';
-
-export type MetadataSchemaGroupType = MetadataSchemaAttributes & {
-  group?: Array<MetadataSchemaElementType>;
-  field?: Array<MetadataSchemaElementType>;
-};

package/src/models/MetadataSchemaHierarchyType.ts

@@ -1,7 +0,0 @@
-import type { MetadataFieldGroupType } from './MetadataFieldGroupType';
-import type { MetadataFieldType } from './MetadataFieldType';
-
-export type MetadataSchemaHierarchyType = {
-  group?: MetadataFieldGroupType;
-  field?: MetadataFieldType;
-};

package/src/models/MetadataSchemaMigrationDocument.ts

@@ -1,3 +0,0 @@
-import type { MetadataSchemaMigrationType } from './MetadataSchemaMigrationType';
-
-export type MetadataSchemaMigrationDocument = MetadataSchemaMigrationType;

package/src/models/MetadataSchemaMigrationListDocument.ts

@@ -1,3 +0,0 @@
-import type { MetadataSchemaMigrationListType } from './MetadataSchemaMigrationListType';
-
-export type MetadataSchemaMigrationListDocument = MetadataSchemaMigrationListType;

package/src/models/MetadataSchemaMigrationListType.ts

@@ -1,5 +0,0 @@
-import type { MetadataSchemaMigrationType } from './MetadataSchemaMigrationType';
-
-export type MetadataSchemaMigrationListType = {
-  migration?: Array<MetadataSchemaMigrationType>;
-};

package/src/models/MetadataSchemaMigrationType.ts

@@ -1,12 +0,0 @@
-import type { MetadataSchemaDeleteOperationType } from './MetadataSchemaDeleteOperationType';
-import type { MetadataSchemaMoveOperationType } from './MetadataSchemaMoveOperationType';
-import type { MetadataSchemaRenameOperationType } from './MetadataSchemaRenameOperationType';
-
-export type MetadataSchemaMigrationType = {
-  done?: boolean;
-  migrationsLeft?: number;
-  move?: Array<MetadataSchemaMoveOperationType>;
-  rename?: Array<MetadataSchemaRenameOperationType>;
-  delete?: Array<MetadataSchemaDeleteOperationType>;
-  id?: number;
-};

package/src/models/MetadataSchemaMoveOperationType.ts

@@ -1,7 +0,0 @@
-import type { MetadataSchemaHierarchyType } from './MetadataSchemaHierarchyType';
-
-export type MetadataSchemaMoveOperationType = {
-  from: MetadataSchemaHierarchyType;
-  to: MetadataSchemaHierarchyType;
-  type?: string;
-};

package/src/models/MetadataSchemaRenameOperationType.ts

@@ -1,6 +0,0 @@
-import type { MetadataSchemaHierarchyType } from './MetadataSchemaHierarchyType';
-
-export type MetadataSchemaRenameOperationType = {
-  from: MetadataSchemaHierarchyType;
-  to: string;
-};

package/src/models/MetadataSchemaType.ts

@@ -1,5 +0,0 @@
-import type { MetadataSchemaGroupType } from './MetadataSchemaGroupType';
-
-export type MetadataSchemaType = {
-  group?: Array<MetadataSchemaGroupType>;
-};

package/src/models/MetadataSynchronizeType.ts

@@ -1,10 +0,0 @@
-import type { MetadataEntryListType } from './MetadataEntryListType';
-import type { SiteIdType } from './SiteIdType';
-
-export type MetadataSynchronizeType = {
-  id: SiteIdType;
-  changeSet?: Array<{
-    id: SiteIdType;
-    metadata: MetadataEntryListType;
-  }>;
-};

package/src/models/MetadataType.ts

@@ -1,15 +0,0 @@
-import type { MetadataFieldValueType } from './MetadataFieldValueType';
-import type { MetadataGroupValueType } from './MetadataGroupValueType';
-
-export type MetadataType = {
-  revision?: string;
-  template?: string;
-  group?: Array<string>;
-  timespan?: Array<{
-    field?: Array<MetadataFieldValueType>;
-    group?: Array<MetadataGroupValueType>;
-    start?: string;
-    end?: string;
-    base?: string;
-  }>;
-};

package/src/models/MetadataValueAttributes.ts

@@ -1,12 +0,0 @@
-import type { MetadataModeType } from './MetadataModeType';
-import type { MetadataReferenceType } from './MetadataReferenceType';
-import type { SiteIdType } from './SiteIdType';
-
-export type MetadataValueAttributes = {
-  uuid?: MetadataReferenceType;
-  user?: string;
-  timestamp?: string;
-  change?: SiteIdType;
-  conflict?: boolean;
-  mode?: MetadataModeType;
-};

package/src/models/MetadataValueType.ts

@@ -1,8 +0,0 @@
-import type { MetadataValueAttributes } from './MetadataValueAttributes';
-
-export type MetadataValueType = MetadataValueAttributes & {
-  lang?: string;
-  id?: string;
-  extraData?: string;
-  value?: string;
-};

package/src/models/MetadataWrapperDocument.ts

@@ -1,3 +0,0 @@
-import type { MetadataWrapperType } from './MetadataWrapperType';
-
-export type MetadataWrapperDocument = MetadataWrapperType;

package/src/models/MetadataWrapperType.ts

@@ -1,15 +0,0 @@
-import type { BulkyMetadataType } from './BulkyMetadataType';
-import type { MetadataListType } from './MetadataListType';
-import type { MetadataType } from './MetadataType';
-import type { ShapeType } from './ShapeType';
-import type { SimpleMetadataType } from './SimpleMetadataType';
-
-export type MetadataWrapperType = {
-  metadata: MetadataType;
-  oldMetadata?: MetadataListType;
-  shape?: Array<ShapeType>;
-  shapeMetadata?: SimpleMetadataType;
-  bulkyMetadata: BulkyMetadataType;
-  oldBulkyMetadata?: BulkyMetadataType;
-  targetId?: string;
-};

package/src/models/MetricsConfigurationDocument.ts

@@ -1,3 +0,0 @@
-import type { MetricsConfigurationType } from './MetricsConfigurationType';
-
-export type MetricsConfigurationDocument = MetricsConfigurationType;

package/src/models/MetricsConfigurationType.ts

@@ -1,5 +0,0 @@
-import type { StatsdReporterType } from './StatsdReporterType';
-
-export type MetricsConfigurationType = {
-  statsd?: StatsdReporterType;
-};

package/src/models/MetricsReporterType.ts

@@ -1,4 +0,0 @@
-export type MetricsReporterType = {
-  exclude?: Array<string>;
-  include?: Array<string>;
-};