diff --git a/docs/pilote/Pilote - Usager/application/deploy.md b/docs/pilote/Pilote - Usager/application/deploy.md
index 831f08ea72d6a8f6c23c586d5e8bdb36e4904a87..72a872cc3e8636474c2598018d95eadd08fcc351 100644
--- a/docs/pilote/Pilote - Usager/application/deploy.md
+++ b/docs/pilote/Pilote - Usager/application/deploy.md
@@ -1,12 +1,11 @@
-!!! info ""
- :construction: Section under Construction :construction:
+:construction: Section under Construction :construction:
This section will show you how to deploy your project on different environments.
## Setup
First of all you'll need to install [MobaXterm](https://mobaxterm.mobatek.net/download.html) in order to connect to the server.
-Then, if your're on Linux you can skip the following section, otherwise if you are on Windows you'll have to install Windows Subsystem for Linux (WSL) since the deployment of the app is not working with windows commands.
+Then, if you're on Linux you can skip the following section, otherwise if you are on Windows you'll have to install Windows Subsystem for Linux (WSL) since the deployment of the app is not working with windows commands.
### Install WSL
@@ -91,7 +90,7 @@ First open a new session and connect to the distant host **192.168.62.31**. Don'
#### Windows
-First open your Ubuntu terminal, and clone the project in the repertory of your choice. Once you've selected the branch of you want to deploy, write the following command :
+First open your Ubuntu terminal, and clone the project in the repository of your choice. Once you've selected the branch of you want to deploy, write the following command :
```
yarn build
```
diff --git a/docs/pilote/Pilote - Usager/application/doctypes.md b/docs/pilote/Pilote - Usager/application/doctypes.md
index 9b25535d2d7bda94072d8498f6277b8a76efbf7a..d386e5aed18517624fbf926f51ded4d3c954bb6d 100644
--- a/docs/pilote/Pilote - Usager/application/doctypes.md
+++ b/docs/pilote/Pilote - Usager/application/doctypes.md
@@ -1,5 +1,3 @@
-:construction: Section under Construction :construction:
-
# Doctypes
Doctypes represent different types of data. Their primary use is for permissions: an app or konnector will request permissions for one or several doctypes and will not be able to access other doctypes. See [Doctypes documentation](https://docs.cozy.io/en/cozy-doctypes/docs/) for more information.
@@ -11,11 +9,12 @@ The following is a full description of the doctypes we use and their fields. Coz
## Used Cozy doctypes
- [`io.cozy.accounts`](https://docs.cozy.io/en/cozy-doctypes/docs/io.cozy.accounts): Konnector accounts
+- [`io.cozy.apps`](https://docs.cozy.io/en/cozy-doctypes/docs/io.cozy.apps/): Installed apps
- [`io.cozy.contacts`](https://docs.cozy.io/en/cozy-doctypes/docs/io.cozy.contacts): Contacts
- [`io.cozy.contacts.groups`](https://docs.cozy.io/en/cozy-doctypes/docs/io.cozy.contacts.groups): Contacts groups
- [`io.cozy.files`](https://docs.cozy.io/en/cozy-doctypes/docs/io.cozy.files): Files
- [`io.cozy.permissions`](https://docs.cozy.io/en/cozy-doctypes/docs/io.cozy.permissions): Permissions of the instance
-- [`io.cozy.todos.item`](https://docs.cozy.io/en/cozy-doctypes/docs/io.cozy.todos.item): Todos item
+- [`io.cozy.konnectors`](https://docs.cozy.io/en/cozy-doctypes/docs/io.cozy.konnectors/): Konnectors
- [`io.cozy.triggers`](https://docs.cozy.io/en/cozy-doctypes/docs/io.cozy.triggers): Job triggers
## Used Cozy remote doctypes
@@ -33,82 +32,77 @@ This kind of doctype are set from the team. We have push two remote doctypes (ea
If you need to target rec remote doctype, you need to change the request : client.getStackClient().fetchJSON('POST','...')
and change them into the manifest also.
-## Custom doctypes
-
-- `com.grandlyon.mps.notes`
-
- Represents ...
-
- `com.grandlyon.mps.notes` attributes are:
-
- - `title`: {string} The title of the note.
- - `content`: {string} The content of the note.
-
- #### Example
- ```json
- {
- title: '...',
- content: '...',
- }
- ```
-
-
+## Custom doctypes
- `com.grandlyon.mps.profile`
- Represents the tutorial and notifications state.
-
- `com.grandlyon.mps.profile` attributes are:
+ ##### Attributes
- - `tutorial`: {object} contains `home`, `contacts`, `documents`, `actions`, and `notes` which are all of type `boolean`. Each one represents the state of its tutorial. For example, `home: true` means the home tutorial hasn't been seen yet and will be visible to the user the next time he visits the Home component.
- - `notification`: {} ...
+ - `tutorial`: {`object`} contains `contacts`, `documents`, `actions`, and `notes`. They represent the state of tutorials. For example, `contacts: true` means the contacts tutorial hasn't been seen yet and will be visible to the user the next time he visits the contacts component.
+ - `notification`: {`boolean`} If equals true, the user has a notification
+ - `fullname`: {`string`} User's full name
+ - `introduction`: {`boolean`} If equals `true`, it means the user has already used the app and seen the introduction.
+ - `lastConnectionDate` : {`string`} When was the user last connected (ISO string).
+ - `hasPhone`: {`boolean`} Equals true if the current user has already a phone number
+ - `userID`: {`string`} Current user id
+ - `publicProfile`: {`object`} contains `fullname`, `endDate` (ISO string), and `isActive`
+
+
+
+- `com.grandlyon.mps.appointments`
- #### Example
+ ##### Attributes
- ```json
- {
- tutorial: {
- home: true,
- contacts: false,
- documents: true,
- actions: false,
- notes: true
- },
- notification: ...
- }
- }
- ```
+ - `id`: {`string`} the appointment id
+ - `appointmentDate`: {`string`} the appointment date (ISO string)
+ - `note`: {`Note`} A unique note for each appointment
+ - `objectives`: {`Array<Objective>`} The list of appointment's objectives
+
+
+
+- `com.grandlyon.mps.objectives`
-- `com.grandlyon.mps.appointments`
+ ##### Attributes
- ...
+ - `id`: {`string`} the objective id
+ - `title`: {`string`} the objective title
+ - `type`: {`string`} The id of the Objective type
+ - `subtype`: {`string`} The id of the Objective subType
+ - `tasks`: {`Array<Task>`} Array of Tasks ids
+ - `archived`: {`boolean`} If equals true, it mean the objective has been completed
-- `com.grandlyon.mps.docrules`
+
+
+- `com.grandlyon.mps.tasks`
- Represents ...
+ ##### Attributes
- `com.grandlyon.mps.docrules` attributes are:
+ - `id`: {`string`} The task id
+ - `name`: {`string`} The task name
+ - `description`: {`string`} The task description
+ - `state`: {`TaskState`} It could be one of the following: `'USER_TO_VALID', 'USER_VALID', 'PUBLIC_VALID', 'PUBLIC_INVALID'`
+ - `qualifications`: {`Array<string>`}
+ - `items`: {`Array<TaskItem>`}
+
+
+
+- `com.grandlyon.mps.task.items`
- - `description`: {string} Description of the docrule.
- - `doctype`: {string} ...
- - `rule`: {object} Contains `limit` of type `number`and `selector` which is an `object` with the following attributes:
- - `'cozyMetadata.classification'`: {string} Classification ...
- - `'cozyMetadata.createdAt'`: {object} Creation date.
+ ##### Attributes
- #### Example
+ - `id`: {`string`} Item id
+ - `file`: {`DocumentEntity`} The items' file
+ - `state`: {`TaskItemState`} It could be one of the following: `'USER_ITEM_PENDING', 'PUBLIC_ITEM_VALID', 'PUBLIC_ITEM_INVALID'`
+
+
+
+- `com.grandlyon.mps.notes`
- ```json
- {
- description: '...',
- doctype: 'io.cozy.files',
- rule: {
- limit: 10,
- selector: {
- 'cozyMetadata.classification': '...',
- 'cozyMetadata.createdAt': 'December 23, 2020 03:24:00',
- }
- }
- }
- ```
+ ##### Attributes
+ - `id`: {`string`} Note's id
+ - `content`: {`string`} The content of the note.
+ - `createdAt`: {`string`} Date of creation (ISO string)
+
+
diff --git a/docs/pilote/Pilote - Usager/application/gitflow.md b/docs/pilote/Pilote - Usager/application/gitflow.md
index 60a934d0e8ebabfb1698d909bfbf1e1be1a4507d..0952239d1a8b9408453147c183668eb8871826fd 100644
--- a/docs/pilote/Pilote - Usager/application/gitflow.md
+++ b/docs/pilote/Pilote - Usager/application/gitflow.md
@@ -1,6 +1,3 @@
-!!! info ""
- :construction: Section under Construction :construction:
-
## Initialize
- Create a new project in GitLab and take note of its URL
@@ -16,7 +13,6 @@ This will prevent anyone to push on the master branch, the only way to add code
- Retrieve the project on your computer, open a command line and execute.
```
-git clone https://forge.grandlyon.com/web-et-numerique/llle.git
git clone https://forge.grandlyon.com/solidarite/monparcourssocial/mps-usager.git
```
@@ -69,6 +65,3 @@ Appends a `!` before the title of the commit to notify that a breaking change ha
git tag -a 1.0.0 -m "complementary message"
```
-### Gitflow Scheme
-
-
\ No newline at end of file
diff --git a/docs/pilote/Pilote - Usager/application/scaffolding.md b/docs/pilote/Pilote - Usager/application/scaffolding.md
index cd43a4a69a32be697f2ff1d30940d59d31fef1ea..f404322e0cb2975084e77964b9b9bda8de489fa1 100644
--- a/docs/pilote/Pilote - Usager/application/scaffolding.md
+++ b/docs/pilote/Pilote - Usager/application/scaffolding.md
@@ -1,13 +1,12 @@
-:construction: Section under Construction :construction:
+# Scaffolding
-In this section, you will find information about the project file structure and the purpose of the main folders.
+In this section, you will find information about the project file structure and the purpose of main folders and files.
-##Source Files
+## Source Files
| Folder/File | Purpose |
| ------------------ | ------------------------------------------------------------ |
-| assets | The application's assets, contains fonts, svg and png files. |
-| docrules | |
+| assets | The application's assets, contains fonts, SVGs, PNGs, and GIFs. |
| doctypes | Contains the **cozy** doctypes, you can see more on [Cozy Documentation](https://github.com/cozy/cozy-doctypes). |
| helpers | Contains helper functions that are used by services. It contains also a test file for each helper file. |
| locales | Contains JSON data used by the translation system i18n provided by [Cozy-ui](https://github.com/cozy/cozy-ui). |
@@ -15,21 +14,23 @@ In this section, you will find information about the project file structure and
| services | Here you'll find all the services. It contains also a test file for each service file. |
| store | Redux store. Contains actions, reducers, and store types. |
| styles | Styles folder. The **base** folder under it contains our variables, fonts, breakpoints, animations, and mixins. Whenever you add a style file elsewhere, don't forget to import it in **index.scss**. |
-| targets | Contains mobile and browser targets. It also contains a **Public** target for *social workers*. |
-| types | |
+| targets | Contains mobile and browser targets. It also contains a **Public** target for the *service worker*. |
+| types | Contains all cozy types. |
| utils | In this folder you'll find utilities methods. |
-| tests | |
| components/App.tsx | The root component. |
-##Configuration Files
+## Configuration Files
+
+| File | Purpose |
+| ------------------------- | ------------------------------------------------------------ |
+| .editorconfig | Editor config rules |
+| .eslintrc.js | ESLint config file |
+| gitlab-ci.yml | Gitlab continuous integration config file |
+| .prettierrc | Prettier extension config file |
+| app.config.* | Overloads webpack configuration |
+| jest.config.js | Jest config file |
+| manifest.webapp | Manifest of the application, used by cozy for permissions' management. You can add permissions for doctypes here |
+| tsconfig.json | TypeScript config file |
+| konnector-dev-config.json | To locally test konnectors |
+| service-dev-config.json | To locally test services |
-| Folder/File | Purpose |
-| --------------- | ------------------------------------------------------------ |
-| .eslintrc.js | Config file for ESLint. |
-| gitlab-ci.yml | Config file used for Gitlab continuous integration. |
-| .prettierrc | Config file for Prettier extension. |
-| | |
-| jest.config.js | Config file used by Jest for testing the application. |
-| manifest.webapp | Manifest of the application, used by cozy for permissions' management, you can add permissions for doctypes here. |
-| tsconfig.json | Config file for TypeScript. |
-| ... | |
\ No newline at end of file
diff --git a/docs/pilote/Pilote - Usager/application/services.md b/docs/pilote/Pilote - Usager/application/services.md
index 8ff103699a118d378c894027f49fe29dc70e7214..1438712c90c4cc553fe4c3fdda5e6eccea3703bf 100644
--- a/docs/pilote/Pilote - Usager/application/services.md
+++ b/docs/pilote/Pilote - Usager/application/services.md
@@ -1,49 +1,62 @@
-:construction: Section under Construction :construction:
-
## Profile Service
### Functions
- `getProfile`: Tries fetching the profile if it exists. If not, it creates a new one and returns it.
- `updateProfile`: Updates the profile.
+- `parseProfile`: Returns the Profile passed as a parameter without the following properties: `_id, id, _type, _rev, cozyMetadata`.
+
+
-## Note Service
+## Notes Service
### Functions
-- `findNoteCurrentAppointement`: Returns a note from an appointment id.
-- `findNoteById`: Returns a note by its id.
-- `getAllNotes`: Returns all notes.
-- `findLastNote`: Returns the last note by date.
-- `createNote`: Creates a new note and returns it.
-- `updateNote`: Updates a note.
-- `deleteNoteById`: Deletes a note by its id.
+- `parseNote`: Returns the Note passed as a parameter without the following properties: `_id, _type, _rev, cozyMetadata`.
+- `getNoteByIDs`: Returns a list of Notes from a list of ids.
+- `createNote`: Creates a new Note.
+- `updateNote`: Updates a Note.
+- `getCurrentNoteOrCreate`: Returns the Note linked to the current Appointment. If id does not exist, it creates and returns a new one.
+- `getAllNotes`: Returns a list of all Notes.
-## DocRule Service
+
+
+## Appointments Service
### Functions
-- `createDocRule`: Creates a new docRule.
-- `getDocRuleById`: Returns a docRule by its id.
-- `getDocRulesByIds`: Returns a list of docRules by their ids.
-- `getAllDocRules`: Returns all docRules.
-- `createAllDocRules`: Fetches all docRules and creates the missing ones.
+- `parseAppointment`: Returns an Appointment from an AppointmentEntity.
+- `getLastAppointment`: Returns the last Appointment, which a user can see first in /actions.
+- `getAllAppointment`: returns a list of all Appointments.
+- `getAppointmentByID`: Returns an Appointment from its id.
+- `createAppointment`: Creates a new Appointment.
+- `updateAppointment`: Updates an Appointment.
+
-## Document Service
+
+## Documents Service
### Functions
- `getAllDocuments`: Returns the list of all documents.
-- `getDocumentsByQualification`: Returns a document by the `'metadata.qualification.label'`.
-- `getDocumentsByQualifications`: Uses `getDocumentsByQualification` to return a list of documents by the `'metadata.qualification.label'`.
+- `getDocumentsByQualification`: Returns a document by a qualification.
+- `getDocumentsByQualifications`: Uses `getDocumentsByQualification` to return a list of documents from a list of qualifications.
- `getDocumentByID`: Returns a document by its id.
- `saveDocument`: Creates a new file.
- `editDocumentName`: Edits a document's name by its id.
- `deleteDocumentById`: Deletes the document by its id.
- `downloadDocument`: Downloads a file from its id.
-- `viewDocument`: Takes a document's id, opens its download link and returns it.
+- `downloadArchive`: Downloads an archive containing all the files whom ids are passed as a parameter.
+- `getLinkDoc`: Returns the file download link.
+- `getReferencedFolders`: Gets a folder by a reference.
+- `getOrCreateFolderWithReference`: Gets a folder by a reference or creates it if it does not exist.
+- `getDocumentsWithQualifications`: Returns the qualified documents along with the not qualified ones (`{ qualified, other }`).
+- `replaceFile`: Replaces a file.
+- `keepFile`: Changes a file's name and saves it.
+
+
-## Contact Service
+## Contacts Service
### Functions
@@ -54,11 +67,73 @@
- `updateContact`: Updates an existing contact.
- `deleteContactById`: Deletes a contact by its id.
-## Group Service
+
+
+## Groups Service
## Function
- `createMetroGroup`: Creates a new group and returns it.
- `getMetroGroup`: Returns the group if it exists or creates it if it doesn't.
-## ...
\ No newline at end of file
+
+
+## Initialization Service
+
+- `Initialization`: {`Object`} Initializes the profile, actions, and the appDirectory.
+
+
+
+## Konnectors Service
+
+### Functions
+
+- `getAllKonnectors`: Returns a list of all the Konnectors.
+- `getAllKonnectorSlugs`: Returns a list of all the Konnectors' slugs.
+- `getKonnectorNameBySlug`: Returns a Konnector name from a slug.
+- `getKonnectorBySlug`: Returns a Konnector from a slug.
+- `getKonnectorByName`: Returns a Konnector from its name.
+- `getKonnectorsFromDocuments`: Returns a list of Konnectors from a passed DocumentEntity list.
+
+
+
+## Objectives Service
+
+### Functions
+
+- `parseObjective`: Returns the Objective passed as a parameter without the following properties: `_type, _rev, _id, cozyMetadata, relationships`.
+- `getObjectiveByIDs`: Returns a list of Objectives from a list of ids.
+- `getOldObjectives`: Returns a list of the archived Objectives not belonging to the last Appointment.
+- `createObjective`: Creates a new Objective.
+- `updateObjective`: Updates an existing Objective.
+
+
+
+## Tasks Service
+
+### Functions
+
+- `parseTaskJSONToTask`: Returns a Task from a TaskJSON.
+- `parseTask`: Returns the Task passed as a parameter without the following properties: `_type, _rev, _id, cozyMetadata, relationships`.
+- `getTasksByIDs`: Returns a list of Tasks from a list of ids.
+- `createTask`: Creates a new Task.
+- `updateTask`: Updates a Task from its id.
+
+
+
+## TaskItems Service
+
+### Functions
+
+- `parseTaskItem`: Returns the TaskItem passed as a parameter without the following properties: `_type, _rev, _id, cozyMetadata, relationships`.
+- `getTaskItemByIDs`: Returns a list of TaskItems from a list of ids.
+- `createTaskItem`: Creates a new TaskItem.
+- `updateTaskItem`: Updates a TaskItem from its id.
+
+
+
+## Triggers Service
+
+### Functions
+
+- `getAllTriggers`: Returns All the triggers filtred by type if passed as parameter.
\ No newline at end of file
diff --git a/docs/pilote/Pilote - Usager/application/store.md b/docs/pilote/Pilote - Usager/application/store.md
index 6dd7f2418f5407802a82f6d262b5f68f3672c250..11753239a9175234a9e9f55f69f3ef3530cb0865 100644
--- a/docs/pilote/Pilote - Usager/application/store.md
+++ b/docs/pilote/Pilote - Usager/application/store.md
@@ -6,11 +6,73 @@ We are using **Redux** for our application state management. it maintains the st
The following are the existing store entities used by our application:
-- `Global`: Preserves the global state, which includes `isPublic` and `screenType` (Mobile/Tablet/Desktop).
+- `Profile`: Preserves the state of tutorials, user profile, public profile, introduction, and notifications (see initial state below).
+
+- `Global`: Preserves the global state, which includes `isPublic` `toast` and `error`
+- `Appointment`: Preserves the state of tutorials and notifications.
- `UploadDocument`: Manages the state of uploaded documents.
-- `Profile`: Preserves the state of tutorials and notifications.
+#### Initial states
+
+##### Profile
+
+```javascript
+{
+ tutorial: { // Tells if a tutorial has already been seen
+ contacts: true,
+ documents: true,
+ actions: {
+ first: true, // 'first' represents the actions component with no appointments yet
+ second: true, // 'second' represents the actions component with an existing appointment
+ },
+ },
+ fullname: '',
+ introduction: true, // If 'true', the user has already used the app and seen the introduction
+ notification: false,
+ lastConnectionDate: '', // ISO string
+ hasPhone: false,
+ userID: '',
+ publicProfile: {
+ fullname: '',
+ endDate: '', // Timestamp
+ isActive: false,
+ },
+}
+```
+
+##### Global
+
+```javascript
+{
+ isPublic: false,
+ toast: null, // Manages global messages toasts
+ error: false, // Manages global errors
+}
+```
+
+##### Appointment
+
+```javascript
+{
+ id: '',
+ appointmentDate: '', // ISO string
+ note: {
+ id: '',
+ content: '',
+ createdAt: '', // ISO string
+ },
+ objectives: [],
+}
+```
+
+##### UploadDocument
+```javascript
+{
+ file: null,
+ qualification: null,
+}
+```
For each reducer file, a test file is associated testing the reducer.
@@ -19,5 +81,6 @@ All the actions are tested in a separate file with the same actions file name.
## Used packages
- **react-redux**: Official React bindings for [Redux](https://github.com/reduxjs/redux).
-- **redux-devtools-extension**: For debugging application's state changes.
+- **react-redux**: [Thunk middleware](https://github.com/reduxjs/redux-thunk) for Redux.
+- **redux-devtools-extension**: For application's state changes debugging.
- **@types/react-redux**: This package contains type definitions for react-redux.
\ No newline at end of file