clefbase 1.4.1 → 1.5.0

package/dist/cli-src/cli/commands/init.js

@@ -60,7 +60,7 @@ async function runInit(cwd = process.cwd()) {
         projectId: projectId.trim(),
         apiKey: apiKey.trim(),
         adminSecret: adminSecret.trim(),
-        services: { database: false, auth: false, storage: false, hosting: false },
+        services: { database: false, auth: false, storage: false, hosting: false, functions: false },
     };
     // ── Step 2: Connection test ───────────────────────────────────────────────
     const connSpinner = (0, ora_1.default)("Testing connection…").start();
@@ -78,10 +78,11 @@ async function runInit(cwd = process.cwd()) {
             name: "services",
             message: "Which services will you use?",
             choices: [
-                { name: "Database  — store and query documents", value: "database", checked: true },
-                { name: "Auth      — user sign-up / sign-in", value: "auth", checked: true },
-                { name: "Storage   — file uploads", value: "storage", checked: false },
-                { name: "Hosting   — deploy static sites", value: "hosting", checked: false },
+                { name: "Database   — store and query documents", value: "database", checked: true },
+                { name: "Auth       — user sign-up / sign-in", value: "auth", checked: true },
+                { name: "Storage    — file uploads", value: "storage", checked: false },
+                { name: "Hosting    — deploy static sites", value: "hosting", checked: false },
+                { name: "Functions  — serverless JS/TS & Python functions", value: "functions", checked: false },
             ],
         }]);
     cfg.services = {
@@ -89,6 +90,7 @@ async function runInit(cwd = process.cwd()) {
         auth: services.includes("auth"),
         storage: services.includes("storage"),
         hosting: services.includes("hosting"),
+        functions: services.includes("functions"),
     };
     // ── Step 4: Hosting setup ─────────────────────────────────────────────────
     if (cfg.services.hosting) {
@@ -116,21 +118,19 @@ async function runInit(cwd = process.cwd()) {
 }
 /**
  * Writes two files into `<cwd>/src/lib/`:
- *   • clefbase.json  — a copy of the project config (secrets stripped for safety)
+ *   • clefbase.json  — a copy of the project config (adminSecret stripped)
  *   • clefBase.ts    — ready-to-import service exports
  *
- * Safe to call multiple times — the TS file is regenerated on every call so it
- * stays in sync with the enabled services.
+ * Safe to call multiple times — always regenerated in sync with enabled services.
  */
 function scaffoldLib(cfg, cwd = process.cwd()) {
     const libDir = path_1.default.join(cwd, "src", "lib");
     fs_1.default.mkdirSync(libDir, { recursive: true });
-    // ── 1. Config copy (strip adminSecret for safety) ─────────────────────────
+    // ── 1. Config copy (adminSecret omitted — not needed in client code) ──────
     const publicCfg = {
         serverUrl: cfg.serverUrl,
         projectId: cfg.projectId,
         apiKey: cfg.apiKey,
-        // adminSecret intentionally omitted — not needed in client code
         services: cfg.services,
         ...(cfg.hosting ? { hosting: cfg.hosting } : {}),
     };
@@ -146,7 +146,7 @@ function scaffoldLib(cfg, cwd = process.cwd()) {
 }
 /** Build the content of src/lib/clefBase.ts based on enabled services. */
 function buildLibTs(cfg) {
-    const { database, auth, storage } = cfg.services;
+    const { database, auth, storage, functions: fns } = cfg.services;
     // Collect SDK imports
     const sdkImports = ["initClefbase"];
     if (database)
@@ -155,6 +155,8 @@ function buildLibTs(cfg) {
         sdkImports.push("getAuth");
     if (storage)
         sdkImports.push("getStorage");
+    if (fns)
+        sdkImports.push("getFunctions", "httpsCallable");
     // Collect type imports
     const typeImports = [];
     if (database)
@@ -163,13 +165,22 @@ function buildLibTs(cfg) {
         typeImports.push("Auth");
     if (storage)
         typeImports.push("ClefbaseStorage");
+    if (fns)
+        typeImports.push("ClefbaseFunctions");
     const lines = [
         `/**`,
         ` * Clefbase — pre-initialised service exports`,
         ` *`,
         ` * Usage:`,
-        ` *   import { db, auth, storage } from "@lib/clefBase";`,
-        ` *   import db from "@lib/clefBase";`,
+        ...(database ? [` *   import { db } from "@lib/clefBase";`] : []),
+        ...(auth ? [` *   import { auth } from "@lib/clefBase";`] : []),
+        ...(storage ? [` *   import { storage } from "@lib/clefBase";`] : []),
+        ...(fns ? [
+            ` *   import { fns, httpsCallable } from "@lib/clefBase";`,
+            ` *`,
+            ` *   const greet = httpsCallable<{ name: string }, { message: string }>(fns, "greetUser");`,
+            ` *   const { data } = await greet({ name: "Alice" });`,
+        ] : []),
         ` */`,
         ``,
         `import { ${sdkImports.join(", ")} } from "clefbase";`,
@@ -189,7 +200,8 @@ function buildLibTs(cfg) {
         ``,
     ];
     // ── Service instances ──────────────────────────────────────────────────────
-    if (database || auth || storage) {
+    const hasServices = database || auth || storage || fns;
+    if (hasServices) {
         lines.push("// ─── Services ───────────────────────────────────────────────────────────────");
         lines.push("");
     }
@@ -208,9 +220,22 @@ function buildLibTs(cfg) {
         lines.push(`export const storage: ClefbaseStorage = getStorage(app);`);
         lines.push("");
     }
-    // ── Re-export app for advanced use ────────────────────────────────────────
+    if (fns) {
+        lines.push(`/** Clefbase Functions — deploy and call serverless functions. */`);
+        lines.push(`export const fns: ClefbaseFunctions = getFunctions(app);`);
+        lines.push("");
+        lines.push(`/**`);
+        lines.push(` * Create a typed callable reference to an HTTP-triggered function.`);
+        lines.push(` *`);
+        lines.push(` * @example`);
+        lines.push(` * const greet = httpsCallable<{ name: string }, { message: string }>(fns, "greetUser");`);
+        lines.push(` * const { data } = await greet({ name: "Alice" });`);
+        lines.push(` */`);
+        lines.push(`export { httpsCallable };`);
+        lines.push("");
+    }
+    // ── Re-export app ─────────────────────────────────────────────────────────
     lines.push(`// ─── Advanced ────────────────────────────────────────────────────────────────`, ``, `/** The underlying ClefbaseApp instance (for advanced use). */`, `export { app };`, ``);
-    lines.push("");
     return lines.join("\n");
 }
 // ─── Hosting sub-flow ─────────────────────────────────────────────────────────
@@ -304,6 +329,8 @@ function printUsageHint(cfg) {
         namedImports.push("auth");
     if (cfg.services.storage)
         namedImports.push("storage");
+    if (cfg.services.functions)
+        namedImports.push("fns", "httpsCallable");
     console.log(chalk_1.default.bold("  Quick start:"));
     console.log();
     if (namedImports.length > 0) {
@@ -324,6 +351,16 @@ function printUsageHint(cfg) {
         console.log();
         console.log(chalk_1.default.cyan(`  await storage.ref("uploads/photo.jpg").upload(file);`));
     }
+    if (cfg.services.functions) {
+        console.log();
+        console.log(chalk_1.default.bold("  Functions:"));
+        console.log(chalk_1.default.cyan(`  // Deploy from a file`));
+        console.log(chalk_1.default.cyan(`  $ clefbase functions:deploy -f ./src/functions/hello.ts`));
+        console.log();
+        console.log(chalk_1.default.cyan(`  // Call from your app`));
+        console.log(chalk_1.default.cyan(`  const greet = httpsCallable(fns, "greetUser");`));
+        console.log(chalk_1.default.cyan(`  const { data } = await greet({ name: "Alice" });`));
+    }
     if (cfg.services.hosting && cfg.hosting) {
         console.log();
         console.log(chalk_1.default.bold("  Deploy:"));

package/dist/cli-src/cli/config.js

@@ -13,7 +13,7 @@ const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
 // ─── File helpers ─────────────────────────────────────────────────────────────
 const CONFIG_FILE = "clefbase.json";
-/** Walk up the directory tree looking for clefbase.json (max 5 levels). */
+/** Walk up the directory tree looking for clefbase.json (max 6 levels). */
 function findConfigPath(cwd = process.cwd()) {
     let dir = cwd;
     for (let i = 0; i < 6; i++) {
@@ -32,7 +32,12 @@ function loadConfig(cwd = process.cwd()) {
     if (!p)
         return null;
     try {
-        return JSON.parse(fs_1.default.readFileSync(p, "utf-8"));
+        const raw = JSON.parse(fs_1.default.readFileSync(p, "utf-8"));
+        // Back-compat: configs written before functions was added won't have the field
+        if (raw.services && raw.services.functions === undefined) {
+            raw.services.functions = false;
+        }
+        return raw;
     }
     catch {
         return null;

package/dist/cli-src/cli/index.js

@@ -8,11 +8,12 @@ const chalk_1 = __importDefault(require("chalk"));
 const init_1 = require("./commands/init");
 const deploy_1 = require("./commands/deploy");
 const info_1 = require("./commands/info");
+const functions_1 = require("./commands/functions");
 const package_json_1 = require("../../package.json");
 const program = new commander_1.Command();
 program
     .name("clefbase")
-    .description("Clefbase CLI — initialise projects, deploy sites, manage hosting")
+    .description("Clefbase CLI — initialise projects, deploy sites, manage functions")
     .version(package_json_1.version);
 // ─── init ─────────────────────────────────────────────────────────────────────
 program
@@ -105,6 +106,83 @@ program
         fatal(err);
     }
 });
+// ─── functions:list ───────────────────────────────────────────────────────────
+program
+    .command("functions:list")
+    .alias("fn:list")
+    .description("List all deployed functions for this project")
+    .action(async () => {
+    try {
+        await (0, functions_1.runFunctionsList)();
+    }
+    catch (err) {
+        fatal(err);
+    }
+});
+// ─── functions:deploy ─────────────────────────────────────────────────────────
+program
+    .command("functions:deploy")
+    .alias("fn:deploy")
+    .description("Deploy (or redeploy) a function from a source file or interactively")
+    .option("-n, --name <name>", "Function name")
+    .option("-f, --file <path>", "Path to source file (.js, .ts, .py)")
+    .option("-r, --runtime <runtime>", "Runtime: node | python  (auto-detected from file ext)")
+    .option("-t, --trigger <type>", "Trigger type (http, schedule, onDocumentCreate, …)")
+    .option("-c, --cron <expr>", "Cron expression for schedule triggers")
+    .option("-C, --collection <path>", "Collection path for document triggers")
+    .option("-T, --timeout <ms>", "Execution timeout in milliseconds (default: 30000)")
+    .option("-e, --entry <name>", "Exported function name to call (default: handler)")
+    .option("--env <KEY=VALUE...>", "Environment variable(s) — repeatable")
+    .action(async (opts) => {
+    try {
+        await (0, functions_1.runFunctionsDeploy)(opts);
+    }
+    catch (err) {
+        fatal(err);
+    }
+});
+// ─── functions:call ───────────────────────────────────────────────────────────
+program
+    .command("functions:call <name>")
+    .alias("fn:call")
+    .description("Call an HTTP-triggered function and print its return value")
+    .option("-d, --data <json>", "JSON payload to pass as ctx.data")
+    .action(async (name, opts) => {
+    try {
+        await (0, functions_1.runFunctionsCall)(name, opts);
+    }
+    catch (err) {
+        fatal(err);
+    }
+});
+// ─── functions:delete ─────────────────────────────────────────────────────────
+program
+    .command("functions:delete <name>")
+    .alias("fn:delete")
+    .description("Delete a deployed function")
+    .option("-y, --force", "Skip confirmation prompt")
+    .action(async (name, opts) => {
+    try {
+        await (0, functions_1.runFunctionsDelete)(name, opts);
+    }
+    catch (err) {
+        fatal(err);
+    }
+});
+// ─── functions:logs ───────────────────────────────────────────────────────────
+program
+    .command("functions:logs <name>")
+    .alias("fn:logs")
+    .description("Show recent execution history for a function")
+    .option("-l, --limit <n>", "Number of executions to show (default: 20, max: 100)")
+    .action(async (name, opts) => {
+    try {
+        await (0, functions_1.runFunctionsLogs)(name, opts);
+    }
+    catch (err) {
+        fatal(err);
+    }
+});
 // ─── info ─────────────────────────────────────────────────────────────────────
 program
     .command("info")
@@ -120,16 +198,29 @@ program
 // ─── help footer ─────────────────────────────────────────────────────────────
 program.addHelpText("after", `
 ${chalk_1.default.bold("Examples:")}
-  ${chalk_1.default.cyan("clefbase init")}                          Set up a new project
-  ${chalk_1.default.cyan("clefbase deploy")}                        Deploy your built site
-  ${chalk_1.default.cyan("clefbase deploy -d ./dist")}              Deploy from a specific directory
-  ${chalk_1.default.cyan("clefbase deploy -m \"v2 release\"")}       Deploy with a release note
-  ${chalk_1.default.cyan("clefbase hosting:init")}                   Link or create a hosted site
-  ${chalk_1.default.cyan("clefbase hosting:status")}                 Show current live deploy
-  ${chalk_1.default.cyan("clefbase hosting:sites")}                  List all sites
-  ${chalk_1.default.cyan("clefbase hosting:dns")}                    Show DNS status
-  ${chalk_1.default.cyan("clefbase hosting:dns:reprovision")}        Fix / create the preview CNAME
-  ${chalk_1.default.cyan("clefbase info")}                          Show config & connection status
+  ${chalk_1.default.bold("Project:")}
+  ${chalk_1.default.cyan("clefbase init")}                              Set up a new project
+  ${chalk_1.default.cyan("clefbase info")}                              Show config & connection status
+
+  ${chalk_1.default.bold("Hosting:")}
+  ${chalk_1.default.cyan("clefbase deploy")}                            Deploy your built site
+  ${chalk_1.default.cyan("clefbase deploy -d ./dist -m \"v2\"")}         Deploy from a dir with a note
+  ${chalk_1.default.cyan("clefbase hosting:init")}                      Link or create a hosted site
+  ${chalk_1.default.cyan("clefbase hosting:status")}                    Show current live deploy
+  ${chalk_1.default.cyan("clefbase hosting:sites")}                     List all sites
+  ${chalk_1.default.cyan("clefbase hosting:dns")}                       Show DNS status
+  ${chalk_1.default.cyan("clefbase hosting:dns:reprovision")}           Fix / create the preview CNAME
+
+  ${chalk_1.default.bold("Functions:")}
+  ${chalk_1.default.cyan("clefbase functions:list")}                    List all deployed functions
+  ${chalk_1.default.cyan("clefbase functions:deploy")}                  Interactive deploy wizard
+  ${chalk_1.default.cyan("clefbase functions:deploy -f ./fn.ts")}       Deploy from a file (auto-detects runtime)
+  ${chalk_1.default.cyan("clefbase functions:deploy -n greet -f fn.ts --trigger http")}
+  ${chalk_1.default.cyan("clefbase functions:call greetUser")}          Call an HTTP function
+  ${chalk_1.default.cyan("clefbase functions:call greetUser -d '{\"name\":\"Alice\"}'}")}
+  ${chalk_1.default.cyan("clefbase functions:logs greetUser")}          View execution history
+  ${chalk_1.default.cyan("clefbase functions:logs greetUser -l 50")}    View last 50 executions
+  ${chalk_1.default.cyan("clefbase functions:delete oldFunction")}      Delete a function
 `);
 program.parse(process.argv);
 // ─── Helper ───────────────────────────────────────────────────────────────────