@uxpilot/openai-astra-shape-cue 1.0.0

package/dist/index.d.ts

@@ -0,0 +1,92 @@
+export type BuiltinShape = "star" | "heart" | "infinity" | "hexagon" | "spiral";
+import type { EngineConfig, EngineSettingValues } from './settings.js';
+export type { EngineConfig, EngineSettingValues } from './settings.js';
+export interface ScrollOptions {
+  /** Entry progress interval over which particles gather; default [0, .36]. */
+  gather?: [number, number];
+  /** Exit interval over which they disperse; default [.5, .86]. */
+  disperse?: [number, number];
+}
+export interface ParticleOptions {
+  density?: number;
+  size?: number;
+  intensity?: number;
+  scatter?: number;
+  twinkle?: number;
+}
+export interface AnimationOptions {
+  /** Particle travel multiplier, 0–3. */
+  speed?: number;
+  /** Approximate gather settling duration in seconds, 1–10. */
+  duration?: number;
+  /** Pause/resume particle flow; pointer interactions remain available. */
+  playing?: boolean;
+}
+export type Shape = BuiltinShape | string | { id?: string; label?: string; width: number; height: number; paths: string[]; strokeWidth?: number };
+export interface CueOptions {
+  shape?: Shape;
+  transform?: "scroll" | "load" | "off";
+  interaction?: "rotate" | "depth-lens" | "none";
+  autoRotate?: boolean;
+  ambient?: boolean;
+  parallax?: boolean;
+  holdAtEnd?: boolean;
+  palette?: "astra" | "aurora" | "ember";
+  background?: string;
+  padding?: number;
+  tier?: 0 | 1 | 2 | 3;
+  interactionLabel?: string;
+  /** 1–8 hex colors. null restores the named palette (Astra by default). */
+  colors?: string[] | null;
+  particles?: ParticleOptions;
+  animation?: AnimationOptions;
+  bloom?: number;
+  scroll?: ScrollOptions;
+  config?: EngineConfig;
+}
+export interface Cue {
+  readonly host: HTMLElement;
+  readonly status: "loading" | "ready" | "error";
+  setShape(shape: Shape): this;
+  /** Local SVG load with 2 MB limit and last-upload-wins semantics. */
+  loadSVG(source: File | Blob | string): Promise<this>;
+  getOptions(): CueOptions;
+  onChange(listener: (options: CueOptions) => void): () => void;
+  /** 0 = entering viewport; 1 = exited; null = follow window scroll again. */
+  setScrollProgress(progress: number | null): this;
+  /** Apply a partial update. Omitted settings retain their current value. */
+  update(options: CueOptions): this;
+  setColors(colors: string[] | null): this;
+  pause(): this;
+  play(): this;
+  setTransform(mode: "scroll" | "load" | "off"): this;
+  setPalette(palette: "astra" | "aurora" | "ember"): this;
+  setBackground(color: string): this;
+  setAmbient(enabled: boolean): this;
+  set<K extends keyof EngineSettingValues>(path: K, value: EngineSettingValues[K]): this;
+  rotate(dx: number, dy: number): this;
+  replay(): this;
+  rebuild(): this;
+  invalidate(): void;
+  dispose(): void;
+}
+/** Register <astra-shape-cue>. Call only in a browser. */
+export function registerShapeCue(): void;
+/** Create a cue on an empty, dedicated element with explicit dimensions. */
+export function createShapeCue(host: HTMLElement, options?: CueOptions): Cue;
+/** Mount the optional settings panel. Load @uxpilot/openai-astra-shape-cue/panel.css. */
+export function mountControls(cue: Cue, host: HTMLElement): () => void;
+export interface ControlDefinition {
+  key: string;
+  label: string;
+  kind: 'range' | 'checkbox' | 'select';
+  optionPath: string;
+  defaultValue: unknown;
+  min?: number;
+  max?: number;
+  step?: number;
+  choices?: string[];
+}
+/** One definition for each engine setting displayed in the stock panel. */
+export function getControlDefinitions(): ControlDefinition[];
+export const version: string;