Merge pull request #51 from blakek/move-to-typescript

Move to typescript

.editorconfig

@@ -0,0 +1,11 @@
+# https://editorconfig.org/
+
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 2
+indent_style = space
+insert_final_newline = true
+trim_trailing_whitespace = true

.eslintignore

@@ -0,0 +1 @@
+dist/*

.eslintrc.js

@@ -0,0 +1,4 @@
+module.exports = {
+  extends: [require.resolve('amper-scripts/config/eslint')],
+  root: true
+};

.github/workflows/publish.yml

@@ -0,0 +1,26 @@
+name: Publish update
+
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - uses: actions/setup-node@v2
+        with:
+          node-version: '16'
+          cache: 'yarn'
+          registry-url: 'https://registry.npmjs.org'
+
+      - run: yarn install
+
+      - run: yarn publish
+        name: Publish to npm
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}

.github/workflows/run-tests.yml

@@ -0,0 +1,29 @@
+name: Run tests
+
+on: push
+
+jobs:
+  run-tests:
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: true
+      matrix:
+        node_version:
+          - '12'
+          - '14'
+          - '16'
+          - '17'
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - uses: actions/setup-node@v2
+        name: Use Node.js v${{matrix.node_version}}
+        with:
+          node-version: ${{matrix.node_version}}
+          cache: 'yarn'
+
+      - run: yarn install
+
+      - run: yarn test

package.json

@@ -1,8 +1,8 @@
 {
   "name": "geo2zip",
-  "version": "2.0.2",
+  "version": "3.0.0",
   "description": "Translates latitude / longitude geolocations to the nearest corresponding U.S. zip code",
-  "main": "index.js",
+  "main": "dist/index.js",
   "repository": {
     "url": "https://github.com/blakek/geo2zip",
     "type": "git"
@@ -33,21 +33,40 @@
     "neighbors"
   ],
   "license": "MIT",
+  "ava": {
+    "extensions": [
+      "js",
+      "ts"
+    ],
+    "files": [
+      "src/**/*.test.ts"
+    ],
+    "ignoredByWatcher": [
+      "!src/**"
+    ],
+    "require": [
+      "ts-node/register"
+    ]
+  },
   "scripts": {
+    "build": "tsc",
     "format-check": "amper-scripts format-check *.js",
     "lint": "amper-scripts lint *.js",
+    "prepack": "run-s build",
     "test": "ava",
     "validate": "run-s test format-check lint",
     "watch": "ava --watch"
   },
   "devDependencies": {
-    "amper-scripts": "^1.0.0-0",
-    "ava": "^3.3.0",
-    "npm-run-all": "^4.1.5"
+    "amper-scripts": "^1.2.4",
+    "ava": "^3.15.0",
+    "npm-run-all": "^4.1.5",
+    "ts-node": "^10.4.0",
+    "typescript": "^4.4.4"
   },
   "dependencies": {
     "sphere-knn": "^1.4.0",
-    "standardize-geolocation": "^2.0.2",
-    "us-zips": "^4.0.0"
+    "standardize-geolocation": "^4.0.0",
+    "us-zips": "^2021.11.4"
   }
 }

prettier.config.js

@@ -1,13 +1 @@
-module.exports = {
-  arrowParens: 'avoid',
-  bracketSpacing: true,
-  endOfLine: 'lf',
-  jsxBracketSameLine: false,
-  jsxSingleQuote: false,
-  printWidth: 80,
-  semi: true,
-  singleQuote: true,
-  tabWidth: 2,
-  trailingComma: 'none',
-  useTabs: false
-};
+module.exports = require('amper-scripts/config/prettier.config.js');

test.js → src/index.test.ts

@@ -1,5 +1,5 @@
-const test = require('ava');
-const geo2zip = require('.');
+import test from 'ava';
+import geo2zip from '.';
 
 test('returns zip code nearest a geolocation', async t => {
   const testPoints = [
@@ -13,12 +13,10 @@ test('returns zip code nearest a geolocation', async t => {
     }
   ];
 
-  const tests = testPoints.map(async ({ expected, location }) => {
-    const actual = await geo2zip(location);
-    t.is(actual[0], expected);
-  });
-
-  return Promise.all(tests);
+  for (const { expected, location } of testPoints) {
+    const [actual] = await geo2zip(location);
+    t.is(actual, expected);
+  }
 });
 
 test('returns a list of zip codes nearest a location, ordered by closeness', async t => {
@@ -33,10 +31,8 @@ test('returns a list of zip codes nearest a location, ordered by closeness', asy
     }
   ];
 
-  const tests = testPoints.map(async ({ expected, location }) => {
+  for (const { expected, location } of testPoints) {
     const actual = await geo2zip(location, { limit: 5 });
     t.true(actual.includes(expected));
-  });
-
-  return Promise.all(tests);
+  }
 });

src/index.ts

@@ -0,0 +1,35 @@
+import sphereKnn from 'sphere-knn';
+import {
+  GeolocationInput,
+  standardizeGeolocation
+} from 'standardize-geolocation';
+import { ZIPCode } from 'us-zips';
+import usZips, { ZIPCodeList } from 'us-zips/array';
+
+export interface Options {
+  limit: number;
+}
+
+export const defaultOptions: Options = { limit: 1 };
+
+// Start building lookup when module imported
+const lookup = sphereKnn(usZips);
+
+// Don't recreate this function on every run
+const pluckZipCode = (obj: { zipCode: string }) => obj.zipCode;
+
+export function geo2zip(
+  location: GeolocationInput,
+  extraOptions: Partial<Options> = {}
+): Promise<ZIPCode[]> {
+  const options = { ...defaultOptions, ...extraOptions };
+  const { latitude, longitude } = standardizeGeolocation(location);
+
+  return new Promise(resolve => {
+    const results = lookup(latitude, longitude, options.limit) as ZIPCodeList;
+
+    resolve(results.map(pluckZipCode));
+  });
+}
+
+export default geo2zip;

src/types/sphere-knn.d.ts

@@ -0,0 +1,28 @@
+declare module 'sphere-knn' {
+  type WithLatitude = { lat: number } | { latitude: number };
+
+  type WithLongitude =
+    | { lon: number }
+    | { lng: number }
+    | { long: number }
+    | { longitude: number };
+
+  type Geolocation =
+    | [number, number]
+    | { location: [number, number] }
+    | { position: [number, number] }
+    | { geometry: { coordinates: [number, number]; type: 'Point' } }
+    | (WithLatitude & WithLongitude);
+
+  type Lookup = (
+    latitude: number,
+    longitude: number,
+    limit?: number,
+    maxDistance?: number
+  ) => Geolocation[];
+
+  type SphereKnn<T = Geolocation> = (points: T[]) => Lookup;
+
+  const defaultExport: SphereKnn;
+  export = defaultExport;
+}

tsconfig.json

@@ -0,0 +1,20 @@
+{
+  "compilerOptions": {
+    "allowJs": true,
+    "allowSyntheticDefaultImports": true,
+    "baseUrl": ".",
+    "declaration": true,
+    "esModuleInterop": true,
+    "incremental": true,
+    "module": "CommonJS",
+    "moduleResolution": "node",
+    "noImplicitAny": true,
+    "outDir": "dist",
+    "sourceMap": true,
+    "target": "ES2019",
+    "paths": {
+      "*": ["node_modules/*", "src/types/*"]
+    }
+  },
+  "include": ["src/**/*"]
+}