@vived/app 3.5.3 → 3.7.0

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

@@ -2,20 +2,24 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.makeBasicDispatcher = exports.APP_DISPATCHER_ID = void 0;
 const AppDispatcher_1 = require("../Entities/AppDispatcher");
+const DispatchStartZSpaceUC_1 = require("../UC/DispatchStartZSpaceUC");
 const DispatchStopZSpaceUC_1 = require("../UC/DispatchStopZSpaceUC");
 const GoToNextStateUC_1 = require("../UC/GoToNextStateUC");
 const GoToPreviousStateUC_1 = require("../UC/GoToPreviousStateUC");
 const HasNextStateUC_1 = require("../UC/HasNextStateUC");
 const HasPreviousStateUC_1 = require("../UC/HasPreviousStateUC");
+const IsZSpaceAvailableUC_1 = require("../UC/IsZSpaceAvailableUC");
 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);
+    DispatchStartZSpaceUC_1.makeDispatchStartZSpaceUC(dispatcherAO);
     GoToPreviousStateUC_1.makeGoToPreviousStateUC(dispatcherAO);
     GoToNextStateUC_1.makeGoToNextStateUC(dispatcherAO);
     HasPreviousStateUC_1.makeHasPreviousStateUC(dispatcherAO);
     HasNextStateUC_1.makeHasNextStateUC(dispatcherAO);
+    IsZSpaceAvailableUC_1.makeIsZSpaceAvailableUC(dispatcherAO);
     return dispatcherAO;
 }
 exports.makeBasicDispatcher = makeBasicDispatcher;

package/lib/AppObjectComponents/Dispatcher/UC/DispatchStartZSpaceUC.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 DispatchStartZSpaceUC extends AppObjectUC {
+    static readonly type = "DispatchStartZSpaceUC";
+    readonly requestType = "START_ZSPACE";
+    abstract doDispatch(): void;
+    static get(appObjects: AppObjectRepo): DispatchStartZSpaceUC | undefined;
+}
+export declare function makeDispatchStartZSpaceUC(appObject: AppObject): DispatchStartZSpaceUC;

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

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.makeDispatchStartZSpaceUC = exports.DispatchStartZSpaceUC = void 0;
+const AppObjectUC_1 = require("../../../AppObject/AppObjectUC");
+const AppDispatcher_1 = require("../Entities/AppDispatcher");
+class DispatchStartZSpaceUC extends AppObjectUC_1.AppObjectUC {
+    constructor() {
+        super(...arguments);
+        this.requestType = "START_ZSPACE";
+    }
+    static get(appObjects) {
+        const selectionEntities = appObjects.getAllComponents(DispatchStartZSpaceUC.type);
+        if (selectionEntities.length === 0) {
+            console.warn("Unable to find a DispatchStartZSpaceUC. Add one on Mount");
+            return undefined;
+        }
+        else if (selectionEntities.length > 1) {
+            console.warn("Multiple DispatchStartZSpaceUC have been found. There should only be one. Using the first one");
+        }
+        return selectionEntities[0];
+    }
+}
+exports.DispatchStartZSpaceUC = DispatchStartZSpaceUC;
+DispatchStartZSpaceUC.type = "DispatchStartZSpaceUC";
+function makeDispatchStartZSpaceUC(appObject) {
+    return new DispatchStateChangeUCImp(appObject);
+}
+exports.makeDispatchStartZSpaceUC = makeDispatchStartZSpaceUC;
+class DispatchStateChangeUCImp extends DispatchStartZSpaceUC {
+    constructor(appObject) {
+        super(appObject, DispatchStartZSpaceUC.type);
+        this.requestVersion = 1;
+        this.appDispatcher = appObject.getComponent(AppDispatcher_1.AppDispatcher.type);
+        if (!this.appDispatcher) {
+            console.warn("DispatchStartZSpaceUC 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/UC/IsZSpaceAvailableUC.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 IsZSpaceAvailableUC extends AppObjectUC {
+    static readonly type = "IsZSpaceAvailableUC";
+    readonly requestType = "IS_ZSPACE_AVAILABLE";
+    abstract doDispatch(): Promise<boolean>;
+    static get(appObjects: AppObjectRepo): IsZSpaceAvailableUC | undefined;
+}
+export declare function makeIsZSpaceAvailableUC(appObject: AppObject): IsZSpaceAvailableUC;

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

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

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

@@ -1,7 +1,9 @@
 export * from "./Entities/AppDispatcher";
 export * from "./Factories/makeBasicDispatcher";
 export * from "./UC/DispatchStopZSpaceUC";
+export * from "./UC/DispatchStartZSpaceUC";
 export * from "./UC/GoToNextStateUC";
 export * from "./UC/GoToPreviousStateUC";
 export * from "./UC/HasNextStateUC";
 export * from "./UC/HasPreviousStateUC";
+export * from "./UC/IsZSpaceAvailableUC";

package/lib/AppObjectComponents/Dispatcher/index.js

@@ -13,7 +13,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./Entities/AppDispatcher"), exports);
 __exportStar(require("./Factories/makeBasicDispatcher"), exports);
 __exportStar(require("./UC/DispatchStopZSpaceUC"), exports);
+__exportStar(require("./UC/DispatchStartZSpaceUC"), exports);
 __exportStar(require("./UC/GoToNextStateUC"), exports);
 __exportStar(require("./UC/GoToPreviousStateUC"), exports);
 __exportStar(require("./UC/HasNextStateUC"), exports);
 __exportStar(require("./UC/HasPreviousStateUC"), exports);
+__exportStar(require("./UC/IsZSpaceAvailableUC"), exports);

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

@@ -1,10 +1,10 @@
 import { AppHandler, RequestHandler } from "../../Entities";
-export declare type StartZSpaceAction = (device: string, session: any, emulate: boolean) => void;
+export declare type StartZSpaceAction = (deviceScaleFactor: number, session: any, emulate: boolean) => void;
 export declare class StartZSpaceBase extends RequestHandler {
     readonly requestType = "START_ZSPACE";
-    readonly payloadVersion = 2;
+    readonly payloadVersion = 3;
     action: StartZSpaceAction;
     handleRequest: (version: number, payload: unknown) => void;
-    private castPayloadV2;
+    private castPayloadV3;
     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 = 2;
+        this.payloadVersion = 3;
         this.action = () => {
             throw new Entities_1.ActionNotImplemented(this.requestType);
         };
         this.handleRequest = (version, payload) => {
             if (version === this.payloadVersion) {
-                const { device, session, emulate } = this.castPayloadV2(payload);
-                this.action(device, session, emulate);
+                const { deviceScaleFactor, session, emulate } = this.castPayloadV3(payload);
+                this.action(deviceScaleFactor, session, emulate);
             }
             else {
                 throw new Entities_1.UnsupportedRequestVerion(this.requestType, version);
@@ -21,9 +21,10 @@ class StartZSpaceBase extends Entities_1.RequestHandler {
         };
         handler.registerRequestHandler(this);
     }
-    castPayloadV2(payload) {
+    castPayloadV3(payload) {
         const castPayload = payload;
-        if (castPayload.device === undefined || castPayload.session === undefined) {
+        if (castPayload.deviceScaleFactor === undefined ||
+            castPayload.session === undefined) {
             throw new Entities_1.UnableToParsePayload(this.requestType, 1, JSON.stringify(payload));
         }
         if (castPayload.emulate === undefined) {

package/package.json

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