https://github.com/capeprivacy/cape-js
The Cape Privacy JavaScript SDK
https://github.com/capeprivacy/cape-js
confidential-computing enclaves monorepo nitro-enclaves sdk typescript
Last synced: about 2 months ago
JSON representation
The Cape Privacy JavaScript SDK
- Host: GitHub
- URL: https://github.com/capeprivacy/cape-js
- Owner: capeprivacy
- License: apache-2.0
- Created: 2022-06-07T14:09:00.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2025-02-20T08:00:48.000Z (3 months ago)
- Last Synced: 2025-03-29T17:37:27.017Z (2 months ago)
- Topics: confidential-computing, enclaves, monorepo, nitro-enclaves, sdk, typescript
- Language: TypeScript
- Homepage: https://docs.capeprivacy.com
- Size: 1.43 MB
- Stars: 24
- Watchers: 6
- Forks: 1
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Cape Privacy SDK for JavaScript
[](https://codecov.io/gh/capeprivacy/cape-js) 
The Cape SDK for JavaScript is a library that provides a simple way to interact with the Cape Privacy API. Works in Node.js and the browser. Requires Node.js version 16+.
Table of Contents
## Installation
Using npm:
```bash
npm install @capeprivacy/cape-sdk
```
Using yarn:
```bash
yarn add @capeprivacy/cape-sdk
```
## Usage
Replace `` and `` with your values.
### `run`
Run is used to invoke a function once with a single input.
Example [run.mjs](https://github.com/capeprivacy/cape-js/tree/main/packages/cape/examples/run.mjs):
```js
import { Cape } from '@capeprivacy/cape-sdk';
const client = new Cape({ authToken: '' });
await client.run({ id: '', data: 'my-data' });
```
### `invoke`
Invoke is used to run a function repeatedly with a multiple inputs. It gives you more control over the lifecycle of
the function invocation.
Example [invoke.mjs](https://github.com/capeprivacy/cape-js/tree/main/packages/cape/examples/invoke.mjs):
```ts
const client = new Cape({ authToken: '' });
try {
await client.connect({ id: '' });
const results = await Promise.all([
client.invoke({ data: 'my-data-1' }),
client.invoke({ data: 'my-data-2' }),
client.invoke({ data: 'my-data-3' }),
]);
console.log('Cape run result:', results);
} catch (err) {
console.error('Something went wrong.', err);
} finally {
client.disconnect();
}
```
Please note that there is a 60-second inactivity timeout on the enclave connection. You may need to monitor the connection status and reconnect if there is a significant wait between inputs.
### `encrypt`
Encrypt is used to encrypt an input in string format. The encrypted content can't be accessed anywhere except in the enclave. This command will retrieve a public key with which it will encrypt the data with.
```ts
const input = '';
const functionToken = '';
const client = new Cape({ functionToken });
const encrypted = await client.encrypt(input);
// Invoke with encrypted input.
await client.run({ id: '', data: encrypted });
```
## TypeScript
The Cape SDK for JavaScript bundles TypeScript definitions to use in TypeScript projects.
## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.
Read more about how to contribute to the Cape SDK in [CONTRIBUTING](./CONTRIBUTING.md).
## License
[Apache 2.0](https://github.com/capeprivacy/cape-js/blob/main/LICENSE)