@carto/ps-utils 1.0.0 → 1.1.0

package/dist/ps-utils.js

@@ -0,0 +1,99 @@
+function f(t, n = 1) {
+  if (!t) {
+    console.warn(`hexToRgbaDeckGL: ${t} invalid hexadecimal format`);
+    return;
+  }
+  if (n < 0 || n > 1) {
+    console.warn(`hexToRgbaDeckGL: ${n} invalid alpha format`);
+    return;
+  }
+  if (t?.includes("#") && (t = t.slice(1)), !/[0-9A-Fa-f]{6}/g.test(t) && !/[0-9A-Fa-f]{3}/g.test(t) && !/[0-9A-Fa-f]{2}/g.test(t)) {
+    console.warn(`hexToRgbaDeckGL: ${t} invalid hexadecimal format`);
+    return;
+  }
+  const r = t.length;
+  r < 6 && (t = t.slice(0, 6 - r).repeat(6 / r));
+  const e = parseInt(
+    t.length === 3 ? t.slice(0, 1).repeat(2) : t.slice(0, 2),
+    16
+  ), o = parseInt(
+    t.length === 3 ? t.slice(1, 2).repeat(2) : t.slice(2, 4),
+    16
+  ), i = parseInt(
+    t.length === 3 ? t.slice(2, 3).repeat(2) : t.slice(4, 6),
+    16
+  );
+  return [e, o, i, n * 255];
+}
+function g(t, { withPrefix: n = !0 } = {}) {
+  if (!t || !t.length) {
+    console.warn("rgbaDeckGLToHex: invalid array or empty values");
+    return;
+  }
+  if (t.some((o) => o < 0 || o > 255)) {
+    console.warn(
+      `rgbaDeckGLToHex: [${t.toString()}] invalid array value format`
+    );
+    return;
+  }
+  const e = t.map((o) => o.toString(16).padStart(2, "0")).join("");
+  return `${n ? "#" : ""}${e}`;
+}
+function s(t, { format: n = "NFD", replaceUnicode: r = "[\u0300-\u036F]" } = {}) {
+  const e = new RegExp(r, "g");
+  return t.normalize(n).replace(e, "");
+}
+function l(t, n, { matchFn: r, normalizeOptions: e } = {}) {
+  const o = new RegExp(
+    s(t.toLowerCase(), e),
+    "gi"
+  );
+  return Array.isArray(n) ? n.filter((i) => {
+    const a = r ? r(i) : i;
+    return s(a).match(o);
+  }) : s(n).match(o) ? n : null;
+}
+function m(t, n, r) {
+  return Intl.DateTimeFormat(n, r).format(t);
+}
+const c = {
+  NUMBER: {
+    style: "decimal",
+    maximumFractionDigits: 1,
+    minimumFractionDigits: 0,
+    notation: "compact",
+    compactDisplay: "short"
+  },
+  CURRENCY: {
+    style: "currency",
+    currency: "USD",
+    maximumFractionDigits: 2,
+    minimumFractionDigits: 2,
+    notation: "compact",
+    compactDisplay: "short"
+  },
+  DATE: {
+    year: "numeric",
+    month: "2-digit",
+    day: "2-digit"
+  }
+};
+function u(t, n, r) {
+  return Intl.NumberFormat(n, r).format(t);
+}
+function D(t, n, r = {}) {
+  return u(t, n, { ...c.NUMBER, ...r });
+}
+function p(t, n, r = {}) {
+  return u(t, n, { ...c.CURRENCY, ...r });
+}
+export {
+  c as CONFIG,
+  p as formatCurrency,
+  m as formatDate,
+  D as formatNumber,
+  f as hexToRgbaDeckGL,
+  l as matchText,
+  s as normalize,
+  g as rgbaDeckGLToHex
+};

package/dist/types/formatters/constants.d.ts

@@ -0,0 +1 @@
+export declare const CONFIG: Record<string, Intl.NumberFormatOptions | Intl.DateTimeFormatOptions>;

package/dist/types/formatters/date/format-date.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Formats a Date or number to a string based on the given options.
+ * This function could be used to format a Date, in Date format or miliseconds, in specific locale and options.
+ * @public
+ *
+ * @export
+ * @param {number | Date} value
+ * @param {string | string[]} locales
+ * @param {Intl.DateTimeFormatOptions} [options]
+ * @return {string}
+ */
+export declare function formatDate(value: number | Date, locales: string | string[], options?: Intl.DateTimeFormatOptions): string;

package/dist/types/formatters/number/format-number.d.ts

@@ -0,0 +1,34 @@
+/**
+ * Formats a number to a string.
+ * @public
+ *
+ * @example
+ *
+ * ```ts
+ * formatNumber(3001, 'es-ES') // => '3 mil'
+ * ```
+ *
+ * @export
+ * @param {number} value - The number to be formatted.
+ * @param {string} locale - The locale to be used.
+ * @param {Intl.NumberFormatOptions} [options] - The options to be used.
+ * @return {string}
+ */
+export declare function formatNumber(value: number, locale: string, options?: Intl.NumberFormatOptions): string;
+/**
+ * Formats a number to a currency string.
+ * @public
+ *
+ * @example
+ *
+ * ```ts
+ * formatCurrency(3001, 'en-US') // => '$3.00K'
+ * ```
+ *
+ * @export
+ * @param {number} value - The number to be formatted.
+ * @param {string} locale - The locale to be used.
+ * @param {Intl.NumberFormatOptions} [options] - The options to be used.
+ * @return {string}
+ */
+export declare function formatCurrency(value: number, locale: string, options?: Intl.NumberFormatOptions): string;

package/dist/types/index.d.ts

@@ -1,7 +1,10 @@
-export { hexToRgbaDeckGL } from './colors/hexToRgbaDeckGL';
-export { rgbaDeckGLToHex } from './colors/rgbaDeckGLToHex/rgbaDeckGLToHex';
-export * from './colors/rgbaDeckGLToHex/types';
-export { matchText } from './strings/matchText/matchText';
-export * from './strings/matchText/types';
+export { hexToRgbaDeckGL } from './colors/hex-to-gba-deckgl/hex-to-gba-deckgl';
+export { rgbaDeckGLToHex } from './colors/rgba-deck-gl-to-hex/rgba-deck-gl-to-hex';
+export * from './colors/rgba-deck-gl-to-hex/types';
+export { matchText } from './strings/match-text/match-text';
+export * from './strings/match-text/types';
 export { normalize } from './strings/normalize/normalize';
 export * from './strings/normalize/types';
+export { formatDate } from './formatters/date/format-date';
+export { formatNumber, formatCurrency } from './formatters/number/format-number';
+export * from './formatters/constants';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@carto/ps-utils",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "CARTO's Professional Service Utils library",
   "files": [
     "dist"

package/dist/ps-utils.es.js

@@ -1,47 +0,0 @@
-function f(n, r = 1) {
-  if (!n) {
-    console.warn(`hexToRgbaDeckGL: ${n} invalid hexadecimal format`);
-    return;
-  }
-  if (r < 0 || r > 1) {
-    console.warn(`hexToRgbaDeckGL: ${r} invalid alpha format`);
-    return;
-  }
-  if (n != null && n.includes("#") && (n = n.slice(1)), !/[0-9A-Fa-f]{6}/g.test(n) && !/[0-9A-Fa-f]{3}/g.test(n) && !/[0-9A-Fa-f]{2}/g.test(n)) {
-    console.warn(`hexToRgbaDeckGL: ${n} invalid hexadecimal format`);
-    return;
-  }
-  const t = n.length;
-  t < 6 && (n = n.slice(0, 6 - t).repeat(6 / t));
-  const e = parseInt(n.length === 3 ? n.slice(0, 1).repeat(2) : n.slice(0, 2), 16), o = parseInt(n.length === 3 ? n.slice(1, 2).repeat(2) : n.slice(2, 4), 16), s = parseInt(n.length === 3 ? n.slice(2, 3).repeat(2) : n.slice(4, 6), 16);
-  return [e, o, s, r * 255];
-}
-function g(n, { withPrefix: r = !0 } = {}) {
-  if (!n || !n.length) {
-    console.warn("rgbaDeckGLToHex: invalid array or empty values");
-    return;
-  }
-  if (n.some((o) => o < 0 || o > 255)) {
-    console.warn(`rgbaDeckGLToHex: [${n.toString()}] invalid array value format`);
-    return;
-  }
-  const e = n.map((o) => o.toString(16).padStart(2, "0")).join("");
-  return `${r ? "#" : ""}${e}`;
-}
-function u(n, { format: r = "NFD", replaceUnicode: t = "[\u0300-\u036F]" } = {}) {
-  const e = new RegExp(t, "g");
-  return n.normalize(r).replace(e, "");
-}
-function c(n, r, { matchFn: t, normalizeOptions: e } = {}) {
-  const o = new RegExp(u(n.toLowerCase(), e), "gi");
-  return Array.isArray(r) ? r.filter((s) => {
-    const i = t ? t(s) : s;
-    return u(i).match(o);
-  }) : u(r).match(o) ? r : null;
-}
-export {
-  f as hexToRgbaDeckGL,
-  c as matchText,
-  u as normalize,
-  g as rgbaDeckGLToHex
-};

package/dist/ps-utils.umd.js

@@ -1 +0,0 @@
-(function(t,i){typeof exports=="object"&&typeof module<"u"?i(exports):typeof define=="function"&&define.amd?define(["exports"],i):(t=typeof globalThis<"u"?globalThis:t||self,i(t.PsUtils={}))})(this,function(t){"use strict";function i(n,e=1){if(!n){console.warn(`hexToRgbaDeckGL: ${n} invalid hexadecimal format`);return}if(e<0||e>1){console.warn(`hexToRgbaDeckGL: ${e} invalid alpha format`);return}if(n!=null&&n.includes("#")&&(n=n.slice(1)),!/[0-9A-Fa-f]{6}/g.test(n)&&!/[0-9A-Fa-f]{3}/g.test(n)&&!/[0-9A-Fa-f]{2}/g.test(n)){console.warn(`hexToRgbaDeckGL: ${n} invalid hexadecimal format`);return}const r=n.length;r<6&&(n=n.slice(0,6-r).repeat(6/r));const s=parseInt(n.length===3?n.slice(0,1).repeat(2):n.slice(0,2),16),o=parseInt(n.length===3?n.slice(1,2).repeat(2):n.slice(2,4),16),u=parseInt(n.length===3?n.slice(2,3).repeat(2):n.slice(4,6),16);return[s,o,u,e*255]}function c(n,{withPrefix:e=!0}={}){if(!n||!n.length){console.warn("rgbaDeckGLToHex: invalid array or empty values");return}if(n.some(o=>o<0||o>255)){console.warn(`rgbaDeckGLToHex: [${n.toString()}] invalid array value format`);return}const s=n.map(o=>o.toString(16).padStart(2,"0")).join("");return`${e?"#":""}${s}`}function f(n,{format:e="NFD",replaceUnicode:r="[\u0300-\u036F]"}={}){const s=new RegExp(r,"g");return n.normalize(e).replace(s,"")}function g(n,e,{matchFn:r,normalizeOptions:s}={}){const o=new RegExp(f(n.toLowerCase(),s),"gi");return Array.isArray(e)?e.filter(u=>{const l=r?r(u):u;return f(l).match(o)}):f(e).match(o)?e:null}t.hexToRgbaDeckGL=i,t.matchText=g,t.normalize=f,t.rgbaDeckGLToHex=c,Object.defineProperties(t,{__esModule:{value:!0},[Symbol.toStringTag]:{value:"Module"}})});