chore(project): improve typings and fix typo (#1802)

packages/core/docs/api/entry/FormValidatorRegistry.md

@@ -13,15 +13,15 @@ order: 6
 #### 签名
 
 ```ts
-interface setValidateLanguage{
+interface setValidateLanguage {
   (language: string): void
 }
 ```
 
 #### 用例
 
 ```ts
-import { setValidateLanguage} from '@formily/core'
+import { setValidateLanguage } from '@formily/core'
 
 setValidationLanguage('en-US')
 
@@ -82,7 +82,7 @@ registerValidateLocale({
 })
 ```
 
-## registerValidateMessageTemplateEnigne
+## registerValidateMessageTemplateEngine
 
 #### 描述
 
@@ -91,17 +91,17 @@ registerValidateLocale({
 #### 签名
 
 ```ts
-interface registerValidateMessageTemplateEnigne {
+interface registerValidateMessageTemplateEngine {
   (template: (message: ValidatorFunctionResponse, context: any) => any): void
 }
 ```
 
 #### 用例
 
 ```ts
-import { registerValidateMessageTemplateEnigne } from '@formily/core'
+import { registerValidateMessageTemplateEngine } from '@formily/core'
 
-registerValidateMessageTemplateEnigne((message, context) => {
+registerValidateMessageTemplateEngine((message, context) => {
   return message.replace(/\<\%\s*([\w.]+)\s*\%\>/g, (_, $0) => {
     return FormPath.getIn(context, $0)
   })

packages/core/src/index.ts

@@ -1,2 +1,4 @@
 export * from './shared/externals'
+export * from './models/types'
 export * from './effects'
+export * from './types'

packages/core/src/models/types.ts

@@ -0,0 +1,9 @@
+export type { Form } from './Form'
+export type { Field } from './Field'
+export type { Query } from './Query'
+export type { Heart } from './Heart'
+export type { Graph } from './Graph'
+export type { LifeCycle } from './LifeCycle'
+export type { ArrayField } from './ArrayField'
+export type { ObjectField } from './ObjectField'
+export type { VoidField } from './VoidField'

packages/core/src/shared/externals.ts

@@ -6,7 +6,7 @@ import {
   setValidateLanguage,
   registerValidateFormats,
   registerValidateLocale,
-  registerValidateMessageTemplateEnigne,
+  registerValidateMessageTemplateEngine,
   registerValidateRules,
 } from '@formily/validator'
 import {
@@ -58,7 +58,7 @@ export {
   setValidateLanguage,
   registerValidateFormats,
   registerValidateLocale,
-  registerValidateMessageTemplateEnigne,
+  registerValidateMessageTemplateEngine,
   registerValidateRules,
   createEffectHook,
   createEffectContext,

packages/react/src/components/SchemaFieid.tsx → packages/react/src/components/SchemaField.tsx

@@ -1,6 +1,6 @@
 import React, { useContext, Fragment } from 'react'
 import { ISchema, Schema } from '@formily/json-schema'
-import { RecursionField } from '../components'
+import { RecursionField } from '.'
 import { render } from '../shared/render'
 import {
   SchemaMarkupContext,
@@ -10,8 +10,8 @@ import {
 import {
   ReactComponentPath,
   JSXComponent,
-  ISchemaFieldFactoryOptions,
-  SchemaComponents,
+  ISchemaFieldReactFactoryOptions,
+  SchemaReactComponents,
   ISchemaFieldProps,
   ISchemaMarkupFieldProps,
   ISchemaTypeFieldProps,
@@ -24,8 +24,8 @@ const getRandomName = () => {
   return `NO_NAME_FIELD_$${env.nonameId++}`
 }
 
-export function createSchemaField<Components extends SchemaComponents>(
-  options: ISchemaFieldFactoryOptions<Components> = {}
+export function createSchemaField<Components extends SchemaReactComponents>(
+  options: ISchemaFieldReactFactoryOptions<Components> = {}
 ) {
   function SchemaField<
     Decorator extends JSXComponent,
@@ -120,7 +120,6 @@ export function createSchemaField<Components extends SchemaComponents>(
     Decorator extends ReactComponentPath<Components>,
     Component extends ReactComponentPath<Components>
   >(props: ISchemaTypeFieldProps<Components, Component, Decorator>) {
-    //@ts-ignore
     return <MarkupField {...props} type="string" />
   }
 

packages/react/src/components/index.ts

@@ -4,5 +4,5 @@ export * from './ArrayField'
 export * from './ObjectField'
 export * from './VoidField'
 export * from './RecursionField'
-export * from './SchemaFieid'
+export * from './SchemaField'
 export * from './Field'

packages/react/src/index.ts

@@ -2,3 +2,4 @@ export * from '@formily/json-schema'
 export * from './components'
 export * from './shared'
 export * from './hooks'
+export * from './types'

packages/react/src/shared/context.ts

@@ -1,6 +1,6 @@
 import React, { createContext } from 'react'
 import { Schema } from '@formily/json-schema'
-import { ISchemaFieldFactoryOptions } from '../types'
+import { ISchemaFieldReactFactoryOptions } from '../types'
 
 const createContextCleaner = <T>(...contexts: React.Context<T>[]) => {
   return ({ children }) => {
@@ -16,7 +16,7 @@ export const SchemaMarkupContext = createContext<Schema>(null)
 export const SchemaContext = createContext<Schema>(null)
 export const SchemaExpressionScopeContext = createContext<any>(null)
 export const SchemaOptionsContext =
-  createContext<ISchemaFieldFactoryOptions>(null)
+  createContext<ISchemaFieldReactFactoryOptions>(null)
 
 export const ContextCleaner = createContextCleaner(
   FieldContext,

packages/react/src/types.ts

@@ -47,10 +47,10 @@ export type IStateMapper<Props> =
     }
   | ((props: Props, field: Formily.Core.Types.GeneralField) => Props)
 
-export type SchemaComponents = Record<string, JSXComponent>
+export type SchemaReactComponents = Record<string, JSXComponent>
 
-export interface ISchemaFieldFactoryOptions<
-  Components extends SchemaComponents = any
+export interface ISchemaFieldReactFactoryOptions<
+  Components extends SchemaReactComponents = any
 > {
   components?: Components
   scope?: any
@@ -73,12 +73,6 @@ export interface ISchemaFieldProps<
   children?: React.ReactNode
 }
 
-export interface ISchemaFieldUpdateRequest {
-  state?: Formily.Core.Types.IFieldState
-  schema?: ISchema
-  run?: string
-}
-
 export interface ISchemaMapper {
   (schema: Schema, name: SchemaKey): Schema
 }
@@ -108,16 +102,18 @@ export type Path<T, Key extends keyof T = keyof T> = Key extends string
     : Key
   : never
 
-export type PathValue<T, P extends Path<T>> =
-  P extends `${infer Key}.${infer Rest}`
-    ? Key extends keyof T
-      ? Rest extends Path<T[Key]>
-        ? PathValue<T[Key], Rest>
-        : never
+export type PathValue<
+  T,
+  P extends Path<T>
+> = P extends `${infer Key}.${infer Rest}`
+  ? Key extends keyof T
+    ? Rest extends Path<T[Key]>
+      ? PathValue<T[Key], Rest>
       : never
-    : P extends keyof T
-    ? T[P]
     : never
+  : P extends keyof T
+  ? T[P]
+  : never
 
 export type KeyOfReactComponent<T> = Exclude<
   keyof T,
@@ -149,7 +145,7 @@ export type ReactComponentPropsByPathValue<
   ? React.ComponentProps<T[P]>
   : never
 export interface ISchemaMarkupFieldProps<
-  Components extends SchemaComponents,
+  Components extends SchemaReactComponents,
   Decorator extends ReactComponentPath<Components>,
   Component extends ReactComponentPath<Components>
 > extends ISchema<
@@ -167,11 +163,7 @@ export interface ISchemaMarkupFieldProps<
 }
 
 export type ISchemaTypeFieldProps<
-  Components extends SchemaComponents,
+  Components extends SchemaReactComponents,
   Decorator extends ReactComponentPath<Components>,
   Component extends ReactComponentPath<Components>
 > = Omit<ISchemaMarkupFieldProps<Components, Decorator, Component>, 'type'>
-
-export interface ISchemaTransformerOptions extends ISchemaFieldFactoryOptions {
-  required?: ISchema['required']
-}

packages/reactive-react/src/index.ts

@@ -1,46 +1,2 @@
-import React, { forwardRef, memo, Fragment } from 'react'
-import hoistNonReactStatics from 'hoist-non-react-statics'
-import { useObserver } from './hooks'
-import { IObserverOptions, IObserverProps } from './types'
-
-export function observer<P, Options extends IObserverOptions>(
-  component: React.FunctionComponent<P>,
-  options?: Options
-): React.MemoExoticComponent<
-  React.FunctionComponent<
-    Options extends { forwardRef: true }
-      ? P & {
-          ref?: 'ref' extends keyof P ? P['ref'] : React.RefAttributes<any>
-        }
-      : React.PropsWithoutRef<P>
-  >
-> {
-  const realOptions = {
-    forwardRef: false,
-    ...options,
-  }
-
-  const wrappedComponent = realOptions.forwardRef
-    ? forwardRef((props: any, ref: any) => {
-        return useObserver(() => component({ ...props, ref }), realOptions)
-      })
-    : (props: any) => {
-        return useObserver(() => component(props), realOptions)
-      }
-
-  const memoComponent = memo(wrappedComponent)
-
-  hoistNonReactStatics(memoComponent, component)
-
-  if (realOptions.displayName) {
-    memoComponent.displayName = realOptions.displayName
-  }
-
-  return memoComponent
-}
-
-export const Observer = observer((props: IObserverProps) => {
-  const children =
-    typeof props.children === 'function' ? props.children() : props.children
-  return React.createElement(Fragment, {}, children)
-})
+export * from './observer'
+export * from './types'

packages/reactive-react/src/observer.ts

@@ -0,0 +1,46 @@
+import React, { forwardRef, memo, Fragment } from 'react'
+import hoistNonReactStatics from 'hoist-non-react-statics'
+import { useObserver } from './hooks'
+import { IObserverOptions, IObserverProps } from './types'
+
+export function observer<P, Options extends IObserverOptions>(
+  component: React.FunctionComponent<P>,
+  options?: Options
+): React.MemoExoticComponent<
+  React.FunctionComponent<
+    Options extends { forwardRef: true }
+      ? P & {
+          ref?: 'ref' extends keyof P ? P['ref'] : React.RefAttributes<any>
+        }
+      : React.PropsWithoutRef<P>
+  >
+> {
+  const realOptions = {
+    forwardRef: false,
+    ...options,
+  }
+
+  const wrappedComponent = realOptions.forwardRef
+    ? forwardRef((props: any, ref: any) => {
+        return useObserver(() => component({ ...props, ref }), realOptions)
+      })
+    : (props: any) => {
+        return useObserver(() => component(props), realOptions)
+      }
+
+  const memoComponent = memo(wrappedComponent)
+
+  hoistNonReactStatics(memoComponent, component)
+
+  if (realOptions.displayName) {
+    memoComponent.displayName = realOptions.displayName
+  }
+
+  return memoComponent
+}
+
+export const Observer = observer((props: IObserverProps) => {
+  const children =
+    typeof props.children === 'function' ? props.children() : props.children
+  return React.createElement(Fragment, {}, children)
+})

packages/reactive-vue/src/index.ts

@@ -1,2 +1,3 @@
 export * from './observer'
 export * from './hooks'
+export * from './types'

packages/validator/src/__tests__/validator.spec.ts

@@ -3,7 +3,7 @@ import {
   registerValidateRules,
   registerValidateFormats,
   setValidateLanguage,
-  registerValidateMessageTemplateEnigne,
+  registerValidateMessageTemplateEngine,
 } from '../index'
 
 registerValidateRules({
@@ -328,7 +328,7 @@ test('language', async () => {
 })
 
 test('validator template', async () => {
-  registerValidateMessageTemplateEnigne((message) => {
+  registerValidateMessageTemplateEngine((message) => {
     if (typeof message !== 'string') return message
     return message.replace(/\<\<\s*([\w.]+)\s*\>\>/g, (_, $0) => {
       return { aa: 123 }[$0]

packages/validator/src/registry.ts

@@ -26,7 +26,9 @@ const getBrowserlanguage = () => {
   if (!self.navigator) {
     return defaultLanguage
   }
-  return self.navigator.browserlanguage || self.navigator.language || defaultLanguage
+  return (
+    self.navigator.browserlanguage || self.navigator.language || defaultLanguage
+  )
 }
 
 const registry = {
@@ -56,7 +58,7 @@ const getISOCode = (language: string) => {
   return isoCode
 }
 
-export const getValidateLocaleIOSCode = getISOCode;
+export const getValidateLocaleIOSCode = getISOCode
 
 export const setValidateLanguage = (lang: string) => {
   registry.locales.language = lang || defaultLanguage
@@ -104,7 +106,7 @@ export const registerValidateFormats = (formats: IRegistryFormats) => {
   })
 }
 
-export const registerValidateMessageTemplateEnigne = (
+export const registerValidateMessageTemplateEngine = (
   template: (message: ValidatorFunctionResponse, context: any) => any
 ) => {
   registry.template = template