arkos 1.2.12-test → 1.2.13-beta

package/dist/esm/modules/error-handler/utils/catch-async.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"catch-async.js","sourceRoot":"","sources":["../../../../../src/modules/error-handler/utils/catch-async.ts"],"names":[],"mappings":"AAwBA,MAAM,UAAU,GACd,CAAC,EAAuB,EAAE,EAAE,CAC5B,KAAK,EACH,GAAiB,EACjB,GAAkB,EAClB,IAAuB,EACR,EAAE;IACjB,IAAI,CAAC;QACH,OAAO,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,CAAC,CAAS,CAAC;IAC5C,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,IAAI,CAAC,GAAG,CAAC,CAAC;IACZ,CAAC;AACH,CAAC,CAAC;AAIJ,eAAe,UAAU,CAAC","sourcesContent":["import {\n  ArkosRequest,\n  ArkosResponse,\n  ArkosNextFunction,\n  ArkosRequestHandler,\n} from \"../../../types\";\n\n/**\n * Used to wrap request handlers and middleware for automatic catch async errors and throw to next to invoke the global error handler\n *\n * @param {ArkosRequestHandler} fn - an express request handler or middleware that will be called with req, res, next, with catch attached for error handling\n * @returns\n *\n * @example\n * ```typescript\n * import { ArkosRequest, ArkosResponse, ArkosNextFunction } from 'arkos'\n *\n * export const getManyPosts = catchAsync(async\n * (req: ArkosRequest, res: ArkosResponse, next: ArkosNextFunction) => {\n *    const posts = await getSomePosts()\n *    res.status(200).json({ data: posts })\n * })\n * ```\n */\nconst catchAsync =\n  (fn: ArkosRequestHandler) =>\n  async (\n    req: ArkosRequest,\n    res: ArkosResponse,\n    next: ArkosNextFunction\n  ): Promise<void> => {\n    try {\n      return (await fn(req, res, next)) as void;\n    } catch (err) {\n      next(err);\n    }\n  };\n\nexport type CatchAsyncReturnType = ReturnType<typeof catchAsync>;\n\nexport default catchAsync;\n"]}

package/dist/{es2020 → esm}/modules/error-handler/utils/error-handler.helpers.js

@@ -1,4 +1,4 @@
-import AppError from "./app-error";
+import AppError from "./app-error.js";
 export function handleJWTError() {
     return new AppError("Invalid token. Please log in again!", 401);
 }
@@ -152,4 +152,9 @@ export function handleEmptyResultError(err) {
     const message = `Empty result: No data was found for the given query. Ensure the query criteria are correct.`;
     return new AppError(message, 404);
 }
+export function handleNonExistingRecord(err) {
+    const message = err?.meta?.cause ||
+        `Operation could not be completed as the required record was not found`;
+    return new AppError(message, 404, err.meta || {}, "PrismaRecordNotFound");
+}
 //# sourceMappingURL=error-handler.helpers.js.map

package/dist/esm/modules/error-handler/utils/error-handler.helpers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"error-handler.helpers.js","sourceRoot":"","sources":["../../../../../src/modules/error-handler/utils/error-handler.helpers.ts"],"names":[],"mappings":"AAAA,OAAO,QAAQ,MAAM,aAAa,CAAC;AASnC,MAAM,UAAU,cAAc;IAC5B,OAAO,IAAI,QAAQ,CAAC,qCAAqC,EAAE,GAAG,CAAC,CAAC;AAClE,CAAC;AAED,MAAM,UAAU,gBAAgB;IAC9B,OAAO,IAAI,QAAQ,CAAC,2CAA2C,EAAE,GAAG,CAAC,CAAC;AACxE,CAAC;AAED,MAAM,UAAU,iCAAiC,CAAC,GAAa;IAC7D,MAAM,OAAO,GAAG,GAAG,EAAE,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IAC9E,OAAO,IAAI,QAAQ,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;AACpC,CAAC;AAED,MAAM,UAAU,yBAAyB,CAAC,GAAa;IACrD,MAAM,OAAO,GACX,mFAAmF,CAAC;IACtF,OAAO,IAAI,QAAQ,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;AACpC,CAAC;AAED,MAAM,UAAU,6BAA6B,CAAC,GAAa;IACzD,MAAM,OAAO,GACX,qGAAqG,CAAC;IACxG,OAAO,IAAI,QAAQ,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;AACpC,CAAC;AAED,MAAM,UAAU,4BAA4B,CAAC,GAAa;IACxD,MAAM,OAAO,GACX,gGAAgG,CAAC;IACnG,OAAO,IAAI,QAAQ,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;AACpC,CAAC;AAED,MAAM,UAAU,2BAA2B,CAAC,GAAa;IACvD,MAAM,OAAO,GAAG,sDAAsD,CAAC;IACvE,OAAO,IAAI,QAAQ,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;AACpC,CAAC;AAED,MAAM,UAAU,8BAA8B,CAAC,GAAa;IAC1D,MAAM,WAAW,GAAG,GAAG,EAAE,OAAO,IAAI,+BAA+B,CAAC;IACpE,MAAM,OAAO,GAAG,6CAA6C,WAAW,oCAAoC,CAAC;IAC7G,OAAO,IAAI,QAAQ,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;AACpC,CAAC;AAED,MAAM,UAAU,6BAA6B,CAAC,GAAa;IACzD,MAAM,OAAO,GAAG,4BAA4B,GAAG,EAAE,IAAI,EAAE,UAAU,iDAAiD,CAAC;IACnH,OAAO,IAAI,QAAQ,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;AACpC,CAAC;AAED,MAAM,UAAU,yBAAyB,CAAC,GAAa;IACrD,MAAM,OAAO,GACX,+EAA+E,CAAC;IAClF,OAAO,IAAI,QAAQ,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;AACpC,CAAC;AAED,MAAM,UAAU,2BAA2B,CAAC,GAAa;IACvD,MAAM,KAAK,GAAG,GAAG,EAAE,IAAI,EAAE,MAAM,IAAI,eAAe,CAAC;IACnD,MAAM,OAAO,GAAG,qDAAqD,KAAK,iCAAiC,CAAC;IAC5G,OAAO,IAAI,QAAQ,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;AACpC,CAAC;AAED,MAAM,UAAU,+BAA+B,CAAC,GAAa;IAC3D,MAAM,OAAO,GACX,6EAA6E,CAAC;IAChF,OAAO,IAAI,QAAQ,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;AACpC,CAAC;AAED,MAAM,UAAU,2BAA2B,CAAC,GAAa;IACvD,MAAM,UAAU,GAAG,GAAG,EAAE,IAAI,EAAE,UAAU,IAAI,oBAAoB,CAAC;IACjE,MAAM,OAAO,GAAG,0BAA0B,UAAU,0CAA0C,CAAC;IAC/F,OAAO,IAAI,QAAQ,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;AACpC,CAAC;AAED,MAAM,UAAU,4BAA4B,CAAC,GAAa;IACxD,MAAM,SAAS,GAAG,GAAG,EAAE,IAAI,EAAE,UAAU,IAAI,eAAe,CAAC;IAC3D,MAAM,OAAO,GAAG,yCAAyC,SAAS,kCAAkC,CAAC;IACrG,OAAO,IAAI,QAAQ,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;AACpC,CAAC;AAED,MAAM,UAAU,+BAA+B,CAAC,GAAa;IAC3D,MAAM,SAAS,GAAG,GAAG,EAAE,IAAI,EAAE,UAAU,IAAI,eAAe,CAAC;IAC3D,MAAM,OAAO,GAAG,cAAc,SAAS,0EAA0E,CAAC;IAClH,OAAO,IAAI,QAAQ,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;AACpC,CAAC;AAED,MAAM,UAAU,yBAAyB,CAAC,GAAa;IACrD,MAAM,OAAO,GACX,sFAAsF,CAAC;IACzF,OAAO,IAAI,QAAQ,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;AACpC,CAAC;AAED,MAAM,UAAU,uBAAuB,CAAC,GAAa;IACnD,MAAM,KAAK,GAAG,GAAG,EAAE,IAAI,EAAE,KAAK,IAAI,eAAe,CAAC;IAClD,MAAM,OAAO,GAAG,+BAA+B,KAAK,oCAAoC,CAAC;IACzF,OAAO,IAAI,QAAQ,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;AACpC,CAAC;AAED,MAAM,UAAU,6BAA6B,CAAC,GAAa;IACzD,MAAM,KAAK,GAAG,GAAG,EAAE,IAAI,EAAE,KAAK,IAAI,eAAe,CAAC;IAClD,MAAM,OAAO,GAAG,iCAAiC,KAAK,qDAAqD,CAAC;IAC5G,OAAO,IAAI,QAAQ,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;AACpC,CAAC;AAED,MAAM,UAAU,4BAA4B,CAAC,GAAa;IACxD,MAAM,OAAO,GACX,wFAAwF,CAAC;IAC3F,OAAO,IAAI,QAAQ,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;AACpC,CAAC;AAED,MAAM,UAAU,kCAAkC,CAAC,GAAa;IAC9D,MAAM,SAAS,GAAG,GAAG,EAAE,IAAI,EAAE,UAAU,IAAI,eAAe,CAAC;IAC3D,MAAM,OAAO,GAAG,cAAc,SAAS,2CAA2C,CAAC;IACnF,OAAO,IAAI,QAAQ,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;AACpC,CAAC;AAED,MAAM,UAAU,+BAA+B,CAAC,GAAa;IAC3D,MAAM,OAAO,GACX,mFAAmF,CAAC;IACtF,OAAO,IAAI,QAAQ,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;AACpC,CAAC;AAED,MAAM,UAAU,kCAAkC,CAAC,GAAa;IAC9D,MAAM,aAAa,GAAG,GAAG,EAAE,IAAI,EAAE,SAAS,IAAI,mBAAmB,CAAC;IAClE,MAAM,OAAO,GAAG,kBAAkB,aAAa,6CAA6C,CAAC;IAC7F,OAAO,IAAI,QAAQ,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;AACpC,CAAC;AAED,MAAM,UAAU,gCAAgC,CAAC,GAAa;IAC5D,MAAM,aAAa,GAAG,GAAG,EAAE,IAAI,EAAE,SAAS,IAAI,mBAAmB,CAAC;IAClE,MAAM,OAAO,GAAG,yBAAyB,aAAa,qDAAqD,CAAC;IAC5G,OAAO,IAAI,QAAQ,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;AACpC,CAAC;AAED,MAAM,UAAU,0BAA0B,CAAC,GAAa;IACtD,MAAM,OAAO,GAAG,qHAAqH,CAAC;IACtI,OAAO,IAAI,QAAQ,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;AACpC,CAAC;AAED,MAAM,UAAU,4BAA4B,CAAC,GAAa;IACxD,MAAM,aAAa,GAAG,GAAG,EAAE,IAAI,EAAE,cAAc,IAAI,cAAc,CAAC;IAClE,MAAM,OAAO,GAAG,sCAAsC,aAAa,8CAA8C,CAAC;IAClH,OAAO,IAAI,QAAQ,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;AACpC,CAAC;AAED,MAAM,UAAU,sBAAsB,CAAC,GAAa;IAClD,MAAM,OAAO,GAAG,uHAAuH,CAAC;IACxI,OAAO,IAAI,QAAQ,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;AACpC,CAAC;AAED,MAAM,UAAU,uBAAuB,CAAC,GAAa;IACnD,MAAM,OAAO,GAAG,sGAAsG,CAAC;IACvH,OAAO,IAAI,QAAQ,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;AACpC,CAAC;AAED,MAAM,UAAU,qBAAqB,CAAC,GAAa;IACjD,MAAM,OAAO,GAAG,oEAAoE,CAAC;IACrF,OAAO,IAAI,QAAQ,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;AACpC,CAAC;AAED,MAAM,UAAU,uBAAuB,CAAC,GAAa;IACnD,MAAM,OAAO,GAAG,yFAAyF,CAAC;IAC1G,OAAO,IAAI,QAAQ,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;AACpC,CAAC;AAED,MAAM,UAAU,0BAA0B,CAAC,GAAa;IACtD,MAAM,QAAQ,GAAG,GAAG,EAAE,IAAI,EAAE,QAAQ,IAAI,kBAAkB,CAAC;IAC3D,MAAM,OAAO,GAAG,2BAA2B,QAAQ,8DAA8D,CAAC;IAClH,OAAO,IAAI,QAAQ,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;AACpC,CAAC;AAED,MAAM,UAAU,iBAAiB,CAAC,GAAa;IAC7C,MAAM,UAAU,GAAG,GAAG,EAAE,IAAI,EAAE,MAAM,IAAI,gBAAgB,CAAC;IACzD,MAAM,OAAO,GAAG,6BAA6B,UAAU,4DAA4D,CAAC;IACpH,OAAO,IAAI,QAAQ,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;AACpC,CAAC;AAED,MAAM,UAAU,kBAAkB,CAAC,GAAa;IAC9C,MAAM,OAAO,GAAG,qGAAqG,CAAC;IACtH,OAAO,IAAI,QAAQ,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;AACpC,CAAC;AAED,MAAM,UAAU,2BAA2B,CAAC,GAAa;IACvD,MAAM,OAAO,GAAG,iGAAiG,CAAC;IAClH,OAAO,IAAI,QAAQ,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;AACpC,CAAC;AAED,MAAM,UAAU,mBAAmB,CAAC,GAAa;IAC/C,MAAM,KAAK,GAAG,GAAG,EAAE,IAAI,EAAE,KAAK,IAAI,eAAe,CAAC;IAClD,MAAM,YAAY,GAAG,GAAG,EAAE,IAAI,EAAE,aAAa,IAAI,cAAc,CAAC;IAChE,MAAM,OAAO,GAAG,gCAAgC,KAAK,qBAAqB,YAAY,GAAG,CAAC;IAC1F,OAAO,IAAI,QAAQ,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;AACpC,CAAC;AAED,MAAM,UAAU,sBAAsB,CAAC,GAAa;IAClD,MAAM,OAAO,GAAG,6FAA6F,CAAC;IAC9G,OAAO,IAAI,QAAQ,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;AACpC,CAAC;AAED,MAAM,UAAU,uBAAuB,CAAC,GAGvC;IACC,MAAM,OAAO,GACX,GAAG,EAAE,IAAI,EAAE,KAAK;QAChB,uEAAuE,CAAC;IAC1E,OAAO,IAAI,QAAQ,CAAC,OAAO,EAAE,GAAG,EAAE,GAAG,CAAC,IAAI,IAAI,EAAE,EAAE,sBAAsB,CAAC,CAAC;AAC5E,CAAC","sourcesContent":["import AppError from \"./app-error\";\n\nexport interface PrismaError {\n  code?: string; // Prisma-specific error code\n  message: string; // Error message\n  meta?: Record<string, any>; // Metadata provided by Prisma\n  name?: string; // Error name\n}\n\nexport function handleJWTError() {\n  return new AppError(\"Invalid token. Please log in again!\", 401);\n}\n\nexport function handleJWTExpired() {\n  return new AppError(\"Your token has expired, Please log again!\", 401);\n}\n\nexport function handlePrismaClientValidationError(err: AppError) {\n  const message = err?.message.split(\"\\n\")[err?.message.split(\"\\n\").length - 1];\n  return new AppError(message, 400);\n}\n\nexport function handleAuthenticationError(err: AppError) {\n  const message =\n    \"Authentication failed against the database server. Please check your credentials.\";\n  return new AppError(message, 401);\n}\n\nexport function handleServerNotReachableError(err: AppError) {\n  const message =\n    \"The database server is not reachable. Verify your connection string or ensure the server is online.\";\n  return new AppError(message, 503);\n}\n\nexport function handleConnectionTimeoutError(err: AppError) {\n  const message =\n    \"Connection to the database timed out. Please check server performance or network connectivity.\";\n  return new AppError(message, 504);\n}\n\nexport function handleDatabaseNotFoundError(err: AppError) {\n  const message = \"The specified database does not exist on the server.\";\n  return new AppError(message, 404);\n}\n\nexport function handleEnvironmentVariableError(err: AppError) {\n  const missingVars = err?.missing || \"unknown environment variables\";\n  const message = `Missing or invalid environment variables: ${missingVars}. Please check your configuration.`;\n  return new AppError(message, 500);\n}\n\nexport function handleFieldValueTooLargeError(err: AppError) {\n  const message = `The value for the field \"${err?.meta?.field_name}\" is too large. Please provide a smaller value.`;\n  return new AppError(message, 400);\n}\n\nexport function handleRecordNotFoundError(err: AppError) {\n  const message =\n    \"No record found for the given query. Ensure the query parameters are correct.\";\n  return new AppError(message, 404);\n}\n\nexport function handleUniqueConstraintError(err: AppError) {\n  const field = err?.meta?.target || \"unknown field\";\n  const message = `Duplicate value detected for the unique field(s): ${field}. Please use a different value.`;\n  return new AppError(message, 409);\n}\n\nexport function handleForeignKeyConstraintError(err: AppError) {\n  const message =\n    \"Foreign key constraint violation. Ensure that the referenced record exists.\";\n  return new AppError(message, 400);\n}\n\nexport function handleConstraintFailedError(err: AppError) {\n  const constraint = err?.meta?.constraint || \"unknown constraint\";\n  const message = `A database constraint \"${constraint}\" failed. Please review your input data.`;\n  return new AppError(message, 400);\n}\n\nexport function handleInvalidFieldValueError(err: AppError) {\n  const fieldName = err?.meta?.field_name || \"unknown field\";\n  const message = `Invalid value provided for the field \"${fieldName}\". Please provide a valid value.`;\n  return new AppError(message, 400);\n}\n\nexport function handleInvalidFieldProvidedError(err: AppError) {\n  const fieldName = err?.meta?.field_name || \"unknown field\";\n  const message = `The field \"${fieldName}\" has been provided with an invalid value. Check the data and try again.`;\n  return new AppError(message, 400);\n}\n\nexport function handleDataValidationError(err: AppError) {\n  const message =\n    \"Data validation error occurred. Please ensure all fields meet the required criteria.\";\n  return new AppError(message, 400);\n}\n\nexport function handleQueryParsingError(err: AppError) {\n  const query = err?.meta?.query || \"unknown query\";\n  const message = `Failed to parse the query: \"${query}\". Check the syntax and structure.`;\n  return new AppError(message, 400);\n}\n\nexport function handleInvalidQueryFormatError(err: AppError) {\n  const query = err?.meta?.query || \"unknown query\";\n  const message = `The query format is invalid: \"${query}\". Ensure the query adheres to the expected format.`;\n  return new AppError(message, 400);\n}\n\nexport function handleRawQueryExecutionError(err: AppError) {\n  const message =\n    \"An error occurred during the execution of a raw query. Verify the query and try again.\";\n  return new AppError(message, 500);\n}\n\nexport function handleNullConstraintViolationError(err: AppError) {\n  const fieldName = err?.meta?.field_name || \"unknown field\";\n  const message = `The field \"${fieldName}\" cannot be null. Please provide a value.`;\n  return new AppError(message, 400);\n}\n\nexport function handleSchemaCreationFailedError(err: AppError) {\n  const message =\n    \"Failed to create the database schema. Verify the schema definition and try again.\";\n  return new AppError(message, 500);\n}\n\nexport function handleMigrationAlreadyAppliedError(err: AppError) {\n  const migrationName = err?.meta?.migration || \"unknown migration\";\n  const message = `The migration \"${migrationName}\" has already been applied to the database.`;\n  return new AppError(message, 409);\n}\n\nexport function handleMigrationScriptFailedError(err: AppError) {\n  const migrationName = err?.meta?.migration || \"unknown migration\";\n  const message = `The migration script \"${migrationName}\" failed. Review the script and resolve any issues.`;\n  return new AppError(message, 500);\n}\n\nexport function handleVersionMismatchError(err: AppError) {\n  const message = `Version mismatch: The database schema and migration versions are inconsistent. Please check and resolve this issue.`;\n  return new AppError(message, 400);\n}\n\nexport function handleMigrationFileReadError(err: AppError) {\n  const migrationFile = err?.meta?.migration_file || \"unknown file\";\n  const message = `Failed to read the migration file \"${migrationFile}\". Ensure the file exists and is accessible.`;\n  return new AppError(message, 500);\n}\n\nexport function handleSchemaDriftError(err: AppError) {\n  const message = `Schema drift detected: The database schema differs from the expected state. Run migrations or sync schema to resolve.`;\n  return new AppError(message, 400);\n}\n\nexport function handleSchemaSyntaxError(err: AppError) {\n  const message = `Syntax error in the schema file. Please check for typos or invalid syntax in your schema definition.`;\n  return new AppError(message, 500);\n}\n\nexport function handleClientTypeError(err: AppError) {\n  const message = `Type error, Ensure proper usage of methods and correct data types.`;\n  return new AppError(message, 400);\n}\n\nexport function handleDynamicQueryError(err: AppError) {\n  const message = `Error constructing or executing a dynamic query. Verify query structure and parameters.`;\n  return new AppError(message, 400);\n}\n\nexport function handleRelationLoadingError(err: AppError) {\n  const relation = err?.meta?.relation || \"unknown relation\";\n  const message = `Error loading relation \"${relation}\". Ensure it is correctly defined and included in the query.`;\n  return new AppError(message, 400);\n}\n\nexport function handleBinaryError(err: AppError) {\n  const binaryName = err?.meta?.binary || \"unknown binary\";\n  const message = `Error with Prisma binary \"${binaryName}\". Ensure the binary is properly installed and compatible.`;\n  return new AppError(message, 500);\n}\n\nexport function handleNetworkError(err: AppError) {\n  const message = `Network error: Unable to connect to the database or internet. Please check your network connection.`;\n  return new AppError(message, 500);\n}\n\nexport function handleUnhandledPromiseError(err: AppError) {\n  const message = `Unhandled promise rejection detected. Please check asynchronous code for proper error handling.`;\n  return new AppError(message, 500);\n}\n\nexport function handleDataTypeError(err: AppError) {\n  const field = err?.meta?.field || \"unknown field\";\n  const expectedType = err?.meta?.expected_type || \"unknown type\";\n  const message = `Invalid data type for field \"${field}\". Expected type: ${expectedType}.`;\n  return new AppError(message, 400);\n}\n\nexport function handleEmptyResultError(err: AppError) {\n  const message = `Empty result: No data was found for the given query. Ensure the query criteria are correct.`;\n  return new AppError(message, 404);\n}\n\nexport function handleNonExistingRecord(err: {\n  meta?: Record<string, any>;\n  [x: string]: any;\n}) {\n  const message =\n    err?.meta?.cause ||\n    `Operation could not be completed as the required record was not found`;\n  return new AppError(message, 404, err.meta || {}, \"PrismaRecordNotFound\");\n}\n"]}

package/dist/{es2020 → esm}/modules/file-upload/file-upload.controller.js

@@ -1,12 +1,12 @@
-import AppError from "../error-handler/utils/app-error";
-import { getFileUploadServices, } from "./file-upload.service";
+import AppError from "../error-handler/utils/app-error.js";
+import { getFileUploadServices, } from "./file-upload.service.js";
 import path from "path";
 import fs from "fs";
-import catchAsync from "../error-handler/utils/catch-async";
-import { getArkosConfig } from "../../server";
-import { processFile, processImage } from "./utils/helpers/file-upload.helpers";
-import { accessAsync, mkdirAsync, statAsync, } from "../../utils/helpers/fs.helpers";
-import { getModelModules } from "../../utils/helpers/models.helpers";
+import catchAsync from "../error-handler/utils/catch-async.js";
+import { getArkosConfig } from "../../server.js";
+import { processFile, processImage } from "./utils/helpers/file-upload.helpers.js";
+import { accessAsync, mkdirAsync, statAsync, } from "../../utils/helpers/fs.helpers.js";
+import { getModelModules } from "../../utils/helpers/models.helpers.js";
 class FileUploadController {
     constructor() {
         this.uploadFile = catchAsync(async (req, res, next) => {

package/dist/esm/modules/file-upload/file-upload.router.js

@@ -0,0 +1,38 @@
+import { Router } from "express";
+import { importPrismaModelModules } from "../../utils/helpers/models.helpers.js";
+import authService from "../auth/auth.service.js";
+import fileUploadController from "./file-upload.controller.js";
+import path from "path";
+import express from "express";
+import deepmerge from "../../utils/helpers/deepmerge.helper.js";
+import { sendResponse } from "../base/base.middlewares.js";
+import { processMiddleware } from "../../utils/helpers/routers.helpers.js";
+import { adjustRequestUrl } from "./utils/helpers/file-upload.helpers.js";
+const router = Router();
+export async function getFileUploadRouter(arkosConfig) {
+    const { fileUpload } = arkosConfig;
+    const modelModules = await importPrismaModelModules("file-upload", arkosConfig);
+    let { middlewares = {}, authConfigs = {} } = {};
+    if (modelModules) {
+        ({ middlewares = {}, authConfigs = {} } = modelModules);
+    }
+    let basePathname = fileUpload?.baseRoute || "/api/uploads/";
+    if (!basePathname.startsWith("/"))
+        basePathname = "/" + basePathname;
+    if (!basePathname.endsWith("/"))
+        basePathname = basePathname + "/";
+    router.get(`${basePathname}*`, authService.handleAuthenticationControl("View", authConfigs.authenticationControl), authService.handleAccessControl("View", "file-upload", authConfigs.accessControl), ...processMiddleware(middlewares?.beforeFindFile), adjustRequestUrl, express.static(path.resolve(process.cwd(), fileUpload?.baseUploadDir || "uploads"), deepmerge({
+        maxAge: "1y",
+        etag: true,
+        lastModified: true,
+        dotfiles: "ignore",
+        fallthrough: true,
+        index: false,
+        cacheControl: true,
+    }, fileUpload?.expressStaticOptions || {})));
+    router.post(`${basePathname}:fileType`, authService.handleAuthenticationControl("Create", authConfigs.authenticationControl), authService.handleAccessControl("Create", "file-upload", authConfigs.accessControl), ...processMiddleware(middlewares?.beforeUploadFile), fileUploadController.uploadFile, ...processMiddleware(middlewares?.afterUploadFile), sendResponse);
+    router.patch(`${basePathname}:fileType/:fileName`, authService.handleAuthenticationControl("Update", authConfigs.authenticationControl), authService.handleAccessControl("Update", "file-upload", authConfigs.accessControl), ...processMiddleware(middlewares?.beforeUpdateFile), fileUploadController.updateFile, ...processMiddleware(middlewares?.afterUpdateFile), sendResponse);
+    router.delete(`${basePathname}:fileType/:fileName`, authService.handleAuthenticationControl("Delete", authConfigs.authenticationControl), authService.handleAccessControl("Delete", "file-upload", authConfigs.accessControl), ...processMiddleware(middlewares?.beforeDeleteFile), fileUploadController.deleteFile, ...processMiddleware(middlewares?.afterDeleteFile), sendResponse);
+    return router;
+}
+//# sourceMappingURL=file-upload.router.js.map

package/dist/esm/modules/file-upload/file-upload.router.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"file-upload.router.js","sourceRoot":"","sources":["../../../../src/modules/file-upload/file-upload.router.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AACjC,OAAO,EAAE,wBAAwB,EAAE,MAAM,oCAAoC,CAAC;AAC9E,OAAO,WAAW,MAAM,sBAAsB,CAAC;AAC/C,OAAO,oBAAoB,MAAM,0BAA0B,CAAC;AAE5D,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,OAAO,MAAM,SAAS,CAAC;AAC9B,OAAO,SAAS,MAAM,sCAAsC,CAAC;AAE7D,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AACxD,OAAO,EAAE,iBAAiB,EAAE,MAAM,qCAAqC,CAAC;AACxE,OAAO,EAAE,gBAAgB,EAAE,MAAM,qCAAqC,CAAC;AAEvE,MAAM,MAAM,GAAW,MAAM,EAAE,CAAC;AAEhC,MAAM,CAAC,KAAK,UAAU,mBAAmB,CAAC,WAAwB;IAChE,MAAM,EAAE,UAAU,EAAE,GAAG,WAAW,CAAC;IAEnC,MAAM,YAAY,GAAG,MAAM,wBAAwB,CACjD,aAAa,EACb,WAAW,CACZ,CAAC;IACF,IAAI,EAAE,WAAW,GAAG,EAAS,EAAE,WAAW,GAAG,EAAiB,EAAE,GAAG,EAAE,CAAC;IAEtE,IAAI,YAAY,EAAE,CAAC;QACjB,CAAC,EAAE,WAAW,GAAG,EAAE,EAAE,WAAW,GAAG,EAAE,EAAE,GAAG,YAAY,CAAC,CAAC;IAC1D,CAAC;IAED,IAAI,YAAY,GAAG,UAAU,EAAE,SAAS,IAAI,eAAe,CAAC;IAE5D,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,GAAG,CAAC;QAAE,YAAY,GAAG,GAAG,GAAG,YAAY,CAAC;IACrE,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,GAAG,CAAC;QAAE,YAAY,GAAG,YAAY,GAAG,GAAG,CAAC;IAGnE,MAAM,CAAC,GAAG,CACR,GAAG,YAAY,GAAG,EAClB,WAAW,CAAC,2BAA2B,CACrC,MAAM,EACN,WAAW,CAAC,qBAAqB,CAClC,EACD,WAAW,CAAC,mBAAmB,CAC7B,MAAM,EACN,aAAa,EACb,WAAW,CAAC,aAAa,CAC1B,EACD,GAAG,iBAAiB,CAAC,WAAW,EAAE,cAAc,CAAC,EACjD,gBAAgB,EAChB,OAAO,CAAC,MAAM,CACZ,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,UAAU,EAAE,aAAa,IAAI,SAAS,CAAC,EACnE,SAAS,CACP;QACE,MAAM,EAAE,IAAI;QACZ,IAAI,EAAE,IAAI;QACV,YAAY,EAAE,IAAI;QAClB,QAAQ,EAAE,QAAQ;QAClB,WAAW,EAAE,IAAI;QACjB,KAAK,EAAE,KAAK;QACZ,YAAY,EAAE,IAAI;KACnB,EACD,UAAU,EAAE,oBAAoB,IAAI,EAAE,CACvC,CACF,CACF,CAAC;IAGF,MAAM,CAAC,IAAI,CACT,GAAG,YAAY,WAAW,EAC1B,WAAW,CAAC,2BAA2B,CACrC,QAAQ,EACR,WAAW,CAAC,qBAAqB,CAClC,EACD,WAAW,CAAC,mBAAmB,CAC7B,QAAQ,EACR,aAAa,EACb,WAAW,CAAC,aAAa,CAC1B,EACD,GAAG,iBAAiB,CAAC,WAAW,EAAE,gBAAgB,CAAC,EACnD,oBAAoB,CAAC,UAAU,EAC/B,GAAG,iBAAiB,CAAC,WAAW,EAAE,eAAe,CAAC,EAClD,YAAY,CACb,CAAC;IAGF,MAAM,CAAC,KAAK,CACV,GAAG,YAAY,qBAAqB,EACpC,WAAW,CAAC,2BAA2B,CACrC,QAAQ,EACR,WAAW,CAAC,qBAAqB,CAClC,EACD,WAAW,CAAC,mBAAmB,CAC7B,QAAQ,EACR,aAAa,EACb,WAAW,CAAC,aAAa,CAC1B,EACD,GAAG,iBAAiB,CAAC,WAAW,EAAE,gBAAgB,CAAC,EACnD,oBAAoB,CAAC,UAAU,EAC/B,GAAG,iBAAiB,CAAC,WAAW,EAAE,eAAe,CAAC,EAClD,YAAY,CACb,CAAC;IAGF,MAAM,CAAC,MAAM,CACX,GAAG,YAAY,qBAAqB,EACpC,WAAW,CAAC,2BAA2B,CACrC,QAAQ,EACR,WAAW,CAAC,qBAAqB,CAClC,EACD,WAAW,CAAC,mBAAmB,CAC7B,QAAQ,EACR,aAAa,EACb,WAAW,CAAC,aAAa,CAC1B,EACD,GAAG,iBAAiB,CAAC,WAAW,EAAE,gBAAgB,CAAC,EACnD,oBAAoB,CAAC,UAAU,EAC/B,GAAG,iBAAiB,CAAC,WAAW,EAAE,eAAe,CAAC,EAClD,YAAY,CACb,CAAC;IAEF,OAAO,MAAM,CAAC;AAChB,CAAC","sourcesContent":["import { Router } from \"express\";\nimport { importPrismaModelModules } from \"../../utils/helpers/models.helpers\";\nimport authService from \"../auth/auth.service\";\nimport fileUploadController from \"./file-upload.controller\";\nimport { ArkosConfig } from \"../../types/arkos-config\";\nimport path from \"path\";\nimport express from \"express\";\nimport deepmerge from \"../../utils/helpers/deepmerge.helper\";\nimport { AuthConfigs } from \"../../types/auth\";\nimport { sendResponse } from \"../base/base.middlewares\";\nimport { processMiddleware } from \"../../utils/helpers/routers.helpers\";\nimport { adjustRequestUrl } from \"./utils/helpers/file-upload.helpers\";\n\nconst router: Router = Router();\n\nexport async function getFileUploadRouter(arkosConfig: ArkosConfig) {\n  const { fileUpload } = arkosConfig;\n\n  const modelModules = await importPrismaModelModules(\n    \"file-upload\",\n    arkosConfig\n  );\n  let { middlewares = {} as any, authConfigs = {} as AuthConfigs } = {};\n\n  if (modelModules) {\n    ({ middlewares = {}, authConfigs = {} } = modelModules);\n  }\n\n  let basePathname = fileUpload?.baseRoute || \"/api/uploads/\";\n\n  if (!basePathname.startsWith(\"/\")) basePathname = \"/\" + basePathname;\n  if (!basePathname.endsWith(\"/\")) basePathname = basePathname + \"/\";\n\n  // Static file serving route\n  router.get(\n    `${basePathname}*`,\n    authService.handleAuthenticationControl(\n      \"View\",\n      authConfigs.authenticationControl\n    ),\n    authService.handleAccessControl(\n      \"View\",\n      \"file-upload\",\n      authConfigs.accessControl\n    ),\n    ...processMiddleware(middlewares?.beforeFindFile),\n    adjustRequestUrl,\n    express.static(\n      path.resolve(process.cwd(), fileUpload?.baseUploadDir || \"uploads\"),\n      deepmerge(\n        {\n          maxAge: \"1y\",\n          etag: true,\n          lastModified: true,\n          dotfiles: \"ignore\",\n          fallthrough: true,\n          index: false,\n          cacheControl: true,\n        },\n        fileUpload?.expressStaticOptions || {}\n      )\n    )\n  );\n\n  // POST /{basePathname}:fileType - Upload File\n  router.post(\n    `${basePathname}:fileType`,\n    authService.handleAuthenticationControl(\n      \"Create\",\n      authConfigs.authenticationControl\n    ),\n    authService.handleAccessControl(\n      \"Create\",\n      \"file-upload\",\n      authConfigs.accessControl\n    ),\n    ...processMiddleware(middlewares?.beforeUploadFile),\n    fileUploadController.uploadFile,\n    ...processMiddleware(middlewares?.afterUploadFile),\n    sendResponse\n  );\n\n  // PATCH /{basePathname}:fileType/:fileName - Update File\n  router.patch(\n    `${basePathname}:fileType/:fileName`,\n    authService.handleAuthenticationControl(\n      \"Update\",\n      authConfigs.authenticationControl\n    ),\n    authService.handleAccessControl(\n      \"Update\",\n      \"file-upload\",\n      authConfigs.accessControl\n    ),\n    ...processMiddleware(middlewares?.beforeUpdateFile),\n    fileUploadController.updateFile,\n    ...processMiddleware(middlewares?.afterUpdateFile),\n    sendResponse\n  );\n\n  // DELETE /{basePathname}:fileType/:fileName - Delete File\n  router.delete(\n    `${basePathname}:fileType/:fileName`,\n    authService.handleAuthenticationControl(\n      \"Delete\",\n      authConfigs.authenticationControl\n    ),\n    authService.handleAccessControl(\n      \"Delete\",\n      \"file-upload\",\n      authConfigs.accessControl\n    ),\n    ...processMiddleware(middlewares?.beforeDeleteFile),\n    fileUploadController.deleteFile,\n    ...processMiddleware(middlewares?.afterDeleteFile),\n    sendResponse\n  );\n\n  return router;\n}\n"]}

package/dist/{es2020 → esm}/modules/file-upload/file-upload.service.js

@@ -1,12 +1,12 @@
 import multer from "multer";
 import path from "path";
 import fs from "fs";
-import AppError from "../error-handler/utils/app-error";
+import AppError from "../error-handler/utils/app-error.js";
 import { promisify } from "util";
-import { getArkosConfig } from "../../server";
-import deepmerge from "../../utils/helpers/deepmerge.helper";
-import { processFile, processImage } from "./utils/helpers/file-upload.helpers";
-import { removeBothSlashes } from "../../utils/helpers/text.helpers";
+import { getArkosConfig } from "../../server.js";
+import deepmerge from "../../utils/helpers/deepmerge.helper.js";
+import { processFile, processImage } from "./utils/helpers/file-upload.helpers.js";
+import { removeBothSlashes } from "../../utils/helpers/text.helpers.js";
 export class FileUploadService {
     constructor(uploadDir, fileSizeLimit = 1024 * 1024 * 5, allowedFileTypes = /.*/, maxCount = 30) {
         this.fileFilter = (req, file, cb) => {

package/dist/{es2020 → esm}/modules/file-upload/utils/helpers/file-upload.helpers.js

@@ -2,9 +2,15 @@ import fs from "fs";
 import path from "path";
 import sharp from "sharp";
 import { promisify } from "util";
-import { getArkosConfig } from "../../../../server";
+import { getArkosConfig } from "../../../../server.js";
 import mimetype from "mimetype";
-import { fullCleanCwd } from "../../../../utils/helpers/fs.helpers";
+import { fullCleanCwd } from "../../../../utils/helpers/fs.helpers.js";
+export function adjustRequestUrl(req, _, next) {
+    const { fileUpload } = getArkosConfig();
+    req.url = req.url.replace(fileUpload?.baseRoute + "/" || "/api/uploads/", "/");
+    req.url = req.url.replace(fileUpload?.baseRoute || "/api/uploads/", "/");
+    next();
+}
 export function extractRequestInfo(req) {
     const { fileUpload } = getArkosConfig();
     const protocol = req.headers["x-forwarded-proto"] === "https" ? "https" : "http";

package/dist/esm/modules/file-upload/utils/helpers/file-upload.helpers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"file-upload.helpers.js","sourceRoot":"","sources":["../../../../../../src/modules/file-upload/utils/helpers/file-upload.helpers.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,IAAI,CAAC;AACpB,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,SAAS,EAAE,MAAM,MAAM,CAAC;AACjC,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AACpD,OAAO,QAAQ,MAAM,UAAU,CAAC;AAMhC,OAAO,EAAE,YAAY,EAAE,MAAM,sCAAsC,CAAC;AAEpE,MAAM,UAAU,gBAAgB,CAC9B,GAAiB,EACjB,CAAgB,EAChB,IAAuB;IAEvB,MAAM,EAAE,UAAU,EAAE,GAAG,cAAc,EAAE,CAAC;IACxC,GAAG,CAAC,GAAG,GAAG,GAAG,CAAC,GAAG,CAAC,OAAO,CACvB,UAAU,EAAE,SAAS,GAAG,GAAG,IAAI,eAAe,EAC9C,GAAG,CACJ,CAAC;IACF,GAAG,CAAC,GAAG,GAAG,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,UAAU,EAAE,SAAS,IAAI,eAAe,EAAE,GAAG,CAAC,CAAC;IACzE,IAAI,EAAE,CAAC;AACT,CAAC;AAED,MAAM,UAAU,kBAAkB,CAAC,GAAiB;IAClD,MAAM,EAAE,UAAU,EAAE,GAAG,cAAc,EAAE,CAAC;IAGxC,MAAM,QAAQ,GACZ,GAAG,CAAC,OAAO,CAAC,mBAAmB,CAAC,KAAK,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC;IAClE,MAAM,OAAO,GAAG,GAAG,QAAQ,MAAM,GAAG,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC;IACrD,MAAM,SAAS,GAAG,UAAU,EAAE,SAAS,IAAI,cAAc,CAAC;IAC1D,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC;AAChC,CAAC;AAKD,MAAM,oBAAoB,GAAG,CAAC,QAAgB,EAAE,QAAgB,EAAE,EAAE;IAClE,MAAM,EAAE,UAAU,EAAE,GAAG,cAAc,EAAE,CAAC;IAExC,MAAM,aAAa,GAAG,UAAU,EAAE,aAAa,IAAI,UAAU,CAAC;IAC9D,IAAI,aAAa,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;QAEnC,OAAO,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC;IACtD,CAAC;SAAM,CAAC;QAEN,OAAO,YAAY,CACjB,QAAQ;aACL,OAAO,CAAC,GAAG,aAAa,GAAG,EAAE,EAAE,CAAC;aAChC,OAAO,CAAC,IAAI,aAAa,GAAG,EAAE,EAAE,CAAC;aACjC,OAAO,CAAC,IAAI,aAAa,EAAE,EAAE,EAAE,CAAC;aAChC,OAAO,CAAC,GAAG,aAAa,EAAE,EAAE,EAAE,CAAC,CACnC,CAAC;IACJ,CAAC;AACH,CAAC,CAAC;AAKF,MAAM,CAAC,MAAM,WAAW,GAAG,KAAK,EAC9B,GAAiB,EACjB,QAAgB,EACC,EAAE;IACnB,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,GAAG,kBAAkB,CAAC,GAAG,CAAC,CAAC;IAEvD,MAAM,YAAY,GAAG,oBAAoB,CAAC,QAAQ,EAAE,GAAG,CAAC,MAAO,CAAC,QAAQ,CAAC,CAAC;IAC1E,OAAO,GAAG,OAAO,GAAG,SAAS,KAAK,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS,IAAI,YAAY,EAAE,CAAC;AAC3E,CAAC,CAAC;AAKF,MAAM,CAAC,MAAM,YAAY,GAAG,KAAK,EAC/B,GAAiB,EACjB,QAAgB,EAChB,OAA4B,EACJ,EAAE;IAC1B,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,GAAG,kBAAkB,CAAC,GAAG,CAAC,CAAC;IAEvD,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,WAAW,EAAE,CAAC;IACjD,MAAM,cAAc,GAAG,GAAG,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;IAC5C,MAAM,YAAY,GAAG,OAAO,CAAC,MAAM,IAAI,cAAc,CAAC;IAEtD,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,QAAQ,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC;QAC/C,MAAM,YAAY,GAAG,oBAAoB,CAAC,QAAQ,EAAE,GAAG,CAAC,MAAO,CAAC,QAAQ,CAAC,CAAC;QAC1E,OAAO,GAAG,OAAO,GAAG,SAAS,IAAI,YAAY,EAAE,CAAC;IAClD,CAAC;IAGD,MAAM,QAAQ,GAAG,GAAG,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,GAAG,CAAC,IAAI,IAAI,CAAC,GAAG,EAAE,GAAG,GAAG,EAAE,CAAC;IACvE,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,QAAQ,CAAC,CAAC;IAE7D,IAAI,CAAC;QACH,IAAI,WAAW,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAC;QAClC,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,QAAQ,EAAE,CAAC;QAG9C,IAAI,OAAO,CAAC,QAAQ,IAAI,QAAQ,CAAC,KAAK,IAAI,QAAQ,CAAC,MAAM,EAAE,CAAC;YAC1D,MAAM,UAAU,GAAG,OAAO,CAAC,QAAQ,CAAC;YACpC,MAAM,WAAW,GACf,UAAU,GAAG,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;YACzD,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,KAAK,GAAG,WAAW,CAAC,CAAC;YAC1D,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,GAAG,WAAW,CAAC,CAAC;YAC5D,WAAW,GAAG,WAAW,CAAC,MAAM,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;QACxD,CAAC;aAAM,IAAI,OAAO,CAAC,KAAK,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;YAC3C,WAAW,GAAG,WAAW,CAAC,MAAM,CAC9B,OAAO,CAAC,KAAK,IAAI,IAAI,EACrB,OAAO,CAAC,MAAM,IAAI,IAAI,EACtB;gBACE,GAAG,EAAE,QAAQ;aACd,CACF,CAAC;QACJ,CAAC;QAGD,IAAI,YAAY,KAAK,MAAM,EAAE,CAAC;YAC5B,WAAW,GAAG,WAAW,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QAC7C,CAAC;aAAM,IAAI,YAAY,KAAK,MAAM,IAAI,YAAY,KAAK,KAAK,EAAE,CAAC;YAC7D,WAAW,GAAG,WAAW,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QAC7C,CAAC;QAGD,MAAM,WAAW,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QAGnC,MAAM,SAAS,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;QAG/C,MAAM,YAAY,GAAG,oBAAoB,CAAC,QAAQ,EAAE,GAAG,EAAE,MAAO,CAAC,QAAQ,CAAC,CAAC;QAE3E,OAAO,GAAG,OAAO,GAAG,SAAS,IAAI,YAAY,EAAE,CAAC;IAClD,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QAEf,IAAI,CAAC;YACH,MAAM,SAAS,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,CAAC;YACnC,MAAM,SAAS,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,QAAQ,CAAC,CAAC;QACvC,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;QAEf,CAAC;QACD,MAAM,KAAK,CAAC;IACd,CAAC;AACH,CAAC,CAAC","sourcesContent":["import fs from \"fs\";\nimport path from \"path\";\nimport sharp from \"sharp\";\nimport { promisify } from \"util\";\nimport { getArkosConfig } from \"../../../../server\";\nimport mimetype from \"mimetype\";\nimport {\n  ArkosNextFunction,\n  ArkosRequest,\n  ArkosResponse,\n} from \"../../../../types\";\nimport { fullCleanCwd } from \"../../../../utils/helpers/fs.helpers\";\n\nexport function adjustRequestUrl(\n  req: ArkosRequest,\n  _: ArkosResponse,\n  next: ArkosNextFunction\n) {\n  const { fileUpload } = getArkosConfig();\n  req.url = req.url.replace(\n    fileUpload?.baseRoute + \"/\" || \"/api/uploads/\",\n    \"/\"\n  );\n  req.url = req.url.replace(fileUpload?.baseRoute || \"/api/uploads/\", \"/\");\n  next();\n}\n\nexport function extractRequestInfo(req: ArkosRequest) {\n  const { fileUpload } = getArkosConfig();\n\n  // Determine the base URL for file access\n  const protocol =\n    req.headers[\"x-forwarded-proto\"] === \"https\" ? \"https\" : \"http\";\n  const baseURL = `${protocol}://${req.get?.(\"host\")}`;\n  const baseRoute = fileUpload?.baseRoute || \"/api/uploads\";\n  return { baseURL, baseRoute };\n}\n\n/**\n * Generates the correct relative path regardless of upload directory location\n */\nconst generateRelativePath = (filePath: string, fileType: string) => {\n  const { fileUpload } = getArkosConfig();\n\n  const baseUploadDir = fileUpload?.baseUploadDir || \"/uploads\";\n  if (baseUploadDir.startsWith(\"..\")) {\n    // For paths outside project directory\n    return path.join(fileType, path.basename(filePath));\n  } else {\n    // For paths within project\n    return fullCleanCwd(\n      filePath\n        .replace(`${baseUploadDir}/`, \"\")\n        .replace(`/${baseUploadDir}/`, \"\")\n        .replace(`/${baseUploadDir}`, \"\")\n        .replace(`${baseUploadDir}`, \"\")\n    );\n  }\n};\n\n/**\n * Handles basic file processing for non-image files\n */\nexport const processFile = async (\n  req: ArkosRequest,\n  filePath: string\n): Promise<string> => {\n  const { baseURL, baseRoute } = extractRequestInfo(req);\n\n  const relativePath = generateRelativePath(filePath, req.params!.fileType);\n  return `${baseURL}${baseRoute === \"/\" ? \"\" : baseRoute}/${relativePath}`;\n};\n\n/**\n * Processes image files using Sharp for resizing and format conversion\n */\nexport const processImage = async (\n  req: ArkosRequest,\n  filePath: string,\n  options: Record<string, any>\n): Promise<string | null> => {\n  const { baseURL, baseRoute } = extractRequestInfo(req);\n\n  const ext = path.extname(filePath).toLowerCase();\n  const originalFormat = ext.replace(\".\", \"\");\n  const outputFormat = options.format || originalFormat;\n\n  if (!mimetype.lookup(ext)?.includes?.(\"image\")) {\n    const relativePath = generateRelativePath(filePath, req.params!.fileType);\n    return `${baseURL}${baseRoute}/${relativePath}`;\n  }\n\n  // Create a temp filename with original name + random string\n  const tempName = `${path.basename(filePath, ext)}_${Date.now()}${ext}`;\n  const tempPath = path.join(path.dirname(filePath), tempName);\n\n  try {\n    let transformer = sharp(filePath);\n    const metadata = await transformer.metadata();\n\n    // Apply resize transformations if requested\n    if (options.resizeTo && metadata.width && metadata.height) {\n      const targetSize = options.resizeTo;\n      const scaleFactor =\n        targetSize / Math.min(metadata.width, metadata.height);\n      const newWidth = Math.round(metadata.width * scaleFactor);\n      const newHeight = Math.round(metadata.height * scaleFactor);\n      transformer = transformer.resize(newWidth, newHeight);\n    } else if (options.width || options.height) {\n      transformer = transformer.resize(\n        options.width || null,\n        options.height || null,\n        {\n          fit: \"inside\",\n        }\n      );\n    }\n\n    // Apply format transformations if requested\n    if (outputFormat === \"webp\") {\n      transformer = transformer.toFormat(\"webp\");\n    } else if (outputFormat === \"jpeg\" || outputFormat === \"jpg\") {\n      transformer = transformer.toFormat(\"jpeg\");\n    }\n\n    // Save to temp file first\n    await transformer.toFile(tempPath);\n\n    // Rename temp file to original filename\n    await promisify(fs.rename)(tempPath, filePath);\n\n    // Return the public URL for the file\n    const relativePath = generateRelativePath(filePath, req?.params!.fileType);\n\n    return `${baseURL}${baseRoute}/${relativePath}`;\n  } catch (error) {\n    // Clean up temp file if it exists\n    try {\n      await promisify(fs.stat)(tempPath);\n      await promisify(fs.unlink)(tempPath);\n    } catch (err) {\n      // If temp file doesn't exist, no need to clean up\n    }\n    throw error;\n  }\n};\n"]}

package/dist/{es2020 → esm}/modules/swagger/swagger.router.js

@@ -1,54 +1,39 @@
 import { Router } from "express";
 import swaggerUi from "swagger-ui-express";
 import swaggerJsdoc from "swagger-jsdoc";
-import deepmerge from "../../utils/helpers/deepmerge.helper";
+import deepmerge from "../../utils/helpers/deepmerge.helper.js";
+import { generatePathsForModels, getOpenAPIJsonSchemasByConfigMode, } from "./utils/helpers/swagger.router.helpers.js";
+import { capitalize } from "../../utils/helpers/text.helpers.js";
 const swaggerRouter = Router();
-function generateSchemasByMode(swaggerConfig) {
-    const schemas = {};
-    switch (swaggerConfig.mode) {
-        case "prisma":
-            break;
-        case "class-validator":
-            break;
-        case "zod":
-            break;
-        case "json-schema":
-        default:
-            break;
-    }
-    return schemas;
-}
-export function getSwaggerRouter(arkosConfig) {
+export async function getSwaggerRouter(arkosConfig) {
+    const defaultJsonSchemas = await getOpenAPIJsonSchemasByConfigMode(arkosConfig.swagger);
+    const defaultModelsPaths = await generatePathsForModels(arkosConfig);
     const defaultSwaggerConfig = {
         endpoint: "/docs",
-        mode: "json-schema",
+        mode: "prisma",
         options: {
             definition: {
                 openapi: "3.0.0",
                 info: {
-                    title: "Generated By Arkos.js",
+                    title: "Powered By Arkos.js",
                     version: "1.0.0",
-                    description: "This API was automatically generated by Arkos.js read more about at www.arkosjs.com",
+                    description: "This API was automatically generated by Arkos.js, read more about at www.arkosjs.com",
                 },
                 servers: [
                     {
                         url: `http://${arkosConfig.host}:${arkosConfig.port}`,
-                        description: "Local server",
+                        description: `Local ${capitalize(process.env.NODE_ENV || "development")} server`,
                     },
                 ],
+                paths: defaultModelsPaths,
                 components: {
-                    schemas: {},
+                    schemas: defaultJsonSchemas || {},
                     securitySchemes: {
                         BearerAuth: {
                             type: "http",
                             scheme: "bearer",
                             bearerFormat: "JWT",
                         },
-                        ApiKeyAuth: {
-                            type: "apiKey",
-                            in: "header",
-                            name: "X-API-Key",
-                        },
                     },
                 },
                 security: [],
@@ -59,10 +44,6 @@ export function getSwaggerRouter(arkosConfig) {
             ],
             swaggerUiOptions: {
                 explorer: true,
-                customCss: `
-          .swagger-ui .topbar { display: none; }
-          .swagger-ui .info { margin: 20px 0; }
-        `,
                 swaggerOptions: {
                     filter: true,
                     displayRequestDuration: true,
@@ -76,11 +57,9 @@ export function getSwaggerRouter(arkosConfig) {
         },
     };
     const swaggerConfigs = deepmerge(defaultSwaggerConfig, arkosConfig.swagger || {});
-    const modeSchemas = generateSchemasByMode(swaggerConfigs);
-    if (swaggerConfigs.options.definition.components?.schemas) {
+    if (swaggerConfigs?.options?.definition?.components?.schemas) {
         swaggerConfigs.options.definition.components.schemas = {
-            ...swaggerConfigs.options.definition.components.schemas,
-            ...modeSchemas,
+            ...swaggerConfigs?.options?.definition?.components.schemas,
         };
     }
     const swaggerSpecification = swaggerJsdoc({
@@ -92,7 +71,7 @@ export function getSwaggerRouter(arkosConfig) {
         explorer: swaggerConfigs.options.swaggerUiOptions?.explorer ?? true,
         customCss: swaggerConfigs.options.swaggerUiOptions?.customCss,
         customSiteTitle: swaggerConfigs.options.swaggerUiOptions?.customSiteTitle ||
-            "API Documentation",
+            "Arkos.js API Documentation",
         customfavIcon: swaggerConfigs.options.swaggerUiOptions?.customfavIcon,
         swaggerOptions: {
             filter: swaggerConfigs.options.swaggerUiOptions?.swaggerOptions?.filter ?? true,
@@ -110,26 +89,6 @@ export function getSwaggerRouter(arkosConfig) {
     };
     swaggerRouter.use(swaggerConfigs.endpoint, swaggerUi.serve);
     swaggerRouter.get(swaggerConfigs.endpoint, swaggerUi.setup(swaggerSpecification, swaggerUiOptions));
-    swaggerRouter.get(`${swaggerConfigs.endpoint}/json`, (req, res) => {
-        res.setHeader("Content-Type", "application/json");
-        res.json(swaggerSpecification);
-    });
-    swaggerRouter.get(`${swaggerConfigs.endpoint}/yaml`, (req, res) => {
-        const yaml = require("js-yaml");
-        res.setHeader("Content-Type", "text/yaml");
-        res.send(yaml.dump(swaggerSpecification));
-    });
-    swaggerRouter.get(`${swaggerConfigs.endpoint}/health`, (req, res) => {
-        res.json({
-            status: "ok",
-            swagger: {
-                version: swaggerConfigs.options.definition.openapi,
-                title: swaggerConfigs.options.definition.info?.title,
-                endpoint: swaggerConfigs.endpoint,
-                mode: swaggerConfigs.mode,
-            },
-        });
-    });
     return swaggerRouter;
 }
 //# sourceMappingURL=swagger.router.js.map

package/dist/esm/modules/swagger/swagger.router.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"swagger.router.js","sourceRoot":"","sources":["../../../../src/modules/swagger/swagger.router.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AACjC,OAAO,SAAS,MAAM,oBAAoB,CAAC;AAC3C,OAAO,YAAY,MAAM,eAAe,CAAC;AAEzC,OAAO,SAAS,MAAM,sCAAsC,CAAC;AAC7D,OAAO,EACL,sBAAsB,EACtB,iCAAiC,GAClC,MAAM,wCAAwC,CAAC;AAChD,OAAO,EAAE,UAAU,EAAE,MAAM,kCAAkC,CAAC;AAE9D,MAAM,aAAa,GAAG,MAAM,EAAE,CAAC;AAE/B,MAAM,CAAC,KAAK,UAAU,gBAAgB,CACpC,WAAwB;IAExB,MAAM,kBAAkB,GAAG,MAAM,iCAAiC,CAChE,WAAW,CAAC,OAAO,CACpB,CAAC;IACF,MAAM,kBAAkB,GAAG,MAAM,sBAAsB,CAAC,WAAW,CAAC,CAAC;IAErE,MAAM,oBAAoB,GAA2B;QACnD,QAAQ,EAAE,OAAO;QACjB,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE;YACP,UAAU,EAAE;gBACV,OAAO,EAAE,OAAO;gBAChB,IAAI,EAAE;oBACJ,KAAK,EAAE,qBAAqB;oBAC5B,OAAO,EAAE,OAAO;oBAChB,WAAW,EACT,sFAAsF;iBACzF;gBACD,OAAO,EAAE;oBACP;wBACE,GAAG,EAAE,UAAU,WAAW,CAAC,IAAI,IAAI,WAAW,CAAC,IAAI,EAAE;wBACrD,WAAW,EAAE,SAAS,UAAU,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,IAAI,aAAa,CAAC,SAAS;qBACjF;iBACF;gBACD,KAAK,EAAE,kBAAkB;gBACzB,UAAU,EAAE;oBACV,OAAO,EAAE,kBAAkB,IAAI,EAAE;oBACjC,eAAe,EAAE;wBACf,UAAU,EAAE;4BACV,IAAI,EAAE,MAAM;4BACZ,MAAM,EAAE,QAAQ;4BAChB,YAAY,EAAE,KAAK;yBACpB;qBACF;iBACF;gBACD,QAAQ,EAAE,EAAE;aACb;YACD,IAAI,EAAE;gBACJ,gCAAgC;gBAChC,mCAAmC;aACpC;YACD,gBAAgB,EAAE;gBAChB,QAAQ,EAAE,IAAI;gBACd,cAAc,EAAE;oBACd,MAAM,EAAE,IAAI;oBACZ,sBAAsB,EAAE,IAAI;oBAC5B,cAAc,EAAE,IAAI;oBACpB,oBAAoB,EAAE,IAAI;iBAC3B;aACF;YACD,WAAW,EAAE,IAAI;YACjB,eAAe,EAAE,IAAI;YACrB,oBAAoB,EAAE,KAAK;SAC5B;KACF,CAAC;IAGF,MAAM,cAAc,GAAG,SAAS,CAC9B,oBAAoB,EACpB,WAAW,CAAC,OAAO,IAAI,EAAE,CAC1B,CAAC;IAGF,IAAI,cAAc,EAAE,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,OAAO,EAAE,CAAC;QAC7D,cAAc,CAAC,OAAO,CAAC,UAAU,CAAC,UAAU,CAAC,OAAO,GAAG;YACrD,GAAG,cAAc,EAAE,OAAO,EAAE,UAAU,EAAE,UAAU,CAAC,OAAO;SAC3D,CAAC;IACJ,CAAC;IAGD,MAAM,oBAAoB,GAAG,YAAY,CAAC;QACxC,UAAU,EAAE,cAAc,CAAC,OAAO;aAC/B,UAA4C;QAC/C,IAAI,EAAE,cAAc,CAAC,OAAO,CAAC,IAAI,IAAI,EAAE;KACxC,CAAC,CAAC;IAGH,MAAM,gBAAgB,GAAG;QACvB,QAAQ,EAAE,cAAc,CAAC,OAAO,CAAC,gBAAgB,EAAE,QAAQ,IAAI,IAAI;QACnE,SAAS,EAAE,cAAc,CAAC,OAAO,CAAC,gBAAgB,EAAE,SAAS;QAC7D,eAAe,EACb,cAAc,CAAC,OAAO,CAAC,gBAAgB,EAAE,eAAe;YACxD,4BAA4B;QAC9B,aAAa,EAAE,cAAc,CAAC,OAAO,CAAC,gBAAgB,EAAE,aAAa;QACrE,cAAc,EAAE;YACd,MAAM,EACJ,cAAc,CAAC,OAAO,CAAC,gBAAgB,EAAE,cAAc,EAAE,MAAM,IAAI,IAAI;YACzE,sBAAsB,EACpB,cAAc,CAAC,OAAO,CAAC,gBAAgB,EAAE,cAAc;gBACrD,EAAE,sBAAsB,IAAI,IAAI;YACpC,WAAW,EAAE,cAAc,CAAC,OAAO,CAAC,WAAW,IAAI,IAAI;YACvD,eAAe,EAAE,cAAc,CAAC,OAAO,CAAC,eAAe,IAAI,IAAI;YAC/D,oBAAoB,EAClB,cAAc,CAAC,OAAO,CAAC,oBAAoB,IAAI,KAAK;YACtD,cAAc,EACZ,cAAc,CAAC,OAAO,CAAC,gBAAgB,EAAE,cAAc;gBACrD,EAAE,cAAc,IAAI,IAAI;YAC5B,oBAAoB,EAClB,cAAc,CAAC,OAAO,CAAC,gBAAgB,EAAE,cAAc;gBACrD,EAAE,oBAAoB,IAAI,IAAI;YAClC,GAAG,cAAc,CAAC,OAAO,CAAC,gBAAgB,EAAE,cAAc;SAC3D;KACF,CAAC;IAGF,aAAa,CAAC,GAAG,CAAC,cAAc,CAAC,QAAS,EAAE,SAAS,CAAC,KAAK,CAAC,CAAC;IAG7D,aAAa,CAAC,GAAG,CACf,cAAc,CAAC,QAAS,EACxB,SAAS,CAAC,KAAK,CAAC,oBAAoB,EAAE,gBAAgB,CAAC,CACxD,CAAC;IA4BF,OAAO,aAAa,CAAC;AACvB,CAAC","sourcesContent":["import { Router } from \"express\";\nimport swaggerUi from \"swagger-ui-express\";\nimport swaggerJsdoc from \"swagger-jsdoc\";\nimport { ArkosConfig } from \"../../types/arkos-config\";\nimport deepmerge from \"../../utils/helpers/deepmerge.helper\";\nimport {\n  generatePathsForModels,\n  getOpenAPIJsonSchemasByConfigMode,\n} from \"./utils/helpers/swagger.router.helpers\";\nimport { capitalize } from \"../../utils/helpers/text.helpers\";\n\nconst swaggerRouter = Router();\n\nexport async function getSwaggerRouter(\n  arkosConfig: ArkosConfig\n): Promise<Router> {\n  const defaultJsonSchemas = await getOpenAPIJsonSchemasByConfigMode(\n    arkosConfig.swagger\n  );\n  const defaultModelsPaths = await generatePathsForModels(arkosConfig);\n\n  const defaultSwaggerConfig: ArkosConfig[\"swagger\"] = {\n    endpoint: \"/docs\",\n    mode: \"prisma\",\n    options: {\n      definition: {\n        openapi: \"3.0.0\",\n        info: {\n          title: \"Powered By Arkos.js\",\n          version: \"1.0.0\",\n          description:\n            \"This API was automatically generated by Arkos.js, read more about at www.arkosjs.com\",\n        },\n        servers: [\n          {\n            url: `http://${arkosConfig.host}:${arkosConfig.port}`,\n            description: `Local ${capitalize(process.env.NODE_ENV || \"development\")} server`,\n          },\n        ],\n        paths: defaultModelsPaths,\n        components: {\n          schemas: defaultJsonSchemas || {},\n          securitySchemes: {\n            BearerAuth: {\n              type: \"http\",\n              scheme: \"bearer\",\n              bearerFormat: \"JWT\",\n            },\n          },\n        },\n        security: [],\n      },\n      apis: [\n        \"./src/routers/*.router.{ts,js}\",\n        \"./src/modules/**/*.router.{ts,js}\",\n      ],\n      swaggerUiOptions: {\n        explorer: true,\n        swaggerOptions: {\n          filter: true,\n          displayRequestDuration: true,\n          showExtensions: true,\n          showCommonExtensions: true,\n        },\n      },\n      deepLinking: true,\n      tryItOutEnabled: true,\n      persistAuthorization: false,\n    },\n  };\n\n  // Merge default config with user config\n  const swaggerConfigs = deepmerge(\n    defaultSwaggerConfig,\n    arkosConfig.swagger || {}\n  );\n\n  // Merge mode-generated schemas with existing schemas\n  if (swaggerConfigs?.options?.definition?.components?.schemas) {\n    swaggerConfigs.options.definition.components.schemas = {\n      ...swaggerConfigs?.options?.definition?.components.schemas,\n    };\n  }\n\n  // Generate OpenAPI specification using swagger-jsdoc\n  const swaggerSpecification = swaggerJsdoc({\n    definition: swaggerConfigs.options\n      .definition as swaggerJsdoc.SwaggerDefinition,\n    apis: swaggerConfigs.options.apis || [],\n  });\n\n  // Setup Swagger UI options\n  const swaggerUiOptions = {\n    explorer: swaggerConfigs.options.swaggerUiOptions?.explorer ?? true,\n    customCss: swaggerConfigs.options.swaggerUiOptions?.customCss,\n    customSiteTitle:\n      swaggerConfigs.options.swaggerUiOptions?.customSiteTitle ||\n      \"Arkos.js API Documentation\",\n    customfavIcon: swaggerConfigs.options.swaggerUiOptions?.customfavIcon,\n    swaggerOptions: {\n      filter:\n        swaggerConfigs.options.swaggerUiOptions?.swaggerOptions?.filter ?? true,\n      displayRequestDuration:\n        swaggerConfigs.options.swaggerUiOptions?.swaggerOptions\n          ?.displayRequestDuration ?? true,\n      deepLinking: swaggerConfigs.options.deepLinking ?? true,\n      tryItOutEnabled: swaggerConfigs.options.tryItOutEnabled ?? true,\n      persistAuthorization:\n        swaggerConfigs.options.persistAuthorization ?? false,\n      showExtensions:\n        swaggerConfigs.options.swaggerUiOptions?.swaggerOptions\n          ?.showExtensions ?? true,\n      showCommonExtensions:\n        swaggerConfigs.options.swaggerUiOptions?.swaggerOptions\n          ?.showCommonExtensions ?? true,\n      ...swaggerConfigs.options.swaggerUiOptions?.swaggerOptions,\n    },\n  };\n\n  // Serve Swagger UI static assets\n  swaggerRouter.use(swaggerConfigs.endpoint!, swaggerUi.serve);\n\n  // Serve Swagger documentation\n  swaggerRouter.get(\n    swaggerConfigs.endpoint!,\n    swaggerUi.setup(swaggerSpecification, swaggerUiOptions)\n  );\n\n  // Serve raw OpenAPI spec as JSON\n  // swaggerRouter.get(`${swaggerConfigs.endpoint}/json`, (req, res) => {\n  //   res.setHeader(\"Content-Type\", \"application/json\");\n  //   res.json(swaggerSpecification);\n  // });\n\n  // // Serve raw OpenAPI spec as YAML (optional)\n  // swaggerRouter.get(`${swaggerConfigs.endpoint}/yaml`, (req, res) => {\n  //   const yaml = require(\"js-yaml\");\n  //   res.setHeader(\"Content-Type\", \"text/yaml\");\n  //   res.send(yaml.dump(swaggerSpecification));\n  // });\n\n  // // Health check endpoint for Swagger itself\n  // swaggerRouter.get(`${swaggerConfigs.endpoint}/health`, (req, res) => {\n  //   res.json({\n  //     status: \"ok\",\n  //     swagger: {\n  //       version: swaggerConfigs?.options?.definition?.openapi,\n  //       title: swaggerConfigs?.options?.definition?.info?.title,\n  //       endpoint: swaggerConfigs.endpoint,\n  //       mode: swaggerConfigs.mode,\n  //     },\n  //   });\n  // });\n\n  return swaggerRouter;\n}\n"]}

package/dist/esm/modules/swagger/utils/helpers/get-authentication-json-schema-paths.js

@@ -0,0 +1,247 @@
+import { getSchemaRef } from "./swagger.router.helpers.js";
+import { getArkosConfig } from "../../../../server.js";
+export function getAuthenticationJsonSchemaPaths() {
+    const mode = getArkosConfig().swagger?.mode;
+    const paths = {};
+    if (!mode)
+        return paths;
+    paths["/api/auth/login"] = {
+        post: {
+            tags: ["Authentication"],
+            summary: "Login to the system",
+            description: "Authenticates a user and returns an access token",
+            operationId: "login",
+            requestBody: {
+                description: "User credentials",
+                required: true,
+                content: {
+                    "application/json": {
+                        schema: {
+                            $ref: getSchemaRef("Login", mode),
+                        },
+                    },
+                },
+            },
+            responses: {
+                "200": {
+                    description: "Login successful",
+                    content: {
+                        "application/json": {
+                            schema: {
+                                type: "object",
+                                properties: {
+                                    accessToken: {
+                                        type: "string",
+                                        description: "JWT access token",
+                                    },
+                                },
+                            },
+                        },
+                    },
+                },
+                "400": {
+                    description: "Invalid input data",
+                },
+                "401": {
+                    description: "Invalid credentials",
+                },
+            },
+        },
+    };
+    paths["/api/auth/logout"] = {
+        delete: {
+            tags: ["Authentication"],
+            summary: "Logout from the system",
+            description: "Invalidates the current user's JWT token",
+            operationId: "logout",
+            security: [{ BearerAuth: [] }],
+            responses: {
+                "204": {
+                    description: "Logout successful",
+                },
+                "401": {
+                    description: "Authentication required",
+                },
+            },
+        },
+    };
+    paths["/api/auth/signup"] = {
+        post: {
+            tags: ["Authentication"],
+            summary: "Register a new user",
+            description: "Creates a new user account",
+            operationId: "signup",
+            requestBody: {
+                description: "User registration data",
+                required: true,
+                content: {
+                    "application/json": {
+                        schema: {
+                            $ref: getSchemaRef("Signup", mode),
+                        },
+                    },
+                },
+            },
+            responses: {
+                "201": {
+                    description: "User created successfully",
+                    content: {
+                        "application/json": {
+                            schema: {
+                                $ref: getSchemaRef("User", mode),
+                            },
+                        },
+                    },
+                },
+                "400": {
+                    description: "Invalid input data",
+                },
+                "409": {
+                    description: "User already exists",
+                },
+            },
+        },
+    };
+    paths["/api/auth/update-password"] = {
+        post: {
+            tags: ["Authentication"],
+            summary: "Update user password",
+            description: "Changes the password for the authenticated user",
+            operationId: "updatePassword",
+            security: [{ BearerAuth: [] }],
+            requestBody: {
+                description: "Current and new password",
+                required: true,
+                content: {
+                    "application/json": {
+                        schema: {
+                            $ref: getSchemaRef("UpdatePassword", mode),
+                        },
+                    },
+                },
+            },
+            responses: {
+                "200": {
+                    description: "Password updated successfully",
+                    content: {
+                        "application/json": {
+                            schema: {
+                                type: "object",
+                                properties: {
+                                    status: {
+                                        type: "string",
+                                        example: "success",
+                                    },
+                                    message: {
+                                        type: "string",
+                                        example: "Password updated successfully!",
+                                    },
+                                },
+                            },
+                        },
+                    },
+                },
+                "400": {
+                    description: "Invalid input data or current password incorrect",
+                },
+                "401": {
+                    description: "Authentication required",
+                },
+            },
+        },
+    };
+    paths["/users/me"] = {
+        get: {
+            tags: ["Users"],
+            summary: "Get current user information",
+            description: "Retrieves information about the currently authenticated user",
+            operationId: "getCurrentUser",
+            security: [{ BearerAuth: [] }],
+            responses: {
+                "200": {
+                    description: "User information retrieved successfully",
+                    content: {
+                        "application/json": {
+                            schema: {
+                                $ref: getSchemaRef("FindMe", mode),
+                            },
+                        },
+                    },
+                },
+                "401": {
+                    description: "Authentication required",
+                },
+            },
+        },
+    };
+    paths["/users/me"] = {
+        patch: {
+            tags: ["Users"],
+            summary: "Update current user information",
+            description: "Updates information for the currently authenticated user",
+            operationId: "updateCurrentUser",
+            security: [{ BearerAuth: [] }],
+            requestBody: {
+                description: "User data to update",
+                required: true,
+                content: {
+                    "application/json": {
+                        schema: {
+                            $ref: getSchemaRef("UpdateMe", mode),
+                        },
+                    },
+                },
+            },
+            responses: {
+                "200": {
+                    description: "User updated successfully",
+                    content: {
+                        "application/json": {
+                            schema: {
+                                $ref: getSchemaRef("User", mode),
+                            },
+                        },
+                    },
+                },
+                "400": {
+                    description: "Invalid input data",
+                },
+                "401": {
+                    description: "Authentication required",
+                },
+            },
+        },
+    };
+    paths["/users/me"] = {
+        delete: {
+            tags: ["Users"],
+            summary: "Delete current user account",
+            description: "Marks the current user's account as deleted",
+            operationId: "deleteCurrentUser",
+            security: [{ BearerAuth: [] }],
+            responses: {
+                "200": {
+                    description: "Account deleted successfully",
+                    content: {
+                        "application/json": {
+                            schema: {
+                                type: "object",
+                                properties: {
+                                    message: {
+                                        type: "string",
+                                        example: "Account deleted successfully",
+                                    },
+                                },
+                            },
+                        },
+                    },
+                },
+                "401": {
+                    description: "Authentication required",
+                },
+            },
+        },
+    };
+    return paths;
+}
+//# sourceMappingURL=get-authentication-json-schema-paths.js.map

package/dist/esm/modules/swagger/utils/helpers/get-authentication-json-schema-paths.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-authentication-json-schema-paths.js","sourceRoot":"","sources":["../../../../../../src/modules/swagger/utils/helpers/get-authentication-json-schema-paths.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AACxD,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAEpD,MAAM,UAAU,gCAAgC;IAC9C,MAAM,IAAI,GAAG,cAAc,EAAE,CAAC,OAAO,EAAE,IAAI,CAAC;IAC5C,MAAM,KAAK,GAA0B,EAAE,CAAC;IAExC,IAAI,CAAC,IAAI;QAAE,OAAO,KAAK,CAAC;IAExB,KAAK,CAAC,iBAAiB,CAAC,GAAG;QACzB,IAAI,EAAE;YACJ,IAAI,EAAE,CAAC,gBAAgB,CAAC;YACxB,OAAO,EAAE,qBAAqB;YAC9B,WAAW,EAAE,kDAAkD;YAC/D,WAAW,EAAE,OAAO;YACpB,WAAW,EAAE;gBACX,WAAW,EAAE,kBAAkB;gBAC/B,QAAQ,EAAE,IAAI;gBACd,OAAO,EAAE;oBACP,kBAAkB,EAAE;wBAClB,MAAM,EAAE;4BACN,IAAI,EAAE,YAAY,CAAC,OAAO,EAAE,IAAI,CAAC;yBAClC;qBACF;iBACF;aACF;YACD,SAAS,EAAE;gBACT,KAAK,EAAE;oBACL,WAAW,EAAE,kBAAkB;oBAC/B,OAAO,EAAE;wBACP,kBAAkB,EAAE;4BAClB,MAAM,EAAE;gCACN,IAAI,EAAE,QAAQ;gCACd,UAAU,EAAE;oCACV,WAAW,EAAE;wCACX,IAAI,EAAE,QAAQ;wCACd,WAAW,EAAE,kBAAkB;qCAChC;iCACF;6BACF;yBACF;qBACF;iBACF;gBACD,KAAK,EAAE;oBACL,WAAW,EAAE,oBAAoB;iBAClC;gBACD,KAAK,EAAE;oBACL,WAAW,EAAE,qBAAqB;iBACnC;aACF;SACF;KACF,CAAC;IAGF,KAAK,CAAC,kBAAkB,CAAC,GAAG;QAC1B,MAAM,EAAE;YACN,IAAI,EAAE,CAAC,gBAAgB,CAAC;YACxB,OAAO,EAAE,wBAAwB;YACjC,WAAW,EAAE,0CAA0C;YACvD,WAAW,EAAE,QAAQ;YACrB,QAAQ,EAAE,CAAC,EAAE,UAAU,EAAE,EAAE,EAAE,CAAC;YAC9B,SAAS,EAAE;gBACT,KAAK,EAAE;oBACL,WAAW,EAAE,mBAAmB;iBACjC;gBACD,KAAK,EAAE;oBACL,WAAW,EAAE,yBAAyB;iBACvC;aACF;SACF;KACF,CAAC;IAGF,KAAK,CAAC,kBAAkB,CAAC,GAAG;QAC1B,IAAI,EAAE;YACJ,IAAI,EAAE,CAAC,gBAAgB,CAAC;YACxB,OAAO,EAAE,qBAAqB;YAC9B,WAAW,EAAE,4BAA4B;YACzC,WAAW,EAAE,QAAQ;YACrB,WAAW,EAAE;gBACX,WAAW,EAAE,wBAAwB;gBACrC,QAAQ,EAAE,IAAI;gBACd,OAAO,EAAE;oBACP,kBAAkB,EAAE;wBAClB,MAAM,EAAE;4BACN,IAAI,EAAE,YAAY,CAAC,QAAQ,EAAE,IAAI,CAAC;yBACnC;qBACF;iBACF;aACF;YACD,SAAS,EAAE;gBACT,KAAK,EAAE;oBACL,WAAW,EAAE,2BAA2B;oBACxC,OAAO,EAAE;wBACP,kBAAkB,EAAE;4BAClB,MAAM,EAAE;gCACN,IAAI,EAAE,YAAY,CAAC,MAAM,EAAE,IAAI,CAAC;6BACjC;yBACF;qBACF;iBACF;gBACD,KAAK,EAAE;oBACL,WAAW,EAAE,oBAAoB;iBAClC;gBACD,KAAK,EAAE;oBACL,WAAW,EAAE,qBAAqB;iBACnC;aACF;SACF;KACF,CAAC;IAGF,KAAK,CAAC,2BAA2B,CAAC,GAAG;QACnC,IAAI,EAAE;YACJ,IAAI,EAAE,CAAC,gBAAgB,CAAC;YACxB,OAAO,EAAE,sBAAsB;YAC/B,WAAW,EAAE,iDAAiD;YAC9D,WAAW,EAAE,gBAAgB;YAC7B,QAAQ,EAAE,CAAC,EAAE,UAAU,EAAE,EAAE,EAAE,CAAC;YAC9B,WAAW,EAAE;gBACX,WAAW,EAAE,0BAA0B;gBACvC,QAAQ,EAAE,IAAI;gBACd,OAAO,EAAE;oBACP,kBAAkB,EAAE;wBAClB,MAAM,EAAE;4BACN,IAAI,EAAE,YAAY,CAAC,gBAAgB,EAAE,IAAI,CAAC;yBAC3C;qBACF;iBACF;aACF;YACD,SAAS,EAAE;gBACT,KAAK,EAAE;oBACL,WAAW,EAAE,+BAA+B;oBAC5C,OAAO,EAAE;wBACP,kBAAkB,EAAE;4BAClB,MAAM,EAAE;gCACN,IAAI,EAAE,QAAQ;gCACd,UAAU,EAAE;oCACV,MAAM,EAAE;wCACN,IAAI,EAAE,QAAQ;wCACd,OAAO,EAAE,SAAS;qCACnB;oCACD,OAAO,EAAE;wCACP,IAAI,EAAE,QAAQ;wCACd,OAAO,EAAE,gCAAgC;qCAC1C;iCACF;6BACF;yBACF;qBACF;iBACF;gBACD,KAAK,EAAE;oBACL,WAAW,EAAE,kDAAkD;iBAChE;gBACD,KAAK,EAAE;oBACL,WAAW,EAAE,yBAAyB;iBACvC;aACF;SACF;KACF,CAAC;IAGF,KAAK,CAAC,WAAW,CAAC,GAAG;QACnB,GAAG,EAAE;YACH,IAAI,EAAE,CAAC,OAAO,CAAC;YACf,OAAO,EAAE,8BAA8B;YACvC,WAAW,EACT,8DAA8D;YAChE,WAAW,EAAE,gBAAgB;YAC7B,QAAQ,EAAE,CAAC,EAAE,UAAU,EAAE,EAAE,EAAE,CAAC;YAC9B,SAAS,EAAE;gBACT,KAAK,EAAE;oBACL,WAAW,EAAE,yCAAyC;oBACtD,OAAO,EAAE;wBACP,kBAAkB,EAAE;4BAClB,MAAM,EAAE;gCACN,IAAI,EAAE,YAAY,CAAC,QAAQ,EAAE,IAAI,CAAC;6BACnC;yBACF;qBACF;iBACF;gBACD,KAAK,EAAE;oBACL,WAAW,EAAE,yBAAyB;iBACvC;aACF;SACF;KACF,CAAC;IAGF,KAAK,CAAC,WAAW,CAAC,GAAG;QACnB,KAAK,EAAE;YACL,IAAI,EAAE,CAAC,OAAO,CAAC;YACf,OAAO,EAAE,iCAAiC;YAC1C,WAAW,EAAE,0DAA0D;YACvE,WAAW,EAAE,mBAAmB;YAChC,QAAQ,EAAE,CAAC,EAAE,UAAU,EAAE,EAAE,EAAE,CAAC;YAC9B,WAAW,EAAE;gBACX,WAAW,EAAE,qBAAqB;gBAClC,QAAQ,EAAE,IAAI;gBACd,OAAO,EAAE;oBACP,kBAAkB,EAAE;wBAClB,MAAM,EAAE;4BACN,IAAI,EAAE,YAAY,CAAC,UAAU,EAAE,IAAI,CAAC;yBACrC;qBACF;iBACF;aACF;YACD,SAAS,EAAE;gBACT,KAAK,EAAE;oBACL,WAAW,EAAE,2BAA2B;oBACxC,OAAO,EAAE;wBACP,kBAAkB,EAAE;4BAClB,MAAM,EAAE;gCACN,IAAI,EAAE,YAAY,CAAC,MAAM,EAAE,IAAI,CAAC;6BACjC;yBACF;qBACF;iBACF;gBACD,KAAK,EAAE;oBACL,WAAW,EAAE,oBAAoB;iBAClC;gBACD,KAAK,EAAE;oBACL,WAAW,EAAE,yBAAyB;iBACvC;aACF;SACF;KACF,CAAC;IAGF,KAAK,CAAC,WAAW,CAAC,GAAG;QACnB,MAAM,EAAE;YACN,IAAI,EAAE,CAAC,OAAO,CAAC;YACf,OAAO,EAAE,6BAA6B;YACtC,WAAW,EAAE,6CAA6C;YAC1D,WAAW,EAAE,mBAAmB;YAChC,QAAQ,EAAE,CAAC,EAAE,UAAU,EAAE,EAAE,EAAE,CAAC;YAC9B,SAAS,EAAE;gBACT,KAAK,EAAE;oBACL,WAAW,EAAE,8BAA8B;oBAC3C,OAAO,EAAE;wBACP,kBAAkB,EAAE;4BAClB,MAAM,EAAE;gCACN,IAAI,EAAE,QAAQ;gCACd,UAAU,EAAE;oCACV,OAAO,EAAE;wCACP,IAAI,EAAE,QAAQ;wCACd,OAAO,EAAE,8BAA8B;qCACxC;iCACF;6BACF;yBACF;qBACF;iBACF;gBACD,KAAK,EAAE;oBACL,WAAW,EAAE,yBAAyB;iBACvC;aACF;SACF;KACF,CAAC;IAEF,OAAO,KAAK,CAAC;AACf,CAAC","sourcesContent":["import { OpenAPIV3 } from \"openapi-types\";\nimport { getSchemaRef } from \"./swagger.router.helpers\";\nimport { getArkosConfig } from \"../../../../server\";\n\nexport function getAuthenticationJsonSchemaPaths() {\n  const mode = getArkosConfig().swagger?.mode;\n  const paths: OpenAPIV3.PathsObject = {};\n\n  if (!mode) return paths;\n  // Add login endpoint\n  paths[\"/api/auth/login\"] = {\n    post: {\n      tags: [\"Authentication\"],\n      summary: \"Login to the system\",\n      description: \"Authenticates a user and returns an access token\",\n      operationId: \"login\",\n      requestBody: {\n        description: \"User credentials\",\n        required: true,\n        content: {\n          \"application/json\": {\n            schema: {\n              $ref: getSchemaRef(\"Login\", mode),\n            },\n          },\n        },\n      },\n      responses: {\n        \"200\": {\n          description: \"Login successful\",\n          content: {\n            \"application/json\": {\n              schema: {\n                type: \"object\",\n                properties: {\n                  accessToken: {\n                    type: \"string\",\n                    description: \"JWT access token\",\n                  },\n                },\n              },\n            },\n          },\n        },\n        \"400\": {\n          description: \"Invalid input data\",\n        },\n        \"401\": {\n          description: \"Invalid credentials\",\n        },\n      },\n    },\n  };\n\n  // Add logout endpoint\n  paths[\"/api/auth/logout\"] = {\n    delete: {\n      tags: [\"Authentication\"],\n      summary: \"Logout from the system\",\n      description: \"Invalidates the current user's JWT token\",\n      operationId: \"logout\",\n      security: [{ BearerAuth: [] }],\n      responses: {\n        \"204\": {\n          description: \"Logout successful\",\n        },\n        \"401\": {\n          description: \"Authentication required\",\n        },\n      },\n    },\n  };\n\n  // Add signup endpoint\n  paths[\"/api/auth/signup\"] = {\n    post: {\n      tags: [\"Authentication\"],\n      summary: \"Register a new user\",\n      description: \"Creates a new user account\",\n      operationId: \"signup\",\n      requestBody: {\n        description: \"User registration data\",\n        required: true,\n        content: {\n          \"application/json\": {\n            schema: {\n              $ref: getSchemaRef(\"Signup\", mode),\n            },\n          },\n        },\n      },\n      responses: {\n        \"201\": {\n          description: \"User created successfully\",\n          content: {\n            \"application/json\": {\n              schema: {\n                $ref: getSchemaRef(\"User\", mode),\n              },\n            },\n          },\n        },\n        \"400\": {\n          description: \"Invalid input data\",\n        },\n        \"409\": {\n          description: \"User already exists\",\n        },\n      },\n    },\n  };\n\n  // Add update password endpoint\n  paths[\"/api/auth/update-password\"] = {\n    post: {\n      tags: [\"Authentication\"],\n      summary: \"Update user password\",\n      description: \"Changes the password for the authenticated user\",\n      operationId: \"updatePassword\",\n      security: [{ BearerAuth: [] }],\n      requestBody: {\n        description: \"Current and new password\",\n        required: true,\n        content: {\n          \"application/json\": {\n            schema: {\n              $ref: getSchemaRef(\"UpdatePassword\", mode),\n            },\n          },\n        },\n      },\n      responses: {\n        \"200\": {\n          description: \"Password updated successfully\",\n          content: {\n            \"application/json\": {\n              schema: {\n                type: \"object\",\n                properties: {\n                  status: {\n                    type: \"string\",\n                    example: \"success\",\n                  },\n                  message: {\n                    type: \"string\",\n                    example: \"Password updated successfully!\",\n                  },\n                },\n              },\n            },\n          },\n        },\n        \"400\": {\n          description: \"Invalid input data or current password incorrect\",\n        },\n        \"401\": {\n          description: \"Authentication required\",\n        },\n      },\n    },\n  };\n\n  // Add get current user endpoint\n  paths[\"/users/me\"] = {\n    get: {\n      tags: [\"Users\"],\n      summary: \"Get current user information\",\n      description:\n        \"Retrieves information about the currently authenticated user\",\n      operationId: \"getCurrentUser\",\n      security: [{ BearerAuth: [] }],\n      responses: {\n        \"200\": {\n          description: \"User information retrieved successfully\",\n          content: {\n            \"application/json\": {\n              schema: {\n                $ref: getSchemaRef(\"FindMe\", mode),\n              },\n            },\n          },\n        },\n        \"401\": {\n          description: \"Authentication required\",\n        },\n      },\n    },\n  };\n\n  // Add update current user endpoint\n  paths[\"/users/me\"] = {\n    patch: {\n      tags: [\"Users\"],\n      summary: \"Update current user information\",\n      description: \"Updates information for the currently authenticated user\",\n      operationId: \"updateCurrentUser\",\n      security: [{ BearerAuth: [] }],\n      requestBody: {\n        description: \"User data to update\",\n        required: true,\n        content: {\n          \"application/json\": {\n            schema: {\n              $ref: getSchemaRef(\"UpdateMe\", mode),\n            },\n          },\n        },\n      },\n      responses: {\n        \"200\": {\n          description: \"User updated successfully\",\n          content: {\n            \"application/json\": {\n              schema: {\n                $ref: getSchemaRef(\"User\", mode),\n              },\n            },\n          },\n        },\n        \"400\": {\n          description: \"Invalid input data\",\n        },\n        \"401\": {\n          description: \"Authentication required\",\n        },\n      },\n    },\n  };\n\n  // Add delete current user endpoint\n  paths[\"/users/me\"] = {\n    delete: {\n      tags: [\"Users\"],\n      summary: \"Delete current user account\",\n      description: \"Marks the current user's account as deleted\",\n      operationId: \"deleteCurrentUser\",\n      security: [{ BearerAuth: [] }],\n      responses: {\n        \"200\": {\n          description: \"Account deleted successfully\",\n          content: {\n            \"application/json\": {\n              schema: {\n                type: \"object\",\n                properties: {\n                  message: {\n                    type: \"string\",\n                    example: \"Account deleted successfully\",\n                  },\n                },\n              },\n            },\n          },\n        },\n        \"401\": {\n          description: \"Authentication required\",\n        },\n      },\n    },\n  };\n\n  return paths;\n}\n"]}