npm - @knowcode/doc-builder - Versions diffs - 1.9.7 → 1.9.9 - Mend

@knowcode/doc-builder 1.9.7 → 1.9.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (7) hide show

package/doc-builder.config.js +78 -10
package/doc-builder.config.js.backup.1753793768283 +47 -0
package/doc-builder.config.js.backup.1753803964423 +114 -0
package/lib/config.js +17 -9
package/lib/core-builder.js +9 -9
package/lib/supabase-auth.js +18 -8
package/package.json +1 -1

package/doc-builder.config.js CHANGED Viewed

@@ -1,17 +1,42 @@
 module.exports = {
-  "configVersion": "1.9.6",
-  "siteName": "@knowcode/doc-builder",
-  "siteDescription": "Beautiful documentation with the least effort possible",
+  "configVersion": "1.9.8",
   "docsDir": "docs",
   "outputDir": "html",
-  "productionUrl": "https://doc-builder-delta.vercel.app",
+  "siteName": "@knowcode/doc-builder",
+  "siteDescription": "Beautiful documentation with the least effort possible",
+  "favicon": "✨",
   "features": {
     "authentication": false,
     "changelog": true,
     "mermaid": true,
+    "tooltips": true,
+    "search": false,
     "darkMode": true,
     "phosphorIcons": true,
-    "menuDefaultOpen": false
+    "phosphorWeight": "regular",
+    "phosphorSize": "1.2em",
+    "normalizeTitle": true,
+    "showPdfDownload": true,
+    "menuDefaultOpen": false,
+    "attachments": true,
+    "dynamicNavIcons": true,
+    "subtleColors": true,
+    "privateDirectoryAuth": false
+  },
+  "auth": {
+    "supabaseUrl": "https://xcihhnfcitjrwbynxmka.supabase.co",
+    "supabaseAnonKey": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZSIsInJlZiI6InhjaWhobmZjaXRqcndieW54bWthIiwicm9sZSI6ImFub24iLCJpYXQiOjE3NTM0Mzc2MzcsImV4cCI6MjA2OTAxMzYzN30.zvWp3JFIR8fBIiwuFF5gqOR_Kxb42baZS5fsBz60XOY"
+  },
+  "changelog": {
+    "daysBack": 14,
+    "enabled": true
+  },
+  "folderOrder": [],
+  "folderDescriptions": {},
+  "folderIcons": {},
+  "deployment": {
+    "platform": "vercel",
+    "outputDirectory": "html"
   },
   "seo": {
     "enabled": true,
@@ -26,13 +51,18 @@ module.exports = {
       "vercel",
       "notion-style"
     ],
-    "generateSitemap": true,
-    "generateRobotsTxt": true,
-    "ogImage": "/og-default.png",
+    "titleTemplate": "{pageTitle} | {siteName}",
+    "autoKeywords": true,
+    "keywordLimit": 7,
+    "descriptionFallback": "smart",
     "organization": {
       "name": "Knowcode Ltd",
-      "url": "https://knowcode.tech"
+      "url": "https://knowcode.tech",
+      "logo": ""
     },
+    "ogImage": "/og-default.png",
+    "generateSitemap": true,
+    "generateRobotsTxt": true,
     "customMetaTags": [
       {
         "name": "google-site-verification",
@@ -43,5 +73,43 @@ module.exports = {
         "content": "B2D8C4C12C530D47AA962B24CAA09630"
       }
     ]
-  }
+  },
+  "attachmentTypes": [
+    ".pdf",
+    ".doc",
+    ".docx",
+    ".xls",
+    ".xlsx",
+    ".csv",
+    ".ppt",
+    ".pptx",
+    ".txt",
+    ".rtf",
+    ".html",
+    ".htm",
+    ".zip",
+    ".tar",
+    ".gz",
+    ".7z",
+    ".rar",
+    ".png",
+    ".jpg",
+    ".jpeg",
+    ".gif",
+    ".svg",
+    ".webp",
+    ".ico",
+    ".bmp",
+    ".json",
+    ".xml",
+    ".yaml",
+    ".yml",
+    ".toml",
+    ".mp4",
+    ".mp3",
+    ".wav",
+    ".avi",
+    ".mov"
+  ],
+  "productionUrl": "https://doc-builder-delta.vercel.app"
 };

package/doc-builder.config.js.backup.1753793768283 ADDED Viewed

@@ -0,0 +1,47 @@
+module.exports = {
+  "configVersion": "1.9.6",
+  "siteName": "@knowcode/doc-builder",
+  "siteDescription": "Beautiful documentation with the least effort possible",
+  "docsDir": "docs",
+  "outputDir": "html",
+  "productionUrl": "https://doc-builder-delta.vercel.app",
+  "features": {
+    "authentication": false,
+    "changelog": true,
+    "mermaid": true,
+    "darkMode": true,
+    "phosphorIcons": true,
+    "menuDefaultOpen": false
+  },
+  "seo": {
+    "enabled": true,
+    "siteUrl": "https://doc-builder-delta.vercel.app",
+    "author": "Lindsay Smith",
+    "twitterHandle": "@planbbackups",
+    "language": "en-US",
+    "keywords": [
+      "documentation",
+      "markdown",
+      "static site generator",
+      "vercel",
+      "notion-style"
+    ],
+    "generateSitemap": true,
+    "generateRobotsTxt": true,
+    "ogImage": "/og-default.png",
+    "organization": {
+      "name": "Knowcode Ltd",
+      "url": "https://knowcode.tech"
+    },
+    "customMetaTags": [
+      {
+        "name": "google-site-verification",
+        "content": "FtzcDTf5BQ9K5EfnGazQkgU2U4FiN3ITzM7gHwqUAqQ"
+      },
+      {
+        "name": "msvalidate.01",
+        "content": "B2D8C4C12C530D47AA962B24CAA09630"
+      }
+    ]
+  }
+};

package/doc-builder.config.js.backup.1753803964423 ADDED Viewed

@@ -0,0 +1,114 @@
+module.exports = {
+  "configVersion": "1.9.7",
+  "docsDir": "docs",
+  "outputDir": "html",
+  "siteName": "@knowcode/doc-builder",
+  "siteDescription": "Beautiful documentation with the least effort possible",
+  "favicon": "✨",
+  "features": {
+    "authentication": false,
+    "changelog": true,
+    "mermaid": true,
+    "tooltips": true,
+    "search": false,
+    "darkMode": true,
+    "phosphorIcons": true,
+    "phosphorWeight": "regular",
+    "phosphorSize": "1.2em",
+    "normalizeTitle": true,
+    "showPdfDownload": true,
+    "menuDefaultOpen": false,
+    "attachments": true,
+    "dynamicNavIcons": true,
+    "subtleColors": true
+  },
+  "auth": {
+    "supabaseUrl": "https://xcihhnfcitjrwbynxmka.supabase.co",
+    "supabaseAnonKey": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZSIsInJlZiI6InhjaWhobmZjaXRqcndieW54bWthIiwicm9sZSI6ImFub24iLCJpYXQiOjE3NTM0Mzc2MzcsImV4cCI6MjA2OTAxMzYzN30.zvWp3JFIR8fBIiwuFF5gqOR_Kxb42baZS5fsBz60XOY"
+  },
+  "changelog": {
+    "daysBack": 14,
+    "enabled": true
+  },
+  "folderOrder": [],
+  "folderDescriptions": {},
+  "folderIcons": {},
+  "deployment": {
+    "platform": "vercel",
+    "outputDirectory": "html"
+  },
+  "seo": {
+    "enabled": true,
+    "siteUrl": "https://doc-builder-delta.vercel.app",
+    "author": "Lindsay Smith",
+    "twitterHandle": "@planbbackups",
+    "language": "en-US",
+    "keywords": [
+      "documentation",
+      "markdown",
+      "static site generator",
+      "vercel",
+      "notion-style"
+    ],
+    "titleTemplate": "{pageTitle} | {siteName}",
+    "autoKeywords": true,
+    "keywordLimit": 7,
+    "descriptionFallback": "smart",
+    "organization": {
+      "name": "Knowcode Ltd",
+      "url": "https://knowcode.tech",
+      "logo": ""
+    },
+    "ogImage": "/og-default.png",
+    "generateSitemap": true,
+    "generateRobotsTxt": true,
+    "customMetaTags": [
+      {
+        "name": "google-site-verification",
+        "content": "FtzcDTf5BQ9K5EfnGazQkgU2U4FiN3ITzM7gHwqUAqQ"
+      },
+      {
+        "name": "msvalidate.01",
+        "content": "B2D8C4C12C530D47AA962B24CAA09630"
+      }
+    ]
+  },
+  "attachmentTypes": [
+    ".pdf",
+    ".doc",
+    ".docx",
+    ".xls",
+    ".xlsx",
+    ".csv",
+    ".ppt",
+    ".pptx",
+    ".txt",
+    ".rtf",
+    ".html",
+    ".htm",
+    ".zip",
+    ".tar",
+    ".gz",
+    ".7z",
+    ".rar",
+    ".png",
+    ".jpg",
+    ".jpeg",
+    ".gif",
+    ".svg",
+    ".webp",
+    ".ico",
+    ".bmp",
+    ".json",
+    ".xml",
+    ".yaml",
+    ".yml",
+    ".toml",
+    ".mp4",
+    ".mp3",
+    ".wav",
+    ".avi",
+    ".mov"
+  ],
+  "productionUrl": "https://doc-builder-delta.vercel.app"
+};

package/lib/config.js CHANGED Viewed

@@ -38,7 +38,8 @@ const defaultConfig = {
     menuDefaultOpen: true,     // Menu/sidebar open by default
     attachments: true,         // Copy attachments (Excel, PDF, etc.) to output
     dynamicNavIcons: true,     // Use status-based icons in navigation
-    subtleColors: true         // Apply subtle colors to status icons
+    subtleColors: true,        // Apply subtle colors to status icons
+    privateDirectoryAuth: false // Enable auth for private directories only (auto-detected)
   },
   // Authentication - Supabase only (basic auth removed for security)
@@ -375,7 +376,10 @@ async function loadConfig(configPath, options = {}) {
       console.warn(chalk.yellow(`Warning: Failed to load config file: ${error.message}`));
     }
   } else if (!options.preset && !options.legacy) {
-    console.log(chalk.gray('No config file found, using defaults'));
+    console.log(chalk.gray('No config file found, creating default config...'));
+    // Create default config file with all settings
+    await saveConfig(customConfigPath, config);
+    console.log(chalk.green(`✅ Created ${configPath} with default settings`));
   }
   // Apply CLI options (these override config file)
@@ -424,15 +428,19 @@ async function loadConfig(configPath, options = {}) {
     }
     // Don't throw error - let commands handle missing directories appropriately
   } else {
-    // Check for private directory and auto-enable authentication if found
+    // Check for private directory to inform user about authentication options
     const privatePath = path.join(docsPath, 'private');
     if (fs.existsSync(privatePath) && fs.statSync(privatePath).isDirectory()) {
-      // Auto-enable authentication when private directory exists
-      // This overrides any config setting to ensure private directories are always protected
-      console.log(chalk.blue('🔐 Found private directory - automatically enabling Supabase authentication'));
-      config.features.authentication = 'supabase';
-      config.features.autoAuthEnabled = true; // Track that this was auto-enabled
-      console.log(chalk.yellow('   Note: Grant users access by adding domain to the docbuilder_access table'));
+      if (config.features.authentication === 'supabase') {
+        console.log(chalk.blue('🔐 Found private directory - global Supabase authentication is enabled'));
+        console.log(chalk.yellow('   Note: Grant users access by adding domain to the docbuilder_access table'));
+      } else {
+        console.log(chalk.blue('🔐 Found private directory - will be protected with Supabase authentication'));
+        console.log(chalk.gray('   Public pages remain accessible, only /private/ pages require login'));
+        console.log(chalk.yellow('   Note: Grant users access by adding domain to the docbuilder_access table'));
+        // Set a flag to indicate private directory authentication is needed
+        config.features.privateDirectoryAuth = true;
+      }
     }
   }

package/lib/core-builder.js CHANGED Viewed

@@ -452,7 +452,7 @@ ${seoTags}
     <!-- Styles -->
     <link rel="stylesheet" href="/css/notion-style.css">
-    ${config.features?.authentication === 'supabase' ? `
+    ${(config.features?.authentication === 'supabase' || config.features?.privateDirectoryAuth === true) ? `
     <!-- Hide content until auth check -->
     <style>
       body {
@@ -510,7 +510,7 @@ ${seoTags}
                     })} UTC</span>
                 </div>
-                ${config.features?.authentication === 'supabase' ? `
+                ${(config.features?.authentication === 'supabase' || config.features?.privateDirectoryAuth === true) ? `
                 <a href="${relativePath}login.html" class="auth-btn" title="Login/Logout">
                     <i class="fas fa-sign-in-alt"></i>
                 </a>
@@ -578,7 +578,7 @@ ${seoTags}
     };
     </script>
     <script src="/js/main.js"></script>
-    ${config.features?.authentication === 'supabase' ? `<script src="https://unpkg.com/@supabase/supabase-js@2"></script>
+    ${(config.features?.authentication === 'supabase' || config.features?.privateDirectoryAuth === true) ? `<script src="https://unpkg.com/@supabase/supabase-js@2"></script>
     <script src="/js/auth.js"></script>` : ''}
 </body>
 </html>`;
@@ -609,8 +609,8 @@ const folderDescriptions = {
 function buildNavigationStructure(files, currentFile, config = {}) {
   const tree = { files: [], folders: {} };
-  // Check if authentication is enabled
-  const isAuthEnabled = config.features?.authentication === 'supabase';
+  // Check if authentication is enabled (either global or private directory)
+  const isAuthEnabled = config.features?.authentication === 'supabase' || config.features?.privateDirectoryAuth === true;
   // Include all files in navigation - we'll use CSS to show/hide based on auth state
   files.forEach(file => {
@@ -1014,8 +1014,8 @@ async function buildDocumentation(config) {
   if (fs.existsSync(jsSource)) {
     await fs.copy(jsSource, path.join(outputDir, 'js'), { overwrite: true });
-    // Generate Supabase auth script if authentication is enabled
-    if (config.features?.authentication === 'supabase') {
+    // Generate Supabase auth script if authentication is needed (global or private directory)
+    if (config.features?.authentication === 'supabase' || config.features?.privateDirectoryAuth === true) {
       await generateSupabaseAuthFiles(outputDir, config);
     }
   }
@@ -1155,7 +1155,7 @@ async function buildDocumentation(config) {
     // Generate robots.txt if enabled
     if (config.seo.generateRobotsTxt) {
       await generateRobotsTxt(config.seo.siteUrl, outputDir, {
-        hasAuthentication: config.features?.authentication === 'supabase'
+        hasAuthentication: config.features?.authentication === 'supabase' || config.features?.privateDirectoryAuth === true
       });
     }
   }
@@ -1326,7 +1326,7 @@ async function generateSupabaseAuthFiles(outputDir, config) {
   const supabaseAuth = new SupabaseAuth(authConfig);
   // Generate auth script and save to js/auth.js
-  const authScript = supabaseAuth.generateAuthScript();
+  const authScript = supabaseAuth.generateAuthScript(config);
   await fs.writeFile(path.join(outputDir, 'js', 'auth.js'), authScript);
   // Also copy to root for backward compatibility

package/lib/supabase-auth.js CHANGED Viewed

@@ -26,7 +26,7 @@ class SupabaseAuth {
   /**
    * Generate client-side auth script for inclusion in HTML pages
    */
-  generateAuthScript() {
+  generateAuthScript(fullConfig) {
     return `
 /**
  * Supabase Authentication for Documentation Site
@@ -56,6 +56,10 @@ class SupabaseAuth {
     // Check authentication and site access
     async function checkAuth() {
         try {
+            // Check authentication mode
+            const isGlobalAuthEnabled = ${fullConfig.features?.authentication === 'supabase'};
+            const isPrivateDirectoryAuthEnabled = ${fullConfig.features?.privateDirectoryAuth === true};
             // Check if current page is in private directory
             const currentPath = window.location.pathname;
             const isPrivatePage = currentPath.includes('/private/');
@@ -64,11 +68,11 @@ class SupabaseAuth {
             const { data: { user }, error: userError } = await supabaseClient.auth.getUser();
             if (userError || !user) {
-                // Only redirect if we're on a private page
-                if (isPrivatePage) {
+                // Redirect if global auth is enabled OR if we're on a private page with private auth enabled
+                if (isGlobalAuthEnabled || (isPrivateDirectoryAuthEnabled && isPrivatePage)) {
                     redirectToLogin();
                 } else {
-                    // Public page, just show it
+                    // Public page (no global auth and either no private auth or not on private page)
                     document.body.classList.add('authenticated'); // Use same class to show body
                     updateAuthButton(false);
                 }
@@ -84,7 +88,7 @@ class SupabaseAuth {
                 .single();
             if (accessError || !access) {
-                if (isPrivatePage) {
+                if (isGlobalAuthEnabled || (isPrivateDirectoryAuthEnabled && isPrivatePage)) {
                     showAccessDenied();
                 } else {
                     // Public page, show it but don't grant private navigation access
@@ -94,15 +98,21 @@ class SupabaseAuth {
                 return;
             }
-            // User is authenticated and has domain access - grant full access including private nav
+            // User is authenticated and has domain access - grant appropriate access
             console.log('User authenticated and authorized');
             document.body.classList.add('authenticated');
-            document.body.classList.add('has-private-access'); // Grant private navigation access
+            // Grant private navigation access if private directory auth is enabled
+            if (isPrivateDirectoryAuthEnabled || isGlobalAuthEnabled) {
+                document.body.classList.add('has-private-access');
+            }
             updateAuthButton(true);
         } catch (error) {
             console.error('Auth check failed:', error);
-            if (window.location.pathname.includes('/private/')) {
+            const isPrivatePage = window.location.pathname.includes('/private/');
+            if (isGlobalAuthEnabled || (isPrivateDirectoryAuthEnabled && isPrivatePage)) {
                 redirectToLogin();
             } else {
                 // Public page, show it anyway

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@knowcode/doc-builder",
-  "version": "1.9.7",
+  "version": "1.9.9",
   "description": "Reusable documentation builder for markdown-based sites with Vercel deployment support",
   "main": "index.js",
   "bin": {