Merge pull request #54 from vbetsch/develop

Sprint 3 - Create API routes for create, list and delete vaults

Author: vbetsch

.idea/sqldialects.xml

@@ -45,6 +45,6 @@ clean:
 
 # Aliases
 run: up dev
-checks: lint
-checks_build: checks build
-.PHONY: run checks checks_build
+checks: lint tests
+ci: checks build
+.PHONY: run checks ci

Makefile

@@ -0,0 +1,8 @@
+-- CreateTable
+CREATE TABLE "Vault" (
+    "id" TEXT NOT NULL,
+    "label" VARCHAR(255) NOT NULL,
+    "secret" VARCHAR(255) NOT NULL,
+
+    CONSTRAINT "Vault_pkey" PRIMARY KEY ("id")
+);

prisma/migrations/20250720185500_init/migration.sql

@@ -7,3 +7,9 @@ datasource db {
   provider = "postgresql"
   url      = env("DATABASE_URL")
 }
+
+model Vault {
+  id     String @id @default(uuid())
+  label  String @db.VarChar(255)
+  secret String @db.VarChar(255)
+}

prisma/migrations/20250720202439_init/migration.sql

@@ -1,6 +1,7 @@
 import { createSwaggerSpec } from 'next-swagger-doc';
+import { NextResponse } from 'next/server';
 
-export function GET(): Response {
+export function GET(): NextResponse {
   const spec: object = createSwaggerSpec({
     apiFolder: 'src/app/api',
     schemaFolders: ['src/modules/shared/dto'],
@@ -13,5 +14,5 @@ export function GET(): Response {
     },
   });
 
-  return Response.json(spec);
+  return NextResponse.json(spec);
 }

prisma/migrations/20250729163721_init/migration.sql

@@ -0,0 +1,45 @@
+import 'reflect-metadata';
+import type { NextRequest, NextResponse } from 'next/server';
+import type { IdParam } from '@shared/dto/params/id.param';
+import { container } from 'tsyringe';
+import { handleApiRequest } from '@api/utils/handle-api-request';
+import { StatusCodes } from 'http-status-codes';
+import { DeleteVaultUseCase } from '@api/usecases/vaults/delete-vault.usecase';
+
+/**
+ * @swagger
+ * /api/vaults/{id}:
+ *   delete:
+ *     tags:
+ *      - Vaults
+ *     description: Delete a vault by ID
+ *     parameters:
+ *      - in: path
+ *        name: id
+ *        required: true
+ *        description: ID of vault to delete
+ *        schema:
+ *          type: string
+ *     responses:
+ *       204:
+ *         description: The vault has been successfully deleted
+ *       404:
+ *         description: Vault not found
+ *       500:
+ *         description: Internal Server Error
+ *         content:
+ *           application/json:
+ *             schema:
+ *               $ref: '#/components/schemas/HttpResponseDto'
+ */
+export async function DELETE(
+  request: NextRequest,
+  params: IdParam
+): Promise<NextResponse> {
+  const deleteVaultUseCase: DeleteVaultUseCase =
+    container.resolve(DeleteVaultUseCase);
+  return await handleApiRequest(
+    () => deleteVaultUseCase.handle(params),
+    StatusCodes.NO_CONTENT
+  );
+}

prisma/schema.prisma

@@ -0,0 +1,80 @@
+import 'reflect-metadata';
+import type { NextRequest, NextResponse } from 'next/server';
+import { container } from 'tsyringe';
+import { handleApiRequest } from '@api/utils/handle-api-request';
+import type { VaultModelDto } from '@shared/dto/models/vault.model.dto';
+import type { CreateVaultResponseDto } from '@shared/dto/responses/create-vault.response.dto';
+import { CreateVaultUseCase } from '@api/usecases/vaults/create-vault.usecase';
+import type { GetMyVaultsResponseDto } from '@shared/dto/responses/get-my-vaults.response.dto';
+import { GetMyVaultsUseCase } from '@api/usecases/vaults/get-my-vaults.usecase';
+import type { CreateVaultRequestDto } from '@shared/dto/requests/create-vault.request.dto';
+import { StatusCodes } from 'http-status-codes';
+
+/**
+ * @swagger
+ * /api/vaults:
+ *   get:
+ *     tags:
+ *      - Vaults
+ *     description: Get my vaults
+ *     responses:
+ *       200:
+ *         description: Returns my vaults
+ *         content:
+ *           application/json:
+ *             schema:
+ *               $ref: '#/components/schemas/GetMyVaultsResponseDto'
+ *       500:
+ *         description: Internal Server Error
+ *         content:
+ *           application/json:
+ *             schema:
+ *               $ref: '#/components/schemas/HttpResponseDto'
+ */
+export async function GET(): Promise<NextResponse> {
+  const getMyVaultsUseCase: GetMyVaultsUseCase =
+    container.resolve(GetMyVaultsUseCase);
+  return await handleApiRequest(async () => {
+    const myVaults: VaultModelDto[] = await getMyVaultsUseCase.handle();
+    const response: GetMyVaultsResponseDto = { myVaults };
+    return response;
+  });
+}
+
+/**
+ * @swagger
+ * /api/vaults:
+ *   post:
+ *     tags:
+ *      - Vaults
+ *     description: Create a vault
+ *     requestBody:
+ *       required: true
+ *       content:
+ *         application/json:
+ *           schema:
+ *             $ref: '#/components/schemas/CreateVaultRequestDto'
+ *     responses:
+ *       201:
+ *         description: Returns the vault created
+ *         content:
+ *           application/json:
+ *             schema:
+ *               $ref: '#/components/schemas/CreateVaultResponseDto'
+ *       500:
+ *         description: Internal Server Error
+ *         content:
+ *           application/json:
+ *             schema:
+ *               $ref: '#/components/schemas/HttpResponseDto'
+ */
+export async function POST(request: NextRequest): Promise<NextResponse> {
+  const params: CreateVaultRequestDto = await request.json();
+  const createVaultUseCase: CreateVaultUseCase =
+    container.resolve(CreateVaultUseCase);
+  return await handleApiRequest(async () => {
+    const vaultCreated: VaultModelDto = await createVaultUseCase.handle(params);
+    const response: CreateVaultResponseDto = { vaultCreated };
+    return response;
+  }, StatusCodes.CREATED);
+}