fossekall-interface 0.1.9 → 0.1.11

package/README.md

@@ -1,9 +1,7 @@
 # fossekall-interface
 
-`fossekall-interface` provides generated TypeScript interfaces/schemas for
-Fossekall data objects.
-
-Current package exports are telemetry schemas and types from `ecu/telemetry`.
+`fossekall-interface` provides generated TypeScript types and runtime schemas
+for Fossekall data objects.
 
 ## Install
 
@@ -13,79 +11,39 @@ npm install fossekall-interface
 
 ## Usage
 
-Import from the package root:
+Import generated modules from published `dist` paths:
 
 ```ts
-import {
-  STATE_NAME,
-  BLDCTelemetry,
-  type BLDCTelemetry as BLDCTelemetryType,
-  FsmTelemetry,
-  type FsmTelemetry as FsmTelemetryType,
-  SawWaveTelemetry,
-  type SawWaveTelemetry as SawWaveTelemetryType,
-} from "fossekall-interface";
+import * as telemetry from "fossekall-interface/dist/ecu/telemetry";
+import * as commands from "fossekall-interface/dist/ecu/commands";
+import type { TelemetrySpec, CommandSpec } from "fossekall-interface/dist/types";
 ```
 
-`index.ts` currently re-exports:
-
-- `./ecu/telemetry`
-
-### Current Generated API
-
-- `STATE_NAME`
-- `type STATE_NAME`
-- `BLDCTelemetry`
-- `type BLDCTelemetry`
-- `FsmTelemetry`
-- `type FsmTelemetry`
-- `SawWaveTelemetry`
-- `type SawWaveTelemetry`
+These modules expose generated schemas, enums, and spec types for integration
+and type-safe data handling.
 
-## What Gets Published
+## Package Output
 
-Only the compiled output in `dist/` is published to npm.
+Published artifacts are compiled files from `dist/`, including:
 
-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
+- JavaScript modules
+- Type declarations
 
 ## Development
 
-Run from this directory (`generated/`):
+From this directory:
 
 ```bash
 npm install
 npm run build
 ```
 
-The build uses `tsc` and outputs to `dist/`.
-
 ## Publishing
 
-1. Update version:
-
 ```bash
 npm version patch
-```
-
-2. Publish:
-
-```bash
 npm publish --access private
 ```
 
-If you publish using a token, configure `.npmrc` with:
-
-```ini
-//registry.npmjs.org/:_authToken=${NPM_TOKEN}
-```
-
-and export `NPM_TOKEN` in your shell before publishing.
+If publishing with a token, configure `.npmrc` and set `NPM_TOKEN` in your
+environment.

package/dist/ecu/constants.d.ts

@@ -0,0 +1 @@
+export declare const ip = "10.19.0.111";

package/dist/ecu/constants.js

@@ -0,0 +1 @@
+export const ip = "10.19.0.111";

package/dist/ecu/index.d.ts

@@ -1,2 +1,3 @@
 export * as commands from "./commands";
+export * as constants from "./constants";
 export * as telemetry from "./telemetry";

package/dist/ecu/index.js

@@ -1,2 +1,3 @@
 export * as commands from "./commands";
+export * as constants from "./constants";
 export * as telemetry from "./telemetry";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fossekall-interface",
-  "version": "0.1.9",
+  "version": "0.1.11",
   "description": "API contracts between client and server (rocket and GUI)",
   "license": "ISC",
   "author": "Propulse",

package/dist/index.d.ts

@@ -1 +0,0 @@
-export * as types from "./types";

package/dist/index.js

@@ -1 +0,0 @@
-export * as types from "./types";