@yam8d/m8-sdk 0.5.1 → 0.5.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yam8d/m8-sdk",
-  "version": "0.5.1",
+  "version": "0.5.3",
   "description": "Client SDK for apps that read and drive a Dirtywave M8, inside a yam8d External Apps iframe or standalone over Web Serial, WebUSB or Web MIDI.",
   "type": "module",
   "main": "./dist/index.js",

package/types/engine/astar.d.ts

@@ -1,15 +1,16 @@
 export type Direction = 'up' | 'down' | 'left' | 'right';
 export type Edge = {
     to: string;
-    dir: Direction;
+    dir?: Direction;
     weight?: number;
 };
-export type Graph = Map<string, Edge[]>;
+export type Graph<E extends Edge = Edge> = Map<string, E[]>;
 export type Heuristic = (a: string, b: string) => number;
-export type EdgeCostFn = (from: string, to: string, dir: Direction) => number;
-export interface PathResult {
+export type EdgeCostFn = (from: string, to: string, dir?: Direction) => number;
+export interface PathResult<E extends Edge = Edge> {
     pages: string[];
-    directions: Direction[];
+    directions: (Direction | undefined)[];
+    edges: E[];
     cost: number;
 }
-export declare function aStar(graph: Graph, start: string, goal: string, heuristic?: Heuristic, edgeCost?: EdgeCostFn): PathResult | null;
+export declare function aStar<E extends Edge = Edge>(graph: Graph<E>, start: string, goal: string, heuristic?: Heuristic, edgeCost?: EdgeCostFn): PathResult<E> | null;

package/types/engine/engine.d.ts

@@ -19,7 +19,8 @@ export interface M8Engine {
     readonly macro: MacroRunner;
     /** Moves the cursor towards a point in M8 pixel coordinates. */
     navigateTo(point: Point): Promise<void>;
-    navigateToView(viewName: string): Promise<void>;
+    /** Resolves true when the view is reached. */
+    navigateToView(viewName: string): Promise<boolean>;
     getState(): M8State;
     getScreenLines(): string[];
     getScreenCellColors(): ScreenCellColors;

package/types/engine/host/hostMethods.d.ts

@@ -7,7 +7,7 @@ export type HostMethodsDeps = {
     editors: ReturnType<typeof createValueEditors>;
     setValueFloat: (targetFloat: number) => Promise<boolean>;
     browseFile: (targetText: string, exact: boolean) => Promise<boolean>;
-    navigateToView: (viewName: string) => Promise<void>;
+    navigateToView: (viewName: string) => Promise<boolean>;
     navigateTo: (point: {
         x: number;
         y: number;

package/types/engine/viewGraph.d.ts

@@ -1,6 +1,22 @@
-import type { Graph } from './astar';
+import type { Edge, Graph } from './astar';
+export type NavEdgeKind = 'shift' | 'button' | 'exit';
+export interface NavEdge extends Edge {
+    from: string;
+    kind: NavEdgeKind;
+    /** Key frames to play (after the cursor move, for buttons). Empty: Shift+dir. */
+    keys: number[];
+    /** Button cell, in text grid coordinates. */
+    cursor?: {
+        x: number;
+        y: number;
+    };
+    /** Button text, used to find the button where the layout differs from `cursor`. */
+    label?: string;
+    /** Where this key goes when the M8 came from `to` (it goes back). */
+    back?: boolean;
+}
 export interface M8ViewGraph {
-    graph: Graph;
+    graph: Graph<NavEdge>;
     /** Explicit key frame sequences per edge: from -> to -> frames. */
     edgeKeys: Map<string, Map<string, number[]>>;
 }

package/types/engine/viewNavigation.d.ts

@@ -6,11 +6,16 @@ export declare const toKeyMasks: (directions: Direction[], opts?: {
     shift?: boolean;
 }) => number[];
 export interface ViewNavigation {
-    /** Resolves when the view is reached, no path is found, or the step limit is hit. */
-    navigateToView(viewName: string): Promise<void>;
+    /** Resolves true when the view is reached; false when no path is left, the step limit is hit or another navigation starts. */
+    navigateToView(viewName: string): Promise<boolean>;
     dispose(): void;
 }
-export declare const createViewNavigation: ({ store, runner }: {
+export interface ViewNavigationDeps {
     store: M8Store;
     runner: MacroRunner;
-}) => ViewNavigation;
+    /** The 24 text rows of the screen, to find buttons by their label. */
+    getScreenLines?: () => string[];
+    /** Moves the cursor to a text grid cell. Without it, button edges are not used. */
+    moveCursor?: (x: number, y: number) => Promise<void>;
+}
+export declare const createViewNavigation: ({ store, runner, getScreenLines, moveCursor }: ViewNavigationDeps) => ViewNavigation;

package/types/fxInsight.d.ts

@@ -71,8 +71,10 @@ export declare function formatFxValue(cmd: string, value: number): string;
 export interface FxValueContext {
     /** Note on the same step (used by ARP to spell out the notes). */
     note?: string | null;
-    /** Table view: HOP and CHA mean something different there. */
+    /** Table view: HOP, CHA, DEL, TIC, REP, RTO and MTT mean something different there. */
     inTable?: boolean;
+    /** Row (phrase step or table row) the command is on: a HOP onto its own row, MTT on the first step. */
+    row?: number | null;
 }
 /**
  * Short explanation of what `value` does for `cmd` (phrase view), or null when

package/types/parameterViews.d.ts

@@ -34,6 +34,14 @@ interface ZoneDef {
     width: number;
 }
 type VocabEntry = Pick<ColumnDef, 'type' | 'format' | 'label' | 'description' | 'parts' | 'options' | 'unit'>;
+/** Rows with one value per operator (FM): the columns of the values. */
+interface OperatorsDef {
+    instrument: string;
+    x: number;
+    step: number;
+    width: number;
+    letters: string[];
+}
 interface LayoutDef {
     extends?: string;
     /** Pattern of the heading label that names the block a cell belongs to ('MOD\\d'): read upward in the cell's zone. */
@@ -45,6 +53,7 @@ interface LayoutDef {
     sections?: string[];
     rows?: RowDef[];
     zones?: ZoneDef[];
+    operators?: OperatorsDef;
     vocabulary?: Record<string, VocabEntry>;
     vocabularyFrom?: 'instrumentTypes';
 }