[contacts] reuse RN ShareOptions type for shareContactAsync param…

…eter (expo#26208)
duogenesis · Jan 3, 2024 · 01f9be2 · 01f9be2
1 parent 18abadd
commit 01f9be2
Show file tree

Hide file tree

Showing 9 changed files with 20 additions and 14 deletions.
diff --git a/docs/components/plugins/api/APISectionUtils.tsx b/docs/components/plugins/api/APISectionUtils.tsx
@@ -177,6 +177,7 @@ const hardcodedTypeLinks: Record<string, string> = {
   Promise:
     'https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise',
   ReactNode: 'https://reactnative.dev/docs/react-node',
+  ShareOptions: 'https://reactnative.dev/docs/share#share',
   SyntheticEvent: 'https://react.dev/reference/react-dom/components/common#react-event-object',
   View: 'https://reactnative.dev/docs/view',
   ViewProps: 'https://reactnative.dev/docs/view#props',

diff --git a/docs/public/static/data/unversioned/expo-contacts.json b/docs/public/static/data/unversioned/expo-contacts.json
diff --git a/docs/public/static/data/v50.0.0/expo-contacts.json b/docs/public/static/data/v50.0.0/expo-contacts.json
diff --git a/packages/expo-contacts/CHANGELOG.md b/packages/expo-contacts/CHANGELOG.md
@@ -10,6 +10,8 @@
 
 ### 💡 Others
 
+- Reuse React Native `ShareOptions` type for `shareContactAsync` parameter typing. ([#26208](https://github.com/expo/expo/pull/26208) by [@Simek](https://github.com/Simek))
+
 ## 12.8.2 - 2023-12-19
 
 _This version does not introduce any user-facing changes._

diff --git a/packages/expo-contacts/build/Contacts.d.ts b/packages/expo-contacts/build/Contacts.d.ts
diff --git a/packages/expo-contacts/build/Contacts.d.ts.map b/packages/expo-contacts/build/Contacts.d.ts.map
diff --git a/packages/expo-contacts/build/Contacts.js b/packages/expo-contacts/build/Contacts.js
diff --git a/packages/expo-contacts/build/Contacts.js.map b/packages/expo-contacts/build/Contacts.js.map
diff --git a/packages/expo-contacts/src/Contacts.ts b/packages/expo-contacts/src/Contacts.ts
@@ -1,5 +1,5 @@
 import { PermissionResponse, PermissionStatus, UnavailabilityError, uuid } from 'expo-modules-core';
-import { Platform, Share } from 'react-native';
+import { Platform, Share, type ShareOptions } from 'react-native';
 
 import ExpoContacts from './ExpoContacts';
 
@@ -223,7 +223,7 @@ export type UrlAddress = {
  */
 export type Image = {
   /**
-   * A **local image URI**.
+   * A local image URI.
    * > **Note**: If you have a remote URI, download it first using  [`FileSystem.downloadAsync`](/versions/latest/sdk/filesystem/#filesystemdownloadasyncuri-fileuri-options).
    */
   uri?: string;
@@ -387,7 +387,7 @@ export type ContactResponse = {
    */
   hasNextPage: boolean;
   /**
-   * This will be `true if there are previous contacts that weren't retrieved due to `pageOffset` limit.
+   * This will be `true` if there are previous contacts that weren't retrieved due to `pageOffset` limit.
    */
   hasPreviousPage: boolean;
 };
@@ -558,10 +558,11 @@ export async function isAvailableAsync(): Promise<boolean> {
   return !!ExpoContacts.getContactsAsync;
 }
 
+// @docsMissing
 export async function shareContactAsync(
   contactId: string,
   message: string,
-  shareOptions: object = {}
+  shareOptions: ShareOptions = {}
 ): Promise<any> {
   if (Platform.OS === 'ios') {
     const url = await writeContactToFileAsync({
@@ -811,7 +812,7 @@ export async function addExistingGroupToContainerAsync(
 }
 
 /**
- * Create a group with a name, and add it to a container. If the container is undefined, the default container will be targeted.
+ * Create a group with a name, and add it to a container. If the container is `undefined`, the default container will be targeted.
  * @param name Name of the new group.
  * @param containerId The container you to add membership to.
  * @return A promise that fulfills with ID of the new group.