@coveo/relay 0.3.2 → 0.3.3

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 +11 -22
  2. package/lib/relay.js +11 -22
  3. package/lib/relay.mjs +11 -22
  4. package/lib/types/event-api-call/event-api-caller.d.ts.map +1 -1
  5. package/lib/types/relay.d.ts +2 -3
  6. package/lib/types/relay.d.ts.map +1 -1
  7. package/lib/types/validate/validate.d.ts +0 -1
  8. package/lib/types/validate/validate.d.ts.map +1 -1
  9. package/package.json +1 -1
package/lib/relay.cjs CHANGED
@@ -16,7 +16,6 @@ async function callEventApi({ event, config, environment, }) {
16
16
  const data = await response.json();
17
17
  if (!response.ok) {
18
18
  throw new Error({
19
- responseType: "serviceError",
20
19
  ...data,
21
20
  });
22
21
  }
@@ -134,7 +133,7 @@ function isBrowser() {
134
133
  }
135
134
  }
136
135
 
137
- const version = "0.3.2" ;
136
+ const version = "0.3.3" ;
138
137
 
139
138
  function getEventConfig(config) {
140
139
  const { trackingId } = config;
@@ -166,12 +165,6 @@ function createRelayEvent(type, payload, config, environment, clientIdManager) {
166
165
  };
167
166
  }
168
167
 
169
- async function validate(params) {
170
- const data = await callEventApi(params);
171
- const { valid, errors } = data[0];
172
- return { valid, errors: errors ?? [], responseType: "validation" };
173
- }
174
-
175
168
  const ANY_EVENT_TYPE = "*";
176
169
  function createListenerManager() {
177
170
  const listeners = [];
@@ -246,29 +239,25 @@ function createConfigManager(initialConfig) {
246
239
  };
247
240
  }
248
241
 
242
+ async function validate(params) {
243
+ const data = await callEventApi(params);
244
+ const { valid, errors } = data[0];
245
+ return { valid, errors: errors ?? [] };
246
+ }
247
+
249
248
  function createRelay(initialConfig) {
250
249
  const environment = currentEnvironment();
251
250
  const clientIdManager = createClientIdManager(environment);
252
251
  const configManager = createConfigManager(initialConfig);
253
252
  const { add, call, remove } = createListenerManager();
254
253
  return {
255
- validate: (type, payload) => {
256
- const event = createRelayEvent(type, payload, configManager.get(), environment, clientIdManager);
257
- call(event);
258
- return validate({
259
- config: configManager.get(),
260
- environment,
261
- event,
262
- });
263
- },
264
254
  emit: (type, payload) => {
265
255
  const event = createRelayEvent(type, payload, configManager.get(), environment, clientIdManager);
266
256
  call(event);
267
- return emit({
268
- config: configManager.get(),
269
- environment,
270
- event,
271
- });
257
+ const params = { config: configManager.get(), environment, event };
258
+ return configManager.get().mode === "validate"
259
+ ? validate(params)
260
+ : emit(params);
272
261
  },
273
262
  getMeta: (type) => createMeta(type, configManager.get(), environment, clientIdManager),
274
263
  on: (type, callback) => add({ type, callback }),
package/lib/relay.js CHANGED
@@ -12,7 +12,6 @@ async function callEventApi({ event, config, environment, }) {
12
12
  const data = await response.json();
13
13
  if (!response.ok) {
14
14
  throw new Error({
15
- responseType: "serviceError",
16
15
  ...data,
17
16
  });
18
17
  }
@@ -138,7 +137,7 @@ function isBrowser() {
138
137
  }
139
138
  }
140
139
 
141
- const version = "0.3.2" ;
140
+ const version = "0.3.3" ;
142
141
 
143
142
  function getEventConfig(config) {
144
143
  const { trackingId } = config;
@@ -170,12 +169,6 @@ function createRelayEvent(type, payload, config, environment, clientIdManager) {
170
169
  };
171
170
  }
172
171
 
173
- async function validate(params) {
174
- const data = await callEventApi(params);
175
- const { valid, errors } = data[0];
176
- return { valid, errors: errors ?? [], responseType: "validation" };
177
- }
178
-
179
172
  const ANY_EVENT_TYPE = "*";
180
173
  function createListenerManager() {
181
174
  const listeners = [];
@@ -250,29 +243,25 @@ function createConfigManager(initialConfig) {
250
243
  };
251
244
  }
252
245
 
246
+ async function validate(params) {
247
+ const data = await callEventApi(params);
248
+ const { valid, errors } = data[0];
249
+ return { valid, errors: errors ?? [] };
250
+ }
251
+
253
252
  function createRelay(initialConfig) {
254
253
  const environment = currentEnvironment();
255
254
  const clientIdManager = createClientIdManager(environment);
256
255
  const configManager = createConfigManager(initialConfig);
257
256
  const { add, call, remove } = createListenerManager();
258
257
  return {
259
- validate: (type, payload) => {
260
- const event = createRelayEvent(type, payload, configManager.get(), environment, clientIdManager);
261
- call(event);
262
- return validate({
263
- config: configManager.get(),
264
- environment,
265
- event,
266
- });
267
- },
268
258
  emit: (type, payload) => {
269
259
  const event = createRelayEvent(type, payload, configManager.get(), environment, clientIdManager);
270
260
  call(event);
271
- return emit({
272
- config: configManager.get(),
273
- environment,
274
- event,
275
- });
261
+ const params = { config: configManager.get(), environment, event };
262
+ return configManager.get().mode === "validate"
263
+ ? validate(params)
264
+ : emit(params);
276
265
  },
277
266
  getMeta: (type) => createMeta(type, configManager.get(), environment, clientIdManager),
278
267
  on: (type, callback) => add({ type, callback }),
package/lib/relay.mjs CHANGED
@@ -14,7 +14,6 @@ async function callEventApi({ event, config, environment, }) {
14
14
  const data = await response.json();
15
15
  if (!response.ok) {
16
16
  throw new Error({
17
- responseType: "serviceError",
18
17
  ...data,
19
18
  });
20
19
  }
@@ -132,7 +131,7 @@ function isBrowser() {
132
131
  }
133
132
  }
134
133
 
135
- const version = "0.3.2" ;
134
+ const version = "0.3.3" ;
136
135
 
137
136
  function getEventConfig(config) {
138
137
  const { trackingId } = config;
@@ -164,12 +163,6 @@ function createRelayEvent(type, payload, config, environment, clientIdManager) {
164
163
  };
165
164
  }
166
165
 
167
- async function validate(params) {
168
- const data = await callEventApi(params);
169
- const { valid, errors } = data[0];
170
- return { valid, errors: errors ?? [], responseType: "validation" };
171
- }
172
-
173
166
  const ANY_EVENT_TYPE = "*";
174
167
  function createListenerManager() {
175
168
  const listeners = [];
@@ -244,29 +237,25 @@ function createConfigManager(initialConfig) {
244
237
  };
245
238
  }
246
239
 
240
+ async function validate(params) {
241
+ const data = await callEventApi(params);
242
+ const { valid, errors } = data[0];
243
+ return { valid, errors: errors ?? [] };
244
+ }
245
+
247
246
  function createRelay(initialConfig) {
248
247
  const environment = currentEnvironment();
249
248
  const clientIdManager = createClientIdManager(environment);
250
249
  const configManager = createConfigManager(initialConfig);
251
250
  const { add, call, remove } = createListenerManager();
252
251
  return {
253
- validate: (type, payload) => {
254
- const event = createRelayEvent(type, payload, configManager.get(), environment, clientIdManager);
255
- call(event);
256
- return validate({
257
- config: configManager.get(),
258
- environment,
259
- event,
260
- });
261
- },
262
252
  emit: (type, payload) => {
263
253
  const event = createRelayEvent(type, payload, configManager.get(), environment, clientIdManager);
264
254
  call(event);
265
- return emit({
266
- config: configManager.get(),
267
- environment,
268
- event,
269
- });
255
+ const params = { config: configManager.get(), environment, event };
256
+ return configManager.get().mode === "validate"
257
+ ? validate(params)
258
+ : emit(params);
270
259
  },
271
260
  getMeta: (type) => createMeta(type, configManager.get(), environment, clientIdManager),
272
261
  on: (type, callback) => add({ type, callback }),
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,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAClD,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAE/C,MAAM,WAAW,kBAAkB;IACjC,MAAM,EAAE,WAAW,CAAC;IACpB,WAAW,EAAE,WAAW,CAAC;IACzB,KAAK,EAAE,QAAQ,CAAC,UAAU,CAAC,CAAC;CAC7B;AAED,wBAAsB,YAAY,CAAC,EACjC,KAAK,EACL,MAAM,EACN,WAAW,GACZ,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,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAClD,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAE/C,MAAM,WAAW,kBAAkB;IACjC,MAAM,EAAE,WAAW,CAAC;IACpB,WAAW,EAAE,WAAW,CAAC;IACzB,KAAK,EAAE,QAAQ,CAAC,UAAU,CAAC,CAAC;CAC7B;AAED,wBAAsB,YAAY,CAAC,EACjC,KAAK,EACL,MAAM,EACN,WAAW,GACZ,EAAE,kBAAkB,GAAG,OAAO,CAAC,GAAG,CAAC,CA0BnC"}
package/lib/types/relay.d.ts CHANGED
@@ -1,12 +1,11 @@
1
- import { ValidationError, ValidationResponse } from "./validate/validate";
2
1
  import { Meta } from "./event/meta/meta";
3
2
  import { EventCallback } from "./listener/listener";
4
3
  import { RelayConfig } from "./config/config";
4
+ import { ValidationError, ValidationResponse } from "./validate/validate";
5
5
  type RelayPayload = Record<string, unknown>;
6
6
  type Off = () => void;
7
7
  interface Relay {
8
- validate: (type: string, payload: RelayPayload) => Promise<ValidationResponse>;
9
- emit: (type: string, payload: RelayPayload) => Promise<void>;
8
+ emit: (type: string, payload: RelayPayload) => Promise<void | ValidationResponse>;
10
9
  getMeta: (type: string) => Meta;
11
10
  on: (type: string, callback: EventCallback) => Off;
12
11
  off: (type: string, callback?: EventCallback) => void;
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;AACrD,OAAO,EAAyB,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAC3E,OAAO,EAAuB,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAEnE,KAAK,YAAY,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAC5C,KAAK,GAAG,GAAG,MAAM,IAAI,CAAC;AAEtB,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,YAAY,EAAE,CAAC,MAAM,EAAE,OAAO,CAAC,WAAW,CAAC,KAAK,IAAI,CAAC;IACrD,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,wBAAgB,WAAW,CAAC,aAAa,EAAE,WAAW,GAAG,KAAK,CAiD7D;AAED,YAAY,EAAE,YAAY,EAAE,WAAW,EAAE,eAAe,EAAE,kBAAkB,EAAE,CAAC"}
1
+ {"version":3,"file":"relay.d.ts","sourceRoot":"","sources":["../../src/relay.ts"],"names":[],"mappings":"AAKA,OAAO,EAAc,IAAI,EAAE,MAAM,mBAAmB,CAAC;AACrD,OAAO,EAAyB,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAC3E,OAAO,EAAuB,WAAW,EAAE,MAAM,iBAAiB,CAAC;AACnE,OAAO,EAEL,eAAe,EACf,kBAAkB,EACnB,MAAM,qBAAqB,CAAC;AAE7B,KAAK,YAAY,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAC5C,KAAK,GAAG,GAAG,MAAM,IAAI,CAAC;AAEtB,UAAU,KAAK;IACb,IAAI,EAAE,CACJ,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,YAAY,KAClB,OAAO,CAAC,IAAI,GAAG,kBAAkB,CAAC,CAAC;IACxC,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,YAAY,EAAE,CAAC,MAAM,EAAE,OAAO,CAAC,WAAW,CAAC,KAAK,IAAI,CAAC;IACrD,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,wBAAgB,WAAW,CAAC,aAAa,EAAE,WAAW,GAAG,KAAK,CAgC7D;AAED,YAAY,EAAE,YAAY,EAAE,WAAW,EAAE,eAAe,EAAE,kBAAkB,EAAE,CAAC"}
package/lib/types/validate/validate.d.ts CHANGED
@@ -6,7 +6,6 @@ export interface ValidationError {
6
6
  }
7
7
  export interface ValidationResponse {
8
8
  valid: boolean;
9
- responseType: "validation";
10
9
  errors: ValidationError[];
11
10
  }
12
11
  export declare function validate(params: EventApiCallParams): Promise<Readonly<ValidationResponse>>;
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,CAMvC"}
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,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.3.2",
3
+ "version": "0.3.3",
4
4
  "description": "A library for sending analytics events using Coveo's Event protocol.",
5
5
  "files": [
6
6
  "lib/**/*"