@volcanicminds/backend 0.1.0

package/.dockerignore

@@ -0,0 +1,2 @@
+node-modules
+**/node_modules

package/.nvmrc

@@ -0,0 +1 @@
+v16.13.2

package/.prettierignore

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

package/.prettierrc

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

package/DOCKER.md

@@ -0,0 +1,23 @@
+# 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
+
+// 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

@@ -0,0 +1,21 @@
+FROM node:16-alpine
+
+LABEL version="0.1.0"
+LABEL description="Volcanic Backend"
+LABEL maintainer="Developers <developers@volcanicminds.com>"
+
+# Create app directory
+WORKDIR /usr/src/app
+
+# Install app dependencies
+COPY package*.json yarn.lock ./
+COPY lib lib/
+
+RUN yarn install
+RUN apk --no-cache add curl
+
+# Bundle app source
+COPY . .
+
+# EXPOSE 2230
+CMD [ "yarn", "start" ]

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Volcanic Minds
+
+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,146 @@
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![opensource](https://img.shields.io/badge/open-source-blue)](https://en.wikipedia.org/wiki/Open_source)
+[![volcanic-backend](https://img.shields.io/badge/volcanic-minds-orange)](https://github.com/volcanicminds/volcanic-backend)
+
+# volcanic-backend
+
+## Based on
+
+Based on [Fastify](https://www.fastify.io) ([GitHub](https://github.com/fastify/fastify)).
+
+Based on [Apollo Server](https://www.apollographql.com) ([GitHub](https://github.com/apollographql/apollo-server)).
+
+And, what you see in [package.json](package.json).
+
+## Environment (example)
+
+```ruby
+NODE_ENV=development
+
+HOST=0.0.0.0
+PORT=2230
+
+# LOG_LEVEL: trace, debug, info, warn, error, fatal
+LOG_LEVEL=info
+LOG_COLORIZE=true
+LOG_TIMESTAMP=true
+LOG_TIMESTAMP_READABLE=true
+LOG_FASTIFY=false
+
+GRAPHQL=false
+SWAGGER=true
+SWAGGER_TITLE=API Documentation
+SWAGGER_DESCRIPTION=List of available APIs and schemes to use
+SWAGGER_VERSION=0.1.0
+
+SRV_CORS=false
+SRV_HELMET=false
+SRV_RATELIMIT=false
+SRV_COMPRESS=false
+```
+
+For docker may be useful set HOST as 0.0.0.0 (instead 127.0.0.1).
+
+## How to upgrade packages
+
+```js
+yarn upgrade-deps
+```
+
+## How to run
+
+```js
+yarn dev
+yarn start
+yarn prod
+```
+
+When you execute `yarn dev` the server is restarted whenever a .js/.ts file is changed (thanks to [nodemon](https://www.npmjs.com/package/nodemon))
+
+## How to test (logic)
+
+```js
+yarn test
+yarn test -t 'Logging'
+```
+
+Refer to jest for more options.
+
+## Logging levels
+
+In the .env file you can change log settings in this way:
+
+```ruby
+# LOG_LEVEL: trace, debug, info, warn, error, fatal
+LOG_LEVEL=debug
+LOG_TIMESTAMP=true
+LOG_TIMESTAMP_READABLE=false
+LOG_COLORIZE=true
+```
+
+Log levels:
+
+- **trace**: useful and useless messages, verbose mode
+- **debug**: well, for debugging purposes.. you know what I mean
+- **info**: minimal logs necessary for understand that everything is working fine
+- **warn**: useful warnings if the environment is controlled
+- **error**: print out errors even if not blocking/fatal errors
+- **fatal**: ok you are dead now, but you want to know why?
+
+a bit of code:
+
+```js
+log.trace('Annoying message')
+log.debug('Where is my bug?')
+log.info('Useful information')
+log.warn(`Hey pay attention: ${message}`)
+log.error(`Catch an exception: ${message}`)
+log.fatal(`Catch an exception: ${message} even if it's too late, sorry.`)
+
+// use the proper flag to check if the level log is active (to minimize phantom loads)
+log.i && log.info('Total commissions -> %d', aHugeCalculation())
+
+// f.e.
+log.t && log.trace('print a message')
+log.d && log.debug('print a message')
+log.i && log.info('print a message')
+log.w && log.warn('print a message')
+log.e && log.error('print a message')
+log.f && log.fatal('print a message')
+```
+
+Other settings:
+
+- **LOG_TIMESTAMP** (bool): add timestamp in each line
+- **LOG_TIMESTAMP_READABLE** (bool): if timestamp is enabled this specify a human-readable format (worst performance)
+- **LOG_COLORIZE** (bool): add a bit of colors
+
+Defaults, see [logger.ts](./lib/util/logger.ts):
+
+```js
+const logColorize = yn(LOG_COLORIZE, true)
+const logTimestamp = yn(LOG_TIMESTAMP, true)
+const logTimestampReadable = yn(LOG_TIMESTAMP_READABLE, true)
+```
+
+## Swagger
+
+In the .env file you can change swagger settings in this way:
+
+```ruby
+SWAGGER=true
+SWAGGER_TITLE=API Documentation
+SWAGGER_DESCRIPTION=List of available APIs and schemes to use
+SWAGGER_VERSION=0.1.0
+```
+
+## Fastify modules
+
+In the .env file you can activate some modules in this way:
+
+```ruby
+SRV_CORS=false
+SRV_HELMET=false
+SRV_RATELIMIT=false
+SRV_COMPRESS=false
+```

package/TODO.md

@@ -0,0 +1,12 @@
+# TODO
+
+- roles
+- database psql
+- models
+- validations
+- authentication
+- hooks (come middlewares esposti)
+- testare middlewares
+- usare progetto come modulo
+- creare modulo npm
+- metrics (plugin?)

package/jest.config.js

@@ -0,0 +1,188 @@
+// For a detailed explanation regarding each configuration property, visit:
+// https://jestjs.io/docs/en/configuration.html
+
+module.exports = {
+  // All imported modules in your tests should be mocked automatically
+  // automock: false,
+
+  // Stop running tests after `n` failures
+  // bail: 0,
+
+  // The directory where Jest should store its cached dependency information
+  // cacheDirectory: "C:\\Users\\davide\\AppData\\Local\\Temp\\jest",
+
+  // Automatically clear mock calls and instances between every test
+  // clearMocks: false,
+
+  // Indicates whether the coverage information should be collected while executing the test
+  collectCoverage: true,
+
+  // An array of glob patterns indicating a set of files for which coverage information should be collected
+  // collectCoverageFrom: undefined,
+
+  // The directory where Jest should output its coverage files
+  // coverageDirectory: undefined,
+
+  // An array of regexp pattern strings used to skip coverage collection
+  // coveragePathIgnorePatterns: [
+  //   "\\\\node_modules\\\\"
+  // ],
+
+  // Indicates which provider should be used to instrument code for coverage
+  coverageProvider: "v8",
+
+  // A list of reporter names that Jest uses when writing coverage reports
+  // coverageReporters: [
+  //   "json",
+  //   "text",
+  //   "lcov",
+  //   "clover"
+  // ],
+
+  // An object that configures minimum threshold enforcement for coverage results
+  // coverageThreshold: undefined,
+
+  // A path to a custom dependency extractor
+  // dependencyExtractor: undefined,
+
+  // Make calling deprecated APIs throw helpful error messages
+  // errorOnDeprecated: false,
+
+  // Force coverage collection from ignored files using an array of glob patterns
+  // forceCoverageMatch: [],
+
+  // A path to a module which exports an async function that is triggered once before all test suites
+  // globalSetup: undefined,
+
+  // A path to a module which exports an async function that is triggered once after all test suites
+  // globalTeardown: undefined,
+
+  // A set of global variables that need to be available in all test environments
+  // globals: {},
+
+  // The maximum amount of workers used to run your tests. Can be specified as % or a number. E.g. maxWorkers: 10% will use 10% of your CPU amount + 1 as the maximum worker number. maxWorkers: 2 will use a maximum of 2 workers.
+  // maxWorkers: "50%",
+
+  // An array of directory names to be searched recursively up from the requiring module's location
+  // moduleDirectories: [
+  //   "node_modules"
+  // ],
+
+  // An array of file extensions your modules use
+  // moduleFileExtensions: [
+  //   "js",
+  //   "json",
+  //   "jsx",
+  //   "ts",
+  //   "tsx",
+  //   "node"
+  // ],
+
+  // A map from regular expressions to module names or to arrays of module names that allow to stub out resources with a single module
+  // moduleNameMapper: {},
+
+  // An array of regexp pattern strings, matched against all module paths before considered 'visible' to the module loader
+  // modulePathIgnorePatterns: [],
+
+  // Activates notifications for test results
+  // notify: false,
+
+  // An enum that specifies notification mode. Requires { notify: true }
+  // notifyMode: "failure-change",
+
+  // A preset that is used as a base for Jest's configuration
+  // preset: undefined,
+
+  // Run tests from one or more projects
+  // projects: undefined,
+
+  // Use this configuration option to add custom reporters to Jest
+  // reporters: undefined,
+
+  // Automatically reset mock state between every test
+  // resetMocks: false,
+
+  // Reset the module registry before running each individual test
+  // resetModules: false,
+
+  // A path to a custom resolver
+  // resolver: undefined,
+
+  // Automatically restore mock state between every test
+  // restoreMocks: false,
+
+  // The root directory that Jest should scan for tests and modules within
+  // rootDir: undefined,
+
+  // A list of paths to directories that Jest should use to search for files in
+  // roots: [
+  //   "<rootDir>"
+  // ],
+
+  // Allows you to use a custom runner instead of Jest's default test runner
+  // runner: "jest-runner",
+
+  // The paths to modules that run some code to configure or set up the testing environment before each test
+  // setupFiles: [],
+
+  // A list of paths to modules that run some code to configure or set up the testing framework before each test
+  // setupFilesAfterEnv: [],
+
+  // A list of paths to snapshot serializer modules Jest should use for snapshot testing
+  // snapshotSerializers: [],
+
+  // The test environment that will be used for testing
+  testEnvironment: "node",
+
+  // Options that will be passed to the testEnvironment
+  // testEnvironmentOptions: {},
+
+  // Adds a location field to test results
+  // testLocationInResults: false,
+
+  // The glob patterns Jest uses to detect test files
+  // testMatch: [
+  //   "**/__tests__/**/*.[jt]s?(x)",
+  //   "**/?(*.)+(spec|test).[tj]s?(x)"
+  // ],
+
+  // An array of regexp pattern strings that are matched against all test paths, matched tests are skipped
+  // testPathIgnorePatterns: [
+  //   "\\\\node_modules\\\\"
+  // ],
+
+  // The regexp pattern or array of patterns that Jest uses to detect test files
+  // testRegex: [],
+
+  // This option allows the use of a custom results processor
+  // testResultsProcessor: undefined,
+
+  // This option allows use of a custom test runner
+  // testRunner: "jasmine2",
+
+  // This option sets the URL for the jsdom environment. It is reflected in properties such as location.href
+  // testURL: "http://localhost",
+
+  // Setting this value to "fake" allows the use of fake timers for functions such as "setTimeout"
+  // timers: "real",
+
+  // A map from regular expressions to paths to transformers
+  // transform: undefined,
+
+  // An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation
+  // transformIgnorePatterns: [
+  //   "\\\\node_modules\\\\"
+  // ],
+
+  // An array of regexp pattern strings that are matched against all modules before the module loader will automatically return a mock for them
+  // unmockedModulePathPatterns: undefined,
+
+  // Indicates whether each individual test should be reported during the run
+  // verbose: undefined,
+
+  // An array of regexp patterns that are matched against all source file paths before re-running tests in watch mode
+  // watchPathIgnorePatterns: [],
+
+  // Whether to use watchman for file crawling
+  // watchman: true,
+};

package/lib/api/me/controller/me.ts

@@ -0,0 +1,13 @@
+import { FastifyReply, FastifyRequest } from 'fastify'
+
+export async function user(req: FastifyRequest, reply: FastifyReply) {
+  reply.send(req.user || {})
+}
+
+export async function isAdmin(req: FastifyRequest, reply: FastifyReply) {
+  reply.send({ isAdmin: (req.user?.roles || []).includes('admin') || false })
+}
+
+export async function demo(req: FastifyRequest, reply: FastifyReply) {
+  reply.send({ demo: true })
+}

package/lib/api/me/routes.ts

@@ -0,0 +1,98 @@
+export default {
+  config: {
+    title: 'Useful functions',
+    description: 'Useful functions',
+    controller: 'controller',
+    tags: ['user', 'code'], // swagger
+    enable: true,
+    deprecated: false, // swagger
+    version: false // swagger
+  },
+  routes: [
+    {
+      method: 'GET',
+      path: '/',
+      roles: [],
+      handler: 'me.user',
+      middlewares: ['global.isAuthenticated'],
+      config: {
+        enable: true,
+        title: 'Me title', // swagger summary
+        description: 'Me description', // swagger
+        tags: ['user', 'code'], // swagger
+        deprecated: false, // swagger
+        version: false, // swagger
+        response: {
+          403: {
+            description: 'Successful response',
+            type: 'object',
+            properties: {
+              hello: { type: 'string' }
+            }
+          },
+          200: {
+            description: 'Default response',
+            type: 'object',
+            properties: {
+              id: { type: 'number' }
+            }
+          }
+        } // swagger
+      }
+    },
+    {
+      method: 'GET',
+      path: '/is-admin',
+      roles: [],
+      handler: 'me.isAdmin',
+      middlewares: ['global.isAuthenticated'],
+      config: {
+        title: 'Admin',
+        description: 'Admin',
+        enable: true,
+        deprecated: false,
+        version: false
+      }
+    },
+    {
+      method: 'GET',
+      path: '/demo',
+      roles: [],
+      handler: 'me.demo',
+      middlewares: ['global.isAdmin'],
+      config: {
+        enable: true,
+        title: 'Me title', // swagger summary
+        description: 'Me description', // swagger
+        tags: ['user', 'code'], // swagger
+        deprecated: false, // swagger
+        version: false, // swagger
+        params: {
+          type: 'object',
+          properties: {
+            id: {
+              type: 'string',
+              description: 'user id'
+            }
+          }
+        }, // swagger
+        response: {
+          201: {
+            description: 'Successful response',
+            type: 'object',
+            properties: {
+              hello: { type: 'string' }
+            }
+          },
+          200: {
+            description: 'Default response',
+            type: 'object',
+            properties: {
+              foo: { type: 'string' }
+            }
+          }
+        } // swagger
+      }
+    }
+  ]
+}

package/lib/apollo/context.ts

@@ -0,0 +1,11 @@
+'use strict'
+
+import { ApolloFastifyContextFunction } from '@as-integrations/fastify'
+
+export interface MyContext {
+  greeting: string
+}
+
+export const myContextFunction: ApolloFastifyContextFunction<MyContext> = async () => ({
+  greeting: 'Hello World!! ' + new Date().getTime()
+})

package/lib/apollo/resolvers.ts

@@ -0,0 +1,11 @@
+'use strict'
+
+import { MyContext } from './context'
+
+const resolvers = {
+  Query: {
+    helloWorld: (parent: any, args: any, context: MyContext, info: any) => context.greeting
+  }
+}
+
+export default resolvers

package/lib/apollo/type-defs.ts

@@ -0,0 +1,9 @@
+'use strict'
+
+const typeDefs = `
+	type Query {
+		helloWorld: String!
+	}
+`
+
+export default typeDefs

package/lib/config/roles.ts

@@ -0,0 +1,25 @@
+export {}
+
+// additional roles
+declare global {
+  enum RoleKey {}
+  // customer = 'customer'
+}
+
+export const roles: Role[] = [
+  {
+    code: 'public',
+    name: 'Public',
+    description: 'Public role'
+  },
+  {
+    code: 'admin',
+    name: 'Admin',
+    description: 'Admin role'
+  },
+  {
+    code: 'backoffice',
+    name: 'Backoffice',
+    description: 'Backoffice role'
+  }
+]