@quillsql/react 2.8.8 → 2.8.9

package/dist/utils/valueFormatter.d.ts

@@ -0,0 +1,17 @@
+type Field = {
+    _id: string;
+    label: string;
+    field: string;
+    format: 'percent';
+};
+type Props = {
+    value: string | number | boolean | undefined | null;
+    field: string | undefined | null;
+    fields: Field[];
+};
+/**
+ * Pretty-prints the given values to their nice-looking string form.
+ */
+export declare const valueFormatter: ({ value, field, fields, }: Props) => string | number | boolean;
+export {};
+//# sourceMappingURL=valueFormatter.d.ts.map

package/dist/utils/valueFormatter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"valueFormatter.d.ts","sourceRoot":"","sources":["../../src/utils/valueFormatter.ts"],"names":[],"mappings":"AAGA,KAAK,KAAK,GAAG;IACX,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,SAAS,CAAC;CACnB,CAAC;AAEF,KAAK,KAAK,GAAG;IACX,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,SAAS,GAAG,IAAI,CAAC;IACpD,KAAK,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI,CAAC;IACjC,MAAM,EAAE,KAAK,EAAE,CAAC;CACjB,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,cAAc,8BAIxB,KAAK,KAAG,MAAM,GAAG,MAAM,GAAG,OA+B5B,CAAC"}

package/dist/utils/valueFormatter.js

@@ -0,0 +1,166 @@
+import { endOfWeek, format, getWeek, isValid, startOfWeek } from 'date-fns';
+import { utcToZonedTime } from 'date-fns-tz';
+/**
+ * Pretty-prints the given values to their nice-looking string form.
+ */
+export const valueFormatter = ({ value, field, fields, }) => {
+    if (field === undefined || field === null)
+        return '';
+    if (value === undefined || value === null)
+        return '';
+    const fieldInfo = fields.find((f) => f.field === field);
+    if (!fieldInfo)
+        return '';
+    const HANDLERS = {
+        percent: formatPercent,
+        dollar_amount: formatDollarAmount,
+        dollar_cents: formatDollarCents,
+        whole_number: formatWholeNumber,
+        one_decimal_place: formatOneDecimalPlace,
+        two_decimal_places: formatTwoDecimalPlaces,
+        string: formatString,
+        yyyy: format_YYYY,
+        MMM_yyyy: format_MMM_yyyy,
+        MMM_dd_yyyy: format_MMM_dd_yyyy,
+        hh_ap_pm: format_hh_ap_pm,
+        'MMM_dd-MMM_dd': format_MMM_dd_MMM_dd,
+        'MMM_dd_hh:mm_ap_pm': format_MMM_dd_hh_mm_ap_pm,
+        'wo, yyyy': format_wo_yyyy,
+    };
+    // try to handle this value using the associated formatType handler
+    const formatType = fieldInfo.format;
+    if (Object.keys(HANDLERS).includes(formatType)) {
+        return HANDLERS[formatType](value);
+    }
+    return value.toString(); // by default make this value a string
+};
+/**
+ * HELPER FUNCTION DEFINITIONS
+ **/
+/**
+ * Formats the value as a string using the built-in converstion.
+ */
+const formatString = (value) => value.toString();
+/**
+ * Formats the value as a (rounded) currency amount in dollars.
+ *
+ * eg. @example format(1234.567) => "$1,235"
+ */
+const formatDollarAmount = (value) => {
+    const formatter = new Intl.NumberFormat('en-US', {
+        style: 'currency',
+        currency: 'USD',
+        maximumFractionDigits: 0,
+    });
+    return formatter.format(Number(value ?? 0));
+};
+/**
+ * Formats the value as a (rounded) currency amount in dollars and cents.
+ *
+ * @example format(1234.567) => "$1,234.57"
+ */
+const formatDollarCents = (value) => {
+    const formatter = new Intl.NumberFormat('en-US', {
+        style: 'currency',
+        currency: 'USD',
+        minimumFractionDigits: 2,
+        maximumFractionDigits: 2,
+    });
+    return formatter.format(Number(value ?? 0));
+};
+/**
+ * Formats the value as a (rounded) integer.
+ *
+ * @example format(1234.567) => "1,235"
+ */
+const formatWholeNumber = (value) => {
+    const formatter = new Intl.NumberFormat('en-US', {
+        maximumFractionDigits: 0,
+    });
+    return formatter.format(Number(value));
+};
+/**
+ * Formats the value as a number rounded to exactly one decimal place.
+ *
+ * @example format(1234.567) => "1,234.6"
+ */
+const formatOneDecimalPlace = (value) => {
+    const formatter = new Intl.NumberFormat('en-US', {
+        minimumFractionDigits: 1,
+        maximumFractionDigits: 1,
+    });
+    return formatter.format(Number(value));
+};
+/**
+ * Formats the value as a number rounded to exactly two decimal places.
+ *
+ * @example format(1234.567) => "1,234.57"
+ */
+const formatTwoDecimalPlaces = (value) => {
+    const formatter = new Intl.NumberFormat('en-US', {
+        minimumFractionDigits: 2,
+        maximumFractionDigits: 2,
+    });
+    return formatter.format(Number(value));
+};
+/**
+ * Formats the value as a percentage.
+ *
+ * @example format(0.1234) => "12.34%"
+ * @example format(0.99) => "99.00%"
+ *
+ * NOTE: This function expects that the value is already a percentage value, and
+ * does not try to guess whether the percentage is represented as a whole number
+ * or a decimal.
+ *
+ * @example format(1234.567) => "123,456.70%"
+ * @example format(99) => "9,900.00%"
+ */
+const formatPercent = (value) => {
+    const formatter = new Intl.NumberFormat('en-US', {
+        style: 'percent',
+        minimumFractionDigits: 2,
+        maximumFractionDigits: 2,
+    });
+    return formatter.format(Number(value));
+};
+// Converts the value to a UTC date with the given format string. If the
+// resulting date is invalid, it returns "Invalid date".
+const _getUTCDateHelper = (value, fmt) => {
+    const utcDate = utcToZonedTime(new Date(value), 'UTC');
+    if (!isValid(utcDate))
+        return 'Invalid date';
+    return format(utcDate, fmt);
+};
+const format_YYYY = (value) => _getUTCDateHelper(value, 'yyyy');
+const format_MMM_yyyy = (value) => _getUTCDateHelper(value, 'MMM yyyy');
+const format_hh_ap_pm = (value) => _getUTCDateHelper(value, 'hh:mm aa');
+const format_MMM_dd_yyyy = (value) => _getUTCDateHelper(value, 'dd MMM yyyy');
+const format_MMM_dd_MMM_dd = (value) => {
+    const utcDate = utcToZonedTime(new Date(value), 'UTC');
+    if (!isValid(utcDate))
+        return 'Invalid date';
+    const monday = startOfWeek(utcDate, { weekStartsOn: 1 });
+    const sunday = endOfWeek(utcDate, { weekStartsOn: 1 });
+    // Check if start and end are in the same month
+    if (format(monday, 'MMM') === format(sunday, 'MMM')) {
+        return `${format(monday, 'MMM dd')} - ${format(sunday, 'dd')}`;
+    }
+    else {
+        return `${format(monday, 'MMM dd')} - ${format(sunday, 'MMM dd')}`;
+    }
+};
+const format_MMM_dd_hh_mm_ap_pm = (value) => {
+    const utcDate = utcToZonedTime(new Date(value), 'UTC');
+    if (!isValid(utcDate))
+        return 'Invalid date';
+    const formatStr = utcDate.getMinutes() === 0 ? 'MMM do h a' : 'MMM do h:mm a';
+    const res = format(utcDate, formatStr);
+    return res.slice(0, -2) + res.slice(-2).toLowerCase();
+};
+const format_wo_yyyy = (value) => {
+    const utcDate = utcToZonedTime(new Date(value), 'UTC');
+    if (!isValid(utcDate))
+        return 'Invalid date';
+    return `${getWeek(utcDate)},${utcDate.getFullYear()}`;
+};

package/dist/utils/valueFormatterCSV.d.ts

@@ -0,0 +1,17 @@
+type Field = {
+    _id: string;
+    label: string;
+    field: string;
+    format: 'percent';
+};
+type Props = {
+    value: string | number | boolean | undefined | null;
+    field: string | undefined | null;
+    fields: Field[];
+};
+/**
+ * Formats a value to CSV-format.
+ */
+export declare const valueFormatterCSV: ({ value, field, fields, }: Props) => string | number | boolean;
+export {};
+//# sourceMappingURL=valueFormatterCSV.d.ts.map

package/dist/utils/valueFormatterCSV.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"valueFormatterCSV.d.ts","sourceRoot":"","sources":["../../src/utils/valueFormatterCSV.ts"],"names":[],"mappings":"AAGA,KAAK,KAAK,GAAG;IACX,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,SAAS,CAAC;CACnB,CAAC;AAEF,KAAK,KAAK,GAAG;IACX,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,SAAS,GAAG,IAAI,CAAC;IACpD,KAAK,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI,CAAC;IACjC,MAAM,EAAE,KAAK,EAAE,CAAC;CACjB,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,iBAAiB,8BAI3B,KAAK,KAAG,MAAM,GAAG,MAAM,GAAG,OA+B5B,CAAC"}

package/dist/utils/valueFormatterCSV.js

@@ -0,0 +1,90 @@
+import { endOfWeek, format, getWeek, isValid, startOfWeek } from 'date-fns';
+import { utcToZonedTime } from 'date-fns-tz';
+/**
+ * Formats a value to CSV-format.
+ */
+export const valueFormatterCSV = ({ value, field, fields, }) => {
+    if (field === undefined || field === null)
+        return '';
+    if (value === undefined || value === null)
+        return '';
+    const fieldInfo = fields.find((f) => f.field === field);
+    if (!fieldInfo)
+        return '';
+    const HANDLERS = {
+        percent: formatPercent,
+        dollar_amount: formatDollarAmount,
+        dollar_cents: formatDollarCents,
+        whole_number: formatWholeNumber,
+        one_decimal_place: formatOneDecimalPlace,
+        two_decimal_places: formatTwoDecimalPlaces,
+        string: formatString,
+        yyyy: format_YYYY,
+        MMM_yyyy: format_MMM_yyyy,
+        MMM_dd_yyyy: format_MMM_dd_yyyy,
+        hh_ap_pm: format_hh_ap_pm,
+        'MMM_dd-MMM_dd': format_MMM_dd_MMM_dd,
+        'MMM_dd_hh:mm_ap_pm': format_MMM_dd_hh_mm_ap_pm,
+        'wo, yyyy': format_wo_yyyy,
+    };
+    // try to handle this value using the associated formatType handler
+    const formatType = fieldInfo.format;
+    if (Object.keys(HANDLERS).includes(formatType)) {
+        return HANDLERS[formatType](value);
+    }
+    return value.toString(); // by default make this value a string
+};
+/**
+ * HELPER FUNCTION DEFINITIONS
+ */
+const formatString = (value) => value.toString();
+const formatDollarAmount = (value) => Number(value ?? 0);
+const formatDollarCents = (value) => Number(value ?? 0);
+const formatWholeNumber = (value) => Math.round(Number(value));
+const formatOneDecimalPlace = (value) => Number(value).toFixed(1);
+const formatTwoDecimalPlaces = (value) => Number(value).toFixed(2);
+const formatPercent = (value) => {
+    const absoluteValue = isNaN(Number(value)) ? 0 : Math.abs(Number(value));
+    if (absoluteValue < 1.0) {
+        return Number(value);
+    }
+    return Number(value) / 100.0;
+};
+const _getUTCDateHelper = (value, fmt) => {
+    const utcDate = utcToZonedTime(new Date(value), 'UTC');
+    if (!isValid(utcDate))
+        return 'Invalid date';
+    return format(utcDate, fmt);
+};
+const format_YYYY = (value) => _getUTCDateHelper(value, 'yyyy');
+const format_MMM_yyyy = (value) => _getUTCDateHelper(value, 'MMM yyyy');
+const format_hh_ap_pm = (value) => _getUTCDateHelper(value, 'hh:mm aa');
+const format_MMM_dd_yyyy = (value) => _getUTCDateHelper(value, 'dd MMM yyyy');
+const format_MMM_dd_MMM_dd = (value) => {
+    const utcDate = utcToZonedTime(new Date(value), 'UTC');
+    if (!isValid(utcDate))
+        return 'Invalid date';
+    const monday = startOfWeek(utcDate, { weekStartsOn: 1 });
+    const sunday = endOfWeek(utcDate, { weekStartsOn: 1 });
+    // Check if start and end are in the same month
+    if (format(monday, 'MMM') === format(sunday, 'MMM')) {
+        return `${format(monday, 'MMM dd')} - ${format(sunday, 'dd')}`;
+    }
+    else {
+        return `${format(monday, 'MMM dd')} - ${format(sunday, 'MMM dd')}`;
+    }
+};
+const format_MMM_dd_hh_mm_ap_pm = (value) => {
+    const utcDate = utcToZonedTime(new Date(value), 'UTC');
+    if (!isValid(utcDate))
+        return 'Invalid date';
+    const formatStr = utcDate.getMinutes() === 0 ? 'MMM do h a' : 'MMM do h:mm a';
+    const res = format(utcDate, formatStr);
+    return res.slice(0, -2) + res.slice(-2).toLowerCase();
+};
+const format_wo_yyyy = (value) => {
+    const utcDate = utcToZonedTime(new Date(value), 'UTC');
+    if (!isValid(utcDate))
+        return 'Invalid date';
+    return `${getWeek(utcDate)},${utcDate.getFullYear()}`;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quillsql/react",
-  "version": "2.8.8",
+  "version": "2.8.9",
   "description": "Quill React components for building dashboards and reporting.",
   "main": "dist/index.js",
   "files": [
@@ -29,7 +29,6 @@
     "typescript": "^5.3.3"
   },
   "peerDependencies": {
-    "react": "^18.0.0",
     "react-dom": "^18.0.0"
   },
   "access": "public"