@silexpert/core 2.0.123-beta.0 → 2.0.123

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@silexpert/core",
-  "version": "2.0.123-beta.0",
+  "version": "2.0.123",
   "description": "Silex Core perform HTTP Request and object binding. Silex core helps developers to retrieve and return formatted object",
   "keywords": [
     "accounting",

package/ts/api/resources/zendesk/Ticket.ts

@@ -1,16 +1,17 @@
 import {
+  CountUnreadZendeskTickets,
+  CountUnreadZendeskTicketsResponse,
   CreateZendeskTicket,
   UpdateZendeskTicket,
   ListZendeskTickets,
-  TicketZendeskResponse,
-  SearchZendeskResponse,
+  ListZendeskTicketsResponse,
   TicketFormEnriched,
   TicketZendesk,
 } from '../../../index.js';
 import { Resource } from '../../Resource.js';
 
 export class ZendeskTicket extends Resource {
-  getPaginate(query: ListZendeskTickets): Promise<TicketZendeskResponse | SearchZendeskResponse> {
+  getPaginate(query: ListZendeskTickets): Promise<ListZendeskTicketsResponse> {
     return this.axios.$get('connectors/zendesk/tickets', { params: query });
   }
 
@@ -18,6 +19,10 @@ export class ZendeskTicket extends Resource {
     return this.axios.$get('connectors/zendesk/tickets/forms');
   }
 
+  getUnreadCount(query: CountUnreadZendeskTickets): Promise<CountUnreadZendeskTicketsResponse> {
+    return this.axios.$get('connectors/zendesk/tickets/unread-count', { params: query });
+  }
+
   get(id: number): Promise<TicketZendesk> {
     return this.axios.$get(`connectors/zendesk/tickets/${id}`);
   }
@@ -43,6 +48,10 @@ export class ZendeskTicket extends Resource {
     return this.axios.$put(`connectors/zendesk/tickets/${id}`, data);
   }
 
+  markAsRead(id: number): Promise<void> {
+    return this.axios.$put(`connectors/zendesk/tickets/${id}/read`);
+  }
+
   delete(id: number): Promise<void> {
     return this.axios.$delete(`connectors/zendesk/tickets/${id}`);
   }

package/ts/types/Enum/Zendesk.ts

@@ -125,3 +125,31 @@ export const ZendeskTicketCategoryList: Array<{ id: ZendeskTicketCategoryEnum; l
   { id: ZendeskTicketCategoryEnum.RELANCE_BILAN, label: 'Relance bilan' },
   { id: ZendeskTicketCategoryEnum.SUPPORT_APPLICATION, label: 'Support application' },
 ];
+
+export type ZendeskTicketStatusGroup = 'information_required' | 'in_progress' | 'received' | 'resolved' | 'closed';
+
+export enum ZendeskTicketStatusGroupEnum {
+  INFORMATION_REQUIRED = 'information_required',
+  IN_PROGRESS = 'in_progress',
+  RECEIVED = 'received',
+  RESOLVED = 'resolved',
+  CLOSED = 'closed',
+}
+
+export const ZendeskTicketStatusGroupByStatus: Record<ZendeskTicketStatusEnum, ZendeskTicketStatusGroupEnum> = {
+  [ZendeskTicketStatusEnum.NEW]: ZendeskTicketStatusGroupEnum.RECEIVED,
+  [ZendeskTicketStatusEnum.OPEN]: ZendeskTicketStatusGroupEnum.IN_PROGRESS,
+  [ZendeskTicketStatusEnum.HOLD]: ZendeskTicketStatusGroupEnum.IN_PROGRESS,
+  [ZendeskTicketStatusEnum.PENDING]: ZendeskTicketStatusGroupEnum.INFORMATION_REQUIRED,
+  [ZendeskTicketStatusEnum.SOLVED]: ZendeskTicketStatusGroupEnum.RESOLVED,
+  [ZendeskTicketStatusEnum.CLOSED]: ZendeskTicketStatusGroupEnum.CLOSED,
+};
+
+// Display order of the support page: groups needing customer action come first.
+export const ZendeskTicketStatusGroupList: Array<{ id: ZendeskTicketStatusGroupEnum; label: string }> = [
+  { id: ZendeskTicketStatusGroupEnum.INFORMATION_REQUIRED, label: 'Information requise' },
+  { id: ZendeskTicketStatusGroupEnum.IN_PROGRESS, label: 'En cours' },
+  { id: ZendeskTicketStatusGroupEnum.RECEIVED, label: 'Demande reçue' },
+  { id: ZendeskTicketStatusGroupEnum.RESOLVED, label: 'Résolu' },
+  { id: ZendeskTicketStatusGroupEnum.CLOSED, label: 'Archivé' },
+];

package/ts/types/Interface/api/zendesk/QueryTicket.ts

@@ -10,6 +10,7 @@ import {
   Min,
   Max,
   IsDateString,
+  IsBoolean,
 } from 'class-validator';
 import { ApiProperty, ApiPropertyOptional } from '@nestjs/swagger';
 import {
@@ -21,9 +22,13 @@ import {
   ZendeskTicketPriorityEnum,
   type ZendeskTicketStatus,
   ZendeskTicketStatusEnum,
+  type ZendeskTicketStatusGroup,
+  ZendeskTicketStatusGroupEnum,
   type ZendeskTicketType,
   ZendeskTicketTypeEnum,
 } from '../../../../types/Enum/Zendesk.js';
+import { ToBoolean } from '../../../../utils/transforms/boolean.transform.js';
+import { ToStringArray } from '../../../../utils/transforms/array.transform.js';
 
 export class CreateZendeskTicket {
   @ApiProperty()
@@ -193,13 +198,36 @@ export class ListZendeskTickets {
   @IsDateString()
   endDate?: string;
 
+  /**
+   * @deprecated Tickets are now sorted by status group, unread state and last public message date.
+   * Only `sortOrder` is taken into account.
+   */
   @ApiPropertyOptional()
   @IsOptional()
   @IsString()
   sortBy?: string;
 
-  @ApiPropertyOptional()
+  @ApiPropertyOptional({ description: 'Order applied to the last public message date' })
   @IsOptional()
   @IsEnum(['asc', 'desc'])
   sortOrder?: 'asc' | 'desc';
+
+  @ApiPropertyOptional({ enum: ZendeskTicketStatusGroupEnum, isArray: true })
+  @IsOptional()
+  @ToStringArray()
+  @IsArray()
+  @IsEnum(ZendeskTicketStatusGroupEnum, { each: true })
+  statusGroups?: ZendeskTicketStatusGroup[];
+
+  @ApiPropertyOptional()
+  @IsOptional()
+  @ToBoolean()
+  @IsBoolean()
+  isUnread?: boolean;
+}
+
+export class CountUnreadZendeskTickets {
+  @ApiProperty()
+  @IsEnum(ZendeskTicketChannelEnum)
+  channel: ZendeskTicketChannel;
 }

package/ts/types/Interface/api/zendesk/ReadTicket.ts

@@ -2,8 +2,10 @@ import {
   ZendeskTicketChannel,
   ZendeskTicketPriority,
   ZendeskTicketStatus,
+  ZendeskTicketStatusGroup,
   ZendeskTicketType,
 } from '../../../Enum/Zendesk.js';
+import type { BasePaginate } from '../BasePaginate.js';
 
 export interface TicketZendesk {
   id: number;
@@ -22,6 +24,19 @@ export interface TicketZendesk {
   organizationId: number | null;
   createdAt: string;
   updatedAt: string;
+  // Read-tracking data, only computed on the paginated list
+  statusGroup?: ZendeskTicketStatusGroup;
+  isUnread?: boolean;
+  lastActivityAt?: string;
+}
+
+export interface ListZendeskTicketsResponse extends BasePaginate<TicketZendesk> {
+  // Unread tickets of the channel whatever the filters, to refresh the unread badge with the list.
+  unreadCount: number;
+}
+
+export interface CountUnreadZendeskTicketsResponse {
+  count: number;
 }
 
 export interface SearchZendeskResponse {

package/ts/types/Interface/models/IApiError.ts

@@ -23,6 +23,7 @@ export enum Code {
   CONNECTION_ALREADY_EXIST = 'connection_already_exist',
   firstConnectionFromVpn = 'first_connection_from_vpn',
   ENTITY_ALREADY_EXIST = 'entity_already_exist',
+  tooManyRequest = 'too_many_requests',
 
   // Annotation Error
   failedCheckBalance = 'failed_check_balance',

package/ts/types/Interface/models/IZendeskTicketRead.ts

@@ -0,0 +1,15 @@
+import type { IUser } from './IUser.js';
+
+export interface IZendeskTicketRead {
+  id?: number;
+  idUser: number;
+  idTicket: number;
+  readAt?: Date | null;
+  // Activity snapshot of the Zendesk ticket, refreshed only when `ticketUpdatedAt` changes
+  ticketUpdatedAt?: Date | null;
+  lastPublicCommentAt?: Date | null;
+  lastSupportCommentAt?: Date | null;
+  createdAt?: Date;
+  updatedAt?: Date;
+  user?: IUser;
+}

package/ts/types/index.ts

@@ -290,6 +290,7 @@ export * from './Interface/models/IRevenueSnapshot.js';
 export * from './Interface/models/IEInvoicingEligibilityRequest.js';
 export * from './Interface/models/IUsersHistory.js';
 export * from './Interface/api/teamSystemSignature/index.js';
+export * from './Interface/models/IZendeskTicketRead.js';
 export * from './Interface/models/IEInvoicingKycAndMandate.js';
 export * from './Interface/models/IConnectorTracking.js';
 export * from './Interface/models/IEInvoicing.js';

package/ts/utils/commercialManagement/document.ts

@@ -171,28 +171,85 @@ export function generateCommercialDocument(
     : payload?.settings?.freeInvoiceText;
 
   return {
-    header: ejs.render(commonTemplate.header, data),
-    body: ejs.render(bodyTemplate, {
-      ...data,
-      comment:
-        data.comment && typeof data.comment === 'string'
-          ? sanitize(data.comment?.replace(/\n/g, '<br/>'), { allowedTags: ['b', 'i', 'em', 'br', 'strong'] })
-          : null,
-      products: data.products.map((p) => ({
-        ...p,
+    header: ejs.render(commonTemplate.header, data, {}),
+    body: ejs.render(
+      bodyTemplate,
+      {
+        ...data,
+        cgv:
+          data.cgv && typeof data.cgv === 'string'
+            ? sanitize(data.cgv, {
+                allowedTags: [
+                  'b',
+                  'i',
+                  'em',
+                  'br',
+                  'strong',
+                  'p',
+                  'span',
+                  'li',
+                  'ul',
+                  'ol',
+                  'h1',
+                  'h2',
+                  'h3',
+                  'u',
+                  's',
+                  'a',
+                  'blockquote',
+                ],
+                allowedAttributes: {
+                  a: ['href', 'name', 'target', 'data-list'],
+                  li: ['data-list'],
+                  '*': ['class', 'style', 'dir'],
+                },
+                allowedClasses: {
+                  '*': [/^ql-/],
+                },
+                allowedStyles: {
+                  '*': {
+                    color: [/^[a-z]+$/i, /^#(?:[0-9a-f]{3}){1,2}$/i, /^rgb\(\s*\d+\s*,\s*\d+\s*,\s*\d+\s*\)$/i],
+                    'background-color': [
+                      /^[a-z]+$/i,
+                      /^#(?:[0-9a-f]{3}){1,2}$/i,
+                      /^rgb\(\s*\d+\s*,\s*\d+\s*,\s*\d+\s*\)$/i,
+                    ],
+                    'text-align': [/^left$/i, /^right$/i, /^center$/i, /^justify$/i],
+                    'white-space': [/^pre-wrap$/i],
+                  },
+                },
+              })
+            : null,
         comment:
-          p.comment && typeof p.comment === 'string'
-            ? sanitize(p.comment?.replace(/\n/g, '<br/>'), { allowedTags: ['b', 'i', 'em', 'br', 'strong'] })
+          data.comment && typeof data.comment === 'string'
+            ? sanitize(data.comment?.replace(/\n/g, '<br/>'), { allowedTags: ['b', 'i', 'em', 'br', 'strong'] })
             : null,
-        // @ts-expect-error
-        unitFormatted: internationalizationConsistency(locale, p.unitFormatted, 'unit'),
-      })),
-      vats: forcedVats ?? vats,
-    }),
-    footer: ejs.render(commonTemplate.footer, {
-      ...data,
-      freeText: documentFreeText ?? null,
-    }),
+        products: data.products.map((p) => ({
+          ...p,
+          comment:
+            p.comment && typeof p.comment === 'string'
+              ? sanitize(p.comment?.replace(/\n/g, '<br/>'), { allowedTags: ['b', 'i', 'em', 'br', 'strong'] })
+              : null,
+          // @ts-expect-error
+          unitFormatted: internationalizationConsistency(locale, p.unitFormatted, 'unit'),
+        })),
+        vats: forcedVats ?? vats,
+      },
+      {},
+    ),
+    footer: ejs.render(
+      commonTemplate.footer,
+      {
+        ...data,
+        freeText:
+          documentFreeText && typeof documentFreeText === 'string'
+            ? sanitize(documentFreeText?.replace(/\n/g, '<br/>'), {
+                allowedTags: ['b', 'i', 'em', 'br', 'strong', 'p'],
+              })
+            : null,
+      },
+      {},
+    ),
     data,
   };
 }
@@ -227,7 +284,7 @@ export function generateMailHeader(
   const mailTemplate = new CommercialDocumentMailHTML();
 
   return {
-    header: ejs.render(mailTemplate.header, data),
+    header: ejs.render(mailTemplate.header, data, {}),
   };
 }
 

package/ts/utils/commercialManagement/templates/common.ts

@@ -334,7 +334,7 @@ export class CommercialDocumentMailHTML {
   </style>
   <div style="background-color: <%= brandColors.primary50 %> !important; color: black; width: calc(100% - 48px); display: grid; border-radius: 16px; padding: 24px;">
     <div style="width: max-content; margin: auto; font-size: 16px; font-family: 'circular std', sans-serif; font-weight: 100; line-height: 140%; position: relative;">
-      <div style="color: black;"><span style="font-weight: 500;"><%- companyName %></span> <%= languageMail.mail.common.send %> 
+      <div style="color: black;"><span style="font-weight: 500;"><%= companyName %></span> <%= languageMail.mail.common.send %> 
       <% if(idEstimateInvoiceType) { %>
         <% if ([${EstimateInvoiceType.FACTURE}, ${EstimateInvoiceType.RESTE}].includes(idEstimateInvoiceType)) { %>
           <%= languageMail.mail.invoice.title %>
@@ -370,7 +370,7 @@ export class CommercialDocumentMailHTML {
             <% } else { %> 
               <%= languageMail.mail.default.subTitle %>
             <% } %>
-            <%- reference %>
+            <%= reference %>
           </div>
           <div style="; color: <%= brandColors.primary500 %>; font-size: 14px;">
             <%= languageMail.mail.common.dueDate %> : <%- dueDateFormatted %>

package/ts/utils/email.ts

@@ -366,25 +366,30 @@ export function generateSignature(params: any): string {
     user.calendlyUrl = calendlyUrl;
   }
 
-  return ejs.render(signatureTemplate, {
-    forceRole,
-    isFacturation: user.roles ? user.roles.some((r: any) => r.id === Role.FACTURATION) : false,
-    isDataOfficer: user.roles ? user.roles.some((r: any) => r.id === Role.DATA_OFFICER) : true,
-    brandName,
-    brandPostalAddress,
-    brandCity,
-    idTypeBrand,
-    commercialName,
-    iban,
-    bic,
-    hostS3,
-    user,
-    roleSignature,
-    mailSignature,
-    phoneSignature: commercialName !== 'Comptalib' && phoneSignature ? phoneSignature.replace(/\s+/gm, ' ') : null,
-    standardPhoneSignature: commercialName !== 'Comptalib' ? standardPhoneSignature.replace(/\s+/gm, ' ') : null,
-    horaires,
-    primaryColor,
-    supportMail,
-  });
+  return ejs.render(
+    signatureTemplate,
+    {
+      forceRole,
+      isFacturation: user.roles ? user.roles.some((r: any) => r.id === Role.FACTURATION) : false,
+      isDataOfficer: user.roles ? user.roles.some((r: any) => r.id === Role.DATA_OFFICER) : true,
+      brandName,
+      brandPostalAddress,
+      brandCity,
+      idTypeBrand,
+      commercialName,
+      iban,
+      bic,
+      hostS3,
+      user,
+      roleSignature,
+      mailSignature,
+      phoneSignature:
+        commercialName !== 'Comptalib' && phoneSignature ? phoneSignature.replace(/\s+/gm, ' ') : null,
+      standardPhoneSignature: commercialName !== 'Comptalib' ? standardPhoneSignature.replace(/\s+/gm, ' ') : null,
+      horaires,
+      primaryColor,
+      supportMail,
+    },
+    {},
+  );
 }

package/ts/utils/tests/document.spec.ts

@@ -24,7 +24,7 @@ const payloadWithoutSellerAddress = {
   reference: '202609/94',
   capital: 0,
   isDraft: false,
-  cgv: '<p><br></p>',
+  cgv: '<p>Test avec une liste</p><ol><li data-list="bullet"><span class="ql-ui"></span>1</li><li data-list="bullet"><span class="ql-ui"></span>2</li></ol></p>',
   logoUrl: null,
   disableVat: false,
   nafCode: null,
@@ -94,7 +94,8 @@ describe('generateCommercialDocument', () => {
   test.each([true, false])(
     'should render CGV HTML only when invoiceCgv is enabled (%s)',
     (invoiceCgv: boolean): void => {
-      const cgv = '<p>Conditions de vente <strong>applicables</strong></p>';
+      const cgv =
+        '<p>Test avec une liste</p><ol><li data-list="bullet"><span class="ql-ui"></span>1</li><li data-list="bullet"><span class="ql-ui"></span>2</li></ol>';
       const payload: CreateInvoiceDocument = {
         ...payloadWithoutSellerAddress,
         cgv,

package/ts/utils/transforms/array.transform.ts

@@ -0,0 +1,35 @@
+import { Transform } from 'class-transformer';
+
+const valueToStringArray = (value: any) => {
+  if (value === null || value === undefined || value === '') {
+    return undefined;
+  }
+  if (Array.isArray(value)) {
+    return value.map((v) => String(v).trim());
+  }
+  return String(value)
+    .split(',')
+    .map((v) => v.trim())
+    .filter((v) => v !== '');
+};
+
+// Accepts repeated query params (`a=x&a=y`) as well as comma-separated values (`a=x,y`).
+const ToStringArray = () => {
+  const toPlain = Transform(
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-return
+    ({ value }) => value,
+    {
+      toPlainOnly: true,
+    },
+  );
+  const toClass = (target: any, key: string) =>
+    Transform(({ obj }) => valueToStringArray(obj[key]), {
+      toClassOnly: true,
+    })(target, key);
+  return (target: any, key: string) => {
+    toPlain(target, key);
+    toClass(target, key);
+  };
+};
+
+export { ToStringArray };