@tx5dr/contracts 1.2.0

package/dist/schema/radio-power.schema.js

@@ -0,0 +1,87 @@
+import { z } from 'zod';
+import { HamlibConfigSchema } from './radio.schema.js';
+/**
+ * High-level runtime state tracked by the RadioPowerController.
+ *
+ * - `off`: radio is known to be off (or was never connected).
+ * - `waking`: power-on command sent, waiting for the radio to respond.
+ * - `awake`: radio is responding; the engine is being started (if autoEngine).
+ * - `shutting_down`: engine is stopping in preparation for a power-off command.
+ * - `entering_standby`: powerstat(2) sent, waiting for radio to drop CAT link.
+ * - `failed`: last transition failed; UI should show an error + retry.
+ */
+export const RadioPowerStateSchema = z.enum([
+    'off',
+    'waking',
+    'awake',
+    'shutting_down',
+    'entering_standby',
+    'failed',
+]);
+/**
+ * Finer-grained progress stage inside `waking` / `shutting_down`.
+ * UI uses this to show progress bar labels.
+ */
+export const RadioPowerStageSchema = z.enum([
+    'idle',
+    'sending_command',
+    'waiting_ready',
+    'waiting_standby_disconnect',
+    'starting_engine',
+    'stopping_engine',
+    'disconnecting',
+]);
+/**
+ * WS event payload: server → client.
+ */
+export const RadioPowerStateEventSchema = z.object({
+    profileId: z.string().optional(),
+    state: RadioPowerStateSchema,
+    stage: RadioPowerStageSchema,
+    /** Translation key reference for an inline error, e.g. 'radio:power.error.timeout'. */
+    errorKey: z.string().optional(),
+    /** Free-form details for debugging; not user-facing. */
+    errorDetail: z.string().optional(),
+});
+/**
+ * REST request body: POST /api/radio/power
+ */
+/** Allowed target states for a power request. */
+export const RadioPowerTargetSchema = z.enum(['on', 'off', 'standby', 'operate']);
+export const RadioPowerRequestSchema = z.object({
+    profileId: z.string().min(1),
+    state: RadioPowerTargetSchema,
+    /** Automatically start the engine after successful power-on. Defaults to true. */
+    autoEngine: z.boolean().optional().default(true),
+});
+/**
+ * REST response: POST /api/radio/power
+ */
+export const RadioPowerResponseSchema = z.object({
+    success: z.boolean(),
+    state: RadioPowerStateSchema,
+});
+/**
+ * REST response: GET /api/radio/power/support?profileId=xxx
+ * The server resolves mfgName/modelName internally via HamLib.getSupportedRigs().
+ */
+export const RadioPowerSupportInfoSchema = z.object({
+    profileId: z.string(),
+    canPowerOn: z.boolean(),
+    canPowerOff: z.boolean(),
+    /**
+     * States the user is allowed to switch *between* while the radio is connected.
+     * Empty when the radio is unsupported or not connected (UI then renders no dropdown).
+     */
+    supportedStates: z.array(z.enum(['operate', 'standby', 'off'])).default([]),
+    reason: z.enum(['model-unsupported', 'network-mode-no-wake', 'none-mode']).optional(),
+    rigInfo: z
+        .object({
+        mfgName: z.string(),
+        modelName: z.string(),
+    })
+        .optional(),
+});
+/** Convenience re-export so callers can validate a full config blob. */
+export const RadioPowerProfileConfigSchema = HamlibConfigSchema;
+//# sourceMappingURL=radio-power.schema.js.map

package/dist/schema/radio-power.schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"radio-power.schema.js","sourceRoot":"","sources":["../../src/schema/radio-power.schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AAEvD;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,CAAC,IAAI,CAAC;IAC1C,KAAK;IACL,QAAQ;IACR,OAAO;IACP,eAAe;IACf,kBAAkB;IAClB,QAAQ;CACT,CAAC,CAAC;AAGH;;;GAGG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,CAAC,IAAI,CAAC;IAC1C,MAAM;IACN,iBAAiB;IACjB,eAAe;IACf,4BAA4B;IAC5B,iBAAiB;IACjB,iBAAiB;IACjB,eAAe;CAChB,CAAC,CAAC;AAGH;;GAEG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC,CAAC,MAAM,CAAC;IACjD,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAChC,KAAK,EAAE,qBAAqB;IAC5B,KAAK,EAAE,qBAAqB;IAC5B,uFAAuF;IACvF,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC/B,wDAAwD;IACxD,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CACnC,CAAC,CAAC;AAGH;;GAEG;AACH,iDAAiD;AACjD,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC;AAGlF,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC9C,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IAC5B,KAAK,EAAE,sBAAsB;IAC7B,kFAAkF;IAClF,UAAU,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC;CACjD,CAAC,CAAC;AAGH;;GAEG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC/C,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE;IACpB,KAAK,EAAE,qBAAqB;CAC7B,CAAC,CAAC;AAGH;;;GAGG;AACH,MAAM,CAAC,MAAM,2BAA2B,GAAG,CAAC,CAAC,MAAM,CAAC;IAClD,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;IACrB,UAAU,EAAE,CAAC,CAAC,OAAO,EAAE;IACvB,WAAW,EAAE,CAAC,CAAC,OAAO,EAAE;IACxB;;;OAGG;IACH,eAAe,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,SAAS,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC;IAC3E,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,mBAAmB,EAAE,sBAAsB,EAAE,WAAW,CAAC,CAAC,CAAC,QAAQ,EAAE;IACrF,OAAO,EAAE,CAAC;SACP,MAAM,CAAC;QACN,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;QACnB,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;KACtB,CAAC;SACD,QAAQ,EAAE;CACd,CAAC,CAAC;AAGH,wEAAwE;AACxE,MAAM,CAAC,MAAM,6BAA6B,GAAG,kBAAkB,CAAC"}