feat: Search integration with Algolia (#25)

feat: Search integration with Algolia

Author: Shriz07

.changeset/lucky-walls-warn.md

@@ -0,0 +1,9 @@
+---
+'@o2s/integrations.strapi-cms': minor
+'@o2s/integrations.algolia': minor
+'@o2s/integrations.mocked': minor
+'@o2s/api-harmonization': minor
+'@o2s/framework': minor
+---
+
+Added search integration with Algolia

apps/api-harmonization/.env.local

@@ -26,3 +26,6 @@ CACHE_REDIS_HOST=localhost
 CACHE_REDIS_PORT=6379
 # redis-cli -> config set requirepass {REDIS_PASS}
 CACHE_REDIS_PASS={REDIS_PASS}
+
+ALGOLIA_APP_ID=
+ALGOLIA_API_KEY=

apps/api-harmonization/package.json

@@ -24,6 +24,7 @@
         "@o2s/integrations.mocked": "*",
         "@o2s/integrations.redis": "*",
         "@o2s/integrations.strapi-cms": "*",
+        "@o2s/integrations.algolia": "*",
         "@o2s/utils.logger": "*",
         "@nestjs/axios": "^3.1.2",
         "@nestjs/common": "^10.0.0",

apps/api-harmonization/src/app.config.ts

@@ -8,6 +8,7 @@ import { InvoicesIntegrationConfig } from '@o2s/api-harmonization/models/invoice
 import { NotificationsIntegrationConfig } from '@o2s/api-harmonization/models/notifications';
 import { OrganizationsIntegrationConfig } from '@o2s/api-harmonization/models/organizations';
 import { ResourcesIntegrationConfig } from '@o2s/api-harmonization/models/resources';
+import { SearchIntegrationConfig } from '@o2s/api-harmonization/models/search';
 import { TicketsIntegrationConfig } from '@o2s/api-harmonization/models/tickets';
 import { UsersIntegrationConfig } from '@o2s/api-harmonization/models/users';
 
@@ -23,5 +24,6 @@ export const AppConfig: ApiConfig = {
         cms: CmsIntegrationConfig,
         cache: CacheIntegrationConfig,
         billingAccounts: BillingAccountsIntegrationConfig,
+        search: SearchIntegrationConfig,
     },
 };

apps/api-harmonization/src/app.module.ts

@@ -14,6 +14,7 @@ import {
     Notifications,
     Organizations,
     Resources,
+    Search,
     Tickets,
     Users,
 } from '@o2s/framework/modules';
@@ -52,13 +53,18 @@ import { RoutesModule } from './modules/routes/routes.module';
             ignoreEnvFile: process.env.NODE_ENV !== 'development',
             envFilePath: `.env.local`,
         }),
+
         CMS.Module.register(AppConfig),
         Tickets.Module.register(AppConfig),
         Notifications.Module.register(AppConfig),
         Users.Module.register(AppConfig),
         Organizations.Module.register(AppConfig),
         Cache.Module.register(AppConfig),
         BillingAccounts.Module.register(AppConfig),
+        Resources.Module.register(AppConfig),
+        Invoices.Module.register(AppConfig),
+        Articles.Module.register(AppConfig),
+        Search.Module.register(AppConfig),
 
         PageModule.register(AppConfig),
         RoutesModule.register(AppConfig),
@@ -70,11 +76,8 @@ import { RoutesModule } from './modules/routes/routes.module';
         NotificationListComponentModule.register(AppConfig),
         NotificationDetailsComponentModule.register(AppConfig),
         FaqComponentModule.register(AppConfig),
-        Articles.Module.register(AppConfig),
         ArticleDetailsComponentModule.register(AppConfig),
         ArticleListComponentModule.register(AppConfig),
-        Resources.Module.register(AppConfig),
-        Invoices.Module.register(AppConfig),
         InvoiceListComponentModule.register(AppConfig),
         PaymentsSummaryComponentModule.register(AppConfig),
         PaymentsHistoryComponentModule.register(AppConfig),

apps/api-harmonization/src/components/article-details/article-details.module.ts

@@ -1,7 +1,7 @@
 import { DynamicModule, Module } from '@nestjs/common';
 import { Type } from '@nestjs/common/interfaces/type.interface';
 
-import { ApiConfig, Articles, CMS } from '@o2s/framework/modules';
+import { ApiConfig, Articles, CMS, Search } from '@o2s/framework/modules';
 
 import { ArticleDetailsController } from './article-details.controller';
 import { ArticleDetailsService } from './article-details.service';
@@ -11,6 +11,7 @@ export class ArticleDetailsComponentModule {
     static register(config: ApiConfig): DynamicModule {
         const cmsService = config.integrations.cms.service;
         const articleService = config.integrations.articles.service;
+        const searchService = config.integrations.search.service;
 
         return {
             module: ArticleDetailsComponentModule,
@@ -24,6 +25,10 @@ export class ArticleDetailsComponentModule {
                     provide: Articles.Service,
                     useClass: articleService as Type,
                 },
+                {
+                    provide: Search.Service,
+                    useClass: searchService as Type,
+                },
             ],
             controllers: [ArticleDetailsController],
             exports: [ArticleDetailsService],

apps/api-harmonization/src/components/article-details/article-details.request.ts

@@ -4,6 +4,6 @@ export class GetArticleDetailsComponentQuery implements Omit<CMS.Request.GetCmsE
     id!: string;
 }
 
-export class GetArticleDetailsComponentParams implements Articles.Request.GetArticleParams {
+export class GetArticleDetailsComponentParams implements Omit<Articles.Request.GetArticleParams, 'locale'> {
     id!: string;
 }

apps/api-harmonization/src/components/article-details/article-details.service.ts

@@ -22,7 +22,7 @@ export class ArticleDetailsService {
         headers: AppHeaders,
     ): Observable<ArticleDetailsComponent> {
         const cms = this.cmsService.getArticleDetailsComponent({ ...query, locale: headers['x-locale'] });
-        const article = this.articleService.getArticle(params);
+        const article = this.articleService.getArticle({ ...params, locale: headers['x-locale'] });
 
         return forkJoin([article, cms]).pipe(
             map(([article, cms]) => {

apps/api-harmonization/src/components/article-list/article-list.controller.ts

@@ -1,10 +1,10 @@
-import { Controller, Get, Headers, Query, UseInterceptors } from '@nestjs/common';
+import { Body, Controller, Get, Headers, Query, UseInterceptors } from '@nestjs/common';
 import { LoggerService } from '@o2s/utils.logger';
 
 import { AppHeaders } from '@o2s/api-harmonization/utils/headers';
 
 import { URL } from './';
-import { GetArticleListComponentQuery } from './article-list.request';
+import { GetArticleListComponentBody, GetArticleListComponentQuery } from './article-list.request';
 import { ArticleListService } from './article-list.service';
 
 @Controller(URL)
@@ -13,7 +13,11 @@ export class ArticleListController {
     constructor(protected readonly service: ArticleListService) {}
 
     @Get()
-    getArticleListComponent(@Headers() headers: AppHeaders, @Query() query: GetArticleListComponentQuery) {
-        return this.service.getArticleListComponent(query, headers);
+    getArticleListComponent(
+        @Headers() headers: AppHeaders,
+        @Query() query: GetArticleListComponentQuery,
+        @Body() body: GetArticleListComponentBody,
+    ) {
+        return this.service.getArticleListComponent(query, headers, body);
     }
 }

apps/api-harmonization/src/components/article-list/article-list.mapper.ts

@@ -35,5 +35,9 @@ const mapArticle = (
         title: article.title,
         createdAt: formatDateRelative(article.createdAt, locale, cms.labels.today, cms.labels.yesterday),
         updatedAt: formatDateRelative(article.updatedAt, locale, cms.labels.today, cms.labels.yesterday),
+        category: {
+            label: cms.fieldMapping.category?.[article.category] || article.category,
+            value: article.category,
+        },
     };
 };