@point-hub/papi 0.1.4 → 0.1.6

package/lib/index.d.ts

@@ -1,63 +1,318 @@
-// Generated by dts-bundle-generator v8.1.2
-
-import { ExpressCli } from '@point-hub/express-cli';
-import { Express } from 'express';
-import { Server as HttpServer } from 'http';
-import { SortDirection } from 'mongodb';
-
-export declare class ConsoleKernel {
-	private command;
-	constructor(command: ExpressCli);
-	/**
-	 * Register the commands for the application.
-	 *
-	 * @example
-	 * this.command.register(new ExampleCommand());
-	 */
-	register(): Promise<void>;
-}
-export interface IFieldsObject {
-	[key: string]: number;
-}
-export interface ISortObject {
-	[key: string]: SortDirection;
-}
-declare function page(page?: string | number): number;
-declare function limit(pageSize?: string | number): number;
-declare function skip(currentPage: string | number, pageSize: string | number): number;
-declare function filter(filter: never): never;
-declare function fields(fields?: string, excludeFields?: string[]): IFieldsObject;
-declare function convertStringToArray(fields: string): string[];
-declare function convertArrayToObject(array: string[], value?: number): IFieldsObject;
-declare function filterExludeFields(obj: IFieldsObject, excludeFields: string[]): IFieldsObject;
-declare function sort(fields: string): ISortObject;
-declare const _default: {
-	page: typeof page;
-	limit: typeof limit;
-	skip: typeof skip;
-	sort: typeof sort;
-	fields: typeof fields;
-	filter: typeof filter;
-	filterExludeFields: typeof filterExludeFields;
-	convertStringToArray: typeof convertStringToArray;
-	convertArrayToObject: typeof convertArrayToObject;
-};
-declare class Server {
-	app: Express;
-	server: HttpServer | null;
-	constructor(app: Express);
-	listen(port: number, hostname?: string): Promise<unknown>;
-	start(port: number, hostname?: string): Promise<void>;
-	stop(): void;
-	get host(): string;
-	get port(): number;
-	get url(): string;
-}
-export declare const stubDir: string;
-
-export {
-	Server as BaseServer,
-	_default as Querystring,
-};
-
-export {};
+#!/usr/bin/env node
+/// <reference types="node" />
+/// <reference types="bun-types" />
+declare module "build" { }
+declare module "src/console/commands/make-command/index.command" {
+    import { BaseCommand } from '@point-hub/express-cli';
+    export default class MakeCommand extends BaseCommand {
+        constructor();
+        handle(): Promise<void>;
+    }
+}
+declare module "src/console/commands/make-middleware/index.command" {
+    import { BaseCommand } from '@point-hub/express-cli';
+    export default class MakeMiddleware extends BaseCommand {
+        constructor();
+        handle(): Promise<void>;
+        private copyMiddleware;
+        private copyConfigureableMiddleware;
+    }
+}
+declare module "src/console/index" {
+    import { ExpressCli } from '@point-hub/express-cli';
+    export class ConsoleKernel {
+        private command;
+        constructor(command: ExpressCli);
+        /**
+         * Register the commands for the application.
+         *
+         * @example
+         * this.command.register(new ExampleCommand());
+         */
+        register(): Promise<void>;
+    }
+}
+declare module "src/database/connection" {
+    export class DatabaseConnection implements IDatabase {
+        adapter: IDatabase;
+        session: unknown;
+        constructor(adapter: IDatabase);
+        open(): Promise<void>;
+        close(): Promise<void>;
+        database(name: string): this;
+        collection(name: string): this;
+        listCollections(): Promise<{
+            name: string;
+        }[]>;
+        startSession(): IClientSession;
+        endSession(): Promise<void>;
+        startTransaction(): void;
+        commitTransaction(): Promise<void>;
+        abortTransaction(): Promise<void>;
+        createIndex(name: string, spec: unknown, options?: unknown): Promise<void>;
+        createCollection(name: string, options?: unknown): Promise<void>;
+        dropCollection(name: string, options?: unknown): Promise<void>;
+        updateSchema(name: string, schema: unknown): Promise<void>;
+        create(document: IDocument, options?: unknown): Promise<ICreateOutput>;
+        createMany(documents: IDocument[], options?: unknown): Promise<ICreateManyOutput>;
+        retrieveAll(query: IQuery, options?: unknown): Promise<IRetrieveAllOutput>;
+        retrieve(_id: string, options?: unknown): Promise<IRetrieveOutput>;
+        update(_id: string, document: IDocument, options?: unknown): Promise<IUpdateOutput>;
+        updateMany(filter: IDocument, document: IDocument, options?: unknown): Promise<IUpdateManyOutput>;
+        delete(_id: string, options?: unknown): Promise<IDeleteOutput>;
+        deleteMany(_ids: string[], options?: unknown): Promise<IDeleteManyOutput>;
+        deleteAll(options?: unknown): Promise<IDeleteManyOutput>;
+        aggregate(pipeline: IPipeline[], query: IQuery, options?: unknown): Promise<IAggregateOutput>;
+    }
+}
+declare module "src/database/mongodb/mongodb-helper" {
+    /**
+     * https://www.mongodb.com/docs/drivers/node/current/fundamentals/indexes/
+     * https://www.mongodb.com/docs/manual/reference/collation/
+     * https://www.mongodb.com/docs/manual/core/index-sparse/
+     * https://www.mongodb.com/docs/manual/core/index-partial/
+     */
+    export class MongoDBHelper {
+        private db;
+        constructor(db: IDatabase);
+        /**
+         * Create unique column
+         *
+         * @example
+         * create unique attribute "name"
+         * createUnique(collection, {
+         *   name: -1,
+         * })
+         *
+         * @example
+         * create unique attribute for multiple column "first_name" and "last_name"
+         * createUnique(collection, {
+         *   firstName: -1,
+         *   lastName: -1,
+         * })
+         */
+        createUnique(collection: string, properties: object): Promise<void>;
+        /**
+         * Create unique if column is exists
+         */
+        createUniqueIfNotNull(collection: string, properties: object): Promise<void>;
+        isExists(name: string): Promise<boolean>;
+        static stringToObjectId(val: any): any;
+        static objectIdToString(val: any): any;
+    }
+}
+declare module "src/database/mongodb/mongodb-querystring" {
+    import { SortDirection } from 'mongodb';
+    interface IFieldsObject {
+        [key: string]: number;
+    }
+    interface ISortObject {
+        [key: string]: SortDirection;
+    }
+    /**
+     * Parse query string to number
+     *
+     * @example
+     * page("10") // => 10
+     * page(10) // => 10
+     */
+    export function page(page?: string | number): number;
+    /**
+     * Parse query string to number
+     *
+     * @example
+     * limit("10") // => 10
+     * limit(10) // => 10
+     */
+    export function limit(pageSize?: string | number): number;
+    /**
+     * Skip number of data from page
+     *
+     * @example
+     * skip(1, 10) // => 0
+     * skip(2, 10) // => 10
+     * skip(3, 10) // => 20
+     */
+    export function skip(currentPage: string | number, pageSize: string | number): number;
+    export function filter(filter: never): never;
+    /**
+     * Convert string param to mongodb field object
+     *
+     * @example
+     * fields("name, address") // => { name: 1, address: 1 }
+     */
+    export function fields(fields?: string, excludeFields?: string[]): IFieldsObject;
+    /**
+     * Convert string to array
+     *
+     * @example
+     * convertStringToArray("name, address") // => ["name", "address"]
+     */
+    export function convertStringToArray(fields: string): string[];
+    /**
+     * Convert array to mongodb field object
+     *
+     * @example
+     * convertArrayToObject(["name", "address"]) // => { name: 1, address: 1 }
+     * convertArrayToObject(["name", "address"], -1) // => { name: -1, address: -1 }
+     */
+    export function convertArrayToObject(array: string[], value?: number): IFieldsObject;
+    /**
+     * Remove excluded fields
+     *
+     * @example
+     * ex: { password: 0 }
+     */
+    export function filterExludeFields(obj: IFieldsObject, excludeFields: string[]): IFieldsObject;
+    /**
+     * Convert string param to mongodb sort object
+     *
+     * @example
+     * sort("name, -createdAt") // => { name: 1, createdAt: -1 }
+     */
+    export function sort(fields: string): ISortObject;
+    const _default: {
+        page: typeof page;
+        limit: typeof limit;
+        skip: typeof skip;
+        sort: typeof sort;
+        fields: typeof fields;
+        filter: typeof filter;
+        filterExludeFields: typeof filterExludeFields;
+        convertStringToArray: typeof convertStringToArray;
+        convertArrayToObject: typeof convertArrayToObject;
+    };
+    export default _default;
+}
+declare module "src/database/mongodb/connection" {
+    import type { ClientSession, Collection, CollectionOptions, CreateIndexesOptions, Db, DbOptions, IndexSpecification } from 'mongodb';
+    import { MongoClient } from 'mongodb';
+    export class MongoDBConnection implements IDatabase {
+        databaseName: string;
+        client: MongoClient;
+        _database: Db | undefined;
+        _collection: Collection | undefined;
+        session: ClientSession | undefined;
+        constructor(connectionString: string, databaseName: string);
+        open(): Promise<void>;
+        close(): Promise<void>;
+        database(name: string, options?: DbOptions): this;
+        collection(name: string, options?: CollectionOptions): this;
+        listCollections(): Promise<{
+            name: string;
+        }[]>;
+        createIndex(name: string, spec: IndexSpecification, options: CreateIndexesOptions): Promise<void>;
+        updateSchema(name: string, schema: unknown): Promise<void>;
+        createCollection(name: string, options: any): Promise<void>;
+        dropCollection(name: string, options: any): Promise<void>;
+        startSession(): ClientSession;
+        endSession(): Promise<void>;
+        startTransaction(): void;
+        commitTransaction(): Promise<void>;
+        abortTransaction(): Promise<void>;
+        create(document: IDocument, options?: unknown): Promise<ICreateOutput>;
+        createMany(documents: IDocument[], options?: unknown): Promise<ICreateManyOutput>;
+        retrieveAll(query: IQuery, options?: any): Promise<IRetrieveAllOutput>;
+        retrieve(_id: string, options?: any): Promise<IRetrieveOutput>;
+        update(_id: string, document: IDocument, options?: any): Promise<IUpdateOutput>;
+        updateMany(filter: IDocument[], document: IDocument[], options?: any): Promise<IUpdateManyOutput>;
+        delete(_id: string, options?: any): Promise<IDeleteOutput>;
+        deleteMany(_ids: string[], options?: any): Promise<IDeleteManyOutput>;
+        deleteAll(options?: any): Promise<IDeleteManyOutput>;
+        aggregate(pipeline: IPipeline[], query: IQuery, options?: any): Promise<IAggregateOutput>;
+    }
+}
+declare module "src/database/mongodb/mongodb-error-handler" {
+    import { BaseError, type IError } from '@point-hub/express-error-handler';
+    import { MongoServerError } from 'mongodb';
+    export function handleSchemaValidation(err: MongoServerError, error: IError): void;
+    export function handleUniqueValidation(err: MongoServerError, error: IError): void;
+    export class MongoErrorHandler extends BaseError {
+        constructor(err: MongoServerError);
+        get isOperational(): boolean;
+        get name(): string;
+    }
+}
+declare module "src/server" {
+    import { Express } from 'express';
+    import { Server as HttpServer } from 'http';
+    export class Server {
+        app: Express;
+        server: HttpServer | null;
+        constructor(app: Express);
+        listen(port: number, hostname?: string): Promise<unknown>;
+        start(port: number, hostname?: string): Promise<void>;
+        stop(): void;
+        get host(): string;
+        get port(): number;
+        get url(): string;
+    }
+}
+declare module "src/index" {
+    import { BaseCommand } from '@point-hub/express-cli';
+    import { ApiError, BaseError, errorHandlerMiddleware, find, invalidPathMiddleware } from '@point-hub/express-error-handler';
+    import { MongoServerError } from 'mongodb';
+    import { ConsoleKernel } from "src/console/index";
+    import { DatabaseConnection } from "src/database/connection";
+    import { MongoDBConnection } from "src/database/mongodb/connection";
+    import { MongoErrorHandler } from "src/database/mongodb/mongodb-error-handler";
+    import { MongoDBHelper } from "src/database/mongodb/mongodb-helper";
+    export const stubDir: string;
+    export { ExpressCli as BaseConsoleCli } from '@point-hub/express-cli';
+    export const BaseConsoleCommand: typeof BaseCommand;
+    export const BaseConsoleKernel: typeof ConsoleKernel;
+    export const BaseDatabaseConnection: typeof DatabaseConnection;
+    export const BaseMongoDBConnection: typeof MongoDBConnection;
+    export const BaseMongoDBHelper: typeof MongoDBHelper;
+    export const BaseMongoDBQuerystring: {
+        page: typeof import("src/database/mongodb/mongodb-querystring").page;
+        limit: typeof import("src/database/mongodb/mongodb-querystring").limit;
+        skip: typeof import("src/database/mongodb/mongodb-querystring").skip;
+        sort: typeof import("src/database/mongodb/mongodb-querystring").sort;
+        fields: typeof import("src/database/mongodb/mongodb-querystring").fields;
+        filter: typeof import("src/database/mongodb/mongodb-querystring").filter;
+        filterExludeFields: typeof import("src/database/mongodb/mongodb-querystring").filterExludeFields;
+        convertStringToArray: typeof import("src/database/mongodb/mongodb-querystring").convertStringToArray;
+        convertArrayToObject: typeof import("src/database/mongodb/mongodb-querystring").convertArrayToObject;
+    };
+    export const BaseMongoServerError: typeof MongoServerError;
+    export const BaseMongoErrorHandler: typeof MongoErrorHandler;
+    export const BaseErrorHandler: {
+        ApiError: typeof ApiError;
+        BaseError: typeof BaseError;
+        isTrustedError: (err: Error) => boolean;
+        getHttpError: typeof find;
+        errorHandlerMiddleware: typeof errorHandlerMiddleware;
+        invalidPathMiddleware: typeof invalidPathMiddleware;
+    };
+    export { Server as BaseServer } from "src/server";
+}
+declare module "cli" { }
+declare module "src/app" {
+    import express from 'express';
+    export function createApp(): Promise<express.Express>;
+}
+declare module "src/app.spec" { }
+declare module "src/server.spec" { }
+declare module "src/console/index.spec" { }
+declare module "src/console/commands/make-command/index.spec" { }
+declare module "src/console/commands/make-middleware/index.spec" { }
+declare module "src/database/mongodb/mongodb-querystring.spec" { }
+declare module "stub/command/index.command" {
+    import { BaseCommand } from '@point-hub/express-cli';
+    export default class NewCommand extends BaseCommand {
+        constructor();
+        handle(): Promise<void>;
+    }
+}
+declare module "stub/command/index.spec" { }
+declare module "stub/middleware/configurable.middleware" {
+    import { NextFunction, Request, Response } from 'express';
+    export default function newMiddleware<T>(options?: T): (req: Request, res: Response, next: NextFunction) => void;
+}
+declare module "stub/middleware/configurable.spec" { }
+declare module "stub/middleware/new.middleware" {
+    import { NextFunction, Request, Response } from 'express';
+    export default function (req: Request, res: Response, next: NextFunction): void;
+}
+declare module "stub/middleware/new.spec" { }