map-gl-offline 0.1.0-alpha.0

package/dist/utils/validation.d.ts

@@ -0,0 +1,67 @@
+/**
+ * Validation utilities for common patterns
+ * Provides reusable validation functions to ensure data integrity
+ */
+import type { OfflineRegionOptions } from '../types';
+/**
+ * Validate geographic bounds
+ * @param bounds - Array of two [lng, lat] coordinate pairs
+ * @returns true if valid, throws error if invalid
+ */
+export declare function validateBounds(bounds: unknown): bounds is [[number, number], [number, number]];
+/**
+ * Validate zoom levels
+ * @param minZoom - Minimum zoom level
+ * @param maxZoom - Maximum zoom level
+ * @param allowedMin - Minimum allowed value (default: 0)
+ * @param allowedMax - Maximum allowed value (default: 24)
+ * @returns true if valid, throws error if invalid
+ */
+export declare function validateZoomLevels(minZoom: unknown, maxZoom: unknown, allowedMin?: number, allowedMax?: number): boolean;
+/**
+ * Validate region configuration
+ * @param options - Region options to validate
+ * @returns true if valid, throws error if invalid
+ */
+export declare function validateRegionOptions(options: unknown): options is OfflineRegionOptions;
+/**
+ * Validate style URL
+ * @param url - Style URL to validate
+ * @returns true if valid, throws error if invalid
+ */
+export declare function validateStyleUrl(url: unknown): url is string;
+/**
+ * Validate region ID format
+ * @param id - Region ID to validate
+ * @returns true if valid, throws error if invalid
+ */
+export declare function validateRegionId(id: unknown): id is string;
+/**
+ * Validate download options batch size
+ * @param batchSize - Batch size to validate
+ * @param min - Minimum allowed value (default: 1)
+ * @param max - Maximum allowed value (default: 100)
+ * @returns true if valid, throws error if invalid
+ */
+export declare function validateBatchSize(batchSize: unknown, min?: number, max?: number): batchSize is number;
+/**
+ * Validate timeout value
+ * @param timeout - Timeout in milliseconds
+ * @param min - Minimum allowed value (default: 1000)
+ * @param max - Maximum allowed value (default: 120000)
+ * @returns true if valid, throws error if invalid
+ */
+export declare function validateTimeout(timeout: unknown, min?: number, max?: number): timeout is number;
+/**
+ * Safe validation wrapper that returns a result object instead of throwing
+ * @param validator - Validation function that throws on error
+ * @param value - Value to validate
+ * @returns Object with isValid boolean and optional error message
+ */
+export declare function safeValidate<T>(validator: (value: unknown) => value is T, value: unknown): {
+    isValid: true;
+    value: T;
+} | {
+    isValid: false;
+    error: string;
+};

package/package.json

@@ -0,0 +1,145 @@
+{
+  "name": "map-gl-offline",
+  "version": "0.1.0-alpha.0",
+  "description": "A TypeScript-compatible npm package for MapLibre GL JS that enables comprehensive offline storage and usage of vector/raster tiles, sprites, styles, fonts (glyphs), and entire map regions with advanced analytics, import/export capabilities, and intelligent cleanup.",
+  "main": "dist/index.js",
+  "module": "dist/index.esm.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.esm.js",
+      "require": "./dist/index.js"
+    },
+    "./style.css": "./dist/style.css"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/muimsd/map-gl-offline.git"
+  },
+  "homepage": "https://github.com/muimsd/map-gl-offline#readme",
+  "bugs": {
+    "url": "https://github.com/muimsd/map-gl-offline/issues"
+  },
+  "scripts": {
+    "dev": "vite",
+    "build": "npm run build:clean && npm run build:lib && npm run build:types && npm run build:css",
+    "build:clean": "rimraf dist",
+    "build:lib": "rollup -c",
+    "build:types": "tsc --declaration --emitDeclarationOnly --outDir dist",
+    "build:css": "cp src/styles/style.css dist/style.css",
+    "build:watch": "rollup -c -w",
+    "build:dev": "npm run build:clean && npm run build:lib",
+    "preview": "vite preview",
+    "start:examples": "cd examples/maplibre && npm i && npm run dev",
+    "test": "jest",
+    "test:watch": "jest --watch",
+    "test:coverage": "jest --coverage",
+    "test:ci": "jest --ci --coverage --watchAll=false",
+    "lint": "eslint src --ext .ts,.tsx --ignore-pattern 'src/main.ts'",
+    "lint:fix": "eslint src --ext .ts,.tsx --ignore-pattern 'src/main.ts' --fix",
+    "lint:warn": "eslint src --ext .ts,.tsx --ignore-pattern 'src/main.ts' --max-warnings 200",
+    "format": "prettier --write \"src/**/*.{ts,tsx,json,md}\"",
+    "format:check": "prettier --check \"src/**/*.{ts,tsx,json,md}\"",
+    "typecheck": "tsc --noEmit",
+    "validate": "npm run typecheck && npm run test:ci",
+    "validate:strict": "npm run typecheck && npm run lint && npm run test:ci",
+    "clean": "npm run build:clean && rimraf node_modules/.cache",
+    "prepublishOnly": "npm run validate && npm run build",
+    "release": "npm version patch && npm publish",
+    "release:minor": "npm version minor && npm publish",
+    "release:major": "npm version major && npm publish",
+    "release:dry": "npm publish --dry-run"
+  },
+  "keywords": [
+    "mapbox-gl",
+    "maplibre-gl",
+    "offline",
+    "maps",
+    "tiles",
+    "caching",
+    "indexeddb",
+    "pwa",
+    "vector-tiles",
+    "raster-tiles",
+    "sprites",
+    "fonts",
+    "glyphs",
+    "pmtiles",
+    "mbtiles",
+    "import",
+    "export",
+    "typescript",
+    "progressive-web-app",
+    "offline-maps",
+    "map-tiles",
+    "mobile",
+    "analytics"
+  ],
+  "author": "Muhammad Imran Siddique",
+  "license": "MIT",
+  "type": "module",
+  "dependencies": {
+    "@mapbox/tilebelt": "^2.0.2",
+    "@tabler/icons": "^3.34.0",
+    "@tailwindcss/vite": "^4.1.8",
+    "@turf/turf": "^7.2.0",
+    "idb": "^8.0.2"
+  },
+  "peerDependencies": {
+    "mapbox-gl": ">=2.0.0",
+    "maplibre-gl": ">=1.0.0"
+  },
+  "peerDependenciesMeta": {
+    "mapbox-gl": {
+      "optional": true
+    },
+    "maplibre-gl": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.28.0",
+    "@rollup/plugin-commonjs": "^28.0.3",
+    "@rollup/plugin-node-resolve": "^16.0.1",
+    "@rollup/plugin-typescript": "^12.1.2",
+    "@tailwindcss/postcss": "^4.1.8",
+    "@types/jest": "^29.5.14",
+    "@types/mapbox-gl": "^3.4.1",
+    "@types/mapbox__tilebelt": "^1.0.4",
+    "@types/maplibre-gl": "^1.14.0",
+    "@types/node": "^22.13.10",
+    "@typescript-eslint/eslint-plugin": "^8.33.1",
+    "@typescript-eslint/parser": "^8.33.1",
+    "autoprefixer": "^10.4.21",
+    "concurrently": "^9.1.2",
+    "eslint": "^9.22.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-prettier": "^5.4.1",
+    "fake-indexeddb": "^6.0.1",
+    "jest": "^29.7.0",
+    "jest-environment-jsdom": "30.0.0-beta.3",
+    "map-gl-style-switcher": "^0.9.1",
+    "nodemon": "^3.1.9",
+    "postcss": "^8.5.4",
+    "prettier": "^3.5.3",
+    "rimraf": "^6.0.1",
+    "rollup": "^4.37.0",
+    "rollup-plugin-dts": "^6.2.1",
+    "tailwindcss": "^4.1.8",
+    "ts-jest": "^29.2.6",
+    "ts-node": "^10.9.2",
+    "tsconfig-paths": "^4.2.0",
+    "tslib": "^2.8.1",
+    "tsx": "^4.19.3",
+    "typescript": "^5.8.2",
+    "typescript-eslint": "^8.33.1",
+    "vite": "^6.2.3",
+    "vite-tsconfig-paths": "^5.1.4"
+  }
+}