feat: expose version string from functional interface (#413)

lib/__tests__/_createInsightsClient.test.ts

@@ -1,4 +1,5 @@
 import { createInsightsClient } from "../_createInsightsClient";
+import { version } from "../../package.json";
 
 describe("createInsightsClient", () => {
   beforeEach(() => {
@@ -9,6 +10,12 @@ describe("createInsightsClient", () => {
     expect(typeof createInsightsClient(() => {})).toBe("function");
   });
 
+  it("returns its version number", () => {
+    const aa = createInsightsClient(() => {});
+
+    expect(aa.version).toEqual(version);
+  });
+
   it("registers itself to window", () => {
     const aa = createInsightsClient(() => {});
 

lib/_createInsightsClient.ts

@@ -2,6 +2,7 @@ import AlgoliaAnalytics from './insights';
 import { getFunctionalInterface } from './_getFunctionalInterface';
 import { RequestFnType } from './utils/request';
 import { createUUID } from './utils/uuid';
+import { version } from '../package.json';
 
 export function createInsightsClient(requestFn: RequestFnType) {
   const aa = getFunctionalInterface(new AlgoliaAnalytics({ requestFn }));
@@ -17,5 +18,7 @@ export function createInsightsClient(requestFn: RequestFnType) {
     }
   }
 
+  aa.version = version;
+
   return aa;
 }

lib/entry-umd.ts

@@ -2,13 +2,16 @@ import AlgoliaAnalytics from "./insights";
 import { getRequesterForBrowser } from "./utils/getRequesterForBrowser";
 import { processQueue } from "./_processQueue";
 import { RequestFnType } from "./utils/request";
+import { version } from "../package.json";
 
 export function createInsightsClient(requestFn: RequestFnType) {
   const instance = new AlgoliaAnalytics({ requestFn });
-  if (typeof window === 'object') {
+  if (typeof window === "object") {
     // Process queue upon script execution
     processQueue.call(instance, window);
   }
+
+  instance.version = version;
   return instance;
 }
 

lib/types.ts

@@ -72,10 +72,10 @@ export type ViewedFilters = MethodType<"viewedFilters">;
 
 export type SendEvents = MethodType<"sendEvents">;
 
-export type InsightsClient = <MethodName extends keyof InsightsMethodMap>(
+export type InsightsClient = (<MethodName extends keyof InsightsMethodMap>(
   method: MethodName,
   ...args: InsightsMethodMap[MethodName]
-) => void;
+) => void) & { version?: string };
 
 export type InsightsEventType = "click" | "conversion" | "view";
 

package.json

@@ -128,7 +128,7 @@
   "bundlesize": [
     {
       "path": "./dist/search-insights.min.js",
-      "maxSize": "2.75 kB"
+      "maxSize": "2.80 kB"
     }
   ]
 }