@falldownthesystem/devtool 0.4.1 → 0.5.0

package/README.md

@@ -53,7 +53,7 @@ Stored via the `conf` package in your OS config directory. You'll need:
 
 - **Bitbucket**: workspace, default repo, email, app password
 - **Jira**: base URL, API token, default project
-- **Confluence**: uses the same Jira base URL and token
+- **Confluence**: base URL, email, API token, default space. Cloud and Server/Data Center are detected from the base URL. For Server/Data Center, include any context path (`https://company.com/confluence`) and leave the email empty to use a personal access token, or set it to your username for Basic auth.
 
 ## License
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@falldownthesystem/devtool",
-	"version": "0.4.1",
+	"version": "0.5.0",
 	"description": "CLI for Bitbucket PRs, Jira tickets, Confluence pages, and Service Desk tickets",
 	"type": "module",
 	"bin": {

package/src/clients/confluence.js

@@ -1,67 +1,171 @@
-import { get } from '../config/store.js';
-
-function apiUrl(path) {
-	return new URL(`/wiki${path}`, get('confluence.baseUrl'));
-}
-
-function authHeader() {
-	const email = get('confluence.email');
-	const token = get('confluence.token');
-	return 'Basic ' + Buffer.from(`${email}:${token}`).toString('base64');
-}
-
-async function request(url, params = {}) {
-	if (url.origin !== new URL(get('confluence.baseUrl')).origin) {
-		throw new Error('Confluence pagination points to a different site. Check confluence.baseUrl.');
-	}
-	for (const [k, v] of Object.entries(params)) {
-		if (v !== undefined && v !== null) url.searchParams.set(k, v);
-	}
-
-	const res = await fetch(url, {
-		headers: {
-			'Authorization': authHeader(),
-			'Accept': 'application/json',
-		},
-	});
-
-	if (!res.ok) {
-		const err = new Error(`Confluence API error: ${res.status} ${res.statusText}`);
-		err.status = res.status;
-		err.url = url.toString();
-		throw err;
-	}
-
-	return res.json();
-}
-
-async function paginateV2(path, params = {}) {
-	const results = [];
-	let url = apiUrl(path);
-	let data = await request(url, params);
-	results.push(...(data.results || []));
-
-	while (data._links?.next) {
-		url = new URL(data._links.next, url);
-		data = await request(url);
-		results.push(...(data.results || []));
-	}
-
-	return results;
-}
-
-export async function listSpaces() {
-	return paginateV2('/api/v2/spaces');
-}
-
-export async function getPage(id) {
-	return request(apiUrl(`/api/v2/pages/${id}`), { 'body-format': 'storage' });
-}
-
-export async function listSpacePages(spaceId) {
-	return paginateV2(`/api/v2/spaces/${spaceId}/pages`);
-}
-
-export async function searchPages(cql) {
-	return request(apiUrl('/rest/api/search'), { cql });
-}
+import { get } from '../config/store.js';
+
+const deployments = new Map();
+
+// Custom domains hide the atlassian.net hostname, so anything else is probed:
+// Atlassian's edge answers tenant_info anonymously, Server/Data Center does not.
+async function detectDeployment(origin) {
+	if (/\.atlassian\.net$/i.test(new URL(origin).hostname)) return 'cloud';
+	try {
+		const res = await fetch(new URL('/_edge/tenant_info', origin), {
+			headers: { 'Accept': 'application/json' },
+		});
+		if (res.ok && (await res.json()).cloudId) return 'cloud';
+	} catch {
+		// An unreachable or non-JSON probe means no Atlassian edge; the real request reports connection errors.
+	}
+	return 'server';
+}
+
+async function connect() {
+	const base = new URL(get('confluence.baseUrl'));
+	if (!deployments.has(base.origin)) deployments.set(base.origin, detectDeployment(base.origin));
+	const kind = await deployments.get(base.origin);
+	// Cloud always serves Confluence under /wiki; Server/Data Center keeps its own context path.
+	const path = kind === 'cloud' ? '/wiki' : base.pathname.replace(/\/+$/, '');
+	return { kind, origin: base.origin, path };
+}
+
+function apiUrl(conn, path) {
+	return new URL(`${conn.origin}${conn.path}${path}`);
+}
+
+// Cloud v2 links are origin-relative, Server/Data Center links are relative to the context path.
+function nextUrl(conn, link, current) {
+	const contextRelative = conn.kind === 'server'
+		&& link.startsWith('/') && !link.startsWith('//')
+		&& !(conn.path && link.startsWith(`${conn.path}/`));
+	return contextRelative ? apiUrl(conn, link) : new URL(link, current);
+}
+
+// Server/Data Center personal access tokens use Bearer auth; a username switches to Basic.
+function authHeader(conn) {
+	const email = get('confluence.email');
+	const token = get('confluence.token');
+	if (conn.kind === 'server' && !email) return `Bearer ${token}`;
+	return 'Basic ' + Buffer.from(`${email}:${token}`).toString('base64');
+}
+
+async function request(conn, url, params = {}) {
+	if (url.origin !== conn.origin) {
+		throw new Error('Confluence pagination points to a different site. Check confluence.baseUrl.');
+	}
+	for (const [k, v] of Object.entries(params)) {
+		if (v !== undefined && v !== null) url.searchParams.set(k, v);
+	}
+
+	const res = await fetch(url, {
+		headers: {
+			'Authorization': authHeader(conn),
+			'Accept': 'application/json',
+		},
+	});
+
+	if (!res.ok) {
+		const err = new Error(`Confluence API error: ${res.status} ${res.statusText}`);
+		err.status = res.status;
+		err.url = url.toString();
+		throw err;
+	}
+
+	// Server/Data Center answers rejected credentials with a login page instead of a 401.
+	if (!res.headers.get('content-type')?.includes('json')) {
+		const err = new Error('Confluence returned a non-JSON response. Check confluence.baseUrl and confluence.token.');
+		err.url = url.toString();
+		throw err;
+	}
+
+	return res.json();
+}
+
+async function paginate(conn, path, params = {}) {
+	const results = [];
+	let url = apiUrl(conn, path);
+	let data = await request(conn, url, params);
+	results.push(...(data.results || []));
+
+	while (data._links?.next) {
+		url = nextUrl(conn, data._links.next, url);
+		data = await request(conn, url);
+		results.push(...(data.results || []));
+	}
+
+	return results;
+}
+
+// Server/Data Center v1 content is reshaped to the Cloud v2 fields the formatters read.
+function serverSpace(space) {
+	return {
+		id: String(space.id),
+		key: space.key,
+		name: space.name,
+		type: space.type,
+		status: space.status,
+	};
+}
+
+function serverPage(page) {
+	return {
+		id: page.id,
+		title: page.title,
+		status: page.status,
+		spaceId: page.space?.id != null ? String(page.space.id) : undefined,
+		createdAt: page.history?.createdDate,
+		version: page.version ? { number: page.version.number } : undefined,
+		body: page.body,
+	};
+}
+
+// The content listing silently returns nothing for an unknown space key, so the space is looked up first.
+async function serverSpaceKey(conn, { spaceId, spaceKey }) {
+	if (!spaceKey) return (await listSpaces()).find((s) => s.id === String(spaceId))?.key;
+	try {
+		return (await request(conn, apiUrl(conn, `/rest/api/space/${encodeURIComponent(spaceKey)}`))).key;
+	} catch (err) {
+		if (err.status === 404) return undefined;
+		throw err;
+	}
+}
+
+export async function listSpaces() {
+	const conn = await connect();
+	if (conn.kind === 'cloud') return paginate(conn, '/api/v2/spaces');
+	return (await paginate(conn, '/rest/api/space', { limit: 100 })).map(serverSpace);
+}
+
+export async function getPage(id) {
+	const conn = await connect();
+	if (conn.kind === 'cloud') {
+		return request(conn, apiUrl(conn, `/api/v2/pages/${id}`), { 'body-format': 'storage' });
+	}
+	return serverPage(await request(conn, apiUrl(conn, `/rest/api/content/${id}`), {
+		expand: 'body.storage,version,space,history',
+	}));
+}
+
+// Cloud lists pages by space ID and Server/Data Center by space key; returns null for an unknown space.
+export async function listSpacePages({ spaceId, spaceKey }) {
+	const conn = await connect();
+	if (conn.kind === 'cloud') {
+		const id = spaceId
+			?? (await request(conn, apiUrl(conn, '/api/v2/spaces'), { keys: spaceKey })).results?.[0]?.id;
+		if (!id) return null;
+		return paginate(conn, `/api/v2/spaces/${id}/pages`);
+	}
+
+	const key = await serverSpaceKey(conn, { spaceId, spaceKey });
+	if (!key) return null;
+	const pages = await paginate(conn, '/rest/api/content', {
+		spaceKey: key,
+		type: 'page',
+		expand: 'version,history',
+		limit: 100,
+	});
+	return pages.map(serverPage);
+}
+
+export async function searchPages(cql) {
+	const conn = await connect();
+	const result = await request(conn, apiUrl(conn, '/rest/api/search'), { cql });
+	return { ...result, totalSize: result.totalSize ?? result.totalCount };
+}

package/src/commands/confluence.js

@@ -57,30 +57,25 @@ confluence.command('pages')
 	.alias('ls')
 	.description('List pages in a space')
 	.option('-s, --space <key>', 'Space key (overrides default)')
-	.option('--space-id <id>', 'Space ID (skip key lookup)')
+	.option('--space-id <id>', 'Space ID (instead of a key)')
 	.action(async function (opts) {
 		const mode = getOutputMode(this);
 		const s = mode === 'rich' ? spinner('Fetching pages...').start() : null;
 		try {
-			let spaceId = opts.spaceId;
-			if (!spaceId) {
-				const spaceKey = opts.space || get('confluence.defaultSpace');
-				if (!spaceKey) {
-					if (s) s.error({ text: 'No space specified' });
-					console.error('Specify --space <key>, --space-id <id>, or set confluence.defaultSpace');
-					process.exitCode = 1;
-					return;
-				}
-				const spaces = await listSpaces();
-				const match = spaces.find((sp) => sp.key === spaceKey);
-				if (!match) {
-					if (s) s.error({ text: `Space "${spaceKey}" not found` });
-					process.exitCode = 1;
-					return;
-				}
-				spaceId = match.id;
+			const spaceId = opts.spaceId;
+			const spaceKey = spaceId ? undefined : opts.space || get('confluence.defaultSpace');
+			if (!spaceId && !spaceKey) {
+				if (s) s.error({ text: 'No space specified' });
+				console.error('Specify --space <key>, --space-id <id>, or set confluence.defaultSpace');
+				process.exitCode = 1;
+				return;
+			}
+			const pages = await listSpacePages({ spaceId, spaceKey });
+			if (!pages) {
+				if (s) s.error({ text: `Space "${spaceId || spaceKey}" not found` });
+				process.exitCode = 1;
+				return;
 			}
-			const pages = await listSpacePages(spaceId);
 			if (s) s.success({ text: `${pages.length} page(s) found` });
 			if (mode === 'json') outputJson(curatePagesJson(pages));
 			else if (mode === 'plain') plainPages(pages);

package/src/config/store.js

@@ -136,17 +136,17 @@ export async function runSetup() {
 
 	const confluence = await p.group({
 		baseUrl: () => p.text({
-			message: 'Confluence Cloud base URL',
+			message: 'Confluence base URL (Cloud or Server/Data Center)',
 			placeholder: 'https://company.atlassian.net',
 			initialValue: config.get('confluence.baseUrl') || '',
 		}),
 		email: () => p.text({
-			message: 'Confluence account email',
+			message: 'Confluence account email (Server/Data Center: username, or empty for a personal access token)',
 			placeholder: 'you@company.com',
 			initialValue: config.get('confluence.email') || '',
 		}),
 		token: () => p.password({
-			message: 'Confluence API token',
+			message: 'Confluence API token (Server/Data Center: personal access token or password)',
 		}),
 		defaultSpace: () => p.text({
 			message: 'Confluence default space key',