@bisondesk/documents-sdk 1.0.404 → 1.0.406

package/src/constants/search.ts

@@ -0,0 +1,271 @@
+import { DEFAULT_EXACT_MATCH_BOOST } from '@bisondesk/commons/es';
+import { getTranslatedTitles } from '@bisondesk/commons/translations';
+import {
+  EsAggregationsDefinition,
+  EsDefinition,
+  EsDefinitionField,
+  EsFullTextSearchDefinition,
+  SearchDefinition,
+  SearchField,
+} from '@bisondesk/core-sdk/types/definitions';
+import { DateGranularity, FieldTypes } from '@bisondesk/core-sdk/types/fields';
+import { AggregationType } from '@bisondesk/core-sdk/types/search';
+import { UTCDate } from '@date-fns/utc';
+import { getTime, parseISO, setHours, setMinutes, setSeconds } from 'date-fns';
+
+const BASE_DOC_DRAFT_MAPPING_FIELDS: {
+  [fieldId: string]: EsDefinitionField;
+} = {
+  'doc.id': {
+    esMapping: { type: 'keyword', boost: DEFAULT_EXACT_MATCH_BOOST },
+  },
+  'doc.status': {
+    esMapping: { type: 'keyword' },
+  },
+  'doc.documentType': {
+    esMapping: { type: 'keyword' },
+  },
+  'doc.category': {
+    esMapping: { type: 'keyword' },
+  },
+  'doc.branchId': {
+    esMapping: { type: 'keyword' },
+  },
+  'doc.attachment': {
+    esMapping: { type: 'object', enabled: false },
+  },
+  'doc.createdAt': {
+    esMapping: { type: 'date' },
+  },
+  'doc.createdBy': {
+    esMapping: { type: 'keyword' },
+  },
+  'custom.stage': {
+    esMapping: { type: 'keyword' },
+  },
+  'custom.rejected': {
+    esMapping: { type: 'boolean' },
+  },
+  'custom.validationRulesStatus': {
+    esMapping: { type: 'keyword' },
+  },
+};
+
+const FINANCE_DOC_DRAFT_MAPPING_FIELDS: {
+  [fieldId: string]: EsDefinitionField;
+} = {
+  'doc.type': {
+    esMapping: { type: 'keyword' },
+  },
+  'doc.subtype': {
+    esMapping: { type: 'keyword' },
+  },
+  'doc.reference': {
+    esMapping: { type: 'keyword', boost: DEFAULT_EXACT_MATCH_BOOST },
+  },
+  'doc.issueDate': {
+    esMapping: { type: 'date', ignore_malformed: true },
+  },
+  'doc.dueDate': {
+    esMapping: { type: 'date', ignore_malformed: true },
+  },
+
+  'doc.organizationSummary.name': {
+    esMapping: { type: 'text' },
+  },
+  'doc.organizationSummary.id': {
+    esMapping: { type: 'keyword' },
+  },
+  'doc.organizationSummary.code': {
+    esMapping: { type: 'keyword' },
+  },
+  'doc.organizationSummary.vatNumber': {
+    esMapping: { type: 'text' },
+  },
+
+  'doc.lines.associations.businessEntityId': {
+    esMapping: { type: 'keyword' },
+  },
+  'doc.lines.associations.recordId': {
+    esMapping: { type: 'keyword' },
+  },
+  'doc.lines.associations.title': {
+    esMapping: { type: 'text' },
+  },
+  'doc.lines.associations.description': {
+    esMapping: { type: 'text' },
+  },
+  'doc.lines.associations.tags': {
+    esMapping: { type: 'keyword' },
+  },
+  'doc.invoiceId': {
+    esMapping: { type: 'keyword' },
+  },
+  'custom.validators': {
+    esMapping: { type: 'keyword' },
+  },
+};
+
+const ADMIN_DOC_DRAFT_MAPPING_FIELDS: {
+  [fieldId: string]: EsDefinitionField;
+} = {
+  'doc.tags': {
+    esMapping: { type: 'text' },
+  },
+  'doc.associations.businessEntityId': {
+    esMapping: { type: 'keyword' },
+  },
+  'doc.associations.recordId': {
+    esMapping: { type: 'keyword' },
+  },
+  'doc.associations.title': {
+    esMapping: { type: 'text' },
+  },
+  'doc.associations.description': {
+    esMapping: { type: 'text' },
+  },
+  'doc.associations.tags': {
+    esMapping: { type: 'keyword' },
+  },
+};
+
+export const DOC_DRAFT_MAPPING_FIELDS: {
+  [fieldId: string]: EsDefinitionField;
+} = {
+  ...BASE_DOC_DRAFT_MAPPING_FIELDS,
+  ...FINANCE_DOC_DRAFT_MAPPING_FIELDS,
+  ...ADMIN_DOC_DRAFT_MAPPING_FIELDS,
+};
+
+export const DOC_DRAFT_DEFINITION_FIELDS: {
+  [fieldId: string]: SearchField;
+} = {
+  'doc.id': {
+    id: 'doc.id',
+    titles: getTranslatedTitles('id'),
+    type: FieldTypes.text,
+  },
+  'custom.stage': {
+    id: 'custom.stage',
+    titles: getTranslatedTitles('aggs.draft.stage'),
+    type: FieldTypes.text,
+  },
+  'doc.documentType': {
+    id: 'doc.documentType',
+    titles: getTranslatedTitles('aggs.draft.documentType'),
+    type: FieldTypes.text,
+  },
+  'doc.branchId': {
+    id: 'doc.branchId',
+    titles: getTranslatedTitles('branch'),
+    type: FieldTypes.text,
+  },
+  'doc.createdAt': {
+    id: 'doc.createdAt',
+    titles: getTranslatedTitles('aggs.creationDate'),
+    type: FieldTypes.date,
+    meta: {
+      granularity: DateGranularity.yearMonthDayTime,
+    },
+  },
+  'custom.validationRulesStatus': {
+    id: 'custom.validationRulesStatus',
+    titles: getTranslatedTitles('aggs.draft.validationRules'),
+    type: FieldTypes.text,
+  },
+  'doc.createdBy': {
+    id: 'doc.createdBy',
+    titles: getTranslatedTitles('aggs.createdBy'),
+    type: FieldTypes.collaborator,
+  },
+  // Finance fields
+  'doc.subtype': {
+    id: 'doc.subtype',
+    titles: getTranslatedTitles('type'),
+    type: FieldTypes.text,
+  },
+  'custom.rejected': {
+    id: 'custom.rejected',
+    titles: getTranslatedTitles('aggs.draft.rejected'),
+    type: FieldTypes.checkbox,
+  },
+};
+
+export const getSearchDocumentDraftsAggs = (): EsAggregationsDefinition => [
+  {
+    titles: getTranslatedTitles('aggs.draft.stage'),
+    fieldId: 'custom.stage',
+    fieldType: FieldTypes.text,
+    type: AggregationType.term,
+    orderBy: 'count',
+  },
+  {
+    titles: getTranslatedTitles('aggs.draft.documentType'),
+    fieldId: 'doc.documentType',
+    fieldType: FieldTypes.text,
+    type: AggregationType.term,
+    orderBy: 'count',
+  },
+  {
+    titles: getTranslatedTitles('type'),
+    fieldId: 'doc.subtype',
+    fieldType: FieldTypes.text,
+    type: AggregationType.term,
+    orderBy: 'count',
+  },
+  {
+    titles: getTranslatedTitles('aggs.draft.rejected'),
+    fieldId: 'custom.rejected',
+    fieldType: FieldTypes.checkbox,
+    type: AggregationType.term,
+    orderBy: 'count',
+  },
+  {
+    titles: getTranslatedTitles('aggs.draft.validationRules'),
+    fieldId: 'custom.validationRulesStatus',
+    fieldType: FieldTypes.text,
+    type: AggregationType.term,
+    orderBy: 'count',
+  },
+  {
+    titles: getTranslatedTitles('aggs.creationDate'),
+    fieldId: 'doc.createdAt',
+    step: 1,
+    type: AggregationType.range,
+    ranges: [
+      {
+        start: getTime(parseISO('2015-01-01')),
+        end: getTime(setSeconds(setMinutes(setHours(new UTCDate(), 23), 59), 59)),
+      },
+    ],
+  },
+];
+
+export const SEARCH_DOC_DRAFT_FULL_TEXT_FIELDS: EsFullTextSearchDefinition = [
+  // finance fields
+  () => 'doc.reference',
+  () => 'doc.tags',
+  () => 'doc.lines.associations.tags',
+  // administrative fields
+  () => 'doc.tags',
+  () => 'doc.associations.tags',
+  // OrgSummary fields
+  () => 'doc.organizationSummary.name',
+  () => 'doc.organizationSummary.id',
+  () => 'doc.organizationSummary.code',
+  () => 'doc.organizationSummary.vatNumber',
+];
+
+export const SEARCH_DOC_DRAFTS_MAPPINGS: EsDefinition = {
+  name: 'document_drafts',
+  nestedEsPaths: [],
+  fields: {
+    ...DOC_DRAFT_MAPPING_FIELDS,
+  },
+};
+
+export const SEARCH_DOC_DRAFTS_DEFINITION: SearchDefinition = {
+  fields: {
+    ...DOC_DRAFT_DEFINITION_FIELDS,
+  },
+};

package/src/types/documents.ts

@@ -298,6 +298,12 @@ export type DocumentGenerateRequestEvent = {
   request: FinanceDocumentGenerateRequest;
 };
 
+export type FinanceDocumentGeneratePDFEvent = {
+  tenantId: string;
+  doc: FinanceDocumentV2;
+  request: FinanceDocumentGenerateRequest;
+};
+
 export type FinanceDocumentSettings<M = {}> = {
   provider: string;
   meta: {

package/src/utils/finance.ts

@@ -2,6 +2,7 @@ import { BusinessEntityIds } from '@bisondesk/commons-sdk/constants';
 import { roundMoney } from '@bisondesk/commons-sdk/money';
 import { Decimal } from 'decimal.js';
 import { uniqBy } from 'lodash-es';
+import { GENERATING_PLACEHOLDER_ATTACHMENT } from '../constants/index.js';
 import {
   Association,
   DocumentDraft,
@@ -169,3 +170,6 @@ export const getLineAmounts = (unitPriceExcl: string, quantity: string, vatRate:
     vatAmount: vatAmount.toString(),
   };
 };
+
+export const isGeneratingAttachment = (doc: FinanceDocument) =>
+  doc.attachment.id === GENERATING_PLACEHOLDER_ATTACHMENT.id;