arkos 1.4.12-beta → 1.4.14-beta

package/dist/types/modules/error-handler/utils/errors.d.ts

@@ -0,0 +1,176 @@
+import AppError from "./app-error";
+/**
+ * 400 - Bad Request
+ * @example throw new BadRequestError("Invalid input", "InvalidInput", { field: "email" })
+ */
+export declare class BadRequestError extends AppError {
+    constructor(message?: string, code?: string, meta?: Record<string, any>);
+}
+/**
+ * 401 - Unauthorized
+ * @example throw new UnauthorizedError("Invalid token", "InvalidToken")
+ */
+export declare class UnauthorizedError extends AppError {
+    constructor(message?: string, code?: string, meta?: Record<string, any>);
+}
+/**
+ * 402 - Payment Required
+ * @example throw new PaymentRequiredError("Subscription expired", "PaymentRequired")
+ */
+export declare class PaymentRequiredError extends AppError {
+    constructor(message?: string, code?: string, meta?: Record<string, any>);
+}
+/**
+ * 403 - Forbidden
+ * @example throw new ForbiddenError("Access denied", "Forbidden", { resource: "admin" })
+ */
+export declare class ForbiddenError extends AppError {
+    constructor(message?: string, code?: string, meta?: Record<string, any>);
+}
+/**
+ * 404 - Not Found
+ * @example throw new NotFoundError("User not found", "NotFound", { id: 123 })
+ */
+export declare class NotFoundError extends AppError {
+    constructor(message?: string, code?: string, meta?: Record<string, any>);
+}
+/**
+ * 405 - Method Not Allowed
+ * @example throw new MethodNotAllowedError("POST not allowed", "MethodNotAllowed")
+ */
+export declare class MethodNotAllowedError extends AppError {
+    constructor(message?: string, code?: string, meta?: Record<string, any>);
+}
+/**
+ * 406 - Not Acceptable
+ * @example throw new NotAcceptableError("Unsupported format", "NotAcceptable")
+ */
+export declare class NotAcceptableError extends AppError {
+    constructor(message?: string, code?: string, meta?: Record<string, any>);
+}
+/**
+ * 408 - Request Timeout
+ * @example throw new RequestTimeoutError("Upload took too long", "RequestTimeout")
+ */
+export declare class RequestTimeoutError extends AppError {
+    constructor(message?: string, code?: string, meta?: Record<string, any>);
+}
+/**
+ * 409 - Conflict
+ * @example throw new ConflictError("Duplicate entry", "Conflict", { field: "email" })
+ */
+export declare class ConflictError extends AppError {
+    constructor(message?: string, code?: string, meta?: Record<string, any>);
+}
+/**
+ * 410 - Gone
+ * @example throw new GoneError("Resource deleted", "Gone")
+ */
+export declare class GoneError extends AppError {
+    constructor(message?: string, code?: string, meta?: Record<string, any>);
+}
+/**
+ * 411 - Length Required
+ * @example throw new LengthRequiredError("Content-Length missing", "LengthRequired")
+ */
+export declare class LengthRequiredError extends AppError {
+    constructor(message?: string, code?: string, meta?: Record<string, any>);
+}
+/**
+ * 412 - Precondition Failed
+ * @example throw new PreconditionFailedError("ETag mismatch", "PreconditionFailed")
+ */
+export declare class PreconditionFailedError extends AppError {
+    constructor(message?: string, code?: string, meta?: Record<string, any>);
+}
+/**
+ * 413 - Payload Too Large
+ * @example throw new PayloadTooLargeError("File exceeds 10MB", "PayloadTooLarge", { max: "10MB" })
+ */
+export declare class PayloadTooLargeError extends AppError {
+    constructor(message?: string, code?: string, meta?: Record<string, any>);
+}
+/**
+ * 414 - URI Too Long
+ * @example throw new UriTooLongError("Query string too long", "UriTooLong")
+ */
+export declare class UriTooLongError extends AppError {
+    constructor(message?: string, code?: string, meta?: Record<string, any>);
+}
+/**
+ * 415 - Unsupported Media Type
+ * @example throw new UnsupportedMediaTypeError("Expected JSON", "UnsupportedMediaType")
+ */
+export declare class UnsupportedMediaTypeError extends AppError {
+    constructor(message?: string, code?: string, meta?: Record<string, any>);
+}
+/**
+ * 416 - Range Not Satisfiable
+ * @example throw new RangeNotSatisfiableError("Invalid byte range", "RangeNotSatisfiable")
+ */
+export declare class RangeNotSatisfiableError extends AppError {
+    constructor(message?: string, code?: string, meta?: Record<string, any>);
+}
+/**
+ * 417 - Expectation Failed
+ * @example throw new ExpectationFailedError("Expect header failed", "ExpectationFailed")
+ */
+export declare class ExpectationFailedError extends AppError {
+    constructor(message?: string, code?: string, meta?: Record<string, any>);
+}
+/**
+ * 418 - I'm a teapot
+ * @example throw new ImATeapotError("Cannot brew coffee", "ImATeapot")
+ */
+export declare class ImATeapotError extends AppError {
+    constructor(message?: string, code?: string, meta?: Record<string, any>);
+}
+/**
+ * 422 - Unprocessable Content
+ * @example throw new UnprocessableContentError("Validation failed", "ValidationFailed", { errors: [...] })
+ */
+export declare class UnprocessableContentError extends AppError {
+    constructor(message?: string, code?: string, meta?: Record<string, any>);
+}
+/**
+ * 429 - Too Many Requests
+ * @example throw new TooManyRequestsError("Rate limit exceeded", "RateLimitExceeded", { retryAfter: 60 })
+ */
+export declare class TooManyRequestsError extends AppError {
+    constructor(message?: string, code?: string, meta?: Record<string, any>);
+}
+/**
+ * 500 - Internal Server Error
+ * @example throw new InternalServerError("Database connection failed", "DatabaseError")
+ */
+export declare class InternalServerError extends AppError {
+    constructor(message?: string, code?: string, meta?: Record<string, any>);
+}
+/**
+ * 501 - Not Implemented
+ * @example throw new NotImplementedError("Feature coming soon", "NotImplemented")
+ */
+export declare class NotImplementedError extends AppError {
+    constructor(message?: string, code?: string, meta?: Record<string, any>);
+}
+/**
+ * 502 - Bad Gateway
+ * @example throw new BadGatewayError("Upstream timeout", "BadGateway")
+ */
+export declare class BadGatewayError extends AppError {
+    constructor(message?: string, code?: string, meta?: Record<string, any>);
+}
+/**
+ * 503 - Service Unavailable
+ * @example throw new ServiceUnavailableError("Maintenance mode", "ServiceUnavailable", { retryAfter: 300 })
+ */
+export declare class ServiceUnavailableError extends AppError {
+    constructor(message?: string, code?: string, meta?: Record<string, any>);
+}
+/**
+ * 504 - Gateway Timeout
+ * @example throw new GatewayTimeoutError("Upstream timeout", "GatewayTimeout")
+ */
+export declare class GatewayTimeoutError extends AppError {
+    constructor(message?: string, code?: string, meta?: Record<string, any>);
+}

package/dist/types/types/arkos-config/utils.d.ts

@@ -1,31 +1,68 @@
 import { ArkosRequest } from "..";
-/**
- * Context object passed to `before` auth hooks.
- */
-export interface AuthBeforeHookContext {
+import { AccessAction, DetailedAccessControlRule } from "../auth";
+/** Context passed to `before` hooks of `authenticate`. */
+export interface AuthenticateBeforeHookContext {
+    /** The incoming request object. */
     req: ArkosRequest;
-    /**
-     * Bypasses core logic and jumps directly to `after` hooks.
-     */
+    /** Bypasses core logic and jumps directly to `after` hooks. */
     skip: () => void;
 }
-/**
- * Context object passed to `after` auth hooks.
- */
-export interface AuthAfterHookContext {
+/** Context passed to `after` hooks of `authenticate`. */
+export interface AuthenticateAfterHookContext {
+    /** The incoming request object. */
     req: ArkosRequest;
 }
-/**
- * Context object passed to `onError` auth hooks.
- */
-export interface AuthErrorHookContext {
+/** Context passed to `onError` hooks of `authenticate`. */
+export interface AuthenticateErrorHookContext {
+    /** The incoming request object. */
     req: ArkosRequest;
+    /** The error thrown during authentication. */
     error: unknown;
-    /**
-     * Suppress the error and jump to `after` hooks.
-     */
+    /** Suppresses the error and jumps to `after` hooks. */
     skip: () => void;
 }
-export type AuthHookHandler = (ctx: AuthBeforeHookContext) => void | Promise<void>;
-export type AuthAfterHookHandler = (ctx: AuthAfterHookContext) => void | Promise<void>;
-export type AuthErrorHookHandler = (ctx: AuthErrorHookContext) => void | Promise<void>;
+export type AuthenticateHookHandler = (ctx: AuthenticateBeforeHookContext) => void | Promise<void>;
+export type AuthenticateAfterHookHandler = (ctx: AuthenticateAfterHookContext) => void | Promise<void>;
+export type AuthenticateErrorHookHandler = (ctx: AuthenticateErrorHookContext) => void | Promise<void>;
+/** Context passed to `before` hooks of `authorize`. */
+export interface AuthorizeBeforeHookContext {
+    /** The incoming request object. */
+    req: ArkosRequest;
+    /** The action being authorized (e.g. `"Create"`, `"Delete"`). */
+    action: AccessAction;
+    /** The resource being accessed in kebab-case (e.g. `"post"`, `"cart-item"`). */
+    resource: string;
+    /** The access control rule for this action. */
+    rule?: string[] | DetailedAccessControlRule | "*";
+    /** Bypasses core logic and jumps directly to `after` hooks. */
+    skip: () => void;
+}
+/** Context passed to `after` hooks of `authorize`. */
+export interface AuthorizeAfterHookContext {
+    /** The incoming request object. */
+    req: ArkosRequest;
+    /** The action that was authorized (e.g. `"Create"`, `"Delete"`). */
+    action: AccessAction;
+    /** The resource that was accessed in kebab-case (e.g. `"post"`, `"cart-item"`). */
+    resource: string;
+    /** The access control rule that was applied. */
+    rule?: string[] | DetailedAccessControlRule | "*";
+}
+/** Context passed to `onError` hooks of `authorize`. */
+export interface AuthorizeErrorHookContext {
+    /** The incoming request object. */
+    req: ArkosRequest;
+    /** The error thrown during authorization. */
+    error: unknown;
+    /** The action being authorized (e.g. `"Create"`, `"Delete"`). */
+    action: AccessAction;
+    /** The resource being accessed in kebab-case (e.g. `"post"`, `"cart-item"`). */
+    resource: string;
+    /** The access control rule for this action. */
+    rule?: string[] | DetailedAccessControlRule | "*";
+    /** Suppresses the error and jumps to `after` hooks. */
+    skip: () => void;
+}
+export type AuthorizeHookHandler = (ctx: AuthorizeBeforeHookContext) => void | Promise<void>;
+export type AuthorizeAfterHookHandler = (ctx: AuthorizeAfterHookContext) => void | Promise<void>;
+export type AuthorizeErrorHookHandler = (ctx: AuthorizeErrorHookContext) => void | Promise<void>;

package/dist/types/types/new-arkos-config.d.ts

@@ -731,4 +731,27 @@ export type ArkosConfig = {
             };
         };
     };
+    /**
+     * Allows to suppress specific warnings emitted by Arkos at startup or runtime.
+     */
+    warnings?: {
+        /**
+         * Suppresses specific warning messages.
+         */
+        suppress?: {
+            /**
+             * Suppresses Prisma-related warnings.
+             */
+            prisma?: {
+                /**
+                 * Suppresses the warning emitted when no Prisma instance is found.
+                 */
+                noInstanceFound?: boolean;
+                /**
+                 * Suppresses the warning emitted when no Prisma schema is found.
+                 */
+                noSchemaFound?: boolean;
+            };
+        };
+    };
 };

package/dist/types/utils/helpers/arkos-config.helpers.d.ts

@@ -10,3 +10,5 @@ export declare const defaultArkosConfig: ArkosConfig & {
  * @returns {ArkosConfig}
  */
 export declare function getArkosConfig(): ArkosConfig;
+export declare function isProduction(): boolean;
+export declare function validateArkosConfig(): void;

package/dist/types/utils/helpers/url-helpers.d.ts

@@ -0,0 +1 @@
+export declare function lenientDecode(str: string): string;

package/dist/types/utils/initialize-app.d.ts

@@ -1,2 +1,3 @@
 import { Arkos } from "../types/arkos";
 export default function initializeApp(app: Arkos): Arkos;
+export declare function addGlobalErrorHandler(app: Arkos): Arkos;

package/dist/types/utils/prisma/prisma-schema-parser.d.ts

@@ -29,6 +29,7 @@ export declare class PrismaSchemaParser {
     prismaSchemasContent: string;
     parsed: boolean;
     config: SchemaConfig;
+    warningNotLogged: boolean;
     constructor();
     /**
      * Parses the Prisma schema and extracts all models and enums.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "arkos",
-  "version": "1.4.12-beta",
+  "version": "1.4.14-beta",
   "description": "The Express & Prisma RESTful Framework",
   "main": "dist/cjs/exports/index.js",
   "module": "dist/esm/exports/index.js",