@pi-oxide/extension-js 0.2.0 → 0.2.1

package/content-script.d.ts

@@ -0,0 +1,44 @@
+declare const __LOG_LEVELS: {
+    readonly debug: 0;
+    readonly info: 1;
+    readonly warn: 2;
+    readonly error: 3;
+    readonly none: 4;
+};
+declare let __logLevel: number;
+declare function __formatMeta(meta: Record<string, unknown> | undefined): string;
+declare function __log(level: number, event: string, meta?: Record<string, unknown>): void;
+declare const logger: {
+    debug: (event: string, meta?: Record<string, unknown>) => void;
+    info: (event: string, meta?: Record<string, unknown>) => void;
+    warn: (event: string, meta?: Record<string, unknown>) => void;
+    error: (event: string, meta?: Record<string, unknown>) => void;
+};
+declare function getElementByRefId(refId: string | number): Element | null;
+declare function findElementByLabel(query: string): Element | null;
+declare function findCandidateLabels(query: string): string[];
+declare function asRecord(obj: unknown): Record<string, unknown>;
+declare function getStringParam(params: unknown, key: string): string;
+declare function getNumberParam(params: unknown, key: string, fallback: number): number;
+declare function getAccessibleRole(el: Element): string;
+declare function getAccessibleName(el: Element): string;
+declare function shouldInclude(el: Element): boolean;
+interface SnapshotNode {
+    refId: number;
+    role: string;
+    tag: string;
+    name?: string;
+}
+interface SnapshotResult {
+    text: string;
+    nodes: SnapshotNode[];
+    url: string;
+    title: string;
+    viewport: {
+        width: number;
+        height: number;
+    };
+}
+declare function inlineSnapshot(maxNodes: number): SnapshotResult;
+type Handler<T = unknown, R = unknown> = (params: T) => R | Promise<R>;
+declare const handlers: Record<string, Handler>;

package/extension_js_bg.wasm.d.ts

@@ -0,0 +1,55 @@
+/* tslint:disable */
+/* eslint-disable */
+export const memory: WebAssembly.Memory;
+export const __wbg_extensionsession_free: (a: number, b: number) => void;
+export const extensionsession_inspect_globals: (a: number) => any;
+export const extensionsession_load_library: (
+	a: number,
+	b: number,
+	c: number,
+) => any;
+export const extensionsession_new: () => number;
+export const extensionsession_reset: (a: number) => void;
+export const extensionsession_runCellAsync: (
+	a: number,
+	b: number,
+	c: number,
+	d: number,
+	e: number,
+) => any;
+export const extensionsession_set_fuel_limit: (a: number, b: number) => void;
+export const extensionsession_stopWith: (a: number) => void;
+export const setLogLevel: (a: number) => void;
+export const generateApiDocs: (a: number, b: number) => [number, number];
+export const collect_document: (a: any) => any;
+export const collect_element: (a: any, b: any) => any;
+export const format_snapshot_js: (a: any, b: number) => [number, number];
+export const wasm_bindgen__convert__closures_____invoke__hbaf3bd60d2f803db: (
+	a: number,
+	b: number,
+	c: any,
+) => [number, number];
+export const wasm_bindgen__convert__closures_____invoke__hf458ead16698aa30: (
+	a: number,
+	b: number,
+	c: any,
+	d: any,
+) => void;
+export const wasm_bindgen__convert__closures_____invoke__hd488ef5680429ef6: (
+	a: number,
+	b: number,
+) => number;
+export const __wbindgen_malloc: (a: number, b: number) => number;
+export const __wbindgen_realloc: (
+	a: number,
+	b: number,
+	c: number,
+	d: number,
+) => number;
+export const __wbindgen_exn_store: (a: number) => void;
+export const __externref_table_alloc: () => number;
+export const __wbindgen_externrefs: WebAssembly.Table;
+export const __wbindgen_destroy_closure: (a: number, b: number) => void;
+export const __wbindgen_free: (a: number, b: number, c: number) => void;
+export const __externref_table_dealloc: (a: number) => void;
+export const __wbindgen_start: () => void;

package/generated.d.ts

@@ -0,0 +1,208 @@
+import { TreeSnapshot } from '@pi-oxide/dom-semantic-tree';
+
+export type CommandParams = FetchParams | SleepParams | PageClickParams | PageDblClickParams | PageFillParams | PageTypeParams | PagePressParams | PageSelectParams | PageCheckParams | PageHoverParams | PageScrollParams | PageScrollToParams | PageGotoParams | PageFindParams | PageWaitForParams | PageExtractParams | PageAppendParams | PageWaitParams | StorageGetParams | StorageSetParams | StorageDeleteParams | DomSnapshotParams | DomFormatParams | TabClickParams | TabFillParams | TabEvaluateParams | TabBackParams | TabWaitForLoadParams | TabScrollToParams | TabTypeParams | TabPressParams | TabSelectParams | TabCheckParams | TabHoverParams | TabUnhoverParams | TabScrollParams | TabDblClickParams | FsWriteParams | FsPathParams | FsCopyParams | FsUpdateParams | FsHashParams | FsReadRangeParams;
+export type AsyncCommand = {
+    call_id: number;
+    action: string;
+    params: CommandParams;
+};
+export type CellError = {
+    kind: "compile";
+    message: string;
+    line: number | null;
+} | {
+    kind: "runtime";
+    message: string;
+    line: number | null;
+} | {
+    kind: "fuel_exhausted";
+} | {
+    kind: "internal";
+    message: string;
+};
+export type CellStatus = "done" | "async_pending";
+export type DomSnapshotParams = {
+    interactive_only: boolean;
+    max_nodes: bigint;
+};
+export type DomFormatParams = {
+    snapshot: TreeSnapshot;
+    format?: string;
+};
+export type FetchParams = {
+    url: string;
+    method: string;
+    headers: Record<string, string>;
+    body: string | null;
+    timeout: bigint;
+};
+export type FsCopyParams = {
+    from: string;
+    to: string;
+};
+export type FsHashParams = {
+    path: string;
+    algo: string;
+};
+export type FsPathParams = {
+    path: string;
+};
+export type FsReadRangeParams = {
+    path: string;
+    offset: bigint;
+    len: number;
+};
+export type FsUpdateParams = {
+    path: string;
+    offset: bigint;
+    data: string;
+};
+export type FsWriteParams = {
+    path: string;
+    data: string;
+};
+export type PageAppendParams = {
+    refId: string;
+    label: string;
+    text: string;
+};
+export type PageCheckParams = {
+    refId: string;
+    checked: boolean;
+};
+export type PageClickParams = {
+    refId: string;
+    label: string;
+};
+export type PageDblClickParams = {
+    refId: string;
+    label: string;
+};
+export type PageExtractParams = {
+    fields: string[];
+};
+export type PageFillParams = {
+    refId: string;
+    label: string;
+    value: string;
+};
+export type PageFindParams = {
+    selector: string;
+};
+export type PageGotoParams = {
+    url: string;
+};
+export type PageHoverParams = {
+    refId: string;
+};
+export type PagePressParams = {
+    key: string;
+};
+export type PageScrollParams = {
+    direction: string;
+    amount: number;
+};
+export type PageScrollToParams = {
+    refId: string;
+};
+export type PageSelectParams = {
+    refId: string;
+    value: string;
+};
+export type PageTypeParams = {
+    refId: string;
+    label: string;
+    text: string;
+};
+export type PageWaitForParams = {
+    selector: string;
+    timeout: bigint;
+};
+export type PageWaitParams = {
+    duration: bigint;
+};
+export type RunResult = {
+    stdout: string[];
+    stderr: string[];
+    result: string | null;
+    error: CellError | null;
+    commands: CommandParams[];
+    fuel_exhausted: boolean;
+    execution_count: number;
+    status: CellStatus;
+    pending_commands: AsyncCommand[];
+};
+export type SleepParams = {
+    duration: bigint;
+};
+export type StorageDeleteParams = {
+    key: string;
+};
+export type StorageGetParams = {
+    key: string;
+};
+export type StorageSetParams = {
+    key: string;
+    value: string;
+};
+export type TabBackParams = {
+    tabId: bigint;
+};
+export type TabCheckParams = {
+    tabId: bigint;
+    refId: string;
+    checked: boolean;
+};
+export type TabClickParams = {
+    tabId: bigint;
+    refId: string;
+};
+export type TabDblClickParams = {
+    tabId: bigint;
+    refId: string;
+};
+export type TabEvaluateParams = {
+    tabId: bigint;
+    script: string;
+};
+export type TabFillParams = {
+    tabId: bigint;
+    refId: string;
+    value: string;
+};
+export type TabHoverParams = {
+    tabId: bigint;
+    refId: string;
+};
+export type TabPressParams = {
+    tabId: bigint;
+    key: string;
+};
+export type TabScrollParams = {
+    tabId: bigint;
+    direction: string;
+    amount: number;
+};
+export type TabScrollToParams = {
+    tabId: bigint;
+    x: number;
+    y: number;
+    refId: string | null;
+};
+export type TabSelectParams = {
+    tabId: bigint;
+    refId: string;
+    value: string;
+};
+export type TabTypeParams = {
+    tabId: bigint;
+    refId: string;
+    text: string;
+};
+export type TabUnhoverParams = {
+    tabId: bigint;
+};
+export type TabWaitForLoadParams = {
+    tabId: bigint;
+    timeout: bigint;
+};

package/index.d.ts

@@ -0,0 +1,92 @@
+import { CellResult, FsCopyParams, FsHashParams, FsPathParams, FsReadRangeDataParams, FsReadRangeParams, FsWriteParams, WasmGlobalsSnapshot } from './extension_js.js';
+import { registerHostHandler, registerHostHandlers } from './runner.js';
+
+export { generateApiDocs } from './extension_js.js';
+export type { LogLevel } from './logger.js';
+export { setLogLevel } from './logger.js';
+export type { CellResult as JsRunResult, WasmGlobalsSnapshot as JsGlobalsSnapshot, };
+export { registerHostHandler, registerHostHandlers };
+export interface JsApiDoc {
+    namespace: string;
+    name: string;
+    action: string | null;
+    description: string;
+    params: {
+        name: string;
+        js_type: string;
+        required: boolean;
+        description: string;
+    }[];
+    returns: {
+        js_type: string;
+        description: string;
+    };
+    source: string;
+}
+/**
+ * ExtensionSession proxy that lives on the main thread.
+ * The actual WASM ExtensionSession runs inside a Web Worker;
+ * this proxy forwards calls via postMessage and awaits responses.
+ */
+export declare class ExtensionSession {
+    private worker;
+    private pendingCalls;
+    private disposed;
+    private onCleanupComplete;
+    private abortController;
+    private constructor();
+    /**
+     * Initialize the extension-js runtime.
+     * Automatically detects extension context, spawns the Worker,
+     * starts the main-thread runner loop, and returns [session, runner].
+     *
+     * The spawned Worker uses `new Worker(..., { type: "module" })`. Your bundler
+     * must support emitting module Workers as separate chunks.
+     *
+     * AbortController is module-global: only one active session per extension
+     * page is fully safe. Concurrent sessions race on the same abort signal.
+     */
+    static init(): Promise<[ExtensionSession, Promise<void>]>;
+    private startWorker;
+    private handleWorkerMessage;
+    private postAndWait;
+    runCellAsync(code: string, stdin?: string): Promise<CellResult>;
+    reset(): Promise<void>;
+    inspectGlobals(): Promise<WasmGlobalsSnapshot>;
+    setFuelLimit(limit: number): void;
+    loadLibrary(source: string): Promise<CellResult>;
+    private safePost;
+    get fs(): {
+        exists: (params: FsPathParams) => Promise<import('./extension_js.js').FsExistsResult>;
+        stat: (params: FsPathParams) => Promise<import('./extension_js.js').FsStatResult>;
+        read: (params: FsPathParams) => Promise<import('./extension_js.js').FsStringResult>;
+        readText: (params: FsPathParams) => Promise<import('./extension_js.js').FsStringResult>;
+        readBase64: (params: FsPathParams) => Promise<import('./extension_js.js').FsStringResult>;
+        list: (params: FsPathParams) => Promise<import('./extension_js.js').FsListResult>;
+        mkdir: (params: FsPathParams) => Promise<import('./extension_js.js').FsBoolResult>;
+        delete: (params: FsPathParams) => Promise<import('./extension_js.js').FsBoolResult>;
+        copy: (params: FsCopyParams) => Promise<import('./extension_js.js').FsBoolResult>;
+        move: (params: FsCopyParams) => Promise<import('./extension_js.js').FsBoolResult>;
+        write: (params: FsWriteParams) => Promise<import('./extension_js.js').FsBoolResult>;
+        writeText: (params: FsWriteParams) => Promise<import('./extension_js.js').FsBoolResult>;
+        writeBase64: (params: FsWriteParams) => Promise<import('./extension_js.js').FsBoolResult>;
+        append: (params: FsWriteParams) => Promise<import('./extension_js.js').FsBoolResult>;
+        appendText: (params: FsWriteParams) => Promise<import('./extension_js.js').FsBoolResult>;
+        appendBase64: (params: FsWriteParams) => Promise<import('./extension_js.js').FsBoolResult>;
+        readRange: (params: FsReadRangeParams) => Promise<import('./extension_js.js').FsStringResult>;
+        update: (params: FsReadRangeDataParams) => Promise<import('./extension_js.js').FsBoolResult>;
+        hash: (params: FsHashParams) => Promise<import('./extension_js.js').FsHashResult>;
+    };
+    /**
+     * Clean up the session, terminate the Worker, and release resources.
+     * Accepts the runner Promise returned by init() so it can be awaited
+     * for graceful shutdown.
+     *
+     * Sends a reset message to the Worker, then waits only 50 ms before
+     * forcefully calling worker.terminate(). If WASM cleanup takes longer,
+     * the Worker is killed mid-operation. Pending async calls are rejected
+     * with "ExtensionSession stopped".
+     */
+    stopWith(runner: Promise<void>): Promise<void>;
+    private generateId;
+}