@vived/host 3.6.0 → 3.7.0

package/lib/Components/Apps/Mocks/MockAppMounterUC.d.ts

@@ -2,6 +2,7 @@
 import { HostAppObject } from "../../../HostAppObject";
 import { MounterUC } from "../UCs/MounterUC";
 export declare class MockAppMounterUC extends MounterUC {
+    mountLatestVersion: jest.Mock<any, any>;
     unmount: jest.Mock<any, any>;
     loadScriptIntoDocument: jest.Mock<any, any>;
     getAppInterface: jest.Mock<any, any>;

package/lib/Components/Apps/Mocks/MockAppMounterUC.js

@@ -5,6 +5,7 @@ const MounterUC_1 = require("../UCs/MounterUC");
 class MockAppMounterUC extends MounterUC_1.MounterUC {
     constructor(appObject) {
         super(appObject, MounterUC_1.MounterUC.type);
+        this.mountLatestVersion = jest.fn();
         this.unmount = jest.fn();
         this.loadScriptIntoDocument = jest.fn();
         this.getAppInterface = jest.fn();

package/lib/Components/Apps/UCs/MounterUC.d.ts

@@ -4,6 +4,7 @@ import { Version } from "../../../ValueObjects";
 export declare abstract class MounterUC extends HostAppObjectUC {
     static type: string;
     abstract mount(majorVersion: number, minorVersion: number): Promise<void>;
+    abstract mountLatestVersion(): Promise<void>;
     abstract unmount(): void;
     abstract loadScriptIntoDocument(scriptURL: string, appIDWithVersion: string): Promise<void>;
     abstract getAppInterface(version: Version): VIVEDApp_3 | undefined;

package/lib/Components/Dispatcher/Entities/HostDispatchEntity.d.ts

@@ -5,6 +5,7 @@ export declare abstract class HostDispatchEntity extends HostAppObjectEntity {
     abstract appHandlerVersion: number;
     abstract getRequestPayloadVersion(requestType: string): number | undefined;
     abstract registerAppHandler: (appHandler: Handler) => void;
+    abstract clearAppHandler: () => void;
     abstract dispatch: (request: Request) => void;
     abstract formRequestAndDispatch: (type: string, version: number, payload?: object | undefined) => void;
     static get(appObject: HostAppObject): HostDispatchEntity | undefined;

package/lib/Components/Dispatcher/Entities/HostDispatchEntity.js

@@ -34,6 +34,9 @@ class HostDispatchEntityImp extends HostDispatchEntity {
             this.appHandler = appHandler;
             this.getAppHandlerVersion();
         };
+        this.clearAppHandler = () => {
+            this.appHandler = undefined;
+        };
         this.getRequestPayloadVersion = (requestType) => {
             return this.appPayloadVersions.get(requestType);
         };

package/lib/Components/Dispatcher/Mocks/MockHostDispatcher.d.ts

@@ -2,6 +2,7 @@
 import { HostAppObject } from "../../../HostAppObject";
 import { HostDispatchEntity } from "../Entities";
 export declare class MockHostDispatchEntity extends HostDispatchEntity {
+    clearAppHandler: jest.Mock<any, any>;
     appHandlerVersion: number;
     getRequestPayloadVersion: jest.Mock<any, any>;
     registerAppHandler: jest.Mock<any, any>;

package/lib/Components/Dispatcher/Mocks/MockHostDispatcher.js

@@ -5,6 +5,7 @@ const Entities_1 = require("../Entities");
 class MockHostDispatchEntity extends Entities_1.HostDispatchEntity {
     constructor(appObject) {
         super(appObject, Entities_1.HostDispatchEntity.type);
+        this.clearAppHandler = jest.fn();
         this.appHandlerVersion = 1;
         this.getRequestPayloadVersion = jest.fn();
         this.registerAppHandler = jest.fn();

package/lib/Components/VivedAPI/Adapters/apiStageAdapter.d.ts

@@ -0,0 +1,3 @@
+import { SingletonPmAdapter } from "../../../Types";
+import { APIStage } from "../Entities";
+export declare const apiStageAdapter: SingletonPmAdapter<APIStage>;

package/lib/Components/VivedAPI/Adapters/apiStageAdapter.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.apiStageAdapter = void 0;
+const Entities_1 = require("../Entities");
+const ApiStagePM_1 = require("../PMs/ApiStagePM");
+exports.apiStageAdapter = {
+    defaultVM: Entities_1.APIStage.PRODUCTION,
+    subscribe: (appObjects, setVM) => {
+        const pm = ApiStagePM_1.ApiStagePM.get(appObjects);
+        if (!pm) {
+            appObjects.submitError("apiStageAdapter", "Unable to find ApiStagePM");
+            return;
+        }
+        pm.addView(setVM);
+    },
+    unsubscribe: (appObjects, setVM) => {
+        const pm = ApiStagePM_1.ApiStagePM.get(appObjects);
+        if (!pm) {
+            appObjects.submitError("apiStageAdapter", "Unable to find ApiStagePM");
+            return;
+        }
+        pm.removeView(setVM);
+    }
+};

package/lib/Components/VivedAPI/Adapters/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./apiStageAdapter";
+export * from "./userTokenAdapter";

package/lib/Components/VivedAPI/Adapters/index.js

@@ -0,0 +1,14 @@
+"use strict";
+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("./apiStageAdapter"), exports);
+__exportStar(require("./userTokenAdapter"), exports);

package/lib/Components/VivedAPI/Adapters/userTokenAdapter.d.ts

@@ -0,0 +1,2 @@
+import { SingletonPmAdapter } from "../../../Types";
+export declare const userTokenAdapter: SingletonPmAdapter<string>;

package/lib/Components/VivedAPI/Adapters/userTokenAdapter.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.userTokenAdapter = void 0;
+const UserTokenPM_1 = require("../PMs/UserTokenPM");
+exports.userTokenAdapter = {
+    defaultVM: "",
+    subscribe: (appObjects, setVM) => {
+        const pm = UserTokenPM_1.UserTokenPM.get(appObjects);
+        if (!pm) {
+            appObjects.submitError("userTokenAdapter", "Unable to find UserTokenPM");
+            return;
+        }
+        pm.addView(setVM);
+    },
+    unsubscribe: (appObjects, setVM) => {
+        const pm = UserTokenPM_1.UserTokenPM.get(appObjects);
+        if (!pm) {
+            appObjects.submitError("userTokenAdapter", "Unable to find UserTokenPM");
+            return;
+        }
+        pm.removeView(setVM);
+    }
+};

package/lib/Components/VivedAPI/Controllers/index.d.ts

@@ -1,3 +1,4 @@
-export * from './loginUser';
-export * from './logoutUser';
-export * from './refreshAuthenticatedUser';
+export * from "./loginUser";
+export * from "./logoutUser";
+export * from "./refreshAuthenticatedUser";
+export * from "./setApiStage";

package/lib/Components/VivedAPI/Controllers/index.js

@@ -13,3 +13,4 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./loginUser"), exports);
 __exportStar(require("./logoutUser"), exports);
 __exportStar(require("./refreshAuthenticatedUser"), exports);
+__exportStar(require("./setApiStage"), exports);

package/lib/Components/VivedAPI/Controllers/setApiStage.d.ts

@@ -0,0 +1,3 @@
+import { HostAppObjectRepo } from "../../../HostAppObject";
+import { APIStage } from "../Entities";
+export declare function setApiStage(stage: APIStage, appObjects: HostAppObjectRepo): void;

package/lib/Components/VivedAPI/Controllers/setApiStage.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setApiStage = void 0;
+const Entities_1 = require("../Entities");
+function setApiStage(stage, appObjects) {
+    const sandbox = Entities_1.VivedAPIEntity.get(appObjects);
+    if (sandbox) {
+        sandbox.apiStage = stage;
+    }
+    else {
+        appObjects.submitWarning("setApiStage", "Unable to find VivedAPIEntity");
+    }
+}
+exports.setApiStage = setApiStage;

package/lib/Components/VivedAPI/Entities/VivedAPIEntity.d.ts

@@ -1,8 +1,21 @@
 import { HostAppObject, HostAppObjectEntity, HostAppObjectRepo } from '../../../HostAppObject';
+export declare enum APIStage {
+    PRODUCTION = "Production",
+    STAGING = "Staging",
+    DEVELOPMENT = "Development",
+    LOCAL = "LOCAL"
+}
 export declare class VivedAPIEntity extends HostAppObjectEntity {
     static type: string;
     static get(appObjects: HostAppObjectRepo): VivedAPIEntity | undefined;
-    baseUrl: string;
+    productionURL: string;
+    stagingURL: string;
+    developmentURL: string;
+    localURL: string;
+    private memoizedApiState;
+    get apiStage(): APIStage;
+    set apiStage(apiState: APIStage);
+    get baseUrl(): string;
     getEndpointURL: (endpoint: string) => URL;
     private memoizedUserToken;
     get userToken(): string;

package/lib/Components/VivedAPI/Entities/VivedAPIEntity.js

@@ -1,12 +1,23 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.VivedAPIEntity = void 0;
+exports.VivedAPIEntity = exports.APIStage = void 0;
 const Entities_1 = require("../../../Entities");
 const HostAppObject_1 = require("../../../HostAppObject");
+var APIStage;
+(function (APIStage) {
+    APIStage["PRODUCTION"] = "Production";
+    APIStage["STAGING"] = "Staging";
+    APIStage["DEVELOPMENT"] = "Development";
+    APIStage["LOCAL"] = "LOCAL";
+})(APIStage = exports.APIStage || (exports.APIStage = {}));
 class VivedAPIEntity extends HostAppObject_1.HostAppObjectEntity {
     constructor(appObject) {
         super(appObject, VivedAPIEntity.type);
-        this.baseUrl = 'https://api.vivedlearning.com';
+        this.productionURL = "https://api.vivedlearning.com";
+        this.stagingURL = "https://api-staging.vivedlearning.com";
+        this.developmentURL = "https://api-test.vivedlearning.com";
+        this.localURL = "http://localhost:3001";
+        this.memoizedApiState = new Entities_1.MemoizedString(APIStage.PRODUCTION, this.notifyOnChange);
         this.getEndpointURL = (endpoint) => {
             return new URL(endpoint, this.baseUrl);
         };
@@ -16,6 +27,24 @@ class VivedAPIEntity extends HostAppObject_1.HostAppObjectEntity {
     static get(appObjects) {
         return HostAppObject_1.getSingletonComponent(VivedAPIEntity.type, appObjects);
     }
+    get apiStage() {
+        return this.memoizedApiState.val;
+    }
+    set apiStage(apiState) {
+        this.memoizedApiState.val = apiState;
+    }
+    get baseUrl() {
+        if (this.memoizedApiState.val === APIStage.PRODUCTION) {
+            return "https://api.vivedlearning.com";
+        }
+        if (this.memoizedApiState.val === APIStage.STAGING) {
+            return "https://api-staging.vivedlearning.com";
+        }
+        if (this.memoizedApiState.val === APIStage.DEVELOPMENT) {
+            return "https://api-test.vivedlearning.com";
+        }
+        return "http://localhost:3001";
+    }
     get userToken() {
         return this.memoizedUserToken.val;
     }

package/lib/Components/VivedAPI/Mocks/ApiStagePMMock.d.ts

@@ -0,0 +1,8 @@
+/// <reference types="jest" />
+import { HostAppObject, HostAppObjectRepo } from "../../../HostAppObject";
+import { ApiStagePM } from "../PMs/ApiStagePM";
+export declare class ApiStagePMMock extends ApiStagePM {
+    vmsAreEqual: jest.Mock<any, any>;
+    constructor(appObject: HostAppObject);
+}
+export declare function makeApiStagePMMock(appObjects: HostAppObjectRepo): ApiStagePMMock;

package/lib/Components/VivedAPI/Mocks/ApiStagePMMock.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.makeApiStagePMMock = exports.ApiStagePMMock = void 0;
+const ApiStagePM_1 = require("../PMs/ApiStagePM");
+class ApiStagePMMock extends ApiStagePM_1.ApiStagePM {
+    constructor(appObject) {
+        super(appObject, ApiStagePM_1.ApiStagePM.type);
+        this.vmsAreEqual = jest.fn();
+    }
+}
+exports.ApiStagePMMock = ApiStagePMMock;
+function makeApiStagePMMock(appObjects) {
+    return new ApiStagePMMock(appObjects.getOrCreate("ApiStagePMMock"));
+}
+exports.makeApiStagePMMock = makeApiStagePMMock;

package/lib/Components/VivedAPI/Mocks/UserTokenPMMock.d.ts

@@ -0,0 +1,8 @@
+/// <reference types="jest" />
+import { HostAppObject, HostAppObjectRepo } from "../../../HostAppObject";
+import { UserTokenPM } from "../PMs/UserTokenPM";
+export declare class UserTokenPMMock extends UserTokenPM {
+    vmsAreEqual: jest.Mock<any, any>;
+    constructor(appObject: HostAppObject);
+}
+export declare function makeUserTokenPMMock(appObjects: HostAppObjectRepo): UserTokenPMMock;

package/lib/Components/VivedAPI/Mocks/UserTokenPMMock.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.makeUserTokenPMMock = exports.UserTokenPMMock = void 0;
+const UserTokenPM_1 = require("../PMs/UserTokenPM");
+class UserTokenPMMock extends UserTokenPM_1.UserTokenPM {
+    constructor(appObject) {
+        super(appObject, UserTokenPM_1.UserTokenPM.type);
+        this.vmsAreEqual = jest.fn();
+    }
+}
+exports.UserTokenPMMock = UserTokenPMMock;
+function makeUserTokenPMMock(appObjects) {
+    return new UserTokenPMMock(appObjects.getOrCreate("UserTokenPMMock"));
+}
+exports.makeUserTokenPMMock = makeUserTokenPMMock;

package/lib/Components/VivedAPI/Mocks/index.d.ts

@@ -1,16 +1,18 @@
-export * from './MockBasicFetchUC';
-export * from './MockBlobRequestUC';
-export * from './MockDeleteAssetOnAPIUC';
-export * from './MockFetchAssetFileFromAPIUC';
-export * from './MockFetchAssetMetaFromAPIUC';
-export * from './MockFileUpload';
-export * from './MockGetAppFromAPIUC';
-export * from './MockGetAssetsForOwnerUC';
-export * from './MockJsonRequestUC';
-export * from './MockPatchAssetFileUC';
-export * from './MockPatchAssetIsArchivedUC';
-export * from './MockPatchAssetMetaUC';
-export * from './MockPatchAssetUC';
-export * from './MockPostNewAssetUC';
-export * from './MockSignedAuthToken';
-export * from './MockUserLoginUC';
+export * from "./ApiStagePMMock";
+export * from "./MockBasicFetchUC";
+export * from "./MockBlobRequestUC";
+export * from "./MockDeleteAssetOnAPIUC";
+export * from "./MockFetchAssetFileFromAPIUC";
+export * from "./MockFetchAssetMetaFromAPIUC";
+export * from "./MockFileUpload";
+export * from "./MockGetAppFromAPIUC";
+export * from "./MockGetAssetsForOwnerUC";
+export * from "./MockJsonRequestUC";
+export * from "./MockPatchAssetFileUC";
+export * from "./MockPatchAssetIsArchivedUC";
+export * from "./MockPatchAssetMetaUC";
+export * from "./MockPatchAssetUC";
+export * from "./MockPostNewAssetUC";
+export * from "./MockSignedAuthToken";
+export * from "./MockUserLoginUC";
+export * from "./UserTokenPMMock";

package/lib/Components/VivedAPI/Mocks/index.js

@@ -10,6 +10,7 @@ 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("./ApiStagePMMock"), exports);
 __exportStar(require("./MockBasicFetchUC"), exports);
 __exportStar(require("./MockBlobRequestUC"), exports);
 __exportStar(require("./MockDeleteAssetOnAPIUC"), exports);
@@ -26,3 +27,4 @@ __exportStar(require("./MockPatchAssetUC"), exports);
 __exportStar(require("./MockPostNewAssetUC"), exports);
 __exportStar(require("./MockSignedAuthToken"), exports);
 __exportStar(require("./MockUserLoginUC"), exports);
+__exportStar(require("./UserTokenPMMock"), exports);

package/lib/Components/VivedAPI/PMs/ApiStagePM.d.ts

@@ -0,0 +1,7 @@
+import { HostAppObject, HostAppObjectPM, HostAppObjectRepo } from "../../../HostAppObject";
+import { APIStage } from "../Entities";
+export declare abstract class ApiStagePM extends HostAppObjectPM<APIStage> {
+    static type: string;
+    static get(appObjects: HostAppObjectRepo): ApiStagePM | undefined;
+}
+export declare function makeApiStagePM(appObject: HostAppObject): ApiStagePM;

package/lib/Components/VivedAPI/PMs/ApiStagePM.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.makeApiStagePM = exports.ApiStagePM = void 0;
+const HostAppObject_1 = require("../../../HostAppObject");
+const Entities_1 = require("../Entities");
+class ApiStagePM extends HostAppObject_1.HostAppObjectPM {
+    static get(appObjects) {
+        return HostAppObject_1.getSingletonComponent(ApiStagePM.type, appObjects);
+    }
+}
+exports.ApiStagePM = ApiStagePM;
+ApiStagePM.type = "ApiStagePM";
+function makeApiStagePM(appObject) {
+    return new ApiStagePMImp(appObject);
+}
+exports.makeApiStagePM = makeApiStagePM;
+class ApiStagePMImp extends ApiStagePM {
+    constructor(appObject) {
+        var _a;
+        super(appObject, ApiStagePM.type);
+        this.onEntityChange = () => {
+            if (!this.api)
+                return;
+            this.doUpdateView(this.api.apiStage);
+        };
+        this.appObjects.registerSingleton(this);
+        (_a = this.api) === null || _a === void 0 ? void 0 : _a.addChangeObserver(this.onEntityChange);
+        this.onEntityChange();
+    }
+    get api() {
+        return this.getCachedSingleton(Entities_1.VivedAPIEntity.type);
+    }
+    vmsAreEqual(a, b) {
+        return a === b;
+    }
+}

package/lib/Components/VivedAPI/PMs/UserTokenPM.d.ts

@@ -1,9 +1,6 @@
-import { HostAppObject, HostAppObjectPM, HostAppObjectRepo } from '../../../HostAppObject';
-export declare class UserTokenPM extends HostAppObjectPM<string> {
+import { HostAppObject, HostAppObjectPM, HostAppObjectRepo } from "../../../HostAppObject";
+export declare abstract class UserTokenPM extends HostAppObjectPM<string> {
     static type: string;
     static get(appObjects: HostAppObjectRepo): UserTokenPM | undefined;
-    private vivedAPI?;
-    vmsAreEqual(a: string, b: string): boolean;
-    private onEntityChange;
-    constructor(appObject: HostAppObject);
 }
+export declare function makeUserTokenPM(appObject: HostAppObject): UserTokenPM;

package/lib/Components/VivedAPI/PMs/UserTokenPM.js

@@ -1,31 +1,36 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.UserTokenPM = void 0;
+exports.makeUserTokenPM = exports.UserTokenPM = void 0;
 const HostAppObject_1 = require("../../../HostAppObject");
 const Entities_1 = require("../Entities");
 class UserTokenPM extends HostAppObject_1.HostAppObjectPM {
+    static get(appObjects) {
+        return HostAppObject_1.getSingletonComponent(UserTokenPM.type, appObjects);
+    }
+}
+exports.UserTokenPM = UserTokenPM;
+UserTokenPM.type = "UserTokenPM";
+function makeUserTokenPM(appObject) {
+    return new UserTokenPMImp(appObject);
+}
+exports.makeUserTokenPM = makeUserTokenPM;
+class UserTokenPMImp extends UserTokenPM {
     constructor(appObject) {
+        var _a;
         super(appObject, UserTokenPM.type);
         this.onEntityChange = () => {
-            if (!this.vivedAPI)
+            if (!this.sandbox)
                 return;
-            this.doUpdateView(this.vivedAPI.userToken);
+            this.doUpdateView(this.sandbox.userToken);
         };
-        this.vivedAPI = appObject.getComponent(Entities_1.VivedAPIEntity.type);
-        if (!this.vivedAPI) {
-            this.error('PM has been added to an App Object that does not have a VivedAPIEntity');
-            return;
-        }
-        this.vivedAPI.addChangeObserver(this.onEntityChange);
-        this.onEntityChange();
         this.appObjects.registerSingleton(this);
+        (_a = this.sandbox) === null || _a === void 0 ? void 0 : _a.addChangeObserver(this.onEntityChange);
+        this.onEntityChange();
     }
-    static get(appObjects) {
-        return HostAppObject_1.getSingletonComponent(UserTokenPM.type, appObjects);
+    get sandbox() {
+        return this.getCachedSingleton(Entities_1.VivedAPIEntity.type);
     }
     vmsAreEqual(a, b) {
         return a === b;
     }
 }
-exports.UserTokenPM = UserTokenPM;
-UserTokenPM.type = 'UserTokenPM';

package/lib/Components/VivedAPI/PMs/index.d.ts

@@ -1 +1,2 @@
+export * from "./ApiStagePM";
 export * from "./UserTokenPM";

package/lib/Components/VivedAPI/PMs/index.js

@@ -10,4 +10,5 @@ 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("./ApiStagePM"), exports);
 __exportStar(require("./UserTokenPM"), exports);

package/lib/Components/VivedAPI/index.d.ts

@@ -1,5 +1,6 @@
-export * from './Controllers';
-export * from './Entities';
-export * from './Mocks';
-export * from './PMs';
-export * from './UCs';
+export * from "./Adapters";
+export * from "./Controllers";
+export * from "./Entities";
+export * from "./Mocks";
+export * from "./PMs";
+export * from "./UCs";

package/lib/Components/VivedAPI/index.js

@@ -10,6 +10,7 @@ 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("./Adapters"), exports);
 __exportStar(require("./Controllers"), exports);
 __exportStar(require("./Entities"), exports);
 __exportStar(require("./Mocks"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vived/host",
-  "version": "3.6.0",
+  "version": "3.7.0",
   "description": "Public Host package for the VIVED Learning App system",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",