- Notifications
You must be signed in to change notification settings - Fork4
TypeScript SDK for Pipedream
License
PipedreamHQ/pipedream-sdk-typescript
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
The Pipedream TypeScript library provides convenient access to the Pipedream APIs from TypeScript.
- Installation
- Reference
- Migration From V 1 X
- Usage
- Request and Response Types
- Exception Handling
- Binary Response
- Pagination
- Advanced
- Contributing
npm i -s @pipedream/sdk
A full reference for this library is availablehere.
If you are migrating from the v1.x SDK, please refer to themigrationguide for details on how to update your code.
Instantiate and use the client with the following:
import{PipedreamClient}from"@pipedream/sdk";constclient=newPipedreamClient({clientId:"YOUR_CLIENT_ID",clientSecret:"YOUR_CLIENT_SECRET",projectEnvironment:"YOUR_PROJECT_ENVIRONMENT",projectId:"YOUR_PROJECT_ID"});awaitclient.actions.run({id:"id",externalUserId:"external_user_id"});
The SDK exports all request and response types as TypeScript interfaces. Simply import them with thefollowing namespace:
import{Pipedream}from"@pipedream/sdk";constrequest:Pipedream.AppsListRequest={ ...};
When the API returns a non-success status code (4xx or 5xx response), a subclass of the following errorwill be thrown.
import{PipedreamError}from"@pipedream/sdk";try{awaitclient.actions.run(...);}catch(err){if(errinstanceofPipedreamError){console.log(err.statusCode);console.log(err.message);console.log(err.body);console.log(err.rawResponse);}}
You can consume binary data from endpoints using theBinaryResponse type which lets you choose how to consume the data:
constresponse=awaitclient.fileStash.downloadFile(...);conststream:ReadableStream<Uint8Array>=response.stream();// const arrayBuffer: ArrayBuffer = await response.arrayBuffer();// const blob: Blob = response.blob();// const bytes: Uint8Array = response.bytes();// You can only use the response body once, so you must choose one of the above methods.// If you want to check if the response body has been used, you can use the following property.constbodyUsed=response.bodyUsed;
Save binary response to a file
Node.js
ReadableStream (most-efficient)
import{createWriteStream}from'fs';import{Readable}from'stream';import{pipeline}from'stream/promises';constresponse=awaitclient.fileStash.downloadFile(...);conststream=response.stream();constnodeStream=Readable.fromWeb(stream);constwriteStream=createWriteStream('path/to/file');awaitpipeline(nodeStream,writeStream);ArrayBuffer
import{writeFile}from'fs/promises';constresponse=awaitclient.fileStash.downloadFile(...);constarrayBuffer=awaitresponse.arrayBuffer();awaitwriteFile('path/to/file',Buffer.from(arrayBuffer));Blob
import{writeFile}from'fs/promises';constresponse=awaitclient.fileStash.downloadFile(...);constblob=awaitresponse.blob();constarrayBuffer=awaitblob.arrayBuffer();awaitwriteFile('output.bin',Buffer.from(arrayBuffer));Bytes (UIntArray8)
import{writeFile}from'fs/promises';constresponse=awaitclient.fileStash.downloadFile(...);constbytes=awaitresponse.bytes();awaitwriteFile('path/to/file',bytes);
Bun
ReadableStream (most-efficient)
constresponse=awaitclient.fileStash.downloadFile(...);conststream=response.stream();awaitBun.write('path/to/file',stream);ArrayBuffer
constresponse=awaitclient.fileStash.downloadFile(...);constarrayBuffer=awaitresponse.arrayBuffer();awaitBun.write('path/to/file',arrayBuffer);Blob
constresponse=awaitclient.fileStash.downloadFile(...);constblob=awaitresponse.blob();awaitBun.write('path/to/file',blob);Bytes (UIntArray8)
constresponse=awaitclient.fileStash.downloadFile(...);constbytes=awaitresponse.bytes();awaitBun.write('path/to/file',bytes);
Deno
ReadableStream (most-efficient)
constresponse=awaitclient.fileStash.downloadFile(...);conststream=response.stream();constfile=awaitDeno.open('path/to/file',{write:true,create:true});awaitstream.pipeTo(file.writable);ArrayBuffer
constresponse=awaitclient.fileStash.downloadFile(...);constarrayBuffer=awaitresponse.arrayBuffer();awaitDeno.writeFile('path/to/file',newUint8Array(arrayBuffer));Blob
constresponse=awaitclient.fileStash.downloadFile(...);constblob=awaitresponse.blob();constarrayBuffer=awaitblob.arrayBuffer();awaitDeno.writeFile('path/to/file',newUint8Array(arrayBuffer));Bytes (UIntArray8)
constresponse=awaitclient.fileStash.downloadFile(...);constbytes=awaitresponse.bytes();awaitDeno.writeFile('path/to/file',bytes);
Browser
Blob (most-efficient)
constresponse=awaitclient.fileStash.downloadFile(...);constblob=awaitresponse.blob();consturl=URL.createObjectURL(blob);// trigger downloadconsta=document.createElement('a');a.href=url;a.download='filename';a.click();URL.revokeObjectURL(url);ReadableStream
constresponse=awaitclient.fileStash.downloadFile(...);conststream=response.stream();constreader=stream.getReader();constchunks=[];while(true){const{ done, value}=awaitreader.read();if(done)break;chunks.push(value);}constblob=newBlob(chunks);consturl=URL.createObjectURL(blob);// trigger downloadconsta=document.createElement('a');a.href=url;a.download='filename';a.click();URL.revokeObjectURL(url);ArrayBuffer
constresponse=awaitclient.fileStash.downloadFile(...);constarrayBuffer=awaitresponse.arrayBuffer();constblob=newBlob([arrayBuffer]);consturl=URL.createObjectURL(blob);// trigger downloadconsta=document.createElement('a');a.href=url;a.download='filename';a.click();URL.revokeObjectURL(url);Bytes (UIntArray8)
constresponse=awaitclient.fileStash.downloadFile(...);constbytes=awaitresponse.bytes();constblob=newBlob([bytes]);consturl=URL.createObjectURL(blob);// trigger downloadconsta=document.createElement('a');a.href=url;a.download='filename';a.click();URL.revokeObjectURL(url);
Convert binary response to text
ReadableStream
constresponse=awaitclient.fileStash.downloadFile(...);conststream=response.stream();consttext=awaitnewResponse(stream).text();
ArrayBuffer
constresponse=awaitclient.fileStash.downloadFile(...);constarrayBuffer=awaitresponse.arrayBuffer();consttext=newTextDecoder().decode(arrayBuffer);
Blob
constresponse=awaitclient.fileStash.downloadFile(...);constblob=awaitresponse.blob();consttext=awaitblob.text();
Bytes (UIntArray8)
constresponse=awaitclient.fileStash.downloadFile(...);constbytes=awaitresponse.bytes();consttext=newTextDecoder().decode(bytes);
List endpoints are paginated. The SDK provides an iterator so that you can simply loop over the items:
import{PipedreamClient}from"@pipedream/sdk";constclient=newPipedreamClient({clientId:"YOUR_CLIENT_ID",clientSecret:"YOUR_CLIENT_SECRET",projectEnvironment:"YOUR_PROJECT_ENVIRONMENT",projectId:"YOUR_PROJECT_ID"});constresponse=awaitclient.apps.list({after:"after",before:"before",limit:1,q:"q",sortKey:"name",sortDirection:"asc",hasComponents:true,hasActions:true,hasTriggers:true});forawait(constitemofresponse){console.log(item);}// Or you can manually iterate page-by-pageletpage=awaitclient.apps.list({after:"after",before:"before",limit:1,q:"q",sortKey:"name",sortDirection:"asc",hasComponents:true,hasActions:true,hasTriggers:true});while(page.hasNextPage()){page=page.getNextPage();}
If you would like to send additional headers as part of the request, use theheaders request option.
constresponse=awaitclient.actions.run(...,{headers:{'X-Custom-Header':'custom value'}});
If you would like to send additional query string parameters as part of the request, use thequeryParams request option.
constresponse=awaitclient.actions.run(...,{queryParams:{'customQueryParamKey':'custom query param value'}});
The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as longas the request is deemed retryable and the number of retry attempts has not grown larger than the configuredretry limit (default: 2).
A request is deemed retryable when any of the following HTTP status codes is returned:
Use themaxRetries request option to configure this behavior.
constresponse=awaitclient.actions.run(...,{maxRetries:0// override maxRetries at the request level});
The SDK defaults to a 60 second timeout. Use thetimeoutInSeconds option to configure this behavior.
constresponse=awaitclient.actions.run(...,{timeoutInSeconds:30// override timeout to 30s});
The SDK allows users to abort requests at any point by passing in an abort signal.
constcontroller=newAbortController();constresponse=awaitclient.actions.run(...,{abortSignal:controller.signal});controller.abort();// aborts the request
The SDK provides access to raw response data, including headers, through the.withRawResponse() method.The.withRawResponse() method returns a promise that results to an object with adata and arawResponse property.
const{ data, rawResponse}=awaitclient.actions.run(...).withRawResponse();console.log(data);console.log(rawResponse.headers['X-My-Header']);
The SDK works in the following runtimes:
- Node.js 18+
- Vercel
- Cloudflare Workers
- Deno v1.25+
- Bun 1.0+
- React Native
The SDK provides a way for you to customize the underlying HTTP client / Fetch function. If you're running in anunsupported environment, this provides a way for you to break glass and ensure the SDK works.
import{PipedreamClient}from"@pipedream/sdk";constclient=newPipedreamClient({ ...fetcher:// provide your implementation here});
While we value open-source contributions to this SDK, this library is generated programmatically.Additions made directly to this library would have to be moved over to our generation code,otherwise they would be overwritten upon the next generated release. Feel free to open a PR asa proof of concept, but know that we will not be able to merge it as-is. We suggest openingan issue first to discuss with us!
On the other hand, contributions to the README are always very welcome!
About
TypeScript SDK for Pipedream
Resources
License
Uh oh!
There was an error while loading.Please reload this page.
Stars
Watchers
Forks
Packages0
Uh oh!
There was an error while loading.Please reload this page.