@mountainpass/addressr-svelte 0.3.0

package/LICENSE

@@ -0,0 +1,123 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work.
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to the Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner.
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by the Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding any notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear.
+
+   5. Submission of Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor.
+
+   7. Disclaimer of Warranty.
+
+   8. Limitation of Liability.
+
+   9. Accepting Warranty or Additional Liability.
+
+   Copyright 2026 Mountain Pass Pty. Limited
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,115 @@
+# @mountainpass/addressr-svelte
+
+Svelte address autocomplete component for Australian address search, powered by [Addressr](https://addressr.io).
+
+Part of the [addressr-ui](https://github.com/mountain-pass/addressr-ui) monorepo.
+
+## Install
+
+```bash
+npm install @mountainpass/addressr-svelte
+```
+
+Peer dependencies: `svelte` >= 4.
+
+## Drop-in component
+
+```svelte
+<script>
+  import { AddressAutocomplete } from '@mountainpass/addressr-svelte';
+  import '@mountainpass/addressr-svelte/style.css';
+</script>
+
+<AddressAutocomplete
+  apiUrl="https://api.addressr.io/"
+  onSelect={(address) => {
+    console.log(address.sla);          // "1 GEORGE ST, SYDNEY NSW 2000"
+    console.log(address.structured);   // { street, locality, state, postcode, ... }
+    console.log(address.geocoding);    // { latitude, longitude, ... }
+  }}
+/>
+```
+
+### Props
+
+| Prop | Type | Default | Description |
+|------|------|---------|-------------|
+| `apiKey` | `string` | -- | RapidAPI key. Omit for direct API access. |
+| `onSelect` | `(address: AddressDetail) => void` | -- | Called when an address is selected |
+| `label` | `string` | `"Search Australian addresses"` | Accessible label text |
+| `placeholder` | `string` | `"Start typing an address..."` | Input placeholder |
+| `debounceMs` | `number` | `300` | Debounce delay in milliseconds |
+| `apiUrl` | `string` | `"https://addressr.p.rapidapi.com/"` | API root URL |
+| `apiHost` | `string` | `"addressr.p.rapidapi.com"` | RapidAPI host header |
+
+## Headless store
+
+Build your own UI while keeping the search logic, debounce, pagination, and abort handling:
+
+```svelte
+<script>
+  import { createAddressSearch } from '@mountainpass/addressr-svelte';
+
+  const search = createAddressSearch({ apiUrl: 'https://api.addressr.io/' });
+
+  function handleInput(e) {
+    search.setQuery(e.target.value);
+  }
+</script>
+
+<input value={$search.query} on:input={handleInput} />
+
+{#if $search.isLoading}
+  <p>Searching...</p>
+{/if}
+
+<ul>
+  {#each $search.results as result}
+    <li on:click={() => search.selectAddress(result.pid)}>{result.sla}</li>
+  {/each}
+  {#if $search.hasMore}
+    <li on:click={() => search.loadMore()}>Load more...</li>
+  {/if}
+</ul>
+```
+
+### Store state (`$search`)
+
+| Property | Type | Description |
+|----------|------|-------------|
+| `query` | `string` | Current input value |
+| `results` | `AddressSearchResult[]` | Search results (accumulated across pages) |
+| `isLoading` | `boolean` | Initial search in progress |
+| `isLoadingMore` | `boolean` | Pagination fetch in progress |
+| `hasMore` | `boolean` | More pages available |
+| `error` | `Error \| null` | Latest error |
+| `selectedAddress` | `AddressDetail \| null` | Selected address detail |
+
+### Store methods
+
+| Method | Description |
+|--------|-------------|
+| `setQuery(q)` | Update query (triggers debounced search) |
+| `loadMore()` | Load next page of results |
+| `selectAddress(pid)` | Fetch full address detail |
+| `clear()` | Reset all state |
+| `destroy()` | Clean up timers and abort controllers |
+
+## Accessibility
+
+Implements the WAI-ARIA combobox pattern:
+
+- Full keyboard navigation (Arrow keys, Enter, Escape)
+- Screen reader announcements for results count and loading state
+- Visible focus indicators (3:1 contrast)
+- Touch targets >= 44px
+- Accessible label always present
+- Infinite scroll with loading indicator
+
+## Re-exports
+
+This package re-exports everything from [`@mountainpass/addressr-core`](../core) for convenience -- `createAddressrClient`, `parseHighlight`, and all types.
+
+## License
+
+Apache-2.0

package/package.json

@@ -0,0 +1,69 @@
+{
+  "name": "@mountainpass/addressr-svelte",
+  "version": "0.3.0",
+  "description": "Svelte address autocomplete component for Australian address search via Addressr",
+  "author": {
+    "name": "Mountain Pass",
+    "url": "https://mountain-pass.com.au"
+  },
+  "license": "Apache-2.0",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "svelte": "./dist/index.mjs",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "svelte": "./dist/index.mjs",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.cjs"
+    },
+    "./style.css": "./dist/style.css"
+  },
+  "files": [
+    "dist/"
+  ],
+  "sideEffects": [
+    "*.css"
+  ],
+  "engines": {
+    "node": ">=18"
+  },
+  "peerDependencies": {
+    "svelte": ">=4"
+  },
+  "dependencies": {
+    "@windyroad/link-header": "^1.0.1",
+    "@mountainpass/addressr-core": "0.1.0"
+  },
+  "devDependencies": {
+    "@sveltejs/vite-plugin-svelte": "^5.0.3",
+    "@testing-library/svelte": "^5.2.7",
+    "@testing-library/jest-dom": "^6.6.3",
+    "@testing-library/user-event": "^14.6.1",
+    "jsdom": "^26.1.0",
+    "svelte": "^5.33.0",
+    "vite": "^6.3.5",
+    "vite-plugin-dts": "^4.5.4",
+    "vitest": "^3.2.3"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "keywords": [
+    "svelte",
+    "address",
+    "autocomplete",
+    "australia",
+    "addressr",
+    "gnaf",
+    "combobox",
+    "hateoas"
+  ],
+  "scripts": {
+    "build": "tsc --noEmit && vite build",
+    "test": "vitest run",
+    "lint": "eslint src/"
+  }
+}