@amp-labs/sdk-node
Advanced tools
<img src="https://res.cloudinary.com/dycvts6vp/image/upload/v1723671980/ampersand-logo-black.svg
Ampersand is a declarative platform for SaaS builders who are creating product integrations. It allows you to:
This repo hosts a developer-friendly & type-safe Typescript SDK specifically catered to leverage the Ampersand API.
The SDK can be installed with either npm, pnpm, bun or yarn package managers.
npm add @amp-labs/sdk-node
pnpm add @amp-labs/sdk-node
bun add @amp-labs/sdk-node
yarn add @amp-labs/sdk-node zod
# Note that Yarn does not install peer dependencies automatically. You will need
# to install zod as shown above.
For supported JavaScript runtimes, please consult RUNTIMES.md.
import { SDK } from "@amp-labs/sdk-node";
const sdk = new SDK({
apiKeyHeader: "<YOUR_API_KEY_HERE>",
});
async function run() {
const result = await sdk.read.records({
projectIdOrName: "<value>",
integrationId: "<id>",
objectName: "<value>",
requestBody: {
groupRef: "<value>",
mode: "async",
sinceTimestamp: "2024-07-01T18:22:30.323771761Z",
},
});
// Handle the result
console.log(result);
}
run();
This SDK supports the following security scheme globally:
| Name | Type | Scheme |
|---|---|---|
apiKeyHeader | apiKey | API key |
To authenticate with the API the apiKeyHeader parameter must be set when initializing the SDK client instance. For example:
import { SDK } from "@amp-labs/sdk-node";
const sdk = new SDK({
apiKeyHeader: "<YOUR_API_KEY_HERE>",
});
async function run() {
const result = await sdk.read.records({
projectIdOrName: "<value>",
integrationId: "<id>",
objectName: "<value>",
requestBody: {
groupRef: "<value>",
mode: "async",
sinceTimestamp: "2024-07-01T18:22:30.323771761Z",
},
});
// Handle the result
console.log(result);
}
run();
All the methods listed above are available as standalone functions. These functions are ideal for use in applications running in the browser, serverless runtimes or other environments where application bundle size is a primary concern. When using a bundler to build your application, all unused functionality will be either excluded from the final bundle or tree-shaken away.
To read more about standalone functions, check FUNCTIONS.md.
connectionsDelete - Delete a connectionconnectionsGenerate - Generate a new connectionconnectionsGet - Get a connectionconnectionsList - List connectionsconsumersCreate - Create a new consumerdestinationsCreate - Create a new destinationdestinationsDelete - Delete a destinationdestinationsGet - Get a destinationdestinationsList - List destinationsdestinationsUpdate - Update a destinationgroupsCreate - Create a new groupinstallationsCreate - Create a new installationinstallationsDelete - Delete an installationinstallationsGet - Get an installationinstallationsList - List installationsinstallationsUpdate - Update an installationintegrationsBatchUpsert - Batch upsert a group of integrationsintegrationsCreate - Create a new integrationintegrationsDelete - Delete an integrationintegrationsList - List integrationsoauthConnect - Get URL for OAuth flowobjectsAndFieldsGetMetadataForConnection - Get object metadata for connectionobjectsAndFieldsGetMetadataForInstallation - Get object metadata for installationoperationsGet - Get an operationoperationsList - List operationsoperationsListLogs - List logs for an operationprojectsCreate - Create a new projectprojectsDelete - Delete a projectprojectsGet - Get a projectprojectsList - List all projects that the API key or user credential has access toprojectsUpdate - Update a projectproviderAppsCreate - Create a new provider appproviderAppsDelete - Delete a provider appproviderAppsList - List provider appsproviderAppsUpdate - Update a provider appprovidersGet - Get providerprovidersList - List providersreadDeliverResults - Deliver resultsreadRecords - Trigger a readrevisionsCreate - Create a new revisionrevisionsHydrate - Hydrate a revisionuploadUrlsGenerate - Generate a signed URL to upload a zip file to.Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.
To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:
import { SDK } from "@amp-labs/sdk-node";
const sdk = new SDK({
apiKeyHeader: "<YOUR_API_KEY_HERE>",
});
async function run() {
const result = await sdk.read.records({
projectIdOrName: "<value>",
integrationId: "<id>",
objectName: "<value>",
requestBody: {
groupRef: "<value>",
mode: "async",
sinceTimestamp: "2024-07-01T18:22:30.323771761Z",
},
}, {
retries: {
strategy: "backoff",
backoff: {
initialInterval: 1,
maxInterval: 50,
exponent: 1.1,
maxElapsedTime: 100,
},
retryConnectionErrors: false,
},
});
// Handle the result
console.log(result);
}
run();
If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:
import { SDK } from "@amp-labs/sdk-node";
const sdk = new SDK({
retryConfig: {
strategy: "backoff",
backoff: {
initialInterval: 1,
maxInterval: 50,
exponent: 1.1,
maxElapsedTime: 100,
},
retryConnectionErrors: false,
},
apiKeyHeader: "<YOUR_API_KEY_HERE>",
});
async function run() {
const result = await sdk.read.records({
projectIdOrName: "<value>",
integrationId: "<id>",
objectName: "<value>",
requestBody: {
groupRef: "<value>",
mode: "async",
sinceTimestamp: "2024-07-01T18:22:30.323771761Z",
},
});
// Handle the result
console.log(result);
}
run();
Some methods specify known errors which can be thrown. All the known errors are enumerated in the models/errors/errors.ts module. The known errors for a method are documented under the Errors tables in SDK docs. For example, the records method may throw the following errors:
| Error Type | Status Code | Content Type |
|---|---|---|
| errors.TriggerReadAPIProblem | 400 | application/json |
| errors.TriggerReadReadAPIProblem | 500 | application/json |
| errors.APIError | 4XX, 5XX | */* |
If the method throws an error and it is not captured by the known errors, it will default to throwing a APIError.
import { SDK } from "@amp-labs/sdk-node";
import {
SDKValidationError,
TriggerReadAPIProblem,
TriggerReadReadAPIProblem,
} from "@amp-labs/sdk-node/models/errors";
const sdk = new SDK({
apiKeyHeader: "<YOUR_API_KEY_HERE>",
});
async function run() {
let result;
try {
result = await sdk.read.records({
projectIdOrName: "<value>",
integrationId: "<id>",
objectName: "<value>",
requestBody: {
groupRef: "<value>",
mode: "async",
sinceTimestamp: "2024-07-01T18:22:30.323771761Z",
},
});
// Handle the result
console.log(result);
} catch (err) {
switch (true) {
// The server response does not match the expected SDK schema
case (err instanceof SDKValidationError): {
// Pretty-print will provide a human-readable multi-line error message
console.error(err.pretty());
// Raw value may also be inspected
console.error(err.rawValue);
return;
}
case (err instanceof TriggerReadAPIProblem): {
// Handle err.data$: TriggerReadAPIProblemData
console.error(err);
return;
}
case (err instanceof TriggerReadReadAPIProblem): {
// Handle err.data$: TriggerReadReadAPIProblemData
console.error(err);
return;
}
default: {
// Other errors such as network errors, see HTTPClientErrors for more details
throw err;
}
}
}
}
run();
Validation errors can also occur when either method arguments or data returned from the server do not match the expected format. The SDKValidationError that is thrown as a result will capture the raw value that failed validation in an attribute called rawValue. Additionally, a pretty() method is available on this error that can be used to log a nicely formatted multi-line string since validation errors can list many issues and the plain error string may be difficult read when debugging.
In some rare cases, the SDK can fail to get a response from the server or even make the request due to unexpected circumstances such as network conditions. These types of errors are captured in the models/errors/httpclienterrors.ts module:
| HTTP Client Error | Description |
|---|---|
| RequestAbortedError | HTTP request was aborted by the client |
| RequestTimeoutError | HTTP request timed out due to an AbortSignal signal |
| ConnectionError | HTTP client was unable to make a request to a server |
| InvalidRequestError | Any input used to create a request is invalid |
| UnexpectedClientError | Unrecognised or unexpected error |
The default server can be overridden globally by passing a URL to the serverURL: string optional parameter when initializing the SDK client instance. For example:
import { SDK } from "@amp-labs/sdk-node";
const sdk = new SDK({
serverURL: "https://read.withampersand.com/v1",
apiKeyHeader: "<YOUR_API_KEY_HERE>",
});
async function run() {
const result = await sdk.read.records({
projectIdOrName: "<value>",
integrationId: "<id>",
objectName: "<value>",
requestBody: {
groupRef: "<value>",
mode: "async",
sinceTimestamp: "2024-07-01T18:22:30.323771761Z",
},
});
// Handle the result
console.log(result);
}
run();
The server URL can also be overridden on a per-operation basis, provided a server list was specified for the operation. For example:
import { SDK } from "@amp-labs/sdk-node";
const sdk = new SDK();
async function run() {
const result = await sdk.oauth.connect({
providerWorkspaceRef: "salesforce-instance-domain",
projectId: "<id>",
groupRef: "<value>",
consumerRef: "<value>",
provider: "salesforce",
}, {
serverURL: "https://api.withampersand.com/v1",
});
// Handle the result
console.log(result);
}
run();
The TypeScript SDK makes API calls using an HTTPClient that wraps the native
Fetch API. This
client is a thin wrapper around fetch and provides the ability to attach hooks
around the request lifecycle that can be used to modify the request or handle
errors and response.
The HTTPClient constructor takes an optional fetcher argument that can be
used to integrate a third-party HTTP client or when writing tests to mock out
the HTTP client and feed in fixtures.
The following example shows how to use the "beforeRequest" hook to to add a
custom header and a timeout to requests and how to use the "requestError" hook
to log errors:
import { SDK } from "@amp-labs/sdk-node";
import { HTTPClient } from "@amp-labs/sdk-node/lib/http";
const httpClient = new HTTPClient({
// fetcher takes a function that has the same signature as native `fetch`.
fetcher: (request) => {
return fetch(request);
}
});
httpClient.addHook("beforeRequest", (request) => {
const nextRequest = new Request(request, {
signal: request.signal || AbortSignal.timeout(5000)
});
nextRequest.headers.set("x-custom-header", "custom value");
return nextRequest;
});
httpClient.addHook("requestError", (error, request) => {
console.group("Request Error");
console.log("Reason:", `${error}`);
console.log("Endpoint:", `${request.method} ${request.url}`);
console.groupEnd();
});
const sdk = new SDK({ httpClient });
You can setup your SDK to emit debug logs for SDK requests and responses.
You can pass a logger that matches console's interface as an SDK option.
[!WARNING] Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.
import { SDK } from "@amp-labs/sdk-node";
const sdk = new SDK({ debugLogger: console });
This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.
While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.
FAQs
<img src="https://res.cloudinary.com/dycvts6vp/image/upload/v1723671980/ampersand-logo-black.svg
The npm package @amp-labs/sdk-node receives a total of 0 weekly downloads. As such, @amp-labs/sdk-node popularity was classified as not popular.
We found that @amp-labs/sdk-node demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Newly introduced telemetry in devenv 1.4 sparked a backlash over privacy concerns, leading to the removal of its AI-powered feature after strong community pushback.
Security News
TC39 met in Seattle and advanced 9 JavaScript proposals, including three to Stage 4, introducing new features and enhancements for a future ECMAScript release.
Security News
Deno 2.2 enhances Node.js compatibility, improves dependency management, adds OpenTelemetry support, and expands linting and task automation for developers.