@pipedream/connect-react 1.3.2 → 1.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -153,9 +153,36 @@ type ComponentFormProps = {
153
153
  sdkResponse: unknown[] | unknown | undefined;
154
154
  /** Whether to show show errors in the form. Requires sdkErrors to be set. */
155
155
  enableDebugging?: boolean;
156
+ /** OAuth app ID configuration for specific apps.
157
+ * Maps app name slugs to their corresponding OAuth app IDs. */
158
+ oauthAppConfig?: Record<string, string>;
156
159
  };
157
160
  ```
158
161
 
162
+ ### OAuth App Configuration
163
+
164
+ To connect to an OAuth app using your own OAuth client, you can specify custom OAuth app IDs for each app using the `oauthAppConfig` prop:
165
+
166
+ ```tsx
167
+ const oauthAppConfig = {
168
+ github: "oa_xxxxxxx",
169
+ google_sheets: "oa_xxxxxxx",
170
+ slack: "oa_xxxxxxx",
171
+ };
172
+
173
+ <ComponentFormContainer
174
+ userId={userId}
175
+ componentKey="slack-send-message-to-channel"
176
+ configuredProps={configuredProps}
177
+ onUpdateConfiguredProps={setConfiguredProps}
178
+ oauthAppConfig={oauthAppConfig}
179
+ />;
180
+ ```
181
+
182
+ This allows you to use your own OAuth applications for specific integrations, providing better control over branding and permissions. Read how to configure OAuth clients in Pipedream here: [https://pipedream.com/docs/connect/managed-auth/oauth-clients](https://pipedream.com/docs/connect/managed-auth/oauth-clients).
183
+
184
+ **Note**: OAuth app IDs are not sensitive, and are safe to expose in the client.
185
+
159
186
  ## Customization
160
187
 
161
188
  Style individual components using the `CustomizeProvider` and a `CustomizationConfig`.
@@ -164,7 +191,7 @@ Style individual components using the `CustomizeProvider` and a `CustomizationCo
164
191
  <FrontendClientProvider client={client}>
165
192
  <CustomizeProvider {...customizationConfig}>
166
193
  <ComponentFormContainer
167
- key="slack-send-message"
194
+ key="slack-send-message-to-channel"
168
195
  configuredProps={configuredProps}
169
196
  onUpdateConfiguredProps={setConfiguredProps}
170
197
  />