@esolve/ng-esolve-connect 0.30.2 → 0.31.0

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

@@ -0,0 +1,19 @@
+import { HttpClient } from '@angular/common/http';
+import { Observable } from 'rxjs';
+import { EsolveResponseHandlerService, EsolveResponseResult } from '../shared/response';
+import { EsolveErrorHandlerService } from '../shared/errors';
+import { EsolveResult } from '../shared/esolve-result.model';
+import { EsolveConnectConfig } from '../esolve-connect.config';
+import * as i0 from "@angular/core";
+export declare class EsolveSessionMetadataService {
+    private config;
+    private http;
+    private errorHandler;
+    private responseHandler;
+    constructor(config: EsolveConnectConfig, http: HttpClient, errorHandler: EsolveErrorHandlerService, responseHandler: EsolveResponseHandlerService);
+    set(type: string, metadata: any): Observable<EsolveResponseResult>;
+    get<T>(type: string): Observable<T>;
+    delete(type: string): Observable<EsolveResult>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<EsolveSessionMetadataService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<EsolveSessionMetadataService>;
+}

package/lib/session/index.d.ts

@@ -2,3 +2,4 @@ export * from './esolve-session.model';
 export * from './esolve-session-data.interface';
 export * from './esolve-stored-session.interface';
 export * from './esolve-session.service';
+export * from './esolve-session-metadata.service';

package/lib/shared/response/esolve-get-response.interface.d.ts

@@ -1,4 +1,4 @@
 import { EsolveResponse } from './esolve-response.interface';
 export interface EsolveGetResponse<T = any> extends EsolveResponse {
-    records?: T;
+    records?: T | never[];
 }

package/media/lib/classes/esolve-media-article.model.d.ts

@@ -1,4 +1,4 @@
-import { EsolveCustomFields, EsolveManufacturer, EsolveRange, EsolveSeoDetails, EsolveSeoInfo, EsolveTag, EsolveTopic } from '@esolve/ng-esolve-connect';
+import { EsolveSeoDetails, EsolveTag, EsolveTopic, EsolveSeoInfo, EsolveManufacturer, EsolveRange, EsolveCustomFields } from '@esolve/ng-esolve-connect';
 import { EsolveMediaRecord } from '../interfaces';
 import { EsolveMediaGroup } from './esolve-media-group.model';
 import { EsolveMediaLayoutSection } from './esolve-media-layout-section.model';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@esolve/ng-esolve-connect",
-  "version": "0.30.2",
+  "version": "0.31.0",
   "description": "An Angular library that speaks to an eSolve instance's API",
   "ng-add": {
     "save": "true"
@@ -47,6 +47,14 @@
       "es2015": "./fesm2015/esolve-ng-esolve-connect-media.mjs",
       "node": "./fesm2015/esolve-ng-esolve-connect-media.mjs",
       "default": "./fesm2020/esolve-ng-esolve-connect-media.mjs"
+    },
+    "./survey": {
+      "types": "./survey/index.d.ts",
+      "esm2020": "./esm2020/survey/esolve-ng-esolve-connect-survey.mjs",
+      "es2020": "./fesm2020/esolve-ng-esolve-connect-survey.mjs",
+      "es2015": "./fesm2015/esolve-ng-esolve-connect-survey.mjs",
+      "node": "./fesm2015/esolve-ng-esolve-connect-survey.mjs",
+      "default": "./fesm2020/esolve-ng-esolve-connect-survey.mjs"
     }
   },
   "sideEffects": false

package/survey/README.md

@@ -0,0 +1,3 @@
+# @esolve/ng-esolve-connect/survey
+
+Secondary entry point of `@esolve/ng-esolve-connect`. It can be used by importing from `@esolve/ng-esolve-connect/survey`.

package/survey/index.d.ts

@@ -0,0 +1,5 @@
+export * from './lib/ng-esolve-connect-survey.module';
+export * from './lib/classes';
+export * from './lib/interfaces';
+export * from './lib/types';
+export * from './lib/services';

package/survey/lib/classes/esolve-survey-answer-result.model.d.ts

@@ -0,0 +1,6 @@
+import { EsolveResponseResult } from '@esolve/ng-esolve-connect';
+import { EsolveSurveyAnswerResponse } from '../interfaces';
+export declare class EsolveSurveyAnswerResult extends EsolveResponseResult {
+    invalid_question_ids?: number[];
+    constructor(response: EsolveSurveyAnswerResponse);
+}

package/survey/lib/classes/esolve-survey-check-question.model.d.ts

@@ -0,0 +1,6 @@
+import { EsolveSurveyValuesQuestionRecord } from '../interfaces';
+import { EsolveSurveyValuesQuestion } from './esolve-survey-values-question.model';
+export declare class EsolveSurveyCheckQuestion extends EsolveSurveyValuesQuestion {
+    readonly type = "check_boxes";
+    constructor(record: EsolveSurveyValuesQuestionRecord);
+}

package/survey/lib/classes/esolve-survey-input-question.model.d.ts

@@ -0,0 +1,6 @@
+import { EsolveSurveyTextQuestionRecord } from '../interfaces';
+import { EsolveSurveyTextQuestion } from './esolve-survey-text-question.model';
+export declare class EsolveSurveyInputQuestion extends EsolveSurveyTextQuestion {
+    readonly type = "input";
+    constructor(record: EsolveSurveyTextQuestionRecord);
+}

package/survey/lib/classes/esolve-survey-options-question.model.d.ts

@@ -0,0 +1,7 @@
+import { EsolveSurveyOption, EsolveSurveyOptionsQuestionRecord } from '../interfaces';
+import { EsolveSurveyQuestion } from './esolve-survey-question.model';
+export declare abstract class EsolveSurveyOptionsQuestion<T extends number | string> extends EsolveSurveyQuestion {
+    options: EsolveSurveyOption<T>[];
+    constructor(record: EsolveSurveyOptionsQuestionRecord);
+    protected abstract processValue(option: number | string): T;
+}

package/survey/lib/classes/esolve-survey-question.model.d.ts

@@ -0,0 +1,11 @@
+import { EsolveSurveyQuestionRecord } from '../interfaces';
+import { EsolveSurveyQuestionType } from '../types';
+export declare abstract class EsolveSurveyQuestion {
+    abstract type: EsolveSurveyQuestionType;
+    id: number;
+    identifier: string;
+    question: string;
+    title: string;
+    description: string;
+    constructor(record: EsolveSurveyQuestionRecord);
+}

package/survey/lib/classes/esolve-survey-radio-question.model.d.ts

@@ -0,0 +1,6 @@
+import { EsolveSurveyValuesQuestionRecord } from '../interfaces';
+import { EsolveSurveyValuesQuestion } from './esolve-survey-values-question.model';
+export declare class EsolveSurveyRadioQuestion extends EsolveSurveyValuesQuestion {
+    readonly type = "radio_boxes";
+    constructor(record: EsolveSurveyValuesQuestionRecord);
+}

package/survey/lib/classes/esolve-survey-rating-question.model.d.ts

@@ -0,0 +1,7 @@
+import { EsolveSurveyOptionsQuestionRecord } from '../interfaces';
+import { EsolveSurveyOptionsQuestion } from './esolve-survey-options-question.model';
+export declare class EsolveSurveyRatingQuestion extends EsolveSurveyOptionsQuestion<number> {
+    readonly type = "rating";
+    constructor(record: EsolveSurveyOptionsQuestionRecord);
+    protected processValue(value: string | number): number;
+}

package/survey/lib/classes/esolve-survey-select-question.model.d.ts

@@ -0,0 +1,7 @@
+import { EsolveSurveyOptionsQuestionRecord } from '../interfaces';
+import { EsolveSurveyOptionsQuestion } from './esolve-survey-options-question.model';
+export declare class EsolveSurveySelectQuestion extends EsolveSurveyOptionsQuestion<string> {
+    readonly type = "select";
+    constructor(record: EsolveSurveyOptionsQuestionRecord);
+    protected processValue(value: string | number): string;
+}

package/survey/lib/classes/esolve-survey-text-question.model.d.ts

@@ -0,0 +1,7 @@
+import { EsolveSurveyTextQuestionRecord } from '../interfaces';
+import { EsolveSurveyQuestion } from './esolve-survey-question.model';
+export declare abstract class EsolveSurveyTextQuestion extends EsolveSurveyQuestion {
+    length: number;
+    placeholder: string;
+    constructor(record: EsolveSurveyTextQuestionRecord);
+}

package/survey/lib/classes/esolve-survey-textarea-question.model.d.ts

@@ -0,0 +1,6 @@
+import { EsolveSurveyTextQuestionRecord } from '../interfaces';
+import { EsolveSurveyTextQuestion } from './esolve-survey-text-question.model';
+export declare class EsolveSurveyTextareaQuestion extends EsolveSurveyTextQuestion {
+    readonly type = "textarea";
+    constructor(record: EsolveSurveyTextQuestionRecord);
+}

package/survey/lib/classes/esolve-survey-values-question.model.d.ts

@@ -0,0 +1,6 @@
+import { EsolveSurveyValuesQuestionRecord } from '../interfaces';
+import { EsolveSurveyQuestion } from './esolve-survey-question.model';
+export declare abstract class EsolveSurveyValuesQuestion extends EsolveSurveyQuestion {
+    values: string[];
+    constructor(record: EsolveSurveyValuesQuestionRecord);
+}

package/survey/lib/classes/esolve-survey.model.d.ts

@@ -0,0 +1,15 @@
+import { EsolveSeoDetails, EsolveSeoInfo } from '@esolve/ng-esolve-connect';
+import { EsolveSurveyRecord } from '../interfaces';
+import { EsolveSurveyType } from '../types';
+import { EsolveSurveyQuestion } from './esolve-survey-question.model';
+export declare class EsolveSurvey implements EsolveSeoDetails {
+    id: number;
+    type: EsolveSurveyType;
+    identifier: string;
+    title: string;
+    description: string;
+    questions: EsolveSurveyQuestion[];
+    seo_details: EsolveSeoInfo;
+    constructor(record: EsolveSurveyRecord);
+    private processQuestions;
+}

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

@@ -0,0 +1,12 @@
+export * from './esolve-survey.model';
+export * from './esolve-survey-question.model';
+export * from './esolve-survey-text-question.model';
+export * from './esolve-survey-values-question.model';
+export * from './esolve-survey-options-question.model';
+export * from './esolve-survey-input-question.model';
+export * from './esolve-survey-textarea-question.model';
+export * from './esolve-survey-check-question.model';
+export * from './esolve-survey-radio-question.model';
+export * from './esolve-survey-rating-question.model';
+export * from './esolve-survey-select-question.model';
+export * from './esolve-survey-answer-result.model';

package/survey/lib/interfaces/esolve-survey-answer-response.interface.d.ts

@@ -0,0 +1,4 @@
+import { EsolvePostResponseItem } from '@esolve/ng-esolve-connect';
+export interface EsolveSurveyAnswerResponse extends EsolvePostResponseItem {
+    invalid_question_ids?: number[];
+}

package/survey/lib/interfaces/esolve-survey-option.interface.d.ts

@@ -0,0 +1,4 @@
+export interface EsolveSurveyOption<T extends number | string> {
+    label: string;
+    value: T;
+}

package/survey/lib/interfaces/esolve-survey-options-question-record.interface.d.ts

@@ -0,0 +1,7 @@
+import { EsolveSurveyOptionsQuestionType } from '../types';
+import { EsolveSurveyOption } from './esolve-survey-option.interface';
+import { EsolveSurveyQuestionRecord } from './esolve-survey-question-record.type';
+export interface EsolveSurveyOptionsQuestionRecord extends EsolveSurveyQuestionRecord {
+    type: EsolveSurveyOptionsQuestionType;
+    options: EsolveSurveyOption<number | string>[];
+}

package/survey/lib/interfaces/esolve-survey-options.interface.d.ts

@@ -0,0 +1,5 @@
+export interface EsolveSurveyOptions {
+    id?: number;
+    identifier?: string;
+    transaction_id?: number;
+}

package/survey/lib/interfaces/esolve-survey-question-record.type.d.ts

@@ -0,0 +1,9 @@
+import { EsolveSurveyQuestionType } from '../types';
+export interface EsolveSurveyQuestionRecord {
+    type: EsolveSurveyQuestionType;
+    id: number;
+    identifier: string;
+    question: string;
+    title: string;
+    description: string;
+}

package/survey/lib/interfaces/esolve-survey-record.interface.d.ts

@@ -0,0 +1,9 @@
+import { EsolveSurveyQuestionRecordList, EsolveSurveyType } from '../types';
+export interface EsolveSurveyRecord {
+    id: number;
+    type: EsolveSurveyType;
+    identifier: string;
+    title: string;
+    description: string;
+    questions: EsolveSurveyQuestionRecordList;
+}

package/survey/lib/interfaces/esolve-survey-text-question-record.interface.d.ts

@@ -0,0 +1,7 @@
+import { EsolveSurveyTextQuestionType } from '../types';
+import { EsolveSurveyQuestionRecord } from './esolve-survey-question-record.type';
+export interface EsolveSurveyTextQuestionRecord extends EsolveSurveyQuestionRecord {
+    type: EsolveSurveyTextQuestionType;
+    length: number;
+    placeholder: string;
+}

package/survey/lib/interfaces/esolve-survey-values-question-record.interface.d.ts

@@ -0,0 +1,6 @@
+import { EsolveSurveyValuesQuestionType } from '../types';
+import { EsolveSurveyQuestionRecord } from './esolve-survey-question-record.type';
+export interface EsolveSurveyValuesQuestionRecord extends EsolveSurveyQuestionRecord {
+    type: EsolveSurveyValuesQuestionType;
+    values: string[];
+}

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

@@ -0,0 +1,8 @@
+export * from './esolve-survey-record.interface';
+export * from './esolve-survey-options-question-record.interface';
+export * from './esolve-survey-question-record.type';
+export * from './esolve-survey-option.interface';
+export * from './esolve-survey-text-question-record.interface';
+export * from './esolve-survey-values-question-record.interface';
+export * from './esolve-survey-options.interface';
+export * from './esolve-survey-answer-response.interface';

package/survey/lib/ng-esolve-connect-survey.module.d.ts

@@ -0,0 +1,7 @@
+import * as i0 from "@angular/core";
+import * as i1 from "@angular/common";
+export declare class NgEsolveConnectSurveyModule {
+    static ɵfac: i0.ɵɵFactoryDeclaration<NgEsolveConnectSurveyModule, never>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<NgEsolveConnectSurveyModule, never, [typeof i1.CommonModule], never>;
+    static ɵinj: i0.ɵɵInjectorDeclaration<NgEsolveConnectSurveyModule>;
+}

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

@@ -0,0 +1,84 @@
+import { HttpClient } from '@angular/common/http';
+import { Observable } from 'rxjs';
+import { EsolveConnectConfig, EsolveErrorHandlerService, EsolveResponseHandlerService } from '@esolve/ng-esolve-connect';
+import { EsolveSurvey, EsolveSurveyAnswerResult } from '../classes';
+import * as i0 from "@angular/core";
+export declare class EsolveSurveyService {
+    private config;
+    private http;
+    private errorHandler;
+    private responseHandler;
+    constructor(config: EsolveConnectConfig, http: HttpClient, errorHandler: EsolveErrorHandlerService, responseHandler: EsolveResponseHandlerService);
+    /**
+     * Get survey from eSolve API
+     *
+     * @param options
+     *
+     * @returns An `Observable` with requested survey
+     */
+    getSurvey(options: {
+        id: number;
+        transaction_id?: number;
+    }): Observable<EsolveSurvey>;
+    getSurvey(options: {
+        identifier: string;
+        transaction_id?: number;
+    }): Observable<EsolveSurvey>;
+    /**
+     * Get survey from eSolve API
+     *
+     * @param id
+     * @param transaction_id
+     *
+     * @returns An `Observable` with requested survey
+     */
+    getSurvey(id: number, transaction_id?: number): Observable<EsolveSurvey>;
+    /**
+     * Get survey from eSolve API
+     *
+     * @param identifier
+     * @param transaction_id
+     *
+     * @returns An `Observable` with requested survey
+     */
+    getSurvey(identifier: string, transaction_id?: number): Observable<EsolveSurvey>;
+    /**
+     * Set the survey answer
+     *
+     * @param data
+     * @param options
+     *
+     * @returns An `Observable` with the result
+     */
+    setSurveyAnswer(data: FormData, options: {
+        id: number;
+        transaction_id?: number;
+    }): Observable<EsolveSurveyAnswerResult>;
+    setSurveyAnswer(data: FormData, options: {
+        identifier: string;
+        transaction_id?: number;
+    }): Observable<EsolveSurveyAnswerResult>;
+    /**
+     * Set the survey answer
+     *
+     * @param data
+     * @param id
+     * @param transaction_id
+     *
+     * @returns An `Observable` with the result
+     */
+    setSurveyAnswer(data: FormData, id: number, transaction_id?: number): Observable<EsolveSurveyAnswerResult>;
+    /**
+     * Set the survey answer
+     *
+     * @param data
+     * @param identifier
+     * @param transaction_id
+     *
+     * @returns An `Observable` with the result
+     */
+    setSurveyAnswer(data: FormData, identifier: string, transaction_id?: number): Observable<EsolveSurveyAnswerResult>;
+    private setParams;
+    static ɵfac: i0.ɵɵFactoryDeclaration<EsolveSurveyService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<EsolveSurveyService>;
+}

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

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

package/survey/lib/types/esolve-survey-options-question-type.type.d.ts

@@ -0,0 +1 @@
+export declare type EsolveSurveyOptionsQuestionType = 'rating' | 'select';

package/survey/lib/types/esolve-survey-question-record-list.type.d.ts

@@ -0,0 +1,2 @@
+import { EsolveSurveyOptionsQuestionRecord, EsolveSurveyTextQuestionRecord, EsolveSurveyValuesQuestionRecord } from '../interfaces';
+export declare type EsolveSurveyQuestionRecordList = (EsolveSurveyTextQuestionRecord | EsolveSurveyOptionsQuestionRecord | EsolveSurveyValuesQuestionRecord)[];

package/survey/lib/types/esolve-survey-question-type.type.d.ts

@@ -0,0 +1,4 @@
+import { EsolveSurveyOptionsQuestionType } from './esolve-survey-options-question-type.type';
+import { EsolveSurveyTextQuestionType } from './esolve-survey-text-question-type.type';
+import { EsolveSurveyValuesQuestionType } from './esolve-survey-values-question-type.type';
+export declare type EsolveSurveyQuestionType = EsolveSurveyTextQuestionType | EsolveSurveyOptionsQuestionType | EsolveSurveyValuesQuestionType;

package/survey/lib/types/esolve-survey-text-question-type.type.d.ts

@@ -0,0 +1 @@
+export declare type EsolveSurveyTextQuestionType = 'input' | 'textarea';

package/survey/lib/types/esolve-survey-type.type.d.ts

@@ -0,0 +1 @@
+export declare type EsolveSurveyType = 'general' | 'anonymous' | 'transaction';

package/survey/lib/types/esolve-survey-values-question-type.type.d.ts

@@ -0,0 +1 @@
+export declare type EsolveSurveyValuesQuestionType = 'check_boxes' | 'radio_boxes';

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

@@ -0,0 +1,6 @@
+export * from './esolve-survey-type.type';
+export * from './esolve-survey-options-question-type.type';
+export * from './esolve-survey-question-type.type';
+export * from './esolve-survey-text-question-type.type';
+export * from './esolve-survey-values-question-type.type';
+export * from './esolve-survey-question-record-list.type';