zoriya/elysia-swagger
1
0
Fork 0
mirror of https://github.com/zoriya/elysia-swagger.git synced 2025-12-06 00:36:10 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #148 from Abraxas-365/fix/swagger-date-time

Browse Source 
fix: swagger date time
This commit is contained in:
Marc Laventure
2024-09-25 16:43:22 -07:00
committed by GitHub
parent 337926c8b4 3d0e07f22a
commit 18860ac252
2 changed files with 67 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

BIN
bun.lockb
View File

Binary file not shown.

71
src/swagger/index.ts
View File

@@ -1,4 +1,52 @@
import type { OpenAPIV3 } from 'openapi-types'
import { OpenAPIV3 } from 'openapi-types';
type DateTimeSchema = {
type: 'string';
format: 'date-time';
default?: string;
};
type SchemaObject = OpenAPIV3.SchemaObject | OpenAPIV3.ReferenceObject;
function isSchemaObject(schema: SchemaObject): schema is OpenAPIV3.SchemaObject {
return 'type' in schema || 'properties' in schema || 'items' in schema;
}
function isDateTimeProperty(key: string, schema: OpenAPIV3.SchemaObject): boolean {
return (key === 'createdAt' || key === 'updatedAt') &&
'anyOf' in schema &&
Array.isArray(schema.anyOf);
}
function transformDateProperties(schema: SchemaObject): SchemaObject {
if (!isSchemaObject(schema) || typeof schema !== 'object' || schema === null) {
return schema;
}
const newSchema: OpenAPIV3.SchemaObject = { ...schema };
Object.entries(newSchema).forEach(([key, value]) => {
if (isSchemaObject(value)) {
if (isDateTimeProperty(key, value)) {
const dateTimeFormat = value.anyOf?.find((item): item is OpenAPIV3.SchemaObject =>
isSchemaObject(item) && item.format === 'date-time'
);
if (dateTimeFormat) {
const dateTimeSchema: DateTimeSchema = {
type: 'string',
format: 'date-time',
default: dateTimeFormat.default
};
(newSchema as Record<string, SchemaObject>)[key] = dateTimeSchema;
}
} else {
(newSchema as Record<string, SchemaObject>)[key] = transformDateProperties(value);
}
}
});
return newSchema;
}
export const SwaggerUIRender = (
info: OpenAPIV3.InfoObject,
@@ -11,7 +59,21 @@ export const SwaggerUIRender = (
},
stringifiedSwaggerOptions: string,
autoDarkMode?: boolean
) => `<!DOCTYPE html>
): string => {
const swaggerOptions: OpenAPIV3.Document = JSON.parse(stringifiedSwaggerOptions);
if (swaggerOptions.components && swaggerOptions.components.schemas) {
swaggerOptions.components.schemas = Object.fromEntries(
Object.entries(swaggerOptions.components.schemas).map(([key, schema]) => [
key,
transformDateProperties(schema)
])
);
}
const transformedStringifiedSwaggerOptions = JSON.stringify(swaggerOptions);
return `<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
@@ -57,8 +119,9 @@ export const SwaggerUIRender = (
<script src="https://unpkg.com/swagger-ui-dist@${version}/swagger-ui-bundle.js" crossorigin></script>
<script>
window.onload = () => {
window.ui = SwaggerUIBundle(${stringifiedSwaggerOptions});
window.ui = SwaggerUIBundle(${transformedStringifiedSwaggerOptions});
};
</script>
</body>
</html>`
</html>`;
};