@india-boundary-corrector/data 0.0.2 → 0.0.4

package/README.md

@@ -4,6 +4,8 @@
 
 PMTiles data package for India boundary corrections.
 
+[**🗺️ View PMTiles data on pmtiles.io**](https://pmtiles.io/#url=https%3A%2F%2Fcdn.jsdelivr.net%2Fnpm%2F%40india-boundary-corrector%2Fdata%2Findia_boundary_corrections.pmtiles)
+
 ## Layers
 
 The PMTiles file contains 4 layers:
@@ -30,6 +32,32 @@ setPmtilesUrl('https://my-cdn.com/india_boundary_corrections.pmtiles');
 const version = getDataVersion(); // e.g., "osm_20231215_143022_ne_5.1.2"
 ```
 
+## PMTiles URL Resolution
+
+The `getPmtilesUrl()` function automatically detects the best URL for the PMTiles file:
+
+1. **ESM environments** (direct import, jsDelivr): Uses `import.meta.url` to resolve the file relative to the module location
+2. **CDNs requiring fallback** (esm.sh, Skypack, unpkg): These are redirected to jsDelivr (see below)
+3. **Bundled/other environments**: When `import.meta.url` isn't available (CJS, UMD), falls back to jsDelivr CDN with pinned package version
+
+### CDN fallback
+
+When the package is loaded from jsDelivr, the PMTiles file is resolved relative to the module URL - no extra configuration needed.
+
+The following CDNs automatically fall back to jsDelivr:
+- **esm.sh, Skypack**: These CDNs transform JS modules but don't serve static files
+- **unpkg**: Has issues serving PMTiles files (see [#13](https://github.com/ramSeraph/india_boundary_corrector/issues/13))
+
+When bundled (Rollup IIFE, Webpack, etc.), `import.meta.url` typically points to the bundle location. If the PMTiles file isn't copied alongside the bundle, the resolved URL will 404. In this case, either:
+- Copy the PMTiles file to your output directory (see below)
+- Use `setPmtilesUrl()` to point to a CDN or self-hosted URL
+
+### Self-hosted / Bundled builds
+
+If you're bundling this package with a tool like Rollup, Webpack, Vite, or tsup, you may need to copy the PMTiles file to your output directory.
+
+See **[Bundling the PMTiles Asset](./bundling-pmtiles.md)** for detailed instructions.
+
 ## Data Sources
 
 - OpenStreetMap boundary relations for India, Pakistan, and disputed territories

package/index.d.ts

@@ -8,12 +8,17 @@ export const layers: {
   toDelNe: string;
 };
 
+/**
+ * Default CDN URL for the PMTiles file (jsDelivr with pinned version)
+ */
+export const DEFAULT_CDN_URL: string;
+
 /**
  * Get the URL for the PMTiles file.
  * Automatically detects the correct URL based on the environment:
  * - ESM bundlers: Uses import.meta.url
- * - CDN (unpkg/jsdelivr): Derives from script src
- * - Fallback: unpkg CDN URL
+ * - IIFE/script tags: Uses document.currentScript.src
+ * - Fallback: jsDelivr CDN URL
  */
 export function getPmtilesUrl(): string;
 
@@ -28,3 +33,11 @@ export function setPmtilesUrl(url: string): void;
  * Format: osm_YYYYMMDD_HHMMSS_ne_VERSION
  */
 export function getDataVersion(): string;
+
+/**
+ * Resolve PMTiles URL from a given script URL.
+ * Useful for testing URL resolution logic.
+ * @param scriptUrl - The script URL to resolve from
+ * @returns The resolved PMTiles URL
+ */
+export function resolvePmtilesUrl(scriptUrl: string): string;

package/index.js

@@ -5,8 +5,18 @@ import { packageVersion } from './version.js';
 const PACKAGE_NAME = '@india-boundary-corrector/data';
 const PMTILES_FILENAME = 'india_boundary_corrections.pmtiles';
 
-// Default CDN URL with pinned package version
-const DEFAULT_CDN_URL = `https://unpkg.com/${PACKAGE_NAME}@${packageVersion}/${PMTILES_FILENAME}`;
+/**
+ * CDNs that need fallback to jsDelivr:
+ * - esm.sh, skypack: JS module transformers only, don't serve static files
+ * - unpkg.com: Has issues serving PMTiles files (incorrect content-type, range request problems)
+ */
+const FALLBACK_CDNS = new Set(['esm.sh', 'skypack.dev', 'cdn.skypack.dev', 'unpkg.com']);
+
+// Default fallback CDN (jsDelivr has multi-CDN architecture, more reliable)
+export const DEFAULT_CDN_URL = `https://cdn.jsdelivr.net/npm/${PACKAGE_NAME}@${packageVersion}/${PMTILES_FILENAME}`;
+
+// Capture document.currentScript.src at module load time (becomes null after script executes)
+const CURRENT_SCRIPT_URL = (typeof document !== 'undefined' && document.currentScript && document.currentScript.src) || null;
 
 /**
  * Layer names in the PMTiles file
@@ -18,46 +28,61 @@ export const layers = {
   toDelNe: 'to-del-ne',
 };
 
-/**
- * Check if a URL hostname should use CDN fallback.
- * Some CDNs like esm.sh don't host static files, so we need to fall back to unpkg.
- * @param {string} hostname - The hostname to check
- * @returns {boolean} True if CDN fallback should be used
- */
-export function shouldUseCdnFallback(hostname) {
-  // esm.sh doesn't host static files, only transforms JS modules
-  return hostname === 'esm.sh';
-}
-
 /**
  * Detect the PMTiles URL from various sources:
  * 1. import.meta.url (for ESM bundlers - most reliable)
- * 2. Fallback to unpkg CDN with pinned version
+ * 2. document.currentScript.src (for IIFE/script tags, captured at load time)
+ * 3. Fallback to jsDelivr CDN with pinned version
  * 
  * Note: When this package is bundled into another bundle, import.meta.url
  * won't work and we fall back to the CDN URL. Users can override with
  * setPmtilesUrl() for self-hosted scenarios.
  */
 function detectPmtilesUrl() {
+  let scriptUrl = null;
+
   // Try import.meta.url first (works in ESM environments)
   try {
     if (typeof import.meta !== 'undefined' && import.meta.url) {
-      const moduleUrl = new URL('.', import.meta.url);
-      // Some CDNs don't host static files, fall back to unpkg
-      if (shouldUseCdnFallback(moduleUrl.hostname)) {
-        return DEFAULT_CDN_URL;
-      }
-      return new URL(PMTILES_FILENAME, moduleUrl).href;
+      scriptUrl = import.meta.url;
     }
   } catch {
-    // import.meta not available (UMD/CJS/bundled)
+    // import.meta not available
+  }
+
+  // Use captured currentScript.src (for IIFE/script tags)
+  if (!scriptUrl && CURRENT_SCRIPT_URL) {
+    scriptUrl = CURRENT_SCRIPT_URL;
+  }
+
+  if (scriptUrl) {
+    const moduleUrl = new URL('.', scriptUrl);
+    // JS-only CDNs don't serve static files, fall back to default
+    if (FALLBACK_CDNS.has(moduleUrl.hostname)) {
+      return DEFAULT_CDN_URL;
+    }
+    return new URL(PMTILES_FILENAME, moduleUrl).href;
   }
 
   // Fallback to CDN with pinned version
-  // This ensures it works even when bundled into another package
   return DEFAULT_CDN_URL;
 }
 
+/**
+ * Resolve PMTiles URL from a given script URL.
+ * Useful for testing URL resolution logic.
+ * @param {string} scriptUrl - The script URL to resolve from
+ * @returns {string} The resolved PMTiles URL
+ */
+export function resolvePmtilesUrl(scriptUrl) {
+  const moduleUrl = new URL('.', scriptUrl);
+  // JS-only CDNs don't serve static files, fall back to default
+  if (FALLBACK_CDNS.has(moduleUrl.hostname)) {
+    return DEFAULT_CDN_URL;
+  }
+  return new URL(PMTILES_FILENAME, moduleUrl).href;
+}
+
 // Cache the detected URL
 let cachedPmtilesUrl = null;
 
@@ -67,7 +92,7 @@ let cachedPmtilesUrl = null;
  * Detection priority:
  * 1. Manually set URL via setPmtilesUrl()
  * 2. import.meta.url (ESM environments)
- * 3. unpkg CDN fallback (pinned to current version)
+ * 3. jsDelivr CDN fallback (pinned to current version)
  * 
  * For self-hosted deployments or custom bundling scenarios,
  * use setPmtilesUrl().

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@india-boundary-corrector/data",
-  "version": "0.0.2",
+  "version": "0.0.4",
   "description": "PMTiles data for India boundary corrections (NE and OSM layers)",
   "type": "module",
   "main": "index.js",
@@ -41,5 +41,6 @@
   "bugs": {
     "url": "https://github.com/ramSeraph/india_boundary_corrector/issues"
   },
-  "homepage": "https://github.com/ramSeraph/india_boundary_corrector#readme"
+  "homepage": "https://github.com/ramSeraph/india_boundary_corrector#readme",
+  "changelog": "https://github.com/ramSeraph/india_boundary_corrector/blob/main/packages/data/CHANGELOG.md"
 }

package/version.js

@@ -1,2 +1,2 @@
 // Auto-generated by scripts/generate-version.js - DO NOT EDIT
-export const packageVersion = '0.0.2';
+export const packageVersion = '0.0.4';