realitydb 2.0.1 → 2.0.14

package/README.md

@@ -1,140 +1,25 @@
-# RealityDB
-
-> Production-like data before production exists.
-
-RealityDB populates your PostgreSQL database with realistic, schema-aware data. Point it at your schema, pick a domain template, and get thousands of rows that look like they came from a real application. Deterministic seeds mean the same command always produces the same data.
-
-## Quick Start
-
-```bash
-npm install -g realitydb
-
-realitydb scan                                    # Inspect your schema
-realitydb seed --template saas --seed 42          # Populate with realistic data
-realitydb reset --confirm                         # Clear and start fresh
-```
-
-## Domain Templates
-
-| Template | Description | Tables |
-|----------|-------------|--------|
-| `saas` | Subscription business | users, plans, subscriptions, payments |
-| `ecommerce` | Online store | customers, products, orders, order_items |
-| `education` | School system | teachers, classes, students, enrollments, grades, attendance |
-| `fintech` | Financial services | accounts, transactions, fraud_alerts, settlements, chargebacks |
-| `healthcare` | Medical system | patients, providers, encounters, diagnoses, billing |
-
-```bash
-realitydb seed --template fintech --records 200 --seed 42
-```
-
-Each template includes weighted distributions matching real-world data.
-
-## Key Features
-
-```bash
-# Timeline generation -- data spanning months
-realitydb seed --template saas --timeline 12-months --seed 42
-
-# Scenario injection -- controlled anomalies
-realitydb seed --template saas --scenario payment-failures --scenario-intensity high
-
-# Environment reproduction -- capture and share
-realitydb capture --name bug-4821
-realitydb load bug-4821.realitydb-pack.json --confirm
-
-# CI mode -- JSON output, proper exit codes
-npx realitydb seed --ci --template saas --records 500 --seed 42
-```
-
-## Data Science Mode
-
-Generate large-scale datasets for ML training, analytics testing, and data pipelines — no database required.
-
-```bash
-# Generate 1M rows with default demo schema
-realitydb generate --records 1000000 --format csv
-
-# Generate from your SQL schema
-realitydb generate --schema schema.sql --records 100000 --format parquet
-
-# Generate from JSON schema with distribution controls
-realitydb generate --schema custom.json --records 500000 --correlations --seed 42
-```
-
-### Statistical Distributions
-
-Define per-column distributions in your JSON schema:
-
-```json
-{
-  "tables": [{
-    "name": "users",
-    "columns": [
-      { "name": "age", "type": "integer", "distribution": { "type": "normal", "mean": 35, "stddev": 12, "min": 18, "max": 85 } },
-      { "name": "income", "type": "numeric", "distribution": { "type": "log-normal", "mu": 10.5, "sigma": 0.8, "min": 15000, "max": 500000 } },
-      { "name": "login_count", "type": "integer", "distribution": { "type": "zipf", "exponent": 1.2, "min": 1, "max": 1000 } }
-    ]
-  }],
-  "correlations": [
-    { "source": "age", "target": "income", "coefficient": 0.6 }
-  ]
-}
-```
-
-Supported distributions: `normal`, `uniform`, `zipf`, `exponential`, `log-normal`.
-
-### Output Formats
-
-| Format | Flag | Description |
-|--------|------|-------------|
-| JSON | `--format json` | NDJSON (newline-delimited JSON), one object per line |
-| CSV | `--format csv` | Standard CSV with headers |
-| Parquet | `--format parquet` | NDJSON with `.parquet.ndjson` extension (convert via DuckDB/pyarrow) |
-
-## Commands
-
-| Command | Description |
-|---------|-------------|
-| `realitydb scan` | Inspect database schema |
-| `realitydb seed` | Generate and insert realistic data |
-| `realitydb reset` | Clear seeded data |
-| `realitydb export` | Export data to JSON/CSV/SQL files |
-| `realitydb generate` | Generate large-scale datasets (no DB required) |
-| `realitydb capture` | Snapshot live database into a Reality Pack |
-| `realitydb load` | Load a Reality Pack into the database |
-| `realitydb share` | Display Reality Pack info for sharing |
-| `realitydb pack export` | Generate and export as Reality Pack |
-| `realitydb pack import` | Import a Reality Pack |
-| `realitydb templates` | List available domain templates |
-| `realitydb scenarios` | List available scenarios |
-
-## Configuration
-
-Create `realitydb.config.json`:
-
-```json
-{
-  "database": {
-    "client": "postgres",
-    "connectionString": "postgres://user:pass@localhost:5432/mydb"
-  },
-  "seed": {
-    "defaultRecords": 1000,
-    "batchSize": 1000,
-    "randomSeed": 42
-  },
-  "template": "saas"
-}
-```
-
-## Requirements
-
-- Node.js 20+
-- PostgreSQL
-
-Full documentation: [github.com/emkwambe/databox](https://github.com/emkwambe/databox)
-
-## License
-
-MIT
+# DEPRECATED
+
+This package has been replaced by **[@realitydb/cli](https://www.npmjs.com/package/@realitydb/cli)**.
+
+## Install the new package
+```bash
+npm install -g @realitydb/cli
+```
+
+## What is RealityDB?
+
+RealityDB generates causally-correct synthetic data with:
+- FK integrity (zero orphans at 2M+ rows)
+- Lifecycle rules (cancelled orders have NULL shipped_at)
+- Temporal ordering (shipped_at always after created_at)
+- Weighted distributions (production-realistic, not uniform random)
+- Seed control (--seed 42 for reproducible data)
+- Direct database seeding (PostgreSQL, MySQL)
+
+## Links
+- **CLI**: [@realitydb/cli on npm](https://www.npmjs.com/package/@realitydb/cli)
+- **Sandbox**: [sandbox.realitydb.dev](https://sandbox.realitydb.dev)
+- **GitHub**: [github.com/emkwambe/databox](https://github.com/emkwambe/databox)
+
+Licensed under BSL-1.1. Copyright (c) 2026 Mpingo Systems LLC.

package/bin.js

@@ -0,0 +1,13 @@
+#!/usr/bin/env node
+console.error(`
+========================================================
+  DEPRECATED - realitydb is now @realitydb/cli
+
+  Install the new package:
+    npm install -g @realitydb/cli
+
+  All future updates are published to @realitydb/cli
+  https://www.npmjs.com/package/@realitydb/cli
+========================================================
+`);
+process.exit(1);

package/package.json

@@ -1,62 +1,16 @@
-{
-  "name": "realitydb",
-  "version": "2.0.1",
-  "description": "Developer Reality Platform - realistic database environments from your schema",
-  "license": "MIT",
-  "keywords": [
-    "database",
-    "seed",
-    "testing",
-    "synthetic-data",
-    "developer-tools",
-    "postgres",
-    "fake-data",
-    "test-data",
-    "reality-engine",
-    "schema",
-    "realitydb"
-  ],
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/emkwambe/databox.git"
-  },
-  "author": "Eddy Mkwambe",
-  "homepage": "https://github.com/emkwambe/databox",
-  "bugs": {
-    "url": "https://github.com/emkwambe/databox/issues"
-  },
-  "bin": {
-    "realitydb": "./dist/index.js"
-  },
-  "files": [
-    "dist/",
-    "README.md",
-    "LICENSE"
-  ],
-  "engines": {
-    "node": ">=20.0.0"
-  },
-  "scripts": {
-    "build": "tsup",
-    "build:tsc": "tsc",
-    "clean": "rm -rf dist *.tsbuildinfo",
-    "start": "node dist/index.js",
-    "typecheck": "tsc --noEmit",
-    "prepublishOnly": "npm run build && node dist/index.js --version"
-  },
-  "devDependencies": {
-    "@databox/config": "workspace:^",
-    "@databox/core": "workspace:^",
-    "@databox/db": "workspace:^",
-    "@databox/generators": "workspace:^",
-    "@databox/schema": "workspace:^",
-    "@databox/shared": "workspace:^",
-    "@databox/templates": "workspace:^",
-    "commander": "^14.0.3",
-    "tsup": "^8.5.1",
-    "typescript": "^5.4.0"
-  },
-  "dependencies": {
-    "pg": "^8.20.0"
-  }
+{
+  "name": "realitydb",
+  "version": "2.0.14",
+  "description": "[DEPRECATED] Please use @realitydb/cli instead. RealityDB generates causally-correct synthetic data with FK integrity, lifecycle rules, and temporal ordering.",
+  "license": "BSL-1.1",
+  "deprecated": "This package has been replaced by @realitydb/cli. Run: npm install -g @realitydb/cli",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/emkwambe/databox"
+  },
+  "bin": {
+    "realitydb": "bin.js"
+  },
+  "files": ["bin.js", "README.md"],
+  "keywords": ["synthetic-data", "database", "testing", "faker", "seed", "postgresql", "mysql", "lifecycle", "FK-integrity"]
 }

package/LICENSE

@@ -1,80 +0,0 @@
-Business Source License 1.1
-
-Parameters
-
-Licensor:             Mpingo Systems Ltd (Eddy Mkwambe)
-Licensed Work:        RealityDB Sandbox
-                      The Licensed Work is (c) 2026 Mpingo Systems Ltd
-Additional Use Grant: You may make use of the Licensed Work, provided that
-                      you do not use the Licensed Work for a Synthetic Data
-                      Service, SQL Learning Service, or Database Simulation
-                      Service.
-
-                      A "Synthetic Data Service" is a commercial offering
-                      that allows third parties to access the functionality
-                      of the Licensed Work by generating synthetic database
-                      records, test data, or simulation environments.
-
-                      A "SQL Learning Service" is a commercial offering that
-                      allows third parties to practice SQL queries against
-                      auto-graded challenges using functionality substantially
-                      derived from the Licensed Work.
-
-                      A "Database Simulation Service" is a commercial offering
-                      that allows third parties to create or access simulated
-                      database environments with lifecycle-coherent data using
-                      functionality substantially derived from the Licensed Work.
-
-                      You may use the Licensed Work for internal testing,
-                      development, education, research, and any non-competing
-                      commercial purpose without restriction.
-
-Change Date:          March 31, 2030
-Change License:       Apache License, Version 2.0
-
-For information about alternative licensing arrangements for the Licensed Work,
-please contact: licensing@realitydb.dev
-
-Notice
-
-Business Source License 1.1 (the "License")
-
-The Licensor hereby grants you the right to copy, modify, create derivative
-works, redistribute, and make non-production use of the Licensed Work. The
-Licensor may make an Additional Use Grant, above, permitting limited production
-use.
-
-Effective on the Change Date, or the fourth anniversary of the first publicly
-available distribution of a specific version of the Licensed Work under this
-License, whichever comes first, the Licensor hereby grants you rights under
-the terms of the Change License, and the rights granted in the paragraph
-above terminate.
-
-If your use of the Licensed Work does not comply with the requirements
-currently in effect as described in this License, you must purchase a
-commercial license from the Licensor, its affiliated entities, or authorized
-resellers, or you must refrain from using the Licensed Work.
-
-All copies of the original and modified Licensed Work, and derivative works
-of the Licensed Work, are subject to this License. This License applies
-separately for each version of the Licensed Work and the Change Date may vary
-for each version of the Licensed Work released by Licensor.
-
-You must conspicuously display this License on each original or modified copy
-of the Licensed Work. If you receive the Licensed Work in original or
-modified form from a third party, the terms and conditions set forth in this
-License apply to your use of that work.
-
-Any use of the Licensed Work in violation of this License will automatically
-terminate your rights under this License for the current and all other
-versions of the Licensed Work.
-
-This License does not grant you any right in any trademark or logo of
-Licensor or its affiliates (provided that you may use a trademark or logo of
-Licensor as expressly required by this License).
-
-TO THE EXTENT PERMITTED BY APPLICABLE LAW, THE LICENSED WORK IS PROVIDED ON
-AN "AS IS" BASIS. LICENSOR HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
-EXPRESS OR IMPLIED, INCLUDING (WITHOUT LIMITATION) WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT, AND
-TITLE.