
Research
Security News
The Landscape of Malicious Open Source Packages: 2025 Mid‑Year Threat Report
A look at the top trends in how threat actors are weaponizing open source packages to deliver malware and persist across the software supply chain.
@forgerock/crest-js
Advanced tools
Lightweight Library for Communicating With ForgeRock CREST APIs.
ForgeRock CREST.js requires the fetch
and Promise
APIs to be available in the global environment.
ForgeRock CREST.js supports CREST versions 2.0 and 2.1.
import { CRESTv2, CRESTv2_1 } from "@forgerock/crest-js";
yarn add @forgerock/crest-js
npm install @forgerock/crest-js
import { CRESTv2 } from "@forgerock/crest-js";
const resource = new CRESTv2("http://www.domain.com/crest/api");
resource.get("id").then(json => {
// Success! `json` is an Object
}, error => {
if (error instanceof CRESTError) {
// CREST error
} else if (error instanceof RequestError) {
// Request could not be completed e.g. network failure
} else if (error instanceof ParseError) {
// Response couldn't be parsed as JSON
}
});
All the functions upon a CREST resource return Promises.
Promises allow for easily building on top of the core functionality, for example, with common handlers that deal with rejections consistently.
import { CRESTv2_1 } from "@forgerock/crest-js";
const resource = new CRESTv2_1("http://www.domain.com/crest/api");
const body = { data: "value" };
// #action
resource.action("action");
resource.action("action", { body }); // Action with body
// #create
resource.create(body); // Server provided ID
resource.create(body, { id: "id" }); // Client provided ID
// #delete
resource.delete("id");
// #get
resource.get("id");
// #queryFilter
resource.queryFilter(); // Only supports `_queryFilter=true`
// #update
resource.update("id", body);
Pagination is currently only supported via the additional query strings option queryString
.
See the API Documentation for all possible options.
queryString
For adding additional query strings to the any request.
import { CRESTv2 } from "@forgerock/crest-js";
const resource = new CRESTv2("http://www.domain.com/crest/api");
resource.get("id", {
queryString: {
query: "value"
}
})
// => http://www.domain.com/crest/api/id?query=value
Query strings applied by ForgeRock CREST.js cannot be overridden.
import { CRESTv2 } from "@forgerock/crest-js";
const resource = new CRESTv2("http://www.domain.com/crest/api");
resource.action("action1", {
queryString: {
_action: "action2"
}
})
// => http://www.domain.com/crest/api?_action=action1
One or many middleware can be applied to an CREST resource.
Each middleware is a function that takes a single Promise parameter, and returns a Promise to pass to the next middleware.
The first middleware in the chain is guaranteed to receive a Promise which is either resolved to a parsed JSON payload, or rejected with one of the defined error types.
import { CRESTv2_1 } from "@forgerock/crest-js";
const customMiddleware = (promise) => {
return promise.then((json) => {
// Success! `json` is an Object
const jsonToReturn = {
...json,
myAttribute: true
};
// Return value will be passed the next middleware
return json;
}, (error) => {
// Capture, rethrow or modify errors
throw new CustomError(error.message);
});
};
const resource = new CRESTv2_1("http://www.domain.com/crest/api", {
middleware: [customMiddleware]
});
dist/ # Output of "yarn run build".
config/ # Tooling configuration files.
docs/ # API documentation And output of "yarn run docs".
src/ # Source code.
├── .babelrc # Babel configuration for source when executing "yarn run test" or "yarn run test:coverage".
└── ...
Builds production CommonJS, ES and UMD versions into /dist
.
yarn run build
Generates API JSDoc into /docs
.
yarn run docs
Runs tests against the source.
yarn run test
The yarn
command will pass arguments to the underlying command. For examples, use yarn run test --verbose --watch
for continuous testing with extra output.
Generates test coverage report.
yarn run test:coverage
Contribute to ForgeRock CREST.js by opening a Pull Request.
FAQs
Lightweight Library for Communicating With ForgeRock CREST APIs.
The npm package @forgerock/crest-js receives a total of 1,023 weekly downloads. As such, @forgerock/crest-js popularity was classified as popular.
We found that @forgerock/crest-js demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 4 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.
Research
Security News
A look at the top trends in how threat actors are weaponizing open source packages to deliver malware and persist across the software supply chain.
Security News
ESLint now supports HTML linting with 48 new rules, expanding its language plugin system to cover more of the modern web development stack.
Security News
CISA is discontinuing official RSS support for KEV and cybersecurity alerts, shifting updates to email and social media, disrupting automation workflows.