@viji-dev/core 0.11.8 → 0.13.0

package/dist/artist-global-p5.d.ts

@@ -185,8 +185,17 @@ declare global {
    * then auto-resets to `false`.
    */
   interface ButtonConfig {
-      /** Display name shown on the button in the parameter UI. Required. */
-      label: string;
+      /**
+       * Advanced: explicit parameter identity. Normally you do NOT set this —
+       * the parameter's name is inferred from the variable or object key you
+       * assign it to (`const speed = viji.slider(...)` → `speed`). Set `name`
+       * only for parameters not assigned to a variable or key (created in an
+       * array, loop, or factory). Must be a valid identifier and scene-globally
+       * unique. When set, it overrides the inferred name.
+       */
+      name?: string;
+      /** Display name shown on the button in the parameter UI. Optional — defaults to the parameter's name. */
+      label?: string;
       /** Optional tooltip / help text shown next to the control. */
       description?: string;
       /** Group name for organizing related parameters under a shared heading. Default: `'general'`. */
@@ -204,7 +213,7 @@ declare global {
       /** `true` for the single frame after the user clicks the button, `false` otherwise. */
       value: boolean;
       /** Display name shown on the button in the parameter UI. */
-      label: string;
+      label?: string;
       /** Tooltip / help text for the control (empty string when not configured). */
       description?: string;
       /** Group name under which the control appears in the UI. */
@@ -253,8 +262,17 @@ declare global {
    * label and UI grouping/visibility.
    */
   interface ColorConfig {
-      /** Display name shown next to the color swatch in the parameter UI. Required. */
-      label: string;
+      /**
+       * Advanced: explicit parameter identity. Normally you do NOT set this —
+       * the parameter's name is inferred from the variable or object key you
+       * assign it to (`const speed = viji.slider(...)` → `speed`). Set `name`
+       * only for parameters not assigned to a variable or key (created in an
+       * array, loop, or factory). Must be a valid identifier and scene-globally
+       * unique. When set, it overrides the inferred name.
+       */
+      name?: string;
+      /** Display name shown next to the color swatch in the parameter UI. Optional — defaults to the parameter's name. */
+      label?: string;
       /** Optional tooltip / help text shown next to the control. */
       description?: string;
       /** Group name for organizing related parameters under a shared heading. Default: `'general'`. */
@@ -315,7 +333,7 @@ declare global {
           b: number;
       };
       /** Display name shown next to the swatch in the parameter UI. */
-      label: string;
+      label?: string;
       /** Tooltip / help text for the control (empty string when not configured). */
       description?: string;
       /** Group name under which the control appears in the UI. */
@@ -329,10 +347,19 @@ declare global {
    * draggable pad; both `x` and `y` are clamped to `-1..1`.
    */
   interface CoordinateConfig {
+      /**
+       * Advanced: explicit parameter identity. Normally you do NOT set this —
+       * the parameter's name is inferred from the variable or object key you
+       * assign it to (`const speed = viji.slider(...)` → `speed`). Set `name`
+       * only for parameters not assigned to a variable or key (created in an
+       * array, loop, or factory). Must be a valid identifier and scene-globally
+       * unique. When set, it overrides the inferred name.
+       */
+      name?: string;
       /** Snap increment for both `x` and `y` components. Default: `0.01`. */
       step?: number;
-      /** Display name shown next to the pad in the parameter UI. Required. */
-      label: string;
+      /** Display name shown next to the pad in the parameter UI. Optional — defaults to the parameter's name. */
+      label?: string;
       /** Optional tooltip / help text shown next to the control. */
       description?: string;
       /** Group name for organizing related parameters under a shared heading. Default: `'general'`. */
@@ -351,7 +378,7 @@ declare global {
       /** Snap increment for both `x` and `y` components. */
       step: number;
       /** Display name shown next to the pad in the parameter UI. */
-      label: string;
+      label?: string;
       /** Tooltip / help text for the control (empty string when not configured). */
       description?: string;
       /** Group name under which the control appears in the UI. */
@@ -745,8 +772,17 @@ declare global {
    * or a P5 image wrapper (P5 renderer).
    */
   interface ImageConfig {
-      /** Display name shown next to the upload field in the parameter UI. Required. */
-      label: string;
+      /**
+       * Advanced: explicit parameter identity. Normally you do NOT set this —
+       * the parameter's name is inferred from the variable or object key you
+       * assign it to (`const speed = viji.slider(...)` → `speed`). Set `name`
+       * only for parameters not assigned to a variable or key (created in an
+       * array, loop, or factory). Must be a valid identifier and scene-globally
+       * unique. When set, it overrides the inferred name.
+       */
+      name?: string;
+      /** Display name shown next to the upload field in the parameter UI. Optional — defaults to the parameter's name. */
+      label?: string;
       /** Optional tooltip / help text shown next to the control. */
       description?: string;
       /** Group name for organizing related parameters under a shared heading. Default: `'general'`. */
@@ -766,7 +802,7 @@ declare global {
       /** P5-compatible image wrapper. Only available in the P5 renderer; added at runtime by the P5 adapter. */
       readonly p5?: any;
       /** Display name shown next to the upload field in the parameter UI. */
-      label: string;
+      label?: string;
       /** Tooltip / help text for the control (empty string when not configured). */
       description?: string;
       /** Group name under which the control appears in the UI. */
@@ -872,6 +908,15 @@ declare global {
    * label, and UI grouping/visibility for a precise numeric input.
    */
   interface NumberConfig {
+      /**
+       * Advanced: explicit parameter identity. Normally you do NOT set this —
+       * the parameter's name is inferred from the variable or object key you
+       * assign it to (`const speed = viji.slider(...)` → `speed`). Set `name`
+       * only for parameters not assigned to a variable or key (created in an
+       * array, loop, or factory). Must be a valid identifier and scene-globally
+       * unique. When set, it overrides the inferred name.
+       */
+      name?: string;
       /** Inclusive minimum value. Default: `0`. */
       min?: number;
       /** Inclusive maximum value. Default: `100`. */
@@ -884,8 +929,8 @@ declare global {
        * (`step: 0.001`).
        */
       step?: number;
-      /** Display name shown next to the input in the parameter UI. Required. */
-      label: string;
+      /** Display name shown next to the input in the parameter UI. Optional — defaults to the parameter's name. */
+      label?: string;
       /** Optional tooltip / help text shown next to the control. */
       description?: string;
       /** Group name for organizing related parameters under a shared heading. Default: `'general'`. */
@@ -908,7 +953,7 @@ declare global {
       /** Increment between values. */
       step: number;
       /** Display name shown next to the input in the parameter UI. */
-      label: string;
+      label?: string;
       /** Tooltip / help text for the control (empty string when not configured). */
       description?: string;
       /** Group name under which the control appears in the UI. */
@@ -1044,10 +1089,19 @@ declare global {
    * as a dropdown or segmented control.
    */
   interface SelectConfig {
+      /**
+       * Advanced: explicit parameter identity. Normally you do NOT set this —
+       * the parameter's name is inferred from the variable or object key you
+       * assign it to (`const speed = viji.slider(...)` → `speed`). Set `name`
+       * only for parameters not assigned to a variable or key (created in an
+       * array, loop, or factory). Must be a valid identifier and scene-globally
+       * unique. When set, it overrides the inferred name.
+       */
+      name?: string;
       /** Available choices. The element type (`string` or `number`) becomes the parameter's value type. Required. */
       options: string[] | number[];
-      /** Display name shown next to the dropdown in the parameter UI. Required. */
-      label: string;
+      /** Display name shown next to the dropdown in the parameter UI. Optional — defaults to the parameter's name. */
+      label?: string;
       /** Optional tooltip / help text shown next to the control. */
       description?: string;
       /** Group name for organizing related parameters under a shared heading. Default: `'general'`. */
@@ -1066,7 +1120,7 @@ declare global {
       /** The full list of choices originally configured. */
       options: string[] | number[];
       /** Display name shown next to the dropdown in the parameter UI. */
-      label: string;
+      label?: string;
       /** Tooltip / help text for the control (empty string when not configured). */
       description?: string;
       /** Group name under which the control appears in the UI. */
@@ -1080,6 +1134,15 @@ declare global {
    * increment, label, and UI grouping/visibility.
    */
   interface SliderConfig {
+      /**
+       * Advanced: explicit parameter identity. Normally you do NOT set this —
+       * the parameter's name is inferred from the variable or object key you
+       * assign it to (`const speed = viji.slider(...)` → `speed`). Set `name`
+       * only for parameters not assigned to a variable or key (created in an
+       * array, loop, or factory). Must be a valid identifier and scene-globally
+       * unique. When set, it overrides the inferred name.
+       */
+      name?: string;
       /** Inclusive minimum value of the slider. Default: `0`. */
       min?: number;
       /** Inclusive maximum value of the slider. Default: `100`. */
@@ -1092,8 +1155,8 @@ declare global {
        * (`step: 1` on a range of `3..30`) or fine precision (`step: 0.001`).
        */
       step?: number;
-      /** Display name shown next to the control in the parameter UI. Required. */
-      label: string;
+      /** Display name shown next to the control in the parameter UI. Optional — defaults to the parameter's name. */
+      label?: string;
       /** Optional tooltip / help text shown next to the control. */
       description?: string;
       /** Group name for organizing related parameters under a shared heading. Default: `'general'`. */
@@ -1116,7 +1179,7 @@ declare global {
       /** Increment between values. */
       step: number;
       /** Display name shown next to the control in the parameter UI. */
-      label: string;
+      label?: string;
       /** Tooltip / help text for the control (empty string when not configured). */
       description?: string;
       /** Group name under which the control appears in the UI. */
@@ -1130,8 +1193,17 @@ declare global {
    * text input field.
    */
   interface TextConfig {
-      /** Display name shown next to the text field in the parameter UI. Required. */
-      label: string;
+      /**
+       * Advanced: explicit parameter identity. Normally you do NOT set this —
+       * the parameter's name is inferred from the variable or object key you
+       * assign it to (`const speed = viji.slider(...)` → `speed`). Set `name`
+       * only for parameters not assigned to a variable or key (created in an
+       * array, loop, or factory). Must be a valid identifier and scene-globally
+       * unique. When set, it overrides the inferred name.
+       */
+      name?: string;
+      /** Display name shown next to the text field in the parameter UI. Optional — defaults to the parameter's name. */
+      label?: string;
       /** Optional tooltip / help text shown next to the control. */
       description?: string;
       /** Group name for organizing related parameters under a shared heading. Default: `'general'`. */
@@ -1152,7 +1224,7 @@ declare global {
       /** Maximum character count enforced by the host UI. */
       maxLength?: number;
       /** Display name shown next to the input in the parameter UI. */
-      label: string;
+      label?: string;
       /** Tooltip / help text for the control (empty string when not configured). */
       description?: string;
       /** Group name under which the control appears in the UI. */
@@ -1166,8 +1238,17 @@ declare global {
    * label and UI grouping/visibility.
    */
   interface ToggleConfig {
-      /** Display name shown next to the switch in the parameter UI. Required. */
-      label: string;
+      /**
+       * Advanced: explicit parameter identity. Normally you do NOT set this —
+       * the parameter's name is inferred from the variable or object key you
+       * assign it to (`const speed = viji.slider(...)` → `speed`). Set `name`
+       * only for parameters not assigned to a variable or key (created in an
+       * array, loop, or factory). Must be a valid identifier and scene-globally
+       * unique. When set, it overrides the inferred name.
+       */
+      name?: string;
+      /** Display name shown next to the switch in the parameter UI. Optional — defaults to the parameter's name. */
+      label?: string;
       /** Optional tooltip / help text shown next to the control. */
       description?: string;
       /** Group name for organizing related parameters under a shared heading. Default: `'general'`. */
@@ -1184,7 +1265,7 @@ declare global {
       /** Current state of the switch. Updates in real-time when the user toggles it. */
       value: boolean;
       /** Display name shown next to the switch in the parameter UI. */
-      label: string;
+      label?: string;
       /** Tooltip / help text for the control (empty string when not configured). */
       description?: string;
       /** Group name under which the control appears in the UI. */
@@ -1264,7 +1345,7 @@ declare global {
       isEnding: boolean;
   }
 
-  const VERSION = "0.11.8";
+  const VERSION = "0.13.0";
 
   /**
    * Real-time video API: drawable frame, dimensions, and the source-side

package/dist/artist-global.d.ts

@@ -185,8 +185,17 @@ declare global {
    * then auto-resets to `false`.
    */
   interface ButtonConfig {
-      /** Display name shown on the button in the parameter UI. Required. */
-      label: string;
+      /**
+       * Advanced: explicit parameter identity. Normally you do NOT set this —
+       * the parameter's name is inferred from the variable or object key you
+       * assign it to (`const speed = viji.slider(...)` → `speed`). Set `name`
+       * only for parameters not assigned to a variable or key (created in an
+       * array, loop, or factory). Must be a valid identifier and scene-globally
+       * unique. When set, it overrides the inferred name.
+       */
+      name?: string;
+      /** Display name shown on the button in the parameter UI. Optional — defaults to the parameter's name. */
+      label?: string;
       /** Optional tooltip / help text shown next to the control. */
       description?: string;
       /** Group name for organizing related parameters under a shared heading. Default: `'general'`. */
@@ -204,7 +213,7 @@ declare global {
       /** `true` for the single frame after the user clicks the button, `false` otherwise. */
       value: boolean;
       /** Display name shown on the button in the parameter UI. */
-      label: string;
+      label?: string;
       /** Tooltip / help text for the control (empty string when not configured). */
       description?: string;
       /** Group name under which the control appears in the UI. */
@@ -253,8 +262,17 @@ declare global {
    * label and UI grouping/visibility.
    */
   interface ColorConfig {
-      /** Display name shown next to the color swatch in the parameter UI. Required. */
-      label: string;
+      /**
+       * Advanced: explicit parameter identity. Normally you do NOT set this —
+       * the parameter's name is inferred from the variable or object key you
+       * assign it to (`const speed = viji.slider(...)` → `speed`). Set `name`
+       * only for parameters not assigned to a variable or key (created in an
+       * array, loop, or factory). Must be a valid identifier and scene-globally
+       * unique. When set, it overrides the inferred name.
+       */
+      name?: string;
+      /** Display name shown next to the color swatch in the parameter UI. Optional — defaults to the parameter's name. */
+      label?: string;
       /** Optional tooltip / help text shown next to the control. */
       description?: string;
       /** Group name for organizing related parameters under a shared heading. Default: `'general'`. */
@@ -315,7 +333,7 @@ declare global {
           b: number;
       };
       /** Display name shown next to the swatch in the parameter UI. */
-      label: string;
+      label?: string;
       /** Tooltip / help text for the control (empty string when not configured). */
       description?: string;
       /** Group name under which the control appears in the UI. */
@@ -329,10 +347,19 @@ declare global {
    * draggable pad; both `x` and `y` are clamped to `-1..1`.
    */
   interface CoordinateConfig {
+      /**
+       * Advanced: explicit parameter identity. Normally you do NOT set this —
+       * the parameter's name is inferred from the variable or object key you
+       * assign it to (`const speed = viji.slider(...)` → `speed`). Set `name`
+       * only for parameters not assigned to a variable or key (created in an
+       * array, loop, or factory). Must be a valid identifier and scene-globally
+       * unique. When set, it overrides the inferred name.
+       */
+      name?: string;
       /** Snap increment for both `x` and `y` components. Default: `0.01`. */
       step?: number;
-      /** Display name shown next to the pad in the parameter UI. Required. */
-      label: string;
+      /** Display name shown next to the pad in the parameter UI. Optional — defaults to the parameter's name. */
+      label?: string;
       /** Optional tooltip / help text shown next to the control. */
       description?: string;
       /** Group name for organizing related parameters under a shared heading. Default: `'general'`. */
@@ -351,7 +378,7 @@ declare global {
       /** Snap increment for both `x` and `y` components. */
       step: number;
       /** Display name shown next to the pad in the parameter UI. */
-      label: string;
+      label?: string;
       /** Tooltip / help text for the control (empty string when not configured). */
       description?: string;
       /** Group name under which the control appears in the UI. */
@@ -745,8 +772,17 @@ declare global {
    * or a P5 image wrapper (P5 renderer).
    */
   interface ImageConfig {
-      /** Display name shown next to the upload field in the parameter UI. Required. */
-      label: string;
+      /**
+       * Advanced: explicit parameter identity. Normally you do NOT set this —
+       * the parameter's name is inferred from the variable or object key you
+       * assign it to (`const speed = viji.slider(...)` → `speed`). Set `name`
+       * only for parameters not assigned to a variable or key (created in an
+       * array, loop, or factory). Must be a valid identifier and scene-globally
+       * unique. When set, it overrides the inferred name.
+       */
+      name?: string;
+      /** Display name shown next to the upload field in the parameter UI. Optional — defaults to the parameter's name. */
+      label?: string;
       /** Optional tooltip / help text shown next to the control. */
       description?: string;
       /** Group name for organizing related parameters under a shared heading. Default: `'general'`. */
@@ -766,7 +802,7 @@ declare global {
       /** P5-compatible image wrapper. Only available in the P5 renderer; added at runtime by the P5 adapter. */
       readonly p5?: any;
       /** Display name shown next to the upload field in the parameter UI. */
-      label: string;
+      label?: string;
       /** Tooltip / help text for the control (empty string when not configured). */
       description?: string;
       /** Group name under which the control appears in the UI. */
@@ -861,6 +897,15 @@ declare global {
    * label, and UI grouping/visibility for a precise numeric input.
    */
   interface NumberConfig {
+      /**
+       * Advanced: explicit parameter identity. Normally you do NOT set this —
+       * the parameter's name is inferred from the variable or object key you
+       * assign it to (`const speed = viji.slider(...)` → `speed`). Set `name`
+       * only for parameters not assigned to a variable or key (created in an
+       * array, loop, or factory). Must be a valid identifier and scene-globally
+       * unique. When set, it overrides the inferred name.
+       */
+      name?: string;
       /** Inclusive minimum value. Default: `0`. */
       min?: number;
       /** Inclusive maximum value. Default: `100`. */
@@ -873,8 +918,8 @@ declare global {
        * (`step: 0.001`).
        */
       step?: number;
-      /** Display name shown next to the input in the parameter UI. Required. */
-      label: string;
+      /** Display name shown next to the input in the parameter UI. Optional — defaults to the parameter's name. */
+      label?: string;
       /** Optional tooltip / help text shown next to the control. */
       description?: string;
       /** Group name for organizing related parameters under a shared heading. Default: `'general'`. */
@@ -897,7 +942,7 @@ declare global {
       /** Increment between values. */
       step: number;
       /** Display name shown next to the input in the parameter UI. */
-      label: string;
+      label?: string;
       /** Tooltip / help text for the control (empty string when not configured). */
       description?: string;
       /** Group name under which the control appears in the UI. */
@@ -1033,10 +1078,19 @@ declare global {
    * as a dropdown or segmented control.
    */
   interface SelectConfig {
+      /**
+       * Advanced: explicit parameter identity. Normally you do NOT set this —
+       * the parameter's name is inferred from the variable or object key you
+       * assign it to (`const speed = viji.slider(...)` → `speed`). Set `name`
+       * only for parameters not assigned to a variable or key (created in an
+       * array, loop, or factory). Must be a valid identifier and scene-globally
+       * unique. When set, it overrides the inferred name.
+       */
+      name?: string;
       /** Available choices. The element type (`string` or `number`) becomes the parameter's value type. Required. */
       options: string[] | number[];
-      /** Display name shown next to the dropdown in the parameter UI. Required. */
-      label: string;
+      /** Display name shown next to the dropdown in the parameter UI. Optional — defaults to the parameter's name. */
+      label?: string;
       /** Optional tooltip / help text shown next to the control. */
       description?: string;
       /** Group name for organizing related parameters under a shared heading. Default: `'general'`. */
@@ -1055,7 +1109,7 @@ declare global {
       /** The full list of choices originally configured. */
       options: string[] | number[];
       /** Display name shown next to the dropdown in the parameter UI. */
-      label: string;
+      label?: string;
       /** Tooltip / help text for the control (empty string when not configured). */
       description?: string;
       /** Group name under which the control appears in the UI. */
@@ -1069,6 +1123,15 @@ declare global {
    * increment, label, and UI grouping/visibility.
    */
   interface SliderConfig {
+      /**
+       * Advanced: explicit parameter identity. Normally you do NOT set this —
+       * the parameter's name is inferred from the variable or object key you
+       * assign it to (`const speed = viji.slider(...)` → `speed`). Set `name`
+       * only for parameters not assigned to a variable or key (created in an
+       * array, loop, or factory). Must be a valid identifier and scene-globally
+       * unique. When set, it overrides the inferred name.
+       */
+      name?: string;
       /** Inclusive minimum value of the slider. Default: `0`. */
       min?: number;
       /** Inclusive maximum value of the slider. Default: `100`. */
@@ -1081,8 +1144,8 @@ declare global {
        * (`step: 1` on a range of `3..30`) or fine precision (`step: 0.001`).
        */
       step?: number;
-      /** Display name shown next to the control in the parameter UI. Required. */
-      label: string;
+      /** Display name shown next to the control in the parameter UI. Optional — defaults to the parameter's name. */
+      label?: string;
       /** Optional tooltip / help text shown next to the control. */
       description?: string;
       /** Group name for organizing related parameters under a shared heading. Default: `'general'`. */
@@ -1105,7 +1168,7 @@ declare global {
       /** Increment between values. */
       step: number;
       /** Display name shown next to the control in the parameter UI. */
-      label: string;
+      label?: string;
       /** Tooltip / help text for the control (empty string when not configured). */
       description?: string;
       /** Group name under which the control appears in the UI. */
@@ -1119,8 +1182,17 @@ declare global {
    * text input field.
    */
   interface TextConfig {
-      /** Display name shown next to the text field in the parameter UI. Required. */
-      label: string;
+      /**
+       * Advanced: explicit parameter identity. Normally you do NOT set this —
+       * the parameter's name is inferred from the variable or object key you
+       * assign it to (`const speed = viji.slider(...)` → `speed`). Set `name`
+       * only for parameters not assigned to a variable or key (created in an
+       * array, loop, or factory). Must be a valid identifier and scene-globally
+       * unique. When set, it overrides the inferred name.
+       */
+      name?: string;
+      /** Display name shown next to the text field in the parameter UI. Optional — defaults to the parameter's name. */
+      label?: string;
       /** Optional tooltip / help text shown next to the control. */
       description?: string;
       /** Group name for organizing related parameters under a shared heading. Default: `'general'`. */
@@ -1141,7 +1213,7 @@ declare global {
       /** Maximum character count enforced by the host UI. */
       maxLength?: number;
       /** Display name shown next to the input in the parameter UI. */
-      label: string;
+      label?: string;
       /** Tooltip / help text for the control (empty string when not configured). */
       description?: string;
       /** Group name under which the control appears in the UI. */
@@ -1155,8 +1227,17 @@ declare global {
    * label and UI grouping/visibility.
    */
   interface ToggleConfig {
-      /** Display name shown next to the switch in the parameter UI. Required. */
-      label: string;
+      /**
+       * Advanced: explicit parameter identity. Normally you do NOT set this —
+       * the parameter's name is inferred from the variable or object key you
+       * assign it to (`const speed = viji.slider(...)` → `speed`). Set `name`
+       * only for parameters not assigned to a variable or key (created in an
+       * array, loop, or factory). Must be a valid identifier and scene-globally
+       * unique. When set, it overrides the inferred name.
+       */
+      name?: string;
+      /** Display name shown next to the switch in the parameter UI. Optional — defaults to the parameter's name. */
+      label?: string;
       /** Optional tooltip / help text shown next to the control. */
       description?: string;
       /** Group name for organizing related parameters under a shared heading. Default: `'general'`. */
@@ -1173,7 +1254,7 @@ declare global {
       /** Current state of the switch. Updates in real-time when the user toggles it. */
       value: boolean;
       /** Display name shown next to the switch in the parameter UI. */
-      label: string;
+      label?: string;
       /** Tooltip / help text for the control (empty string when not configured). */
       description?: string;
       /** Group name under which the control appears in the UI. */
@@ -1253,7 +1334,7 @@ declare global {
       isEnding: boolean;
   }
 
-  const VERSION = "0.11.8";
+  const VERSION = "0.13.0";
 
   /**
    * Real-time video API: drawable frame, dimensions, and the source-side