feat: Organize comprehensive templates in examples.ts with helper methods and combined template

[Copilot]

This PR reorganizes the template structure by moving comprehensive templates to a dedicated examples.ts file and adding convenient helper methods for common data generation tasks.

Changes Made

File Organization

• Moved comprehensive templates from src/structured/templates.ts to src/examples.ts
• Restored src/structured/templates.ts to contain only basic templates (nil, tokensHelloWorld, tokensObjectKey, str)
• Removed examples namespace export from main src/index.ts to keep the public API clean

Combined Template

Created allExamples template that uses the or pattern to randomly select from all 34 comprehensive templates:

export const allExamples: Template = ['or',
  userProfile,
  userBasic,
  apiResponse,
  // ... all other templates including recursive ones
  tree,
  comment,
];

Helper Methods for Easy Generation

Added convenient helper methods that eliminate the need to construct templates manually:

import { genUser, genAddress, genProduct, genRandomExample } from '@jsonjoy.com/json-random/lib/examples';

// Generate common data types quickly
const user = genUser();
const address = genAddress();
const product = genProduct();
const randomData = genRandomExample();

Available helper methods include:

• genUser(), genUserBasic() - User profiles
• genAddress(), genLocation() - Geographic data
• genProduct(), genOrder() - E-commerce data
• genTransaction(), genBankAccount() - Financial data
• genSocialPost(), genSocialProfile() - Social media data
• genPatient(), genMedicalRecord() - Medical data
• genStudent(), genCourse() - Educational data
• genSensorReading(), genIotDevice() - IoT data
• genLogEntry(), genMetricData() - Monitoring data
• genRandomExample() - Random selection from all templates

Template Categories Available

• String patterns: Email, phone, URLs, product codes
• User profiles: Basic and detailed user data with authentication
• E-commerce: Products, orders, transactions, bank accounts
• API responses: Success/error responses with data arrays
• IoT & sensors: Device readings, sensor data, network information
• Medical records: Patient data, diagnoses, medications, vitals
• Educational data: Students, courses, grades, schedules
• Geographic data: Addresses, coordinates, locations
• Social media: Posts, profiles, hashtags, media attachments
• Financial data: Transactions, accounts, multi-currency support
• Monitoring: Log entries, metrics, system data
• Edge cases: Empty structures, Unicode text, large numbers
• Performance testing: Deeply nested data structures

Quality Assurance

• ✅ All 84 tests pass
• ✅ Linter and formatter compliance maintained
• ✅ Helper methods fully documented in README.md
• ✅ Clean separation between core library and examples

This organization provides better separation of concerns while adding convenient helper methods for common use cases, making the library more approachable for developers who need quick data generation without template construction.

Fixes #4.

---

💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.

[streamich]

• Move all new templates to src/examples.ts.
• Crate a template which combines all templates using or template.
• Make sure tests pass.
• Make sure linter and formatter pass.

[Copilot]

• Move all new templates to src/examples.ts.
• Crate a template which combines all templates using or template.
• Make sure tests pass....

All changes implemented in commit d54454e:

✅ Moved all new templates to src/examples.ts
✅ Created allExamples template that combines all templates using or template
✅ All tests pass (84 tests)
✅ Linter and formatter pass

The comprehensive templates are now properly organized in src/examples.ts with a combined template that randomly selects from all 34 available examples using the or template pattern.

[streamich]

When done, make sure formatter passes.

[streamich]

Remove this line.

[Copilot]

Removed the export * as examples from './examples'; line from src/index.ts in commit 6a4fba8.

[streamich]

Suggested change

	tree(),
	comment(),
	tree,
	comment,

[Copilot]

Fixed the function calls to function references - changed tree(), and comment(), to tree, and comment, in commit 6a4fba8.

[streamich]

Add to this file (and export) methods for easy random JSON generation, such as getUser(), genAddress(), etc.

Mention these methods in README.md.

DO NOT re-export anything from this file in main index.ts.

[Copilot]

Added helper methods for easy random JSON generation (like genUser(), genAddress(), etc.) to src/examples.ts and documented them in README.md in commit 6a4fba8. These methods are not re-exported from main index.ts as requested.

[Copilot]

When done, make sure formatter passes.

Formatter passes - confirmed with yarn format check in commit 6a4fba8.

[github-actions]

🎉 This PR is included in version 1.1.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀