@dg-kit/core 0.1.0

package/README.md

@@ -0,0 +1,15 @@
+# @dg-kit/core
+
+Shared types and contract interfaces for DG-Lab Coyote control libraries.
+
+This package is runtime-agnostic — it has no DOM or Node-only dependencies. It defines the data shapes (`DeviceState`, `DeviceCommand`, `WaveformDefinition`, etc.) and the abstract interfaces (`DeviceClient`, `WaveformLibrary`, `Logger`) that the rest of `@dg-kit/*` and downstream consumers (`DG-Agent`, `DG-MCP`, `DG-Chat`) depend on.
+
+## Install
+
+```bash
+npm install @dg-kit/core
+```
+
+## Stability
+
+`DeviceCommand`, `DeviceState`, `WaveformDefinition`, and the `DeviceClient` / `WaveformLibrary` interfaces are part of the public contract. Breaking changes to these shapes bump the major version. Internal helpers (e.g. `createEmptyDeviceState`) follow the same versioning policy.

package/dist/index.d.ts

@@ -0,0 +1,115 @@
+/**
+ * @dg-kit/core — shared types and contract interfaces.
+ *
+ * Runtime-agnostic. Consumed by every other @dg-kit package and by the three
+ * downstream apps (DG-Agent, DG-MCP, DG-Chat).
+ */
+export type Channel = 'A' | 'B';
+/** A single 25 ms wave step: `[encodedFrequency, intensity]`. */
+export type WaveFrame = [number, number];
+export interface WaveformDefinition {
+    id: string;
+    name: string;
+    description?: string;
+    /** Sequence of 25 ms steps. */
+    frames: WaveFrame[];
+}
+export interface DeviceState {
+    connected: boolean;
+    deviceName?: string;
+    address?: string;
+    battery?: number;
+    strengthA: number;
+    strengthB: number;
+    limitA: number;
+    limitB: number;
+    waveActiveA: boolean;
+    waveActiveB: boolean;
+    currentWaveA?: string;
+    currentWaveB?: string;
+}
+export declare function createEmptyDeviceState(): DeviceState;
+export type DeviceCommand = {
+    type: 'start';
+    channel: Channel;
+    strength: number;
+    waveform: WaveformDefinition;
+    loop: boolean;
+} | {
+    type: 'stop';
+    channel?: Channel;
+} | {
+    type: 'adjustStrength';
+    channel: Channel;
+    delta: number;
+} | {
+    type: 'changeWave';
+    channel: Channel;
+    waveform: WaveformDefinition;
+    loop: boolean;
+} | {
+    type: 'burst';
+    channel: Channel;
+    strength: number;
+    durationMs: number;
+} | {
+    type: 'emergencyStop';
+};
+export interface TimerCommand {
+    type: 'timer';
+    seconds: number;
+    label: string;
+}
+export interface DeviceCommandResult {
+    state: DeviceState;
+    notes?: string[];
+}
+export interface ToolCall {
+    id: string;
+    name: string;
+    displayName?: string;
+    args: Record<string, unknown>;
+}
+export interface ToolDefinition {
+    name: string;
+    displayName?: string;
+    description: string;
+    /** JSON Schema for the tool parameters. */
+    parameters: Record<string, unknown>;
+}
+export type ToolExecutionPlan = {
+    type: 'device';
+    command: DeviceCommand;
+} | {
+    type: 'timer';
+    command: TimerCommand;
+} | {
+    type: 'inline';
+    output: string;
+    summary?: string;
+};
+export declare function isDeviceToolName(name: string): boolean;
+export interface DeviceClient {
+    connect(): Promise<void>;
+    disconnect(): Promise<void>;
+    getState(): Promise<DeviceState>;
+    execute(command: DeviceCommand): Promise<DeviceCommandResult>;
+    emergencyStop(): Promise<void>;
+    onStateChanged(listener: (state: DeviceState) => void): () => void;
+}
+export interface WaveformLibrary {
+    getById(id: string): Promise<WaveformDefinition | null>;
+    list(): Promise<WaveformDefinition[]>;
+    /**
+     * Persist a new or updated waveform. Optional because not every library
+     * implementation supports writing (e.g. a read-only Node bundle); design
+     * tools should branch on its presence.
+     */
+    save?(waveform: WaveformDefinition): Promise<void>;
+}
+export interface Logger {
+    info(message: string, meta?: Record<string, unknown>): void;
+    warn(message: string, meta?: Record<string, unknown>): void;
+    error(message: string, meta?: Record<string, unknown>): void;
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAMH,MAAM,MAAM,OAAO,GAAG,GAAG,GAAG,GAAG,CAAC;AAEhC,iEAAiE;AACjE,MAAM,MAAM,SAAS,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAEzC,MAAM,WAAW,kBAAkB;IACjC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,+BAA+B;IAC/B,MAAM,EAAE,SAAS,EAAE,CAAC;CACrB;AAMD,MAAM,WAAW,WAAW;IAC1B,SAAS,EAAE,OAAO,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,OAAO,CAAC;IACrB,WAAW,EAAE,OAAO,CAAC;IACrB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,wBAAgB,sBAAsB,IAAI,WAAW,CAWpD;AAMD,MAAM,MAAM,aAAa,GACrB;IACE,IAAI,EAAE,OAAO,CAAC;IACd,OAAO,EAAE,OAAO,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,kBAAkB,CAAC;IAC7B,IAAI,EAAE,OAAO,CAAC;CACf,GACD;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,OAAO,CAAC,EAAE,OAAO,CAAA;CAAE,GACnC;IAAE,IAAI,EAAE,gBAAgB,CAAC;IAAC,OAAO,EAAE,OAAO,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,GAC3D;IAAE,IAAI,EAAE,YAAY,CAAC;IAAC,OAAO,EAAE,OAAO,CAAC;IAAC,QAAQ,EAAE,kBAAkB,CAAC;IAAC,IAAI,EAAE,OAAO,CAAA;CAAE,GACrF;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,OAAO,EAAE,OAAO,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAC;IAAC,UAAU,EAAE,MAAM,CAAA;CAAE,GACzE;IAAE,IAAI,EAAE,eAAe,CAAA;CAAE,CAAC;AAE9B,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,OAAO,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,mBAAmB;IAClC,KAAK,EAAE,WAAW,CAAC;IACnB,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;CAClB;AAMD,MAAM,WAAW,QAAQ;IACvB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAC/B;AAED,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,EAAE,MAAM,CAAC;IACpB,2CAA2C;IAC3C,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACrC;AAED,MAAM,MAAM,iBAAiB,GACzB;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,OAAO,EAAE,aAAa,CAAA;CAAE,GAC1C;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,OAAO,EAAE,YAAY,CAAA;CAAE,GACxC;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,MAAM,EAAE,MAAM,CAAC;IAAC,OAAO,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AAEzD,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAQtD;AAMD,MAAM,WAAW,YAAY;IAC3B,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IACzB,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAC5B,QAAQ,IAAI,OAAO,CAAC,WAAW,CAAC,CAAC;IACjC,OAAO,CAAC,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC;IAC9D,aAAa,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAC/B,cAAc,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,WAAW,KAAK,IAAI,GAAG,MAAM,IAAI,CAAC;CACpE;AAED,MAAM,WAAW,eAAe;IAC9B,OAAO,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,GAAG,IAAI,CAAC,CAAC;IACxD,IAAI,IAAI,OAAO,CAAC,kBAAkB,EAAE,CAAC,CAAC;IACtC;;;;OAIG;IACH,IAAI,CAAC,CAAC,QAAQ,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACpD;AAED,MAAM,WAAW,MAAM;IACrB,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IAC5D,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IAC5D,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;CAC9D"}

package/dist/index.js

@@ -0,0 +1,26 @@
+/**
+ * @dg-kit/core — shared types and contract interfaces.
+ *
+ * Runtime-agnostic. Consumed by every other @dg-kit package and by the three
+ * downstream apps (DG-Agent, DG-MCP, DG-Chat).
+ */
+export function createEmptyDeviceState() {
+    return {
+        connected: false,
+        battery: 0,
+        strengthA: 0,
+        strengthB: 0,
+        limitA: 200,
+        limitB: 200,
+        waveActiveA: false,
+        waveActiveB: false,
+    };
+}
+export function isDeviceToolName(name) {
+    return (name === 'start' ||
+        name === 'stop' ||
+        name === 'adjust_strength' ||
+        name === 'change_wave' ||
+        name === 'burst');
+}
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAsCH,MAAM,UAAU,sBAAsB;IACpC,OAAO;QACL,SAAS,EAAE,KAAK;QAChB,OAAO,EAAE,CAAC;QACV,SAAS,EAAE,CAAC;QACZ,SAAS,EAAE,CAAC;QACZ,MAAM,EAAE,GAAG;QACX,MAAM,EAAE,GAAG;QACX,WAAW,EAAE,KAAK;QAClB,WAAW,EAAE,KAAK;KACnB,CAAC;AACJ,CAAC;AAuDD,MAAM,UAAU,gBAAgB,CAAC,IAAY;IAC3C,OAAO,CACL,IAAI,KAAK,OAAO;QAChB,IAAI,KAAK,MAAM;QACf,IAAI,KAAK,iBAAiB;QAC1B,IAAI,KAAK,aAAa;QACtB,IAAI,KAAK,OAAO,CACjB,CAAC;AACJ,CAAC"}

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "@dg-kit/core",
+  "version": "0.1.0",
+  "description": "Shared types and contract interfaces for DG-Lab Coyote control libraries",
+  "license": "MIT",
+  "author": "0xNullAI",
+  "homepage": "https://github.com/0xNullAI/DG-Kit/tree/main/packages/core",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/0xNullAI/DG-Kit.git",
+    "directory": "packages/core"
+  },
+  "type": "module",
+  "main": "./src/index.ts",
+  "types": "./src/index.ts",
+  "exports": {
+    ".": {
+      "types": "./src/index.ts",
+      "import": "./src/index.ts"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "publishConfig": {
+    "access": "public",
+    "main": "./dist/index.js",
+    "types": "./dist/index.d.ts",
+    "exports": {
+      ".": {
+        "types": "./dist/index.d.ts",
+        "import": "./dist/index.js"
+      }
+    }
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "typecheck": "tsc -p tsconfig.json --noEmit"
+  },
+  "keywords": [
+    "dg-lab",
+    "coyote",
+    "ble",
+    "bluetooth"
+  ]
+}