@unchainedshop/events 1.1.3

package/README.md

@@ -0,0 +1,3 @@
+# Events (Unchained Engine)
+
+This package contains business logic for the event emitter abstraction layer

package/babel.config.js

@@ -0,0 +1,3 @@
+export default {
+  presets: [['@babel/preset-env', { targets: { node: 'current' } }], '@babel/preset-typescript'],
+};

package/lib/EventDirector.d.ts

@@ -0,0 +1,3 @@
+import { ContextNormalizerFunction, EventDirector as IEventDirector } from '@unchainedshop/types/events';
+export declare const defaultNormalizer: ContextNormalizerFunction;
+export declare const EventDirector: IEventDirector;

package/lib/EventDirector.js

@@ -0,0 +1,66 @@
+import { createLogger } from '@unchainedshop/logger';
+const logger = createLogger('unchained:events');
+export const defaultNormalizer = (context) => {
+    return {
+        userAgent: context?.userAgent,
+        language: context?.localeContext?.code,
+        country: context?.localeContext?.country,
+        remoteAddress: context?.remoteAddress,
+        referer: context?.req?.headers?.referer,
+        origin: context?.req?.headers?.origin,
+        userId: context?.userId,
+    };
+};
+const RegisteredEventsSet = new Set();
+const RegisteredCallbacksSet = new Set();
+let Adapter; // Public (customizable)
+let HistoryAdapter; // (Per default: Core-events adapter to write into DB)
+let ContextNormalizer = defaultNormalizer;
+export const EventDirector = {
+    registerEvents: (events) => {
+        if (events.length) {
+            events.forEach((e) => RegisteredEventsSet.add(e));
+            logger.verbose(`EventDirector -> Registered ${JSON.stringify(events)}`);
+        }
+    },
+    getRegisteredEvents: () => {
+        return Array.from(RegisteredEventsSet);
+    },
+    setContextNormalizer: (fn) => {
+        ContextNormalizer = fn;
+    },
+    setEmitAdapter: (adapter) => {
+        Adapter = adapter;
+    },
+    getEmitAdapter: () => Adapter,
+    setEmitHistoryAdapter: (adapter) => {
+        HistoryAdapter = adapter;
+    },
+    getEmitHistoryAdapter: () => HistoryAdapter,
+    emit: async (eventName, data) => {
+        const extractedContext = ContextNormalizer(null);
+        if (!RegisteredEventsSet.has(eventName))
+            throw new Error(`Event with ${eventName} is not registered`);
+        Adapter?.publish(eventName, {
+            payload: { ...data },
+            context: extractedContext,
+        });
+        HistoryAdapter?.publish(eventName, {
+            payload: { ...data },
+            context: extractedContext,
+        });
+        logger.verbose(`EventDirector -> Emitted ${eventName} with ${JSON.stringify(data)}`);
+    },
+    subscribe: (eventName, callback) => {
+        const currentSubscription = `${eventName}${callback?.toString()}`; // used to avaoid registering the same event handler callback
+        if (!RegisteredEventsSet.has(eventName))
+            throw new Error(`Event with ${eventName} is not registered`);
+        if (!RegisteredCallbacksSet.has(currentSubscription)) {
+            Adapter?.subscribe(eventName, callback);
+            HistoryAdapter?.subscribe(eventName, callback);
+            RegisteredCallbacksSet.add(currentSubscription);
+            logger.verbose(`EventDirector -> Subscribed to ${eventName}`);
+        }
+    },
+};
+//# sourceMappingURL=EventDirector.js.map

package/lib/EventDirector.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"EventDirector.js","sourceRoot":"","sources":["../src/EventDirector.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAErD,MAAM,MAAM,GAAG,YAAY,CAAC,kBAAkB,CAAC,CAAC;AAEhD,MAAM,CAAC,MAAM,iBAAiB,GAA8B,CAAC,OAAO,EAAE,EAAE;IACtE,OAAO;QACL,SAAS,EAAE,OAAO,EAAE,SAAS;QAC7B,QAAQ,EAAE,OAAO,EAAE,aAAa,EAAE,IAAI;QACtC,OAAO,EAAE,OAAO,EAAE,aAAa,EAAE,OAAO;QACxC,aAAa,EAAE,OAAO,EAAE,aAAa;QACrC,OAAO,EAAE,OAAO,EAAE,GAAG,EAAE,OAAO,EAAE,OAAO;QACvC,MAAM,EAAE,OAAO,EAAE,GAAG,EAAE,OAAO,EAAE,MAAM;QACrC,MAAM,EAAE,OAAO,EAAE,MAAM;KACxB,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,mBAAmB,GAAG,IAAI,GAAG,EAAE,CAAC;AACtC,MAAM,sBAAsB,GAAG,IAAI,GAAG,EAAE,CAAC;AAEzC,IAAI,OAAoB,CAAC,CAAC,wBAAwB;AAClD,IAAI,cAA2B,CAAC,CAAC,sDAAsD;AACvF,IAAI,iBAAiB,GAAG,iBAAiB,CAAC;AAE1C,MAAM,CAAC,MAAM,aAAa,GAAmB;IAC3C,cAAc,EAAE,CAAC,MAAgB,EAAQ,EAAE;QACzC,IAAI,MAAM,CAAC,MAAM,EAAE;YACjB,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,mBAAmB,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;YAClD,MAAM,CAAC,OAAO,CAAC,+BAA+B,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;SACzE;IACH,CAAC;IAED,mBAAmB,EAAE,GAAa,EAAE;QAClC,OAAO,KAAK,CAAC,IAAI,CAAC,mBAAmB,CAAa,CAAC;IACrD,CAAC;IAED,oBAAoB,EAAE,CAAC,EAA6B,EAAQ,EAAE;QAC5D,iBAAiB,GAAG,EAAE,CAAC;IACzB,CAAC;IAED,cAAc,EAAE,CAAC,OAAoB,EAAE,EAAE;QACvC,OAAO,GAAG,OAAO,CAAC;IACpB,CAAC;IAED,cAAc,EAAE,GAAgB,EAAE,CAAC,OAAO;IAE1C,qBAAqB,EAAE,CAAC,OAAoB,EAAE,EAAE;QAC9C,cAAc,GAAG,OAAO,CAAC;IAC3B,CAAC;IAED,qBAAqB,EAAE,GAAgB,EAAE,CAAC,cAAc;IAExD,IAAI,EAAE,KAAK,EAAE,SAAiB,EAAE,IAAS,EAAiB,EAAE;QAC1D,MAAM,gBAAgB,GAAG,iBAAiB,CAAC,IAAI,CAAC,CAAC;QAEjD,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,SAAS,CAAC;YACrC,MAAM,IAAI,KAAK,CAAC,cAAc,SAAS,oBAAoB,CAAC,CAAC;QAE/D,OAAO,EAAE,OAAO,CAAC,SAAS,EAAE;YAC1B,OAAO,EAAE,EAAE,GAAG,IAAI,EAAE;YACpB,OAAO,EAAE,gBAAgB;SAC1B,CAAC,CAAC;QAEH,cAAc,EAAE,OAAO,CAAC,SAAS,EAAE;YACjC,OAAO,EAAE,EAAE,GAAG,IAAI,EAAE;YACpB,OAAO,EAAE,gBAAgB;SAC1B,CAAC,CAAC;QAEH,MAAM,CAAC,OAAO,CAAC,4BAA4B,SAAS,SAAS,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACvF,CAAC;IAED,SAAS,EAAE,CAAC,SAAiB,EAAE,QAAoB,EAAQ,EAAE;QAC3D,MAAM,mBAAmB,GAAG,GAAG,SAAS,GAAG,QAAQ,EAAE,QAAQ,EAAE,EAAE,CAAC,CAAC,6DAA6D;QAEhI,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,SAAS,CAAC;YACrC,MAAM,IAAI,KAAK,CAAC,cAAc,SAAS,oBAAoB,CAAC,CAAC;QAE/D,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,mBAAmB,CAAC,EAAE;YACpD,OAAO,EAAE,SAAS,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;YACxC,cAAc,EAAE,SAAS,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;YAC/C,sBAAsB,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC;YAChD,MAAM,CAAC,OAAO,CAAC,kCAAkC,SAAS,EAAE,CAAC,CAAC;SAC/D;IACH,CAAC;CACF,CAAC"}

package/lib/events-index.d.ts

@@ -0,0 +1,2 @@
+declare const emit: (eventName: string, data?: string | Record<string, unknown>) => Promise<void>, getEmitAdapter: () => import("@unchainedshop/types/events").EmitAdapter, getEmitHistoryAdapter: () => import("@unchainedshop/types/events").EmitAdapter, getRegisteredEvents: () => string[], registerEvents: (events: string[]) => void, setEmitAdapter: (adapter: import("@unchainedshop/types/events").EmitAdapter) => void, setEmitHistoryAdapter: (adapter: import("@unchainedshop/types/events").EmitAdapter) => void, subscribe: (eventName: string, callback: (payload?: Record<string, unknown>) => void) => void;
+export { emit, getEmitAdapter, getEmitHistoryAdapter, getRegisteredEvents, registerEvents, setEmitAdapter, setEmitHistoryAdapter, subscribe, };

package/lib/events-index.js

@@ -0,0 +1,6 @@
+import { EventDirector } from './EventDirector';
+const { emit, getEmitAdapter, getEmitHistoryAdapter, getRegisteredEvents, registerEvents, setEmitAdapter, setEmitHistoryAdapter, subscribe, } = EventDirector;
+const GLOBAL_EVENTS = ['PAGE_VIEW'];
+registerEvents(GLOBAL_EVENTS);
+export { emit, getEmitAdapter, getEmitHistoryAdapter, getRegisteredEvents, registerEvents, setEmitAdapter, setEmitHistoryAdapter, subscribe, };
+//# sourceMappingURL=events-index.js.map

package/lib/events-index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"events-index.js","sourceRoot":"","sources":["../src/events-index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAEhD,MAAM,EACJ,IAAI,EACJ,cAAc,EACd,qBAAqB,EACrB,mBAAmB,EACnB,cAAc,EACd,cAAc,EACd,qBAAqB,EACrB,SAAS,GACV,GAAG,aAAa,CAAC;AAElB,MAAM,aAAa,GAAG,CAAC,WAAW,CAAC,CAAC;AACpC,cAAc,CAAC,aAAa,CAAC,CAAC;AAE9B,OAAO,EACL,IAAI,EACJ,cAAc,EACd,qBAAqB,EACrB,mBAAmB,EACnB,cAAc,EACd,cAAc,EACd,qBAAqB,EACrB,SAAS,GACV,CAAC"}

package/package.js

@@ -0,0 +1,20 @@
+Package.describe({
+  name: 'unchained:events',
+  version: '1.1.3',
+  summary: 'Unchained Engine: Event Director',
+  git: 'https://github.com/unchainedshop/unchained',
+  documentation: 'README.md',
+});
+
+Npm.depends({
+  redis: '4.1.0',
+  '@unchainedshop/logger': '1.1.3',
+});
+
+Package.onUse((api) => {
+  api.versionsFrom('2.7.3');
+  api.use('ecmascript');
+  api.use('typescript');
+
+  api.mainModule('src/events-index.ts', 'server');
+});

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "@unchainedshop/events",
+  "version": "1.1.3",
+  "main": "lib/events-index.js",
+  "types": "lib/events-index.d.ts",
+  "type": "module",
+  "scripts": {
+    "clean": "rm -rf lib",
+    "build": "npm run clean && tsc -p tsconfig.build.json",
+    "watch": "tsc --watch",
+    "link:core": "npm link @unchainedshop/types",
+    "test": "jest --watch"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/unchainedshop/unchained.git"
+  },
+  "keywords": [
+    "unchained",
+    "ecommerce",
+    "core"
+  ],
+  "author": "Joël Meiller",
+  "license": "EUPL-1.2",
+  "bugs": {
+    "url": "https://github.com/unchainedshop/unchained/issues"
+  },
+  "homepage": "https://github.com/unchainedshop/unchained#readme",
+  "dependencies": {
+    "redis": "^4.1.0",
+    "@unchainedshop/logger": "latest"
+  },
+  "devDependencies": {
+    "@babel/core": "^7.18.6",
+    "@babel/preset-env": "^7.18.6",
+    "@babel/preset-typescript": "^7.18.6",
+    "@types/chai": "^4.3.1",
+    "@types/jest": "^28.1.3",
+    "@types/mocha": "^9.1.1",
+    "@unchainedshop/types": "latest",
+    "babel-jest": "^28.1.1",
+    "chai": "^4.3.6",
+    "cross-env": "^7.0.3",
+    "jest": "^28.1.1",
+    "ts-jest": "^28.0.5",
+    "ts-node": "^10.8.1",
+    "typescript": "^4.7.4"
+  }
+}

package/plugins/node-event-emitter.ts

@@ -0,0 +1,20 @@
+import { EventEmitter } from 'events';
+import { EmitAdapter } from '@unchainedshop/types/events';
+import { setEmitAdapter } from 'meteor/unchained:events';
+
+const NodeEventEmitter = (): EmitAdapter => {
+  const eventEmitter = new EventEmitter();
+
+  return {
+    publish: (eventName, payload) => {
+      eventEmitter.emit(eventName, payload);
+    },
+
+    subscribe: (eventName, callback) => {
+      return eventEmitter.on(eventName, callback);
+    },
+  };
+};
+
+const adapter = NodeEventEmitter();
+setEmitAdapter(adapter);

package/plugins/redis.ts

@@ -0,0 +1,30 @@
+import redis from 'redis';
+import { EmitAdapter } from '@unchainedshop/types/events';
+import { setEmitAdapter } from 'meteor/unchained:events';
+
+const { REDIS_PORT = 6379, REDIS_HOST = '127.0.0.1' } = process.env;
+
+const subscribedEvents = new Set();
+
+const RedisEventEmitter = (): EmitAdapter => {
+  const redisPublisher = redis.createClient({
+    url: `redis://${REDIS_HOST}:${REDIS_PORT}`,
+  });
+
+  const redisSubscriber = redis.createClient({
+    url: `redis://${REDIS_HOST}:${REDIS_PORT}`,
+  });
+
+  return {
+    publish: (eventName, payload) => redisPublisher.publish(eventName, JSON.stringify(payload)),
+    subscribe: (eventName, callback) => {
+      redisSubscriber.on('message', (_channelName, payload) => callback(payload));
+      if (!subscribedEvents.has(eventName)) {
+        redisSubscriber.subscribe(eventName);
+        subscribedEvents.add(eventName);
+      }
+    },
+  };
+};
+
+setEmitAdapter(RedisEventEmitter());

package/tsconfig.build.json

@@ -0,0 +1,26 @@
+{
+  "compilerOptions": {
+    "allowJs": true,
+    "allowSyntheticDefaultImports": true,
+    "declaration": true,
+    "esModuleInterop": true,
+    "experimentalDecorators": true,
+    "forceConsistentCasingInFileNames": true,
+    "lib": ["esnext"],
+    "module": "esnext",
+    "moduleResolution": "node",
+    "noImplicitReturns": true,
+    "noUnusedLocals": false,
+    "outDir": "lib",
+    "preserveWatchOutput": true,
+    "skipLibCheck": true,
+    "sourceMap": true,
+    "target": "esnext",
+    "types": ["node"],
+    "baseUrl": ".", // This must be specified if "paths" is.
+    "paths": {
+      "meteor/unchained:*": ["node_modules/@unchainedshop/types/index.d.ts"]
+    }
+  },
+  "include": ["src"]
+}