@vived/app 4.19.1 → 4.20.0

package/lib/Components/FeatureFlags/Adapters/featureFlagsAdapter.d.ts

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

package/lib/Components/FeatureFlags/Adapters/featureFlagsAdapter.js

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

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

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

package/lib/Components/FeatureFlags/Adapters/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("./featureFlagsAdapter"), exports);

package/lib/Components/FeatureFlags/Entity/FeatureFlagEntity.d.ts

@@ -0,0 +1,10 @@
+import { AppObject, AppObjectEntity, AppObjectRepo } from "../../../AppObject";
+export declare abstract class FeatureFlagsEntity extends AppObjectEntity {
+    static type: string;
+    abstract addFlag(feature: string): void;
+    abstract removeFlag(feature: string): void;
+    abstract hasFlag(feature: string): boolean;
+    abstract get flags(): string[];
+    static get(appObjects: AppObjectRepo): FeatureFlagsEntity | undefined;
+}
+export declare function makeFeatureFlagsEntity(appObject: AppObject): FeatureFlagsEntity;

package/lib/Components/FeatureFlags/Entity/FeatureFlagEntity.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.makeFeatureFlagsEntity = exports.FeatureFlagsEntity = void 0;
+const AppObject_1 = require("../../../AppObject");
+class FeatureFlagsEntity extends AppObject_1.AppObjectEntity {
+    static get(appObjects) {
+        return AppObject_1.getSingletonComponent(FeatureFlagsEntity.type, appObjects);
+    }
+}
+exports.FeatureFlagsEntity = FeatureFlagsEntity;
+FeatureFlagsEntity.type = "FeatureFlagsEntity";
+function makeFeatureFlagsEntity(appObject) {
+    return new FeatureFlagsEntityImp(appObject);
+}
+exports.makeFeatureFlagsEntity = makeFeatureFlagsEntity;
+class FeatureFlagsEntityImp extends FeatureFlagsEntity {
+    constructor(appObject) {
+        super(appObject, FeatureFlagsEntity.type);
+        this._flags = [];
+        this.appObjects.registerSingleton(this);
+    }
+    get flags() {
+        return [...this._flags];
+    }
+    addFlag(feature) {
+        if (this.hasFlag(feature))
+            return;
+        this._flags.push(feature);
+        this.notifyOnChange();
+    }
+    removeFlag(feature) {
+        if (!this.hasFlag(feature))
+            return;
+        this._flags = this._flags.filter((flag) => flag !== feature);
+        this.notifyOnChange();
+    }
+    hasFlag(feature) {
+        return this._flags.includes(feature);
+    }
+}

package/lib/Components/FeatureFlags/Entity/index.d.ts

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

package/lib/Components/FeatureFlags/Entity/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("./FeatureFlagEntity"), exports);

package/lib/Components/FeatureFlags/Mocks/FeatureFlagsPMMock.d.ts

@@ -0,0 +1,8 @@
+/// <reference types="jest" />
+import { AppObject, AppObjectRepo } from "../../../AppObject";
+import { FeatureFlagsPM } from "../PMs/FeatureFlagsPM";
+export declare class FeatureFlagsPMMock extends FeatureFlagsPM {
+    vmsAreEqual: jest.Mock<any, any>;
+    constructor(appObject: AppObject);
+}
+export declare function makeFeatureFlagsPMMock(appObjects: AppObjectRepo): FeatureFlagsPMMock;

package/lib/Components/FeatureFlags/Mocks/FeatureFlagsPMMock.js

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

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

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

package/lib/Components/FeatureFlags/Mocks/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("./FeatureFlagsPMMock"), exports);

package/lib/Components/FeatureFlags/PMs/FeatureFlagsPM.d.ts

@@ -0,0 +1,6 @@
+import { AppObject, AppObjectPM, AppObjectRepo } from "../../../AppObject";
+export declare abstract class FeatureFlagsPM extends AppObjectPM<string[]> {
+    static type: string;
+    static get(appObjects: AppObjectRepo): FeatureFlagsPM | undefined;
+}
+export declare function makeFeatureFlagsPM(appObject: AppObject): FeatureFlagsPM;

package/lib/Components/FeatureFlags/PMs/FeatureFlagsPM.js

@@ -0,0 +1,45 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.makeFeatureFlagsPM = exports.FeatureFlagsPM = void 0;
+const AppObject_1 = require("../../../AppObject");
+const FeatureFlagEntity_1 = require("../Entity/FeatureFlagEntity");
+class FeatureFlagsPM extends AppObject_1.AppObjectPM {
+    static get(appObjects) {
+        return AppObject_1.getSingletonComponent(FeatureFlagsPM.type, appObjects);
+    }
+}
+exports.FeatureFlagsPM = FeatureFlagsPM;
+FeatureFlagsPM.type = "FeatureFlagsPM";
+function makeFeatureFlagsPM(appObject) {
+    return new FeatureFlagsPMImp(appObject);
+}
+exports.makeFeatureFlagsPM = makeFeatureFlagsPM;
+class FeatureFlagsPMImp extends FeatureFlagsPM {
+    constructor(appObject) {
+        var _a;
+        super(appObject, FeatureFlagsPM.type);
+        this.onEntityChange = () => {
+            if (!this.featureFlagsEntity)
+                return;
+            this.doUpdateView(this.featureFlagsEntity.flags);
+        };
+        this.onEntityChange();
+        (_a = this.featureFlagsEntity) === null || _a === void 0 ? void 0 : _a.addChangeObserver(this.onEntityChange);
+        this.appObjects.registerSingleton(this);
+    }
+    get featureFlagsEntity() {
+        return this.getCachedSingleton(FeatureFlagEntity_1.FeatureFlagsEntity.type);
+    }
+    vmsAreEqual(a, b) {
+        if (a.length !== b.length)
+            return false;
+        let areEqual = true;
+        a.forEach((flagA, i) => {
+            const flagB = b[i];
+            if (flagA !== flagB) {
+                areEqual = false;
+            }
+        });
+        return areEqual;
+    }
+}

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

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

package/lib/Components/FeatureFlags/PMs/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("./FeatureFlagsPM"), exports);

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

@@ -0,0 +1,4 @@
+export * from "./Adapters";
+export * from "./Entity";
+export * from "./Mocks";
+export * from "./PMs";

package/lib/Components/FeatureFlags/index.js

@@ -0,0 +1,16 @@
+"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("./Adapters"), exports);
+__exportStar(require("./Entity"), exports);
+__exportStar(require("./Mocks"), exports);
+__exportStar(require("./PMs"), exports);

package/lib/Components/RequestHandler/UC/EnableFeatureUC.d.ts

@@ -0,0 +1,11 @@
+import { AppObject } from "../../../AppObject/AppObject";
+import { AppObjectUC } from "../../../AppObject/AppObjectUC";
+import { RequestHandler } from "../Entities";
+export declare abstract class EnableFeatureUC extends AppObjectUC implements RequestHandler {
+    static readonly type = "EnableFeatureUC";
+    readonly requestType = "ENABLE_FEATURE";
+    readonly payloadVersion = 1;
+    abstract action: (feature: string) => void;
+    abstract handleRequest: (version: number, payload?: unknown) => void;
+}
+export declare function makeEnableFeatureUC(appObject: AppObject): EnableFeatureUC;

package/lib/Components/RequestHandler/UC/EnableFeatureUC.js

@@ -0,0 +1,53 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.makeEnableFeatureUC = exports.EnableFeatureUC = void 0;
+const AppObjectUC_1 = require("../../../AppObject/AppObjectUC");
+const FeatureFlags_1 = require("../../FeatureFlags");
+const Entities_1 = require("../Entities");
+class EnableFeatureUC extends AppObjectUC_1.AppObjectUC {
+    constructor() {
+        super(...arguments);
+        this.requestType = "ENABLE_FEATURE";
+        this.payloadVersion = 1;
+    }
+}
+exports.EnableFeatureUC = EnableFeatureUC;
+EnableFeatureUC.type = "EnableFeatureUC";
+function makeEnableFeatureUC(appObject) {
+    return new EnableFeatureUCImp(appObject);
+}
+exports.makeEnableFeatureUC = makeEnableFeatureUC;
+class EnableFeatureUCImp extends EnableFeatureUC {
+    constructor(appObject) {
+        super(appObject, EnableFeatureUC.type);
+        this.action = (featureFlag) => {
+            var _a;
+            (_a = this.featureFlagEntity) === null || _a === void 0 ? void 0 : _a.addFlag(featureFlag);
+        };
+        this.handleRequest = (version, payload) => {
+            if (version === this.payloadVersion) {
+                const { featureFlag } = this.castPayload(payload);
+                this.action(featureFlag);
+            }
+            else {
+                throw new Entities_1.UnsupportedRequestVersion(this.requestType, version);
+            }
+        };
+        const handler = appObject.getComponent(Entities_1.AppHandlerEntity.type);
+        if (!handler) {
+            this.warn("DisposeAppBaseUC has been added to an app object that does not have an AppHandlerEntity. Add one first");
+            return;
+        }
+        handler.registerRequestHandler(this);
+    }
+    get featureFlagEntity() {
+        return this.getCachedSingleton(FeatureFlags_1.FeatureFlagsEntity.type);
+    }
+    castPayload(payload) {
+        const castPayload = payload;
+        if (castPayload.featureFlag === undefined) {
+            throw new Entities_1.UnableToParsePayload(this.requestType, 1, JSON.stringify(payload));
+        }
+        return castPayload;
+    }
+}

package/lib/Components/RequestHandler/UC/index.d.ts

@@ -1,4 +1,5 @@
 export * from "./DisposeAppUC";
+export * from "./EnableFeatureUC";
 export * from "./SetAppStateUC";
 export * from "./SetIsAuthoringUC";
 export * from "./SetThemeColorUC";

package/lib/Components/RequestHandler/UC/index.js

@@ -11,6 +11,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./DisposeAppUC"), exports);
+__exportStar(require("./EnableFeatureUC"), exports);
 __exportStar(require("./SetAppStateUC"), exports);
 __exportStar(require("./SetIsAuthoringUC"), exports);
 __exportStar(require("./SetThemeColorUC"), exports);

package/lib/Components/index.d.ts

@@ -5,6 +5,7 @@ export * from "./Challenge";
 export * from "./ChannelModel";
 export * from "./Dispatcher";
 export * from "./Enablement";
+export * from "./FeatureFlags";
 export * from "./FramedScreen";
 export * from "./GLBModel";
 export * from "./Hideable";

package/lib/Components/index.js

@@ -17,6 +17,7 @@ __exportStar(require("./Challenge"), exports);
 __exportStar(require("./ChannelModel"), exports);
 __exportStar(require("./Dispatcher"), exports);
 __exportStar(require("./Enablement"), exports);
+__exportStar(require("./FeatureFlags"), exports);
 __exportStar(require("./FramedScreen"), exports);
 __exportStar(require("./GLBModel"), exports);
 __exportStar(require("./Hideable"), exports);

package/package.json

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