@concord-consortium/lara-interactive-api 1.5.0 → 1.6.0-pre.1

package/api.d.ts

@@ -1,4 +1,4 @@
-import { IInitInteractive, INavigationOptions, IAuthInfo, ISupportedFeatures, IShowModal, ICloseModal, IGetInteractiveListOptions, IGetInteractiveListResponse, ISetLinkedInteractives, IGetLibraryInteractiveListRequest, IJwtResponse, ICustomMessageHandler, ICustomMessagesHandledMap, IGetInteractiveSnapshotOptions, IGetInteractiveSnapshotResponse, IAddLinkedInteractiveStateListenerOptions, IDecoratedContentEvent, ITextDecorationHandler, WriteAttachmentParams, ReadAttachmentParams, GetAttachmentUrlParams, IGetReportItemAnswerHandler, IReportItemAnswer } from "./types";
+import { IInitInteractive, INavigationOptions, IAuthInfo, ISupportedFeatures, IShowModal, ICloseModal, IGetInteractiveListOptions, IGetInteractiveListResponse, ISetLinkedInteractives, IGetLibraryInteractiveListRequest, IJwtResponse, ICustomMessageHandler, ICustomMessagesHandledMap, IGetInteractiveSnapshotOptions, IGetInteractiveSnapshotResponse, IAddLinkedInteractiveStateListenerOptions, IDecoratedContentEvent, ITextDecorationHandler, WriteAttachmentParams, ReadAttachmentParams, GetAttachmentUrlParams, IGetReportItemAnswerHandler, IReportItemAnswer, OnUnloadFunction } from "./types";
 export declare const getInitInteractiveMessage: <InteractiveState = {}, AuthoredState = {}, GlobalInteractiveState = {}>() => Promise<IInitInteractive<InteractiveState, AuthoredState, GlobalInteractiveState> | null>;
 export declare const getMode: () => Promise<"runtime" | "authoring" | "report" | "reportItem" | undefined>;
 export declare const getInteractiveState: <InteractiveState>() => InteractiveState | null;
@@ -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;
 /**
@@ -105,3 +114,4 @@ export declare const writeAttachment: (params: WriteAttachmentParams) => Promise
 export declare const readAttachment: (params: ReadAttachmentParams) => Promise<Response>;
 export declare const getAttachmentUrl: (params: GetAttachmentUrlParams) => Promise<string>;
 export declare const sendReportItemAnswer: (request: Omit<IReportItemAnswer, "requestId">) => void;
+export declare const setOnUnload: (onUnload?: OnUnloadFunction<{}> | undefined) => void;

package/client.d.ts

@@ -1,5 +1,5 @@
 import * as iframePhone from "iframe-phone";
-import { ClientMessage, ICustomMessageHandler, ICustomMessagesHandledMap, ISupportedFeaturesRequest, ServerMessage, ITextDecorationHandler, IGetReportItemAnswerHandler } from "./types";
+import { ClientMessage, ICustomMessageHandler, ICustomMessagesHandledMap, ISupportedFeaturesRequest, ServerMessage, ITextDecorationHandler, IGetReportItemAnswerHandler, OnUnloadFunction } from "./types";
 import { ManagedState } from "./managed-state";
 export declare const getClient: () => Client;
 export declare class Client {
@@ -8,6 +8,7 @@ export declare class Client {
     private customMessagesHandled;
     private listeners;
     private requestId;
+    private onUnload;
     constructor();
     getNextRequestId(): number;
     post(message: ClientMessage, content?: any): void;
@@ -20,5 +21,6 @@ export declare class Client {
     addGetReportItemAnswerListener(callback: IGetReportItemAnswerHandler): void;
     removeGetReportItemAnswerListener(): boolean;
     setSupportedFeatures: (request: ISupportedFeaturesRequest) => void;
+    setOnUnload: (onUnload?: OnUnloadFunction<{}> | undefined) => void;
     private connect;
 }

package/index-bundle.d.ts

@@ -35,6 +35,10 @@ interface IJwtResponse {
     claims: IJwtClaims;
 }
 
+interface IAttachmentInfo {
+    contentType?: string;
+}
+declare type AttachmentInfoMap = Record<string, IAttachmentInfo>;
 interface IInteractiveStateProps<InteractiveState = {}> {
     interactiveState: InteractiveState | null;
     hasLinkedInteractive?: boolean;
@@ -51,6 +55,7 @@ interface IInteractiveStateProps<InteractiveState = {}> {
     pageName?: string;
     activityName?: string;
     externalReportUrl?: string;
+    attachments?: AttachmentInfoMap;
 }
 interface IHostFeatureSupport extends Record<string, unknown> {
     version: string;
@@ -86,6 +91,7 @@ interface IRuntimeInitInteractive<InteractiveState = {}, AuthoredState = {}, Glo
     };
     linkedInteractives: ILinkedInteractive[];
     themeInfo: IThemeInfo;
+    attachments?: AttachmentInfoMap;
 }
 interface IThemeInfo {
     colors: {
@@ -111,10 +117,12 @@ interface IAuthoringInitInteractive<AuthoredState = {}> {
 interface IReportInitInteractive<InteractiveState = {}, AuthoredState = {}> {
     version: 1;
     mode: "report";
+    view?: "standalone";
     hostFeatures: IHostFeatures;
     authoredState: AuthoredState;
     interactiveState: InteractiveState;
     themeInfo: IThemeInfo;
+    attachments?: AttachmentInfoMap;
 }
 interface IReportItemInitInteractive<InteractiveState = {}, AuthoredState = {}> {
     version: 1;
@@ -125,6 +133,7 @@ interface IReportItemInitInteractive<InteractiveState = {}, AuthoredState = {}>
     users: Record<string, {
         hasAnswer: boolean;
     }>;
+    attachments?: AttachmentInfoMap;
 }
 declare type IInitInteractive<InteractiveState = {}, AuthoredState = {}, GlobalInteractiveState = {}> = IRuntimeInitInteractive<InteractiveState, AuthoredState, GlobalInteractiveState> | IAuthoringInitInteractive<AuthoredState> | IReportInitInteractive<InteractiveState, AuthoredState> | IReportItemInitInteractive<InteractiveState, AuthoredState>;
 declare type InitInteractiveMode = "runtime" | "authoring" | "report" | "reportItem";
@@ -352,16 +361,34 @@ interface ILinkedInteractiveStateResponse<LinkedInteractiveState> {
     interactiveState: LinkedInteractiveState | undefined;
 }
 interface IGetReportItemAnswer<InteractiveState = {}, AuthoredState = {}> extends IBaseRequestResponse {
-    type: "html";
+    version: "2.0.0";
     platformUserId: string;
     interactiveState: InteractiveState;
     authoredState: AuthoredState;
 }
-interface IReportItemAnswer extends IBaseRequestResponse {
+interface IReportItemAnswerItemAttachment {
+    type: "attachment";
+    name: string;
+    label?: string;
+}
+interface IReportItemAnswerItemAnswerText {
+    type: "answerText";
+}
+interface IReportItemAnswerItemHtml {
     type: "html";
-    platformUserId: string;
     html: string;
 }
+interface IReportItemAnswerItemLinks {
+    type: "links";
+    hideViewInline?: boolean;
+    hideViewInNewTab?: boolean;
+}
+declare type IReportItemAnswerItem = IReportItemAnswerItemAttachment | IReportItemAnswerItemAnswerText | IReportItemAnswerItemHtml | IReportItemAnswerItemLinks;
+interface IReportItemAnswer extends IBaseRequestResponse {
+    version: "2.0.0";
+    platformUserId: string;
+    items: IReportItemAnswerItem[];
+}
 declare type IGetReportItemAnswerHandler = (message: IGetReportItemAnswer) => void;
 /**
  * Interface that can be used by interactives to export and consume datasets. For example:
@@ -384,6 +411,10 @@ interface IDataset {
 interface IInteractiveStateWithDataset {
     dataset?: IDataset | null;
 }
+interface IGetInteractiveState {
+    unloading?: boolean;
+}
+declare type OnUnloadFunction<InteractiveState = {}> = (options: IGetInteractiveState) => Promise<InteractiveState>;
 
 declare type ChoiceId = string;
 interface IAuthoringMetadataBase {
@@ -525,6 +556,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 +570,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;
 /**
@@ -556,6 +596,7 @@ declare const writeAttachment: (params: WriteAttachmentParams) => Promise<Respon
 declare const readAttachment: (params: ReadAttachmentParams) => Promise<Response>;
 declare const getAttachmentUrl: (params: GetAttachmentUrlParams) => Promise<string>;
 declare const sendReportItemAnswer: (request: Omit<IReportItemAnswer, "requestId">) => void;
+declare const setOnUnload: (onUnload?: OnUnloadFunction<{}> | undefined) => void;
 
 declare type UpdateFunc<S> = (prevState: S | null) => S;
 declare const useInteractiveState: <InteractiveState>() => {
@@ -604,6 +645,7 @@ declare class Client {
     private customMessagesHandled;
     private listeners;
     private requestId;
+    private onUnload;
     constructor();
     getNextRequestId(): number;
     post(message: ClientMessage, content?: any): void;
@@ -616,7 +658,8 @@ declare class Client {
     addGetReportItemAnswerListener(callback: IGetReportItemAnswerHandler): void;
     removeGetReportItemAnswerListener(): boolean;
     setSupportedFeatures: (request: ISupportedFeaturesRequest) => void;
+    setOnUnload: (onUnload?: OnUnloadFunction<{}> | undefined) => void;
     private connect;
 }
 
-export { ChoiceId, Client, ClientMessage, DeprecatedRuntimeClientMessage, DeprecatedRuntimeServerMessage, GetAttachmentUrlParams, GlobalIFrameSaverClientMessage, GlobalIFrameSaverServerMessage, IAddLinkedInteractiveStateListenerOptions, IAddLinkedInteractiveStateListenerRequest, IAttachmentUrlRequest, IAttachmentUrlResponse, IAuthInfo, IAuthoringClientMessage, IAuthoringCustomReportField, IAuthoringCustomReportFields, IAuthoringImageQuestionMetadata, IAuthoringInitInteractive, IAuthoringInteractiveMetadata, IAuthoringMetadata, IAuthoringMetadataBase, IAuthoringMultipleChoiceChoiceMetadata, IAuthoringMultipleChoiceMetadata, IAuthoringOpenResponseMetadata, IAuthoringServerMessage, IBaseShowModal, ICloseModal, IContextMember, IContextMembership, ICustomMessage, ICustomMessageHandler, ICustomMessageOptions, ICustomMessagesHandledMap, ICustomReportFieldsAuthoredState, ICustomReportFieldsAuthoredStateField, ICustomReportFieldsInteractiveState, IDataset, IDecoratedContentEvent, IGetAuthInfoRequest, IGetAuthInfoResponse, IGetFirebaseJwtRequest, IGetFirebaseJwtResponse, IGetInteractiveListOptions, IGetInteractiveListRequest, IGetInteractiveListResponse, IGetInteractiveSnapshotOptions, IGetInteractiveSnapshotRequest, IGetInteractiveSnapshotResponse, IGetLibraryInteractiveListOptions, IGetLibraryInteractiveListRequest, IGetLibraryInteractiveListResponse, IGetReportItemAnswer, IGetReportItemAnswerHandler, IHintRequest, IHostFeatureSupport, IHostFeatures, IHostModalSupport, IInitInteractive, IInteractiveListResponseItem, IInteractiveStateProps, IInteractiveStateWithDataset, IJwtClaims, IJwtResponse, ILibraryInteractiveListResponseItem, ILinkedInteractive, ILinkedInteractiveStateResponse, INavigationOptions, IPortalClaims, IRemoveLinkedInteractiveStateListenerRequest, IReportInitInteractive, IReportItemAnswer, IReportItemClientMessage, IReportItemInitInteractive, IReportItemServerMessage, IRuntimeClientMessage, IRuntimeCustomReportValues, IRuntimeImageQuestionMetadata, IRuntimeInitInteractive, IRuntimeInteractiveMetadata, IRuntimeMetadata, IRuntimeMetadataBase, IRuntimeMultipleChoiceMetadata, IRuntimeOpenResponseMetadata, IRuntimeServerMessage, ISetLinkedInteractives, IShowAlert, IShowDialog, IShowLightbox, IShowModal, ISupportedFeatures, ISupportedFeaturesRequest, ITextDecorationHandler, ITextDecorationHandlerInfo, ITextDecorationInfo, IThemeInfo, IWriteAttachmentRequest, IframePhoneServerMessage, InitInteractiveMode, InteractiveItemId, LoggerClientMessage, ModalType, ReadAttachmentParams, ServerMessage, WriteAttachmentParams, addAuthoredStateListener, addCustomMessageListener, addDecorateContentListener, addGetReportItemAnswerListener, addGlobalInteractiveStateListener, addInteractiveStateListener, addLinkedInteractiveStateListener, closeModal, flushStateUpdates, getAttachmentUrl, getAuthInfo, getAuthoredState, getClient, getFirebaseJwt, getGlobalInteractiveState, getInitInteractiveMessage, getInteractiveList, getInteractiveSnapshot, getInteractiveState, getLibraryInteractiveList, getMode, inIframe, log, postDecoratedContentEvent, readAttachment, removeAuthoredStateListener, removeCustomMessageListener, removeDecorateContentListener, removeGetReportItemAnswerListener, removeGlobalInteractiveStateListener, removeInteractiveStateListener, removeLinkedInteractiveStateListener, sendReportItemAnswer, setAuthoredState, setGlobalInteractiveState, setHeight, setHint, setInteractiveState, setInteractiveStateTimeout, setLinkedInteractives, setNavigation, setSupportedFeatures, showModal, useAuthoredState, useAutoSetHeight, useCustomMessages, useDecorateContent, useGlobalInteractiveState, useInitMessage, useInteractiveState, writeAttachment };
+export { AttachmentInfoMap, ChoiceId, Client, ClientMessage, DeprecatedRuntimeClientMessage, DeprecatedRuntimeServerMessage, GetAttachmentUrlParams, GlobalIFrameSaverClientMessage, GlobalIFrameSaverServerMessage, IAddLinkedInteractiveStateListenerOptions, IAddLinkedInteractiveStateListenerRequest, IAttachmentInfo, IAttachmentUrlRequest, IAttachmentUrlResponse, IAuthInfo, IAuthoringClientMessage, IAuthoringCustomReportField, IAuthoringCustomReportFields, IAuthoringImageQuestionMetadata, IAuthoringInitInteractive, IAuthoringInteractiveMetadata, IAuthoringMetadata, IAuthoringMetadataBase, IAuthoringMultipleChoiceChoiceMetadata, IAuthoringMultipleChoiceMetadata, IAuthoringOpenResponseMetadata, IAuthoringServerMessage, IBaseShowModal, ICloseModal, IContextMember, IContextMembership, ICustomMessage, ICustomMessageHandler, ICustomMessageOptions, ICustomMessagesHandledMap, ICustomReportFieldsAuthoredState, ICustomReportFieldsAuthoredStateField, ICustomReportFieldsInteractiveState, IDataset, IDecoratedContentEvent, IGetAuthInfoRequest, IGetAuthInfoResponse, IGetFirebaseJwtRequest, IGetFirebaseJwtResponse, IGetInteractiveListOptions, IGetInteractiveListRequest, IGetInteractiveListResponse, IGetInteractiveSnapshotOptions, IGetInteractiveSnapshotRequest, IGetInteractiveSnapshotResponse, IGetInteractiveState, IGetLibraryInteractiveListOptions, IGetLibraryInteractiveListRequest, IGetLibraryInteractiveListResponse, IGetReportItemAnswer, IGetReportItemAnswerHandler, IHintRequest, IHostFeatureSupport, IHostFeatures, IHostModalSupport, IInitInteractive, IInteractiveListResponseItem, IInteractiveStateProps, IInteractiveStateWithDataset, IJwtClaims, IJwtResponse, ILibraryInteractiveListResponseItem, ILinkedInteractive, ILinkedInteractiveStateResponse, INavigationOptions, IPortalClaims, IRemoveLinkedInteractiveStateListenerRequest, IReportInitInteractive, IReportItemAnswer, IReportItemAnswerItem, IReportItemAnswerItemAnswerText, IReportItemAnswerItemAttachment, IReportItemAnswerItemHtml, IReportItemAnswerItemLinks, IReportItemClientMessage, IReportItemInitInteractive, IReportItemServerMessage, IRuntimeClientMessage, IRuntimeCustomReportValues, IRuntimeImageQuestionMetadata, IRuntimeInitInteractive, IRuntimeInteractiveMetadata, IRuntimeMetadata, IRuntimeMetadataBase, IRuntimeMultipleChoiceMetadata, IRuntimeOpenResponseMetadata, IRuntimeServerMessage, ISetLinkedInteractives, IShowAlert, IShowDialog, IShowLightbox, IShowModal, ISupportedFeatures, ISupportedFeaturesRequest, ITextDecorationHandler, ITextDecorationHandlerInfo, ITextDecorationInfo, IThemeInfo, IWriteAttachmentRequest, IframePhoneServerMessage, InitInteractiveMode, InteractiveItemId, LoggerClientMessage, ModalType, OnUnloadFunction, ReadAttachmentParams, ServerMessage, WriteAttachmentParams, addAuthoredStateListener, addCustomMessageListener, addDecorateContentListener, addGetReportItemAnswerListener, addGlobalInteractiveStateListener, addInteractiveStateListener, addLinkedInteractiveStateListener, closeModal, flushStateUpdates, getAttachmentUrl, getAuthInfo, getAuthoredState, getClient, getFirebaseJwt, getGlobalInteractiveState, getInitInteractiveMessage, getInteractiveList, getInteractiveSnapshot, getInteractiveState, getLibraryInteractiveList, getMode, inIframe, log, postDecoratedContentEvent, readAttachment, removeAuthoredStateListener, removeCustomMessageListener, removeDecorateContentListener, removeGetReportItemAnswerListener, removeGlobalInteractiveStateListener, removeInteractiveStateListener, removeLinkedInteractiveStateListener, sendReportItemAnswer, setAuthoredState, setGlobalInteractiveState, setHeight, setHint, setInteractiveState, setInteractiveStateTimeout, setLinkedInteractives, setNavigation, setOnUnload, setSupportedFeatures, showModal, useAuthoredState, useAutoSetHeight, useCustomMessages, useDecorateContent, useGlobalInteractiveState, useInitMessage, useInteractiveState, writeAttachment };

package/index.js

@@ -4099,7 +4099,7 @@ var __rest = (this && this.__rest) || function (s, e) {
     return t;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.sendReportItemAnswer = exports.getAttachmentUrl = exports.readAttachment = exports.writeAttachment = exports.getLibraryInteractiveList = exports.getInteractiveSnapshot = exports.setLinkedInteractives = exports.getInteractiveList = exports.closeModal = exports.showModal = exports.removeLinkedInteractiveStateListener = exports.addLinkedInteractiveStateListener = exports.removeGlobalInteractiveStateListener = exports.addGlobalInteractiveStateListener = exports.removeAuthoredStateListener = exports.addAuthoredStateListener = exports.removeInteractiveStateListener = exports.addInteractiveStateListener = exports.log = exports.getFirebaseJwt = exports.getAuthInfo = exports.setNavigation = exports.setHint = exports.postDecoratedContentEvent = exports.setHeight = exports.setSupportedFeatures = exports.removeGetReportItemAnswerListener = exports.addGetReportItemAnswerListener = exports.removeDecorateContentListener = exports.addDecorateContentListener = exports.removeCustomMessageListener = exports.addCustomMessageListener = exports.setGlobalInteractiveState = exports.getGlobalInteractiveState = exports.setAuthoredState = exports.getAuthoredState = exports.flushStateUpdates = exports.setInteractiveState = exports.setInteractiveStateTimeout = exports.getInteractiveState = exports.getMode = exports.getInitInteractiveMessage = void 0;
+exports.setOnUnload = exports.sendReportItemAnswer = exports.getAttachmentUrl = exports.readAttachment = exports.writeAttachment = exports.getLibraryInteractiveList = exports.getInteractiveSnapshot = exports.setLinkedInteractives = exports.getInteractiveList = exports.closeModal = exports.showModal = exports.removeLinkedInteractiveStateListener = exports.addLinkedInteractiveStateListener = exports.removeGlobalInteractiveStateListener = exports.addGlobalInteractiveStateListener = exports.removeAuthoredStateListener = exports.addAuthoredStateListener = exports.removeInteractiveStateListener = exports.addInteractiveStateListener = exports.log = exports.getFirebaseJwt = exports.getAuthInfo = exports.setNavigation = exports.setHint = exports.postDecoratedContentEvent = exports.setHeight = exports.setSupportedFeatures = exports.removeGetReportItemAnswerListener = exports.addGetReportItemAnswerListener = exports.removeDecorateContentListener = exports.addDecorateContentListener = exports.removeCustomMessageListener = exports.addCustomMessageListener = exports.setGlobalInteractiveState = exports.getGlobalInteractiveState = exports.setAuthoredState = exports.getAuthoredState = exports.flushStateUpdates = exports.setInteractiveState = exports.setInteractiveStateTimeout = exports.getInteractiveState = exports.getMode = exports.getInitInteractiveMessage = void 0;
 var client_1 = __webpack_require__(/*! ./client */ "./src/interactive-api-client/client.ts");
 var uuid_1 = __webpack_require__(/*! uuid */ "./node_modules/uuid/dist/esm-browser/index.js");
 var THROW_NOT_IMPLEMENTED_YET = function (method) {
@@ -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)();
@@ -4563,6 +4569,10 @@ var sendReportItemAnswer = function (request) {
     (0, client_1.getClient)().post("reportItemAnswer", request);
 };
 exports.sendReportItemAnswer = sendReportItemAnswer;
+var setOnUnload = function (onUnload) {
+    (0, client_1.getClient)().setOnUnload(onUnload);
+};
+exports.setOnUnload = setOnUnload;
 
 
 /***/ }),
@@ -4587,6 +4597,42 @@ var __assign = (this && this.__assign) || function () {
     };
     return __assign.apply(this, arguments);
 };
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
 var __rest = (this && this.__rest) || function (s, e) {
     var t = {};
     for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
@@ -4635,6 +4681,7 @@ var Client = /** @class */ (function () {
         this.managedState = new managed_state_1.ManagedState();
         this.listeners = {};
         this.requestId = 1;
+        this.onUnload = undefined;
         this.setSupportedFeatures = function (request) {
             var newRequest = request;
             if (_this.customMessagesHandled) {
@@ -4644,6 +4691,9 @@ var Client = /** @class */ (function () {
             }
             _this.post("supportedFeatures", newRequest);
         };
+        this.setOnUnload = function (onUnload) {
+            _this.onUnload = onUnload;
+        };
         if (!(0, in_frame_1.inIframe)()) {
             // tslint:disable-next-line:no-console
             console.warn("Interactive API is meant to be used in iframe");
@@ -4784,10 +4834,26 @@ var Client = /** @class */ (function () {
                 _this.managedState.globalInteractiveState = parseJSONIfString(newInitMessage.globalInteractiveState);
             }
         });
-        this.addListener("getInteractiveState", function () {
-            _this.post("interactiveState", _this.managedState.interactiveState);
-            _this.managedState.interactiveStateDirty = false;
-        });
+        this.addListener("getInteractiveState", function (options) { return __awaiter(_this, void 0, void 0, function () {
+            var finalState;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        if (!((options === null || options === void 0 ? void 0 : options.unloading) && this.onUnload)) return [3 /*break*/, 2];
+                        return [4 /*yield*/, this.onUnload(options)];
+                    case 1:
+                        finalState = _a.sent();
+                        if (finalState) {
+                            this.managedState.interactiveState = finalState;
+                        }
+                        _a.label = 2;
+                    case 2:
+                        this.post("interactiveState", this.managedState.interactiveState);
+                        this.managedState.interactiveStateDirty = false;
+                        return [2 /*return*/];
+                }
+            });
+        }); });
         this.addListener("loadInteractiveGlobal", function (globalState) {
             _this.managedState.globalInteractiveState = parseJSONIfString(globalState);
         });

package/package.json

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