fake-data-npm 1.0.2 → 1.0.4

package/.github/workflows/publish.yml

@@ -4,6 +4,7 @@ on:
   push:
     branches:
       - master
+      - main
     tags:
       - 'v*.*.*'
 
@@ -26,11 +27,18 @@ jobs:
       - name: Build
         run: npm run build
 
+      - name: Run tests
+        run: npm test
+
       - name: Publish to npm
-        if: github.ref_type == 'tag' || github.ref == 'refs/heads/master'
+        if: github.ref_type == 'tag' || github.ref == 'refs/heads/master' || github.ref == 'refs/heads/main'
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
         run: |
-          # publish to the public registry and github package (if needed)
+          # publish to the public registry
           npm publish
-          npm publish --registry=https://npm.pkg.github.com/fox3000foxy
+          # conditionally publish to GitHub Packages (requires scoped name)
+          name=$(node -p "require('./package.json').name")
+          if [[ "$name" == @* ]]; then
+            npm publish --registry=https://npm.pkg.github.com/${{ github.repository_owner }}
+          fi

package/README.md

@@ -34,7 +34,7 @@ npm run clean     # remove build output
 import { generateFakeProfile } from 'fake-data-npm';
 
 const profile = generateFakeProfile({ countryName: 'France', birthGender: 'female' });
-console.log(profile); // JSON string
+console.log(profile); // Profile object with typed fields
 
 // other helpers:
 import {
@@ -47,7 +47,7 @@ import {
 console.log(generatePhoneNumber('+33')); // +33xxxxxxxxx
 ```
 
-You can also generate batches and export CSV:
+You can also generate batches (now typed as `Profile[]`) and export CSV:
 
 ```ts
 import { generateAndComposeCSV } from 'fake-data-npm';
@@ -60,23 +60,58 @@ console.log(csv.split('\n').length);
 | Function | Description |
 |----------|-------------|
 | `randomItem(arr)` | Return random element from array |
+| `shuffleArray(arr)` | In-place Fisher–Yates shuffle |
+| `randomUUID()` | RFC‑4122 v4 UUID string |
+| `generatePassword(len?)` | Simple alphanumeric password |
 | `generatePhoneNumber(countryCode)` | Fake phone number |
-| `generateSocialHandleVariant(name,surname,pseudo,media)` | Variant 
+| `generateSocialHandleVariant(name,surname,pseudo,media)` | Variant |
 | `generateRandomDigits(length)` | String of digits |
 | `buildCredibleEmailAddress(first,last,country)` | Email generator |
 | `generateCreditCard()` | Fake CC data |
 | `getRandomUsername()` | Get from internal list |
 | `generateRandomDate()` | Random adult birthdate |
+| `randomDateBetween(start,end)` | Date between two bounds |
 | `getAge(date)` | Age from birthdate |
 | `getContinent(code)` | Continent from country code |
 | `generatePreferences(categories,gender)` | Ad preference map |
-| `generateFakeProfile(params)` | Full profile JSON string |
+| `generateFakeProfile(params)` | Full profile **object** (see `Profile` type) |
 | `generateFakeProfilesBatch(batchSize,params)` | Array of profiles |
-| `generateAndComposeCSV(total,batch,params)` | CSV string of profiles |
 | `composeCSVFile(data)` | Convert profiles to CSV |
+| `generateAndComposeCSV(total,batch,params)` | CSV string of profiles |
 | `writeCSVFile(fname,content)` | Write CSV to disk |
 
-Refer to inline JSDoc and generated `.d.ts` for detailed types.
+Refer to inline JSDoc and generated `.d.ts` for detailed types.  The
+package exports several interfaces (`Profile`, `Location`, `Passwords`, etc.)
+for easier TypeScript consumption.
+
+---
+
+## Continuous integration
+
+A GitHub Actions workflow (`.github/workflows/publish.yml`) builds the project
+and publishes to npm when commits are pushed to `main`/`master` or a new
+`vX.Y.Z` tag is created.  A repository secret named `NPM_TOKEN` is required to
+authenticate with npm.
+
+> **npm warning**
+> When the action runs, npm may auto‑correct issues in `package.json` (for
+> example normalising `repository.url` to `git+…`). Run `npm pkg fix` locally
+> or update the field manually to avoid the warnings.
+
+GitHub Packages publishing is conditional on the package being scoped (e.g.
+`@owner/name`); unscoped names are not allowed and will raise a 405 error.
+
+## Testing
+
+A simple Jest setup lives under `tests/`. To run the tests:
+
+```bash
+npm install   # if dependencies changed
+npm test
+```
+
+This ensures future enhancements remain stable and provides examples of
+utility usage.
 
 ## License