@rainbow-robotics/plugin-ui 1.3.8-dev.3 → 1.10.1-dev.0

package/src/manifest.ts

@@ -1,135 +1,135 @@
-/* eslint-disable @typescript-eslint/no-explicit-any */
-/**
- * Plugin manifest schema — the single source of truth shared by the front end
- * (nexus reads it) and the back end (rby2 mirrors it for validation).
- *
- * Evolve additively only.
- */
-
-/** Known contribution points the host understands. */
-export const CONTRIBUTION_POINTS = [
-  "toolbar",
-  "lnb",
-  "move.panel",
-  "program.panel",
-] as const;
-
-export type ContributionPoint = (typeof CONTRIBUTION_POINTS)[number];
-
-/** How a header.toolbar contribution opens when clicked. */
-export type ContributionOpens = "popover" | "panel" | "page";
-
-export interface PluginContribution {
-  /** Where this contribution mounts. */
-  point: ContributionPoint | (string & {});
-  /** UI entry name relative to ui/ (without extension). Defaults to "content". */
-  ui?: string;
-  /** Icon path relative to the plugin root (e.g. "assets/icon.svg"). */
-  icon?:
-    | string
-    | {
-        "16"?: string;
-        "48"?: string;
-        "126"?: string;
-      };
-  /** Display label. */
-  label?: string | Record<string, string>;
-  /** For header.toolbar: how the contribution surfaces. */
-  opens?: ContributionOpens;
-  commandInfo?: {
-    name: string;
-    icon: string;
-    funcName: string;
-    args?: Record<string, any>;
-  };
-}
-
-export interface PluginAction {
-  /** Action id referenced by `rb.action(id, payload)`. */
-  id: string;
-  /** Transport topic (Zenoh / ROS2) the back end routes to. */
-  topic: string;
-  /** Optional payload schema hint (field → type name). */
-  schema?: Record<string, string>;
-}
-
-/** Allowed variable value types exposed to pyfm. */
-export const VARIABLE_TYPES = ["number", "string", "boolean", "array"] as const;
-
-export type PluginVariableType = (typeof VARIABLE_TYPES)[number];
-
-/** A variable the plugin pre-declares for use in pyfm programs. */
-export interface PluginVariable {
-  /** Identifier, must start with "RBP_" (then letters, digits, underscore). Unique per plugin. */
-  name: `RBP_${string}`;
-  type: PluginVariableType;
-  /** Initial value — must match `type`. */
-  init: number | string | boolean | any[];
-  /** Optional. Without it the UI cannot explain what the variable is for. */
-  description?: string | Record<string, string>;
-}
-
-export type PluginRuntime =
-  | { type: "none" }
-  | { type: "python"; entry: string }
-  | {
-      type: "ros2";
-      package: string;
-      launch: string;
-      rosClient: "rclpy" | "rclcpp";
-    };
-
-export interface PluginManifest {
-  /** Reverse-DNS unique id, e.g. "com.rainbow.gripper-tool". */
-  id: string;
-  /** Human-readable name. */
-  name: string;
-  /** Plugin version (semver). */
-  version: string;
-  /** Minimum host (Muscat) version this plugin supports. */
-  minAppVersion?: string;
-  /** Icon path relative to plugin root. */
-  icons:
-    | string
-    | {
-        "16"?: string;
-        "48"?: string;
-        "128"?: string;
-      };
-  /** UI / chrome contributions. */
-  contributes?: PluginContribution[];
-  /** Host actions the plugin can invoke. */
-  actions?: PluginAction[];
-  /** Variables pre-declared for pyfm; the variable picker UI lists these. */
-  variables?: PluginVariable[];
-  /** Back-end runtime declaration. */
-  runtime?: PluginRuntime;
-}
-
-/**
- * Lightweight structural check. Returns the list of problems (empty = valid).
- * Kept dependency-free so both front and back ends can reuse it; richer
- * validation (zod) can layer on top later without breaking this contract.
- */
-export function validateManifest(value: unknown): string[] {
-  const errors: string[] = [];
-  if (typeof value !== "object" || value === null) {
-    return ["manifest must be an object"];
-  }
-  const m = value as Record<string, unknown>;
-  if (typeof m.id !== "string" || m.id.length === 0)
-    errors.push("manifest.id is required (string)");
-  else if (!/^[a-z][a-z0-9]*(-[a-z0-9]+)*(\.[a-z][a-z0-9]*(-[a-z0-9]+)*)*$/.test(m.id))
-    errors.push('manifest.id must be "."-separated parts of lowercase letters/digits and single "-", each starting with a letter (e.g. com.example.my-plugin)');
-  if (typeof m.name !== "string" || m.name.length === 0)
-    errors.push("manifest.name is required (string)");
-  if (typeof m.version !== "string" || m.version.length === 0)
-    errors.push("manifest.version is required (string)");
-  if (m.contributes !== undefined && !Array.isArray(m.contributes))
-    errors.push("manifest.contributes must be an array");
-  if (m.actions !== undefined && !Array.isArray(m.actions))
-    errors.push("manifest.actions must be an array");
-  if (m.variables !== undefined && !Array.isArray(m.variables))
-    errors.push("manifest.variables must be an array");
-  return errors;
-}
+/* eslint-disable @typescript-eslint/no-explicit-any */
+/**
+ * Plugin manifest schema — the single source of truth shared by the front end
+ * (nexus reads it) and the back end (rby2 mirrors it for validation).
+ *
+ * Evolve additively only.
+ */
+
+/** Known contribution points the host understands. */
+export const CONTRIBUTION_POINTS = [
+  "toolbar",
+  "lnb",
+  "move.panel",
+  "program.panel",
+] as const;
+
+export type ContributionPoint = (typeof CONTRIBUTION_POINTS)[number];
+
+/** How a header.toolbar contribution opens when clicked. */
+export type ContributionOpens = "popover" | "panel" | "page";
+
+export interface PluginContribution {
+  /** Where this contribution mounts. */
+  point: ContributionPoint | (string & {});
+  /** UI entry name relative to ui/ (without extension). Defaults to "content". */
+  ui?: string;
+  /** Icon path relative to the plugin root (e.g. "assets/icon.svg"). */
+  icon?:
+    | string
+    | {
+        "16"?: string;
+        "48"?: string;
+        "126"?: string;
+      };
+  /** Display label. */
+  label?: string | Record<string, string>;
+  /** For header.toolbar: how the contribution surfaces. */
+  opens?: ContributionOpens;
+  commandInfo?: {
+    name: string;
+    icon: string;
+    funcName: string;
+    args?: Record<string, any>;
+  };
+}
+
+export interface PluginAction {
+  /** Action id referenced by `rb.action(id, payload)`. */
+  id: string;
+  /** Transport topic (Zenoh / ROS2) the back end routes to. */
+  topic: string;
+  /** Optional payload schema hint (field → type name). */
+  schema?: Record<string, string>;
+}
+
+/** Allowed variable value types exposed to pyfm. */
+export const VARIABLE_TYPES = ["number", "string", "boolean", "array"] as const;
+
+export type PluginVariableType = (typeof VARIABLE_TYPES)[number];
+
+/** A variable the plugin pre-declares for use in pyfm programs. */
+export interface PluginVariable {
+  /** Identifier, must start with "RBP_" (then letters, digits, underscore). Unique per plugin. */
+  name: `RBP_${string}`;
+  type: PluginVariableType;
+  /** Initial value — must match `type`. */
+  init: number | string | boolean | any[];
+  /** Optional. Without it the UI cannot explain what the variable is for. */
+  description?: string | Record<string, string>;
+}
+
+export type PluginRuntime =
+  | { type: "none" }
+  | { type: "python"; entry: string }
+  | {
+      type: "ros2";
+      package: string;
+      launch: string;
+      rosClient: "rclpy" | "rclcpp";
+    };
+
+export interface PluginManifest {
+  /** Reverse-DNS unique id, e.g. "com.rainbow.gripper-tool". */
+  id: string;
+  /** Human-readable name. */
+  name: string;
+  /** Plugin version (semver). */
+  version: string;
+  /** Minimum host (Muscat) version this plugin supports. */
+  minAppVersion?: string;
+  /** Icon path relative to plugin root. */
+  icons:
+    | string
+    | {
+        "16"?: string;
+        "48"?: string;
+        "128"?: string;
+      };
+  /** UI / chrome contributions. */
+  contributes?: PluginContribution[];
+  /** Host actions the plugin can invoke. */
+  actions?: PluginAction[];
+  /** Variables pre-declared for pyfm; the variable picker UI lists these. */
+  variables?: PluginVariable[];
+  /** Back-end runtime declaration. */
+  runtime?: PluginRuntime;
+}
+
+/**
+ * Lightweight structural check. Returns the list of problems (empty = valid).
+ * Kept dependency-free so both front and back ends can reuse it; richer
+ * validation (zod) can layer on top later without breaking this contract.
+ */
+export function validateManifest(value: unknown): string[] {
+  const errors: string[] = [];
+  if (typeof value !== "object" || value === null) {
+    return ["manifest must be an object"];
+  }
+  const m = value as Record<string, unknown>;
+  if (typeof m.id !== "string" || m.id.length === 0)
+    errors.push("manifest.id is required (string)");
+  else if (!/^[a-z][a-z0-9]*(-[a-z0-9]+)*(\.[a-z][a-z0-9]*(-[a-z0-9]+)*)*$/.test(m.id))
+    errors.push('manifest.id must be "."-separated parts of lowercase letters/digits and single "-", each starting with a letter (e.g. com.example.my-plugin)');
+  if (typeof m.name !== "string" || m.name.length === 0)
+    errors.push("manifest.name is required (string)");
+  if (typeof m.version !== "string" || m.version.length === 0)
+    errors.push("manifest.version is required (string)");
+  if (m.contributes !== undefined && !Array.isArray(m.contributes))
+    errors.push("manifest.contributes must be an array");
+  if (m.actions !== undefined && !Array.isArray(m.actions))
+    errors.push("manifest.actions must be an array");
+  if (m.variables !== undefined && !Array.isArray(m.variables))
+    errors.push("manifest.variables must be an array");
+  return errors;
+}