Several features for the node-boot persistence layer

.prettierrc.yaml

@@ -4,3 +4,4 @@ singleQuote: false
 trailingComma: "all"
 arrowParens: "avoid"
 bracketSpacing: false
+printWidth: 120

app-config.yaml

@@ -0,0 +1,55 @@
+node-boot:
+    # App configurations
+    application:
+        name: ""
+        platform: ""
+        environment: ""
+        defaultErrorHandler: false
+        port: 3000
+        api:
+            routePrefix: ""
+            nullResultCode: 200
+            undefinedResultCode: 200
+            paramOptions:
+                required: false
+            validations:
+                enable: true
+                enableDebugMessages: false
+                skipUndefinedProperties: false
+                skipNullProperties: false
+                skipMissingProperties: false
+                whitelist: false
+                forbidNonWhitelisted: false
+                forbidUnknownValues: false
+                stopAtFirstError: false
+
+    # Server configurations
+    server:
+        cors:
+            origin: "*"
+            methods:
+                - GET
+                - POST
+                - DELETE
+                - PUT
+            credentials: true
+            maxAge: 55000
+            cacheControl: 4096
+            preflightContinue: true
+            optionsSuccessStatus: 204
+            preflight: true
+            strictPreflight: false
+            exposedHeaders: []
+            allowedHeaders: []
+        multipart:
+            throwFileSizeLimit: true
+            limits:
+                fieldNameSize: 128
+                fieldSize: 128
+                fields: 10
+                fileSize: 4096
+                files: 5
+                headerPairs: 10
+
+    # Storage configurations
+    persistence:

package.json

@@ -22,7 +22,7 @@
         "pnpm": ">=7.5.1"
     },
     "main": "dist/index.js",
-    "types": "dist/index.d.ts",
+    "types": "src/index.ts",
     "scripts": {
         "build": "turbo run build",
         "build:clean": "turbo run clean:build",
@@ -57,7 +57,12 @@
         "prettier": "^2.8.3",
         "prettier-plugin-organize-imports": "^3.2.3",
         "rimraf": "^4.3.1",
-        "turbo": "^1.10.12",
+        "turbo": "^1.11.2",
         "typescript": "^5.1.6"
-    }
+    },
+    "files": [
+        "dist",
+        "config.d.ts"
+    ],
+    "configSchema": "config.d.ts"
 }

packages/authorization/jest.config.js

@@ -1,4 +1,3 @@
-/** @type {import('jest').Config} */
 module.exports = {
     transform: {
         "^.+\\.(t|j)sx?$": "@swc/jest",

packages/authorization/package.json

@@ -15,8 +15,8 @@
     "publishConfig": {
         "access": "public"
     },
-    "main": "dist/index.js",
-    "types": "dist/index.d.ts",
+    "main": "src/index.js",
+    "types": "src/index.ts",
     "scripts": {
         "build": "tsc -p tsconfig.build.json",
         "clean:build": "rimraf ./dist",
@@ -29,9 +29,7 @@
         "typecheck": "tsc"
     },
     "dependencies": {
-        "@node-boot/context": "1.0.0"
-    },
-    "peerDependencies": {
-        "routing-controllers": ">=0.10.4"
+        "@node-boot/context": "1.0.0",
+        "@node-boot/engine": "1.0.0"
     }
 }

packages/authorization/src/decorator/Authorized.ts

@@ -1,4 +1,4 @@
-import {Authorized as InnerAuthorized} from "routing-controllers";
+import {NodeBootToolkit} from "@node-boot/engine";
 
 /**
  * Marks controller action to have a special access.
@@ -27,15 +27,14 @@ export function Authorized(role: Function): Function;
 /**
  * Marks controller action to have a special access.
  * Authorization logic must be defined in routing-controllers settings.
- *
- * @param roleOrRoles Arguments for routing-controllers @Authorized decorator
  */
-export function Authorized(roleOrRoles?: string | string[] | Function) {
-    return <TFunction extends Function>(
-        clsOrObject: Function | Object,
-        method?: string,
-    ) => {
-        // DI is optional and the decorator will only be applied if the DI container dependency is available.
-        InnerAuthorized(roleOrRoles)(clsOrObject, method);
+export function Authorized(roleOrRoles?: string | string[] | Function): Function {
+    return function (clsOrObject: Function | Object, method?: string) {
+        NodeBootToolkit.getMetadataArgsStorage().responseHandlers.push({
+            type: "authorized",
+            target: method ? clsOrObject.constructor : (clsOrObject as Function),
+            method: method,
+            value: roleOrRoles,
+        });
     };
 }

packages/authorization/src/decorator/CurrentUser.ts

@@ -1,13 +1,18 @@
-import {CurrentUser as InnerCurrentUser} from "routing-controllers";
+import {NodeBootToolkit} from "@node-boot/engine";
 
 /**
  * Injects currently authorized user.
  * Authorization logic must be defined in routing-controllers settings.
- *
- * @param args Arguments for routing-controllers @CurrentUser decorator
  */
-export function CurrentUser(...args: Parameters<typeof InnerCurrentUser>) {
-    return (target: Object, methodName: string, index: number) => {
-        InnerCurrentUser(...args)(target, methodName, index);
+export function CurrentUser(options?: {required?: boolean}) {
+    return function (object: Object, methodName: string, index: number) {
+        NodeBootToolkit.getMetadataArgsStorage().params.push({
+            type: "current-user",
+            object: object,
+            method: methodName,
+            index: index,
+            parse: false,
+            required: options?.required ?? false,
+        });
     };
 }

packages/authorization/src/decorator/EnableAuthorization.ts

@@ -1,35 +1,22 @@
-import {ApplicationContext, RequestContext} from "@node-boot/context";
-import {AuthorizationResolver, CurrentUserResolver} from "../resolver";
-import {Action} from "routing-controllers/types/Action";
+import {ApplicationContext, AuthorizationChecker, CurrentUserChecker} from "@node-boot/context";
 
 /**
  * Enable Authorization features by providing an Authorization and current user resolvers.
  *
- * @param CurrentUserResolverClass class implementing CurrentUserResolver interface
- * @param AuthorizationResolverClass class implementing AuthorizationResolver interface
+ * @param CurrentUserCheckerClass class implementing CurrentUserResolver interface
+ * @param AuthorizationCheckerClass class implementing AuthorizationResolver interface
  */
 export function EnableAuthorization(
-    CurrentUserResolverClass?: new () => CurrentUserResolver,
-    AuthorizationResolverClass?: new () => AuthorizationResolver,
+    CurrentUserCheckerClass?: new () => CurrentUserChecker,
+    AuthorizationCheckerClass?: new () => AuthorizationChecker,
 ): Function {
-    return function (object: Function) {
-        if (AuthorizationResolverClass) {
-            const authResolver = new AuthorizationResolverClass();
-            ApplicationContext.get().authorizationChecker = async (
-                context: RequestContext,
-                roles: any[],
-            ) => {
-                return authResolver.authorize(context, roles);
-            };
+    return function () {
+        if (AuthorizationCheckerClass) {
+            ApplicationContext.get().authorizationChecker = new AuthorizationCheckerClass();
         }
 
-        if (CurrentUserResolverClass) {
-            const userResolver = new CurrentUserResolverClass();
-            ApplicationContext.get().currentUserChecker = async (
-                action: Action,
-            ) => {
-                return userResolver.getCurrentUser(action);
-            };
+        if (CurrentUserCheckerClass) {
+            ApplicationContext.get().currentUserChecker = new CurrentUserCheckerClass();
         }
     };
 }

packages/authorization/src/index.ts

@@ -1,2 +1 @@
 export * from "./decorator";
-export * from "./resolver";

packages/config/jest.config.js

@@ -1,4 +1,3 @@
-/** @type {import('jest').Config} */
 module.exports = {
     transform: {
         "^.+\\.(t|j)sx?$": "@swc/jest",

packages/config/package.json

@@ -16,7 +16,7 @@
         "access": "public"
     },
     "main": "dist/index.js",
-    "types": "dist/index.d.ts",
+    "types": "src/index.ts",
     "scripts": {
         "build": "tsc -p tsconfig.build.json",
         "clean:build": "rimraf ./dist",

packages/config/src/decorator/ConfigurationProperties.ts

@@ -1,14 +1,8 @@
-import {
-    ApplicationContext,
-    ConfigurationPropertiesAdapter,
-    IocContainer,
-} from "@node-boot/context";
+import {ApplicationContext, ConfigurationPropertiesAdapter, IocContainer} from "@node-boot/context";
 import {ConfigurationPropertiesMetadata} from "../metadata";
 import {ConfigService} from "../service";
 
-export function ConfigurationProperties(
-    args: ConfigurationPropertiesMetadata,
-): Function {
+export function ConfigurationProperties(args: ConfigurationPropertiesMetadata): Function {
     return function (target: any) {
         Reflect.defineMetadata("config:isConfigProperties", true, target);
         Reflect.defineMetadata("config:path", args.configPath, target);
@@ -17,22 +11,14 @@ export function ConfigurationProperties(
             new (class implements ConfigurationPropertiesAdapter {
                 bind(iocContainer: IocContainer) {
                     const config: ConfigService = iocContainer.get("config");
-                    const configProperties = config.get<typeof target>(
-                        args.configPath,
-                    );
+                    const configProperties = config.get<typeof target>(args.configPath);
 
                     if (configProperties) {
                         const instance = new target();
 
                         for (const propertyName in configProperties) {
-                            if (
-                                Object.prototype.hasOwnProperty.call(
-                                    configProperties,
-                                    propertyName,
-                                )
-                            ) {
-                                instance[propertyName] =
-                                    configProperties[propertyName];
+                            if (Object.prototype.hasOwnProperty.call(configProperties, propertyName)) {
+                                instance[propertyName] = configProperties[propertyName];
                             }
                         }
                         if (!iocContainer.has(args.configName)) {
@@ -43,9 +29,7 @@ export function ConfigurationProperties(
                             );
                         }
                     } else {
-                        throw new Error(
-                            `Configuration for prefix '${args.configPath}' not found.`,
-                        );
+                        throw new Error(`Configuration for prefix '${args.configPath}' not found.`);
                     }
                 }
             })(),

packages/config/src/service/ConfigService.ts

@@ -7,10 +7,7 @@ export class ConfigService implements Config {
 
     private readonly subscribers: (() => void)[] = [];
 
-    constructor(
-        private readonly parent?: ConfigService,
-        private parentKey?: string,
-    ) {
+    constructor(private readonly parent?: ConfigService, private parentKey?: string) {
         if (parent && !parentKey) {
             throw new Error("parentKey is required if parent is set");
         }

packages/config/src/service/ObservableConfigProxy.test.ts

@@ -72,15 +72,9 @@ describe("ObservableConfigProxy", () => {
         expect(config3.getNumber("x")).toBe(6);
 
         config1.setConfig(new ConfigReader({}));
-        expect(() => config1.getNumber("x")).toThrow(
-            "Missing required config value at 'x'",
-        );
-        expect(() => config2.getNumber("x")).toThrow(
-            "Missing required config value at 'a'",
-        );
-        expect(() => config3.getNumber("x")).toThrow(
-            "Missing required config value at 'a'",
-        );
+        expect(() => config1.getNumber("x")).toThrow("Missing required config value at 'x'");
+        expect(() => config2.getNumber("x")).toThrow("Missing required config value at 'a'");
+        expect(() => config3.getNumber("x")).toThrow("Missing required config value at 'a'");
 
         config1.setConfig(new ConfigReader({x: "s", a: {x: "s", b: {x: "s"}}}));
         expect(() => config1.getNumber("x")).toThrow(

packages/config/src/service/config.ts

@@ -1,11 +1,7 @@
 import {resolve as resolvePath} from "path";
 import parseArgs from "minimist";
 import {findPaths} from "@backstage/cli-common";
-import {
-    ConfigTarget,
-    loadConfig,
-    LoadConfigOptionsRemote,
-} from "@backstage/config-loader";
+import {ConfigTarget, loadConfig, LoadConfigOptionsRemote} from "@backstage/config-loader";
 import type {AppConfig} from "@backstage/config";
 import {ConfigReader} from "@backstage/config";
 import {ConfigService} from "./ConfigService";
@@ -51,11 +47,7 @@ export async function loadNodeBootConfig(options: {
         remote: options.remote,
         watch: {
             onChange(newConfigs) {
-                console.info(
-                    `Reloaded config from ${newConfigs
-                        .map(c => c.context)
-                        .join(", ")}`,
-                );
+                console.info(`Reloaded config from ${newConfigs.map(c => c.context).join(", ")}`);
                 const configsToMerge = [...newConfigs];
                 if (options.additionalConfigs) {
                     configsToMerge.push(...options.additionalConfigs);
@@ -71,9 +63,7 @@ export async function loadNodeBootConfig(options: {
         },
     });
 
-    console.info(
-        `Loaded config from ${appConfigs.map(c => c.context).join(", ")}`,
-    );
+    console.info(`Loaded config from ${appConfigs.map(c => c.context).join(", ")}`);
 
     const finalAppConfigs = [...appConfigs];
     if (options.additionalConfigs) {

packages/context/jest.config.js

@@ -1,4 +1,3 @@
-/** @type {import('jest').Config} */
 module.exports = {
     transform: {
         "^.+\\.(t|j)sx?$": "@swc/jest",