Merge branch 'danny/connect-link-docs' of https://github.com/PipedreamHQ/pipedream into danny/connect-link-docs

dannyroosevelt · dannyroosevelt · commit 0307fead06ec · 2024-09-26T22:15:10.000-07:00
diff --git a/components/nocodb/actions/add-record/add-record.mjs b/components/nocodb/actions/add-record/add-record.mjs
@@ -5,7 +5,7 @@ export default {
   key: "nocodb-add-record",
   name: "Add Record",
   description: "This action adds a record in a table. [See the documentation](https://data-apis-v2.nocodb.com/#tag/Table-Records/operation/db-data-table-row-create)",
-  version: "0.0.3",
+  version: "0.0.4",
   type: "action",
   props: {
     ...common.props,
diff --git a/components/nocodb/actions/delete-record/delete-record.mjs b/components/nocodb/actions/delete-record/delete-record.mjs
@@ -5,7 +5,7 @@ export default {
   key: "nocodb-delete-record",
   name: "Delete Record",
   description: "This action deletes a row in a table. [See the documentation](https://data-apis-v2.nocodb.com/#tag/Table-Records/operation/db-data-table-row-delete)",
-  version: "0.0.3",
+  version: "0.0.4",
   type: "action",
   props: {
     ...common.props,
diff --git a/components/nocodb/actions/get-record/get-record.mjs b/components/nocodb/actions/get-record/get-record.mjs
@@ -5,7 +5,7 @@ export default {
   key: "nocodb-get-record",
   name: "Get Record (from row number)",
   description: "This action gets a row by row Id. [See the documentation](https://data-apis-v2.nocodb.com/#tag/Table-Records/operation/db-data-table-row-read)",
-  version: "0.0.3",
+  version: "0.0.4",
   type: "action",
   props: {
     ...common.props,
diff --git a/components/nocodb/actions/list-records-matching-criteria/list-records-matching-criteria.mjs b/components/nocodb/actions/list-records-matching-criteria/list-records-matching-criteria.mjs
@@ -5,7 +5,7 @@ export default {
   key: "nocodb-list-records-matching-criteria",
   name: "List Records in Table Matching Criteria",
   description: "This action lists all rows in a table. [See the documentation](https://data-apis-v2.nocodb.com/#tag/Table-Records/operation/db-data-table-row-list)",
-  version: "0.0.4",
+  version: "0.0.5",
   type: "action",
   props: {
     ...common.props,
diff --git a/components/nocodb/actions/update-record/update-record.mjs b/components/nocodb/actions/update-record/update-record.mjs
@@ -5,7 +5,7 @@ export default {
   key: "nocodb-update-record",
   name: "Update Record",
   description: "This action updates a record in a table. [See the documentation](https://data-apis-v2.nocodb.com/#tag/Table-Records/operation/db-data-table-row-update)",
-  version: "0.0.3",
+  version: "0.0.4",
   type: "action",
   props: {
     ...common.props,
diff --git a/components/nocodb/nocodb.app.mjs b/components/nocodb/nocodb.app.mjs
@@ -119,24 +119,26 @@ export default {
     async *paginate({
       fn, args = {}, max,
     }) {
-      let lastPage, count = 0;
+      let hasMore = false;
+      let count = 0;
       args.params = {
         ...args.params,
-        page: 1,
+        offset: 0,
+        limit: 1000,
       };
       do {
         const {
           list, pageInfo,
         } = await fn(args);
         for (const item of list) {
+          args.params.offset++;
           yield item;
           if (max && ++count === max) {
             return;
           }
         }
-        args.params.page++;
-        lastPage = !pageInfo.isLastPage;
-      } while (lastPage);
+        hasMore = !pageInfo.isLastPage;
+      } while (hasMore);
     },
     listWorkspaces(opts = {}) {
       return this._makeRequest({
diff --git a/components/nocodb/package.json b/components/nocodb/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/nocodb",
-  "version": "0.0.6",
+  "version": "0.0.7",
   "description": "Pipedream Nocodb Components",
   "main": "nocodb.app.mjs",
   "keywords": [
diff --git a/components/nocodb/sources/new-record/new-record.mjs b/components/nocodb/sources/new-record/new-record.mjs
@@ -6,7 +6,7 @@ export default {
   name: "New Record in Table",
   key: "nocodb-new-record",
   description: "Emit new event for each new record in table. [See the documentation](https://data-apis-v2.nocodb.com/#tag/Table-Records/operation/db-data-table-row-list)",
-  version: "0.0.4",
+  version: "0.0.5",
   dedupe: "unique",
   props: {
     ...common.props,
diff --git a/components/nocodb/sources/updated-record/updated-record.mjs b/components/nocodb/sources/updated-record/updated-record.mjs
@@ -6,7 +6,7 @@ export default {
   name: "New Update in Table",
   key: "nocodb-updated-record",
   description: "Emit new event for each update in table. [See the documentation](https://data-apis-v2.nocodb.com/#tag/Table-Records/operation/db-data-table-row-list)",
-  version: "0.0.4",
+  version: "0.0.5",
   dedupe: "unique",
   props: {
     ...common.props,
diff --git a/components/pixelbin/package.json b/components/pixelbin/package.json
@@ -0,0 +1,15 @@
+{
+  "name": "@pipedream/pixelbin",
+  "version": "0.0.1",
+  "description": "Pipedream Pixelbin Components",
+  "main": "pixelbin.app.mjs",
+  "keywords": [
+    "pipedream",
+    "pixelbin"
+  ],
+  "homepage": "https://pipedream.com/apps/pixelbin",
+  "author": "Pipedream <support@pipedream.com> (https://pipedream.com/)",
+  "publishConfig": {
+    "access": "public"
+  }
+}
diff --git a/components/pixelbin/pixelbin.app.mjs b/components/pixelbin/pixelbin.app.mjs
@@ -0,0 +1,11 @@
+export default {
+  type: "app",
+  app: "pixelbin",
+  propDefinitions: {},
+  methods: {
+    // this.$auth contains connected account data
+    authKeys() {
+      console.log(Object.keys(this.$auth));
+    },
+  },
+};
diff --git a/components/smslink_nc/package.json b/components/smslink_nc/package.json
@@ -0,0 +1,15 @@
+{
+  "name": "@pipedream/smslink_nc",
+  "version": "0.0.1",
+  "description": "Pipedream SMSlink nc Components",
+  "main": "smslink_nc.app.mjs",
+  "keywords": [
+    "pipedream",
+    "smslink_nc"
+  ],
+  "homepage": "https://pipedream.com/apps/smslink_nc",
+  "author": "Pipedream <support@pipedream.com> (https://pipedream.com/)",
+  "publishConfig": {
+    "access": "public"
+  }
+}
diff --git a/components/smslink_nc/smslink_nc.app.mjs b/components/smslink_nc/smslink_nc.app.mjs
@@ -0,0 +1,11 @@
+export default {
+  type: "app",
+  app: "smslink_nc",
+  propDefinitions: {},
+  methods: {
+    // this.$auth contains connected account data
+    authKeys() {
+      console.log(Object.keys(this.$auth));
+    },
+  },
+};
diff --git a/components/vida/package.json b/components/vida/package.json
@@ -0,0 +1,15 @@
+{
+  "name": "@pipedream/vida",
+  "version": "0.0.1",
+  "description": "Pipedream Vida Components",
+  "main": "vida.app.mjs",
+  "keywords": [
+    "pipedream",
+    "vida"
+  ],
+  "homepage": "https://pipedream.com/apps/vida",
+  "author": "Pipedream <support@pipedream.com> (https://pipedream.com/)",
+  "publishConfig": {
+    "access": "public"
+  }
+}
diff --git a/components/vida/vida.app.mjs b/components/vida/vida.app.mjs
@@ -0,0 +1,11 @@
+export default {
+  type: "app",
+  app: "vida",
+  propDefinitions: {},
+  methods: {
+    // this.$auth contains connected account data
+    authKeys() {
+      console.log(Object.keys(this.$auth));
+    },
+  },
+};
diff --git a/docs-v2/pages/connect/api.mdx b/docs-v2/pages/connect/api.mdx
@@ -77,9 +77,7 @@ import { createClient } from "@pipedream/sdk/browser"
 import { serverConnectTokenCreate } from "./server"
  
 const { token, expires_at } = await serverConnectTokenCreate({
-  app_slug: appSlug,  // The app's name slug — see the quickstart
-  oauth_app_id: oauthAppId,  // The OAuth app ID, if you're connecting an OAuth app — keep this in config / a DB, pass here
-  external_id: externalUserId  // The end user's ID in your system
+  external_user_id: externalUserId  // The end user's ID in your system
 });
 
 export default function Home() {
@@ -148,9 +146,9 @@ POST /tokens
 
 ##### Parameters
 
-- `app_slug` - [The app's name slug](/quickstart#find-your-apps-name-slug)
-- `oauth_app_id` - [The OAuth app ID](/quickstart#creating-a-custom-oauth-client), if you're connecting an OAuth app — keep this in config / a DB, pass here
 - `external_id` - [The external user ID](#external-users) in your system
+- `success_redirect_uri` — _Optional_. The URL to redirect the user to after they successfully connect an account
+- `error_redirect_uri` — _Optional_. The URL to redirect the user to if they encounter an error during the connection flow
 
 ##### Examples
 
@@ -180,9 +178,7 @@ export async function serverConnectTokenCreate(opts: ConnectTokenCreateOpts): Pr
 }
 
 const { token, expires_at } = await serverConnectTokenCreate({
-  app_slug: appSlug,  // The app's name slug
-  oauth_app_id: oauthAppId,  // The OAuth app ID, if you're connecting an OAuth app — keep this in config / a DB, pass here
-  external_id: externalUserId  // The end user's ID in your system
+  external_user_id: externalUserId  // The end user's ID in your system
 });
 ```
 </Tabs.Tab>
@@ -225,8 +221,6 @@ const client = new Client({
 });
 
 const connectTokenOpts = {
-  app_slug: "YOUR_APP_SLUG",  // The app's name slug
-  oauth_app_id: "o_abc123",  // The OAuth app ID, if you're connecting an OAuth app — keep this in config / a DB, pass here
   external_id: "USER_ID"  // The end user's ID in your system
 }
 
@@ -272,14 +266,12 @@ class Client:
 
 # Usage example
 client = Client({
-    'public_key': 'YOUR_PUBLIC_KEY',
-    'secret_key': 'YOUR_SECRET_KEY',
+  'public_key': 'YOUR_PUBLIC_KEY',
+  'secret_key': 'YOUR_SECRET_KEY',
 })
 
 connect_token_opts = {
-    'app_slug': "YOUR_APP_SLUG",
-    'oauth_app_id': "o_abc123",
-    'external_id': "USER_ID"
+  'external_id': "USER_ID"
 }
 
 # Expose this code as an API endpoint in your server to fetch the token from the frontend
@@ -313,7 +305,7 @@ public class Client {
         return "Basic " + encoded;
     }
 
-    public String connectTokenCreate(String appSlug, String oauthClientId, String externalId) throws Exception {
+    public String connectTokenCreate(String externalId) throws Exception {
         String auth = authorizationHeader();
         URL url = new URL(baseURL + "/v1/connect/tokens");
         HttpURLConnection conn = (HttpURLConnection) url.openConnection();
@@ -322,7 +314,7 @@ public class Client {
         conn.setRequestProperty("Content-Type", "application/json");
         conn.setDoOutput(true);
 
-        String jsonInputString = String.format("{\"app_slug\":\"%s\",\"oauth_app_id\":\"%s\",\"external_id\":\"%s\"}", appSlug, oauthClientId, externalId);
+        String jsonInputString = String.format("{\"external_id\":\"%s\"}", externalId);
 
         try (OutputStream os = conn.getOutputStream()) {
             byte[] input = jsonInputString.getBytes(StandardCharsets.UTF_8);
@@ -336,7 +328,7 @@ public class Client {
         Client client = new Client("YOUR_SECRET_KEY", "YOUR_PUBLIC_KEY");
 
         // Expose this code as an API endpoint in your server to fetch the token from the frontend
-        String response = client.connectTokenCreate("YOUR_APP_SLUG", "o_abc123", "USER_ID");
+        String response = client.connectTokenCreate("USER_ID");
     }
 }
 
@@ -367,13 +359,13 @@ public class Client {
         return $"Basic {encoded}";
     }
 
-    public async Task<string> ConnectTokenCreate(string appSlug, string oauthClientId, string externalId) {
+    public async Task<string> ConnectTokenCreate(string externalId) {
         string auth = AuthorizationHeader();
         using (HttpClient client = new HttpClient()) {
             client.DefaultRequestHeaders.Add("Authorization", auth);
             client.DefaultRequestHeaders.Add("Content-Type", "application/json");
 
-            var content = new StringContent($"{{\"app_slug\":\"{appSlug}\",\"oauth_app_id\":\"{oauthClientId}\",\"external_id\":\"{externalId}\"}}", Encoding.UTF8, "application/json");
+            var content = new StringContent($"{{\"external_id\":\"{externalId}\"}}", Encoding.UTF8, "application/json");
             var response = await client.PostAsync($"{baseURL}/v1/connect/tokens", content);
 
             return await response.Content.ReadAsStringAsync();
@@ -384,7 +376,7 @@ public class Client {
         var client = new Client("YOUR_SECRET_KEY", "YOUR_PUBLIC_KEY");
 
         // Expose this code as an API endpoint in your server to fetch the token from the frontend
-        string response = await client.ConnectTokenCreate("YOUR_APP_SLUG", "o_abc123", "USER_ID");
+        string response = await client.ConnectTokenCreate("USER_ID");
     }
 }
 
@@ -424,13 +416,11 @@ func (c *Client) authorizationHeader() string {
 	return fmt.Sprintf("Basic %s", encoded)
 }
 
-func (c *Client) ConnectTokenCreate(appSlug, oauthClientId, externalId string) (map[string]interface{}, error) {
+func (c *Client) ConnectTokenCreate(externalId string) (map[string]interface{}, error) {
 	auth := c.authorizationHeader()
 	url := fmt.Sprintf("%s/v1/connect/tokens", c.BaseURL)
 
 	opts := map[string]string{
-		"app_slug":       appSlug,
-		"oauth_app_id": oauthClientId,
 		"external_id":    externalId,
 	}
 
@@ -465,7 +455,7 @@ func main() {
 	client := NewClient("YOUR_SECRET_KEY", "YOUR_PUBLIC_KEY")
 
   // Expose this code as an API endpoint in your server to fetch the token from the frontend
-	response, err := client.ConnectTokenCreate("YOUR_APP_SLUG", "o_abc123", "USER_ID")
+	response, err := client.ConnectTokenCreate( "USER_ID")
 	if err != nil {
 		fmt.Println("Error:", err)
 		return
@@ -496,13 +486,11 @@ class Client {
         return "Basic $encoded";
     }
 
-    public function connectTokenCreate($appSlug, $oauthClientId, $externalId) {
+    public function connectTokenCreate($externalId) {
         $auth = $this->authorizationHeader();
         $url = "$this->baseURL/v1/connect/tokens";
 
         $data = json_encode([
-            'app_slug' => $appSlug,
-            'oauth_app_id' => $oauthClientId,
             'external_id' => $externalId
         ]);
 
@@ -528,13 +516,11 @@ class Client {
 $client = new Client('YOUR_SECRET_KEY', 'YOUR_PUBLIC_KEY');
 
 $connectTokenOpts = [
-    'app_slug' => "YOUR_APP_SLUG",
-    'oauth_app_id' => "o_abc123",
     'external_id' => "USER_ID"
 ];
 
 // Expose this code as an API endpoint in your server to fetch the token from the frontend
-$response = $client->connectTokenCreate($connectTokenOpts['app_slug'], $connectTokenOpts['oauth_app_id'], $connectTokenOpts['external_id']);
+$response = $client->connectTokenCreate($connectTokenOpts['external_id']);
 ?>
 ```
 </Tabs.Tab>
@@ -564,7 +550,7 @@ class Client
     req = Net::HTTP::Post.new(uri)
     req['Authorization'] = authorization_header
     req['Content-Type'] = 'application/json'
-    req.body = { app_slug: app_slug, oauth_app_id: oauth_app_id, external_id: external_id }.to_json
+    req.body = { external_id: external_id }.to_json
 
     res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
       http.request(req)
@@ -577,13 +563,11 @@ end
 client = Client.new('YOUR_SECRET_KEY', 'YOUR_PUBLIC_KEY')
 
 connect_token_opts = {
-  app_slug: "YOUR_APP_SLUG",
-  oauth_app_id: "o_abc123",
   external_id: "USER_ID"
 }
 
 # Expose this code as an API endpoint in your server to fetch the token from the frontend
-response = client.connect_token_create(connect_token_opts[:app_slug], connect_token_opts[:oauth_app_id], connect_token_opts[:external_id])
+response = client.connect_token_create(connect_token_opts[:external_id])
 ```
 </Tabs.Tab>
 </Tabs>
diff --git a/docs-v2/pages/connect/quickstart.mdx b/docs-v2/pages/connect/quickstart.mdx
diff --git a/packages/sdk/src/server/__tests__/server.test.ts b/packages/sdk/src/server/__tests__/server.test.ts
diff --git a/packages/sdk/src/server/index.ts b/packages/sdk/src/server/index.ts
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@pipedream/nocodb",`
`3`		`- "version": "0.0.6",`
	`3`	`+ "version": "0.0.7",`
`4`	`4`	`"description": "Pipedream Nocodb Components",`
`5`	`5`	`"main": "nocodb.app.mjs",`
`6`	`6`	`"keywords": [`