@bisondesk/core-sdk 1.0.330 → 1.0.332

package/src/apis/leasing.ts

@@ -1,7 +1,9 @@
 import { SERVICE_ID_ADMIN_HEADER, TENANT_ID_ADMIN_HEADER } from '@bisondesk/commons-sdk/constants';
 import { XError } from '@bisondesk/commons-sdk/errors';
 import { cleanHeaders, getAdminAuth } from '@bisondesk/commons-sdk/fetch';
+import { PaginatedList } from '@bisondesk/commons-sdk/types';
 import fetch, { Response } from 'node-fetch';
+import { SearchLeasingContract } from '../types/leasing-search.js';
 import {
   AmortizationDocs,
   AmortizationTable,
@@ -10,7 +12,8 @@ import {
   NewLeasingConditions,
   NewLeasingContract,
 } from '../types/leasing.js';
-import { DataRecord } from '../types/utils.js';
+import { SearchRequest } from '../types/search.js';
+import { DataRecord, ReferenceData } from '../types/utils.js';
 
 export const listLeasingClients = async (
   tenantId: string,
@@ -156,6 +159,32 @@ export const getLeasingContract = async (
   throw new XError(response.statusText, { tenantId, contractId, body });
 };
 
+export const searchLeasingContracts = async (
+  tenantId: string,
+  request: SearchRequest
+): Promise<PaginatedList<SearchLeasingContract, ReferenceData> | undefined> => {
+  const auth = await getAdminAuth();
+  const response: Response = await fetch(
+    `${process.env.CORE_API_ORIGIN}/api/leasing/contracts/search/results`,
+    {
+      headers: {
+        'Content-Type': 'application/json',
+        Authorization: auth,
+        [TENANT_ID_ADMIN_HEADER]: tenantId,
+      },
+      method: 'POST',
+      body: JSON.stringify(request),
+    }
+  );
+
+  if (response.ok) {
+    return response.status === 200 ? (response.json() as any) : undefined;
+  }
+
+  const body = await response.text();
+  throw new XError(response.statusText, { tenantId, body });
+};
+
 export const findLeasingContracts = async (
   tenantId: string,
   clientId: string,

package/src/apis/picklists.ts

@@ -1,73 +1 @@
-import { XError } from '@bisondesk/commons-sdk/errors';
-import { cleanHeaders, getAdminAuth } from '@bisondesk/commons-sdk/fetch';
-import { Option } from '@bisondesk/commons-sdk/types';
-import fetch, { Response } from 'node-fetch';
-import {
-  AdHocPicklistRequest,
-  AdHocPicklistValueDisplay,
-  PicklistOptionsRequest,
-  PicklistValue,
-  PicklistValueUpdateRequest,
-} from '../types/picklists.js';
-
-export const getMultiplePicklistValues = async (
-  request: AdHocPicklistRequest
-): Promise<AdHocPicklistValueDisplay> => {
-  const auth = await getAdminAuth();
-  const response: Response = await fetch(`${process.env.CORE_API_ORIGIN}/api/picklists/bulk/read`, {
-    method: 'POST',
-    headers: {
-      Authorization: auth,
-      'Content-Type': 'application/json',
-    },
-    body: JSON.stringify(request),
-  });
-
-  if (response.ok) {
-    return response.json() as any;
-  }
-
-  const body = await response.text();
-  throw new XError(response.statusText, { body });
-};
-
-export const getPicklistOptions = async (req: PicklistOptionsRequest): Promise<Option[]> => {
-  const auth = await getAdminAuth();
-
-  const response: Response = await fetch(`${process.env.CORE_API_ORIGIN}/api/picklists/options`, {
-    method: 'POST',
-    headers: cleanHeaders({
-      Authorization: auth,
-      'Content-Type': 'application/json',
-    }),
-    body: JSON.stringify(req),
-  });
-
-  if (response.ok) {
-    return response.json() as any;
-  }
-
-  const body = await response.text();
-  throw new XError(response.statusText, { body, req });
-};
-
-export const upsertPicklistValue = async (
-  request: PicklistValueUpdateRequest
-): Promise<PicklistValue> => {
-  const auth = await getAdminAuth();
-  const response: Response = await fetch(`${process.env.CORE_API_ORIGIN}/api/picklists/value`, {
-    method: 'POST',
-    headers: {
-      Authorization: auth,
-      'Content-Type': 'application/json',
-    },
-    body: JSON.stringify(request),
-  });
-
-  if (response.ok) {
-    return response.json() as any;
-  }
-
-  const body = await response.text();
-  throw new XError(response.statusText, { body });
-};
+export * from '@bisondesk/commons-sdk/apis/picklists';

package/src/types/definitions.ts

@@ -1,43 +1 @@
-import { SUPPORTED_LANGUAGES } from '@bisondesk/commons-sdk/constants';
-import { FieldTypeInfo } from './fields.js';
-import { Aggregation } from './search.js';
-
-//
-// These definitions are sent to the UI
-//
-export type PublicSearchDefinition = {
-  fields: { [fieldId: string]: SearchField };
-  aggs: Aggregation[];
-};
-
-//
-// These definitions are for internal consumption
-//
-export type SearchDefinition = {
-  fields: { [fieldId: string]: SearchField };
-};
-
-export type SearchField = {
-  id: string;
-  titles: { [lang: string]: string } & (
-    | { [local in (typeof SUPPORTED_LANGUAGES)[number]]: string }
-    | { key: string }
-  );
-} & FieldTypeInfo;
-
-export type EsDefinitionField = {
-  esMapping: unknown;
-  sortKey?: string;
-};
-
-export type EsDefinition = {
-  name: string;
-  nestedEsPaths: string[];
-  fields: {
-    [fieldId: string]: EsDefinitionField;
-  };
-};
-
-export type EsFullTextSearchDefinition = ((lang: string) => string)[];
-
-export type EsAggregationsDefinition = Aggregation[];
+export * from '@bisondesk/commons-sdk/definitions';

package/src/types/fields.ts

@@ -1,123 +1 @@
-export enum FieldTypes {
-  attachment = 'attachment',
-  checkbox = 'checkbox',
-  collaborator = 'collaborator',
-  date = 'date',
-  email = 'email',
-  image = 'image',
-  link = 'link',
-  location = 'location',
-  multilang = 'multilang',
-  multiline = 'multiline',
-  number = 'number',
-  phoneNumber = 'phoneNumber',
-  picklist = 'picklist',
-  rating = 'rating',
-  text = 'text',
-}
-
-//
-// Field values
-//
-export enum DateGranularity {
-  year = 'year',
-  yearMonth = 'yearMonth',
-  yearMonthDay = 'yearMonthDay',
-  yearMonthDayTime = 'yearMonthDayTime',
-}
-
-//
-// Field metas
-//
-type BaseMeta = {};
-
-type NumberUnit =
-  | 'acre'
-  | 'bit'
-  | 'byte'
-  | 'celsius'
-  | 'centimeter'
-  | 'day'
-  | 'degree'
-  | 'fahrenheit'
-  | 'fluid-ounce'
-  | 'foot'
-  | 'gallon'
-  | 'gigabit'
-  | 'gigabyte'
-  | 'gram'
-  | 'hectare'
-  | 'hour'
-  | 'inch'
-  | 'kilobit'
-  | 'kilobyte'
-  | 'kilogram'
-  | 'kilometer'
-  | 'liter'
-  | 'megabit'
-  | 'megabyte'
-  | 'meter'
-  | 'mile'
-  | 'mile-scandinavian'
-  | 'milliliter'
-  | 'millimeter'
-  | 'millisecond'
-  | 'minute'
-  | 'month'
-  | 'ounce'
-  | 'percent'
-  | 'petabyte'
-  | 'pound'
-  | 'second'
-  | 'stone'
-  | 'terabit'
-  | 'terabyte'
-  | 'week'
-  | 'yard'
-  | 'year';
-
-type BaseNumberMeta = {
-  minimumFractionDigits?: number;
-  maximumFractionDigits?: number;
-  useGrouping?: boolean;
-} & (
-  | {
-      style: 'unit';
-      unit: NumberUnit;
-    }
-  | {
-      style?: 'currency' | 'decimal' | 'percent';
-      unit?: NumberUnit;
-    }
-);
-
-export type NumberMeta = BaseMeta & BaseNumberMeta;
-
-export type DateMeta = BaseMeta & {
-  granularity: DateGranularity;
-};
-
-export type RatingMeta = BaseMeta & {
-  max: number;
-};
-
-export type PicklistMeta = BaseMeta & {
-  picklistId: string;
-};
-
-export type FieldTypeInfo =
-  | { type: FieldTypes.attachment }
-  | { type: FieldTypes.checkbox }
-  | { type: FieldTypes.date; meta: DateMeta }
-  | { type: FieldTypes.email }
-  | { type: FieldTypes.image }
-  | { type: FieldTypes.link }
-  | { type: FieldTypes.location }
-  | { type: FieldTypes.multilang }
-  | { type: FieldTypes.multiline }
-  | { type: FieldTypes.number; meta: NumberMeta }
-  | { type: FieldTypes.phoneNumber }
-  | { type: FieldTypes.picklist; meta: PicklistMeta }
-  | { type: FieldTypes.rating; meta: RatingMeta }
-  | { type: FieldTypes.text }
-  | { type: FieldTypes.collaborator };
+export * from '@bisondesk/commons-sdk/fields';

package/src/types/opportunities.ts

@@ -182,6 +182,7 @@ export type OpportunityUpdate = {
   prepared?: boolean;
   lost?: boolean;
   delivered?: boolean;
+  cmrDeleted?: boolean;
   lostReason?: OpportunityLostReasonValues;
   documents?: Document[];
   branch?: string;

package/src/types/picklists.ts

@@ -1,95 +1 @@
-import { MultiLangValue } from '@bisondesk/commons-sdk/types';
-
-export type PicklistValueUpdateRequest = {
-  picklistId: string;
-  value: PicklistValue | NewPicklistValue;
-  tenantId?: string;
-};
-
-export type NewPicklistValue<T = Record<string, string>> = {
-  color?: string;
-  sortPriority?: number;
-  titles: MultiLangValue;
-  dependency?: PicklistValueDependency;
-  meta?: T;
-};
-
-export type PicklistValue<T = any> = NewPicklistValue<T> & {
-  id: string;
-  system?: boolean;
-};
-
-export type PicklistValueListRequest = {
-  picklistId: string;
-  limit: number;
-  offset: number;
-  dependencies?: PicklistValueDependency[];
-};
-
-export type PicklistValueRequest = {
-  picklistId: string;
-  valueId: string;
-};
-
-export type AdHocPicklistValues<T = any> = {
-  [picklistId: string]: {
-    [valueId: string]: PicklistValue<T>;
-  };
-};
-
-export type AdHocPicklistRequest = {
-  requests: PicklistValueRequest[];
-  preferredLang: string;
-  tenantLang: string;
-};
-
-export type AdHocPicklistValueDisplay = {
-  [picklistId: string]: {
-    [valueId: string]: {
-      color?: string;
-      title: string;
-    };
-  };
-};
-
-export type PicklistOptionsRequest = {
-  picklistId: string;
-  dependencies?: PicklistValueDependency[];
-  lang: string;
-};
-
-export type PicklistUpsertValueRequest = {
-  tenantId?: string;
-  picklistId: string;
-  value: PicklistValue | NewPicklistValue;
-};
-
-export type QuickAddPicklistValue = {
-  sortPriority?: number;
-  titles: MultiLangValue;
-};
-
-export type NewPicklist = {
-  id?: undefined;
-  titles: MultiLangValue;
-  values: QuickAddPicklistValue[];
-  customSort?: boolean;
-};
-
-export type BasePicklist = {
-  customSort?: boolean;
-  id: string;
-  system?: boolean;
-  titles: MultiLangValue;
-};
-
-export type PicklistInfo = BasePicklist & {
-  count: number;
-  modifiedAt: string;
-};
-export type PicklistValueDependency = {
-  picklistId: string;
-  values: string[];
-};
-
-export type PicklistCollection = (BasePicklist & { data: PicklistValue[] })[];
+export * from '@bisondesk/commons-sdk/picklists';

package/src/types/search.ts

@@ -1,222 +1 @@
-///////////////////////////////////////////////////////
-// Generic stuff
-///////////////////////////////////////////////////////
-
-import { BusinessEntityIds, SUPPORTED_LANGUAGES } from '@bisondesk/commons-sdk/constants';
-import { MultiLangValue } from '@bisondesk/commons-sdk/types';
-import { FieldTypes, NumberMeta } from './fields.js';
-
-export enum ConditionType {
-  and = 'AND',
-  or = 'OR',
-}
-
-export enum ElasticsearchOperator {
-  // all properties
-  empty = 'EMPTY',
-  notEmpty = 'NOT_EMPTY',
-  is = 'IS',
-  isNot = 'IS_NOT',
-  // number, date properties
-  greaterThanOrEqual = 'GTE',
-  greaterThan = 'GT',
-  lessThanEqual = 'LTE',
-  lessThan = 'LT',
-  between = 'BETWEEN',
-  // string properties
-  contains = 'CONTAINS',
-  notContains = 'NOT_CONTAINS',
-  startsWith = 'STARTS_WITH',
-  endsWith = 'ENDS_WITH',
-}
-
-export type Filter<OP = ElasticsearchOperator> = {
-  data: string;
-  fieldId: string;
-  operator: OP;
-};
-
-export type ComplexFilter<OP = ElasticsearchOperator> = {
-  condition: ConditionType;
-  filters: Array<Filter<OP> | ComplexFilter<OP>>;
-};
-
-export type SearchResponse<T = any> = {
-  took: number;
-  timed_out: boolean;
-  _scroll_id?: string;
-  _shards: unknown;
-  hits: {
-    total: {
-      value: number;
-      relation: 'eq' | 'gte';
-    };
-    max_score: number;
-    hits: Array<{
-      _index: string;
-      _type: string;
-      _id: string;
-      _score: number;
-      _source?: T;
-      _version?: number;
-      _explanation?: unknown;
-      fields?: any;
-      highlight?: any;
-      inner_hits?: any;
-      matched_queries?: string[];
-      sort?: Array<string | number>;
-    }>;
-  };
-  aggregations?: { [aggName: string]: object };
-};
-
-///////////////////////////////////////////////////////
-// Search
-///////////////////////////////////////////////////////
-
-export const FILTER_RANGE_SEPARATOR = '__';
-
-export enum SortOrder {
-  asc = 'asc',
-  desc = 'desc',
-}
-
-export type SortFilter = {
-  fieldId: string;
-  order: SortOrder;
-};
-
-export type BaseSearchRequest = {
-  fullText?: string;
-  limit: number;
-  query?: ComplexFilter<ElasticsearchOperator>;
-  sortBy?: SortFilter[];
-};
-
-type InfiniteSearchRequest = {
-  infinite: true;
-  nextToken?: string;
-};
-
-type PaginatedSearchRequest = {
-  infinite?: false;
-  offset?: number;
-};
-
-export type SearchRequest = {
-  fullText?: string;
-  limit: number;
-  query?: ComplexFilter<ElasticsearchOperator>;
-  sortBy?: SortFilter[];
-} & (InfiniteSearchRequest | PaginatedSearchRequest);
-
-export type GlobalSearchRequest = {
-  fullText: string;
-  limit: number;
-} & {
-  entityIds: BusinessEntityIds[];
-} & (InfiniteSearchRequest | PaginatedSearchRequest);
-
-export type GlobalSearchResult = {
-  businessEntityId: BusinessEntityIds;
-  recordId: string;
-  title: string;
-  description: string;
-  tags?: string[];
-};
-
-export type GlobalSearchByIdRequest = {
-  ids: {
-    businessEntityId: BusinessEntityIds;
-    recordId: string;
-  }[];
-};
-
-export type PublicSearchRequest = {
-  limit: number;
-  offset?: number;
-  query?: ComplexFilter;
-  sortBy?: SortFilter[];
-};
-
-///////////////////////////////////////////////////////
-// Aggregations
-///////////////////////////////////////////////////////
-
-export type AggFilterOperator =
-  | ElasticsearchOperator.is
-  | ElasticsearchOperator.greaterThan
-  | ElasticsearchOperator.lessThan
-  | ElasticsearchOperator.greaterThanOrEqual
-  | ElasticsearchOperator.lessThanEqual;
-
-export enum AggregationType {
-  term = 'TERM',
-  range = 'RANGE',
-}
-
-export type TermAggregation = {
-  titles: MultiLangValue & { [local in (typeof SUPPORTED_LANGUAGES)[number]]: string };
-  fieldId: string;
-  type: AggregationType.term;
-
-  orderBy?: 'count' | 'field';
-} & (
-  | {
-      fieldType: FieldTypes.picklist;
-      picklistId: string;
-    }
-  | {
-      fieldType: FieldTypes.number;
-      meta?: NumberMeta;
-    }
-  | {
-      fieldType: Exclude<FieldTypes, FieldTypes.picklist | FieldTypes.number>;
-    }
-);
-
-export type Range =
-  | {
-      start: number;
-      end?: number;
-    }
-  | {
-      start?: number;
-      end: number;
-    }
-  | {
-      start: number;
-      end: number;
-    };
-
-export type RangeAggregation = {
-  titles: MultiLangValue & { [local in (typeof SUPPORTED_LANGUAGES)[number]]: string };
-  fieldId: string;
-  type: AggregationType.range;
-  step: number;
-  ranges: Range[];
-  format?: NumberMeta;
-};
-
-export type Aggregation = TermAggregation | RangeAggregation;
-
-export type AggregationRequest = {
-  fullText?: string;
-  filters: ComplexFilter<AggFilterOperator>[];
-};
-
-export type AggregationResult = {
-  value: string;
-  count: number;
-  from?: number;
-  to?: number;
-};
-
-export type AggregationResultSet = {
-  [field: string]: AggregationResult[];
-};
-
-export type AggregationResponse<M = {}> = {
-  results: AggregationResultSet;
-  meta: M;
-};
+export * from '@bisondesk/commons-sdk/search';

package/src/types/utils.ts

@@ -1,52 +1 @@
-import { MultiLangValue } from '@bisondesk/commons-sdk/types';
-import { AdHocPicklistValueDisplay } from './picklists.js';
-
-export type CountryInfo = {
-  code: string; // code is ISO 3166-1 alpha-2
-  name: string;
-  labels: {
-    city: string;
-    state: string;
-    postalCode?: string;
-  };
-  required: {
-    city: boolean;
-    state: boolean;
-    postalCode: boolean;
-  };
-  dialCode: number;
-  currencyCode: string;
-  states?: {
-    [code: string]: string; // code is ISO 3166-2
-  };
-  postalCodeFormat?: string;
-  postalCodeEx?: string;
-};
-
-export type Country = {
-  code: string;
-  name: string;
-  dialCode: number;
-};
-
-export type ReferenceData = {
-  recordTitles: AdHocRecordTitles;
-  picklistTitles: AdHocPicklistValueDisplay;
-};
-
-export type AdHocRecordTitles = {
-  [businessEntityId: string]: {
-    [recordId: string]: string | MultiLangValue;
-  };
-};
-
-export type DataRecord<T, M = undefined> = {
-  record: T;
-  meta?: M; // typically ReferenceData
-  actions: string[];
-};
-
-export enum PricePercentageMode {
-  CURRENCY = 'currency',
-  PERCENTAGE = 'percentage',
-}
+export * from '@bisondesk/commons-sdk/utils';

package/src/utils/search.ts

@@ -54,6 +54,8 @@ export const mappings: {
     getMainEntity: (entity: SearchVehicle) => entity.vehicle,
     getTitle: (vehicle: Vehicle) => vehicle.internal.description.title,
     getTags: (vehicle: Vehicle) => [
+      // the order of the tags here is relevant for exact integration
+      // see: packages/exact/src/service/purchase.ts
       vehicle.external.identification?.stockNumber,
       vehicle.internal.identification?.administrativeNumber,
       vehicle.external.identification?.vin,