@vidispine/vdt-js 23.3.0-pre.4 → 23.3.0-pre.5

package/dist/index.d.ts

@@ -6,6 +6,7 @@
 
 import type { AudioComponentType } from '@vidispine/types';
 import type { BinaryComponentType } from '@vidispine/types';
+import type { CollectionType } from '@vidispine/types';
 import type { ContainerComponentType } from '@vidispine/types';
 import type { FacetType } from '@vidispine/types';
 import type { FileType } from '@vidispine/types';
@@ -19,6 +20,7 @@ import type { MetadataValueType } from '@vidispine/types';
 import { RationalType } from '@vidispine/types';
 import type { SearchFacetType } from '@vidispine/types';
 import type { SearchResultEntryTimespanType } from '@vidispine/types';
+import type { SearchResultType } from '@vidispine/types';
 import type { ShapeType } from '@vidispine/types';
 import type { SimpleMetadataType } from '@vidispine/types';
 import type { TimeBaseType } from '@vidispine/types';
@@ -79,6 +81,8 @@ export declare const createTimeCode: (timeCode: TimeCodeInput | string | number,
 
 export declare type CreateTimeCodeOptions = TimeCodeInputOptions | FormatTimeCodeSmpteOptions | FormatTimeCodeSecondsOptions | FormatTimeCodeTextOptions;
 
+export declare const defaultOptions: ParseSearchResultEventsOptions;
+
 /**
  * Const object with document types
  *
@@ -628,6 +632,29 @@ export declare type ParsedMetadataType<TOptions> = (TOptions extends {
     includeMetadataAttributes?: true | string[];
 } ? ParsedMetadataAttributes : {});
 
+export declare type ParsedSearchResultEntryTimespanType = {
+    entityType?: 'Item' | 'Collection';
+    entityId?: string;
+    group?: MetadataGroupValueType;
+    start?: string;
+    end?: string;
+    thumbnail?: string;
+    startSeconds?: number;
+    endSeconds?: number;
+};
+
+export declare type ParsedSearchResultEntryType = {
+    entityType: 'Item' | 'Collection';
+    entityId: string;
+    events?: ParsedSearchResultEntryTimespanType[];
+    itemType?: ItemType;
+    collectionType?: CollectionType;
+};
+
+export declare type ParsedSearchResultEvents<TOptions> = TOptions extends {
+    flatEvents?: true;
+} ? ParsedSearchResultEntryTimespanType[] : ParsedSearchResultEntryType[];
+
 export declare type ParsedShapeType = {
     uri?: string;
     tag?: string;
@@ -938,6 +965,38 @@ export declare interface ParseMetadataTypeOptions extends ParseTimespanListOptio
  */
 export declare const parseNowDate: (value?: string) => Date;
 
+/**
+ * Parse metadata-group search result to event representations
+ *
+ * For more info see:
+ * - https://apidoc.vidispine.com/latest/ref/search.html#search-collection-and-item-by-metadata-group
+ * - https://apidoc.vidispine.com/latest/item/search.html#find-item-and-collections-by-their-metadata-groups
+ *
+ * @param searchResult
+ * @param options
+ * @returns
+ */
+export declare const parseSearchResultEvents: <TOptions extends ParseSearchResultEventsOptions = ParseSearchResultEventsOptions>(searchResult?: SearchResultType, options?: TOptions) => ParsedSearchResultEvents<TOptions>;
+
+export declare type ParseSearchResultEventsOptions = {
+    /**
+     * Append matching group with metadata
+     */
+    includeGroupMetadata?: boolean;
+    /**
+     * Return flat array with all matching events, not grouped by entity
+     */
+    flatEvents?: boolean;
+    /**
+     * Include itemType/collectionType of the event
+     */
+    includeEntityType?: boolean;
+    /**
+     * Find and return nearest thumbnail (Item only)
+     */
+    includeNearestThumbnail?: boolean;
+};
+
 /**
  * Parses the technical information of a ShapeType and its various components.
  *