@keltoi/hydra 1.0.0

package/.github/workflows/npm-publish.yml

@@ -0,0 +1,33 @@
+# This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
+# For more information see: https://docs.github.com/en/actions/publishing-packages/publishing-nodejs-packages
+
+name: Node.js Package
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+      - run: npm ci
+      - run: npm test
+
+  publish-npm:
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          registry-url: https://registry.npmjs.org/
+      - run: npm ci
+      - run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.KELTOI_GITPUB}}

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Keltoi
+
+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,2 @@
+# HydraJs
+Boilerplate to start your API from zero using Repository Pattern

package/index.js

@@ -0,0 +1 @@
+"use strict";var t=require("knex"),e=require("axios");class Model{#t;constructor(t={}){this.#t=t}get key(){return this.#t}set key(t={}){this.#t=t}get entity(){return{}}}class Logged extends Model{#e=new Date;#n=void 0|new Date;#s=!0;constructor({key:t={},createdAt:e=new Date,updatedAt:n=void 0|new Date,active:s=!0}){super(t),this.#s=s,this.#n=n,this.#e=e}get createdAt(){return this.#e}set createdAt(t=new Date){this.createdAt=t}get updatedAt(){return this.#n}set updatedAt(t=new Date){this.#n=t}get active(){return this.#s}set active(t=!0){this.#s=t}static makeMe(e=t(),n=Model,s=(e=new t.TableBuilder)=>{}){return e.schema.createTable(n.name,(t=>{s(t),t.dateTime("createdAt").notNullable().defaultTo(e.fn.now()),t.dateTime("updatedAt").nullable(),t.boolean("active").defaultTo(!0)}))}}class Thing extends Model{#o;constructor({key:t={},name:e=""}){super(t),this.#o=e}get name(){return this.#o}set name(t=""){this.#o=t}get entity(){return{name:this.#o}}static makeMe(e=t(),n=Thing,s=(e=new t.TableBuilder)=>{}){return e.schema.createTable(n.name,(t=>{s(t),t.string(255).notNullable()}))}}let n=class Context{#r;constructor(e=t()){this.#r=e}get db(){return this.#r}unitOfWork(...t){return this.#r.transaction().then((e=>(t.forEach((t=>t.context=e)),{done:()=>e.commit().then((()=>t.forEach((t=>t.resetContext())))),rollback:()=>e.rollback().then((()=>t.forEach((t=>t.resetContext()))))})))}static instance(e=t()){return new Context(e)}async terraform(t=[]){const e=t.map((async t=>{await this.#r.schema.hasTable(t.name)||await t.makeMe(this.#r)}));await Promise.all(e)}},s=class Repository{#o="";myContext;static anyOrError(t,e={code:0,message:""}){if(t)return t;throw e}static setOrEmpty(t=[],e=t=>t){return t.length?t.map(e):[]}constructor(t=Model,e=new n){this.#o=t.name,this.myContext=()=>e.db(this.#o),this.resetContext=()=>{this.myContext=()=>e.db(this.#o)},this.modelInstance=(e={})=>new t(e)}set context(e=t()){this.myContext=()=>e(this.#o)}insert=(t=new Model)=>this.myContext().insert(t.entity,Object.keys(t.key)).then((e=>t.key=e[0])).then((()=>t));update=(t=new Model)=>this.myContext().where(t.key).update(t.entity).then((t=>t>0));delete=(t={})=>this.myContext().where(t).del().then((t=>t>0));get=(t={})=>this.myContext().where(t).first().then(Repository.anyOrError).then(this.modelInstance);list=()=>this.myContext().select().then((t=>Repository.setOrEmpty(t,this.modelInstance)))};class Context{#a;constructor(t=e.create({})){this.#a=t}get http(){return this.#a}}class Repository{#i;constructor(t=Model,e=new Context){this.#i=e,this.modelInstance=(e={})=>new t(e)}static queryString(t={}){return"?"+Object.entries(t).map((([t,e])=>`${t}=${e}`)).join("&")}get context(){return this.#i}}exports.ApiContext=Context,exports.ApiRepository=Repository,exports.ApiRestRepository=class RestRepository extends Repository{constructor(t=Model,e=new Context){super(t,e)}#h=(t="",e=void 0|{})=>this.context.http.get(e?`${t}${Repository.queryString(e)}`:t);get=(t="",e=void 0|{})=>this.#h(t,e).then((t=>this.modelInstance(t)));list=(t="",e=void 0|{})=>this.#h(t,e).then(((t=[])=>t.map((t=>this.modelInstance(t)))));create=(t="",e=new Model)=>this.context.http.post(t,e.entity);update=(t="",e=new Model)=>this.context.http.put(t,e.entity);change=(t="",e=new Model)=>this.context.http.patch(t,e.entity);delete=(t,e=new Model)=>this.context.http.delete(`/${t}`)},exports.DbContext=n,exports.DbLoggedRepository=class LoggedRepository extends s{constructor(t=Logged,e=new n){super(t,e)}deceased=()=>this.myContext().where({active:!1}).select().then((t=>t.map(this.modelInstance)));get=(t={})=>this.myContext().where({...t,active:!0}).first().then(this.modelInstance);before=(t=new Date)=>this.myContext().where("createdAt","<",t.toISOString()).select().then((t=>t.map(this.modelInstance)));after=(t=new Date)=>this.myContext().where("createdAt",">",t.toISOString()).select().then((t=>t.map(this.modelInstance)));list=()=>this.myContext().select().orderBy("createdAt","updatedAt").where({active:!0}).then((t=>t.map(this.modelInstance)));update=(t=new Logged)=>this.myContext().where(t.key).update({...t.entity,updatedAt:new Date}).then((t=>t>0));delete=(t={})=>this.myContext().where(t).update({updatedAt:(new Date).toISOString(),active:!1}).then((t=>t>0))},exports.DbRepository=s,exports.DbThingRepository=class ThingRepository extends s{constructor(t=new n){super(model=Thing,t)}getByName=(t="")=>this.myContext().where({name:t}).select().then((t=>this.modelInstance(t)))},exports.Logged=Logged,exports.Model=Model,exports.Thing=Thing;

package/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "@keltoi/hydra",
+  "version": "1.0.0",
+  "description": "Boilerplate to start your API from zero using Repository Pattern",
+  "main": "index.js",
+  "scripts": {
+    "test": "npm run build & npm link",
+    "build": "rollup -c"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Keltoi-Tech/HydraJs.git"
+  },
+  "keywords": [
+    "API",
+    "RepositoryPattern"
+  ],
+  "author": "DaniloHenrique",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/Keltoi-Tech/HydraJs/issues"
+  },
+  "homepage": "https://github.com/Keltoi-Tech/HydraJs#readme",
+  "dependencies": {
+    "@rollup/plugin-terser": "^0.4.4",
+    "axios": "^1.7.7",
+    "knex": "^3.1.0",
+    "rollup": "^4.24.4"
+  }
+}

package/rollup.config.mjs

@@ -0,0 +1,17 @@
+import terser from '@rollup/plugin-terser';
+
+export default {
+    input:'src/index.js',
+    plugins:[
+        terser({
+            keep_classnames:true,
+            keep_fnames:true
+        })
+    ],
+    output:[
+        {
+            file:'index.js',
+            format:'cjs'
+        }
+    ]
+}

package/src/index.js

@@ -0,0 +1,23 @@
+import Logged from './model/logged.js'
+import Model from './model/index.js'
+import Thing from './model/thing.js'
+import DbContext from './repository/db/context.js'
+import DbRepository from './repository/db/index.js'
+import DbLoggedRepository  from './repository/db/loggedRepository.js'
+import DbThingRepository from './repository/db/thingRepository.js'
+import ApiContext from './repository/api/context.js'
+import ApiRepository from './repository/api/index.js'
+import ApiRestRepository from './repository/api/restRepository.js'
+
+export {
+    Model,
+    Thing,
+    Logged,
+    DbContext,
+    DbRepository,
+    DbLoggedRepository,
+    DbThingRepository,
+    ApiContext,
+    ApiRepository,
+    ApiRestRepository
+}

package/src/model/index.js

@@ -0,0 +1,12 @@
+export default class Model{
+    #key
+    constructor(key={}){
+        this.#key = key
+    }
+
+    get key(){return this.#key }
+    set key(value={}){this.#key=value}    
+
+    get entity(){return {}}
+
+}

package/src/model/logged.js

@@ -0,0 +1,34 @@
+import knex from "knex"
+import Model from "./index.js"
+
+export default class Logged extends Model{
+    #createdAt=new Date()
+    #updatedAt=new Date()|undefined
+    #active=true
+
+    constructor({key={},createdAt=new Date(),updatedAt=new Date()|undefined,active=true}){
+        super(key)
+        this.#active=active
+        this.#updatedAt = updatedAt
+        this.#createdAt = createdAt
+    }
+
+    get createdAt(){return this.#createdAt}
+    set createdAt(value = new Date()){this.createdAt = value}
+
+    get updatedAt(){return this.#updatedAt}
+    set updatedAt(value = new Date()){this.#updatedAt = value}
+
+    get active(){return this.#active}
+    set active(value = true){this.#active = value}
+
+    static makeMe(db=knex(),model=Model,schema=(t=new knex.TableBuilder())=>{}){
+        return db.schema.createTable(model.name,table=>{
+            schema(table)
+
+            table.dateTime('createdAt').notNullable().defaultTo(db.fn.now())
+            table.dateTime('updatedAt').nullable()
+            table.boolean('active').defaultTo(true)
+        })
+    }
+}

package/src/model/thing.js

@@ -0,0 +1,26 @@
+import knex from "knex";
+import Model from "./index.js";
+
+
+export default class Thing extends Model{
+    #name
+    constructor({key={},name=''}){
+        super(key)
+        this.#name = name
+    }
+
+    get name(){return this.#name}
+    set name(value=''){this.#name=value}    
+
+    get entity(){
+        return {name:this.#name}
+    }
+
+    static makeMe(db=knex(),thing=Thing,schema=(t=new knex.TableBuilder())=>{}){
+        return db.schema.createTable(thing.name,table=>{
+            schema(table)
+
+            table.string(255).notNullable()
+        })
+    }
+}

package/src/repository/api/context.js

@@ -0,0 +1,10 @@
+import axios from "axios"
+
+export default class Context{
+    #http
+    constructor(config=axios.create({})){
+        this.#http = config
+    }
+
+    get http(){return this.#http}
+}

package/src/repository/api/index.js

@@ -0,0 +1,16 @@
+import Model  from "../../model/index.js"
+import Context from "./context.js"
+
+export default class Repository{
+    #context
+    constructor(model=Model,context=new Context()){
+        this.#context = context
+        this.modelInstance=(m={})=>new model(m)
+    }
+
+    static queryString(param={}){
+        return '?' + Object.entries(param).map(([k,v])=>`${k}=${v}`).join('&')
+    }
+
+    get context(){return this.#context}
+}

package/src/repository/api/restRepository.js

@@ -0,0 +1,26 @@
+import Model from "../../model/index.js"
+import Context from "./context.js"
+import Repository from "./index.js"
+
+
+export default class RestRepository extends Repository{
+    constructor(model=Model,context=new Context()){
+        super(model,context)
+    }
+
+    #httpGet=(route='',query={}|undefined)=>this.context
+        .http
+        .get(!! query ? `${route}${Repository.queryString(query)}` : route)
+
+    get=(route='',query={}|undefined)=>this.#httpGet(route,query).then(value=>this.modelInstance(value))
+
+    list=(route='',query={}|undefined)=>this.#httpGet(route,query).then((values=[])=>values.map(value=>this.modelInstance(value)))
+
+    create=(route='',model=new Model())=>this.context.http.post(route,model.entity)
+
+    update=(route='',model=new Model())=>this.context.http.put(route,model.entity)
+
+    change=(route='',model=new Model())=>this.context.http.patch(route,model.entity)
+
+    delete=(id,model=new Model())=>this.context.http.delete(`/${id}`)
+}

package/src/repository/db/context.js

@@ -0,0 +1,33 @@
+import knex from "knex"
+
+export default class Context{
+    #db
+
+    constructor(database=knex()){
+        this.#db= database
+    }
+
+    get db(){return this.#db}
+
+    unitOfWork(...repositories){
+        return this.#db.transaction().then(trx=>{
+            repositories.forEach(repo=>repo.context = trx)
+
+            return {
+                done:()=>trx.commit().then(()=>repositories.forEach(repo=>repo.resetContext())),
+                rollback:()=>trx.rollback().then(()=>repositories.forEach(repo=>repo.resetContext()))
+            }
+        })
+    }
+
+    static instance(database=knex()){return new Context(database)}
+
+    async terraform(models=[]){
+        const promises = models.map(async model=>{
+            const exists = await this.#db.schema.hasTable(model.name)
+            if (!exists) await model.makeMe(this.#db)
+        })
+
+        await Promise.all(promises)
+    }
+}

package/src/repository/db/index.js

@@ -0,0 +1,63 @@
+import knex from "knex";
+import Model from "../../model/index.js";
+import Context from "./context.js";
+
+
+export default class Repository{
+    #name='';
+
+    myContext
+
+    static anyOrError(model,err={code:0,message:''}){
+        if (!!model) return model
+
+        throw err;
+    }
+
+    static setOrEmpty(array=[],modeling=(e)=>e){
+        return array.length ? array.map(modeling) : []
+    }
+
+
+    constructor(model=Model,context=new Context())
+    {
+        this.#name = model.name
+        this.myContext=()=>context.db(this.#name)
+        this.resetContext=()=>{
+            this.myContext=()=>context.db(this.#name)
+        }
+        this.modelInstance=(m={})=>new model(m)
+    }
+
+    set context(value=knex()){ this.myContext=()=>value(this.#name)}
+
+    insert=(model=new Model())=>
+        this.myContext()
+        .insert(model.entity,Object.keys(model.key))
+        .then(ids=>model.key = ids[0])
+        .then(()=>model)
+
+    update=(model=new Model())=>
+        this.myContext()
+        .where(model.key)
+        .update(model.entity)
+        .then(affected=>affected > 0)
+
+    delete=(key={})=>
+        this.myContext()
+        .where(key)
+        .del()
+        .then(affected=>affected > 0)
+
+    get=(key={})=>
+        this.myContext()
+       .where(key)
+       .first()
+       .then(Repository.anyOrError)
+       .then(this.modelInstance) 
+
+    list=()=>
+        this.myContext()
+        .select()
+        .then(result=>Repository.setOrEmpty(result,this.modelInstance))
+}

package/src/repository/db/loggedRepository.js

@@ -0,0 +1,54 @@
+import Logged from '../../model/logged.js';
+import Context from './context.js';
+import Repository from './index.js';
+
+export default class LoggedRepository extends Repository{
+    constructor(model=Logged,context=new Context()){
+        super(model,context)
+    }
+
+    deceased=()=>this.myContext()
+        .where({active:false})
+        .select()
+        .then(deads=>deads.map(this.modelInstance))
+
+    get=(key={})=>this.myContext()
+        .where({...key,active:true})
+        .first()
+        .then(this.modelInstance)
+
+    before=(date=new Date())=>this.myContext()
+        .where('createdAt','<',date.toISOString())
+        .select()
+        .then(result=>result.map(this.modelInstance))
+
+    after=(date=new Date())=>this.myContext()
+        .where('createdAt','>',date.toISOString())
+        .select()
+        .then(result=>result.map(this.modelInstance))
+
+    list=()=>this.myContext()
+        .select()
+        .orderBy('createdAt','updatedAt')
+        .where({active:true})
+        .then(result=>result.map(this.modelInstance))
+
+    update=(model=new Logged())=>
+        this.myContext()
+        .where(model.key)
+        .update({
+            ...model.entity,
+            updatedAt:new Date()
+        })
+        .then(affected=> affected > 0)
+
+    delete=(key={})=>
+        this.myContext()
+        .where(key)
+        .update({
+            updatedAt:new Date().toISOString(),
+            active:false
+        })
+        .then(affected=> affected > 0)
+    
+}

package/src/repository/db/thingRepository.js

@@ -0,0 +1,14 @@
+import Thing from "../../model/thing.js";
+import Context from "./context.js";
+import Repository from "./index.js";
+
+export default class ThingRepository extends Repository{
+    constructor(context=new Context()){
+        super(model=Thing,context)
+    }
+
+    getByName=(name='')=>this.myContext()
+        .where({name})
+        .select()
+        .then(model=>this.modelInstance(model))
+}