@streamscloud/embeddable 2.1.6 → 2.2.0

package/dist/short-videos/short-video-viewer/index.d.ts

@@ -7,3 +7,4 @@ export { default as ShortVideoDetails } from './cmp.short-video-details.svelte';
 export type { ShortVideoViewerModel, ShortVideoViewerAdModel, ShortVideoViewerProductModel } from './types';
 export type { IShortVideoViewerLocalization } from './short-video-viewer-localization.svelte';
 export type { IShortVideoDetailsLocalization } from './short-video-details-localization.svelte';
+export { mapShortVideoViewerModel } from './mapper';

package/dist/short-videos/short-video-viewer/index.js

@@ -4,3 +4,4 @@ export { default as ShortVideoProductViewer } from './cmp.product.svelte';
 export { default as ShortVideoViewerAttachments } from './cmp.attachments.svelte';
 export { default as ShortVideoViewerAttachmentsInline } from './cmp.attachments-inline.svelte';
 export { default as ShortVideoDetails } from './cmp.short-video-details.svelte';
+export { mapShortVideoViewerModel } from './mapper';

package/dist/short-videos/short-videos-player/cmp.short-videos-player.svelte

@@ -7,16 +7,64 @@
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-import { ShortVideoViewer } from '../short-video-viewer';
+import { createLocalGQLClient } from '../../core/graphql';
+import { mapShortVideoViewerModel, ShortVideoViewer } from '../short-video-viewer';
+import { GetShortVideosDocument } from './operations.generated';
+import { Loading } from '../../ui/loading';
 import { PlayerBuffer, PlayerSlider } from '../../ui/player';
 import { SpotlightLayout } from '../../ui/spotlight-layout';
 import { default as Controls } from './controls.svelte';
 import { ShortVideosPlayerLocalization } from './short-videos-player-localization.svelte';
 import { ShortVideosPlayerUiManager } from './ui-manager.svelte';
-import { onDestroy, onMount } from 'svelte';
-let { shortVideosProvider, localization: localizationInit, on } = $props();
+import { onDestroy, onMount, untrack } from 'svelte';
+let { input, localization: localizationInit, on } = $props();
 const localization = $derived(new ShortVideosPlayerLocalization(localizationInit));
-const buffer = $derived(new PlayerBuffer(shortVideosProvider));
+let buffer = $state(input.type === 'provider' ? new PlayerBuffer(input.provider) : null);
+$effect(() => {
+    if (input.type !== 'ids')
+        return;
+    untrack(() => {
+        initBuffer(input);
+    });
+});
+const initBuffer = (input) => __awaiter(void 0, void 0, void 0, function* () {
+    var _a, _b;
+    try {
+        const { graphqlUrl, ids, initialId } = input;
+        const graphql = createLocalGQLClient(graphqlUrl);
+        const payload = yield graphql
+            .query(GetShortVideosDocument, {
+            input: {
+                filter: {
+                    includePostIds: ids
+                }
+            }
+        })
+            .toPromise();
+        const posts = ((_b = (_a = payload.data) === null || _a === void 0 ? void 0 : _a.shortVideos) === null || _b === void 0 ? void 0 : _b.items) || [];
+        const idOrder = new Map(ids.map((id, index) => [id, index]));
+        posts.sort((a, b) => {
+            var _a, _b;
+            return ((_a = idOrder.get(a.id)) !== null && _a !== void 0 ? _a : Infinity) - ((_b = idOrder.get(b.id)) !== null && _b !== void 0 ? _b : Infinity);
+        });
+        const index = initialId ? posts.findIndex((p) => p.id === initialId) : 0;
+        const provider = {
+            initialData: {
+                prefetchedItems: posts.map(mapShortVideoViewerModel),
+                startIndex: index
+            },
+            loadMore: () => __awaiter(void 0, void 0, void 0, function* () {
+                // No more items to load, as all are already prefetched
+                return [];
+            })
+        };
+        buffer = new PlayerBuffer(provider);
+    }
+    catch (_c) {
+        console.error('Failed to load short videos by IDs:', input.ids);
+        buffer = null; // Reset buffer on error
+    }
+});
 const uiManager = new ShortVideosPlayerUiManager();
 onMount(() => __awaiter(void 0, void 0, void 0, function* () {
     uiManager.detailsCollapsed = window && window.innerWidth < window.innerHeight;
@@ -45,6 +93,8 @@ const handleDimensionsChanged = (dimensions) => {
         </div>
       </SpotlightLayout>
       <Controls buffer={buffer} uiManager={uiManager} localization={localization} on={{ closePlayer: () => on?.closePlayer?.() }} />
+    {:else}
+      <Loading positionFixedCenter={true} timeout={1000} />
     {/if}
   </div>
 </div>

package/dist/short-videos/short-videos-player/cmp.short-videos-player.svelte.d.ts

@@ -1,8 +1,7 @@
-import { type ShortVideoViewerModel } from '../short-video-viewer';
-import { type PlayerItemsProvider } from '../../ui/player';
+import type { PlayerInput } from './types';
 import { type IShortVideosPlayerLocalization } from './short-videos-player-localization.svelte';
 type Props = {
-    shortVideosProvider: PlayerItemsProvider<ShortVideoViewerModel>;
+    input: PlayerInput;
     localization?: IShortVideosPlayerLocalization;
     on?: {
         closePlayer?: () => void;

package/dist/short-videos/short-videos-player/index.d.ts

@@ -1,15 +1,38 @@
-import type { ShortVideoViewerModel } from '../short-video-viewer';
-import type { PlayerItemsProvider } from '../../ui/player';
+import { type OpenShortVideosPlayerInit } from './types';
 import type { IShortVideosPlayerLocalization } from './short-videos-player-localization.svelte';
 export type { IShortVideosPlayerLocalization };
 /**
- * Opens the short videos player modal with the specified provider and optional localization.
+ * Opens the short videos player modal with the specified provider or by fetching videos by IDs.
+ *
+ * You can use either a ready-made provider, or simply pass a list of video IDs and a GraphQL endpoint to fetch them.
  *
  * @param init - Configuration options.
- * @param {PlayerItemsProvider<ShortVideoViewerModel>} init.shortVideosProvider - The provider instance supplying short video items to the player.
- * @param {IShortVideosPlayerLocalization} [init.localization] - Optional localization settings for the player UI.
  *
- * @example
+ * @param {PlayerItemsProvider<ShortVideoViewerModel>} [init.shortVideosProvider]
+ *   The provider instance supplying short video items to the player.
+ *   **Use this if you already have your own provider implementation.**
+ *
+ * @param {string[]} [init.ids]
+ *   List of short video IDs to display in the player.
+ *   **Use this if you want the player to fetch and show specific videos.**
+ *
+ * @param {string} [init.graphqlUrl]
+ *   The GraphQL endpoint to use when fetching videos by IDs.
+ *   **Required if you use `ids`.**
+ *
+ * @param {string} [init.initialId]
+ *   The ID of the video that should be shown first.
+ *   **Optional. Only used when using `ids`.**
+ *
+ * @param {IShortVideosPlayerLocalization} [init.localization]
+ *   Optional localization settings for the player UI.
+ *
+ * @param {object} [init.on]
+ *   Optional event handlers.
+ * @param {() => void} [init.on.playerClosed]
+ *   Called when the player is closed.
+ *
+ * @example <caption>Using a custom provider</caption>
  * ```ts
  * import { openShortVideosPlayer } from '@streamscloud/embeddable/short-videos-player';
  *
@@ -21,11 +44,25 @@ export type { IShortVideosPlayerLocalization };
  *   }
  * });
  * ```
+ *
+ * @example <caption>Using a list of IDs</caption>
+ * ```ts
+ * import { openShortVideosPlayer } from '@streamscloud/embeddable/short-videos-player';
+ *
+ * openShortVideosPlayer({
+ *   ids: ['id1', 'id2', 'id3'],
+ *   graphqlUrl: 'https://api.example.com/graphql',
+ *   initialId: 'id2',
+ *   localization: {
+ *     next: 'Next',
+ *     previous: 'Previous'
+ *   },
+ *   on: {
+ *     playerClosed: () => {
+ *       console.log('Player was closed');
+ *     }
+ *   }
+ * });
+ * ```
  */
-export declare const openShortVideosPlayer: (init: {
-    shortVideosProvider: PlayerItemsProvider<ShortVideoViewerModel>;
-    localization?: IShortVideosPlayerLocalization;
-    on?: {
-        playerClosed?: () => void;
-    };
-}) => void;
+export declare const openShortVideosPlayer: (init: OpenShortVideosPlayerInit) => Promise<void>;

package/dist/short-videos/short-videos-player/index.js

@@ -1,14 +1,39 @@
+import { isIdsInit, isShortVideosProviderInit } from './types';
 import { ShadowHost } from '../../ui/shadow-dom';
-import { default as ShortVideosPlayer } from './cmp.short-videos-player.svelte';
 import { mount } from 'svelte';
+import { default as ShortVideosPlayer } from './cmp.short-videos-player.svelte';
 /**
- * Opens the short videos player modal with the specified provider and optional localization.
+ * Opens the short videos player modal with the specified provider or by fetching videos by IDs.
+ *
+ * You can use either a ready-made provider, or simply pass a list of video IDs and a GraphQL endpoint to fetch them.
  *
  * @param init - Configuration options.
- * @param {PlayerItemsProvider<ShortVideoViewerModel>} init.shortVideosProvider - The provider instance supplying short video items to the player.
- * @param {IShortVideosPlayerLocalization} [init.localization] - Optional localization settings for the player UI.
  *
- * @example
+ * @param {PlayerItemsProvider<ShortVideoViewerModel>} [init.shortVideosProvider]
+ *   The provider instance supplying short video items to the player.
+ *   **Use this if you already have your own provider implementation.**
+ *
+ * @param {string[]} [init.ids]
+ *   List of short video IDs to display in the player.
+ *   **Use this if you want the player to fetch and show specific videos.**
+ *
+ * @param {string} [init.graphqlUrl]
+ *   The GraphQL endpoint to use when fetching videos by IDs.
+ *   **Required if you use `ids`.**
+ *
+ * @param {string} [init.initialId]
+ *   The ID of the video that should be shown first.
+ *   **Optional. Only used when using `ids`.**
+ *
+ * @param {IShortVideosPlayerLocalization} [init.localization]
+ *   Optional localization settings for the player UI.
+ *
+ * @param {object} [init.on]
+ *   Optional event handlers.
+ * @param {() => void} [init.on.playerClosed]
+ *   Called when the player is closed.
+ *
+ * @example <caption>Using a custom provider</caption>
  * ```ts
  * import { openShortVideosPlayer } from '@streamscloud/embeddable/short-videos-player';
  *
@@ -20,15 +45,55 @@ import { mount } from 'svelte';
  *   }
  * });
  * ```
+ *
+ * @example <caption>Using a list of IDs</caption>
+ * ```ts
+ * import { openShortVideosPlayer } from '@streamscloud/embeddable/short-videos-player';
+ *
+ * openShortVideosPlayer({
+ *   ids: ['id1', 'id2', 'id3'],
+ *   graphqlUrl: 'https://api.example.com/graphql',
+ *   initialId: 'id2',
+ *   localization: {
+ *     next: 'Next',
+ *     previous: 'Previous'
+ *   },
+ *   on: {
+ *     playerClosed: () => {
+ *       console.log('Player was closed');
+ *     }
+ *   }
+ * });
+ * ```
  */
-export const openShortVideosPlayer = (init) => {
-    const { shortVideosProvider, localization } = init;
+export const openShortVideosPlayer = async (init) => {
+    let input = null;
+    if (isShortVideosProviderInit(init)) {
+        input = {
+            type: 'provider',
+            provider: init.shortVideosProvider
+        };
+    }
+    else if (isIdsInit(init)) {
+        input = {
+            type: 'ids',
+            ids: init.ids,
+            initialId: init.initialId,
+            graphqlUrl: init.graphqlUrl
+        };
+    }
+    else {
+        input = null;
+    }
+    if (!input) {
+        return;
+    }
     const shadowHost = new ShadowHost({ onClosed: () => init.on?.playerClosed?.() });
     mount(ShortVideosPlayer, {
         target: shadowHost.shadowRoot,
         props: {
-            shortVideosProvider,
-            localization,
+            input,
+            localization: init.localization,
             on: {
                 closePlayer: () => {
                     shadowHost.remove();

package/dist/short-videos/short-videos-player/operations.generated.d.ts

@@ -0,0 +1,64 @@
+import type * as SchemaTypes from '../../../gql/types';
+import type { TypedDocumentNode as DocumentNode } from '@graphql-typed-document-node/core';
+export type GetShortVideosQueryVariables = SchemaTypes.Exact<{
+    input: SchemaTypes.PostsInput;
+    image_scale?: SchemaTypes.InputMaybe<SchemaTypes.ImageScale>;
+}>;
+export type GetShortVideosQuery = {
+    shortVideos: {
+        items: Array<{
+            id: string;
+            enableSocialInteractions: boolean;
+            postHeading: {
+                sourceImage: string | null;
+                sourceName: string;
+                postDisplayDate: any;
+                postViewsCount: number;
+            };
+            allProducts: Array<{
+                title: string;
+                id: string;
+                link: string | null;
+                media: Array<{
+                    url: string;
+                    thumbnailUrl: string | null;
+                    type: SchemaTypes.MediaType;
+                }>;
+                priceAndAvailability: {
+                    currency: SchemaTypes.Currency;
+                    price: number;
+                    productSalePrices: Array<{
+                        salePrice: number;
+                        salePriceEffectiveDateFrom: any | null;
+                        salePriceEffectiveDateTo: any | null;
+                    }> | null;
+                };
+            }>;
+            ad: {
+                id: string;
+                title: string;
+                description: string | null;
+                buttonText: string | null;
+                buttonUrl: string | null;
+                openLinkInNewWindow: boolean | null;
+                type: SchemaTypes.AdType;
+                media: Array<{
+                    url: string;
+                    thumbnailUrl: string | null;
+                    type: SchemaTypes.MediaType;
+                }>;
+            } | null;
+            postData: {
+                media: Array<{
+                    url: string;
+                    thumbnailUrl: string | null;
+                    type: SchemaTypes.MediaType;
+                }>;
+                shortVideoData: {
+                    text: string | null;
+                } | null;
+            };
+        }>;
+    };
+};
+export declare const GetShortVideosDocument: DocumentNode<GetShortVideosQuery, GetShortVideosQueryVariables>;

package/dist/short-videos/short-videos-player/operations.generated.js

@@ -0,0 +1,193 @@
+export const GetShortVideosDocument = {
+    kind: 'Document',
+    definitions: [
+        {
+            kind: 'OperationDefinition',
+            operation: 'query',
+            name: { kind: 'Name', value: 'GetShortVideos' },
+            variableDefinitions: [
+                {
+                    kind: 'VariableDefinition',
+                    variable: { kind: 'Variable', name: { kind: 'Name', value: 'input' } },
+                    type: { kind: 'NonNullType', type: { kind: 'NamedType', name: { kind: 'Name', value: 'PostsInput' } } }
+                },
+                {
+                    kind: 'VariableDefinition',
+                    variable: { kind: 'Variable', name: { kind: 'Name', value: 'image_scale' } },
+                    type: { kind: 'NamedType', name: { kind: 'Name', value: 'ImageScale' } },
+                    defaultValue: { kind: 'EnumValue', value: 'ORIGINAL_ENCODED' }
+                }
+            ],
+            selectionSet: {
+                kind: 'SelectionSet',
+                selections: [
+                    {
+                        kind: 'Field',
+                        alias: { kind: 'Name', value: 'shortVideos' },
+                        name: { kind: 'Name', value: 'posts' },
+                        arguments: [{ kind: 'Argument', name: { kind: 'Name', value: 'input' }, value: { kind: 'Variable', name: { kind: 'Name', value: 'input' } } }],
+                        selectionSet: {
+                            kind: 'SelectionSet',
+                            selections: [
+                                {
+                                    kind: 'Field',
+                                    name: { kind: 'Name', value: 'items' },
+                                    selectionSet: {
+                                        kind: 'SelectionSet',
+                                        selections: [{ kind: 'FragmentSpread', name: { kind: 'Name', value: 'ShortVideoViewerPayloadFragment' } }]
+                                    }
+                                }
+                            ]
+                        }
+                    }
+                ]
+            }
+        },
+        {
+            kind: 'FragmentDefinition',
+            name: { kind: 'Name', value: 'ShortVideoViewerPayloadFragment' },
+            typeCondition: { kind: 'NamedType', name: { kind: 'Name', value: 'Post' } },
+            selectionSet: {
+                kind: 'SelectionSet',
+                selections: [
+                    { kind: 'Field', name: { kind: 'Name', value: 'id' } },
+                    { kind: 'Field', name: { kind: 'Name', value: 'enableSocialInteractions' } },
+                    {
+                        kind: 'Field',
+                        name: { kind: 'Name', value: 'postHeading' },
+                        selectionSet: {
+                            kind: 'SelectionSet',
+                            selections: [
+                                { kind: 'Field', name: { kind: 'Name', value: 'sourceImage' } },
+                                { kind: 'Field', name: { kind: 'Name', value: 'sourceName' } },
+                                { kind: 'Field', name: { kind: 'Name', value: 'postDisplayDate' } },
+                                { kind: 'Field', name: { kind: 'Name', value: 'postViewsCount' } }
+                            ]
+                        }
+                    },
+                    {
+                        kind: 'Field',
+                        name: { kind: 'Name', value: 'allProducts' },
+                        selectionSet: {
+                            kind: 'SelectionSet',
+                            selections: [
+                                {
+                                    kind: 'Field',
+                                    name: { kind: 'Name', value: 'media' },
+                                    selectionSet: {
+                                        kind: 'SelectionSet',
+                                        selections: [
+                                            { kind: 'Field', name: { kind: 'Name', value: 'url' } },
+                                            { kind: 'Field', name: { kind: 'Name', value: 'thumbnailUrl' } },
+                                            { kind: 'Field', name: { kind: 'Name', value: 'type' } }
+                                        ]
+                                    }
+                                },
+                                { kind: 'Field', name: { kind: 'Name', value: 'title' } },
+                                { kind: 'Field', name: { kind: 'Name', value: 'id' } },
+                                { kind: 'Field', name: { kind: 'Name', value: 'link' } },
+                                {
+                                    kind: 'Field',
+                                    name: { kind: 'Name', value: 'priceAndAvailability' },
+                                    selectionSet: {
+                                        kind: 'SelectionSet',
+                                        selections: [
+                                            { kind: 'Field', name: { kind: 'Name', value: 'currency' } },
+                                            { kind: 'Field', name: { kind: 'Name', value: 'price' } },
+                                            {
+                                                kind: 'Field',
+                                                name: { kind: 'Name', value: 'productSalePrices' },
+                                                selectionSet: {
+                                                    kind: 'SelectionSet',
+                                                    selections: [
+                                                        { kind: 'Field', name: { kind: 'Name', value: 'salePrice' } },
+                                                        { kind: 'Field', name: { kind: 'Name', value: 'salePriceEffectiveDateFrom' } },
+                                                        { kind: 'Field', name: { kind: 'Name', value: 'salePriceEffectiveDateTo' } }
+                                                    ]
+                                                }
+                                            }
+                                        ]
+                                    }
+                                }
+                            ]
+                        }
+                    },
+                    {
+                        kind: 'Field',
+                        name: { kind: 'Name', value: 'ad' },
+                        selectionSet: {
+                            kind: 'SelectionSet',
+                            selections: [
+                                { kind: 'Field', name: { kind: 'Name', value: 'id' } },
+                                { kind: 'Field', name: { kind: 'Name', value: 'title' } },
+                                { kind: 'Field', name: { kind: 'Name', value: 'description' } },
+                                { kind: 'Field', name: { kind: 'Name', value: 'buttonText' } },
+                                { kind: 'Field', name: { kind: 'Name', value: 'buttonUrl' } },
+                                { kind: 'Field', name: { kind: 'Name', value: 'openLinkInNewWindow' } },
+                                { kind: 'Field', name: { kind: 'Name', value: 'type' } },
+                                {
+                                    kind: 'Field',
+                                    name: { kind: 'Name', value: 'media' },
+                                    selectionSet: {
+                                        kind: 'SelectionSet',
+                                        selections: [
+                                            { kind: 'Field', name: { kind: 'Name', value: 'url' } },
+                                            { kind: 'Field', name: { kind: 'Name', value: 'thumbnailUrl' } },
+                                            { kind: 'Field', name: { kind: 'Name', value: 'type' } }
+                                        ]
+                                    }
+                                }
+                            ]
+                        }
+                    },
+                    {
+                        kind: 'Field',
+                        name: { kind: 'Name', value: 'postData' },
+                        selectionSet: {
+                            kind: 'SelectionSet',
+                            selections: [
+                                {
+                                    kind: 'Field',
+                                    name: { kind: 'Name', value: 'media' },
+                                    selectionSet: {
+                                        kind: 'SelectionSet',
+                                        selections: [
+                                            {
+                                                kind: 'Field',
+                                                name: { kind: 'Name', value: 'url' },
+                                                arguments: [
+                                                    {
+                                                        kind: 'Argument',
+                                                        name: { kind: 'Name', value: 'scale' },
+                                                        value: { kind: 'Variable', name: { kind: 'Name', value: 'image_scale' } }
+                                                    }
+                                                ]
+                                            },
+                                            {
+                                                kind: 'Field',
+                                                name: { kind: 'Name', value: 'thumbnailUrl' },
+                                                arguments: [
+                                                    {
+                                                        kind: 'Argument',
+                                                        name: { kind: 'Name', value: 'scale' },
+                                                        value: { kind: 'Variable', name: { kind: 'Name', value: 'image_scale' } }
+                                                    }
+                                                ]
+                                            },
+                                            { kind: 'Field', name: { kind: 'Name', value: 'type' } }
+                                        ]
+                                    }
+                                },
+                                {
+                                    kind: 'Field',
+                                    name: { kind: 'Name', value: 'shortVideoData' },
+                                    selectionSet: { kind: 'SelectionSet', selections: [{ kind: 'Field', name: { kind: 'Name', value: 'text' } }] }
+                                }
+                            ]
+                        }
+                    }
+                ]
+            }
+        }
+    ]
+};

package/dist/short-videos/short-videos-player/operations.graphql

@@ -0,0 +1,8 @@
+# noinspection GraphQLSchemaValidation
+query GetShortVideos($input: PostsInput!, $image_scale: ImageScale = ORIGINAL_ENCODED) {
+  shortVideos: posts(input: $input) {
+    items {
+      ...ShortVideoViewerPayloadFragment
+    }
+  }
+}

package/dist/short-videos/short-videos-player/types.d.ts

@@ -0,0 +1,34 @@
+import type { ShortVideoViewerModel } from '../..';
+import type { IShortVideosPlayerLocalization } from './short-videos-player-localization.svelte';
+import type { PlayerItemsProvider } from '../../ui/player';
+export type PlayerInput = ProviderPlayerInput | IdsPlayerInput;
+export type ProviderPlayerInput = {
+    type: 'provider';
+    provider: PlayerItemsProvider<ShortVideoViewerModel>;
+};
+export type IdsPlayerInput = {
+    type: 'ids';
+    ids: string[];
+    initialId?: string;
+    graphqlUrl: string;
+};
+export type OpenShortVideosPlayerInit = ProviderInit | IdsInit;
+type ProviderInit = {
+    shortVideosProvider: PlayerItemsProvider<ShortVideoViewerModel>;
+    localization?: IShortVideosPlayerLocalization;
+    on?: {
+        playerClosed?: () => void;
+    };
+};
+type IdsInit = {
+    ids: string[];
+    graphqlUrl: string;
+    initialId?: string;
+    localization?: IShortVideosPlayerLocalization;
+    on?: {
+        playerClosed?: () => void;
+    };
+};
+export declare const isShortVideosProviderInit: (init: unknown) => init is ProviderInit;
+export declare function isIdsInit(init: unknown): init is IdsInit;
+export {};

package/dist/short-videos/short-videos-player/types.js

@@ -0,0 +1,6 @@
+export const isShortVideosProviderInit = (init) => {
+    return typeof init === 'object' && init !== null && 'shortVideosProvider' in init;
+};
+export function isIdsInit(init) {
+    return typeof init === 'object' && init !== null && 'ids' in init && 'graphqlUrl' in init;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@streamscloud/embeddable",
-  "version": "2.1.6",
+  "version": "2.2.0",
   "author": "StreamsCloud",
   "repository": "https://github.com/StreamsCloud/streamscloud-frontend-packages.git",
   "type": "module",