#!/usr/bin/env node // scripts/generate-changelog-mintlify.js // Generate changelog entries using proper Mintlify Update component const fs = require('fs'); const path = require('path'); const log = { info: (msg) => console.log(`ℹ️ ${msg}`), success: (msg) => console.log(`✅ ${msg}`), warn: (msg) => console.log(`⚠️ ${msg}`), error: (msg) => console.error(`❌ ${msg}`) }; // Generate Mintlify Update component entry function formatMintlifyChangelogEntry(changes, apiVersion, timestamp) { const date = new Date(timestamp).toISOString().split('T')[0]; let entry = `\n\n`; const hasChanges = changes.added.length > 0 || changes.modified.length > 0 || changes.removed.length > 0 || changes.deprecated.length > 0; if (!hasChanges) { entry += `## Minor Updates\n\n`; entry += `Minor improvements and optimizations to existing endpoints.\n\n`; entry += `\n\n`; return entry; } // Added endpoints if (changes.added.length > 0) { entry += `## ✨ New Endpoints\n\n`; changes.added.forEach(endpoint => { const method = endpoint.method; const methodEmoji = { 'GET': '📖', 'POST': '📝', 'PUT': '✏️', 'PATCH': '🔧', 'DELETE': '🗑️' }[method] || '🔗'; entry += `- ${methodEmoji} **${method}** \`${endpoint.path}\` - ${endpoint.summary}\n`; if (endpoint.tags.length > 0) { entry += ` - Tags: ${endpoint.tags.map(tag => `\`${tag}\``).join(', ')}\n`; } }); entry += `\n`; } // Deprecated endpoints if (changes.deprecated.length > 0) { entry += `## ⚠️ Deprecated Endpoints\n\n`; entry += `\n`; entry += `The following endpoints are deprecated and will be removed in a future version:\n`; entry += `\n\n`; changes.deprecated.forEach(endpoint => { entry += `- **${endpoint.method}** \`${endpoint.path}\` - ${endpoint.summary}\n`; }); entry += `\n`; } // Removed endpoints if (changes.removed.length > 0) { entry += `## 🗑️ Removed Endpoints\n\n`; entry += `\n`; entry += `The following endpoints have been removed:\n`; entry += `\n\n`; changes.removed.forEach(endpoint => { entry += `- **${endpoint.method}** \`${endpoint.path}\` - ${endpoint.summary}\n`; }); entry += `\n`; } // Summary entry += `## 📊 Summary\n\n`; entry += `- **Added**: ${changes.added.length} endpoints\n`; entry += `- **Modified**: ${changes.modified.length} endpoints\n`; entry += `- **Deprecated**: ${changes.deprecated.length} endpoints\n`; entry += `- **Removed**: ${changes.removed.length} endpoints\n\n`; entry += `\n\n`; return entry; } // Compare two OpenAPI specs function compareSpecs(oldSpec, newSpec) { const changes = { added: [], modified: [], removed: [], deprecated: [] }; const oldPaths = oldSpec?.paths || {}; const newPaths = newSpec?.paths || {}; // Find added endpoints Object.entries(newPaths).forEach(([path, pathItem]) => { if (!oldPaths[path]) { Object.keys(pathItem).forEach(method => { if (typeof pathItem[method] === 'object') { changes.added.push({ method: method.toUpperCase(), path, summary: pathItem[method].summary || `${method.toUpperCase()} ${path}`, tags: pathItem[method].tags || [] }); } }); } else { // Check for new methods on existing paths Object.entries(pathItem).forEach(([method, operation]) => { if (typeof operation === 'object' && !oldPaths[path][method]) { changes.added.push({ method: method.toUpperCase(), path, summary: operation.summary || `${method.toUpperCase()} ${path}`, tags: operation.tags || [] }); } }); } }); // Find removed endpoints Object.entries(oldPaths).forEach(([path, pathItem]) => { if (!newPaths[path]) { Object.keys(pathItem).forEach(method => { if (typeof pathItem[method] === 'object') { changes.removed.push({ method: method.toUpperCase(), path, summary: pathItem[method].summary || `${method.toUpperCase()} ${path}`, tags: pathItem[method].tags || [] }); } }); } }); // Find deprecated endpoints Object.entries(newPaths).forEach(([path, pathItem]) => { Object.entries(pathItem).forEach(([method, operation]) => { if (typeof operation === 'object' && operation.deprecated) { changes.deprecated.push({ method: method.toUpperCase(), path, summary: operation.summary || `${method.toUpperCase()} ${path}`, tags: operation.tags || [] }); } }); }); return changes; } // Update changelog.mdx with proper Mintlify format function updateMintlifyChangelog(changelogEntry, changelogPath = './changelog.mdx') { let content = ''; // Read existing changelog or create header if (fs.existsSync(changelogPath)) { content = fs.readFileSync(changelogPath, 'utf8'); } else { content = `--- title: "API Changelog" description: "Track changes and updates to the Royalti.io API" --- # API Changelog New updates and improvements to the Royalti.io API. This changelog is automatically generated when API changes are detected. `; } // Insert new entry after the header const headerEnd = content.indexOf('\n\n Save summary JSON to file --changelog Changelog file path (default: ./changelog.mdx) --help, -h Show this help message Examples: node scripts/generate-changelog-mintlify.js ./old-openapi.json ./openapi.json node scripts/generate-changelog-mintlify.js ./openapi.json `); process.exit(0); } const oldSpecPath = args[0] === './openapi.json' ? null : args[0]; const newSpecPath = args[1] || args[0] || './openapi.json'; const options = {}; const outputIndex = args.indexOf('--output'); if (outputIndex !== -1 && args[outputIndex + 1]) { options.outputPath = args[outputIndex + 1]; } const changelogIndex = args.indexOf('--changelog'); if (changelogIndex !== -1 && args[changelogIndex + 1]) { options.changelogPath = args[changelogIndex + 1]; } generateMintlifyChangelog(oldSpecPath, newSpecPath, options) .then((result) => { process.exit(result.success ? 0 : 1); }) .catch((error) => { log.error(`Unexpected error: ${error.message}`); process.exit(1); }); } module.exports = { generateMintlifyChangelog, formatMintlifyChangelogEntry, compareSpecs };

Introduction

Guides

Auth

User

Artist

Asset

Product

Splits

Royalties

File

Payment

Expense

Checklists

Revenue

Accounting

Payment Requests

Payment Settings

VertoFx

Integration

Notifications

Release

Release Media

Track Media

Release Asset

Track Management

Sources

Page Not Found