{"id":19760123,"url":"https://github.com/videsk/mongoose-dummy","last_synced_at":"2025-08-01T09:40:31.050Z","repository":{"id":42383410,"uuid":"433421259","full_name":"videsk/mongoose-dummy","owner":"videsk","description":"Random data generator based on mongoose schema, with very flexible options, populate feature and easily integrable with random data generators libraries.","archived":false,"fork":false,"pushed_at":"2024-05-14T16:22:12.000Z","size":309,"stargazers_count":6,"open_issues_count":2,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-10-28T23:52:08.541Z","etag":null,"topics":["dummy","dummy-data","mongoose","mongoose-data-seed","nodejs"],"latest_commit_sha":null,"homepage":"https://open.videsk.io","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"lgpl-2.1","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/videsk.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-11-30T12:24:33.000Z","updated_at":"2024-05-14T16:21:00.000Z","dependencies_parsed_at":"2024-05-02T20:50:01.280Z","dependency_job_id":"9ba0bb56-eaf9-4de8-b425-04e49ffc4ad5","html_url":"https://github.com/videsk/mongoose-dummy","commit_stats":null,"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/videsk%2Fmongoose-dummy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/videsk%2Fmongoose-dummy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/videsk%2Fmongoose-dummy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/videsk%2Fmongoose-dummy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/videsk","download_url":"https://codeload.github.com/videsk/mongoose-dummy/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224214230,"owners_count":17274523,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["dummy","dummy-data","mongoose","mongoose-data-seed","nodejs"],"created_at":"2024-11-12T03:35:36.025Z","updated_at":"2025-04-30T13:32:33.013Z","avatar_url":"https://github.com/videsk.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 🎲 Mongoose Dummy\n\n\u003e Create realistic test data for your Mongoose models with zero hassle! \n\n[![npm version](https://img.shields.io/npm/v/@videsk/mongoose-dummy.svg)](https://www.npmjs.com/package/@videsk/mongoose-dummy)\n[![License: LGPL-2.1](https://img.shields.io/badge/License-LGPL_2.1-blue.svg)](https://opensource.org/licenses/LGPL-2.1)\n\nMongoose Dummy is a powerful random data generator built specifically for Mongoose schemas. Generate realistic test data with support for complex relationships, nested objects, and custom generators. Perfect for testing, development, and seeding your MongoDB databases.\n\n## ✨ Features\n\n- 🔌 Seamless integration with Mongoose models\n- 🔄 Smart population of referenced models\n- 📋 Random selection from enum values\n- 🎯 Customizable field filters\n- 🔧 Flexible array length control\n- 🎨 Works with Faker.js and other data generation libraries\n- 📦 Support for nested objects and arrays\n- 🧪 Perfect for testing and development\n\n## 📦 Installation\n\n```bash\nnpm install @videsk/mongoose-dummy\n```\n\n## 🚀 Quick Start\n\n```javascript\nimport mongoose from 'mongoose';\nimport MongooseDummy from '@videsk/mongoose-dummy';\nimport { faker } from '@faker-js/faker';\n\n// Initialize with mongoose\nconst dummy = new MongooseDummy(mongoose);\n\n// Add faker.js support\ndummy.generators = { faker };\n\n// Generate fake data\nconst fakeUser = dummy.model('User').generate();\n```\n\n## 📖 Usage Guide\n\n### 🏗️ Defining Schemas\n\nAdd the `dummy` property to any field you want to generate data for:\n\n```javascript\nconst userSchema = new mongoose.Schema({\n  name: {\n    type: String,\n    dummy: ({ faker }) =\u003e faker.person.fullName()\n  },\n  email: {\n    type: String,\n    dummy: ({ faker }) =\u003e faker.internet.email()\n  },\n  address: {\n    street: {\n      type: String,\n      dummy: ({ faker }) =\u003e faker.location.streetAddress()\n    },\n    city: {\n      type: String,\n      dummy: ({ faker }) =\u003e faker.location.city()\n    }\n  },\n  createdAt: {\n    type: Date,\n    dummy: ({ faker }) =\u003e faker.date.past()\n  }\n});\n```\n\n### 🔄 Working with References\n\nAutomatically populate referenced models:\n\n```javascript\nconst orderSchema = new mongoose.Schema({\n  customer: {\n    type: mongoose.Schema.Types.ObjectId,\n    ref: 'User',\n    populate: true,  // 👈 Will generate full user data\n    dummy: true\n  },\n  products: [{\n    type: mongoose.Schema.Types.ObjectId,\n    ref: 'Product',\n    populate: true,\n    dummy: true\n  }],\n  total: {\n    type: Number,\n    dummy: ({ faker }) =\u003e faker.number.float({ min: 10, max: 1000 })\n  }\n});\n```\n\n### 📝 Smart Enum Handling\n\n```javascript\nconst taskSchema = new mongoose.Schema({\n  status: {\n    type: String,\n    enum: ['pending', 'in-progress', 'completed'],\n    dummy: true  // 👈 Will randomly select from enum values\n  },\n  priority: {\n    type: String,\n    enum: ['low', 'medium', 'high'],\n    dummy: true\n  }\n});\n```\n\n### 🎯 Custom Field Filters\n\nGenerate data only for specific fields:\n\n```javascript\n// Only generate required fields\nconst requiredOnly = dummy.model('User').generate(\n  options =\u003e options.required === true\n);\n\n// Only generate fields with specific validators\nconst validatedFields = dummy.model('User').generate(\n  options =\u003e options.validate !== undefined\n);\n```\n\n### 📚 Array Configuration\n\nControl the length of generated arrays:\n\n```javascript\n// Global array length setting\nconst dummy = new MongooseDummy(mongoose);\ndummy.setup({ arrayLength: 5 });\n\n// Generate data with custom array length\nconst data = dummy.model('Order').generate();\n// All arrays will have 5 items\n```\n\n### 🔗 Complex Relationships\n\nGenerate data with nested relationships and dependencies:\n\n```javascript\nconst companySchema = new mongoose.Schema({\n  name: {\n    type: String,\n    dummy: ({ faker }) =\u003e faker.company.name()\n  },\n  employees: [{\n    type: mongoose.Schema.Types.ObjectId,\n    ref: 'User',\n    populate: true,\n    dummy: true\n  }],\n  departments: [{\n    name: {\n      type: String,\n      dummy: ({ faker }) =\u003e faker.commerce.department()\n    },\n    manager: {\n      type: mongoose.Schema.Types.ObjectId,\n      ref: 'User',\n      populate: true,\n      dummy: true\n    },\n    budget: {\n      type: Number,\n      dummy: ({ faker }) =\u003e faker.number.int({ min: 10000, max: 1000000 })\n    }\n  }]\n});\n```\n\n### 🎨 Custom Data Generation\n\nUse values from other fields in your generators:\n\n```javascript\nconst productSchema = new mongoose.Schema({\n  name: {\n    type: String,\n    dummy: ({ faker }) =\u003e faker.commerce.productName()\n  },\n  basePrice: {\n    type: Number,\n    dummy: ({ faker }) =\u003e faker.number.float({ min: 10, max: 1000 })\n  },\n  discountedPrice: {\n    type: Number,\n    dummy() {\n      return this.basePrice * 0.8; // Access other generated fields\n    }\n  }\n});\n```\n\n## ⚠️ Limitations\n\n- 🔄 Populate feature is limited to one level deep to prevent circular dependencies\n- 🏷️ Fields without a `dummy` key are ignored in generation\n- 🔒 Some Mongoose features like virtual fields are not supported\n\n## 🤝 Contributing\n\nContributions are welcome! Please feel free to submit issues and pull requests.\n\n1. Fork the repository\n2. Create your feature branch (`git checkout -b feature/amazing-feature`)\n3. Commit your changes (`git commit -m 'Add some amazing feature'`)\n4. Push to the branch (`git push origin feature/amazing-feature`)\n5. Open a Pull Request\n\n## 🧪 Running Tests\n\n```bash\nnpm test\n```\n\n## 📄 License\n\nLGPL-2.1 License - Created with ❤️ by Videsk™\n\n## 🙏 Acknowledgments\n\nSpecial thanks to all contributors and the Mongoose community for making this project possible!","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvidesk%2Fmongoose-dummy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvidesk%2Fmongoose-dummy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvidesk%2Fmongoose-dummy/lists"}