@clipboard-health/usa-states 1.0.0

package/README.md

@@ -0,0 +1,32 @@
+# @clipboard-health/usa-states <!-- omit from toc -->
+
+Canonical US state and territory list and `StateCode` type.
+
+## Table of contents <!-- omit from toc -->
+
+- [Install](#install)
+- [Usage](#usage)
+- [Local development commands](#local-development-commands)
+
+## Install
+
+```bash
+npm install @clipboard-health/usa-states
+```
+
+## Usage
+
+```ts
+import { isStateCode, type StateCode, US_STATES } from "@clipboard-health/usa-states";
+
+US_STATES.find((state) => state.code === "CA");
+// => { name: "California", code: "CA" }
+
+function parseStateCode(value: string): StateCode | undefined {
+  return isStateCode(value) ? value : undefined;
+}
+```
+
+## Local development commands
+
+See [`package.json`](./package.json) `scripts` for a list of commands.

package/package.json

@@ -0,0 +1,24 @@
+{
+  "name": "@clipboard-health/usa-states",
+  "version": "1.0.0",
+  "description": "Canonical US state and territory list and StateCode type.",
+  "keywords": [],
+  "bugs": "https://github.com/ClipboardHealth/core-utils/issues",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ClipboardHealth/core-utils.git",
+    "directory": "packages/usa-states"
+  },
+  "type": "commonjs",
+  "main": "./src/index.js",
+  "typings": "./src/index.d.ts",
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@clipboard-health/util-ts": "5.14.1",
+    "tslib": "2.8.1"
+  },
+  "types": "./src/index.d.ts"
+}

package/src/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./lib/isStateCode";
+export * from "./lib/usStates";

package/src/index.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./lib/isStateCode"), exports);
+tslib_1.__exportStar(require("./lib/usStates"), exports);
+//# sourceMappingURL=index.js.map

package/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../packages/usa-states/src/index.ts"],"names":[],"mappings":";;;AAAA,4DAAkC;AAClC,yDAA+B"}

package/src/lib/isStateCode.d.ts

@@ -0,0 +1,2 @@
+import { type StateCode } from "./usStates";
+export declare function isStateCode(value: string): value is StateCode;

package/src/lib/isStateCode.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isStateCode = isStateCode;
+const usStates_1 = require("./usStates");
+const STATE_CODES = new Set(usStates_1.US_STATES.map((state) => state.code));
+function isStateCode(value) {
+    return STATE_CODES.has(value);
+}
+//# sourceMappingURL=isStateCode.js.map

package/src/lib/isStateCode.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"isStateCode.js","sourceRoot":"","sources":["../../../../../packages/usa-states/src/lib/isStateCode.ts"],"names":[],"mappings":";;;AAAA,yCAAuD;AAEvD,MAAM,WAAW,GAAwB,IAAI,GAAG,CAAC,oBAAS,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;AAEvF,qBAA4B,KAAa;IACvC,OAAO,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;AAChC,CAAC"}

package/src/lib/usStates.d.ts

@@ -0,0 +1,183 @@
+export declare const US_STATES: readonly [{
+    readonly name: "Alabama";
+    readonly code: "AL";
+}, {
+    readonly name: "Alaska";
+    readonly code: "AK";
+}, {
+    readonly name: "American Samoa";
+    readonly code: "AS";
+}, {
+    readonly name: "Arizona";
+    readonly code: "AZ";
+}, {
+    readonly name: "Arkansas";
+    readonly code: "AR";
+}, {
+    readonly name: "California";
+    readonly code: "CA";
+}, {
+    readonly name: "Colorado";
+    readonly code: "CO";
+}, {
+    readonly name: "Connecticut";
+    readonly code: "CT";
+}, {
+    readonly name: "Delaware";
+    readonly code: "DE";
+}, {
+    readonly name: "District of Columbia";
+    readonly code: "DC";
+}, {
+    readonly name: "Federated States of Micronesia";
+    readonly code: "FM";
+}, {
+    readonly name: "Florida";
+    readonly code: "FL";
+}, {
+    readonly name: "Georgia";
+    readonly code: "GA";
+}, {
+    readonly name: "Guam";
+    readonly code: "GU";
+}, {
+    readonly name: "Hawaii";
+    readonly code: "HI";
+}, {
+    readonly name: "Idaho";
+    readonly code: "ID";
+}, {
+    readonly name: "Illinois";
+    readonly code: "IL";
+}, {
+    readonly name: "Indiana";
+    readonly code: "IN";
+}, {
+    readonly name: "Iowa";
+    readonly code: "IA";
+}, {
+    readonly name: "Kansas";
+    readonly code: "KS";
+}, {
+    readonly name: "Kentucky";
+    readonly code: "KY";
+}, {
+    readonly name: "Louisiana";
+    readonly code: "LA";
+}, {
+    readonly name: "Maine";
+    readonly code: "ME";
+}, {
+    readonly name: "Marshall Islands";
+    readonly code: "MH";
+}, {
+    readonly name: "Maryland";
+    readonly code: "MD";
+}, {
+    readonly name: "Massachusetts";
+    readonly code: "MA";
+}, {
+    readonly name: "Michigan";
+    readonly code: "MI";
+}, {
+    readonly name: "Minnesota";
+    readonly code: "MN";
+}, {
+    readonly name: "Mississippi";
+    readonly code: "MS";
+}, {
+    readonly name: "Missouri";
+    readonly code: "MO";
+}, {
+    readonly name: "Montana";
+    readonly code: "MT";
+}, {
+    readonly name: "Nebraska";
+    readonly code: "NE";
+}, {
+    readonly name: "Nevada";
+    readonly code: "NV";
+}, {
+    readonly name: "New Hampshire";
+    readonly code: "NH";
+}, {
+    readonly name: "New Jersey";
+    readonly code: "NJ";
+}, {
+    readonly name: "New Mexico";
+    readonly code: "NM";
+}, {
+    readonly name: "New York";
+    readonly code: "NY";
+}, {
+    readonly name: "North Carolina";
+    readonly code: "NC";
+}, {
+    readonly name: "North Dakota";
+    readonly code: "ND";
+}, {
+    readonly name: "Northern Mariana Islands";
+    readonly code: "MP";
+}, {
+    readonly name: "Ohio";
+    readonly code: "OH";
+}, {
+    readonly name: "Oklahoma";
+    readonly code: "OK";
+}, {
+    readonly name: "Oregon";
+    readonly code: "OR";
+}, {
+    readonly name: "Palau";
+    readonly code: "PW";
+}, {
+    readonly name: "Pennsylvania";
+    readonly code: "PA";
+}, {
+    readonly name: "Puerto Rico";
+    readonly code: "PR";
+}, {
+    readonly name: "Rhode Island";
+    readonly code: "RI";
+}, {
+    readonly name: "South Carolina";
+    readonly code: "SC";
+}, {
+    readonly name: "South Dakota";
+    readonly code: "SD";
+}, {
+    readonly name: "Tennessee";
+    readonly code: "TN";
+}, {
+    readonly name: "Texas";
+    readonly code: "TX";
+}, {
+    readonly name: "Utah";
+    readonly code: "UT";
+}, {
+    readonly name: "Vermont";
+    readonly code: "VT";
+}, {
+    readonly name: "Virgin Islands";
+    readonly code: "VI";
+}, {
+    readonly name: "Virginia";
+    readonly code: "VA";
+}, {
+    readonly name: "Washington";
+    readonly code: "WA";
+}, {
+    readonly name: "West Virginia";
+    readonly code: "WV";
+}, {
+    readonly name: "Wisconsin";
+    readonly code: "WI";
+}, {
+    readonly name: "Wyoming";
+    readonly code: "WY";
+}];
+export type StateCode = (typeof US_STATES)[number]["code"];
+export interface UsState {
+    name: string;
+    code: StateCode;
+}

package/src/lib/usStates.js

@@ -0,0 +1,68 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.US_STATES = void 0;
+const util_ts_1 = require("@clipboard-health/util-ts");
+const RAW_US_STATES = [
+    { name: "Alabama", code: "AL" },
+    { name: "Alaska", code: "AK" },
+    { name: "American Samoa", code: "AS" },
+    { name: "Arizona", code: "AZ" },
+    { name: "Arkansas", code: "AR" },
+    { name: "California", code: "CA" },
+    { name: "Colorado", code: "CO" },
+    { name: "Connecticut", code: "CT" },
+    { name: "Delaware", code: "DE" },
+    { name: "District of Columbia", code: "DC" },
+    // Lowercase "of" matches cbh-mobile-app and documents-service-backend; don't "correct" to cbh-admin-frontend's capitalized variant, which is the outlier.
+    { name: "Federated States of Micronesia", code: "FM" },
+    { name: "Florida", code: "FL" },
+    { name: "Georgia", code: "GA" },
+    { name: "Guam", code: "GU" },
+    { name: "Hawaii", code: "HI" },
+    { name: "Idaho", code: "ID" },
+    { name: "Illinois", code: "IL" },
+    { name: "Indiana", code: "IN" },
+    { name: "Iowa", code: "IA" },
+    { name: "Kansas", code: "KS" },
+    { name: "Kentucky", code: "KY" },
+    { name: "Louisiana", code: "LA" },
+    { name: "Maine", code: "ME" },
+    { name: "Marshall Islands", code: "MH" },
+    { name: "Maryland", code: "MD" },
+    { name: "Massachusetts", code: "MA" },
+    { name: "Michigan", code: "MI" },
+    { name: "Minnesota", code: "MN" },
+    { name: "Mississippi", code: "MS" },
+    { name: "Missouri", code: "MO" },
+    { name: "Montana", code: "MT" },
+    { name: "Nebraska", code: "NE" },
+    { name: "Nevada", code: "NV" },
+    { name: "New Hampshire", code: "NH" },
+    { name: "New Jersey", code: "NJ" },
+    { name: "New Mexico", code: "NM" },
+    { name: "New York", code: "NY" },
+    { name: "North Carolina", code: "NC" },
+    { name: "North Dakota", code: "ND" },
+    { name: "Northern Mariana Islands", code: "MP" },
+    { name: "Ohio", code: "OH" },
+    { name: "Oklahoma", code: "OK" },
+    { name: "Oregon", code: "OR" },
+    { name: "Palau", code: "PW" },
+    { name: "Pennsylvania", code: "PA" },
+    { name: "Puerto Rico", code: "PR" },
+    { name: "Rhode Island", code: "RI" },
+    { name: "South Carolina", code: "SC" },
+    { name: "South Dakota", code: "SD" },
+    { name: "Tennessee", code: "TN" },
+    { name: "Texas", code: "TX" },
+    { name: "Utah", code: "UT" },
+    { name: "Vermont", code: "VT" },
+    { name: "Virgin Islands", code: "VI" },
+    { name: "Virginia", code: "VA" },
+    { name: "Washington", code: "WA" },
+    { name: "West Virginia", code: "WV" },
+    { name: "Wisconsin", code: "WI" },
+    { name: "Wyoming", code: "WY" },
+];
+exports.US_STATES = (0, util_ts_1.deepFreeze)(RAW_US_STATES);
+//# sourceMappingURL=usStates.js.map

package/src/lib/usStates.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"usStates.js","sourceRoot":"","sources":["../../../../../packages/usa-states/src/lib/usStates.ts"],"names":[],"mappings":";;;AAAA,uDAAuD;AAEvD,MAAM,aAAa,GAAG;IACpB,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE;IAC/B,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAI,EAAE;IAC9B,EAAE,IAAI,EAAE,gBAAgB,EAAE,IAAI,EAAE,IAAI,EAAE;IACtC,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE;IAC/B,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,IAAI,EAAE;IAChC,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE,IAAI,EAAE;IAClC,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,IAAI,EAAE;IAChC,EAAE,IAAI,EAAE,aAAa,EAAE,IAAI,EAAE,IAAI,EAAE;IACnC,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,IAAI,EAAE;IAChC,EAAE,IAAI,EAAE,sBAAsB,EAAE,IAAI,EAAE,IAAI,EAAE;IAC5C,0JAA0J;IAC1J,EAAE,IAAI,EAAE,gCAAgC,EAAE,IAAI,EAAE,IAAI,EAAE;IACtD,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE;IAC/B,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE;IAC/B,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE;IAC5B,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAI,EAAE;IAC9B,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE;IAC7B,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,IAAI,EAAE;IAChC,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE;IAC/B,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE;IAC5B,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAI,EAAE;IAC9B,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,IAAI,EAAE;IAChC,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,IAAI,EAAE;IACjC,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE;IAC7B,EAAE,IAAI,EAAE,kBAAkB,EAAE,IAAI,EAAE,IAAI,EAAE;IACxC,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,IAAI,EAAE;IAChC,EAAE,IAAI,EAAE,eAAe,EAAE,IAAI,EAAE,IAAI,EAAE;IACrC,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,IAAI,EAAE;IAChC,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,IAAI,EAAE;IACjC,EAAE,IAAI,EAAE,aAAa,EAAE,IAAI,EAAE,IAAI,EAAE;IACnC,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,IAAI,EAAE;IAChC,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE;IAC/B,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,IAAI,EAAE;IAChC,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAI,EAAE;IAC9B,EAAE,IAAI,EAAE,eAAe,EAAE,IAAI,EAAE,IAAI,EAAE;IACrC,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE,IAAI,EAAE;IAClC,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE,IAAI,EAAE;IAClC,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,IAAI,EAAE;IAChC,EAAE,IAAI,EAAE,gBAAgB,EAAE,IAAI,EAAE,IAAI,EAAE;IACtC,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,EAAE,IAAI,EAAE;IACpC,EAAE,IAAI,EAAE,0BAA0B,EAAE,IAAI,EAAE,IAAI,EAAE;IAChD,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE;IAC5B,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,IAAI,EAAE;IAChC,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAI,EAAE;IAC9B,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE;IAC7B,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,EAAE,IAAI,EAAE;IACpC,EAAE,IAAI,EAAE,aAAa,EAAE,IAAI,EAAE,IAAI,EAAE;IACnC,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,EAAE,IAAI,EAAE;IACpC,EAAE,IAAI,EAAE,gBAAgB,EAAE,IAAI,EAAE,IAAI,EAAE;IACtC,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,EAAE,IAAI,EAAE;IACpC,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,IAAI,EAAE;IACjC,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE;IAC7B,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE;IAC5B,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE;IAC/B,EAAE,IAAI,EAAE,gBAAgB,EAAE,IAAI,EAAE,IAAI,EAAE;IACtC,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,IAAI,EAAE;IAChC,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE,IAAI,EAAE;IAClC,EAAE,IAAI,EAAE,eAAe,EAAE,IAAI,EAAE,IAAI,EAAE;IACrC,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,IAAI,EAAE;IACjC,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE;CACiC,CAAC;AAEtD,QAAA,SAAS,GAAG,IAAA,oBAAU,EAAC,aAAa,CAAC,CAAC"}