coveo.analytics 2.27.9 → 2.27.11

package/dist/definitions/client/analytics.d.ts

@@ -10,6 +10,7 @@ export declare const Endpoints: {
 export interface ClientOptions {
     token?: string;
     endpoint: string;
+    isCustomEndpoint?: boolean;
     version: string;
     runtimeEnvironment?: IRuntimeEnvironment;
     beforeSendHooks: AnalyticsClientSendEventHook[];
@@ -55,7 +56,7 @@ export interface BufferedRequest {
     eventType: EventType;
     payload: any;
 }
-export declare function buildBaseUrl(endpoint?: string, apiVersion?: string): string;
+export declare function buildBaseUrl(endpoint?: string, apiVersion?: string, isCustomEndpoint?: boolean): string;
 export declare class CoveoAnalyticsClient implements AnalyticsClient, VisitorIdProvider {
     private get defaultOptions();
     runtime: IRuntimeEnvironment;

package/dist/definitions/coveoua/simpleanalytics.d.ts

@@ -5,6 +5,7 @@ import { PluginClass } from '../plugins/BasePlugin';
 export type AvailableActions = keyof CoveoUA;
 export interface CoveoUAOptions {
     endpoint?: string;
+    isCustomEndpoint?: boolean;
     plugins?: string[];
 }
 export declare class CoveoUA {
@@ -15,7 +16,8 @@ export declare class CoveoUA {
     private isAnalyticsClient;
     private getPluginKeys;
     private getEndpoint;
-    initForProxy(endpoint: string): void;
+    private getIsCustomEndpoint;
+    initForProxy(endpoint: string, isCustomEndpoint?: boolean): void;
     set(keyOrObject: string | any, value: string): void;
     send(...[event, ...payload]: SendEventArguments): Promise<AnyEventResponse | void>;
     onLoad(callback: Function): void;

package/dist/definitions/src/coveoua/simpleanalytics.d.ts

@@ -5,6 +5,7 @@ import { PluginClass } from '../plugins/BasePlugin';
 export type AvailableActions = keyof CoveoUA;
 export interface CoveoUAOptions {
     endpoint?: string;
+    isCustomEndpoint?: boolean;
     plugins?: string[];
 }
 export declare class CoveoUA {
@@ -15,7 +16,8 @@ export declare class CoveoUA {
     private isAnalyticsClient;
     private getPluginKeys;
     private getEndpoint;
-    initForProxy(endpoint: string): void;
+    private getIsCustomEndpoint;
+    initForProxy(endpoint: string, isCustomEndpoint?: boolean): void;
     set(keyOrObject: string | any, value: string): void;
     send(...[event, ...payload]: SendEventArguments): Promise<AnyEventResponse | void>;
     onLoad(callback: Function): void;

package/dist/definitions/version.d.ts

@@ -1 +1 @@
-export declare const libVersion = "2.27.9";
+export declare const libVersion = "2.27.11";

package/dist/library.es.js

@@ -596,7 +596,7 @@ function sha1(bytes) {
 const v5 = v35('v5', 0x50, sha1);
 var uuidv5 = v5;
 
-const libVersion = "2.27.9" ;
+const libVersion = "2.27.11" ;
 
 const getFormattedLocation = (location) => `${location.protocol}//${location.hostname}${location.pathname.indexOf('/') === 0 ? location.pathname : `/${location.pathname}`}${location.search}`;
 
@@ -1204,15 +1204,20 @@ const Endpoints = {
     production: 'https://analytics.cloud.coveo.com/rest/ua',
     hipaa: 'https://analyticshipaa.cloud.coveo.com/rest/ua',
 };
-function buildBaseUrl(endpoint = Endpoints.default, apiVersion = Version) {
-    const endpointIsCoveoProxy = endpoint.indexOf('.cloud.coveo.com') !== -1;
-    return `${endpoint}${endpointIsCoveoProxy ? '' : '/rest'}/${apiVersion}`;
+function buildBaseUrl(endpoint = Endpoints.default, apiVersion = Version, isCustomEndpoint = false) {
+    endpoint = endpoint.replace(/\/$/, '');
+    if (isCustomEndpoint) {
+        return `${endpoint}/${apiVersion}`;
+    }
+    const hasUARestEndpoint = endpoint.endsWith('/rest') || endpoint.endsWith('/rest/ua');
+    return `${endpoint}${hasUARestEndpoint ? '' : '/rest'}/${apiVersion}`;
 }
 const COVEO_NAMESPACE = '38824e1f-37f5-42d3-8372-a4b8fa9df946';
 class CoveoAnalyticsClient {
     get defaultOptions() {
         return {
             endpoint: Endpoints.default,
+            isCustomEndpoint: false,
             token: '',
             version: Version,
             beforeSendHooks: [],
@@ -1622,7 +1627,7 @@ class CoveoAnalyticsClient {
         return input.substring(0, length);
     }
     get baseUrl() {
-        return buildBaseUrl(this.options.endpoint, this.options.version);
+        return buildBaseUrl(this.options.endpoint, this.options.version, this.options.isCustomEndpoint);
     }
 }
 

package/dist/library.js

@@ -731,7 +731,7 @@ function sha1(bytes) {
 const v5 = v35('v5', 0x50, sha1);
 var uuidv5 = v5;
 
-var libVersion = "2.27.9" ;
+var libVersion = "2.27.11" ;
 
 var getFormattedLocation = function (location) {
     return "".concat(location.protocol, "//").concat(location.hostname).concat(location.pathname.indexOf('/') === 0 ? location.pathname : "/".concat(location.pathname)).concat(location.search);
@@ -82996,11 +82996,16 @@ var Endpoints = {
     production: 'https://analytics.cloud.coveo.com/rest/ua',
     hipaa: 'https://analyticshipaa.cloud.coveo.com/rest/ua',
 };
-function buildBaseUrl(endpoint, apiVersion) {
+function buildBaseUrl(endpoint, apiVersion, isCustomEndpoint) {
     if (endpoint === void 0) { endpoint = Endpoints.default; }
     if (apiVersion === void 0) { apiVersion = Version; }
-    var endpointIsCoveoProxy = endpoint.indexOf('.cloud.coveo.com') !== -1;
-    return "".concat(endpoint).concat(endpointIsCoveoProxy ? '' : '/rest', "/").concat(apiVersion);
+    if (isCustomEndpoint === void 0) { isCustomEndpoint = false; }
+    endpoint = endpoint.replace(/\/$/, '');
+    if (isCustomEndpoint) {
+        return "".concat(endpoint, "/").concat(apiVersion);
+    }
+    var hasUARestEndpoint = endpoint.endsWith('/rest') || endpoint.endsWith('/rest/ua');
+    return "".concat(endpoint).concat(hasUARestEndpoint ? '' : '/rest', "/").concat(apiVersion);
 }
 var COVEO_NAMESPACE = '38824e1f-37f5-42d3-8372-a4b8fa9df946';
 var CoveoAnalyticsClient = (function () {
@@ -83031,6 +83036,7 @@ var CoveoAnalyticsClient = (function () {
         get: function () {
             return {
                 endpoint: Endpoints.default,
+                isCustomEndpoint: false,
                 token: '',
                 version: Version,
                 beforeSendHooks: [],
@@ -83664,7 +83670,7 @@ var CoveoAnalyticsClient = (function () {
     };
     Object.defineProperty(CoveoAnalyticsClient.prototype, "baseUrl", {
         get: function () {
-            return buildBaseUrl(this.options.endpoint, this.options.version);
+            return buildBaseUrl(this.options.endpoint, this.options.version, this.options.isCustomEndpoint);
         },
         enumerable: false,
         configurable: true
@@ -83976,6 +83982,7 @@ var CoveoUA = (function () {
             this.client = new CoveoAnalyticsClient({
                 token: token,
                 endpoint: this.getEndpoint(optionsOrEndpoint),
+                isCustomEndpoint: this.getIsCustomEndpoint(optionsOrEndpoint),
             });
         }
         else if (this.isAnalyticsClient(token)) {
@@ -84012,7 +84019,17 @@ var CoveoUA = (function () {
         }
         return Endpoints.default;
     };
-    CoveoUA.prototype.initForProxy = function (endpoint) {
+    CoveoUA.prototype.getIsCustomEndpoint = function (optionsOrEndpoint) {
+        if (typeof optionsOrEndpoint === 'string') {
+            return false;
+        }
+        else if (optionsOrEndpoint === null || optionsOrEndpoint === void 0 ? void 0 : optionsOrEndpoint.isCustomEndpoint) {
+            return optionsOrEndpoint.isCustomEndpoint;
+        }
+        return false;
+    };
+    CoveoUA.prototype.initForProxy = function (endpoint, isCustomEndpoint) {
+        if (isCustomEndpoint === void 0) { isCustomEndpoint = false; }
         if (!endpoint) {
             throw new Error("You must pass your endpoint when you call 'initForProxy'");
         }
@@ -84021,6 +84038,7 @@ var CoveoUA = (function () {
         }
         this.client = new CoveoAnalyticsClient({
             endpoint: endpoint,
+            isCustomEndpoint: isCustomEndpoint,
         });
     };
     CoveoUA.prototype.set = function (keyOrObject, value) {

package/dist/react-native.es.js

@@ -658,7 +658,7 @@ const addPageViewToHistory = (pageViewValue) => __awaiter(void 0, void 0, void 0
     yield store.addElementAsync(historyElement);
 });
 
-const libVersion = "2.27.9" ;
+const libVersion = "2.27.11" ;
 
 const getFormattedLocation = (location) => `${location.protocol}//${location.hostname}${location.pathname.indexOf('/') === 0 ? location.pathname : `/${location.pathname}`}${location.search}`;
 
@@ -1205,15 +1205,20 @@ const Endpoints = {
     production: 'https://analytics.cloud.coveo.com/rest/ua',
     hipaa: 'https://analyticshipaa.cloud.coveo.com/rest/ua',
 };
-function buildBaseUrl(endpoint = Endpoints.default, apiVersion = Version) {
-    const endpointIsCoveoProxy = endpoint.indexOf('.cloud.coveo.com') !== -1;
-    return `${endpoint}${endpointIsCoveoProxy ? '' : '/rest'}/${apiVersion}`;
+function buildBaseUrl(endpoint = Endpoints.default, apiVersion = Version, isCustomEndpoint = false) {
+    endpoint = endpoint.replace(/\/$/, '');
+    if (isCustomEndpoint) {
+        return `${endpoint}/${apiVersion}`;
+    }
+    const hasUARestEndpoint = endpoint.endsWith('/rest') || endpoint.endsWith('/rest/ua');
+    return `${endpoint}${hasUARestEndpoint ? '' : '/rest'}/${apiVersion}`;
 }
 const COVEO_NAMESPACE = '38824e1f-37f5-42d3-8372-a4b8fa9df946';
 class CoveoAnalyticsClient {
     get defaultOptions() {
         return {
             endpoint: Endpoints.default,
+            isCustomEndpoint: false,
             token: '',
             version: Version,
             beforeSendHooks: [],
@@ -1623,7 +1628,7 @@ class CoveoAnalyticsClient {
         return input.substring(0, length);
     }
     get baseUrl() {
-        return buildBaseUrl(this.options.endpoint, this.options.version);
+        return buildBaseUrl(this.options.endpoint, this.options.version, this.options.isCustomEndpoint);
     }
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "coveo.analytics",
-    "version": "2.27.9",
+    "version": "2.27.11",
     "description": "📈 Coveo analytics client (node and browser compatible) ",
     "main": "dist/library.js",
     "module": "dist/library.es.js",

package/src/client/analytics.spec.ts

@@ -1,4 +1,4 @@
-import {EventType, ViewEventRequest, DefaultEventResponse} from '../events';
+import {DefaultEventResponse, EventType, ViewEventRequest} from '../events';
 import {CoveoAnalyticsClient} from './analytics';
 import {IAnalyticsRequestOptions} from './analyticsRequestClient';
 import {CookieAndLocalStorage, CookieStorage, NullStorage} from '../storage';
@@ -58,6 +58,77 @@ describe('Analytics', () => {
         });
     });
 
+    it('should add /rest if not present in endpoint', async () => {
+        const legacyEndpoint = 'https://usageanalytics.com';
+
+        client = new CoveoAnalyticsClient({
+            token: aToken,
+            endpoint: legacyEndpoint,
+            version: A_VERSION,
+        });
+
+        fetchMock.post(endpointForEventType(EventType.custom, `${legacyEndpoint}/rest`), eventResponse);
+        const response = await client.sendEvent(EventType.custom);
+        expect(response).toEqual(eventResponse);
+    });
+
+    it('should not add /rest if /rest present in endpoint', async () => {
+        const legacyEndpoint = 'https://usageanalytics.com/rest';
+
+        client = new CoveoAnalyticsClient({
+            token: aToken,
+            endpoint: legacyEndpoint,
+            version: A_VERSION,
+        });
+
+        fetchMock.post(endpointForEventType(EventType.custom, legacyEndpoint), eventResponse);
+        const response = await client.sendEvent(EventType.custom);
+        expect(response).toEqual(eventResponse);
+    });
+
+    it('should not add /rest if /rest/ua present in endpoint', async () => {
+        const legacyEndpoint = 'https://usageanalytics.com/rest/ua';
+
+        client = new CoveoAnalyticsClient({
+            token: aToken,
+            endpoint: legacyEndpoint,
+            version: A_VERSION,
+        });
+
+        fetchMock.post(endpointForEventType(EventType.custom, legacyEndpoint), eventResponse);
+        const response = await client.sendEvent(EventType.custom);
+        expect(response).toEqual(eventResponse);
+    });
+
+    it('should remove trailing slash in endpoint', async () => {
+        const legacyEndpoint = 'https://usageanalytics.com';
+
+        client = new CoveoAnalyticsClient({
+            token: aToken,
+            endpoint: legacyEndpoint + '/',
+            version: A_VERSION,
+        });
+
+        fetchMock.post(endpointForEventType(EventType.custom, `${legacyEndpoint}/rest`), eventResponse);
+        const response = await client.sendEvent(EventType.custom);
+        expect(response).toEqual(eventResponse);
+    });
+
+    it('should allow reverse-proxy endpoint', async () => {
+        const aReverseProxyEndpoint = 'https://12364734.cloudfront.net/analytics';
+
+        client = new CoveoAnalyticsClient({
+            token: aToken,
+            endpoint: aReverseProxyEndpoint,
+            isCustomEndpoint: true,
+            version: A_VERSION,
+        });
+
+        fetchMock.post(endpointForEventType(EventType.custom, aReverseProxyEndpoint), eventResponse);
+        const response = await client.sendEvent(EventType.custom);
+        expect(response).toEqual(eventResponse);
+    });
+
     it('should call fetch with the parameters', async () => {
         mockFetchRequestForEventType(EventType.view);
 

package/src/client/analytics.ts

@@ -49,6 +49,7 @@ export const Endpoints = {
 export interface ClientOptions {
     token?: string;
     endpoint: string;
+    isCustomEndpoint?: boolean;
     version: string;
     runtimeEnvironment?: IRuntimeEnvironment;
     beforeSendHooks: AnalyticsClientSendEventHook[];
@@ -117,9 +118,16 @@ export interface BufferedRequest {
 type ProcessPayloadStep = (currentPayload: any) => any;
 type AsyncProcessPayloadStep = (currentPayload: any) => Promise<any>;
 
-export function buildBaseUrl(endpoint = Endpoints.default, apiVersion = Version) {
-    const endpointIsCoveoProxy = endpoint.indexOf('.cloud.coveo.com') !== -1;
-    return `${endpoint}${endpointIsCoveoProxy ? '' : '/rest'}/${apiVersion}`;
+export function buildBaseUrl(endpoint = Endpoints.default, apiVersion = Version, isCustomEndpoint = false) {
+    endpoint = endpoint.replace(/\/$/, ''); // Remove trailing slash in endpoint.
+
+    if (isCustomEndpoint) {
+        return `${endpoint}/${apiVersion}`;
+    }
+
+    const hasUARestEndpoint = endpoint.endsWith('/rest') || endpoint.endsWith('/rest/ua');
+
+    return `${endpoint}${hasUARestEndpoint ? '' : '/rest'}/${apiVersion}`;
 }
 
 // Note: Changing this value will destroy the mapping from tracking string to clientId for all customers
@@ -131,6 +139,7 @@ export class CoveoAnalyticsClient implements AnalyticsClient, VisitorIdProvider
     private get defaultOptions(): ClientOptions {
         return {
             endpoint: Endpoints.default,
+            isCustomEndpoint: false,
             token: '',
             version: Version,
             beforeSendHooks: [],
@@ -622,7 +631,7 @@ export class CoveoAnalyticsClient implements AnalyticsClient, VisitorIdProvider
     }
 
     private get baseUrl(): string {
-        return buildBaseUrl(this.options.endpoint, this.options.version);
+        return buildBaseUrl(this.options.endpoint, this.options.version, this.options.isCustomEndpoint);
     }
 }
 

package/src/coveoua/simpleanalytics.ts

@@ -9,6 +9,7 @@ export type AvailableActions = keyof CoveoUA;
 
 export interface CoveoUAOptions {
     endpoint?: string;
+    isCustomEndpoint?: boolean;
     plugins?: string[];
 }
 
@@ -31,6 +32,7 @@ export class CoveoUA {
             this.client = new CoveoAnalyticsClient({
                 token: token,
                 endpoint: this.getEndpoint(optionsOrEndpoint),
+                isCustomEndpoint: this.getIsCustomEndpoint(optionsOrEndpoint),
             });
         } else if (this.isAnalyticsClient(token)) {
             this.client = token;
@@ -72,9 +74,18 @@ export class CoveoUA {
         return Endpoints.default;
     }
 
+    private getIsCustomEndpoint(optionsOrEndpoint: string | CoveoUAOptions) {
+        if (typeof optionsOrEndpoint === 'string') {
+            return false;
+        } else if (optionsOrEndpoint?.isCustomEndpoint) {
+            return optionsOrEndpoint.isCustomEndpoint;
+        }
+        return false;
+    }
+
     // init initializes a new client intended to be used with a proxy that injects the access token.
     // @param endpoint is the endpoint of your proxy.
-    initForProxy(endpoint: string): void {
+    initForProxy(endpoint: string, isCustomEndpoint = false): void {
         if (!endpoint) {
             throw new Error(`You must pass your endpoint when you call 'initForProxy'`);
         }
@@ -85,6 +96,7 @@ export class CoveoUA {
 
         this.client = new CoveoAnalyticsClient({
             endpoint: endpoint,
+            isCustomEndpoint: isCustomEndpoint,
         });
     }