@brostark/solutions-client 1.0.1 → 1.1.0

package/dist/api/v1/search.d.ts

@@ -18,5 +18,32 @@ export declare const generateSearchAPI: (apiUrl: string, apiKey: string) => {
      * @returns A promise with the created search collection
      */
     createCollection: (params: BrostarkSolutions.Search.CreateCollectionParams) => Promise<any>;
+    /**
+     * Deletes a search collection
+     * @param name - The name of the collection to delete
+     * @returns A promise with the deleted collection
+     */
+    deleteCollection: (name: string) => Promise<any>;
+    /**
+     * Inserts a document into a search collection
+     * @param collectionName - The name of the collection to insert the document into
+     * @param document - The document to insert
+     * @returns A promise with the inserted document
+     */
+    upsertDocument: (collectionName: string, document: Record<string, unknown>) => Promise<any>;
+    /**
+     * Deletes a document from a search collection
+     * @param collectionName - The name of the collection to delete the document from
+     * @param documentId - The ID of the document to delete
+     * @returns A promise with the deleted document
+     */
+    deleteDocument: (collectionName: string, documentId: string) => Promise<any>;
+    /**
+     * Searches for documents in a search collection
+     * @param collectionName - The name of the collection to search in
+     * @param query - The query to search for
+     * @returns A promise with the search results
+     */
+    search: (collectionName: string, query: BrostarkSolutions.Search.SearchQuery) => Promise<any>;
 };
 //# sourceMappingURL=search.d.ts.map

package/dist/api/v1/search.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"search.d.ts","sourceRoot":"","sources":["../../../src/api/v1/search.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAIjE;;;;;GAKG;AACH,eAAO,MAAM,iBAAiB,GAAI,QAAQ,MAAM,EAAE,QAAQ,MAAM;IAE5D;;;;OAIG;gCAC8B,WAAW;IAK5C;;;;OAIG;+BAC8B,iBAAiB,CAAC,MAAM,CAAC,sBAAsB;CAMnF,CAAA"}
+{"version":3,"file":"search.d.ts","sourceRoot":"","sources":["../../../src/api/v1/search.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAIjE;;;;;GAKG;AACH,eAAO,MAAM,iBAAiB,GAAI,QAAQ,MAAM,EAAE,QAAQ,MAAM;IAE5D;;;;OAIG;gCAC8B,WAAW;IAK5C;;;;OAIG;+BAC8B,iBAAiB,CAAC,MAAM,CAAC,sBAAsB;IAMhF;;;;OAIG;6BAC4B,MAAM;IAMrC;;;;;OAKG;qCACoC,MAAM,YAAY,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAMhF;;;;;OAKG;qCACoC,MAAM,cAAc,MAAM;IAMjE;;;;;OAKG;6BAC4B,MAAM,SAAS,iBAAiB,CAAC,MAAM,CAAC,WAAW;CAcrF,CAAA"}

package/dist/api/v1/search.js

@@ -28,6 +28,51 @@ const generateSearchAPI = (apiUrl, apiKey) => {
             const response = await (0, httpRequest_1.httpPostRequest)(`${apiUrl}/search/collections`, apiKey, params);
             return response.data;
         },
+        /**
+         * Deletes a search collection
+         * @param name - The name of the collection to delete
+         * @returns A promise with the deleted collection
+         */
+        deleteCollection: async (name) => {
+            const response = await (0, httpRequest_1.httpDeleteRequest)(`${apiUrl}/search/collections/${name}`, apiKey);
+            return response.data;
+        },
+        /**
+         * Inserts a document into a search collection
+         * @param collectionName - The name of the collection to insert the document into
+         * @param document - The document to insert
+         * @returns A promise with the inserted document
+         */
+        upsertDocument: async (collectionName, document) => {
+            const response = await (0, httpRequest_1.httpPostRequest)(`${apiUrl}/search/collections/${collectionName}/documents`, apiKey, document);
+            return response.data;
+        },
+        /**
+         * Deletes a document from a search collection
+         * @param collectionName - The name of the collection to delete the document from
+         * @param documentId - The ID of the document to delete
+         * @returns A promise with the deleted document
+         */
+        deleteDocument: async (collectionName, documentId) => {
+            const response = await (0, httpRequest_1.httpDeleteRequest)(`${apiUrl}/search/collections/${collectionName}/documents/${documentId}`, apiKey);
+            return response.data;
+        },
+        /**
+         * Searches for documents in a search collection
+         * @param collectionName - The name of the collection to search in
+         * @param query - The query to search for
+         * @returns A promise with the search results
+         */
+        search: async (collectionName, query) => {
+            const urlQuery = new URLSearchParams();
+            Object.entries(query).forEach(([key, value]) => {
+                if (value !== undefined && value !== null) {
+                    urlQuery.set(key, String(value));
+                }
+            });
+            const response = await (0, httpRequest_1.httpGetRequest)(`${apiUrl}/search/collections/${collectionName}/search?${urlQuery.toString()}`, apiKey);
+            return response.data;
+        },
     };
 };
 exports.generateSearchAPI = generateSearchAPI;

package/dist/client.d.ts

@@ -25,6 +25,10 @@ export declare function createClient(apiKey: string, options?: CreateClientOptio
     search: {
         listCollections: (options?: import("./lib/types").ListOptions) => Promise<any>;
         createCollection: (params: import("./lib/types").BrostarkSolutions.Search.CreateCollectionParams) => Promise<any>;
+        deleteCollection: (name: string) => Promise<any>;
+        upsertDocument: (collectionName: string, document: Record<string, unknown>) => Promise<any>;
+        deleteDocument: (collectionName: string, documentId: string) => Promise<any>;
+        search: (collectionName: string, query: import("./lib/types").BrostarkSolutions.Search.SearchQuery) => Promise<any>;
     };
 };
 //# sourceMappingURL=client.d.ts.map

package/dist/client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,UAAU,EAAyC,MAAM,YAAY,CAAC;AAE/E;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,+CAA+C;IAC/C,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,qDAAqD;IACrD,OAAO,CAAC,EAAE,UAAU,CAAC;CACtB;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,GAAE,mBAAwB;;;;;;;;;;;;EAY7E"}
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,UAAU,EAAyC,MAAM,YAAY,CAAC;AAE/E;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,+CAA+C;IAC/C,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,qDAAqD;IACrD,OAAO,CAAC,EAAE,UAAU,CAAC;CACtB;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,GAAE,mBAAwB;;;;;;;;;;;;;;;;EAY7E"}

package/dist/lib/types.d.ts

@@ -26,6 +26,15 @@ export declare namespace BrostarkSolutions {
             defaultSortingField?: string;
             metadata?: Record<string, unknown>;
         }
+        interface SearchQuery {
+            query: string;
+            by?: string;
+            sortBy?: string;
+            filterBy?: string;
+        }
+        type Document = {
+            id: string;
+        } & Record<string, unknown>;
     }
 }
 //# sourceMappingURL=types.d.ts.map

package/dist/lib/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/lib/types.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,WAAW;IAC1B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAGD,yBAAiB,iBAAiB,CAAC;IACjC,UAAiB,MAAM,CAAC;QACtB,KAAY,SAAS,GAAG,QAAQ,GAAG,OAAO,GAAG,OAAO,GAAG,OAAO,GAAG,MAAM,GAAG,UAAU,GAAG,YAAY,GAAG,YAAY,GAAG,UAAU,GAAG,SAAS,GAAG,SAAS,GAAG,SAAS,GAAG,QAAQ,GAAG,QAAQ,GAAG,UAAU,GAAG,MAAM,GAAG,SAAS,GAAG,OAAO,CAAC;QACtO,UAAiB,eAAe;YAC9B,IAAI,EAAE,MAAM,CAAC;YACb,IAAI,EAAE,SAAS,CAAC;YAChB,QAAQ,CAAC,EAAE,OAAO,CAAC;YACnB,KAAK,CAAC,EAAE,OAAO,CAAC;YAChB,KAAK,CAAC,EAAE,OAAO,CAAC;YAChB,IAAI,CAAC,EAAE,OAAO,CAAC;YACf,MAAM,CAAC,EAAE,MAAM,CAAC;YAChB,KAAK,CAAC,EAAE,OAAO,CAAC;YAChB,IAAI,CAAC,EAAE,OAAO,CAAC;YACf,OAAO,CAAC,EAAE,MAAM,CAAC;YACjB,KAAK,CAAC,EAAE,OAAO,CAAC;YAChB,WAAW,CAAC,EAAE,OAAO,CAAC;YACtB,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;SACtB;QAED,UAAiB,sBAAsB;YACrC,IAAI,EAAE,MAAM,CAAC;YACb,MAAM,EAAE,eAAe,EAAE,CAAC;YAC1B,mBAAmB,CAAC,EAAE,MAAM,CAAC;YAC7B,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;SACpC;KACF;CACF"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/lib/types.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,WAAW;IAC1B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAGD,yBAAiB,iBAAiB,CAAC;IACjC,UAAiB,MAAM,CAAC;QACtB,KAAY,SAAS,GAAG,QAAQ,GAAG,OAAO,GAAG,OAAO,GAAG,OAAO,GAAG,MAAM,GAAG,UAAU,GAAG,YAAY,GAAG,YAAY,GAAG,UAAU,GAAG,SAAS,GAAG,SAAS,GAAG,SAAS,GAAG,QAAQ,GAAG,QAAQ,GAAG,UAAU,GAAG,MAAM,GAAG,SAAS,GAAG,OAAO,CAAC;QACtO,UAAiB,eAAe;YAC9B,IAAI,EAAE,MAAM,CAAC;YACb,IAAI,EAAE,SAAS,CAAC;YAChB,QAAQ,CAAC,EAAE,OAAO,CAAC;YACnB,KAAK,CAAC,EAAE,OAAO,CAAC;YAChB,KAAK,CAAC,EAAE,OAAO,CAAC;YAChB,IAAI,CAAC,EAAE,OAAO,CAAC;YACf,MAAM,CAAC,EAAE,MAAM,CAAC;YAChB,KAAK,CAAC,EAAE,OAAO,CAAC;YAChB,IAAI,CAAC,EAAE,OAAO,CAAC;YACf,OAAO,CAAC,EAAE,MAAM,CAAC;YACjB,KAAK,CAAC,EAAE,OAAO,CAAC;YAChB,WAAW,CAAC,EAAE,OAAO,CAAC;YACtB,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;SACtB;QAED,UAAiB,sBAAsB;YACrC,IAAI,EAAE,MAAM,CAAC;YACb,MAAM,EAAE,eAAe,EAAE,CAAC;YAC1B,mBAAmB,CAAC,EAAE,MAAM,CAAC;YAC7B,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;SACpC;QAED,UAAiB,WAAW;YAC1B,KAAK,EAAE,MAAM,CAAC;YACd,EAAE,CAAC,EAAE,MAAM,CAAC;YACZ,MAAM,CAAC,EAAE,MAAM,CAAC;YAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;SACnB;QAED,KAAY,QAAQ,GAAG;YACrB,EAAE,EAAE,MAAM,CAAC;SACZ,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;KAC7B;CACF"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@brostark/solutions-client",
-  "version": "1.0.1",
+  "version": "1.1.0",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {
@@ -14,7 +14,12 @@
   "author": "Brostark Solutions",
   "license": "ISC",
   "description": "Brostark Solutions Client",
-  "keywords": ["brostark", "solutions", "client", "api"],
+  "keywords": [
+    "brostark",
+    "solutions",
+    "client",
+    "api"
+  ],
   "devDependencies": {
     "eslint": "^8.57.1",
     "eslint-config-incredibilis": "^1.1.30",

package/src/api/v1/search.ts

@@ -1,5 +1,5 @@
 import { BrostarkSolutions, ListOptions } from "../../lib/types";
-import { httpListRequest, httpPostRequest } from "../../lib/httpRequest";
+import { httpDeleteRequest, httpGetRequest, httpListRequest, httpPostRequest } from "../../lib/httpRequest";
 
 
 /**
@@ -30,5 +30,60 @@ export const generateSearchAPI = (apiUrl: string, apiKey: string) => {
 
       return response.data;
     },
+
+    /**
+     * Deletes a search collection
+     * @param name - The name of the collection to delete
+     * @returns A promise with the deleted collection
+     */
+    deleteCollection: async (name: string) => {
+      const response = await httpDeleteRequest(`${apiUrl}/search/collections/${name}`, apiKey);
+
+      return response.data;
+    },
+
+    /**
+     * Inserts a document into a search collection
+     * @param collectionName - The name of the collection to insert the document into
+     * @param document - The document to insert
+     * @returns A promise with the inserted document
+     */
+    upsertDocument: async (collectionName: string, document: Record<string, unknown>) => {
+      const response = await httpPostRequest(`${apiUrl}/search/collections/${collectionName}/documents`, apiKey, document);
+
+      return response.data;
+    },
+
+    /**
+     * Deletes a document from a search collection
+     * @param collectionName - The name of the collection to delete the document from
+     * @param documentId - The ID of the document to delete
+     * @returns A promise with the deleted document
+     */
+    deleteDocument: async (collectionName: string, documentId: string) => {
+      const response = await httpDeleteRequest(`${apiUrl}/search/collections/${collectionName}/documents/${documentId}`, apiKey);
+
+      return response.data;
+    },
+
+    /**
+     * Searches for documents in a search collection
+     * @param collectionName - The name of the collection to search in
+     * @param query - The query to search for
+     * @returns A promise with the search results
+     */
+    search: async (collectionName: string, query: BrostarkSolutions.Search.SearchQuery) => {
+      const urlQuery = new URLSearchParams();
+
+      Object.entries(query).forEach(([key, value]) => {
+        if (value !== undefined && value !== null) {
+          urlQuery.set(key, String(value));
+        }
+      });
+
+      const response = await httpGetRequest(`${apiUrl}/search/collections/${collectionName}/search?${urlQuery.toString()}`, apiKey);
+
+      return response.data;
+    },
   }
 }

package/src/lib/types.ts

@@ -29,5 +29,16 @@ export namespace BrostarkSolutions {
       defaultSortingField?: string;
       metadata?: Record<string, unknown>;
     }
+
+    export interface SearchQuery {
+      query: string;
+      by?: string;
+      sortBy?: string;
+      filterBy?: string;
+    }
+
+    export type Document = {
+      id: string;
+    } & Record<string, unknown>;
   }
 }