Add Link Resolver Module with CRUD functionality and DTOs

.env

@@ -9,4 +9,13 @@ DATABASE_URL="postgres://tkawcvceqtdlrt:b63809a94a8d366a92eca1d489dbc43bcc7a58fd
 SHADOW_DATABASE_URL="postgres://kyrhydpwvpavke:7917c48b5ad1e3cfc294df930e053075270752c19bd13c1ea6fd31280722735c@ec2-44-205-112-253.compute-1.amazonaws.com:5432/dfdm5lo7eed2pb"
 
 
-JWT_SECRET='mSSS9Zrd'
+JWT_SECRET='mSSS9Zrd'
+
+# MinIO Configuration
+MINIO_ENDPOINT=localhost
+MINIO_PORT=9000
+MINIO_USE_SSL=false
+MINIO_ACCESS_KEY=minioadmin
+MINIO_SECRET_KEY=minioadmin
+MINIO_BUCKET=link-resolvers
+MINIO_REGION=us-east-1

docker-compose.minio.yml

@@ -0,0 +1,17 @@
+version: '3.7'
+
+services:
+  minio:
+    image: minio/minio
+    ports:
+      - "9000:9000"
+      - "9001:9001"
+    environment:
+      MINIO_ROOT_USER: minioadmin
+      MINIO_ROOT_PASSWORD: minioadmin
+    volumes:
+      - minio-data:/data
+    command: server --console-address ":9001" /data
+
+volumes:
+  minio-data: 

package.json

@@ -18,21 +18,27 @@
     "test:watch": "jest --watch",
     "test:cov": "jest --coverage",
     "test:debug": "node --inspect-brk -r tsconfig-paths/register -r ts-node/register node_modules/.bin/jest --runInBand",
-    "test:e2e": "jest --config ./test/jest-e2e.json"
+    "test:e2e": "jest --config ./test/jest-e2e.json",
+    "cli:dev": "ts-node src/cli.ts",
+    "cli:build": "nest build && node dist/cli.js",
+    "save-sample": "ts-node src/cli.ts save-sample"
   },
   "dependencies": {
+    "@aws-sdk/client-s3": "^3.777.0",
+    "@aws-sdk/s3-request-presigner": "^3.777.0",
     "@nestjs/common": "^9.0.0",
-    "@nestjs/config": "^2.2.0",
+    "@nestjs/config": "^4.0.2",
     "@nestjs/core": "^9.0.0",
     "@nestjs/jwt": "^9.0.0",
     "@nestjs/passport": "^9.0.0",
     "@nestjs/platform-express": "^9.0.0",
     "@prisma/client": "^4.1.1",
     "bcrypt": "^5.0.1",
     "class-transformer": "^0.5.1",
-    "class-validator": "^0.13.2",
+    "class-validator": "^0.14.1",
     "cookie-parser": "^1.4.6",
     "csurf": "^1.11.0",
+    "nest-commander": "^3.17.0",
     "passport": "^0.6.0",
     "passport-jwt": "^4.0.0",
     "reflect-metadata": "^0.1.13",

save-to-minio.sh

@@ -0,0 +1,17 @@
+#!/bin/bash
+
+# Start MinIO in the background
+echo "Starting MinIO..."
+docker-compose -f docker-compose.minio.yml up -d
+
+# Wait for MinIO to start
+echo "Waiting for MinIO to start..."
+sleep 5
+
+# Save the sample data
+echo "Saving sample data to MinIO..."
+yarn save-sample
+
+echo "Done!"
+echo "The MinIO console is available at http://localhost:9001 (login with minioadmin/minioadmin)"
+echo "The link resolver data is saved to the 'link-resolvers' bucket" 

src/app.module.ts

@@ -6,6 +6,8 @@ import { UserModule } from './user/user.module';
 import { TodoModule } from './todo/todo.module';
 import { PrismaModule } from './prisma/prisma.module';
 import { ConfigModule } from '@nestjs/config';
+import { LinkResolverModule } from './link-resolver/link-resolver.module';
+import { StorageModule } from './storage/storage.module';
 
 @Module({
   imports: [
@@ -14,6 +16,8 @@ import { ConfigModule } from '@nestjs/config';
     UserModule,
     TodoModule,
     PrismaModule,
+    LinkResolverModule,
+    StorageModule,
   ],
   controllers: [AppController],
   providers: [AppService],

src/cli.ts

@@ -0,0 +1,11 @@
+import { CommandFactory } from 'nest-commander';
+import { LinkResolverCommandsModule } from './link-resolver/commands/commands.module';
+import { StorageModule } from './storage/storage.module';
+
+async function bootstrap() {
+  await CommandFactory.run(LinkResolverCommandsModule, {
+    logger: ['error', 'warn'],
+  });
+}
+
+bootstrap(); 

src/common/index.ts

@@ -0,0 +1,8 @@
+/**
+ * Common Barrel File
+ *
+ * This file exports all common elements from the common directory,
+ * making them easier to import elsewhere in the application.
+ */
+
+export * from './interfaces';

src/common/interfaces/index.ts

@@ -0,0 +1,8 @@
+/**
+ * Interfaces Barrel File
+ *
+ * This file exports all interfaces from the interfaces directory,
+ * making them easier to import elsewhere in the application.
+ */
+
+export * from './repository.interface';

src/common/interfaces/repository.interface.ts

@@ -0,0 +1,55 @@
+/**
+ * Repository Provider Interface
+ *
+ * This file defines a TypeScript interface for a repository provider,
+ * which is a common pattern in software architecture for abstracting data access operations.
+ */
+
+/**
+ * Defines the structure for data being saved
+ * Requires an id property as a string
+ * Allows any additional properties
+ */
+export type SaveParams = {
+  id: string;
+  [k: string]: any;
+};
+
+/**
+ * Repository Provider Interface
+ *
+ * Defines four standard CRUD operations:
+ * - save: Stores data with the given parameters
+ * - one: Retrieves a single item by ID
+ * - all: Retrieves all items of a specific category
+ * - delete: Removes an item by ID
+ */
+export interface IRepositoryProvider {
+  /**
+   * Stores data with the given parameters
+   * @param data The data to be saved
+   * @returns A promise resolving to void
+   */
+  save(data: SaveParams): Promise<void>;
+
+  /**
+   * Retrieves a single item by ID
+   * @param id The unique identifier of the item
+   * @returns A promise resolving to the requested item or null if not found
+   */
+  one<T>(id: string): Promise<T | null>;
+
+  /**
+   * Retrieves all items of a specific category
+   * @param filter Optional filtering criteria
+   * @returns A promise resolving to an array of items
+   */
+  all<T>(filter?: object): Promise<T[]>;
+
+  /**
+   * Removes an item by ID
+   * @param id The unique identifier of the item to delete
+   * @returns A promise resolving to void
+   */
+  delete(id: string): Promise<void>;
+}

src/link-resolver/commands/commands.module.ts

@@ -0,0 +1,10 @@
+import { Module } from '@nestjs/common';
+import { SaveSampleDataCommand } from './save-sample-data.command';
+import { LinkResolverModule } from '../link-resolver.module';
+
+@Module({
+  imports: [LinkResolverModule],
+  providers: [SaveSampleDataCommand],
+  exports: [SaveSampleDataCommand],
+})
+export class LinkResolverCommandsModule {} 

src/link-resolver/commands/save-sample-data.command.ts

@@ -0,0 +1,69 @@
+import { Command, CommandRunner } from 'nest-commander';
+import { Injectable } from '@nestjs/common';
+import { LinkResolverService } from '../link-resolver.service';
+
+@Injectable()
+@Command({
+  name: 'save-sample',
+  description: 'Save sample link resolver data to MinIO',
+})
+export class SaveSampleDataCommand extends CommandRunner {
+  constructor(private readonly linkResolverService: LinkResolverService) {
+    super();
+  }
+
+  async run(): Promise<void> {
+    console.log('Saving sample link resolver data to MinIO...');
+
+    const sampleData = {
+      id: 'gs1/01/12345678901234/10/123456789012345678902.json',
+      createdAt: '2024-09-02T06:19:58.783Z',
+      linkset: {
+        anchor:
+          'http://localhost:3000/gs1/01/12345678901234/10/123456789012345678902',
+        'http://localhost:3000/voc/certificationInfo': [
+          {
+            href: 'https://example.com',
+            title: 'Certification Information',
+            type: 'application/json',
+            hreflang: ['en'],
+            'title*': [{ value: 'Certification Information', language: 'en' }],
+          },
+        ],
+      },
+      linkHeaderText: 
+        '<https://example.com>; rel="gs1:certificationInfo"; type="application/json"; hreflang="en"; title="Certification Information", <http://localhost:3000/gs1/01/12345678901234/10/123456789012345678902>; rel="owl:sameAs"',
+      namespace: 'gs1',
+      identificationKeyType: 'gtin',
+      identificationKey: '12345678901234',
+      itemDescription: 'Product description',
+      qualifierPath: '/10/123456789012345678902',
+      active: true,
+      responses: [
+        {
+          defaultLinkType: true,
+          defaultMimeType: true,
+          fwqs: false,
+          active: true,
+          linkType: 'gs1:certificationInfo',
+          title: 'Certification Information',
+          targetUrl: 'https://example.com',
+          mimeType: 'application/json',
+          ianaLanguage: 'en',
+          context: 'au',
+          defaultContext: true,
+          defaultIanaLanguage: true,
+        },
+      ],
+    };
+
+    try {
+      await this.linkResolverService.create(sampleData);
+      console.log('Sample data saved successfully!');
+      console.log(`ID: ${sampleData.id}`);
+    } catch (error: unknown) {
+      const errorMessage = error instanceof Error ? error.message : String(error);
+      console.error('Failed to save sample data:', errorMessage);
+    }
+  }
+} 

src/link-resolver/dto/create-link-resolver.dto.ts

@@ -0,0 +1,83 @@
+import {
+  IsString,
+  IsBoolean,
+  IsOptional,
+  IsArray,
+  IsObject,
+  ValidateNested,
+} from 'class-validator';
+import { Type } from 'class-transformer';
+import { Linkset, Response } from '../entities/link-resolver.entity';
+
+/**
+ * Data Transfer Object for creating a Link Resolver entry
+ */
+export class CreateLinkResolverDto {
+  @IsString()
+  namespace: string;
+
+  @IsString()
+  identificationKeyType: string;
+
+  @IsString()
+  identificationKey: string;
+
+  @IsString()
+  @IsOptional()
+  itemDescription?: string;
+
+  @IsString()
+  @IsOptional()
+  qualifierPath?: string;
+
+  @IsBoolean()
+  active: boolean;
+
+  @IsObject()
+  @ValidateNested()
+  @Type(() => Object) // We can't directly validate Linkset due to dynamic keys
+  linkset: Linkset;
+
+  @IsArray()
+  @ValidateNested({ each: true })
+  @Type(() => ResponseDto)
+  responses: Response[];
+}
+
+export class ResponseDto implements Response {
+  @IsBoolean()
+  defaultLinkType: boolean;
+
+  @IsBoolean()
+  defaultMimeType: boolean;
+
+  @IsBoolean()
+  fwqs: boolean;
+
+  @IsBoolean()
+  active: boolean;
+
+  @IsString()
+  linkType: string;
+
+  @IsString()
+  title: string;
+
+  @IsString()
+  targetUrl: string;
+
+  @IsString()
+  mimeType: string;
+
+  @IsString()
+  ianaLanguage: string;
+
+  @IsString()
+  context: string;
+
+  @IsBoolean()
+  defaultContext: boolean;
+
+  @IsBoolean()
+  defaultIanaLanguage: boolean;
+}