Cape Privacy SDK for JavaScript

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

1. Installation
2. Usage
3. TypeScript
4. Contributing
5. License

Installation

Using npm:

npm install @capeprivacy/cape-sdk

Using yarn:

yarn add @capeprivacy/cape-sdk

(back to top)

Usage

Replace <AUTH_TOKEN> and <FUNCTION_ID> with your values.

run

Run is used to invoke a function once with a single input.

Example run.mjs:

import { Cape } from '@capeprivacy/cape-sdk';

const client = new Cape({ authToken: '<AUTH_TOKEN>' });
await client.run({ id: '<FUNCTION_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:

const client = new Cape({ authToken: '<AUTH_TOKEN>' });

try {
  await client.connect({ id: '<FUNCTION_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.

(back to top)

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.

const input = '<USER_INPUT>';
const functionToken = '<FUNCTION_TOKEN>';

const client = new Cape({ functionToken });

const encrypted = await client.encrypt(input);

// Invoke with encrypted input.
await client.run({ id: '<FUNCTION_ID>', data: encrypted });

(back to top)

TypeScript

The Cape SDK for JavaScript bundles TypeScript definitions to use in TypeScript projects.

(back to top)

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.

(back to top)

License

Apache 2.0

(back to top)