@esolve/ng-esolve-connect 0.96.0 → 0.97.0

package/index.d.ts

@@ -33,3 +33,4 @@ export * from './lib/wallet';
 export * from './lib/deliveries';
 export * from './lib/competitions';
 export * from './lib/reviews';
+export * from './lib/albums';

package/lib/albums/classes/esolve-album-image-list.model.d.ts

@@ -0,0 +1,4 @@
+import { EsolveList } from '../../shared';
+import { EsolveAlbumImage } from './esolve-album-image.model';
+export declare class EsolveAlbumImageList extends EsolveList<EsolveAlbumImage> {
+}

package/lib/albums/classes/esolve-album-image.model.d.ts

@@ -0,0 +1,30 @@
+import { EsolveAlbumImageRecord } from '../interfaces';
+import { EsolveAlbumImageSize } from '../types';
+export declare class EsolveAlbumImage {
+    id: number;
+    caption: string;
+    private base_image_url;
+    /**
+     * Path to tiny album image
+     */
+    get tiny_image_src(): string;
+    /**
+     * Path to thumbnail album image
+     */
+    get thumbnail_image_src(): string;
+    /**
+     * Path to small album image
+     */
+    get small_image_src(): string;
+    /**
+     * Path to original album image
+     */
+    get original_image_src(): string;
+    constructor(record?: Partial<EsolveAlbumImageRecord>);
+    /**
+     * Generate a string representing the path to the image with the specified size.
+     *
+     * @param image_size
+     */
+    getImagePath(image_size: EsolveAlbumImageSize): string;
+}

package/lib/albums/classes/esolve-album-list.model.d.ts

@@ -0,0 +1,4 @@
+import { EsolveList } from '../../shared';
+import { EsolveAlbum } from './esolve-album.model';
+export declare class EsolveAlbumList extends EsolveList<EsolveAlbum> {
+}

package/lib/albums/classes/esolve-album.model.d.ts

@@ -0,0 +1,9 @@
+import { EsolveAlbumRecord } from '../interfaces';
+export declare class EsolveAlbum {
+    id: number;
+    identifier: string;
+    description: string;
+    media_identifier: string;
+    cover_image_url: string;
+    constructor(record?: Partial<EsolveAlbumRecord>);
+}

package/lib/albums/classes/index.d.ts

@@ -0,0 +1,4 @@
+export * from './esolve-album-image-list.model';
+export * from './esolve-album-image.model';
+export * from './esolve-album-list.model';
+export * from './esolve-album.model';

package/lib/albums/index.d.ts

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

package/lib/albums/interfaces/esolve-album-image-options.interface.d.ts

@@ -0,0 +1,6 @@
+export interface EsolveAlbumImageOptions {
+    albums_id?: number;
+    identifier?: string;
+    page?: number;
+    rows?: number;
+}

package/lib/albums/interfaces/esolve-album-image-record.interface.d.ts

@@ -0,0 +1,5 @@
+export interface EsolveAlbumImageRecord {
+    id: number;
+    caption: string;
+    image_url: string;
+}

package/lib/albums/interfaces/esolve-album-options.interface.d.ts

@@ -0,0 +1,6 @@
+export interface EsolveAlbumOptions {
+    albums_id?: number;
+    identifier?: string;
+    page?: number;
+    rows?: number;
+}

package/lib/albums/interfaces/esolve-album-record.interface.d.ts

@@ -0,0 +1,7 @@
+export interface EsolveAlbumRecord {
+    id: number;
+    identifier: string;
+    description: string;
+    media_identifier: string;
+    image_url: string;
+}

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

@@ -0,0 +1,4 @@
+export * from './esolve-album-image-options.interface';
+export * from './esolve-album-image-record.interface';
+export * from './esolve-album-options.interface';
+export * from './esolve-album-record.interface';

package/lib/albums/services/esolve-albums.service.d.ts

@@ -0,0 +1,47 @@
+import { Observable } from 'rxjs';
+import { EsolveAlbum, EsolveAlbumImageList, EsolveAlbumList } from '../classes';
+import { EsolveAlbumImageOptions, EsolveAlbumOptions } from '../interfaces';
+import * as i0 from "@angular/core";
+export declare class EsolveAlbumsService {
+    private readonly http;
+    private readonly config;
+    /**
+     * Retrieve a album based on its ID.
+     *
+     * @param album_id - number that represents the unique id of a album.
+     *
+     * @returns an Observable of type EsolveAlbum
+     */
+    getAlbum(albums_id: number): Observable<EsolveAlbum>;
+    /**
+     * Retrieves a album based on its identifier.
+     *
+     * @param identifier - string that represents the identifier of the album.
+     *
+     * @returns an Observable of type EsolveAlbum.
+     */
+    getAlbumFromIdentifier(identifier: string): Observable<EsolveAlbum>;
+    /**
+     * Retrieve a list of albums based on the provided options
+     *
+     * @param options - Optional options for filtering albums
+     *
+     * @returns an Observable of type EsolveAlbumList.
+     */
+    getAlbums(options?: EsolveAlbumOptions): Observable<EsolveAlbumList>;
+    /**
+     * Retrieve a list of album images based on the provided options
+     *
+     * @param options - Optional options for filtering album images
+     *
+     * @returns an Observable of type EsolveAlbumImageList.
+     */
+    getAlbumImages(options: EsolveAlbumImageOptions): Observable<EsolveAlbumImageList>;
+    private getAlbumSingle;
+    private getAlbumsStream;
+    private processAlbums;
+    private processAlbum;
+    private processAlbumImages;
+    static ɵfac: i0.ɵɵFactoryDeclaration<EsolveAlbumsService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<EsolveAlbumsService>;
+}

package/lib/albums/services/index.d.ts

@@ -0,0 +1 @@
+export * from './esolve-albums.service';

package/lib/albums/types/esolve-album-image-size.type.d.ts

@@ -0,0 +1 @@
+export type EsolveAlbumImageSize = 'tiny' | 'thumb' | 'small' | 'original';

package/lib/albums/types/index.d.ts

@@ -0,0 +1 @@
+export * from './esolve-album-image-size.type';

package/lib/stock/classes/esolve-stock-item-base.model.d.ts

@@ -5,7 +5,6 @@ import { EsolveManufacturer } from '../../manufacturers';
 import { EsolveRange } from '../../ranges';
 import { EsolveTag } from '../../tags';
 import { EsolveTopic } from '../../topics';
-import { EsolveReviewReport } from '../../reviews';
 import { EsolveStockImageSize, EsolveStockUnitOfMeasure } from '../types';
 import { EsolveStockBaseRecord, EsolveStockCartParameter } from '../interfaces';
 import { EsolveStockBadge } from './esolve-stock-badge.model';
@@ -13,6 +12,7 @@ import { EsolveStockPrice } from './esolve-stock-price.model';
 import { EsolveColour } from './esolve-colour.model';
 import { EsolveStockLeadTimes } from './esolve-stock-lead-times.model';
 import { EsolveStockTransactionHistory } from './esolve-stock-transaction-history.model';
+import { EsolveStockReviewsReport } from './esolve-stock-reviews-report.model';
 export declare class EsolveStockItemBase<T extends EsolveCustomFields = EsolveCustomFields> implements EsolveSeoDetails {
     /**
      * eSolve Generated ID
@@ -229,7 +229,7 @@ export declare class EsolveStockItemBase<T extends EsolveCustomFields = EsolveCu
     video_embed?: string;
     three_d_embed?: string;
     additional_data?: any;
-    reviews_report?: EsolveReviewReport;
+    reviews_report?: EsolveStockReviewsReport;
     /**
      * Image filename
      */

package/lib/stock/classes/esolve-stock-reviews-report.model.d.ts

@@ -0,0 +1,13 @@
+import { EsolveStockReviewsReportRecord } from '../interfaces';
+export declare class EsolveStockReviewsReport {
+    /** Average review rating */
+    average_rating: number;
+    /** Total number of times reviewed */
+    total_user_reviews: number;
+    /**
+     * Create instance of reviews report
+     *
+     * @param record
+     */
+    constructor(record?: Partial<EsolveStockReviewsReportRecord>);
+}

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

@@ -15,3 +15,4 @@ export * from './esolve-stock-image.model';
 export * from './esolve-stock-image-collection.model';
 export * from './esolve-additional-stock-image.model';
 export * from './esolve-set-notify-result.model';
+export * from './esolve-stock-reviews-report.model';

package/lib/stock/interfaces/esolve-stock-base-record.interface.d.ts

@@ -4,12 +4,12 @@ import { EsolveManufacturerRecord } from '../../manufacturers';
 import { EsolveRangeRecord } from '../../ranges';
 import { EsolveTagRecord } from '../../tags';
 import { EsolveTopicRecord } from '../../topics';
-import { EsolveReviewReport } from '../../reviews';
 import { EsolveStockUnitOfMeasure } from '../types';
 import { EsolveStockBadgeRecord } from './esolve-stock-badge-record.interface';
 import { EsolveColourRecord } from './esolve-colour-record.interface';
 import { EsolveStockLeadTimesRecord } from './esolve-stock-lead-times-record.interface';
 import { EsolveStockCartParameter } from './esolve-stock-cart-parameter.interface';
+import { EsolveStockReviewsReportRecord } from './esolve-stock-reviews-report-record.interface';
 export interface EsolveStockBaseRecord<T extends EsolveCustomFields = EsolveCustomFields> {
     id: number;
     code: string;
@@ -80,5 +80,5 @@ export interface EsolveStockBaseRecord<T extends EsolveCustomFields = EsolveCust
     video_embed?: string;
     three_d_embed?: string;
     additional_data?: any;
-    reviews_report?: EsolveReviewReport;
+    reviews_report?: EsolveStockReviewsReportRecord;
 }

package/lib/stock/interfaces/esolve-stock-reviews-report-record.interface.d.ts

@@ -0,0 +1,4 @@
+export interface EsolveStockReviewsReportRecord {
+    average_score: number;
+    total_user_reviews: number;
+}

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

@@ -14,3 +14,4 @@ export * from './esolve-additional-stock-image-record.interface';
 export * from './esolve-media-stock-item-options.interface';
 export * from './esolve-dependant-item-record.interface';
 export * from './esolve-stock-cart-parameter.interface';
+export * from './esolve-stock-reviews-report-record.interface';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@esolve/ng-esolve-connect",
-  "version": "0.96.0",
+  "version": "0.97.0",
   "homepage": "https://www.esolve.co.za/",
   "description": "An Angular library that speaks to an eSolve instance's API",
   "peerDependencies": {