# test-bit-sys/algeria-geo architecture

> Architecture diagram of the GitHub repository test-bit-sys/algeria-geo, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-21). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/test-bit-sys/algeria-geo
- Repository: https://github.com/test-bit-sys/algeria-geo

## Overview

algeria-geo is a dependency-free geospatial and administrative-data library, exposed for TypeScript/JavaScript and Python. A caller uses package APIs for administrative lookups, historical-era queries, cross-script search, postal-code or dropdown helpers, and SVG map generation. Its core runtime is an in-memory index, with language normalization and typed domain models supporting queries. The README also describes GeoJSON and SQL/JSON/CSV exports; the available tree shows source data and GeoJSON, but not the export implementation. Relationships for unsampled features are therefore not inferred.

Main entry points: [`packages/node/src/index.ts`](https://github.com/test-bit-sys/algeria-geo/blob/main/packages/node/src/index.ts) (TypeScript API And Index), [`packages/python/src/algeria_geo/index.py`](https://github.com/test-bit-sys/algeria-geo/blob/main/packages/python/src/algeria_geo/index.py) (Python Query Index), [`packages/python/src/algeria_geo/__init__.py`](https://github.com/test-bit-sys/algeria-geo/blob/main/packages/python/src/algeria_geo/__init__.py) (Python Public API), [`packages/node/src/map.ts`](https://github.com/test-bit-sys/algeria-geo/blob/main/packages/node/src/map.ts) (SVG Map Generator)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_datasets["Administrative Data"]
  node_admin_data[("Administrative Records")]
  node_geojson["Boundary GeoJSON<br/>[algeria-69.geojson]"]
end

subgraph group_ts["TypeScript Runtime"]
  node_ts_api["TypeScript API And Index<br/>[index.ts]"]
  node_ts_types["TypeScript Models<br/>[types.ts]"]
end

subgraph group_py["Python Runtime"]
  node_py_api["Python Public API<br/>[__init__.py]"]
  node_py_index["Python Query Index<br/>[index.py]"]
  node_py_models["Python Domain Models<br/>[models.py]"]
end

subgraph group_shared["Search And Mapping"]
  node_ts_text["Text Matching<br/>[text.ts]"]
  node_ts_map["SVG Map Generator<br/>[map.ts]"]
  node_py_text["Text Matching<br/>[_text.py]"]
  node_py_map["SVG Map Generator<br/>[map.py]"]
end

node_caller(("Library Caller"))

node_caller -->|"queries"| node_ts_api
node_caller -->|"queries"| node_py_api
node_ts_api -->|"normalizes queries"| node_ts_text
node_py_api -->|"delegates queries"| node_py_index
node_py_index -->|"normalizes queries"| node_py_text
node_py_index -->|"constructs records"| node_py_models
node_ts_api -->|"uses types"| node_ts_types
node_ts_api -->|"exports map APIs"| node_ts_map
node_ts_map -->|"gets era wilayas"| node_ts_api
node_py_api -->|"exports map APIs"| node_py_map
node_py_map -->|"gets era wilayas"| node_py_index
node_caller -->|"can consume polygons"| node_geojson

click node_admin_data "https://github.com/test-bit-sys/algeria-geo/tree/main/data"
click node_geojson "https://github.com/test-bit-sys/algeria-geo/blob/main/data/maps/algeria-69.geojson"
click node_ts_api "https://github.com/test-bit-sys/algeria-geo/blob/main/packages/node/src/index.ts"
click node_ts_types "https://github.com/test-bit-sys/algeria-geo/blob/main/packages/node/src/types.ts"
click node_ts_text "https://github.com/test-bit-sys/algeria-geo/blob/main/packages/node/src/text.ts"
click node_ts_map "https://github.com/test-bit-sys/algeria-geo/blob/main/packages/node/src/map.ts"
click node_py_api "https://github.com/test-bit-sys/algeria-geo/blob/main/packages/python/src/algeria_geo/__init__.py"
click node_py_index "https://github.com/test-bit-sys/algeria-geo/blob/main/packages/python/src/algeria_geo/index.py"
click node_py_models "https://github.com/test-bit-sys/algeria-geo/blob/main/packages/python/src/algeria_geo/models.py"
click node_py_text "https://github.com/test-bit-sys/algeria-geo/blob/main/packages/python/src/algeria_geo/_text.py"
click node_py_map "https://github.com/test-bit-sys/algeria-geo/blob/main/packages/python/src/algeria_geo/map.py"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_admin_data,node_geojson toneBlue
class node_ts_api,node_ts_types toneAmber
class node_py_api,node_py_index,node_py_models toneMint
class node_ts_text,node_ts_map,node_py_text,node_py_map toneRose
class node_caller toneIndigo
```

## Components

### Administrative Data

- [Administrative Records](https://github.com/test-bit-sys/algeria-geo/tree/main/data): `data`
- [Boundary GeoJSON](https://github.com/test-bit-sys/algeria-geo/blob/main/data/maps/algeria-69.geojson): `data/maps/algeria-69.geojson`

### TypeScript Runtime

- [TypeScript API And Index](https://github.com/test-bit-sys/algeria-geo/blob/main/packages/node/src/index.ts): `packages/node/src/index.ts`
- [TypeScript Models](https://github.com/test-bit-sys/algeria-geo/blob/main/packages/node/src/types.ts): `packages/node/src/types.ts`

### Python Runtime

- [Python Public API](https://github.com/test-bit-sys/algeria-geo/blob/main/packages/python/src/algeria_geo/__init__.py): `packages/python/src/algeria_geo/__init__.py`
- [Python Query Index](https://github.com/test-bit-sys/algeria-geo/blob/main/packages/python/src/algeria_geo/index.py): `packages/python/src/algeria_geo/index.py`
- [Python Domain Models](https://github.com/test-bit-sys/algeria-geo/blob/main/packages/python/src/algeria_geo/models.py): `packages/python/src/algeria_geo/models.py`

### Search And Mapping

- [Text Matching](https://github.com/test-bit-sys/algeria-geo/blob/main/packages/node/src/text.ts): `packages/node/src/text.ts`
- [SVG Map Generator](https://github.com/test-bit-sys/algeria-geo/blob/main/packages/node/src/map.ts): `packages/node/src/map.ts`
- [Text Matching](https://github.com/test-bit-sys/algeria-geo/blob/main/packages/python/src/algeria_geo/_text.py): `packages/python/src/algeria_geo/_text.py`
- [SVG Map Generator](https://github.com/test-bit-sys/algeria-geo/blob/main/packages/python/src/algeria_geo/map.py): `packages/python/src/algeria_geo/map.py`

### Other components

- **Library Caller**

## Connections

- Library Caller → TypeScript API And Index: queries (evidence: `README.md`)
- Library Caller → Python Public API: queries (evidence: `README.md`)
- TypeScript API And Index → Text Matching: normalizes queries (evidence: `packages/node/src/index.ts`)
- Python Public API → Python Query Index: delegates queries (evidence: `packages/python/src/algeria_geo/__init__.py`)
- Python Query Index → Text Matching: normalizes queries (evidence: `packages/python/src/algeria_geo/index.py`)
- Python Query Index → Python Domain Models: constructs records (evidence: `packages/python/src/algeria_geo/index.py`)
- TypeScript API And Index → TypeScript Models: uses types (evidence: `packages/node/src/index.ts`)
- TypeScript API And Index → SVG Map Generator: exports map APIs (evidence: `packages/node/src/index.ts`)
- SVG Map Generator → TypeScript API And Index: gets era wilayas (evidence: `packages/node/src/map.ts`)
- Python Public API → SVG Map Generator: exports map APIs (evidence: `packages/python/src/algeria_geo/__init__.py`)
- SVG Map Generator → Python Query Index: gets era wilayas (evidence: `packages/python/src/algeria_geo/map.py`)
- Library Caller → Boundary GeoJSON: can consume polygons (evidence: `README.md`)
