expo-keep-awake 10.1.0 → 10.2.1

package/CHANGELOG.md

@@ -10,6 +10,22 @@
 
 ### 💡 Others
 
+## 10.2.1 — 2022-08-08
+
+### 🐛 Bug fixes
+
+- Attempt to fix `EXC_BAD_ACCESS` and `NSInvalidArgumentException` crashes by not referencing to the class instance function. ([#18553](https://github.com/expo/expo/pull/18553) by [@tsapeta](https://github.com/tsapeta))
+
+## 10.2.0 — 2022-07-07
+
+### 🐛 Bug fixes
+
+- Fixed `Unable to deactivate keep awake. However, it probably is deactivated already` unhandled promise rejection warning when resuming apps on Android. ([#17319](https://github.com/expo/expo/pull/17319) by [@kudo](https://github.com/kudo))
+
+### 💡 Others
+
+- Migrated Expo modules definitions to the new naming convention. ([#17193](https://github.com/expo/expo/pull/17193) by [@tsapeta](https://github.com/tsapeta))
+
 ## 10.1.0 — 2022-04-18
 
 ### 🎉 New features

package/android/build.gradle

@@ -3,7 +3,7 @@ apply plugin: 'kotlin-android'
 apply plugin: 'maven-publish'
 
 group = 'host.exp.exponent'
-version = '10.1.0'
+version = '10.2.1'
 
 buildscript {
   def expoModulesCorePlugin = new File(project(":expo-modules-core").projectDir.absolutePath, "ExpoModulesCorePlugin.gradle")
@@ -74,7 +74,7 @@ android {
     minSdkVersion safeExtGet("minSdkVersion", 21)
     targetSdkVersion safeExtGet("targetSdkVersion", 31)
     versionCode 16
-    versionName "10.1.0"
+    versionName "10.2.1"
   }
   lintOptions {
     abortOnError false

package/build/index.d.ts

@@ -1,11 +1,20 @@
+export declare const ExpoKeepAwakeTag = "ExpoKeepAwakeDefaultTag";
 /**
  * A React hook to keep the screen awake for as long as the owner component is mounted.
  * The optionally provided `tag` argument is used when activating and deactivating the keep-awake
  * feature. If unspecified, the default `tag` is used. See the documentation for `activateKeepAwake`
  * below to learn more about the `tag` argument.
- * @param tag *Optional*
+ *
+ * @param tag *Optional* - Tag to lock screen sleep prevention. If not provided, the default tag is used.
+ * @param options *Optional*
+ *   - `suppressDeactivateWarnings` *Optional* -
+ *      The call will throw an unhandled promise rejection on Android
+ *      when the original Activity is dead or deactivated.
+ *      Set the value to true for suppressing the uncaught exception.
  */
-export declare function useKeepAwake(tag?: string): void;
+export declare function useKeepAwake(tag?: string, options?: {
+    suppressDeactivateWarnings: boolean;
+}): void;
 /**
  * Prevents the screen from sleeping until `deactivateKeepAwake` is called with the same `tag` value.
  *
@@ -14,12 +23,12 @@ export declare function useKeepAwake(tag?: string): void;
  * each one in order to re-enable screen sleep. If tag is unspecified, the default `tag` is used.
  * @param tag *Optional* - Tag to lock screen sleep prevention. If not provided, the default tag is used.
  */
-export declare function activateKeepAwake(tag?: string): void;
+export declare function activateKeepAwake(tag?: string): Promise<void>;
 /**
  * Releases the lock on screen-sleep prevention associated with the given `tag` value. If `tag`
  * is unspecified, it defaults to the same default tag that `activateKeepAwake` uses.
  * @param tag *Optional* - Tag to release the lock on screen sleep prevention. If not provided,
  * the default tag is used.
  */
-export declare function deactivateKeepAwake(tag?: string): void;
+export declare function deactivateKeepAwake(tag?: string): Promise<void>;
 //# sourceMappingURL=index.d.ts.map

package/build/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAOA;;;;;;GAMG;AACH,wBAAgB,YAAY,CAAC,GAAG,GAAE,MAAyB,GAAG,IAAI,CAKjE;AAGD;;;;;;;GAOG;AAEH,wBAAgB,iBAAiB,CAAC,GAAG,GAAE,MAAyB,GAAG,IAAI,CAEtE;AAGD;;;;;GAKG;AACH,wBAAgB,mBAAmB,CAAC,GAAG,GAAE,MAAyB,GAAG,IAAI,CAExE"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAIA,eAAO,MAAM,gBAAgB,4BAA4B,CAAC;AAG1D;;;;;;;;;;;;GAYG;AACH,wBAAgB,YAAY,CAC1B,GAAG,GAAE,MAAyB,EAC9B,OAAO,CAAC,EAAE;IACR,0BAA0B,EAAE,OAAO,CAAC;CACrC,GACA,IAAI,CAWN;AAGD;;;;;;;GAOG;AAEH,wBAAsB,iBAAiB,CAAC,GAAG,GAAE,MAAyB,GAAG,OAAO,CAAC,IAAI,CAAC,CAErF;AAGD;;;;;GAKG;AACH,wBAAsB,mBAAmB,CAAC,GAAG,GAAE,MAAyB,GAAG,OAAO,CAAC,IAAI,CAAC,CAEvF"}

package/build/index.js

@@ -1,18 +1,31 @@
 import { useEffect } from 'react';
 import ExpoKeepAwake from './ExpoKeepAwake';
-const ExpoKeepAwakeTag = 'ExpoKeepAwakeDefaultTag';
+export const ExpoKeepAwakeTag = 'ExpoKeepAwakeDefaultTag';
 // @needsAudit
 /**
  * A React hook to keep the screen awake for as long as the owner component is mounted.
  * The optionally provided `tag` argument is used when activating and deactivating the keep-awake
  * feature. If unspecified, the default `tag` is used. See the documentation for `activateKeepAwake`
  * below to learn more about the `tag` argument.
- * @param tag *Optional*
+ *
+ * @param tag *Optional* - Tag to lock screen sleep prevention. If not provided, the default tag is used.
+ * @param options *Optional*
+ *   - `suppressDeactivateWarnings` *Optional* -
+ *      The call will throw an unhandled promise rejection on Android
+ *      when the original Activity is dead or deactivated.
+ *      Set the value to true for suppressing the uncaught exception.
  */
-export function useKeepAwake(tag = ExpoKeepAwakeTag) {
+export function useKeepAwake(tag = ExpoKeepAwakeTag, options) {
     useEffect(() => {
         activateKeepAwake(tag);
-        return () => deactivateKeepAwake(tag);
+        return () => {
+            if (options?.suppressDeactivateWarnings) {
+                deactivateKeepAwake(tag).catch(() => { });
+            }
+            else {
+                deactivateKeepAwake(tag);
+            }
+        };
     }, [tag]);
 }
 // @needsAudit
@@ -24,9 +37,8 @@ export function useKeepAwake(tag = ExpoKeepAwakeTag) {
  * each one in order to re-enable screen sleep. If tag is unspecified, the default `tag` is used.
  * @param tag *Optional* - Tag to lock screen sleep prevention. If not provided, the default tag is used.
  */
-export function activateKeepAwake(tag = ExpoKeepAwakeTag) {
-    if (ExpoKeepAwake.activate)
-        ExpoKeepAwake.activate(tag);
+export async function activateKeepAwake(tag = ExpoKeepAwakeTag) {
+    await ExpoKeepAwake.activate?.(tag);
 }
 // @needsAudit
 /**
@@ -35,8 +47,7 @@ export function activateKeepAwake(tag = ExpoKeepAwakeTag) {
  * @param tag *Optional* - Tag to release the lock on screen sleep prevention. If not provided,
  * the default tag is used.
  */
-export function deactivateKeepAwake(tag = ExpoKeepAwakeTag) {
-    if (ExpoKeepAwake.deactivate)
-        ExpoKeepAwake.deactivate(tag);
+export async function deactivateKeepAwake(tag = ExpoKeepAwakeTag) {
+    await ExpoKeepAwake.deactivate?.(tag);
 }
 //# sourceMappingURL=index.js.map

package/build/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAElC,OAAO,aAAa,MAAM,iBAAiB,CAAC;AAE5C,MAAM,gBAAgB,GAAG,yBAAyB,CAAC;AAEnD,cAAc;AACd;;;;;;GAMG;AACH,MAAM,UAAU,YAAY,CAAC,MAAc,gBAAgB;IACzD,SAAS,CAAC,GAAG,EAAE;QACb,iBAAiB,CAAC,GAAG,CAAC,CAAC;QACvB,OAAO,GAAG,EAAE,CAAC,mBAAmB,CAAC,GAAG,CAAC,CAAC;IACxC,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;AACZ,CAAC;AAED,cAAc;AACd;;;;;;;GAOG;AAEH,MAAM,UAAU,iBAAiB,CAAC,MAAc,gBAAgB;IAC9D,IAAI,aAAa,CAAC,QAAQ;QAAE,aAAa,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;AAC1D,CAAC;AAED,cAAc;AACd;;;;;GAKG;AACH,MAAM,UAAU,mBAAmB,CAAC,MAAc,gBAAgB;IAChE,IAAI,aAAa,CAAC,UAAU;QAAE,aAAa,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;AAC9D,CAAC","sourcesContent":["import { useEffect } from 'react';\n\nimport ExpoKeepAwake from './ExpoKeepAwake';\n\nconst ExpoKeepAwakeTag = 'ExpoKeepAwakeDefaultTag';\n\n// @needsAudit\n/**\n * A React hook to keep the screen awake for as long as the owner component is mounted.\n * The optionally provided `tag` argument is used when activating and deactivating the keep-awake\n * feature. If unspecified, the default `tag` is used. See the documentation for `activateKeepAwake`\n * below to learn more about the `tag` argument.\n * @param tag *Optional*\n */\nexport function useKeepAwake(tag: string = ExpoKeepAwakeTag): void {\n  useEffect(() => {\n    activateKeepAwake(tag);\n    return () => deactivateKeepAwake(tag);\n  }, [tag]);\n}\n\n// @needsAudit\n/**\n * Prevents the screen from sleeping until `deactivateKeepAwake` is called with the same `tag` value.\n *\n * If the `tag` argument is specified, the screen will not sleep until you call `deactivateKeepAwake`\n * with the same `tag` argument. When using multiple `tags` for activation you'll have to deactivate\n * each one in order to re-enable screen sleep. If tag is unspecified, the default `tag` is used.\n * @param tag *Optional* - Tag to lock screen sleep prevention. If not provided, the default tag is used.\n */\n\nexport function activateKeepAwake(tag: string = ExpoKeepAwakeTag): void {\n  if (ExpoKeepAwake.activate) ExpoKeepAwake.activate(tag);\n}\n\n// @needsAudit\n/**\n * Releases the lock on screen-sleep prevention associated with the given `tag` value. If `tag`\n * is unspecified, it defaults to the same default tag that `activateKeepAwake` uses.\n * @param tag *Optional* - Tag to release the lock on screen sleep prevention. If not provided,\n * the default tag is used.\n */\nexport function deactivateKeepAwake(tag: string = ExpoKeepAwakeTag): void {\n  if (ExpoKeepAwake.deactivate) ExpoKeepAwake.deactivate(tag);\n}\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAElC,OAAO,aAAa,MAAM,iBAAiB,CAAC;AAE5C,MAAM,CAAC,MAAM,gBAAgB,GAAG,yBAAyB,CAAC;AAE1D,cAAc;AACd;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,YAAY,CAC1B,MAAc,gBAAgB,EAC9B,OAEC;IAED,SAAS,CAAC,GAAG,EAAE;QACb,iBAAiB,CAAC,GAAG,CAAC,CAAC;QACvB,OAAO,GAAG,EAAE;YACV,IAAI,OAAO,EAAE,0BAA0B,EAAE;gBACvC,mBAAmB,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;aAC1C;iBAAM;gBACL,mBAAmB,CAAC,GAAG,CAAC,CAAC;aAC1B;QACH,CAAC,CAAC;IACJ,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;AACZ,CAAC;AAED,cAAc;AACd;;;;;;;GAOG;AAEH,MAAM,CAAC,KAAK,UAAU,iBAAiB,CAAC,MAAc,gBAAgB;IACpE,MAAM,aAAa,CAAC,QAAQ,EAAE,CAAC,GAAG,CAAC,CAAC;AACtC,CAAC;AAED,cAAc;AACd;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,mBAAmB,CAAC,MAAc,gBAAgB;IACtE,MAAM,aAAa,CAAC,UAAU,EAAE,CAAC,GAAG,CAAC,CAAC;AACxC,CAAC","sourcesContent":["import { useEffect } from 'react';\n\nimport ExpoKeepAwake from './ExpoKeepAwake';\n\nexport const ExpoKeepAwakeTag = 'ExpoKeepAwakeDefaultTag';\n\n// @needsAudit\n/**\n * A React hook to keep the screen awake for as long as the owner component is mounted.\n * The optionally provided `tag` argument is used when activating and deactivating the keep-awake\n * feature. If unspecified, the default `tag` is used. See the documentation for `activateKeepAwake`\n * below to learn more about the `tag` argument.\n *\n * @param tag *Optional* - Tag to lock screen sleep prevention. If not provided, the default tag is used.\n * @param options *Optional*\n *   - `suppressDeactivateWarnings` *Optional* -\n *      The call will throw an unhandled promise rejection on Android\n *      when the original Activity is dead or deactivated.\n *      Set the value to true for suppressing the uncaught exception.\n */\nexport function useKeepAwake(\n  tag: string = ExpoKeepAwakeTag,\n  options?: {\n    suppressDeactivateWarnings: boolean;\n  }\n): void {\n  useEffect(() => {\n    activateKeepAwake(tag);\n    return () => {\n      if (options?.suppressDeactivateWarnings) {\n        deactivateKeepAwake(tag).catch(() => {});\n      } else {\n        deactivateKeepAwake(tag);\n      }\n    };\n  }, [tag]);\n}\n\n// @needsAudit\n/**\n * Prevents the screen from sleeping until `deactivateKeepAwake` is called with the same `tag` value.\n *\n * If the `tag` argument is specified, the screen will not sleep until you call `deactivateKeepAwake`\n * with the same `tag` argument. When using multiple `tags` for activation you'll have to deactivate\n * each one in order to re-enable screen sleep. If tag is unspecified, the default `tag` is used.\n * @param tag *Optional* - Tag to lock screen sleep prevention. If not provided, the default tag is used.\n */\n\nexport async function activateKeepAwake(tag: string = ExpoKeepAwakeTag): Promise<void> {\n  await ExpoKeepAwake.activate?.(tag);\n}\n\n// @needsAudit\n/**\n * Releases the lock on screen-sleep prevention associated with the given `tag` value. If `tag`\n * is unspecified, it defaults to the same default tag that `activateKeepAwake` uses.\n * @param tag *Optional* - Tag to release the lock on screen sleep prevention. If not provided,\n * the default tag is used.\n */\nexport async function deactivateKeepAwake(tag: string = ExpoKeepAwakeTag): Promise<void> {\n  await ExpoKeepAwake.deactivate?.(tag);\n}\n"]}

package/ios/KeepAwakeModule.swift

@@ -6,44 +6,41 @@ public final class KeepAwakeModule: Module {
   private var activeTags = Set<String>()
 
   public func definition() -> ModuleDefinition {
-    name("ExpoKeepAwake")
+    Name("ExpoKeepAwake")
 
-    function("activate", activate)
-    function("deactivate", deactivate)
-    function("isActivated", isActivated)
-
-    onAppEntersForeground {
-      if !self.activeTags.isEmpty {
+    AsyncFunction("activate") { (tag: String) -> Bool in
+      if self.activeTags.isEmpty {
         setActivated(true)
       }
+      self.activeTags.insert(tag)
+      return true
     }
-    onAppEntersBackground {
-      if !self.activeTags.isEmpty {
+
+    AsyncFunction("deactivate") { (tag: String) -> Bool in
+      self.activeTags.remove(tag)
+      if self.activeTags.isEmpty {
         setActivated(false)
       }
+      return true
     }
-  }
 
-  private func activate(tag: String) -> Bool {
-    if activeTags.isEmpty {
-      setActivated(true)
+    AsyncFunction("isActivated") { () -> Bool in
+      return DispatchQueue.main.sync {
+        return UIApplication.shared.isIdleTimerDisabled
+      }
     }
-    activeTags.insert(tag)
-    return true
-  }
 
-  private func deactivate(tag: String) -> Bool {
-    activeTags.remove(tag)
-    if activeTags.isEmpty {
-      setActivated(false)
+    OnAppEntersForeground {
+      if !self.activeTags.isEmpty {
+        setActivated(true)
+      }
     }
-    return true
-  }
-}
 
-private func isActivated() -> Bool {
-  return DispatchQueue.main.sync {
-    return UIApplication.shared.isIdleTimerDisabled
+    OnAppEntersBackground {
+      if !self.activeTags.isEmpty {
+        setActivated(false)
+      }
+    }
   }
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "expo-keep-awake",
-  "version": "10.1.0",
+  "version": "10.2.1",
   "description": "Provides a React component that prevents the screen sleeping when rendered. It also exposes static methods to control the behavior imperatively.",
   "main": "build/index.js",
   "types": "build/index.d.ts",
@@ -33,10 +33,14 @@
   "homepage": "https://docs.expo.dev/versions/latest/sdk/keep-awake/",
   "dependencies": {},
   "devDependencies": {
+    "@testing-library/react-hooks": "^7.0.1",
     "expo-module-scripts": "^2.0.0"
   },
   "peerDependencies": {
     "expo": "*"
   },
-  "gitHead": "22dce752354bb429c84851bc4389abe47a766b1f"
+  "jest": {
+    "preset": "expo-module-scripts"
+  },
+  "gitHead": "38e4349fbebadadffe28bd8e800f527a7a2a50fa"
 }

package/src/index.ts

@@ -2,7 +2,7 @@ import { useEffect } from 'react';
 
 import ExpoKeepAwake from './ExpoKeepAwake';
 
-const ExpoKeepAwakeTag = 'ExpoKeepAwakeDefaultTag';
+export const ExpoKeepAwakeTag = 'ExpoKeepAwakeDefaultTag';
 
 // @needsAudit
 /**
@@ -10,12 +10,29 @@ const ExpoKeepAwakeTag = 'ExpoKeepAwakeDefaultTag';
  * The optionally provided `tag` argument is used when activating and deactivating the keep-awake
  * feature. If unspecified, the default `tag` is used. See the documentation for `activateKeepAwake`
  * below to learn more about the `tag` argument.
- * @param tag *Optional*
+ *
+ * @param tag *Optional* - Tag to lock screen sleep prevention. If not provided, the default tag is used.
+ * @param options *Optional*
+ *   - `suppressDeactivateWarnings` *Optional* -
+ *      The call will throw an unhandled promise rejection on Android
+ *      when the original Activity is dead or deactivated.
+ *      Set the value to true for suppressing the uncaught exception.
  */
-export function useKeepAwake(tag: string = ExpoKeepAwakeTag): void {
+export function useKeepAwake(
+  tag: string = ExpoKeepAwakeTag,
+  options?: {
+    suppressDeactivateWarnings: boolean;
+  }
+): void {
   useEffect(() => {
     activateKeepAwake(tag);
-    return () => deactivateKeepAwake(tag);
+    return () => {
+      if (options?.suppressDeactivateWarnings) {
+        deactivateKeepAwake(tag).catch(() => {});
+      } else {
+        deactivateKeepAwake(tag);
+      }
+    };
   }, [tag]);
 }
 
@@ -29,8 +46,8 @@ export function useKeepAwake(tag: string = ExpoKeepAwakeTag): void {
  * @param tag *Optional* - Tag to lock screen sleep prevention. If not provided, the default tag is used.
  */
 
-export function activateKeepAwake(tag: string = ExpoKeepAwakeTag): void {
-  if (ExpoKeepAwake.activate) ExpoKeepAwake.activate(tag);
+export async function activateKeepAwake(tag: string = ExpoKeepAwakeTag): Promise<void> {
+  await ExpoKeepAwake.activate?.(tag);
 }
 
 // @needsAudit
@@ -40,6 +57,6 @@ export function activateKeepAwake(tag: string = ExpoKeepAwakeTag): void {
  * @param tag *Optional* - Tag to release the lock on screen sleep prevention. If not provided,
  * the default tag is used.
  */
-export function deactivateKeepAwake(tag: string = ExpoKeepAwakeTag): void {
-  if (ExpoKeepAwake.deactivate) ExpoKeepAwake.deactivate(tag);
+export async function deactivateKeepAwake(tag: string = ExpoKeepAwakeTag): Promise<void> {
+  await ExpoKeepAwake.deactivate?.(tag);
 }

package/tsconfig.json

@@ -5,5 +5,5 @@
     "outDir": "./build"
   },
   "include": ["./src"],
-  "exclude": ["**/__mocks__/*", "**/__tests__/*"]
+  "exclude": ["**/__mocks__/*", "**/__tests__/*", "**/__stories__/*"]
 }