@rt-tools/core 0.0.6 → 0.2.0

package/types/rt-tools-core.d.ts

@@ -1,8 +1,181 @@
-import { Observable } from 'rxjs';
+import { ConnectedPosition } from '@angular/cdk/overlay';
 import * as i0 from '@angular/core';
-import { InjectionToken, OnChanges, ElementRef, Renderer2, PipeTransform, Provider } from '@angular/core';
+import { InputSignalWithTransform, InputSignal, OnInit, Signal, OnDestroy, OutputEmitterRef, PipeTransform, Provider, InjectionToken, OnChanges, ElementRef, Renderer2 } from '@angular/core';
+import { BooleanInput } from '@angular/cdk/coercion';
+import { Nullable } from '@rt-tools/utils';
+import { SafeHtml } from '@angular/platform-browser';
+import { Observable } from 'rxjs';
+import { ValidatorFn, AbstractControl, ValidationErrors } from '@angular/forms';
+
+declare const OVERLAY_POSITIONS: Readonly<ConnectedPosition[]>;
+
+declare class RtIconOutlinedDirective {
+    isOutlined: InputSignalWithTransform<boolean, BooleanInput>;
+    get fontVariationSettings(): string;
+    static ɵfac: i0.ɵɵFactoryDeclaration<RtIconOutlinedDirective, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<RtIconOutlinedDirective, "mat-icon[rtIconOutlined]", never, { "isOutlined": { "alias": "rtIconOutlined"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
+}
+
+declare class RtScrollToElementDirective {
+    #private;
+    rtScrollToElement: InputSignal<string | number>;
+    elements: InputSignalWithTransform<unknown[], unknown[]>;
+    constructor();
+    static ɵfac: i0.ɵɵFactoryDeclaration<RtScrollToElementDirective, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<RtScrollToElementDirective, "[rtScrollToElement]", never, { "rtScrollToElement": { "alias": "rtScrollToElement"; "required": true; "isSignal": true; }; "elements": { "alias": "elements"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>;
+}
+
+declare class RtNavigationDirective {
+    #private;
+    link: InputSignal<Nullable<string>>;
+    onClick(event: MouseEvent): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<RtNavigationDirective, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<RtNavigationDirective, "[rtNavigationDirective]", never, { "link": { "alias": "rtNavigationDirective"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>;
+}
+
+declare abstract class RtTabQueryParamDirective implements OnInit {
+    #private;
+    readonly currentTabIndex: Signal<number>;
+    ngOnInit(): void;
+    setQueryTab(index: number): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<RtTabQueryParamDirective, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<RtTabQueryParamDirective, never, never, {}, {}, never, never, true, never>;
+}
+
+declare class RtScrollDirective implements OnInit, OnDestroy {
+    #private;
+    active: InputSignal<boolean>;
+    multiplier: InputSignal<number>;
+    readonly scrollAction: OutputEmitterRef<void>;
+    ngOnInit(): void;
+    ngOnDestroy(): void;
+    scroll: EventListener;
+    static ɵfac: i0.ɵɵFactoryDeclaration<RtScrollDirective, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<RtScrollDirective, "[rtScrollDirective]", never, { "active": { "alias": "active"; "required": false; "isSignal": true; }; "multiplier": { "alias": "multiplier"; "required": false; "isSignal": true; }; }, { "scrollAction": "scrollAction"; }, never, never, true, never>;
+}
+
+declare class RtEscapeKeyDirective {
+    readonly escapeKeyAction: OutputEmitterRef<void>;
+    handleKeyboardEvent(event: KeyboardEvent): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<RtEscapeKeyDirective, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<RtEscapeKeyDirective, "[rtEscapeKey]", never, {}, { "escapeKeyAction": "escapeKeyAction"; }, never, never, true, never>;
+}
+
+declare enum POSITION_ENUM {
+    LEFT = "left",
+    RIGHT = "right",
+    TOP = "top",
+    BOTTOM = "bottom",
+    START = "start",
+    END = "end",
+    CENTER = "center"
+}
+
+/**
+ * This function is a type guard that checks if a value is an instance of HTMLElement.
+ */
+declare function isHTMLElement(element: any): element is HTMLElement;
+
+declare class BreakStringPipe implements PipeTransform {
+    transform(value: Nullable<string>): string;
+    static ɵfac: i0.ɵɵFactoryDeclaration<BreakStringPipe, never>;
+    static ɵpipe: i0.ɵɵPipeDeclaration<BreakStringPipe, "breakString", true>;
+}
+
+declare class SanitizePipe implements PipeTransform {
+    #private;
+    transform(value: string): SafeHtml;
+    static ɵfac: i0.ɵɵFactoryDeclaration<SanitizePipe, never>;
+    static ɵpipe: i0.ɵɵPipeDeclaration<SanitizePipe, "sanitize", true>;
+}
+
+declare class EntityToStringPipe implements PipeTransform {
+    transform<T>(value: T): string;
+    static ɵfac: i0.ɵɵFactoryDeclaration<EntityToStringPipe, never>;
+    static ɵpipe: i0.ɵɵPipeDeclaration<EntityToStringPipe, "entityToString", true>;
+}
+
+declare class EmptyToDashPipe implements PipeTransform {
+    transform<T>(value: T | null | undefined): T | string;
+    static ɵfac: i0.ɵɵFactoryDeclaration<EmptyToDashPipe, never>;
+    static ɵpipe: i0.ɵɵPipeDeclaration<EmptyToDashPipe, "emptyToDash", true>;
+}
+
+/**
+ * @description Use to compare equality to any of items with provided value
+ * @example
+ *
+ * Direct usage
+ * ```ts
+ *   equalPipe.transform(100, 1, 10, 100) // => true
+ * ```
+ *
+ * Template usage
+ *
+ * ```html
+ *   <div *ngIf="100 | equal:1:10:100">Visible</div>
+ * ```
+ */
+declare class EqualPipe implements PipeTransform {
+    transform(value: any, ...compares: any[]): boolean;
+    static ɵfac: i0.ɵɵFactoryDeclaration<EqualPipe, never>;
+    static ɵpipe: i0.ɵɵPipeDeclaration<EqualPipe, "equal", true>;
+}
+
+/**
+ * @description Use to access to the deep object state for comparison
+ * @example
+ *  {a: {b: true}} | equalChain:'a':'b':true => true
+ */
+declare class EqualChainPipe implements PipeTransform {
+    transform(obj: object, ...args: any[]): boolean;
+    static ɵfac: i0.ɵɵFactoryDeclaration<EqualChainPipe, never>;
+    static ɵpipe: i0.ɵɵPipeDeclaration<EqualChainPipe, "equalChain", true>;
+}
+
+/**
+ * @description Use to compare not equality to all items with provided value
+ * @example
+ *
+ * Direct usage
+ * ```ts
+ *   notEqualPipe.transform(100, 1, 10, 100) // => false
+ * ```
+ *
+ * Template usage
+ *
+ * ```html
+ *   <div *ngIf="100 | notEqual:1:10:100">Invisible</div>
+ * ```
+ */
+declare class NotEqualPipe implements PipeTransform {
+    transform(value: any, ...compares: any[]): boolean;
+    static ɵfac: i0.ɵɵFactoryDeclaration<NotEqualPipe, never>;
+    static ɵpipe: i0.ɵɵPipeDeclaration<NotEqualPipe, "notEqual", true>;
+}
+
+/**
+ * @description Use to access to the deep object state for comparison
+ * @example
+ *  {a: {b: true}} | equalChain:'a':'b':false => true
+ */
+declare class NotEqualChainPipe implements PipeTransform {
+    transform(obj: object, ...args: any[]): boolean;
+    static ɵfac: i0.ɵɵFactoryDeclaration<NotEqualChainPipe, never>;
+    static ɵpipe: i0.ɵɵPipeDeclaration<NotEqualChainPipe, "notEqualChain", true>;
+}
+
+declare class TernaryPipe implements PipeTransform {
+    transform(value: any, option1: any, option2: any): any;
+    static ɵfac: i0.ɵɵFactoryDeclaration<TernaryPipe, never>;
+    static ɵpipe: i0.ɵɵPipeDeclaration<TernaryPipe, "ternary", true>;
+}
 
-declare function isNil<T>(entity: T | null | undefined): entity is null | undefined;
+declare class IsEmailPipe implements PipeTransform {
+    transform(value: any): boolean;
+    static ɵfac: i0.ɵɵFactoryDeclaration<IsEmailPipe, never>;
+    static ɵpipe: i0.ɵɵPipeDeclaration<IsEmailPipe, "isEmail", true>;
+}
 
 interface MessageBusEvent<T = string> {
     readonly type: T;
@@ -27,14 +200,122 @@ declare class PlatformService {
     static ɵprov: i0.ɵɵInjectableDeclaration<PlatformService>;
 }
 
+declare namespace OSTypes {
+    const WINDOWS: string;
+    const MAC_OS: string;
+    const LINUX: string;
+    const ANDROID: string;
+    const IOS: string;
+    const UNKNOWN: string;
+}
+declare class DeviceDetectorService {
+    #private;
+    userAgent: Nullable<string>;
+    constructor();
+    isMobile(): boolean;
+    isTablet(): boolean;
+    isDesktop(): boolean;
+    getOS(): string;
+    static ɵfac: i0.ɵɵFactoryDeclaration<DeviceDetectorService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<DeviceDetectorService>;
+}
+
+interface IBreakpoints {
+    xl: string;
+    lg: string;
+    md: string;
+    sm: string;
+    xs: string;
+}
+
+/**
+ * A service that manages responsive design breakpoints using Angular's `BreakpointObserver`.
+ * This service provides signals for different screen sizes and allows dynamic
+ * breakpoint management.
+ *
+ * @Injectable
+ */
+declare class BreakpointService {
+    #private;
+    readonly isDesktop: Signal<Nullable<boolean>>;
+    readonly isSmallDesktop: Signal<Nullable<boolean>>;
+    readonly isMobile: Signal<Nullable<boolean>>;
+    readonly isTablet: Signal<Nullable<boolean>>;
+    readonly isSmallTablet: Signal<Nullable<boolean>>;
+    /**
+     * Allows setting custom breakpoints for different screen sizes.
+     *
+     * @param breakpoints - The custom breakpoints to apply.
+     */
+    setBreakpoints(breakpoints: IBreakpoints): void;
+    /**
+     * Helper function to decrement the pixel value by 1.
+     * Used to exclude the exact pixel value in media queries.
+     *
+     * @usageNotes
+     *
+     * This function is useful for setting correct media queries.
+     * E.g. for mobile devices: media query should be `(max-width: 599px)`,
+     * and from `(min-width: 600px)` it should be considered as a tablet.
+     *
+     * @param value - The pixel value to decrement.
+     * @returns The adjusted pixel value as a string.
+     */
+    decrementOnePixel(value: string): string;
+    static ɵfac: i0.ɵɵFactoryDeclaration<BreakpointService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<BreakpointService>;
+}
+
+declare class Breakpoints implements IBreakpoints {
+    readonly xl: string;
+    readonly lg: string;
+    readonly md: string;
+    readonly sm: string;
+    readonly xs: string;
+}
+
+declare function checkIsMatchingValues(sample: string): ValidatorFn;
+
+declare function arraysNotEmptyValidator(control: AbstractControl): ValidationErrors | null;
+
+/**
+ * @description Reactive-forms validator over the framework-free `isEmail` predicate.
+ *
+ * Reports `{ email: true }` on a malformed address. An empty control passes, matching `isEmail` —
+ * combine it with `Validators.required` where the field is mandatory.
+ */
+declare function emailValidator(control: AbstractControl): ValidationErrors | null;
+
+/**
+ * Returns a set of dependency injection providers for utility services.
+ *
+ * @usageNotes
+ *
+ * This function provides utility services that are commonly used across
+ * an Angular application. Specifically, it provides the `BreakpointService`
+ * for managing responsive design breakpoints and the `PlatformService` for
+ * detecting the platform on which the application is running (e.g., browser or server).
+ *
+ * ```typescript
+ * bootstrapApplication(RootComponent, {
+ *   providers: [
+ *     provideRtUtils()
+ *   ]
+ * });
+ * ```
+ *
+ * @publicApi
+ */
+declare function provideRtUtils(): Provider[];
+
 declare const WINDOW: InjectionToken<Window>;
 
+declare const NAVIGATOR: InjectionToken<Navigator>;
+
 interface IDictionary<T> {
     [Key: string]: T;
 }
 
-type Nullable<T> = T | undefined | null;
-
 type Primitive = string | number | bigint | boolean | symbol | null | undefined;
 
 type IModsObject = Record<string, unknown>;
@@ -363,5 +644,5 @@ declare function provideRtIDBStorage(): Provider[];
  */
 declare const IDB_STORAGE_SERVICE_TOKEN: InjectionToken<IDBStorageService<any>>;
 
-export { BlockDirective, CUSTOM_STORAGE, ConcatClassesPipe, ElemDirective, IDBStorageService, IDB_STORAGE_SERVICE_TOKEN, IN_MEMORY_STORAGE, InMemoryStorageService, JsonConverter, LOCAL_STORAGE, MessageBus, ModDirective, PlatformService, SESSION_STORAGE, STORAGE_TYPES_ENUM, StorageService, WINDOW, iDBStorageFactory, inMemoryStorageFactory, isNil, localStorageFactory, provideRtIDBStorage, provideRtStorage, sessionStorageFactory };
-export type { IBemConfig, IDictionary, IIDBStorageServiceInterface, IModsObject, IStorageConfig, IStorageConverter, MessageBusEvent, Nullable, Primitive, StorageType };
+export { BlockDirective, BreakStringPipe, BreakpointService, Breakpoints, CUSTOM_STORAGE, ConcatClassesPipe, DeviceDetectorService, ElemDirective, EmptyToDashPipe, EntityToStringPipe, EqualChainPipe, EqualPipe, IDBStorageService, IDB_STORAGE_SERVICE_TOKEN, IN_MEMORY_STORAGE, InMemoryStorageService, IsEmailPipe, JsonConverter, LOCAL_STORAGE, MessageBus, ModDirective, NAVIGATOR, NotEqualChainPipe, NotEqualPipe, OSTypes, OVERLAY_POSITIONS, POSITION_ENUM, PlatformService, RtEscapeKeyDirective, RtIconOutlinedDirective, RtNavigationDirective, RtScrollDirective, RtScrollToElementDirective, RtTabQueryParamDirective, SESSION_STORAGE, STORAGE_TYPES_ENUM, SanitizePipe, StorageService, TernaryPipe, WINDOW, arraysNotEmptyValidator, checkIsMatchingValues, emailValidator, iDBStorageFactory, inMemoryStorageFactory, isHTMLElement, localStorageFactory, provideRtIDBStorage, provideRtStorage, provideRtUtils, sessionStorageFactory };
+export type { IBemConfig, IBreakpoints, IDictionary, IIDBStorageServiceInterface, IModsObject, IStorageConfig, IStorageConverter, MessageBusEvent, Primitive, StorageType };