@symbiote-native/sharing 3.0.1 → 3.0.3

package/src/core/sharing.ts

@@ -1,7 +1,11 @@
 import { UnavailabilityError } from 'expo-modules-core';
 
 import { expoSharing } from './native-module';
-import type { ISharingOptions } from './types';
+import type {
+  IResolvedSharePayload,
+  ISharePayload,
+  ISharingOptions,
+} from './types';
 
 const NATIVE_MODULE_NAME = 'expo-sharing';
 
@@ -38,6 +42,34 @@ export async function shareAsync(
   await expoSharing.shareAsync(url, options);
 }
 
+// Empty until the host app carries the share target (iOS Share Extension, Android intent filters)
+export function getSharedPayloads(): ISharePayload[] {
+  if (!expoSharing.getSharedPayloads) {
+    throw new UnavailabilityError(NATIVE_MODULE_NAME, 'getSharedPayloads');
+  }
+  return expoSharing.getSharedPayloads();
+}
+
+// Adds display details per payload, resolving a shared URL may need the network
+export async function getResolvedSharedPayloadsAsync(): Promise<
+  IResolvedSharePayload[]
+> {
+  if (!expoSharing.getResolvedSharedPayloadsAsync) {
+    throw new UnavailabilityError(
+      NATIVE_MODULE_NAME,
+      'getResolvedSharedPayloadsAsync',
+    );
+  }
+  return expoSharing.getResolvedSharedPayloadsAsync();
+}
+
+export function clearSharedPayloads(): void {
+  if (!expoSharing.clearSharedPayloads) {
+    throw new UnavailabilityError(NATIVE_MODULE_NAME, 'clearSharedPayloads');
+  }
+  expoSharing.clearSharedPayloads();
+}
+
 // Not in upstream, which hands anything straight to the native module. An empty or non-string
 // url surfaces there as an argument-conversion failure on iOS and a generic "Failed to share the
 // file" on Android — both far enough from the call site to be worth failing early with the

package/src/core/types.ts

@@ -37,3 +37,55 @@ export type ISharingOptions = {
    */
   anchor?: ISharingAnchor;
 };
+
+export type IShareType = 'text' | 'url' | 'audio' | 'image' | 'video' | 'file';
+
+export type IContentType =
+  'text' | 'audio' | 'image' | 'video' | 'file' | 'website';
+
+/** Raw data shared with the app (android, ios) */
+export type ISharePayload = {
+  /** Message body for `text`, the URL for `url`, otherwise typically the file URI */
+  value: string;
+  shareType: IShareType;
+  /** MIME type of `value` */
+  mimeType?: string;
+};
+
+export type IBaseResolvedSharePayload = ISharePayload & {
+  /** Where the content can be read from (the redirect target for a URL), null for text */
+  contentUri: string | null;
+  contentType: IContentType | null;
+  contentMimeType: string | null;
+  /** The `suggestedFilename` HTTP header if present, otherwise the last path component */
+  originalName: string | null;
+  contentSize: number | null;
+};
+
+export type IUriBasedResolvedSharePayload = IBaseResolvedSharePayload & {
+  contentType: 'audio' | 'file' | 'video' | 'image' | 'website';
+  contentUri: string;
+};
+
+export type ITextBasedResolvedSharePayload = IBaseResolvedSharePayload & {
+  contentType?: 'text';
+};
+
+/** A payload plus the details needed to display it, resolving a URL may need the network */
+export type IResolvedSharePayload =
+  IUriBasedResolvedSharePayload | ITextBasedResolvedSharePayload;
+
+export type IIncomingShareSnapshot = {
+  /** Unresolved payloads, available synchronously from the first read */
+  sharedPayloads: ISharePayload[];
+  /** Empty while resolving or when resolving failed */
+  resolvedSharedPayloads: IResolvedSharePayload[];
+  isResolving: boolean;
+  /** The error hit while resolving, null on success */
+  error: Error | null;
+};
+
+export type IUseIncomingShareResult = IIncomingShareSnapshot & {
+  clearSharedPayloads: () => void;
+  refreshSharePayloads: () => void;
+};

package/src/react/index.ts

@@ -0,0 +1,2 @@
+export * from '../core';
+export { useIncomingShare } from './use-incoming-share';

package/src/react/use-incoming-share.ts

@@ -0,0 +1,24 @@
+import { useState } from 'react';
+import { createEventValueHook } from '@symbiote-native/react';
+import {
+  createIncomingShareStore,
+  INCOMING_SHARE_CHANGE,
+} from '../core/incoming-share-store';
+import { withShareActions } from '../core/incoming-share-result';
+import type { IIncomingShareStore } from '../core/incoming-share-store';
+import type {
+  IIncomingShareSnapshot,
+  IUseIncomingShareResult,
+} from '../core/types';
+
+const useShareSnapshot = createEventValueHook<
+  IIncomingShareStore,
+  IIncomingShareSnapshot,
+  typeof INCOMING_SHARE_CHANGE
+>(INCOMING_SHARE_CHANGE, store => store.getSnapshot());
+
+/** React twin of `expo-sharing`'s `useIncomingShare` */
+export function useIncomingShare(): IUseIncomingShareResult {
+  const [store] = useState(createIncomingShareStore);
+  return withShareActions(useShareSnapshot(store), store);
+}

package/src/solid/index.ts

@@ -0,0 +1,2 @@
+export * from '../core';
+export { useIncomingShare } from './use-incoming-share';

package/src/solid/use-incoming-share.ts

@@ -0,0 +1,13 @@
+import { createMemo, type Accessor } from 'solid-js';
+import { createEventValueHook } from '@symbiote-native/solid';
+import { createIncomingShareHook } from '../core/incoming-share-hook';
+import type {
+  IIncomingShareSnapshot,
+  IUseIncomingShareResult,
+} from '../core/types';
+
+/** Solid twin of `expo-sharing`'s `useIncomingShare` */
+export const useIncomingShare = createIncomingShareHook<
+  Accessor<IIncomingShareSnapshot>,
+  Accessor<IUseIncomingShareResult>
+>(createEventValueHook, box => box(), createMemo);

package/src/svelte/index.ts

@@ -0,0 +1,2 @@
+export * from '../core';
+export { useIncomingShare } from './use-incoming-share.svelte';

package/src/svelte/svelte-ambient.d.ts

@@ -0,0 +1,3 @@
+// Pulls svelte's ambient globals ($state/$effect/...) into this package's tsc program,
+// same fix as `packages/navigation/src/svelte/svelte-ambient.d.ts`
+/// <reference types="svelte" />

package/src/svelte/svelte-compile.test-helper.ts

@@ -0,0 +1,7 @@
+// Re-exports the existing harness instead of a third copy (packages/sqlite and
+// packages/navigation already carry one, not part of either package's public exports)
+export {
+  createSvelteHarness,
+  loadComponent,
+  type ISvelteHarness,
+} from '../../../sqlite/src/svelte/svelte-compile.test-helper';

package/src/svelte/use-incoming-share.svelte.ts

@@ -0,0 +1,22 @@
+import { createEventValueHook } from '@symbiote-native/svelte/runes/create-event-value-hook';
+import { createIncomingShareHook } from '../core/incoming-share-hook';
+import type {
+  IIncomingShareSnapshot,
+  IUseIncomingShareResult,
+} from '../core/types';
+
+type IBox<TValue> = { readonly current: TValue };
+
+/** Svelte twin of `expo-sharing`'s `useIncomingShare` */
+export const useIncomingShare = createIncomingShareHook<
+  IBox<IIncomingShareSnapshot>,
+  IBox<IUseIncomingShareResult>
+>(
+  createEventValueHook,
+  box => box.current,
+  compute => ({
+    get current(): IUseIncomingShareResult {
+      return compute();
+    },
+  }),
+);

package/src/vue/index.ts

@@ -0,0 +1,2 @@
+export * from '../core';
+export { useIncomingShare } from './use-incoming-share';

package/src/vue/use-incoming-share.ts

@@ -0,0 +1,13 @@
+import { computed, type ComputedRef, type ShallowRef } from '@vue/runtime-core';
+import { createEventValueHook } from '@symbiote-native/vue';
+import { createIncomingShareHook } from '../core/incoming-share-hook';
+import type {
+  IIncomingShareSnapshot,
+  IUseIncomingShareResult,
+} from '../core/types';
+
+/** Vue twin of `expo-sharing`'s `useIncomingShare` */
+export const useIncomingShare = createIncomingShareHook<
+  ShallowRef<IIncomingShareSnapshot>,
+  ComputedRef<IUseIncomingShareResult>
+>(createEventValueHook, box => box.value, computed);