@bigbinary/neeto-form-frontend 3.13.9 → 3.14.0

package/README.md

@@ -1,22 +1,30 @@
 # neeto-form-nano
 
-The `neeto-form-nano` allows us to build forms within neeto applications. This nano exports `@bigbinary/neeto-form-frontend` NPM package and `neeto-form-engine` Rails engine.
+The `neeto-form-nano` allows us to build forms within neeto applications. This
+nano exports `@bigbinary/neeto-form-frontend` NPM package and
+`neeto-form-engine` Rails engine.
 
-See [this page](https://github.com/search?q=org%3Abigbinary+%22neeto-form-engine+%28%22&type=code) to find host applications using this nano. Changes made in the nano should be rolled out to all of them, especially migrations.
+See
+[this page](https://github.com/search?q=org%3Abigbinary+%22neeto-form-engine+%28%22&type=code)
+to find host applications using this nano. Changes made in the nano should be
+rolled out to all of them, especially migrations.
 
 # Contents
-  1. [Development with Host Application](#development-with-host-application)
-      - [Engine](#engine)
-      - [Frontend package](#frontend-package)
-        - [Installation](#installation-1)
-        - [Instructions for development](#instructions-for-development)
-        - [Usage](#usage)
-  2. [Instructions for Publishing](#instructions-for-publishing)
+
+1. [Development with Host Application](#development-with-host-application)
+   - [Engine](#engine)
+   - [Frontend package](#frontend-package)
+     - [Installation](#installation-1)
+     - [Instructions for development](#instructions-for-development)
+     - [Usage](#usage)
+2. [Instructions for Publishing](#instructions-for-publishing)
 
 # Development with Host Application
 
 ## Engine
-The engine adds setup for form on backend and allows us to attach forms to any model. It also stores submissions.
+
+The engine adds setup for form on backend and allows us to attach forms to any
+model. It also stores submissions.
 
 ### Installation
 
@@ -48,13 +56,15 @@ The engine adds setup for form on backend and allows us to attach forms to any m
    bundle exec rails db:migrate
    ```
 
-5. Add this line to your application's `config/routes.rb` file (replace `at` to your desired route):
+5. Add this line to your application's `config/routes.rb` file (replace `at` to
+   your desired route):
 
    ```ruby
    mount NeetoFormEngine::Engine, at: "/neeto_form_engine"
    ```
 
-6. Create file `neeto_form_engine.rb` under `config/initializers` to provide the `owner_class` information
+6. Create file `neeto_form_engine.rb` under `config/initializers` to provide the
+   `owner_class` information
 
    ```ruby
    NeetoFormEngine.owner_class = "Organization"
@@ -66,7 +76,8 @@ The engine adds setup for form on backend and allows us to attach forms to any m
    has_many :forms, class_name: "::NeetoFormEngine::Form", as: :owner
    ```
 
-8. Configure models to add below association to scope submission records (optional)
+8. Configure models to add below association to scope submission records
+   (optional)
 
    ```ruby
    has_one :submission, class_name: "::NeetoFormEngine::Submission", as: :record
@@ -80,83 +91,116 @@ The engine adds setup for form on backend and allows us to attach forms to any m
 
 ### Customizability
 
-  #### `NeetoFormEngine::Customizable::Forms::Createable`
-  The engine supports customizing the default behavior of `Forms::CreateService` by overriding the supported methods in this concern.
-
-  #### Available methods:
-  1. `create_default_questions!`: If you want to use custom logic to create default questions, you can specify them using this method. `owner`, `form` and `params` will be available globally.
-  2. `additional_form_params`: If you want to include additional attributes while creating forms, you can specify them using this method. It takes one argument `params` which will be the form parameters passed from the front-end.
-
-  #### `NeetoFormEngine::Customizable::Questions::Createable`
-  The engine supports customizing the default behavior of `Questions::CreateService` by overriding the supported methods in this concern.
-
-  #### Available methods:
-  1. `create_question!`: This method receives one argument `params` that contains the question parameters passed from the front-end.
-  2. `additional_question_params`: If you want to include additional attributes while creating questions, you can specify them using this method. It takes one argument `params` which will be the question parameters passed from the front-end.
-
-  #### `NeetoFormEngine::Customizable::Questions::Updateable`
-  The engine supports customizing the default behavior of `Questions::UpdateService` by overriding the supported constants in this concern.
-
-  #### Available constants:
-  1. `EXCLUDED_UPDATE_PARAMS`: If you have included extra parameters other than `kind` for additional use cases that are not valid entity attributes, they need to be specified as `EXCLUDED_UPDATE_PARAMS`.
-
-  #### `NeetoFormEngine::Customizable::QuestionResponses::Createable`
-  The engine supports customizing the default behavior of `QuestionResponses::CreateService` by overriding the supported methods in this concern.
-
-  #### Available methods:
-  1. `additional_initialization_logic`: If you want to initialize additional variables, you can specify them using this method.
-  2. `additional_process_actions`: If you want to perform any additional actions outside the transaction block, you can override this method.
-  3. `additional_create_submission_actions`: You can use this method to specify any additional logic that needs to be executed after creating submissions.
-  4. `additional_create_response_actions`: If you want to perform some additional actions on each of the responses, you can specify them using this method. This method receives `question` and `response_param` passed from the front-end as arguments.
-
-  ### Set up Google reCAPTCHA
-
-  1. Sign up for an API key pair from the
-    [official website](http://www.google.com/recaptcha/admin).
-  2. Configure the following `environment variables` and `secrets` with suitable
-    values
-
-      - Under `.env` file:
-
-        ```yaml
-        FORM_NANO_RECAPTCHA_V2_SITE_KEY=# Value from Google cloud console
-        FORM_NANO_RECAPTCHA_V2_SECRET_KEY=# Value from Google cloud console
-        ```
-
-      - Under `secrets.yml` file:
-
-        ```yaml
-        form_nano:
-          recaptcha_v2:
-            site_key: <%= ENV["FORM_NANO_RECAPTCHA_V2_SITE_KEY"] %>
-            secret_key: <%= ENV["FORM_NANO_RECAPTCHA_V2_SECRET_KEY"] %>
-        ```
-  3. Include the site key in `global_props`
-      ```ruby
-      module ApplicationHelper
-        def get_client_props
-          # other variables
-          custom_props = {
-            # other props
-            form_nano_recaptcha_v2_site_key: Rails.application.secrets.form_nano.dig(:recaptcha_v2, :site_key)
-          }
-        end
-      end
-      ```
+#### `NeetoFormEngine::Customizable::Forms::Createable`
+
+The engine supports customizing the default behavior of `Forms::CreateService`
+by overriding the supported methods in this concern.
+
+#### Available methods:
+
+1. `create_default_questions!`: If you want to use custom logic to create
+   default questions, you can specify them using this method. `owner`, `form`
+   and `params` will be available globally.
+2. `additional_form_params`: If you want to include additional attributes while
+   creating forms, you can specify them using this method. It takes one argument
+   `params` which will be the form parameters passed from the front-end.
+
+#### `NeetoFormEngine::Customizable::Questions::Createable`
+
+The engine supports customizing the default behavior of
+`Questions::CreateService` by overriding the supported methods in this concern.
+
+#### Available methods:
+
+1. `create_question!`: This method receives one argument `params` that contains
+   the question parameters passed from the front-end.
+2. `additional_question_params`: If you want to include additional attributes
+   while creating questions, you can specify them using this method. It takes
+   one argument `params` which will be the question parameters passed from the
+   front-end.
+
+#### `NeetoFormEngine::Customizable::Questions::Updateable`
+
+The engine supports customizing the default behavior of
+`Questions::UpdateService` by overriding the supported constants in this
+concern.
+
+#### Available constants:
+
+1. `EXCLUDED_UPDATE_PARAMS`: If you have included extra parameters other than
+   `kind` for additional use cases that are not valid entity attributes, they
+   need to be specified as `EXCLUDED_UPDATE_PARAMS`.
+
+#### `NeetoFormEngine::Customizable::QuestionResponses::Createable`
+
+The engine supports customizing the default behavior of
+`QuestionResponses::CreateService` by overriding the supported methods in this
+concern.
+
+#### Available methods:
+
+1. `additional_initialization_logic`: If you want to initialize additional
+   variables, you can specify them using this method.
+2. `additional_process_actions`: If you want to perform any additional actions
+   outside the transaction block, you can override this method.
+3. `additional_create_submission_actions`: You can use this method to specify
+   any additional logic that needs to be executed after creating submissions.
+4. `additional_create_response_actions`: If you want to perform some additional
+   actions on each of the responses, you can specify them using this method.
+   This method receives `question` and `response_param` passed from the
+   front-end as arguments.
+
+### Set up Google reCAPTCHA
+
+1. Sign up for an API key pair from the
+   [official website](http://www.google.com/recaptcha/admin).
+2. Configure the following `environment variables` and `secrets` with suitable
+   values
+
+   - Under `.env` file:
+
+     ```yaml
+     FORM_NANO_RECAPTCHA_V2_SITE_KEY=# Value from Google cloud console
+     FORM_NANO_RECAPTCHA_V2_SECRET_KEY=# Value from Google cloud console
+     ```
+
+   - Under `secrets.yml` file:
+
+     ```yaml
+     form_nano:
+       recaptcha_v2:
+         site_key: <%= ENV["FORM_NANO_RECAPTCHA_V2_SITE_KEY"] %>
+         secret_key: <%= ENV["FORM_NANO_RECAPTCHA_V2_SECRET_KEY"] %>
+     ```
+
+3. Include the site key in `global_props`
+   ```ruby
+   module ApplicationHelper
+     def get_client_props
+       # other variables
+       custom_props = {
+         # other props
+         form_nano_recaptcha_v2_site_key: Rails.application.secrets.form_nano.dig(:recaptcha_v2, :site_key)
+       }
+     end
+   end
+   ```
 
 ## Frontend package
+
 The frontend package allows us to create forms across neeto products.
 
 ### Installation
 
 1. Install the NPM package
+
    ```zsh
    yarn add @bigbinary/neeto-form-frontend
    ```
 
-2. The frontend package has a few peer dependencies that are required for
-the proper functioning of the package. Install all the peer dependencies using
-the below command:
+2. The frontend package has a few peer dependencies that are required for the
+   proper functioning of the package. Install all the peer dependencies using
+   the below command:
 
    ```zsh
    yarn add @bigbinary/neetoui @bigbinary/neeto-icons ramda@^0.28.0 classnames@^2.3.1 formik@2.2.9 @bigbinary/neeto-commons-frontend react-google-recaptcha
@@ -170,14 +214,20 @@ the below command:
 
 ### Instructions for development
 
-Check the [Frontend package development guide](https://neeto-engineering.neetokb.com/p/a-d34cb4b0) for step-by-step instructions to develop the frontend package.
+Check the
+[Frontend package development guide](https://neeto-engineering.neetokb.com/p/a-d34cb4b0)
+for step-by-step instructions to develop the frontend package.
 
 ### Usage
 
 You can learn more about the usage here:
+
 1. [Components](./docs/frontend/components.md)
 2. [Hooks](./docs/frontend/hooks.md)
+3. [Email Verification](./docs/email-verification.md)
 
 # Instructions for Publishing
 
-Consult the [building and releasing packages](https://neeto-engineering.neetokb.com/articles/building-and-releasing-packages) guide for details on how to publish.
+Consult the
+[building and releasing packages](https://neeto-engineering.neetokb.com/articles/building-and-releasing-packages)
+guide for details on how to publish.

package/app/javascript/src/translations/ar.json

@@ -202,6 +202,14 @@
       "helpText": "اضغط على مفتاح المسافة أو تبويب أو مفتاح الإدخال بعد إضافة نطاق.",
       "removeInvalidDomains": "انقر هنا لإزالة النطاقات غير الصالحة.",
       "placeholder": "يرجى إدخال نطاقات البريد الإلكتروني"
+    },
+    "emailVerification": {
+      "switchLabel": "تأكيد البريد الإلكتروني",
+      "switchHelpText": "سيتم إرسال رمز تحقق إلى البريد الإلكتروني لحجز الاجتماع.",
+      "resendInSeconds": "تم إرسال رمز تحقق إلى بريدك الوارد. لم تستلم الرمز؟ أعد الإرسال خلال {{secondsLeft}} ثانية",
+      "resendCode": "تم إرسال رمز تحقق إلى بريدك الوارد. لم تستلم الرمز؟ <button>أعد إرسال رمز التحقق</button>",
+      "sendCode": "إرسال الرمز",
+      "verificationCode": "رمز التحقق"
     }
   }
-}
+}

package/app/javascript/src/translations/bg.json

@@ -0,0 +1,207 @@
+{
+  "neetoForm": {
+    "common": {
+      "fieldReq": "{{field}} е задължителен",
+      "thisFieldIsRequired": "Това поле е задължително",
+      "somethingWentWrong": "Нещо се обърка!",
+      "edit": "Редактиране",
+      "clone": "Копиране",
+      "delete": "Изтриване",
+      "agreeTermsAndConditions": "Съгласен съм с условията и правилата, споменати по-долу",
+      "agreeCondition": "Съгласен съм",
+      "mustAcceptTermsAndConditions": "Трябва да приемете условията и правилата",
+      "mustAcceptCondition": "Трябва да приемете условието, за да продължите",
+      "email": "Имейл",
+      "phone": "Телефон",
+      "phNo": "Телефонен номер",
+      "name": "Име",
+      "text": "Текст",
+      "rate": "Оценка",
+      "submit": "Изпрати",
+      "reset": "Нулиране",
+      "cancel": "Отмяна",
+      "singleChoice": "Единствен избор",
+      "company": "Компания",
+      "select": "Изберете",
+      "selectOne": "Изберете един",
+      "required": "Задължително",
+      "hideQuestion": "Скрий въпроса",
+      "readOnly": "Само за четене",
+      "responseVisibleOnlyToHost": "Отговорът е видим само за хоста",
+      "invalidURL": "Невалидно URL",
+      "generateLink": "Генериране на линк",
+      "paragraphCantBeEmpty": "Параграфът не може да бъде празен",
+      "fillTheFormToChat": "Моля, попълнете формуляра, за да започнете чат.",
+      "phoneNumberValidation": "Телефонен номер, започващ с код на държавата",
+      "yes": "Да",
+      "count": "Брой",
+      "shape": "Форма",
+      "good": "Добър",
+      "okay": "Добре",
+      "bad": "Лош",
+      "no": "Не",
+      "addAdditionalGuests": "Добавете допълнителни гости",
+      "unanswered": "Без отговор",
+      "hobbies": "Хобита",
+      "country": "Държава",
+      "addGuests": "Добавете гости",
+      "addGuestsHelper": "Въведете имейли, разделени с запетая.",
+      "start": "Начало",
+      "end": "Край",
+      "settings": "Настройки",
+      "advancedProperties": "Разширени свойства",
+      "clonedElementLabel": "Копие на {{label, anyCase}}",
+      "option": "Опция",
+      "rating": "Оценка",
+      "captchaType": "Тип captcha",
+      "reCaptchaV2": "reCAPTCHA v2",
+      "mathCaptcha": "Математическа captcha",
+      "remainingItemsCount": "{{count}} повече",
+      "domain": "Домейн",
+      "domains": "Домейни",
+      "viewHelpArticle": "Прегледайте статията за помощ",
+      "splitAsFirstAndLastNames": "Разделете на \"Име\" и \"Фамилия\""
+    },
+    "fields": {
+      "mcf": "Множествен избор",
+      "scf": "Единствен избор",
+      "def": "Параграф",
+      "drf": "Падащо меню",
+      "qif": "Текст с множество редове",
+      "nif": "Име",
+      "tif": "Текст в един ред",
+      "eif": "Имейл",
+      "pif": "Телефонен номер",
+      "rif": "Оценка",
+      "tcf": "Условия и правила",
+      "date": "Дата",
+      "fbf": "Обратна връзка",
+      "agif": "Допълнителни гости",
+      "rtf": "Поле за рибок текст",
+      "cf": "Условие",
+      "iif": "Цяло число",
+      "dif": "Десетично",
+      "fileUpload": "Качване на файл",
+      "captcha": "Captcha",
+      "smsReminder": "SMS напомняне"
+    },
+    "toasts": {
+      "formSubmitted": "Формулярът е подаден успешно!"
+    },
+    "callouts": {
+      "submitError": "Не можа да се подаде формулярът",
+      "hiddenQuestion": "Това е скрито поле. Хората, попълващи този формуляр, няма да виждат това поле.",
+      "responseVisibleOnlyToHost": "Тази поле е видимо за всички. Но отговорът му ще е видим само за хоста."
+    },
+    "successPage": {
+      "title1": "Благодаря ви.",
+      "title2": "Вашият отговор е получен."
+    },
+    "emptyState": {
+      "noData": "Не са намерени данни."
+    },
+    "questions": {
+      "deleteAlert": {
+        "title": "Изтриване на полето?",
+        "message_one": "Вие изтривате полето <strong>{{label}}</strong>. Това ще изтрие и всякакви свързани данни.",
+        "message_other": "Вие изтривате полето <strong>{{label}}</strong> за всички езици. Това ще изтрие и всякакви свързани данни."
+      },
+      "common": {
+        "noData": "Няма въпроси за показване.",
+        "helpText": {
+          "learnAbout": "Научете за",
+          "howToAddNewQuestions": "как да добавите нови въпроси"
+        },
+        "primaryPanel": {
+          "addQuestion": "Добавете въпрос",
+          "noQuestionLeft": "Няма повече полета за въпроси за добавяне"
+        },
+        "editQuestion": "Редактирайте въпрос",
+        "cloneBtn": "Копиране",
+        "questionFields": {
+          "field": {
+            "question": "Въпрос",
+            "firstNameQuestion": "Въпрос за име",
+            "lastNameQuestion": "Въпрос за фамилия",
+            "placeholder": "Текст на място",
+            "firstNamePlaceholder": "Място за име",
+            "lastNamePlaceholder": "Място за фамилия",
+            "required": "Задължително",
+            "addOption": "Добавете нова опция",
+            "option": "Опция",
+            "numberedOption": "Опция {{number}}",
+            "options": "Опции",
+            "labelExample": "Пример: {{what}}",
+            "label": "Етикет",
+            "fieldCodeTitle": "Разширени настройки",
+            "fieldCode": "Полева код",
+            "fieldCodeHelpDescription": "Ако промените кода на полето, всички съществуващи споделени линкове, съдържащи стария код на полето като параметър за заявка, няма да работят правилно. <Link>Прегледайте статията за помощ</Link> за повече информация.",
+            "questionType": "Тип на въпроса",
+            "hideQuestionHelpDescription": "Когато е активирано, този въпрос няма да е видим в създадения формуляр. Може да се използва за проследяване на \"идентификатори за справка\" и UTM параметри.",
+            "responseVisibleOnlyToHostHelpDescription": "Когато е активирано, отговорът на този въпрос ще бъде видим само за хоста",
+            "readOnlyHelpDescription": "Когато е активирано, клиентът ще може да вижда само отговора на този въпрос, но няма да може да променя отговора на този въпрос. Тъй като отбелязвате този въпрос като \"само за четене\", трябва предварително да попълните въпроса с отговор.",
+            "verifyHuman": "Потвърдете, че сте човек"
+          }
+        }
+      },
+      "changeLanguage": "Смена на езика"
+    },
+    "error": {
+      "invalidField": "Моля, въведете валиден {{label}}",
+      "invalidFieldCode": "Този полев код не може да се използва",
+      "requiredField": "Моля, въведете {{label}}",
+      "selectMin": "Моля, изберете {{min}} {{entity}}",
+      "invalidType": "{{label}} трябва да бъде валиден {{type}}",
+      "fieldCantBeEmpty": "{{field, anyCase}} не може да бъде празен",
+      "incompleteCaptcha": "Моля, завършете captcha",
+      "captchaVerificationFailed": "Потвърждаването на captcha не успя. Моля, опитайте отново.",
+      "invalidDomain": "Името на домейна е невалидно",
+      "minOneEntity": "Моля, добавете поне една {{entity}}",
+      "emailFromRestrictedDomain": "Имейли с домейн {{domain}} не се приемат."
+    },
+    "fileTypes": {
+      "documents": "Документи",
+      "images": "Изображения",
+      "audioVideo": "Аудио/Видео"
+    },
+    "fileUpload": {
+      "enableMultipleFilesUpload": "Разрешете качването на множество файлове",
+      "fileTypes": "Типове файлове",
+      "validations": {
+        "waitForUpload": "Моля, изчакайте, докато качването свърши",
+        "atLeastOneFileRequired": "Моля, качете поне един файл",
+        "removeDuplicates": "Моля, премахнете дублиращите се записи",
+        "fileIsRequired": "Моля, качете файл"
+      },
+      "dropzone": {
+        "errors": {
+          "fileTooLarge": "Файлът '{{fileName, anyCase}}' е по-голям от {{maxSize}} MB",
+          "fileInvalidType": "Типът файл {{fileType}} не е разрешен",
+          "tooManyFiles": "Можете да качите само един файл",
+          "defaultError": "Нещо се обърка при качването на {{fileName, anyCase}}"
+        },
+        "maxFileSize": "Максимално допустимият размер е {{size}} {{unit, anyCase}}",
+        "allowedFileTypes": "Разрешените типове файлове са {{types}}",
+        "oneFileAllowed": "Моля, качете само 1 файл",
+        "chooseOrDragFile": "<typography>Изберете файл <span>или</span> плъзнете тук.</typography>"
+      },
+      "fileSizeInMb": "{{fileSize}} MB",
+      "mb": "MB"
+    },
+    "domainRestriction": {
+      "whitelistedDomains": {
+        "label": "Разрешете имейл домейни",
+        "description": "Имейли с следните домейни ще бъдат приети.",
+        "popoverDescription": "Въведете домейни, които трябва да бъдат разрешени. Само имейли с тези домейни ще бъдат приети."
+      },
+      "blacklistedDomains": {
+        "label": "Откажете имейл домейни",
+        "description": "Имейли с следните домейни ще бъдат отхвърлени.",
+        "popoverDescription": "Въведете домейни, които трябва да бъдат ограничени. Имейли с тези домейни няма да бъдат приети."
+      },
+      "helpText": "Натиснете интервал, таб или клавиш Enter след добавяне на домейн.",
+      "removeInvalidDomains": "Натиснете тук, за да премахнете невалидни домейни.",
+      "placeholder": "Моля, въведете имейл домейни"
+    }
+  }
+}