annil 1.7.4 → 1.7.5-beta.4

package/dist/api/SubComponent/SubEvents/SubEventsConstraint.d.ts

@@ -3,6 +3,9 @@ import type { IfExtends } from "hry-types/src/Any/IfExtends";
 import type { Detail, WMBaseEvent } from "../../../types/OfficialTypeAlias";
 import type { ComponentDoc } from "../../DefineComponent/ReturnType/ComponentDoc";
 import type { Bubbles, Capture, CustomEventsTags } from "../../RootComponent/CustomEvents/CustomEventsTag";
+/**
+ * 把组件事件类型转为函数类型,冒泡事件捕获事件会多一个加后缀(_catch)的key,表示阻止事件冒泡和捕获。
+ */
 export type SubEventsConstraint<CompDoc extends ComponentDoc> = {
     [k in keyof CompDoc["customEvents"] as Contains<CompDoc["customEvents"][k], Bubbles | Capture> extends true ? (k | `${k & string}_catch`) : k]?: (e: IfExtends<WMBaseEvent, CompDoc["customEvents"][k], WMBaseEvent, Detail<Exclude<CompDoc["customEvents"][k], CustomEventsTags>>>) => void;
 };

package/dist/api/SubComponent/SubEvents/SubEventsOptions.d.ts

@@ -1,4 +1,9 @@
 import type { G } from "hry-types";
 export type SubEventsOption<TSubEvents, SubEventsDoc extends object, legalKeys extends PropertyKey> = {
+    /**
+     * 子组件事件(基础事件|自定义事件)
+     * 可使用内部泛型(Detail、Mark、WMBaseEvent、WMCustomEvent、CurrentTargetDataset、TargetDataset)自定义事件类型
+     * 非法字段检测(除了组件事件的key均属于非法字段)
+     */
     events?: TSubEvents & G.IllegalFieldValidator<SubEventsDoc, legalKeys>;
 };

package/dist/api/SubComponent/SubInherit/SubInheritConstraint.d.ts

@@ -3,6 +3,10 @@ import type { RemoveInnerData } from "../../../types/RemoveInnerData";
 import type { ComponentDoc } from "../../DefineComponent/ReturnType/ComponentDoc";
 type WXMLSign = "wxml";
 type unionAddList<Keys extends string> = Keys | Keys[];
+/**
+ * 子组件inherit字段约束,key为构建组件所需的properties字段,类型为根组件数据的key或key[]或`WXMLSign`。要求根数据类型为子数据类型的子类型。当key的值来自wxml(循环产生的子数据等情况)时用`WXMLSign`表示。
+ * @returns object
+ */
 export type InheritConstraint<AllRootData extends object, TComponentDoc extends ComponentDoc> = {
     [k in keyof TComponentDoc["properties"]]?: unionAddList<RemoveInnerData<SelectKeys<AllRootData, TComponentDoc["properties"][k]> & string>> | WXMLSign;
 };

package/dist/api/SubComponent/SubInherit/SubInheritOption.d.ts

@@ -1,4 +1,9 @@
 import type { G } from "hry-types";
 export type SubInheritOption<TInherit extends object, legalKeys extends PropertyKey> = {
-    inherit?: TInherit & G.IllegalFieldValidator<TInherit, legalKeys, 0, "">;
+    /**
+     * 继承来自根组件的数据(key)或'wxml',wxml表示数据来自`.wxml`文件(例如数据来自父元素循环wx:for的数据).
+     * inherit字段最终会在选项中删除,它的存在是为了ts开发时提供心智模型(类型检测),js开发好比注释功能.便于代码阅读。
+     * 带类型检测
+     */
+    inherit?: TInherit & G.IllegalFieldValidator<TInherit, legalKeys>;
 };

package/dist/api/SubComponent/SubMethods/SubMethodsConstraint.d.ts

@@ -1,4 +1,2 @@
 import type { Func } from "hry-types/src/Misc/Func";
-export type SubMethodsConstraint = {
-    [x: string]: Func;
-};
+export type SubMethodsConstraint = Record<string, Func>;

package/dist/api/SubComponent/SubMethods/SubMethodsOption.d.ts

@@ -2,5 +2,8 @@ import type { G } from "hry-types";
 import type { PrefixValidator } from "hry-types/src/Generic/PrefixValidator";
 import type { SubMethodsConstraint } from "./SubMethodsConstraint";
 export type SubMethodsOption<TSubMethods extends SubMethodsConstraint, TPrefix extends string, ExcludedKeys extends PropertyKey> = {
+    /**
+     * 前缀检测和重复检测(与events和组件customEvents字段)
+     */
     methods?: TSubMethods & PrefixValidator<TSubMethods, TPrefix> & G.DuplicateFieldValidator<TSubMethods, ExcludedKeys>;
 };

package/dist/api/SubComponent/SubStore/SubStoreConstraint.d.ts

@@ -1,3 +1,7 @@
+/**
+ * 子组件Data字段约束
+ * @returns 当剩余对象不为空对象,约束对象的key为剩余key,类型为剩余key对应的文档类型或函数返回类型。
+ */
 export type SubStoreConstraint<legal extends object> = {
     [k in keyof legal]?: () => legal[k];
 };

package/dist/api/SubComponent/SubStore/SubStoreOption.d.ts

@@ -1,4 +1,18 @@
 import type { G } from "hry-types";
 export type SubStoreOption<TSubStore extends object, legalKeys extends PropertyKey> = {
+    /**
+     * 全局响应式数据字段,全局store对应数据变化实例对应数据自动setData。
+     * 约束为组件properties字段去除inherit和data的剩余字段和内部字段
+     * 有非法字段(除了约束字段外的字段)检测
+     * @example
+     * ```ts
+     * {
+     *   //...
+     *   store: {
+     *     aaa_str: () => sroreX.str,
+     *   },
+     * }
+     * ```
+     */
     store?: TSubStore & G.IllegalFieldValidator<TSubStore, legalKeys, 0, "", "与inherit和data字段重复或前缀错误">;
 };

package/dist/api/SubComponent/index.d.ts

@@ -1,13 +1,13 @@
 import type { IfExtends } from "hry-types/src/Any/IfExtends";
 import type { EmptyObject } from "hry-types/src/Misc/EmptyObject";
+import type { Func } from "hry-types/src/Misc/Func";
 import type { RequiredKeys } from "hry-types/src/Object/RequiredKeys";
 import type { GetComponentPrefix } from "../../types/GetComponentPrefix";
-import type { ReplacePrefix } from "../../types/ReplacePrefix";
-import type { ComponentDoc } from "../DefineComponent/ReturnType/ComponentDoc";
-import type { Func } from "hry-types/src/Misc/Func";
 import type { InnerFields } from "../../types/InnerData";
 import type { WMCompOtherOption } from "../../types/OfficialTypeAlias";
 import type { Replace } from "../../types/Replace";
+import type { ReplacePrefix } from "../../types/ReplacePrefix";
+import type { ComponentDoc } from "../DefineComponent/ReturnType/ComponentDoc";
 import type { IInjectStore } from "../InstanceInject/instanceConfig";
 import type { ComputedConstraint } from "../RootComponent/Computed/ComputedConstraint";
 import type { DataConstraint } from "../RootComponent/Data/DataConstraint";
@@ -37,11 +37,13 @@ import type { SubStoreConstraint } from "./SubStore/SubStoreConstraint";
 import type { SubStoreOption } from "./SubStore/SubStoreOption";
 import type { SubWatchOption } from "./SubWatch/SubWatchOption";
 type Options<RootDoc extends RootComponentDoc, IsPage extends boolean, CurrentCompDoc extends ComponentDoc, Prefix extends string, AllRootDataDoc extends object, TInherit extends object, TSubData extends object, TSubStore extends object, TSubComputed extends object, TEvents extends object, TSubMethods extends SubMethodsConstraint, InheritDoc extends object, SubDataDoc extends object, SubStoreDoc extends object, SubComputedDoc extends object, SubEventsDoc extends object, SubMethodsDoc extends object, CompDocKeys extends PropertyKey = keyof CurrentCompDoc["properties"]> = SubInheritOption<TInherit, CompDocKeys> & SubDataOption<TSubData, Exclude<CompDocKeys, (keyof InheritDoc)> | InnerFields<Prefix>> & SubStoreOption<TSubStore, Exclude<CompDocKeys, (keyof (InheritDoc & SubDataDoc))> | InnerFields<Prefix>> & SubComputedOption<TSubComputed, Exclude<CompDocKeys, (keyof (InheritDoc & SubDataDoc & SubStoreDoc))> | InnerFields<Prefix>> & SubEventsOption<TEvents, SubEventsDoc, keyof SubEventsConstraint<CurrentCompDoc>> & SubMethodsOption<TSubMethods, Prefix, keyof (CurrentCompDoc["customEvents"] & SubEventsDoc)> & SubPageLifetimesOption<IsPage, NonNullable<RootDoc["properties"]>> & SubLifetimesOption & SubWatchOption<SubComputedDoc & SubDataDoc & AllRootDataDoc & SubStoreDoc & IInjectStore> & Partial<Omit<WMCompOtherOption, "pageLifetimes" | "definitionFilter" | "export" | "observers" | "relations">> & SubObserversOption<SubComputedDoc & SubDataDoc & AllRootDataDoc & SubStoreDoc & IInjectStore> & ThisType<SubInstance<SubMethodsDoc & RootDoc["methods"], Replace<SubDataDoc, Required<CurrentCompDoc["properties"]>>, AllRootDataDoc & Replace<SubDataDoc & SubComputedDoc & SubStoreDoc, Required<CurrentCompDoc["properties"]>>, NonNullable<RootDoc["customEvents"]>, SubStoreDoc>>;
-type SubComponentConstructor<TRootDoc extends RootComponentDoc, TOriginalCompDoc extends ComponentDoc, TSupplementalPrefix extends string = "", IsPage extends boolean = TRootDoc["isPage"] extends true ? true : false, CurrentPrefix extends string = `${GetComponentPrefix<TOriginalCompDoc>}${Capitalize<TSupplementalPrefix>}`, CurrentCompDoc extends ComponentDoc = IfExtends<TSupplementalPrefix, "", TOriginalCompDoc, ReplacePrefix<TOriginalCompDoc, CurrentPrefix>>, AllRootDataDoc extends object = Required<TRootDoc["properties"]> & TRootDoc["data"] & TRootDoc["computed"] & TRootDoc["store"]> = {
-    <TInherit extends InheritConstraint<AllRootDataDoc, CurrentCompDoc>, TSubData extends SubDataConstraint<Omit<Required<CurrentCompDoc["properties"]>, keyof InheritDoc> & Record<InnerFields<CurrentPrefix>, unknown>>, TSubStore extends SubStoreConstraint<Omit<Required<CurrentCompDoc["properties"]>, keyof (InheritDoc & SubDataDoc)> & Record<InnerFields<CurrentPrefix>, unknown>>, TEvents extends SubEventsConstraint<CurrentCompDoc>, TSubComputed extends SubComputedConstraint<Omit<Required<CurrentCompDoc["properties"]>, keyof (InheritDoc & SubDataDoc & SubStoreDoc)> & Record<InnerFields<CurrentPrefix>, unknown>>, TSubMethods extends SubMethodsConstraint = {}, InheritDoc extends object = IfExtends<InheritConstraint<AllRootDataDoc, CurrentCompDoc>, TInherit, {}, TInherit>, SubDataDoc extends object = IfExtends<SubDataConstraint<Omit<Required<CurrentCompDoc["properties"]>, keyof InheritDoc> & Record<InnerFields<CurrentPrefix>, unknown>>, TSubData, {}, TSubData>, SubStoreDoc extends object = IfExtends<SubStoreConstraint<Omit<Required<CurrentCompDoc["properties"]>, keyof (InheritDoc & SubDataDoc)> & Record<InnerFields<CurrentPrefix>, unknown>>, TSubStore, {}, {
-        [k in keyof TSubStore]: ReturnType<NonNullable<TSubStore[k]>>;
-    }>, SubComputedDoc extends object = IfExtends<SubComputedConstraint<Omit<Required<CurrentCompDoc["properties"]>, keyof (InheritDoc & SubDataDoc & SubStoreDoc)> & Record<InnerFields<CurrentPrefix>, unknown>>, TSubComputed, {}, GetSubComputedDoc<TSubComputed>>, SubEventsDoc extends object = IfExtends<SubEventsConstraint<CurrentCompDoc>, TEvents, {}, TEvents>, SubMethodsDoc extends object = TSubMethods, MissingRequiredField extends PropertyKey = Exclude<RequiredKeys<NonNullable<CurrentCompDoc["properties"]>>, keyof (InheritDoc & SubDataDoc & SubStoreDoc & IfExtends<SubComputedConstraint<Omit<Required<CurrentCompDoc["properties"]>, keyof (InheritDoc & SubDataDoc & SubStoreDoc)>>, TSubComputed, {}, GetSubComputedDoc<TSubComputed>>)>>(options: Options<TRootDoc, IsPage, CurrentCompDoc, CurrentPrefix, AllRootDataDoc, TInherit, TSubData, TSubStore, TSubComputed, TEvents, TSubMethods, InheritDoc, SubDataDoc, SubStoreDoc, SubComputedDoc, SubEventsDoc, SubMethodsDoc>): CreateSubComponentDoc<NonNullable<TOriginalCompDoc["customEvents"]>, SubEventsDoc, MissingRequiredField>;
-};
+type SubComponentConstructor<TRootDoc extends RootComponentDoc, TOriginalCompDoc extends ComponentDoc, TSupplementalPrefix extends string = "", IsPage extends boolean = TRootDoc["isPage"] extends true ? true : false, CurrentPrefix extends string = `${GetComponentPrefix<TOriginalCompDoc>}${Capitalize<TSupplementalPrefix>}`, CurrentCompDoc extends ComponentDoc = IfExtends<TSupplementalPrefix, "", TOriginalCompDoc, ReplacePrefix<TOriginalCompDoc, CurrentPrefix>>, AllRootDataDoc extends object = Required<TRootDoc["properties"]> & TRootDoc["data"] & TRootDoc["computed"] & TRootDoc["store"]> = <TInherit extends InheritConstraint<AllRootDataDoc, CurrentCompDoc>, TSubData extends SubDataConstraint<Omit<Required<CurrentCompDoc["properties"]>, keyof InheritDoc> & Record<InnerFields<CurrentPrefix>, unknown>>, TSubStore extends SubStoreConstraint<Omit<Required<CurrentCompDoc["properties"]>, keyof (InheritDoc & SubDataDoc)> & Record<InnerFields<CurrentPrefix>, unknown>>, TEvents extends SubEventsConstraint<CurrentCompDoc>, TSubComputed extends SubComputedConstraint<Omit<Required<CurrentCompDoc["properties"]>, keyof (InheritDoc & SubDataDoc & SubStoreDoc)> & Record<InnerFields<CurrentPrefix>, unknown>>, TSubMethods extends SubMethodsConstraint = {}, InheritDoc extends object = IfExtends<InheritConstraint<AllRootDataDoc, CurrentCompDoc>, TInherit, {}, TInherit>, SubDataDoc extends object = IfExtends<SubDataConstraint<Omit<Required<CurrentCompDoc["properties"]>, keyof InheritDoc> & Record<InnerFields<CurrentPrefix>, unknown>>, TSubData, {}, TSubData>, SubStoreDoc extends object = IfExtends<SubStoreConstraint<Omit<Required<CurrentCompDoc["properties"]>, keyof (InheritDoc & SubDataDoc)> & Record<InnerFields<CurrentPrefix>, unknown>>, TSubStore, {}, {
+    [k in keyof TSubStore]: ReturnType<NonNullable<TSubStore[k]>>;
+}>, SubComputedDoc extends object = IfExtends<SubComputedConstraint<Omit<Required<CurrentCompDoc["properties"]>, keyof (InheritDoc & SubDataDoc & SubStoreDoc)> & Record<InnerFields<CurrentPrefix>, unknown>>, TSubComputed, {}, GetSubComputedDoc<TSubComputed>>, SubEventsDoc extends object = IfExtends<SubEventsConstraint<CurrentCompDoc>, TEvents, {}, TEvents>, SubMethodsDoc extends object = TSubMethods, MissingRequiredField extends PropertyKey = Exclude<RequiredKeys<NonNullable<CurrentCompDoc["properties"]>>, keyof (InheritDoc & SubDataDoc & SubStoreDoc & IfExtends<SubComputedConstraint<Omit<Required<CurrentCompDoc["properties"]>, keyof (InheritDoc & SubDataDoc & SubStoreDoc)>>, TSubComputed, {}, GetSubComputedDoc<TSubComputed>>)>>(options: Options<TRootDoc, IsPage, CurrentCompDoc, CurrentPrefix, AllRootDataDoc, TInherit, TSubData, TSubStore, TSubComputed, TEvents, TSubMethods, InheritDoc, SubDataDoc, SubStoreDoc, SubComputedDoc, SubEventsDoc, SubMethodsDoc>) => CreateSubComponentDoc<NonNullable<TOriginalCompDoc["customEvents"]>, SubEventsDoc, MissingRequiredField>;
+/**
+ * 子组件构建函数
+ * @returns `(options:) => SubComponentDoc`
+ */
 export declare function SubComponent<RootDoc extends RootComponentDoc, CompDoc extends ComponentDoc, Prefix extends string = "">(): IfExtends<EmptyObject, CompDoc, (opt: EmptyObject) => never, SubComponentConstructor<RootDoc, CompDoc, Prefix>>;
 export type SubComponentTrueOptions = {
     inhrit?: string;

package/dist/api/SubComponent/index.js

@@ -1,4 +1,9 @@
+/**
+ * 子组件构建函数
+ * @returns `(options:) => SubComponentDoc`
+ */
 export function SubComponent() {
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     return ((options) => options);
 }
 //# sourceMappingURL=index.js.map

package/dist/api/SubComponent/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/api/SubComponent/index.ts"],"names":[],"mappings":"AAyOA,MAAM,UAAU,YAAY;IAK1B,OAAO,CAAC,CAAC,OAAY,EAAE,EAAE,CAAC,OAAkC,CAAQ,CAAC;AACvE,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/api/SubComponent/index.ts"],"names":[],"mappings":"AAiOA;;;GAGG;AACH,MAAM,UAAU,YAAY;IAK1B,8DAA8D;IAC9D,OAAO,CAAC,CAAC,OAAY,EAAE,EAAE,CAAC,OAAkC,CAAQ,CAAC;AACvE,CAAC"}

package/dist/api/navigateTo.d.ts

@@ -11,5 +11,10 @@ type NavigateToOption<T extends PageDoc> = {
 }, {
     data: T["properties"];
 }>> & Omit<WMNavigateToOption, "url">;
+/**
+ * 页面onload参数中接受的数据值是传递的url解析后的字符串。例如:A页面通过`wx.navigateTo({url:'/pages/test/test?num=123&obj={"name":"zhao"}'})`
+ * test页面onLoad(data)的参数data接受内容为` data = {num:"123",obj:"{"name":"zhao"}"}`即默认的url传的数据值为字符串,需要在接收时自行解析(JSON.parse)。且url采取ASCII编码只能接受0x20-0x7e区间的符号。无法使用一些特殊符号 如 ` :/?#[]@!$&'()*+,;= `。
+ * navigateTo API 为 wx.navigateTo的语法糖,增加了data字段,最终的url数据拼接了通过encodeURIComponent编码(支持默认忽略的特殊符号)的data字段,在跳转页面的onload中通过decodeURIComponent解析url赋值给实例的data对象。为求使用时更加方便(无需对参数data解析再赋值)。且有ts类型提示。
+ */
 export declare function navigateTo<TPageDoc extends PageDoc = never>(option: NoInfer<NavigateToOption<TPageDoc>>): Promise<WechatMiniprogram.NavigateToSuccessCallbackResult>;
 export {};

package/dist/api/navigateTo.js

@@ -1,4 +1,7 @@
 import { INNERMARKER } from "../utils/InnerMarker";
+/**
+ *  对象中可以使用 `"; / ? : @ & = + $ `, #"做为数据的一部分
+ */
 function _encodeURIComponent(option) {
     const result = {
         url: `${option.url}?${INNERMARKER.url}=${encodeURIComponent(JSON.stringify(option.data))}`,
@@ -7,8 +10,14 @@ function _encodeURIComponent(option) {
     Reflect.deleteProperty(option, "data");
     return Object.assign(result, option);
 }
+/**
+ * 页面onload参数中接受的数据值是传递的url解析后的字符串。例如:A页面通过`wx.navigateTo({url:'/pages/test/test?num=123&obj={"name":"zhao"}'})`
+ * test页面onLoad(data)的参数data接受内容为` data = {num:"123",obj:"{"name":"zhao"}"}`即默认的url传的数据值为字符串,需要在接收时自行解析(JSON.parse)。且url采取ASCII编码只能接受0x20-0x7e区间的符号。无法使用一些特殊符号 如 ` :/?#[]@!$&'()*+,;= `。
+ * navigateTo API 为 wx.navigateTo的语法糖,增加了data字段,最终的url数据拼接了通过encodeURIComponent编码(支持默认忽略的特殊符号)的data字段,在跳转页面的onload中通过decodeURIComponent解析url赋值给实例的data对象。为求使用时更加方便(无需对参数data解析再赋值)。且有ts类型提示。
+ */
 export function navigateTo(option) {
-    if (!option["data"]) {
+    // @ts-ignore 隐式索引
+    if (!option.data) {
         return wx.navigateTo(option);
     }
     else {

package/dist/api/navigateTo.js.map

@@ -1 +1 @@
-{"version":3,"file":"navigateTo.js","sourceRoot":"","sources":["../../src/api/navigateTo.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AA2BnD,SAAS,mBAAmB,CAC1B,MAAuE;IAEvE,MAAM,MAAM,GAAuB;QACjC,GAAG,EAAE,GAAG,MAAM,CAAC,GAAG,IAAI,WAAW,CAAC,GAAG,IACnC,kBAAkB,CAChB,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,CAE/B,EAAE;KACH,CAAC;IAEF,OAAO,CAAC,cAAc,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IAEtC,OAAO,CAAC,cAAc,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAEvC,OAAO,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AACvC,CAAC;AAOD,MAAM,UAAU,UAAU,CACxB,MAA2C;IAG3C,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC;QACpB,OAAO,EAAE,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;IAC/B,CAAC;SAAM,CAAC;QACN,OAAO,EAAE,CAAC,UAAU,CAClB,mBAAmB,CAAC,MAAuD,CAAC,CAC7E,CAAC;IACJ,CAAC;AACH,CAAC"}
+{"version":3,"file":"navigateTo.js","sourceRoot":"","sources":["../../src/api/navigateTo.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAwBnD;;GAEG;AACH,SAAS,mBAAmB,CAC1B,MAAuE;IAEvE,MAAM,MAAM,GAAuB;QACjC,GAAG,EAAE,GAAG,MAAM,CAAC,GAAG,IAAI,WAAW,CAAC,GAAG,IACnC,kBAAkB,CAChB,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,CAE/B,EAAE;KACH,CAAC;IAEF,OAAO,CAAC,cAAc,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IAEtC,OAAO,CAAC,cAAc,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAEvC,OAAO,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AACvC,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,UAAU,CACxB,MAA2C;IAE3C,kBAAkB;IAClB,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;QACjB,OAAO,EAAE,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;IAC/B,CAAC;SAAM,CAAC;QACN,OAAO,EAAE,CAAC,UAAU,CAClB,mBAAmB,CAAC,MAAuD,CAAC,CAC7E,CAAC;IACJ,CAAC;AACH,CAAC"}

package/dist/behaviors/BStore.d.ts

@@ -1 +1,5 @@
+/**
+ * 在created生命周期中,初始化 store数据(__storeConfig__)到data中
+ * 在detached生命周期中,清除store数据
+ */
 export declare const BStore: string;

package/dist/behaviors/BStore.js

@@ -1,13 +1,21 @@
+/**
+ * 在created生命周期中,初始化 store数据(__storeConfig__)到data中
+ * 在detached生命周期中,清除store数据
+ */
 export const BStore = Behavior({
     lifetimes: {
         created() {
             const storeConfig = this.data.__storeConfig__;
             if (!storeConfig)
                 return;
+            // eslint-disable-next-line @typescript-eslint/no-require-imports
             const { comparer, reaction, toJS } = require("mobx");
+            // 存储reaction的disposer 需要冲突字段验证
             this.disposer = {};
             for (const key in storeConfig) {
+                // 添加响应式逻辑
                 this.disposer[key] = reaction(storeConfig[key], (value) => {
+                    // 加入到待setData对象中
                     this.setData({
                         [key]: toJS(value),
                     });
@@ -18,6 +26,7 @@ export const BStore = Behavior({
             delete this.data.__storeConfig__;
         },
         detached() {
+            /* istanbul ignore next 清除store数据 test中模拟了测试，所以忽略 框架(1.6.1)不支持 issue {@link https://github.com/wechat-miniprogram/miniprogram-simulate/issues/110}*/
             for (const key in this.disposer) {
                 this.disposer[key]();
             }

package/dist/behaviors/BStore.js.map

@@ -1 +1 @@
-{"version":3,"file":"BStore.js","sourceRoot":"","sources":["../../src/behaviors/BStore.ts"],"names":[],"mappings":"AAGA,MAAM,CAAC,MAAM,MAAM,GAAG,QAAQ,CAAC;IAC7B,SAAS,EAAE;QACT,OAAO;YACL,MAAM,WAAW,GAAG,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC;YAC9C,IAAI,CAAC,WAAW;gBAAE,OAAO;YAEzB,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC,MAAM,CAAgB,CAAC;YAEpE,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAC;YAEnB,KAAK,MAAM,GAAG,IAAI,WAAW,EAAE,CAAC;gBAE9B,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,QAAQ,CAC3B,WAAW,CAAC,GAAG,CAAC,EAChB,CAAC,KAAc,EAAE,EAAE;oBAEjB,IAAI,CAAC,OAAO,CAAC;wBACX,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC;qBACnB,CAAC,CAAC;gBACL,CAAC,EACD;oBACE,MAAM,EAAE,QAAQ,CAAC,UAAU;iBAC5B,CACF,CAAC;YACJ,CAAC;YACD,OAAO,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC;QACnC,CAAC;QAED,QAAQ;YAEN,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;gBAChC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;YACvB,CAAC;QACH,CAAC;KACF;CACF,CAAC,CAAC"}
+{"version":3,"file":"BStore.js","sourceRoot":"","sources":["../../src/behaviors/BStore.ts"],"names":[],"mappings":"AAGA;;;GAGG;AACH,MAAM,CAAC,MAAM,MAAM,GAAG,QAAQ,CAAC;IAC7B,SAAS,EAAE;QACT,OAAO;YACL,MAAM,WAAW,GAAG,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC;YAC9C,IAAI,CAAC,WAAW;gBAAE,OAAO;YAEzB,iEAAiE;YACjE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC,MAAM,CAAgB,CAAC;YACpE,+BAA+B;YAC/B,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAC;YACnB,KAAK,MAAM,GAAG,IAAI,WAAW,EAAE,CAAC;gBAC9B,UAAU;gBACV,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,QAAQ,CAC3B,WAAW,CAAC,GAAG,CAAC,EAChB,CAAC,KAAc,EAAE,EAAE;oBACjB,iBAAiB;oBACjB,IAAI,CAAC,OAAO,CAAC;wBACX,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC;qBACnB,CAAC,CAAC;gBACL,CAAC,EACD;oBACE,MAAM,EAAE,QAAQ,CAAC,UAAU;iBAC5B,CACF,CAAC;YACJ,CAAC;YACD,OAAO,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC;QACnC,CAAC;QAED,QAAQ;YACN,oJAAoJ;YACpJ,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;gBAChC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;YACvB,CAAC;QACH,CAAC;KACF;CACF,CAAC,CAAC"}

package/dist/behaviors/BbeforeCreated.d.ts

@@ -1 +1,4 @@
+/**
+ * 增加beforeCreate生命周期函数,便于测试
+ */
 export declare const BBeforeCreate: string;

package/dist/behaviors/BbeforeCreated.js

@@ -1,7 +1,14 @@
+/**
+ * 增加beforeCreate生命周期函数,便于测试
+ */
 export const BBeforeCreate = Behavior({
+    // @ts-ignore
     definitionFilter(options) {
+        // 触发beforeCreate生命周期函数  options.lifetimes在之前被赋值过默认{}所以！
         const beforeCreateFunc = options.lifetimes.beforeCreate;
-        beforeCreateFunc && beforeCreateFunc(options);
+        if (beforeCreateFunc) {
+            beforeCreateFunc.call(undefined, options);
+        }
     },
 });
 //# sourceMappingURL=BbeforeCreated.js.map

package/dist/behaviors/BbeforeCreated.js.map

@@ -1 +1 @@
-{"version":3,"file":"BbeforeCreated.js","sourceRoot":"","sources":["../../src/behaviors/BbeforeCreated.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,MAAM,aAAa,GAAG,QAAQ,CAAC;IAEpC,gBAAgB,CACd,OAAwF;QAGxF,MAAM,gBAAgB,GAAG,OAAO,CAAC,SAAU,CAAC,YAAY,CAAC;QAEzD,gBAAgB,IAAI,gBAAgB,CAAC,OAAO,CAAC,CAAC;IAChD,CAAC;CACF,CAAC,CAAC"}
+{"version":3,"file":"BbeforeCreated.js","sourceRoot":"","sources":["../../src/behaviors/BbeforeCreated.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,QAAQ,CAAC;IACpC,aAAa;IACb,gBAAgB,CACd,OAAwF;QAExF,wDAAwD;QACxD,MAAM,gBAAgB,GAAG,OAAO,CAAC,SAAS,CAAC,YAAY,CAAC;QAExD,IAAI,gBAAgB,EAAE,CAAC;YACrB,gBAAgB,CAAC,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;QAC5C,CAAC;IACH,CAAC;CACF,CAAC,CAAC"}

package/dist/index.d.ts

@@ -3,10 +3,10 @@ import { type IInjectInfo, instanceConfig } from "./api/InstanceInject/instanceC
 import { navigateTo } from "./api/navigateTo";
 import { RootComponent } from "./api/RootComponent";
 import { SubComponent } from "./api/SubComponent";
+import type { CreateComponentType } from "./types/CreateComponentType";
 import type { DetailedType } from "./types/DetailedType";
 import type { DocAssign } from "./types/DocAssign";
-import type { GenerateDoc } from "./types/GenerateDoc";
 import type { ParamsEqual } from "./types/TwoParamsEqual";
 export type { Vant, Wm } from "./thirdLib";
 export type { CurrentTargetDataset, Dataset, Detail, Mark, TargetDataset, WMBaseEvent, WMCustomEvent, } from "./types/OfficialTypeAlias";
-export { DefineComponent, type DetailedType, type DocAssign, type GenerateDoc, type IInjectInfo, instanceConfig, navigateTo, type ParamsEqual, RootComponent, SubComponent, };
+export { type CreateComponentType, DefineComponent, type DetailedType, type DocAssign, type IInjectInfo, instanceConfig, navigateTo, type ParamsEqual, RootComponent, SubComponent, };

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AACxD,OAAO,EAAoB,cAAc,EAAE,MAAM,qCAAqC,CAAC;AACvF,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAiBlD,OAAO,EACL,eAAe,EAKf,cAAc,EACd,UAAU,EAEV,aAAa,EACb,YAAY,GACb,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AACxD,OAAO,EAAoB,cAAc,EAAE,MAAM,qCAAqC,CAAC;AACvF,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAiBlD,OAAO,EAEL,eAAe,EAIf,cAAc,EACd,UAAU,EAEV,aAAa,EACb,YAAY,GACb,CAAC"}

package/dist/thirdLib/vant/Button.d.ts

@@ -1,9 +1,21 @@
-import type { CreateComponentDoc } from "../../types/CreateComponentDoc";
-export type Button = CreateComponentDoc<"button", {
+import type { CreateComponentType } from "../../types/CreateComponentType";
+export type Button = CreateComponentType<"button", {
     properties: {
+        /**
+         * 标识符
+         */
         id?: string;
+        /**
+         * 按钮类型
+         */
         type?: "primary" | "warning" | "danger" | "info";
+        /**
+         * 按钮尺寸
+         */
         size?: "normal" | "large" | "small" | "mini";
+        /**
+         * 按钮颜色 支持传入linear-gradient渐变色
+         */
         color?: string;
     };
 }>;

package/dist/thirdLib/vant/NoticeBar.d.ts

@@ -1,11 +1,11 @@
-import type { CreateComponentDoc } from "../../types/CreateComponentDoc";
+import type { CreateComponentType } from "../../types/CreateComponentType";
 export type CssVar<T extends string = string> = `var(--${T}-${string})`;
 export type HEX = `#${number}`;
 export type RGBA = `rgba(${number},${number},${number},${number})`;
 export type RGB = `rgb(${number},${number},${number})`;
 export type TWClass = `${string}-${string}`;
 export type Color = RGBA | HEX | RGB | CssVar<"color">;
-export type NoticeBar = CreateComponentDoc<"noticeBar", {
+export type NoticeBar = CreateComponentType<"noticeBar", {
     properties: {
         mode?: "closeable" | "link";
         text?: string;

package/dist/thirdLib/vant/Popup.d.ts

@@ -1,20 +1,60 @@
-import type { CreateComponentDoc } from "../../types/CreateComponentDoc";
+import type { CreateComponentType } from "../../types/CreateComponentType";
 type Position = "top" | "bottom" | "left" | "right";
-export type Popup = CreateComponentDoc<"popup", {
+export type Popup = CreateComponentType<"popup", {
     properties: {
+        /**
+         *  是否显示弹出层
+         */
         show: boolean;
+        /**
+         *  z-index 层级
+         */
         zIndex?: number;
+        /**
+         * 弹出位置  top bottom right left 默认 居中
+         */
         position?: Position;
+        /**
+         *  是否显示遮罩层
+         */
         overlay?: boolean;
+        /**
+         * 动画时长，单位为毫秒
+         */
         duration?: number;
+        /** */
         round?: boolean;
+        /**
+         * 自定义弹出层样式
+         */
         customStyle?: string;
+        /**
+         * 自定义遮罩层样式
+         */
         overlayStyle?: string;
+        /**
+         * 是否在点击遮罩层后关闭
+         */
         closeOnClickOverlay?: boolean;
+        /**
+         * 是否显示关闭图标
+         */
         closeable?: boolean;
+        /**
+         * 关闭图标名称或图片链接
+         */
         closeIcon?: string;
+        /**
+         * 是否为 iPhoneX 留出底部安全距离 true
+         */
         safeAreaInsetBottom?: boolean;
+        /**
+         * 是否留出顶部安全距离（状态栏高度） false
+         */
         safeAreaInsetTop?: boolean;
+        /**
+         * 是否锁定背景滚动 true
+         */
         lockScroll?: boolean;
     };
     customEvents: {

package/dist/thirdLib/wm/Textarea.d.ts

@@ -1,8 +1,17 @@
-import type { CreateComponentDoc } from "../../types/CreateComponentDoc";
-export type Textarea = CreateComponentDoc<"textarea", {
+import type { CreateComponentType } from "../../types/CreateComponentType";
+export type Textarea = CreateComponentType<"textarea", {
     properties: {
+        /**
+         * 输入框的内容
+         */
         value?: string;
+        /**
+         * 最大输入长度，设置为 -1 的时候不限制最大长度 默认140
+         */
         maxlength?: number;
+        /**
+         * 输入框为空时占位符
+         */
         placeholder?: string;
     };
     customEvents: {

package/dist/thirdLib/wm/baseEvents.d.ts

@@ -1,16 +1,53 @@
 import type { Bubbles } from "../../api/RootComponent/CustomEvents/CustomEventsTag";
 import type { WMBaseEvent } from "../../types/OfficialTypeAlias";
-export type BaseEvents = {
+export interface BaseEvents {
+    [key: string]: WMBaseEvent | Bubbles;
+    /**
+     * 手指触摸动作开始
+     */
     touchstart: WMBaseEvent | Bubbles;
+    /**
+     * 手指触摸后移动
+     */
     touchmove: WMBaseEvent | Bubbles;
+    /**
+     * 手指触摸动作被打断，如来电提醒，弹窗
+     */
     touchcancel: WMBaseEvent | Bubbles;
+    /**
+     * 手指触摸动作结束
+     */
     touchend: WMBaseEvent | Bubbles;
+    /**
+     * 手指触摸后马上离开
+     */
     tap: WMBaseEvent | Bubbles;
+    /**
+     * 手指触摸后，超过350ms再离开，如果指定了事件回调函数并触发了这个事件，tap事件将不被触发	1.5.0
+     */
     longpress: WMBaseEvent | Bubbles;
+    /**
+     * 手指触摸后，超过350ms再离开（推荐使用longpress事件代替）
+     */
     longtap: WMBaseEvent | Bubbles;
+    /**
+     * 会在 WXSS transition 或 wx.createAnimation 动画结束后触发
+     */
     transitionend: WMBaseEvent | Bubbles;
+    /**
+     * 会在一个 WXSS animation 动画开始时触发
+     */
     animationstart: WMBaseEvent | Bubbles;
+    /**
+     * 会在一个 WXSS animation 一次迭代结束时触发
+     */
     animationiteration: WMBaseEvent | Bubbles;
+    /**
+     * 会在一个 WXSS animation 动画完成时触发
+     */
     animationend: WMBaseEvent | Bubbles;
+    /**
+     * 在支持 3D Touch 的 iPhone 设备，重按时会触发  1.9.90
+     */
     touchforcechange: WMBaseEvent | Bubbles;
-};
+}

package/dist/thirdLib/wm/scrollView.d.ts

@@ -1,7 +1,9 @@
 import type { EmptyObject } from "hry-types/src/Misc/EmptyObject";
-import type { CreateComponentDoc } from "../../types/CreateComponentDoc";
-export type ScrollView = CreateComponentDoc<"scrollView", {
+import type { CreateComponentType } from "../../types/CreateComponentType";
+export type ScrollView = CreateComponentType<"scrollView", {
     properties: {
+        class?: string;
+        style?: string;
         scroll_x?: boolean;
         scroll_y?: boolean;
         upper_threshold?: number | string;

package/dist/thirdLib/wm/scrollView.js

@@ -1,2 +1,8 @@
 export {};
+// Bug & Tip
+// tip: 基础库 2.4.0以下不支持嵌套textarea、map、canvas、video 组件
+// tip: scroll-into-view 的优先级高于 scroll-top
+// tip: 在滚动 scroll-view 时会阻止页面回弹，所以在 scroll-view 中滚动，是无法触发 onPullDownRefresh
+// tip: 若要使用下拉刷新，请使用页面的滚动，而不是 scroll-view ，这样也能通过点击顶部状态栏回到页面顶部
+// tip: scroll-view 自定义下拉刷新可以结合 WXS 事件响应 开发交互动画
 //# sourceMappingURL=scrollView.js.map

package/dist/thirdLib/wm/scrollView.js.map

@@ -1 +1 @@
-{"version":3,"file":"scrollView.js","sourceRoot":"","sources":["../../../src/thirdLib/wm/scrollView.ts"],"names":[],"mappings":""}
+{"version":3,"file":"scrollView.js","sourceRoot":"","sources":["../../../src/thirdLib/wm/scrollView.ts"],"names":[],"mappings":";AAgFA,YAAY;AACZ,oDAAoD;AACpD,0CAA0C;AAC1C,4EAA4E;AAC5E,8DAA8D;AAC9D,+CAA+C"}

package/dist/thirdLib/wm/swiper.d.ts

@@ -1,38 +1,108 @@
-import type { CreateComponentDoc } from "../../types/CreateComponentDoc";
+import type { CreateComponentType } from "../../types/CreateComponentType";
 type CssVar<T extends string = string> = `var(--${T}-${string})`;
 type Color = `rgba(${number}, ${number}, ${number}, ${number})` | `#${number}` | CssVar<"color">;
-type ChangeEventDetail = {
+interface ChangeEventDetail {
     current: number;
     currentItemId: string;
     source: "touch" | "" | "autoplay";
-};
+}
 type AnimationfinishEventDetail = ChangeEventDetail;
-export type Swiper = CreateComponentDoc<"swiper", {
+export type Swiper = CreateComponentType<"swiper", {
     properties: {
-        list: unknown[];
+        /**
+         * @description class
+         */
         class?: string;
+        /**
+         * @description style
+         */
         style?: string;
+        /**
+         * 是否显示面板指示点
+         * @defaultValue false
+         */
         indicatorDots?: boolean;
+        /**
+         * 指示点颜色
+         * @defaultValue 'rgba(0, 0, 0, .3)'
+         */
         indicatorColor?: Color;
+        /**
+         * 当前选中的指示点颜色
+         * @defaultValue "#000000"
+         */
         indicatorActiveColor?: Color;
+        /**
+         * 是否自动切换
+         * @defaultValue false
+         */
         autoplay?: boolean;
+        /**
+         * 当前所在滑块的 index
+         * @defaultValue  0
+         */
         current?: number;
+        /**
+         * 自动切换时间间隔
+         * @defaultValue 5000
+         */
         interval?: number;
+        /**
+         * 滑动动画时长
+         * @defaultValue 500
+         */
         duration?: number;
+        /**
+         * 是否采用衔接滑动
+         * @defaultValue false
+         */
         circular?: boolean;
+        /**
+         * 滑动方向是否为纵向
+         * @defaultValue false
+         */
         vertical?: boolean;
+        /**
+         * 前边距，可用于露出前一项的一小部分，接受 px 和 rpx 值
+         * @defaultValue '0px'
+         */
         previousMargin?: string;
+        /**
+         * 后边距，可用于露出后一项的一小部分，接受 px 和 rpx 值
+         * @defaultValue '0px'
+         */
         nextMargin?: string;
+        /**
+         * 当 swiper-item 的个数大于等于 2，关闭 circular 并且开启 previous-margin 或 next-margin 的时候，可以指定这个边距是否应用到第一个、最后一个元素
+         * @defaultValue false
+         */
         snapToEdge?: boolean;
+        /**
+         * 同时显示的滑块数量
+         * @defaultValue 1
+         */
         displayMultipleItems?: number;
+        /**
+         * 指定 swiper 切换缓动动画类型
+         * @defaultValue 'defaultValue'
+         */
         easingFunction?: "defaultValue" | "linear" | "easeInCubic" | "easeOutCubic" | "easeInOutCubic";
     };
     customEvents: {
+        /**
+         * current 改变时会触发 change 事件，event.detail = `{current, source}`
+         */
         change: ChangeEventDetail;
+        /**
+         * swiper-item 的位置发生改变时会触发 transition 事件，event.detail = `{dx: number, dy: number}`
+         */
         transition: {
             dx: number;
             dy: number;
         };
+        /**
+         * animationfinish 动画结束时会触发 animationfinish 事件，event.detail change字段
+         */
         animationfinish: AnimationfinishEventDetail;
     };
 }>;