Santuy is a nodejs framework and database generator from model schema.
You are viewing docs for the v1 of santuy
Features:
npm i santuy
init "Generate santuy directory"
sync "Database sync"
seed "Database seeder"
generate "Generate model or seed"
-- create database
CREATE DATABASE `database_name`;
npx santuy init
npx santuy generate model [model_name]
npx santuy generate model users
[use lowercase underscores for model name and column name]
//model users (file: santuy/models/users.js)
const UsersModel = {
name: 'users',
icon: 'AiFillCaretRight',
columns: [
{
name: 'id',
title: 'ID',
dataType: 'INT AUTO_INCREMENT PRIMARY KEY',
inputType: 'number',
},
{
name: 'username',
title: 'Username',
dataType: 'VARCHAR(100) NULL',
inputType: 'text',
},
{
name: 'password',
title: 'Password',
dataType: 'VARCHAR(255) NULL',
inputType: 'password',
},
{
name: 'name',
title: 'Name',
dataType: 'VARCHAR(30) NULL',
inputType: 'text',
},
{
name: 'avatar',
title: 'Avatar',
dataType: 'VARCHAR(100) NULL',
inputType: 'image',
},
{
name: 'address',
title: 'Address',
dataType: 'VARCHAR(100) NULL',
inputType: 'textarea',
},
],
}
module.exports = UsersModel
npx santuy generate model categories
//model categories (file: santuy/models/categories.js)
const CategoriesModel = {
name: 'categories',
icon: 'AiFillCaretRight',
columns: [
{
name: 'id',
title: 'ID',
dataType: 'INT AUTO_INCREMENT PRIMARY KEY',
inputType: 'number',
},
{
name: 'name',
title: 'Category Name',
dataType: 'VARCHAR(50) NULL',
inputType: 'text',
},
],
}
module.exports = CategoriesModel
npx santuy generate model products
//model products (file: santuy/models/products.js)
const ProductsModel = {
name: 'products',
icon: 'AiFillCaretRight',
columns: [
{
name: 'id',
title: 'ID',
dataType: 'INT AUTO_INCREMENT PRIMARY KEY',
inputType: 'number',
},
{
name: 'category_id',
title: 'Category',
dataType: 'INT NULL',
inputType: 'select',
selectData: "categories",
relation: {
field: 'category_id',
reference: 'categories.id',
select: 'categories.name'
},
},
{
name: 'name',
title: 'Item Name',
dataType: 'VARCHAR(100) NULL',
inputType: 'text',
},
{
name: 'plu',
title: 'PLU',
dataType: 'VARCHAR(50) NULL',
inputType: 'text',
},
{
name: 'unit',
title: 'Unit',
dataType: 'VARCHAR(30) NULL',
inputType: 'text',
},
{
name: 'cost',
title: 'Cost',
dataType: 'INT NULL',
inputType: 'number',
},
{
name: 'price',
title: 'Price',
dataType: 'INT NULL',
inputType: 'number',
},
{
name: 'qty',
title: 'Qty',
dataType: 'INT NULL',
inputType: 'number',
},
]
}
module.exports = ProductsModel
[mysql] DATABASE_URL="mysql://USER:PASSWORD@HOST:PORT/DATABASE"
[postgresql] DATABASE_URL="postgresql://USER:PASSWORD@HOST:PORT/DATABASE"
DATABASE_URL="mysql://root:@localhost:3306/database_name"
DATABASE_URL="postgresql://postgres:password@localhost:5432/database_name"
npx santuy sync
[*if sync fails with relations, try to reorder models list from models/schema.js]
npx santuy generate seed [model_name]
npx santuy generate seed users
[seed users (file: santuy/seeds/users.json)]
[
{
"username": "admin",
"password": "admin123",
"name": "Admin",
"avatar": "https://ui-avatars.com/api/?name=Admin%20Dashboard",
"address": "Jl. Ahmad Yani No. 790"
}
]
npx santuy seed users
[routes/index]
var express = require('express')
var router = express.Router()
const { models } = require("../santuy/schema")
const { get, detail, create, update, remove, restore, raw } = require("santuy")
/* GET DATA. */
/* GET: http://localhost:3000/?model=users */
router.get('/', async function (req, res, next) {
const modelName = req.query.model
let page = req.query.page ?? ""
let limit = req.query.limit ?? "10"
const model = models[modelName]
page = parseInt(page)
limit = parseInt(limit)
let payload = {
model,
paginate: page ? {
page,
limit
} : null
}
const response = await get(payload)
if (response) {
res.send(response)
} else {
res.send({ message: "error" })
}
})
/* GET DETAIL DATA. */
/* GET: http://localhost:3000/1/?model=users */
router.get('/:id', async function (req, res, next) {
let id = req.params.id ?? ""
const modelName = req.query.model
const model = models[modelName]
let payload = {
model,
id
}
const response = await detail(payload)
if (response) {
res.send(response)
} else {
res.send({ message: "error" })
}
})
/* CREATE DATA. */
/* POST: http://localhost:3000/?model=users */
router.post('/', async function (req, res, next) {
const modelName = req.query.model
const model = models[modelName]
const data = req.body
let payload = {
model,
data
}
const response = await create(payload)
if (response) {
res.send(response)
} else {
res.send({ message: "error" })
}
})
/* UPDATE DATA. */
/* PUT: http://localhost:3000/1/?model=users */
router.put('/:id', async function (req, res, next) {
let id = req.params.id ?? ""
const modelName = req.query.model
const model = models[modelName]
const data = req.body
let payload = {
model,
data,
id
}
const response = await update(payload)
if (response) {
res.send(response)
} else {
res.send({ message: "error" })
}
})
/* DELETE DATA. */
/* DELETE: http://localhost:3000/1/?model=users */
router.delete('/:id', async function (req, res, next) {
let id = req.params.id ?? ""
const modelName = req.query.model
const model = models[modelName]
let payload = {
model,
id
}
const response = await remove(payload)
if (response) {
res.send(response)
} else {
res.send({ message: "error" })
}
})
/* RESTORE DATA. */
/* PUT: http://localhost:3000/restore/1/?model=users */
router.put('/restore/:id', async function (req, res, next) {
let id = req.params.id ?? ""
const modelName = req.query.model
const model = models[modelName]
let payload = {
model,
id
}
const response = await restore(payload)
if (response) {
res.send(response)
} else {
res.send({ message: "error" })
}
})
module.exports = router
[routes/query]
var express = require('express')
var router = express.Router()
const { raw } = require("santuy")
/* RAW QUERY. */
/* GET: http://localhost:3000/query/raw/ */
router.get('/raw', async function (req, res, next) {
const response = await raw("SELECT * FROM users")
if (response) {
res.send(response)
} else {
res.send({ message: "error" })
}
})
module.exports = router
export interface DatabaseType {
host: string | 'localhost';
user: string | 'root';
password: string;
port: number | 3306;
database: string;
}
export interface ModelType {
name: string;
icon?: string;
columns: Array<ColumnType>;
includes?: Array<IncludeType>;
}
export interface ColumnType {
name: 'id' | string | ModelType;
title: string;
dataType?: string;
inputType?: InputType;
selectData?: string | Array<string>;
relation?: RelationType;
}
type InputType = 'text' | 'number' | 'password' | 'email' | 'select' | 'textarea' | 'file' | 'image' | 'hidden' | 'checkbox';
export interface IncludeType {
model: ModelType;
relation: string;
}
export interface RelationType {
field: string;
reference: string;
select: string;
}
export interface SyncType {
models: any;
}
export interface SeedType {
model: ModelType;
path: string;
}
export interface GetType {
model: ModelType;
paginate?: PaginateType | null;
}
export interface DetailType {
model: ModelType;
id: number | string;
}
export interface CreateType {
model: ModelType;
data: any;
}
export interface UpdateType {
model: ModelType;
data: any;
id: number | string;
}
export interface RemoveType {
model: ModelType;
id: number | string;
}
export interface RestoreType {
model: ModelType;
id: number | string;
}
export interface PaginateType {
page: number;
limit: number;
}
export interface ResultType {
data: Array<Object | null> | null | false | undefined;
page?: number;
limit?: number;
total?: number;
}
FAQs
Santuy is a nodejs framework and database generator from model schema.
The npm package santuy receives a total of 29 weekly downloads. As such, santuy popularity was classified as not popular.
We found that santuy demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 3 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
In this segment of the Risky Business podcast, Feross Aboukhadijeh and Patrick Gray discuss the challenges of tracking malware discovered in open source softare.
Research
Security News
A threat actor's playbook for exploiting the npm ecosystem was exposed on the dark web, detailing how to build a blockchain-powered botnet.
Security News
NVD’s backlog surpasses 20,000 CVEs as analysis slows and NIST announces new system updates to address ongoing delays.