Streamdal's Snitch Node Client SDK

Getting started

Optionally copy example.env -> .env and specify any custom env vars.

To use the sdk in your node app:

npm install @streamdal/snitch-node-client

Then construct an instance of "@streamdal/snitch-node-client/snitch.js" and use that to process your data:

const config: SnitchConfigs = {
  snitchUrl: "localhost:9091",
  snitchToken: "1234",
  serviceName: "test-service-name",
  pipelineTimeout: "100",
  stepTimeout: "10",
  dryRun: "false",
};

const audience: Audience = {
  serviceName: "test-service-name",
  componentName: "kafka",
  operationType: OperationType.CONSUMER,
  operationName: "test-kafka-consumer",
};

export const example = async () => {
  const snitch = new Snitch(config);
  const result = await snitch.processPipeline({
    audience,
    data: new TextEncoder().encode(JSON.stringify(exampleData)),
  });

  console.log("snitch response");
  console.dir(result, {depth: 20});
};

see ./examples for a runnable examples that can be used as a starters

WASM

In order to run pipelines with a minimal amount of overhead, the Snitch node client ships and executes pipeline rules as WASM. If you are using Node version < 20.* you'll need to enable WASM functionality in your node app by supplying the flag, see:

node --experimental-wasi-unstable-preview1 ./build/sandbox/index.js

More info: Node WASM Modules

Development

To do development on the snitch-node-client, you can run it locally:

npm install npm run sandbox

See ./src/sandbox/index.ts for an entry point for local dev.

Optionally install and run the snitch-server

Releasing

1. npm version [<newversion> | major | minor | patch]
2. git push the generated version tag: git push origin <tag_name>
3. Generate a release from the tag with user-friendly release notes: https://github.com/streamdal/snitch-node-client/releases