@oomol-lab/open-flow 0.1.0-beta.75 → 0.1.0-beta.77

package/dist/common/runtime-nodejs-compat.d.ts

@@ -0,0 +1,44 @@
+import type { EngineContract } from './engine-contract.js';
+/**
+ * Guest modules of the Node compatibility engine, keyed by engine module path.
+ *
+ * A Host evaluates `engine/web.mjs` after installing the guest bridge, then `engine/globals.mjs`, then the Task.
+ * The bridge consists of `__hostPrimitive(request, buffer?, extra?)`, which forwards to {@link NodejsPrimitives.call};
+ * `__hostTimer(callback, delay, repeat)` and `__hostClearTimer(id)`, which schedule guest callbacks; and
+ * `__hostBuiltin(group)`, which synchronously evaluates {@link nodejsBuiltinGroupModule} and returns its namespace.
+ */
+export declare const nodejsGuestModules: Readonly<Record<string, string>>;
+export declare const nodejsWebModule = "engine/web.mjs";
+export declare const nodejsGlobalsModule = "engine/globals.mjs";
+/** Returns the engine module of a lazily loaded builtin group requested through `__hostBuiltin`. */
+export declare function nodejsBuiltinGroupModule(group: string): string;
+/** Resolves a builtin specifier or an import between engine modules; other specifiers belong to the Host closure. */
+export declare function resolveNodejsModule(contract: EngineContract, specifier: string, referrer: string): string | undefined;
+type Encoding = 'utf8' | 'utf-8' | 'hex' | 'base64' | 'ascii' | 'latin1' | 'binary' | 'ucs2' | 'ucs-2' | 'utf16le' | 'utf-16le';
+type ZlibMethod = 'gzipSync' | 'gunzipSync' | 'deflateSync' | 'inflateSync' | 'deflateRawSync' | 'inflateRawSync' | 'unzipSync';
+interface PlatformHash {
+    update(data: Uint8Array): unknown;
+    digest(): Uint8Array;
+    destroy(): unknown;
+}
+/** Platform implementations behind the primitives; Node.js and Workers with `nodejs_compat` supply their own modules. */
+export interface NodejsPrimitivePlatform {
+    readonly Buffer: {
+        from(text: string, encoding: Encoding): Uint8Array;
+        from(buffer: ArrayBuffer, offset: number, length: number): {
+            toString(encoding: Encoding): string;
+        };
+        byteLength(text: string, encoding: Encoding): number;
+    };
+    createHash(algorithm: string): PlatformHash;
+    createHmac(algorithm: string, key: Uint8Array): PlatformHash;
+    readonly zlib: Readonly<Record<ZlibMethod, (input: Uint8Array, options: object) => Uint8Array>>;
+}
+export interface NodejsPrimitives {
+    /** Serves one `__hostPrimitive` request; failures are returned as a serialized guest error. */
+    call(request: string, buffer?: ArrayBuffer, extra?: ArrayBuffer): string | ArrayBuffer;
+    close(): void;
+}
+/** Creates the per-Task primitive state behind the guest bridge, bounded by call count, bytes, and live instances. */
+export declare function createNodejsPrimitives(platform: NodejsPrimitivePlatform): NodejsPrimitives;
+export {};