HKEY Docs
← Back to SDKs & downloads

SDK Documentation

TypeScript / Node.js SDK

Reference implementation of the Hotkey Encryption System (HKEY v1) for Node.js and TypeScript. Build authenticated, portable packets from hotkey chord sequences with a familiar, typed API.

Requirements

Package contents

Build

cd sdk/typescript
npm install
npm run build

Quick start

import { HotkeyEncryption } from '@hkey/sdk';

const hkey = new HotkeyEncryption('lab.freezer.alpha', [
  'Ctrl+Alt+H', 'Shift+K', 'Meta+E', 'Y',
]);

const packetJson = hkey.encryptText('sensitive payload');
const plain = hkey.decryptText(packetJson);

console.log(hkey.digest); // sequence digest
console.log(plain);       // "sensitive payload"

API overview

Interop notes

Good practices

Reference implementation for education and prototyping. For regulated or high-risk use, perform independent review and consider audited standard AEAD cores in production deployments.