expo-linking 2.4.2 → 3.2.0

package/CHANGELOG.md

@@ -10,9 +10,38 @@
 
 ### 💡 Others
 
-## 2.4.2 — 2021-10-15
+## 3.2.0 — 2022-07-07
 
-_This version does not introduce any user-facing changes._
+### 🐛 Bug fixes
+
+- Fix bug in isExpoHosted for new manifests. ([#17402](https://github.com/expo/expo/pull/17402) by [@wschurman](https://github.com/wschurman))
+- Fix `addEventListener` not returning a subscription on web. ([#17925](https://github.com/expo/expo/pull/17925) by [@EvanBacon](https://github.com/EvanBacon))
+
+## 3.1.0 — 2022-04-18
+
+### 🎉 New features
+
+- `addEventListener` returns `EmitterSubscription` rather than `void` ([#17014](https://github.com/expo/expo/pull/17014) by [@frankcalise](https://github.com/frankcalise))
+
+### 🐛 Bug fixes
+
+- `addEventListener` and `removeEventListener` only accept `'url'` as `type` param, rather than `string`
+- `useURL` hook now cleans up `addEventListener` via `remove` rather than `removeEventListener` ([#17014](https://github.com/expo/expo/pull/17014) by [@frankcalise](https://github.com/frankcalise))
+
+### 💡 Others
+
+- Export public `Schemes` methods in main file. ([#17058](https://github.com/expo/expo/pull/17058) by [@Simek](https://github.com/Simek))
+
+## 3.0.0 — 2021-12-03
+
+### 🛠 Breaking changes
+
+- Remove deprecated `useUrl` method. ([#15226](https://github.com/expo/expo/pull/15226) by [@Simek](https://github.com/Simek))
+
+### 💡 Others
+
+- Update `qs` dependency. ([#15069](https://github.com/expo/expo/pull/15069) by [@Simek](https://github.com/Simek))
+- Extract `sendIntent` method `extras` parameter to the separate type named `SendIntentExtras`. ([#15226](https://github.com/expo/expo/pull/15226) by [@Simek](https://github.com/Simek))
 
 ## 2.4.1 — 2021-10-01
 

package/README.md

@@ -4,16 +4,16 @@ Create and open deep links universally.
 
 # API documentation
 
-- [Documentation for the master branch](https://github.com/expo/expo/blob/master/docs/pages/versions/unversioned/sdk/linking.md)
-- [Documentation for the latest stable release](https://docs.expo.io/versions/latest/sdk/linking/)
+- [Documentation for the main branch](https://github.com/expo/expo/blob/main/docs/pages/versions/unversioned/sdk/linking.md)
+- [Documentation for the latest stable release](https://docs.expo.dev/versions/latest/sdk/linking/)
 
 # Installation in managed Expo projects
 
-For managed [managed](https://docs.expo.io/versions/latest/introduction/managed-vs-bare/) Expo projects, please follow the installation instructions in the [API documentation for the latest stable release](https://docs.expo.io/versions/latest/sdk/asset/). If you follow the link and there is no documentation available then this library is not yet usable within managed projects — it is likely to be included in an upcoming Expo SDK release.
+For [managed](https://docs.expo.dev/versions/latest/introduction/managed-vs-bare/) Expo projects, please follow the installation instructions in the [API documentation for the latest stable release](https://docs.expo.dev/versions/latest/sdk/asset/). If you follow the link and there is no documentation available then this library is not yet usable within managed projects — it is likely to be included in an upcoming Expo SDK release.
 
 # Installation in bare React Native projects
 
-For bare React Native projects, you must ensure that you have [installed and configured the `react-native-unimodules` package](https://github.com/expo/expo/tree/master/packages/react-native-unimodules) before continuing.
+For bare React Native projects, you must ensure that you have [installed and configured the `expo` package](https://docs.expo.dev/bare/installing-expo-modules/) before continuing.
 
 ### Add the package to your npm dependencies
 

package/build/ExpoLinking.d.ts

@@ -1,2 +1,3 @@
 import { Linking } from 'react-native';
 export default Linking;
+//# sourceMappingURL=ExpoLinking.d.ts.map

package/build/ExpoLinking.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ExpoLinking.d.ts","sourceRoot":"","sources":["../src/ExpoLinking.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,eAAe,OAAO,CAAC"}

package/build/ExpoLinking.web.d.ts

@@ -1,9 +1,12 @@
 import { URLListener } from './Linking.types';
 declare const _default: {
-    addEventListener(type: 'url', listener: URLListener): void;
+    addEventListener(type: 'url', listener: URLListener): {
+        remove(): void;
+    };
     removeEventListener(type: 'url', listener: URLListener): void;
     canOpenURL(url: string): Promise<boolean>;
     getInitialURL(): Promise<string>;
     openURL(url: string): Promise<void>;
 };
 export default _default;
+//# sourceMappingURL=ExpoLinking.web.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ExpoLinking.web.d.ts","sourceRoot":"","sources":["../src/ExpoLinking.web.ts"],"names":[],"mappings":"AAGA,OAAO,EAAqB,WAAW,EAAE,MAAM,iBAAiB,CAAC;;2BAOxC,KAAK,YAAY,WAAW,GAAG;QAAE,MAAM,IAAI,IAAI,CAAA;KAAE;8BAqB9C,KAAK,YAAY,WAAW,GAAG,IAAI;oBAmBvC,MAAM,GAAG,QAAQ,OAAO,CAAC;qBAKxB,QAAQ,MAAM,CAAC;iBAKnB,MAAM,GAAG,QAAQ,IAAI,CAAC;;AAnD3C,wBAyDE"}

package/build/ExpoLinking.web.js

@@ -4,12 +4,25 @@ const EventTypes = ['url'];
 const listeners = [];
 export default {
     addEventListener(type, listener) {
+        // Do nothing in Node.js environments
+        if (!Platform.isDOMAvailable) {
+            return { remove() { } };
+        }
         invariant(EventTypes.indexOf(type) !== -1, `Linking.addEventListener(): ${type} is not a valid event`);
         const nativeListener = (nativeEvent) => listener({ url: window.location.href, nativeEvent });
         listeners.push({ listener, nativeListener });
         window.addEventListener('message', nativeListener, false);
+        return {
+            remove: () => {
+                this.removeEventListener(type, listener);
+            },
+        };
     },
     removeEventListener(type, listener) {
+        // Do nothing in Node.js environments
+        if (!Platform.isDOMAvailable) {
+            return;
+        }
         invariant(EventTypes.indexOf(type) !== -1, `Linking.removeEventListener(): ${type} is not a valid event.`);
         const listenerIndex = listeners.findIndex((pair) => pair.listener === listener);
         invariant(listenerIndex !== -1, 'Linking.removeEventListener(): cannot remove an unregistered event listener.');

package/build/ExpoLinking.web.js.map

@@ -1 +1 @@
-{"version":3,"file":"ExpoLinking.web.js","sourceRoot":"","sources":["../src/ExpoLinking.web.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAC7C,OAAO,SAAS,MAAM,WAAW,CAAC;AAIlC,MAAM,UAAU,GAAG,CAAC,KAAK,CAAC,CAAC;AAE3B,MAAM,SAAS,GAAmE,EAAE,CAAC;AAErF,eAAe;IACb,gBAAgB,CAAC,IAAW,EAAE,QAAqB;QACjD,SAAS,CACP,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAC/B,+BAA+B,IAAI,uBAAuB,CAC3D,CAAC;QACF,MAAM,cAAc,GAAsB,CAAC,WAAW,EAAE,EAAE,CACxD,QAAQ,CAAC,EAAE,GAAG,EAAE,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,WAAW,EAAE,CAAC,CAAC;QACvD,SAAS,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,cAAc,EAAE,CAAC,CAAC;QAC7C,MAAM,CAAC,gBAAgB,CAAC,SAAS,EAAE,cAAc,EAAE,KAAK,CAAC,CAAC;IAC5D,CAAC;IAED,mBAAmB,CAAC,IAAW,EAAE,QAAqB;QACpD,SAAS,CACP,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAC/B,kCAAkC,IAAI,wBAAwB,CAC/D,CAAC;QACF,MAAM,aAAa,GAAG,SAAS,CAAC,SAAS,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,KAAK,QAAQ,CAAC,CAAC;QAChF,SAAS,CACP,aAAa,KAAK,CAAC,CAAC,EACpB,8EAA8E,CAC/E,CAAC;QACF,MAAM,cAAc,GAAG,SAAS,CAAC,aAAa,CAAC,CAAC,cAAc,CAAC;QAC/D,MAAM,CAAC,mBAAmB,CAAC,SAAS,EAAE,cAAc,EAAE,KAAK,CAAC,CAAC;QAC7D,SAAS,CAAC,MAAM,CAAC,aAAa,EAAE,CAAC,CAAC,CAAC;IACrC,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,GAAW;QAC1B,uFAAuF;QACvF,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK,CAAC,aAAa;QACjB,IAAI,CAAC,QAAQ,CAAC,cAAc;YAAE,OAAO,EAAE,CAAC;QACxC,OAAO,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC;IAC9B,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,GAAW;QACvB,IAAI,QAAQ,CAAC,cAAc,EAAE;YAC3B,aAAa;YACb,MAAM,CAAC,QAAQ,GAAG,IAAI,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC,QAAQ,EAAE,CAAC;SAC5D;IACH,CAAC;CACF,CAAC","sourcesContent":["import { Platform } from 'expo-modules-core';\nimport invariant from 'invariant';\n\nimport { NativeURLListener, URLListener } from './Linking.types';\n\nconst EventTypes = ['url'];\n\nconst listeners: { listener: URLListener; nativeListener: NativeURLListener }[] = [];\n\nexport default {\n  addEventListener(type: 'url', listener: URLListener): void {\n    invariant(\n      EventTypes.indexOf(type) !== -1,\n      `Linking.addEventListener(): ${type} is not a valid event`\n    );\n    const nativeListener: NativeURLListener = (nativeEvent) =>\n      listener({ url: window.location.href, nativeEvent });\n    listeners.push({ listener, nativeListener });\n    window.addEventListener('message', nativeListener, false);\n  },\n\n  removeEventListener(type: 'url', listener: URLListener): void {\n    invariant(\n      EventTypes.indexOf(type) !== -1,\n      `Linking.removeEventListener(): ${type} is not a valid event.`\n    );\n    const listenerIndex = listeners.findIndex((pair) => pair.listener === listener);\n    invariant(\n      listenerIndex !== -1,\n      'Linking.removeEventListener(): cannot remove an unregistered event listener.'\n    );\n    const nativeListener = listeners[listenerIndex].nativeListener;\n    window.removeEventListener('message', nativeListener, false);\n    listeners.splice(listenerIndex, 1);\n  },\n\n  async canOpenURL(url: string): Promise<boolean> {\n    // In reality this should be able to return false for links like `chrome://` on chrome.\n    return true;\n  },\n\n  async getInitialURL(): Promise<string> {\n    if (!Platform.isDOMAvailable) return '';\n    return window.location.href;\n  },\n\n  async openURL(url: string): Promise<void> {\n    if (Platform.isDOMAvailable) {\n      // @ts-ignore\n      window.location = new URL(url, window.location).toString();\n    }\n  },\n};\n"]}
+{"version":3,"file":"ExpoLinking.web.js","sourceRoot":"","sources":["../src/ExpoLinking.web.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAC7C,OAAO,SAAS,MAAM,WAAW,CAAC;AAIlC,MAAM,UAAU,GAAG,CAAC,KAAK,CAAC,CAAC;AAE3B,MAAM,SAAS,GAAmE,EAAE,CAAC;AAErF,eAAe;IACb,gBAAgB,CAAC,IAAW,EAAE,QAAqB;QACjD,qCAAqC;QACrC,IAAI,CAAC,QAAQ,CAAC,cAAc,EAAE;YAC5B,OAAO,EAAE,MAAM,KAAI,CAAC,EAAE,CAAC;SACxB;QAED,SAAS,CACP,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAC/B,+BAA+B,IAAI,uBAAuB,CAC3D,CAAC;QACF,MAAM,cAAc,GAAsB,CAAC,WAAW,EAAE,EAAE,CACxD,QAAQ,CAAC,EAAE,GAAG,EAAE,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,WAAW,EAAE,CAAC,CAAC;QACvD,SAAS,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,cAAc,EAAE,CAAC,CAAC;QAC7C,MAAM,CAAC,gBAAgB,CAAC,SAAS,EAAE,cAAc,EAAE,KAAK,CAAC,CAAC;QAC1D,OAAO;YACL,MAAM,EAAE,GAAG,EAAE;gBACX,IAAI,CAAC,mBAAmB,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;YAC3C,CAAC;SACF,CAAC;IACJ,CAAC;IAED,mBAAmB,CAAC,IAAW,EAAE,QAAqB;QACpD,qCAAqC;QACrC,IAAI,CAAC,QAAQ,CAAC,cAAc,EAAE;YAC5B,OAAO;SACR;QACD,SAAS,CACP,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAC/B,kCAAkC,IAAI,wBAAwB,CAC/D,CAAC;QACF,MAAM,aAAa,GAAG,SAAS,CAAC,SAAS,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,KAAK,QAAQ,CAAC,CAAC;QAChF,SAAS,CACP,aAAa,KAAK,CAAC,CAAC,EACpB,8EAA8E,CAC/E,CAAC;QACF,MAAM,cAAc,GAAG,SAAS,CAAC,aAAa,CAAC,CAAC,cAAc,CAAC;QAC/D,MAAM,CAAC,mBAAmB,CAAC,SAAS,EAAE,cAAc,EAAE,KAAK,CAAC,CAAC;QAC7D,SAAS,CAAC,MAAM,CAAC,aAAa,EAAE,CAAC,CAAC,CAAC;IACrC,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,GAAW;QAC1B,uFAAuF;QACvF,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK,CAAC,aAAa;QACjB,IAAI,CAAC,QAAQ,CAAC,cAAc;YAAE,OAAO,EAAE,CAAC;QACxC,OAAO,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC;IAC9B,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,GAAW;QACvB,IAAI,QAAQ,CAAC,cAAc,EAAE;YAC3B,aAAa;YACb,MAAM,CAAC,QAAQ,GAAG,IAAI,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC,QAAQ,EAAE,CAAC;SAC5D;IACH,CAAC;CACF,CAAC","sourcesContent":["import { Platform } from 'expo-modules-core';\nimport invariant from 'invariant';\n\nimport { NativeURLListener, URLListener } from './Linking.types';\n\nconst EventTypes = ['url'];\n\nconst listeners: { listener: URLListener; nativeListener: NativeURLListener }[] = [];\n\nexport default {\n  addEventListener(type: 'url', listener: URLListener): { remove(): void } {\n    // Do nothing in Node.js environments\n    if (!Platform.isDOMAvailable) {\n      return { remove() {} };\n    }\n\n    invariant(\n      EventTypes.indexOf(type) !== -1,\n      `Linking.addEventListener(): ${type} is not a valid event`\n    );\n    const nativeListener: NativeURLListener = (nativeEvent) =>\n      listener({ url: window.location.href, nativeEvent });\n    listeners.push({ listener, nativeListener });\n    window.addEventListener('message', nativeListener, false);\n    return {\n      remove: () => {\n        this.removeEventListener(type, listener);\n      },\n    };\n  },\n\n  removeEventListener(type: 'url', listener: URLListener): void {\n    // Do nothing in Node.js environments\n    if (!Platform.isDOMAvailable) {\n      return;\n    }\n    invariant(\n      EventTypes.indexOf(type) !== -1,\n      `Linking.removeEventListener(): ${type} is not a valid event.`\n    );\n    const listenerIndex = listeners.findIndex((pair) => pair.listener === listener);\n    invariant(\n      listenerIndex !== -1,\n      'Linking.removeEventListener(): cannot remove an unregistered event listener.'\n    );\n    const nativeListener = listeners[listenerIndex].nativeListener;\n    window.removeEventListener('message', nativeListener, false);\n    listeners.splice(listenerIndex, 1);\n  },\n\n  async canOpenURL(url: string): Promise<boolean> {\n    // In reality this should be able to return false for links like `chrome://` on chrome.\n    return true;\n  },\n\n  async getInitialURL(): Promise<string> {\n    if (!Platform.isDOMAvailable) return '';\n    return window.location.href;\n  },\n\n  async openURL(url: string): Promise<void> {\n    if (Platform.isDOMAvailable) {\n      // @ts-ignore\n      window.location = new URL(url, window.location).toString();\n    }\n  },\n};\n"]}

package/build/Linking.d.ts

@@ -1,10 +1,10 @@
-import { CreateURLOptions, ParsedURL, QueryParams, URLListener } from './Linking.types';
+import { EmitterSubscription } from 'react-native';
+import { CreateURLOptions, ParsedURL, QueryParams, SendIntentExtras, URLListener } from './Linking.types';
 /**
  * Create a URL that works for the environment the app is currently running in.
  * The scheme in bare and standalone must be defined in the app.json under `expo.scheme`.
  *
- * **Examples**
- *
+ * # Examples
  * - Bare: empty string
  * - Standalone, Custom: `yourscheme:///path`
  * - Web (dev): `https://localhost:19006/path`
@@ -13,87 +13,111 @@ import { CreateURLOptions, ParsedURL, QueryParams, URLListener } from './Linking
  * - Expo Client (prod): `exp://exp.host/@yourname/your-app/--/path`
  *
  * @param path addition path components to append to the base URL.
- * @param queryParams An object of parameters that will be converted into a query string.
+ * @param queryParams An object with a set of query parameters. These will be merged with any
+ * Expo-specific parameters that are needed (e.g. release channel) and then appended to the URL
+ * as a query string.
+ * @param scheme Optional URI protocol to use in the URL `<scheme>:///`, when `undefined` the scheme
+ * will be chosen from the Expo config (`app.config.js` or `app.json`).
+ * @return A URL string which points to your app with the given deep link information.
+ * @deprecated An alias for [`createURL()`](#linkingcreateurlpath-namedparameters). This method is
+ * deprecated and will be removed in a future SDK version.
  */
 export declare function makeUrl(path?: string, queryParams?: QueryParams, scheme?: string): string;
 /**
- * Create a URL that works for the environment the app is currently running in.
- * The scheme in bare and standalone must be defined in the Expo config (app.config.js or app.json) under `expo.scheme`.
+ * Helper method for constructing a deep link into your app, given an optional path and set of query
+ * parameters. Creates a URI scheme with two slashes by default.
  *
- * **Examples**
+ * The scheme in bare and standalone must be defined in the Expo config (`app.config.js` or `app.json`)
+ * under `expo.scheme`.
  *
- * - Bare: `<scheme>://path` -- uses provided scheme or scheme from Expo config `scheme`.
+ * # Examples
+ * - Bare: `<scheme>://path` - uses provided scheme or scheme from Expo config `scheme`.
  * - Standalone, Custom: `yourscheme://path`
  * - Web (dev): `https://localhost:19006/path`
  * - Web (prod): `https://myapp.com/path`
  * - Expo Client (dev): `exp://128.0.0.1:19000/--/path`
  * - Expo Client (prod): `exp://exp.host/@yourname/your-app/--/path`
  *
- * @param path addition path components to append to the base URL.
- * @param scheme URI protocol `<scheme>://` that must be built into your native app.
- * @param queryParams An object of parameters that will be converted into a query string.
+ * @param path Addition path components to append to the base URL.
+ * @param namedParameters Additional options object.
+ * @return A URL string which points to your app with the given deep link information.
  */
 export declare function createURL(path: string, { scheme, queryParams, isTripleSlashed }?: CreateURLOptions): string;
 /**
- * Returns the components and query parameters for a given URL.
- *
- * @param url Input URL to parse
+ * Helper method for parsing out deep link information from a URL.
+ * @param url A URL that points to the currently running experience (e.g. an output of `Linking.createURL()`).
+ * @return A `ParsedURL` object.
  */
 export declare function parse(url: string): ParsedURL;
 /**
- * Add a handler to Linking changes by listening to the `url` event type
- * and providing the handler
- *
- * See https://reactnative.dev/docs/linking.html#addeventlistener
+ * Add a handler to `Linking` changes by listening to the `url` event type and providing the handler.
+ * It is recommended to use the [`useURL()`](#useurl) hook instead.
+ * @param type The only valid type is `'url'`.
+ * @param handler An [`URLListener`](#urllistener) function that takes an `event` object of the type
+ * [`EventType`](#eventype).
+ * @return An EmitterSubscription that has the remove method from EventSubscription
+ * @see [React Native Docs Linking page](https://reactnative.dev/docs/linking#addeventlistener).
  */
-export declare function addEventListener(type: string, handler: URLListener): void;
+export declare function addEventListener(type: 'url', handler: URLListener): EmitterSubscription;
 /**
  * Remove a handler by passing the `url` event type and the handler.
+ * @param type The only valid type is `'url'`.
+ * @param handler An [`URLListener`](#urllistener) function that takes an `event` object of the type
+ * [`EventType`](#eventype).
+ * @see [React Native Docs Linking page](https://reactnative.dev/docs/linking#removeeventlistener).
  *
- * See https://reactnative.dev/docs/linking.html#removeeventlistener
+ * @deprecated Call `remove()` on the return value of `addEventListener()` instead.
  */
-export declare function removeEventListener(type: string, handler: URLListener): void;
+export declare function removeEventListener(type: 'url', handler: URLListener): void;
 /**
- * **Native:** Parses the link that opened the app. If no link opened the app, all the fields will be \`null\`.
- * **Web:** Parses the current window URL.
+ * Helper method which wraps React Native's `Linking.getInitialURL()` in `Linking.parse()`.
+ * Parses the deep link information out of the URL used to open the experience initially.
+ * If no link opened the app, all the fields will be `null`.
+ * > On the web it parses the current window URL.
+ * @return A promise that resolves with `ParsedURL` object.
  */
 export declare function parseInitialURLAsync(): Promise<ParsedURL>;
 /**
- * Launch an Android intent with optional extras
- *
+ * Launch an Android intent with extras.
+ * > Use [IntentLauncher](./intent-launcher) instead, `sendIntent` is only included in
+ * > `Linking` for API compatibility with React Native's Linking API.
  * @platform android
  */
-export declare function sendIntent(action: string, extras?: {
-    key: string;
-    value: string | number | boolean;
-}[]): Promise<void>;
+export declare function sendIntent(action: string, extras?: SendIntentExtras[]): Promise<void>;
 /**
- * Attempt to open the system settings for an the app.
- *
- * @platform ios
+ * Open the operating system settings app and displays the app’s custom settings, if it has any.
  */
 export declare function openSettings(): Promise<void>;
 /**
- * If the app launch was triggered by an app link,
- * it will give the link url, otherwise it will give `null`
+ * Get the URL that was used to launch the app if it was launched by a link.
+ * @return The URL string that launched your app, or `null`.
  */
 export declare function getInitialURL(): Promise<string | null>;
 /**
- * Try to open the given `url` with any of the installed apps.
+ * Attempt to open the given URL with an installed app. See the [Linking guide](/guides/linking)
+ * for more information.
+ * @param url A URL for the operating system to open, eg: `tel:5555555`, `exp://`.
+ * @return A `Promise` that is fulfilled with `true` if the link is opened operating system
+ * automatically or the user confirms the prompt to open the link. The `Promise` rejects if there
+ * are no applications registered for the URL or the user cancels the dialog.
  */
 export declare function openURL(url: string): Promise<true>;
 /**
  * Determine whether or not an installed app can handle a given URL.
- * On web this always returns true because there is no API for detecting what URLs can be opened.
+ * On web this always returns `true` because there is no API for detecting what URLs can be opened.
+ * @param url The URL that you want to test can be opened.
+ * @return A `Promise` object that is fulfilled with `true` if the URL can be handled, otherwise it
+ * `false` if not.
+ *
+ * The `Promise` will reject on Android if it was impossible to check if the URL can be opened, and
+ * on iOS if you didn't [add the specific scheme in the `LSApplicationQueriesSchemes` key inside **Info.plist**](/guides/linking#opening-links-to-other-apps).
  */
 export declare function canOpenURL(url: string): Promise<boolean>;
 /**
  * Returns the initial URL followed by any subsequent changes to the URL.
+ * @return Returns the initial URL or `null`.
  */
 export declare function useURL(): string | null;
-/**
- * Returns the initial URL followed by any subsequent changes to the URL.
- * @deprecated Use `useURL` instead.
- */
-export declare function useUrl(): string | null;
 export * from './Linking.types';
+export * from './Schemes';
+//# sourceMappingURL=Linking.d.ts.map

package/build/Linking.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Linking.d.ts","sourceRoot":"","sources":["../src/Linking.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,mBAAmB,EAAE,MAAM,cAAc,CAAC;AAInD,OAAO,EACL,gBAAgB,EAChB,SAAS,EACT,WAAW,EACX,gBAAgB,EAChB,WAAW,EACZ,MAAM,iBAAiB,CAAC;AAyEzB;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,OAAO,CAAC,IAAI,GAAE,MAAW,EAAE,WAAW,CAAC,EAAE,WAAW,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,CAE7F;AAGD;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,SAAS,CACvB,IAAI,EAAE,MAAM,EACZ,EAAE,MAAM,EAAE,WAAgB,EAAE,eAAuB,EAAE,GAAE,gBAAqB,GAC3E,MAAM,CAgER;AAGD;;;;GAIG;AACH,wBAAgB,KAAK,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,CA6C5C;AAGD;;;;;;;;GAQG;AACH,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,KAAK,EAAE,OAAO,EAAE,WAAW,GAAG,mBAAmB,CAEvF;AAED;;;;;;;;GAQG;AACH,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,KAAK,EAAE,OAAO,EAAE,WAAW,GAAG,IAAI,CAE3E;AAGD;;;;;;GAMG;AACH,wBAAsB,oBAAoB,IAAI,OAAO,CAAC,SAAS,CAAC,CAY/D;AAGD;;;;;GAKG;AACH,wBAAsB,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,gBAAgB,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAK3F;AAGD;;GAEG;AACH,wBAAsB,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC,CAQlD;AAGD;;;GAGG;AACH,wBAAsB,aAAa,IAAI,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAE5D;AAGD;;;;;;;GAOG;AACH,wBAAsB,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAGxD;AAGD;;;;;;;;;GASG;AACH,wBAAsB,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAG9D;AAGD;;;GAGG;AACH,wBAAgB,MAAM,IAAI,MAAM,GAAG,IAAI,CActC;AAED,cAAc,iBAAiB,CAAC;AAChC,cAAc,WAAW,CAAC"}

package/build/Linking.js

@@ -13,8 +13,12 @@ function validateURL(url) {
 function getHostUri() {
     if (Constants.manifest?.hostUri) {
         return Constants.manifest.hostUri;
+        // @ts-ignore: hostUri isn't defined on the expoClient type, because
+        // Constants.manifest is of type AppManifest while
+        // Constants.manifest2.extra.expoClient is of type ExpoConfig
     }
     else if (Constants.manifest2?.extra?.expoClient?.hostUri) {
+        // @ts-ignore
         return Constants.manifest2.extra.expoClient.hostUri;
     }
     else if (!hasCustomScheme()) {
@@ -30,7 +34,8 @@ function isExpoHosted() {
     const hostUri = getHostUri();
     return !!(hostUri &&
         (/^(.*\.)?(expo\.io|exp\.host|exp\.direct|expo\.test)(:.*)?(\/.*)?$/.test(hostUri) ||
-            Constants.manifest?.developer));
+            Constants.manifest?.developer ||
+            Constants.manifest2?.extra?.expoGo?.developer));
 }
 function removeScheme(url) {
     return url.replace(/^[a-zA-Z0-9+.-]+:\/\//, '');
@@ -64,12 +69,12 @@ function ensureLeadingSlash(input, shouldAppend) {
     }
     return input;
 }
+// @needsAudit
 /**
  * Create a URL that works for the environment the app is currently running in.
  * The scheme in bare and standalone must be defined in the app.json under `expo.scheme`.
  *
- * **Examples**
- *
+ * # Examples
  * - Bare: empty string
  * - Standalone, Custom: `yourscheme:///path`
  * - Web (dev): `https://localhost:19006/path`
@@ -78,27 +83,37 @@ function ensureLeadingSlash(input, shouldAppend) {
  * - Expo Client (prod): `exp://exp.host/@yourname/your-app/--/path`
  *
  * @param path addition path components to append to the base URL.
- * @param queryParams An object of parameters that will be converted into a query string.
+ * @param queryParams An object with a set of query parameters. These will be merged with any
+ * Expo-specific parameters that are needed (e.g. release channel) and then appended to the URL
+ * as a query string.
+ * @param scheme Optional URI protocol to use in the URL `<scheme>:///`, when `undefined` the scheme
+ * will be chosen from the Expo config (`app.config.js` or `app.json`).
+ * @return A URL string which points to your app with the given deep link information.
+ * @deprecated An alias for [`createURL()`](#linkingcreateurlpath-namedparameters). This method is
+ * deprecated and will be removed in a future SDK version.
  */
 export function makeUrl(path = '', queryParams, scheme) {
     return createURL(path, { queryParams, scheme, isTripleSlashed: true });
 }
+// @needsAudit
 /**
- * Create a URL that works for the environment the app is currently running in.
- * The scheme in bare and standalone must be defined in the Expo config (app.config.js or app.json) under `expo.scheme`.
+ * Helper method for constructing a deep link into your app, given an optional path and set of query
+ * parameters. Creates a URI scheme with two slashes by default.
  *
- * **Examples**
+ * The scheme in bare and standalone must be defined in the Expo config (`app.config.js` or `app.json`)
+ * under `expo.scheme`.
  *
- * - Bare: `<scheme>://path` -- uses provided scheme or scheme from Expo config `scheme`.
+ * # Examples
+ * - Bare: `<scheme>://path` - uses provided scheme or scheme from Expo config `scheme`.
  * - Standalone, Custom: `yourscheme://path`
  * - Web (dev): `https://localhost:19006/path`
  * - Web (prod): `https://myapp.com/path`
  * - Expo Client (dev): `exp://128.0.0.1:19000/--/path`
  * - Expo Client (prod): `exp://exp.host/@yourname/your-app/--/path`
  *
- * @param path addition path components to append to the base URL.
- * @param scheme URI protocol `<scheme>://` that must be built into your native app.
- * @param queryParams An object of parameters that will be converted into a query string.
+ * @param path Addition path components to append to the base URL.
+ * @param namedParameters Additional options object.
+ * @return A URL string which points to your app with the given deep link information.
  */
 export function createURL(path, { scheme, queryParams = {}, isTripleSlashed = false } = {}) {
     if (Platform.OS === 'web') {
@@ -144,7 +159,7 @@ export function createURL(path, { scheme, queryParams = {}, isTripleSlashed = fa
                 paramsFromHostUri = parsedParams;
             }
         }
-        catch (e) { }
+        catch { }
         queryParams = {
             ...queryParams,
             ...paramsFromHostUri,
@@ -157,10 +172,11 @@ export function createURL(path, { scheme, queryParams = {}, isTripleSlashed = fa
     hostUri = ensureLeadingSlash(hostUri, !isTripleSlashed);
     return encodeURI(`${resolvedScheme}:${isTripleSlashed ? '/' : ''}/${hostUri}${path}${queryString}`);
 }
+// @needsAudit
 /**
- * Returns the components and query parameters for a given URL.
- *
- * @param url Input URL to parse
+ * Helper method for parsing out deep link information from a URL.
+ * @param url A URL that points to the currently running experience (e.g. an output of `Linking.createURL()`).
+ * @return A `ParsedURL` object.
  */
 export function parse(url) {
     validateURL(url);
@@ -200,26 +216,38 @@ export function parse(url) {
         scheme,
     };
 }
+// @needsAudit
 /**
- * Add a handler to Linking changes by listening to the `url` event type
- * and providing the handler
- *
- * See https://reactnative.dev/docs/linking.html#addeventlistener
+ * Add a handler to `Linking` changes by listening to the `url` event type and providing the handler.
+ * It is recommended to use the [`useURL()`](#useurl) hook instead.
+ * @param type The only valid type is `'url'`.
+ * @param handler An [`URLListener`](#urllistener) function that takes an `event` object of the type
+ * [`EventType`](#eventype).
+ * @return An EmitterSubscription that has the remove method from EventSubscription
+ * @see [React Native Docs Linking page](https://reactnative.dev/docs/linking#addeventlistener).
  */
 export function addEventListener(type, handler) {
-    NativeLinking.addEventListener(type, handler);
+    return NativeLinking.addEventListener(type, handler);
 }
 /**
  * Remove a handler by passing the `url` event type and the handler.
+ * @param type The only valid type is `'url'`.
+ * @param handler An [`URLListener`](#urllistener) function that takes an `event` object of the type
+ * [`EventType`](#eventype).
+ * @see [React Native Docs Linking page](https://reactnative.dev/docs/linking#removeeventlistener).
  *
- * See https://reactnative.dev/docs/linking.html#removeeventlistener
+ * @deprecated Call `remove()` on the return value of `addEventListener()` instead.
  */
 export function removeEventListener(type, handler) {
     NativeLinking.removeEventListener(type, handler);
 }
+// @needsAudit
 /**
- * **Native:** Parses the link that opened the app. If no link opened the app, all the fields will be \`null\`.
- * **Web:** Parses the current window URL.
+ * Helper method which wraps React Native's `Linking.getInitialURL()` in `Linking.parse()`.
+ * Parses the deep link information out of the URL used to open the experience initially.
+ * If no link opened the app, all the fields will be `null`.
+ * > On the web it parses the current window URL.
+ * @return A promise that resolves with `ParsedURL` object.
  */
 export async function parseInitialURLAsync() {
     const initialUrl = await NativeLinking.getInitialURL();
@@ -233,9 +261,11 @@ export async function parseInitialURLAsync() {
     }
     return parse(initialUrl);
 }
+// @needsAudit
 /**
- * Launch an Android intent with optional extras
- *
+ * Launch an Android intent with extras.
+ * > Use [IntentLauncher](./intent-launcher) instead, `sendIntent` is only included in
+ * > `Linking` for API compatibility with React Native's Linking API.
  * @platform android
  */
 export async function sendIntent(action, extras) {
@@ -244,10 +274,9 @@ export async function sendIntent(action, extras) {
     }
     throw new UnavailabilityError('Linking', 'sendIntent');
 }
+// @needsAudit
 /**
- * Attempt to open the system settings for an the app.
- *
- * @platform ios
+ * Open the operating system settings app and displays the app’s custom settings, if it has any.
  */
 export async function openSettings() {
     if (Platform.OS === 'web') {
@@ -258,30 +287,46 @@ export async function openSettings() {
     }
     await openURL('app-settings:');
 }
+// @needsAudit
 /**
- * If the app launch was triggered by an app link,
- * it will give the link url, otherwise it will give `null`
+ * Get the URL that was used to launch the app if it was launched by a link.
+ * @return The URL string that launched your app, or `null`.
  */
 export async function getInitialURL() {
     return (await NativeLinking.getInitialURL()) ?? null;
 }
+// @needsAudit
 /**
- * Try to open the given `url` with any of the installed apps.
+ * Attempt to open the given URL with an installed app. See the [Linking guide](/guides/linking)
+ * for more information.
+ * @param url A URL for the operating system to open, eg: `tel:5555555`, `exp://`.
+ * @return A `Promise` that is fulfilled with `true` if the link is opened operating system
+ * automatically or the user confirms the prompt to open the link. The `Promise` rejects if there
+ * are no applications registered for the URL or the user cancels the dialog.
  */
 export async function openURL(url) {
     validateURL(url);
     return await NativeLinking.openURL(url);
 }
+// @needsAudit
 /**
  * Determine whether or not an installed app can handle a given URL.
- * On web this always returns true because there is no API for detecting what URLs can be opened.
+ * On web this always returns `true` because there is no API for detecting what URLs can be opened.
+ * @param url The URL that you want to test can be opened.
+ * @return A `Promise` object that is fulfilled with `true` if the URL can be handled, otherwise it
+ * `false` if not.
+ *
+ * The `Promise` will reject on Android if it was impossible to check if the URL can be opened, and
+ * on iOS if you didn't [add the specific scheme in the `LSApplicationQueriesSchemes` key inside **Info.plist**](/guides/linking#opening-links-to-other-apps).
  */
 export async function canOpenURL(url) {
     validateURL(url);
     return await NativeLinking.canOpenURL(url);
 }
+// @needsAudit
 /**
  * Returns the initial URL followed by any subsequent changes to the URL.
+ * @return Returns the initial URL or `null`.
  */
 export function useURL() {
     const [url, setLink] = useState(null);
@@ -290,18 +335,11 @@ export function useURL() {
     }
     useEffect(() => {
         getInitialURL().then((url) => setLink(url));
-        addEventListener('url', onChange);
-        return () => removeEventListener('url', onChange);
+        const subscription = addEventListener('url', onChange);
+        return () => subscription.remove();
     }, []);
     return url;
 }
-/**
- * Returns the initial URL followed by any subsequent changes to the URL.
- * @deprecated Use `useURL` instead.
- */
-export function useUrl() {
-    console.warn(`Linking.useUrl has been deprecated in favor of Linking.useURL. This API will be removed in SDK 44.`);
-    return useURL();
-}
 export * from './Linking.types';
+export * from './Schemes';
 //# sourceMappingURL=Linking.js.map