@esolve/ng-esolve-connect 0.10.2 → 0.11.0

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

@@ -1,9 +1,9 @@
 import { HttpClient } from '@angular/common/http';
 import { Observable } from 'rxjs';
-import { CookieService } from 'ngx-cookie-service';
 import { EsolveConnectConfig } from '../esolve-connect.config';
 import { EsolveSessionService } from '../session/esolve-session.service';
 import { EsolveErrorHandlerService } from '../shared/error-handler/esolve-error-handler.service';
+import { EsolveCookieService } from '../shared/cookie/esolve-cookie.service';
 import * as i0 from "@angular/core";
 interface EsolveAuthResponseData {
     service_type: string;
@@ -23,7 +23,7 @@ export declare class EsolveAuthService {
     private session;
     private errorHandler;
     private cookieService;
-    constructor(config: EsolveConnectConfig, http: HttpClient, session: EsolveSessionService, errorHandler: EsolveErrorHandlerService, cookieService: CookieService);
+    constructor(config: EsolveConnectConfig, http: HttpClient, session: EsolveSessionService, errorHandler: EsolveErrorHandlerService, cookieService: EsolveCookieService);
     getAccessToken(email: string, password: string, anonymous?: boolean): Observable<EsolveAuthResponseData>;
     autoLogin(): void;
     login(email: string, password: string): Observable<number>;

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

@@ -17,11 +17,13 @@ export declare class EsolveCartService {
     constructor(config: EsolveConnectConfig, http: HttpClient, errorHandler: EsolveErrorHandlerService, responseHandler: EsolveResponseHandlerService);
     /**
      * Retrieves the current cart
+     *
      * @returns An `Observable` with an array of cart items
      */
     getCart(): Observable<EsolveCart>;
     /**
      * Updates the cart by preforming various actions, such as adding, editing or removing items from the cart.
+     *
      * @param items An array of options to update the cart
      * @param action The default action to preform
      * @returns An `Observable` with an array of responses that gives feedback on the requested changes
@@ -29,16 +31,19 @@ export declare class EsolveCartService {
     setCart(items: EsolveCartSetItem[], action?: EsolveCartSetAction): Observable<EsolveCartItemResponse[]>;
     /**
      * Retrieves the totals of the cart with all the totals calculated
+     *
      * @returns An `Observable` with an object containing cart totals
      */
     getTotals(): Observable<EsolveCartTotals>;
     /**
      * Retrieves a tracking code for the cart
+     *
      * @returns An `Observable` with the cart tracking code
      */
     getTrackingCode(): Observable<number>;
     /**
      * Initiates checkout of the cart items
+     *
      * @param type The cart type that needs to be checked out
      * @param addresses_id The ID of the delivery address
      * @param shipping_id The ID of the shipping method
@@ -49,13 +54,15 @@ export declare class EsolveCartService {
      */
     checkout(type: 'order' | 'quote', addresses_id: number, shipping_id: number, payment_method_id?: number, location_id?: number, comments?: string): Observable<EsolveCheckoutResult>;
     /**
-     * Processes the eSolve tree records.
+     * Processes the eSolve tree records
+     *
      * @param cart_item_records Records to process
      * @returns An array of processed cart items
      */
     private processCart;
     /**
      * Processes the eSolve cart totals
+     *
      * @param record Data to process
      * @returns Processed cart totals
      */

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

@@ -13,12 +13,15 @@ export declare class EsolveCategoryTreeService {
      */
     getCategoryTree(): Observable<EsolveCategoryTreeItem[]>;
     /**
-     * Retrieve the details of a category tree item from the eSolve instance and converts it to the correct format.
+     * Retrieve the details of a category tree item from the eSolve instance and
+     * converts it to the correct format.
+     *
      * @param options Filter options
      */
     getCategoryTreeItem(options: EsolveCategoryTreeItemOptions): Observable<EsolveCategoryTreeItem>;
     /**
      * Processes the eSolve tree records and converts them into the correct format.
+     *
      * @param tree_records Records to process
      */
     private processTree;

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

@@ -9,11 +9,13 @@ export declare class EsolveLocationsService {
     constructor(config: EsolveConnectConfig, http: HttpClient);
     /**
      * Retrieves a list of stock locations
+     *
      * @returns An `Observable` with an array of stock locations
      */
     getStockLocations(): Observable<EsolveStockLocation[]>;
     /**
      * Processes the eSolve stock location records.
+     *
      * @param records Records to process
      * @returns An array of processed stock location records
      */

package/lib/media/esolve-heading-record.d.ts

@@ -0,0 +1,5 @@
+export interface EsolveHeadingRecord {
+    id: number;
+    identifier: string;
+    value: string;
+}

package/lib/media/esolve-heading.d.ts

@@ -0,0 +1,5 @@
+export declare class EsolveHeading {
+    identifier: string;
+    value: string;
+    constructor(identifier: string, value: string);
+}

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

@@ -2,25 +2,46 @@ import { HttpClient } from '@angular/common/http';
 import { Observable } from 'rxjs';
 import { EsolveConnectConfig } from '../esolve-connect.config';
 import { EsolveMediaArticle } from './esolve-media-article';
+import { EsolveHeading } from './esolve-heading';
 import * as i0 from "@angular/core";
 export declare class EsolveMediaService {
     private config;
     private http;
     constructor(config: EsolveConnectConfig, http: HttpClient);
     /**
-     * Retrieves the media record from the eSolve instance using the identifier.
-     * @param identifier String representing the eSolve media indentifier
+     * Retrieves the media record from the eSolve instance using the identifier
+     *
+     * @param identifier String representing the eSolve media identifier
      */
     getMediaArticle(identifier: string): Observable<EsolveMediaArticle>;
     /**
-     * Retrieves a group of media records from the eSolve instance linked to a group.
+     * Retrieves a group of media records from the eSolve instance linked to a group
+     *
      * @param media_group String representing the eSolve media group
      */
     getGroupedMediaArticles(media_group: string): Observable<EsolveMediaArticle[]>;
+    /**
+     * Retrieves the media heading records from the eSolve instance using the identifiers
+     *
+     * @param identifiers Array of strings representing the eSolve heading identifiers
+     */
+    getHeadings(identifiers: string[]): Observable<EsolveHeading[]>;
+    /**
+     * Processes media article record
+     *
+     * @param record Record from eSolve instance
+     */
     private processMediaRecord;
+    /**
+     * Processes media heading record
+     *
+     * @param record Record from eSolve instance
+     */
+    private processHeadingRecord;
     /**
      * Retrieves media records from eSolve instance.
-     * @param params Header params
+     *
+     * @param params HTTP params
      */
     private getMediaRecords;
     static ɵfac: i0.ɵɵFactoryDeclaration<EsolveMediaService, never>;

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

@@ -10,11 +10,11 @@ export declare class EsolveNewsService {
     private config;
     private http;
     constructor(config: EsolveConnectConfig, http: HttpClient);
-    private getNewsRecords;
     getNewsArticle(identifier: string): Observable<EsolveNewsArticle>;
     getNewsArticles(options: EsolveNewsArticleOptions): Observable<EsolveNewsArticleList>;
     getNewsGroups(): Observable<EsolveNewsGroup[]>;
     private processNewsArticle;
+    private getNewsRecords;
     static ɵfac: i0.ɵɵFactoryDeclaration<EsolveNewsService, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<EsolveNewsService>;
 }

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

@@ -17,19 +17,6 @@ export declare class EsolvePaymentService {
     private errorHandler;
     private responseHandler;
     constructor(config: EsolveConnectConfig, http: HttpClient, errorHandler: EsolveErrorHandlerService, responseHandler: EsolveResponseHandlerService);
-    /**
-     * Processes the eSolve payment method records.
-     * @param records Records to process
-     * @returns An array of processed payment methods.
-     */
-    private processPaymentMethods;
-    /**
-     * Processes the eSolve vault records.
-     * @param records Records to process
-     * @returns An array of processed vault items (a.k.a. cards)
-     */
-    private processVaultItems;
-    private generateExpiry;
     /**
      * Retrieves a list of payment methods.
      * @param options Filter options
@@ -51,13 +38,28 @@ export declare class EsolvePaymentService {
     setVaultItem(payment_methods_id: number, card_data: EsolveCardData): Observable<EsolveVaultItemResult>;
     deleteVaultItem(id: number): Observable<EsolveResult>;
     /**
-     * Sets the payment for the specified transaction using selected payment method.
+     * Sets the payment for the specified transaction using selected payment
+     * method.
+     *
      * @param transaction_id eSolve ID to the transaction
      * @param payment_methods_id eSolve ID to the selected payment method
      * @param card ID of selected card from the vault or information to a brand new card
      * @returns An `Observable` with the result of the payment
      */
     setPayment(transaction_id: number, payment_methods_id: number, card: EsolveCardData | number): Observable<EsolvePaymentResult>;
+    /**
+     * Processes the eSolve payment method records.
+     * @param records Records to process
+     * @returns An array of processed payment methods.
+     */
+    private processPaymentMethods;
+    /**
+     * Processes the eSolve vault records.
+     * @param records Records to process
+     * @returns An array of processed vault items (a.k.a. cards)
+     */
+    private processVaultItems;
+    private generateExpiry;
     static ɵfac: i0.ɵɵFactoryDeclaration<EsolvePaymentService, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<EsolvePaymentService>;
 }

package/lib/session/esolve-session.d.ts

@@ -1,9 +1,8 @@
 export declare class EsolveSession {
     id: number;
-    private _key;
-    private _key_expiration_date?;
-    constructor(id?: number, _key?: string, _key_expiration_date?: Date | undefined);
-    get key(): string;
+    readonly key: string;
+    readonly expiration_date?: Date | undefined;
+    constructor(id?: number, key?: string, expiration_date?: Date | undefined);
     get expired(): boolean;
     get authenticated(): boolean;
     get valid(): boolean;

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

@@ -1,15 +1,19 @@
 import { Observable } from 'rxjs';
+import { EsolveCookieService } from '../shared/cookie/esolve-cookie.service';
 import { EsolveConnectConfig } from '../esolve-connect.config';
 import { EsolveSession } from './esolve-session';
 import * as i0 from "@angular/core";
 export declare class EsolveSessionService {
+    private platformId;
     private config;
+    private cookieService;
+    session: Observable<EsolveSession>;
+    private _session;
     private key_expiration_timer;
     private storage_key;
-    private _session;
-    session: Observable<EsolveSession>;
+    private is_browser;
     get currentSession(): EsolveSession;
-    constructor(config: EsolveConnectConfig);
+    constructor(platformId: Object, config: EsolveConnectConfig, cookieService: EsolveCookieService);
     private setStorageKey;
     private startTimer;
     clearTimer(): void;

package/lib/session/esolve-stored-session.d.ts

@@ -1,5 +1,5 @@
 export interface EsolveStoredSession {
     id: number;
-    _key: string;
-    _key_expiration_date: string;
+    key: string;
+    expiration_date: string;
 }

package/lib/shared/cookie/esolve-cookie.service.d.ts

@@ -0,0 +1,36 @@
+import { Request, Response } from 'express';
+import { CookieService } from 'ngx-cookie-service';
+import * as i0 from "@angular/core";
+export declare class EsolveCookieService {
+    private ngxCookies;
+    private platformId;
+    private request;
+    private response;
+    private is_browser;
+    constructor(ngxCookies: CookieService, platformId: Object, request: Request, response: Response);
+    check(name: string): boolean;
+    get(name: string): string;
+    set(name: string, value: string, expires?: Date, path?: string, domain?: string, secure?: boolean): void;
+    delete(name: string, path?: string, domain?: string, secure?: boolean): void;
+    /**
+     * Get cookie Regular Expression
+     *
+     * @param name Cookie name
+     * @returns property RegExp
+     *
+     * @link https://github.com/stevermeister/ngx-cookie-service/blob/bcb6ac203487c487fcd126896bffaa14981c709c/projects/ngx-cookie-service/src/lib/cookie.service.ts#L31
+     */
+    private getCookieRegExp;
+    /**
+     * Gets the unencoded version of an encoded component of a Uniform Resource Identifier (URI).
+     *
+     * @param encodedURIComponent A value representing an encoded URI component.
+     *
+     * @returns The unencoded version of an encoded component of a Uniform Resource Identifier (URI).
+     *
+     * @link https://github.com/stevermeister/ngx-cookie-service/blob/bcb6ac203487c487fcd126896bffaa14981c709c/projects/ngx-cookie-service/src/lib/cookie.service.ts#L47
+     */
+    private safeDecodeURIComponent;
+    static ɵfac: i0.ɵɵFactoryDeclaration<EsolveCookieService, [null, null, { optional: true; }, { optional: true; }]>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<EsolveCookieService>;
+}

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

@@ -9,6 +9,17 @@ export declare class EsolveShippingService {
     private config;
     private http;
     constructor(config: EsolveConnectConfig, http: HttpClient);
+    /**
+     * Retrieves a list of shipping methods
+     * @returns An `Observable` with an array of shipping methods
+     */
+    getShippingMethods(options?: EsolveShippingMethodOptions): Observable<EsolveShippingMethod[]>;
+    /**
+     * Retrieves the shipping costs
+     * @param options Shipping cost options
+     * @returns An `Observable` with the shipping costs
+     */
+    getShippingCost(shipping_id: number, addresses_id: number, location_id?: number): Observable<EsolveShippingCost>;
     /**
      * Processes the eSolve shipping method records.
      * @param records Records to process
@@ -21,17 +32,6 @@ export declare class EsolveShippingService {
      * @returns Processed shipping costs
      */
     private processShippingCost;
-    /**
-     * Retrieves a list of shipping methods
-     * @returns An `Observable` with an array of shipping methods
-     */
-    getShippingMethods(options?: EsolveShippingMethodOptions): Observable<EsolveShippingMethod[]>;
-    /**
-     * Retrieves the shipping costs
-     * @param options Shipping cost options
-     * @returns An `Observable` with the shipping costs
-     */
-    getShippingCost(shipping_id: number, addresses_id: number, location_id?: number): Observable<EsolveShippingCost>;
     static ɵfac: i0.ɵɵFactoryDeclaration<EsolveShippingService, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<EsolveShippingService>;
 }

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

@@ -27,6 +27,10 @@ export declare class EsolveStockItem implements EsolveSEODetails {
      * Short description of stock item
      */
     description: string;
+    /**
+     * Full description of stock item
+     */
+    extended_description: string;
     /**
      * Active state
      */
@@ -105,6 +109,10 @@ export declare class EsolveStockItem implements EsolveSEODetails {
      * Short description of stock item
      */
     description: string, 
+    /**
+     * Full description of stock item
+     */
+    extended_description: string, 
     /**
      * Active state
      */

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

@@ -12,6 +12,7 @@ export interface EsolveStockRecord {
     seo_page_title: string;
     seo_keywords: string;
     description: string;
+    extended_description: string;
     category_id: string;
     category_description: string;
     subcategory_id: number;

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

@@ -9,16 +9,6 @@ export declare class EsolveStockService {
     private config;
     private http;
     constructor(config: EsolveConnectConfig, http: HttpClient);
-    /**
-     * Processes the eSolve stock item record and converts it to StockItem object.
-     * @param record eSolve stock item record
-     */
-    private processStockItem;
-    /**
-     * Retrieves stock records from HTTP params.
-     * @param params HTTP client parameters
-     */
-    private getStockRecords;
     /**
      * Retrieves the stock record from the eSolve instance using the code.
      * @param code eSolve stock code
@@ -34,6 +24,16 @@ export declare class EsolveStockService {
      * @param options Stock filter options
      */
     getStockItems(options: EsolveStockItemOptions): Observable<EsolveStockItemList>;
+    /**
+     * Processes the eSolve stock item record and converts it to StockItem object.
+     * @param record eSolve stock item record
+     */
+    private processStockItem;
+    /**
+     * Retrieves stock records from HTTP params.
+     * @param params HTTP client parameters
+     */
+    private getStockRecords;
     static ɵfac: i0.ɵɵFactoryDeclaration<EsolveStockService, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<EsolveStockService>;
 }

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "@esolve/ng-esolve-connect",
-  "version": "0.10.2",
+  "version": "0.11.0",
   "description": "An Angular library that speaks to an eSolve instance's API",
   "peerDependencies": {
-    "@angular/common": "^13.0.0",
-    "@angular/core": "^13.0.0",
-    "ngx-cookie-service": "^13.0.0"
+    "@angular/common": ">=12.0.0",
+    "@angular/core": ">=12.0.0",
+    "ngx-cookie-service": "^13.0.0",
+    "@types/express": "^4.17.0"
   },
   "dependencies": {
     "tslib": "^2.3.0"

package/public-api.d.ts

@@ -3,6 +3,7 @@ export { EsolveConnectConfig } from './lib/esolve-connect.config';
 export * from './lib/shared/esolve-list';
 export * from './lib/shared/esolve-result';
 export * from './lib/shared/esolve-response';
+export * from './lib/shared/cookie/esolve-cookie.service';
 export * from './lib/shared/error-handler/esolve-http-error';
 export * from './lib/shared/error-handler/esolve-error-handler.service';
 export * from './lib/shared/response-handler/esolve-response-result';
@@ -26,6 +27,7 @@ export * from './lib/account/esolve-registration-result';
 export * from './lib/account/esolve-change-password-result';
 export * from './lib/account/esolve-reset-password-result';
 export * from './lib/account/esolve-account.service';
+export * from './lib/media/esolve-heading';
 export * from './lib/media/esolve-media-article';
 export * from './lib/media/esolve-media.service';
 export * from './lib/news/esolve-news-group';