@concord-consortium/lara-interactive-api 1.5.0 → 1.5.1

package/api.d.ts

@@ -74,6 +74,9 @@ export declare const removeGetReportItemAnswerListener: () => void;
 export declare const setSupportedFeatures: (features: ISupportedFeatures) => void;
 export declare const setHeight: (height: number | string) => void;
 export declare const postDecoratedContentEvent: (msg: IDecoratedContentEvent) => void;
+/**
+ * Providing empty string or null disables hint.
+ */
 export declare const setHint: (hint: string | null) => void;
 export declare const setNavigation: (options: INavigationOptions) => void;
 export declare const getAuthInfo: () => Promise<IAuthInfo>;
@@ -85,6 +88,12 @@ export declare const addAuthoredStateListener: <AuthoredState>(listener: (author
 export declare const removeAuthoredStateListener: <AuthoredState>(listener: (authoredState: AuthoredState) => void) => void;
 export declare const addGlobalInteractiveStateListener: <GlobalInteractiveState>(listener: (globalInteractiveState: GlobalInteractiveState) => void) => void;
 export declare const removeGlobalInteractiveStateListener: <GlobalInteractiveState>(listener: (globalInteractiveState: GlobalInteractiveState) => void) => void;
+/**
+ * The listener should be called immediately after it is added with any state of the linked
+ * interactive that the host currently knows about. This first call might not happen
+ * synchronously it could be slightly delayed. And then the listener should be called again
+ * whenever the state of the linked interactive changes.
+ */
 export declare const addLinkedInteractiveStateListener: <LinkedInteractiveState>(listener: (linkedIntState: LinkedInteractiveState | undefined) => void, options: IAddLinkedInteractiveStateListenerOptions) => void;
 export declare const removeLinkedInteractiveStateListener: <InteractiveState>(listener: (intState: InteractiveState | null) => void) => void;
 /**

package/index-bundle.d.ts

@@ -111,6 +111,7 @@ interface IAuthoringInitInteractive<AuthoredState = {}> {
 interface IReportInitInteractive<InteractiveState = {}, AuthoredState = {}> {
     version: 1;
     mode: "report";
+    view?: "standalone";
     hostFeatures: IHostFeatures;
     authoredState: AuthoredState;
     interactiveState: InteractiveState;
@@ -525,6 +526,9 @@ declare const removeGetReportItemAnswerListener: () => void;
 declare const setSupportedFeatures: (features: ISupportedFeatures) => void;
 declare const setHeight: (height: number | string) => void;
 declare const postDecoratedContentEvent: (msg: IDecoratedContentEvent) => void;
+/**
+ * Providing empty string or null disables hint.
+ */
 declare const setHint: (hint: string | null) => void;
 declare const setNavigation: (options: INavigationOptions) => void;
 declare const getAuthInfo: () => Promise<IAuthInfo>;
@@ -536,6 +540,12 @@ declare const addAuthoredStateListener: <AuthoredState>(listener: (authoredState
 declare const removeAuthoredStateListener: <AuthoredState>(listener: (authoredState: AuthoredState) => void) => void;
 declare const addGlobalInteractiveStateListener: <GlobalInteractiveState>(listener: (globalInteractiveState: GlobalInteractiveState) => void) => void;
 declare const removeGlobalInteractiveStateListener: <GlobalInteractiveState>(listener: (globalInteractiveState: GlobalInteractiveState) => void) => void;
+/**
+ * The listener should be called immediately after it is added with any state of the linked
+ * interactive that the host currently knows about. This first call might not happen
+ * synchronously it could be slightly delayed. And then the listener should be called again
+ * whenever the state of the linked interactive changes.
+ */
 declare const addLinkedInteractiveStateListener: <LinkedInteractiveState>(listener: (linkedIntState: LinkedInteractiveState | undefined) => void, options: IAddLinkedInteractiveStateListenerOptions) => void;
 declare const removeLinkedInteractiveStateListener: <InteractiveState>(listener: (intState: InteractiveState | null) => void) => void;
 /**

package/index.js

@@ -4265,7 +4265,7 @@ var postDecoratedContentEvent = function (msg) {
     (0, client_1.getClient)().post("decoratedContentEvent", msg);
 };
 exports.postDecoratedContentEvent = postDecoratedContentEvent;
-/*
+/**
  * Providing empty string or null disables hint.
  */
 var setHint = function (hint) {
@@ -4364,6 +4364,12 @@ var removeGlobalInteractiveStateListener = function (listener) {
 exports.removeGlobalInteractiveStateListener = removeGlobalInteractiveStateListener;
 // Mapping between external listener and internal listener, so it's possible to remove linkedInteractiveState listeners.
 var _linkedInteractiveStateListeners = new Map();
+/**
+ * The listener should be called immediately after it is added with any state of the linked
+ * interactive that the host currently knows about. This first call might not happen
+ * synchronously it could be slightly delayed. And then the listener should be called again
+ * whenever the state of the linked interactive changes.
+ */
 var addLinkedInteractiveStateListener = function (listener, options) {
     var client = (0, client_1.getClient)();
     var listenerId = (0, uuid_1.v4)();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@concord-consortium/lara-interactive-api",
-  "version": "1.5.0",
+  "version": "1.5.1",
   "description": "LARA Interactive API client and types",
   "main": "./index.js",
   "types": "./index-bundle.d.ts",