@kadown/types 0.1.0

package/LICENSE

@@ -0,0 +1,19 @@
+ISC License
+
+Copyright 2025 Pho Thin Maung<phothinmg@disroot.org>
+
+Permission to use, copy, modify, and/or distribute 
+this software for any purpose with or without fee is 
+hereby granted, provided that the above copyright 
+notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR 
+DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE 
+INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY 
+AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE 
+FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL 
+DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS 
+OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF 
+CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING 
+OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF 
+THIS SOFTWARE.

package/README.md

@@ -0,0 +1,8 @@
+<div align="center">
+<img src="https://raw.githubusercontent.com/phothinmg/types/main/kadown.svg" width="160" height="160">
+<h1>Kadown</h1>
+</div>
+
+### Type Definitions for geojson
+
+These definitions are focus for geojson data of Myanmar, that provided by [Myanmar Information Management Unit(MIMU)](https://geonode.themimu.info/).

package/index.d.ts

@@ -0,0 +1,208 @@
+import {
+  SNR_Names,
+  SNR_Types,
+  SAD_SAZ_Ethnic_Group,
+  SAD_SAZ_Names,
+  District_Names,
+} from "./lib/admdiv";
+import { Geo_Properties } from "./lib/properties";
+
+/**
+ * Type Definitions for `geojson`
+ *
+ * These definitions are focus for geojson data of Myanmar, that provided by Myanmar Information Management Unit(MIMU).
+ *
+ * @see https://geonode.themimu.info/
+ */
+export as namespace GeoDataJson;
+
+/** Coordinates */
+export type Coord = number[];
+
+/**
+ * Administrative division names of Myanmar (First level)
+ *
+ * - 2 sub-region in Bago and 3 sub-state in Shan
+ */
+export type SNRNames = SNR_Names;
+/**
+ * Administrative divisions of Myanmar (First level)
+ */
+export type SNRTypes = SNR_Types;
+/**
+ * Names of Ethnic Group , SAD or SAZ
+ */
+export type SAD_SAZ_EthnicGroup = SAD_SAZ_Ethnic_Group;
+/**
+ * Administrative divisions of Myanmar (Sub-first level && Second level)
+ *
+ * Self-Administered Division(SAD) - Sub-first level
+ *
+ * Self-Administered Zone(SAZ) - Second level
+ */
+export type SAD_SAZNames = SAD_SAZ_Names;
+/** Names of  District */
+export type DistrictNames = District_Names;
+/**
+ * Geodata properties , base on https://geonode.themimu.info/
+ */
+export type GeoProperties = Geo_Properties;
+/**
+ * Coordinate Reference System
+ *
+ * No "crs" Member Required: It is not necessary to include a "crs"
+ * member in the JSON structure because the WGS 84 standard is assumed by default.
+ */
+export type CRS = {
+  type: "name";
+  properties: {
+    name: string;
+  };
+};
+/**
+ * Geometry types `Point`
+ *
+ * @see https://geojson.org/
+ */
+export type Point = {
+  type: "Point";
+  coordinates: Coord;
+};
+/**
+ * Geometry types `MultiPoint`
+ *
+ * @see https://geojson.org/
+ */
+export type MultiPoint = {
+  type: "MultiPoint";
+  coordinates: Coord[];
+};
+/**
+ * Geometry types `LineString`
+ *
+ * @see https://geojson.org/
+ */
+export type LineString = {
+  type: "LineString";
+  coordinates: Coord[];
+};
+/**
+ * Geometry types `MultiLineString`
+ *
+ * @see https://geojson.org/
+ */
+export type MultiLineString = {
+  type: "MultiLineString";
+  coordinates: Coord[][];
+};
+/**
+ * Geometry types `Polygon`
+ *
+ * @see https://geojson.org/
+ */
+export type Polygon = {
+  type: "Polygon";
+  coordinates: Coord[][];
+};
+/**
+ * Geometry types `MultiPolygon`
+ *
+ * @see https://geojson.org/
+ */
+export type MultiPolygon = {
+  type: "MultiPolygon";
+  coordinates: Coord[][][];
+};
+/**
+ * Group of Main(6) Geometric objects
+ *
+ * The GeoJSON Specification (RFC 7946)
+ *
+ * 1. Point
+ * 2. MultiPoint
+ * 3. LineString
+ * 4. MultiLineString
+ * 5. Polygon
+ * 6. MultiPolygon
+ *
+ * @see https://datatracker.ietf.org/doc/html/rfc7946
+ */
+export type GeometricObjects =
+  | Point
+  | MultiPoint
+  | LineString
+  | MultiLineString
+  | Polygon
+  | MultiPolygon;
+/**
+ * Group of Main(3) Multi Geometric objects
+ *
+ * 1. MultiLineString
+ * 2. Polygon
+ * 3. MultiPolygon
+ *
+ * @see https://datatracker.ietf.org/doc/html/rfc7946
+ */
+export type GeometricObjectMulti = MultiPoint | MultiLineString | MultiPolygon;
+/**
+ * Group of Main(3) Single Geometric objects
+ *
+ * 1. Point
+ * 2. MultiPoint
+ * 3. LineString
+ *
+ * @see https://datatracker.ietf.org/doc/html/rfc7946
+ */
+export type GeometricObjectSingle = Point | LineString | Polygon;
+/**
+ * Geometry Collection Object
+ *
+ * A `GeometryCollection` in GeoJSON is a single geometry object that can group multiple,
+ * potentially different, geometry types (like a Point and a LineString) into a single unit.
+ * This is unlike other "Multi" geometries (e.g., MultiPoint, MultiPolygon) which can only
+ * contain homogeneous collections of a single type.
+ *
+ *  @see https://datatracker.ietf.org/doc/html/rfc7946
+ */
+export type GeometryCollection = {
+  type: "GeometryCollection";
+  geometries: GeometricObjects[];
+};
+/**
+ * Feature Object (additional Geometric object)
+ *
+ * @see https://geojson.org/
+ */
+export type GeoFeature = {
+  type: "Feature";
+  geometry: GeometricObjects | GeometryCollection;
+  id: string | number;
+  properties: GeoProperties;
+  geometry_name: "the_geom";
+};
+/**
+ * Feature Collection object
+ *
+ * Set of Feature Objects
+ *
+ * @see https://geojson.org/
+ */
+export type GeoFeatureCollection = {
+  type: "FeatureCollection";
+  totalFeatures: number;
+  features: GeoFeature[];
+  crs: CRS;
+};
+/**
+ * Group of :
+ *
+ * 1. Geometric Objects
+ * 2. Geometry Collection Object
+ * 3. Feature Object
+ * 4. Feature Collection Object
+ */
+export type GeoJsonObject =
+  | GeometricObjects
+  | GeometryCollection
+  | GeoFeature
+  | GeoFeatureCollection;

package/index.js

@@ -0,0 +1,12 @@
+const geometryTypeSingle = ["Point", "Polygon", "LineString"];
+const geometryTypeMulti = ["MultiPoint", "MultiPolygon", "MultiLineString"];
+const geometryTypes = [
+  "Point",
+  "Polygon",
+  "LineString",
+  "MultiPoint",
+  "MultiPolygon",
+  "MultiLineString",
+];
+
+export { geometryTypeMulti, geometryTypeSingle, geometryTypes };

package/lib/admdiv.ts

@@ -0,0 +1,133 @@
+/**
+ * Administrative division names of Myanmar (First level)
+ *
+ * - 2 sub-region in Bago and 3 sub-state in Shan
+ */
+export type SNR_Names =
+  | "Ayeyarwady"
+  | "Bago"
+  | "Chin"
+  | "Kachin"
+  | "Kayah"
+  | "Kayin"
+  | "Magway"
+  | "Mandalay"
+  | "Mon"
+  | "Nay Pyi Taw"
+  | "Rakhine"
+  | "Sagaing"
+  | "Shan"
+  | "Tanintharyi"
+  | "Yangon"
+  | "Bago (East)"
+  | "Bago (West)"
+  | "Shan (East)"
+  | "Shan (North)"
+  | "Shan (South)"
+  | "Shan State (South)"
+  | "Shan State (North)";
+/**
+ * Administrative divisions of Myanmar (First level)
+ */
+export type SNR_Types = "Region" | "State" | "Union Territory";
+/**
+ * Administrative divisions of Myanmar (Sub-first level && Second level)
+ *
+ * Self-Administered Division(SAD) - Sub-first level
+ *
+ * Self-Administered Zone(SAZ) - Second level
+ */
+export type SAD_SAZ_Names =
+  | "Danu Self-Administered Zone"
+  | "Pa-O Self-Administered Zone"
+  | "Naga Self-Administered Zone"
+  | "Wa Self-Administered Division"
+  | "Kokang Self-Administered Zone"
+  | "Pa Laung Self-Administered Zone";
+/**
+ * Names of Ethnic Group , SAD or SAZ
+ */
+export type SAD_SAZ_Ethnic_Group =
+  | "Danu"
+  | "Pa-O"
+  | "Naga"
+  | "Wa"
+  | "Kokang"
+  | "Pa Laung";
+
+export type District_Names =
+  | "Hinthada"
+  | "Labutta"
+  | "Maubin"
+  | "Myaungmya"
+  | "Pathein"
+  | "Pyapon"
+  | "Bago"
+  | "Taungoo"
+  | "Pyay"
+  | "Thayarwady"
+  | "Falam"
+  | "Hakha"
+  | "Matupi"
+  | "Mindat"
+  | "Bhamo"
+  | "Mohnyin"
+  | "Myitkyina"
+  | "Puta-O"
+  | "Bawlake"
+  | "Loikaw"
+  | "Hpa-An"
+  | "Hpapun"
+  | "Kawkareik"
+  | "Myawaddy"
+  | "Gangaw"
+  | "Magway"
+  | "Minbu"
+  | "Pakokku"
+  | "Thayet"
+  | "Kyaukse"
+  | "Kawlin"
+  | "Mawlaik"
+  | "Monywa"
+  | "Sagaing"
+  | "Tamu"
+  | "Yinmarbin"
+  | "Kengtung"
+  | "Monghsat"
+  | "Tachileik"
+  | "Hopang"
+  | "Kyaukme"
+  | "Lashio"
+  | "Matman"
+  | "Mongmit"
+  | "Muse"
+  | "Langkho"
+  | "Loilen"
+  | "Taunggyi"
+  | "Dawei"
+  | "Kawthoung"
+  | "Myeik"
+  | "Yangon (East)"
+  | "Yangon (North)"
+  | "Yangon (South)"
+  | "Yangon (West)"
+  | "Mandalay"
+  | "Meiktila"
+  | "Myingyan"
+  | "Nyaung-U"
+  | "Pyinoolwin"
+  | "Yamethin"
+  | "Mawlamyine"
+  | "Thaton"
+  | "Det Khi Na"
+  | "Oke Ta Ra"
+  | "Kyaukpyu"
+  | "Maungdaw"
+  | "Mrauk-U"
+  | "Sittwe"
+  | "Thandwe"
+  | "Kale"
+  | "Kanbalu"
+  | "Katha"
+  | "Shwebo"
+  | "Hkamti";

package/lib/properties.ts

@@ -0,0 +1,106 @@
+import {
+  SNR_Names,
+  SNR_Types,
+  SAD_SAZ_Ethnic_Group,
+  SAD_SAZ_Names,
+  District_Names,
+} from "./admdiv";
+
+export interface Geo_Properties {
+  /**
+   * Version of Place codes (Pcodes)
+   *
+   * @see{https://themimu.info/place-codes}
+   */
+  PCode_V: number;
+  /** State and Region Names */
+  ST?: SNR_Names;
+  /** State and Region Names in Myanmar*/
+  ST_MMR?: string;
+  /** Pcode for State and Region */
+  ST_PCODE?: string;
+  /** Administrative division types */
+  ST_RG?: SNR_Types;
+  /**
+   * Names
+   *
+   * 1. District
+   * 2. Self-Administered Division(SAD)
+   * 3. Self-Administered Zone(SAZ)
+   */
+  DT?: SAD_SAZ_Names | District_Names;
+  /**
+   * Names in Myanmar
+   *
+   * 1. District
+   * 2. Self-Administered Division(SAD)
+   * 3. Self-Administered Zone(SAZ)
+   */
+  DT_MMR?: string;
+  /** Pcodes */
+  DT_PCODE?: string;
+  /** */
+  OBJECTID?: number;
+  /**
+   * Names
+   *
+   * 1. Self-Administered Division(SAD)
+   * 2. Self-Administered Zone(SAZ)
+   */
+  SAD_SAZ?: SAD_SAZ_Names;
+  /**
+   * Names in Burmese
+   *
+   * 1. Self-Administered Division(SAD)
+   * 2. Self-Administered Zone(SAZ)
+   */
+  SAZ_D_MMR?: string;
+  /**
+   * Names of Athnic Group , SAD or SAZ
+   */
+  SELF_ADMIN?: SAD_SAZ_Ethnic_Group;
+  /** Pcodes */
+  SAZ_PCODE?: string;
+  /** State and Region Names */
+  ST_2?: SNR_Names;
+  /** Names of Township */
+  TS?: string;
+  /** Names of Township in Burmese */
+  TS_MMR?: string;
+  /** Pcodes for Township*/
+  TS_PCODE?: string;
+  // Town and Ward
+  /** Names of Town */
+  TOWN?: string;
+  /** Pcodes of Town */
+  TOWN_PCODE?: string;
+  /** Names of Ward */
+  WARD?: string;
+  /** Names of Ward in Burmese */
+  WARD_MMR?: string;
+  /** Pcodes of Ward */
+  WARD_PCODE?: string;
+  /** */
+  SOURCE?: string;
+  /** */
+  REMARK?: string;
+  // ===
+  /** Names of Village Tract */
+  VT?: string;
+  /** Pcodes of Village Tract */
+  VT_PCODE?: string;
+  /** Names of Village */
+  VILLAGE?: string;
+  /** Names of Village in Burmese */
+  VLG_MMR?: string;
+  /** Pcodes of Village */
+  VLG_PCODE?: string | number;
+  /** Alt Names of Village */
+  ALTVLG_ENG?: string;
+  /** Alt Names of Village in Burmese */
+  ALTVLG_MMR?: string;
+  /** Longitude for Village */
+  Longitude?: number;
+  /** Latitude for Village */
+  Latitude?: number;
+}

package/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "@kadown/types",
+  "version": "0.1.0",
+  "description": "Type Definitions for geojson",
+  "types": "./index.d.ts",
+  "module": "index.js",
+  "keywords": [],
+  "author": {
+    "name": "Pho Thin Mg",
+    "email": "phothinmg@disroot.org",
+    "url": "https://phothinmg.github.io/"
+  },
+  "type": "module",
+  "license": "ISC",
+  "devDependencies": {
+    "@types/node": "^25.0.3",
+    "typescript": "^5.9.3"
+  },
+  "files": [
+    "package.json",
+    "README.md",
+    "LICENSE",
+    "index.js",
+    "index.d.ts",
+    "lib/**/*"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/phothinmg/types.git"
+  },
+  "exports": {
+    ".": {
+      "import": "./index.js",
+      "types": "./index.d.ts"
+    }
+  }
+}