data-faker-plus 0.0.1

package/dist/types/types/faker.d.ts

@@ -0,0 +1,238 @@
+import { COUNT, DEEP } from '../constant/DataFakerConstants';
+import { Faker, allFakers, LocaleDefinition } from '@faker-js/faker';
+import { DModel } from '../core/DataModel';
+
+/**
+ * faker模块联合类型
+ */
+type FakerModule = keyof Faker;
+
+/**
+ * faker 模块.方法联合类型路径字符串
+ * @example book.title,animal.name
+ */
+type FakerMethodPath<M extends FakerModule = FakerModule> = M extends M
+  ? keyof Faker[M] extends string
+    ? `${M}.${keyof Faker[M]}`
+    : never
+  : never;
+
+/**
+ * faker方法
+ * @description 根据方法路径推断方法类型
+ */
+type FakerMethod<P extends string> = P extends `${infer M extends FakerModule}.${infer F}`
+  ? F extends keyof Faker[M]
+    ? Faker[M][F] extends (...args: any) => any
+      ? Faker[M][F]
+      : never
+    : never
+  : never;
+
+/**
+ * faker方法参数类型
+ */
+/* type FakerMethodParamsType<P extends string> = FakerMethod<P> extends (args: infer A) => any ? A :never; */
+type FakerMethodParamsType<P extends FakerMethodPath> = P extends `${infer M}.${infer F}`
+  ? M extends FakerModule
+    ? F extends keyof Faker[M]
+      ? Faker[M][F] extends (...args: infer A) => any
+        ? A extends [any?]
+          ? A[0]
+          : never
+        : never
+      : never
+    : never
+  : never;
+/**
+ * 自定义数据生成器
+ */
+type CustomGenerator = (ctx: Record<string | symbol, any>) => any;
+
+/**
+ * 引用模型选项
+ */
+type RefModelOptions = {
+  /**
+   * 所引用的模型
+   */
+  refModel: DModel | string | symbol;
+  /**
+   * 生成数量
+   */
+  count?: number;
+  /**
+   * 引用自身时的递归深度
+   */
+  deep?: number;
+  /**
+   * 保留最后一项，并使用null显示
+   */
+  //remain?: boolean;
+};
+/**
+ * 引用模型配置
+ */
+type RefModel = RefModelOptions | DModel;
+
+/**
+ * 数据字段类型
+ */
+type DataFieldType<P extends FakerMethodPath = FakerMethodPath> =
+  | CustomGenerator
+  | RefModel
+  | FakerMethodPath
+  | [P, FakerMethodParamsType<P>];
+
+/**
+ * 字段装饰器配置类型
+ */
+type DataFieldDecoratorOptions<P extends FakerMethodPath> = DataFieldType<P>;
+
+/**
+ * 模型字段结构
+ */
+type DataField = {
+  /**
+   * 类型
+   */
+  fieldSchema: FakerMethodPath | CustomGenerator | RefModel;
+
+  /**
+   * 参数
+   */
+  args?: any;
+};
+
+/**
+ * 模型数据结构
+ */
+type ModelSchema = Record<string | symbol, DataFieldType>;
+
+/**
+ * 所有Fakers联合类型
+ */
+export type AllFakers = keyof typeof allFakers;
+
+/**
+ * 语言环境类型
+ */
+type LocaleType = AllFakers | Array<LocaleDefinition | AllFakers> | Faker;
+
+/**
+ * Fake数据规则
+ */
+type RefModelRule = {
+  /**
+   * 生成数量
+   */
+  [COUNT]?: number;
+  /**
+   * 引用自身时的递归深度
+   */
+  [DEEP]?: number;
+
+  /**
+   * 结构递归
+   */
+  [key: string | symbol]: number | RefModelRule | [number, number];
+};
+/**
+ * schema类型
+ */
+type SchemaType = 'function' | 'object' | 'array' | 'string';
+/**
+ * beforeEachCbs的上下文对象
+ */
+type BeforeEachContext = {
+  /**
+   * 每次循环的key
+   */
+  key: string | symbol;
+  /**
+   * schema
+   */
+  schema: DataFieldType;
+  /**
+   * 模板schema的类型
+   */
+  type: SchemaType;
+  /**
+   * 所属对象
+   */
+  belongTo: string | symbol;
+};
+
+/**
+ * afterEachCbs的上下文对象
+ */
+type AfterEachContext = {
+  /**
+   * 每次循环的key
+   */
+  key: string | symbol;
+  /**
+   * 每次循环后的value
+   */
+  value: any;
+  /**
+   * 已经生成的数据结果
+   */
+  result: any;
+  /**
+   * 模板schema的类型
+   */
+  type: SchemaType;
+  /**
+   * 所属对象
+   */
+  belongTo: string | symbol;
+};
+
+/**
+ * 数据生成钩子
+ */
+type DataFakeHook = {
+  /**
+   * 数据生成前的钩子
+   */
+  beforeAllCbs?: DataFakeCb<ModelSchema>;
+  /**
+   * 数据生成之后的钩子
+   */
+  afterAllCbs?: DataFakeCb;
+  /**
+   * 每次循环之前的钩子
+   */
+  beforeEachCbs?: DataFakeCb<BeforeEachContext>;
+  /**
+   * 每次循环生成数据之后的钩子
+   */
+  afterEachCbs?: DataFakeCb<AfterEachContext>;
+};
+/**
+ * 使用模型配置
+ */
+type DataFakeOptions = {
+  /**
+   * 生成数量
+   */
+  count?: number;
+  /**
+   * 对于引用类型的规则
+   */
+  refRules?: RefModelRule;
+  /**
+   * 钩子函数
+   */
+  hooks?: DataFakeHook;
+  /**
+   * 语言环境
+   */
+  locale?: LocaleType;
+};
+
+/**
+ * 数据生成后的回调函数类型
+ */
+type DataFakeCb<T = any> = ((data: T) => T) | Array<(data: T) => T>;

package/dist/types/types/index.d.ts

@@ -0,0 +1,2 @@
+export * from './decorator';
+export * from './faker';

package/dist/types/types/index.ts

@@ -0,0 +1,2 @@
+export * from './decorator';
+export * from './faker';

package/dist/types/utils/IdUtils.d.ts

@@ -0,0 +1,13 @@
+/**
+ * 编号生成工具
+ */
+export declare class IdUtils {
+    /**
+     * 初始编号
+     */
+    private static id;
+    /**
+     * 获取唯一识别码
+     */
+    static getUUID(): string;
+}

package/dist/types/utils/ObjectUtils.d.ts

@@ -0,0 +1,9 @@
+/**
+ * 对象处理工具
+ */
+export declare class ObjectUtils {
+    /**
+     * 深克隆对象
+     */
+    static deepClone(obj: any, hashMap?: WeakMap<object, any>): any;
+}

package/package.json

@@ -0,0 +1,58 @@
+{
+  "name": "data-faker-plus",
+  "private": false,
+  "version": "0.0.1",
+  "type": "module",
+  "main": "dist/index.esm.js",
+  "module": "dist/index.esm.js",
+  "types": "dist/types/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "keywords": [
+    "faker",
+    "mock",
+    "mock data"
+  ],
+  "engines": {
+    "node": ">=18"
+  },
+  "description": "A data faker library based on @faker-js/faker",
+  "author": "SWUST-LMH <1357526355@qq.com>",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/bloom-lmh/data-faker.git"
+  },
+  "homepage": "https://yourname.github.io/repo",
+  "bugs": {
+    "url": "https://github.com/bloom-lmh/data-faker/issues"
+  },
+  "scripts": {
+    "build": "cross-env NODE_ENV=production rollup -c rollup.config.js",
+    "dev": "rollup -c rollup.config.js --watch",
+    "clean": "rimraf dist",
+    "build:clean": "npm run clean && npm run build",
+    "test": "vitest"
+  },
+  "devDependencies": {
+    "@rollup/plugin-alias": "^5.1.1",
+    "@rollup/plugin-babel": "^6.0.4",
+    "@rollup/plugin-commonjs": "^28.0.6",
+    "@rollup/plugin-node-resolve": "^16.0.1",
+    "@rollup/plugin-terser": "^0.4.4",
+    "@rollup/plugin-typescript": "^12.1.4",
+    "cross-env": "^10.1.0",
+    "rimraf": "^6.0.1",
+    "rollup": "^4.52.3",
+    "rollup-plugin-copy": "^3.5.0",
+    "rollup-plugin-dts": "^6.2.3",
+    "tslib": "^2.8.1",
+    "typescript": "~5.8.3",
+    "vitest": "^3.2.4"
+  },
+  "dependencies": {
+    "@faker-js/faker": "^10.0.0",
+    "reflect-metadata": "^0.2.2"
+  }
+}