@zakkster/lite-ui-fx 1.4.0 → 1.6.0

package/UIFXRecipes.d.ts

@@ -1,7 +1,7 @@
 import type { UIFXRecipe, UIFXInstance, MountOptions } from './UIFXController';
 
 // ===========================================================
-//  RECIPE OPTIONS + FACTORIES (all 50)
+//  RECIPE OPTIONS + FACTORIES (all 56)
 // ===========================================================
 
 /**
@@ -72,6 +72,9 @@ export declare function HelixLoader(options?: RecipeOptions): UIFXRecipe;
 // -- Vol.2: Checkboxes --
 export declare function RippleCheck(options?: RecipeOptions): UIFXRecipe;
 export declare function MorphCheck(options?: RecipeOptions): UIFXRecipe;
+// -- U4a: CHECKBOX recipes (honour st.indeterminate) --
+export declare function TickDraw(options?: RecipeOptions): UIFXRecipe;
+export declare function IndeterminateScan(options?: RecipeOptions): UIFXRecipe;
 
 // -- Vol.2: Counters --
 export declare function FlameCounter(options?: RecipeOptions): UIFXRecipe;
@@ -88,6 +91,8 @@ export declare function CompassKnob(options?: RecipeOptions): UIFXRecipe;
 export declare function RingProgress(options?: RecipeOptions): UIFXRecipe;
 export declare function BatteryGauge(options?: RecipeOptions): UIFXRecipe;
 export declare function SignalMeter(options?: RecipeOptions): UIFXRecipe;
+// -- U4a: PROGRESS recipe --
+export declare function LiquidFill(options?: RecipeOptions): UIFXRecipe;
 
 // -- Vol.3: Controls --
 export declare function PillTabs(options?: RecipeOptions): UIFXRecipe;
@@ -114,6 +119,13 @@ export declare function ScratchReveal(options?: RecipeOptions): UIFXRecipe;
 export declare function TimerCountdown(options?: RecipeOptions): UIFXRecipe;
 export declare function PullRefresh(options?: RecipeOptions): UIFXRecipe;
 
+// -- U4b: DECORATE recipes (mounted AROUND a live element via decorateUIFX).
+//    Generic form feedback; PasswordStrength + TypewriterField (above) re-home
+//    onto decorate mode too. See decisions/0004. --
+export declare function FocusHalo(options?: RecipeOptions): UIFXRecipe;
+export declare function ErrorShake(options?: RecipeOptions): UIFXRecipe;
+export declare function SuccessBloom(options?: RecipeOptions): UIFXRecipe;
+
 // ===========================================================
 //  BARREL OBJECTS (back-compat)
 // ===========================================================
@@ -177,11 +189,28 @@ export declare const UIFXRecipes3: {
     PullRefresh: typeof PullRefresh;
 };
 
+/** U4a additions -- new native element types (kept out of the Vol.1-3 snapshots). */
+export declare const UIFXRecipes4: {
+    TickDraw: typeof TickDraw;
+    IndeterminateScan: typeof IndeterminateScan;
+    LiquidFill: typeof LiquidFill;
+};
+
+/** U4b additions -- decorate-mode recipes (kept out of the Vol.1-3 + Vol.4 snapshots). */
+export declare const UIFXRecipes5: {
+    FocusHalo: typeof FocusHalo;
+    ErrorShake: typeof ErrorShake;
+    SuccessBloom: typeof SuccessBloom;
+};
+
 // ===========================================================
 //  RECIPE REGISTRY
 // ===========================================================
 
-export type RecipeType = 'toggle' | 'button' | 'slider';
+// 'decorate' is not a UIType (it creates no native element); it is the registry
+// routing tag for a recipe mounted AROUND a live element via decorateUIFX. See
+// decisions/0004.
+export type RecipeType = 'toggle' | 'button' | 'slider' | 'checkbox' | 'progress' | 'knob' | 'decorate';
 
 export type RecipeFactory = (options?: Record<string, unknown>) => UIFXRecipe;
 
@@ -211,7 +240,10 @@ export declare function registerRecipe(
 ): RecipeFactory;
 
 /**
- * Resolve a recipe id to its factory + declared type and mount it via mountUIFX.
+ * Resolve a recipe id to its factory + declared type and mount it. A hijack
+ * recipe mounts via mountUIFX (the native element is created inside `container`);
+ * a recipe whose meta.type is 'decorate' mounts via decorateUIFX, treating
+ * `container` as the LIVE element to decorate (a canvas is placed AROUND it).
  * Fail closed: unknown id or a conflicting options.type throws.
  */
 export declare function mountRecipe(
@@ -221,7 +253,7 @@ export declare function mountRecipe(
 ): UIFXInstance;
 
 // ===========================================================
-//  DEFAULT EXPORT -- combined all-50 namespace
+//  DEFAULT EXPORT -- combined all-56 namespace
 // ===========================================================
 
 declare const UIFXAllRecipes: {
@@ -252,6 +284,8 @@ declare const UIFXAllRecipes: {
     HelixLoader: typeof HelixLoader;
     RippleCheck: typeof RippleCheck;
     MorphCheck: typeof MorphCheck;
+    TickDraw: typeof TickDraw;
+    IndeterminateScan: typeof IndeterminateScan;
     FlameCounter: typeof FlameCounter;
     GlitchCounter: typeof GlitchCounter;
     BubbleRating: typeof BubbleRating;
@@ -260,6 +294,7 @@ declare const UIFXAllRecipes: {
     RingProgress: typeof RingProgress;
     BatteryGauge: typeof BatteryGauge;
     SignalMeter: typeof SignalMeter;
+    LiquidFill: typeof LiquidFill;
     PillTabs: typeof PillTabs;
     Stepper: typeof Stepper;
     RadioOrbit: typeof RadioOrbit;
@@ -275,5 +310,8 @@ declare const UIFXAllRecipes: {
     ScratchReveal: typeof ScratchReveal;
     TimerCountdown: typeof TimerCountdown;
     PullRefresh: typeof PullRefresh;
+    FocusHalo: typeof FocusHalo;
+    ErrorShake: typeof ErrorShake;
+    SuccessBloom: typeof SuccessBloom;
 };
 export default UIFXAllRecipes;