Merge pull request #130 from smarty/ryan/hello_types

Ryan/hello types

Author: RyanLCox1

.claude/settings.json

@@ -1,16 +1,9 @@
 {
-  "permissions": {
-    "allow": [
-      "Edit",
-      "Write",
-      "Bash(rm:./*)",
-      "Bash(git *)",
-      "Bash(make *)",
-      "Bash(npm *)"
-    ]
-  },
-  "attribution": {
-    "commit": "",
-    "pr": ""
-  }
+	"permissions": {
+		"allow": ["Edit", "Write", "Bash(rm:./*)", "Bash(git *)", "Bash(make *)", "Bash(npm *)"]
+	},
+	"attribution": {
+		"commit": "",
+		"pr": ""
+	}
 }

.github/workflows/node-tests.yml

@@ -2,27 +2,26 @@ name: Node Tests
 
 on:
   push:
-    branches: [ master ]
+    branches: [master]
   pull_request:
-    branches: [ master ]
+    branches: [master]
 
 jobs:
   build:
-
     runs-on: ubuntu-latest
 
     strategy:
       matrix:
         node-version: [20.x, 22.x, 24.x]
 
     steps:
-    - uses: actions/checkout@v6
-    - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v6
-      with:
-        node-version: ${{ matrix.node-version }}
-    - run: npm ci
-    - run: npm run build
-    - run: npm test
-      env:
-        CI: true
+      - uses: actions/checkout@v6
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v6
+        with:
+          node-version: ${{ matrix.node-version }}
+      - run: npm ci
+      - run: npm run build
+      - run: npm test
+        env:
+          CI: true

.github/workflows/publish.yml

@@ -3,10 +3,10 @@ name: Publish to npm
 on:
   push:
     tags:
-      - '*'
+      - "*"
 
 permissions:
-  id-token: write  # Required for OIDC
+  id-token: write # Required for OIDC
   contents: read
 
 jobs:
@@ -19,8 +19,8 @@ jobs:
       - name: Setup Node.js
         uses: actions/setup-node@v6
         with:
-          node-version: '20.x'
-          registry-url: 'https://registry.npmjs.org'
+          node-version: "20.x"
+          registry-url: "https://registry.npmjs.org"
 
       - name: Update npm
         run: npm install -g npm@'>=11.5.1'
@@ -44,4 +44,4 @@ jobs:
         run: npm publish
         env:
           NPM_CONFIG_PROVENANCE: true
-          NPM_TOKEN: ''
+          NPM_TOKEN: ""

CHANGELOG.md

@@ -2,4 +2,4 @@
 
 See the changelog repository:
 
-github.com/smartystreets/changelog/blob/master/sdk/javascript.md
+github.com/smartystreets/changelog/blob/master/sdk/javascript.md

CLAUDE.md

@@ -6,9 +6,7 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co
 
 ```bash
 npm install        # Install dependencies
-npm test           # Run all tests (JS + TS)
-npm run test:js    # Run JavaScript tests only
-npm run test:ts    # Run TypeScript tests only
+npm test           # Run all tests
 npm run build      # Build the library (outputs to dist/)
 npx tsc --noEmit   # Type-check without emitting
 npx prettier --write .  # Format all files (respects .prettierignore)
@@ -23,16 +21,16 @@ make integrate     # Run all example files against built dist/
 ```
 
 To run a single test file:
+
 ```bash
-npx mocha tests/us_street/test_Client.js           # JS test
-npx mocha --require tsx/cjs tests/test_RetrySender.ts   # TS test
+npx mocha --require tsx/cjs tests/test_RetrySender.ts
 ```
 
 Build outputs dual formats via Rollup: `dist/cjs/` (CommonJS), `dist/esm/` (ESM), and `dist/types/` (declarations). Rollup preserves module structure (`preserveModules: true`). Axios and axios-retry are external dependencies (not bundled).
 
 ## Architecture
 
-This is the official JavaScript SDK for Smarty address validation APIs. It supports both Node.js (CommonJS/ESM) and browser environments.
+This is the official JavaScript SDK for Smarty address validation APIs. It supports both Node.js (CommonJS/ESM) and browser environments. The entire codebase is TypeScript.
 
 ### Sender Chain Pattern
 
@@ -51,46 +49,49 @@ All senders implement the `Sender` interface from `src/types.ts`, which also def
 
 - **ClientBuilder**: Fluent API for configuring and building API-specific clients. Accepts either `StaticCredentials` (server-side: auth-id + auth-token) or `SharedCredentials` (client-side: embedded key).
 
-- **Lookup classes**: Each API has a `Lookup` that holds both input parameters and results after the API call. Located in `src/<api_name>/Lookup.js`.
+- **Lookup classes**: Each API has a `Lookup` that holds both input parameters and results after the API call. Located in `src/<api_name>/Lookup.ts`.
 
 - **Batch**: Container for up to 100 lookups. Single lookups use GET requests; batches with 2+ lookups use POST.
 
-- **Client classes**: Each API has a `Client` in `src/<api_name>/Client.js` that handles domain-specific request building and response parsing.
+- **Client classes**: Each API has a `Client` in `src/<api_name>/Client.ts` that handles domain-specific request building and response parsing.
 
 ### API Modules
 
 Each API follows the same structure in `src/<api_name>/`:
-- `Lookup.js` - Input/output container
-- `Client.js` - Request/response handling
-- `Candidate.js`, `Result.js`, or `Suggestion.js` - Response data structures
+
+- `Lookup.ts` - Input/output container
+- `Client.ts` - Request/response handling
+- `Candidate.ts`, `Result.ts`, or `Suggestion.ts` - Response data structures
 
 Supported APIs: `us_street`, `us_zipcode`, `us_autocomplete_pro`, `us_extract`, `us_enrichment`, `us_reverse_geo`, `international_street`, `international_address_autocomplete`, `international_postal_code`
 
 ### Credentials
 
 Three credential types, each implementing a `sign(request)` method used by `SigningSender`:
-- **StaticCredentials** (TS) - Server-side: adds `auth-id` + `auth-token` query params
-- **SharedCredentials** (TS) - Client-side/browser: adds embedded `key` param + `Referer` header. Cannot be used with POST (batch) requests.
-- **BasicAuthCredentials** (TS) - Adds HTTP Basic Auth `Authorization` header
+
+- **StaticCredentials** - Server-side: adds `auth-id` + `auth-token` query params
+- **SharedCredentials** - Client-side/browser: adds embedded `key` param + `Referer` header. Cannot be used with POST (batch) requests.
+- **BasicAuthCredentials** - Adds HTTP Basic Auth `Authorization` header
 
 ### Entry Point
 
-`index.mjs` exports all public classes organized by API namespace (e.g., `core`, `usStreet`, `usZipcode`).
+`index.ts` exports all public classes organized by API namespace (e.g., `core`, `usStreet`, `usZipcode`).
 
 ### Test Infrastructure
 
 Tests use Mocha + Chai (`expect` style). Test files are prefixed with `test_` and mirror the source structure under `tests/`.
 
-`tests/fixtures/mock_senders.js` provides reusable mocks:
+`tests/fixtures/mock_senders.ts` provides reusable mocks:
+
 - `MockSender` - Captures the request for inspection
 - `MockSenderWithResponse` - Returns a fixed payload/error
 - `MockSenderWithStatusCodesAndHeaders` - Iterates through status codes (useful for retry tests)
 
 ## Code Style
 
 - Uses Prettier: tabs, double quotes, 100 char line width, trailing commas
-- Mixed JS/TS: Business logic (clients, lookups, results) in JS; infrastructure (credentials, senders, types) in TS
+- All source and test files are TypeScript with ES module syntax (`import`/`export`)
+- Import paths use `.js` extensions (TypeScript resolves `.js` to `.ts`)
 - TypeScript is configured with `strict: true`, `exactOptionalPropertyTypes`, and `noPropertyAccessFromIndexSignature`
-- `allowJs: true` in tsconfig enables type-checking of JS files alongside TS
 - Tests use Mocha + Chai with `expect` style assertions
 - Test files are prefixed with `test_` and mirror the source structure