@annoto/widget-api 2.10.0-alpha.1 → 3.0.0-alpha.2

package/CHANGELOG.md

@@ -3,6 +3,41 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [3.0.0-alpha.2](https://bitbucket.org/annototeam/annoto/compare/v3.0.0-alpha.1...v3.0.0-alpha.2) (2021-12-19)
+
+
+### Features
+
+* **widget-api:** added optional setup hook ([3f23f19](https://bitbucket.org/annototeam/annoto/commits/3f23f19c91b599252e438d3101ad2140eb63f0ab))
+
+
+
+
+
+# [3.0.0-alpha.0](https://bitbucket.org/annototeam/annoto/compare/v2.10.0-alpha.3...v3.0.0-alpha.0) (2021-12-13)
+
+**Note:** Version bump only for package @annoto/widget-api
+
+
+
+
+
+# [2.10.0-alpha.3](https://bitbucket.org/annototeam/annoto/compare/v2.10.0-alpha.2...v2.10.0-alpha.3) (2021-12-08)
+
+**Note:** Version bump only for package @annoto/widget-api
+
+
+
+
+
+# [2.10.0-alpha.2](https://bitbucket.org/annototeam/annoto/compare/v2.10.0-alpha.1...v2.10.0-alpha.2) (2021-12-08)
+
+**Note:** Version bump only for package @annoto/widget-api
+
+
+
+
+
 # [2.10.0-alpha.1](https://bitbucket.org/annototeam/annoto/compare/v2.10.0-alpha.0...v2.10.0-alpha.1) (2021-12-08)
 
 **Note:** Version bump only for package @annoto/widget-api

package/dist/build/api/index.d.ts

@@ -0,0 +1,40 @@
+/**
+ * @module Api
+ */
+import { IConfig } from '../config';
+import { IMetadata } from './metadata';
+export * from './metadata';
+export * from './device-detector';
+export interface IAnnotoApi {
+    /**
+     * Single Sign On (SSO) user authentication
+     * @param token
+     */
+    auth(token: string): Promise<void>;
+    /**
+     * Load new application configuration
+     * @param config
+     */
+    load(config: IConfig): Promise<void>;
+    /**
+     * Destroy single or all the widgets
+     * @param index if provided destroy specific widget
+     */
+    destroy(index?: number): Promise<void>;
+    /**
+     * Logout current user
+     */
+    logout(): Promise<void>;
+    /**
+     * Show single or all the widgets
+     * @param index if provided show specific widget
+     */
+    show(index?: number): Promise<void>;
+    /**
+     * Hide single or all the widgets
+     * @param index if provided hide specific widget
+     */
+    hide(index?: number): Promise<void>;
+    getMetadata(): IMetadata;
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/build/api/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../lib/api/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AACvC,cAAc,YAAY,CAAC;AAC3B,cAAc,mBAAmB,CAAC;AAElC,MAAM,WAAW,UAAU;IACvB;;;OAGG;IACH,IAAI,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACnC;;;OAGG;IACH,IAAI,CAAC,MAAM,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACrC;;;OAGG;IACH,OAAO,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACvC;;OAEG;IACH,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IACxB;;;OAGG;IACH,IAAI,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACpC;;;OAGG;IACH,IAAI,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACpC,WAAW,IAAI,SAAS,CAAC;CAC5B"}

package/dist/build/api/index.js

@@ -0,0 +1,18 @@
+"use strict";
+/**
+ * @module Api
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./metadata"), exports);
+__exportStar(require("./device-detector"), exports);
+//# sourceMappingURL=index.js.map

package/dist/build/api/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../lib/api/index.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;AAIH,6CAA2B;AAC3B,oDAAkC"}

package/dist/build/config/hooks.d.ts

@@ -0,0 +1,87 @@
+import { IConfig } from '.';
+import { IMediaDetails } from './media-details';
+/**
+ * Callback hooks for triggering actions such as auth and getting info
+ */
+export interface IHooks {
+    /**
+     * Callback that allows to modify the configuration
+     * This callback is called when media is ready and it's preferences is loaded from the backend
+     * @remarks
+     * This is the prefered way of modifying the configuration.
+     * The best practice is to keep the widget bootstrap configuration to a minimum.
+     *
+     * @param params
+     * @returns the modified configuration to use instead of the provided config in params
+     */
+    setup?(params: {
+        widgetIndex: number;
+        config: IConfig;
+        mediaSrc: string;
+    }): Promise<IConfig | undefined>;
+    /**
+     * Callback that allows to enrich details about the played media.
+     * If provided the function is called by the widget to obtain additional details about the media.
+     * @param details media details obtained from the player
+     * @returns additional details about the played media, such as title
+     */
+    mediaDetails?(params: {
+        widgetIndex: number;
+        mediaSrc: string;
+        details?: IMediaDetails;
+    }): IMediaDetails | Promise<IMediaDetails>;
+    /**
+     * For SSO enabled integrations only.
+     * If Provided, Will be called when user triggers Authentication.
+     * If not provided a message in the form is shown.
+     * @returns If possible the promise should reslove/reject when the auth flow is finished.
+     */
+    ssoAuthRequestHandle?(): Promise<void> | void;
+    /**
+     * For SSO enabled integrations only.
+     * If Provided, Will be called when user triggers Logout action and "Logout" option will appear in the drawer menu.
+     * @returns If possible the promise should reslove/reject when the logout flow is finished.
+     */
+    logoutRequestHandle?(): Promise<void> | void;
+    /**
+     * Url to the video page.
+     * Useful if Annoto is embedded inside iframe for example.
+     * default: window.location.href is used.
+     */
+    getPageUrl?(): string;
+    /**
+     * Url to the video page and specific playback time of currentTime.
+     * If provided will be used by annoto for email notifications, in the dashboard, etc.
+     * @param currentTime current playback time of the player in seconds
+     * @param mediaSrc the media source of the player
+     */
+    getMediaDeepLinkUrl?(params: {
+        widgetIndex: number;
+        currentTime: number;
+        mediaSrc: string;
+    }): string;
+    /**
+     * @internal
+     * If people and presence are enabled for the site, this api can be implemented to add invites to one on one meetings
+     * @param params
+     */
+    getOneOnOneSessionInvite?(params: IOneOnOneSessionInviteParams): Promise<IOneOnOneSessionInviteResult> | IOneOnOneSessionInviteResult;
+}
+/**
+ * @internal
+ */
+export interface IOneOnOneSessionInviteParams {
+    authorId: string;
+    invitedUserId: string;
+}
+/**
+ * @internal
+ */
+export interface IOneOnOneSessionInviteResult {
+    inviteUrl: string;
+    inviteUrlText?: string;
+    title?: string;
+    message?: string;
+    inviteButton?: string;
+}
+//# sourceMappingURL=hooks.d.ts.map

package/dist/build/config/hooks.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"hooks.d.ts","sourceRoot":"","sources":["../../../lib/config/hooks.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,GAAG,CAAC;AAC5B,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAEhD;;GAEG;AACH,MAAM,WAAW,MAAM;IACnB;;;;;;;;;OASG;IACH,KAAK,CAAC,CAAC,MAAM,EAAE;QAAE,WAAW,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,OAAO,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAC;KAAE,GAAG,OAAO,CAAC,OAAO,GAAG,SAAS,CAAC,CAAC;IAC1G;;;;;OAKG;IACH,YAAY,CAAC,CAAC,MAAM,EAAE;QAAE,WAAW,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,aAAa,CAAC;KAAE,GAAG,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;IACnI;;;;;OAKG;IACH,oBAAoB,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;IAC9C;;;;OAIG;IACH,mBAAmB,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;IAC7C;;;;OAIG;IACH,UAAU,CAAC,IAAI,MAAM,CAAC;IACtB;;;;;OAKG;IACH,mBAAmB,CAAC,CAAC,MAAM,EAAE;QAAE,WAAW,EAAE,MAAM,CAAC;QAAC,WAAW,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAC;KAAE,GAAG,MAAM,CAAC;IACtG;;;;OAIG;IACH,wBAAwB,CAAC,CAAC,MAAM,EAAE,4BAA4B,GAAG,OAAO,CAAC,4BAA4B,CAAC,GAAG,4BAA4B,CAAC;CACzI;AAED;;GAEG;AACH,MAAM,WAAW,4BAA4B;IACzC,QAAQ,EAAE,MAAM,CAAC;IACjB,aAAa,EAAE,MAAM,CAAC;CACzB;AACD;;GAEG;AACH,MAAM,WAAW,4BAA4B;IACzC,SAAS,EAAE,MAAM,CAAC;IAClB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,YAAY,CAAC,EAAE,MAAM,CAAC;CACzB"}

package/dist/build/config/hooks.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=hooks.js.map

package/dist/build/config/hooks.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"hooks.js","sourceRoot":"","sources":["../../../lib/config/hooks.ts"],"names":[],"mappings":""}

package/dist/build/config/index.d.ts

@@ -0,0 +1,88 @@
+/**
+ * @module Config
+ */
+import { IWidgetBackendOptions } from './backend';
+import { IFeatures } from './features';
+import { IGroupDetails } from './group-details';
+import { IHooks } from './hooks';
+import { ILaunchSourceConfig } from './launch-source';
+import { IUx } from './ux';
+import { IWidgetConfig } from './widget';
+export * from './backend';
+export * from './features';
+export * from './group-details';
+export * from './hooks';
+export * from './launch-source';
+export * from './media-details';
+export * from './timeline';
+export * from './ux';
+export * from './widget';
+export interface IConfig<F = IFeatures> {
+    /**
+     * The client ID key provided by Annoto
+     * @remarks
+     * If not set, the widget will load in demo mode
+     */
+    clientId?: string;
+    /**
+     * Widget configuration settings.
+     * @remarks
+     * only single widget is supported. the array is for future use.
+     */
+    widgets: IWidgetConfig<F>[];
+    /**
+     * Course/group details
+     * If provided the discussions on the media will be categorized by groups
+     * allowing private discussions per group for same media
+     */
+    group?: IGroupDetails;
+    /**
+     * Enable/disable and configure features
+     * Modifying the features will override the backend configured features.
+     * @remarks
+     * If Feature is not enabled on backend it cannot be enabled via this api.
+     */
+    features?: F;
+    /**
+     * Configuration options that affect the user experience
+     */
+    ux?: IUx;
+    /**
+     * Callback hooks for triggering actions such as auth and getting info
+     */
+    hooks?: IHooks;
+    /**
+     * If set to true, the widget will load in demo mode
+     */
+    demoMode?: boolean;
+    /**
+     * @internal
+     * Demo discussion for the demo mode
+     */
+    demoDiscussion?: string;
+    /**
+     * Language code in IETF BCP 47 or ISO/IEC 15897.
+     * @default 'en'
+     */
+    locale?: string;
+    /**
+     * Launch source credentials for widget integration via proxy domain
+     * For example LTI
+     */
+    launchSource?: ILaunchSourceConfig;
+    /**
+     * Set the zIndex to appropriate value to make the app visible and not iterfer with other elements.
+     * @default 100
+     */
+    zIndex?: number;
+    /**
+     * same as zIndex, only for when the player is in fullscreen.
+     * @default 100
+     */
+    fsZIndex?: number;
+    /**
+     * setup the backend endpoints to override the default
+     */
+    backend?: IWidgetBackendOptions;
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/build/config/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../lib/config/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,qBAAqB,EAAE,MAAM,WAAW,CAAC;AAClD,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AACvC,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AACjC,OAAO,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAC;AACtD,OAAO,EAAE,GAAG,EAAE,MAAM,MAAM,CAAC;AAC3B,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAGzC,cAAc,WAAW,CAAC;AAC1B,cAAc,YAAY,CAAC;AAC3B,cAAc,iBAAiB,CAAC;AAChC,cAAc,SAAS,CAAC;AACxB,cAAc,iBAAiB,CAAC;AAChC,cAAc,iBAAiB,CAAC;AAChC,cAAc,YAAY,CAAC;AAC3B,cAAc,MAAM,CAAC;AACrB,cAAc,UAAU,CAAC;AAEzB,MAAM,WAAW,OAAO,CAAC,CAAC,GAAG,SAAS;IAClC;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,OAAO,EAAE,aAAa,CAAC,CAAC,CAAC,EAAE,CAAC;IAC5B;;;;OAIG;IACH,KAAK,CAAC,EAAE,aAAa,CAAC;IACtB;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,CAAC,CAAC;IACb;;OAEG;IACH,EAAE,CAAC,EAAE,GAAG,CAAC;IACT;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IACd;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,YAAY,CAAC,EAAE,mBAAmB,CAAC;IACnC;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,OAAO,CAAC,EAAE,qBAAqB,CAAC;CACnC"}

package/dist/build/config/index.js

@@ -0,0 +1,25 @@
+"use strict";
+/**
+ * @module Config
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./backend"), exports);
+__exportStar(require("./features"), exports);
+__exportStar(require("./group-details"), exports);
+__exportStar(require("./hooks"), exports);
+__exportStar(require("./launch-source"), exports);
+__exportStar(require("./media-details"), exports);
+__exportStar(require("./timeline"), exports);
+__exportStar(require("./ux"), exports);
+__exportStar(require("./widget"), exports);
+//# sourceMappingURL=index.js.map

package/dist/build/config/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../lib/config/index.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;AAWH,4CAA0B;AAC1B,6CAA2B;AAC3B,kDAAgC;AAChC,0CAAwB;AACxB,kDAAgC;AAChC,kDAAgC;AAChC,6CAA2B;AAC3B,uCAAqB;AACrB,2CAAyB"}

package/dist/build/config/ux.d.ts

@@ -0,0 +1,153 @@
+export interface IUx {
+    /**
+     * Select the widget theme
+     * If set to 'dark', the dark theme will always be used even when widget is not in overlay.
+     * @default 'default'
+     */
+    theme?: ThemeType;
+    widget?: IWidgetUx;
+    player?: IPlayerUx;
+    comments?: ICommentsUx;
+}
+export interface IWidgetUx {
+    /**
+     * Position the widget on the right or on the left side
+     * @default 'right'
+     */
+    position?: WidgetPositionType;
+    /**
+     * Load widget in open state on first boot.
+     * 'kuku' - widget is loaded closed, and after timeout a kuku is shown promting user to comment.
+     * 'open' - load in open state
+     * 'closed' - load in closed state with no kuku
+     * @default 'kuku'
+     */
+    loadState?: WidgetLoadStateType;
+    /**
+     * 'edge' - outside the element right next to it
+     * 'overlay' - as an overlay inside the element on it's edge
+     * 'fixed' - fixed position on the screen edge instead of relative to the element
+     * 'sidePanel' - non dragable side panel layout
+     * 'sidePanelOverlay' - non dragable side panel that overlays content including controls
+     * @default 'edge'
+     * @remarks
+     * If align is set to 'edge' or 'sidePanel' and there is no space for the widget, it will fallback to 'overlay'
+     */
+    layout?: WidgetLayoutType;
+    /**
+     * Enable/Disable navigation side tabs
+     * @default true
+     */
+    tabs?: boolean;
+    /**
+     * If povided will limit the responsive widget width.
+     * Has effect when widget is positioned outside of the player.
+     * Has no effect when widget is overlay inside the player.
+     * @default 460
+     */
+    maxWidth?: number;
+    /**
+     * Disable Floating action button that opens the widget
+     * If disabled, a custom button should be implemented for the close/open actions
+     * @default false
+     */
+    fabDisable?: boolean;
+    /**
+     * side panel layout preferences
+     */
+    sidePanel?: ISidePanelUx;
+    /**
+     * if set to true widget position will be fixed and user won't be able to drag it.
+     * @default false
+     */
+    draggableDisabled?: boolean;
+}
+export interface ISidePanelUx {
+    /**
+     * Enables side panel ux for player fullscreen. by default overlay is used in fullscreen.
+     * @default false
+     */
+    fullScreenEnable?: boolean;
+    /**
+     * Width of the side panel in player fullscreen in pixels
+     * @default 400
+     */
+    fullScreenWidth?: number;
+    /**
+     * Width of the overlay side panel
+     * @default 350
+     */
+    width?: number;
+}
+export interface ICommentsUx {
+    /**
+     * If set to true comments start will be at the top instead of bottom.
+     * @default false
+     */
+    topToBottom?: boolean;
+    /**
+     * If set to true, when widget is loaded all the replies to comments will be shown.
+     * @default false
+     */
+    showReplies?: boolean;
+    /**
+     * The default sorting to use on startup.
+     * @default 'most_recent'
+     */
+    sort?: CommentsSortType;
+}
+export interface IPlayerUx {
+    /**
+     * Triggers that will automatically pause the player.
+     * All true by default.
+     * > For live video, the player is never paused.
+     */
+    pauseTriggers?: IPlayerPauseTriggers;
+    /**
+     * Triggers that will automatically play the player.
+     * All false by default.
+     */
+    playTriggers?: IPlayerPlayTriggers;
+}
+export interface IPlayerPauseTriggers {
+    /**
+     * Pause when user starts to comment
+     * @default true
+     */
+    comment?: boolean;
+    /**
+     * Pause when user starts to add new note
+     * @default true
+     */
+    note?: boolean;
+    /**
+     * Pause when user is prompted to login/signup
+     * @default true
+     */
+    authPrompt?: boolean;
+    /**
+     * On mobile when widget is open it overlays the player.
+     * Pause when widget is open on mobile devices, so the video is not played in the background.
+     * > when opening in interactive mode (kuku/mini widget that do not overlay all the video), the player will not be paused.
+     * @default true
+     */
+    openOnPhone?: boolean;
+}
+export interface IPlayerPlayTriggers {
+    /**
+     * Pause when user starts to comment
+     * @default false
+     */
+    comment?: boolean;
+    /**
+     * Pause when user starts to add new note
+     * @default false
+     */
+    note?: boolean;
+}
+export declare type ThemeType = 'default' | 'dark';
+export declare type WidgetPositionType = 'right' | 'right:top' | 'right:bottom' | 'left' | 'left:top' | 'left:bottom';
+export declare type WidgetLayoutType = 'edge' | 'overlay' | 'fixed' | 'sidePanel' | 'sidePanelOverlay';
+export declare type WidgetLoadStateType = 'kuku' | 'open' | 'closed';
+export declare type CommentsSortType = 'most_recent' | 'top_rated' | 'by_timetag';
+//# sourceMappingURL=ux.d.ts.map

package/dist/build/config/ux.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ux.d.ts","sourceRoot":"","sources":["../../../lib/config/ux.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,GAAG;IAChB;;;;OAIG;IACH,KAAK,CAAC,EAAE,SAAS,CAAC;IAClB,MAAM,CAAC,EAAE,SAAS,CAAC;IACnB,MAAM,CAAC,EAAE,SAAS,CAAC;IACnB,QAAQ,CAAC,EAAE,WAAW,CAAC;CAC1B;AAED,MAAM,WAAW,SAAS;IACtB;;;OAGG;IACH,QAAQ,CAAC,EAAE,kBAAkB,CAAC;IAC9B;;;;;;OAMG;IACH,SAAS,CAAC,EAAE,mBAAmB,CAAC;IAChC;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAE,gBAAgB,CAAC;IAC1B;;;OAGG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;IACf;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;OAEG;IACH,SAAS,CAAC,EAAE,YAAY,CAAC;IACzB;;;OAGG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC/B;AAED,MAAM,WAAW,YAAY;IACzB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,WAAW;IACxB;;;OAGG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;;OAGG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;;OAGG;IACH,IAAI,CAAC,EAAE,gBAAgB,CAAC;CAC3B;AAED,MAAM,WAAW,SAAS;IACtB;;;;OAIG;IACH,aAAa,CAAC,EAAE,oBAAoB,CAAC;IACrC;;;OAGG;IACH,YAAY,CAAC,EAAE,mBAAmB,CAAC;CACtC;AAED,MAAM,WAAW,oBAAoB;IACjC;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;;OAGG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;IACf;;;OAGG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;;;;OAKG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;CACzB;AAED,MAAM,WAAW,mBAAmB;IAChC;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;;OAGG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;CAClB;AAED,oBAAY,SAAS,GAAG,SAAS,GAAG,MAAM,CAAC;AAC3C,oBAAY,kBAAkB,GAAG,OAAO,GAAG,WAAW,GAAG,cAAc,GAAG,MAAM,GAAG,UAAU,GAAG,aAAa,CAAC;AAC9G,oBAAY,gBAAgB,GAAG,MAAM,GAAG,SAAS,GAAG,OAAO,GAAG,WAAW,GAAG,kBAAkB,CAAC;AAC/F,oBAAY,mBAAmB,GAAG,MAAM,GAAG,MAAM,GAAG,QAAQ,CAAC;AAC7D,oBAAY,gBAAgB,GAAG,aAAa,GAAG,WAAW,GAAG,YAAY,CAAC"}

package/dist/build/config/ux.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=ux.js.map

package/dist/build/config/ux.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ux.js","sourceRoot":"","sources":["../../../lib/config/ux.ts"],"names":[],"mappings":""}

package/dist/build/config/widget.d.ts

@@ -0,0 +1,70 @@
+import { IFeatures } from './features';
+import { IPlayerAdaptorApi } from '../player-adapter';
+import { ITimelineConfig } from './timeline';
+import { IWidgetUx } from './ux';
+export interface IWidgetConfig<F = IFeatures> {
+    /**
+     * Player setup
+     */
+    player: IPlayerConfig;
+    /**
+     * If provided, the widget will be positioned relative to this element instead of the player element
+     */
+    positionElement?: string | HTMLElement;
+    /**
+     * Configuration options that affect the user experience.
+     * Overrides any backend and {@link IConfig} ux settings.
+     */
+    ux?: IWidgetUx;
+    /**
+     * Enable/disable and configure features
+     * Modifying the features will override the backend and {@link IConfig} features.
+     * @remarks
+     * If Feature is not enabled on backend it cannot be enabled via this api.
+     */
+    features?: F;
+    /**
+     * If provided the discusion widget will be embedded inside the host element instead of as overlay
+     * The size of the widget will be responsive and set to 100% width and height of the host element.
+     */
+    host?: string | HTMLElement;
+    /**
+     * @internal
+     * Timeline configuration
+     */
+    timeline?: ITimelineConfig;
+    /**
+     * @internal
+     */
+    stats?: IStatsConfig;
+}
+export interface IPlayerConfig {
+    /**
+     * One of the player types
+     */
+    type: PlayerType;
+    /**
+     * dom element of the player or selector string to be used in document.querySelector()
+     */
+    element: string | HTMLElement;
+    /**
+     * Player adaptor API required for the `custom` player type
+     */
+    adaptorApi?: IPlayerAdaptorApi;
+    /**
+     * @internal
+     */
+    wide?: boolean;
+    /**
+     * @internal
+     */
+    params?: unknown;
+}
+/**
+ * @internal
+ */
+export interface IStatsConfig {
+    host: HTMLElement;
+}
+export declare type PlayerType = 'html5' | 'youtube' | 'jw6' | 'jw7' | 'jw' | 'videojs' | 'kaltura' | 'vimeo' | 'flowplayer' | 'h5p' | 'wistia' | 'openedx' | 'page' | 'kplaykit' | 'custom';
+//# sourceMappingURL=widget.d.ts.map

package/dist/build/config/widget.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"widget.d.ts","sourceRoot":"","sources":["../../../lib/config/widget.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AACvC,OAAO,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AACtD,OAAO,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAC7C,OAAO,EAAE,SAAS,EAAE,MAAM,MAAM,CAAC;AAEjC,MAAM,WAAW,aAAa,CAAC,CAAC,GAAG,SAAS;IACxC;;OAEG;IACH,MAAM,EAAE,aAAa,CAAC;IACtB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,WAAW,CAAC;IACvC;;;OAGG;IACH,EAAE,CAAC,EAAE,SAAS,CAAC;IACf;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,CAAC,CAAC;IACb;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,WAAW,CAAC;IAC5B;;;OAGG;IACH,QAAQ,CAAC,EAAE,eAAe,CAAC;IAC3B;;OAEG;IACH,KAAK,CAAC,EAAE,YAAY,CAAC;CACxB;AAED,MAAM,WAAW,aAAa;IAC1B;;OAEG;IACH,IAAI,EAAE,UAAU,CAAC;IACjB;;OAEG;IACH,OAAO,EAAE,MAAM,GAAG,WAAW,CAAC;IAC9B;;OAEG;IACH,UAAU,CAAC,EAAE,iBAAiB,CAAC;IAC/B;;OAEG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;IACf;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IACzB,IAAI,EAAE,WAAW,CAAC;CACrB;AAED,oBAAY,UAAU,GAAG,OAAO,GAAG,SAAS,GAAG,KAAK,GAAG,KAAK,GAAG,IAAI,GAAG,SAAS,GAAG,SAAS,GAAG,OAAO,GAAG,YAAY,GAAG,KAAK,GAAG,QAAQ,GAAG,SAAS,GAAG,MAAM,GAAG,UAAU,GAAG,QAAQ,CAAC"}

package/dist/build/config/widget.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=widget.js.map

package/dist/build/config/widget.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"widget.js","sourceRoot":"","sources":["../../../lib/config/widget.ts"],"names":[],"mappings":""}

package/dist/build/index.d.ts

@@ -0,0 +1,22 @@
+/**
+ * @module Annoto
+ */
+import { IConfig } from './config';
+import { IUxEvent, IStatsEvent, IVideoBenchmarkEvent, IMyActivity } from './events';
+import { IAnnotoApi, IMetadata } from './api';
+export declare type AnnotoEventType = 'ready' | 'metadata' | 'ux' | 'stats_events' | 'video_benchmark' | 'my_activity';
+export declare type AnnotoReadyCallback = (api: IAnnotoApi) => void;
+export declare type AnnotoMetadataCallback = (metadata: IMetadata) => void;
+export declare type AnnotoUxEventCallback = (uxEvent: IUxEvent) => void;
+export declare type AnnotoStatsEventCallback = (statsEvent: IStatsEvent) => void;
+export declare type AnnotoVideoBenchmarkCallback = (uxEvent: IVideoBenchmarkEvent) => void;
+export declare type AnnotoMyActivityCallback = (uxEvent: IMyActivity) => void;
+export interface Annoto {
+    on(event: AnnotoEventType, cb: AnnotoReadyCallback | AnnotoMetadataCallback | AnnotoUxEventCallback | AnnotoStatsEventCallback | AnnotoVideoBenchmarkCallback | AnnotoMyActivityCallback): void;
+    boot(config: IConfig): void;
+}
+export * from './config';
+export * from './api';
+export * from './events';
+export * from './player-adapter';
+//# sourceMappingURL=index.d.ts.map

package/dist/build/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../lib/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC;AACnC,OAAO,EAAE,QAAQ,EAAE,WAAW,EAAE,oBAAoB,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AACpF,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAE9C,oBAAY,eAAe,GAAG,OAAO,GAAG,UAAU,GAAG,IAAI,GAAG,cAAc,GAAG,iBAAiB,GAAG,aAAa,CAAC;AAC/G,oBAAY,mBAAmB,GAAG,CAAC,GAAG,EAAE,UAAU,KAAK,IAAI,CAAC;AAC5D,oBAAY,sBAAsB,GAAG,CAAC,QAAQ,EAAE,SAAS,KAAK,IAAI,CAAC;AACnE,oBAAY,qBAAqB,GAAG,CAAC,OAAO,EAAE,QAAQ,KAAK,IAAI,CAAC;AAChE,oBAAY,wBAAwB,GAAG,CAAC,UAAU,EAAE,WAAW,KAAK,IAAI,CAAC;AACzE,oBAAY,4BAA4B,GAAG,CAAC,OAAO,EAAE,oBAAoB,KAAK,IAAI,CAAC;AACnF,oBAAY,wBAAwB,GAAG,CAAC,OAAO,EAAE,WAAW,KAAK,IAAI,CAAC;AAEtE,MAAM,WAAW,MAAM;IACnB,EAAE,CAAC,KAAK,EAAE,eAAe,EAAE,EAAE,EAAE,mBAAmB,GAAG,sBAAsB,GAAG,qBAAqB,GAAG,wBAAwB,GAAG,4BAA4B,GAAG,wBAAwB,GAAG,IAAI,CAAC;IAChM,IAAI,CAAC,MAAM,EAAE,OAAO,GAAG,IAAI,CAAC;CAC/B;AAED,cAAc,UAAU,CAAC;AACzB,cAAc,OAAO,CAAC;AACtB,cAAc,UAAU,CAAC;AACzB,cAAc,kBAAkB,CAAC"}

package/dist/build/index.js

@@ -0,0 +1,20 @@
+"use strict";
+/**
+ * @module Annoto
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./config"), exports);
+__exportStar(require("./api"), exports);
+__exportStar(require("./events"), exports);
+__exportStar(require("./player-adapter"), exports);
+//# sourceMappingURL=index.js.map

package/dist/build/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../lib/index.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;AAmBH,2CAAyB;AACzB,wCAAsB;AACtB,2CAAyB;AACzB,mDAAiC"}