react-native-worklets 0.8.0-rc.0 → 0.8.0

package/lib/typescript/memory/shareable.d.ts

@@ -1,9 +1,23 @@
 import type { UIRuntimeId } from '../runtimes';
-import type { SerializableRef, Shareable, ShareableConfig } from './types';
+import type { Shareable, ShareableConfig } from './types';
+/**
+ * Creates a new {@link Shareable} holding the provided initial value. You must
+ * explicitly declare which Worklet Runtime will host the Shareable by passing
+ * its `runtimeId`.
+ *
+ * Currently only hosting a Shareable on the UI Runtime is supported.
+ *
+ * @param hostRuntimeId - The `runtimeId` of the Worklet Runtime that will host
+ *   the Shareable. Use {@link UIRuntimeId}.
+ * @param initial - The initial value of the Shareable.
+ * @param config - Optional advanced configuration.
+ * @returns The created {@link Shareable}.
+ * @see {@link https://docs.swmansion.com/react-native-worklets/docs/memory/createShareable | createShareable docs}
+ */
 export declare function createShareable<TValue = unknown, THostDecorated = unknown, TGuestDecorated = unknown>(hostRuntimeId: typeof UIRuntimeId, initial: TValue, config?: ShareableConfig<TValue, THostDecorated, TGuestDecorated>): Shareable<TValue, THostDecorated, TGuestDecorated>;
 /**
  * @deprecated Only UI host runtime is supported now. Use {@link UIRuntimeId} as
  *   the `hostRuntimeId` argument.
  */
-export declare function createShareable<TValue = unknown, THostDecorated = unknown, TGuestDecorated = unknown>(hostRuntimeId: number, initial: SerializableRef<TValue>, config?: ShareableConfig<TValue, THostDecorated, TGuestDecorated>): Shareable<TValue, THostDecorated, TGuestDecorated>;
+export declare function createShareable<TValue = unknown, THostDecorated = unknown, TGuestDecorated = unknown>(hostRuntimeId: number, initial: TValue, config?: ShareableConfig<TValue, THostDecorated, TGuestDecorated>): Shareable<TValue, THostDecorated, TGuestDecorated>;
 //# sourceMappingURL=shareable.d.ts.map

package/lib/typescript/memory/shareable.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"shareable.d.ts","sourceRoot":"","sources":["../../../src/memory/shareable.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC/C,OAAO,KAAK,EAAE,eAAe,EAAE,SAAS,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAE3E,wBAAgB,eAAe,CAC7B,MAAM,GAAG,OAAO,EAChB,cAAc,GAAG,OAAO,EACxB,eAAe,GAAG,OAAO,EAEzB,aAAa,EAAE,OAAO,WAAW,EACjC,OAAO,EAAE,MAAM,EACf,MAAM,CAAC,EAAE,eAAe,CAAC,MAAM,EAAE,cAAc,EAAE,eAAe,CAAC,GAChE,SAAS,CAAC,MAAM,EAAE,cAAc,EAAE,eAAe,CAAC,CAAC;AAEtD;;;GAGG;AACH,wBAAgB,eAAe,CAC7B,MAAM,GAAG,OAAO,EAChB,cAAc,GAAG,OAAO,EACxB,eAAe,GAAG,OAAO,EAEzB,aAAa,EAAE,MAAM,EACrB,OAAO,EAAE,eAAe,CAAC,MAAM,CAAC,EAChC,MAAM,CAAC,EAAE,eAAe,CAAC,MAAM,EAAE,cAAc,EAAE,eAAe,CAAC,GAChE,SAAS,CAAC,MAAM,EAAE,cAAc,EAAE,eAAe,CAAC,CAAC"}
+{"version":3,"file":"shareable.d.ts","sourceRoot":"","sources":["../../../src/memory/shareable.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC/C,OAAO,KAAK,EAAE,SAAS,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAE1D;;;;;;;;;;;;;GAaG;AACH,wBAAgB,eAAe,CAC7B,MAAM,GAAG,OAAO,EAChB,cAAc,GAAG,OAAO,EACxB,eAAe,GAAG,OAAO,EAEzB,aAAa,EAAE,OAAO,WAAW,EACjC,OAAO,EAAE,MAAM,EACf,MAAM,CAAC,EAAE,eAAe,CAAC,MAAM,EAAE,cAAc,EAAE,eAAe,CAAC,GAChE,SAAS,CAAC,MAAM,EAAE,cAAc,EAAE,eAAe,CAAC,CAAC;AAEtD;;;GAGG;AACH,wBAAgB,eAAe,CAC7B,MAAM,GAAG,OAAO,EAChB,cAAc,GAAG,OAAO,EACxB,eAAe,GAAG,OAAO,EAEzB,aAAa,EAAE,MAAM,EACrB,OAAO,EAAE,MAAM,EACf,MAAM,CAAC,EAAE,eAAe,CAAC,MAAM,EAAE,cAAc,EAAE,eAAe,CAAC,GAChE,SAAS,CAAC,MAAM,EAAE,cAAc,EAAE,eAAe,CAAC,CAAC"}

package/lib/typescript/memory/shareable.native.d.ts

@@ -1,9 +1,23 @@
 import { UIRuntimeId } from '../runtimes';
-import type { SerializableRef, Shareable, ShareableConfig } from './types';
+import type { Shareable, ShareableConfig } from './types';
+/**
+ * Creates a new {@link Shareable} holding the provided initial value. You must
+ * explicitly declare which Worklet Runtime will host the Shareable by passing
+ * its `runtimeId`.
+ *
+ * Currently only hosting a Shareable on the UI Runtime is supported.
+ *
+ * @param hostRuntimeId - The `runtimeId` of the Worklet Runtime that will host
+ *   the Shareable. Use {@link UIRuntimeId}.
+ * @param initial - The initial value of the Shareable.
+ * @param config - Optional advanced configuration.
+ * @returns The created {@link Shareable}.
+ * @see {@link https://docs.swmansion.com/react-native-worklets/docs/memory/createShareable | createShareable docs}
+ */
 export declare function createShareable<TValue = unknown, THostDecorated = unknown, TGuestDecorated = unknown>(hostRuntimeId: typeof UIRuntimeId, initial: TValue, config?: ShareableConfig<TValue, THostDecorated, TGuestDecorated>): Shareable<TValue, THostDecorated, TGuestDecorated>;
 /**
  * @deprecated Only UI host runtime is supported now. Use {@link UIRuntimeId} as
  *   the `hostRuntimeId` argument.
  */
-export declare function createShareable<TValue = unknown, THostDecorated = unknown, TGuestDecorated = unknown>(hostRuntimeId: number, initial: SerializableRef<TValue>, config?: ShareableConfig<TValue, THostDecorated, TGuestDecorated>): Shareable<TValue, THostDecorated, TGuestDecorated>;
+export declare function createShareable<TValue = unknown, THostDecorated = unknown, TGuestDecorated = unknown>(hostRuntimeId: number, initial: TValue, config?: ShareableConfig<TValue, THostDecorated, TGuestDecorated>): Shareable<TValue, THostDecorated, TGuestDecorated>;
 //# sourceMappingURL=shareable.native.d.ts.map

package/lib/typescript/memory/shareable.native.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"shareable.native.d.ts","sourceRoot":"","sources":["../../../src/memory/shareable.native.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAI1C,OAAO,KAAK,EAAE,eAAe,EAAE,SAAS,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAE3E,wBAAgB,eAAe,CAC7B,MAAM,GAAG,OAAO,EAChB,cAAc,GAAG,OAAO,EACxB,eAAe,GAAG,OAAO,EAEzB,aAAa,EAAE,OAAO,WAAW,EACjC,OAAO,EAAE,MAAM,EACf,MAAM,CAAC,EAAE,eAAe,CAAC,MAAM,EAAE,cAAc,EAAE,eAAe,CAAC,GAChE,SAAS,CAAC,MAAM,EAAE,cAAc,EAAE,eAAe,CAAC,CAAC;AAEtD;;;GAGG;AACH,wBAAgB,eAAe,CAC7B,MAAM,GAAG,OAAO,EAChB,cAAc,GAAG,OAAO,EACxB,eAAe,GAAG,OAAO,EAEzB,aAAa,EAAE,MAAM,EACrB,OAAO,EAAE,eAAe,CAAC,MAAM,CAAC,EAChC,MAAM,CAAC,EAAE,eAAe,CAAC,MAAM,EAAE,cAAc,EAAE,eAAe,CAAC,GAChE,SAAS,CAAC,MAAM,EAAE,cAAc,EAAE,eAAe,CAAC,CAAC"}
+{"version":3,"file":"shareable.native.d.ts","sourceRoot":"","sources":["../../../src/memory/shareable.native.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAI1C,OAAO,KAAK,EAAE,SAAS,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAE1D;;;;;;;;;;;;;GAaG;AACH,wBAAgB,eAAe,CAC7B,MAAM,GAAG,OAAO,EAChB,cAAc,GAAG,OAAO,EACxB,eAAe,GAAG,OAAO,EAEzB,aAAa,EAAE,OAAO,WAAW,EACjC,OAAO,EAAE,MAAM,EACf,MAAM,CAAC,EAAE,eAAe,CAAC,MAAM,EAAE,cAAc,EAAE,eAAe,CAAC,GAChE,SAAS,CAAC,MAAM,EAAE,cAAc,EAAE,eAAe,CAAC,CAAC;AAEtD;;;GAGG;AACH,wBAAgB,eAAe,CAC7B,MAAM,GAAG,OAAO,EAChB,cAAc,GAAG,OAAO,EACxB,eAAe,GAAG,OAAO,EAEzB,aAAa,EAAE,MAAM,EACrB,OAAO,EAAE,MAAM,EACf,MAAM,CAAC,EAAE,eAAe,CAAC,MAAM,EAAE,cAAc,EAAE,eAAe,CAAC,GAChE,SAAS,CAAC,MAAM,EAAE,cAAc,EAAE,eAAe,CAAC,CAAC"}

package/lib/typescript/memory/types.d.ts

@@ -67,6 +67,11 @@ export type ShareableHostMeta = {
     isHost: true;
     __shareableRef: true;
 };
+/**
+ * A worklet that takes the created {@link ShareableHost} and decorates it with
+ * additional properties or methods. It must return the same reference it
+ * received.
+ */
 export type ShareableHostDecorator<TValue = unknown, TDecorated = unknown> = (shareable: ShareableHost<TValue> & TDecorated) => ShareableHost<TValue> & TDecorated;
 export type ShareableGuestMeta = {
     isHost: false;
@@ -78,13 +83,50 @@ export type ShareableGuestProps<TValue = unknown> = {
     setAsync(value: TValue | ((prev: TValue) => TValue)): void;
     setSync(value: TValue | ((prev: TValue) => TValue)): void;
 };
+/**
+ * A worklet that decorates each {@link ShareableGuest} created for the Shareable
+ * with additional properties or methods. It must return the same reference it
+ * received.
+ */
 export type ShareableGuestDecorator<TValue = unknown, TDecorated = unknown> = (shareable: ShareableGuest<TValue> & TDecorated) => ShareableGuest<TValue> & TDecorated;
+/**
+ * The host-side representation of a {@link Shareable}, living on the
+ * {@link https://docs.swmansion.com/react-native-worklets/docs/fundamentals/runtimeKinds#worklet-runtime | Worklet Runtime}
+ * that hosts the Shareable.
+ */
 export type ShareableHost<TValue = unknown, THostDecorated = unknown> = ShareableHostMeta & ShareableHostProps<TValue> & (THostDecorated extends object ? THostDecorated : object);
+/**
+ * A guest-side representation of a {@link Shareable}, used on any runtime other
+ * than the host runtime.
+ */
 export type ShareableGuest<TValue = unknown, TGuestDecorated = unknown> = ShareableGuestMeta & ShareableGuestProps<TValue> & (TGuestDecorated extends object ? TGuestDecorated : object);
+/**
+ * A type of shared memory tied to a given runtime, called the Host Runtime.
+ * Depending on the context it's either a {@link ShareableHost} (on the hosting
+ * Worklet Runtime) or a {@link ShareableGuest} (on every other runtime).
+ *
+ * @see {@link https://docs.swmansion.com/react-native-worklets/docs/memory/shareable | Shareable docs}
+ */
 export type Shareable<TValue = unknown, THostDecorated = unknown, TGuestDecorated = unknown> = (ShareableHost<TValue, THostDecorated> & Partial<ShareableGuestProps<TValue> & (TGuestDecorated extends object ? Partial<TGuestDecorated> : object)>) | (ShareableGuest<TValue, TGuestDecorated> & Partial<ShareableHostProps<TValue> & (THostDecorated extends object ? Partial<THostDecorated> : object)>);
+/** Optional advanced configuration for a {@link Shareable}. */
 export type ShareableConfig<TValue, THostDecorated, TGuestDecorated> = {
+    /**
+     * A worklet that decorates the {@link ShareableHost} with additional
+     * properties or methods.
+     */
     hostDecorator?: ShareableHostDecorator<TValue, THostDecorated>;
+    /**
+     * A worklet that decorates each {@link ShareableGuest} with additional
+     * properties or methods.
+     */
     guestDecorator?: ShareableGuestDecorator<TValue, TGuestDecorated>;
+    /**
+     * When `true`, the {@link ShareableHost} is created synchronously during the
+     * call to `createShareable` instead of lazily on first access. Use this when
+     * the host initialization triggers side effects that must happen eagerly.
+     *
+     * @defaultValue `false`
+     */
     initSynchronously?: boolean;
 };
 //# sourceMappingURL=types.d.ts.map

package/lib/typescript/memory/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/memory/types.ts"],"names":[],"mappings":"AAEA;;;;;;;;GAQG;AACH,MAAM,MAAM,eAAe,CAAC,MAAM,GAAG,OAAO,IAAI;IAC9C,iBAAiB,EAAE,IAAI,CAAC;IACxB,8BAA8B,EAAE,MAAM,CAAC;CACxC,CAAC;AAIF,MAAM,MAAM,mBAAmB,CAAC,MAAM,IACpC,MAAM,SAAS,eAAe,CAAC,MAAM,UAAU,CAAC,GAC5C,eAAe,CAAC,UAAU,CAAC,GAC3B,eAAe,CAAC,MAAM,CAAC,CAAC;AAE9B,MAAM,MAAM,iBAAiB,CAAC,MAAM,GAAG,OAAO,IAAI;IAChD,mBAAmB,EAAE,IAAI,CAAC;IAC1B,gCAAgC,EAAE,MAAM,CAAC;CAC1C,CAAC;AAEF,MAAM,MAAM,cAAc,CAAC,MAAM,GAAG,OAAO,IAAI,eAAe,CAAC,MAAM,CAAC,GACpE,iBAAiB,CAAC,MAAM,CAAC,GAAG;IAC1B,mBAAmB,EAAE,IAAI,CAAC;IAC1B,QAAQ,IAAI,MAAM,CAAC;IACnB,WAAW,IAAI,MAAM,CAAC;IACtB,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,CAAC,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,CAAC,GAAG,IAAI,CAAC;IAC9D,IAAI,IAAI,IAAI,CAAC;IACb,MAAM,IAAI,IAAI,CAAC;CAChB,CAAC;AAEJ;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,CAAC,MAAM,SAAS,MAAM,EAAE,OAAO,GAAG,OAAO,IAAI;IACvE;;;;;OAKG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;;OAGG;IACH,SAAS,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,KAAK,IAAI,MAAM,CAAC;IAC9C;;;;;OAKG;IACH,IAAI,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,OAAO,CAAC;IACjC;;;OAGG;IACH,MAAM,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,MAAM,CAAC;CACpC,CAAC;AAEF,MAAM,MAAM,iBAAiB,CAAC,MAAM,SAAS,MAAM,EAAE,OAAO,GAAG,OAAO,IAAI,IAAI,CAC5E,gBAAgB,CAAC,MAAM,EAAE,OAAO,CAAC,EACjC,MAAM,CACP,GAAG;IACF,sCAAsC;IACtC,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,2BAA2B,GAAG,iBAAiB,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,CAAC;AAE/E,MAAM,MAAM,kBAAkB,CAAC,MAAM,GAAG,OAAO,IAAI;IACjD,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAC9B,MAAM,EAAE,IAAI,CAAC;IACb,cAAc,EAAE,IAAI,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,sBAAsB,CAAC,MAAM,GAAG,OAAO,EAAE,UAAU,GAAG,OAAO,IAAI,CAC3E,SAAS,EAAE,aAAa,CAAC,MAAM,CAAC,GAAG,UAAU,KAC1C,aAAa,CAAC,MAAM,CAAC,GAAG,UAAU,CAAC;AAExC,MAAM,MAAM,kBAAkB,GAAG;IAC/B,MAAM,EAAE,KAAK,CAAC;IACd,cAAc,EAAE,IAAI,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,mBAAmB,CAAC,MAAM,GAAG,OAAO,IAAI;IAClD,QAAQ,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;IAC5B,OAAO,IAAI,MAAM,CAAC;IAClB,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,CAAC,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,CAAC,GAAG,IAAI,CAAC;IAC3D,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,CAAC,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,CAAC,GAAG,IAAI,CAAC;CAC3D,CAAC;AAEF,MAAM,MAAM,uBAAuB,CAAC,MAAM,GAAG,OAAO,EAAE,UAAU,GAAG,OAAO,IAAI,CAC5E,SAAS,EAAE,cAAc,CAAC,MAAM,CAAC,GAAG,UAAU,KAC3C,cAAc,CAAC,MAAM,CAAC,GAAG,UAAU,CAAC;AAEzC,MAAM,MAAM,aAAa,CACvB,MAAM,GAAG,OAAO,EAChB,cAAc,GAAG,OAAO,IACtB,iBAAiB,GACnB,kBAAkB,CAAC,MAAM,CAAC,GAC1B,CAAC,cAAc,SAAS,MAAM,GAAG,cAAc,GAAG,MAAM,CAAC,CAAC;AAE5D,MAAM,MAAM,cAAc,CACxB,MAAM,GAAG,OAAO,EAChB,eAAe,GAAG,OAAO,IACvB,kBAAkB,GACpB,mBAAmB,CAAC,MAAM,CAAC,GAC3B,CAAC,eAAe,SAAS,MAAM,GAAG,eAAe,GAAG,MAAM,CAAC,CAAC;AAE9D,MAAM,MAAM,SAAS,CACnB,MAAM,GAAG,OAAO,EAChB,cAAc,GAAG,OAAO,EACxB,eAAe,GAAG,OAAO,IAEvB,CAAC,aAAa,CAAC,MAAM,EAAE,cAAc,CAAC,GACpC,OAAO,CACL,mBAAmB,CAAC,MAAM,CAAC,GACzB,CAAC,eAAe,SAAS,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC,GAAG,MAAM,CAAC,CACvE,CAAC,GACJ,CAAC,cAAc,CAAC,MAAM,EAAE,eAAe,CAAC,GACtC,OAAO,CACL,kBAAkB,CAAC,MAAM,CAAC,GACxB,CAAC,cAAc,SAAS,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC,GAAG,MAAM,CAAC,CACrE,CAAC,CAAC;AAET,MAAM,MAAM,eAAe,CAAC,MAAM,EAAE,cAAc,EAAE,eAAe,IAAI;IACrE,aAAa,CAAC,EAAE,sBAAsB,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;IAC/D,cAAc,CAAC,EAAE,uBAAuB,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;IAClE,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B,CAAC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/memory/types.ts"],"names":[],"mappings":"AAEA;;;;;;;;GAQG;AACH,MAAM,MAAM,eAAe,CAAC,MAAM,GAAG,OAAO,IAAI;IAC9C,iBAAiB,EAAE,IAAI,CAAC;IACxB,8BAA8B,EAAE,MAAM,CAAC;CACxC,CAAC;AAIF,MAAM,MAAM,mBAAmB,CAAC,MAAM,IACpC,MAAM,SAAS,eAAe,CAAC,MAAM,UAAU,CAAC,GAC5C,eAAe,CAAC,UAAU,CAAC,GAC3B,eAAe,CAAC,MAAM,CAAC,CAAC;AAE9B,MAAM,MAAM,iBAAiB,CAAC,MAAM,GAAG,OAAO,IAAI;IAChD,mBAAmB,EAAE,IAAI,CAAC;IAC1B,gCAAgC,EAAE,MAAM,CAAC;CAC1C,CAAC;AAEF,MAAM,MAAM,cAAc,CAAC,MAAM,GAAG,OAAO,IAAI,eAAe,CAAC,MAAM,CAAC,GACpE,iBAAiB,CAAC,MAAM,CAAC,GAAG;IAC1B,mBAAmB,EAAE,IAAI,CAAC;IAC1B,QAAQ,IAAI,MAAM,CAAC;IACnB,WAAW,IAAI,MAAM,CAAC;IACtB,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,CAAC,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,CAAC,GAAG,IAAI,CAAC;IAC9D,IAAI,IAAI,IAAI,CAAC;IACb,MAAM,IAAI,IAAI,CAAC;CAChB,CAAC;AAEJ;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,CAAC,MAAM,SAAS,MAAM,EAAE,OAAO,GAAG,OAAO,IAAI;IACvE;;;;;OAKG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;;OAGG;IACH,SAAS,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,KAAK,IAAI,MAAM,CAAC;IAC9C;;;;;OAKG;IACH,IAAI,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,OAAO,CAAC;IACjC;;;OAGG;IACH,MAAM,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,MAAM,CAAC;CACpC,CAAC;AAEF,MAAM,MAAM,iBAAiB,CAAC,MAAM,SAAS,MAAM,EAAE,OAAO,GAAG,OAAO,IAAI,IAAI,CAC5E,gBAAgB,CAAC,MAAM,EAAE,OAAO,CAAC,EACjC,MAAM,CACP,GAAG;IACF,sCAAsC;IACtC,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,2BAA2B,GAAG,iBAAiB,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,CAAC;AAE/E,MAAM,MAAM,kBAAkB,CAAC,MAAM,GAAG,OAAO,IAAI;IACjD,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAC9B,MAAM,EAAE,IAAI,CAAC;IACb,cAAc,EAAE,IAAI,CAAC;CACtB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,sBAAsB,CAAC,MAAM,GAAG,OAAO,EAAE,UAAU,GAAG,OAAO,IAAI,CAC3E,SAAS,EAAE,aAAa,CAAC,MAAM,CAAC,GAAG,UAAU,KAC1C,aAAa,CAAC,MAAM,CAAC,GAAG,UAAU,CAAC;AAExC,MAAM,MAAM,kBAAkB,GAAG;IAC/B,MAAM,EAAE,KAAK,CAAC;IACd,cAAc,EAAE,IAAI,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,mBAAmB,CAAC,MAAM,GAAG,OAAO,IAAI;IAClD,QAAQ,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;IAC5B,OAAO,IAAI,MAAM,CAAC;IAClB,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,CAAC,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,CAAC,GAAG,IAAI,CAAC;IAC3D,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,CAAC,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,CAAC,GAAG,IAAI,CAAC;CAC3D,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,uBAAuB,CAAC,MAAM,GAAG,OAAO,EAAE,UAAU,GAAG,OAAO,IAAI,CAC5E,SAAS,EAAE,cAAc,CAAC,MAAM,CAAC,GAAG,UAAU,KAC3C,cAAc,CAAC,MAAM,CAAC,GAAG,UAAU,CAAC;AAEzC;;;;GAIG;AACH,MAAM,MAAM,aAAa,CACvB,MAAM,GAAG,OAAO,EAChB,cAAc,GAAG,OAAO,IACtB,iBAAiB,GACnB,kBAAkB,CAAC,MAAM,CAAC,GAC1B,CAAC,cAAc,SAAS,MAAM,GAAG,cAAc,GAAG,MAAM,CAAC,CAAC;AAE5D;;;GAGG;AACH,MAAM,MAAM,cAAc,CACxB,MAAM,GAAG,OAAO,EAChB,eAAe,GAAG,OAAO,IACvB,kBAAkB,GACpB,mBAAmB,CAAC,MAAM,CAAC,GAC3B,CAAC,eAAe,SAAS,MAAM,GAAG,eAAe,GAAG,MAAM,CAAC,CAAC;AAE9D;;;;;;GAMG;AACH,MAAM,MAAM,SAAS,CACnB,MAAM,GAAG,OAAO,EAChB,cAAc,GAAG,OAAO,EACxB,eAAe,GAAG,OAAO,IAEvB,CAAC,aAAa,CAAC,MAAM,EAAE,cAAc,CAAC,GACpC,OAAO,CACL,mBAAmB,CAAC,MAAM,CAAC,GACzB,CAAC,eAAe,SAAS,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC,GAAG,MAAM,CAAC,CACvE,CAAC,GACJ,CAAC,cAAc,CAAC,MAAM,EAAE,eAAe,CAAC,GACtC,OAAO,CACL,kBAAkB,CAAC,MAAM,CAAC,GACxB,CAAC,cAAc,SAAS,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC,GAAG,MAAM,CAAC,CACrE,CAAC,CAAC;AAET,+DAA+D;AAC/D,MAAM,MAAM,eAAe,CAAC,MAAM,EAAE,cAAc,EAAE,eAAe,IAAI;IACrE;;;OAGG;IACH,aAAa,CAAC,EAAE,sBAAsB,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;IAC/D;;;OAGG;IACH,cAAc,CAAC,EAAE,uBAAuB,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;IAClE;;;;;;OAMG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B,CAAC"}

package/lib/typescript/specs/NativeWorkletsModule.d.ts

@@ -1,6 +1,6 @@
 import { type TurboModule } from 'react-native';
 export interface Spec extends TurboModule {
-    installTurboModule: () => boolean;
+    installTurboModule: (bundleModeEnabled: boolean) => boolean;
 }
 declare const _default: Spec | null;
 export default _default;

package/lib/typescript/specs/NativeWorkletsModule.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"NativeWorkletsModule.d.ts","sourceRoot":"","sources":["../../../src/specs/NativeWorkletsModule.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,WAAW,EAAuB,MAAM,cAAc,CAAC;AAErE,MAAM,WAAW,IAAK,SAAQ,WAAW;IACvC,kBAAkB,EAAE,MAAM,OAAO,CAAC;CACnC;;AAED,wBAA+D"}
+{"version":3,"file":"NativeWorkletsModule.d.ts","sourceRoot":"","sources":["../../../src/specs/NativeWorkletsModule.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,WAAW,EAAuB,MAAM,cAAc,CAAC;AAErE,MAAM,WAAW,IAAK,SAAQ,WAAW;IACvC,kBAAkB,EAAE,CAAC,iBAAiB,EAAE,OAAO,KAAK,OAAO,CAAC;CAC7D;;AAED,wBAA+D"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-native-worklets",
-  "version": "0.8.0-rc.0",
+  "version": "0.8.0",
   "description": "The React Native multithreading library",
   "keywords": [
     "react-native",
@@ -37,7 +37,8 @@
     "type:check:app": "yarn workspace common-app type:check",
     "type:check:plugin": "yarn workspace babel-plugin-worklets type:check",
     "type:check:tests": "../../scripts/test-ts.sh __typetests__",
-    "tree-shake:check:web": "yarn is-tree-shakable --resolution web"
+    "tree-shake:check:web": "yarn is-tree-shakable --resolution web",
+    "validate-peers": "node ../../scripts/validate-compatibility-peer-dependencies.js"
   },
   "repository": {
     "type": "git",
@@ -54,21 +55,20 @@
     "@babel/core": "*",
     "@react-native/metro-config": "*",
     "react": "*",
-    "react-native": "*"
+    "react-native": "0.81 - 0.85"
   },
   "dependencies": {
-    "@babel/plugin-transform-arrow-functions": "7.27.1",
-    "@babel/plugin-transform-class-properties": "7.27.1",
-    "@babel/plugin-transform-classes": "7.28.4",
-    "@babel/plugin-transform-nullish-coalescing-operator": "7.27.1",
-    "@babel/plugin-transform-optional-chaining": "7.27.1",
-    "@babel/plugin-transform-shorthand-properties": "7.27.1",
-    "@babel/plugin-transform-template-literals": "7.27.1",
-    "@babel/plugin-transform-unicode-regex": "7.27.1",
-    "@babel/preset-typescript": "7.27.1",
-    "convert-source-map": "2.0.0",
-    "is-tree-shakable": "0.4.1",
-    "semver": "7.7.3"
+    "@babel/plugin-transform-arrow-functions": "^7.27.1",
+    "@babel/plugin-transform-class-properties": "^7.27.1",
+    "@babel/plugin-transform-classes": "^7.28.4",
+    "@babel/plugin-transform-nullish-coalescing-operator": "^7.27.1",
+    "@babel/plugin-transform-optional-chaining": "^7.27.1",
+    "@babel/plugin-transform-shorthand-properties": "^7.27.1",
+    "@babel/plugin-transform-template-literals": "^7.27.1",
+    "@babel/plugin-transform-unicode-regex": "^7.27.1",
+    "@babel/preset-typescript": "^7.27.1",
+    "convert-source-map": "^2.0.0",
+    "semver": "^7.7.3"
   },
   "devDependencies": {
     "@babel/cli": "7.28.3",
@@ -82,6 +82,7 @@
     "clang-format-node": "1.3.5",
     "code-tag": "1.2.0",
     "eslint": "9.37.0",
+    "is-tree-shakable": "^0.5.0",
     "jest": "30.2.0",
     "knip": "5.61.3",
     "madge": "8.0.0",

package/scripts/worklets_utils.rb

@@ -8,7 +8,6 @@ end
 
 def worklets_find_config()
   result = {
-    :bundle_mode_flag => nil,
     :feature_flags_flag => nil,
     :fetch_preview_flag => nil,
     :is_reanimated_example_app => nil,
@@ -48,7 +47,6 @@ def worklets_find_config()
 
   feature_flags = worklets_get_static_feature_flags()
   result[:feature_flags_flag] = worklets_get_static_feature_flags_flag(feature_flags)
-  result[:bundle_mode_flag] = worklets_get_flag_from_feature_flags(feature_flags, 'BUNDLE_MODE_ENABLED')
   result[:fetch_preview_flag] = worklets_get_flag_from_feature_flags(feature_flags, 'FETCH_PREVIEW_ENABLED')
   
   return result

package/src/WorkletsModule/NativeWorklets.native.ts

@@ -20,13 +20,14 @@ class NativeWorklets implements IWorkletsModule {
   #serializableFalse: SerializableRef<boolean>;
 
   constructor() {
+    const bundleModeEnabled = globalThis._WORKLETS_BUNDLE_MODE_ENABLED ?? false;
     globalThis._WORKLETS_VERSION_JS = jsVersion;
     if (
       global.__workletsModuleProxy === undefined &&
       globalThis.__RUNTIME_KIND === RuntimeKind.ReactNative
     ) {
-      WorkletsTurboModule?.installTurboModule();
-      if (__DEV__ && globalThis._WORKLETS_BUNDLE_MODE_ENABLED) {
+      WorkletsTurboModule?.installTurboModule(bundleModeEnabled);
+      if (__DEV__ && bundleModeEnabled) {
         console.log(
           '[Worklets] Bundle mode initialization: Downloaded the bundle for Worklet Runtimes.'
         );

package/src/debug/jsVersion.ts

@@ -5,4 +5,4 @@
  * version used to build the native part of the library in runtime. Remember to
  * keep this in sync with the version declared in `package.json`
  */
-export const jsVersion = '0.8.0-rc.0';
+export const jsVersion = '0.8.0';

package/src/featureFlags/staticFlags.json

@@ -1,6 +1,5 @@
 {
   "RUNTIME_TEST_FLAG": false,
-  "BUNDLE_MODE_ENABLED": false,
   "FETCH_PREVIEW_ENABLED": false,
   "IOS_DYNAMIC_FRAMERATE_ENABLED": true
 }

package/src/featureFlags/types.ts

@@ -21,7 +21,6 @@ export type DynamicFlagName = keyof Omit<
  */
 export const DefaultStaticFeatureFlags = {
   RUNTIME_TEST_FLAG: false,
-  BUNDLE_MODE_ENABLED: false,
   FETCH_PREVIEW_ENABLED: false,
   IOS_DYNAMIC_FRAMERATE_ENABLED: true,
 } as const satisfies typeof StaticFeatureFlagsJSON;

package/src/memory/serializable.native.ts

@@ -173,15 +173,21 @@ export function createSerializable<TValue>(
   if (Array.isArray(value)) {
     return cloneArray(value, shouldPersistRemote, depth);
   }
-  if (
-    globalThis._WORKLETS_BUNDLE_MODE_ENABLED &&
-    isFunction &&
-    (value as WorkletImport).__bundleData
-  ) {
-    return cloneImport(value as WorkletImport) as SerializableRef<TValue>;
-  }
-  if (isFunction && !isWorkletFunction(value)) {
-    return cloneRemoteFunction(value);
+  if (isFunction) {
+    if (globalThis._WORKLETS_BUNDLE_MODE_ENABLED) {
+      if ((value as RemoteFunction).__remoteFunction) {
+        // Remote functions are already serialized.
+        return (value as RemoteFunction)
+          .__remoteFunction as SerializableRef<TValue>;
+      }
+      if ((value as WorkletImport).__bundleData) {
+        return cloneImport(value as WorkletImport) as SerializableRef<TValue>;
+      }
+    } else {
+      if (!isWorkletFunction(value)) {
+        return cloneRemoteFunction(value);
+      }
+    }
   }
   // RN has introduced a new representation of TurboModules as a JS object whose prototype is the host object
   // More details: https://github.com/facebook/react-native/blob/main/packages/react-native/ReactCommon/react/nativemodule/core/ReactCommon/TurboModuleBinding.cpp#L182
@@ -732,7 +738,7 @@ function getWorkletCode(value: WorkletFunction) {
   return code;
 }
 
-type RemoteFunction<TValue> = {
+type RemoteFunction<TValue = unknown> = {
   __remoteFunction: FlatSerializableRef<TValue>;
 };
 

package/src/memory/shareable.native.ts

@@ -6,8 +6,22 @@ import { UIRuntimeId } from '../runtimes';
 import { isWorkletFunction } from '../workletFunction';
 import { WorkletsModule } from '../WorkletsModule/NativeWorklets';
 import { createSerializable } from './serializable';
-import type { SerializableRef, Shareable, ShareableConfig } from './types';
+import type { Shareable, ShareableConfig } from './types';
 
+/**
+ * Creates a new {@link Shareable} holding the provided initial value. You must
+ * explicitly declare which Worklet Runtime will host the Shareable by passing
+ * its `runtimeId`.
+ *
+ * Currently only hosting a Shareable on the UI Runtime is supported.
+ *
+ * @param hostRuntimeId - The `runtimeId` of the Worklet Runtime that will host
+ *   the Shareable. Use {@link UIRuntimeId}.
+ * @param initial - The initial value of the Shareable.
+ * @param config - Optional advanced configuration.
+ * @returns The created {@link Shareable}.
+ * @see {@link https://docs.swmansion.com/react-native-worklets/docs/memory/createShareable | createShareable docs}
+ */
 export function createShareable<
   TValue = unknown,
   THostDecorated = unknown,
@@ -28,7 +42,7 @@ export function createShareable<
   TGuestDecorated = unknown,
 >(
   hostRuntimeId: number,
-  initial: SerializableRef<TValue>,
+  initial: TValue,
   config?: ShareableConfig<TValue, THostDecorated, TGuestDecorated>
 ): Shareable<TValue, THostDecorated, TGuestDecorated>;
 

package/src/memory/shareable.ts

@@ -2,8 +2,22 @@
 
 import { WorkletsError } from '../debug/WorkletsError';
 import type { UIRuntimeId } from '../runtimes';
-import type { SerializableRef, Shareable, ShareableConfig } from './types';
+import type { Shareable, ShareableConfig } from './types';
 
+/**
+ * Creates a new {@link Shareable} holding the provided initial value. You must
+ * explicitly declare which Worklet Runtime will host the Shareable by passing
+ * its `runtimeId`.
+ *
+ * Currently only hosting a Shareable on the UI Runtime is supported.
+ *
+ * @param hostRuntimeId - The `runtimeId` of the Worklet Runtime that will host
+ *   the Shareable. Use {@link UIRuntimeId}.
+ * @param initial - The initial value of the Shareable.
+ * @param config - Optional advanced configuration.
+ * @returns The created {@link Shareable}.
+ * @see {@link https://docs.swmansion.com/react-native-worklets/docs/memory/createShareable | createShareable docs}
+ */
 export function createShareable<
   TValue = unknown,
   THostDecorated = unknown,
@@ -24,7 +38,7 @@ export function createShareable<
   TGuestDecorated = unknown,
 >(
   hostRuntimeId: number,
-  initial: SerializableRef<TValue>,
+  initial: TValue,
   config?: ShareableConfig<TValue, THostDecorated, TGuestDecorated>
 ): Shareable<TValue, THostDecorated, TGuestDecorated>;
 

package/src/memory/types.ts

@@ -87,6 +87,11 @@ export type ShareableHostMeta = {
   __shareableRef: true;
 };
 
+/**
+ * A worklet that takes the created {@link ShareableHost} and decorates it with
+ * additional properties or methods. It must return the same reference it
+ * received.
+ */
 export type ShareableHostDecorator<TValue = unknown, TDecorated = unknown> = (
   shareable: ShareableHost<TValue> & TDecorated
 ) => ShareableHost<TValue> & TDecorated;
@@ -103,10 +108,20 @@ export type ShareableGuestProps<TValue = unknown> = {
   setSync(value: TValue | ((prev: TValue) => TValue)): void;
 };
 
+/**
+ * A worklet that decorates each {@link ShareableGuest} created for the Shareable
+ * with additional properties or methods. It must return the same reference it
+ * received.
+ */
 export type ShareableGuestDecorator<TValue = unknown, TDecorated = unknown> = (
   shareable: ShareableGuest<TValue> & TDecorated
 ) => ShareableGuest<TValue> & TDecorated;
 
+/**
+ * The host-side representation of a {@link Shareable}, living on the
+ * {@link https://docs.swmansion.com/react-native-worklets/docs/fundamentals/runtimeKinds#worklet-runtime | Worklet Runtime}
+ * that hosts the Shareable.
+ */
 export type ShareableHost<
   TValue = unknown,
   THostDecorated = unknown,
@@ -114,6 +129,10 @@ export type ShareableHost<
   ShareableHostProps<TValue> &
   (THostDecorated extends object ? THostDecorated : object);
 
+/**
+ * A guest-side representation of a {@link Shareable}, used on any runtime other
+ * than the host runtime.
+ */
 export type ShareableGuest<
   TValue = unknown,
   TGuestDecorated = unknown,
@@ -121,6 +140,13 @@ export type ShareableGuest<
   ShareableGuestProps<TValue> &
   (TGuestDecorated extends object ? TGuestDecorated : object);
 
+/**
+ * A type of shared memory tied to a given runtime, called the Host Runtime.
+ * Depending on the context it's either a {@link ShareableHost} (on the hosting
+ * Worklet Runtime) or a {@link ShareableGuest} (on every other runtime).
+ *
+ * @see {@link https://docs.swmansion.com/react-native-worklets/docs/memory/shareable | Shareable docs}
+ */
 export type Shareable<
   TValue = unknown,
   THostDecorated = unknown,
@@ -137,8 +163,24 @@ export type Shareable<
           (THostDecorated extends object ? Partial<THostDecorated> : object)
       >);
 
+/** Optional advanced configuration for a {@link Shareable}. */
 export type ShareableConfig<TValue, THostDecorated, TGuestDecorated> = {
+  /**
+   * A worklet that decorates the {@link ShareableHost} with additional
+   * properties or methods.
+   */
   hostDecorator?: ShareableHostDecorator<TValue, THostDecorated>;
+  /**
+   * A worklet that decorates each {@link ShareableGuest} with additional
+   * properties or methods.
+   */
   guestDecorator?: ShareableGuestDecorator<TValue, TGuestDecorated>;
+  /**
+   * When `true`, the {@link ShareableHost} is created synchronously during the
+   * call to `createShareable` instead of lazily on first access. Use this when
+   * the host initialization triggers side effects that must happen eagerly.
+   *
+   * @defaultValue `false`
+   */
   initSynchronously?: boolean;
 };

package/src/privateGlobals.d.ts

@@ -73,6 +73,10 @@ declare global {
   var __flushAnimationFrame: (timestamp: number) => void;
   var __frameTimestamp: number | undefined;
   var _log: (value: unknown) => void;
+  var _startProfiling: (meanHzFreq?: number) => void;
+  var _stopProfiling: () => string;
+  var _beginSection: (name: string) => void;
+  var _endSection: () => void;
   var _getAnimationTimestamp: () => number;
   var _scheduleOnRuntime: (
     runtime: WorkletRuntime,

package/src/runtimeKind.ts

@@ -76,6 +76,7 @@ export function isWorkerRuntime(): boolean {
   return globalThis.__RUNTIME_KIND === 3;
 }
 
+// is-tree-shakable-suppress
 if (globalThis.__RUNTIME_KIND === undefined) {
   // In Jest environments eager imports make this file to evaluate before
   // `initializers.ts` file, therefore we have to set the RuntimeKind here,

package/src/specs/NativeWorkletsModule.ts

@@ -3,7 +3,7 @@
 import { type TurboModule, TurboModuleRegistry } from 'react-native';
 
 export interface Spec extends TurboModule {
-  installTurboModule: () => boolean;
+  installTurboModule: (bundleModeEnabled: boolean) => boolean;
 }
 
 export default TurboModuleRegistry.get<Spec>('WorkletsModule');