instaserve 1.1.11 → 1.1.12

package/README.md

@@ -238,3 +238,49 @@ export default {
     }
 }
 ```
+
+## Library Modules
+
+The `lib/` directory contains useful modules for authentication, storage, and database manipulation.
+
+### Auth0 (`lib/auth0.js`)
+Provides authentication routes and `req.user` handling via Auth0.
+- **Routes:** `GET /login`, `GET /logout`, `GET /callback`
+- **Usage:** Import and spread into your routes.
+  ```javascript
+  import auth0 from './lib/auth0.js';
+  
+  export default {
+    ...auth0,
+    // other routes
+  }
+  ```
+
+### R2 Storage (`lib/r2.js`)
+Utilities for Cloudflare R2 or S3-compatible object storage.
+- **Features:** `uploadToR2`, `downloadFromR2`, `listR2Files`
+- **Routes:** `fileRoutes` exports helpers for file management.
+- **Usage:**
+  ```javascript
+  import { fileRoutes } from './lib/r2.js';
+  
+  export default {
+    ...fileRoutes,
+    // other routes
+  }
+  ```
+
+### SQLite (`lib/sqlite.js`)
+Provides a local SQLite database with a per-user Key-Value store.
+- **Features:** User management table, KV table.
+- **Routes:** `_auth` middleware, CRUD for KV store (`/api`, `/all`).
+- **Usage:**
+  ```javascript
+  import sqliteRoutes from './lib/sqlite.js';
+  
+  export default {
+    ...sqliteRoutes,
+    // other routes
+  }
+  ```
+```

package/lib/auth0.js

@@ -1,6 +1,20 @@
+/**
+ * Auth0 Authentication Module
+ * 
+ * Usage:
+ * 1. Import this module in your routes.js file.
+ * 2. Merge it into your default export routes object: `...auth0`.
+ * 3. Ensure 'secrets' is globally available or imported with `auth0_domain`, `auth0_clientid`, and `auth0_clientsecret`.
+ * 4. Ensure `global.sqlite` is initialized (typically by importing lib/sqlite.js).
+ * 
+ * Routes provided:
+ * - GET /login: Initiates Auth0 login flow.
+ * - GET /logout: Clears session and token.
+ * - GET /callback: Handles Auth0 callback, validates token, creates user in DB.
+ */
 export default {
   "GET /login": (req, res) => {
-    const REDIRECT_URI = "https://${req.headers.host}/callback";
+    const REDIRECT_URI = `https://${req.headers.host}/callback`;
     const state = crypto.randomBytes(16).toString("hex");
     global.a0state = state;
     const url = `https://${secrets.auth0_domain}/authorize?response_type=code&client_id=${secrets.auth0_clientid}&redirect_uri=${encodeURIComponent(REDIRECT_URI)}&scope=openid%20profile%20email&state=${encodeURIComponent(state)}`;
@@ -18,8 +32,8 @@ export default {
     res.end();
   },
   "GET /callback": async (req, res, data) => {
-    const REDIRECT_URI = "https://${req.headers.host}/callback";
-    const tokenRes = await fetch("https://digplan.auth0.com/oauth/token", {
+    const REDIRECT_URI = `https://${req.headers.host}/callback`;
+    const tokenRes = await fetch(`https://${secrets.auth0_domain}/oauth/token`, {
       method: "POST",
       headers: { "content-type": "application/json" },
       body: JSON.stringify({

package/lib/r2.js

@@ -1,3 +1,24 @@
+/**
+ * Cloudflare R2 / S3-Compatible Storage Module
+ * 
+ * Usage:
+ * 1. Import desired functions or `fileRoutes` from this file.
+ * 2. Requires a `secrets` object with:
+ *    - cloudflareAccessKeyId
+ *    - cloudflareSecretAccessKey
+ *    - cloudflareAccountId
+ * 
+ * Exports:
+ * - uploadToR2(bucket, key, body, contentType, secrets)
+ * - downloadFromR2(bucket, key, secrets)
+ * - deleteFromR2(bucket, key, secrets)
+ * - listR2Files(bucket, prefix, secrets)
+ * - getSignedDownloadUrl(bucket, key, secrets)
+ * 
+ * fileRoutes:
+ * Contains helper handlers for file operations. Note that `upload`, `download`, `delete`
+ * are generic async functions awaiting `data` parameters, while `POST /files` is a standard route.
+ */
 import https from 'https';
 import crypto from 'crypto';
 import { URL } from 'url';

package/lib/sqlite.js

@@ -1,3 +1,22 @@
+/**
+ * SQLite Database & Key-Value Store Module
+ * 
+ * Usage:
+ * 1. Import this module to initialize the database ('data.db') and tables ('users', 'kv').
+ * 2. Access the database instance via `global.sqlite`.
+ * 3. Exported routes provide a per-user Key-Value store mechanism guarded by the `_auth` middleware.
+ * 
+ * Tables created:
+ * - users: id, username, pass, token, picture, name, email
+ * - kv: key (format: "username:key"), value
+ * 
+ * Routes provided:
+ * - _auth: Middleware for protecting routes (assigns `req.user`).
+ * - POST /api: Set a KV pair for the logged-in user.
+ * - GET /api: Get a value by key.
+ * - GET /all: List all keys/values for the user.
+ * - DELETE /api: Delete a key.
+ */
 import Database from "better-sqlite3";
 import { fileRoutes } from "./lib/file-routes.js";
 import secrets from "./secrets.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "instaserve",
-  "version": "1.1.11",
+  "version": "1.1.12",
   "description": "Instant web stack",
   "main": "module.mjs",
   "bin": "./instaserve",