@modular-rest/server 1.16.2 → 1.17.1

package/dist/application.js

@@ -104,13 +104,41 @@ async function createRest(options) {
     /**
      * Plug In KoaStatic
      */
-    if (config_1.config.staticPath) {
-        const defaultStaticPath = config_1.config.staticPath.actualPath || '';
-        const defaultStaticRootPath = config_1.config.staticPath.path || '/assets';
-        const staticOptions = { ...config_1.config.staticPath, defer: true };
-        delete staticOptions.actualPath;
-        delete staticOptions.path;
-        app.use((0, koa_mount_1.default)(defaultStaticRootPath, (0, koa_static_1.default)(defaultStaticPath, staticOptions)));
+    // Collect static paths from new property or fallback to old property
+    let staticPathsToMount = [];
+    if (config_1.config.staticPaths && config_1.config.staticPaths.length > 0) {
+        // Use new staticPaths property
+        staticPathsToMount = config_1.config.staticPaths;
+    }
+    else if (config_1.config.staticPath) {
+        // Backward compatibility: use old staticPath property with deprecation warning
+        console.warn('\x1b[33m%s\x1b[0m', "Warning: 'staticPath' is deprecated and will be removed in a future version. Please use 'staticPaths' (array) instead.");
+        staticPathsToMount = Array.isArray(config_1.config.staticPath) ? config_1.config.staticPath : [config_1.config.staticPath];
+    }
+    // Mount all static paths
+    for (const staticPathConfig of staticPathsToMount) {
+        const directory = staticPathConfig.directory || '';
+        const urlPath = staticPathConfig.urlPath || '/assets';
+        const staticOptions = { ...staticPathConfig, defer: true };
+        delete staticOptions.directory;
+        delete staticOptions.urlPath;
+        app.use((0, koa_mount_1.default)(urlPath, (0, koa_static_1.default)(directory, staticOptions)));
+    }
+    // Auto-mount uploadDirectoryConfig if staticPaths (new property) is configured
+    if (config_1.config.staticPaths && config_1.config.staticPaths.length > 0 && config_1.config.uploadDirectoryConfig) {
+        const uploadDirectory = config_1.config.uploadDirectoryConfig.directory || '';
+        const uploadUrlPath = config_1.config.uploadDirectoryConfig.urlPath || '/assets';
+        const uploadStaticOptions = {
+            ...config_1.config.uploadDirectoryConfig,
+            defer: true,
+        };
+        delete uploadStaticOptions.directory;
+        delete uploadStaticOptions.urlPath;
+        app.use((0, koa_mount_1.default)(uploadUrlPath, (0, koa_static_1.default)(uploadDirectory, uploadStaticOptions)));
+    }
+    // Show deprecation warning for old uploadDirectory property
+    if (config_1.config.uploadDirectory) {
+        console.warn('\x1b[33m%s\x1b[0m', "Warning: 'uploadDirectory' is deprecated and will be removed in a future version. Please use 'uploadDirectoryConfig' (StaticPathOptions) instead.");
     }
     /**
      * Run before hook
@@ -185,7 +213,7 @@ async function createRest(options) {
     }
     // 4. Setting up default services
     try {
-        await require('./helper/presetup_services').setup(options);
+        await require('./helper/presetup_services').setup(config_1.config);
     }
     catch (e) {
         return Promise.reject(e);

package/dist/config.d.ts

@@ -8,16 +8,17 @@ import { Options as KoaStaticOptionsBase } from 'koa-static';
 /**
  * The options for the static file server, it's a combination of modular-rest and [koa-static options](https://github.com/koajs/static?tab=readme-ov-file#options)
  */
-export type StaticPathOptions = KoaStaticOptionsBase & {
+export interface StaticPathOptions extends KoaStaticOptionsBase {
     /**
-     * The actual path of the static files on your server
+     * The filesystem directory where static files are stored
      */
-    actualPath: string;
+    directory: string;
     /**
-     * The path you want to serve the static files from
+     * The URL path where static files will be served from
+     * @default '/assets'
      */
-    path: string;
-};
+    urlPath?: string;
+}
 /**
  * JWT keypair configuration
  * @interface KeyPair
@@ -53,9 +54,9 @@ interface AdminUser {
  * @interface RestOptions
  * @property {KoaCorsOptions} [cors] - CORS configuration [options](https://github.com/koajs/cors?tab=readme-ov-file#corsoptions)
  * @property {string} [modulesPath] - Path to custom modules directory
- * @property {string} [uploadDirectory] - Directory for file uploads
+ * @property {StaticPathOptions[]} [staticPaths] - Array of static file serving configurations
+ * @property {StaticPathOptions} [uploadDirectoryConfig] - Upload directory configuration with static path info
  * @property {any} [koaBodyOptions] - Options for koa-body middleware
- * @property {StaticPathOptions} [staticPath] - Static file serving options
  * @property {Function} [onBeforeInit] - Hook called before initialization
  * @property {Function} [onAfterInit] - Hook called after initialization
  * @property {number} [port] - Port to listen on
@@ -69,13 +70,15 @@ interface AdminUser {
  * @property {CmsTrigger[]} [authTriggers] - Authentication triggers
  * @property {CmsTrigger[]} [fileTriggers] - File handling triggers
  * @property {DefinedFunction[]} [functions] - Custom API functions
+ * @property {string} [uploadDirectory] - @deprecated Use uploadDirectoryConfig instead. Directory for file uploads
+ * @property {StaticPathOptions | StaticPathOptions[]} [staticPath] - @deprecated Use staticPaths instead. Static file serving options
  */
 export interface RestOptions {
     cors?: KoaCorsOptions;
     modulesPath?: string;
-    uploadDirectory?: string;
+    staticPaths?: StaticPathOptions[];
+    uploadDirectoryConfig?: StaticPathOptions;
     koaBodyOptions?: any;
-    staticPath?: StaticPathOptions;
     onBeforeInit?: (koaApp: Koa) => void;
     onAfterInit?: (koaApp: Koa) => void;
     port?: number;
@@ -89,6 +92,14 @@ export interface RestOptions {
     authTriggers?: CmsTrigger[];
     fileTriggers?: CmsTrigger[];
     functions?: DefinedFunction[];
+    /**
+     * @deprecated Use uploadDirectoryConfig instead. This property will be removed in a future version.
+     */
+    uploadDirectory?: string;
+    /**
+     * @deprecated Use staticPaths instead. This property will be removed in a future version.
+     */
+    staticPath?: StaticPathOptions | StaticPathOptions[];
 }
 /**
  * Global configuration object

package/dist/helper/presetup_services.d.ts

@@ -1,3 +1,4 @@
+import { StaticPathOptions } from '../config';
 /**
  * Setup options interface for initializing required services
  * @interface SetupOptions
@@ -7,7 +8,8 @@
  * @property {Object} adminUser - Admin user configuration
  * @property {string} adminUser.email - Admin user email address
  * @property {string} adminUser.password - Admin user password
- * @property {string} [uploadDirectory] - Directory for file uploads
+ * @property {StaticPathOptions} [uploadDirectoryConfig] - Upload directory configuration with static path info
+ * @property {string} [uploadDirectory] - @deprecated Use uploadDirectoryConfig instead. Directory for file uploads
  */
 interface SetupOptions {
     keypair?: {
@@ -18,6 +20,10 @@ interface SetupOptions {
         email: string;
         password: string;
     };
+    uploadDirectoryConfig?: StaticPathOptions;
+    /**
+     * @deprecated Use uploadDirectoryConfig instead. This property will be removed in a future version.
+     */
     uploadDirectory?: string;
 }
 /**
@@ -34,7 +40,7 @@ interface SetupOptions {
  *
  * @example
  * ```typescript
- * // Setup with custom keypair
+ * // Setup with custom keypair and uploadDirectoryConfig
  * await setup({
  *   keypair: {
  *     private: 'your-private-key',
@@ -44,7 +50,10 @@ interface SetupOptions {
  *     email: 'admin@example.com',
  *     password: 'secure-password'
  *   },
- *   uploadDirectory: './uploads'
+ *   uploadDirectoryConfig: {
+ *     directory: './uploads',
+   *     urlPath: '/assets'
+ *   }
  * });
  *
  * // Setup with auto-generated keypair
@@ -56,5 +65,5 @@ interface SetupOptions {
  * });
  * ```
  */
-export declare function setup({ keypair, adminUser, uploadDirectory }: SetupOptions): Promise<void>;
+export declare function setup({ keypair, adminUser, uploadDirectory, uploadDirectoryConfig, }: SetupOptions): Promise<void>;
 export {};

package/dist/helper/presetup_services.js

@@ -40,6 +40,7 @@ exports.setup = setup;
 const DataInsertion = __importStar(require("./data_insertion"));
 const JWT = __importStar(require("../services/jwt/service"));
 const FileService = __importStar(require("../services/file/service"));
+const config_1 = require("../config");
 const keypair_1 = __importDefault(require("keypair"));
 /**
  * Sets up required services for the application to run
@@ -55,7 +56,7 @@ const keypair_1 = __importDefault(require("keypair"));
  *
  * @example
  * ```typescript
- * // Setup with custom keypair
+ * // Setup with custom keypair and uploadDirectoryConfig
  * await setup({
  *   keypair: {
  *     private: 'your-private-key',
@@ -65,7 +66,10 @@ const keypair_1 = __importDefault(require("keypair"));
  *     email: 'admin@example.com',
  *     password: 'secure-password'
  *   },
- *   uploadDirectory: './uploads'
+ *   uploadDirectoryConfig: {
+ *     directory: './uploads',
+   *     urlPath: '/assets'
+ *   }
  * });
  *
  * // Setup with auto-generated keypair
@@ -77,7 +81,7 @@ const keypair_1 = __importDefault(require("keypair"));
  * });
  * ```
  */
-async function setup({ keypair, adminUser, uploadDirectory }) {
+async function setup({ keypair, adminUser, uploadDirectory, uploadDirectoryConfig, }) {
     /**
      * Json web Token
      *
@@ -90,7 +94,7 @@ async function setup({ keypair, adminUser, uploadDirectory }) {
     }
     JWT.main.setKies(keyPairToUse.private, keyPairToUse.public);
     if (!adminUser) {
-        throw new Error('Admin user is not supported in TypeScript version');
+        throw new Error('Admin user configuration is required. Please provide adminUser in your createRest() options.');
     }
     /**
      * Data Insertion
@@ -102,7 +106,14 @@ async function setup({ keypair, adminUser, uploadDirectory }) {
     /**
      * File Service
      */
-    if (uploadDirectory) {
+    // Check for uploadDirectoryConfig from global config first, then from options
+    const uploadConfigToUse = config_1.config.uploadDirectoryConfig || uploadDirectoryConfig;
+    if (uploadConfigToUse) {
+        FileService.main.setUploadDirectory(uploadConfigToUse);
+    }
+    else if (uploadDirectory) {
+        // Backward compatibility: use old uploadDirectory property with deprecation warning
+        console.warn('\x1b[33m%s\x1b[0m', "Warning: 'uploadDirectory' is deprecated and will be removed in a future version. Please use 'uploadDirectoryConfig' (StaticPathOptions) instead.");
         FileService.main.setUploadDirectory(uploadDirectory);
     }
 }

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 import { createRest } from './application';
 import { Schema } from 'mongoose';
+import { StaticPathOptions, RestOptions } from './config';
 import * as paginator from './class/paginator';
 import * as reply from './class/reply';
 import { validator } from './class/validator';
@@ -23,6 +24,28 @@ import * as middleware from './middlewares';
  * @returns A new REST API instance
  */
 export { createRest };
+/**
+ * @description Configuration types for creating a REST API instance
+ * @example
+ * ```typescript
+ * import { RestOptions, StaticPathOptions } from '@modular-rest/server-ts';
+ *
+ * const config: RestOptions = {
+ *   port: 3000,
+ *   staticPaths: [
+ *     {
+ *       directory: './public',
+ *       urlPath: '/static'
+ *     }
+ *   ],
+ *   uploadDirectoryConfig: {
+ *     directory: './uploads',
+   *     urlPath: '/assets'
+ *   }
+ * };
+ * ```
+ */
+export type { RestOptions, StaticPathOptions };
 export { CollectionDefinition, defineCollection };
 /**
  * @description Provides predefined database schemas

package/dist/services/file/service.d.ts

@@ -1,3 +1,4 @@
+import { StaticPathOptions } from '../../config';
 import { IFile } from '../../class/db_schemas';
 /**
  * Service name constant
@@ -51,6 +52,10 @@ declare class FileService {
      * @hidden
      */
     private directory;
+    /**
+     * @hidden
+     */
+    private urlPath;
     /**
      * @hidden
      */
@@ -63,16 +68,23 @@ declare class FileService {
      * @hidden
      *
      * Sets the upload directory for file storage
-     * @param {string} directory - Directory path for file storage
+     * @param {string | StaticPathOptions} directoryOrConfig - Directory path for file storage or StaticPathOptions configuration
      * @throws {Error} If directory is invalid or not writable
      * @example
      * ```typescript
      * import { fileService } from '@modular-rest/server';
      *
+     * // New format with StaticPathOptions
+     * fileService.setUploadDirectory({
+     *   directory: '/path/to/uploads',
+     *   urlPath: '/assets'
+     * });
+     *
+     * // Legacy format (deprecated)
      * fileService.setUploadDirectory('/path/to/uploads');
      * ```
      */
-    setUploadDirectory(directory: string): void;
+    setUploadDirectory(directoryOrConfig: string | StaticPathOptions): void;
     /**
      * @hidden
      *
@@ -170,13 +182,13 @@ declare class FileService {
      *
      * @param {string} fileId - File ID to get link for
      * @returns {Promise<string>} Promise resolving to file URL
-     * @throws {Error} If static path root is not defined or file is not found
+     * @throws {Error} If URL path is not defined or file is not found
      * @example
      * ```typescript
      * import { fileService } from '@modular-rest/server';
      *
      * const link = await fileService.getFileLink('file123');
-     * // Returns: '/static/jpeg/profile/1234567890.jpeg'
+     * // Returns: '/uploads/jpeg/profile/1234567890.jpeg'
      * ```
      */
     getFileLink(fileId: string): Promise<string>;

package/dist/services/file/service.js

@@ -41,7 +41,6 @@ const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
 const DataProvider = __importStar(require("../data_provider/service"));
 const trigger_operator_1 = __importDefault(require("../../class/trigger_operator"));
-const config_1 = require("../../config");
 /**
  * Service name constant
  * @constant {string}
@@ -63,25 +62,54 @@ class FileService {
          * @hidden
          */
         this.directory = null;
+        /**
+         * @hidden
+         */
+        this.urlPath = null;
     }
     /**
      * @hidden
      *
      * Sets the upload directory for file storage
-     * @param {string} directory - Directory path for file storage
+     * @param {string | StaticPathOptions} directoryOrConfig - Directory path for file storage or StaticPathOptions configuration
      * @throws {Error} If directory is invalid or not writable
      * @example
      * ```typescript
      * import { fileService } from '@modular-rest/server';
      *
+     * // New format with StaticPathOptions
+     * fileService.setUploadDirectory({
+     *   directory: '/path/to/uploads',
+     *   urlPath: '/assets'
+     * });
+     *
+     * // Legacy format (deprecated)
      * fileService.setUploadDirectory('/path/to/uploads');
      * ```
      */
-    setUploadDirectory(directory) {
+    setUploadDirectory(directoryOrConfig) {
+        // Handle backward compatibility with string
+        if (typeof directoryOrConfig === 'string') {
+            console.warn('\x1b[33m%s\x1b[0m', "Warning: Passing a string to 'setUploadDirectory' is deprecated. Please use StaticPathOptions object instead.");
+            if (!fs_1.default.existsSync(directoryOrConfig)) {
+                fs_1.default.mkdirSync(directoryOrConfig, { recursive: true });
+            }
+            this.directory = directoryOrConfig;
+            this.urlPath = null; // No URL path available with legacy format
+            return;
+        }
+        // New format: Extract only necessary properties from StaticPathOptions
+        const directory = directoryOrConfig.directory || '';
+        const urlPath = directoryOrConfig.urlPath || '/assets';
+        if (!directory) {
+            throw new Error('directory is required in uploadDirectoryConfig');
+        }
         if (!fs_1.default.existsSync(directory)) {
             fs_1.default.mkdirSync(directory, { recursive: true });
         }
+        // Store only the necessary properties (ignore koa-static options)
         this.directory = directory;
+        this.urlPath = urlPath;
     }
     /**
      * @hidden
@@ -295,21 +323,21 @@ class FileService {
      *
      * @param {string} fileId - File ID to get link for
      * @returns {Promise<string>} Promise resolving to file URL
-     * @throws {Error} If static path root is not defined or file is not found
+     * @throws {Error} If URL path is not defined or file is not found
      * @example
      * ```typescript
      * import { fileService } from '@modular-rest/server';
      *
      * const link = await fileService.getFileLink('file123');
-     * // Returns: '/static/jpeg/profile/1234567890.jpeg'
+     * // Returns: '/uploads/jpeg/profile/1234567890.jpeg'
      * ```
      */
     async getFileLink(fileId) {
         const fileDoc = await FileService.instance.getFile(fileId);
-        if (!config_1.config.staticPath?.actualPath) {
-            throw new Error('Static path root is not defined');
+        if (!FileService.instance.urlPath) {
+            throw new Error('Upload directory URL path is not defined. Please configure uploadDirectoryConfig with a urlPath property.');
         }
-        const link = config_1.config.staticPath.actualPath + `/${fileDoc.format}/${fileDoc.tag}/` + fileDoc.fileName;
+        const link = `${FileService.instance.urlPath}/${fileDoc.format}/${fileDoc.tag}/${fileDoc.fileName}`;
         return link;
     }
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@modular-rest/server",
-	"version": "1.16.2",
+	"version": "1.17.1",
 	"description": "TypeScript version of a nodejs module based on KOAJS for developing Rest-APIs in a modular solution.",
 	"main": "dist/index.js",
 	"types": "dist/index.d.ts",

package/src/application.ts

@@ -74,16 +74,56 @@ export async function createRest(options: RestOptions): Promise<{ app: Koa; serv
   /**
    * Plug In KoaStatic
    */
-  if (config.staticPath) {
-    const defaultStaticPath = config.staticPath.actualPath || '';
-    const defaultStaticRootPath = config.staticPath.path || '/assets';
+  // Collect static paths from new property or fallback to old property
+  let staticPathsToMount: StaticPathOptions[] = [];
+
+  if (config.staticPaths && config.staticPaths.length > 0) {
+    // Use new staticPaths property
+    staticPathsToMount = config.staticPaths;
+  } else if (config.staticPath) {
+    // Backward compatibility: use old staticPath property with deprecation warning
+    console.warn(
+      '\x1b[33m%s\x1b[0m',
+      "Warning: 'staticPath' is deprecated and will be removed in a future version. Please use 'staticPaths' (array) instead."
+    );
+    staticPathsToMount = Array.isArray(config.staticPath) ? config.staticPath : [config.staticPath];
+  }
+
+  // Mount all static paths
+  for (const staticPathConfig of staticPathsToMount) {
+    const directory = staticPathConfig.directory || '';
+    const urlPath = staticPathConfig.urlPath || '/assets';
+
+    const staticOptions: Partial<StaticPathOptions> = { ...staticPathConfig, defer: true };
 
-    const staticOptions: Partial<StaticPathOptions> = { ...config.staticPath, defer: true };
+    delete staticOptions.directory;
+    delete staticOptions.urlPath;
+
+    app.use(mount(urlPath, koaStatic(directory, staticOptions)));
+  }
 
-    delete staticOptions.actualPath;
-    delete staticOptions.path;
+  // Auto-mount uploadDirectoryConfig if staticPaths (new property) is configured
+  if (config.staticPaths && config.staticPaths.length > 0 && config.uploadDirectoryConfig) {
+    const uploadDirectory = config.uploadDirectoryConfig.directory || '';
+    const uploadUrlPath = config.uploadDirectoryConfig.urlPath || '/assets';
+
+    const uploadStaticOptions: Partial<StaticPathOptions> = {
+      ...config.uploadDirectoryConfig,
+      defer: true,
+    };
+
+    delete uploadStaticOptions.directory;
+    delete uploadStaticOptions.urlPath;
+
+    app.use(mount(uploadUrlPath, koaStatic(uploadDirectory, uploadStaticOptions)));
+  }
 
-    app.use(mount(defaultStaticRootPath, koaStatic(defaultStaticPath, staticOptions)));
+  // Show deprecation warning for old uploadDirectory property
+  if (config.uploadDirectory) {
+    console.warn(
+      '\x1b[33m%s\x1b[0m',
+      "Warning: 'uploadDirectory' is deprecated and will be removed in a future version. Please use 'uploadDirectoryConfig' (StaticPathOptions) instead."
+    );
   }
 
   /**
@@ -172,7 +212,7 @@ export async function createRest(options: RestOptions): Promise<{ app: Koa; serv
 
   // 4. Setting up default services
   try {
-    await require('./helper/presetup_services').setup(options);
+    await require('./helper/presetup_services').setup(config);
   } catch (e) {
     return Promise.reject(e);
   }

package/src/config.ts

@@ -10,16 +10,17 @@ import { Options as KoaStaticOptionsBase } from 'koa-static';
 /**
  * The options for the static file server, it's a combination of modular-rest and [koa-static options](https://github.com/koajs/static?tab=readme-ov-file#options)
  */
-export type StaticPathOptions = KoaStaticOptionsBase & {
+export interface StaticPathOptions extends KoaStaticOptionsBase {
   /**
-   * The actual path of the static files on your server
+   * The filesystem directory where static files are stored
    */
-  actualPath: string;
+  directory: string;
   /**
-   * The path you want to serve the static files from
+   * The URL path where static files will be served from
+   * @default '/assets'
    */
-  path: string;
-};
+  urlPath?: string;
+}
 
 /**
  * JWT keypair configuration
@@ -59,9 +60,9 @@ interface AdminUser {
  * @interface RestOptions
  * @property {KoaCorsOptions} [cors] - CORS configuration [options](https://github.com/koajs/cors?tab=readme-ov-file#corsoptions)
  * @property {string} [modulesPath] - Path to custom modules directory
- * @property {string} [uploadDirectory] - Directory for file uploads
+ * @property {StaticPathOptions[]} [staticPaths] - Array of static file serving configurations
+ * @property {StaticPathOptions} [uploadDirectoryConfig] - Upload directory configuration with static path info
  * @property {any} [koaBodyOptions] - Options for koa-body middleware
- * @property {StaticPathOptions} [staticPath] - Static file serving options
  * @property {Function} [onBeforeInit] - Hook called before initialization
  * @property {Function} [onAfterInit] - Hook called after initialization
  * @property {number} [port] - Port to listen on
@@ -75,13 +76,15 @@ interface AdminUser {
  * @property {CmsTrigger[]} [authTriggers] - Authentication triggers
  * @property {CmsTrigger[]} [fileTriggers] - File handling triggers
  * @property {DefinedFunction[]} [functions] - Custom API functions
+ * @property {string} [uploadDirectory] - @deprecated Use uploadDirectoryConfig instead. Directory for file uploads
+ * @property {StaticPathOptions | StaticPathOptions[]} [staticPath] - @deprecated Use staticPaths instead. Static file serving options
  */
 export interface RestOptions {
   cors?: KoaCorsOptions;
   modulesPath?: string;
-  uploadDirectory?: string;
+  staticPaths?: StaticPathOptions[];
+  uploadDirectoryConfig?: StaticPathOptions;
   koaBodyOptions?: any;
-  staticPath?: StaticPathOptions;
   onBeforeInit?: (koaApp: Koa) => void;
   onAfterInit?: (koaApp: Koa) => void;
   port?: number;
@@ -95,6 +98,14 @@ export interface RestOptions {
   authTriggers?: CmsTrigger[];
   fileTriggers?: CmsTrigger[];
   functions?: DefinedFunction[];
+  /**
+   * @deprecated Use uploadDirectoryConfig instead. This property will be removed in a future version.
+   */
+  uploadDirectory?: string;
+  /**
+   * @deprecated Use staticPaths instead. This property will be removed in a future version.
+   */
+  staticPath?: StaticPathOptions | StaticPathOptions[];
 }
 
 /**

package/src/helper/presetup_services.ts

@@ -1,6 +1,7 @@
 import * as DataInsertion from './data_insertion';
 import * as JWT from '../services/jwt/service';
 import * as FileService from '../services/file/service';
+import { config, StaticPathOptions } from '../config';
 import generateKeypair from 'keypair';
 
 /**
@@ -12,7 +13,8 @@ import generateKeypair from 'keypair';
  * @property {Object} adminUser - Admin user configuration
  * @property {string} adminUser.email - Admin user email address
  * @property {string} adminUser.password - Admin user password
- * @property {string} [uploadDirectory] - Directory for file uploads
+ * @property {StaticPathOptions} [uploadDirectoryConfig] - Upload directory configuration with static path info
+ * @property {string} [uploadDirectory] - @deprecated Use uploadDirectoryConfig instead. Directory for file uploads
  */
 interface SetupOptions {
   keypair?: {
@@ -23,6 +25,10 @@ interface SetupOptions {
     email: string;
     password: string;
   };
+  uploadDirectoryConfig?: StaticPathOptions;
+  /**
+   * @deprecated Use uploadDirectoryConfig instead. This property will be removed in a future version.
+   */
   uploadDirectory?: string;
 }
 
@@ -40,7 +46,7 @@ interface SetupOptions {
  *
  * @example
  * ```typescript
- * // Setup with custom keypair
+ * // Setup with custom keypair and uploadDirectoryConfig
  * await setup({
  *   keypair: {
  *     private: 'your-private-key',
@@ -50,7 +56,10 @@ interface SetupOptions {
  *     email: 'admin@example.com',
  *     password: 'secure-password'
  *   },
- *   uploadDirectory: './uploads'
+ *   uploadDirectoryConfig: {
+ *     directory: './uploads',
+   *     urlPath: '/assets'
+ *   }
  * });
  *
  * // Setup with auto-generated keypair
@@ -62,7 +71,12 @@ interface SetupOptions {
  * });
  * ```
  */
-export async function setup({ keypair, adminUser, uploadDirectory }: SetupOptions): Promise<void> {
+export async function setup({
+  keypair,
+  adminUser,
+  uploadDirectory,
+  uploadDirectoryConfig,
+}: SetupOptions): Promise<void> {
   /**
    * Json web Token
    *
@@ -77,7 +91,7 @@ export async function setup({ keypair, adminUser, uploadDirectory }: SetupOption
   JWT.main.setKies(keyPairToUse.private, keyPairToUse.public);
 
   if (!adminUser) {
-    throw new Error('Admin user is not supported in TypeScript version');
+    throw new Error('Admin user configuration is required. Please provide adminUser in your createRest() options.');
   }
   /**
    * Data Insertion
@@ -90,7 +104,17 @@ export async function setup({ keypair, adminUser, uploadDirectory }: SetupOption
   /**
    * File Service
    */
-  if (uploadDirectory) {
+  // Check for uploadDirectoryConfig from global config first, then from options
+  const uploadConfigToUse = config.uploadDirectoryConfig || uploadDirectoryConfig;
+
+  if (uploadConfigToUse) {
+    FileService.main.setUploadDirectory(uploadConfigToUse);
+  } else if (uploadDirectory) {
+    // Backward compatibility: use old uploadDirectory property with deprecation warning
+    console.warn(
+      '\x1b[33m%s\x1b[0m',
+      "Warning: 'uploadDirectory' is deprecated and will be removed in a future version. Please use 'uploadDirectoryConfig' (StaticPathOptions) instead."
+    );
     FileService.main.setUploadDirectory(uploadDirectory);
   }
 }

package/src/index.ts

@@ -2,6 +2,9 @@
 import { createRest } from './application';
 import { Schema } from 'mongoose';
 
+// Configuration types
+import { StaticPathOptions, RestOptions } from './config';
+
 // Utilities
 import * as paginator from './class/paginator';
 import * as reply from './class/reply';
@@ -37,6 +40,29 @@ import * as middleware from './middlewares';
  */
 export { createRest };
 
+/**
+ * @description Configuration types for creating a REST API instance
+ * @example
+ * ```typescript
+ * import { RestOptions, StaticPathOptions } from '@modular-rest/server-ts';
+ *
+ * const config: RestOptions = {
+ *   port: 3000,
+ *   staticPaths: [
+ *     {
+ *       directory: './public',
+ *       urlPath: '/static'
+ *     }
+ *   ],
+ *   uploadDirectoryConfig: {
+ *     directory: './uploads',
+   *     urlPath: '/assets'
+ *   }
+ * };
+ * ```
+ */
+export type { RestOptions, StaticPathOptions };
+
 export { CollectionDefinition, defineCollection };
 
 /**

package/src/services/file/service.ts

@@ -2,7 +2,7 @@ import fs from 'fs';
 import pathModule from 'path';
 import * as DataProvider from '../data_provider/service';
 import triggerService from '../../class/trigger_operator';
-import { config } from '../../config';
+import { config, StaticPathOptions } from '../../config';
 import { IFile } from '../../class/db_schemas';
 
 /**
@@ -61,6 +61,11 @@ class FileService {
    */
   private directory: string | null = null;
 
+  /**
+   * @hidden
+   */
+  private urlPath: string | null = null;
+
   /**
    * @hidden
    */
@@ -75,20 +80,52 @@ class FileService {
    * @hidden
    *
    * Sets the upload directory for file storage
-   * @param {string} directory - Directory path for file storage
+   * @param {string | StaticPathOptions} directoryOrConfig - Directory path for file storage or StaticPathOptions configuration
    * @throws {Error} If directory is invalid or not writable
    * @example
    * ```typescript
    * import { fileService } from '@modular-rest/server';
    *
+   * // New format with StaticPathOptions
+   * fileService.setUploadDirectory({
+   *   directory: '/path/to/uploads',
+   *   urlPath: '/assets'
+   * });
+   *
+   * // Legacy format (deprecated)
    * fileService.setUploadDirectory('/path/to/uploads');
    * ```
    */
-  setUploadDirectory(directory: string): void {
+  setUploadDirectory(directoryOrConfig: string | StaticPathOptions): void {
+    // Handle backward compatibility with string
+    if (typeof directoryOrConfig === 'string') {
+      console.warn(
+        '\x1b[33m%s\x1b[0m',
+        "Warning: Passing a string to 'setUploadDirectory' is deprecated. Please use StaticPathOptions object instead."
+      );
+      if (!fs.existsSync(directoryOrConfig)) {
+        fs.mkdirSync(directoryOrConfig, { recursive: true });
+      }
+      this.directory = directoryOrConfig;
+      this.urlPath = null; // No URL path available with legacy format
+      return;
+    }
+
+    // New format: Extract only necessary properties from StaticPathOptions
+    const directory = directoryOrConfig.directory || '';
+    const urlPath = directoryOrConfig.urlPath || '/assets';
+
+    if (!directory) {
+      throw new Error('directory is required in uploadDirectoryConfig');
+    }
+
     if (!fs.existsSync(directory)) {
       fs.mkdirSync(directory, { recursive: true });
     }
+
+    // Store only the necessary properties (ignore koa-static options)
     this.directory = directory;
+    this.urlPath = urlPath;
   }
 
   /**
@@ -333,24 +370,25 @@ class FileService {
    *
    * @param {string} fileId - File ID to get link for
    * @returns {Promise<string>} Promise resolving to file URL
-   * @throws {Error} If static path root is not defined or file is not found
+   * @throws {Error} If URL path is not defined or file is not found
    * @example
    * ```typescript
    * import { fileService } from '@modular-rest/server';
    *
    * const link = await fileService.getFileLink('file123');
-   * // Returns: '/static/jpeg/profile/1234567890.jpeg'
+   * // Returns: '/uploads/jpeg/profile/1234567890.jpeg'
    * ```
    */
   async getFileLink(fileId: string): Promise<string> {
     const fileDoc = await FileService.instance.getFile(fileId);
 
-    if (!config.staticPath?.actualPath) {
-      throw new Error('Static path root is not defined');
+    if (!FileService.instance.urlPath) {
+      throw new Error(
+        'Upload directory URL path is not defined. Please configure uploadDirectoryConfig with a urlPath property.'
+      );
     }
 
-    const link =
-      config.staticPath.actualPath + `/${fileDoc.format}/${fileDoc.tag}/` + fileDoc.fileName;
+    const link = `${FileService.instance.urlPath}/${fileDoc.format}/${fileDoc.tag}/${fileDoc.fileName}`;
 
     return link;
   }