@bisondesk/commons-sdk 1.0.331 → 1.0.332

package/lib/search.d.ts

@@ -0,0 +1,221 @@
+import { BusinessEntityIds, SUPPORTED_LANGUAGES } from './constants.js';
+import { FieldTypes, NumberMeta } from './fields.js';
+import { MultiLangValue } from './types.js';
+export declare enum ConditionType {
+    and = "AND",
+    or = "OR"
+}
+export declare enum ElasticsearchOperator {
+    empty = "EMPTY",
+    notEmpty = "NOT_EMPTY",
+    is = "IS",
+    isNot = "IS_NOT",
+    greaterThanOrEqual = "GTE",
+    greaterThan = "GT",
+    lessThanEqual = "LTE",
+    lessThan = "LT",
+    between = "BETWEEN",
+    contains = "CONTAINS",
+    notContains = "NOT_CONTAINS",
+    startsWith = "STARTS_WITH",
+    endsWith = "ENDS_WITH"
+}
+export type Filter<OP = ElasticsearchOperator> = {
+    data: string;
+    fieldId: string;
+    operator: OP;
+};
+export declare 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;
+    };
+};
+export declare const FILTER_RANGE_SEPARATOR = "__";
+export declare 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[];
+};
+export type AggFilterOperator = ElasticsearchOperator.is | ElasticsearchOperator.greaterThan | ElasticsearchOperator.lessThan | ElasticsearchOperator.greaterThanOrEqual | ElasticsearchOperator.lessThanEqual;
+export declare 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;
+};
+export {};
+//# sourceMappingURL=search.d.ts.map

package/lib/search.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"search.d.ts","sourceRoot":"/","sources":["search.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,MAAM,gBAAgB,CAAC;AACxE,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACrD,OAAO,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAE5C,oBAAY,aAAa;IACvB,GAAG,QAAQ;IACX,EAAE,OAAO;CACV;AAED,oBAAY,qBAAqB;IAE/B,KAAK,UAAU;IACf,QAAQ,cAAc;IACtB,EAAE,OAAO;IACT,KAAK,WAAW;IAEhB,kBAAkB,QAAQ;IAC1B,WAAW,OAAO;IAClB,aAAa,QAAQ;IACrB,QAAQ,OAAO;IACf,OAAO,YAAY;IAEnB,QAAQ,aAAa;IACrB,WAAW,iBAAiB;IAC5B,UAAU,gBAAgB;IAC1B,QAAQ,cAAc;CACvB;AAED,MAAM,MAAM,MAAM,CAAC,EAAE,GAAG,qBAAqB,IAAI;IAC/C,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,EAAE,CAAC;CACd,CAAC;AAEF,oBAAY,wBAAwB;IAClC,WAAW,qBAAqB;IAChC,QAAQ,iBAAiB;IACzB,OAAO,gBAAgB;CACxB;AAED,KAAK,wBAAwB,GACzB;IACE,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;CACb,GACD,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,CAAC,GAC1B,MAAM,CAAC;AAEX,KAAK,sBAAsB,GAAG;IAC5B,QAAQ,EAAE,wBAAwB,CAAC;IACnC,YAAY,EAAE,wBAAwB,CAAC;CACxC,CAAC;AAEF,KAAK,cAAc,GAAG;IACpB,GAAG,EAAE,SAAS,MAAM,KAAK,MAAM,KAAK,MAAM,KAAK,MAAM,GAAG,CAAC;CAC1D,CAAC;AAEF,KAAK,mBAAmB,GAAG;IACzB,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,KAAK,eAAe,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,GAAG,GAAG,IAAI,GAAG,IAAI,GAAG,KAAK,CAAC;AAEpF,KAAK,oBAAoB,GAAG;IAC1B,QAAQ,EAAE,wBAAwB,CAAC,WAAW,CAAC;IAC/C,IAAI,EAAE,sBAAsB,GAAG,cAAc,GAAG,mBAAmB,CAAC;CACrE,CAAC;AAEF,KAAK,iBAAiB,GAAG;IACvB,QAAQ,EAAE,wBAAwB,CAAC,QAAQ,CAAC;IAC5C,IAAI,EAAE;QACJ,QAAQ,EAAE,GAAG,MAAM,GAAG,eAAe,EAAE,CAAC;QACxC,MAAM,EAAE,wBAAwB,CAAC;KAClC,CAAC;CACH,CAAC;AAEF,KAAK,gBAAgB,GAAG;IACtB,QAAQ,EAAE,wBAAwB,CAAC,OAAO,CAAC;IAC3C,IAAI,EAAE;QACJ,MAAM,EAAE,wBAAwB,EAAE,CAAC;KACpC,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,SAAS,GAAG;IAAE,OAAO,EAAE,MAAM,CAAA;CAAE,GAAG,CAC1C,oBAAoB,GACpB,iBAAiB,GACjB,gBAAgB,CACnB,CAAC;AAEF,MAAM,MAAM,aAAa,CAAC,EAAE,GAAG,qBAAqB,IAAI;IACtD,SAAS,EAAE,aAAa,CAAC;IACzB,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC,GAAG,aAAa,CAAC,EAAE,CAAC,CAAC,CAAC;CAChD,CAAC;AAEF,MAAM,MAAM,cAAc,CAAC,CAAC,GAAG,GAAG,IAAI;IACpC,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,OAAO,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,OAAO,EAAE,OAAO,CAAC;IACjB,IAAI,EAAE;QACJ,KAAK,EAAE;YACL,KAAK,EAAE,MAAM,CAAC;YACd,QAAQ,EAAE,IAAI,GAAG,KAAK,CAAC;SACxB,CAAC;QACF,SAAS,EAAE,MAAM,CAAC;QAClB,IAAI,EAAE,KAAK,CAAC;YACV,MAAM,EAAE,MAAM,CAAC;YACf,KAAK,EAAE,MAAM,CAAC;YACd,GAAG,EAAE,MAAM,CAAC;YACZ,MAAM,EAAE,MAAM,CAAC;YACf,OAAO,CAAC,EAAE,CAAC,CAAC;YACZ,QAAQ,CAAC,EAAE,MAAM,CAAC;YAClB,YAAY,CAAC,EAAE,OAAO,CAAC;YACvB,MAAM,CAAC,EAAE,GAAG,CAAC;YACb,SAAS,CAAC,EAAE,GAAG,CAAC;YAChB,UAAU,CAAC,EAAE,GAAG,CAAC;YACjB,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;YAC3B,IAAI,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC,CAAC;SAC/B,CAAC,CAAC;KACJ,CAAC;IACF,YAAY,CAAC,EAAE;QAAE,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;CAC9C,CAAC;AAMF,eAAO,MAAM,sBAAsB,OAAO,CAAC;AAE3C,oBAAY,SAAS;IACnB,GAAG,QAAQ;IACX,IAAI,SAAS;CACd;AAED,MAAM,MAAM,UAAU,GAAG;IACvB,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,SAAS,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAC9B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,aAAa,CAAC,qBAAqB,CAAC,CAAC;IAC7C,MAAM,CAAC,EAAE,UAAU,EAAE,CAAC;CACvB,CAAC;AAEF,KAAK,qBAAqB,GAAG;IAC3B,QAAQ,EAAE,IAAI,CAAC;IACf,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,KAAK,sBAAsB,GAAG;IAC5B,QAAQ,CAAC,EAAE,KAAK,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,aAAa,CAAC,qBAAqB,CAAC,CAAC;IAC7C,UAAU,CAAC,EAAE,SAAS,EAAE,CAAC;IACzB,MAAM,CAAC,EAAE,UAAU,EAAE,CAAC;CACvB,GAAG,CAAC,qBAAqB,GAAG,sBAAsB,CAAC,CAAC;AAErD,MAAM,MAAM,mBAAmB,GAAG;IAChC,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;CACf,GAAG;IACF,SAAS,EAAE,iBAAiB,EAAE,CAAC;CAChC,GAAG,CAAC,qBAAqB,GAAG,sBAAsB,CAAC,CAAC;AAErD,MAAM,MAAM,kBAAkB,GAAG;IAC/B,gBAAgB,EAAE,iBAAiB,CAAC;IACpC,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;IACpB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG;IACpC,GAAG,EAAE;QACH,gBAAgB,EAAE,iBAAiB,CAAC;QACpC,QAAQ,EAAE,MAAM,CAAC;KAClB,EAAE,CAAC;CACL,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,aAAa,CAAC;IACtB,MAAM,CAAC,EAAE,UAAU,EAAE,CAAC;CACvB,CAAC;AAMF,MAAM,MAAM,iBAAiB,GACzB,qBAAqB,CAAC,EAAE,GACxB,qBAAqB,CAAC,WAAW,GACjC,qBAAqB,CAAC,QAAQ,GAC9B,qBAAqB,CAAC,kBAAkB,GACxC,qBAAqB,CAAC,aAAa,CAAC;AAExC,oBAAY,eAAe;IACzB,IAAI,SAAS;IACb,KAAK,UAAU;CAChB;AAED,MAAM,MAAM,eAAe,GAAG;IAC5B,MAAM,EAAE,cAAc,GAAG;SAAG,KAAK,IAAI,CAAC,OAAO,mBAAmB,CAAC,CAAC,MAAM,CAAC,GAAG,MAAM;KAAE,CAAC;IACrF,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,eAAe,CAAC,IAAI,CAAC;IAE3B,OAAO,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC;CAC7B,GAAG,CACA;IACE,SAAS,EAAE,UAAU,CAAC,QAAQ,CAAC;IAC/B,UAAU,EAAE,MAAM,CAAC;CACpB,GACD;IACE,SAAS,EAAE,UAAU,CAAC,MAAM,CAAC;IAC7B,IAAI,CAAC,EAAE,UAAU,CAAC;CACnB,GACD;IACE,SAAS,EAAE,OAAO,CAAC,UAAU,EAAE,UAAU,CAAC,QAAQ,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC;CACzE,CACJ,CAAC;AAEF,MAAM,MAAM,KAAK,GACb;IACE,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,CAAC,EAAE,MAAM,CAAC;CACd,GACD;IACE,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,GAAG,EAAE,MAAM,CAAC;CACb,GACD;IACE,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,EAAE,MAAM,CAAC;CACb,CAAC;AAEN,MAAM,MAAM,gBAAgB,GAAG;IAC7B,MAAM,EAAE,cAAc,GAAG;SAAG,KAAK,IAAI,CAAC,OAAO,mBAAmB,CAAC,CAAC,MAAM,CAAC,GAAG,MAAM;KAAE,CAAC;IACrF,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,eAAe,CAAC,KAAK,CAAC;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,KAAK,EAAE,CAAC;IAChB,MAAM,CAAC,EAAE,UAAU,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG,eAAe,GAAG,gBAAgB,CAAC;AAE7D,MAAM,MAAM,kBAAkB,GAAG;IAC/B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,aAAa,CAAC,iBAAiB,CAAC,EAAE,CAAC;IAC5C,UAAU,CAAC,EAAE,SAAS,EAAE,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAC9B,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,EAAE,CAAC,EAAE,MAAM,CAAC;CACb,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,CAAC,KAAK,EAAE,MAAM,GAAG,iBAAiB,EAAE,CAAC;CACtC,CAAC;AAEF,MAAM,MAAM,mBAAmB,CAAC,CAAC,GAAG,EAAE,IAAI;IACxC,OAAO,EAAE,oBAAoB,CAAC;IAC9B,IAAI,EAAE,CAAC,CAAC;CACT,CAAC"}

package/lib/search.js

@@ -0,0 +1,39 @@
+export var ConditionType;
+(function (ConditionType) {
+    ConditionType["and"] = "AND";
+    ConditionType["or"] = "OR";
+})(ConditionType || (ConditionType = {}));
+export var ElasticsearchOperator;
+(function (ElasticsearchOperator) {
+    ElasticsearchOperator["empty"] = "EMPTY";
+    ElasticsearchOperator["notEmpty"] = "NOT_EMPTY";
+    ElasticsearchOperator["is"] = "IS";
+    ElasticsearchOperator["isNot"] = "IS_NOT";
+    ElasticsearchOperator["greaterThanOrEqual"] = "GTE";
+    ElasticsearchOperator["greaterThan"] = "GT";
+    ElasticsearchOperator["lessThanEqual"] = "LTE";
+    ElasticsearchOperator["lessThan"] = "LT";
+    ElasticsearchOperator["between"] = "BETWEEN";
+    ElasticsearchOperator["contains"] = "CONTAINS";
+    ElasticsearchOperator["notContains"] = "NOT_CONTAINS";
+    ElasticsearchOperator["startsWith"] = "STARTS_WITH";
+    ElasticsearchOperator["endsWith"] = "ENDS_WITH";
+})(ElasticsearchOperator || (ElasticsearchOperator = {}));
+export var ElasticsearchGeoOperator;
+(function (ElasticsearchGeoOperator) {
+    ElasticsearchGeoOperator["boundingBox"] = "geo_bounding_box";
+    ElasticsearchGeoOperator["distance"] = "geo_distance";
+    ElasticsearchGeoOperator["polygon"] = "geo_polygon";
+})(ElasticsearchGeoOperator || (ElasticsearchGeoOperator = {}));
+export const FILTER_RANGE_SEPARATOR = '__';
+export var SortOrder;
+(function (SortOrder) {
+    SortOrder["asc"] = "asc";
+    SortOrder["desc"] = "desc";
+})(SortOrder || (SortOrder = {}));
+export var AggregationType;
+(function (AggregationType) {
+    AggregationType["term"] = "TERM";
+    AggregationType["range"] = "RANGE";
+})(AggregationType || (AggregationType = {}));
+//# sourceMappingURL=search.js.map

package/lib/search.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"search.js","sourceRoot":"/","sources":["search.ts"],"names":[],"mappings":"AAIA,MAAM,CAAN,IAAY,aAGX;AAHD,WAAY,aAAa;IACvB,4BAAW,CAAA;IACX,0BAAS,CAAA;AACX,CAAC,EAHW,aAAa,KAAb,aAAa,QAGxB;AAED,MAAM,CAAN,IAAY,qBAiBX;AAjBD,WAAY,qBAAqB;IAE/B,wCAAe,CAAA;IACf,+CAAsB,CAAA;IACtB,kCAAS,CAAA;IACT,yCAAgB,CAAA;IAEhB,mDAA0B,CAAA;IAC1B,2CAAkB,CAAA;IAClB,8CAAqB,CAAA;IACrB,wCAAe,CAAA;IACf,4CAAmB,CAAA;IAEnB,8CAAqB,CAAA;IACrB,qDAA4B,CAAA;IAC5B,mDAA0B,CAAA;IAC1B,+CAAsB,CAAA;AACxB,CAAC,EAjBW,qBAAqB,KAArB,qBAAqB,QAiBhC;AAQD,MAAM,CAAN,IAAY,wBAIX;AAJD,WAAY,wBAAwB;IAClC,4DAAgC,CAAA;IAChC,qDAAyB,CAAA;IACzB,mDAAuB,CAAA;AACzB,CAAC,EAJW,wBAAwB,KAAxB,wBAAwB,QAInC;AA4FD,MAAM,CAAC,MAAM,sBAAsB,GAAG,IAAI,CAAC;AAE3C,MAAM,CAAN,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,KAAT,SAAS,QAGpB;AAwED,MAAM,CAAN,IAAY,eAGX;AAHD,WAAY,eAAe;IACzB,gCAAa,CAAA;IACb,kCAAe,CAAA;AACjB,CAAC,EAHW,eAAe,KAAf,eAAe,QAG1B","sourcesContent":["import { BusinessEntityIds, SUPPORTED_LANGUAGES } from './constants.js';\nimport { FieldTypes, NumberMeta } from './fields.js';\nimport { MultiLangValue } from './types.js';\n\nexport enum ConditionType {\n  and = 'AND',\n  or = 'OR',\n}\n\nexport enum ElasticsearchOperator {\n  // all properties\n  empty = 'EMPTY',\n  notEmpty = 'NOT_EMPTY',\n  is = 'IS',\n  isNot = 'IS_NOT',\n  // number, date properties\n  greaterThanOrEqual = 'GTE',\n  greaterThan = 'GT',\n  lessThanEqual = 'LTE',\n  lessThan = 'LT',\n  between = 'BETWEEN',\n  // string properties\n  contains = 'CONTAINS',\n  notContains = 'NOT_CONTAINS',\n  startsWith = 'STARTS_WITH',\n  endsWith = 'ENDS_WITH',\n}\n\nexport type Filter<OP = ElasticsearchOperator> = {\n  data: string;\n  fieldId: string;\n  operator: OP;\n};\n\nexport enum ElasticsearchGeoOperator {\n  boundingBox = 'geo_bounding_box',\n  distance = 'geo_distance',\n  polygon = 'geo_polygon',\n}\n\ntype ElasticSearchCoordinates =\n  | {\n      lat: number;\n      lon: number;\n    }\n  | [lat: number, lon: number]\n  | string;\n\ntype BoundingBoxCoordinates = {\n  top_left: ElasticSearchCoordinates;\n  bottom_right: ElasticSearchCoordinates;\n};\n\ntype BoundingBoxWKT = {\n  wkt: `BBOX (${number}, ${number}, ${number}, ${number})`;\n};\n\ntype BoundingBoxVertices = {\n  top: number;\n  left: number;\n  bottom: number;\n  right: number;\n};\n\ntype GeoDistanceUnit = 'mi' | 'yd' | 'ft' | 'in' | 'km' | 'm' | 'cm' | 'mm' | 'nmi';\n\ntype GeoBoundingBoxFilter = {\n  operator: ElasticsearchGeoOperator.boundingBox;\n  data: BoundingBoxCoordinates | BoundingBoxWKT | BoundingBoxVertices;\n};\n\ntype GeoDistanceFilter = {\n  operator: ElasticsearchGeoOperator.distance;\n  data: {\n    distance: `${number}${GeoDistanceUnit}`;\n    coords: ElasticSearchCoordinates;\n  };\n};\n\ntype GeoPolygonFilter = {\n  operator: ElasticsearchGeoOperator.polygon;\n  data: {\n    points: ElasticSearchCoordinates[];\n  };\n};\n\nexport type GeoFilter = { fieldId: string } & (\n  | GeoBoundingBoxFilter\n  | GeoDistanceFilter\n  | GeoPolygonFilter\n);\n\nexport type ComplexFilter<OP = ElasticsearchOperator> = {\n  condition: ConditionType;\n  filters: Array<Filter<OP> | ComplexFilter<OP>>;\n};\n\nexport type SearchResponse<T = any> = {\n  took: number;\n  timed_out: boolean;\n  _scroll_id?: string;\n  _shards: unknown;\n  hits: {\n    total: {\n      value: number;\n      relation: 'eq' | 'gte';\n    };\n    max_score: number;\n    hits: Array<{\n      _index: string;\n      _type: string;\n      _id: string;\n      _score: number;\n      _source?: T;\n      _version?: number;\n      _explanation?: unknown;\n      fields?: any;\n      highlight?: any;\n      inner_hits?: any;\n      matched_queries?: string[];\n      sort?: Array<string | number>;\n    }>;\n  };\n  aggregations?: { [aggName: string]: object };\n};\n\n///////////////////////////////////////////////////////\n// Search\n///////////////////////////////////////////////////////\n\nexport const FILTER_RANGE_SEPARATOR = '__';\n\nexport enum SortOrder {\n  asc = 'asc',\n  desc = 'desc',\n}\n\nexport type SortFilter = {\n  fieldId: string;\n  order: SortOrder;\n};\n\nexport type BaseSearchRequest = {\n  fullText?: string;\n  limit: number;\n  query?: ComplexFilter<ElasticsearchOperator>;\n  sortBy?: SortFilter[];\n};\n\ntype InfiniteSearchRequest = {\n  infinite: true;\n  nextToken?: string;\n};\n\ntype PaginatedSearchRequest = {\n  infinite?: false;\n  offset?: number;\n};\n\nexport type SearchRequest = {\n  fullText?: string;\n  limit: number;\n  query?: ComplexFilter<ElasticsearchOperator>;\n  geoFilters?: GeoFilter[];\n  sortBy?: SortFilter[];\n} & (InfiniteSearchRequest | PaginatedSearchRequest);\n\nexport type GlobalSearchRequest = {\n  fullText: string;\n  limit: number;\n} & {\n  entityIds: BusinessEntityIds[];\n} & (InfiniteSearchRequest | PaginatedSearchRequest);\n\nexport type GlobalSearchResult = {\n  businessEntityId: BusinessEntityIds;\n  recordId: string;\n  title: string;\n  description: string;\n  tags?: string[];\n};\n\nexport type GlobalSearchByIdRequest = {\n  ids: {\n    businessEntityId: BusinessEntityIds;\n    recordId: string;\n  }[];\n};\n\nexport type PublicSearchRequest = {\n  limit: number;\n  offset?: number;\n  query?: ComplexFilter;\n  sortBy?: SortFilter[];\n};\n\n///////////////////////////////////////////////////////\n// Aggregations\n///////////////////////////////////////////////////////\n\nexport type AggFilterOperator =\n  | ElasticsearchOperator.is\n  | ElasticsearchOperator.greaterThan\n  | ElasticsearchOperator.lessThan\n  | ElasticsearchOperator.greaterThanOrEqual\n  | ElasticsearchOperator.lessThanEqual;\n\nexport enum AggregationType {\n  term = 'TERM',\n  range = 'RANGE',\n}\n\nexport type TermAggregation = {\n  titles: MultiLangValue & { [local in (typeof SUPPORTED_LANGUAGES)[number]]: string };\n  fieldId: string;\n  type: AggregationType.term;\n\n  orderBy?: 'count' | 'field';\n} & (\n  | {\n      fieldType: FieldTypes.picklist;\n      picklistId: string;\n    }\n  | {\n      fieldType: FieldTypes.number;\n      meta?: NumberMeta;\n    }\n  | {\n      fieldType: Exclude<FieldTypes, FieldTypes.picklist | FieldTypes.number>;\n    }\n);\n\nexport type Range =\n  | {\n      start: number;\n      end?: number;\n    }\n  | {\n      start?: number;\n      end: number;\n    }\n  | {\n      start: number;\n      end: number;\n    };\n\nexport type RangeAggregation = {\n  titles: MultiLangValue & { [local in (typeof SUPPORTED_LANGUAGES)[number]]: string };\n  fieldId: string;\n  type: AggregationType.range;\n  step: number;\n  ranges: Range[];\n  format?: NumberMeta;\n};\n\nexport type Aggregation = TermAggregation | RangeAggregation;\n\nexport type AggregationRequest = {\n  fullText?: string;\n  filters: ComplexFilter<AggFilterOperator>[];\n  geoFilters?: GeoFilter[];\n};\n\nexport type AggregationResult = {\n  value: string;\n  count: number;\n  from?: number;\n  to?: number;\n};\n\nexport type AggregationResultSet = {\n  [field: string]: AggregationResult[];\n};\n\nexport type AggregationResponse<M = {}> = {\n  results: AggregationResultSet;\n  meta: M;\n};\n"]}

package/lib/utils.d.ts

@@ -0,0 +1,47 @@
+import { AdHocPicklistValueDisplay } from './picklists.js';
+import { MultiLangValue } from './types.js';
+export type CountryInfo = {
+    code: string;
+    name: string;
+    labels: {
+        city: string;
+        state: string;
+        postalCode?: string;
+    };
+    required: {
+        city: boolean;
+        state: boolean;
+        postalCode: boolean;
+    };
+    dialCode: number;
+    currencyCode: string;
+    states?: {
+        [code: string]: string;
+    };
+    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;
+    actions: string[];
+};
+export declare enum PricePercentageMode {
+    CURRENCY = "currency",
+    PERCENTAGE = "percentage"
+}
+//# sourceMappingURL=utils.d.ts.map

package/lib/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"/","sources":["utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,yBAAyB,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAE5C,MAAM,MAAM,WAAW,GAAG;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE;QACN,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,EAAE,MAAM,CAAC;QACd,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB,CAAC;IACF,QAAQ,EAAE;QACR,IAAI,EAAE,OAAO,CAAC;QACd,KAAK,EAAE,OAAO,CAAC;QACf,UAAU,EAAE,OAAO,CAAC;KACrB,CAAC;IACF,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE;QACP,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC;KACxB,CAAC;IACF,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,OAAO,GAAG;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B,YAAY,EAAE,iBAAiB,CAAC;IAChC,cAAc,EAAE,yBAAyB,CAAC;CAC3C,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAC9B,CAAC,gBAAgB,EAAE,MAAM,GAAG;QAC1B,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,cAAc,CAAC;KAC7C,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,UAAU,CAAC,CAAC,EAAE,CAAC,GAAG,SAAS,IAAI;IACzC,MAAM,EAAE,CAAC,CAAC;IACV,IAAI,CAAC,EAAE,CAAC,CAAC;IACT,OAAO,EAAE,MAAM,EAAE,CAAC;CACnB,CAAC;AAEF,oBAAY,mBAAmB;IAC7B,QAAQ,aAAa;IACrB,UAAU,eAAe;CAC1B"}

package/lib/utils.js

@@ -0,0 +1,6 @@
+export var PricePercentageMode;
+(function (PricePercentageMode) {
+    PricePercentageMode["CURRENCY"] = "currency";
+    PricePercentageMode["PERCENTAGE"] = "percentage";
+})(PricePercentageMode || (PricePercentageMode = {}));
+//# sourceMappingURL=utils.js.map

package/lib/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"/","sources":["utils.ts"],"names":[],"mappings":"AAgDA,MAAM,CAAN,IAAY,mBAGX;AAHD,WAAY,mBAAmB;IAC7B,4CAAqB,CAAA;IACrB,gDAAyB,CAAA;AAC3B,CAAC,EAHW,mBAAmB,KAAnB,mBAAmB,QAG9B","sourcesContent":["import { AdHocPicklistValueDisplay } from './picklists.js';\nimport { MultiLangValue } from './types.js';\n\nexport type CountryInfo = {\n  code: string; // code is ISO 3166-1 alpha-2\n  name: string;\n  labels: {\n    city: string;\n    state: string;\n    postalCode?: string;\n  };\n  required: {\n    city: boolean;\n    state: boolean;\n    postalCode: boolean;\n  };\n  dialCode: number;\n  currencyCode: string;\n  states?: {\n    [code: string]: string; // code is ISO 3166-2\n  };\n  postalCodeFormat?: string;\n  postalCodeEx?: string;\n};\n\nexport type Country = {\n  code: string;\n  name: string;\n  dialCode: number;\n};\n\nexport type ReferenceData = {\n  recordTitles: AdHocRecordTitles;\n  picklistTitles: AdHocPicklistValueDisplay;\n};\n\nexport type AdHocRecordTitles = {\n  [businessEntityId: string]: {\n    [recordId: string]: string | MultiLangValue;\n  };\n};\n\nexport type DataRecord<T, M = undefined> = {\n  record: T;\n  meta?: M; // typically ReferenceData\n  actions: string[];\n};\n\nexport enum PricePercentageMode {\n  CURRENCY = 'currency',\n  PERCENTAGE = 'percentage',\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bisondesk/commons-sdk",
-  "version": "1.0.331",
+  "version": "1.0.332",
   "type": "module",
   "scripts": {
     "build": "npx tsc --build tsconfig.deploy.json",

package/src/apis/picklists.ts

@@ -0,0 +1,105 @@
+import fetch, { Response } from 'node-fetch';
+import { XError } from '../errors.js';
+import { cleanHeaders, getAdminAuth } from '../fetch.js';
+import {
+  AdHocPicklistRequest,
+  AdHocPicklistValueDisplay,
+  PicklistOptionsRequest,
+  PicklistValue,
+  PicklistValueRequest,
+  PicklistValueUpdateRequest,
+} from '../picklists.js';
+import { Option } from '../types.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 const getAdhocPicklistDisplayValue = async (
+  requests: PicklistValueRequest[],
+  preferredLang: string,
+  tenantLang: string
+): Promise<AdHocPicklistValueDisplay> => {
+  const auth = await getAdminAuth();
+
+  const req: AdHocPicklistRequest = {
+    preferredLang,
+    requests,
+    tenantLang,
+  };
+
+  const response: Response = await fetch(`${process.env.CORE_API_ORIGIN}/api/picklists/bulk/read`, {
+    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 });
+};

package/src/constants.ts

@@ -70,6 +70,7 @@ export enum BusinessEntityIds {
   VehiclesPriceLists = 'vehicles_price_lists',
   Debtors = 'debtors',
   DocumentDrafts = 'document_drafts',
+  TrackAndTraceDevices = 'track_and_trace_devices',
 }
 
 //

package/src/definitions.ts

@@ -0,0 +1,44 @@
+//
+// These definitions are sent to the UI
+
+import { SUPPORTED_LANGUAGES } from './constants.js';
+import { FieldTypeInfo } from './fields.js';
+import { Aggregation } from './search.js';
+
+//
+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[];

package/src/exact.ts

@@ -14,18 +14,3 @@ export type ExactClientAccount = {
   exactTld: string;
   authenticated: boolean;
 };
-
-// TODO remove once exact-sdk is correctly published
-export type GlAccount = {
-  id: string;
-  code: number;
-  description: string;
-};
-
-export type Journal = {
-  code: string;
-  type: string;
-  glAccountCode: string;
-  glAccountDescription: string;
-  description: string;
-};

package/src/fields.ts

@@ -0,0 +1,123 @@
+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 };