The Abstract SDK provides universal JavaScript bindings for both the Abstract API and the Abstract CLI.

Installation

The SDK is available as a Node.js module available via the public NPM registry. An underlying Node.js version of 10.0.0 or higher is required.

npm install abstract-sdk

Please see the installation guide for more information.

Documentation

Complete SDK documentation can be found at https://developer.abstract.com.

The following community resources are available to help you get started quickly with the SDK:

• Documentation website
• Abstract help center
• Abstract support
• Still stuck? File an issue!

Contributing

This project is maintained by a team at Abstract. Outside contributions are highly encouraged, but please ensure that a relevant issue exists and that an approach has been discussed before beginning to write code. This makes it more likely that your contribution will be accepted and ensures that your time is not wasted.

Please see the contributors guide for more information.

License

MIT

Changelog

All notable changes to this project will be documented in this file. See standard-version for commit guidelines.

8.1.5 (2024-05-15)

Bug Fixes

• export files with slashes in their names (#368) (f9e157b)

8.1.4 (2023-07-25)

8.1.3 (2023-07-25)

Bug Fixes

• Optional proxy agent param to fetch (#338) (7ce38d2)

8.1.2 (2021-05-21)

8.1.2-0 (2021-05-17)

Bug Fixes

• Pipe optional proxy agent param to fetch (179246f)

8.1.1 (2021-04-05)

Bug Fixes

• increase file export timeout for api transport (#329) (a4b51d3)

8.1.0 (2020-11-16)

Features

• adds update method to Branch endpoint (#309) (a5375fc)

Bug Fixes

• Add missing invariant to deps (#318) (0041fd3), closes #316
• Broken wordmark image in README (#306) (3507f65)
• Mark stream dep as node only (#319) (20bc063)

8.0.0-beta.38 (2020-10-20)

Features

• passes user params to cli request to enable it (eed942b)
• updates branches.update tests (b0b858a)

8.0.0-beta.37 (2020-09-17)

Features

• adds update method to Branch endpoint (1eef2f0), adds respective tests (b1ee544), and updates sdk docs (eb4852b)

Bug Fixes

• Broken wordmark image in README (#306) (3507f65)

8.0.0-beta.36 (2020-07-31)

Bug Fixes

• Broken error handling (#302) (c48321c)

8.0.0-beta.35 (2020-07-29)

8.0.0-beta.34 (2020-07-29)

Bug Fixes

• Add ValidationError class (#301) (2d4f9c5), closes #279
• Incorrect enum for project visibility (#299) (cdbf2a4)
• Update API version passed to project create/update (#300) (2e2b381)

8.0.0-beta.33 (2020-07-20)

Features

• Allows listing of branches for user of an organization and project (#293) (0849b63)

8.0.0-beta.32 (2020-07-06)

Bug Fixes

• Correctly handle error when CLI response is unparsable (#269) (ffd5618)
• Optional Error.captureStackTrace (#259) (5fb24fd)
• typo in name (#283) (6748cff)

Features

• Add ability to set a shareId (#267) (23f9ed0)
• add marketo analytics to documentation website (#281) (05c1b57)
• list files from a commit (#275) (cc97e76)
• update cli (#284) (e24b149)
• docs: add description for an iframe aspect ratio fix (#263) (9f19c3f)
• docs: document layer properties (#264) (9dbeea7)

8.0.0-beta.31 (2020-06-26)

Bug Fixes

• typo in name (#283) (6748cff)

Features

• list files from a commit (#275) (cc97e76)
• update cli (#284) (e24b149)

8.0.0-beta.29 (2020-05-07)

Bug Fixes

• Optional Error.captureStackTrace (#259) (5fb24fd)

Features

• Add ability to set a shareId (#267) (23f9ed0)
• docs: add description for an iframe aspect ratio fix (#263) (9f19c3f)
• docs: document layer properties (#264) (9dbeea7)

8.0.0-beta.27 (2020-04-21)

Bug Fixes

• 'active' filter with latest CLI only filters to specifically active branches (#257) (52c194c)
• Add perfomance from perf_hooks (Node v8.5.0+) (#251) (6773642), closes #252
• edit config.yml so yarn check-ts-types would not override flow (02ae3de)

Features

• add Abstract.MultiError (#250) (be99dae)
• Add func generators support (#245) (b61cd55)

8.0.0-beta.22 (2020-04-10)

Features

• allow analytics callback to be set on Client (#248) (28d3d9b)

8.0.0-beta.25 (2020-04-15)

Features

• add Abstract.MultiError (#250) (be99dae)
• add regenerator runtime polyfill for ie11 (aacc231)

8.0.0-beta.24 (2020-04-15)

Features

• add Abstract.MultiError (#250) (be99dae)
• add regenerator runtime polyfill for ie11 (aacc231)

8.0.0-beta.23 (2020-04-13)

Features

• add check-ts-types to circleCI (bd3c9b4)

8.0.0-beta.24 (2020-04-14)

Features

• add script for checking types in abstract.d.ts (75658a2)

• add Abstract.MultiError (d70227d)

8.0.0-beta.19 (2020-03-19)

Bug Fixes

• Return branch merge state at top level of CLI response (#237) (4dc001a)

8.0.0-beta.18 (2020-03-18)

Bug Fixes

• Respect transportMode for branches.mergeState (#236) (5805c51)

8.0.0-beta.17 (2020-03-18)

Bug Fixes

• Type ErrorData in abstract-sdk.d.ts (#227) (4b45070)

Features

• branches merge state (#232) (024c5a2)

8.0.0-beta.16 (2020-03-12)

Features

• Add projects changeset support (#233) (9b829b9)

8.0.0-beta.15 (2020-03-10)

Bug Fixes

• Allow abstract.com domain for share links and expose inferShareId (#217) (7789a92)
• data endpoint needs to pass branch id to cli (#208) (328e5ef)
• embed generator (#213) (42f466d)
• support branch pagination (#221) (34e6a42)

Features

• add ability to manage project and section stars (bc8a31f)
• add layer dependency filtering options (#207) (88705e8)
• add layer filtering options to cli transport (#209) (42006ab)
• add review requests to API transport (09b64c8)
• api file export (#199) (d2d310f)
• support branch searching (#206) (2517a8d)
• support full project CRUD (#201) (a000ca6)
• update collections list parameters (#214) (dcb290a)

BREAKING CHANGES

• api file export (#199)

8.0.0-beta.13 (2020-03-02)

Bug Fixes

• Allow abstract.com domain for share links and expose inferShareId (#217) (7789a92)
• data endpoint needs to pass branch id to cli (#208) (328e5ef)
• embed generator (#213) (42f466d)
• support branch pagination (#221) (34e6a42)

Features

• add ability to manage project and section stars (bc8a31f)
• add layer dependency filtering options (#207) (88705e8)
• add layer filtering options to cli transport (#209) (42006ab)
• add review requests to API transport (09b64c8)
• support full project CRUD (#201) (a000ca6)
• update collections list parameters (#214) (dcb290a)

8.0.0-beta.7 (2020-01-16)

Features

• api file export (#199) (d2d310f)

BREAKING CHANGES

• api file export (#199)

7.0.1 (2019-12-16)

Bug Fixes

• move js-sha256 from devDependencies to dependencies (#178) (f9b93b3)

7.0.0 (2019-12-14)

Bug Fixes

• Incorrect casing on commits.list parameters (#176) (457c0a7)

Features

• add webhooks verification endpoint (25b70cd)
• Remove need to pass branchId to load a commit (#173) (c016216)

BREAKING CHANGES

• • CommitDescriptor renamed to BranchCommitDescriptor
• commits.info no longer requires a branch ID to load a commit

6.0.1 (2019-12-12)

Bug Fixes

• do not use aliases for easier external consumption (52d7597)

6.0.0 (2019-12-09)

6.0.0-beta.0 (2019-12-06)

Features

• multi transport support (2ff3ce2)

BREAKING CHANGES

• • transportMode is now an array of strings, e.g. ["cli", "api"].
• The specified transports will be tried sequentially until one succeeds.
• If no transport succeeds, a MultiError will be thrown with references to all transport errors.
• Every SDK endpoint now accepts an options argument that can be used to specify a one-off transportMode that overrides the globally-configured transportMode.
• Client caching via maxCacheSize has been removed.

5.0.0 (2019-11-26)

Bug Fixes

• document CursorPromise-returning methods and update TypeScript definition (ddedc5a)
• don't require abstract-cli in the browser (#169) (d65f78b)
• remove deprecated description key fom project type (1535731)
• remove deprecated description key fom project type (8362134)

Features

• add batch collection layer support (4f840b3)
• add file assets endpoint (2ebc219)
• add webhooks API endpoint (ded4e91)

BREAKING CHANGES

• LayerDescriptor was renamed to LayerVersionDescriptor
• assets.list was renamed to assets.commit

4.0.3 (2019-10-30)

Bug Fixes

• don't require abstract-cli in the browser (#169) (d65f78b)

4.0.2 (2019-10-29)

Bug Fixes

• add missing projectId property to CollectionLayer type (#168) (5f9e77a)

4.0.1 (2019-10-22)

4.0.0 (2019-10-22)

Bug Fixes

• embed documentation typo &chromless -> ?chromeless (#161) (d7a9b4a)

Features

• add CollectionLayers endpoint (be2c6aa)
• add support for branch changesets (9d79909)

BREAKING CHANGES

• changesets.info was ranamed to changesets.commit

3.1.1 (2019-09-23)

Bug Fixes

• reliably use local CLI path via require (845540e)

3.1.0 (2019-09-17)

Bug Fixes

• remove pageId from LayerDescriptor examples (#159) (63fac47)

Features

• add sections support to the API transport (6f910f6)

3.0.0 (2019-09-09)

Features

• externalize asset URL configuration (9b53624)

BREAKING CHANGES

• previewsUrl was changed to previewUrl

2.0.0 (2019-08-19)

Features

• add abstract-cli as a dependency (65911c4)

BREAKING CHANGES

• cliPath is no longer configurable

1.9.0 (2019-08-08)

Bug Fixes

• disable caching of non-static entities (#151) (98ad004)
• ignore test files when generating typings (#150) (27af92c)

Features

• embed code generator (467fcb3)

1.8.0 (2019-07-24)

Bug Fixes

• await the CLI request in files.raw (#147) (2e9808b)
• update example in rate limit documentation (6302f72)
• update example in rate limit documentation (720d18c)
• update pageId usage in documentation (e1e3658)

Features

• add hand-rolled TypeScript definitions (#148) (e945a55)
• update embed documentation to include collections (37b4d22)
• update rate limit documentation (b331000)
• use Abstract.sketch instead of Abstract.Sketch in documentation (a002cf4)

1.7.1 (2019-06-28)

Bug Fixes

• exclude Node modules from browser builds (97711f5)

1.7.0 (2019-06-27)

Bug Fixes

• do not ship test files (5a4c767)

Features

• update changelog (26e4868)
• update contributing guide with standard-version info (abd8595)
• use standard-version and conventional-commits (#141) (9d9a6a0)