npm - @streamlayer/sdk-web-features - Versions diffs - 0.2.22 → 0.7.0 - Mend

@streamlayer/sdk-web-features 0.2.22 → 0.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (7) hide show

package/README.md CHANGED Viewed

@@ -1,6 +1,6 @@
 # core
-This library was generatedwith [Nx](https://nx.dev).
+This library was generated with [Nx](https://nx.dev).
 ## Building
 Run `nx build core` to build the library.

package/lib/index.d.ts ADDED Viewed

@@ -0,0 +1,30 @@
+import { FeatureType } from '@streamlayer/sdk-web-types';
+import { AbstractFeature, FeatureSource, FeatureProps, StreamLayerContext, SingleStore } from '@streamlayer/sdk-web-interfaces';
+import { Highlights, Gamification } from '@streamlayer/feature-gamification';
+export type Features = Feature | Gamification | Highlights;
+export declare const AvailableFeatures: {
+    12: boolean;
+    14: boolean;
+};
+export declare class Feature extends AbstractFeature<undefined> {
+    constructor(overlay: FeatureProps, source: FeatureSource);
+}
+export declare const initFeature: (overlay: FeatureProps, source: FeatureSource, instance: StreamLayerContext) => Feature | Gamification | Highlights;
+export { FeatureSource } from '@streamlayer/sdk-web-interfaces';
+declare module '@streamlayer/sdk-web-interfaces' {
+    interface StreamLayerContext {
+        features: Map<FeatureType, Features>;
+        initFeature: (overlay: FeatureProps, source: FeatureSource) => void;
+        updateFeature: (overlay: FeatureProps, source: FeatureSource) => void;
+        destroyFeature: (overlay: FeatureProps) => void;
+        reinitializeFeatures: () => Promise<void>;
+        activeFeature: SingleStore<FeatureType>;
+    }
+    interface StreamLayerSDK {
+        getFeatures: () => Map<FeatureType, Features>;
+        getFeature: <T extends FeatureType = FeatureType>(featureType: T) => (T extends FeatureType.GAMES ? Gamification : T extends FeatureType.HIGHLIGHTS ? Highlights : Feature) | undefined;
+        getActiveFeature: SingleStore<FeatureType>['getStore'];
+        closeFeature: () => void;
+    }
+}
+export declare const features: (instance: StreamLayerContext, opts: unknown, done: () => void) => void;

package/lib/index.js ADDED Viewed

@@ -0,0 +1,124 @@
+import { FeatureType } from '@streamlayer/sdk-web-types';
+import { AbstractFeature, FeatureSource, SingleStore, createSingleStore, } from '@streamlayer/sdk-web-interfaces';
+import { Highlights, Gamification } from '@streamlayer/feature-gamification';
+export const AvailableFeatures = {
+    [FeatureType.GAMES]: true,
+    [FeatureType.HIGHLIGHTS]: true,
+};
+export class Feature extends AbstractFeature {
+    constructor(overlay, source) {
+        super(overlay, source);
+    }
+}
+export const initFeature = (overlay, source, instance) => {
+    if (overlay.type === FeatureType.GAMES) {
+        return new Gamification(overlay, source, instance);
+    }
+    if (overlay.type === FeatureType.HIGHLIGHTS) {
+        return new Highlights(overlay, source, instance);
+    }
+    return new Feature(overlay, source);
+};
+export { FeatureSource } from '@streamlayer/sdk-web-interfaces';
+export const features = (instance, opts, done) => {
+    instance.features = new Map();
+    instance.activeFeature = new SingleStore(createSingleStore(), 'activeFeature');
+    instance.sdk.getFeatures = () => instance.features;
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+    // @ts-ignore
+    instance.sdk.getFeature = (featureType) => instance.features.get(featureType);
+    instance.sdk.getActiveFeature = () => instance.activeFeature.getStore();
+    instance.sdk.openFeature = (featureType) => {
+        instance.activeFeature.setValue(featureType);
+    };
+    instance.sdk.closeFeature = () => {
+        instance.activeFeature.setValue(undefined);
+    };
+    /**
+     * A distinct object instance is created and initialized for each overlay.
+     */
+    instance.initFeature = (overlay, source = FeatureSource.ORGANIZATION) => {
+        const feature = initFeature(overlay, source, instance);
+        instance.features.set(overlay.type, feature);
+    };
+    instance.updateFeature = (overlay, source) => {
+        instance.features.get(overlay.type)?.update(overlay, source);
+    };
+    instance.destroyFeature = (overlay) => {
+        instance.features.delete(overlay.type);
+    };
+    instance.reinitializeFeatures = async () => {
+        // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+        // @ts-ignore
+        const organizationSettings = await instance.stores.organizationSettings.getValue();
+        instance.features.clear();
+        for (const overlay of organizationSettings?.overlays || []) {
+            instance.initFeature(overlay, FeatureSource.ORGANIZATION);
+        }
+    };
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+    // @ts-ignore
+    instance.stores.providerStreamId.listen((eventId) => {
+        if (!eventId) {
+            void instance.reinitializeFeatures();
+        }
+    });
+    /**
+     * Essentially, features and stores establish subscriptions to other stores
+     * based on their dependencies. In certain cases, specific logic is
+     * directly invoked in response to changes in the store.
+     */
+    instance.storeSubscribe = () => {
+        const processSettings = (source, settings) => {
+            if (!settings?.overlays)
+                return;
+            if (source === FeatureSource.STREAM) {
+                instance.features.clear();
+            }
+            for (const overlay of settings.overlays) {
+                if (overlay.sdkEnable !== true) {
+                    continue;
+                }
+                if (!instance.features.has(overlay.type)) {
+                    instance.initFeature(overlay, source);
+                }
+                else {
+                    instance.updateFeature(overlay, source);
+                }
+            }
+        };
+        const subscribes = {
+            /**
+             * During the initial SDK initialization, it's imperative to initialize features first,
+             * followed by their direct subscriptions to store fields.
+             * This section is currently in development, and it's
+             * essential to implement checks to determine whether a feature
+             * has already been initialized. If it has, events related to
+             * that feature should be skipped. Conversely, if a feature is
+             * missing in the new settings, it should be initialized again.
+             */
+            organizationSettings: (orgSettings) => {
+                if (orgSettings.data) {
+                    try {
+                        processSettings(FeatureSource.ORGANIZATION, orgSettings.data);
+                    }
+                    catch (err) {
+                        console.log(err);
+                    }
+                }
+            },
+            streamSettings: (streamSettings) => {
+                if (streamSettings.data) {
+                    try {
+                        processSettings(FeatureSource.STREAM, streamSettings.data);
+                    }
+                    catch (err) {
+                        console.log(err);
+                    }
+                }
+            },
+        };
+        instance.store.subscribe(subscribes);
+    };
+    done();
+};

package/package.json CHANGED Viewed

@@ -1,20 +1,20 @@
 {
   "name": "@streamlayer/sdk-web-features",
-  "dependencies": {
-    "@streamlayer/sdk-web-interfaces": "*",
-    "@streamlayer/sdk-web-types": "*",
-    "@streamlayer/feature-gamification": "*",
-    "tslib": "^2.6.2"
+  "peerDependencies": {
+    "@streamlayer/sdk-web-interfaces": "^0.16.1",
+    "@streamlayer/sdk-web-types": "^0.1.0",
+    "@streamlayer/feature-gamification": "^0.13.1",
+    "@streamlayer/sdk-web-core": "^0.9.0"
   },
-  "version": "0.2.22",
+  "devDependencies": {
+    "tslib": "*"
+  },
+  "version": "0.7.0",
   "type": "module",
-  "main": "./src/index.js",
-  "module": "./src/index.js",
-  "typings": "./src/index.d.ts",
+  "main": "./lib/index.js",
+  "typings": "./lib/index.d.ts",
   "files": [
-    "src/"
-  ],
-  "devDependencies": {
-    "@swc/helpers": "^0.5.2"
-  }
-}
+    "lib/",
+    "package.json"
+  ]
+}

package/src/index.d.ts DELETED Viewed

@@ -1,20 +0,0 @@
-import { FeatureConfig } from '@streamlayer/sdk-web-types';
-import { AbstractFeature, FeatureSource, FeatureProps, StreamLayerContext } from '@streamlayer/sdk-web-interfaces';
-import { Gamification } from '@streamlayer/feature-gamification';
-export declare class Feature extends AbstractFeature<undefined> {
-}
-export declare const initFeature: (overlay: FeatureProps, source: FeatureSource, instance: StreamLayerContext) => Feature | Gamification;
-export { FeatureSource } from '@streamlayer/sdk-web-interfaces';
-declare module '@streamlayer/sdk-web-interfaces' {
-    interface StreamLayerContext {
-        features: Map<FeatureConfig['name'], Feature | Gamification>;
-        initFeature: (overlay: FeatureProps, source: FeatureSource) => void;
-        updateFeature: (overlay: FeatureProps, source: FeatureSource) => void;
-        destroyFeature: (overlay: FeatureProps) => void;
-        reinitializeFeatures: () => Promise<void>;
-    }
-    interface StreamLayerSDK {
-        getFeatures: () => Map<string, Feature | Gamification>;
-    }
-}
-export declare const features: (instance: StreamLayerContext, opts: unknown, done: () => void) => void;

package/src/index.js DELETED Viewed

@@ -1,47 +0,0 @@
-import { FeatureType } from '@streamlayer/sdk-web-types';
-import { AbstractFeature, FeatureSource } from '@streamlayer/sdk-web-interfaces';
-import { Gamification } from '@streamlayer/feature-gamification';
-export class Feature extends AbstractFeature {
-}
-export const initFeature = (overlay, source, instance) => {
-    if (overlay.type === FeatureType.GAMES) {
-        return new Gamification(overlay, source, instance);
-    }
-    return new Feature(overlay, source);
-};
-export { FeatureSource } from '@streamlayer/sdk-web-interfaces';
-export const features = (instance, opts, done) => {
-    instance.features = new Map();
-    instance.sdk.getFeatures = () => instance.features;
-    /**
-     * A distinct object instance is created and initialized for each overlay.
-     */
-    instance.initFeature = (overlay, source = FeatureSource.ORGANIZATION) => {
-        const feature = initFeature(overlay, source, instance);
-        instance.features.set(overlay.name, feature);
-    };
-    instance.updateFeature = (overlay, source) => {
-        instance.features.get(overlay.name)?.update(overlay, source);
-    };
-    instance.destroyFeature = (overlay) => {
-        instance.features.delete(overlay.name);
-    };
-    instance.reinitializeFeatures = async () => {
-        // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-        // @ts-ignore
-        const organizationSettings = await instance.stores.organizationSettings.getValue();
-        instance.features.clear();
-        for (const overlay of organizationSettings?.overlays || []) {
-            instance.initFeature(overlay, FeatureSource.ORGANIZATION);
-        }
-    };
-    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-    // @ts-ignore
-    instance.stores.providerStreamId.listen((eventId) => {
-        if (!eventId) {
-            void instance.reinitializeFeatures();
-        }
-    });
-    done();
-};
-//# sourceMappingURL=index.js.map

package/src/index.js.map DELETED Viewed

@@ -1 +0,0 @@

- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../packages/sdk-web-features/src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAiB,WAAW,EAAE,MAAM,4BAA4B,CAAA;AACvE,OAAO,EAAE,eAAe,EAAE,aAAa,EAAoC,MAAM,iCAAiC,CAAA;AAClH,OAAO,EAAE,YAAY,EAAE,MAAM,mCAAmC,CAAA;AAEhE,MAAM,OAAO,OAAQ,SAAQ,eAA0B;CAAG;AAE1D,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,OAAqB,EAAE,MAAqB,EAAE,QAA4B,EAAE,EAAE;IACxG,IAAI,OAAO,CAAC,IAAI,KAAK,WAAW,CAAC,KAAK,EAAE;QACtC,OAAO,IAAI,YAAY,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAA;KACnD;IAED,OAAO,IAAI,OAAO,CAAC,OAAO,EAAE,MAAM,CAAC,CAAA;AACrC,CAAC,CAAA;AAED,OAAO,EAAE,aAAa,EAAE,MAAM,iCAAiC,CAAA;AAwB/D,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC,QAA4B,EAAE,IAAa,EAAE,IAAgB,EAAE,EAAE;IACxF,QAAQ,CAAC,QAAQ,GAAG,IAAI,GAAG,EAAmB,CAAA;IAE9C,QAAQ,CAAC,GAAG,CAAC,WAAW,GAAG,GAAG,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAA;IAElD;;OAEG;IACH,QAAQ,CAAC,WAAW,GAAG,CAAC,OAAqB,EAAE,SAAwB,aAAa,CAAC,YAAY,EAAE,EAAE;QACnG,MAAM,OAAO,GAAG,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAA;QAEtD,QAAQ,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;IAC9C,CAAC,CAAA;IAED,QAAQ,CAAC,aAAa,GAAG,CAAC,OAAqB,EAAE,MAAqB,EAAE,EAAE;QACxE,QAAQ,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,CAAA;IAC9D,CAAC,CAAA;IAED,QAAQ,CAAC,cAAc,GAAG,CAAC,OAAqB,EAAE,EAAE;QAClD,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;IACxC,CAAC,CAAA;IAED,QAAQ,CAAC,oBAAoB,GAAG,KAAK,IAAI,EAAE;QACzC,6DAA6D;QAC7D,aAAa;QACb,MAAM,oBAAoB,GAAG,MAAM,QAAQ,CAAC,MAAM,CAAC,oBAAoB,CAAC,QAAQ,EAAE,CAAA;QAElF,QAAQ,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAA;QAEzB,KAAK,MAAM,OAAO,IAAI,oBAAoB,EAAE,QAAQ,IAAI,EAAE,EAAE;YAC1D,QAAQ,CAAC,WAAW,CAAC,OAAO,EAAE,aAAa,CAAC,YAAY,CAAC,CAAA;SAC1D;IACH,CAAC,CAAA;IAED,6DAA6D;IAC7D,aAAa;IACb,QAAQ,CAAC,MAAM,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE;QAClD,IAAI,CAAC,OAAO,EAAE;YACZ,KAAK,QAAQ,CAAC,oBAAoB,EAAE,CAAA;SACrC;IACH,CAAC,CAAC,CAAA;IAEF,IAAI,EAAE,CAAA;AACR,CAAC,CAAA"}