wip: defineModel

vuejs · Apr 5, 2023 · 221dabc · 221dabc
1 parent 9557529
commit 221dabc
Show file tree

Hide file tree

Showing 5 changed files with 64 additions and 3 deletions.
diff --git a/packages/compiler-sfc/src/compileScript.ts b/packages/compiler-sfc/src/compileScript.ts
@@ -151,6 +151,11 @@ type EmitsDeclType = FromNormalScript<
   TSFunctionType | TSTypeLiteral | TSInterfaceBody
 >
 
+export interface ModelDecl {
+  type: TSType
+  option: Node
+}
+
 /**
  * Compile `<script setup>`
  * It requires the whole SFC descriptor because we need to handle and merge
@@ -325,6 +330,7 @@ export function compileScript(
   let emitsTypeDecl: EmitsDeclType | undefined
   let emitIdentifier: string | undefined
   let optionsRuntimeDecl: Node | undefined
+  // let modelDeclMap: Record<string, ModelDecl> = {}
   let hasAwait = false
   let hasInlinedSsrRenderFn = false
   // props/emits declared via types

diff --git a/packages/dts-test/setupHelpers.test-d.ts b/packages/dts-test/setupHelpers.test-d.ts
@@ -6,7 +6,9 @@ import {
   withDefaults,
   Slots,
   defineSlots,
-  VNode
+  VNode,
+  WritableComputedRef,
+  defineModel
 } from 'vue'
 import { describe, expectType } from './utils'
 
@@ -202,6 +204,27 @@ describe('defineSlots', () => {
   expectType<Slots>(slotsUntype)
 })
 
+describe('defineModel', () => {
+  const modelValue = defineModel<string>()
+  expectType<WritableComputedRef<string | undefined>>(modelValue)
+  modelValue.value = 'new value'
+
+  const modelValueRequired = defineModel<boolean>({ required: true })
+  expectType<WritableComputedRef<boolean>>(modelValueRequired)
+
+  const modelValueDefault = defineModel<boolean>({ default: true })
+  expectType<WritableComputedRef<boolean>>(modelValueDefault)
+
+  const count = defineModel<number>('count')
+  expectType<WritableComputedRef<number | undefined>>(count)
+
+  const countRequired = defineModel<number>('count', { required: true })
+  expectType<WritableComputedRef<number>>(countRequired)
+
+  const countDefault = defineModel<number>('count', { default: 1 })
+  expectType<WritableComputedRef<number>>(countDefault)
+})
+
 describe('useAttrs', () => {
   const attrs = useAttrs()
   expectType<Record<string, unknown>>(attrs)

diff --git a/packages/runtime-core/src/apiSetupHelpers.ts b/packages/runtime-core/src/apiSetupHelpers.ts
@@ -26,6 +26,7 @@ import {
 } from './componentProps'
 import { warn } from './warning'
 import { SlotsType, TypedSlots } from './componentSlots'
+import { WritableComputedRef } from '@vue/reactivity'
 
 // dev only
 const warnRuntimeUsage = (method: string) =>
@@ -200,11 +201,39 @@ export function defineOptions<
 
 export function defineSlots<
   S extends Record<string, any> = Record<string, any>
->(): // @ts-expect-error
-TypedSlots<SlotsType<S>> {
+>(): TypedSlots<SlotsType<S>> {
   if (__DEV__) {
     warnRuntimeUsage(`defineSlots`)
   }
+  return null as any
+}
+
+export function defineModel<T>(
+  options: { required: true } & Record<string, unknown>
+): WritableComputedRef<T>
+export function defineModel<T>(
+  options: { default: any } & Record<string, unknown>
+): WritableComputedRef<T>
+export function defineModel<T>(
+  options?: Record<string, unknown>
+): WritableComputedRef<T | undefined>
+export function defineModel<T>(
+  name: string,
+  options: { required: true } & Record<string, unknown>
+): WritableComputedRef<T>
+export function defineModel<T>(
+  name: string,
+  options: { default: any } & Record<string, unknown>
+): WritableComputedRef<T>
+export function defineModel<T>(
+  name: string,
+  options?: Record<string, unknown>
+): WritableComputedRef<T | undefined>
+export function defineModel() {
+  if (__DEV__) {
+    warnRuntimeUsage('defineModel')
+  }
+  return null as any
 }
 
 type NotUndefined<T> = T extends undefined ? never : T

diff --git a/packages/runtime-core/src/index.ts b/packages/runtime-core/src/index.ts
@@ -71,6 +71,7 @@ export {
   defineExpose,
   defineOptions,
   defineSlots,
+  defineModel,
   withDefaults,
   // internal
   mergeDefaults,

diff --git a/packages/runtime-core/types/scriptSetupHelpers.d.ts b/packages/runtime-core/types/scriptSetupHelpers.d.ts
@@ -5,6 +5,7 @@ type _defineEmits = typeof defineEmits
 type _defineExpose = typeof defineExpose
 type _defineOptions = typeof defineOptions
 type _defineSlots = typeof defineSlots
+type _defineModel = typeof defineModel
 type _withDefaults = typeof withDefaults
 
 declare global {
@@ -13,5 +14,6 @@ declare global {
   const defineExpose: _defineExpose
   const defineOptions: _defineOptions
   const defineSlots: _defineSlots
+  const defineModel: _defineModel
   const withDefaults: _withDefaults
 }