@helioslx/core 0.2.0

package/dist/contracts-C4kpAdZq.d.ts

@@ -0,0 +1,265 @@
+//#region src/contracts.d.ts
+declare const SLOT_COUNT = 512;
+declare const MIN_UNIVERSE = 1;
+declare const MAX_UNIVERSE = 63999;
+declare const MIN_PRIORITY = 0;
+declare const MAX_PRIORITY = 200;
+declare const DEFAULT_PRIORITY = 100;
+declare const DEFAULT_ACTIVE_FPS = 44;
+declare const DEFAULT_IDLE_FPS = 2;
+interface OutputAddress {
+  readonly universe: number;
+  readonly priority?: number;
+}
+interface OutputOptions extends OutputAddress {
+  readonly cid?: string;
+  readonly idleFps?: number;
+  readonly sourceName?: string;
+}
+/** One-based DMX channel → value map used by setChannels / fadeChannels. */
+type ChannelValues = Readonly<Record<number, number>>;
+interface ChannelWrite {
+  /** One-based DMX slot number. */
+  readonly channel: number;
+  readonly value: number;
+  /** Linear transition duration in milliseconds. Defaults to 0 (snap). */
+  readonly durationMs?: number;
+}
+interface TransitionWrite {
+  readonly channel: number;
+  readonly value: number;
+  readonly durationMs: number;
+}
+interface FadeChannelsOptions {
+  readonly durationMs: number;
+  readonly signal?: AbortSignal;
+}
+interface WriteFrameOptions {
+  readonly durationMs?: number;
+  readonly signal?: AbortSignal;
+}
+interface ClearUniverseOptions {
+  readonly signal?: AbortSignal;
+}
+interface UniverseOptions {
+  readonly priority?: number;
+  readonly cid?: string;
+  readonly idleFps?: number;
+  readonly sourceName?: string;
+}
+type FrameMode = "active" | "idle";
+interface OutputSnapshot {
+  readonly activeTransitions: number;
+  readonly cid: string;
+  readonly current: readonly number[];
+  readonly dirty: boolean;
+  readonly frameMode: FrameMode;
+  readonly idleFps: number;
+  readonly lastError: string | null;
+  readonly lastSent: readonly number[];
+  readonly lastSentAt: number | null;
+  readonly nextDueAt: number;
+  readonly priority: number;
+  readonly sequence: number;
+  readonly sourceName: string | null;
+  readonly target: readonly number[];
+  readonly universe: number;
+  readonly updatedAt: number;
+}
+interface OutputRecord {
+  readonly cid: string;
+  readonly idleFps: number;
+  readonly priority: number;
+  readonly sourceName: string | null;
+  readonly target: readonly number[];
+  readonly universe: number;
+  readonly updatedAt: number;
+}
+interface OutputStore {
+  get(address: Required<OutputAddress>): Promise<OutputRecord | null>;
+  list(): Promise<readonly OutputRecord[]>;
+  remove(address: Required<OutputAddress>): Promise<void>;
+  save(record: OutputRecord): Promise<void>;
+  close?(): Promise<void>;
+}
+interface OutputPacket {
+  readonly cid: string;
+  readonly data: Uint8Array;
+  readonly priority: number;
+  readonly sequence: number;
+  readonly sourceName: string | null;
+  readonly universe: number;
+}
+interface OutputTransport {
+  send(packet: OutputPacket, signal: AbortSignal): Promise<void>;
+  closeOutput?(address: Required<OutputAddress>): Promise<void>;
+  close(): Promise<void>;
+}
+interface Clock {
+  /** Monotonic milliseconds used for scheduling. */
+  now(): number;
+  /** Wall-clock Unix milliseconds used for public and persisted metadata. */
+  wallNow?(): number;
+  sleep(delayMs: number, signal: AbortSignal): Promise<void>;
+}
+interface Logger {
+  debug?(message: string, context?: Readonly<Record<string, unknown>>): void;
+  info?(message: string, context?: Readonly<Record<string, unknown>>): void;
+  warn?(message: string, context?: Readonly<Record<string, unknown>>): void;
+  error?(message: string, context?: Readonly<Record<string, unknown>>): void;
+}
+interface TransportTelemetry {
+  readonly sendAttempts: number;
+  readonly sendFailures: number;
+  readonly sendRetries: number;
+  readonly sendSuccesses: number;
+  readonly sendTimeouts: number;
+}
+interface EngineTelemetry {
+  readonly closed: boolean;
+  readonly lastLoopCompletedAt: number | null;
+  readonly lastLoopDurationMs: number | null;
+  readonly lastLoopStartedAt: number | null;
+  readonly loopIterations: number;
+  readonly outputCount: number;
+  readonly outputs: readonly OutputSnapshot[];
+  readonly running: boolean;
+  readonly transport: TransportTelemetry;
+}
+type SacnLifecycleHook = () => void | Promise<void>;
+interface SacnSourceOptions {
+  readonly transport: OutputTransport;
+  readonly store?: OutputStore;
+  readonly clock?: Clock;
+  readonly logger?: Logger;
+  readonly activeFps?: number;
+  readonly idleFps?: number;
+  readonly sendTimeoutMs?: number;
+  /** Maximum time spent awaiting transport shutdown. Defaults to 2 seconds. */
+  readonly shutdownTimeoutMs?: number;
+  /** Maximum number of active universe/priority outputs. Defaults to 1024. */
+  readonly maxOutputs?: number;
+  /** Close the injected transport with the source. Defaults to false. */
+  readonly ownsTransport?: boolean;
+  /** Defaults to true for the default memory store, false for an injected store. */
+  readonly ownsStore?: boolean;
+  readonly createId?: () => string;
+  readonly onStart?: SacnLifecycleHook;
+  readonly onStop?: SacnLifecycleHook;
+  readonly onClose?: SacnLifecycleHook;
+}
+type SacnSourceEvent = {
+  readonly type: "started";
+} | {
+  readonly type: "stopped";
+} | {
+  readonly type: "output-updated";
+  readonly output: OutputSnapshot;
+} | {
+  readonly type: "output-cleared";
+  readonly address: Required<OutputAddress>;
+} | {
+  readonly type: "closed";
+};
+interface UniverseContract {
+  readonly universe: number;
+  readonly priority: number;
+  setChannels(values: ChannelValues, options?: {
+    readonly signal?: AbortSignal;
+  }): Promise<OutputSnapshot>;
+  fadeChannels(values: ChannelValues, options: FadeChannelsOptions): Promise<OutputSnapshot>;
+  transition(writes: readonly TransitionWrite[], options?: {
+    readonly signal?: AbortSignal;
+  }): Promise<OutputSnapshot>;
+  write(values: readonly number[] | Uint8Array, options?: WriteFrameOptions): Promise<OutputSnapshot>;
+  get(): Promise<OutputSnapshot | null>;
+  clear(options?: ClearUniverseOptions): Promise<boolean>;
+}
+interface SacnSourceContract {
+  universe(universe: number, options?: UniverseOptions): UniverseContract;
+  start(): Promise<void>;
+  stop(): Promise<void>;
+  listUniverses(): Promise<readonly OutputSnapshot[]>;
+  getTelemetry(): EngineTelemetry;
+  subscribe(listener: (event: SacnSourceEvent) => void): () => void;
+  close(): Promise<void>;
+}
+interface ReceiverPacket {
+  readonly cid: string;
+  readonly priority: number;
+  readonly sequence: number;
+  readonly sourceAddress: string | null;
+  readonly sourceName: string | null;
+  readonly universe: number;
+  readonly values: Uint8Array;
+}
+type ReceiverPacketListener = (packet: ReceiverPacket) => void;
+/** Runtime-neutral source of normalized sACN packets. */
+interface Receiver {
+  addUniverse(universe: number): Promise<void> | void;
+  removeUniverse(universe: number): Promise<void> | void;
+  subscribe(listener: ReceiverPacketListener): () => void;
+  close(): Promise<void>;
+}
+interface ViewerSourceMetadata {
+  readonly cid: string;
+  readonly priority: number;
+  readonly sequence: number;
+  readonly sourceAddress: string | null;
+  readonly sourceName: string | null;
+}
+interface ViewerPacket {
+  readonly receivedAt: number;
+  readonly source: ViewerSourceMetadata;
+  readonly universe: number;
+  /** Exactly 512 normalized values. */
+  readonly values: readonly number[];
+}
+interface ViewerRecord {
+  readonly selectedUniverses: readonly number[];
+  readonly updatedAt: number;
+}
+interface ViewerStore {
+  load(): Promise<ViewerRecord | null>;
+  save(record: ViewerRecord): Promise<void>;
+  close?(): Promise<void>;
+}
+interface ViewerTelemetry {
+  readonly droppedUpdates: number;
+  readonly packetsReceived: number;
+  readonly selectedUniverses: readonly number[];
+  readonly streamCount: number;
+}
+interface ViewerPacketStream extends AsyncIterable<ViewerPacket> {
+  close(): void;
+}
+interface ViewerServiceContract {
+  start(): Promise<void>;
+  getSelectedUniverses(): readonly number[];
+  setSelectedUniverses(universes: readonly number[]): Promise<readonly number[]>;
+  addUniverse(universe: number): Promise<readonly number[]>;
+  removeUniverse(universe: number): Promise<readonly number[]>;
+  subscribe(listener: (packet: ViewerPacket) => void): () => void;
+  packets(capacity?: number): ViewerPacketStream;
+  getTelemetry(): ViewerTelemetry;
+  close(): Promise<void>;
+}
+interface ViewerServiceOptions {
+  readonly receiver: Receiver;
+  readonly store?: ViewerStore;
+  readonly clock?: Pick<Clock, "now">;
+  readonly logger?: Logger;
+  /** Close the injected receiver with this service. Defaults to false. */
+  readonly ownsReceiver?: boolean;
+  /** Defaults to true for the default memory store, false for an injected store. */
+  readonly ownsStore?: boolean;
+  /** Default queue capacity for streams. Defaults to 32. */
+  readonly streamCapacity?: number;
+  /** Maximum number of selected universes. Defaults to 256. */
+  readonly maxUniverses?: number;
+  /** Maximum combined callback and stream subscribers. Defaults to 256. */
+  readonly maxListeners?: number;
+}
+//#endregion
+export { SacnSourceOptions as A, ViewerSourceMetadata as B, Receiver as C, SacnLifecycleHook as D, SLOT_COUNT as E, ViewerPacket as F, ViewerTelemetry as H, ViewerPacketStream as I, ViewerRecord as L, TransportTelemetry as M, UniverseContract as N, SacnSourceContract as O, UniverseOptions as P, ViewerServiceContract as R, OutputTransport as S, ReceiverPacketListener as T, WriteFrameOptions as U, ViewerStore as V, OutputOptions as _, DEFAULT_ACTIVE_FPS as a, OutputSnapshot as b, EngineTelemetry as c, Logger as d, MAX_PRIORITY as f, OutputAddress as g, MIN_UNIVERSE as h, Clock as i, TransitionWrite as j, SacnSourceEvent as k, FadeChannelsOptions as l, MIN_PRIORITY as m, ChannelWrite as n, DEFAULT_IDLE_FPS as o, MAX_UNIVERSE as p, ClearUniverseOptions as r, DEFAULT_PRIORITY as s, ChannelValues as t, FrameMode as u, OutputPacket as v, ReceiverPacket as w, OutputStore as x, OutputRecord as y, ViewerServiceOptions as z };
+//# sourceMappingURL=contracts-C4kpAdZq.d.ts.map

package/dist/contracts-C4kpAdZq.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"contracts-C4kpAdZq.d.ts","names":[],"sources":["../src/contracts.ts"],"mappings":";cAAa;cACA;cACA;cACA;cACA;cACA;cACA;cACA;UAEI;WACP;WACA;;UAGO,sBAAsB;WAC7B;WACA;WACA;;;KAIE,gBAAgB,SAAS;UAEpB;;WAEP;WACA;;WAEA;;UAGO;WACP;WACA;WACA;;UAGO;WACP;WACA,SAAS;;UAGF;WACP;WACA,SAAS;;UAGF;WACP,SAAS;;UAGF;WACP;WACA;WACA;WACA;;KAGE;UAEK;WACP;WACA;WACA;WACA;WACA,WAAW;WACX;WACA;WACA;WACA;WACA;WACA;WACA;WACA;WACA;WACA;WACA;;UAGO;WACP;WACA;WACA;WACA;WACA;WACA;WACA;;UAGO;EAChB,IAAI,SAAS,SAAS,iBAAiB,QAAQ;EAC/C,QAAQ,iBAAiB;EACzB,OAAO,SAAS,SAAS,iBAAiB;EAC1C,KAAK,QAAQ,eAAe;EAC5B,UAAU;;UAGM;WACP;WACA,MAAM;WACN;WACA;WACA;WACA;;UAGO;EAChB,KAAK,QAAQ,cAAc,QAAQ,cAAc;EACjD,aAAa,SAAS,SAAS,iBAAiB;EAChD,SAAS;;UAGO;;EAEhB;;EAEA;EACA,MAAM,iBAAiB,QAAQ,cAAc;;UAG7B;EAChB,OAAO,iBAAiB,UAAU,SAAS;EAC3C,MAAM,iBAAiB,UAAU,SAAS;EAC1C,MAAM,iBAAiB,UAAU,SAAS;EAC1C,OAAO,iBAAiB,UAAU,SAAS;;UAG3B;WACP;WACA;WACA;WACA;WACA;;UAGO;WACP;WACA;WACA;WACA;WACA;WACA;WACA,kBAAkB;WAClB;WACA,WAAW;;KAGT,iCAAiC;UAE5B;WACP,WAAW;WACX,QAAQ;WACR,QAAQ;WACR,SAAS;WACT;WACA;WACA;;WAEA;;WAEA;;WAEA;;WAEA;WACA;WACA,UAAU;WACV,SAAS;WACT,UAAU;;KAGR;WACE;;WACA;;WACA;WAAiC,QAAQ;;WAE3C;WACA,SAAS,SAAS;;WAEhB;;UAEG;WACP;WACA;EACT,YACC,QAAQ,eACR;aAAqB,SAAS;MAC5B,QAAQ;EACX,aACC,QAAQ,eACR,SAAS,sBACP,QAAQ;EACX,WACC,iBAAiB,mBACjB;aAAqB,SAAS;MAC5B,QAAQ;EACX,MACC,4BAA4B,YAC5B,UAAU,oBACR,QAAQ;EACX,OAAO,QAAQ;EACf,MAAM,UAAU,uBAAuB;;UAGvB;EAChB,SAAS,kBAAkB,UAAU,kBAAkB;EACvD,SAAS;EACT,QAAQ;EACR,iBAAiB,iBAAiB;EAClC,gBAAgB;EAChB,UAAU,WAAW,OAAO;EAC5B,SAAS;;UAGO;WACP;WACA;WACA;WACA;WACA;WACA;WACA,QAAQ;;KAGN,0BAA0B,QAAQ;;UAG7B;EAChB,YAAY,mBAAmB;EAC/B,eAAe,mBAAmB;EAClC,UAAU,UAAU;EACpB,SAAS;;UAGO;WACP;WACA;WACA;WACA;WACA;;UAGO;WACP;WACA,QAAQ;WACR;;WAEA;;UAGO;WACP;WACA;;UAGO;EAChB,QAAQ,QAAQ;EAChB,KAAK,QAAQ,eAAe;EAC5B,UAAU;;UAGM;WACP;WACA;WACA;WACA;;UAGO,2BAA2B,cAAc;EACzD;;UAGgB;EAChB,SAAS;EACT;EACA,qBACC,+BACE;EACH,YAAY,mBAAmB;EAC/B,eAAe,mBAAmB;EAClC,UAAU,WAAW,QAAQ;EAC7B,QAAQ,oBAAoB;EAC5B,gBAAgB;EAChB,SAAS;;UAGO;WACP,UAAU;WACV,QAAQ;WACR,QAAQ,KAAK;WACb,SAAS;;WAET;;WAEA;;WAEA;;WAEA;;WAEA"}