@crombolo/server 0.12.1 → 0.13.2

package/src/config.ts

@@ -272,6 +272,16 @@ export interface CromboloConfig {
    * deploy turns it off, and an install can decline it for itself.
    */
   applyBundleContentOnInstall: boolean
+  /**
+   * Whether the Packages section may install and remove packages on the running
+   * site (`bun add` on the node that served the request). Off, the Marketplace
+   * still lists packages and says to add them to `package.json` and deploy:
+   * what a site of several nodes, or of containers that start afresh, needs —
+   * an install there reaches one node and is lost at its next restart. On unless
+   * set, or unless a schema store is configured, which says the same thing
+   * about the nodes' disks. `CROMBOLO_RUNTIME_INSTALLS`.
+   */
+  runtimeInstalls: boolean
   /**
    * Where the Packages section's Marketplace sends someone browsing for
    * extensions. Never framed — npm refuses to be framed — so the native view
@@ -495,6 +505,8 @@ export function loadConfig(
     redirects: [],
     trackRedirects: Bun.env.CROMBOLO_TRACK_REDIRECTS !== 'false',
     applyBundleContentOnInstall: Bun.env.CROMBOLO_APPLY_BUNDLE_CONTENT !== 'false',
+    // Resolved again below, once it is known whether a store was configured.
+    runtimeInstalls: Bun.env.CROMBOLO_RUNTIME_INSTALLS !== 'false',
     seo: stripUndefined({
       sitemap: envFlag(Bun.env.CROMBOLO_SITEMAP),
       indexable: envFlag(Bun.env.CROMBOLO_INDEXABLE),
@@ -533,6 +545,15 @@ export function loadConfig(
   ) {
     merged.schemaWritable = true
   }
+  // Likewise a store says the nodes' disks do not last, so an install on one of
+  // them would not either. An explicit setting still wins.
+  if (
+    merged.schemaStore &&
+    Bun.env.CROMBOLO_RUNTIME_INSTALLS === undefined &&
+    overrides.runtimeInstalls === undefined
+  ) {
+    merged.runtimeInstalls = false
+  }
   // Relative paths are relative to the site, not to wherever the process started.
   merged.siteDir = resolve(cwd, merged.siteDir)
   // Against the site rather than the working directory: it has to sit where the
@@ -597,4 +618,4 @@ export function describeDatabase(
   }
 }
 
-export const VERSION = '0.12.1'
+export const VERSION = '0.13.2'

package/src/marketplace.ts

@@ -17,6 +17,7 @@
  * browser cannot reach npm, and the backoffice keeps making same-origin
  * requests only.
  */
+import { readFileSync } from 'node:fs'
 import { join } from 'node:path'
 import {
   type BundlePackage,
@@ -57,6 +58,10 @@ export interface InstalledListing {
   wired: boolean
   /** The version whose content was applied here, or null when none has been. */
   contentApplied: string | null
+  /** What the package says it is, from its `package.json`; empty when it says nothing. */
+  description: string
+  /** The crombolo releases it is written for. */
+  peerRange: string
 }
 
 /** What became of the content half of an install. */
@@ -88,6 +93,11 @@ export interface MarketplaceOptions {
   applyContent?: (packageName: string) => Promise<ContentOutcome>
   /** The site's `applyBundleContentOnInstall`. */
   applyContentOnInstall?: boolean
+  /**
+   * False refuses installing and removing here: the dependency belongs in
+   * `package.json` and a deploy, so every node has it and it outlives a restart.
+   */
+  installs?: boolean
 }
 
 export interface InstallOutcome {
@@ -303,11 +313,14 @@ export function createMarketplace(options: MarketplaceOptions): Marketplace {
           carries: bundle.carries,
           wired: wired.has(bundle.id),
           contentApplied: (await options.contentApplied?.(bundle.packageName)) ?? null,
+          description: descriptionOf(bundle.directory),
+          peerRange: bundle.peerRange,
         })),
       )
     },
 
     async install(name, version, request = {}) {
+      if (options.installs === false) return refusedHere(name, 'add')
       if (!isValidPackageName(name))
         return { ok: false, message: `'${name}' is not a package name npm would accept.` }
       if (version !== undefined && !isValidVersion(version))
@@ -365,6 +378,7 @@ export function createMarketplace(options: MarketplaceOptions): Marketplace {
     },
 
     async uninstall(name) {
+      if (options.installs === false) return refusedHere(name, 'remove')
       if (!isValidPackageName(name))
         return { ok: false, message: `'${name}' is not a package name npm would accept.` }
       const result = await install('remove', name, options.siteDir)
@@ -379,4 +393,27 @@ export function createMarketplace(options: MarketplaceOptions): Marketplace {
   }
 }
 
+/** A package's own description, read leniently: anything unreadable is none. */
+function descriptionOf(directory: string): string {
+  try {
+    const json = JSON.parse(readFileSync(join(directory, 'package.json'), 'utf8')) as {
+      description?: unknown
+    }
+    return typeof json.description === 'string' ? json.description : ''
+  } catch {
+    return ''
+  }
+}
+
+/** What a site that does not install at runtime says instead, with what to do. */
+function refusedHere(name: string, verb: 'add' | 'remove'): InstallOutcome {
+  return {
+    ok: false,
+    message:
+      verb === 'add'
+        ? `Packages are not installed from the backoffice on this site. Add ${name} to the site's package.json (bun add ${name}) and deploy, so every server has it.`
+        : `Packages are not removed from the backoffice on this site. Remove ${name} from the site's package.json (bun remove ${name}) and deploy.`,
+  }
+}
+
 export { EXTENSION_KEYWORD }

package/src/ports.ts

@@ -70,6 +70,7 @@ import { createTemplateFileStore } from './adapters/template-files.ts'
 import { createTemplateQueryPort } from './adapters/template-query.ts'
 import { avatarUrls, createUserPorts } from './adapters/users.ts'
 import { createWebhookPort } from './adapters/webhooks.ts'
+import { createApprovals } from './approvals.ts'
 import { COMPONENT_SNIPPETS } from './component-snippets.ts'
 import { type CromboloConfig, type UserLinkSender, VERSION } from './config.ts'
 import { type EmailPort, resolveEmailPort } from './email.ts'
@@ -603,6 +604,20 @@ export function createDeps(options: DepsOptions): ManagementApiDeps {
         }),
         options.config.siteDir,
       )
+    if (deps.documents) {
+      const documents = deps.documents
+      deps.approvals = createApprovals({
+        db: options.db,
+        nodeState: options.schema?.nodeState,
+        email,
+        // Through the same port an editor's publish takes, so what approval
+        // publishes is cached, tracked and announced as any publish is.
+        publisher: {
+          publish: (key, cultures) => documents.publish(key, cultures),
+          unpublish: (key, cultures) => documents.unpublish(key, cultures),
+        },
+      })
+    }
   }
   return deps
 }

package/src/server.ts

@@ -84,6 +84,8 @@ import { createAuditHost, createAuditSink, pluginAuditPlan, recordAudit } from '
 import { readCreatedBundlePackage, writeCreatedBundlePackage } from './adapters/bundles.ts'
 import { createPublishedContentSource, loadDraftNode } from './adapters/documents.ts'
 import { createSchemaProposals } from './adapters/schema-proposals.ts'
+import type { Approvals } from './approvals.ts'
+import { handleApprovalsApi } from './approvals-api.ts'
 import { CommandError, installBundleContent } from './bundle-install.ts'
 import { bundleChains, bundleTablesReport } from './bundle-tables.ts'
 import { createBundleRedirects, createServerBundles, validateServerBundles } from './bundles.ts'
@@ -247,6 +249,7 @@ export async function createServer(config: CromboloConfig = loadConfig()): Promi
     contentApplied: async (packageName) =>
       (await new TransferRunRepository(db).appliedForPackage(packageName))?.packageVersion ?? null,
     applyContentOnInstall: config.applyBundleContentOnInstall,
+    installs: config.runtimeInstalls,
     applyContent: async (packageName) => {
       // A package from the marketplace is for anyone, so nothing in it can be
       // sealed; one that is is refused rather than half applied.
@@ -657,37 +660,36 @@ export async function createServer(config: CromboloConfig = loadConfig()): Promi
         }
       : undefined,
   })
-  const api = createManagementApiRouter({
-    deps: {
-      ...createDeps({
-        config,
-        paths,
-        extensions,
-        db,
-        webhooks,
-        cache,
-        schema,
-        mediaFiles,
-        email,
-        onSearchQueued: () => jobs.kickSearchIndexing(),
-        // This node looks again at once; the others are told to. The write has
-        // already landed wherever `componentsDir` points, so there is nothing to
-        // distribute — only the fact that it happened.
-        onViewsChange: async (alias) => {
-          // The snapshot first, and awaited: the hash announced is then the one
-          // this write produced rather than the generation it replaced, and the
-          // editor's next request renders what they just saved.
-          const hash = await snapshots.refresh()
-          void appendCacheInstruction(db, {
-            kind: 'components',
-            payload: hash ? { alias, hash } : { alias },
-            by: schema.nodeId,
-          }).catch((error: unknown) => {
-            renderLog.error('Could not announce the template {alias}: {error}', { alias, error })
-          })
-        },
-      }),
+  const managementDeps = createDeps({
+    config,
+    paths,
+    extensions,
+    db,
+    webhooks,
+    cache,
+    schema,
+    mediaFiles,
+    email,
+    onSearchQueued: () => jobs.kickSearchIndexing(),
+    // This node looks again at once; the others are told to. The write has
+    // already landed wherever `componentsDir` points, so there is nothing to
+    // distribute — only the fact that it happened.
+    onViewsChange: async (alias) => {
+      // The snapshot first, and awaited: the hash announced is then the one
+      // this write produced rather than the generation it replaced, and the
+      // editor's next request renders what they just saved.
+      const hash = await snapshots.refresh()
+      void appendCacheInstruction(db, {
+        kind: 'components',
+        payload: hash ? { alias, hash } : { alias },
+        by: schema.nodeId,
+      }).catch((error: unknown) => {
+        renderLog.error('Could not announce the template {alias}: {error}', { alias, error })
+      })
     },
+  })
+  const api = createManagementApiRouter({
+    deps: managementDeps,
     authenticate,
     nodes: createNodeLookup(db),
     allowLocalLogin: config.allowLocalLogin,
@@ -1089,6 +1091,7 @@ export async function createServer(config: CromboloConfig = loadConfig()): Promi
           url: marketplace.url(),
           keyword: config.packageKeyword,
           appliesContent: config.applyBundleContentOnInstall,
+          installs: config.runtimeInstalls,
           items: await marketplace.search(url.searchParams.get('q') ?? undefined),
         })
       }
@@ -1110,7 +1113,10 @@ export async function createServer(config: CromboloConfig = loadConfig()): Promi
       }
 
       if (action === 'installed' && request.method === 'GET') {
-        return Response.json({ items: await marketplace.installed() })
+        return Response.json({
+          installs: config.runtimeInstalls,
+          items: await marketplace.installed(),
+        })
       }
 
       if ((action === 'install' || action === 'uninstall') && request.method === 'POST') {
@@ -1460,6 +1466,43 @@ export async function createServer(config: CromboloConfig = loadConfig()): Promi
         : Response.json({ ok: false, message: outcome.message }, { status: outcome.status })
     }
 
+    // Non-contract: approval workflows (story 028) — the page's Workflow tab, the
+    // Workflows section and its designer. Content or Workflows, as either screen is.
+    if (pathname.startsWith(`${paths.pluginPath}/api/approvals/`)) {
+      const principal = await authenticate(request)
+      if (!principal) return new Response('Unauthorized', { status: 401 })
+      if (!hasSection(principal, 'content') && !hasSection(principal, 'workflow'))
+        return new Response('Forbidden', { status: 403 })
+      const approvals = managementDeps.approvals as Approvals | undefined
+      if (!approvals) return new Response('Not Found', { status: 404 })
+      const response = await handleApprovalsApi(
+        request,
+        pathname.slice(`${paths.pluginPath}/api/approvals/`.length),
+        {
+          db,
+          approvals,
+          principal,
+          schemaDir: config.schemaDir,
+          writable: config.schemaWritable,
+          onChanged: config.schemaStore
+            ? async () => {
+                await publishSchema(config.schemaStore as SchemaStore, config.schemaDir)
+              }
+            : undefined,
+        },
+      )
+      if (response) {
+        if (request.method !== 'GET')
+          log.info('{user} {verb} on approvals: {status}', {
+            user: principal.email,
+            verb: pathname.split('/').slice(-1)[0],
+            status: response.status,
+          })
+        return response
+      }
+      return new Response('Not Found', { status: 404 })
+    }
+
     // Non-contract, Packages: answering a content import's conflicts and running
     // it, from the Changes dashboard. Packages, because installing is.
     if (pathname.startsWith(`${paths.pluginPath}/api/transfers/`)) {