@verifyhash/koppen-classifier 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 @@
 # koppen-classifier
 
-<!-- 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 `koppen-classifier` as a placeholder — replace it
-> (and the `npm install` line below) with the real published name/scope before
-> running `npm publish`.
-
 A tiny, **zero-dependency** Node library that assigns a location its
 **Köppen–Geiger climate class** (e.g. `Cfa`, `BWh`, `Dfb`) from twelve monthly
 mean temperatures and twelve monthly precipitation totals. Pure function, no
@@ -29,7 +22,7 @@ No install step for local use — it's one file with no dependencies. Copy the
 folder in, or `require('./koppen-classifier')`.
 
 ```js
-const { classify } = require('koppen-classifier');
+const { classify } = require('@verifyhash/koppen-classifier');
 
 // London, UK — monthly arrays run January → December.
 const london = classify({
@@ -74,6 +67,13 @@ throws a `TypeError` rather than returning a wrong answer.
 | `groupLabel` | `string` | `'Temperate'`          | Top-level group name (Tropical / Arid / Temperate / Continental / Polar). |
 | `blurb`      | `string` | `'A coldest month …'`  | One-sentence plain-language summary. |
 
+### Lookup tables
+
+- `KOPPEN_NAMES` — map from every Köppen code to its human-readable name,
+  e.g. `KOPPEN_NAMES.Cfa === 'humid subtropical'` — 31 codes in total.
+- `GROUP_NAMES` — the five top-level groups:
+  `{ A: 'Tropical', B: 'Arid', C: 'Temperate', D: 'Continental', E: 'Polar' }`.
+
 ## What the algorithm actually does
 
 It applies the standard Köppen decision tree, tested in this order:
@@ -124,8 +124,9 @@ input validation. Exit code is non-zero on any failure.
 
 ## Status
 
-Incubator project — an npm-graduation **candidate**, not published. Promotion to
-a real package registry is a separate, human-approved step.
+Published to npm as [`@verifyhash/koppen-classifier`](https://www.npmjs.com/package/@verifyhash/koppen-classifier);
+source lives in the [verifyhash/libs](https://github.com/verifyhash/libs) monorepo.
+Version bumps and republishing remain a human-approved step.
 
 ## License
 
@@ -133,15 +134,12 @@ MIT.
 
 ## Install
 
-> Placeholder name: the `koppen-classifier` below is the working slug, not a finalized
-> npm name — see the owner TODO near the top of this README.
-
 ```sh
-npm install koppen-classifier
+npm install @verifyhash/koppen-classifier
 ```
 
 ```js
-const { classify } = require('koppen-classifier');
+const { classify } = require('@verifyhash/koppen-classifier');
 
 const london = classify({
   tempsC:   [5.2, 5.3, 7.6, 9.6, 12.9, 16.0, 18.1, 17.8, 15.2, 11.4, 7.8, 5.5],

package/index.d.ts

@@ -0,0 +1,49 @@
+/**
+ * Type declarations for @verifyhash/koppen-classifier — zero-dependency
+ * Köppen–Geiger climate classifier.
+ */
+
+/** Options for classify(). Provide either `lat` or `hemisphere` (lat wins). */
+export interface ClassifyOptions {
+  /** 12 monthly MEAN temperatures in °C, Jan → Dec. Exactly 12 finite numbers. */
+  tempsC: number[];
+  /** 12 monthly precipitation totals in mm, Jan → Dec. Exactly 12 finite numbers. */
+  precipMm: number[];
+  /** Signed latitude (north positive); only its sign is used. */
+  lat?: number;
+  /** Alternative to lat: 'N'/'S' (or 'north'/'south', case-insensitive). */
+  hemisphere?: string;
+}
+
+/** Result of classify(). */
+export interface KoppenClassification {
+  /** Köppen–Geiger code, e.g. 'Cfa'. */
+  code: string;
+  /** Human-readable class name, e.g. 'humid subtropical'. */
+  label: string;
+  /** Top-level letter, e.g. 'C'. */
+  group: string;
+  /** Top-level name, e.g. 'Temperate'. */
+  groupLabel: string;
+  /** One-sentence plain-language summary. */
+  blurb: string;
+}
+
+/**
+ * Classify a location's Köppen–Geiger climate from 12 monthly mean
+ * temperatures (°C) and 12 monthly precipitation totals (mm). Throws
+ * TypeError on malformed input.
+ */
+export function classify(opts: ClassifyOptions): KoppenClassification;
+
+/** Human-readable names for the Köppen–Geiger codes the classifier can emit. */
+export const KOPPEN_NAMES: Record<string, string>;
+
+/** Top-level group letter → short name ('A' → 'Tropical', …). */
+export const GROUP_NAMES: {
+  A: string;
+  B: string;
+  C: string;
+  D: string;
+  E: string;
+};

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "@verifyhash/koppen-classifier",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Zero-dependency Köppen–Geiger climate classifier from 12 monthly mean-temperature and precipitation values (hemisphere-aware).",
   "main": "index.js",
+  "types": "index.d.ts",
   "type": "commonjs",
   "scripts": {
     "test": "node test/koppen.test.js"
@@ -18,7 +19,8 @@
   "license": "MIT",
   "files": [
     "index.js",
-    "README.md"
+    "README.md",
+    "index.d.ts"
   ],
   "publishConfig": {
     "access": "public"