@postseed/core 0.0.0-stage → 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Sagar Pinninti
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,25 @@
-# Temporary Holding Version
+# @postseed/core
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+The engine behind [Postseed](https://github.com/isagarpinninti/postseed): realistic, relationship-correct, deterministic seed data for PostgreSQL. **Browser-safe**: no Node APIs, so it also runs in a Web Worker.
+
+```bash
+npm install @postseed/core
+```
+
+```ts
+import { parseDdl, generate, writeSql } from "@postseed/core";
+
+const db = parseDdl(`
+  CREATE TABLE users (id serial PRIMARY KEY, email text UNIQUE NOT NULL);
+  CREATE TABLE posts (id serial PRIMARY KEY, user_id int NOT NULL REFERENCES users(id), title text);
+`);
+
+for (const chunk of writeSql(generate(db, { seed: 42, rows: 25 }))) process.stdout.write(chunk);
+```
+
+- `parseDdl(sql)` builds the schema model; statements it cannot understand become `db.warnings` instead of errors.
+- `generate(db, options)` is a synchronous generator of events, so output streams and memory stays flat. The same schema, options and version always give the same events.
+- `writeSql`, `writeJson` and `writeCsv` turn events into text. `prepare(db, options)` plans a selection and reports what would stop it, without generating.
+- To read a live database use [`@postseed/pg`](https://www.npmjs.com/package/@postseed/pg), which produces the same model.
+
+See the [documentation](https://github.com/isagarpinninti/postseed#readme). MIT licensed.