adminforth/adminforth/servers/openapiDocument.ts at main · devforth/adminforth · GitHub

Repository navigation

History

412 lines (350 loc) · 12.8 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

import type { AnySchemaObject } from 'ajv';

import type { IRegisteredApiSchema } from '../types/Back.js';

const COMPONENT_REF_PREFIX = '#/components/schemas/';

const JSON_SCHEMA_DIALECT = 'https://json-schema.org/draft/2020-12/schema';

const CONDITIONAL_NOTE = 'Runtime applies additional conditional validation rules that are documented in descriptions instead of nested schema conditionals.';

const SINGLE_OR_ARRAY_NOTE = 'Runtime also accepts a single object here, but the documented shape uses the array form because it is more stable for API reference UIs and generated clients.';

type SchemaKind = 'request' | 'response';

type BuildOpenApiDocumentOptions = {

title: string;

version: string;

description: string;

routes: IRegisteredApiSchema[];

};

type NormalizeOptions = {

componentName: string;

requestMode: boolean;

localDefs: Map<string, string>;

};

type TransformState = {

components: Record<string, AnySchemaObject>;

componentNames: WeakMap<object, string>;

usedNames: Set<string>;

};

function isSchemaObject(value: unknown): value is AnySchemaObject {

return !!value && typeof value === 'object' && !Array.isArray(value);

}

function toPascalCase(value: string): string {

return value

.replace(/([a-z0-9])([A-Z])/g, '$1 $2')

.split(/[^a-zA-Z0-9]+/)

.filter(Boolean)

.map((segment) => segment.charAt(0).toUpperCase() + segment.slice(1))

.join('');

}

function sanitizeComponentName(value: string): string {

const normalized = toPascalCase(value);

if (!normalized) {

return 'SchemaComponent';

}

return /^[A-Za-z_]/.test(normalized) ? normalized : `Schema${normalized}`;

}

function createRouteComponentName(route: IRegisteredApiSchema, kind: SchemaKind): string {

return sanitizeComponentName(`${route.method} ${route.path} ${kind}`);

}

function appendDescription(existing: string | undefined, note: string): string {

return existing ? `${existing}\n\n${note}` : note;

}

function extractLocalRefKey(ref: string): string | undefined {

if (!ref.startsWith('#/$defs/')) {

return undefined;

}

return ref.slice('#/$defs/'.length);

}

function hasCompositeKeywords(schema: AnySchemaObject): boolean {

return Array.isArray(schema.anyOf)

|| Array.isArray(schema.oneOf)

|| Array.isArray(schema.allOf)

|| Array.isArray(schema.prefixItems)

|| '$defs' in schema

|| 'if' in schema

|| 'then' in schema

|| 'else' in schema;

}

function shouldHoistSchema(schema: AnySchemaObject): boolean {

if (typeof schema.$ref === 'string' && Object.keys(schema).length === 1) {

return false;

}

if (typeof schema.title === 'string' && schema.title.trim().length > 0) {

return true;

}

if (hasCompositeKeywords(schema)) {

return true;

}

return schema.type === 'object'

&& isSchemaObject(schema.properties)

&& Object.keys(schema.properties).length > 1;

}

function createSchemaSignature(schema: AnySchemaObject): unknown {

return Object.fromEntries(

Object.entries(schema)

.filter(([key]) => key !== 'description' && key !== 'examples' && key !== 'title')

.map(([key, value]) => {

if (isSchemaObject(value)) {

return [key, createSchemaSignature(value)];

}

if (Array.isArray(value)) {

return [

key,

value.map((item) => isSchemaObject(item) ? createSchemaSignature(item) : item),

];

}

return [key, value];

}),

);

}

function schemasMatch(left: AnySchemaObject, right: AnySchemaObject): boolean {

if (typeof left.$ref === 'string' || typeof right.$ref === 'string') {

return left.$ref === right.$ref;

}

return JSON.stringify(createSchemaSignature(left)) === JSON.stringify(createSchemaSignature(right));

}

function simplifyRequestSchema(schema: AnySchemaObject): { schema: AnySchemaObject; notes: string[] } {

const simplifiedSchema: AnySchemaObject = { ...schema };

const notes: string[] = [];

const variants = Array.isArray(simplifiedSchema.oneOf)

? simplifiedSchema.oneOf

: Array.isArray(simplifiedSchema.anyOf)

? simplifiedSchema.anyOf

: null;

if (variants && variants.length === 2) {

const arrayVariant = variants.find((option) => isSchemaObject(option) && option.type === 'array' && isSchemaObject(option.items));

const singleVariant = variants.find((option) => option !== arrayVariant);

if (

arrayVariant

&& singleVariant

&& isSchemaObject(singleVariant)

&& isSchemaObject(arrayVariant.items)

&& schemasMatch(arrayVariant.items as AnySchemaObject, singleVariant)

) {

const { anyOf, oneOf, ...rest } = simplifiedSchema;

Object.assign(simplifiedSchema, rest, {

type: 'array',

items: arrayVariant.items,

});

delete simplifiedSchema.anyOf;

delete simplifiedSchema.oneOf;

notes.push(SINGLE_OR_ARRAY_NOTE);

}

if ('if' in simplifiedSchema || 'then' in simplifiedSchema || 'else' in simplifiedSchema) {

delete simplifiedSchema.if;

delete simplifiedSchema.then;

delete simplifiedSchema.else;

notes.push(CONDITIONAL_NOTE);

}

if (Array.isArray(simplifiedSchema.allOf)) {

const remainingSchemas = simplifiedSchema.allOf.filter((option) => {

return !(isSchemaObject(option) && ('if' in option || 'then' in option || 'else' in option));

});

if (remainingSchemas.length !== simplifiedSchema.allOf.length) {

if (remainingSchemas.length > 0) {

simplifiedSchema.allOf = remainingSchemas;

} else {

delete simplifiedSchema.allOf;

}

notes.push(CONDITIONAL_NOTE);

}

return { schema: simplifiedSchema, notes };

}

function createChildOptions(options: NormalizeOptions, suffix: string): NormalizeOptions {

return {

...options,

componentName: `${options.componentName}${toPascalCase(suffix)}`,

};

}

function resolveComponentName(state: TransformState, schema: AnySchemaObject, preferredName: string): string {

const existingName = state.componentNames.get(schema as object);

if (existingName) {

return existingName;

}

const titledName = typeof schema.title === 'string' && schema.title.trim().length > 0

? schema.title

: preferredName;

const baseName = sanitizeComponentName(titledName);

let candidate = baseName;

let suffix = 2;

while (state.usedNames.has(candidate)) {

candidate = `${baseName}${suffix}`;

suffix += 1;

}

state.usedNames.add(candidate);

state.componentNames.set(schema as object, candidate);

return candidate;

}

function registerComponent(state: TransformState, schema: AnySchemaObject, options: NormalizeOptions): AnySchemaObject {

const componentName = resolveComponentName(state, schema, options.componentName);

if (!state.components[componentName]) {

state.components[componentName] = {};

state.components[componentName] = normalizeSchema(state, schema, {

...options,

componentName,

});

}

return { $ref: `${COMPONENT_REF_PREFIX}${componentName}` };

}

function hoistLocalDefinitions(state: TransformState, schema: AnySchemaObject, options: NormalizeOptions): Map<string, string> {

const localDefs = new Map(options.localDefs);

const definitions = isSchemaObject(schema.$defs) ? schema.$defs as Record<string, AnySchemaObject> : undefined;

if (!definitions) {

return localDefs;

}

const entries = Object.entries(definitions).filter(([, definitionSchema]) => isSchemaObject(definitionSchema));

entries.forEach(([definitionKey, definitionSchema]) => {

const preferredName = typeof definitionSchema.title === 'string' && definitionSchema.title.trim().length > 0

? definitionSchema.title

: `${options.componentName}${toPascalCase(definitionKey)}`;

const componentName = resolveComponentName(state, definitionSchema, preferredName);

localDefs.set(definitionKey, componentName);

});

entries.forEach(([, definitionSchema]) => {

const componentName = state.componentNames.get(definitionSchema as object);

if (!componentName || state.components[componentName]) {

return;

}

state.components[componentName] = {};

state.components[componentName] = normalizeSchema(state, definitionSchema, {

...options,

componentName,

localDefs,

});

return localDefs;

}

function normalizeNestedSchema(state: TransformState, schema: AnySchemaObject, options: NormalizeOptions): AnySchemaObject {

if (typeof schema.$ref === 'string' && Object.keys(schema).length === 1) {

return normalizeSchema(state, schema, options);

}

if (shouldHoistSchema(schema)) {

return registerComponent(state, schema, options);

}

return normalizeSchema(state, schema, options);

}

function normalizeSchema(state: TransformState, schema: AnySchemaObject, options: NormalizeOptions): AnySchemaObject {

const localDefs = hoistLocalDefinitions(state, schema, options);

const { schema: simplifiedSchema, notes } = options.requestMode

? simplifyRequestSchema(schema)

: { schema, notes: [] as string[] };

const normalized: AnySchemaObject = {};

Object.entries(simplifiedSchema).forEach(([key, value]) => {

if (key === '$defs' || key === '$schema' || key === '$id') {

return;

}

if (key === '$ref' && typeof value === 'string') {

const localRefKey = extractLocalRefKey(value);

normalized.$ref = localRefKey && localDefs.has(localRefKey)

? `${COMPONENT_REF_PREFIX}${localDefs.get(localRefKey)}`

: value;

return;

}

if ((key === 'properties' || key === 'patternProperties' || key === 'dependentSchemas') && isSchemaObject(value)) {

normalized[key] = Object.fromEntries(

Object.entries(value).map(([propertyName, propertySchema]) => {

if (!isSchemaObject(propertySchema)) {

return [propertyName, propertySchema];

}

return [

propertyName,

normalizeNestedSchema(state, propertySchema, {

...createChildOptions(options, propertyName),

localDefs,

}),

];

}),

);

return;

}

if ((key === 'items' || key === 'contains' || key === 'additionalProperties' || key === 'propertyNames' || key === 'not' || key === 'unevaluatedProperties' || key === 'unevaluatedItems' || key === 'contentSchema') && isSchemaObject(value)) {

normalized[key] = normalizeNestedSchema(state, value, {

...createChildOptions(options, key === 'additionalProperties' ? 'value' : key === 'propertyNames' ? 'propertyName' : key),

localDefs,

});

return;

}

if ((key === 'anyOf' || key === 'oneOf' || key === 'allOf' || key === 'prefixItems') && Array.isArray(value)) {

normalized[key] = value.map((option, index) => {

if (!isSchemaObject(option)) {

return option;

}

return normalizeNestedSchema(state, option, {

...createChildOptions(options, `${key}Option${index + 1}`),

localDefs,

});

return;

}

normalized[key] = value;

});

if (notes.length > 0) {

normalized.description = appendDescription(

typeof normalized.description === 'string' ? normalized.description : undefined,

notes.join(' '),

);

}

return normalized;

}

export function buildOpenApiDocument(options: BuildOpenApiDocumentOptions): {[key: string]: any} {

const state: TransformState = {

components: {},

componentNames: new WeakMap(),

usedNames: new Set(),

};

const paths: Record<string, Record<string, unknown>> = {};

options.routes.forEach((route) => {

if (!route.request_schema && !route.response_schema) {

return;

}

if (!paths[route.path]) {

paths[route.path] = {};

}

paths[route.path][route.method] = {

...(route.description ? {

description: route.description,

} : {}),

...(route.request_schema ? {

requestBody: {

required: true,

content: {

'application/json': {

schema: registerComponent(state, route.request_schema, {

componentName: createRouteComponentName(route, 'request'),

requestMode: true,

localDefs: new Map(),

}),

} : {}),

responses: {

200: route.response_schema ? {

description: 'Successful response',

content: {

'application/json': {

schema: registerComponent(state, route.response_schema, {

componentName: createRouteComponentName(route, 'response'),

requestMode: false,

localDefs: new Map(),

}),

} : {

description: 'Successful response',

};

});

return {

openapi: '3.1.0',

jsonSchemaDialect: JSON_SCHEMA_DIALECT,

info: {

title: options.title,

version: options.version,

description: options.description,

paths,

components: {

schemas: state.components,

};

}

adminforth/adminforth/servers/openapiDocument.ts at main · devforth/adminforth · GitHub

Repository navigation

Expand file tree

Breadcrumbs

openapiDocument.ts

Latest commit

History

Breadcrumbs

openapiDocument.ts

File metadata and controls