pangea-node-sdk

Pangea Node.js SDK

A Node.js SDK for integrating with Pangea services. Supports Node.js v18 and v20.

Installation

GA releases

Via npm:

$ npm install pangea-node-sdk

Via yarn:

$ yarn add pangea-node-sdk

Beta releases

Pre-release versions may be available with the beta denotation in the version number. These releases serve to preview beta services and APIs. Per Semantic Versioning, they are considered unstable and do not carry the same compatibility guarantees as stable releases. Beta changelog.

Via npm:

$ npm install pangea-node-sdk@3.8.0-beta.2

Via yarn:

$ yarn add pangea-node-sdk@3.8.0-beta.2

Usage

• Documentation
• GA Examples
• Beta Examples

General usage would be to create a token for a service through the Pangea Console and then construct an API client for that respective service. The below example shows how this can be done for Secure Audit Log to log a simple event:

import process from "node:process";
import { PangeaConfig, AuditService } from "pangea-node-sdk";

// Load client configuration from environment variables `PANGEA_AUDIT_TOKEN` and
// `PANGEA_DOMAIN`.
const token = process.env.PANGEA_AUDIT_TOKEN;
const config = new PangeaConfig({ domain: process.env.PANGEA_DOMAIN });

// Create a Secure Audit Log client.
const audit = new AuditService(token, config);

// Log a basic event.
const response = await audit.log({ message: "Hello, World!" });