@verifyhash/moon-phase 0.1.0 → 0.1.1

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2026 <OWNER-NAME PLACEHOLDER>
+Copyright (c) 2026 verifyhash
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,12 +1,5 @@
 # moon-phase
 
-<!-- publish-prep -->
-> **TODO (owner): pick the final npm name/scope before publishing.**
-> The npm package name is **not** finalized by this project. Convention used here:
-> `package.json` keeps the working slug `moon-phase` as a placeholder — replace it
-> (and the `npm install` line below) with the real published name/scope before
-> running `npm publish`.
-
 A **zero-dependency, pure-function** Node library that turns any instant into the
 Moon's phase: its phase angle, the fraction of the disk that is lit, the synodic
 age in days, the canonical phase name, and the Brown lunation number.
@@ -61,6 +54,16 @@ defining angle — so `New` covers 337.5°–360°–22.5°, `First Quarter` cov
 67.5°–112.5°, and so on. The narrow "instant" phases (New, the two quarters,
 Full) are the sectors straddling their exact angles.
 
+### Constants & internals
+
+- `SYNODIC_MONTH` — the mean synodic month, `29.530588853` days (new moon to
+  new moon). Handy for converting `ageDays` to a fraction of the cycle.
+- `_julianDay(date)` — Julian Day number for a JS `Date` (UTC).
+- `_elongationAtJD(jd)` — Moon−Sun elongation in degrees at a Julian Day.
+
+The two underscore-prefixed functions are the internal kernels, exported only
+so the tests can pin them against almanac values — internal API, not semver-stable.
+
 ## Algorithm & citation
 
 The geometry follows **Jean Meeus, *Astronomical Algorithms* (2nd ed., 1998)**:
@@ -122,15 +125,12 @@ MIT.
 
 ## Install
 
-> Placeholder name: the `moon-phase` below is the working slug, not a finalized
-> npm name — see the owner TODO near the top of this README.
-
 ```sh
-npm install moon-phase
+npm install @verifyhash/moon-phase
 ```
 
 ```js
-const moon = require('moon-phase');
+const moon = require('@verifyhash/moon-phase');
 
 const d = new Date('2024-01-25T17:54:00Z'); // a full moon
 moon.phaseName(d);           // 'Full'

package/index.d.ts

@@ -0,0 +1,57 @@
+/**
+ * Type declarations for @verifyhash/moon-phase — zero-dependency lunar phase
+ * & illumination math (simplified Meeus method).
+ *
+ * Every function takes a JS Date interpreted as a UTC INSTANT (date + time
+ * both matter — the Moon moves ~12° per day). Inputs are never mutated.
+ */
+
+/** The 8 canonical phase names returned by phaseName(). */
+export type MoonPhaseName =
+  | 'New'
+  | 'Waxing Crescent'
+  | 'First Quarter'
+  | 'Waxing Gibbous'
+  | 'Full'
+  | 'Waning Gibbous'
+  | 'Last Quarter'
+  | 'Waning Crescent';
+
+/**
+ * Sun-Moon elongation in degrees, in [0, 360). 0° = New, 90° = First Quarter,
+ * 180° = Full, 270° = Last Quarter.
+ */
+export function moonPhaseAngle(date: Date): number;
+
+/**
+ * Fraction of the Moon's disk that is lit, in [0, 1]. 0 at new moon, 1 at
+ * full moon, ~0.5 at the quarters.
+ */
+export function illuminatedFraction(date: Date): number;
+
+/**
+ * Days since the last new moon (synodic age), in [0, ~29.53). Good to a
+ * fraction of a day (derived via the MEAN synodic month), not to the minute.
+ */
+export function moonAge(date: Date): number;
+
+/**
+ * One of the 8 canonical phase names, binned by elongation into 45° sectors
+ * (boundaries at 22.5°, 67.5°, 112.5°, …).
+ */
+export function phaseName(date: Date): MoonPhaseName;
+
+/**
+ * Brown Lunation Number of the lunation in progress on the given date
+ * (integer; the new moon of 2000-01-06 is number 953).
+ */
+export function lunation(date: Date): number;
+
+/** Mean length of the synodic month in days (29.530588853). */
+export const SYNODIC_MONTH: number;
+
+/** Internal, exposed for testing: Julian Day (with fraction) of a Date instant. */
+export function _julianDay(date: Date): number;
+
+/** Internal, exposed for testing: true Sun-Moon elongation (deg) at a Julian Day. */
+export function _elongationAtJD(jd: number): number;

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "@verifyhash/moon-phase",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Zero-dependency lunar phase & illumination math (simplified Meeus method): phase angle, illuminated fraction, synodic age, canonical phase name, and Brown lunation number for any UTC instant.",
   "main": "index.js",
+  "types": "index.d.ts",
   "type": "commonjs",
   "scripts": {
     "test": "node test/moon.test.js"
@@ -22,7 +23,8 @@
   "license": "MIT",
   "files": [
     "index.js",
-    "README.md"
+    "README.md",
+    "index.d.ts"
   ],
   "publishConfig": {
     "access": "public"