@ethlete/core 3.1.0 → 3.3.0

package/lib/types/public-api.d.ts

@@ -1,3 +1,4 @@
 export * from './angular.types';
 export * from './i18n.types';
+export * from './value.types';
 export * from './viewport.types';

package/lib/types/value.types.d.ts

@@ -0,0 +1,2 @@
+export type Primitive = string | number | boolean | null | undefined | symbol | bigint;
+export type Reference = Record<string, unknown> | Array<unknown>;

package/lib/utils/key-press-manager.utils.d.ts

@@ -0,0 +1,9 @@
+export declare class KeyPressManager {
+    readonly key: number;
+    private readonly _isKeyPressed$;
+    private readonly _keyPressCount$;
+    private readonly _stopTimeout$;
+    constructor(key: number);
+    isPressed(event: KeyboardEvent): boolean;
+    clear(): void;
+}

package/lib/utils/public-api.d.ts

@@ -5,6 +5,7 @@ export * from './clone.util';
 export * from './cookie.util';
 export * from './destroy.utils';
 export * from './equal.util';
+export * from './key-press-manager.utils';
 export * from './media-query-observable.util';
 export * from './mutation-observable.util';
 export * from './reactive-binding.util';
@@ -13,4 +14,5 @@ export * from './runtime-error.utils';
 export * from './scrollable.utils';
 export * from './selection-model.utils';
 export * from './smart-block-scroll-strategy.utils';
+export * from './value.utils';
 export * from './viewport.util';

package/lib/utils/runtime-error.utils.d.ts

@@ -1,6 +1,8 @@
+export declare const RUNTIME_ERROR_NO_DATA = "__ET_NO_DATA__";
 export declare class RuntimeError<T extends number> extends Error {
     code: T;
+    devOnly: boolean;
     data: unknown;
-    constructor(code: T, message: null | false | string, data?: unknown);
+    constructor(code: T, message: null | false | string, devOnly?: boolean, data?: unknown);
 }
-export declare function formatRuntimeError<T extends number>(code: T, message: null | false | string): string;
+export declare function formatRuntimeError<T extends number>(code: T, message: null | false | string, devOnly: boolean): string;

package/lib/utils/selection-model.utils.d.ts

@@ -1,4 +1,19 @@
-type SelectionModelTypes = string | number | Record<string, unknown> | unknown;
+export type SelectionModelTypes = string | number | Record<string, unknown> | unknown;
+export type SelectionModelPropertyPath = string;
+export type SelectionModelOptionValueFn<T extends SelectionModelTypes = any> = (option: T) => unknown;
+/**
+ * You can use a property path or a function to get the value of an option. The function should be as **lightweight as possible** as it will be called **a lot**.
+ *
+ * @example
+ * // Property path
+ * "id" // option.id
+ * "user.name" // option.user.name
+ *
+ * // Function
+ * (option) => option.id // option.id
+ * (option) => option.user.name // option.user.name
+ */
+export type SelectionModelBinding<T extends SelectionModelTypes = any> = SelectionModelPropertyPath | SelectionModelOptionValueFn<T>;
 export declare class SelectionModel<T extends SelectionModelTypes = unknown> {
     get selection$(): import("rxjs").Observable<T[]>;
     get selection(): T[];
@@ -6,14 +21,14 @@ export declare class SelectionModel<T extends SelectionModelTypes = unknown> {
     get options$(): import("rxjs").Observable<T[]>;
     get options(): T[];
     private readonly _options$;
-    get valueBinding$(): import("rxjs").Observable<string | null>;
-    get valueBinding(): string | null;
+    get valueBinding$(): import("rxjs").Observable<SelectionModelBinding<T> | null>;
+    get valueBinding(): SelectionModelBinding<T> | null;
     private readonly _valueBinding$;
-    get keyBinding$(): import("rxjs").Observable<string | null>;
-    get keyBinding(): string | null;
+    get keyBinding$(): import("rxjs").Observable<SelectionModelBinding<T> | null>;
+    get keyBinding(): SelectionModelBinding<T> | null;
     private readonly _keyBinding$;
-    get labelBinding$(): import("rxjs").Observable<string | null>;
-    get labelBinding(): string | null;
+    get labelBinding$(): import("rxjs").Observable<SelectionModelBinding<T> | null>;
+    get labelBinding(): SelectionModelBinding<T> | null;
     private readonly _labelBinding$;
     get allowMultiple$(): import("rxjs").Observable<boolean>;
     get allowMultiple(): boolean;
@@ -25,9 +40,9 @@ export declare class SelectionModel<T extends SelectionModelTypes = unknown> {
     readonly filteredOptions$: import("rxjs").Observable<T[]>;
     private readonly _optionsAndSelection$;
     setSelection(selection: T | T[]): this;
-    setValueBinding(propertyPath: string | null): this;
-    setKeyBinding(propertyPath: string | null): this;
-    setLabelBinding(propertyPath: string | null): this;
+    setValueBinding(fnOrPropertyPath: SelectionModelBinding<T> | null): this;
+    setKeyBinding(fnOrPropertyPath: SelectionModelBinding<T> | null): this;
+    setLabelBinding(fnOrPropertyPath: SelectionModelBinding<T> | null): this;
     setOptions(options: T[]): this;
     setAllowMultiple(allowMultiple: boolean): this;
     setFilter(filter: string | null): void;
@@ -42,7 +57,7 @@ export declare class SelectionModel<T extends SelectionModelTypes = unknown> {
     getOptionByValue(value: unknown): T | undefined;
     getOptionByLabel(label: string): T | undefined;
     getOptionByKey(key: string): T | undefined;
-    getOption(value: unknown, propertyPath?: string | null, options?: T[]): T | undefined;
+    getOption(value: unknown, propertyPath?: SelectionModelBinding<T> | null, options?: T[]): T | undefined;
     getOptionByIndex(index: number, options?: T[]): T | null;
     getOptionByOffset(offset: number, index: number, options?: T[], config?: {
         loop?: boolean;
@@ -60,6 +75,7 @@ export declare class SelectionModel<T extends SelectionModelTypes = unknown> {
     getLabel(option: T): unknown;
     getValue(option: T): unknown;
     getKey(option: T): unknown;
+    execFnOrGetOptionProperty(option: T, fnOrPropertyPath: SelectionModelBinding<T> | null): unknown;
     getOptionProperty(option: T, propertyPath: string | null): unknown;
     isSelected(option: T): boolean;
     getFilteredOptions(filter?: string, options?: T[]): T[];
@@ -69,4 +85,3 @@ export declare class SelectionModel<T extends SelectionModelTypes = unknown> {
     toggleSelectedOption(option: T): void;
     toggleAllSelectedOptions(): void;
 }
-export {};

package/lib/utils/value.utils.d.ts

@@ -0,0 +1,4 @@
+import { Primitive } from '../types';
+export declare const isPrimitiveArray: (value: unknown) => value is Primitive[];
+export declare const isObjectArray: (value: unknown) => value is Record<string, unknown>[];
+export declare const isEmptyArray: (value: unknown) => value is [];

package/package.json

@@ -1,19 +1,19 @@
 {
   "name": "@ethlete/core",
-  "version": "3.1.0",
+  "version": "3.3.0",
   "dependencies": {
     "tslib": "^2.5.0"
   },
   "peerDependencies": {
     "@angular/common": "^15.2.1 || ^16.0.0",
     "@angular/core": "^15.2.1 || ^16.0.0",
-    "@angular/platform-browser": "16.2.0",
+    "@angular/platform-browser": "16.2.1",
     "@ethlete/types": "1.4.0",
     "rxjs": "7.8.1",
-    "@angular/cdk": "16.2.0",
+    "@angular/cdk": "16.2.1",
     "@floating-ui/dom": "1.5.1",
-    "@angular/router": "16.2.0",
-    "@angular/forms": "16.2.0"
+    "@angular/router": "16.2.1",
+    "@angular/forms": "16.2.1"
   },
   "module": "fesm2022/ethlete-core.mjs",
   "typings": "index.d.ts",