@ni/nimble-components 35.13.3 → 35.14.0

package/dist/esm/table-column/date-text/models/date-text-formatter.js

@@ -0,0 +1,60 @@
+import { supportedIntlDateTimeFormatOptionNames } from '../types';
+/**
+ * A class for formatting date values using the provided locale and options.
+ */
+export class DateTextFormatter {
+    constructor(lang, options) {
+        this.options = this.resolveOptions(options);
+        this.formatter = new Intl.DateTimeFormat(lang, this.options);
+    }
+    format(value) {
+        const milliseconds = this.parseValue(value);
+        if (milliseconds === undefined || !Number.isFinite(milliseconds)) {
+            return '';
+        }
+        try {
+            return this.formatter.format(milliseconds);
+        }
+        catch (_e) {
+            return '';
+        }
+    }
+    optionsMatch(targetOptions) {
+        const resolvedTargetOptions = targetOptions ?? DateTextFormatter.defaultOptions;
+        for (const name of supportedIntlDateTimeFormatOptionNames) {
+            if (this.options[name] !== resolvedTargetOptions[name]) {
+                return false;
+            }
+        }
+        return true;
+    }
+    parseValue(value) {
+        if (value instanceof Date) {
+            return value.getTime();
+        }
+        if (typeof value === 'number') {
+            return value;
+        }
+        return undefined;
+    }
+    resolveOptions(options) {
+        if (options === undefined) {
+            return DateTextFormatter.defaultOptions;
+        }
+        const supportedOptions = {};
+        for (const name of supportedIntlDateTimeFormatOptionNames) {
+            this.resolveOption(supportedOptions, options, name);
+        }
+        return supportedOptions;
+    }
+    resolveOption(target, source, name) {
+        if (source[name] !== undefined) {
+            target[name] = source[name];
+        }
+    }
+}
+DateTextFormatter.defaultOptions = {
+    dateStyle: 'medium',
+    timeStyle: 'medium'
+};
+//# sourceMappingURL=date-text-formatter.js.map

package/dist/esm/table-column/date-text/models/date-text-formatter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"date-text-formatter.js","sourceRoot":"","sources":["../../../../../src/table-column/date-text/models/date-text-formatter.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,sCAAsC,EAEzC,MAAM,UAAU,CAAC;AAElB;;GAEG;AACH,MAAM,OAAO,iBAAiB;IAS1B,YACI,IAAY,EACZ,OAA4C;QAE5C,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;QAC5C,IAAI,CAAC,SAAS,GAAG,IAAI,IAAI,CAAC,cAAc,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;IACjE,CAAC;IAEM,MAAM,CAAC,KAAuC;QACjD,MAAM,YAAY,GAAG,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;QAC5C,IAAI,YAAY,KAAK,SAAS,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,YAAY,CAAC,EAAE,CAAC;YAC/D,OAAO,EAAE,CAAC;QACd,CAAC;QAED,IAAI,CAAC;YACD,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;QAC/C,CAAC;QAAC,OAAO,EAAE,EAAE,CAAC;YACV,OAAO,EAAE,CAAC;QACd,CAAC;IACL,CAAC;IAEM,YAAY,CAAC,aAAkD;QAClE,MAAM,qBAAqB,GAAG,aAAa,IAAI,iBAAiB,CAAC,cAAc,CAAC;QAChF,KAAK,MAAM,IAAI,IAAI,sCAAsC,EAAE,CAAC;YACxD,IAAI,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,qBAAqB,CAAC,IAAI,CAAC,EAAE,CAAC;gBACrD,OAAO,KAAK,CAAC;YACjB,CAAC;QACL,CAAC;QACD,OAAO,IAAI,CAAC;IAChB,CAAC;IAEO,UAAU,CAAC,KAAuC;QACtD,IAAI,KAAK,YAAY,IAAI,EAAE,CAAC;YACxB,OAAO,KAAK,CAAC,OAAO,EAAE,CAAC;QAC3B,CAAC;QACD,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YAC5B,OAAO,KAAK,CAAC;QACjB,CAAC;QACD,OAAO,SAAS,CAAC;IACrB,CAAC;IAEO,cAAc,CAClB,OAAuD;QAEvD,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;YACxB,OAAO,iBAAiB,CAAC,cAAc,CAAC;QAC5C,CAAC;QACD,MAAM,gBAAgB,GAAuC,EAAE,CAAC;QAChE,KAAK,MAAM,IAAI,IAAI,sCAAsC,EAAE,CAAC;YACxD,IAAI,CAAC,aAAa,CAAC,gBAAgB,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC;QACxD,CAAC;QACD,OAAO,gBAAgB,CAAC;IAC5B,CAAC;IAEO,aAAa,CAGjB,MAA0C,EAC1C,MAA0C,EAC1C,IAAU;QAEV,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,SAAS,EAAE,CAAC;YAC7B,MAAM,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC;QAChC,CAAC;IACL,CAAC;;AAxEuB,gCAAc,GAAuC;IACzE,SAAS,EAAE,QAAQ;IACnB,SAAS,EAAE,QAAQ;CACb,CAAC","sourcesContent":["import {\n    supportedIntlDateTimeFormatOptionNames,\n    type SupportedIntlDateTimeFormatOptions\n} from '../types';\n\n/**\n * A class for formatting date values using the provided locale and options.\n */\nexport class DateTextFormatter {\n    private static readonly defaultOptions: SupportedIntlDateTimeFormatOptions = {\n        dateStyle: 'medium',\n        timeStyle: 'medium'\n    } as const;\n\n    private readonly formatter: Intl.DateTimeFormat;\n    private readonly options: SupportedIntlDateTimeFormatOptions;\n\n    public constructor(\n        lang: string,\n        options?: SupportedIntlDateTimeFormatOptions\n    ) {\n        this.options = this.resolveOptions(options);\n        this.formatter = new Intl.DateTimeFormat(lang, this.options);\n    }\n\n    public format(value: Date | number | null | undefined): string {\n        const milliseconds = this.parseValue(value);\n        if (milliseconds === undefined || !Number.isFinite(milliseconds)) {\n            return '';\n        }\n\n        try {\n            return this.formatter.format(milliseconds);\n        } catch (_e) {\n            return '';\n        }\n    }\n\n    public optionsMatch(targetOptions?: SupportedIntlDateTimeFormatOptions): boolean {\n        const resolvedTargetOptions = targetOptions ?? DateTextFormatter.defaultOptions;\n        for (const name of supportedIntlDateTimeFormatOptionNames) {\n            if (this.options[name] !== resolvedTargetOptions[name]) {\n                return false;\n            }\n        }\n        return true;\n    }\n\n    private parseValue(value: Date | number | null | undefined): number | undefined {\n        if (value instanceof Date) {\n            return value.getTime();\n        }\n        if (typeof value === 'number') {\n            return value;\n        }\n        return undefined;\n    }\n\n    private resolveOptions(\n        options: SupportedIntlDateTimeFormatOptions | undefined\n    ): SupportedIntlDateTimeFormatOptions {\n        if (options === undefined) {\n            return DateTextFormatter.defaultOptions;\n        }\n        const supportedOptions: SupportedIntlDateTimeFormatOptions = {};\n        for (const name of supportedIntlDateTimeFormatOptionNames) {\n            this.resolveOption(supportedOptions, options, name);\n        }\n        return supportedOptions;\n    }\n\n    private resolveOption<\n        TKey extends keyof SupportedIntlDateTimeFormatOptions\n    >(\n        target: SupportedIntlDateTimeFormatOptions,\n        source: SupportedIntlDateTimeFormatOptions,\n        name: TKey\n    ): void {\n        if (source[name] !== undefined) {\n            target[name] = source[name];\n        }\n    }\n}\n"]}

package/dist/esm/table-column/date-text/types.d.ts

@@ -21,3 +21,8 @@ export type DayPeriodFormat = Intl.DateTimeFormatOptions['dayPeriod'];
 export type DateStyle = Intl.DateTimeFormatOptions['dateStyle'];
 export type TimeStyle = Intl.DateTimeFormatOptions['timeStyle'];
 export type HourCycleFormat = Intl.DateTimeFormatOptions['hourCycle'];
+/**
+ * The `Intl.DateTimeFormatOptions` properties supported by the date-text column and `DateTextFormatter`.
+ */
+export declare const supportedIntlDateTimeFormatOptionNames: readonly ["localeMatcher", "weekday", "era", "year", "month", "day", "hour", "minute", "second", "dayPeriod", "timeZoneName", "formatMatcher", "hour12", "timeZone", "calendar", "numberingSystem", "dateStyle", "timeStyle", "hourCycle"];
+export type SupportedIntlDateTimeFormatOptions = Pick<Intl.DateTimeFormatOptions, (typeof supportedIntlDateTimeFormatOptionNames)[number]>;

package/dist/esm/table-column/date-text/types.js

@@ -5,4 +5,28 @@ export const DateTextFormat = {
     default: undefined,
     custom: 'custom'
 };
+/**
+ * The `Intl.DateTimeFormatOptions` properties supported by the date-text column and `DateTextFormatter`.
+ */
+export const supportedIntlDateTimeFormatOptionNames = [
+    'localeMatcher',
+    'weekday',
+    'era',
+    'year',
+    'month',
+    'day',
+    'hour',
+    'minute',
+    'second',
+    'dayPeriod',
+    'timeZoneName',
+    'formatMatcher',
+    'hour12',
+    'timeZone',
+    'calendar',
+    'numberingSystem',
+    'dateStyle',
+    'timeStyle',
+    'hourCycle'
+];
 //# sourceMappingURL=types.js.map

package/dist/esm/table-column/date-text/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/table-column/date-text/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG;IAC1B,OAAO,EAAE,SAAS;IAClB,MAAM,EAAE,QAAQ;CACV,CAAC","sourcesContent":["/**\n * Formatting scheme for the date-text table column\n */\nexport const DateTextFormat = {\n    default: undefined,\n    custom: 'custom'\n} as const;\nexport type DateTextFormat = (typeof DateTextFormat)[keyof typeof DateTextFormat];\n\nexport type LocaleMatcherAlgorithm = Intl.DateTimeFormatOptions['localeMatcher'];\nexport type WeekdayFormat = Intl.DateTimeFormatOptions['weekday'];\nexport type EraFormat = Intl.DateTimeFormatOptions['era'];\nexport type YearFormat = Intl.DateTimeFormatOptions['year'];\nexport type MonthFormat = Intl.DateTimeFormatOptions['month'];\nexport type DayFormat = Intl.DateTimeFormatOptions['day'];\nexport type HourFormat = Intl.DateTimeFormatOptions['hour'];\nexport type MinuteFormat = Intl.DateTimeFormatOptions['minute'];\nexport type SecondFormat = Intl.DateTimeFormatOptions['second'];\nexport type TimeZoneNameFormat = Intl.DateTimeFormatOptions['timeZoneName'];\nexport type FormatMatcherAlgorithm = Intl.DateTimeFormatOptions['formatMatcher'];\nexport type DayPeriodFormat = Intl.DateTimeFormatOptions['dayPeriod'];\nexport type DateStyle = Intl.DateTimeFormatOptions['dateStyle'];\nexport type TimeStyle = Intl.DateTimeFormatOptions['timeStyle'];\nexport type HourCycleFormat = Intl.DateTimeFormatOptions['hourCycle'];\n"]}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/table-column/date-text/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG;IAC1B,OAAO,EAAE,SAAS;IAClB,MAAM,EAAE,QAAQ;CACV,CAAC;AAmBX;;GAEG;AACH,MAAM,CAAC,MAAM,sCAAsC,GAAG;IAClD,eAAe;IACf,SAAS;IACT,KAAK;IACL,MAAM;IACN,OAAO;IACP,KAAK;IACL,MAAM;IACN,QAAQ;IACR,QAAQ;IACR,WAAW;IACX,cAAc;IACd,eAAe;IACf,QAAQ;IACR,UAAU;IACV,UAAU;IACV,iBAAiB;IACjB,WAAW;IACX,WAAW;IACX,WAAW;CACL,CAAC","sourcesContent":["/**\n * Formatting scheme for the date-text table column\n */\nexport const DateTextFormat = {\n    default: undefined,\n    custom: 'custom'\n} as const;\nexport type DateTextFormat = (typeof DateTextFormat)[keyof typeof DateTextFormat];\n\nexport type LocaleMatcherAlgorithm = Intl.DateTimeFormatOptions['localeMatcher'];\nexport type WeekdayFormat = Intl.DateTimeFormatOptions['weekday'];\nexport type EraFormat = Intl.DateTimeFormatOptions['era'];\nexport type YearFormat = Intl.DateTimeFormatOptions['year'];\nexport type MonthFormat = Intl.DateTimeFormatOptions['month'];\nexport type DayFormat = Intl.DateTimeFormatOptions['day'];\nexport type HourFormat = Intl.DateTimeFormatOptions['hour'];\nexport type MinuteFormat = Intl.DateTimeFormatOptions['minute'];\nexport type SecondFormat = Intl.DateTimeFormatOptions['second'];\nexport type TimeZoneNameFormat = Intl.DateTimeFormatOptions['timeZoneName'];\nexport type FormatMatcherAlgorithm = Intl.DateTimeFormatOptions['formatMatcher'];\nexport type DayPeriodFormat = Intl.DateTimeFormatOptions['dayPeriod'];\nexport type DateStyle = Intl.DateTimeFormatOptions['dateStyle'];\nexport type TimeStyle = Intl.DateTimeFormatOptions['timeStyle'];\nexport type HourCycleFormat = Intl.DateTimeFormatOptions['hourCycle'];\n\n/**\n * The `Intl.DateTimeFormatOptions` properties supported by the date-text column and `DateTextFormatter`.\n */\nexport const supportedIntlDateTimeFormatOptionNames = [\n    'localeMatcher',\n    'weekday',\n    'era',\n    'year',\n    'month',\n    'day',\n    'hour',\n    'minute',\n    'second',\n    'dayPeriod',\n    'timeZoneName',\n    'formatMatcher',\n    'hour12',\n    'timeZone',\n    'calendar',\n    'numberingSystem',\n    'dateStyle',\n    'timeStyle',\n    'hourCycle'\n] as const;\n\nexport type SupportedIntlDateTimeFormatOptions = Pick<\n    Intl.DateTimeFormatOptions,\n    (typeof supportedIntlDateTimeFormatOptionNames)[number]\n>;\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ni/nimble-components",
-  "version": "35.13.3",
+  "version": "35.14.0",
   "description": "Styled web components for the NI Nimble Design System",
   "scripts": {
     "build": "npm run build:icons && npm run build:workers && npm run build:components && npm run build:scss && npm run build:cem",

package/dist/esm/table-column/date-text/models/format-helper.d.ts

@@ -1,2 +0,0 @@
-import type { TableNumberFieldValue } from '../../../table/types';
-export declare function formatNumericDate(formatter: Intl.DateTimeFormat, date: TableNumberFieldValue): string;

package/dist/esm/table-column/date-text/models/format-helper.js

@@ -1,14 +0,0 @@
-export function formatNumericDate(formatter, date) {
-    if (typeof date === 'number') {
-        try {
-            return formatter.format(date);
-        }
-        catch (_e) {
-            return '';
-        }
-    }
-    else {
-        return '';
-    }
-}
-//# sourceMappingURL=format-helper.js.map

package/dist/esm/table-column/date-text/models/format-helper.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"format-helper.js","sourceRoot":"","sources":["../../../../../src/table-column/date-text/models/format-helper.ts"],"names":[],"mappings":"AAEA,MAAM,UAAU,iBAAiB,CAC7B,SAA8B,EAC9B,IAA2B;IAE3B,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;QAC3B,IAAI,CAAC;YACD,OAAO,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAClC,CAAC;QAAC,OAAO,EAAE,EAAE,CAAC;YACV,OAAO,EAAE,CAAC;QACd,CAAC;IACL,CAAC;SAAM,CAAC;QACJ,OAAO,EAAE,CAAC;IACd,CAAC;AACL,CAAC","sourcesContent":["import type { TableNumberFieldValue } from '../../../table/types';\n\nexport function formatNumericDate(\n    formatter: Intl.DateTimeFormat,\n    date: TableNumberFieldValue\n): string {\n    if (typeof date === 'number') {\n        try {\n            return formatter.format(date);\n        } catch (_e) {\n            return '';\n        }\n    } else {\n        return '';\n    }\n}\n"]}