@mgdis/stencil-helpers 2.2.6 → 3.1.0

package/README.md

@@ -1,6 +1,8 @@
 # @mgdis/stencil-helpers
 
-This package centralizes helper functions for your [Stencil](https://stenciljs.com/) projects. It is divided into four thematic sections:
+This package centralizes helper functions for your [Stencil](https://stenciljs.com/) projects.
+
+It is divided into four thematic sections:
 
 - **Components**: Centralizes all component utilities.
 - **Locale**: Centralizes all necessary locale utilities for managing content translation.
@@ -12,7 +14,3 @@ This package centralizes helper functions for your [Stencil](https://stenciljs.c
 ```bash
 pnpm i @mgdis/stencil-helpers
 ```
-
-## Documentation
-
-Read the full [documentation](./docs/README.md)

package/dist/components/index.d.ts

@@ -110,5 +110,91 @@ export declare const cleanString: (text: string) => string;
  * @param callback - code to excute on next tick
  * @returns differed code excution
  */
-export declare const nextTick: (callback: () => void) => Promise<void>;
+export declare const nextTick: (callback?: () => void) => Promise<void>;
+/**
+ * Check if a value is of object type.
+ * @param object - The value to validate.
+ * @returns `true` if the value is a valid object (non-null and not an array), otherwise `false`.
+ */
+export declare const isObject: <T>(object: unknown) => object is T;
+/**
+ * Get object value from key
+ * @param object - object to query
+ * @param path - path of the property to get. Nested keys are allowed with `.` separators (eg: 'key0.key1.key2' = object[key0][key1][key2])
+ * @param defaultValue - The value returned for `undefined` resolved values
+ * @returns object value
+ */
+export declare const getObjectValueFromKey: <T, R>(object: T, path: string, defaultValue?: R) => R | undefined;
+/**
+ * Define getPage methode interface
+ */
+export interface IGetPage<T> {
+    (offset?: number, filter?: Parameters<Array<T>['filter']>[0]): Page<T>;
+}
+/**
+ * Cursor type
+ */
+export type CursorType = 'first' | 'next' | 'previous' | 'last';
+/**
+ * Cursor possible values
+ */
+export declare const Cursor: Record<string, CursorType>;
+/**
+ * Define a valid Page object and navigate throw page items with cursor.
+ * Page object entries follow the REST API page practices.
+ */
+export declare class Page<T> {
+    /**
+     * Define items
+     */
+    items: T[];
+    /**
+     * Define total
+     */
+    total: number;
+    /**
+     * Define top
+     */
+    top: number;
+    /**
+     * Define next
+     */
+    next?: IGetPage<T> | string | URL;
+    /**
+     * Define base index
+     */
+    readonly baseIndex = 1;
+    constructor(init: Partial<Pick<Page<T>, 'items' | 'top' | 'total' | 'next'>>);
+    /**
+     * Get index of items from cursor
+     * @param cursor - cursor to find
+     * @param oldItem - previous item
+     * @returns item index
+     */
+    getIndexFromCursor: (cursor?: CursorType, oldItem?: T) => number | null;
+}
+/**
+ * Paginate an items array to navigate into with pages.
+ * It follow REST standard and allow to navigate in items array with a similar format.
+ */
+export declare class Paginate<T> {
+    #private;
+    /**
+     * Define paginated items
+     */
+    items: Page<T>['items'];
+    constructor(items: Page<T>['items'], options?: {
+        step?: number;
+        top?: Page<T>['top'];
+        total?: Page<T>['total'];
+        next?: Page<T>['next'];
+    });
+    /**
+     * Get page
+     * @param offset - pagiantion offset
+     * @param filter - filter methode
+     * @returns formated page
+     */
+    getPage: IGetPage<T>;
+}
 //# sourceMappingURL=index.d.ts.map

package/dist/components/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/components/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,eAAO,MAAM,QAAQ,GAAI,eAAW,EAAE,eAAW,KAAG,MAWnD,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,UAAU,GAAI,UAAU,OAAO,KAAG,OAA+F,CAAC;AAE/I;;GAEG;AACH,qBAAa,SAAS;IACpB;;OAEG;IACH,OAAO,EAAE,MAAM,EAAE,CAAC;gBAEN,SAAS,GAAE,MAAM,EAAO;IAIpC;;;OAGG;IACH,GAAG,GAAI,WAAW,MAAM,KAAG,IAAI,CAI7B;IAEF;;;OAGG;IACH,MAAM,GAAI,WAAW,MAAM,KAAG,IAAI,CAKhC;IAEF;;;;OAIG;IACH,GAAG,GAAI,WAAW,MAAM,KAAG,OAAO,CAEhC;IAEF;;;OAGG;IACH,IAAI,QAAO,MAAM,CAEf;CACH;AAED;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,GAAI,OAAO,OAAO,KAAG,KAAK,IAAI,MAAM,EAA2E,CAAC;AAE9I;;;;;GAKG;AACH,eAAO,MAAM,SAAS,GAAI,SAAS,OAAO,EAAE,UAAU,MAAM,EAAE,KAAG,OAEhE,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,iBAAiB,kHAAgH,CAAC;AAE/I;;;;GAIG;AACH,eAAO,MAAM,UAAU,GAAI,aAAa,MAAM,KAAG,MAAM,EAItD,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,gBAAgB,GAAI,aAAa,MAAM,EAAE,UAAS,MAAM,EAAO,KAAG,MAAM,EAgBpF,CAAC;AAkBF;;;;GAIG;AACH,eAAO,MAAM,aAAa,GAAI,OAAO,OAAO,KAAG,KAAK,IAAI,MAA0D,CAAC;AAEnH;;;;GAIG;AACH,eAAO,MAAM,QAAQ,GAAI,OAAO,OAAO,KAAG,MAGzC,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,aAAa,GAAI,OAAO,OAAO,KAAG,KAAK,IAAI,MAA2D,CAAC;AAEpH;;;;;;;;;GASG;AACH,eAAO,MAAM,WAAW,GAAI,MAAM,MAAM,KAAG,MAMjC,CAAC;AAEX;;;;GAIG;AACH,eAAO,MAAM,QAAQ,GAAU,UAAU,MAAM,IAAI,KAAG,OAAO,CAAC,IAAI,CAAe,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/components/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,eAAO,MAAM,QAAQ,GAAI,eAAW,EAAE,eAAW,KAAG,MAWnD,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,UAAU,GAAI,UAAU,OAAO,KAAG,OAA+F,CAAC;AAE/I;;GAEG;AACH,qBAAa,SAAS;IACpB;;OAEG;IACH,OAAO,EAAE,MAAM,EAAE,CAAC;gBAEN,SAAS,GAAE,MAAM,EAAO;IAIpC;;;OAGG;IACH,GAAG,GAAI,WAAW,MAAM,KAAG,IAAI,CAI7B;IAEF;;;OAGG;IACH,MAAM,GAAI,WAAW,MAAM,KAAG,IAAI,CAKhC;IAEF;;;;OAIG;IACH,GAAG,GAAI,WAAW,MAAM,KAAG,OAAO,CAEhC;IAEF;;;OAGG;IACH,IAAI,QAAO,MAAM,CAEf;CACH;AAED;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,GAAI,OAAO,OAAO,KAAG,KAAK,IAAI,MAAM,EAA2E,CAAC;AAE9I;;;;;GAKG;AACH,eAAO,MAAM,SAAS,GAAI,SAAS,OAAO,EAAE,UAAU,MAAM,EAAE,KAAG,OAEhE,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,iBAAiB,kHAAgH,CAAC;AAE/I;;;;GAIG;AACH,eAAO,MAAM,UAAU,GAAI,aAAa,MAAM,KAAG,MAAM,EAItD,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,gBAAgB,GAAI,aAAa,MAAM,EAAE,UAAS,MAAM,EAAO,KAAG,MAAM,EAgBpF,CAAC;AAkBF;;;;GAIG;AACH,eAAO,MAAM,aAAa,GAAI,OAAO,OAAO,KAAG,KAAK,IAAI,MAA0D,CAAC;AAEnH;;;;GAIG;AACH,eAAO,MAAM,QAAQ,GAAI,OAAO,OAAO,KAAG,MAGzC,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,aAAa,GAAI,OAAO,OAAO,KAAG,KAAK,IAAI,MAA2D,CAAC;AAEpH;;;;;;;;;GASG;AACH,eAAO,MAAM,WAAW,GAAI,MAAM,MAAM,KAAG,MAMjC,CAAC;AAEX;;;;GAIG;AACH,eAAO,MAAM,QAAQ,GAAU,WAAW,MAAM,IAAI,KAAG,OAAO,CAAC,IAAI,CAElE,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,QAAQ,GAAI,CAAC,EAAE,QAAQ,OAAO,KAAG,MAAM,IAAI,CAA4E,CAAC;AAErI;;;;;;GAMG;AACH,eAAO,MAAM,qBAAqB,GAAI,CAAC,EAAE,CAAC,EAAE,QAAQ,CAAC,EAAE,MAAM,MAAM,EAAE,eAAe,CAAC,KAAG,CAAC,GAAG,SAW3F,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,QAAQ,CAAC,CAAC;IACzB,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;CACxE;AAED;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,OAAO,GAAG,MAAM,GAAG,UAAU,GAAG,MAAM,CAAC;AAEhE;;GAEG;AACH,eAAO,MAAM,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,CAKpC,CAAC;AAIX;;;GAGG;AACH,qBAAa,IAAI,CAAC,CAAC;IACjB;;OAEG;IACI,KAAK,EAAE,CAAC,EAAE,CAAM;IACvB;;OAEG;IACI,KAAK,EAAE,MAAM,CAAC;IACrB;;OAEG;IACI,GAAG,EAAE,MAAM,CAAe;IACjC;;OAEG;IACI,IAAI,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,GAAG,MAAM,GAAG,GAAG,CAAC;IACzC;;OAEG;IACH,SAAgB,SAAS,KAAK;gBAElB,IAAI,EAAE,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,OAAO,GAAG,KAAK,GAAG,OAAO,GAAG,MAAM,CAAC,CAAC;IAW5E;;;;;OAKG;IACI,kBAAkB,GAAI,SAAQ,UAAoB,EAAE,UAAU,CAAC,KAAG,MAAM,GAAG,IAAI,CAwBpF;CACH;AAED;;;GAGG;AACH,qBAAa,QAAQ,CAAC,CAAC;;IACrB;;OAEG;IACI,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAM;gBAOxB,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,GAAG,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;QAAC,KAAK,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;QAAC,IAAI,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAA;KAAE;IAOxI;;;;;OAKG;IACI,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC,CAYzB;CACH"}