arkos 1.2.15-test.1 → 1.2.16-test

package/dist/cjs/modules/swagger/utils/helpers/json-schema-generators/prisma-models/generate-prisma-model-main-routes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generate-prisma-model-main-routes.js","sourceRoot":"","sources":["../../../../../../../../src/modules/swagger/utils/helpers/json-schema-generators/prisma-models/generate-prisma-model-main-routes.ts"],"names":[],"mappings":";;;;;AAKA,gFAicC;AArcD,yEAA4D;AAC5D,0DAAkC;AAClC,+FAA2F;AAEpF,KAAK,UAAU,kCAAkC,CACtD,KAA4B,EAC5B,SAAiB,EACjB,eAAuB,EACvB,iBAAyB,EACzB,uBAA+B,EAC/B,YAAiB,EACjB,IAAY;IAGZ,IAAI,CAAC,IAAA,wCAAkB,EAAC,YAAY,EAAE,WAAW,CAAC,EAAE,CAAC;QACnD,IAAI,CAAC,KAAK,CAAC,QAAQ,SAAS,EAAE,CAAC;YAAE,KAAK,CAAC,QAAQ,SAAS,EAAE,CAAC,GAAG,EAAE,CAAC;QACjE,KAAK,CAAC,QAAQ,SAAS,EAAE,CAAE,CAAC,IAAI,GAAG;YACjC,IAAI,EAAE,CAAC,uBAAuB,CAAC;YAC/B,OAAO,EAAE,gBAAgB,iBAAiB,EAAE;YAC5C,WAAW,EAAE,iBAAiB,iBAAiB,uBAAuB;YACtE,WAAW,EAAE,SAAS,eAAe,EAAE;YACvC,WAAW,EAAE;gBACX,WAAW,EAAE,GAAG,iBAAiB,iBAAiB;gBAClD,QAAQ,EAAE,IAAI;gBACd,OAAO,EAAE;oBACP,kBAAkB,EAAE;wBAClB,MAAM,EAAE;4BACN,IAAI,EAAE,IAAA,qCAAY,EAAC,SAAS,eAAe,EAAE,EAAE,IAAI,CAAC;yBACrD;qBACF;iBACF;aACF;YACD,SAAS,EAAE;gBACT,KAAK,EAAE;oBACL,WAAW,EAAE,GAAG,iBAAiB,uBAAuB;oBACxD,OAAO,EAAE;wBACP,kBAAkB,EAAE;4BAClB,MAAM,EAAE;gCACN,IAAI,EAAE,IAAA,qCAAY,EAAC,GAAG,eAAe,EAAE,EAAE,IAAI,CAAC;6BAC/C;yBACF;qBACF;iBACF;gBACD,KAAK,EAAE;oBACL,WAAW,EAAE,6BAA6B;iBAC3C;gBACD,KAAK,EAAE;oBACL,WAAW,EAAE,yBAAyB;iBACvC;gBACD,KAAK,EAAE;oBACL,WAAW,EAAE,0BAA0B;iBACxC;aACF;YACD,QAAQ,EAAE,CAAC,EAAE,UAAU,EAAE,EAAE,EAAE,CAAC;SAC/B,CAAC;IACJ,CAAC;IAGD,IAAI,CAAC,IAAA,wCAAkB,EAAC,YAAY,EAAE,UAAU,CAAC,EAAE,CAAC;QAClD,IAAI,CAAC,KAAK,CAAC,QAAQ,SAAS,EAAE,CAAC;YAAE,KAAK,CAAC,QAAQ,SAAS,EAAE,CAAC,GAAG,EAAE,CAAC;QACjE,KAAK,CAAC,QAAQ,SAAS,EAAE,CAAE,CAAC,GAAG,GAAG;YAChC,IAAI,EAAE,CAAC,uBAAuB,CAAC;YAC/B,OAAO,EAAE,OAAO,uBAAuB,EAAE;YACzC,WAAW,EAAE,iCAAiC,uBAAuB,sCAAsC;YAC3G,WAAW,EAAE,MAAM,mBAAS,CAAC,MAAM,CAAC,eAAe,CAAC,EAAE;YACtD,UAAU,EAAE;gBACV;oBACE,IAAI,EAAE,QAAQ;oBACd,EAAE,EAAE,OAAO;oBACX,WAAW,EAAE,gCAAgC;oBAC7C,MAAM,EAAE;wBACN,IAAI,EAAE,QAAQ;qBACf;iBACF;gBACD;oBACE,IAAI,EAAE,MAAM;oBACZ,EAAE,EAAE,OAAO;oBACX,WAAW,EAAE,mDAAmD;oBAChE,MAAM,EAAE;wBACN,IAAI,EAAE,QAAQ;qBACf;iBACF;gBACD;oBACE,IAAI,EAAE,MAAM;oBACZ,EAAE,EAAE,OAAO;oBACX,WAAW,EAAE,6BAA6B;oBAC1C,MAAM,EAAE;wBACN,IAAI,EAAE,SAAS;wBACf,OAAO,EAAE,CAAC;qBACX;iBACF;gBACD;oBACE,IAAI,EAAE,OAAO;oBACb,EAAE,EAAE,OAAO;oBACX,WAAW,EAAE,0BAA0B;oBACvC,MAAM,EAAE;wBACN,IAAI,EAAE,SAAS;wBACf,OAAO,EAAE,CAAC;wBACV,OAAO,EAAE,GAAG;qBACb;iBACF;gBACD;oBACE,IAAI,EAAE,QAAQ;oBACd,EAAE,EAAE,OAAO;oBACX,WAAW,EAAE,uDAAuD;oBACpE,MAAM,EAAE;wBACN,IAAI,EAAE,QAAQ;qBACf;iBACF;aACF;YACD,SAAS,EAAE;gBACT,KAAK,EAAE;oBACL,WAAW,EAAE,WAAW,uBAAuB,yBAAyB;oBACxE,OAAO,EAAE;wBACP,kBAAkB,EAAE;4BAClB,MAAM,EAAE;gCACN,IAAI,EAAE,QAAQ;gCACd,UAAU,EAAE;oCACV,KAAK,EAAE;wCACL,IAAI,EAAE,SAAS;wCACf,WAAW,EACT,+CAA+C;qCAClD;oCACD,OAAO,EAAE;wCACP,IAAI,EAAE,SAAS;wCACf,WAAW,EAAE,4CAA4C;qCAC1D;oCACD,IAAI,EAAE;wCACJ,IAAI,EAAE,OAAO;wCACb,KAAK,EAAE;4CACL,IAAI,EAAE,IAAA,qCAAY,EAAC,WAAW,eAAe,EAAE,EAAE,IAAI,CAAC;yCACvD;qCACF;iCACF;6BACF;yBACF;qBACF;iBACF;gBACD,KAAK,EAAE;oBACL,WAAW,EAAE,yBAAyB;iBACvC;gBACD,KAAK,EAAE;oBACL,WAAW,EAAE,0BAA0B;iBACxC;aACF;YACD,QAAQ,EAAE,CAAC,EAAE,UAAU,EAAE,EAAE,EAAE,CAAC;SAC/B,CAAC;IACJ,CAAC;IAGD,IAAI,CAAC,IAAA,wCAAkB,EAAC,YAAY,EAAE,YAAY,CAAC,EAAE,CAAC;QACpD,KAAK,CAAC,QAAQ,SAAS,OAAO,CAAC,GAAG;YAChC,IAAI,EAAE;gBACJ,IAAI,EAAE,CAAC,uBAAuB,CAAC;gBAC/B,OAAO,EAAE,mBAAmB,uBAAuB,EAAE;gBACrD,WAAW,EAAE,oBAAoB,uBAAuB,sCAAsC;gBAC9F,WAAW,EAAE,aAAa,eAAe,EAAE;gBAC3C,WAAW,EAAE;oBACX,WAAW,EAAE,YAAY,iBAAiB,iBAAiB;oBAC3D,QAAQ,EAAE,IAAI;oBACd,OAAO,EAAE;wBACP,kBAAkB,EAAE;4BAClB,MAAM,EAAE;gCACN,IAAI,EAAE,OAAO;gCACb,KAAK,EAAE;oCACL,IAAI,EAAE,IAAA,qCAAY,EAAC,SAAS,eAAe,EAAE,EAAE,IAAI,CAAC;iCACrD;6BACF;yBACF;qBACF;iBACF;gBACD,SAAS,EAAE;oBACT,KAAK,EAAE;wBACL,WAAW,EAAE,GAAG,uBAAuB,uBAAuB;wBAC9D,OAAO,EAAE;4BACP,kBAAkB,EAAE;gCAClB,MAAM,EAAE;oCACN,IAAI,EAAE,QAAQ;oCACd,UAAU,EAAE;wCACV,KAAK,EAAE;4CACL,IAAI,EAAE,SAAS;4CACf,WAAW,EAAE,2BAA2B;yCACzC;qCACF;iCACF;6BACF;yBACF;qBACF;oBACD,KAAK,EAAE;wBACL,WAAW,EAAE,6BAA6B;qBAC3C;oBACD,KAAK,EAAE;wBACL,WAAW,EAAE,yBAAyB;qBACvC;oBACD,KAAK,EAAE;wBACL,WAAW,EAAE,0BAA0B;qBACxC;iBACF;gBACD,QAAQ,EAAE,CAAC,EAAE,UAAU,EAAE,EAAE,EAAE,CAAC;aAC/B;SACF,CAAC;IACJ,CAAC;IAGD,IAAI,CAAC,IAAA,wCAAkB,EAAC,YAAY,EAAE,YAAY,CAAC,EAAE,CAAC;QACpD,IAAI,CAAC,KAAK,CAAC,QAAQ,SAAS,OAAO,CAAC;YAAE,KAAK,CAAC,QAAQ,SAAS,OAAO,CAAC,GAAG,EAAE,CAAC;QAC3E,KAAK,CAAC,QAAQ,SAAS,OAAO,CAAE,CAAC,KAAK,GAAG;YACvC,IAAI,EAAE,CAAC,uBAAuB,CAAC;YAC/B,OAAO,EAAE,mBAAmB,uBAAuB,EAAE;YACrD,WAAW,EAAE,oBAAoB,uBAAuB,mDAAmD;YAC3G,WAAW,EAAE,aAAa,eAAe,EAAE;YAC3C,UAAU,EAAE;gBACV;oBACE,IAAI,EAAE,QAAQ;oBACd,EAAE,EAAE,OAAO;oBACX,WAAW,EAAE,2CAA2C;oBACxD,QAAQ,EAAE,IAAI;oBACd,MAAM,EAAE;wBACN,IAAI,EAAE,QAAQ;qBACf;iBACF;aACF;YACD,WAAW,EAAE;gBACX,WAAW,EAAE,WAAW,iBAAiB,iBAAiB;gBAC1D,QAAQ,EAAE,IAAI;gBACd,OAAO,EAAE;oBACP,kBAAkB,EAAE;wBAClB,MAAM,EAAE;4BACN,IAAI,EAAE,IAAA,qCAAY,EAAC,SAAS,eAAe,EAAE,EAAE,IAAI,CAAC;yBACrD;qBACF;iBACF;aACF;YACD,SAAS,EAAE;gBACT,KAAK,EAAE;oBACL,WAAW,EAAE,GAAG,uBAAuB,uBAAuB;oBAC9D,OAAO,EAAE;wBACP,kBAAkB,EAAE;4BAClB,MAAM,EAAE;gCACN,IAAI,EAAE,QAAQ;gCACd,UAAU,EAAE;oCACV,KAAK,EAAE;wCACL,IAAI,EAAE,SAAS;wCACf,WAAW,EAAE,2BAA2B;qCACzC;iCACF;6BACF;yBACF;qBACF;iBACF;gBACD,KAAK,EAAE;oBACL,WAAW,EAAE,+CAA+C;iBAC7D;gBACD,KAAK,EAAE;oBACL,WAAW,EAAE,yBAAyB;iBACvC;gBACD,KAAK,EAAE;oBACL,WAAW,EAAE,0BAA0B;iBACxC;aACF;YACD,QAAQ,EAAE,CAAC,EAAE,UAAU,EAAE,EAAE,EAAE,CAAC;SAC/B,CAAC;IACJ,CAAC;IAGD,IAAI,CAAC,IAAA,wCAAkB,EAAC,YAAY,EAAE,YAAY,CAAC,EAAE,CAAC;QACpD,IAAI,CAAC,KAAK,CAAC,QAAQ,SAAS,OAAO,CAAC;YAAE,KAAK,CAAC,QAAQ,SAAS,OAAO,CAAC,GAAG,EAAE,CAAC;QAC3E,KAAK,CAAC,QAAQ,SAAS,OAAO,CAAE,CAAC,MAAM,GAAG;YACxC,IAAI,EAAE,CAAC,uBAAuB,CAAC;YAC/B,OAAO,EAAE,mBAAmB,uBAAuB,EAAE;YACrD,WAAW,EAAE,oBAAoB,uBAAuB,mDAAmD;YAC3G,WAAW,EAAE,aAAa,eAAe,EAAE;YAC3C,UAAU,EAAE;gBACV;oBACE,IAAI,EAAE,QAAQ;oBACd,EAAE,EAAE,OAAO;oBACX,WAAW,EAAE,2CAA2C;oBACxD,QAAQ,EAAE,IAAI;oBACd,MAAM,EAAE;wBACN,IAAI,EAAE,QAAQ;qBACf;iBACF;aACF;YACD,SAAS,EAAE;gBACT,KAAK,EAAE;oBACL,WAAW,EAAE,GAAG,uBAAuB,uBAAuB;oBAC9D,OAAO,EAAE;wBACP,kBAAkB,EAAE;4BAClB,MAAM,EAAE;gCACN,IAAI,EAAE,QAAQ;gCACd,UAAU,EAAE;oCACV,KAAK,EAAE;wCACL,IAAI,EAAE,SAAS;wCACf,WAAW,EAAE,2BAA2B;qCACzC;iCACF;6BACF;yBACF;qBACF;iBACF;gBACD,KAAK,EAAE;oBACL,WAAW,EAAE,yBAAyB;iBACvC;gBACD,KAAK,EAAE;oBACL,WAAW,EAAE,yBAAyB;iBACvC;gBACD,KAAK,EAAE;oBACL,WAAW,EAAE,0BAA0B;iBACxC;aACF;YACD,QAAQ,EAAE,CAAC,EAAE,UAAU,EAAE,EAAE,EAAE,CAAC;SAC/B,CAAC;IACJ,CAAC;IAGD,IAAI,CAAC,IAAA,wCAAkB,EAAC,YAAY,EAAE,SAAS,CAAC,EAAE,CAAC;QACjD,KAAK,CAAC,QAAQ,SAAS,OAAO,CAAC,GAAG;YAChC,GAAG,EAAE;gBACH,IAAI,EAAE,CAAC,uBAAuB,CAAC;gBAC/B,OAAO,EAAE,OAAO,iBAAiB,QAAQ;gBACzC,WAAW,EAAE,sBAAsB,iBAAiB,kCAAkC;gBACtF,WAAW,EAAE,MAAM,eAAe,MAAM;gBACxC,UAAU,EAAE;oBACV;wBACE,IAAI,EAAE,IAAI;wBACV,EAAE,EAAE,MAAM;wBACV,WAAW,EAAE,4BAA4B,iBAAiB,EAAE;wBAC5D,QAAQ,EAAE,IAAI;wBACd,MAAM,EAAE;4BACN,IAAI,EAAE,QAAQ;yBACf;qBACF;iBACF;gBACD,SAAS,EAAE;oBACT,KAAK,EAAE;wBACL,WAAW,EAAE,GAAG,iBAAiB,yBAAyB;wBAC1D,OAAO,EAAE;4BACP,kBAAkB,EAAE;gCAClB,MAAM,EAAE;oCACN,IAAI,EAAE,IAAA,qCAAY,EAAC,UAAU,eAAe,EAAE,EAAE,IAAI,CAAC;iCACtD;6BACF;yBACF;qBACF;oBACD,KAAK,EAAE;wBACL,WAAW,EAAE,yBAAyB;qBACvC;oBACD,KAAK,EAAE;wBACL,WAAW,EAAE,0BAA0B;qBACxC;oBACD,KAAK,EAAE;wBACL,WAAW,EAAE,GAAG,iBAAiB,YAAY;qBAC9C;iBACF;gBACD,QAAQ,EAAE,CAAC,EAAE,UAAU,EAAE,EAAE,EAAE,CAAC;aAC/B;SACF,CAAC;IACJ,CAAC;IAGD,IAAI,CAAC,IAAA,wCAAkB,EAAC,YAAY,EAAE,WAAW,CAAC,EAAE,CAAC;QACnD,IAAI,CAAC,KAAK,CAAC,QAAQ,SAAS,OAAO,CAAC;YAAE,KAAK,CAAC,QAAQ,SAAS,OAAO,CAAC,GAAG,EAAE,CAAC;QAC3E,KAAK,CAAC,QAAQ,SAAS,OAAO,CAAE,CAAC,KAAK,GAAG;YACvC,IAAI,EAAE,CAAC,uBAAuB,CAAC;YAC/B,OAAO,EAAE,UAAU,iBAAiB,QAAQ;YAC5C,WAAW,EAAE,oBAAoB,iBAAiB,kCAAkC;YACpF,WAAW,EAAE,SAAS,eAAe,EAAE;YACvC,UAAU,EAAE;gBACV;oBACE,IAAI,EAAE,IAAI;oBACV,EAAE,EAAE,MAAM;oBACV,WAAW,EAAE,4BAA4B,iBAAiB,EAAE;oBAC5D,QAAQ,EAAE,IAAI;oBACd,MAAM,EAAE;wBACN,IAAI,EAAE,QAAQ;qBACf;iBACF;aACF;YACD,WAAW,EAAE;gBACX,WAAW,EAAE,WAAW,iBAAiB,iBAAiB;gBAC1D,QAAQ,EAAE,IAAI;gBACd,OAAO,EAAE;oBACP,kBAAkB,EAAE;wBAClB,MAAM,EAAE;4BACN,IAAI,EAAE,IAAA,qCAAY,EAAC,SAAS,eAAe,EAAE,EAAE,IAAI,CAAC;yBACrD;qBACF;iBACF;aACF;YACD,SAAS,EAAE;gBACT,KAAK,EAAE;oBACL,WAAW,EAAE,GAAG,iBAAiB,uBAAuB;oBACxD,OAAO,EAAE;wBACP,kBAAkB,EAAE;4BAClB,MAAM,EAAE;gCACN,IAAI,EAAE,IAAA,qCAAY,EAAC,GAAG,eAAe,EAAE,EAAE,IAAI,CAAC;6BAC/C;yBACF;qBACF;iBACF;gBACD,KAAK,EAAE;oBACL,WAAW,EAAE,6BAA6B;iBAC3C;gBACD,KAAK,EAAE;oBACL,WAAW,EAAE,yBAAyB;iBACvC;gBACD,KAAK,EAAE;oBACL,WAAW,EAAE,0BAA0B;iBACxC;gBACD,KAAK,EAAE;oBACL,WAAW,EAAE,GAAG,iBAAiB,YAAY;iBAC9C;aACF;YACD,QAAQ,EAAE,CAAC,EAAE,UAAU,EAAE,EAAE,EAAE,CAAC;SAC/B,CAAC;IACJ,CAAC;IAGD,IAAI,CAAC,IAAA,wCAAkB,EAAC,YAAY,EAAE,WAAW,CAAC,EAAE,CAAC;QACnD,IAAI,CAAC,KAAK,CAAC,QAAQ,SAAS,OAAO,CAAC;YAAE,KAAK,CAAC,QAAQ,SAAS,OAAO,CAAC,GAAG,EAAE,CAAC;QAC3E,KAAK,CAAC,QAAQ,SAAS,OAAO,CAAE,CAAC,MAAM,GAAG;YACxC,IAAI,EAAE,CAAC,uBAAuB,CAAC;YAC/B,OAAO,EAAE,UAAU,iBAAiB,QAAQ;YAC5C,WAAW,EAAE,gCAAgC,iBAAiB,kCAAkC;YAChG,WAAW,EAAE,SAAS,eAAe,EAAE;YACvC,UAAU,EAAE;gBACV;oBACE,IAAI,EAAE,IAAI;oBACV,EAAE,EAAE,MAAM;oBACV,WAAW,EAAE,4BAA4B,iBAAiB,EAAE;oBAC5D,QAAQ,EAAE,IAAI;oBACd,MAAM,EAAE;wBACN,IAAI,EAAE,QAAQ;qBACf;iBACF;aACF;YACD,SAAS,EAAE;gBACT,KAAK,EAAE;oBACL,WAAW,EAAE,GAAG,iBAAiB,uBAAuB;iBACzD;gBACD,KAAK,EAAE;oBACL,WAAW,EAAE,yBAAyB;iBACvC;gBACD,KAAK,EAAE;oBACL,WAAW,EAAE,0BAA0B;iBACxC;gBACD,KAAK,EAAE;oBACL,WAAW,EAAE,GAAG,iBAAiB,YAAY;iBAC9C;aACF;YACD,QAAQ,EAAE,CAAC,EAAE,UAAU,EAAE,EAAE,EAAE,CAAC;SAC/B,CAAC;IACJ,CAAC;AACH,CAAC","sourcesContent":["import { OpenAPIV3 } from \"openapi-types\";\nimport { getSchemaRef } from \"../../swagger.router.helpers\";\nimport pluralize from \"pluralize\";\nimport { isEndpointDisabled } from \"../../../../../base/utils/helpers/base.router.helpers\";\n\nexport async function generatePrismaModelMainRoutesPaths(\n  paths: OpenAPIV3.PathsObject,\n  routeName: string,\n  pascalModelName: string,\n  humanReadableName: string,\n  humanReadableNamePlural: string,\n  routerConfig: any,\n  mode: string\n) {\n  // Create One\n  if (!isEndpointDisabled(routerConfig, \"createOne\")) {\n    if (!paths[`/api/${routeName}`]) paths[`/api/${routeName}`] = {};\n    paths[`/api/${routeName}`]!.post = {\n      tags: [humanReadableNamePlural],\n      summary: `Create a new ${humanReadableName}`,\n      description: `Creates a new ${humanReadableName} record in the system`,\n      operationId: `create${pascalModelName}`,\n      requestBody: {\n        description: `${humanReadableName} data to create`,\n        required: true,\n        content: {\n          \"application/json\": {\n            schema: {\n              $ref: getSchemaRef(`Create${pascalModelName}`, mode),\n            },\n          },\n        },\n      },\n      responses: {\n        \"201\": {\n          description: `${humanReadableName} created successfully`,\n          content: {\n            \"application/json\": {\n              schema: {\n                $ref: getSchemaRef(`${pascalModelName}`, mode),\n              },\n            },\n          },\n        },\n        \"400\": {\n          description: \"Invalid input data provided\",\n        },\n        \"401\": {\n          description: \"Authentication required\",\n        },\n        \"403\": {\n          description: \"Insufficient permissions\",\n        },\n      },\n      security: [{ BearerAuth: [] }],\n    };\n  }\n\n  // Find Many\n  if (!isEndpointDisabled(routerConfig, \"findMany\")) {\n    if (!paths[`/api/${routeName}`]) paths[`/api/${routeName}`] = {};\n    paths[`/api/${routeName}`]!.get = {\n      tags: [humanReadableNamePlural],\n      summary: `Get ${humanReadableNamePlural}`,\n      description: `Retrieves a paginated list of ${humanReadableNamePlural} with optional filtering and sorting`,\n      operationId: `get${pluralize.plural(pascalModelName)}`,\n      parameters: [\n        {\n          name: \"filter\",\n          in: \"query\",\n          description: \"Filter criteria in JSON format\",\n          schema: {\n            type: \"string\",\n          },\n        },\n        {\n          name: \"sort\",\n          in: \"query\",\n          description: \"Sort field (prefix with '-' for descending order)\",\n          schema: {\n            type: \"string\",\n          },\n        },\n        {\n          name: \"page\",\n          in: \"query\",\n          description: \"Page number (starts from 1)\",\n          schema: {\n            type: \"integer\",\n            minimum: 1,\n          },\n        },\n        {\n          name: \"limit\",\n          in: \"query\",\n          description: \"Number of items per page\",\n          schema: {\n            type: \"integer\",\n            minimum: 1,\n            maximum: 100,\n          },\n        },\n        {\n          name: \"fields\",\n          in: \"query\",\n          description: \"Comma-separated list of fields to include in response\",\n          schema: {\n            type: \"string\",\n          },\n        },\n      ],\n      responses: {\n        \"200\": {\n          description: `List of ${humanReadableNamePlural} retrieved successfully`,\n          content: {\n            \"application/json\": {\n              schema: {\n                type: \"object\",\n                properties: {\n                  total: {\n                    type: \"integer\",\n                    description:\n                      \"Total number of records matching the criteria\",\n                  },\n                  results: {\n                    type: \"integer\",\n                    description: \"Number of records returned in current page\",\n                  },\n                  data: {\n                    type: \"array\",\n                    items: {\n                      $ref: getSchemaRef(`FindMany${pascalModelName}`, mode),\n                    },\n                  },\n                },\n              },\n            },\n          },\n        },\n        \"401\": {\n          description: \"Authentication required\",\n        },\n        \"403\": {\n          description: \"Insufficient permissions\",\n        },\n      },\n      security: [{ BearerAuth: [] }],\n    };\n  }\n\n  // Create Many\n  if (!isEndpointDisabled(routerConfig, \"createMany\")) {\n    paths[`/api/${routeName}/many`] = {\n      post: {\n        tags: [humanReadableNamePlural],\n        summary: `Create multiple ${humanReadableNamePlural}`,\n        description: `Creates multiple ${humanReadableNamePlural} records in a single batch operation`,\n        operationId: `createMany${pascalModelName}`,\n        requestBody: {\n          description: `Array of ${humanReadableName} data to create`,\n          required: true,\n          content: {\n            \"application/json\": {\n              schema: {\n                type: \"array\",\n                items: {\n                  $ref: getSchemaRef(`Create${pascalModelName}`, mode),\n                },\n              },\n            },\n          },\n        },\n        responses: {\n          \"201\": {\n            description: `${humanReadableNamePlural} created successfully`,\n            content: {\n              \"application/json\": {\n                schema: {\n                  type: \"object\",\n                  properties: {\n                    count: {\n                      type: \"integer\",\n                      description: \"Number of records created\",\n                    },\n                  },\n                },\n              },\n            },\n          },\n          \"400\": {\n            description: \"Invalid input data provided\",\n          },\n          \"401\": {\n            description: \"Authentication required\",\n          },\n          \"403\": {\n            description: \"Insufficient permissions\",\n          },\n        },\n        security: [{ BearerAuth: [] }],\n      },\n    };\n  }\n\n  // Update Many\n  if (!isEndpointDisabled(routerConfig, \"updateMany\")) {\n    if (!paths[`/api/${routeName}/many`]) paths[`/api/${routeName}/many`] = {};\n    paths[`/api/${routeName}/many`]!.patch = {\n      tags: [humanReadableNamePlural],\n      summary: `Update multiple ${humanReadableNamePlural}`,\n      description: `Updates multiple ${humanReadableNamePlural} records that match the specified filter criteria`,\n      operationId: `updateMany${pascalModelName}`,\n      parameters: [\n        {\n          name: \"filter\",\n          in: \"query\",\n          description: \"Filter criteria in JSON format (required)\",\n          required: true,\n          schema: {\n            type: \"string\",\n          },\n        },\n      ],\n      requestBody: {\n        description: `Partial ${humanReadableName} data to update`,\n        required: true,\n        content: {\n          \"application/json\": {\n            schema: {\n              $ref: getSchemaRef(`Update${pascalModelName}`, mode),\n            },\n          },\n        },\n      },\n      responses: {\n        \"200\": {\n          description: `${humanReadableNamePlural} updated successfully`,\n          content: {\n            \"application/json\": {\n              schema: {\n                type: \"object\",\n                properties: {\n                  count: {\n                    type: \"integer\",\n                    description: \"Number of records updated\",\n                  },\n                },\n              },\n            },\n          },\n        },\n        \"400\": {\n          description: \"Invalid input data or missing filter criteria\",\n        },\n        \"401\": {\n          description: \"Authentication required\",\n        },\n        \"403\": {\n          description: \"Insufficient permissions\",\n        },\n      },\n      security: [{ BearerAuth: [] }],\n    };\n  }\n\n  // Delete Many\n  if (!isEndpointDisabled(routerConfig, \"deleteMany\")) {\n    if (!paths[`/api/${routeName}/many`]) paths[`/api/${routeName}/many`] = {};\n    paths[`/api/${routeName}/many`]!.delete = {\n      tags: [humanReadableNamePlural],\n      summary: `Delete multiple ${humanReadableNamePlural}`,\n      description: `Deletes multiple ${humanReadableNamePlural} records that match the specified filter criteria`,\n      operationId: `deleteMany${pascalModelName}`,\n      parameters: [\n        {\n          name: \"filter\",\n          in: \"query\",\n          description: \"Filter criteria in JSON format (required)\",\n          required: true,\n          schema: {\n            type: \"string\",\n          },\n        },\n      ],\n      responses: {\n        \"200\": {\n          description: `${humanReadableNamePlural} deleted successfully`,\n          content: {\n            \"application/json\": {\n              schema: {\n                type: \"object\",\n                properties: {\n                  count: {\n                    type: \"integer\",\n                    description: \"Number of records deleted\",\n                  },\n                },\n              },\n            },\n          },\n        },\n        \"400\": {\n          description: \"Missing filter criteria\",\n        },\n        \"401\": {\n          description: \"Authentication required\",\n        },\n        \"403\": {\n          description: \"Insufficient permissions\",\n        },\n      },\n      security: [{ BearerAuth: [] }],\n    };\n  }\n\n  // Find One\n  if (!isEndpointDisabled(routerConfig, \"findOne\")) {\n    paths[`/api/${routeName}/{id}`] = {\n      get: {\n        tags: [humanReadableNamePlural],\n        summary: `Get ${humanReadableName} by ID`,\n        description: `Retrieves a single ${humanReadableName} record by its unique identifier`,\n        operationId: `get${pascalModelName}ById`,\n        parameters: [\n          {\n            name: \"id\",\n            in: \"path\",\n            description: `Unique identifier of the ${humanReadableName}`,\n            required: true,\n            schema: {\n              type: \"string\",\n            },\n          },\n        ],\n        responses: {\n          \"200\": {\n            description: `${humanReadableName} retrieved successfully`,\n            content: {\n              \"application/json\": {\n                schema: {\n                  $ref: getSchemaRef(`FindOne${pascalModelName}`, mode),\n                },\n              },\n            },\n          },\n          \"401\": {\n            description: \"Authentication required\",\n          },\n          \"403\": {\n            description: \"Insufficient permissions\",\n          },\n          \"404\": {\n            description: `${humanReadableName} not found`,\n          },\n        },\n        security: [{ BearerAuth: [] }],\n      },\n    };\n  }\n\n  // Update One\n  if (!isEndpointDisabled(routerConfig, \"updateOne\")) {\n    if (!paths[`/api/${routeName}/{id}`]) paths[`/api/${routeName}/{id}`] = {};\n    paths[`/api/${routeName}/{id}`]!.patch = {\n      tags: [humanReadableNamePlural],\n      summary: `Update ${humanReadableName} by ID`,\n      description: `Updates a single ${humanReadableName} record by its unique identifier`,\n      operationId: `update${pascalModelName}`,\n      parameters: [\n        {\n          name: \"id\",\n          in: \"path\",\n          description: `Unique identifier of the ${humanReadableName}`,\n          required: true,\n          schema: {\n            type: \"string\",\n          },\n        },\n      ],\n      requestBody: {\n        description: `Partial ${humanReadableName} data to update`,\n        required: true,\n        content: {\n          \"application/json\": {\n            schema: {\n              $ref: getSchemaRef(`Update${pascalModelName}`, mode),\n            },\n          },\n        },\n      },\n      responses: {\n        \"200\": {\n          description: `${humanReadableName} updated successfully`,\n          content: {\n            \"application/json\": {\n              schema: {\n                $ref: getSchemaRef(`${pascalModelName}`, mode),\n              },\n            },\n          },\n        },\n        \"400\": {\n          description: \"Invalid input data provided\",\n        },\n        \"401\": {\n          description: \"Authentication required\",\n        },\n        \"403\": {\n          description: \"Insufficient permissions\",\n        },\n        \"404\": {\n          description: `${humanReadableName} not found`,\n        },\n      },\n      security: [{ BearerAuth: [] }],\n    };\n  }\n\n  // Delete One\n  if (!isEndpointDisabled(routerConfig, \"deleteOne\")) {\n    if (!paths[`/api/${routeName}/{id}`]) paths[`/api/${routeName}/{id}`] = {};\n    paths[`/api/${routeName}/{id}`]!.delete = {\n      tags: [humanReadableNamePlural],\n      summary: `Delete ${humanReadableName} by ID`,\n      description: `Permanently deletes a single ${humanReadableName} record by its unique identifier`,\n      operationId: `delete${pascalModelName}`,\n      parameters: [\n        {\n          name: \"id\",\n          in: \"path\",\n          description: `Unique identifier of the ${humanReadableName}`,\n          required: true,\n          schema: {\n            type: \"string\",\n          },\n        },\n      ],\n      responses: {\n        \"204\": {\n          description: `${humanReadableName} deleted successfully`,\n        },\n        \"401\": {\n          description: \"Authentication required\",\n        },\n        \"403\": {\n          description: \"Insufficient permissions\",\n        },\n        \"404\": {\n          description: `${humanReadableName} not found`,\n        },\n      },\n      security: [{ BearerAuth: [] }],\n    };\n  }\n}\n"]}

package/dist/cjs/modules/swagger/utils/helpers/json-schema-generators/prisma-models/generate-prisma-model-parent-routes.js

@@ -0,0 +1,165 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generatePrismaModelParentRoutePaths = generatePrismaModelParentRoutePaths;
+const pluralize_1 = __importDefault(require("pluralize"));
+const utils_1 = require("../../../../../../exports/utils");
+const swagger_router_helpers_1 = require("../../swagger.router.helpers");
+const base_router_helpers_1 = require("../../../../../base/utils/helpers/base.router.helpers");
+async function generatePrismaModelParentRoutePaths(paths, routeName, pascalModelName, humanReadableName, humanReadableNamePlural, routerConfig, mode) {
+    const parentModel = routerConfig.parent.model;
+    const parentRouteName = pluralize_1.default.plural((0, utils_1.kebabCase)(parentModel));
+    const parentHumanName = (0, swagger_router_helpers_1.kebabToHuman)((0, utils_1.kebabCase)(parentModel));
+    if ((0, base_router_helpers_1.isParentEndpointAllowed)(routerConfig, "createOne")) {
+        paths[`/api/${parentRouteName}/{id}/${routeName}`] = {
+            post: {
+                tags: [humanReadableNamePlural],
+                summary: `Create ${humanReadableName} for ${parentHumanName}`,
+                description: `Creates a new ${humanReadableName} record associated with the specified ${parentHumanName}`,
+                operationId: `create${pascalModelName}For${(0, utils_1.pascalCase)(parentModel)}`,
+                parameters: [
+                    {
+                        name: "id",
+                        in: "path",
+                        description: `Unique identifier of the ${parentHumanName}`,
+                        required: true,
+                        schema: {
+                            type: "string",
+                        },
+                    },
+                ],
+                requestBody: {
+                    description: `${humanReadableName} data to create`,
+                    required: true,
+                    content: {
+                        "application/json": {
+                            schema: {
+                                $ref: (0, swagger_router_helpers_1.getSchemaRef)(`Create${pascalModelName}`, mode),
+                            },
+                        },
+                    },
+                },
+                responses: {
+                    "201": {
+                        description: `${humanReadableName} created successfully`,
+                        content: {
+                            "application/json": {
+                                schema: {
+                                    $ref: (0, swagger_router_helpers_1.getSchemaRef)(`${pascalModelName}`, mode),
+                                },
+                            },
+                        },
+                    },
+                    "400": {
+                        description: "Invalid input data provided",
+                    },
+                    "401": {
+                        description: "Authentication required",
+                    },
+                    "403": {
+                        description: "Insufficient permissions",
+                    },
+                    "404": {
+                        description: `${parentHumanName} not found`,
+                    },
+                },
+                security: [{ BearerAuth: [] }],
+            },
+        };
+    }
+    if ((0, base_router_helpers_1.isParentEndpointAllowed)(routerConfig, "findMany")) {
+        if (!paths[`/api/${parentRouteName}/{id}/${routeName}`])
+            paths[`/api/${parentRouteName}/{id}/${routeName}`] = {};
+        paths[`/api/${parentRouteName}/{id}/${routeName}`].get = {
+            tags: [humanReadableNamePlural],
+            summary: `Get ${humanReadableNamePlural} for ${parentHumanName}`,
+            description: `Retrieves all ${humanReadableNamePlural} associated with the specified ${parentHumanName}`,
+            operationId: `get${pluralize_1.default.plural(pascalModelName)}For${(0, utils_1.pascalCase)(parentModel)}`,
+            parameters: [
+                {
+                    name: "id",
+                    in: "path",
+                    description: `Unique identifier of the ${parentHumanName}`,
+                    required: true,
+                    schema: {
+                        type: "string",
+                    },
+                },
+                {
+                    name: "filter",
+                    in: "query",
+                    description: "Additional filter criteria in JSON format",
+                    schema: {
+                        type: "string",
+                    },
+                },
+                {
+                    name: "sort",
+                    in: "query",
+                    description: "Sort field (prefix with '-' for descending order)",
+                    schema: {
+                        type: "string",
+                    },
+                },
+                {
+                    name: "page",
+                    in: "query",
+                    description: "Page number (starts from 1)",
+                    schema: {
+                        type: "integer",
+                        minimum: 1,
+                    },
+                },
+                {
+                    name: "limit",
+                    in: "query",
+                    description: "Number of items per page",
+                    schema: {
+                        type: "integer",
+                    },
+                },
+            ],
+            responses: {
+                "200": {
+                    description: `List of ${humanReadableNamePlural} retrieved successfully`,
+                    content: {
+                        "application/json": {
+                            schema: {
+                                type: "object",
+                                properties: {
+                                    total: {
+                                        type: "integer",
+                                        description: "Total number of records",
+                                    },
+                                    results: {
+                                        type: "integer",
+                                        description: "Number of records in current page",
+                                    },
+                                    data: {
+                                        type: "array",
+                                        items: {
+                                            $ref: (0, swagger_router_helpers_1.getSchemaRef)(`${pascalModelName}`, mode),
+                                        },
+                                    },
+                                },
+                            },
+                        },
+                    },
+                },
+                "401": {
+                    description: "Authentication required",
+                },
+                "403": {
+                    description: "Insufficient permissions",
+                },
+                "404": {
+                    description: `${parentHumanName} not found`,
+                },
+            },
+            security: [{ BearerAuth: [] }],
+        };
+    }
+}
+//# sourceMappingURL=generate-prisma-model-parent-routes.js.map

package/dist/cjs/modules/swagger/utils/helpers/json-schema-generators/prisma-models/generate-prisma-model-parent-routes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generate-prisma-model-parent-routes.js","sourceRoot":"","sources":["../../../../../../../../src/modules/swagger/utils/helpers/json-schema-generators/prisma-models/generate-prisma-model-parent-routes.ts"],"names":[],"mappings":";;;;;AAMA,kFAyKC;AA9KD,0DAAkC;AAClC,2DAAwE;AACxE,yEAA0E;AAC1E,+FAAgG;AAEzF,KAAK,UAAU,mCAAmC,CACvD,KAA4B,EAC5B,SAAiB,EACjB,eAAuB,EACvB,iBAAyB,EACzB,uBAA+B,EAC/B,YAAiB,EACjB,IAAY;IAEZ,MAAM,WAAW,GAAG,YAAY,CAAC,MAAM,CAAC,KAAK,CAAC;IAC9C,MAAM,eAAe,GAAG,mBAAS,CAAC,MAAM,CAAC,IAAA,iBAAS,EAAC,WAAW,CAAC,CAAC,CAAC;IACjE,MAAM,eAAe,GAAG,IAAA,qCAAY,EAAC,IAAA,iBAAS,EAAC,WAAW,CAAC,CAAC,CAAC;IAK7D,IAAI,IAAA,6CAAuB,EAAC,YAAY,EAAE,WAAW,CAAC,EAAE,CAAC;QACvD,KAAK,CAAC,QAAQ,eAAe,SAAS,SAAS,EAAE,CAAC,GAAG;YACnD,IAAI,EAAE;gBACJ,IAAI,EAAE,CAAC,uBAAuB,CAAC;gBAC/B,OAAO,EAAE,UAAU,iBAAiB,QAAQ,eAAe,EAAE;gBAC7D,WAAW,EAAE,iBAAiB,iBAAiB,yCAAyC,eAAe,EAAE;gBACzG,WAAW,EAAE,SAAS,eAAe,MAAM,IAAA,kBAAU,EAAC,WAAW,CAAC,EAAE;gBACpE,UAAU,EAAE;oBACV;wBACE,IAAI,EAAE,IAAI;wBACV,EAAE,EAAE,MAAM;wBACV,WAAW,EAAE,4BAA4B,eAAe,EAAE;wBAC1D,QAAQ,EAAE,IAAI;wBACd,MAAM,EAAE;4BACN,IAAI,EAAE,QAAQ;yBACf;qBACF;iBACF;gBACD,WAAW,EAAE;oBACX,WAAW,EAAE,GAAG,iBAAiB,iBAAiB;oBAClD,QAAQ,EAAE,IAAI;oBACd,OAAO,EAAE;wBACP,kBAAkB,EAAE;4BAClB,MAAM,EAAE;gCACN,IAAI,EAAE,IAAA,qCAAY,EAAC,SAAS,eAAe,EAAE,EAAE,IAAI,CAAC;6BACrD;yBACF;qBACF;iBACF;gBACD,SAAS,EAAE;oBACT,KAAK,EAAE;wBACL,WAAW,EAAE,GAAG,iBAAiB,uBAAuB;wBACxD,OAAO,EAAE;4BACP,kBAAkB,EAAE;gCAClB,MAAM,EAAE;oCACN,IAAI,EAAE,IAAA,qCAAY,EAAC,GAAG,eAAe,EAAE,EAAE,IAAI,CAAC;iCAC/C;6BACF;yBACF;qBACF;oBACD,KAAK,EAAE;wBACL,WAAW,EAAE,6BAA6B;qBAC3C;oBACD,KAAK,EAAE;wBACL,WAAW,EAAE,yBAAyB;qBACvC;oBACD,KAAK,EAAE;wBACL,WAAW,EAAE,0BAA0B;qBACxC;oBACD,KAAK,EAAE;wBACL,WAAW,EAAE,GAAG,eAAe,YAAY;qBAC5C;iBACF;gBACD,QAAQ,EAAE,CAAC,EAAE,UAAU,EAAE,EAAE,EAAE,CAAC;aAC/B;SACF,CAAC;IACJ,CAAC;IAGD,IAAI,IAAA,6CAAuB,EAAC,YAAY,EAAE,UAAU,CAAC,EAAE,CAAC;QACtD,IAAI,CAAC,KAAK,CAAC,QAAQ,eAAe,SAAS,SAAS,EAAE,CAAC;YACrD,KAAK,CAAC,QAAQ,eAAe,SAAS,SAAS,EAAE,CAAC,GAAG,EAAE,CAAC;QAC1D,KAAK,CAAC,QAAQ,eAAe,SAAS,SAAS,EAAE,CAAE,CAAC,GAAG,GAAG;YACxD,IAAI,EAAE,CAAC,uBAAuB,CAAC;YAC/B,OAAO,EAAE,OAAO,uBAAuB,QAAQ,eAAe,EAAE;YAChE,WAAW,EAAE,iBAAiB,uBAAuB,kCAAkC,eAAe,EAAE;YACxG,WAAW,EAAE,MAAM,mBAAS,CAAC,MAAM,CAAC,eAAe,CAAC,MAAM,IAAA,kBAAU,EAAC,WAAW,CAAC,EAAE;YACnF,UAAU,EAAE;gBACV;oBACE,IAAI,EAAE,IAAI;oBACV,EAAE,EAAE,MAAM;oBACV,WAAW,EAAE,4BAA4B,eAAe,EAAE;oBAC1D,QAAQ,EAAE,IAAI;oBACd,MAAM,EAAE;wBACN,IAAI,EAAE,QAAQ;qBACf;iBACF;gBACD;oBACE,IAAI,EAAE,QAAQ;oBACd,EAAE,EAAE,OAAO;oBACX,WAAW,EAAE,2CAA2C;oBACxD,MAAM,EAAE;wBACN,IAAI,EAAE,QAAQ;qBACf;iBACF;gBACD;oBACE,IAAI,EAAE,MAAM;oBACZ,EAAE,EAAE,OAAO;oBACX,WAAW,EAAE,mDAAmD;oBAChE,MAAM,EAAE;wBACN,IAAI,EAAE,QAAQ;qBACf;iBACF;gBACD;oBACE,IAAI,EAAE,MAAM;oBACZ,EAAE,EAAE,OAAO;oBACX,WAAW,EAAE,6BAA6B;oBAC1C,MAAM,EAAE;wBACN,IAAI,EAAE,SAAS;wBACf,OAAO,EAAE,CAAC;qBACX;iBACF;gBACD;oBACE,IAAI,EAAE,OAAO;oBACb,EAAE,EAAE,OAAO;oBACX,WAAW,EAAE,0BAA0B;oBACvC,MAAM,EAAE;wBACN,IAAI,EAAE,SAAS;qBAChB;iBACF;aACF;YACD,SAAS,EAAE;gBACT,KAAK,EAAE;oBACL,WAAW,EAAE,WAAW,uBAAuB,yBAAyB;oBACxE,OAAO,EAAE;wBACP,kBAAkB,EAAE;4BAClB,MAAM,EAAE;gCACN,IAAI,EAAE,QAAQ;gCACd,UAAU,EAAE;oCACV,KAAK,EAAE;wCACL,IAAI,EAAE,SAAS;wCACf,WAAW,EAAE,yBAAyB;qCACvC;oCACD,OAAO,EAAE;wCACP,IAAI,EAAE,SAAS;wCACf,WAAW,EAAE,mCAAmC;qCACjD;oCACD,IAAI,EAAE;wCACJ,IAAI,EAAE,OAAO;wCACb,KAAK,EAAE;4CACL,IAAI,EAAE,IAAA,qCAAY,EAAC,GAAG,eAAe,EAAE,EAAE,IAAI,CAAC;yCAC/C;qCACF;iCACF;6BACF;yBACF;qBACF;iBACF;gBACD,KAAK,EAAE;oBACL,WAAW,EAAE,yBAAyB;iBACvC;gBACD,KAAK,EAAE;oBACL,WAAW,EAAE,0BAA0B;iBACxC;gBACD,KAAK,EAAE;oBACL,WAAW,EAAE,GAAG,eAAe,YAAY;iBAC5C;aACF;YACD,QAAQ,EAAE,CAAC,EAAE,UAAU,EAAE,EAAE,EAAE,CAAC;SAC/B,CAAC;IACJ,CAAC;AAGH,CAAC","sourcesContent":["import { OpenAPIV3 } from \"openapi-types\";\nimport pluralize from \"pluralize\";\nimport { kebabCase, pascalCase } from \"../../../../../../exports/utils\";\nimport { getSchemaRef, kebabToHuman } from \"../../swagger.router.helpers\";\nimport { isParentEndpointAllowed } from \"../../../../../base/utils/helpers/base.router.helpers\";\n\nexport async function generatePrismaModelParentRoutePaths(\n  paths: OpenAPIV3.PathsObject,\n  routeName: string,\n  pascalModelName: string,\n  humanReadableName: string,\n  humanReadableNamePlural: string,\n  routerConfig: any,\n  mode: string\n) {\n  const parentModel = routerConfig.parent.model;\n  const parentRouteName = pluralize.plural(kebabCase(parentModel));\n  const parentHumanName = kebabToHuman(kebabCase(parentModel));\n  // const foreignKeyField =\n  //   routerConfig.parent.foreignKeyField || `${kebabCase(parentModel)}Id`;\n\n  // Create One (Parent)\n  if (isParentEndpointAllowed(routerConfig, \"createOne\")) {\n    paths[`/api/${parentRouteName}/{id}/${routeName}`] = {\n      post: {\n        tags: [humanReadableNamePlural],\n        summary: `Create ${humanReadableName} for ${parentHumanName}`,\n        description: `Creates a new ${humanReadableName} record associated with the specified ${parentHumanName}`,\n        operationId: `create${pascalModelName}For${pascalCase(parentModel)}`,\n        parameters: [\n          {\n            name: \"id\",\n            in: \"path\",\n            description: `Unique identifier of the ${parentHumanName}`,\n            required: true,\n            schema: {\n              type: \"string\",\n            },\n          },\n        ],\n        requestBody: {\n          description: `${humanReadableName} data to create`,\n          required: true,\n          content: {\n            \"application/json\": {\n              schema: {\n                $ref: getSchemaRef(`Create${pascalModelName}`, mode),\n              },\n            },\n          },\n        },\n        responses: {\n          \"201\": {\n            description: `${humanReadableName} created successfully`,\n            content: {\n              \"application/json\": {\n                schema: {\n                  $ref: getSchemaRef(`${pascalModelName}`, mode),\n                },\n              },\n            },\n          },\n          \"400\": {\n            description: \"Invalid input data provided\",\n          },\n          \"401\": {\n            description: \"Authentication required\",\n          },\n          \"403\": {\n            description: \"Insufficient permissions\",\n          },\n          \"404\": {\n            description: `${parentHumanName} not found`,\n          },\n        },\n        security: [{ BearerAuth: [] }],\n      },\n    };\n  }\n\n  // Find Many (Parent)\n  if (isParentEndpointAllowed(routerConfig, \"findMany\")) {\n    if (!paths[`/api/${parentRouteName}/{id}/${routeName}`])\n      paths[`/api/${parentRouteName}/{id}/${routeName}`] = {};\n    paths[`/api/${parentRouteName}/{id}/${routeName}`]!.get = {\n      tags: [humanReadableNamePlural],\n      summary: `Get ${humanReadableNamePlural} for ${parentHumanName}`,\n      description: `Retrieves all ${humanReadableNamePlural} associated with the specified ${parentHumanName}`,\n      operationId: `get${pluralize.plural(pascalModelName)}For${pascalCase(parentModel)}`,\n      parameters: [\n        {\n          name: \"id\",\n          in: \"path\",\n          description: `Unique identifier of the ${parentHumanName}`,\n          required: true,\n          schema: {\n            type: \"string\",\n          },\n        },\n        {\n          name: \"filter\",\n          in: \"query\",\n          description: \"Additional filter criteria in JSON format\",\n          schema: {\n            type: \"string\",\n          },\n        },\n        {\n          name: \"sort\",\n          in: \"query\",\n          description: \"Sort field (prefix with '-' for descending order)\",\n          schema: {\n            type: \"string\",\n          },\n        },\n        {\n          name: \"page\",\n          in: \"query\",\n          description: \"Page number (starts from 1)\",\n          schema: {\n            type: \"integer\",\n            minimum: 1,\n          },\n        },\n        {\n          name: \"limit\",\n          in: \"query\",\n          description: \"Number of items per page\",\n          schema: {\n            type: \"integer\",\n          },\n        },\n      ],\n      responses: {\n        \"200\": {\n          description: `List of ${humanReadableNamePlural} retrieved successfully`,\n          content: {\n            \"application/json\": {\n              schema: {\n                type: \"object\",\n                properties: {\n                  total: {\n                    type: \"integer\",\n                    description: \"Total number of records\",\n                  },\n                  results: {\n                    type: \"integer\",\n                    description: \"Number of records in current page\",\n                  },\n                  data: {\n                    type: \"array\",\n                    items: {\n                      $ref: getSchemaRef(`${pascalModelName}`, mode),\n                    },\n                  },\n                },\n              },\n            },\n          },\n        },\n        \"401\": {\n          description: \"Authentication required\",\n        },\n        \"403\": {\n          description: \"Insufficient permissions\",\n        },\n        \"404\": {\n          description: `${parentHumanName} not found`,\n        },\n      },\n      security: [{ BearerAuth: [] }],\n    };\n  }\n\n  // Add other parent endpoints (findOne, updateOne, deleteOne, etc.) following the same pattern...\n}\n"]}

package/dist/cjs/modules/swagger/utils/helpers/swagger.router.helpers.js

@@ -0,0 +1,93 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getOpenAPIJsonSchemasByConfigMode = getOpenAPIJsonSchemasByConfigMode;
+exports.getCorrectJsonSchemaName = getCorrectJsonSchemaName;
+exports.kebabToHuman = kebabToHuman;
+exports.getSchemaRef = getSchemaRef;
+exports.generatePathsForModels = generatePathsForModels;
+const models_helpers_1 = require("../../../../utils/helpers/models.helpers");
+const utils_1 = require("../../../../exports/utils");
+const pluralize_1 = __importDefault(require("pluralize"));
+const get_system_json_schema_paths_1 = require("./get-system-json-schema-paths");
+const get_authentication_json_schema_paths_1 = require("./get-authentication-json-schema-paths");
+const generate_zod_json_schema_1 = require("./json-schema-generators/generate-zod-json-schema");
+const generate_class_validator_json_schemas_1 = require("./json-schema-generators/generate-class-validator-json-schemas");
+const generate_prisma_json_schemas_1 = require("./json-schema-generators/generate-prisma-json-schemas");
+const generate_prisma_model_main_routes_1 = require("./json-schema-generators/prisma-models/generate-prisma-model-main-routes");
+const generate_prisma_model_parent_routes_1 = require("./json-schema-generators/prisma-models/generate-prisma-model-parent-routes");
+async function getOpenAPIJsonSchemasByConfigMode(swaggerConfig) {
+    switch (swaggerConfig.mode) {
+        case "prisma":
+            return await (0, generate_prisma_json_schemas_1.generatePrismaJsonSchemas)();
+        case "class-validator":
+            return await (0, generate_class_validator_json_schemas_1.generateClassValidatorJsonSchemas)();
+        case "zod":
+            return await (0, generate_zod_json_schema_1.generateZodJsonSchemas)();
+        default:
+            throw Error("Unknown mode for auto documentation, supported values are prisma, class-validator, zod or json-schemas");
+    }
+}
+function getCorrectJsonSchemaName(type, modelName, suffix) {
+    const pascalModelName = (0, utils_1.pascalCase)(modelName);
+    const map = {
+        model: pascalModelName,
+        create: `Create${pascalModelName}`,
+        createMany: `CreateMany${pascalModelName}`,
+        findOne: `FindOne${pascalModelName}`,
+        findMany: `FindMany${pascalModelName}`,
+        update: `Update${pascalModelName}`,
+        updateMany: `UpdateMany${pascalModelName}`,
+        query: `Query${pascalModelName}`,
+        login: "Login",
+        signup: "Signup",
+        updateMe: "UpdateMe",
+        updatePassword: "UpdatePassword",
+    };
+    const baseName = map[type] ?? (0, utils_1.pascalCase)(type);
+    return `${baseName}${suffix}`;
+}
+function kebabToHuman(kebabStr) {
+    return kebabStr
+        .split("-")
+        .map((word) => word.charAt(0).toUpperCase() + word.slice(1))
+        .join(" ");
+}
+function getSchemaRef(schemaName, mode) {
+    switch (mode) {
+        case "prisma":
+        case "zod":
+            return `#/components/schemas/${schemaName}Schema`;
+        case "class-validator":
+            return `#/components/schemas/${schemaName}Dto`;
+        default:
+            return `#/components/schemas/${schemaName}`;
+    }
+}
+async function generatePathsForModels(swaggerConfig) {
+    if (!swaggerConfig)
+        return {};
+    let paths = {};
+    const models = (0, models_helpers_1.getModels)();
+    const mode = swaggerConfig.mode;
+    for (const model of models) {
+        const modelName = (0, utils_1.kebabCase)(model);
+        const routeName = pluralize_1.default.plural(modelName);
+        const pascalModelName = (0, utils_1.pascalCase)(model);
+        const humanReadableName = kebabToHuman(modelName);
+        const humanReadableNamePlural = pluralize_1.default.plural(humanReadableName);
+        const modelModules = await (0, models_helpers_1.importPrismaModelModules)(model);
+        const routerConfig = modelModules.router?.config;
+        if (routerConfig?.disable === true)
+            continue;
+        await (0, generate_prisma_model_main_routes_1.generatePrismaModelMainRoutesPaths)(paths, routeName, pascalModelName, humanReadableName, humanReadableNamePlural, routerConfig, mode);
+        if (routerConfig?.parent)
+            await (0, generate_prisma_model_parent_routes_1.generatePrismaModelParentRoutePaths)(paths, routeName, pascalModelName, humanReadableName, humanReadableNamePlural, routerConfig, mode);
+    }
+    paths = { ...paths, ...(0, get_system_json_schema_paths_1.getSystemJsonSchemaPaths)() };
+    paths = { ...paths, ...(0, get_authentication_json_schema_paths_1.getAuthenticationJsonSchemaPaths)() };
+    return paths;
+}
+//# sourceMappingURL=swagger.router.helpers.js.map

package/dist/cjs/modules/swagger/utils/helpers/swagger.router.helpers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"swagger.router.helpers.js","sourceRoot":"","sources":["../../../../../../src/modules/swagger/utils/helpers/swagger.router.helpers.ts"],"names":[],"mappings":";;;;;AAgBA,8EAeC;AAED,4DAwBC;AAED,oCAKC;AAED,oCAUC;AAED,wDAsDC;AAnID,6EAGkD;AAClD,qDAAkE;AAElE,0DAAkC;AAClC,iFAA0E;AAC1E,iGAA0F;AAC1F,gGAA2F;AAC3F,0HAAmH;AACnH,wGAAkG;AAClG,gIAA8H;AAC9H,oIAAiI;AAE1H,KAAK,UAAU,iCAAiC,CACrD,aAAqC;IAErC,QAAQ,aAAc,CAAC,IAAI,EAAE,CAAC;QAC5B,KAAK,QAAQ;YACX,OAAO,MAAM,IAAA,wDAAyB,GAAE,CAAC;QAC3C,KAAK,iBAAiB;YACpB,OAAO,MAAM,IAAA,yEAAiC,GAAE,CAAC;QACnD,KAAK,KAAK;YACR,OAAO,MAAM,IAAA,iDAAsB,GAAE,CAAC;QACxC;YACE,MAAM,KAAK,CACT,wGAAwG,CACzG,CAAC;IACN,CAAC;AACH,CAAC;AAED,SAAgB,wBAAwB,CACtC,IAAY,EACZ,SAAiB,EACjB,MAAwB;IAExB,MAAM,eAAe,GAAG,IAAA,kBAAU,EAAC,SAAS,CAAC,CAAC;IAE9C,MAAM,GAAG,GAA2B;QAClC,KAAK,EAAE,eAAe;QACtB,MAAM,EAAE,SAAS,eAAe,EAAE;QAClC,UAAU,EAAE,aAAa,eAAe,EAAE;QAC1C,OAAO,EAAE,UAAU,eAAe,EAAE;QACpC,QAAQ,EAAE,WAAW,eAAe,EAAE;QACtC,MAAM,EAAE,SAAS,eAAe,EAAE;QAClC,UAAU,EAAE,aAAa,eAAe,EAAE;QAC1C,KAAK,EAAE,QAAQ,eAAe,EAAE;QAChC,KAAK,EAAE,OAAO;QACd,MAAM,EAAE,QAAQ;QAChB,QAAQ,EAAE,UAAU;QACpB,cAAc,EAAE,gBAAgB;KACjC,CAAC;IAEF,MAAM,QAAQ,GAAG,GAAG,CAAC,IAAI,CAAC,IAAI,IAAA,kBAAU,EAAC,IAAI,CAAC,CAAC;IAC/C,OAAO,GAAG,QAAQ,GAAG,MAAM,EAAE,CAAC;AAChC,CAAC;AAED,SAAgB,YAAY,CAAC,QAAgB;IAC3C,OAAO,QAAQ;SACZ,KAAK,CAAC,GAAG,CAAC;SACV,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;SAC3D,IAAI,CAAC,GAAG,CAAC,CAAC;AACf,CAAC;AAED,SAAgB,YAAY,CAAC,UAAkB,EAAE,IAAY;IAC3D,QAAQ,IAAI,EAAE,CAAC;QACb,KAAK,QAAQ,CAAC;QACd,KAAK,KAAK;YACR,OAAO,wBAAwB,UAAU,QAAQ,CAAC;QACpD,KAAK,iBAAiB;YACpB,OAAO,wBAAwB,UAAU,KAAK,CAAC;QACjD;YACE,OAAO,wBAAwB,UAAU,EAAE,CAAC;IAChD,CAAC;AACH,CAAC;AAEM,KAAK,UAAU,sBAAsB,CAC1C,aAAqC;IAErC,IAAI,CAAC,aAAa;QAAE,OAAO,EAAE,CAAC;IAE9B,IAAI,KAAK,GAA0B,EAAE,CAAC;IACtC,MAAM,MAAM,GAAG,IAAA,0BAAS,GAAE,CAAC;IAC3B,MAAM,IAAI,GAAG,aAAc,CAAC,IAAI,CAAC;IAEjC,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;QAC3B,MAAM,SAAS,GAAG,IAAA,iBAAS,EAAC,KAAK,CAAC,CAAC;QACnC,MAAM,SAAS,GAAG,mBAAS,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QAC9C,MAAM,eAAe,GAAG,IAAA,kBAAU,EAAC,KAAK,CAAC,CAAC;QAC1C,MAAM,iBAAiB,GAAG,YAAY,CAAC,SAAS,CAAC,CAAC;QAClD,MAAM,uBAAuB,GAAG,mBAAS,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC;QAGpE,MAAM,YAAY,GAAG,MAAM,IAAA,yCAAwB,EAAC,KAAK,CAAC,CAAC;QAC3D,MAAM,YAAY,GAAG,YAAY,CAAC,MAAM,EAAE,MAAM,CAAC;QAGjD,IAAI,YAAY,EAAE,OAAO,KAAK,IAAI;YAAE,SAAS;QAG7C,MAAM,IAAA,sEAAkC,EACtC,KAAK,EACL,SAAS,EACT,eAAe,EACf,iBAAiB,EACjB,uBAAuB,EACvB,YAAY,EACZ,IAAI,CACL,CAAC;QAGF,IAAI,YAAY,EAAE,MAAM;YACtB,MAAM,IAAA,yEAAmC,EACvC,KAAK,EACL,SAAS,EACT,eAAe,EACf,iBAAiB,EACjB,uBAAuB,EACvB,YAAY,EACZ,IAAI,CACL,CAAC;IACN,CAAC;IAGD,KAAK,GAAG,EAAE,GAAG,KAAK,EAAE,GAAG,IAAA,uDAAwB,GAAE,EAAE,CAAC;IAGpD,KAAK,GAAG,EAAE,GAAG,KAAK,EAAE,GAAG,IAAA,uEAAgC,GAAE,EAAE,CAAC;IAE5D,OAAO,KAAK,CAAC;AACf,CAAC","sourcesContent":["import { ArkosConfig } from \"../../../../exports\";\nimport {\n  getModels,\n  importPrismaModelModules,\n} from \"../../../../utils/helpers/models.helpers\";\nimport { kebabCase, pascalCase } from \"../../../../exports/utils\";\nimport { OpenAPIV3 } from \"openapi-types\";\nimport pluralize from \"pluralize\";\nimport { getSystemJsonSchemaPaths } from \"./get-system-json-schema-paths\";\nimport { getAuthenticationJsonSchemaPaths } from \"./get-authentication-json-schema-paths\";\nimport { generateZodJsonSchemas } from \"./json-schema-generators/generate-zod-json-schema\";\nimport { generateClassValidatorJsonSchemas } from \"./json-schema-generators/generate-class-validator-json-schemas\";\nimport { generatePrismaJsonSchemas } from \"./json-schema-generators/generate-prisma-json-schemas\";\nimport { generatePrismaModelMainRoutesPaths } from \"./json-schema-generators/prisma-models/generate-prisma-model-main-routes\";\nimport { generatePrismaModelParentRoutePaths } from \"./json-schema-generators/prisma-models/generate-prisma-model-parent-routes\";\n\nexport async function getOpenAPIJsonSchemasByConfigMode(\n  swaggerConfig: ArkosConfig[\"swagger\"]\n) {\n  switch (swaggerConfig!.mode) {\n    case \"prisma\":\n      return await generatePrismaJsonSchemas();\n    case \"class-validator\":\n      return await generateClassValidatorJsonSchemas();\n    case \"zod\":\n      return await generateZodJsonSchemas();\n    default:\n      throw Error(\n        \"Unknown mode for auto documentation, supported values are prisma, class-validator, zod or json-schemas\"\n      );\n  }\n}\n\nexport function getCorrectJsonSchemaName(\n  type: string,\n  modelName: string,\n  suffix: \"Dto\" | \"Schema\"\n): string {\n  const pascalModelName = pascalCase(modelName);\n\n  const map: Record<string, string> = {\n    model: pascalModelName,\n    create: `Create${pascalModelName}`,\n    createMany: `CreateMany${pascalModelName}`,\n    findOne: `FindOne${pascalModelName}`,\n    findMany: `FindMany${pascalModelName}`,\n    update: `Update${pascalModelName}`,\n    updateMany: `UpdateMany${pascalModelName}`,\n    query: `Query${pascalModelName}`,\n    login: \"Login\",\n    signup: \"Signup\",\n    updateMe: \"UpdateMe\",\n    updatePassword: \"UpdatePassword\",\n  };\n\n  const baseName = map[type] ?? pascalCase(type);\n  return `${baseName}${suffix}`;\n}\n\nexport function kebabToHuman(kebabStr: string): string {\n  return kebabStr\n    .split(\"-\")\n    .map((word) => word.charAt(0).toUpperCase() + word.slice(1))\n    .join(\" \");\n}\n\nexport function getSchemaRef(schemaName: string, mode: string): string {\n  switch (mode) {\n    case \"prisma\":\n    case \"zod\":\n      return `#/components/schemas/${schemaName}Schema`;\n    case \"class-validator\":\n      return `#/components/schemas/${schemaName}Dto`;\n    default:\n      return `#/components/schemas/${schemaName}`;\n  }\n}\n\nexport async function generatePathsForModels(\n  swaggerConfig: ArkosConfig[\"swagger\"]\n): Promise<OpenAPIV3.PathsObject> {\n  if (!swaggerConfig) return {};\n\n  let paths: OpenAPIV3.PathsObject = {};\n  const models = getModels();\n  const mode = swaggerConfig!.mode;\n\n  for (const model of models) {\n    const modelName = kebabCase(model);\n    const routeName = pluralize.plural(modelName);\n    const pascalModelName = pascalCase(model);\n    const humanReadableName = kebabToHuman(modelName);\n    const humanReadableNamePlural = pluralize.plural(humanReadableName);\n\n    // Import model modules to get router config\n    const modelModules = await importPrismaModelModules(model);\n    const routerConfig = modelModules.router?.config;\n\n    // Skip if router is completely disabled\n    if (routerConfig?.disable === true) continue;\n\n    // Generate main routes\n    await generatePrismaModelMainRoutesPaths(\n      paths,\n      routeName,\n      pascalModelName,\n      humanReadableName,\n      humanReadableNamePlural,\n      routerConfig,\n      mode\n    );\n\n    // Generate parent routes if configured\n    if (routerConfig?.parent)\n      await generatePrismaModelParentRoutePaths(\n        paths,\n        routeName,\n        pascalModelName,\n        humanReadableName,\n        humanReadableNamePlural,\n        routerConfig,\n        mode\n      );\n  }\n\n  // Add system routes\n  paths = { ...paths, ...getSystemJsonSchemaPaths() };\n\n  // Add authentication routes\n  paths = { ...paths, ...getAuthenticationJsonSchemaPaths() };\n\n  return paths;\n}\n"]}

package/dist/cjs/paths.js

@@ -1 +1 @@
-"use strict";var __importDefault=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(exports,"__esModule",{value:!0}),exports.ROOT_DIR=void 0;const path_1=__importDefault(require("path"));exports.ROOT_DIR=path_1.default.resolve(__dirname,"../..");
+"use strict";var __importDefault=function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(exports,"__esModule",{value:!0}),exports.ROOT_DIR=void 0;const path_1=__importDefault(require("path"));exports.ROOT_DIR=path_1.default.resolve(__dirname,"../..");

package/dist/cjs/server.js

@@ -1,3 +1,3 @@
-"use strict";var __importDefault=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(exports,"__esModule",{value:!0}),exports.server=void 0,exports.terminateApplicationRunningProcessAndServer=terminateApplicationRunningProcessAndServer,exports.getArkosConfig=getArkosConfig,exports.getExpressApp=getExpressApp,exports.initApp=initApp;const app_1=require("./app"),deepmerge_helper_1=__importDefault(require("./utils/helpers/deepmerge.helper")),http_1=__importDefault(require("http"));process.on("uncaughtException",e=>{e.message.includes("EPIPE")||(console.error(`
+"use strict";var __importDefault=function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(exports,"__esModule",{value:!0}),exports.server=void 0,exports.terminateApplicationRunningProcessAndServer=terminateApplicationRunningProcessAndServer,exports.getArkosConfig=getArkosConfig,exports.getExpressApp=getExpressApp,exports.initApp=initApp;const app_1=require("./app"),deepmerge_helper_1=__importDefault(require("./utils/helpers/deepmerge.helper")),http_1=__importDefault(require("http")),sheu_1=__importDefault(require("./utils/sheu"));process.on("uncaughtException",e=>{e.message.includes("EPIPE")||(console.error(`
 UNCAUGHT EXCEPTION! SHUTTING DOWN...
-`),console.error(e.name,e.message),console.error(e),process.exit(1))});let server,_app,_arkosConfig={welcomeMessage:"Welcome to our RESTful API generated by Arkos, find out more about Arkos at www.arkosjs.com",port:Number(process.env.CLI_PORT)||Number(process.env.PORT)||8e3,host:process.env.CLI_HOST||process.env.HOST||"localhost",fileUpload:{baseUploadDir:"uploads",baseRoute:"/api/uploads"},available:!1};async function initApp(e={}){_arkosConfig.available=!0,_arkosConfig=(0,deepmerge_helper_1.default)(_arkosConfig,e);const r=process.env.CLI_PORT||e.port||process.env.PORT||void 0;return _app=await(0,app_1.bootstrap)(_arkosConfig),r&&(exports.server=server=http_1.default.createServer(_app),_arkosConfig?.configureServer&&await _arkosConfig.configureServer(server),server.listen(Number(r),_arkosConfig.host,()=>{const o=new Date().toTimeString().split(" ")[0];console.info(`[\x1B[32mREADY\x1B[0m] \x1B[90m${o}\x1B[0m server waiting on http://${_arkosConfig.host||"localhost"}:${r}`)})),_app}process.on("unhandledRejection",e=>{console.error("UNHANDLED REJECTION! SHUTTING DOWN..."),console.error(e.name,e.message),console.error(e),server?.close(()=>{process.exit(1)})});function terminateApplicationRunningProcessAndServer(){server?.close(()=>{process.exit(1)})}function getArkosConfig(){return _arkosConfig}function getExpressApp(){return _app}
+`),console.error(e.name,e.message),console.error(e),process.exit(1))});let server,_app,_arkosConfig={welcomeMessage:"Welcome to our RESTful API generated by Arkos, find out more about Arkos at www.arkosjs.com",port:Number(process.env.CLI_PORT)||Number(process.env.PORT)||8e3,host:process.env.CLI_HOST||process.env.HOST||"localhost",fileUpload:{baseUploadDir:"uploads",baseRoute:"/api/uploads"},available:!1};async function initApp(e={}){_arkosConfig.available=!0,_arkosConfig=(0,deepmerge_helper_1.default)(_arkosConfig,e);const r=process.env.CLI_PORT||_arkosConfig.port||process.env.PORT||"port"in _arkosConfig?_arkosConfig.port:8e3;_app=await(0,app_1.bootstrap)(_arkosConfig);const t=new Date().toTimeString().split(" ")[0];return r?(exports.server=server=http_1.default.createServer(_app),_arkosConfig?.configureServer&&await _arkosConfig.configureServer(server),server.listen(Number(r),_arkosConfig.host,()=>{sheu_1.default.ready(`${sheu_1.default.gray(t)} server waiting on http://${_arkosConfig.host||"localhost"}:${r}`)})):sheu_1.default.warn(`${sheu_1.default.gray(t)} port set to undefined, hence no internal http server was setup.`),_app}process.on("unhandledRejection",e=>{console.error("UNHANDLED REJECTION! SHUTTING DOWN..."),console.error(e.name,e.message),console.error(e),server?.close(()=>{process.exit(1)})});function terminateApplicationRunningProcessAndServer(){server?.close(()=>{process.exit(1)})}function getArkosConfig(){return _arkosConfig}function getExpressApp(){return _app}

package/dist/cjs/server.js.map

@@ -1 +1 @@
-{"version":3,"file":"server.js","sourceRoot":"","sources":["../../src/server.ts"],"names":[],"mappings":";;;;;;AAqFA,kGAIC;AAOD,wCAEC;AAED,sCAEC;AAEgB,0BAAO;AArGxB,+BAAkC;AAElC,wFAAyD;AACzD,gDAAwB;AAExB,OAAO,CAAC,EAAE,CAAC,mBAAmB,EAAE,CAAC,GAAG,EAAE,EAAE;IACtC,IAAI,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC;QAAE,OAAO;IAE1C,OAAO,CAAC,KAAK,CAAC,0CAA0C,CAAC,CAAC;IAC1D,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;IACrC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACnB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC,CAAC,CAAC;AAEH,IAAI,MAA6D,CAAC;AAClE,IAAI,IAAa,CAAC;AAElB,IAAI,YAAY,GAA0C;IACxD,cAAc,EACZ,6FAA6F;IAC/F,IAAI,EAAE,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,IAAI;IACtE,IAAI,EAAE,OAAO,CAAC,GAAG,CAAC,QAAQ,IAAI,OAAO,CAAC,GAAG,CAAC,IAAI,IAAI,WAAW;IAC7D,UAAU,EAAE;QACV,aAAa,EAAE,SAAS;QACxB,SAAS,EAAE,cAAc;KAC1B;IACD,SAAS,EAAE,KAAK;CACjB,CAAC;AAeF,KAAK,UAAU,OAAO,CAAC,cAA2B,EAAE;IAClD,YAAY,CAAC,SAAS,GAAG,IAAI,CAAC;IAC9B,YAAY,GAAG,IAAA,0BAAS,EAAC,YAAY,EAAE,WAAW,CAAC,CAAC;IAEpD,MAAM,IAAI,GACR,OAAO,CAAC,GAAG,CAAC,QAAQ,IAAI,WAAW,CAAC,IAAI,IAAI,OAAO,CAAC,GAAG,CAAC,IAAI,IAAI,SAAS,CAAC;IAE5E,IAAI,GAAG,MAAM,IAAA,eAAS,EAAC,YAAY,CAAC,CAAC;IAErC,IAAI,IAAI,EAAE,CAAC;QACT,iBAAA,MAAM,GAAG,cAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QAEjC,IAAI,YAAY,EAAE,eAAe;YAC/B,MAAM,YAAY,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;QAE7C,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,YAAY,CAAC,IAAK,EAAE,GAAG,EAAE;YACnD,MAAM,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC,YAAY,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;YACrD,OAAO,CAAC,IAAI,CACV,kCAAkC,IAAI,oCAAoC,YAAY,CAAC,IAAI,IAAI,WAAW,IAAI,IAAI,EAAE,CACrH,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AAED,OAAO,CAAC,EAAE,CAAC,oBAAoB,EAAE,CAAC,GAAa,EAAE,EAAE;IACjD,OAAO,CAAC,KAAK,CAAC,uCAAuC,CAAC,CAAC;IACvD,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;IACrC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACnB,MAAM,EAAE,KAAK,CAAC,GAAG,EAAE;QACjB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAOH,SAAgB,2CAA2C;IACzD,MAAM,EAAE,KAAK,CAAC,GAAG,EAAE;QACjB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC,CAAC,CAAC;AACL,CAAC;AAOD,SAAgB,cAAc;IAC5B,OAAO,YAAY,CAAC;AACtB,CAAC;AAED,SAAgB,aAAa;IAC3B,OAAO,IAAI,CAAC;AACd,CAAC","sourcesContent":["import { IncomingMessage, Server, ServerResponse } from \"http\";\nimport AppError from \"./modules/error-handler/utils/app-error\";\nimport { Express } from \"express\";\nimport { bootstrap } from \"./app\";\nimport { ArkosConfig } from \"./types/arkos-config\";\nimport deepmerge from \"./utils/helpers/deepmerge.helper\";\nimport http from \"http\";\n\nprocess.on(\"uncaughtException\", (err) => {\n  if (err.message.includes(\"EPIPE\")) return;\n\n  console.error(\"\\nUNCAUGHT EXCEPTION! SHUTTING DOWN...\\n\");\n  console.error(err.name, err.message);\n  console.error(err);\n  process.exit(1);\n});\n\nlet server: Server<typeof IncomingMessage, typeof ServerResponse>;\nlet _app: Express;\n\nlet _arkosConfig: ArkosConfig & { available?: boolean } = {\n  welcomeMessage:\n    \"Welcome to our RESTful API generated by Arkos, find out more about Arkos at www.arkosjs.com\",\n  port: Number(process.env.CLI_PORT) || Number(process.env.PORT) || 8000,\n  host: process.env.CLI_HOST || process.env.HOST || \"localhost\",\n  fileUpload: {\n    baseUploadDir: \"uploads\",\n    baseRoute: \"/api/uploads\",\n  },\n  available: false,\n};\n\n/**\n * Initializes the application server.\n *\n * This function starts the server by listening on a specified port.\n * The port is determined by the following order of precedence:\n * 1. The `port` argument passed to the function.\n * 2. Defaults to `8000` if neither is provided.\n *\n * @param {ArkosConfig} arkosConfig - initial configs for the api ( authentication, port).\n * @returns {Promise<Express>} This function returns the Express App after all middlewares configurations.\n * You can prevent it from listen py passing port as undefined\n *\n */\nasync function initApp(arkosConfig: ArkosConfig = {}): Promise<Express> {\n  _arkosConfig.available = true;\n  _arkosConfig = deepmerge(_arkosConfig, arkosConfig);\n\n  const port =\n    process.env.CLI_PORT || arkosConfig.port || process.env.PORT || undefined;\n\n  _app = await bootstrap(_arkosConfig);\n\n  if (port) {\n    server = http.createServer(_app);\n\n    if (_arkosConfig?.configureServer)\n      await _arkosConfig.configureServer(server);\n\n    server.listen(Number(port), _arkosConfig.host!, () => {\n      const time = new Date().toTimeString().split(\" \")[0];\n      console.info(\n        `[\\x1b[32mREADY\\x1b[0m] \\x1b[90m${time}\\x1b[0m server waiting on http://${_arkosConfig.host || \"localhost\"}:${port}`\n      );\n    });\n  }\n\n  return _app;\n}\n\nprocess.on(\"unhandledRejection\", (err: AppError) => {\n  console.error(\"UNHANDLED REJECTION! SHUTTING DOWN...\");\n  console.error(err.name, err.message);\n  console.error(err);\n  server?.close(() => {\n    process.exit(1);\n  });\n});\n\n/**\n * Terminates the current running express application, server and process.\n *\n * @returns {void}\n */\nexport function terminateApplicationRunningProcessAndServer(): void {\n  server?.close(() => {\n    process.exit(1);\n  });\n}\n\n/**\n * Gives access to the underlying current configurations being used by **Arkos** by default and also passed through `arkos.init()`\n *\n * @returns {ArkosConfig}\n */\nexport function getArkosConfig(): ArkosConfig {\n  return _arkosConfig;\n}\n\nexport function getExpressApp() {\n  return _app;\n}\n\nexport { server, initApp };\n"]}
+{"version":3,"file":"server.js","sourceRoot":"","sources":["../../src/server.ts"],"names":[],"mappings":";;;;;;AA+FA,kGAIC;AAOD,wCAEC;AAED,sCAEC;AAEgB,0BAAO;AA/GxB,+BAAkC;AAElC,wFAAyD;AACzD,gDAAwB;AACxB,wDAAgC;AAEhC,OAAO,CAAC,EAAE,CAAC,mBAAmB,EAAE,CAAC,GAAG,EAAE,EAAE;IACtC,IAAI,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC;QAAE,OAAO;IAE1C,OAAO,CAAC,KAAK,CAAC,0CAA0C,CAAC,CAAC;IAC1D,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;IACrC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACnB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC,CAAC,CAAC;AAEH,IAAI,MAA6D,CAAC;AAClE,IAAI,IAAa,CAAC;AAElB,IAAI,YAAY,GAA0C;IACxD,cAAc,EACZ,6FAA6F;IAC/F,IAAI,EAAE,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,IAAI;IACtE,IAAI,EAAE,OAAO,CAAC,GAAG,CAAC,QAAQ,IAAI,OAAO,CAAC,GAAG,CAAC,IAAI,IAAI,WAAW;IAC7D,UAAU,EAAE;QACV,aAAa,EAAE,SAAS;QACxB,SAAS,EAAE,cAAc;KAC1B;IACD,SAAS,EAAE,KAAK;CACjB,CAAC;AAeF,KAAK,UAAU,OAAO,CAAC,cAA2B,EAAE;IAClD,YAAY,CAAC,SAAS,GAAG,IAAI,CAAC;IAC9B,YAAY,GAAG,IAAA,0BAAS,EAAC,YAAY,EAAE,WAAW,CAAC,CAAC;IAEpD,MAAM,IAAI,GACR,OAAO,CAAC,GAAG,CAAC,QAAQ;QACpB,YAAY,CAAC,IAAI;QACjB,OAAO,CAAC,GAAG,CAAC,IAAI;QAChB,MAAM,IAAI,YAAY;QACpB,CAAC,CAAC,YAAY,CAAC,IAAI;QACnB,CAAC,CAAC,IAAI,CAAC;IAEX,IAAI,GAAG,MAAM,IAAA,eAAS,EAAC,YAAY,CAAC,CAAC;IACrC,MAAM,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC,YAAY,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;IAErD,IAAI,IAAI,EAAE,CAAC;QACT,iBAAA,MAAM,GAAG,cAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QAEjC,IAAI,YAAY,EAAE,eAAe;YAC/B,MAAM,YAAY,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;QAE7C,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,YAAY,CAAC,IAAK,EAAE,GAAG,EAAE;YACnD,cAAI,CAAC,KAAK,CACR,GAAG,cAAI,CAAC,IAAI,CAAC,IAAI,CAAC,6BAA6B,YAAY,CAAC,IAAI,IAAI,WAAW,IAAI,IAAI,EAAE,CAC1F,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;SAAM,CAAC;QACN,cAAI,CAAC,IAAI,CACP,GAAG,cAAI,CAAC,IAAI,CAAC,IAAI,CAAC,kEAAkE,CACrF,CAAC;IACJ,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AAED,OAAO,CAAC,EAAE,CAAC,oBAAoB,EAAE,CAAC,GAAa,EAAE,EAAE;IACjD,OAAO,CAAC,KAAK,CAAC,uCAAuC,CAAC,CAAC;IACvD,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;IACrC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACnB,MAAM,EAAE,KAAK,CAAC,GAAG,EAAE;QACjB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAOH,SAAgB,2CAA2C;IACzD,MAAM,EAAE,KAAK,CAAC,GAAG,EAAE;QACjB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC,CAAC,CAAC;AACL,CAAC;AAOD,SAAgB,cAAc;IAC5B,OAAO,YAAY,CAAC;AACtB,CAAC;AAED,SAAgB,aAAa;IAC3B,OAAO,IAAI,CAAC;AACd,CAAC","sourcesContent":["import { IncomingMessage, Server, ServerResponse } from \"http\";\nimport AppError from \"./modules/error-handler/utils/app-error\";\nimport { Express } from \"express\";\nimport { bootstrap } from \"./app\";\nimport { ArkosConfig } from \"./types/arkos-config\";\nimport deepmerge from \"./utils/helpers/deepmerge.helper\";\nimport http from \"http\";\nimport sheu from \"./utils/sheu\";\n\nprocess.on(\"uncaughtException\", (err) => {\n  if (err.message.includes(\"EPIPE\")) return;\n\n  console.error(\"\\nUNCAUGHT EXCEPTION! SHUTTING DOWN...\\n\");\n  console.error(err.name, err.message);\n  console.error(err);\n  process.exit(1);\n});\n\nlet server: Server<typeof IncomingMessage, typeof ServerResponse>;\nlet _app: Express;\n\nlet _arkosConfig: ArkosConfig & { available?: boolean } = {\n  welcomeMessage:\n    \"Welcome to our RESTful API generated by Arkos, find out more about Arkos at www.arkosjs.com\",\n  port: Number(process.env.CLI_PORT) || Number(process.env.PORT) || 8000,\n  host: process.env.CLI_HOST || process.env.HOST || \"localhost\",\n  fileUpload: {\n    baseUploadDir: \"uploads\",\n    baseRoute: \"/api/uploads\",\n  },\n  available: false,\n};\n\n/**\n * Initializes the application server.\n *\n * This function starts the server by listening on a specified port.\n * The port is determined by the following order of precedence:\n * 1. The `port` argument passed to the function.\n * 2. Defaults to `8000` if neither is provided.\n *\n * @param {ArkosConfig} arkosConfig - initial configs for the api ( authentication, port).\n * @returns {Promise<Express>} This function returns the Express App after all middlewares configurations.\n * You can prevent it from listen py passing port as undefined\n *\n */\nasync function initApp(arkosConfig: ArkosConfig = {}): Promise<Express> {\n  _arkosConfig.available = true;\n  _arkosConfig = deepmerge(_arkosConfig, arkosConfig);\n\n  const port =\n    process.env.CLI_PORT ||\n    _arkosConfig.port ||\n    process.env.PORT ||\n    \"port\" in _arkosConfig\n      ? _arkosConfig.port\n      : 8000;\n\n  _app = await bootstrap(_arkosConfig);\n  const time = new Date().toTimeString().split(\" \")[0];\n\n  if (port) {\n    server = http.createServer(_app);\n\n    if (_arkosConfig?.configureServer)\n      await _arkosConfig.configureServer(server);\n\n    server.listen(Number(port), _arkosConfig.host!, () => {\n      sheu.ready(\n        `${sheu.gray(time)} server waiting on http://${_arkosConfig.host || \"localhost\"}:${port}`\n      );\n    });\n  } else {\n    sheu.warn(\n      `${sheu.gray(time)} port set to undefined, hence no internal http server was setup.`\n    );\n  }\n\n  return _app;\n}\n\nprocess.on(\"unhandledRejection\", (err: AppError) => {\n  console.error(\"UNHANDLED REJECTION! SHUTTING DOWN...\");\n  console.error(err.name, err.message);\n  console.error(err);\n  server?.close(() => {\n    process.exit(1);\n  });\n});\n\n/**\n * Terminates the current running express application, server and process.\n *\n * @returns {void}\n */\nexport function terminateApplicationRunningProcessAndServer(): void {\n  server?.close(() => {\n    process.exit(1);\n  });\n}\n\n/**\n * Gives access to the underlying current configurations being used by **Arkos** by default and also passed through `arkos.init()`\n *\n * @returns {ArkosConfig}\n */\nexport function getArkosConfig(): ArkosConfig {\n  return _arkosConfig;\n}\n\nexport function getExpressApp() {\n  return _app;\n}\n\nexport { server, initApp };\n"]}

package/dist/cjs/types/arkos-config.js.map

@@ -1 +1 @@
-{"version":3,"file":"arkos-config.js","sourceRoot":"","sources":["../../../src/types/arkos-config.ts"],"names":[],"mappings":"","sourcesContent":["import http from \"http\";\nimport cors from \"cors\";\nimport express from \"express\";\nimport { Options as RateLimitOptions } from \"express-rate-limit\";\nimport cookieParser from \"cookie-parser\";\nimport compression from \"compression\";\nimport { Options as QueryParserOptions } from \"../utils/helpers/query-parser.helpers\";\nimport { ValidatorOptions } from \"class-validator\";\nimport { MsDuration } from \"../modules/auth/utils/helpers/auth.controller.helpers\";\n\n/**\n * Defines the initial configs of the api to be loaded at startup when arkos.init() is called.\n */\nexport type ArkosConfig = {\n  /**\n   * Allows to configure request configs\n   */\n  request?: {\n    /**\n     * Allows to configure request parameters\n     */\n    parameters?: {\n      /**\n       * Toggles allowing `VERY DANGEROUS` request paramateres under `req.query` for passing prisma query options.\n       *\n       * See more\n       */\n      allowDangerousPrismaQueryOptions?: boolean;\n    };\n  };\n  /** Message you would like to send, as Json and 200 response when\n   * ```curl\n   * GET /api\n   * ```\n   *\n   * ```json\n   * { \"message\": \"Welcome to YourAppName\" }\n   * ```\n   *\n   * default message is: Welcome to our Rest API generated by Arkos, find more about Arkos at www.arkosjs.com.\n   *\n   *\n   *  */\n  welcomeMessage?: string;\n  /**\n   * Port where the application will run, can be set in 3 ways:\n   *\n   * 1. default is 8000\n   * 2. PORT under environment variables (Lower precedence)\n   * 3. this config option (Higher precedence)\n   */\n  port?: number | undefined;\n  /**\n   * Allows to listen on a different host than localhost only\n   */\n  host?: string;\n  /**\n   * Defines authentication related configurations, by default is undefined.\n   *\n   * See [www.arkosjs.com/docs/core-concepts/built-in-authentication-system](https://www.arkosjs.com/docs/core-concepts/built-in-authentication-system) for details.\n   */\n  authentication?: {\n    /**\n     * Defines whether to use Static or Dynamic Role-Based Acess Control\n     *\n     * Visit [www.arkosjs.com/docs/core-concepts/built-in-authentication-system](https://www.arkosjs.com/docs/core-concepts/built-in-authentication-system) for more details.\n     */\n    mode: \"static\" | \"dynamic\";\n    /**\n     * Defines auth login related configurations to customize the api.\n     */\n    login?: {\n      /**\n       * Defines the field that will be used as username by the built-in auth system, by default arkos will look for the field \"username\" in your model User, hence when making login for example you must send:\n       *\n       * ```json\n       *  {\n       *    \"username\": \"johndoe\",\n       *    \"password\": \"somePassword123\"\n       *  }\n       * ```\n       *\n       * **Note:** You can also modify the usernameField on the fly by passing it to the request query parameters. example:\n       *\n       * ```curl\n       * POST /api/auth/login?usernameField=email\n       * ```\n       *\n       * See more at [www.arkosjs.com/docs/guide/authentication-system/sending-authentication-requests#example-changing-the-username-field](https://www.arkosjs.com/docs/guide/authentication-system/sending-authentication-requests#example-changing-the-username-field)\n       *\n       * By specifing here another field for username, for example passing \"email\", \"companyCode\" or something else your json will be like:\n       *\n       * **Example with email**\n       *\n       * ```json\n       *  {\n       *    \"email\": \"john.doe@example.com\",\n       *    \"password\": \"somePassword123\"\n       *  }\n       * ```\n       */\n      allowedUsernames?: string[];\n      /** Defines wether to send the access token in response after login or only send as cookie, defeault is both.*/\n      sendAccessTokenThrough?: \"cookie-only\" | \"response-only\" | \"both\";\n    };\n    /**\n     * Specifies the regex pattern used by the authentication system to enforce password strength requirements.\n     *\n     * **Important**: If using validation libraries like Zod or class-validator, this will be completely overwritten.\n     *\n     * **Default**: ```/^(?=.*[A-Z])(?=.*[a-z])(?=.*\\d).+$/``` - Ensures the password contains at least one uppercase letter, one lowercase letter, and one numeric digit.\n     *\n     * **message**: (Optional) A custom error message to display when the password does not meet the required strength criteria.\n     */\n    passwordValidation?: { regex: RegExp; message?: string };\n    /**\n     * Allows to specify the request rate limit for all authentication endpoints but `/api/users/me`.\n     * \n     * #### Default\n     *{\n        windowMs: 5000,\n        limit: 10,\n        standardHeaders: \"draft-7\",\n        legacyHeaders: false,\n      }\n     * \n     * Passing an object not overriding all the default options will only\n     * cause it to be deepmerged and not actually replace with empty fields\n     * \n     *@see This is are the options used on the `express-rate-limit` npm package used on epxress. read more about [https://www.npmjs.com/package/express-rate-limit](https://www.npmjs.com/package/express-rate-limit)\n     */\n    requestRateLimitOptions?: Partial<RateLimitOptions>;\n    /**\n     * JWT (JSON Web Token) authentication configuration.\n     *\n     * You can override these values directly in code, or use environment variables:\n     *\n     * - `JWT_SECRET`: Secret used to sign and verify JWT tokens.\n     * - `JWT_EXPIRES_IN`: Duration string or number indicating when the token should expire (e.g. \"30d\", 3600).\n     * - `JWT_COOKIE_SECURE`: Whether the cookie is sent only over HTTPS. Default: `true` in production.\n     * - `JWT_COOKIE_HTTP_ONLY`: Whether the cookie is HTTP-only. Default: `true`.\n     * - `JWT_COOKIE_SAME_SITE`: Can be \"lax\", \"strict\", or \"none\". Defaults to \"lax\" in dev, \"none\" in prod.\n     *\n     * ⚠️ Values passed here take precedence over environment variables.\n     */\n    jwt?: {\n      /** Secret key used for signing and verifying JWT tokens */\n      secret?: string;\n      /**\n       * Duration after which the JWT token expires.\n       * Accepts either a duration string (e.g. \"30d\", \"1h\") or a number in milliseconds.\n       * Defaults to \"30d\" if not provided.\n       */\n      expiresIn?: MsDuration | number;\n\n      /**\n       * Configuration for the JWT cookie sent to the client\n       */\n      cookie?: {\n        /**\n         * Whether the cookie should be marked as secure (sent only over HTTPS).\n         * Defaults to `true` in production and `false` in development.\n         */\n        secure?: boolean;\n\n        /**\n         * Whether the cookie should be marked as HTTP-only.\n         * Default is `true` to prevent access via JavaScript.\n         */\n        httpOnly?: boolean;\n\n        /**\n         * Controls the SameSite attribute of the cookie.\n         * Defaults to \"none\" in production and \"lax\" in development.\n         * Options: \"lax\" | \"strict\" | \"none\"\n         */\n        sameSite?: \"lax\" | \"strict\" | \"none\";\n      };\n    };\n  };\n  /** Allows to customize and toggle the built-in validation, by default it is set to `false`. If true is passed it will use validation with the default resolver set to `class-validator` if you intend to change the resolver to `zod` do the following:\n   *\n   *```ts\n   * // src/app.ts\n   * import arkos from 'arkos'\n   *\n   * arkos.init({\n   *    validation: {\n   *        resolver: \"zod\"\n   *    }\n   * })\n   * ```\n   *\n   * @See [www.arkosjs.com/docs/core-concepts/request-data-validation](https://www.arkosjs.com/docs/core-concepts/request-data-validation) for more details.\n   */\n  validation?:\n    | {\n        resolver?: \"class-validator\";\n        /**\n         * ValidatorOptions to used while validating request data.\n         *\n         * **Default**:\n         * ```ts\n         * {\n         *  whitelist: true\n         * }\n         * ```\n         */\n        validationOptions?: ValidatorOptions;\n      }\n    | {\n        resolver?: \"zod\";\n        validationOptions?: Record<string, any>;\n      };\n  /**\n   * Defines file upload configurations\n   *\n   * See [www.arkosjs.com/docs/core-concepts/file-upload#costum-configurations](https://www.arkosjs.com/docs/core-concepts/file-upload#costum-configurations)\n   */\n  fileUpload?: {\n    /**\n     * Defiens the base file upload directory, default is set to /uploads (on root directory)\n     *\n     * When setting up a path dir always now that root directory will be the starting reference.\n     *\n     * #### Example\n     * passing `../my-arkos-uploaded-files`\n     *\n     * Will save uploaded files one level outside the root dir inside `my-arkos-uploaded-files`\n     *\n     * NB: You must be aware of permissions on your server to acess files outside your project directory.\n     *\n     */\n    baseUploadDir?: string;\n    /**\n     * Changes the default `/api/uploads` base route for accessing file upload route.\n     *\n     * #### IMPORTANT\n     * Changing this will not affect the `baseUploadDir` folder. You can\n     * pass here `/api/files/my-user-files` and `baseUploadDir` be `/uploaded-files`.\n     *\n     */\n    baseRoute?: string;\n    /**\n     * Defines options for `express.static(somePath, someOptions)`\n     *\n     * #### Default:\n     *\n     * ```ts\n     *{\n          maxAge: \"1y\",\n          etag: true,\n          lastModified: true,\n          dotfiles: \"ignore\",\n          fallthrough: true,\n          index: false,\n          cacheControl: true,\n        }\n     * ```\n     * \n     * By passing your custom options have in mind that it\n     * will be deepmerged with the default.\n     * \n     * Visit [https://expressjs.com/en/4x/api.html#express.static](https://expressjs.com/en/4x/api.html#express.static) for more understanding.\n     * \n     */\n    expressStaticOptions?: Parameters<typeof express.static>[1];\n    /**\n     * Defines upload restrictions for each file type: image, video, document or other.\n     *\n     * #### Important:\n     * Passing an object without overriding everything will only cause it\n     * to be deepmerged with the default options.\n     *\n     * See [www.arkosjs.com/docs/api-reference/default-supported-upload-files](https://www.arkosjs.com/docs/api-reference/default-supported-upload-files) for detailed explanation about default values.\n     * ```\n     */\n    restrictions?: {\n      images?: {\n        maxCount?: number;\n        maxSize?: number;\n        supportedFilesRegex?: RegExp;\n      };\n      videos?: {\n        maxCount?: number;\n        maxSize?: number;\n        supportedFilesRegex?: RegExp;\n      };\n      documents?: {\n        maxCount?: number;\n        maxSize?: number;\n        supportedFilesRegex?: RegExp;\n      };\n      files?: {\n        maxCount?: number;\n        maxSize?: number;\n        supportedFilesRegex?: RegExp;\n      };\n    };\n  };\n  /**\n   * Allows to specify the request rate limit for all endpoints.\n   * \n   * #### Default\n   *```ts\n   *{\n      windowMs: 60 * 1000,\n      limit: 1000,\n      standardHeaders: \"draft-7\",\n      legacyHeaders: false,\n    }\n    ```\n   * \n   * Passing an object not overriding all the default options will only\n   * cause it to be deepmerged and not actually replace with empty fields\n   * \n   * This is are the options used on the `express-rate-limit` npm package used on epxress. read more about [https://www.npmjs.com/package/express-rate-limit](https://www.npmjs.com/package/express-rate-limit)\n   */\n  globalRequestRateLimitOptions?: Partial<RateLimitOptions>;\n  /**\n   * Defines options for the built-in express.json() middleware\n   * Nothing is passed by default.\n   */\n  jsonBodyParserOptions?: Parameters<typeof express.json>[0];\n  /**\n   * Allows to pass paremeters to cookieParser from npm package cookie-parser\n   * Nothing is passed by default.\n   *\n   * See [www.npmjs.com/package/cookie-parser](https://www.npmjs.com/package/cookie-parser) for further details.\n   */\n  cookieParserParameters?: Parameters<typeof cookieParser>;\n  /**\n   * Allows to define options for npm package compression\n   * Nothing is passed by default.\n   *\n   * See [www.npmjs.com/package/compression](https://www.npmjs.com/package/compression) for further details.\n   */\n  compressionOptions?: compression.CompressionOptions;\n  /**\n   * Options to define how query must be parsed.\n   *\n   * #### for example:\n   * ```\n   * GET /api/product?saleId=null\n   * ```\n   *\n   * Normally would parsed to { saleId: \"null\" } so query parser\n   * trough setting option `parseNull` will transform { saleId: null }\n   * \n   * #### Default:\n   * \n   * {\n      parseNull: true,\n      parseUndefined: true,\n      parseBoolean: true,\n    }\n   * \n   * parseNumber may convert fields that are string but you only passed\n   * numbers to query pay attention to this.\n   * \n   * Soon a feature to converted the query to the end prisma type will be added.\n   */\n  queryParserOptions?: QueryParserOptions;\n  /**\n   * Configuration for CORS (Cross-Origin Resource Sharing).\n   *\n   * @property {string | string[] | \"all\"} [allowedOrigins] - List of allowed origins. If set to `\"all\"`, all origins are accepted.\n   * @property {import('cors').CorsOptions} [options] - Additional CORS options passed directly to the `cors` middleware.\n   * @property {import('cors').CorsOptionsDelegate} [customMiddleware] - A custom middleware function that overrides the default behavior.\n   *\n   * @remarks\n   * If `customMiddleware` is provided, both `allowedOrigins` and `options` will be ignored in favor of the custom logic.\n   *\n   * See https://www.npmjs.com/package/cors\n   */\n  cors?: {\n    /**\n     * Defines allowed origins to acess the API.\n     */\n    allowedOrigins?: string | string[] | \"*\";\n    options?: cors.CorsOptions;\n    /**\n     * If you would like to override the entire middleware\n     *\n     * see\n     */\n    customHandler?: cors.CorsOptionsDelegate;\n  };\n  /**\n   * Defines express/arkos middlewares configurations\n   */\n  middlewares?: {\n    /**\n     * Allows to add an array of custom express middlewares into the default middleware stack.\n     *\n     * **Tip**: If you would like to acess the express app before everthing use `configureApp` and pass a function.\n     *\n     * **Where will these be placed?**: see [www.arkosjs.com/docs/advanced-guide/replace-or-disable-built-in-middlewares#middleware-execution-order](https://www.arkosjs.com/docs/advanced-guide/replace-or-disable-built-in-middlewares#middleware-execution-order)\n     *\n     * **Note**: If you want to use custom global error handler middleware use `middlewares.replace.globalErrorHandler`.\n     *\n     * Read more about The Arkos Middleware Stack at [www.arkosjs.com/docs/the-middleware-stack](https://www.arkosjs.com/docs/the-middleware-stack) for in-depth details.\n     */\n    additional?: express.RequestHandler[];\n    /**\n     * An array containing a list of defaults middlewares to be disabled\n     *\n     * **Caution**: Be careful with this because you may endup breaking your entire application.\n     */\n    disable?: (\n      | \"compression\"\n      | \"global-rate-limit\"\n      | \"auth-rate-limit\"\n      | \"cors\"\n      | \"express-json\"\n      | \"cookie-parser\"\n      | \"query-parser\"\n      | \"database-connection\"\n      | \"request-logger\"\n      | \"global-error-handler\"\n    )[];\n    /**\n     * Allows you to replace each of the built-in middlewares with your own implementation\n     *\n     * **Caution**: Be careful with this because you may endup breaking your entire application.\n     */\n    replace?: {\n      /**\n       * Replace the default compression middleware\n       */\n      compression?: express.RequestHandler;\n      /**\n       * Replace the default global rate limit middleware\n       */\n      globalRateLimit?: express.RequestHandler;\n      /**\n       * Replace the default authentication rate limit middleware\n       */\n      authRateLimit?: express.RequestHandler;\n      /**\n       * Replace the default CORS middleware\n       */\n      cors?: express.RequestHandler;\n      /**\n       * Replace the default JSON body parser middleware\n       */\n      expressJson?: express.RequestHandler;\n      /**\n       * Replace the default cookie parser middleware\n       */\n      cookieParser?: express.RequestHandler;\n      /**\n       * Replace the default query parser middleware\n       */\n      queryParser?: express.RequestHandler;\n      /**\n       * Replace the default database connection check middleware\n       */\n      databaseConnection?: express.RequestHandler;\n      /**\n       * Replace the default request logger middleware\n       */\n      requestLogger?: express.RequestHandler;\n      /**\n       * Replace the default global error handler middleware\n       */\n      globalErrorHandler?: express.ErrorRequestHandler;\n    };\n  };\n  /**\n   * Defines express/arkos routers configurations\n   */\n  routers?: {\n    /**\n     * Allows to add an array of custom express routers into the default middleware/router stack.\n     *\n     * **Where will these be placed?**: see [www.arkosjs.com/docs/advanced-guide/adding-custom-routers](https://www.arkosjs.com/docs/advanced-guide/adding-custom-routers)\n     *\n     *\n     * Read more about The Arkos Middleware Stack at [www.arkosjs.com/docs/the-middleware-stack](https://www.arkosjs.com/docs/the-middleware-stack) for in-depth details.\n     */\n    additional?: express.Router[];\n    disable?: (\n      | \"auth-router\"\n      | \"prisma-models-router\"\n      | \"file-upload\"\n      | \"welcome-endpoint\"\n    )[];\n    /**\n     * Allows you to replace each of the built-in routers with your own implementation.\n     *\n     * **Note**: Doing this you will lose all default middleware chaining, auth control, handlers from the specific router.\n     *\n     * **Tip**: I you want to disable some prisma models specific endpoint\n     * see [www.arkosjs.com/docs/guide/adding-custom-routers#disabling-auto-generated-endpoints](https://www.arkosjs.com/docs/guide/adding-custom-routers#disabling-auto-generated-endpoints)\n     *\n     * **Caution**: Be careful with this because you may endup breaking your entire application.\n     */\n    replace?: {\n      /**\n       * Replace the default authentication router\n       * @param config The original Arkos configuration\n       * @returns A router handling authentication endpoints\n       */\n      authRouter?: (\n        config: ArkosConfig\n      ) => express.Router | Promise<express.Router>;\n      /**\n       * Replace the default Prisma models router\n       * @param config The original Arkos configuration\n       * @returns A router handling Prisma model endpoints\n       */\n      prismaModelsRouter?: (\n        config: ArkosConfig\n      ) => express.Router | Promise<express.Router>;\n      /**\n       * Replace the default file upload router\n       * @param config The original Arkos configuration\n       * @returns A router handling file upload endpoints\n       */\n      fileUpload?: (\n        config: ArkosConfig\n      ) => express.Router | Promise<express.Router>;\n      /**\n       * Replace the default welcome endpoint handler\n       * @param req Express request object\n       * @param res Express response object\n       * @param next Express next function\n       */\n      welcomeEndpoint?: express.RequestHandler;\n    };\n  };\n  /**\n   * Gives acess to the underlying express app so that you can add custom configurations beyong **Arkos** customization capabilities\n   *\n   * **Note**: In the end **Arkos** will call `app.listen` for you.\n   *\n   * If you want to call `app.listen` by yourself pass port as `undefined` and then use the return app from `arkos.init()`.\n   *\n   * See how to call `app.listen` correctly [www.arkosjs.com/docs/guide/accessing-the-express-app#calling-applisten-by-yourself](https://www.arkosjs.com/docs/guide/accessing-the-express-app#calling-applisten-by-yourself)\n   *\n   * See [www.arkosjs.com/docs/guide/accessing-the-express-app](https://www.arkosjs.com/docs/guide/accessing-the-express-app) for further details on the method configureApp.\n   *\n   * @param {express.Express} app\n   * @returns {any}\n   */\n  configureApp?: (app: express.Express) => Promise<any> | any;\n  /**\n   * Gives access to the underlying HTTP server so that you can add custom configurations beyond **Arkos** customization capabilities\n   *\n   * **Note**: In the end **Arkos** will call `server.listen` for you.\n   *\n   * If you want to call `server.listen` by yourself pass port as `undefined` and then use the return server from `arkos.init()`.\n   *\n   * See how to call `server.listen` correctly [www.arkosjs.com/docs/guide/accessing-the-express-app#creating-your-own-http-server](https://www.arkosjs.com/docs/guide/accessing-the-express-app#creating-your-own-http-server)\n   *\n   * See [www.arkosjs.com/docs/guide/accessing-the-express-app#accessing-the-http-server](https://www.arkosjs.com/docs/guide/accessing-the-express-app#accessing-the-http-server) for further details on the method configureServer.\n   *\n   * @param {http.Server} server - The HTTP server instance\n   * @returns {any}\n   */\n  configureServer?: (server: http.Server) => Promise<any> | any;\n  /**\n   * Allows to configure email configurations for sending emails through `emailService`\n   *\n   * See [www.arkosjs.com/docs/core-concepts/sending-emails](https://www.arkosjs.com/docs/core-concepts/sending-emails)\n   */\n  email?: {\n    /**\n     * Your email provider url\n     */\n    host: string;\n    /**\n     * Email provider SMTP port, Default is `465`\n     */\n    port?: number;\n    /**\n     * If smtp connection must be secure, Default is `true`\n     */\n    secure?: boolean;\n    /**\n     * Used to authenticate in your smtp server\n     */\n    auth: {\n      /**\n       * Email used for auth as well as sending emails\n       */\n      user: string;\n      /**\n       * Your SMTP password\n       */\n      pass: string;\n    };\n    /**\n     * Email name to used like:\n     *\n     * John Doe\\<john.doe@gmail.com>\n     */\n    name?: string;\n  };\n  /**\n   * Defines Swagger and OpenApi specifications for auto generating swagger documentation UI using whether it is Prisma Schemas, Class-validator DTOs, Zod Schemas or JSON-Schemas\n   *\n   * **Usage**\n   *\n   * ```ts\n   * // src/app.ts\n   *\n   * import arkos from \"arkos\"\n   *\n   *  arkos.init({\n   *    // other configs\n   *    swagger: {\n   *      mode: \"zod\",\n   *      options: {\n   *        openapi: \"3.0.0\",\n   *        title: \"API Generated By Arkos.js\",\n   *        description: \"This API was automatically generated by Arkos.js    read more about at www.arkosjs.com\"\n   *    }\n   *  }\n   * })\n   * ```\n   *\n   *\n   * @see {@link https://www.arkosjs.com/docs/core-concepts/swagger-api-documentation}\n   */\n  swagger?: {\n    /**\n     * Endpoint where the Swagger UI will be available.\n     *\n     * @default \"/api/docs\"\n     */\n    endpoint?: string;\n    /**\n     * Determines how your API schemas should be generated.\n     *\n     * - \"prisma\": Generates schemas based on Prisma models\n     * - \"class-validator\": Uses class-validator and class-transformer DTO classes\n     * - \"zod`\": Uses OpenAPI-compliant schemas directly\n     * - \"json-schema\": Uses OpenAPI-compliant schemas directly\n     */\n    mode: \"prisma\" | \"class-validator\" | \"zod\" | \"json-schema\";\n    /**\n     *\n     */\n    options: {\n      /**\n       * Swagger definition according to OpenAPI Specification.\n       */\n      definition: {\n        /**\n         * OpenAPI version.\n         *\n         * @default \"3.0.0\"\n         */\n        openapi?: string;\n\n        /**\n         * Information about your API.\n         */\n        info?: {\n          /**\n           * Title of the API documentation.\n           *\n           *\n           * @example \"My API\"\n           *\n           * @default \"API Generated By Arkos.js\"\n           */\n          title?: string;\n\n          /**\n           * Version of the API.\n           *\n           * @example \"1.0.0\"\n           */\n          version?: string;\n\n          /**\n           * Description of the API.\n           *\n           * @default \"This API was automatically generated by Arkos.js read more about at www.arkosjs.com\"\n           */\n          description?: string;\n        };\n\n        /**\n         * Server configurations for the API.\n         *\n         * @default [{ url: \"http://localhost:8000\", description: \"Local server\" }]\n         *\n         * This can be overridden automatically by Arkos based on CLI, .env, or `arkos.init()`.\n         */\n        servers?: {\n          /**\n           * Base URL of the server.\n           *\n           * @example \"http://localhost:8000\"\n           */\n          url: string;\n\n          /**\n           * Human-readable description of the server.\n           *\n           * @example \"Development Server\"\n           */\n          description: string;\n        }[];\n\n        /**\n         * (Optional) Additional metadata such as terms of service, contact, or license.\n         *\n         * See: https://swagger.io/specification/#infoObject\n         */\n        termsOfService?: string;\n        contact?: {\n          name?: string;\n          url?: string;\n          email?: string;\n        };\n        license?: {\n          name: string;\n          url?: string;\n        };\n\n        /**\n         * Tags to group and describe endpoints.\n         */\n        tags?: {\n          name: string;\n          description?: string;\n        }[];\n\n        /**\n         * Security definitions (e.g., Bearer Auth).\n         */\n        components?: {\n          securitySchemes?: Record<string, any>;\n          schemas?: Record<string, any>;\n        };\n\n        /**\n         * Global security requirements.\n         */\n        security?: Array<Record<string, string[]>>;\n      };\n\n      /**\n       * Glob patterns defining where Swagger should look for API route definitions and comments.\n       *\n       * @default \n       * ```ts\n       *  [\"./src/routers/*.router.{ts,js}\", \"./src/modules/**\\/*.router.{ts,js}\"]\n        ```\n       *\n       * Adjust depending on TypeScript or JavaScript usage.\n       */\n      apis?: string[];\n\n      /**\n       * Custom Swagger UI options.\n       *\n       * See: https://github.com/swagger-api/swagger-ui/blob/master/docs/usage/configuration.md\n       */\n      swaggerUiOptions?: Record<string, any>;\n\n      /**\n       * Enables deep linking in the Swagger UI.\n       *\n       * @default true\n       */\n      deepLinking?: boolean;\n\n      /**\n       * Enable/disable the \"Try it out\" button globally.\n       *\n       * @default true\n       */\n      tryItOutEnabled?: boolean;\n\n      /**\n       * Whether to persist authorization data across page reloads.\n       *\n       * @default false\n       */\n      persistAuthorization?: boolean;\n    };\n  };\n};\n"]}
+{"version":3,"file":"arkos-config.js","sourceRoot":"","sources":["../../../src/types/arkos-config.ts"],"names":[],"mappings":"","sourcesContent":["import http from \"http\";\nimport cors from \"cors\";\nimport express from \"express\";\nimport { Options as RateLimitOptions } from \"express-rate-limit\";\nimport cookieParser from \"cookie-parser\";\nimport compression from \"compression\";\nimport { Options as QueryParserOptions } from \"../utils/helpers/query-parser.helpers\";\nimport { ValidatorOptions } from \"class-validator\";\nimport { MsDuration } from \"../modules/auth/utils/helpers/auth.controller.helpers\";\nimport { OpenAPIV3 } from \"openapi-types\";\n\n/**\n * Defines the initial configs of the api to be loaded at startup when arkos.init() is called.\n */\nexport type ArkosConfig = {\n  /**\n   * Allows to configure request configs\n   */\n  request?: {\n    /**\n     * Allows to configure request parameters\n     */\n    parameters?: {\n      /**\n       * Toggles allowing `VERY DANGEROUS` request paramateres under `req.query` for passing prisma query options.\n       *\n       * See more\n       */\n      allowDangerousPrismaQueryOptions?: boolean;\n    };\n  };\n  /** Message you would like to send, as Json and 200 response when\n   * ```curl\n   * GET /api\n   * ```\n   *\n   * ```json\n   * { \"message\": \"Welcome to YourAppName\" }\n   * ```\n   *\n   * default message is: Welcome to our Rest API generated by Arkos, find more about Arkos at www.arkosjs.com.\n   *\n   *\n   *  */\n  welcomeMessage?: string;\n  /**\n   * Port where the application will run, can be set in 3 ways:\n   *\n   * 1. default is 8000\n   * 2. PORT under environment variables (Lower precedence)\n   * 3. this config option (Higher precedence)\n   */\n  port?: number | undefined;\n  /**\n   * Allows to listen on a different host than localhost only\n   */\n  host?: string;\n  /**\n   * Defines authentication related configurations, by default is undefined.\n   *\n   * See [www.arkosjs.com/docs/core-concepts/built-in-authentication-system](https://www.arkosjs.com/docs/core-concepts/built-in-authentication-system) for details.\n   */\n  authentication?: {\n    /**\n     * Defines whether to use Static or Dynamic Role-Based Acess Control\n     *\n     * Visit [www.arkosjs.com/docs/core-concepts/built-in-authentication-system](https://www.arkosjs.com/docs/core-concepts/built-in-authentication-system) for more details.\n     */\n    mode: \"static\" | \"dynamic\";\n    /**\n     * Defines auth login related configurations to customize the api.\n     */\n    login?: {\n      /**\n       * Defines the field that will be used as username by the built-in auth system, by default arkos will look for the field \"username\" in your model User, hence when making login for example you must send:\n       *\n       * ```json\n       *  {\n       *    \"username\": \"johndoe\",\n       *    \"password\": \"somePassword123\"\n       *  }\n       * ```\n       *\n       * **Note:** You can also modify the usernameField on the fly by passing it to the request query parameters. example:\n       *\n       * ```curl\n       * POST /api/auth/login?usernameField=email\n       * ```\n       *\n       * See more at [www.arkosjs.com/docs/guide/authentication-system/sending-authentication-requests#example-changing-the-username-field](https://www.arkosjs.com/docs/guide/authentication-system/sending-authentication-requests#example-changing-the-username-field)\n       *\n       * By specifing here another field for username, for example passing \"email\", \"companyCode\" or something else your json will be like:\n       *\n       * **Example with email**\n       *\n       * ```json\n       *  {\n       *    \"email\": \"john.doe@example.com\",\n       *    \"password\": \"somePassword123\"\n       *  }\n       * ```\n       */\n      allowedUsernames?: string[];\n      /** Defines wether to send the access token in response after login or only send as cookie, defeault is both.*/\n      sendAccessTokenThrough?: \"cookie-only\" | \"response-only\" | \"both\";\n    };\n    /**\n     * Specifies the regex pattern used by the authentication system to enforce password strength requirements.\n     *\n     * **Important**: If using validation libraries like Zod or class-validator, this will be completely overwritten.\n     *\n     * **Default**: ```/^(?=.*[A-Z])(?=.*[a-z])(?=.*\\d).+$/``` - Ensures the password contains at least one uppercase letter, one lowercase letter, and one numeric digit.\n     *\n     * **message**: (Optional) A custom error message to display when the password does not meet the required strength criteria.\n     */\n    passwordValidation?: { regex: RegExp; message?: string };\n    /**\n     * Allows to specify the request rate limit for all authentication endpoints but `/api/users/me`.\n     * \n     * #### Default\n     *{\n        windowMs: 5000,\n        limit: 10,\n        standardHeaders: \"draft-7\",\n        legacyHeaders: false,\n      }\n     * \n     * Passing an object not overriding all the default options will only\n     * cause it to be deepmerged and not actually replace with empty fields\n     * \n     *@see This is are the options used on the `express-rate-limit` npm package used on epxress. read more about [https://www.npmjs.com/package/express-rate-limit](https://www.npmjs.com/package/express-rate-limit)\n     */\n    requestRateLimitOptions?: Partial<RateLimitOptions>;\n    /**\n     * JWT (JSON Web Token) authentication configuration.\n     *\n     * You can override these values directly in code, or use environment variables:\n     *\n     * - `JWT_SECRET`: Secret used to sign and verify JWT tokens.\n     * - `JWT_EXPIRES_IN`: Duration string or number indicating when the token should expire (e.g. \"30d\", 3600).\n     * - `JWT_COOKIE_SECURE`: Whether the cookie is sent only over HTTPS. Default: `true` in production.\n     * - `JWT_COOKIE_HTTP_ONLY`: Whether the cookie is HTTP-only. Default: `true`.\n     * - `JWT_COOKIE_SAME_SITE`: Can be \"lax\", \"strict\", or \"none\". Defaults to \"lax\" in dev, \"none\" in prod.\n     *\n     * ⚠️ Values passed here take precedence over environment variables.\n     */\n    jwt?: {\n      /** Secret key used for signing and verifying JWT tokens */\n      secret?: string;\n      /**\n       * Duration after which the JWT token expires.\n       * Accepts either a duration string (e.g. \"30d\", \"1h\") or a number in milliseconds.\n       * Defaults to \"30d\" if not provided.\n       */\n      expiresIn?: MsDuration | number;\n\n      /**\n       * Configuration for the JWT cookie sent to the client\n       */\n      cookie?: {\n        /**\n         * Whether the cookie should be marked as secure (sent only over HTTPS).\n         * Defaults to `true` in production and `false` in development.\n         */\n        secure?: boolean;\n\n        /**\n         * Whether the cookie should be marked as HTTP-only.\n         * Default is `true` to prevent access via JavaScript.\n         */\n        httpOnly?: boolean;\n\n        /**\n         * Controls the SameSite attribute of the cookie.\n         * Defaults to \"none\" in production and \"lax\" in development.\n         * Options: \"lax\" | \"strict\" | \"none\"\n         */\n        sameSite?: \"lax\" | \"strict\" | \"none\";\n      };\n    };\n  };\n  /** Allows to customize and toggle the built-in validation, by default it is set to `false`. If true is passed it will use validation with the default resolver set to `class-validator` if you intend to change the resolver to `zod` do the following:\n   *\n   *```ts\n   * // src/app.ts\n   * import arkos from 'arkos'\n   *\n   * arkos.init({\n   *    validation: {\n   *        resolver: \"zod\"\n   *    }\n   * })\n   * ```\n   *\n   * @See [www.arkosjs.com/docs/core-concepts/request-data-validation](https://www.arkosjs.com/docs/core-concepts/request-data-validation) for more details.\n   */\n  validation?:\n    | {\n        resolver?: \"class-validator\";\n        /**\n         * ValidatorOptions to used while validating request data.\n         *\n         * **Default**:\n         * ```ts\n         * {\n         *  whitelist: true\n         * }\n         * ```\n         */\n        validationOptions?: ValidatorOptions;\n      }\n    | {\n        resolver?: \"zod\";\n        validationOptions?: Record<string, any>;\n      };\n  /**\n   * Defines file upload configurations\n   *\n   * See [www.arkosjs.com/docs/core-concepts/file-upload#costum-configurations](https://www.arkosjs.com/docs/core-concepts/file-upload#costum-configurations)\n   */\n  fileUpload?: {\n    /**\n     * Defiens the base file upload directory, default is set to /uploads (on root directory)\n     *\n     * When setting up a path dir always now that root directory will be the starting reference.\n     *\n     * #### Example\n     * passing `../my-arkos-uploaded-files`\n     *\n     * Will save uploaded files one level outside the root dir inside `my-arkos-uploaded-files`\n     *\n     * NB: You must be aware of permissions on your server to acess files outside your project directory.\n     *\n     */\n    baseUploadDir?: string;\n    /**\n     * Changes the default `/api/uploads` base route for accessing file upload route.\n     *\n     * #### IMPORTANT\n     * Changing this will not affect the `baseUploadDir` folder. You can\n     * pass here `/api/files/my-user-files` and `baseUploadDir` be `/uploaded-files`.\n     *\n     */\n    baseRoute?: string;\n    /**\n     * Defines options for `express.static(somePath, someOptions)`\n     *\n     * #### Default:\n     *\n     * ```ts\n     *{\n          maxAge: \"1y\",\n          etag: true,\n          lastModified: true,\n          dotfiles: \"ignore\",\n          fallthrough: true,\n          index: false,\n          cacheControl: true,\n        }\n     * ```\n     * \n     * By passing your custom options have in mind that it\n     * will be deepmerged with the default.\n     * \n     * Visit [https://expressjs.com/en/4x/api.html#express.static](https://expressjs.com/en/4x/api.html#express.static) for more understanding.\n     * \n     */\n    expressStaticOptions?: Parameters<typeof express.static>[1];\n    /**\n     * Defines upload restrictions for each file type: image, video, document or other.\n     *\n     * #### Important:\n     * Passing an object without overriding everything will only cause it\n     * to be deepmerged with the default options.\n     *\n     * See [www.arkosjs.com/docs/api-reference/default-supported-upload-files](https://www.arkosjs.com/docs/api-reference/default-supported-upload-files) for detailed explanation about default values.\n     * ```\n     */\n    restrictions?: {\n      images?: {\n        maxCount?: number;\n        maxSize?: number;\n        supportedFilesRegex?: RegExp;\n      };\n      videos?: {\n        maxCount?: number;\n        maxSize?: number;\n        supportedFilesRegex?: RegExp;\n      };\n      documents?: {\n        maxCount?: number;\n        maxSize?: number;\n        supportedFilesRegex?: RegExp;\n      };\n      files?: {\n        maxCount?: number;\n        maxSize?: number;\n        supportedFilesRegex?: RegExp;\n      };\n    };\n  };\n  /**\n   * Allows to specify the request rate limit for all endpoints.\n   * \n   * #### Default\n   *```ts\n   *{\n      windowMs: 60 * 1000,\n      limit: 1000,\n      standardHeaders: \"draft-7\",\n      legacyHeaders: false,\n    }\n    ```\n   * \n   * Passing an object not overriding all the default options will only\n   * cause it to be deepmerged and not actually replace with empty fields\n   * \n   * This is are the options used on the `express-rate-limit` npm package used on epxress. read more about [https://www.npmjs.com/package/express-rate-limit](https://www.npmjs.com/package/express-rate-limit)\n   */\n  globalRequestRateLimitOptions?: Partial<RateLimitOptions>;\n  /**\n   * Defines options for the built-in express.json() middleware\n   * Nothing is passed by default.\n   */\n  jsonBodyParserOptions?: Parameters<typeof express.json>[0];\n  /**\n   * Allows to pass paremeters to cookieParser from npm package cookie-parser\n   * Nothing is passed by default.\n   *\n   * See [www.npmjs.com/package/cookie-parser](https://www.npmjs.com/package/cookie-parser) for further details.\n   */\n  cookieParserParameters?: Parameters<typeof cookieParser>;\n  /**\n   * Allows to define options for npm package compression\n   * Nothing is passed by default.\n   *\n   * See [www.npmjs.com/package/compression](https://www.npmjs.com/package/compression) for further details.\n   */\n  compressionOptions?: compression.CompressionOptions;\n  /**\n   * Options to define how query must be parsed.\n   *\n   * #### for example:\n   * ```\n   * GET /api/product?saleId=null\n   * ```\n   *\n   * Normally would parsed to { saleId: \"null\" } so query parser\n   * trough setting option `parseNull` will transform { saleId: null }\n   * \n   * #### Default:\n   * \n   * {\n      parseNull: true,\n      parseUndefined: true,\n      parseBoolean: true,\n    }\n   * \n   * parseNumber may convert fields that are string but you only passed\n   * numbers to query pay attention to this.\n   * \n   * Soon a feature to converted the query to the end prisma type will be added.\n   */\n  queryParserOptions?: QueryParserOptions;\n  /**\n   * Configuration for CORS (Cross-Origin Resource Sharing).\n   *\n   * @property {string | string[] | \"all\"} [allowedOrigins] - List of allowed origins. If set to `\"all\"`, all origins are accepted.\n   * @property {import('cors').CorsOptions} [options] - Additional CORS options passed directly to the `cors` middleware.\n   * @property {import('cors').CorsOptionsDelegate} [customMiddleware] - A custom middleware function that overrides the default behavior.\n   *\n   * @remarks\n   * If `customMiddleware` is provided, both `allowedOrigins` and `options` will be ignored in favor of the custom logic.\n   *\n   * See https://www.npmjs.com/package/cors\n   */\n  cors?: {\n    /**\n     * Defines allowed origins to acess the API.\n     */\n    allowedOrigins?: string | string[] | \"*\";\n    options?: cors.CorsOptions;\n    /**\n     * If you would like to override the entire middleware\n     *\n     * see\n     */\n    customHandler?: cors.CorsOptionsDelegate;\n  };\n  /**\n   * Defines express/arkos middlewares configurations\n   */\n  middlewares?: {\n    /**\n     * Allows to add an array of custom express middlewares into the default middleware stack.\n     *\n     * **Tip**: If you would like to acess the express app before everthing use `configureApp` and pass a function.\n     *\n     * **Where will these be placed?**: see [www.arkosjs.com/docs/advanced-guide/replace-or-disable-built-in-middlewares#middleware-execution-order](https://www.arkosjs.com/docs/advanced-guide/replace-or-disable-built-in-middlewares#middleware-execution-order)\n     *\n     * **Note**: If you want to use custom global error handler middleware use `middlewares.replace.globalErrorHandler`.\n     *\n     * Read more about The Arkos Middleware Stack at [www.arkosjs.com/docs/the-middleware-stack](https://www.arkosjs.com/docs/the-middleware-stack) for in-depth details.\n     */\n    additional?: express.RequestHandler[];\n    /**\n     * An array containing a list of defaults middlewares to be disabled\n     *\n     * **Caution**: Be careful with this because you may endup breaking your entire application.\n     */\n    disable?: (\n      | \"compression\"\n      | \"global-rate-limit\"\n      | \"auth-rate-limit\"\n      | \"cors\"\n      | \"express-json\"\n      | \"cookie-parser\"\n      | \"query-parser\"\n      | \"database-connection\"\n      | \"request-logger\"\n      | \"global-error-handler\"\n    )[];\n    /**\n     * Allows you to replace each of the built-in middlewares with your own implementation\n     *\n     * **Caution**: Be careful with this because you may endup breaking your entire application.\n     */\n    replace?: {\n      /**\n       * Replace the default compression middleware\n       */\n      compression?: express.RequestHandler;\n      /**\n       * Replace the default global rate limit middleware\n       */\n      globalRateLimit?: express.RequestHandler;\n      /**\n       * Replace the default authentication rate limit middleware\n       */\n      authRateLimit?: express.RequestHandler;\n      /**\n       * Replace the default CORS middleware\n       */\n      cors?: express.RequestHandler;\n      /**\n       * Replace the default JSON body parser middleware\n       */\n      expressJson?: express.RequestHandler;\n      /**\n       * Replace the default cookie parser middleware\n       */\n      cookieParser?: express.RequestHandler;\n      /**\n       * Replace the default query parser middleware\n       */\n      queryParser?: express.RequestHandler;\n      /**\n       * Replace the default database connection check middleware\n       */\n      databaseConnection?: express.RequestHandler;\n      /**\n       * Replace the default request logger middleware\n       */\n      requestLogger?: express.RequestHandler;\n      /**\n       * Replace the default global error handler middleware\n       */\n      globalErrorHandler?: express.ErrorRequestHandler;\n    };\n  };\n  /**\n   * Defines express/arkos routers configurations\n   */\n  routers?: {\n    /**\n     * Allows to add an array of custom express routers into the default middleware/router stack.\n     *\n     * **Where will these be placed?**: see [www.arkosjs.com/docs/advanced-guide/adding-custom-routers](https://www.arkosjs.com/docs/advanced-guide/adding-custom-routers)\n     *\n     *\n     * Read more about The Arkos Middleware Stack at [www.arkosjs.com/docs/the-middleware-stack](https://www.arkosjs.com/docs/the-middleware-stack) for in-depth details.\n     */\n    additional?: express.Router[];\n    disable?: (\n      | \"auth-router\"\n      | \"prisma-models-router\"\n      | \"file-upload\"\n      | \"welcome-endpoint\"\n    )[];\n    /**\n     * Allows you to replace each of the built-in routers with your own implementation.\n     *\n     * **Note**: Doing this you will lose all default middleware chaining, auth control, handlers from the specific router.\n     *\n     * **Tip**: I you want to disable some prisma models specific endpoint\n     * see [www.arkosjs.com/docs/guide/adding-custom-routers#disabling-auto-generated-endpoints](https://www.arkosjs.com/docs/guide/adding-custom-routers#disabling-auto-generated-endpoints)\n     *\n     * **Caution**: Be careful with this because you may endup breaking your entire application.\n     */\n    replace?: {\n      /**\n       * Replace the default authentication router\n       * @param config The original Arkos configuration\n       * @returns A router handling authentication endpoints\n       */\n      authRouter?: (\n        config: ArkosConfig\n      ) => express.Router | Promise<express.Router>;\n      /**\n       * Replace the default Prisma models router\n       * @param config The original Arkos configuration\n       * @returns A router handling Prisma model endpoints\n       */\n      prismaModelsRouter?: (\n        config: ArkosConfig\n      ) => express.Router | Promise<express.Router>;\n      /**\n       * Replace the default file upload router\n       * @param config The original Arkos configuration\n       * @returns A router handling file upload endpoints\n       */\n      fileUpload?: (\n        config: ArkosConfig\n      ) => express.Router | Promise<express.Router>;\n      /**\n       * Replace the default welcome endpoint handler\n       * @param req Express request object\n       * @param res Express response object\n       * @param next Express next function\n       */\n      welcomeEndpoint?: express.RequestHandler;\n    };\n  };\n  /**\n   * Gives acess to the underlying express app so that you can add custom configurations beyong **Arkos** customization capabilities\n   *\n   * **Note**: In the end **Arkos** will call `app.listen` for you.\n   *\n   * If you want to call `app.listen` by yourself pass port as `undefined` and then use the return app from `arkos.init()`.\n   *\n   * See how to call `app.listen` correctly [www.arkosjs.com/docs/guide/accessing-the-express-app#calling-applisten-by-yourself](https://www.arkosjs.com/docs/guide/accessing-the-express-app#calling-applisten-by-yourself)\n   *\n   * See [www.arkosjs.com/docs/guide/accessing-the-express-app](https://www.arkosjs.com/docs/guide/accessing-the-express-app) for further details on the method configureApp.\n   *\n   * @param {express.Express} app\n   * @returns {any}\n   */\n  configureApp?: (app: express.Express) => Promise<any> | any;\n  /**\n   * Gives access to the underlying HTTP server so that you can add custom configurations beyond **Arkos** customization capabilities\n   *\n   * **Note**: In the end **Arkos** will call `server.listen` for you.\n   *\n   * If you want to call `server.listen` by yourself pass port as `undefined` and then use the return server from `arkos.init()`.\n   *\n   * See how to call `server.listen` correctly [www.arkosjs.com/docs/guide/accessing-the-express-app#creating-your-own-http-server](https://www.arkosjs.com/docs/guide/accessing-the-express-app#creating-your-own-http-server)\n   *\n   * See [www.arkosjs.com/docs/guide/accessing-the-express-app#accessing-the-http-server](https://www.arkosjs.com/docs/guide/accessing-the-express-app#accessing-the-http-server) for further details on the method configureServer.\n   *\n   * @param {http.Server} server - The HTTP server instance\n   * @returns {any}\n   */\n  configureServer?: (server: http.Server) => Promise<any> | any;\n  /**\n   * Allows to configure email configurations for sending emails through `emailService`\n   *\n   * See [www.arkosjs.com/docs/core-concepts/sending-emails](https://www.arkosjs.com/docs/core-concepts/sending-emails)\n   */\n  email?: {\n    /**\n     * Your email provider url\n     */\n    host: string;\n    /**\n     * Email provider SMTP port, Default is `465`\n     */\n    port?: number;\n    /**\n     * If smtp connection must be secure, Default is `true`\n     */\n    secure?: boolean;\n    /**\n     * Used to authenticate in your smtp server\n     */\n    auth: {\n      /**\n       * Email used for auth as well as sending emails\n       */\n      user: string;\n      /**\n       * Your SMTP password\n       */\n      pass: string;\n    };\n    /**\n     * Email name to used like:\n     *\n     * John Doe\\<john.doe@gmail.com>\n     */\n    name?: string;\n  };\n  /**\n   * Defines Swagger and OpenApi specifications for auto generating swagger documentation UI using whether it is Prisma Schemas, Class-validator DTOs, Zod Schemas or JSON-Schemas\n   *\n   * **Usage**\n   *\n   * ```ts\n   * // src/app.ts\n   *\n   * import arkos from \"arkos\"\n   *\n   *  arkos.init({\n   *    // other configs\n   *    swagger: {\n   *      mode: \"zod\",\n   *      options: {\n   *        openapi: \"3.0.0\",\n   *        title: \"API Generated By Arkos.js\",\n   *        description: \"This API was automatically generated by Arkos.js    read more about at www.arkosjs.com\"\n   *    }\n   *  }\n   * })\n   * ```\n   * @see {@link https://www.arkosjs.com/docs/core-concepts/swagger-api-documentation}\n   */\n  swagger?: {\n    /**\n     * By default Arkos will disable API Documentation when the project is built `npm run build`, it does not matter what node environment is set. If you want to use it even after the `arkos build` command just set this to `true`.\n     * */\n    enableAfterBuild?: boolean;\n    /**\n     * Endpoint where the Swagger UI will be available.\n     *\n     * @default \"/api/api-docs\"\n     */\n    endpoint?: string;\n    /**\n     * Determines how your API schemas should be generated.\n     *\n     * - \"prisma\": Generates schemas based on Prisma models\n     * - \"class-validator\": Uses class-validator and class-transformer DTO classes\n     * - \"zod\": Uses OpenAPI-compliant schemas directly\n     */\n    mode: \"prisma\" | \"class-validator\" | \"zod\";\n    /**\n     *\n     */\n    options?: {\n      /**\n       * Swagger definition according to OpenAPI Specification.\n       */\n      definition?: {\n        /**\n         * OpenAPI version.\n         *\n         * @default \"3.0.0\"\n         */\n        openapi?: string;\n\n        /**\n         * Information about your API.\n         */\n        info?: {\n          /**\n           * Title of the API documentation.\n           *\n           *\n           * @example \"My API\"\n           *\n           * @default \"API Generated By Arkos.js\"\n           */\n          title?: string;\n\n          /**\n           * Version of the API.\n           *\n           * @example \"1.0.0\"\n           */\n          version?: string;\n\n          /**\n           * Description of the API.\n           *\n           * @default \"This API was automatically generated by Arkos.js read more about at www.arkosjs.com\"\n           */\n          description?: string;\n        };\n\n        /**\n         * Server configurations for the API.\n         *\n         * @default [{ url: \"http://localhost:8000\", description: \"Development server\" }]\n         *\n         * This can be overridden automatically by Arkos based on CLI, .env, or `arkos.init()`.\n         */\n        servers?: {\n          /**\n           * Base URL of the server.\n           *\n           * @example \"http://localhost:8000\"\n           */\n          url: string;\n\n          /**\n           * Human-readable description of the server.\n           *\n           * @example \"Development Server\"\n           */\n          description?: string;\n        }[];\n        /**\n         * Allows adding more paths for your OpenAPI documentation\n         *\n         * */\n        paths?: OpenAPIV3.PathsObject;\n        /**\n         * (Optional) Additional metadata such as terms of service, contact, or license.\n         *\n         * See: https://swagger.io/specification/#infoObject\n         */\n        termsOfService?: string;\n        contact?: {\n          name?: string;\n          url?: string;\n          email?: string;\n        };\n        license?: {\n          name: string;\n          url?: string;\n        };\n\n        /**\n         * Tags to group and describe endpoints.\n         */\n        tags?: {\n          name: string;\n          description?: string;\n        }[];\n\n        /**\n         * Security definitions (e.g., Bearer Auth).\n         */\n        components?: {\n          securitySchemes?: Record<string, any>;\n          schemas?: Record<string, any>;\n        };\n\n        /**\n         * Global security requirements.\n         */\n        security?: Array<Record<string, string[]>>;\n      };\n\n      /**\n       * Glob patterns defining where Swagger should look for API route definitions and comments.\n       *\n       * @default \n       * ```ts\n       *  [\"./src/routers/*.router.{ts,js}\", \"./src/modules/**\\/*.router.{ts,js}\"]\n        ```\n       *\n       * Adjust depending on TypeScript or JavaScript usage.\n       */\n      apis?: string[];\n\n      /**\n       * Custom Swagger UI options.\n       *\n       * See: https://github.com/swagger-api/swagger-ui/blob/master/docs/usage/configuration.md\n       */\n      swaggerUiOptions?: Record<string, any>;\n\n      /**\n       * Enables deep linking in the Swagger UI.\n       *\n       * @default true\n       */\n      deepLinking?: boolean;\n\n      /**\n       * Enable/disable the \"Try it out\" button globally.\n       *\n       * @default true\n       */\n      tryItOutEnabled?: boolean;\n\n      /**\n       * Whether to persist authorization data across page reloads.\n       *\n       * @default false\n       */\n      persistAuthorization?: boolean;\n    };\n  };\n};\n"]}

package/dist/cjs/utils/cli/build.js

@@ -10,26 +10,9 @@ const child_process_1 = require("child_process");
 const fs_helpers_1 = require("../helpers/fs.helpers");
 const dotenv_helpers_1 = require("../dotenv.helpers");
 const cli_helpers_1 = require("./utils/cli.helpers");
+const shared_1 = require("@arkos/shared");
 const BUILD_DIR = ".build";
 const MODULE_TYPES = ["cjs", "esm"];
-function detectPackageManagerFromUserAgent() {
-    const userAgent = process.env.npm_config_user_agent || "";
-    if (userAgent.includes("pnpm"))
-        return "pnpm";
-    if (userAgent.includes("yarn"))
-        return "yarn";
-    if (userAgent.includes("npm"))
-        return "npm";
-    if (userAgent.includes("bun"))
-        return "bun";
-    if (userAgent.includes("cnpm"))
-        return "cnpm";
-    if (userAgent.includes("corepack"))
-        return "corepack";
-    if (userAgent.includes("deno"))
-        return "deno";
-    return "npm";
-}
 function buildCommand(options = {}) {
     const fileExt = (0, fs_helpers_1.getUserFileExtension)();
     process.env.NODE_ENV = "production";
@@ -49,7 +32,7 @@ function buildCommand(options = {}) {
         else {
             buildJavaScriptProject(options, moduleType);
         }
-        const packageManger = detectPackageManagerFromUserAgent();
+        const packageManger = (0, shared_1.detectPackageManagerFromUserAgent)();
         console.info(`\n\x1b[1m\x1b[32m  Build complete!\x1b[0m\n`);
         console.info(`  \x1b[1mNext step:\x1b[0m`);
         console.info(`  Run it using \x1b[1m\x1b[36m${packageManger} run start\x1b[0m\n`);