@fendent/react-native-enriched 0.5.2-fork.1

package/package.json

@@ -0,0 +1,226 @@
+{
+  "name": "@fendent/react-native-enriched",
+  "version": "0.5.2-fork.1",
+  "description": "Rich Text Editor component for React Native",
+  "source": "./src/index.tsx",
+  "main": "./lib/module/index.js",
+  "types": "./lib/typescript/src/index.d.ts",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "react-native": {
+        "types": "./lib/typescript/src/index.d.ts",
+        "default": "./lib/module/index.js"
+      },
+      "types": "./lib/typescript/src/index.d.ts",
+      "default": "./lib/module/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "src",
+    "lib",
+    "android",
+    "ios",
+    "cpp",
+    "*.podspec",
+    "react-native.config.js",
+    "!src/web",
+    "!src/index.web.tsx",
+    "!lib/module/web",
+    "!lib/module/index.web.js",
+    "!lib/module/index.web.js.map",
+    "!lib/typescript/src/web",
+    "!lib/typescript/src/index.web.d.ts",
+    "!lib/typescript/src/index.web.d.ts.map",
+    "!ios/build",
+    "!android/build",
+    "!android/gradle",
+    "!android/gradlew",
+    "!android/gradlew.bat",
+    "!android/local.properties",
+    "!**/__tests__",
+    "!**/__fixtures__",
+    "!**/__mocks__",
+    "!**/.*"
+  ],
+  "scripts": {
+    "example": "yarn workspace react-native-enriched-example",
+    "example-web": "yarn workspace react-native-enriched-web-example",
+    "test": "jest --passWithNoTests",
+    "typecheck": "yarn typecheck:lib && yarn typecheck:example && yarn typecheck:example-web",
+    "typecheck:lib": "tsc -p tsconfig.build.json",
+    "typecheck:example": "tsc -p apps/example/tsconfig.json",
+    "typecheck:example-web": "tsc -p apps/example-web/tsconfig.app.json",
+    "lint": "eslint \"**/*.{js,ts,tsx}\"",
+    "lint:android": "cd apps/example/android && ./gradlew lintVerify",
+    "lint:android:fix": "cd apps/example/android && ./gradlew lintFormat",
+    "lint-clang:ios": "find ios/ \\( -iname \"*.h\" -o -iname \"*.m\" -o -iname \"*.mm\" \\) | grep -v -e Pods -e build -e generated | xargs npx clang-format -i -n --Werror",
+    "lint-clang:ios:fix": "find ios/ \\( -iname \"*.h\" -o -iname \"*.m\" -o -iname \"*.mm\" \\) | grep -v -e Pods -e build -e generated | xargs npx clang-format -i",
+    "lint-clang:android": "find android/ \\( -iname \"*.h\" -o -iname \"*.cpp\" \\) | grep -v -e build -e generated | xargs npx clang-format -i -n --Werror",
+    "lint-clang:android:fix": "find android/ \\( -iname \"*.h\" -o -iname \"*.cpp\" \\) | grep -v -e build -e generated | xargs npx clang-format -i",
+    "lint-clang": "yarn lint-clang:ios && yarn lint-clang:android",
+    "lint-clang:fix": "yarn lint-clang:ios:fix && yarn lint-clang:android:fix",
+    "clean": "del-cli android/build apps/example/android/build apps/example/android/app/build apps/example/ios/build lib",
+    "prepare": "bob build",
+    "release": "release-it",
+    "android-studio": "open -a 'Android Studio' apps/example/android",
+    "xcode": "open -a 'Xcode' apps/example/ios/EnrichedTextInputExample.xcworkspace",
+    "test:e2e:mobile": ".maestro/scripts/run-tests-all.sh",
+    "test:e2e:android": ".maestro/scripts/run-tests.sh --platform android",
+    "test:e2e:ios": ".maestro/scripts/run-tests.sh --platform ios",
+    "test:e2e:web": "playwright test --config .playwright/playwright.config.ts",
+    "test:e2e": "yarn test:e2e:mobile && yarn test:e2e:web"
+  },
+  "keywords": [
+    "react-native",
+    "ios",
+    "android"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/software-mansion/react-native-enriched.git"
+  },
+  "author": "Software Mansion <contact@swmansion.com> (https://swmansion.com)",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/software-mansion/react-native-enriched/issues"
+  },
+  "homepage": "https://github.com/software-mansion/react-native-enriched#readme",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/"
+  },
+  "dependencies": {
+    "@tiptap/core": "3.20.4",
+    "@tiptap/extension-document": "3.20.4",
+    "@tiptap/extension-paragraph": "3.20.4",
+    "@tiptap/extension-text": "3.20.4",
+    "@tiptap/extensions": "3.20.4",
+    "@tiptap/pm": "3.20.4",
+    "@tiptap/react": "3.20.4"
+  },
+  "devDependencies": {
+    "@commitlint/config-conventional": "^19.6.0",
+    "@eslint/compat": "^1.2.7",
+    "@eslint/eslintrc": "^3.3.0",
+    "@eslint/js": "^9.22.0",
+    "@evilmartians/lefthook": "^1.5.0",
+    "@playwright/test": "1.58.2",
+    "@react-native-community/cli": "20.0.0",
+    "@react-native/eslint-config": "^0.81.0",
+    "@release-it/conventional-changelog": "^9.0.2",
+    "@types/jest": "^29.5.5",
+    "@types/react": "^19.1.0",
+    "@types/react-dom": "^19.1.0",
+    "clang-format": "^1.8.0",
+    "commitlint": "^19.6.1",
+    "del-cli": "^5.1.0",
+    "eslint": "^9.22.0",
+    "eslint-config-prettier": "^10.1.1",
+    "eslint-plugin-prettier": "^5.2.3",
+    "jest": "^29.7.0",
+    "playwright": "1.58.2",
+    "prettier": "^3.0.3",
+    "react": "19.1.0",
+    "react-dom": "19.1.0",
+    "react-native": "0.81.0",
+    "react-native-builder-bob": "^0.40.18",
+    "release-it": "^17.10.0",
+    "turbo": "^1.10.7",
+    "typescript": "^5.8.3"
+  },
+  "peerDependencies": {
+    "react": "*",
+    "react-native": "*"
+  },
+  "workspaces": [
+    "apps/example",
+    "apps/example-web"
+  ],
+  "packageManager": "yarn@3.6.1",
+  "jest": {
+    "preset": "react-native",
+    "modulePathIgnorePatterns": [
+      "<rootDir>/apps/example/node_modules",
+      "<rootDir>/lib/"
+    ],
+    "testPathIgnorePatterns": [
+      "/node_modules/",
+      "<rootDir>/.playwright/",
+      "<rootDir>/apps/example-web/"
+    ]
+  },
+  "commitlint": {
+    "extends": [
+      "@commitlint/config-conventional"
+    ]
+  },
+  "release-it": {
+    "git": {
+      "commitMessage": "chore: release ${version}",
+      "tagName": "v${version}"
+    },
+    "npm": {
+      "publish": true
+    },
+    "github": {
+      "release": true
+    },
+    "plugins": {
+      "@release-it/conventional-changelog": {
+        "preset": {
+          "name": "angular"
+        }
+      }
+    }
+  },
+  "prettier": {
+    "quoteProps": "consistent",
+    "singleQuote": true,
+    "tabWidth": 2,
+    "trailingComma": "es5",
+    "useTabs": false
+  },
+  "react-native-builder-bob": {
+    "source": "src",
+    "output": "lib",
+    "targets": [
+      "codegen",
+      [
+        "module",
+        {
+          "esm": true
+        }
+      ],
+      [
+        "typescript",
+        {
+          "project": "tsconfig.build.json"
+        }
+      ]
+    ]
+  },
+  "codegenConfig": {
+    "name": "ReactNativeEnrichedSpec",
+    "type": "components",
+    "jsSrcsDir": "src/spec",
+    "outputDir": {
+      "ios": "ios/generated",
+      "android": "android/generated"
+    },
+    "android": {
+      "javaPackageName": "com.swmansion.enriched"
+    },
+    "ios": {
+      "componentProvider": {
+        "EnrichedTextInputView": "EnrichedTextInputView"
+      }
+    },
+    "includesGeneratedCode": true
+  },
+  "create-react-native-library": {
+    "languages": "kotlin-objc",
+    "type": "fabric-view",
+    "version": "0.49.8"
+  }
+}

package/react-native.config.js

@@ -0,0 +1,13 @@
+/**
+ * @type {import('@react-native-community/cli-types').UserDependencyConfig}
+ */
+module.exports = {
+  dependency: {
+    platforms: {
+      android: {
+        cmakeListsPath: '../android/src/main/new_arch/CMakeLists.txt',
+        componentDescriptors: ['EnrichedTextInputComponentDescriptor'],
+      },
+    },
+  },
+};

package/src/index.tsx

@@ -0,0 +1,20 @@
+export { EnrichedTextInput } from './native/EnrichedTextInput';
+export type {
+  EnrichedTextInputProps,
+  OnChangeTextEvent,
+  OnChangeHtmlEvent,
+  OnChangeStateEvent,
+  OnLinkDetected,
+  OnMentionDetected,
+  OnChangeSelectionEvent,
+  OnKeyPressEvent,
+  OnPasteImagesEvent,
+  OnSubmitEditing,
+  HtmlStyle,
+  MentionStyleProperties,
+  FocusEvent,
+  BlurEvent,
+  EnrichedTextInputInstance,
+  ContextMenuItem,
+  OnChangeMentionEvent,
+} from './types';

package/src/native/EnrichedTextInput.tsx

@@ -0,0 +1,370 @@
+import {
+  type Component,
+  useEffect,
+  useImperativeHandle,
+  useMemo,
+  useRef,
+} from 'react';
+import { useCallback } from 'react';
+import EnrichedTextInputNativeComponent, {
+  Commands,
+  type NativeProps,
+  type OnContextMenuItemPressEvent,
+  type OnMentionEvent,
+  type OnMentionDetectedInternal,
+  type OnRequestHtmlResultEvent,
+} from '../spec/EnrichedTextInputNativeComponent';
+import type {
+  HostInstance,
+  MeasureInWindowOnSuccessCallback,
+  MeasureLayoutOnSuccessCallback,
+  MeasureOnSuccessCallback,
+  NativeMethods,
+  NativeSyntheticEvent,
+} from 'react-native';
+import { normalizeHtmlStyle } from '../utils/normalizeHtmlStyle';
+import { toNativeRegexConfig } from '../utils/regexParser';
+import { nullthrows } from '../utils/nullthrows';
+import { ENRICHED_TEXT_INPUT_DEFAULT_PROPS } from '../utils/EnrichedTextInputDefaultProps';
+import type {
+  ContextMenuItem,
+  EnrichedTextInputProps,
+  OnLinkDetected,
+  OnMentionDetected,
+} from '../types';
+
+const warnMentionIndicators = (indicator: string) => {
+  console.warn(
+    `Looks like you are trying to set a "${indicator}" but it's not in the mentionIndicators prop`
+  );
+};
+
+type ComponentType = (Component<NativeProps, {}, any> & NativeMethods) | null;
+
+type HtmlRequest = {
+  resolve: (html: string) => void;
+  reject: (error: Error) => void;
+};
+
+export const EnrichedTextInput = ({
+  ref,
+  autoFocus,
+  editable = ENRICHED_TEXT_INPUT_DEFAULT_PROPS.editable,
+  mentionIndicators = ENRICHED_TEXT_INPUT_DEFAULT_PROPS.mentionIndicators.slice(),
+  defaultValue,
+  placeholder,
+  placeholderTextColor,
+  cursorColor,
+  selectionColor,
+  style,
+  autoCapitalize = ENRICHED_TEXT_INPUT_DEFAULT_PROPS.autoCapitalize,
+  htmlStyle = ENRICHED_TEXT_INPUT_DEFAULT_PROPS.htmlStyle,
+  linkRegex: _linkRegex,
+  onFocus,
+  onBlur,
+  onChangeText,
+  onChangeHtml,
+  onChangeState,
+  onLinkDetected,
+  onMentionDetected,
+  onStartMention,
+  onChangeMention,
+  onEndMention,
+  onChangeSelection,
+  onKeyPress,
+  onSubmitEditing,
+  returnKeyType,
+  returnKeyLabel,
+  submitBehavior,
+  contextMenuItems,
+  androidExperimentalSynchronousEvents = ENRICHED_TEXT_INPUT_DEFAULT_PROPS.androidExperimentalSynchronousEvents,
+  useHtmlNormalizer = ENRICHED_TEXT_INPUT_DEFAULT_PROPS.useHtmlNormalizer,
+  scrollEnabled = ENRICHED_TEXT_INPUT_DEFAULT_PROPS.scrollEnabled,
+  ...rest
+}: EnrichedTextInputProps) => {
+  const nativeRef = useRef<ComponentType | null>(null);
+
+  const nextHtmlRequestId = useRef(1);
+  const pendingHtmlRequests = useRef(new Map<number, HtmlRequest>());
+
+  // Store onPress callbacks in a ref so native only receives serializable data
+  const contextMenuCallbacksRef = useRef<
+    Map<string, ContextMenuItem['onPress']>
+  >(new Map());
+
+  useEffect(() => {
+    const callbacksMap = new Map<string, ContextMenuItem['onPress']>();
+    if (contextMenuItems) {
+      for (const item of contextMenuItems) {
+        callbacksMap.set(item.text, item.onPress);
+      }
+    }
+    contextMenuCallbacksRef.current = callbacksMap;
+  }, [contextMenuItems]);
+
+  const nativeContextMenuItems = useMemo(
+    () =>
+      contextMenuItems
+        ?.filter((item) => item.visible !== false)
+        .map((item) => ({
+          text: item.text,
+        })),
+    [contextMenuItems]
+  );
+
+  const handleContextMenuItemPress = useCallback(
+    (e: NativeSyntheticEvent<OnContextMenuItemPressEvent>) => {
+      const {
+        itemText,
+        selectedText,
+        selectionStart,
+        selectionEnd,
+        styleState,
+      } = e.nativeEvent;
+      const callback = contextMenuCallbacksRef.current.get(itemText);
+      callback?.({
+        text: selectedText,
+        selection: { start: selectionStart, end: selectionEnd },
+        styleState,
+      });
+    },
+    []
+  );
+
+  useEffect(() => {
+    const pendingRequests = pendingHtmlRequests.current;
+    return () => {
+      pendingRequests.forEach(({ reject }) => {
+        reject(new Error('Component unmounted'));
+      });
+      pendingRequests.clear();
+    };
+  }, []);
+
+  const normalizedHtmlStyle = useMemo(
+    () => normalizeHtmlStyle(htmlStyle, mentionIndicators),
+    [htmlStyle, mentionIndicators]
+  );
+
+  const linkRegex = useMemo(
+    () => toNativeRegexConfig(_linkRegex),
+    [_linkRegex]
+  );
+
+  useImperativeHandle(ref, () => ({
+    measureInWindow: (callback: MeasureInWindowOnSuccessCallback) => {
+      nullthrows(nativeRef.current).measureInWindow(callback);
+    },
+    measure: (callback: MeasureOnSuccessCallback) => {
+      nullthrows(nativeRef.current).measure(callback);
+    },
+    measureLayout: (
+      relativeToNativeComponentRef: HostInstance | number,
+      onSuccess: MeasureLayoutOnSuccessCallback,
+      onFail?: () => void
+    ) => {
+      nullthrows(nativeRef.current).measureLayout(
+        relativeToNativeComponentRef,
+        onSuccess,
+        onFail
+      );
+    },
+    setNativeProps: (nativeProps: object) => {
+      nullthrows(nativeRef.current).setNativeProps(nativeProps);
+    },
+    focus: () => {
+      Commands.focus(nullthrows(nativeRef.current));
+    },
+    blur: () => {
+      Commands.blur(nullthrows(nativeRef.current));
+    },
+    setValue: (value: string) => {
+      Commands.setValue(nullthrows(nativeRef.current), value);
+    },
+    insertText: (text: string, start?: number, end?: number) => {
+      const s = start ?? -1;
+      const e = end ?? s;
+      Commands.insertText(nullthrows(nativeRef.current), text, s, e);
+    },
+    getHTML: () => {
+      return new Promise<string>((resolve, reject) => {
+        const requestId = nextHtmlRequestId.current++;
+        pendingHtmlRequests.current.set(requestId, { resolve, reject });
+        Commands.requestHTML(nullthrows(nativeRef.current), requestId);
+      });
+    },
+    toggleBold: () => {
+      Commands.toggleBold(nullthrows(nativeRef.current));
+    },
+    toggleItalic: () => {
+      Commands.toggleItalic(nullthrows(nativeRef.current));
+    },
+    toggleUnderline: () => {
+      Commands.toggleUnderline(nullthrows(nativeRef.current));
+    },
+    toggleStrikeThrough: () => {
+      Commands.toggleStrikeThrough(nullthrows(nativeRef.current));
+    },
+    toggleInlineCode: () => {
+      Commands.toggleInlineCode(nullthrows(nativeRef.current));
+    },
+    toggleH1: () => {
+      Commands.toggleH1(nullthrows(nativeRef.current));
+    },
+    toggleH2: () => {
+      Commands.toggleH2(nullthrows(nativeRef.current));
+    },
+    toggleH3: () => {
+      Commands.toggleH3(nullthrows(nativeRef.current));
+    },
+    toggleH4: () => {
+      Commands.toggleH4(nullthrows(nativeRef.current));
+    },
+    toggleH5: () => {
+      Commands.toggleH5(nullthrows(nativeRef.current));
+    },
+    toggleH6: () => {
+      Commands.toggleH6(nullthrows(nativeRef.current));
+    },
+    toggleCodeBlock: () => {
+      Commands.toggleCodeBlock(nullthrows(nativeRef.current));
+    },
+    toggleBlockQuote: () => {
+      Commands.toggleBlockQuote(nullthrows(nativeRef.current));
+    },
+    toggleOrderedList: () => {
+      Commands.toggleOrderedList(nullthrows(nativeRef.current));
+    },
+    toggleUnorderedList: () => {
+      Commands.toggleUnorderedList(nullthrows(nativeRef.current));
+    },
+    toggleCheckboxList: (checked: boolean) => {
+      Commands.toggleCheckboxList(nullthrows(nativeRef.current), checked);
+    },
+    setLink: (start: number, end: number, text: string, url: string) => {
+      Commands.addLink(nullthrows(nativeRef.current), start, end, text, url);
+    },
+    removeLink: (start: number, end: number) => {
+      Commands.removeLink(nullthrows(nativeRef.current), start, end);
+    },
+    setImage: (uri: string, width: number, height: number) => {
+      Commands.addImage(nullthrows(nativeRef.current), uri, width, height);
+    },
+    setMention: (
+      indicator: string,
+      text: string,
+      attributes?: Record<string, string>
+    ) => {
+      // Codegen does not support objects as Commands parameters, so we stringify attributes
+      const parsedAttributes = JSON.stringify(attributes ?? {});
+
+      Commands.addMention(
+        nullthrows(nativeRef.current),
+        indicator,
+        text,
+        parsedAttributes
+      );
+    },
+    startMention: (indicator: string) => {
+      if (!mentionIndicators?.includes(indicator)) {
+        warnMentionIndicators(indicator);
+      }
+
+      Commands.startMention(nullthrows(nativeRef.current), indicator);
+    },
+    setSelection: (start: number, end: number) => {
+      Commands.setSelection(nullthrows(nativeRef.current), start, end);
+    },
+  }));
+
+  const handleMentionEvent = (e: NativeSyntheticEvent<OnMentionEvent>) => {
+    const mentionText = e.nativeEvent.text;
+    const mentionIndicator = e.nativeEvent.indicator;
+
+    if (typeof mentionText === 'string') {
+      if (mentionText === '') {
+        onStartMention?.(mentionIndicator);
+      } else {
+        onChangeMention?.({ indicator: mentionIndicator, text: mentionText });
+      }
+    } else if (mentionText === null) {
+      onEndMention?.(mentionIndicator);
+    }
+  };
+
+  const handleLinkDetected = (e: NativeSyntheticEvent<OnLinkDetected>) => {
+    const { text, url, start, end } = e.nativeEvent;
+    onLinkDetected?.({ text, url, start, end });
+  };
+
+  const handleMentionDetected = (
+    e: NativeSyntheticEvent<OnMentionDetectedInternal>
+  ) => {
+    const { text, indicator, payload } = e.nativeEvent;
+    const attributes = JSON.parse(payload) as Record<string, string>;
+    onMentionDetected?.({
+      text,
+      indicator,
+      attributes,
+    } satisfies OnMentionDetected);
+  };
+
+  const handleRequestHtmlResult = (
+    e: NativeSyntheticEvent<OnRequestHtmlResultEvent>
+  ) => {
+    const { requestId, html } = e.nativeEvent;
+    const pending = pendingHtmlRequests.current.get(requestId);
+    if (!pending) return;
+
+    if (html === null || typeof html !== 'string') {
+      pending.reject(new Error('Failed to parse HTML'));
+    } else {
+      pending.resolve(html);
+    }
+
+    pendingHtmlRequests.current.delete(requestId);
+  };
+
+  return (
+    <EnrichedTextInputNativeComponent
+      ref={nativeRef}
+      mentionIndicators={mentionIndicators}
+      editable={editable}
+      autoFocus={autoFocus}
+      defaultValue={defaultValue}
+      placeholder={placeholder}
+      placeholderTextColor={placeholderTextColor}
+      cursorColor={cursorColor}
+      selectionColor={selectionColor}
+      style={style}
+      autoCapitalize={autoCapitalize}
+      htmlStyle={normalizedHtmlStyle}
+      linkRegex={linkRegex}
+      onInputFocus={onFocus}
+      onInputBlur={onBlur}
+      onChangeText={onChangeText}
+      onChangeHtml={onChangeHtml}
+      isOnChangeHtmlSet={onChangeHtml !== undefined}
+      isOnChangeTextSet={onChangeText !== undefined}
+      onChangeState={onChangeState}
+      onLinkDetected={handleLinkDetected}
+      onMentionDetected={handleMentionDetected}
+      onMention={handleMentionEvent}
+      onChangeSelection={onChangeSelection}
+      onRequestHtmlResult={handleRequestHtmlResult}
+      onInputKeyPress={onKeyPress}
+      contextMenuItems={nativeContextMenuItems}
+      onContextMenuItemPress={handleContextMenuItemPress}
+      onSubmitEditing={onSubmitEditing}
+      returnKeyType={returnKeyType}
+      returnKeyLabel={returnKeyLabel}
+      submitBehavior={submitBehavior}
+      androidExperimentalSynchronousEvents={
+        androidExperimentalSynchronousEvents
+      }
+      useHtmlNormalizer={useHtmlNormalizer}
+      scrollEnabled={scrollEnabled}
+      {...rest}
+    />
+  );
+};