@wg-npm/survey-service-api 0.1.272 → 0.2.0

package/src/survey-service.ts

@@ -1,124 +1,90 @@
 import {
     PlanModel,
     PlanStatisticsModel,
-    QuestionModel,
+    BaseQuestionModel as QuestionModel,
     ResponseModel,
     ResponseStatisticsModel,
-    SurveyModel,
-    TemplateModel
-} from "@wg-npm/survey-core";
+    SurveyModel
+} from '@wg-npm/survey-core';
 
 export interface SurveyServiceOptions {
-    baseUrl: string
-    version: string
-    httpDecorator: Function
+    baseUrl: string;
+    version: string;
+    httpDecorator: Function;
 }
 
-export interface AsyncSurveyService {
-    loadTemplate(id: string): Promise<TemplateModel>
+export interface SurveyService {
+    loadSurvey(id: string): Promise<SurveyModel>;
 
-    loadTemplates(params: any): Promise<TemplateModel>
+    loadSurveys(params: any): Promise<SurveyModel[]>;
 
-    createTemplate(survey: TemplateModel): Promise<TemplateModel>
+    createSurvey(survey: SurveyModel): Promise<SurveyModel>;
 
-    updateTemplate(survey: TemplateModel): Promise<TemplateModel>
+    updateSurvey(survey: SurveyModel): Promise<SurveyModel>;
 
-    deleteTemplate(id: string): Promise<void>
+    deleteSurvey(id: string): Promise<void>;
 
-    loadSurvey(id: string): Promise<SurveyModel>
+    createQuestion(surveyId: string, question: QuestionModel): Promise<QuestionModel>;
 
-    loadSurveys(params: any): Promise<SurveyModel>
+    createQuestions(surveyId: string, questions: Array<QuestionModel>): Promise<QuestionModel>;
 
-    createSurvey(survey: SurveyModel): Promise<SurveyModel>
+    updateQuestion(surveyId: string, question: QuestionModel): Promise<QuestionModel>;
 
-    updateSurvey(survey: SurveyModel): Promise<SurveyModel>
+    updateQuestionsOptions(surveyId: string, questions: Array<QuestionModel>): Promise<QuestionModel>;
 
-    deleteSurvey(id: string): Promise<void>
+    moveQuestion(surveyId: string, questionId: string, index: number): Promise<void>;
 
-    createQuestion(surveyId: string, question: QuestionModel): Promise<QuestionModel>
+    deleteQuestion(surveyId: string, questionId: string): Promise<void>;
 
-    createQuestions(surveyId: string, questions: Array<QuestionModel>): Promise<QuestionModel>
+    loadResponse(id: string): Promise<ResponseModel>;
 
-    updateQuestion(surveyId: string, question: QuestionModel): Promise<QuestionModel>
+    loadResponses(params: any): Promise<ResponseModel>;
 
-    updateQuestionsOptions(surveyId: string, questions: Array<QuestionModel>): Promise<QuestionModel>
+    loadResponsesPost(params: any): Promise<ResponseModel>;
 
-    moveQuestion(surveyId: string, questionId: string, index: number): Promise<void>
+    dispatchResponse(surveyId: string, response: ResponseModel): Promise<ResponseModel>;
 
-    deleteQuestion(surveyId: string, questionId: string): Promise<void>
+    dispatchResponses(surveyId: string, respondentId: string, targets: Array<string>): Promise<ResponseModel>;
 
-    loadResponse(id: string): Promise<ResponseModel>
+    dispatchResponse(surveyId: string, response: ResponseModel): Promise<ResponseModel>;
 
-    loadResponses(params: any): Promise<ResponseModel>
+    updateResponse(response: ResponseModel): Promise<ResponseModel>;
 
-    loadResponsesPost(params: any): Promise<ResponseModel>
+    loadMyPlans(params: any): Promise<ResponseModel>;
 
-    dispatchResponse(surveyId: string, response: ResponseModel): Promise<ResponseModel>
+    loadPlans(params: any): Promise<PlanModel>;
 
-    dispatchResponses(surveyId: string, respondentId: string, targets: Array<string>): Promise<ResponseModel>
+    loadPlanById(planId: string, params: any): Promise<PlanModel>;
 
-    dispatchResponse(surveyId: string, response: ResponseModel): Promise<ResponseModel>
+    loadPlanWithFiltersById(planId: string, statistics: PlanStatisticsModel): Promise<PlanStatisticsModel>;
 
-    updateResponse(response: ResponseModel): Promise<ResponseModel>
+    loadPlanWithFiltersByIdAndTargetId(planId: string, targetId: string, statistics: PlanStatisticsModel): Promise<PlanStatisticsModel>;
 
-    loadMyPlans(params: any): Promise<ResponseModel>
+    createPlan(plan: PlanModel): Promise<PlanModel>;
 
-    loadPlans(params: any): Promise<PlanModel>
+    updatePlan(plan: PlanModel): Promise<PlanModel>;
 
-    loadPlanById(planId: string, params: any): Promise<PlanModel>
+    deletePlan(id: string): Promise<void>;
 
-    loadPlanWithFiltersById(planId: string, statistics: PlanStatisticsModel): Promise<PlanStatisticsModel>
+    loadStatisticsByAll(surveyId: string, statistics: ResponseStatisticsModel): Promise<ResponseStatisticsModel>;
 
-    loadPlanWithFiltersByIdAndTargetId(planId: string,
-        targetId: string,
-        statistics: PlanStatisticsModel): Promise<PlanStatisticsModel>
+    loadStatisticsBySurvey(surveyId: string, statistics: ResponseStatisticsModel): Promise<ResponseStatisticsModel>;
 
-    createPlan(plan: PlanModel): Promise<PlanModel>
+    loadStatisticsByTargets(surveyId: string, statistics: ResponseStatisticsModel): Promise<ResponseStatisticsModel>;
 
-    updatePlan(plan: PlanModel): Promise<PlanModel>
+    loadStatisticsWithFiltersByAll(surveyId: string, statistics: ResponseStatisticsModel): Promise<ResponseStatisticsModel>;
 
-    deletePlan(id: string): Promise<void>
+    loadStatisticsWithFiltersBySurvey(surveyId: string, statistics: ResponseStatisticsModel): Promise<ResponseStatisticsModel>;
 
-    loadStatisticsByAll(surveyId: string, statistics: ResponseStatisticsModel): Promise<ResponseStatisticsModel>
+    loadStatisticsWithFiltersByTargets(surveyId: string, statistics: ResponseStatisticsModel): Promise<ResponseStatisticsModel>;
 
-    loadStatisticsBySurvey(surveyId: string, statistics: ResponseStatisticsModel): Promise<ResponseStatisticsModel>
+    loadStatisticsBySurveyAndTarget(data: any): Promise<ResponseStatisticsModel>;
 
-    loadStatisticsByTargets(surveyId: string, statistics: ResponseStatisticsModel): Promise<ResponseStatisticsModel>
+    loadRespondents(params: any): Promise<ResponseModel>;
 
-    loadStatisticsWithFiltersByAll(surveyId: string,
-        statistics: ResponseStatisticsModel): Promise<ResponseStatisticsModel>
+    loadRespondentByPlanAndTarget(params: any): Promise<ResponseModel>;
 
-    loadStatisticsWithFiltersBySurvey(surveyId: string,
-        statistics: ResponseStatisticsModel): Promise<ResponseStatisticsModel>
+    get(url: string, params: any): Promise<Object>;
 
-    loadStatisticsWithFiltersByTargets(surveyId: string,
-        statistics: ResponseStatisticsModel): Promise<ResponseStatisticsModel>
-
-    loadStatisticsBySurveyAndTarget(data: any): Promise<ResponseStatisticsModel>
-
-    loadRespondents(params: any): Promise<ResponseModel>
-
-    loadRespondentbyPlanAndTarget(params: any): Promise<ResponseModel>
-
-    loadRespondentbyPlanAndTargetAndRespondentIds(planId: string, targetId: string, respondentIds: Array<number>): Promise<ResponseModel>
-
-    get(url: string, params: any): Promise<Object>
-
-    updatePlanStatistics(params: any): Promise<ResponseStatisticsModel>
-
-    exportPlanStatisticsRawData(params: any): Promise<ResponseStatisticsModel>
+    updatePlanStatistics(params: any): Promise<ResponseStatisticsModel>;
 }
-
-export interface BlockingSurveyService {
-    loadSurvey(id: string): SurveyModel
-
-    createQuestion(surveyId: string, question: QuestionModel): QuestionModel
-
-    updateQuestion(surveyId: string, question: QuestionModel): QuestionModel
-
-    moveQuestion(surveyId: string, questionId: string, index: number): void
-
-    deleteQuestion(surveyId: string, questionId: string): void
-}
-
-

package/types/index.d.ts

@@ -1,28 +1,24 @@
 import _Vue from 'vue';
+import './vue.d.ts';
 import { SurveyModel, QuestionModel } from '@wg-npm/survey-core';
 
 interface SurveyServiceOptions {
-    baseUrl: string;
-    version: string;
+  baseUrl: string;
+  version: string;
 }
-interface AsyncSurveyService {
-    loadSurvey(id: string): Promise<SurveyModel>;
-    createQuestion(surveyId: string, question: QuestionModel): Promise<QuestionModel>;
-    updateQuestion(surveyId: string, question: QuestionModel): Promise<QuestionModel>;
-    moveQuestion(surveyId: string, questionId: string, index: number): Promise<void>;
-    deleteQuestion(surveyId: string, questionId: string): Promise<void>;
-}
-interface BlockingSurveyService {
-    loadSurvey(id: string): SurveyModel;
-    createQuestion(surveyId: string, question: QuestionModel): QuestionModel;
-    updateQuestion(surveyId: string, question: QuestionModel): QuestionModel;
-    moveQuestion(surveyId: string, questionId: string, index: number): void;
-    deleteQuestion(surveyId: string, questionId: string): void;
+
+interface SurveyService {
+  loadSurvey(id: string): Promise<SurveyModel>;
+  loadSurveys(params: any): Promise<SurveyModel[]>;
+  createQuestion(surveyId: string, question: QuestionModel): Promise<QuestionModel>;
+  updateQuestion(surveyId: string, question: QuestionModel): Promise<QuestionModel>;
+  moveQuestion(surveyId: string, questionId: string, index: number): Promise<void>;
+  deleteQuestion(surveyId: string, questionId: string): Promise<void>;
 }
 
 declare class SurveyServiceApiPlugin {
-    static install(Vue: typeof _Vue, options: SurveyServiceOptions): void;
+  static install(Vue: typeof _Vue, options: SurveyServiceOptions): void;
 }
 
 export default SurveyServiceApiPlugin;
-export { AsyncSurveyService, BlockingSurveyService, SurveyServiceOptions };
+export { SurveyService, SurveyServiceOptions };

package/types/vue.d.ts

@@ -1,18 +1,18 @@
-import Vue from 'vue'
-import {AsyncSurveyService, BlockingSurveyService} from "./index";
+import Vue from 'vue';
+import { SurveyService } from './index';
+
+declare module 'vue/types/options' {
+  interface ComponentOptions<V extends Vue> {
+    $surveyService?: SurveyService;
+  }
+}
 
 declare module 'vue/types/vue' {
   interface Vue {
-    $surveyService: AsyncSurveyService;
-    $asyncSurveyService: AsyncSurveyService;
-    $blockingSurveyService: BlockingSurveyService;
+    $surveyService: SurveyService;
   }
-}
 
-declare module 'vue/types/options' {
-  interface ComponentOptions<V extends Vue> {
-    surveyService?: AsyncSurveyService;
-    asyncSurveyService?: AsyncSurveyService;
-    blockingSurveyService?: BlockingSurveyService;
+  interface VueConstructor {
+    $surveyService: SurveyService;
   }
 }