@coveo/relay 0.2.0 → 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (9) hide show
  1. package/lib/relay.cjs +3 -4
  2. package/lib/relay.js +3 -4
  3. package/lib/relay.mjs +3 -4
  4. package/lib/types/event-api-call/event-api-caller.d.ts +2 -2
  5. package/lib/types/event-api-call/event-api-caller.d.ts.map +1 -1
  6. package/lib/types/relay.d.ts +2 -0
  7. package/lib/types/relay.d.ts.map +1 -1
  8. package/lib/types/validate/validate.d.ts.map +1 -1
  9. package/package.json +3 -3
package/lib/relay.cjs CHANGED
@@ -2,13 +2,13 @@
2
2
 
3
3
  var crypto = require('crypto');
4
4
 
5
- async function callEventApi({ event, options, environment, validate, }) {
5
+ async function callEventApi({ event, options, environment, }) {
6
6
  const { token, host, organizationId } = options;
7
7
  const headers = {
8
8
  "Content-Type": "application/json",
9
9
  Authorization: `Bearer ${token}`,
10
10
  };
11
- const response = await environment.fetch(`${host}/rest/organizations/${organizationId}/events/v1${validate ? "/validate" : ""}`, {
11
+ const response = await environment.fetch(`${host}/rest/organizations/${organizationId}/events/v1${options.mode == "validate" ? "/validate" : ""}`, {
12
12
  method: "POST",
13
13
  body: JSON.stringify([event]),
14
14
  headers,
@@ -134,7 +134,7 @@ function isBrowser() {
134
134
  }
135
135
  }
136
136
 
137
- const version = "0.2.0" ;
137
+ const version = "0.3.0" ;
138
138
 
139
139
  function getConfig(options) {
140
140
  const { trackingId } = options;
@@ -167,7 +167,6 @@ function createRelayEvent(type, payload, options, environment, clientIdManager)
167
167
  }
168
168
 
169
169
  async function validate(params) {
170
- params.validate = true;
171
170
  const data = await callEventApi(params);
172
171
  const { valid, errors } = data[0];
173
172
  return { valid, errors: errors ?? [], responseType: "validation" };
package/lib/relay.js CHANGED
@@ -1,10 +1,10 @@
1
- async function callEventApi({ event, options, environment, validate, }) {
1
+ async function callEventApi({ event, options, environment, }) {
2
2
  const { token, host, organizationId } = options;
3
3
  const headers = {
4
4
  "Content-Type": "application/json",
5
5
  Authorization: `Bearer ${token}`,
6
6
  };
7
- const response = await environment.fetch(`${host}/rest/organizations/${organizationId}/events/v1${validate ? "/validate" : ""}`, {
7
+ const response = await environment.fetch(`${host}/rest/organizations/${organizationId}/events/v1${options.mode == "validate" ? "/validate" : ""}`, {
8
8
  method: "POST",
9
9
  body: JSON.stringify([event]),
10
10
  headers,
@@ -138,7 +138,7 @@ function isBrowser() {
138
138
  }
139
139
  }
140
140
 
141
- const version = "0.2.0" ;
141
+ const version = "0.3.0" ;
142
142
 
143
143
  function getConfig(options) {
144
144
  const { trackingId } = options;
@@ -171,7 +171,6 @@ function createRelayEvent(type, payload, options, environment, clientIdManager)
171
171
  }
172
172
 
173
173
  async function validate(params) {
174
- params.validate = true;
175
174
  const data = await callEventApi(params);
176
175
  const { valid, errors } = data[0];
177
176
  return { valid, errors: errors ?? [], responseType: "validation" };
package/lib/relay.mjs CHANGED
@@ -1,12 +1,12 @@
1
1
  import crypto from 'crypto';
2
2
 
3
- async function callEventApi({ event, options, environment, validate, }) {
3
+ async function callEventApi({ event, options, environment, }) {
4
4
  const { token, host, organizationId } = options;
5
5
  const headers = {
6
6
  "Content-Type": "application/json",
7
7
  Authorization: `Bearer ${token}`,
8
8
  };
9
- const response = await environment.fetch(`${host}/rest/organizations/${organizationId}/events/v1${validate ? "/validate" : ""}`, {
9
+ const response = await environment.fetch(`${host}/rest/organizations/${organizationId}/events/v1${options.mode == "validate" ? "/validate" : ""}`, {
10
10
  method: "POST",
11
11
  body: JSON.stringify([event]),
12
12
  headers,
@@ -132,7 +132,7 @@ function isBrowser() {
132
132
  }
133
133
  }
134
134
 
135
- const version = "0.2.0" ;
135
+ const version = "0.3.0" ;
136
136
 
137
137
  function getConfig(options) {
138
138
  const { trackingId } = options;
@@ -165,7 +165,6 @@ function createRelayEvent(type, payload, options, environment, clientIdManager)
165
165
  }
166
166
 
167
167
  async function validate(params) {
168
- params.validate = true;
169
168
  const data = await callEventApi(params);
170
169
  const { valid, errors } = data[0];
171
170
  return { valid, errors: errors ?? [], responseType: "validation" };
package/lib/types/event-api-call/event-api-caller.d.ts CHANGED
@@ -5,7 +5,7 @@ export interface EventApiCallParams {
5
5
  event: Readonly<RelayEvent>;
6
6
  options: RelayOptions;
7
7
  environment: Environment;
8
- validate?: boolean;
9
8
  }
10
- export declare function callEventApi({ event, options, environment, validate, }: EventApiCallParams): Promise<any>;
9
+ export type RelayMode = "emit" | "validate";
10
+ export declare function callEventApi({ event, options, environment, }: EventApiCallParams): Promise<any>;
11
11
  //# sourceMappingURL=event-api-caller.d.ts.map
package/lib/types/event-api-call/event-api-caller.d.ts.map CHANGED
@@ -1 +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;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"}
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"}
package/lib/types/relay.d.ts CHANGED
@@ -1,4 +1,5 @@
1
1
  import { ValidationError, ValidationResponse } from "./validate/validate";
2
+ import { RelayMode } from "./event-api-call/event-api-caller";
2
3
  import { Meta } from "./event/meta/meta";
3
4
  type RelayPayload = Record<string, unknown>;
4
5
  interface RelayOptions {
@@ -6,6 +7,7 @@ interface RelayOptions {
6
7
  organizationId: string;
7
8
  token: string;
8
9
  trackingId: string;
10
+ mode?: RelayMode;
9
11
  }
10
12
  interface Relay {
11
13
  validate: (type: string, payload: RelayPayload) => Promise<ValidationResponse>;
package/lib/types/relay.d.ts.map CHANGED
@@ -1 +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,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"}
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"}
package/lib/types/validate/validate.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"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"}
1
+ {"version":3,"file":"validate.d.ts","sourceRoot":"","sources":["../../../src/validate/validate.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,kBAAkB,EAEnB,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,CAMvC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@coveo/relay",
3
- "version": "0.2.0",
3
+ "version": "0.3.0",
4
4
  "description": "A library for sending analytics events using Coveo's Event protocol.",
5
5
  "files": [
6
6
  "lib/**/*"
@@ -48,8 +48,8 @@
48
48
  "rollup": "^3.28.0",
49
49
  "ts-jest": "^29.1.1",
50
50
  "typescript": "^5.1.6",
51
- "tsconfig": "0.0.0",
52
- "eslint-config-custom": "0.0.0"
51
+ "eslint-config-custom": "0.0.0",
52
+ "tsconfig": "0.0.0"
53
53
  },
54
54
  "dependencies": {
55
55
  "uuid": "^9.0.0"