@vived/app 4.3.0 → 4.4.0

package/lib/Entities/AppDispatcher.js

@@ -1,336 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.makeAppDispatcher = exports.AppDispatcher = void 0;
-class AppDispatcher {
-}
-exports.AppDispatcher = AppDispatcher;
-function makeAppDispatcher() {
-    return new AppDistpatcherImp();
-}
-exports.makeAppDispatcher = makeAppDispatcher;
-class AppDistpatcherImp extends AppDispatcher {
-    constructor() {
-        super(...arguments);
-        this.registerHostHandler = (hostHandler) => {
-            this.hostHandler = hostHandler;
-        };
-        this.dispatch = (request) => {
-            if (!this.hostHandler) {
-                console.error("[AppDispatcher] No host handler has been registered");
-                return;
-            }
-            this.hostHandler(request);
-        };
-        this.stateHasChanged = (stateObject, assets, validationErrorMessage) => {
-            const payload = {
-                stateObject,
-                assets,
-                validationErrorMessage,
-            };
-            this.formRequestAndDispatch("ON_STATE_CHANGE", 3, payload);
-        };
-        this.stateIsCompleted = () => {
-            this.formRequestAndDispatch("ON_STATE_COMPLETED", 1);
-        };
-        this.getAppAssetsURL = () => {
-            return new Promise((resolve, reject) => {
-                const callback = (url) => {
-                    if (!url) {
-                        reject(new Error("URL to asset folder is empty"));
-                    }
-                    else {
-                        resolve(url);
-                    }
-                };
-                const payload = {
-                    callback,
-                };
-                if (!this.hostHandler) {
-                    reject(new Error("No host handler has been registered"));
-                }
-                else {
-                    this.formRequestAndDispatch("GET_APP_ASSET_URL", 1, payload);
-                }
-            });
-        };
-        this.registerExternalStylesheets = (stylesheets) => {
-            const payload = {
-                stylesheets,
-            };
-            this.formRequestAndDispatch("REGISTER_EXTERNAL_STYLESHEETS", 1, payload);
-        };
-        this.appIsReady = () => {
-            this.formRequestAndDispatch("APP_IS_READY", 1);
-        };
-        this.submitLog = (sender, message) => {
-            const payload = {
-                sender,
-                severity: "LOG",
-                message,
-            };
-            this.formRequestAndDispatch("SUBMIT_LOG", 1, payload);
-        };
-        this.log = (sender, message) => {
-            const payload = {
-                sender,
-                severity: "LOG",
-                message,
-            };
-            this.formRequestAndDispatch("SUBMIT_LOG", 1, payload);
-        };
-        this.logWarnign = (sender, message) => {
-            const payload = {
-                sender,
-                severity: "WARNING",
-                message,
-            };
-            this.formRequestAndDispatch("SUBMIT_LOG", 1, payload);
-        };
-        this.logError = (sender, message) => {
-            const payload = {
-                sender,
-                severity: "ERROR",
-                message,
-            };
-            this.formRequestAndDispatch("SUBMIT_LOG", 1, payload);
-        };
-        this.logFatalError = (sender, message) => {
-            const payload = {
-                sender,
-                severity: "FATAL",
-                message,
-            };
-            this.formRequestAndDispatch("SUBMIT_LOG", 1, payload);
-        };
-        this.submitHitResult = (success, description) => {
-            const payload = {
-                resultType: "HIT_V1",
-                description,
-                result: {
-                    success,
-                },
-            };
-            this.formRequestAndDispatch("SUBMIT_RESULTS", 3, payload);
-        };
-        this.submitProgressResult = (progress, description) => {
-            const payload = {
-                resultType: "PROGRESS_V1",
-                description,
-                result: {
-                    progress,
-                },
-            };
-            this.formRequestAndDispatch("SUBMIT_RESULTS", 3, payload);
-        };
-        this.submitMultiHitResult = (hits, misses, unanswered, description) => {
-            const payload = {
-                resultType: "MULTIHIT_V1",
-                description,
-                result: {
-                    hits,
-                    misses,
-                    unanswered,
-                },
-            };
-            this.formRequestAndDispatch("SUBMIT_RESULTS", 3, payload);
-        };
-        this.submitQualityResult = (stars, maxStars, description) => {
-            const payload = {
-                resultType: "QUALITY_V1",
-                description,
-                result: {
-                    stars,
-                    maxStars,
-                },
-            };
-            this.formRequestAndDispatch("SUBMIT_RESULTS", 3, payload);
-        };
-        this.submitScoreResult = (score, maxScore, description) => {
-            const payload = {
-                resultType: "SCORE_V1",
-                description,
-                result: {
-                    score,
-                    maxScore,
-                },
-            };
-            this.formRequestAndDispatch("SUBMIT_RESULTS", 3, payload);
-        };
-        this.getAssetBlobURL = (assetID) => {
-            return new Promise((resolve, reject) => {
-                const callback = (blobURL) => {
-                    if (blobURL === undefined) {
-                        reject(new Error("Blob URL is undefined"));
-                    }
-                    else {
-                        resolve(blobURL);
-                    }
-                };
-                const payload = {
-                    assetID,
-                    callback,
-                };
-                if (!this.hostHandler) {
-                    reject(new Error("No host handler has been registered"));
-                }
-                else {
-                    this.formRequestAndDispatch("GET_ASSET_BLOB", 1, payload);
-                }
-            });
-        };
-        this.getAssetMeta = (assetID) => {
-            return new Promise((resolve, reject) => {
-                const callback = (assetMeta) => {
-                    if (assetMeta === undefined) {
-                        reject(new Error("Meta is undefined"));
-                    }
-                    else {
-                        resolve(assetMeta);
-                    }
-                };
-                const payload = {
-                    assetID,
-                    callback,
-                };
-                if (!this.hostHandler) {
-                    reject(new Error("No host handler has been registered"));
-                }
-                else {
-                    this.formRequestAndDispatch("GET_ASSET_META", 1, payload);
-                }
-            });
-        };
-        this.getLinkedAssets = (assetID, type) => {
-            return new Promise((resolve, reject) => {
-                const callback = (linkedAssets) => {
-                    if (linkedAssets === undefined) {
-                        reject(new Error("Linked asset list is missing"));
-                    }
-                    else {
-                        resolve(linkedAssets);
-                    }
-                };
-                const payload = {
-                    assetID,
-                    type,
-                    callback,
-                };
-                if (!this.hostHandler) {
-                    reject(new Error("No host handler has been registered"));
-                }
-                else {
-                    this.formRequestAndDispatch("GET_LINKED_ASSETS", 1, payload);
-                }
-            });
-        };
-        this.getAssetsForOwner = (ownerID) => {
-            return new Promise((resolve, reject) => {
-                const callback = (assetMetas) => {
-                    resolve(assetMetas);
-                };
-                const payload = {
-                    ownerID,
-                    callback,
-                };
-                if (!this.hostHandler) {
-                    reject(new Error("No host handler has been registered"));
-                }
-                else {
-                    this.formRequestAndDispatch("GET_ASSET_FOR_OWNER", 1, payload);
-                }
-            });
-        };
-        this.submitNewActivityAsset = (file) => {
-            return new Promise((resolve, reject) => {
-                const callback = (assetID) => {
-                    if (assetID) {
-                        resolve(assetID);
-                    }
-                    else {
-                        reject(new Error("Failed to get asset ID"));
-                    }
-                };
-                const payload = {
-                    file,
-                    callback,
-                };
-                if (!this.hostHandler) {
-                    reject(new Error("No host handler has been registered"));
-                }
-                else {
-                    this.formRequestAndDispatch("NEW_ACTIVITY_ASSET", 1, payload);
-                }
-            });
-        };
-        this.showAlert = (data) => {
-            const payload = {
-                title: data.title,
-                message: data.message,
-                closeButtonLabel: data.closeButtonLabel,
-                closeCallback: data.closeCallback,
-            };
-            this.formRequestAndDispatch("SHOW_ALERT", 1, payload);
-        };
-        this.showConfirm = (data) => {
-            const payload = {
-                title: data.title,
-                message: data.message,
-                confirmCallback: data.confirmCallback,
-                cancelButtonLabel: data.cancelButtonLabel,
-                cancelCallback: data.cancelCallback,
-                confirmButtonLabel: data.confirmButtonLabel,
-            };
-            this.formRequestAndDispatch("SHOW_CONFIRM", 1, payload);
-        };
-        this.showMarkDownEditor = (data) => {
-            var _a;
-            const payload = {
-                initialText: (_a = data.initialText) !== null && _a !== void 0 ? _a : "",
-                submitCallback: data.submitCallback,
-            };
-            if (data.validateString) {
-                payload.validateString = data.validateString;
-            }
-            this.formRequestAndDispatch("SHOW_MARKDOWN_EDITOR", 1, payload);
-        };
-        this.showSelectModel = (callback) => {
-            const payload = {
-                callback,
-            };
-            this.formRequestAndDispatch("SHOW_SELECT_MODEL", 1, payload);
-        };
-        this.isAssetFetched = (data) => {
-            const payload = {
-                assetId: data.assetId,
-                callback: data.callback,
-            };
-            this.formRequestAndDispatch("IS_ASSET_FILE_FETCHED", 1, payload);
-        };
-        this.showSpinner = (data) => {
-            return new Promise((resolve, reject) => {
-                const closeCallback = (closeSpinner) => {
-                    resolve(closeSpinner);
-                };
-                const payload = {
-                    message: data.message,
-                    title: data.title,
-                    closeCallback,
-                };
-                if (!this.hostHandler) {
-                    reject(new Error("No host handler has been registered"));
-                }
-                else {
-                    this.formRequestAndDispatch("SHOW_SPINNER", 1, payload);
-                }
-            });
-        };
-    }
-    formRequestAndDispatch(type, version, payload) {
-        const request = {
-            type,
-            version,
-            payload,
-        };
-        this.dispatch(request);
-    }
-}

package/lib/Entities/AppHandler.d.ts

@@ -1,20 +0,0 @@
-import { Handler } from "./AppBoundary";
-export declare abstract class RequestHandler {
-    abstract readonly requestType: string;
-    abstract payloadVersion: number;
-    abstract handleRequest: (version: number, payload?: unknown) => void;
-}
-export declare abstract class AppHandler {
-    abstract handler: Handler;
-    abstract registerRequestHandler: (requestHandler: RequestHandler) => void;
-}
-export declare function makeAppHandler(): AppHandler;
-export declare class UnsupportedRequestVerion extends Error {
-    constructor(requestType: string, version: number);
-}
-export declare class ActionNotImplemented extends Error {
-    constructor(requestType: string);
-}
-export declare class UnableToParsePayload extends Error {
-    constructor(requestType: string, version: number, payload: string);
-}

package/lib/Entities/AppHandler.js

@@ -1,94 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.UnableToParsePayload = exports.ActionNotImplemented = exports.UnsupportedRequestVerion = exports.makeAppHandler = exports.AppHandler = exports.RequestHandler = void 0;
-class RequestHandler {
-}
-exports.RequestHandler = RequestHandler;
-class AppHandler {
-}
-exports.AppHandler = AppHandler;
-function makeAppHandler() {
-    return new RequestHandlerImp();
-}
-exports.makeAppHandler = makeAppHandler;
-class RequestHandlerImp extends AppHandler {
-    constructor() {
-        super(...arguments);
-        this.handlers = new Map();
-        this.getAppPayloadRequest = "GET_APP_PAYLOAD_VERSION";
-        this.getAppHandlerVersionRequest = "GET_APP_HANDLER_VERSION";
-        this.appHandlerVersion = 1;
-        this.handler = (request) => {
-            if (request.type === this.getAppPayloadRequest) {
-                this.handlePayloadVersionRequest(request);
-                return;
-            }
-            if (request.type === this.getAppHandlerVersionRequest) {
-                this.handleAppHandlerVersionRequest(request);
-                return;
-            }
-            const handler = this.handlers.get(request.type);
-            if (!handler) {
-                console.warn(`[AppHandler] Unsupported request type recieved: ${request.type}`);
-                return;
-            }
-            try {
-                handler.handleRequest(request.version, request.payload);
-            }
-            catch (e) {
-                console.warn(`[AppHandler] ${e}`);
-            }
-        };
-        this.registerRequestHandler = (handler) => {
-            if (this.handlers.has(handler.requestType)) {
-                console.warn(`[AppHandler] More than one handler is being registered for ${handler.requestType}. Previous handler is being overwritten`);
-            }
-            this.handlers.set(handler.requestType, handler);
-        };
-    }
-    handlePayloadVersionRequest(request) {
-        if (request.version !== 2) {
-            throw new UnsupportedRequestVerion(request.type, request.version);
-        }
-        const payload = request.payload;
-        if (payload.callback === undefined) {
-            throw new UnableToParsePayload(request.type, request.version, JSON.stringify(payload));
-        }
-        const versionMap = new Map();
-        this.handlers.forEach((handler) => {
-            versionMap.set(handler.requestType, handler.payloadVersion);
-        });
-        payload.callback(versionMap);
-    }
-    handleAppHandlerVersionRequest(request) {
-        if (request.version !== 1) {
-            throw new UnsupportedRequestVerion(request.type, request.version);
-        }
-        const payload = request.payload;
-        if (payload.callback === undefined) {
-            throw new UnableToParsePayload(request.type, request.version, JSON.stringify(payload));
-        }
-        payload.callback(this.appHandlerVersion);
-    }
-}
-class UnsupportedRequestVerion extends Error {
-    constructor(requestType, version) {
-        const msg = `Version ${version} of request type ${requestType} is not supported`;
-        super(msg);
-    }
-}
-exports.UnsupportedRequestVerion = UnsupportedRequestVerion;
-class ActionNotImplemented extends Error {
-    constructor(requestType) {
-        const msg = `Action for request type ${requestType} is not implemented`;
-        super(msg);
-    }
-}
-exports.ActionNotImplemented = ActionNotImplemented;
-class UnableToParsePayload extends Error {
-    constructor(requestType, version, payload) {
-        const msg = `Unable to parse paylod for version ${version} of request type ${requestType}: ${payload}`;
-        super(msg);
-    }
-}
-exports.UnableToParsePayload = UnableToParsePayload;

package/lib/Entities/Babylon.d.ts

@@ -1,48 +0,0 @@
-import { ParametricLine, Vector2, Vector3 } from "../ValueObjects";
-export declare type OnBabylonChange = () => void;
-export interface ScenePick {
-    mouseRay: ParametricLine;
-    hit: boolean;
-    worldPickPoint?: Vector3;
-    objectPickMeta?: object;
-    normal?: Vector3;
-}
-export interface IScreenshotSize {
-    /**
-     * number in pixels for canvas height
-     */
-    height?: number;
-    /**
-     * multiplier allowing render at a higher or lower resolution
-     * If value is defined then height and width will be ignored and taken from camera
-     */
-    precision?: number;
-    /**
-     * number in pixels for canvas width
-     */
-    width?: number;
-}
-export interface Babylon {
-    engine: unknown;
-    scene: unknown;
-    workingCanvas?: HTMLCanvasElement;
-    showInspector: boolean;
-    renderCanvas?: HTMLCanvasElement;
-    isRendering: boolean;
-    pixelToSceneRay: (pixelPos: Vector2) => ParametricLine;
-    sceneRayPick: (ray: ParametricLine) => ScenePick | undefined;
-    scenePixelPick: (pixelPos: Vector2) => ScenePick | undefined;
-    sceneObjectRayPick: (ray: ParametricLine) => string | undefined;
-    sceneObjectPixelPick: (pixelPos: Vector2) => string | undefined;
-    captureScreenshot: (size: IScreenshotSize | number) => Promise<Blob>;
-    makeSceneObjectMeta: (id: string) => object;
-    updateCanvasSize: () => void;
-    submitRenderCanvas: (canvas: HTMLCanvasElement) => void;
-    clearRenderCanvas: () => void;
-    registerResizeEnging: (resizeEngine: () => void) => void;
-    registerStartRendering: (startRendering: (canvas: HTMLCanvasElement) => void) => void;
-    registerStopRendering: (stopRendering: (canvas: HTMLCanvasElement) => void) => void;
-    addObserver: (observer: OnBabylonChange) => void;
-    removeObserver: (observer: OnBabylonChange) => void;
-}
-export declare function makeBabylon(): Babylon;

package/lib/Entities/Babylon.js

@@ -1,146 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.makeBabylon = void 0;
-const ValueObjects_1 = require("../ValueObjects");
-const MemoizedBoolean_1 = require("./Memoized/MemoizedBoolean");
-const MemoizedVector2_1 = require("./Memoized/MemoizedVector2");
-const ObserverList_1 = require("./ObserverList");
-function makeBabylon() {
-    return new BabylonImp();
-}
-exports.makeBabylon = makeBabylon;
-class BabylonImp {
-    constructor() {
-        this.observers = new ObserverList_1.ObserverList();
-        this.updateCanvasSize = () => {
-            if (!this.workingCanvas)
-                return;
-            if (!this._renderCanvas)
-                return;
-            if (this.workingCanvas.height === this._renderCanvas.height &&
-                this.workingCanvas.width === this._renderCanvas.width) {
-                return;
-            }
-            if (this.resizeEngine) {
-                this.resizeEngine();
-            }
-            this.workingCanvas.height = this._renderCanvas.height;
-            this.workingCanvas.width = this._renderCanvas.width;
-            this.observers.notify();
-        };
-        this.submitRenderCanvas = (canvas) => {
-            if (canvas === this._renderCanvas)
-                return;
-            if (this._renderCanvas && this.stopRendering) {
-                this.stopRendering(this._renderCanvas);
-            }
-            this._renderCanvas = canvas;
-            this.updateCanvasSize();
-            if (this.startRendering) {
-                this.startRendering(canvas);
-            }
-            this.observers.notify();
-        };
-        this.clearRenderCanvas = () => {
-            if (!this._renderCanvas)
-                return;
-            if (this.stopRendering) {
-                this.stopRendering(this._renderCanvas);
-            }
-            this._renderCanvas = undefined;
-            this.observers.notify();
-        };
-        this.registerResizeEnging = (resizeEngine) => {
-            this.resizeEngine = resizeEngine;
-        };
-        this.registerStartRendering = (startRendering) => {
-            this.startRendering = startRendering;
-        };
-        this.registerStopRendering = (stopRendering) => {
-            this.stopRendering = stopRendering;
-        };
-        this.addObserver = (observer) => {
-            this.observers.add(observer);
-        };
-        this.removeObserver = (observer) => {
-            this.observers.remove(observer);
-        };
-        this.makeSceneObjectMeta = (id) => {
-            return { sceneObjectID: id };
-        };
-        this.getSceneObjectIDFromMeta = (meta) => {
-            if (meta === null || meta === void 0 ? void 0 : meta.hasOwnProperty("sceneObjectID")) {
-                return meta.sceneObjectID;
-            }
-            else {
-                return;
-            }
-        };
-        this.memoizedIsRendering = new MemoizedBoolean_1.MemoizedBoolean(false, this.observers.notify);
-        this.sceneRayPick = (ray) => {
-            throw new Error("Scene ray pick has not been injected");
-        };
-        this.captureScreenshot = (size = 512) => {
-            throw new Error("CaptureScreenshot has not been injected");
-        };
-        this.sceneObjectRayPick = (ray) => {
-            try {
-                const pick = this.sceneRayPick(ray);
-                if (pick === undefined)
-                    return;
-                const sceneObjectId = this.getSceneObjectIDFromMeta(pick.objectPickMeta);
-                return sceneObjectId;
-            }
-            catch (e) {
-                console.warn(e);
-                return;
-            }
-        };
-        this.sceneObjectPixelPick = (pixelPos) => {
-            try {
-                const ray = this.pixelToSceneRay(pixelPos);
-                return this.sceneObjectRayPick(ray);
-            }
-            catch (e) {
-                console.warn(e);
-                return;
-            }
-        };
-        this.scenePixelPick = (pixelPos) => {
-            try {
-                const ray = this.pixelToSceneRay(pixelPos);
-                return this.sceneRayPick(ray);
-            }
-            catch (e) {
-                console.warn(e);
-                return;
-            }
-        };
-        this.pixelToSceneRay = (pixelPos) => {
-            throw new Error("Pixel to scene ray has not been injected");
-        };
-        this.memoizedShowInspector = new MemoizedBoolean_1.MemoizedBoolean(false, this.observers.notify);
-        this.memoizedCanvasSize = new MemoizedVector2_1.MemoizedVector2(ValueObjects_1.Vector2.One(), this.observers.notify);
-    }
-    get showInspector() {
-        return this.memoizedShowInspector.val;
-    }
-    set showInspector(val) {
-        this.memoizedShowInspector.val = val;
-    }
-    get renderCanvas() {
-        return this._renderCanvas;
-    }
-    get canvasSize() {
-        return this.memoizedCanvasSize.val;
-    }
-    set canvasSize(val) {
-        this.memoizedCanvasSize.val = val;
-    }
-    get isRendering() {
-        return this.memoizedIsRendering.val;
-    }
-    set isRendering(val) {
-        this.memoizedIsRendering.val = val;
-    }
-}

package/lib/Entities/BaseApp.d.ts

@@ -1,9 +0,0 @@
-import { ObservableEntity } from "./ObservableEntity";
-export declare type OnBaseAppChange = () => void;
-export declare abstract class BaseApp extends ObservableEntity {
-    abstract get isAuthoring(): boolean;
-    abstract set isAuthoring(val: boolean);
-    abstract startRendering: (container: HTMLElement) => void;
-    abstract stopRendering: () => void;
-}
-export declare function makeBaseApp(): BaseApp;

package/lib/Entities/BaseApp.js

@@ -1,30 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.makeBaseApp = exports.BaseApp = void 0;
-const MemoizedBoolean_1 = require("./Memoized/MemoizedBoolean");
-const ObservableEntity_1 = require("./ObservableEntity");
-class BaseApp extends ObservableEntity_1.ObservableEntity {
-}
-exports.BaseApp = BaseApp;
-function makeBaseApp() {
-    return new BaseAppImp();
-}
-exports.makeBaseApp = makeBaseApp;
-class BaseAppImp extends BaseApp {
-    constructor() {
-        super(...arguments);
-        this.startRendering = (container) => {
-            throw new Error("[Base App] Start rendering function has not been injected");
-        };
-        this.stopRendering = () => {
-            throw new Error("[Base App] Stop rendering function has not been injected");
-        };
-        this.memoizedIsAuthoring = new MemoizedBoolean_1.MemoizedBoolean(false, this.notify);
-    }
-    get isAuthoring() {
-        return this.memoizedIsAuthoring.val;
-    }
-    set isAuthoring(val) {
-        this.memoizedIsAuthoring.val = val;
-    }
-}

package/lib/Entities/DevicePreview.d.ts

@@ -1,11 +0,0 @@
-import { Vector2 } from "../ValueObjects";
-export declare type OnDevicePreviewChange = () => void;
-export interface DevicePreview {
-    useDevicePreview: boolean;
-    previewSize: Vector2;
-    setDevicePreview(x: number, y: number): void;
-    clearDevicePreview(): void;
-    addObserver(observer: OnDevicePreviewChange): void;
-    removeObserver(observer: OnDevicePreviewChange): void;
-}
-export declare function makeDevicePreview(): DevicePreview;