@lunora/seed 0.0.0 → 1.0.0-alpha.1

package/LICENSE.md

@@ -0,0 +1,105 @@
+# Functional Source License, Version 1.1, Apache 2.0 Future License
+
+## Abbreviation
+
+FSL-1.1-Apache-2.0
+
+## Notice
+
+Copyright 2026 anolilab and contributors
+
+## Terms and Conditions
+
+### Licensor ("We")
+
+The party offering the Software under these Terms and Conditions.
+
+### The Software
+
+The "Software" is each version of the software that we make available under
+these Terms and Conditions, as indicated by our inclusion of these Terms and
+Conditions with the Software.
+
+### License Grant
+
+Subject to your compliance with this License Grant and the Patents,
+Redistribution and Trademark clauses below, we hereby grant you the right to
+use, copy, modify, create derivative works, publicly perform, publicly display
+and redistribute the Software for any Permitted Purpose identified below.
+
+### Permitted Purpose
+
+A Permitted Purpose is any purpose other than a Competing Use. A Competing Use
+means making the Software available to others in a commercial product or service
+that:
+
+1. substitutes for the Software;
+
+2. substitutes for any other product or service we offer using the Software that
+   exists as of the date we make the Software available; or
+
+3. offers the same or substantially similar functionality as the Software.
+
+Permitted Purposes specifically include using the Software:
+
+1. for your internal use and access;
+
+2. for non-commercial education;
+
+3. for non-commercial research; and
+
+4. in connection with professional services that you provide to a licensee using
+   the Software in accordance with these Terms and Conditions.
+
+### Patents
+
+To the extent your use for a Permitted Purpose would necessarily infringe our
+patents, the license grant above includes a license under our patents. If you
+make a claim against any party that the Software infringes or contributes to the
+infringement of any patent, then your patent license to the Software ends
+immediately.
+
+### Redistribution
+
+The Terms and Conditions apply to all copies, modifications and derivatives of
+the Software.
+
+If you redistribute any copies, modifications or derivatives of the Software,
+you must include a copy of or a link to these Terms and Conditions and not
+remove any copyright notices provided in or with the Software.
+
+### Disclaimer
+
+THE SOFTWARE IS PROVIDED "AS IS" AND WITHOUT WARRANTIES OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING WITHOUT LIMITATION WARRANTIES OF FITNESS FOR A PARTICULAR
+PURPOSE, MERCHANTABILITY, TITLE OR NON-INFRINGEMENT.
+
+IN NO EVENT WILL WE HAVE ANY LIABILITY TO YOU ARISING OUT OF OR RELATED TO THE
+SOFTWARE, INCLUDING INDIRECT, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES, EVEN
+IF WE HAVE BEEN INFORMED OF THEIR POSSIBILITY IN ADVANCE.
+
+### Trademarks
+
+Except for displaying the License Details and identifying us as the origin of
+the Software, you have no right under these Terms and Conditions to use our
+trademarks, trade names, service marks or product names.
+
+## Grant of Future License
+
+We hereby irrevocably grant you an additional license to use the Software under
+the Apache License, Version 2.0 that is effective on the second anniversary of
+the date we make the Software available. On or after that date, you may use the
+Software under the Apache License, Version 2.0, in which case the following will
+apply:
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use
+this file except in compliance with the License.
+
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed
+under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+CONDITIONS OF ANY KIND, either express or implied. See the License for the
+specific language governing permissions and limitations under the License.

package/README.md

@@ -1,18 +1,179 @@
-# @lunora/seed
+<!-- START_PACKAGE_OG_IMAGE_PLACEHOLDER -->
 
-> ⚠️ **Placeholder release.** This package name is reserved for the [Lunora](https://lunora.sh) framework. The real `1.0.0-alpha` release is coming soon.
+<a href="https://www.anolilab.com/open-source" align="center">
 
-Schema-driven, deterministic database seeding for Lunora: realistic fake data from defineSchema
+  <img src="__assets__/package-og.svg" alt="seed" />
 
-Lunora is a type-safe, real-time backend framework for Cloudflare Workers + Durable Objects with a Vite-first developer experience.
+</a>
 
-- Website: https://lunora.sh
-- Repository: https://github.com/anolilab/lunora
+<h3 align="center">Schema-driven, deterministic database seeding for Lunora: realistic fake data from defineSchema</h3>
 
-## Status
+<!-- END_PACKAGE_OG_IMAGE_PLACEHOLDER -->
 
-This is a `0.0.0` placeholder to reserve the npm name. Do not depend on it yet — APIs and exports are not published in this version. Watch the repository for the alpha release.
+<br />
+
+<div align="center">
+
+[![typescript-image][typescript-badge]][typescript-url]
+[![FSL-1.1-Apache-2.0 licence][license-badge]][license]
+[![npm version][npm-version-badge]][npm-version]
+[![npm downloads][npm-downloads-badge]][npm-downloads]
+[![PRs Welcome][prs-welcome-badge]][prs-welcome]
+
+</div>
+
+---
+
+<div align="center">
+    <p>
+        <sup>
+            Daniel Bannert's open source work is supported by the community on <a href="https://github.com/sponsors/prisis">GitHub Sponsors</a>
+        </sup>
+    </p>
+</div>
+
+---
+
+`@lunora/seed` populates a Lunora database with realistic, production-like fake data derived from your `defineSchema`. It introspects every table, maps each field to a generator (field-name aware — a `string` column called `email` becomes an email address, `firstName` a first name, and so on), resolves foreign keys by inserting parent tables before their children, and lets you override any value.
+
+Generation is **deterministic**: it is built on a vendored, input-hashed generator (a rebuilt [`copycat`](https://github.com/supabase-community/copycat)) layered over [`@faker-js/faker`](https://fakerjs.dev). The same `seed` value and schema always produce the same rows, so fixtures are reproducible across runs and machines.
+
+Part of the [Lunora](https://github.com/anolilab/lunora) framework — a type-safe, real-time backend on Cloudflare Workers + Durable Objects with a Vite-first DX.
+
+## Install
+
+```sh
+npm install @lunora/seed
+```
+
+```sh
+yarn add @lunora/seed
+```
+
+```sh
+pnpm add @lunora/seed
+```
+
+## Usage
+
+### Generate a plan
+
+```ts
+import { seedPlan } from "@lunora/seed";
+import schema from "./lunora/schema";
+
+const plan = seedPlan(schema, {
+    counts: { users: 10, posts: 30 },
+    seed: 1,
+    overrides: {
+        users: { email: (ctx) => `user${ctx.index}@example.com` },
+    },
+});
+
+// plan === [{ table: "users", rows: [...] }, { table: "posts", rows: [...] }]
+// (parents before children; every post.authorId points at a generated user)
+```
+
+### Seed an in-memory test harness
+
+```ts
+import { lunoraTest } from "@lunora/testing";
+import { seed } from "@lunora/seed/testing";
+import schema from "./lunora/schema";
+
+const harness = lunoraTest(schema);
+const ids = await seed(harness, schema, { counts: { users: 5, posts: 20 } });
+// ids.users / ids.posts — the inserted document ids, for assertions
+```
+
+### Typed client
+
+For a Snaplet-style, one-table-at-a-time DX, `createSeedClient` exposes each table as a method. Foreign keys connect to whatever was seeded earlier in the run, FK parents are pulled in automatically, and state accumulates on `$store`/`$ids` (clear it with `$reset()`):
+
+```ts
+import { createSeedClient } from "@lunora/seed";
+import schema from "./lunora/schema";
+
+const seed = createSeedClient(schema, { seed: 1 });
+
+const { users } = await seed.users(5);
+const { posts } = await seed.posts((x) => x([10, 20])); // a deterministic count in [10, 20]
+
+// Explicit partial rows — omitted columns are still generated:
+await seed.users([{ name: "Alice" }, { email: "bob@example.com", name: "Bob" }]);
+
+seed.$ids.users; // every user id generated this run
+```
+
+Pass your generated `InsertModel` type — `createSeedClient<InsertModel>(schema)` — for autocomplete on each table's columns. Or skip the wiring: when `@lunora/seed` is a declared dependency, codegen emits `_generated/seed.ts` with the schema and `InsertModel` already bound.
+
+```ts
+import { createSeedClient } from "@/lunora/_generated/seed";
+
+const seed = createSeedClient({ seed: 1 });
+const { users } = await seed.users(5); // columns typed from InsertModel
+```
+
+Supply a `persist` hook (`SeedClientOptions.persist`) to write each batch as it is generated (parents first); the client is pure when it is omitted. Per-call field overrides go in the second argument: `seed.posts(3, { overrides: { title: (ctx) => `Post ${ctx.index}` } })`.
+
+### Seed a running dev worker
+
+```bash
+lunora seed --count 25                  # 25 rows per table (default 10)
+lunora seed --table posts --count 100   # one table (FK parents seeded automatically)
+lunora seed --seed 42                    # reproducible run
+lunora seed --reset                      # wipe local .wrangler/state first (local dev only)
+lunora seed --dry-run                    # print NDJSON, write nothing
+```
+
+Also: `--batch-size` (rows per HTTP request, default 500), `--url` (worker URL, default `http://localhost:8787`), `--prod` (requires an explicit `--url`), `--token` / `LUNORA_ADMIN_TOKEN` (admin bearer; prefer the env var), `--yes` (skip the non-local confirmation prompt). `--reset` is local-only and cannot be combined with `--prod` or a remote `--url`.
+
+## Limitations
+
+- **`.unique()` columns are not enforced.** Each value is hashed independently, so a unique column over a small value space (a bounded integer, a boolean, a short enum) can collide across rows. Strings such as emails and uuids are effectively unique in practice. Colliding rows are rejected by the import path rather than silently overwritten.
+- **Seeding is deterministic by design.** Re-running with the same `--seed` regenerates identical `_id`s, which the import path skips as conflicts. Use a different `--seed` for fresh rows, or `--reset` to wipe local state first.
+
+> This README covers the basics. For the full API, options, and guides, see the **[documentation](https://lunora.sh/docs/packages/seed)**.
+
+## Related
+
+- [`@lunora/server`](https://www.npmjs.com/package/@lunora/server) — defines the `defineSchema` that seeding introspects.
+- [`@lunora/testing`](https://www.npmjs.com/package/@lunora/testing) — the in-memory harness `@lunora/seed/testing` seeds.
+- [`@lunora/cli`](https://www.npmjs.com/package/@lunora/cli) — ships the `lunora seed` command.
+
+## Supported Node.js Versions
+
+Libraries in this ecosystem make the best effort to track [Node.js' release schedule](https://github.com/nodejs/release#release-schedule).
+Here's [a post on why we think this is important](https://medium.com/the-node-js-collection/maintainers-should-consider-following-node-js-release-schedule-ab08ed4de71a).
+
+## Contributing
+
+If you would like to help take a look at the [list of issues](https://github.com/anolilab/lunora/issues) and check our [Contributing](https://github.com/anolilab/lunora/blob/alpha/.github/CONTRIBUTING.md) guidelines.
+
+> **Note:** please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.
+
+## Credits
+
+- [Daniel Bannert](https://github.com/prisis)
+- [All Contributors](https://github.com/anolilab/lunora/graphs/contributors)
+
+## Made with ❤️ at Anolilab
+
+This is an open source project and will always remain free to use. If you think it's cool, please star it 🌟. [Anolilab](https://www.anolilab.com/open-source) is a Development and AI Studio. Contact us at [hello@anolilab.com](mailto:hello@anolilab.com) if you need any help with these technologies or just want to say hi!
 
 ## License
 
-FSL-1.1-Apache-2.0
+The Lunora seed package is open-sourced software licensed under the [FSL-1.1-Apache-2.0][license].
+
+<!-- badges -->
+
+[license-badge]: https://img.shields.io/badge/license-FSL--1.1--Apache--2.0-blue.svg?style=for-the-badge
+[license]: https://github.com/anolilab/lunora/blob/alpha/LICENSE.md
+[npm-version-badge]: https://img.shields.io/npm/v/@lunora/seed?style=for-the-badge
+[npm-version]: https://www.npmjs.com/package/@lunora/seed
+[npm-downloads-badge]: https://img.shields.io/npm/dm/@lunora/seed?style=for-the-badge
+[npm-downloads]: https://www.npmjs.com/package/@lunora/seed
+[prs-welcome-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=for-the-badge
+[prs-welcome]: https://github.com/anolilab/lunora/blob/alpha/.github/CONTRIBUTING.md
+[typescript-badge]: https://img.shields.io/badge/Typescript-294E80.svg?style=for-the-badge&logo=typescript
+[typescript-url]: https://www.typescriptlang.org/