@pranamphd/digipin 0.1.0-alpha.1

package/LICENSE

@@ -0,0 +1,176 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

package/README.md

@@ -0,0 +1,49 @@
+# digipin-ts
+
+DIGIPIN (Digital Postal Index Number) is a national-level, geo-coded addressing grid developed by the **Department of Posts, Ministry of Communications, Government of India**. It provides a deterministic and reversible method to represent geographic locations in India using a **10-character alphanumeric code derived from latitude and longitude**.
+
+This repository contains a **TypeScript implementation of the DIGIPIN algorithm**, intended to enable consistent and correct adoption across platforms, applications, and systems.
+
+![DIGIPIN Logo](/digipin-social-preview.png)
+
+## What this repository provides
+
+- Deterministic conversion from **latitude / longitude → DIGIPIN**
+- Reversible conversion from **DIGIPIN → geographic coordinates**
+- Comprehensive tests to ensure correctness
+- Implementation aligned with the **final DIGIPIN Technical Specification (March 2025)**
+
+---
+
+## Specification reference
+
+This project implements the **DIGIPIN (Digital Postal Index Number)** algorithm strictly according to the official technical specification published by the **Department of Posts, Ministry of Communications, Government of India**.
+
+The authoritative specification is available at:
+[https://www.indiapost.gov.in/digipin](https://www.indiapost.gov.in/digipin)
+
+All implementations in this repository aim to faithfully reproduce the behavior described in the final DIGIPIN Technical Document (March 2025).
+
+> This repository provides an independent implementation of the DIGIPIN specification and is not an official distribution of the Department of Posts unless explicitly stated otherwise.
+
+---
+
+## Design principles
+
+- **Specification-first**: Implementation strictly follows the DIGIPIN technical specification.
+- **Deterministic**: The same input always produces the same output, regardless of language or platform.
+- **No external dependencies**: Core logic is self-contained.
+
+---
+
+## Status
+
+This repository is under active development.
+The library interfaces (function and type signatures) may evolve until the first stable release (`v1.0.0`).
+
+---
+
+## License
+
+This project is licensed under the **Apache License, Version 2.0**.
+See the [LICENSE](LICENSE) file for details.

package/dist/constants.d.ts

@@ -0,0 +1,96 @@
+/**
+ * Copyright (c) 2026 Pranam
+ * ORCID: https://orcid.org/0009-0007-9316-3616
+ *
+ * This code is licensed under the Apache License, Version 2.0.
+ *
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * QR Code:
+ * ![QR Code](/ORCID.png)
+ * Scan the QR code to access my ORCID profile.
+ */
+/**
+ * Geodetic coordinate limits (WGS-84 compatible).
+ *
+ * These constants define the full valid range of latitude and longitude
+ * values supported by the WGS-84 coordinate reference system.
+ */
+/**
+ *  Minimum latitude for geodetic coordinates
+ */
+export declare const GEODETIC_LATITUDE_MIN: number;
+/**
+ * Maximum latitude for geodetic coordinates
+ */
+export declare const GEODETIC_LATITUDE_MAX: number;
+/**
+ * Minimum longitude for geodetic coordinates
+ */
+export declare const GEODETIC_LONGITUDE_MIN: number;
+/**
+ * Maximum longitude for geodetic coordinates
+ */
+export declare const GEODETIC_LONGITUDE_MAX: number;
+/**
+ * Official DIGIPIN supported territory bounds.
+ *
+ * Only geographic coordinates within these bounds are valid inputs
+ * for DIGIPIN encoding.
+ */
+/** Minimum latitude for DIGIPIN supported territory */
+export declare const DIGIPIN_LATITUDE_MIN: number;
+/** Maximum latitude for DIGIPIN supported territory */
+export declare const DIGIPIN_LATITUDE_MAX: number;
+/** Minimum longitude for DIGIPIN supported territory */
+export declare const DIGIPIN_LONGITUDE_MIN: number;
+/** Maximum longitude for DIGIPIN supported territory */
+export declare const DIGIPIN_LONGITUDE_MAX: number;
+/**
+ * Official DIGIPIN symbol set (base-16).
+ *
+ * The order of symbols is significant and MUST NOT be changed.
+ * This array represents the canonical DIGIPIN symbol sequence
+ * as defined by the specification.
+ */
+/**
+ * Flattened array of valid DIGIPIN symbols.
+ */
+export declare const DIGIPIN_SYMBOLS: readonly string[];
+/**
+ * Length of a DIGIPIN code in characters.
+ */
+export declare const DIGIPIN_LENGTH: number;
+/**
+ * Size of the DIGIPIN grid along one axis.
+ *
+ * DIGIPIN uses a fixed 4 × 4 hierarchical grid at each level.
+ */
+export declare const DIGIPIN_GRID_SIZE: number;
+/**
+ * 2D array representing the DIGIPIN label grid.
+ *
+ * This grid defines the mapping between grid cell indices and
+ * DIGIPIN symbols.
+ *
+ * - Row index corresponds to latitude subdivision (south → north)
+ * - Column index corresponds to longitude subdivision (west → east)
+ *
+ * The structure and ordering match the official specification.
+ */
+export declare const DIGIPIN_LABEL_GRID: readonly (readonly string[])[];
+/**
+ * Maximum possible positional error after DIGIPIN decoding, in degrees.
+ *
+ * This value is derived from the specification:
+ *   36° / 4¹⁰ / 2
+ *
+ * It represents the maximum deviation between the decoded centroid
+ * and any point within the corresponding DIGIPIN grid cell.
+ *
+ * This constant is primarily intended for testing and conformance checks.
+ */
+export declare const DIGIPIN_MAX_DECODE_ERROR_DEGREES: number;
+//# sourceMappingURL=constants.d.ts.map

package/dist/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAEH;;;;;GAKG;AAEH;;GAEG;AACH,eAAO,MAAM,qBAAqB,EAAE,MAAY,CAAC;AACjD;;GAEG;AACH,eAAO,MAAM,qBAAqB,EAAE,MAAW,CAAC;AAChD;;GAEG;AACH,eAAO,MAAM,sBAAsB,EAAE,MAAa,CAAC;AACnD;;GAEG;AACH,eAAO,MAAM,sBAAsB,EAAE,MAAY,CAAC;AAGlD;;;;;GAKG;AAEH,uDAAuD;AACvD,eAAO,MAAM,oBAAoB,EAAE,MAAY,CAAC;AAChD,uDAAuD;AACvD,eAAO,MAAM,oBAAoB,EAAE,MAAa,CAAC;AACjD,wDAAwD;AACxD,eAAO,MAAM,qBAAqB,EAAE,MAAa,CAAC;AAClD,wDAAwD;AACxD,eAAO,MAAM,qBAAqB,EAAE,MAAa,CAAC;AAElD;;;;;;GAMG;AAEH;;GAEG;AACH,eAAO,MAAM,eAAe,EAAE,SAAS,MAAM,EAiB5C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,cAAc,EAAE,MAAW,CAAC;AAEzC;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,EAAE,MAAU,CAAC;AAE3C;;;;;;;;;;GAUG;AACH,eAAO,MAAM,kBAAkB,EAAE,SAAS,CAAC,SAAS,MAAM,EAAE,CAAC,EAK5D,CAAC;AAEF;;;;;;;;;;GAUG;AACH,eAAO,MAAM,gCAAgC,EAAE,MAA8B,CAAC"}

package/dist/constants.js

@@ -0,0 +1,118 @@
+/**
+ * Copyright (c) 2026 Pranam
+ * ORCID: https://orcid.org/0009-0007-9316-3616
+ *
+ * This code is licensed under the Apache License, Version 2.0.
+ *
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * QR Code:
+ * ![QR Code](/ORCID.png)
+ * Scan the QR code to access my ORCID profile.
+ */
+/**
+ * Geodetic coordinate limits (WGS-84 compatible).
+ *
+ * These constants define the full valid range of latitude and longitude
+ * values supported by the WGS-84 coordinate reference system.
+ */
+/**
+ *  Minimum latitude for geodetic coordinates
+ */
+export const GEODETIC_LATITUDE_MIN = -90;
+/**
+ * Maximum latitude for geodetic coordinates
+ */
+export const GEODETIC_LATITUDE_MAX = 90;
+/**
+ * Minimum longitude for geodetic coordinates
+ */
+export const GEODETIC_LONGITUDE_MIN = -180;
+/**
+ * Maximum longitude for geodetic coordinates
+ */
+export const GEODETIC_LONGITUDE_MAX = 180;
+/**
+ * Official DIGIPIN supported territory bounds.
+ *
+ * Only geographic coordinates within these bounds are valid inputs
+ * for DIGIPIN encoding.
+ */
+/** Minimum latitude for DIGIPIN supported territory */
+export const DIGIPIN_LATITUDE_MIN = 2.5;
+/** Maximum latitude for DIGIPIN supported territory */
+export const DIGIPIN_LATITUDE_MAX = 38.5;
+/** Minimum longitude for DIGIPIN supported territory */
+export const DIGIPIN_LONGITUDE_MIN = 63.5;
+/** Maximum longitude for DIGIPIN supported territory */
+export const DIGIPIN_LONGITUDE_MAX = 99.5;
+/**
+ * Official DIGIPIN symbol set (base-16).
+ *
+ * The order of symbols is significant and MUST NOT be changed.
+ * This array represents the canonical DIGIPIN symbol sequence
+ * as defined by the specification.
+ */
+/**
+ * Flattened array of valid DIGIPIN symbols.
+ */
+export const DIGIPIN_SYMBOLS = [
+    "F",
+    "C",
+    "9",
+    "8",
+    "J",
+    "3",
+    "2",
+    "7",
+    "K",
+    "4",
+    "5",
+    "6",
+    "L",
+    "M",
+    "P",
+    "T",
+];
+/**
+ * Length of a DIGIPIN code in characters.
+ */
+export const DIGIPIN_LENGTH = 10;
+/**
+ * Size of the DIGIPIN grid along one axis.
+ *
+ * DIGIPIN uses a fixed 4 × 4 hierarchical grid at each level.
+ */
+export const DIGIPIN_GRID_SIZE = 4;
+/**
+ * 2D array representing the DIGIPIN label grid.
+ *
+ * This grid defines the mapping between grid cell indices and
+ * DIGIPIN symbols.
+ *
+ * - Row index corresponds to latitude subdivision (south → north)
+ * - Column index corresponds to longitude subdivision (west → east)
+ *
+ * The structure and ordering match the official specification.
+ */
+export const DIGIPIN_LABEL_GRID = [
+    ["F", "C", "9", "8"],
+    ["J", "3", "2", "7"],
+    ["K", "4", "5", "6"],
+    ["L", "M", "P", "T"],
+];
+/**
+ * Maximum possible positional error after DIGIPIN decoding, in degrees.
+ *
+ * This value is derived from the specification:
+ *   36° / 4¹⁰ / 2
+ *
+ * It represents the maximum deviation between the decoded centroid
+ * and any point within the corresponding DIGIPIN grid cell.
+ *
+ * This constant is primarily intended for testing and conformance checks.
+ */
+export const DIGIPIN_MAX_DECODE_ERROR_DEGREES = 0.0000171661376953125;
+//# sourceMappingURL=constants.js.map

package/dist/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAEH;;;;;GAKG;AAEH;;GAEG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAW,CAAC,EAAE,CAAC;AACjD;;GAEG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAW,EAAE,CAAC;AAChD;;GAEG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAW,CAAC,GAAG,CAAC;AACnD;;GAEG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAW,GAAG,CAAC;AAGlD;;;;;GAKG;AAEH,uDAAuD;AACvD,MAAM,CAAC,MAAM,oBAAoB,GAAW,GAAG,CAAC;AAChD,uDAAuD;AACvD,MAAM,CAAC,MAAM,oBAAoB,GAAW,IAAI,CAAC;AACjD,wDAAwD;AACxD,MAAM,CAAC,MAAM,qBAAqB,GAAW,IAAI,CAAC;AAClD,wDAAwD;AACxD,MAAM,CAAC,MAAM,qBAAqB,GAAW,IAAI,CAAC;AAElD;;;;;;GAMG;AAEH;;GAEG;AACH,MAAM,CAAC,MAAM,eAAe,GAAsB;IAChD,GAAG;IACH,GAAG;IACH,GAAG;IACH,GAAG;IACH,GAAG;IACH,GAAG;IACH,GAAG;IACH,GAAG;IACH,GAAG;IACH,GAAG;IACH,GAAG;IACH,GAAG;IACH,GAAG;IACH,GAAG;IACH,GAAG;IACH,GAAG;CACJ,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,cAAc,GAAW,EAAE,CAAC;AAEzC;;;;GAIG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAW,CAAC,CAAC;AAE3C;;;;;;;;;;GAUG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAmC;IAChE,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC;IACpB,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC;IACpB,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC;IACpB,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC;CACrB,CAAC;AAEF;;;;;;;;;;GAUG;AACH,MAAM,CAAC,MAAM,gCAAgC,GAAW,qBAAqB,CAAC"}

package/dist/decode.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Copyright (c) 2026 Pranam
+ * ORCID: https://orcid.org/0009-0007-9316-3616
+ *
+ * This code is licensed under the Apache License, Version 2.0.
+ *
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * QR Code:
+ * ![QR Code](/ORCID.png)
+ * Scan the QR code to access my ORCID profile.
+ */
+import type { Location } from "./location.js";
+/**
+ * Decodes a DIGIPIN into geodetic coordinates.
+ *
+ * @param digipin - DIGIPIN string (separators allowed)
+ * @returns The geodetic coordinates of the DIGIPIN
+ * @throws Error if the DIGIPIN is invalid
+ */
+export declare function decode(digipin: string): Location;
+//# sourceMappingURL=decode.d.ts.map

package/dist/decode.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"decode.d.ts","sourceRoot":"","sources":["../src/decode.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAYH,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAmB9C;;;;;;GAMG;AACH,wBAAgB,MAAM,CAAC,OAAO,EAAE,MAAM,GAAG,QAAQ,CAkChD"}

package/dist/decode.js

@@ -0,0 +1,58 @@
+/**
+ * Copyright (c) 2026 Pranam
+ * ORCID: https://orcid.org/0009-0007-9316-3616
+ *
+ * This code is licensed under the Apache License, Version 2.0.
+ *
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * QR Code:
+ * ![QR Code](/ORCID.png)
+ * Scan the QR code to access my ORCID profile.
+ */
+import { DIGIPIN_GRID_SIZE, DIGIPIN_LABEL_GRID, DIGIPIN_LATITUDE_MIN, DIGIPIN_LATITUDE_MAX, DIGIPIN_LONGITUDE_MIN, DIGIPIN_LONGITUDE_MAX, } from "./constants.js";
+import { DigipinError } from "./errors.js";
+import { normalize } from "./normalize.js";
+import { validateDigipinFormat } from "./validation.js";
+/**
+ * Mapping from DIGIPIN symbol to its grid position.
+ *
+ * Key: DIGIPIN symbol
+ * Value: [row, column]
+ */
+const DIGIPIN_SYMBOL_POSITION_MAP = new Map(DIGIPIN_LABEL_GRID.flatMap((row, rowIndex) => row.map((symbol, columnIndex) => [symbol, [rowIndex, columnIndex]])));
+/**
+ * Decodes a DIGIPIN into geodetic coordinates.
+ *
+ * @param digipin - DIGIPIN string (separators allowed)
+ * @returns The geodetic coordinates of the DIGIPIN
+ * @throws Error if the DIGIPIN is invalid
+ */
+export function decode(digipin) {
+    const normalized = normalize(digipin);
+    validateDigipinFormat(normalized);
+    let latitudeMin = DIGIPIN_LATITUDE_MIN;
+    let latitudeMax = DIGIPIN_LATITUDE_MAX;
+    let longitudeMin = DIGIPIN_LONGITUDE_MIN;
+    let longitudeMax = DIGIPIN_LONGITUDE_MAX;
+    for (const symbol of normalized) {
+        const position = DIGIPIN_SYMBOL_POSITION_MAP.get(symbol);
+        if (position === undefined) {
+            throw DigipinError.invalidDigipinFormat();
+        }
+        const [row, column] = position;
+        const latitudeStep = (latitudeMax - latitudeMin) / DIGIPIN_GRID_SIZE;
+        const longitudeStep = (longitudeMax - longitudeMin) / DIGIPIN_GRID_SIZE;
+        latitudeMax -= row * latitudeStep;
+        latitudeMin = latitudeMax - latitudeStep;
+        longitudeMin += column * longitudeStep;
+        longitudeMax = longitudeMin + longitudeStep;
+    }
+    return {
+        latitude: (latitudeMin + latitudeMax) / 2,
+        longitude: (longitudeMin + longitudeMax) / 2,
+    };
+}
+//# sourceMappingURL=decode.js.map

package/dist/decode.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"decode.js","sourceRoot":"","sources":["../src/decode.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAEH,OAAO,EACL,iBAAiB,EACjB,kBAAkB,EAClB,oBAAoB,EACpB,oBAAoB,EACpB,qBAAqB,EACrB,qBAAqB,GACtB,MAAM,gBAAgB,CAAC;AAExB,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAE3C,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,qBAAqB,EAAE,MAAM,iBAAiB,CAAC;AAExD;;;;;GAKG;AACH,MAAM,2BAA2B,GAG7B,IAAI,GAAG,CACT,kBAAkB,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,QAAQ,EAAE,EAAE,CAC3C,GAAG,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,WAAW,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAU,CAAC,CAC7E,CACF,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,UAAU,MAAM,CAAC,OAAe;IACpC,MAAM,UAAU,GAAW,SAAS,CAAC,OAAO,CAAC,CAAC;IAC9C,qBAAqB,CAAC,UAAU,CAAC,CAAC;IAElC,IAAI,WAAW,GAAW,oBAAoB,CAAC;IAC/C,IAAI,WAAW,GAAW,oBAAoB,CAAC;IAC/C,IAAI,YAAY,GAAW,qBAAqB,CAAC;IACjD,IAAI,YAAY,GAAW,qBAAqB,CAAC;IAEjD,KAAK,MAAM,MAAM,IAAI,UAAU,EAAE,CAAC;QAChC,MAAM,QAAQ,GAAG,2BAA2B,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QAEzD,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;YAC3B,MAAM,YAAY,CAAC,oBAAoB,EAAE,CAAC;QAC5C,CAAC;QAED,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,GAAG,QAAQ,CAAC;QAE/B,MAAM,YAAY,GAChB,CAAC,WAAW,GAAG,WAAW,CAAC,GAAG,iBAAiB,CAAC;QAClD,MAAM,aAAa,GACjB,CAAC,YAAY,GAAG,YAAY,CAAC,GAAG,iBAAiB,CAAC;QAEpD,WAAW,IAAI,GAAG,GAAG,YAAY,CAAC;QAClC,WAAW,GAAG,WAAW,GAAG,YAAY,CAAC;QAEzC,YAAY,IAAI,MAAM,GAAG,aAAa,CAAC;QACvC,YAAY,GAAG,YAAY,GAAG,aAAa,CAAC;IAC9C,CAAC;IAED,OAAO;QACL,QAAQ,EAAE,CAAC,WAAW,GAAG,WAAW,CAAC,GAAG,CAAC;QACzC,SAAS,EAAE,CAAC,YAAY,GAAG,YAAY,CAAC,GAAG,CAAC;KAC7C,CAAC;AACJ,CAAC"}

package/dist/encode.d.ts

@@ -0,0 +1,30 @@
+/**
+ * Copyright (c) 2026 Pranam
+ * ORCID: https://orcid.org/0009-0007-9316-3616
+ *
+ * This code is licensed under the Apache License, Version 2.0.
+ *
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * QR Code:
+ * ![QR Code](/ORCID.png)
+ * Scan the QR code to access my ORCID profile.
+ */
+import type { Location } from "./location.js";
+/**
+ * Encode geographic coordinates into a canonical DIGIPIN.
+ *
+ * This function implements the official DIGIPIN hierarchical 4 × 4 grid
+ * encoding algorithm exactly as defined by the specification.
+ *
+ * The returned DIGIPIN contains no separators and is always
+ * exactly DIGIPIN_LENGTH characters long.
+ *
+ * @param location - Geographic location containing latitude and longitude
+ * @returns Encoded DIGIPIN string
+ * @throws Error if the geodetic coordinates are invalid or if the location is outside the supported territory
+ */
+export declare function encode(location: Location): string;
+//# sourceMappingURL=encode.d.ts.map

package/dist/encode.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"encode.d.ts","sourceRoot":"","sources":["../src/encode.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAiBH,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAY9C;;;;;;;;;;;;GAYG;AACH,wBAAgB,MAAM,CAAC,QAAQ,EAAE,QAAQ,GAAG,MAAM,CA0CjD"}

package/dist/encode.js

@@ -0,0 +1,62 @@
+/**
+ * Copyright (c) 2026 Pranam
+ * ORCID: https://orcid.org/0009-0007-9316-3616
+ *
+ * This code is licensed under the Apache License, Version 2.0.
+ *
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * QR Code:
+ * ![QR Code](/ORCID.png)
+ * Scan the QR code to access my ORCID profile.
+ */
+import { DIGIPIN_LATITUDE_MIN, DIGIPIN_LATITUDE_MAX, DIGIPIN_LONGITUDE_MIN, DIGIPIN_LONGITUDE_MAX, DIGIPIN_GRID_SIZE, DIGIPIN_LENGTH, DIGIPIN_LABEL_GRID, } from "./constants.js";
+import { validateGeodeticCoordinates, validateDigipinTerritory, } from "./validation.js";
+function getSymbolAt(row, column) {
+    const symbol = DIGIPIN_LABEL_GRID[row]?.[column];
+    if (symbol === undefined) {
+        throw new Error("Internal DIGIPIN grid invariant violated.");
+    }
+    return symbol;
+}
+/**
+ * Encode geographic coordinates into a canonical DIGIPIN.
+ *
+ * This function implements the official DIGIPIN hierarchical 4 × 4 grid
+ * encoding algorithm exactly as defined by the specification.
+ *
+ * The returned DIGIPIN contains no separators and is always
+ * exactly DIGIPIN_LENGTH characters long.
+ *
+ * @param location - Geographic location containing latitude and longitude
+ * @returns Encoded DIGIPIN string
+ * @throws Error if the geodetic coordinates are invalid or if the location is outside the supported territory
+ */
+export function encode(location) {
+    validateGeodeticCoordinates(location);
+    validateDigipinTerritory(location);
+    let latitudeMin = DIGIPIN_LATITUDE_MIN;
+    let latitudeMax = DIGIPIN_LATITUDE_MAX;
+    let longitudeMin = DIGIPIN_LONGITUDE_MIN;
+    let longitudeMax = DIGIPIN_LONGITUDE_MAX;
+    let digipin = "";
+    for (let level = 0; level < DIGIPIN_LENGTH; level++) {
+        const latitudeStep = (latitudeMax - latitudeMin) / DIGIPIN_GRID_SIZE;
+        const longitudeStep = (longitudeMax - longitudeMin) / DIGIPIN_GRID_SIZE;
+        let rowIndex = Math.floor((latitudeMax - location.latitude) / latitudeStep);
+        let columnIndex = Math.floor((location.longitude - longitudeMin) / longitudeStep);
+        // Clamp row and column indices to valid grid bounds
+        rowIndex = Math.min(rowIndex, DIGIPIN_GRID_SIZE - 1);
+        columnIndex = Math.min(columnIndex, DIGIPIN_GRID_SIZE - 1);
+        const symbol = getSymbolAt(rowIndex, columnIndex);
+        digipin += symbol;
+        latitudeMax -= rowIndex * latitudeStep;
+        latitudeMin = latitudeMax - latitudeStep;
+        longitudeMin += columnIndex * longitudeStep;
+        longitudeMax = longitudeMin + longitudeStep;
+    }
+    return digipin;
+}
+//# sourceMappingURL=encode.js.map

package/dist/encode.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"encode.js","sourceRoot":"","sources":["../src/encode.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAEH,OAAO,EACL,oBAAoB,EACpB,oBAAoB,EACpB,qBAAqB,EACrB,qBAAqB,EACrB,iBAAiB,EACjB,cAAc,EACd,kBAAkB,GACnB,MAAM,gBAAgB,CAAC;AAExB,OAAO,EACL,2BAA2B,EAC3B,wBAAwB,GACzB,MAAM,iBAAiB,CAAC;AAIzB,SAAS,WAAW,CAAC,GAAW,EAAE,MAAc;IAC9C,MAAM,MAAM,GAAG,kBAAkB,CAAC,GAAG,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC;IAEjD,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QACzB,MAAM,IAAI,KAAK,CAAC,2CAA2C,CAAC,CAAC;IAC/D,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,MAAM,CAAC,QAAkB;IACvC,2BAA2B,CAAC,QAAQ,CAAC,CAAC;IACtC,wBAAwB,CAAC,QAAQ,CAAC,CAAC;IAEnC,IAAI,WAAW,GAAW,oBAAoB,CAAC;IAC/C,IAAI,WAAW,GAAW,oBAAoB,CAAC;IAC/C,IAAI,YAAY,GAAW,qBAAqB,CAAC;IACjD,IAAI,YAAY,GAAW,qBAAqB,CAAC;IAEjD,IAAI,OAAO,GAAW,EAAE,CAAC;IAEzB,KAAK,IAAI,KAAK,GAAW,CAAC,EAAE,KAAK,GAAG,cAAc,EAAE,KAAK,EAAE,EAAE,CAAC;QAC5D,MAAM,YAAY,GAChB,CAAC,WAAW,GAAG,WAAW,CAAC,GAAG,iBAAiB,CAAC;QAElD,MAAM,aAAa,GACjB,CAAC,YAAY,GAAG,YAAY,CAAC,GAAG,iBAAiB,CAAC;QAEpD,IAAI,QAAQ,GAAW,IAAI,CAAC,KAAK,CAC/B,CAAC,WAAW,GAAG,QAAQ,CAAC,QAAQ,CAAC,GAAG,YAAY,CACjD,CAAC;QAEF,IAAI,WAAW,GAAW,IAAI,CAAC,KAAK,CAClC,CAAC,QAAQ,CAAC,SAAS,GAAG,YAAY,CAAC,GAAG,aAAa,CACpD,CAAC;QAEF,oDAAoD;QACpD,QAAQ,GAAG,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,iBAAiB,GAAG,CAAC,CAAC,CAAC;QACrD,WAAW,GAAG,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE,iBAAiB,GAAG,CAAC,CAAC,CAAC;QAE3D,MAAM,MAAM,GAAW,WAAW,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;QAE1D,OAAO,IAAI,MAAM,CAAC;QAElB,WAAW,IAAI,QAAQ,GAAG,YAAY,CAAC;QACvC,WAAW,GAAG,WAAW,GAAG,YAAY,CAAC;QAEzC,YAAY,IAAI,WAAW,GAAG,aAAa,CAAC;QAC5C,YAAY,GAAG,YAAY,GAAG,aAAa,CAAC;IAC9C,CAAC;IAED,OAAO,OAAO,CAAC;AACjB,CAAC"}

package/dist/errors.d.ts

@@ -0,0 +1,57 @@
+/**
+ * Copyright (c) 2026 Pranam
+ * ORCID: https://orcid.org/0009-0007-9316-3616
+ *
+ * This code is licensed under the Apache License, Version 2.0.
+ *
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * QR Code:
+ * ![QR Code](/ORCID.png)
+ * Scan the QR code to access my ORCID profile.
+ */
+/**
+ * Custom error class for DIGIPIN-related errors.
+ * @category Errors
+ *
+ */
+export declare class DigipinError extends Error {
+    /**
+     * Error code indicating the type of DIGIPIN error.
+     */
+    readonly code: "InvalidLatitude" | "InvalidLongitude" | "OutsideSupportedTerritory" | "InvalidDigipinLength" | "InvalidDigipinFormat";
+    /**
+     * Creates a new DigipinError instance.
+     * @param code Error code indicating the type of error
+     * @param message Human-readable error message
+     */
+    constructor(code: DigipinError["code"], message: string);
+    /**
+     * Creates an error for invalid latitude values.
+     * @returns DigipinError instance for invalid latitude
+     */
+    static invalidLatitude(): DigipinError;
+    /**
+     * Creates an error for invalid longitude values.
+     * @returns DigipinError instance for invalid longitude
+     */
+    static invalidLongitude(): DigipinError;
+    /**
+     * Creates an error for locations outside the DIGIPIN supported territory.
+     * @returns DigipinError instance for locations outside the supported territory
+     */
+    static outsideSupportedTerritory(): DigipinError;
+    /**
+     * Creates an error for DIGIPINs with invalid length.
+     * @returns DigipinError instance for invalid DIGIPIN length
+     */
+    static invalidDigipinLength(): DigipinError;
+    /**
+     * Creates an error for DIGIPINs with invalid format or symbols.
+     * @returns DigipinError instance for invalid DIGIPIN format
+     */
+    static invalidDigipinFormat(): DigipinError;
+}
+//# sourceMappingURL=errors.d.ts.map

package/dist/errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAEH;;;;GAIG;AACH,qBAAa,YAAa,SAAQ,KAAK;IACrC;;OAEG;IACH,SAAgB,IAAI,EAChB,iBAAiB,GACjB,kBAAkB,GAClB,2BAA2B,GAC3B,sBAAsB,GACtB,sBAAsB,CAAC;IAE3B;;;;OAIG;gBACgB,IAAI,EAAE,YAAY,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE,MAAM;IAM9D;;;OAGG;IACH,MAAM,CAAC,eAAe,IAAI,YAAY;IAMtC;;;OAGG;IACH,MAAM,CAAC,gBAAgB,IAAI,YAAY;IAMvC;;;OAGG;IACH,MAAM,CAAC,yBAAyB,IAAI,YAAY;IAMhD;;;OAGG;IACH,MAAM,CAAC,oBAAoB,IAAI,YAAY;IAO3C;;;OAGG;IACH,MAAM,CAAC,oBAAoB,IAAI,YAAY;CAM5C"}

package/dist/errors.js

@@ -0,0 +1,71 @@
+/**
+ * Copyright (c) 2026 Pranam
+ * ORCID: https://orcid.org/0009-0007-9316-3616
+ *
+ * This code is licensed under the Apache License, Version 2.0.
+ *
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * QR Code:
+ * ![QR Code](/ORCID.png)
+ * Scan the QR code to access my ORCID profile.
+ */
+/**
+ * Custom error class for DIGIPIN-related errors.
+ * @category Errors
+ *
+ */
+export class DigipinError extends Error {
+    /**
+     * Error code indicating the type of DIGIPIN error.
+     */
+    code;
+    /**
+     * Creates a new DigipinError instance.
+     * @param code Error code indicating the type of error
+     * @param message Human-readable error message
+     */
+    constructor(code, message) {
+        super(message);
+        this.name = "DigipinError";
+        this.code = code;
+    }
+    /**
+     * Creates an error for invalid latitude values.
+     * @returns DigipinError instance for invalid latitude
+     */
+    static invalidLatitude() {
+        return new DigipinError("InvalidLatitude", "Latitude is outside geodetic bounds.");
+    }
+    /**
+     * Creates an error for invalid longitude values.
+     * @returns DigipinError instance for invalid longitude
+     */
+    static invalidLongitude() {
+        return new DigipinError("InvalidLongitude", "Longitude is outside geodetic bounds.");
+    }
+    /**
+     * Creates an error for locations outside the DIGIPIN supported territory.
+     * @returns DigipinError instance for locations outside the supported territory
+     */
+    static outsideSupportedTerritory() {
+        return new DigipinError("OutsideSupportedTerritory", "Location is outside the DIGIPIN supported territory.");
+    }
+    /**
+     * Creates an error for DIGIPINs with invalid length.
+     * @returns DigipinError instance for invalid DIGIPIN length
+     */
+    static invalidDigipinLength() {
+        return new DigipinError("InvalidDigipinLength", "DIGIPIN does not conform to required length.");
+    }
+    /**
+     * Creates an error for DIGIPINs with invalid format or symbols.
+     * @returns DigipinError instance for invalid DIGIPIN format
+     */
+    static invalidDigipinFormat() {
+        return new DigipinError("InvalidDigipinFormat", "DIGIPIN contains invalid symbols or format.");
+    }
+}
+//# sourceMappingURL=errors.js.map

package/dist/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAEH;;;;GAIG;AACH,MAAM,OAAO,YAAa,SAAQ,KAAK;IACrC;;OAEG;IACa,IAAI,CAKO;IAE3B;;;;OAIG;IACH,YAAmB,IAA0B,EAAE,OAAe;QAC5D,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,cAAc,CAAC;QAC3B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,eAAe;QACpB,OAAO,IAAI,YAAY,CACrB,iBAAiB,EACjB,sCAAsC,CACvC,CAAC;IACJ,CAAC;IACD;;;OAGG;IACH,MAAM,CAAC,gBAAgB;QACrB,OAAO,IAAI,YAAY,CACrB,kBAAkB,EAClB,uCAAuC,CACxC,CAAC;IACJ,CAAC;IACD;;;OAGG;IACH,MAAM,CAAC,yBAAyB;QAC9B,OAAO,IAAI,YAAY,CACrB,2BAA2B,EAC3B,sDAAsD,CACvD,CAAC;IACJ,CAAC;IACD;;;OAGG;IACH,MAAM,CAAC,oBAAoB;QACzB,OAAO,IAAI,YAAY,CACrB,sBAAsB,EACtB,8CAA8C,CAC/C,CAAC;IACJ,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,oBAAoB;QACzB,OAAO,IAAI,YAAY,CACrB,sBAAsB,EACtB,6CAA6C,CAC9C,CAAC;IACJ,CAAC;CACF"}

package/dist/index.d.ts

@@ -0,0 +1,38 @@
+/**
+ * Copyright (c) 2026 Pranam
+ * ORCID: https://orcid.org/0009-0007-9316-3616
+ *
+ * This code is licensed under the Apache License, Version 2.0.
+ *
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * QR Code:
+ * ![QR Code](/ORCID.png)
+ * Scan the QR code to access my ORCID profile.
+ */
+/**
+ * This library provides functions to encode geodetic coordinates into 10 character DIGIPINs
+ * and decode DIGIPINs back into geodetic coordinates.
+ * The DIGIPIN system divides the Earth's surface into a grid of cells, each represented by a unique 10 character code.
+ * The library includes functions for normalization and validation of DIGIPINs.
+ * It is implemented in TypeScript and can be used in both Node.js and browser environments.
+ *
+ * @packageDocumentation
+ *
+ * @example
+ * ```ts
+ * import { encode, decode } from "@pranamphd/digipin";
+ *
+ * const digipin = encode(28.6139, 77.209); // Encode coordinates to DIGIPIN
+ * console.log(digipin); // Example output: "39J438TJC7"
+ *
+ * const location = decode(digipin); // Decode DIGIPIN back to coordinates
+ * console.log(location); // Example output: { latitude: 28.6139, longitude: 77.209 }
+ * ```
+ */
+export { encode } from "./encode.js";
+export { decode } from "./decode.js";
+export type { Location } from "./location.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAEH;;;;;;;;;;;;;;;;;;;GAmBG;AACH,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,YAAY,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC"}

package/dist/index.js

@@ -0,0 +1,37 @@
+/**
+ * Copyright (c) 2026 Pranam
+ * ORCID: https://orcid.org/0009-0007-9316-3616
+ *
+ * This code is licensed under the Apache License, Version 2.0.
+ *
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * QR Code:
+ * ![QR Code](/ORCID.png)
+ * Scan the QR code to access my ORCID profile.
+ */
+/**
+ * This library provides functions to encode geodetic coordinates into 10 character DIGIPINs
+ * and decode DIGIPINs back into geodetic coordinates.
+ * The DIGIPIN system divides the Earth's surface into a grid of cells, each represented by a unique 10 character code.
+ * The library includes functions for normalization and validation of DIGIPINs.
+ * It is implemented in TypeScript and can be used in both Node.js and browser environments.
+ *
+ * @packageDocumentation
+ *
+ * @example
+ * ```ts
+ * import { encode, decode } from "@pranamphd/digipin";
+ *
+ * const digipin = encode(28.6139, 77.209); // Encode coordinates to DIGIPIN
+ * console.log(digipin); // Example output: "39J438TJC7"
+ *
+ * const location = decode(digipin); // Decode DIGIPIN back to coordinates
+ * console.log(location); // Example output: { latitude: 28.6139, longitude: 77.209 }
+ * ```
+ */
+export { encode } from "./encode.js";
+export { decode } from "./decode.js";
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAEH;;;;;;;;;;;;;;;;;;;GAmBG;AACH,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC"}

package/dist/location.d.ts

@@ -0,0 +1,33 @@
+/**
+ * Copyright (c) 2026 Pranam
+ * ORCID: https://orcid.org/0009-0007-9316-3616
+ *
+ * This code is licensed under the Apache License, Version 2.0.
+ *
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * QR Code:
+ * ![QR Code](/ORCID.png)
+ * Scan the QR code to access my ORCID profile.
+ */
+/**
+ * Represents a geographic location expressed as latitude and longitude.
+ *
+ * Both values are expressed in decimal degrees using the WGS-84
+ * coordinate reference system.
+ *
+ * This type is used as the return value of DIGIPIN decoding operations.
+ */
+export type Location = {
+    /**
+     * Latitude in decimal degrees.
+     */
+    latitude: number;
+    /**
+     * Longitude in decimal degrees.
+     */
+    longitude: number;
+};
+//# sourceMappingURL=location.d.ts.map

package/dist/location.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"location.d.ts","sourceRoot":"","sources":["../src/location.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAEH;;;;;;;GAOG;AACH,MAAM,MAAM,QAAQ,GAAG;IACrB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB,CAAA"}

package/dist/location.js

@@ -0,0 +1,16 @@
+/**
+ * Copyright (c) 2026 Pranam
+ * ORCID: https://orcid.org/0009-0007-9316-3616
+ *
+ * This code is licensed under the Apache License, Version 2.0.
+ *
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * QR Code:
+ * ![QR Code](/ORCID.png)
+ * Scan the QR code to access my ORCID profile.
+ */
+export {};
+//# sourceMappingURL=location.js.map

package/dist/location.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"location.js","sourceRoot":"","sources":["../src/location.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG"}

package/dist/normalize.d.ts

@@ -0,0 +1,26 @@
+/**
+ * Copyright (c) 2026 Pranam
+ * ORCID: https://orcid.org/0009-0007-9316-3616
+ *
+ * This code is licensed under the Apache License, Version 2.0.
+ *
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * QR Code:
+ * ![QR Code](/ORCID.png)
+ * Scan the QR code to access my ORCID profile.
+ */
+/**
+ * Normalize a DIGIPIN string.
+ *
+ * Normalization applies the following rules:
+ * - Removes '-' separator characters
+ * - Converts all characters to uppercase
+ *
+ * @param digipin - DIGIPIN string to normalize
+ * @returns Normalized DIGIPIN string
+ */
+export declare function normalize(digipin: string): string;
+//# sourceMappingURL=normalize.d.ts.map

package/dist/normalize.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"normalize.d.ts","sourceRoot":"","sources":["../src/normalize.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAEH;;;;;;;;;GASG;AACH,wBAAgB,SAAS,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAUjD"}

package/dist/normalize.js

@@ -0,0 +1,34 @@
+/**
+ * Copyright (c) 2026 Pranam
+ * ORCID: https://orcid.org/0009-0007-9316-3616
+ *
+ * This code is licensed under the Apache License, Version 2.0.
+ *
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * QR Code:
+ * ![QR Code](/ORCID.png)
+ * Scan the QR code to access my ORCID profile.
+ */
+/**
+ * Normalize a DIGIPIN string.
+ *
+ * Normalization applies the following rules:
+ * - Removes '-' separator characters
+ * - Converts all characters to uppercase
+ *
+ * @param digipin - DIGIPIN string to normalize
+ * @returns Normalized DIGIPIN string
+ */
+export function normalize(digipin) {
+    let normalizedDigipin = "";
+    for (const character of digipin) {
+        if (character !== "-") {
+            normalizedDigipin += character.toUpperCase();
+        }
+    }
+    return normalizedDigipin;
+}
+//# sourceMappingURL=normalize.js.map

package/dist/normalize.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"normalize.js","sourceRoot":"","sources":["../src/normalize.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAEH;;;;;;;;;GASG;AACH,MAAM,UAAU,SAAS,CAAC,OAAe;IACvC,IAAI,iBAAiB,GAAW,EAAE,CAAC;IAEnC,KAAK,MAAM,SAAS,IAAI,OAAO,EAAE,CAAC;QAChC,IAAI,SAAS,KAAK,GAAG,EAAE,CAAC;YACtB,iBAAiB,IAAI,SAAS,CAAC,WAAW,EAAE,CAAC;QAC/C,CAAC;IACH,CAAC;IAED,OAAO,iBAAiB,CAAC;AAC3B,CAAC"}

package/dist/validation.d.ts

@@ -0,0 +1,48 @@
+/**
+ * Copyright (c) 2026 Pranam
+ * ORCID: https://orcid.org/0009-0007-9316-3616
+ *
+ * This code is licensed under the Apache License, Version 2.0.
+ *
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * QR Code:
+ * ![QR Code](/ORCID.png)
+ * Scan the QR code to access my ORCID profile.
+ */
+import type { Location } from "./location.js";
+/**
+ * Validate geodetic latitude and longitude.
+ *
+ * This function checks whether the provided coordinates fall within
+ * the valid WGS-84 geodetic bounds.
+ *
+ * @param location - Geographic location containing latitude and longitude
+ * @throws Error if geodetic coordinates are out of bounds
+ */
+export declare function validateGeodeticCoordinates(location: Location): void;
+/**
+ * Validate that a geographic location lies within the DIGIPIN
+ * supported territory.
+ *
+ * @param location - Geographic location containing latitude and longitude
+ * @throws Outside supported territory error if location is out of supported bounds
+ */
+export declare function validateDigipinTerritory(location: Location): void;
+/**
+ * Validate the format of a DIGIPIN string.
+ *
+ * This function checks:
+ * - Exact DIGIPIN length
+ * - Allowed DIGIPIN symbol set
+ *
+ * The input must already be normalized (no separators, uppercase).
+ *
+ * @param digipin - DIGIPIN string to validate
+ * @throws Invalid DIGIPIN length error if length is incorrect
+ * @throws Invalid DIGIPIN format error if invalid symbols are found
+ */
+export declare function validateDigipinFormat(digipin: string): void;
+//# sourceMappingURL=validation.d.ts.map

package/dist/validation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validation.d.ts","sourceRoot":"","sources":["../src/validation.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAeH,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAc9C;;;;;;;;GAQG;AACH,wBAAgB,2BAA2B,CAAC,QAAQ,EAAE,QAAQ,GAAG,IAAI,CAgBpE;AACD;;;;;;GAMG;AACH,wBAAgB,wBAAwB,CAAC,QAAQ,EAAE,QAAQ,GAAG,IAAI,CASjE;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,qBAAqB,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAU3D"}

package/dist/validation.js

@@ -0,0 +1,83 @@
+/**
+ * Copyright (c) 2026 Pranam
+ * ORCID: https://orcid.org/0009-0007-9316-3616
+ *
+ * This code is licensed under the Apache License, Version 2.0.
+ *
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * QR Code:
+ * ![QR Code](/ORCID.png)
+ * Scan the QR code to access my ORCID profile.
+ */
+import { GEODETIC_LATITUDE_MIN, GEODETIC_LATITUDE_MAX, GEODETIC_LONGITUDE_MIN, GEODETIC_LONGITUDE_MAX, DIGIPIN_LATITUDE_MIN, DIGIPIN_LATITUDE_MAX, DIGIPIN_LONGITUDE_MIN, DIGIPIN_LONGITUDE_MAX, DIGIPIN_LENGTH, DIGIPIN_SYMBOLS, } from "./constants.js";
+import { DigipinError } from "./errors.js";
+/**
+ * Check if a value is within a range.
+ *
+ * @param value - The value to check
+ * @param min - The minimum allowed value
+ * @param max - The maximum allowed value
+ * @returns True if the value is within the range, false otherwise
+ */
+function isWithin(value, min, max) {
+    return value >= min && value <= max;
+}
+/**
+ * Validate geodetic latitude and longitude.
+ *
+ * This function checks whether the provided coordinates fall within
+ * the valid WGS-84 geodetic bounds.
+ *
+ * @param location - Geographic location containing latitude and longitude
+ * @throws Error if geodetic coordinates are out of bounds
+ */
+export function validateGeodeticCoordinates(location) {
+    if (!isWithin(location.latitude, GEODETIC_LATITUDE_MIN, GEODETIC_LATITUDE_MAX)) {
+        throw DigipinError.invalidLatitude();
+    }
+    if (!isWithin(location.longitude, GEODETIC_LONGITUDE_MIN, GEODETIC_LONGITUDE_MAX)) {
+        throw DigipinError.invalidLongitude();
+    }
+}
+/**
+ * Validate that a geographic location lies within the DIGIPIN
+ * supported territory.
+ *
+ * @param location - Geographic location containing latitude and longitude
+ * @throws Outside supported territory error if location is out of supported bounds
+ */
+export function validateDigipinTerritory(location) {
+    if (location.latitude < DIGIPIN_LATITUDE_MIN ||
+        location.latitude > DIGIPIN_LATITUDE_MAX ||
+        location.longitude < DIGIPIN_LONGITUDE_MIN ||
+        location.longitude > DIGIPIN_LONGITUDE_MAX) {
+        throw DigipinError.outsideSupportedTerritory();
+    }
+}
+/**
+ * Validate the format of a DIGIPIN string.
+ *
+ * This function checks:
+ * - Exact DIGIPIN length
+ * - Allowed DIGIPIN symbol set
+ *
+ * The input must already be normalized (no separators, uppercase).
+ *
+ * @param digipin - DIGIPIN string to validate
+ * @throws Invalid DIGIPIN length error if length is incorrect
+ * @throws Invalid DIGIPIN format error if invalid symbols are found
+ */
+export function validateDigipinFormat(digipin) {
+    if (digipin.length !== DIGIPIN_LENGTH) {
+        throw DigipinError.invalidDigipinLength();
+    }
+    for (const character of digipin) {
+        if (!DIGIPIN_SYMBOLS.includes(character)) {
+            throw DigipinError.invalidDigipinFormat();
+        }
+    }
+}
+//# sourceMappingURL=validation.js.map

package/dist/validation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validation.js","sourceRoot":"","sources":["../src/validation.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAEH,OAAO,EACL,qBAAqB,EACrB,qBAAqB,EACrB,sBAAsB,EACtB,sBAAsB,EACtB,oBAAoB,EACpB,oBAAoB,EACpB,qBAAqB,EACrB,qBAAqB,EACrB,cAAc,EACd,eAAe,GAChB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAG3C;;;;;;;GAOG;AACH,SAAS,QAAQ,CAAC,KAAa,EAAE,GAAW,EAAE,GAAW;IACvD,OAAO,KAAK,IAAI,GAAG,IAAI,KAAK,IAAI,GAAG,CAAC;AACtC,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,2BAA2B,CAAC,QAAkB;IAC5D,IACE,CAAC,QAAQ,CAAC,QAAQ,CAAC,QAAQ,EAAE,qBAAqB,EAAE,qBAAqB,CAAC,EAC1E,CAAC;QACD,MAAM,YAAY,CAAC,eAAe,EAAE,CAAC;IACvC,CAAC;IAED,IACE,CAAC,QAAQ,CACP,QAAQ,CAAC,SAAS,EAClB,sBAAsB,EACtB,sBAAsB,CACvB,EACD,CAAC;QACD,MAAM,YAAY,CAAC,gBAAgB,EAAE,CAAC;IACxC,CAAC;AACH,CAAC;AACD;;;;;;GAMG;AACH,MAAM,UAAU,wBAAwB,CAAC,QAAkB;IACzD,IACE,QAAQ,CAAC,QAAQ,GAAG,oBAAoB;QACxC,QAAQ,CAAC,QAAQ,GAAG,oBAAoB;QACxC,QAAQ,CAAC,SAAS,GAAG,qBAAqB;QAC1C,QAAQ,CAAC,SAAS,GAAG,qBAAqB,EAC1C,CAAC;QACD,MAAM,YAAY,CAAC,yBAAyB,EAAE,CAAC;IACjD,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,qBAAqB,CAAC,OAAe;IACnD,IAAI,OAAO,CAAC,MAAM,KAAK,cAAc,EAAE,CAAC;QACtC,MAAM,YAAY,CAAC,oBAAoB,EAAE,CAAC;IAC5C,CAAC;IAED,KAAK,MAAM,SAAS,IAAI,OAAO,EAAE,CAAC;QAChC,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC;YACzC,MAAM,YAAY,CAAC,oBAAoB,EAAE,CAAC;QAC5C,CAAC;IACH,CAAC;AACH,CAAC"}

package/package.json

@@ -0,0 +1,59 @@
+{
+  "name": "@pranamphd/digipin",
+  "version": "0.1.0-alpha.1",
+  "description": "TypeScript library for encoding and decoding India's DIGIPIN (Digital Postal Index Number).",
+  "keywords": [
+    "digipin",
+    "india",
+    "postal",
+    "gis",
+    "geolocation",
+    "pincode",
+    "library"
+  ],
+  "homepage": "https://github.com/pranamphd/digipin-ts#readme",
+  "bugs": {
+    "url": "https://github.com/pranamphd/digipin-ts/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/pranamphd/digipin-ts.git"
+  },
+  "license": "Apache-2.0",
+  "author": "Pranam <pranam@pranam.phd>",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "clean": "rm -rf dist",
+    "build": "tsc -p tsconfig.json",
+    "lint": "eslint . --max-warnings 0",
+    "lint:fix": "eslint . --fix",
+    "typecheck": "tsc -p tsconfig.test.json",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage",
+    "check": "npm run lint && npm run typecheck && npm run test"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.39.2",
+    "@vitest/coverage-v8": "^4.0.17",
+    "eslint": "^9.39.2",
+    "globals": "^17.0.0",
+    "jiti": "^2.6.1",
+    "typescript": "^5.9.3",
+    "typescript-eslint": "^8.53.0",
+    "vitest": "^4.0.17"
+  }
+}