@mgdis/stencil-helpers 3.2.0 → 3.2.2

package/dist/components/index.d.ts

@@ -1,206 +1,2 @@
-/**
- * Create random ID
- * @param prefix - add prefix to created ID
- * @param length - ID length
- * @returns ID
- */
-export declare const createID: (prefix?: string, length?: number) => string;
-/**
- * Validate html `id` format
- * @param newValue - id value to validate
- * @returns true if `id` is valid
- */
-export declare const isValideID: (newValue: unknown) => boolean;
-/**
- * Format id from value
- * @param value - id to transforme
- * @returns valid id
- */
-export declare const formatID: (value: unknown) => string | undefined;
-/**
- * Class to manage component classlist
- */
-export declare class ClassList {
-    /**
-     * Available classes
-     */
-    classes: string[];
-    constructor(classlist?: string[]);
-    /**
-     * Add class
-     * @param className - class name to add
-     */
-    add: (className: string) => void;
-    /**
-     * Delete class
-     * @param className - class name to delete
-     */
-    delete: (className: string) => void;
-    /**
-     * Check if class exist in list
-     * @param className - class name to check
-     * @returns class name is in the list
-     */
-    has: (className: string) => boolean;
-    /**
-     * Join classes seperated by spaces
-     * @returns joined values
-     */
-    join: () => string;
-}
-/**
- * Typeguard function to check if all array items are strings.
- * @param items - items to check
- * @returns `true` if all items are strings
- */
-export declare const allItemsAreString: (items: unknown) => items is string[];
-/**
- * Check if element belongs to the given tagNames list
- * @param element - element to check
- * @param tagNames - allowed tag names list
- * @returns `true` if element tagName is in the tagNames list
- */
-export declare const isTagName: (element: Element, tagNames: string[]) => boolean;
-/**
- * CSS selector to select focusable elements.
- * @example
- * ```ts
- * const allFocusableElements: HTMLElement[] = Array.from(this.element.querySelectorAll(focusableElements));
- * ```
- */
-export declare const focusableElements = "a[href], button, input, textarea, select, details, [tabindex]:not([tabindex=\"-1\"]), [identifier], mg-button";
-/**
- * Get windows
- * @param localWindow - the window we are lookink for other windows
- * @returns The list of windows found
- */
-export declare const getWindows: (localWindow: Window) => Window[];
-/**
- * Get parent windows
- * @param localWindow - the window we are lookink for parents
- * @param windows - The list of allready found windows
- * @returns The list of windows found
- */
-export declare const getParentWindows: (localWindow: Window, windows?: Window[]) => Window[];
-/**
- * Validate string
- * @param value - value to check
- * @returns `true` if string is valid
- */
-export declare const isValidString: (value: unknown) => value is string;
-/**
- * Stringify value
- * @param value - value to stringify
- * @returns stringified value
- */
-export declare const toString: (value: unknown) => string;
-/**
- * Validate number
- * @param value - value to check
- * @returns `true` if number is valid
- */
-export declare const isValidNumber: (value: unknown) => value is number;
-/**
- * Cleans string characters by removing special characters and converting to lowercase.
- * @param text - text to clean
- * @returns cleaned string
- * @example
- * ```ts
- * cleanString('âäàçéèêñù') // 'aaaceeenu'
- * cleanString('BATMAN') // 'batman'
- * ```
- */
-export declare const cleanString: (text: string) => string;
-/**
- * Use to process code next tick in the event loop
- * @param callback - code to excute on next tick
- * @returns differed code excution
- */
-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>;
-}
+export { createID, isValideID, formatID, ClassList, allItemsAreString, isTagName, focusableElements, getWindows, getParentWindows, isValidString, toString, isValidNumber, cleanString, nextTick, isObject, getObjectValueFromKey, type CursorType, Cursor, Page, Paginate, } from '@mgdis/core-ui-helpers/dist/utils';
 //# 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":"AAEA;;;;;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;;;;GAIG;AACH,eAAO,MAAM,QAAQ,GAAI,OAAO,OAAO,KAAG,MAAM,GAAG,SAUlD,CAAC;AAEF;;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"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/components/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,QAAQ,EACR,UAAU,EACV,QAAQ,EACR,SAAS,EACT,iBAAiB,EACjB,SAAS,EACT,iBAAiB,EACjB,UAAU,EACV,gBAAgB,EAChB,aAAa,EACb,QAAQ,EACR,aAAa,EACb,WAAW,EACX,QAAQ,EACR,QAAQ,EACR,qBAAqB,EACrB,KAAK,UAAU,EACf,MAAM,EACN,IAAI,EACJ,QAAQ,GACT,MAAM,mCAAmC,CAAC"}

package/dist/ide/index.d.ts

@@ -1,109 +1,2 @@
-import { JsonDocs } from '@stencil/core/internal';
-/**
- * Generate Web Types metadata for IntelliJ's IDE
- * @param name - Library name
- * @param version - Library version
- * @param jsonDocs - Stencil JSON doc
- * @param storybookBaseUrl - Storybook Base Url
- * @returns Web Types metadata
- * @example
- * ```ts
- * const webTypesJson = webTypesGenerator('@mgdis/mg-components', '1.0.0', jsonDocs, 'https://storybook.example.com');
- * ```
- */
-export declare const webTypesGenerator: (name: string, version: string, jsonDocs: JsonDocs, storybookBaseUrl: string) => {
-    $schema: string;
-    name: string;
-    version: string;
-    'description-markup': string;
-    contributions: {
-        html: {
-            elements: {
-                name: string;
-                description: string;
-                'doc-url': string | undefined;
-                attributes: {
-                    name: string | undefined;
-                    description: string;
-                    'doc-url': string | undefined;
-                    value: {
-                        type: string;
-                        default: string | undefined;
-                        required: boolean;
-                    };
-                }[];
-                js: {
-                    properties: {
-                        name: string;
-                        description: string;
-                        'doc-url': string | undefined;
-                        value: {
-                            type: string;
-                            default: string | undefined;
-                            required: boolean;
-                        };
-                    }[];
-                    events: {
-                        name: string;
-                        description: string;
-                    }[];
-                };
-                css: {
-                    properties: {
-                        name: string;
-                        description: string;
-                    }[];
-                };
-            }[];
-        };
-    };
-};
-/**
- * Generate custom HTML datasets for VS Code
- * @param jsonDocs - Stencil JSON doc
- * @param storybookBaseUrl - Storybook Base Url
- * @returns custom HTML datasets
- * @example
- * ```ts
- * const customDataJson = vsCodeGenerator(jsonDocs, 'https://storybook.example.com', 'https://sources.example.com');
- * ```
- */
-export declare const vsCodeGenerator: (jsonDocs: JsonDocs, storybookBaseUrl: string, sourceBaseUrl: string) => {
-    version: number;
-    tags: {
-        name: string;
-        description: string;
-        attributes: {
-            name: string;
-            description: string;
-            values: unknown[] | undefined;
-            references: {
-                name: string;
-                url: string | undefined;
-            }[];
-        }[];
-        references: {
-            name: string;
-            url: string | undefined;
-        }[];
-    }[];
-    globalAttributes: never[];
-    valueSets: never[];
-};
-/**
- * Generate custom CSS datasets for VS Code
- * @param jsonDocs - Stencil JSON doc
- * @returns custom CSS datasets
- * @example
- * ```ts
- * const customDataJson = vsCodeCssGenerator(jsonDocs);
- * ```
- */
-export declare const vsCodeCssGenerator: (jsonDocs: JsonDocs) => {
-    version: number;
-    properties: {
-        name: string;
-        description: string;
-    }[];
-};
+export { webTypesGenerator, vsCodeGenerator, vsCodeCssGenerator } from '@mgdis/core-ui-helpers/dist/stencil';
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/ide/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAmC,MAAM,wBAAwB,CAAC;AA2EnF;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,iBAAiB,GAAI,MAAM,MAAM,EAAE,SAAS,MAAM,EAAE,UAAU,QAAQ,EAAE,kBAAkB,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAmD3G,CAAC;AA4BH;;;;;;;;;GASG;AACH,eAAO,MAAM,eAAe,GAAI,UAAU,QAAQ,EAAE,kBAAkB,MAAM,EAAE,eAAe,MAAM;;;;;;;;;;;;;;;;;;;;;CAkBjG,CAAC;AAEH;;;;;;;;GAQG;AACH,eAAO,MAAM,kBAAkB,GAAI,UAAU,QAAQ;;;;;;CAQnD,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/ide/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,eAAe,EAAE,kBAAkB,EAAE,MAAM,qCAAqC,CAAC"}