xhelpers-api
Advanced tools
This project was made for personal use, it should simplify the process of creating an new api using node js + typescript + database (Mongoose/Sequelize).
$ npm i xhelpers-api
Basics "createServer" method:
Signature:
createServer({ serverOptions, options }:
{
serverOptions: {
port: number;
host: string;
};
options: {
app_key_auth?: string;
jwt_secret?: string;
swaggerOptions?: hapi-swagger.RegisterOptions;
routeOptions: {
routes: string;
};
mongooseOptions?: {
uri: string;
connectionOptions: mongoose.ConnectionOptions;
};
sequelizeOptions?: sequelize-typescript.SequelizeOptions;
enableSSL: boolean;
enableSSO: boolean;
ssoCallback: Function;
plugins?: [];
};
}): Hapi.Server
import { createServer } from "xhelpers-api/lib/server";
const pkgJson = require("../package.json");
let server: any = {};
const start = () => {
const serverOptions: any = {
port: 5000,
host: process.env.HOST || "127.0.0.1",
};
const options: any = {
jwt_secret: "v3ryH4Rds3cr3t",
swaggerOptions: {
info: {
title: "Test API",
version: "1.0",
contact: {
name: "todo test",
email: "tester@test.com",
},
},
schemes: [process.env.SSL === "true" ? "https" : "http"],
grouping: "tags",
},
routeOptions: {
routes: "**/routes/*.js",
}
};
server = await createServer({ serverOptions, options });
await server.start();
}
start();
Starting Xhelpers Hapi server API
Settings API: Mongoose disabled;
Settings API: Sequelize disabled;
Settings API: SSL disabled;
Settings API: AppKey disabled;
Settings API: JWT enabled;
Settings API: SSO disabled;
====================================================================================================
🆙 Server api : http://127.0.0.1:5000/
🆙 Server doc : http://127.0.0.1:5000/documentation
🆙 Server status : http://127.0.0.1:5000/status
====================================================================================================
Routing table:
🔎 get - /documentation
🔎 get - /health
🔎 get - /status
🔎 get - /swagger.json
🔎 get - /api/auth
🔎 get - /api/todos
🔎 get - 🔑 /api/todos/{id}
📄 post - /api/todos
📝 patch - 🔑 /api/todos/{id}
📝 put - 🔑 /api/todos/{id}
🚩 delete - 🔑 /api/todos/{id}
====================================================================================================
🆙 Server doc : http://127.0.0.1:5000/documentation
🆙 Server status : http://127.0.0.1:5000/status
🆙 Server health : http://127.0.0.1:5000/health
import * as Joi from "@hapi/joi";
import * as jwt from "jsonwebtoken";
import BaseRouteSimple from "xhelpers-api/lib/base-route-simple";
const httpResourcePath = "todos";
class TodoRoutes extends BaseRouteSimple {
constructor() {
super([httpResourcePath]);
this.route("GET",`/api/auth`, {
description: "Create new JWT to tests API",
tags: ["api", "auth"],
},
false)
.handler(async (r, h, u) => {
const token = jwt.sign({ user: { id: "99999" } },
"v3ryH4Rds3cr3t",
{
issuer: "ApiTesterIssuer",
expiresIn: "2h",
}
);
return h.response({ token: token }).code(200);
})
.build();
this.route("GET",`/api/${httpResourcePath}`,{
description: "Search 'Todos'",
},
false
)
.validate({ query: todoDemoPayload })
.handler(async (r, h, u) => {
return h.response([r.query]).code(200);
})
.build();
this.route("GET", `/api/${httpResourcePath}/{id}`, {
description: "Get 'Todo' by id",
})
.validate({ params: this.defaultIdProperty })
.handler(async (r, h, u) => {
return h.response(r.params).code(200);
})
.build();
this.route("POST", `/api/${httpResourcePath}`, {
description: "Create new 'Todo'",
},
false
)
.validate({ payload: todoDemoPayload })
.handler(async (r, h, u) => {
return h.response(r.payload).code(200);
})
.build();
this.route("PATCH", `/api/${httpResourcePath}/{id}`, {
description: "Update 'Todo' by id",
})
.validate({ params: this.defaultIdProperty, payload: todoDemoPayload })
.handler(async (r, h, u) => {
return h
.response({
...r.params,
...(r.payload as {}),
})
.code(200);
})
.build();
this.route("PUT", `/api/${httpResourcePath}/{id}`, {
description: "Replace 'Todo' by id",
})
.validate({ params: this.defaultIdProperty, payload: todoDemoPayload })
.handler(async (r, h, u) => {
return h
.response({
...r.params,
...(r.payload as {}),
})
.code(200);
})
.build();
this.route("DELETE", `/api/${httpResourcePath}/{id}`, {
description: "Delete 'Todo' by id",
})
.validate({ params: this.defaultIdProperty })
.handler(async (r, h, u) => {
return h
.response({
...r.params,
})
.code(200);
})
.build();
}
}
// ****
// Validation Joi
const todoDemoPayload = Joi.object({
title: Joi.string()
.required()
.description("Title"),
description: Joi.string()
.required()
.description("Description"),
done: Joi.boolean()
.required()
.default(false)
.description("Todo is done"),
})
.description("Todo payload")
.label("TodoPayload");
module.exports = [...new TodoRoutes().buildRoutes()];
//contract
export interface IBaseService {
queryAll(
user: any,
filter: any,
pagination: {
offset: number;
limit: number;
sort: any;
},
populateOptions?: {
path: string | any;
select?: string | any;
}
): Promise<any[]>;
getById(
user: any,
id: any,
projection: any,
populateOptions?: {
path: string | any;
select?: string | any;
}
): Promise<any>;
create(user: any, payload: any): Promise<any>;
update(user: any, id: any, payload: any): Promise<any>;
delete(user: any, id: any): Promise<void>;
}
import AccountLogin from "/model/account_login"; // mongoose or sequelize "Model"
import BaseServiceSequelize from "xhelpers-api/lib/base-service-sequelize";
import BaseServiceMongoose from "xhelpers-api/lib/base-service-mongoose";
// mongoose
export class AccountLoginService extends BaseServiceMongoose<
AccountLogin
> {
constructor() {
super(AccountLogin);
}
sentitiveInfo: any = ["-__v", "password"];
protected async validate(entity: AccountLogin, payload: AccountLogin): Promise<boolean> {
const invalid = false;
if (invalid) throw new Error("Invalid payload.");
return Promise.resolve(true);
}
}
// sequelize
export class AccountLoginSqlService extends BaseServiceSequelize<
AccountLogin
> {
constructor() {
super(AccountLogin);
}
sentitiveInfo: any = ["id"];
protected async validate(
entity: AccountLogin,
payload: AccountLogin
): Promise<boolean> {
const invalid = false;
if (invalid) throw new Error("Invalid payload.");
return Promise.resolve(true);
}
}
import * as mongoose from 'mongoose';
export interface AccountLogin extends mongoose.Document {
ip_number: string;
browser: string;
created_at: Date;
}
const schema = new mongoose.Schema({
ip_number: { type: String , required: true},
browser: { type: String },
created_at: { type: Date, required: true },
});
schema.set('toJSON', { virtuals: true });
export default mongoose.model<AccountLogin>('AccountLogin', schema, 'account_login');
import {
BelongsTo,
Column,
CreatedAt,
ForeignKey,
Model,
Scopes,
Table
} from "sequelize-typescript";
@Scopes(() => ({}))
@Table({ tableName: "account_login", updatedAt: false })
export default class AccountLogin extends Model<AccountLogin> {
@Column
ip_number: string;
@Column
browser: string;
/* auto */
@CreatedAt
@Column
created_at: Date;
}
?
fields=
&offset=
&limit=
&sort=[["", "ASC|DESC"]]
&filter={"":""}
fields: Select the existing fields in model, comma separeted.
offset: To skip lines before starting to return the lines.
OFFSET 0 is the same as omitting the OFFSET parameter
limit: If the limit is specified, no more than this number of lines will be returned.
When using LIMIT it is important to use the SORT parameter to establish a single order for the result lines
filter: Select the existing fields in model and values filter, based in JSON.
Example: filter=[{"field name":, "field value"}]
Template based on sequelize: Applyng where clauses
sort: Select the existing fields in the model to order the result, based in JSON.
Example: sort=[["field name": "ASC|DESC"]]
Template based on sequelize: Ordering and grouping
# build tsc
$ npm run build
$ npm run test
$ npm run test:coverage
$ npm run cover:report
🚧 Testing API Health 🚧
1589087475331 info server started at: http://127.0.0.1:5005
Health API
[2020-05-10T05:11:15.354Z] GET http://127.0.0.1:5005/documentation 200 (19 ms) {}
✓ /documentation should return 200
[2020-05-10T05:11:15.358Z] GET http://127.0.0.1:5005/health 200 (1 ms) {}
✓ /health should return 200
[2020-05-10T05:11:15.360Z] GET http://127.0.0.1:5005/status 200 (1 ms) {}
✓ /status should return 200
1589087475361 info server stopped at: http://127.0.0.1:5005
🚧 Resource api/todos 🚧
1589087476139 info server started at: http://127.0.0.1:5005
API api/todos
[2020-05-10T05:11:16.142Z] POST http://127.0.0.1:5005/api/auth 404 (1 ms) {}
✓ POST api/auth - should return 404 not found
[2020-05-10T05:11:16.148Z] GET http://127.0.0.1:5005/api/auth 200 (4 ms) {}
✓ GET api/auth - should return 200 with new token
[2020-05-10T05:11:16.153Z] POST http://127.0.0.1:5005/api/todos 200 (4 ms) {"title":"Test TODO","description":"Description of my todo","done":false}
✓ POST api/todos - should return 200 with new resource created
[2020-05-10T05:11:16.157Z] POST http://127.0.0.1:5005/api/todos 400 (2 ms) {"title":"","description":"Description of my todo","done":false}
✓ POST api/todos - should return 400 and inform that the title is required
[2020-05-10T05:11:16.159Z] POST http://127.0.0.1:5005/api/todos 400 (1 ms) {"title":"Test TODO","description":"","done":false}
✓ POST api/todos - should return 400 and inform that the description is required
[2020-05-10T05:11:16.164Z] PATCH http://127.0.0.1:5005/api/todos/99100 200 (4 ms) {"title":"Test TODO","description":"Description of my todo","done":false}
✓ PATCH api/todos/{id} - should return 200 with modified resource
[2020-05-10T05:11:16.167Z] PATCH http://127.0.0.1:5005/api/todos/99100 400 (2 ms) {"title":"Test TODO","description":"Description of my todo","done":false,"something":true}
✓ PATCH api/todos/{id} - should return 400 with not allowed keys message
[2020-05-10T05:11:16.171Z] PATCH http://127.0.0.1:5005/api/todos/99100 401 (1 ms) {}
✓ PATCH api/todos/{id} - should return 401 unauthorized
[2020-05-10T05:11:16.174Z] GET http://127.0.0.1:5005/api/todos?title=test&description=terr&done=false 200 (2 ms) {}
✓ GET api/todos - should return 200 with one row
[2020-05-10T05:11:16.177Z] DELETE http://127.0.0.1:5005/api/todos/99100 200 (2 ms) {}
✓ DELETE api/todos/{id} - should return 200
[2020-05-10T05:11:16.178Z] DELETE http://127.0.0.1:5005/api/todos/99100 401 (0 ms) {}
✓ DELETE api/todos/{id} - should return 401 unauthorized
1589087476179 info server stopped at: http://127.0.0.1:5005
14 passing (2s)
[Pending]
[2.1.18] - 2021-03-05
Custom/Override server plugins
FAQs
xhelpers-api is an open source project that enables developers to easily create and manage micro-services into their own environment
The npm package xhelpers-api receives a total of 58 weekly downloads. As such, xhelpers-api popularity was classified as not popular.
We found that xhelpers-api demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Ransomware negotiators share how modern cybercriminals operate like corporations, using specialized teams, negotiation tactics, and reputation management.
Security News
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.