vue-datocms 5.0.1 → 5.1.1-0

package/dist/index.d.ts

@@ -1,9 +1,12 @@
 import * as vue from 'vue';
-import { PropType, VNodeProps, VNode, Ref, UnwrapRef } from 'vue';
+import { PropType, VNodeProps, VNode, Ref, UnwrapRef, CSSProperties } from 'vue';
 import { TransformedMeta, RenderMarkRule, TransformMetaFn } from 'datocms-structured-text-generic-html-renderer';
 export { renderMarkRule, renderNodeRule, renderNodeRule as renderRule } from 'datocms-structured-text-generic-html-renderer';
 import { Record as Record$1, RenderResult, StructuredText as StructuredText$1, Document, Node, RenderRule } from 'datocms-structured-text-utils';
 export { RenderError, Document as StructuredTextDocument, StructuredText as StructuredTextGraphQlResponse } from 'datocms-structured-text-utils';
+import * as hls_js from 'hls.js';
+import { StreamTypes, MaxResolutionValue, MinResolutionValue, CmcdTypes, PlaybackTypes } from '@mux/playback-core/.';
+import MuxPlayerElement, { Tokens } from '@mux/mux-player';
 import { Options, ConnectionStatus } from 'datocms-listen';
 
 type ResponsiveImageType = {
@@ -378,6 +381,627 @@ declare const DatocmsStructuredTextPlugin: {
     install: (Vue: any) => void;
 };
 
+type ValueOf<T> = T[keyof T];
+type Maybe$1<T> = T | null;
+type Possibly<T> = Maybe$1<T> | undefined;
+type Video = {
+    /** Title attribute (`title`) for the video */
+    title?: Possibly<string>;
+    /** The height of the video */
+    height?: Possibly<number>;
+    /** The width of the video */
+    width?: Possibly<number>;
+    /** The MUX playbaack ID */
+    muxPlaybackId?: Possibly<string>;
+    /** The MUX playbaack ID */
+    playbackId?: Possibly<string>;
+    /** A data: URI containing a blurhash for the video  */
+    blurUpThumb?: Possibly<string>;
+    /** Other data can be passed, but they have no effect on rendering the player */
+    [k: string]: any;
+};
+type KeyTypes = string | number | symbol;
+declare const isNil: (x: unknown) => x is null | undefined;
+declare const isKeyOf: <T extends {} = any>(k: KeyTypes, o: Maybe$1<T> | undefined) => k is keyof T;
+declare const toNativeAttrName: (propName: string, propValue: any) => string | undefined;
+declare const toNativeAttrValue: (propValue: any, propName: string) => any;
+declare const VideoPlayer: vue.DefineComponent<{
+    _hlsConfig: {
+        type: PropType<Readonly<Partial<hls_js.HlsConfig>> | undefined>;
+        required: false;
+    };
+    accentColor: {
+        type: StringConstructor;
+        required: false;
+    };
+    audio: {
+        type: BooleanConstructor;
+        required: false;
+    };
+    autoPlay: {
+        type: PropType<string | boolean>;
+        required: false;
+    };
+    backwardSeekOffset: {
+        type: NumberConstructor;
+        required: false;
+    };
+    beaconCollectionDomain: {
+        type: StringConstructor;
+        required: false;
+    };
+    crossOrigin: {
+        type: StringConstructor;
+        required: false;
+    };
+    currentTime: {
+        type: NumberConstructor;
+        required: false;
+    };
+    customDomain: {
+        type: StringConstructor;
+        required: false;
+    };
+    data: {
+        type: PropType<Video>;
+        required: false;
+    };
+    debug: {
+        type: BooleanConstructor;
+        required: false;
+    };
+    defaultDuration: {
+        type: NumberConstructor;
+        required: false;
+    };
+    defaultHiddenCaptions: {
+        type: BooleanConstructor;
+        required: false;
+    };
+    defaultShowRemainingTime: {
+        type: BooleanConstructor;
+        required: false;
+    };
+    defaultStreamType: {
+        type: PropType<ValueOf<StreamTypes>>;
+        required: false;
+    };
+    disableCookies: {
+        type: BooleanConstructor;
+        required: false;
+        default: () => boolean;
+    };
+    disablePictureInPicture: {
+        type: BooleanConstructor;
+        required: false;
+    };
+    envKey: {
+        type: StringConstructor;
+        required: false;
+    };
+    extraSourceParams: {
+        type: PropType<Record<string, any>>;
+        required: false;
+    };
+    forwardSeekOffset: {
+        type: NumberConstructor;
+        required: false;
+    };
+    hotkeys: {
+        type: StringConstructor;
+        required: false;
+    };
+    loop: {
+        type: BooleanConstructor;
+        required: false;
+    };
+    maxResolution: {
+        type: PropType<MaxResolutionValue>;
+        required: false;
+    };
+    metadata: {
+        type: PropType<Record<string, any>>;
+        required: false;
+    };
+    metadataVideoId: {
+        type: StringConstructor;
+        required: false;
+    };
+    metadataVideoTitle: {
+        type: StringConstructor;
+        required: false;
+    };
+    metadataViewerUserId: {
+        type: StringConstructor;
+        required: false;
+    };
+    minResolution: {
+        type: PropType<MinResolutionValue>;
+        required: false;
+    };
+    muted: {
+        type: BooleanConstructor;
+        required: false;
+    };
+    nohotkeys: {
+        type: StringConstructor;
+        required: false;
+    };
+    noVolumePref: {
+        type: BooleanConstructor;
+        required: false;
+    };
+    paused: {
+        type: BooleanConstructor;
+        required: false;
+    };
+    placeholder: {
+        type: StringConstructor;
+        required: false;
+    };
+    playbackId: {
+        type: StringConstructor;
+        required: false;
+    };
+    playbackRate: {
+        type: NumberConstructor;
+        required: false;
+    };
+    playbackRates: {
+        type: PropType<Number[]>;
+        required: false;
+    };
+    playerSoftwareName: {
+        type: StringConstructor;
+        required: false;
+    };
+    playerSoftwareVersion: {
+        type: StringConstructor;
+        required: false;
+    };
+    playsInline: {
+        type: BooleanConstructor;
+        required: false;
+    };
+    poster: {
+        type: StringConstructor;
+        required: false;
+    };
+    preferCmcd: {
+        type: PropType<ValueOf<CmcdTypes> | undefined>;
+        required: false;
+    };
+    preferPlayback: {
+        type: PropType<ValueOf<PlaybackTypes> | undefined>;
+        required: false;
+    };
+    preload: {
+        type: StringConstructor;
+        required: false;
+        default: () => string;
+    };
+    primaryColor: {
+        type: StringConstructor;
+        required: false;
+    };
+    renditionOrder: {
+        type: PropType<"desc">;
+        required: false;
+    };
+    secondaryColor: {
+        type: StringConstructor;
+        required: false;
+    };
+    src: {
+        type: StringConstructor;
+        required: false;
+    };
+    startTime: {
+        type: NumberConstructor;
+        required: false;
+    };
+    storyboardSrc: {
+        type: StringConstructor;
+        required: false;
+    };
+    streamType: {
+        type: PropType<ValueOf<StreamTypes> | "ll-live" | "live:dvr" | "ll-live:dvr">;
+        required: false;
+    };
+    targetLiveWindow: {
+        type: NumberConstructor;
+        required: false;
+    };
+    theme: {
+        type: StringConstructor;
+        required: false;
+    };
+    themeProps: {
+        type: PropType<Record<string, any>>;
+        required: false;
+    };
+    thumbnailTime: {
+        type: NumberConstructor;
+        required: false;
+    };
+    title: {
+        type: StringConstructor;
+        required: false;
+    };
+    tokens: {
+        type: PropType<Tokens>;
+        required: false;
+    };
+    volume: {
+        type: NumberConstructor;
+        required: false;
+    };
+}, {
+    muxPlayerRef: vue.Ref<MuxPlayerElement | undefined>;
+    computedProps: {
+        disableCookies: boolean;
+        preload: string;
+        style?: (vue.CSSProperties | null) | undefined;
+        title?: (string | null) | undefined;
+        playbackId?: (string | null) | undefined;
+        placeholder?: (string | null) | undefined;
+    };
+    otherProps: {
+        disablePictureInPicture: boolean;
+        playsInline: boolean;
+        loop: boolean;
+        muted: boolean;
+        paused: boolean;
+        debug: boolean;
+        audio: boolean;
+        defaultHiddenCaptions: boolean;
+        defaultShowRemainingTime: boolean;
+        noVolumePref: boolean;
+        src: string | undefined;
+        title: string | undefined;
+        playbackId: string | undefined;
+        _hlsConfig: Readonly<Partial<hls_js.HlsConfig>> | undefined;
+        poster: string | undefined;
+        crossOrigin: string | undefined;
+        currentTime: number | undefined;
+        playbackRate: number | undefined;
+        volume: number | undefined;
+        accentColor: string | undefined;
+        autoPlay: string | boolean | undefined;
+        backwardSeekOffset: number | undefined;
+        beaconCollectionDomain: string | undefined;
+        customDomain: string | undefined;
+        defaultDuration: number | undefined;
+        defaultStreamType: ValueOf<StreamTypes> | undefined;
+        envKey: string | undefined;
+        extraSourceParams: Record<string, any> | undefined;
+        forwardSeekOffset: number | undefined;
+        hotkeys: string | undefined;
+        maxResolution: MaxResolutionValue | undefined;
+        metadata: Record<string, any> | undefined;
+        metadataVideoId: string | undefined;
+        metadataVideoTitle: string | undefined;
+        metadataViewerUserId: string | undefined;
+        minResolution: MinResolutionValue | undefined;
+        nohotkeys: string | undefined;
+        placeholder: string | undefined;
+        playbackRates: Number[] | undefined;
+        playerSoftwareName: string | undefined;
+        playerSoftwareVersion: string | undefined;
+        preferCmcd: ValueOf<CmcdTypes> | undefined;
+        preferPlayback: ValueOf<PlaybackTypes> | undefined;
+        primaryColor: string | undefined;
+        renditionOrder: "desc" | undefined;
+        secondaryColor: string | undefined;
+        startTime: number | undefined;
+        storyboardSrc: string | undefined;
+        streamType: ValueOf<StreamTypes> | "ll-live" | "live:dvr" | "ll-live:dvr" | undefined;
+        targetLiveWindow: number | undefined;
+        theme: string | undefined;
+        themeProps: Record<string, any> | undefined;
+        thumbnailTime: number | undefined;
+        tokens: Tokens | undefined;
+        onError: ((...args: any[]) => any) | undefined;
+        onSeeking: ((...args: any[]) => any) | undefined;
+        onEnded: ((...args: any[]) => any) | undefined;
+        onPause: ((...args: any[]) => any) | undefined;
+        onPlay: ((...args: any[]) => any) | undefined;
+        onAbort: ((...args: any[]) => any) | undefined;
+        onCanPlay: ((...args: any[]) => any) | undefined;
+        onCanPlayThrough: ((...args: any[]) => any) | undefined;
+        onEmptied: ((...args: any[]) => any) | undefined;
+        onLoadStart: ((...args: any[]) => any) | undefined;
+        onLoadedData: ((...args: any[]) => any) | undefined;
+        onLoadedMetadata: ((...args: any[]) => any) | undefined;
+        onProgress: ((...args: any[]) => any) | undefined;
+        onDurationChange: ((...args: any[]) => any) | undefined;
+        onVolumeChange: ((...args: any[]) => any) | undefined;
+        onRateChange: ((...args: any[]) => any) | undefined;
+        onResize: ((...args: any[]) => any) | undefined;
+        onWaiting: ((...args: any[]) => any) | undefined;
+        onPlaying: ((...args: any[]) => any) | undefined;
+        onTimeUpdate: ((...args: any[]) => any) | undefined;
+        onSeeked: ((...args: any[]) => any) | undefined;
+        onStalled: ((...args: any[]) => any) | undefined;
+        onSuspend: ((...args: any[]) => any) | undefined;
+        onCuePointChange: ((...args: any[]) => any) | undefined;
+        onCuePointsChange: ((...args: any[]) => any) | undefined;
+    };
+}, unknown, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, ("error" | "seeking" | "ended" | "pause" | "play" | "abort" | "canPlay" | "canPlayThrough" | "emptied" | "loadStart" | "loadedData" | "loadedMetadata" | "progress" | "durationChange" | "volumeChange" | "rateChange" | "resize" | "waiting" | "playing" | "timeUpdate" | "seeked" | "stalled" | "suspend" | "cuePointChange" | "cuePointsChange")[], "error" | "seeking" | "ended" | "pause" | "play" | "abort" | "canPlay" | "canPlayThrough" | "emptied" | "loadStart" | "loadedData" | "loadedMetadata" | "progress" | "durationChange" | "volumeChange" | "rateChange" | "resize" | "waiting" | "playing" | "timeUpdate" | "seeked" | "stalled" | "suspend" | "cuePointChange" | "cuePointsChange", vue.VNodeProps & vue.AllowedComponentProps & vue.ComponentCustomProps, Readonly<vue.ExtractPropTypes<{
+    _hlsConfig: {
+        type: PropType<Readonly<Partial<hls_js.HlsConfig>> | undefined>;
+        required: false;
+    };
+    accentColor: {
+        type: StringConstructor;
+        required: false;
+    };
+    audio: {
+        type: BooleanConstructor;
+        required: false;
+    };
+    autoPlay: {
+        type: PropType<string | boolean>;
+        required: false;
+    };
+    backwardSeekOffset: {
+        type: NumberConstructor;
+        required: false;
+    };
+    beaconCollectionDomain: {
+        type: StringConstructor;
+        required: false;
+    };
+    crossOrigin: {
+        type: StringConstructor;
+        required: false;
+    };
+    currentTime: {
+        type: NumberConstructor;
+        required: false;
+    };
+    customDomain: {
+        type: StringConstructor;
+        required: false;
+    };
+    data: {
+        type: PropType<Video>;
+        required: false;
+    };
+    debug: {
+        type: BooleanConstructor;
+        required: false;
+    };
+    defaultDuration: {
+        type: NumberConstructor;
+        required: false;
+    };
+    defaultHiddenCaptions: {
+        type: BooleanConstructor;
+        required: false;
+    };
+    defaultShowRemainingTime: {
+        type: BooleanConstructor;
+        required: false;
+    };
+    defaultStreamType: {
+        type: PropType<ValueOf<StreamTypes>>;
+        required: false;
+    };
+    disableCookies: {
+        type: BooleanConstructor;
+        required: false;
+        default: () => boolean;
+    };
+    disablePictureInPicture: {
+        type: BooleanConstructor;
+        required: false;
+    };
+    envKey: {
+        type: StringConstructor;
+        required: false;
+    };
+    extraSourceParams: {
+        type: PropType<Record<string, any>>;
+        required: false;
+    };
+    forwardSeekOffset: {
+        type: NumberConstructor;
+        required: false;
+    };
+    hotkeys: {
+        type: StringConstructor;
+        required: false;
+    };
+    loop: {
+        type: BooleanConstructor;
+        required: false;
+    };
+    maxResolution: {
+        type: PropType<MaxResolutionValue>;
+        required: false;
+    };
+    metadata: {
+        type: PropType<Record<string, any>>;
+        required: false;
+    };
+    metadataVideoId: {
+        type: StringConstructor;
+        required: false;
+    };
+    metadataVideoTitle: {
+        type: StringConstructor;
+        required: false;
+    };
+    metadataViewerUserId: {
+        type: StringConstructor;
+        required: false;
+    };
+    minResolution: {
+        type: PropType<MinResolutionValue>;
+        required: false;
+    };
+    muted: {
+        type: BooleanConstructor;
+        required: false;
+    };
+    nohotkeys: {
+        type: StringConstructor;
+        required: false;
+    };
+    noVolumePref: {
+        type: BooleanConstructor;
+        required: false;
+    };
+    paused: {
+        type: BooleanConstructor;
+        required: false;
+    };
+    placeholder: {
+        type: StringConstructor;
+        required: false;
+    };
+    playbackId: {
+        type: StringConstructor;
+        required: false;
+    };
+    playbackRate: {
+        type: NumberConstructor;
+        required: false;
+    };
+    playbackRates: {
+        type: PropType<Number[]>;
+        required: false;
+    };
+    playerSoftwareName: {
+        type: StringConstructor;
+        required: false;
+    };
+    playerSoftwareVersion: {
+        type: StringConstructor;
+        required: false;
+    };
+    playsInline: {
+        type: BooleanConstructor;
+        required: false;
+    };
+    poster: {
+        type: StringConstructor;
+        required: false;
+    };
+    preferCmcd: {
+        type: PropType<ValueOf<CmcdTypes> | undefined>;
+        required: false;
+    };
+    preferPlayback: {
+        type: PropType<ValueOf<PlaybackTypes> | undefined>;
+        required: false;
+    };
+    preload: {
+        type: StringConstructor;
+        required: false;
+        default: () => string;
+    };
+    primaryColor: {
+        type: StringConstructor;
+        required: false;
+    };
+    renditionOrder: {
+        type: PropType<"desc">;
+        required: false;
+    };
+    secondaryColor: {
+        type: StringConstructor;
+        required: false;
+    };
+    src: {
+        type: StringConstructor;
+        required: false;
+    };
+    startTime: {
+        type: NumberConstructor;
+        required: false;
+    };
+    storyboardSrc: {
+        type: StringConstructor;
+        required: false;
+    };
+    streamType: {
+        type: PropType<ValueOf<StreamTypes> | "ll-live" | "live:dvr" | "ll-live:dvr">;
+        required: false;
+    };
+    targetLiveWindow: {
+        type: NumberConstructor;
+        required: false;
+    };
+    theme: {
+        type: StringConstructor;
+        required: false;
+    };
+    themeProps: {
+        type: PropType<Record<string, any>>;
+        required: false;
+    };
+    thumbnailTime: {
+        type: NumberConstructor;
+        required: false;
+    };
+    title: {
+        type: StringConstructor;
+        required: false;
+    };
+    tokens: {
+        type: PropType<Tokens>;
+        required: false;
+    };
+    volume: {
+        type: NumberConstructor;
+        required: false;
+    };
+}>> & {
+    onError?: ((...args: any[]) => any) | undefined;
+    onSeeking?: ((...args: any[]) => any) | undefined;
+    onEnded?: ((...args: any[]) => any) | undefined;
+    onPause?: ((...args: any[]) => any) | undefined;
+    onPlay?: ((...args: any[]) => any) | undefined;
+    onAbort?: ((...args: any[]) => any) | undefined;
+    onCanPlay?: ((...args: any[]) => any) | undefined;
+    onCanPlayThrough?: ((...args: any[]) => any) | undefined;
+    onEmptied?: ((...args: any[]) => any) | undefined;
+    onLoadStart?: ((...args: any[]) => any) | undefined;
+    onLoadedData?: ((...args: any[]) => any) | undefined;
+    onLoadedMetadata?: ((...args: any[]) => any) | undefined;
+    onProgress?: ((...args: any[]) => any) | undefined;
+    onDurationChange?: ((...args: any[]) => any) | undefined;
+    onVolumeChange?: ((...args: any[]) => any) | undefined;
+    onRateChange?: ((...args: any[]) => any) | undefined;
+    onResize?: ((...args: any[]) => any) | undefined;
+    onWaiting?: ((...args: any[]) => any) | undefined;
+    onPlaying?: ((...args: any[]) => any) | undefined;
+    onTimeUpdate?: ((...args: any[]) => any) | undefined;
+    onSeeked?: ((...args: any[]) => any) | undefined;
+    onStalled?: ((...args: any[]) => any) | undefined;
+    onSuspend?: ((...args: any[]) => any) | undefined;
+    onCuePointChange?: ((...args: any[]) => any) | undefined;
+    onCuePointsChange?: ((...args: any[]) => any) | undefined;
+}, {
+    disablePictureInPicture: boolean;
+    playsInline: boolean;
+    loop: boolean;
+    muted: boolean;
+    paused: boolean;
+    preload: string;
+    debug: boolean;
+    audio: boolean;
+    defaultHiddenCaptions: boolean;
+    defaultShowRemainingTime: boolean;
+    disableCookies: boolean;
+    noVolumePref: boolean;
+}, {}>;
+declare const DatocmsVideoPlayerPlugin: {
+    install: (Vue: any) => void;
+};
+
 type SubscribeToQueryOptions<QueryResult, QueryVariables> = Omit<Options<QueryResult, QueryVariables>, 'onStatusChange' | 'onUpdate' | 'onChannelError'>;
 type EnabledQueryListenerOptions<QueryResult, QueryVariables> = {
     /** Whether the subscription has to be performed or not */
@@ -487,6 +1111,22 @@ type UseSiteSearchResult = {
 };
 declare function useSiteSearch<Client extends GenericClient>(config: UseSiteSearchConfig<Client>): UseSiteSearchResult;
 
+type Maybe<T> = T | null;
+type Style = Maybe<CSSProperties>;
+type Title = Maybe<string>;
+type PlaybackId = Maybe<string>;
+type Placeholder = Maybe<string>;
+type AttrsForMuxPlayer = {
+    style?: Style;
+    title?: Title;
+    playbackId?: PlaybackId;
+    placeholder?: Placeholder;
+};
+type UseVideoPlayerArgs = {
+    data?: Video;
+};
+declare const useVideoPlayer: ({ data, }: UseVideoPlayerArgs) => AttrsForMuxPlayer;
+
 type SeoMetaTagType = {
     /** the tag for the meta information */
     tag: string;
@@ -508,4 +1148,4 @@ declare const toHead: (...args: ToMetaTagsType[]) => {
     }[];
 };
 
-export { DatocmsImagePlugin, DatocmsStructuredTextPlugin, DisabledQueryListenerOptions, EnabledQueryListenerOptions, GenericClient, Image, QueryListenerOptions, RawSearchResult, RenderBlockContext, RenderInlineRecordContext, RenderRecordLinkContext, ResponsiveImageType, SeoMetaTagType, StructuredText, SubscribeToQueryOptions, ToMetaTagsType, UseSiteSearchConfig, UseSiteSearchData, UseSiteSearchResult, appendKeyToValidElement, defaultAdapter, toHead, useQuerySubscription, useSiteSearch };
+export { DatocmsImagePlugin, DatocmsStructuredTextPlugin, DatocmsVideoPlayerPlugin, DisabledQueryListenerOptions, EnabledQueryListenerOptions, GenericClient, Image, QueryListenerOptions, RawSearchResult, RenderBlockContext, RenderInlineRecordContext, RenderRecordLinkContext, ResponsiveImageType, SeoMetaTagType, StructuredText, SubscribeToQueryOptions, ToMetaTagsType, UseSiteSearchConfig, UseSiteSearchData, UseSiteSearchResult, Video, VideoPlayer, appendKeyToValidElement, defaultAdapter, isKeyOf, isNil, toHead, toNativeAttrName, toNativeAttrValue, useQuerySubscription, useSiteSearch, useVideoPlayer };