@swissgeo/numbers 1.0.0-beta.1

package/dist/index.d.ts

@@ -0,0 +1,94 @@
+/**
+ * Compute the circular mean of radians angles
+ *
+ * @param values List of radians angles to compute the circular mean
+ * @returns Circular mean in radians
+ * @see https://en.wikipedia.org/wiki/Circular_mean
+ */
+export declare function circularMean(values: number[]): number | undefined;
+
+/**
+ * @param value A floating number
+ * @param fromList A list of integer
+ * @returns The closest value, from the list of integer, matching the floating number (will floor or
+ *   ceil accordingly)
+ */
+export declare function closest(value: number, fromList: number[]): number;
+
+/**
+ * Format this number into a string with the `de-CH` locale (thousands separator is ')
+ *
+ * @param value The value to be formatted
+ * @param decimal How many decimals should be shown
+ */
+export declare function format(value: number, decimal?: number): string;
+
+/**
+ * Returns a string representing a number with the right thousand separator
+ *
+ * @param num A number, or a string representing a number
+ * @param separator The thousand separator, default to "'"
+ * @returns String A formatted string representing a number, e.g. 1'546
+ */
+export declare function formatThousand(num: number | string, separator?: string): string;
+
+export declare interface GeoadminNumberUtils {
+    round: typeof round;
+    closest: typeof closest;
+    isNumber: typeof isNumber;
+    randomIntBetween: typeof randomIntBetween;
+    format: typeof format;
+    formatThousand: typeof formatThousand;
+    wrapDegrees: typeof wrapDegrees;
+    isTimestampYYYYMMDD: typeof isTimestampYYYYMMDD;
+    circularMean: typeof circularMean;
+}
+
+/**
+ * Returns true if value represents or is a number (a string containing a valid number will return
+ * true)
+ */
+export declare function isNumber(value: unknown): boolean;
+
+/**
+ * Test if the given string match a timestamp of the format YYYYMMDD
+ *
+ * NOTE: it only supports timestamp from 00000101 to 99991231
+ *
+ * @param timestamp
+ * @returns True if it match false otherwise
+ */
+export declare function isTimestampYYYYMMDD(timestamp: string): boolean;
+
+declare const numbers: GeoadminNumberUtils;
+export default numbers;
+export { numbers }
+
+/**
+ * Returns a random int in the range provided
+ *
+ * @param start The start of the range
+ * @param end The end of the range, must be greater than the start
+ * @returns A random number between start and end (both included), or 0 if either start or end is
+ *   not a number or start is bigger than the end
+ */
+export declare function randomIntBetween(start: number, end: number): number;
+
+/** @module swissgeo/numbers */
+/**
+ * Rounds the given value according to how many decimals are wanted
+ *
+ * @param value
+ * @param decimals How many decimals after the separator must be present after rounding (default to
+ *   0)
+ * @returns Value rounded
+ */
+export declare function round(value: number, decimals?: number): number;
+
+/**
+ * Makes sure that the given angle stays between -359.99999 and 359.9999 degrees (will start over at
+ * 0 whenever a full-circle is present)
+ */
+export declare function wrapDegrees(angleInDegrees: number): number;
+
+export { }

package/dist/index.js

@@ -0,0 +1,69 @@
+function s(n, r = 0) {
+  if (!i(n))
+    return Number.NaN;
+  if (r === 0)
+    return Math.round(n);
+  const t = Math.pow(10, r);
+  return Math.round(n * t) / t;
+}
+function f(n, r) {
+  if (Array.isArray(r) && r.length > 2) {
+    const t = r.map((u) => Math.abs(n - u)), e = t.reduce(
+      (u, c) => u > c ? c : u
+    ), o = t.indexOf(e);
+    return typeof r[o] != "number" || isNaN(r[o]) ? n : r[o];
+  }
+  return n;
+}
+function i(n) {
+  return n != null && !Number.isNaN(Number(n)) && (typeof n != "string" || n.length !== 0);
+}
+function h(n, r) {
+  return !Number.isInteger(n) || !Number.isInteger(r) || r < n ? 0 : Math.floor(Math.random() * (r - n + 1) + n);
+}
+const a = /\B(?=(\d{3})+(?!\d))/g;
+function p(n, r = 2) {
+  return i(n) ? `${s(n, r)}`.replace(a, "'") : "";
+}
+function d(n, r = "'") {
+  const t = ".", e = `${n}`.split(t);
+  return typeof e[0] != "string" || e[0].length === 0 ? `${n}` : (e[0] = e[0].replace(a, r), e.join(t));
+}
+function m(n) {
+  const r = Math.sign(n), t = Math.abs(n);
+  return t > 360 ? r * (t % 360) : t === 360 ? 0 : n;
+}
+function M(n) {
+  return /^\d{4}(1[0-2]|0[1-9])(0[1-9]|[1-2][0-9]|3[0-1])$/.test(n);
+}
+function N(n) {
+  if (!Array.isArray(n) || n.some((o) => !i(o)))
+    return;
+  const r = n.reduce((o, u) => o + Math.cos(u), 0), t = n.reduce((o, u) => o + Math.sin(u), 0);
+  let e = Math.atan2(t, r);
+  return e < 0 && (e = 6.2831853 + e), e;
+}
+const b = {
+  round: s,
+  closest: f,
+  isNumber: i,
+  randomIntBetween: h,
+  format: p,
+  formatThousand: d,
+  wrapDegrees: m,
+  isTimestampYYYYMMDD: M,
+  circularMean: N
+};
+export {
+  N as circularMean,
+  f as closest,
+  b as default,
+  p as format,
+  d as formatThousand,
+  i as isNumber,
+  M as isTimestampYYYYMMDD,
+  b as numbers,
+  h as randomIntBetween,
+  s as round,
+  m as wrapDegrees
+};

package/dist/index.umd.cjs

@@ -0,0 +1 @@
+(function(t,s){typeof exports=="object"&&typeof module<"u"?s(exports):typeof define=="function"&&define.amd?define(["exports"],s):(t=typeof globalThis<"u"?globalThis:t||self,s(t["@swissgeo/numbers"]={}))})(this,function(t){"use strict";function s(n,e=0){if(!c(n))return Number.NaN;if(e===0)return Math.round(n);const r=Math.pow(10,e);return Math.round(n*r)/r}function a(n,e){if(Array.isArray(e)&&e.length>2){const r=e.map(o=>Math.abs(n-o)),i=r.reduce((o,N)=>o>N?N:o),u=r.indexOf(i);return typeof e[u]!="number"||isNaN(e[u])?n:e[u]}return n}function c(n){return n!=null&&!Number.isNaN(Number(n))&&(typeof n!="string"||n.length!==0)}function f(n,e){return!Number.isInteger(n)||!Number.isInteger(e)||e<n?0:Math.floor(Math.random()*(e-n+1)+n)}const d=/\B(?=(\d{3})+(?!\d))/g;function m(n,e=2){return c(n)?`${s(n,e)}`.replace(d,"'"):""}function h(n,e="'"){const r=".",i=`${n}`.split(r);return typeof i[0]!="string"||i[0].length===0?`${n}`:(i[0]=i[0].replace(d,e),i.join(r))}function M(n){const e=Math.sign(n),r=Math.abs(n);return r>360?e*(r%360):r===360?0:n}function b(n){return/^\d{4}(1[0-2]|0[1-9])(0[1-9]|[1-2][0-9]|3[0-1])$/.test(n)}function g(n){if(!Array.isArray(n)||n.some(u=>!c(u)))return;const e=n.reduce((u,o)=>u+Math.cos(o),0),r=n.reduce((u,o)=>u+Math.sin(o),0);let i=Math.atan2(r,e);return i<0&&(i=6.2831853+i),i}const p={round:s,closest:a,isNumber:c,randomIntBetween:f,format:m,formatThousand:h,wrapDegrees:M,isTimestampYYYYMMDD:b,circularMean:g};t.circularMean=g,t.closest=a,t.default=p,t.format=m,t.formatThousand=h,t.isNumber=c,t.isTimestampYYYYMMDD=b,t.numbers=p,t.randomIntBetween=f,t.round=s,t.wrapDegrees=M,Object.defineProperties(t,{__esModule:{value:!0},[Symbol.toStringTag]:{value:"Module"}})});

package/package.json

@@ -0,0 +1,52 @@
+{
+    "name": "@swissgeo/numbers",
+    "version": "1.0.0-beta.1",
+    "description": "Numbers utils for SWISSGEO projects.",
+    "license": "BSD-3-Clause",
+    "type": "module",
+    "exports": {
+        ".": {
+            "types": "./dist/index.d.ts",
+            "import": "./dist/index.js",
+            "require": "./dist/index.umd.cjs"
+        }
+    },
+    "files": [
+        "dist"
+    ],
+    "scripts": {
+        "build": "pnpm run type-check && pnpm run generate-types && vite build",
+        "build:dev": "pnpm run build --mode development",
+        "build:dev:watch": "pnpm run build --watch --mode development",
+        "build:int": "pnpm run build --mode integration",
+        "build:prod": "pnpm run build --mode production",
+        "dev": "vite",
+        "generate-types": "tsc --declaration",
+        "lint": "eslint --fix",
+        "lint:no-fix": "eslint",
+        "test:unit": "vitest --run --mode development --environment jsdom",
+        "test:unit:watch": "vitest --mode development --environment jsdom",
+        "type-check": "tsc -p tsconfig.json"
+    },
+    "dependencies": {
+        "@swissgeo/log": "workspace:*"
+    },
+    "devDependencies": {
+        "@microsoft/api-extractor": "catalog:",
+        "@prettier/plugin-xml": "catalog:",
+        "@swissgeo/config-eslint": "workspace:*",
+        "@swissgeo/config-prettier": "workspace:*",
+        "@swissgeo/config-typescript": "workspace:*",
+        "@types/chai": "catalog:",
+        "chai": "catalog:",
+        "eslint": "catalog:",
+        "prettier": "catalog:",
+        "prettier-plugin-jsdoc": "catalog:",
+        "prettier-plugin-packagejson": "catalog:",
+        "prettier-plugin-tailwindcss": "catalog:",
+        "typescript": "catalog:",
+        "unplugin-dts": "catalog:",
+        "vite": "catalog:",
+        "vitest": "catalog:"
+    }
+}