@mgdis/stencil-helpers 3.2.0 → 3.2.2

package/dist/locale/index.d.ts

@@ -1,117 +1,3 @@
-import { ObjectType } from '../types';
-/**
- * Gets the date pattern based on the specified locale.
- * @param locale - the locale to refer to
- * @returns date pattern
- * @example
- * ```ts
- * getLocaleDatePattern('fr') // 'dd/mm/yyyy'
- * ```
- */
-export declare const getLocaleDatePattern: (locale: string) => string;
-/**
- * Formats a date object to a string with the pattern 'YYYY-MM-DD'.
- * @param date - date to parse
- * @returns string date with pattern 'YYYY-MM-DD'
- * @example
- * ```ts
- * dateToString(new Date('2023-12-24')) // '2023-12-24'
- * ```
- */
-export declare const dateToString: (date: Date) => string | undefined;
-/**
- * Format number to the locale currency
- * @param number - number to format
- * @param locale - locale to apply
- * @param currency - currency to apply
- * @returns formatted currency
- * @example
- * ```ts
- * localeCurrency(1234567890.12, 'fr', 'EUR') // '1 234 567 890,12\xa0€'
- * ```
- */
-export declare const localeCurrency: (number: number, locale: string, currency: string) => string;
-/**
- * Format number to locale
- * @param number - number to format
- * @param locale - locale to apply
- * @param decimalLength - decimal length to apply
- * @returns formatted number
- * @example
- * ```ts
- * localeNumber(1234567890.12, 'fr') // 1 234 567 890,12
- * ```
- */
-export declare const localeNumber: (number: number, locale: string, decimalLength?: number) => string;
-/**
- * Format number as percentage based on locale
- * @param number - number to format
- * @param locale - locale to apply
- * @param decimalLength - decimal length to apply
- * @returns formatted percentage
- * @example
- * ```ts
- * localePercent(0.42, 'fr', 2) // '42,00 %'
- * localePercent(0.42, 'en', 2) // '42.00%'
- * ```
- */
-export declare const localePercent: (number: number, locale: string, decimalLength?: number) => string;
-/**
- * Format number with standardized unit based on locale using Intl unit formatting
- * @param number - number to format
- * @param locale - locale to apply
- * @param unit - standardized unit (e.g., 'kilometer', 'kilogram', 'celsius')
- * @param unitDisplay - how to display the unit ('short', 'long', 'narrow')
- * @param decimalLength - decimal length to apply
- * @returns formatted number with localized unit
- * @example
- * ```ts
- * localeUnit(1234567890.12, 'fr', 'kilometer') // '1 234 567 890,12 km'
- * localeUnit(23, 'fr', 'celsius') // '23 °C'
- * localeUnit(10, 'fr', 'kilometer', 0, 'long') // '10 kilomètres'
- * ```
- */
-export declare const localeUnit: (number: number, locale: string, unit: Intl.NumberFormatOptions["unit"], unitDisplay?: Intl.NumberFormatOptions["unitDisplay"], decimalLength?: number) => string;
-/**
- * Date RegExp, usefull to test if string is a follow the date pattern
- * @example
- * ```ts
- * dateRegExp.test('mystring') // false
- * dateRegExp.test('2020-12-31') // true
- * ```
- */
-export declare const dateRegExp: RegExp;
-/**
- * Locale date format
- * @param date - date to format
- * @param locale - locale to apply
- * @param config - DateTimeFormatOptions object to apply
- * @returns formatted date
- * @example
- * ```ts
- * localeDate('2022-06-02', 'fr') // '02/06/2022'
- * ```
- */
-export declare const localeDate: (date: string | undefined, locale: string, config?: Intl.DateTimeFormatOptions) => string;
-/**
- * Get Intl object
- * @param messages - locales to render in object format. `ex: { en: { porp: "test" }, fr: { porp: "test" }}`.
- * @param defaultLocale - fallback locale to render. `ex: 'en'`.
- * @returns from the element passed in return function you will get the matching messages object
- * @example
- * ```ts
- * import en from './en/messages.json';
- * import fr from './fr/messages.json';
- * import { defineLocales } from '@mgdis/stencil-helpers';
- *
- * const defaultLocale = 'en';
- * const messages = { en, fr };
- *
- * export const initLocales = defineLocales(messages, defaultLocale);
- * ```
- */
-export declare const defineLocales: (messages: ObjectType, defaultLocale: "fr" | "en" | string) => (element: HTMLElement) => {
-    locale: string;
-    messages: ObjectType;
-};
+export { localeDatePattern as getLocaleDatePattern, localeCurrency, localeNumber, localePercent, localeUnit, localeDate, defineLocales } from '@mgdis/core-ui-helpers/dist/locale';
+export { dateToString, dateRegExp } from '@mgdis/core-ui-helpers/dist/utils';
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/locale/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAE3C;;;;;;;;GAQG;AACH,eAAO,MAAM,oBAAoB,GAAI,QAAQ,MAAM,WAQlD,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,YAAY,GAAI,MAAM,IAAI,KAAG,MAAM,GAAG,SAA6C,CAAC;AAiCjG;;;;;;;;;;GAUG;AACH,eAAO,MAAM,cAAc,GAAI,QAAQ,MAAM,EAAE,QAAQ,MAAM,EAAE,UAAU,MAAM,KAAG,MAAuF,CAAC;AAE1K;;;;;;;;;;GAUG;AACH,eAAO,MAAM,YAAY,GAAI,QAAQ,MAAM,EAAE,QAAQ,MAAM,EAAE,gBAAe,MAAU,KAAG,MACO,CAAC;AAEjG;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,aAAa,GAAI,QAAQ,MAAM,EAAE,QAAQ,MAAM,EAAE,gBAAe,MAAU,KAAG,MAMzF,CAAC;AAEF;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,UAAU,GACrB,QAAQ,MAAM,EACd,QAAQ,MAAM,EACd,MAAM,IAAI,CAAC,mBAAmB,CAAC,MAAM,CAAC,EACtC,cAAa,IAAI,CAAC,mBAAmB,CAAC,aAAa,CAAW,EAC9D,gBAAe,MAAU,KACxB,MAQF,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,UAAU,QAAkD,CAAC;AAE1E;;;;;;;;;;GAUG;AACH,eAAO,MAAM,UAAU,GAAI,MAAM,MAAM,GAAG,SAAS,EAAE,QAAQ,MAAM,EAAE,SAAS,IAAI,CAAC,qBAAqB,KAAG,MAC8B,CAAC;AAE1I;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,aAAa,GACvB,UAAU,UAAU,EAAE,eAAe,IAAI,GAAG,IAAI,GAAG,MAAM,MACzD,SAAS,WAAW,KAAG;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,UAAU,CAAA;CACT,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/locale/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,IAAI,oBAAoB,EAAE,cAAc,EAAE,YAAY,EAAE,aAAa,EAAE,UAAU,EAAE,UAAU,EAAE,aAAa,EAAE,MAAM,oCAAoC,CAAC;AAEnL,OAAO,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,mCAAmC,CAAC"}

package/dist/storybook/index.d.ts

@@ -1,77 +1,2 @@
-import { VNode } from '@stencil/core';
-import { ArgsType } from './index.conf';
-import { JsonDocs } from '@stencil/core/internal';
-/**
- * Filter default argument on component argument to prevent them to be rendered
- * @param args - all possible args with custom values
- * @param defaultValues - component default args values
- * @param slots - slots
- * @returns filtres args
- * @example
- * ```ts
- * import { filterArgs } from '@mgdis/stencil-helpers';
- * const Template = (args: MgBadgeType): HTMLElement => <mg-badge {...filterArgs(args, { variant: 'info' }, ['actions'])}></mg-badge>;
- * ```
- */
-export declare const filterArgs: <T>(args: T, defaultValues?: Partial<T>, slots?: string[]) => T;
-/**
- * Storybook stencil wrapper. Used to target element with `storybook-root` id and render virtual DOM inside.
- * @param storyFn - storybook render function
- * @param context - storybook context
- * @returns rendered element
- * @example
- * ```ts
- * // .storybook/preview.ts
- * import { stencilWrapper } from '@mgdis/stencil-helpers';
- * export const decorators: Preview['decorators'] = [stencilWrapper];
- * ```
- */
-export declare const stencilWrapper: (storyFn: (ctx: any) => void, context: ArgsType) => Element | undefined;
-/**
- * Get story HTML from virtual DOM.
- * Mainly used to render, component code exemple in stories.
- * @param vitualNode - story virtual DOM
- * @returns stringified rendered HTML
- * @example
- * ```ts
- * // .storybook/preview.ts
- * import { getStoryHTML } from '@mgdis/stencil-helpers';
- *
- * export const parameters: Preview['parameters'] = {
- *   docs: {
- *     source: {
- *       transform: (_, ctx) => getStoryHTML(ctx.originalStoryFn(ctx.args)),
- *     }
- *   },
- * };
- * ```
- */
-export declare const getStoryHTML: ({ $tag$, $attrs$, $children$, $text$ }: VNode) => string;
-/**
- * Retrieve Component Storybook URL from file path
- * @param storybookBaseUrl - Storybook Base URL
- * @param filePath - Component file path
- * @returns Component Storybook URL
- */
-export declare const getStorybookUrl: (storybookBaseUrl: string, filePath: string | undefined) => string | undefined;
-export declare class StorybookPreview {
-    #private;
-    /**
-     * JsonDocs
-     */
-    jsonDoc: JsonDocs;
-    constructor(jsonDoc: JsonDocs);
-    /**
-     * Extract component arg types from the component data
-     * @param tagName - tag name we want to extract the arg types from
-     * @returns component arg types
-     */
-    extractArgTypes: (tagName: string) => {};
-    /**
-     * Extract component description from the component data
-     * @param tagName - tag name we want to extract the description from
-     * @returns component description
-     */
-    extractComponentDescription: (tagName: string) => string | undefined;
-}
+export { filterArgs, stencilWrapper, getStoryHTML, getStorybookUrl, StorybookPreview } from '@mgdis/core-ui-helpers/dist/storybook';
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/storybook/index.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,eAAe,CAAC;AAC3C,OAAO,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AACxC,OAAO,EAAE,QAAQ,EAAmC,MAAM,wBAAwB,CAAC;AA+CnF;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,UAAU,GAAI,CAAC,EAAE,MAAM,CAAC,EAAE,gBAAgB,OAAO,CAAC,CAAC,CAAC,EAAE,QAAO,MAAM,EAAO,KAAG,CAgBzF,CAAC;AAEF;;;;;;;;;;;GAWG;AAEH,eAAO,MAAM,cAAc,GAAI,SAAS,CAAC,GAAG,EAAE,GAAG,KAAK,IAAI,EAAE,SAAS,QAAQ,KAAG,OAAO,GAAG,SAqBzF,CAAC;AAEF;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,YAAY,GAAI,wCAAwC,KAAK,KAAG,MAS5E,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,eAAe,GAAI,kBAAkB,MAAM,EAAE,UAAU,MAAM,GAAG,SAAS,KAAG,MAAM,GAAG,SAMjG,CAAC;AAEF,qBAAa,gBAAgB;;IAC3B;;OAEG;IACH,OAAO,EAAE,QAAQ,CAAC;gBAEN,OAAO,EAAE,QAAQ;IAmD7B;;;;OAIG;IACH,eAAe,GAAI,SAAS,MAAM,QAoIhC;IAEF;;;;OAIG;IACH,2BAA2B,GAAI,SAAS,MAAM,wBAG5C;CACH"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/storybook/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,cAAc,EAAE,YAAY,EAAE,eAAe,EAAE,gBAAgB,EAAE,MAAM,uCAAuC,CAAC"}

package/dist/tests/index.d.ts

@@ -1,2 +1,2 @@
-export * from './unit';
+export { setupMutationObserverMock, setupResizeObserverMock, setupSubmitEventMock, setUpRequestAnimationFrameMock } from '@mgdis/core-ui-helpers/dist/tests';
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/tests/index.ts"],"names":[],"mappings":"AAAA,cAAc,QAAQ,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/tests/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,yBAAyB,EAAE,uBAAuB,EAAE,oBAAoB,EAAE,8BAA8B,EAAE,MAAM,mCAAmC,CAAC"}

package/dist/types/index.d.ts

@@ -1,5 +1,2 @@
-/**
- * Define json object type
- */
-export type ObjectType = Record<string, unknown>;
+export { type ObjectType } from '@mgdis/core-ui-helpers/dist/utils';
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,mCAAmC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mgdis/stencil-helpers",
-  "version": "3.2.0",
+  "version": "3.2.2",
   "license": "ISC",
   "author": "Nicolas Jouanno <jouanno-n@mgdis.fr>",
   "maintainers": [
@@ -21,22 +21,21 @@
     }
   },
   "dependencies": {
-    "@stencil/core": "4.28.2",
-    "@mgdis/mg-components-helpers": "4.2.0"
+    "@mgdis/core-ui-helpers": "1.0.1"
   },
   "devDependencies": {
-    "@types/node": "22.15.3",
-    "@vitest/coverage-istanbul": "3.1.2",
-    "@vitest/coverage-v8": "3.1.2",
-    "htmlfy": "0.7.2",
-    "typedoc": "0.28.3",
-    "typedoc-plugin-markdown": "4.6.3",
-    "vite": "6.3.3",
-    "vite-plugin-dts": "4.5.3",
-    "vitest": "3.1.2",
-    "@core-ui/tsconfig": "1.0.7",
-    "@core-ui/typedoc-config": "1.0.2",
-    "@core-ui/vitest-config": "1.0.5"
+    "@types/node": "22.15.31",
+    "@vitest/coverage-istanbul": "3.2.3",
+    "@vitest/coverage-v8": "3.2.3",
+    "htmlfy": "0.7.5",
+    "typedoc": "0.28.5",
+    "typedoc-plugin-markdown": "4.6.4",
+    "vite": "6.3.5",
+    "vite-plugin-dts": "4.5.4",
+    "vitest": "3.2.3",
+    "@core-ui/tsconfig": "1.0.8",
+    "@core-ui/vitest-config": "1.0.5",
+    "@core-ui/typedoc-config": "1.0.2"
   },
   "scripts": {
     "build": "vite build",

package/dist/storybook/index.conf.d.ts

@@ -1,7 +0,0 @@
-/**
- * Define compents default args type
- */
-export type ArgsType = {
-    [x: string]: unknown;
-};
-//# sourceMappingURL=index.conf.d.ts.map

package/dist/storybook/index.conf.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.conf.d.ts","sourceRoot":"","sources":["../../src/storybook/index.conf.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG;IAAE,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAA;CAAE,CAAC"}

package/dist/tests/unit.conf.d.ts

@@ -1,16 +0,0 @@
-/**
- * Define MutationObserver setup function signature
- */
-export type SetupMutationObserverMockParams = {
-    disconnect: MutationObserver['disconnect'];
-    observe: MutationObserver['observe'];
-    takeRecords: MutationObserver['takeRecords'];
-};
-/**
- * Define ResizeObserver setup function signature
- */
-export type setupResizeObserverMockParams = {
-    disconnect: ResizeObserver['disconnect'];
-    observe: ResizeObserver['observe'];
-};
-//# sourceMappingURL=unit.conf.d.ts.map

package/dist/tests/unit.conf.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"unit.conf.d.ts","sourceRoot":"","sources":["../../src/tests/unit.conf.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,+BAA+B,GAAG;IAAE,UAAU,EAAE,gBAAgB,CAAC,YAAY,CAAC,CAAC;IAAC,OAAO,EAAE,gBAAgB,CAAC,SAAS,CAAC,CAAC;IAAC,WAAW,EAAE,gBAAgB,CAAC,aAAa,CAAC,CAAA;CAAE,CAAC;AAEjL;;GAEG;AACH,MAAM,MAAM,6BAA6B,GAAG;IAAE,UAAU,EAAE,cAAc,CAAC,YAAY,CAAC,CAAC;IAAC,OAAO,EAAE,cAAc,CAAC,SAAS,CAAC,CAAA;CAAE,CAAC"}

package/dist/tests/unit.d.ts

@@ -1,76 +0,0 @@
-import { SetupMutationObserverMockParams, setupResizeObserverMockParams } from './unit.conf';
-/**
- * Utility function that mocks the `MutationObserver` API. Recommended to execute inside `beforeEach`.
- * @param mutationObserverMock - Parameter that is sent to the `Object.defineProperty`
- * overwrite method. `jest.fn()` mock functions can be passed here if the goal is to not only
- * mock the mutation observer, but its methods.
- * You can manually fire an intersection entry:
- * @param mutationObserverMock - configuration object
- * @returns Mocked MutationObserver
- * @example
- * ```
- * let fireMo;
- * setupMutationObserverMock({
- *   observe: function () {
- *     fireMo = this.cb;
- *   },
- * });
- * ...
- * fireMo([{ type: 'childList', addedNodes: [AMockElemenet, AnotherMockElemenet], target: yourMockElemenet }]);;
- * ```
- */
-export declare const setupMutationObserverMock: ({ disconnect, observe, takeRecords }: SetupMutationObserverMockParams) => typeof MutationObserver;
-/**
- * Utility function that mocks the `ResizeObserver` API. Recommended to execute inside `beforeEach`.
- * @param resizeObserverMock - Parameter that is sent to the `Object.defineProperty`
- * overwrite method. `jest.fn()` mock functions can be passed here if the goal is to not only
- * mock the resize observer, but its methods.
- * You can manually fire an intersection entry:
- * @param resizeObserverMock - configuration object
- * @returns Mocked ResizeObserver
- * @example
- * ```
- * let fireRo;
- * setupResizeObserverMock({
- *   observe: function () {
- *     fireRo = this.cb;
- *   },
- * });
- * ...
- * fireRo([{
- *  borderBoxSize: ResizeObserverSize[],
- *  contentBoxSize: ResizeObserverSize[],
- *  contentRect: DOMRectReadOnly,
- *  devicePixelContentBoxSize: ResizeObserverSize[],
- *  target: yourMockElemenet
- * }]);;
- * ```
- */
-export declare const setupResizeObserverMock: ({ disconnect, observe }: setupResizeObserverMockParams) => typeof ResizeObserver;
-declare class MockCustomEvent extends Event {
-    /**
-     *
-     */
-    detail: any;
-}
-/**
- * Utility function that mocks the `SubmitEvent` API. Recommended to execute inside `beforeEach`.
- * @example
- * ```
- * setupSubmitEventMock();
- * ```
- * @returns custom event mock
- */
-export declare const setupSubmitEventMock: () => typeof MockCustomEvent;
-/**
- * Utility function that mocks the `requestAnimationFrame` API. Recommended to execute inside `test`.
- * @example
- * ```
- * setUpRequestAnimationFrameMock(jest.runOnlyPendingTimers);
- * ```
- * @param faketimer - recommended to use jest.runOnlyPendingTimers()
- * @returns custom setUpRequestAnimationFrameMock mock
- */
-export declare const setUpRequestAnimationFrameMock: (faketimer: () => void) => (callback: FrameRequestCallback) => number;
-export {};
-//# sourceMappingURL=unit.d.ts.map

package/dist/tests/unit.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"unit.d.ts","sourceRoot":"","sources":["../../src/tests/unit.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,+BAA+B,EAAE,6BAA6B,EAAE,MAAM,aAAa,CAAC;AAElG;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,yBAAyB,GAAI,sCAAsC,+BAA+B,KAAG,OAAO,gBAgCxH,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,eAAO,MAAM,uBAAuB,GAAI,yBAAyB,6BAA6B,KAAG,OAAO,cAgCvG,CAAC;AAEF,cAAM,eAAgB,SAAQ,KAAK;IACjC;;OAEG;IACH,MAAM,EAAE,GAAG,CAAC;CACb;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,oBAAoB,QAAO,OAAO,eAY9C,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,8BAA8B,GAAI,WAAW,MAAM,IAAI,gBACzB,oBAAoB,WAe9D,CAAC"}