annil 1.1.1 → 1.2.0-beta.0

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

@@ -1,6 +1,7 @@
 import { Checking, type Test } from "hry-types";
 import type { Wm } from "../../../../thirdLib";
-import type { Detail, WMBaseEvent } from "../../../../types/OfficialTypeAlias";
+
+import type { Detail, Mark, WMBaseEvent } from "../../../..";
 import type { ComponentDoc } from "../../../DefineComponent/ReturnType/ComponentDoc";
 import type {
   Bubbles,
@@ -10,6 +11,7 @@ import type {
   Capture,
   CaptureComposed,
 } from "../../../RootComponent/CustomEvents/CustomEventsTag";
+import type { Mock_User } from "../../../RootComponent/Properties/test/normalRequired.test";
 import { SubComponent } from "../..";
 
 type CompDoc = ComponentDoc<{
@@ -51,13 +53,13 @@ const sub1 = SubComponent<{}, CompDoc>()({
   },
 });
 
-// 1.2 Composed事件会被返回
 type Sub1Expected = {
   BubblesComposed: string | BubblesComposed;
   CapturePhaseComposed: string | CaptureComposed;
   BubblesCapturePhaseComposed: string | BubblesCaptureComposed;
 };
 
+// 1.2 Composed事件会被返回
 Checking<typeof sub1, Sub1Expected, Test.Pass>;
 
 // 2.1 key可写入后缀字段(_catch,表示阻止冒泡和捕获事件)。
@@ -75,7 +77,6 @@ const sub2 = SubComponent<{}, CompDoc>()({
 // 2.2 返回没有被加后最(_catch)的Composed事件
 Checking<typeof sub2, { BubblesCapturePhaseComposed: string | BubblesCaptureComposed }, Test.Pass>;
 
-// 2.3 key可写入后缀字段(_catch,表示阻止冒泡和捕获事件)。
 const sub3 = SubComponent<{}, CompDoc>()({
   events: {
     aaa_BubblesComposed_catch(e) {
@@ -106,7 +107,7 @@ SubComponent<{}, Wm.View>()({
   },
 });
 
-// 3.2 基础组件自定义事件参数为Detail<object>
+// 3.1 基础组件自定义事件参数为Detail<object>
 SubComponent<{}, Wm.ScrollView>()({
   events: {
     scrollView_bindscroll(e) {
@@ -126,3 +127,29 @@ SubComponent<{}, Wm.ScrollView>()({
     // ...
   },
 });
+
+// 4 可为事件自定义类型
+SubComponent<{}, Wm.View>()({
+  events: {
+    view_tap(e: Detail<number>) {
+      Checking<typeof e.detail, number, Test.Pass>;
+    },
+    view_longtap(e: Mark<Mock_User>) {
+      Checking<typeof e.mark, Mock_User, Test.Pass>;
+    },
+    // ...
+  },
+});
+
+// 4 可为事件自定义类型
+SubComponent<{}, Wm.View>()({
+  events: {
+    view_tap(e: Detail<number>) {
+      Checking<typeof e.detail, number, Test.Pass>;
+    },
+    view_longtap(e: Mark<Mock_User>) {
+      Checking<typeof e.mark, Mock_User, Test.Pass>;
+    },
+    // ...
+  },
+});

package/src/api/SubComponent/SubInherit/SubInheritConstraint.ts

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

package/src/api/SubComponent/SubInherit/SubInheritOption.ts

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

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

@@ -17,6 +17,8 @@ type Mock_RootDoc = RootComponentDoc<{
     str: string;
     literal_str: "a" | "b" | "c";
     bool: boolean;
+    _num: number;
+    _str: string;
   };
   computed: {
     Cuinon: string | boolean;
@@ -34,19 +36,19 @@ type Mock_CompDoc = ComponentDoc<{
   };
 }>;
 
-// RootDoc不为空时,可继承对应类型的字段。
+// 1 继承字段类型错误
 SubComponent<Mock_RootDoc, Mock_CompDoc>()({
   inherit: {
-    // @ts-expect-error  [string | number] 不是 [number] 的子集
+    // @ts-expect-error 1.1 [string | number] 不是 [number] 的子集
     aaa_num: "unionStrNum",
-    // @ts-expect-error  [123 | 456 | 789] 不是 [123 | 456] 的子集
+    // @ts-expect-error 1.2 [123 | 456 | 789] 不是 [123 | 456] 的子集
     aaa_literal_num: "optional_literal_num",
-    // @ts-expect-error  [string | number] 不是 [string] 的子集
-    aaa_str: "" as "unionStrNum",
+    // @ts-expect-error 1.3 不可继承内部字段
+    aaa_str: "_str",
   },
 });
 
-// inherit字段最终不会在组件配置中,意义在于通过声明继承字段便于类型判断,配置是否满足组件的需求。下面示例中,配置不满足组件需求,Mock_CompDoc需要一些必传字段没有配置,即使这些字段存在在于根组件(或wmxl).而返回的字符串(错误),无法通过DefinedComponent Api 类型检测。
+// 2 inherit字段最终不会在组件配置中,意义在于通过声明继承字段便于类型判断,配置是否满足子组件文档的需求。下面示例中,配置不满足组件需求,Mock_CompDoc需要一些必传字段没有配置,即使这些字段存在在于根组件(或wmxl).而返回的字符串(错误),无法通过DefinedComponent Api 类型检测。
 const subDoc = SubComponent<Mock_RootDoc, Mock_CompDoc>()({
   data: {
     aaa_num: 123,
@@ -57,6 +59,6 @@ Checking<typeof subDoc, SubComponentDoc, Test.Fail>;
 
 DefineComponent({
   name: "xxx",
-  // @ts-expect-error 不能将类型“string”分配给类型“_SubComponentDoc”。
+  // @ts-expect-error 2 不能将类型“string”分配给类型“_SubComponentDoc”。
   subComponents: [subDoc],
 });

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

@@ -2,13 +2,16 @@ import type { ComponentDoc } from "../../../DefineComponent/ReturnType/Component
 import type { RootComponentDoc } from "../../../RootComponent/RootComponentDoc";
 import { SubComponent } from "../..";
 
+/**
+ * inherit字段最终会在选项中删除,它用ts开发类型检测。
+ */
 type Mock_RootDoc = RootComponentDoc<{
   properties: {
     required_num: number;
     optional_literal_num?: 123 | 456 | 789;
     unionStrNum: string | number;
     required_obj: object | null;
-    optional_obj?: object;
+    optional_obj?: object | null;
   };
   data: {
     str: string;
@@ -31,7 +34,7 @@ type Mock_CompDoc = ComponentDoc<{
   };
 }>;
 
-// 1 没有可继承的数据,类型可为'wxml',表示数据来自wxml(例如数据来自父组件循环wx:for后的数据等情况)
+// 1 没有可继承的数据,类型可为'wxml',表示数据来自wxml(例如数据来自父元素循环wx:for后的数据等情况)
 SubComponent<{}, Mock_CompDoc>()({
   inherit: {
     aaa_num: "wxml",
@@ -51,5 +54,3 @@ SubComponent<Mock_RootDoc, Mock_CompDoc>()({
     aaa_obj1: "" as "required_obj" | "optional_obj" | "wxml",
   },
 });
-
-// inherit字段最终会在配置对象中删除,它用类型检测。

package/src/api/SubComponent/SubMethods/SubMethodsOption.ts

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

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

@@ -1,4 +1,5 @@
 import type { ComponentDoc } from "../../../DefineComponent/ReturnType/ComponentDoc";
+import type { Bubbles } from "../../../RootComponent/CustomEvents/CustomEventsTag";
 import type { RootComponentDoc } from "../../../RootComponent/RootComponentDoc";
 import { SubComponent } from "../..";
 
@@ -16,22 +17,29 @@ type RootDoc = RootComponentDoc<{
 
 type CompDoc = ComponentDoc<{
   customEvents: {
-    aaa_str: string;
+    aaa_str: string | Bubbles;
   };
 }>;
 
-// 前缀错误
+// 1 前缀错误
 SubComponent<RootDoc, CompDoc>()({
   methods: {
-    // @ts-expect-error 前缀错误
+    // @ts-expect-error 1.1 前缀错误
     xxx_yyy() {},
   },
 });
 
-// 与组件事件字段重复
+// 2 重复检测
 SubComponent<RootDoc, CompDoc>()({
+  events: {
+    aaa_str_catch() {
+    },
+  },
   methods: {
-    // @ts-expect-error 与组件事件字段重复
+    // @ts-expect-error 2.1 与组件自定义事件字段重复
     aaa_str() {},
+    // @ts-expect-error 2.2 与events字段重复
+    aaa_str_catch() {
+    },
   },
 });

package/src/api/SubComponent/SubMethods/test/normarl.test.ts

@@ -6,12 +6,6 @@ type RootDoc = RootComponentDoc<{
   methods: {
     Mstr: () => string;
   };
-  events: {
-    Estr: () => string;
-  };
-  customEvents: {
-    Cstr: string;
-  };
 }>;
 
 type CompDoc = ComponentDoc<{
@@ -20,12 +14,7 @@ type CompDoc = ComponentDoc<{
   };
 }>;
 
-// 默认可以为{}。
-SubComponent<RootDoc, CompDoc>()({
-  methods: {},
-});
-
-// methods字段可以写 任意字段函数,不与RootDoc和CompDoc中的方法字段重复即可,前缀为CompDoc的前缀
+// methods字段同组件前缀
 SubComponent<RootDoc, CompDoc>()({
   methods: {
     aaa_xxx() {},
@@ -33,3 +22,8 @@ SubComponent<RootDoc, CompDoc>()({
     // ...
   },
 });
+
+// 2 默认可以为{}。
+SubComponent<RootDoc, CompDoc>()({
+  methods: {},
+});

package/src/api/SubComponent/SubPageLifetimes/SubPageLifetimesOption.ts

@@ -1,6 +1,6 @@
 import type { PageLifetimesOption } from "../../RootComponent/PageLifetimes/PageLifetimesOption";
 
-export type SubPageLifetimesOption<TIsPage extends boolean, AllPropertiesDoc extends object> = PageLifetimesOption<
+export type SubPageLifetimesOption<TIsPage extends boolean, PropertiesDoc extends object> = PageLifetimesOption<
   TIsPage,
-  AllPropertiesDoc
+  PropertiesDoc
 >;

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

@@ -1,32 +1 @@
-import type { RootComponentDoc } from "../../../RootComponent/RootComponentDoc";
-import { SubComponent } from "../..";
-
-type RootDocCompPage = RootComponentDoc<{
-  isPage: true;
-}>;
-
-type CompDoc = RootComponentDoc<{
-  properties: {
-    aaa_str: string;
-  };
-}>;
-
-/**
- * 测试 组件时
- */
-SubComponent<{}, CompDoc>()({
-  pageLifetimes: {
-    // @ts-expect-error 不存在的字段 show是正确字段
-    onShow() {},
-  },
-});
-
-/**
- * 页面时
- */
-SubComponent<RootDocCompPage, CompDoc>()({
-  pageLifetimes: {
-    // @ts-expect-error 不存在的字段 多了一个 `d`
-    onLoadd() {},
-  },
-});
+// 同 RootComponent的PageLifetimes

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() {
+    },
   },
 });