@coveo/relay 0.3.0 → 0.3.1

package/lib/relay.cjs

@@ -134,7 +134,7 @@ function isBrowser() {
     }
 }
 
-const version = "0.3.0" ;
+const version = "0.3.1" ;
 
 function getConfig(options) {
     const { trackingId } = options;
@@ -147,7 +147,7 @@ function createMeta(type, options, environment, clientIdManager) {
     const { getReferrerUrl, getUrl, getUserAgent } = environment;
     const config = getConfig(options);
     const { clientId } = clientIdManager;
-    return {
+    return Object.freeze({
         type,
         config,
         ts: Date.now(),
@@ -156,7 +156,7 @@ function createMeta(type, options, environment, clientIdManager) {
         userAgent: getUserAgent(),
         referrerUrl: getReferrerUrl(),
         url: getUrl(),
-    };
+    });
 }
 
 function createRelayEvent(type, payload, options, environment, clientIdManager) {
@@ -172,21 +172,87 @@ async function validate(params) {
     return { valid, errors: errors ?? [], responseType: "validation" };
 }
 
+const ANY_EVENT_TYPE = "*";
+function createListenerManager() {
+    const listeners = [];
+    function getListenerIndex({ type, callback }) {
+        return listeners.findIndex((listener) => listener.type === type && listener.callback === callback);
+    }
+    function isMatchesType(listener, type) {
+        return listener.type === "*" || type === listener.type;
+    }
+    function add(listener) {
+        if (getListenerIndex(listener) < 0) {
+            listeners.push(listener);
+        }
+        return () => remove(listener.type, listener.callback);
+    }
+    function call(event) {
+        listeners.forEach((listener) => {
+            if (isMatchesType(listener, event.meta.type)) {
+                try {
+                    listener.callback(event);
+                }
+                catch (e) {
+                    console.error(e);
+                }
+            }
+        });
+    }
+    function removeMultiple(type) {
+        if (type === ANY_EVENT_TYPE) {
+            listeners.length = 0;
+        }
+        else {
+            for (let i = listeners.length - 1; i >= 0; i--) {
+                if (listeners[i].type === type) {
+                    listeners.splice(i, 1);
+                }
+            }
+        }
+    }
+    function removeOne(listener) {
+        const index = getListenerIndex(listener);
+        if (index >= 0) {
+            listeners.splice(index, 1);
+        }
+    }
+    function remove(type, callback) {
+        !!callback ? removeOne({ type, callback }) : removeMultiple(type);
+    }
+    return {
+        add,
+        call,
+        remove,
+    };
+}
+
 function createRelay(options) {
     const environment = currentEnvironment();
     const clientIdManager = createClientIdManager(environment);
+    const { add, call, remove } = createListenerManager();
     return {
-        validate: (type, payload) => validate({
-            options,
-            environment,
-            event: createRelayEvent(type, payload, options, environment, clientIdManager),
-        }),
-        emit: (type, payload) => emit({
-            options,
-            environment,
-            event: createRelayEvent(type, payload, options, environment, clientIdManager),
-        }),
+        validate: (type, payload) => {
+            const event = createRelayEvent(type, payload, options, environment, clientIdManager);
+            call(event);
+            return validate({
+                options,
+                environment,
+                event: createRelayEvent(type, payload, options, environment, clientIdManager),
+            });
+        },
+        emit: (type, payload) => {
+            const event = createRelayEvent(type, payload, options, environment, clientIdManager);
+            call(event);
+            return emit({
+                options,
+                environment,
+                event,
+            });
+        },
         getMeta: (type) => createMeta(type, options, environment, clientIdManager),
+        on: (type, callback) => add({ type, callback }),
+        off: (type, callback) => remove(type, callback),
         version,
     };
 }

package/lib/relay.js

@@ -138,7 +138,7 @@ function isBrowser() {
     }
 }
 
-const version = "0.3.0" ;
+const version = "0.3.1" ;
 
 function getConfig(options) {
     const { trackingId } = options;
@@ -151,7 +151,7 @@ function createMeta(type, options, environment, clientIdManager) {
     const { getReferrerUrl, getUrl, getUserAgent } = environment;
     const config = getConfig(options);
     const { clientId } = clientIdManager;
-    return {
+    return Object.freeze({
         type,
         config,
         ts: Date.now(),
@@ -160,7 +160,7 @@ function createMeta(type, options, environment, clientIdManager) {
         userAgent: getUserAgent(),
         referrerUrl: getReferrerUrl(),
         url: getUrl(),
-    };
+    });
 }
 
 function createRelayEvent(type, payload, options, environment, clientIdManager) {
@@ -176,21 +176,87 @@ async function validate(params) {
     return { valid, errors: errors ?? [], responseType: "validation" };
 }
 
+const ANY_EVENT_TYPE = "*";
+function createListenerManager() {
+    const listeners = [];
+    function getListenerIndex({ type, callback }) {
+        return listeners.findIndex((listener) => listener.type === type && listener.callback === callback);
+    }
+    function isMatchesType(listener, type) {
+        return listener.type === "*" || type === listener.type;
+    }
+    function add(listener) {
+        if (getListenerIndex(listener) < 0) {
+            listeners.push(listener);
+        }
+        return () => remove(listener.type, listener.callback);
+    }
+    function call(event) {
+        listeners.forEach((listener) => {
+            if (isMatchesType(listener, event.meta.type)) {
+                try {
+                    listener.callback(event);
+                }
+                catch (e) {
+                    console.error(e);
+                }
+            }
+        });
+    }
+    function removeMultiple(type) {
+        if (type === ANY_EVENT_TYPE) {
+            listeners.length = 0;
+        }
+        else {
+            for (let i = listeners.length - 1; i >= 0; i--) {
+                if (listeners[i].type === type) {
+                    listeners.splice(i, 1);
+                }
+            }
+        }
+    }
+    function removeOne(listener) {
+        const index = getListenerIndex(listener);
+        if (index >= 0) {
+            listeners.splice(index, 1);
+        }
+    }
+    function remove(type, callback) {
+        !!callback ? removeOne({ type, callback }) : removeMultiple(type);
+    }
+    return {
+        add,
+        call,
+        remove,
+    };
+}
+
 function createRelay(options) {
     const environment = currentEnvironment();
     const clientIdManager = createClientIdManager(environment);
+    const { add, call, remove } = createListenerManager();
     return {
-        validate: (type, payload) => validate({
-            options,
-            environment,
-            event: createRelayEvent(type, payload, options, environment, clientIdManager),
-        }),
-        emit: (type, payload) => emit({
-            options,
-            environment,
-            event: createRelayEvent(type, payload, options, environment, clientIdManager),
-        }),
+        validate: (type, payload) => {
+            const event = createRelayEvent(type, payload, options, environment, clientIdManager);
+            call(event);
+            return validate({
+                options,
+                environment,
+                event: createRelayEvent(type, payload, options, environment, clientIdManager),
+            });
+        },
+        emit: (type, payload) => {
+            const event = createRelayEvent(type, payload, options, environment, clientIdManager);
+            call(event);
+            return emit({
+                options,
+                environment,
+                event,
+            });
+        },
         getMeta: (type) => createMeta(type, options, environment, clientIdManager),
+        on: (type, callback) => add({ type, callback }),
+        off: (type, callback) => remove(type, callback),
         version,
     };
 }

package/lib/relay.mjs

@@ -132,7 +132,7 @@ function isBrowser() {
     }
 }
 
-const version = "0.3.0" ;
+const version = "0.3.1" ;
 
 function getConfig(options) {
     const { trackingId } = options;
@@ -145,7 +145,7 @@ function createMeta(type, options, environment, clientIdManager) {
     const { getReferrerUrl, getUrl, getUserAgent } = environment;
     const config = getConfig(options);
     const { clientId } = clientIdManager;
-    return {
+    return Object.freeze({
         type,
         config,
         ts: Date.now(),
@@ -154,7 +154,7 @@ function createMeta(type, options, environment, clientIdManager) {
         userAgent: getUserAgent(),
         referrerUrl: getReferrerUrl(),
         url: getUrl(),
-    };
+    });
 }
 
 function createRelayEvent(type, payload, options, environment, clientIdManager) {
@@ -170,21 +170,87 @@ async function validate(params) {
     return { valid, errors: errors ?? [], responseType: "validation" };
 }
 
+const ANY_EVENT_TYPE = "*";
+function createListenerManager() {
+    const listeners = [];
+    function getListenerIndex({ type, callback }) {
+        return listeners.findIndex((listener) => listener.type === type && listener.callback === callback);
+    }
+    function isMatchesType(listener, type) {
+        return listener.type === "*" || type === listener.type;
+    }
+    function add(listener) {
+        if (getListenerIndex(listener) < 0) {
+            listeners.push(listener);
+        }
+        return () => remove(listener.type, listener.callback);
+    }
+    function call(event) {
+        listeners.forEach((listener) => {
+            if (isMatchesType(listener, event.meta.type)) {
+                try {
+                    listener.callback(event);
+                }
+                catch (e) {
+                    console.error(e);
+                }
+            }
+        });
+    }
+    function removeMultiple(type) {
+        if (type === ANY_EVENT_TYPE) {
+            listeners.length = 0;
+        }
+        else {
+            for (let i = listeners.length - 1; i >= 0; i--) {
+                if (listeners[i].type === type) {
+                    listeners.splice(i, 1);
+                }
+            }
+        }
+    }
+    function removeOne(listener) {
+        const index = getListenerIndex(listener);
+        if (index >= 0) {
+            listeners.splice(index, 1);
+        }
+    }
+    function remove(type, callback) {
+        !!callback ? removeOne({ type, callback }) : removeMultiple(type);
+    }
+    return {
+        add,
+        call,
+        remove,
+    };
+}
+
 function createRelay(options) {
     const environment = currentEnvironment();
     const clientIdManager = createClientIdManager(environment);
+    const { add, call, remove } = createListenerManager();
     return {
-        validate: (type, payload) => validate({
-            options,
-            environment,
-            event: createRelayEvent(type, payload, options, environment, clientIdManager),
-        }),
-        emit: (type, payload) => emit({
-            options,
-            environment,
-            event: createRelayEvent(type, payload, options, environment, clientIdManager),
-        }),
+        validate: (type, payload) => {
+            const event = createRelayEvent(type, payload, options, environment, clientIdManager);
+            call(event);
+            return validate({
+                options,
+                environment,
+                event: createRelayEvent(type, payload, options, environment, clientIdManager),
+            });
+        },
+        emit: (type, payload) => {
+            const event = createRelayEvent(type, payload, options, environment, clientIdManager);
+            call(event);
+            return emit({
+                options,
+                environment,
+                event,
+            });
+        },
         getMeta: (type) => createMeta(type, options, environment, clientIdManager),
+        on: (type, callback) => add({ type, callback }),
+        off: (type, callback) => remove(type, callback),
         version,
     };
 }

package/lib/types/event/relay-event.d.ts

@@ -3,7 +3,7 @@ import { Environment } from "../environment/environment";
 import { RelayOptions, RelayPayload } from "../relay";
 import { Meta } from "./meta/meta";
 export interface RelayEvent extends RelayPayload {
-    meta: Meta;
+    meta: Readonly<Meta>;
 }
 export declare function createRelayEvent(type: string, payload: RelayPayload, options: RelayOptions, environment: Environment, clientIdManager: ClientIdManager): Readonly<RelayEvent>;
 //# sourceMappingURL=relay-event.d.ts.map

package/lib/types/event/relay-event.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"relay-event.d.ts","sourceRoot":"","sources":["../../../src/event/relay-event.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AACzD,OAAO,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AACzD,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AACtD,OAAO,EAAc,IAAI,EAAE,MAAM,aAAa,CAAC;AAE/C,MAAM,WAAW,UAAW,SAAQ,YAAY;IAC9C,IAAI,EAAE,IAAI,CAAC;CACZ;AAED,wBAAgB,gBAAgB,CAC9B,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,YAAY,EACrB,OAAO,EAAE,YAAY,EACrB,WAAW,EAAE,WAAW,EACxB,eAAe,EAAE,eAAe,GAC/B,QAAQ,CAAC,UAAU,CAAC,CAKtB"}
+{"version":3,"file":"relay-event.d.ts","sourceRoot":"","sources":["../../../src/event/relay-event.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AACzD,OAAO,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AACzD,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AACtD,OAAO,EAAc,IAAI,EAAE,MAAM,aAAa,CAAC;AAE/C,MAAM,WAAW,UAAW,SAAQ,YAAY;IAC9C,IAAI,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC;CACtB;AAED,wBAAgB,gBAAgB,CAC9B,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,YAAY,EACrB,OAAO,EAAE,YAAY,EACrB,WAAW,EAAE,WAAW,EACxB,eAAe,EAAE,eAAe,GAC/B,QAAQ,CAAC,UAAU,CAAC,CAKtB"}

package/lib/types/event-api-call/event-api-caller.d.ts

@@ -2,9 +2,9 @@ import { Environment } from "../environment/environment";
 import { RelayOptions } from "../relay";
 import { RelayEvent } from "../event/relay-event";
 export interface EventApiCallParams {
-    event: Readonly<RelayEvent>;
     options: RelayOptions;
     environment: Environment;
+    event: Readonly<RelayEvent>;
 }
 export type RelayMode = "emit" | "validate";
 export declare function callEventApi({ event, options, environment, }: EventApiCallParams): Promise<any>;

package/lib/types/event-api-call/event-api-caller.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"event-api-caller.d.ts","sourceRoot":"","sources":["../../../src/event-api-call/event-api-caller.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AACzD,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AACxC,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAElD,MAAM,WAAW,kBAAkB;IACjC,KAAK,EAAE,QAAQ,CAAC,UAAU,CAAC,CAAC;IAC5B,OAAO,EAAE,YAAY,CAAC;IACtB,WAAW,EAAE,WAAW,CAAC;CAC1B;AAED,MAAM,MAAM,SAAS,GAAG,MAAM,GAAG,UAAU,CAAC;AAE5C,wBAAsB,YAAY,CAAC,EACjC,KAAK,EACL,OAAO,EACP,WAAW,GACZ,EAAE,kBAAkB,GAAG,OAAO,CAAC,GAAG,CAAC,CA2BnC"}
+{"version":3,"file":"event-api-caller.d.ts","sourceRoot":"","sources":["../../../src/event-api-call/event-api-caller.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AACzD,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AACxC,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAElD,MAAM,WAAW,kBAAkB;IACjC,OAAO,EAAE,YAAY,CAAC;IACtB,WAAW,EAAE,WAAW,CAAC;IACzB,KAAK,EAAE,QAAQ,CAAC,UAAU,CAAC,CAAC;CAC7B;AAED,MAAM,MAAM,SAAS,GAAG,MAAM,GAAG,UAAU,CAAC;AAE5C,wBAAsB,YAAY,CAAC,EACjC,KAAK,EACL,OAAO,EACP,WAAW,GACZ,EAAE,kBAAkB,GAAG,OAAO,CAAC,GAAG,CAAC,CA2BnC"}

package/lib/types/listener/listener.d.ts

@@ -0,0 +1,14 @@
+import { RelayEvent } from "../event/relay-event";
+export type EventCallback = (event: RelayEvent) => void;
+interface Listener {
+    type: string;
+    callback: EventCallback;
+}
+interface ListenerManager {
+    add: (listener: Listener) => () => void;
+    call: (event: RelayEvent) => void;
+    remove: (type: string, callback?: EventCallback) => void;
+}
+export declare function createListenerManager(): ListenerManager;
+export {};
+//# sourceMappingURL=listener.d.ts.map

package/lib/types/listener/listener.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"listener.d.ts","sourceRoot":"","sources":["../../../src/listener/listener.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAIlD,MAAM,MAAM,aAAa,GAAG,CAAC,KAAK,EAAE,UAAU,KAAK,IAAI,CAAC;AAExD,UAAU,QAAQ;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,aAAa,CAAC;CACzB;AAED,UAAU,eAAe;IACvB,GAAG,EAAE,CAAC,QAAQ,EAAE,QAAQ,KAAK,MAAM,IAAI,CAAC;IACxC,IAAI,EAAE,CAAC,KAAK,EAAE,UAAU,KAAK,IAAI,CAAC;IAClC,MAAM,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,aAAa,KAAK,IAAI,CAAC;CAC1D;AAED,wBAAgB,qBAAqB,IAAI,eAAe,CA4DvD"}

package/lib/types/relay.d.ts

@@ -1,7 +1,9 @@
 import { ValidationError, ValidationResponse } from "./validate/validate";
 import { RelayMode } from "./event-api-call/event-api-caller";
 import { Meta } from "./event/meta/meta";
+import { EventCallback } from "./listener/listener";
 type RelayPayload = Record<string, unknown>;
+type Off = () => void;
 interface RelayOptions {
     host: string;
     organizationId: string;
@@ -13,6 +15,8 @@ interface Relay {
     validate: (type: string, payload: RelayPayload) => Promise<ValidationResponse>;
     emit: (type: string, payload: RelayPayload) => Promise<void>;
     getMeta: (type: string) => Meta;
+    on: (type: string, callback: EventCallback) => Off;
+    off: (type: string, callback?: EventCallback) => void;
     version: string;
 }
 export declare function createRelay(options: RelayOptions): Relay;

package/lib/types/relay.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"relay.d.ts","sourceRoot":"","sources":["../../src/relay.ts"],"names":[],"mappings":"AAIA,OAAO,EAEL,eAAe,EACf,kBAAkB,EACnB,MAAM,qBAAqB,CAAC;AAE7B,OAAO,EAAE,SAAS,EAAE,MAAM,mCAAmC,CAAC;AAC9D,OAAO,EAAc,IAAI,EAAE,MAAM,mBAAmB,CAAC;AAErD,KAAK,YAAY,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAE5C,UAAU,YAAY;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,cAAc,EAAE,MAAM,CAAC;IACvB,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,CAAC,EAAE,SAAS,CAAC;CAClB;AAED,UAAU,KAAK;IACb,QAAQ,EAAE,CACR,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,YAAY,KAClB,OAAO,CAAC,kBAAkB,CAAC,CAAC;IACjC,IAAI,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,YAAY,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAC7D,OAAO,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;IAChC,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,wBAAgB,WAAW,CAAC,OAAO,EAAE,YAAY,GAAG,KAAK,CAiCxD;AAED,YAAY,EAAE,YAAY,EAAE,YAAY,EAAE,eAAe,EAAE,kBAAkB,EAAE,CAAC"}
+{"version":3,"file":"relay.d.ts","sourceRoot":"","sources":["../../src/relay.ts"],"names":[],"mappings":"AAIA,OAAO,EAEL,eAAe,EACf,kBAAkB,EACnB,MAAM,qBAAqB,CAAC;AAE7B,OAAO,EAAE,SAAS,EAAE,MAAM,mCAAmC,CAAC;AAC9D,OAAO,EAAc,IAAI,EAAE,MAAM,mBAAmB,CAAC;AACrD,OAAO,EAAyB,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAE3E,KAAK,YAAY,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAC5C,KAAK,GAAG,GAAG,MAAM,IAAI,CAAC;AAEtB,UAAU,YAAY;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,cAAc,EAAE,MAAM,CAAC;IACvB,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,CAAC,EAAE,SAAS,CAAC;CAClB;AAED,UAAU,KAAK;IACb,QAAQ,EAAE,CACR,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,YAAY,KAClB,OAAO,CAAC,kBAAkB,CAAC,CAAC;IACjC,IAAI,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,YAAY,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAC7D,OAAO,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;IAChC,EAAE,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,aAAa,KAAK,GAAG,CAAC;IACnD,GAAG,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,aAAa,KAAK,IAAI,CAAC;IACtD,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,wBAAgB,WAAW,CAAC,OAAO,EAAE,YAAY,GAAG,KAAK,CAoDxD;AAED,YAAY,EAAE,YAAY,EAAE,YAAY,EAAE,eAAe,EAAE,kBAAkB,EAAE,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@coveo/relay",
-  "version": "0.3.0",
+  "version": "0.3.1",
   "description": "A library for sending analytics events using Coveo's Event protocol.",
   "files": [
     "lib/**/*"