@amazon-devices/react-native-worklets 1.0.0 → 1.0.2

package/bundleMode/index.js

@@ -1,59 +0,0 @@
-const { getDefaultConfig } = require('@react-native/metro-config');
-const path = require('path');
-
-const workletsPackageParentDir = path.resolve(__dirname, '../..');
-
-const defaults = getDefaultConfig(__dirname);
-
-module.exports = {
-  bundleModeMetroConfig: {
-    serializer: {
-      getModulesRunBeforeMainModule(/** @type {string} dirname */ dirname) {
-        return [
-          require.resolve('react-native-worklets/src/workletRuntimeEntry.ts'),
-          require.resolve(
-            'react-native-worklets/lib/module/workletRuntimeEntry.js'
-          ),
-          ...defaults.serializer.getModulesRunBeforeMainModule(dirname),
-        ];
-      },
-      createModuleIdFactory() {
-        let nextId = 0;
-        const idFileMap = new Map();
-        return (/** @type {string} */ moduleName) => {
-          if (idFileMap.has(moduleName)) {
-            return idFileMap.get(moduleName);
-          }
-          if (
-            moduleName.includes('react-native-worklets/__generatedWorklets/')
-          ) {
-            const base = path.basename(moduleName, '.js');
-            const id = Number(base);
-            idFileMap.set(moduleName, id);
-            return id;
-          }
-          idFileMap.set(moduleName, nextId++);
-          return idFileMap.get(moduleName);
-        };
-      },
-    },
-    resolver: {
-      resolveRequest: (
-        /** @type {any} */ context,
-        /** @type {string} */ moduleName,
-        /** @type {any} */ platform
-      ) => {
-        if (
-          moduleName.startsWith('react-native-worklets/__generatedWorklets/')
-        ) {
-          const fullModuleName = path.join(
-            workletsPackageParentDir,
-            moduleName
-          );
-          return { type: 'sourceFile', filePath: fullModuleName };
-        }
-        return context.resolveRequest(context, moduleName, platform);
-      },
-    },
-  },
-};

package/lib/module/PlatformChecker/PlatformChecker.js

@@ -1,8 +0,0 @@
-'use strict';
-
-import { Platform } from 'react-native';
-export const IS_JEST = !!process.env.JEST_WORKER_ID;
-export const IS_WEB = Platform.OS === 'web';
-export const IS_WINDOWS = Platform.OS === 'windows';
-export const SHOULD_BE_USE_WEB = IS_JEST || IS_WEB || IS_WINDOWS;
-//# sourceMappingURL=PlatformChecker.js.map

package/lib/module/PlatformChecker/index.js

@@ -1,18 +0,0 @@
-'use strict';
-
-import { RuntimeKind } from '../runtimeKind';
-import { IS_JEST as RN_IS_JEST, IS_WEB as RN_IS_WEB, IS_WINDOWS as RN_IS_WINDOWS, SHOULD_BE_USE_WEB as RN_SHOULD_BE_USE_WEB } from './PlatformChecker';
-let IS_JEST = false;
-let IS_WEB = false;
-let IS_WINDOWS = false;
-let SHOULD_BE_USE_WEB = false;
-if (globalThis.__RUNTIME_KIND === RuntimeKind.ReactNative) {
-  IS_JEST = RN_IS_JEST;
-  IS_WEB = RN_IS_WEB;
-  IS_WINDOWS = RN_IS_WINDOWS;
-  SHOULD_BE_USE_WEB = RN_SHOULD_BE_USE_WEB;
-}
-export { IS_JEST, /** @knipIgnore */
-IS_WEB, /** @knipIgnore */
-IS_WINDOWS, SHOULD_BE_USE_WEB };
-//# sourceMappingURL=index.js.map

package/lib/module/WorkletsError.js

@@ -1,29 +0,0 @@
-'use strict';
-
-import { RuntimeKind } from './runtimeKind';
-function WorkletsErrorConstructor(message) {
-  'worklet';
-
-  const prefix = '[Worklets]';
-
-  // eslint-disable-next-line reanimated/use-worklets-error
-  const errorInstance = new Error(message ? `${prefix} ${message}` : prefix);
-  errorInstance.name = `WorkletsError`;
-  return errorInstance;
-}
-
-/**
- * Registers WorkletsError in the global scope. Register only for Worklet
- * runtimes.
- */
-export function registerWorkletsError() {
-  'worklet';
-
-  if (globalThis.__RUNTIME_KIND !== RuntimeKind.ReactNative) {
-    globalThis.WorkletsError = WorkletsErrorConstructor;
-  }
-}
-export const WorkletsError = WorkletsErrorConstructor;
-
-// signed type
-//# sourceMappingURL=WorkletsError.js.map

package/lib/module/WorkletsModule/JSWorklets.js

@@ -1,111 +0,0 @@
-'use strict';
-
-import { IS_JEST } from '../PlatformChecker';
-import { mockedRequestAnimationFrame } from '../runLoop/uiRuntime/mockedRequestAnimationFrame';
-import { WorkletsError } from '../WorkletsError';
-export function createJSWorkletsModule() {
-  return new JSWorklets();
-}
-
-// In Node.js environments (like when static rendering with Expo Router)
-// requestAnimationFrame is unavailable, so we use our mock.
-// It also has to be mocked for Jest purposes (see `initializeUIRuntime`).
-const requestAnimationFrameImpl = IS_JEST || !globalThis.requestAnimationFrame ? mockedRequestAnimationFrame : globalThis.requestAnimationFrame;
-class JSWorklets {
-  createSerializable() {
-    throw new WorkletsError('createSerializable should never be called in JSWorklets.');
-  }
-  createSerializableString() {
-    throw new WorkletsError('createSerializableString should never be called in JSWorklets.');
-  }
-  createSerializableNumber() {
-    throw new WorkletsError('createSerializableNumber should never be called in JSWorklets.');
-  }
-  createSerializableBoolean() {
-    throw new WorkletsError('createSerializableBoolean should never be called in JSWorklets.');
-  }
-  createSerializableBigInt() {
-    throw new WorkletsError('createSerializableBigInt should never be called in JSWorklets.');
-  }
-  createSerializableUndefined() {
-    throw new WorkletsError('createSerializableUndefined should never be called in JSWorklets.');
-  }
-  createSerializableNull() {
-    throw new WorkletsError('createSerializableNull should never be called in JSWorklets.');
-  }
-  createSerializableTurboModuleLike() {
-    throw new WorkletsError('createSerializableTurboModuleLike should never be called in JSWorklets.');
-  }
-  createSerializableObject() {
-    throw new WorkletsError('createSerializableObject should never be called in JSWorklets.');
-  }
-  createSerializableMap() {
-    throw new WorkletsError('createSerializableMap should never be called in JSWorklets.');
-  }
-  createSerializableSet() {
-    throw new WorkletsError('createSerializableSet should never be called in JSWorklets.');
-  }
-  createSerializableImport() {
-    throw new WorkletsError('createSerializableImport should never be called in JSWorklets.');
-  }
-  createSerializableHostObject() {
-    throw new WorkletsError('createSerializableHostObject should never be called in JSWorklets.');
-  }
-  createSerializableArray() {
-    throw new WorkletsError('createSerializableArray should never be called in JSWorklets.');
-  }
-  createSerializableInitializer() {
-    throw new WorkletsError('createSerializableInitializer should never be called in JSWorklets.');
-  }
-  createSerializableFunction() {
-    throw new WorkletsError('createSerializableFunction should never be called in JSWorklets.');
-  }
-  createSerializableWorklet() {
-    throw new WorkletsError('createSerializableWorklet should never be called in JSWorklets.');
-  }
-  scheduleOnUI(worklet) {
-    // TODO: `requestAnimationFrame` should be used exclusively in Reanimated
-
-    // @ts-ignore web implementation has still not been updated after the rewrite,
-    // this will be addressed once the web implementation updates are ready
-    requestAnimationFrameImpl(worklet);
-  }
-  executeOnUIRuntimeSync() {
-    throw new WorkletsError('`executeOnUIRuntimeSync` is not available in JSWorklets.');
-  }
-  createWorkletRuntime() {
-    throw new WorkletsError('createWorkletRuntime is not available in JSWorklets.');
-  }
-  scheduleOnRuntime() {
-    throw new WorkletsError('scheduleOnRuntime is not available in JSWorklets.');
-  }
-  createSynchronizable() {
-    throw new WorkletsError('createSynchronizable should never be called in JSWorklets.');
-  }
-  synchronizableGetDirty() {
-    throw new WorkletsError('synchronizableGetDirty should never be called in JSWorklets.');
-  }
-  synchronizableGetBlocking() {
-    throw new WorkletsError('synchronizableGetBlocking should never be called in JSWorklets.');
-  }
-  synchronizableSetBlocking() {
-    throw new WorkletsError('synchronizableSetBlocking should never be called in JSWorklets.');
-  }
-  synchronizableLock() {
-    throw new WorkletsError('synchronizableLock should never be called in JSWorklets.');
-  }
-  synchronizableUnlock() {
-    throw new WorkletsError('synchronizableUnlock should never be called in JSWorklets.');
-  }
-  reportFatalErrorOnJS() {
-    throw new WorkletsError('reportFatalErrorOnJS should never be called in JSWorklets.');
-  }
-  getStaticFeatureFlag() {
-    // mock implementation
-    return false;
-  }
-  setDynamicFeatureFlag() {
-    // noop
-  }
-}
-//# sourceMappingURL=JSWorklets.js.map

package/lib/module/WorkletsModule/NativeWorklets.js

@@ -1,126 +0,0 @@
-'use strict';
-
-import { RuntimeKind } from '../runtimeKind';
-import { WorkletsTurboModule } from '../specs';
-import { checkCppVersion } from '../utils/checkCppVersion';
-import { jsVersion } from '../utils/jsVersion';
-import { WorkletsError } from '../WorkletsError';
-export function createNativeWorkletsModule() {
-  return new NativeWorklets();
-}
-class NativeWorklets {
-  #workletsModuleProxy;
-  #serializableUndefined;
-  #serializableNull;
-  #serializableTrue;
-  #serializableFalse;
-  constructor() {
-    globalThis._WORKLETS_VERSION_JS = jsVersion;
-    if (global.__workletsModuleProxy === undefined && globalThis.__RUNTIME_KIND === RuntimeKind.ReactNative) {
-      WorkletsTurboModule?.installTurboModule();
-    }
-    if (global.__workletsModuleProxy === undefined) {
-      throw new WorkletsError(`Native part of Worklets doesn't seem to be initialized.
-See https://docs.swmansion.com/react-native-worklets/docs/guides/troubleshooting#native-part-of-worklets-doesnt-seem-to-be-initialized for more details.`);
-    }
-    if (__DEV__) {
-      checkCppVersion();
-    }
-    this.#workletsModuleProxy = global.__workletsModuleProxy;
-    this.#serializableNull = this.#workletsModuleProxy.createSerializableNull();
-    this.#serializableUndefined = this.#workletsModuleProxy.createSerializableUndefined();
-    this.#serializableTrue = this.#workletsModuleProxy.createSerializableBoolean(true);
-    this.#serializableFalse = this.#workletsModuleProxy.createSerializableBoolean(false);
-  }
-  createSerializable(value, shouldPersistRemote, nativeStateSource) {
-    return this.#workletsModuleProxy.createSerializable(value, shouldPersistRemote, nativeStateSource);
-  }
-  createSerializableImport(from, to) {
-    return this.#workletsModuleProxy.createSerializableImport(from, to);
-  }
-  createSerializableString(str) {
-    return this.#workletsModuleProxy.createSerializableString(str);
-  }
-  createSerializableNumber(num) {
-    return this.#workletsModuleProxy.createSerializableNumber(num);
-  }
-  createSerializableBoolean(bool) {
-    return bool ? this.#serializableTrue : this.#serializableFalse;
-  }
-  createSerializableBigInt(bigInt) {
-    return this.#workletsModuleProxy.createSerializableBigInt(bigInt);
-  }
-  createSerializableUndefined() {
-    return this.#serializableUndefined;
-  }
-  createSerializableNull() {
-    return this.#serializableNull;
-  }
-  createSerializableTurboModuleLike(props, proto) {
-    return this.#workletsModuleProxy.createSerializableTurboModuleLike(props, proto);
-  }
-  createSerializableObject(obj, shouldRetainRemote, nativeStateSource) {
-    return this.#workletsModuleProxy.createSerializableObject(obj, shouldRetainRemote, nativeStateSource);
-  }
-  createSerializableHostObject(obj) {
-    return this.#workletsModuleProxy.createSerializableHostObject(obj);
-  }
-  createSerializableArray(array, shouldRetainRemote) {
-    return this.#workletsModuleProxy.createSerializableArray(array, shouldRetainRemote);
-  }
-  createSerializableMap(keys, values) {
-    return this.#workletsModuleProxy.createSerializableMap(keys, values);
-  }
-  createSerializableSet(values) {
-    return this.#workletsModuleProxy.createSerializableSet(values);
-  }
-  createSerializableInitializer(obj) {
-    return this.#workletsModuleProxy.createSerializableInitializer(obj);
-  }
-  createSerializableFunction(func) {
-    return this.#workletsModuleProxy.createSerializableFunction(func);
-  }
-  createSerializableWorklet(worklet, shouldPersistRemote) {
-    return this.#workletsModuleProxy.createSerializableWorklet(worklet, shouldPersistRemote);
-  }
-  scheduleOnUI(serializable) {
-    return this.#workletsModuleProxy.scheduleOnUI(serializable);
-  }
-  executeOnUIRuntimeSync(serializable) {
-    return this.#workletsModuleProxy.executeOnUIRuntimeSync(serializable);
-  }
-  createWorkletRuntime(name, initializer, useDefaultQueue, customQueue, enableEventLoop) {
-    return this.#workletsModuleProxy.createWorkletRuntime(name, initializer, useDefaultQueue, customQueue, enableEventLoop);
-  }
-  scheduleOnRuntime(workletRuntime, serializableWorklet) {
-    return this.#workletsModuleProxy.scheduleOnRuntime(workletRuntime, serializableWorklet);
-  }
-  createSynchronizable(value) {
-    return this.#workletsModuleProxy.createSynchronizable(value);
-  }
-  synchronizableGetDirty(synchronizableRef) {
-    return this.#workletsModuleProxy.synchronizableGetDirty(synchronizableRef);
-  }
-  synchronizableGetBlocking(synchronizableRef) {
-    return this.#workletsModuleProxy.synchronizableGetBlocking(synchronizableRef);
-  }
-  synchronizableSetBlocking(synchronizableRef, value) {
-    return this.#workletsModuleProxy.synchronizableSetBlocking(synchronizableRef, value);
-  }
-  synchronizableLock(synchronizableRef) {
-    return this.#workletsModuleProxy.synchronizableLock(synchronizableRef);
-  }
-  synchronizableUnlock(synchronizableRef) {
-    return this.#workletsModuleProxy.synchronizableUnlock(synchronizableRef);
-  }
-  reportFatalErrorOnJS(message, stack, name, jsEngine) {
-    return this.#workletsModuleProxy.reportFatalErrorOnJS(message, stack, name, jsEngine);
-  }
-  getStaticFeatureFlag(name) {
-    return this.#workletsModuleProxy.getStaticFeatureFlag(name);
-  }
-  setDynamicFeatureFlag(name, value) {
-    this.#workletsModuleProxy.setDynamicFeatureFlag(name, value);
-  }
-}
-//# sourceMappingURL=NativeWorklets.js.map

package/lib/module/WorkletsModule/index.js

@@ -1,4 +0,0 @@
-'use strict';
-
-export { WorkletsModule } from './workletsModuleInstance';
-//# sourceMappingURL=index.js.map

package/lib/module/WorkletsModule/workletsModuleInstance.js

@@ -1,7 +0,0 @@
-'use strict';
-
-import { SHOULD_BE_USE_WEB } from '../PlatformChecker';
-import { createJSWorkletsModule } from './JSWorklets';
-import { createNativeWorkletsModule } from './NativeWorklets';
-export const WorkletsModule = SHOULD_BE_USE_WEB ? createJSWorkletsModule() : createNativeWorkletsModule();
-//# sourceMappingURL=workletsModuleInstance.js.map

package/lib/module/WorkletsModule/workletsModuleInstance.web.js

@@ -1,5 +0,0 @@
-'use strict';
-
-import { createJSWorkletsModule } from './JSWorklets';
-export const WorkletsModule = createJSWorkletsModule();
-//# sourceMappingURL=workletsModuleInstance.web.js.map

package/lib/module/WorkletsModule/workletsModuleProxy.js

@@ -1,4 +0,0 @@
-'use strict';
-
-export {};
-//# sourceMappingURL=workletsModuleProxy.js.map

package/lib/module/bundleUnpacker.js

@@ -1,47 +0,0 @@
-'use strict';
-
-import { logger } from './logger';
-import { WorkletsError } from './WorkletsError';
-const handleCache = new WeakMap();
-export function bundleValueUnpacker(objectToUnpack, category, remoteFunctionName) {
-  const workletHash = objectToUnpack.__workletHash;
-  if (workletHash !== undefined) {
-    return getWorklet(workletHash, objectToUnpack.__closure);
-  } else if (objectToUnpack.__init !== undefined) {
-    let value = handleCache.get(objectToUnpack);
-    if (value === undefined) {
-      value = objectToUnpack.__init();
-      handleCache.set(objectToUnpack, value);
-    }
-    return value;
-  } else if (category === 'RemoteFunction') {
-    const remoteFunctionHolder = () => {
-      const label = remoteFunctionName ? `function \`${remoteFunctionName}\`` : 'anonymous function';
-      throw new WorkletsError(`Tried to synchronously call a non-worklet ${label} on the UI thread.
-See https://docs.swmansion.com/react-native-reanimated/docs/guides/troubleshooting#tried-to-synchronously-call-a-non-worklet-function-on-the-ui-thread for more details.`);
-    };
-    remoteFunctionHolder.__remoteFunction = objectToUnpack;
-    return remoteFunctionHolder;
-  } else {
-    throw new WorkletsError(`Data type in category "${category}" not recognized by value unpacker: "${globalThis._toString(objectToUnpack)}".`);
-  }
-}
-function getWorklet(workletHash, closureVariables) {
-  let worklet;
-  if (__DEV__) {
-    try {
-      worklet = getWorkletFromMetroRequire(workletHash, closureVariables);
-    } catch (_e) {
-      logger.error('Unable to resolve worklet with hash ' + workletHash + '. Try reloading the app.');
-    }
-  } else {
-    worklet = getWorkletFromMetroRequire(workletHash, closureVariables);
-  }
-  return worklet;
-}
-const metroRequire = globalThis.__r;
-function getWorkletFromMetroRequire(workletHash, closureVariables) {
-  const factory = metroRequire(workletHash).default;
-  return factory(closureVariables);
-}
-//# sourceMappingURL=bundleUnpacker.js.map

package/lib/module/callGuard.js

@@ -1,30 +0,0 @@
-'use strict';
-
-/** Used only with debug builds. */
-export function callGuardDEV(fn, ...args) {
-  'worklet';
-
-  try {
-    return fn(...args);
-  } catch (error) {
-    if (globalThis.__workletsModuleProxy) {
-      const {
-        message,
-        stack,
-        name,
-        jsEngine
-      } = error;
-      globalThis.__workletsModuleProxy.reportFatalErrorOnJS(message, stack ?? '', name ?? 'WorkletsError', jsEngine ?? 'Worklets');
-    } else {
-      throw error;
-    }
-  }
-}
-export function setupCallGuard() {
-  'worklet';
-
-  if (!globalThis.__callGuardDEV) {
-    globalThis.__callGuardDEV = callGuardDEV;
-  }
-}
-//# sourceMappingURL=callGuard.js.map

package/lib/module/deprecated.js

@@ -1,20 +0,0 @@
-'use strict';
-
-import { createSerializable, isSerializableRef, makeShareable, makeShareableCloneOnUIRecursive } from './serializable';
-import { serializableMappingCache } from './serializableMappingCache';
-
-/** @deprecated Use {@link SerializableRef} instead. */
-
-export { makeShareable, makeShareableCloneOnUIRecursive };
-
-/** @deprecated It will be removed in the next major version. */
-
-/** @deprecated Use {@link createSerializable} instead. */
-export const makeShareableCloneRecursive = createSerializable;
-
-/** @deprecated Use {@link isSerializableRef} instead. */
-export const isShareableRef = isSerializableRef;
-
-/** @deprecated Use {@link serializableMappingCache} instead. */
-export const shareableMappingCache = serializableMappingCache;
-//# sourceMappingURL=deprecated.js.map

package/lib/module/errors.js

@@ -1,69 +0,0 @@
-'use strict';
-
-import { WorkletsError } from './WorkletsError';
-const _workletStackDetails = new Map();
-export function registerWorkletStackDetails(hash, stackDetails) {
-  _workletStackDetails.set(hash, stackDetails);
-}
-function getBundleOffset(error) {
-  const frame = error.stack?.split('\n')?.[0];
-  if (frame) {
-    const parsedFrame = /@([^@]+):(\d+):(\d+)/.exec(frame);
-    if (parsedFrame) {
-      const [, file, line, col] = parsedFrame;
-      return [file, Number(line), Number(col)];
-    }
-  }
-  return ['unknown', 0, 0];
-}
-function processStack(stack) {
-  if (stack === '' || stack === undefined) {
-    return undefined;
-  }
-  const workletStackEntries = stack.match(/worklet_(\d+):(\d+):(\d+)/g);
-  let result = stack;
-  workletStackEntries?.forEach(match => {
-    const [, hash, origLine, origCol] = match.split(/:|_/).map(Number);
-    const errorDetails = _workletStackDetails.get(hash);
-    if (!errorDetails) {
-      return;
-    }
-    const [error, lineOffset, colOffset] = errorDetails;
-    const [bundleFile, bundleLine, bundleCol] = getBundleOffset(error);
-    const line = origLine + bundleLine + lineOffset;
-    const col = origCol + bundleCol + colOffset;
-    result = result.replace(match, `${bundleFile}:${line}:${col}`);
-  });
-  return result;
-}
-/**
- * Remote error is an error coming from a Worklet Runtime that we bubble up to
- * the RN Runtime.
- */
-export function reportFatalRemoteError({
-  message,
-  stack,
-  name,
-  jsEngine
-}, force) {
-  const error = new WorkletsError();
-  error.message = message;
-  error.stack = processStack(stack);
-  error.name = name;
-  error.jsEngine = jsEngine;
-  if (force) {
-    throw error;
-  } else {
-    // @ts-expect-error React Native's `ErrorUtils` are hidden from the global scope.
-    globalThis.ErrorUtils.reportFatalError(error);
-  }
-}
-
-/**
- * Registers `reportFatalRemoteError` function in global scope to allow to
- * invoke it from C++.
- */
-export function registerReportFatalRemoteError() {
-  globalThis.__reportFatalRemoteError = reportFatalRemoteError;
-}
-//# sourceMappingURL=errors.js.map

package/lib/module/featureFlags/index.js

@@ -1,48 +0,0 @@
-'use strict';
-
-import { logger } from '../logger';
-import { WorkletsModule } from '../WorkletsModule';
-export const DynamicFlags = {
-  EXAMPLE_DYNAMIC_FLAG: true,
-  init() {
-    Object.keys(DynamicFlags).forEach(key => {
-      if (key !== 'init' && key !== 'setFlag') {
-        WorkletsModule.setDynamicFeatureFlag(key, DynamicFlags[key]);
-      }
-    });
-  },
-  setFlag(name, value) {
-    if (name in DynamicFlags) {
-      DynamicFlags[name] = value;
-      WorkletsModule.setDynamicFeatureFlag(name, value);
-    } else {
-      logger.warn(`The feature flag: '${name}' no longer exists, you can safely remove invocation of \`setDynamicFeatureFlag('${name}')\` from your code.`);
-    }
-  }
-};
-DynamicFlags.init();
-// Public API function to update a feature flag
-export function setDynamicFeatureFlag(name, value) {
-  DynamicFlags.setFlag(name, value);
-}
-
-/**
- * This constant is needed for typechecking and preserving static typechecks in
- * generated .d.ts files. Without it, the static flags resolve to an object
- * without specific keys.
- */
-// eslint-disable-next-line @typescript-eslint/no-unused-vars
-const DefaultStaticFeatureFlags = {
-  RUNTIME_TEST_FLAG: false,
-  IOS_DYNAMIC_FRAMERATE_ENABLED: false
-};
-const staticFeatureFlags = {};
-export function getStaticFeatureFlag(name) {
-  if (name in staticFeatureFlags) {
-    return staticFeatureFlags[name];
-  }
-  const featureFlagValue = WorkletsModule.getStaticFeatureFlag(name);
-  staticFeatureFlags[name] = featureFlagValue;
-  return featureFlagValue;
-}
-//# sourceMappingURL=index.js.map