sailpoint-api-client 1.6.7 → 1.6.9

package/paginator.ts

@@ -116,17 +116,60 @@ export class Paginator {
     }
   }
 
+  public static async *paginateGenerator<
+    T,
+    TResult,
+    A extends PaginationParams & ExtraParams
+  >(
+    thisArg: T,
+    callbackFn: (this: T, args: A) => Promise<AxiosResponse<TResult[], any>>,
+    args?: A,
+    increment?: number
+  ) {
+    let params: PaginationParams = args ? args : { limit: 0, offset: 0 };
+    const maxLimit = params && params.limit ? params.limit : 0;
+    if (!params.offset) {
+      params.offset = 0;
+    }
+    if (!increment) {
+      increment = 250;
+    }
+    params.limit = increment;
+
+    let totalYielded = 0;
+    while (true) {
+      const results = await callbackFn.call(thisArg, params);
+
+      for (const item of results.data) {
+        yield item;
+        totalYielded++;
+
+        // Stop if we've reached the max limit
+        if (maxLimit > 0 && totalYielded >= maxLimit) {
+          return;
+        }
+      }
+
+      // Stop if we got fewer results than requested
+      if (results.data.length < increment) {
+        return;
+      }
+
+      params.offset += increment;
+    }
+  }
+
   public static async paginateSearchApi<T extends ApiType>(
     searchAPI: ApiInstanceMap[T],
-    search: SearchApiTypeMap[T]['search'],
+    search: SearchApiTypeMap[T]["search"],
     increment?: number,
     limit?: number
-  ): Promise<AxiosResponse<SearchApiTypeMap[T]['document'][], any>> {
+  ): Promise<AxiosResponse<SearchApiTypeMap[T]["document"][], any>> {
     increment = increment ? increment : 250;
-    
+
     let offset = 0;
     const maxLimit = limit ? limit : 0;
-    let modified: SearchApiTypeMap[T]['document'][] = [];
+    let modified: SearchApiTypeMap[T]["document"][] = [];
 
     if (!search.sort || search.sort.length != 1) {
       throw "search must include exactly one sort parameter to paginate properly";
@@ -134,33 +177,39 @@ export class Paginator {
 
     while (true) {
       console.log(`Paginating call, offset = ${offset}`);
-      let results: AxiosResponse<SearchApiTypeMap[T]['document'][], any>;
-      
+      let results: AxiosResponse<SearchApiTypeMap[T]["document"][], any>;
+
       // Handle each API type separately to avoid type conflicts
       if (searchAPI instanceof SearchApi) {
         const searchParams: SearchApiSearchPostRequest = {
           search: search as Search,
           limit: increment,
         };
-        results = await (searchAPI as SearchApi).searchPost(searchParams) as AxiosResponse<SearchApiTypeMap[T]['document'][], any>;
+        results = (await (searchAPI as SearchApi).searchPost(
+          searchParams
+        )) as AxiosResponse<SearchApiTypeMap[T]["document"][], any>;
       } else if (searchAPI instanceof SearchV2024Api) {
         const searchParams: SearchV2024ApiSearchPostRequest = {
           searchV2024: search as SearchV2024,
           limit: increment,
         };
-        results = await (searchAPI as SearchV2024Api).searchPost(searchParams) as AxiosResponse<SearchApiTypeMap[T]['document'][], any>;
+        results = (await (searchAPI as SearchV2024Api).searchPost(
+          searchParams
+        )) as AxiosResponse<SearchApiTypeMap[T]["document"][], any>;
       } else if (searchAPI instanceof SearchV2025Api) {
         const searchParams: SearchV2025ApiSearchPostRequest = {
           searchV2025: search as SearchV2025,
           limit: increment,
         };
-        results = await (searchAPI as SearchV2025Api).searchPost(searchParams) as AxiosResponse<SearchApiTypeMap[T]['document'][], any>;
+        results = (await (searchAPI as SearchV2025Api).searchPost(
+          searchParams
+        )) as AxiosResponse<SearchApiTypeMap[T]["document"][], any>;
       } else {
         throw new Error("Unsupported API type");
       }
-      
+
       modified.push.apply(modified, results.data);
-      
+
       if (
         results.data.length < increment ||
         (modified.length >= maxLimit && maxLimit > 0)
@@ -180,4 +229,81 @@ export class Paginator {
       offset += increment;
     }
   }
+
+  public static async *paginateSearchApiGenerator<T extends ApiType>(
+    searchAPI: ApiInstanceMap[T],
+    search: SearchApiTypeMap[T]["search"],
+    increment?: number,
+    limit?: number
+  ) {
+    increment = increment ? increment : 250;
+
+    let offset = 0;
+    const maxLimit = limit ? limit : 0;
+    let totalYielded = 0;
+
+    if (!search.sort || search.sort.length != 1) {
+      throw "search must include exactly one sort parameter to paginate properly";
+    }
+
+    while (true) {
+      console.log(`Paginating call, offset = ${offset}`);
+      let results: AxiosResponse<SearchApiTypeMap[T]["document"][], any>;
+
+      // Handle each API type separately to avoid type conflicts
+      if (searchAPI instanceof SearchApi) {
+        const searchParams: SearchApiSearchPostRequest = {
+          search: search as Search,
+          limit: increment,
+        };
+        results = (await (searchAPI as SearchApi).searchPost(
+          searchParams
+        )) as AxiosResponse<SearchApiTypeMap[T]["document"][], any>;
+      } else if (searchAPI instanceof SearchV2024Api) {
+        const searchParams: SearchV2024ApiSearchPostRequest = {
+          searchV2024: search as SearchV2024,
+          limit: increment,
+        };
+        results = (await (searchAPI as SearchV2024Api).searchPost(
+          searchParams
+        )) as AxiosResponse<SearchApiTypeMap[T]["document"][], any>;
+      } else if (searchAPI instanceof SearchV2025Api) {
+        const searchParams: SearchV2025ApiSearchPostRequest = {
+          searchV2025: search as SearchV2025,
+          limit: increment,
+        };
+        results = (await (searchAPI as SearchV2025Api).searchPost(
+          searchParams
+        )) as AxiosResponse<SearchApiTypeMap[T]["document"][], any>;
+      } else {
+        throw new Error("Unsupported API type");
+      }
+
+      // Yield each document as it arrives
+      for (const doc of results.data) {
+        yield doc;
+        totalYielded++;
+
+        // Stop if we've reached the max limit
+        if (maxLimit > 0 && totalYielded >= maxLimit) {
+          return;
+        }
+      }
+
+      // Stop if we got fewer results than requested
+      if (results.data.length < increment) {
+        return;
+      }
+
+      // Update search after for next iteration
+      const result = <any>results.data[results.data.length - 1];
+      if (search.sort) {
+        (search as any).searchAfter = [result[search.sort[0].replace("-", "")]];
+      } else {
+        throw "search unexpectedly did not return a result we can search after!";
+      }
+
+      offset += increment;
+    }
+  }
 }

package/v2024/README.md

@@ -1,4 +1,4 @@
-## sailpoint-sdk@1.6.7
+## sailpoint-sdk@1.6.9
 
 This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
 _published:_
 
 ```
-npm install sailpoint-sdk@1.6.7 --save
+npm install sailpoint-sdk@1.6.9 --save
 ```
 
 _unPublished (not recommended):_