@excalidraw/excalidraw 0.18.0-d92384b77-3 → 0.18.0-f0063e113

package/dist/types/{excalidraw → common/src}/emitter.d.ts

@@ -1,16 +1,16 @@
-import type { UnsubscribeCallback } from "./types";
-type Subscriber<T extends any[]> = (...payload: T) => void;
-export declare class Emitter<T extends any[] = []> {
-    subscribers: Subscriber<T>[];
-    /**
-     * Attaches subscriber
-     *
-     * @returns unsubscribe function
-     */
-    on(...handlers: Subscriber<T>[] | Subscriber<T>[][]): UnsubscribeCallback;
-    once(...handlers: Subscriber<T>[] | Subscriber<T>[][]): UnsubscribeCallback;
-    off(...handlers: Subscriber<T>[] | Subscriber<T>[][]): void;
-    trigger(...payload: T): this;
-    clear(): void;
-}
-export {};
+import type { UnsubscribeCallback } from "@excalidraw/excalidraw/types";
+type Subscriber<T extends any[]> = (...payload: T) => void;
+export declare class Emitter<T extends any[] = []> {
+    subscribers: Subscriber<T>[];
+    /**
+     * Attaches subscriber
+     *
+     * @returns unsubscribe function
+     */
+    on(...handlers: Subscriber<T>[] | Subscriber<T>[][]): UnsubscribeCallback;
+    once(...handlers: Subscriber<T>[] | Subscriber<T>[][]): UnsubscribeCallback;
+    off(...handlers: Subscriber<T>[] | Subscriber<T>[][]): void;
+    trigger(...payload: T): this;
+    clear(): void;
+}
+export {};

package/dist/types/{excalidraw/fonts/FontMetadata.d.ts → common/src/font-metadata.d.ts}

@@ -1,38 +1,48 @@
-import type { JSX } from "react";
-/**
- * Encapsulates font metrics with additional font metadata.
- * */
-export interface FontMetadata {
-    /** for head & hhea metrics read the woff2 with https://fontdrop.info/ */
-    metrics: {
-        /** head.unitsPerEm metric */
-        unitsPerEm: 1000 | 1024 | 2048;
-        /** hhea.ascender metric */
-        ascender: number;
-        /** hhea.descender metric */
-        descender: number;
-        /** harcoded unitless line-height, https://github.com/excalidraw/excalidraw/pull/6360#issuecomment-1477635971 */
-        lineHeight: number;
-    };
-    /** element to be displayed as an icon  */
-    icon?: JSX.Element;
-    /** flag to indicate a deprecated font */
-    deprecated?: true;
-    /** flag to indicate a server-side only font */
-    serverSide?: true;
-    /** flag to indiccate a local-only font */
-    local?: true;
-    /** flag to indicate a fallback font */
-    fallback?: true;
-}
-export declare const FONT_METADATA: Record<number, FontMetadata>;
-/** Unicode ranges defined by google fonts */
-export declare const GOOGLE_FONTS_RANGES: {
-    LATIN: string;
-    LATIN_EXT: string;
-    CYRILIC_EXT: string;
-    CYRILIC: string;
-    VIETNAMESE: string;
-};
-/** local protocol to skip the local font from registering or inlining */
-export declare const LOCAL_FONT_PROTOCOL = "local:";
+import type { ExcalidrawTextElement, FontFamilyValues } from "@excalidraw/element/types";
+/**
+ * Encapsulates font metrics with additional font metadata.
+ * */
+export interface FontMetadata {
+    /** for head & hhea metrics read the woff2 with https://fontdrop.info/ */
+    metrics: {
+        /** head.unitsPerEm metric */
+        unitsPerEm: 1000 | 1024 | 2048;
+        /** hhea.ascender metric */
+        ascender: number;
+        /** hhea.descender metric */
+        descender: number;
+        /** harcoded unitless line-height, https://github.com/excalidraw/excalidraw/pull/6360#issuecomment-1477635971 */
+        lineHeight: number;
+    };
+    /** flag to indicate a deprecated font */
+    deprecated?: true;
+    /**
+     * whether this is a font that users can use (= shown in font picker)
+     */
+    private?: true;
+    /** flag to indiccate a local-only font */
+    local?: true;
+    /** flag to indicate a fallback font */
+    fallback?: true;
+}
+export declare const FONT_METADATA: Record<number, FontMetadata>;
+/** Unicode ranges defined by google fonts */
+export declare const GOOGLE_FONTS_RANGES: {
+    LATIN: string;
+    LATIN_EXT: string;
+    CYRILIC_EXT: string;
+    CYRILIC: string;
+    VIETNAMESE: string;
+};
+/** local protocol to skip the local font from registering or inlining */
+export declare const LOCAL_FONT_PROTOCOL = "local:";
+/**
+ * Calculates vertical offset for a text with alphabetic baseline.
+ */
+export declare const getVerticalOffset: (fontFamily: ExcalidrawTextElement["fontFamily"], fontSize: ExcalidrawTextElement["fontSize"], lineHeightPx: number) => number;
+/**
+ * Gets line height for a selected family.
+ */
+export declare const getLineHeight: (fontFamily: FontFamilyValues) => number & {
+    _brand: "unitlessLineHeight";
+};

package/dist/types/common/src/index.d.ts

@@ -0,0 +1,12 @@
+export * from "./binary-heap";
+export * from "./colors";
+export * from "./constants";
+export * from "./font-metadata";
+export * from "./queue";
+export * from "./keys";
+export * from "./points";
+export * from "./promise-pool";
+export * from "./random";
+export * from "./url";
+export * from "./utils";
+export * from "./emitter";

package/dist/types/{excalidraw → common/src}/keys.d.ts

@@ -1,189 +1,189 @@
-import type { ValueOf } from "./utility-types";
-export declare const CODES: {
-    readonly EQUAL: "Equal";
-    readonly MINUS: "Minus";
-    readonly NUM_ADD: "NumpadAdd";
-    readonly NUM_SUBTRACT: "NumpadSubtract";
-    readonly NUM_ZERO: "Numpad0";
-    readonly BRACKET_RIGHT: "BracketRight";
-    readonly BRACKET_LEFT: "BracketLeft";
-    readonly ONE: "Digit1";
-    readonly TWO: "Digit2";
-    readonly THREE: "Digit3";
-    readonly NINE: "Digit9";
-    readonly QUOTE: "Quote";
-    readonly ZERO: "Digit0";
-    readonly SLASH: "Slash";
-    readonly C: "KeyC";
-    readonly D: "KeyD";
-    readonly H: "KeyH";
-    readonly V: "KeyV";
-    readonly Z: "KeyZ";
-    readonly Y: "KeyY";
-    readonly R: "KeyR";
-    readonly S: "KeyS";
-};
-export declare const KEYS: {
-    readonly ARROW_DOWN: "ArrowDown";
-    readonly ARROW_LEFT: "ArrowLeft";
-    readonly ARROW_RIGHT: "ArrowRight";
-    readonly ARROW_UP: "ArrowUp";
-    readonly PAGE_UP: "PageUp";
-    readonly PAGE_DOWN: "PageDown";
-    readonly BACKSPACE: "Backspace";
-    readonly ALT: "Alt";
-    readonly CTRL_OR_CMD: "metaKey" | "ctrlKey";
-    readonly DELETE: "Delete";
-    readonly ENTER: "Enter";
-    readonly ESCAPE: "Escape";
-    readonly QUESTION_MARK: "?";
-    readonly SPACE: " ";
-    readonly TAB: "Tab";
-    readonly CHEVRON_LEFT: "<";
-    readonly CHEVRON_RIGHT: ">";
-    readonly PERIOD: ".";
-    readonly COMMA: ",";
-    readonly SUBTRACT: "-";
-    readonly SLASH: "/";
-    readonly A: "a";
-    readonly C: "c";
-    readonly D: "d";
-    readonly E: "e";
-    readonly F: "f";
-    readonly G: "g";
-    readonly H: "h";
-    readonly I: "i";
-    readonly L: "l";
-    readonly O: "o";
-    readonly P: "p";
-    readonly Q: "q";
-    readonly R: "r";
-    readonly S: "s";
-    readonly T: "t";
-    readonly V: "v";
-    readonly X: "x";
-    readonly Y: "y";
-    readonly Z: "z";
-    readonly K: "k";
-    readonly W: "w";
-    readonly 0: "0";
-    readonly 1: "1";
-    readonly 2: "2";
-    readonly 3: "3";
-    readonly 4: "4";
-    readonly 5: "5";
-    readonly 6: "6";
-    readonly 7: "7";
-    readonly 8: "8";
-    readonly 9: "9";
-};
-export type Key = keyof typeof KEYS;
-export declare const KeyCodeMap: Map<ValueOf<{
-    readonly ARROW_DOWN: "ArrowDown";
-    readonly ARROW_LEFT: "ArrowLeft";
-    readonly ARROW_RIGHT: "ArrowRight";
-    readonly ARROW_UP: "ArrowUp";
-    readonly PAGE_UP: "PageUp";
-    readonly PAGE_DOWN: "PageDown";
-    readonly BACKSPACE: "Backspace";
-    readonly ALT: "Alt";
-    readonly CTRL_OR_CMD: "metaKey" | "ctrlKey";
-    readonly DELETE: "Delete";
-    readonly ENTER: "Enter";
-    readonly ESCAPE: "Escape";
-    readonly QUESTION_MARK: "?";
-    readonly SPACE: " ";
-    readonly TAB: "Tab";
-    readonly CHEVRON_LEFT: "<";
-    readonly CHEVRON_RIGHT: ">";
-    readonly PERIOD: ".";
-    readonly COMMA: ",";
-    readonly SUBTRACT: "-";
-    readonly SLASH: "/";
-    readonly A: "a";
-    readonly C: "c";
-    readonly D: "d";
-    readonly E: "e";
-    readonly F: "f";
-    readonly G: "g";
-    readonly H: "h";
-    readonly I: "i";
-    readonly L: "l";
-    readonly O: "o";
-    readonly P: "p";
-    readonly Q: "q";
-    readonly R: "r";
-    readonly S: "s";
-    readonly T: "t";
-    readonly V: "v";
-    readonly X: "x";
-    readonly Y: "y";
-    readonly Z: "z";
-    readonly K: "k";
-    readonly W: "w";
-    readonly 0: "0";
-    readonly 1: "1";
-    readonly 2: "2";
-    readonly 3: "3";
-    readonly 4: "4";
-    readonly 5: "5";
-    readonly 6: "6";
-    readonly 7: "7";
-    readonly 8: "8";
-    readonly 9: "9";
-}>, ValueOf<{
-    readonly EQUAL: "Equal";
-    readonly MINUS: "Minus";
-    readonly NUM_ADD: "NumpadAdd";
-    readonly NUM_SUBTRACT: "NumpadSubtract";
-    readonly NUM_ZERO: "Numpad0";
-    readonly BRACKET_RIGHT: "BracketRight";
-    readonly BRACKET_LEFT: "BracketLeft";
-    readonly ONE: "Digit1";
-    readonly TWO: "Digit2";
-    readonly THREE: "Digit3";
-    readonly NINE: "Digit9";
-    readonly QUOTE: "Quote";
-    readonly ZERO: "Digit0";
-    readonly SLASH: "Slash";
-    readonly C: "KeyC";
-    readonly D: "KeyD";
-    readonly H: "KeyH";
-    readonly V: "KeyV";
-    readonly Z: "KeyZ";
-    readonly Y: "KeyY";
-    readonly R: "KeyR";
-    readonly S: "KeyS";
-}>>;
-export declare const isLatinChar: (key: string) => boolean;
-/**
- * Used to match key events for any keyboard layout, especially on Windows and Linux,
- * where non-latin character with modified (CMD) is not substituted with latin-based alternative.
- *
- * Uses `event.key` when it's latin, otherwise fallbacks to `event.code` (if mapping exists).
- *
- * Example of pressing "z" on different layouts, with the chosen key or code highlighted in []:
- *
- * Layout                | Code  | Key | Comment
- * --------------------- | ----- | --- | -------
- * U.S.                  |  KeyZ  | [z] |
- * Czech                 |  KeyY  | [z] |
- * Turkish               |  KeyN  | [z] |
- * French                |  KeyW  | [z] |
- * Macedonian            | [KeyZ] |  з  | z with cmd; з is Cyrillic equivalent of z
- * Russian               | [KeyZ] |  я  | z with cmd
- * Serbian               | [KeyZ] |  ѕ  | z with cmd
- * Greek                 | [KeyZ] |  ζ  | z with cmd; also ζ is Greek equivalent of z
- * Hebrew                | [KeyZ] |  ז  | z with cmd; also ז is Hebrew equivalent of z
- * Pinyin - Simplified   |  KeyZ  | [z] | due to IME
- * Cangije - Traditional | [KeyZ] |  重 | z with cmd
- * Japanese              | [KeyZ] |  つ | z with cmd
- * 2-Set Korean          | [KeyZ] |  ㅋ | z with cmd
- *
- * More details in https://github.com/excalidraw/excalidraw/pull/5944
- */
-export declare const matchKey: (event: KeyboardEvent | React.KeyboardEvent<Element>, key: ValueOf<typeof KEYS>) => boolean;
-export declare const isArrowKey: (key: string) => boolean;
-export declare const shouldResizeFromCenter: (event: MouseEvent | KeyboardEvent) => boolean;
-export declare const shouldMaintainAspectRatio: (event: MouseEvent | KeyboardEvent) => boolean;
-export declare const shouldRotateWithDiscreteAngle: (event: MouseEvent | KeyboardEvent | React.PointerEvent<HTMLCanvasElement>) => boolean;
+import type { ValueOf } from "./utility-types";
+export declare const CODES: {
+    readonly EQUAL: "Equal";
+    readonly MINUS: "Minus";
+    readonly NUM_ADD: "NumpadAdd";
+    readonly NUM_SUBTRACT: "NumpadSubtract";
+    readonly NUM_ZERO: "Numpad0";
+    readonly BRACKET_RIGHT: "BracketRight";
+    readonly BRACKET_LEFT: "BracketLeft";
+    readonly ONE: "Digit1";
+    readonly TWO: "Digit2";
+    readonly THREE: "Digit3";
+    readonly NINE: "Digit9";
+    readonly QUOTE: "Quote";
+    readonly ZERO: "Digit0";
+    readonly SLASH: "Slash";
+    readonly C: "KeyC";
+    readonly D: "KeyD";
+    readonly H: "KeyH";
+    readonly V: "KeyV";
+    readonly Z: "KeyZ";
+    readonly Y: "KeyY";
+    readonly R: "KeyR";
+    readonly S: "KeyS";
+};
+export declare const KEYS: {
+    readonly ARROW_DOWN: "ArrowDown";
+    readonly ARROW_LEFT: "ArrowLeft";
+    readonly ARROW_RIGHT: "ArrowRight";
+    readonly ARROW_UP: "ArrowUp";
+    readonly PAGE_UP: "PageUp";
+    readonly PAGE_DOWN: "PageDown";
+    readonly BACKSPACE: "Backspace";
+    readonly ALT: "Alt";
+    readonly CTRL_OR_CMD: "metaKey" | "ctrlKey";
+    readonly DELETE: "Delete";
+    readonly ENTER: "Enter";
+    readonly ESCAPE: "Escape";
+    readonly QUESTION_MARK: "?";
+    readonly SPACE: " ";
+    readonly TAB: "Tab";
+    readonly CHEVRON_LEFT: "<";
+    readonly CHEVRON_RIGHT: ">";
+    readonly PERIOD: ".";
+    readonly COMMA: ",";
+    readonly SUBTRACT: "-";
+    readonly SLASH: "/";
+    readonly A: "a";
+    readonly C: "c";
+    readonly D: "d";
+    readonly E: "e";
+    readonly F: "f";
+    readonly G: "g";
+    readonly H: "h";
+    readonly I: "i";
+    readonly L: "l";
+    readonly O: "o";
+    readonly P: "p";
+    readonly Q: "q";
+    readonly R: "r";
+    readonly S: "s";
+    readonly T: "t";
+    readonly V: "v";
+    readonly X: "x";
+    readonly Y: "y";
+    readonly Z: "z";
+    readonly K: "k";
+    readonly W: "w";
+    readonly 0: "0";
+    readonly 1: "1";
+    readonly 2: "2";
+    readonly 3: "3";
+    readonly 4: "4";
+    readonly 5: "5";
+    readonly 6: "6";
+    readonly 7: "7";
+    readonly 8: "8";
+    readonly 9: "9";
+};
+export type Key = keyof typeof KEYS;
+export declare const KeyCodeMap: Map<ValueOf<{
+    readonly ARROW_DOWN: "ArrowDown";
+    readonly ARROW_LEFT: "ArrowLeft";
+    readonly ARROW_RIGHT: "ArrowRight";
+    readonly ARROW_UP: "ArrowUp";
+    readonly PAGE_UP: "PageUp";
+    readonly PAGE_DOWN: "PageDown";
+    readonly BACKSPACE: "Backspace";
+    readonly ALT: "Alt";
+    readonly CTRL_OR_CMD: "metaKey" | "ctrlKey";
+    readonly DELETE: "Delete";
+    readonly ENTER: "Enter";
+    readonly ESCAPE: "Escape";
+    readonly QUESTION_MARK: "?";
+    readonly SPACE: " ";
+    readonly TAB: "Tab";
+    readonly CHEVRON_LEFT: "<";
+    readonly CHEVRON_RIGHT: ">";
+    readonly PERIOD: ".";
+    readonly COMMA: ",";
+    readonly SUBTRACT: "-";
+    readonly SLASH: "/";
+    readonly A: "a";
+    readonly C: "c";
+    readonly D: "d";
+    readonly E: "e";
+    readonly F: "f";
+    readonly G: "g";
+    readonly H: "h";
+    readonly I: "i";
+    readonly L: "l";
+    readonly O: "o";
+    readonly P: "p";
+    readonly Q: "q";
+    readonly R: "r";
+    readonly S: "s";
+    readonly T: "t";
+    readonly V: "v";
+    readonly X: "x";
+    readonly Y: "y";
+    readonly Z: "z";
+    readonly K: "k";
+    readonly W: "w";
+    readonly 0: "0";
+    readonly 1: "1";
+    readonly 2: "2";
+    readonly 3: "3";
+    readonly 4: "4";
+    readonly 5: "5";
+    readonly 6: "6";
+    readonly 7: "7";
+    readonly 8: "8";
+    readonly 9: "9";
+}>, ValueOf<{
+    readonly EQUAL: "Equal";
+    readonly MINUS: "Minus";
+    readonly NUM_ADD: "NumpadAdd";
+    readonly NUM_SUBTRACT: "NumpadSubtract";
+    readonly NUM_ZERO: "Numpad0";
+    readonly BRACKET_RIGHT: "BracketRight";
+    readonly BRACKET_LEFT: "BracketLeft";
+    readonly ONE: "Digit1";
+    readonly TWO: "Digit2";
+    readonly THREE: "Digit3";
+    readonly NINE: "Digit9";
+    readonly QUOTE: "Quote";
+    readonly ZERO: "Digit0";
+    readonly SLASH: "Slash";
+    readonly C: "KeyC";
+    readonly D: "KeyD";
+    readonly H: "KeyH";
+    readonly V: "KeyV";
+    readonly Z: "KeyZ";
+    readonly Y: "KeyY";
+    readonly R: "KeyR";
+    readonly S: "KeyS";
+}>>;
+export declare const isLatinChar: (key: string) => boolean;
+/**
+ * Used to match key events for any keyboard layout, especially on Windows and Linux,
+ * where non-latin character with modified (CMD) is not substituted with latin-based alternative.
+ *
+ * Uses `event.key` when it's latin, otherwise fallbacks to `event.code` (if mapping exists).
+ *
+ * Example of pressing "z" on different layouts, with the chosen key or code highlighted in []:
+ *
+ * Layout                | Code  | Key | Comment
+ * --------------------- | ----- | --- | -------
+ * U.S.                  |  KeyZ  | [z] |
+ * Czech                 |  KeyY  | [z] |
+ * Turkish               |  KeyN  | [z] |
+ * French                |  KeyW  | [z] |
+ * Macedonian            | [KeyZ] |  з  | z with cmd; з is Cyrillic equivalent of z
+ * Russian               | [KeyZ] |  я  | z with cmd
+ * Serbian               | [KeyZ] |  ѕ  | z with cmd
+ * Greek                 | [KeyZ] |  ζ  | z with cmd; also ζ is Greek equivalent of z
+ * Hebrew                | [KeyZ] |  ז  | z with cmd; also ז is Hebrew equivalent of z
+ * Pinyin - Simplified   |  KeyZ  | [z] | due to IME
+ * Cangije - Traditional | [KeyZ] |  重 | z with cmd
+ * Japanese              | [KeyZ] |  つ | z with cmd
+ * 2-Set Korean          | [KeyZ] |  ㅋ | z with cmd
+ *
+ * More details in https://github.com/excalidraw/excalidraw/pull/5944
+ */
+export declare const matchKey: (event: KeyboardEvent | React.KeyboardEvent<Element>, key: ValueOf<typeof KEYS>) => boolean;
+export declare const isArrowKey: (key: string) => boolean;
+export declare const shouldResizeFromCenter: (event: MouseEvent | KeyboardEvent) => boolean;
+export declare const shouldMaintainAspectRatio: (event: MouseEvent | KeyboardEvent) => boolean;
+export declare const shouldRotateWithDiscreteAngle: (event: MouseEvent | KeyboardEvent | React.PointerEvent<HTMLCanvasElement>) => boolean;

package/dist/types/{excalidraw → common/src}/points.d.ts

@@ -1,7 +1,9 @@
-import { type GlobalPoint, type LocalPoint } from "@excalidraw/math";
-export declare const getSizeFromPoints: (points: readonly (GlobalPoint | LocalPoint)[]) => {
-    width: number;
-    height: number;
-};
-/** @arg dimension, 0 for rescaling only x, 1 for y */
-export declare const rescalePoints: <Point extends GlobalPoint | LocalPoint>(dimension: 0 | 1, newSize: number, points: readonly Point[], normalize: boolean) => Point[];
+import { type GlobalPoint, type LocalPoint } from "@excalidraw/math";
+import type { NullableGridSize } from "@excalidraw/excalidraw/types";
+export declare const getSizeFromPoints: (points: readonly (GlobalPoint | LocalPoint)[]) => {
+    width: number;
+    height: number;
+};
+/** @arg dimension, 0 for rescaling only x, 1 for y */
+export declare const rescalePoints: <Point extends GlobalPoint | LocalPoint>(dimension: 0 | 1, newSize: number, points: readonly Point[], normalize: boolean) => Point[];
+export declare const getGridPoint: (x: number, y: number, gridSize: NullableGridSize) => [number, number];

package/dist/types/common/src/promise-pool.d.ts

@@ -0,0 +1,6 @@
+export declare class PromisePool<T> {
+    private readonly pool;
+    private readonly entries;
+    constructor(source: IterableIterator<Promise<void | readonly [number, T]>>, concurrency: number);
+    all(): PromiseLike<T[]>;
+}

package/dist/types/{excalidraw → common/src}/queue.d.ts

@@ -1,9 +1,9 @@
-import type { MaybePromise } from "./utility-types";
-type Job<T, TArgs extends unknown[]> = (...args: TArgs) => MaybePromise<T>;
-export declare class Queue {
-    private jobs;
-    private running;
-    private tick;
-    push<TValue, TArgs extends unknown[]>(jobFactory: Job<TValue, TArgs>, ...args: TArgs): Promise<TValue>;
-}
-export {};
+import type { MaybePromise } from "./utility-types";
+type Job<T, TArgs extends unknown[]> = (...args: TArgs) => MaybePromise<T>;
+export declare class Queue {
+    private jobs;
+    private running;
+    private tick;
+    push<TValue, TArgs extends unknown[]>(jobFactory: Job<TValue, TArgs>, ...args: TArgs): Promise<TValue>;
+}
+export {};

package/dist/types/{excalidraw → common/src}/random.d.ts

@@ -1,3 +1,3 @@
-export declare const randomInteger: () => number;
-export declare const reseed: (seed: number) => void;
-export declare const randomId: () => string;
+export declare const randomInteger: () => number;
+export declare const reseed: (seed: number) => void;
+export declare const randomId: () => string;

package/dist/types/{excalidraw/data → common/src}/url.d.ts

@@ -1,7 +1,7 @@
-export declare const normalizeLink: (link: string) => string;
-export declare const isLocalLink: (link: string | null) => boolean;
-/**
- * Returns URL sanitized and safe for usage in places such as
- * iframe's src attribute or <a> href attributes.
- */
-export declare const toValidURL: (link: string) => string;
+export declare const normalizeLink: (link: string) => string;
+export declare const isLocalLink: (link: string | null) => boolean;
+/**
+ * Returns URL sanitized and safe for usage in places such as
+ * iframe's src attribute or <a> href attributes.
+ */
+export declare const toValidURL: (link: string) => string;