@loadsmart/loadsmart-ui 5.10.1 → 5.11.1

package/dist/components/Calendar/Calendar.stories.d.ts

@@ -1,15 +1,10 @@
 /// <reference types="react" />
-import type { Meta } from '@storybook/react/types-6-0';
+import type { Story, Meta } from '@storybook/react/types-6-0';
 import type { CalendarDate } from './Date.helper';
 import type { CalendarProps } from './Calendar.types';
 declare const _default: Meta<import("@storybook/react/types-6-0").Args>;
 export default _default;
-export declare function Playground(args: CalendarProps): JSX.Element;
-export declare namespace Playground {
-    var args: {
-        mode: string;
-    };
-}
+export declare const Playground: Story<CalendarProps>;
 export declare function Selection(): JSX.Element;
 declare function isWeekend(date: CalendarDate): boolean;
 export declare function CalendarConstraints(args: CalendarProps): JSX.Element;

package/dist/components/Calendar/Date.helper.d.ts

@@ -3,6 +3,8 @@ export declare type DateHelperOptions = {
 };
 export declare const DEFAULT_OPTIONS: DateHelperOptions;
 export declare type InputDate = string | number | Date;
+declare type Unit = 'year' | 'month' | 'day' | 'hour' | 'minute' | 'second' | 'millisecond';
+declare type Operator = '>=' | '>' | '=' | '<' | '<=';
 export declare type DateConstraint = InputDate | [InputDate, InputDate] | [null, InputDate] | [InputDate, null];
 export declare type FunctionConstraint = (day: CalendarDate) => boolean;
 export declare type CalendarConstraint = DateConstraint | FunctionConstraint;
@@ -72,42 +74,58 @@ export interface CalendarDate {
      * @returns {number}
      */
     getSeconds(): number;
+    /**
+     * Get the milliseconds value.
+     *
+     * [!] Be aware that it might be normalized to 12:00:00 (UTC), if you did not call the helper with
+     * `options.normalize: false`.
+     *
+     * @returns {number}
+     */
+    getMilliseconds(): number;
     /**
      * Check if the current date matches **at least one** of the provided constraints.
+     *
+     * [!] Be aware that all dates in this comparison will be normalized to 12:00:00 (UTC).
+     *
      * @param {...CalendarConstraint[]} constraintsArg
      * @returns {boolean}
      */
     matches(...constraints: CalendarConstraint[]): boolean;
     /**
-     * Set the given `value` to the `key` property of this instance.
+     * Set the given `value` to the `unit` property of this instance.
      * This function mutates the internal date instance.
-     * @param {('year' | 'month' | 'day')} key
+     * @param {Unit} unit
      * @param {number} value
      * @returns {CalendarDate}
      */
-    set(key: 'year' | 'month' | 'day', value: number): CalendarDate;
+    set(unit: Unit, value: number): CalendarDate;
     /**
-     * Return a copy of this instance, adding the given `value` to the `key` property.
-     * @param {('year' | 'month' | 'day')} key
+     * Return a copy of this instance, adding the given `value` to the `unit` property.
+     * @param {Unit} unit
      * @param {number} value
      * @returns {CalendarDate}
      */
-    add(key: 'year' | 'month' | 'day', value: number): CalendarDate;
+    add(unit: Unit, value: number): CalendarDate;
     /**
-     * Return a copy of this instance, subtracting the given `value` from the `key` property.
-     * @param {('year' | 'month' | 'day')} key
+     * Return a copy of this instance, subtracting the given `value` from the `unit` property.
+     * @param {Unit} unit
      * @param {number} value
      * @returns {CalendarDate}
      */
-    subtract(key: 'year' | 'month' | 'day', value: number): CalendarDate;
+    subtract(unit: Unit, value: number): CalendarDate;
     /**
      * Compare this date with the given `other`.
-     * @param {('>=' | '>' | '=' | '<' | '<=')} operator - type of comparison to be performed.
+     *
+     * [!] Be aware that it might be normalized to 12:00:00 (UTC), if you did not call the helper with
+     * `options.normalize: false`.
+     *
+     * @param {Operator} operator - type of comparison to be performed.
      * @param {CalendarDate} other - Other `CalendarDate` to compare with.
-     * @param {('year' | 'month' | 'day')} [precision] - notice that the precision increases with the evaluated period, so year < month < day < hour < minute < second < millisecond. Default is 'day'.
+     * @param {Unit} [precision] - notice that the precision increases with the evaluated period, so year < month < day < hour < minute < second < millisecond. Default is 'day'.
      * @return {boolean} comparison result
      */
-    is(operator: '>=' | '>' | '=' | '<' | '<=', other: CalendarDate, precision?: string): boolean;
+    is(operator: Operator, other: CalendarDate, precision?: string): boolean;
     /**
      * Return this date as a string value in ISO format.
      * @returns {string}
@@ -131,6 +149,23 @@ export declare type CalendarDateRange = [CalendarDate | null, CalendarDate | nul
  * @return {CalendarDate}
  */
 declare function DateHelper(dateArg?: InputDate, optionsArg?: DateHelperOptions): CalendarDate;
+/**
+ * This method takes a date and a unit of precision and then normalizes the given date based on that precision.
+ * The return will be the timestamp of the normalized date
+ *
+ * @example
+ * ```js
+ * getComparableDate(new Date('2022-10-13T17:42:19.948Z'), 'hour')) // returns 1665680400000
+ *
+ * // '2022-10-13T17:42:19.948Z' will be normalized to '2022-10-13T17:00:00.000Z'
+ * // 1665680400000 is equal to: new Date('2022-10-13T17:00:00.000Z').getTime()
+ * ```
+ *
+ * @param {Date} date
+ * @param {Unit} precision
+ * @returns {number}
+ */
+export declare function getComparableDate(date: Date, precision?: Unit): number;
 /**
  * Constraints represent ranges of dates, inclusive in both ends.
  * Returns an array representing the initial and final timestamps (after the transformations applied by `DateHelper`).

package/dist/components/Dropdown/Dropdown.stories.d.ts

@@ -2,7 +2,10 @@ import type { Story, Meta } from '@storybook/react/types-6-0';
 import type { DropdownProps, DropdownMenuProps, DropdownTriggerProps } from './Dropdown.types';
 declare const _default: Meta<import("@storybook/react/types-6-0").Args>;
 export default _default;
-declare type DropdownStoryProps = DropdownProps & DropdownMenuProps & DropdownTriggerProps;
+export declare type DropdownStoryProps = DropdownProps & {
+    align?: DropdownMenuProps['align'];
+    outlined?: DropdownTriggerProps['outlined'];
+};
 export declare const Playground: Story<DropdownStoryProps>;
 export declare const WithSections: Story<DropdownStoryProps>;
 export declare const Extended: Story<DropdownStoryProps>;

package/dist/components/Loaders/LoadingBar.stories.d.ts

@@ -1,5 +1,5 @@
 import type { Story, Meta } from '@storybook/react/types-6-0';
-import { LoadingBarProps } from './LoadingBar';
+import type { LoadingBarProps } from './LoadingBar';
 declare const _default: Meta<import("@storybook/react/types-6-0").Args>;
 export default _default;
 export declare const Playground: Story<LoadingBarProps>;