feature/list blocks update with initialFilters option

.changeset/common-brooms-search.md

@@ -0,0 +1,11 @@
+---
+'@o2s/blocks.notification-list': minor
+'@o2s/integrations.strapi-cms': minor
+'@o2s/blocks.invoice-list': minor
+'@o2s/integrations.mocked': minor
+'@o2s/blocks.ticket-list': minor
+'@o2s/blocks.order-list': minor
+'@o2s/framework': minor
+---
+
+adding initial filters support to list blocks

packages/blocks/invoice-list/src/api-harmonization/invoice-list.mapper.ts

@@ -27,6 +27,7 @@ export const mapInvoiceList = (
         },
         downloadFileName: cms.downloadFileName,
         downloadButtonAriaDescription: cms.downloadButtonAriaDescription,
+        initialFilters: cms.initialFilters,
     };
 };
 

packages/blocks/invoice-list/src/api-harmonization/invoice-list.model.ts

@@ -23,6 +23,7 @@ export class InvoiceListBlock extends ApiModels.Block.Block {
     };
     downloadFileName?: string;
     downloadButtonAriaDescription?: string;
+    initialFilters?: Partial<Invoices.Model.Invoice & { sort?: string }>;
 }
 
 export class Invoice {

packages/blocks/invoice-list/src/api-harmonization/invoice-list.service.ts

@@ -25,8 +25,11 @@ export class InvoiceListService {
             concatMap(([cms]) => {
                 return this.invoiceService
                     .getInvoiceList({
+                        ...(cms.initialFilters || {}),
                         ...query,
-                        limit: cms.pagination?.limit || query.limit,
+                        limit: query.limit || cms.pagination?.limit || 1,
+                        offset: query.offset || 0,
+                        locale: headers['x-locale'],
                     })
                     .pipe(
                         map((invoices) =>

packages/blocks/notification-list/src/api-harmonization/notification-list.mapper.ts

@@ -24,6 +24,7 @@ export const mapNotificationList = (
             total: notifications.total,
             data: notifications.data.map((notification) => mapNotification(notification, cms, locale, timezone)),
         },
+        initialFilters: cms.initialFilters,
     };
 };
 

packages/blocks/notification-list/src/api-harmonization/notification-list.model.ts

@@ -19,6 +19,7 @@ export class NotificationListBlock extends ApiModels.Block.Block {
         data: Notification[];
         total: Notifications.Model.Notifications['total'];
     };
+    initialFilters?: Partial<Notifications.Model.Notification & { sort?: string }>;
 }
 
 export class Notification {

packages/blocks/notification-list/src/api-harmonization/notification-list.service.ts

@@ -25,6 +25,7 @@ export class NotificationListService {
             concatMap(([cms]) => {
                 return this.notificationService
                     .getNotificationList({
+                        ...(cms.initialFilters || {}),
                         ...query,
                         limit: query.limit || cms.pagination?.limit || 1,
                         offset: query.offset || 0,

packages/blocks/order-list/src/api-harmonization/order-list.mapper.ts

@@ -26,6 +26,7 @@ export const mapOrderList = (
         pagination: cms.pagination,
         labels: cms.labels,
         reorderLabel: cms.reorderLabel,
+        initialFilters: cms.initialFilters,
     };
 };
 

packages/blocks/order-list/src/api-harmonization/order-list.model.ts

@@ -24,6 +24,7 @@ export class OrderListBlock extends ApiModels.Block.Block {
         clickToSelect: string;
     };
     reorderLabel?: string;
+    initialFilters?: Partial<Orders.Model.Order & { sort?: string }>;
 }
 
 export class Order {

packages/blocks/order-list/src/api-harmonization/order-list.service.ts

@@ -26,6 +26,7 @@ export class OrderListService {
                 return this.orderService
                     .getOrderList(
                         {
+                            ...(cms.initialFilters || {}),
                             ...query,
                             limit: query.limit || cms.pagination?.limit || 1,
                             offset: query.offset || 0,

packages/blocks/ticket-list/src/api-harmonization/ticket-list.mapper.ts

@@ -26,6 +26,7 @@ export const mapTicketList = (
         },
         forms: cms.forms,
         labels: cms.labels,
+        initialFilters: cms.initialFilters,
     };
 };
 

packages/blocks/ticket-list/src/api-harmonization/ticket-list.model.ts

@@ -24,6 +24,7 @@ export class TicketListBlock extends ApiModels.Block.Block {
         showMore: string;
         clickToSelect: string;
     };
+    initialFilters?: Partial<Tickets.Model.Ticket & { sort?: string }>;
 }
 
 export class Ticket {

packages/blocks/ticket-list/src/api-harmonization/ticket-list.service.ts

@@ -25,6 +25,7 @@ export class TicketListService {
             concatMap(([cms]) => {
                 return this.ticketService
                     .getTicketList({
+                        ...(cms.initialFilters || {}),
                         ...query,
                         limit: query.limit || cms.pagination?.limit || 1,
                         offset: query.offset || 0,

packages/framework/src/modules/cms/models/blocks/invoice-list.model.ts

@@ -20,4 +20,5 @@ export class InvoiceListBlock extends Block.Block {
         clickToSelect: string;
     };
     downloadButtonAriaDescription?: string;
+    initialFilters?: Partial<Invoice & { sort?: string }>;
 }

packages/framework/src/modules/cms/models/blocks/notification-list.model.ts

@@ -19,4 +19,5 @@ export class NotificationListBlock extends Block.Block {
         clickToSelect: string;
     };
     detailsUrl!: string;
+    initialFilters?: Partial<Notification & { sort?: string }>;
 }

packages/framework/src/modules/cms/models/blocks/order-list.model.ts

@@ -21,4 +21,5 @@ export class OrderListBlock extends Block.Block {
     };
     reorderLabel?: string;
     detailsUrl!: string;
+    initialFilters?: Partial<Order & { sort?: string }>;
 }

packages/framework/src/modules/cms/models/blocks/ticket-list.model.ts

@@ -22,4 +22,5 @@ export class TicketListBlock extends Block.Block {
     };
     detailsUrl!: string;
     forms?: Link[];
+    initialFilters?: Partial<Ticket & { sort?: string }>;
 }

packages/framework/src/modules/invoices/invoices.request.ts

@@ -12,4 +12,5 @@ export class GetInvoiceListQuery extends PaginationQuery {
     dateTo?: Date;
     sort?: string;
     search?: string;
+    locale?: string;
 }

packages/integrations/mocked/src/modules/cms/mappers/blocks/cms.notification-list.mapper.ts

@@ -98,10 +98,10 @@ const MOCK_NOTIFICATION_LIST_BLOCK_EN: CMS.Model.NotificationListBlock.Notificat
                 label: 'Priority',
                 allowMultiple: true,
                 options: [
-                    { label: 'Low Priority', value: 'low' },
-                    { label: 'Medium Priority', value: 'medium' },
-                    { label: 'High Priority', value: 'high' },
-                    { label: 'Critical Priority', value: 'critical' },
+                    { label: 'Low Priority', value: 'LOW' },
+                    { label: 'Medium Priority', value: 'MEDIUM' },
+                    { label: 'High Priority', value: 'HIGH' },
+                    { label: 'Critical Priority', value: 'CRITICAL' },
                 ],
             },
             {

packages/integrations/strapi-cms/src/modules/cms/mappers/blocks/cms.invoice-list.mapper.ts

@@ -38,6 +38,7 @@ export const mapInvoiceListBlock = (data: GetComponentQuery): CMS.Model.InvoiceL
                 table: mapTable(component.table),
                 downloadFileName: component.downloadFileName,
                 downloadButtonAriaDescription: component.downloadButtonAriaDescription,
+                initialFilters: undefined, // TODO: add initial filters field in CMS
             };
     }
 

packages/integrations/strapi-cms/src/modules/cms/mappers/blocks/cms.notification-list.mapper.ts

@@ -39,6 +39,7 @@ export const mapNotificationListBlock = (
                     clickToSelect: configurableTexts.actions.clickToSelect,
                 },
                 detailsUrl: component.detailsURL as string,
+                initialFilters: undefined, // TODO: add initial filters field in CMS
             };
     }
 

packages/integrations/strapi-cms/src/modules/cms/mappers/blocks/cms.order-list.mapper.ts

@@ -39,6 +39,7 @@ export const mapOrderListBlock = (data: GetComponentQuery): CMS.Model.OrderListB
                 },
                 reorderLabel: component.reorderLabel,
                 detailsUrl: component.detailsURL as string,
+                initialFilters: undefined, // TODO: add initial filters field in CMS
             };
     }
 

packages/integrations/strapi-cms/src/modules/cms/mappers/blocks/cms.ticket-list.mapper.ts

@@ -40,6 +40,7 @@ export const mapTicketListBlock = (data: GetComponentQuery): CMS.Model.TicketLis
                     clickToSelect: configurableTexts.actions.clickToSelect,
                 },
                 detailsUrl: component.detailsURL as string,
+                initialFilters: undefined, // TODO: add initial filters field in CMS
             };
     }