@contember/cli 2.1.0-rc.3 → 2.2.0-alpha.10

package/package.json

@@ -1,17 +1,34 @@
 {
   "name": "@contember/cli",
-  "version": "2.1.0-rc.3",
+  "version": "2.2.0-alpha.10",
   "license": "Apache-2.0",
   "bin": {
     "contember": "./dist/production/run.js"
   },
   "type": "module",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/types/index.d.ts",
+        "development": "./dist/development/index.js",
+        "production": "./dist/production/index.js",
+        "typescript": "./src/index.ts",
+        "default": "./dist/production/index.js"
+      },
+      "require": {
+        "types": "./dist/types/index.d.ts",
+        "development": "./dist/development/index.cjs",
+        "production": "./dist/production/index.cjs",
+        "typescript": "./src/index.ts",
+        "default": "./dist/production/index.cjs"
+      }
+    }
+  },
   "scripts": {
     "build": "tailwindcss -i src/lib/project/docs/resources/style.css -o ./dist/resources/out.css"
   },
   "devDependencies": {
     "@tailwindcss/cli": "^4.2.1",
-    "@types/fs-extra": "^11.0.4",
     "@types/js-yaml": "^4.0.9",
     "@types/node": "^24.12.0",
     "@types/prompts": "^2.4.9",
@@ -19,25 +36,26 @@
     "tailwindcss": "^4.2.1"
   },
   "dependencies": {
-    "@contember/cli-common": "2.1.0-rc.3",
-    "@contember/config-loader": "2.1.0-rc.3",
-    "@contember/database": "2.1.0-rc.3",
-    "@contember/dic": "2.1.0-rc.3",
-    "@contember/engine-common": "2.1.0-rc.3",
-    "@contember/engine-content-api": "2.1.0-rc.3",
-    "@contember/graphql-client": "2.1.0-rc.3",
-    "@contember/migrations-client": "2.1.0-rc.3",
-    "@contember/schema": "2.1.0-rc.3",
-    "@contember/schema-migrations": "2.1.0-rc.3",
-    "@contember/schema-utils": "2.1.0-rc.3",
-    "@contember/typesafe": "2.1.0-rc.3",
+    "@contember/cli-common": "2.2.0-alpha.10",
+    "@contember/config-loader": "2.2.0-alpha.10",
+    "@contember/database": "2.2.0-alpha.10",
+    "@contember/dic": "2.2.0-alpha.10",
+    "@contember/engine-common": "2.2.0-alpha.10",
+    "@contember/engine-content-api": "2.2.0-alpha.10",
+    "@contember/graphql-client": "2.2.0-alpha.10",
+    "@contember/graphql-client-tenant": "2.2.0-alpha.10",
+    "@contember/migrations-client": "2.2.0-alpha.10",
+    "@contember/schema": "2.2.0-alpha.10",
+    "@contember/schema-migrations": "2.2.0-alpha.10",
+    "@contember/schema-utils": "2.2.0-alpha.10",
+    "@contember/typesafe": "2.2.0-alpha.10",
     "@graphql-tools/schema": "^10.0.31",
     "chalk": "^5.6.2",
     "chalk-table": "^1.0.2",
     "fast-glob": "^3.3.3",
     "graphql": "^16.13.1",
+    "graphql-ts-client-api": "^3.1.17",
     "js-yaml": "^4.1.1",
-    "lodash-es": "^4.17.23",
     "pg": "^8.20.0",
     "preact": "^10.28.4",
     "preact-render-to-string": "^6.6.6",

package/src/commands/actions/ActionsGetEventCommand.ts

@@ -1,9 +1,10 @@
-import { Command, CommandConfiguration, Input } from '@contember/cli-common'
-import { RemoteProjectResolver } from '../../lib/project/RemoteProjectResolver'
-import { ActionsClient } from '../../lib/actions/ActionsClient'
+import { Command, CommandConfiguration, escapeTerminalText, ExitCode, Input, Output } from '@contember/cli-common'
+import { RemoteProjectResolver } from '../../lib/project/RemoteProjectResolver.js'
+import { ActionsClientResolver, resolveActionsClient } from '../../lib/actions/resolveActionsClient.js'
+import { Event } from '../../lib/actions/ActionsClient.js'
 
 type Args = {
-	eventId: string
+	eventIds: string[]
 }
 
 type Options = {
@@ -13,29 +14,50 @@ type Options = {
 export class ActionsGetEventCommand extends Command<Args, Options> {
 	constructor(
 		private readonly remoteProjectResolver: RemoteProjectResolver,
+		private readonly resolveClient: ActionsClientResolver = resolveActionsClient,
 	) {
 		super()
 	}
 
 	protected configure(configuration: CommandConfiguration<Args, Options>): void {
-		configuration.description('Get single event')
-		configuration.argument('eventId')
+		configuration.description('Get one or more events by id')
+		configuration.argument('eventIds').variadic().description('event ids to fetch')
 		configuration.option('project').valueRequired()
 	}
 
-	protected async execute(input: Input<Args, Options>): Promise<void | number> {
-		const dsn = input.getOption('project')
-		const project = await this.remoteProjectResolver.resolve(dsn)
-		if (!project) {
-			throw `Project not defined`
+	protected async execute(input: Input<Args, Options>, output: Output): Promise<void | number> {
+		const api = await this.resolveClient(this.remoteProjectResolver, input.getOption('project'))
+		const ids = input.getArgument('eventIds')
+
+		// looped rather than parallel: ActionsClient only exposes a single-id getEvent call
+		const results: { id: string; event: Event | null }[] = []
+		for (const id of ids) {
+			results.push({ id, event: await api.getEvent(id) })
+		}
+		const missingIds = results.filter(it => it.event === null).map(it => it.id)
+		if (missingIds.length > 0) {
+			output.warn(`Event not found: ${missingIds.join(', ')}`)
 		}
-		const api = ActionsClient.create(project.endpoint, project.name, project.token)
 
-		const result = await api.getEvent(input.getArgument('eventId'))
-		if (!result) {
-			console.log('Event not found')
-			return 1
+		if (results.length === 1) {
+			const [{ id, event }] = results
+			output.data(event, {
+				human: value => value === null ? `Event ${escapeTerminalText(id)} not found` : sanitizeMultiline(JSON.stringify(value, null, 2)),
+				quiet: () => id,
+			})
+		} else {
+			output.data(results, {
+				human: value =>
+					value.map(item =>
+						item.event === null
+							? `${escapeTerminalText(item.id)}: not found`
+							: sanitizeMultiline(JSON.stringify(item.event, null, 2))
+					).join('\n\n'),
+				quiet: value => value.map(item => item.id),
+			})
 		}
-		console.log(JSON.stringify(result, null, 2))
+		return missingIds.length > 0 ? ExitCode.NotFound : ExitCode.Success
 	}
 }
+
+const sanitizeMultiline = (value: string): string => value.split('\n').map(escapeTerminalText).join('\n')

package/src/commands/actions/ActionsListFailedEventsCommand.ts

@@ -1,17 +1,18 @@
-import { Command, CommandConfiguration, Input } from '@contember/cli-common'
-import { RemoteProjectResolver } from '../../lib/project/RemoteProjectResolver'
-import { ActionsClient } from '../../lib/actions/ActionsClient'
-import chalkTable from 'chalk-table'
+import { Command, CommandConfiguration, escapeTerminalText, Input, JsonValue, Output } from '@contember/cli-common'
+import { RemoteProjectResolver } from '../../lib/project/RemoteProjectResolver.js'
+import { ActionsClientResolver, resolveActionsClient } from '../../lib/actions/resolveActionsClient.js'
+import { Event } from '../../lib/actions/ActionsClient.js'
+
 type Args = {}
 
 type Options = {
 	project?: string
-	json?: boolean
 }
 
 export class ActionsListFailedEventsCommand extends Command<Args, Options> {
 	constructor(
 		private readonly remoteProjectResolver: RemoteProjectResolver,
+		private readonly resolveClient: ActionsClientResolver = resolveActionsClient,
 	) {
 		super()
 	}
@@ -19,50 +20,30 @@ export class ActionsListFailedEventsCommand extends Command<Args, Options> {
 	protected configure(configuration: CommandConfiguration<Args, Options>): void {
 		configuration.description('Show failed events')
 		configuration.option('project').valueRequired()
-		configuration.option('json').valueNone()
 	}
 
-	protected async execute(input: Input<Args, Options>): Promise<void | number> {
-		const dsn = input.getOption('project')
-		const project = await this.remoteProjectResolver.resolve(dsn)
-		if (!project) {
-			throw `Project not defined`
-		}
-		const api = ActionsClient.create(project.endpoint, project.name, project.token)
-
+	protected async execute(input: Input<Args, Options>, output: Output): Promise<void> {
+		const api = await this.resolveClient(this.remoteProjectResolver, input.getOption('project'))
 		const result = await api.listFailedEvents()
-		if (input.getOption('json')) {
-			console.log(JSON.stringify(result, null, 2))
-			return
-		}
 		if (result.length === 0) {
-			console.log('No failed events')
-			return
+			output.info('No failed events')
 		}
-		const table = chalkTable(
-			{
-				columns: [
-					{ field: 'id', name: 'ID' },
-					{ field: 'createdAt', name: 'Created at' },
-					{ field: 'lastStateChange', name: 'Last state change' },
-					{ field: 'visibleAt', name: 'Visible at' },
-					{ field: 'numRetries', name: 'Retries' },
-					{ field: 'state', name: 'State' },
-					{ field: 'target', name: 'Target' },
-					{ field: 'log', name: 'Log' },
-				],
-			},
-			result.map(it => ({
-				id: it.id,
-				createdAt: it.createdAt,
-				lastStateChange: it.lastStateChange,
-				visibleAt: it.visibleAt || '',
-				numRetries: it.numRetries.toString(),
-				state: it.state,
-				target: it.target,
-				log: JSON.stringify(it.log.length > 0 ? it.log[it.log.length - 1] : {}),
-			})),
+		output.table<Event>(
+			[
+				{ field: 'id', name: 'ID' },
+				{ field: 'createdAt', name: 'Created at' },
+				{ field: 'lastStateChange', name: 'Last state change' },
+				{ field: 'visibleAt', name: 'Visible at' },
+				{ field: 'numRetries', name: 'Retries' },
+				{ field: 'state', name: 'State' },
+				{ field: 'target', name: 'Target' },
+				// human mode only: show just the last log entry, a terminal-width row of the full history is unreadable
+				{ field: 'log', name: 'Log', format: value => escapeTerminalText(JSON.stringify(lastLogEntry(value)) ?? '') },
+			],
+			result,
+			'id',
 		)
-		console.log(table)
 	}
 }
+
+const lastLogEntry = (log: JsonValue): JsonValue => Array.isArray(log) ? log[log.length - 1] ?? {} : log

package/src/commands/actions/ActionsListVariablesCommand.ts

@@ -1,7 +1,6 @@
-import { Command, CommandConfiguration, Input } from '@contember/cli-common'
-import { RemoteProjectResolver } from '../../lib/project/RemoteProjectResolver'
-import { ActionsClient } from '../../lib/actions/ActionsClient'
-import chalkTable from 'chalk-table'
+import { Command, CommandConfiguration, Input, Output } from '@contember/cli-common'
+import { RemoteProjectResolver } from '../../lib/project/RemoteProjectResolver.js'
+import { ActionsClientResolver, resolveActionsClient } from '../../lib/actions/resolveActionsClient.js'
 
 type Args = {}
 
@@ -12,6 +11,7 @@ type Options = {
 export class ActionsListVariablesCommand extends Command<Args, Options> {
 	constructor(
 		private readonly remoteProjectResolver: RemoteProjectResolver,
+		private readonly resolveClient: ActionsClientResolver = resolveActionsClient,
 	) {
 		super()
 	}
@@ -21,16 +21,18 @@ export class ActionsListVariablesCommand extends Command<Args, Options> {
 		configuration.option('project').valueRequired()
 	}
 
-	protected async execute(input: Input<Args, Options>): Promise<void | number> {
-		const dsn = input.getOption('project')
-		const project = await this.remoteProjectResolver.resolve(dsn)
-		if (!project) {
-			throw `Project not defined`
-		}
-		const api = ActionsClient.create(project.endpoint, project.name, project.token)
+	protected async execute(input: Input<Args, Options>, output: Output): Promise<void> {
+		const api = await this.resolveClient(this.remoteProjectResolver, input.getOption('project'))
 		const result = await api.listVariables()
-		console.log(chalkTable({
-			columns: ['name', 'value'],
-		}, result))
+		output.table(
+			[
+				{ field: 'name', name: 'Name' },
+				// an environment value is not returned by the API, so there is nothing to print but its absence
+				{ field: 'value', name: 'Value', format: value => value ?? '<not readable>' },
+				{ field: 'source', name: 'Source', format: source => source === 'ENVIRONMENT' ? 'Environment (read-only)' : 'Database' },
+			],
+			result,
+			'name',
+		)
 	}
 }

package/src/commands/actions/ActionsRetryEventCommand.ts

@@ -1,9 +1,10 @@
-import { Command, CommandConfiguration, Input } from '@contember/cli-common'
-import { RemoteProjectResolver } from '../../lib/project/RemoteProjectResolver'
-import { ActionsClient } from '../../lib/actions/ActionsClient'
-import chalkTable from 'chalk-table'
+import { Command, CommandConfiguration, escapeTerminalText, ExitCode, Input, Output } from '@contember/cli-common'
+import { RemoteProjectResolver } from '../../lib/project/RemoteProjectResolver.js'
+import { ActionsClientResolver, resolveActionsClient } from '../../lib/actions/resolveActionsClient.js'
+import { ActionMutationResult, runActionMutationBatch, validateActionEventIds } from '../../lib/actions/runActionMutationBatch.js'
+
 type Args = {
-	eventId: string
+	eventIds: string[]
 }
 
 type Options = {
@@ -13,30 +14,47 @@ type Options = {
 export class ActionsRetryEventCommand extends Command<Args, Options> {
 	constructor(
 		private readonly remoteProjectResolver: RemoteProjectResolver,
+		private readonly resolveClient: ActionsClientResolver = resolveActionsClient,
 	) {
 		super()
 	}
 
 	protected configure(configuration: CommandConfiguration<Args, Options>): void {
-		configuration.description('Retry given event')
-		configuration.argument('eventId')
+		configuration.description('Retry one or more events')
+		configuration.argument('eventIds').variadic().description('event ids to retry')
 		configuration.option('project').valueRequired()
 	}
 
-	protected async execute(input: Input<Args, Options>): Promise<void | number> {
-		const dsn = input.getOption('project')
-		const project = await this.remoteProjectResolver.resolve(dsn)
-		if (!project) {
-			throw `Project not defined`
-		}
-		const api = ActionsClient.create(project.endpoint, project.name, project.token)
+	protected async execute(input: Input<Args, Options>, output: Output): Promise<void | number> {
+		const ids = input.getArgument('eventIds')
+		validateActionEventIds(ids)
+		const api = await this.resolveClient(this.remoteProjectResolver, input.getOption('project'))
 
-		const result = await api.retryEvent(input.getArgument('eventId'))
-		if (result) {
-			console.log('Event requeued for processing')
+		const batch = await runActionMutationBatch(ids, id => api.retryEvent(id), {
+			code: 'ACTION_RETRY_FAILED',
+			retryable: false,
+			exitCode: ExitCode.InputError,
+		})
+		if (batch.results.length === 1) {
+			output.data(batch.results[0], {
+				human: result => renderResults([result]),
+				quiet: result => result.id,
+			})
 		} else {
-			console.log('Failed to requeue event. Check the event status')
-			return 1
+			output.data(batch.results, {
+				human: renderResults,
+				quiet: results => results.map(result => result.id),
+			})
 		}
+		return batch.exitCode
 	}
 }
+
+const renderResults = (results: readonly ActionMutationResult[]): string =>
+	results
+		.map(result =>
+			result.ok
+				? escapeTerminalText(`Event ${result.id} requeued for processing`)
+				: escapeTerminalText(`Failed to requeue event ${result.id} (${result.error.code})`)
+		)
+		.join('\n')

package/src/commands/actions/ActionsSetVariablesCommand.ts

@@ -1,6 +1,7 @@
-import { Command, CommandConfiguration, Input } from '@contember/cli-common'
-import { RemoteProjectResolver } from '../../lib/project/RemoteProjectResolver'
-import { ActionsClient } from '../../lib/actions/ActionsClient'
+import { CliError, Command, CommandConfiguration, Input, Output } from '@contember/cli-common'
+import { RemoteProjectResolver } from '../../lib/project/RemoteProjectResolver.js'
+import { ActionsClientResolver, resolveActionsClient } from '../../lib/actions/resolveActionsClient.js'
+import { SetVariablesMode } from '../../lib/actions/ActionsClient.js'
 
 type Args = {
 	variables: string[]
@@ -16,6 +17,7 @@ type Options = {
 export class ActionsSetVariablesCommand extends Command<Args, Options> {
 	constructor(
 		private readonly remoteProjectResolver: RemoteProjectResolver,
+		private readonly resolveClient: ActionsClientResolver = resolveActionsClient,
 	) {
 		super()
 	}
@@ -29,34 +31,60 @@ export class ActionsSetVariablesCommand extends Command<Args, Options> {
 		configuration.argument('variables').variadic().description('variables to set, in the form of name=value')
 	}
 
-	protected async execute(input: Input<Args, Options>): Promise<void | number> {
-		const dsn = input.getOption('project')
-		const project = await this.remoteProjectResolver.resolve(dsn)
-		if (!project) {
-			throw `Project not defined`
-		}
-		const api = ActionsClient.create(project.endpoint, project.name, project.token)
-		const mode = input.getOption('merge')
-			? 'MERGE' as const
-			: input.getOption('set')
-			? 'SET' as const
-			: input.getOption('append-only-missing')
-			? 'APPEND_ONLY_MISSING' as const
-			: 'MERGE' as const
+	protected async execute(input: Input<Args, Options>, output: Output): Promise<void> {
+		const mode = resolveMode(input)
 
 		const variables = input.getArgument('variables').flatMap(it => it.split('\n')).filter(it => it.trim().length > 0)
-		const result = await api.setVariables(
-			variables.map(it => {
-				const [name, value] = it.split('=')
-				return { name, value }
-			}),
-			mode,
-		)
-		if (result) {
-			console.log('Success')
-		} else {
-			console.error('Failed')
-			return 1
+		const parsedVariables = variables.map((assignment, position) => {
+			// split on the first `=` only — the value (e.g. a base64 payload) may legitimately contain more
+			const separatorIndex = assignment.indexOf('=')
+			if (separatorIndex === -1) {
+				throw invalidAssignment(position, 'missing separator')
+			}
+			const name = assignment.slice(0, separatorIndex)
+			if (name.length === 0) {
+				throw invalidAssignment(position, 'empty name')
+			}
+			return { name, value: assignment.slice(separatorIndex + 1) }
+		})
+		const api = await this.resolveClient(this.remoteProjectResolver, input.getOption('project'))
+		const result = await api.setVariables(parsedVariables, mode)
+		if (!result) {
+			throw new CliError('Failed to set variables', { code: 'SET_VARIABLES_FAILED' })
 		}
+		output.data(
+			{ mode, count: parsedVariables.length },
+			{
+				human: result => `Set ${result.count} variable(s) (${result.mode})`,
+				quiet: result => result.count,
+			},
+		)
+	}
+}
+
+const resolveMode = (input: Input<Args, Options>): SetVariablesMode => {
+	const selected: { flag: string; mode: SetVariablesMode }[] = []
+	if (input.getOption('merge')) {
+		selected.push({ flag: '--merge', mode: 'MERGE' })
+	}
+	if (input.getOption('set')) {
+		selected.push({ flag: '--set', mode: 'SET' })
+	}
+	if (input.getOption('append-only-missing')) {
+		selected.push({ flag: '--append-only-missing', mode: 'APPEND_ONLY_MISSING' })
 	}
+	if (selected.length > 1) {
+		const flags = selected.map(option => option.flag)
+		throw new CliError(`Options ${flags.join(', ')} cannot be combined`, {
+			code: 'VARIABLE_MODE_CONFLICT',
+			details: { options: flags },
+		})
+	}
+	return selected[0]?.mode ?? 'MERGE'
 }
+
+const invalidAssignment = (position: number, reason: string): CliError =>
+	new CliError(`Invalid variable assignment at position ${position + 1}: ${reason}`, {
+		code: 'INVALID_VARIABLE',
+		details: { option: 'variables', position: position + 1, reason },
+	})

package/src/commands/actions/ActionsStopEventCommand.ts

@@ -1,9 +1,10 @@
-import { Command, CommandConfiguration, Input } from '@contember/cli-common'
-import { RemoteProjectResolver } from '../../lib/project/RemoteProjectResolver'
-import { ActionsClient } from '../../lib/actions/ActionsClient'
-import chalkTable from 'chalk-table'
+import { Command, CommandConfiguration, escapeTerminalText, ExitCode, Input, Output } from '@contember/cli-common'
+import { RemoteProjectResolver } from '../../lib/project/RemoteProjectResolver.js'
+import { ActionsClientResolver, resolveActionsClient } from '../../lib/actions/resolveActionsClient.js'
+import { ActionMutationResult, runActionMutationBatch, validateActionEventIds } from '../../lib/actions/runActionMutationBatch.js'
+
 type Args = {
-	eventId: string
+	eventIds: string[]
 }
 
 type Options = {
@@ -13,30 +14,47 @@ type Options = {
 export class ActionsStopEventCommand extends Command<Args, Options> {
 	constructor(
 		private readonly remoteProjectResolver: RemoteProjectResolver,
+		private readonly resolveClient: ActionsClientResolver = resolveActionsClient,
 	) {
 		super()
 	}
 
 	protected configure(configuration: CommandConfiguration<Args, Options>): void {
-		configuration.description('Stop given event')
-		configuration.argument('eventId')
+		configuration.description('Stop one or more events')
+		configuration.argument('eventIds').variadic().description('event ids to stop')
 		configuration.option('project').valueRequired()
 	}
 
-	protected async execute(input: Input<Args, Options>): Promise<void | number> {
-		const dsn = input.getOption('project')
-		const project = await this.remoteProjectResolver.resolve(dsn)
-		if (!project) {
-			throw `Project not defined`
-		}
-		const api = ActionsClient.create(project.endpoint, project.name, project.token)
+	protected async execute(input: Input<Args, Options>, output: Output): Promise<void | number> {
+		const ids = input.getArgument('eventIds')
+		validateActionEventIds(ids)
+		const api = await this.resolveClient(this.remoteProjectResolver, input.getOption('project'))
 
-		const result = await api.stopEvent(input.getArgument('eventId'))
-		if (result) {
-			console.log('Event stopped')
+		const batch = await runActionMutationBatch(ids, id => api.stopEvent(id), {
+			code: 'ACTION_STOP_FAILED',
+			retryable: false,
+			exitCode: ExitCode.NotFound,
+		})
+		if (batch.results.length === 1) {
+			output.data(batch.results[0], {
+				human: result => renderResults([result]),
+				quiet: result => result.id,
+			})
 		} else {
-			console.log('Failed to stop event. Check the event id.')
-			return 1
+			output.data(batch.results, {
+				human: renderResults,
+				quiet: results => results.map(result => result.id),
+			})
 		}
+		return batch.exitCode
 	}
 }
+
+const renderResults = (results: readonly ActionMutationResult[]): string =>
+	results
+		.map(result =>
+			result.ok
+				? escapeTerminalText(`Event ${result.id} stopped`)
+				: escapeTerminalText(`Failed to stop event ${result.id} (${result.error.code})`)
+		)
+		.join('\n')