@crowdstrike/foundry-js 0.17.0 → 0.17.1

package/README.md

@@ -80,8 +80,11 @@ To call on-demand workflow:
   const record = await collection.read('test-key');
   // record.age === 42
   
-  // search collection, `filter` uses FQL (Falcon Query Language)
-  const searchResult = await collection.search({ filter: `name:'*'` });
+  // search collection, `filter` does NOT use FQL (Falcon Query Language). An exact match for the name has to be used in this example below
+  const searchResult = await collection.search({ filter: `name:'exact-name-value'` });
+
+  // list the object keys in the collection, pagination is supported using; `start`, `end` and `limit`.
+  const listResult = await collection.list({ start, end, limit });
   
   // deletes record
   const deleteResponse = await collection.delete('test-key');

package/dist/abstraction/collection.d.ts

@@ -13,6 +13,11 @@ interface CollectionSearchDefinition {
     sort: string;
     limit: number;
 }
+interface CollectionListDefinition {
+    end: string;
+    limit: number;
+    start: string;
+}
 export declare class Collection<DATA extends LocalData = LocalData> {
     private readonly falcon;
     private readonly definition;
@@ -46,5 +51,12 @@ export declare class Collection<DATA extends LocalData = LocalData> {
      * @returns
      */
     search({ filter, offset, sort, limit, }: CollectionSearchDefinition): Promise<unknown>;
+    /**
+     * lists the object keys in the specified collection
+     *
+     * @param searchDefinition
+     * @returns
+     */
+    list(options?: CollectionListDefinition): Promise<unknown>;
 }
 export {};

package/dist/index.js

@@ -2811,6 +2811,24 @@ class Collection {
             },
         });
     }
+    /**
+     * lists the object keys in the specified collection
+     *
+     * @param searchDefinition
+     * @returns
+     */
+    async list(options) {
+        return this.falcon.bridge.postMessage({
+            type: 'collection',
+            payload: {
+                type: 'list',
+                collection: this.definition.collection,
+                start: options?.start,
+                end: options?.end,
+                limit: options?.limit,
+            },
+        });
+    }
 }
 
 class Logscale {