@capacitor/motion 1.0.0 → 1.0.5

package/CHANGELOG.md

@@ -3,6 +3,52 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [1.0.5](https://github.com/ionic-team/capacitor-plugins/compare/@capacitor/motion@1.0.4...@capacitor/motion@1.0.5) (2022-01-19)
+
+
+### Bug Fixes
+
+* inline source code in esm map files ([#760](https://github.com/ionic-team/capacitor-plugins/issues/760)) ([a960489](https://github.com/ionic-team/capacitor-plugins/commit/a960489a19db0182b90d187a50deff9dfbe51038))
+
+
+
+
+
+## [1.0.4](https://github.com/ionic-team/capacitor-plugins/compare/@capacitor/motion@1.0.3...@capacitor/motion@1.0.4) (2021-11-17)
+
+**Note:** Version bump only for package @capacitor/motion
+
+
+
+
+
+## [1.0.3](https://github.com/ionic-team/capacitor-plugins/compare/@capacitor/motion@1.0.2...@capacitor/motion@1.0.3) (2021-10-13)
+
+
+### Bug Fixes
+
+* correct addListeners links ([#655](https://github.com/ionic-team/capacitor-plugins/issues/655)) ([f9871e7](https://github.com/ionic-team/capacitor-plugins/commit/f9871e7bd53478addb21155e148829f550c0e457))
+
+
+
+
+
+## [1.0.2](https://github.com/ionic-team/capacitor-plugins/compare/@capacitor/motion@1.0.1...@capacitor/motion@1.0.2) (2021-06-23)
+
+**Note:** Version bump only for package @capacitor/motion
+
+
+
+
+
+## [1.0.1](https://github.com/ionic-team/capacitor-plugins/compare/@capacitor/motion@1.0.0...@capacitor/motion@1.0.1) (2021-06-09)
+
+**Note:** Version bump only for package @capacitor/motion
+
+
+
+
+
 # [1.0.0](https://github.com/ionic-team/capacitor-plugins/compare/@capacitor/motion@0.3.8...@capacitor/motion@1.0.0) (2021-05-19)
 
 **Note:** Version bump only for package @capacitor/motion

package/README.md

@@ -16,8 +16,12 @@ permission before using this API. To request permission, prompt the user for
 permission on any user-initiated action (such as a button click):
 
 ```typescript
+import { PluginListenerHandle } from '@capacitor/core';
 import { Motion } from '@capacitor/motion';
 
+
+let accelHandler: PluginListenerHandle;
+
 myButton.addEventListener('click', async () => {
   try {
     await DeviceMotionEvent.requestPermission();
@@ -27,10 +31,22 @@ myButton.addEventListener('click', async () => {
   }
 
   // Once the user approves, can start listening:
-  Motion.addListener('accel', event => {
+  accelHandler = await Motion.addListener('accel', event => {
     console.log('Device motion event:', event);
   });
 });
+
+// Stop the acceleration listener
+const stopAcceleration = () => {
+  if (accelHandler) {
+    accelHandler.remove();
+  }
+};
+
+// Remove all listeners
+const removeListeners = () => {
+  Motion.removeAllListeners();
+};
 ```
 
 See the
@@ -41,8 +57,8 @@ API to understand the data supplied in the 'accel' event.
 
 <docgen-index>
 
-* [`addListener('accel', ...)`](#addlisteneraccel-)
-* [`addListener('orientation', ...)`](#addlistenerorientation-)
+* [`addListener('accel', ...)`](#addlisteneraccel)
+* [`addListener('orientation', ...)`](#addlistenerorientation)
 * [`removeAllListeners()`](#removealllisteners)
 * [Interfaces](#interfaces)
 * [Type Aliases](#type-aliases)

package/dist/docs.json

@@ -32,7 +32,7 @@
           "PluginListenerHandle",
           "AccelListener"
         ],
-        "slug": "addlisteneraccel-"
+        "slug": "addlisteneraccel"
       },
       {
         "name": "addListener",
@@ -61,7 +61,7 @@
           "PluginListenerHandle",
           "OrientationListener"
         ],
-        "slug": "addlistenerorientation-"
+        "slug": "addlistenerorientation"
       },
       {
         "name": "removeAllListeners",

package/dist/esm/definitions.js.map

@@ -1 +1 @@
-{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":""}
+{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"","sourcesContent":["import type { PluginListenerHandle } from '@capacitor/core';\n\nexport interface MotionPlugin {\n  /**\n   * Add a listener for accelerometer data\n   *\n   * @since 1.0.0\n   */\n  addListener(\n    eventName: 'accel',\n    listenerFunc: AccelListener,\n  ): Promise<PluginListenerHandle> & PluginListenerHandle;\n\n  /**\n   * Add a listener for device orientation change (compass heading, etc.)\n   *\n   * @since 1.0.0\n   */\n  addListener(\n    eventName: 'orientation',\n    listenerFunc: OrientationListener,\n  ): Promise<PluginListenerHandle> & PluginListenerHandle;\n\n  /**\n   * Remove all the listeners that are attached to this plugin.\n   *\n   * @since 1.0.0\n   */\n  removeAllListeners(): Promise<void>;\n}\n\nexport type AccelListener = (event: AccelListenerEvent) => void;\nexport type OrientationListener = (event: OrientationListenerEvent) => void;\nexport type OrientationListenerEvent = RotationRate;\n\nexport interface RotationRate {\n  /**\n   * The amount of rotation around the Z axis, in degrees per second.\n   *\n   * @since 1.0.0\n   */\n  alpha: number;\n\n  /**\n   * The amount of rotation around the X axis, in degrees per second.\n   *\n   * @since 1.0.0\n   */\n  beta: number;\n\n  /**\n   * The amount of rotation around the Y axis, in degrees per second.\n   *\n   * @since 1.0.0\n   */\n  gamma: number;\n}\n\nexport interface Acceleration {\n  /**\n   * The amount of acceleration along the X axis.\n   *\n   * @since 1.0.0\n   */\n  x: number;\n\n  /**\n   * The amount of acceleration along the Y axis.\n   *\n   * @since 1.0.0\n   */\n  y: number;\n\n  /**\n   * The amount of acceleration along the Z axis.\n   *\n   * @since 1.0.0\n   */\n  z: number;\n}\n\nexport interface AccelListenerEvent {\n  /**\n   * An object giving the acceleration of the device on the three axis X, Y and Z. Acceleration is expressed in m/s\n   *\n   * @since 1.0.0\n   */\n  acceleration: Acceleration;\n\n  /**\n   * An object giving the acceleration of the device on the three axis X, Y and Z with the effect of gravity. Acceleration is expressed in m/s\n   *\n   * @since 1.0.0\n   */\n  accelerationIncludingGravity: Acceleration;\n\n  /**\n   * An object giving the rate of change of the device's orientation on the three orientation axis alpha, beta and gamma. Rotation rate is expressed in degrees per seconds.\n   *\n   * @since 1.0.0\n   */\n  rotationRate: RotationRate;\n\n  /**\n   * A number representing the interval of time, in milliseconds, at which data is obtained from the device.\n   *\n   * @since 1.0.0\n   */\n  interval: number;\n}\n\n/**\n * @deprecated Use `AccelListener`.\n * @since 1.0.0\n */\nexport type MotionWatchAccelCallback = AccelListener;\n\n/**\n * @deprecated Use `AccelListenerEvent`.\n * @since 1.0.0\n */\nexport type MotionEventResult = AccelListenerEvent;\n\n/**\n * @deprecated Use `OrientationListener`.\n * @since 1.0.0\n */\nexport type MotionWatchOrientationCallback = OrientationListener;\n\n/**\n * @deprecated Use `OrientationListenerEvent`.\n * @since 1.0.0\n */\nexport type MotionOrientationEventResult = OrientationListenerEvent;\n"]}

package/dist/esm/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAIjD,MAAM,MAAM,GAAG,cAAc,CAAe,QAAQ,EAAE;IACpD,OAAO,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,CAAC;IAC3D,GAAG,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,CAAC;IACvD,GAAG,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,CAAC;CACxD,CAAC,CAAC;AAEH,cAAc,eAAe,CAAC;AAC9B,OAAO,EAAE,MAAM,EAAE,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAIjD,MAAM,MAAM,GAAG,cAAc,CAAe,QAAQ,EAAE;IACpD,OAAO,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,CAAC;IAC3D,GAAG,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,CAAC;IACvD,GAAG,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,CAAC;CACxD,CAAC,CAAC;AAEH,cAAc,eAAe,CAAC;AAC9B,OAAO,EAAE,MAAM,EAAE,CAAC","sourcesContent":["import { registerPlugin } from '@capacitor/core';\n\nimport type { MotionPlugin } from './definitions';\n\nconst Motion = registerPlugin<MotionPlugin>('Motion', {\n  android: () => import('./web').then(m => new m.MotionWeb()),\n  ios: () => import('./web').then(m => new m.MotionWeb()),\n  web: () => import('./web').then(m => new m.MotionWeb()),\n});\n\nexport * from './definitions';\nexport { Motion };\n"]}

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,SAAU,SAAQ,SAAS;IACtC;QACE,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,sBAAsB,CAAC,cAAc,EAAE,OAAO,CAAC,CAAC;QACrD,IAAI,CAAC,sBAAsB,CAAC,mBAAmB,EAAE,aAAa,CAAC,CAAC;IAClE,CAAC;CACF"}
+{"version":3,"file":"web.js","sourceRoot":"","sources":["../../src/web.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAI5C,MAAM,OAAO,SAAU,SAAQ,SAAS;IACtC;QACE,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,sBAAsB,CAAC,cAAc,EAAE,OAAO,CAAC,CAAC;QACrD,IAAI,CAAC,sBAAsB,CAAC,mBAAmB,EAAE,aAAa,CAAC,CAAC;IAClE,CAAC;CACF","sourcesContent":["import { WebPlugin } from '@capacitor/core';\n\nimport type { MotionPlugin } from './definitions';\n\nexport class MotionWeb extends WebPlugin implements MotionPlugin {\n  constructor() {\n    super();\n    this.registerWindowListener('devicemotion', 'accel');\n    this.registerWindowListener('deviceorientation', 'orientation');\n  }\n}\n"]}

package/dist/plugin.js

@@ -26,5 +26,5 @@ var capacitorMotion = (function (exports, core) {
 
     return exports;
 
-}({}, capacitorExports));
+})({}, capacitorExports);
 //# sourceMappingURL=plugin.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@capacitor/motion",
-  "version": "1.0.0",
+  "version": "1.0.5",
   "description": "The Motion API tracks accelerometer and device orientation (compass heading, etc.)",
   "main": "dist/plugin.cjs.js",
   "module": "dist/esm/index.js",
@@ -39,10 +39,10 @@
     "prepublishOnly": "npm run build"
   },
   "devDependencies": {
-    "@capacitor/android": "3.0.0",
-    "@capacitor/core": "3.0.0",
-    "@capacitor/docgen": "0.0.16",
-    "@capacitor/ios": "3.0.0",
+    "@capacitor/android": "^3.0.0",
+    "@capacitor/core": "^3.0.0",
+    "@capacitor/docgen": "0.0.18",
+    "@capacitor/ios": "^3.0.0",
     "@ionic/eslint-config": "^0.3.0",
     "@ionic/prettier-config": "~1.0.1",
     "eslint": "^7.11.0",
@@ -53,7 +53,7 @@
     "typescript": "~4.1.5"
   },
   "peerDependencies": {
-    "@capacitor/core": "3.0.0"
+    "@capacitor/core": "^3.0.0"
   },
   "prettier": "@ionic/prettier-config",
   "eslintConfig": {
@@ -63,5 +63,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "d264b9e6547d97e86258e067bd37254311d9f1a5"
+  "gitHead": "f18ee6482e1ec8e5fb0290d51f598397133af990"
 }