@volcanicminds/backend 2.0.4 → 2.1.0

package/lib/hooks/preHandler.ts

@@ -1,5 +1,5 @@
-import * as tracking from '../util/tracker'
+import * as tracking from '../util/tracker.js'
 
-module.exports = async (req, reply) => {
+export default async (req, reply) => {
   tracking.initialize(req, reply)
 }

package/lib/hooks/preSerialization.ts

@@ -1,7 +1,7 @@
 import sizeof from 'object-sizeof'
-import * as tracking from '../util/tracker'
+import * as tracking from '../util/tracker.js'
 
-module.exports = async (req, reply, payload) => {
+export default async (req, reply, payload) => {
   if (log.t) {
     req.payloadSize = sizeof(req.body) + sizeof(req.params) + sizeof(req.query)
     reply.payloadSize = sizeof(payload)

package/lib/loader/general.ts

@@ -1,8 +1,8 @@
-import { GeneralConfig } from '../../types/global'
-import { normalizePatterns } from '../util/path'
-const glob = require('glob')
+import type { GeneralConfig } from '../../types/global.js'
+import { normalizePatterns } from '../util/path.js'
+import { globSync } from 'glob'
 
-export function load() {
+export async function load() {
   const generalConfig: GeneralConfig = {
     name: 'general',
     enable: true,
@@ -15,10 +15,14 @@ export function load() {
   }
 
   const patterns = normalizePatterns(['..', 'config', 'general.{ts,js}'], ['src', 'config', 'general.{ts,js}'])
-  patterns.forEach((pattern) => {
+
+  for (const pattern of patterns) {
     log.t && log.trace('Looking for ' + pattern)
-    glob.sync(pattern).forEach((f: string) => {
-      const config: GeneralConfig = require(f)
+    const files = globSync(pattern, { windowsPathsNoEscape: true })
+
+    for (const f of files) {
+      const module = await import(f)
+      const config: GeneralConfig = module.default || module
 
       if (config.name === generalConfig.name) {
         generalConfig.enable = config.enable
@@ -27,8 +31,8 @@ export function load() {
           ...(config.options || {})
         }
       }
-    })
-  })
+    }
+  }
 
   log.d && log.debug('General configuration loaded')
   return generalConfig

package/lib/loader/hooks.ts

@@ -1,4 +1,7 @@
-import { normalizePatterns } from '../util/path'
+import { normalizePatterns } from '../util/path.js'
+import { globSync } from 'glob'
+import path from 'path'
+import require from '../util/require.js'
 
 const hooks = [
   'onRequest',
@@ -16,16 +19,13 @@ const hooks = [
   'preHandler'
 ]
 
-const glob = require('glob')
-const path = require('path')
-
 export function apply(server: any): void {
   const patterns = normalizePatterns(['..', 'hooks', '*.{ts,js}'], ['src', 'hooks', '*.{ts,js}'])
   const allHooks: any = hooks.reduce((acc, v) => ({ ...acc, [v]: [] as Function[] }), {})
 
   patterns.forEach((pattern) => {
     log.t && log.trace('Looking for ' + pattern)
-    glob.sync(pattern).forEach((f: string) => {
+    globSync(pattern, { windowsPathsNoEscape: true }).forEach((f: string) => {
       const hookName = path.basename(f, path.extname(f))
       const fn = require(f)
 

package/lib/loader/plugins.ts

@@ -1,22 +1,26 @@
-import { config } from 'dotenv'
-import { normalizePatterns } from '../util/path'
+import { normalizePatterns } from '../util/path.js'
+import { globSync } from 'glob'
 
-const glob = require('glob')
-
-export function load() {
+export async function load() {
   const plugins: any = {}
 
   const patterns = normalizePatterns(['..', 'config', 'plugins.{ts,js}'], ['src', 'config', 'plugins.{ts,js}'])
-  patterns.forEach((pattern) => {
+
+  for (const pattern of patterns) {
     log.t && log.trace('Looking for ' + pattern)
-    glob.sync(pattern).forEach((f: string) => {
-      const configPlugins = require(f)
+    const files = globSync(pattern, { windowsPathsNoEscape: true })
+
+    for (const f of files) {
+      const module = await import(f)
+      const configPlugins = module.default || module
+
       configPlugins.forEach((plugin) => {
         plugins[plugin.name] = plugin.enable ? plugin.options : false
         log.t && log.trace(`* Plugin ${plugin.name} ${plugin.enable ? 'enabled' : 'disabled'}`)
       })
-    })
-  })
+    }
+  }
+
   const enabledPulgins = Object.keys(plugins).filter((p) => !!plugins[p])
   log.d && log.debug(`Plugins loaded: ${enabledPulgins.length > 0 ? enabledPulgins.join(', ') : 0}`)
   return plugins

package/lib/loader/roles.ts

@@ -1,21 +1,26 @@
-import { Role, Roles } from '../../types/global'
-import { normalizePatterns } from '../util/path'
-const glob = require('glob')
+import type { Role, Roles } from '../../types/global.js'
+import { normalizePatterns } from '../util/path.js'
+import { globSync } from 'glob'
 
-export function load() {
+export async function load() {
   const roles: Roles = {}
 
   const patterns = normalizePatterns(['..', 'config', 'roles.{ts,js}'], ['src', 'config', 'roles.{ts,js}'])
-  patterns.forEach((pattern) => {
+
+  for (const pattern of patterns) {
     log.t && log.trace('Looking for ' + pattern)
-    glob.sync(pattern).forEach((f: string) => {
-      const configRoles = require(f)
+    const files = globSync(pattern, { windowsPathsNoEscape: true })
+
+    for (const f of files) {
+      const module = await import(f)
+      const configRoles = module.default || module
 
       configRoles.forEach((role: Role) => {
         roles[role.code] = role
       })
-    })
-  })
+    }
+  }
+
   log.d && log.debug('Roles loaded: ' + Object.keys(roles).join(', '))
   return roles
 }

package/lib/loader/router.ts

@@ -1,10 +1,11 @@
-import yn from '../util/yn'
-import { Role, Route, ConfiguredRoute, RouteConfig } from '../../types/global'
+import yn from '../util/yn.js'
+import type { Role, Route, ConfiguredRoute, RouteConfig } from '../../types/global.js'
 import { FastifyReply, FastifyRequest } from 'fastify'
-import { normalizePatterns } from '../util/path'
+import { normalizePatterns } from '../util/path.js'
+import { globSync } from 'glob'
+import path from 'path'
+import require from '../util/require.js'
 
-const glob = require('glob')
-const path = require('path')
 const methods = ['GET', 'POST', 'PUT', 'DELETE', 'HEAD', 'PATCH', 'OPTIONS']
 
 export function load(): ConfiguredRoute[] {
@@ -14,7 +15,7 @@ export function load(): ConfiguredRoute[] {
 
   patterns.forEach((pattern) => {
     log.t && log.trace('Looking for ' + pattern)
-    glob.sync(pattern).forEach((f: string, index: number, values: string[]) => {
+    globSync(pattern, { windowsPathsNoEscape: true }).forEach((f: string, index: number, values: string[]) => {
       const base = path.dirname(f)
       const dir = path.basename(base)
       const file = path.join(dir, path.basename(f))

package/lib/loader/schedules.ts

@@ -1,10 +1,10 @@
 import _ from 'lodash'
-import { JobSchedule } from '../../types/global'
-import { normalizePatterns } from '../util/path'
+import type { JobSchedule } from '../../types/global.js'
+import { normalizePatterns } from '../util/path.js'
 import { CronJob, SimpleIntervalJob, Task, AsyncTask } from 'toad-scheduler'
-
-const glob = require('glob')
-const path = require('path')
+import { globSync } from 'glob'
+import path from 'path'
+import require from '../util/require.js'
 
 export function load(): any[] {
   const patterns = normalizePatterns(['..', 'schedules', '*.job.{ts,js}'], ['src', 'schedules', '*.job.{ts,js}'])
@@ -33,7 +33,7 @@ export function load(): any[] {
 
   patterns.forEach((pattern) => {
     log.t && log.trace('Looking for ' + pattern)
-    glob.sync(pattern).forEach((f: string) => {
+    globSync(pattern, { windowsPathsNoEscape: true }).forEach((f: string) => {
       log.t && log.trace(`* Add job schedule from ${f}`)
 
       const jobName = path.basename(f, path.extname(f))

package/lib/loader/schemas.ts

@@ -1,7 +1,7 @@
-import { normalizePatterns } from '../util/path'
-
-const glob = require('glob')
-const path = require('path')
+import { normalizePatterns } from '../util/path.js'
+import { globSync } from 'glob'
+import path from 'path'
+import require from '../util/require.js'
 
 export function apply(server: any): void {
   const [baseSchemaPath, customSchemaPath] = normalizePatterns(
@@ -14,7 +14,7 @@ export function apply(server: any): void {
   let schemaCount = 0
 
   log.t && log.trace('Looking for custom schemas in ' + customSchemaPath)
-  glob.sync(customSchemaPath).forEach((f: string) => {
+  globSync(customSchemaPath, { windowsPathsNoEscape: true }).forEach((f: string) => {
     try {
       const schemaClass = require(f)
       const schemaNames = Object.keys(schemaClass)
@@ -38,7 +38,7 @@ export function apply(server: any): void {
   })
 
   log.t && log.trace('Looking for base schemas in ' + baseSchemaPath)
-  glob.sync(baseSchemaPath).forEach((f: string) => {
+  globSync(baseSchemaPath, { windowsPathsNoEscape: true }).forEach((f: string) => {
     try {
       const schemaFileName = path.basename(f)
       const schemaClass = require(f)

package/lib/loader/tracking.ts

@@ -1,18 +1,23 @@
-import { TrackChanges, TrackChangesList, Data } from '../../types/global'
-import { normalizePatterns } from '../util/path'
-const glob = require('glob')
+import type { TrackChanges, TrackChangesList, Data } from '../../types/global.js'
+import { normalizePatterns } from '../util/path.js'
+import { globSync } from 'glob'
 
 const METHODS = ['POST', 'PUT', 'DELETE']
 
-export function load() {
+export async function load() {
   const trackChangesList: TrackChangesList = {}
   let trackConfig: Data = {}
 
   const patterns = normalizePatterns(['..', 'config', 'tracking.{ts,js}'], ['src', 'config', 'tracking.{ts,js}'])
-  patterns.forEach((pattern) => {
+
+  for (const pattern of patterns) {
     log.t && log.trace('Looking for ' + pattern)
-    glob.sync(pattern).forEach((f: string) => {
-      const configTracking = require(f)
+    const files = globSync(pattern, { windowsPathsNoEscape: true })
+
+    for (const f of files) {
+      const module = await import(f)
+      const configTracking = module.default || module
+
       const { config, changes } = configTracking || {}
       const { enableAll = true, primaryKey = 'id', changeEntity = 'Change' } = config || {}
 
@@ -30,8 +35,8 @@ export function load() {
             trackChangesList[code] = tc
           }
         })
-    })
-  })
+    }
+  }
 
   const keys = Object.keys(trackChangesList) || []
   log.d && log.debug(`Tracking changes loaded: ${keys?.length || 0}`)

package/lib/loader/translation.ts

@@ -1,8 +1,11 @@
-const path = require('path')
-const glob = require('glob')
-const { I18n } = require('i18n')
+import path from 'path'
+import { globSync } from 'glob'
+import { I18n } from 'i18n'
+import { fileURLToPath } from 'url'
+import require from '../util/require.js'
 
-// import { normalizePatterns } from '../util/path'
+const __filename = fileURLToPath(import.meta.url)
+const __dirname = path.dirname(__filename)
 
 export function load(): any {
   const i18n = new I18n({
@@ -25,7 +28,7 @@ export function load(): any {
 
   const basePath = path.join(__dirname, '..', 'locales', '*.json').replaceAll('\\', '/')
 
-  glob.sync(basePath).forEach((f: string) => {
+  globSync(basePath, { windowsPathsNoEscape: true }).forEach((f: string) => {
     log.info('* Loading base dictionary %s', path.parse(f).base)
     try {
       const content = require(f)
@@ -37,7 +40,7 @@ export function load(): any {
 
   const addPath = path.join(process.cwd(), 'src', 'locales', '*.json').replaceAll('\\', '/')
 
-  glob.sync(addPath).forEach((f: string) => {
+  globSync(addPath, { windowsPathsNoEscape: true }).forEach((f: string) => {
     log.info('* Loading additional dictionary %s', path.parse(f).base)
     try {
       const content = require(f)
@@ -48,14 +51,6 @@ export function load(): any {
   })
 
   i18n.setLocale(i18n.defaultLocale || 'en')
-  //   let test1 = i18n.__('greeting.formal')
-  //   let test2 = i18n.__('hello')
-  //   let test3 = i18n.__('greeting.placeholder.formal', 'UGO')
-  //   let test4 = i18n.__('greeting.placeholder.formalize:Buondì %s', 'UGO')
-  //   let test5 = i18n.__('greeting.formal')
-  //   let test6 = i18n.__({ phrase: 'greeting.formal', locale: 'it' })
-  //   let test7 = i18n.__({ phrase: 'greeting.placeholder.formal', locale: 'it' }, 'UGO')
-  //   i18n.setLocale(i18n.defaultLocale || 'en')
   return i18n
 }
 

package/lib/schedules/test.job.ts

@@ -1,4 +1,4 @@
-import { JobSchedule } from '../../types/global'
+import type { JobSchedule } from '../../types/global.js'
 
 export const schedule: JobSchedule = {
   active: false,

package/lib/util/common.ts

@@ -1,5 +1,5 @@
 import { FastifyRequest } from 'fastify'
-import { Data } from '../../types/global'
+import type { Data } from '../../types/global.js'
 
 export function getData(req: FastifyRequest): Data {
   if (!req) return {}

package/lib/util/generate.ts

@@ -1,4 +1,4 @@
-const { customAlphabet } = require('nanoid')
+import { customAlphabet } from 'nanoid'
 const nanoid = customAlphabet('AaBbCcDdEeFfGgHhIiJjKkLlMmNnOoPpQqRrSsTtUuVvWwXxYyZz0123456789')
 
 export function newAuthCode() {

package/lib/util/logger.ts

@@ -12,7 +12,7 @@
 // log.trace('test log test log test log')
 
 import pino from 'pino'
-import yn from './yn'
+import yn from './yn.js'
 
 const logLevels = ['fatal', 'error', 'warn', 'info', 'debug', 'trace']
 

package/lib/util/mark.ts

@@ -1,3 +1,4 @@
+import require from './require.js'
 const pkg = require('root-require')('package.json')
 
 /**

package/lib/util/path.ts

@@ -1,4 +1,9 @@
-const path = require('path')
+import path from 'path'
+import { fileURLToPath } from 'url'
+
+const __filename = fileURLToPath(import.meta.url)
+const __dirname = path.dirname(__filename)
+
 export function normalizePatterns(path1: Array<string>, path2: Array<string>): Array<string> {
   // replaceAll is needed for windows
   return [

package/lib/util/require.ts

@@ -0,0 +1,3 @@
+import { createRequire } from 'module'
+const require = createRequire(import.meta.url)
+export default require

package/lib/util/tracker.ts

@@ -1,5 +1,5 @@
 import dayjs from 'dayjs'
-import { FastifyRequest, FastifyReply } from '../../types/global'
+import type { FastifyRequest, FastifyReply } from '../../types/global.js'
 
 export async function initialize(req: FastifyRequest, reply: FastifyReply) {
   if (req.server['dataBaseManager'].isImplemented()) {

package/package.json

@@ -1,6 +1,7 @@
 {
   "name": "@volcanicminds/backend",
-  "version": "2.0.4",
+  "version": "2.1.0",
+  "type": "module",
   "codename": "rome",
   "license": "MIT",
   "description": "The volcanic (minds) backend",
@@ -27,23 +28,32 @@
     "rate limit",
     "jest"
   ],
-  "main": "dist/index",
-  "typings": "dist/index",
+  "main": "dist/index.js",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "lib"
+  ],
   "scripts": {
-    "clean": "rm -rf dist esm",
+    "clean": "rm -rf dist",
     "prebuild": "npm run clean",
-    "build:esm": "tsc --target es2018 --outDir esm",
-    "build:cjs": "tsc --target es2015 --module commonjs --outDir dist",
-    "build": "npm run build:esm && npm run build:cjs",
-    "compile": "npm run build",
+    "build": "tsc",
     "preprod": "npm run build",
     "prod": "cd dist && node server.js",
-    "server": "cd dist && node server.js",
-    "start": "ts-node server.ts",
-    "dev": "nodemon --exec \"ts-node\" server.ts",
+    "start": "tsx server.ts",
+    "dev": "node --import tsx/esm --watch server.ts",
     "test": "npm run test:full",
-    "test:full": "cross-env PORT=2231 NODE_ENV=memory BROWSER=false mocha ./test/index.spec.ts -t 100000",
-    "reset": "npm install && npm update && npm run compile",
+    "test:full": "cross-env PORT=2231 NODE_ENV=memory BROWSER=false mocha --loader=tsx ./test/index.spec.ts -t 100000",
+    "reset": "npm install && npm update && npm run build",
     "upgrade-deps": "npx npm-check-updates -u",
     "combine": "node combine.js"
   },
@@ -81,9 +91,8 @@
     "cross-env": "^10.1.0",
     "expect": "^30.2.0",
     "mocha": "^11.7.5",
-    "nodemon": "^3.1.10",
     "npm-upgrade": "^3.1.2",
-    "ts-node": "^10.9.2",
+    "tsx": "^4.19.2",
     "typescript": "^5.9.3"
   },
   "repository": {

package/.dockerignore

@@ -1,6 +0,0 @@
-.git
-dist
-esm
-test
-node_modules
-**/node_modules

package/.mocharc.json

@@ -1,3 +0,0 @@
-{
-  "loader": "ts-node/esm"
-}

package/.nvmrc

@@ -1 +0,0 @@
-v24.11.0

package/.prettierignore

@@ -1,5 +0,0 @@
-node_modules
-
-# Ignore artifacts:
-build
-coverage

package/.prettierrc

@@ -1,9 +0,0 @@
-{
-  "semi": false,
-  "singleQuote": true,
-  "useTabs": false,
-  "bracketSpacing": true,
-  "trailingComma": "none",
-  "tabWidth": 2,
-  "printWidth": 120
-}

package/DOCKER.md

@@ -1,27 +0,0 @@
-# Docker
-
-try to use these to run the app in a docker node:16-alpine image:
-
-```js
-
-// easy
-docker build -t volcanic-backend .
-docker run -dp 2230:2230 -it volcanic-backend
-
-// prod
-docker build -f Dockerfile.prod -t volcanic-backend-prod .
-docker run -dp 2230:2230 -it volcanic-backend-prod
-
-// detached mode with autoremove when stopped
-docker run --rm -dp 2230:2230 -it volcanic-backend
-
-// attached mode with autoremove when stopped
-docker run --rm -p 2230:2230 -it volcanic-backend
-
-// remove
-docker image rm volcanic-backend
-
-// prune all
-docker system prune --all
-
-```

package/Dockerfile

@@ -1,24 +0,0 @@
-FROM --platform=linux/amd64 node:18-alpine AS builder
-
-# Create app directory
-WORKDIR /usr/src/app
-
-# Install app dependencies
-COPY package*.json ./
-COPY lib lib/
-
-RUN npm install
-
-# Bundle app source
-COPY . .
-
-FROM --platform=linux/amd64 node:18-alpine
-LABEL version="0.1.0"
-LABEL description="Volcanic Backend"
-LABEL maintainer="Developers <developers@volcanicminds.com>"
-
-WORKDIR /usr/src/app
-COPY --from=builder /usr/src/app .
-
-EXPOSE 2230
-CMD [ "npm", "run start" ]

package/Dockerfile.prod

@@ -1,33 +0,0 @@
-FROM --platform=linux/amd64 node:18-alpine AS builder
-
-# Create app directory
-WORKDIR /usr/src/app
-
-# Install app dependencies
-COPY package*.json ./
-COPY lib lib/
-
-RUN npm install \
-        --prefer-offline \
-        --non-interactive
-
-# Bundle app source
-COPY . .
-
-RUN npm run compile && \
-    rm -rf node_modules && \
-    npm install \
-        --prefer-offline \
-        --non-interactive \
-        --production
-
-FROM --platform=linux/amd64 node:18-alpine
-LABEL version="0.1.0"
-LABEL description="Volcanic Backend"
-LABEL maintainer="Developers <developers@volcanicminds.com>"
-
-WORKDIR /usr/src/app
-COPY --from=builder /usr/src/app .
-
-EXPOSE 2230
-CMD [ "npm", "run server" ]

package/NPM.md

@@ -1,24 +0,0 @@
-# NPM
-
-[more info](https://zellwk.com/blog/publish-to-npm/)
-
-## how to publish
-
-```ruby
-npm install npm@latest -g
-npm login
-npm init --scope=volcanicminds
-npm publish --access public
-```
-
-## local linking
-
-```ruby
-npm link
-npm link "@volcanicminds/backend"
-```
-
-```ruby
-npm unlink
-npm unlink "@volcanicminds/backend"
-```

package/TODO.md

@@ -1,14 +0,0 @@
-# TODO
-
-- add example / demo project (with @volcanicminds/backend & @volcanicminds/typeorm)
-- validations (see typeorm)
-- subscribers / hooks (Active Records: in separated files)
-- api versioning
-
-## Useful links
-
-https://tutorialjavascript.altervista.org/moduli-typescript
-https://swagger.io/specification/v2/#swaggerObject
-https://github.com/fastify/fastify-swagger
-https://www.fastify.io/docs/latest/Reference/Validation-and-Serialization/
-https://json-schema.org/draft/2020-12/json-schema-validation.html#name-pattern