@viji-dev/core 0.3.23 → 0.3.25

package/dist/artist-jsdoc.d.ts

@@ -4,29 +4,422 @@
  */
 
 /**
- * Global viji object available in artist code
- * @type {VijiAPI}
+ * Configuration for slider parameters
+ * @typedef {Object} SliderConfig
+ * @property {number} [min] - min property
+ * @property {number} [max] - max property
+ * @property {number} [step] - step property
+ * @property {string} label - label property
+ * @property {string} [description] - description property
+ * @property {string} [group] - group property
+ * @property {ParameterCategory} [category] - category property
  */
-declare const viji;
 
 /**
- * Type alias for render function
- * @typedef {function(VijiAPI): void} Render
+ * Configuration for color parameters
+ * @typedef {Object} ColorConfig
+ * @property {string} label - label property
+ * @property {string} [description] - description property
+ * @property {string} [group] - group property
+ * @property {ParameterCategory} [category] - category property
  */
 
 /**
- * Type alias for setup function
- * @typedef {function(VijiAPI): void} Setup
+ * Configuration for toggle parameters
+ * @typedef {Object} ToggleConfig
+ * @property {string} label - label property
+ * @property {string} [description] - description property
+ * @property {string} [group] - group property
+ * @property {ParameterCategory} [category] - category property
+ */
+
+/**
+ * Configuration for select parameters
+ * @typedef {Object} SelectConfig
+ * @property {string[] | number[]} options - options property
+ * @property {string} label - label property
+ * @property {string} [description] - description property
+ * @property {string} [group] - group property
+ * @property {ParameterCategory} [category] - category property
+ */
+
+/**
+ * Configuration for text parameters
+ * @typedef {Object} TextConfig
+ * @property {string} label - label property
+ * @property {string} [description] - description property
+ * @property {string} [group] - group property
+ * @property {ParameterCategory} [category] - category property
+ * @property {number} [maxLength] - maxLength property
+ */
+
+/**
+ * Configuration for number parameters
+ * @typedef {Object} NumberConfig
+ * @property {number} [min] - min property
+ * @property {number} [max] - max property
+ * @property {number} [step] - step property
+ * @property {string} label - label property
+ * @property {string} [description] - description property
+ * @property {string} [group] - group property
+ * @property {ParameterCategory} [category] - category property
+ */
+
+/**
+ * Configuration for image parameters
+ * @typedef {Object} ImageConfig
+ * @property {string} label - label property
+ * @property {string} [description] - description property
+ * @property {string} [group] - group property
+ * @property {ParameterCategory} [category] - category property
+ */
+
+/**
+ * Configuration for button parameters
+ * @typedef {Object} ButtonConfig
+ * @property {string} label - label property
+ * @property {string} [description] - description property
+ * @property {string} [group] - group property
+ * @property {ParameterCategory} [category] - category property
+ */
+
+/**
+ * Parameter object for slider parameters
+ * @typedef {Object} SliderParameter
+ * @property {number} value - value property
+ * @property {number} min - min property
+ * @property {number} max - max property
+ * @property {number} step - step property
+ * @property {string} label - label property
+ * @property {string} [description] - description property
+ * @property {string} group - group property
+ * @property {ParameterCategory} category - category property
+ */
+
+/**
+ * Parameter object for color parameters
+ * @typedef {Object} ColorParameter
+ * @property {string} value - value property
+ * @property {string} label - label property
+ * @property {string} [description] - description property
+ * @property {string} group - group property
+ * @property {ParameterCategory} category - category property
  */
 
 /**
- * Artist render function - called every frame
- * @param {VijiAPI} viji - The viji API object with all capabilities
+ * Parameter object for toggle parameters
+ * @typedef {Object} ToggleParameter
+ * @property {boolean} value - value property
+ * @property {string} label - label property
+ * @property {string} [description] - description property
+ * @property {string} group - group property
+ * @property {ParameterCategory} category - category property
  */
-declare function render(viji): void;
 
 /**
- * Artist setup function - called once at initialization
- * @param {VijiAPI} viji - The viji API object with all capabilities
+ * Parameter object for select parameters
+ * @typedef {Object} SelectParameter
+ * @property {string | number} value - value property
+ * @property {string[] | number[]} options - options property
+ * @property {string} label - label property
+ * @property {string} [description] - description property
+ * @property {string} group - group property
+ * @property {ParameterCategory} category - category property
  */
-declare function setup(viji): void;
+
+/**
+ * Parameter object for text parameters
+ * @typedef {Object} TextParameter
+ * @property {string} value - value property
+ * @property {number} [maxLength] - maxLength property
+ * @property {string} label - label property
+ * @property {string} [description] - description property
+ * @property {string} group - group property
+ * @property {ParameterCategory} category - category property
+ */
+
+/**
+ * Parameter object for number parameters
+ * @typedef {Object} NumberParameter
+ * @property {number} value - value property
+ * @property {number} min - min property
+ * @property {number} max - max property
+ * @property {number} step - step property
+ * @property {string} label - label property
+ * @property {string} [description] - description property
+ * @property {string} group - group property
+ * @property {ParameterCategory} category - category property
+ */
+
+/**
+ * Parameter object for image parameters
+ * @typedef {Object} ImageParameter
+ * @property {ImageBitmap |null} value - value property
+ * @property {string} label - label property
+ * @property {string} [description] - description property
+ * @property {string} group - group property
+ * @property {ParameterCategory} category - category property
+ */
+
+/**
+ * Parameter object for button parameters
+ * @typedef {Object} ButtonParameter
+ * @property {boolean} value - value property
+ * @property {string} label - label property
+ * @property {string} [description] - description property
+ * @property {string} group - group property
+ * @property {ParameterCategory} category - category property
+ */
+
+/**
+ * Audio analysis API - provides real-time audio data and frequency analysis
+ * @typedef {Object} AudioAPI
+ * @property {boolean} isConnected - isConnected property
+ * @property {Object} volume - volume property
+ * @property {number} volume.current - current property
+ * @property {number} volume.peak - peak property
+ * @property {number} volume.smoothed - smoothed property
+ */
+
+/**
+ * Video frame API - provides access to video stream and computer vision data
+ * @typedef {Object} VideoAPI
+ * @property {boolean} isConnected - isConnected property
+ * @property {OffscreenCanvas | ImageBitmap |null} currentFrame - currentFrame property
+ * @property {number} frameWidth - frameWidth property
+ * @property {number} frameHeight - frameHeight property
+ * @property {number} frameRate - frameRate property
+ * @property {() => ImageData |null} getFrameData - getFrameData property
+ * @property {FaceData[]} faces - faces property
+ * @property {HandData[]} hands - hands property
+ * @property {PoseData |null} pose - pose property
+ * @property {SegmentationData |null} segmentation - segmentation property
+ * @property {Object} cv - cv property
+ */
+
+/**
+ * Mouse interaction API
+ * @typedef {Object} MouseAPI
+ * @property {number} x - x property
+ * @property {number} y - y property
+ * @property {boolean} isInCanvas - isInCanvas property
+ * @property {boolean} isPressed - isPressed property
+ * @property {boolean} leftButton - leftButton property
+ * @property {boolean} rightButton - rightButton property
+ * @property {boolean} middleButton - middleButton property
+ * @property {number} deltaX - deltaX property
+ * @property {number} deltaY - deltaY property
+ * @property {number} wheelDelta - wheelDelta property
+ * @property {number} wheelX - wheelX property
+ * @property {number} wheelY - wheelY property
+ * @property {boolean} wasPressed - wasPressed property
+ * @property {boolean} wasReleased - wasReleased property
+ * @property {boolean} wasMoved - wasMoved property
+ */
+
+/**
+ * Keyboard interaction API
+ * @typedef {Object} KeyboardAPI
+ * @property {Set<string>} activeKeys - activeKeys property
+ * @property {Set<string>} pressedThisFrame - pressedThisFrame property
+ * @property {Set<string>} releasedThisFrame - releasedThisFrame property
+ * @property {string} lastKeyPressed - lastKeyPressed property
+ * @property {string} lastKeyReleased - lastKeyReleased property
+ * @property {boolean} shift - shift property
+ * @property {boolean} ctrl - ctrl property
+ * @property {boolean} alt - alt property
+ * @property {boolean} meta - meta property
+ * @property {Uint8Array} textureData - textureData property
+ */
+
+/**
+ * Touch interaction API
+ * @typedef {Object} TouchAPI
+ * @property {TouchPoint[]} points - points property
+ * @property {number} count - count property
+ * @property {TouchPoint[]} started - started property
+ * @property {TouchPoint[]} moved - moved property
+ * @property {TouchPoint[]} ended - ended property
+ * @property {TouchPoint |null} primary - primary property
+ */
+
+/**
+ * Main Viji Artist API - provides access to canvas, timing, audio, video, and interactions
+ * @typedef {Object} VijiAPI
+ * @property {OffscreenCanvas} canvas - canvas property
+ * @property {OffscreenCanvasRenderingContext2D} [ctx] - ctx property
+ * @property {WebGLRenderingContext | WebGL2RenderingContext} [gl] - gl property
+ * @property {number} width - width property
+ * @property {number} height - height property
+ * @property {number} time - time property
+ * @property {number} deltaTime - deltaTime property
+ * @property {number} frameCount - frameCount property
+ * @property {number} fps - fps property
+ * @property {AudioAPI} audio - audio property
+ * @property {VideoAPI} video - video property
+ * @property {VideoAPI[]} streams - streams property
+ * @property {MouseAPI} mouse - mouse property
+ * @property {KeyboardAPI} keyboard - keyboard property
+ * @property {TouchAPI} touches - touches property
+ * @property {PointerAPI} pointer - pointer property
+ * @property {DeviceSensorState} device - device property
+ * @property {DeviceState[]} devices - devices property
+ * @property {(defaultValue: number, config: SliderConfig) => SliderParameter} slider - slider property
+ * @property {(defaultValue: string, config: ColorConfig) => ColorParameter} color - color property
+ * @property {(defaultValue: boolean, config: ToggleConfig) => ToggleParameter} toggle - toggle property
+ * @property {(defaultValue: string | number, config: SelectConfig) => SelectParameter} select - select property
+ * @property {(defaultValue: string, config: TextConfig) => TextParameter} text - text property
+ * @property {(defaultValue: number, config: NumberConfig) => NumberParameter} number - number property
+ * @property {(defaultValue: null, config: ImageConfig) => ImageParameter} image - image property
+ * @property {(config: ButtonConfig) => ButtonParameter} button - button property
+ */
+
+/**
+ * FaceData interface
+ * @typedef {Object} FaceData
+ * @property {number} id - id property
+ * @property {Object} bounds - bounds property
+ * @property {number} bounds.x - x property
+ * @property {number} bounds.y - y property
+ * @property {number} bounds.width - width property
+ * @property {number} bounds.height - height property
+ */
+
+/**
+ * FaceBlendshapes interface
+ * @typedef {Object} FaceBlendshapes
+ * @property {number} browDownLeft - browDownLeft property
+ * @property {number} browDownRight - browDownRight property
+ * @property {number} browInnerUp - browInnerUp property
+ * @property {number} browOuterUpLeft - browOuterUpLeft property
+ * @property {number} browOuterUpRight - browOuterUpRight property
+ * @property {number} cheekPuff - cheekPuff property
+ * @property {number} cheekSquintLeft - cheekSquintLeft property
+ * @property {number} cheekSquintRight - cheekSquintRight property
+ * @property {number} eyeBlinkLeft - eyeBlinkLeft property
+ * @property {number} eyeBlinkRight - eyeBlinkRight property
+ * @property {number} eyeLookDownLeft - eyeLookDownLeft property
+ * @property {number} eyeLookDownRight - eyeLookDownRight property
+ * @property {number} eyeLookInLeft - eyeLookInLeft property
+ * @property {number} eyeLookInRight - eyeLookInRight property
+ * @property {number} eyeLookOutLeft - eyeLookOutLeft property
+ * @property {number} eyeLookOutRight - eyeLookOutRight property
+ * @property {number} eyeLookUpLeft - eyeLookUpLeft property
+ * @property {number} eyeLookUpRight - eyeLookUpRight property
+ * @property {number} eyeSquintLeft - eyeSquintLeft property
+ * @property {number} eyeSquintRight - eyeSquintRight property
+ * @property {number} eyeWideLeft - eyeWideLeft property
+ * @property {number} eyeWideRight - eyeWideRight property
+ * @property {number} jawForward - jawForward property
+ * @property {number} jawLeft - jawLeft property
+ * @property {number} jawOpen - jawOpen property
+ * @property {number} jawRight - jawRight property
+ * @property {number} mouthClose - mouthClose property
+ * @property {number} mouthDimpleLeft - mouthDimpleLeft property
+ * @property {number} mouthDimpleRight - mouthDimpleRight property
+ * @property {number} mouthFrownLeft - mouthFrownLeft property
+ * @property {number} mouthFrownRight - mouthFrownRight property
+ * @property {number} mouthFunnel - mouthFunnel property
+ * @property {number} mouthLeft - mouthLeft property
+ * @property {number} mouthLowerDownLeft - mouthLowerDownLeft property
+ * @property {number} mouthLowerDownRight - mouthLowerDownRight property
+ * @property {number} mouthPressLeft - mouthPressLeft property
+ * @property {number} mouthPressRight - mouthPressRight property
+ * @property {number} mouthPucker - mouthPucker property
+ * @property {number} mouthRight - mouthRight property
+ * @property {number} mouthRollLower - mouthRollLower property
+ * @property {number} mouthRollUpper - mouthRollUpper property
+ * @property {number} mouthShrugLower - mouthShrugLower property
+ * @property {number} mouthShrugUpper - mouthShrugUpper property
+ * @property {number} mouthSmileLeft - mouthSmileLeft property
+ * @property {number} mouthSmileRight - mouthSmileRight property
+ * @property {number} mouthStretchLeft - mouthStretchLeft property
+ * @property {number} mouthStretchRight - mouthStretchRight property
+ * @property {number} mouthUpperUpLeft - mouthUpperUpLeft property
+ * @property {number} mouthUpperUpRight - mouthUpperUpRight property
+ * @property {number} noseSneerLeft - noseSneerLeft property
+ * @property {number} noseSneerRight - noseSneerRight property
+ * @property {number} tongueOut - tongueOut property
+ */
+
+/**
+ * HandData interface
+ * @typedef {Object} HandData
+ * @property {number} id - id property
+ * @property {'left' | 'right'} handedness - handedness property
+ * @property {number} confidence - confidence property
+ * @property {Object} bounds - bounds property
+ * @property {number} bounds.x - x property
+ * @property {number} bounds.y - y property
+ * @property {number} bounds.width - width property
+ * @property {number} bounds.height - height property
+ */
+
+/**
+ * PoseData interface
+ * @typedef {Object} PoseData
+ * @property {number} confidence - confidence property
+ * @property {Object} landmarks - landmarks property
+ * @property {number} landmarks.x - x property
+ * @property {number} landmarks.y - y property
+ * @property {number} landmarks.z - z property
+ * @property {number} landmarks.visibility - visibility property
+ */
+
+/**
+ * SegmentationData interface
+ * @typedef {Object} SegmentationData
+ * @property {Uint8Array} mask - mask property
+ * @property {number} width - width property
+ * @property {number} height - height property
+ */
+
+/**
+ * DeviceMotionData interface
+ * @typedef {Object} DeviceMotionData
+ * @property {Object} acceleration - Acceleration without gravity (m/s²)
+ * @property {number |null} acceleration.x - x property
+ * @property {number |null} acceleration.y - y property
+ * @property {number |null} acceleration.z - z property
+ */
+
+/**
+ * DeviceOrientationData interface
+ * @typedef {Object} DeviceOrientationData
+ * @property {number |null} alpha - Rotation around Z-axis (0-360 degrees, compass heading)
+ * @property {number |null} beta - Rotation around X-axis (-180 to 180 degrees, front-to-back tilt)
+ * @property {number |null} gamma - Rotation around Y-axis (-90 to 90 degrees, left-to-right tilt)
+ * @property {boolean} absolute - True if using magnetometer (compass) for absolute orientation
+ */
+
+/**
+ * DeviceSensorState interface
+ * @typedef {Object} DeviceSensorState
+ * @property {DeviceMotionData |null} motion - motion property
+ * @property {DeviceOrientationData |null} orientation - orientation property
+ */
+
+/**
+ * DeviceState interface
+ * @typedef {Object} DeviceState
+ * @property {string} id - Unique device identifier
+ * @property {string} name - User-friendly device name
+ * @property {VideoAPI |null} video - Device camera video (null if not available)
+ */
+
+/**
+ * @typedef {function(VijiAPI): void} Render
+ */
+
+/**
+ * @typedef {function(VijiAPI): void} Setup
+ */
+
+/** Global viji object available in artist code */
+declare const viji: VijiAPI;
+
+/** Artist render function - called every frame */
+declare function render(viji: VijiAPI): void;
+
+/** Artist setup function - called once at initialization */
+declare function setup(viji: VijiAPI): void;