@nu-art/analytics-backend 0.400.8 → 0.400.14

package/_modules/ModuleBE_Analytics.d.ts

@@ -14,6 +14,7 @@ declare class ModuleBE_Analytics_Class extends Module<Config> {
     private initPlugins;
     private api_sendEvent;
     private api_updateUser;
+    private api_updateLexicon;
 }
 export declare const ModuleBE_Analytics: ModuleBE_Analytics_Class;
 export {};

package/_modules/ModuleBE_Analytics.js

@@ -9,6 +9,7 @@ class ModuleBE_Analytics_Class extends Module {
         addRoutes([
             createBodyServerApi(ApiDef_Analytics()._v1.sendEvent, this.api_sendEvent),
             createBodyServerApi(ApiDef_Analytics()._v1.updateUser, this.api_updateUser),
+            createBodyServerApi(ApiDef_Analytics()._v1.updateLexicon, this.api_updateLexicon),
         ]);
     }
     //######################### Plugin Management #########################
@@ -36,5 +37,10 @@ class ModuleBE_Analytics_Class extends Module {
             plugin.updateUser?.(request);
         });
     };
+    api_updateLexicon = async (request) => {
+        return this.plugins.forEach(plugin => {
+            plugin.updateLexicon?.(request);
+        });
+    };
 }
 export const ModuleBE_Analytics = new ModuleBE_Analytics_Class();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nu-art/analytics-backend",
-  "version": "0.400.8",
+  "version": "0.400.14",
   "description": "analytics Backend",
   "license": "Apache-2.0",
   "scripts": {
@@ -11,12 +11,12 @@
     "linkDirectory": true
   },
   "dependencies": {
-    "@nu-art/analytics-shared": "0.400.8",
-    "@nu-art/ts-common": "0.400.8",
-    "@nu-art/firebase-backend": "0.400.8",
-    "@nu-art/firebase-shared": "0.400.8",
-    "@nu-art/thunderstorm-backend": "0.400.8",
-    "@nu-art/thunderstorm-shared": "0.400.8",
+    "@nu-art/analytics-shared": "0.400.14",
+    "@nu-art/ts-common": "0.400.14",
+    "@nu-art/firebase-backend": "0.400.14",
+    "@nu-art/firebase-shared": "0.400.14",
+    "@nu-art/thunderstorm-backend": "0.400.14",
+    "@nu-art/thunderstorm-shared": "0.400.14",
     "mixpanel": "~0.18.1"
   },
   "devDependencies": {},

package/plugins/AnalyticsPlugin_Base.d.ts

@@ -1,4 +1,4 @@
-import { Analytics_UpdateUser, TSAnalyticsEvent } from '@nu-art/analytics-shared';
+import { Analytics_UpdateLexicon, Analytics_UpdateUser, TSAnalyticsEvent } from '@nu-art/analytics-shared';
 import { Logger } from '@nu-art/ts-common';
 import { AnalyticsPluginBaseConfig } from './types.js';
 /**
@@ -34,8 +34,10 @@ export declare abstract class AnalyticsPlugin_Base<R extends any = any, C extend
     protected abstract translateEvent(event: TSAnalyticsEvent): R;
     protected abstract sendEvents: (events: R[]) => Promise<void>;
     protected abstract updateUser_Impl: undefined | ((mode: Analytics_UpdateUser['request']['mode'], data: Analytics_UpdateUser['request']['userData']) => Promise<void>);
+    protected abstract updateLexicon_Impl: undefined | ((mode: Analytics_UpdateLexicon['request']['mode'], data: Analytics_UpdateLexicon['request']['lexiconMap']) => Promise<void>);
     init(config: C): void;
     private emptyEventBuffer;
     registerEvent(event: TSAnalyticsEvent): void;
     updateUser(request: Analytics_UpdateUser['request']): void;
+    updateLexicon(request: Analytics_UpdateLexicon['request']): void;
 }

package/plugins/AnalyticsPlugin_Base.js

@@ -58,4 +58,9 @@ export class AnalyticsPlugin_Base extends Logger {
             return;
         this.updateUser_Impl?.(request.mode, request.userData);
     }
+    updateLexicon(request) {
+        if (!this.config?.active)
+            return;
+        this.updateLexicon_Impl?.(request.mode, request.lexiconMap);
+    }
 }

package/plugins/AnalyticsPlugin_Logger.d.ts

@@ -5,5 +5,6 @@ export declare class AnalyticsPlugin_Logger extends AnalyticsPlugin_Base {
     key: string;
     protected translateEvent(event: TSAnalyticsEvent): TSAnalyticsEvent;
     protected updateUser_Impl: undefined;
+    protected updateLexicon_Impl: undefined;
     protected sendEvents: (events: any[]) => Promise<void>;
 }

package/plugins/AnalyticsPlugin_Logger.js

@@ -6,6 +6,7 @@ export class AnalyticsPlugin_Logger extends AnalyticsPlugin_Base {
         return event;
     }
     updateUser_Impl = undefined;
+    updateLexicon_Impl = undefined;
     sendEvents = async (events) => {
         this.logInfoBold('######## Analytics Event - Start ########');
         this.logInfo(events);

package/plugins/AnalyticsPlugin_MixedPanels.d.ts

@@ -1,4 +1,4 @@
-import { Analytics_UpdateUser, TSAnalyticsEvent } from '@nu-art/analytics-shared';
+import { Analytics_UpdateLexicon, Analytics_UpdateUser, TSAnalyticsEvent } from '@nu-art/analytics-shared';
 import { AnalyticsPlugin_Base } from './AnalyticsPlugin_Base.js';
 import mixpanelLib from 'mixpanel';
 import { TypedMap } from '@nu-art/ts-common';
@@ -23,8 +23,10 @@ export declare class AnalyticsPlugin_MixedPanels extends AnalyticsPlugin_Base<Mi
     private mixpanel;
     init(config: MPConfig): void;
     private prepareUserProps;
+    private prepareLexiconMap;
     protected translateEvent(event: TSAnalyticsEvent): MixedPanelsEvent;
     protected sendEvents: (events: MixedPanelsEvent[]) => Promise<void>;
     protected updateUser_Impl: (mode: Analytics_UpdateUser["request"]["mode"], data: Analytics_UpdateUser["request"]["userData"]) => Promise<void>;
+    protected updateLexicon_Impl: (mode: Analytics_UpdateLexicon["request"]["mode"], data: Analytics_UpdateLexicon["request"]["lexiconMap"]) => Promise<void>;
 }
 export {};

package/plugins/AnalyticsPlugin_MixedPanels.js

@@ -36,6 +36,15 @@ export class AnalyticsPlugin_MixedPanels extends AnalyticsPlugin_Base {
         });
         return props;
     };
+    prepareLexiconMap = (data) => {
+        return _keys(data).reduce((map, groupKey) => {
+            map[groupKey] = {
+                id: data[groupKey].id,
+                propDict: { $name: data[groupKey].label },
+            };
+            return map;
+        }, {});
+    };
     //######################### Implemented Logic #########################
     translateEvent(event) {
         return {
@@ -95,4 +104,60 @@ export class AnalyticsPlugin_MixedPanels extends AnalyticsPlugin_Base {
             }
         });
     };
+    updateLexicon_Impl = (mode, data) => {
+        if (!this.mixpanel)
+            throw new BadImplementationException(`Calling update lexicon before analytics plugin ${pluginKey_MixedPanels} finished initializing`);
+        return new Promise((resolve, reject) => {
+            const lexiconMap = this.prepareLexiconMap(data);
+            this.logDebug('Updating Lexicon', lexiconMap);
+            switch (mode) {
+                case 'set': {
+                    const promises = _keys(lexiconMap)
+                        .map(groupKey => new Promise((resolve, reject) => {
+                        this.mixpanel?.groups.set(groupKey, lexiconMap[groupKey].id, lexiconMap[groupKey].propDict, (err) => {
+                            if (err) {
+                                this.logError(err);
+                                reject(err);
+                            }
+                            else {
+                                this.logDebug('Successfully updated lexicon');
+                                resolve();
+                            }
+                        });
+                    }));
+                    Promise.all(promises)
+                        .then(() => resolve())
+                        .catch(err => {
+                        this.logError('Failed batch updating lexicon', err);
+                        reject();
+                    });
+                    break;
+                }
+                case 'set_once': {
+                    const promises = _keys(lexiconMap)
+                        .map(groupKey => new Promise((resolve, reject) => {
+                        this.mixpanel?.groups.set_once(groupKey, lexiconMap[groupKey].id, lexiconMap[groupKey].propDict, (err) => {
+                            if (err) {
+                                this.logError(err);
+                                reject(err);
+                            }
+                            else {
+                                this.logDebug('Successfully updated lexicon');
+                                resolve();
+                            }
+                        });
+                    }));
+                    Promise.all(promises)
+                        .then(() => resolve())
+                        .catch(err => {
+                        this.logError('Failed batch updating lexicon', err);
+                        reject();
+                    });
+                    break;
+                }
+                default:
+                    throw new BadImplementationException(`No Implementation for mode ${mode}`);
+            }
+        });
+    };
 }