@crombolo/cli 0.10.0 → 0.11.0

package/bin/crombolo.ts

@@ -2111,7 +2111,10 @@ function help(): void {
 }
 
 try {
+  // Before dispatching, which rewrites `bundle install` as `content import`.
+  const audited = commandAudit()
   await dispatch()
+  if (audited) await ops.recordCommand(await siteConfig(), audited)
 } catch (error) {
   if (!(error instanceof ops.CommandError)) throw error
   for (const problem of error.problems) console.error(`  ${problem}`)
@@ -2119,6 +2122,52 @@ try {
   process.exit(1)
 }
 
+// A declaration, not a const: the top-level dispatch above runs before this line.
+function capital(word: string): string {
+  return `${word.charAt(0).toUpperCase()}${word.slice(1)}`
+}
+
+/** The audit log entry for a command that changes the environment; undefined for one that only reads. */
+function commandAudit(): ops.CommandAudit | undefined {
+  if (flags.has('--dry-run') || flags.has('--plan') || flags.has('--help')) return undefined
+  const sub = positional[0]
+  const typed = `crombolo ${command}${sub ? ` ${sub}` : ''}`
+  const entry = (
+    category: ops.CommandAudit['category'],
+    action: string,
+    entityType?: string,
+    entityKey?: string,
+  ): ops.CommandAudit => ({ category, action, command: typed, entityType, entityKey })
+  switch (command) {
+    case 'admin':
+      return sub === 'reset-password' ? entry('user', 'ResetPassword', 'User') : undefined
+    case 'schema':
+      if (sub === 'sync') return entry('schema', 'Sync', 'Schema')
+      return sub === 'purge' ? entry('schema', 'Purge', 'Schema') : undefined
+    case 'content':
+    case 'bundle':
+      if (sub === 'purge') return entry('system', 'Purge', 'Bundle', positional[1])
+      if (sub === 'import' || sub === 'install') return entry('content', 'Import', 'Bundle')
+      return sub === 'publish' || sub === 'unpublish' || sub === 'revert'
+        ? entry('content', capital(sub), 'Document', positional[1])
+        : undefined
+    case 'dictionary':
+      return sub === 'import' ? entry('settings', 'Import', 'DictionaryItem') : undefined
+    case 'domains':
+      return sub && sub !== 'list'
+        ? entry('settings', `${capital(sub)}Domains`, 'Domain')
+        : undefined
+    case 'upgrade':
+      if (sub === undefined) return entry('system', 'Upgrade')
+      return sub === 'check' && flags.has('--fix') ? entry('system', 'UpgradeFix') : undefined
+    case 'maintenance':
+      if (sub === 'pause') return entry('system', 'PauseEditing')
+      return sub === 'resume' ? entry('system', 'ResumeEditing') : undefined
+    default:
+      return undefined
+  }
+}
+
 async function dispatch(): Promise<void> {
   switch (command) {
     case 'start':

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@crombolo/cli",
-  "version": "0.10.0",
+  "version": "0.11.0",
   "description": "The crombolo command line: scaffolding a site, schema, views, domains, content transfer and upgrades.",
   "license": "MIT",
   "author": "Crombolo",
@@ -34,11 +34,11 @@
     "access": "public"
   },
   "dependencies": {
-    "@crombolo/auth": "0.10.0",
-    "@crombolo/core": "0.10.0",
-    "@crombolo/data": "0.10.0",
-    "@crombolo/schema": "0.10.0",
-    "@crombolo/server": "0.10.0",
-    "@crombolo/transfer": "0.10.0"
+    "@crombolo/auth": "0.11.0",
+    "@crombolo/core": "0.11.0",
+    "@crombolo/data": "0.11.0",
+    "@crombolo/schema": "0.11.0",
+    "@crombolo/server": "0.11.0",
+    "@crombolo/transfer": "0.11.0"
   }
 }

package/src/operations/commands.ts

@@ -5,8 +5,10 @@
  * a platform's own tooling — gets the same results as data. One implementation,
  * so the two can never disagree about what an import or an upgrade does.
  */
+import { userInfo } from 'node:os'
 import { ROOT_ACCESS } from '@crombolo/core'
 import {
+  type AuditCategory,
   bundleStateKey,
   bundleTablesIn,
   connect,
@@ -52,6 +54,7 @@ import {
   planBundleUpgrades,
   readBlobs,
   readBundle,
+  recordAudit,
   syncOptionsFor,
   type TransferInput,
   VERSION,
@@ -565,6 +568,44 @@ export async function backup(
   })
 }
 
+export interface CommandAudit {
+  category: AuditCategory
+  action: string
+  /** The command as typed, without its arguments, which can hold a password. */
+  command: string
+  entityType?: string
+  entityKey?: string
+}
+
+/**
+ * Records a command that changed this environment, in the audit log, as the
+ * account that ran it — `CROMBOLO_ACTOR` when a pipeline names who it runs for.
+ * Never fails the command: what it records has already happened.
+ */
+export async function recordCommand(config: CromboloConfig, entry: CommandAudit): Promise<void> {
+  let actor = Bun.env.CROMBOLO_ACTOR
+  try {
+    actor ??= userInfo().username
+  } catch {
+    actor ??= undefined
+  }
+  try {
+    await withDatabase(config, (db) =>
+      recordAudit(db, {
+        category: entry.category,
+        action: entry.action,
+        source: 'cli',
+        userName: actor ?? null,
+        entityType: entry.entityType ?? null,
+        entityKey: entry.entityKey ?? null,
+        detail: entry.command,
+      }),
+    )
+  } catch {
+    // No database to write to, or one without the log yet: the command still happened.
+  }
+}
+
 async function withDatabase<T>(config: CromboloConfig, use: (db: Db) => Promise<T>): Promise<T> {
   const db = await connect({ file: config.sqliteFile })
   try {

package/templates/basic/bundle/package.json

@@ -6,7 +6,7 @@
     "content"
   ],
   "peerDependencies": {
-    "@crombolo/crombolo": "^0.10.0"
+    "@crombolo/crombolo": "^0.11.0"
   },
   "crombolo": {
     "id": "basic",

package/templates/demo/harbourstone/bundle/package.json

@@ -6,7 +6,7 @@
     "content"
   ],
   "peerDependencies": {
-    "@crombolo/crombolo": "^0.10.0"
+    "@crombolo/crombolo": "^0.11.0"
   },
   "crombolo": {
     "id": "demo-harbourstone",

package/templates/starter/bundle/package.json

@@ -6,7 +6,7 @@
     "content"
   ],
   "peerDependencies": {
-    "@crombolo/crombolo": "^0.10.0"
+    "@crombolo/crombolo": "^0.11.0"
   },
   "crombolo": {
     "id": "starter",