@volcanicminds/backend 2.0.4 → 2.1.1

package/lib/loader/schemas.ts

@@ -1,9 +1,8 @@
-import { normalizePatterns } from '../util/path'
+import { normalizePatterns } from '../util/path.js'
+import { globSync } from 'glob'
+import path from 'path'
 
-const glob = require('glob')
-const path = require('path')
-
-export function apply(server: any): void {
+export async function apply(server: any): Promise<void> {
   const [baseSchemaPath, customSchemaPath] = normalizePatterns(
     ['..', 'schemas', '*.{ts,js}'],
     ['src', 'schemas', '*.{ts,js}']
@@ -14,14 +13,19 @@ 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) => {
+  const customFiles = globSync(customSchemaPath, { windowsPathsNoEscape: true })
+
+  for (const f of customFiles) {
+    if (f.endsWith('.d.ts')) continue
+
     try {
-      const schemaClass = require(f)
-      const schemaNames = Object.keys(schemaClass)
+      const schemaModule = await import(f)
+      const schemaClass = schemaModule.default || schemaModule
+      const schemaNames = Object.keys(schemaModule)
 
       schemaNames.forEach((name) => {
-        const schema = schemaClass[name]
-        if (schema?.$id) {
+        const schema = schemaModule[name]
+        if (schema && typeof schema === 'object' && schema.$id) {
           customSchemas.push(schema)
           customSchemaIds.add(schema.$id)
         }
@@ -29,7 +33,7 @@ export function apply(server: any): void {
     } catch (e) {
       log.w && log.warn(`Could not load custom schema file: ${f}`, e)
     }
-  })
+  }
 
   customSchemas.forEach((schema) => {
     log.trace(`* Registering custom schema [${schema.$id}]`)
@@ -38,15 +42,19 @@ export function apply(server: any): void {
   })
 
   log.t && log.trace('Looking for base schemas in ' + baseSchemaPath)
-  glob.sync(baseSchemaPath).forEach((f: string) => {
+  const baseFiles = globSync(baseSchemaPath, { windowsPathsNoEscape: true })
+
+  for (const f of baseFiles) {
+    if (f.endsWith('.d.ts')) continue
+
     try {
       const schemaFileName = path.basename(f)
-      const schemaClass = require(f)
-      const schemaNames = Object.keys(schemaClass)
+      const schemaModule = await import(f)
+      const schemaNames = Object.keys(schemaModule)
 
       schemaNames.forEach((name) => {
-        const schema = schemaClass[name]
-        if (schema?.$id) {
+        const schema = schemaModule[name]
+        if (schema && typeof schema === 'object' && schema.$id) {
           if (customSchemaIds.has(schema.$id)) {
             log.w &&
               log.warn(
@@ -57,14 +65,14 @@ export function apply(server: any): void {
             server.addSchema(schema)
             schemaCount++
           }
-        } else {
-          log.w && log.warn(`* Schema with no $id found in ${schemaFileName}, cannot be registered.`)
+        } else if (name !== 'default') {
+          log.w && log.warn(`* Schema with no $id found in ${schemaFileName} (export ${name}), cannot be registered.`)
         }
       })
     } catch (e) {
       log.w && log.warn(`Could not load base schema file: ${f}`, e)
     }
-  })
+  }
 
   log.d && log.debug(`Schemas loaded: ${schemaCount} referenceable by $ref`)
 }

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.1",
+  "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

package/combine.js

@@ -1,124 +0,0 @@
-const fs = require('fs')
-const path = require('path')
-
-const MAIN_DIRECTORY = './'
-const INCLUDE_FILES = ['package.json', 'tsconfig.json', 'README.md', '.nvmrc', 'index.ts', 'index.d.ts']
-const SUB_DIRECTORIES = ['lib', 'types']
-const OUTPUT_FILE = 'OUTPUT.md'
-
-/**
- * Recursively collects .js and .ts files from a given directory.
- *
- * @param {string} directory - _The directory to scan recursively._
- * @returns {Array<{ relativePath: string }>} - _List of file objects with relative paths._
- */
-const getFilesFromDirectory = (directory) => {
-  let filesList = []
-  const items = fs.readdirSync(directory)
-
-  items.forEach((item) => {
-    const itemPath = path.join(directory, item)
-    const stats = fs.statSync(itemPath)
-
-    if (stats.isDirectory()) {
-      filesList = filesList.concat(getFilesFromDirectory(itemPath))
-    } else if (
-      item.endsWith('.html') ||
-      item.endsWith('.vue') ||
-      item.endsWith('.css') ||
-      item.endsWith('.json') ||
-      item.endsWith('.js') ||
-      item.endsWith('.ts') ||
-      item.endsWith('.md')
-    ) {
-      filesList.push({ relativePath: path.relative(MAIN_DIRECTORY, itemPath) })
-    }
-  })
-
-  return filesList
-}
-
-/**
- * Retrieves files from the specified subdirectories.
- *
- * @returns {Object} - _Object containing individual subdirectory files and a combined list._
- */
-const getFilesFromSubDirectories = () => {
-  const subDirectoryFiles = {}
-  let combinedFiles = []
-
-  SUB_DIRECTORIES.forEach((dir) => {
-    const files = getFilesFromDirectory(dir)
-    subDirectoryFiles[dir] = files
-    combinedFiles = combinedFiles.concat(files)
-  })
-
-  return { subDirectoryFiles, combinedFiles }
-}
-
-async function generateMarkdown() {
-  const rootFiles = fs
-    .readdirSync(MAIN_DIRECTORY)
-    .filter(
-      (file) =>
-        file.endsWith('.html') ||
-        (file.endsWith('.ts') && file !== 'combine.ts') ||
-        (file.endsWith('.js') && file !== 'combine.js') ||
-        INCLUDE_FILES.includes(file)
-    )
-    .map((file) => ({ relativePath: file }))
-
-  const { subDirectoryFiles, combinedFiles } = getFilesFromSubDirectories()
-  const allFiles = [...rootFiles, ...combinedFiles]
-  const currentISOString = new Date().toISOString()
-
-  const markdownLines = []
-  markdownLines.push('# Full Project - Updated At ' + currentISOString, '')
-  markdownLines.push('Below are all the files, materials and documentation of the project to analyze.', '')
-  markdownLines.push('```bash')
-  markdownLines.push('./')
-
-  rootFiles.forEach((file) => {
-    markdownLines.push(`├── ${file.relativePath}`)
-  })
-
-  if (SUB_DIRECTORIES.length > 0) {
-    SUB_DIRECTORIES.forEach((dir) => {
-      markdownLines.push(`├── ${dir}`)
-
-      const sortedSubFiles = subDirectoryFiles[dir].sort((a, b) => a.relativePath.localeCompare(b.relativePath))
-      sortedSubFiles.forEach((file) => {
-        const displayPath = file.relativePath.replace(new RegExp(`^(${SUB_DIRECTORIES.join('|')})[\\\\/]`), '')
-        markdownLines.push(`    ├── ${displayPath}`)
-      })
-    })
-  }
-  markdownLines.push('```', '')
-
-  markdownLines.push('## Source Files Index', '')
-  allFiles.forEach((file) => {
-    const filePath = file.relativePath
-
-    const slug = filePath.replace(/[\/.]/g, '-')
-    markdownLines.push(`- [${filePath}](#file-${slug})`)
-  })
-  markdownLines.push('')
-
-  for (const file of allFiles) {
-    const filePath = file.relativePath
-    const fullPath = path.join(MAIN_DIRECTORY, filePath)
-
-    const language = filePath.endsWith('.md') ? 'markdown' : filePath.endsWith('.ts') ? 'typescript' : 'javascript'
-
-    const fileContent = fs.readFileSync(fullPath, 'utf-8')
-    markdownLines.push(`## File: ${filePath}`, '')
-    markdownLines.push('```' + language)
-    markdownLines.push(fileContent)
-    markdownLines.push('```', '')
-  }
-
-  fs.writeFileSync(OUTPUT_FILE, markdownLines.join('\n'))
-  console.log(`Markdown file generated: ${OUTPUT_FILE}`)
-}
-
-generateMarkdown()

package/dist/lib/locales/en.json

@@ -1,12 +0,0 @@
-{
-    "hello": "Hello",
-    "greeting": {
-        "formal": "Hello",
-        "informal": "Hi",
-        "placeholder": {
-            "formal": "Hello %s",
-            "informal": "Hi %s"
-        }
-    },
-    "complex": "Hello {{user.firstname}} {{user.lastname}}"
-}

package/dist/lib/locales/it.json

@@ -1,12 +0,0 @@
-{
-    "hello": "Ciao",
-    "greeting": {
-        "formal": "Ciao",
-        "informal": "Cià",
-        "placeholder": {
-            "formal": "Ciao %s",
-            "informal": "Cià %s"
-        }
-    },
-    "complex": "Ciao {{user.firstname}} {{user.lastname}}"
-}

package/dist/nodemon.json

@@ -1,7 +0,0 @@
-{
-    "watch": ["lib"],
-    "verbose": true,
-    "ext": "js,ts,json,jsonc",
-    "ignore": [".git", "coverage", "dist", "lib/**/*.spec.ts", "node_modules"],
-    "exec": "ts-node ./lib/index.ts"
-}