@silexpert/core 2.0.126 → 2.0.127-beta.0

package/ts/utils/commercialManagement/document.ts

@@ -1,435 +0,0 @@
-import dayjs from 'dayjs';
-import ejs from 'ejs';
-import { orderBy, groupBy, sumBy, round, uniq } from 'lodash-es';
-import sanitize from 'sanitize-html';
-import {
-  AccountingCategoryList,
-  CommercialVatMentionList,
-  FontIds,
-  fontList,
-  InvoiceLanguage,
-} from '../../types/Enum/CommercialManagement.js';
-import { EstimateInvoiceType } from '../../types/Enum/EstimateInvoice.js';
-import { Vat } from '../../types/Enum/Vat.js';
-import {
-  CreateInvoiceDocument,
-  CreateMailHeader,
-  CreatePreSaleDocument,
-  ReadCommercialMailTemplate,
-} from '../../types/index.js';
-import {
-  ReadCommercialDocumentTemplate,
-  ReadDocumentEditing,
-  ReadVatEditing,
-} from '../../types/Interface/api/commercialManagement/Read.js';
-import { integerToFormattedAmountString, integerToFormattedAmountObject } from '../amount.js';
-import { getBrandConfig } from '../brands.js';
-import { isHtmlEmpty } from '../isHtml.js';
-import { internationalizationChoices, internationalizationConsistency } from './internationalization/choices.js';
-import { productToReadProductEditing } from './product.js';
-import { bodyTemplate } from './templates/body.js';
-import 'dayjs/locale/fr.js';
-import { CommercialDocumentCommonHTML, CommercialDocumentMailHTML } from './templates/common.js';
-import { thirdPartyToReadThirdPartyEditing } from './thirdParty.js';
-import { getById, vatToReadVatEditing } from './vat.js';
-
-type brandColorType = {
-  primary: string;
-  primary50: string;
-  primary100: string;
-  primary300: string;
-  primary500: string;
-  primary700: string;
-};
-
-export function generateCommercialDocument(
-  idEstimateInvoiceType: EstimateInvoiceType,
-  payload: CreateInvoiceDocument | CreatePreSaleDocument,
-  shouldHideBrandName = false,
-  nodeEnv: string | undefined = undefined,
-): ReadCommercialDocumentTemplate {
-  const products = orderBy(payload.products.map((product) => productToReadProductEditing(product), 'reorder'));
-  const vats = orderBy(
-    Object.values(groupBy(products, 'vatFormatted')).map((v) => vatToReadVatEditing(v), 'value'),
-  ).filter((v) => v.id !== Vat.MARGE.id);
-
-  const thirdParty = thirdPartyToReadThirdPartyEditing(payload.thirdParty);
-
-  let forcedVats: ReadVatEditing[] | undefined = undefined;
-
-  if (payload.advanceProducts?.length) {
-    const advanceVats = Object.values(groupBy(payload.advanceProducts, 'vatFormatted'))
-      .map((v) => vatToReadVatEditing(v), 'value')
-      .filter((v) => v.id !== Vat.MARGE.id);
-
-    forcedVats = vats.map((v) => {
-      const base = v.base - (advanceVats.find((a) => a.id === v.id)?.base ?? 0);
-      const toPay = v.toPay - (advanceVats.find((a) => a.id === v.id)?.toPay ?? 0);
-      return {
-        ...v,
-        baseFormatted: integerToFormattedAmountString(base),
-        amountFormatted: integerToFormattedAmountString(toPay),
-      };
-    });
-  }
-
-  const totalVats = sumBy(vats, (v) => round(v.amount));
-  const totalTaxExcluded = sumBy(products, 'totalTaxExcludedRounded');
-
-  const totalTaxIncluded = totalTaxExcluded + totalVats;
-
-  const locale = payload.language ?? InvoiceLanguage.FR;
-  const languageOption = internationalizationChoices[locale];
-
-  const accountingCategory = AccountingCategoryList.find((a) => a.id === payload.accountingCategory)?.label ?? null;
-
-  const recoveryCost = payload.recoveryCost;
-  const data: ReadDocumentEditing & { brandColors: brandColorType; brandName: string; shouldHideBrandName: boolean } = {
-    ...payload,
-    thirdParty,
-    paymentLink: payload.paymentLink ?? '#',
-    idEstimateInvoiceType,
-    title: payload.title ?? null,
-    cgv: isHtmlEmpty(payload.cgv) ? null : payload.cgv,
-    // EJS `with` blocks throw a ReferenceError when a variable key is entirely absent from the data object, so seller
-    // identity/address fields must always be defined even when the payload omits them.
-    name: payload.name ?? null,
-    number: payload.number ?? null,
-    street: payload.street ?? null,
-    zipCode: payload.zipCode ?? null,
-    city: payload.city ?? null,
-    legalForm: payload.legalForm ?? null,
-    capital: payload.capital ?? null,
-    siren: payload.siren ?? null,
-    rcs: payload.rcs ?? null,
-    vatCode: payload.vatCode ?? null,
-    nafCode: payload.nafCode ?? null,
-    penalties: payload.penalties
-      ? (internationalizationConsistency(locale, payload.penalties, 'penalties') ?? payload.penalties)
-      : null,
-    termsOfPayment: payload.termsOfPayment
-      ? (internationalizationConsistency(locale, payload.termsOfPayment, 'termsOfPayment') ?? payload.termsOfPayment)
-      : null,
-    recoveryCost: recoveryCost
-      ? (internationalizationConsistency(locale, recoveryCost, 'recoveryCost') ?? recoveryCost)
-      : null,
-    discount: payload.discount
-      ? (internationalizationConsistency(locale, payload.discount, 'discount') ?? payload.discount)
-      : null,
-    vatMention: payload.vatMention
-      ? (internationalizationConsistency(locale, payload.vatMention, 'vatMention') ?? payload.vatMention)
-      : null,
-    phoneContact: payload.settings?.phoneContact ?? null,
-    products,
-    vats,
-    totalTaxExcluded: totalTaxExcluded,
-    totalTaxIncluded: round(totalTaxIncluded),
-    totalTaxAndDiscountIncluded: round(totalTaxIncluded),
-    generalDiscountFormatted: payload.generalDiscount2
-      ? integerToFormattedAmountString(payload.generalDiscount2)
-      : null,
-    depositFormatted: payload.deposit ? integerToFormattedAmountString(payload.deposit) : null,
-    totalTaxExcludedFormatted: integerToFormattedAmountString(totalTaxExcluded),
-    totalTaxIncludedFormatted: integerToFormattedAmountString(totalTaxIncluded),
-    totalTaxAndDiscountIncludedFormatted: integerToFormattedAmountString(
-      totalTaxIncluded - (payload.generalDiscount2 ?? 0) - (payload.deposit ?? 0),
-    ),
-    totalVatAmountFormatted: integerToFormattedAmountString(totalVats),
-    font: {
-      id: payload.settings?.idFont ?? FontIds.CIRCULAR_STD,
-      name: fontList.find((f) => f.id === payload.settings?.idFont)?.name ?? fontList[0].name,
-      url: fontList.find((f) => f.id === payload.settings?.idFont)?.link ?? fontList[0].link,
-    },
-    capitalFormatted: payload.capital
-      ? `${payload.capital}`
-          .split('')
-          .reduceRight((acc, char, i, { length }) => `${char}${(length - (i + 1)) % 3 === 0 ? ' ' : ''}${acc}`, '')
-          .trim()
-      : null,
-    dueDateFormatted: payload.dueDate ? dayjs(payload.dueDate).format('DD/MM/YYYY') : null,
-    expirationDateFormatted: payload.expirationDate ? dayjs(payload.expirationDate).format('DD/MM/YYYY') : null,
-    emissionDateFormatted: payload.emissionDate ? dayjs(payload.emissionDate).format('DD/MM/YYYY') : null,
-    shouldDisplayDiscountColumn: !!products.find((p) => p.discount2 && p.discount2 > 0),
-    // @ts-ignore
-    marginVats: uniq(products.filter((p) => p.marginVatFormatted !== null).map((p) => p.marginVatFormatted)),
-    accountingCategoryFormatted: accountingCategory
-      ? (internationalizationConsistency(locale, accountingCategory, 'accountingCategory') ?? null)
-      : null,
-    // @ts-ignore
-    brandColors: getBrandConfig({ objectWaited: 'colors', nodeEnv }) as brandColorType,
-    brandName: `${getBrandConfig({ objectWaited: 'name', nodeEnv }) as unknown as string}`,
-    shouldHideBrandName,
-    addressComplement: payload.addressComplement ?? null,
-    paymentType: payload.paymentType
-      ? (internationalizationConsistency(locale, payload.paymentType, 'paymentType') ?? payload.paymentType)
-      : null,
-    languageTemplate: languageOption,
-  };
-
-  const commonTemplate = new CommercialDocumentCommonHTML();
-  const documentFreeText = [EstimateInvoiceType.DEVIS, EstimateInvoiceType.BON].includes(idEstimateInvoiceType)
-    ? payload?.settings?.freeEstimateText
-    : payload?.settings?.freeInvoiceText;
-
-  return {
-    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:
-          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,
-          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,
-  };
-}
-
-export function generateMailHeader(
-  params: CreateMailHeader,
-  shouldHideBrandName = false,
-  nodeEnv: string | undefined = undefined,
-): ReadCommercialMailTemplate {
-  const locale = params.payload.language ?? InvoiceLanguage.FR;
-  const languageOption = internationalizationChoices[locale];
-  dayjs.locale('fr');
-  const data = {
-    ...params.payload,
-    totalTaxExcludedFormatted: integerToFormattedAmountObject(params.payload.totalTaxExcluded),
-    totalTaxIncludedFormatted: integerToFormattedAmountObject(params.payload.totalTaxIncluded),
-    totalVatFormatted: integerToFormattedAmountObject(
-      params.payload.totalTaxIncluded - params.payload.totalTaxExcluded,
-    ),
-    dueDateFormatted: params.payload.dueDate ? dayjs(params.payload.dueDate).format('DD MMMM YYYY') : null,
-    hasVat: params.hasVat,
-    hostS3: params.hostS3,
-    logoUrl: params.logoUrl,
-    companyName: params.companyName,
-    fileUrl: params.fileUrl,
-    // @ts-ignore
-    brandColors: getBrandConfig({ objectWaited: 'colors', nodeEnv }) as brandColorType,
-    shouldHideBrandName,
-    languageMail: languageOption,
-  };
-
-  const mailTemplate = new CommercialDocumentMailHTML();
-
-  return {
-    header: ejs.render(mailTemplate.header, data, {}),
-  };
-}
-
-function isMissing(value: unknown): boolean {
-  if (value === null || value === undefined) return true;
-  if (typeof value === 'string') return value.trim().length === 0;
-  if (Array.isArray(value)) return value.length === 0;
-  return false;
-}
-
-/**
- * @description Si cette fonction est modifiée, penser à check si la fonction `checkErrors` de `emission.service.ts` du core doit être modifiée aussi
- */
-export function checkCommercialDocumentInformation(payload: CreateInvoiceDocument | CreatePreSaleDocument): {
-  valid: boolean;
-  errors?: string[];
-} {
-  const errors: string[] = [];
-
-  const products = orderBy(payload.products.map((product) => productToReadProductEditing(product), 'reorder'));
-  const vats = orderBy(
-    Object.values(groupBy(products, 'vatFormatted')).map((v) => vatToReadVatEditing(v), 'value'),
-  ).filter((v) => v.id !== Vat.MARGE.id);
-
-  const totalVats = sumBy(vats, (v) => round(v.amount));
-  const totalTaxExcluded = sumBy(products, (p) => round(p.totalTaxExcluded));
-  const totalTaxIncluded = round(totalTaxExcluded + totalVats);
-
-  const requiredData: Array<{ value: unknown; error: string }> = [
-    // Invoice
-    { value: payload.reference, error: 'Le numéro de facture est obligatoire.' },
-    { value: payload.idEstimateInvoiceType, error: 'Le type de document est obligatoire.' },
-    { value: payload.emissionDate, error: 'La date d’émission est obligatoire.' },
-    // Items
-    ...products.flatMap((product, index) => {
-      const productLabel = product.itemSaleName?.trim() ? `"${product.itemSaleName}"` : `à la ligne ${index + 1}`;
-
-      return [
-        {
-          value: product.itemSaleName,
-          error: `Le nom de l'article ${productLabel} est obligatoire.`,
-        },
-        {
-          value: product.priceTaxExcluded,
-          error: `Le prix net de l'article ${productLabel} est obligatoire.`,
-        },
-        {
-          value: product.quantity,
-          error: `La quantité de l'article ${productLabel} est obligatoire.`,
-        },
-        {
-          value: product.unit,
-          error: `Le code EN 16931 de l'article ${productLabel} est obligatoire.`,
-        },
-        {
-          value: product.idVat,
-          error: `Le type de TVA de l'article ${productLabel} est obligatoire.`,
-        },
-        {
-          value: product.totalTaxExcluded,
-          error: `Le montant net de l'article ${productLabel} est obligatoire.`,
-        },
-      ];
-    }),
-    // Seller
-    { value: payload.name, error: 'Le nom du vendeur est obligatoire.' },
-    { value: payload.siren, error: 'Le SIREN du vendeur est obligatoire.' },
-    {
-      value: payload.zipCode,
-      error: 'Le code postal du vendeur est obligatoire.',
-    },
-    {
-      value: payload.street,
-      error: 'L’adresse du vendeur est obligatoire.',
-    },
-    {
-      value: payload.city,
-      error: 'La ville du vendeur est obligatoire.',
-    },
-    {
-      value: payload.idCountry,
-      error: 'Le pays du vendeur est obligatoire.',
-    },
-    // {
-    //   value: payload.settings?.mailContact,
-    //   error: 'L’email du vendeur est obligatoire.',
-    // },
-    // Customer
-    {
-      value: payload.thirdParty.company ?? payload.thirdParty.fullname ?? 'NA',
-      error: 'Le nom de l’acheteur est obligatoire.',
-    },
-    {
-      value: payload.thirdParty?.idCountry,
-      error: 'Le pays de l’acheteur est obligatoire.',
-    },
-    // {
-    //   value: payload.thirdParty?.email,
-    //   error: 'L’email de l’acheteur est obligatoire.',
-    // },
-    // Vats
-    ...vats.flatMap((vat, index) => [
-      {
-        value: vat.amount,
-        error: `Le montant de TVA à la ligne ${index + 1} est obligatoire.`,
-      },
-      {
-        value: vat.base,
-        error: `La base d’imposition de la TVA à la ligne ${index + 1} est obligatoire.`,
-      },
-      {
-        value: vat.value,
-        error: `Le type de TVA à la ligne ${index + 1} est obligatoire.`,
-      },
-    ]),
-    // Totals
-    { value: totalTaxExcluded, error: 'Le montant total hors taxe est obligatoire.' },
-    {
-      value: totalTaxExcluded,
-      error: 'La somme du montant net des lignes est obligatoire.',
-    },
-    { value: totalVats, error: 'Le montant total de TVA est obligatoire.' },
-    {
-      value: totalTaxIncluded,
-      error: 'Le montant total TTC est obligatoire.',
-    },
-  ];
-
-  // Check des mentions de tva
-  const vatType = CommercialVatMentionList.find((v) => v.value === payload.vatMention)?.taxType ?? 'standard';
-
-  // Si le type de tva est margin, autoliquidation, export ou exempt,
-  // aucun produit ne doit avoir de tva > 0
-  if (['margin', 'autoliquidation', 'export', 'exempt'].includes(vatType)) {
-    for (const product of products) {
-      if (getById(product.idVat)?.value !== 0) {
-        errors.push(
-          `L'article "${product.itemSaleName}" a une TVA non nulle alors que la mention légale de TVA est définie comme "${vatType}".`,
-        );
-      }
-    }
-  }
-
-  errors.push(...requiredData.filter((data) => isMissing(data.value)).map((data) => data.error));
-
-  return { valid: errors.length === 0, errors: errors.length > 0 ? errors : undefined };
-}