feat: add koa-jsonapi-zod and remove unneccessary boilerplate code

soliantconsulting · Feb 12, 2024 · ea3238c · ea3238c
1 parent c287b69
commit ea3238c
Show file tree

Hide file tree

Showing 18 changed files with 128 additions and 241 deletions.
diff --git a/biome.json b/biome.json
@@ -17,8 +17,34 @@
         "rules": {
             "recommended": true,
             "nursery": {
+                "noEmptyTypeParameters": "error",
+                "noInvalidUseBeforeDeclaration": "error",
+                "noUnusedImports": "error",
+                "noUnusedPrivateClassMembers": "error",
+                "noUselessLoneBlockStatements": "error",
+                "noUselessTernary": "error",
+                "useExportType": "error",
                 "useImportType": "error",
-                "noUnusedImports": "error"
+                "useForOf": "error",
+                "useGroupedTypeImport": "error"
+            },
+            "complexity": {
+                "noExcessiveCognitiveComplexity": "warn",
+                "useSimplifiedLogicExpression": "error"
+            },
+            "correctness": {
+                "noNewSymbol": "error"
+            },
+            "style": {
+                "useBlockStatements": "error",
+                "useCollapsedElseIf": "error",
+                "useShorthandArrayType": "error",
+                "useShorthandAssign": "error",
+                "useSingleCaseStatement": "error"
+            },
+            "suspicious": {
+                "noApproximativeNumericConstant": "warn",
+                "noConsoleLog": "error"
             }
         }
     },

diff --git a/skeleton/base/biome.json b/skeleton/base/biome.json
@@ -18,8 +18,34 @@
         "rules": {
             "recommended": true,
             "nursery": {
+                "noEmptyTypeParameters": "error",
+                "noInvalidUseBeforeDeclaration": "error",
+                "noUnusedImports": "error",
+                "noUnusedPrivateClassMembers": "error",
+                "noUselessLoneBlockStatements": "error",
+                "noUselessTernary": "error",
+                "useExportType": "error",
                 "useImportType": "error",
-                "noUnusedImports": "error"
+                "useForOf": "error",
+                "useGroupedTypeImport": "error"
+            },
+            "complexity": {
+                "noExcessiveCognitiveComplexity": "warn",
+                "useSimplifiedLogicExpression": "error"
+            },
+            "correctness": {
+                "noNewSymbol": "error"
+            },
+            "style": {
+                "useBlockStatements": "error",
+                "useCollapsedElseIf": "error",
+                "useShorthandArrayType": "error",
+                "useShorthandAssign": "error",
+                "useSingleCaseStatement": "error"
+            },
+            "suspicious": {
+                "noApproximativeNumericConstant": "warn",
+                "noConsoleLog": "error"
             }
         }
     },

diff --git a/skeleton/base/src/route/hello-world/foo.ts b/skeleton/base/src/route/hello-world/foo.ts
diff --git a/skeleton/base/src/route/hello-world/index.ts b/skeleton/base/src/route/hello-world/index.ts
diff --git a/skeleton/base/src/route/index.ts b/skeleton/base/src/route/index.ts
@@ -1,6 +1,3 @@
 import type Router from "koa-tree-router";
-import { registerHelloWorldRoutes } from "./hello-world/index.js";
 
-export const registerRoutes = (router: Router): void => {
-    registerHelloWorldRoutes(router);
-};
+export const registerRoutes = (router: Router): void => {};
diff --git a/skeleton/base/src/util/json-api.ts b/skeleton/base/src/util/json-api.ts
diff --git a/skeleton/base/src/util/zod.ts b/skeleton/base/src/util/zod.ts
diff --git a/...atures/appconfig/dev-app-config.toml.dist → ...atures/appconfig/base/dev-app-config.toml b/...atures/appconfig/dev-app-config.toml.dist → ...atures/appconfig/base/dev-app-config.toml
diff --git a/skeleton/features/postgres/base/src/entity/World.ts b/skeleton/features/postgres/base/src/entity/World.ts
diff --git a/skeleton/features/postgres/base/src/mikro-orm.config.ts b/skeleton/features/postgres/base/src/mikro-orm.config.ts
@@ -111,6 +111,9 @@ export default (async (): Promise<Options> => {
             pathTs: "./src/migration",
             generator,
         },
+        discovery: {
+            warnWhenNoEntities: false,
+        },
         loadStrategy: LoadStrategy.JOINED,
         ...postgresConfig,
     });

diff --git a/skeleton/features/postgres/base/src/util/mikro-orm.ts b/skeleton/features/postgres/base/src/util/mikro-orm.ts
@@ -1,7 +1,9 @@
-import { RequestContext } from "@mikro-orm/core";
+import { type QueryOrderMap, RequestContext } from "@mikro-orm/core";
 import { MikroORM } from "@mikro-orm/postgresql";
 import fnv1a from "@sindresorhus/fnv1a";
+import { unflatten } from "flat";
 import type { Next, ParameterizedContext } from "koa";
+import type { Sort } from "koa-jsonapi-zod";
 
 export const orm = await MikroORM.init();
 export const em = orm.em;
@@ -22,3 +24,17 @@ await em.transactional(async (em) => {
 
 export const requestContextMiddleware = async (_context: ParameterizedContext, next: Next) =>
     RequestContext.create(em, next);
+
+export const orderByFromJsonApiSort = <TSort extends string, TEntity>(
+    sort: Sort<TSort> | undefined,
+): QueryOrderMap<TEntity>[] | undefined => {
+    if (!sort) {
+        return undefined;
+    }
+
+    return sort.map((field) =>
+        unflatten({
+            [field.field]: field.order,
+        }),
+    );
+};
diff --git a/skeleton/features/postgres/package.json b/skeleton/features/postgres/package.json
@@ -8,7 +8,8 @@
         "@mikro-orm/core": "^6.0.0",
         "@mikro-orm/postgresql": "^6.0.0",
         "@mikro-orm/migrations": "^6.0.0",
-        "@sindresorhus/fnv1a": "^3.1.0"
+        "@sindresorhus/fnv1a": "^3.1.0",
+        "flat": "^6.0.1"
     },
     "scripts": {
         "mikro-orm": "tsx ./node_modules/@mikro-orm/cli/esm"

diff --git a/skeleton/package.json b/skeleton/package.json
@@ -31,6 +31,7 @@
         "koa-bodyparser": "^4.3.0",
         "koa-cache-control": "^2.0.0",
         "koa-compress": "^5.0.1",
+        "koa-jsonapi-zod": "^1.1.0",
         "koa-tree-router": "^0.12.1",
         "source-map-support": "^0.5.21",
         "winston": "^3.6.0",

diff --git a/skeleton/templates/README.md.mustache b/skeleton/templates/README.md.mustache
@@ -2,6 +2,8 @@
 
 Koa API following [JSON:API](https://jsonapi.org/) 1.1 specification.
 
+See [koa-jsonapi-zod](/~https://github.com/DASPRiD/koa-jsonapi-zod) examples for integration.
+
 ## Setup
 
 - `pnpm install`

diff --git a/skeleton/templates/cdk/src/api-stack.ts.mustache b/skeleton/templates/cdk/src/api-stack.ts.mustache
@@ -8,6 +8,7 @@ import {
     InstanceType,
     IpAddresses,
     IpProtocol,
+    Port,
     SubnetType,
     Vpc,
 } from "aws-cdk-lib/aws-ec2";
@@ -75,12 +76,6 @@ export class ApiStack extends Stack {
         if (!databaseCluster.secret) {
             throw new Error("Database cluster has nio secret attached");
         }
-
-        const databaseProxy = databaseCluster.addProxy("DatabaseProxy", {
-            vpc,
-            secrets: [databaseCluster.secret],
-            clientPasswordAuthType: ClientPasswordAuthType.POSTGRES_SCRAM_SHA_256,
-        });
 {{/if}}
 {{#if (has features "appconfig")}}
 
@@ -138,8 +133,8 @@ export class ApiStack extends Stack {
                 environment: {
                     PORT: "80",
 {{#if (has features "postgres")}}
-                    POSTGRES_HOSTNAME: databaseProxy.endpoint,
-                    POSTGRES_PORT: "5432",
+                    POSTGRES_HOSTNAME: databaseCluster.clusterEndpoint.hostname,
+                    POSTGRES_PORT: databaseCluster.clusterEndpoint.port.toString(),
                     POSTGRES_SECRET: databaseCluster.secret.secretArn,
                     PGSSLMODE: "require",
 {{/if}}
@@ -161,7 +156,7 @@ export class ApiStack extends Stack {
         });
 
 {{#if (has features "postgres")}}
-        albService.service.connections.allowTo(databaseProxy.connections, Port.tcp(5432));
+        albService.service.connections.allowToDefaultPort(databaseCluster.connections);
         databaseCluster.secret.grantRead(albService.taskDefinition.taskRole);
 {{/if}}
 {{#if (has features "appconfig")}}