@motioncomplex/cosmos-lib 1.0.9

package/dist/units.d.ts

@@ -0,0 +1,132 @@
+/**
+ * Unit conversion and formatting utilities for astronomical distances,
+ * angles, and Right Ascension values.
+ *
+ * @example
+ * ```ts
+ * import { Units } from '@motioncomplex/cosmos-lib'
+ * Units.auToKm(1)            // 149597870.7
+ * Units.formatRA(83.822)      // '5h 35m 17.3s'
+ * Units.formatDistance(4.07e13) // '4.307 ly'
+ * ```
+ */
+export declare const Units: {
+    /**
+     * Convert Astronomical Units to kilometres.
+     * @param au - Distance in AU.
+     * @returns Distance in kilometres.
+     */
+    readonly auToKm: (au: number) => number;
+    /**
+     * Convert kilometres to Astronomical Units.
+     * @param km - Distance in kilometres.
+     * @returns Distance in AU.
+     */
+    readonly kmToAu: (km: number) => number;
+    /**
+     * Convert light-years to parsecs.
+     * @param ly - Distance in light-years.
+     * @returns Distance in parsecs.
+     */
+    readonly lyToPc: (ly: number) => number;
+    /**
+     * Convert parsecs to light-years.
+     * @param pc - Distance in parsecs.
+     * @returns Distance in light-years.
+     */
+    readonly pcToLy: (pc: number) => number;
+    /**
+     * Convert parsecs to kilometres.
+     * @param pc - Distance in parsecs.
+     * @returns Distance in kilometres.
+     */
+    readonly pcToKm: (pc: number) => number;
+    /**
+     * Convert light-years to kilometres.
+     * @param ly - Distance in light-years.
+     * @returns Distance in kilometres.
+     */
+    readonly lyToKm: (ly: number) => number;
+    /**
+     * Convert kilometres to light-years.
+     * @param km - Distance in kilometres.
+     * @returns Distance in light-years.
+     */
+    readonly kmToLy: (km: number) => number;
+    /**
+     * Convert degrees to radians.
+     * @param d - Angle in degrees.
+     * @returns Angle in radians.
+     */
+    readonly degToRad: (d: number) => number;
+    /**
+     * Convert radians to degrees.
+     * @param r - Angle in radians.
+     * @returns Angle in degrees.
+     */
+    readonly radToDeg: (r: number) => number;
+    /**
+     * Convert arcseconds to degrees.
+     * @param a - Angle in arcseconds.
+     * @returns Angle in degrees.
+     */
+    readonly arcsecToDeg: (a: number) => number;
+    /**
+     * Convert degrees to arcseconds.
+     * @param d - Angle in degrees.
+     * @returns Angle in arcseconds.
+     */
+    readonly degToArcsec: (d: number) => number;
+    /**
+     * Convert Right Ascension from hours to degrees.
+     * @param h - RA in hours (0–24).
+     * @returns RA in degrees (0–360).
+     */
+    readonly hrsToDeg: (h: number) => number;
+    /**
+     * Convert Right Ascension from degrees to hours.
+     * @param d - RA in degrees (0–360).
+     * @returns RA in hours (0–24).
+     */
+    readonly degToHrs: (d: number) => number;
+    /**
+     * Format a distance in kilometres into a human-readable string,
+     * automatically choosing the most appropriate unit (km, AU, ly, or Mly).
+     *
+     * @param km - Distance in kilometres.
+     * @returns Formatted string with unit suffix.
+     *
+     * @example
+     * ```ts
+     * Units.formatDistance(384_400)               // '0.002570 AU'
+     * Units.formatDistance(9_460_730_472_580 * 8.6) // '8.600 ly'
+     * ```
+     */
+    readonly formatDistance: (km: number) => string;
+    /**
+     * Format decimal degrees as d°m′s″ (signed).
+     *
+     * @param deg - Angle in decimal degrees.
+     * @returns Formatted DMS string.
+     *
+     * @example
+     * ```ts
+     * Units.formatAngle(-16.716)  // '-16°42′57.6″'
+     * Units.formatAngle(83.822)   // '83°49′19.2″'
+     * ```
+     */
+    readonly formatAngle: (deg: number) => string;
+    /**
+     * Format Right Ascension from decimal degrees into hours/minutes/seconds.
+     *
+     * @param deg - RA in decimal degrees (0–360).
+     * @returns Formatted string like `'5h 35m 17.3s'`.
+     *
+     * @example
+     * ```ts
+     * Units.formatRA(83.822)  // '5h 35m 17.3s'
+     * Units.formatRA(0)       // '0h 0m 0.0s'
+     * ```
+     */
+    readonly formatRA: (deg: number) => string;
+};

package/package.json

@@ -0,0 +1,93 @@
+{
+  "name": "@motioncomplex/cosmos-lib",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org",
+    "access": "public"
+  },
+  "version": "1.0.9",
+  "description": "Reusable astronomical utilities: data, math, media, sky maps, NASA APIs, and UI transitions.",
+  "author": "",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/MotionComplex/cosmos-lib.git"
+  },
+  "type": "module",
+  "files": [
+    "dist",
+    "!dist/**/*.map",
+    "!dist/bundle-analysis.html",
+    "README.md"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    },
+    "./three": {
+      "types": "./dist/three/index.d.ts",
+      "import": "./dist/three/index.js",
+      "require": "./dist/three/index.cjs"
+    },
+    "./react": {
+      "types": "./dist/react/index.d.ts",
+      "import": "./dist/react/index.js",
+      "require": "./dist/react/index.cjs"
+    }
+  },
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "scripts": {
+    "build": "vite build && tsc --emitDeclarationOnly --declaration --declarationDir dist",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage",
+    "typecheck": "tsc --noEmit",
+    "lint": "eslint src tests --ext .ts",
+    "docs": "typedoc",
+    "size": "npm run build && node -e \"const s=require('fs').statSync('dist/index.cjs').size;console.log('CJS:',Math.round(s/1024)+'KB');if(s>200000){console.error('Bundle exceeds 200KB!');process.exit(1)}\"",
+    "prepublishOnly": "npm run typecheck && npm test && npm run build"
+  },
+  "devDependencies": {
+    "@testing-library/react": "^16.3.2",
+    "@types/node": "^22.19.15",
+    "@types/react": "^19.2.14",
+    "@types/three": "^0.183.1",
+    "@vitest/coverage-v8": "^4.1.0",
+    "happy-dom": "^20.8.4",
+    "react": "^19.2.4",
+    "react-dom": "^19.2.4",
+    "rollup-plugin-visualizer": "^6.0.11",
+    "three": "^0.160.0",
+    "typedoc": "^0.28.17",
+    "typedoc-plugin-markdown": "^4.11.0",
+    "typescript": "^5.3.3",
+    "vite": "^6.4.1",
+    "vite-plugin-dts": "^4.5.4",
+    "vitest": "^4.1.0"
+  },
+  "peerDependencies": {
+    "react": ">=18.0.0",
+    "three": ">=0.150.0"
+  },
+  "peerDependenciesMeta": {
+    "three": {
+      "optional": true
+    },
+    "react": {
+      "optional": true
+    }
+  },
+  "keywords": [
+    "astronomy",
+    "celestial",
+    "nasa",
+    "skymap",
+    "coordinates",
+    "three.js",
+    "space"
+  ],
+  "sideEffects": false
+}