@hapticjs/core 0.1.0

package/dist/presets/index.d.ts

@@ -0,0 +1,950 @@
+/** UI interaction presets */
+declare const ui: {
+    /** Light button tap */
+    tap: {
+        name: string;
+        steps: {
+            type: "vibrate";
+            duration: number;
+            intensity: number;
+        }[];
+    };
+    /** Double tap */
+    doubleTap: {
+        name: string;
+        steps: ({
+            type: "vibrate";
+            duration: number;
+            intensity: number;
+        } | {
+            type: "pause";
+            duration: number;
+            intensity: number;
+        })[];
+    };
+    /** Long press acknowledgment */
+    longPress: {
+        name: string;
+        steps: {
+            type: "vibrate";
+            duration: number;
+            intensity: number;
+        }[];
+    };
+    /** Toggle switch on */
+    toggleOn: {
+        name: string;
+        steps: {
+            type: "vibrate";
+            duration: number;
+            intensity: number;
+        }[];
+    };
+    /** Toggle switch off */
+    toggleOff: {
+        name: string;
+        steps: {
+            type: "vibrate";
+            duration: number;
+            intensity: number;
+        }[];
+    };
+    /** Slider snap to value */
+    sliderSnap: {
+        name: string;
+        steps: {
+            type: "vibrate";
+            duration: number;
+            intensity: number;
+        }[];
+    };
+    /** Selection changed */
+    selection: {
+        name: string;
+        steps: {
+            type: "vibrate";
+            duration: number;
+            intensity: number;
+        }[];
+    };
+    /** Pull to refresh threshold reached */
+    pullToRefresh: {
+        name: string;
+        steps: ({
+            type: "vibrate";
+            duration: number;
+            intensity: number;
+        } | {
+            type: "pause";
+            duration: number;
+            intensity: number;
+        })[];
+    };
+    /** Swipe action triggered */
+    swipe: {
+        name: string;
+        steps: ({
+            type: "vibrate";
+            duration: number;
+            intensity: number;
+        } | {
+            type: "pause";
+            duration: number;
+            intensity: number;
+        })[];
+    };
+    /** Context menu appearance */
+    contextMenu: {
+        name: string;
+        steps: {
+            type: "vibrate";
+            duration: number;
+            intensity: number;
+        }[];
+    };
+    /** Drag start */
+    dragStart: {
+        name: string;
+        steps: {
+            type: "vibrate";
+            duration: number;
+            intensity: number;
+        }[];
+    };
+    /** Drag drop */
+    drop: {
+        name: string;
+        steps: ({
+            type: "vibrate";
+            duration: number;
+            intensity: number;
+        } | {
+            type: "pause";
+            duration: number;
+            intensity: number;
+        })[];
+    };
+};
+
+/** Notification feedback presets */
+declare const notifications: {
+    /** Success — two ascending pulses */
+    success: {
+        name: string;
+        steps: ({
+            type: "vibrate";
+            duration: number;
+            intensity: number;
+        } | {
+            type: "pause";
+            duration: number;
+            intensity: number;
+        })[];
+    };
+    /** Warning — three even pulses */
+    warning: {
+        name: string;
+        steps: ({
+            type: "vibrate";
+            duration: number;
+            intensity: number;
+        } | {
+            type: "pause";
+            duration: number;
+            intensity: number;
+        })[];
+    };
+    /** Error — two heavy pulses */
+    error: {
+        name: string;
+        steps: ({
+            type: "vibrate";
+            duration: number;
+            intensity: number;
+        } | {
+            type: "pause";
+            duration: number;
+            intensity: number;
+        })[];
+    };
+    /** Info — soft single pulse */
+    info: {
+        name: string;
+        steps: {
+            type: "vibrate";
+            duration: number;
+            intensity: number;
+        }[];
+    };
+    /** Message received */
+    messageReceived: {
+        name: string;
+        steps: ({
+            type: "vibrate";
+            duration: number;
+            intensity: number;
+        } | {
+            type: "pause";
+            duration: number;
+            intensity: number;
+        })[];
+    };
+    /** Alarm — urgent repeating pattern */
+    alarm: {
+        name: string;
+        steps: ({
+            type: "vibrate";
+            duration: number;
+            intensity: number;
+        } | {
+            type: "pause";
+            duration: number;
+            intensity: number;
+        })[];
+    };
+    /** Reminder — gentle nudge */
+    reminder: {
+        name: string;
+        steps: ({
+            type: "vibrate";
+            duration: number;
+            intensity: number;
+        } | {
+            type: "pause";
+            duration: number;
+            intensity: number;
+        })[];
+    };
+};
+
+/** Gaming haptic presets */
+declare const gaming: {
+    /** Explosion — heavy descending */
+    explosion: {
+        name: string;
+        steps: {
+            type: "vibrate";
+            duration: number;
+            intensity: number;
+        }[];
+    };
+    /** Collision — sharp impact */
+    collision: {
+        name: string;
+        steps: ({
+            type: "vibrate";
+            duration: number;
+            intensity: number;
+        } | {
+            type: "pause";
+            duration: number;
+            intensity: number;
+        })[];
+    };
+    /** Heartbeat — rhythmic pulse */
+    heartbeat: {
+        name: string;
+        steps: ({
+            type: "vibrate";
+            duration: number;
+            intensity: number;
+        } | {
+            type: "pause";
+            duration: number;
+            intensity: number;
+        })[];
+    };
+    /** Gunshot — sharp burst */
+    gunshot: {
+        name: string;
+        steps: {
+            type: "vibrate";
+            duration: number;
+            intensity: number;
+        }[];
+    };
+    /** Sword clash — metallic ring */
+    swordClash: {
+        name: string;
+        steps: ({
+            type: "vibrate";
+            duration: number;
+            intensity: number;
+        } | {
+            type: "pause";
+            duration: number;
+            intensity: number;
+        })[];
+    };
+    /** Power up — ascending intensity */
+    powerUp: {
+        name: string;
+        steps: {
+            type: "vibrate";
+            duration: number;
+            intensity: number;
+        }[];
+    };
+    /** Damage taken — heavy stutter */
+    damage: {
+        name: string;
+        steps: ({
+            type: "vibrate";
+            duration: number;
+            intensity: number;
+        } | {
+            type: "pause";
+            duration: number;
+            intensity: number;
+        })[];
+    };
+    /** Item pickup — light cheerful */
+    pickup: {
+        name: string;
+        steps: ({
+            type: "vibrate";
+            duration: number;
+            intensity: number;
+        } | {
+            type: "pause";
+            duration: number;
+            intensity: number;
+        })[];
+    };
+    /** Level complete — celebratory */
+    levelComplete: {
+        name: string;
+        steps: ({
+            type: "vibrate";
+            duration: number;
+            intensity: number;
+        } | {
+            type: "pause";
+            duration: number;
+            intensity: number;
+        })[];
+    };
+    /** Engine rumble — continuous vibration */
+    engineRumble: {
+        name: string;
+        steps: ({
+            type: "vibrate";
+            duration: number;
+            intensity: number;
+        } | {
+            type: "pause";
+            duration: number;
+            intensity: number;
+        })[];
+    };
+};
+
+/** Accessibility-focused haptic presets — rhythmic patterns for non-visual feedback */
+declare const accessibility: {
+    /** Confirm action — clear double pulse */
+    confirm: {
+        name: string;
+        steps: ({
+            type: "vibrate";
+            duration: number;
+            intensity: number;
+        } | {
+            type: "pause";
+            duration: number;
+            intensity: number;
+        })[];
+    };
+    /** Deny/reject — long single buzz */
+    deny: {
+        name: string;
+        steps: {
+            type: "vibrate";
+            duration: number;
+            intensity: number;
+        }[];
+    };
+    /** Boundary reached (e.g., scroll limit, min/max value) */
+    boundary: {
+        name: string;
+        steps: {
+            type: "vibrate";
+            duration: number;
+            intensity: number;
+        }[];
+    };
+    /** Focus change — subtle tick */
+    focusChange: {
+        name: string;
+        steps: {
+            type: "vibrate";
+            duration: number;
+            intensity: number;
+        }[];
+    };
+    /** Counting rhythm — one tick per count */
+    countTick: {
+        name: string;
+        steps: {
+            type: "vibrate";
+            duration: number;
+            intensity: number;
+        }[];
+    };
+    /** Navigation landmark reached */
+    landmark: {
+        name: string;
+        steps: ({
+            type: "vibrate";
+            duration: number;
+            intensity: number;
+        } | {
+            type: "pause";
+            duration: number;
+            intensity: number;
+        })[];
+    };
+    /** Progress checkpoint — escalating feedback */
+    progressCheckpoint: {
+        name: string;
+        steps: ({
+            type: "vibrate";
+            duration: number;
+            intensity: number;
+        } | {
+            type: "pause";
+            duration: number;
+            intensity: number;
+        })[];
+    };
+};
+
+/** System-level haptic presets */
+declare const system: {
+    /** Keyboard key press */
+    keyPress: {
+        name: string;
+        steps: {
+            type: "vibrate";
+            duration: number;
+            intensity: number;
+        }[];
+    };
+    /** Scroll tick (detent-like) */
+    scrollTick: {
+        name: string;
+        steps: {
+            type: "vibrate";
+            duration: number;
+            intensity: number;
+        }[];
+    };
+    /** Scroll boundary reached */
+    scrollBounce: {
+        name: string;
+        steps: {
+            type: "vibrate";
+            duration: number;
+            intensity: number;
+        }[];
+    };
+    /** Delete action */
+    delete: {
+        name: string;
+        steps: ({
+            type: "vibrate";
+            duration: number;
+            intensity: number;
+        } | {
+            type: "pause";
+            duration: number;
+            intensity: number;
+        })[];
+    };
+    /** Undo action */
+    undo: {
+        name: string;
+        steps: ({
+            type: "vibrate";
+            duration: number;
+            intensity: number;
+        } | {
+            type: "pause";
+            duration: number;
+            intensity: number;
+        })[];
+    };
+    /** Copy to clipboard */
+    copy: {
+        name: string;
+        steps: {
+            type: "vibrate";
+            duration: number;
+            intensity: number;
+        }[];
+    };
+    /** Paste from clipboard */
+    paste: {
+        name: string;
+        steps: ({
+            type: "vibrate";
+            duration: number;
+            intensity: number;
+        } | {
+            type: "pause";
+            duration: number;
+            intensity: number;
+        })[];
+    };
+};
+
+/** All presets grouped by category */
+declare const presets: {
+    readonly ui: {
+        tap: {
+            name: string;
+            steps: {
+                type: "vibrate";
+                duration: number;
+                intensity: number;
+            }[];
+        };
+        doubleTap: {
+            name: string;
+            steps: ({
+                type: "vibrate";
+                duration: number;
+                intensity: number;
+            } | {
+                type: "pause";
+                duration: number;
+                intensity: number;
+            })[];
+        };
+        longPress: {
+            name: string;
+            steps: {
+                type: "vibrate";
+                duration: number;
+                intensity: number;
+            }[];
+        };
+        toggleOn: {
+            name: string;
+            steps: {
+                type: "vibrate";
+                duration: number;
+                intensity: number;
+            }[];
+        };
+        toggleOff: {
+            name: string;
+            steps: {
+                type: "vibrate";
+                duration: number;
+                intensity: number;
+            }[];
+        };
+        sliderSnap: {
+            name: string;
+            steps: {
+                type: "vibrate";
+                duration: number;
+                intensity: number;
+            }[];
+        };
+        selection: {
+            name: string;
+            steps: {
+                type: "vibrate";
+                duration: number;
+                intensity: number;
+            }[];
+        };
+        pullToRefresh: {
+            name: string;
+            steps: ({
+                type: "vibrate";
+                duration: number;
+                intensity: number;
+            } | {
+                type: "pause";
+                duration: number;
+                intensity: number;
+            })[];
+        };
+        swipe: {
+            name: string;
+            steps: ({
+                type: "vibrate";
+                duration: number;
+                intensity: number;
+            } | {
+                type: "pause";
+                duration: number;
+                intensity: number;
+            })[];
+        };
+        contextMenu: {
+            name: string;
+            steps: {
+                type: "vibrate";
+                duration: number;
+                intensity: number;
+            }[];
+        };
+        dragStart: {
+            name: string;
+            steps: {
+                type: "vibrate";
+                duration: number;
+                intensity: number;
+            }[];
+        };
+        drop: {
+            name: string;
+            steps: ({
+                type: "vibrate";
+                duration: number;
+                intensity: number;
+            } | {
+                type: "pause";
+                duration: number;
+                intensity: number;
+            })[];
+        };
+    };
+    readonly notifications: {
+        success: {
+            name: string;
+            steps: ({
+                type: "vibrate";
+                duration: number;
+                intensity: number;
+            } | {
+                type: "pause";
+                duration: number;
+                intensity: number;
+            })[];
+        };
+        warning: {
+            name: string;
+            steps: ({
+                type: "vibrate";
+                duration: number;
+                intensity: number;
+            } | {
+                type: "pause";
+                duration: number;
+                intensity: number;
+            })[];
+        };
+        error: {
+            name: string;
+            steps: ({
+                type: "vibrate";
+                duration: number;
+                intensity: number;
+            } | {
+                type: "pause";
+                duration: number;
+                intensity: number;
+            })[];
+        };
+        info: {
+            name: string;
+            steps: {
+                type: "vibrate";
+                duration: number;
+                intensity: number;
+            }[];
+        };
+        messageReceived: {
+            name: string;
+            steps: ({
+                type: "vibrate";
+                duration: number;
+                intensity: number;
+            } | {
+                type: "pause";
+                duration: number;
+                intensity: number;
+            })[];
+        };
+        alarm: {
+            name: string;
+            steps: ({
+                type: "vibrate";
+                duration: number;
+                intensity: number;
+            } | {
+                type: "pause";
+                duration: number;
+                intensity: number;
+            })[];
+        };
+        reminder: {
+            name: string;
+            steps: ({
+                type: "vibrate";
+                duration: number;
+                intensity: number;
+            } | {
+                type: "pause";
+                duration: number;
+                intensity: number;
+            })[];
+        };
+    };
+    readonly gaming: {
+        explosion: {
+            name: string;
+            steps: {
+                type: "vibrate";
+                duration: number;
+                intensity: number;
+            }[];
+        };
+        collision: {
+            name: string;
+            steps: ({
+                type: "vibrate";
+                duration: number;
+                intensity: number;
+            } | {
+                type: "pause";
+                duration: number;
+                intensity: number;
+            })[];
+        };
+        heartbeat: {
+            name: string;
+            steps: ({
+                type: "vibrate";
+                duration: number;
+                intensity: number;
+            } | {
+                type: "pause";
+                duration: number;
+                intensity: number;
+            })[];
+        };
+        gunshot: {
+            name: string;
+            steps: {
+                type: "vibrate";
+                duration: number;
+                intensity: number;
+            }[];
+        };
+        swordClash: {
+            name: string;
+            steps: ({
+                type: "vibrate";
+                duration: number;
+                intensity: number;
+            } | {
+                type: "pause";
+                duration: number;
+                intensity: number;
+            })[];
+        };
+        powerUp: {
+            name: string;
+            steps: {
+                type: "vibrate";
+                duration: number;
+                intensity: number;
+            }[];
+        };
+        damage: {
+            name: string;
+            steps: ({
+                type: "vibrate";
+                duration: number;
+                intensity: number;
+            } | {
+                type: "pause";
+                duration: number;
+                intensity: number;
+            })[];
+        };
+        pickup: {
+            name: string;
+            steps: ({
+                type: "vibrate";
+                duration: number;
+                intensity: number;
+            } | {
+                type: "pause";
+                duration: number;
+                intensity: number;
+            })[];
+        };
+        levelComplete: {
+            name: string;
+            steps: ({
+                type: "vibrate";
+                duration: number;
+                intensity: number;
+            } | {
+                type: "pause";
+                duration: number;
+                intensity: number;
+            })[];
+        };
+        engineRumble: {
+            name: string;
+            steps: ({
+                type: "vibrate";
+                duration: number;
+                intensity: number;
+            } | {
+                type: "pause";
+                duration: number;
+                intensity: number;
+            })[];
+        };
+    };
+    readonly accessibility: {
+        confirm: {
+            name: string;
+            steps: ({
+                type: "vibrate";
+                duration: number;
+                intensity: number;
+            } | {
+                type: "pause";
+                duration: number;
+                intensity: number;
+            })[];
+        };
+        deny: {
+            name: string;
+            steps: {
+                type: "vibrate";
+                duration: number;
+                intensity: number;
+            }[];
+        };
+        boundary: {
+            name: string;
+            steps: {
+                type: "vibrate";
+                duration: number;
+                intensity: number;
+            }[];
+        };
+        focusChange: {
+            name: string;
+            steps: {
+                type: "vibrate";
+                duration: number;
+                intensity: number;
+            }[];
+        };
+        countTick: {
+            name: string;
+            steps: {
+                type: "vibrate";
+                duration: number;
+                intensity: number;
+            }[];
+        };
+        landmark: {
+            name: string;
+            steps: ({
+                type: "vibrate";
+                duration: number;
+                intensity: number;
+            } | {
+                type: "pause";
+                duration: number;
+                intensity: number;
+            })[];
+        };
+        progressCheckpoint: {
+            name: string;
+            steps: ({
+                type: "vibrate";
+                duration: number;
+                intensity: number;
+            } | {
+                type: "pause";
+                duration: number;
+                intensity: number;
+            })[];
+        };
+    };
+    readonly system: {
+        keyPress: {
+            name: string;
+            steps: {
+                type: "vibrate";
+                duration: number;
+                intensity: number;
+            }[];
+        };
+        scrollTick: {
+            name: string;
+            steps: {
+                type: "vibrate";
+                duration: number;
+                intensity: number;
+            }[];
+        };
+        scrollBounce: {
+            name: string;
+            steps: {
+                type: "vibrate";
+                duration: number;
+                intensity: number;
+            }[];
+        };
+        delete: {
+            name: string;
+            steps: ({
+                type: "vibrate";
+                duration: number;
+                intensity: number;
+            } | {
+                type: "pause";
+                duration: number;
+                intensity: number;
+            })[];
+        };
+        undo: {
+            name: string;
+            steps: ({
+                type: "vibrate";
+                duration: number;
+                intensity: number;
+            } | {
+                type: "pause";
+                duration: number;
+                intensity: number;
+            })[];
+        };
+        copy: {
+            name: string;
+            steps: {
+                type: "vibrate";
+                duration: number;
+                intensity: number;
+            }[];
+        };
+        paste: {
+            name: string;
+            steps: ({
+                type: "vibrate";
+                duration: number;
+                intensity: number;
+            } | {
+                type: "pause";
+                duration: number;
+                intensity: number;
+            })[];
+        };
+    };
+};
+
+export { accessibility, gaming, notifications, presets, system, ui };