@drax/crud-back 0.11.5 → 0.12.1

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "0.11.5",
+  "version": "0.12.1",
   "description": "Crud utils across modules",
   "main": "dist/index.js",
   "types": "types/index.d.ts",
@@ -22,13 +22,14 @@
   "author": "Cristian Incarnato & Drax Team",
   "license": "ISC",
   "dependencies": {
-    "@drax/common-back": "^0.11.3",
-    "@drax/common-share": "^0.11.3",
-    "@drax/identity-share": "^0.11.5",
-    "@drax/media-back": "^0.11.5",
+    "@drax/common-back": "^0.12.1",
+    "@drax/common-share": "^0.12.1",
+    "@drax/identity-share": "^0.12.1",
+    "@drax/media-back": "^0.12.1",
     "@graphql-tools/load-files": "^7.0.0",
     "@graphql-tools/merge": "^9.0.4",
     "mongoose": "^8.6.3",
+    "mongoose-lean-virtuals": "^1.1.0",
     "mongoose-paginate-v2": "^1.8.3"
   },
   "peerDependencies": {
@@ -44,5 +45,5 @@
     "tsc-alias": "^1.8.10",
     "typescript": "^5.6.2"
   },
-  "gitHead": "e67f10f0af29468c9d30f16135cfdbdff166d916"
+  "gitHead": "76fd366e12449f5f605662197f985a28d98058a2"
 }

package/src/builders/CrudSchemaBuilder.ts

@@ -0,0 +1,420 @@
+import z from 'zod';
+import { zodToJsonSchema } from 'zod-to-json-schema';
+import type { Targets } from 'zod-to-json-schema';
+import {
+  IdParamSchema,
+  DeleteBodyResponseSchema,
+  PaginateQuerySchema,
+  PaginateBodyResponseSchema,
+  FindQuerySchema,
+  SearchQuerySchema,
+  FindByParamSchema,
+  ErrorBodyResponseSchema,
+  ValidationErrorBodyResponseSchema,
+  ExportBodyResponseSchema
+} from '../index.js';
+
+export class CrudSchemaBuilder<T extends z.ZodObject<z.ZodRawShape>, TCreate extends z.ZodObject<z.ZodRawShape>, TUpdate extends z.ZodObject<z.ZodRawShape>> {
+  private entitySchema: T;
+  private entityCreateSchema: TCreate;
+  private entityUpdateSchema: TUpdate;
+  private entityName: string;
+  private tags: string[];
+  private target: Targets = 'openApi3'; //"jsonSchema7" | "jsonSchema2019-09" | "openApi3" | "openAi"
+
+  constructor(entitySchema: T, entityCreateSchema: TCreate, entityUpdateSchema: TUpdate, entityName: string, target:Targets = 'openApi3', tags: string[] = []) {
+    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?: boolean;
+        all?: boolean;
+        export?: boolean;
+        search?: boolean;
+        findById?: boolean;
+        create?: boolean;
+        update?: boolean;
+        delete?: boolean;
+      } = {
+        paginate: true,
+        all: true,
+        export: true,
+        search: true,
+        findById: true,
+        create: true,
+        update: true,
+        delete: true
+      },
+      basePath: string = `/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