tg-map-vue3 3.0.2 → 3.0.4

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

@@ -1,18 +1,59 @@
-/// <reference path="../map-mixin.d.ts" />
-/// <reference types="@/global" />
-import { type Props } from '../../utils/vue-utils';
-import type { PolylineOptions, PolylineOverlay } from '../../map/map/overlay/polyline';
-declare const _sfc_main: import('./@vue/compat').DefineComponent<Props<PolylineOptions>, {
+import { type PropType } from 'vue';
+import type { PolylineOverlay } from '../../map/map/overlay/polyline';
+import type { LatLng } from '../../map/lat-lng';
+declare const _default: import("vue").DefineComponent<{
+    path: {
+        type: PropType<LatLng[]>;
+        required: true;
+    };
+    clickable: {
+        type: PropType<boolean>;
+    };
+    editable: {
+        type: PropType<boolean>;
+    };
+    strokeColor: {
+        type: PropType<string>;
+    };
+    strokeOpacity: {
+        type: PropType<number>;
+    };
+    strokeWeight: {
+        type: PropType<number>;
+    };
+    visible: {
+        type: PropType<boolean>;
+    };
+}, {
+    attrs: {
+        binds: Record<string, unknown>;
+        listeners: Record<string, unknown>;
+    };
     polyline: PolylineOverlay;
-}, unknown, {}, {}, import('./@vue/compat').DefineComponent<{}, {}, {}, {}, {
+}, unknown, {}, {}, import("vue").DefineComponent<{}, {}, {}, {}, {
     recreate(): void;
-}, import('./@vue/compat').ComponentOptionsMixin, import('./@vue/compat').ComponentOptionsMixin, {}, string, import('./@vue/compat').VNodeProps & import('./@vue/compat').AllowedComponentProps & import('./@vue/compat').ComponentCustomProps, Readonly<import('./@vue/compat').ExtractPropTypes<{}>>, {}>, import('./@vue/compat').ComponentOptionsMixin, {}, string, import('./@vue/compat').VNodeProps & import('./@vue/compat').AllowedComponentProps & import('./@vue/compat').ComponentCustomProps, Readonly<import('./@vue/compat').ExtractPropTypes<Props<PolylineOptions>>>, {
-    clickable?: any;
-    editable?: any;
-    strokeColor?: any;
-    strokeOpacity?: any;
-    strokeWeight?: any;
-    visible?: any;
-    path: any;
-}>;
-export default _sfc_main;
+}, 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<{
+    path: {
+        type: PropType<LatLng[]>;
+        required: true;
+    };
+    clickable: {
+        type: PropType<boolean>;
+    };
+    editable: {
+        type: PropType<boolean>;
+    };
+    strokeColor: {
+        type: PropType<string>;
+    };
+    strokeOpacity: {
+        type: PropType<number>;
+    };
+    strokeWeight: {
+        type: PropType<number>;
+    };
+    visible: {
+        type: PropType<boolean>;
+    };
+}>>, {}>;
+export default _default;

package/dist/src/map/event.d.ts

@@ -1,5 +1,4 @@
 import type { LatLng } from './lat-lng';
-import type { ComponentPublicInstance } from './@vue/compat';
 /**
  * ## 事件机制对比
  * - DOM: add/removeEventListener, Event {type, target}
@@ -39,7 +38,7 @@ export declare namespace Tg {
         removeEventListener<K extends keyof MAP>(type: K, listener: (this: THIS, event: MAP[K]) => void): void;
     }
 }
-export declare function bindEvents(this: ComponentPublicInstance, target: Tg.EventTarget, excludes?: string[]): void;
+export declare function bindEvents(listeners: Record<string, unknown>, target: Tg.EventTarget, excludes?: string[]): void;
 export declare function generateNextEventListenerId(): number;
 /**
  * JS的Map/object的key都不支持自定义hashCode()/equals(), 故只能生成字符串当作key

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

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

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

package/dist/src/map/map/overlay/baidu-info-box.d.ts

@@ -1,6 +1,7 @@
 /// <reference types="baidumap-web-sdk" />
 import { Point } from '../../types';
 import type { BMarker } from './marker';
+import './baidu-info-box.scss';
 export type BaiduInfoBox = InstanceType<ReturnType<typeof createBaiduInfoBoxClass>>;
 export declare function createBaiduInfoBox(content: HTMLElement, position?: BMap.Point, offset?: Point, zIndex?: number, maxWidth?: number, borderClass?: String): {
     container: HTMLElement;

package/dist/src/map/map/overlay/element-overlay.d.ts

@@ -2,6 +2,7 @@
 import { LatLng } from '../../lat-lng';
 import type { Point } from '../../types';
 import type { AbstractMap } from '../map';
+import './element-overlay.scss';
 export declare enum MapPane {
     map = "map",
     overlay = "overlay",

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

@@ -1 +1 @@
-export declare function dimen(value: string | number | null | undefined): string | null;
+export declare function dimen(value: string | number | null | undefined): string | undefined;

package/dist/src/utils/lifecycle-log.d.ts

@@ -1,4 +1,4 @@
-import { type App } from './@vue/compat';
+import { type App } from 'vue';
 import type { VueHookName } from './vue-utils';
 export interface LifecycleLogOptions {
     /** @default /^[A-Z]/ 匹配大写字母开头的组件名 */

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

@@ -1,11 +1,11 @@
-import type { Component, ComponentPublicInstance } from './@vue/compat';
+import type { Component, ComponentPublicInstance } from "vue";
 /** deep版的 `Partial` */
 export type DeepPartial<T> = {
     [U in keyof T]?: T[U] extends object ? DeepPartial<T[U]> : T[U];
 };
 /**
  * 表示一个构造器
- * {@link import('./@vue/compat/types/options').Constructor}
+ * {@link import('vue/types/options').Constructor}
  * */
 export type Constructor<T = {}> = new (...args: any[]) => T;
 /**
@@ -22,7 +22,7 @@ export type WrapperToPrimitive<T> = T extends Boolean ? boolean : T extends Stri
  * 模仿了kotlin的lateinit关键字
  * */
 export declare function lateinit<T>(): T;
-/** 用来给纯对象的成员加上类型验证 */
+export declare function typed<T>(): T | undefined;
 export declare function typed<T>(t: T): T;
 /**
  * `vue instanceof VueConstructor`时`vue`并不会自动转换成`VueConstructor`的子类, 用该方法可以实现这种转换

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

@@ -1,5 +1,4 @@
-import type { VNode, ComponentPublicInstance, Component } from './@vue/compat';
-import type { ComponentOptions, PropType, PropOptions, PropValidator, WritableComputedOptions } from './@vue/compat';
+import type { Component, ComponentOptions, ComponentPublicInstance, Prop, PropType, RendererElement, RendererNode, Slots, VNode, WritableComputedOptions } from 'vue';
 import type { AbstractConstructor, KeysMatching, StringEnumLike, Thing } from './mapped-types';
 /** 组件选项中的hook名 */
 export type VueHookName = ExcludeSubtype<KeysMatching<OmitStartsWith<RemoveIndex<ComponentOptions>, '_'>, {
@@ -16,31 +15,53 @@ export type Property<T> = T | {
     set?(value: T): void;
 };
 /**
+ * ## Vue2
  * 和typed()联合使用, 写成: `props: typed<Props<Options>>({...})`, 可以将`Options`作为属性的类型声明,
  * ### 注意
  * 1. 对于`Options`中可选的属性, 漏了VSCode不会报错...要小心
  * 2. `...`中理论上来说只要写Vue的纯js式的类型验证信息(Boolean/Number/String/Object/...)就行了, 并且还有ts的类型检查
  * 3. 对于`Options`中可选的`boolean`属性, 若将类型验证信息写为`Boolean`时, 该属性的默认值并不是`undefined`而是`false`, 这和它的类型声明(`boolean | undefined`)不匹配, 推荐写成`optionalProp(Boolean)`
  * 4. 因为存在上述特殊情况, 推荐使用{@link requiredProp},{@link optionalProp}等快捷方法写类型验证信息, 方法的传入参数直接写Vue的纯js式的类型验证信息, 就行了
+ *
+ * ## Vue3
+ * 需要用`props: {...} satisfies Props<Options>`替代`typed()`, 防止{@link NotNullProp}被Vue看成必选的属性
  * */
 export type Props<T> = {
-    [K in keyof T]: PropValidator<T[K]>;
+    [K in keyof T]-?: T[K] extends {} ? NotNullProp<T[K]> : Prop<Exclude<T[K], undefined>>;
+};
+/** 表示一个非空的Prop, `required`为true 或者 设置了`default`的{@link Prop}, 才是非空的Prop */
+type NotNullProp<T = any, D = T> = {
+    type: PropType<T>;
+} & ({
+    required: true;
+} | {
+    default: D | (() => D);
+});
+export declare function stringEnumProp<E extends StringEnumLike>(enumObject: E, defaultValue: E[keyof E]): {
+    type: PropType<E[keyof E]>;
+    default: E[keyof E];
+};
+export declare function stringEnumProp<E extends StringEnumLike>(enumObject: E): {
+    type: PropType<E[keyof E]>;
+};
+export declare function stringEnumPropFromArray<T extends string>(enums: T[], defaultValue: T): {
+    type: PropType<T>;
+    default: T;
+};
+export declare function stringEnumPropFromArray<T extends string>(enums: T[]): {
+    type: PropType<T>;
+};
+export declare function requiredProp<T>(type: PropType<T>): {
+    type: PropType<T>;
+    required: true;
+};
+export declare function optionalProp<T>(type: PropType<T>, defaultValue: T | (() => T)): {
+    type: PropType<T>;
+    default: T;
+};
+export declare function optionalProp<T>(type: PropType<T>): {
+    type: PropType<T>;
 };
-/**
- * 注意: 由于使用了`Object.values(enumObject)`来获取所有枚举值
- * - 若enumObject为数字枚举, 获取出来的值会同时包含枚举名和枚举值, 故不支持
- * - 若enumObject同时是命名空间名, 获取出来的值会包含命名空间上的方法, 应当避免
- *
- * @param enumObject 枚举对象
- * @param defaultValue 默认值
- * @see https://frontendsociety.com/using-a-typescript-interfaces-and-types-as-a-prop-type-in-vuejs-508ab3f83480
- * */
-export declare function stringEnumProp<E extends StringEnumLike>(enumObject: E, defaultValue?: E[keyof E]): PropOptions<E[keyof E]>;
-export declare function stringEnumPropFromArray<T extends string>(enums: T[], defaultValue: T): PropOptions<T>;
-export declare function stringEnumPropFromArray<T extends string>(enums: T[]): PropOptions<T | undefined>;
-export declare function requiredProp<T>(type: PropType<T>): PropOptions<T>;
-export declare function optionalProp<T>(type: PropType<T>, defaultValue: T | (() => T)): PropOptions<T>;
-export declare function optionalProp<T>(type: PropType<T>): PropOptions<T | undefined>;
 /**
  * 保存在this上的属性
  * @param defaultValues 属性的默认值
@@ -65,13 +86,43 @@ export declare function createPropertyObject(obj: any): any;
 export declare function createPropertyObjectTyped<T>(obj: {
     [K in keyof T]: Property<T[K]>;
 }): T;
-export declare function createEmptyVNode(h: any, context: any): VNode;
+/**
+ * 创建空节点
+ *
+ * Vue2中使用`this._e()`创建空节点: https://github.com/vuejs/vue/blob/b6247fc9d7442c50d60ccf366a7cb183a4d02129/src/core/instance/render-helpers/index.js#L28
+ *
+ * Vue3中等价的实现是{@link createCommentVNode}: https://github.com/vuejs/core/blob/650f5c26f464505d9e865bdb0eafb24350859528/packages/runtime-core/src/compat/instance.ts#L162
+ */
+export declare function createEmptyVNode(): VNode;
 /**
  * @see https://github.com/vuejs/vue/blob/43b98fe25151b0b6bacd36f3ee27c5d61add5fdb/packages/weex-vue-framework/factory.js/#L2906
  * */
 export declare function callHook(vm: ComponentPublicInstance, hookName: VueHookName): void;
 /** {@link import('./mapped-types.ts').safeAsComponent} */
 export declare function findByComponentType<T extends Component & AbstractConstructor>(arr: ComponentPublicInstance[], component: T): InstanceType<T> | undefined;
+/**
+ * 通过构造slots内容的方式, 提取出slots中对应{@link component}的VNode, {@link VNode.props}就是当前给组件设置的属性值
+ *
+ * 注意, 该方法并无法获取到{@link component}的实例
+ *
+ * @see https://stackoverflow.com/questions/64154002/vue-3-how-to-get-information-about-children
+ */
+export declare function extractVNodeFromSlotsByComponent<Props>(slots: Slots, component: ComponentOptions<Props>): VNode<RendererNode, RendererElement, Props> | undefined;
+/**
+ * Vue3中 class/style/未声明的事件/未声明的属性 都会集合到{@link SetupContext.attrs}中
+ * 默认情况下({@link ComponentOptions.inheritAttrs}为true), 将被透传给组件的根节点
+ *
+ * 而Vue2, 默认只会透传 未声明的属性, 事件通过`$listeners`暴露
+ *
+ * 这里模仿Vue2的行为, 拆分出未声明的事件, 方便将他们透传给地图的对象
+ *
+ * @see https://cn.vuejs.org/guide/components/attrs.html#disabling-attribute-inheritance
+ * @see https://v3-migration.vuejs.org/zh/breaking-changes/listeners-removed.html
+ */
+export declare function splitAttrs(attrs: Record<string, unknown>): {
+    binds: Record<string, unknown>;
+    listeners: Record<string, unknown>;
+};
 export declare const eventLogMethods: {
     /**
      * @event 一般来说传{@link Tg.Event}对象, 但传其他对象也不会报错
@@ -80,3 +131,4 @@ export declare const eventLogMethods: {
     /** @see eventLog */
     eventLogLess(this: any, event: Thing | null | undefined): void;
 };
+export {};

package/dist/style.css

@@ -1 +1 @@
-.baidu-info-box-container{transform:translateY(-11px);font-size:13px;font-weight:300;width:100vw}.baidu-info-box-container__border{position:absolute;padding:12px;background-color:#fff;box-shadow:0 2px 7px 1px #0000004d;border-radius:8px;transform:translate(-50%,-100%)}.baidu-info-box-container__inner{overflow:auto}.baidu-info-box-container__close{position:absolute;right:-6px;top:-6px;width:14px;height:14px;margin:8px;opacity:.6;cursor:pointer}.baidu-info-box-container__close:hover{opacity:1}.baidu-info-box-container:after{position:absolute;background-color:#fff;content:"";width:15px;height:15px;left:0px;top:0px;box-shadow:-2px 2px 2px #b2b2b266;transform:translate(-50%,-50%) rotate(-45deg)}.tg-map{height:100vh;position:relative}.tg-map__map{width:100%;height:100%}.tg-map-widget{position:absolute}.tg-map>.tg-custom-control{display:none}.tg-map .tg-label{display:none}.tg-map__map .tg-label{display:block}.tg-map .tg-info-box{display:none}.tg-map__map .tg-info-box{display:block}.element-overlay{position:absolute}.tg-map .tg-element-overlay{display:none}.tg-map__map .tg-element-overlay{display:block}
+.baidu-info-box-container{transform:translateY(-11px);font-size:13px;font-weight:300;width:100vw}.baidu-info-box-container__border{position:absolute;padding:12px;background-color:#fff;box-shadow:0 2px 7px 1px #0000004d;border-radius:8px;transform:translate(-50%,-100%)}.baidu-info-box-container__inner{overflow:auto}.baidu-info-box-container__close{position:absolute;right:-6px;top:-6px;width:14px;height:14px;margin:8px;opacity:.6;cursor:pointer}.baidu-info-box-container__close:hover{opacity:1}.baidu-info-box-container:after{position:absolute;background-color:#fff;content:"";width:15px;height:15px;left:0px;top:0px;box-shadow:-2px 2px 2px #b2b2b266;transform:translate(-50%,-50%) rotate(-45deg)}.tg-map{height:100vh;position:relative}.tg-map__map{width:100%;height:100%}.tg-map-widget{position:absolute}.tg-map>.tg-custom-control{display:none}.element-overlay{position:absolute}.tg-map .tg-element-overlay{display:none}.tg-map__map .tg-element-overlay{display:block}.tg-map .tg-info-box{display:none}.tg-map__map .tg-info-box{display:block}.tg-map .tg-label{display:none}.tg-map__map .tg-label{display:block}