annil 1.1.1 → 1.2.0-beta.0

package/src/api/SubComponent/index.ts

@@ -6,13 +6,15 @@ import type { ReplacePrefix } from "../../types/ReplacePrefix";
 import type { ComponentDoc } from "../DefineComponent/ReturnType/ComponentDoc";
 
 import type { Func } from "hry-types/src/Misc/Func";
-import type {
-  WMCompLifetimes,
-  WMCompOtherOption,
-  WMCompPageLifetimes,
-  WMPageLifetimes,
-} from "../../types/OfficialTypeAlias";
+import type { WMCompOtherOption } from "../../types/OfficialTypeAlias";
+import type { ComputedConstraint } from "../RootComponent/Computed/ComputedConstraint";
+import type { DataConstraint } from "../RootComponent/Data/DataConstraint";
+import type { EventsConstraint } from "../RootComponent/Events/EventsConstraint";
+import type { LifetimesConstraint } from "../RootComponent/Lifetimes/LifetimesConstraint";
+import type { MethodsConstraint } from "../RootComponent/Methods/MethodsConstraint";
+import type { PageLifetimesOption } from "../RootComponent/PageLifetimes/PageLifetimesOption";
 import type { RootComponentDoc } from "../RootComponent/RootComponentDoc";
+import type { StoreConstraint } from "../RootComponent/Store/StoreConstraint";
 import type { GetSubComputedDoc } from "./SubComputed/GetSubComputedDoc";
 import type { SubComputedConstraint } from "./SubComputed/SubComputedConstraint";
 import type { SubComputedOption } from "./SubComputed/SubComputedOption";
@@ -21,6 +23,7 @@ import type { SubDataOption } from "./SubData/SubDataOption";
 import type { SubEventsConstraint } from "./SubEvents/SubEventsConstraint";
 import type { SubEventsOption } from "./SubEvents/SubEventsOptions";
 import type { InheritConstraint } from "./SubInherit/SubInheritConstraint";
+import type { SubInheritOption } from "./SubInherit/SubInheritOption";
 import type { SubInstance } from "./SubInstance/SubInstance";
 import type { SubLifetimesOption } from "./SubLifetimes/SubLifetimesOption";
 import type { SubMethodsConstraint } from "./SubMethods/SubMethodsConstraint";
@@ -42,7 +45,7 @@ type Options<
   TSubStore extends object,
   TSubComputed extends object,
   TEvents extends object,
-  TSubMethods extends object,
+  TSubMethods extends SubMethodsConstraint,
   InheritDoc extends object,
   SubDataDoc extends object,
   SubStoreDoc extends object,
@@ -50,7 +53,7 @@ type Options<
   SubEventsDoc extends object,
   SubMethodsDoc extends object,
 > =
-  & { inherit?: TInherit }
+  & SubInheritOption<TInherit>
   & SubDataOption<
     TSubData,
     Exclude<keyof CurrentCompDoc["properties"], (keyof InheritDoc)>,
@@ -67,8 +70,9 @@ type Options<
     // 合法的配置
     Omit<CurrentCompDoc["properties"], (keyof (InheritDoc & SubDataDoc & SubStoreDoc))>
   >
+  // 无需与根组件的events字段重复检测,因为根组件多了bubbles字段,一定不会重复
   & SubEventsOption<TEvents, SubEventsDoc, keyof SubEventsConstraint<CurrentCompDoc>>
-  & SubMethodsOption<TSubMethods, Prefix, keyof CurrentCompDoc["customEvents"]>
+  & SubMethodsOption<TSubMethods, Prefix, keyof (CurrentCompDoc["customEvents"] & SubEventsDoc)>
   & SubPageLifetimesOption<IsPage, RootDoc["properties"] & {}>
   & SubLifetimesOption
   & SubWatchOption<
@@ -104,7 +108,8 @@ type SubComponentConstructor<
     ReplacePrefix<TOriginalCompDoc, CurrentPrefix>
   >,
   AllRootDataDoc extends object =
-    & Required<TRootDoc["properties"]>
+    // rootDoc中的properties是带有可选的,这是为了给使用者(上层组件)提示,而在自身组件实例中并不存在可选状态,故加了Required,正因加了Required使得最终结果不可能为unknown而是`{}`,满足object约束
+    & Required<TRootDoc["properties"]> // Required<unknown> = {}
     & TRootDoc["data"]
     & TRootDoc["computed"]
     & TRootDoc["store"],
@@ -114,9 +119,10 @@ type SubComponentConstructor<
     TSubData extends SubDataConstraint<Omit<Required<CurrentCompDoc["properties"]>, keyof InheritDoc>>,
     TSubStore extends SubStoreConstraint<Omit<Required<CurrentCompDoc["properties"]>, keyof (InheritDoc & SubDataDoc)>>,
     TEvents extends SubEventsConstraint<CurrentCompDoc>,
+    // 加默认值计算字段无提示且需要手写返回类型,不加watch无法对computed监控
     TSubComputed extends SubComputedConstraint<
       Omit<Required<CurrentCompDoc["properties"]>, keyof (InheritDoc & SubDataDoc & SubStoreDoc)>
-    >,
+    > = {},
     TSubMethods extends SubMethodsConstraint = {},
     InheritDoc extends object = IfExtends<InheritConstraint<AllRootDataDoc, CurrentCompDoc>, TInherit, {}, TInherit>,
     SubDataDoc extends object = IfExtends<
@@ -202,11 +208,16 @@ export function SubComponent<
 
 export type SubComponentTrueOptions = {
   inhrit?: string;
-  data?: Record<string, unknown>;
-  computed?: Record<string, Func>;
-  events?: Record<string, Func>;
-  methods?: Record<string, Func>;
+  data?: DataConstraint;
+  computed?: ComputedConstraint;
+  store?: StoreConstraint;
+  events?: EventsConstraint;
+  methods?: MethodsConstraint;
+  // behaviors?: string[];
+  observers?: Record<string, Func>;
   watch?: Record<string, Func>;
-  lifetimes?: WMCompLifetimes["lifetimes"];
-  pageLifetimes?: Partial<WMCompPageLifetimes & { load: Func } & WMPageLifetimes>;
+  lifetimes?: LifetimesConstraint;
+  pageLifetimes?:
+    | PageLifetimesOption<false, object>["pageLifetimes"]
+    | PageLifetimesOption<true, object>["pageLifetimes"];
 };

package/src/behaviors/BComputedAndWatch/index.ts

@@ -1,5 +1,5 @@
 import type { Func } from "hry-types/src/Misc/Func";
-import type { FinalOptionsForComponent } from "../../api/DefineComponent";
+import type { FinalOptionsOfComponent } from "../../api/DefineComponent";
 import { deepClone } from "../../utils/deepClone";
 import { deleteProtoField } from "../../utils/deleteProtoField";
 
@@ -32,7 +32,7 @@ function initWatchOldValue(this: Instance, watchConfig: object): WatchOldValue {
  */
 
 export const BComputedAndWatch = Behavior({
-  definitionFilter(options: FinalOptionsForComponent) {
+  definitionFilter(options: FinalOptionsOfComponent) {
     const computedConfig = options.computed;
 
     // computed handle

package/src/behaviors/BComputedAndWatch/types.ts

@@ -11,6 +11,7 @@ export type InstanceCustomFields = {
   __computedCache__?: ComputedCache;
   __watchOldValue__?: WatchOldValue;
   __watchConfig__?: () => Record<string, Func>;
+  __compLoadList__?: Func[];
   disposer: Record<string, Func>;
 };
 

package/src/behaviors/BStore.ts

@@ -1,10 +1,10 @@
 import type mobx from "mobx";
-import type { FinalOptionsForComponent } from "../api/DefineComponent";
+import type { FinalOptionsOfComponent } from "../api/DefineComponent";
 import { deleteProtoField } from "../utils/deleteProtoField";
 import type { Instance } from "./BComputedAndWatch/types";
 
 export const BStore = Behavior({
-  definitionFilter(options: FinalOptionsForComponent) {
+  definitionFilter(options: FinalOptionsOfComponent) {
     // 初始化store
     const storeConfig = options.store;
     if (!storeConfig) return;
@@ -15,7 +15,6 @@ export const BStore = Behavior({
       options.data[key] = toJS(storeConfig[key]());
 
       // 把响应式数据配置保留在methods的__storeConfig__字段下带入到组件实例中(不用函数返回方式也可以,但不符合methods字段类型),后续再从原型上删除。
-      /* istanbul ignore next */
       options.methods ||= {};
 
       options.methods.__storeConfig__ = () => storeConfig;
@@ -23,7 +22,6 @@ export const BStore = Behavior({
       delete options.store;
     }
   },
-
   lifetimes: {
     created(this: Instance) {
       // 取出通过addStoreConfigToMethods函数带入的storeConfig
@@ -50,9 +48,9 @@ export const BStore = Behavior({
       }
       deleteProtoField(this, "__storeConfig__");
     },
+    /* istanbul ignore next */
     detached(this: Instance) {
-      // 清除store数据 test中模拟了测试，所以忽略 框架不支持 issue {@link https://github.com/wechat-miniprogram/miniprogram-simulate/issues/110}
-      /* 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/src/behaviors/BbeforeCreated.ts

@@ -1,7 +1,7 @@
-import type { FinalOptionsForComponent } from "../api/DefineComponent";
+import type { FinalOptionsOfComponent } from "../api/DefineComponent";
 
 export const BBeforeCreate = Behavior({
-  definitionFilter(options: FinalOptionsForComponent) {
+  definitionFilter(options: FinalOptionsOfComponent) {
     // 触发beforeCreate生命周期函数
     const beforeCreateFunc = options.lifetimes!.beforeCreate;
 

package/src/index.ts

@@ -1,25 +1,29 @@
-import { navigateTo } from "./api/navigateTo";
-
 import { DefineComponent } from "./api/DefineComponent";
-
+import { navigateTo } from "./api/navigateTo";
 import { RootComponent } from "./api/RootComponent";
-
 import { SubComponent } from "./api/SubComponent";
-
-import type { DetailedType } from "./types/DetailedType";
-
 import type { ComponentDocExtension } from "./types/ComponentDocExtension";
+import type { DetailedType } from "./types/DetailedType";
 import type { GenerateDoc } from "./types/GenerateDoc";
 import type { ParamsEqual } from "./types/TwoParamsEqual";
 export type { Vant, Wm } from "./thirdLib";
 
-export type { Dataset, Detail, WMBaseEvent, WMCustomEvent } from "./types/OfficialTypeAlias";
+export type {
+  CurrentTargetDataset,
+  Dataset,
+  Detail,
+  Mark,
+  TargetDataset,
+  WMBaseEvent,
+  WMCustomEvent,
+} from "./types/OfficialTypeAlias";
 
 export {
   type ComponentDocExtension,
   DefineComponent,
   type DetailedType,
   type GenerateDoc,
+  /* istanbul ignore next */
   navigateTo,
   type ParamsEqual,
   RootComponent,

package/src/types/OfficialTypeAlias.ts

@@ -31,11 +31,13 @@ export type Dataset<
 /**
  * 自定义事件Detail类型
  */
-export type Mark<TMark extends object> = WechatMiniprogram.CustomEvent<
-  {},
-  TMark,
-  {},
-  {}
+export type Mark<TMark extends object> = Required<
+  WechatMiniprogram.CustomEvent<
+    object,
+    TMark,
+    object,
+    object
+  >
 >;
 
 /**
@@ -53,12 +55,6 @@ export type CurrentTargetDataset<T extends object> = WMCustomEvent<{}, {}, T>;
  */
 export type TargetDataset<TargetDataset extends object> = WMCustomEvent<{}, {}, {}, TargetDataset>;
 
-// export type WMTrivialOption<
-//   TData extends WechatMiniprogram.Component.DataOption,
-//   TProperty extends WechatMiniprogram.Component.PropertyOption,
-//   TMethod extends WechatMiniprogram.Component.MethodOption,
-//   TCustomInstanceProperty extends WechatMiniprogram.IAnyObject = {},
-//   TIsPage extends boolean = false,
 export type WMComponentOption = WechatMiniprogram.Component.TrivialOption;
 
 export type WMNavigateToSuccessCallbackResult = WechatMiniprogram.NavigateToSuccessCallbackResult;

package/src/types/RemoveInnerData.ts

@@ -0,0 +1,5 @@
+/**
+ * 去除前缀为`_`的字符串
+ */
+export type RemoveInnerData<S extends string> = S extends unknown ? S extends `_${string}` ? never : S
+  : never;

package/src/utils/InnerMarker.ts

@@ -1,4 +1,4 @@
 export const INNERMARKER = {
-  url: "__missannil__" satisfies `_${string}`, // url默认传值Data字段 必须是内部字段,因为会加入到实例的data下。
+  url: "__annil__" satisfies `_${string}`, // url默认传值Data字段 必须是内部字段,因为会加入到实例的data下。
   // defUrl: "/xx&xx", // 标记 组件默认的的url类型
 };

package/src/utils/deepClone.ts

@@ -5,6 +5,7 @@ export function deepClone<T>(value: T): T {
   if (typeof value !== "object" || value === null) {
     return value;
   }
+  /* istanbul ignore next */
   const clone = (Array.isArray(value) ? [] : {}) as T;
 
   Object.setPrototypeOf(clone, Object.getPrototypeOf(value));