annil 1.7.6 → 1.7.8

package/CHANGELOG.md

@@ -4,6 +4,20 @@
 
 * 解决DetailedType不接收接口类型的错误 ([ae8acbf](https://github.com/missannil/annil/commit/ae8acbfc2e62f99db565c448ad9253aa549e78bb))
 
+## [1.7.8](https://github.com/missannil/annil/compare/v1.7.7...v1.7.8) (2024-08-22)
+
+
+### Bug Fixes
+
+* 当SubComponents组件有后缀时,阻止穿透(_catch)事件类型被返回的错误 ([deab409](https://github.com/missannil/annil/commit/deab409c1116d2e810cc018797b6c38061701f25))
+
+## [1.7.7](https://github.com/missannil/annil/compare/v1.7.6...v1.7.7) (2024-08-13)
+
+
+### Bug Fixes
+
+* 修复SubComponent中计算属性无法获取data和store中数据的错误。 ([014a375](https://github.com/missannil/annil/commit/014a375de3ae657740b185b91f41e1215ef80ace))
+
 ## [1.7.6](https://github.com/missannil/annil/compare/v1.7.5...v1.7.6) (2024-08-10)
 
 

package/README.md

@@ -27,6 +27,8 @@ annil(安奈儿)是微信小程序原生开发插件。她会给您更佳的开
 
 ### 特点
 
+[代码片段](https://developers.weixin.qq.com/s/kRjkFlme7nTV)
+
 - **组件构建API功能更强大**
 
   新的组件构建API加入了[computed](./doc/demo/computed.md)、[watch](./doc/demo/watch.md)、[store](./doc/demo/store.md)(基于mobx的全局响应式数据)`等功能,使开发更便捷。
@@ -146,3 +148,7 @@ annil(安奈儿)是微信小程序原生开发插件。她会给您更佳的开
 ### 更新日志
 
 [CHANGELOG](./CHANGELOG.md)
+
+### 讨论群
+
+加微信 missannil 请注明(annil)

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

@@ -38,11 +38,11 @@ import type { SubStoreConstraint } from "./SubStore/SubStoreConstraint";
 import type { SubStoreOption } from "./SubStore/SubStoreOption";
 import type { SubWatchOption } from "./SubWatch/SubWatchOption";
 type Options<RootDoc extends RootComponentType, IsPage extends boolean, CurrentCompDoc extends ComponentType, 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, CompDocKeys extends PropertyKey = keyof CurrentCompDoc["properties"]> = SubInheritOption<TInherit, CompDocKeys> & SubDataOption<TSubData, Exclude<CompDocKeys, (keyof InheritDoc)> | InnerFields<Prefix>> & SubStoreOption<TSubStore, Exclude<CompDocKeys, (keyof (InheritDoc & SubDataDoc))> | InnerFields<Prefix>> & SubComputedOption<TSubComputed, Exclude<CompDocKeys, (keyof (InheritDoc & SubDataDoc & SubStoreDoc))> | InnerFields<Prefix>, {
-    data: ComputeObject<AllRootDataDoc & Replace<SubComputedDoc, Required<CurrentCompDoc["properties"]>> & IInjectAllData>;
+    data: ComputeObject<AllRootDataDoc & Replace<SubComputedDoc, Required<CurrentCompDoc["properties"]>> & SubStoreDoc & SubDataDoc & IInjectAllData>;
 }> & SubEventsOption<TEvents, SubEventsDoc, keyof SubEventsConstraint<CurrentCompDoc>> & SubMethodsOption<TSubMethods, Prefix, keyof (CurrentCompDoc["customEvents"] & SubEventsDoc)> & SubPageLifetimesOption<IsPage, NonNullable<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"]>>, NonNullable<RootDoc["customEvents"]>, SubStoreDoc>>;
 type SubComponentConstructor<TRootDoc extends RootComponentType, TOriginalCompDoc extends ComponentType, TSupplementalPrefix extends string = "", IsPage extends boolean = TRootDoc["isPage"] extends true ? true : false, CurrentPrefix extends string = `${GetComponentPrefix<TOriginalCompDoc>}${Capitalize<TSupplementalPrefix>}`, CurrentCompDoc extends ComponentType = 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> & Record<InnerFields<CurrentPrefix>, unknown>>, TSubStore extends SubStoreConstraint<Omit<Required<CurrentCompDoc["properties"]>, keyof (InheritDoc & SubDataDoc)> & Record<InnerFields<CurrentPrefix>, unknown>>, TEvents extends SubEventsConstraint<CurrentCompDoc>, TSubComputed extends SubComputedConstraint<Omit<Required<CurrentCompDoc["properties"]>, keyof (InheritDoc & SubDataDoc & SubStoreDoc)> & Record<InnerFields<CurrentPrefix>, unknown>>, TSubMethods extends SubMethodsConstraint = {}, InheritDoc extends object = IfExtends<InheritConstraint<AllRootDataDoc, CurrentCompDoc>, TInherit, {}, TInherit>, SubDataDoc extends object = IfExtends<SubDataConstraint<Omit<Required<CurrentCompDoc["properties"]>, keyof InheritDoc> & Record<InnerFields<CurrentPrefix>, unknown>>, TSubData, {}, TSubData>, SubStoreDoc extends object = IfExtends<SubStoreConstraint<Omit<Required<CurrentCompDoc["properties"]>, keyof (InheritDoc & SubDataDoc)> & Record<InnerFields<CurrentPrefix>, unknown>>, TSubStore, {}, {
     [k in keyof TSubStore]: ReturnType<NonNullable<TSubStore[k]>>;
-}>, SubComputedDoc extends object = IfExtends<SubComputedConstraint<Omit<Required<CurrentCompDoc["properties"]>, keyof (InheritDoc & SubDataDoc & SubStoreDoc)> & Record<InnerFields<CurrentPrefix>, unknown>>, TSubComputed, {}, GetSubComputedDoc<TSubComputed>>, SubEventsDoc extends object = IfExtends<SubEventsConstraint<CurrentCompDoc>, TEvents, {}, TEvents>, SubMethodsDoc extends object = TSubMethods, MissingRequiredField extends PropertyKey = Exclude<RequiredKeys<NonNullable<CurrentCompDoc["properties"]>>, keyof (InheritDoc & SubDataDoc & SubStoreDoc & IfExtends<SubComputedConstraint<Omit<Required<CurrentCompDoc["properties"]>, keyof (InheritDoc & SubDataDoc & SubStoreDoc)>>, TSubComputed, {}, GetSubComputedDoc<TSubComputed>>)>>(options: Options<TRootDoc, IsPage, CurrentCompDoc, CurrentPrefix, AllRootDataDoc, TInherit, TSubData, TSubStore, TSubComputed, TEvents, TSubMethods, InheritDoc, SubDataDoc, SubStoreDoc, SubComputedDoc, SubEventsDoc, SubMethodsDoc>) => CreateSubComponentDoc<NonNullable<TOriginalCompDoc["customEvents"]>, SubEventsDoc, MissingRequiredField>;
+}>, SubComputedDoc extends object = IfExtends<SubComputedConstraint<Omit<Required<CurrentCompDoc["properties"]>, keyof (InheritDoc & SubDataDoc & SubStoreDoc)> & Record<InnerFields<CurrentPrefix>, unknown>>, TSubComputed, {}, GetSubComputedDoc<TSubComputed>>, SubEventsDoc extends object = IfExtends<SubEventsConstraint<CurrentCompDoc>, TEvents, {}, TEvents>, SubMethodsDoc extends object = TSubMethods, MissingRequiredField extends PropertyKey = Exclude<RequiredKeys<NonNullable<CurrentCompDoc["properties"]>>, keyof (InheritDoc & SubDataDoc & SubStoreDoc & IfExtends<SubComputedConstraint<Omit<Required<CurrentCompDoc["properties"]>, keyof (InheritDoc & SubDataDoc & SubStoreDoc)>>, TSubComputed, {}, GetSubComputedDoc<TSubComputed>>)>>(options: Options<TRootDoc, IsPage, CurrentCompDoc, CurrentPrefix, AllRootDataDoc, TInherit, TSubData, TSubStore, TSubComputed, TEvents, TSubMethods, InheritDoc, SubDataDoc, SubStoreDoc, SubComputedDoc, SubEventsDoc, SubMethodsDoc>) => CreateSubComponentDoc<NonNullable<CurrentCompDoc["customEvents"]>, SubEventsDoc, MissingRequiredField>;
 /**
  * 子组件构建函数
  * @returns `(options:) => SubComponentDoc`

package/dist/api/SubComponent/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/api/SubComponent/index.ts"],"names":[],"mappings":"AAuOA;;;GAGG;AACH,MAAM,UAAU,YAAY;IAK1B,8DAA8D;IAC9D,OAAO,CAAC,CAAC,OAAY,EAAE,EAAE,CAAC,OAAkC,CAAQ,CAAC;AACvE,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/api/SubComponent/index.ts"],"names":[],"mappings":"AA2OA;;;GAGG;AACH,MAAM,UAAU,YAAY;IAK1B,8DAA8D;IAC9D,OAAO,CAAC,CAAC,OAAY,EAAE,EAAE,CAAC,OAAkC,CAAQ,CAAC;AACvE,CAAC"}

package/dist/index.d.ts

@@ -7,6 +7,7 @@ import type { CreateComponentType } from "./types/CreateComponentType";
 import type { DetailedType } from "./types/DetailedType";
 import type { ExtendComponentType } from "./types/ExtendComponentType";
 import type { ParamsEqual } from "./types/TwoParamsEqual";
+export type { Bubbles, BubblesCapture, BubblesCaptureComposed, BubblesComposed, Capture, CaptureComposed, Composed, CustomEventsTags, } from "./api/RootComponent/CustomEvents/CustomEventsTag";
 export type { Vant, Wm } from "./thirdLib";
 export type { CurrentTargetDataset, Dataset, Detail, Mark, TargetDataset, WMBaseEvent, WMCustomEvent, } from "./types/OfficialTypeAlias";
 export { type CreateComponentType, DefineComponent, type DetailedType, type ExtendComponentType, type IInjectInfo, instanceConfig, navigateTo, type ParamsEqual, RootComponent, SubComponent, };

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AACxD,OAAO,EAAoB,cAAc,EAAE,MAAM,qCAAqC,CAAC;AACvF,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAiBlD,OAAO,EAEL,eAAe,EAIf,cAAc,EACd,UAAU,EAEV,aAAa,EACb,YAAY,GACb,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AACxD,OAAO,EAAoB,cAAc,EAAE,MAAM,qCAAqC,CAAC;AACvF,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AA2BlD,OAAO,EAEL,eAAe,EAIf,cAAc,EACd,UAAU,EAEV,aAAa,EACb,YAAY,GACb,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "annil",
-  "version": "1.7.6",
+  "version": "1.7.8",
   "description": "微信小程序(原生开发)插件",
   "main": "dist/index.js",
   "types": "src/index.ts",
@@ -12,11 +12,12 @@
   "scripts": {
     "coverage": "jest --coverage",
     "prepare": "husky install",
-    "lint": "eslint . --fix && npm run fmt",
+    "lint": "eslint . --fix --max-warnings 0",
     "fmt": "dprint fmt",
-    "type": "tsc --watch",
-    "jest": "jest --watch",
-    "build": "tsc -p tsconfig.build.json"
+    "tsc": "tsc --watch",
+    "test": "jest --watch",
+    "build": "tsc -p tsconfig.build.json",
+    "check": "eslint . --fix --max-warnings 0 && (dprint check || (dprint fmt && exit 1))"
   },
   "devDependencies": {
     "@commitlint/config-conventional": "^17.6.5",

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

@@ -66,7 +66,7 @@ SubComponent<Root, OnlyPropsCompDoc>()({
     },
   },
 });
-
+// 3 computed字段的返回类型应为对应的文档类型,避免返回字面量类型导致与实际文档类型不符
 SubComponent<Root, OnlyPropsCompDoc>()({
   computed: {
     aaa_num() {
@@ -76,7 +76,7 @@ SubComponent<Root, OnlyPropsCompDoc>()({
       return 123;
     },
     aaa_str() {
-      return "a";
+      return "a"; // 默认下返回的类型是'a',但文档中是'a' | 'b'.所以要在this.data中处理
     },
     aaa_obj() {
       // 5 this.data
@@ -143,3 +143,20 @@ SubComponent<Root, $aaa>()({
     },
   },
 });
+// 计算属性this.data可获取store和data的字段中文档中的字段和内部字段(_开头的字段)
+SubComponent<Root, $aaa>()({
+  data: {
+    aaa_age: 123,
+    _aaa_age1: 123,
+  },
+  store: {
+    aaa_str: () => "a",
+    _aaa_age: () => 123,
+  },
+  computed: {
+    aaa_num(): number {
+      const { aaa_age, _aaa_age1, _aaa_age, aaa_str } = this.data;
+      return aaa_age + _aaa_age1 + _aaa_age + aaa_str.length;
+    },
+  },
+});

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

@@ -37,3 +37,47 @@ type SubDocExpect = {
 };
 
 Checking<typeof SubDoc, SubDocExpect, Test.Pass>();
+// 去除已经声明的穿透事件
+const removeCatchedEvents = SubComponent<{}, CompDoc>()({
+  data: {
+    aaa_str: "string",
+  },
+  events: {
+    aaa_bubblesCaptrueComposed_catch(e) {
+      console.log(e);
+    },
+    aaa_bubblesComposed_catch(e) {
+      console.log(e);
+    },
+    aaa_captrueComposed_catch(e) {
+      console.log(e);
+    },
+  },
+});
+void removeCatchedEvents;
+// 返回穿透的自定义事件,并去除了前缀
+type RemoveSubDoc = never;
+
+Checking<typeof removeCatchedEvents, RemoveSubDoc, Test.Pass>();
+// 去除有后缀时,已经声明的穿透事件
+const removeCatchedEventsOfSuffix = SubComponent<{}, CompDoc, "aa">()({
+  data: {
+    aaaAa_str: "string",
+  },
+  events: {
+    aaaAa_bubblesCaptrueComposed_catch(e) {
+      console.log(e);
+    },
+    aaaAa_bubblesComposed_catch(e) {
+      console.log(e);
+    },
+    aaaAa_captrueComposed_catch(e) {
+      console.log(e);
+    },
+  },
+});
+void removeCatchedEventsOfSuffix;
+// 返回穿透的自定义事件,并去除了前缀
+type RemoveCatchedEventsOfSuffix = never;
+
+Checking<typeof removeCatchedEventsOfSuffix, RemoveCatchedEventsOfSuffix, Test.Pass>();

package/src/api/SubComponent/index.ts

@@ -75,7 +75,11 @@ type Options<
     Exclude<CompDocKeys, (keyof (InheritDoc & SubDataDoc & SubStoreDoc))> | InnerFields<Prefix>,
     {
       data: ComputeObject<
-        AllRootDataDoc & Replace<SubComputedDoc, Required<CurrentCompDoc["properties"]>> & IInjectAllData
+        & AllRootDataDoc
+        & Replace<SubComputedDoc, Required<CurrentCompDoc["properties"]>>
+        & SubStoreDoc
+        & SubDataDoc
+        & IInjectAllData
       >;
     }
   >
@@ -227,7 +231,7 @@ type SubComponentConstructor<
     SubEventsDoc,
     SubMethodsDoc
   >,
-) => CreateSubComponentDoc<NonNullable<TOriginalCompDoc["customEvents"]>, SubEventsDoc, MissingRequiredField>;
+) => CreateSubComponentDoc<NonNullable<CurrentCompDoc["customEvents"]>, SubEventsDoc, MissingRequiredField>;
 
 /**
  * 子组件构建函数

package/src/index.ts

@@ -7,6 +7,16 @@ import type { CreateComponentType } from "./types/CreateComponentType";
 import type { DetailedType } from "./types/DetailedType";
 import type { ExtendComponentType } from "./types/ExtendComponentType";
 import type { ParamsEqual } from "./types/TwoParamsEqual";
+export type {
+  Bubbles,
+  BubblesCapture,
+  BubblesCaptureComposed,
+  BubblesComposed,
+  Capture,
+  CaptureComposed,
+  Composed,
+  CustomEventsTags,
+} from "./api/RootComponent/CustomEvents/CustomEventsTag";
 export type { Vant, Wm } from "./thirdLib";
 
 export type {