@drax/crud-back 0.11.5 → 0.12.1

package/dist/builders/CrudSchemaBuilder.js

@@ -0,0 +1,349 @@
+import z from 'zod';
+import { zodToJsonSchema } from 'zod-to-json-schema';
+import { IdParamSchema, DeleteBodyResponseSchema, PaginateQuerySchema, PaginateBodyResponseSchema, FindQuerySchema, SearchQuerySchema, FindByParamSchema, ErrorBodyResponseSchema, ValidationErrorBodyResponseSchema, ExportBodyResponseSchema } from '../index.js';
+export class CrudSchemaBuilder {
+    constructor(entitySchema, entityCreateSchema, entityUpdateSchema, entityName, target = 'openApi3', tags = []) {
+        this.target = 'openApi3'; //"jsonSchema7" | "jsonSchema2019-09" | "openApi3" | "openAi"
+        this.entitySchema = entitySchema;
+        this.entityCreateSchema = entityCreateSchema;
+        this.entityUpdateSchema = entityUpdateSchema;
+        this.entityName = entityName;
+        this.tags = tags;
+        this.target = target;
+    }
+    get getTags() {
+        if (this.tags.length > 0) {
+            return { tags: this.tags };
+        }
+        return [];
+    }
+    get jsonEntityCreateSchema() {
+        return zodToJsonSchema(this.entityCreateSchema, { target: this.target });
+    }
+    get jsonEntityUpdateSchema() {
+        return zodToJsonSchema(this.entityUpdateSchema, { target: this.target });
+    }
+    get jsonEntitySchema() {
+        return zodToJsonSchema(this.entitySchema, { target: this.target });
+    }
+    get jsonEntityArraySchema() {
+        return zodToJsonSchema(z.array(this.entitySchema), { target: this.target });
+    }
+    get jsonExportBodyResponse() {
+        return zodToJsonSchema(ExportBodyResponseSchema, { target: this.target });
+    }
+    get jsonErrorBodyResponse() {
+        return zodToJsonSchema(ErrorBodyResponseSchema, { target: this.target });
+    }
+    get jsonValidationErrorBodyResponse() {
+        return zodToJsonSchema(ValidationErrorBodyResponseSchema, { target: this.target });
+    }
+    get jsonFindQuerySchema() {
+        return zodToJsonSchema(FindQuerySchema, { target: this.target });
+    }
+    get jsonSearchQuerySchema() {
+        return zodToJsonSchema(SearchQuerySchema, { target: this.target });
+    }
+    get jsonPaginateQuerySchema() {
+        return zodToJsonSchema(PaginateQuerySchema, { target: this.target });
+    }
+    get jsonDeleteBodyResponseSchema() {
+        return zodToJsonSchema(DeleteBodyResponseSchema, { target: this.target });
+    }
+    get jsonFindByParamSchema() {
+        return zodToJsonSchema(FindByParamSchema, { target: this.target });
+    }
+    get jsonPaginateBodyResponseSchema() {
+        return zodToJsonSchema(PaginateBodyResponseSchema.extend({
+            items: z.array(this.entitySchema)
+        }), { target: this.target });
+    }
+    get jsonIdParamSchema() {
+        return zodToJsonSchema(IdParamSchema, { target: this.target });
+    }
+    /**
+     * Get JSON schema for export
+     */
+    get exportSchema() {
+        return {
+            ...(this.getTags),
+            query: this.jsonFindQuerySchema,
+            response: {
+                200: this.jsonExportBodyResponse,
+                400: this.jsonErrorBodyResponse,
+                401: this.jsonErrorBodyResponse,
+                403: this.jsonErrorBodyResponse,
+                500: this.jsonErrorBodyResponse
+            }
+        };
+    }
+    /**
+     * Get JSON schema for finding an entity by ID
+     */
+    get findByIdSchema() {
+        return {
+            ...(this.getTags),
+            params: this.jsonIdParamSchema,
+            response: {
+                200: this.jsonEntitySchema,
+                400: this.jsonErrorBodyResponse,
+                401: this.jsonErrorBodyResponse,
+                403: this.jsonErrorBodyResponse,
+                500: this.jsonErrorBodyResponse
+            }
+        };
+    }
+    /**
+     * Get JSON schema for finding an entity by IDs
+     */
+    get findByIdsSchema() {
+        return {
+            ...(this.getTags),
+            params: zodToJsonSchema(z.object({
+                ids: z.string().regex(/^[^,]+(,[^,]+)*$/, "Debe ser una lista de valores separados por coma sin comas consecutivas")
+            }), { target: this.target }),
+            response: {
+                200: this.jsonEntityArraySchema,
+                400: this.jsonErrorBodyResponse,
+                401: this.jsonErrorBodyResponse,
+                403: this.jsonErrorBodyResponse,
+                500: this.jsonErrorBodyResponse
+            }
+        };
+    }
+    /**
+     * Get JSON schema for search an entity
+     */
+    get searchSchema() {
+        return {
+            ...(this.getTags),
+            query: this.jsonSearchQuerySchema,
+            response: {
+                200: this.jsonEntityArraySchema,
+                400: this.jsonErrorBodyResponse,
+                401: this.jsonErrorBodyResponse,
+                403: this.jsonErrorBodyResponse,
+                500: this.jsonErrorBodyResponse
+            }
+        };
+    }
+    /**
+     * Get JSON schema for find entities
+     */
+    get findSchema() {
+        return {
+            ...(this.getTags),
+            query: this.jsonFindQuerySchema,
+            response: {
+                200: this.jsonEntityArraySchema,
+                400: this.jsonErrorBodyResponse,
+                401: this.jsonErrorBodyResponse,
+                403: this.jsonErrorBodyResponse,
+                500: this.jsonErrorBodyResponse
+            }
+        };
+    }
+    /**
+     * Get JSON schema for find one entity
+     */
+    get findOneSchema() {
+        return {
+            ...(this.getTags),
+            params: this.jsonFindQuerySchema,
+            response: {
+                200: this.jsonEntitySchema,
+                400: this.jsonErrorBodyResponse,
+                401: this.jsonErrorBodyResponse,
+                403: this.jsonErrorBodyResponse,
+                500: this.jsonErrorBodyResponse
+            }
+        };
+    }
+    /**
+     * Get JSON schema for findBy entities
+     */
+    get findBySchema() {
+        return {
+            ...(this.getTags),
+            params: this.jsonFindByParamSchema,
+            response: {
+                200: this.jsonEntityArraySchema,
+                401: this.jsonErrorBodyResponse,
+                403: this.jsonErrorBodyResponse,
+                500: this.jsonErrorBodyResponse
+            }
+        };
+    }
+    /**
+     * Get JSON schema for findBy entities
+     */
+    get findOneBySchema() {
+        return {
+            ...(this.getTags),
+            params: this.jsonFindByParamSchema,
+            response: {
+                200: this.jsonEntitySchema,
+                401: this.jsonErrorBodyResponse,
+                403: this.jsonErrorBodyResponse,
+                500: this.jsonErrorBodyResponse
+            }
+        };
+    }
+    /**
+     * Get JSON schema for paginating entities
+     */
+    get paginateSchema() {
+        return {
+            ...(this.getTags),
+            query: this.jsonPaginateQuerySchema,
+            response: {
+                200: this.jsonPaginateBodyResponseSchema,
+                400: this.jsonErrorBodyResponse,
+                401: this.jsonErrorBodyResponse,
+                403: this.jsonErrorBodyResponse,
+                500: this.jsonErrorBodyResponse
+            }
+        };
+    }
+    /**
+     * Get JSON schema for all entities
+     */
+    get allSchema() {
+        return {
+            ...(this.getTags),
+            response: {
+                200: this.jsonEntityArraySchema,
+                401: this.jsonErrorBodyResponse,
+                403: this.jsonErrorBodyResponse,
+                500: this.jsonErrorBodyResponse
+            }
+        };
+    }
+    /**
+     * Get JSON schema for creating an entity
+     */
+    get createSchema() {
+        return {
+            ...(this.getTags),
+            body: this.jsonEntityCreateSchema,
+            response: {
+                200: this.jsonEntitySchema,
+                401: this.jsonErrorBodyResponse,
+                403: this.jsonErrorBodyResponse,
+                422: this.jsonValidationErrorBodyResponse,
+                500: this.jsonErrorBodyResponse
+            }
+        };
+    }
+    /**
+     * Get JSON schema for updating an entity
+     */
+    get updateSchema() {
+        return {
+            ...(this.getTags),
+            params: this.jsonIdParamSchema,
+            body: this.jsonEntityUpdateSchema,
+            response: {
+                200: this.jsonEntitySchema,
+                401: this.jsonErrorBodyResponse,
+                403: this.jsonErrorBodyResponse,
+                422: this.jsonValidationErrorBodyResponse,
+                500: this.jsonErrorBodyResponse
+            }
+        };
+    }
+    /**
+     * Get JSON schema for updating an entity
+     */
+    get updatePartialSchema() {
+        return {
+            ...(this.getTags),
+            params: this.jsonIdParamSchema,
+            body: zodToJsonSchema(this.entityUpdateSchema.partial(), { target: this.target }),
+            response: {
+                200: this.jsonEntitySchema,
+                401: this.jsonErrorBodyResponse,
+                403: this.jsonErrorBodyResponse,
+                422: this.jsonValidationErrorBodyResponse,
+                500: this.jsonErrorBodyResponse
+            }
+        };
+    }
+    /**
+     * Get JSON schema for deleting an entity
+     */
+    get deleteSchema() {
+        return {
+            ...(this.getTags),
+            params: this.jsonIdParamSchema,
+            response: {
+                200: this.jsonDeleteBodyResponseSchema,
+                400: this.jsonErrorBodyResponse,
+                401: this.jsonErrorBodyResponse,
+                403: this.jsonErrorBodyResponse,
+                500: this.jsonErrorBodyResponse
+            }
+        };
+    }
+    /**
+     * Generate route builder function for Fastify with configurable endpoints
+     * @param options Configuration options for route generation
+     * @param basePath Base API path for the entity
+     */
+    generateRoutes(options = {
+        paginate: true,
+        all: true,
+        export: true,
+        search: true,
+        findById: true,
+        create: true,
+        update: true,
+        delete: true
+    }, basePath = `/api/${this.entityName.toLowerCase()}s`) {
+        return (fastify, controller) => {
+            // Get all entities with pagination
+            if (options.paginate !== false) {
+                fastify.get(basePath, {
+                    schema: this.paginateSchema
+                }, (req, rep) => controller.paginate(req, rep));
+            }
+            // Get all entities without pagination
+            if (options.all !== false) {
+                fastify.get(`${basePath}/all`, (req, rep) => controller.all(req, rep));
+            }
+            // Export entities
+            if (options.export !== false) {
+                fastify.get(`${basePath}/export`, (req, rep) => controller.export(req, rep));
+            }
+            // Search entities
+            if (options.search !== false) {
+                fastify.get(`${basePath}/search`, (req, rep) => controller.search(req, rep));
+            }
+            // Get entity by ID
+            if (options.findById !== false) {
+                fastify.get(`${basePath}/:id`, {
+                    schema: this.findByIdSchema
+                }, (req, rep) => controller.findById(req, rep));
+            }
+            // Create entity
+            if (options.create !== false) {
+                fastify.post(basePath, {
+                    schema: this.createSchema
+                }, (req, rep) => controller.create(req, rep));
+            }
+            // Update entity
+            if (options.update !== false) {
+                fastify.put(`${basePath}/:id`, {
+                    schema: this.updateSchema
+                }, (req, rep) => controller.update(req, rep));
+            }
+            // Delete entity
+            if (options.delete !== false) {
+                fastify.delete(`${basePath}/:id`, {
+                    schema: this.deleteSchema
+                }, (req, rep) => controller.delete(req, rep));
+            }
+        };
+    }
+}
+export default CrudSchemaBuilder;