@marktiderman/genesis-chat 0.1.0 → 0.2.0

package/src/native/modules.ts

@@ -0,0 +1,275 @@
+/**
+ * @feat:chat
+ * The native modules chat can use, as the shapes it needs. The app passes the
+ * real ones (each an optional peer); chat never imports them, so it builds and
+ * runs without any of them, and the tests pass fakes:
+ *
+ *   import * as Audio from "expo-audio";                    // voice notes
+ *   import * as ImagePicker from "expo-image-picker";       // photos and videos
+ *   import * as Haptics from "expo-haptics";                // send and record
+ *   import * as Clipboard from "expo-clipboard";            // copy, paste a picture
+ *   import { KeyboardAvoidingView } from "react-native-keyboard-controller";
+ *   import AsyncStorage from "@react-native-async-storage/async-storage"; // drafts
+ *   import * as Sharing from "expo-sharing";                // share a photo
+ *   import * as MediaLibrary from "expo-media-library";     // save a photo
+ *   import NetInfo from "@react-native-community/netinfo";  // retry when back online
+ *   import * as Camera from "expo-camera";                  // video messages
+ *   import * as Video from "expo-video";                    // video playback
+ *   import * as WebBrowser from "expo-web-browser";         // link previews
+ *
+ * FlashList and expo-image come from GenesisNativeApp's `modules` (genesis-ui-native's
+ * GenesisModulesProvider), the same objects every Genesis list and image uses.
+ * The shapes follow the SDK 58 packages' own type declarations.
+ */
+import type { ComponentType, ReactNode } from "react";
+
+/** `RecorderState` from expo-audio (`recorder.getStatus()`). */
+export interface RecorderStateLike {
+  isRecording: boolean;
+  durationMillis: number;
+  /** dB, about -160…0, when `isMeteringEnabled`. */
+  metering?: number;
+  url: string | null;
+}
+
+/** `AudioRecorder` from expo-audio. */
+export interface AudioRecorderLike {
+  prepareToRecordAsync(options?: Record<string, unknown>): Promise<void>;
+  record(): void;
+  stop(): Promise<void>;
+  getStatus(): RecorderStateLike;
+  uri: string | null;
+}
+
+/** `AudioStatus` from expo-audio (`useAudioPlayerStatus`). Seconds. */
+export interface AudioStatusLike {
+  currentTime: number;
+  duration: number;
+  playing: boolean;
+  didJustFinish: boolean;
+  isLoaded: boolean;
+  playbackRate: number;
+}
+
+/** `AudioPlayer` from expo-audio. */
+export interface AudioPlayerLike {
+  play(): void;
+  pause(): void;
+  seekTo(seconds: number): Promise<void>;
+  setPlaybackRate(rate: number): void;
+}
+
+/** `import * as Audio from "expo-audio"` (SDK 58). */
+export interface ExpoAudioLike {
+  useAudioRecorder(options: Record<string, unknown>): AudioRecorderLike;
+  useAudioPlayer(source: { uri: string } | null, options?: { updateInterval?: number }): AudioPlayerLike;
+  useAudioPlayerStatus(player: AudioPlayerLike): AudioStatusLike;
+  RecordingPresets: { HIGH_QUALITY: Record<string, unknown> };
+  requestRecordingPermissionsAsync(): Promise<{ granted: boolean; canAskAgain?: boolean }>;
+  setAudioModeAsync(mode: { allowsRecording?: boolean; playsInSilentMode?: boolean }): Promise<void>;
+}
+
+/** One picked file (`ImagePickerAsset`). */
+export interface PickedAssetLike {
+  uri: string;
+  width?: number;
+  height?: number;
+  fileName?: string | null;
+  fileSize?: number;
+  mimeType?: string;
+  /** Milliseconds, for a video. */
+  duration?: number | null;
+  type?: string | null;
+}
+
+export interface PickerResultLike {
+  canceled: boolean;
+  assets: PickedAssetLike[] | null;
+}
+
+/** `import * as ImagePicker from "expo-image-picker"`. */
+export interface ImagePickerLike {
+  launchImageLibraryAsync(options?: Record<string, unknown>): Promise<PickerResultLike>;
+  launchCameraAsync?(options?: Record<string, unknown>): Promise<PickerResultLike>;
+  requestCameraPermissionsAsync?(): Promise<{ granted: boolean }>;
+}
+
+/** `import * as Haptics from "expo-haptics"`. */
+export interface HapticsLike {
+  impactAsync(style?: never): Promise<void>;
+  selectionAsync(): Promise<void>;
+  notificationAsync(type?: never): Promise<void>;
+  ImpactFeedbackStyle: { Light: unknown; Medium: unknown };
+  NotificationFeedbackType: { Success: unknown; Warning: unknown; Error: unknown };
+}
+
+/** `import * as Clipboard from "expo-clipboard"`. */
+export interface ClipboardLike {
+  setStringAsync(text: string): Promise<boolean>;
+  hasImageAsync?(): Promise<boolean>;
+  /** `data` is a data URI (`data:image/png;base64,…`). */
+  getImageAsync?(options: { format: "png" | "jpeg" }): Promise<{ data: string; size: { width: number; height: number } } | null>;
+}
+
+/** react-native-keyboard-controller's `KeyboardAvoidingView` (needs its `KeyboardProvider`, which GenesisNativeApp mounts). */
+export type KeyboardAvoidingLike = ComponentType<{
+  behavior?: "height" | "padding" | "position" | "translate-with-padding";
+  keyboardVerticalOffset?: number;
+  style?: unknown;
+  children?: ReactNode;
+  testID?: string;
+}>;
+
+/** Where drafts wait: AsyncStorage, or MMKV's async adapter. */
+export interface DraftStorageLike {
+  getItem(key: string): Promise<string | null>;
+  setItem(key: string, value: string): Promise<void>;
+  removeItem(key: string): Promise<void>;
+  /** For `clearDrafts` on sign-out. */
+  getAllKeys?(): Promise<readonly string[]>;
+  multiRemove?(keys: readonly string[]): Promise<void>;
+}
+
+/** `import * as Sharing from "expo-sharing"`: the system share sheet for a file on the phone. */
+export interface SharingLike {
+  isAvailableAsync(): Promise<boolean>;
+  shareAsync(url: string, options?: { mimeType?: string; UTI?: string; dialogTitle?: string }): Promise<void>;
+}
+
+/** `import * as MediaLibrary from "expo-media-library"`: save to Photos (asks for add-only access). */
+export interface MediaLibraryLike {
+  requestPermissionsAsync(writeOnly?: boolean): Promise<{ granted: boolean }>;
+  saveToLibraryAsync(localUri: string): Promise<void>;
+}
+
+/** `NetInfo` from @react-native-community/netinfo: tells chat when the connection comes back. */
+export interface NetInfoLike {
+  addEventListener(listener: (state: { isConnected: boolean | null; isInternetReachable?: boolean | null }) => void): () => void;
+}
+
+/** A permission answer from expo-camera (`PermissionResponse`). */
+export interface PermissionLike {
+  granted: boolean;
+  canAskAgain?: boolean;
+}
+
+/** The `ref` of expo-camera's `CameraView`. */
+export interface CameraViewHandleLike {
+  /** Resolves with the file when `stopRecording` is called, the limit is reached or the preview stops. */
+  recordAsync(options?: { maxDuration?: number; maxFileSize?: number; codec?: string }): Promise<{ uri: string } | undefined>;
+  stopRecording(): void;
+}
+
+/** `import * as Camera from "expo-camera"` (SDK 58): `CameraView` and the permission requests on `Camera`. */
+export interface ExpoCameraLike {
+  CameraView: ComponentType<{
+    ref?: unknown;
+    style?: unknown;
+    facing?: "front" | "back";
+    mode?: "picture" | "video";
+    mirror?: boolean;
+    mute?: boolean;
+    videoQuality?: "2160p" | "1080p" | "720p" | "480p" | "4:3";
+    onCameraReady?: () => void;
+    onMountError?: (event: { message: string }) => void;
+    testID?: string;
+  }>;
+  Camera: {
+    requestCameraPermissionsAsync(): Promise<PermissionLike>;
+    requestMicrophonePermissionsAsync(): Promise<PermissionLike>;
+  };
+}
+
+/** `VideoPlayer` from expo-video. */
+export interface VideoPlayerLike {
+  play(): void;
+  pause(): void;
+  muted: boolean;
+  playing: boolean;
+  playbackRate: number;
+  currentTime: number;
+  addListener(event: "playingChange" | "statusChange" | "playToEnd", listener: (payload: never) => void): { remove(): void };
+}
+
+/** `import * as Video from "expo-video"` (SDK 58). */
+export interface ExpoVideoLike {
+  useVideoPlayer(source: { uri: string; contentType?: "auto" | "progressive" | "hls" } | null, setup?: (player: VideoPlayerLike) => void): VideoPlayerLike;
+  VideoView: ComponentType<{
+    ref?: unknown;
+    player: VideoPlayerLike;
+    style?: unknown;
+    contentFit?: "contain" | "cover" | "fill";
+    nativeControls?: boolean;
+    allowsPictureInPicture?: boolean;
+    testID?: string;
+  }>;
+}
+
+/** The `ref` of expo-video's `VideoView`. */
+export interface VideoViewHandleLike {
+  enterFullscreen(): Promise<void>;
+}
+
+/** `import * as WebBrowser from "expo-web-browser"`: links open in an in-app browser. */
+export interface WebBrowserLike {
+  openBrowserAsync(url: string, options?: Record<string, unknown>): Promise<unknown>;
+}
+
+/** An open file read a chunk at a time (expo-file-system's `new File(uri).open()`), as `createTusUpload` takes. */
+export interface ChunkFileLike {
+  size: number;
+  read(offset: number, length: number): Promise<ArrayBuffer | Uint8Array>;
+  close?(): void;
+}
+
+/** Each optional: without one its feature is hidden (no mic without audio, no attach without a picker). */
+export interface ChatNativeModules {
+  audio?: ExpoAudioLike;
+  imagePicker?: ImagePickerLike;
+  haptics?: HapticsLike;
+  clipboard?: ClipboardLike;
+  keyboardAvoidingView?: KeyboardAvoidingLike;
+  drafts?: DraftStorageLike;
+  /** Share in the photo viewer (with `downloadFile` for photos not on the phone). */
+  sharing?: SharingLike;
+  /** Save in the photo viewer (with `downloadFile`). */
+  mediaLibrary?: MediaLibraryLike;
+  /**
+   * Copies a photo from its signed link to the phone and returns the file:// URI, for sharing
+   * and saving (expo-file-system: `(await File.downloadFileAsync(url, Paths.cache, { idempotent: true })).uri`).
+   */
+  downloadFile?: (url: string) => Promise<string>;
+  /** Unsent messages are retried when the connection comes back (`ChatAutoRetry`). */
+  netInfo?: NetInfoLike;
+  /** Video messages recorded in the thread. Without it there is no video button. */
+  camera?: ExpoCameraLike;
+  /** Video playback (HLS and files) in the bubble. Without it a video shows as a row with its name. */
+  video?: ExpoVideoLike;
+  /** Where links from previews open; without it, the system browser (`Linking`). */
+  webBrowser?: WebBrowserLike;
+  /** Reads a recording a chunk at a time for a hosted upload; without it the file is read whole. */
+  openFile?: (uri: string) => Promise<ChunkFileLike> | ChunkFileLike;
+}
+
+export type HapticEvent = "send" | "record-start" | "record-lock" | "record-cancel" | "select" | "error";
+
+/** Plays a haptic when the app gave expo-haptics; never throws. */
+export function haptic(haptics: HapticsLike | undefined, event: HapticEvent): void {
+  if (!haptics) return;
+  try {
+    const style = (s: unknown) => s as never;
+    const p =
+      event === "send" || event === "record-lock"
+        ? haptics.impactAsync(style(haptics.ImpactFeedbackStyle.Light))
+        : event === "record-start"
+          ? haptics.impactAsync(style(haptics.ImpactFeedbackStyle.Medium))
+          : event === "select"
+            ? haptics.selectionAsync()
+            : haptics.notificationAsync(
+                style(event === "error" ? haptics.NotificationFeedbackType.Error : haptics.NotificationFeedbackType.Warning),
+              );
+    void p?.catch?.(() => undefined);
+  } catch {
+    // A haptic is never worth an error.
+  }
+}

package/src/native/organise-copy.ts

@@ -0,0 +1,195 @@
+/**
+ * @feat:chat
+ * The words of chat's organising features on native (topics, scheduled send, availability,
+ * broadcast, search, moderation), part of `ChatNativeCopy`, so an app overrides them the same
+ * way (`ChatNativeProvider copy`). `{name}`, `{count}`, `{when}` and `{query}` are filled in.
+ */
+export interface ChatOrganiseCopy {
+  // Topics
+  topics: string;
+  topicAll: string;
+  topicClosed: string;
+  topicOptions: string;
+  topicNew: string;
+  topicRename: string;
+  topicClose: string;
+  topicReopen: string;
+  topicName: string;
+  topicNamePlaceholder: string;
+  topicAdd: string;
+  topicSave: string;
+  topicExists: string;
+  topicClosedNotice: string;
+  topicPlaceholder: string;
+  topicClosedDone: string;
+  topicReopenedDone: string;
+  // Scheduled send
+  schedule: string;
+  scheduleTitle: string;
+  scheduleHint: string;
+  schedulePick: string;
+  scheduleDate: string;
+  scheduleTime: string;
+  scheduleConfirm: string;
+  scheduleOutOfRange: string;
+  scheduledFor: string;
+  scheduleFailed: string;
+  scheduleNoFiles: string;
+  scheduledCount: string;
+  scheduledCountOne: string;
+  scheduledTitle: string;
+  scheduledEmpty: string;
+  scheduledEmptyBody: string;
+  scheduledCancel: string;
+  /** On a scheduled message that couldn't be sent. */
+  scheduledRemove: string;
+  scheduledCancelled: string;
+  scheduledCouldntSend: string;
+  // Availability
+  availabilityTitle: string;
+  awayMessage: string;
+  awayMessagePlaceholder: string;
+  awayUntil: string;
+  awayUntilOn: string;
+  imBack: string;
+  workingHours: string;
+  workingHoursOn: string;
+  workingHoursHint: string;
+  workingDay: string;
+  notWorking: string;
+  hoursFrom: string;
+  hoursTo: string;
+  hoursSameTime: string;
+  timeZone: string;
+  timeZoneSearch: string;
+  availabilitySave: string;
+  availabilitySaved: string;
+  // Broadcast
+  broadcastTitle: string;
+  broadcastExplainer: string;
+  broadcastMessage: string;
+  broadcastPlaceholder: string;
+  broadcastTo: string;
+  broadcastFilter: string;
+  broadcastSelectAll: string;
+  broadcastClear: string;
+  broadcastPickSome: string;
+  broadcastPicked: string;
+  broadcastPickedOne: string;
+  broadcastSend: string;
+  broadcastSendTo: string;
+  broadcastSent: string;
+  broadcastSentOne: string;
+  broadcastSentSome: string;
+  broadcastNoMatches: string;
+  broadcastNoConversations: string;
+  // Search
+  search: string;
+  searchPlaceholder: string;
+  searchThreadPlaceholder: string;
+  searchHint: string;
+  searchNoResults: string;
+  searchNoResultsBody: string;
+  searchResults: string;
+  searchResultsOne: string;
+  searchIn: string;
+  transcript: string;
+  messageGone: string;
+  /** Said by VoiceOver when a jump lands. */
+  jumpedTo: string;
+  // Moderation
+  moderationHidden: string;
+  moderationHiddenMine: string;
+  moderationFlagged: string;
+}
+
+export const chatOrganiseCopy: ChatOrganiseCopy = {
+  topics: "Topics",
+  topicAll: "All",
+  topicClosed: "Closed",
+  topicOptions: "Topic options",
+  topicNew: "New topic",
+  topicRename: "Rename topic",
+  topicClose: "Close topic",
+  topicReopen: "Reopen topic",
+  topicName: "Name",
+  topicNamePlaceholder: "Week 1: Habits",
+  topicAdd: "Add topic",
+  topicSave: "Save",
+  topicExists: "There's already a topic with that name.",
+  topicClosedNotice: "This topic is closed.",
+  topicPlaceholder: "Message #{name}",
+  topicClosedDone: "Closed {name}",
+  topicReopenedDone: "Reopened {name}",
+  schedule: "Schedule message",
+  scheduleTitle: "Schedule message",
+  scheduleHint: "It sends at this time, in your time zone, as if you'd sent it then.",
+  schedulePick: "Pick a date and time",
+  scheduleDate: "Date",
+  scheduleTime: "Time",
+  scheduleConfirm: "Schedule",
+  scheduleOutOfRange: "Pick a time from a minute to a year from now.",
+  scheduledFor: "Scheduled for {when}",
+  scheduleFailed: "Couldn't schedule it",
+  scheduleNoFiles: "Photos and files can't be scheduled yet. Send them now, or remove them to schedule the text.",
+  scheduledCount: "{count} scheduled messages",
+  scheduledCountOne: "1 scheduled message",
+  scheduledTitle: "Scheduled",
+  scheduledEmpty: "Nothing scheduled",
+  scheduledEmptyBody: "Touch and hold Send to schedule a message.",
+  scheduledCancel: "Cancel",
+  scheduledRemove: "Remove",
+  scheduledCancelled: "Scheduled message cancelled",
+  scheduledCouldntSend: "Couldn't send",
+  availabilityTitle: "Availability",
+  awayMessage: "Away message",
+  awayMessagePlaceholder: "Back Monday. For anything urgent, call the office.",
+  awayUntil: "Away until",
+  awayUntilOn: "Set an end",
+  imBack: "I'm back",
+  workingHours: "Working hours",
+  workingHoursOn: "Tell people when you usually reply",
+  workingHoursHint: "An end before the start runs past midnight.",
+  workingDay: "Working on {name}",
+  notWorking: "Not working",
+  hoursFrom: "{name} from",
+  hoursTo: "{name} to",
+  hoursSameTime: "A day's start and end can't be the same time.",
+  timeZone: "Time zone",
+  timeZoneSearch: "Search time zones",
+  availabilitySave: "Save",
+  availabilitySaved: "Availability saved",
+  broadcastTitle: "Broadcast",
+  broadcastExplainer: "Each person gets this in their own conversation with you, so replies come back to you privately. No one sees who else got it.",
+  broadcastMessage: "Message",
+  broadcastPlaceholder: "Write once, send to everyone you pick",
+  broadcastTo: "Send to",
+  broadcastFilter: "Filter",
+  broadcastSelectAll: "Select all",
+  broadcastClear: "Clear",
+  broadcastPickSome: "Pick who gets it",
+  broadcastPicked: "{count} conversations",
+  broadcastPickedOne: "1 conversation",
+  broadcastSend: "Send",
+  broadcastSendTo: "Send to {count}",
+  broadcastSent: "Sent to {count} conversations",
+  broadcastSentOne: "Sent to 1 conversation",
+  broadcastSentSome: "Sent to {count} of {total}. You can't post in the others.",
+  broadcastNoMatches: "No matches",
+  broadcastNoConversations: "No conversations yet",
+  search: "Search",
+  searchPlaceholder: "Search messages",
+  searchThreadPlaceholder: "Search this conversation",
+  searchHint: "Type at least two letters.",
+  searchNoResults: "No results",
+  searchNoResultsBody: "Nothing matches “{query}”.",
+  searchResults: "{count} results",
+  searchResultsOne: "1 result",
+  searchIn: "in {name}",
+  transcript: "Transcript",
+  messageGone: "That message isn't here any more",
+  jumpedTo: "Message from {name}: {text}",
+  moderationHidden: "Hidden by moderation",
+  moderationHiddenMine: "Hidden by moderation. Only you can see it.",
+  moderationFlagged: "Flagged",
+};