feat(storage): [beta] added error propagation and more input validati…

…on to search function

lib/minimal-package.ts

@@ -1 +1 @@
-export default { name: '@mondaycom/apps-sdk', version: '3.0.12' };
+export default { name: '@mondaycom/apps-sdk', version: '3.0.12-beta' };

lib/storage/storage.ts

@@ -42,13 +42,20 @@ export class Storage extends BaseStorage implements IStorageInstance {
   }
 
   async search<T extends JsonValue>(key: string, options: SearchOptions = {}): Promise<SearchResponse<T>> {
+    if (!key?.length){
+        return { success: false, error: 'key cannot be empty', records: null };
+    }
     const url = this.searchUrl(key, options);
     const params = { method: 'GET' };
     const result = await this.storageFetchV2<SearchServerResponse<T>>(url, params);
     if (!isDefined(result)) {
       return { success: false, records: null };
     }
 
+    if (result.error) {
+      return { success: false, error: result.error, records: null };
+    }
+
     const response: SearchResponse<T> = { success: true, records: result.records };
     if (result.cursor) {
       response.cursor = result.cursor;

lib/types/storage.ts

@@ -43,6 +43,7 @@ export type SearchEntity<T extends JsonValue> = {
 export type SearchServerResponse<T extends JsonValue> = {
   records: Array<SearchEntity<T>> | null
   cursor?: string
+  error?: string
 }
 
 export type SearchResponse<T extends JsonValue> = {

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mondaycom/apps-sdk",
-  "version": "3.0.12",
+  "version": "3.0.12-beta",
   "description": "monday apps SDK for NodeJS",
   "main": "./dist/cjs/index.js",
   "module": "./dist/esm/index.js",

tests/storage/storage.test.ts

@@ -64,5 +64,17 @@ describe('Storage', () => {
       await expect(async () => await storage.search(term)).rejects.toThrow(InternalServerError);
       expect(fetch).toHaveBeenCalledTimes(1);
     });
+
+    it('Should return error that cannot search with empty term', async () => {
+      // Arrange
+      const storage = new Storage(FAKE_TOKEN);
+
+      // Act
+      const res = await storage.search('');
+
+      // Assert
+      expect(res).toEqual({ success: false, error: 'key cannot be empty', records: null });
+      expect(fetch).toHaveBeenCalledTimes(0);
+    });
   });
 });