Merge pull request #32 from Samagra-Development/file-upload

File upload

Author: Shruti3004

.gitignore

@@ -0,0 +1,3 @@
+.turbo
+node_modules
+.idea

.nvmrc

@@ -0,0 +1 @@
+v14.19.1

.prettierignore

@@ -0,0 +1 @@
+enketo-express

.prettierrc

@@ -0,0 +1 @@
+{}

.vscode/settings.json

@@ -0,0 +1,11 @@
+{
+  "cSpell.words": [
+    "encryptor",
+    "enketo",
+    "prefill",
+    "submissionerror",
+    "submissionsuccess",
+    "submissionwarning",
+    "xform"
+  ]
+}

README.md

@@ -20,20 +20,19 @@ Enketo has been used all around the world for a wide range of uses from needs as
 
 ![Screencast from 03-02-22 05_31_50 PM IST](https://user-images.githubusercontent.com/56133783/152341126-ac03baa3-258c-473a-956a-d0973682234a.gif)
 
-
 ## Requirements :scroll:
 
 1. Your machine should have [Yarn](https://classic.yarnpkg.com/en/docs/install/#windows-stable) or [Npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm), [Docker](https://docs.docker.com/get-docker/), [Python](https://www.python.org/downloads/) installed.
 
 *Note: Preferable Npm version (6.14.15) and Node version(v14.18.1) and Ubuntu OS version(18.04)**
 
 2. Check the node and npm version by running following commands.
+
 ```sh
 node -v
 npm -v
 ```
 
-
 ## Installation Steps :walking:
 
 ### 1. Fork it :fork_and_knife:
@@ -68,6 +67,7 @@ git remote -v
 origin  https://github.com/Your_Username/enketo.git (fetch)
 origin  https://github.com/Your_Username/enketo.git (push)
 ```
+
 ### 4. Run it :checkered_flag:
 
 ```sh
@@ -96,12 +96,167 @@ cd ../forms
 python3 -m http.server
 ```
 
-You can preview your form on http://localhost:8005/preview?xform=http://localhost:8000/sample.xml
+You can preview your form on http://localhost:8005/preview?xform=http://localhost:8080/getForm/SOE
 
 ### 5. For integrating your backend
-Customize the [submission url](https://github.com/Samagra-Development/enketo/blob/main/enketo-express/public/js/src/module/connection.js#L150) with your hosted backend. 
+
+Customize the [submission url](https://github.com/Samagra-Development/enketo/blob/main/enketo-express/public/js/src/module/connection.js#L150) with your hosted backend.
 
 ## Future Enhancements :rocket:
 
 - [Encrypting query parameters on rendering the enketo form. ](https://github.com/Samagra-Development/enketo/issues/1)
 - Writing a API for changing an XML form directly from it.
+- add npm scripts for install
+
+We are trying to an inversion of control here.
+
+### For Get API
+
+`curl --location --request GET 'http://localhost:3002/form/form2'`
+
+### Form Prefill API
+
+```sh
+curl --location --request POST 'http://localhost:3002/prefill' \
+--header 'Content-Type: application/json' \
+--data-raw '{
+    "prefillSpec": {
+        "pf_name": "`${onFormSuccessData.name}`",
+        "pf_iti": "`${onFormSuccessData.itiByIti.name}`",
+        "pf_trade": "`${onFormSuccessData.tradeName}`",
+        "pf_batch": "`${onFormSuccessData.batch}`",
+        "pf_industry": "`${onFormSuccessData.industryByIndustry.name}`",
+        "ojt_month": "`${onFormSuccessData.industryByIndustry.schedules[0].is_industry === true ? 1 : 0}`"
+    },
+    "onFormSuccessData": {
+        "name": "DEVA",
+        "batch": "2021-2023",
+        "id": 8,
+        "DOB": "2005-03-04",
+        "affiliationType": "NCVT",
+        "registrationNumber": "ICA211021569832",
+        "tradeName": "Electrician",
+        "iti": 7,
+        "industry": 1,
+        "itiByIti": {
+            "id": 7,
+            "name": "GITI Nagina"
+        },
+        "industryByIndustry": {
+            "id": 1,
+            "name": "Kaushal Bhawan",
+            "latitude": 30.695753,
+            "longitude": 76.872025,
+            "schedules": [
+                {
+                    "is_industry": true
+                }
+            ]
+        }
+    },
+    "form": "form2"
+}'
+```
+
+## Architecture
+
+<!-- Insert LLD Image here -->
+![alt text](./docs/images/LLD.png "Title")
+
+
+## Wrapper Config
+
+Example config
+```json
+{
+  "start": "form1",
+  "forms": {
+    "form1": {
+      "skipOnSuccessMessage": true,
+      "prefill": {},
+      "submissionURL": "http://esamwad.samagra.io/api/v4/form/submit",
+      "name": "SampleForm",
+      "successCheck": "async (formData) => { console.log('From isSuccess', formData.getElementsByTagName('reg_no')[0].textContent); return formData.getElementsByTagName('reg_no')[0].textContent === 'registration123'; }",
+      "onSuccess": {
+        "notificationMessage": "Form submitted successfully or not Maybe",
+        "sideEffect": "async (formData) => { return JSON.parse(decodeURIComponent('%7B%0A%20%20%20%20%20%20%20%20%22name%22%3A%20%22DEVA%22%2C%0A%20%20%20%20%20%20%20%20%22batch%22%3A%20%222021-2023%22%2C%0A%20%20%20%20%20%20%20%20%22id%22%3A%208%2C%0A%20%20%20%20%20%20%20%20%22DOB%22%3A%20%222005-03-04%22%2C%0A%20%20%20%20%20%20%20%20%22affiliationType%22%3A%20%22NCVT%22%2C%0A%20%20%20%20%20%20%20%20%22registrationNumber%22%3A%20%22ICA211021569832%22%2C%0A%20%20%20%20%20%20%20%20%22tradeName%22%3A%20%22Electrician%22%2C%0A%20%20%20%20%20%20%20%20%22iti%22%3A%207%2C%0A%20%20%20%20%20%20%20%20%22industry%22%3A%201%2C%0A%20%20%20%20%20%20%20%20%22itiByIti%22%3A%20%7B%0A%20%20%20%20%20%20%20%20%20%20%20%20%22id%22%3A%207%2C%0A%20%20%20%20%20%20%20%20%20%20%20%20%22name%22%3A%20%22GITI%20Nagina%22%0A%20%20%20%20%20%20%20%20%7D%2C%0A%20%20%20%20%20%20%20%20%22industryByIndustry%22%3A%20%7B%0A%20%20%20%20%20%20%20%20%20%20%20%20%22id%22%3A%201%2C%0A%20%20%20%20%20%20%20%20%20%20%20%20%22name%22%3A%20%22Kaushal%20Bhawan%22%2C%0A%20%20%20%20%20%20%20%20%20%20%20%20%22latitude%22%3A%2030.695753%2C%0A%20%20%20%20%20%20%20%20%20%20%20%20%22longitude%22%3A%2076.872025%2C%0A%20%20%20%20%20%20%20%20%20%20%20%20%22schedules%22%3A%20%5B%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%7B%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%22is_industry%22%3A%20true%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%7D%0A%20%20%20%20%20%20%20%20%20%20%20%20%5D%0A%20%20%20%20%20%20%20%20%7D%0A%20%20%20%20%7D')); }",
+        "next": {
+          "type": "form",
+          "id": "form2"
+        }
+      },
+      "onFailure": {
+        "message": "Form submission failed",
+        "sideEffect": "async (formData) => { console.log(formData); }",
+        "next": {
+          "type": "url",
+          "id": "google"
+        }
+      },
+      "metaData": {
+        "constant1": "Test"
+      }
+    },
+    "form2": {
+      "skipOnSuccessMessage": true,
+      "prefill": {
+        "pf_name": "`${onFormSuccessData.name}`",
+        "pf_iti": "`${onFormSuccessData.itiByIti.name}`",
+        "pf_trade": "`${onFormSuccessData.tradeName}`",
+        "pf_batch": "`${onFormSuccessData.batch}`",
+        "pf_industry": "`${onFormSuccessData.industryByIndustry.name}`"
+      },
+      "submissionURL": "http://esamwad.samagra.io/api/v4/form/submit",
+      "name": "SampleForm",
+      "successCheck": "async (formData) => { console.log('From isSuccess', formData.getElementsByTagName('reg_no')[0].textContent); return formData.getElementsByTagName('reg_no')[0].textContent === 'registration123'; }",
+      "onSuccess": {
+        "message": "Form submitted successfully",
+        "sideEffect": "async (formData) => { console.log(formData); }",
+        "next": {
+          "type": "form",
+          "id": "form2"
+        }
+      },
+      "onFailure": {
+        "notificationMessage": "Form submission failed",
+        "sideEffect": "async (formData) => { console.log(formData); }",
+        "next": {
+          "type": "url",
+          "id": "https://google.com"
+        }
+      },
+       "metaData": {
+        "constantForm2": "Test"
+      }
+    }
+  },
+  "urls": {
+    "google": {
+      "url": "https://google.com",
+      "queryParams": {},
+      "onSuccess": {
+        "message": null,
+        "sideEffect": "async (formData) => { console.log(formData); }",
+        "next": null
+      }
+    }
+  },
+  "metaData": {}
+}
+```
+
+### State
+State for prefilling, sideEffect.
+```json
+{
+    "onFormSuccessData": {},
+    "formConfig": {},
+    "formState": {},
+}
+```
+
+TODO: Add details on the specifications
+
+## Possible Attack Vectors
+1. XSS (High Priority) - Simple form
+2. SQL Injection (High Priority) - needs to be fixed.

apps/wrapper/.gitignore

@@ -0,0 +1,23 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+
+# testing
+/coverage
+
+# production
+/build
+
+# misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

apps/wrapper/README.md

@@ -0,0 +1,70 @@
+# Getting Started with Create React App
+
+This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
+
+## Available Scripts
+
+In the project directory, you can run:
+
+### `npm start`
+
+Runs the app in the development mode.\
+Open [http://localhost:3000](http://localhost:3000) to view it in your browser.
+
+The page will reload when you make changes.\
+You may also see any lint errors in the console.
+
+### `npm test`
+
+Launches the test runner in the interactive watch mode.\
+See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
+
+### `npm run build`
+
+Builds the app for production to the `build` folder.\
+It correctly bundles React in production mode and optimizes the build for the best performance.
+
+The build is minified and the filenames include the hashes.\
+Your app is ready to be deployed!
+
+See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
+
+### `npm run eject`
+
+**Note: this is a one-way operation. Once you `eject`, you can't go back!**
+
+If you aren't satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
+
+Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you're on your own.
+
+You don't have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn't feel obligated to use this feature. However we understand that this tool wouldn't be useful if you couldn't customize it when you are ready for it.
+
+## Learn More
+
+You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
+
+To learn React, check out the [React documentation](https://reactjs.org/).
+
+### Code Splitting
+
+This section has moved here: [https://facebook.github.io/create-react-app/docs/code-splitting](https://facebook.github.io/create-react-app/docs/code-splitting)
+
+### Analyzing the Bundle Size
+
+This section has moved here: [https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size](https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size)
+
+### Making a Progressive Web App
+
+This section has moved here: [https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app](https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app)
+
+### Advanced Configuration
+
+This section has moved here: [https://facebook.github.io/create-react-app/docs/advanced-configuration](https://facebook.github.io/create-react-app/docs/advanced-configuration)
+
+### Deployment
+
+This section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment)
+
+### `npm run build` fails to minify
+
+This section has moved here: [https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify)