@lunora/nuxt 0.0.1 → 1.0.0-alpha.10

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,45 +1,177 @@
-# @lunora/nuxt
+<!-- START_PACKAGE_OG_IMAGE_PLACEHOLDER -->
 
-## ⚠️ IMPORTANT NOTICE ⚠️
+<a href="https://www.anolilab.com/open-source" align="center">
 
-**This package is created solely for the purpose of setting up OIDC (OpenID Connect) trusted publishing with npm.**
+  <img src="__assets__/package-og.svg" alt="nuxt" />
 
-This is **NOT** a functional package and contains **NO** code or functionality beyond the OIDC setup configuration.
+</a>
 
-## Purpose
+<h3 align="center">Nuxt module for Lunora — single-worker composition (mounts /_lunora/* into Nitro) plus reactive-loader server helpers</h3>
 
-This package exists to:
-1. Configure OIDC trusted publishing for the package name `@lunora/nuxt`
-2. Enable secure, token-less publishing from CI/CD workflows
-3. Establish provenance for packages published under this name
+<!-- END_PACKAGE_OG_IMAGE_PLACEHOLDER -->
 
-## What is OIDC Trusted Publishing?
+<br />
 
-OIDC trusted publishing allows package maintainers to publish packages directly from their CI/CD workflows without needing to manage npm access tokens. Instead, it uses OpenID Connect to establish trust between the CI/CD provider (like GitHub Actions) and npm.
+<div align="center">
 
-## Setup Instructions
+[![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]
 
-To properly configure OIDC trusted publishing for this package:
+</div>
 
-1. Go to [npmjs.com](https://www.npmjs.com/) and navigate to your package settings
-2. Configure the trusted publisher (e.g., GitHub Actions)
-3. Specify the repository and workflow that should be allowed to publish
-4. Use the configured workflow to publish your actual package
+---
+
+<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>
 
-## DO NOT USE THIS PACKAGE
+---
 
-This package is a placeholder for OIDC configuration only. It:
-- Contains no executable code
-- Provides no functionality
-- Should not be installed as a dependency
-- Exists only for administrative purposes
+A **Nuxt module** that runs Lunora and Nuxt as a **single Cloudflare Worker**.
+
+Instead of Lunora owning the Cloudflare worker entry (the two-worker split), it
+is mounted _inside_ Nitro: the module registers a server route at `/_lunora/**`
+that forwards every Lunora RPC, WebSocket upgrade, and admin request to your
+Lunora app in-process. One `wrangler.jsonc`, one deploy, a same-origin client.
+
+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
+
+```bash
+npm install @lunora/nuxt
+```
 
-## More Information
+## Setup
 
-For more details about npm's trusted publishing feature, see:
-- [npm Trusted Publishing Documentation](https://docs.npmjs.com/generating-provenance-statements)
-- [GitHub Actions OIDC Documentation](https://docs.github.com/en/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect)
+```ts
+// nuxt.config.ts
+export default defineNuxtConfig({
+    modules: ["@lunora/nuxt"],
+    nitro: { preset: "cloudflare_module" },
+});
+```
 
----
+Add `exports.cloudflare.ts` to the project root so the `ShardDO` Durable Object
+class is exported from the emitted worker entry:
+
+```ts
+// exports.cloudflare.ts
+export { ShardDO } from "./lunora/server";
+```
+
+`lunora/server.ts` is your built Lunora app (`defineApp().build()`) — its default
+export is the worker (a `fetch` entrypoint), and it re-exports `ShardDO`. The
+module aliases the `#lunora/app` virtual to it (configurable via the `lunora.appEntry`
+option, default `~/lunora/server`) and serves it at the `/_lunora/**` route
+(prefix configurable via `lunora.prefix`).
+
+## Options
+
+| Option     | Default           | Description                                               |
+| ---------- | ----------------- | --------------------------------------------------------- |
+| `appEntry` | `~/lunora/server` | Module specifier of the Lunora app entry (`#lunora/app`). |
+| `prefix`   | `/_lunora`        | URL prefix the Lunora realtime plane is mounted at.       |
+
+## How it works
+
+- **The route** (`addServerHandler` at `prefix/**`): reconstructs a Web `Request`
+  from the H3 event, resolves the Cloudflare `env`/`ExecutionContext` off it
+  (tolerating both `event.context.cloudflare` and `event.req.runtime.cloudflare`),
+  and forwards to your app's `fetch`. A missing Cloudflare runtime answers a clear 500.
+- **`#lunora/app` alias**: points the route's worker import at your app entry,
+  forwarded into the Nitro server bundle via `nuxt.options.alias`.
+- **`ShardDO`** rides to the worker entry through your root `exports.cloudflare.ts`
+  (the `cloudflare_module` preset appends its exports).
+
+## Verify before deploy
+
+Single-worker composition rides on two Nitro behaviours that vary across versions
+— verify them on your pinned toolchain:
+
+1. **WebSocket upgrade pass-through.** The live feed needs Nitro to return your
+   Lunora app's `101 Switching Protocols` response (carrying its Cloudflare
+   `webSocket`) untouched. RPC (plain JSON) works regardless; if live
+   subscriptions never connect while RPC does, Nitro is normalising the upgrade
+   response and `/_lunora/ws` needs a deploy-boundary handoff instead of the H3
+   route return.
+2. **`exports.cloudflare.ts` hook.** The `cloudflare_module` preset must append
+   this file's exports onto the worker entry. If `wrangler deploy` fails with
+   "ShardDO class not exported", your Nitro version may use a different hook
+   (`nitro.cloudflare.additionalModules`, or a `rollupConfig` output export). The
+   module `warn()`s when the file is missing but can't verify the hook fires.
+
+## Server data-loading
+
+`@lunora/nuxt/server` re-exports the framework-neutral SSR helpers
+(`createServerClient`, `preloadQuery`, …) from `@lunora/client/ssr` for the
+reactive-loader handoff. Safe to import from a Nitro server route (no WebSocket,
+no browser globals).
+
+## Feature flags
+
+`@lunora/nuxt` ships no flag composable — Nuxt _is_ Vue, so read `ctx.flags`
+server-side (a Nitro route, a function, or a reactive loader) and pass the
+resolved value down, or call `useFlag` / `useFlags` from
+[`@lunora/vue`](https://www.npmjs.com/package/@lunora/vue) directly in a
+component for live updates over the WebSocket. Requires
+[`@lunora/flags`](https://www.npmjs.com/package/@lunora/flags) wired in
+`lunora/flags.ts`.
+
+```vue
+<script setup lang="ts">
+import { useFlag } from "@lunora/vue";
+
+// Live over the Lunora WS — holds `false` until the server resolves it.
+const newHero = useFlag("homepage-hero", false);
+</script>
+
+<template>
+    <NewHero v-if="newHero" />
+    <ClassicHero v-else />
+</template>
+```
+
+## 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
+
+The Lunora nuxt package is open-sourced software licensed under the [FSL-1.1-Apache-2.0][license].
+
+<!-- badges -->
 
-**Maintained for OIDC setup purposes only**
+[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/nuxt?style=for-the-badge
+[npm-version]: https://www.npmjs.com/package/@lunora/nuxt
+[npm-downloads-badge]: https://img.shields.io/npm/dm/@lunora/nuxt?style=for-the-badge
+[npm-downloads]: https://www.npmjs.com/package/@lunora/nuxt
+[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/