owasp-nest

Developer-friendly & type-safe Typescript SDK specifically catered to leverage owasp-nest API.

Summary

OWASP Nest: Open Worldwide Application Security Project API

SDK Installation

The SDK can be installed with either npm, pnpm, bun or yarn package managers.

NPM

npm add owasp-nest

PNPM

pnpm add owasp-nest

Bun

bun add owasp-nest

Yarn

yarn add owasp-nest

Note

This package is published with CommonJS and ES Modules (ESM) support.

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

SDK Example Usage

Example

import { Nest } from "owasp-nest";

const nest = new Nest({
  apiKey: process.env["NEST_API_KEY"] ?? "",
});

async function run() {
  const result = await nest.chapters.listChapters({
    country: "India",
  });

  console.log(result);
}

run();

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

Name	Type	Scheme	Environment Variable
`apiKey`	apiKey	API key	`NEST_API_KEY`

To authenticate with the API the apiKey parameter must be set when initializing the SDK client instance. For example:

import { Nest } from "owasp-nest";

const nest = new Nest({
  apiKey: process.env["NEST_API_KEY"] ?? "",
});

async function run() {
  const result = await nest.chapters.listChapters({
    country: "India",
  });

  console.log(result);
}

run();

Available Resources and Operations

Available methods

chapters

listChapters - List chapters
getChapter - Get chapter

committees

listCommittees - List committees
getCommittee - Get committee

community

listMembers - List members
getMember - Get member
listOrganizations - List organizations
getOrganization - Get organization

events

listEvents - List events
getEvent - Get event

issues

listIssues - List issues
getIssue - Get issue

projects

listProjects - List projects
getProject - Get project

releases

listReleases - List releases
getRelease - Get release

repositories

listRepositories - List repositories
getRepository - Get repository

Standalone functions

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.

Available standalone functions

chaptersGetChapter - Get chapter
chaptersListChapters - List chapters
committeesGetCommittee - Get committee
committeesListCommittees - List committees
communityGetMember - Get member
communityGetOrganization - Get organization
communityListMembers - List members
communityListOrganizations - List organizations
eventsGetEvent - Get event
eventsListEvents - List events
issuesGetIssue - Get issue
issuesListIssues - List issues
projectsGetProject - Get project
projectsListProjects - List projects
releasesGetRelease - Get release
releasesListReleases - List releases
repositoriesGetRepository - Get repository
repositoriesListRepositories - List repositories
sponsorsGetSponsor - Get sponsor
sponsorsListSponsors - List sponsors

Retries

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 { Nest } from "owasp-nest";

const nest = new Nest({
  apiKey: process.env["NEST_API_KEY"] ?? "",
});

async function run() {
  const result = await nest.chapters.listChapters({
    country: "India",
  }, {
    retries: {
      strategy: "backoff",
      backoff: {
        initialInterval: 1,
        maxInterval: 50,
        exponent: 1.1,
        maxElapsedTime: 100,
      },
      retryConnectionErrors: false,
    },
  });

  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 { Nest } from "owasp-nest";

const nest = new Nest({
  retryConfig: {
    strategy: "backoff",
    backoff: {
      initialInterval: 1,
      maxInterval: 50,
      exponent: 1.1,
      maxElapsedTime: 100,
    },
    retryConnectionErrors: false,
  },
  apiKey: process.env["NEST_API_KEY"] ?? "",
});

async function run() {
  const result = await nest.chapters.listChapters({
    country: "India",
  });

  console.log(result);
}

run();

Error Handling

NestError is the base class for all HTTP error responses. It has the following properties:

Property	Type	Description
`error.message`	`string`	Error message
`error.statusCode`	`number`	HTTP response status code eg `404`
`error.headers`	`Headers`	HTTP response headers
`error.body`	`string`	HTTP body. Can be empty string if no body is returned.
`error.rawResponse`	`Response`	Raw HTTP response
`error.data$`		Optional. Some errors may contain structured data. See Error Classes.

Example

import { Nest } from "owasp-nest";
import * as errors from "owasp-nest/models/errors";

const nest = new Nest({
  apiKey: process.env["NEST_API_KEY"] ?? "",
});

async function run() {
  try {
    const result = await nest.chapters.getChapter({
      chapterId: "London",
    });

    console.log(result);
  } catch (error) {
    // The base class for HTTP error responses
    if (error instanceof errors.NestError) {
      console.log(error.message);
      console.log(error.statusCode);
      console.log(error.body);
      console.log(error.headers);

      // Depending on the method different errors may be thrown
      if (error instanceof errors.ChapterError) {
        console.log(error.data$.message); // string
      }
    }
  }
}

run();

Error Classes

Primary error:

NestError: The base class for HTTP error responses.

Less common errors (16)

Network errors:

ConnectionError: HTTP client was unable to make a request to a server.
RequestTimeoutError: HTTP request timed out due to an AbortSignal signal.
RequestAbortedError: HTTP request was aborted by the client.
InvalidRequestError: Any input used to create a request is invalid.
UnexpectedClientError: Unrecognised or unexpected error.

Inherit from NestError:

ChapterError: Chapter error schema. Status code 404. Applicable to 1 of 20 methods.*
CommitteeError: Committee error schema. Status code 404. Applicable to 1 of 20 methods.*
MemberError: Member error schema. Status code 404. Applicable to 1 of 20 methods.*
OrganizationError: Organization error schema. Status code 404. Applicable to 1 of 20 methods.*
EventError: Event error schema. Status code 404. Applicable to 1 of 20 methods.*
IssueError: Issue error schema. Status code 404. Applicable to 1 of 20 methods.*
ProjectError: Project error schema. Status code 404. Applicable to 1 of 20 methods.*
ReleaseError: Release error schema. Status code 404. Applicable to 1 of 20 methods.*
RepositoryError: Repository error schema. Status code 404. Applicable to 1 of 20 methods.*
SponsorError: Sponsor error schema. Status code 404. Applicable to 1 of 20 methods.*
ResponseValidationError: Type mismatch between the data returned from the server and the structure expected by the SDK. See error.rawValue for the raw value and error.pretty() for a nicely formatted multi-line string.

* Check the method documentation to see if the error is applicable.

Server Selection

Override Server URL Per-Client

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 { Nest } from "owasp-nest";

const nest = new Nest({
  serverURL: "https://nest.owasp.dev",
  apiKey: process.env["NEST_API_KEY"] ?? "",
});

async function run() {
  const result = await nest.chapters.listChapters({
    country: "India",
  });

  console.log(result);
}

run();

Custom HTTP Client

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 fet 67F5 cher 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 { Nest } from "owasp-nest";
import { HTTPClient } from "owasp-nest/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 Nest({ httpClient: httpClient });

Debugging

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 { Nest } from "owasp-nest";

const sdk = new Nest({ debugLogger: console });

You can also enable a default debug logger by setting an environment variable NEST_DEBUG to true.

Development

Maturity

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.

Contributions

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.

Name		Name	Last commit message	Last commit date
Latest commit History 14 Commits
.github/workflows		.github/workflows
.speakeasy		.speakeasy
docs		docs
examples		examples
src		src
.gitattributes		.gitattributes
.gitignore		.gitignore
.npmignore		.npmignore
CONTRIBUTING.md		CONTRIBUTING.md
FUNCTIONS.md		FUNCTIONS.md
LICENSE		LICENSE
README.md		README.md
RELEASES.md		RELEASES.md
RUNTIMES.md		RUNTIMES.md
USAGE.md		USAGE.md
eslint.config.mjs		eslint.config.mjs
jsr.json		jsr.json
package-lock.json		package-lock.json
package.json		package.json
tsconfig.json		tsconfig.json

License

OWASP/nest-sdk-typescript

Folders and files

Latest commit

History

Repository files navigation

owasp-nest

Summary

Table of Contents

SDK Installation

NPM

PNPM

Bun

Yarn

Requirements

SDK Example Usage

Example

Authentication

Per-Client Security Schemes

Available Resources and Operations

Standalone functions

Retries

Error Handling

Example

Error Classes

Server Selection

Override Server URL Per-Client

Custom HTTP Client

Debugging

Development

Maturity

Contributions

SDK Created by Speakeasy

About

Resources

License

Contributing

Uh oh!

Stars

Watchers

Forks

Uh oh!

Languages