@xiuchang-midscene/shared 2.0.2

package/dist/types/env/utils.d.ts

@@ -0,0 +1,38 @@
+import { GlobalConfigManager } from './global-config-manager';
+import { ModelConfigManager } from './model-config-manager';
+import { type GLOBAL_ENV_KEYS, type MODEL_ENV_KEYS } from './types';
+export declare const globalModelConfigManager: ModelConfigManager;
+export declare const globalConfigManager: GlobalConfigManager;
+/**
+ * Interface for devices that support getTimestamp method.
+ * This is a minimal interface to avoid circular dependencies with @xiuchang-midscene/core.
+ */
+export interface DeviceWithTimestamp {
+    getTimestamp?: () => Promise<number>;
+}
+/**
+ * Get the current timestamp, optionally from the target device.
+ *
+ * When useDeviceTimestamp is enabled and a device with getTimestamp is provided,
+ * this function will return the device's time. Otherwise, it returns the system time.
+ *
+ * This is useful when:
+ * - Testing on devices with different time zones
+ * - Debugging time-sensitive features
+ * - The system clock and device clock are not synchronized
+ *
+ * @param device Optional device interface that supports getTimestamp
+ * @param useDeviceTimestamp Whether to use device timestamp (from agent config)
+ * @returns Timestamp in milliseconds
+ *
+ * @example
+ * // Without device - always returns system time
+ * const systemTime = await getCurrentTime();
+ *
+ * @example
+ * // With device and config enabled - returns device time
+ * const deviceTime = await getCurrentTime(androidDevice, true);
+ */
+export declare function getCurrentTime(device?: DeviceWithTimestamp, useDeviceTimestamp?: boolean): Promise<number>;
+export declare const getPreferredLanguage: () => string;
+export declare const overrideAIConfig: (newConfig: Partial<Record<(typeof GLOBAL_ENV_KEYS)[number] | (typeof MODEL_ENV_KEYS)[number], string>>, extendMode?: boolean) => void;

package/dist/types/env/utils.d.ts.bak

@@ -0,0 +1,38 @@
+import { GlobalConfigManager } from './global-config-manager';
+import { ModelConfigManager } from './model-config-manager';
+import { type GLOBAL_ENV_KEYS, type MODEL_ENV_KEYS } from './types';
+export declare const globalModelConfigManager: ModelConfigManager;
+export declare const globalConfigManager: GlobalConfigManager;
+/**
+ * Interface for devices that support getTimestamp method.
+ * This is a minimal interface to avoid circular dependencies with @midscene/core.
+ */
+export interface DeviceWithTimestamp {
+    getTimestamp?: () => Promise<number>;
+}
+/**
+ * Get the current timestamp, optionally from the target device.
+ *
+ * When useDeviceTimestamp is enabled and a device with getTimestamp is provided,
+ * this function will return the device's time. Otherwise, it returns the system time.
+ *
+ * This is useful when:
+ * - Testing on devices with different time zones
+ * - Debugging time-sensitive features
+ * - The system clock and device clock are not synchronized
+ *
+ * @param device Optional device interface that supports getTimestamp
+ * @param useDeviceTimestamp Whether to use device timestamp (from agent config)
+ * @returns Timestamp in milliseconds
+ *
+ * @example
+ * // Without device - always returns system time
+ * const systemTime = await getCurrentTime();
+ *
+ * @example
+ * // With device and config enabled - returns device time
+ * const deviceTime = await getCurrentTime(androidDevice, true);
+ */
+export declare function getCurrentTime(device?: DeviceWithTimestamp, useDeviceTimestamp?: boolean): Promise<number>;
+export declare const getPreferredLanguage: () => string;
+export declare const overrideAIConfig: (newConfig: Partial<Record<(typeof GLOBAL_ENV_KEYS)[number] | (typeof MODEL_ENV_KEYS)[number], string>>, extendMode?: boolean) => void;

package/dist/types/extractor/constants.d.ts

@@ -0,0 +1 @@
+export { NodeType, TEXT_MAX_SIZE, TEXT_SIZE_THRESHOLD, } from '../constants/index';

package/dist/types/extractor/constants.d.ts.bak

@@ -0,0 +1 @@
+export { NodeType, TEXT_MAX_SIZE, TEXT_SIZE_THRESHOLD, } from '../constants/index';

package/dist/types/extractor/debug.d.ts

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

package/dist/types/extractor/debug.d.ts.bak

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

package/dist/types/extractor/dom-util.d.ts

@@ -0,0 +1,56 @@
+import type { LocateResultElement } from '../types';
+export declare function isFormElement(node: globalThis.Node): boolean;
+export declare function isButtonElement(node: globalThis.Node): node is globalThis.HTMLButtonElement;
+export declare function isAElement(node: globalThis.Node): node is globalThis.HTMLButtonElement;
+export declare function isSvgElement(node: globalThis.Node): node is globalThis.SVGSVGElement;
+export declare function isImgElement(node: globalThis.Node): node is globalThis.HTMLImageElement;
+export declare function isNotContainerElement(node: globalThis.Node): boolean;
+export declare function isTextElement(node: globalThis.Node): node is globalThis.HTMLTextAreaElement;
+export declare function isContainerElement(node: globalThis.Node): node is globalThis.HTMLElement;
+/**
+ * Generate a LocateResultElement from a point.
+ * This function creates an expanded rect around the given center point.
+ *
+ * Note: Center coordinates should be integers for pixel-aligned positioning.
+ * If decimal values are provided, they will be used as-is, which may result in
+ * non-pixel-aligned rect positions.
+ *
+ * The rect positioning behavior:
+ * - When edgeSize is even: center is at the top-left of the four center pixels
+ *   For example, with edgeSize=4 and center=[10, 10]:
+ *   □□□□
+ *   □■□□  (■ represents the center point at pixel 10)
+ *   □□□□
+ *   □□□□
+ *
+ * - When edgeSize is odd: center is at the exact middle pixel
+ *   For example, with edgeSize=5 and center=[10, 10]:
+ *   □□□□□
+ *   □□■□□  (■ represents the center point at pixel 10)
+ *   □□□□□
+ *
+ * @param center - Center point coordinates as [x, y] (should be integers)
+ * @param description - Description of the element
+ * @param edgeSize - Size to expand around the center point (default: 8)
+ * @returns A LocateResultElement with rect, center, and description
+ */
+export declare function generateElementByPoint(center: [number, number], description: string, edgeSize?: number): LocateResultElement;
+/**
+ * Generate a LocateResultElement from a rect.
+ * This function calculates the center point from the rect and expands the rect by edgeSize.
+ *
+ * Note: The rect uses inclusive coordinates where:
+ * - A rect from [left=10, top=10] with [width=1, height=1] covers exactly 1 pixel
+ * - The actual pixel range is [left, left+width) which means width pixels
+ *
+ * @param sourceRect - The source rect to generate element from (typically contains integer values)
+ * @param description - Description of the element
+ * @param edgeSize - Size to expand around the center point (default: 8)
+ * @returns A LocateResultElement with rect, center (always integers), and description
+ */
+export declare function generateElementByRect(sourceRect: {
+    left: number;
+    top: number;
+    width: number;
+    height: number;
+}, description: string, edgeSize?: number): LocateResultElement;

package/dist/types/extractor/dom-util.d.ts.bak

@@ -0,0 +1,56 @@
+import type { LocateResultElement } from '../types';
+export declare function isFormElement(node: globalThis.Node): boolean;
+export declare function isButtonElement(node: globalThis.Node): node is globalThis.HTMLButtonElement;
+export declare function isAElement(node: globalThis.Node): node is globalThis.HTMLButtonElement;
+export declare function isSvgElement(node: globalThis.Node): node is globalThis.SVGSVGElement;
+export declare function isImgElement(node: globalThis.Node): node is globalThis.HTMLImageElement;
+export declare function isNotContainerElement(node: globalThis.Node): boolean;
+export declare function isTextElement(node: globalThis.Node): node is globalThis.HTMLTextAreaElement;
+export declare function isContainerElement(node: globalThis.Node): node is globalThis.HTMLElement;
+/**
+ * Generate a LocateResultElement from a point.
+ * This function creates an expanded rect around the given center point.
+ *
+ * Note: Center coordinates should be integers for pixel-aligned positioning.
+ * If decimal values are provided, they will be used as-is, which may result in
+ * non-pixel-aligned rect positions.
+ *
+ * The rect positioning behavior:
+ * - When edgeSize is even: center is at the top-left of the four center pixels
+ *   For example, with edgeSize=4 and center=[10, 10]:
+ *   □□□□
+ *   □■□□  (■ represents the center point at pixel 10)
+ *   □□□□
+ *   □□□□
+ *
+ * - When edgeSize is odd: center is at the exact middle pixel
+ *   For example, with edgeSize=5 and center=[10, 10]:
+ *   □□□□□
+ *   □□■□□  (■ represents the center point at pixel 10)
+ *   □□□□□
+ *
+ * @param center - Center point coordinates as [x, y] (should be integers)
+ * @param description - Description of the element
+ * @param edgeSize - Size to expand around the center point (default: 8)
+ * @returns A LocateResultElement with rect, center, and description
+ */
+export declare function generateElementByPoint(center: [number, number], description: string, edgeSize?: number): LocateResultElement;
+/**
+ * Generate a LocateResultElement from a rect.
+ * This function calculates the center point from the rect and expands the rect by edgeSize.
+ *
+ * Note: The rect uses inclusive coordinates where:
+ * - A rect from [left=10, top=10] with [width=1, height=1] covers exactly 1 pixel
+ * - The actual pixel range is [left, left+width) which means width pixels
+ *
+ * @param sourceRect - The source rect to generate element from (typically contains integer values)
+ * @param description - Description of the element
+ * @param edgeSize - Size to expand around the center point (default: 8)
+ * @returns A LocateResultElement with rect, center (always integers), and description
+ */
+export declare function generateElementByRect(sourceRect: {
+    left: number;
+    top: number;
+    width: number;
+    height: number;
+}, description: string, edgeSize?: number): LocateResultElement;

package/dist/types/extractor/index.d.ts

@@ -0,0 +1,32 @@
+import type { NodeType } from '../constants/index';
+export interface ElementInfo {
+    id: string;
+    indexId: number;
+    nodeHashId: string;
+    xpaths?: string[];
+    attributes: {
+        nodeType: NodeType;
+        [key: string]: string;
+    };
+    nodeType: NodeType;
+    content: string;
+    rect: {
+        left: number;
+        top: number;
+        width: number;
+        height: number;
+    };
+    center: [number, number];
+    isVisible: boolean;
+}
+export interface ElementNode {
+    node: ElementInfo | null;
+    children: ElementNode[];
+}
+export { descriptionOfTree, traverseTree, treeToList, truncateText, trimAttributes, } from './tree';
+export { extractTextWithPosition as webExtractTextWithPosition } from './web-extractor';
+export { extractTreeNode as webExtractNodeTree } from './web-extractor';
+export { extractTreeNodeAsString as webExtractNodeTreeAsString } from './web-extractor';
+export { getXpathsByPoint, getXpathsById, getNodeInfoByXpath, getElementInfoByXpath, getElementXpath, } from './locator';
+export { generateElementByRect } from './dom-util';
+export { isNotContainerElement } from './dom-util';

package/dist/types/extractor/index.d.ts.bak

@@ -0,0 +1,32 @@
+import type { NodeType } from '../constants/index';
+export interface ElementInfo {
+    id: string;
+    indexId: number;
+    nodeHashId: string;
+    xpaths?: string[];
+    attributes: {
+        nodeType: NodeType;
+        [key: string]: string;
+    };
+    nodeType: NodeType;
+    content: string;
+    rect: {
+        left: number;
+        top: number;
+        width: number;
+        height: number;
+    };
+    center: [number, number];
+    isVisible: boolean;
+}
+export interface ElementNode {
+    node: ElementInfo | null;
+    children: ElementNode[];
+}
+export { descriptionOfTree, traverseTree, treeToList, truncateText, trimAttributes, } from './tree';
+export { extractTextWithPosition as webExtractTextWithPosition } from './web-extractor';
+export { extractTreeNode as webExtractNodeTree } from './web-extractor';
+export { extractTreeNodeAsString as webExtractNodeTreeAsString } from './web-extractor';
+export { getXpathsByPoint, getXpathsById, getNodeInfoByXpath, getElementInfoByXpath, getElementXpath, } from './locator';
+export { generateElementByRect } from './dom-util';
+export { isNotContainerElement } from './dom-util';

package/dist/types/extractor/locator.d.ts

@@ -0,0 +1,9 @@
+import type { ElementInfo } from '.';
+import type { Point } from '../types';
+export declare const getElementXpath: (element: Node, isOrderSensitive?: boolean, isLeafElement?: boolean, limitToCurrentDocument?: boolean) => string;
+/** Retrieve XPath for a previously cached node by its hash ID.
+ *  Returns a local xpath within the node's own document (limitToCurrentDocument=true). */
+export declare function getXpathsById(id: string): string[] | null;
+export declare function getXpathsByPoint(point: Point, isOrderSensitive: boolean): string[] | null;
+export declare function getNodeInfoByXpath(xpath: string): Node | null;
+export declare function getElementInfoByXpath(xpath: string): ElementInfo | null;

package/dist/types/extractor/locator.d.ts.bak

@@ -0,0 +1,9 @@
+import type { ElementInfo } from '.';
+import type { Point } from '../types';
+export declare const getElementXpath: (element: Node, isOrderSensitive?: boolean, isLeafElement?: boolean, limitToCurrentDocument?: boolean) => string;
+/** Retrieve XPath for a previously cached node by its hash ID.
+ *  Returns a local xpath within the node's own document (limitToCurrentDocument=true). */
+export declare function getXpathsById(id: string): string[] | null;
+export declare function getXpathsByPoint(point: Point, isOrderSensitive: boolean): string[] | null;
+export declare function getNodeInfoByXpath(xpath: string): Node | null;
+export declare function getElementInfoByXpath(xpath: string): ElementInfo | null;

package/dist/types/extractor/tree.d.ts

@@ -0,0 +1,6 @@
+import type { BaseElement, ElementTreeNode } from '../types';
+export declare function truncateText(text: string | number | object | undefined, maxLength?: number): string;
+export declare function trimAttributes(attributes: Record<string, any>, truncateTextLength?: number): Record<string, string>;
+export declare function descriptionOfTree<ElementType extends BaseElement = BaseElement>(tree: ElementTreeNode<ElementType>, truncateTextLength?: number, filterNonTextContent?: boolean, visibleOnly?: boolean): string;
+export declare function treeToList<T extends BaseElement>(tree: ElementTreeNode<T>): T[];
+export declare function traverseTree<T extends BaseElement, ReturnNodeType extends BaseElement>(tree: ElementTreeNode<T>, onNode: (node: T) => ReturnNodeType): ElementTreeNode<ReturnNodeType>;

package/dist/types/extractor/tree.d.ts.bak

@@ -0,0 +1,6 @@
+import type { BaseElement, ElementTreeNode } from '../types';
+export declare function truncateText(text: string | number | object | undefined, maxLength?: number): string;
+export declare function trimAttributes(attributes: Record<string, any>, truncateTextLength?: number): Record<string, string>;
+export declare function descriptionOfTree<ElementType extends BaseElement = BaseElement>(tree: ElementTreeNode<ElementType>, truncateTextLength?: number, filterNonTextContent?: boolean, visibleOnly?: boolean): string;
+export declare function treeToList<T extends BaseElement>(tree: ElementTreeNode<T>): T[];
+export declare function traverseTree<T extends BaseElement, ReturnNodeType extends BaseElement>(tree: ElementTreeNode<T>, onNode: (node: T) => ReturnNodeType): ElementTreeNode<ReturnNodeType>;

package/dist/types/extractor/util.d.ts

@@ -0,0 +1,47 @@
+import type { Rect } from '../types';
+export declare function setDebugMode(mode: boolean): void;
+export declare function getDebugMode(): boolean;
+export declare function logger(..._msg: any[]): void;
+export declare function isElementPartiallyInViewport(rect: ReturnType<typeof getRect>, currentWindow: typeof window, currentDocument: typeof document, visibleAreaRatio?: number): boolean;
+export declare function getPseudoElementContent(element: globalThis.Node, currentWindow: typeof globalThis.window): {
+    before: string;
+    after: string;
+};
+export declare function hasOverflowY(element: globalThis.HTMLElement, currentWindow: typeof globalThis.window): boolean;
+export interface ExtractedRect {
+    width: number;
+    height: number;
+    left: number;
+    top: number;
+    right: number;
+    bottom: number;
+    x: number;
+    y: number;
+    zoom: number;
+}
+export declare function overlappedRect(rect1: ExtractedRect, rect2: ExtractedRect): ExtractedRect | null;
+export declare function getRect(el: globalThis.HTMLElement | globalThis.Node, baseZoom: number, // base zoom
+currentWindow: typeof globalThis.window): ExtractedRect;
+export declare function elementRect(el: globalThis.HTMLElement | globalThis.Node | null, currentWindow: typeof globalThis.window, currentDocument: typeof globalThis.document, baseZoom?: number): {
+    left: number;
+    top: number;
+    width: number;
+    height: number;
+    zoom: number;
+    isVisible: boolean;
+} | false;
+export declare function validTextNodeContent(node: globalThis.Node): string | false;
+export declare function getNodeAttributes(node: globalThis.HTMLElement | globalThis.Node, currentWindow: typeof globalThis.window): Record<string, string>;
+/**
+ * Reset the node hash cache. Call at the beginning of each extraction cycle
+ * to prevent stale DOM references from accumulating.
+ */
+export declare function setNodeHashCacheListOnWindow(): void;
+export declare function setNodeToCacheList(node: globalThis.Node, id: string): void;
+export declare function getNodeFromCacheList(id: string): globalThis.Node | undefined;
+export declare function midsceneGenerateHash(node: globalThis.Node | null, content: string, rect: Rect): string;
+export declare function generateId(numberId: number): string;
+export declare function setGenerateHashOnWindow(): void;
+export declare function setMidsceneVisibleRectOnWindow(): void;
+export declare function setExtractTextWithPositionOnWindow(): void;
+export declare function getTopDocument(): globalThis.HTMLElement;

package/dist/types/extractor/util.d.ts.bak

@@ -0,0 +1,47 @@
+import type { Rect } from '../types';
+export declare function setDebugMode(mode: boolean): void;
+export declare function getDebugMode(): boolean;
+export declare function logger(..._msg: any[]): void;
+export declare function isElementPartiallyInViewport(rect: ReturnType<typeof getRect>, currentWindow: typeof window, currentDocument: typeof document, visibleAreaRatio?: number): boolean;
+export declare function getPseudoElementContent(element: globalThis.Node, currentWindow: typeof globalThis.window): {
+    before: string;
+    after: string;
+};
+export declare function hasOverflowY(element: globalThis.HTMLElement, currentWindow: typeof globalThis.window): boolean;
+export interface ExtractedRect {
+    width: number;
+    height: number;
+    left: number;
+    top: number;
+    right: number;
+    bottom: number;
+    x: number;
+    y: number;
+    zoom: number;
+}
+export declare function overlappedRect(rect1: ExtractedRect, rect2: ExtractedRect): ExtractedRect | null;
+export declare function getRect(el: globalThis.HTMLElement | globalThis.Node, baseZoom: number, // base zoom
+currentWindow: typeof globalThis.window): ExtractedRect;
+export declare function elementRect(el: globalThis.HTMLElement | globalThis.Node | null, currentWindow: typeof globalThis.window, currentDocument: typeof globalThis.document, baseZoom?: number): {
+    left: number;
+    top: number;
+    width: number;
+    height: number;
+    zoom: number;
+    isVisible: boolean;
+} | false;
+export declare function validTextNodeContent(node: globalThis.Node): string | false;
+export declare function getNodeAttributes(node: globalThis.HTMLElement | globalThis.Node, currentWindow: typeof globalThis.window): Record<string, string>;
+/**
+ * Reset the node hash cache. Call at the beginning of each extraction cycle
+ * to prevent stale DOM references from accumulating.
+ */
+export declare function setNodeHashCacheListOnWindow(): void;
+export declare function setNodeToCacheList(node: globalThis.Node, id: string): void;
+export declare function getNodeFromCacheList(id: string): globalThis.Node | undefined;
+export declare function midsceneGenerateHash(node: globalThis.Node | null, content: string, rect: Rect): string;
+export declare function generateId(numberId: number): string;
+export declare function setGenerateHashOnWindow(): void;
+export declare function setMidsceneVisibleRectOnWindow(): void;
+export declare function setExtractTextWithPositionOnWindow(): void;
+export declare function getTopDocument(): globalThis.HTMLElement;

package/dist/types/extractor/web-extractor.d.ts

@@ -0,0 +1,19 @@
+import type { WebElementInfo } from '../types';
+import type { Point } from '../types';
+export declare function collectElementInfo(node: Node, currentWindow: typeof window, currentDocument: typeof document, baseZoom?: number, basePoint?: Point, isContainer?: boolean): WebElementInfo | null | any;
+interface WebElementNode {
+    node: WebElementInfo | null;
+    children: WebElementNode[];
+}
+export declare function extractTextWithPosition(initNode: globalThis.Node, debugMode?: boolean): WebElementInfo[];
+export declare function extractTreeNodeAsString(initNode: globalThis.Node, visibleOnly?: boolean, debugMode?: boolean): string;
+export declare function extractTreeNode(initNode: globalThis.Node, debugMode?: boolean): WebElementNode;
+export declare function mergeElementAndChildrenRects(node: Node, currentWindow: typeof window, currentDocument: typeof document, baseZoom?: number): {
+    left: number;
+    top: number;
+    width: number;
+    height: number;
+    zoom: number;
+    isVisible: boolean;
+} | null;
+export {};

package/dist/types/extractor/web-extractor.d.ts.bak

@@ -0,0 +1,19 @@
+import type { WebElementInfo } from '../types';
+import type { Point } from '../types';
+export declare function collectElementInfo(node: Node, currentWindow: typeof window, currentDocument: typeof document, baseZoom?: number, basePoint?: Point, isContainer?: boolean): WebElementInfo | null | any;
+interface WebElementNode {
+    node: WebElementInfo | null;
+    children: WebElementNode[];
+}
+export declare function extractTextWithPosition(initNode: globalThis.Node, debugMode?: boolean): WebElementInfo[];
+export declare function extractTreeNodeAsString(initNode: globalThis.Node, visibleOnly?: boolean, debugMode?: boolean): string;
+export declare function extractTreeNode(initNode: globalThis.Node, debugMode?: boolean): WebElementNode;
+export declare function mergeElementAndChildrenRects(node: Node, currentWindow: typeof window, currentDocument: typeof document, baseZoom?: number): {
+    left: number;
+    top: number;
+    width: number;
+    height: number;
+    zoom: number;
+    isVisible: boolean;
+} | null;
+export {};

package/dist/types/img/box-select.d.ts

@@ -0,0 +1,26 @@
+import type { BaseElement, Rect } from '../types';
+interface ElementForOverlay {
+    rect: Rect;
+    indexId?: number;
+}
+export declare const compositeElementInfoImg: (options: {
+    inputImgBase64: string;
+    elementsPositionInfo: Array<ElementForOverlay>;
+    size?: {
+        width: number;
+        height: number;
+    };
+    annotationPadding?: number;
+    borderThickness?: number;
+    prompt?: string;
+}) => Promise<string>;
+export declare const processImageElementInfo: (options: {
+    inputImgBase64: string;
+    elementsPositionInfo: Array<BaseElement>;
+    elementsPositionInfoWithoutText: Array<BaseElement>;
+}) => Promise<{
+    compositeElementInfoImgBase64: string;
+    compositeElementInfoImgWithoutTextBase64: string;
+}>;
+export declare function annotateRects(imgBase64: string, rects: Rect[], prompt?: string): Promise<string>;
+export {};

package/dist/types/img/box-select.d.ts.bak

@@ -0,0 +1,26 @@
+import type { BaseElement, Rect } from '../types';
+interface ElementForOverlay {
+    rect: Rect;
+    indexId?: number;
+}
+export declare const compositeElementInfoImg: (options: {
+    inputImgBase64: string;
+    elementsPositionInfo: Array<ElementForOverlay>;
+    size?: {
+        width: number;
+        height: number;
+    };
+    annotationPadding?: number;
+    borderThickness?: number;
+    prompt?: string;
+}) => Promise<string>;
+export declare const processImageElementInfo: (options: {
+    inputImgBase64: string;
+    elementsPositionInfo: Array<BaseElement>;
+    elementsPositionInfoWithoutText: Array<BaseElement>;
+}) => Promise<{
+    compositeElementInfoImgBase64: string;
+    compositeElementInfoImgWithoutTextBase64: string;
+}>;
+export declare function annotateRects(imgBase64: string, rects: Rect[], prompt?: string): Promise<string>;
+export {};

package/dist/types/img/canvas-fallback.d.ts

@@ -0,0 +1,105 @@
+/**
+ * Canvas-based fallback for image processing when Photon WASM fails to load.
+ * Provides a compatible API with Photon for browser environments.
+ */
+/**
+ * Canvas-based image class that mimics PhotonImage API
+ */
+export declare class CanvasImage {
+    private canvas;
+    private ctx;
+    private _width;
+    private _height;
+    constructor(canvas: HTMLCanvasElement);
+    get_width(): number;
+    get_height(): number;
+    get_raw_pixels(): Uint8Array;
+    get_bytes_jpeg(quality: number): Uint8Array;
+    free(): void;
+    _getCanvas(): HTMLCanvasElement;
+    _getContext(): CanvasRenderingContext2D;
+    /**
+     * Create a CanvasImage from a base64 string
+     */
+    static new_from_base64(base64Body: string): Promise<CanvasImage>;
+    /**
+     * Create a CanvasImage from a byte array (async version)
+     */
+    static new_from_byteslice(bytes: Uint8Array): Promise<CanvasImage>;
+}
+/**
+ * Sampling filter enum (compatible with Photon)
+ */
+export declare const CanvasSamplingFilter: {
+    readonly Nearest: "nearest";
+    readonly Triangle: "triangle";
+    readonly CatmullRom: "catmullrom";
+    readonly Gaussian: "gaussian";
+    readonly Lanczos3: "lanczos3";
+};
+/**
+ * RGBA color class (compatible with Photon)
+ */
+export declare class CanvasRgba {
+    r: number;
+    g: number;
+    b: number;
+    a: number;
+    constructor(r: number, g: number, b: number, a: number);
+}
+/**
+ * Resize an image
+ */
+export declare function canvasResize(image: CanvasImage, newWidth: number, newHeight: number, _filter: string): CanvasImage;
+/**
+ * Crop an image
+ */
+export declare function canvasCrop(image: CanvasImage, x1: number, y1: number, x2: number, y2: number): CanvasImage;
+/**
+ * Add padding to the right of an image
+ */
+export declare function canvasPaddingRight(image: CanvasImage, padding: number, color: CanvasRgba): CanvasImage;
+/**
+ * Add padding to the bottom of an image
+ */
+export declare function canvasPaddingBottom(image: CanvasImage, padding: number, color: CanvasRgba): CanvasImage;
+/**
+ * Add uniform padding to an image
+ */
+export declare function canvasPaddingUniform(image: CanvasImage, padding: number, color: CanvasRgba): CanvasImage;
+/**
+ * Add padding to the left of an image
+ */
+export declare function canvasPaddingLeft(image: CanvasImage, padding: number, color: CanvasRgba): CanvasImage;
+/**
+ * Add padding to the top of an image
+ */
+export declare function canvasPaddingTop(image: CanvasImage, padding: number, color: CanvasRgba): CanvasImage;
+/**
+ * Watermark an image (overlay one image on another)
+ */
+export declare function canvasWatermark(base: CanvasImage, overlay: CanvasImage, x: number, y: number): CanvasImage;
+/**
+ * Create and return the canvas fallback module with Photon-compatible API
+ */
+export declare function createCanvasFallbackModule(): {
+    PhotonImage: typeof CanvasImage;
+    SamplingFilter: {
+        readonly Nearest: "nearest";
+        readonly Triangle: "triangle";
+        readonly CatmullRom: "catmullrom";
+        readonly Gaussian: "gaussian";
+        readonly Lanczos3: "lanczos3";
+    };
+    resize: typeof canvasResize;
+    crop: typeof canvasCrop;
+    open_image: () => never;
+    base64_to_image: typeof CanvasImage.new_from_base64;
+    padding_uniform: typeof canvasPaddingUniform;
+    padding_left: typeof canvasPaddingLeft;
+    padding_right: typeof canvasPaddingRight;
+    padding_top: typeof canvasPaddingTop;
+    padding_bottom: typeof canvasPaddingBottom;
+    watermark: typeof canvasWatermark;
+    Rgba: typeof CanvasRgba;
+};