@coveo/relay 0.0.6 → 0.1.0

package/lib/relay.cjs

@@ -0,0 +1,181 @@
+'use strict';
+
+var crypto = require('crypto');
+
+/**
+ * @todo LENS-1059: The clientId should be a value that is persisted over time on a device.
+ */
+function getClientId(environment) {
+    return environment.generateUUID();
+}
+function createClientIdManager(environment) {
+    return {
+        clientId: getClientId(environment),
+    };
+}
+
+const rnds8Pool = new Uint8Array(256); // # of random values to pre-allocate
+
+let poolPtr = rnds8Pool.length;
+function rng() {
+  if (poolPtr > rnds8Pool.length - 16) {
+    crypto.randomFillSync(rnds8Pool);
+    poolPtr = 0;
+  }
+
+  return rnds8Pool.slice(poolPtr, poolPtr += 16);
+}
+
+/**
+ * Convert array of 16 byte values to UUID string format of the form:
+ * XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
+ */
+
+const byteToHex = [];
+
+for (let i = 0; i < 256; ++i) {
+  byteToHex.push((i + 0x100).toString(16).slice(1));
+}
+
+function unsafeStringify(arr, offset = 0) {
+  // Note: Be careful editing this code!  It's been tuned for performance
+  // and works in ways you may not expect. See https://github.com/uuidjs/uuid/pull/434
+  return (byteToHex[arr[offset + 0]] + byteToHex[arr[offset + 1]] + byteToHex[arr[offset + 2]] + byteToHex[arr[offset + 3]] + '-' + byteToHex[arr[offset + 4]] + byteToHex[arr[offset + 5]] + '-' + byteToHex[arr[offset + 6]] + byteToHex[arr[offset + 7]] + '-' + byteToHex[arr[offset + 8]] + byteToHex[arr[offset + 9]] + '-' + byteToHex[arr[offset + 10]] + byteToHex[arr[offset + 11]] + byteToHex[arr[offset + 12]] + byteToHex[arr[offset + 13]] + byteToHex[arr[offset + 14]] + byteToHex[arr[offset + 15]]).toLowerCase();
+}
+
+var native = {
+  randomUUID: crypto.randomUUID
+};
+
+function v4(options, buf, offset) {
+  if (native.randomUUID && !buf && !options) {
+    return native.randomUUID();
+  }
+
+  options = options || {};
+  const rnds = options.random || (options.rng || rng)(); // Per 4.4, set bits for version and `clock_seq_hi_and_reserved`
+
+  rnds[6] = rnds[6] & 0x0f | 0x40;
+  rnds[8] = rnds[8] & 0x3f | 0x80; // Copy bytes to buffer, if provided
+
+  if (buf) {
+    offset = offset || 0;
+
+    for (let i = 0; i < 16; ++i) {
+      buf[offset + i] = rnds[i];
+    }
+
+    return buf;
+  }
+
+  return unsafeStringify(rnds);
+}
+
+function getReferrerUrl() {
+    const referrer = document.referrer;
+    return referrer === "" ? null : referrer;
+}
+function buildBrowserEnvironment() {
+    return {
+        runtime: "browser",
+        fetch: (url, init) => fetch(url, init),
+        getReferrerUrl: () => getReferrerUrl(),
+        getUrl: () => window.location.href,
+        getUserAgent: () => navigator.userAgent,
+        generateUUID: () => v4(),
+    };
+}
+
+function buildNodeEnvironment() {
+    return {
+        runtime: "node",
+        fetch: (url, init) => fetch(url, init),
+        getReferrerUrl: () => null,
+        getUrl: () => null,
+        getUserAgent: () => null,
+        generateUUID: () => v4(),
+    };
+}
+
+function currentEnvironment() {
+    return isBrowser() ? buildBrowserEnvironment() : buildNodeEnvironment();
+}
+function isBrowser() {
+    try {
+        return typeof window === "object";
+    }
+    catch (e) {
+        return false;
+    }
+}
+
+const version = "0.1.0" ;
+
+function getConfig(options) {
+    const { trackingId } = options;
+    return { trackingId };
+}
+function getSource() {
+    return `relay@${version}`;
+}
+function createMeta(type, options, environment, clientIdManager) {
+    const { getReferrerUrl, getUrl, getUserAgent } = environment;
+    const config = getConfig(options);
+    const { clientId } = clientIdManager;
+    return {
+        type,
+        config,
+        ts: Date.now(),
+        source: getSource(),
+        clientId,
+        userAgent: getUserAgent(),
+        referrerUrl: getReferrerUrl(),
+        url: getUrl(),
+    };
+}
+
+function createRelayEvent(type, payload, options, environment, clientIdManager) {
+    return {
+        ...payload,
+        meta: createMeta(type, 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,
+        };
+    }
+    const { valid, errors } = data[0];
+    return { valid, errors: errors ?? [], responseType: "validation" };
+}
+
+function createRelay(options) {
+    const environment = currentEnvironment();
+    const clientIdManager = createClientIdManager(environment);
+    return {
+        validate: (type, payload) => validate({
+            options,
+            environment,
+            event: createRelayEvent(type, payload, options, environment, clientIdManager),
+        }),
+        version,
+    };
+}
+
+exports.createRelay = createRelay;

package/lib/relay.js

@@ -0,0 +1,185 @@
+/**
+ * @todo LENS-1059: The clientId should be a value that is persisted over time on a device.
+ */
+function getClientId(environment) {
+    return environment.generateUUID();
+}
+function createClientIdManager(environment) {
+    return {
+        clientId: getClientId(environment),
+    };
+}
+
+// Unique ID creation requires a high quality random # generator. In the browser we therefore
+// require the crypto API and do not support built-in fallback to lower quality random number
+// generators (like Math.random()).
+let getRandomValues;
+const rnds8 = new Uint8Array(16);
+function rng() {
+  // lazy load so that environments that need to polyfill have a chance to do so
+  if (!getRandomValues) {
+    // getRandomValues needs to be invoked in a context where "this" is a Crypto implementation.
+    getRandomValues = typeof crypto !== 'undefined' && crypto.getRandomValues && crypto.getRandomValues.bind(crypto);
+
+    if (!getRandomValues) {
+      throw new Error('crypto.getRandomValues() not supported. See https://github.com/uuidjs/uuid#getrandomvalues-not-supported');
+    }
+  }
+
+  return getRandomValues(rnds8);
+}
+
+/**
+ * Convert array of 16 byte values to UUID string format of the form:
+ * XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
+ */
+
+const byteToHex = [];
+
+for (let i = 0; i < 256; ++i) {
+  byteToHex.push((i + 0x100).toString(16).slice(1));
+}
+
+function unsafeStringify(arr, offset = 0) {
+  // Note: Be careful editing this code!  It's been tuned for performance
+  // and works in ways you may not expect. See https://github.com/uuidjs/uuid/pull/434
+  return (byteToHex[arr[offset + 0]] + byteToHex[arr[offset + 1]] + byteToHex[arr[offset + 2]] + byteToHex[arr[offset + 3]] + '-' + byteToHex[arr[offset + 4]] + byteToHex[arr[offset + 5]] + '-' + byteToHex[arr[offset + 6]] + byteToHex[arr[offset + 7]] + '-' + byteToHex[arr[offset + 8]] + byteToHex[arr[offset + 9]] + '-' + byteToHex[arr[offset + 10]] + byteToHex[arr[offset + 11]] + byteToHex[arr[offset + 12]] + byteToHex[arr[offset + 13]] + byteToHex[arr[offset + 14]] + byteToHex[arr[offset + 15]]).toLowerCase();
+}
+
+const randomUUID = typeof crypto !== 'undefined' && crypto.randomUUID && crypto.randomUUID.bind(crypto);
+var native = {
+  randomUUID
+};
+
+function v4(options, buf, offset) {
+  if (native.randomUUID && !buf && !options) {
+    return native.randomUUID();
+  }
+
+  options = options || {};
+  const rnds = options.random || (options.rng || rng)(); // Per 4.4, set bits for version and `clock_seq_hi_and_reserved`
+
+  rnds[6] = rnds[6] & 0x0f | 0x40;
+  rnds[8] = rnds[8] & 0x3f | 0x80; // Copy bytes to buffer, if provided
+
+  if (buf) {
+    offset = offset || 0;
+
+    for (let i = 0; i < 16; ++i) {
+      buf[offset + i] = rnds[i];
+    }
+
+    return buf;
+  }
+
+  return unsafeStringify(rnds);
+}
+
+function getReferrerUrl() {
+    const referrer = document.referrer;
+    return referrer === "" ? null : referrer;
+}
+function buildBrowserEnvironment() {
+    return {
+        runtime: "browser",
+        fetch: (url, init) => fetch(url, init),
+        getReferrerUrl: () => getReferrerUrl(),
+        getUrl: () => window.location.href,
+        getUserAgent: () => navigator.userAgent,
+        generateUUID: () => v4(),
+    };
+}
+
+function buildNodeEnvironment() {
+    return {
+        runtime: "node",
+        fetch: (url, init) => fetch(url, init),
+        getReferrerUrl: () => null,
+        getUrl: () => null,
+        getUserAgent: () => null,
+        generateUUID: () => v4(),
+    };
+}
+
+function currentEnvironment() {
+    return isBrowser() ? buildBrowserEnvironment() : buildNodeEnvironment();
+}
+function isBrowser() {
+    try {
+        return typeof window === "object";
+    }
+    catch (e) {
+        return false;
+    }
+}
+
+const version = "0.1.0" ;
+
+function getConfig(options) {
+    const { trackingId } = options;
+    return { trackingId };
+}
+function getSource() {
+    return `relay@${version}`;
+}
+function createMeta(type, options, environment, clientIdManager) {
+    const { getReferrerUrl, getUrl, getUserAgent } = environment;
+    const config = getConfig(options);
+    const { clientId } = clientIdManager;
+    return {
+        type,
+        config,
+        ts: Date.now(),
+        source: getSource(),
+        clientId,
+        userAgent: getUserAgent(),
+        referrerUrl: getReferrerUrl(),
+        url: getUrl(),
+    };
+}
+
+function createRelayEvent(type, payload, options, environment, clientIdManager) {
+    return {
+        ...payload,
+        meta: createMeta(type, 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,
+        };
+    }
+    const { valid, errors } = data[0];
+    return { valid, errors: errors ?? [], responseType: "validation" };
+}
+
+function createRelay(options) {
+    const environment = currentEnvironment();
+    const clientIdManager = createClientIdManager(environment);
+    return {
+        validate: (type, payload) => validate({
+            options,
+            environment,
+            event: createRelayEvent(type, payload, options, environment, clientIdManager),
+        }),
+        version,
+    };
+}
+
+export { createRelay };

package/lib/relay.mjs

@@ -0,0 +1,179 @@
+import crypto from 'crypto';
+
+/**
+ * @todo LENS-1059: The clientId should be a value that is persisted over time on a device.
+ */
+function getClientId(environment) {
+    return environment.generateUUID();
+}
+function createClientIdManager(environment) {
+    return {
+        clientId: getClientId(environment),
+    };
+}
+
+const rnds8Pool = new Uint8Array(256); // # of random values to pre-allocate
+
+let poolPtr = rnds8Pool.length;
+function rng() {
+  if (poolPtr > rnds8Pool.length - 16) {
+    crypto.randomFillSync(rnds8Pool);
+    poolPtr = 0;
+  }
+
+  return rnds8Pool.slice(poolPtr, poolPtr += 16);
+}
+
+/**
+ * Convert array of 16 byte values to UUID string format of the form:
+ * XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
+ */
+
+const byteToHex = [];
+
+for (let i = 0; i < 256; ++i) {
+  byteToHex.push((i + 0x100).toString(16).slice(1));
+}
+
+function unsafeStringify(arr, offset = 0) {
+  // Note: Be careful editing this code!  It's been tuned for performance
+  // and works in ways you may not expect. See https://github.com/uuidjs/uuid/pull/434
+  return (byteToHex[arr[offset + 0]] + byteToHex[arr[offset + 1]] + byteToHex[arr[offset + 2]] + byteToHex[arr[offset + 3]] + '-' + byteToHex[arr[offset + 4]] + byteToHex[arr[offset + 5]] + '-' + byteToHex[arr[offset + 6]] + byteToHex[arr[offset + 7]] + '-' + byteToHex[arr[offset + 8]] + byteToHex[arr[offset + 9]] + '-' + byteToHex[arr[offset + 10]] + byteToHex[arr[offset + 11]] + byteToHex[arr[offset + 12]] + byteToHex[arr[offset + 13]] + byteToHex[arr[offset + 14]] + byteToHex[arr[offset + 15]]).toLowerCase();
+}
+
+var native = {
+  randomUUID: crypto.randomUUID
+};
+
+function v4(options, buf, offset) {
+  if (native.randomUUID && !buf && !options) {
+    return native.randomUUID();
+  }
+
+  options = options || {};
+  const rnds = options.random || (options.rng || rng)(); // Per 4.4, set bits for version and `clock_seq_hi_and_reserved`
+
+  rnds[6] = rnds[6] & 0x0f | 0x40;
+  rnds[8] = rnds[8] & 0x3f | 0x80; // Copy bytes to buffer, if provided
+
+  if (buf) {
+    offset = offset || 0;
+
+    for (let i = 0; i < 16; ++i) {
+      buf[offset + i] = rnds[i];
+    }
+
+    return buf;
+  }
+
+  return unsafeStringify(rnds);
+}
+
+function getReferrerUrl() {
+    const referrer = document.referrer;
+    return referrer === "" ? null : referrer;
+}
+function buildBrowserEnvironment() {
+    return {
+        runtime: "browser",
+        fetch: (url, init) => fetch(url, init),
+        getReferrerUrl: () => getReferrerUrl(),
+        getUrl: () => window.location.href,
+        getUserAgent: () => navigator.userAgent,
+        generateUUID: () => v4(),
+    };
+}
+
+function buildNodeEnvironment() {
+    return {
+        runtime: "node",
+        fetch: (url, init) => fetch(url, init),
+        getReferrerUrl: () => null,
+        getUrl: () => null,
+        getUserAgent: () => null,
+        generateUUID: () => v4(),
+    };
+}
+
+function currentEnvironment() {
+    return isBrowser() ? buildBrowserEnvironment() : buildNodeEnvironment();
+}
+function isBrowser() {
+    try {
+        return typeof window === "object";
+    }
+    catch (e) {
+        return false;
+    }
+}
+
+const version = "0.1.0" ;
+
+function getConfig(options) {
+    const { trackingId } = options;
+    return { trackingId };
+}
+function getSource() {
+    return `relay@${version}`;
+}
+function createMeta(type, options, environment, clientIdManager) {
+    const { getReferrerUrl, getUrl, getUserAgent } = environment;
+    const config = getConfig(options);
+    const { clientId } = clientIdManager;
+    return {
+        type,
+        config,
+        ts: Date.now(),
+        source: getSource(),
+        clientId,
+        userAgent: getUserAgent(),
+        referrerUrl: getReferrerUrl(),
+        url: getUrl(),
+    };
+}
+
+function createRelayEvent(type, payload, options, environment, clientIdManager) {
+    return {
+        ...payload,
+        meta: createMeta(type, 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,
+        };
+    }
+    const { valid, errors } = data[0];
+    return { valid, errors: errors ?? [], responseType: "validation" };
+}
+
+function createRelay(options) {
+    const environment = currentEnvironment();
+    const clientIdManager = createClientIdManager(environment);
+    return {
+        validate: (type, payload) => validate({
+            options,
+            environment,
+            event: createRelayEvent(type, payload, options, environment, clientIdManager),
+        }),
+        version,
+    };
+}
+
+export { createRelay };

package/lib/types/client-id/client-id.d.ts

@@ -0,0 +1,6 @@
+import { Environment } from "../environment/environment";
+export interface ClientIdManager {
+    clientId: string;
+}
+export declare function createClientIdManager(environment: Environment): ClientIdManager;
+//# sourceMappingURL=client-id.d.ts.map

package/lib/types/client-id/client-id.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client-id.d.ts","sourceRoot":"","sources":["../../../src/client-id/client-id.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AAEzD,MAAM,WAAW,eAAe;IAC9B,QAAQ,EAAE,MAAM,CAAC;CAClB;AASD,wBAAgB,qBAAqB,CACnC,WAAW,EAAE,WAAW,GACvB,eAAe,CAIjB"}

package/lib/types/environment/browser/browser.d.ts

@@ -0,0 +1,3 @@
+import { Environment } from "../environment";
+export declare function buildBrowserEnvironment(): Environment;
+//# sourceMappingURL=browser.d.ts.map

package/lib/types/environment/browser/browser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"browser.d.ts","sourceRoot":"","sources":["../../../../src/environment/browser/browser.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAQ7C,wBAAgB,uBAAuB,IAAI,WAAW,CASrD"}

package/lib/types/environment/environment.d.ts

@@ -0,0 +1,10 @@
+export interface Environment {
+    runtime: "browser" | "node";
+    fetch: (url: string, init?: RequestInit) => Promise<Response>;
+    getReferrerUrl: () => string | null;
+    getUrl: () => string | null;
+    getUserAgent: () => string | null;
+    generateUUID: () => string;
+}
+export declare function currentEnvironment(): Environment;
+//# sourceMappingURL=environment.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"environment.d.ts","sourceRoot":"","sources":["../../../src/environment/environment.ts"],"names":[],"mappings":"AAGA,MAAM,WAAW,WAAW;IAC1B,OAAO,EAAE,SAAS,GAAG,MAAM,CAAC;IAC5B,KAAK,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,WAAW,KAAK,OAAO,CAAC,QAAQ,CAAC,CAAC;IAC9D,cAAc,EAAE,MAAM,MAAM,GAAG,IAAI,CAAC;IACpC,MAAM,EAAE,MAAM,MAAM,GAAG,IAAI,CAAC;IAC5B,YAAY,EAAE,MAAM,MAAM,GAAG,IAAI,CAAC;IAClC,YAAY,EAAE,MAAM,MAAM,CAAC;CAC5B;AAED,wBAAgB,kBAAkB,IAAI,WAAW,CAEhD"}

package/lib/types/environment/node/node.d.ts

@@ -0,0 +1,3 @@
+import { Environment } from "../environment";
+export declare function buildNodeEnvironment(): Environment;
+//# sourceMappingURL=node.d.ts.map

package/lib/types/environment/node/node.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"node.d.ts","sourceRoot":"","sources":["../../../../src/environment/node/node.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,wBAAgB,oBAAoB,IAAI,WAAW,CASlD"}

package/lib/types/event/meta/meta.d.ts

@@ -0,0 +1,19 @@
+import { ClientIdManager } from "../../client-id/client-id";
+import { Environment } from "../../environment/environment";
+import { RelayOptions } from "../../relay";
+interface Config {
+    trackingId: string;
+}
+export interface Meta {
+    type: string;
+    config: Config;
+    ts: number;
+    source: string;
+    clientId: string;
+    userAgent: string | null;
+    referrerUrl: string | null;
+    url: string | null;
+}
+export declare function createMeta(type: string, options: RelayOptions, environment: Environment, clientIdManager: ClientIdManager): Readonly<Meta>;
+export {};
+//# sourceMappingURL=meta.d.ts.map

package/lib/types/event/meta/meta.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"meta.d.ts","sourceRoot":"","sources":["../../../../src/event/meta/meta.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AAC5D,OAAO,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAC;AAC5D,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAG3C,UAAU,MAAM;IACd,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,IAAI;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;CACpB;AAWD,wBAAgB,UAAU,CACxB,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,YAAY,EACrB,WAAW,EAAE,WAAW,EACxB,eAAe,EAAE,eAAe,GAC/B,QAAQ,CAAC,IAAI,CAAC,CAehB"}

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

@@ -0,0 +1,9 @@
+import { ClientIdManager } from "../client-id/client-id";
+import { Environment } from "../environment/environment";
+import { RelayOptions, RelayPayload } from "../relay";
+import { Meta } from "./meta/meta";
+export interface RelayEvent extends RelayPayload {
+    meta: 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

@@ -0,0 +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"}

package/lib/types/relay.d.ts

@@ -0,0 +1,15 @@
+import { ServiceErrorResponse, ValidationError, ValidationReport, ValidationResponse } from "./validate/validate";
+type RelayPayload = Record<string, unknown>;
+interface RelayOptions {
+    host: string;
+    organizationId: string;
+    token: string;
+    trackingId: string;
+}
+interface Relay {
+    validate: (type: string, payload: RelayPayload) => Promise<ValidationReport>;
+    version: string;
+}
+export declare function createRelay(options: RelayOptions): Relay;
+export type { RelayPayload, RelayOptions, ServiceErrorResponse, ValidationError, ValidationReport, ValidationResponse, };
+//# sourceMappingURL=relay.d.ts.map

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

@@ -0,0 +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"}

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

@@ -0,0 +1,29 @@
+import { Environment } from "../environment/environment";
+import { RelayOptions } from "../relay";
+import { RelayEvent } from "../event/relay-event";
+interface ValidationParams {
+    event: Readonly<RelayEvent>;
+    options: RelayOptions;
+    environment: Environment;
+}
+export interface ValidationError {
+    type: string;
+    message: string;
+    path: string;
+}
+export interface ValidationResponse {
+    valid: boolean;
+    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 {};
+//# sourceMappingURL=validate.d.ts.map

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

@@ -0,0 +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"}

package/lib/types/version.d.ts

@@ -0,0 +1,2 @@
+export declare const version: string;
+//# sourceMappingURL=version.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["../../src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,EAAE,MAAkC,CAAC"}

package/package.json

@@ -1,7 +1,27 @@
 {
   "name": "@coveo/relay",
-  "version": "0.0.6",
+  "version": "0.1.0",
   "description": "A library for sending analytics events using Coveo's Event protocol.",
+  "files": [
+    "lib/**/*"
+  ],
+  "types": "./lib/types/relay.d.ts",
+  "exports": {
+    "node": {
+      "import": {
+        "types": "./lib/types/relay.d.ts",
+        "default": "./lib/relay.mjs"
+      },
+      "require": {
+        "types": "./lib/types/relay.d.ts",
+        "default": "./lib/relay.cjs"
+      }
+    },
+    "default": {
+      "types": "./lib/types/relay.d.ts",
+      "default": "./lib/relay.js"
+    }
+  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/coveo/relay.git"
@@ -18,17 +38,28 @@
   },
   "homepage": "https://github.com/coveo/relay#readme",
   "devDependencies": {
+    "@rollup/plugin-node-resolve": "^15.2.1",
+    "@rollup/plugin-replace": "^5.0.2",
+    "@rollup/plugin-typescript": "^11.1.2",
     "@types/jest": "^29.5.3",
+    "@types/uuid": "^9.0.2",
     "jest": "^29.6.2",
     "jest-environment-jsdom": "^29.6.2",
+    "rollup": "^3.28.0",
     "ts-jest": "^29.1.1",
     "typescript": "^5.1.6",
-    "eslint-config-custom": "0.0.6",
-    "tsconfig": "0.0.0"
+    "tsconfig": "0.0.0",
+    "eslint-config-custom": "0.0.0"
+  },
+  "dependencies": {
+    "uuid": "^9.0.0"
   },
   "scripts": {
+    "build": "npm run clean && rollup --config ./config/rollup.config.mjs",
+    "clean": "rm -rf ./lib",
     "test": "jest",
     "test:watch": "jest --watch",
-    "publish:npm": "node ./scripts/publish.mjs"
+    "npm:publish": "node ./scripts/publish.mjs",
+    "npm:tag": "node ./scripts/update-npm-tag.mjs"
   }
 }

package/CHANGELOG.md

@@ -1,4 +0,0 @@
-## 0.0.6 (2023-08-08)
-
-
-

package/jest.config.js

@@ -1,5 +0,0 @@
-/** @type {import('ts-jest').JestConfigWithTsJest} */
-module.exports = {
-  preset: "ts-jest",
-  testEnvironment: "node",
-};

package/scripts/publish.mjs

@@ -1,28 +0,0 @@
-import {context} from '@actions/github';
-import {
-  describeNpmTag,
-  getLastTag,
-  pnpmPublish,
-} from "@coveo/semantic-monorepo-tools";
-
-const VERSION_PREFIX = "@coveo/relay/v";
-
-const publishNpm = async () => {
-  try {
-    const refBranchName = context.payload.pull_request.head.ref;
-    const lastTag = await getLastTag(VERSION_PREFIX);
-    const version = lastTag.replace(VERSION_PREFIX, "");
-    const currentAlphaVersion = await describeNpmTag("@coveo/relay", "alpha");
-    console.info("The current version of the package is %s", version);
-    console.info("the describe npm tag is %s", currentAlphaVersion);
-
-    if (version > currentAlphaVersion) {
-      console.info("needs to publish");
-      await pnpmPublish(undefined, "alpha", refBranchName);
-    }
-  } catch (e) {
-    console.log(e);
-  }
-};
-
-publishNpm();

package/src/environment/browser/browser.test.ts

@@ -1,16 +0,0 @@
-/**
- * @jest-environment jsdom
- */
-
-import { buildBrowserEnvironment } from "./browser";
-
-describe("buildBrowserEnvironment", () => {
-  it("retrieves the referrer", () => {
-    Object.defineProperty(window.document, "referrer", {
-      value: "https://www.coveo.com/",
-    });
-    expect(buildBrowserEnvironment().getReferrer()).toBe(
-      "https://www.coveo.com/"
-    );
-  });
-});

package/src/environment/browser/browser.ts

@@ -1,7 +0,0 @@
-import { Environment } from "../environment";
-
-export function buildBrowserEnvironment(): Environment {
-  return {
-    getReferrer: () => document.referrer,
-  };
-}

package/src/environment/environment.ts

@@ -1,3 +0,0 @@
-export interface Environment {
-  getReferrer: () => string | null;
-}

package/src/environment/node/node.test.ts

@@ -1,7 +0,0 @@
-import { buildNodeEnvironment } from "./node";
-
-describe("buildNodeEnvironment", () => {
-  it("getReferrer returns null", () => {
-    expect(buildNodeEnvironment().getReferrer()).toBe(null);
-  });
-});

package/src/environment/node/node.ts

@@ -1,7 +0,0 @@
-import { Environment } from "../environment";
-
-export function buildNodeEnvironment(): Environment {
-  return {
-    getReferrer: () => null,
-  };
-}

package/tsconfig.json

@@ -1,5 +0,0 @@
-{
-  "extends": "tsconfig/base.json",
-  "include": ["**/*.ts"],
-  "exclude": ["node_modules"]
-}