@vkontakte/videoplayer-interactive 1.0.29-dev.e881d3ff.0 → 1.0.30-dev.bd42a8ac.0

package/types/modules/Interactives/utils/events.types.d.ts

@@ -0,0 +1,47 @@
+import type { SubjectName, ActionMap, SubjectType, AfterExpectActionType, Behaviour } from './SelectBranches.types';
+import { InteractivesEventTypes } from './events';
+import { EventActionTypes } from '../../../manifest';
+import type { ControlEvent, ContainerEvent, ChapterEvent, ChapterContainer, Control } from '../../../manifest';
+import type { InteractiveRange } from './getInteractiveRanges';
+export type { SubjectName };
+type InteractivesEventTypesValues = `${InteractivesEventTypes}`;
+type InteractivesEventTypesValuesChapter = InteractivesEventTypes.ACTION_CHOICE | InteractivesEventTypes.ACTION_CHOICE_CANCELED | InteractivesEventTypes.ACTION_EXECUTION;
+type InteractivesEventTypesValuesContainer = InteractivesEventTypesValues;
+type InteractivesEventTypesValuesControl = InteractivesEventTypesValuesChapter | InteractivesEventTypes.VISIBILITY;
+type InteractiveEventType<T extends SubjectName> = T extends 'container' ? InteractivesEventTypesValuesContainer : InteractivesEventTypesValuesControl;
+type TInteractiveCommon<T extends SubjectName, U extends InteractiveEventType<T>> = {
+    subjectId: string;
+    subjectName: T;
+    type: U;
+};
+export type TInteractivesVisibility<T extends Exclude<SubjectName, 'chapter'>> = TInteractiveCommon<T, InteractivesEventTypes.VISIBILITY> & {
+    visibility: boolean;
+    isFirst?: boolean;
+};
+type EventActionTypesValues = `${EventActionTypes}`;
+export type TInteractiveRangeEndedEvent = {
+    type: InteractivesEventTypes.RANGE_ENDED;
+    payload: InteractiveRange;
+};
+type NonChapterChangeEvents = EventActionTypes.openURI | EventActionTypes.continuePlayback | EventActionTypes.expect;
+type TInteractivesActionExecEventPayload<T extends EventActionTypesValues> = T extends Exclude<EventActionTypesValues, NonChapterChangeEvents> ? Partial<{
+    chapterId: string;
+    autoSelect: boolean;
+    behaviour: Behaviour;
+    manifestURL: string;
+}> : undefined;
+export type TInteractivesActionExecutionEvent<T extends SubjectName> = TInteractiveCommon<T, InteractivesEventTypes.ACTION_EXECUTION> & {
+    actionType: ActionMap[T]['type'] | AfterExpectActionType;
+    subjectType?: SubjectType<T>;
+    payload?: TInteractivesActionExecEventPayload<ActionMap[T]['type']>;
+};
+type TInteractivesActionChoiceEventPayload<T extends SubjectName> = T extends 'chapter' ? ChapterEvent['action']['args'] : T extends 'container' ? ContainerEvent['action']['args'] : ControlEvent['action']['args'] & {
+    containerId: string;
+};
+type TSubjectTypeValues<T extends SubjectName> = T extends 'chapter' ? undefined : T extends 'container' ? ChapterContainer['type'] : Control['type'];
+export type TInteractivesActionChoiceEvent<T extends SubjectName> = TInteractiveCommon<T, InteractivesEventTypes.ACTION_CHOICE | InteractivesEventTypes.ACTION_CHOICE_CANCELED> & {
+    subjectType?: TSubjectTypeValues<T>;
+    actionType: EventActionTypesValues;
+    payload: TInteractivesActionChoiceEventPayload<T>;
+};
+export type TInteractivesContainerRemoved = TInteractiveCommon<'container', InteractivesEventTypes.CONTAINER_REMOVED>;