clefbase 1.2.1 → 1.2.3

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

@@ -4,6 +4,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.runInit = runInit;
+exports.scaffoldLib = scaffoldLib;
 const path_1 = __importDefault(require("path"));
 const fs_1 = __importDefault(require("fs"));
 const chalk_1 = __importDefault(require("chalk"));
@@ -93,25 +94,130 @@ async function runInit(cwd = process.cwd()) {
     if (cfg.services.hosting) {
         await setupHosting(cfg, cwd);
     }
-    // ── Step 5: Write config files ────────────────────────────────────────────
+    // ── Step 5: Write root config files ──────────────────────────────────────
     const configPath = (0, config_1.saveConfig)(cfg, cwd);
     (0, config_1.ensureGitignore)(cwd);
     (0, config_1.writeEnvExample)(cfg, cwd);
+    // ── Step 6: Scaffold src/lib ──────────────────────────────────────────────
+    const libResult = scaffoldLib(cfg, cwd);
+    // ── Done ──────────────────────────────────────────────────────────────────
     console.log();
     console.log(chalk_1.default.green.bold("  ✓ Project initialised!"));
     console.log();
-    console.log(chalk_1.default.dim(`  Config:      ${path_1.default.relative(cwd, configPath)}`));
-    console.log(chalk_1.default.dim("  Secrets:     clefbase.json has been added to .gitignore"));
-    console.log(chalk_1.default.dim("  Env example: .env.example created"));
+    console.log(chalk_1.default.dim(`  Config:        ${path_1.default.relative(cwd, configPath)}`));
+    console.log(chalk_1.default.dim("  Secrets:       clefbase.json has been added to .gitignore"));
+    console.log(chalk_1.default.dim("  Env example:   .env.example created"));
+    if (libResult) {
+        console.log(chalk_1.default.dim(`  Lib config:    ${libResult.configCopy}`));
+        console.log(chalk_1.default.dim(`  Lib entry:     ${libResult.libFile}`));
+    }
     console.log();
     printUsageHint(cfg);
 }
+/**
+ * Writes two files into `<cwd>/src/lib/`:
+ *   • clefbase.json  — a copy of the project config (secrets stripped for safety)
+ *   • 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.
+ */
+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) ─────────────────────────
+    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 } : {}),
+    };
+    const configCopyAbs = path_1.default.join(libDir, "clefbase.json");
+    fs_1.default.writeFileSync(configCopyAbs, JSON.stringify(publicCfg, null, 2) + "\n");
+    // ── 2. clefBase.ts ────────────────────────────────────────────────────────
+    const libFileAbs = path_1.default.join(libDir, "clefBase.ts");
+    fs_1.default.writeFileSync(libFileAbs, buildLibTs(cfg));
+    return {
+        configCopy: path_1.default.relative(cwd, configCopyAbs),
+        libFile: path_1.default.relative(cwd, libFileAbs),
+    };
+}
+/** Build the content of src/lib/clefBase.ts based on enabled services. */
+function buildLibTs(cfg) {
+    const { database, auth, storage } = cfg.services;
+    // Collect SDK imports
+    const sdkImports = ["initClefbase"];
+    if (database)
+        sdkImports.push("getDatabase");
+    if (auth)
+        sdkImports.push("getAuth");
+    if (storage)
+        sdkImports.push("getStorage");
+    // Collect type imports
+    const typeImports = [];
+    if (database)
+        typeImports.push("Database");
+    if (auth)
+        typeImports.push("Auth");
+    if (storage)
+        typeImports.push("ClefbaseStorage");
+    const lines = [
+        `/**`,
+        ` * Clefbase — pre-initialised service exports`,
+        ` *`,
+        ` * Usage:`,
+        ` *   import { db, auth, storage } from "@lib/clefBase";`,
+        ` *   import db from "@lib/clefBase";`,
+        ` */`,
+        ``,
+        `import { ${sdkImports.join(", ")} } from "clefbase";`,
+        ...(typeImports.length > 0
+            ? [`import type { ${typeImports.join(", ")} } from "clefbase";`]
+            : []),
+        `import config from "./clefbase.json";`,
+        ``,
+        `// ─── App ─────────────────────────────────────────────────────────────────────`,
+        ``,
+        `const app = initClefbase({`,
+        `  serverUrl:   config.serverUrl,`,
+        `  projectId:   config.projectId,`,
+        `  apiKey:      config.apiKey,`,
+        `  adminSecret: "",`,
+        `});`,
+        ``,
+    ];
+    // ── Service instances ──────────────────────────────────────────────────────
+    if (database || auth || storage) {
+        lines.push("// ─── Services ───────────────────────────────────────────────────────────────");
+        lines.push("");
+    }
+    if (database) {
+        lines.push(`/** Clefbase Database — query and mutate documents. */`);
+        lines.push(`export const db: Database = getDatabase(app);`);
+        lines.push("");
+    }
+    if (auth) {
+        lines.push(`/** Clefbase Auth — sign up, sign in, manage sessions. */`);
+        lines.push(`export const auth: Auth = getAuth(app);`);
+        lines.push("");
+    }
+    if (storage) {
+        lines.push(`/** Clefbase Storage — upload and manage files. */`);
+        lines.push(`export const storage: ClefbaseStorage = getStorage(app);`);
+        lines.push("");
+    }
+    // ── Re-export app for advanced use ────────────────────────────────────────
+    lines.push(`// ─── Advanced ────────────────────────────────────────────────────────────────`, ``, `/** The underlying ClefbaseApp instance (for advanced use). */`, `export { app };`, ``);
+    lines.push("");
+    return lines.join("\n");
+}
 // ─── Hosting sub-flow ─────────────────────────────────────────────────────────
 async function setupHosting(cfg, cwd) {
     console.log();
     console.log(chalk_1.default.bold("  Hosting"));
     console.log();
-    // Fetch existing sites
     let existing = [];
     const siteSpinner = (0, ora_1.default)("Fetching existing sites…").start();
     try {
@@ -191,35 +297,37 @@ function guessDistDir(cwd) {
     return "dist";
 }
 function printUsageHint(cfg) {
-    const imports = ["initClefbase"];
+    const namedImports = [];
     if (cfg.services.database)
-        imports.push("getDatabase");
+        namedImports.push("db");
     if (cfg.services.auth)
-        imports.push("getAuth");
+        namedImports.push("auth");
     if (cfg.services.storage)
-        imports.push("getStorage");
-    if (cfg.services.hosting)
-        imports.push("getHosting");
+        namedImports.push("storage");
     console.log(chalk_1.default.bold("  Quick start:"));
     console.log();
-    console.log(chalk_1.default.cyan(`  import { ${imports.join(", ")} } from "clefbase";`));
-    console.log(chalk_1.default.cyan(`  import config from "./clefbase.json";`));
-    console.log();
-    console.log(chalk_1.default.cyan(`  const app = initClefbase(config);`));
+    if (namedImports.length > 0) {
+        console.log(chalk_1.default.cyan(`  import { ${namedImports.join(", ")} } from "@lib/clefBase";`));
+    }
+    else {
+        console.log(chalk_1.default.cyan(`  import app from "@lib/clefBase";`));
+    }
     if (cfg.services.database) {
         console.log();
-        console.log(chalk_1.default.cyan(`  const db   = getDatabase(app);`));
         console.log(chalk_1.default.cyan(`  const docs = await db.collection("items").getDocs();`));
     }
     if (cfg.services.auth) {
         console.log();
-        console.log(chalk_1.default.cyan(`  const auth = getAuth(app);`));
         console.log(chalk_1.default.cyan(`  const { user } = await auth.signIn("email", "pass");`));
     }
+    if (cfg.services.storage) {
+        console.log();
+        console.log(chalk_1.default.cyan(`  await storage.ref("uploads/photo.jpg").upload(file);`));
+    }
     if (cfg.services.hosting && cfg.hosting) {
         console.log();
         console.log(chalk_1.default.bold("  Deploy:"));
-        console.log(chalk_1.default.cyan(`  $ npm run build && clefbase deploy`));
+        console.log(chalk_1.default.cyan(`  $ npm run build && npx clefbase deploy`));
         console.log(chalk_1.default.dim(`  Site: ${cfg.serverUrl}/hosted/${cfg.projectId}/${cfg.hosting.siteId}`));
     }
     console.log();

package/dist/cli.js

@@ -33903,15 +33903,102 @@ async function runInit(cwd = process.cwd()) {
   const configPath = saveConfig(cfg, cwd);
   ensureGitignore(cwd);
   writeEnvExample(cfg, cwd);
+  const libResult = scaffoldLib(cfg, cwd);
   console.log();
   console.log(source_default.green.bold("  \u2713 Project initialised!"));
   console.log();
-  console.log(source_default.dim(`  Config:      ${import_path2.default.relative(cwd, configPath)}`));
-  console.log(source_default.dim("  Secrets:     clefbase.json has been added to .gitignore"));
-  console.log(source_default.dim("  Env example: .env.example created"));
+  console.log(source_default.dim(`  Config:        ${import_path2.default.relative(cwd, configPath)}`));
+  console.log(source_default.dim("  Secrets:       clefbase.json has been added to .gitignore"));
+  console.log(source_default.dim("  Env example:   .env.example created"));
+  if (libResult) {
+    console.log(source_default.dim(`  Lib config:    ${libResult.configCopy}`));
+    console.log(source_default.dim(`  Lib entry:     ${libResult.libFile}`));
+  }
   console.log();
   printUsageHint(cfg);
 }
+function scaffoldLib(cfg, cwd = process.cwd()) {
+  const libDir = import_path2.default.join(cwd, "src", "lib");
+  import_fs3.default.mkdirSync(libDir, { recursive: true });
+  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 } : {}
+  };
+  const configCopyAbs = import_path2.default.join(libDir, "clefbase.json");
+  import_fs3.default.writeFileSync(configCopyAbs, JSON.stringify(publicCfg, null, 2) + "\n");
+  const libFileAbs = import_path2.default.join(libDir, "clefBase.ts");
+  import_fs3.default.writeFileSync(libFileAbs, buildLibTs(cfg));
+  return {
+    configCopy: import_path2.default.relative(cwd, configCopyAbs),
+    libFile: import_path2.default.relative(cwd, libFileAbs)
+  };
+}
+function buildLibTs(cfg) {
+  const { database, auth, storage } = cfg.services;
+  const sdkImports = ["initClefbase"];
+  if (database) sdkImports.push("getDatabase");
+  if (auth) sdkImports.push("getAuth");
+  if (storage) sdkImports.push("getStorage");
+  const typeImports = [];
+  if (database) typeImports.push("Database");
+  if (auth) typeImports.push("Auth");
+  if (storage) typeImports.push("ClefbaseStorage");
+  const lines = [
+    `/**`,
+    ` * Clefbase \u2014 pre-initialised service exports`,
+    ` *`,
+    ` * Usage:`,
+    ` *   import { db, auth, storage } from "@lib/clefBase";`,
+    ` *   import db from "@lib/clefBase";`,
+    ` */`,
+    ``,
+    `import { ${sdkImports.join(", ")} } from "clefbase";`,
+    ...typeImports.length > 0 ? [`import type { ${typeImports.join(", ")} } from "clefbase";`] : [],
+    `import config from "./clefbase.json";`,
+    ``,
+    `// \u2500\u2500\u2500 App \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500`,
+    ``,
+    `const app = initClefbase({`,
+    `  serverUrl:   config.serverUrl,`,
+    `  projectId:   config.projectId,`,
+    `  apiKey:      config.apiKey,`,
+    `  adminSecret: "",`,
+    `});`,
+    ``
+  ];
+  if (database || auth || storage) {
+    lines.push("// \u2500\u2500\u2500 Services \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500");
+    lines.push("");
+  }
+  if (database) {
+    lines.push(`/** Clefbase Database \u2014 query and mutate documents. */`);
+    lines.push(`export const db: Database = getDatabase(app);`);
+    lines.push("");
+  }
+  if (auth) {
+    lines.push(`/** Clefbase Auth \u2014 sign up, sign in, manage sessions. */`);
+    lines.push(`export const auth: Auth = getAuth(app);`);
+    lines.push("");
+  }
+  if (storage) {
+    lines.push(`/** Clefbase Storage \u2014 upload and manage files. */`);
+    lines.push(`export const storage: ClefbaseStorage = getStorage(app);`);
+    lines.push("");
+  }
+  lines.push(
+    `// \u2500\u2500\u2500 Advanced \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500`,
+    ``,
+    `/** The underlying ClefbaseApp instance (for advanced use). */`,
+    `export { app };`,
+    ``
+  );
+  lines.push("");
+  return lines.join("\n");
+}
 async function setupHosting(cfg, cwd) {
   var _a;
   console.log();
@@ -33992,31 +34079,35 @@ function guessDistDir(cwd) {
   return "dist";
 }
 function printUsageHint(cfg) {
-  const imports = ["initClefbase"];
-  if (cfg.services.database) imports.push("getDatabase");
-  if (cfg.services.auth) imports.push("getAuth");
-  if (cfg.services.storage) imports.push("getStorage");
-  if (cfg.services.hosting) imports.push("getHosting");
+  const namedImports = [];
+  if (cfg.services.database) namedImports.push("db");
+  if (cfg.services.auth) namedImports.push("auth");
+  if (cfg.services.storage) namedImports.push("storage");
   console.log(source_default.bold("  Quick start:"));
   console.log();
-  console.log(source_default.cyan(`  import { ${imports.join(", ")} } from "clefbase";`));
-  console.log(source_default.cyan(`  import config from "./clefbase.json";`));
-  console.log();
-  console.log(source_default.cyan(`  const app = initClefbase(config);`));
+  if (namedImports.length > 0) {
+    console.log(
+      source_default.cyan(`  import { ${namedImports.join(", ")} } from "@lib/clefBase";`)
+    );
+  } else {
+    console.log(source_default.cyan(`  import app from "@lib/clefBase";`));
+  }
   if (cfg.services.database) {
     console.log();
-    console.log(source_default.cyan(`  const db   = getDatabase(app);`));
     console.log(source_default.cyan(`  const docs = await db.collection("items").getDocs();`));
   }
   if (cfg.services.auth) {
     console.log();
-    console.log(source_default.cyan(`  const auth = getAuth(app);`));
     console.log(source_default.cyan(`  const { user } = await auth.signIn("email", "pass");`));
   }
+  if (cfg.services.storage) {
+    console.log();
+    console.log(source_default.cyan(`  await storage.ref("uploads/photo.jpg").upload(file);`));
+  }
   if (cfg.services.hosting && cfg.hosting) {
     console.log();
     console.log(source_default.bold("  Deploy:"));
-    console.log(source_default.cyan(`  $ npm run build && clefbase deploy`));
+    console.log(source_default.cyan(`  $ npm run build && npx clefbase deploy`));
     console.log(source_default.dim(`  Site: ${cfg.serverUrl}/hosted/${cfg.projectId}/${cfg.hosting.siteId}`));
   }
   console.log();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "clefbase",
-  "version": "1.2.1",
+  "version": "1.2.3",
   "description": "Firebase-style SDK and CLI for Clefbase — database, auth, storage, and hosting",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",