import { WebApi } from 'azure-devops-node-api';
import { AzureDevOpsConfig } from '../config/environment.js';
import { WikiError, WikiNotFoundError, WikiPageNotFoundError } from '../errors.js';
import { processEscapeSequences } from '../utils/index.js';
import fetch from 'node-fetch';
import type { Wiki, WikiPage, WikiPageResponse, WikiType, WikiCreateParameters, WikiPageCreateOrUpdateParameters } from 'azure-devops-node-api/interfaces/WikiInterfaces.js';
interface WikiListResponse {
count: number;
value: Wiki[];
}
interface WikiCreateResponse extends WikiCreateParameters {
id: string;
createdBy: {
id: string;
displayName: string;
uniqueName: string;
};
createdDate: string;
}
interface WikiPageUpdateResponse extends WikiPageResponse {
lastUpdatedBy: {
id: string;
displayName: string;
uniqueName: string;
};
lastUpdatedDate: string;
}
export class WikiApi {
private connection: WebApi;
private baseUrl: string;
private config: AzureDevOpsConfig;
constructor(connection: WebApi, config: AzureDevOpsConfig) {
this.connection = connection;
this.config = config;
this.baseUrl = `${config.orgUrl}/${config.project}/_apis/wiki`;
}
private async getAuthHeader(): Promise<string> {
const token = Buffer.from(`:${this.config.pat}`).toString('base64');
return `Basic ${token}`;
}
async createWiki(name: string, projectId?: string, mappedPath?: string): Promise<WikiCreateResponse> {
const authHeader = await this.getAuthHeader();
const response = await fetch(`${this.baseUrl}?api-version=7.0`, {
method: 'POST',
headers: {
'Content-Type': 'application/json',
Authorization: authHeader,
},
body: JSON.stringify({
name,
projectId: projectId || this.config.project,
type: 'projectWiki',
mappedPath: mappedPath || '/',
}),
});
if (!response.ok) {
throw new WikiError(
`Failed to create wiki: ${response.statusText}`,
response.status,
undefined,
undefined,
await response.text()
);
}
return response.json();
}
async getWiki(projectName: string, wikiIdentifier: string): Promise<Wiki> {
const authHeader = await this.getAuthHeader();
console.log(`Getting wiki with ID ${wikiIdentifier} in project ${projectName}`);
console.log(`URL: ${this.config.orgUrl}/${projectName}/_apis/wiki/wikis/${wikiIdentifier}?api-version=7.0`);
const response = await fetch(`${this.config.orgUrl}/${projectName}/_apis/wiki/wikis/${wikiIdentifier}?api-version=7.0`, {
headers: {
Authorization: authHeader,
},
});
console.log(`Response status: ${response.status} ${response.statusText}`);
if (response.status === 404) {
throw new WikiNotFoundError(wikiIdentifier);
}
if (!response.ok) {
throw new WikiError(
`Failed to get wiki: ${response.statusText}`,
response.status,
wikiIdentifier,
undefined,
await response.text()
);
}
return response.json();
}
async getAllWikis(): Promise<WikiListResponse> {
const authHeader = await this.getAuthHeader();
const response = await fetch(`${this.baseUrl}?api-version=7.0`, {
headers: {
Authorization: authHeader,
},
});
if (!response.ok) {
throw new WikiError(
`Failed to get wikis: ${response.statusText}`,
response.status,
undefined,
undefined,
await response.text()
);
}
return response.json();
}
async getWikiPage(wikiIdentifier: string, path: string): Promise<WikiPage> {
const authHeader = await this.getAuthHeader();
const encodedPath = encodeURIComponent(path);
const response = await fetch(
`${this.baseUrl}/${wikiIdentifier}/pages?path=${encodedPath}&api-version=7.0`,
{
headers: {
Authorization: authHeader,
},
}
);
if (response.status === 404) {
if (response.statusText.includes('Wiki not found')) {
throw new WikiNotFoundError(wikiIdentifier);
}
throw new WikiPageNotFoundError(wikiIdentifier, path);
}
if (!response.ok) {
throw new WikiError(
`Failed to get wiki page: ${response.statusText}`,
response.status,
wikiIdentifier,
path,
await response.text()
);
}
return response.json();
}
async searchWikiPages(wikiIdentifier: string, searchText: string, projectName: string, top: number = 20): Promise<any> {
const authHeader = await this.getAuthHeader();
const encodedSearchText = encodeURIComponent(searchText);
// Use the search endpoint
const response = await fetch(
`${this.config.orgUrl}/${projectName}/_apis/wiki/wikis/${wikiIdentifier}/searchResults?searchText=${encodedSearchText}&top=${top}&api-version=7.0`,
{
headers: {
Authorization: authHeader,
},
}
);
if (response.status === 404) {
if (response.statusText.includes('Wiki not found')) {
throw new WikiNotFoundError(wikiIdentifier);
}
throw new WikiError(
`Failed to search wiki pages: ${response.statusText}`,
response.status,
wikiIdentifier,
undefined,
await response.text()
);
}
if (!response.ok) {
throw new WikiError(
`Failed to search wiki pages: ${response.statusText}`,
response.status,
wikiIdentifier,
undefined,
await response.text()
);
}
return response.json();
}
async updateWikiPage(
wikiIdentifier: string,
path: string,
content: string,
comment?: string,
projectName?: string
): Promise<WikiPageUpdateResponse> {
const authHeader = await this.getAuthHeader();
const encodedPath = encodeURIComponent(path);
// Use the provided project name or the default one from config
const project = projectName || this.config.project;
console.log(`WikiApi.updateWikiPage called with:
- wikiIdentifier: ${wikiIdentifier}
- path: ${path}
- projectName: ${projectName || '(using default)'}
- resolved project: ${project}
- content length: ${content?.length || 0} characters
- comment: ${comment || '(default comment)'}`);
// Try to get the wiki first to verify it exists
try {
console.log(`Verifying wiki exists in project ${project}...`);
const wikiResponse = await fetch(`${this.config.orgUrl}/${project}/_apis/wiki/wikis/${wikiIdentifier}?api-version=7.0`, {
headers: {
Authorization: authHeader,
},
});
if (wikiResponse.ok) {
const wiki = await wikiResponse.json();
console.log(`Wiki found: ${wiki.name} (${wiki.id})`);
} else {
console.log(`Wiki verification failed: ${wikiResponse.status} ${wikiResponse.statusText}`);
const responseText = await wikiResponse.text();
console.log(`Wiki verification response: ${responseText}`);
}
} catch (error) {
console.log(`Error verifying wiki: ${error instanceof Error ? error.message : String(error)}`);
}
// Use the full URL with project name
const url = `${this.config.orgUrl}/${project}/_apis/wiki/wikis/${wikiIdentifier}/pages?path=${encodedPath}&api-version=7.0`;
console.log(`Updating wiki page at URL: ${url}`);
// Process escape sequences in the content
const processedContent = processEscapeSequences(content);
console.log(`Processing content with escape sequences. Original length: ${content.length}, Processed length: ${processedContent.length}`);
const response = await fetch(
url,
{
method: 'PUT',
headers: {
'Content-Type': 'application/json',
Authorization: authHeader,
},
body: JSON.stringify({
content: processedContent,
comment: comment || `Updated page ${path}`,
}),
}
);
console.log(`Response status: ${response.status} ${response.statusText}`);
if (response.status === 404) {
const responseText = await response.text();
console.log(`404 Response body: ${responseText}`);
if (responseText.includes('Wiki not found')) {
throw new WikiNotFoundError(wikiIdentifier);
}
throw new WikiPageNotFoundError(wikiIdentifier, path);
}
if (!response.ok) {
const responseText = await response.text();
console.log(`Error response body: ${responseText}`);
throw new WikiError(
`Failed to update wiki page: ${response.statusText}`,
response.status,
wikiIdentifier,
path,
responseText
);
}
return response.json();
}
}
