feat(sdk): add limit option to apps, components, accounts (1.0.11)

Author: tjk

packages/sdk/CHANGELOG.md

@@ -1,6 +1,12 @@
 <!-- markdownlint-disable MD024 -->
 # Changelog
 
+## [1.0.11] - 2024-12-04
+
+### Added
+
+- Configurable `limit` option for apps, accounts, components endpoints
+
 ## [1.0.10] - 2024-12-04
 
 ### Changed

packages/sdk/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/sdk",
-  "version": "1.0.10",
+  "version": "1.0.11",
   "description": "Pipedream SDK",
   "main": "dist/server/server/index.js",
   "module": "dist/server/server/index.js",

packages/sdk/src/shared/index.ts

@@ -95,10 +95,14 @@ export type ComponentConfigureResponse = {
   errors: string[];
 };
 
+export type RelationOpts = {
+  limit?: number
+}
+
 /**
  * Parameters for the retrieval of apps from the Connect API
  */
-export type GetAppsOpts = {
+export type GetAppsOpts = RelationOpts & {
   /**
    * A search query to filter the apps.
    */
@@ -108,7 +112,7 @@ export type GetAppsOpts = {
 /**
  * Parameters for the retrieval of accounts from the Connect API
  */
-export type GetAccountOpts = {
+export type GetAccountOpts = RelationOpts & {
   /**
    * The ID or name slug of the app, in case you want to only retrieve the
    * accounts for a specific app.
@@ -201,7 +205,7 @@ export type ComponentConfigureOpts = {
   query?: string;
 };
 
-export type GetComponentOpts = {
+export type GetComponentOpts = RelationOpts & {
   q?: string;
   app?: string;
   componentType?: "trigger" | "action";
@@ -519,6 +523,9 @@ export abstract class BaseClient {
     if (opts?.q) {
       params.q = opts.q;
     }
+    if (opts?.limit != null) {
+      params.limit = "" + opts.limit
+    }
     const resp = await this.makeAuthorizedRequest<AppsRequestResponse>(
       "/apps",
       {
@@ -539,15 +546,14 @@ export abstract class BaseClient {
 
   // XXX only here while need project auth
   public async components(opts?: GetComponentOpts) {
-    const params: Record<string, string> = {
-      limit: "20",
-    };
+    const params: Record<string, string> = {};
     if (opts?.app) {
       params.app = opts.app;
     }
     if (opts?.q) {
       params.q = opts.q;
     }
+    params.limit = "" + (opts?.limit ?? 20)
     // XXX can just use /components and ?type instead when supported
     let path = "/components";
     if (opts?.componentType === "trigger") {