@taiga-ui/cdk 3.51.0-canary.d032cc6 → 3.52.0-canary.104df92

package/schematics/utils/progress.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.setupProgressLogger = void 0;
+/// <reference types="node" />
 const readline_1 = require("readline");
 const colored_log_1 = require("./colored-log");
 const is_ci_1 = require("./is-ci");

package/schematics/utils/push-to-array-property.js

@@ -21,6 +21,7 @@ function pushToObjectArrayProperty(objectExpression, propertyName, initializer,
             .some(element => element.getText() === initializer)) {
         return;
     }
+    // eslint-disable-next-line @taiga-ui/experience/no-typeof
     if (typeof index === `number`) {
         importsInitializer.insertElement(index, initializer);
     }

package/schematics/utils/templates/elements.d.ts

@@ -3,9 +3,28 @@ export declare function findElementsByFn(nodes: ChildNode[], predicateFn: (el: E
 export declare function findElementsInTemplateByFn(html: string, predicateFn: (el: Element) => boolean): Element[];
 export declare function findElementsByTagName(html: string, tagName: string): Element[];
 export declare function findElementsByTagNames(html: string, tagNames: string[]): Element[];
+/**
+ * Parses a HTML fragment and traverses all AST nodes in order find elements that
+ * include the specified attribute.
+ */
 export declare function findElementsWithAttribute(html: string, attributeName: string): Element[];
+/**
+ * Parses a HTML fragment and traverses all AST nodes in order find elements that include the specified attribute and tag name.
+ * @param html
+ * @param attributeName
+ */
 export declare function findElementsWithAttributeOnTag(html: string, attributeNames: string[], tagNames?: string[]): Element[];
+/**
+ * Finds elements with explicit tag names that also contain the specified attribute. Returns the
+ * attribute start offset based on the specified HTML.
+ */
 export declare function findAttributeOnElementWithTag(html: string, name: string, tagNames: string[], filterFn?: (element: Element) => boolean): number[];
+/**
+ * Finds elements that contain the given attribute and contain at least one of the other
+ * specified attributes. Returns the primary attribute's start offset based on the specified HTML.
+ */
 export declare function findAttributeOnElementWithAttrs(html: string, name: string, attrs: string[], filterFn?: (element: Element) => boolean): number[];
+/** Shorthand function that checks if the specified element contains the given attribute. */
 export declare function hasElementAttribute(element: Element, attributeName: string): boolean;
+/** Gets the start offset of the given attribute from a Parse5 element. */
 export declare function getStartOffsetOfAttribute(element: Element, attributeName: string): number;

package/schematics/utils/templates/elements.js

@@ -20,6 +20,7 @@ function findElementsByFn(nodes, predicateFn) {
 }
 exports.findElementsByFn = findElementsByFn;
 function findElementsInTemplateByFn(html, predicateFn) {
+    // utf8 with BOM adds an extra character to the beginning of the string
     if (html.charCodeAt(0) === 0xfeff) {
         html = html.slice(1);
     }
@@ -35,10 +36,19 @@ function findElementsByTagNames(html, tagNames) {
     return findElementsInTemplateByFn(html, el => tagNames.includes(el.tagName));
 }
 exports.findElementsByTagNames = findElementsByTagNames;
+/**
+ * Parses a HTML fragment and traverses all AST nodes in order find elements that
+ * include the specified attribute.
+ */
 function findElementsWithAttribute(html, attributeName) {
     return findElementsInTemplateByFn(html, el => { var _a; return (_a = el.attrs) === null || _a === void 0 ? void 0 : _a.some(attr => attr.name === attributeName.toLowerCase()); });
 }
 exports.findElementsWithAttribute = findElementsWithAttribute;
+/**
+ * Parses a HTML fragment and traverses all AST nodes in order find elements that include the specified attribute and tag name.
+ * @param html
+ * @param attributeName
+ */
 function findElementsWithAttributeOnTag(html, attributeNames, tagNames = []) {
     return findElementsInTemplateByFn(html, el => {
         var _a;
@@ -47,25 +57,39 @@ function findElementsWithAttributeOnTag(html, attributeNames, tagNames = []) {
     });
 }
 exports.findElementsWithAttributeOnTag = findElementsWithAttributeOnTag;
-function findAttributeOnElementWithTag(html, name, tagNames, filterFn = () => true) {
+/**
+ * Finds elements with explicit tag names that also contain the specified attribute. Returns the
+ * attribute start offset based on the specified HTML.
+ */
+function findAttributeOnElementWithTag(html, name, tagNames, 
+// eslint-disable-next-line no-restricted-syntax
+filterFn = () => true) {
     return findElementsWithAttribute(html, name)
         .filter(element => (tagNames.includes(element.tagName) || tagNames.includes(`*`)) &&
         filterFn(element))
         .map(element => getStartOffsetOfAttribute(element, name));
 }
 exports.findAttributeOnElementWithTag = findAttributeOnElementWithTag;
-function findAttributeOnElementWithAttrs(html, name, attrs, filterFn = () => true) {
+/**
+ * Finds elements that contain the given attribute and contain at least one of the other
+ * specified attributes. Returns the primary attribute's start offset based on the specified HTML.
+ */
+function findAttributeOnElementWithAttrs(html, name, attrs, 
+// eslint-disable-next-line no-restricted-syntax
+filterFn = () => true) {
     return findElementsWithAttribute(html, name)
         .filter(element => attrs.some(attr => hasElementAttribute(element, attr)) &&
         filterFn(element))
         .map(element => getStartOffsetOfAttribute(element, name));
 }
 exports.findAttributeOnElementWithAttrs = findAttributeOnElementWithAttrs;
+/** Shorthand function that checks if the specified element contains the given attribute. */
 function hasElementAttribute(element, attributeName) {
     var _a;
     return (_a = element.attrs) === null || _a === void 0 ? void 0 : _a.some(attr => attr.name === attributeName.toLowerCase());
 }
 exports.hasElementAttribute = hasElementAttribute;
+/** Gets the start offset of the given attribute from a Parse5 element. */
 function getStartOffsetOfAttribute(element, attributeName) {
     var _a, _b, _c;
     return (((_c = (_b = (_a = element.sourceCodeLocation) === null || _a === void 0 ? void 0 : _a.attrs) === null || _b === void 0 ? void 0 : _b[attributeName.toLowerCase()]) === null || _c === void 0 ? void 0 : _c.startOffset) || 0);

package/schematics/utils/templates/ng-component-input-manipulations.d.ts

@@ -1,6 +1,31 @@
 import { DevkitFileSystem } from 'ng-morph/project/classes/devkit-file-system';
 import { Element } from 'parse5';
 import { TemplateResource } from '../../ng-update/interfaces/template-resource';
+/**
+ * Replace component input property by new value
+ * ___
+ * Example:
+ * 1. Before
+ * ```html
+ * <tui-input-slider secondary="123"></tui-input-slider>
+ * ```
+ * 2. Execute
+ * ```ts
+ * const wasModified = replaceInputProperty({
+ *      templateResource,
+ *      fileSystem,
+ *      componentSelector: 'tui-input-slider',
+ *      from: 'secondary',
+ *      to: 'tuiTextfieldCustomContent',
+ * });
+ * ```
+ * 3. After
+ * ```html
+ * <tui-input-slider tuiTextfieldCustomContent="123"></tui-input-slider>
+ * ```
+ * ___
+ * @return true if something was changed
+ */
 export declare function replaceInputProperty({ templateResource, fileSystem, componentSelector, from, to, newValue, filterFn, }: {
     componentSelector: string[] | string;
     fileSystem: DevkitFileSystem;
@@ -10,7 +35,21 @@ export declare function replaceInputProperty({ templateResource, fileSystem, com
     templateResource: TemplateResource;
     to: string;
 }): boolean;
+/**
+ * @example
+ * // 10 symbols before property `size` and string `size="s"` has 8-symbols length
+ * const template = '<tui-card size="s"></tui-card>';
+ *
+ * getInputPropertyOffsets(template, 'size', ['tui-card']) // [[10, 18]]
+ */
 export declare function getInputPropertyOffsets(html: string, attrName: string, tags: string[], filterFn?: (element: Element) => boolean): Array<[number, number]>;
+/**
+ * @example
+ * // `<tui-card size="` has 16-symbols length
+ * const template = '<tui-card size="xl"></tui-card>';
+ *
+ * getInputPropertyValueOffsets(template, 'size', ['tui-card']) // [ [16, 18] ]
+ */
 export declare function getInputPropertyValueOffsets(template: string, attrName: string, tags: string[]): Array<[number, number]>;
 export declare function replaceInputPropertyByDirective({ templateResource, fileSystem, componentSelector, inputProperty, directive, directiveModule, filterFn, }: {
     componentSelector: string[] | string;
@@ -24,6 +63,11 @@ export declare function replaceInputPropertyByDirective({ templateResource, file
     inputProperty: string;
     templateResource: TemplateResource;
 }): void;
+/**
+ * After removing property from the tag (which uses multi lines inside template) it can leave redundant space.
+ * It is not critical because html is valid even with this extra space.
+ * TODO: Find a way to fix it
+ */
 export declare function removeInputProperty({ templateResource, fileSystem, componentSelector, inputProperty, filterFn, }: {
     componentSelector: string;
     fileSystem: DevkitFileSystem;

package/schematics/utils/templates/ng-component-input-manipulations.js

@@ -4,6 +4,31 @@ exports.removeInputProperty = exports.replaceInputPropertyByDirective = exports.
 const add_import_to_closest_module_1 = require("../add-import-to-closest-module");
 const elements_1 = require("./elements");
 const template_resource_1 = require("./template-resource");
+/**
+ * Replace component input property by new value
+ * ___
+ * Example:
+ * 1. Before
+ * ```html
+ * <tui-input-slider secondary="123"></tui-input-slider>
+ * ```
+ * 2. Execute
+ * ```ts
+ * const wasModified = replaceInputProperty({
+ *      templateResource,
+ *      fileSystem,
+ *      componentSelector: 'tui-input-slider',
+ *      from: 'secondary',
+ *      to: 'tuiTextfieldCustomContent',
+ * });
+ * ```
+ * 3. After
+ * ```html
+ * <tui-input-slider tuiTextfieldCustomContent="123"></tui-input-slider>
+ * ```
+ * ___
+ * @return true if something was changed
+ */
 function replaceInputProperty({ templateResource, fileSystem, componentSelector, from, to, newValue = ``, filterFn, }) {
     const template = template_resource_1.getTemplateFromTemplateResource(templateResource, fileSystem);
     const path = fileSystem.resolve(template_resource_1.getPathFromTemplateResource(templateResource));
@@ -44,7 +69,16 @@ function replaceInputProperty({ templateResource, fileSystem, componentSelector,
     return true;
 }
 exports.replaceInputProperty = replaceInputProperty;
-function getInputPropertyOffsets(html, attrName, tags, filterFn = () => true) {
+/**
+ * @example
+ * // 10 symbols before property `size` and string `size="s"` has 8-symbols length
+ * const template = '<tui-card size="s"></tui-card>';
+ *
+ * getInputPropertyOffsets(template, 'size', ['tui-card']) // [[10, 18]]
+ */
+function getInputPropertyOffsets(html, attrName, tags, 
+// eslint-disable-next-line no-restricted-syntax
+filterFn = () => true) {
     return elements_1.findElementsWithAttribute(html, attrName)
         .filter(element => (tags.includes(element.tagName) || tags.includes(`*`)) &&
         filterFn(element))
@@ -55,6 +89,13 @@ function getInputPropertyOffsets(html, attrName, tags, filterFn = () => true) {
     });
 }
 exports.getInputPropertyOffsets = getInputPropertyOffsets;
+/**
+ * @example
+ * // `<tui-card size="` has 16-symbols length
+ * const template = '<tui-card size="xl"></tui-card>';
+ *
+ * getInputPropertyValueOffsets(template, 'size', ['tui-card']) // [ [16, 18] ]
+ */
 function getInputPropertyValueOffsets(template, attrName, tags) {
     const stringProperties = getInputPropertyOffsets(template, attrName, tags).map(([start, end]) => [start + attrName.length + `="`.length, end - 1]);
     const propertyBindings = getInputPropertyOffsets(template, `[${attrName}]`, tags).map(([start, end]) => [start + `[${attrName}]`.length + `="`.length, end - 1]);
@@ -75,6 +116,11 @@ function replaceInputPropertyByDirective({ templateResource, fileSystem, compone
     }
 }
 exports.replaceInputPropertyByDirective = replaceInputPropertyByDirective;
+/**
+ * After removing property from the tag (which uses multi lines inside template) it can leave redundant space.
+ * It is not critical because html is valid even with this extra space.
+ * TODO: Find a way to fix it
+ */
 function removeInputProperty({ templateResource, fileSystem, componentSelector, inputProperty, filterFn, }) {
     const template = template_resource_1.getTemplateFromTemplateResource(templateResource, fileSystem);
     const templateOffset = template_resource_1.getTemplateOffset(templateResource);

package/services/destroy.service.d.ts

@@ -1,6 +1,14 @@
 import { OnDestroy } from '@angular/core';
 import { ReplaySubject } from 'rxjs';
 import * as i0 from "@angular/core";
+/**
+ * @note:
+ * Observable abstraction over ngOnDestroy to use with takeUntil
+ *
+ * Why we use `ReplaySubject` instead of `Subject`?
+ * Well, we’ll use ReplaySubject to emit the last message in case
+ * the subscription is ended after the component is destroyed.
+ */
 export declare class TuiDestroyService extends ReplaySubject<void> implements OnDestroy {
     constructor();
     ngOnDestroy(): void;

package/services/directive-styles.service.d.ts

@@ -1,5 +1,8 @@
 import { ComponentFactoryResolver, Injector, Type } from '@angular/core';
 import * as i0 from "@angular/core";
+/**
+ * Service to use styles with directives
+ */
 export declare class TuiDirectiveStylesService {
     private readonly resolver;
     private readonly injector;

package/services/focus-visible.service.d.ts

@@ -1,6 +1,11 @@
 import { ChangeDetectorRef, ElementRef } from '@angular/core';
 import { Observable } from 'rxjs';
 import * as i0 from "@angular/core";
+/**
+ * Service to imitate :focus-visible
+ * (https://developer.mozilla.org/en-US/docs/Web/CSS/:focus-visible)
+ * in browsers that do not support it
+ */
 export declare class TuiFocusVisibleService extends Observable<boolean> {
     private readonly focusVisible$;
     constructor({ nativeElement }: ElementRef<Element>, cdr: ChangeDetectorRef, destroy$: Observable<void>);

package/services/id.service.d.ts

@@ -1,4 +1,7 @@
 import * as i0 from "@angular/core";
+/**
+ * Generates unique ids
+ */
 export declare class TuiIdService {
     private static autoId;
     generate(): string;

package/services/obscured.service.d.ts

@@ -2,6 +2,11 @@ import { ElementRef, NgZone } from '@angular/core';
 import { Observable } from 'rxjs';
 import { TuiParentsScrollService } from './parents-scroll.service';
 import * as i0 from "@angular/core";
+/**
+ * Service that monitors element visibility by subscribing to scrolls
+ * and polling with set interval, returns either null or an array
+ * of elements that overlap given element edges
+ */
 export declare class TuiObscuredService extends Observable<readonly Element[] | null> {
     private readonly obscured$;
     constructor(parentsScroll$: TuiParentsScrollService, { nativeElement }: ElementRef<Element>, zone: NgZone, win: Window, destroy$: Observable<void>, animationFrame$: Observable<number>);

package/services/parents-scroll.service.d.ts

@@ -1,6 +1,9 @@
 import { ElementRef } from '@angular/core';
 import { Observable } from 'rxjs';
 import * as i0 from "@angular/core";
+/**
+ * Service that subscribes to scroll events of all parent elements
+ */
 export declare class TuiParentsScrollService extends Observable<Event> {
     private readonly callback$;
     constructor(el: ElementRef<Element>, win: Window);

package/services/taiga-ui-cdk-services.d.ts

@@ -1,2 +1,5 @@
+/**
+ * Generated bundle index. Do not edit.
+ */
 /// <amd-module name="@taiga-ui/cdk/services" />
 export * from './index';

package/taiga-ui-cdk.d.ts

@@ -1,2 +1,5 @@
+/**
+ * Generated bundle index. Do not edit.
+ */
 /// <amd-module name="@taiga-ui/cdk" />
 export * from './index';

package/tokens/active-element.d.ts

@@ -1,2 +1,5 @@
 import { Observable } from 'rxjs';
+/**
+ * Active element on the document for ActiveZone
+ */
 export declare const TUI_ACTIVE_ELEMENT: import("@angular/core").InjectionToken<Observable<EventTarget | null>>;

package/tokens/alerts.d.ts

@@ -1,5 +1,8 @@
 import { Provider, Type } from '@angular/core';
 import { TuiAriaDialogContext } from '@taiga-ui/cdk/interfaces';
 import { Observable } from 'rxjs';
+/**
+ * A stream of alerts
+ */
 export declare const TUI_ALERTS: import("@angular/core").InjectionToken<readonly Observable<readonly TuiAriaDialogContext[]>[]>;
 export declare function tuiAsAlerts(useExisting: Type<Observable<readonly TuiAriaDialogContext[]>>): Provider;

package/tokens/default-renderer.d.ts

@@ -1,2 +1,8 @@
 import { Renderer2 } from '@angular/core';
+/**
+ * A Renderer2 for global services
+ * https://github.com/angular/angular/issues/17824#issuecomment-353239017
+ * @deprecated unnecessary
+ * TODO: remove in 4.0
+ */
 export declare const TUI_DEFAULT_RENDERER: import("@angular/core").InjectionToken<Renderer2>;

package/tokens/dialogs.d.ts

@@ -1,5 +1,8 @@
 import { Provider, Type } from '@angular/core';
 import { TuiAriaDialogContext } from '@taiga-ui/cdk/interfaces';
 import { Observable } from 'rxjs';
+/**
+ * A stream of dialogs
+ */
 export declare const TUI_DIALOGS: import("@angular/core").InjectionToken<readonly Observable<readonly TuiAriaDialogContext[]>[]>;
 export declare function tuiAsDialog(useExisting: Type<Observable<readonly TuiAriaDialogContext[]>>): Provider;

package/tokens/ensure-base-href.d.ts

@@ -1 +1,4 @@
+/**
+ * @deprecated: use {@link TUI_BASE_HREF}
+ */
 export declare const TUI_ENSURE_BASE_HREF: import("@angular/core").InjectionToken<string>;

package/tokens/focusable-item-accessor.d.ts

@@ -1,4 +1,7 @@
 import { InjectionToken, Provider, Type } from '@angular/core';
 import { TuiFocusableElementAccessor } from '@taiga-ui/cdk/interfaces';
+/**
+ * A component that can be focused
+ */
 export declare const TUI_FOCUSABLE_ITEM_ACCESSOR: InjectionToken<TuiFocusableElementAccessor>;
 export declare function tuiAsFocusableItemAccessor(useExisting: Type<TuiFocusableElementAccessor>): Provider;

package/tokens/is-android.d.ts

@@ -1 +1,4 @@
+/**
+ * Mobile browser that is not iOS (technically includes Windows Phone, Blackberry etc.)
+ */
 export declare const TUI_IS_ANDROID: import("@angular/core").InjectionToken<boolean>;

package/tokens/is-apple.d.ts

@@ -1 +1,4 @@
+/**
+ * Apple(safari/webkit) detection
+ */
 export declare const TUI_IS_APPLE: import("@angular/core").InjectionToken<boolean>;

package/tokens/is-chromium.d.ts

@@ -1 +1,4 @@
+/**
+ * Chromium browser engine detection
+ */
 export declare const TUI_IS_CHROMIUM: import("@angular/core").InjectionToken<boolean>;

package/tokens/is-cypress.d.ts

@@ -1 +1,5 @@
+/**
+ * Detect if app is running under Cypress
+ * {@link https://docs.cypress.io/faq/questions/using-cypress-faq#Is-there-any-way-to-detect-if-my-app-is-running-under-Cypress Cypress docs}
+ */
 export declare const TUI_IS_CYPRESS: import("@angular/core").InjectionToken<boolean>;

package/tokens/is-e2e.d.ts

@@ -1 +1,4 @@
+/**
+ * Detect if app is running under any of test frameworks
+ */
 export declare const TUI_IS_E2E: import("@angular/core").InjectionToken<boolean>;

package/tokens/is-firefox.d.ts

@@ -1 +1,4 @@
+/**
+ * Firefox browser engine detection
+ */
 export declare const TUI_IS_FIREFOX: import("@angular/core").InjectionToken<boolean>;

package/tokens/is-ios.d.ts

@@ -1 +1,4 @@
+/**
+ * iOS browser detection
+ */
 export declare const TUI_IS_IOS: import("@angular/core").InjectionToken<boolean>;

package/tokens/is-mobile.d.ts

@@ -1 +1,4 @@
+/**
+ * Mobile browser detection
+ */
 export declare const TUI_IS_MOBILE: import("@angular/core").InjectionToken<boolean>;

package/tokens/is-playwright.d.ts

@@ -1 +1,4 @@
+/**
+ * Detect if app is running under Playwright
+ */
 export declare const TUI_IS_PLAYWRIGHT: import("@angular/core").InjectionToken<boolean>;

package/tokens/is-webkit.d.ts

@@ -1 +1,4 @@
+/**
+ * Webkit browser engine detection
+ */
 export declare const TUI_IS_WEBKIT: import("@angular/core").InjectionToken<boolean>;

package/tokens/range.d.ts

@@ -1 +1,4 @@
+/**
+ * SSR safe default empty Range
+ */
 export declare const TUI_RANGE: import("@angular/core").InjectionToken<Range>;

package/tokens/removed-element.d.ts

@@ -1 +1,4 @@
+/**
+ * Element currently being removed by AnimationEngine
+ */
 export declare const TUI_REMOVED_ELEMENT: import("@angular/core").InjectionToken<import("rxjs").Observable<Element | null>>;

package/tokens/scroll-ref.d.ts

@@ -1,2 +1,5 @@
 import { ElementRef } from '@angular/core';
+/**
+ * Scrollable container
+ */
 export declare const TUI_SCROLL_REF: import("@angular/core").InjectionToken<ElementRef<HTMLElement>>;

package/tokens/swipe-options.d.ts

@@ -1,2 +1,5 @@
 import { TuiSwipeOptions } from '@taiga-ui/cdk/interfaces';
+/**
+ * Swipe options
+ */
 export declare const TUI_SWIPE_OPTIONS: import("@angular/core").InjectionToken<TuiSwipeOptions>;

package/tokens/taiga-ui-cdk-tokens.d.ts

@@ -1,2 +1,5 @@
+/**
+ * Generated bundle index. Do not edit.
+ */
 /// <amd-module name="@taiga-ui/cdk/tokens" />
 export * from './index';

package/tokens/take-only-trusted-events.d.ts

@@ -1 +1,7 @@
+/**
+ * @description:
+ * The isTrusted read-only property of the Event interface is a boolean value that is true
+ * when the event was generated by a user action, and false when the event was created or
+ * modified by a script or dispatched via EventTarget.dispatchEvent().
+ */
 export declare const TUI_TAKE_ONLY_TRUSTED_EVENTS: import("@angular/core").InjectionToken<boolean>;

package/tokens/window-height.d.ts

@@ -1 +1,4 @@
+/**
+ * @deprecated Use {@link TUI_WINDOW_SIZE} instead
+ */
 export declare const TUI_WINDOW_HEIGHT: import("@angular/core").InjectionToken<import("rxjs").Observable<number>>;

package/tokens/zoom-options.d.ts

@@ -1,2 +1,5 @@
 import { TuiZoomOptions } from '@taiga-ui/cdk/interfaces';
+/**
+ * Zoom options
+ */
 export declare const TUI_ZOOM_OPTIONS: import("@angular/core").InjectionToken<TuiZoomOptions>;

package/types/autocomplete.d.ts

@@ -1 +1,2 @@
+/** @deprecated remove in 4.0 */
 export declare type TuiAutofillFieldName = 'additional-name' | 'bday' | 'cc-csc' | 'cc-exp-month' | 'cc-exp-year' | 'cc-exp' | 'cc-name' | 'cc-number' | 'cc-type' | 'country-name' | 'current-password' | 'email' | 'family-name' | 'given-name' | 'name' | 'new-password' | 'off' | 'postal-code' | 'street-address' | 'tel' | 'transaction-amount' | 'transaction-currency' | 'username';

package/types/date-mode.d.ts

@@ -1 +1,6 @@
+/**
+ * * DMY - dd.mm.yyyy
+ * * MDY - mm.dd.yyyy
+ * * YMD - yyyy.mm.dd
+ */
 export declare type TuiDateMode = 'DMY' | 'MDY' | 'YMD';

package/types/event-with.d.ts

@@ -2,6 +2,9 @@ export interface TuiTypedEventTarget<E> {
     addEventListener(type: string, listener: ((evt: E) => void) | null, options?: AddEventListenerOptions | boolean): void;
     removeEventListener(type: string, listener?: ((evt: E) => void) | null, options?: EventListenerOptions | boolean): void;
 }
+/**
+ * Wrapper around {@link Event} to add typings to target and currentTarget.
+ */
 export declare type TuiEventWith<G extends Event, T extends TuiTypedEventTarget<G>> = G & {
     readonly currentTarget: T;
 };

package/types/mapper.d.ts

@@ -1,2 +1,11 @@
+/**
+ * Typed mapping function.
+ *
+ * @deprecated Will be removed in v4.0. Use {@link TuiTypedMapper} instead.
+ */
 export declare type TuiMapper<T, G> = (item: T, ...args: any[]) => G;
+/**
+ * Typed mapping function.
+ * TODO: rename TuiTypedMapper to TuiMapper in v4.0
+ */
 export declare type TuiTypedMapper<T extends unknown[], G> = (...args: T) => G;

package/types/matcher.d.ts

@@ -1,6 +1,14 @@
 import { TuiStringHandler } from './handler';
 import { TuiMapper, TuiTypedMapper } from './mapper';
+/**
+ * A matcher function to test items against with extra arguments.
+ *
+ * @deprecated Will be removed in v4.0. Use {@link TuiTypedMatcher} instead.
+ */
 export declare type TuiMatcher<I> = TuiMapper<I, boolean>;
+/**
+ * A matcher function to test items against with extra arguments.
+ */
 export declare type TuiTypedMatcher<I extends unknown[]> = TuiTypedMapper<I, boolean>;
 export declare type TuiStringMatcher<I> = (item: I, matchValue: string, stringify: TuiStringHandler<I>) => boolean;
 export declare type TuiIdentityMatcher<I> = (item1: I, item2: I) => boolean;

package/types/taiga-ui-cdk-types.d.ts

@@ -1,2 +1,5 @@
+/**
+ * Generated bundle index. Do not edit.
+ */
 /// <amd-module name="@taiga-ui/cdk/types" />
 export * from './index';

package/utils/browser/taiga-ui-cdk-utils-browser.d.ts

@@ -1,2 +1,5 @@
+/**
+ * Generated bundle index. Do not edit.
+ */
 /// <amd-module name="@taiga-ui/cdk/utils/browser" />
 export * from './index';

package/utils/color/hsv-to-rgb.d.ts

@@ -1 +1,4 @@
+/**
+ * https://stackoverflow.com/a/54024653/2706426
+ */
 export declare function tuiHsvToRgb(h: number, s: number, v: number): [number, number, number];

package/utils/color/taiga-ui-cdk-utils-color.d.ts

@@ -1,2 +1,5 @@
+/**
+ * Generated bundle index. Do not edit.
+ */
 /// <amd-module name="@taiga-ui/cdk/utils/color" />
 export * from './index';

package/utils/dom/get-actual-target.d.ts

@@ -1 +1,4 @@
+/**
+ * Gets actual target from open Shadow DOM if event happened within it
+ */
 export declare function tuiGetActualTarget(event: Event): Node;

package/utils/dom/get-clipboard-data-text.d.ts

@@ -1 +1,4 @@
+/**
+ * Gets text from data of clipboardEvent, it also works in IE and Edge browsers
+ */
 export declare function tuiGetClipboardDataText(event: ClipboardEvent, format?: string): string;

package/utils/dom/get-element-obscurers.d.ts

@@ -1 +1,10 @@
+/**
+ * Returns array of Elements covering edges of given element or null if at least one edge middle point is visible
+ *
+ * CAUTION: Empty array means element if offscreen i.e. covered by no elements, rather than not covered
+ * TODO: v4.0 change function signature to
+ * ```ts
+ * function tuiGetElementObscures(element: Element): readonly [Element, Element, Element, Element] | [] | null
+ * ```
+ */
 export declare function tuiGetElementObscures(element: Element): readonly Element[] | null;

package/utils/dom/get-element-offset.d.ts

@@ -1,3 +1,10 @@
+/**
+ * Calculates offset for an element relative to it's parent several levels above
+ *
+ * @param host parent element
+ * @param element
+ * @return object with offsetTop and offsetLeft number properties
+ */
 export declare function tuiGetElementOffset(host: Element, element: HTMLElement): {
     offsetLeft: number;
     offsetTop: number;