updated oskey notes

notes/oskey.md

@@ -1,3 +1,132 @@
+---
+19/11/24
+
+# reu ux/ui
+
+- travail moins sur l'app, plus sur la presentation sur les stores
+- on oublis la meteo sur l'interphone, mais a la place on va implementer un panneau d'informations pour l'immeuble (ex: fete de l'immeuble semaine prochaine, nouveau local velo...)
+	- pour l'instant ben va l'implementer en static
+- differents cas de figures d'invitations
+	- deja inscrit sur l'app
+	- deja inscrit mais avec un autre mail
+	- pas de compte ni app
+
+
+# PBM :
+- anonymous pincode is associated to inhabitant access
+
+---
+
+- update all users pincodes
+- iot ajouter api qui regroupe tous les pincodes par intercom (ACD)
+
+## access and pincode creation :
+- new access creation :
+	- create access document in building -> only contains userID -> each time we add a new access for the user, it erase the last one in database
+	- create pincodes documents in building and user
+	- create access document in user -> access name is buildingId, and it contains array of accesses -> each time we add a new access for the user, it replace the last one with a new one with the array increased by the new access
+	- publish to ACD
+
+## delete pincodes :
+- quickcode ?
+	- delete the pincode documents
+	- delete the access
+- pincode ?
+	- delete the pincode documents
+	- 
+
+## todo v1 :
+
+- **documents :**
+	- [/] types for inhabitant pincode building
+	- [/] types for anonymous pincode building
+	- [/] types for guest pincode building
+	- [/] types for inhabitant pincode user
+	- [/] types for anonymous pincode user
+	- [/] types for guest pincode user
+	- [/] controllers for inhabitant pincode building
+	- [/] controllers for anonymous pincode building
+	- [/] controllers for guest pincode building
+	- [/] controllers for inhabitant pincode user
+	- [/] controllers for anonymous pincode user
+	- [/] controllers for guest pincode user
+	- [/] services for inhabitant pincode building
+	- [/] services for anonymous pincode building
+	- [/] services for guest pincode building
+	- [/] services for inhabitant pincode user
+	- [/] services for anonymous pincode user
+	- [/] services for guest pincode user
+	- [/] generate unique pincodes with pattern
+- **create pincode :**
+	- [/] create inhabitant user pincodes
+	- [/] create inhabitant building pincodes
+	- [/] create anonymous user pincodes
+	- [/] create anonymous building pincodes
+	- [/] create guest user pincodes
+	- [/] create guest building pincodes
+	- [/] create quickcodes
+- **delete pincode :**
+	- [/] delete quickcodes and access
+- **get pincodes:**
+	- [/] get all user pincode documents
+	- [/] get all building pincode documents
+	- [/] get specific user pincode document
+	- [/] get specific building pincode document
+	- [/] get user by accessId
+	- [/] get user pincode id
+	- [/] get building pincode id
+	- [/] get all quickcodes for a user
+	- [ ] a user needs to see the quickcodes in the invitations granted : is it under a building, and when you click on the building in the list you see the quickcode in addition to other accesses ? or in the same arrays as the building invitations ?
+	- [ ] a user needs to see its pincode to access its own building, is it on the invitations screen ?
+- **iot :**
+	- [ ] update access type in iot node
+- **callables :**
+	- [/] create quickcode
+	- [/] delete quickcode
+	- [ ] remove get all pincodes for user ?
+- **tests :**
+	- [/] handle existing documents
+	- [/] associate created documents with expected ones
+	- [/] create inhabitants pincodes
+	- [/] create quickcodes
+	- [/] check all inhabitant documents created
+	- [/] check all quickcode documents created
+	- [/] check inhabitant documents ok
+	- [/] check quickcode documents ok
+	- [/] delete quickcodes
+	- [-] create guest inhabitants
+	- [ ] pubsub messages for all docs are valid
+	- [ ] check errors in quickcode creation
+	- [ ] check errors in quickcode deletion
+- **security rules:**
+	- [-] add security rules for pincodes
+- **confluence :**
+	- [/] documentation on pincode v1
+	- [/] documentation on pincode callable functions
+
+## todo v2 :
+
+- **delete pincode :**
+	- delete pincodes ?
+- **update pincode :**
+	- refresh (automatic and manual)
+	- change informations ? (ex: dates)
+	- update all pincodes (for example if we upgrade the pincode behavior, to reflect on existing ones)
+- **iot :**
+	- iot needs to have a list of the pincodes for an ACD
+- **additional :**
+	- createAccess returns pincode id in a clean way (or, add pincodeId to access docs, so we can retrieve it ?) (CLD1-559)
+	- each quickcode (and pincode ?) creation does not trigger a replacement of the database access document in building and user (CLD1-560)
+	- clean pincodes : pincodes documents may have been partially deleted, only in user or in building, or forgotten when access or invitation has been deleted
+	- should we put pincodes documents in inviter collection ? also adding a field 'inviter' in pincode documents
+
+---
+
+- `test_checks` : 553
+- `pincode_test_match_helper_function` : 595
+- `utility_error_log` : 542
+- `utility_parameter` : 541
+
 ---
 
 - guest user service created
@@ -8,7 +137,7 @@
 ---
 
 - [/] update my branch with develop
-- [ ] add dates to guests and permanent-guests
+- [/] add dates to guests and permanent-guests
 - [ ] user can delete its quickcodes
 - [ ] front needs to get invitations and quickcodes
 	- [ ] update callable to get invitations : fix database call, and add get-quickcode
@@ -19,6 +148,8 @@
 - [ ] **add v2 task :** should we put pincodes documents in inviter collection ? also adding a field 'inviter' in pincode documents
 - [ ] test callable create-quickcodes
 - [ ] test pubsub messages
+- [ ] test access creation for quickcodes
+- [ ] test guest pincodes
 - [ ] update access type in iot node
 - [ ] add security rules for pincodes
 - [ ] test security rules