Merge pull request #332 from lv-z-l/master

feat: supports the issues/331 mentioned in points 2, 3, 4
wechat-miniprogram · Sep 3, 2024 · 0a76c78 · 0a76c78
2 parents 6a7f4f9 + 7002da6
commit 0a76c78
Show file tree

Hide file tree

Showing 3 changed files with 55 additions and 9 deletions.
diff --git a/test/component.test.ts b/test/component.test.ts
@@ -178,7 +178,7 @@ Component({
       expectType<number>(this.data.n2)
       expectType<string>(this.data.s)
       expectType<any[]>(this.data.a)
-      expectType<any[]>(this.data.a2)
+      expectType<number[]>(this.data.a2)
       expectType<boolean>(this.data.b)
       expectType<Record<string, any>>(this.data.o)
       expectType<any>(this.data.a[0])
@@ -218,7 +218,7 @@ Component({
       expectType<number>(this.data.n2)
       expectType<string>(this.data.s)
       expectType<any[]>(this.data.a)
-      expectType<any[]>(this.data.a2)
+      expectType<number[]>(this.data.a2)
       expectType<boolean>(this.data.b)
       expectType<Record<string, any>>(this.data.o)
       expectType<Record<string, any>>(this.data.o2)
@@ -243,7 +243,7 @@ Component({
   methods: {
     f() {
       expectType<number>(this.data.n)
-      expectType<any[]>(this.data.a)
+      expectType<number[]>(this.data.a)
     },
   },
 })

diff --git a/test/issue.test.ts b/test/issue.test.ts
@@ -1,4 +1,4 @@
-import { expectType } from 'tsd'
+import { expectError, expectType } from 'tsd'
 
 // https://github.com/wechat-miniprogram/api-typings/issues/11
 expectType<string>(wx.env.USER_DATA_PATH)
@@ -397,7 +397,9 @@ import WX = WechatMiniprogram
         return this.data.foo
       },
       test() {
-        expectType<Record<string, any>>(this.data.bar)
+        expectType<{
+          skuNum: number
+      }>(this.data.bar)
         expectType<number>(this.getDataOrPoperty())
       },
     }
@@ -441,3 +443,46 @@ import WX = WechatMiniprogram
   expectType<number>(offscreenCanvas.height)
   expectType<number>(offscreenCanvas.width)
 }
+
+// https://github.com/wechat-miniprogram/api-typings/issues/332
+{
+  Component({
+    data: {
+      a: ''
+    },
+    methods: {
+      test() {
+        expectError<any>(this.data.xxx)
+      },
+    }
+  })
+}
+
+{
+  interface Foo {
+    f: string
+  }
+
+  Component({
+    properties: {
+      bar: {
+        type: Object,
+        value: { f: '' } as Foo,
+        observer () {}
+      },
+      foo: {
+        type: Array,
+        value: [] as Foo[],
+      }
+    },
+    methods: {
+      getData() {
+        return this.data.foo
+      },
+      test() {
+        expectType<Foo>(this.data.bar)
+        expectType<Foo[]>(this.getData())
+      },
+    }
+  })
+}
diff --git a/types/wx/lib.wx.component.d.ts b/types/wx/lib.wx.component.d.ts
@@ -21,6 +21,7 @@ SOFTWARE.
 ***************************************************************************** */
 
 declare namespace WechatMiniprogram.Component {
+    type FilterUnknownProperty<TProperty> = string extends keyof TProperty ? {} : TProperty
     type Instance<
         TData extends DataOption,
         TProperty extends PropertyOption,
@@ -33,9 +34,9 @@ declare namespace WechatMiniprogram.Component {
         (TIsPage extends true ? Page.ILifetime : {}) &
         TCustomInstanceProperty & {
             /** 组件数据，**包括内部数据和属性值** */
-            data: TData & PropertyOptionToData<TProperty>
+            data: TData & PropertyOptionToData<FilterUnknownProperty<TProperty>>
             /** 组件数据，**包括内部数据和属性值**（与 `data` 一致） */
-            properties: TData & PropertyOptionToData<TProperty>
+            properties: TData & PropertyOptionToData<FilterUnknownProperty<TProperty>>
         }
     type TrivialInstance = Instance<
         IAnyObject,
@@ -151,8 +152,8 @@ declare namespace WechatMiniprogram.Component {
     type PropertyToData<T extends AllProperty> = T extends ShortProperty
         ? ValueType<T>
         : FullPropertyToData<Exclude<T, ShortProperty>>
-    type FullPropertyToData<T extends AllFullProperty> = ValueType<T['type']>
-    // type FullPropertyToData<T extends AllFullProperty> = unknown extends T['value'] ? ValueType<T['type']> : T['value']
+    type ArrayOrObject = ArrayConstructor | ObjectConstructor
+    type FullPropertyToData<T extends AllFullProperty> = T['type'] extends ArrayOrObject ? unknown extends T['value'] ? ValueType<T['type']> : T['value'] : ValueType<T['type']>
     type PropertyOptionToData<P extends PropertyOption> = {
         [name in keyof P]: PropertyToData<P[name]>
     }