@capgo/capacitor-shake 7.1.29 → 7.2.4

package/README.md

@@ -23,6 +23,7 @@ npx cap sync
 <docgen-index>
 
 * [`addListener('shake', ...)`](#addlistenershake-)
+* [`getPluginVersion()`](#getpluginversion)
 * [Interfaces](#interfaces)
 
 </docgen-index>
@@ -30,19 +31,46 @@ npx cap sync
 <docgen-api>
 <!--Update the source file JSDoc comments and rerun docgen to update the docs below-->
 
+Capacitor Shake Plugin interface for detecting shake gestures on mobile devices.
+This plugin allows you to listen for shake events and get plugin version information.
+
 ### addListener('shake', ...)
 
 ```typescript
 addListener(eventName: 'shake', listenerFunc: () => void) => Promise<PluginListenerHandle>
 ```
 
-| Param              | Type                       |
-| ------------------ | -------------------------- |
-| **`eventName`**    | <code>'shake'</code>       |
-| **`listenerFunc`** | <code>() =&gt; void</code> |
+Listen for shake event on the device.
+
+Registers a listener that will be called whenever a shake gesture is detected.
+The shake detection uses the device's accelerometer to identify shake patterns.
+
+| Param              | Type                       | Description                                         |
+| ------------------ | -------------------------- | --------------------------------------------------- |
+| **`eventName`**    | <code>'shake'</code>       | The shake change event name. Must be 'shake'.       |
+| **`listenerFunc`** | <code>() =&gt; void</code> | Callback function invoked when the phone is shaken. |
 
 **Returns:** <code>Promise&lt;<a href="#pluginlistenerhandle">PluginListenerHandle</a>&gt;</code>
 
+**Since:** 1.0.0
+
+--------------------
+
+
+### getPluginVersion()
+
+```typescript
+getPluginVersion() => Promise<{ version: string; }>
+```
+
+Get the native Capacitor plugin version.
+
+Returns the current version of the native plugin implementation.
+
+**Returns:** <code>Promise&lt;{ version: string; }&gt;</code>
+
+**Since:** 1.0.0
+
 --------------------
 
 

package/android/src/main/java/ee/forgr/capacitor/shake/CapacitorShakePlugin.java

@@ -5,12 +5,16 @@ import android.hardware.SensorManager;
 import android.util.Log;
 import com.getcapacitor.JSObject;
 import com.getcapacitor.Plugin;
+import com.getcapacitor.PluginCall;
+import com.getcapacitor.PluginMethod;
 import com.getcapacitor.annotation.CapacitorPlugin;
 import com.squareup.seismic.ShakeDetector;
 
 @CapacitorPlugin(name = "CapacitorShake")
 public class CapacitorShakePlugin extends Plugin implements ShakeDetector.Listener {
 
+    private final String PLUGIN_VERSION = "7.2.4";
+
     @Override
     public void load() {
         super.load();
@@ -42,4 +46,15 @@ public class CapacitorShakePlugin extends Plugin implements ShakeDetector.Listen
         JSObject ret = new JSObject();
         notifyListeners("shake", ret);
     }
+
+    @PluginMethod
+    public void getPluginVersion(final PluginCall call) {
+        try {
+            final JSObject ret = new JSObject();
+            ret.put("version", this.PLUGIN_VERSION);
+            call.resolve(ret);
+        } catch (final Exception e) {
+            call.reject("Could not get plugin version", e);
+        }
+    }
 }

package/dist/docs.json

@@ -2,8 +2,13 @@
   "api": {
     "name": "CapacitorShakePlugin",
     "slug": "capacitorshakeplugin",
-    "docs": "",
-    "tags": [],
+    "docs": "Capacitor Shake Plugin interface for detecting shake gestures on mobile devices.\nThis plugin allows you to listen for shake events and get plugin version information.",
+    "tags": [
+      {
+        "text": "1.0.0",
+        "name": "since"
+      }
+    ],
     "methods": [
       {
         "name": "addListener",
@@ -11,22 +16,70 @@
         "parameters": [
           {
             "name": "eventName",
-            "docs": "",
+            "docs": "The shake change event name. Must be 'shake'.",
             "type": "'shake'"
           },
           {
             "name": "listenerFunc",
-            "docs": "",
+            "docs": "Callback function invoked when the phone is shaken.",
             "type": "() => void"
           }
         ],
         "returns": "Promise<PluginListenerHandle>",
-        "tags": [],
-        "docs": "",
+        "tags": [
+          {
+            "name": "since",
+            "text": "1.0.0"
+          },
+          {
+            "name": "param",
+            "text": "eventName The shake change event name. Must be 'shake'."
+          },
+          {
+            "name": "param",
+            "text": "listenerFunc Callback function invoked when the phone is shaken."
+          },
+          {
+            "name": "returns",
+            "text": "A promise that resolves to a listener handle that can be used to remove the listener."
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nconst listener = await CapacitorShake.addListener('shake', () => {\n  console.log('Shake detected!');\n});\n\n// To remove the listener:\nawait listener.remove();\n```"
+          }
+        ],
+        "docs": "Listen for shake event on the device.\n\nRegisters a listener that will be called whenever a shake gesture is detected.\nThe shake detection uses the device's accelerometer to identify shake patterns.",
         "complexTypes": [
           "PluginListenerHandle"
         ],
         "slug": "addlistenershake-"
+      },
+      {
+        "name": "getPluginVersion",
+        "signature": "() => Promise<{ version: string; }>",
+        "parameters": [],
+        "returns": "Promise<{ version: string; }>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "1.0.0"
+          },
+          {
+            "name": "returns",
+            "text": "A promise that resolves with an object containing the version string."
+          },
+          {
+            "name": "throws",
+            "text": "An error if something went wrong retrieving the version."
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nconst { version } = await CapacitorShake.getPluginVersion();\nconsole.log('Plugin version:', version);\n```"
+          }
+        ],
+        "docs": "Get the native Capacitor plugin version.\n\nReturns the current version of the native plugin implementation.",
+        "complexTypes": [],
+        "slug": "getpluginversion"
       }
     ],
     "properties": []

package/dist/esm/definitions.d.ts

@@ -1,4 +1,49 @@
 import type { PluginListenerHandle } from '@capacitor/core';
+/**
+ * Capacitor Shake Plugin interface for detecting shake gestures on mobile devices.
+ * This plugin allows you to listen for shake events and get plugin version information.
+ *
+ * @since 1.0.0
+ */
 export interface CapacitorShakePlugin {
+    /**
+     * Listen for shake event on the device.
+     *
+     * Registers a listener that will be called whenever a shake gesture is detected.
+     * The shake detection uses the device's accelerometer to identify shake patterns.
+     *
+     * @since 1.0.0
+     * @param eventName The shake change event name. Must be 'shake'.
+     * @param listenerFunc Callback function invoked when the phone is shaken.
+     * @returns {Promise<PluginListenerHandle>} A promise that resolves to a listener handle that can be used to remove the listener.
+     *
+     * @example
+     * ```typescript
+     * const listener = await CapacitorShake.addListener('shake', () => {
+     *   console.log('Shake detected!');
+     * });
+     *
+     * // To remove the listener:
+     * await listener.remove();
+     * ```
+     */
     addListener(eventName: 'shake', listenerFunc: () => void): Promise<PluginListenerHandle>;
+    /**
+     * Get the native Capacitor plugin version.
+     *
+     * Returns the current version of the native plugin implementation.
+     *
+     * @since 1.0.0
+     * @returns {Promise<{ version: string }>} A promise that resolves with an object containing the version string.
+     * @throws An error if something went wrong retrieving the version.
+     *
+     * @example
+     * ```typescript
+     * const { version } = await CapacitorShake.getPluginVersion();
+     * console.log('Plugin version:', version);
+     * ```
+     */
+    getPluginVersion(): Promise<{
+        version: string;
+    }>;
 }

package/dist/esm/definitions.js.map

@@ -1 +1 @@
-{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"","sourcesContent":["import type { PluginListenerHandle } from '@capacitor/core';\n\nexport interface CapacitorShakePlugin {\n  addListener(eventName: 'shake', listenerFunc: () => void): Promise<PluginListenerHandle>;\n}\n"]}
+{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"","sourcesContent":["import type { PluginListenerHandle } from '@capacitor/core';\n\n/**\n * Capacitor Shake Plugin interface for detecting shake gestures on mobile devices.\n * This plugin allows you to listen for shake events and get plugin version information.\n *\n * @since 1.0.0\n */\nexport interface CapacitorShakePlugin {\n  /**\n   * Listen for shake event on the device.\n   *\n   * Registers a listener that will be called whenever a shake gesture is detected.\n   * The shake detection uses the device's accelerometer to identify shake patterns.\n   *\n   * @since 1.0.0\n   * @param eventName The shake change event name. Must be 'shake'.\n   * @param listenerFunc Callback function invoked when the phone is shaken.\n   * @returns {Promise<PluginListenerHandle>} A promise that resolves to a listener handle that can be used to remove the listener.\n   *\n   * @example\n   * ```typescript\n   * const listener = await CapacitorShake.addListener('shake', () => {\n   *   console.log('Shake detected!');\n   * });\n   *\n   * // To remove the listener:\n   * await listener.remove();\n   * ```\n   */\n  addListener(eventName: 'shake', listenerFunc: () => void): Promise<PluginListenerHandle>;\n\n  /**\n   * Get the native Capacitor plugin version.\n   *\n   * Returns the current version of the native plugin implementation.\n   *\n   * @since 1.0.0\n   * @returns {Promise<{ version: string }>} A promise that resolves with an object containing the version string.\n   * @throws An error if something went wrong retrieving the version.\n   *\n   * @example\n   * ```typescript\n   * const { version } = await CapacitorShake.getPluginVersion();\n   * console.log('Plugin version:', version);\n   * ```\n   */\n  getPluginVersion(): Promise<{ version: string }>;\n}\n"]}

package/dist/esm/web.d.ts

@@ -1,4 +1,7 @@
 import { WebPlugin } from '@capacitor/core';
 import type { CapacitorShakePlugin } from './definitions';
 export declare class CapacitorShakeWeb extends WebPlugin implements CapacitorShakePlugin {
+    getPluginVersion(): Promise<{
+        version: string;
+    }>;
 }

package/dist/esm/web.js

@@ -1,4 +1,7 @@
 import { WebPlugin } from '@capacitor/core';
 export class CapacitorShakeWeb extends WebPlugin {
+    async getPluginVersion() {
+        return { version: 'web' };
+    }
 }
 //# sourceMappingURL=web.js.map

package/dist/esm/web.js.map

@@ -1 +1 @@
-{"version":3,"file":"web.js","sourceRoot":"","sources":["../../src/web.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAI5C,MAAM,OAAO,iBAAkB,SAAQ,SAAS;CAAmC","sourcesContent":["import { WebPlugin } from '@capacitor/core';\n\nimport type { CapacitorShakePlugin } from './definitions';\n\nexport class CapacitorShakeWeb extends WebPlugin implements CapacitorShakePlugin {}\n"]}
+{"version":3,"file":"web.js","sourceRoot":"","sources":["../../src/web.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAI5C,MAAM,OAAO,iBAAkB,SAAQ,SAAS;IAC9C,KAAK,CAAC,gBAAgB;QACpB,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;IAC5B,CAAC;CACF","sourcesContent":["import { WebPlugin } from '@capacitor/core';\n\nimport type { CapacitorShakePlugin } from './definitions';\n\nexport class CapacitorShakeWeb extends WebPlugin implements CapacitorShakePlugin {\n  async getPluginVersion(): Promise<{ version: string }> {\n    return { version: 'web' };\n  }\n}\n"]}

package/dist/plugin.cjs.js

@@ -7,6 +7,9 @@ const CapacitorShake = core.registerPlugin('CapacitorShake', {
 });
 
 class CapacitorShakeWeb extends core.WebPlugin {
+    async getPluginVersion() {
+        return { version: 'web' };
+    }
 }
 
 var web = /*#__PURE__*/Object.freeze({

package/dist/plugin.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"plugin.cjs.js","sources":["esm/index.js","esm/web.js"],"sourcesContent":["import { registerPlugin } from '@capacitor/core';\nconst CapacitorShake = registerPlugin('CapacitorShake', {\n    web: () => import('./web').then((m) => new m.CapacitorShakeWeb()),\n});\nexport * from './definitions';\nexport { CapacitorShake };\n//# sourceMappingURL=index.js.map","import { WebPlugin } from '@capacitor/core';\nexport class CapacitorShakeWeb extends WebPlugin {\n}\n//# sourceMappingURL=web.js.map"],"names":["registerPlugin","WebPlugin"],"mappings":";;;;AACK,MAAC,cAAc,GAAGA,mBAAc,CAAC,gBAAgB,EAAE;AACxD,IAAI,GAAG,EAAE,MAAM,mDAAe,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC,iBAAiB,EAAE,CAAC;AACrE,CAAC;;ACFM,MAAM,iBAAiB,SAASC,cAAS,CAAC;AACjD;;;;;;;;;"}
+{"version":3,"file":"plugin.cjs.js","sources":["esm/index.js","esm/web.js"],"sourcesContent":["import { registerPlugin } from '@capacitor/core';\nconst CapacitorShake = registerPlugin('CapacitorShake', {\n    web: () => import('./web').then((m) => new m.CapacitorShakeWeb()),\n});\nexport * from './definitions';\nexport { CapacitorShake };\n//# sourceMappingURL=index.js.map","import { WebPlugin } from '@capacitor/core';\nexport class CapacitorShakeWeb extends WebPlugin {\n    async getPluginVersion() {\n        return { version: 'web' };\n    }\n}\n//# sourceMappingURL=web.js.map"],"names":["registerPlugin","WebPlugin"],"mappings":";;;;AACK,MAAC,cAAc,GAAGA,mBAAc,CAAC,gBAAgB,EAAE;AACxD,IAAI,GAAG,EAAE,MAAM,mDAAe,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC,iBAAiB,EAAE,CAAC;AACrE,CAAC;;ACFM,MAAM,iBAAiB,SAASC,cAAS,CAAC;AACjD,IAAI,MAAM,gBAAgB,GAAG;AAC7B,QAAQ,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE;AACjC,IAAI;AACJ;;;;;;;;;"}

package/dist/plugin.js

@@ -6,6 +6,9 @@ var capacitorCapacitorUpdater = (function (exports, core) {
     });
 
     class CapacitorShakeWeb extends core.WebPlugin {
+        async getPluginVersion() {
+            return { version: 'web' };
+        }
     }
 
     var web = /*#__PURE__*/Object.freeze({

package/dist/plugin.js.map

@@ -1 +1 @@
-{"version":3,"file":"plugin.js","sources":["esm/index.js","esm/web.js"],"sourcesContent":["import { registerPlugin } from '@capacitor/core';\nconst CapacitorShake = registerPlugin('CapacitorShake', {\n    web: () => import('./web').then((m) => new m.CapacitorShakeWeb()),\n});\nexport * from './definitions';\nexport { CapacitorShake };\n//# sourceMappingURL=index.js.map","import { WebPlugin } from '@capacitor/core';\nexport class CapacitorShakeWeb extends WebPlugin {\n}\n//# sourceMappingURL=web.js.map"],"names":["registerPlugin","WebPlugin"],"mappings":";;;AACK,UAAC,cAAc,GAAGA,mBAAc,CAAC,gBAAgB,EAAE;IACxD,IAAI,GAAG,EAAE,MAAM,mDAAe,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC,iBAAiB,EAAE,CAAC;IACrE,CAAC;;ICFM,MAAM,iBAAiB,SAASC,cAAS,CAAC;IACjD;;;;;;;;;;;;;;;"}
+{"version":3,"file":"plugin.js","sources":["esm/index.js","esm/web.js"],"sourcesContent":["import { registerPlugin } from '@capacitor/core';\nconst CapacitorShake = registerPlugin('CapacitorShake', {\n    web: () => import('./web').then((m) => new m.CapacitorShakeWeb()),\n});\nexport * from './definitions';\nexport { CapacitorShake };\n//# sourceMappingURL=index.js.map","import { WebPlugin } from '@capacitor/core';\nexport class CapacitorShakeWeb extends WebPlugin {\n    async getPluginVersion() {\n        return { version: 'web' };\n    }\n}\n//# sourceMappingURL=web.js.map"],"names":["registerPlugin","WebPlugin"],"mappings":";;;AACK,UAAC,cAAc,GAAGA,mBAAc,CAAC,gBAAgB,EAAE;IACxD,IAAI,GAAG,EAAE,MAAM,mDAAe,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC,iBAAiB,EAAE,CAAC;IACrE,CAAC;;ICFM,MAAM,iBAAiB,SAASC,cAAS,CAAC;IACjD,IAAI,MAAM,gBAAgB,GAAG;IAC7B,QAAQ,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE;IACjC,IAAI;IACJ;;;;;;;;;;;;;;;"}

package/ios/Sources/CapacitorShakePlugin/CapacitorShakePlugin.swift

@@ -20,9 +20,11 @@ extension UIWindow {
  */
 @objc(CapacitorShakePlugin)
 public class CapacitorShakePlugin: CAPPlugin, CAPBridgedPlugin {
+    private let PLUGIN_VERSION: String = "7.2.4"
     public let identifier = "CapacitorShakePlugin"
     public let jsName = "CapacitorShake"
     public let pluginMethods: [CAPPluginMethod] = [
+        CAPPluginMethod(name: "getPluginVersion", returnType: CAPPluginReturnPromise)
     ]
 
     override public func load() {
@@ -41,4 +43,9 @@ public class CapacitorShakePlugin: CAPPlugin, CAPBridgedPlugin {
         print("Shake detected")
         notifyListeners("shake", data: [:])
     }
+
+    @objc func getPluginVersion(_ call: CAPPluginCall) {
+        call.resolve(["version": self.PLUGIN_VERSION])
+    }
+
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@capgo/capacitor-shake",
-  "version": "7.1.29",
+  "version": "7.2.4",
   "description": "Detect shake gesture in device",
   "main": "dist/plugin.cjs.js",
   "module": "dist/esm/index.js",