@abyss-project/form 1.0.3 → 1.0.5

package/dist/api/form-submission.api.d.ts

@@ -1,5 +1,6 @@
-import { IArchiveFormSubmissionParams, IArchiveFormSubmissionResponse, IGetFormSubmissionParams, IGetFormSubmissionResponse, IPaginateFormSubmissionParams, IPaginateFormSubmissionQuery, IPaginateFormSubmissionResponse, IUpdateFormSubmissionBody, IUpdateFormSubmissionParams, IUpdateFormSubmissionResponse } from '..';
+import { IArchiveFormSubmissionParams, IArchiveFormSubmissionResponse, IGetFormSubmissionParams, IGetFormSubmissionResponse, IGetNextToReviewFormSubmissionParams, IGetNextToReviewFormSubmissionQuery, IGetNextToReviewFormSubmissionResponse, IPaginateFormSubmissionParams, IPaginateFormSubmissionQuery, IPaginateFormSubmissionResponse, IUpdateFormSubmissionBody, IUpdateFormSubmissionParams, IUpdateFormSubmissionResponse } from '..';
 export declare const getFormSubmission: (params: IGetFormSubmissionParams) => Promise<IGetFormSubmissionResponse>;
+export declare const getNextToReviewFormSubmission: (params: IGetNextToReviewFormSubmissionParams, query: IGetNextToReviewFormSubmissionQuery) => Promise<IGetNextToReviewFormSubmissionResponse>;
 export declare const updateFormSubmission: (params: IUpdateFormSubmissionParams, body: IUpdateFormSubmissionBody) => Promise<IUpdateFormSubmissionResponse>;
 export declare const archiveFormSubmission: (params: IArchiveFormSubmissionParams) => Promise<IArchiveFormSubmissionResponse>;
 export declare const paginateFormSubmission: (params: IPaginateFormSubmissionParams, query: IPaginateFormSubmissionQuery) => Promise<IPaginateFormSubmissionResponse>;

package/dist/api/form-submission.api.js

@@ -1,11 +1,17 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.paginateFormSubmission = exports.archiveFormSubmission = exports.updateFormSubmission = exports.getFormSubmission = void 0;
+exports.paginateFormSubmission = exports.archiveFormSubmission = exports.updateFormSubmission = exports.getNextToReviewFormSubmission = exports.getFormSubmission = void 0;
 const __1 = require("..");
 const getFormSubmission = async (params) => {
     return (await __1.AbyssFormCore.axios.get(`form-submission/${params.formId}/submission/${params.formSubmissionId}`)).data;
 };
 exports.getFormSubmission = getFormSubmission;
+const getNextToReviewFormSubmission = async (params, query) => {
+    return (await __1.AbyssFormCore.axios.get(`form-submission/${params.formId}/submission/next-to-review`, {
+        params: query,
+    })).data;
+};
+exports.getNextToReviewFormSubmission = getNextToReviewFormSubmission;
 const updateFormSubmission = async (params, body) => {
     return (await __1.AbyssFormCore.axios.put(`form-submission/${params.formId}/submission/${params.formSubmissionId}`, body)).data;
 };

package/dist/types/interface/api/requests/form-submission.request.d.ts

@@ -9,6 +9,7 @@ export interface IUpdateFormSubmissionParams {
 }
 export interface IUpdateFormSubmissionBody {
     comment?: string;
+    reviewed?: boolean;
 }
 export interface IGetFormSubmissionParams {
     formId: string;
@@ -18,3 +19,9 @@ export interface IPaginateFormSubmissionParams {
     formId: string;
 }
 export type IPaginateFormSubmissionQuery = QueryPaginate;
+export interface IGetNextToReviewFormSubmissionParams {
+    formId: string;
+}
+export interface IGetNextToReviewFormSubmissionQuery {
+    excludeFormSubmissionId?: string;
+}

package/dist/types/interface/api/requests/form-webhook-history.admin.request.d.ts

@@ -1,7 +1,6 @@
-import * as core from 'express-serve-static-core';
 import { FormWebhookType } from '../../../enum';
 import { QueryPaginate } from '..';
-export interface IGetFormWebhookHistoryAdminParams extends core.ParamsDictionary {
+export interface IGetFormWebhookHistoryAdminParams {
     formWebhookHistoryId: string;
 }
 export type IPaginateFormWebhookHistoryAdminQuery = {

package/dist/types/interface/api/requests/form-webhook-history.request.d.ts

@@ -1,11 +1,10 @@
-import * as core from 'express-serve-static-core';
 import { FormWebhookType } from '../../../enum';
 import { QueryPaginate } from '..';
-export interface IGetFormWebhookHistoryParams extends core.ParamsDictionary {
+export interface IGetFormWebhookHistoryParams {
     formId: string;
     formWebhookHistoryId: string;
 }
-export interface IPaginateFormWebhookHistoryParams extends core.ParamsDictionary {
+export interface IPaginateFormWebhookHistoryParams {
     formId: string;
 }
 export type IPaginateFormWebhookHistoryQuery = {

package/dist/types/interface/api/responses/form-submission.response.d.ts

@@ -12,3 +12,8 @@ export interface IArchiveFormSubmissionData {
     formSubmission: IFormSubmission;
 }
 export type IArchiveFormSubmissionResponse = IResponse<IArchiveFormSubmissionData>;
+export interface IGetNextToReviewFormSubmissionData {
+    formSubmission: IFormSubmission | null;
+    remainingCount: number;
+}
+export type IGetNextToReviewFormSubmissionResponse = IResponse<IGetNextToReviewFormSubmissionData>;

package/dist/types/interface/dto/form.dto.d.ts

@@ -64,6 +64,8 @@ export type FormContentQuestionBaseOptionsDTO = {
     formDocumentIds: string[] | null;
     formCodeBlockIds: string[];
     description: string | null;
+    displayCondition?: FormContentQuestionDisplayConditionDTO;
+    archivedAt?: Date | null;
 };
 export type FormContentQuestionDateOptionsDTO = FormContentQuestionBaseOptionsDTO & {
     type: FormContentQuestionType.DATE;
@@ -135,7 +137,32 @@ export type FormResponseQuestionDTO = {
         language: string;
         content: string;
     } | null;
+    userQuestionRate?: boolean | null;
 };
 export type FormResponseDTO = {
     questions: Record<string, FormResponseQuestionDTO>;
 };
+export type FormContentQuestionDisplayConditionDTO = {
+    shouldDisplay: boolean;
+    conditions: {
+        operator: 'and' | 'or';
+        filters: {
+            questionId: string;
+            number?: {
+                operator?: 'eq' | 'neq' | 'gt' | 'lt' | 'gte' | 'lte';
+                value?: number;
+            } | null;
+            period?: {
+                before?: Date | null;
+                after?: Date | null;
+            } | null;
+            date?: {
+                before?: Date | null;
+                after?: Date | null;
+            } | null;
+            freeText?: {
+                contains?: string | null;
+            };
+        }[];
+    }[];
+};

package/dist/types/interface/models/form-submission.model.d.ts

@@ -14,6 +14,7 @@ export interface IFormSubmission {
     countRestart: number;
     formId: string;
     archivedAt: Date | null;
+    reviewedAt: Date | null;
     updatedAt?: Date;
     createdAt?: Date;
     form: IForm;

package/dist/utils/form.utils.d.ts

@@ -1,5 +1,6 @@
-import { FormContentDTO, FormContentPageDTO, FormContentQuestionBaseOptionsDTO, FormContentQuestionDTO } from '../types';
+import { FormContentDTO, FormContentPageDTO, FormContentQuestionBaseOptionsDTO, FormContentQuestionDTO, FormResponseDTO } from '../types';
 export declare const formContentMapper: (formContent: FormContentDTO) => FormContentDTO;
-export declare const formContentPageMapper: (formContentPage: FormContentPageDTO) => FormContentPageDTO;
-export declare const formContentQuestionMapper: (question: FormContentQuestionDTO) => FormContentQuestionBaseOptionsDTO;
-export declare const mapQuestionByType: (question: FormContentQuestionDTO) => FormContentQuestionDTO;
+export declare const formContentPageMapper: (formContentPage: FormContentPageDTO, allQuestions: FormContentQuestionDTO[]) => FormContentPageDTO;
+export declare const formContentQuestionMapper: (question: FormContentQuestionDTO, allQuestions: FormContentQuestionDTO[]) => FormContentQuestionBaseOptionsDTO;
+export declare const mapQuestionByType: (question: FormContentQuestionDTO, allQuestions: FormContentQuestionDTO[]) => FormContentQuestionDTO;
+export declare const shouldDisplayQuestion: (question: FormContentQuestionDTO, content: FormContentDTO, response: FormResponseDTO) => boolean;

package/dist/utils/form.utils.js

@@ -1,44 +1,114 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.mapQuestionByType = exports.formContentQuestionMapper = exports.formContentPageMapper = exports.formContentMapper = void 0;
+exports.shouldDisplayQuestion = exports.mapQuestionByType = exports.formContentQuestionMapper = exports.formContentPageMapper = exports.formContentMapper = void 0;
 const types_1 = require("../types");
+const lodash_1 = require("lodash");
 const formContentMapper = (formContent) => {
     return {
-        pages: formContent.pages.map(exports.formContentPageMapper),
+        pages: formContent.pages.map((page) => (0, exports.formContentPageMapper)(page, formContent.pages.flatMap((p) => p.questions))),
         formDocumentIds: formContent.formDocumentIds || null,
         formCodeBlockIds: formContent.formCodeBlockIds || null,
     };
 };
 exports.formContentMapper = formContentMapper;
-const formContentPageMapper = (formContentPage) => {
+const formContentPageMapper = (formContentPage, allQuestions) => {
     return {
         id: formContentPage.id,
         title: formContentPage.title,
         description: formContentPage.description,
-        questions: formContentPage.questions.map(exports.mapQuestionByType),
+        questions: formContentPage.questions.map((question) => (0, exports.mapQuestionByType)(question, allQuestions)),
         formDocumentIds: formContentPage.formDocumentIds || null,
         formCodeBlockIds: formContentPage.formCodeBlockIds || null,
     };
 };
 exports.formContentPageMapper = formContentPageMapper;
-const formContentQuestionMapper = (question) => {
+const formContentQuestionMapper = (question, allQuestions) => {
+    var _a;
+    const { id, ask, description, isRequired, allowFileUpload, formDocumentIds, formCodeBlockIds, displayCondition, } = question;
+    const cleanedDisplayCondition = {
+        ...displayCondition,
+        shouldDisplay: (displayCondition === null || displayCondition === void 0 ? void 0 : displayCondition.shouldDisplay) || false,
+        conditions: (_a = displayCondition === null || displayCondition === void 0 ? void 0 : displayCondition.conditions) === null || _a === void 0 ? void 0 : _a.map((condition) => {
+            return {
+                operator: condition.operator,
+                filters: (0, lodash_1.compact)(condition.filters.map((filter) => {
+                    const correspondingQuestion = allQuestions.find((q) => q.id === filter.questionId);
+                    if (!correspondingQuestion) {
+                        return null;
+                    }
+                    if (correspondingQuestion.type === types_1.FormContentQuestionType.DATE && filter.date) {
+                        return {
+                            questionId: filter.questionId,
+                            date: {
+                                before: filter.date.before || null,
+                                after: filter.date.after || null,
+                            },
+                            freeText: null,
+                            number: null,
+                            period: null,
+                        };
+                    }
+                    if (correspondingQuestion.type === types_1.FormContentQuestionType.PERIOD && filter.period) {
+                        return {
+                            questionId: filter.questionId,
+                            period: {
+                                before: filter.period.before || null,
+                                after: filter.period.after || null,
+                            },
+                            freeText: null,
+                            number: null,
+                            date: null,
+                        };
+                    }
+                    if (correspondingQuestion.type === types_1.FormContentQuestionType.NUMBER && filter.number) {
+                        return {
+                            questionId: filter.questionId,
+                            number: {
+                                operator: filter.number.operator,
+                                value: filter.number.value,
+                            },
+                            freeText: null,
+                            period: null,
+                            date: null,
+                        };
+                    }
+                    if (correspondingQuestion.type === types_1.FormContentQuestionType.FREE_TEXT &&
+                        filter.freeText) {
+                        return {
+                            questionId: filter.questionId,
+                            freeText: {
+                                contains: filter.freeText.contains || '',
+                            },
+                            number: null,
+                            period: null,
+                            date: null,
+                        };
+                    }
+                    return null;
+                })),
+            };
+        }),
+    };
     return {
-        id: question.id,
-        ask: question.ask,
-        description: question.description,
-        isRequired: question.isRequired,
-        allowFileUpload: question.allowFileUpload,
-        formDocumentIds: question.formDocumentIds || null,
-        formCodeBlockIds: question.formCodeBlockIds || null,
+        id,
+        ask,
+        description,
+        isRequired,
+        allowFileUpload,
+        formDocumentIds: formDocumentIds || null,
+        formCodeBlockIds: formCodeBlockIds || null,
+        ...(displayCondition && {
+            displayCondition: cleanedDisplayCondition,
+        }),
     };
 };
 exports.formContentQuestionMapper = formContentQuestionMapper;
-const mapQuestionByType = (question) => {
+const mapQuestionByType = (question, allQuestions) => {
     switch (question.type) {
         case types_1.FormContentQuestionType.DATE:
         case types_1.FormContentQuestionType.PERIOD:
             return {
-                ...(0, exports.formContentQuestionMapper)(question),
+                ...(0, exports.formContentQuestionMapper)(question, allQuestions),
                 type: question.type,
                 minDate: question.minDate || null,
                 maxDate: question.maxDate || null,
@@ -48,9 +118,9 @@ const mapQuestionByType = (question) => {
             };
         case types_1.FormContentQuestionType.RATE:
             return {
-                ...(0, exports.formContentQuestionMapper)(question),
+                ...(0, exports.formContentQuestionMapper)(question, allQuestions),
                 type: question.type,
-                display: question.display,
+                display: question.display || 'star',
                 answers: question.answers.map((answer) => ({
                     id: answer.id,
                     content: answer.content,
@@ -62,7 +132,7 @@ const mapQuestionByType = (question) => {
             };
         case types_1.FormContentQuestionType.NUMBER:
             return {
-                ...(0, exports.formContentQuestionMapper)(question),
+                ...(0, exports.formContentQuestionMapper)(question, allQuestions),
                 type: question.type,
                 minValue: question.minValue || null,
                 maxValue: question.maxValue || null,
@@ -70,13 +140,13 @@ const mapQuestionByType = (question) => {
             };
         case types_1.FormContentQuestionType.FREE_TEXT:
             return {
-                ...(0, exports.formContentQuestionMapper)(question),
+                ...(0, exports.formContentQuestionMapper)(question, allQuestions),
                 type: question.type,
                 allowCodeBlock: question.allowCodeBlock || false,
             };
         case types_1.FormContentQuestionType.SELECT:
             return {
-                ...(0, exports.formContentQuestionMapper)(question),
+                ...(0, exports.formContentQuestionMapper)(question, allQuestions),
                 type: question.type,
                 allowMultipleAnswers: question.allowMultipleAnswers || false,
                 allowFreeText: question.allowFreeText || false,
@@ -88,7 +158,7 @@ const mapQuestionByType = (question) => {
             };
         case types_1.FormContentQuestionType.CARD:
             return {
-                ...(0, exports.formContentQuestionMapper)(question),
+                ...(0, exports.formContentQuestionMapper)(question, allQuestions),
                 type: question.type,
                 allowMultipleAnswers: question.allowMultipleAnswers || false,
                 allowFreeText: question.allowFreeText || false,
@@ -101,3 +171,83 @@ const mapQuestionByType = (question) => {
     }
 };
 exports.mapQuestionByType = mapQuestionByType;
+const shouldDisplayQuestion = (question, content, response) => {
+    if (question.archivedAt) {
+        return false;
+    }
+    if (!question.displayCondition || !question.displayCondition.conditions.length) {
+        return true;
+    }
+    const allQuestions = content.pages.flatMap((page) => page.questions);
+    const some = question.displayCondition.conditions.some((condition) => {
+        if (condition.filters.length === 0) {
+            condition.filters.some((filter) => {
+                const responseQuestion = response.questions[filter.questionId];
+                const question = allQuestions.find((q) => q.id === filter.questionId);
+                if (!question || !responseQuestion) {
+                    return false;
+                }
+                return computeFiler(question, responseQuestion, filter);
+            });
+        }
+        else {
+            condition.filters.every((filter) => {
+                const responseQuestion = response.questions[filter.questionId];
+                const question = allQuestions.find((q) => q.id === filter.questionId);
+                if (!question || !responseQuestion) {
+                    return false;
+                }
+                return computeFiler(question, responseQuestion, filter);
+            });
+        }
+    });
+    return question.displayCondition.shouldDisplay ? some : !some;
+};
+exports.shouldDisplayQuestion = shouldDisplayQuestion;
+const computeFiler = (question, responseQuestion, filter) => {
+    if (!responseQuestion || !question) {
+        return false;
+    }
+    if (question.type === types_1.FormContentQuestionType.DATE && filter.date) {
+        return !!((filter.date.before && responseQuestion.date && responseQuestion.date < filter.date.before) ||
+            (filter.date.after && responseQuestion.date && responseQuestion.date > filter.date.after));
+    }
+    if (question.type === types_1.FormContentQuestionType.PERIOD && filter.period) {
+        return !!((filter.period.before &&
+            responseQuestion.startDate &&
+            responseQuestion.startDate < filter.period.before) ||
+            (filter.period.after &&
+                responseQuestion.endDate &&
+                responseQuestion.endDate > filter.period.after));
+    }
+    if (question.type === types_1.FormContentQuestionType.NUMBER && filter.number) {
+        const value = responseQuestion.value;
+        if (value === undefined ||
+            value === null ||
+            filter.number.value === undefined ||
+            filter.number.value === null) {
+            return false;
+        }
+        switch (filter.number.operator) {
+            case 'eq':
+                return value === filter.number.value;
+            case 'neq':
+                return value !== filter.number.value;
+            case 'gt':
+                return value > filter.number.value;
+            case 'lt':
+                return value < filter.number.value;
+            case 'gte':
+                return value >= filter.number.value;
+            case 'lte':
+                return value <= filter.number.value;
+            default:
+                return false;
+        }
+    }
+    if (question.type === types_1.FormContentQuestionType.FREE_TEXT && filter.freeText) {
+        return !!(responseQuestion.freeText &&
+            responseQuestion.freeText.includes(filter.freeText.contains || ''));
+    }
+    return false;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@abyss-project/form",
-  "version": "1.0.3",
+  "version": "1.0.5",
   "description": "Core package to interact with AbyssForm",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -17,10 +17,12 @@
     "core-js": "^3.37.1",
     "dayjs": "^1.10.8",
     "form-data": "^4.0.0",
+    "lodash": "^4.17.21",
     "uuid": "^9.0.0"
   },
   "devDependencies": {
     "@types/express-serve-static-core": "^4.17.31",
+    "@types/lodash": "^4.17.16",
     "@types/node": "^20.11.0",
     "@types/uuid": "^9.0.0",
     "@typescript-eslint/eslint-plugin": "6.21.0",