annil 1.1.1 → 1.1.2

package/src/api/SubComponent/SubPageLifetimes/test/normal.test.ts

@@ -1,74 +1 @@
-import { Checking, type Test } from "hry-types";
-
-import type { Mock_User } from "../../../RootComponent/Properties/test/normalRequired.test";
-import type { RootComponentDoc } from "../../../RootComponent/RootComponentDoc";
-import { SubComponent } from "../..";
-
-type RootDocComp = RootComponentDoc<{
-  properties: {
-    union?: Mock_User;
-    optionalObject?: Mock_User | null;
-    str: string;
-    obj: object | null;
-  };
-}>;
-
-type RootDocCompPage = RootComponentDoc<{
-  isPage: true;
-  properties: {
-    union?: Mock_User;
-    optionalObject?: Mock_User | null;
-    str: string;
-    obj: object | null;
-  };
-}>;
-
-type CompDoc = RootComponentDoc<{
-  properties: {
-    aaa_str: string;
-  };
-  customEvents: {
-    aaa_num: number;
-  };
-}>;
-
-/**
- * 测试 组件时
- */
-SubComponent<RootDocComp, CompDoc>()({
-  pageLifetimes: {
-    hide() {},
-    load() {},
-    resize(size) {
-      Checking<typeof size, WechatMiniprogram.Page.IResizeOption, Test.Pass>;
-    },
-    show() {},
-  },
-});
-
-/**
- * 页面时
- */
-SubComponent<RootDocCompPage, CompDoc>()({
-  pageLifetimes: {
-    onLoad(props) {
-      // 接受的必传properties字段,不应该有null
-      Checking<
-        typeof props,
-        {
-          str: string;
-          obj: object;
-          union: Mock_User;
-          optionalObject: Mock_User | null;
-        },
-        Test.Pass
-      >;
-    },
-    onHide() {
-      console.log("onHide");
-    },
-    onResize(options) {
-      console.log("onResize", options);
-    },
-  },
-});
+// 同 RootComponent的PageLifetimes

package/src/api/SubComponent/SubStore/SubDataConstraint.ts

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

package/src/api/SubComponent/SubStore/SubStoreOption.ts

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

package/src/api/SubComponent/SubStore/test/error.test.ts

@@ -31,5 +31,9 @@ SubComponent<{
     aaa_str: () => user.name,
     // @ts-expect-error 2 与 data 字段重复
     aaa_num: () => user.age,
+    // @ts-expect-error 3 内部字段前缀错误
+    _num: () => user.age,
+    // @ts-expect-error 4 超出约束字段
+    num: () => user.age,
   },
 });

package/src/api/SubComponent/SubStore/test/normal.test.ts

@@ -19,5 +19,7 @@ SubComponent<{}, DocA>()({
     aaa_str: () => user.name,
 
     aaa_num: () => user.age,
+    // 运行内部字段(暂定)
+    _aaa_ddd: () => user.age,
   },
 });

package/src/api/SubComponent/SubWatch/SubWatchOption.ts

@@ -1,3 +1,4 @@
+import type { NoInfer } from "hry-types/src/Generic/NoInfer";
 import type { WatchOption } from "../../RootComponent/Watch/WatchOption";
 
-export type SubWatchOption<TWatchData extends object> = WatchOption<TWatchData>;
+export type SubWatchOption<TWatchData extends object> = WatchOption<NoInfer<TWatchData>>;

package/src/api/SubComponent/SubWatch/test/WatchComputed.test.ts

@@ -1,46 +1,78 @@
-// import type { ComponentDoc } from "../../../DefineComponent/ReturnType/ComponentDoc";
-// import type { Mock_User } from "../../../RootComponent/Properties/test/normalRequired.test";
-// import type { RootComponentDoc } from "../../../RootComponent/RetrunType/RootComponentDoc";
-
-// type RootDoc = RootComponentDoc<{
-//   properties: {
-//     Pnum: number;
-//     obj: Mock_User | null;
-//   };
-// }>;
-
-// type CompDoc = ComponentDoc<{
-//   properties: {
-//     aaa_str: string;
-//     aaa_num: number;
-//   };
-// }>;
+import { Checking, type Test } from "hry-types";
+import type { ComponentDoc } from "../../../DefineComponent/ReturnType/ComponentDoc";
+import type { Mock_User } from "../../../RootComponent/Properties/test/normalRequired.test";
+import type { RootComponentDoc } from "../../../RootComponent/RootComponentDoc";
+import { SubComponent } from "../..";
+
+type RootDoc = RootComponentDoc<{
+  properties: {
+    obj: Mock_User | null;
+  };
+  data: {
+    num: number;
+  };
+  store: {
+    bool: boolean;
+  };
+}>;
+
+type CompDoc = ComponentDoc<{
+  properties: {
+    aaa_obj: Mock_User | null;
+    aaa_str: string;
+    aaa_num: number;
+    aaa_bool: boolean;
+  };
+}>;
 
 /**
- *  测试 computed字段时需要手写类型,可悬停鼠标到key查看类型
+ *  watch computed字段时需要手写类型,可悬停鼠标到key查看类型
  */
-// SubComponent<RootDoc, CompDoc>()({
-//   data: {
-//     aaa_num: 123,
-//   },
-//   computed: {
-//     _aaa_CNum() {
-//       return this.data.Pnum + this.data.aaa_num;
-//     },
-//     aaa_str() {
-//       return 123;
-//     },
-//   },
-//   watch: {
-//     _aaa_CNum(newValue: number, oldValue: number) {
-//       Checking<number, typeof newValue, Test.Pass>;
-
-//       Checking<number, typeof oldValue, Test.Pass>;
-//     },
-//     aaa_str(newValue: 123, oldValue: 123) {
-//       Checking<123, typeof newValue, Test.Pass>;
-
-//       Checking<123, typeof oldValue, Test.Pass>;
-//     },
-//   },
-// });
+SubComponent<RootDoc, CompDoc>()({
+  computed: {
+    aaa_str(): string {
+      return this.data.aaa_num.toString();
+    },
+    aaa_num(): number {
+      return 123;
+    },
+    aaa_bool(): boolean {
+      return this.data.bool;
+    },
+    aaa_obj(): Mock_User {
+      return {} as Mock_User;
+    },
+  },
+  watch: {
+    aaa_num(newValue: number, oldValue: number) {
+      Checking<number, typeof newValue, Test.Pass>;
+
+      Checking<number, typeof oldValue, Test.Pass>;
+    },
+    aaa_str(newValue: string, oldValue: string) {
+      Checking<string, typeof newValue, Test.Pass>;
+
+      Checking<string, typeof oldValue, Test.Pass>;
+    },
+    aaa_bool(newValue: boolean, oldValue: boolean) {
+      Checking<boolean, typeof newValue, Test.Pass>;
+
+      Checking<boolean, typeof oldValue, Test.Pass>;
+    },
+    aaa_obj(newValue: Mock_User, oldValue: Mock_User | null) {
+      Checking<Mock_User, typeof newValue, Test.Pass>;
+
+      Checking<Mock_User | null, typeof oldValue, Test.Pass>;
+    },
+    "aaa_obj.id"(newValue: string, oldValue: string) {
+      Checking<string, typeof newValue, Test.Pass>;
+
+      Checking<string, typeof oldValue, Test.Pass>;
+    },
+    "aaa_obj.age"(newValue: number, oldValue: number) {
+      Checking<number, typeof newValue, Test.Pass>;
+
+      Checking<number, typeof oldValue, Test.Pass>;
+    },
+  },
+});

package/src/api/SubComponent/SubWatch/test/error.test.ts

@@ -5,7 +5,7 @@ import { SubComponent } from "../..";
 SubComponent<{ events: { a: string } }, Wm.View>()({
   watch: {
     // @ts-expect-error 无可监控字段时，约束为EmptyObject,不可写任何字段
-    xxx() {},
+    nothing() {},
   },
 });
 
@@ -14,7 +14,16 @@ SubComponent<{ events: { a: string } }, Wm.View>()({
  */
 SubComponent<{ events: { a: string } }, Wm.View>()({
   data: {
-    // @ts-expect-error 超出字段报错
-    view_classdd: "",
+    view_style: "",
+  },
+  watch: {
+    view_style(newValue, oldValue) { // ok
+      newValue;
+
+      oldValue;
+    },
+    // @ts-expect-error 超出约束字段错误
+    view_XXstyle() {
+    },
   },
 });

package/src/api/SubComponent/index.ts

@@ -21,6 +21,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 +43,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 +51,7 @@ type Options<
   SubEventsDoc extends object,
   SubMethodsDoc extends object,
 > =
-  & { inherit?: TInherit }
+  & SubInheritOption<TInherit>
   & SubDataOption<
     TSubData,
     Exclude<keyof CurrentCompDoc["properties"], (keyof InheritDoc)>,
@@ -67,8 +68,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 +106,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 +117,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<

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;

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

@@ -13,7 +13,15 @@ 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,

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;