@aprestmo/norway-geodata 0.1.0

package/dist/esm/types.d.ts

@@ -0,0 +1,111 @@
+/**
+ * Language status for Norwegian municipalities
+ */
+export type LanguageStatus = 'Nøytral' | 'Bokmål' | 'Nynorsk' | 'Sami' | 'Kvensk';
+/**
+ * Municipality (Kommune) data structure
+ */
+export interface Municipality {
+    /** 4-digit municipality ID */
+    readonly k_id: string;
+    /** Municipality name */
+    readonly k_name: string;
+    /** Municipality name in Norwegian */
+    readonly k_name_no: string;
+    /** Administrative center */
+    readonly k_adm_center: string;
+    /** Population count */
+    readonly k_population: number;
+    /** Area in square kilometers */
+    readonly k_area: number;
+    /** Official language status */
+    readonly k_language: LanguageStatus;
+    /** Official website URL */
+    readonly k_url: string;
+    /** Array of postal codes with place names */
+    readonly k_postal_codes: readonly {
+        /** 4-digit postal code */
+        readonly postal_code: string;
+        /** Place name */
+        readonly postal_place: string;
+    }[];
+}
+/**
+ * County (Fylke) data structure
+ */
+export interface County {
+    /** 2-digit county ID */
+    readonly f_id: string;
+    /** County name */
+    readonly f_name: string;
+    /** Official website URL */
+    readonly f_url: string;
+}
+/**
+ * Population density statistics
+ */
+export interface PopulationDensityStats {
+    /** Minimum population density (people per km²) */
+    readonly min: number;
+    /** Maximum population density (people per km²) */
+    readonly max: number;
+    /** Average population density (people per km²) */
+    readonly average: number;
+}
+/**
+ * Version bump types for semantic versioning
+ */
+export type VersionBumpType = 'patch' | 'minor' | 'major' | 'prerelease';
+/**
+ * Sort order options
+ */
+export type SortOrder = 'asc' | 'desc';
+/**
+ * Search options for municipalities
+ */
+export interface MunicipalitySearchOptions {
+    /** Search in both Norwegian and English names */
+    readonly includeAllNames?: boolean;
+    /** Case sensitive search */
+    readonly caseSensitive?: boolean;
+    /** Exact match only */
+    readonly exactMatch?: boolean;
+}
+/**
+ * Filter options for municipalities
+ */
+export interface MunicipalityFilterOptions {
+    /** Minimum population */
+    readonly minPopulation?: number;
+    /** Maximum population */
+    readonly maxPopulation?: number;
+    /** Minimum area (km²) */
+    readonly minArea?: number;
+    /** Maximum area (km²) */
+    readonly maxArea?: number;
+    /** Language status */
+    readonly language?: LanguageStatus;
+    /** County ID */
+    readonly countyId?: string;
+}
+/**
+ * Postal Code data structure
+ */
+export interface PostalCode {
+    /** 4-digit postal code */
+    readonly k_postal_code: string;
+    /** Postal place name */
+    readonly k_postal_place: string;
+    /** 4-digit municipality ID */
+    readonly k_id: string;
+}
+/**
+ * Search options for postal codes
+ */
+export interface PostalCodeSearchOptions {
+    /** Case sensitive search */
+    readonly caseSensitive?: boolean;
+    /** Exact match only */
+    readonly exactMatch?: boolean;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/esm/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/dist/index.d.ts

@@ -0,0 +1,207 @@
+import type { Municipality, County, PostalCode, PopulationDensityStats, LanguageStatus, MunicipalitySearchOptions, MunicipalityFilterOptions, PostalCodeSearchOptions } from './types';
+/**
+ * Get the library version following semantic versioning.
+ * @returns Version string (e.g., "1.0.0")
+ */
+export declare function getVersion(): string;
+/**
+ * Get all municipalities with metadata.
+ * @returns Array of all municipalities
+ */
+export declare function getMunicipalities(): readonly Municipality[];
+/**
+ * Get a municipality by municipality ID.
+ * @param id - 4-digit municipality ID (e.g., "0301" for Oslo)
+ * @returns Municipality object or undefined if not found
+ * @throws {TypeError} If id is not a string
+ */
+export declare function getMunicipalityById(id: string): Municipality | undefined;
+/**
+ * Get municipalities by name (case-insensitive partial match by default).
+ * @param name - Municipality name or partial name to search for
+ * @param options - Search options
+ * @returns Array of matching municipalities
+ * @throws {TypeError} If name is not a string
+ */
+export declare function getMunicipalitiesByName(name: string, options?: MunicipalitySearchOptions): Municipality[];
+/**
+ * Get all counties (fylker) with metadata.
+ * @returns Array of all counties
+ */
+export declare function getCounties(): readonly County[];
+/**
+ * Get a county by county ID.
+ * @param id - 2-digit county ID (e.g., "03" for Oslo)
+ * @returns County object or undefined if not found
+ * @throws {TypeError} If id is not a string
+ */
+export declare function getCountyById(id: string): County | undefined;
+/**
+ * Get county by name (case-insensitive partial match).
+ * @param name - County name or partial name to search for
+ * @param exactMatch - Whether to match exactly (default: false)
+ * @returns County object or undefined if not found
+ * @throws {TypeError} If name is not a string
+ */
+export declare function getCountyByName(name: string, exactMatch?: boolean): County | undefined;
+/**
+ * Get all municipalities in a given county.
+ * @param countyId - 2-digit county ID (first two digits of municipality k_id)
+ * @returns Array of municipalities in the county
+ * @throws {TypeError} If countyId is not a string
+ */
+export declare function getMunicipalitiesByCounty(countyId: string): Municipality[];
+/**
+ * Get municipality by postal code.
+ * @param postalCode - Postal code to search for
+ * @returns Municipality object or undefined if not found
+ * @throws {TypeError} If postal code is not a valid number
+ */
+export declare function getMunicipalityByPostalCode(postalCode: string | number): Municipality | undefined;
+/**
+ * Get all postal codes for a specific municipality.
+ * @param municipalityId - 4-digit municipality ID
+ * @returns Array of postal codes or undefined if municipality not found
+ */
+export declare function getPostalCodesByMunicipality(municipalityId: string): readonly string[] | undefined;
+/**
+ * Get all postal codes from all municipalities.
+ * @param includeDetails - If true, returns objects with postal code and place name. If false, returns only postal codes (default: false)
+ * @returns Array of postal codes or postal code objects
+ */
+export declare function getAllPostalCodes(includeDetails?: boolean): readonly string[] | readonly {
+    zip: string;
+    place: string;
+    municipalityId: string;
+    municipalityName: string;
+}[];
+/**
+ * Get municipalities sorted by population.
+ * @param ascending - Sort in ascending order if true (default: false for descending)
+ * @returns Array of municipalities sorted by population
+ */
+export declare function getMunicipalitiesByPopulation(ascending?: boolean): Municipality[];
+/**
+ * Get municipalities sorted by area.
+ * @param ascending - Sort in ascending order if true (default: false for descending)
+ * @returns Array of municipalities sorted by area
+ */
+export declare function getMunicipalitiesByArea(ascending?: boolean): Municipality[];
+/**
+ * Get municipalities by language status.
+ * @param language - Language status
+ * @returns Array of municipalities with the specified language status
+ * @throws {TypeError} If language is not a string
+ */
+export declare function getMunicipalitiesByLanguage(language: LanguageStatus): Municipality[];
+/**
+ * Get municipalities with advanced filtering options.
+ * @param options - Filter options
+ * @returns Array of municipalities matching the filter criteria
+ */
+export declare function getMunicipalitiesFiltered(options: MunicipalityFilterOptions): Municipality[];
+/**
+ * Get total population of all municipalities.
+ * @returns Total population
+ */
+export declare function getTotalPopulation(): number;
+/**
+ * Get total area of all municipalities.
+ * @returns Total area in square kilometers
+ */
+export declare function getTotalArea(): number;
+/**
+ * Get population density statistics.
+ * @returns Object with min, max, and average population density
+ */
+export declare function getPopulationDensityStats(): PopulationDensityStats;
+/**
+ * Get municipalities by population density range.
+ * @param minDensity - Minimum population density (people per km²)
+ * @param maxDensity - Maximum population density (people per km²)
+ * @returns Array of municipalities within the density range
+ */
+export declare function getMunicipalitiesByPopulationDensity(minDensity?: number, maxDensity?: number): Municipality[];
+/**
+ * Get the largest municipalities by population.
+ * @param count - Number of municipalities to return (default: 10)
+ * @returns Array of largest municipalities by population
+ */
+export declare function getLargestMunicipalities(count?: number): Municipality[];
+/**
+ * Get the smallest municipalities by population.
+ * @param count - Number of municipalities to return (default: 10)
+ * @returns Array of smallest municipalities by population
+ */
+export declare function getSmallestMunicipalities(count?: number): Municipality[];
+/**
+ * Get all postal codes with metadata.
+ * @returns Array of all postal codes
+ */
+export declare function getPostalCodes(): readonly PostalCode[];
+/**
+ * Get postal code information by postal code.
+ * @param code - 4-digit postal code (e.g., "0001")
+ * @returns PostalCode object or undefined if not found
+ * @throws {TypeError} If code is not a string
+ */
+export declare function getPostalCodeByCode(code: string): PostalCode | undefined;
+/**
+ * Get postal codes by postal place (case-insensitive partial match by default).
+ * @param place - Postal place name or partial name to search for
+ * @param options - Search options
+ * @returns Array of matching postal codes
+ * @throws {TypeError} If place is not a string
+ */
+export declare function getPostalCodesByPlace(place: string, options?: PostalCodeSearchOptions): PostalCode[];
+/**
+ * Get postal codes by municipality ID.
+ * @param municipalityId - 4-digit municipality ID (e.g., "0301" for Oslo)
+ * @returns Array of postal codes for the municipality
+ * @throws {TypeError} If municipalityId is not a string
+ */
+export declare function getPostalCodesByMunicipalityId(municipalityId: string): PostalCode[];
+/**
+ * Get unique postal places.
+ * @returns Array of unique postal place names sorted alphabetically
+ */
+export declare function getUniquePostalPlaces(): readonly string[];
+/**
+ * Get postal codes within a range.
+ * @param startCode - Starting postal code (inclusive)
+ * @param endCode - Ending postal code (inclusive)
+ * @returns Array of postal codes within the range
+ * @throws {TypeError} If start or end codes are not strings
+ */
+export declare function getPostalCodesInRange(startCode: string, endCode: string): PostalCode[];
+/**
+ * Get postal codes statistics.
+ * @returns Object with total count and unique places count
+ */
+export declare function getPostalCodesStats(): {
+    readonly totalPostalCodes: number;
+    readonly uniquePlaces: number;
+    readonly uniqueMunicipalities: number;
+};
+/**
+ * Get postal codes sorted by code.
+ * @param ascending - Sort in ascending order if true (default: true)
+ * @returns Array of postal codes sorted by postal code
+ */
+export declare function getPostalCodesSorted(ascending?: boolean): PostalCode[];
+/**
+ * Check if a postal code exists.
+ * @param code - 4-digit postal code to check
+ * @returns True if postal code exists, false otherwise
+ */
+export declare function isValidPostalCode(code: string): boolean;
+/**
+ * Get postal codes by municipality name.
+ * Note: This function combines data from municipalities and postal codes.
+ * @param municipalityName - Municipality name to search for
+ * @param exactMatch - Whether to match exactly (default: false)
+ * @returns Array of postal codes for municipalities matching the name
+ */
+export declare function getPostalCodesByMunicipalityName(municipalityName: string, exactMatch?: boolean): PostalCode[];
+export type { Municipality, County, PostalCode, PopulationDensityStats, LanguageStatus, MunicipalitySearchOptions, MunicipalityFilterOptions, PostalCodeSearchOptions };
+//# sourceMappingURL=index.d.ts.map