@monterosa/sdk-interact-kit 2.0.0-rc.1 → 2.0.0-rc.3

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

@@ -10,18 +10,18 @@ import { Emitter } from '@monterosa/sdk-util';
 import { EventHistory } from './types';
 import { EventContext } from './context';
 /**
- * Describes the event state.
+ * 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}.
+     * The Event is in the `upcoming` state when its {@link InteractEvent | startAt}
+     * less than the {@link @monterosa/sdk-util#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}.
+     * The Event is in the `active` state when its {@link InteractEvent | startAt}
+     * equal or more than the {@link @monterosa/sdk-util#now | current time} and less than the
+     * {@link InteractEvent | endAt}.
      */
     Active = "active",
     /**
@@ -29,8 +29,8 @@ export declare enum EventState {
      */
     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}.
+     * The Event is in the `finished` state when its {@link InteractEvent | endAt}
+     * equal or more than the {@link @monterosa/sdk-util#now | current time}.
      */
     Finished = "finished"
 }
@@ -40,15 +40,19 @@ export declare enum InitState {
     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.
+ * Represents an Event, a time-bound period of
+ * interactivity. Obtain via {@link getEvent} or
+ * {@link getEvents}.
  *
- * 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
+ * @remarks
+ * Events represent a sports game, TV show, or any period of time in which you
+ * want to push interactivity to users. Each Event has a 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
+ * that can be configured by developers.
+ *
+ * See {@link https://products.monterosa.co/mic/core-concepts/schedule-and-events | Events} in
+ * the platform documentation for more details.
  */
 export interface InteractEvent extends Emitter {
     /**
@@ -60,23 +64,23 @@ export interface InteractEvent extends Emitter {
      */
     name: string;
     /**
-     * Returns the event start time as UNIX time in seconds.
+     * Returns the Event start time as UNIX time in seconds.
      */
     startAt: number;
     /**
-     * Returns the event start time as ISO string.
+     * Returns the Event start time as ISO string.
      */
     startAtIso: string;
     /**
-     * Returns the event end time as UNIX time in seconds.
+     * Returns the Event end time as UNIX time in seconds.
      */
     endAt: number;
     /**
-     * Returns the event end time as ISO string.
+     * Returns the Event end time as ISO string.
      */
     endAtIso: string;
     /**
-     * Studio supports custom fields within Event. This returns an object
+     * Studio supports custom fields within an 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.
@@ -97,7 +101,7 @@ export interface InteractEvent extends Emitter {
      */
     state: EventState;
     /**
-     * Returns the total duration in seconds of the event.
+     * Returns the total duration in seconds of the Event.
      */
     duration: number;
     /** @internal */

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

@@ -14,20 +14,20 @@ import { InteractProject } from './public-types';
  */
 declare const getProjectMemoized: (...args: any[]) => Promise<InteractProject>;
 /**
- * Returns {@link InteractProject | project instance} associated
- * with the {@link @monterosa/sdk-core#MonterosaSdk | configured sdk}
+ * Returns {@link InteractProject | Project instance} associated
+ * with the
+ * {@link @monterosa/sdk-core#MonterosaSdk | configured SDK}
+ *
+ * @param sdk - The SDK instance. Defaults to the default SDK.
+ * @returns The Project instance.
  */
 declare function getProject(sdk?: MonterosaSdk): Promise<InteractProject>;
 /**
- * Adds an observer for when {@link InteractProject.fields |  project fields}
- * are updated
- */
-declare function onProjectFieldsUpdated(project: InteractProject, callback: () => void): Unsubscribe;
-/**
- * Adds an observer that is called when the project listings are updated.
+ * Adds an observer for when
+ * {@link InteractProject | Project fields} are updated
  *
- * @deprecated Use {@link onEventAdded()}, {@link onEventUpdated()} and
- * {@link onEventRemoved()} instead
+ * @param project - The Project to observe
+ * @param callback - Called when Project fields change
  */
-declare function onProjectListingsUpdated(project: InteractProject, callback: () => void): Unsubscribe;
-export { getProject, getProjectMemoized, onProjectFieldsUpdated, onProjectListingsUpdated, };
+declare function onProjectFieldsUpdated(project: InteractProject, callback: () => void): Unsubscribe;
+export { getProject, getProjectMemoized, onProjectFieldsUpdated };

package/dist/core/project/public-types.d.ts

@@ -11,19 +11,21 @@ import { MonterosaKit } from '@monterosa/sdk-core';
 import { ProjectContext } from './context';
 import { EventOptions } from '../event/types';
 /**
- * An instance of
- * {@link https://products.monterosa.co/mic/core-concepts | Monterosa / Interaction Cloud Project}
- * that holds all of its information.
+ * Represents a Project, a container for configuration,
+ * theming, and Events. Obtain via {@link getProject}.
  *
- * Every Project in Studio has id, host, embedUrl and a set of fields
+ * @remarks
+ * Every Project in Studio has an id, host, embedUrl, and a set of fields
  * associated with an
  * {@link https://products.monterosa.co/mic/developer-guides/whats-an-app | App}.
- * Project fields a set of
+ * Project fields are
  * {@link https://products.monterosa.co/mic/producer-guide/studio/app-setup | configuration options}
- * that are created by the
+ * created by the
  * {@link https://products.monterosa.co/mic/developer-guides/app-spec/project-settings-spec | app developer}
  * and vary from App to App.
  *
+ * See {@link https://products.monterosa.co/mic/core-concepts | Projects} in
+ * the platform documentation for more details.
  */
 export interface InteractProject extends MonterosaKit, Emitter {
     /**
@@ -39,7 +41,7 @@ export interface InteractProject extends MonterosaKit, Emitter {
      */
     embedUrl: string;
     /**
-     * Returns `true` if the project supports localisation.
+     * Returns `true` if the Project supports localisation.
      */
     isLocalisationSupported: boolean;
     /**
@@ -51,7 +53,7 @@ export interface InteractProject extends MonterosaKit, Emitter {
      */
     locale: string;
     /**
-     * Monterosa / Interaction Cloud supports custom fields within Project.
+     * Monterosa / Interaction Cloud supports custom fields within a Project.
      * 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.