data-faker-plus 0.0.1

package/dist/types/common/ClassDecoratorStateManager.d.ts

@@ -0,0 +1,47 @@
+import { DecoratorInfo } from '../core/DecoratorInfo';
+import { DecoratedClass } from '../types/decorator';
+/**
+ * 类状态管理器
+ * @description 管理类的状态，包括定义在类上装饰器的配置，定义在类上的装饰器
+ */
+export declare class ClassDecoratorStateManager {
+    /**
+     * 单例模式
+     */
+    private static instance;
+    /**
+     * 获取实例
+     * @returns ClassDecoratorStateManager 单例
+     */
+    static getInstance(): ClassDecoratorStateManager;
+    /**
+     * 初始化类装饰器元数据列表
+     * @param target 被装饰的类
+     * @param decorationInfos 装饰器信息列表
+     */
+    initDecoratorInfos(target: DecoratedClass, decorationInfos?: DecoratorInfo[]): void;
+    /**
+     * 是否有装饰器信息元数据列表
+     */
+    hasDecoratorInfos(target: DecoratedClass): boolean;
+    /**
+     * 是否有指定装饰器信息元数据
+     */
+    hasDecoratorInfo(target: DecoratedClass, decoratorName: string | symbol): boolean;
+    /**
+     * 设置类装饰器信息列表元数据
+     */
+    setDecoratorInfos(target: DecoratedClass, decoratorInfos: DecoratorInfo[]): void;
+    /**
+     * 在类上添加装饰器信息
+     */
+    setDecoratorInfo(target: DecoratedClass, decoratorInfo: DecoratorInfo): void;
+    /**
+     * 获取类上所有装饰器信息
+     */
+    getDecoratorInfos(target: DecoratedClass): DecoratorInfo[] | undefined;
+    /**
+     * 获取类上装饰器信息元数据
+     */
+    getDecoratorInfo(target: DecoratedClass, decoratorName: string | symbol): DecoratorInfo | undefined;
+}

package/dist/types/common/ClassDecoratorValidator.d.ts

@@ -0,0 +1,28 @@
+import { DecoratorValidator } from './DecoratorValidator';
+import { DecoratedClass } from '../types/decorator';
+/**
+ * 类装饰器校验器
+ * @description 封装装饰器校验的通用方法
+ */
+export declare class ClassDecoratorValidator implements DecoratorValidator {
+    /**
+     * 类装饰器校验器实例
+     */
+    private static instance;
+    /**
+     * 获取单例实例
+     */
+    static getInstance(): ClassDecoratorValidator;
+    /**
+     * 检查是否有装饰器所要依赖的装饰器
+     * @param target 类装饰器
+     * @param dpDecorators 依赖的装饰器
+     * @param propertyKey 属性名称
+     * @description 有一些装饰器需要依赖于其它装饰器的存在才能工作
+     */
+    hasDependentedDecorator(target: any, dpDecorators: (string | symbol)[]): boolean;
+    /**
+     * 检查类装饰器是否与其它装饰冲突
+     */
+    isDecoratorConflict(target: DecoratedClass, conflictList: (string | symbol)[]): boolean;
+}

package/dist/types/common/DecoratorValidator.d.ts

@@ -0,0 +1,14 @@
+/**
+ * 装饰器校验器
+ * @description 封装装饰器校验的通用方法
+ */
+export declare abstract class DecoratorValidator {
+    /**
+     * 检查装饰器依赖的装饰器是否存在
+     */
+    abstract hasDependentedDecorator(...args: any[]): boolean;
+    /**
+     * 检查装饰器是否与其它装饰冲突
+     */
+    abstract isDecoratorConflict(...args: any[]): boolean;
+}

package/dist/types/common/PropertyDecoraotrValidator.d.ts

@@ -0,0 +1,30 @@
+import { DecoratorValidator } from './DecoratorValidator';
+import { DecoratedClass, DecoratedClassProto } from '../types/decorator';
+/**
+ * 属性装饰器校验器
+ */
+export declare class PropertyDecoratorValidator implements DecoratorValidator {
+    /**
+     * 单例模式
+     */
+    private static instance;
+    /**
+     * 获取PropertyDecoratorValidator实例
+     * ..returns PropertyDecoratorValidator实例
+     */
+    static getInstance(): PropertyDecoratorValidator;
+    /**
+     * 是否有依赖的装饰器
+     * ..param target 被装饰的目标对象或其原型
+     * ..param decoratorName 装饰器名称
+     * ..param propertyKey 属性名称
+     */
+    hasDependentedDecorator(target: any, dpDecorators: (string | symbol)[], propertyKey: string | symbol): boolean;
+    /**
+     * 判断属性上是否存在冲突的装饰器
+     * ..param target 被装饰的目标对象或其原型
+     * ..param decoratorName 装饰器名称
+     * ..param propertyKey 属性名称
+     */
+    isDecoratorConflict(target: DecoratedClass | DecoratedClassProto, conflictList: (string | symbol)[], propertyKey: string | symbol): boolean;
+}

package/dist/types/constants/DataFakerConstants.d.ts

@@ -0,0 +1,2 @@
+export declare const COUNT: unique symbol;
+export declare const DEEP: unique symbol;

package/dist/types/constants/DecoratorConstants.d.ts

@@ -0,0 +1,5 @@
+export declare const DECORATORNAME: {
+    DATAMODEL: symbol;
+    DATAFIELD: symbol;
+    ANONYMOUSE: symbol;
+};

package/dist/types/constants/MetaDataConstants.d.ts

@@ -0,0 +1,4 @@
+export declare const METADATAKEY: {
+    DECORATORINFOS: symbol;
+    MODELSCHEMA: symbol;
+};

package/dist/types/core/DataFaker.d.ts

@@ -0,0 +1,43 @@
+import { Faker } from '@faker-js/faker';
+import { DModel } from './DataModel';
+import { DataFakeHook, DataFakeOptions, LocaleType } from '../types/faker';
+/**
+ * FakerApi类
+ * 提供定义模型的方法
+ */
+export declare class DataFaker {
+    /**
+     * 当前语言
+     * ..default 英文环境
+     */
+    static locale: Faker;
+    /**
+     * 全局回调函数
+     */
+    static hooks: DataFakeHook;
+    /**
+     * 设置当前语言环境
+     * ..param locale 语言环境
+     */
+    static setLocale(locale?: LocaleType): void;
+    /**
+     * 设置全局回调函数
+     */
+    static setHooks(hooks?: DataFakeHook): void;
+    /**
+     * 合并hooks
+     */
+    static unionHooks(runtimeHooks?: DataFakeHook): DataFakeHook;
+    /**
+     * 合并回调函数
+     */
+    private static mergeCb;
+    /**
+     * 伪造数据
+     */
+    static fake(dataModel: DModel | string | symbol | undefined | null, options?: DataFakeOptions | number): any;
+}
+/**
+ * 伪造数据
+ */
+export declare function fakeData(dataModel: DModel | string | symbol | undefined | null, options?: DataFakeOptions | number): any;

package/dist/types/core/DataFieldDecoratorFactory.d.ts

@@ -0,0 +1,38 @@
+import { DecoratorInfo } from './DecoratorInfo';
+import { PropertyDecoratorValidator } from '../common/PropertyDecoraotrValidator';
+import 'reflect-metadata';
+import { DecoratedClassOrProto } from '../types/decorator';
+import { CustomGenerator, DataFieldType, FakerMethodParamsType, FakerMethodPath, RefModel } from '../types/faker';
+/**
+ * 数据字段装饰器工厂
+ */
+export declare class DataFieldDecoratorFactory {
+    /**
+     * 装饰器信息
+     */
+    protected decoratorInfo: DecoratorInfo;
+    /**
+     * 装饰器校验器
+     */
+    protected decoratorValidator: PropertyDecoratorValidator;
+    /**
+     * 初始化装饰
+     */
+    protected initDecoratorInfo(): void;
+    /**
+     * 校验装饰器
+     */
+    protected validateDecorator(target: DecoratedClassOrProto, propertyKey: string | symbol): void;
+    /**
+     * 设置状态
+     * ..param target 被装饰的类或原型
+     * ..param propertyKey 被装饰的属性名
+     * ..param config  配置
+     */
+    protected setupState(target: DecoratedClassOrProto, propertyKey: string | symbol, config: DataFieldType): void;
+    createDecorator(config: DataFieldType): PropertyDecorator;
+}
+/**
+ * 数据字段装饰器
+ */
+export declare function DataField<P extends FakerMethodPath>(options: FakerMethodPath | [P, FakerMethodParamsType<P>] | CustomGenerator | RefModel): PropertyDecorator;

package/dist/types/core/DataModel.d.ts

@@ -0,0 +1,39 @@
+import { DataFieldType, ModelSchema } from '../types/faker';
+/**
+ * 数据模型
+ */
+export declare class DModel {
+    /**
+     * 模型模板
+     */
+    private modelSchema;
+    /**
+     * 模型别名
+     */
+    private modelName;
+    constructor(modelName: string | symbol, modelSchema: Record<string | symbol, DataFieldType>);
+    /**
+     * 添加属性
+     */
+    withProperty(name: string, type: DataFieldType): this;
+    /**
+     * 添加多个属性
+     */
+    withProperties(properties: Record<string, DataFieldType>): this;
+    /**
+     * 排除属性
+     */
+    excludeProperty(name: string | symbol): this;
+    /**
+     * 排除属性
+     */
+    excludeProperties(excluedes: (string | symbol)[]): this;
+    /**
+     * 获取模板
+     */
+    getModelSchema(): ModelSchema;
+    /**
+     * 获取模型名
+     */
+    getModelName(): string | symbol;
+}

package/dist/types/core/DataModelDecoratorFactory.d.ts

@@ -0,0 +1,48 @@
+import { ClassDecoratorValidator } from '../common/ClassDecoratorValidator';
+import { DecoratorInfo } from './DecoratorInfo';
+import { ClassDecorator, DecoratedClass } from '../types/decorator';
+import { ClassDecoratorStateManager } from '../common/ClassDecoratorStateManager';
+/**
+ * 数据模型装饰器工厂类
+ */
+export declare class DataModelDecoratorFactory {
+    /**
+     * 装饰器信息
+     */
+    protected decoratorInfo: DecoratorInfo;
+    /**
+     * 装饰器校验器
+     */
+    protected decoratorValidator: ClassDecoratorValidator;
+    /**
+     * 状态管理器
+     */
+    protected stateManager: ClassDecoratorStateManager;
+    /**
+     * 初始化装饰器信息
+     */
+    protected initDecoratorInfo(): void;
+    /**
+     * 校验装饰器
+     */
+    protected validateDecorator(target: DecoratedClass): void;
+    /**
+     * 获取模型并注入工厂
+     * ..param target 被装饰的类
+     * ..param modelName 模型名
+     */
+    protected setupState(target: DecoratedClass, modelName: string | symbol): void;
+    /**
+     * 递归继承属性
+     */
+    private extendSchema;
+    /**
+     * 创建装饰器
+     * ..param modelName 模型名
+     */
+    createDecorator(modelName: string | symbol): ClassDecorator;
+}
+/**
+ * 数据模型装饰器
+ */
+export declare function DataModel(modelName: string | symbol): ClassDecorator;

package/dist/types/core/DecoratorInfo.d.ts

@@ -0,0 +1,37 @@
+import { DecorationInfo } from '../types/decorator';
+/**
+ * 装饰器信息建造者
+ */
+export declare class DecoratorInfo implements DecorationInfo {
+    /**
+     * 装饰器信息编号
+     */
+    readonly id: string;
+    /**
+     * 装饰器名称
+     * ..default DECORATORNAME.ANONYMOUSE
+     */
+    name: string | symbol;
+    /**
+     * 装饰器配置
+     */
+    configs: any[];
+    /**
+     * 装饰器冲突列表
+     */
+    conflictList: (string | symbol)[];
+    /**
+     * 依赖装饰器
+     */
+    dependsOn: (string | symbol)[];
+    /**
+     * 构造器
+     * ..param decoratorInfo 装饰器信息对象
+     * ..returns 装饰器信息对象
+     */
+    constructor(decoratorInfo?: DecorationInfo);
+    setName(name: string | symbol): this;
+    setConfig(config?: any): this;
+    setConflictList(conflictList: (string | symbol)[]): this;
+    setDependsOn(dependsOn: (string | symbol)[]): this;
+}

package/dist/types/core/LocaleParser.d.ts

@@ -0,0 +1,16 @@
+import { LocaleType } from '../types/faker';
+import { Faker } from '@faker-js/faker';
+/**
+ * 语言解析器
+ */
+export declare class LocaleParser {
+    /**
+     * faker缓存
+     */
+    private static fakerCache;
+    /**
+     * 解析语言环境
+     * ..param locale 语言选项
+     */
+    static parseLocale(locale?: LocaleType): Faker | undefined;
+}

package/dist/types/core/ModelManager.d.ts

@@ -0,0 +1,53 @@
+import { DataFieldType } from '../types/faker';
+import { DModel } from './DataModel';
+import { ClassDecoratorStateManager } from '../common/ClassDecoratorStateManager';
+import { DecoratedClass } from '../types/decorator';
+/**
+ * 模型管理器
+ */
+export declare class ModelManager {
+    /**
+     * 数据模型映射
+     */
+    private static dataModelMap;
+    /**
+     * 状态管理器
+     */
+    protected static stateManager: ClassDecoratorStateManager;
+    /**
+     * 定义模型
+     */
+    static defineModel(modelName: string | symbol, modelSchema: Record<string, DataFieldType>): DModel;
+    /**
+     * 克隆模型
+     */
+    static cloneModel(newModelName: string | symbol, dataModel: DModel): DModel;
+    /**
+     * 使用模型
+     */
+    static useModel(target: DecoratedClass | string | symbol): DModel | null | undefined;
+    /**
+     * 注册数据模型
+     */
+    private static registerDataModel;
+    /**
+     * 是否有数据模型
+     */
+    private static hasDataModel;
+    /**
+     * 获取数据模型
+     */
+    static getDataModel(modelName: string | symbol): DModel | undefined;
+}
+/**
+ * 定义模型
+ */
+export declare function defineModel(modelName: string | symbol, modelSchema: Record<string, DataFieldType>): DModel;
+/**
+ * 克隆模型
+ */
+export declare function cloneModel(newModelName: string | symbol, dataModel: DModel): DModel;
+/**
+ * 使用模型
+ */
+export declare function useModel(target: DecoratedClass | string | symbol): DModel | null | undefined;

package/dist/types/core/ModelParser.d.ts

@@ -0,0 +1,62 @@
+import { RefModelRule, DataFakeHook } from '../types/faker';
+import { Faker } from '@faker-js/faker';
+import { DModel } from './DataModel';
+/**
+ * 模型解析器
+ */
+export declare class ModelParser {
+    /**
+     * 当前语言
+     * ..default 英文环境
+     */
+    private static locale;
+    /**
+     * 钩子函数
+     */
+    private static hooks;
+    /**
+     * 引用规则
+     */
+    private static refRules;
+    /**
+     * 设置当前语言环境
+     * ..param locale 语言环境
+     */
+    static setLocale(locale: Faker): typeof ModelParser;
+    /**
+     * 设置钩子函数
+     */
+    static setHooks(hooks?: DataFakeHook): typeof ModelParser;
+    /**
+     * 设置引用规则
+     */
+    static setRefRules(refRules?: RefModelRule): typeof ModelParser;
+    /**
+     * 使用的模型
+     */
+    static parseModel(dataModel: DModel | string | symbol, count?: number): any;
+    /**
+     * 解析模式
+     */
+    private static parseScheme;
+    /**
+     * 处理字符串schema
+     */
+    private static parseStringSchema;
+    /**
+     * 处理数组schema
+     */
+    private static parseArraySchema;
+    /**
+     * 解析引用对象schema
+     */
+    private static parseRefSchema;
+    /**
+     * 执行hooks
+     */
+    private static executeHooks;
+    /**
+     * 解析路径方法字符串
+     */
+    private static parsePathMethod;
+}

package/dist/types/index.d.ts

@@ -0,0 +1,6 @@
+export { DataModel } from './core/DataModelDecoratorFactory';
+export { DataField } from './core/DataFieldDecoratorFactory';
+export { fakeData } from './core/DataFaker';
+export { useModel, cloneModel, defineModel } from './core/ModelManager';
+export { COUNT, DEEP } from './constants/DataFakerConstants';
+export * from '@faker-js/faker';

package/dist/types/types/decorator.d.ts

@@ -0,0 +1,70 @@
+/**
+ * 构造器
+ */
+export type Constructor<T = any> = new (...args: any[]) => T;
+
+/**
+ * 被装饰类原型
+ */
+type DecoratedClassProto = {};
+
+/**
+ * 被装饰类
+ */
+export type DecoratedClass<T = any> = Constructor<T>;
+
+/**
+ * 被装饰类或原型
+ */
+export type DecoratedClassOrProto = DecoratedClass | DecoratedClassProto;
+
+/**
+ * 类装饰器
+ */
+export type ClassDecorator = (target: DecoratedClass) => void;
+
+/**
+ * 方法装饰器
+ */
+export type MethodDecorator = (
+  target: DecoratedClassOrProto,
+  propertyKey: string | symbol,
+  descriptor: TypedPropertyDescriptor<any>,
+) => void;
+
+/**
+ * 属性装饰器
+ */
+export type PropertyDecorator = (target: DecoratedClassOrProto, propertyKey: string) => void;
+
+/**
+ * 装饰器信息模板
+ */
+export interface DecorationInfo {
+  /**
+   * 装饰器编号
+   */
+  id?: string;
+  /**
+   * 装饰器信息名称
+   */
+  name: string | symbol;
+
+  /**
+   * 装饰器信息配置
+   */
+  configs?: any[];
+  /**
+   * 装饰器冲突列表
+   */
+  conflictList?: (string | symbol)[];
+  /**
+   * 所依赖的装饰器列表
+   */
+  dependsOn?: (string | symbol)[];
+}
+
+/**
+ * 装饰器列表元数据
+ */
+export type DecoratorInfos = DecorationInfo[];