annil 1.15.1 → 1.17.0

package/src/api/RootComponent/PageLifetimes/test/normal.test.ts

@@ -2,10 +2,7 @@ import { Checking, type Test } from "hry-types";
 import { type DetailedType, RootComponent } from "../../../..";
 
 import type { Mock_User } from "../../Properties/test/normalRequired.test";
-type User = {
-  name: string;
-  age?: number;
-};
+
 /**
  * 组件时
  */
@@ -49,8 +46,8 @@ RootComponent()({
       void Checking<
         typeof props,
         {
-          union?: Mock_User;
-          optionalObject?: Mock_User | null;
+          union: Mock_User;
+          optionalObject: Mock_User | null;
           str: string;
           obj: object;
         },
@@ -72,28 +69,3 @@ RootComponent()({
     // ...
   },
 });
-// prop中必传对象没有null,但在实例中却需要有null
-RootComponent()({
-  isPage: true,
-  properties: {
-    optionalObj: {
-      type: Object,
-      value: {},
-    },
-    requiredObj: Object as DetailedType<User>,
-  },
-
-  pageLifetimes: {
-    onLoad(prop) {
-      void prop;
-      // 页面外部传值时没必要传null,组件时有需要的。
-      void Checking<typeof prop.requiredObj, User, true>;
-      // 虽然传值不应该是null,但由于实例建立时默认为null,所以实例类型加上null
-      void Checking<typeof this.data.requiredObj, User, true>;
-      // 页面传入的可选对象不需要null,有undefined
-      void Checking<typeof prop.optionalObj, object | undefined, true>;
-      // 实例中的可选对象不需要null,有默认值。
-      void Checking<typeof this.data.optionalObj, object, true>;
-    },
-  },
-});

package/src/api/RootComponent/Store/test/normal.test.ts

@@ -1,3 +1,4 @@
+import { Checking, type Test } from "hry-types";
 import { observable } from "mobx";
 import { typeEqual } from "../../../../utils/_utils";
 import { RootComponent } from "../..";
@@ -9,15 +10,30 @@ const user = observable({
 const storeDoc = RootComponent()({
   properties: {
     condition: Number,
+    optional: {
+      type: Number,
+      value: 10,
+    },
+  },
+  data: {
+    injectStr: 123,
   },
   store: {
-    // normal
+    // 1. 简单的箭头函数写法
     userName: () => user.name,
-    // 条件反应式,当condition>10时,响应式,否则不可响应式(返回undefined),但不报错(有警告).
-    userAge: (props) => {
-      if (props.condition > 10) {
+    // 2. 使用参数 datas
+    userAge: (datas) => {
+      // 参数类型为Required<PropertiesDef> & DataDef & Omit<InjectData, keyof (PropertiesDef & DataDef).
+      Checking<
+        typeof datas,
+        { condition: number; optional: number; injectStr: number; injectNum: number },
+        Test.Pass
+      >();
+
+      if (datas.condition > 10) {
         return user.age;
       }
+      // 返回undefined时字段不会被响应式追踪,不会报错(有警告).
       return undefined;
     },
   },
@@ -25,8 +41,12 @@ const storeDoc = RootComponent()({
 
 type StoreDocExpected = {
   properties: {
+    optional?: number;
     condition: number;
   };
+  data: {
+    injectStr: number;
+  };
   store: {
     userName: string;
     userAge: number | undefined;

package/src/api/RootComponent/index.ts

@@ -6,7 +6,7 @@ import type { ComputeObject } from "../../types/ComputeObject";
 import type { WMCompOtherOption } from "../../types/OfficialTypeAlias";
 import type { RemoveNullOfRequired } from "../../types/RemoveNullOfRequired";
 import type { ComponentDoc } from "../DefineComponent/returnType/ComponentDoc";
-import type { IInjectStore } from "../InstanceInject/instanceConfig";
+import type { IInjectAllData, IInjectMethods, IInjectStore, InjectData } from "../InstanceInject/instanceConfig";
 import type { ComputedConstraint } from "./Computed/ComputedConstraint";
 import type { ComputedOption } from "./Computed/ComputedOption";
 import type { GetComputedDef } from "./Computed/GetComputedDef";
@@ -46,6 +46,8 @@ type RootComponentOptions<
   DataDef extends object,
   StoreDef extends object,
   ComputedDef extends object,
+  SelfAllDatas extends object,
+  ValidInjectDatas extends object,
 > =
   & MethodsOption<TMethods, keyof (EventsDef & CustomEventsDef)>
   & PropertiesOption<TProperties>
@@ -57,7 +59,7 @@ type RootComponentOptions<
   & ComputedOption<
     TComputed,
     keyof (PropertiesDef & DataDef & StoreDef)
-  > // { data: ComputeObject<DataDef & Required<PropertiesDef> & StoreDef & ComputedDef & IInjectAllData> }
+  >
   & PageLifetimesOption<TIsPage, PropertiesDef>
   & LifetimesOption
   & WatchOption<
@@ -78,9 +80,9 @@ type RootComponentOptions<
   & ThisType<
     RootComponentInstance<
       TIsPage,
-      TMethods,
+      TMethods & Omit<IInjectMethods, keyof TMethods>,
       DataDef,
-      DataDef & Required<PropertiesDef> & StoreDef & ComputedDef,
+      SelfAllDatas & ValidInjectDatas,
       CustomEventsDef,
       StoreDef
     >
@@ -88,7 +90,9 @@ type RootComponentOptions<
 
 type RootComponentConstructor<TComponentDocList extends ComponentDoc[]> = <
   TEvents extends EventsConstraint<TComponentDocList>,
-  TStore extends StoreConstraint<PropertiesDef>,
+  TStore extends StoreConstraint<
+    ComputeIntersection<Required<PropertiesDef> & DataDef & Omit<InjectData, keyof (PropertiesDef & DataDef)>>
+  >,
   TIsPage extends boolean = false,
   const TProperties extends PropertiesConstraint = {},
   TData extends object = {},
@@ -100,8 +104,13 @@ type RootComponentConstructor<TComponentDocList extends ComponentDoc[]> = <
   CustomEventsDef extends object = GetCustomEventsDef<TCustomEvents>,
   PropertiesDef extends object = GetPropertiesDef<TProperties>,
   DataDef extends object = TData,
-  StoreDef extends object = StoreConstraint<PropertiesDef> extends TStore ? {} : GetStoreDef<TStore>,
+  StoreDef extends object = StoreConstraint<
+    ComputeIntersection<Required<PropertiesDef> & DataDef & Omit<InjectData, keyof (PropertiesDef & DataDef)>>
+  > extends TStore ? {}
+    : GetStoreDef<TStore>,
   ComputedDef extends object = GetComputedDef<TComputed>,
+  SelfAllDatas extends object = Required<PropertiesDef> & DataDef & StoreDef & ComputedDef,
+  ValidInjectDatas extends object = Omit<IInjectAllData, keyof SelfAllDatas>,
 >(
   options: RootComponentOptions<
     TEvents,
@@ -118,7 +127,9 @@ type RootComponentConstructor<TComponentDocList extends ComponentDoc[]> = <
     PropertiesDef,
     DataDef,
     StoreDef,
-    ComputedDef
+    ComputedDef,
+    SelfAllDatas,
+    ValidInjectDatas
   >,
 ) => // 生成RootComponentDefinition
 ComputeIntersection<
@@ -149,3 +160,5 @@ export function RootComponent<
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   return (options: any) => options;
 }
+
+// 全局实例增加 有效的注入数据,store字段参数包含 (prop + data + 有效的注入数据)

package/src/api/{CustomComponent/CustomComputed/GetCustomComputedDoc.ts → SubComponent/SubComputed/GetSubComputedDoc.ts}

@@ -1,4 +1,4 @@
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
-export type GetCustomComputedDoc<TComputed extends Record<string, any>> = {
+export type GetSubComputedDoc<TComputed extends Record<string, any>> = {
   [k in keyof TComputed]: ReturnType<TComputed[k]>;
 };

package/src/api/SubComponent/SubComputed/SubComputedConstraint.ts

@@ -0,0 +1 @@
+export type SubComputedConstraint<obj extends object> = { [k in keyof obj]?: () => obj[k] };

package/src/api/{CustomComponent/CustomComputed/CustomComputedOption.ts → SubComponent/SubComputed/SubComputedOption.ts}

@@ -1,5 +1,5 @@
 import type { G } from "hry-types";
-export type CustomComputedOption<
+export type SubComputedOption<
   TComputed extends object,
   legal extends PropertyKey,
 > // Instance extends object,

package/src/api/{CustomComponent/CustomComputed → SubComponent/SubComputed}/test/error.test.ts

@@ -1,12 +1,12 @@
 import type { ComponentDoc } from "../../../DefineComponent/returnType/ComponentDoc";
-import { CustomComponent } from "../..";
+import { SubComponent } from "../..";
 
 type OnlyCustomCompDoc = ComponentDoc<{
   events: { aaa_str: string };
 }>;
 
 // 1 CompDoc的properties为空时,写任何字段都报错
-CustomComponent<{}, OnlyCustomCompDoc>()({
+SubComponent<{}, OnlyCustomCompDoc>()({
   computed: {
     // @ts-expect-error ⚠️"重复或无效的字段"⚠️
     aaa_xxx() {
@@ -23,7 +23,7 @@ type OnlyPropsCompDoc = ComponentDoc<{
 }>;
 
 // 2 去除inhrit和data字段后无组件字段约束时,只可写内部字段
-CustomComponent<{}, OnlyPropsCompDoc>()({
+SubComponent<{}, OnlyPropsCompDoc>()({
   inherit: {
     aaa_str: "wxml",
   },
@@ -42,7 +42,7 @@ CustomComponent<{}, OnlyPropsCompDoc>()({
 });
 
 // 3 类型错误
-CustomComponent<{}, OnlyPropsCompDoc>()({
+SubComponent<{}, OnlyPropsCompDoc>()({
   inherit: {
     aaa_str: "wxml",
   },
@@ -54,7 +54,7 @@ CustomComponent<{}, OnlyPropsCompDoc>()({
   },
 });
 // 4 与data的内部字段重复
-CustomComponent<{}, OnlyPropsCompDoc>()({
+SubComponent<{}, OnlyPropsCompDoc>()({
   data: {
     _aaa_fff: 123,
   },
@@ -66,7 +66,7 @@ CustomComponent<{}, OnlyPropsCompDoc>()({
   },
 });
 // 5 与store的内部字段重复
-CustomComponent<{}, OnlyPropsCompDoc>()({
+SubComponent<{}, OnlyPropsCompDoc>()({
   store: {
     _aaa_ccc: () => 123,
   },
@@ -78,7 +78,7 @@ CustomComponent<{}, OnlyPropsCompDoc>()({
   },
 });
 // 6 与root字段重复
-CustomComponent<{ data: { _aaa_ccc: 123 } }, OnlyPropsCompDoc>()({
+SubComponent<{ data: { _aaa_ccc: 123 } }, OnlyPropsCompDoc>()({
   computed: {
     // @ts-expect-error 与store的内部字段重复
     _aaa_ccc(): number {

package/src/api/{CustomComponent/CustomComputed → SubComponent/SubComputed}/test/normal.test.ts

@@ -4,7 +4,7 @@ import type { ComponentDoc } from "../../../DefineComponent/returnType/Component
 import type { ComputeIntersection } from "hry-types/src/Object/ComputeIntersection";
 import type { IInjectAllData } from "../../../InstanceInject/instanceConfig";
 import type { Mock_User } from "../../../RootComponent/Properties/test/normalRequired.test";
-import { CustomComponent } from "../..";
+import { SubComponent } from "../..";
 
 type OnlyCustomCompDoc = ComponentDoc<{
   events: { aaa_str: string };
@@ -35,7 +35,7 @@ type $aaa = ComponentDoc<
   { properties: { aaa_str: string; aaa_user: User | null; aaa_num: number; aaa_age: number } }
 >;
 
-CustomComponent<{}, OnlyCustomCompDoc>()({
+SubComponent<{}, OnlyCustomCompDoc>()({
   // 1 CompDoc的properties为空时,可以写{}
   computed: {},
 });
@@ -49,7 +49,7 @@ type OnlyPropsCompDoc = ComponentDoc<{
   };
 }>;
 
-CustomComponent<Root, OnlyPropsCompDoc>()({
+SubComponent<Root, OnlyPropsCompDoc>()({
   inherit: {
     aaa_num: "num",
   },
@@ -67,7 +67,7 @@ CustomComponent<Root, OnlyPropsCompDoc>()({
   },
 });
 // 3 computed字段的返回类型应为对应的文档类型,避免返回字面量类型导致与实际文档类型不符
-CustomComponent<Root, OnlyPropsCompDoc>()({
+SubComponent<Root, OnlyPropsCompDoc>()({
   computed: {
     aaa_num() {
       return 123;
@@ -127,7 +127,7 @@ CustomComponent<Root, OnlyPropsCompDoc>()({
 
 // 计算属性可互相引用,但要加返回类型注释
 
-CustomComponent<Root, $aaa>()({
+SubComponent<Root, $aaa>()({
   computed: {
     aaa_num(): number {
       return this.data.SNum;
@@ -144,7 +144,7 @@ CustomComponent<Root, $aaa>()({
   },
 });
 // 计算属性this.data可获取store和data的字段中文档中的字段和内部字段(_开头的字段)
-CustomComponent<Root, $aaa>()({
+SubComponent<Root, $aaa>()({
   data: {
     aaa_age: 123,
     _aaa_age1: 123,
@@ -161,7 +161,7 @@ CustomComponent<Root, $aaa>()({
   },
 });
 // computed中可写 额外字段 isReady
-CustomComponent<{ data: { _num: number } }, $aaa>()({
+SubComponent<{ data: { _num: number } }, $aaa>()({
   computed: {
     aaa_isReady() {
       return true;
@@ -170,7 +170,7 @@ CustomComponent<{ data: { _num: number } }, $aaa>()({
 });
 
 // computed中可写 内部字段
-CustomComponent<{ data: { _num: number } }, $aaa>()({
+SubComponent<{ data: { _num: number } }, $aaa>()({
   computed: {
     aaa_isReady() {
       return true;
@@ -185,7 +185,7 @@ CustomComponent<{ data: { _num: number } }, $aaa>()({
 type Custom = { type: "custom"; xxx: string };
 type Chunk = { type: "chunk"; yyy: number };
 type Union = Custom | Chunk;
-CustomComponent<{ data: { _num: number }; methods: { IsChunk: (union: Union) => union is Chunk } }, $aaa>()({
+SubComponent<{ data: { _num: number }; methods: { IsChunk: (union: Union) => union is Chunk } }, $aaa>()({
   data: {
     _aaa_union: { type: "custom", xxx: "123" } as Union,
   },

package/src/api/{CustomComponent/CustomData/CustomDataConstraint.ts → SubComponent/SubData/SubDataConstraint.ts}

@@ -2,7 +2,7 @@
  * 子组件Data字段约束
  * @returns 当剩余对象不为空对象,约束对象的key为剩余key,类型为剩余key对应的文档类型.
  */
-export type CustomDataConstraint<
+export type SubDataConstraint<
   TComponentDoc extends object,
 > = {
   [k in keyof TComponentDoc]?: TComponentDoc[k];

package/src/api/{CustomComponent/CustomData/CustomDataOption.ts → SubComponent/SubData/SubDataOption.ts}

@@ -1,6 +1,6 @@
 import type { G } from "hry-types";
 
-export type CustomDataOption<TData extends object, legalKeys extends PropertyKey, errMsg extends string> = {
+export type SubDataOption<TData extends object, legalKeys extends PropertyKey, errMsg extends string> = {
   /**
    * 可写子组件所需数据和内部公共数据
    * 非法字段检测和与Inherit字段的重复检测

package/src/api/{CustomComponent/CustomData → SubComponent/SubData}/test/error.test.ts

@@ -1,14 +1,14 @@
 import type { ComponentDoc } from "../../../DefineComponent/returnType/ComponentDoc";
 
 import type { Mock_User } from "../../../RootComponent/Properties/test/normalRequired.test";
-import { CustomComponent } from "../..";
+import { SubComponent } from "../..";
 
 type OnlyCustomCompDoc = ComponentDoc<{
   events: { aaa_str: string };
 }>;
 
 // 1 CompDoc无properties字段时 data字段只可写内部字段
-CustomComponent<{}, OnlyCustomCompDoc>()({
+SubComponent<{}, OnlyCustomCompDoc>()({
   data: {
     // @ts-expect-error "⚠️ 与Inherit字段重复或组件文档无需字段 ⚠️"
     aaa_str: "str",
@@ -25,7 +25,7 @@ type OnlyPropsCompDoc = ComponentDoc<{
 }>;
 
 // 2 CompDoc有properties字段但去除Inherit字段后为空,只可写内部字段
-CustomComponent<{}, OnlyPropsCompDoc>()({
+SubComponent<{}, OnlyPropsCompDoc>()({
   inherit: {
     aaa_str: "wxml",
     aaa_num: "wxml",
@@ -41,7 +41,7 @@ CustomComponent<{}, OnlyPropsCompDoc>()({
 });
 
 // 3 重复字段和非组件所需字段错误
-CustomComponent<{}, OnlyPropsCompDoc>()({
+SubComponent<{}, OnlyPropsCompDoc>()({
   inherit: {
     aaa_str: "wxml",
   },
@@ -56,7 +56,7 @@ CustomComponent<{}, OnlyPropsCompDoc>()({
   },
 });
 // 4 与root的数据字段重复
-CustomComponent<{ data: { aaa_str: 123 } }, OnlyPropsCompDoc>()({
+SubComponent<{ data: { aaa_str: 123 } }, OnlyPropsCompDoc>()({
   data: {
     // @ts-expect-error 与root的data字段重复
     aaa_str: "a",

package/src/api/{CustomComponent/CustomData → SubComponent/SubData}/test/normal.test.ts

@@ -4,7 +4,7 @@ import type { ComponentDoc } from "../../../DefineComponent/returnType/Component
 import type { ComputeIntersection } from "hry-types/src/Object/ComputeIntersection";
 import type { IInjectAllData } from "../../../InstanceInject/instanceConfig";
 import type { Mock_User } from "../../../RootComponent/Properties/test/normalRequired.test";
-import { CustomComponent } from "../..";
+import { SubComponent } from "../..";
 
 type CompDoc = ComponentDoc<{
   properties: {
@@ -14,7 +14,7 @@ type CompDoc = ComponentDoc<{
   };
 }>;
 
-CustomComponent<{}, CompDoc>()({
+SubComponent<{}, CompDoc>()({
   inherit: {
     aaa_obj: "wxml",
   },
@@ -27,7 +27,7 @@ CustomComponent<{}, CompDoc>()({
   },
 });
 
-CustomComponent<{ data: { _num: number } }, CompDoc>()({
+SubComponent<{ data: { _num: number } }, CompDoc>()({
   inherit: {
     aaa_str: "wxml",
     aaa_num: "wxml",
@@ -39,7 +39,7 @@ CustomComponent<{ data: { _num: number } }, CompDoc>()({
   },
 });
 
-CustomComponent<{}, CompDoc>()({
+SubComponent<{}, CompDoc>()({
   data: {
     aaa_str: "a" as "a" | "b",
     aaa_num: 123 as number,
@@ -66,7 +66,7 @@ CustomComponent<{}, CompDoc>()({
 });
 
 // 确保实例和setData中使用的data字段类型为文档中定义的类型而非data配置中的类型(data中配置的类型可能推导默认为字面量类型,通过加入Replace泛型替换为对应的文档类型。),
-CustomComponent<{ data: { _num: number } }, CompDoc>()({
+SubComponent<{ data: { _num: number } }, CompDoc>()({
   data: {
     aaa_obj: null, // 类型为null 而非 Mock_User | null
     aaa_str: "a", // 类型为"a" 而非string
@@ -84,7 +84,7 @@ CustomComponent<{ data: { _num: number } }, CompDoc>()({
   },
 });
 // data中可写 额外字段 isReady
-CustomComponent<{ data: { _num: number } }, CompDoc>()({
+SubComponent<{ data: { _num: number } }, CompDoc>()({
   data: {
     aaa_isReady: false,
   },

package/src/api/{CustomComponent/CustomEvents/CustomEventsConstraint.ts → SubComponent/SubEvents/SubEventsConstraint.ts}

@@ -7,7 +7,7 @@ import type { Bubbles, Capture, CustomEventsTags } from "../../RootComponent/Cus
 /**
  * 把组件事件类型转为函数类型,冒泡事件捕获事件会多一个加后缀(_catch)的key,表示阻止事件冒泡和捕获。
  */
-export type CustomEventsConstraint<
+export type SubEventsConstraint<
   CompDoc extends ComponentDoc,
 > = {
   [

package/src/api/{CustomComponent/CustomEvents/CustomEventsOption.ts → SubComponent/SubEvents/SubEventsOption.ts}

@@ -1,6 +1,6 @@
 import type { G } from "hry-types";
 
-export type CustomEventsOption<TSubEvents, SubEventsDoc extends object, legalKeys extends PropertyKey> = {
+export type SubEventsOption<TSubEvents, SubEventsDoc extends object, legalKeys extends PropertyKey> = {
   /**
    * 子组件事件(基础事件|自定义事件)
    * 可使用内部泛型(Detail、Mark、WMBaseEvent、WMCustomEvent、CurrentTargetDataset、TargetDataset)自定义事件类型

package/src/api/{CustomComponent/CustomEvents → SubComponent/SubEvents}/test/error.test.ts

@@ -1,6 +1,6 @@
 import type { ComponentDoc } from "../../../DefineComponent/returnType/ComponentDoc";
 import type { Bubbles } from "../../../RootComponent/CustomEvents/CustomEventsTag";
-import { CustomComponent } from "../..";
+import { SubComponent } from "../..";
 
 type CompDoc = ComponentDoc<{
   properties: {
@@ -9,7 +9,7 @@ type CompDoc = ComponentDoc<{
 }>;
 
 // 组件文档无自定义事件时,events字段类型为EmptyObject
-CustomComponent<{}, CompDoc>()({
+SubComponent<{}, CompDoc>()({
   events: {
     // @ts-expect-error 非法字段
     xxx: 123,
@@ -23,7 +23,7 @@ type CompDoc1 = ComponentDoc<{
 }>;
 
 // 非法字段检测 组件文档有自定义事件时,events下的字段仅可写文档包含字段
-CustomComponent<{}, CompDoc1>()({
+SubComponent<{}, CompDoc1>()({
   events: {
     aaa_str(e) { // ok
       void e;

package/src/api/{CustomComponent/CustomEvents → SubComponent/SubEvents}/test/normal.test.ts

@@ -14,7 +14,7 @@ import type {
   CaptureComposed,
 } from "../../../RootComponent/CustomEvents/CustomEventsTag";
 import type { Mock_User } from "../../../RootComponent/Properties/test/normalRequired.test";
-import { CustomComponent } from "../..";
+import { SubComponent } from "../..";
 
 type CompDoc = ComponentDoc<{
   events: {
@@ -29,7 +29,7 @@ type CompDoc = ComponentDoc<{
 }>;
 
 // 1.1 events字段提示 key为 CompDoc下customEvents的字段,类型为函数(e)=>void,e为对应keys类型去除事件标记(冒泡 捕获 穿透)
-const custom1 = CustomComponent<{}, CompDoc>()({
+const custom1 = SubComponent<{}, CompDoc>()({
   events: {
     aaa_str(e) {
       Checking<typeof e.detail, string, Test.Pass>;
@@ -76,7 +76,7 @@ type custom1Expected = {
 Checking<typeof custom1, custom1Expected, Test.Pass>;
 
 // 2.1 key可写入后缀字段(_catch,表示阻止冒泡和捕获事件)。
-const custom2 = CustomComponent<{}, CompDoc>()({
+const custom2 = SubComponent<{}, CompDoc>()({
   events: {
     aaa_BubblesComposed_catch(e) {
       Checking<typeof e.detail, string, Test.Pass>;
@@ -98,7 +98,7 @@ Checking<typeof custom2, {
   // };
 }, Test.Pass>;
 
-const custom3 = CustomComponent<{}, CompDoc>()({
+const custom3 = SubComponent<{}, CompDoc>()({
   events: {
     aaa_BubblesComposed_catch(e) {
       Checking<typeof e.detail, string, Test.Pass>;
@@ -116,7 +116,7 @@ const custom3 = CustomComponent<{}, CompDoc>()({
 Checking<typeof custom3, never, Test.Pass>;
 
 // 3.1 基础组件基本事件参数为WMBaseEvent
-CustomComponent<{}, Wm.View>()({
+SubComponent<{}, Wm.View>()({
   events: {
     view_tap(e) {
       Checking<typeof e, WMBaseEvent, Test.Pass>;
@@ -129,7 +129,7 @@ CustomComponent<{}, Wm.View>()({
 });
 
 // 3.1 基础组件自定义事件参数为Detail<object>
-CustomComponent<{}, Wm.ScrollView>()({
+SubComponent<{}, Wm.ScrollView>()({
   events: {
     scrollView_bindscroll(e) {
       Checking<
@@ -150,7 +150,7 @@ CustomComponent<{}, Wm.ScrollView>()({
 });
 
 // 4 可为事件自定义类型
-CustomComponent<{}, Wm.View>()({
+SubComponent<{}, Wm.View>()({
   events: {
     view_tap(e: Detail<number>) {
       Checking<typeof e.detail, number, Test.Pass>;
@@ -163,7 +163,7 @@ CustomComponent<{}, Wm.View>()({
 });
 
 // 4 可为事件自定义类型
-CustomComponent<{}, Wm.View>()({
+SubComponent<{}, Wm.View>()({
   events: {
     view_tap(e: Detail<number>) {
       Checking<typeof e.detail, number, Test.Pass>;
@@ -176,7 +176,7 @@ CustomComponent<{}, Wm.View>()({
 });
 
 // 5 可以调用自身事件
-CustomComponent<{ methods: { aaa: () => string } }, Wm.View>()({
+SubComponent<{ methods: { aaa: () => string } }, Wm.View>()({
   methods: {
     view_xxx() {
       return 123;
@@ -190,7 +190,7 @@ CustomComponent<{ methods: { aaa: () => string } }, Wm.View>()({
   },
 });
 // 5 可以调用自身事件
-CustomComponent<{ methods: { aaa: () => string } }, Wm.Map>()({
+SubComponent<{ methods: { aaa: () => string } }, Wm.Map>()({
   methods: {
     map_xxx() {
       return 123;

package/src/api/{CustomComponent/CustomInherit/CustomInheritConstraint.ts → SubComponent/SubInherit/SubInheritConstraint.ts}

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

package/src/api/{CustomComponent/CustomInherit/CustomInheritOption.ts → SubComponent/SubInherit/SubInheritOption.ts}

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

package/src/api/{CustomComponent/CustomInherit → SubComponent/SubInherit}/test/error.test.ts

@@ -2,8 +2,8 @@ import { Checking, type Test } from "hry-types";
 import { DefineComponent } from "../../../DefineComponent";
 import type { ComponentDoc } from "../../../DefineComponent/returnType/ComponentDoc";
 import type { RootComponentDefinition } from "../../../RootComponent/returnType";
-import { CustomComponent } from "../..";
-import type { CustomComponentDefinition } from "../../returnType";
+import { SubComponent } from "../..";
+import type { SubComponentDefinition } from "../../returnType";
 
 type Mock_RootDoc = RootComponentDefinition<{
   properties: {
@@ -37,7 +37,7 @@ type Mock_CompDoc = ComponentDoc<{
 }>;
 
 // 1 继承字段类型错误
-CustomComponent<Mock_RootDoc, Mock_CompDoc>()({
+SubComponent<Mock_RootDoc, Mock_CompDoc>()({
   inherit: {
     // @ts-expect-error 1.1 [string | number] 不是 [number] 的子集
     aaa_num: "unionStrNum",
@@ -49,13 +49,13 @@ CustomComponent<Mock_RootDoc, Mock_CompDoc>()({
 });
 
 // 2 inherit字段最终不会在组件配置中,意义在于通过声明继承字段便于类型判断,配置是否满足子组件文档的需求。下面示例中,配置不满足组件需求,Mock_CompDoc需要一些必传字段没有配置,即使这些字段存在在于根组件(或wmxl).而返回的字符串(错误),无法通过DefinedComponent Api 类型检测。
-const customDoc = CustomComponent<Mock_RootDoc, Mock_CompDoc>()({
+const customDoc = SubComponent<Mock_RootDoc, Mock_CompDoc>()({
   data: {
     aaa_num: 123,
   },
 });
 
-void Checking<typeof customDoc, CustomComponentDefinition, Test.Fail>;
+void Checking<typeof customDoc, SubComponentDefinition, Test.Fail>;
 
 DefineComponent({
   name: "xxx",
@@ -65,7 +65,7 @@ DefineComponent({
 
 // 3 错误的key检查
 
-CustomComponent<Mock_RootDoc, Mock_CompDoc>()({
+SubComponent<Mock_RootDoc, Mock_CompDoc>()({
   inherit: {
     aaa_num: "required_num",
     // @ts-expect-error 3.1 不存在于组件中的key给错误提示
@@ -76,7 +76,7 @@ CustomComponent<Mock_RootDoc, Mock_CompDoc>()({
 });
 // 4 数组时类型错误
 
-CustomComponent<Mock_RootDoc, Mock_CompDoc>()({
+SubComponent<Mock_RootDoc, Mock_CompDoc>()({
   inherit: {
     // @ts-expect-error   取消了数组类型,之前的版本允许数组类型表示三元表达式
     aaa_num: ["optional_lit1eral_num", "require1d_num"],