@devdash/bofrid-api-types 0.1.5

package/dist/routes/geo.d.ts

@@ -0,0 +1,518 @@
+/**
+ * Geo routes — serves Swedish geographic data from the `geo.*` Postgres tables.
+ *
+ * All data is read-only (no auth required). Responses are heavily cached.
+ */
+import { OpenAPIHono } from "@hono/zod-openapi";
+import type { AppBindings } from "../app";
+export declare const geoApp: OpenAPIHono<AppBindings, {
+    "/geo/autocomplete": {
+        $get: {
+            input: {
+                query: {
+                    limit?: number | undefined;
+                    q?: string | undefined;
+                };
+            };
+            output: {
+                predictions: {
+                    type: string;
+                    data: {
+                        name: string;
+                        slug: string;
+                        center: {
+                            lat: number;
+                            lng: number;
+                        } | null;
+                        boundingbox: [number, number, number, number] | null;
+                        regionSlug?: string | undefined;
+                        municipalitySlug?: string | undefined;
+                    };
+                    place_id: string;
+                    structured_formatting: {
+                        main_text: string;
+                        secondary_text: string;
+                    };
+                    _links?: {
+                        polygon?: string | undefined;
+                    } | undefined;
+                }[];
+            };
+            outputFormat: "json";
+            status: 200;
+        };
+    };
+} & {
+    "/geo/lan/:slug": {
+        $get: {
+            input: {
+                param: {
+                    slug: string;
+                };
+            };
+            output: {};
+            outputFormat: "json";
+            status: 200;
+        } | {
+            input: {
+                param: {
+                    slug: string;
+                };
+            };
+            output: {
+                error: string;
+            };
+            outputFormat: "json";
+            status: 404;
+        };
+    };
+} & {
+    "/geo/lan/:slug/polygon": {
+        $get: {
+            input: {
+                param: {
+                    slug: string;
+                };
+            };
+            output: {};
+            outputFormat: "json";
+            status: 200;
+        } | {
+            input: {
+                param: {
+                    slug: string;
+                };
+            };
+            output: {
+                error: string;
+            };
+            outputFormat: "json";
+            status: 404;
+        };
+    };
+} & {
+    "/geo/kommun/:slug": {
+        $get: {
+            input: {
+                param: {
+                    slug: string;
+                };
+            };
+            output: {};
+            outputFormat: "json";
+            status: 200;
+        } | {
+            input: {
+                param: {
+                    slug: string;
+                };
+            };
+            output: {
+                error: string;
+            };
+            outputFormat: "json";
+            status: 404;
+        };
+    };
+} & {
+    "/geo/kommun/:slug/polygon": {
+        $get: {
+            input: {
+                param: {
+                    slug: string;
+                };
+            };
+            output: {};
+            outputFormat: "json";
+            status: 200;
+        } | {
+            input: {
+                param: {
+                    slug: string;
+                };
+            };
+            output: {
+                error: string;
+            };
+            outputFormat: "json";
+            status: 404;
+        };
+    };
+} & {
+    "/geo/kommun/:slug/areas": {
+        $get: {
+            input: {
+                param: {
+                    slug: string;
+                };
+            } & {
+                query: {
+                    limit?: number | undefined;
+                };
+            };
+            output: {};
+            outputFormat: "json";
+            status: 200;
+        } | {
+            input: {
+                param: {
+                    slug: string;
+                };
+            } & {
+                query: {
+                    limit?: number | undefined;
+                };
+            };
+            output: {
+                error: string;
+            };
+            outputFormat: "json";
+            status: 404;
+        };
+    };
+} & {
+    "/geo/area/: municipalitySlug/:areaSlug": {
+        $get: {
+            input: {
+                param: {
+                    municipalitySlug: string;
+                    areaSlug: string;
+                };
+            };
+            output: {};
+            outputFormat: "json";
+            status: 200;
+        } | {
+            input: {
+                param: {
+                    municipalitySlug: string;
+                    areaSlug: string;
+                };
+            };
+            output: {
+                error: string;
+            };
+            outputFormat: "json";
+            status: 404;
+        };
+    };
+} & {
+    "/geo/area/: municipalitySlug/:areaSlug/polygon": {
+        $get: {
+            input: {
+                param: {
+                    municipalitySlug: string;
+                    areaSlug: string;
+                };
+            };
+            output: {};
+            outputFormat: "json";
+            status: 200;
+        } | {
+            input: {
+                param: {
+                    municipalitySlug: string;
+                    areaSlug: string;
+                };
+            };
+            output: {
+                error: string;
+            };
+            outputFormat: "json";
+            status: 404;
+        };
+    };
+} & {
+    "/geo/hierarchy": {
+        $get: {
+            input: {};
+            output: {};
+            outputFormat: "json";
+            status: 200;
+        };
+    };
+} & {
+    "/geo/hierarchy-bulk": {
+        $get: {
+            input: {};
+            output: {};
+            outputFormat: "json";
+            status: 200;
+        };
+    };
+} & {
+    "/geo/hierarchy/: regionSlug": {
+        $get: {
+            input: {
+                param: {
+                    regionSlug: string;
+                };
+            };
+            output: {};
+            outputFormat: "json";
+            status: 200;
+        } | {
+            input: {
+                param: {
+                    regionSlug: string;
+                };
+            };
+            output: {
+                error: string;
+            };
+            outputFormat: "json";
+            status: 404;
+        };
+    };
+} & {
+    "/geo/listings/stats": {
+        $get: {
+            input: {};
+            output: {};
+            outputFormat: "json";
+            status: 200;
+        };
+    };
+} & {
+    "/geo/market-insights": {
+        $get: {
+            input: {
+                query: {
+                    municipalitySlug: string;
+                    propertyType?: string | undefined;
+                    regionSlug?: string | undefined;
+                    sqm?: number | undefined;
+                    areaId?: string | undefined;
+                };
+            };
+            output: {
+                insight: {
+                    propertyType: string | null;
+                    locationName: string;
+                    level: "lan" | "kommun" | "area";
+                    sampleSize: number;
+                    avgKvmPris: number;
+                    medianKvmPris: number;
+                    avgRent: number;
+                    medianRent: number;
+                    rentP25: number;
+                    rentP75: number;
+                    avgSqm: number;
+                    suggestedRent: number | null;
+                } | null;
+            };
+            outputFormat: "json";
+            status: 200;
+        };
+    };
+} & {
+    "/geo/market-insights/coords": {
+        $get: {
+            input: {
+                query: {
+                    lat: number;
+                    lng: number;
+                    sqm?: number | undefined;
+                };
+            };
+            output: {
+                location: {
+                    lan: {
+                        name: string;
+                        slug: string;
+                    } | null;
+                    kommun: {
+                        name: string;
+                        slug: string;
+                    } | null;
+                    area: {
+                        type: string;
+                        name: string;
+                        slug: string;
+                    } | null;
+                };
+                lat: number;
+                lng: number;
+                insights: {
+                    name: string;
+                    slug: string;
+                    level: "lan" | "kommun" | "area";
+                    byType: {
+                        [x: string]: {
+                            sampleSize: number;
+                            avgKvmPris: number;
+                            medianKvmPris: number;
+                            avgRent: number;
+                            medianRent: number;
+                            rentP25: number;
+                            rentP75: number;
+                            avgSqm: number;
+                            suggestedRent: number | null;
+                        };
+                    };
+                    byYear: {
+                        byType: {
+                            [x: string]: {
+                                sampleSize: number;
+                                avgKvmPris: number;
+                                medianKvmPris: number;
+                                avgRent: number;
+                                medianRent: number;
+                                rentP25: number;
+                                rentP75: number;
+                                avgSqm: number;
+                                suggestedRent: number | null;
+                            };
+                        };
+                        year: number;
+                    }[];
+                    meta?: {
+                        [x: string]: string;
+                    } | undefined;
+                }[];
+            };
+            outputFormat: "json";
+            status: 200;
+        };
+    };
+} & {
+    "/geo/market-overview": {
+        $get: {
+            input: {
+                query: {
+                    limit?: number | undefined;
+                    propertyType?: "apartment" | "all" | "house" | "student" | "room" | undefined;
+                    regionSlug?: string | undefined;
+                    minSamples?: number | undefined;
+                    sortBy?: "sampleSize" | "medianKvmPris" | "medianRent" | undefined;
+                };
+            };
+            output: {
+                totalListings: number;
+                swedenWide: {
+                    sampleSize: number;
+                    medianKvmPris: number;
+                    medianRent: number;
+                    avgSqm: number;
+                } | null;
+                rows: {
+                    regionSlug: string;
+                    municipalitySlug: string;
+                    regionName: string;
+                    municipalityName: string;
+                    sampleSize: number;
+                    medianKvmPris: number;
+                    medianRent: number;
+                    rentP25: number;
+                    rentP75: number;
+                    avgSqm: number;
+                }[];
+            };
+            outputFormat: "json";
+            status: 200;
+        };
+    };
+} & {
+    "/geo/market-insights/samples": {
+        $get: {
+            input: {
+                query: {
+                    limit?: number | undefined;
+                    regionSlug?: string | undefined;
+                    municipalitySlug?: string | undefined;
+                    areaId?: string | undefined;
+                };
+            };
+            output: {
+                samples: {
+                    id: string;
+                    address: string | null;
+                    city: string | null;
+                    source: string | null;
+                    externalUrl: string | null;
+                    rentSek: number | null;
+                    rooms: number | null;
+                    sqm: number | null;
+                    kvmPris: number | null;
+                }[];
+            };
+            outputFormat: "json";
+            status: 200;
+        };
+    };
+} & {
+    "/geo/unified-listing/:id": {
+        $get: {
+            input: {
+                param: {
+                    id: string;
+                };
+            };
+            output: {
+                error: string;
+            };
+            outputFormat: "json";
+            status: 404;
+        } | {
+            input: {
+                param: {
+                    id: string;
+                };
+            };
+            output: {
+                title: string | null;
+                address: string | null;
+                city: string | null;
+                publicUrl: string | null;
+                regionSlug: string | null;
+                municipalitySlug: string | null;
+                externalUrl: string | null;
+                sourceUrl: string | null;
+                imageUrl: string | null;
+                rentSek: number | null;
+                rooms: number | null;
+                sqm: number | null;
+            };
+            outputFormat: "json";
+            status: 200;
+        };
+    };
+} & {
+    "/geo/fb-groups": {
+        $get: {
+            input: {
+                query: {
+                    lan?: string | undefined;
+                    kommun?: string | undefined;
+                };
+            };
+            output: {
+                count: number;
+                groups: {
+                    name: string;
+                    url: string;
+                    id: string;
+                    regionSlug: string | null;
+                    municipalitySlug: string | null;
+                    areaId: string | null;
+                    level: "lan" | "kommun" | "area";
+                    areaName: string | null;
+                }[];
+            };
+            outputFormat: "json";
+            status: 200;
+        } | {
+            input: {
+                query: {
+                    lan?: string | undefined;
+                    kommun?: string | undefined;
+                };
+            };
+            output: {
+                error: string;
+            };
+            outputFormat: "json";
+            status: 503;
+        };
+    };
+}, "/">;

package/dist/routes/geocoding.d.ts

@@ -0,0 +1,192 @@
+import { OpenAPIHono } from "@hono/zod-openapi";
+import type { AppBindings } from "../app";
+export declare const geocodingApp: OpenAPIHono<AppBindings, {
+    "/geocoding/autocomplete": {
+        $post: {
+            input: {
+                json: {
+                    query: string;
+                };
+            };
+            output: {
+                predictions: {
+                    text: {
+                        text: string;
+                        matches?: {
+                            endOffset: number;
+                            startOffset?: number | undefined;
+                        }[] | undefined;
+                    };
+                    place: string;
+                    placeId: string;
+                    types?: string[] | undefined;
+                    structuredFormat?: {
+                        mainText: {
+                            text: string;
+                        };
+                        secondaryText?: {
+                            text: string;
+                        } | undefined;
+                    } | undefined;
+                }[];
+            };
+            outputFormat: "json";
+            status: 200;
+        } | {
+            input: {
+                json: {
+                    query: string;
+                };
+            };
+            output: {
+                error: string;
+            };
+            outputFormat: "json";
+            status: 500;
+        };
+    };
+} & {
+    "/geocoding/place-details": {
+        $post: {
+            input: {
+                json: {
+                    placeId: string;
+                    autocompleteText?: string | undefined;
+                };
+            };
+            output: {
+                error: string;
+            };
+            outputFormat: "json";
+            status: 500;
+        } | {
+            input: {
+                json: {
+                    placeId: string;
+                    autocompleteText?: string | undefined;
+                };
+            };
+            output: {
+                street: string;
+                streetNumber: string;
+                postalCode: string;
+                city: string;
+                municipality: string;
+                country: string;
+                coordinates: {
+                    lat: number;
+                    lon: number;
+                };
+                formattedAddress: string;
+                neighborhood?: string | undefined;
+            };
+            outputFormat: "json";
+            status: 200;
+        } | {
+            input: {
+                json: {
+                    placeId: string;
+                    autocompleteText?: string | undefined;
+                };
+            };
+            output: {
+                error: string;
+            };
+            outputFormat: "json";
+            status: 404;
+        };
+    };
+} & {
+    "/geocoding/search": {
+        $post: {
+            input: {
+                json: {
+                    address: string;
+                };
+            };
+            output: {
+                error: string;
+            };
+            outputFormat: "json";
+            status: 500;
+        } | {
+            input: {
+                json: {
+                    address: string;
+                };
+            };
+            output: {
+                error: string;
+            };
+            outputFormat: "json";
+            status: 404;
+        } | {
+            input: {
+                json: {
+                    address: string;
+                };
+            };
+            output: {
+                lat: number;
+                lon: number;
+            };
+            outputFormat: "json";
+            status: 200;
+        };
+    };
+} & {
+    "/geocoding/reverse": {
+        $get: {
+            input: {
+                query: {
+                    lat: number;
+                    lng: number;
+                };
+            };
+            output: {
+                error: string;
+            };
+            outputFormat: "json";
+            status: 500;
+        } | {
+            input: {
+                query: {
+                    lat: number;
+                    lng: number;
+                };
+            };
+            output: {
+                municipality: {
+                    name: string;
+                    slug: string;
+                };
+                region: {
+                    name: string;
+                    slug: string;
+                };
+                postalCode?: string | undefined;
+                formattedAddress?: string | undefined;
+                areas?: {
+                    type: string;
+                    name: string;
+                    slug: string;
+                }[] | undefined;
+                primaryArea?: string | undefined;
+            };
+            outputFormat: "json";
+            status: 200;
+        } | {
+            input: {
+                query: {
+                    lat: number;
+                    lng: number;
+                };
+            };
+            output: {
+                error: string;
+            };
+            outputFormat: "json";
+            status: 400;
+        };
+    };
+}, "/">;