tg-map-vue3 3.0.8 → 3.0.9

package/dist/src/components/TgMap.vue.d.ts

@@ -1,12 +1,13 @@
-import { type PropType, type Prop } from 'vue';
-import type { AbstractMap } from '../map/map/map';
-import { TgMapType } from '../map/map-factory';
 import { LatLng } from '../map/lat-lng';
-import { type InfoWindowMode, GestureHandlingOptions } from '../map/map/map-options';
+import { TgMapType } from '../map/map-factory';
+import type { AbstractMap } from '../map/map/map';
+import { GestureHandlingOptions, type InfoWindowMode } from '../map/map/map-options';
+import { BuildInMapTypeId } from '../map/map/map-type';
+import { type StringEnumValue } from '../utils/mapped-types';
 declare const _default: import("vue").DefineComponent<{
     /** type没做响应式, 但外部可以把type作为tg-map的key, 让type修改时完全重建tg-map */
     type: {
-        type: PropType<TgMapType>;
+        type: import("vue").PropType<StringEnumValue<typeof TgMapType>>;
         default: TgMapType;
     };
     /**
@@ -18,7 +19,7 @@ declare const _default: import("vue").DefineComponent<{
      * @see AbstractMapEventMap.center-changed
      * */
     center: {
-        type: PropType<LatLng>;
+        type: import("vue").PropType<LatLng>;
         required: true;
     };
     /**
@@ -27,7 +28,7 @@ declare const _default: import("vue").DefineComponent<{
      * @see center
      */
     centerSyncDelay: {
-        type: PropType<number>;
+        type: import("vue").PropType<number>;
         default: number;
     };
     /**
@@ -35,39 +36,40 @@ declare const _default: import("vue").DefineComponent<{
      * @see center
      * */
     currentCenter: {
-        type: PropType<LatLng>;
+        type: import("vue").PropType<LatLng>;
     };
     /**
      * 仅用于获取tg-map销毁时的最后的center的值
      * @see center
      */
     lastCenter: {
-        type: PropType<LatLng>;
+        type: import("vue").PropType<LatLng>;
     };
     zoom: {
-        type: PropType<number>;
+        type: import("vue").PropType<number>;
         required: true;
     };
     infoWindowMode: {
-        type: PropType<InfoWindowMode>;
+        type: import("vue").PropType<InfoWindowMode>;
+    };
+    gestureHandling: {
+        type: import("vue").PropType<StringEnumValue<typeof GestureHandlingOptions>>;
     };
-    gestureHandling: Prop<"none" | GestureHandlingOptions | "auto" | "greedy" | "cooperative", "none" | GestureHandlingOptions | "auto" | "greedy" | "cooperative">;
     minZoom: {
-        type: PropType<number>;
+        type: import("vue").PropType<number>;
     };
     maxZoom: {
-        type: PropType<number>;
+        type: import("vue").PropType<number>;
     };
     mapStyle: {
-        type: PropType<any>;
+        type: import("vue").PropType<any>;
     };
-    /** 设置为除BuildInMapTypeId以外的值时, 无实际效果... */
     mapTypeId: {
-        type: PropType<"normal" | "satellite" | "hybrid">;
+        type: import("vue").PropType<StringEnumValue<typeof BuildInMapTypeId>>;
     };
-    /** 优先级比mapTypeId高 */
+    /** 地图类型对象, 优先级比mapTypeId高 */
     mapType: {
-        type: PropType<any>;
+        type: import("vue").PropType<any>;
     };
 }, {
     attrs: {
@@ -83,7 +85,7 @@ declare const _default: import("vue").DefineComponent<{
 }, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
     /** type没做响应式, 但外部可以把type作为tg-map的key, 让type修改时完全重建tg-map */
     type: {
-        type: PropType<TgMapType>;
+        type: import("vue").PropType<StringEnumValue<typeof TgMapType>>;
         default: TgMapType;
     };
     /**
@@ -95,7 +97,7 @@ declare const _default: import("vue").DefineComponent<{
      * @see AbstractMapEventMap.center-changed
      * */
     center: {
-        type: PropType<LatLng>;
+        type: import("vue").PropType<LatLng>;
         required: true;
     };
     /**
@@ -104,7 +106,7 @@ declare const _default: import("vue").DefineComponent<{
      * @see center
      */
     centerSyncDelay: {
-        type: PropType<number>;
+        type: import("vue").PropType<number>;
         default: number;
     };
     /**
@@ -112,42 +114,43 @@ declare const _default: import("vue").DefineComponent<{
      * @see center
      * */
     currentCenter: {
-        type: PropType<LatLng>;
+        type: import("vue").PropType<LatLng>;
     };
     /**
      * 仅用于获取tg-map销毁时的最后的center的值
      * @see center
      */
     lastCenter: {
-        type: PropType<LatLng>;
+        type: import("vue").PropType<LatLng>;
     };
     zoom: {
-        type: PropType<number>;
+        type: import("vue").PropType<number>;
         required: true;
     };
     infoWindowMode: {
-        type: PropType<InfoWindowMode>;
+        type: import("vue").PropType<InfoWindowMode>;
+    };
+    gestureHandling: {
+        type: import("vue").PropType<StringEnumValue<typeof GestureHandlingOptions>>;
     };
-    gestureHandling: Prop<"none" | GestureHandlingOptions | "auto" | "greedy" | "cooperative", "none" | GestureHandlingOptions | "auto" | "greedy" | "cooperative">;
     minZoom: {
-        type: PropType<number>;
+        type: import("vue").PropType<number>;
     };
     maxZoom: {
-        type: PropType<number>;
+        type: import("vue").PropType<number>;
     };
     mapStyle: {
-        type: PropType<any>;
+        type: import("vue").PropType<any>;
     };
-    /** 设置为除BuildInMapTypeId以外的值时, 无实际效果... */
     mapTypeId: {
-        type: PropType<"normal" | "satellite" | "hybrid">;
+        type: import("vue").PropType<StringEnumValue<typeof BuildInMapTypeId>>;
     };
-    /** 优先级比mapTypeId高 */
+    /** 地图类型对象, 优先级比mapTypeId高 */
     mapType: {
-        type: PropType<any>;
+        type: import("vue").PropType<any>;
     };
 }>>, {
-    type: TgMapType;
+    type: StringEnumValue<typeof TgMapType>;
     centerSyncDelay: number;
 }>;
 export default _default;

package/dist/src/components/controls/TgCustomControl.vue.d.ts

@@ -1,7 +1,8 @@
+import { type StringEnumValue } from '../../utils/mapped-types';
 import { ControlPosition, CustomControl } from '../../map/map/controls/control';
 declare const _default: import("vue").DefineComponent<{
     position: {
-        type: import("vue").PropType<ControlPosition>;
+        type: import("vue").PropType<StringEnumValue<typeof ControlPosition>>;
         default: ControlPosition;
     };
 }, {
@@ -10,10 +11,10 @@ declare const _default: import("vue").DefineComponent<{
     recreate(): void;
 }, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}>, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
     position: {
-        type: import("vue").PropType<ControlPosition>;
+        type: import("vue").PropType<StringEnumValue<typeof ControlPosition>>;
         default: ControlPosition;
     };
 }>>, {
-    position: ControlPosition;
+    position: StringEnumValue<typeof ControlPosition>;
 }>;
 export default _default;

package/dist/src/components/controls/TgMapTypeControl.vue.d.ts

@@ -2,11 +2,11 @@ import { MapTypeControlType, type MapTypeControl } from '../../map/map/controls/
 import { ControlPosition } from '../../map/map/controls/control';
 declare const _default: import("vue").DefineComponent<{
     position: {
-        type: import("vue").PropType<ControlPosition>;
+        type: import("vue").PropType<import("../../utils/mapped-types").StringEnumValue<typeof ControlPosition>>;
         default: ControlPosition;
     };
     type: {
-        type: import("vue").PropType<MapTypeControlType>;
+        type: import("vue").PropType<import("../../utils/mapped-types").StringEnumValue<typeof MapTypeControlType>>;
     };
     mapTypes: {
         type: import("vue").PropType<import("../../map/map/map-type").MapType[]>;
@@ -17,16 +17,16 @@ declare const _default: import("vue").DefineComponent<{
     recreate(): void;
 }, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}>, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
     position: {
-        type: import("vue").PropType<ControlPosition>;
+        type: import("vue").PropType<import("../../utils/mapped-types").StringEnumValue<typeof ControlPosition>>;
         default: ControlPosition;
     };
     type: {
-        type: import("vue").PropType<MapTypeControlType>;
+        type: import("vue").PropType<import("../../utils/mapped-types").StringEnumValue<typeof MapTypeControlType>>;
     };
     mapTypes: {
         type: import("vue").PropType<import("../../map/map/map-type").MapType[]>;
     };
 }>>, {
-    position: ControlPosition;
+    position: import("../../utils/mapped-types").StringEnumValue<typeof ControlPosition>;
 }>;
 export default _default;

package/dist/src/components/controls/TgScaleControl.vue.d.ts

@@ -2,7 +2,7 @@ import { ControlPosition } from '../../map/map/controls/control';
 import type { ScaleControl } from '../../map/map/controls/scale.control';
 declare const _default: import("vue").DefineComponent<{
     position: {
-        type: import("vue").PropType<ControlPosition>;
+        type: import("vue").PropType<import("../../utils/mapped-types").StringEnumValue<typeof ControlPosition>>;
         default: ControlPosition;
     };
 }, {
@@ -11,10 +11,10 @@ declare const _default: import("vue").DefineComponent<{
     recreate(): void;
 }, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}>, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
     position: {
-        type: import("vue").PropType<ControlPosition>;
+        type: import("vue").PropType<import("../../utils/mapped-types").StringEnumValue<typeof ControlPosition>>;
         default: ControlPosition;
     };
 }>>, {
-    position: ControlPosition;
+    position: import("../../utils/mapped-types").StringEnumValue<typeof ControlPosition>;
 }>;
 export default _default;

package/dist/src/components/controls/TgZoomControl.vue.d.ts

@@ -2,7 +2,7 @@ import type { ZoomControl } from '../../map/map/controls/zoom.control';
 import { ControlPosition } from '../../map/map/controls/control';
 declare const _default: import("vue").DefineComponent<{
     position: {
-        type: import("vue").PropType<ControlPosition>;
+        type: import("vue").PropType<import("../../utils/mapped-types").StringEnumValue<typeof ControlPosition>>;
         default: ControlPosition;
     };
 }, {
@@ -11,10 +11,10 @@ declare const _default: import("vue").DefineComponent<{
     recreate(): void;
 }, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}>, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
     position: {
-        type: import("vue").PropType<ControlPosition>;
+        type: import("vue").PropType<import("../../utils/mapped-types").StringEnumValue<typeof ControlPosition>>;
         default: ControlPosition;
     };
 }>>, {
-    position: ControlPosition;
+    position: import("../../utils/mapped-types").StringEnumValue<typeof ControlPosition>;
 }>;
 export default _default;

package/dist/src/components/overlays/TgElementOverlay.vue.d.ts

@@ -12,7 +12,7 @@ declare class SimpleElementOverlay extends ElementOverlay {
 }
 declare const TgElementOverlay: import("vue").DefineComponent<{
     mapPane: {
-        type: import("vue").PropType<MapPane>;
+        type: import("vue").PropType<import("../../utils/mapped-types").StringEnumValue<typeof MapPane>>;
         default: MapPane;
     };
     position: {
@@ -27,7 +27,7 @@ declare const TgElementOverlay: import("vue").DefineComponent<{
     recreate(): void;
 }, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}>, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
     mapPane: {
-        type: import("vue").PropType<MapPane>;
+        type: import("vue").PropType<import("../../utils/mapped-types").StringEnumValue<typeof MapPane>>;
         default: MapPane;
     };
     position: {
@@ -35,7 +35,7 @@ declare const TgElementOverlay: import("vue").DefineComponent<{
         required: true;
     };
 }>>, {
-    mapPane: MapPane;
+    mapPane: import("../../utils/mapped-types").StringEnumValue<typeof MapPane>;
 }>;
 type TgElementOverlay = InstanceType<typeof TgElementOverlay>;
 export default TgElementOverlay;

package/dist/src/map/map/baidu-map.d.ts

@@ -1,6 +1,6 @@
 import { LatLng, LatLngBounds } from '../lat-lng';
 import { AbstractMap, type AbstractMapEventMap } from './map';
-import { MapOptions, GestureHandlingOptions, type MapStyle, type GestureHandlingOptionsLiteral } from './map-options';
+import { MapOptions, GestureHandlingOptions, type MapStyle } from './map-options';
 import type { BaiduOverlay } from './overlay/overlay';
 import { BaiduMarkerClusterer, type MarkerClustererOptions } from './extra/marker-clusterer';
 import { BaiduPolyline } from './overlay/polyline';
@@ -23,7 +23,7 @@ export declare class BaiduMap extends AbstractMap {
     private baiduMapType2BIMT;
     private map;
     constructor(element: HTMLElement, mapOptions: MapOptions);
-    setGestureHandling(gestureHandling?: GestureHandlingOptions | GestureHandlingOptionsLiteral): void;
+    setGestureHandling(gestureHandling?: GestureHandlingOptions): void;
     get innerMap(): BMap.Map;
     get coordType(): import("../lat-lng").CoordType;
     addEventListener<K extends keyof AbstractMapEventMap>(type: K, listener: (event: AbstractMapEventMap[K]) => void): void;

package/dist/src/map/map/map-options.d.ts

@@ -18,14 +18,13 @@ export declare enum GestureHandlingOptions {
     /** 合作, 按住ctrl或者双指才能缩放地图 */
     cooperative = "cooperative"
 }
-export type GestureHandlingOptionsLiteral = keyof typeof GestureHandlingOptions;
 export interface MapOptions {
     /** 中心点 */
     center: LatLng;
     /** 缩放等级, 必须是整数 */
     zoom: number;
     infoWindowMode?: InfoWindowMode;
-    gestureHandling?: GestureHandlingOptions | GestureHandlingOptionsLiteral;
+    gestureHandling?: GestureHandlingOptions;
     minZoom?: number;
     maxZoom?: number;
     mapStyle?: MapStyle;

package/dist/src/map/map/map-type.d.ts

@@ -13,7 +13,6 @@ export declare enum BuildInMapTypeId {
     satellite = "satellite",
     hybrid = "hybrid"
 }
-export type BuildInMapTypeIdLiteral = keyof typeof BuildInMapTypeId;
 /**
  * 包括不兼容的地图类型
  * - 'terrain': google中为地形图, baidu中为三维图

package/dist/src/utils/mapped-types.d.ts

@@ -49,6 +49,27 @@ export type KeysMatching<T, V> = {
 export type StringEnumLike = {
     [k: string]: string;
 };
+/**
+ * String枚举的值, 包括`string`类型
+ * @see https://stackoverflow.com/questions/52393730/typescript-string-literal-union-type-from-enum
+ */
+export type StringEnumValue<E extends StringEnumLike> = ValueOf<E> | `${ValueOf<E>}`;
+/**
+ * 包装`T`中的部分枚举字段的值为{@link StringEnumValue}
+ *
+ * 会校验{@link EnumObjects}中的类型是否书写正确, 若写错, 会推断成`never`
+ * */
+export type WrapStringEnumValue<T, EnumObjects extends {
+    [k in keyof T]?: StringEnumLike;
+}> = {
+    [P in keyof T]: P extends keyof EnumObjects ? EnumObjects[P] extends StringEnumLike ? T[P] extends ValueOf<EnumObjects[P]> | undefined ? StringEnumValue<EnumObjects[P]> : never : never : T[P];
+};
+/** 取消包装`T`中的{@link StringEnumValue}字段 */
+export declare function unwrapStringEnumValue<T extends object>(value: T): {
+    [K in keyof T]: T[K] extends StringEnumValue<infer Enum> ? StringEnumLike extends Enum ? T[K] : Enum[keyof Enum] : Exclude<T[K], undefined> extends StringEnumValue<infer Enum> ? StringEnumLike extends Enum ? T[K] : Enum[keyof Enum] | undefined : T[K];
+};
+export declare function unwrapStringEnumValue<E extends StringEnumLike>(value: StringEnumValue<E>, enumObject?: E): E[keyof E];
+export declare function unwrapStringEnumValue<E extends StringEnumLike>(value: StringEnumValue<E> | undefined, enumObject?: E): E[keyof E] | undefined;
 /**
  * 非空的值
  * @see https://github.com/microsoft/TypeScript/issues/7648#issuecomment-541625573

package/dist/src/utils/strings.d.ts

@@ -2,7 +2,8 @@ import type { StringEnumLike } from './mapped-types';
 export declare namespace Strings {
     /**
     * 将string转换成字符枚举, 转换失败返回undefined
-    * @see import('./vue-utils.ts').stringEnumProp 由于使用了Object.values(enumObject), 应该避免在enumObject上添加其他属性/方法
+    * @see {@link import('./vue-utils.ts').stringEnumProp} 由于使用了Object.values(enumObject), 应该避免在enumObject上添加其他属性/方法
+    * @deprecated 使用{@link import('./mapped-types.ts').unwrapStringEnumValue}替代
     */
     function toEnumOrNull<E extends StringEnumLike>(value: string | undefined, enumObject: E): E[keyof E] | undefined;
     function trimIndent(str: string): string;

package/dist/src/utils/vue-utils.d.ts

@@ -1,5 +1,5 @@
 import type { Component, ComponentOptions, ComponentPublicInstance, Prop, PropType, RendererElement, RendererNode, Slots, VNode, WritableComputedOptions } from 'vue';
-import type { AbstractConstructor, KeysMatching, StringEnumLike, Thing } from './mapped-types';
+import type { AbstractConstructor, KeysMatching, StringEnumLike, StringEnumValue, Thing } from './mapped-types';
 /** 组件选项中的hook名 */
 export type VueHookName = ExcludeSubtype<KeysMatching<OmitStartsWith<RemoveIndex<ComponentOptions>, '_'>, {
     (): void;
@@ -39,11 +39,11 @@ type NotNullProp<T = any, D = T> = {
     default: D | (() => D);
 });
 export declare function stringEnumProp<E extends StringEnumLike>(enumObject: E, defaultValue: E[keyof E]): {
-    type: PropType<E[keyof E]>;
+    type: PropType<StringEnumValue<E>>;
     default: E[keyof E];
 };
 export declare function stringEnumProp<E extends StringEnumLike>(enumObject: E): {
-    type: PropType<E[keyof E]>;
+    type: PropType<StringEnumValue<E>>;
 };
 export declare function stringEnumPropFromArray<T extends string>(enums: T[], defaultValue: T): {
     type: PropType<T>;