arkos 2.0.0-next.3 → 2.0.0-next.30

package/dist/types/modules/swagger/utils/get-open-api-login-html.d.ts

@@ -0,0 +1 @@
+export default function getOpenApiLoginHtml(): string;

package/dist/types/modules/swagger/utils/helpers/get-swagger-default-configs.d.ts

@@ -1,3 +1,48 @@
-import { OpenAPIV3 } from "openapi-types";
-import { ArkosConfig } from "../../../../exports";
-export default function getSwaggerDefaultConfig(defaultModelsPaths: Record<string, any>, defaultJsonSchemas: OpenAPIV3.PathsObject<{}, {}>): ArkosConfig["swagger"];
+export default function getSwaggerDefaultConfig(defaultModelsPaths: Record<string, any>): {
+    endpoint: string;
+    mode: string;
+    strict: boolean;
+    options: {
+        definition: {
+            openapi: string;
+            info: {
+                title: string;
+                version: string;
+                description: string;
+            };
+            servers: {
+                url: string;
+                description: string;
+            }[];
+            paths: Record<string, any>;
+            components: {
+                securitySchemes: {
+                    BearerAuth: {
+                        type: string;
+                        scheme: string;
+                        bearerFormat: string;
+                    };
+                };
+            };
+            security: never[];
+        };
+        apis: string[];
+        deepLinking: boolean;
+        tryItOutEnabled: boolean;
+        persistAuthorization: boolean;
+    };
+    scalarApiReferenceConfiguration: {
+        theme: string;
+        darkMode: boolean;
+        layout: string;
+        showSidebar: boolean;
+        hideDownloadButton: boolean;
+        cdn: string;
+        metaData: {
+            title: string;
+            description: string;
+        };
+        pageTitle: string;
+        customCss: string;
+    };
+};

package/dist/types/modules/swagger/utils/helpers/openapi-schema-converter.d.ts

@@ -1,11 +1,11 @@
-import { OpenAPIV3 } from "openapi-types";
+import { OpenAPIV3 } from 'openapi-types';
 /**
  * Singleton class responsible for converting various schema formats (Zod, Class DTOs, JSON Schema)
  * into OpenAPI-compliant schema objects. Handles shorthand syntax for responses, request bodies,
  * and parameters.
  */
 declare class OpenAPIchemaConverter {
-    private validatorToJsonSchema;
+    validatorToJsonSchema: (schema: any) => any;
     constructor();
     /**
      * Checks if a value is a schema-like object (Zod, Class, or JSON Schema).
@@ -120,7 +120,12 @@ declare class OpenAPIchemaConverter {
      * @param visitedRefs - Set to track circular references
      * @returns Array of OpenAPI parameter objects
      */
-    jsonSchemaToOpenApiParameters(paramType: string, schema: any, prefix?: string, visitedRefs?: Set<string>): any[];
+    jsonSchemaToOpenApiParameters(paramType: string, schema: any, prefix?: string, visitedRefs?: Set<string>): {
+        in: string;
+        name: string;
+        required: boolean;
+        schema: any;
+    }[];
     resolveRef(rootSchema: any, refPath: string): any;
 }
 declare const openApiSchemaConverter: OpenAPIchemaConverter;

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

@@ -0,0 +1,68 @@
+import { ArkosRequest } from "..";
+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. */
+    skip: () => void;
+}
+/** Context passed to `after` hooks of `authenticate`. */
+export interface AuthenticateAfterHookContext {
+    /** The incoming request object. */
+    req: ArkosRequest;
+}
+/** Context passed to `onError` hooks of `authenticate`. */
+export interface AuthenticateErrorHookContext {
+    /** The incoming request object. */
+    req: ArkosRequest;
+    /** The error thrown during authentication. */
+    error: unknown;
+    /** Suppresses the error and jumps to `after` hooks. */
+    skip: () => 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/arkos-prisma-input.d.ts

@@ -17,6 +17,8 @@ type Unpack<T> = T;
  * Identified by the presence of createMany property
  */
 export type IsArrayRelation<T> = Exclude<T, undefined> extends never ? false : Exclude<T, undefined> extends {
+    connect?: infer C;
+} ? (Extract<Exclude<C, undefined>, any[]> extends never ? false : true) : Exclude<T, undefined> extends {
     createMany?: any;
 } ? true : false;
 /**
@@ -131,9 +133,11 @@ type StripPrismaFilters<T> = T extends {
     OR?: any;
 } | {
     NOT?: any;
-} ? never : T;
+} ? Omit<T, "equals" | "in" | "notIn" | "lt" | "lte" | "gt" | "gte" | "AND" | "OR" | "NOT"> : T;
+type ScalarValue = string | number | boolean | Date | null | undefined;
+type StripToScalar<T> = T extends Array<ScalarValue> ? T : T extends ScalarValue ? T : never;
 type FlattenRelations<T> = {
-    [K in keyof T]: IsArrayRelation<T[K]> extends true ? FlattenArrayRelation<T[K]> : IsObjectRelation<T[K]> extends true ? XOR<FlattenObjectRelation<T[K]>, T[K]> : StripPrismaFilters<T[K]> extends never ? never : T[K] extends object ? T[K] extends Date | null | undefined ? T[K] : FlattenRelations<StripPrismaFilters<T[K]>> : StripPrismaFilters<T[K]>;
+    [K in keyof T]: IsArrayRelation<T[K]> extends true ? FlattenArrayRelation<T[K]> | undefined : IsObjectRelation<T[K]> extends true ? XOR<FlattenObjectRelation<T[K]> | undefined, T[K]> : StripPrismaFilters<T[K]> extends never ? never : T[K] extends object ? T[K] extends Date | null | undefined ? T[K] : FlattenRelations<StripPrismaFilters<T[K]>> | undefined : StripToScalar<T[K]> extends never ? StripPrismaFilters<T[K]> : StripToScalar<T[K]>;
 };
 /**
  * Flattens Prisma relation inputs into a simpler, developer-friendly format
@@ -152,7 +156,7 @@ type FlattenRelations<T> = {
  * ]}
  * ```
  *
- * @see {@link https://wwww.arkosjs.com/docs/api-reference/arkos-prisma-input}
+ * @see {@link https://wwww.arkosjs.com/docs/reference/arkos-prisma-input}
  * @template T - The Prisma input type (e.g., Prisma.UserCreateInput)
  * @returns A flattened version of the input type with simplified relation handling
  */

package/dist/types/types/arkos.d.ts

@@ -1,7 +1,8 @@
 import { Express } from "express";
 import { IncomingMessage, Server, ServerResponse } from "http";
 import { ArkosAuthRouteHookInstance, ArkosFileUploadRouteHookInstance, ArkosRouteHookInstance } from "../components/arkos-route-hook/types";
-import { ArkosServiceHookInstance } from "../components/arkos-service-hook/types";
+import { IArkosRouter } from "../exports";
+type ArkosRouterMethods = "get" | "post" | "put" | "patch" | "delete" | "options" | "head" | "all" | "use" | "trace" | "route" | "use" | "load";
 /**
  * Creates and configures an Arkos application instance.
  *
@@ -43,20 +44,8 @@ import { ArkosServiceHookInstance } from "../components/arkos-service-hook/types
  *
  * @see {@link https://www.arkosjs.com/docs/core-concepts/routing/setup}
  */
-export interface Arkos extends Omit<Express, "listen"> {
+export interface Arkos extends Omit<Express, "listen" | ArkosRouterMethods>, Pick<IArkosRouter, ArkosRouterMethods> {
     (req: IncomingMessage, res: ServerResponse): void;
-    /**
-     * Loads Arkos-specific instances into the app for internal usage.
-     * Unlike use(), load() has no order — it simply makes the loaded
-     * data available for Arkos to apply where needed.
-     */
-    load(...items: ArkosLoadable[]): this;
-    /**
-     * Loads Arkos-specific instances into the app for internal usage.
-     * Unlike use(), load() has no order — it simply makes the loaded
-     * data available for Arkos to apply where needed.
-     */
-    load(items: ArkosLoadable[] | ArkosLoadable): this;
     /**
      * Applies all loaded items to the app by adding them as middleware,
      * routers, or handlers at the end of the stack.
@@ -85,4 +74,5 @@ export interface Arkos extends Omit<Express, "listen"> {
  * Union of all valid types that can be passed to `app.load()`.
  * Grows as new Arkos-specific loadable types are introduced.
  */
-export type ArkosLoadable = ArkosRouteHookInstance<any> | ArkosAuthRouteHookInstance | ArkosFileUploadRouteHookInstance | ArkosServiceHookInstance<any, any>;
+export type ArkosLoadable = ArkosRouteHookInstance<any> | ArkosAuthRouteHookInstance | ArkosFileUploadRouteHookInstance;
+export {};

package/dist/types/types/auth.d.ts

@@ -25,7 +25,7 @@ export type DetailedAccessControlRule = {
  * Rules defining access control for different controller actions.
  * The array contains role names that are allowed to perform the action.
  *
- * @see {@link https://www.arkosjs.com/docs/core-concepts/authentication-system#using-auth-config-to-customize-endpoint-behavior}
+ * @see {@link https://www.arkosjs.com/docs/core-concepts/authentication/setup#using-auth-config-to-customize-endpoint-behavior}
  * @example
  *
  * const rules: AccessControlRules = {
@@ -46,7 +46,7 @@ export type AccessControlRules = {
 /**
  * Rules defining authentication requirements for different controller actions.
  *
- * @see {@link https://www.arkosjs.com/docs/core-concepts/authentication-system#using-auth-config-to-customize-endpoint-behavior}
+ * @see {@link https://www.arkosjs.com/docs/core-concepts/authentication/setup#using-auth-config-to-customize-endpoint-behavior}
  * @example
  * const authRules: AuthenticationControlRules = {
  *   Create: true,
@@ -75,7 +75,7 @@ export type AuthenticationControlConfig = boolean | Partial<AuthenticationContro
 /**
  * Configuration for access control.
  *
- * @see {@link https://www.arkosjs.com/docs/core-concepts/authentication-system#auth-config-files---static-rbac}
+ * @see {@link https://www.arkosjs.com/docs/core-concepts/authentication/setup#auth-config-files---static-rbac}
  * @example
  * // All actions allowed for these roles
  * const config1: AccessControlConfig = ["Admin", "Manager"];
@@ -90,7 +90,7 @@ export type AccessControlConfig = UserRole[] | Partial<AccessControlRules> | "*"
 /**
  * Configuration for authentication and access control.
  *
- * @see {@link https://www.arkosjs.com/docs/core-concepts/authentication-system#using-auth-config-to-customize-endpoint-behavior}
+ * @see {@link https://www.arkosjs.com/docs/core-concepts/authentication/setup#using-auth-config-to-customize-endpoint-behavior}
  * @example
  * export const authConfig: AuthConfigs = {
  *   authenticationControl: {

package/dist/types/types/index.d.ts

@@ -1,6 +1,7 @@
-import { ErrorRequestHandler, NextFunction, RequestHandler, Response, Request } from "express";
+import { NextFunction, Response, Request } from "express";
 import { PrismaModels } from "../generated";
-export type PrismaOperations = "findMany";
+import { ArkosFile } from "./upload";
+import type { ArkosRequestInternalState } from "./internal";
 /**
  * Type definition for authentication-related Prisma query operations
  * @template T - The Prisma model delegate type
@@ -121,53 +122,6 @@ type BasePrismaQueryOptions<T extends Record<string, any>> = {
  * @template ModelName - The model name (defaults to string for standard models)
  */
 export type PrismaQueryOptions<T extends Record<string, any>, ModelName extends string = string> = ModelName extends "auth" ? AuthPrismaQueryOptions<T> : BasePrismaQueryOptions<T>;
-/**
- * Interface defining the minimum structure required for Prisma model delegates
- * This allows us to constraint TModel without requiring Prisma imports
- */
-export type PrismaModelDelegate = {
-    create: (args: {
-        data: never;
-        [key: string]: never;
-    }) => Promise<any>;
-    createMany: (args: {
-        data: never;
-        [key: string]: never;
-    }) => Promise<any>;
-    findMany: (args: {
-        [key: string]: never;
-    }) => Promise<any[]>;
-    findFirst: (args: {
-        where: never;
-        [key: string]: never;
-    }) => Promise<any>;
-    findUnique: (args: {
-        where: never;
-        [key: string]: never;
-    }) => Promise<any>;
-    update: (args: {
-        where: never;
-        data: never;
-        [key: string]: never;
-    }) => Promise<any>;
-    updateMany: (args: {
-        where: never;
-        data: never;
-        [key: string]: never;
-    }) => Promise<any>;
-    delete: (args: {
-        where: never;
-        [key: string]: never;
-    }) => Promise<any>;
-    deleteMany: (args: {
-        where: never;
-        [key: string]: never;
-    }) => Promise<any>;
-    count: (args: {
-        where: never;
-        [key: string]: never;
-    }) => Promise<number>;
-};
 export interface BaseUser extends Record<string, any> {
     id: string;
     isSuperUser: boolean;
@@ -187,19 +141,19 @@ export type UserRole = User extends {
 } ? R[number] : User extends {
     role: infer R;
 } ? R : string;
-export interface ArkosRequest<P extends Record<string, any> = any, ResBody = any, ReqBody = any, Query extends Record<string, any> = any> extends Request<P, ResBody, ReqBody, Query> {
+export interface ArkosRequest<P extends Record<string, any> = any, ResBody = any, ReqBody = any, Query extends Record<string, any> = any, Locals extends Record<string, any> = Record<string, any>> extends Request<P, ResBody, ReqBody, Query, Locals> {
     /**
      * Authenticated user
      */
     user?: User;
     /**
-     * Single uploaded file, populated when using `multer.single()`
+     * Single uploaded file, populated when using `{ uploads: { type: "single" }}`
      */
-    file?: Express.Multer.File;
+    file?: ArkosFile;
     /**
-     * Uploaded files, populated when using `multer.array()` or `multer.fields()`.
+     * Uploaded files, populated when using `{ uploads: { type: "array" }}` or `{ uploads: { type: "fileds" }}`.
      */
-    files?: Express.Multer.File[] | Record<string, Express.Multer.File[]>;
+    files?: ArkosFile[] | Record<string, ArkosFile[]>;
     /**
      * Fields to include in relational queries
      */
@@ -248,13 +202,16 @@ export interface ArkosRequest<P extends Record<string, any> = any, ResBody = any
      * Name of the Prisma model being queried
      */
     modelName?: string;
+    /**
+     * @internal Upload state resolved by Arkos.
+     */
+    __arkos?: ArkosRequestInternalState;
 }
 export interface ArkosResponse<ResBody = any, Locals extends Record<string, any> = Record<string, any>> extends Response<ResBody, Locals> {
 }
 export interface ArkosNextFunction extends NextFunction {
 }
-export interface ArkosRequestHandler<P extends Record<string, any> = any, ResBody = any, ReqBody = any, ReqQuery = qs.ParsedQs, Locals extends Record<string, any> = Record<string, any>> extends RequestHandler<P, ResBody, ReqBody, ReqQuery, Locals> {
-}
-export interface ArkosErrorRequestHandler<P extends Record<string, any> = any, ResBody = any, ReqBody = any, ReqQuery = qs.ParsedQs, Locals extends Record<string, any> = Record<string, any>> extends ErrorRequestHandler<P, ResBody, ReqBody, ReqQuery, Locals> {
-}
+export type ArkosRequestHandler<P extends Record<string, any> = any, ResBody = any, ReqBody = any, ReqQuery extends Record<string, any> = any, Locals extends Record<string, any> = Record<string, any>> = (req: ArkosRequest<P, ResBody, ReqBody, ReqQuery>, res: ArkosResponse<ResBody, Locals>, next: ArkosNextFunction) => unknown;
+export type ArkosErrorRequestHandler<P extends Record<string, any> = any, ResBody = any, ReqBody = any, ReqQuery extends Record<string, any> = any, Locals extends Record<string, any> = Record<string, any>> = (err: any, req: ArkosRequest<P, ResBody, ReqBody, ReqQuery>, res: ArkosResponse<ResBody, Locals>, next: ArkosNextFunction) => unknown;
+export type ArkosAnyRequestHandler<P extends Record<string, any> = any, ResBody = any, ReqBody = any, ReqQuery extends Record<string, any> = any, Locals extends Record<string, any> = Record<string, any>> = ArkosRequestHandler<P, ResBody, ReqBody, ReqQuery, Locals> | ArkosErrorRequestHandler<P, ResBody, ReqBody, ReqQuery, Locals> | Array<ArkosRequestHandler<P, ResBody, ReqBody, ReqQuery, Locals> | ArkosErrorRequestHandler<P, ResBody, ReqBody, ReqQuery, Locals>>;
 export {};

package/dist/types/types/internal.d.ts

@@ -0,0 +1,25 @@
+import type { UploadConfig } from "../utils/arkos-router/types/upload-config";
+import type { UploadDirParams } from "./upload";
+export type ArkosFileInternalState = {
+    uploadDir?: string;
+    urlPath?: string;
+    urlPathExact?: boolean;
+    dirParams?: UploadDirParams;
+    uploadPath?: string;
+    targetPath?: string;
+};
+export type ArkosRequestInternalState = {
+    uploadConfig?: UploadConfig;
+    uploadDir?: string;
+    uploadPath?: string;
+    uploadKind?: "file" | "directory";
+    preparedUploads?: Map<string, {
+        dirParams: UploadDirParams;
+        uploadDir: string;
+        urlPath: string;
+        urlPathExact: boolean;
+    }>;
+    uploadFileIndexes?: Record<string, number>;
+    uploadTargetPaths?: Set<string>;
+    uploadWrittenPaths?: string[];
+};