@convex-dev/static-hosting 0.1.2-beta.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1.  Definitions.
+
+    "License" shall mean the terms and conditions for use, reproduction,
+    and distribution as defined by Sections 1 through 9 of this document.
+
+    "Licensor" shall mean the copyright owner or entity authorized by
+    the copyright owner that is granting the License.
+
+    "Legal Entity" shall mean the union of the acting entity and all
+    other entities that control, are controlled by, or are under common
+    control with that entity. For the purposes of this definition,
+    "control" means (i) the power, direct or indirect, to cause the
+    direction or management of such entity, whether by contract or
+    otherwise, or (ii) ownership of fifty percent (50%) or more of the
+    outstanding shares, or (iii) beneficial ownership of such entity.
+
+    "You" (or "Your") shall mean an individual or Legal Entity
+    exercising permissions granted by this License.
+
+    "Source" form shall mean the preferred form for making modifications,
+    including but not limited to software source code, documentation
+    source, and configuration files.
+
+    "Object" form shall mean any form resulting from mechanical
+    transformation or translation of a Source form, including but
+    not limited to compiled object code, generated documentation,
+    and conversions to other media types.
+
+    "Work" shall mean the work of authorship, whether in Source or
+    Object form, made available under the License, as indicated by a
+    copyright notice that is included in or attached to the work
+    (an example is provided in the Appendix below).
+
+    "Derivative Works" shall mean any work, whether in Source or Object
+    form, that is based on (or derived from) the Work and for which the
+    editorial revisions, annotations, elaborations, or other modifications
+    represent, as a whole, an original work of authorship. For the purposes
+    of this License, Derivative Works shall not include works that remain
+    separable from, or merely link (or bind by name) to the interfaces of,
+    the Work and Derivative Works thereof.
+
+    "Contribution" shall mean any work of authorship, including
+    the original version of the Work and any modifications or additions
+    to that Work or Derivative Works thereof, that is intentionally
+    submitted to Licensor for inclusion in the Work by the copyright owner
+    or by an individual or Legal Entity authorized to submit on behalf of
+    the copyright owner. For the purposes of this definition, "submitted"
+    means any form of electronic, verbal, or written communication sent
+    to the Licensor or its representatives, including but not limited to
+    communication on electronic mailing lists, source code control systems,
+    and issue tracking systems that are managed by, or on behalf of, the
+    Licensor for the purpose of discussing and improving the Work, but
+    excluding communication that is conspicuously marked or otherwise
+    designated in writing by the copyright owner as "Not a Contribution."
+
+    "Contributor" shall mean Licensor and any individual or Legal Entity
+    on behalf of whom a Contribution has been received by Licensor and
+    subsequently incorporated within the Work.
+
+2.  Grant of Copyright License. Subject to the terms and conditions of
+    this License, each Contributor hereby grants to You a perpetual,
+    worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+    copyright license to reproduce, prepare Derivative Works of,
+    publicly display, publicly perform, sublicense, and distribute the
+    Work and such Derivative Works in Source or Object form.
+
+3.  Grant of Patent License. Subject to the terms and conditions of
+    this License, each Contributor hereby grants to You a perpetual,
+    worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+    (except as stated in this section) patent license to make, have made,
+    use, offer to sell, sell, import, and otherwise transfer the Work,
+    where such license applies only to those patent claims licensable
+    by such Contributor that are necessarily infringed by their
+    Contribution(s) alone or by combination of their Contribution(s)
+    with the Work to which such Contribution(s) was submitted. If You
+    institute patent litigation against any entity (including a
+    cross-claim or counterclaim in a lawsuit) alleging that the Work
+    or a Contribution incorporated within the Work constitutes direct
+    or contributory patent infringement, then any patent licenses
+    granted to You under this License for that Work shall terminate
+    as of the date such litigation is filed.
+
+4.  Redistribution. You may reproduce and distribute copies of the
+    Work or Derivative Works thereof in any medium, with or without
+    modifications, and in Source or Object form, provided that You
+    meet the following conditions:
+
+    (a) You must give any other recipients of the Work or
+    Derivative Works a copy of this License; and
+
+    (b) You must cause any modified files to carry prominent notices
+    stating that You changed the files; and
+
+    (c) You must retain, in the Source form of any Derivative Works
+    that You distribute, all copyright, patent, trademark, and
+    attribution notices from the Source form of the Work,
+    excluding those notices that do not pertain to any part of
+    the Derivative Works; and
+
+    (d) If the Work includes a "NOTICE" text file as part of its
+    distribution, then any Derivative Works that You distribute must
+    include a readable copy of the attribution notices contained
+    within such NOTICE file, excluding those notices that do not
+    pertain to any part of the Derivative Works, in at least one
+    of the following places: within a NOTICE text file distributed
+    as part of the Derivative Works; within the Source form or
+    documentation, if provided along with the Derivative Works; or,
+    within a display generated by the Derivative Works, if and
+    wherever such third-party notices normally appear. The contents
+    of the NOTICE file are for informational purposes only and
+    do not modify the License. You may add Your own attribution
+    notices within Derivative Works that You distribute, alongside
+    or as an addendum to the NOTICE text from the Work, provided
+    that such additional attribution notices cannot be construed
+    as modifying the License.
+
+    You may add Your own copyright statement to Your modifications and
+    may provide additional or different license terms and conditions
+    for use, reproduction, or distribution of Your modifications, or
+    for any such Derivative Works as a whole, provided Your use,
+    reproduction, and distribution of the Work otherwise complies with
+    the conditions stated in this License.
+
+5.  Submission of Contributions. Unless You explicitly state otherwise,
+    any Contribution intentionally submitted for inclusion in the Work
+    by You to the Licensor shall be under the terms and conditions of
+    this License, without any additional terms or conditions.
+    Notwithstanding the above, nothing herein shall supersede or modify
+    the terms of any separate license agreement you may have executed
+    with Licensor regarding such Contributions.
+
+6.  Trademarks. This License does not grant permission to use the trade
+    names, trademarks, service marks, or product names of the Licensor,
+    except as required for reasonable and customary use in describing the
+    origin of the Work and reproducing the content of the NOTICE file.
+
+7.  Disclaimer of Warranty. Unless required by applicable law or
+    agreed to in writing, Licensor provides the Work (and each
+    Contributor provides its Contributions) on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+    implied, including, without limitation, any warranties or conditions
+    of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+    PARTICULAR PURPOSE. You are solely responsible for determining the
+    appropriateness of using or redistributing the Work and assume any
+    risks associated with Your exercise of permissions under this License.
+
+8.  Limitation of Liability. In no event and under no legal theory,
+    whether in tort (including negligence), contract, or otherwise,
+    unless required by applicable law (such as deliberate and grossly
+    negligent acts) or agreed to in writing, shall any Contributor be
+    liable to You for damages, including any direct, indirect, special,
+    incidental, or consequential damages of any character arising as a
+    result of this License or out of the use or inability to use the
+    Work (including but not limited to damages for loss of goodwill,
+    work stoppage, computer failure or malfunction, or any and all
+    other commercial damages or losses), even if such Contributor
+    has been advised of the possibility of such damages.
+
+9.  Accepting Warranty or Additional Liability. While redistributing
+    the Work or Derivative Works thereof, You may choose to offer,
+    and charge a fee for, acceptance of support, warranty, indemnity,
+    or other liability obligations and/or rights consistent with this
+    License. However, in accepting such obligations, You may act only
+    on Your own behalf and on Your sole responsibility, not on behalf
+    of any other Contributor, and only if You agree to indemnify,
+    defend, and hold each Contributor harmless for any liability
+    incurred by, or claims asserted against, such Contributor by reason
+    of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+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

@@ -0,0 +1,333 @@
+# Convex Static Hosting
+
+[![npm version](https://badge.fury.io/js/@convex-dev%2Fstatic-hosting.svg)](https://badge.fury.io/js/@convex-dev/static-hosting)
+
+A Convex component that enables hosting static React/Vite apps using Convex
+HTTP actions and file storage. No external hosting provider required!
+
+## Quick Start
+
+### Automated Setup (Recommended)
+
+```bash
+npm install @convex-dev/static-hosting
+npx @convex-dev/static-hosting setup
+```
+
+The interactive wizard will:
+1. Create necessary Convex files
+2. Add deploy script to package.json
+
+Then deploy:
+```bash
+npm run deploy
+```
+
+### For LLMs / AI Assistants
+
+If you're an LLM helping a user integrate this component, read [INTEGRATION.md](./INTEGRATION.md) for complete integration instructions optimized for AI consumption.
+
+### Manual Setup
+
+See [Manual Setup](#manual-setup-1) section below for step-by-step instructions.
+
+## Features
+
+- 🚀 **Simple deployment** - Upload your built files directly to Convex storage
+- 🔒 **Secure by default** - Upload API uses internal functions (not publicly
+  accessible)
+- 🔄 **SPA support** - Automatic fallback to index.html for client-side routing
+- ⚡ **Smart caching** - Hashed assets get long-term caching, HTML is always
+  fresh with ETag support
+- 🧹 **Auto cleanup** - Old deployment files are automatically garbage collected
+- 📦 **Zero config** - Works out of the box with Vite, Create React App, and
+  other bundlers
+
+
+
+https://github.com/user-attachments/assets/5eaf781f-87da-4292-9f96-38070c86cd39
+
+
+
+
+## Manual Setup
+
+### 1. Install
+
+```bash
+npm install @convex-dev/static-hosting
+```
+
+### 2. Add to your `convex/convex.config.ts`:
+
+```ts
+import { defineApp } from "convex/server";
+import staticHosting from "@convex-dev/static-hosting/convex.config.js";
+
+const app = defineApp();
+app.use(staticHosting);
+
+export default app;
+```
+
+### 3. Register HTTP routes
+
+Create or update `convex/http.ts` to serve static files:
+
+```ts
+import { httpRouter } from "convex/server";
+import { registerStaticRoutes } from "@convex-dev/static-hosting";
+import { components } from "./_generated/api";
+
+const http = httpRouter();
+
+// Serve static files at the root path with SPA fallback
+registerStaticRoutes(http, components.staticHosting);
+
+export default http;
+```
+
+### 4. Expose upload API (internal functions)
+
+Create a file like `convex/staticHosting.ts`:
+
+```ts
+import { exposeUploadApi } from "@convex-dev/static-hosting";
+import { components } from "./_generated/api";
+
+// These are INTERNAL functions - only callable via `npx convex run`
+// NOT accessible from the public internet
+export const { generateUploadUrl, recordAsset, gcOldAssets, listAssets } =
+  exposeUploadApi(components.staticHosting);
+```
+
+**Note:** Run `npx convex dev` at least once after setup to push your schema and
+enable HTTP actions. If you see the error "This Convex deployment does not have
+HTTP actions enabled", it means the Convex backend hasn't been deployed yet.
+
+### 5. Add deploy script to package.json
+
+```json
+{
+  "scripts": {
+    "build": "vite build",
+    "deploy:static": "npx @convex-dev/static-hosting upload --build --prod"
+  }
+}
+```
+
+**Important:** Use `--build` to ensure `VITE_CONVEX_URL` is set correctly for
+production. Don't run `npm run build` separately before the upload command, as
+that would use the dev URL from `.env.local`.
+
+**CLI Options:**
+
+```bash
+npx @convex-dev/static-hosting upload [options]
+
+Options:
+  -d, --dist <path>           Path to dist directory (default: ./dist)
+  -c, --component <name>      Convex component name (default: staticHosting)
+      --prod                  Deploy to production Convex deployment
+      --dev                   Deploy to dev deployment (default)
+  -b, --build                 Run 'npm run build' with correct VITE_CONVEX_URL
+  -h, --help                  Show help
+```
+
+**Examples:**
+
+```bash
+# Deploy to production with automatic build
+npx @convex-dev/static-hosting upload --build --prod
+
+# Deploy to dev (for testing)
+npx @convex-dev/static-hosting upload --build
+```
+
+### Using Non-Vite Bundlers
+
+The CLI's `--build` flag sets `VITE_CONVEX_URL` when running your build command.
+For bundlers that use different environment variable conventions, wrap your build
+script to pass through the value:
+
+**For Expo:**
+
+```json
+{
+  "scripts": {
+    "build": "EXPO_PUBLIC_CONVEX_URL=${VITE_CONVEX_URL:-$EXPO_PUBLIC_CONVEX_URL} npx expo export --platform web"
+  }
+}
+```
+
+**For Next.js:**
+
+```json
+{
+  "scripts": {
+    "build": "NEXT_PUBLIC_CONVEX_URL=${VITE_CONVEX_URL:-$NEXT_PUBLIC_CONVEX_URL} next build"
+  }
+}
+```
+
+The pattern `${VITE_CONVEX_URL:-$VAR}` uses `VITE_CONVEX_URL` if set (by the CLI),
+otherwise falls back to your bundler-specific variable. This allows the CLI's
+`--build` flag to work correctly while keeping your standalone `npm run build`
+functional.
+
+## Deployment
+
+### One-Shot Deployment (Recommended)
+
+Deploy both Convex backend and static files with a single command:
+
+```bash
+# Make sure you're logged in
+npx convex login
+
+# Deploy everything
+npx @convex-dev/static-hosting deploy
+```
+
+The `deploy` command:
+1. Builds frontend with production `VITE_CONVEX_URL`
+2. Deploys Convex backend (`npx convex deploy`)
+3. Deploys static files to Convex storage
+
+This minimizes the inconsistency window between backend and frontend updates.
+
+**Deploy command options:**
+
+```bash
+npx @convex-dev/static-hosting deploy [options]
+
+Options:
+  -d, --dist <path>           Path to dist directory (default: ./dist)
+  -c, --component <name>      Convex component name (default: staticHosting)
+      --skip-build            Skip the build step (use existing dist)
+      --skip-convex           Skip Convex backend deployment
+  -h, --help                  Show help
+```
+
+Add to `package.json` for easy deployments:
+
+```json
+{
+  "scripts": {
+    "deploy": "npx @convex-dev/static-hosting deploy"
+  }
+}
+```
+
+### Manual Two-Step Deployment
+
+If you prefer more control, deploy separately:
+
+```bash
+# Deploy Convex backend
+npx convex deploy
+
+# Deploy static files
+npx @convex-dev/static-hosting upload --build --prod
+```
+
+Your app is now live at `https://your-deployment.convex.site`
+
+## Security
+
+The upload API uses **internal functions** that can only be called via:
+
+- `npx convex run` (requires Convex CLI authentication)
+- Other Convex functions (server-side only)
+
+This means unauthorized users **cannot** upload files to your site, even if they
+know your Convex URL.
+
+## Live Reload on Deploy
+
+Connected clients can be notified when a new deployment is available:
+
+1. **Expose the deployment query**:
+
+   ```ts
+   import { exposeDeploymentQuery } from "@convex-dev/static-hosting";
+   import { components } from "./_generated/api";
+
+   export const { getCurrentDeployment } = exposeDeploymentQuery(
+     components.staticHosting,
+   );
+   ```
+
+2. **Add the update banner to your app**:
+
+   ```tsx
+   import { UpdateBanner } from "@convex-dev/static-hosting/react";
+   import { api } from "../convex/_generated/api";
+
+   function App() {
+     return (
+       <div>
+         <UpdateBanner
+           getCurrentDeployment={api.staticHosting.getCurrentDeployment}
+           message="New version available!"
+           buttonText="Refresh"
+         />
+         {/* rest of your app */}
+       </div>
+     );
+   }
+   ```
+
+Or use the hook for custom UI:
+
+```tsx
+import { useDeploymentUpdates } from "@convex-dev/static-hosting/react";
+
+const { updateAvailable, reload, dismiss } = useDeploymentUpdates(
+  api.staticHosting.getCurrentDeployment,
+);
+```
+
+## Configuration Options
+
+### `registerStaticRoutes`
+
+```ts
+registerStaticRoutes(http, components.staticHosting, {
+  // URL prefix for static files (default: "/")
+  pathPrefix: "/app",
+
+  // Enable SPA fallback to index.html (default: true)
+  spaFallback: true,
+});
+```
+
+## How It Works
+
+1. **Build Phase**: Your bundler (Vite, etc.) creates optimized files in `dist/`
+2. **Upload Phase**: The upload script uses `npx convex run` to:
+   - Generate signed upload URLs
+   - Upload each file to Convex storage
+   - Record file metadata in the component's database
+   - Garbage collect files from previous deployments
+3. **Serve Phase**: HTTP actions serve files from storage with:
+   - Correct Content-Type headers
+   - Smart cache control (immutable for hashed assets)
+   - SPA fallback for client-side routing
+
+## Example
+
+Check out the [example](./example) directory for a complete working example.
+
+```bash
+npm install
+npm run dev
+```
+
+## Contributing
+
+See [CONTRIBUTING.md](./CONTRIBUTING.md) for development setup and guidelines.
+
+## License
+
+Apache-2.0

package/dist/cli/deploy.d.ts

@@ -0,0 +1,16 @@
+#!/usr/bin/env node
+/**
+ * One-shot deployment command that deploys both Convex backend and static files.
+ *
+ * Usage:
+ *   npx @convex-dev/static-hosting deploy [options]
+ *
+ * This command:
+ * 1. Builds the frontend with the correct VITE_CONVEX_URL
+ * 2. Deploys the Convex backend (npx convex deploy)
+ * 3. Deploys static files to Convex storage
+ *
+ * The goal is to minimize the inconsistency window between backend and frontend.
+ */
+export {};
+//# sourceMappingURL=deploy.d.ts.map

package/dist/cli/deploy.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"deploy.d.ts","sourceRoot":"","sources":["../../src/cli/deploy.ts"],"names":[],"mappings":";AACA;;;;;;;;;;;;GAYG"}