arkos 1.4.0-canary.9 → 1.4.0-canary.91

package/dist/types/utils/arkos-router/types/body-parser-config.d.ts

@@ -0,0 +1,18 @@
+import express from "express";
+import { Options as MulterOptions } from "multer";
+export type BodyParserConfig = {
+    parser: "json";
+    options?: Parameters<typeof express.json>[0];
+} | {
+    parser: "urlencoded";
+    options?: Parameters<typeof express.urlencoded>[0];
+} | {
+    parser: "raw";
+    options?: Parameters<typeof express.raw>[0];
+} | {
+    parser: "multipart";
+    options?: MulterOptions["limits"];
+} | {
+    parser: "text";
+    options?: Parameters<typeof express.text>[0];
+};

package/dist/types/utils/arkos-router/types/index.d.ts

@@ -1,7 +1,14 @@
-import { ErrorRequestHandler, IRouter, RequestHandler } from "express";
-import { OpenAPIV3 } from "openapi-types";
+import { IRouter } from "express";
 import { ZodSchema } from "zod";
-type MethodHandler = (configOrPath: ArkosRouteConfig, ...handlers: (RequestHandler | ErrorRequestHandler)[]) => IArkosRouter;
+import { Options as RateLimitOptions } from "express-rate-limit";
+import { Options as QueryParserOptions } from "../../../utils/helpers/query-parser.helpers";
+import { DetailedAccessControlRule } from "../../../types/auth";
+import { ArkosErrorRequestHandler, ArkosRequestHandler } from "../../../types";
+import compression from "compression";
+import { OpenApiConfig } from "./openapi-config";
+import { UploadConfig } from "./upload-config";
+import { BodyParserConfig } from "./body-parser-config";
+type MethodHandler = (config: ArkosRouteConfig, ...handlers: (ArkosRequestHandler | ArkosErrorRequestHandler)[]) => IRouter;
 export interface IArkosRouter extends Omit<IRouter, "get" | "post" | "put" | "patch" | "delete" | "options" | "head" | "trace" | "all"> {
     get: MethodHandler;
     post: MethodHandler;
@@ -14,17 +21,25 @@ export interface IArkosRouter extends Omit<IRouter, "get" | "post" | "put" | "pa
     all: MethodHandler;
 }
 export interface ArkosRouteConfig {
-    route: string;
+    disabled?: boolean;
+    path: string;
     authentication?: boolean | {
         resource: string;
         action: string;
-        rule?: any;
+        rule?: DetailedAccessControlRule | string[];
     };
-    validation?: undefined | {
-        query?: ZodSchema | (new (...args: any[]) => object) | undefined;
-        body?: ZodSchema | (new (...args: any[]) => object) | undefined;
-        params?: ZodSchema | (new (...args: any[]) => object) | undefined;
+    validation?: false | {
+        query?: ZodSchema | (new (...args: any[]) => object) | false;
+        body?: ZodSchema | (new (...args: any[]) => object) | false;
+        params?: ZodSchema | (new (...args: any[]) => object) | false;
+    };
+    rateLimit?: Partial<RateLimitOptions>;
+    compression?: compression.CompressionOptions;
+    queryParser?: QueryParserOptions;
+    bodyParser?: BodyParserConfig | BodyParserConfig[] | false;
+    experimental?: {
+        openapi?: false | OpenApiConfig;
+        uploads?: UploadConfig;
     };
-    openapi?: boolean | Partial<OpenAPIV3.OperationObject>;
 }
 export {};

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

@@ -0,0 +1,35 @@
+import { OpenAPIV3 } from "openapi-types";
+import { ZodSchema } from "zod";
+type SchemaLike = ZodSchema | (new (...args: any[]) => object) | OpenAPIV3.SchemaObject;
+type ExtendedMediaTypeObject = Omit<OpenAPIV3.MediaTypeObject, "schema"> & {
+    schema: SchemaLike;
+};
+export type ExtendedParameterObject = Omit<OpenAPIV3.ParameterObject, "schema"> & {
+    schema?: SchemaLike;
+};
+type ResponseDefinition = SchemaLike | {
+    content: SchemaLike;
+    description?: string;
+} | (Omit<OpenAPIV3.ResponseObject, "content"> & {
+    content?: {
+        [media: string]: ExtendedMediaTypeObject;
+    };
+});
+type RequestBodyDefinition = SchemaLike | {
+    content: SchemaLike;
+    required?: boolean;
+    description?: string;
+} | (Omit<OpenAPIV3.RequestBodyObject, "content"> & {
+    content: {
+        [media: string]: ExtendedMediaTypeObject;
+    };
+});
+type ExtendedOperationObject = Omit<OpenAPIV3.OperationObject, "responses" | "requestBody"> & {
+    responses?: {
+        [statusCode: number]: ResponseDefinition;
+    };
+    requestBody?: RequestBodyDefinition;
+    parameters?: (ExtendedParameterObject | OpenAPIV3.ReferenceObject)[];
+};
+export type OpenApiConfig = false | Partial<ExtendedOperationObject>;
+export {};

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

@@ -0,0 +1,21 @@
+export type UploadConfig = ({
+    type: "single";
+    field: string;
+} & ArkosRouterBaseUploadConfig) | ({
+    type: "array";
+    field: string;
+    maxCount?: number;
+} & ArkosRouterBaseUploadConfig) | ({
+    type: "fields";
+    fields: {
+        name: string;
+        maxCount?: number;
+    }[];
+} & ArkosRouterBaseUploadConfig);
+export type ArkosRouterBaseUploadConfig = {
+    uploadDir?: string;
+    deleteOnError?: boolean;
+    attachToBody?: "pathname" | "url" | "file" | false;
+    maxSize?: number;
+    allowedFileTypes?: string[] | RegExp;
+};

package/dist/types/utils/arkos-router/utils/helpers/upload-manager.d.ts

@@ -0,0 +1,13 @@
+import { UploadConfig } from "../../types/upload-config";
+import { ArkosNextFunction, ArkosRequest, ArkosResponse } from "../../../../exports";
+import { RequestHandler } from "express";
+declare class UploadManager {
+    private getUpload;
+    getMiddleware(config: UploadConfig): RequestHandler;
+    handleUpload(config: UploadConfig, oldFilePath?: string): any;
+    handleFileCleanup(config: UploadConfig): (err: any, req: ArkosRequest, _: ArkosResponse, next: ArkosNextFunction) => Promise<void>;
+    handlePostUpload(config: UploadConfig): any;
+    private fileFilter;
+}
+declare const uploadManager: UploadManager;
+export default uploadManager;

package/dist/types/utils/cli/export-auth-action.d.ts

@@ -0,0 +1,4 @@
+export default function exportAuthActionCommand(options: {
+    overwrite?: boolean;
+    path?: string;
+}): Promise<void>;

package/dist/types/utils/cli/generate.d.ts

@@ -1,6 +1,7 @@
 interface GenerateOptions {
     path?: string;
-    model: string;
+    model?: string;
+    module?: string;
 }
 export declare const generateCommand: {
     controller: (options: GenerateOptions) => Promise<void>;

package/dist/types/utils/cli/utils/runtime-cli-commander.d.ts

@@ -0,0 +1,11 @@
+declare class RuntimeCliCommander {
+    getOptions(): {
+        overwrite?: boolean;
+        path: string;
+    };
+    end(): void;
+    handle(): Promise<void>;
+    exportAuthAction(): Promise<void>;
+}
+declare const runtimeCliCommander: RuntimeCliCommander;
+export default runtimeCliCommander;

package/dist/types/utils/cli/utils/watermark-stamper.d.ts

@@ -1,8 +1,8 @@
 declare class WatermarkStamper {
     stamp({ envFiles, host, port, }: {
-        envFiles: string[] | undefined;
-        host: string | undefined;
-        port: string | undefined;
+        envFiles?: string[];
+        host?: string;
+        port?: string;
     }): void;
 }
 declare const watermarkStamper: WatermarkStamper;

package/dist/types/utils/features/port-and-host-allocator.d.ts

@@ -1,8 +1,10 @@
 import { ArkosConfig } from "../../exports";
 declare class PortAndHostAllocator {
-    private host;
-    private port;
+    host: string | undefined;
+    private networkHost;
+    port: string | undefined;
     private prevWarnings;
+    getFirstNonLocalIp(): string | undefined;
     getCorrectHostAndPortToUse(env: Record<string, any>, config?: ArkosConfig): {
         port: string;
         host: string;

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

@@ -0,0 +1,7 @@
+import { ArkosConfig } from "../../types/new-arkos-config";
+export declare function isUsingAuthentication(): "static" | "dynamic" | undefined;
+export declare function isAuthenticationEnabled(): boolean | undefined;
+export declare const defaultArkosConfig: ArkosConfig & {
+    available?: boolean;
+};
+export declare function getArkosConfig(): ArkosConfig;

package/dist/types/utils/helpers/dynamic-loader.helpers.d.ts

@@ -1,3 +1,4 @@
 import { ArkosConfig, RouterConfig } from "../../exports";
 export declare function applyStrictRoutingRules<T extends string>(appModule: T, arkosConfig: ArkosConfig, moduleConfig?: RouterConfig<T>): RouterConfig<T>;
+export declare function validateRouterConfigConsistency(appModule: string, config: Record<string, any>): void;
 export declare function pathExists(path: string): Promise<boolean>;

package/dist/types/utils/helpers/query-parser.helpers.d.ts

@@ -5,6 +5,7 @@ export interface Options {
     parseUndefined?: boolean;
     parseBoolean?: boolean;
     parseNumber?: boolean;
+    parseDoubleUnderscore?: boolean;
 }
 export declare const parse: (target: ParsedQuery, options: Options) => ParsedQuery;
 export declare const queryParser: (options: Options) => (req: ArkosRequest, res: ArkosResponse, next: ArkosNextFunction) => void;

package/dist/types/utils/helpers/routers.helpers.d.ts

@@ -1,6 +1,16 @@
+import { AuthConfigs } from "../../types/auth";
+import { AuthRouterEndpoint, RouterConfig, RouterEndpoint } from "../../types/router-config";
+import { ArkosRouteConfig } from "../arkos-router/types";
+import { ArkosConfig } from "../../exports";
 export declare const safeCatchAsync: (middleware: any, options?: {
     type: "error" | "normal";
 }) => any;
 export declare const processMiddleware: (middleware: any, options?: {
     type: "error" | "normal";
 }) => any[];
+export declare function getAuthenticationConfig(endpoint: RouterEndpoint | AuthRouterEndpoint, modelName: string, authConfigs?: AuthConfigs): boolean | {
+    resource: string;
+    action: string;
+    rule: string[] | import("../../types/auth").DetailedAccessControlRule | undefined;
+};
+export declare function createRouteConfig(arkosConfig: ArkosConfig, endpoint: RouterEndpoint | AuthRouterEndpoint, routeName: string, path: string, routerConfig: RouterConfig<any>, modelNameInKebab: string, authConfigs: any, validationSchema?: any): ArkosRouteConfig;

package/dist/types/utils/prisma/prisma-json-schema-generator.d.ts

@@ -11,7 +11,7 @@ export interface GeneratedSchemas {
 }
 export declare class PrismaJsonSchemaGenerator {
     schema: import("./types").PrismaSchema;
-    generateModelSchemas(config: SchemaGenerationConfig): Promise<GeneratedSchemas>;
+    generateModelSchemas(config: SchemaGenerationConfig): GeneratedSchemas;
     private generateAuthSchemas;
     private generateCrudSchemas;
     private generateCreateSchema;

package/dist/types/utils/validate-schema.d.ts

@@ -1,2 +1,2 @@
 import { ZodSchema } from "zod";
-export default function validateSchema<T>(schema: ZodSchema<T>, data: unknown): Promise<T>;
+export default function validateSchema<T>(schema: ZodSchema<T>, data: unknown, options?: any): Promise<T>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "arkos",
-  "version": "1.4.0-canary.9",
+  "version": "1.4.0-canary.91",
   "description": "The Express & Prisma RESTful Framework",
   "main": "dist/cjs/exports/index.js",
   "module": "dist/esm/exports/index.js",
@@ -194,9 +194,10 @@
     "swagger-ui-express": "^5.0.1",
     "trash-cli": "6.0.0",
     "zod": "^3.24.2",
+    "tsx-strict": "^0.2.0",
     "zod-to-json-schema": "^3.24.6"
   },
   "engines": {
-    "node": ">=14.16"
+    "node": ">=20.16"
   }
 }

package/dist/cjs/utils/cli/utils/template-generator/templates/controller-template.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"controller-template.js","sourceRoot":"","sources":["../../../../../../../src/utils/cli/utils/template-generator/templates/controller-template.ts"],"names":[],"mappings":";;AAEA,gEAsCC;AAtCD,SAAgB,0BAA0B,CAAC,OAAwB;IACjE,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC;IAEvC,IAAI,CAAC,SAAS;QACZ,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAC;IAGrE,MAAM,SAAS,GAAG,SAAS,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC;IAChD,IAAI,cAAwD,CAAC;IAC7D,IAAI,cAAsB,CAAC;IAC3B,IAAI,gBAAwB,CAAC;IAE7B,IAAI,SAAS,KAAK,YAAY,EAAE,CAAC;QAC/B,cAAc,GAAG,YAAY,CAAC;QAC9B,cAAc,GAAG,sBAAsB,CAAC;QACxC,gBAAgB,GAAG,OAAO,EAAE,oBAAoB,IAAI,mBAAmB,CAAC;IAC1E,CAAC;SAAM,IAAI,SAAS,KAAK,MAAM,EAAE,CAAC;QAChC,cAAc,GAAG,MAAM,CAAC;QACxB,cAAc,GAAG,gBAAgB,CAAC;QAClC,gBAAgB,GAAG,OAAO,EAAE,cAAc,IAAI,mBAAmB,CAAC;IACpE,CAAC;SAAM,IAAI,SAAS,KAAK,OAAO,EAAE,CAAC;QACjC,cAAc,GAAG,OAAO,CAAC;QACzB,cAAc,GAAG,iBAAiB,CAAC;QACnC,gBAAgB,GAAG,OAAO,EAAE,eAAe,IAAI,mBAAmB,CAAC;IACrE,CAAC;SAAM,CAAC;QACN,cAAc,GAAG,MAAM,CAAC;QACxB,cAAc,GAAG,gBAAgB,CAAC;QAClC,gBAAgB,GAAG,OAAO,EAAE,cAAc,IAAI,mBAAmB,CAAC;IACpE,CAAC;IAED,MAAM,qBAAqB,GAAG,YAAY,cAAc,YAAY,gBAAgB,IAAI,CAAC;IAEzF,OAAO,GAAG,qBAAqB;;QAEzB,SAAS,CAAC,MAAM,sBAAsB,cAAc;QACpD,SAAS,CAAC,KAAK,oBAAoB,SAAS,CAAC,MAAM,cAAc,cAAc,KAAK,MAAM,CAAC,CAAC,CAAC,IAAI,SAAS,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,EAAE;iBAC/G,SAAS,CAAC,KAAK;CAC/B,CAAC;AACF,CAAC","sourcesContent":["import { TemplateOptions } from \"../../template-generators\";\n\nexport function generateControllerTemplate(options: TemplateOptions): string {\n  const { modelName, imports } = options;\n\n  if (!modelName)\n    throw new Error(\"Module name is required for controller template\");\n\n  // Determine which controller to extend based on model name\n  const camelName = modelName.camel.toLowerCase();\n  let controllerType: \"fileUpload\" | \"auth\" | \"email\" | \"base\";\n  let controllerName: string;\n  let controllerImport: string;\n\n  if (camelName === \"fileupload\") {\n    controllerType = \"fileUpload\";\n    controllerName = \"FileUploadController\";\n    controllerImport = imports?.fileUploadController || \"arkos/controllers\";\n  } else if (camelName === \"auth\") {\n    controllerType = \"auth\";\n    controllerName = \"AuthController\";\n    controllerImport = imports?.authController || \"arkos/controllers\";\n  } else if (camelName === \"email\") {\n    controllerType = \"email\";\n    controllerName = \"EmailController\";\n    controllerImport = imports?.emailController || \"arkos/controllers\";\n  } else {\n    controllerType = \"base\";\n    controllerName = \"BaseController\";\n    controllerImport = imports?.baseController || \"arkos/controllers\";\n  }\n\n  const controllerClassImport = `import { ${controllerName} } from \"${controllerImport}\";`;\n\n  return `${controllerClassImport}\n  \nclass ${modelName.pascal}Controller extends ${controllerName} {}\nconst ${modelName.camel}Controller = new ${modelName.pascal}Controller(${controllerType === \"base\" ? `\"${modelName.kebab}\"` : \"\"});\nexport default ${modelName.camel}Controller;\n`;\n}\n"]}

package/dist/esm/utils/cli/utils/template-generator/templates/controller-template.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"controller-template.js","sourceRoot":"","sources":["../../../../../../../src/utils/cli/utils/template-generator/templates/controller-template.ts"],"names":[],"mappings":"AAEA,MAAM,UAAU,0BAA0B,CAAC,OAAwB;IACjE,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC;IAEvC,IAAI,CAAC,SAAS;QACZ,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAC;IAGrE,MAAM,SAAS,GAAG,SAAS,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC;IAChD,IAAI,cAAwD,CAAC;IAC7D,IAAI,cAAsB,CAAC;IAC3B,IAAI,gBAAwB,CAAC;IAE7B,IAAI,SAAS,KAAK,YAAY,EAAE,CAAC;QAC/B,cAAc,GAAG,YAAY,CAAC;QAC9B,cAAc,GAAG,sBAAsB,CAAC;QACxC,gBAAgB,GAAG,OAAO,EAAE,oBAAoB,IAAI,mBAAmB,CAAC;IAC1E,CAAC;SAAM,IAAI,SAAS,KAAK,MAAM,EAAE,CAAC;QAChC,cAAc,GAAG,MAAM,CAAC;QACxB,cAAc,GAAG,gBAAgB,CAAC;QAClC,gBAAgB,GAAG,OAAO,EAAE,cAAc,IAAI,mBAAmB,CAAC;IACpE,CAAC;SAAM,IAAI,SAAS,KAAK,OAAO,EAAE,CAAC;QACjC,cAAc,GAAG,OAAO,CAAC;QACzB,cAAc,GAAG,iBAAiB,CAAC;QACnC,gBAAgB,GAAG,OAAO,EAAE,eAAe,IAAI,mBAAmB,CAAC;IACrE,CAAC;SAAM,CAAC;QACN,cAAc,GAAG,MAAM,CAAC;QACxB,cAAc,GAAG,gBAAgB,CAAC;QAClC,gBAAgB,GAAG,OAAO,EAAE,cAAc,IAAI,mBAAmB,CAAC;IACpE,CAAC;IAED,MAAM,qBAAqB,GAAG,YAAY,cAAc,YAAY,gBAAgB,IAAI,CAAC;IAEzF,OAAO,GAAG,qBAAqB;;QAEzB,SAAS,CAAC,MAAM,sBAAsB,cAAc;QACpD,SAAS,CAAC,KAAK,oBAAoB,SAAS,CAAC,MAAM,cAAc,cAAc,KAAK,MAAM,CAAC,CAAC,CAAC,IAAI,SAAS,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,EAAE;iBAC/G,SAAS,CAAC,KAAK;CAC/B,CAAC;AACF,CAAC","sourcesContent":["import { TemplateOptions } from \"../../template-generators\";\n\nexport function generateControllerTemplate(options: TemplateOptions): string {\n  const { modelName, imports } = options;\n\n  if (!modelName)\n    throw new Error(\"Module name is required for controller template\");\n\n  // Determine which controller to extend based on model name\n  const camelName = modelName.camel.toLowerCase();\n  let controllerType: \"fileUpload\" | \"auth\" | \"email\" | \"base\";\n  let controllerName: string;\n  let controllerImport: string;\n\n  if (camelName === \"fileupload\") {\n    controllerType = \"fileUpload\";\n    controllerName = \"FileUploadController\";\n    controllerImport = imports?.fileUploadController || \"arkos/controllers\";\n  } else if (camelName === \"auth\") {\n    controllerType = \"auth\";\n    controllerName = \"AuthController\";\n    controllerImport = imports?.authController || \"arkos/controllers\";\n  } else if (camelName === \"email\") {\n    controllerType = \"email\";\n    controllerName = \"EmailController\";\n    controllerImport = imports?.emailController || \"arkos/controllers\";\n  } else {\n    controllerType = \"base\";\n    controllerName = \"BaseController\";\n    controllerImport = imports?.baseController || \"arkos/controllers\";\n  }\n\n  const controllerClassImport = `import { ${controllerName} } from \"${controllerImport}\";`;\n\n  return `${controllerClassImport}\n  \nclass ${modelName.pascal}Controller extends ${controllerName} {}\nconst ${modelName.camel}Controller = new ${modelName.pascal}Controller(${controllerType === \"base\" ? `\"${modelName.kebab}\"` : \"\"});\nexport default ${modelName.camel}Controller;\n`;\n}\n"]}