@vived/app 3.2.1 → 3.3.0

package/lib/AppObjectComponents/Dispatcher/Entities/AppDispatcher.d.ts

@@ -0,0 +1,16 @@
+import { AppObject } from "../../../AppObject/AppObject";
+import { AppObjectEntity } from "../../../AppObject/AppObjectEntity";
+import { AppObjectRepo } from "../../../AppObject/AppObjectRepo";
+export declare type Handler = (request: Request) => void;
+export interface Request {
+    type: string;
+    version: number;
+    payload?: unknown;
+}
+export declare abstract class AppDispatcher extends AppObjectEntity {
+    static readonly type = "APP_DISPATCHER";
+    abstract dispatch: (request: Request) => void;
+    abstract formRequestAndDispatch: (type: string, version: number, payload?: object | undefined) => void;
+    static get(appObjects: AppObjectRepo): AppDispatcher | undefined;
+}
+export declare function makeAppDispatcher(appObject: AppObject, hostHandler: Handler): AppDispatcher;

package/lib/AppObjectComponents/Dispatcher/Entities/AppDispatcher.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.makeAppDispatcher = exports.AppDispatcher = void 0;
+const AppObjectEntity_1 = require("../../../AppObject/AppObjectEntity");
+class AppDispatcher extends AppObjectEntity_1.AppObjectEntity {
+    static get(appObjects) {
+        const selectionEntities = appObjects.getAllComponents(AppDispatcher.type);
+        if (selectionEntities.length === 0) {
+            console.warn("Unable to find a App Dispatcher. Add one on Mount");
+            return undefined;
+        }
+        else if (selectionEntities.length > 1) {
+            console.warn("Multiple App Dispatcher have been found. There should only be one. Using the first one");
+        }
+        return selectionEntities[0];
+    }
+}
+exports.AppDispatcher = AppDispatcher;
+AppDispatcher.type = "APP_DISPATCHER";
+function makeAppDispatcher(appObject, hostHandler) {
+    return new AppDispatcherImp(appObject, hostHandler);
+}
+exports.makeAppDispatcher = makeAppDispatcher;
+class AppDispatcherImp extends AppDispatcher {
+    constructor(appObject, hostHandler) {
+        super(appObject, AppDispatcher.type);
+        this.hostHandler = hostHandler;
+        this.dispatch = (request) => {
+            this.hostHandler(request);
+        };
+        this.formRequestAndDispatch = (type, version, payload) => {
+            const request = {
+                type,
+                version,
+                payload
+            };
+            this.hostHandler(request);
+        };
+    }
+}

package/lib/AppObjectComponents/Dispatcher/Factories/makeBasicDispatcher.d.ts

@@ -0,0 +1,4 @@
+import { AppObjectRepo } from "../../../AppObject/AppObjectRepo";
+import { Handler } from "../Entities/AppDispatcher";
+export declare const APP_DISPATCHER_ID = "AppDispatcher";
+export declare function makeBasicDispatcher(appObjects: AppObjectRepo, hostHandler: Handler): void;

package/lib/AppObjectComponents/Dispatcher/Factories/makeBasicDispatcher.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.makeBasicDispatcher = exports.APP_DISPATCHER_ID = void 0;
+const AppDispatcher_1 = require("../Entities/AppDispatcher");
+const DispatchStopZSpaceUC_1 = require("../UC/DispatchStopZSpaceUC");
+exports.APP_DISPATCHER_ID = "AppDispatcher";
+function makeBasicDispatcher(appObjects, hostHandler) {
+    const dispatcherAO = appObjects.getOrCreate(exports.APP_DISPATCHER_ID);
+    AppDispatcher_1.makeAppDispatcher(dispatcherAO, hostHandler);
+    DispatchStopZSpaceUC_1.makeDispatchStopZSpaceUC(dispatcherAO);
+}
+exports.makeBasicDispatcher = makeBasicDispatcher;

package/lib/AppObjectComponents/Dispatcher/UC/DispatchStopZSpaceUC.d.ts

@@ -0,0 +1,10 @@
+import { AppObject } from "../../../AppObject/AppObject";
+import { AppObjectRepo } from "../../../AppObject/AppObjectRepo";
+import { AppObjectUC } from "../../../AppObject/AppObjectUC";
+export declare abstract class DispatchStopZSpaceUC extends AppObjectUC {
+    static readonly type = "DispatchStopZSpaceUC";
+    readonly requestType = "STOP_ZSPACE";
+    abstract doDispatch(): void;
+    static get(appObjects: AppObjectRepo): DispatchStopZSpaceUC | undefined;
+}
+export declare function makeDispatchStopZSpaceUC(appObject: AppObject): DispatchStopZSpaceUC;

package/lib/AppObjectComponents/Dispatcher/UC/DispatchStopZSpaceUC.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.makeDispatchStopZSpaceUC = exports.DispatchStopZSpaceUC = void 0;
+const AppObjectUC_1 = require("../../../AppObject/AppObjectUC");
+const AppDispatcher_1 = require("../Entities/AppDispatcher");
+class DispatchStopZSpaceUC extends AppObjectUC_1.AppObjectUC {
+    constructor() {
+        super(...arguments);
+        this.requestType = "STOP_ZSPACE";
+    }
+    static get(appObjects) {
+        const selectionEntities = appObjects.getAllComponents(DispatchStopZSpaceUC.type);
+        if (selectionEntities.length === 0) {
+            console.warn("Unable to find a DispatchStopZSpaceUC. Add one on Mount");
+            return undefined;
+        }
+        else if (selectionEntities.length > 1) {
+            console.warn("Multiple DispatchStopZSpaceUC have been found. There should only be one. Using the first one");
+        }
+        return selectionEntities[0];
+    }
+}
+exports.DispatchStopZSpaceUC = DispatchStopZSpaceUC;
+DispatchStopZSpaceUC.type = "DispatchStopZSpaceUC";
+function makeDispatchStopZSpaceUC(appObject) {
+    return new DispatchStateChangeUCImp(appObject);
+}
+exports.makeDispatchStopZSpaceUC = makeDispatchStopZSpaceUC;
+class DispatchStateChangeUCImp extends DispatchStopZSpaceUC {
+    constructor(appObject) {
+        super(appObject, DispatchStopZSpaceUC.type);
+        this.requestVersion = 1;
+        this.appDispatcher = appObject.getComponent(AppDispatcher_1.AppDispatcher.type);
+        if (!this.appDispatcher) {
+            console.warn("DispatchStopZSpaceUC has been added to an App Object that does not have a AppDispatcher. Add a dispatcher first");
+            this.dispose();
+        }
+    }
+    doDispatch() {
+        if (!this.appDispatcher)
+            return;
+        this.appDispatcher.formRequestAndDispatch(this.requestType, this.requestVersion);
+    }
+}

package/lib/AppObjectComponents/Dispatcher/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./Entities/AppDispatcher";
+export * from "./Factories/makeBasicDispatcher";
+export * from "./UC/DispatchStopZSpaceUC";

package/lib/AppObjectComponents/Dispatcher/index.js

@@ -0,0 +1,15 @@
+"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("./Entities/AppDispatcher"), exports);
+__exportStar(require("./Factories/makeBasicDispatcher"), exports);
+__exportStar(require("./UC/DispatchStopZSpaceUC"), exports);

package/lib/Entities/AppDispatcher.d.ts

@@ -58,7 +58,6 @@ export declare abstract class AppDispatcher {
     abstract getAssetsForOwner: (ownerID: string) => Promise<AssetMetaDTO[]>;
     abstract isAssetFetched: (data: IsAssetFetchedDTO) => void;
     abstract submitNewActivityAsset: (file: File) => Promise<string>;
-    abstract stopZSpace: () => void;
     abstract showAlert: (data: ShowAlertDTO) => void;
     abstract showConfirm: (data: ShowConfirmDTO) => void;
     abstract showMarkDownEditor: (data: ShowMarkDownEditorDTO) => void;

package/lib/Entities/AppDispatcher.js

@@ -268,9 +268,6 @@ class AppDistpatcherImp extends AppDispatcher {
         this.goToNextState = () => {
             this.formRequestAndDispatch("GO_TO_NEXT_STATE", 1);
         };
-        this.stopZSpace = () => {
-            this.formRequestAndDispatch("STOP_ZSPACE", 1);
-        };
         this.hasNextState = () => {
             return new Promise((resolve, reject) => {
                 const callback = (hasNextState) => {

package/lib/UseCases/Handlers/StartZSpaceBase.d.ts

@@ -1,10 +1,10 @@
 import { AppHandler, RequestHandler } from "../../Entities";
-export declare type StartZSpaceAction = (device: string, session: any) => void;
+export declare type StartZSpaceAction = (device: string, session: any, emulate: boolean) => void;
 export declare class StartZSpaceBase extends RequestHandler {
     readonly requestType = "START_ZSPACE";
-    readonly payloadVersion = 1;
+    readonly payloadVersion = 2;
     action: StartZSpaceAction;
     handleRequest: (version: number, payload: unknown) => void;
-    private castPayloadV1;
+    private castPayloadV2;
     constructor(handler: AppHandler);
 }

package/lib/UseCases/Handlers/StartZSpaceBase.js

@@ -6,14 +6,14 @@ class StartZSpaceBase extends Entities_1.RequestHandler {
     constructor(handler) {
         super();
         this.requestType = "START_ZSPACE";
-        this.payloadVersion = 1;
+        this.payloadVersion = 2;
         this.action = () => {
             throw new Entities_1.ActionNotImplemented(this.requestType);
         };
         this.handleRequest = (version, payload) => {
             if (version === this.payloadVersion) {
-                const { device, session } = this.castPayloadV1(payload);
-                this.action(device, session);
+                const { device, session, emulate } = this.castPayloadV2(payload);
+                this.action(device, session, emulate);
             }
             else {
                 throw new Entities_1.UnsupportedRequestVerion(this.requestType, version);
@@ -21,11 +21,14 @@ class StartZSpaceBase extends Entities_1.RequestHandler {
         };
         handler.registerRequestHandler(this);
     }
-    castPayloadV1(payload) {
+    castPayloadV2(payload) {
         const castPayload = payload;
         if (castPayload.device === undefined || castPayload.session === undefined) {
             throw new Entities_1.UnableToParsePayload(this.requestType, 1, JSON.stringify(payload));
         }
+        if (castPayload.emulate === undefined) {
+            castPayload.emulate = false;
+        }
         return castPayload;
     }
 }

package/package.json

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