@modular-rest/server 1.12.1 → 1.13.0

package/dist/class/user.js

@@ -102,7 +102,7 @@ class User {
     static loadFromModel(model) {
         return new Promise((done, reject) => {
             // check required fields
-            const isValidData = (0, validator_1.validator)(model, 'fullname email password permission');
+            const isValidData = (0, validator_1.validator)(model, '_id permissionGroup');
             if (!isValidData.isValid) {
                 return reject(User.notValid(model));
             }

package/dist/config.d.ts

@@ -3,9 +3,12 @@ import { CollectionDefinition } from './class/collection_definition';
 import { PermissionGroup } from './class/security';
 import { CmsTrigger } from './class/cms_trigger';
 import { DefinedFunction } from './services/functions/service';
-import cors from '@koa/cors';
+import { Options as KoaCorsOptions } from '@koa/cors';
 import { Options as KoaStaticOptionsBase } from 'koa-static';
-export interface StaticPathOptions extends KoaStaticOptionsBase {
+/**
+ * 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 & {
     /**
      * The actual path of the static files on your server
      */
@@ -14,7 +17,7 @@ export interface StaticPathOptions extends KoaStaticOptionsBase {
      * The path you want to serve the static files from
      */
     path: string;
-}
+};
 /**
  * JWT keypair configuration
  * @interface KeyPair
@@ -30,12 +33,10 @@ interface KeyPair {
  * @interface MongoOptions
  * @property {string} dbPrefix - Prefix for database names
  * @property {string} mongoBaseAddress - MongoDB connection URL
- * @property {string} [addressMap] - Optional address mapping configuration
  */
 interface MongoOptions {
     dbPrefix: string;
     mongoBaseAddress: string;
-    addressMap?: string;
 }
 /**
  * Admin user configuration
@@ -50,7 +51,7 @@ interface AdminUser {
 /**
  * Configuration options for creating a REST API instance
  * @interface RestOptions
- * @property {cors.Options} [cors] - CORS configuration options
+ * @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 {any} [koaBodyOptions] - Options for koa-body middleware
@@ -70,7 +71,7 @@ interface AdminUser {
  * @property {DefinedFunction[]} [functions] - Custom API functions
  */
 export interface RestOptions {
-    cors?: cors.Options;
+    cors?: KoaCorsOptions;
     modulesPath?: string;
     uploadDirectory?: string;
     koaBodyOptions?: any;

package/dist/defult-permissions.d.ts

@@ -1,2 +1,2 @@
-import { PermissionGroup } from './index';
+import { PermissionGroup } from './class/security';
 export declare const permissionGroups: PermissionGroup[];

package/dist/defult-permissions.js

@@ -1,14 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.permissionGroups = void 0;
-const index_1 = require("./index");
+const security_1 = require("./class/security");
 exports.permissionGroups = [
-    new index_1.PermissionGroup({
+    new security_1.PermissionGroup({
         title: 'anonymous',
         isAnonymous: true,
         allowedAccessTypes: ['anonymous_access'],
     }),
-    new index_1.PermissionGroup({
+    new security_1.PermissionGroup({
         title: 'end-user',
         isDefault: true,
         allowedAccessTypes: [
@@ -18,7 +18,7 @@ exports.permissionGroups = [
             'remove_file_access',
         ],
     }),
-    new index_1.PermissionGroup({
+    new security_1.PermissionGroup({
         title: 'administrator',
         allowedAccessTypes: [
             'user_access',

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@modular-rest/server",
-	"version": "1.12.1",
+	"version": "1.13.0",
 	"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/class/user.ts

@@ -146,7 +146,7 @@ export class User {
   static loadFromModel(model: any): Promise<User> {
     return new Promise((done, reject) => {
       // check required fields
-      const isValidData = validateObject(model, 'fullname email password permission');
+      const isValidData = validateObject(model, '_id permissionGroup');
 
       if (!isValidData.isValid) {
         return reject(User.notValid(model));

package/src/config.ts

@@ -4,10 +4,13 @@ import { CollectionDefinition } from './class/collection_definition';
 import { PermissionGroup } from './class/security';
 import { CmsTrigger } from './class/cms_trigger';
 import { DefinedFunction } from './services/functions/service';
-import cors from '@koa/cors';
+import { Options as KoaCorsOptions } from '@koa/cors';
 import { Options as KoaStaticOptionsBase } from 'koa-static';
 
-export interface StaticPathOptions extends KoaStaticOptionsBase {
+/**
+ * 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 & {
   /**
    * The actual path of the static files on your server
    */
@@ -16,7 +19,7 @@ export interface StaticPathOptions extends KoaStaticOptionsBase {
    * The path you want to serve the static files from
    */
   path: string;
-}
+};
 
 /**
  * JWT keypair configuration
@@ -34,12 +37,10 @@ interface KeyPair {
  * @interface MongoOptions
  * @property {string} dbPrefix - Prefix for database names
  * @property {string} mongoBaseAddress - MongoDB connection URL
- * @property {string} [addressMap] - Optional address mapping configuration
  */
 interface MongoOptions {
   dbPrefix: string;
   mongoBaseAddress: string;
-  addressMap?: string;
 }
 
 /**
@@ -56,7 +57,7 @@ interface AdminUser {
 /**
  * Configuration options for creating a REST API instance
  * @interface RestOptions
- * @property {cors.Options} [cors] - CORS configuration options
+ * @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 {any} [koaBodyOptions] - Options for koa-body middleware
@@ -76,7 +77,7 @@ interface AdminUser {
  * @property {DefinedFunction[]} [functions] - Custom API functions
  */
 export interface RestOptions {
-  cors?: cors.Options;
+  cors?: KoaCorsOptions;
   modulesPath?: string;
   uploadDirectory?: string;
   koaBodyOptions?: any;

package/src/defult-permissions.ts

@@ -1,4 +1,4 @@
-import { PermissionGroup } from './index';
+import { PermissionGroup } from './class/security';
 
 export const permissionGroups = [
   new PermissionGroup({

package/typedoc.mjs

@@ -2,10 +2,10 @@ export default {
   plugin: ['typedoc-plugin-missing-exports', 'typedoc-plugin-markdown'],
 
   disableSources: true,
-  excludeProtected: false,
+  excludeProtected: true,
   excludeInternal: false,
   excludePrivate: false,
-  excludeExternals: false,
+  excludeExternals: true,
 
   //
   // Formatting `typedoc-plugin-markdown`