feat(types): adopt TypeScript types generated from the API

AGENTS.md

@@ -83,6 +83,25 @@ import { merchantList } from '$lib/merchantListStore';
 import type { Place, Report, AreaTags } from '$lib/types';
 ```
 
+### Generated API types (`$types/btcmap-api`)
+
+- `src/types/btcmap-api/` is generated from btcmap-api's Rust response structs
+  (ts-rs) — never hand-edit it; it is excluded from biome and must stay
+  byte-identical to the generator's output
+- Refresh with `pnpm types:api` — it fetches the committed `bindings/ts/`
+  directory from btcmap-api's master on GitHub (no Rust toolchain or checkout
+  needed; btcmap-api CI guarantees that directory matches its code). Commit
+  the resulting diff — it documents the API change
+- To develop against an unmerged btcmap-api branch:
+  `npx degit "teambtcmap/btcmap-api/bindings/ts#<branch>" src/types/btcmap-api`
+- Import these types (via the `$types` alias) when typing raw v4 API responses,
+  e.g. `import type { SearchResponse } from "$types/btcmap-api/SearchResponse"`
+- **Two `Place` types exist during the migration:** `Place` from `$lib/types`
+  stays the app-facing type used by stores and components; the generated
+  `$types/btcmap-api/Place` is the API contract shape for the `fields`-driven
+  endpoints (all fields optional). Don't autocomplete the wrong one — if a
+  store or component needs `Place`, it's the `$lib/types` one
+
 ### Comments
 
 - **Avoid JSDoc comments** (`/** */` with `@param`, `@returns`, `@description`, etc.)

biome.json

@@ -18,7 +18,8 @@
 			"!spritesheet-*.ts",
 			"!playwright-report",
 			"!src/error.html",
-			"!**/*.svg"
+			"!**/*.svg",
+			"!src/types/btcmap-api"
 		]
 	},
 	"assist": {

package.json

@@ -23,6 +23,7 @@
 		"preview": "vite preview",
 		"sync:rtl-plugin": "cp node_modules/@mapbox/mapbox-gl-rtl-text/dist/mapbox-gl-rtl-text.js static/mapbox-gl-rtl-text.js",
 		"test": "vitest",
+		"types:api": "rm -rf src/types/btcmap-api && npx degit teambtcmap/btcmap-api/bindings/ts src/types/btcmap-api",
 		"typecheck": "tsc --project ./tsconfig.json --noEmit --pretty"
 	},
 	"lint-staged": {

src/routes/api/search/places/+server.ts

@@ -3,6 +3,7 @@ import { error } from "@sveltejs/kit";
 import { API_BASE } from "$lib/api-base";
 
 import type { RequestHandler } from "./$types";
+import type { SearchResponse } from "$types/btcmap-api/SearchResponse";
 
 // Worldwide free-text search. Backed by /v4/search, which matches every OSM tag
 // value, so a city name finds the places addressed in that city. Scoped to
@@ -43,12 +44,11 @@ export const GET: RequestHandler = async ({ url, fetch }) => {
 		error(res.status, "Search temporarily unavailable");
 	}
 
-	const body = (await res.json()) as {
-		results?: ({ type: string } & Record<string, unknown>)[];
-		total_count?: number;
-		has_more?: boolean;
-	};
-	// Drop the discriminator so each row is exactly a Place.
+	// Partial: the type describes what the current API sends, but this proxy
+	// deliberately tolerates an upstream that omits fields (see tests).
+	const body = (await res.json()) as Partial<SearchResponse>;
+	// Drop the discriminator; `type_filter=place` means every row is a place
+	// at runtime, though the static type stays the area/place union.
 	const places = (body.results ?? []).map(({ type: _type, ...place }) => place);
 
 	// The API caps `limit`, so a broad query ("str" matches every addr:street)

src/types/btcmap-api/ActivityItem.ts

@@ -0,0 +1,3 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+export type ActivityItem = { type: string, place_id: number, place_name?: string, osm_user_id?: number, osm_user_name?: string, osm_user_tip?: string, comment?: string, duration_days?: number, image: string, date: string, };

src/types/btcmap-api/Area.ts

@@ -0,0 +1,3 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+export type Area = { id: number, name: string, type: string, url_alias: string, icon: string | null, icon_wide: string | null, website_url: string, description: string, };

src/types/btcmap-api/AreaSearchResult.ts

@@ -0,0 +1,3 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+export type AreaSearchResult = { id: number, name: string, type: string, url_alias: string, icon: string | null, website_url: string, };

src/types/btcmap-api/AuthNostrResponse.ts

@@ -0,0 +1,3 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+export type AuthNostrResponse = { token: string, username: string, npub: string, };

src/types/btcmap-api/ChangePasswordArgs.ts

@@ -0,0 +1,3 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+export type ChangePasswordArgs = { old_password: string, new_password: string, };

src/types/btcmap-api/ChartEntry.ts

@@ -0,0 +1,3 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+export type ChartEntry = { date: string, value: number, };

src/types/btcmap-api/Community.ts

@@ -0,0 +1,3 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+export type Community = { id: number, alias: string, name: string, icon: string | null, places_total: number, places_verified_1y: number, grade: number, };

src/types/btcmap-api/Country.ts

@@ -0,0 +1,3 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+export type Country = { id: number, alias: string, name: string, icon: string | null, places_total: number, places_verified_1y: number, grade: number, };

src/types/btcmap-api/CreateTokenArgs.ts

@@ -0,0 +1,3 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+export type CreateTokenArgs = { label: string | null, };

src/types/btcmap-api/CreateTokenResponse.ts

@@ -0,0 +1,4 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+import type { MeResponse } from "./MeResponse";
+
+export type CreateTokenResponse = { token: string, user: MeResponse, };

src/types/btcmap-api/CreateUserArgs.ts

@@ -0,0 +1,3 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+export type CreateUserArgs = { name: string | null, password: string, };

src/types/btcmap-api/CreateUserResponse.ts

@@ -0,0 +1,3 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+export type CreateUserResponse = { id: number, name: string, roles: Array<string>, };

src/types/btcmap-api/Dashboard.ts

@@ -0,0 +1,4 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+import type { ChartEntry } from "./ChartEntry";
+
+export type Dashboard = { total_merchants: number, total_merchants_chart: Array<ChartEntry>, verified_merchants_1y: number, verified_merchants_1y_chart: Array<ChartEntry>, total_exchanges: number, total_exchanges_chart: Array<ChartEntry>, verified_exchanges_1y: number, total_areas: number, verified_areas_1y: number, };

src/types/btcmap-api/Invoice.ts

@@ -0,0 +1,3 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+export type Invoice = { id: string, status: string, };

src/types/btcmap-api/MeResponse.ts

@@ -0,0 +1,15 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+import type { SavedArea } from "./SavedArea";
+import type { SavedPlace } from "./SavedPlace";
+
+export type MeResponse = { id: number, name: string, roles: Array<string>, saved_places: Array<SavedPlace>, saved_areas: Array<SavedArea>, 
+/**
+ * Area ids the user is restricted to when acting as an event manager.
+ * Empty means unrestricted.
+ */
+geofence: Array<number>, 
+/**
+ * Bech32 npub (`npub1...`) of the Nostr identity linked to this user,
+ * or `null` when no pubkey is linked.
+ */
+npub: string | null, };

src/types/btcmap-api/NostrIdentityResponse.ts

@@ -0,0 +1,7 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+export type NostrIdentityResponse = { 
+/**
+ * Bech32 npub (`npub1...`) currently linked to the account, or `null`.
+ */
+npub: string | null, };

src/types/btcmap-api/PaginationInfo.ts

@@ -0,0 +1,3 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+export type PaginationInfo = { offset: number, limit: number, total: number, };

src/types/btcmap-api/Place.ts

@@ -0,0 +1,11 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+/**
+ * Type-export-only description of the dynamic place responses.
+ * `GET /v4/places` and `GET /v4/places/{id}` build their JSON at runtime
+ * from the `fields` query param, so every field except `id` is optional.
+ * Fields requested via the `osm:<tag>` passthrough appear as extra keys and
+ * cannot be typed statically. Kept in sync with `service::element::TAGS` by
+ * `place_type_covers_all_generate_tags_fields`.
+ */
+export type Place = { id: number, osm_id?: string, osm_url?: string, osm_edit_url?: string, lat?: number, lon?: number, name?: string, address?: string, icon?: string, phone?: string, website?: string, twitter?: string, facebook?: string, instagram?: string, line?: string, email?: string, opening_hours?: string, boosted_until?: string, required_app_url?: string, created_at?: string, updated_at?: string, deleted_at?: string, verified_at?: string, comments?: number, description?: string, image?: string, payment_provider?: string, telegram?: string, localized_name?: Record<string, string>, localized_opening_hours?: Record<string, string>, };

src/types/btcmap-api/PlaceActivity.ts

@@ -0,0 +1,3 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+export type PlaceActivity = { id: number, type: string, user_id: number | null, user_name?: string, user_tip?: string, created_at: string, updated_at: string, };

src/types/btcmap-api/PlaceArea.ts

@@ -0,0 +1,3 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+export type PlaceArea = { id: number, alias: string, tags: Record<string, unknown>, created_at: string, updated_at: string, };

src/types/btcmap-api/PlaceBoostQuote.ts

@@ -0,0 +1,3 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+export type PlaceBoostQuote = { quote_30d_sat: number, quote_90d_sat: number, quote_365d_sat: number, };

src/types/btcmap-api/PlaceComment.ts

@@ -0,0 +1,3 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+export type PlaceComment = { id: number, text: string, created_at: string, };

src/types/btcmap-api/PlaceCommentListItem.ts

@@ -0,0 +1,3 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+export type PlaceCommentListItem = { id: number, place_id: number, text: string, created_at: string, updated_at: string, deleted_at?: string, };

src/types/btcmap-api/PlaceCommentQuote.ts

@@ -0,0 +1,3 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+export type PlaceCommentQuote = { quote_sat: number, };

src/types/btcmap-api/PlaceIssue.ts

@@ -0,0 +1,3 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+export type PlaceIssue = { id: number, place_id: number, code: string, severity: number, created_at: string, updated_at: string, deleted_at?: string, };

src/types/btcmap-api/PlaceIssueSummary.ts

@@ -0,0 +1,3 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+export type PlaceIssueSummary = { element_osm_type: string, element_osm_id: number, element_name: string, issue_code: string, };

src/types/btcmap-api/PlaceIssuesRes.ts

@@ -0,0 +1,4 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+import type { PlaceIssueSummary } from "./PlaceIssueSummary";
+
+export type PlaceIssuesRes = { total_issues: number, requested_issues: Array<PlaceIssueSummary>, };

src/types/btcmap-api/PostPlaceBoostArgs.ts

@@ -0,0 +1,3 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+export type PostPlaceBoostArgs = { place_id: string, days: number, };

src/types/btcmap-api/PostPlaceBoostResponse.ts

@@ -0,0 +1,3 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+export type PostPlaceBoostResponse = { invoice_id: string, invoice: string, };

src/types/btcmap-api/PostPlaceCommentArgs.ts

@@ -0,0 +1,3 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+export type PostPlaceCommentArgs = { place_id: string, comment: string, };

src/types/btcmap-api/PostPlaceCommentResponse.ts

@@ -0,0 +1,3 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+export type PostPlaceCommentResponse = { invoice_id: string, invoice: string, };

src/types/btcmap-api/SavedArea.ts

@@ -0,0 +1,3 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+export type SavedArea = { id: number, name: string, };

src/types/btcmap-api/SavedPlace.ts

@@ -0,0 +1,3 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+export type SavedPlace = { id: number, name: string, };

src/types/btcmap-api/SearchResponse.ts

@@ -0,0 +1,5 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+import type { PaginationInfo } from "./PaginationInfo";
+import type { SearchResult } from "./SearchResult";
+
+export type SearchResponse = { results: Array<SearchResult>, total_count: number, has_more: boolean, query: string, pagination: PaginationInfo, };

src/types/btcmap-api/SearchResult.ts

@@ -0,0 +1,9 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+import type { SearchedArea } from "./SearchedArea";
+import type { SearchedPlace } from "./SearchedPlace";
+
+/**
+ * `SearchedPlace` is boxed because it is an order of magnitude larger than
+ * `SearchedArea`, and clippy's `large_enum_variant` would otherwise fire.
+ */
+export type SearchResult = { "type": "area" } & SearchedArea | { "type": "place" } & SearchedPlace;

src/types/btcmap-api/SearchedArea.ts

@@ -0,0 +1,7 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+export type SearchedArea = { id: number, name: string, alias?: string, 
+/**
+ * `[west, south, east, north]`. Absent when the area has no bbox of its own.
+ */
+bbox?: [number, number, number, number], };

src/types/btcmap-api/SearchedPlace.ts

@@ -0,0 +1,3 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+export type SearchedPlace = { id: number, lat: number, lon: number, icon: string, name: string, address?: string, opening_hours?: string, comments?: number, created_at: string, updated_at: string, verified_at: string | null, osm_id?: string, phone?: string, website?: string, twitter?: string, facebook?: string, instagram?: string, line?: string, email?: string, boosted_until?: string, required_app_url?: string, description?: string, image?: string, payment_provider?: string, localized_name?: Record<string, string>, };

src/types/btcmap-api/TopEditor.ts

@@ -0,0 +1,3 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+export type TopEditor = { id: number, name: string, avatar_url: string | null, total_edits: number, places_created: number, places_updated: number, places_deleted: number, tip_url: string | null, };

src/types/btcmap-api/UpdateUsernameArgs.ts

@@ -0,0 +1,3 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+export type UpdateUsernameArgs = { username: string, };

svelte.config.js

@@ -14,7 +14,9 @@ const config = {
 		adapter: adapter(),
 		alias: {
 			$components: 'src/components',
-			'$components/*': 'src/components/*'
+			'$components/*': 'src/components/*',
+			$types: 'src/types',
+			'$types/*': 'src/types/*'
 		},
 		serviceWorker: {
 			register: true,