@drichdev/genata 1.0.1 → 1.0.4

package/README.md

@@ -15,28 +15,53 @@ A lightweight, secure, and TypeScript-first library for generating realistic fak
 ## 📦 Installation
 
 ```bash
-npm install genata
+npm install @drichdev/genata
 # or
-yarn add genata
+yarn add @drichdev/genata
 # or
-pnpm add genata
+pnpm add @drichdev/genata
 ```
 
 ## 🎯 Quick Start
 
-### Basic Usage
+### CommonJS (Node.js)
 
 ```javascript
-import genata from "genata";
+const genata = require('@drichdev/genata');
 
-// Generate single values
 const email = genata.email();
 const firstName = genata.firstName();
 const phone = genata.phone();
+```
+
+### ES Modules (Node.js with "type": "module")
+
+```javascript
+import genata from '@drichdev/genata';
 
-// Generate with options
-const password = genata.password({ length: 20 });
-const randomInt = genata.datatype.integer({ min: 1, max: 100 });
+const email = genata.email();
+const firstName = genata.firstName();
+const phone = genata.phone();
+```
+
+### TypeScript / Next.js
+
+```typescript
+import genata from '@drichdev/genata';
+
+export default function Home() {
+  const email = genata.email();
+  const firstName = genata.firstName();
+  const phone = genata.phone();
+
+  return (
+    <div>
+      <p>Email: {email}</p>
+      <p>Name: {firstName}</p>
+      <p>Phone: {phone}</p>
+    </div>
+  );
+}
 ```
 
 ### Using Generators by Category
@@ -146,8 +171,8 @@ Location: address, city, country, zip
 Internet: url, ipv4, ipv6, credit_card
 Company: company, job_title
 Date: date, datetime
-Data Types: uuid, boolean, int, float, number, zero_one, id_increment, color
-Text: sentence, paragraph
+Data Types: uuid, boolean, int, float, number, zero_one, id_increment, color, hex
+Text: sentence, paragraph, word, slug
 ```
 
 ## 🎛️ API Reference
@@ -299,6 +324,42 @@ For very large batches (>100K records), consider:
 - Using `generateBatchWithProgress` to show progress
 - Running in a worker thread if in browser
 
+## 📚 Complete Documentation
+
+For detailed examples and advanced usage, see [USAGE.md](./USAGE.md)
+
+## 🔧 Import Methods
+
+### CommonJS
+```javascript
+const genata = require('@drichdev/genata');
+genata.email();
+```
+
+### ES Modules
+```javascript
+import genata from '@drichdev/genata';
+genata.email();
+```
+
+### TypeScript
+```typescript
+import genata, { type FieldDefinition } from '@drichdev/genata';
+```
+
+### Next.js / React
+```typescript
+import genata from '@drichdev/genata';
+
+export default function Component() {
+  const data = genata.email();
+  return <div>{data}</div>;
+}
+```
+
+**⚠️ Note**: If you get a "Module type is not specified" warning, add `"type": "module"` to your `package.json` or use CommonJS require instead.
+
 ---
 
 Made with ❤️ by Drichdev
+

package/dist/generators/field.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"field.d.ts","sourceRoot":"","sources":["../../src/generators/field.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,EAAE,SAAS,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAW5D,UAAU,sBAAuB,SAAQ,gBAAgB;IACvD,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,wBAAgB,aAAa,CAC3B,IAAI,EAAE,SAAS,EACf,OAAO,CAAC,EAAE,sBAAsB,GAC/B,OAAO,CA8ET"}
+{"version":3,"file":"field.d.ts","sourceRoot":"","sources":["../../src/generators/field.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,EAAE,SAAS,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAW5D,UAAU,sBAAuB,SAAQ,gBAAgB;IACvD,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,wBAAgB,aAAa,CAC3B,IAAI,EAAE,SAAS,EACf,OAAO,CAAC,EAAE,sBAAsB,GAC/B,OAAO,CAoFT"}

package/dist/generators/field.js

@@ -70,8 +70,14 @@ function generateField(type, options) {
             return base_1.TextGenerators.paragraph(options);
         case "sentence":
             return base_1.TextGenerators.sentence(options);
+        case "word":
+            return base_1.TextGenerators.word(options);
+        case "slug":
+            return base_1.TextGenerators.slug(options);
         case "color":
             return base_1.DataTypeGenerators.color(options);
+        case "hex":
+            return base_1.DataTypeGenerators.hex(options);
         default:
             throw new Error(`Unknown field type: ${type}`);
     }

package/dist/index.d.ts

@@ -7,7 +7,6 @@
  * - genata.person.firstName() - generates a first name
  * - genata.generateBatch([...]) - generates multiple records
  */
-import { PersonGenerators, LocationGenerators, InternetGenerators, CompanyGenerators, DateGenerators, DataTypeGenerators, TextGenerators, generateBatch, generateBatchWithProgress } from "./generators";
 import type { FieldDefinition, BatchGeneratorOptions } from "./types";
 /**
  * Main Genata API
@@ -89,8 +88,5 @@ declare const genata: {
     resetSeed: () => void;
     setLocale: (locale: string) => void;
 };
-export default genata;
-export * from "./types";
-export * from "./validators";
-export { PersonGenerators, LocationGenerators, InternetGenerators, CompanyGenerators, DateGenerators, DataTypeGenerators, TextGenerators, generateBatch, generateBatchWithProgress, };
+export = genata;
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,EACL,gBAAgB,EAChB,kBAAkB,EAClB,kBAAkB,EAClB,iBAAiB,EACjB,cAAc,EACd,kBAAkB,EAClB,cAAc,EACd,aAAa,EACb,yBAAyB,EAC1B,MAAM,cAAc,CAAC;AACtB,OAAO,KAAK,EAAE,eAAe,EAAE,qBAAqB,EAAE,MAAM,SAAS,CAAC;AAItE;;GAEG;AACH,QAAA,MAAM,MAAM;;;;;;yBAOW;QAAE,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE;;;;;;;;;kBAOnC,CAAC;;;;;;;;;;;;;;;;;;;;;;kBA+C+3C,CAAC;;;;;;;;;eAAq+B,CAAC;eAAa,CAAC;;;eAAkW,CAAC;eAAa,CAAC;oBAAkB,CAAC;;;kBAAwhB,CAAC;;;;;;;qBAA2uB,CAAC;;;;;4BAvCz/H,eAAe,EAAE,YACf,qBAAqB;wCAIvB,eAAe,EAAE,YACf,qBAAqB,GAAG;QAAE,UAAU,CAAC,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,IAAI,CAAA;KAAE;oBAI/D,MAAM;;wBASF,MAAM;CAI3B,CAAC;AAEF,eAAe,MAAM,CAAC;AACtB,cAAc,SAAS,CAAC;AACxB,cAAc,cAAc,CAAC;AAC7B,OAAO,EACL,gBAAgB,EAChB,kBAAkB,EAClB,kBAAkB,EAClB,iBAAiB,EACjB,cAAc,EACd,kBAAkB,EAClB,cAAc,EACd,aAAa,EACb,yBAAyB,GAC1B,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAaH,OAAO,KAAK,EAAE,eAAe,EAAE,qBAAqB,EAAE,MAAM,SAAS,CAAC;AAItE;;GAEG;AACH,QAAA,MAAM,MAAM;;;;;;yBAOW;QAAE,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE;;;;;;;;;kBAOnC,CAAC;;;;;;;;;;;;;;;;;;;;;;kBAkCqoD,CAAC;;;;;;;;;eAAq+B,CAAC;eAAa,CAAC;;;eAAkW,CAAC;eAAa,CAAC;oBAAkB,CAAC;;;kBAAwhB,CAAC;;;;;;;qBAA2uB,CAAC;;;;;4BA1B/vI,eAAe,EAAE,YACf,qBAAqB;wCAIvB,eAAe,EAAE,YACf,qBAAqB,GAAG;QAAE,UAAU,CAAC,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,IAAI,CAAA;KAAE;oBAI/D,MAAM;;wBASF,MAAM;CAI3B,CAAC;AAEF,SAAS,MAAM,CAAC"}

package/dist/index.js

@@ -8,32 +8,7 @@
  * - genata.person.firstName() - generates a first name
  * - genata.generateBatch([...]) - generates multiple records
  */
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateBatchWithProgress = exports.generateBatch = exports.TextGenerators = exports.DataTypeGenerators = exports.DateGenerators = exports.CompanyGenerators = exports.InternetGenerators = exports.LocationGenerators = exports.PersonGenerators = void 0;
 const generators_1 = require("./generators");
-Object.defineProperty(exports, "PersonGenerators", { enumerable: true, get: function () { return generators_1.PersonGenerators; } });
-Object.defineProperty(exports, "LocationGenerators", { enumerable: true, get: function () { return generators_1.LocationGenerators; } });
-Object.defineProperty(exports, "InternetGenerators", { enumerable: true, get: function () { return generators_1.InternetGenerators; } });
-Object.defineProperty(exports, "CompanyGenerators", { enumerable: true, get: function () { return generators_1.CompanyGenerators; } });
-Object.defineProperty(exports, "DateGenerators", { enumerable: true, get: function () { return generators_1.DateGenerators; } });
-Object.defineProperty(exports, "DataTypeGenerators", { enumerable: true, get: function () { return generators_1.DataTypeGenerators; } });
-Object.defineProperty(exports, "TextGenerators", { enumerable: true, get: function () { return generators_1.TextGenerators; } });
-Object.defineProperty(exports, "generateBatch", { enumerable: true, get: function () { return generators_1.generateBatch; } });
-Object.defineProperty(exports, "generateBatchWithProgress", { enumerable: true, get: function () { return generators_1.generateBatchWithProgress; } });
 const faker_1 = require("./utils/faker");
 const validators_1 = require("./validators");
 /**
@@ -72,6 +47,4 @@ const genata = {
         (0, faker_1.initializeFaker)({ locale });
     },
 };
-exports.default = genata;
-__exportStar(require("./types"), exports);
-__exportStar(require("./validators"), exports);
+module.exports = genata;

package/dist/types/index.d.ts

@@ -1,7 +1,7 @@
 /**
  * Types and interfaces for Genata data generation
  */
-export type FieldType = "first_name" | "last_name" | "full_name" | "email" | "password" | "phone" | "address" | "city" | "country" | "zip" | "date" | "datetime" | "int" | "float" | "uuid" | "boolean" | "id_increment" | "number" | "zero_one" | "company" | "job_title" | "username" | "url" | "credit_card" | "ipv4" | "ipv6" | "color" | "paragraph" | "sentence";
+export type FieldType = "first_name" | "last_name" | "full_name" | "email" | "password" | "phone" | "address" | "city" | "country" | "zip" | "date" | "datetime" | "int" | "float" | "uuid" | "boolean" | "id_increment" | "number" | "zero_one" | "company" | "job_title" | "username" | "url" | "credit_card" | "ipv4" | "ipv6" | "color" | "hex" | "paragraph" | "sentence" | "word" | "slug";
 export interface GeneratorOptions {
     seed?: number;
     locale?: string;

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,MAAM,MAAM,SAAS,GACjB,YAAY,GACZ,WAAW,GACX,WAAW,GACX,OAAO,GACP,UAAU,GACV,OAAO,GACP,SAAS,GACT,MAAM,GACN,SAAS,GACT,KAAK,GACL,MAAM,GACN,UAAU,GACV,KAAK,GACL,OAAO,GACP,MAAM,GACN,SAAS,GACT,cAAc,GACd,QAAQ,GACR,UAAU,GACV,SAAS,GACT,WAAW,GACX,UAAU,GACV,KAAK,GACL,aAAa,GACb,MAAM,GACN,MAAM,GACN,OAAO,GACP,WAAW,GACX,UAAU,CAAC;AAEf,MAAM,WAAW,gBAAgB;IAC/B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,SAAS,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACnC;AAED,MAAM,WAAW,qBAAsB,SAAQ,gBAAgB;IAC7D,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,eAAe;IAC9B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,mBAAmB,CAAC,EAAE,OAAO,CAAC;CAC/B"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,MAAM,MAAM,SAAS,GACjB,YAAY,GACZ,WAAW,GACX,WAAW,GACX,OAAO,GACP,UAAU,GACV,OAAO,GACP,SAAS,GACT,MAAM,GACN,SAAS,GACT,KAAK,GACL,MAAM,GACN,UAAU,GACV,KAAK,GACL,OAAO,GACP,MAAM,GACN,SAAS,GACT,cAAc,GACd,QAAQ,GACR,UAAU,GACV,SAAS,GACT,WAAW,GACX,UAAU,GACV,KAAK,GACL,aAAa,GACb,MAAM,GACN,MAAM,GACN,OAAO,GACP,KAAK,GACL,WAAW,GACX,UAAU,GACV,MAAM,GACN,MAAM,CAAC;AAEX,MAAM,WAAW,gBAAgB;IAC/B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,SAAS,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACnC;AAED,MAAM,WAAW,qBAAsB,SAAQ,gBAAgB;IAC7D,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,eAAe;IAC9B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,mBAAmB,CAAC,EAAE,OAAO,CAAC;CAC/B"}

package/dist/validators/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/validators/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,EAAE,SAAS,EAAE,gBAAgB,EAAE,qBAAqB,EAAE,MAAM,UAAU,CAAC;AAEnF,qBAAa,eAAgB,SAAQ,KAAK;gBAC5B,OAAO,EAAE,MAAM;CAI5B;AAED,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI,CAI3D;AAED,wBAAgB,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI,CAI7D;AAED,wBAAgB,cAAc,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI,CAI/D;AAED,wBAAgB,wBAAwB,CAAC,OAAO,EAAE,gBAAgB,GAAG,IAAI,CAGxE;AAED,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,qBAAqB,GAAG,IAAI,CAGzE;AAED,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,OAAO,GAAG,IAAI,IAAI,SAAS,CAkCjE;AAED,wBAAgB,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAGnD;AAED,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,IAAI,SAAS,CAI1E"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/validators/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,EAAE,SAAS,EAAE,gBAAgB,EAAE,qBAAqB,EAAE,MAAM,UAAU,CAAC;AAEnF,qBAAa,eAAgB,SAAQ,KAAK;gBAC5B,OAAO,EAAE,MAAM;CAI5B;AAED,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI,CAI3D;AAED,wBAAgB,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI,CAI7D;AAED,wBAAgB,cAAc,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI,CAI/D;AAED,wBAAgB,wBAAwB,CAAC,OAAO,EAAE,gBAAgB,GAAG,IAAI,CAGxE;AAED,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,qBAAqB,GAAG,IAAI,CAGzE;AAED,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,OAAO,GAAG,IAAI,IAAI,SAAS,CAqCjE;AAED,wBAAgB,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAGnD;AAED,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,IAAI,SAAS,CAI1E"}

package/dist/validators/index.js

@@ -71,8 +71,11 @@ function isValidFieldType(type) {
         "ipv4",
         "ipv6",
         "color",
+        "hex",
         "paragraph",
         "sentence",
+        "word",
+        "slug",
     ];
     return typeof type === "string" && validTypes.includes(type);
 }

package/package.json

@@ -1,10 +1,9 @@
 {
   "name": "@drichdev/genata",
-  "version": "1.0.1",
+  "version": "1.0.4",
   "description": "Generate realistic fake data easily",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
-  "module": "dist/index.esm.js",
   "files": [
     "dist"
   ],
@@ -22,7 +21,7 @@
     "testing",
     "data-generator"
   ],
-  "author": "Genata",
+  "author": "Drichdev",
   "license": "MIT",
   "dependencies": {
     "@faker-js/faker": "^10.0.0"