@lunora/scheduler 0.0.0 → 1.0.0-alpha.2

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,149 @@
-# @lunora/scheduler
+<!-- 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">
 
-Scheduling for Lunora: runAfter / runAt and Cron Triggers via SchedulerDO
+  <img src="__assets__/package-og.svg" alt="scheduler" />
 
-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">Scheduling for Lunora: runAfter / runAt and Cron Triggers via SchedulerDO</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>
+
+---
+
+Scheduling for Lunora. Defer function invocations with `runAfter` / `runAt` backed by a `SchedulerDO` Durable Object alarm, and run repeating jobs via Cloudflare Cron Triggers.
+
+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/scheduler
+```
+
+```sh
+yarn add @lunora/scheduler
+```
+
+```sh
+pnpm add @lunora/scheduler
+```
+
+Most apps schedule jobs through `ctx.scheduler` inside a mutation or action —
+codegen wires that surface for you. Reach for the package exports directly when
+you build the scheduler outside a function (a standalone Worker, a test), or
+when you declare cron jobs.
+
+## Usage
+
+`ctx.scheduler` from a mutation or action — pass the function path as a string:
+
+```ts
+import { mutation, v } from "@/lunora/_generated/server";
+
+export const requestReminder = mutation.input({ userId: v.id("users") }).mutation(async ({ ctx, args: { userId } }) => {
+    // Run in 5 minutes.
+    await ctx.scheduler.runAfter(5 * 60_000, "email:sendReminder", { userId });
+
+    // Run at a specific moment.
+    await ctx.scheduler.runAt(Date.now() + 60_000, "cleanup:run", { older: 30 });
+});
+```
+
+Outside a function, build the scheduler yourself. The standalone `createScheduler`
+takes a typed function reference instead of a path:
+
+```ts
+import { createScheduler } from "@lunora/scheduler";
+
+import { api } from "@/lunora/_generated/api";
+
+const scheduler = createScheduler({ namespace: env.SCHEDULER, originUrl: "https://app.acme.test" });
+
+const { id } = await scheduler.runAfter(5 * 60_000, api.email.sendReminder, { userId: "u-1" });
+await scheduler.cancel(id);
+```
+
+Declare recurring jobs in `lunora/crons.ts` — codegen lifts them into
+`wrangler.jsonc` and the runtime's `scheduled()` handler:
+
+```ts
+import { cronJobs } from "@lunora/scheduler";
+
+import { internal } from "@/lunora/_generated/api";
+
+const crons = cronJobs();
+
+crons.interval("clear presence", { minutes: 30 }, internal.presence.clear, {});
+crons.daily("send digest", { hourUTC: 9, minuteUTC: 0 }, internal.email.digest, {});
+
+export default crons;
+```
+
+> This README covers the basics. For the full API, options, and guides, see the **[documentation](https://lunora.sh/docs/addons/scheduler)**.
+
+## Related
+
+- [`@lunora/do`](https://www.npmjs.com/package/@lunora/do) — the Durable Objects the scheduler dispatches into.
+- [`@lunora/server`](https://www.npmjs.com/package/@lunora/server) — define the functions you schedule.
+- [`@lunora/codegen`](https://www.npmjs.com/package/@lunora/codegen) — keeps `triggers.crons` in sync from your `cronJobs()` definitions.
+
+## 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 scheduler 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/scheduler?style=for-the-badge
+[npm-version]: https://www.npmjs.com/package/@lunora/scheduler
+[npm-downloads-badge]: https://img.shields.io/npm/dm/@lunora/scheduler?style=for-the-badge
+[npm-downloads]: https://www.npmjs.com/package/@lunora/scheduler
+[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/