@bisondesk/commons-sdk 1.0.331 → 1.0.333

package/src/picklists.ts

@@ -0,0 +1,95 @@
+import { MultiLangValue } from './types.js';
+
+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[] })[];

package/src/search.ts

@@ -0,0 +1,278 @@
+import { BusinessEntityIds, SUPPORTED_LANGUAGES } from './constants.js';
+import { FieldTypes, NumberMeta } from './fields.js';
+import { MultiLangValue } from './types.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 enum ElasticsearchGeoOperator {
+  boundingBox = 'geo_bounding_box',
+  distance = 'geo_distance',
+  polygon = 'geo_polygon',
+}
+
+type ElasticSearchCoordinates =
+  | {
+      lat: number;
+      lon: number;
+    }
+  | [lat: number, lon: number]
+  | string;
+
+type BoundingBoxCoordinates = {
+  top_left: ElasticSearchCoordinates;
+  bottom_right: ElasticSearchCoordinates;
+};
+
+type BoundingBoxWKT = {
+  wkt: `BBOX (${number}, ${number}, ${number}, ${number})`;
+};
+
+type BoundingBoxVertices = {
+  top: number;
+  left: number;
+  bottom: number;
+  right: number;
+};
+
+type GeoDistanceUnit = 'mi' | 'yd' | 'ft' | 'in' | 'km' | 'm' | 'cm' | 'mm' | 'nmi';
+
+type GeoBoundingBoxFilter = {
+  operator: ElasticsearchGeoOperator.boundingBox;
+  data: BoundingBoxCoordinates | BoundingBoxWKT | BoundingBoxVertices;
+};
+
+type GeoDistanceFilter = {
+  operator: ElasticsearchGeoOperator.distance;
+  data: {
+    distance: `${number}${GeoDistanceUnit}`;
+    coords: ElasticSearchCoordinates;
+  };
+};
+
+type GeoPolygonFilter = {
+  operator: ElasticsearchGeoOperator.polygon;
+  data: {
+    points: ElasticSearchCoordinates[];
+  };
+};
+
+export type GeoFilter = { fieldId: string } & (
+  | GeoBoundingBoxFilter
+  | GeoDistanceFilter
+  | GeoPolygonFilter
+);
+
+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>;
+  geoFilters?: GeoFilter[];
+  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>[];
+  geoFilters?: GeoFilter[];
+};
+
+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;
+};

package/src/utils.ts

@@ -0,0 +1,52 @@
+import { AdHocPicklistValueDisplay } from './picklists.js';
+import { MultiLangValue } from './types.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',
+}