@modular-rest/server 1.11.12 → 1.11.14

package/types/class/security.d.ts

@@ -1,109 +0,0 @@
-export type PermissionType = ('god_access' | 'user_access' | 'upload_file_access' | 'remove_file_access' | 'anonymous_access' | 'advanced_settings' | string);
-/**
- * Class representing an access definition.
- */
-export class AccessDefinition {
-    /**
-     * Create an access definition.
-     * @param {Object} options - The options for the access definition.
-     * @param {string} options.database - The name of the database.
-     * @param {string} options.collection - The name of the collection.
-     * @param {Array.<Permission>} options.permissionList - The list of permissions.
-     */
-    constructor({ database, collection, permissionList }: {
-        database: string;
-        collection: string;
-        permissionList: Array<Permission>;
-    });
-    database: string;
-    collection: string;
-    permissionList: Permission[];
-}
-/**
- * @typedef {('god_access'|'user_access'|'upload_file_access'|'remove_file_access'|'anonymous_access'|'advanced_settings'|string)} PermissionType
- */
-/**
- * Class representing a permission.
- */
-export class Permission {
-    /**
-     * Create a permission.
-     * @param {Object} options - The options for the permission.
-     * @param {PermissionType} options.type - The type of the permission.
-     * @param {boolean} [options.read=false] - The read access of the permission.
-     * @param {boolean} [options.write=false] - The write access of the permission.
-     * @param {boolean} [options.onlyOwnData=false] - If true, users can perform CRUD on documents that they created already.
-     * @param {string} [options.ownerIdField='refId'] - The name of the field that contains the owner's id of the document.
-     */
-    constructor({ type, read, write, onlyOwnData, ownerIdField, }: {
-        type: PermissionType;
-        read?: boolean;
-        write?: boolean;
-        onlyOwnData?: boolean;
-        ownerIdField?: string;
-    });
-    type: string;
-    read: boolean;
-    write: boolean;
-    onlyOwnData: boolean;
-    ownerIdField: string;
-}
-/**
- * Class representing different types of permissions.
- * Each static getter returns a string that represents a specific type of permission.
- */
-export class PermissionTypes {
-    /**
-     * Get the string representing god access permission type.
-     * @return {string} The god access permission type.
-     */
-    static get god_access(): string;
-    /**
-     * Get the string representing advanced settings permission type.
-     * @return {string} The advanced settings permission type.
-     */
-    static get advanced_settings(): string;
-    /**
-     * Get the string representing user access permission type.
-     * @return {string} The user access permission type.
-     */
-    static get user_access(): string;
-    /**
-     * Get the string representing upload file access permission type.
-     * @return {string} The upload file access permission type.
-     */
-    static get upload_file_access(): string;
-    /**
-     * Get the string representing remove file access permission type.
-     * @return {string} The remove file access permission type.
-     */
-    static get remove_file_access(): string;
-}
-export class PermissionGroup {
-    /**
-     * Create a permission group.
-     * @param {Object} options - The options for the permission group.
-     * @param {string} options.title - The title of the permission group.
-     * @param {boolean} [options.isDefault=false] - If true, the permission group is the default permission group.
-     * @param {boolean} [options.isAnonymous=false] - If true, the permission group is the anonymous permission group.
-     * @param {Array.<PermissionType>} [options.validPermissionTypes=[]] - The valid permission types of the permission group.
-     * @return {PermissionGroup} The created permission group.
-     */
-    constructor({ title, isDefault, isAnonymous, validPermissionTypes, }: {
-        title: string;
-        isDefault?: boolean;
-        isAnonymous?: boolean;
-        validPermissionTypes?: Array<PermissionType>;
-    });
-    title: string;
-    isDefault: boolean;
-    isAnonymous: boolean;
-    validPermissionTypes: string[];
-}
-/**
- * Class representing access types.
- */
-export class AccessTypes {
-    static get read(): string;
-    static get write(): string;
-}

package/types/class/trigger_operator.d.ts

@@ -1,19 +0,0 @@
-export = TriggerOperator.instance;
-declare var instance: TriggerOperator;
-declare class TriggerOperator {
-    static get instance(): TriggerOperator;
-    triggers: any[];
-    /**
-     * add a collection trigger
-     * @param {object} trigger DatabaseTrigger object
-     */
-    addTrigger(trigger: object): void;
-    /**
-     * Call a trigger
-     * @param {'find' | 'find-one' | 'count' | 'update-one' | 'insert-one' | 'remove-one' | 'aggregate'} operation operation name
-     * @param {string} database database name
-     * @param {string} collection collection name
-     * @param {string} data
-     */
-    call(operation: 'find' | 'find-one' | 'count' | 'update-one' | 'insert-one' | 'remove-one' | 'aggregate', database: string, collection: string, data: string): void;
-}

package/types/class/user.d.ts

@@ -1,24 +0,0 @@
-export = User;
-declare class User {
-    static loadFromModel(model: any): Promise<any>;
-    static createFromModel(model: any, detail: any): Promise<any>;
-    static notValid(object: any): string;
-    constructor(id: any, permissionGroup: any, phone: any, email: any, password: any, type: any, model: any);
-    id: any;
-    permissionGroup: any;
-    email: any;
-    phone: any;
-    password: any;
-    type: any;
-    dbModel: any;
-    getBrief(): {
-        id: any;
-        permissionGroup: import("./security").PermissionGroup;
-        phone: any;
-        email: any;
-        type: any;
-    };
-    setNewDetail(detail: any): void;
-    hasPermission(permissionField: any): boolean;
-    save(): Promise<void>;
-}

package/types/class/validator.d.ts

@@ -1,9 +0,0 @@
-export = validate;
-/**
- * Validates an object by checking if it contains all the required fields.
- * @param {Object} obj - The object to be validated.
- * @param {string|Object} requiredFields - The list of required fields. If it's a string, it should contain keys separated by spaces. If it's an object, it should contain key-value pairs where the key is the field name and the value is a boolean indicating whether the field is required or not.
- * @returns {boolean} - Returns true if the object contains all the required fields, otherwise returns false.
- * @throws {string} - Throws an error if the requiredFields parameter is not a string or an object.
- */
-declare function validate(obj: any, requiredFields: string | any): boolean;

package/types/config.d.ts

@@ -1,101 +0,0 @@
-export type Koa = import('koa');
-export type Cors = import('@koa/cors').Options;
-export type CollectionDefinition = import('./class/collection_definition.js');
-export type PermissionGroup = import('./class/security.js').PermissionGroup;
-export type CmsTrigger = import('./class/cms_trigger.js');
-export type Config = {
-    cors?: Cors;
-    modulesPath?: string;
-    koaBodyOptions?: object;
-    staticPath?: {
-        rootDir: string;
-        rootPath: string;
-        maxage?: number;
-        hidden?: boolean;
-        index?: string;
-        defer?: boolean;
-        gzip?: boolean;
-        br?: boolean;
-        setHeaders?: Function;
-        extensions?: boolean | any[];
-    };
-    onBeforeInit?: (koaApp: Koa) => void;
-    onAfterInit?: (koaApp: Koa) => void;
-    port?: number;
-    dontListen?: boolean;
-    mongo?: {
-        dbPrefix: string;
-        mongoBaseAddress: string;
-        addressMap?: string;
-    };
-    keypair?: {
-        private: string;
-        public: string;
-    };
-    adminUser?: {
-        email: string;
-        password: string;
-    };
-    verificationCodeGeneratorMethod: () => string;
-    collectionDefinitions?: CollectionDefinition[];
-    permissionGroups?: PermissionGroup[];
-    authTriggers?: DatabaseTrigger[];
-    fileTriggers?: CmsTrigger[];
-};
-/**
- * @param {Config} options
- */
-export function setConfig(options: Config): void;
-/**
- * @typedef {import('koa')} Koa
- * @typedef {import('@koa/cors').Options} Cors
- * @typedef {import('./class/collection_definition.js')} CollectionDefinition
- * @typedef {import('./class/security.js').PermissionGroup} PermissionGroup
- * @typedef {import('./class/cms_trigger.js')} CmsTrigger
- */
-/**
- * @typedef {{
- *   cors?: Cors; // CORS options.
- *   modulesPath?: string; // Root directory of your router.js/db.js files.
- *   koaBodyOptions?: object; // Options for koa-body.
- *    staticPath?: {
- *        rootDir: string; // Root directory of your static files.
- *        rootPath: string; // Root path of your static files, defaults to '/assets'.
- *        maxage?: number; // Browser cache max-age in milliseconds. Defaults to 0.
- *        hidden?: boolean; // Allow transfer of hidden files. Defaults to false.
- *        index?: string; // Default file name. Defaults to 'index.html'.
- *        defer?: boolean; // If true, serves after return next(), allowing any downstream middleware to respond first. Defaults to false.
- *        gzip?: boolean; // Try to serve the gzipped version of a file automatically when gzip is supported by a client and if the requested file with .gz extension exists. Defaults to true.
- *        br?: boolean; // Try to serve the brotli version of a file automatically when brotli is supported by a client and if the requested file with .br extension exists. Note that brotli is only accepted over https. Defaults to false.
- *        setHeaders?: Function; // Function to set custom headers on response.
- *        extensions?: boolean|Array; // Try to match extensions from passed array to search for file when no extension is suffixed in URL. First found is served. Defaults to false.
- *    };
- *   onBeforeInit?: (koaApp:Koa) => void; // A callback called before initializing the Koa server.
- *   onAfterInit?: (koaApp:Koa) => void; // A callback called after server initialization.
- *   port?: number; // Server port.
- *   dontListen?: boolean; // If true, the server will not run and will only return the Koa app object.
- *   mongo?: {
- *     dbPrefix: string; // A prefix for your database name.
- *     mongoBaseAddress: string; // The address of your MongoDB server without any database specification.
- *     addressMap?: string; // Specific addresses for each database.
- *   };
- *   keypair?: {
- *     private: string; // Private key for RSA authentication.
- *     public: string; // Public key for RSA authentication.
- *   };
- *   adminUser?: {
- *     email: string; // Admin user email.
- *     password: string; // Admin user password.
- *   };
- *   verificationCodeGeneratorMethod: () => string; // A method to return a verification code when registering a new user.
- *   collectionDefinitions?: CollectionDefinition[]; // An array of additional collection definitions.
- *   permissionGroups?: PermissionGroup[]; // An array of additional permission groups.
- *   authTriggers?: DatabaseTrigger[]; // An array of additional database triggers for the auth collection.
- *   fileTriggers?: CmsTrigger[]; // An array of additional database triggers for the auth collection.
- * }} Config
- * @exports Config
- */
-/**
- * @type {Config}
- */
-export const config: Config;

package/types/events.d.ts

@@ -1,7 +0,0 @@
-/**
- * onBeforeInit: (koaApp:Koa) => void; // A callback called before initializing the Koa server.
- * onAfterInit: (koaApp:Koa) => void; // A callback called after server initialization.
- * onNewUser:
- */
-declare function registerEventCallback(event: any, callback: any): void;
-declare const eventCallbacks: any[];

package/types/helper/data_insertion.d.ts

@@ -1,4 +0,0 @@
-export function createAdminUser({ email, password }: {
-    email: any;
-    password: any;
-}): Promise<never>;

package/types/helper/presetup_services.d.ts

@@ -1,5 +0,0 @@
-export function setup({ keypair, adminUser, uploadDirectory }: {
-    keypair: any;
-    adminUser: any;
-    uploadDirectory: any;
-}): Promise<void>;

package/types/index.d.ts

@@ -1,72 +0,0 @@
-declare const _exports: {
-    defineFunction: typeof defineFunction;
-    TypeCasters: {
-        ObjectId: import("mongoose").Types.ObjectIdConstructor;
-        Date: (dateValue: any) => Date;
-    };
-    validator: typeof validator;
-    reply: typeof reply;
-    paginator: typeof paginator;
-    getCollection: typeof getCollection;
-    getFile: (fileId: string) => Promise<any>;
-    getFileLink: (fileId: string) => Promise<any>;
-    getFilePath: (fileId: any) => Promise<string>;
-    removeFile: (fileId: string) => Promise<any>;
-    storeFile: ({ file, ownerId, tag, removeFileAfterStore }: {
-        file: {
-            path: string;
-            type: string;
-            name: string;
-            size: number;
-        };
-        ownerId: string;
-        tag: string;
-        removeFileAfterStore?: boolean;
-    }) => Promise<any>;
-    middleware: typeof middleware;
-    userManager: {
-        tempIds: {};
-        setCustomVerificationCodeGeneratorMethod(generatorMethod: Function): void;
-        verificationCodeGeneratorMethod: Function;
-        generateVerificationCode(id: string, idType: any): Promise<import("./class/user")>;
-        getUserById(id: string): Promise<import("./class/user")>;
-        getUserByIdentity(id: string, idType: string): Promise<import("./class/user")>;
-        getUserByToken(token: string): Promise<import("./class/user")>;
-        isCodeValid(id: string, code: string): boolean;
-        loginUser(id?: string, idType?: string, password?: string): Promise<string>;
-        issueTokenForUser(email: string): Promise<string>;
-        loginAnonymous(): Promise<string>;
-        registerTemporaryID(id: string, type: string, code: string): void;
-        submitPasswordForTemporaryID(id: string, password: string, code: string): Promise<boolean>;
-        changePasswordForTemporaryID(id: string, password: string, code: string): Promise<boolean>;
-        registerUser(detail: any): Promise<string>;
-        changePassword(query: any, newPass: string): Promise<void>;
-    };
-    AccessDefinition: typeof SecurityClass.AccessDefinition;
-    Permission: typeof SecurityClass.Permission;
-    PermissionTypes: typeof SecurityClass.PermissionTypes;
-    PermissionGroup: typeof SecurityClass.PermissionGroup;
-    AccessTypes: typeof SecurityClass.AccessTypes;
-    createRest: typeof createRest;
-    CollectionDefinition: typeof CollectionDefinition;
-    Schemas: {
-        file: Schema<import("mongoose").Document<any, any, any>, import("mongoose").Model<import("mongoose").Document<any, any, any>, any, any>, undefined, {}>;
-    };
-    Schema: typeof Schema;
-    DatabaseTrigger: typeof DatabaseTrigger;
-    CmsTrigger: typeof CmsTrigger;
-};
-export = _exports;
-import { defineFunction } from "./services/functions/service";
-import validator = require("./class/validator");
-import reply = require("./class/reply");
-import paginator = require("./class/paginator");
-import { getCollection } from "./services/data_provider/service";
-import middleware = require("./middlewares");
-import SecurityClass = require("./class/security");
-import createRest = require("./application");
-import CollectionDefinition = require("./class/collection_definition");
-import Schema_1 = require("mongoose");
-import Schema = Schema_1.Schema;
-import DatabaseTrigger = require("./class/database_trigger");
-import CmsTrigger = require("./class/cms_trigger");

package/types/middlewares.d.ts

@@ -1,9 +0,0 @@
-/**
- * Authentication middleware
- * It checks if incoming request has a valid token in header.authorization
- *
- * @param {Object} ctx - Koa context
- * @param {Function} next - Koa next function
- * @returns {Promise<void>}
- */
-export function auth(ctx: any, next: Function): Promise<void>;

package/types/services/data_provider/router.d.ts

@@ -1,3 +0,0 @@
-export let name: string;
-declare let dataProvider: any;
-export { dataProvider as main };

package/types/services/data_provider/service.d.ts

@@ -1,40 +0,0 @@
-export let name: string;
-/**
- * Get a collection from a database.
- * @param {string} db - The database name.
- * @param {string} collection - The collection name.
- * @returns {import('mongoose').Model} The found collection.
- */
-export function getCollection(db: string, collection: string): Mongoose.Model<any, any, any>;
-/**
- *
- * @param {object} option
- * @param {array} option.list an array of CollectionDefinition instance
- * @param {object} option.mongoOption
- * @param {string} option.mongoOption.dbPrefix
- * @param {string} option.mongoOption.mongoBaseAddress
- */
-export function addCollectionDefinitionByList({ list, mongoOption }: {
-    list: any[];
-    mongoOption: {
-        dbPrefix: string;
-        mongoBaseAddress: string;
-    };
-}): Promise<void>;
-/**
- * Check access to a collection.
- * @param {string} db - The database name.
- * @param {string} collection - The collection name.
- * @param {string} operationType - The operation type.
- * @param {object} queryOrDoc - The query or document.
- * @param {import('../../class/user')} user - The user.
- * @returns {boolean} The access result.
- */
-export function checkAccess(db: string, collection: string, operationType: string, queryOrDoc: object, user: import('../../class/user')): boolean;
-export function getAsID(strId: any): Mongoose.Types.ObjectId;
-export function performPopulateToQueryObject(queryObj: any, popArr?: any[]): any;
-export function performAdditionalOptionsToQueryObject(queryObj: any, options: any): any;
-import triggers = require("../../class/trigger_operator");
-import TypeCasters = require("./typeCasters");
-import Mongoose = require("mongoose");
-export { triggers, TypeCasters };

package/types/services/data_provider/typeCasters.d.ts

@@ -1,3 +0,0 @@
-import Mongoose = require("mongoose");
-export let ObjectId: Mongoose.Types.ObjectIdConstructor;
-export function Date(dateValue: any): Date;

package/types/services/file/db.d.ts

@@ -1,3 +0,0 @@
-declare const _exports: CollectionDefinition[];
-export = _exports;
-import CollectionDefinition = require("../../class/collection_definition");

package/types/services/file/router.d.ts

@@ -1,3 +0,0 @@
-export let name: string;
-declare let fileRouter: any;
-export { fileRouter as main };

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

@@ -1,81 +0,0 @@
-export = FileService.instance;
-declare var instance: FileService;
-declare class FileService {
-    directory: any;
-    setUploadDirectory(directory: any): void;
-    /**
-     *
-     * @param {string} fileType
-     * @param {string} tag
-     *
-     * @returns storedFile
-     * @returns storedFile.fileName
-     * @returns storedFile.directory
-     * @returns storedFile.fullPath
-     * @returns storedFile.fileFormat
-     */
-    createStoredDetail(fileType: string, tag: string): {
-        fileName: string;
-        fullPath: string;
-        fileFormat: string;
-    };
-    /**
-     * Stores a file, removes the given temporary file, and submits file details into the database.
-     *
-     * @param {Object} options - The options for storing the file.
-     * @param {Object} options.file - The file to be stored.
-     * @param {string} options.file.path - The path of the file.
-     * @param {string} options.file.type - The type of the file.
-     * @param {string} options.file.name - The original name of the file.
-     * @param {number} options.file.size - The size of the file.
-     * @param {string} options.ownerId - The ID of the owner of the file.
-     * @param {string} options.tag - The tag associated with the file.
-     * @param {boolean} [options.removeFileAfterStore=true] - Whether to remove the file after storing it.
-     *
-     * @returns {Promise} A promise that resolves with the document of the stored file.
-     *
-     * @throws {string} If the upload directory has not been set.
-     */
-    storeFile({ file, ownerId, tag, removeFileAfterStore }: {
-        file: {
-            path: string;
-            type: string;
-            name: string;
-            size: number;
-        };
-        ownerId: string;
-        tag: string;
-        removeFileAfterStore?: boolean;
-    }): Promise<any>;
-    /**
-     * Removes a file from the disk.
-     *
-     * @param {string} path - The path of the file to be removed.
-     * @returns {Promise} A promise that resolves if the file is successfully removed, and rejects if an error occurs.
-     */
-    removeFromDisc(path: string): Promise<any>;
-    /**
-     * Removes a file from the database and the disk.
-     *
-     * @param {string} fileId - The ID of the file to be removed.
-     * @returns {Promise} A promise that resolves if the file is successfully removed, and rejects if an error occurs.
-     * @throws Will throw an error if upload directory has not been set.
-     */
-    removeFile(fileId: string): Promise<any>;
-    /**
-     * Retrieves a file from the database.
-     *
-     * @param {string} fileId - The ID of the file to be retrieved.
-     * @returns {Promise} A promise that resolves with the file document, or rejects if an error occurs.
-     */
-    getFile(fileId: string): Promise<any>;
-    /**
-     * Retrieves the link of a file.
-     *
-     * @param {string} fileId - The ID of the file to get the link for.
-     * @returns {Promise} A promise that resolves with the file link, or rejects if an error occurs.
-     */
-    getFileLink(fileId: string): Promise<any>;
-    getFilePath(fileId: any): Promise<string>;
-}
-declare namespace FileService { }

package/types/services/functions/router.d.ts

@@ -1,3 +0,0 @@
-export const name: "function";
-declare const functionRouter: any;
-export { functionRouter as main };

package/types/services/functions/service.d.ts

@@ -1,23 +0,0 @@
-export type PermissionType = import('../../class/security.js').PermissionType;
-/**
- * @typedef {import('../../class/security.js').PermissionType} PermissionType
- */
-/**
- * Defines a function with a given name, permission types, and callback.
- *
- * @param {Object} params - The parameters for the function.
- * @param {string} params.name - The name of the function.
- * @param {[PermissionType]} params.permissionTypes - The permission types for the function.
- * @param {Function} params.callback - The callback to be executed by the function.
- */
-export function defineFunction({ name, permissionTypes, callback }: {
-    name: string;
-    permissionTypes: [PermissionType];
-    callback: Function;
-}): {
-    name: string;
-    permissionTypes: [string];
-    callback: Function;
-};
-export function runFunction(name: any, args: any, user: any): Promise<any>;
-export function addFunction(func: any): void;

package/types/services/jwt/router.d.ts

@@ -1,3 +0,0 @@
-export let name: string;
-declare let verify: any;
-export { verify as main };

package/types/services/jwt/service.d.ts

@@ -1,10 +0,0 @@
-export const name: "jwt";
-export const main: JWT;
-declare class JWT {
-    setKies(privateKey: any, publicKey: any): void;
-    privateKey: any;
-    publicKey: any;
-    sign(payload: any): Promise<any>;
-    verify(token: any): Promise<any>;
-}
-export {};

package/types/services/user_manager/db.d.ts

@@ -1,3 +0,0 @@
-declare const _exports: CollectionDefinition[];
-export = _exports;
-import CollectionDefinition = require("../../class/collection_definition");

package/types/services/user_manager/permissionManager.d.ts

@@ -1,3 +0,0 @@
-export function getDefaultPermissionGroups(): import("../../class/security").PermissionGroup;
-export function getDefaultAnonymousPermissionGroup(): import("../../class/security").PermissionGroup;
-export function getDefaultAdministratorPermissionGroup(): import("../../class/security").PermissionGroup;

package/types/services/user_manager/router.d.ts

@@ -1,3 +0,0 @@
-export let name: string;
-declare let userManager: any;
-export { userManager as main };