@carto/ps-utils 1.2.0 → 1.3.0

package/dist/index.cjs

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});function f(t,r=1){if(!t){console.warn(`hexToRgbaDeckGL: ${t} invalid hexadecimal format`);return}if(r<0||r>1){console.warn(`hexToRgbaDeckGL: ${r} 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 n=t.length;n<6&&(t=t.slice(0,6-n).repeat(6/n));const o=parseInt(t.length===3?t.slice(0,1).repeat(2):t.slice(0,2),16),e=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[o,e,i,r*255]}function g(t,{withPrefix:r=!0}={}){if(!t||!t.length){console.warn("rgbaDeckGLToHex: invalid array or empty values");return}if(t.some(e=>e<0||e>255)){console.warn(`rgbaDeckGLToHex: [${t.toString()}] invalid array value format`);return}const o=t.map(e=>e.toString(16).padStart(2,"0")).join("");return`${r?"#":""}${o}`}function c(t,{format:r="NFD",replaceUnicode:n="[̀-ͯ]"}={}){const o=new RegExp(n,"g");return t.normalize(r).replace(o,"")}function m(t,r,{matchFn:n,normalizeOptions:o}={}){const e=new RegExp(c(t.toLowerCase(),o),"gi");return Array.isArray(r)?r.filter(i=>{const a=n?n(i):i;return c(a).match(e)}):c(r).match(e)?r:null}function l(t,r,n){return Intl.DateTimeFormat(r,n).format(t)}const s={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,r,n){return Intl.NumberFormat(r,n).format(t)}function D(t,r,n={}){return u(t,r,{...s.NUMBER,...n})}function p(t,r,n={}){return u(t,r,{...s.CURRENCY,...n})}exports.CONFIG=s;exports.formatCurrency=p;exports.formatDate=l;exports.formatNumber=D;exports.hexToRgbaDeckGL=f;exports.matchText=m;exports.normalize=c;exports.rgbaDeckGLToHex=g;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});function l(t,r=1){if(!t){console.warn(`hexToRgbaDeckGL: ${t} invalid hexadecimal format`);return}if(r<0||r>1){console.warn(`hexToRgbaDeckGL: ${r} 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 n=t.length;n<6&&(t=t.slice(0,6-n).repeat(6/n));const o=parseInt(t.length===3?t.slice(0,1).repeat(2):t.slice(0,2),16),e=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[o,e,i,r*255]}function m(t,{withPrefix:r=!0}={}){if(!t||!t.length){console.warn("rgbaDeckGLToHex: invalid array or empty values");return}if(t.some(e=>e<0||e>255)){console.warn(`rgbaDeckGLToHex: [${t.toString()}] invalid array value format`);return}const o=t.map(e=>e.toString(16).padStart(2,"0")).join("");return`${r?"#":""}${o}`}function c(t,{format:r="NFD",replaceUnicode:n="[̀-ͯ]"}={}){const o=new RegExp(n,"g");return t.normalize(r).replace(o,"")}function D(t,r,{matchFn:n,normalizeOptions:o}={}){const e=new RegExp(c(t.toLowerCase(),o),"gi");return Array.isArray(r)?r.filter(i=>{const s=n?n(i):i;return c(s).match(e)}):c(r).match(e)?r:null}function p(t,r,n){return Intl.DateTimeFormat(r,n).format(t)}const u={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 f(t,r,n){return Intl.NumberFormat(r,n).format(t)}function y(t,r,n={}){return f(t,r,{...u.NUMBER,...n})}function R(t,r,n={}){return f(t,r,{...u.CURRENCY,...n})}const T=/:+[a-z]+/gi;function b(t,r=[]){let n=t;const o=n.match(T)||[],e=Array.isArray(r);return o.forEach((i,s)=>{let a;if(e)a=r[s];else{const g=i.substring(1);a=r[g]}n=n.replace(i,a?.toString())}),n}exports.CONFIG=u;exports.formatCurrency=R;exports.formatDate=p;exports.formatNumber=y;exports.hexToRgbaDeckGL=l;exports.matchText=D;exports.normalize=c;exports.replaceRoute=b;exports.rgbaDeckGLToHex=m;

package/dist/index.js

@@ -1,18 +1,18 @@
-function f(t, n = 1) {
+function m(t, r = 1) {
   if (!t) {
     console.warn(`hexToRgbaDeckGL: ${t} invalid hexadecimal format`);
     return;
   }
-  if (n < 0 || n > 1) {
-    console.warn(`hexToRgbaDeckGL: ${n} invalid alpha format`);
+  if (r < 0 || r > 1) {
+    console.warn(`hexToRgbaDeckGL: ${r} 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 n = t.length;
+  n < 6 && (t = t.slice(0, 6 - n).repeat(6 / n));
   const e = parseInt(
     t.length === 3 ? t.slice(0, 1).repeat(2) : t.slice(0, 2),
     16
@@ -23,9 +23,9 @@ function f(t, n = 1) {
     t.length === 3 ? t.slice(2, 3).repeat(2) : t.slice(4, 6),
     16
   );
-  return [e, o, i, n * 255];
+  return [e, o, i, r * 255];
 }
-function g(t, { withPrefix: n = !0 } = {}) {
+function p(t, { withPrefix: r = !0 } = {}) {
   if (!t || !t.length) {
     console.warn("rgbaDeckGLToHex: invalid array or empty values");
     return;
@@ -37,26 +37,26 @@ function g(t, { withPrefix: n = !0 } = {}) {
     return;
   }
   const e = t.map((o) => o.toString(16).padStart(2, "0")).join("");
-  return `${n ? "#" : ""}${e}`;
+  return `${r ? "#" : ""}${e}`;
 }
-function s(t, { format: n = "NFD", replaceUnicode: r = "[̀-ͯ]" } = {}) {
-  const e = new RegExp(r, "g");
-  return t.normalize(n).replace(e, "");
+function u(t, { format: r = "NFD", replaceUnicode: n = "[̀-ͯ]" } = {}) {
+  const e = new RegExp(n, "g");
+  return t.normalize(r).replace(e, "");
 }
-function l(t, n, { matchFn: r, normalizeOptions: e } = {}) {
+function D(t, r, { matchFn: n, normalizeOptions: e } = {}) {
   const o = new RegExp(
-    s(t.toLowerCase(), e),
+    u(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;
+  return Array.isArray(r) ? r.filter((i) => {
+    const s = n ? n(i) : i;
+    return u(s).match(o);
+  }) : u(r).match(o) ? r : null;
 }
-function m(t, n, r) {
-  return Intl.DateTimeFormat(n, r).format(t);
+function y(t, r, n) {
+  return Intl.DateTimeFormat(r, n).format(t);
 }
-const c = {
+const a = {
   NUMBER: {
     style: "decimal",
     maximumFractionDigits: 1,
@@ -78,22 +78,38 @@ const c = {
     day: "2-digit"
   }
 };
-function u(t, n, r) {
-  return Intl.NumberFormat(n, r).format(t);
+function f(t, r, n) {
+  return Intl.NumberFormat(r, n).format(t);
 }
-function D(t, n, r = {}) {
-  return u(t, n, { ...c.NUMBER, ...r });
+function R(t, r, n = {}) {
+  return f(t, r, { ...a.NUMBER, ...n });
 }
-function p(t, n, r = {}) {
-  return u(t, n, { ...c.CURRENCY, ...r });
+function F(t, r, n = {}) {
+  return f(t, r, { ...a.CURRENCY, ...n });
+}
+const l = /:+[a-z]+/gi;
+function T(t, r = []) {
+  let n = t;
+  const e = n.match(l) || [], o = Array.isArray(r);
+  return e.forEach((i, s) => {
+    let c;
+    if (o)
+      c = r[s];
+    else {
+      const g = i.substring(1);
+      c = r[g];
+    }
+    n = n.replace(i, c?.toString());
+  }), n;
 }
 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
+  a as CONFIG,
+  F as formatCurrency,
+  y as formatDate,
+  R as formatNumber,
+  m as hexToRgbaDeckGL,
+  D as matchText,
+  u as normalize,
+  T as replaceRoute,
+  p as rgbaDeckGLToHex
 };

package/dist/types/clipboard/copy.d.ts

@@ -1 +1,16 @@
+/**
+ * This function is a helper function to copy text to the clipboard.
+ *
+ * @param {string} text - The text to copy to the clipboard.
+ *
+ * @returns {void}
+ *
+ *
+ * @example
+ * ```ts
+ * import { copy } from '@carto/ps-utils'
+ *
+ * copy('Hello world!')
+ * ```
+ */
 export declare function copy(text: string): void;

package/dist/types/colors/hex-to-gba-deckgl/hex-to-gba-deckgl.d.ts

@@ -21,6 +21,6 @@
  * hexToRgbaDeckGL('#d1', 1)
  * ```
  *
- * @alpha
+ * @deprecated use `hexToRgb` from `@deck.gl/carto/typed/style/palette` instead
  */
 export declare function hexToRgbaDeckGL(hexadecimal: string, alpha?: number): number[] | undefined;

package/dist/types/colors/rgba-deck-gl-to-hex/rgba-deck-gl-to-hex.d.ts

@@ -24,7 +24,5 @@ import { RgbaDeckGLToHexOptions } from './types';
  * rgbaDeckGLToHex([0, 0, 0], { withPrefix: false }) // => '000000'
  * ```
  *
- *
- * @alpha
  */
 export declare function rgbaDeckGLToHex(rgba: number[], { withPrefix }?: RgbaDeckGLToHexOptions): string | undefined;

package/dist/types/index.d.ts

@@ -8,3 +8,5 @@ export * from './strings/normalize/types';
 export { formatDate } from './formatters/date/format-date';
 export { formatNumber, formatCurrency } from './formatters/number/format-number';
 export * from './formatters/constants';
+export * from './routes/replace-route';
+export * from './routes/types';

package/dist/types/routes/replace-route.d.ts

@@ -0,0 +1,23 @@
+import { Route, Values } from './types';
+/**
+ * Replace route with values from array or object.
+ * @param {Route} data
+ * @param {Values} values
+ *
+ * @returns {Route}
+ *
+ * @example
+ * ```ts
+ * replaceRoute('/user/:id', { id: 1 }) // /user/1
+ * replaceRoute('/user/:id/:name', [1, 'John']) // /user/1/John
+ * ```
+ *
+ * @remarks
+ * This function is used to replace the route with the values from the array or object. If the values are not found, it will replace it with `undefined`.
+ *
+ * ```ts
+ *  replaceRoute('/user/:id/:name', [1]) // /user/1/undefined
+ * ```
+ *
+ **/
+export declare function replaceRoute(data: Route, values?: Values): string;

package/dist/types/routes/types.d.ts

@@ -0,0 +1,2 @@
+export type Route = string;
+export type Values = Record<string, string | number> | (string | number)[];

package/dist/types/strings/match-text/match-text.d.ts

@@ -8,6 +8,5 @@ import { MatchTextOptions } from './types';
  *
  * @returns {T[] | string | null} - The matched data or null.
  *
- * @alpha
  */
 export declare function matchText<T>(text: string, data: T[] | string, { matchFn, normalizeOptions }?: MatchTextOptions<T>): T[] | string | null;

package/dist/types/strings/normalize/normalize.d.ts

@@ -14,6 +14,5 @@ import { NormalizeOptions } from './types';
  * normalize('foo bar')
  * ```
  *
- * @alpha
  */
 export declare function normalize(data: string, { format, replaceUnicode }?: NormalizeOptions): string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@carto/ps-utils",
-  "version": "1.2.0",
+  "version": "1.3.0",
   "description": "CARTO's Professional Service Utils library",
   "files": [
     "dist"
@@ -17,16 +17,13 @@
     }
   },
   "scripts": {
-    "build": "vite build && tsc",
+    "prebuild": "npm exec rimraf dist",
+    "build": "tsc && vite build",
     "lint": "eslint src --ext ts,tsx,js,jsx,json --ignore-path ../../.gitignore --fix",
     "format": "prettier --write . --ignore-path ../../.gitignore",
     "test:watch": "vitest",
     "test:related": "vitest --run --passWithNoTests",
     "test:coverage": "vitest run --coverage"
   },
-  "typedoc": {
-    "entryPoint": "./src/index.ts",
-    "readmeFile": "./README.md"
-  },
   "dependencies": {}
 }

package/dist/types/clipboard/copy.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/types/colors/hex-to-gba-deckgl/hex-to-gba-deckgl.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/types/colors/rgba-deck-gl-to-hex/rgba-deck-gl-to-hex.test.d.ts

@@ -1 +0,0 @@
-export {};

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

@@ -1 +0,0 @@
-export {};

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

@@ -1 +0,0 @@
-export {};

package/dist/types/strings/match-text/match-text.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/types/strings/normalize/normalize.test.d.ts

@@ -1 +0,0 @@
-export {};