@coveo/relay 0.4.0 → 0.4.2

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 (11) hide show
  1. package/lib/relay.cjs +13 -8
  2. package/lib/relay.js +13 -8
  3. package/lib/relay.mjs +13 -8
  4. package/lib/types/config/config.d.ts +1 -2
  5. package/lib/types/config/config.d.ts.map +1 -1
  6. package/lib/types/environment/browser/browser.d.ts.map +1 -1
  7. package/lib/types/environment/node/node.d.ts.map +1 -1
  8. package/lib/types/environment/utils/fetch.d.ts +2 -0
  9. package/lib/types/environment/utils/fetch.d.ts.map +1 -0
  10. package/lib/types/event-api-call/event-api-caller.d.ts.map +1 -1
  11. package/package.json +1 -1
package/lib/relay.cjs CHANGED
@@ -3,12 +3,12 @@
3
3
  var crypto = require('crypto');
4
4
 
5
5
  async function callEventApi({ event, config, environment, }) {
6
- const { token, host, organizationId } = config;
6
+ const { url, token } = config;
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${config.mode == "validate" ? "/validate" : ""}`, {
11
+ const response = await environment.fetch(`${url}${config.mode == "validate" ? "/validate" : ""}`, {
12
12
  method: "POST",
13
13
  body: JSON.stringify([event]),
14
14
  headers,
@@ -153,6 +153,12 @@ function createBrowserStorage() {
153
153
  };
154
154
  }
155
155
 
156
+ async function fetchAPI(url, init) {
157
+ return fetch(url, init).catch((err) => {
158
+ throw new Error(`${err.message}: The "host" value is invalid or a network error occured, according to the FetchAPI's response.`, { cause: err });
159
+ });
160
+ }
161
+
156
162
  function getReferrerUrl() {
157
163
  const referrer = document.referrer;
158
164
  return referrer === "" ? null : referrer;
@@ -160,7 +166,7 @@ function getReferrerUrl() {
160
166
  function buildBrowserEnvironment() {
161
167
  return {
162
168
  runtime: "browser",
163
- fetch: (url, init) => fetch(url, init),
169
+ fetch: (url, init) => fetchAPI(url, init),
164
170
  getReferrerUrl: () => getReferrerUrl(),
165
171
  getUrl: () => window.location.href,
166
172
  getUserAgent: () => navigator.userAgent,
@@ -186,7 +192,7 @@ function createNullStorage() {
186
192
  function buildNodeEnvironment() {
187
193
  return {
188
194
  runtime: "node",
189
- fetch: (url, init) => fetch(url, init),
195
+ fetch: (url, init) => fetchAPI(url, init),
190
196
  getReferrerUrl: () => null,
191
197
  getUrl: () => null,
192
198
  getUserAgent: () => null,
@@ -207,7 +213,7 @@ function isBrowser() {
207
213
  }
208
214
  }
209
215
 
210
- const version = "0.4.0" ;
216
+ const version = "0.4.2" ;
211
217
 
212
218
  function getEventConfig(config) {
213
219
  const { trackingId } = config;
@@ -294,10 +300,9 @@ function createListenerManager() {
294
300
  };
295
301
  }
296
302
 
297
- function pick({ host, organizationId, token, trackingId, ...rest }) {
303
+ function pick({ url, token, trackingId, ...rest }) {
298
304
  return Object.freeze({
299
- host,
300
- organizationId,
305
+ url,
301
306
  token,
302
307
  trackingId,
303
308
  ...(!!rest.mode && { mode: rest.mode }),
package/lib/relay.js CHANGED
@@ -1,10 +1,10 @@
1
1
  async function callEventApi({ event, config, environment, }) {
2
- const { token, host, organizationId } = config;
2
+ const { url, token } = config;
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${config.mode == "validate" ? "/validate" : ""}`, {
7
+ const response = await environment.fetch(`${url}${config.mode == "validate" ? "/validate" : ""}`, {
8
8
  method: "POST",
9
9
  body: JSON.stringify([event]),
10
10
  headers,
@@ -157,6 +157,12 @@ function createBrowserStorage() {
157
157
  };
158
158
  }
159
159
 
160
+ async function fetchAPI(url, init) {
161
+ return fetch(url, init).catch((err) => {
162
+ throw new Error(`${err.message}: The "host" value is invalid or a network error occured, according to the FetchAPI's response.`, { cause: err });
163
+ });
164
+ }
165
+
160
166
  function getReferrerUrl() {
161
167
  const referrer = document.referrer;
162
168
  return referrer === "" ? null : referrer;
@@ -164,7 +170,7 @@ function getReferrerUrl() {
164
170
  function buildBrowserEnvironment() {
165
171
  return {
166
172
  runtime: "browser",
167
- fetch: (url, init) => fetch(url, init),
173
+ fetch: (url, init) => fetchAPI(url, init),
168
174
  getReferrerUrl: () => getReferrerUrl(),
169
175
  getUrl: () => window.location.href,
170
176
  getUserAgent: () => navigator.userAgent,
@@ -190,7 +196,7 @@ function createNullStorage() {
190
196
  function buildNodeEnvironment() {
191
197
  return {
192
198
  runtime: "node",
193
- fetch: (url, init) => fetch(url, init),
199
+ fetch: (url, init) => fetchAPI(url, init),
194
200
  getReferrerUrl: () => null,
195
201
  getUrl: () => null,
196
202
  getUserAgent: () => null,
@@ -211,7 +217,7 @@ function isBrowser() {
211
217
  }
212
218
  }
213
219
 
214
- const version = "0.4.0" ;
220
+ const version = "0.4.2" ;
215
221
 
216
222
  function getEventConfig(config) {
217
223
  const { trackingId } = config;
@@ -298,10 +304,9 @@ function createListenerManager() {
298
304
  };
299
305
  }
300
306
 
301
- function pick({ host, organizationId, token, trackingId, ...rest }) {
307
+ function pick({ url, token, trackingId, ...rest }) {
302
308
  return Object.freeze({
303
- host,
304
- organizationId,
309
+ url,
305
310
  token,
306
311
  trackingId,
307
312
  ...(!!rest.mode && { mode: rest.mode }),
package/lib/relay.mjs CHANGED
@@ -1,12 +1,12 @@
1
1
  import crypto from 'crypto';
2
2
 
3
3
  async function callEventApi({ event, config, environment, }) {
4
- const { token, host, organizationId } = config;
4
+ const { url, token } = config;
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${config.mode == "validate" ? "/validate" : ""}`, {
9
+ const response = await environment.fetch(`${url}${config.mode == "validate" ? "/validate" : ""}`, {
10
10
  method: "POST",
11
11
  body: JSON.stringify([event]),
12
12
  headers,
@@ -151,6 +151,12 @@ function createBrowserStorage() {
151
151
  };
152
152
  }
153
153
 
154
+ async function fetchAPI(url, init) {
155
+ return fetch(url, init).catch((err) => {
156
+ throw new Error(`${err.message}: The "host" value is invalid or a network error occured, according to the FetchAPI's response.`, { cause: err });
157
+ });
158
+ }
159
+
154
160
  function getReferrerUrl() {
155
161
  const referrer = document.referrer;
156
162
  return referrer === "" ? null : referrer;
@@ -158,7 +164,7 @@ function getReferrerUrl() {
158
164
  function buildBrowserEnvironment() {
159
165
  return {
160
166
  runtime: "browser",
161
- fetch: (url, init) => fetch(url, init),
167
+ fetch: (url, init) => fetchAPI(url, init),
162
168
  getReferrerUrl: () => getReferrerUrl(),
163
169
  getUrl: () => window.location.href,
164
170
  getUserAgent: () => navigator.userAgent,
@@ -184,7 +190,7 @@ function createNullStorage() {
184
190
  function buildNodeEnvironment() {
185
191
  return {
186
192
  runtime: "node",
187
- fetch: (url, init) => fetch(url, init),
193
+ fetch: (url, init) => fetchAPI(url, init),
188
194
  getReferrerUrl: () => null,
189
195
  getUrl: () => null,
190
196
  getUserAgent: () => null,
@@ -205,7 +211,7 @@ function isBrowser() {
205
211
  }
206
212
  }
207
213
 
208
- const version = "0.4.0" ;
214
+ const version = "0.4.2" ;
209
215
 
210
216
  function getEventConfig(config) {
211
217
  const { trackingId } = config;
@@ -292,10 +298,9 @@ function createListenerManager() {
292
298
  };
293
299
  }
294
300
 
295
- function pick({ host, organizationId, token, trackingId, ...rest }) {
301
+ function pick({ url, token, trackingId, ...rest }) {
296
302
  return Object.freeze({
297
- host,
298
- organizationId,
303
+ url,
299
304
  token,
300
305
  trackingId,
301
306
  ...(!!rest.mode && { mode: rest.mode }),
package/lib/types/config/config.d.ts CHANGED
@@ -1,7 +1,6 @@
1
1
  export type RelayMode = "emit" | "validate";
2
2
  export interface RelayConfig {
3
- host: string;
4
- organizationId: string;
3
+ url: string;
5
4
  token: string;
6
5
  trackingId: string;
7
6
  mode?: RelayMode;
package/lib/types/config/config.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../../src/config/config.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,SAAS,GAAG,MAAM,GAAG,UAAU,CAAC;AAE5C,MAAM,WAAW,WAAW;IAC1B,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,MAAM,WAAW,aAAa;IAC5B,GAAG,EAAE,MAAM,QAAQ,CAAC,WAAW,CAAC,CAAC;IACjC,MAAM,EAAE,CAAC,aAAa,EAAE,OAAO,CAAC,WAAW,CAAC,KAAK,IAAI,CAAC;CACvD;AAkBD,wBAAgB,mBAAmB,CACjC,aAAa,EAAE,WAAW,GACzB,QAAQ,CAAC,aAAa,CAAC,CASzB"}
1
+ {"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../../src/config/config.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,SAAS,GAAG,MAAM,GAAG,UAAU,CAAC;AAE5C,MAAM,WAAW,WAAW;IAC1B,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,CAAC,EAAE,SAAS,CAAC;CAClB;AAED,MAAM,WAAW,aAAa;IAC5B,GAAG,EAAE,MAAM,QAAQ,CAAC,WAAW,CAAC,CAAC;IACjC,MAAM,EAAE,CAAC,aAAa,EAAE,OAAO,CAAC,WAAW,CAAC,KAAK,IAAI,CAAC;CACvD;AAgBD,wBAAgB,mBAAmB,CACjC,aAAa,EAAE,WAAW,GACzB,QAAQ,CAAC,aAAa,CAAC,CASzB"}
package/lib/types/environment/browser/browser.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"browser.d.ts","sourceRoot":"","sources":["../../../../src/environment/browser/browser.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAS7C,wBAAgB,uBAAuB,IAAI,WAAW,CAUrD"}
1
+ {"version":3,"file":"browser.d.ts","sourceRoot":"","sources":["../../../../src/environment/browser/browser.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAU7C,wBAAgB,uBAAuB,IAAI,WAAW,CAUrD"}
package/lib/types/environment/node/node.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"node.d.ts","sourceRoot":"","sources":["../../../../src/environment/node/node.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAG7C,wBAAgB,oBAAoB,IAAI,WAAW,CAUlD"}
1
+ {"version":3,"file":"node.d.ts","sourceRoot":"","sources":["../../../../src/environment/node/node.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAI7C,wBAAgB,oBAAoB,IAAI,WAAW,CAUlD"}
package/lib/types/environment/utils/fetch.d.ts ADDED
@@ -0,0 +1,2 @@
1
+ export declare function fetchAPI(url: string, init?: RequestInit): Promise<Response>;
2
+ //# sourceMappingURL=fetch.d.ts.map
package/lib/types/environment/utils/fetch.d.ts.map ADDED
@@ -0,0 +1 @@
1
+ {"version":3,"file":"fetch.d.ts","sourceRoot":"","sources":["../../../../src/environment/utils/fetch.ts"],"names":[],"mappings":"AAAA,wBAAsB,QAAQ,CAC5B,GAAG,EAAE,MAAM,EACX,IAAI,CAAC,EAAE,WAAW,GACjB,OAAO,CAAC,QAAQ,CAAC,CAOnB"}
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,CA0BnC"}
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,CAwBnC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@coveo/relay",
3
- "version": "0.4.0",
3
+ "version": "0.4.2",
4
4
  "description": "A library for sending analytics events using Coveo's Event protocol.",
5
5
  "files": [
6
6
  "lib/**/*"