@swissgeo/numbers 1.0.0-beta.2 → 1.0.0

package/README.md

@@ -0,0 +1,89 @@
+# @swissgeo/numbers
+
+Number manipulation and formatting utilities for SWISSGEO projects.
+
+## Overview
+
+This package provides a collection of utility functions for working with numbers, including rounding, formatting with Swiss locale, calculating circular means, and other common mathematical operations used within the SWISSGEO ecosystem.
+
+## Installation
+
+```bash
+npm install @swissgeo/numbers
+```
+
+## Features
+
+- **Rounding & Comparison**: `round`, `closest`, `isNumber`.
+- **Formatting**: `format` (Swiss locale), `formatThousand` with custom separators.
+- **Math & Utilities**: `randomIntBetween`, `wrapDegrees`, `circularMean`.
+- **Validation**: `isTimestampYYYYMMDD`.
+
+## Usage
+
+### Basic Usage
+
+The default export provides access to all utility functions.
+
+```typescript
+import { round, isNumber } from '@swissgeo/numbers'
+
+const rounded = round(1.2345, 2) // 1.23
+const isNum = isNumber('123') // true
+```
+
+### Rounding and Closest Value
+
+```typescript
+import { round, closest } from '@swissgeo/numbers'
+
+// Rounding to 2 decimal places
+round(10.556, 2) // 10.56
+
+// Finding the closest value in a list
+closest(15, [10, 20, 30]) // 20
+```
+
+### Formatting
+
+The `format` function uses the `de-CH` locale convention (using `'` as a thousands separator).
+
+```typescript
+import { format, formatThousand } from '@swissgeo/numbers'
+
+// Swiss formatting (thousands separator is ')
+format(1234.567) // "1'234.57"
+
+// Custom thousand separator
+formatThousand(1000000, ' ') // "1 000 000"
+```
+
+### Circular Mean and Degrees
+
+Useful for handling angles and rotations.
+
+```typescript
+import { wrapDegrees, circularMean } from '@swissgeo/numbers'
+
+// Wrap angle to [-360, 360] range
+wrapDegrees(370) // 10
+
+// Compute circular mean of radians
+circularMean([0, Math.PI / 2]) // 0.785398... (Math.PI / 4)
+```
+
+### Random Integers
+
+```typescript
+import { randomIntBetween } from '@swissgeo/numbers'
+
+const random = randomIntBetween(1, 10) // Random integer between 1 and 10 (inclusive)
+```
+
+## License
+
+BSD-3-Clause
+
+## Repository
+
+[https://github.com/geoadmin/web-mapviewer](https://github.com/geoadmin/web-mapviewer)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@swissgeo/numbers",
-  "version": "1.0.0-beta.2",
+  "version": "1.0.0",
   "description": "Numbers utils for SWISSGEO projects.",
   "license": "BSD-3-Clause",
   "type": "module",
@@ -15,25 +15,19 @@
     "dist"
   ],
   "dependencies": {
-    "@swissgeo/log": "1.0.0-beta.2"
+    "@swissgeo/log": "1.0.0"
   },
   "devDependencies": {
-    "@microsoft/api-extractor": "^7.55.0",
-    "@prettier/plugin-xml": "^3.4.2",
+    "@microsoft/api-extractor": "^7.55.2",
     "@types/chai": "^5.2.3",
-    "chai": "^6.2.1",
-    "eslint": "^9.39.1",
-    "prettier": "^3.6.2",
-    "prettier-plugin-jsdoc": "^1.5.0",
-    "prettier-plugin-packagejson": "^2.5.19",
-    "prettier-plugin-tailwindcss": "^0.7.1",
+    "chai": "^6.2.2",
+    "eslint": "^9.39.2",
     "typescript": "^5.9.3",
     "unplugin-dts": "1.0.0-beta.6",
-    "vite": "^7.2.2",
-    "vitest": "^4.0.8",
-    "@swissgeo/config-eslint": "1.0.0-beta.2",
-    "@swissgeo/config-typescript": "1.0.0-beta.2",
-    "@swissgeo/config-prettier": "1.0.0-beta.2"
+    "vite": "7.2.2",
+    "vitest": "^4.0.16",
+    "@swissgeo/config-eslint": "1.0.0",
+    "@swissgeo/config-typescript": "1.0.0"
   },
   "scripts": {
     "build": "pnpm run type-check && pnpm run generate-types && vite build",
@@ -45,8 +39,8 @@
     "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",
+    "test:unit": "vitest run",
+    "test:unit:watch": "vitest watch",
     "type-check": "tsc -p tsconfig.json"
   }
 }