Merge pull request #5 from get-convex/rename-to-static-hosting

Rename @convex-dev/self-hosting to @convex-dev/static-hosting

Author: sethconvex

.gitignore

@@ -18,4 +18,4 @@ node_modules
 next-example/
 
 # Note: dist/ is NOT ignored - it's committed for GitHub installs
-# (npm install github:get-convex/self-hosting#main)
+# (npm install github:get-convex/static-hosting#main)

CLAUDE.md

@@ -4,7 +4,7 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co
 
 ## Project Overview
 
-A Convex component that enables self-hosting static React/Vite apps using Convex HTTP actions and file storage. Published as `@convex-dev/self-hosting` on npm.
+A Convex component that enables hosting static React/Vite apps using Convex HTTP actions and file storage. Published as `@convex-dev/static-hosting` on npm.
 
 ## Commands
 
@@ -47,9 +47,9 @@ src/
 
 ### Package Exports
 
-- `@convex-dev/self-hosting` - Client APIs (registerStaticRoutes, exposeUploadApi, etc.)
-- `@convex-dev/self-hosting/react` - React components (UpdateBanner, useDeploymentUpdates)
-- `@convex-dev/self-hosting/convex.config` - Component config for app.use()
+- `@convex-dev/static-hosting` - Client APIs (registerStaticRoutes, exposeUploadApi, etc.)
+- `@convex-dev/static-hosting/react` - React components (UpdateBanner, useDeploymentUpdates)
+- `@convex-dev/static-hosting/convex.config` - Component config for app.use()
 
 ### Deployment Mode
 

CONVEX_STATIC_HOSTING.md

@@ -2,7 +2,7 @@
 
 ## Overview
 
-This implementation allows self-hosting static React/Vite apps using Convex HTTP actions and file storage, eliminating the need for Vercel or other hosting providers.
+This implementation allows hosting static React/Vite apps using Convex HTTP actions and file storage, eliminating the need for Vercel or other hosting providers.
 
 ## Architecture
 
@@ -443,7 +443,7 @@ For better performance, non-HTML static assets can be served from a CDN via [con
 
 **Schema change**: The `staticAssets` table now supports both `storageId` (optional) and `blobId` (optional). An asset has either a `storageId` (Convex storage) or a `blobId` (CDN).
 
-**Deploy command**: `npx @convex-dev/self-hosting deploy --cdn`
+**Deploy command**: `npx @convex-dev/static-hosting deploy --cdn`
 
 See `INTEGRATION.md` for full CDN setup instructions.
 

INTEGRATION.md

@@ -1,19 +1,19 @@
-# Integration Guide: @convex-dev/self-hosting
+# Integration Guide: @convex-dev/static-hosting
 
-A Convex component that enables self-hosting static React/Vite apps using Convex HTTP actions and file storage. No external hosting provider required.
+A Convex component that enables hosting static React/Vite apps using Convex HTTP actions and file storage. No external hosting provider required.
 
 ## Quick Start
 
 ### Step 1: Install
 ```bash
-npm install @convex-dev/self-hosting
+npm install @convex-dev/static-hosting
 ```
 
 ### Step 2: Setup (Choose One)
 
 #### Option A: Automated Setup (Recommended)
 ```bash
-npx @convex-dev/self-hosting setup
+npx @convex-dev/static-hosting setup
 ```
 Interactive wizard that creates all necessary files.
 
@@ -27,7 +27,7 @@ See Manual Setup section below.
 #### 1. convex/convex.config.ts
 ```typescript
 import { defineApp } from "convex/server";
-import selfHosting from "@convex-dev/self-hosting/convex.config";
+import selfHosting from "@convex-dev/static-hosting/convex.config";
 
 const app = defineApp();
 app.use(selfHosting);
@@ -41,7 +41,7 @@ import { components } from "./_generated/api";
 import {
   exposeUploadApi,
   exposeDeploymentQuery,
-} from "@convex-dev/self-hosting";
+} from "@convex-dev/static-hosting";
 
 // Internal functions for secure uploads (CLI only)
 export const { generateUploadUrl, recordAsset, gcOldAssets, listAssets } =
@@ -55,7 +55,7 @@ export const { getCurrentDeployment } =
 #### 3. convex/http.ts
 ```typescript
 import { httpRouter } from "convex/server";
-import { registerStaticRoutes } from "@convex-dev/self-hosting";
+import { registerStaticRoutes } from "@convex-dev/static-hosting";
 import { components } from "./_generated/api";
 
 const http = httpRouter();
@@ -78,7 +78,7 @@ Add a deploy script for easy deployments:
 ```json
 {
   "scripts": {
-    "deploy": "npx @convex-dev/self-hosting deploy"
+    "deploy": "npx @convex-dev/static-hosting deploy"
   }
 }
 ```
@@ -87,28 +87,28 @@ Add a deploy script for easy deployments:
 
 ```bash
 # Interactive setup wizard
-npx @convex-dev/self-hosting setup
+npx @convex-dev/static-hosting setup
 
 # One-shot deployment (backend + static files)
-npx @convex-dev/self-hosting deploy
+npx @convex-dev/static-hosting deploy
 
 # Upload static files only (after building)
-npx @convex-dev/self-hosting upload --build --prod
+npx @convex-dev/static-hosting upload --build --prod
 
 # Traditional two-step deployment
 npx convex deploy                                      # Deploy backend
-npx @convex-dev/self-hosting upload --build --prod  # Deploy static files
+npx @convex-dev/static-hosting upload --build --prod  # Deploy static files
 ```
 
 ## Deployment Workflow
 
 ### First Time Setup
 ```bash
 # 1. Install
-npm install @convex-dev/self-hosting
+npm install @convex-dev/static-hosting
 
 # 2. Run setup wizard
-npx @convex-dev/self-hosting setup
+npx @convex-dev/static-hosting setup
 
 # 3. Initialize Convex (if not already done)
 npx convex dev --once
@@ -148,7 +148,7 @@ npm install convex-fs
 #### 2. convex/convex.config.ts
 ```typescript
 import { defineApp } from "convex/server";
-import selfHosting from "@convex-dev/self-hosting/convex.config";
+import selfHosting from "@convex-dev/static-hosting/convex.config";
 import fs from "convex-fs/convex.config";
 
 const app = defineApp();
@@ -161,7 +161,7 @@ export default app;
 #### 3. convex/http.ts
 ```typescript
 import { httpRouter } from "convex/server";
-import { registerStaticRoutes } from "@convex-dev/self-hosting";
+import { registerStaticRoutes } from "@convex-dev/static-hosting";
 import { registerRoutes } from "convex-fs";
 import { components } from "./_generated/api";
 
@@ -187,7 +187,7 @@ import { components } from "./_generated/api";
 import {
   exposeUploadApi,
   exposeDeploymentQuery,
-} from "@convex-dev/self-hosting";
+} from "@convex-dev/static-hosting";
 import { internalAction } from "./_generated/server";
 import { v } from "convex/values";
 import { del } from "convex-fs";
@@ -214,17 +214,17 @@ export const deleteCdnBlobs = internalAction({
 #### 5. Deploy with --cdn flag
 ```bash
 # One-shot deployment with CDN
-npx @convex-dev/self-hosting deploy --cdn
+npx @convex-dev/static-hosting deploy --cdn
 
 # Or upload only with CDN
-npx @convex-dev/self-hosting upload --cdn --prod
+npx @convex-dev/static-hosting upload --cdn --prod
 ```
 
 ### CDN Deploy Script
 ```json
 {
   "scripts": {
-    "deploy": "npx @convex-dev/self-hosting deploy --cdn"
+    "deploy": "npx @convex-dev/static-hosting deploy --cdn"
   }
 }
 ```
@@ -235,7 +235,7 @@ Add a banner that notifies users when a new deployment is available:
 
 ```typescript
 // In your src/App.tsx or main component
-import { UpdateBanner } from "@convex-dev/self-hosting/react";
+import { UpdateBanner } from "@convex-dev/static-hosting/react";
 import { api } from "../convex/_generated/api";
 
 function App() {
@@ -254,7 +254,7 @@ function App() {
 
 Or use the hook for custom UI:
 ```typescript
-import { useDeploymentUpdates } from "@convex-dev/self-hosting/react";
+import { useDeploymentUpdates } from "@convex-dev/static-hosting/react";
 import { api } from "../convex/_generated/api";
 
 const { updateAvailable, reload, dismiss } = useDeploymentUpdates(
@@ -279,16 +279,16 @@ This means unauthorized users cannot upload files, even if they know your Convex
 Always use the `--build` flag when deploying:
 ```bash
 # ✅ Correct - CLI sets VITE_CONVEX_URL for target environment
-npx @convex-dev/self-hosting deploy
+npx @convex-dev/static-hosting deploy
 
 # ❌ Wrong - uses dev URL from .env.local
-npm run build && npx @convex-dev/self-hosting upload --prod
+npm run build && npx @convex-dev/static-hosting upload --prod
 ```
 
 ### "Cannot find module convex.config"
 Make sure you've installed the package and it's listed in `package.json`:
 ```bash
-npm install @convex-dev/self-hosting
+npm install @convex-dev/static-hosting
 ```
 
 ### HTTP routes not working (404s)
@@ -298,7 +298,7 @@ npm install @convex-dev/self-hosting
 ### Component name mismatch
 Default component name is `staticHosting`. If you named your file differently or used a different component name in config, specify it:
 ```bash
-npx @convex-dev/self-hosting upload --component myCustomName
+npx @convex-dev/static-hosting upload --component myCustomName
 ```
 
 ## API Reference
@@ -326,7 +326,7 @@ Browser-only function to derive Convex URL from `.convex.site` hostname.
 
 **Usage**:
 ```typescript
-import { getConvexUrl } from "@convex-dev/self-hosting";
+import { getConvexUrl } from "@convex-dev/static-hosting";
 
 const convexUrl = import.meta.env.VITE_CONVEX_URL ?? getConvexUrl();
 ```

README.md

@@ -1,17 +1,17 @@
-# Convex Self Hosting
+# Convex Static Hosting
 
-[![npm version](https://badge.fury.io/js/@get-convex%2Fself-hosting.svg)](https://badge.fury.io/js/@convex-dev/self-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 self-hosting static React/Vite apps using Convex
+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/self-hosting
-npx @convex-dev/self-hosting setup
+npm install @convex-dev/static-hosting
+npx @convex-dev/static-hosting setup
 ```
 
 The interactive wizard will:
@@ -55,14 +55,14 @@ https://github.com/user-attachments/assets/5eaf781f-87da-4292-9f96-38070c86cd39
 ### 1. Install
 
 ```bash
-npm install @convex-dev/self-hosting
+npm install @convex-dev/static-hosting
 ```
 
 ### 2. Add to your `convex/convex.config.ts`:
 
 ```ts
 import { defineApp } from "convex/server";
-import selfHosting from "@convex-dev/self-hosting/convex.config.js";
+import selfHosting from "@convex-dev/static-hosting/convex.config.js";
 
 const app = defineApp();
 app.use(selfHosting);
@@ -76,7 +76,7 @@ Create or update `convex/http.ts` to serve static files:
 
 ```ts
 import { httpRouter } from "convex/server";
-import { registerStaticRoutes } from "@convex-dev/self-hosting";
+import { registerStaticRoutes } from "@convex-dev/static-hosting";
 import { components } from "./_generated/api";
 
 const http = httpRouter();
@@ -92,7 +92,7 @@ export default http;
 Create a file like `convex/staticHosting.ts`:
 
 ```ts
-import { exposeUploadApi } from "@convex-dev/self-hosting";
+import { exposeUploadApi } from "@convex-dev/static-hosting";
 import { components } from "./_generated/api";
 
 // These are INTERNAL functions - only callable via `npx convex run`
@@ -111,7 +111,7 @@ HTTP actions enabled", it means the Convex backend hasn't been deployed yet.
 {
   "scripts": {
     "build": "vite build",
-    "deploy:static": "npx @convex-dev/self-hosting upload --build --prod"
+    "deploy:static": "npx @convex-dev/static-hosting upload --build --prod"
   }
 }
 ```
@@ -123,7 +123,7 @@ that would use the dev URL from `.env.local`.
 **CLI Options:**
 
 ```bash
-npx @convex-dev/self-hosting upload [options]
+npx @convex-dev/static-hosting upload [options]
 
 Options:
   -d, --dist <path>           Path to dist directory (default: ./dist)
@@ -138,10 +138,10 @@ Options:
 
 ```bash
 # Deploy to production with automatic build
-npx @convex-dev/self-hosting upload --build --prod
+npx @convex-dev/static-hosting upload --build --prod
 
 # Deploy to dev (for testing)
-npx @convex-dev/self-hosting upload --build
+npx @convex-dev/static-hosting upload --build
 ```
 
 ### Using Non-Vite Bundlers
@@ -186,7 +186,7 @@ Deploy both Convex backend and static files with a single command:
 npx convex login
 
 # Deploy everything
-npx @convex-dev/self-hosting deploy
+npx @convex-dev/static-hosting deploy
 ```
 
 The `deploy` command:
@@ -199,7 +199,7 @@ This minimizes the inconsistency window between backend and frontend updates.
 **Deploy command options:**
 
 ```bash
-npx @convex-dev/self-hosting deploy [options]
+npx @convex-dev/static-hosting deploy [options]
 
 Options:
   -d, --dist <path>           Path to dist directory (default: ./dist)
@@ -214,7 +214,7 @@ Add to `package.json` for easy deployments:
 ```json
 {
   "scripts": {
-    "deploy": "npx @convex-dev/self-hosting deploy"
+    "deploy": "npx @convex-dev/static-hosting deploy"
   }
 }
 ```
@@ -228,7 +228,7 @@ If you prefer more control, deploy separately:
 npx convex deploy
 
 # Deploy static files
-npx @convex-dev/self-hosting upload --build --prod
+npx @convex-dev/static-hosting upload --build --prod
 ```
 
 Your app is now live at `https://your-deployment.convex.site`
@@ -250,7 +250,7 @@ Connected clients can be notified when a new deployment is available:
 1. **Expose the deployment query**:
 
    ```ts
-   import { exposeDeploymentQuery } from "@convex-dev/self-hosting";
+   import { exposeDeploymentQuery } from "@convex-dev/static-hosting";
    import { components } from "./_generated/api";
 
    export const { getCurrentDeployment } = exposeDeploymentQuery(
@@ -261,7 +261,7 @@ Connected clients can be notified when a new deployment is available:
 2. **Add the update banner to your app**:
 
    ```tsx
-   import { UpdateBanner } from "@convex-dev/self-hosting/react";
+   import { UpdateBanner } from "@convex-dev/static-hosting/react";
    import { api } from "../convex/_generated/api";
 
    function App() {
@@ -281,7 +281,7 @@ Connected clients can be notified when a new deployment is available:
 Or use the hook for custom UI:
 
 ```tsx
-import { useDeploymentUpdates } from "@convex-dev/self-hosting/react";
+import { useDeploymentUpdates } from "@convex-dev/static-hosting/react";
 
 const { updateAvailable, reload, dismiss } = useDeploymentUpdates(
   api.staticHosting.getCurrentDeployment,