expo-keep-awake 11.0.0 → 12.0.0

package/CHANGELOG.md

@@ -10,6 +10,27 @@
 
 ### 💡 Others
 
+## 12.0.0 — 2023-02-03
+
+### 🛠 Breaking changes
+
+- `KeepAwake.activateKeepAwake` has been deprecated in favor of `KeepAwake.activateKeepAwakeAsync`. ([#15826](https://github.com/expo/expo/pull/15826) by [@EvanBacon](https://github.com/EvanBacon))
+
+### 🎉 New features
+
+- Added web support. ([#15826](https://github.com/expo/expo/pull/15826) by [@EvanBacon](https://github.com/EvanBacon))
+- Added `KeepAwake.isAvailableAsync` which returns false on certain web browsers. ([#15826](https://github.com/expo/expo/pull/15826) by [@EvanBacon](https://github.com/EvanBacon))
+- Added `KeepAwake.addListener` to observe state changes on web. ([#15826](https://github.com/expo/expo/pull/15826) by [@EvanBacon](https://github.com/EvanBacon))
+
+### 💡 Others
+
+- Define `KeepAwakeOptions` type, update the doc comments. ([#20489](https://github.com/expo/expo/pull/20489) by [@Simek](https://github.com/Simek))
+- On Android bump `compileSdkVersion` and `targetSdkVersion` to `33`. ([#20721](https://github.com/expo/expo/pull/20721) by [@lukmccall](https://github.com/lukmccall))
+
+## 11.0.1 — 2022-10-28
+
+_This version does not introduce any user-facing changes._
+
 ## 11.0.0 — 2022-10-06
 
 ### 🛠 Breaking changes

package/README.md

@@ -4,7 +4,7 @@ Provides a React component that prevents the screen sleeping when rendered. It a
 
 # API documentation
 
-- [Documentation for the main branch](https://github.com/expo/expo/blob/main/docs/pages/versions/unversioned/sdk/keep-awake.md)
+- [Documentation for the main branch](https://github.com/expo/expo/blob/main/docs/pages/versions/unversioned/sdk/keep-awake.mdx)
 - [Documentation for the latest stable release](https://docs.expo.dev/versions/latest/sdk/keep-awake/)
 
 # Installation in managed Expo projects

package/android/build.gradle

@@ -3,7 +3,7 @@ apply plugin: 'kotlin-android'
 apply plugin: 'maven-publish'
 
 group = 'host.exp.exponent'
-version = '11.0.0'
+version = '12.0.0'
 
 buildscript {
   def expoModulesCorePlugin = new File(project(":expo-modules-core").projectDir.absolutePath, "ExpoModulesCorePlugin.gradle")
@@ -59,7 +59,7 @@ afterEvaluate {
 }
 
 android {
-  compileSdkVersion safeExtGet("compileSdkVersion", 31)
+  compileSdkVersion safeExtGet("compileSdkVersion", 33)
 
   compileOptions {
     sourceCompatibility JavaVersion.VERSION_11
@@ -72,9 +72,9 @@ android {
 
   defaultConfig {
     minSdkVersion safeExtGet("minSdkVersion", 21)
-    targetSdkVersion safeExtGet("targetSdkVersion", 31)
+    targetSdkVersion safeExtGet("targetSdkVersion", 33)
     versionCode 16
-    versionName "11.0.0"
+    versionName "12.0.0"
   }
   lintOptions {
     abortOnError false

package/build/ExpoKeepAwake.web.d.ts

@@ -1,3 +1,11 @@
-declare const _default: {};
+import { Subscription } from 'expo-modules-core';
+import { KeepAwakeListener } from './KeepAwake.types';
+/** Wraps the webWakeLock API https://developer.mozilla.org/en-US/docs/Web/API/Screen_Wake_Lock_API */
+declare const _default: {
+    isAvailableAsync(): Promise<boolean>;
+    activate(tag: string): Promise<void>;
+    deactivate(tag: string): Promise<void>;
+    addListenerForTag(tag: string, listener: KeepAwakeListener): Subscription;
+};
 export default _default;
 //# sourceMappingURL=ExpoKeepAwake.web.d.ts.map

package/build/ExpoKeepAwake.web.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ExpoKeepAwake.web.d.ts","sourceRoot":"","sources":["../src/ExpoKeepAwake.web.ts"],"names":[],"mappings":";AAAA,wBAAkB"}
+{"version":3,"file":"ExpoKeepAwake.web.d.ts","sourceRoot":"","sources":["../src/ExpoKeepAwake.web.ts"],"names":[],"mappings":"AAAA,OAAO,EAAwB,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAEvE,OAAO,EAAuB,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AAoB3E,sGAAsG;;;kBAQhF,MAAM;oBAOJ,MAAM;2BAcL,MAAM,YAAY,iBAAiB,GAAG,YAAY;;AA5B3E,wBAqDE"}

package/build/ExpoKeepAwake.web.js

@@ -1,2 +1,59 @@
-export default {};
+import { CodedError, Platform } from 'expo-modules-core';
+import { KeepAwakeEventState } from './KeepAwake.types';
+const wakeLockMap = {};
+/** Wraps the webWakeLock API https://developer.mozilla.org/en-US/docs/Web/API/Screen_Wake_Lock_API */
+export default {
+    async isAvailableAsync() {
+        if (Platform.isDOMAvailable) {
+            return 'wakeLock' in navigator;
+        }
+        return false;
+    },
+    async activate(tag) {
+        if (!Platform.isDOMAvailable) {
+            return;
+        }
+        const wakeLock = await navigator.wakeLock.request('screen');
+        wakeLockMap[tag] = wakeLock;
+    },
+    async deactivate(tag) {
+        if (!Platform.isDOMAvailable) {
+            return;
+        }
+        if (wakeLockMap[tag]) {
+            wakeLockMap[tag].release?.();
+            delete wakeLockMap[tag];
+        }
+        else {
+            throw new CodedError('ERR_KEEP_AWAKE_TAG_INVALID', `The wake lock with tag ${tag} has not activated yet`);
+        }
+    },
+    addListenerForTag(tag, listener) {
+        const eventListener = () => {
+            listener({ state: KeepAwakeEventState.RELEASE });
+        };
+        const sentinel = wakeLockMap[tag];
+        if (sentinel) {
+            if ('addEventListener' in sentinel) {
+                sentinel.addEventListener?.('release', eventListener);
+            }
+            else {
+                sentinel.onrelease = eventListener;
+            }
+        }
+        return {
+            remove: () => {
+                const sentinel = wakeLockMap[tag];
+                if (sentinel) {
+                    if (sentinel.removeEventListener) {
+                        sentinel.removeEventListener('release', eventListener);
+                    }
+                    else {
+                        sentinel.onrelease = null;
+                    }
+                }
+            },
+        };
+    },
+};
 //# sourceMappingURL=ExpoKeepAwake.web.js.map

package/build/ExpoKeepAwake.web.js.map

@@ -1 +1 @@
-{"version":3,"file":"ExpoKeepAwake.web.js","sourceRoot":"","sources":["../src/ExpoKeepAwake.web.ts"],"names":[],"mappings":"AAAA,eAAe,EAAE,CAAC","sourcesContent":["export default {};\n"]}
+{"version":3,"file":"ExpoKeepAwake.web.js","sourceRoot":"","sources":["../src/ExpoKeepAwake.web.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAgB,MAAM,mBAAmB,CAAC;AAEvE,OAAO,EAAE,mBAAmB,EAAqB,MAAM,mBAAmB,CAAC;AAE3E,MAAM,WAAW,GAAqC,EAAE,CAAC;AAkBzD,sGAAsG;AACtG,eAAe;IACb,KAAK,CAAC,gBAAgB;QACpB,IAAI,QAAQ,CAAC,cAAc,EAAE;YAC3B,OAAO,UAAU,IAAI,SAAS,CAAC;SAChC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IACD,KAAK,CAAC,QAAQ,CAAC,GAAW;QACxB,IAAI,CAAC,QAAQ,CAAC,cAAc,EAAE;YAC5B,OAAO;SACR;QACD,MAAM,QAAQ,GAAG,MAAM,SAAS,CAAC,QAAQ,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QAC5D,WAAW,CAAC,GAAG,CAAC,GAAG,QAAQ,CAAC;IAC9B,CAAC;IACD,KAAK,CAAC,UAAU,CAAC,GAAW;QAC1B,IAAI,CAAC,QAAQ,CAAC,cAAc,EAAE;YAC5B,OAAO;SACR;QACD,IAAI,WAAW,CAAC,GAAG,CAAC,EAAE;YACpB,WAAW,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC;YAC7B,OAAO,WAAW,CAAC,GAAG,CAAC,CAAC;SACzB;aAAM;YACL,MAAM,IAAI,UAAU,CAClB,4BAA4B,EAC5B,0BAA0B,GAAG,wBAAwB,CACtD,CAAC;SACH;IACH,CAAC;IACD,iBAAiB,CAAC,GAAW,EAAE,QAA2B;QACxD,MAAM,aAAa,GAAG,GAAG,EAAE;YACzB,QAAQ,CAAC,EAAE,KAAK,EAAE,mBAAmB,CAAC,OAAO,EAAE,CAAC,CAAC;QACnD,CAAC,CAAC;QACF,MAAM,QAAQ,GAAG,WAAW,CAAC,GAAG,CAAC,CAAC;QAClC,IAAI,QAAQ,EAAE;YACZ,IAAI,kBAAkB,IAAI,QAAQ,EAAE;gBAClC,QAAQ,CAAC,gBAAgB,EAAE,CAAC,SAAS,EAAE,aAAa,CAAC,CAAC;aACvD;iBAAM;gBACL,QAAQ,CAAC,SAAS,GAAG,aAAa,CAAC;aACpC;SACF;QACD,OAAO;YACL,MAAM,EAAE,GAAG,EAAE;gBACX,MAAM,QAAQ,GAAG,WAAW,CAAC,GAAG,CAAC,CAAC;gBAClC,IAAI,QAAQ,EAAE;oBACZ,IAAI,QAAQ,CAAC,mBAAmB,EAAE;wBAChC,QAAQ,CAAC,mBAAmB,CAAC,SAAS,EAAE,aAAa,CAAC,CAAC;qBACxD;yBAAM;wBACL,QAAQ,CAAC,SAAS,GAAG,IAAI,CAAC;qBAC3B;iBACF;YACH,CAAC;SACF,CAAC;IACJ,CAAC;CACF,CAAC","sourcesContent":["import { CodedError, Platform, Subscription } from 'expo-modules-core';\n\nimport { KeepAwakeEventState, KeepAwakeListener } from './KeepAwake.types';\n\nconst wakeLockMap: Record<string, WakeLockSentinel> = {};\n\ntype WakeLockSentinel = {\n  onrelease: null | ((event: any) => void);\n  released: boolean;\n  type: 'screen';\n  release?: Function;\n\n  addEventListener?: (event: string, listener: (event: any) => void) => void;\n  removeEventListener?: (event: string, listener: (event: any) => void) => void;\n};\n\ndeclare const navigator: {\n  wakeLock: {\n    request(type: 'screen'): Promise<WakeLockSentinel>;\n  };\n};\n\n/** Wraps the webWakeLock API https://developer.mozilla.org/en-US/docs/Web/API/Screen_Wake_Lock_API */\nexport default {\n  async isAvailableAsync() {\n    if (Platform.isDOMAvailable) {\n      return 'wakeLock' in navigator;\n    }\n    return false;\n  },\n  async activate(tag: string) {\n    if (!Platform.isDOMAvailable) {\n      return;\n    }\n    const wakeLock = await navigator.wakeLock.request('screen');\n    wakeLockMap[tag] = wakeLock;\n  },\n  async deactivate(tag: string) {\n    if (!Platform.isDOMAvailable) {\n      return;\n    }\n    if (wakeLockMap[tag]) {\n      wakeLockMap[tag].release?.();\n      delete wakeLockMap[tag];\n    } else {\n      throw new CodedError(\n        'ERR_KEEP_AWAKE_TAG_INVALID',\n        `The wake lock with tag ${tag} has not activated yet`\n      );\n    }\n  },\n  addListenerForTag(tag: string, listener: KeepAwakeListener): Subscription {\n    const eventListener = () => {\n      listener({ state: KeepAwakeEventState.RELEASE });\n    };\n    const sentinel = wakeLockMap[tag];\n    if (sentinel) {\n      if ('addEventListener' in sentinel) {\n        sentinel.addEventListener?.('release', eventListener);\n      } else {\n        sentinel.onrelease = eventListener;\n      }\n    }\n    return {\n      remove: () => {\n        const sentinel = wakeLockMap[tag];\n        if (sentinel) {\n          if (sentinel.removeEventListener) {\n            sentinel.removeEventListener('release', eventListener);\n          } else {\n            sentinel.onrelease = null;\n          }\n        }\n      },\n    };\n  },\n};\n"]}

package/build/KeepAwake.types.d.ts

@@ -0,0 +1,21 @@
+export type KeepAwakeEvent = {
+    /** Keep awake state. */
+    state: KeepAwakeEventState;
+};
+export declare enum KeepAwakeEventState {
+    RELEASE = "release"
+}
+export type KeepAwakeListener = (event: KeepAwakeEvent) => void;
+export type KeepAwakeOptions = {
+    /**
+     * 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.
+     */
+    suppressDeactivateWarnings?: boolean;
+    /**
+     * A callback that is invoked when the keep-awake state changes.
+     * @platform web
+     */
+    listener?: KeepAwakeListener;
+};
+//# sourceMappingURL=KeepAwake.types.d.ts.map

package/build/KeepAwake.types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"KeepAwake.types.d.ts","sourceRoot":"","sources":["../src/KeepAwake.types.ts"],"names":[],"mappings":"AACA,MAAM,MAAM,cAAc,GAAG;IAC3B,wBAAwB;IACxB,KAAK,EAAE,mBAAmB,CAAC;CAC5B,CAAC;AAGF,oBAAY,mBAAmB;IAC7B,OAAO,YAAY;CACpB;AAGD,MAAM,MAAM,iBAAiB,GAAG,CAAC,KAAK,EAAE,cAAc,KAAK,IAAI,CAAC;AAEhE,MAAM,MAAM,gBAAgB,GAAG;IAC7B;;;OAGG;IACH,0BAA0B,CAAC,EAAE,OAAO,CAAC;IAErC;;;OAGG;IACH,QAAQ,CAAC,EAAE,iBAAiB,CAAC;CAC9B,CAAC"}

package/build/KeepAwake.types.js

@@ -0,0 +1,6 @@
+// @needsAudit
+export var KeepAwakeEventState;
+(function (KeepAwakeEventState) {
+    KeepAwakeEventState["RELEASE"] = "release";
+})(KeepAwakeEventState || (KeepAwakeEventState = {}));
+//# sourceMappingURL=KeepAwake.types.js.map

package/build/KeepAwake.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"KeepAwake.types.js","sourceRoot":"","sources":["../src/KeepAwake.types.ts"],"names":[],"mappings":"AAMA,cAAc;AACd,MAAM,CAAN,IAAY,mBAEX;AAFD,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;AACrB,CAAC,EAFW,mBAAmB,KAAnB,mBAAmB,QAE9B","sourcesContent":["// @needsAudit\nexport type KeepAwakeEvent = {\n  /** Keep awake state. */\n  state: KeepAwakeEventState;\n};\n\n// @needsAudit\nexport enum KeepAwakeEventState {\n  RELEASE = 'release',\n}\n\n// @needsAudit\nexport type KeepAwakeListener = (event: KeepAwakeEvent) => void;\n\nexport type KeepAwakeOptions = {\n  /**\n   * The call will throw an unhandled promise rejection on Android when the original Activity is dead or deactivated.\n   * Set the value to `true` for suppressing the uncaught exception.\n   */\n  suppressDeactivateWarnings?: boolean;\n\n  /**\n   * A callback that is invoked when the keep-awake state changes.\n   * @platform web\n   */\n  listener?: KeepAwakeListener;\n};\n"]}

package/build/index.d.ts

@@ -1,34 +1,64 @@
+import { Subscription } from 'expo-modules-core';
+import { KeepAwakeListener, KeepAwakeOptions } from './KeepAwake.types';
+/** Default tag, used when no tag has been specified in keep awake method calls. */
 export declare const ExpoKeepAwakeTag = "ExpoKeepAwakeDefaultTag";
+/** @returns `true` on all platforms except [unsupported web browsers](https://caniuse.com/wake-lock). */
+export declare function isAvailableAsync(): Promise<boolean>;
 /**
  * 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`
+ * feature. If unspecified, the default `tag` is used. See the documentation for `activateKeepAwakeAsync`
  * below to learn more about the `tag` argument.
  *
- * @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.
+ * @param tag Tag to lock screen sleep prevention. If not provided, the default tag is used.
+ * @param options Additional options for the keep awake hook.
  */
-export declare function useKeepAwake(tag?: string, options?: {
-    suppressDeactivateWarnings: boolean;
-}): void;
+export declare function useKeepAwake(tag?: string, options?: KeepAwakeOptions): void;
 /**
  * Prevents the screen from sleeping until `deactivateKeepAwake` is called with the same `tag` value.
  *
  * If the `tag` argument is specified, the screen will not sleep until you call `deactivateKeepAwake`
  * with the same `tag` argument. When using multiple `tags` for activation you'll have to deactivate
  * 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.
+ *
+ * Web support [is limited](https://caniuse.com/wake-lock).
+ *
+ * @param tag Tag to lock screen sleep prevention. If not provided, the default tag is used.
+ * @deprecated use `activateKeepAwakeAsync` instead.
  */
 export declare function activateKeepAwake(tag?: string): Promise<void>;
+/**
+ * Prevents the screen from sleeping until `deactivateKeepAwake` is called with the same `tag` value.
+ *
+ * If the `tag` argument is specified, the screen will not sleep until you call `deactivateKeepAwake`
+ * with the same `tag` argument. When using multiple `tags` for activation you'll have to deactivate
+ * each one in order to re-enable screen sleep. If tag is unspecified, the default `tag` is used.
+ *
+ * Web support [is limited](https://caniuse.com/wake-lock).
+ *
+ * @param tag Tag to lock screen sleep prevention. If not provided, the default tag is used.
+ */
+export declare function activateKeepAwakeAsync(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,
+ *
+ * @param tag Tag to release the lock on screen sleep prevention. If not provided,
  * the default tag is used.
  */
 export declare function deactivateKeepAwake(tag?: string): Promise<void>;
+/**
+ * Observe changes to the keep awake timer.
+ * On web, this changes when navigating away from the active window/tab. No-op on native.
+ * @platform web
+ *
+ * @example
+ * ```ts
+ * KeepAwake.addListener(({ state }) => {
+ *   // ...
+ * });
+ * ```
+ */
+export declare function addListener(tagOrListener: string | KeepAwakeListener, listener?: KeepAwakeListener): Subscription;
+export * from './KeepAwake.types';
 //# 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":"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"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAuB,MAAM,mBAAmB,CAAC;AAItE,OAAO,EAAE,iBAAiB,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AAExE,mFAAmF;AACnF,eAAO,MAAM,gBAAgB,4BAA4B,CAAC;AAE1D,yGAAyG;AACzG,wBAAsB,gBAAgB,IAAI,OAAO,CAAC,OAAO,CAAC,CAKzD;AAED;;;;;;;;GAQG;AACH,wBAAgB,YAAY,CAAC,GAAG,GAAE,MAAyB,EAAE,OAAO,CAAC,EAAE,gBAAgB,GAAG,IAAI,CAiB7F;AAGD;;;;;;;;;;;GAWG;AACH,wBAAgB,iBAAiB,CAAC,GAAG,GAAE,MAAyB,GAAG,OAAO,CAAC,IAAI,CAAC,CAG/E;AAGD;;;;;;;;;;GAUG;AACH,wBAAsB,sBAAsB,CAAC,GAAG,GAAE,MAAyB,GAAG,OAAO,CAAC,IAAI,CAAC,CAE1F;AAGD;;;;;;GAMG;AACH,wBAAsB,mBAAmB,CAAC,GAAG,GAAE,MAAyB,GAAG,OAAO,CAAC,IAAI,CAAC,CAEvF;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,WAAW,CACzB,aAAa,EAAE,MAAM,GAAG,iBAAiB,EACzC,QAAQ,CAAC,EAAE,iBAAiB,GAC3B,YAAY,CAUd;AAED,cAAc,mBAAmB,CAAC"}

package/build/index.js

@@ -1,24 +1,34 @@
+import { UnavailabilityError } from 'expo-modules-core';
 import { useEffect } from 'react';
 import ExpoKeepAwake from './ExpoKeepAwake';
+/** Default tag, used when no tag has been specified in keep awake method calls. */
 export const ExpoKeepAwakeTag = 'ExpoKeepAwakeDefaultTag';
-// @needsAudit
+/** @returns `true` on all platforms except [unsupported web browsers](https://caniuse.com/wake-lock). */
+export async function isAvailableAsync() {
+    if (ExpoKeepAwake.isAvailableAsync) {
+        return await ExpoKeepAwake.isAvailableAsync();
+    }
+    return true;
+}
 /**
  * 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`
+ * feature. If unspecified, the default `tag` is used. See the documentation for `activateKeepAwakeAsync`
  * below to learn more about the `tag` argument.
  *
- * @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.
+ * @param tag Tag to lock screen sleep prevention. If not provided, the default tag is used.
+ * @param options Additional options for the keep awake hook.
  */
 export function useKeepAwake(tag = ExpoKeepAwakeTag, options) {
     useEffect(() => {
-        activateKeepAwake(tag);
+        let isMounted = true;
+        activateKeepAwakeAsync(tag).then(() => {
+            if (isMounted && ExpoKeepAwake.addListenerForTag && options?.listener) {
+                addListener(tag, options.listener);
+            }
+        });
         return () => {
+            isMounted = false;
             if (options?.suppressDeactivateWarnings) {
                 deactivateKeepAwake(tag).catch(() => { });
             }
@@ -35,19 +45,62 @@ export function useKeepAwake(tag = ExpoKeepAwakeTag, options) {
  * If the `tag` argument is specified, the screen will not sleep until you call `deactivateKeepAwake`
  * with the same `tag` argument. When using multiple `tags` for activation you'll have to deactivate
  * 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.
+ *
+ * Web support [is limited](https://caniuse.com/wake-lock).
+ *
+ * @param tag Tag to lock screen sleep prevention. If not provided, the default tag is used.
+ * @deprecated use `activateKeepAwakeAsync` instead.
  */
-export async function activateKeepAwake(tag = ExpoKeepAwakeTag) {
+export function activateKeepAwake(tag = ExpoKeepAwakeTag) {
+    console.warn('`activateKeepAwake` is deprecated. Use `activateKeepAwakeAsync` instead.');
+    return activateKeepAwakeAsync(tag);
+}
+// @needsAudit
+/**
+ * Prevents the screen from sleeping until `deactivateKeepAwake` is called with the same `tag` value.
+ *
+ * If the `tag` argument is specified, the screen will not sleep until you call `deactivateKeepAwake`
+ * with the same `tag` argument. When using multiple `tags` for activation you'll have to deactivate
+ * each one in order to re-enable screen sleep. If tag is unspecified, the default `tag` is used.
+ *
+ * Web support [is limited](https://caniuse.com/wake-lock).
+ *
+ * @param tag Tag to lock screen sleep prevention. If not provided, the default tag is used.
+ */
+export async function activateKeepAwakeAsync(tag = ExpoKeepAwakeTag) {
     await ExpoKeepAwake.activate?.(tag);
 }
 // @needsAudit
 /**
  * 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,
+ *
+ * @param tag Tag to release the lock on screen sleep prevention. If not provided,
  * the default tag is used.
  */
 export async function deactivateKeepAwake(tag = ExpoKeepAwakeTag) {
     await ExpoKeepAwake.deactivate?.(tag);
 }
+/**
+ * Observe changes to the keep awake timer.
+ * On web, this changes when navigating away from the active window/tab. No-op on native.
+ * @platform web
+ *
+ * @example
+ * ```ts
+ * KeepAwake.addListener(({ state }) => {
+ *   // ...
+ * });
+ * ```
+ */
+export function addListener(tagOrListener, listener) {
+    // Assert so the type is non-nullable.
+    if (!ExpoKeepAwake.addListenerForTag) {
+        throw new UnavailabilityError('ExpoKeepAwake', 'addListenerForTag');
+    }
+    const tag = typeof tagOrListener === 'string' ? tagOrListener : ExpoKeepAwakeTag;
+    const _listener = typeof tagOrListener === 'function' ? tagOrListener : listener;
+    return ExpoKeepAwake.addListenerForTag(tag, _listener);
+}
+export * from './KeepAwake.types';
 //# 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,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"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAgB,mBAAmB,EAAE,MAAM,mBAAmB,CAAC;AACtE,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAElC,OAAO,aAAa,MAAM,iBAAiB,CAAC;AAG5C,mFAAmF;AACnF,MAAM,CAAC,MAAM,gBAAgB,GAAG,yBAAyB,CAAC;AAE1D,yGAAyG;AACzG,MAAM,CAAC,KAAK,UAAU,gBAAgB;IACpC,IAAI,aAAa,CAAC,gBAAgB,EAAE;QAClC,OAAO,MAAM,aAAa,CAAC,gBAAgB,EAAE,CAAC;KAC/C;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,YAAY,CAAC,MAAc,gBAAgB,EAAE,OAA0B;IACrF,SAAS,CAAC,GAAG,EAAE;QACb,IAAI,SAAS,GAAG,IAAI,CAAC;QACrB,sBAAsB,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE;YACpC,IAAI,SAAS,IAAI,aAAa,CAAC,iBAAiB,IAAI,OAAO,EAAE,QAAQ,EAAE;gBACrE,WAAW,CAAC,GAAG,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC;aACpC;QACH,CAAC,CAAC,CAAC;QACH,OAAO,GAAG,EAAE;YACV,SAAS,GAAG,KAAK,CAAC;YAClB,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;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,iBAAiB,CAAC,MAAc,gBAAgB;IAC9D,OAAO,CAAC,IAAI,CAAC,0EAA0E,CAAC,CAAC;IACzF,OAAO,sBAAsB,CAAC,GAAG,CAAC,CAAC;AACrC,CAAC;AAED,cAAc;AACd;;;;;;;;;;GAUG;AACH,MAAM,CAAC,KAAK,UAAU,sBAAsB,CAAC,MAAc,gBAAgB;IACzE,MAAM,aAAa,CAAC,QAAQ,EAAE,CAAC,GAAG,CAAC,CAAC;AACtC,CAAC;AAED,cAAc;AACd;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,mBAAmB,CAAC,MAAc,gBAAgB;IACtE,MAAM,aAAa,CAAC,UAAU,EAAE,CAAC,GAAG,CAAC,CAAC;AACxC,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,WAAW,CACzB,aAAyC,EACzC,QAA4B;IAE5B,sCAAsC;IACtC,IAAI,CAAC,aAAa,CAAC,iBAAiB,EAAE;QACpC,MAAM,IAAI,mBAAmB,CAAC,eAAe,EAAE,mBAAmB,CAAC,CAAC;KACrE;IAED,MAAM,GAAG,GAAG,OAAO,aAAa,KAAK,QAAQ,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,gBAAgB,CAAC;IACjF,MAAM,SAAS,GAAG,OAAO,aAAa,KAAK,UAAU,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,QAAQ,CAAC;IAEjF,OAAO,aAAa,CAAC,iBAAiB,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;AACzD,CAAC;AAED,cAAc,mBAAmB,CAAC","sourcesContent":["import { Subscription, UnavailabilityError } from 'expo-modules-core';\nimport { useEffect } from 'react';\n\nimport ExpoKeepAwake from './ExpoKeepAwake';\nimport { KeepAwakeListener, KeepAwakeOptions } from './KeepAwake.types';\n\n/** Default tag, used when no tag has been specified in keep awake method calls. */\nexport const ExpoKeepAwakeTag = 'ExpoKeepAwakeDefaultTag';\n\n/** @returns `true` on all platforms except [unsupported web browsers](https://caniuse.com/wake-lock). */\nexport async function isAvailableAsync(): Promise<boolean> {\n  if (ExpoKeepAwake.isAvailableAsync) {\n    return await ExpoKeepAwake.isAvailableAsync();\n  }\n  return true;\n}\n\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 `activateKeepAwakeAsync`\n * below to learn more about the `tag` argument.\n *\n * @param tag Tag to lock screen sleep prevention. If not provided, the default tag is used.\n * @param options Additional options for the keep awake hook.\n */\nexport function useKeepAwake(tag: string = ExpoKeepAwakeTag, options?: KeepAwakeOptions): void {\n  useEffect(() => {\n    let isMounted = true;\n    activateKeepAwakeAsync(tag).then(() => {\n      if (isMounted && ExpoKeepAwake.addListenerForTag && options?.listener) {\n        addListener(tag, options.listener);\n      }\n    });\n    return () => {\n      isMounted = false;\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 *\n * Web support [is limited](https://caniuse.com/wake-lock).\n *\n * @param tag Tag to lock screen sleep prevention. If not provided, the default tag is used.\n * @deprecated use `activateKeepAwakeAsync` instead.\n */\nexport function activateKeepAwake(tag: string = ExpoKeepAwakeTag): Promise<void> {\n  console.warn('`activateKeepAwake` is deprecated. Use `activateKeepAwakeAsync` instead.');\n  return activateKeepAwakeAsync(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 *\n * Web support [is limited](https://caniuse.com/wake-lock).\n *\n * @param tag Tag to lock screen sleep prevention. If not provided, the default tag is used.\n */\nexport async function activateKeepAwakeAsync(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 *\n * @param tag 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\n/**\n * Observe changes to the keep awake timer.\n * On web, this changes when navigating away from the active window/tab. No-op on native.\n * @platform web\n *\n * @example\n * ```ts\n * KeepAwake.addListener(({ state }) => {\n *   // ...\n * });\n * ```\n */\nexport function addListener(\n  tagOrListener: string | KeepAwakeListener,\n  listener?: KeepAwakeListener\n): Subscription {\n  // Assert so the type is non-nullable.\n  if (!ExpoKeepAwake.addListenerForTag) {\n    throw new UnavailabilityError('ExpoKeepAwake', 'addListenerForTag');\n  }\n\n  const tag = typeof tagOrListener === 'string' ? tagOrListener : ExpoKeepAwakeTag;\n  const _listener = typeof tagOrListener === 'function' ? tagOrListener : listener;\n\n  return ExpoKeepAwake.addListenerForTag(tag, _listener);\n}\n\nexport * from './KeepAwake.types';\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "expo-keep-awake",
-  "version": "11.0.0",
+  "version": "12.0.0",
   "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",
@@ -34,7 +34,7 @@
   "dependencies": {},
   "devDependencies": {
     "@testing-library/react-hooks": "^7.0.1",
-    "expo-module-scripts": "^2.0.0"
+    "expo-module-scripts": "^3.0.0"
   },
   "peerDependencies": {
     "expo": "*"
@@ -42,5 +42,5 @@
   "jest": {
     "preset": "expo-module-scripts"
   },
-  "gitHead": "1327fe2bc92f71f7213cd5ddd40fa4f8a5336bc6"
+  "gitHead": "1815e2eaad8c753588c7b1eb74420174a28e01f4"
 }

package/src/ExpoKeepAwake.web.ts

@@ -1 +1,77 @@
-export default {};
+import { CodedError, Platform, Subscription } from 'expo-modules-core';
+
+import { KeepAwakeEventState, KeepAwakeListener } from './KeepAwake.types';
+
+const wakeLockMap: Record<string, WakeLockSentinel> = {};
+
+type WakeLockSentinel = {
+  onrelease: null | ((event: any) => void);
+  released: boolean;
+  type: 'screen';
+  release?: Function;
+
+  addEventListener?: (event: string, listener: (event: any) => void) => void;
+  removeEventListener?: (event: string, listener: (event: any) => void) => void;
+};
+
+declare const navigator: {
+  wakeLock: {
+    request(type: 'screen'): Promise<WakeLockSentinel>;
+  };
+};
+
+/** Wraps the webWakeLock API https://developer.mozilla.org/en-US/docs/Web/API/Screen_Wake_Lock_API */
+export default {
+  async isAvailableAsync() {
+    if (Platform.isDOMAvailable) {
+      return 'wakeLock' in navigator;
+    }
+    return false;
+  },
+  async activate(tag: string) {
+    if (!Platform.isDOMAvailable) {
+      return;
+    }
+    const wakeLock = await navigator.wakeLock.request('screen');
+    wakeLockMap[tag] = wakeLock;
+  },
+  async deactivate(tag: string) {
+    if (!Platform.isDOMAvailable) {
+      return;
+    }
+    if (wakeLockMap[tag]) {
+      wakeLockMap[tag].release?.();
+      delete wakeLockMap[tag];
+    } else {
+      throw new CodedError(
+        'ERR_KEEP_AWAKE_TAG_INVALID',
+        `The wake lock with tag ${tag} has not activated yet`
+      );
+    }
+  },
+  addListenerForTag(tag: string, listener: KeepAwakeListener): Subscription {
+    const eventListener = () => {
+      listener({ state: KeepAwakeEventState.RELEASE });
+    };
+    const sentinel = wakeLockMap[tag];
+    if (sentinel) {
+      if ('addEventListener' in sentinel) {
+        sentinel.addEventListener?.('release', eventListener);
+      } else {
+        sentinel.onrelease = eventListener;
+      }
+    }
+    return {
+      remove: () => {
+        const sentinel = wakeLockMap[tag];
+        if (sentinel) {
+          if (sentinel.removeEventListener) {
+            sentinel.removeEventListener('release', eventListener);
+          } else {
+            sentinel.onrelease = null;
+          }
+        }
+      },
+    };
+  },
+};

package/src/KeepAwake.types.ts

@@ -0,0 +1,27 @@
+// @needsAudit
+export type KeepAwakeEvent = {
+  /** Keep awake state. */
+  state: KeepAwakeEventState;
+};
+
+// @needsAudit
+export enum KeepAwakeEventState {
+  RELEASE = 'release',
+}
+
+// @needsAudit
+export type KeepAwakeListener = (event: KeepAwakeEvent) => void;
+
+export type KeepAwakeOptions = {
+  /**
+   * 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.
+   */
+  suppressDeactivateWarnings?: boolean;
+
+  /**
+   * A callback that is invoked when the keep-awake state changes.
+   * @platform web
+   */
+  listener?: KeepAwakeListener;
+};

package/src/index.ts

@@ -1,32 +1,39 @@
+import { Subscription, UnavailabilityError } from 'expo-modules-core';
 import { useEffect } from 'react';
 
 import ExpoKeepAwake from './ExpoKeepAwake';
+import { KeepAwakeListener, KeepAwakeOptions } from './KeepAwake.types';
 
+/** Default tag, used when no tag has been specified in keep awake method calls. */
 export const ExpoKeepAwakeTag = 'ExpoKeepAwakeDefaultTag';
 
-// @needsAudit
+/** @returns `true` on all platforms except [unsupported web browsers](https://caniuse.com/wake-lock). */
+export async function isAvailableAsync(): Promise<boolean> {
+  if (ExpoKeepAwake.isAvailableAsync) {
+    return await ExpoKeepAwake.isAvailableAsync();
+  }
+  return true;
+}
+
 /**
  * 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`
+ * feature. If unspecified, the default `tag` is used. See the documentation for `activateKeepAwakeAsync`
  * below to learn more about the `tag` argument.
  *
- * @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.
+ * @param tag Tag to lock screen sleep prevention. If not provided, the default tag is used.
+ * @param options Additional options for the keep awake hook.
  */
-export function useKeepAwake(
-  tag: string = ExpoKeepAwakeTag,
-  options?: {
-    suppressDeactivateWarnings: boolean;
-  }
-): void {
+export function useKeepAwake(tag: string = ExpoKeepAwakeTag, options?: KeepAwakeOptions): void {
   useEffect(() => {
-    activateKeepAwake(tag);
+    let isMounted = true;
+    activateKeepAwakeAsync(tag).then(() => {
+      if (isMounted && ExpoKeepAwake.addListenerForTag && options?.listener) {
+        addListener(tag, options.listener);
+      }
+    });
     return () => {
+      isMounted = false;
       if (options?.suppressDeactivateWarnings) {
         deactivateKeepAwake(tag).catch(() => {});
       } else {
@@ -43,10 +50,30 @@ export function useKeepAwake(
  * If the `tag` argument is specified, the screen will not sleep until you call `deactivateKeepAwake`
  * with the same `tag` argument. When using multiple `tags` for activation you'll have to deactivate
  * 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.
+ *
+ * Web support [is limited](https://caniuse.com/wake-lock).
+ *
+ * @param tag Tag to lock screen sleep prevention. If not provided, the default tag is used.
+ * @deprecated use `activateKeepAwakeAsync` instead.
  */
+export function activateKeepAwake(tag: string = ExpoKeepAwakeTag): Promise<void> {
+  console.warn('`activateKeepAwake` is deprecated. Use `activateKeepAwakeAsync` instead.');
+  return activateKeepAwakeAsync(tag);
+}
 
-export async function activateKeepAwake(tag: string = ExpoKeepAwakeTag): Promise<void> {
+// @needsAudit
+/**
+ * Prevents the screen from sleeping until `deactivateKeepAwake` is called with the same `tag` value.
+ *
+ * If the `tag` argument is specified, the screen will not sleep until you call `deactivateKeepAwake`
+ * with the same `tag` argument. When using multiple `tags` for activation you'll have to deactivate
+ * each one in order to re-enable screen sleep. If tag is unspecified, the default `tag` is used.
+ *
+ * Web support [is limited](https://caniuse.com/wake-lock).
+ *
+ * @param tag Tag to lock screen sleep prevention. If not provided, the default tag is used.
+ */
+export async function activateKeepAwakeAsync(tag: string = ExpoKeepAwakeTag): Promise<void> {
   await ExpoKeepAwake.activate?.(tag);
 }
 
@@ -54,9 +81,39 @@ export async function activateKeepAwake(tag: string = ExpoKeepAwakeTag): Promise
 /**
  * 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,
+ *
+ * @param tag Tag to release the lock on screen sleep prevention. If not provided,
  * the default tag is used.
  */
 export async function deactivateKeepAwake(tag: string = ExpoKeepAwakeTag): Promise<void> {
   await ExpoKeepAwake.deactivate?.(tag);
 }
+
+/**
+ * Observe changes to the keep awake timer.
+ * On web, this changes when navigating away from the active window/tab. No-op on native.
+ * @platform web
+ *
+ * @example
+ * ```ts
+ * KeepAwake.addListener(({ state }) => {
+ *   // ...
+ * });
+ * ```
+ */
+export function addListener(
+  tagOrListener: string | KeepAwakeListener,
+  listener?: KeepAwakeListener
+): Subscription {
+  // Assert so the type is non-nullable.
+  if (!ExpoKeepAwake.addListenerForTag) {
+    throw new UnavailabilityError('ExpoKeepAwake', 'addListenerForTag');
+  }
+
+  const tag = typeof tagOrListener === 'string' ? tagOrListener : ExpoKeepAwakeTag;
+  const _listener = typeof tagOrListener === 'function' ? tagOrListener : listener;
+
+  return ExpoKeepAwake.addListenerForTag(tag, _listener);
+}
+
+export * from './KeepAwake.types';