fix: pass query params to delete calls (#217) (#218)

* fix(delete-query): make filter by optional

* fix(delete-query): pass query params to api call

* test(delete-query): test that it passes query params to api call

* build(delete-query): add build files

lib/Typesense/Document.d.ts

@@ -1,12 +1,12 @@
 import ApiCall from "./ApiCall";
-import { DocumentSchema, DocumentWriteParameters } from "./Documents";
+import { DeleteQuery, DocumentSchema, DocumentWriteParameters } from "./Documents";
 export declare class Document<T extends DocumentSchema = object> {
     private collectionName;
     private documentId;
     private apiCall;
     constructor(collectionName: string, documentId: string, apiCall: ApiCall);
     retrieve(): Promise<T>;
-    delete(): Promise<T>;
+    delete(options?: DeleteQuery): Promise<T>;
     update(partialDocument: Partial<T>, options?: DocumentWriteParameters): Promise<T>;
     private endpointPath;
 }

lib/Typesense/Documents.d.ts

@@ -4,7 +4,7 @@ import ApiCall from "./ApiCall";
 import Configuration from "./Configuration";
 import { SearchOnlyDocuments } from "./SearchOnlyDocuments";
 export interface DeleteQuery {
-    filter_by: string;
+    filter_by?: string;
     batch_size?: number;
     ignore_not_found?: boolean;
 }
@@ -102,7 +102,6 @@ export interface SearchResponseHit<T extends DocumentSchema> {
             field: keyof T;
             snippet?: string;
             value?: string;
-            values?: string[];
             snippets?: string[];
             indices?: number[];
             matched_tokens: string[][] | string[];

src/Typesense/Document.ts

@@ -1,6 +1,7 @@
 import ApiCall from "./ApiCall";
 import Collections from "./Collections";
 import Documents, {
+  DeleteQuery,
   DocumentSchema,
   DocumentWriteParameters,
 } from "./Documents";
@@ -16,8 +17,8 @@ export class Document<T extends DocumentSchema = object> {
     return this.apiCall.get<T>(this.endpointPath());
   }
 
-  async delete(): Promise<T> {
-    return this.apiCall.delete<T>(this.endpointPath());
+  async delete(options?: DeleteQuery): Promise<T> {
+    return this.apiCall.delete<T>(this.endpointPath(), options);
   }
 
   async update(

src/Typesense/Documents.ts

@@ -6,7 +6,7 @@ import { SearchOnlyDocuments } from "./SearchOnlyDocuments";
 
 // Todo: use generic to extract filter_by values
 export interface DeleteQuery {
-  filter_by: string;
+  filter_by?: string;
   batch_size?: number;
   ignore_not_found?: boolean;
 }

test/Typesense/Document.spec.js

@@ -121,4 +121,32 @@ describe("Document", function () {
       expect(returnData).to.eventually.deep.equal(documentResult).notify(done);
     });
   });
+  it("passes query params to delete", function (done) {
+    const queryParams = { ignore_not_found: true };
+    mockAxios
+      .onDelete(
+        apiCall.uriFor(
+          "/collections/companies/documents/124",
+          typesense.configuration.nodes[0],
+        ),
+        null,
+        {
+          Accept: "application/json, text/plain, */*",
+          "Content-Type": "application/json",
+          "X-TYPESENSE-API-KEY": typesense.configuration.apiKey,
+        },
+      )
+      .reply((config) => {
+        expect(config.params).to.deep.equal(queryParams);
+        return [
+          200,
+          JSON.stringify(documentResult),
+          { "content-type": "application/json" },
+        ];
+      });
+
+    let returnData = document.delete(queryParams);
+
+    expect(returnData).to.eventually.deep.equal(documentResult).notify(done);
+  });
 });