fossekall-interface

fossekall-interface provides generated TypeScript interfaces/schemas for Fossekall data objects.

Current package exports are telemetry schemas and types from ecu/telemetry.

Install

npm install fossekall-interface

Usage

Import from the package root:

import {
  STATE_NAME,
  BLDCTelemetry,
  type BLDCTelemetry as BLDCTelemetryType,
  FsmTelemetry,
  type FsmTelemetry as FsmTelemetryType,
  SawWaveTelemetry,
  type SawWaveTelemetry as SawWaveTelemetryType,
} from "fossekall-interface";

index.ts currently re-exports:

• ./ecu/telemetry

Current Generated API

• STATE_NAME
• type STATE_NAME
• BLDCTelemetry
• type BLDCTelemetry
• FsmTelemetry
• type FsmTelemetry
• SawWaveTelemetry
• type SawWaveTelemetry

What Gets Published

Only the compiled output in dist/ is published to npm.

This package ships:

• JavaScript (dist/**/*.js)
• Type declarations (dist/**/*.d.ts)

Source Layout

• index.ts: package root exports
• ecu/telemetry.ts: generated telemetry schemas/types
• dist/: compiled output used by npm consumers

Development

Run from this directory (generated/):

npm install
npm run build

The build uses tsc and outputs to dist/.

Publishing

1. Update version:

npm version patch

2. Publish:

npm publish --access private

If you publish using a token, configure .npmrc with:

//registry.npmjs.org/:_authToken=${NPM_TOKEN}

and export NPM_TOKEN in your shell before publishing.