Security News
tea.xyz Spam Plagues npm and RubyGems Package Registries
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
@flatfile/api-beta
Advanced tools
Readme
The Flatfile Node.js library provides convenient access to the Flatfile API from JavaScript/TypeScript.
API reference documentation is available here.
npm install --save @flatfile/api-beta
# or
yarn add @flatfile/api-beta
import { Flatfile, FlatfileClient } from '@flatfile/api-beta';
const flatfile = new FlatfileClient({
clientId: 'YOUR_CLIENT_ID',
clientSecret: 'YOUR_CLIENT_SECRET',
});
const environment = await flatfile.environments.create({
name: 'dev',
isProd: false,
newSpacesInherit: false,
guestAuthentication: [Flatfile.GuestAuthentication.SharedLink],
});
console.log('Created environment with id', environment.id);
When the API returns a non-success status code (4xx or 5xx response), a subclass of FlatfileError will be thrown:
try {
await client.agents.get("environment-id", "agent-id");
} catch (err) {
if (err instanceof FlatfileError) {
console.log(err.statusCode); // 400
console.log(err.message); // "BadRequestError"
console.log(err.body); // list of errors
}
}
Error codes are as followed:
Status Code | Error Type |
---|---|
400 | BadRequestError |
404 | NotFoundError |
The flatfile platform emits different events (e.g. user:added
, webhook:removed
). The SDK uses discriminated unions that make it easy to handle specific events.
const event = eventResponse.data;
if (event.type === 'job:started') {
console.log(event.payload.operation); // FILE
console.log(event.payload.type); // PIPELINE
} else if (event.type === 'records:created') {
console.log(event.payload.count) // 100
}
The SDK uses discriminated unions that make it easy to introspect different fields.
for (const field of sheet.config.fields) {
if (field.type === 'boolean') {
console.log(field.config?.allowIndeterminate); // false
} else if (field.type === "number") {
console.log(field.config?.decimalPlaces); // 2
} else if (field.type === "enum") {
console.log(field.config.allowCustom); // true
}
}
This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning the package version to a specific version in your package.json file. 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. 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 as a proof of concept, but know that we will not be able to merge it as-is. We suggest opening an issue first to discuss with us!
On the other hand, contributions to the README are always very welcome!
FAQs
[![npm shield](https://img.shields.io/npm/v/@flatfile/api-beta)](https://www.npmjs.com/package/@flatfile/api-beta) [![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://github.com/fern-api/fern)
The npm package @flatfile/api-beta receives a total of 0 weekly downloads. As such, @flatfile/api-beta popularity was classified as not popular.
We found that @flatfile/api-beta demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 25 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
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.