@monterosa/sdk-interact-kit 0.17.1-rc.6

package/dist/src/core/event/api.d.ts

@@ -0,0 +1,84 @@
+import { Unsubscribe } from '@monterosa/sdk-util';
+import { InteractEvent, EventState } from './public-types';
+import { InteractProject } from '../project/public-types';
+/**
+ * @internal
+ */
+declare const getEventsMemoized: (...args: any[]) => Promise<InteractEvent[]>;
+/**
+ * Returns all events in a project, including all active events and
+ * past/upcoming events, according to Listings settings in Project Setup
+ * in Studio.
+ *
+ * @param project - A project instance. If not provided,
+ *   the one from the default sdk will be fetched.
+ */
+declare function getEvents(project?: InteractProject): Promise<InteractEvent[]>;
+/**
+ * @internal
+ */
+declare const getEventMemoized: (...args: any[]) => Promise<InteractEvent | null>;
+/**
+ * Returns an event by its id
+ *
+ * @param id - Id of the event
+ * @param project - A project instance. If not provided,
+ *   the one from the default sdk will be fetched.
+ *
+ * @returns A an event associated with the provided id and project or null if no such
+ *   event exists in the project.
+ */
+declare function getEvent(id: string, project?: InteractProject): Promise<InteractEvent | null>;
+/**
+ * Adds an observer for when {@link InteractEvent.state | event state} changed
+ */
+declare function onEventState(event: InteractEvent, callback: (state: EventState) => void): Unsubscribe;
+/**
+ * Adds an observer for when event's data changed
+ */
+declare function onEventUpdated(event: InteractEvent, callback: () => void): Unsubscribe;
+/**
+ * Adds an observer that is called when an event is added to listings.
+ *
+ * @remarks
+ * The following actions will result in adding an event to listings:
+ *
+ * - The start of the event in Studio
+ *
+ * - The scheduling of a future event in Studio, when listings are configured
+ *   to include future events in Project Settings.
+ *
+ * - When a future event starts, a new future event may be added to the list,
+ *   depending on the project configuration, to ensure a minimum number of
+ *   upcoming events are always available.
+ */
+declare function onEventAdded(project: InteractProject, callback: (event: InteractEvent) => void): Unsubscribe;
+/**
+ * {@link onEventAdded} alias.
+ *
+ * @deprecated Use the new {@link onEventAdded} function instead.
+ */
+declare function onEventPublished(project: InteractProject, callback: (event: InteractEvent) => void): Unsubscribe;
+/**
+ * Adds an observer that is called when an event is removed from listings.
+ *
+ * @remarks
+ * The following actions will result in removing an event from listings:
+ *
+ * - The deletion of the event from Studio
+ *
+ * - The change of listings confuguration in Project Settings to exclude future
+ *   or past events.
+ *
+ * - The event is removed after a period of time since its completion. This period
+ *   is calculated as 45 seconds plus the Maximum allowed delay (configured in
+ *   Project Settings in Studio).
+ */
+declare function onEventRemoved(project: InteractProject, callback: (event: InteractEvent) => void): Unsubscribe;
+/**
+ * Returns the list of upcoming events
+ */
+/**
+ * Returns the list of active events
+ */
+export { getEvents, getEventsMemoized, getEvent, getEventMemoized, onEventState, onEventUpdated, onEventAdded, onEventPublished, onEventRemoved, };

package/dist/src/core/event/context.d.ts

@@ -0,0 +1,16 @@
+/**
+ * @license
+ * context.ts
+ * interact-kit
+ *
+ * Created by Rygor Kharytanovich <rygor@monterosa.co.uk> on 2022-02-22
+ * Copyright © 2022 Monterosa. All rights reserved.
+ *
+ * More details on the license can be found at https://www.monterosa.co/sdk/license
+ */
+import { MonterosaSdk } from '@monterosa/sdk-core';
+import { InteractProject } from '../project/public-types';
+export interface EventContext {
+    sdk: MonterosaSdk;
+    project: InteractProject;
+}

package/dist/src/core/event/event_impl.d.ts

@@ -0,0 +1,53 @@
+/**
+ * @license
+ * event_impl.ts
+ * interact-kit
+ *
+ * Created by Rygor Kharytanovich <rygor@monterosa.co.uk> on 2022-02-15
+ * Copyright © 2022 Monterosa. All rights reserved.
+ *
+ * More details on the license can be found at https://www.monterosa.co/sdk/license
+ */
+import { Emitter } from '@monterosa/sdk-util';
+import { EventContext } from './context';
+import { EventOptions, EventHistory } from './types';
+import { InteractEvent, EventState, InitState } from './public-types';
+/**
+ * @internal
+ */
+export declare class EventImpl extends Emitter implements InteractEvent {
+    readonly _data: EventOptions;
+    private _context;
+    private _state;
+    private _internalState;
+    private _initState;
+    private _history;
+    private unsubscribeStateHandler;
+    private unsubscribeInternalStateHandler;
+    private unsubscribeListingsHandler;
+    constructor(data: EventOptions, context: EventContext);
+    private calculateState;
+    private calculateInternalState;
+    private handleState;
+    private handleInternalState;
+    private handleListings;
+    /** @internal */
+    destroy(): void;
+    get context(): EventContext;
+    get id(): string;
+    get name(): string;
+    get startAt(): number;
+    get startAtIso(): string;
+    get endAt(): number;
+    get endAtIso(): string;
+    get duration(): number;
+    get fields(): Record<string, unknown>;
+    get state(): EventState;
+    get internalState(): EventState;
+    get initState(): InitState;
+    set initState(state: InitState);
+    get history(): EventHistory | null;
+    set history(value: EventHistory | null);
+    get canSubscribe(): boolean;
+    get canLoadHistory(): boolean;
+}

package/dist/src/core/event/factory.d.ts

@@ -0,0 +1,22 @@
+/**
+ * @license
+ * factory.ts
+ * interact-kit
+ *
+ * Created by Rygor Kharytanovich <rygor@monterosa.co.uk> on 2022-02-22
+ * Copyright © 2022 Monterosa. All rights reserved.
+ *
+ * More details on the license can be found at https://www.monterosa.co/sdk/license
+ */
+import { Unsubscribe } from '@monterosa/sdk-util';
+import { EventContext } from './context';
+import { EventOptions } from './types';
+import { InteractEvent } from './public-types';
+export declare const events: Map<string, InteractEvent>;
+export declare const healthListeners: Map<string, Unsubscribe>;
+export declare function buildEvent(options: EventOptions, context: EventContext): InteractEvent;
+export declare function init(event: InteractEvent): Promise<void>;
+/** @internal */
+export declare function terminate(event: InteractEvent): Promise<void>;
+export declare function subscribe(event: InteractEvent): Promise<void>;
+export declare function unsubscribe(event: InteractEvent): Promise<void>;

package/dist/src/core/event/index.d.ts

@@ -0,0 +1,13 @@
+/**
+ * @license
+ * index.ts
+ * interact-kit
+ *
+ * Created by Rygor Kharytanovich <rygor@monterosa.co.uk> on 2022-02-15
+ * Copyright © 2022 Monterosa. All rights reserved.
+ *
+ * More details on the license can be found at https://www.monterosa.co/sdk/license
+ */
+export * from './api';
+export * from './event_impl';
+export { InteractEvent, EventState } from './public-types';

package/dist/src/core/event/internal.d.ts

@@ -0,0 +1,12 @@
+/**
+ * @license
+ * internal.ts
+ * interact-kit
+ *
+ * Created by Rygor Kharytanovich <rygor@monterosa.co.uk> on 2022-03-24
+ * Copyright © 2022 Monterosa. All rights reserved.
+ *
+ * More details on the license can be found at https://www.monterosa.co/sdk/license
+ */
+import { EventHistory } from './types';
+export declare function fetchHistory(host: string, id: string): Promise<EventHistory>;

package/dist/src/core/event/public-types.d.ts

@@ -0,0 +1,119 @@
+/**
+ * @license
+ * public-types.ts
+ * interact-kit
+ *
+ * Created by Rygor Kharytanovich <rygor@monterosa.co.uk> on 2022-03-24
+ * Copyright © 2022 Monterosa. All rights reserved.
+ *
+ * More details on the license can be found at https://www.monterosa.co/sdk/license
+ */
+import { Emitter } from '@monterosa/sdk-util';
+import { EventHistory } from './types';
+import { EventContext } from './context';
+/**
+ * Describes the event state.
+ */
+export declare enum EventState {
+    /**
+     * The event is in the `upcoming` state when its {@link InteractEvent.startAt | start time}
+     * less than the {@link now | current time}.
+     */
+    Upcoming = "upcoming",
+    /**
+     * The event is in the `active` state when its {@link InteractEvent.startAt | start time}
+     * equal or more than the {@link now | current time} and less than the
+     * {@link InteractEvent.endAt | end time}.
+     */
+    Active = "active",
+    /**
+     * @internal
+     */
+    Prolonged = "prolonged",
+    /**
+     * The event is in the `finished` state when its {@link InteractEvent.endAt | end time}
+     * equal or more than the {@link now | current time}.
+     */
+    Finished = "finished"
+}
+export declare enum InitState {
+    Uninitialised = "uninitialised",
+    Initialising = "initialising",
+    Initialised = "initialised"
+}
+/**
+ * An instance of
+ * {@link https://products.monterosa.co/mic/core-concepts/schedule-and-events | Monterosa / Interaction Cloud Event}
+ * that holds all of its information.
+ *
+ * Event represent either a sports game, TV show or simply a period of time in
+ * which you want to push out interactivity to users. When you create an event
+ * you can specify: duration, start time, start mode and
+ * {@link https://products.monterosa.co/mic/developer-guides/app-spec/event-settings-spec | custom fields}
+ * that can be confgured by a developers
+ */
+export interface InteractEvent extends Emitter {
+    /**
+     * Event uuid.
+     */
+    id: string;
+    /**
+     * Event name.
+     */
+    name: string;
+    /**
+     * Returns the event start time as UNIX time in seconds.
+     */
+    startAt: number;
+    /**
+     * Returns the event start time as ISO string.
+     */
+    startAtIso: string;
+    /**
+     * Returns the event end time as UNIX time in seconds.
+     */
+    endAt: number;
+    /**
+     * Returns the event end time as ISO string.
+     */
+    endAtIso: string;
+    /**
+     * Studio supports custom fields within Event. This returns an object
+     * populated with the custom fields. Object property names will match keys
+     * as provided as part of custom fields definition in the feed and values
+     * will be as collected by Studio.
+     *
+     * @example
+     * ```javascript
+     * // {
+     * //   "name": "Canis lupus",
+     * //   "family": "Canidae",
+     * //   ...
+     * //   "species": "C. lupus"
+     * // }
+     * ```
+     */
+    fields: Record<string, unknown>;
+    /**
+     * Event state
+     */
+    state: EventState;
+    /**
+     * Returns the total duration in seconds of the event.
+     */
+    duration: number;
+    /** @internal */
+    canSubscribe: boolean;
+    /** @internal */
+    canLoadHistory: boolean;
+    /** @internal */
+    internalState: EventState;
+    /** @internal */
+    initState: InitState;
+    /** @internal */
+    context: EventContext;
+    /** @internal */
+    history: EventHistory | null;
+    /** @internal */
+    destroy(): void;
+}

package/dist/src/core/event/types.d.ts

@@ -0,0 +1,32 @@
+/**
+ * @license
+ * types.ts
+ * interact-kit
+ *
+ * Created by Rygor Kharytanovich <rygor@monterosa.co.uk> on 2022-02-15
+ * Copyright © 2022 Monterosa. All rights reserved.
+ *
+ * More details on the license can be found at https://www.monterosa.co/sdk/license
+ */
+import { Localised } from '../../types';
+import { ElementOptions } from '../element/types';
+export interface EventOptions {
+    id: string;
+    name: string;
+    start_at: number;
+    start_at_iso: string;
+    end_at: number;
+    end_at_iso: string;
+    started: boolean;
+    custom_fields: Localised<Record<string, unknown>>;
+    extra_time: number;
+    on_demand_time: number;
+    duration: number;
+    original_duration: number;
+    digest: string;
+}
+export interface EventHistory {
+    timeline: ElementOptions[];
+    config: EventOptions;
+    version: number;
+}

package/dist/src/core/index.d.ts

@@ -0,0 +1,15 @@
+/**
+ * @license
+ * index.ts
+ * interact-kit
+ *
+ * Created by Rygor Kharytanovich <rygor@monterosa.co.uk> on 2022-02-15
+ * Copyright © 2022 Monterosa. All rights reserved.
+ *
+ * More details on the license can be found at https://www.monterosa.co/sdk/license
+ */
+export * from './connect';
+export * from './connection_health';
+export * from './project';
+export * from './event';
+export * from './element';

package/dist/src/core/project/api.d.ts

@@ -0,0 +1,36 @@
+/**
+ * @license
+ * api.ts
+ * interact-kit
+ *
+ * Created by Rygor Kharytanovich <rygor@monterosa.co.uk> on 2022-02-15
+ * Copyright © 2022 Monterosa. All rights reserved.
+ *
+ * More details on the license can be found at https://www.monterosa.co/sdk/license
+ */
+import { MonterosaSdk } from '@monterosa/sdk-core';
+import { Unsubscribe } from '@monterosa/sdk-util';
+import { InteractProject, Listings } from './public-types';
+/**
+ * @internal
+ */
+declare const getProjectMemoized: (...args: any[]) => Promise<InteractProject>;
+/**
+ * Returns {@link InteractProject | project instance} associated
+ * with the {@link @monterosa/sdk-core#MonterosaSdk | configured sdk}
+ */
+declare function getProject(sdk?: MonterosaSdk): Promise<InteractProject>;
+/**
+ * @internal
+ */
+export declare function fetchListings(host: string, projectId: string): Promise<Listings>;
+/**
+ * Adds an observer for when {@link InteractProject.fields |  project fields}
+ * are updated
+ */
+declare function onProjectFieldsUpdated(project: InteractProject, callback: () => void): Unsubscribe;
+/**
+ * @internal
+ */
+declare function onProjectListingsUpdated(project: InteractProject, callback: () => void): Unsubscribe;
+export { getProject, getProjectMemoized, onProjectFieldsUpdated, onProjectListingsUpdated, };

package/dist/src/core/project/constants.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @license
+ * constants.ts
+ * interact-kit
+ *
+ * Created by Rygor Kharytanovich <rygor@monterosa.co.uk> on 2022-06-02
+ * Copyright © 2022 Monterosa. All rights reserved.
+ *
+ * More details on the license can be found at https://www.monterosa.co/sdk/license
+ */
+export declare const DEFAULT_IGNORE_TIME = 30;

package/dist/src/core/project/context.d.ts

@@ -0,0 +1,14 @@
+/**
+ * @license
+ * context.ts
+ * interact-kit
+ *
+ * Created by Rygor Kharytanovich <rygor@monterosa.co.uk> on 2022-02-22
+ * Copyright © 2022 Monterosa. All rights reserved.
+ *
+ * More details on the license can be found at https://www.monterosa.co/sdk/license
+ */
+import { MonterosaSdk } from '@monterosa/sdk-core';
+export interface ProjectContext {
+    sdk: MonterosaSdk;
+}

package/dist/src/core/project/factory.d.ts

@@ -0,0 +1,16 @@
+/**
+ * @license
+ * factory.ts
+ * interact-kit
+ *
+ * Created by Rygor Kharytanovich <rygor@monterosa.co.uk> on 2022-02-15
+ * Copyright © 2022 Monterosa. All rights reserved.
+ *
+ * More details on the license can be found at https://www.monterosa.co/sdk/license
+ */
+import { ProjectContext } from './context';
+import { InteractProject, ProjectOptions } from './public-types';
+import { Message } from '../connect';
+export declare const projects: Map<string, InteractProject>;
+export declare function buildProject(options: ProjectOptions, context: ProjectContext): Promise<InteractProject>;
+export declare function handleConnectMessage(message: Message): Promise<void>;

package/dist/src/core/project/index.d.ts

@@ -0,0 +1,13 @@
+/**
+ * @license
+ * index.ts
+ * interact-kit
+ *
+ * Created by Rygor Kharytanovich <rygor@monterosa.co.uk> on 2022-02-15
+ * Copyright © 2022 Monterosa. All rights reserved.
+ *
+ * More details on the license can be found at https://www.monterosa.co/sdk/license
+ */
+export * from './api';
+export * from './project_impl';
+export { InteractProject, ExtensionAsset } from './public-types';

package/dist/src/core/project/internal.d.ts

@@ -0,0 +1,12 @@
+/**
+ * @license
+ * internal.ts
+ * interact-kit
+ *
+ * Created by Rygor Kharytanovich <rygor@monterosa.co.uk> on 2022-02-15
+ * Copyright © 2022 Monterosa. All rights reserved.
+ *
+ * More details on the license can be found at https://www.monterosa.co/sdk/license
+ */
+import { Localised } from '../../types';
+export declare function fetchSettings(host: string, id: string): Promise<Localised<Record<string, unknown>>>;

package/dist/src/core/project/project_impl.d.ts

@@ -0,0 +1,51 @@
+/**
+ * @license
+ * project_impl.ts
+ * interact-kit
+ *
+ * Created by Rygor Kharytanovich <rygor@monterosa.co.uk> on 2022-02-15
+ * Copyright © 2022 Monterosa. All rights reserved.
+ *
+ * More details on the license can be found at https://www.monterosa.co/sdk/license
+ */
+import { Emitter } from '@monterosa/sdk-util';
+import { ProjectContext } from './context';
+import { InteractProject, Listings, ProjectOptions } from './public-types';
+import { Localised } from '../../types';
+import { EventOptions } from '../event/types';
+/**
+ * @internal
+ */
+export declare class ProjectImpl extends Emitter implements InteractProject {
+    host: string;
+    id: string;
+    private _context;
+    private _listings;
+    private _fields;
+    private _locales;
+    private _locale;
+    constructor(options: ProjectOptions, context: ProjectContext);
+    get context(): ProjectContext;
+    get embedUrl(): string;
+    get uuid(): string;
+    get events(): EventOptions[];
+    get listings(): Listings;
+    set listings(value: Listings);
+    get isLocalisationSupported(): boolean;
+    get locale(): string;
+    set locale(locale: string);
+    get locales(): string[];
+    get fields(): Record<string, unknown>;
+    /**
+     * Sets custom fields
+     *
+     * It accepts both Localised<Record<string, unknown>> and Record<string, unknown> to
+     * avoid mistyping between setter and getter
+     *
+     * @internal
+     */
+    set fields(value: Localised<Record<string, unknown>> | Record<string, unknown>);
+    get extensions(): Record<string, import("./public-types").ExtensionAsset[]>;
+    get historyIgnore(): number;
+    delete(): void;
+}