CE-RISE TypeScript Software Development Kit for Hexagonal Core Service

A TypeScript SDK for the CE-RISE Hex Core Service: https://codeberg.org/CE-RISE-software/hex-core-service

Install

Install from npm:

npm install "@ce-rise/hex-core-sdk-typescript"

Install a specific version:

npm install "@ce-rise/[email protected]"

Quickstart

1) Configure client and call public endpoints

import { Configuration, DiscoveryApi } from "@ce-rise/hex-core-sdk-typescript";

const config = new Configuration({
  basePath: "https://your-hex-core-service.example.org"
});

const discoveryApi = new DiscoveryApi(config);
const models = await discoveryApi.listModels();
console.log(models);

2) Configure bearer token for protected endpoints

import { AdminApi, Configuration } from "@ce-rise/hex-core-sdk-typescript";

const config = new Configuration({
  basePath: "https://your-hex-core-service.example.org",
  accessToken: process.env.HEX_CORE_TOKEN
});

const adminApi = new AdminApi(config);
const status = await adminApi.status();
console.log(status);

3) Validate and create records

import { Configuration, ModelsApi } from "@ce-rise/hex-core-sdk-typescript";

const config = new Configuration({
  basePath: "https://your-hex-core-service.example.org",
  accessToken: process.env.HEX_CORE_TOKEN
});

const modelsApi = new ModelsApi(config);

const report = await modelsApi.validateModelPayload({
  model: "model-a",
  version: "1.0.0",
  validateRequest: { payload: { x: 1 } }
});

const created = await modelsApi.createRecord({
  model: "model-a",
  version: "1.0.0",
  idempotencyKey: "my-key-123",
  createRequest: { payload: { x: 1 } }
});

console.log(report, created);

API Documentation

• Generated docs website: https://ce-rise-software.codeberg.page/hex-core-sdk-typescript/
• Local API docs:
  • docs/apis/AdminApi.md
  • docs/apis/DiscoveryApi.md
  • docs/apis/ModelsApi.md

License

Licensed under the European Union Public Licence v1.2 (EUPL-1.2).

Contributing

This repository is maintained on Codeberg as the canonical source of truth. The GitHub repository is a read-only mirror used for release archival and Zenodo integration.

Funded by the European Union under Grant Agreement No. 101092281 - CE-RISE.
Views and opinions expressed are those of the author(s) only and do not necessarily reflect those of the European Union or the granting authority (HADEA). Neither the European Union nor the granting authority can be held responsible for them.

(c) 2026 CE-RISE consortium.
Licensed under the European Union Public Licence v1.2 (EUPL-1.2).
Attribution: CE-RISE project (Grant Agreement No. 101092281) and the individual authors/partners as indicated.

Developed by NILU (Riccardo Boero - [email protected]) within the CE-RISE project.