@lynx-js/react 0.105.0

package/runtime/lib/utils.d.ts

@@ -0,0 +1,4 @@
+export declare function isDirectOrDeepEqual(a: any, b: any): boolean;
+export declare function isEmptyObject(obj?: object): obj is Record<string, never>;
+export declare function isSdkVersionGt(major: number, minor: number): boolean;
+export declare function pick<T extends object, K extends keyof T>(obj: T, keys: Iterable<K>): Pick<T, K>;

package/runtime/lib/utils.js

@@ -0,0 +1,32 @@
+// Copyright 2024 The Lynx Authors. All rights reserved.
+// Licensed under the Apache License Version 2.0 that can be found in the
+// LICENSE file in the root directory of this source tree.
+export function isDirectOrDeepEqual(a, b) {
+    if (a === b) {
+        return true;
+    }
+    if (typeof a == 'object' && a !== null && typeof b == 'object' && b !== null && JSON.stringify(a) === JSON.stringify(b)) {
+        return true;
+    }
+    return false;
+}
+export function isEmptyObject(obj) {
+    for (var _ in obj)
+        return false;
+    return true;
+}
+export function isSdkVersionGt(major, minor) {
+    const lynxSdkVersion = SystemInfo.lynxSdkVersion || '1.0';
+    const version = lynxSdkVersion.split('.');
+    return Number(version[0]) > major || (Number(version[0]) == major && Number(version[1]) > minor);
+}
+export function pick(obj, keys) {
+    const result = {};
+    for (const key of keys) {
+        if (key in obj) {
+            result[key] = obj[key];
+        }
+    }
+    return result;
+}
+//# sourceMappingURL=utils.js.map

package/runtime/lib/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA,wDAAwD;AACxD,yEAAyE;AACzE,0DAA0D;AAC1D,MAAM,UAAU,mBAAmB,CAAC,CAAM,EAAE,CAAM;IAChD,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;QACZ,OAAO,IAAI,CAAC;IACd,CAAC;IACD,IACE,OAAO,CAAC,IAAI,QAAQ,IAAI,CAAC,KAAK,IAAI,IAAI,OAAO,CAAC,IAAI,QAAQ,IAAI,CAAC,KAAK,IAAI,IAAI,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,EACnH,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,MAAM,UAAU,aAAa,CAAC,GAAY;IACxC,KAAK,IAAI,CAAC,IAAI,GAAG;QAAE,OAAO,KAAK,CAAC;IAChC,OAAO,IAAI,CAAC;AACd,CAAC;AAED,MAAM,UAAU,cAAc,CAAC,KAAa,EAAE,KAAa;IACzD,MAAM,cAAc,GAAW,UAAU,CAAC,cAAc,IAAI,KAAK,CAAC;IAClE,MAAM,OAAO,GAAG,cAAc,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAC1C,OAAO,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC;AACnG,CAAC;AAED,MAAM,UAAU,IAAI,CAAsC,GAAM,EAAE,IAAiB;IACjF,MAAM,MAAM,GAAQ,EAAE,CAAC;IACvB,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;QACvB,IAAI,GAAG,IAAI,GAAG,EAAE,CAAC;YACf,MAAM,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC;QACzB,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/runtime/lib/worklet/ctx.d.ts

@@ -0,0 +1 @@
+export {};

package/runtime/lib/worklet/ctx.js

@@ -0,0 +1,17 @@
+import { lynxWorkletJsImpl } from './jsImpl.js';
+/**
+ * @internal
+ */
+export function onPostWorkletCtx(afterValue) {
+    const impl = lynxWorkletJsImpl();
+    if (!impl && afterValue) {
+        lynx.reportError(new Error('Main thread script requires Lynx sdk version 2.14'));
+        return null;
+    }
+    if (!afterValue) {
+        return afterValue;
+    }
+    impl?._workletExecIdMap?.add(afterValue);
+    return afterValue;
+}
+//# sourceMappingURL=ctx.js.map

package/runtime/lib/worklet/ctx.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ctx.js","sourceRoot":"","sources":["../../src/worklet/ctx.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAEhD;;GAEG;AACH,MAAM,UAAU,gBAAgB,CAAC,UAA0B;IACzD,MAAM,IAAI,GAAG,iBAAiB,EAAE,CAAC;IACjC,IAAI,CAAC,IAAI,IAAI,UAAU,EAAE,CAAC;QACxB,IAAI,CAAC,WAAW,CAAC,IAAI,KAAK,CAAC,mDAAmD,CAAC,CAAC,CAAC;QACjF,OAAO,IAAI,CAAC;IACd,CAAC;IACD,IAAI,CAAC,UAAU,EAAE,CAAC;QAChB,OAAO,UAAU,CAAC;IACpB,CAAC;IACD,IAAI,EAAE,iBAAiB,EAAE,GAAG,CAAC,UAAU,CAAC,CAAC;IACzC,OAAO,UAAU,CAAC;AACpB,CAAC"}

package/runtime/lib/worklet/execMap.d.ts

@@ -0,0 +1 @@
+export {};

package/runtime/lib/worklet/execMap.js

@@ -0,0 +1,42 @@
+import { IndexMap } from './indexMap.js';
+/**
+ * `WorkletExecIdMap` ensures the worklet object is not released in js context when the main thread is still holding the
+ * worklet object (or any of its jsFnHandles). The worklet object holds the js functions which might be called by `runOnBackground()`.
+ * If the worklet object is incorrectly released earlier, the `runOnBackground()` would result in failure.
+ *
+ * Every time a worklet object is sent to the main thread, an `execId` is distributed and will be sent to element
+ * context with the worklet object. This relationship is recorded in this class. When all the references to the
+ * worklet object are released in the main thread, a message will be sent back to remove the record here.
+ *
+ * @internal
+ */
+export class WorkletExecIdMap extends IndexMap {
+    add(worklet) {
+        const execId = super.add(worklet);
+        worklet._execId = execId;
+        return execId;
+    }
+    findJsFnHandle(execId, fnId) {
+        const worklet = this.get(execId);
+        if (!worklet) {
+            return undefined;
+        }
+        const f = (obj) => {
+            if (obj === null || typeof obj !== 'object') {
+                return undefined;
+            }
+            if ('_jsFnId' in obj && obj._jsFnId === fnId) {
+                return obj;
+            }
+            for (const i in obj) {
+                const result = f(obj[i]);
+                if (result) {
+                    return result;
+                }
+            }
+            return undefined;
+        };
+        return f(worklet);
+    }
+}
+//# sourceMappingURL=execMap.js.map

package/runtime/lib/worklet/execMap.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"execMap.js","sourceRoot":"","sources":["../../src/worklet/execMap.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAEzC;;;;;;;;;;GAUG;AACH,MAAM,OAAO,gBAAiB,SAAQ,QAAiB;IACrC,GAAG,CAAC,OAAgB;QAClC,MAAM,MAAM,GAAG,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QAClC,OAAO,CAAC,OAAO,GAAG,MAAM,CAAC;QACzB,OAAO,MAAM,CAAC;IAChB,CAAC;IAEM,cAAc,CAAC,MAAc,EAAE,IAAY;QAChD,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QACjC,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,MAAM,CAAC,GAAG,CAAC,GAAQ,EAA0B,EAAE;YAC7C,IAAI,GAAG,KAAK,IAAI,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;gBAC5C,OAAO,SAAS,CAAC;YACnB,CAAC;YACD,IAAI,SAAS,IAAI,GAAG,IAAI,GAAG,CAAC,OAAO,KAAK,IAAI,EAAE,CAAC;gBAC7C,OAAO,GAAiB,CAAC;YAC3B,CAAC;YACD,KAAK,MAAM,CAAC,IAAI,GAAG,EAAE,CAAC;gBACpB,MAAM,MAAM,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;gBACzB,IAAI,MAAM,EAAE,CAAC;oBACX,OAAO,MAAM,CAAC;gBAChB,CAAC;YACH,CAAC;YACD,OAAO,SAAS,CAAC;QACnB,CAAC,CAAC;QAEF,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC;IACpB,CAAC;CACF"}

package/runtime/lib/worklet/functionality.d.ts

@@ -0,0 +1 @@
+export {};

package/runtime/lib/worklet/functionality.js

@@ -0,0 +1,11 @@
+// Copyright 2024 The Lynx Authors. All rights reserved.
+// Licensed under the Apache License Version 2.0 that can be found in the
+// LICENSE file in the root directory of this source tree.
+import { isSdkVersionGt } from '../utils.js';
+/**
+ * @internal
+ */
+export function enableRunOnBackground() {
+    return isSdkVersionGt(2, 15);
+}
+//# sourceMappingURL=functionality.js.map

package/runtime/lib/worklet/functionality.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"functionality.js","sourceRoot":"","sources":["../../src/worklet/functionality.ts"],"names":[],"mappings":"AAAA,wDAAwD;AACxD,yEAAyE;AACzE,0DAA0D;AAE1D,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAE7C;;GAEG;AACH,MAAM,UAAU,qBAAqB;IACnC,OAAO,cAAc,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;AAC/B,CAAC"}

package/runtime/lib/worklet/hmr.d.ts

@@ -0,0 +1 @@
+export { registerWorkletOnBackground };

package/runtime/lib/worklet/hmr.js

@@ -0,0 +1,21 @@
+// Copyright 2024 The Lynx Authors. All rights reserved.
+// Licensed under the Apache License Version 2.0 that can be found in the
+// LICENSE file in the root directory of this source tree.
+import { SnapshotOperation, __globalSnapshotPatch } from '../snapshotPatch.js';
+const workletHashSet = /* @__PURE__ */ new Set();
+/**
+ * @internal
+ */
+function registerWorkletOnBackground(_type, hash, fn) {
+    if (workletHashSet.has(hash)) {
+        return;
+    }
+    workletHashSet.add(hash);
+    if (__globalSnapshotPatch) {
+        __globalSnapshotPatch.push(SnapshotOperation.DEV_ONLY_RegisterWorklet, hash, 
+        // We use `Function.prototype.toString` to serialize the function for Lepus.
+        fn.toString());
+    }
+}
+export { registerWorkletOnBackground };
+//# sourceMappingURL=hmr.js.map

package/runtime/lib/worklet/hmr.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"hmr.js","sourceRoot":"","sources":["../../src/worklet/hmr.ts"],"names":[],"mappings":"AAAA,wDAAwD;AACxD,yEAAyE;AACzE,0DAA0D;AAC1D,OAAO,EAAE,iBAAiB,EAAE,qBAAqB,EAAE,MAAM,qBAAqB,CAAC;AAE/E,MAAM,cAAc,GAAgB,eAAe,CAAC,IAAI,GAAG,EAAE,CAAC;AAE9D;;GAEG;AACH,SAAS,2BAA2B,CAAC,KAAa,EAAE,IAAY,EAAE,EAAY;IAC5E,IAAI,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;QAC7B,OAAO;IACT,CAAC;IACD,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACzB,IAAI,qBAAqB,EAAE,CAAC;QAC1B,qBAAqB,CAAC,IAAI,CACxB,iBAAiB,CAAC,wBAAwB,EAC1C,IAAI;QACJ,4EAA4E;QAC5E,EAAE,CAAC,QAAQ,EAAE,CACd,CAAC;IACJ,CAAC;AACH,CAAC;AAED,OAAO,EAAE,2BAA2B,EAAE,CAAC"}

package/runtime/lib/worklet/indexMap.d.ts

@@ -0,0 +1,8 @@
+declare class IndexMap<T> {
+    protected lastIndex: number;
+    protected indexMap: Map<number, T>;
+    add(value: T): number;
+    get(index: number): T | undefined;
+    remove(index: number): void;
+}
+export { IndexMap };

package/runtime/lib/worklet/indexMap.js

@@ -0,0 +1,17 @@
+class IndexMap {
+    lastIndex = 0;
+    indexMap = new Map();
+    add(value) {
+        const index = ++this.lastIndex;
+        this.indexMap.set(index, value);
+        return index;
+    }
+    get(index) {
+        return this.indexMap.get(index);
+    }
+    remove(index) {
+        this.indexMap.delete(index);
+    }
+}
+export { IndexMap };
+//# sourceMappingURL=indexMap.js.map

package/runtime/lib/worklet/indexMap.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"indexMap.js","sourceRoot":"","sources":["../../src/worklet/indexMap.ts"],"names":[],"mappings":"AAAA,MAAM,QAAQ;IACF,SAAS,GAAG,CAAC,CAAC;IACd,QAAQ,GAAmB,IAAI,GAAG,EAAE,CAAC;IAExC,GAAG,CAAC,KAAQ;QACjB,MAAM,KAAK,GAAG,EAAE,IAAI,CAAC,SAAS,CAAC;QAC/B,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;QAChC,OAAO,KAAK,CAAC;IACf,CAAC;IAEM,GAAG,CAAC,KAAa;QACtB,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IAClC,CAAC;IAEM,MAAM,CAAC,KAAa;QACzB,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAC9B,CAAC;CACF;AAED,OAAO,EAAE,QAAQ,EAAE,CAAC"}

package/runtime/lib/worklet/jsImpl.d.ts

@@ -0,0 +1,11 @@
+import { WorkletExecIdMap } from './execMap.js';
+interface LynxWorkletJsImpl {
+    _workletExecIdMap?: WorkletExecIdMap;
+    _workletJsFnLastId: number;
+    _workletRefLastId: number;
+    _workletRefInitValueSet: Set<number>;
+    _workletRefInitValuePatch: [number, unknown][];
+}
+export declare function destroyWorklet(): void;
+export declare function lynxWorkletJsImpl(shouldInit?: boolean): LynxWorkletJsImpl | undefined;
+export {};

package/runtime/lib/worklet/jsImpl.js

@@ -0,0 +1,68 @@
+// Copyright 2024 The Lynx Authors. All rights reserved.
+// Licensed under the Apache License Version 2.0 that can be found in the
+// LICENSE file in the root directory of this source tree.
+import { WorkletEvents } from '@lynx-js/react/worklet-runtime/bindings';
+import { WorkletExecIdMap } from './execMap.js';
+import { enableRunOnBackground } from './functionality.js';
+/**
+ * @internal
+ */
+export function runJSFunction(event) {
+    const impl = lynxWorkletJsImpl();
+    if (!impl || !impl._workletExecIdMap) {
+        return;
+    }
+    const data = JSON.parse(event.data);
+    const obj = impl._workletExecIdMap.findJsFnHandle(data.obj._execId, data.obj._jsFnId);
+    const f = obj?._fn;
+    if (!f) {
+        throw new Error('runOnBackground: JS function not found: ' + JSON.stringify(data.obj));
+    }
+    f(...data.params);
+}
+/**
+ * @internal
+ */
+export function removeJsWorklets(event) {
+    const impl = lynxWorkletJsImpl();
+    if (!impl?._workletExecIdMap) {
+        return;
+    }
+    for (const id of event.data) {
+        impl._workletExecIdMap.remove(id);
+    }
+}
+function initWorklet() {
+    if (lynx.getCoreContext === undefined) {
+        return false;
+    }
+    lynx.lynxWorkletJsImpl = {
+        _workletJsFnLastId: 0,
+        _workletRefLastId: 0,
+        _workletRefInitValueSet: new Set(),
+        _workletRefInitValuePatch: [],
+    };
+    if (enableRunOnBackground()) {
+        lynx.lynxWorkletJsImpl._workletExecIdMap = new WorkletExecIdMap();
+        lynx.getCoreContext().addEventListener(WorkletEvents.runOnBackground, runJSFunction);
+        lynx.getCoreContext().addEventListener(WorkletEvents.releaseBackgroundWorkletCtx, removeJsWorklets);
+    }
+    return true;
+}
+export function destroyWorklet() {
+    if (!lynx.lynxWorkletJsImpl) {
+        return;
+    }
+    lynx.lynxWorkletJsImpl = undefined;
+    if (enableRunOnBackground()) {
+        lynx.getCoreContext?.().removeEventListener(WorkletEvents.runOnBackground, runJSFunction);
+        lynx.getCoreContext?.().removeEventListener(WorkletEvents.releaseBackgroundWorkletCtx, removeJsWorklets);
+    }
+}
+export function lynxWorkletJsImpl(shouldInit = true) {
+    if (lynx.lynxWorkletJsImpl || (shouldInit && initWorklet())) {
+        return lynx.lynxWorkletJsImpl;
+    }
+    return undefined;
+}
+//# sourceMappingURL=jsImpl.js.map

package/runtime/lib/worklet/jsImpl.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"jsImpl.js","sourceRoot":"","sources":["../../src/worklet/jsImpl.ts"],"names":[],"mappings":"AAAA,wDAAwD;AACxD,yEAAyE;AACzE,0DAA0D;AAC1D,OAAO,EAAE,aAAa,EAAE,MAAM,yCAAyC,CAAC;AAExE,OAAO,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAChD,OAAO,EAAE,qBAAqB,EAAE,MAAM,oBAAoB,CAAC;AAU3D;;GAEG;AACH,MAAM,UAAU,aAAa,CAAC,KAAyB;IACrD,MAAM,IAAI,GAAG,iBAAiB,EAAE,CAAC;IACjC,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC;QACrC,OAAO;IACT,CAAC;IACD,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IACpC,MAAM,GAAG,GAAG,IAAI,CAAC,iBAAiB,CAAC,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IACtF,MAAM,CAAC,GAAG,GAAG,EAAE,GAAG,CAAC;IACnB,IAAI,CAAC,CAAC,EAAE,CAAC;QACP,MAAM,IAAI,KAAK,CAAC,0CAA0C,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;IACzF,CAAC;IACD,CAAC,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC;AACpB,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,gBAAgB,CAAC,KAAyB;IACxD,MAAM,IAAI,GAAG,iBAAiB,EAAE,CAAC;IACjC,IAAI,CAAC,IAAI,EAAE,iBAAiB,EAAE,CAAC;QAC7B,OAAO;IACT,CAAC;IACD,KAAK,MAAM,EAAE,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC;QAC5B,IAAI,CAAC,iBAAiB,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IACpC,CAAC;AACH,CAAC;AAED,SAAS,WAAW;IAClB,IAAI,IAAI,CAAC,cAAc,KAAK,SAAS,EAAE,CAAC;QACtC,OAAO,KAAK,CAAC;IACf,CAAC;IAED,IAAI,CAAC,iBAAiB,GAAG;QACvB,kBAAkB,EAAE,CAAC;QACrB,iBAAiB,EAAE,CAAC;QACpB,uBAAuB,EAAE,IAAI,GAAG,EAAU;QAC1C,yBAAyB,EAAE,EAAE;KAC9B,CAAC;IAEF,IAAI,qBAAqB,EAAE,EAAE,CAAC;QAC5B,IAAI,CAAC,iBAAiB,CAAC,iBAAiB,GAAG,IAAI,gBAAgB,EAAE,CAAC;QAClE,IAAI,CAAC,cAAc,EAAE,CAAC,gBAAgB,CAAC,aAAa,CAAC,eAAe,EAAE,aAAa,CAAC,CAAC;QACrF,IAAI,CAAC,cAAc,EAAE,CAAC,gBAAgB,CAAC,aAAa,CAAC,2BAA2B,EAAE,gBAAgB,CAAC,CAAC;IACtG,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AAED,MAAM,UAAU,cAAc;IAC5B,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC;QAC5B,OAAO;IACT,CAAC;IAED,IAAI,CAAC,iBAAiB,GAAG,SAAS,CAAC;IAEnC,IAAI,qBAAqB,EAAE,EAAE,CAAC;QAC5B,IAAI,CAAC,cAAc,EAAE,EAAE,CAAC,mBAAmB,CAAC,aAAa,CAAC,eAAe,EAAE,aAAa,CAAC,CAAC;QAC1F,IAAI,CAAC,cAAc,EAAE,EAAE,CAAC,mBAAmB,CAAC,aAAa,CAAC,2BAA2B,EAAE,gBAAgB,CAAC,CAAC;IAC3G,CAAC;AACH,CAAC;AAED,MAAM,UAAU,iBAAiB,CAAC,aAAsB,IAAI;IAC1D,IAAI,IAAI,CAAC,iBAAiB,IAAI,CAAC,UAAU,IAAI,WAAW,EAAE,CAAC,EAAE,CAAC;QAC5D,OAAO,IAAI,CAAC,iBAAiB,CAAC;IAChC,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC"}

package/runtime/lib/worklet/runWorklet.d.ts

@@ -0,0 +1,14 @@
+/**
+ * `runOnMainThread` allows triggering main thread functions on the main thread asynchronously.
+ * @param fn - The main thread functions to be called.
+ * @returns A function. Calling which with the arguments to be passed to the main thread function to trigger it on the main thread.
+ * @public
+ */
+export declare function runOnMainThread<Fn extends (...args: any[]) => any>(fn: Fn): (...args: Parameters<Fn>) => void;
+/**
+ * `runOnBackground` allows triggering js functions on the js context asynchronously.
+ * @param f - The js function to be called.
+ * @returns A function. Calling which with the arguments to be passed to the js function to trigger it on the js context.
+ * @public
+ */
+export declare function runOnBackground<Fn extends (...args: any[]) => any>(f: Fn): (...args: Parameters<Fn>) => void;

package/runtime/lib/worklet/runWorklet.js

@@ -0,0 +1,82 @@
+import { WorkletEvents } from '@lynx-js/react/worklet-runtime/bindings';
+import { onPostWorkletCtx } from './ctx.js';
+import { enableRunOnBackground } from './functionality.js';
+import { lynxWorkletJsImpl } from './jsImpl.js';
+/**
+ * transform args of `runOnJS()`.
+ *
+ * @internal
+ */
+export function transformToWorklet(obj) {
+    const impl = lynxWorkletJsImpl();
+    const id = impl ? ++impl._workletJsFnLastId : 0;
+    if (typeof obj !== 'function') {
+        // We save the error message in the object, so that we can throw it later when the function is called on the main thread.
+        return {
+            _jsFnId: id,
+            _error: `Argument of runOnBackground should be a function, but got [${typeof obj}] instead`,
+        };
+    }
+    return {
+        _jsFnId: id,
+        _fn: obj,
+    };
+}
+/**
+ * `runOnMainThread` allows triggering main thread functions on the main thread asynchronously.
+ * @param fn - The main thread functions to be called.
+ * @returns A function. Calling which with the arguments to be passed to the main thread function to trigger it on the main thread.
+ * @public
+ */
+export function runOnMainThread(fn) {
+    if (__LEPUS__) {
+        throw new Error('runOnMainThread can only be used on the background thread.');
+    }
+    const impl = lynxWorkletJsImpl();
+    if (!impl) {
+        throw new Error('runOnMainThread requires Lynx sdk version 2.14.');
+    }
+    return (...params) => {
+        onPostWorkletCtx(fn);
+        lynx.getCoreContext().dispatchEvent({
+            type: WorkletEvents.runWorkletCtx,
+            data: JSON.stringify({
+                worklet: fn,
+                params,
+            }),
+        });
+    };
+}
+/**
+ * `runOnBackground` allows triggering js functions on the js context asynchronously.
+ * @param f - The js function to be called.
+ * @returns A function. Calling which with the arguments to be passed to the js function to trigger it on the js context.
+ * @public
+ */
+export function runOnBackground(f) {
+    if (!enableRunOnBackground()) {
+        throw new Error('runOnBackground requires Lynx sdk version 2.16.');
+    }
+    if (__JS__) {
+        throw new Error('runOnBackground can not be used on the main thread.');
+    }
+    const obj = f;
+    if (obj._error) {
+        throw new Error(obj._error);
+    }
+    return (...params) => {
+        if (lynx.getJSContext) {
+            lynx.getJSContext().dispatchEvent({
+                type: WorkletEvents.runOnBackground,
+                data: JSON.stringify({
+                    obj: {
+                        _jsFnId: obj._jsFnId,
+                        _execId: obj._execId,
+                    },
+                    params,
+                }),
+            });
+        }
+    };
+}
+//# sourceMappingURL=runWorklet.js.map

package/runtime/lib/worklet/runWorklet.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"runWorklet.js","sourceRoot":"","sources":["../../src/worklet/runWorklet.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,aAAa,EAAE,MAAM,yCAAyC,CAAC;AAExE,OAAO,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAC5C,OAAO,EAAE,qBAAqB,EAAE,MAAM,oBAAoB,CAAC;AAC3D,OAAO,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAChD;;;;GAIG;AACH,MAAM,UAAU,kBAAkB,CAAC,GAAa;IAC9C,MAAM,IAAI,GAAG,iBAAiB,EAAE,CAAC;IACjC,MAAM,EAAE,GAAG,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,CAAC;IAChD,IAAI,OAAO,GAAG,KAAK,UAAU,EAAE,CAAC;QAC9B,yHAAyH;QACzH,OAAO;YACL,OAAO,EAAE,EAAE;YACX,MAAM,EAAE,8DAA8D,OAAO,GAAG,WAAW;SAC5F,CAAC;IACJ,CAAC;IACD,OAAO;QACL,OAAO,EAAE,EAAE;QACX,GAAG,EAAE,GAAG;KACT,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,eAAe,CAAqC,EAAM;IACxE,IAAI,SAAS,EAAE,CAAC;QACd,MAAM,IAAI,KAAK,CAAC,4DAA4D,CAAC,CAAC;IAChF,CAAC;IACD,MAAM,IAAI,GAAG,iBAAiB,EAAE,CAAC;IACjC,IAAI,CAAC,IAAI,EAAE,CAAC;QACV,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAC;IACrE,CAAC;IACD,OAAO,CAAC,GAAG,MAAa,EAAQ,EAAE;QAChC,gBAAgB,CAAC,EAAoB,CAAC,CAAC;QACvC,IAAI,CAAC,cAAe,EAAE,CAAC,aAAa,CAAC;YACnC,IAAI,EAAE,aAAa,CAAC,aAAa;YACjC,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;gBACnB,OAAO,EAAE,EAAE;gBACX,MAAM;aACP,CAAC;SACH,CAAC,CAAC;IACL,CAAC,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,eAAe,CAAqC,CAAK;IACvE,IAAI,CAAC,qBAAqB,EAAE,EAAE,CAAC;QAC7B,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAC;IACrE,CAAC;IACD,IAAI,MAAM,EAAE,CAAC;QACX,MAAM,IAAI,KAAK,CAAC,qDAAqD,CAAC,CAAC;IACzE,CAAC;IACD,MAAM,GAAG,GAAG,CAAsB,CAAC;IACnC,IAAI,GAAG,CAAC,MAAM,EAAE,CAAC;QACf,MAAM,IAAI,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IAC9B,CAAC;IACD,OAAO,CAAC,GAAG,MAAa,EAAQ,EAAE;QAChC,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;YACtB,IAAI,CAAC,YAAY,EAAE,CAAC,aAAa,CAAC;gBAChC,IAAI,EAAE,aAAa,CAAC,eAAe;gBACnC,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;oBACnB,GAAG,EAAE;wBACH,OAAO,EAAE,GAAG,CAAC,OAAO;wBACpB,OAAO,EAAE,GAAG,CAAC,OAAQ;qBACtB;oBACD,MAAM;iBACP,CAAC;aACH,CAAC,CAAC;QACL,CAAC;IACH,CAAC,CAAC;AACJ,CAAC"}

package/runtime/lib/worklet/workletRef.d.ts

@@ -0,0 +1,131 @@
+import type { RefObject } from 'react';
+declare abstract class WorkletRef<T> {
+    get current(): T;
+    set current(_: T);
+}
+/**
+ * A `MainThreadRef` is a ref that can only be accessed on the main thread. It is used to preserve
+ * states between main thread function calls.
+ * The data saved in `current` property of the `MainThreadRef` can be read and written in
+ * multiple main thread functions.
+ * @public
+ */
+export declare class MainThreadRef<T> extends WorkletRef<T> {
+    constructor(initValue: T);
+}
+/**
+ * Create A `MainThreadRef`.
+ *
+ * A `MainThreadRef` is a ref that can only be accessed on the main thread. It is used to preserve
+ * states between main thread function calls.
+ * The data saved in `current` property of the `MainThreadRef` can be read and written in
+ * multiple main thread functions.
+ *
+ * It is a hook and it should only be called at the top level of your component.
+ *
+ * @param initValue - The init value of the `MainThreadRef`.
+ *
+ * @example
+ *
+ * ```ts
+ * import { useMainThreadRef } from '@lynx-js/react'
+ * import type { MainThread } from '@lynx-js/types'
+ *
+ * export function App() {
+ *   const ref = useMainThreadRef<MainThread.Element>(null)
+ *
+ *   const handleTap = () => {
+ *     'main thread'
+ *     ref.current?.setStyleProperty('background-color', 'blue')
+ *   }
+ *
+ *   return (
+ *     <view
+ *       main-thread:ref={ref}
+ *       main-thread:bindtap={handleTap}
+ *       style={{ width: '300px', height: '300px' }}
+ *     />
+ *   )
+ * }
+ * ```
+ *
+ * @public
+ */
+export declare function useMainThreadRef<T>(initValue: T): MainThreadRef<T>;
+/**
+ * Create A `MainThreadRef`.
+ *
+ * A `MainThreadRef` is a ref that can only be accessed on the main thread. It is used to preserve
+ * states between main thread function calls.
+ * The data saved in `current` property of the `MainThreadRef` can be read and written in
+ * multiple main thread functions.
+ *
+ * It is a hook and it should only be called at the top level of your component.
+ *
+ * @param initValue - The init value of the `MainThreadRef`.
+ *
+ * @example
+ *
+ * ```ts
+ * import { useMainThreadRef } from '@lynx-js/react'
+ * import type { MainThread } from '@lynx-js/types'
+ *
+ * export function App() {
+ *   const ref = useMainThreadRef<MainThread.Element>(null)
+ *
+ *   const handleTap = () => {
+ *     'main thread'
+ *     ref.current?.setStyleProperty('background-color', 'blue')
+ *   }
+ *
+ *   return (
+ *     <view
+ *       main-thread:ref={ref}
+ *       main-thread:bindtap={handleTap}
+ *       style={{ width: '300px', height: '300px' }}
+ *     />
+ *   )
+ * }
+ * ```
+ *
+ * @public
+ */
+export declare function useMainThreadRef<T>(initValue: T | null): RefObject<T>;
+/**
+ * Create A `MainThreadRef`.
+ *
+ * A `MainThreadRef` is a ref that can only be accessed on the main thread. It is used to preserve
+ * states between main thread function calls.
+ * The data saved in `current` property of the `MainThreadRef` can be read and written in
+ * multiple main thread functions.
+ *
+ * It is a hook and it should only be called at the top level of your component.
+ *
+ * @example
+ *
+ * ```ts
+ * import { useMainThreadRef } from '@lynx-js/react'
+ * import type { MainThread } from '@lynx-js/types'
+ *
+ * export function App() {
+ *   const ref = useMainThreadRef<MainThread.Element>(null)
+ *
+ *   const handleTap = () => {
+ *     'main thread'
+ *     ref.current?.setStyleProperty('background-color', 'blue')
+ *   }
+ *
+ *   return (
+ *     <view
+ *       main-thread:ref={ref}
+ *       main-thread:bindtap={handleTap}
+ *       style={{ width: '300px', height: '300px' }}
+ *     />
+ *   )
+ * }
+ * ```
+ *
+ * @public
+ */
+export declare function useMainThreadRef<T = undefined>(): MainThreadRef<T | undefined>;
+export {};

package/runtime/lib/worklet/workletRef.js

@@ -0,0 +1,96 @@
+import { WorkletEvents } from '@lynx-js/react/worklet-runtime/bindings';
+import { lynxWorkletJsImpl } from './jsImpl.js';
+import { addWorkletRefInitValue } from './workletRefPool.js';
+import { useMemo } from '../hooks/react.js';
+class WorkletRef {
+    /**
+     * @internal
+     */
+    _id;
+    /**
+     * @internal
+     */
+    _initValue;
+    /**
+     * @internal
+     */
+    _type;
+    /**
+     * @internal
+     */
+    _lifecycleObserver;
+    /**
+     * @internal
+     */
+    constructor(initValue, type) {
+        if (__JS__) {
+            const impl = lynxWorkletJsImpl();
+            this._id = impl ? ++impl._workletRefLastId : 0;
+            this._initValue = initValue;
+            this._type = type;
+            addWorkletRefInitValue(this._id, initValue);
+        }
+        else {
+            // Out of the js thread, the `WorkletRef` class here is just a placeholder and should not be accessed directly.
+            // The real WorkletRef will be generated by the worklet runtime.
+            this._id = -1;
+            this._type = '__LEPUS__';
+        }
+    }
+    get current() {
+        if (__JS__ && __DEV__) {
+            throw new Error('MainThreadRef: value of a MainThreadRef cannot be accessed in the background thread.');
+        }
+        if (__LEPUS__ && __DEV__) {
+            /* v8 ignore next */
+            throw new Error('MainThreadRef: value of a MainThreadRef cannot be accessed outside of main thread script.');
+        }
+        /* v8 ignore next */
+        return undefined;
+    }
+    set current(_) {
+        if (__JS__ && __DEV__) {
+            throw new Error('MainThreadRef: value of a MainThreadRef cannot be accessed in the background thread.');
+        }
+        if (__LEPUS__ && __DEV__) {
+            throw new Error('MainThreadRef: value of a MainThreadRef cannot be accessed outside of main thread script.');
+        }
+    }
+    /**
+     * @internal
+     */
+    toJSON() {
+        return {
+            _wvid: this._id,
+        };
+    }
+}
+/**
+ * A `MainThreadRef` is a ref that can only be accessed on the main thread. It is used to preserve
+ * states between main thread function calls.
+ * The data saved in `current` property of the `MainThreadRef` can be read and written in
+ * multiple main thread functions.
+ * @public
+ */
+export class MainThreadRef extends WorkletRef {
+    constructor(initValue) {
+        super(initValue, 'main-thread');
+        if (__JS__) {
+            const id = this._id;
+            this._lifecycleObserver = lynx.getNativeApp().createJSObjectDestructionObserver(() => {
+                lynx.getCoreContext?.().dispatchEvent({
+                    type: WorkletEvents.releaseWorkletRef,
+                    data: {
+                        id,
+                    },
+                });
+            });
+        }
+    }
+}
+export function useMainThreadRef(initValue) {
+    return useMemo(() => {
+        return new MainThreadRef(initValue);
+    }, []);
+}
+//# sourceMappingURL=workletRef.js.map

package/runtime/lib/worklet/workletRef.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"workletRef.js","sourceRoot":"","sources":["../../src/worklet/workletRef.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,aAAa,EAAE,MAAM,yCAAyC,CAAC;AAExE,OAAO,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAChD,OAAO,EAAE,sBAAsB,EAAE,MAAM,qBAAqB,CAAC;AAC7D,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAE5C,MAAe,UAAU;IACvB;;OAEG;IACO,GAAG,CAAS;IACtB;;OAEG;IACO,UAAU,CAAgB;IACpC;;OAEG;IACO,KAAK,CAAS;IACxB;;OAEG;IACO,kBAAkB,CAAU;IAEtC;;OAEG;IACH,YAAsB,SAAY,EAAE,IAAY;QAC9C,IAAI,MAAM,EAAE,CAAC;YACX,MAAM,IAAI,GAAG,iBAAiB,EAAE,CAAC;YACjC,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAAC;YAC/C,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;YAC5B,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;YAClB,sBAAsB,CAAC,IAAI,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;QAC9C,CAAC;aAAM,CAAC;YACN,+GAA+G;YAC/G,gEAAgE;YAChE,IAAI,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC;YACd,IAAI,CAAC,KAAK,GAAG,WAAW,CAAC;QAC3B,CAAC;IACH,CAAC;IAED,IAAI,OAAO;QACT,IAAI,MAAM,IAAI,OAAO,EAAE,CAAC;YACtB,MAAM,IAAI,KAAK,CAAC,sFAAsF,CAAC,CAAC;QAC1G,CAAC;QACD,IAAI,SAAS,IAAI,OAAO,EAAE,CAAC;YACzB,oBAAoB;YACpB,MAAM,IAAI,KAAK,CAAC,2FAA2F,CAAC,CAAC;QAC/G,CAAC;QACD,oBAAoB;QACpB,OAAO,SAAc,CAAC;IACxB,CAAC;IAED,IAAI,OAAO,CAAC,CAAI;QACd,IAAI,MAAM,IAAI,OAAO,EAAE,CAAC;YACtB,MAAM,IAAI,KAAK,CAAC,sFAAsF,CAAC,CAAC;QAC1G,CAAC;QACD,IAAI,SAAS,IAAI,OAAO,EAAE,CAAC;YACzB,MAAM,IAAI,KAAK,CAAC,2FAA2F,CAAC,CAAC;QAC/G,CAAC;IACH,CAAC;IAED;;OAEG;IACH,MAAM;QACJ,OAAO;YACL,KAAK,EAAE,IAAI,CAAC,GAAG;SAChB,CAAC;IACJ,CAAC;CACF;AAED;;;;;;GAMG;AACH,MAAM,OAAO,aAAiB,SAAQ,UAAa;IACjD,YAAY,SAAY;QACtB,KAAK,CAAC,SAAS,EAAE,aAAa,CAAC,CAAC;QAChC,IAAI,MAAM,EAAE,CAAC;YACX,MAAM,EAAE,GAAG,IAAI,CAAC,GAAG,CAAC;YACpB,IAAI,CAAC,kBAAkB,GAAG,IAAI,CAAC,YAAY,EAAE,CAAC,iCAAiC,CAAC,GAAG,EAAE;gBACnF,IAAI,CAAC,cAAc,EAAE,EAAE,CAAC,aAAa,CAAC;oBACpC,IAAI,EAAE,aAAa,CAAC,iBAAiB;oBACrC,IAAI,EAAE;wBACJ,EAAE;qBACH;iBACF,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;QACL,CAAC;IACH,CAAC;CACF;AA2HD,MAAM,UAAU,gBAAgB,CAAI,SAAa;IAC/C,OAAO,OAAO,CAAC,GAAG,EAAE;QAClB,OAAO,IAAI,aAAa,CAAC,SAAS,CAAC,CAAC;IACtC,CAAC,EAAE,EAAE,CAAC,CAAC;AACT,CAAC"}

package/runtime/lib/worklet/workletRefPool.d.ts

@@ -0,0 +1,2 @@
+export declare function addWorkletRefInitValue(id: number, value: unknown): void;
+export declare function takeWorkletRefInitValuePatch(): [number, unknown][];

package/runtime/lib/worklet/workletRefPool.js

@@ -0,0 +1,22 @@
+// Copyright 2024 The Lynx Authors. All rights reserved.
+// Licensed under the Apache License Version 2.0 that can be found in the
+// LICENSE file in the root directory of this source tree.
+import { lynxWorkletJsImpl } from './jsImpl.js';
+export function addWorkletRefInitValue(id, value) {
+    const impl = lynxWorkletJsImpl();
+    if (!impl) {
+        return;
+    }
+    impl._workletRefInitValueSet.add(id);
+    impl._workletRefInitValuePatch.push([id, value]);
+}
+export function takeWorkletRefInitValuePatch() {
+    const impl = lynxWorkletJsImpl(false);
+    if (!impl) {
+        return [];
+    }
+    const res = impl._workletRefInitValuePatch;
+    impl._workletRefInitValuePatch = [];
+    return res;
+}
+//# sourceMappingURL=workletRefPool.js.map

package/runtime/lib/worklet/workletRefPool.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"workletRefPool.js","sourceRoot":"","sources":["../../src/worklet/workletRefPool.ts"],"names":[],"mappings":"AAAA,wDAAwD;AACxD,yEAAyE;AACzE,0DAA0D;AAC1D,OAAO,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAEhD,MAAM,UAAU,sBAAsB,CAAC,EAAU,EAAE,KAAc;IAC/D,MAAM,IAAI,GAAG,iBAAiB,EAAE,CAAC;IACjC,IAAI,CAAC,IAAI,EAAE,CAAC;QACV,OAAO;IACT,CAAC;IAED,IAAI,CAAC,uBAAuB,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IACrC,IAAI,CAAC,yBAAyB,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC,CAAC;AACnD,CAAC;AAED,MAAM,UAAU,4BAA4B;IAC1C,MAAM,IAAI,GAAG,iBAAiB,CAAC,KAAK,CAAC,CAAC;IACtC,IAAI,CAAC,IAAI,EAAE,CAAC;QACV,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,MAAM,GAAG,GAAG,IAAI,CAAC,yBAAyB,CAAC;IAC3C,IAAI,CAAC,yBAAyB,GAAG,EAAE,CAAC;IACpC,OAAO,GAAG,CAAC;AACb,CAAC"}