@visulima/api-platform 1.0.2 → 1.1.0

package/src/next/webpack/with-open-api.ts

@@ -1,63 +0,0 @@
-import type { BaseDefinition } from "@visulima/jsdoc-open-api";
-import { SwaggerCompilerPlugin } from "@visulima/jsdoc-open-api";
-import type { NextConfig } from "next";
-import fs from "node:fs";
-import path from "node:path";
-import type { Configuration } from "webpack";
-
-const withOpenApi = ({
-    definition, sources, verbose, output = "swagger/swagger.json",
-// eslint-disable-next-line max-len
-}: { definition: Exclude<BaseDefinition, "openapi"> & { openapi?: string }; sources: string[]; verbose?: boolean; output: string }) => (nextConfig: NextConfig) => {
-    return {
-        ...nextConfig,
-        webpack: (config: Configuration, options: any) => {
-            if (!options.isServer) {
-                return config;
-            }
-
-            if (output.startsWith("/")) {
-                // eslint-disable-next-line no-param-reassign
-                output = output.slice(1);
-            }
-
-            if (!output.endsWith(".json")) {
-                throw new Error("The output path must end with .json");
-            }
-
-            // eslint-disable-next-line no-param-reassign
-            config = {
-                ...config,
-                plugins: [
-                    // @ts-ignore
-                    ...config.plugins,
-                    new SwaggerCompilerPlugin(
-                        `${options.dir}/${output}`,
-                        sources.map((source) => {
-                            const combinedPath = path.join(options.dir, source.replace("./", ""));
-
-                            // Check if the path is a directory
-                            fs.lstatSync(combinedPath).isDirectory();
-
-                            return combinedPath;
-                        }),
-                        {
-                            // @ts-ignore
-                            openapi: "3.0.0",
-                            ...definition,
-                        },
-                        { verbose },
-                    ),
-                ],
-            };
-
-            if (typeof nextConfig.webpack === "function") {
-                return nextConfig.webpack(config, options);
-            }
-
-            return config;
-        },
-    };
-};
-
-export default withOpenApi;

package/src/swagger/extend-swagger-spec.ts

@@ -1,167 +0,0 @@
-import { header as headerCase } from "case";
-import type { OpenAPIV3 } from "openapi-types";
-import type { OAS3Definition, Operation, Responses } from "swagger-jsdoc";
-
-const extendComponentSchemas = (spec: Partial<OAS3Definition>, schemaName: string, schema: OpenAPIV3.SchemaObject) => {
-    if (typeof spec.components !== "object") {
-        // eslint-disable-next-line no-param-reassign
-        spec.components = {};
-    }
-
-    if (typeof spec.components.schemas !== "object") {
-        // eslint-disable-next-line no-param-reassign
-        spec.components.schemas = {};
-    }
-
-    if (typeof spec.components.schemas[schemaName] === "undefined") {
-        // eslint-disable-next-line no-param-reassign
-        spec.components.schemas[schemaName] = schema;
-    }
-};
-
-const extendComponentExamples = (spec: Partial<OAS3Definition>, exampleName: string, example: OpenAPIV3.SchemaObject) => {
-    if (typeof spec.components !== "object") {
-        // eslint-disable-next-line no-param-reassign
-        spec.components = {};
-    }
-
-    if (typeof spec.components.examples !== "object") {
-        // eslint-disable-next-line no-param-reassign
-        spec.components.examples = {};
-    }
-
-    if (typeof spec.components.examples[exampleName] === "undefined") {
-        // eslint-disable-next-line no-param-reassign
-        spec.components.examples[exampleName] = example;
-    }
-};
-
-function extendSwaggerWithMediaTypeSchema(
-    responseSpec: OpenAPIV3.ResponseObject,
-    allowedMediaTypes: { [p: string]: boolean } | undefined,
-    pathKey: string,
-    spec: Partial<OAS3Definition>,
-    methodSpec: Operation,
-    status: string,
-) {
-    let examples:
-        | {
-              [media: string]: OpenAPIV3.ReferenceObject | OpenAPIV3.ExampleObject;
-          }
-        | undefined;
-
-    Object.entries(responseSpec.content as object).forEach(([mediaName, contentSpec]) => {
-        if (typeof contentSpec.schema === "object") {
-            const { schema } = contentSpec;
-
-            if (mediaName === "application/json" && typeof contentSpec.examples !== "undefined") {
-                examples = contentSpec.examples;
-            }
-
-            if (typeof (schema as OpenAPIV3.ReferenceObject).$ref !== "undefined") {
-                return;
-            }
-
-            const schemaIsArray = (schema as OpenAPIV3.SchemaObject).type === "array";
-
-            Object.entries(allowedMediaTypes || {}).forEach(([mediaType, allowed]) => {
-                if (!allowed) {
-                    return;
-                }
-
-                // eslint-disable-next-line max-len
-                const schemaName = `${headerCase(pathKey.trim().replace("/", ""))}${mediaType === "application/ld+json" ? ".jsonld" : ""}`;
-
-                extendComponentSchemas(spec as OAS3Definition, schemaName, schema as OpenAPIV3.SchemaObject);
-
-                if (typeof methodSpec?.responses?.[status]?.content[mediaType]?.schema === "undefined") {
-                    // eslint-disable-next-line no-param-reassign
-                    (methodSpec.responses as Responses)[status].content[mediaType] = { schema: {} };
-                }
-
-                // eslint-disable-next-line no-param-reassign
-                (methodSpec.responses as Responses)[status].content[mediaType].schema = schemaIsArray
-                    ? {
-                          type: "array",
-                          items: {
-                              $ref: `#/components/schemas/${schemaName}`,
-                          },
-                      }
-                    : {
-                          $ref: `#/components/schemas/${schemaName}`,
-                      };
-
-                if (typeof methodSpec.produces === "undefined") {
-                    // eslint-disable-next-line no-param-reassign
-                    methodSpec.produces = [];
-                }
-
-                methodSpec.produces.push(mediaType);
-            });
-        }
-    });
-
-    return examples;
-}
-
-function extendSwaggerWithMediaTypeExamples(
-    responseSpec: OpenAPIV3.ResponseObject,
-    allowedMediaTypes: { [p: string]: boolean } | undefined,
-    pathKey: string,
-    spec: Partial<OAS3Definition>,
-    examples: { [p: string]: OpenAPIV3.ReferenceObject | OpenAPIV3.ExampleObject } | undefined,
-    methodSpec: Operation,
-    status: string,
-) {
-    Object.keys(responseSpec.content as object).forEach((mediaName) => {
-        if (mediaName === "application/json") {
-            return;
-        }
-
-        Object.entries(allowedMediaTypes || {}).forEach(([mediaType, allowed]) => {
-            if (!allowed) {
-                return;
-            }
-
-            // eslint-disable-next-line max-len
-            const examplesName = `${headerCase(pathKey.trim().replace("/", ""))}${mediaType === "application/ld+json" ? ".jsonld" : ""}`;
-
-            extendComponentExamples(spec as OAS3Definition, examplesName, examples as OpenAPIV3.SchemaObject);
-
-            if (typeof methodSpec?.responses?.[status]?.content[mediaType]?.examples === "undefined") {
-                // eslint-disable-next-line no-param-reassign
-                (methodSpec.responses as Responses)[status].content[mediaType] = { examples: {} };
-            }
-
-            // eslint-disable-next-line no-param-reassign
-            (methodSpec.responses as Responses)[status].content[mediaType].examples = examples;
-        });
-    });
-}
-
-// eslint-disable-next-line radar/cognitive-complexity
-export default function extendSwaggerSpec(spec: Partial<OAS3Definition>, allowedMediaTypes?: { [key: string]: boolean }): Partial<OAS3Definition> {
-    if (typeof spec === "object" && typeof spec.paths === "object") {
-        Object.entries(spec.paths).forEach(([pathKey, pathSpec]) => {
-            Object.values(pathSpec).forEach((methodSpec) => {
-                if (typeof methodSpec.responses === "object") {
-                    Object.entries<OpenAPIV3.ResponseObject>(methodSpec.responses).forEach(([status, responseSpec]) => {
-                        if (typeof responseSpec.content === "object") {
-                            let examples:
-                                | {
-                                      [media: string]: OpenAPIV3.ReferenceObject | OpenAPIV3.ExampleObject;
-                                  }
-                                | undefined = extendSwaggerWithMediaTypeSchema(responseSpec, allowedMediaTypes, pathKey, spec, methodSpec, status);
-
-                            if (typeof examples !== "undefined") {
-                                extendSwaggerWithMediaTypeExamples(responseSpec, allowedMediaTypes, pathKey, spec, examples, methodSpec, status);
-                            }
-                        }
-                    });
-                }
-            });
-        });
-    }
-
-    return spec;
-}

package/src/swagger/swagger-handler.ts

@@ -1,83 +0,0 @@
-// eslint-disable-next-line unicorn/prevent-abbreviations,import/no-extraneous-dependencies
-import type { ModelsToOpenApiParameters, SwaggerModelsConfig } from "@visulima/crud";
-// eslint-disable-next-line unicorn/prevent-abbreviations,import/no-extraneous-dependencies
-import { modelsToOpenApi } from "@visulima/crud";
-import debug from "debug";
-import merge from "lodash.merge";
-import { existsSync, readFileSync } from "node:fs";
-import type { IncomingMessage, ServerResponse } from "node:http";
-import path from "node:path";
-import type { OAS3Definition, Tag } from "swagger-jsdoc";
-
-import yamlTransformer from "../connect/serializers/yaml";
-import extendSwaggerSpec from "./extend-swagger-spec";
-
-// eslint-disable-next-line testing-library/no-debugging-utils
-const swaggerCrudDebug = debug("visulima:api-platform:swagger:crud:get-static-properties-swagger");
-
-const swaggerHandler = (
-    options: Partial<{
-        allowedMediaTypes: { [key: string]: boolean };
-        swaggerFilePath: string;
-        crud: Exclude<ModelsToOpenApiParameters, "swagger"> & {
-            swagger?: {
-                models?: SwaggerModelsConfig<string>;
-            };
-        };
-    }> = {},
-) => {
-    const {
-        allowedMediaTypes = {
-            "application/json": true,
-        },
-        swaggerFilePath,
-        crud,
-    } = options;
-
-    return async <Request extends IncomingMessage, Response extends ServerResponse>(request: Request, response: Response) => {
-        const swaggerPath = path.join(process.cwd(), swaggerFilePath || "swagger/swagger.json");
-
-        if (!existsSync(swaggerPath)) {
-            throw new Error(`Swagger file not found at ${swaggerPath}. Did you change the output path in "withOpenApi" inside the next.config.js file?`);
-        }
-
-        const fileContents = readFileSync(swaggerPath, "utf8");
-
-        let spec = extendSwaggerSpec(JSON.parse(fileContents) as OAS3Definition, allowedMediaTypes) as OAS3Definition;
-        let crudSwagger: Partial<OAS3Definition> = {};
-
-        if (typeof crud !== "undefined") {
-            try {
-                const modelsOpenApi = await modelsToOpenApi(crud);
-
-                crudSwagger = {
-                    components: { schemas: modelsOpenApi.schemas, examples: modelsOpenApi.examples },
-                    tags: modelsOpenApi.tags as Tag[],
-                    paths: modelsOpenApi.paths,
-                };
-
-                crudSwagger = extendSwaggerSpec(crudSwagger, allowedMediaTypes);
-
-                swaggerCrudDebug(JSON.stringify(crudSwagger, null, 2));
-
-                spec = merge(spec, crudSwagger);
-            } catch (error) {
-                // eslint-disable-next-line no-console
-                console.log(error);
-                throw new Error("Please install @visulima/crud to use the crud swagger generator.");
-            }
-        }
-
-        if (typeof request.headers.accept === "string" && /yaml|yml/.test(request.headers.accept)) {
-            response.statusCode = 200;
-            response.setHeader("Content-Type", request.headers.accept);
-            response.end(yamlTransformer(spec));
-        } else {
-            response.statusCode = 200;
-            response.setHeader("Content-Type", "application/json");
-            response.end(JSON.stringify(spec, null, 2));
-        }
-    };
-};
-
-export default swaggerHandler;

package/src/utils.ts

@@ -1,37 +0,0 @@
-import { IncomingMessage } from "node:http";
-import { parse as urlParse } from "node:url";
-
-type IncomingApiRequest<TApiRequest = IncomingMessage> = TApiRequest & {
-    body?: any;
-    query?: any;
-};
-
-export const jsonResponse = (response: any, status: number, data?: unknown): void => {
-    response.statusCode = status;
-    response.setHeader("Content-Type", "application/json");
-    response.end(data ? JSON.stringify(data) : "");
-};
-
-export const parseBody = async (request: IncomingApiRequest): Promise<unknown> => {
-    if (request.body) {
-        return request.body;
-    }
-
-    const buffers = [];
-
-    // eslint-disable-next-line no-restricted-syntax
-    for await (const chunk of request) {
-        buffers.push(chunk);
-    }
-
-    const data = Buffer.concat(buffers).toString();
-
-    return data ? JSON.parse(data) : null;
-};
-
-export const parseQuery = (request: IncomingApiRequest): unknown => {
-    if (request.query) {
-        return request.query;
-    }
-    return urlParse(request.url ?? "", true).query;
-};

package/src/zod/date-in-schema.ts

@@ -1,57 +0,0 @@
-import type { ParseInput, ParseReturnType, ZodTypeDef } from "zod";
-import {
-    addIssueToContext, INVALID, ZodIssueCode, ZodParsedType, ZodType,
-} from "zod";
-
-const zodDateInKind = "ZodDateIn";
-
-// simple regex for ISO date, supports the following formats:
-// 2021-01-01T00:00:00.000Z
-// 2021-01-01T00:00:00Z
-// 2021-01-01T00:00:00
-// 2021-01-01
-export const isoDateRegex = /^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d{3})?)?Z?$/;
-
-// eslint-disable-next-line unicorn/prevent-abbreviations
-export interface ZodDateInDef extends ZodTypeDef {
-    typeName: typeof zodDateInKind;
-}
-
-export class ZodDateIn extends ZodType<Date, ZodDateInDef, string> {
-    // eslint-disable-next-line no-underscore-dangle
-    _parse(input: ParseInput): ParseReturnType<Date> {
-        // eslint-disable-next-line no-underscore-dangle
-        const { status, ctx } = this._processInputParams(input);
-        if (ctx.parsedType !== ZodParsedType.string) {
-            addIssueToContext(ctx, {
-                code: ZodIssueCode.invalid_type,
-                expected: ZodParsedType.string,
-                received: ctx.parsedType,
-            });
-            return INVALID;
-        }
-
-        if (!isoDateRegex.test(ctx.data as string)) {
-            addIssueToContext(ctx, {
-                code: ZodIssueCode.invalid_string,
-                validation: "regex",
-            });
-            status.dirty();
-        }
-
-        const date = new Date(ctx.data);
-
-        if (Number.isNaN(date.getTime())) {
-            addIssueToContext(ctx, {
-                code: ZodIssueCode.invalid_date,
-            });
-            return INVALID;
-        }
-
-        return { status: status.value, value: date };
-    }
-
-    static create = () => new ZodDateIn({
-        typeName: zodDateInKind,
-    });
-}

package/src/zod/date-out-schema.ts

@@ -1,41 +0,0 @@
-import type { ParseInput, ParseReturnType, ZodTypeDef } from "zod";
-import {
-    addIssueToContext, INVALID, ZodIssueCode, ZodParsedType, ZodType,
-} from "zod";
-
-const zodDateOutKind = "ZodDateOut";
-
-// eslint-disable-next-line unicorn/prevent-abbreviations
-export interface ZodDateOutDef extends ZodTypeDef {
-    typeName: typeof zodDateOutKind;
-}
-
-export class ZodDateOut extends ZodType<string, ZodDateOutDef, Date> {
-    // eslint-disable-next-line no-underscore-dangle
-    _parse(input: ParseInput): ParseReturnType<string> {
-        // eslint-disable-next-line no-underscore-dangle
-        const { status, ctx } = this._processInputParams(input);
-
-        if (ctx.parsedType !== ZodParsedType.date) {
-            addIssueToContext(ctx, {
-                code: ZodIssueCode.invalid_type,
-                expected: ZodParsedType.date,
-                received: ctx.parsedType,
-            });
-            return INVALID;
-        }
-
-        if (Number.isNaN(ctx.data.getTime())) {
-            addIssueToContext(ctx, {
-                code: ZodIssueCode.invalid_date,
-            });
-            return INVALID;
-        }
-
-        return { status: status.value, value: (ctx.data as Date).toISOString() };
-    }
-
-    static create = () => new ZodDateOut({
-        typeName: zodDateOutKind,
-    });
-}

package/src/zod/index.ts

@@ -1,9 +0,0 @@
-import { withGetType } from "zod-to-ts";
-
-import { ZodDateIn } from "./date-in-schema";
-import { ZodDateOut } from "./date-out-schema";
-
-// eslint-disable-next-line max-len
-export const dateIn = (...parameters: Parameters<typeof ZodDateIn.create>) => withGetType(ZodDateIn.create(...parameters), (ts) => ts.factory.createKeywordTypeNode(ts.SyntaxKind.StringKeyword));
-// eslint-disable-next-line max-len
-export const dateOut = (...parameters: Parameters<typeof ZodDateOut.create>) => withGetType(ZodDateOut.create(...parameters), (ts) => ts.factory.createKeywordTypeNode(ts.SyntaxKind.StringKeyword));