@bisondesk/documents-sdk 1.0.589 → 1.0.591

package/src/constants/search.ts

@@ -1,290 +0,0 @@
-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' },
-  },
-  'custom.businessValidationAt': {
-    esMapping: { type: 'date' },
-  },
-};
-
-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' },
-  },
-  'custom.restrictedDraftUsers': {
-    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,
-  },
-  'custom.restrictedDraftUsers': {
-    id: 'custom.restrictedDraftUsers',
-    titles: getTranslatedTitles('agg.drafts.restrictedDraftUsers'),
-    type: FieldTypes.text,
-  },
-};
-
-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)),
-      },
-    ],
-  },
-  {
-    titles: getTranslatedTitles('aggs.draft.restrictedDraftUsers'),
-    fieldId: 'custom.restrictedDraftUsers',
-    fieldType: FieldTypes.text,
-    type: AggregationType.term,
-    orderBy: 'count',
-  },
-];
-
-export const SEARCH_DOC_DRAFT_FULL_TEXT_FIELDS: EsFullTextSearchDefinition = [
-  // finance fields
-  () => 'doc.id',
-  () => '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/schemas.ts

@@ -1,144 +0,0 @@
-import { BusinessEntityIds } from '@bisondesk/commons-sdk/constants';
-import {
-  attachmentValueSchema,
-  getPhoneSchema,
-  isoDateSchema,
-} from '@bisondesk/commons/joi-schemas';
-import { FinanceDocType } from '@bisondesk/documents-sdk/types/documents';
-import Joi from 'joi';
-
-const orgSummarySchema = Joi.object({
-  id: Joi.string().required(),
-  code: Joi.number().required(),
-  name: Joi.string().empty('').required(),
-  language: Joi.string().empty(''),
-  vatNumber: Joi.string().empty(''),
-  addressLine1: Joi.string().empty(''),
-  addressLine2: Joi.string().empty(''),
-  postcode: Joi.string().empty(''),
-  city: Joi.string().empty(''),
-  country: Joi.string().required(),
-  emails: Joi.array().items(Joi.string().empty('').email()),
-  phone: getPhoneSchema(),
-  contact: Joi.object({
-    name: Joi.string().empty('').required(),
-    username: Joi.string().empty('').required(),
-  }),
-});
-
-const associationsSchema = Joi.array().items(
-  Joi.object({
-    businessEntityId: Joi.string()
-      .valid(...Object.values(BusinessEntityIds))
-      .required(),
-    recordId: Joi.string().required(),
-    title: Joi.string().required(),
-    description: Joi.string().required(),
-    tags: Joi.array().items(Joi.string().empty('')),
-    linkTo: Joi.object({
-      businessEntityId: Joi.string().required(),
-      recordId: Joi.string().required(),
-    }),
-  }),
-);
-
-export const lineSchema = Joi.object({
-  category: Joi.string().required(),
-  amount: Joi.number().cast('string').required(),
-  amountExcl: Joi.number().cast('string').required(),
-  description: Joi.string().required(),
-  foreign: Joi.object({
-    amount: Joi.number().cast('string').required(),
-    amountExcl: Joi.number().cast('string').required(),
-    unitPriceExcl: Joi.number().cast('string').required(),
-    vatAmount: Joi.number().cast('string').required(),
-  }),
-  invoiceLineId: Joi.string().empty('').uuid(),
-  quantity: Joi.number().min(0).cast('string').required(),
-  associations: associationsSchema,
-  unitPriceExcl: Joi.number().cast('string').required(),
-  vatAmount: Joi.number().cast('string').required(),
-  vatCode: Joi.string().required(),
-  vatPercentage: Joi.number().min(0).cast('string').required(),
-  vatReason: Joi.string().empty(''),
-  costCenterId: Joi.string().empty(''),
-});
-
-export const newFinanceDocV2Schema = Joi.object({
-  id: Joi.string().uuid(),
-  version: Joi.number().valid(2.0).default(2.0),
-  reference: Joi.string().required(),
-  type: Joi.string()
-    .valid(...Object.values(FinanceDocType))
-    .required(),
-  subtype: Joi.string().required(),
-  attachment: attachmentValueSchema.required(),
-  branchId: Joi.string().required(),
-  category: Joi.string().required(),
-  organizationSummary: orgSummarySchema.required(),
-  transferDescription: Joi.string().empty(''),
-  invoiceId: Joi.string().uuid().empty(''),
-  notes: Joi.string().empty(''),
-  salesperson: Joi.object({
-    name: Joi.string().required(),
-    username: Joi.string().required(),
-  }),
-  paidAt: Joi.string().empty(''),
-  tags: Joi.array().items(Joi.string().empty('')),
-  total: Joi.object({
-    amountExcl: Joi.number().min(0).cast('string').required(),
-    amount: Joi.number().min(0).cast('string').required(),
-    currencyCode: Joi.string().required(),
-    foreign: Joi.object({
-      amount: Joi.number().min(0).cast('string').required(),
-      amountExcl: Joi.number().min(0).cast('string').required(),
-      vatAmount: Joi.number().min(0).cast('string').required(),
-      currencyCode: Joi.string().required(),
-      exchangeRate: Joi.number().min(0).cast('string').required(),
-    }),
-    vatAmount: Joi.number().min(0).cast('string').required(),
-  }),
-  issueDate: isoDateSchema.required(),
-  dueDate: isoDateSchema.empty(''),
-  lines: Joi.array().items(lineSchema).required().default([]),
-  reportingYear: Joi.number().min(0).cast('string'),
-  reportingPeriod: Joi.number().min(0).cast('string'),
-  accountingDescription: Joi.string().empty(''),
-  peppol: Joi.object({
-    extraAttachments: Joi.array()
-      .items(
-        attachmentValueSchema.keys({
-          contentType: Joi.string().valid('application/pdf').required(),
-        }),
-      )
-      .max(9),
-    additionalItemProperties: Joi.array().items(
-      Joi.object({
-        lineId: Joi.string().required(),
-        properties: Joi.array().items(
-          Joi.object({
-            name: Joi.string().required(),
-            value: Joi.string().required(),
-          }),
-        ),
-      }),
-    ),
-  }),
-});
-
-export const newAdministrativedDocumentSchema = Joi.object({
-  id: Joi.string(),
-  displayName: Joi.string().empty(''),
-  branchId: Joi.string().required(),
-  attachment: attachmentValueSchema.required(),
-  category: Joi.string().empty(''),
-  tags: Joi.array().items(Joi.string().empty('')),
-  associations: associationsSchema,
-  organizationSummary: orgSummarySchema,
-});
-
-export const AdministrativeDocumentSchema = newAdministrativedDocumentSchema.keys({
-  id: Joi.string().required(),
-  createdAt: Joi.string().required(),
-  createdBy: Joi.string().required(),
-});