@webitel/ui-sdk 0.1.2 → 0.1.3-vite

package/src/modules/AuditForm/components/questions/options/audit-form-question-options.vue

@@ -0,0 +1,97 @@
+<template>
+  <article class="audit-form-question-options">
+    <div
+      v-if="mode === 'write'"
+      class="audit-form-question-options-write"
+    >
+      <options-write-row
+        v-for="(option, key) of question.options"
+        :key="key"
+        :option="option"
+        :first="key === 0"
+        @update:option="updateQuestion({ path: `options[${key}]`, value: $event })"
+        @delete="deleteQuestionOption({ key })"
+      ></options-write-row>
+      <wt-button
+        class="audit-form-question-options-write__add-button"
+        @click="addQuestionOption"
+      >{{ $t('reusable.add') }}
+      </wt-button>
+    </div>
+    <div
+      v-else-if="mode === 'read'"
+      class="audit-form-question-options-read"
+    >
+      <wt-radio
+        v-for="opt of question.options"
+        :key="opt.score+opt.name"
+        :label="opt.name"
+        :selected="result"
+        :value="opt"
+        @input="emit('change:result', $event)"
+      ></wt-radio>
+    </div>
+    <div v-else>Unknown mode: {{ mode }}</div>
+  </article>
+</template>
+
+<script setup>
+import OptionsWriteRow from './audit-form-question-options-write-row.vue';
+import WtButton from '../../../../../components/wt-button/wt-button.vue';
+import WtRadio from '../../../../../components/wt-radio/wt-radio.vue';
+import updateObject from '../../../../../scripts/updateObject';
+import { generateOption } from '../../../schemas/AuditFormQuestionOptionsSchema';
+
+const props = defineProps({
+  question: {
+    type: Object,
+    required: true,
+  },
+  result: {
+    type: Object,
+  },
+  mode: {
+    // options: ['read', 'write']
+    type: String,
+    default: 'read',
+  },
+});
+
+const emit = defineEmits([
+  'change:question',
+  'change:result',
+]);
+
+function updateQuestion({ path, value }) {
+  emit('change:question', updateObject({ obj: props.question, path, value }));
+}
+
+function addQuestionOption() {
+  const options = [...props.question.options, generateOption()];
+  return updateQuestion({ path: 'options', value: options });
+}
+
+function deleteQuestionOption({ key }) {
+  const options = [...props.question.options];
+  options.splice(key, 1);
+  return updateQuestion({ path: 'options', value: options });
+}
+</script>
+
+<style lang="scss" scoped>
+.audit-form-question-options-write {
+  display: flex;
+  flex-direction: column;
+  gap: var(--spacing-sm);
+
+  &__add-button {
+    align-self: flex-start;
+  }
+}
+
+.audit-form-question-options-read {
+  display: flex;
+  flex-direction: column;
+  gap: var(--spacing-sm);
+}
+</style>

package/src/modules/AuditForm/components/questions/score/__tests__/audit-form-question-score.spec.js

@@ -0,0 +1,30 @@
+import { shallowMount } from '@vue/test-utils';
+import AuditFormQuestionScore from '../audit-form-question-score.vue';
+
+describe('AuditFormQuestionScore', () => {
+  it('renders a component', () => {
+    const wrapper = shallowMount(AuditFormQuestionScore, {
+      props: {
+        question: {
+          min: 0,
+          max: 10,
+        },
+      },
+    });
+    expect(wrapper.isVisible()).toBe(true);
+  });
+  it('emits result change with selected radio score', () => {
+    const min = 8;
+    const wrapper = shallowMount(AuditFormQuestionScore, {
+      props: {
+        question: {
+          min,
+          max: 10,
+        },
+        mode: 'read',
+      },
+    });
+    wrapper.findComponent({ name: 'wt-radio' }).vm.$emit('input');
+    expect(wrapper.emitted()['change:result'][0][0]).toEqual({ score: min });
+  });
+});

package/src/modules/AuditForm/components/questions/score/audit-form-question-score.vue

@@ -0,0 +1,132 @@
+<template>
+  <article class="audit-form-question-score">
+    <div
+      v-if="mode === 'write'"
+      class="audit-form-question-score-write"
+    >
+      <wt-input
+        :value="question.min"
+        :v="v$.question.min"
+        :number-min="0"
+        :number-max="19"
+        :label="$t('reusable.from')"
+        type="number"
+        required
+        @input="updateQuestion({ path: 'min', value: $event })"
+      ></wt-input>
+      <wt-input
+        :value="question.max"
+        :v="v$.question.max"
+        :number-min="1"
+        :number-max="20"
+        :label="$t('reusable.to')"
+        type="number"
+        required
+        @input="updateQuestion({ path: 'max', value: $event })"
+      ></wt-input>
+    </div>
+    <div
+      v-else-if="mode === 'read'"
+      class="audit-form-question-score-read"
+    >
+      <wt-radio
+        v-for="(value) of scoreRange"
+        :key="value"
+        :label="`${value}`"
+        :value="value"
+        :selected="isResult ? result.score : null"
+        @input="emit('change:result', { score: value })"
+      ></wt-radio>
+    </div>
+  </article>
+</template>
+
+<script setup>
+import { useVuelidate } from '@vuelidate/core';
+import { maxValue, minValue, required, integer } from '@vuelidate/validators';
+import { computed, onMounted, toRefs } from 'vue';
+import isEmpty from '../../../../../scripts/isEmpty';
+import updateObject from '../../../../../scripts/updateObject';
+import WtRadio from '../../../../../components/wt-radio/wt-radio.vue';
+import WtInput from '../../../../../components/wt-input/wt-input.vue';
+
+const props = defineProps({
+  question: {
+    type: Object,
+    required: true,
+  },
+  result: {
+    type: Object,
+  },
+  mode: {
+    // options: ['read', 'write']
+    type: String,
+    default: 'read',
+  },
+});
+
+const emit = defineEmits([
+  'change:question',
+  'change:result',
+]);
+
+// is needed for useVuelidate, because props.question/props.result isn't reactive
+const { question } = toRefs(props);
+
+const v$ = useVuelidate(
+  computed(() => (
+    {
+      question: {
+        min: {
+          minValue: minValue(0),
+          maxValue: maxValue(9),
+          required,
+          integer,
+        },
+        max: {
+          minValue: minValue(1),
+          maxValue: maxValue(10),
+          required,
+          integer,
+        },
+      },
+    })),
+  { question },
+  { $autoDirty: true },
+);
+
+const scoreRange = computed(() => {
+  if (props.question.min > props.question.max) return [];
+  const result = [];
+  let i = +props.question.min;
+  do {
+    result.push(i);
+    i += 1;
+  } while (i <= props.question.max);
+  return result;
+});
+
+const isResult = computed(() => !isEmpty(props.result));
+
+function updateQuestion({ path, value }) {
+  emit('change:question', updateObject({ obj: props.question, path, value }));
+}
+
+// init validation
+onMounted(() => v$.value.$touch());
+</script>
+
+<style lang="scss" scoped>
+.audit-form-question-score-write {
+  display: grid;
+  grid-template-columns: 100px 100px;
+  gap: var(--spacing-sm);
+  margin-right: calc(var(--spacing-sm) + 24px); // icon offset
+}
+
+.audit-form-question-score-read {
+  display: flex;
+  flex-wrap: wrap;
+  gap: var(--spacing-sm);
+}
+</style>

package/src/modules/AuditForm/schemas/AuditFormQuestionOptionsSchema.js

@@ -0,0 +1,13 @@
+import { EngineAuditQuestionType } from 'webitel-sdk';
+
+export const generateOption = () => ({
+  name: '',
+  score: 10,
+});
+
+export const generateQuestionOptionsSchema = () => ({
+  type: EngineAuditQuestionType.Option,
+  options: [
+    generateOption(),
+  ],
+});

package/src/modules/AuditForm/schemas/AuditFormQuestionSchema.js

@@ -0,0 +1,8 @@
+import { generateQuestionScoreSchema } from './AuditFormQuestionScoreSchema';
+
+// eslint-disable-next-line import/prefer-default-export
+export const generateQuestionSchema = ({ required = true } = {}) => ({
+  required,
+  question: '',
+  ...generateQuestionScoreSchema(),
+});

package/src/modules/AuditForm/schemas/AuditFormQuestionScoreSchema.js

@@ -0,0 +1,8 @@
+import { EngineAuditQuestionType } from 'webitel-sdk';
+
+// eslint-disable-next-line import/prefer-default-export
+export const generateQuestionScoreSchema = () => ({
+  type: EngineAuditQuestionType.Score,
+  min: 1,
+  max: 5,
+});

package/src/modules/CSVExport/CSVExport.js

@@ -0,0 +1,89 @@
+import { saveAs } from 'file-saver';
+import stringify from 'csv-stringify/lib/sync';
+import { objSnakeToCamel } from '../../scripts/caseConverters';
+
+const cast = {
+  object: (separator) => {
+    const cast = (object) => {
+      if (Array.isArray(object)) {
+        return object.map((item) => cast(item))
+          .join(separator);
+      }
+      return object.name || JSON.stringify(object);
+    };
+    return cast;
+  },
+};
+
+export default class CSVExport {
+  filename = 'export';
+
+  fetchMethod = null;
+
+  downloadProgress = { count: 0 };
+
+  constructor(fetchMethod, { filename }) {
+    if (!fetchMethod) throw new Error('fetch method should be specified!');
+    this.fetchMethod = fetchMethod;
+    this.filename = filename;
+  }
+
+  static _getStringifyOptions() {
+    const defaultOptions = {
+      header: true,
+      delimiter: ',',
+    };
+    const localStorageOptions = JSON.parse(localStorage.getItem('csv-export-options')) || {};
+    return {
+      ...defaultOptions,
+      ...localStorageOptions,
+      cast: {
+        object: cast.object(localStorageOptions.valueDelimiter || ' | '),
+      },
+    };
+  }
+
+  resetProgress() {
+    this.downloadProgress = { count: 0 };
+    this.zippingProgress = { percent: 0 };
+  }
+
+  save(csv) {
+    const blob = new Blob([csv], { type: 'data:text/csv;charset=utf-8' });
+    saveAs(blob, `${this.filename}.csv`);
+  }
+
+  async stringify(params = {}) {
+    let csv = '';
+    let isNext = false;
+    let columns = params?.fields ? objSnakeToCamel(params?.fields) : [];
+    let page = 1;
+
+    do {
+      // eslint-disable-next-line no-await-in-loop
+      const { items, next } = await this.fetchMethod({
+        ...params,
+        page,
+      });
+      if (!columns.length && items.length) columns = Object.keys(items[0]);
+
+      const options = {
+        ...CSVExport._getStringifyOptions(),
+        columns,
+      };
+
+      csv += stringify(items, options);
+      this.downloadProgress.count += items.length;
+
+      isNext = next;
+      page += 1;
+    } while (isNext);
+    return csv;
+  }
+
+  async export(params) {
+    const csv = await this.stringify(params);
+    this.save(csv);
+    this.resetProgress();
+  }
+}

package/src/modules/CSVExport/__tests__/CSVExport.spec.js

@@ -0,0 +1,63 @@
+import { shallowMount } from '@vue/test-utils';
+import * as fileSaver from 'file-saver';
+import stringify from 'csv-stringify/lib/sync';
+import CSVExportMixin from '../mixins/exportCSVMixin';
+import '../../../../tests/mocks/localStorageMock';
+
+jest.mock('csv-stringify/lib/sync');
+jest.mock('file-saver');
+const dataList = [
+  { _isSelected: true, id: 1 },
+  { _isSelected: true, id: 2 },
+  { _isSelected: true, id: 3 },
+];
+
+describe('CSV Export', () => {
+  let wrapper;
+  const Component = {
+    render() {
+    },
+    mixins: [CSVExportMixin],
+    created() {
+      this.initCSVExport(() => ({ items: dataList }), { filename: 'jest' });
+    },
+    data: () => ({ dataList }),
+  };
+
+  it('goes through all important steps to generate and save csv', async () => {
+    wrapper = shallowMount(Component);
+    await wrapper.vm.exportCSV();
+    expect(stringify).toHaveBeenCalled();
+    expect(fileSaver.saveAs).toHaveBeenCalled();
+  });
+
+  it('mixin correctly computes empty export progress from class data', () => {
+    wrapper = shallowMount(Component);
+    expect(wrapper.vm.CSVDownloadProgress).toBe(0);
+  });
+
+  it('computes selected ids and isAnySelected', async () => {
+    wrapper = shallowMount(Component);
+    const selectedIds = [1, 2, 3];
+    expect(wrapper.vm.selectedIds).toEqual(selectedIds);
+    expect(wrapper.vm.isAnySelected).toBe(true);
+  });
+
+  it('correctly generates csv headers from passed fields', async () => {
+    wrapper = shallowMount(Component);
+    const params = { fields: ['id', 'col1', 'columnTwo'] };
+    await wrapper.vm.exportCSV(params);
+    expect(stringify.mock.calls.pop()[1].columns).toEqual(params.fields); // last mock call, 2nd param, columns obj param
+  });
+
+  it('config csv export from localStorage', async () => {
+    wrapper = shallowMount(Component);
+    const csvExportOptions = {
+      header: false,
+      delimiter: ';',
+    };
+    localStorage.setItem('csv-export-options', JSON.stringify(csvExportOptions));
+    await wrapper.vm.exportCSV();
+    expect(stringify.mock.calls.pop()[1]).toMatchObject(csvExportOptions);
+  });
+});

package/src/modules/CSVExport/mixins/exportCSVMixin.js

@@ -0,0 +1,46 @@
+import CSVExport from '../CSVExport';
+
+export default {
+  data: () => ({
+    CSVExport: null,
+  }),
+
+  computed: {
+    isCSVLoading() {
+      return !!this.CSVDownloadProgress;
+    },
+
+    CSVDownloadProgress() {
+      return this.CSVExport ? this.CSVExport.downloadProgress.count : 0;
+    },
+    selectedIds() {
+      return this.dataList
+        .filter((item) => item._isSelected)
+        .map((item) => item.id);
+    },
+    isAnySelected() {
+      return !!this.selectedIds.length;
+    },
+  },
+
+  methods: {
+    initCSVExport(fetchMethod, options) {
+      this.CSVExport = new CSVExport(fetchMethod, options);
+    },
+
+    async exportCSV(exportParams) {
+      const routeQuery = this.$route?.query;
+      const params = {
+        ...exportParams || routeQuery,
+        size: 5000,
+      };
+      if (this.isAnySelected) params.id = this.selectedIds;
+
+      try {
+        await this.CSVExport.export(params);
+      } catch (err) {
+        throw err;
+      };
+    },
+  },
+};

package/src/modules/CardStoreModule/composables/useCardStore.js

@@ -0,0 +1,55 @@
+import { computed } from 'vue';
+import { useStore } from 'vuex';
+import getNamespacedState from '../../../store/helpers/getNamespacedState';
+
+// eslint-disable-next-line import/prefer-default-export
+export const useCardStore = (namespace) => {
+  const store = useStore();
+
+  const cardNamespace = `${namespace}/card`;
+
+  const id = computed(() => getNamespacedState(store.state, cardNamespace).itemId);
+  const itemInstance = computed(() => getNamespacedState(store.state, cardNamespace).itemInstance);
+
+  function loadItem(payload) {
+    return store.dispatch(`${cardNamespace}/LOAD_ITEM`, payload);
+  }
+
+  function addItem(payload) {
+    return store.dispatch(`${cardNamespace}/ADD_ITEM`, payload);
+  }
+
+  function updateItem(payload) {
+    return store.dispatch(`${cardNamespace}/UPDATE_ITEM`, payload);
+  }
+
+  function setId(payload) {
+    return store.dispatch(`${cardNamespace}/SET_ITEM_ID`, payload);
+  }
+
+  function resetState() {
+    return store.dispatch(`${cardNamespace}/RESET_ITEM_STATE`);
+  }
+
+  function setItemProp(payload) {
+    return store.dispatch(`${cardNamespace}/SET_ITEM_PROPERTY`, payload);
+  }
+
+  function deleteItem(payload) {
+    return store.dispatch(`${cardNamespace}/DELETE_ITEM`, payload);
+  }
+
+  return {
+    namespace: cardNamespace,
+    id,
+    itemInstance,
+
+    loadItem,
+    addItem,
+    updateItem,
+    setId,
+    resetState,
+    setItemProp,
+    deleteItem,
+  };
+};

package/src/modules/CardStoreModule/store/CardStoreModule.js

@@ -0,0 +1,84 @@
+import deepCopy from 'deep-copy';
+import set from 'lodash/set';
+import BaseStoreModule from '../../../store/BaseStoreModules/BaseStoreModule';
+
+export default class CardStoreModule extends BaseStoreModule {
+  state = {
+    itemId: 0,
+    itemInstance: {},
+  };
+
+  actions = {
+    SET_PARENT_ITEM_ID: (context, id) => {
+      context.commit('SET_PARENT_ITEM_ID', id);
+    },
+    SET_ITEM_ID: (context, id) => {
+      if (id !== 'new') context.commit('SET_ITEM_ID', id);
+      else context.commit('SET_ITEM_ID', 0);
+    },
+    LOAD_ITEM: async (context) => {
+      if (context.state.itemId) {
+        const item = await context.dispatch('api/GET_ITEM', { context });
+        context.commit('SET_ITEM', item);
+      }
+    },
+    ADD_ITEM: async (context) => {
+      if (!context.state.itemId) {
+        const { id } = await context.dispatch('api/POST_ITEM', { context });
+        await context.dispatch('SET_ITEM_ID', id);
+        context.dispatch('LOAD_ITEM');
+      }
+    },
+    UPDATE_ITEM: async (context) => {
+      await context.dispatch('api/UPD_ITEM', { context });
+      context.dispatch('LOAD_ITEM');
+    },
+    SET_ITEM_PROPERTY: (context, payload) => {
+      context.commit('SET_ITEM_PROPERTY', payload);
+      context.commit('SET_ITEM_PROPERTY', { path: '_dirty', value: true });
+    },
+    RESET_ITEM_STATE: async (context) => {
+      context.commit('RESET_ITEM_STATE');
+    },
+    DELETE_ITEM: async (context, { id }) => {
+      await context.dispatch('api/DELETE_ITEM', {context, id});
+    },
+  };
+
+  mutations = {
+    SET_PARENT_ITEM_ID: (state, id) => {
+      state.parentId = id;
+    },
+    SET_ITEM_ID: (state, id) => {
+      state.itemId = id;
+    },
+    SET_ITEM_PROPERTY: (state, { prop, value, path }) => {
+      if (path) {
+        set(state.itemInstance, path, value);
+      } else {
+        // DEPRECATED, LEGACY CODE
+        state.itemInstance[prop] = value;
+      }
+    },
+    SET_ITEM: (state, item) => {
+      state.itemInstance = item;
+    },
+    RESET_ITEM_STATE: (state) => {
+      Object.assign(state, deepCopy(this.state));
+    },
+  };
+
+  getModule({
+              state = {},
+              ...rest
+            } = {}) {
+    this.state = {
+      ...this.state,
+      ...state,
+    };
+    return super.getModule({
+      ...rest,
+      state: deepCopy(this.state),
+    });
+  }
+}