@modular-rest/server 1.11.6 → 1.11.8

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

@@ -0,0 +1,40 @@
+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/src/services/data_provider/typeCasters.d.ts

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

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

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

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

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

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

@@ -0,0 +1,81 @@
+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/src/services/functions/router.d.ts

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

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

@@ -0,0 +1,23 @@
+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: [import("../../class/security.js").PermissionType];
+    callback: Function;
+};
+export function runFunction(name: any, args: any, user: any): Promise<any>;
+export function addFunction(func: any): void;

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

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

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

@@ -0,0 +1,10 @@
+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/src/services/user_manager/db.d.ts

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

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

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

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

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

package/types/src/services/user_manager/service.d.ts

@@ -0,0 +1,131 @@
+export const name: "userManager";
+export { instance as main };
+/**
+ * import user type
+ */
+export type User = import('../../class/user');
+declare var instance: UserManager;
+/**
+ * import user type
+ * @typedef {import('../../class/user')} User
+ */
+declare class UserManager {
+    static get instance(): UserManager;
+    tempIds: {};
+    /**
+     * Sets a custom method for generating verification codes.
+     *
+     * @param {Function} generatorMethod - A function that returns a random verification code.
+     * @returns {void}
+     */
+    setCustomVerificationCodeGeneratorMethod(generatorMethod: Function): void;
+    verificationCodeGeneratorMethod: Function;
+    /**
+     * Get a user by their ID.
+     *
+     * @param {string} id - The ID of the user.
+     * @returns {Promise<User>} A promise that resolves to the user.
+     * @throws {Error} If the user is not found.
+     */
+    generateVerificationCode(id: string, idType: any): Promise<User>;
+    /**
+     * Get a user by their ID.
+     *
+     * @param {string} id - The ID of the user.
+     * @returns {Promise<User>} A promise that resolves to the user.
+     * @throws {string} If the user is not found.
+     */
+    getUserById(id: string): Promise<User>;
+    /**
+     * Get a user by their identity.
+     *
+     * @param {string} id - The identity of the user.
+     * @param {string} idType - The type of the identity (phone or email).
+     * @returns {Promise<User>} A promise that resolves to the user.
+     * @throws {string} If the user is not found.
+     */
+    getUserByIdentity(id: string, idType: string): Promise<User>;
+    /**
+     * Get a user by their token.
+     *
+     * @param {string} token - The token of the user.
+     * @returns {Promise<User>} A promise that resolves to the user.
+     */
+    getUserByToken(token: string): Promise<User>;
+    /**
+     * Check if a verification code is valid.
+     *
+     * @param {string} id - The ID of the user.
+     * @param {string} code - The verification code.
+     * @returns {boolean} Whether the verification code is valid.
+     */
+    isCodeValid(id: string, code: string): boolean;
+    /**
+     * Login a user and return their token.
+     *
+     * @param {string} id - The ID of the user.
+     * @param {string} idType - The type of the ID (phone or email).
+     * @param {string} password - The password of the user.
+     * @returns {Promise<string>} A promise that resolves to the token of the user.
+     * @throws {string} If the user is not found.
+     */
+    loginUser(id?: string, idType?: string, password?: string): Promise<string>;
+    /**
+     * Issue a token for a user.
+     *
+     * @param {string} email - The email of the user.
+     * @returns {Promise<string>} A promise that resolves to the token of the user.
+     * @throws {string} If the user is not found.
+     */
+    issueTokenForUser(email: string): Promise<string>;
+    /**
+     * Login as an anonymous user.
+     *
+     * @returns {Promise<string>} A promise that resolves to the token of the anonymous user.
+     * @throws {string} If the anonymous user is not found.
+     */
+    loginAnonymous(): Promise<string>;
+    /**
+     * Register a temporary ID.
+     *
+     * @param {string} id - The ID to register.
+     * @param {string} type - The type of the ID.
+     * @param {string} code - The verification code.
+     */
+    registerTemporaryID(id: string, type: string, code: string): void;
+    /**
+     * Submit a password for a temporary ID.
+     *
+     * @param {string} id - The ID.
+     * @param {string} password - The password.
+     * @param {string} code - The verification code.
+     * @returns {Promise<boolean>} A promise that resolves to whether the operation was successful.
+     */
+    submitPasswordForTemporaryID(id: string, password: string, code: string): Promise<boolean>;
+    /**
+     * Change the password for a temporary ID.
+     *
+     * @param {string} id - The ID.
+     * @param {string} password - The new password.
+     * @param {string} code - The verification code.
+     * @returns {Promise<boolean>} A promise that resolves to whether the operation was successful.
+     */
+    changePasswordForTemporaryID(id: string, password: string, code: string): Promise<boolean>;
+    /**
+     * Register a user.
+     *
+     * @param {Object} detail - The details of the user.
+     * @returns {Promise<string>} A promise that resolves to the ID of the new user.
+     * @throws {string} If the user could not be registered.
+     */
+    registerUser(detail: any): Promise<string>;
+    /**
+     * Change the password of a user.
+     *
+     * @param {Object} query - The query to find the user.
+     * @param {string} newPass - The new password.
+     * @returns {Promise<void>} A promise that resolves when the operation is complete.
+     */
+    changePassword(query: any, newPass: string): Promise<void>;
+}
+import User = require("../../class/user");

package/types/test.d.ts

@@ -0,0 +1 @@
+export {};

package/test.js

@@ -1,10 +0,0 @@
-const { createRest } = require('.');
-const { PermissionTypes } = require('./src/class/security');
-
-{ createRest } require('./src/application');
-{PermissionTypes} require('./src/class/security');
-
-createRest({
-    uploadDirectory: 'uploads',
-    port: '3001'
-});