Skip to content

README.md

Latest commit

 

History

History
53 lines (35 loc) · 1.12 KB

README.md

File metadata and controls

53 lines (35 loc) · 1.12 KB

Sigma Node.js Embed SDK

This package provides Node.js utilities for working with Sigma Computing's Embed API.

Getting Started

To use the node-embed-sdk in your project, you can install it using your node package manager.

Using npm:

npm install @sigmacomputing/node-embed-sdk

yarn:

yarn add @sigmacomputing/node-embed-sdk

pnpm:

pnpm add @sigmacomputing/node-embed-sdk

Features

Token Encryption and Decryption

The SDK provides utilities for encrypting and decrypting OAuth tokens using AES-256-GCM encryption.

See our documentation on embedding with JWTS for more information.

Sigma expects you to encrypt OAuth tokens using the same embed secret used to sign the embed.

Example Usage

import { encrypt, decrypt } from '@sigmacomputing/node-embed-sdk';

// Encrypt an OAuth token
const encryptedToken = encrypt(
  'your-embed-secret',
  'your-oauth-token'
);

// Decrypt an encrypted token
const decryptedToken = decrypt(
  'your-embed-secret',
  encryptedToken
);