This repository is no longer maintained and is considered deprecated in favour of @palantir/compute-module. Please do not use it for new projects. To use Palantir's version as a drop in replacement npm install @palantir/compute-module@0.1

[DEPRECATED] @chrisjeg/compute-module

Node.JS compatible implementation of the Compute Module interface. Definitions are generated using typebox allowing the Compute Module to register functions at runtime, while maintaining typesafety at compile time.

This library is dependent on "Runtime V1", if not provided this will not work.

Functions Mode

Basic usage

This library can be used untyped with vanilla JavaScript to generate registerable functions in "Functions" execution mode.

import { ComputeModule } from "@chrisjeg/compute-module";

new ComputeModule()
  .on("addOne", async (n) => n + 1)
  .on("stringify", async (n) => "" + n)
  .default(() => ({ error: "Unsupported query name" }));

Schema registration

Definitions can be generated using typebox allowing the Compute Module to register functions at runtime, while maintaining typesafety at compile time.

import { ComputeModule } from "@chrisjeg/compute-module";
import { Type } from "@sinclair/typebox";

const myModule = new ComputeModule({
  logger: console,
  definitions: {
    addOne: {
      input: Type.Object({
        value: Type.Number(),
      }),
      output: Type.Object({ value: Type.Number() }),
    },
  },
});

myModule.on("addOne", async (n) => n + 1);

Pipelines Mode

Retrieving source credentials

Sources can be used to store secrets for use within a Compute Module, they prevent you from having to put secrets in your container or in plaintext in the job specification. Retrieving a source credential using this library is simple:

const myModule = new ComputeModule();
const myCredential = await myModule.getCredential(
  "mySourceApiName",
  "MyCredential"
);

As a file is mounted at runtime, getCredential returns a promise that will resolve once the file is mounted to avoid race conditions.

Retrieving aliases

Compute Modules can interact with resources in their execution environment, within Palantir Foundry these are defined as inputs and outputs on the Compute Module spec. Resource identifiers can be unique to the execution environment, so using aliases allows your code to maintain a static reference to known resources. To receive the identifier for an aliases resource, use the getResource method.

const resourceId = await myModule.getResource("myResourceAlias");
const result = await someDataFetcherForId(resourceId);

Developing the SDK

Building the example module

Run docker build from the top-level directory (not example-module):

docker build -f example-module/Dockerfile -t my-container-registry.palantirfoundry.com/example-module:0.0.1 .