Add support for upsert and retrieve for analytics rules

Author: jasonbosco

dist/typesense.js

@@ -1,12 +1,14 @@
 /*
- These examples walk you through key management operations.
+ These examples walk you through how to use search suggestions in Typesense.
 
  See clientInitalization.js for quick instructions on starting the Typesense server.
 */
-require("@babel/register");
+import "@babel/register";
+/* eslint-disable @typescript-eslint/no-var-requires */
+import Typesense from "../../../lib/Typesense.js";
 
-// eslint-disable-next-line @typescript-eslint/no-var-requires
-const Typesense = require("../../../lib/Typesense");
+// import axios from "axios";
+// import curlirize from "axios-curlirize";
 
 const masterApiKey = "xyz";
 
@@ -21,6 +23,8 @@ const typesense = new Typesense.Client({
   apiKey: masterApiKey,
 });
 
+// curlirize(axios);
+
 async function runExample() {
   await deleteDataFromPreviousRuns();
   try {
@@ -45,9 +49,8 @@ async function runExample() {
       ],
     });
 
-    // Create a rule to capture top queries
-    result = await typesense.analytics.rules().create({
-      name: "search_suggestions",
+    // Upsert a rule to capture top queries
+    result = await typesense.analytics.rules().upsert("search_suggestions", {
       type: "popular_queries",
       params: {
         source: { collections: ["products"] },
@@ -57,10 +60,27 @@ async function runExample() {
     });
     console.dir(result);
 
+    // This will result in any search terms sent to the `products` to be logged in the `products_top_queries` along with a count of how many times it was searched for.
+
     // Retrieve all rules
     result = await typesense.analytics.rules().retrieve();
     console.dir(result);
 
+    // Update the limit in the rule
+    result = await typesense.analytics.rules().upsert("search_suggestions", {
+      type: "popular_queries",
+      params: {
+        source: { collections: ["products"] },
+        destination: { collection: "products_top_queries" },
+      },
+      limit: 10,
+    });
+    console.dir(result);
+
+    // Retrieve a single rule
+    result = await typesense.analytics.rules("search_suggestions").retrieve();
+    console.dir(result);
+
     // Delete rule
     result = await typesense.analytics.rules("search_suggestions").delete();
     console.dir(result);

dist/typesense.min.js

@@ -1,6 +1,5 @@
 import ApiCall from "./ApiCall";
 export interface AnalyticsRuleCreateSchema {
-    name: string;
     type: "popular_queries";
     params: {
         source: {
@@ -22,6 +21,7 @@ export default class AnalyticsRule {
     private name;
     private apiCall;
     constructor(name: string, apiCall: ApiCall);
+    retrieve(): Promise<AnalyticsRuleSchema>;
     delete(): Promise<AnalyticsRuleDeleteSchema>;
     private endpointPath;
 }

dist/typesense.min.js.map

@@ -6,7 +6,8 @@ export interface AnalyticsRulesRetrieveSchema {
 export default class AnalyticsRules {
     private readonly apiCall;
     constructor(apiCall: ApiCall);
-    create(schema: AnalyticsRuleCreateSchema): Promise<AnalyticsRuleCreateSchema>;
+    upsert(name: string, params: AnalyticsRuleCreateSchema): Promise<AnalyticsRuleCreateSchema>;
     retrieve(): Promise<AnalyticsRulesRetrieveSchema>;
+    private endpointPath;
     static get RESOURCEPATH(): string;
 }

doc/examples/server/searchSuggestions.js renamed to doc/examples/server/searchSuggestions.mjs

@@ -51,6 +51,7 @@
     "@types/node": "^17.0.21",
     "@typescript-eslint/eslint-plugin": "^5.61.0",
     "@typescript-eslint/parser": "^5.61.0",
+    "axios-curlirize": "^2.0.0",
     "axios-mock-adapter": "^1.20.0",
     "babel-plugin-istanbul": "^6.1.1",
     "babelify": "^10.0.0",

lib/Typesense/AnalyticsRule.d.ts

@@ -2,7 +2,6 @@ import ApiCall from "./ApiCall";
 import AnalyticsRules from "./AnalyticsRules";
 
 export interface AnalyticsRuleCreateSchema {
-  name: string;
   type: "popular_queries";
   params: {
     source: {
@@ -26,6 +25,10 @@ export interface AnalyticsRuleSchema extends AnalyticsRuleCreateSchema {
 export default class AnalyticsRule {
   constructor(private name: string, private apiCall: ApiCall) {}
 
+  async retrieve(): Promise<AnalyticsRuleSchema> {
+    return this.apiCall.get<AnalyticsRuleSchema>(this.endpointPath());
+  }
+
   async delete(): Promise<AnalyticsRuleDeleteSchema> {
     return this.apiCall.delete<AnalyticsRuleDeleteSchema>(this.endpointPath());
   }

lib/Typesense/AnalyticsRule.js

@@ -15,14 +15,24 @@ export default class AnalyticsRules {
     this.apiCall = apiCall;
   }
 
-  async create(
-    schema: AnalyticsRuleCreateSchema
+  async upsert(
+    name: string,
+    params: AnalyticsRuleCreateSchema
   ): Promise<AnalyticsRuleCreateSchema> {
-    return this.apiCall.post<AnalyticsRuleCreateSchema>(RESOURCEPATH, schema);
+    return this.apiCall.put<AnalyticsRuleCreateSchema>(
+      this.endpointPath(name),
+      params
+    );
   }
 
   async retrieve(): Promise<AnalyticsRulesRetrieveSchema> {
-    return this.apiCall.get<AnalyticsRulesRetrieveSchema>(RESOURCEPATH);
+    return this.apiCall.get<AnalyticsRulesRetrieveSchema>(this.endpointPath());
+  }
+
+  private endpointPath(operation?: string): string {
+    return `${AnalyticsRules.RESOURCEPATH}${
+      operation === undefined ? "" : "/" + operation
+    }`;
   }
 
   static get RESOURCEPATH() {

lib/Typesense/AnalyticsRule.js.map

@@ -30,6 +30,31 @@ describe("AnalyticsRule", function () {
     mockAxios = new MockAxiosAdapter(axios);
   });
 
+  describe(".retrieve", function () {
+    it("retrieves the rule", function (done) {
+      mockAxios
+        .onGet(
+          apiCall.uriFor(
+            "/analytics/rules/123",
+            typesense.configuration.nodes[0]
+          ),
+          null,
+          {
+            Accept: "application/json, text/plain, */*",
+            "Content-Type": "application/json",
+            "X-TYPESENSE-API-KEY": typesense.configuration.apiKey,
+          }
+        )
+        .reply(200, "{}", { "content-type": "application/json" });
+
+      // console.log(mockAxios.handlers)
+
+      let returnData = analyticsRule.retrieve();
+
+      expect(returnData).to.eventually.deep.equal({}).notify(done);
+    });
+  });
+
   describe(".delete", function () {
     it("deletes a key", function (done) {
       mockAxios

lib/Typesense/AnalyticsRules.d.ts

@@ -30,13 +30,15 @@ describe("AnalyticsRules", function () {
     mockAxios = new MockAxiosAdapter(axios);
   });
 
-  describe(".create", function () {
-    it("creates an analytics rule", function (done) {
+  describe(".upsert", function () {
+    it("upserts an analytics rule", function (done) {
       mockAxios
-        .onPost(
-          apiCall.uriFor("/analytics/rules", typesense.configuration.nodes[0]),
+        .onPut(
+          apiCall.uriFor(
+            "/analytics/rules/search_suggestions",
+            typesense.configuration.nodes[0]
+          ),
           {
-            name: "search_suggestions",
             type: "popular_queries",
             params: {
               source: { collections: ["products"] },
@@ -52,8 +54,7 @@ describe("AnalyticsRules", function () {
         )
         .reply(201, "{}", { "content-type": "application/json" });
 
-      let returnData = analyticsRules.create({
-        name: "search_suggestions",
+      let returnData = analyticsRules.upsert("search_suggestions", {
         type: "popular_queries",
         params: {
           source: { collections: ["products"] },