Add image urls output to products and inventory items

Author: MrBartusek

apps/api/src/helpers/dtoHelpers.ts

@@ -0,0 +1,9 @@
+import Utils from './utils';
+
+class DtoHelpers {
+	public static getImageUrl(key?: string): string {
+		return Utils.getApiBaseUrl() + `images/${key || 'default'}`;
+	}
+}
+
+export default DtoHelpers;

apps/api/src/helpers/utils.ts

@@ -10,7 +10,7 @@ class Utils {
 		return NODE_ENV == 'production';
 	}
 
-	public static getApiBaseUrl(req?: Request): string {
+	public static getApiBaseUrl(): string {
 		const API_BASE_URL_REGEX = /^https?:\/\/.*api\/?$/;
 		if (BASE_API_URL) {
 			const isValid = API_BASE_URL_REGEX.test(BASE_API_URL);
@@ -20,13 +20,10 @@ class Utils {
 			return BASE_API_URL.endsWith('/') ? BASE_API_URL : BASE_API_URL + '/';
 		}
 
-		if (!req) {
-			logger.error('BASE_API_URL have not been provided. Failed to retrieve absolute base URL');
-			return '/api';
-		}
+		if (!Utils.isProduction()) return 'http://localhost:5173/api/';
 
-		logger.warn('BASE_API_URL have not been provided. Please update your .env file');
-		return `${req.protocol}://${req.get('Host')}/api/`;
+		logger.error('BASE_API_URL have not been provided. Failed to retrieve absolute base URL');
+		return '/api';
 	}
 
 	public static get schemaSerializerHelper(): SchemaOptions {

apps/api/src/models/inventory/schemas/inventory-item.schema.ts

@@ -3,6 +3,7 @@ import mongoose, { HydratedDocument } from 'mongoose';
 import { BasicInventoryItemDto, InventoryItemDto } from 'shared-types';
 import { ProductDocument } from '../../products/schemas/product.schema';
 import { Warehouse } from '../../warehouses/schemas/warehouse.schema';
+import DtoHelpers from '../../../helpers/dtoHelpers';
 
 export type InventoryItemDocument = HydratedDocument<InventoryItem>;
 
@@ -26,6 +27,7 @@ export class InventoryItem {
 		return {
 			id: document._id,
 			productId: isProductMongoId ? (document.product as any) : document.product._id.toString(),
+			image: DtoHelpers.getImageUrl(document.product.imageKey),
 			name: document.product.name,
 			quantity: document.quantity,
 			unit: document.product.unit,

apps/api/src/models/products/schemas/product.schema.ts

@@ -2,6 +2,7 @@ import { Prop, Schema, SchemaFactory } from '@nestjs/mongoose';
 import mongoose, { HydratedDocument } from 'mongoose';
 import { BasicProductDto, ProductDto } from 'shared-types';
 import { Organization } from '../../organizations/schemas/organization.schema';
+import DtoHelpers from '../../../helpers/dtoHelpers';
 
 export type ProductDocument = HydratedDocument<Product>;
 
@@ -13,6 +14,9 @@ export class Product {
 	@Prop({ required: true, index: 'text' })
 	name: string;
 
+	@Prop()
+	imageKey: string;
+
 	@Prop()
 	description: string;
 
@@ -32,6 +36,7 @@ export class Product {
 		return {
 			id: document._id,
 			name: document.name,
+			image: DtoHelpers.getImageUrl(document.imageKey),
 			buyPrice: document.buyPrice,
 			sellPrice: document.sellPrice,
 			unit: document.unit,

packages/shared-types/src/inventory/BasicInventoryItemDto.ts

@@ -3,6 +3,7 @@ import { BaseDto } from "../BaseDto";
 export class BasicInventoryItemDto extends BaseDto {
     productId: string;
     name: string;
+    image: string;
     quantity: number;
     unit: string;
 }

packages/shared-types/src/product/BasicProductDto.ts

@@ -2,6 +2,7 @@ import { BaseDto } from "../BaseDto";
 
 export class BasicProductDto extends BaseDto {
     name: string;
+    image: string;
     buyPrice: number;
     sellPrice: number;
     unit?: string;