@tma.js/sdk 0.13.3 → 1.0.0

package/dist/dts/bridge/methods/methods.d.ts

@@ -0,0 +1,329 @@
+import type { RGB } from '../../colors/index.js';
+import type { IsNever, Not, RequestId, UnionKeys } from '../../types/index.js';
+import type { AnyHapticFeedbackParams } from './haptic.js';
+import type { AnyInvokeCustomMethodParams } from './invoke-custom-method.js';
+import type { PopupParams } from './popup.js';
+/**
+ * Color key which could be used to update header color.
+ */
+export type HeaderColorKey = 'bg_color' | 'secondary_bg_color';
+/**
+ * Chat type which could be used when calling `web_app_switch_inline_query` method.
+ */
+export type SwitchInlineQueryChatType = 'users' | 'bots' | 'groups' | 'channels';
+interface CreateParams<Params = undefined, VersionedParam extends UnionKeys<Params> = never> {
+    params: Params;
+    versionedParams: VersionedParam;
+}
+/**
+ * Describes list of events and their parameters that could be posted by Bridge.
+ * @see https://docs.telegram-mini-apps.com/platform/apps-communication/methods
+ */
+export interface MiniAppsMethods {
+    /**
+     * Notifies parent iframe about the current frame is ready. This method is only used in the Web
+     * version of Telegram. As a result, Mini App will receive `set_custom_style` event.
+     * @see https://docs.telegram-mini-apps.com/platform/apps-communication/methods#iframe-ready
+     */
+    iframe_ready: CreateParams<{
+        /**
+         * True, if current Mini App supports native reloading.
+         */
+        reload_supported?: boolean;
+    } | undefined>;
+    /**
+     * Notifies parent iframe about the current iframe is going to reload.
+     * @see https://docs.telegram-mini-apps.com/platform/apps-communication/methods#iframe-will-reload
+     */
+    iframe_will_reload: CreateParams;
+    /**
+     * Closes Mini App.
+     * @see https://docs.telegram-mini-apps.com/platform/apps-communication/methods#web-app-close
+     */
+    web_app_close: CreateParams;
+    /**
+     * Closes a QR scanner. The Telegram application creates `scan_qr_popup_closed` event.
+     * @since v6.4
+     * @see https://docs.telegram-mini-apps.com/platform/apps-communication/methods#web-app-close-scan-qr-popup
+     */
+    web_app_close_scan_qr_popup: CreateParams;
+    /**
+     * Sends data to the bot. When this method is called, a service message is sent to the bot
+     * containing the data of the length up to 4096 bytes. Then, Mini App will be closed.
+     *
+     * To get more information, take a look at `web_app_data` field in the
+     * class [Message](https://core.telegram.org/bots/api#message).
+     *
+     * @see https://docs.telegram-mini-apps.com/platform/apps-communication/methods#web-app-data-send
+     */
+    web_app_data_send: CreateParams<{
+        /**
+         * Data to send to a bot. Should not have size of more than 4096 bytes.
+         */
+        data: string;
+    }>;
+    /**
+     * Expands the Mini App.
+     * @see https://docs.telegram-mini-apps.com/platform/apps-communication/methods#web-app-expand
+     */
+    web_app_expand: CreateParams;
+    /**
+     * Invokes custom method.
+     * @since v6.9
+     * @see https://docs.telegram-mini-apps.com/platform/apps-communication/methods#web-app-invoke-custom-method
+     */
+    web_app_invoke_custom_method: CreateParams<AnyInvokeCustomMethodParams>;
+    /**
+     * Opens an invoice by its specified slug. More information about invoices in
+     * this [documentation](https://core.telegram.org/bots/payments).
+     * @since v6.1
+     * @see https://docs.telegram-mini-apps.com/platform/apps-communication/methods#web-app-open-invoice
+     */
+    web_app_open_invoice: CreateParams<{
+        /**
+         * Invoice unique identifier.
+         */
+        slug: string;
+    }>;
+    /**
+     * Opens link in the default browser. Mini App will not be closed.
+     * @see https://docs.telegram-mini-apps.com/platform/apps-communication/methods#web-app-open-link
+     */
+    web_app_open_link: CreateParams<{
+        /**
+         * URL to be opened by Telegram application. Should be a full path with `https` protocol.
+         */
+        url: string;
+        /**
+         * Link will be opened in Instant View mode if possible.
+         * @since v6.4
+         * @see https://instantview.telegram.org/
+         */
+        try_instant_view?: boolean;
+    }, 'try_instant_view'>;
+    /**
+     * Opens a new popup. When user closes the popup, Telegram creates the `popup_closed` event.
+     * @since v6.2
+     * @see https://docs.telegram-mini-apps.com/platform/apps-communication/methods#web-app-open-popup
+     */
+    web_app_open_popup: CreateParams<PopupParams>;
+    /**
+     * Opens a QR scanner. When the scanner was closed, the Telegram application creates
+     * the `scan_qr_popup_closed` event. When the scanner reads QR, Telegram creates the
+     * `qr_text_received` event.
+     * @since v6.4
+     * @see https://docs.telegram-mini-apps.com/platform/apps-communication/methods#web-app-open-scan-qr-popup
+     */
+    web_app_open_scan_qr_popup: CreateParams<{
+        /**
+         * Text to be displayed in the QR scanner.
+         */
+        text?: string;
+    }>;
+    /**
+     * Opens the Telegram link by its pathname and query parameters. The link will be opened in the
+     * Telegram app, Mini App will be closed.
+     * @since v6.1
+     * @see https://docs.telegram-mini-apps.com/platform/apps-communication/methods#web-app-open-tg-link
+     */
+    web_app_open_tg_link: CreateParams<{
+        /**
+         * Should be a value taken from the link of this format: `https://t.me/{path_full}`. Can
+         * additionally contain query parameters.
+         */
+        path_full: string;
+    }>;
+    /**
+     * Reads text from the clipboard. The method accepts a request identifier which is used to
+     * appropriately retrieve the method execution result from the `clipboard_text_received` event.
+     * @since v6.4
+     * @see https://docs.telegram-mini-apps.com/platform/apps-communication/methods#web-app-read-text-from-clipboard
+     */
+    web_app_read_text_from_clipboard: CreateParams<{
+        /**
+         * Unique request identifier. Should be any unique string to handle the generated event
+         * appropriately.
+         */
+        req_id: RequestId;
+    }>;
+    /**
+     * Notifies Telegram about current application is ready to be shown. This method will make
+     * Telegram to remove application loader and display Mini App.
+     * @see https://docs.telegram-mini-apps.com/platform/apps-communication/methods#web-app-ready
+     */
+    web_app_ready: CreateParams;
+    /**
+     * Requests access to current user's phone.
+     * @since v6.9
+     * @see https://docs.telegram-mini-apps.com/platform/apps-communication/methods#web-app-request-phone
+     */
+    web_app_request_phone: CreateParams;
+    /**
+     * Requests current theme from Telegram. As a result, Telegram will create `theme_changed` event.
+     * @see https://docs.telegram-mini-apps.com/platform/apps-communication/methods#web-app-request-theme
+     */
+    web_app_request_theme: CreateParams;
+    /**
+     * Requests current viewport information from Telegram. As a result, Telegram will create
+     * `viewport_changed` event.
+     * @see https://docs.telegram-mini-apps.com/platform/apps-communication/methods#web-app-request-viewport
+     */
+    web_app_request_viewport: CreateParams;
+    /**
+     * Requests write message access to current user.
+     * @since v6.9
+     * @see https://docs.telegram-mini-apps.com/platform/apps-communication/methods#web-app-rqeuest-write-access
+     */
+    web_app_request_write_access: CreateParams;
+    /**
+     * Updates the Mini App background color.
+     * @since v6.1
+     * @see https://docs.telegram-mini-apps.com/platform/apps-communication/methods#web-app-set-background-color
+     */
+    web_app_set_background_color: CreateParams<{
+        /**
+         * The Mini App background color in `#RRGGBB` format.
+         */
+        color: RGB;
+    }>;
+    /**
+     * Updates the Mini App header color.
+     * @since v6.1
+     * @see https://docs.telegram-mini-apps.com/platform/apps-communication/methods#web-app-set-header-color
+     */
+    web_app_set_header_color: CreateParams<{
+        /**
+         * The Mini App header color key.
+         */
+        color_key: HeaderColorKey;
+    } | {
+        /**
+         * Color in RGB format.
+         * @since v6.9
+         */
+        color: RGB;
+    }, 'color'>;
+    /**
+     * Updates the Back Button settings.
+     * @since v6.1
+     * @see https://docs.telegram-mini-apps.com/platform/apps-communication/methods#web-app-setup-back-button
+     */
+    web_app_setup_back_button: CreateParams<{
+        /**
+         * Should the Back Button be visible.
+         */
+        is_visible: boolean;
+    }>;
+    /**
+     * Updates current closing behavior.
+     * @see https://docs.telegram-mini-apps.com/platform/apps-communication/methods#web-app-setup-closing-behavior
+     */
+    web_app_setup_closing_behavior: CreateParams<{
+        /**
+         * Will user be prompted in case, an application is going to be closed.
+         */
+        need_confirmation: boolean;
+    }>;
+    /**
+     * Updates the Main Button settings.
+     * @see https://docs.telegram-mini-apps.com/platform/apps-communication/methods#web-app-setup-main-button
+     */
+    web_app_setup_main_button: CreateParams<{
+        /**
+         * Should the Main Button be displayed.
+         */
+        is_visible?: boolean;
+        /**
+         * Should the Main Button be enabled.
+         */
+        is_active?: boolean;
+        /**
+         * Should loader inside the Main Button be displayed. Use this property in case, some
+         * operation takes time. This loader will make user notified about it.
+         */
+        is_progress_visible?: boolean;
+        /**
+         * Text inside the Main Button.
+         */
+        text?: string;
+        /**
+         * The Main Button background color in `#RRGGBB` format.
+         */
+        color?: string;
+        /**
+         * The Main Button text color in `#RRGGBB` format.
+         */
+        text_color?: string;
+    }>;
+    /**
+     * Updates current state of Settings Button.
+     * @since v6.10
+     * @see https://docs.telegram-mini-apps.com/platform/apps-communication/methods#web-app-setup-settings-button
+     */
+    web_app_setup_settings_button: CreateParams<{
+        /**
+         * Should the Settings Button be displayed.
+         */
+        is_visible: boolean;
+    }>;
+    /**
+     * Inserts the bot's username and the specified inline query in the current chat's input field.
+     * Query may be empty, in which case only the bot's username will be inserted. The client prompts
+     * the user to choose a specific chat, then opens that chat and inserts the bot's username and
+     * the specified inline query in the input field.
+     * @since v6.7
+     * @see https://docs.telegram-mini-apps.com/platform/apps-communication/methods#web-app-switch-inline-query
+     */
+    web_app_switch_inline_query: CreateParams<{
+        /**
+         * Text which should be inserted in the input after the current bot name. Max length is
+         * 256 symbols.
+         */
+        query: string;
+        /**
+         * List of chat types which could be chosen to send the message. Could be empty list.
+         */
+        chat_types: SwitchInlineQueryChatType[];
+    }>;
+    /**
+     * Generates haptic feedback event.
+     * @since v6.1
+     * @see https://docs.telegram-mini-apps.com/platform/apps-communication/methods#web-app-trigger-haptic-feedback
+     */
+    web_app_trigger_haptic_feedback: CreateParams<AnyHapticFeedbackParams>;
+}
+/**
+ * Any Telegram Mini Apps known method name.
+ */
+export type MiniAppsMethodName = keyof MiniAppsMethods;
+/**
+ * Returns parameters for specified post-available event.
+ */
+export type MiniAppsMethodParams<M extends MiniAppsMethodName> = MiniAppsMethods[M]['params'];
+/**
+ * True if specified method accepts parameters.
+ */
+export type MiniAppsMethodAcceptParams<M extends MiniAppsMethodName> = Not<IsNever<Exclude<MiniAppsMethodParams<M>, undefined>>>;
+/**
+ * Any post-available event name which does not require arguments.
+ */
+export type MiniAppsEmptyMethodName = {
+    [M in MiniAppsMethodName]: undefined extends MiniAppsMethodParams<M> ? M : never;
+}[MiniAppsMethodName];
+/**
+ * Any post-available event name which require arguments.
+ */
+export type MiniAppsNonEmptyMethodName = {
+    [M in MiniAppsMethodName]: MiniAppsMethodAcceptParams<M> extends true ? M : never;
+}[MiniAppsMethodName];
+/**
+ * Method names which have versioned params.
+ */
+export type MiniAppsMethodWithVersionedParams = {
+    [M in MiniAppsMethodName]: IsNever<MiniAppsMethods[M]['versionedParams']> extends true ? never : M;
+}[MiniAppsMethodName];
+/**
+ * Method parameters which appear only in the specific Telegram Mini Apps version.
+ */
+export type MiniAppsMethodVersionedParams<M extends MiniAppsMethodWithVersionedParams> = MiniAppsMethods[M]['versionedParams'];
+export {};

package/dist/dts/bridge/methods/popup.d.ts

@@ -0,0 +1,49 @@
+/**
+ * Describes the native popup.
+ */
+export interface PopupParams {
+    /**
+     * The text to be displayed in the popup title, 0-64 characters.
+     */
+    title: string;
+    /**
+     * The message to be displayed in the body of the popup, 1-256 characters.
+     */
+    message: string;
+    /**
+     * List of buttons to be displayed in the popup, 1-3 buttons.
+     */
+    buttons: PopupButton[];
+}
+/**
+ * Describes the native popup button.
+ * @see https://docs.telegram-mini-apps.com/platform/apps-communication/methods#popupbutton
+ */
+export type PopupButton = {
+    /**
+     * Identifier of the button, 0-64 characters.
+     */
+    id: string;
+} & ({
+    /**
+     * Type of the button:
+     * - `default`, a button with the default style;
+     * - `destructive`, a button with a style that indicates a destructive
+     * action (e.g. "Remove", "Delete", etc.).
+     *
+     * @default "default"
+     */
+    type?: 'default' | 'destructive';
+    /**
+     * The text to be displayed on the button, 0-64 characters.
+     */
+    text: string;
+} | {
+    /**
+     * Type of the button:
+     * - `ok`, a button with the localized text "OK";
+     * - `close`, a button with the localized text "Close";
+     * - `cancel`, a button with the localized text "Cancel".
+     */
+    type: 'ok' | 'close' | 'cancel';
+});

package/dist/dts/bridge/methods/postEvent.d.ts

@@ -0,0 +1,29 @@
+import type { MiniAppsEmptyMethodName, MiniAppsMethodParams, MiniAppsNonEmptyMethodName } from './methods.js';
+interface PostEventOptions {
+    /**
+     * Origin used while posting message. This option is only used in case,
+     * current environment is browser (Web version of Telegram) and could
+     * be used for test purposes.
+     * @default 'https://web.telegram.org'
+     */
+    targetOrigin?: string;
+}
+export type PostEvent = typeof postEvent;
+/**
+ * Sends event to native application which launched Mini App. This function
+ * accepts only events, which require arguments.
+ * @param eventType - event name.
+ * @param params - event parameters.
+ * @param options - posting options.
+ * @throws {Error} Bridge could not determine current environment and possible way to send event.
+ */
+export declare function postEvent<E extends MiniAppsNonEmptyMethodName>(eventType: E, params: MiniAppsMethodParams<E>, options?: PostEventOptions): void;
+/**
+ * Sends event to native application which launched Mini App. This function
+ * accepts only events, which require arguments.
+ * @param eventType - event name.
+ * @param options - posting options.
+ * @throws {Error} Bridge could not determine current environment and possible way to send event.
+ */
+export declare function postEvent(eventType: MiniAppsEmptyMethodName, options?: PostEventOptions): void;
+export {};

package/dist/dts/bridge/request.d.ts

@@ -0,0 +1,65 @@
+import type { And, If, IsNever } from '../types/index.js';
+import { type MiniAppsEventHasParams, type MiniAppsEventName, type MiniAppsEventParams } from './events/index.js';
+import { type MiniAppsEmptyMethodName, type MiniAppsMethodAcceptParams, type MiniAppsMethodName, type MiniAppsMethodParams, type MiniAppsNonEmptyMethodName, type PostEvent } from './methods/index.js';
+/**
+ * Names of methods, which require passing "req_id" parameter.
+ */
+type MethodWithRequestId = {
+    [M in MiniAppsMethodName]: If<And<MiniAppsMethodAcceptParams<M>, MiniAppsMethodParams<M> extends {
+        req_id: string;
+    } ? true : false>, M, never>;
+}[MiniAppsMethodName];
+/**
+ * Names of events, which contain "req_id" parameter.
+ */
+type EventWithRequestId = {
+    [E in MiniAppsEventName]: If<And<MiniAppsEventHasParams<E>, MiniAppsEventParams<E> extends {
+        req_id: string;
+    } ? true : false>, E, never>;
+}[MiniAppsEventName];
+export interface RequestOptions {
+    /**
+     * Bridge postEvent method.
+     * @default Global postEvent method.
+     */
+    postEvent?: PostEvent;
+    /**
+     * Execution timeout.
+     */
+    timeout?: number;
+}
+export interface RequestOptionsAdvanced<EventPayload> extends RequestOptions {
+    /**
+     * Should return true in case, this event should be captured. If not specified,
+     * request is not skipping captured events.
+     */
+    capture?: If<IsNever<EventPayload>, () => boolean, (payload: EventPayload) => boolean>;
+}
+/**
+ * Calls specified TWA method and captures one of the specified events. Returns promise
+ * which will be resolved in case, event with specified in method request identifier
+ * was captured.
+ * @param method - method to execute.
+ * @param params - method parameters.
+ * @param event - event or events to listen.
+ * @param options - additional execution options.
+ */
+export declare function request<M extends MethodWithRequestId, E extends EventWithRequestId>(method: M, params: MiniAppsMethodParams<M>, event: E | E[], options?: RequestOptions): Promise<MiniAppsEventParams<E>>;
+/**
+ * Calls specified TWA method and captures one of the specified events. Returns promise
+ * which will be resolved in case, specified event was captured.
+ * @param method - method to execute.
+ * @param event - event or events to listen.
+ * @param options - additional execution options.
+ */
+export declare function request<M extends MiniAppsEmptyMethodName, E extends MiniAppsEventName>(method: M, event: E | E[], options?: RequestOptionsAdvanced<MiniAppsEventParams<E>>): Promise<MiniAppsEventParams<E>>;
+/**
+ * Calls specified TWA method and captures one of the specified events. Returns promise
+ * which will be resolved in case, specified event was captured.
+ * @param method - method to execute
+ * @param params - method parameters.
+ * @param event - event or events to listen
+ * @param options - additional execution options.
+ */
+export declare function request<M extends MiniAppsNonEmptyMethodName, E extends MiniAppsEventName>(method: M, params: MiniAppsMethodParams<M>, event: E | E[], options?: RequestOptionsAdvanced<MiniAppsEventParams<E>>): Promise<MiniAppsEventParams<E>>;
+export {};

package/dist/dts/classnames/classNames.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Function which joins passed values with space following these rules:
+ * 1. If value is non-empty string, it will be added to output.
+ * 2. If value is object, only those keys will be added, which values are truthy.
+ * 3. All other values are ignored.
+ *
+ * You can find this function to similar one from package {@link https://www.npmjs.com/package/classnames|classnames}.
+ * @param values - values array.
+ */
+export declare function classNames(...values: any[]): string;

package/dist/dts/classnames/index.d.ts

@@ -0,0 +1,2 @@
+export * from './classNames.js';
+export * from './mergeClassNames.js';

package/dist/dts/classnames/mergeClassNames.d.ts

@@ -0,0 +1,32 @@
+type FilterUnion<U> = Exclude<U, number | string | null | undefined | any[] | boolean>;
+/**
+ * Returns union keys removing those, which values are not strings.
+ */
+type UnionFilteredKeys<U> = U extends U ? {
+    [K in keyof U]: U[K] extends string ? K : never;
+}[keyof U] : never;
+/**
+ * Returns union required keys.
+ */
+type UnionRequiredKeys<U> = U extends U ? {
+    [K in UnionFilteredKeys<U>]-?: ({} extends {
+        [P in K]: U[K];
+    } ? never : K);
+}[UnionFilteredKeys<U>] : never;
+/**
+ * Returns union optional keys.
+ */
+type UnionOptionalKeys<U> = Exclude<UnionFilteredKeys<U>, UnionRequiredKeys<U>>;
+type MergeClassNames<Tuple extends any[]> = Tuple[number] extends infer Union ? FilterUnion<Union> extends infer UnionFiltered ? {
+    [K in UnionRequiredKeys<UnionFiltered>]: string;
+} & {
+    [K in UnionOptionalKeys<UnionFiltered>]?: string;
+} : never : never;
+/**
+ * Merges 2 sets of parameters. Function expects passing an array of objects with values, which
+ * could be passed to `classNames` function. As the result, it returns an object with keys
+ * from all objects with merged values.
+ * @see classNames
+ */
+export declare function mergeClassNames<T extends any[]>(...partials: T): MergeClassNames<T>;
+export {};

package/dist/dts/{components/ClosingBehaviour/ClosingBehaviour.d.ts → closing-behavior/ClosingBehavior.d.ts}

@@ -1,9 +1,10 @@
-import { type PostEvent } from '@tma.js/bridge';
+import { type PostEvent } from '../bridge/index.js';
+import type { ClosingBehaviorEvents } from './types.js';
 /**
  * Component responsible for controlling current closing confirmation
  * status.
  */
-export declare class ClosingBehaviour {
+export declare class ClosingBehavior {
     private readonly postEvent;
     private readonly ee;
     private readonly state;
@@ -27,9 +28,9 @@ export declare class ClosingBehaviour {
     /**
      * Adds new event listener.
      */
-    on: typeof this.ee.on;
+    on: <E extends "change" | "change:isConfirmationNeeded">(event: E, listener: import('../event-emitter/index.js').EventListener<ClosingBehaviorEvents[E]>) => import('../event-emitter/index.js').RemoveEventListener;
     /**
      * Removes event listener.
      */
-    off: typeof this.ee.off;
+    off: <E extends "change" | "change:isConfirmationNeeded">(event: E, listener: import('../event-emitter/index.js').EventListener<ClosingBehaviorEvents[E]>) => void;
 }

package/dist/dts/closing-behavior/index.d.ts

@@ -0,0 +1,2 @@
+export * from './ClosingBehavior.js';
+export * from './types.js';

package/dist/dts/closing-behavior/types.d.ts

@@ -0,0 +1,7 @@
+import type { StateEvents } from '../state/index.js';
+export interface ClosingBehaviorState {
+    isConfirmationNeeded: boolean;
+}
+export type ClosingBehaviorEvents = StateEvents<ClosingBehaviorState>;
+export type ClosingBehaviorEventName = keyof ClosingBehaviorEvents;
+export type ClosingBehaviorEventListener<E extends ClosingBehaviorEventName> = ClosingBehaviorEvents[E];

package/dist/dts/{components/CloudStorage → cloud-storage}/CloudStorage.d.ts

@@ -1,7 +1,7 @@
-import { postEvent as defaultPostEvent, type RequestOptions } from '@tma.js/bridge';
-import type { Version } from '@tma.js/utils';
-import { type SupportsFunc } from '../../supports.js';
-import type { CreateRequestIdFunc } from '../../types.js';
+import { postEvent as defaultPostEvent, type RequestOptions } from '../bridge/index.js';
+import { type SupportsFunc } from '../supports/index.js';
+import type { CreateRequestIdFunc } from '../types/index.js';
+import type { Version } from '../version/index.js';
 type WiredRequestOptions = Omit<RequestOptions, 'postEvent'>;
 export declare class CloudStorage {
     private readonly createRequestId;
@@ -15,13 +15,13 @@ export declare class CloudStorage {
      */
     private invokeCustomMethod;
     /**
-     * Deletes specified keys from the CloudStorage.
-     * @param keys - keys list.
+     * Deletes specified key or keys from the cloud storage.
+     * @param keyOrKeys - key or keys to delete.
      * @param options - request execution options.
      */
-    deleteKeys(keys: string[], options?: WiredRequestOptions): Promise<void>;
+    delete(keyOrKeys: string | string[], options?: WiredRequestOptions): Promise<void>;
     /**
-     * Returns list of all keys presented in CloudStorage.
+     * Returns list of all keys presented in the cloud storage.
      * @param options - request execution options.
      */
     getKeys(options?: WiredRequestOptions): Promise<string[]>;
@@ -31,17 +31,25 @@ export declare class CloudStorage {
      * @param keys - keys list.
      * @param options - request execution options.
      */
-    getValues<K extends string>(keys: K[], options?: WiredRequestOptions): Promise<Record<K, string>>;
+    get<K extends string>(keys: K[], options?: WiredRequestOptions): Promise<Record<K, string>>;
+    /**
+     * Returns value of the specified key.
+     * @param key - cloud storage key.
+     * @param options - request execution options.
+     * @return Value of the specified key. In case, key was not created previously, function
+     * will return empty string.
+     */
+    get(key: string, options?: WiredRequestOptions): Promise<string>;
     /**
      * Saves specified value by key.
      * @param key - storage key.
      * @param value - storage value.
      * @param options - request execution options.
      */
-    saveValue(key: string, value: string, options?: WiredRequestOptions): Promise<void>;
+    set(key: string, value: string, options?: WiredRequestOptions): Promise<void>;
     /**
      * Checks if specified method is supported by current component.
      */
-    supports: SupportsFunc<'deleteKeys' | 'getKeys' | 'getValues' | 'saveValue'>;
+    supports: SupportsFunc<'delete' | 'get' | 'getKeys' | 'set'>;
 }
 export {};

package/dist/dts/colors/index.d.ts

@@ -0,0 +1,5 @@
+export * from './isColorDark.js';
+export * from './isRGB.js';
+export * from './isRGBShort.js';
+export * from './toRGB.js';
+export * from './types.js';

package/dist/dts/colors/isColorDark.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Returns true in case, the color is recognized as dark.
+ * @param color - color in any format acceptable by toRGB function.
+ * @see toRGB
+ */
+export declare function isColorDark(color: string): boolean;

package/dist/dts/colors/isRGB.d.ts

@@ -0,0 +1,6 @@
+import type { RGB } from './types.js';
+/**
+ * Returns true in case, passed value has #RRGGBB format.
+ * @param value - value to check.
+ */
+export declare function isRGB(value: string): value is RGB;

package/dist/dts/colors/isRGBShort.d.ts

@@ -0,0 +1,6 @@
+import type { RGBShort } from './types.js';
+/**
+ * Returns true in case, passed value has #RGB format.
+ * @param value - value to check.
+ */
+export declare function isRGBShort(value: string): value is RGBShort;

package/dist/dts/colors/toRGB.d.ts

@@ -0,0 +1,11 @@
+import type { RGB } from './types.js';
+/**
+ * Converts passed value to #RRGGBB format. Accepts following color formats:
+ * - `#RGB`
+ * - `#RRGGBB`
+ * - `rgb(1,2,3)`
+ * - `rgba(1,2,3,4)`
+ * @param value - value to convert.
+ * @throws {Error} Passed value does not satisfy any of known RGB formats.
+ */
+export declare function toRGB(value: string): RGB;

package/dist/dts/colors/types.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Color in format #RGB.
+ */
+export type RGBShort = `#${string}`;
+/**
+ * Color in format #RRGGBB.
+ */
+export type RGB = `#${string}`;