@capawesome/capacitor-haptics 0.0.1

package/dist/esm/definitions.d.ts

@@ -0,0 +1,363 @@
+export interface HapticsPlugin {
+    /**
+     * Trigger an impact haptic feedback.
+     *
+     * Use this to simulate a physical impact, for example when user
+     * interface elements collide or a drag operation snaps into place.
+     *
+     * On Android, the impact style is mapped to a best-effort vibration effect.
+     *
+     * @since 0.1.0
+     */
+    impact(options?: ImpactOptions): Promise<void>;
+    /**
+     * Check if haptic feedback is available on the device.
+     *
+     * On Android, this checks whether the device has a vibrator.
+     * On iOS, this checks whether the device supports haptic event playback.
+     * On the web, this checks whether the Vibration API is supported.
+     *
+     * @since 0.1.0
+     */
+    isAvailable(): Promise<IsAvailableResult>;
+    /**
+     * Trigger a notification haptic feedback.
+     *
+     * Use this to communicate that a task or action has succeeded, failed,
+     * or produced a warning.
+     *
+     * On Android, the notification type is mapped to a best-effort vibration
+     * effect.
+     *
+     * @since 0.1.0
+     */
+    notification(options?: NotificationOptions): Promise<void>;
+    /**
+     * Perform a predefined Android haptic feedback effect.
+     *
+     * In contrast to the other methods, this method does not use the vibrator
+     * but the semantic haptic feedback constants of the Android view system.
+     * This respects the user's haptic feedback settings.
+     *
+     * Only available on Android.
+     *
+     * @since 0.1.0
+     */
+    performAndroidHaptic(options: PerformAndroidHapticOptions): Promise<void>;
+    /**
+     * Play a custom haptic pattern composed of individual haptic events.
+     *
+     * On iOS, the pattern is played using Core Haptics with full support for
+     * intensity and sharpness. This requires a device with haptic event
+     * playback support (for example an iPhone with a Taptic Engine).
+     * Otherwise, the call rejects as unavailable.
+     *
+     * On Android, the pattern is played using vibration effects. Intensity is
+     * only respected on devices with amplitude control.
+     *
+     * On the web, the pattern is approximated using the Vibration API.
+     *
+     * @since 0.1.0
+     */
+    playPattern(options: PlayPatternOptions): Promise<void>;
+    /**
+     * Trigger a selection changed haptic feedback.
+     *
+     * Call this method after `selectionStart()` whenever the selection changes.
+     *
+     * On the web, this method does nothing.
+     *
+     * @since 0.1.0
+     */
+    selectionChanged(): Promise<void>;
+    /**
+     * End a selection session.
+     *
+     * Call this method when the user finishes a selection interaction.
+     *
+     * On the web, this method does nothing.
+     *
+     * @since 0.1.0
+     */
+    selectionEnd(): Promise<void>;
+    /**
+     * Start a selection session.
+     *
+     * Call this method when the user starts a selection interaction, for
+     * example when a picker starts scrolling. It prepares the haptic hardware
+     * to reduce the latency of subsequent `selectionChanged()` calls.
+     *
+     * On the web, this method does nothing.
+     *
+     * @since 0.1.0
+     */
+    selectionStart(): Promise<void>;
+    /**
+     * Vibrate the device.
+     *
+     * @since 0.1.0
+     */
+    vibrate(options?: VibrateOptions): Promise<void>;
+}
+/**
+ * @since 0.1.0
+ */
+export interface HapticEvent {
+    /**
+     * The duration of the event in seconds.
+     *
+     * If omitted, the event is a transient tap.
+     *
+     * @since 0.1.0
+     * @example 0.5
+     */
+    duration?: number;
+    /**
+     * The intensity of the event as a value between `0` and `1`.
+     *
+     * On Android, the intensity is only respected on devices with amplitude
+     * control.
+     *
+     * @since 0.1.0
+     * @example 1.0
+     */
+    intensity: number;
+    /**
+     * The sharpness of the event as a value between `0` and `1`.
+     *
+     * A lower value results in a rounder, softer feedback while a higher value
+     * results in a crisper, more precise feedback.
+     *
+     * Only available on iOS.
+     *
+     * @since 0.1.0
+     * @default 0.5
+     * @example 0.7
+     */
+    sharpness?: number;
+    /**
+     * The relative time at which the event occurs, in seconds.
+     *
+     * @since 0.1.0
+     * @example 0.2
+     */
+    time: number;
+}
+/**
+ * @since 0.1.0
+ */
+export interface ImpactOptions {
+    /**
+     * The style of the impact.
+     *
+     * @since 0.1.0
+     * @default ImpactStyle.Medium
+     */
+    style?: ImpactStyle;
+}
+/**
+ * @since 0.1.0
+ */
+export interface IsAvailableResult {
+    /**
+     * Whether or not haptic feedback is available on the device.
+     *
+     * @since 0.1.0
+     * @example true
+     */
+    available: boolean;
+}
+/**
+ * @since 0.1.0
+ */
+export interface NotificationOptions {
+    /**
+     * The type of the notification.
+     *
+     * @since 0.1.0
+     * @default NotificationType.Success
+     */
+    type?: NotificationType;
+}
+/**
+ * @since 0.1.0
+ */
+export interface PerformAndroidHapticOptions {
+    /**
+     * The Android haptic feedback effect to perform.
+     *
+     * @since 0.1.0
+     */
+    type: AndroidHapticType;
+}
+/**
+ * @since 0.1.0
+ */
+export interface PlayPatternOptions {
+    /**
+     * The haptic events that make up the pattern.
+     *
+     * @since 0.1.0
+     */
+    events: HapticEvent[];
+}
+/**
+ * @since 0.1.0
+ */
+export interface VibrateOptions {
+    /**
+     * The duration of the vibration in milliseconds.
+     *
+     * Only available on Android and Web.
+     *
+     * @since 0.1.0
+     * @default 300
+     * @example 500
+     */
+    duration?: number;
+}
+/**
+ * The Android haptic feedback effect to perform.
+ *
+ * The effects correspond to the haptic feedback constants of the Android
+ * view system.
+ *
+ * @since 0.1.0
+ */
+export declare enum AndroidHapticType {
+    /**
+     * The user has pressed either an hour or minute tick of a clock.
+     *
+     * @since 0.1.0
+     */
+    ClockTick = "CLOCK_TICK",
+    /**
+     * The confirmation of a user's action.
+     *
+     * On Android 10 and older, `ContextClick` is performed instead.
+     *
+     * @since 0.1.0
+     */
+    Confirm = "CONFIRM",
+    /**
+     * The user has performed a context click on an object.
+     *
+     * @since 0.1.0
+     */
+    ContextClick = "CONTEXT_CLICK",
+    /**
+     * The user has pressed a virtual or software keyboard key.
+     *
+     * @since 0.1.0
+     */
+    KeyboardTap = "KEYBOARD_TAP",
+    /**
+     * The user has performed a long press on an object.
+     *
+     * @since 0.1.0
+     */
+    LongPress = "LONG_PRESS",
+    /**
+     * The rejection or failure of a user's action.
+     *
+     * On Android 10 and older, `LongPress` is performed instead.
+     *
+     * @since 0.1.0
+     */
+    Reject = "REJECT",
+    /**
+     * The user has toggled a switch or button into the off position.
+     *
+     * On Android 13 and older, `ClockTick` is performed instead.
+     *
+     * @since 0.1.0
+     */
+    ToggleOff = "TOGGLE_OFF",
+    /**
+     * The user has toggled a switch or button into the on position.
+     *
+     * On Android 13 and older, `ClockTick` is performed instead.
+     *
+     * @since 0.1.0
+     */
+    ToggleOn = "TOGGLE_ON",
+    /**
+     * The user has pressed on a virtual on-screen key.
+     *
+     * @since 0.1.0
+     */
+    VirtualKey = "VIRTUAL_KEY"
+}
+/**
+ * @since 0.1.0
+ */
+export declare enum ErrorCode {
+    /**
+     * The haptic pattern could not be played.
+     *
+     * @since 0.1.0
+     */
+    PatternPlaybackFailed = "PATTERN_PLAYBACK_FAILED"
+}
+/**
+ * The style of the impact.
+ *
+ * @since 0.1.0
+ */
+export declare enum ImpactStyle {
+    /**
+     * A collision between large, heavy user interface elements.
+     *
+     * @since 0.1.0
+     */
+    Heavy = "HEAVY",
+    /**
+     * A collision between small, light user interface elements.
+     *
+     * @since 0.1.0
+     */
+    Light = "LIGHT",
+    /**
+     * A collision between moderately sized user interface elements.
+     *
+     * @since 0.1.0
+     */
+    Medium = "MEDIUM",
+    /**
+     * A collision between hard or inflexible user interface elements.
+     *
+     * @since 0.1.0
+     */
+    Rigid = "RIGID",
+    /**
+     * A collision between soft or flexible user interface elements.
+     *
+     * @since 0.1.0
+     */
+    Soft = "SOFT"
+}
+/**
+ * The type of the notification.
+ *
+ * @since 0.1.0
+ */
+export declare enum NotificationType {
+    /**
+     * A task or action has failed.
+     *
+     * @since 0.1.0
+     */
+    Error = "ERROR",
+    /**
+     * A task or action has completed successfully.
+     *
+     * @since 0.1.0
+     */
+    Success = "SUCCESS",
+    /**
+     * A task or action has produced a warning.
+     *
+     * @since 0.1.0
+     */
+    Warning = "WARNING"
+}

package/dist/esm/definitions.js

@@ -0,0 +1,150 @@
+/**
+ * The Android haptic feedback effect to perform.
+ *
+ * The effects correspond to the haptic feedback constants of the Android
+ * view system.
+ *
+ * @since 0.1.0
+ */
+export var AndroidHapticType;
+(function (AndroidHapticType) {
+    /**
+     * The user has pressed either an hour or minute tick of a clock.
+     *
+     * @since 0.1.0
+     */
+    AndroidHapticType["ClockTick"] = "CLOCK_TICK";
+    /**
+     * The confirmation of a user's action.
+     *
+     * On Android 10 and older, `ContextClick` is performed instead.
+     *
+     * @since 0.1.0
+     */
+    AndroidHapticType["Confirm"] = "CONFIRM";
+    /**
+     * The user has performed a context click on an object.
+     *
+     * @since 0.1.0
+     */
+    AndroidHapticType["ContextClick"] = "CONTEXT_CLICK";
+    /**
+     * The user has pressed a virtual or software keyboard key.
+     *
+     * @since 0.1.0
+     */
+    AndroidHapticType["KeyboardTap"] = "KEYBOARD_TAP";
+    /**
+     * The user has performed a long press on an object.
+     *
+     * @since 0.1.0
+     */
+    AndroidHapticType["LongPress"] = "LONG_PRESS";
+    /**
+     * The rejection or failure of a user's action.
+     *
+     * On Android 10 and older, `LongPress` is performed instead.
+     *
+     * @since 0.1.0
+     */
+    AndroidHapticType["Reject"] = "REJECT";
+    /**
+     * The user has toggled a switch or button into the off position.
+     *
+     * On Android 13 and older, `ClockTick` is performed instead.
+     *
+     * @since 0.1.0
+     */
+    AndroidHapticType["ToggleOff"] = "TOGGLE_OFF";
+    /**
+     * The user has toggled a switch or button into the on position.
+     *
+     * On Android 13 and older, `ClockTick` is performed instead.
+     *
+     * @since 0.1.0
+     */
+    AndroidHapticType["ToggleOn"] = "TOGGLE_ON";
+    /**
+     * The user has pressed on a virtual on-screen key.
+     *
+     * @since 0.1.0
+     */
+    AndroidHapticType["VirtualKey"] = "VIRTUAL_KEY";
+})(AndroidHapticType || (AndroidHapticType = {}));
+/**
+ * @since 0.1.0
+ */
+export var ErrorCode;
+(function (ErrorCode) {
+    /**
+     * The haptic pattern could not be played.
+     *
+     * @since 0.1.0
+     */
+    ErrorCode["PatternPlaybackFailed"] = "PATTERN_PLAYBACK_FAILED";
+})(ErrorCode || (ErrorCode = {}));
+/**
+ * The style of the impact.
+ *
+ * @since 0.1.0
+ */
+export var ImpactStyle;
+(function (ImpactStyle) {
+    /**
+     * A collision between large, heavy user interface elements.
+     *
+     * @since 0.1.0
+     */
+    ImpactStyle["Heavy"] = "HEAVY";
+    /**
+     * A collision between small, light user interface elements.
+     *
+     * @since 0.1.0
+     */
+    ImpactStyle["Light"] = "LIGHT";
+    /**
+     * A collision between moderately sized user interface elements.
+     *
+     * @since 0.1.0
+     */
+    ImpactStyle["Medium"] = "MEDIUM";
+    /**
+     * A collision between hard or inflexible user interface elements.
+     *
+     * @since 0.1.0
+     */
+    ImpactStyle["Rigid"] = "RIGID";
+    /**
+     * A collision between soft or flexible user interface elements.
+     *
+     * @since 0.1.0
+     */
+    ImpactStyle["Soft"] = "SOFT";
+})(ImpactStyle || (ImpactStyle = {}));
+/**
+ * The type of the notification.
+ *
+ * @since 0.1.0
+ */
+export var NotificationType;
+(function (NotificationType) {
+    /**
+     * A task or action has failed.
+     *
+     * @since 0.1.0
+     */
+    NotificationType["Error"] = "ERROR";
+    /**
+     * A task or action has completed successfully.
+     *
+     * @since 0.1.0
+     */
+    NotificationType["Success"] = "SUCCESS";
+    /**
+     * A task or action has produced a warning.
+     *
+     * @since 0.1.0
+     */
+    NotificationType["Warning"] = "WARNING";
+})(NotificationType || (NotificationType = {}));
+//# sourceMappingURL=definitions.js.map

package/dist/esm/definitions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"AAkOA;;;;;;;GAOG;AACH,MAAM,CAAN,IAAY,iBA+DX;AA/DD,WAAY,iBAAiB;IAC3B;;;;OAIG;IACH,6CAAwB,CAAA;IACxB;;;;;;OAMG;IACH,wCAAmB,CAAA;IACnB;;;;OAIG;IACH,mDAA8B,CAAA;IAC9B;;;;OAIG;IACH,iDAA4B,CAAA;IAC5B;;;;OAIG;IACH,6CAAwB,CAAA;IACxB;;;;;;OAMG;IACH,sCAAiB,CAAA;IACjB;;;;;;OAMG;IACH,6CAAwB,CAAA;IACxB;;;;;;OAMG;IACH,2CAAsB,CAAA;IACtB;;;;OAIG;IACH,+CAA0B,CAAA;AAC5B,CAAC,EA/DW,iBAAiB,KAAjB,iBAAiB,QA+D5B;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,SAOX;AAPD,WAAY,SAAS;IACnB;;;;OAIG;IACH,8DAAiD,CAAA;AACnD,CAAC,EAPW,SAAS,KAAT,SAAS,QAOpB;AAED;;;;GAIG;AACH,MAAM,CAAN,IAAY,WA+BX;AA/BD,WAAY,WAAW;IACrB;;;;OAIG;IACH,8BAAe,CAAA;IACf;;;;OAIG;IACH,8BAAe,CAAA;IACf;;;;OAIG;IACH,gCAAiB,CAAA;IACjB;;;;OAIG;IACH,8BAAe,CAAA;IACf;;;;OAIG;IACH,4BAAa,CAAA;AACf,CAAC,EA/BW,WAAW,KAAX,WAAW,QA+BtB;AAED;;;;GAIG;AACH,MAAM,CAAN,IAAY,gBAmBX;AAnBD,WAAY,gBAAgB;IAC1B;;;;OAIG;IACH,mCAAe,CAAA;IACf;;;;OAIG;IACH,uCAAmB,CAAA;IACnB;;;;OAIG;IACH,uCAAmB,CAAA;AACrB,CAAC,EAnBW,gBAAgB,KAAhB,gBAAgB,QAmB3B","sourcesContent":["export interface HapticsPlugin {\n  /**\n   * Trigger an impact haptic feedback.\n   *\n   * Use this to simulate a physical impact, for example when user\n   * interface elements collide or a drag operation snaps into place.\n   *\n   * On Android, the impact style is mapped to a best-effort vibration effect.\n   *\n   * @since 0.1.0\n   */\n  impact(options?: ImpactOptions): Promise<void>;\n  /**\n   * Check if haptic feedback is available on the device.\n   *\n   * On Android, this checks whether the device has a vibrator.\n   * On iOS, this checks whether the device supports haptic event playback.\n   * On the web, this checks whether the Vibration API is supported.\n   *\n   * @since 0.1.0\n   */\n  isAvailable(): Promise<IsAvailableResult>;\n  /**\n   * Trigger a notification haptic feedback.\n   *\n   * Use this to communicate that a task or action has succeeded, failed,\n   * or produced a warning.\n   *\n   * On Android, the notification type is mapped to a best-effort vibration\n   * effect.\n   *\n   * @since 0.1.0\n   */\n  notification(options?: NotificationOptions): Promise<void>;\n  /**\n   * Perform a predefined Android haptic feedback effect.\n   *\n   * In contrast to the other methods, this method does not use the vibrator\n   * but the semantic haptic feedback constants of the Android view system.\n   * This respects the user's haptic feedback settings.\n   *\n   * Only available on Android.\n   *\n   * @since 0.1.0\n   */\n  performAndroidHaptic(options: PerformAndroidHapticOptions): Promise<void>;\n  /**\n   * Play a custom haptic pattern composed of individual haptic events.\n   *\n   * On iOS, the pattern is played using Core Haptics with full support for\n   * intensity and sharpness. This requires a device with haptic event\n   * playback support (for example an iPhone with a Taptic Engine).\n   * Otherwise, the call rejects as unavailable.\n   *\n   * On Android, the pattern is played using vibration effects. Intensity is\n   * only respected on devices with amplitude control.\n   *\n   * On the web, the pattern is approximated using the Vibration API.\n   *\n   * @since 0.1.0\n   */\n  playPattern(options: PlayPatternOptions): Promise<void>;\n  /**\n   * Trigger a selection changed haptic feedback.\n   *\n   * Call this method after `selectionStart()` whenever the selection changes.\n   *\n   * On the web, this method does nothing.\n   *\n   * @since 0.1.0\n   */\n  selectionChanged(): Promise<void>;\n  /**\n   * End a selection session.\n   *\n   * Call this method when the user finishes a selection interaction.\n   *\n   * On the web, this method does nothing.\n   *\n   * @since 0.1.0\n   */\n  selectionEnd(): Promise<void>;\n  /**\n   * Start a selection session.\n   *\n   * Call this method when the user starts a selection interaction, for\n   * example when a picker starts scrolling. It prepares the haptic hardware\n   * to reduce the latency of subsequent `selectionChanged()` calls.\n   *\n   * On the web, this method does nothing.\n   *\n   * @since 0.1.0\n   */\n  selectionStart(): Promise<void>;\n  /**\n   * Vibrate the device.\n   *\n   * @since 0.1.0\n   */\n  vibrate(options?: VibrateOptions): Promise<void>;\n}\n\n/**\n * @since 0.1.0\n */\nexport interface HapticEvent {\n  /**\n   * The duration of the event in seconds.\n   *\n   * If omitted, the event is a transient tap.\n   *\n   * @since 0.1.0\n   * @example 0.5\n   */\n  duration?: number;\n  /**\n   * The intensity of the event as a value between `0` and `1`.\n   *\n   * On Android, the intensity is only respected on devices with amplitude\n   * control.\n   *\n   * @since 0.1.0\n   * @example 1.0\n   */\n  intensity: number;\n  /**\n   * The sharpness of the event as a value between `0` and `1`.\n   *\n   * A lower value results in a rounder, softer feedback while a higher value\n   * results in a crisper, more precise feedback.\n   *\n   * Only available on iOS.\n   *\n   * @since 0.1.0\n   * @default 0.5\n   * @example 0.7\n   */\n  sharpness?: number;\n  /**\n   * The relative time at which the event occurs, in seconds.\n   *\n   * @since 0.1.0\n   * @example 0.2\n   */\n  time: number;\n}\n\n/**\n * @since 0.1.0\n */\nexport interface ImpactOptions {\n  /**\n   * The style of the impact.\n   *\n   * @since 0.1.0\n   * @default ImpactStyle.Medium\n   */\n  style?: ImpactStyle;\n}\n\n/**\n * @since 0.1.0\n */\nexport interface IsAvailableResult {\n  /**\n   * Whether or not haptic feedback is available on the device.\n   *\n   * @since 0.1.0\n   * @example true\n   */\n  available: boolean;\n}\n\n/**\n * @since 0.1.0\n */\nexport interface NotificationOptions {\n  /**\n   * The type of the notification.\n   *\n   * @since 0.1.0\n   * @default NotificationType.Success\n   */\n  type?: NotificationType;\n}\n\n/**\n * @since 0.1.0\n */\nexport interface PerformAndroidHapticOptions {\n  /**\n   * The Android haptic feedback effect to perform.\n   *\n   * @since 0.1.0\n   */\n  type: AndroidHapticType;\n}\n\n/**\n * @since 0.1.0\n */\nexport interface PlayPatternOptions {\n  /**\n   * The haptic events that make up the pattern.\n   *\n   * @since 0.1.0\n   */\n  events: HapticEvent[];\n}\n\n/**\n * @since 0.1.0\n */\nexport interface VibrateOptions {\n  /**\n   * The duration of the vibration in milliseconds.\n   *\n   * Only available on Android and Web.\n   *\n   * @since 0.1.0\n   * @default 300\n   * @example 500\n   */\n  duration?: number;\n}\n\n/**\n * The Android haptic feedback effect to perform.\n *\n * The effects correspond to the haptic feedback constants of the Android\n * view system.\n *\n * @since 0.1.0\n */\nexport enum AndroidHapticType {\n  /**\n   * The user has pressed either an hour or minute tick of a clock.\n   *\n   * @since 0.1.0\n   */\n  ClockTick = 'CLOCK_TICK',\n  /**\n   * The confirmation of a user's action.\n   *\n   * On Android 10 and older, `ContextClick` is performed instead.\n   *\n   * @since 0.1.0\n   */\n  Confirm = 'CONFIRM',\n  /**\n   * The user has performed a context click on an object.\n   *\n   * @since 0.1.0\n   */\n  ContextClick = 'CONTEXT_CLICK',\n  /**\n   * The user has pressed a virtual or software keyboard key.\n   *\n   * @since 0.1.0\n   */\n  KeyboardTap = 'KEYBOARD_TAP',\n  /**\n   * The user has performed a long press on an object.\n   *\n   * @since 0.1.0\n   */\n  LongPress = 'LONG_PRESS',\n  /**\n   * The rejection or failure of a user's action.\n   *\n   * On Android 10 and older, `LongPress` is performed instead.\n   *\n   * @since 0.1.0\n   */\n  Reject = 'REJECT',\n  /**\n   * The user has toggled a switch or button into the off position.\n   *\n   * On Android 13 and older, `ClockTick` is performed instead.\n   *\n   * @since 0.1.0\n   */\n  ToggleOff = 'TOGGLE_OFF',\n  /**\n   * The user has toggled a switch or button into the on position.\n   *\n   * On Android 13 and older, `ClockTick` is performed instead.\n   *\n   * @since 0.1.0\n   */\n  ToggleOn = 'TOGGLE_ON',\n  /**\n   * The user has pressed on a virtual on-screen key.\n   *\n   * @since 0.1.0\n   */\n  VirtualKey = 'VIRTUAL_KEY',\n}\n\n/**\n * @since 0.1.0\n */\nexport enum ErrorCode {\n  /**\n   * The haptic pattern could not be played.\n   *\n   * @since 0.1.0\n   */\n  PatternPlaybackFailed = 'PATTERN_PLAYBACK_FAILED',\n}\n\n/**\n * The style of the impact.\n *\n * @since 0.1.0\n */\nexport enum ImpactStyle {\n  /**\n   * A collision between large, heavy user interface elements.\n   *\n   * @since 0.1.0\n   */\n  Heavy = 'HEAVY',\n  /**\n   * A collision between small, light user interface elements.\n   *\n   * @since 0.1.0\n   */\n  Light = 'LIGHT',\n  /**\n   * A collision between moderately sized user interface elements.\n   *\n   * @since 0.1.0\n   */\n  Medium = 'MEDIUM',\n  /**\n   * A collision between hard or inflexible user interface elements.\n   *\n   * @since 0.1.0\n   */\n  Rigid = 'RIGID',\n  /**\n   * A collision between soft or flexible user interface elements.\n   *\n   * @since 0.1.0\n   */\n  Soft = 'SOFT',\n}\n\n/**\n * The type of the notification.\n *\n * @since 0.1.0\n */\nexport enum NotificationType {\n  /**\n   * A task or action has failed.\n   *\n   * @since 0.1.0\n   */\n  Error = 'ERROR',\n  /**\n   * A task or action has completed successfully.\n   *\n   * @since 0.1.0\n   */\n  Success = 'SUCCESS',\n  /**\n   * A task or action has produced a warning.\n   *\n   * @since 0.1.0\n   */\n  Warning = 'WARNING',\n}\n"]}

package/dist/esm/index.d.ts

@@ -0,0 +1,4 @@
+import type { HapticsPlugin } from './definitions';
+declare const Haptics: HapticsPlugin;
+export * from './definitions';
+export { Haptics };

package/dist/esm/index.js

@@ -0,0 +1,7 @@
+import { registerPlugin } from '@capacitor/core';
+const Haptics = registerPlugin('Haptics', {
+    web: () => import('./web').then(m => new m.HapticsWeb()),
+});
+export * from './definitions';
+export { Haptics };
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAIjD,MAAM,OAAO,GAAG,cAAc,CAAgB,SAAS,EAAE;IACvD,GAAG,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,CAAC;CACzD,CAAC,CAAC;AAEH,cAAc,eAAe,CAAC;AAC9B,OAAO,EAAE,OAAO,EAAE,CAAC","sourcesContent":["import { registerPlugin } from '@capacitor/core';\n\nimport type { HapticsPlugin } from './definitions';\n\nconst Haptics = registerPlugin<HapticsPlugin>('Haptics', {\n  web: () => import('./web').then(m => new m.HapticsWeb()),\n});\n\nexport * from './definitions';\nexport { Haptics };\n"]}

package/dist/esm/web.d.ts

@@ -0,0 +1,21 @@
+import { WebPlugin } from '@capacitor/core';
+import type { HapticsPlugin, ImpactOptions, IsAvailableResult, NotificationOptions, PerformAndroidHapticOptions, PlayPatternOptions, VibrateOptions } from './definitions';
+export declare class HapticsWeb extends WebPlugin implements HapticsPlugin {
+    private static readonly defaultVibrateDuration;
+    private static readonly errorEventsMissing;
+    private static readonly transientEventDuration;
+    impact(options?: ImpactOptions): Promise<void>;
+    isAvailable(): Promise<IsAvailableResult>;
+    notification(options?: NotificationOptions): Promise<void>;
+    performAndroidHaptic(_options: PerformAndroidHapticOptions): Promise<void>;
+    playPattern(options: PlayPatternOptions): Promise<void>;
+    selectionChanged(): Promise<void>;
+    selectionEnd(): Promise<void>;
+    selectionStart(): Promise<void>;
+    vibrate(options?: VibrateOptions): Promise<void>;
+    private createPatternFromEvents;
+    private getDurationForImpactStyle;
+    private getPatternForNotificationType;
+    private isVibrationSupported;
+    private vibrateOrThrow;
+}

package/dist/esm/web.js

@@ -0,0 +1,100 @@
+import { WebPlugin } from '@capacitor/core';
+import { ImpactStyle, NotificationType } from './definitions';
+export class HapticsWeb extends WebPlugin {
+    async impact(options) {
+        var _a;
+        const style = (_a = options === null || options === void 0 ? void 0 : options.style) !== null && _a !== void 0 ? _a : ImpactStyle.Medium;
+        this.vibrateOrThrow(this.getDurationForImpactStyle(style));
+    }
+    async isAvailable() {
+        return { available: this.isVibrationSupported() };
+    }
+    async notification(options) {
+        var _a;
+        const type = (_a = options === null || options === void 0 ? void 0 : options.type) !== null && _a !== void 0 ? _a : NotificationType.Success;
+        this.vibrateOrThrow(this.getPatternForNotificationType(type));
+    }
+    async performAndroidHaptic(_options) {
+        throw this.unimplemented('Not implemented on web.');
+    }
+    async playPattern(options) {
+        const events = options.events;
+        if (!events || events.length === 0) {
+            throw new Error(HapticsWeb.errorEventsMissing);
+        }
+        this.vibrateOrThrow(this.createPatternFromEvents(events));
+    }
+    async selectionChanged() {
+        // No-op on the web.
+    }
+    async selectionEnd() {
+        // No-op on the web.
+    }
+    async selectionStart() {
+        // No-op on the web.
+    }
+    async vibrate(options) {
+        var _a;
+        this.vibrateOrThrow((_a = options === null || options === void 0 ? void 0 : options.duration) !== null && _a !== void 0 ? _a : HapticsWeb.defaultVibrateDuration);
+    }
+    createPatternFromEvents(events) {
+        const sortedEvents = [...events].sort((a, b) => a.time - b.time);
+        const pattern = [];
+        let currentTime = 0;
+        for (const event of sortedEvents) {
+            const startTime = Math.max(Math.round(event.time * 1000), currentTime);
+            const pause = startTime - currentTime;
+            const duration = event.duration
+                ? Math.round(event.duration * 1000)
+                : HapticsWeb.transientEventDuration;
+            if (pattern.length === 0) {
+                if (pause > 0) {
+                    pattern.push(0, pause);
+                }
+            }
+            else {
+                pattern.push(pause);
+            }
+            pattern.push(duration);
+            currentTime = startTime + duration;
+        }
+        return pattern;
+    }
+    getDurationForImpactStyle(style) {
+        switch (style) {
+            case ImpactStyle.Heavy:
+                return 60;
+            case ImpactStyle.Light:
+                return 20;
+            case ImpactStyle.Rigid:
+                return 25;
+            case ImpactStyle.Soft:
+                return 50;
+            default:
+                return 40;
+        }
+    }
+    getPatternForNotificationType(type) {
+        switch (type) {
+            case NotificationType.Error:
+                return [40, 60, 40, 60, 60];
+            case NotificationType.Warning:
+                return [60, 100, 60];
+            default:
+                return [40, 80, 60];
+        }
+    }
+    isVibrationSupported() {
+        return typeof navigator !== 'undefined' && 'vibrate' in navigator;
+    }
+    vibrateOrThrow(pattern) {
+        if (!this.isVibrationSupported()) {
+            throw this.unavailable('Vibration API not available in this browser.');
+        }
+        navigator.vibrate(pattern);
+    }
+}
+HapticsWeb.defaultVibrateDuration = 300;
+HapticsWeb.errorEventsMissing = 'events must be provided.';
+HapticsWeb.transientEventDuration = 30;
+//# sourceMappingURL=web.js.map

package/dist/esm/web.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"web.js","sourceRoot":"","sources":["../../src/web.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAY5C,OAAO,EAAE,WAAW,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AAE9D,MAAM,OAAO,UAAW,SAAQ,SAAS;IAKvC,KAAK,CAAC,MAAM,CAAC,OAAuB;;QAClC,MAAM,KAAK,GAAG,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,KAAK,mCAAI,WAAW,CAAC,MAAM,CAAC;QACnD,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,yBAAyB,CAAC,KAAK,CAAC,CAAC,CAAC;IAC7D,CAAC;IAED,KAAK,CAAC,WAAW;QACf,OAAO,EAAE,SAAS,EAAE,IAAI,CAAC,oBAAoB,EAAE,EAAE,CAAC;IACpD,CAAC;IAED,KAAK,CAAC,YAAY,CAAC,OAA6B;;QAC9C,MAAM,IAAI,GAAG,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,IAAI,mCAAI,gBAAgB,CAAC,OAAO,CAAC;QACvD,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,6BAA6B,CAAC,IAAI,CAAC,CAAC,CAAC;IAChE,CAAC;IAED,KAAK,CAAC,oBAAoB,CACxB,QAAqC;QAErC,MAAM,IAAI,CAAC,aAAa,CAAC,yBAAyB,CAAC,CAAC;IACtD,CAAC;IAED,KAAK,CAAC,WAAW,CAAC,OAA2B;QAC3C,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;QAC9B,IAAI,CAAC,MAAM,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACnC,MAAM,IAAI,KAAK,CAAC,UAAU,CAAC,kBAAkB,CAAC,CAAC;QACjD,CAAC;QACD,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,uBAAuB,CAAC,MAAM,CAAC,CAAC,CAAC;IAC5D,CAAC;IAED,KAAK,CAAC,gBAAgB;QACpB,oBAAoB;IACtB,CAAC;IAED,KAAK,CAAC,YAAY;QAChB,oBAAoB;IACtB,CAAC;IAED,KAAK,CAAC,cAAc;QAClB,oBAAoB;IACtB,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,OAAwB;;QACpC,IAAI,CAAC,cAAc,CAAC,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,QAAQ,mCAAI,UAAU,CAAC,sBAAsB,CAAC,CAAC;IAC9E,CAAC;IAEO,uBAAuB,CAAC,MAAqB;QACnD,MAAM,YAAY,GAAG,CAAC,GAAG,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC;QACjE,MAAM,OAAO,GAAa,EAAE,CAAC;QAC7B,IAAI,WAAW,GAAG,CAAC,CAAC;QACpB,KAAK,MAAM,KAAK,IAAI,YAAY,EAAE,CAAC;YACjC,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,GAAG,IAAI,CAAC,EAAE,WAAW,CAAC,CAAC;YACvE,MAAM,KAAK,GAAG,SAAS,GAAG,WAAW,CAAC;YACtC,MAAM,QAAQ,GAAG,KAAK,CAAC,QAAQ;gBAC7B,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC;gBACnC,CAAC,CAAC,UAAU,CAAC,sBAAsB,CAAC;YACtC,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBACzB,IAAI,KAAK,GAAG,CAAC,EAAE,CAAC;oBACd,OAAO,CAAC,IAAI,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;gBACzB,CAAC;YACH,CAAC;iBAAM,CAAC;gBACN,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACtB,CAAC;YACD,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YACvB,WAAW,GAAG,SAAS,GAAG,QAAQ,CAAC;QACrC,CAAC;QACD,OAAO,OAAO,CAAC;IACjB,CAAC;IAEO,yBAAyB,CAAC,KAAkB;QAClD,QAAQ,KAAK,EAAE,CAAC;YACd,KAAK,WAAW,CAAC,KAAK;gBACpB,OAAO,EAAE,CAAC;YACZ,KAAK,WAAW,CAAC,KAAK;gBACpB,OAAO,EAAE,CAAC;YACZ,KAAK,WAAW,CAAC,KAAK;gBACpB,OAAO,EAAE,CAAC;YACZ,KAAK,WAAW,CAAC,IAAI;gBACnB,OAAO,EAAE,CAAC;YACZ;gBACE,OAAO,EAAE,CAAC;QACd,CAAC;IACH,CAAC;IAEO,6BAA6B,CAAC,IAAsB;QAC1D,QAAQ,IAAI,EAAE,CAAC;YACb,KAAK,gBAAgB,CAAC,KAAK;gBACzB,OAAO,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;YAC9B,KAAK,gBAAgB,CAAC,OAAO;gBAC3B,OAAO,CAAC,EAAE,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC;YACvB;gBACE,OAAO,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;QACxB,CAAC;IACH,CAAC;IAEO,oBAAoB;QAC1B,OAAO,OAAO,SAAS,KAAK,WAAW,IAAI,SAAS,IAAI,SAAS,CAAC;IACpE,CAAC;IAEO,cAAc,CAAC,OAA0B;QAC/C,IAAI,CAAC,IAAI,CAAC,oBAAoB,EAAE,EAAE,CAAC;YACjC,MAAM,IAAI,CAAC,WAAW,CAAC,8CAA8C,CAAC,CAAC;QACzE,CAAC;QACD,SAAS,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IAC7B,CAAC;;AA1GuB,iCAAsB,GAAG,GAAG,CAAC;AAC7B,6BAAkB,GAAG,0BAA0B,CAAC;AAChD,iCAAsB,GAAG,EAAE,CAAC","sourcesContent":["import { WebPlugin } from '@capacitor/core';\n\nimport type {\n  HapticEvent,\n  HapticsPlugin,\n  ImpactOptions,\n  IsAvailableResult,\n  NotificationOptions,\n  PerformAndroidHapticOptions,\n  PlayPatternOptions,\n  VibrateOptions,\n} from './definitions';\nimport { ImpactStyle, NotificationType } from './definitions';\n\nexport class HapticsWeb extends WebPlugin implements HapticsPlugin {\n  private static readonly defaultVibrateDuration = 300;\n  private static readonly errorEventsMissing = 'events must be provided.';\n  private static readonly transientEventDuration = 30;\n\n  async impact(options?: ImpactOptions): Promise<void> {\n    const style = options?.style ?? ImpactStyle.Medium;\n    this.vibrateOrThrow(this.getDurationForImpactStyle(style));\n  }\n\n  async isAvailable(): Promise<IsAvailableResult> {\n    return { available: this.isVibrationSupported() };\n  }\n\n  async notification(options?: NotificationOptions): Promise<void> {\n    const type = options?.type ?? NotificationType.Success;\n    this.vibrateOrThrow(this.getPatternForNotificationType(type));\n  }\n\n  async performAndroidHaptic(\n    _options: PerformAndroidHapticOptions,\n  ): Promise<void> {\n    throw this.unimplemented('Not implemented on web.');\n  }\n\n  async playPattern(options: PlayPatternOptions): Promise<void> {\n    const events = options.events;\n    if (!events || events.length === 0) {\n      throw new Error(HapticsWeb.errorEventsMissing);\n    }\n    this.vibrateOrThrow(this.createPatternFromEvents(events));\n  }\n\n  async selectionChanged(): Promise<void> {\n    // No-op on the web.\n  }\n\n  async selectionEnd(): Promise<void> {\n    // No-op on the web.\n  }\n\n  async selectionStart(): Promise<void> {\n    // No-op on the web.\n  }\n\n  async vibrate(options?: VibrateOptions): Promise<void> {\n    this.vibrateOrThrow(options?.duration ?? HapticsWeb.defaultVibrateDuration);\n  }\n\n  private createPatternFromEvents(events: HapticEvent[]): number[] {\n    const sortedEvents = [...events].sort((a, b) => a.time - b.time);\n    const pattern: number[] = [];\n    let currentTime = 0;\n    for (const event of sortedEvents) {\n      const startTime = Math.max(Math.round(event.time * 1000), currentTime);\n      const pause = startTime - currentTime;\n      const duration = event.duration\n        ? Math.round(event.duration * 1000)\n        : HapticsWeb.transientEventDuration;\n      if (pattern.length === 0) {\n        if (pause > 0) {\n          pattern.push(0, pause);\n        }\n      } else {\n        pattern.push(pause);\n      }\n      pattern.push(duration);\n      currentTime = startTime + duration;\n    }\n    return pattern;\n  }\n\n  private getDurationForImpactStyle(style: ImpactStyle): number {\n    switch (style) {\n      case ImpactStyle.Heavy:\n        return 60;\n      case ImpactStyle.Light:\n        return 20;\n      case ImpactStyle.Rigid:\n        return 25;\n      case ImpactStyle.Soft:\n        return 50;\n      default:\n        return 40;\n    }\n  }\n\n  private getPatternForNotificationType(type: NotificationType): number[] {\n    switch (type) {\n      case NotificationType.Error:\n        return [40, 60, 40, 60, 60];\n      case NotificationType.Warning:\n        return [60, 100, 60];\n      default:\n        return [40, 80, 60];\n    }\n  }\n\n  private isVibrationSupported(): boolean {\n    return typeof navigator !== 'undefined' && 'vibrate' in navigator;\n  }\n\n  private vibrateOrThrow(pattern: number | number[]): void {\n    if (!this.isVibrationSupported()) {\n      throw this.unavailable('Vibration API not available in this browser.');\n    }\n    navigator.vibrate(pattern);\n  }\n}\n"]}