expo-gaode-map-web-api 1.0.1-next.0

package/build/index.d.ts

@@ -0,0 +1,91 @@
+/**
+ * 高德地图 Web API 模块
+ *
+ * 提供基于高德地图 Web API 的各种服务，包括：
+ * - 地理编码/逆地理编码
+ * - 路径规划（驾车、步行、骑行、电动车、公交）
+ * - POI 搜索（关键字搜索、周边搜索、多边形搜索）
+ * - 输入提示（搜索建议）
+ *
+ *
+ * @example
+ * ```typescript
+ * import { GaodeWebAPI } from 'expo-gaode-map-web-api';
+ *
+ * // 创建实例
+ * const api = new GaodeWebAPI();
+ *
+ * // 逆地理编码
+ * const result = await api.geocode.regeocode('116.481028,39.989643');
+ * console.log(result.regeocode.formatted_address);
+ *
+ * // 地理编码
+ * const result = await api.geocode.geocode('北京市朝阳区阜通东大街6号');
+ * console.log(result.geocodes[0].location);
+ *
+ * // 驾车路径规划
+ * const route = await api.route.driving('116.481028,39.989643', '116.434446,39.90816');
+ * console.log(`距离：${route.route.paths[0].distance}米`);
+ *
+ * // POI 搜索
+ * const pois = await api.poi.search('肯德基', { city: '北京' });
+ * console.log(`找到 ${pois.count} 个结果`);
+ *
+ * // 输入提示
+ * const tips = await api.inputTips.getTips('肯德基', { city: '北京' });
+ * console.log(`找到 ${tips.count} 个建议`);
+ * ```
+ */
+import { ClientConfig } from './utils/client';
+import { GeocodeService } from './services/GeocodeService';
+import { RouteService } from './services/RouteService';
+import { POIService } from './services/POIService';
+import { InputTipsService } from './services/InputTipsService';
+export * from './types/geocode.types';
+export * from './types/route.types';
+export * from './types/inputtips.types';
+export type { POISearchParams, POIAroundParams, POIPolygonParams, POIDetailParams, POIInfo, POISearchResponse, } from './types/poi.types';
+export type { ClientConfig, APIError } from './utils/client';
+export { GaodeAPIError } from './utils/client';
+export { getErrorInfo, isSuccess, ERROR_CODE_MAP } from './utils/errorCodes';
+export type { InfoCode, ErrorInfo } from './utils/errorCodes';
+/**
+ * 高德地图 Web API 主类
+ */
+export declare class GaodeWebAPI {
+    private client;
+    /** 地理编码服务 */
+    geocode: GeocodeService;
+    /** 路径规划服务 */
+    route: RouteService;
+    /** POI 搜索服务 */
+    poi: POIService;
+    /** 输入提示服务 */
+    inputTips: InputTipsService;
+    /**
+     * 创建高德地图 Web API 实例
+     *
+     * @param config 配置选项（可选）
+     *
+     * @example
+     * ```typescript
+     * const api = new GaodeWebAPI({
+     *   key: 'your-web-api-key',
+     *   timeout: 10000
+     * });
+     * ```
+     */
+    constructor(config?: ClientConfig);
+    /**
+     * 更新 API Key
+     */
+    setKey(key: string): void;
+    /**
+     * 获取当前 API Key
+     */
+    getKey(): string;
+}
+/**
+ * 创建默认导出，方便使用
+ */
+export default GaodeWebAPI;

package/build/index.js

@@ -0,0 +1,186 @@
+"use strict";
+/**
+ * 高德地图 Web API 模块
+ *
+ * 提供基于高德地图 Web API 的各种服务，包括：
+ * - 地理编码/逆地理编码
+ * - 路径规划（驾车、步行、骑行、电动车、公交）
+ * - POI 搜索（关键字搜索、周边搜索、多边形搜索）
+ * - 输入提示（搜索建议）
+ *
+ *
+ * @example
+ * ```typescript
+ * import { GaodeWebAPI } from 'expo-gaode-map-web-api';
+ *
+ * // 创建实例
+ * const api = new GaodeWebAPI();
+ *
+ * // 逆地理编码
+ * const result = await api.geocode.regeocode('116.481028,39.989643');
+ * console.log(result.regeocode.formatted_address);
+ *
+ * // 地理编码
+ * const result = await api.geocode.geocode('北京市朝阳区阜通东大街6号');
+ * console.log(result.geocodes[0].location);
+ *
+ * // 驾车路径规划
+ * const route = await api.route.driving('116.481028,39.989643', '116.434446,39.90816');
+ * console.log(`距离：${route.route.paths[0].distance}米`);
+ *
+ * // POI 搜索
+ * const pois = await api.poi.search('肯德基', { city: '北京' });
+ * console.log(`找到 ${pois.count} 个结果`);
+ *
+ * // 输入提示
+ * const tips = await api.inputTips.getTips('肯德基', { city: '北京' });
+ * console.log(`找到 ${tips.count} 个建议`);
+ * ```
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GaodeWebAPI = exports.ERROR_CODE_MAP = exports.isSuccess = exports.getErrorInfo = exports.GaodeAPIError = void 0;
+/**
+ * 在加载 Web API 模块前，强制校验“基础地图提供者”是否已安装。
+ * 支持以下任一包：
+ *  - expo-gaode-map（核心地图包）
+ *  - expo-gaode-map-navigation（导航包，内置地图能力）
+ * 这样可避免导航与核心包 SDK 冲突时无法使用的问题。
+ */
+function ensureBaseInstalled() {
+    let installed = false;
+    try {
+        // eslint-disable-next-line @typescript-eslint/no-var-requires
+        require('expo-gaode-map');
+        installed = true;
+    }
+    catch (_) {
+        try {
+            // eslint-disable-next-line @typescript-eslint/no-var-requires
+            require('expo-gaode-map-navigation');
+            installed = true;
+        }
+        catch (_) {
+            installed = false;
+        }
+    }
+    if (!installed) {
+        const msg = '[expo-gaode-map-web-api] 需要先安装基础地图组件，支持以下任一包：\n' +
+            '  - expo-gaode-map（核心地图包），或\n' +
+            '  - expo-gaode-map-navigation（导航包，内置地图能力）\n' +
+            '请先安装并完成原生配置后再重试。';
+        throw new Error(msg);
+    }
+}
+ensureBaseInstalled();
+const client_1 = require("./utils/client");
+const GeocodeService_1 = require("./services/GeocodeService");
+const RouteService_1 = require("./services/RouteService");
+const POIService_1 = require("./services/POIService");
+const InputTipsService_1 = require("./services/InputTipsService");
+/**
+ * 从核心包解析 getWebKey（运行时解析，避免类型导出时序问题）
+ */
+function resolveWebKey() {
+    // 1) 尝试从核心地图包读取
+    try {
+        // eslint-disable-next-line @typescript-eslint/no-var-requires
+        const core = require('expo-gaode-map');
+        const fn = core?.getWebKey;
+        if (typeof fn === 'function') {
+            return fn();
+        }
+    }
+    catch {
+        // ignore
+    }
+    // 2) 若未安装核心包，则尝试从导航包读取（导航内置地图）
+    try {
+        // eslint-disable-next-line @typescript-eslint/no-var-requires
+        const nav = require('expo-gaode-map-navigation');
+        const fn2 = nav?.getWebKey;
+        if (typeof fn2 === 'function') {
+            return fn2();
+        }
+    }
+    catch {
+        // ignore
+    }
+    return undefined;
+}
+// 导出类型
+__exportStar(require("./types/geocode.types"), exports);
+__exportStar(require("./types/route.types"), exports);
+__exportStar(require("./types/inputtips.types"), exports);
+var client_2 = require("./utils/client");
+Object.defineProperty(exports, "GaodeAPIError", { enumerable: true, get: function () { return client_2.GaodeAPIError; } });
+// 错误码相关导出
+var errorCodes_1 = require("./utils/errorCodes");
+Object.defineProperty(exports, "getErrorInfo", { enumerable: true, get: function () { return errorCodes_1.getErrorInfo; } });
+Object.defineProperty(exports, "isSuccess", { enumerable: true, get: function () { return errorCodes_1.isSuccess; } });
+Object.defineProperty(exports, "ERROR_CODE_MAP", { enumerable: true, get: function () { return errorCodes_1.ERROR_CODE_MAP; } });
+/**
+ * 高德地图 Web API 主类
+ */
+class GaodeWebAPI {
+    /**
+     * 创建高德地图 Web API 实例
+     *
+     * @param config 配置选项（可选）
+     *
+     * @example
+     * ```typescript
+     * const api = new GaodeWebAPI({
+     *   key: 'your-web-api-key',
+     *   timeout: 10000
+     * });
+     * ```
+     */
+    constructor(config = {}) {
+        const webKey = resolveWebKey();
+        if (!webKey) {
+            throw new Error('[expo-gaode-map-web-api] 必须先通过 ExpoGaodeMapModule.initSDK({ webKey }) 初始化并提供 Web API Key。\n' +
+                '请在应用启动时调用：\n' +
+                "  import { ExpoGaodeMapModule } from 'expo-gaode-map';\n" +
+                '  ExpoGaodeMapModule.initSDK({ webKey: \"your-web-api-key\", iosKey, androidKey });\n' +
+                '随后再创建 GaodeWebAPI 实例使用 Web API 能力。');
+        }
+        // 强制使用核心模块中的 webKey，避免直接在此处绕过初始化约束
+        const effectiveConfig = { ...config, key: webKey };
+        this.client = new client_1.GaodeWebAPIClient(effectiveConfig);
+        this.geocode = new GeocodeService_1.GeocodeService(this.client);
+        this.route = new RouteService_1.RouteService(this.client);
+        this.poi = new POIService_1.POIService(this.client);
+        this.inputTips = new InputTipsService_1.InputTipsService(this.client);
+    }
+    /**
+     * 更新 API Key
+     */
+    setKey(key) {
+        this.client.setKey(key);
+    }
+    /**
+     * 获取当前 API Key
+     */
+    getKey() {
+        return this.client.getKey();
+    }
+}
+exports.GaodeWebAPI = GaodeWebAPI;
+/**
+ * 创建默认导出，方便使用
+ */
+exports.default = GaodeWebAPI;

package/build/services/GeocodeService.d.ts

@@ -0,0 +1,97 @@
+/**
+ * 高德地图 Web API - 地理编码服务
+ */
+import { GaodeWebAPIClient } from '../utils/client';
+import type { RegeocodeParams, RegeocodeResponse, GeocodeResponse } from '../types/geocode.types';
+/**
+ * 地理编码服务
+ */
+export declare class GeocodeService {
+    private client;
+    constructor(client: GaodeWebAPIClient);
+    /**
+     * 逆地理编码
+     * 将经纬度坐标转换为地址信息
+     *
+     * @param location 经纬度坐标，格式：经度,纬度 或 { longitude, latitude }
+     * @param options 可选参数
+     * @returns 地址信息
+     *
+     * @example
+     * ```typescript
+     * // 方式1：使用字符串
+     * const result = await geocode.regeocode('116.481028,39.989643');
+     *
+     * // 方式2：使用对象
+     * const result = await geocode.regeocode({
+     *   longitude: 116.481028,
+     *   latitude: 39.989643
+     * });
+     *
+     * // 方式3：带可选参数
+     * const result = await geocode.regeocode('116.481028,39.989643', {
+     *   extensions: 'all',
+     *   radius: 1000
+     * });
+     *
+     * console.log(result.regeocode.formatted_address);
+     * // 输出：北京市朝阳区阜通东大街6号
+     * ```
+     */
+    regeocode(location: string | {
+        longitude: number;
+        latitude: number;
+    }, options?: Omit<RegeocodeParams, 'location'>): Promise<RegeocodeResponse>;
+    /**
+     * 地理编码
+     * 将地址转换为经纬度坐标
+     *
+     * @param address 地址
+     * @param city 可选，指定查询的城市
+     * @returns 坐标信息
+     *
+     * @example
+     * ```typescript
+     * // 基础用法
+     * const result = await geocode.geocode('北京市朝阳区阜通东大街6号');
+     * console.log(result.geocodes[0].location);
+     * // 输出：116.481028,39.989643
+     *
+     * // 指定城市
+     * const result = await geocode.geocode('阜通东大街6号', '北京');
+     * ```
+     */
+    geocode(address: string, city?: string): Promise<GeocodeResponse>;
+    /**
+     * 批量逆地理编码
+     *
+     * @param locations 坐标列表
+     * @param options 可选参数
+     * @returns 地址信息列表
+     *
+     * @example
+     * ```typescript
+     * const result = await geocode.batchRegeocode([
+     *   '116.481028,39.989643',
+     *   '116.434446,39.90816'
+     * ]);
+     * ```
+     */
+    batchRegeocode(locations: string[], options?: Omit<RegeocodeParams, 'location' | 'batch'>): Promise<RegeocodeResponse>;
+    /**
+     * 批量地理编码
+     *
+     * @param addresses 地址列表
+     * @param city 可选，指定查询的城市
+     * @returns 坐标信息列表
+     *
+     * @example
+     * ```typescript
+     * const result = await geocode.batchGeocode([
+     *   '北京市朝阳区阜通东大街6号',
+     *   '北京市朝阳区望京SOHO'
+     * ], '北京');
+     * ```
+     */
+    batchGeocode(addresses: string[], city?: string): Promise<GeocodeResponse>;
+}

package/build/services/GeocodeService.js

@@ -0,0 +1,133 @@
+"use strict";
+/**
+ * 高德地图 Web API - 地理编码服务
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GeocodeService = void 0;
+/**
+ * 地理编码服务
+ */
+class GeocodeService {
+    constructor(client) {
+        this.client = client;
+    }
+    /**
+     * 逆地理编码
+     * 将经纬度坐标转换为地址信息
+     *
+     * @param location 经纬度坐标，格式：经度,纬度 或 { longitude, latitude }
+     * @param options 可选参数
+     * @returns 地址信息
+     *
+     * @example
+     * ```typescript
+     * // 方式1：使用字符串
+     * const result = await geocode.regeocode('116.481028,39.989643');
+     *
+     * // 方式2：使用对象
+     * const result = await geocode.regeocode({
+     *   longitude: 116.481028,
+     *   latitude: 39.989643
+     * });
+     *
+     * // 方式3：带可选参数
+     * const result = await geocode.regeocode('116.481028,39.989643', {
+     *   extensions: 'all',
+     *   radius: 1000
+     * });
+     *
+     * console.log(result.regeocode.formatted_address);
+     * // 输出：北京市朝阳区阜通东大街6号
+     * ```
+     */
+    async regeocode(location, options) {
+        // 处理坐标参数
+        let locationStr;
+        if (typeof location === 'string') {
+            locationStr = location;
+        }
+        else {
+            locationStr = `${location.longitude},${location.latitude}`;
+        }
+        // 构建请求参数
+        const params = {
+            location: locationStr,
+            ...options,
+        };
+        // 发起请求
+        return this.client.request('/v3/geocode/regeo', params);
+    }
+    /**
+     * 地理编码
+     * 将地址转换为经纬度坐标
+     *
+     * @param address 地址
+     * @param city 可选，指定查询的城市
+     * @returns 坐标信息
+     *
+     * @example
+     * ```typescript
+     * // 基础用法
+     * const result = await geocode.geocode('北京市朝阳区阜通东大街6号');
+     * console.log(result.geocodes[0].location);
+     * // 输出：116.481028,39.989643
+     *
+     * // 指定城市
+     * const result = await geocode.geocode('阜通东大街6号', '北京');
+     * ```
+     */
+    async geocode(address, city) {
+        const params = {
+            address,
+            city,
+        };
+        return this.client.request('/v3/geocode/geo', params);
+    }
+    /**
+     * 批量逆地理编码
+     *
+     * @param locations 坐标列表
+     * @param options 可选参数
+     * @returns 地址信息列表
+     *
+     * @example
+     * ```typescript
+     * const result = await geocode.batchRegeocode([
+     *   '116.481028,39.989643',
+     *   '116.434446,39.90816'
+     * ]);
+     * ```
+     */
+    async batchRegeocode(locations, options) {
+        const params = {
+            location: locations.join('|'),
+            batch: true,
+            ...options,
+        };
+        return this.client.request('/v3/geocode/regeo', params);
+    }
+    /**
+     * 批量地理编码
+     *
+     * @param addresses 地址列表
+     * @param city 可选，指定查询的城市
+     * @returns 坐标信息列表
+     *
+     * @example
+     * ```typescript
+     * const result = await geocode.batchGeocode([
+     *   '北京市朝阳区阜通东大街6号',
+     *   '北京市朝阳区望京SOHO'
+     * ], '北京');
+     * ```
+     */
+    async batchGeocode(addresses, city) {
+        const params = {
+            address: addresses.join('|'),
+            batch: true,
+            city,
+        };
+        return this.client.request('/v3/geocode/geo', params);
+    }
+}
+exports.GeocodeService = GeocodeService;

package/build/services/InputTipsService.d.ts

@@ -0,0 +1,103 @@
+/**
+ * 高德地图 Web API - 输入提示服务
+ *
+ */
+import { GaodeWebAPIClient } from '../utils/client';
+import type { InputTipsParams, InputTipsResponse } from '../types/inputtips.types';
+/**
+ * 输入提示服务
+ * 提供根据用户输入的关键词查询返回建议列表
+ */
+export declare class InputTipsService {
+    private client;
+    constructor(client: GaodeWebAPIClient);
+    /**
+     * 获取输入提示
+     * 根据用户输入的关键词返回建议列表
+     *
+     * @param keywords 查询关键词
+     * @param options 可选参数
+     * @returns 输入提示结果
+     *
+     * @example
+     * ```typescript
+     * // 基础搜索
+     * const result = await inputTips.getTips('肯德基');
+     *
+     * // 指定城市搜索
+     * const result = await inputTips.getTips('肯德基', {
+     *   city: '北京',
+     *   citylimit: true
+     * });
+     *
+     * // 指定位置和类型
+     * const result = await inputTips.getTips('银行', {
+     *   location: '116.481488,39.990464',
+     *   type: '150100',
+     *   city: '010'
+     * });
+     *
+     * // 搜索公交站点
+     * const result = await inputTips.getTips('天安门', {
+     *   city: '北京',
+     *   datatype: 'bus'
+     * });
+     *
+     * // 搜索公交线路
+     * const result = await inputTips.getTips('1路', {
+     *   city: '北京',
+     *   datatype: 'busline'
+     * });
+     * ```
+     */
+    getTips(keywords: string, options?: Omit<InputTipsParams, 'keywords'>): Promise<InputTipsResponse>;
+    /**
+     * 获取 POI 输入提示
+     * 仅返回 POI 类型的建议
+     *
+     * @param keywords 查询关键词
+     * @param options 可选参数
+     * @returns 输入提示结果
+     *
+     * @example
+     * ```typescript
+     * const result = await inputTips.getPOITips('餐厅', {
+     *   city: '北京',
+     *   type: '050000'
+     * });
+     * ```
+     */
+    getPOITips(keywords: string, options?: Omit<InputTipsParams, 'keywords' | 'datatype'>): Promise<InputTipsResponse>;
+    /**
+     * 获取公交站点输入提示
+     * 仅返回公交站点类型的建议
+     *
+     * @param keywords 查询关键词
+     * @param options 可选参数
+     * @returns 输入提示结果
+     *
+     * @example
+     * ```typescript
+     * const result = await inputTips.getBusTips('天安门', {
+     *   city: '北京'
+     * });
+     * ```
+     */
+    getBusTips(keywords: string, options?: Omit<InputTipsParams, 'keywords' | 'datatype'>): Promise<InputTipsResponse>;
+    /**
+     * 获取公交线路输入提示
+     * 仅返回公交线路类型的建议
+     *
+     * @param keywords 查询关键词
+     * @param options 可选参数
+     * @returns 输入提示结果
+     *
+     * @example
+     * ```typescript
+     * const result = await inputTips.getBuslineTips('1路', {
+     *   city: '北京'
+     * });
+     * ```
+     */
+    getBuslineTips(keywords: string, options?: Omit<InputTipsParams, 'keywords' | 'datatype'>): Promise<InputTipsResponse>;
+}