annil 1.5.11 → 1.5.13

package/CHANGELOG.md

@@ -4,6 +4,20 @@
 
 * 解决DetailedType不接收接口类型的错误 ([ae8acbf](https://github.com/missannil/annil/commit/ae8acbfc2e62f99db565c448ad9253aa549e78bb))
 
+## [1.5.13](https://github.com/missannil/annil/compare/v1.5.12...v1.5.13) (2024-01-12)
+
+
+### Bug Fixes
+
+* 修改自定义事件detail类型为ReadOnlyDeep,以便调用时可传入实例中的data类型(都是ReadOnlyDeep的) ([428710e](https://github.com/missannil/annil/commit/428710ea84717c45361d1e6c9c7db46c693026a9))
+
+## [1.5.12](https://github.com/missannil/annil/compare/v1.5.11...v1.5.12) (2024-01-12)
+
+
+### Bug Fixes
+
+* setData时data中的数据类型不是组件类型的错误 ([871ac43](https://github.com/missannil/annil/commit/871ac439d1786cb74fb752e353a1f953d11de780))
+
 ## [1.5.11](https://github.com/missannil/annil/compare/v1.5.10...v1.5.11) (2024-01-08)
 
 

package/dist/api/RootComponent/CustomEvents/GetCustomEventDoc.d.ts

@@ -1,8 +1,9 @@
+import type { ReadonlyDeep } from "hry-types/src/Any/ReadonlyDeep";
 import type { DetailedType } from "../../../types/DetailedType";
 import type { InferDetailedType } from "../../../types/InferDetailedType";
 import type { CustomEventConstraint, FullCustomEvents, ShortCustomeEvents, SimpleCustomeEventsList } from "./CustomEventConstraint";
 import type { AddTagForCustomEventsDoc } from "./CustomEventsTag";
-export type GetShortCustomEventsDoc<T extends ShortCustomeEvents> = T extends DetailedType ? InferDetailedType<T> : T extends null ? null : T extends undefined ? undefined : T extends SimpleCustomeEventsList ? GetShortCustomEventsDoc<T[number]> : never;
+export type GetShortCustomEventsDoc<T extends ShortCustomeEvents> = T extends DetailedType ? ReadonlyDeep<InferDetailedType<T>> : T extends null ? null : T extends undefined ? undefined : T extends SimpleCustomeEventsList ? GetShortCustomEventsDoc<T[number]> : never;
 export type GetFullCustomEventsDoc<T extends FullCustomEvents> = GetShortCustomEventsDoc<T["detail"]> | AddTagForCustomEventsDoc<T["options"]>;
 export type GetCustomEventDoc<T extends CustomEventConstraint> = {
     [k in keyof T]: T[k] extends ShortCustomeEvents ? GetShortCustomEventsDoc<T[k]> : GetShortCustomEventsDoc<T[k]["detail"]> | AddTagForCustomEventsDoc<T[k]["options"]>;

package/dist/api/RootComponent/Instance/RootComponentInstance.d.ts

@@ -7,7 +7,7 @@ import type { WMComponentInstance, WMInstanceMethods, WMPageInstance } from "../
 import type { IInjectData, IInjectMethods } from "../../InstanceInject/instanceConfig";
 import type { CustomEventMethods } from "./CustomEventMethods";
 import type { CustomSetData } from "./CustomSetData";
-export type RootComponentInstance<TIsPage extends boolean, TMethods extends object, TData extends object, AllData extends object, CustomEventsDoc extends object, StoreDoc extends object> = IfExtends<false, TIsPage, WMComponentInstance, WMPageInstance> & Omit<WMInstanceMethods<{}>, "setData"> & CustomSetData<TData> & IfExtends<{}, StoreDoc, unknown, {
+export type RootComponentInstance<TIsPage extends boolean, TMethods extends object, TDataForSetData extends object, AllData extends object, CustomEventsDoc extends object, StoreDoc extends object> = IfExtends<false, TIsPage, WMComponentInstance, WMPageInstance> & Omit<WMInstanceMethods<{}>, "setData"> & CustomSetData<TDataForSetData> & IfExtends<{}, StoreDoc, unknown, {
     disposer: {
         [k in keyof StoreDoc]: IReactionDisposer;
     };

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

@@ -1,2 +1,2 @@
 import type { RootComponentInstance } from "../../RootComponent/Instance/RootComponentInstance";
-export type SubInstance<TAllMethods extends object, TData extends object, AllData extends object, AllCustomEventsDoc extends object, SubStoreDoc extends object> = RootComponentInstance<false, TAllMethods, TData, AllData, AllCustomEventsDoc, SubStoreDoc>;
+export type SubInstance<TAllMethods extends object, TDataForSetData extends object, AllData extends object, AllCustomEventsDoc extends object, SubStoreDoc extends object> = RootComponentInstance<false, TAllMethods, TDataForSetData, AllData, AllCustomEventsDoc, SubStoreDoc>;

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

@@ -5,8 +5,8 @@ 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 { AssignValues } from "../../types/AssignValues";
 import type { WMCompOtherOption } from "../../types/OfficialTypeAlias";
+import type { Replace } from "../../types/Replace";
 import type { IInjectStore } from "../InstanceInject/instanceConfig";
 import type { ComputedConstraint } from "../RootComponent/Computed/ComputedConstraint";
 import type { DataConstraint } from "../RootComponent/Data/DataConstraint";
@@ -35,7 +35,7 @@ import type { CreateSubComponentDoc } from "./SubReturnType/CreateSubComponentDo
 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> = SubInheritOption<TInherit> & SubDataOption<TSubData, Exclude<keyof CurrentCompDoc["properties"], (keyof InheritDoc)>, Prefix> & SubStoreOption<TSubStore, Exclude<keyof CurrentCompDoc["properties"], (keyof (InheritDoc & SubDataDoc))>> & SubComputedOption<TSubComputed, Omit<CurrentCompDoc["properties"], (keyof (InheritDoc & SubDataDoc & SubStoreDoc))>> & SubEventsOption<TEvents, SubEventsDoc, keyof SubEventsConstraint<CurrentCompDoc>> & SubMethodsOption<TSubMethods, Prefix, keyof (CurrentCompDoc["customEvents"] & SubEventsDoc)> & SubPageLifetimesOption<IsPage, 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"], SubDataDoc, AllRootDataDoc & AssignValues<SubDataDoc & SubComputedDoc & SubStoreDoc, Required<CurrentCompDoc["properties"]>>, RootDoc["customEvents"] & {}, SubStoreDoc>>;
+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> = SubInheritOption<TInherit> & SubDataOption<TSubData, Exclude<keyof CurrentCompDoc["properties"], (keyof InheritDoc)>, Prefix> & SubStoreOption<TSubStore, Exclude<keyof CurrentCompDoc["properties"], (keyof (InheritDoc & SubDataDoc))>> & SubComputedOption<TSubComputed, Omit<CurrentCompDoc["properties"], (keyof (InheritDoc & SubDataDoc & SubStoreDoc))>> & SubEventsOption<TEvents, SubEventsDoc, keyof SubEventsConstraint<CurrentCompDoc>> & SubMethodsOption<TSubMethods, Prefix, keyof (CurrentCompDoc["customEvents"] & SubEventsDoc)> & SubPageLifetimesOption<IsPage, 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"]>>, 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>>, TSubStore extends SubStoreConstraint<Omit<Required<CurrentCompDoc["properties"]>, keyof (InheritDoc & SubDataDoc)>>, TEvents extends SubEventsConstraint<CurrentCompDoc>, 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<SubDataConstraint<Omit<Required<CurrentCompDoc["properties"]>, keyof InheritDoc>>, TSubData, {}, TSubData>, SubStoreDoc extends object = IfExtends<SubStoreConstraint<Omit<Required<CurrentCompDoc["properties"]>, keyof (InheritDoc & SubDataDoc)>>, TSubStore, {}, {
         [k in keyof TSubStore]: ReturnType<TSubStore[k] & {}>;

package/dist/types/Replace.d.ts

@@ -0,0 +1,8 @@
+import type { ComputeIntersection } from "hry-types/src/Object/ComputeIntersection";
+type _Replace<Target, Source, DifferentKeys extends keyof Target, SameKey extends keyof Source> = ComputeIntersection<{
+    [k in DifferentKeys]: Target[k];
+} & {
+    [k in SameKey]: Source[k];
+}>;
+export type Replace<Target extends object, Source extends object> = _Replace<Target, Source, Exclude<keyof Target, keyof Source>, Extract<keyof Target, keyof Source>>;
+export {};

package/dist/types/Replace.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=Replace.js.map

package/dist/types/Replace.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Replace.js","sourceRoot":"","sources":["../../src/types/Replace.ts"],"names":[],"mappings":""}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "annil",
-  "version": "1.5.11",
+  "version": "1.5.13",
   "description": "微信小程序(原生开发)插件",
   "main": "dist/index.js",
   "types": "src/index.ts",

package/src/api/RootComponent/CustomEvents/GetCustomEventDoc.ts

@@ -1,3 +1,4 @@
+import type { ReadonlyDeep } from "hry-types/src/Any/ReadonlyDeep";
 import type { DetailedType } from "../../../types/DetailedType";
 import type { InferDetailedType } from "../../../types/InferDetailedType";
 import type {
@@ -8,7 +9,8 @@ import type {
 } from "./CustomEventConstraint";
 import type { AddTagForCustomEventsDoc } from "./CustomEventsTag";
 
-export type GetShortCustomEventsDoc<T extends ShortCustomeEvents> = T extends DetailedType ? InferDetailedType<T>
+export type GetShortCustomEventsDoc<T extends ShortCustomeEvents> = T extends DetailedType
+  ? ReadonlyDeep<InferDetailedType<T>>
   : T extends null ? null
   : T extends undefined ? undefined
   : T extends SimpleCustomeEventsList ? GetShortCustomEventsDoc<T[number]>

package/src/api/RootComponent/CustomEvents/test/GetCustomEventDoc.test.ts

@@ -9,7 +9,13 @@ import {
   type CapturePhaseComposedExpected,
   type CapturePhaseExpected,
 } from "./GetFullEventDoc.test";
-import { type ListExpected, type NullExpected, type StrExpected, type UnionStrExpected } from "./GetShortEventDoc.test";
+import {
+  type ListExpected,
+  type NullExpected,
+  type ObjExpected,
+  type StrExpected,
+  type UnionStrExpected,
+} from "./GetShortEventDoc.test";
 import { mock_customEvents } from "./normal.test";
 
 type Mock_CustomEventsDoc = GetCustomEventDoc<typeof mock_customEvents>;
@@ -20,6 +26,7 @@ export type Mock_CustomEventsDocExpected = {
   nothing: undefined;
   unionStr: UnionStrExpected;
   union: ListExpected;
+  obj: ObjExpected;
   bubbles: bubblesExpected;
   capturePhase: CapturePhaseExpected;
   bubbles_capturePhase: BubblesCapturePhaseExpected;

package/src/api/RootComponent/CustomEvents/test/GetShortEventDoc.test.ts

@@ -1,5 +1,7 @@
 import { Checking, type Test } from "hry-types";
 
+import type { ReadonlyDeep } from "hry-types/src/Any/ReadonlyDeep";
+import type { Mock_User } from "../../Properties/test/normalRequired.test";
 import type { GetShortCustomEventsDoc } from "../GetCustomEventDoc";
 import { mock_shortCustomEvents } from "./normal.test";
 
@@ -26,3 +28,9 @@ type ListResult = GetShortCustomEventsDoc<typeof mock_shortCustomEvents["union"]
 export type ListExpected = string | 0 | 1 | 2 | null;
 
 Checking<ListResult, ListExpected, Test.Pass>;
+
+type ObjResult = GetShortCustomEventsDoc<typeof mock_shortCustomEvents["obj"]>;
+
+export type ObjExpected = ReadonlyDeep<Mock_User>;
+
+Checking<ObjResult, ObjExpected, Test.Pass>;

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

@@ -1,5 +1,7 @@
 import { Checking, type Test } from "hry-types";
+import type { ReadonlyDeep } from "hry-types/src/Any/ReadonlyDeep";
 import { type DetailedType, RootComponent } from "../../../..";
+import type { Mock_User } from "../../Properties/test/normalRequired.test";
 import type { CustomEventConstraint, FullCustomEvents, ShortCustomeEvents } from "../CustomEventConstraint";
 import type {
   Bubbles,
@@ -19,6 +21,7 @@ export const mock_shortCustomEvents = {
   null: null,
   unionStr: String as DetailedType<"male" | "female">,
   union: [String, Number as DetailedType<0 | 1 | 2>, null],
+  obj: Object as DetailedType<Mock_User>,
 } satisfies Record<string, ShortCustomeEvents>;
 
 /**
@@ -68,6 +71,7 @@ type RootDoc = {
     nothing: undefined;
     unionStr: "male" | "female";
     union: string | 0 | 1 | 2 | null;
+    obj: ReadonlyDeep<Mock_User>;
     // 带options字段 通过联合类型加入。
     bubbles: string | Bubbles;
     capturePhase: null | Capture;
@@ -92,3 +96,22 @@ const rootDocNoFields = RootComponent()({});
 
 // 3. 无customEvents字段时,Doc中无customEvents字段
 Checking<typeof rootDocNoFields, {}, Test.Pass>;
+
+// 4 实例中的对象数组都是readOnlyDeep类型,可以传递给自定义做参数
+RootComponent()({
+  properties: {
+    obj: Object as DetailedType<Mock_User>,
+  },
+  data: {
+    obj1: {} as Mock_User,
+    _ddd: {} as Mock_User,
+  },
+  customEvents: mock_customEvents,
+  events: {
+    ddd() {
+      this.obj(this.data.obj!);
+
+      this.obj(this.data.obj1);
+    },
+  },
+});

package/src/api/RootComponent/Instance/RootComponentInstance.ts

@@ -11,7 +11,7 @@ import type { CustomSetData } from "./CustomSetData";
 export type RootComponentInstance<
   TIsPage extends boolean,
   TMethods extends object,
-  TData extends object,
+  TDataForSetData extends object,
   AllData extends object,
   CustomEventsDoc extends object,
   StoreDoc extends object,
@@ -21,7 +21,7 @@ export type RootComponentInstance<
   // 官方实例方法去除setData,因其类型宽泛
   & Omit<WMInstanceMethods<{}>, "setData">
   // 加入自定义setData方法
-  & CustomSetData<TData>
+  & CustomSetData<TDataForSetData>
   & IfExtends<{}, StoreDoc, unknown, {
     disposer: { [k in keyof StoreDoc]: IReactionDisposer };
   }>

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

@@ -65,3 +65,19 @@ SubComponent<{}, CompDoc>()({
     },
   },
 });
+
+// data建立的类型在setData时为组件类型
+SubComponent<{ data: { _num: number } }, CompDoc>()({
+  data: {
+    aaa_obj: null,
+  },
+  lifetimes: {
+    attached() {
+      Checking<typeof this.data.aaa_obj, ReadonlyDeep<Mock_User | null>, Test.Pass>;
+
+      this.setData({
+        aaa_obj: {} as Mock_User, // aaa_obj 类型为 Mock_User | null 而非 null
+      });
+    },
+  },
+});

package/src/api/SubComponent/SubInstance/SubInstance.ts

@@ -2,8 +2,8 @@ import type { RootComponentInstance } from "../../RootComponent/Instance/RootCom
 
 export type SubInstance<
   TAllMethods extends object,
-  TData extends object,
+  TDataForSetData extends object,
   AllData extends object,
   AllCustomEventsDoc extends object,
   SubStoreDoc extends object,
-> = RootComponentInstance<false, TAllMethods, TData, AllData, AllCustomEventsDoc, SubStoreDoc>;
+> = RootComponentInstance<false, TAllMethods, TDataForSetData, AllData, AllCustomEventsDoc, SubStoreDoc>;

package/src/api/SubComponent/index.ts

@@ -6,8 +6,8 @@ import type { ReplacePrefix } from "../../types/ReplacePrefix";
 import type { ComponentDoc } from "../DefineComponent/ReturnType/ComponentDoc";
 
 import type { Func } from "hry-types/src/Misc/Func";
-import type { AssignValues } from "../../types/AssignValues";
 import type { WMCompOtherOption } from "../../types/OfficialTypeAlias";
+import type { Replace } from "../../types/Replace";
 import type { IInjectStore } from "../InstanceInject/instanceConfig";
 import type { ComputedConstraint } from "../RootComponent/Computed/ComputedConstraint";
 import type { DataConstraint } from "../RootComponent/Data/DataConstraint";
@@ -95,8 +95,8 @@ type Options<
   & ThisType<
     SubInstance<
       SubMethodsDoc & RootDoc["methods"],
-      SubDataDoc,
-      AllRootDataDoc & AssignValues<SubDataDoc & SubComputedDoc & SubStoreDoc, Required<CurrentCompDoc["properties"]>>,
+      Replace<SubDataDoc, Required<CurrentCompDoc["properties"]>>,
+      AllRootDataDoc & Replace<SubDataDoc & SubComputedDoc & SubStoreDoc, Required<CurrentCompDoc["properties"]>>,
       RootDoc["customEvents"] & {},
       SubStoreDoc
     >

package/src/types/Replace.ts

@@ -0,0 +1,24 @@
+import type { ComputeIntersection } from "hry-types/src/Object/ComputeIntersection";
+
+type _Replace<Target, Source, DifferentKeys extends keyof Target, SameKey extends keyof Source> = ComputeIntersection<
+  & { [k in DifferentKeys]: Target[k] }
+  & { [k in SameKey]: Source[k] }
+>;
+
+/**
+ * Target与Source相同的key类型替换为Source的类型
+ * @example
+ * ```ts
+ * type obj = { a: "a"; b: "b"; c: boolean };
+ * type obj2 = { a: number; b: string; d: number };
+ * type test = Replace<obj, obj2>;
+ * //  test = { a: number; b: string; c: boolean}
+ * type test1 = Replace<{}, obj2>; // {}
+ * ```
+ */
+export type Replace<Target extends object, Source extends object> = _Replace<
+  Target,
+  Source,
+  Exclude<keyof Target, keyof Source>,
+  Extract<keyof Target, keyof Source>
+>;

package/dist/types/AssignValues.d.ts

@@ -1,9 +0,0 @@
-import type { IfExtends } from "hry-types/src/Any/IfExtends";
-import type { ComputeIntersection } from "hry-types/src/Object/ComputeIntersection";
-type _AssignValues<Target, Source, UniqueKey extends keyof Target> = ComputeIntersection<{
-    [k in UniqueKey]: Target[k];
-} & {
-    [k in Exclude<keyof Target, UniqueKey>]: Source[k];
-}>;
-export type AssignValues<Target, Source> = IfExtends<unknown, Target, unknown, _AssignValues<Target, Source, Exclude<keyof Target, keyof Source>>>;
-export {};

package/dist/types/AssignValues.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=AssignValues.js.map

package/dist/types/AssignValues.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"AssignValues.js","sourceRoot":"","sources":["../../src/types/AssignValues.ts"],"names":[],"mappings":""}

package/src/types/AssignValues.ts

@@ -1,26 +0,0 @@
-import type { IfExtends } from "hry-types/src/Any/IfExtends";
-import type { ComputeIntersection } from "hry-types/src/Object/ComputeIntersection";
-
-type _AssignValues<Target, Source, UniqueKey extends keyof Target> = ComputeIntersection<
-  & { [k in UniqueKey]: Target[k] }
-  // @ts-ignore
-  & { [k in Exclude<keyof Target, UniqueKey>]: Source[k] }
->;
-
-/**
- * Target与Source相同的key类型变为Source的类型
- * @example
- * ```ts
- * type obj = { a: "a"; b: "b"; c: boolean };
- * type obj2 = { a: number; b: string; d: number };
- * type test = AssignValues<obj, obj2>;
- * //  test = { a: number; b: string; c: boolean}
- * type test1 = AssignValues<unknown, obj2>; // unknown
- * ```
- */
-export type AssignValues<Target, Source> = IfExtends<
-  unknown,
-  Target,
-  unknown,
-  _AssignValues<Target, Source, Exclude<keyof Target, keyof Source>>
->;