@esolve/ng-esolve-connect 0.20.9 → 0.21.2

package/lib/cart/index.d.ts

@@ -13,3 +13,5 @@ export * from './esolve-cart-stock-item.model';
 export * from './esolve-cart-totals.model';
 export * from './esolve-cart-totals-record.interface';
 export * from './esolve-cart.service';
+export * from './esolve-cart-empty-response.interface';
+export * from './esolve-empty-cart-result.model';

package/lib/category-tree/esolve-category-tree.service.d.ts

@@ -12,6 +12,15 @@ export declare class EsolveCategoryTreeService {
      * Retrieves the category tree from eSolve instance and coverts it to the correct format.
      */
     getCategoryTree(): Observable<EsolveCategoryTreeItem[]>;
+    /**
+     * Retrieve the special tree structure for a specific special from the eSolve
+     * instance and converts it into the correct format
+     *
+     * @param special_id Id of to special to get tree for
+     *
+     * @returns Observable containing special tree data
+     */
+    getSpecialTree(special_id: number): Observable<EsolveCategoryTreeItem[]>;
     /**
      * Retrieve the details of a category tree item from the eSolve instance and
      * converts it to the correct format.

package/lib/locations/esolve-locations.service.d.ts

@@ -18,9 +18,10 @@ export declare class EsolveLocationsService {
      * Set the addresses_id to 0 and the gps coordinates in order to retrieve the locations list when the address isn't
      * yet saved.
      *
-     * @param addresses_id if supplied, the address will be looked up and the latitude and longitude on the address will be used.
+     * @param addresses_id if supplied, the latitude and longitude on the address will be used.
      * @param latitude if supplied and address_id > 0, the value is ignored.
      * @param longitude if supplied and address_id > 0, the value is ignored.
+     *
      * @returns An `Observable` with an array of stock locations
      */
     getStockLocationsGeo(addresses_id?: number, latitude?: number, longitude?: number): Observable<EsolveLocation[]>;

package/lib/shared/errors/esolve-http-error.model.d.ts

@@ -1,6 +1,6 @@
-export declare class EsolveHttpError {
+export declare class EsolveHttpError extends Error {
+    readonly http_error = true;
     type: 'error' | 'exception';
-    message: string;
     error_code: string;
-    constructor(type: 'error' | 'exception', message: string, error_code: string);
+    constructor(type: 'error' | 'exception', code: string, message: string, ...params: any[]);
 }

package/lib/shared/filters/classes/esolve-multiple-select-filter.model.d.ts

@@ -0,0 +1,14 @@
+import { HttpParams } from '@angular/common/http';
+import { EsolveSelectFilter } from '../interfaces';
+export declare class EsolveMultipleSelectFilter implements EsolveSelectFilter {
+    field: string;
+    readonly type = "multiple";
+    options: (string | number)[];
+    private values?;
+    constructor(field: string, options?: (string | number)[]);
+    setValue(values: (string | number)[]): void;
+    toHttpParams(): {
+        [x: string]: string | (string | number)[];
+    };
+    toHttpParams(http_params: HttpParams): HttpParams;
+}

package/lib/shared/filters/classes/esolve-range-filter.model.d.ts

@@ -0,0 +1,18 @@
+import { HttpParams } from '@angular/common/http';
+import { EsolveFilter } from '../interfaces';
+export declare class EsolveRangeFilter implements EsolveFilter {
+    field: string;
+    readonly type = "range";
+    min: number;
+    max: number;
+    options: {
+        min: number;
+        max: number;
+    };
+    constructor(field: string, min?: number, max?: number);
+    setValue(min: number, max: number): void;
+    toHttpParams(): {
+        [x: string]: string | number;
+    };
+    toHttpParams(http_params: HttpParams): HttpParams;
+}

package/lib/shared/filters/classes/esolve-single-select-filter.model.d.ts

@@ -0,0 +1,15 @@
+import { HttpParams } from '@angular/common/http';
+import { EsolveSelectFilter } from '../interfaces';
+export declare class EsolveSingleSelectFilter implements EsolveSelectFilter {
+    field: string;
+    readonly type = "single";
+    options: (string | number)[];
+    private value?;
+    constructor(field: string, options: (string | number)[]);
+    constructor(field: string, value: string | number);
+    setValue(value: string | number): void;
+    toHttpParams(): {
+        [x: string]: string | number;
+    };
+    toHttpParams(http_params: HttpParams): HttpParams;
+}

package/lib/shared/filters/classes/index.d.ts

@@ -0,0 +1,3 @@
+export * from './esolve-multiple-select-filter.model';
+export * from './esolve-range-filter.model';
+export * from './esolve-single-select-filter.model';

package/lib/shared/filters/esolve-filter-factory.d.ts

@@ -0,0 +1,13 @@
+import { HttpParams } from '@angular/common/http';
+import { EsolveMultipleSelectFilter, EsolveRangeFilter, EsolveSingleSelectFilter } from './classes';
+import { EsolveFilter, EsolveFilterDefinitions } from './interfaces';
+export declare namespace EsolveFilterFactory {
+    function createRangeWithValue(field: string, min?: number, max?: number): EsolveRangeFilter;
+    function createSingleSelectWithValue(field: string, value: string | number): EsolveSingleSelectFilter;
+    function createMultipleSelectWithValue(field: string, value: (string | number)[]): EsolveMultipleSelectFilter;
+    function covertFromObj(obj: EsolveFilterDefinitions): EsolveFilter[];
+    function convertToHttpParams(filters: EsolveFilter[]): {
+        [x: string]: string | number | (string | number)[];
+    };
+    function convertToHttpParams(filters: EsolveFilter[], http_params: HttpParams): HttpParams;
+}

package/lib/shared/filters/index.d.ts

@@ -0,0 +1,4 @@
+export * from './classes';
+export * from './interfaces';
+export * from './types';
+export * from './esolve-filter-factory';

package/lib/shared/filters/interfaces/esolve-filter-definitions.interface.d.ts

@@ -0,0 +1,6 @@
+export interface EsolveFilterDefinitions {
+    [x: string]: string | number | (string | number)[] | {
+        min: number;
+        max: number;
+    };
+}

package/lib/shared/filters/interfaces/esolve-filter-record.interface.d.ts

@@ -0,0 +1,5 @@
+import { EsolveFilterType } from '../types';
+export interface EsolveFilterRecord {
+    field: string;
+    type: EsolveFilterType;
+}

package/lib/shared/filters/interfaces/esolve-filter.interface.d.ts

@@ -0,0 +1,10 @@
+import { HttpParams } from '@angular/common/http';
+import { EsolveFilterType } from '../types';
+export interface EsolveFilter {
+    field: string;
+    readonly type: EsolveFilterType;
+    toHttpParams(): {
+        [x: string]: string | number | (string | number)[];
+    };
+    toHttpParams(http_params: HttpParams): HttpParams;
+}

package/lib/shared/filters/interfaces/esolve-range-filter-record.interface.d.ts

@@ -0,0 +1,7 @@
+import { EsolveRangeFilterType } from '../types';
+import { EsolveFilterRecord } from './esolve-filter-record.interface';
+export interface EsolveRangeFilterRecord extends EsolveFilterRecord {
+    type: EsolveRangeFilterType;
+    min: number;
+    max: number;
+}

package/lib/shared/filters/interfaces/esolve-select-filter-record.interface.d.ts

@@ -0,0 +1,6 @@
+import { EsolveSelectFilterType } from '../types';
+import { EsolveFilterRecord } from './esolve-filter-record.interface';
+export interface EsolveSelectFilterRecord extends EsolveFilterRecord {
+    type: EsolveSelectFilterType;
+    values: string[];
+}

package/lib/shared/filters/interfaces/esolve-select-filter.interface.d.ts

@@ -0,0 +1,4 @@
+import { EsolveFilter } from './esolve-filter.interface';
+export interface EsolveSelectFilter extends EsolveFilter {
+    options: (string | number)[];
+}

package/lib/shared/filters/interfaces/index.d.ts

@@ -0,0 +1,6 @@
+export * from './esolve-filter-definitions.interface';
+export * from './esolve-filter-record.interface';
+export * from './esolve-filter.interface';
+export * from './esolve-range-filter-record.interface';
+export * from './esolve-select-filter-record.interface';
+export * from './esolve-select-filter.interface';

package/lib/shared/filters/types/esolve-filter-list.type.d.ts

@@ -0,0 +1,2 @@
+import { EsolveMultipleSelectFilter, EsolveRangeFilter, EsolveSingleSelectFilter } from '../classes';
+export declare type EsolveFilterList = (EsolveRangeFilter | EsolveMultipleSelectFilter | EsolveSingleSelectFilter)[];

package/lib/shared/filters/types/esolve-filter-record-list.type.d.ts

@@ -0,0 +1,2 @@
+import { EsolveRangeFilterRecord, EsolveSelectFilterRecord } from '../interfaces';
+export declare type EsolveFilterRecordList = (EsolveRangeFilterRecord | EsolveSelectFilterRecord)[];

package/lib/shared/filters/types/esolve-filter-type.type.d.ts

@@ -0,0 +1,3 @@
+import { EsolveSelectFilterType } from './esolve-select-filter-type.type';
+import { EsolveRangeFilterType } from './esolve-range-filter-type.type';
+export declare type EsolveFilterType = EsolveSelectFilterType | EsolveRangeFilterType;

package/lib/shared/filters/types/esolve-range-filter-type.type.d.ts

@@ -0,0 +1 @@
+export declare type EsolveRangeFilterType = 'range';

package/lib/shared/filters/types/esolve-select-filter-type.type.d.ts

@@ -0,0 +1 @@
+export declare type EsolveSelectFilterType = 'single' | 'multiple';

package/lib/shared/filters/types/index.d.ts

@@ -0,0 +1,5 @@
+export * from './esolve-filter-list.type';
+export * from './esolve-filter-record-list.type';
+export * from './esolve-filter-type.type';
+export * from './esolve-range-filter-type.type';
+export * from './esolve-select-filter-type.type';

package/lib/stock/classes/esolve-stock-price.model.d.ts

@@ -18,12 +18,15 @@ export declare class EsolveStockPrice {
      * Price with tax and with discounts applied if applicable
      */
     sell_price_with_tax: number;
+    taxed: boolean;
     /**
      * Create stock price instance
+     *
      * @param base_price Price without tax
      * @param base_price_with_tax Price with tax
      * @param sell_price Price without tax and with discounts applied if applicable
      * @param sell_price_with_tax Price with tax and with discounts applied if applicable
+     * @param taxed Whether tax has been applied
      */
     constructor(
     /**
@@ -41,5 +44,5 @@ export declare class EsolveStockPrice {
     /**
      * Price with tax and with discounts applied if applicable
      */
-    sell_price_with_tax?: number);
+    sell_price_with_tax?: number, taxed?: boolean);
 }

package/lib/stock/esolve-stock.service.d.ts

@@ -2,8 +2,9 @@ import { HttpClient } from '@angular/common/http';
 import { Observable } from 'rxjs';
 import { EsolveConnectConfig } from '../esolve-connect.config';
 import { EsolveCustomFields } from '../shared/custom-fields';
+import { EsolveFilterList } from '../shared/filters';
 import { EsolveMediaStockItemList } from './types';
-import { EsolveStockItemOptions, EsolveRecipeStockOptions, EsolveMediaStockItemOptions } from './interfaces';
+import { EsolveStockItemOptions, EsolveRecipeStockOptions, EsolveMediaStockItemOptions, EsolveStockFilterOptions } from './interfaces';
 import { EsolveStockItem, EsolveStockItemList, EsolveRecipeStockItem, EsolveLinkedStockItem, EsolveStockImageCollection } from './classes';
 import * as i0 from "@angular/core";
 export declare class EsolveStockService<T extends EsolveCustomFields = EsolveCustomFields> {
@@ -52,6 +53,7 @@ export declare class EsolveStockService<T extends EsolveCustomFields = EsolveCus
      * @param code Stock item code
      */
     getStockImageCollection(code: string): Observable<EsolveStockImageCollection>;
+    getStockFilters(options: EsolveStockFilterOptions): Observable<EsolveFilterList>;
     /**
      * Processes the eSolve stock item record and converts it to an object.
      *

package/lib/stock/interfaces/esolve-stock-filter-options.interface.d.ts

@@ -0,0 +1,7 @@
+export interface EsolveStockFilterOptions {
+    category_id?: string;
+    subcategory_id?: number;
+    manufacturers_id?: number;
+    ranges_id?: number;
+    fields: string[];
+}

package/lib/stock/interfaces/esolve-stock-item-options.interface.d.ts

@@ -1,3 +1,4 @@
+import { EsolveFilter, EsolveFilterDefinitions } from '../../shared/filters';
 import { EsolveSort } from '../../shared/sort';
 import { EsolveStockSortField } from '../types';
 export interface EsolveStockItemOptions {
@@ -14,4 +15,8 @@ export interface EsolveStockItemOptions {
     search_phrase?: string;
     specials_id?: number;
     sort?: EsolveSort<EsolveStockSortField>;
+    /**
+     * Use an actual list of filter objects OR using a filter definition object
+     */
+    filters?: EsolveFilter[] | EsolveFilterDefinitions;
 }

package/lib/stock/interfaces/index.d.ts

@@ -4,6 +4,7 @@ export * from './esolve-stock-base-record.interface';
 export * from './esolve-stock-item-options.interface';
 export * from './esolve-stock-badge-record.interface';
 export * from './esolve-recipe-item-record.interface';
+export * from './esolve-stock-filter-options.interface';
 export * from './esolve-recipe-stock-options.interface';
 export * from './esolve-linked-stock-record.interface';
 export * from './esolve-stock-group-item-record.interface';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@esolve/ng-esolve-connect",
-  "version": "0.20.9",
+  "version": "0.21.2",
   "description": "An Angular library that speaks to an eSolve instance's API",
   "ng-add": {
     "save": "true"

package/public-api.d.ts

@@ -5,6 +5,7 @@ export * from './lib/shared/esolve-list.model';
 export * from './lib/shared/esolve-result.model';
 export * from './lib/shared/esolve-url-target.type';
 export * from './lib/shared/custom-fields';
+export * from './lib/shared/filters';
 export * from './lib/shared/response';
 export * from './lib/shared/errors';
 export * from './lib/shared/cookie/esolve-cookie.service';