@unchainedshop/core-events 1.1.3

package/README.md

@@ -0,0 +1,3 @@
+# Core Events (Unchained Engine)
+
+This package defines the event module which ensures the emitted events are written to the database as an Event History and offers a core module to search for events.

package/lib/db/EventsCollection.d.ts

@@ -0,0 +1,3 @@
+import { Db } from '@unchainedshop/types/common';
+import { Event } from '@unchainedshop/types/events';
+export declare const EventsCollection: (db: Db) => Promise<import("mongodb").Collection<Event>>;

package/lib/db/EventsCollection.js

@@ -0,0 +1,24 @@
+import { buildDbIndexes } from '@unchainedshop/utils';
+const TWO_DAYS_SEC = 172800;
+export const EventsCollection = async (db) => {
+    const Events = db.collection('events');
+    await buildDbIndexes(Events, [
+        {
+            index: { created: -1 },
+            options: { expireAfterSeconds: TWO_DAYS_SEC, name: 'created' },
+        },
+        { index: { type: 1 }, options: { name: 'type' } },
+        {
+            index: { _id: 'text', type: 'text' },
+            options: {
+                weights: {
+                    _id: 8,
+                    type: 4,
+                },
+                name: 'events_fulltext_search',
+            },
+        },
+    ]);
+    return Events;
+};
+//# sourceMappingURL=EventsCollection.js.map

package/lib/db/EventsCollection.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"EventsCollection.js","sourceRoot":"","sources":["../../src/db/EventsCollection.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AAEtD,MAAM,YAAY,GAAG,MAAM,CAAC;AAE5B,MAAM,CAAC,MAAM,gBAAgB,GAAG,KAAK,EAAE,EAAM,EAAE,EAAE;IAC/C,MAAM,MAAM,GAAG,EAAE,CAAC,UAAU,CAAQ,QAAQ,CAAC,CAAC;IAE9C,MAAM,cAAc,CAAC,MAAM,EAAE;QAC3B;YACE,KAAK,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC,EAAE;YACtB,OAAO,EAAE,EAAE,kBAAkB,EAAE,YAAY,EAAE,IAAI,EAAE,SAAS,EAAE;SAC/D;QACD,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,CAAC,EAAE,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE;QACjD;YACE,KAAK,EAAE,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE;YACpC,OAAO,EAAE;gBACP,OAAO,EAAE;oBACP,GAAG,EAAE,CAAC;oBACN,IAAI,EAAE,CAAC;iBACR;gBACD,IAAI,EAAE,wBAAwB;aAC/B;SACF;KACF,CAAC,CAAC;IAEH,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC"}

package/lib/db/EventsSchema.d.ts

@@ -0,0 +1 @@
+export const EventsSchema: any;

package/lib/db/EventsSchema.js

@@ -0,0 +1,9 @@
+import { Schemas } from '@unchainedshop/utils';
+import SimpleSchema from 'simpl-schema';
+export const EventsSchema = new SimpleSchema({
+    type: { type: String, required: true },
+    payload: { type: Object, blackbox: true },
+    context: { type: Object, blackbox: true },
+    ...Schemas.timestampFields,
+}, { requiredByDefault: false });
+//# sourceMappingURL=EventsSchema.js.map

package/lib/db/EventsSchema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"EventsSchema.js","sourceRoot":"","sources":["../../src/db/EventsSchema.js"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAC/C,OAAO,YAAY,MAAM,cAAc,CAAC;AAExC,MAAM,CAAC,MAAM,YAAY,GAAG,IAAI,YAAY,CAC1C;IACE,IAAI,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE;IACtC,OAAO,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE;IACzC,OAAO,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE;IACzC,GAAG,OAAO,CAAC,eAAe;CAC3B,EACD,EAAE,iBAAiB,EAAE,KAAK,EAAE,CAC7B,CAAC"}

package/lib/events-index.d.ts

@@ -0,0 +1 @@
+export { configureEventsModule } from './module/configureEventsModule';

package/lib/events-index.js

@@ -0,0 +1,2 @@
+export { configureEventsModule } from './module/configureEventsModule';
+//# 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,qBAAqB,EAAE,MAAM,gCAAgC,CAAC"}

package/lib/module/configureEventHistoryAdapter.d.ts

@@ -0,0 +1,3 @@
+import { ModuleMutations } from '@unchainedshop/types/common';
+import { Event } from '@unchainedshop/types/events';
+export declare const configureEventHistoryAdapter: (mutations: ModuleMutations<Event>) => void;

package/lib/module/configureEventHistoryAdapter.js

@@ -0,0 +1,19 @@
+import { getEmitHistoryAdapter, setEmitHistoryAdapter } from '@unchainedshop/events';
+export const configureEventHistoryAdapter = (mutations) => {
+    if (!getEmitHistoryAdapter()) {
+        const adapter = {
+            subscribe: () => {
+                // Do nothing
+            },
+            publish: async (eventName, { payload, context = {} }) => {
+                await mutations.create({
+                    type: eventName,
+                    payload,
+                    context,
+                });
+            },
+        };
+        setEmitHistoryAdapter(adapter);
+    }
+};
+//# sourceMappingURL=configureEventHistoryAdapter.js.map

package/lib/module/configureEventHistoryAdapter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"configureEventHistoryAdapter.js","sourceRoot":"","sources":["../../src/module/configureEventHistoryAdapter.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,qBAAqB,EAAE,qBAAqB,EAAE,MAAM,uBAAuB,CAAC;AAErF,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAAC,SAAiC,EAAE,EAAE;IAChF,IAAI,CAAC,qBAAqB,EAAE,EAAE;QAC5B,MAAM,OAAO,GAAgB;YAC3B,SAAS,EAAE,GAAG,EAAE;gBACd,aAAa;YACf,CAAC;YACD,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,EAAE,OAAO,EAAE,OAAO,GAAG,EAAE,EAAE,EAAE,EAAE;gBACtD,MAAM,SAAS,CAAC,MAAM,CAAC;oBACrB,IAAI,EAAE,SAAS;oBACf,OAAO;oBACP,OAAO;iBACR,CAAC,CAAC;YACL,CAAC;SACF,CAAC;QACF,qBAAqB,CAAC,OAAO,CAAC,CAAC;KAChC;AACH,CAAC,CAAC"}

package/lib/module/configureEventsModule.d.ts

@@ -0,0 +1,3 @@
+import { ModuleInput } from '@unchainedshop/types/common';
+import { EventsModule } from '@unchainedshop/types/events';
+export declare const configureEventsModule: ({ db, }: ModuleInput<Record<string, never>>) => Promise<EventsModule>;

package/lib/module/configureEventsModule.js

@@ -0,0 +1,47 @@
+import { generateDbFilterById, generateDbMutations, buildSortOptions } from '@unchainedshop/utils';
+import { getRegisteredEvents } from '@unchainedshop/events';
+import { EventsCollection } from '../db/EventsCollection';
+import { EventsSchema } from '../db/EventsSchema';
+import { configureEventHistoryAdapter } from './configureEventHistoryAdapter';
+const buildFindSelector = ({ types, queryString, created }) => {
+    const selector = {};
+    if (types && Array.isArray(types))
+        selector.type = { $in: types };
+    if (queryString)
+        selector.$text = { $search: queryString };
+    if (created)
+        selector.created = { $gte: created };
+    return selector;
+};
+export const configureEventsModule = async ({ db, }) => {
+    const Events = await EventsCollection(db);
+    const mutations = generateDbMutations(Events, EventsSchema, {
+        hasCreateOnly: true,
+    });
+    configureEventHistoryAdapter(mutations);
+    return {
+        ...mutations,
+        findEvent: async ({ eventId, ...rest }, options) => {
+            const selector = eventId ? generateDbFilterById(eventId) : rest;
+            return Events.findOne(selector, options);
+        },
+        findEvents: async ({ limit, offset, sort, ...query }) => {
+            return Events.find(buildFindSelector(query), {
+                skip: offset,
+                limit,
+                sort: buildSortOptions(sort || [{ key: 'created', value: 'DESC' }]),
+            }).toArray();
+        },
+        type: (event) => {
+            if (getRegisteredEvents().includes(event.type)) {
+                return event.type;
+            }
+            return 'UNKNOWN';
+        },
+        count: async (query) => {
+            const count = await Events.countDocuments(buildFindSelector(query));
+            return count;
+        },
+    };
+};
+//# sourceMappingURL=configureEventsModule.js.map

package/lib/module/configureEventsModule.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"configureEventsModule.js","sourceRoot":"","sources":["../../src/module/configureEventsModule.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,mBAAmB,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAGnG,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAC1D,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,EAAE,4BAA4B,EAAE,MAAM,gCAAgC,CAAC;AAE9E,MAAM,iBAAiB,GAAG,CAAC,EAAE,KAAK,EAAE,WAAW,EAAE,OAAO,EAAc,EAAE,EAAE;IACxE,MAAM,QAAQ,GAA+C,EAAE,CAAC;IAEhE,IAAI,KAAK,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;QAAE,QAAQ,CAAC,IAAI,GAAG,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC;IAClE,IAAI,WAAW;QAAE,QAAQ,CAAC,KAAK,GAAG,EAAE,OAAO,EAAE,WAAW,EAAE,CAAC;IAC3D,IAAI,OAAO;QAAE,QAAQ,CAAC,OAAO,GAAG,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC;IAClD,OAAO,QAAQ,CAAC;AAClB,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,qBAAqB,GAAG,KAAK,EAAE,EAC1C,EAAE,GACiC,EAAyB,EAAE;IAC9D,MAAM,MAAM,GAAG,MAAM,gBAAgB,CAAC,EAAE,CAAC,CAAC;IAE1C,MAAM,SAAS,GAAG,mBAAmB,CAAQ,MAAM,EAAE,YAAY,EAAE;QACjE,aAAa,EAAE,IAAI;KACpB,CAA2B,CAAC;IAE7B,4BAA4B,CAAC,SAAS,CAAC,CAAC;IAExC,OAAO;QACL,GAAG,SAAS;QACZ,SAAS,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,EAAE,OAAO,EAAE,EAAE;YACjD,MAAM,QAAQ,GAAG,OAAO,CAAC,CAAC,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;YAChE,OAAO,MAAM,CAAC,OAAO,CAAC,QAAoC,EAAE,OAAO,CAAC,CAAC;QACvE,CAAC;QAED,UAAU,EAAE,KAAK,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,KAAK,EAAE,EAAE,EAAE;YACtD,OAAO,MAAM,CAAC,IAAI,CAAC,iBAAiB,CAAC,KAAK,CAAC,EAAE;gBAC3C,IAAI,EAAE,MAAM;gBACZ,KAAK;gBACL,IAAI,EAAE,gBAAgB,CAAC,IAAI,IAAI,CAAC,EAAE,GAAG,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC;aACpE,CAAC,CAAC,OAAO,EAAE,CAAC;QACf,CAAC;QAED,IAAI,EAAE,CAAC,KAAK,EAAE,EAAE;YACd,IAAI,mBAAmB,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE;gBAC9C,OAAO,KAAK,CAAC,IAAI,CAAC;aACnB;YACD,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE;YACrB,MAAM,KAAK,GAAG,MAAM,MAAM,CAAC,cAAc,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC,CAAC;YACpE,OAAO,KAAK,CAAC;QACf,CAAC;KACF,CAAC;AACJ,CAAC,CAAC"}

package/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "@unchainedshop/core-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": "cross-env METEOR_PACKAGE_DIRS=../ TEST_CLIENT=0 TEST_WATCH=1 meteor test-packages ./ --driver-package meteortesting:mocha --port 4212"
+  },
+  "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": {
+    "@unchainedshop/events": "latest",
+    "@unchainedshop/utils": "latest",
+    "simpl-schema": "^1.12.2"
+  },
+  "devDependencies": {
+    "@types/chai": "^4.3.1",
+    "@types/mocha": "^9.1.1",
+    "@unchainedshop/types": "latest",
+    "chai": "^4.3.6",
+    "cross-env": "^7.0.3",
+    "isomorphic-unfetch": "^3.1.0",
+    "mongodb": "^4.4.1",
+    "typescript": "^4.7.4"
+  }
+}

package/tests/events-index.test.ts

@@ -0,0 +1,33 @@
+import { assert } from 'chai';
+import { initDb } from 'meteor/unchained:mongodb';
+import { configureEventsModule } from '@unchainedshop/events';
+import { emit, registerEvents, getEmitHistoryAdapter } from '@unchainedshop/events';
+
+describe('Test exports', () => {
+  let module;
+  before(async () => {
+    const db = await initDb();
+    module = await configureEventsModule({ db });
+
+    registerEvents(['TEST EVENT']);
+  });
+  it('Configure Events', () => {
+    assert.isDefined(configureEventsModule);
+    assert.ok(module);
+    assert.isFunction(module.findEvent);
+  });
+
+  it('Test event history adapter', async () => {
+    assert.ok(getEmitHistoryAdapter());
+
+    emit('TEST EVENT', { orderId: 'Order1234' });
+
+    const events = await module.findEvents({
+      limit: 10,
+      offset: 0,
+      type: 'TEST EVENT',
+    });
+
+    assert.isAtLeast(events.length, 1)
+  });
+});

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"]
+}

package/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "extends": "./tsconfig.build.json",
+  "compilerOptions": {
+    "noEmit": true,
+    "types": ["node", "mocha"]
+  },
+  "include": ["src", "tests"]
+}