How pipedreamhq/pipedream-sdk-typescript works
This repository is the Pipedream TypeScript SDK: callers configure a client, authenticate, and invoke typed API resources whose requests are serialized and sent to Pipedream; responses may be typed, paginated, binary, or errors. The README documents action execution, OAuth or bearer-token authentication, environment selection, pagination, and file downloads. It also documents browser account connection, implemented in the browser entry point. Resource endpoints beyond the sampled clients are represented at their existing resource-directory paths; their exact wiring was not inspected.
Main entry points: Client.ts Pipedream client · fetcher HTTP fetcher · projects Projects · actions Actions
Components 25
Client setup
- Pipedream client
src/Client.ts - Client options
src/BaseClient.ts
API capabilities
- Actions
src/api/resources/actions - Workflows
src/api/resources/workflows - Accounts
src/api/resources/accounts - App catalog
src/api/resources/apps - Triggers
src/api/resources/triggers - Deployed triggers
src/api/resources/deployedTriggers - Projects
src/api/resources/projects - Connected proxy
src/api/resources/proxy - File stash
src/api/resources/fileStash - Other API resources
src/api/resources - OAuth tokens
src/api/resources/oauthTokens
Request runtime
- Type serialization
src/serialization - HTTP fetcher
src/core/fetcher - Pagination
src/core/pagination - Error handling
src/errors - Binary response
src/core/fetcher/BinaryResponse.ts
Authentication
- Auth providers
src/core/auth - OAuth provider
src/auth/OAuthAuthProvider.ts
Browser Connect
- Frontend client
src/browser/index.ts - Connect token
src/core/auth/ConnectTokenProvider.ts
Other components
- SDK caller
- Pipedream API
- Browser user
Connections 36
- SDK caller → Pipedream client: configures
- Pipedream client → Client options: normalizes options
- Pipedream client → Actions: provides resource
- Pipedream client → Workflows: provides resource
- Pipedream client → Accounts: provides resource
- Pipedream client → App catalog: provides resource
- Pipedream client → Triggers: provides resource
- Pipedream client → Deployed triggers: provides resource
- Pipedream client → Projects: provides resource
- Pipedream client → Connected proxy: provides resource
- Pipedream client → File stash: provides resource
- Pipedream client → Other API resources: provides resources
- SDK caller → Actions: invokes action
- Actions → Type serialization: serializes request
- Accounts → Type serialization: serializes request
- Projects → Type serialization: serializes request
- Type serialization → HTTP fetcher: encodes request
- Actions → HTTP fetcher: sends request
- Accounts → HTTP fetcher: sends request
- Projects → HTTP fetcher: sends request
- Triggers → HTTP fetcher: sends request
- Deployed triggers → HTTP fetcher: sends request
- Connected proxy → HTTP fetcher: sends request
- File stash → HTTP fetcher: sends request
- HTTP fetcher → Pipedream API: HTTP request
- Pipedream API → HTTP fetcher: HTTP response
- HTTP fetcher → Error handling: handles failures
- HTTP fetcher → Binary response: returns binary
- Projects → Pagination: pages results
- SDK caller → Auth providers: supplies credentials
- Pipedream client → Auth providers: uses provider
- Pipedream client → OAuth provider: creates OAuth provider
- OAuth provider → OAuth tokens: requests token
- Browser user → Frontend client: connects account
- Frontend client → Connect token: uses token provider
- Frontend client → Pipedream client: creates client