Santuy is a nextjs framework and SQL for auto generate data from model
You are viewing docs for the v1 of santuy
Features:
npm i santuy
init "Generate santuy directory"
migrate "Database migration & sync"
seed "Database seeder"
generate "Generate model or seed"
-- create database
CREATE DATABASE `database_name`;
{
"compilerOptions": {
"paths": {
"@/*": [
"./src/*"
],
"@santuy/*": [
"./santuy/*"
],
"@santuyapi/*": [
"./node_modules/santuy/dist/*"
]
}
}
}
npx santuy init
npx santuy generate model [model_name]
npx santuy generate model users
//model users (file: santuy/models/users.mjs)
const UsersModel = {
name: 'users',
icon: 'AiOutlineUser',
columns: [
{
name: 'id',
title: 'ID',
dataType: 'INT AUTO_INCREMENT PRIMARY KEY',
inputType: 'number',
},
{
name: 'username',
title: 'Username',
dataType: 'VARCHAR(30) NULL',
inputType: 'text',
},
{
name: 'password',
title: 'Password',
dataType: 'VARCHAR(100) NULL',
inputType: 'password',
},
{
name: 'name',
title: 'Name',
dataType: 'VARCHAR(30) NULL',
inputType: 'text',
},
{
name: 'avatar',
title: 'Avatar',
dataType: 'TEXT NULL',
inputType: 'image',
},
{
name: 'address',
title: 'Address',
dataType: 'TEXT NULL',
inputType: 'textarea',
},
],
};
export default UsersModel
npx santuy generate model categories
//model categories (file: santuy/models/categories.mjs)
const CategoriesModel = {
name: 'categories',
icon: 'AiOutlineFileAdd',
columns: [
{
name: 'id',
title: 'ID',
dataType: 'INT AUTO_INCREMENT PRIMARY KEY',
inputType: 'number',
},
{
name: 'name',
title: 'Category Name',
dataType: 'VARCHAR(30) NULL',
inputType: 'text',
},
],
};
export default CategoriesModel
npx santuy generate model products
//model products (file: santuy/models/products.mjs)
const ProductsModel = {
name: 'products',
icon: 'AiOutlineFileAdd',
columns: [
{
name: 'id',
title: 'ID',
dataType: 'INT AUTO_INCREMENT PRIMARY KEY',
inputType: 'number',
},
{
name: 'categoryId',
title: 'Category',
dataType: 'INT NULL',
inputType: 'select',
selectData: "categories",
relation: {
field: 'categoryId',
reference: 'categories.id',
select: 'categories.name'
},
},
{
name: 'name',
title: 'Item Name',
dataType: 'VARCHAR(50) 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',
},
]
};
export default ProductsModel
DATABASE_URL="mysql://root:@localhost:3306/database_name"
npx santuy migrate
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
//file: api/get/route.ts
//GET: http://localhost:3000/api/get/?model=users
//Pagination -> GET: http://localhost:3000/api/get/?model=users&page=1&limit=10
import { NextResponse } from 'next/server';
import { NextRequest } from "next/server";
import { GetType, get, ModelType } from 'santuy';
import { models } from '@santuy/schema.mjs'
export async function GET(request: NextRequest) {
const modelName = request.nextUrl.searchParams.get("model") ?? "";
const mod: any = models;
const model: ModelType = mod[modelName];
let page: any = request.nextUrl.searchParams.get("page") ?? "0";
let limit: any = request.nextUrl.searchParams.get("limit") ?? "10";
page = parseInt(page);
limit = parseInt(limit);
let getData: GetType = {
model,
paginate: page ? {
page,
limit
} : null
}
const response: any = await get(getData);
if (!response) {
return NextResponse.json("No Data!", { status: 400 })
}
return NextResponse.json(response, { status: 200 })
}
//file: api/detail/route.ts
//GET: http://localhost:3000/api/detail/?model=users&id=1
import { NextResponse } from 'next/server';
import { NextRequest } from "next/server";
import { DetailType, ModelType, detail } from 'santuy';
import { models } from '@santuy/schema.mjs'
export async function GET(request: NextRequest) {
const modelName = request.nextUrl.searchParams.get("model") ?? "";
const mod: any = models;
const model: ModelType = mod[modelName];
let id: any = request.nextUrl.searchParams.get("id");
let detailData: DetailType = {
model,
id: parseInt(id) ?? null
}
const response: any = await detail(detailData);
if (!response) {
return NextResponse.json("No Data!", { status: 400 })
}
return NextResponse.json(response, { status: 200 })
}
//file: api/create/route.ts
//POST: http://localhost:3000/api/create/?model=users
import { NextResponse } from 'next/server';
import { NextRequest } from "next/server";
import { CreateType, ModelType, create } from 'santuy';
import { models } from '@santuy/schema.mjs'
export async function POST(request: NextRequest) {
const modelName = request.nextUrl.searchParams.get("model") ?? "";
const mod: any = models;
const model: ModelType = mod[modelName];
const data = await request.json();
let createData: CreateType = {
model,
data
}
const response: any = await create(createData);
if (!response) {
return NextResponse.json("No Data!", { status: 400 })
}
return NextResponse.json(response, { status: 200 })
}
//file: api/update/route.ts
//PUT: http://localhost:3000/api/update/?model=users&id=1
import { NextResponse } from 'next/server';
import { NextRequest } from "next/server";
import { ModelType, UpdateType, update } from 'santuy';
import { models } from '@santuy/schema.mjs'
export async function PUT(request: NextRequest) {
const modelName = request.nextUrl.searchParams.get("model") ?? "";
const mod: any = models;
const model: ModelType = mod[modelName];
const id = request.nextUrl.searchParams.get("id") ?? "";
const data = await request.json();
let updateData: UpdateType = {
model,
data,
id: parseInt(id)
}
const response: any = await update(updateData);
if (!response) {
return NextResponse.json("No Data!", { status: 400 })
}
return NextResponse.json(response, { status: 200 })
}
//file: api/remove/route.ts
//DELETE: http://localhost:3000/api/remove/?model=users&id=1
import { NextResponse } from 'next/server';
import { NextRequest } from "next/server";
import { ModelType, RemoveType, remove } from 'santuy';
import { models } from '@santuy/schema.mjs'
export async function DELETE(request: NextRequest) {
const modelName = request.nextUrl.searchParams.get("model") ?? "";
const mod: any = models;
const model: ModelType = mod[modelName];
const id = request.nextUrl.searchParams.get("id") ?? "";
let removeData: RemoveType = {
model,
id: parseInt(id)
}
const response: any = await remove(removeData);
if (!response) {
return NextResponse.json("No Data!", { status: 400 })
}
return NextResponse.json(response, { status: 200 })
}
//file: api/restore/route.ts
//PUT: http://localhost:3000/api/restore/?model=users&id=1
import { NextResponse } from 'next/server';
import { NextRequest } from "next/server";
import { ModelType, RestoreType, restore } from 'santuy';
import { models } from '@santuy/schema.mjs'
export async function PUT(request: NextRequest) {
const modelName = request.nextUrl.searchParams.get("model") ?? "";
const mod: any = models;
const model: ModelType = mod[modelName];
const id = request.nextUrl.searchParams.get("id") ?? "";
let restoreData: RestoreType = {
model,
id: parseInt(id)
}
const response: any = await restore(restoreData);
if (!response) {
return NextResponse.json("No Data!", { status: 400 })
}
return NextResponse.json(response, { status: 200 })
}
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 MigrateType {
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 RawType {
query: string,
params?: Array<string | number>
}
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 0 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
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.
Security News
The Ultralytics' PyPI Package was compromised four times in one weekend through GitHub Actions cache poisoning and failure to rotate previously compromised API tokens.