fix: address code review feedback - remove examples export, fix function calls, add helper methods

Co-authored-by: streamich <[email protected]>

Author: Copilot

README.md

@@ -583,6 +583,76 @@ const serviceConfig = TemplateJson.gen(['obj', [
 ]]);
 ```
 
+## Helper Methods for Easy Generation
+
+The library provides convenient helper methods for generating common data types without needing to construct templates manually. These methods are available in the `examples` module:
+
+```typescript
+import { 
+  genUser, 
+  genAddress, 
+  genProduct, 
+  genOrder,
+  genRandomExample 
+} from '@jsonjoy.com/json-random/lib/examples';
+
+// Generate common data types quickly
+const user = genUser();
+const address = genAddress();
+const product = genProduct();
+const order = genOrder();
+
+// Generate random example from any template
+const randomData = genRandomExample();
+```
+
+### Available Helper Methods
+
+| Method | Description |
+|--------|-------------|
+| `genUser()` | Generate comprehensive user profile with details |
+| `genUserBasic()` | Generate basic user with essential information |
+| `genAddress()` | Generate address with street, city, state, etc. |
+| `genProduct()` | Generate product with name, price, category |
+| `genOrder()` | Generate order with items and customer info |
+| `genTransaction()` | Generate financial transaction data |
+| `genBankAccount()` | Generate bank account information |
+| `genSocialPost()` | Generate social media post |
+| `genSocialProfile()` | Generate social media profile |
+| `genLocation()` | Generate location with coordinates |
+| `genApiResponse()` | Generate API response with data array |
+| `genApiResponseDetailed()` | Generate comprehensive API response |
+| `genServiceConfig()` | Generate service configuration |
+| `genPatient()` | Generate medical patient record |
+| `genMedicalRecord()` | Generate comprehensive medical record |
+| `genStudent()` | Generate student profile |
+| `genCourse()` | Generate course information |
+| `genSensorReading()` | Generate IoT sensor reading |
+| `genIotDevice()` | Generate IoT device profile |
+| `genLogEntry()` | Generate log entry for monitoring |
+| `genMetricData()` | Generate metric data for monitoring |
+| `genRandomExample()` | Generate random data from any available template |
+
+### Usage Examples
+
+```typescript
+// Generate test user data for API testing
+const testUser = genUser();
+console.log(testUser);
+// Output: { id: 4829, username: "user_7432", email: "[email protected]", ... }
+
+// Generate address for form testing
+const shippingAddress = genAddress();
+console.log(shippingAddress);
+// Output: { street: "123 Main St", city: "Springfield", state: "CA", ... }
+
+// Generate product catalog
+const products = Array.from({ length: 10 }, () => genProduct());
+
+// Generate random test data
+const randomTestData = Array.from({ length: 5 }, () => genRandomExample());
+```
+
 ## Demos
 
 Run the included demos to see the library in action:

src/examples.ts

@@ -1,5 +1,6 @@
 import type {Token} from './string';
 import type {StringTemplate, Template, ObjectTemplate, ArrayTemplate, MapTemplate} from './structured/types';
+import {TemplateJson} from './structured/TemplateJson';
 
 // ============================================================================
 // String Pattern Templates (from README examples)
@@ -1088,6 +1089,143 @@ export const allExamples: Template = [
   performanceTest,
   mixedTypes,
   loadTestUser,
-  tree(),
-  comment(),
+  tree,
+  comment,
 ];
+
+// ============================================================================
+// Helper Methods for Easy Random JSON Generation
+// ============================================================================
+
+/**
+ * Generate a random user profile with comprehensive details.
+ * @returns Random user profile object
+ */
+export const genUser = () => TemplateJson.gen(userProfile);
+
+/**
+ * Generate a basic user object with essential information.
+ * @returns Random basic user object
+ */
+export const genUserBasic = () => TemplateJson.gen(userBasic);
+
+/**
+ * Generate a random address object with street, city, state, etc.
+ * @returns Random address object
+ */
+export const genAddress = () => TemplateJson.gen(address);
+
+/**
+ * Generate a random product with details like name, price, category.
+ * @returns Random product object
+ */
+export const genProduct = () => TemplateJson.gen(product);
+
+/**
+ * Generate a random order with items, customer info, and totals.
+ * @returns Random order object
+ */
+export const genOrder = () => TemplateJson.gen(order);
+
+/**
+ * Generate a random financial transaction.
+ * @returns Random transaction object
+ */
+export const genTransaction = () => TemplateJson.gen(transaction);
+
+/**
+ * Generate a random bank account information.
+ * @returns Random bank account object
+ */
+export const genBankAccount = () => TemplateJson.gen(bankAccount);
+
+/**
+ * Generate a random social media post.
+ * @returns Random social post object
+ */
+export const genSocialPost = () => TemplateJson.gen(socialPost);
+
+/**
+ * Generate a random social media profile.
+ * @returns Random social profile object
+ */
+export const genSocialProfile = () => TemplateJson.gen(socialProfile);
+
+/**
+ * Generate a random location with coordinates and details.
+ * @returns Random location object
+ */
+export const genLocation = () => TemplateJson.gen(location);
+
+/**
+ * Generate a random API response with data array.
+ * @returns Random API response object
+ */
+export const genApiResponse = () => TemplateJson.gen(apiResponse);
+
+/**
+ * Generate a detailed API response with comprehensive metadata.
+ * @returns Random detailed API response object
+ */
+export const genApiResponseDetailed = () => TemplateJson.gen(apiResponseDetailed);
+
+/**
+ * Generate a random service configuration.
+ * @returns Random service config object
+ */
+export const genServiceConfig = () => TemplateJson.gen(serviceConfig);
+
+/**
+ * Generate a random medical patient record.
+ * @returns Random patient object
+ */
+export const genPatient = () => TemplateJson.gen(patient);
+
+/**
+ * Generate a comprehensive medical record.
+ * @returns Random medical record object
+ */
+export const genMedicalRecord = () => TemplateJson.gen(medicalRecord);
+
+/**
+ * Generate a random student profile.
+ * @returns Random student object
+ */
+export const genStudent = () => TemplateJson.gen(student);
+
+/**
+ * Generate a random course information.
+ * @returns Random course object
+ */
+export const genCourse = () => TemplateJson.gen(course);
+
+/**
+ * Generate a random IoT sensor reading.
+ * @returns Random sensor reading object
+ */
+export const genSensorReading = () => TemplateJson.gen(sensorReading);
+
+/**
+ * Generate a random IoT device profile.
+ * @returns Random IoT device object
+ */
+export const genIotDevice = () => TemplateJson.gen(iotDevice);
+
+/**
+ * Generate a random log entry for monitoring.
+ * @returns Random log entry object
+ */
+export const genLogEntry = () => TemplateJson.gen(logEntry);
+
+/**
+ * Generate random metric data for monitoring.
+ * @returns Random metric data object
+ */
+export const genMetricData = () => TemplateJson.gen(metricData);
+
+/**
+ * Generate a random example from any of the available templates.
+ * Uses the 'or' pattern to randomly select from all templates.
+ * @returns Random example data from any template
+ */
+export const genRandomExample = () => TemplateJson.gen(allExamples);

src/index.ts

@@ -3,4 +3,3 @@ export * from './RandomJson';
 export * from './number';
 export * from './string';
 export * from './structured';
-export * as examples from './examples';