feat: glass-easel chaining api supports TypeSignature for glass-easel-analyzer

Author: SgLy

test/component.glass-easel.test.ts

@@ -570,3 +570,51 @@ import { expectType } from 'tsd'
     })
     .register()
 }
+
+// TypeSignature: Component register() should carry field types for glass-easel-analyzer
+{
+  const def = Component()
+    .property('a', Boolean)
+    .data(() => ({
+      b: 1,
+    }))
+    .methods({
+      c() {},
+    })
+    .register()
+  type FieldTypes = (typeof def)['_$fieldTypes']
+  expectType<NonNullable<FieldTypes>['propertyValues']['a']>(false as boolean)
+  expectType<NonNullable<FieldTypes>['dataWithProperties']['a']>(false as boolean)
+  expectType<NonNullable<FieldTypes>['dataWithProperties']['b']>(1 as number)
+  expectType<NonNullable<FieldTypes>['methods']['c']>(() => {})
+}
+
+// TypeSignature: Behavior register() should carry field types for glass-easel-analyzer
+{
+  const beh = Behavior()
+    .property('a', Number)
+    .data(() => ({
+      b: 'hello',
+    }))
+    .methods({
+      c() { return 1 },
+    })
+    .register()
+  type FieldTypes = (typeof beh)['_$behaviorFieldTypes']
+  expectType<NonNullable<FieldTypes>['propertyValues']['a']>(1 as number)
+  expectType<NonNullable<FieldTypes>['dataWithProperties']['a']>(1 as number)
+  expectType<NonNullable<FieldTypes>['dataWithProperties']['b']>('hello' as string)
+  expectType<NonNullable<FieldTypes>['methods']['c']>(() => 1)
+}
+
+// Property value type: precise value type inference (like glass-easel)
+{
+  Component()
+    .property('n', { type: Number, value: 1 as const })
+    .property('o', { type: Object, value: { f1: 123 } })
+    .lifetime('attached', function () {
+      expectType<1>(this.data.n)
+      expectType<number>(this.data.o.f1)
+    })
+    .register()
+}

types/wx/lib.wx.api.d.ts

@@ -21814,7 +21814,7 @@ Page({
          * 衍生值 `DerivedValue`，可基于已有的 `SharedValue` 生成其它共享变量。 */
         derived(
             /** worklet 函数类型，该函数被立即执行，返回值作为 DerivedValue 的初始值。当函数内捕获的 SharedValue 类型值发生变化时，updaterWorklet 被驱动执行，返回值用于更新 DerivedValue。可类比 computed 计算属性进行理解。 */
-            updaterWorklet: Skyline.WorkletFunction
+            updaterWorklet: Skyline.WorkletFunction<any>
         ): Skyline.DerivedValue<any>
         /** [SharedValue worklet.shared(any initialValue)](https://developers.weixin.qq.com/miniprogram/dev/api/ui/worklet/base/worklet.shared.html)
          *

types/wx/lib.wx.glass-easel.behavior.d.ts

@@ -1,3 +1,6 @@
+// this rule seems buggy, unable to distinguish WechatMiniprogram.GlassEasel.Component and WechatMiniprogram.Component
+/* eslint-disable @typescript-eslint/no-unnecessary-qualifier */
+
 declare namespace WechatMiniprogram.GlassEasel.Behavior {
     type DefinitionFilter = (
         target: Component.TrivialDefinition,
@@ -145,14 +148,27 @@ declare namespace WechatMiniprogram.GlassEasel.Behavior {
         ): ResolveBehaviorBuilder<this, TChainingFilter>
     }
 
+    /** 用于辅助识别 behavior 字段类型的虚拟字段（供 glass-easel-analyzer 等外部模块使用） */
+    type TypeSignature<
+        TData extends TypeUtils.DataList,
+        TProperty extends TypeUtils.PropertyList,
+        TMethod extends TypeUtils.MethodList,
+    > = {
+        readonly _$behaviorFieldTypes?: {
+            propertyValues: TypeUtils.PropertyValues<TProperty>
+            dataWithProperties: TypeUtils.DataWithPropertyValues<TData, TProperty>
+            methods: TMethod
+        }
+    }
+
     type Instance<
         TData extends TypeUtils.DataList,
         TProperty extends TypeUtils.PropertyList,
         TMethod extends TypeUtils.MethodList,
         TChainingFilter extends TypeUtils.ChainingFilterType,
         TComponentExport,
         TExtraThisFields extends TypeUtils.DataList = TypeUtils.Empty
-    > = {}
+    > = TypeSignature<TData, TProperty, TMethod>
 
     type TrivialInstance = Instance<
         /* TData */ IAnyObject,
@@ -224,7 +240,7 @@ declare namespace WechatMiniprogram.GlassEasel.Behavior {
                       UComponentExport,
                       UExtraThisFields
                   >
-                | string
+                | WechatMiniprogram.Behavior.Identifier
         ): ResolveBehaviorBuilder<
             Builder<
                 TPrevData,

types/wx/lib.wx.glass-easel.component.d.ts

@@ -384,13 +384,26 @@ declare namespace WechatMiniprogram.GlassEasel.Component {
             IAnyObject
         > {}
 
+    /** 用于辅助识别组件类型的虚拟字段（供 glass-easel-analyzer 等外部模块使用） */
+    class TypeSignature<
+        TData extends TypeUtils.DataList,
+        TProperty extends TypeUtils.PropertyList,
+        TMethod extends TypeUtils.MethodList,
+    > {
+        protected readonly _$fieldTypes?: {
+            propertyValues: TypeUtils.PropertyValues<TProperty>
+            dataWithProperties: TypeUtils.DataWithPropertyValues<TData, TProperty>
+            methods: TMethod
+        }
+    }
+
     type ComponentType<
         TData extends TypeUtils.DataList,
         TProperty extends TypeUtils.PropertyList,
         TMethod extends TypeUtils.MethodList,
         TComponentExport,
         TExtraThisFields extends TypeUtils.DataList = TypeUtils.Empty
-    > = {}
+    > = TypeSignature<TData, TProperty, TMethod>
 
     type TrivialComponentType = ComponentType<
         TypeUtils.DataList,
@@ -436,14 +449,16 @@ declare namespace WechatMiniprogram.GlassEasel.Component {
             UComponentExport,
             UExtraThisFields extends TypeUtils.DataList = TypeUtils.Empty
         >(
-            behavior: Behavior.Instance<
-                UData,
-                UProperty,
-                UMethod,
-                UChainingFilter,
-                UComponentExport,
-                UExtraThisFields
-            >
+            behavior:
+                | Behavior.Instance<
+                      UData,
+                      UProperty,
+                      UMethod,
+                      UChainingFilter,
+                      UComponentExport,
+                      UExtraThisFields
+                  >
+                | WechatMiniprogram.Behavior.Identifier
         ): Behavior.ResolveBehaviorBuilder<
             Builder<
                 TPrevData,