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: 

initialize-gs1.sh

@@ -0,0 +1,25 @@
+#!/bin/bash
+
+# Start MinIO in the background using Docker Compose
+echo "Starting MinIO..."
+docker-compose -f docker-compose.minio.yml up -d
+
+# Wait a moment for MinIO to fully initialize
+echo "Waiting for MinIO to start..."
+sleep 5
+
+# Run the GS1 initialization command
+echo "Initializing GS1 identity resolver with sample data..."
+yarn ts-node src/cli.ts --gs1 initialize-gs1
+
+echo ""
+echo "GS1 Identity Resolver has been initialized!"
+echo "You can access MinIO console at: http://localhost:9001"
+echo "Login with: minioadmin / minioadmin"
+echo "Check the gs1-identity-resolver bucket for your data"
+echo ""
+echo "To test the API, try these endpoints:"
+echo "- http://localhost:3000/gs1/products/01/12345678901234"
+echo "- http://localhost:3000/gs1/products/01/12345678901235/10/ABC123"
+echo "- http://localhost:3000/gs1/01/12345678901234 (Digital Link)"
+echo "" 

package.json

@@ -18,21 +18,29 @@
     "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",
+    "gs1:init": "ts-node src/cli.ts --gs1 initialize-gs1",
+    "gs1:start": "./initialize-gs1.sh"
   },
   "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,9 @@ 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';
+import { GS1Module } from './gs1/gs1.module';
 
 @Module({
   imports: [
@@ -14,6 +17,9 @@ import { ConfigModule } from '@nestjs/config';
     UserModule,
     TodoModule,
     PrismaModule,
+    LinkResolverModule,
+    StorageModule,
+    GS1Module,
   ],
   controllers: [AppController],
   providers: [AppService],

src/cli.ts

@@ -0,0 +1,26 @@
+import { CommandFactory } from 'nest-commander';
+import { LinkResolverCommandsModule } from './link-resolver/commands/commands.module';
+import { GS1CommandsModule } from './gs1/commands/gs1-commands.module';
+
+async function bootstrap() {
+  // To run LinkResolver commands
+  if (process.argv.includes('--link-resolver')) {
+    await CommandFactory.run(LinkResolverCommandsModule, {
+      logger: ['error', 'warn'],
+    });
+  } 
+  // To run GS1 commands
+  else if (process.argv.includes('--gs1')) {
+    await CommandFactory.run(GS1CommandsModule, {
+      logger: ['error', 'warn'],
+    });
+  }
+  // Default to LinkResolver commands for backward compatibility
+  else {
+    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/gs1/commands/gs1-commands.module.ts

@@ -0,0 +1,10 @@
+import { Module } from '@nestjs/common';
+import { GS1Module } from '../gs1.module';
+import { InitializeGS1Command } from './initialize-gs1.command';
+
+@Module({
+  imports: [GS1Module],
+  providers: [InitializeGS1Command],
+  exports: [InitializeGS1Command]
+})
+export class GS1CommandsModule {} 

src/gs1/commands/initialize-gs1.command.ts

@@ -0,0 +1,112 @@
+import { Command, CommandRunner } from 'nest-commander';
+import { Injectable, Logger } from '@nestjs/common';
+import { GS1ResolverService } from '../gs1-resolver.service';
+
+@Command({
+  name: 'initialize-gs1',
+  description: 'Initialize GS1 identity resolver with sample data',
+})
+@Injectable()
+export class InitializeGS1Command extends CommandRunner {
+  private readonly logger = new Logger(InitializeGS1Command.name);
+
+  constructor(private readonly gs1Service: GS1ResolverService) {
+    super();
+  }
+
+  async run(): Promise<void> {
+    try {
+      this.logger.log('Initializing GS1 identity resolver structure...');
+      const initialized = await this.gs1Service.initialize();
+
+      if (!initialized) {
+        this.logger.error('Failed to initialize GS1 structure');
+        return;
+      }
+
+      this.logger.log('GS1 structure initialized. Adding sample data...');
+
+      // Add sample company
+      const sampleCompanyId = 'company-12345';
+      const sampleCompany = {
+        name: 'Sample Manufacturing Co.',
+        address: '123 Industry Way, Manufacturing City',
+        contactEmail: '[email protected]',
+        website: 'https://www.samplemanufacturing.com',
+        gs1MembershipId: 'GS1-12345-XYZ'
+      };
+
+      await this.gs1Service.upsertCompany(sampleCompanyId, sampleCompany);
+      this.logger.log(`Added sample company: ${sampleCompanyId}`);
+
+      // Add sample products with GS1 Digital Link format IDs
+      const sampleProducts = [
+        {
+          id: '01/12345678901234', // GTIN format
+          name: 'Organic Apple Juice',
+          description: 'Pure organic apple juice, 100% natural ingredients',
+          companyId: sampleCompanyId,
+          category: 'Beverages',
+          attributes: {
+            organic: true,
+            servingSize: '250ml',
+            ingredients: ['organic apple juice', 'vitamin c']
+          }
+        },
+        {
+          id: '01/12345678901235/10/ABC123', // GTIN with batch/lot
+          name: 'Whole Grain Bread',
+          description: 'Nutritious whole grain bread, freshly baked',
+          companyId: sampleCompanyId,
+          category: 'Bakery',
+          attributes: {
+            wholeGrain: true,
+            weight: '500g',
+            ingredients: ['whole grain flour', 'water', 'salt', 'yeast']
+          }
+        },
+        {
+          id: '01/12345678901236/21/SERIAL9876', // GTIN with serial
+          name: 'Premium Coffee Maker',
+          description: 'Smart coffee maker with programmable features',
+          companyId: sampleCompanyId,
+          category: 'Appliances',
+          attributes: {
+            powerConsumption: '1200W',
+            warranty: '2 years',
+            color: 'stainless steel',
+            dimensions: '30x25x40cm'
+          }
+        }
+      ];
+
+      for (const product of sampleProducts) {
+        await this.gs1Service.upsertProduct(product.id, product);
+        this.logger.log(`Added sample product: ${product.id}`);
+
+        // Add a sample certificate to the last product
+        if (product.id === '01/12345678901236/21/SERIAL9876') {
+          const sampleCertificate = {
+            id: 'cert-123456',
+            name: 'Energy Efficiency Certificate',
+            issuer: 'Energy Rating Authority',
+            issuedDate: '2023-01-15',
+            expiryDate: '2025-01-15',
+            rating: 'A+',
+            documentUrl: 'https://example.com/certificates/energy-123456.pdf'
+          };
+
+          await this.gs1Service.addProductCertificate(product.id, sampleCertificate);
+          this.logger.log(`Added sample certificate to product: ${product.id}`);
+        }
+      }
+
+      this.logger.log('Sample data initialization completed successfully!');
+      this.logger.log('GS1 identity resolver is ready for use.');
+
+    } catch (error: unknown) {
+      const errorMessage = error instanceof Error ? error.message : String(error);
+      this.logger.error(`Failed to initialize GS1 with sample data: ${errorMessage}`);
+    }
+  }
+}