@point-hub/papi 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 PointHub
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,3 @@
+## Description
+
+Papi stands for Pointhub API. I made this because setting the project is kinda the bottleneck for me to make the ideas simply come true within a very short time, so I made this for Pointhub meet minimum requirement to create Backend API more easily, along with some good practices that I have learned. 

package/lib/app.d.ts

@@ -0,0 +1,2 @@
+import express from "express";
+export declare function createApp(): Promise<express.Express>;

package/lib/app.js

@@ -0,0 +1,10 @@
+import express from "express";
+export async function createApp() {
+    const app = express();
+    app.get("/", (req, res) => {
+        res.status(200).json({
+            message: "Papi",
+        });
+    });
+    return app;
+}

package/lib/console/commands/make-command/index.command.d.ts

@@ -0,0 +1,5 @@
+import { BaseCommand } from "@point-hub/express-cli";
+export default class MakeCommand extends BaseCommand {
+    constructor();
+    handle(): Promise<void>;
+}

package/lib/console/commands/make-command/index.command.js

@@ -0,0 +1,44 @@
+import fs from "fs";
+import path from "path";
+import { BaseCommand, Color } from "@point-hub/express-cli";
+import { pascalCase, kebabCase, camelCase } from "@point-hub/express-utils";
+import { stubDir } from "../../../console/helper.js";
+export default class MakeCommand extends BaseCommand {
+    constructor() {
+        super({
+            name: "make:command",
+            description: "Make a new console command",
+            summary: "Make a new console command",
+            arguments: [
+                {
+                    name: "name",
+                    description: "Name of console command",
+                },
+            ],
+            options: [],
+        });
+    }
+    async handle() {
+        // Check if command directory is already exists
+        if (fs.existsSync(`${process.cwd()}/src/console/commands/${kebabCase(this.args.name)}`)) {
+            console.error(Color.red("Command directory is exists"));
+            return;
+        }
+        // Create directory
+        fs.mkdirSync(`${process.cwd()}/src/console/commands/${kebabCase(this.args.name)}`, { recursive: true });
+        // Copy command file
+        const stubCommand = fs
+            .readFileSync(path.resolve(stubDir, "./command/index.command.ts"))
+            .toString()
+            .replace("[name]", kebabCase(this.args.name))
+            .replace("NewCommand", `${pascalCase(this.args.name)}Command`);
+        fs.writeFileSync(`${process.cwd()}/src/console/commands/${kebabCase(this.args.name)}/index.command.ts`, stubCommand);
+        // Copy test file
+        const stubTest = fs
+            .readFileSync(path.resolve(stubDir, "./command/index.spec.ts"))
+            .toString()
+            .replace(/NewCommand/g, `${pascalCase(this.args.name)}Command`)
+            .replace(/newCommand/g, `${camelCase(this.args.name)}Command`);
+        fs.writeFileSync(`${process.cwd()}/src/console/commands/${kebabCase(this.args.name)}/index.spec.ts`, stubTest);
+    }
+}

package/lib/console/commands/make-middleware/index.command.d.ts

@@ -0,0 +1,7 @@
+import { BaseCommand } from "@point-hub/express-cli";
+export default class MakeMiddleware extends BaseCommand {
+    constructor();
+    handle(): Promise<void>;
+    private copyMiddleware;
+    private copyConfigureableMiddleware;
+}

package/lib/console/commands/make-middleware/index.command.js

@@ -0,0 +1,72 @@
+import fs from "fs";
+import path from "path";
+import { BaseCommand, Color } from "@point-hub/express-cli";
+import { pascalCase, kebabCase } from "@point-hub/express-utils";
+import { stubDir } from "../../../console/helper.js";
+export default class MakeMiddleware extends BaseCommand {
+    constructor() {
+        super({
+            name: "make:middleware",
+            description: "Make a new middleware",
+            summary: "Make a new middleware",
+            arguments: [
+                {
+                    name: "name",
+                    description: "Name of middleware",
+                },
+            ],
+            options: [
+                {
+                    type: "boolean",
+                    flag: "--configurable",
+                    shorthand: "-c",
+                    description: "Export a function which accepts an options",
+                },
+            ],
+        });
+    }
+    async handle() {
+        // Check if middleware directory is already exists
+        if (fs.existsSync(`${process.cwd()}/src/middleware/${kebabCase(this.args.name)}`)) {
+            console.error(Color.red("Middleware directory is exists"));
+            return;
+        }
+        // Create middleware directory
+        fs.mkdirSync(`${process.cwd()}/src/middleware/${kebabCase(this.args.name)}`, { recursive: true });
+        // Copy middleware
+        if (this.opts["--configurable"]) {
+            this.copyConfigureableMiddleware();
+        }
+        else {
+            this.copyMiddleware();
+        }
+    }
+    copyMiddleware() {
+        // Copy middleware file
+        const stubMiddleware = fs
+            .readFileSync(path.resolve(stubDir, "./middleware/new.middleware.ts"))
+            .toString()
+            .replace("NewMiddleware", `${pascalCase(this.args.name)}Middleware`);
+        fs.writeFileSync(`${process.cwd()}/src/middleware/${kebabCase(this.args.name)}/index.middleware.ts`, stubMiddleware);
+        // Copy test file
+        const stubTest = fs
+            .readFileSync(path.resolve(stubDir, "./middleware/new.spec.ts"))
+            .toString()
+            .replace("new.middleware.js", `index.middleware.js`);
+        fs.writeFileSync(`${process.cwd()}/src/middleware/${kebabCase(this.args.name)}/index.spec.ts`, stubTest);
+    }
+    copyConfigureableMiddleware() {
+        // Copy middleware file
+        const stubMiddleware = fs
+            .readFileSync(path.resolve(stubDir, "./middleware/configurable.middleware.ts"))
+            .toString()
+            .replace("NewMiddleware", `${pascalCase(this.args.name)}Middleware`);
+        fs.writeFileSync(`${process.cwd()}/src/middleware/${kebabCase(this.args.name)}/index.middleware.ts`, stubMiddleware);
+        // Copy test file
+        const stubTest = fs
+            .readFileSync(path.resolve(stubDir, "./middleware/configurable.spec.ts"))
+            .toString()
+            .replace("configurable.middleware.js", `index.middleware.js`);
+        fs.writeFileSync(`${process.cwd()}/src/middleware/${kebabCase(this.args.name)}/index.spec.ts`, stubTest);
+    }
+}

package/lib/console/helper.d.ts

@@ -0,0 +1 @@
+export declare const stubDir: string;

package/lib/console/helper.js

@@ -0,0 +1,2 @@
+import { URL } from "url";
+export const stubDir = new URL("../../stub", import.meta.url).pathname;

package/lib/console/index.d.ts

@@ -0,0 +1,13 @@
+import { ExpressCli } from "@point-hub/express-cli";
+export declare class ConsoleKernel {
+    path: string;
+    private command;
+    constructor(command: ExpressCli);
+    /**
+     * Register the commands for the application.
+     *
+     * @example
+     * command.register(new ExampleCommand());
+     */
+    register(): Promise<void>;
+}

package/lib/console/index.js

@@ -0,0 +1,21 @@
+import { URL } from "url";
+import { fileSearch } from "@point-hub/express-utils";
+export class ConsoleKernel {
+    constructor(command) {
+        this.path = new URL(".", import.meta.url).pathname;
+        this.command = command;
+    }
+    /**
+     * Register the commands for the application.
+     *
+     * @example
+     * command.register(new ExampleCommand());
+     */
+    async register() {
+        const result = await fileSearch("/*.command.(js|ts)", this.path, { maxDeep: 2, regExp: true });
+        for (let i = 0; i < result.length; i++) {
+            const { default: Command } = await import(`./${result[i].path}`);
+            this.command.register(new Command());
+        }
+    }
+}

package/lib/index.d.ts

@@ -0,0 +1 @@
+export { Server as BaseServer } from "./server.js";

package/lib/index.js

@@ -0,0 +1 @@
+export { Server as BaseServer } from "./server.js";

package/lib/server.d.ts

@@ -0,0 +1,14 @@
+/// <reference types="node" />
+import { Server as HttpServer } from "http";
+import { Express } from "express";
+export 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;
+}

package/lib/server.js

@@ -0,0 +1,47 @@
+export class Server {
+    constructor(app) {
+        this.server = null;
+        this.app = app;
+    }
+    listen(port, hostname) {
+        return new Promise((resolve, reject) => {
+            if (hostname) {
+                this.server = this.app.listen(port, hostname).once("listening", resolve).once("error", reject);
+            }
+            else {
+                this.server = this.app.listen(port).once("listening", resolve).once("error", reject);
+            }
+        });
+    }
+    async start(port, hostname) {
+        try {
+            await this.listen(port, hostname);
+        }
+        catch (error) {
+            throw error;
+        }
+    }
+    stop() {
+        var _a;
+        (_a = this.server) === null || _a === void 0 ? void 0 : _a.close();
+        this.server = null;
+    }
+    get host() {
+        var _a;
+        const address = (_a = this.server) === null || _a === void 0 ? void 0 : _a.address();
+        if ((address === null || address === void 0 ? void 0 : address.address) === "0.0.0.0" || (address === null || address === void 0 ? void 0 : address.address) === "::") {
+            return "localhost";
+        }
+        else {
+            return address === null || address === void 0 ? void 0 : address.address;
+        }
+    }
+    get port() {
+        var _a;
+        const address = (_a = this.server) === null || _a === void 0 ? void 0 : _a.address();
+        return address === null || address === void 0 ? void 0 : address.port;
+    }
+    get url() {
+        return `http://${this.host}${this.port !== 80 ? `:${this.port}` : ""}`;
+    }
+}

package/package.json

@@ -0,0 +1,71 @@
+{
+  "name": "@point-hub/papi",
+  "version": "0.0.1",
+  "description": "Point API Framework",
+  "type": "module",
+  "main": "lib/index.js",
+  "files": [
+    "lib/",
+    "stub/"
+  ],
+  "scripts": {
+    "dev:compile": "tsc -w --project tsconfig.build.json",
+    "dev:resolve-path": "tsc-alias -w --project tsconfig.build.json",
+    "dev": "shx rm -rf lib && concurrently -k npm:dev:*",
+    "build:compile": "tsc --project tsconfig.build.json",
+    "build:resolve-path": "tsc-alias --project tsconfig.build.json",
+    "build": "shx rm -rf lib && npm run build:compile && npm run build:resolve-path",
+    "lint": "eslint ./src/**/*.ts",
+    "lint:fix": "npm run lint -- --fix",
+    "test": "NODE_OPTIONS=--experimental-vm-modules jest --runInBand",
+    "test:coverage": "shx rm -rf coverage && npm run test -- --coverage"
+  },
+  "keywords": [
+    "papi",
+    "express",
+    "api",
+    "boilerplate",
+    "framework"
+  ],
+  "author": "Martien Dermawan Tanama <martiendt@gmail.com>",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/point-hub/papi.git"
+  },
+  "devDependencies": {
+    "@babel/core": "^7.18.6",
+    "@babel/preset-env": "^7.18.6",
+    "@babel/preset-typescript": "^7.18.6",
+    "@types/compression": "^1.7.2",
+    "@types/cors": "^2.8.12",
+    "@types/express": "^4.17.13",
+    "@types/jest": "^28.1.4",
+    "@types/node": "^18.0.3",
+    "@types/shelljs": "^0.8.11",
+    "@types/supertest": "^2.0.12",
+    "@typescript-eslint/eslint-plugin": "^5.25.0",
+    "babel-jest": "^28.1.2",
+    "concurrently": "^7.2.2",
+    "eslint": "^8.15.0",
+    "eslint-config-prettier": "^8.5.0",
+    "eslint-import-resolver-typescript": "^3.2.4",
+    "eslint-plugin-import": "^2.26.0",
+    "eslint-plugin-prettier": "^4.2.1",
+    "jest": "^28.1.2",
+    "prettier": "^2.7.1",
+    "shx": "^0.3.4",
+    "supertest": "^6.2.4",
+    "tsc-alias": "^1.6.11",
+    "typescript": "^4.7.4"
+  },
+  "dependencies": {
+    "@point-hub/express-cli": "^0.2.2",
+    "@point-hub/express-error-handler": "^0.0.1",
+    "@point-hub/express-utils": "^0.0.14",
+    "shelljs": "^0.8.5"
+  },
+  "peerDependencies": {
+    "express": "^4.18.1"
+  }
+}

package/stub/command/index.command.ts

@@ -0,0 +1,16 @@
+import { BaseCommand } from "@point-hub/express-cli";
+
+export default class NewCommand extends BaseCommand {
+  constructor() {
+    super({
+      name: "[name]",
+      description: "[description]",
+      summary: "[summary]",
+      arguments: [],
+      options: [],
+    });
+  }
+  async handle(): Promise<void> {
+    //
+  }
+}

package/stub/command/index.spec.ts

@@ -0,0 +1,10 @@
+import { jest } from "@jest/globals";
+import NewCommand from "./index.command.js";
+
+it("test command", () => {
+  const newCommand = new NewCommand();
+  const spy = jest.spyOn(newCommand, "handle");
+  newCommand.handle();
+
+  expect(spy).toBeCalled();
+});

package/stub/middleware/configurable.middleware.ts

@@ -0,0 +1,8 @@
+import { Request, Response, NextFunction } from "express";
+
+export default function newMiddleware<T>(options?: T) {
+  return function (req: Request, res: Response, next: NextFunction) {
+    console.log(options);
+    next();
+  };
+}

package/stub/middleware/configurable.spec.ts

@@ -0,0 +1,12 @@
+import { jest } from "@jest/globals";
+import { Request, Response, NextFunction } from "express";
+import middleware from "./configurable.middleware.js";
+
+it("test middleware", () => {
+  const req = {} as Request;
+  const res = {} as Response;
+  const next: NextFunction = jest.fn();
+  middleware()(req, res, next);
+
+  expect(next).toBeCalled();
+});

package/stub/middleware/new.middleware.ts

@@ -0,0 +1,5 @@
+import { Request, Response, NextFunction } from "express";
+
+export default function (req: Request, res: Response, next: NextFunction) {
+  next();
+}

package/stub/middleware/new.spec.ts

@@ -0,0 +1,12 @@
+import { jest } from "@jest/globals";
+import { Request, Response, NextFunction } from "express";
+import middleware from "./new.middleware.js";
+
+it("test middleware", () => {
+  const req = {} as Request;
+  const res = {} as Response;
+  const next: NextFunction = jest.fn();
+  middleware(req, res, next);
+
+  expect(next).toBeCalled();
+});