miolo 2.1.0-beta.1 → 3.0.0-beta.2

package/src/{server/config → config}/defaults.mjs

@@ -1,3 +1,4 @@
+import path from 'path'
 const SESSION_MAX_AGE = 86400 * 10 * 1000
 
 
@@ -9,10 +10,10 @@ const SESSION_MAX_AGE = 86400 * 10 * 1000
 
 
 export default {
-  name: 'miolo',
+  name: process.env.MIOLO_NAME,
   http: {
-    port: 8001,
-    hostname: 'localhost',
+    port: process.env?.MIOLO_PORT || 8001,
+    hostname: process.env?.MIOLO_HOSTNAME || 'localhost',
 
     catcher_url: '/sys/jserror',
     
@@ -27,37 +28,41 @@ export default {
     //   - true      enable @koa/cors
     //   - {options} enable @koa/cors and use the custom options
     //
-    cors: 'simple',
+    cors: process.env.MIOLO_HTTP_CORS==='true'
+      ? true
+      : process.env.MIOLO_HTTP_CORS==='simple'
+      ? 'simple'
+      : false,
 
     // proxy can be:
     //   - false
     //   - true      enable koa-proxies and use default options
     //   - {options} enable koa-proxies and use the custom options
-    proxy: false,
+    proxy: process.env.MIOLO_HTTP_PROXY==='true',
 
     ratelimit: {
       /* eslint-disable no-unused-vars */
-      max: 1000,
-      duration: 60 * 1000, // miliseconds
+      max: parseInt(process.env.MIOLO_RATELIMIT_MAX || 1000),
+      duration: parseInt(process.env.MIOLO_RATELIMIT_DURATION || 60 * 1000), // miliseconds
       errorMessage: 'Rate Limit reached',      
       //whitelist: (ctx) => false,
       //blacklist: (ctx) => false,
-      whitelist_ips: [],
-      blacklist_ips: [],
+      whitelist_ips: process.env.MIOLO_RATELIMIT_WHITELIST_IPS?.split(',') || [],
+      blacklist_ips: process.env.MIOLO_RATELIMIT_BLACKLIST_IPS?.split(',') || [],
       ipsum_folder: '/var/ipsum' // https://github.com/stamparm/ipsum
     },
 
     request: {
-      lazy: 1, // seconds to consider lazy a request
-      slow: 2, // seconds to consider slow a request
+      lazy: parseInt(process.env.MIOLO_REQUEST_LAZY || 1), // seconds to consider lazy a request
+      slow: parseInt(process.env.MIOLO_REQUEST_SLOW || 2), // seconds to consider slow a request
       onStart: undefined,
       // (ctx, times) => { return begin_result}
       onDone: undefined,
       // (ctx, begin_result, times) => {},
       geoip: {
-        enabled: false,
-        db: '/var/lib/GeoIP/GeoLite2-City.mmdb',
-        local_ips: [
+        enabled: process.env.MIOLO_GEOIP_ENABLED==='true',
+        db: process.env.MIOLO_GEOIP_DB,
+        local_ips: process.env.MIOLO_GEOIP_LOCAL_IPS?.split(',') || [
           '127.0.0.1'
         ]
       }
@@ -65,13 +70,13 @@ export default {
     
   },
   session: {
-    salt: 'SUPER_SALTY_YES?',
-    secret: 'SUPER_SECRET_KEY_KERE',
+    salt: process.env.MIOLO_SESSION_SALT || 'SUPER_SALTY_YES?',
+    secret: process.env.MIOLO_SESSION_SECRET || 'SUPER_SECRET_KEY_KERE',
     options: {
       /** (number || 'session') maxAge in ms (default is 1 days) */
       /** 'session' will result in a cookie that expires when session/browser is closed */
       /** Warning: If a session cookie is stolen, this cookie will never expire */
-      maxAge: SESSION_MAX_AGE,
+      maxAge: parseInt(process.env.MIOLO_SESSION_MAX_AGE || SESSION_MAX_AGE),
       
       /** (boolean) automatically commit headers (default true) */
       //autoCommit: true, 
@@ -95,7 +100,7 @@ export default {
       /** You may want to set it as true in your Production environement,
        *  while false at DEV time.
        */
-      secure: true, 
+      secure: process.env?.MIOLO_SESSION_SECURE === 'true',
       
       /** (string) session cookie sameSite options (default null, don't set it) */
       sameSite: 'lax', // 'strict', 
@@ -103,15 +108,20 @@ export default {
   },
   db: {
     config: {
-        dialect:  'postgres',
-        host:     'localhost',
-        port:     5432,
-        database: 'miolo',
-        user:     'postgres',
-        password: 'postgres',
-        max:      5,          // Maximum number of connection in pool
-        min:      0,          // Minimum number of connection in pool
-        idleTimeoutMillis: 10000,  // The maximum time, in milliseconds, that a connection can be idle before being released. Use with combination of evict for proper working, for more details read https://github.com/coopernurse/node-pool/issues/178#issuecomment-327110870,
+        dialect:  process.env.MIOLO_DB_DIALECT,
+        host:     process.env.MIOLO_DB_HOST,
+        port:     process.env.MIOLO_DB_PORT,
+        database: process.env.MIOLO_DB_DATABASE,
+        user:     process.env.MIOLO_DB_USER,
+        password: process.env.MIOLO_DB_PASSWORD,
+        // Maximum number of connection in pool
+        max:      parseInt(process.env.MIOLO_DB_POOL_MAX),
+        // Minimum number of connection in pool
+        min:      parseInt(process.env.MIOLO_DB_POOL_MIN),
+        // The maximum time, in milliseconds, that a connection can be idle before being released. 
+        // Use with combination of evict for proper working,
+        //   for more details read https://github.com/coopernurse/node-pool/issues/178#issuecomment-327110870,
+        idleTimeoutMillis: parseInt(process.env.MIOLO_DB_POOL_IDLE_TIMEOUT_MS), 
     },
     options: {
       tables: []
@@ -181,17 +191,18 @@ export default {
     */],
   },
   log: {
-    level: 'debug',
+    level: process.env.MIOLO_LOG_LEVEL || 'debug',
     format: {
       locale: 'en-GB'
     },
     console: {
-      enabled: true,
+      enabled: process.env.MIOLO_LOG_CONSOLE_ENABLED === 'true',
+      level: process.env.MIOLO_LOG_CONSOLE_LEVEL || process.env.MIOLO_LOG_LEVEL || 'debug',
     },
     file: {
-      enabled: true,
-
-      filename: '/var/log/afialapis/%MIOLO%.log',
+      enabled: process.env.MIOLO_LOG_FILE_ENABLED === 'true',
+      level: process.env.MIOLO_LOG_FILE_LEVEL || process.env.MIOLO_LOG_LEVEL || 'debug',
+      filename: process.env.MIOLO_LOG_FILE_PATH || '/var/log/afialapis/%MIOLO%.log',
       
       //frequency: undefined,
       //datePattern: 'YYYY-MM-DD',
@@ -211,23 +222,25 @@ export default {
       hup_patch: false
     },
     mail: {
-      enabled: false,
-      level: 'warn',
-      name: 'miolo',
-      from: 'miolo@mail.com',
-      to: 'errors@mail.com'      
+      enabled: process.env.MIOLO_LOG_MAIL_ENABLED 
+      ? process.env.MIOLO_LOG_MAIL_ENABLED === 'true' 
+      : false,
+      level: process.env.MIOLO_LOG_MAIL_LEVEL || process.env.MIOLO_LOG_LEVEL || 'warn',
+      name: process.env.MIOLO_NAME || 'miolo',
+      from: process.env.MIOLO_LOG_MAIL_FROM || 'noreply@mail.com',
+      to: process.env.MIOLO_LOG_MAIL_TO || 'noreply@mail.com'      
     }
   },
   mail: {
-    silent: true,
+    silent: process.env.MIOLO_MAILER_SILENT === 'true',
     options: {
       //
       // General options
       //
       // port – is the port to connect to (defaults to 587 is secure is false or 465 if true)
-      port: 25,
+      port: parseInt(process.env.MIOLO_MAILER_PORT || 25),
       // host – is the hostname or IP address to connect to (defaults to ‘localhost’)
-      host: 'mail.com',
+      host: process.env.MIOLO_MAILER_HOST || 'mail.com',
       // auth – defines authentication data 
       //        If authentication data is not present, the connection is considered authenticated from the start. 
       //        Otherwise you would need to provide the authentication options object.
@@ -235,7 +248,20 @@ export default {
       //   - user is the username
       //   - pass is the password for the user if normal login is used
       // authMethod – defines preferred authentication method, defaults to ‘PLAIN’
-      authMethod: 'PLAIN',
+      authMethod: process.env.MIOLO_MAILER_AUTH_METHOD || 'PLAIN',
+      ... process.env.MIOLO_MAILER_AUTH_METHOD === 'LOGIN'
+        ? {
+          auth: {
+            user: process.env.MIOLO_MAILER_SMTP_USER || 'noreply@mail.com',
+            pass: process.env.MIOLO_MAILER_SMTP_PASS || '****',
+            type: 'login',
+          },
+          secure: true,
+        }
+        : {
+          secure: false
+        },
+
       //
       // TLS options
       //
@@ -244,7 +270,8 @@ export default {
       //          In most cases set this value to true if you are connecting to port 465. For port 587 or 25 keep it false
       //    ** Setting secure to false does not mean that you would not use an encrypted connection. Most SMTP servers allow 
       //       connection upgrade via STARTTLS command but to use this you have to connect using plaintext first
-      secure: false,
+     
+      
       // tls – defines additional node.js TLSSocket options to be passed to the socket constructor, eg. {rejectUnauthorized: true}.
       tls: {
           // do not fail on invalid certs
@@ -297,9 +324,9 @@ export default {
       //         Read about proxy support in Nodemailer from here: https://nodemailer.com/smtp/proxies/
     },
     defaults: {
-      name: 'miolo',
-      from: 'miolo@mail.com',
-      to: 'errors@mail.com'
+      name: process.env.MIOLO_NAME || 'miolo',
+      from: process.env.MIOLO_MAILER_FROM || 'noreply@mail.com',
+      to: process.env.MIOLO_MAILER_TO || 'noreply@mail.com'
     }
   },
   auth: {
@@ -332,6 +359,7 @@ export default {
     //        callback: a middleware function
     //      }, ...]
   },
+
   middlewares: [
     // async (ctx, next) => {}
     // Remember to call `await next()`
@@ -361,20 +389,22 @@ export default {
         host: '127.0.0.1',
         port: 6379
       },
-      version: 1,
+      version: parseInt(process.env.MIOLO_CACHE_VERSION || 1),
       clean: false,
     },
     
     // specific cache options for calustra
     calustra: {
       namespace: 'miolo-calustra',
-      ttl: 86400*1000,
+      ttl: parseInt(process.env.MIOLO_CACHE_CALUSTRA_TTL || 86400*1000),
+      version: parseInt(process.env.MIOLO_CACHE_CALUSTRA_VERSION || process.env.MIOLO_CACHE_VERSION || 1)
     },
 
     // specific cache options for koa-session
     session: {
       namespace: 'miolo-session',
-      ttl: SESSION_MAX_AGE,
+      ttl: parseInt(process.env.MIOLO_CACHE_SESSION_TTL || process.env.MIOLO_SESSION_MAX_AGE || SESSION_MAX_AGE),
+      version: parseInt(process.env.MIOLO_CACHE_SESSION_VERSION || process.env.MIOLO_CACHE_VERSION || 1)
     },
     
     // custom cache instances
@@ -404,30 +434,38 @@ export default {
     */
   },
 
-  // vite: false, 
-  vite: {
-    base: '/',
-    root: '',
-    watch: {
-      // During tests we edit the files too fast and sometimes chokidar
-      // misses change events, so enforce polling for consistency
-      usePolling: true,
-      interval: 100,
-    }, 
-  },
+  build: {
     
-  ssr: {
-    client: 'cli/entry-cli.jsx',
-    server: 'server/ssr/entry-server.jsx',
-    // html: '',
-    // loader: async (ctx) => {}
-  },
+    client: process.env.NODE_ENV === 'production'
+      ? `${process.env.MIOLO_BUILD_CLIENT_DEST}/${process.env.MIOLO_NAME}.${process.env.MIOLO_BUNDLE_SUFFIX}.js`
+      : process.env.MIOLO_BUILD_CLIENT_ENTRY,
+    
+    html: process.env.MIOLO_BUILD_HTML_FILE,
 
-  dev: {
-    watcher: {
-      enabled: true,
-      // dirs: []    By default, server's entry dir
+    vite: {
+      base: '/',
+      root: '',
+      watch: {
+        // During tests we edit the files too fast and sometimes chokidar
+        // misses change events, so enforce polling for consistency
+        usePolling: true,
+        interval: 100,
+      }, 
+    },
+      
+    ssr: {
+      server: process.env.NODE_ENV === 'production'
+      ? path.join(process.cwd(), `${process.env.MIOLO_BUILD_SERVER_DEST}/entry-server.js`)
+      : process.env.MIOLO_BUILD_SERVER_SSR_ENTRY
+      // loader: async (ctx) => {}
     },
+
+    dev: {
+      watcher: {
+        enabled: process.env.MIOLO_DEV_WATCH_ENABLED==='true',
+        dirs: process.env.MIOLO_DEV_WATCH_DIRS.split(',').map(dir => path.join(process.cwd(), dir)),
+      },
+    }
   }
 };
 

package/src/{server/middleware → middleware}/ssr/html.mjs

@@ -1,5 +1,22 @@
+import path from 'path'
+import { readFileSync } from 'fs'
 import { fallbackIndexHTML } from './fallbackIndex.mjs'
 
+function _html_read(htmlFile) {
+  try {
+    const isProduction = process.env.NODE_ENV === 'production'
+    const proot = (p) => path.join(process.cwd(), p)
+    const indexHTMLPath=  proot(isProduction 
+        ? `${process.env.MIOLO_BUILD_CLIENT_DEST}/index.html`
+        : htmlFile) 
+
+    const indexHTML = readFileSync(indexHTMLPath, 'utf8')
+    return indexHTML
+  } catch(error) {
+    console.error(`[miolo] Error reading HTML file ${htmlFile}: ${error}`)
+    return fallbackIndexHTML
+  }
+}
 
 
 function _add_client_script_to_body(htmlString, client) {
@@ -27,11 +44,11 @@ function _add_client_script_to_body(htmlString, client) {
 
 
 // HTML renderer
-export const ssr_html_renderer_make = async (app, ssrConfig, devRender= undefined) => {
+export const ssr_html_renderer_make = async (app, ssrConfig, htmlFile, client, devRender= undefined) => {
   const isProduction = process.env.NODE_ENV === 'production'
 
   // check HTML
-  let tmplHtml = ssrConfig?.html || fallbackIndexHTML
+  let tmplHtml = _html_read(htmlFile)
   for (const vrb of ['{context}', '{children}']) {
     if (tmplHtml.indexOf(vrb) < 0) {
       app.context.miolo.logger.error(`[ssr] Provided HTML for rendering has no ${vrb} template variable`)
@@ -81,7 +98,7 @@ export const ssr_html_renderer_make = async (app, ssrConfig, devRender= undefine
       .replace('{context}', JSON.stringify(context, null, 2))  
       .replace('{children}', ssr_html)
     
-    parsed_html = _add_client_script_to_body(parsed_html, ssrConfig?.client)
+    parsed_html = _add_client_script_to_body(parsed_html, client)
 
     return parsed_html
   }

package/src/{server/middleware → middleware}/ssr/ssr_render.mjs

@@ -5,14 +5,14 @@ import { ssr_html_renderer_make } from './html.mjs'
 
 export async function init_ssr_render_middleware(app, config, devRender= undefined) {
 
-  const ssrConfig = config.ssr
+  const ssrConfig = config.build.ssr
   const httpConfig = config.http
   const authConfig = config?.auth || {}
   // const socketConfig = config?.socket || {}
 
   const ssr_build_context = ssr_context_builder_make(app, ssrConfig)
   const ssr_loader = ssr_loader_make(app, ssrConfig)
-  const ssr_html_renderer = await ssr_html_renderer_make(app, ssrConfig, devRender)
+  const ssr_html_renderer = await ssr_html_renderer_make(app, ssrConfig, config.build.html, config.build.client, devRender)
 
   async function render_ssr_middleware(ctx) {
     try {

package/src/{server/middleware → middleware}/vite/devserver.mjs

@@ -2,7 +2,7 @@
 import koaConnect from 'koa-connect'
 
 // Vite Dev Server
-export async function init_vite_dev_server_middleware(app, config) {
+export async function init_vite_dev_server_middleware(app, viteConfig) {
   const isProduction = process.env.NODE_ENV === 'production'
   let vite
 
@@ -22,17 +22,17 @@ export async function init_vite_dev_server_middleware(app, config) {
           }
         }
       )],
+      ...viteConfig || {},
       // 
-      base: config?.base || '/',
-      root: config?.root || '',
+      base: viteConfig?.base || '/',
+      root: viteConfig?.root || '',
       watch: {
         // During tests we edit the files too fast and sometimes chokidar
         // misses change events, so enforce polling for consistency
         usePolling: true,
         interval: 100,
-        ...config?.vite?.watch || {}
-      }, 
-      ...config?.vite || {}    
+        ...viteConfig?.vite?.watch || {}
+      }
     })
 
     app.use(koaConnect(vite.middlewares))

package/src/{server/server-cron.mjs → server-cron.mjs}

@@ -1,5 +1,3 @@
-import '@dotenvx/dotenvx/config'
-
 import { init_config }                    from './config/index.mjs'
 import { init_context_middleware }         from './middleware/context/index.mjs'
 import { init_cron }                       from './engines/cron/index.mjs'

package/src/{server/server-dev.mjs → server-dev.mjs}

@@ -18,8 +18,8 @@ export async function miolo_dev(sconfig) {
   
   // Vite DEV server init
   const devInit= async (app, config) => {
-    await init_vite_dev_server_middleware(app, config.vite)
-    await init_watcher_dev_server_middleware(app, config.dev.watcher, config.ssr)
+    await init_vite_dev_server_middleware(app, config.build.vite)
+    await init_watcher_dev_server_middleware(app, config.build.dev.watcher, config.build.ssr)
   }
 
   // Vite SSR side

package/src/{server/server.mjs → server.mjs}

@@ -1,5 +1,3 @@
-import '@dotenvx/dotenvx/config'
-
 import Koa                                from 'koa'
 import { init_config }                    from './config/index.mjs'
 
@@ -41,7 +39,7 @@ async function miolo(sconfig, devInit= undefined, devRender= undefined) {
   // Vite Dev Server
   if (devInit) {
     await devInit(app, config)
-    // await init_vite_dev_server_middleware(app, config.vite)
+    // await init_vite_dev_server_middleware(app, config.build.vite)
   }
   
   

package/README.md

@@ -1,69 +0,0 @@
-# miolo
-[![NPM Version](https://badge.fury.io/js/miolo.svg)](https://www.npmjs.com/package/miolo)
-[![NPM Downloads](https://img.shields.io/npm/dm/miolo.svg?style=flat)](https://www.npmjs.com/package/miolo)
-
-![miolo logo](https://www.afialapis.com/os/miolo/logo.png)
-
----
-
-> **[miolo](https://academia.gal/dicionario/-/termo/miolo)**. substantivo masculino plural:
-
-> **1.** popular **Encéfalo.**
-
-> _Disque aínda se vían os miolos esparexidos polo chan._
-
-> substantivo masculino:
-
-> **2. Parte interior do pan.**
-
-> _Prefiro o miolo á codia._
-
-> **4.** figurado **Parte fundamental ou máis importante de algo.**
-
-> _O miolo da cuestión non é ese._
-
-
----
-
-# Intro
-
-[`miolo`](https://www.afialapis.com/os/miolo) is an all-in-one koa-based server.
-
-
-## Server middleware
-
-## init
-
-```miolo(config, render)```
-
-config: ver defaults.js
-
-render:
-	undefined         => renderiza un html fallback
-	html     (string) => renderiza ese HTML
-	middleware        => renderiza HTML con posibilidad de SSR
-
-### Custom `ctx` properties
-
-  ctx.request.body
-  ctx.request.ip
-
-  From koa-passport:
-
-  ctx.isAuthenticated()
-  ctx.isUnauthenticated()
-  await ctx.login()
-  ctx.logout()
-  ctx.state.user
-
-  From auth:
-    ctx.session.user
-    ctx.session.authenticated
-    ctx.session.token (if guest auth)
-                 
-
-
-
-# Changelog
-
-See [changelog here](https://github.com/afialapis/miolo/blob/main/CHANGELOG.md)