@carto/ps-utils 1.2.0 → 1.4.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"});const R=require("@turf/meta");function b(t,e=1){if(!t){console.warn(`hexToRgbaDeckGL: ${t} invalid hexadecimal format`);return}if(e<0||e>1){console.warn(`hexToRgbaDeckGL: ${e} 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 i=parseInt(t.length===3?t.slice(0,1).repeat(2):t.slice(0,2),16),r=parseInt(t.length===3?t.slice(1,2).repeat(2):t.slice(2,4),16),o=parseInt(t.length===3?t.slice(2,3).repeat(2):t.slice(4,6),16);return[i,r,o,e*255]}function I(t,{withPrefix:e=!0}={}){if(!t||!t.length){console.warn("rgbaDeckGLToHex: invalid array or empty values");return}if(t.some(r=>r<0||r>255)){console.warn(`rgbaDeckGLToHex: [${t.toString()}] invalid array value format`);return}const i=t.map(r=>r.toString(16).padStart(2,"0")).join("");return`${e?"#":""}${i}`}function l(t,{format:e="NFD",replaceUnicode:n="[̀-ͯ]"}={}){const i=new RegExp(n,"g");return t.normalize(e).replace(i,"")}function T(t,e,{matchFn:n,normalizeOptions:i}={}){const r=new RegExp(l(t.toLowerCase(),i),"gi");return Array.isArray(e)?e.filter(o=>{const c=n?n(o):o;return l(c).match(r)}):l(e).match(r)?e:null}function h(t,e,n){return Intl.DateTimeFormat(e,n).format(t)}const g={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 D(t,e,n){return Intl.NumberFormat(e,n).format(t)}function A(t,e,n={}){return D(t,e,{...g.NUMBER,...n})}function L(t,e,n={}){return D(t,e,{...g.CURRENCY,...n})}const w=/:+[a-z]+/gi;function F(t,e=[]){let n=t;const i=n.match(w)||[],r=Array.isArray(e);return i.forEach((o,c)=>{let a;if(r)a=e[c];else{const s=o.substring(1);a=e[s]}n=n.replace(o,a?.toString())}),n}const m=63710088e-1;function G(t){return R.geomReduce(t,function(e,n){return e+k(n)},0)}function k(t){let e=0,n;switch(t.type){case"Polygon":return p(t.coordinates);case"MultiPolygon":for(n=0;n<t.coordinates.length;n++)e+=p(t.coordinates[n]);return e;case"Point":case"MultiPoint":case"LineString":case"MultiLineString":return 0}return 0}function p(t){let e=0;if(t&&t.length>0){e+=Math.abs(y(t[0]));for(let n=1;n<t.length;n++)e-=Math.abs(y(t[n]))}return e}function y(t){let e,n,i,r,o,c,a,s=0;const u=t.length;if(u>2){for(a=0;a<u;a++)a===u-2?(r=u-2,o=u-1,c=0):a===u-1?(r=u-1,o=0,c=1):(r=a,o=a+1,c=a+2),e=t[r],n=t[o],i=t[c],s+=(f(i[0])-f(e[0]))*Math.sin(f(n[1]));s=s*m*m/2}return s}function f(t){return t*Math.PI/180}exports.CONFIG=g;exports.area=G;exports.formatCurrency=L;exports.formatDate=h;exports.formatNumber=A;exports.hexToRgbaDeckGL=b;exports.matchText=T;exports.normalize=l;exports.replaceRoute=F;exports.rgbaDeckGLToHex=I;

package/dist/index.js

@@ -1,4 +1,5 @@
-function f(t, n = 1) {
+import { geomReduce as R } from "@turf/meta";
+function w(t, n = 1) {
   if (!t) {
     console.warn(`hexToRgbaDeckGL: ${t} invalid hexadecimal format`);
     return;
@@ -13,50 +14,50 @@ function f(t, n = 1) {
   }
   const r = t.length;
   r < 6 && (t = t.slice(0, 6 - r).repeat(6 / r));
-  const e = parseInt(
+  const i = parseInt(
     t.length === 3 ? t.slice(0, 1).repeat(2) : t.slice(0, 2),
     16
-  ), o = parseInt(
+  ), e = parseInt(
     t.length === 3 ? t.slice(1, 2).repeat(2) : t.slice(2, 4),
     16
-  ), i = parseInt(
+  ), o = parseInt(
     t.length === 3 ? t.slice(2, 3).repeat(2) : t.slice(4, 6),
     16
   );
-  return [e, o, i, n * 255];
+  return [i, e, o, n * 255];
 }
-function g(t, { withPrefix: n = !0 } = {}) {
+function L(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)) {
+  if (t.some((e) => e < 0 || e > 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}`;
+  const i = t.map((e) => e.toString(16).padStart(2, "0")).join("");
+  return `${n ? "#" : ""}${i}`;
 }
-function s(t, { format: n = "NFD", replaceUnicode: r = "[̀-ͯ]" } = {}) {
-  const e = new RegExp(r, "g");
-  return t.normalize(n).replace(e, "");
+function l(t, { format: n = "NFD", replaceUnicode: r = "[̀-ͯ]" } = {}) {
+  const i = new RegExp(r, "g");
+  return t.normalize(n).replace(i, "");
 }
-function l(t, n, { matchFn: r, normalizeOptions: e } = {}) {
-  const o = new RegExp(
-    s(t.toLowerCase(), e),
+function F(t, n, { matchFn: r, normalizeOptions: i } = {}) {
+  const e = new RegExp(
+    l(t.toLowerCase(), i),
     "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(n) ? n.filter((o) => {
+    const a = r ? r(o) : o;
+    return l(a).match(e);
+  }) : l(n).match(e) ? n : null;
 }
-function m(t, n, r) {
+function T(t, n, r) {
   return Intl.DateTimeFormat(n, r).format(t);
 }
-const c = {
+const y = {
   NUMBER: {
     style: "decimal",
     maximumFractionDigits: 1,
@@ -78,22 +79,88 @@ const c = {
     day: "2-digit"
   }
 };
-function u(t, n, r) {
+function D(t, n, r) {
   return Intl.NumberFormat(n, r).format(t);
 }
-function D(t, n, r = {}) {
-  return u(t, n, { ...c.NUMBER, ...r });
+function b(t, n, r = {}) {
+  return D(t, n, { ...y.NUMBER, ...r });
+}
+function M(t, n, r = {}) {
+  return D(t, n, { ...y.CURRENCY, ...r });
+}
+const A = /:+[a-z]+/gi;
+function k(t, n = []) {
+  let r = t;
+  const i = r.match(A) || [], e = Array.isArray(n);
+  return i.forEach((o, a) => {
+    let c;
+    if (e)
+      c = n[a];
+    else {
+      const u = o.substring(1);
+      c = n[u];
+    }
+    r = r.replace(o, c?.toString());
+  }), r;
+}
+const g = 63710088e-1;
+function E(t) {
+  return R(
+    t,
+    function(n, r) {
+      return n + I(r);
+    },
+    0
+  );
+}
+function I(t) {
+  let n = 0, r;
+  switch (t.type) {
+    case "Polygon":
+      return p(t.coordinates);
+    case "MultiPolygon":
+      for (r = 0; r < t.coordinates.length; r++)
+        n += p(t.coordinates[r]);
+      return n;
+    case "Point":
+    case "MultiPoint":
+    case "LineString":
+    case "MultiLineString":
+      return 0;
+  }
+  return 0;
+}
+function p(t) {
+  let n = 0;
+  if (t && t.length > 0) {
+    n += Math.abs(m(t[0]));
+    for (let r = 1; r < t.length; r++)
+      n -= Math.abs(m(t[r]));
+  }
+  return n;
+}
+function m(t) {
+  let n, r, i, e, o, a, c, u = 0;
+  const s = t.length;
+  if (s > 2) {
+    for (c = 0; c < s; c++)
+      c === s - 2 ? (e = s - 2, o = s - 1, a = 0) : c === s - 1 ? (e = s - 1, o = 0, a = 1) : (e = c, o = c + 1, a = c + 2), n = t[e], r = t[o], i = t[a], u += (f(i[0]) - f(n[0])) * Math.sin(f(r[1]));
+    u = u * g * g / 2;
+  }
+  return u;
 }
-function p(t, n, r = {}) {
-  return u(t, n, { ...c.CURRENCY, ...r });
+function f(t) {
+  return t * Math.PI / 180;
 }
 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
+  y as CONFIG,
+  E as area,
+  M as formatCurrency,
+  T as formatDate,
+  b as formatNumber,
+  w as hexToRgbaDeckGL,
+  F as matchText,
+  l as normalize,
+  k as replaceRoute,
+  L 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/features/area.d.ts

@@ -0,0 +1,17 @@
+import type { GeojsonAreaProps } from './types';
+/**
+ * Takes one or more features and returns their area in square meters paying attention to earth radius.
+ * It's fixed in turf.js v7.0.0+ for previous versions of turf use this function instead turf.area
+ * @name area
+ * @param {GeojsonAreaProps>} geojson {GeoJSON} input GeoJSON feature(s)
+ * @returns {number} area in square meters
+ * @example
+ * let polygon = turf.polygon([[[125, -15], [113, -22], [154, -27], [144, -15], [125, -15]]]);
+ *
+ * let area = turf.area(polygon);
+ *
+ * //addToMap
+ * let addToMap = [polygon]
+ * polygon.properties.area = area
+ */
+export declare function area(geojson: GeojsonAreaProps): any;

package/dist/types/features/types.d.ts

@@ -0,0 +1,4 @@
+import type { Geometries } from '@turf/helpers';
+import type { Feature, FeatureCollection, LineString, GeoJsonProperties, MultiLineString, MultiPoint, MultiPolygon, Point, Polygon } from 'geojson';
+export type GeomAreaProps = Point | LineString | Polygon | MultiPoint | MultiLineString | MultiPolygon;
+export type GeojsonAreaProps = Geometries | FeatureCollection<Geometries, GeoJsonProperties> | Feature<Geometries, GeoJsonProperties>;

package/dist/types/index.d.ts

@@ -8,3 +8,7 @@ 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';
+export { area } from './features/area';
+export * from './features/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.4.0",
   "description": "CARTO's Professional Service Utils library",
   "files": [
     "dist"
@@ -17,16 +17,22 @@
     }
   },
   "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"
+  "peerDependencies": {
+    "@turf/meta": ">= 6.x < 7.x"
   },
-  "dependencies": {}
+  "dependencies": {
+    "@turf/meta": "6.5.0"
+  },
+  "devDependencies": {
+    "@turf/helpers": "6.5.0",
+    "@types/geojson": "7946.0.11"
+  }
 }

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 {};