@vived/app 4.30.0 → 4.32.0

package/lib/Components/Tools/Entities/ToolRepository.d.ts

@@ -2,17 +2,18 @@ import { AppObject } from "../../../AppObject/AppObject";
 import { AppObjectEntity } from "../../../AppObject/AppObjectEntity";
 import { AppObjectRepo } from "../../../AppObject/AppObjectRepo";
 import { HotKey, ToolData, ToolEntity } from "./ToolEntity";
-export declare abstract class ToolRepository<ToolTypes> extends AppObjectEntity {
+export declare abstract class ToolRepository extends AppObjectEntity {
     static readonly type = "TOOL_REPOSITORY";
-    abstract get activeTool(): ToolEntity<ToolTypes> | undefined;
-    abstract get allTools(): ToolEntity<ToolTypes>[];
-    abstract setupToolsFromData(toolData: ToolData<ToolTypes>[]): void;
-    abstract getTool(toolType: ToolTypes): ToolEntity<ToolTypes> | undefined;
-    abstract getToolForHotkey(hotkey: HotKey): ToolEntity<ToolTypes> | undefined;
+    abstract get activeTool(): ToolEntity | undefined;
+    abstract get allTools(): ToolEntity[];
+    abstract setupToolsFromData(toolData: ToolData[]): void;
+    abstract getTool(toolType: string): ToolEntity | undefined;
+    abstract getToolForHotkey(hotkey: HotKey): ToolEntity | undefined;
     abstract setDefaultToolActive(): void;
-    abstract triggerTool(toolType: ToolTypes): void;
-    abstract toggleToolVisibility(toolType: ToolTypes): void;
-    abstract toolFactory: (toolData: ToolData<ToolTypes>) => ToolEntity<ToolTypes>;
-    static get: <ToolTypes_1>(appObjects: AppObjectRepo) => ToolRepository<ToolTypes_1> | undefined;
+    abstract triggerTool(toolType: string): void;
+    abstract toggleToolVisibility(toolType: string): void;
+    abstract toolFactory: (id: string) => ToolEntity;
+    abstract makeTool(id: string): ToolEntity;
+    static get: (appObjects: AppObjectRepo) => ToolRepository | undefined;
 }
-export declare function makeToolRepo<ToolTypes>(appObject: AppObject): ToolRepository<ToolTypes>;
+export declare function makeToolRepo(appObject: AppObject): ToolRepository;

package/lib/Components/Tools/Entities/ToolRepository.js

@@ -17,10 +17,9 @@ class ToolRepositoryImp extends ToolRepository {
     constructor(appObject) {
         super(appObject, ToolRepository.type);
         this.toolLookup = new Map();
-        this.toolFactory = (toolData) => {
-            const ao = this.appObjects.getOrCreate(toolData.toolType);
+        this.toolFactory = (id) => {
+            const ao = this.appObjects.getOrCreate(id + "_tool");
             const toolEntity = ToolEntity_1.makeToolEntity(ao);
-            toolEntity.setupFromData(toolData);
             return toolEntity;
         };
     }
@@ -35,29 +34,6 @@ class ToolRepositoryImp extends ToolRepository {
             this.warn(`No default tools has been specified`);
         }
     }
-    setupToolsFromData(toolDatas) {
-        toolDatas.forEach((toolData) => {
-            const toolType = toolData.toolType;
-            if (this.toolLookup.has(toolType)) {
-                this.warn(`A tool with the ID ${toolData.toolType} already exists. Replacing`);
-            }
-            const tool = this.toolFactory(toolData);
-            this.toolLookup.set(toolType, tool);
-            if (toolData.isDefault) {
-                if (this._defaultToolType) {
-                    this.warn(`More than one tools is marked as default. Replacing`);
-                }
-                this._defaultToolType = toolType;
-            }
-        });
-        if (!this._defaultToolType) {
-            this.warn(`No default tools was specified. Defaulting to the first tool in the list`);
-            this._defaultToolType = Array.from(this.toolLookup.keys())[0];
-        }
-        if (this._defaultToolType) {
-            this.triggerTool(this._defaultToolType);
-        }
-    }
     getTool(type) {
         return this.toolLookup.get(type);
     }
@@ -124,4 +100,32 @@ class ToolRepositoryImp extends ToolRepository {
             tool.state = ToolEntity_1.ToolState.HIDDEN;
         }
     }
+    makeTool(id) {
+        const tool = this.toolFactory(id);
+        if (this.toolLookup.has(id)) {
+            this.warn(`A tool with the ID ${id} already exists. Replacing`);
+        }
+        this.toolLookup.set(id, tool);
+        return tool;
+    }
+    setupToolsFromData(toolDatas) {
+        toolDatas.forEach((toolData) => {
+            const toolType = toolData.toolType;
+            const tool = this.makeTool(toolType);
+            tool.setupFromData(toolData);
+            if (toolData.isDefault) {
+                if (this._defaultToolType) {
+                    this.warn(`More than one tools is marked as default. Replacing`);
+                }
+                this._defaultToolType = toolType;
+            }
+        });
+        if (!this._defaultToolType) {
+            this.warn(`No default tools was specified. Defaulting to the first tool in the list`);
+            this._defaultToolType = Array.from(this.toolLookup.keys())[0];
+        }
+        if (this._defaultToolType) {
+            this.triggerTool(this._defaultToolType);
+        }
+    }
 }

package/lib/Components/Tools/Factories/index.d.ts

@@ -0,0 +1 @@
+export * from "./setupTools";

package/lib/Components/Tools/Factories/index.js

@@ -0,0 +1,13 @@
+"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("./setupTools"), exports);

package/lib/Components/Tools/Factories/setupTools.d.ts

@@ -0,0 +1,3 @@
+import { AppObject, AppObjectRepo } from "../../../AppObject";
+import { ToolData } from "../Entities";
+export declare function setupTools(appObjects: AppObjectRepo, toolData: ToolData[]): AppObject;

package/lib/Components/Tools/Factories/setupTools.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setupTools = void 0;
+const Controller_1 = require("../Controller");
+const Entities_1 = require("../Entities");
+const toolFactory_1 = require("./toolFactory");
+function setupTools(appObjects, toolData) {
+    const ao = appObjects.getOrCreate("ToolRepo");
+    const toolRepo = Entities_1.makeToolRepo(ao);
+    toolRepo.toolFactory = toolFactory_1.makeToolFactory(appObjects);
+    toolRepo.setupToolsFromData(toolData);
+    new Controller_1.ToolHotkeys(ao);
+    return ao;
+}
+exports.setupTools = setupTools;

package/lib/Components/Tools/Factories/toolFactory.d.ts

@@ -0,0 +1,3 @@
+import { AppObjectRepo } from "../../../AppObject";
+import { ToolEntity } from "../Entities";
+export declare function makeToolFactory(appObjects: AppObjectRepo): (id: string) => ToolEntity;

package/lib/Components/Tools/Factories/toolFactory.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.makeToolFactory = void 0;
+const Entities_1 = require("../Entities");
+const PM_1 = require("../PM");
+function makeToolFactory(appObjects) {
+    return function toolFactory(id) {
+        const ao = appObjects.getOrCreate(id);
+        const toolEntity = Entities_1.makeToolEntity(ao);
+        PM_1.makeToolPM(ao);
+        return toolEntity;
+    };
+}
+exports.makeToolFactory = makeToolFactory;

package/lib/Components/Tools/Mocks/MockToolRepo.d.ts

@@ -0,0 +1,17 @@
+/// <reference types="jest" />
+import { AppObject, AppObjectRepo } from "../../../AppObject";
+import { ToolEntity, ToolRepository } from "../Entities";
+export declare class MockToolRepo extends ToolRepository {
+    get activeTool(): ToolEntity | undefined;
+    get allTools(): ToolEntity[];
+    setupToolsFromData: jest.Mock<any, any>;
+    getTool: jest.Mock<any, any>;
+    getToolForHotkey: jest.Mock<any, any>;
+    setDefaultToolActive: jest.Mock<any, any>;
+    triggerTool: jest.Mock<any, any>;
+    toggleToolVisibility: jest.Mock<any, any>;
+    toolFactory: jest.Mock<any, any>;
+    makeTool: jest.Mock<any, any>;
+    constructor(appObject: AppObject);
+}
+export declare function makeMockToolRepo(appObjects: AppObjectRepo): MockToolRepo;

package/lib/Components/Tools/Mocks/MockToolRepo.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.makeMockToolRepo = exports.MockToolRepo = void 0;
+const Entities_1 = require("../Entities");
+class MockToolRepo extends Entities_1.ToolRepository {
+    constructor(appObject) {
+        super(appObject, Entities_1.ToolRepository.type);
+        this.setupToolsFromData = jest.fn();
+        this.getTool = jest.fn();
+        this.getToolForHotkey = jest.fn();
+        this.setDefaultToolActive = jest.fn();
+        this.triggerTool = jest.fn();
+        this.toggleToolVisibility = jest.fn();
+        this.toolFactory = jest.fn();
+        this.makeTool = jest.fn();
+    }
+    get activeTool() {
+        return undefined;
+    }
+    get allTools() {
+        return [];
+    }
+}
+exports.MockToolRepo = MockToolRepo;
+function makeMockToolRepo(appObjects) {
+    return new MockToolRepo(appObjects.getOrCreate("MockToolRepo"));
+}
+exports.makeMockToolRepo = makeMockToolRepo;

package/lib/Components/Tools/Mocks/ToolPMMock.d.ts

@@ -1,8 +1,8 @@
 /// <reference types="jest" />
 import { AppObject, AppObjectRepo } from "../../../AppObject";
 import { ToolPM } from "../PM";
-export declare class ToolPMMock<CT> extends ToolPM<CT> {
+export declare class ToolPMMock extends ToolPM {
     vmsAreEqual: jest.Mock<any, any>;
     constructor(appObject: AppObject);
 }
-export declare function makeToolPMMock<CT>(appObjects: AppObjectRepo): ToolPMMock<CT>;
+export declare function makeToolPMMock(appObjects: AppObjectRepo): ToolPMMock;

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

@@ -1 +1,2 @@
 export * from "./ToolPMMock";
+export * from "./MockToolRepo";

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

@@ -11,3 +11,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./ToolPMMock"), exports);
+__exportStar(require("./MockToolRepo"), exports);

package/lib/Components/Tools/PM/ToolPM.d.ts

@@ -1,7 +1,7 @@
 import { AppObjectRepo } from "../../../AppObject";
 import { AppObject } from "../../../AppObject/AppObject";
 import { AppObjectPM } from "../../../AppObject/AppObjectPM";
-export interface ToolVM<ToolType> {
+export interface ToolVM {
     label: string;
     enabled: boolean;
     selected: boolean;
@@ -17,14 +17,14 @@ export declare const defaultToolVM: {
     shortcutLabel: string;
     tooltipLabel: string;
 };
-export declare abstract class ToolPM<ToolType> extends AppObjectPM<ToolVM<ToolType>> {
+export declare abstract class ToolPM extends AppObjectPM<ToolVM> {
     static readonly type = "ToolPM";
-    static get<ToolType>(id: string, appObjects: AppObjectRepo): ToolPM<ToolType> | undefined;
+    static get(id: string, appObjects: AppObjectRepo): ToolPM | undefined;
 }
-export declare function makeToolPM<ToolType>(appObject: AppObject): ToolPMImp<ToolType>;
-declare class ToolPMImp<ToolType> extends ToolPM<ToolType> {
+export declare function makeToolPM(appObject: AppObject): ToolPMImp;
+declare class ToolPMImp extends ToolPM {
     private get tool();
-    vmsAreEqual(a: ToolVM<ToolType>, b: ToolVM<ToolType>): boolean;
+    vmsAreEqual(a: ToolVM, b: ToolVM): boolean;
     onToolChange: () => void;
     constructor(appObject: AppObject);
 }

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

@@ -1,5 +1,6 @@
 export * from "./Adapters";
 export * from "./Controller";
 export * from "./Entities";
+export * from "./Factories";
 export * from "./Mocks";
 export * from "./PM";

package/lib/Components/Tools/index.js

@@ -13,5 +13,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./Adapters"), exports);
 __exportStar(require("./Controller"), exports);
 __exportStar(require("./Entities"), exports);
+__exportStar(require("./Factories"), exports);
 __exportStar(require("./Mocks"), exports);
 __exportStar(require("./PM"), exports);

package/lib/Components/TouchController/Factories/index.d.ts

@@ -0,0 +1 @@
+export * from "./setupTouchInput";

package/lib/Components/TouchController/Factories/index.js

@@ -0,0 +1,13 @@
+"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("./setupTouchInput"), exports);

package/lib/Components/TouchController/Factories/setupTouchInput.d.ts

@@ -0,0 +1,2 @@
+import { AppObjectRepo } from "../../../AppObject";
+export declare function setupTouchInput(appObject: AppObjectRepo): void;

package/lib/Components/TouchController/Factories/setupTouchInput.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setupTouchInput = void 0;
+const Entities_1 = require("../Entities");
+function setupTouchInput(appObject) {
+    const ao = appObject.getOrCreate("TouchInput");
+    Entities_1.makeTouchInput(ao);
+}
+exports.setupTouchInput = setupTouchInput;

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

@@ -1,3 +1,4 @@
 export * from "./Entities";
+export * from "./Factories";
 export * from "./Mock";
 export * from "./UC";

package/lib/Components/TouchController/index.js

@@ -11,5 +11,6 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./Entities"), exports);
+__exportStar(require("./Factories"), exports);
 __exportStar(require("./Mock"), exports);
 __exportStar(require("./UC"), exports);

package/lib/Components/UndoRedo/Factories/index.d.ts

@@ -0,0 +1 @@
+export * from "./setupUndoRedo";

package/lib/Components/UndoRedo/Factories/index.js

@@ -0,0 +1,13 @@
+"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("./setupUndoRedo"), exports);

package/lib/Components/UndoRedo/Factories/setupUndoRedo.d.ts

@@ -0,0 +1,2 @@
+import { AppObject, AppObjectRepo } from "../../../AppObject";
+export declare function setupUndoRedo(appObjects: AppObjectRepo): AppObject;

package/lib/Components/UndoRedo/Factories/setupUndoRedo.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setupUndoRedo = void 0;
+const Entities_1 = require("../Entities");
+const PM_1 = require("../PM");
+const UCs_1 = require("../UCs");
+function setupUndoRedo(appObjects) {
+    const ao = appObjects.getOrCreate("UndoRedo");
+    // Entity
+    const undoRedo = Entities_1.makeUndoRedoEntity(ao);
+    // UCs
+    new UCs_1.UndoRedoToolStatesHook(ao);
+    // PMs
+    PM_1.makeHasUndoPM(ao);
+    PM_1.makeHasRedoPM(ao);
+    return ao;
+}
+exports.setupUndoRedo = setupUndoRedo;

package/lib/Components/UndoRedo/UCs/UndoRedoButtonStatesHook.d.ts

@@ -0,0 +1,11 @@
+import { AppObject, AppObjectUC } from "../../../AppObject";
+export declare class UndoRedoToolStatesHook extends AppObjectUC {
+    static type: string;
+    private get baseApp();
+    private get undoRedo();
+    private get toolRepo();
+    private undoTool?;
+    private redoTool?;
+    onUndoRedoChange: () => void;
+    constructor(appObject: AppObject);
+}

package/lib/Components/UndoRedo/UCs/UndoRedoButtonStatesHook.js

@@ -0,0 +1,55 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UndoRedoToolStatesHook = void 0;
+const AppObject_1 = require("../../../AppObject");
+const BaseAppState_1 = require("../../BaseApp/Entity/BaseAppState");
+const Entities_1 = require("../../Tools/Entities");
+const Entities_2 = require("../Entities");
+class UndoRedoToolStatesHook extends AppObject_1.AppObjectUC {
+    constructor(appObject) {
+        var _a, _b, _c, _d;
+        super(appObject, UndoRedoToolStatesHook.type);
+        this.onUndoRedoChange = () => {
+            if (!this.baseApp)
+                return;
+            if (!this.undoRedo)
+                return;
+            if (this.redoTool) {
+                if (this.baseApp.isAuthoring) {
+                    this.redoTool.state = this.undoRedo.hasRedo
+                        ? Entities_1.ToolState.ENABLED
+                        : Entities_1.ToolState.DISABLED;
+                }
+                else {
+                    this.redoTool.state = Entities_1.ToolState.HIDDEN;
+                }
+            }
+            if (this.undoTool) {
+                if (this.baseApp.isAuthoring) {
+                    this.undoTool.state = this.undoRedo.hasUndo
+                        ? Entities_1.ToolState.ENABLED
+                        : Entities_1.ToolState.DISABLED;
+                }
+                else {
+                    this.undoTool.state = Entities_1.ToolState.HIDDEN;
+                }
+            }
+        };
+        this.undoTool = (_a = this.toolRepo) === null || _a === void 0 ? void 0 : _a.getTool("UNDO");
+        this.redoTool = (_b = this.toolRepo) === null || _b === void 0 ? void 0 : _b.getTool("REDO");
+        (_c = this.undoRedo) === null || _c === void 0 ? void 0 : _c.addChangeObserver(this.onUndoRedoChange);
+        (_d = this.baseApp) === null || _d === void 0 ? void 0 : _d.addChangeObserver(this.onUndoRedoChange);
+        this.onUndoRedoChange();
+    }
+    get baseApp() {
+        return this.getCachedSingleton(BaseAppState_1.BaseAppState.type);
+    }
+    get undoRedo() {
+        return this.getCachedSingleton(Entities_2.UndoRedoEntity.type);
+    }
+    get toolRepo() {
+        return this.getCachedSingleton(Entities_1.ToolRepository.type);
+    }
+}
+exports.UndoRedoToolStatesHook = UndoRedoToolStatesHook;
+UndoRedoToolStatesHook.type = "UndoRedoToolStatesHook";

package/lib/Components/UndoRedo/UCs/index.d.ts

@@ -0,0 +1 @@
+export * from "./UndoRedoButtonStatesHook";

package/lib/Components/UndoRedo/UCs/index.js

@@ -0,0 +1,13 @@
+"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("./UndoRedoButtonStatesHook"), exports);

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

@@ -1,4 +1,6 @@
+export * from "./Controllers";
 export * from "./Entities";
+export * from "./Factories";
 export * from "./Mocks";
 export * from "./PM";
-export * from "./Controllers";
+export * from "./UCs";

package/lib/Components/UndoRedo/index.js

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

package/lib/Components/index.d.ts

@@ -12,6 +12,7 @@ export * from "./FramedScreen";
 export * from "./GLBModel";
 export * from "./Hideable";
 export * from "./HoverLabel";
+export * from "./InspectorTab";
 export * from "./KeyboardInput";
 export * from "./Label";
 export * from "./LabelDrop";

package/lib/Components/index.js

@@ -24,6 +24,7 @@ __exportStar(require("./FramedScreen"), exports);
 __exportStar(require("./GLBModel"), exports);
 __exportStar(require("./Hideable"), exports);
 __exportStar(require("./HoverLabel"), exports);
+__exportStar(require("./InspectorTab"), exports);
 __exportStar(require("./KeyboardInput"), exports);
 __exportStar(require("./Label"), exports);
 __exportStar(require("./LabelDrop"), exports);

package/package.json

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