react-native-worklets 0.2.0 → 0.3.0-nightly-20250424-43520c73e

package/scripts/worklets_utils.rb

@@ -12,7 +12,8 @@ def worklets_find_config()
     :react_native_version => nil,
     :react_native_minor_version => nil,
     :react_native_node_modules_dir => nil,
-    :react_native_common_dir => nil
+    :react_native_common_dir => nil,
+    :dynamic_frameworks_worklets_dir => nil,
   }
 
   react_native_node_modules_dir = File.join(File.dirname(`cd "#{Pod::Config.instance.installation_root.to_s}" && node --print "require.resolve('react-native/package.json')"`), '..')
@@ -41,6 +42,10 @@ def worklets_find_config()
   react_native_common_dir_relative = Pathname.new(react_native_common_dir_absolute).relative_path_from(pods_root).to_s
   result[:react_native_common_dir] = react_native_common_dir_relative
 
+  react_native_worklets_dir_absolute = File.join(__dir__, '..')
+  react_native_worklets_dir_relative = Pathname.new(react_native_worklets_dir_absolute).relative_path_from(pods_root).to_s
+  result[:dynamic_frameworks_worklets_dir] = react_native_worklets_dir_relative
+
   return result
 end
 

package/src/WorkletsError.ts

@@ -1,13 +1,33 @@
+/* eslint-disable reanimated/use-worklets-error */
 'use strict';
 
-import { createCustomError, registerCustomError } from './errors';
-
-export const WorkletsError = createCustomError('Worklets');
-
-// To capture it in a the registering worklet's closure.
-const WorkletsErrorConstructor = WorkletsError;
+function WorkletsErrorConstructor(message?: string): WorkletsError {
+  'worklet';
+  const prefix = '[Worklets]';
+  const errorInstance = new Error(message ? `${prefix} ${message}` : prefix);
+  errorInstance.name = `WorkletsError`;
+  return errorInstance as WorkletsError;
+}
 
+/**
+ * Registers WorkletsError in the global scope. Register only for Worklet
+ * runtimes.
+ */
 export function registerWorkletsError() {
   'worklet';
-  registerCustomError(WorkletsErrorConstructor, 'Worklets');
+  if (globalThis._WORKLET) {
+    globalThis.WorkletsError =
+      WorkletsErrorConstructor as IWorkletsErrorConstructor;
+  }
+}
+
+export const WorkletsError =
+  WorkletsErrorConstructor as IWorkletsErrorConstructor;
+
+export type WorkletsError = Error & { name: 'Worklets' }; // signed type
+
+export interface IWorkletsErrorConstructor extends Error {
+  new (message?: string): WorkletsError;
+  (message?: string): WorkletsError;
+  readonly prototype: WorkletsError;
 }

package/src/WorkletsModule/NativeWorklets.ts

@@ -1,4 +1,5 @@
 /* eslint-disable reanimated/use-reanimated-error */
+/* eslint-disable @typescript-eslint/unbound-method */
 'use strict';
 
 import { WorkletsTurboModule } from '../specs';
@@ -27,7 +28,14 @@ class NativeWorklets {
 See https://docs.swmansion.com/react-native-reanimated/docs/guides/troubleshooting#native-part-of-reanimated-doesnt-seem-to-be-initialized for more details.`
       );
     }
-    this.#workletsModuleProxy = global.__workletsModuleProxy;
+    this.#workletsModuleProxy = {
+      scheduleOnUI: global.__workletsModuleProxy.scheduleOnUI,
+      scheduleOnRuntime: global.__workletsModuleProxy.scheduleOnRuntime,
+      executeOnUIRuntimeSync:
+        global.__workletsModuleProxy.executeOnUIRuntimeSync,
+      createWorkletRuntime: global.__workletsModuleProxy.createWorkletRuntime,
+      makeShareableClone: global.__workletsModuleProxy.makeShareableClone,
+    };
   }
 
   makeShareableClone<TValue>(

package/src/errors.ts

@@ -2,46 +2,6 @@
 
 import type { WorkletStackDetails } from './workletTypes';
 
-export type CustomError<TName extends string> = Error & { name: TName }; // signed type
-
-export interface CustomErrorConstructor<TName extends string> extends Error {
-  new (message?: string): CustomError<TName>;
-  (message?: string): CustomError<TName>;
-  readonly prototype: CustomError<TName>;
-}
-
-export function createCustomError<TName extends string>(
-  name: TName
-): CustomErrorConstructor<TName> {
-  const constructor = function CustomError(message?: string) {
-    'worklet';
-    const prefix = `[${name}]`;
-    // eslint-disable-next-line reanimated/use-worklets-error
-    const errorInstance = new Error(message ? `${prefix} ${message}` : prefix);
-    errorInstance.name = `${name}Error`;
-    return errorInstance;
-  };
-
-  Object.defineProperty(constructor, 'name', { value: `${name}Error` });
-
-  return constructor as CustomErrorConstructor<TName>;
-}
-
-/** Registers custom errors in global scope. Use it only for Worklet runtimes. */
-export function registerCustomError<TName extends string>(
-  constructor: CustomErrorConstructor<TName>,
-  name: TName
-) {
-  'worklet';
-  if (!_WORKLET) {
-    // eslint-disable-next-line reanimated/use-worklets-error
-    throw new Error(
-      '[Worklets] registerCustomError() must be called on a Worklet runtime'
-    );
-  }
-  (global as Record<string, unknown>)[`${name}Error`] = constructor;
-}
-
 const _workletStackDetails = new Map<number, WorkletStackDetails>();
 
 export function registerWorkletStackDetails(

package/src/index.ts

@@ -7,8 +7,6 @@ import { WorkletsModule } from './WorkletsModule';
 // universal source of truth for it.
 initializeUIRuntime(WorkletsModule);
 
-export type { CustomError } from './errors';
-export { createCustomError, registerCustomError } from './errors';
 export type { LoggerConfig } from './logger';
 export {
   logger,

package/src/privateGlobals.d.ts

@@ -1,9 +1,11 @@
+/* eslint-disable reanimated/use-global-this */
 /* eslint-disable no-var */
 'use strict';
 
 // This file works by accident - currently Builder Bob doesn't move `.d.ts` files to output types.
 // If it ever breaks, we should address it so we'd not pollute the user's global namespace.
 import type { callGuardDEV } from './initializers';
+import type { IWorkletsErrorConstructor } from './WorkletsError';
 import type { WorkletsModuleProxy } from './WorkletsModule';
 
 declare global {
@@ -39,4 +41,5 @@ declare global {
     worklet: ShareableRef<() => void>
   ) => void;
   var _microtaskQueueFinalizers: (() => void)[];
+  var WorkletsError: IWorkletsErrorConstructor;
 }

package/src/runtimes.ts

@@ -66,12 +66,12 @@ export function runOnRuntime<Args extends unknown[], ReturnValue>(
   if (__DEV__ && !SHOULD_BE_USE_WEB && !isWorkletFunction(worklet)) {
     throw new WorkletsError(
       'The function passed to `runOnRuntime` is not a worklet.' +
-        (_WORKLET
+        (globalThis._WORKLET
           ? ' Please make sure that `processNestedWorklets` option in Reanimated Babel plugin is enabled.'
           : '')
     );
   }
-  if (_WORKLET) {
+  if (globalThis._WORKLET) {
     return (...args) =>
       global._scheduleOnRuntime(
         workletRuntime,

package/src/threads.ts

@@ -83,7 +83,7 @@ export function runOnUI<Args extends unknown[], ReturnValue>(
   worklet: WorkletFunction<Args, ReturnValue>
 ): (...args: Args) => void {
   'worklet';
-  if (__DEV__ && !SHOULD_BE_USE_WEB && _WORKLET) {
+  if (__DEV__ && !SHOULD_BE_USE_WEB && globalThis._WORKLET) {
     throw new WorkletsError(
       '`runOnUI` cannot be called on the UI runtime. Please call the function synchronously or use `queueMicrotask` or `requestAnimationFrame` instead.'
     );
@@ -200,7 +200,7 @@ export function runOnJS<Args extends unknown[], ReturnValue>(
 ): (...args: Args) => void {
   'worklet';
   type FunDevRemote = Extract<typeof fun, DevRemoteFunction<Args, ReturnValue>>;
-  if (SHOULD_BE_USE_WEB || !_WORKLET) {
+  if (SHOULD_BE_USE_WEB || !globalThis._WORKLET) {
     // if we are already on the JS thread, we just schedule the worklet on the JS queue
     return (...args) =>
       queueMicrotask(

package/android/src/main/cpp/worklets/CMakeLists.txt

@@ -1,85 +0,0 @@
-cmake_minimum_required(VERSION 3.8)
-
-file(GLOB_RECURSE WORKLETS_COMMON_CPP_SOURCES CONFIGURE_DEPENDS
-     "${COMMON_CPP_DIR}/worklets/*.cpp")
-file(GLOB_RECURSE WORKLETS_ANDROID_CPP_SOURCES CONFIGURE_DEPENDS
-     "${ANDROID_CPP_DIR}/worklets/*.cpp")
-
-# Consume shared libraries and headers from prefabs
-find_package(fbjni REQUIRED CONFIG)
-find_package(ReactAndroid REQUIRED CONFIG)
-
-if(${JS_RUNTIME} STREQUAL "hermes")
-  find_package(hermes-engine REQUIRED CONFIG)
-endif()
-
-add_library(worklets SHARED ${WORKLETS_COMMON_CPP_SOURCES}
-                            ${WORKLETS_ANDROID_CPP_SOURCES})
-
-# includes
-target_include_directories(worklets PUBLIC "${COMMON_CPP_DIR}"
-                                           "${ANDROID_CPP_DIR}")
-
-target_include_directories(
-  worklets
-  PRIVATE "${REACT_NATIVE_DIR}/ReactCommon"
-          "${REACT_NATIVE_DIR}/ReactAndroid/src/main/jni/react/turbomodule"
-          "${REACT_NATIVE_DIR}/ReactCommon/react/nativemodule/core/ReactCommon"
-          "${REACT_NATIVE_DIR}/ReactCommon/callinvoker"
-          "${REACT_NATIVE_DIR}/ReactCommon/runtimeexecutor")
-
-if(${IS_NEW_ARCHITECTURE_ENABLED})
-  target_include_directories(
-    worklets
-    PRIVATE
-      "${REACT_NATIVE_DIR}/ReactCommon/yoga"
-      "${REACT_NATIVE_DIR}/ReactCommon/react/renderer/graphics/platform/cxx")
-
-  if(ReactAndroid_VERSION_MINOR LESS 76)
-    target_link_libraries(
-      worklets ReactAndroid::fabricjni ReactAndroid::react_debug
-      ReactAndroid::react_render_core
-      ReactAndroid::react_render_componentregistry ReactAndroid::rrc_view)
-  endif()
-endif()
-
-# build shared lib
-set_target_properties(worklets PROPERTIES LINKER_LANGUAGE CXX)
-
-target_link_libraries(worklets log ReactAndroid::jsi fbjni::fbjni)
-
-if(ReactAndroid_VERSION_MINOR GREATER_EQUAL 76)
-  target_link_libraries(worklets ReactAndroid::reactnative)
-else()
-  target_link_libraries(
-    worklets ReactAndroid::react_nativemodule_core ReactAndroid::folly_runtime
-    ReactAndroid::glog ReactAndroid::reactnativejni)
-endif()
-
-if(${JS_RUNTIME} STREQUAL "hermes")
-  target_link_libraries(worklets hermes-engine::libhermes)
-
-  if(${HERMES_ENABLE_DEBUGGER})
-    if(ReactAndroid_VERSION_MINOR GREATER_EQUAL 76)
-      target_link_libraries(worklets ReactAndroid::hermestooling)
-    else()
-      target_link_libraries(worklets ReactAndroid::hermes_executor)
-    endif()
-  endif()
-elseif(${JS_RUNTIME} STREQUAL "jsc")
-  if(ReactAndroid_VERSION_MINOR GREATER_EQUAL 76)
-    target_link_libraries(worklets ReactAndroid::jsctooling)
-  else()
-    target_link_libraries(worklets ReactAndroid::jscexecutor)
-  endif()
-elseif(${JS_RUNTIME} STREQUAL "v8")
-  # TODO: Refactor this when adding support for newest V8
-  target_include_directories(worklets PRIVATE "${JS_RUNTIME_DIR}/src")
-  file(GLOB V8_SO_DIR "${JS_RUNTIME_DIR}/android/build/intermediates/\
-    library_jni/**/jni/${ANDROID_ABI}")
-  find_library(
-    V8EXECUTOR_LIB v8executor
-    PATHS ${V8_SO_DIR}
-    NO_DEFAULT_PATH NO_CMAKE_FIND_ROOT_PATH)
-  target_link_libraries(worklets ${V8EXECUTOR_LIB})
-endif()