kempo 4.2.39 → 4.3.0

package/middleware/kempo.js

@@ -6,6 +6,7 @@ import getSession from '../server/utils/auth/getSession.js';
 import currentUserHasPermission from '../server/utils/permissions/currentUserHasPermission.js';
 import { LEXICAL_BASE, bundleFileName as lexicalBundleFileName } from '../server/utils/lexical/packages.js';
 import { getEnabledExtensions } from '../server/utils/extensions/scopeCache.js';
+import { extensionAdminDirs, extensionPublicDirs } from '../server/utils/extensions/contentDirs.js';
 import triggerHook from '../server/utils/hooks/triggerHook.js';
 import { ADMIN_GLOBALS_DIR } from '../server/utils/admin-global-content/helpers.js';
 
@@ -112,7 +113,7 @@ const executeRouteFile = async (filePath, request, response, params = {}) => {
   extensions guard their own private pages. Rendering a page anywhere without this helper silently
   bypasses those guards.
 */
-const renderGuardedPage = async (pageFilePath, request, response, rootDir, resolveDir, params = {}, extraGlobalDirs = []) => {
+const renderGuardedPage = async (pageFilePath, request, response, rootDir, resolveDir, params = {}, extraGlobalDirs = [], extraFragmentDirs = []) => {
   try {
     await triggerHook('middleware:before_page', {
       url: request.url.split('?')[0],
@@ -127,7 +128,7 @@ const renderGuardedPage = async (pageFilePath, request, response, rootDir, resol
     return;
   }
 
-  const html = await renderExternalPage(pageFilePath, rootDir, resolveDir, {}, {}, 10, extraGlobalDirs);
+  const html = await renderExternalPage(pageFilePath, rootDir, resolveDir, {}, {}, 10, extraGlobalDirs, extraFragmentDirs);
   response.writeHead(200, { 'Content-Type': 'text/html; charset=utf-8' });
   response.end(html);
 };
@@ -145,16 +146,22 @@ const renderGuardedPage = async (pageFilePath, request, response, rootDir, resol
 */
 export const adminGlobalDirs = async () => [
   ADMIN_GLOBALS_DIR,
-  ...(await getEnabledExtensions()).map(ext => join(NODE_MODULES, ext.name, 'admin')),
+  ...await extensionAdminDirs(),
 ];
 
-const serveDir = async (dirPath, method, request, response, resolveDir, rootDir, params = {}, extraGlobalDirs = []) => {
+/*
+  Fragments an admin render may pull from extension packages. ADMIN_GLOBALS_DIR is deliberately not
+  here: it holds admin-authored global content and never fragments.
+*/
+export const adminFragmentDirs = () => extensionAdminDirs();
+
+const serveDir = async (dirPath, method, request, response, resolveDir, rootDir, params = {}, extraGlobalDirs = [], extraFragmentDirs = []) => {
   const candidates = [`${method}.js`, 'index.page.html', 'index.js', 'index.html', 'CATCH.js'];
   for(const candidate of candidates){
     const candidatePath = join(dirPath, candidate);
     try { await stat(candidatePath); } catch { continue; }
     if(candidate.endsWith('.page.html')){
-      await renderGuardedPage(candidatePath, request, response, rootDir, resolveDir, params, extraGlobalDirs);
+      await renderGuardedPage(candidatePath, request, response, rootDir, resolveDir, params, extraGlobalDirs, extraFragmentDirs);
       return true;
     }
     if(ROUTE_FILES.includes(candidate)){
@@ -271,9 +278,10 @@ export default config => {
         const segments = url.slice('/admin'.length).replace(/^\//, '').split('/').filter(Boolean);
         const resolveDir = buildResolveDir(ADMIN_ROOT, url);
         const globalDirs = await adminGlobalDirs();
+        const fragmentDirs = await adminFragmentDirs();
 
         if(segments.length === 0){
-          const served = await serveDir(ADMIN_ROOT, method, request, response, resolveDir, ADMIN_ROOT, {}, globalDirs);
+          const served = await serveDir(ADMIN_ROOT, method, request, response, resolveDir, ADMIN_ROOT, {}, globalDirs, fragmentDirs);
           if(served) return;
         } else {
           const walked = await walkDynamic(ADMIN_ROOT, segments);
@@ -283,12 +291,12 @@ export default config => {
             try { fileStat = await stat(filePath); } catch { /* not found */ }
 
             if(fileStat?.isDirectory()){
-              const served = await serveDir(filePath, method, request, response, resolveDir, ADMIN_ROOT, params, globalDirs);
+              const served = await serveDir(filePath, method, request, response, resolveDir, ADMIN_ROOT, params, globalDirs, fragmentDirs);
               if(served) return;
             } else if(fileStat?.isFile()){
               const name = filePath.split(/[/\\]/).pop();
               if(name.endsWith('.page.html')){
-                await renderGuardedPage(filePath, request, response, ADMIN_ROOT, resolveDir, params, globalDirs);
+                await renderGuardedPage(filePath, request, response, ADMIN_ROOT, resolveDir, params, globalDirs, fragmentDirs);
                 return;
               }
               if(ROUTE_FILES.includes(name)){
@@ -317,6 +325,7 @@ export default config => {
       const resolveDir = buildResolveDir(ADMIN_ROOT, url);
       const method = request.method?.toUpperCase() || 'GET';
       const globalDirs = await adminGlobalDirs();
+      const fragmentDirs = await adminFragmentDirs();
 
       const pageCandidates = subPath.endsWith('/')
         ? [join(adminDir, subPath, 'index.page.html')]
@@ -329,7 +338,7 @@ export default config => {
         try {
           await stat(pagePath);
         } catch { continue; }
-        await renderGuardedPage(pagePath, request, response, ADMIN_ROOT, resolveDir, {}, globalDirs);
+        await renderGuardedPage(pagePath, request, response, ADMIN_ROOT, resolveDir, {}, globalDirs, fragmentDirs);
         return;
       }
 
@@ -351,12 +360,12 @@ export default config => {
         let walkedStat;
         try { walkedStat = await stat(walkedPath); } catch { /* not found */ }
         if(walkedStat?.isDirectory()){
-          const served = await serveDir(walkedPath, method, request, response, resolveDir, ADMIN_ROOT, params, globalDirs);
+          const served = await serveDir(walkedPath, method, request, response, resolveDir, ADMIN_ROOT, params, globalDirs, fragmentDirs);
           if(served) return;
         } else if(walkedStat?.isFile()){
           const name = walkedPath.split(/[/\\]/).pop();
           if(name.endsWith('.page.html')){
-            await renderGuardedPage(walkedPath, request, response, ADMIN_ROOT, resolveDir, params, globalDirs);
+            await renderGuardedPage(walkedPath, request, response, ADMIN_ROOT, resolveDir, params, globalDirs, fragmentDirs);
             return;
           }
           if(ROUTE_FILES.includes(name)){
@@ -378,6 +387,12 @@ export default config => {
     */
     const extensions = await getEnabledExtensions();
 
+    /*
+      Resolved once for every public render below — an extension's own scoped pages, the consumer's
+      pages, and the 404 alike — so any enabled extension can contribute to any of them.
+    */
+    const publicContentDirs = await extensionPublicDirs();
+
     for(const ext of extensions){
       let pkgPath, pkg;
       try {
@@ -398,7 +413,7 @@ export default config => {
       const segments = subPath.replace(/^\//, '').split('/').filter(Boolean);
 
       if(segments.length === 0){
-        const served = await serveDir(publicDir, method, request, response, resolveDir, PROJECT_PUBLIC);
+        const served = await serveDir(publicDir, method, request, response, resolveDir, PROJECT_PUBLIC, {}, publicContentDirs, publicContentDirs);
         if(served) return;
         return next();
       }
@@ -410,12 +425,12 @@ export default config => {
         try { fileStat = await stat(filePath); } catch { /* not found */ }
 
         if(fileStat?.isDirectory()){
-          const served = await serveDir(filePath, method, request, response, resolveDir, PROJECT_PUBLIC, params);
+          const served = await serveDir(filePath, method, request, response, resolveDir, PROJECT_PUBLIC, params, publicContentDirs, publicContentDirs);
           if(served) return;
         } else if(fileStat?.isFile()){
           const name = filePath.split(/[/\\]/).pop();
           if(name.endsWith('.page.html')){
-            await renderGuardedPage(filePath, request, response, PROJECT_PUBLIC, resolveDir, params);
+            await renderGuardedPage(filePath, request, response, PROJECT_PUBLIC, resolveDir, params, publicContentDirs, publicContentDirs);
             return;
           }
           if(ROUTE_FILES.includes(name)){
@@ -448,7 +463,7 @@ export default config => {
 
       for(const pageFilePath of candidates){
         try { await stat(pageFilePath); } catch { continue; }
-        await renderGuardedPage(pageFilePath, request, response, PROJECT_PUBLIC, resolveDir);
+        await renderGuardedPage(pageFilePath, request, response, PROJECT_PUBLIC, resolveDir, {}, publicContentDirs, publicContentDirs);
         return;
       }
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "kempo",
-  "version": "4.2.39",
+  "version": "4.3.0",
   "type": "module",
   "description": "A fullstack CMS framework for creating websites with user authentication",
   "scripts": {
@@ -58,7 +58,7 @@
   },
   "peerDependencies": {
     "kempo-css": ">=2.2.5",
-    "kempo-server": ">=3.3.0",
+    "kempo-server": ">=3.4.0",
     "kempo-ui": ">=0.4.39"
   },
   "devDependencies": {

package/scripts/init-db.js

@@ -46,6 +46,8 @@ const DEFAULT_PERMISSIONS = [
   { name: 'system:extensions:uninstall', description: 'Uninstall extensions' },
   { name: 'system:extensions:manage', description: 'Enable and disable extensions' },
 
+  { name: 'system:realtime:read', description: 'View realtime connections and channels' },
+
   { name: 'system:admin:access', description: 'Access admin panel' },
 ];
 
@@ -66,7 +68,8 @@ const DEFAULT_GROUPS = {
       'system:menus:create', 'system:menus:read', 'system:menus:update', 'system:menus:delete',
       'system:fragments:read', 'system:fragments:create', 'system:fragments:update', 'system:fragments:delete',
       'system:globals:read', 'system:globals:create', 'system:globals:update', 'system:globals:delete',
-      'system:extensions:read', 'system:extensions:install', 'system:extensions:uninstall', 'system:extensions:manage'
+      'system:extensions:read', 'system:extensions:install', 'system:extensions:uninstall', 'system:extensions:manage',
+      'system:realtime:read'
     ]
   }
 };

package/server/db/schema.js

@@ -1,4 +1,4 @@
-import { pgTable, text, timestamp, boolean, index, jsonb } from 'drizzle-orm/pg-core';
+import { pgTable, text, timestamp, boolean, index, jsonb, bigserial, bigint } from 'drizzle-orm/pg-core';
 
 /*
   Auth Tables
@@ -114,6 +114,35 @@ export const extension = pgTable('extension', {
   updatedAt: timestamp('updatedAt').notNull(),
 });
 
+/*
+  Realtime System
+*/
+
+/*
+  A published message, kept only for channels that opt in to persistence. `id` is what a client
+  hands back as `since` to replay what it missed, so it must be ordered within a channel: publish
+  takes a per-channel lock, otherwise two rows could commit out of id order and a replay from the
+  earlier id would skip the later-committing one for good.
+*/
+export const realtimeMessage = pgTable('realtimeMessage', {
+  id: bigserial('id', { mode: 'number' }).primaryKey(),
+  channel: text('channel').notNull(),
+  data: jsonb('data').notNull(),
+  createdAt: timestamp('createdAt').notNull(),
+}, table => [
+  index('realtimeMessage_channel_id_idx').on(table.channel, table.id),
+  index('realtimeMessage_createdAt_idx').on(table.createdAt),
+]);
+
+/*
+  How far a channel has been pruned. Ids are shared across channels, so a gap cannot be inferred from
+  id arithmetic; a client whose `since` is below this watermark has provably missed messages.
+*/
+export const realtimeChannel = pgTable('realtimeChannel', {
+  channel: text('channel').primaryKey(),
+  prunedThrough: bigint('prunedThrough', { mode: 'number' }).notNull().default(0),
+});
+
 /*
   Triggers to prevent deletion of system resources
 */

package/server/sdk.js

@@ -196,3 +196,8 @@ export { default as listExtensions } from './utils/extensions/listExtensions.js'
 export { default as uninstallExtension } from './utils/extensions/uninstallExtension.js';
 export { default as updateExtension } from './utils/extensions/updateExtension.js';
 
+/*
+  Realtime
+*/
+
+export * as realtime from './utils/realtime/index.js';

package/server/utils/extensions/contentDirs.js

@@ -0,0 +1,27 @@
+import { join } from 'path';
+import { getEnabledExtensions } from './scopeCache.js';
+
+const NODE_MODULES = join(process.cwd(), 'node_modules');
+
+/*
+  The directories an enabled extension may contribute *.global.html and *.fragment.html from, split
+  by which half of the site is rendering: `admin/` for the admin portal, `public/` for the live site.
+
+  Each is read straight from the package at render time, the same way an extension's pages and
+  routes are resolved, so nothing is copied anywhere on install: enabling, disabling, upgrading or
+  removing an extension takes effect immediately, and there is nothing left behind to clean up.
+
+  That is also the whole of the on/off switch for this content — a disabled extension drops out of
+  these lists and its files are simply never read. There is no `enabled` flag on a packaged file the
+  way there is on admin-authored global content, because there is no stored row to carry one.
+
+  Lives here rather than in middleware/kempo.js so that server utils can reach it too — the 404 page
+  is rendered from server/utils/routing/serveUnmatched.js, and importing the middleware from there
+  would be circular.
+*/
+const extensionDirs = async sub =>
+  (await getEnabledExtensions()).map(ext => join(NODE_MODULES, ext.name, sub));
+
+export const extensionAdminDirs = () => extensionDirs('admin');
+
+export const extensionPublicDirs = () => extensionDirs('public');