@developmentseed/epsg 0.1.0

package/README.md

@@ -0,0 +1,62 @@
+# @developmentseed/epsg
+
+The full EPSG projection database, compressed to **309kb** for the web.
+
+[EPSG]: https://en.wikipedia.org/wiki/EPSG_Geodetic_Parameter_Dataset
+
+Some existing EPSG amalgamations exist, but all are uncompressed, incomplete, outdated, and/or not reproducible [^1] [^2] [^3] [^4]. This package uses the [DecompressionStream] API, now [widely available in browsers][DecompressionStream_gzip], to bundle a gzip-compressed text file of WKT definitions for **all 7352 defined EPSG projection codes**.
+
+[DecompressionStream]: https://developer.mozilla.org/en-US/docs/Web/API/DecompressionStream
+[DecompressionStream_gzip]: https://caniuse.com/mdn-api_decompressionstream_decompressionstream_gzip
+
+[^1]: [`epsg`](https://www.npmjs.com/package/epsg) includes only 3912 definitions, stores older, deprecated proj strings, and is uncompressed, coming to 500kb.
+
+[^2]: [`epsg-index`](https://www.npmjs.com/package/epsg-index) stores extra parsed information for each projection and is **7.7 MB**.
+
+[^3]: [`proj4-list`](https://www.npmjs.com/package/proj4-list) includes only 5434 definitions, stores older, deprecated proj strings, and is 759KB of uncompressed strings.
+
+[^4]: [`@esri/proj-codes`](https://www.npmjs.com/package/@esri/proj-codes) ships a lot of redundant information, coming to nearly **15MB** of JSON.
+
+## Usage
+
+Currently, the only package entrypoint is `@developmentseed/epsg/all`, which loads a `Map<number, string>`, with all EPSG definitions in OGC WKT2 format.
+
+```ts
+import loadEPSG from "@developmentseed/epsg/all";
+import proj4 from "proj4";
+
+// Load the EPSG database
+const epsg = await loadEPSG();
+
+// Access WKT strings by EPSG code.
+const wkt4326 = epsg.get(4326);
+const wkt3857 = epsg.get(3857);
+
+// Then use proj4.js as normal
+const converter = proj4(wkt4326, wkt3857);
+const inputPoint = [1, 52];
+const outputPoint = converter.forward(inputPoint);
+```
+
+## Generate new EPSG definitions
+
+First, download the latest EPSG definitions in WKT format. Go to [epsg.org/download-dataset.html](https://epsg.org/download-dataset.html), create an account or log in, then download the `WKT File` version.
+
+Then, from this directory, run
+
+```bash
+python scripts/generate.py
+```
+
+Then the file `src/all.csv.gz` will be updated with the latest EPSG definitions.
+
+## Publishing
+
+The `build` script in `package.json` will automatically include `all.csv.gz` in the published NPM package.
+
+If you get an error like
+
+> `cp: dist/all.csv.gz: No such file or directory`
+
+You may need to delete an errant `tsconfig.build.tsbuildinfo` and try again. I'm not sure why.
+

package/dist/all.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Load the EPSG database into memory.
+ *
+ * The database is stored as a gzipped CSV file. This function loads and parses
+ * the file, returning a map of EPSG code to WKT string.
+ *
+ * The result is cached after the first call, so subsequent calls will return
+ * the cached result.
+ *
+ * @param url - Optional URL to the gzipped CSV file. When using a bundler like
+ * Vite, pass the asset URL directly to ensure correct resolution:
+ * `import csvUrl from "@developmentseed/epsg/all.csv.gz?url"`
+ */
+export default function loadEPSG(url?: string | URL): Promise<Map<number, string>>;
+//# sourceMappingURL=all.d.ts.map

package/dist/all.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"all.d.ts","sourceRoot":"","sources":["../src/all.ts"],"names":[],"mappings":"AAKA;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,OAAO,UAAU,QAAQ,CAC9B,GAAG,CAAC,EAAE,MAAM,GAAG,GAAG,GACjB,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAM9B"}

package/dist/all.js

@@ -0,0 +1,73 @@
+const SEP = "|";
+/** A cached promise for the loaded EPSG database */
+let cachedLoad = null;
+/**
+ * Load the EPSG database into memory.
+ *
+ * The database is stored as a gzipped CSV file. This function loads and parses
+ * the file, returning a map of EPSG code to WKT string.
+ *
+ * The result is cached after the first call, so subsequent calls will return
+ * the cached result.
+ *
+ * @param url - Optional URL to the gzipped CSV file. When using a bundler like
+ * Vite, pass the asset URL directly to ensure correct resolution:
+ * `import csvUrl from "@developmentseed/epsg/all.csv.gz?url"`
+ */
+export default function loadEPSG(url) {
+    if (!cachedLoad) {
+        cachedLoad = load(url ?? new URL("./all.csv.gz", import.meta.url));
+    }
+    return cachedLoad;
+}
+async function load(url) {
+    const response = await fetch(url);
+    if (!response.body) {
+        throw new Error("Response has no body");
+    }
+    // When the server serves the gzipped file with `Content-Encoding: gzip`, the
+    // browser automatically decompresses it, so we can just read the text
+    // directly.
+    // If the header is missing, we need to decompress it ourselves.
+    const alreadyDecompressed = response.headers.get("Content-Encoding") === "gzip";
+    const stream = !alreadyDecompressed
+        ? response.body
+            .pipeThrough(new DecompressionStream("gzip"))
+            .pipeThrough(new TextDecoderStream())
+        : response.body.pipeThrough(new TextDecoderStream());
+    return parseStream(stream);
+}
+async function parseStream(stream) {
+    const reader = stream.getReader();
+    const map = new Map();
+    let buffer = "";
+    while (true) {
+        // Read the next chunk from the stream
+        const { value, done } = await reader.read();
+        if (done) {
+            break;
+        }
+        buffer += value;
+        // The position of the newline character
+        let newlineIndex = buffer.indexOf("\n");
+        // Iterate over each line in the buffer
+        while (newlineIndex !== -1) {
+            const line = buffer.slice(0, newlineIndex);
+            // Update buffer range and search for next newline
+            buffer = buffer.slice(newlineIndex + 1);
+            newlineIndex = buffer.indexOf("\n");
+            if (!line) {
+                continue;
+            }
+            const sep = line.indexOf(SEP);
+            if (sep === -1) {
+                throw new Error(`Invalid line, missing separator: ${line}`);
+            }
+            const code = Number.parseInt(line.slice(0, sep), 10);
+            const wkt = line.slice(sep + 1);
+            map.set(code, wkt);
+        }
+    }
+    return map;
+}
+//# sourceMappingURL=all.js.map

package/dist/all.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"all.js","sourceRoot":"","sources":["../src/all.ts"],"names":[],"mappings":"AAAA,MAAM,GAAG,GAAG,GAAG,CAAC;AAEhB,oDAAoD;AACpD,IAAI,UAAU,GAAwC,IAAI,CAAC;AAE3D;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,OAAO,UAAU,QAAQ,CAC9B,GAAkB;IAElB,IAAI,CAAC,UAAU,EAAE,CAAC;QAChB,UAAU,GAAG,IAAI,CAAC,GAAG,IAAI,IAAI,GAAG,CAAC,cAAc,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;IACrE,CAAC;IAED,OAAO,UAAU,CAAC;AACpB,CAAC;AAED,KAAK,UAAU,IAAI,CAAC,GAAiB;IACnC,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,CAAC,CAAC;IAElC,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;QACnB,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;IAC1C,CAAC;IAED,6EAA6E;IAC7E,sEAAsE;IACtE,YAAY;IACZ,gEAAgE;IAChE,MAAM,mBAAmB,GACvB,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,kBAAkB,CAAC,KAAK,MAAM,CAAC;IAEtD,MAAM,MAAM,GAAG,CAAC,mBAAmB;QACjC,CAAC,CAAC,QAAQ,CAAC,IAAI;aACV,WAAW,CAAC,IAAI,mBAAmB,CAAC,MAAM,CAAC,CAAC;aAC5C,WAAW,CAAC,IAAI,iBAAiB,EAAE,CAAC;QACzC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,iBAAiB,EAAE,CAAC,CAAC;IAEvD,OAAO,WAAW,CAAC,MAAM,CAAC,CAAC;AAC7B,CAAC;AAED,KAAK,UAAU,WAAW,CACxB,MAA8B;IAE9B,MAAM,MAAM,GAAG,MAAM,CAAC,SAAS,EAAE,CAAC;IAClC,MAAM,GAAG,GAAG,IAAI,GAAG,EAAkB,CAAC;IAEtC,IAAI,MAAM,GAAG,EAAE,CAAC;IAEhB,OAAO,IAAI,EAAE,CAAC;QACZ,sCAAsC;QACtC,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,MAAM,MAAM,CAAC,IAAI,EAAE,CAAC;QAC5C,IAAI,IAAI,EAAE,CAAC;YACT,MAAM;QACR,CAAC;QAED,MAAM,IAAI,KAAK,CAAC;QAEhB,wCAAwC;QACxC,IAAI,YAAY,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAExC,uCAAuC;QACvC,OAAO,YAAY,KAAK,CAAC,CAAC,EAAE,CAAC;YAC3B,MAAM,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,YAAY,CAAC,CAAC;YAE3C,kDAAkD;YAClD,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,YAAY,GAAG,CAAC,CAAC,CAAC;YACxC,YAAY,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YAEpC,IAAI,CAAC,IAAI,EAAE,CAAC;gBACV,SAAS;YACX,CAAC;YAED,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;YAC9B,IAAI,GAAG,KAAK,CAAC,CAAC,EAAE,CAAC;gBACf,MAAM,IAAI,KAAK,CAAC,oCAAoC,IAAI,EAAE,CAAC,CAAC;YAC9D,CAAC;YAED,MAAM,IAAI,GAAG,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,EAAE,CAAC,CAAC;YACrD,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC;YAEhC,GAAG,CAAC,GAAG,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;QACrB,CAAC;IACH,CAAC;IAED,OAAO,GAAG,CAAC;AACb,CAAC"}

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "@developmentseed/epsg",
+  "version": "0.1.0",
+  "description": "The full EPSG projection database, compressed to 309kb for the web.",
+  "type": "module",
+  "exports": {
+    "./all": {
+      "types": "./dist/all.d.ts",
+      "default": "./dist/all.js"
+    },
+    "./all.csv.gz": "./dist/all.csv.gz"
+  },
+  "sideEffects": false,
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsc --build tsconfig.build.json && cp src/all.csv.gz dist/all.csv.gz",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "typecheck": "tsc --noEmit",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": [
+    "proj4",
+    "geotiff",
+    "zarr",
+    "cog",
+    "cloud-optimized-geotiff",
+    "raster",
+    "visualization",
+    "webgl",
+    "gpu"
+  ],
+  "author": "Development Seed",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/developmentseed/deck.gl-raster.git"
+  },
+  "devDependencies": {
+    "@types/node": "^25.3.3",
+    "jsdom": "^27.4.0",
+    "proj4": "^2.20.3",
+    "typescript": "^5.9.3",
+    "vitest": "^4.0.18"
+  },
+  "volta": {
+    "extends": "../../package.json"
+  }
+}