feat(class-mock): add entity decorator、class decorator

Author: 2214962083

packages/class-mock/api.drawio.png

@@ -18,7 +18,7 @@
     "build": "pnpm type-check &&esno ./scripts/build.ts",
     "build:watch": "cross-env WATCH=true pnpm build",
     "clean": "rimraf ./dist/**/*",
-    "dev": "esno ./src/index.ts",
+    "dev": "esno ./src/playground.ts",
     "test": "vitest run --silent --passWithNoTests",
     "test:watch": "pnpm test -- --watch",
     "type-check": "tsc --noEmit"

packages/class-mock/package.json

@@ -0,0 +1,4 @@
+export const CLASS_META_KEY = '__CLASS_MOCK_CLASS_META_KEY__'
+export const DEFAULT_ARRAY_LENGTH = 10
+export const DEFAULT_ARRAY_MAX = 50
+export const DEFAULT_ARRAY_MIN = 0

packages/class-mock/src/constants/meta.constants.ts

@@ -0,0 +1,16 @@
+import {CLASS_META_KEY} from '@/constants/meta.constants'
+import {ConfigDecorator} from './config.decorator'
+
+const _decoratorProto = ConfigDecorator(
+  {},
+  {
+    overridePropertyKey: CLASS_META_KEY,
+    isClass: true
+  }
+)
+
+export const DefaultPartial = _decoratorProto.DefaultPartial
+export const DefaultInclude = _decoratorProto.DefaultInclude
+export const DefaultExclude = _decoratorProto.DefaultExclude
+export const DefaultAlwaysRandom = _decoratorProto.DefaultAlwaysRandom
+export const DefaultNotAlwaysRandom = _decoratorProto.DefaultNotAlwaysRandom

packages/class-mock/src/constants/metakey.constants.ts

@@ -6,44 +6,108 @@ import {
   MockPropertyMetadata,
   MockPropertyDecorator,
   ArrayConfig,
-  MockPropertyDecoratorProps
+  MockPropertyDecoratorProps,
+  MockClassDecorator,
+  MockClassDecoratorProps
 } from '@/utils/types-helper'
 
-export function ConfigDecorator<T extends MockPropertyDecoratorConfig = MockPropertyDecoratorConfig>(
-  config: T = <T>{}
-): MockPropertyDecorator<T> {
-  const createConfigDecorator = (config: T = <T>{}) => {
+export interface ConfigDecoratorOptions<IsClass extends boolean = false> {
+  /**
+   * for class decorator
+   */
+  overridePropertyKey?: string
+
+  /**
+   * for class decorator
+   */
+  isClass?: IsClass
+}
+export function ConfigDecorator<
+  T extends MockPropertyDecoratorConfig = MockPropertyDecoratorConfig,
+  IsClass extends boolean = false
+>(
+  config: T = <T>{},
+  options: ConfigDecoratorOptions<IsClass> = {}
+): IsClass extends true ? MockClassDecorator<T> : MockPropertyDecorator<T> {
+  const {overridePropertyKey, isClass} = options
+
+  const createConfigDecorator = <IsClass extends boolean = false>(
+    config: T = <T>{}
+  ): IsClass extends true ? MockClassDecorator<T> : MockPropertyDecorator<T> => {
     const decorator = (target: any, propertyKey: string | symbol) => {
-      const propertyName = propertyKey as string
+      const propertyName = overridePropertyKey ? overridePropertyKey : (propertyKey as string)
       const _target = getTarget(target)
-      const preMetadata = MetadataStorage.instance.findMockMetadata(_target, propertyName)
-      const metadata: MockPropertyMetadata = mergeConfig(preMetadata, {
-        target: _target,
-        propertyName,
-        ...config
-      })
-
-      MetadataStorage.instance.addMockMetadata(metadata)
+      if (!isClass) {
+        const preMetadata = MetadataStorage.instance.findMockMetadata(_target, propertyName)
+        const metadata: MockPropertyMetadata = mergeConfig(preMetadata, {
+          target: _target,
+          propertyName,
+          ...config
+        })
+
+        MetadataStorage.instance.setMockMetadata(metadata)
+      } else {
+        MetadataStorage.instance.mergeAllPropertyMockMetadata(_target, config, (oldMeta, mergeMeta) => {
+          const finalPartial =
+            oldMeta.partial === undefined || oldMeta.partial === null || oldMeta.partial === 'auto'
+              ? mergeMeta?.partial ?? oldMeta.partial
+              : oldMeta.partial
+
+          const finalAlwaysRandom =
+            oldMeta.alwaysRandom === undefined || oldMeta.alwaysRandom === null
+              ? mergeMeta?.alwaysRandom ?? oldMeta.alwaysRandom
+              : oldMeta.alwaysRandom
+
+          MetadataStorage.instance.updateMockMetadata(oldMeta.target, oldMeta.propertyName, {
+            partial: finalPartial,
+            alwaysRandom: finalAlwaysRandom
+          })
+        })
+      }
     }
 
-    const createMergeConfigDecorator = (newConfig: T = <T>{}) => createConfigDecorator(mergeConfig(config, newConfig))
+    const createMergeConfigDecorator = <IsClass extends boolean = false>(newConfig: T = <T>{}) =>
+      createConfigDecorator<IsClass>(mergeConfig(config, newConfig))
 
-    const decoratorProto: MockPropertyDecoratorProps<T> = {
+    const propertyDecoratorProto: MockPropertyDecoratorProps<T> = {
       config: (_config: T = <T>{}) => createMergeConfigDecorator(_config),
       isPartial: () => createMergeConfigDecorator(<T>{partial: 'partial'}),
       isInclude: () => createMergeConfigDecorator(<T>{partial: 'include'}),
       isExclude: () => createMergeConfigDecorator(<T>{partial: 'exclude'}),
       isAlwaysRandom: () => createMergeConfigDecorator(<T>{alwaysRandom: true}),
       isNotAlwaysRandom: () => createMergeConfigDecorator(<T>{alwaysRandom: false}),
-      isArray: (arrayConfig?: ArrayConfig) => createMergeConfigDecorator(<T>{array: true, ...arrayConfig}),
+      isArray: (arrayConfig?: ArrayConfig | number) =>
+        createMergeConfigDecorator(<T>{
+          array: true,
+          ...(typeof arrayConfig === 'number' ? {length: arrayConfig} : arrayConfig)
+        }),
       isNotArray: () => createMergeConfigDecorator(<T>{array: false}),
       groups: (groups: string[]) => createMergeConfigDecorator(<T>{groups})
     }
 
-    Object.assign(decorator, decoratorProto)
+    const classDecoratorProto: MockClassDecoratorProps<T> = {
+      DefaultPartial: () => createMergeConfigDecorator<true>(<T>{partial: 'partial'}),
+      DefaultInclude: () => createMergeConfigDecorator<true>(<T>{partial: 'include'}),
+      DefaultExclude: () => createMergeConfigDecorator<true>(<T>{partial: 'exclude'}),
+      DefaultAlwaysRandom: () => createMergeConfigDecorator<true>(<T>{alwaysRandom: true}),
+      DefaultNotAlwaysRandom: () => createMergeConfigDecorator<true>(<T>{alwaysRandom: false})
+    }
+
+    Object.assign(decorator, isClass ? classDecoratorProto : propertyDecoratorProto)
 
-    return decorator as MockPropertyDecorator<T>
+    return decorator as IsClass extends true ? MockClassDecorator<T> : MockPropertyDecorator<T>
   }
 
   return createConfigDecorator(config)
 }
+
+const _decoratorProto = ConfigDecorator()
+export const Config = _decoratorProto.config
+export const IsPartial = _decoratorProto.isPartial
+export const IsInclude = _decoratorProto.isInclude
+export const IsExclude = _decoratorProto.isExclude
+export const IsAlwaysRandom = _decoratorProto.isAlwaysRandom
+export const IsNotAlwaysRandom = _decoratorProto.isNotAlwaysRandom
+export const IsArray = _decoratorProto.isArray
+export const IsNotArray = _decoratorProto.isNotArray
+export const Groups = _decoratorProto.groups

packages/class-mock/src/decorators/class.decorator.ts

@@ -0,0 +1,8 @@
+import {BaseClass, MockPropertyDecorator, MockPropertyDecoratorConfig, MockPropertyMetadata} from '@/utils/types-helper'
+import {ConfigDecorator} from './config.decorator'
+
+export const Entity = <T extends BaseClass>(getEntity: () => T): MockPropertyDecorator<MockPropertyDecoratorConfig> => {
+  return ConfigDecorator<MockPropertyDecoratorConfig>({
+    entityFn: getEntity
+  } as MockPropertyMetadata)
+}

packages/class-mock/src/decorators/config.decorator.ts

@@ -7,8 +7,6 @@ import {MockDecorator} from './mock.decorator'
 export type FakeProp = typeof fakeProps[number]
 export type MockFaker = Pick<Faker, FakeProp>
 const createFakeProxy = <T extends keyof MockFaker, KeyFns extends keyof MockFaker[T]>(fakeKey: T) => {
-  const mockFaker = faker as MockFaker
-
   // fix Parameter params only allow function
   type MockFnParameters<T> = T extends (...args: infer P) => any ? P : never
 
@@ -21,7 +19,7 @@ const createFakeProxy = <T extends keyof MockFaker, KeyFns extends keyof MockFak
 
   return new Proxy(faker[fakeKey], {
     get(target, targetKey: string) {
-      const mockFn = mockFaker[fakeKey][targetKey as KeyFns] as unknown as Fn
+      const mockFn = target[targetKey as KeyFns] as unknown as Fn
       return (...params: any[]) => MockDecorator(mockFn, ...params)
     }
   }) as unknown as MockProxy

packages/class-mock/src/decorators/entity.decorator.ts

@@ -0,0 +1,5 @@
+export * from './config.decorator'
+export * from './mock.decorator'
+export * from './class.decorator'
+export * from './entity.decorator'
+export * from './faker.decorator'

packages/class-mock/src/decorators/faker.decorator.ts

@@ -1,39 +1,48 @@
-/* eslint-disable @typescript-eslint/no-explicit-any */
-import 'reflect-metadata'
-import faker from '@faker-js/faker'
-import {Random, Name, Phone, Address} from './decorators/faker.decorator'
-import {createMock} from './utils/create-mock'
-
-faker.setLocale('zh_CN')
-
-class User {
-  @Name.firstName()
-  name!: string
-
-  @Random.number({min: 0, max: 100})
-  age!: number
-}
-
-class Student extends User {
-  @Address.streetAddress().isArray({length: 3})
-  address!: string[]
-
-  @Phone.phoneNumber('188########')
-  tel!: number
-}
-
-const mockStudent = createMock(Student)
-
-console.log('mockStudent: ', mockStudent)
-
-// 比如提供一个 webpack 插件或者 vite 插件，配置一下，axios 或 fetch 访问该 url 就可以自动响应 mock 数据了
-// const serverPluginConfig = [
-//   {
-//     url: '/api/users',
-//     res: () => createMock(Student, {array: true})
-//   },
-//   {
-//     url: '/api/user/:id',
-//     res: () => createMock(Student, {array: false})
-//   }
-// ]
+export {
+  // custom decorator
+  MockDecorator,
+  // property config decorator
+  Config,
+  IsPartial,
+  IsInclude,
+  IsExclude,
+  IsAlwaysRandom,
+  IsNotAlwaysRandom,
+  IsArray,
+  IsNotArray,
+  // entity decorator
+  Entity,
+  // faker decorators
+  Mersenne,
+  Random,
+  Helpers,
+  Datatype,
+  Address,
+  Animal,
+  Commerce,
+  Company,
+  Database,
+  Date,
+  Finance,
+  Git,
+  Hacker,
+  Image,
+  Internet,
+  Lorem,
+  Music,
+  Name,
+  Phone,
+  System,
+  Time,
+  Vehicle,
+  Word,
+  // class decorators
+  DefaultPartial,
+  DefaultInclude,
+  DefaultExclude,
+  DefaultAlwaysRandom,
+  DefaultNotAlwaysRandom
+} from './decorators'
+export {createMock} from './utils/create-mock'
+export type {CreateMockOptions} from './utils/create-mock'
+export * from './utils/types-helper'