@coveo/relay 0.1.0 → 0.2.0

package/lib/relay.cjs

@@ -2,6 +2,31 @@
 
 var crypto = require('crypto');
 
+async function callEventApi({ event, options, environment, validate, }) {
+    const { token, host, organizationId } = options;
+    const headers = {
+        "Content-Type": "application/json",
+        Authorization: `Bearer ${token}`,
+    };
+    const response = await environment.fetch(`${host}/rest/organizations/${organizationId}/events/v1${validate ? "/validate" : ""}`, {
+        method: "POST",
+        body: JSON.stringify([event]),
+        headers,
+    });
+    const data = await response.json();
+    if (!response.ok) {
+        throw new Error({
+            responseType: "serviceError",
+            ...data,
+        });
+    }
+    return data;
+}
+
+async function emit(params) {
+    await callEventApi(params);
+}
+
 /**
  * @todo LENS-1059: The clientId should be a value that is persisted over time on a device.
  */
@@ -109,7 +134,7 @@ function isBrowser() {
     }
 }
 
-const version = "0.1.0" ;
+const version = "0.2.0" ;
 
 function getConfig(options) {
     const { trackingId } = options;
@@ -141,26 +166,9 @@ function createRelayEvent(type, payload, options, environment, clientIdManager)
     };
 }
 
-async function validate({ event, options, environment, }) {
-    const { host, token, organizationId } = options;
-    const headers = {
-        "Content-Type": "application/json",
-        Authorization: `Bearer ${token}`,
-    };
-    const url = `${host}/rest/organizations/${organizationId}/events/v1/validate`;
-    const response = await environment.fetch(url, {
-        method: "POST",
-        body: JSON.stringify([event]),
-        headers,
-    });
-    const data = await response.json();
-    if (!response.ok) {
-        return {
-            valid: false,
-            responseType: "serviceError",
-            ...data,
-        };
-    }
+async function validate(params) {
+    params.validate = true;
+    const data = await callEventApi(params);
     const { valid, errors } = data[0];
     return { valid, errors: errors ?? [], responseType: "validation" };
 }
@@ -174,6 +182,12 @@ function createRelay(options) {
             environment,
             event: createRelayEvent(type, payload, options, environment, clientIdManager),
         }),
+        emit: (type, payload) => emit({
+            options,
+            environment,
+            event: createRelayEvent(type, payload, options, environment, clientIdManager),
+        }),
+        getMeta: (type) => createMeta(type, options, environment, clientIdManager),
         version,
     };
 }

package/lib/relay.js

@@ -1,3 +1,28 @@
+async function callEventApi({ event, options, environment, validate, }) {
+    const { token, host, organizationId } = options;
+    const headers = {
+        "Content-Type": "application/json",
+        Authorization: `Bearer ${token}`,
+    };
+    const response = await environment.fetch(`${host}/rest/organizations/${organizationId}/events/v1${validate ? "/validate" : ""}`, {
+        method: "POST",
+        body: JSON.stringify([event]),
+        headers,
+    });
+    const data = await response.json();
+    if (!response.ok) {
+        throw new Error({
+            responseType: "serviceError",
+            ...data,
+        });
+    }
+    return data;
+}
+
+async function emit(params) {
+    await callEventApi(params);
+}
+
 /**
  * @todo LENS-1059: The clientId should be a value that is persisted over time on a device.
  */
@@ -113,7 +138,7 @@ function isBrowser() {
     }
 }
 
-const version = "0.1.0" ;
+const version = "0.2.0" ;
 
 function getConfig(options) {
     const { trackingId } = options;
@@ -145,26 +170,9 @@ function createRelayEvent(type, payload, options, environment, clientIdManager)
     };
 }
 
-async function validate({ event, options, environment, }) {
-    const { host, token, organizationId } = options;
-    const headers = {
-        "Content-Type": "application/json",
-        Authorization: `Bearer ${token}`,
-    };
-    const url = `${host}/rest/organizations/${organizationId}/events/v1/validate`;
-    const response = await environment.fetch(url, {
-        method: "POST",
-        body: JSON.stringify([event]),
-        headers,
-    });
-    const data = await response.json();
-    if (!response.ok) {
-        return {
-            valid: false,
-            responseType: "serviceError",
-            ...data,
-        };
-    }
+async function validate(params) {
+    params.validate = true;
+    const data = await callEventApi(params);
     const { valid, errors } = data[0];
     return { valid, errors: errors ?? [], responseType: "validation" };
 }
@@ -178,6 +186,12 @@ function createRelay(options) {
             environment,
             event: createRelayEvent(type, payload, options, environment, clientIdManager),
         }),
+        emit: (type, payload) => emit({
+            options,
+            environment,
+            event: createRelayEvent(type, payload, options, environment, clientIdManager),
+        }),
+        getMeta: (type) => createMeta(type, options, environment, clientIdManager),
         version,
     };
 }

package/lib/relay.mjs

@@ -1,5 +1,30 @@
 import crypto from 'crypto';
 
+async function callEventApi({ event, options, environment, validate, }) {
+    const { token, host, organizationId } = options;
+    const headers = {
+        "Content-Type": "application/json",
+        Authorization: `Bearer ${token}`,
+    };
+    const response = await environment.fetch(`${host}/rest/organizations/${organizationId}/events/v1${validate ? "/validate" : ""}`, {
+        method: "POST",
+        body: JSON.stringify([event]),
+        headers,
+    });
+    const data = await response.json();
+    if (!response.ok) {
+        throw new Error({
+            responseType: "serviceError",
+            ...data,
+        });
+    }
+    return data;
+}
+
+async function emit(params) {
+    await callEventApi(params);
+}
+
 /**
  * @todo LENS-1059: The clientId should be a value that is persisted over time on a device.
  */
@@ -107,7 +132,7 @@ function isBrowser() {
     }
 }
 
-const version = "0.1.0" ;
+const version = "0.2.0" ;
 
 function getConfig(options) {
     const { trackingId } = options;
@@ -139,26 +164,9 @@ function createRelayEvent(type, payload, options, environment, clientIdManager)
     };
 }
 
-async function validate({ event, options, environment, }) {
-    const { host, token, organizationId } = options;
-    const headers = {
-        "Content-Type": "application/json",
-        Authorization: `Bearer ${token}`,
-    };
-    const url = `${host}/rest/organizations/${organizationId}/events/v1/validate`;
-    const response = await environment.fetch(url, {
-        method: "POST",
-        body: JSON.stringify([event]),
-        headers,
-    });
-    const data = await response.json();
-    if (!response.ok) {
-        return {
-            valid: false,
-            responseType: "serviceError",
-            ...data,
-        };
-    }
+async function validate(params) {
+    params.validate = true;
+    const data = await callEventApi(params);
     const { valid, errors } = data[0];
     return { valid, errors: errors ?? [], responseType: "validation" };
 }
@@ -172,6 +180,12 @@ function createRelay(options) {
             environment,
             event: createRelayEvent(type, payload, options, environment, clientIdManager),
         }),
+        emit: (type, payload) => emit({
+            options,
+            environment,
+            event: createRelayEvent(type, payload, options, environment, clientIdManager),
+        }),
+        getMeta: (type) => createMeta(type, options, environment, clientIdManager),
         version,
     };
 }

package/lib/types/emit/emit.d.ts

@@ -0,0 +1,3 @@
+import { EventApiCallParams } from "../event-api-call/event-api-caller";
+export declare function emit(params: EventApiCallParams): Promise<void>;
+//# sourceMappingURL=emit.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"emit.d.ts","sourceRoot":"","sources":["../../../src/emit/emit.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,kBAAkB,EACnB,MAAM,oCAAoC,CAAC;AAE5C,wBAAsB,IAAI,CAAC,MAAM,EAAE,kBAAkB,iBAEpD"}

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

@@ -0,0 +1,11 @@
+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;
+    validate?: boolean;
+}
+export declare function callEventApi({ event, options, environment, validate, }: EventApiCallParams): Promise<any>;
+//# sourceMappingURL=event-api-caller.d.ts.map

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

@@ -0,0 +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;IACzB,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED,wBAAsB,YAAY,CAAC,EACjC,KAAK,EACL,OAAO,EACP,WAAW,EACX,QAAQ,GACT,EAAE,kBAAkB,GAAG,OAAO,CAAC,GAAG,CAAC,CA2BnC"}

package/lib/types/relay.d.ts

@@ -1,4 +1,5 @@
-import { ServiceErrorResponse, ValidationError, ValidationReport, ValidationResponse } from "./validate/validate";
+import { ValidationError, ValidationResponse } from "./validate/validate";
+import { Meta } from "./event/meta/meta";
 type RelayPayload = Record<string, unknown>;
 interface RelayOptions {
     host: string;
@@ -7,9 +8,11 @@ interface RelayOptions {
     trackingId: string;
 }
 interface Relay {
-    validate: (type: string, payload: RelayPayload) => Promise<ValidationReport>;
+    validate: (type: string, payload: RelayPayload) => Promise<ValidationResponse>;
+    emit: (type: string, payload: RelayPayload) => Promise<void>;
+    getMeta: (type: string) => Meta;
     version: string;
 }
 export declare function createRelay(options: RelayOptions): Relay;
-export type { RelayPayload, RelayOptions, ServiceErrorResponse, ValidationError, ValidationReport, ValidationResponse, };
+export type { RelayPayload, RelayOptions, ValidationError, ValidationResponse };
 //# sourceMappingURL=relay.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"relay.d.ts","sourceRoot":"","sources":["../../src/relay.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,oBAAoB,EAEpB,eAAe,EACf,gBAAgB,EAChB,kBAAkB,EACnB,MAAM,qBAAqB,CAAC;AAG7B,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;CACpB;AAED,UAAU,KAAK;IACb,QAAQ,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,YAAY,KAAK,OAAO,CAAC,gBAAgB,CAAC,CAAC;IAC7E,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,wBAAgB,WAAW,CAAC,OAAO,EAAE,YAAY,GAAG,KAAK,CAmBxD;AAED,YAAY,EACV,YAAY,EACZ,YAAY,EACZ,oBAAoB,EACpB,eAAe,EACf,gBAAgB,EAChB,kBAAkB,GACnB,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,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;CACpB;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"}

package/lib/types/validate/validate.d.ts

@@ -1,11 +1,4 @@
-import { Environment } from "../environment/environment";
-import { RelayOptions } from "../relay";
-import { RelayEvent } from "../event/relay-event";
-interface ValidationParams {
-    event: Readonly<RelayEvent>;
-    options: RelayOptions;
-    environment: Environment;
-}
+import { EventApiCallParams } from "../event-api-call/event-api-caller";
 export interface ValidationError {
     type: string;
     message: string;
@@ -16,14 +9,5 @@ export interface ValidationResponse {
     responseType: "validation";
     errors: ValidationError[];
 }
-export interface ServiceErrorResponse {
-    valid: false;
-    responseType: "serviceError";
-    errorCode: string;
-    message: string;
-    requestID: string;
-}
-export type ValidationReport = ValidationResponse | ServiceErrorResponse;
-export declare function validate({ event, options, environment, }: ValidationParams): Promise<Readonly<ValidationReport>>;
-export {};
+export declare function validate(params: EventApiCallParams): Promise<Readonly<ValidationResponse>>;
 //# sourceMappingURL=validate.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"validate.d.ts","sourceRoot":"","sources":["../../../src/validate/validate.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,UAAU,gBAAgB;IACxB,KAAK,EAAE,QAAQ,CAAC,UAAU,CAAC,CAAC;IAC5B,OAAO,EAAE,YAAY,CAAC;IACtB,WAAW,EAAE,WAAW,CAAC;CAC1B;AAED,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,kBAAkB;IACjC,KAAK,EAAE,OAAO,CAAC;IACf,YAAY,EAAE,YAAY,CAAC;IAC3B,MAAM,EAAE,eAAe,EAAE,CAAC;CAC3B;AAED,MAAM,WAAW,oBAAoB;IACnC,KAAK,EAAE,KAAK,CAAC;IACb,YAAY,EAAE,cAAc,CAAC;IAC7B,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,MAAM,gBAAgB,GAAG,kBAAkB,GAAG,oBAAoB,CAAC;AAEzE,wBAAsB,QAAQ,CAAC,EAC7B,KAAK,EACL,OAAO,EACP,WAAW,GACZ,EAAE,gBAAgB,GAAG,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAAC,CA4BxD"}
+{"version":3,"file":"validate.d.ts","sourceRoot":"","sources":["../../../src/validate/validate.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,kBAAkB,EACnB,MAAM,oCAAoC,CAAC;AAE5C,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,kBAAkB;IACjC,KAAK,EAAE,OAAO,CAAC;IACf,YAAY,EAAE,YAAY,CAAC;IAC3B,MAAM,EAAE,eAAe,EAAE,CAAC;CAC3B;AAED,wBAAsB,QAAQ,CAC5B,MAAM,EAAE,kBAAkB,GACzB,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAAC,CAAC,CAOvC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@coveo/relay",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "A library for sending analytics events using Coveo's Event protocol.",
   "files": [
     "lib/**/*"
@@ -59,7 +59,6 @@
     "clean": "rm -rf ./lib",
     "test": "jest",
     "test:watch": "jest --watch",
-    "npm:publish": "node ./scripts/publish.mjs",
     "npm:tag": "node ./scripts/update-npm-tag.mjs"
   }
 }