diff --git a/docu/commandAndEventDocu.md b/docu/commandAndEventDocu.md index 175fa7b2..915c09e8 100644 --- a/docu/commandAndEventDocu.md +++ b/docu/commandAndEventDocu.md @@ -1,37 +1,37 @@ # Poinz Command and Event Docu -This is an autogenerated docu. 1/2/2023, 10:34:15 AM (Poinz version 0.17.6) +This is an autogenerated docu. 1/2/2023, 10:42:56 AM (Poinz version 0.17.6) * Jump to [commands](#commands) * Jump to [events](#events) ## Commands - * [addStory](#command-addStory) - * [changeStory](#command-changeStory) - * [clearStoryEstimate](#command-clearStoryEstimate) - * [deleteStory](#command-deleteStory) - * [giveStoryEstimate](#command-giveStoryEstimate) - * [importStories](#command-importStories) - * [joinRoom](#command-joinRoom) - * [kick](#command-kick) - * [leaveRoom](#command-leaveRoom) - * [newEstimationRound](#command-newEstimationRound) - * [restoreStory](#command-restoreStory) - * [reveal](#command-reveal) - * [selectStory](#command-selectStory) - * [setAvatar](#command-setAvatar) - * [setCardConfig](#command-setCardConfig) - * [setEmail](#command-setEmail) - * [setPassword](#command-setPassword) - * [setRoomConfig](#command-setRoomConfig) - * [setSortOrder](#command-setSortOrder) - * [setUsername](#command-setUsername) - * [settleEstimation](#command-settleEstimation) - * [toggleExclude](#command-toggleExclude) - * [trashStory](#command-trashStory) - - -### Command "addStory" + * [addStory](#command-addstory-) + * [changeStory](#command-changestory-) + * [clearStoryEstimate](#command-clearstoryestimate-) + * [deleteStory](#command-deletestory-) + * [giveStoryEstimate](#command-givestoryestimate-) + * [importStories](#command-importstories-) + * [joinRoom](#command-joinroom-) + * [kick](#command-kick-) + * [leaveRoom](#command-leaveroom-) + * [newEstimationRound](#command-newestimationround-) + * [restoreStory](#command-restorestory-) + * [reveal](#command-reveal-) + * [selectStory](#command-selectstory-) + * [setAvatar](#command-setavatar-) + * [setCardConfig](#command-setcardconfig-) + * [setEmail](#command-setemail-) + * [setPassword](#command-setpassword-) + * [setRoomConfig](#command-setroomconfig-) + * [setSortOrder](#command-setsortorder-) + * [setUsername](#command-setusername-) + * [settleEstimation](#command-settleestimation-) + * [toggleExclude](#command-toggleexclude-) + * [trashStory](#command-trashstory-) + + +### Command "addStory" Source: [/server/src/commandHandlers/addStory.js](/server/src/commandHandlers/addStory.js) @@ -85,7 +85,7 @@ Produces: **[storyAdded](#event-storyAdded)**, **[storySelected](#event-storySel -### Command "changeStory" +### Command "changeStory" Source: [/server/src/commandHandlers/changeStory.js](/server/src/commandHandlers/changeStory.js) @@ -144,7 +144,7 @@ Produces: **[storyChanged](#event-storyChanged)**, -### Command "clearStoryEstimate" +### Command "clearStoryEstimate" Source: [/server/src/commandHandlers/clearStoryEstimate.js](/server/src/commandHandlers/clearStoryEstimate.js) @@ -193,7 +193,7 @@ Produces: **[storyEstimateCleared](#event-storyEstimateCleared)**, -### Command "deleteStory" +### Command "deleteStory" Source: [/server/src/commandHandlers/deleteStory.js](/server/src/commandHandlers/deleteStory.js) @@ -243,7 +243,7 @@ Produces: **[storyDeleted](#event-storyDeleted)**, -### Command "giveStoryEstimate" +### Command "giveStoryEstimate" Source: [/server/src/commandHandlers/giveStoryEstimate.js](/server/src/commandHandlers/giveStoryEstimate.js) @@ -302,7 +302,7 @@ Produces: **[consensusAchieved](#event-consensusAchieved)**, **[revealed](#event -### Command "importStories" +### Command "importStories" Source: [/server/src/commandHandlers/importStories.js](/server/src/commandHandlers/importStories.js) @@ -353,7 +353,7 @@ Produces: **[consensusAchieved](#event-consensusAchieved)**, **[importFailed](#e -### Command "joinRoom" +### Command "joinRoom" Source: [/server/src/commandHandlers/joinRoom.js](/server/src/commandHandlers/joinRoom.js) @@ -420,7 +420,7 @@ Produces: **[avatarSet](#event-avatarSet)**, **[emailSet](#event-emailSet)**, ** -### Command "kick" +### Command "kick" Source: [/server/src/commandHandlers/kick.js](/server/src/commandHandlers/kick.js) @@ -468,7 +468,7 @@ Produces: **[kicked](#event-kicked)**, -### Command "leaveRoom" +### Command "leaveRoom" Source: [/server/src/commandHandlers/leaveRoom.js](/server/src/commandHandlers/leaveRoom.js) @@ -514,7 +514,7 @@ Produces: **[connectionLost](#event-connectionLost)**, **[leftRoom](#event-leftR -### Command "newEstimationRound" +### Command "newEstimationRound" Source: [/server/src/commandHandlers/newEstimationRound.js](/server/src/commandHandlers/newEstimationRound.js) @@ -565,7 +565,7 @@ Produces: **[newEstimationRoundStarted](#event-newEstimationRoundStarted)**, -### Command "restoreStory" +### Command "restoreStory" Source: [/server/src/commandHandlers/restoreStory.js](/server/src/commandHandlers/restoreStory.js) @@ -615,7 +615,7 @@ Produces: **[storyRestored](#event-storyRestored)**, **[storySelected](#event-st -### Command "reveal" +### Command "reveal" Source: [/server/src/commandHandlers/reveal.js](/server/src/commandHandlers/reveal.js) @@ -665,7 +665,7 @@ Produces: **[consensusAchieved](#event-consensusAchieved)**, **[revealed](#event -### Command "selectStory" +### Command "selectStory" Source: [/server/src/commandHandlers/selectStory.js](/server/src/commandHandlers/selectStory.js) @@ -713,7 +713,7 @@ Produces: **[storySelected](#event-storySelected)**, -### Command "setAvatar" +### Command "setAvatar" Source: [/server/src/commandHandlers/setAvatar.js](/server/src/commandHandlers/setAvatar.js) @@ -762,7 +762,7 @@ Produces: **[avatarSet](#event-avatarSet)**, -### Command "setCardConfig" +### Command "setCardConfig" Source: [/server/src/commandHandlers/setCardConfig.js](/server/src/commandHandlers/setCardConfig.js) @@ -835,7 +835,7 @@ Produces: **[cardConfigSet](#event-cardConfigSet)**, -### Command "setEmail" +### Command "setEmail" Source: [/server/src/commandHandlers/setEmail.js](/server/src/commandHandlers/setEmail.js) @@ -882,7 +882,7 @@ Produces: **[emailSet](#event-emailSet)**, -### Command "setPassword" +### Command "setPassword" Source: [/server/src/commandHandlers/setPassword.js](/server/src/commandHandlers/setPassword.js) @@ -931,7 +931,7 @@ Produces: **[passwordCleared](#event-passwordCleared)**, **[passwordSet](#event- -### Command "setRoomConfig" +### Command "setRoomConfig" Source: [/server/src/commandHandlers/setRoomConfig.js](/server/src/commandHandlers/setRoomConfig.js) @@ -996,7 +996,7 @@ Produces: **[roomConfigSet](#event-roomConfigSet)**, -### Command "setSortOrder" +### Command "setSortOrder" Source: [/server/src/commandHandlers/setSortOrder.js](/server/src/commandHandlers/setSortOrder.js) @@ -1049,7 +1049,7 @@ Produces: **[sortOrderSet](#event-sortOrderSet)**, -### Command "setUsername" +### Command "setUsername" Source: [/server/src/commandHandlers/setUsername.js](/server/src/commandHandlers/setUsername.js) @@ -1097,7 +1097,7 @@ Produces: **[usernameSet](#event-usernameSet)**, -### Command "settleEstimation" +### Command "settleEstimation" Source: [/server/src/commandHandlers/settleEstimation.js](/server/src/commandHandlers/settleEstimation.js) @@ -1151,7 +1151,7 @@ Produces: **[consensusAchieved](#event-consensusAchieved)**, -### Command "toggleExclude" +### Command "toggleExclude" Source: [/server/src/commandHandlers/toggleExclude.js](/server/src/commandHandlers/toggleExclude.js) @@ -1201,7 +1201,7 @@ Produces: **[excludedFromEstimations](#event-excludedFromEstimations)**, **[incl -### Command "trashStory" +### Command "trashStory" Source: [/server/src/commandHandlers/trashStory.js](/server/src/commandHandlers/trashStory.js) @@ -1253,37 +1253,37 @@ Produces: **[storySelected](#event-storySelected)**, **[storyTrashed](#event-sto ## Events - * [storyAdded](#event-storyAdded) - * [storySelected](#event-storySelected) - * [storyChanged](#event-storyChanged) - * [storyEstimateCleared](#event-storyEstimateCleared) - * [storyDeleted](#event-storyDeleted) - * [consensusAchieved](#event-consensusAchieved) - * [revealed](#event-revealed) - * [storyEstimateGiven](#event-storyEstimateGiven) - * [importFailed](#event-importFailed) - * [avatarSet](#event-avatarSet) - * [emailSet](#event-emailSet) - * [excludedFromEstimations](#event-excludedFromEstimations) - * [joinedRoom](#event-joinedRoom) - * [roomCreated](#event-roomCreated) - * [tokenIssued](#event-tokenIssued) - * [usernameSet](#event-usernameSet) - * [kicked](#event-kicked) - * [connectionLost](#event-connectionLost) - * [leftRoom](#event-leftRoom) - * [newEstimationRoundStarted](#event-newEstimationRoundStarted) - * [storyRestored](#event-storyRestored) - * [cardConfigSet](#event-cardConfigSet) - * [passwordCleared](#event-passwordCleared) - * [passwordSet](#event-passwordSet) - * [roomConfigSet](#event-roomConfigSet) - * [sortOrderSet](#event-sortOrderSet) - * [includedInEstimations](#event-includedInEstimations) - * [storyTrashed](#event-storyTrashed) - - -### Event "storyAdded" + * [storyAdded](#event-storyadded-) + * [storySelected](#event-storyselected-) + * [storyChanged](#event-storychanged-) + * [storyEstimateCleared](#event-storyestimatecleared-) + * [storyDeleted](#event-storydeleted-) + * [consensusAchieved](#event-consensusachieved-) + * [revealed](#event-revealed-) + * [storyEstimateGiven](#event-storyestimategiven-) + * [importFailed](#event-importfailed-) + * [avatarSet](#event-avatarset-) + * [emailSet](#event-emailset-) + * [excludedFromEstimations](#event-excludedfromestimations-) + * [joinedRoom](#event-joinedroom-) + * [roomCreated](#event-roomcreated-) + * [tokenIssued](#event-tokenissued-) + * [usernameSet](#event-usernameset-) + * [kicked](#event-kicked-) + * [connectionLost](#event-connectionlost-) + * [leftRoom](#event-leftroom-) + * [newEstimationRoundStarted](#event-newestimationroundstarted-) + * [storyRestored](#event-storyrestored-) + * [cardConfigSet](#event-cardconfigset-) + * [passwordCleared](#event-passwordcleared-) + * [passwordSet](#event-passwordset-) + * [roomConfigSet](#event-roomconfigset-) + * [sortOrderSet](#event-sortorderset-) + * [includedInEstimations](#event-includedinestimations-) + * [storyTrashed](#event-storytrashed-) + + +### Event "storyAdded" Source: [/server/src/eventHandlers/storyAdded.js](/server/src/eventHandlers/storyAdded.js) @@ -1298,7 +1298,7 @@ a new story was added to the room ``` -### Event "storySelected" +### Event "storySelected" Source: [/server/src/eventHandlers/storySelected.js](/server/src/eventHandlers/storySelected.js) @@ -1313,7 +1313,7 @@ Store id of given story as "selectedStory" ``` -### Event "storyChanged" +### Event "storyChanged" Source: [/server/src/eventHandlers/storyChanged.js](/server/src/eventHandlers/storyChanged.js) @@ -1328,7 +1328,7 @@ Title and/or Description of story changed ``` -### Event "storyEstimateCleared" +### Event "storyEstimateCleared" Source: [/server/src/eventHandlers/storyEstimateCleared.js](/server/src/eventHandlers/storyEstimateCleared.js) @@ -1343,7 +1343,7 @@ Removes a previously set estimation value on the given story for the given user ``` -### Event "storyDeleted" +### Event "storyDeleted" Source: [/server/src/eventHandlers/storyDeleted.js](/server/src/eventHandlers/storyDeleted.js) @@ -1358,7 +1358,7 @@ Removes matching story from "stories" list in room ``` -### Event "consensusAchieved" +### Event "consensusAchieved" Source: [/server/src/eventHandlers/consensusAchieved.js](/server/src/eventHandlers/consensusAchieved.js) @@ -1373,7 +1373,7 @@ Stores consensus estimation value (that everybody agreed on) on story. ``` -### Event "revealed" +### Event "revealed" Source: [/server/src/eventHandlers/revealed.js](/server/src/eventHandlers/revealed.js) @@ -1390,7 +1390,7 @@ This happens if a user manually reveals. (this is helpful, if someone is AFK and ``` -### Event "storyEstimateGiven" +### Event "storyEstimateGiven" Source: [/server/src/eventHandlers/storyEstimateGiven.js](/server/src/eventHandlers/storyEstimateGiven.js) @@ -1405,7 +1405,7 @@ Stores the given estimation value on the story for the given user ``` -### Event "importFailed" +### Event "importFailed" Source: [/server/src/eventHandlers/importFailed.js](/server/src/eventHandlers/importFailed.js) @@ -1420,7 +1420,7 @@ a stories import (csv) failed. Does not modify room in any way, ``` -### Event "avatarSet" +### Event "avatarSet" Source: [/server/src/eventHandlers/avatarSet.js](/server/src/eventHandlers/avatarSet.js) @@ -1435,7 +1435,7 @@ user sets his avatar (number) ``` -### Event "emailSet" +### Event "emailSet" Source: [/server/src/eventHandlers/emailSet.js](/server/src/eventHandlers/emailSet.js) @@ -1450,7 +1450,7 @@ user set his email address ``` -### Event "excludedFromEstimations" +### Event "excludedFromEstimations" Source: [/server/src/eventHandlers/excludedFromEstimations.js](/server/src/eventHandlers/excludedFromEstimations.js) @@ -1466,7 +1466,7 @@ Sets "excluded" flag on user to true. ``` -### Event "joinedRoom" +### Event "joinedRoom" Source: [/server/src/eventHandlers/joinedRoom.js](/server/src/eventHandlers/joinedRoom.js) @@ -1482,7 +1482,7 @@ A user joined a room: update "users" array in room object. ``` -### Event "roomCreated" +### Event "roomCreated" Source: [/server/src/eventHandlers/roomCreated.js](/server/src/eventHandlers/roomCreated.js) @@ -1497,7 +1497,7 @@ A room was created. Creates a new default room object ``` -### Event "tokenIssued" +### Event "tokenIssued" Source: [/server/src/eventHandlers/tokenIssued.js](/server/src/eventHandlers/tokenIssued.js) @@ -1512,7 +1512,7 @@ The server issued a new JWT token. this does not modify the room in any way. ``` -### Event "usernameSet" +### Event "usernameSet" Source: [/server/src/eventHandlers/usernameSet.js](/server/src/eventHandlers/usernameSet.js) @@ -1527,7 +1527,7 @@ user set his name ``` -### Event "kicked" +### Event "kicked" Source: [/server/src/eventHandlers/kicked.js](/server/src/eventHandlers/kicked.js) @@ -1543,7 +1543,7 @@ removes estimations on all stories that were given by user ``` -### Event "connectionLost" +### Event "connectionLost" Source: [/server/src/eventHandlers/connectionLost.js](/server/src/eventHandlers/connectionLost.js) @@ -1558,7 +1558,7 @@ Marks user as "disconnected". ``` -### Event "leftRoom" +### Event "leftRoom" Source: [/server/src/eventHandlers/leftRoom.js](/server/src/eventHandlers/leftRoom.js) @@ -1574,7 +1574,7 @@ removes estimations on all stories that were given by user ``` -### Event "newEstimationRoundStarted" +### Event "newEstimationRoundStarted" Source: [/server/src/eventHandlers/newEstimationRoundStarted.js](/server/src/eventHandlers/newEstimationRoundStarted.js) @@ -1589,7 +1589,7 @@ Clears all estimations on story, sets "revealed" flag to false and erases "conse ``` -### Event "storyRestored" +### Event "storyRestored" Source: [/server/src/eventHandlers/storyRestored.js](/server/src/eventHandlers/storyRestored.js) @@ -1605,7 +1605,7 @@ Flag will be "false" afterwards. ``` -### Event "cardConfigSet" +### Event "cardConfigSet" Source: [/server/src/eventHandlers/cardConfigSet.js](/server/src/eventHandlers/cardConfigSet.js) @@ -1620,7 +1620,7 @@ user did set custom cardConfig on room ``` -### Event "passwordCleared" +### Event "passwordCleared" Source: [/server/src/eventHandlers/passwordCleared.js](/server/src/eventHandlers/passwordCleared.js) @@ -1635,7 +1635,7 @@ user removed password protection from room ``` -### Event "passwordSet" +### Event "passwordSet" Source: [/server/src/eventHandlers/passwordSet.js](/server/src/eventHandlers/passwordSet.js) @@ -1650,7 +1650,7 @@ user did set new password for room ``` -### Event "roomConfigSet" +### Event "roomConfigSet" Source: [/server/src/eventHandlers/roomConfigSet.js](/server/src/eventHandlers/roomConfigSet.js) @@ -1666,7 +1666,7 @@ sets issueTrackingUrl on room ``` -### Event "sortOrderSet" +### Event "sortOrderSet" Source: [/server/src/eventHandlers/sortOrderSet.js](/server/src/eventHandlers/sortOrderSet.js) @@ -1683,7 +1683,7 @@ Trashed stories will not be affected. (sortOrder = undefined). ``` -### Event "includedInEstimations" +### Event "includedInEstimations" Source: [/server/src/eventHandlers/includedInEstimations.js](/server/src/eventHandlers/includedInEstimations.js) @@ -1699,7 +1699,7 @@ Sets "excluded" flag on user to false. ``` -### Event "storyTrashed" +### Event "storyTrashed" Source: [/server/src/eventHandlers/storyTrashed.js](/server/src/eventHandlers/storyTrashed.js) diff --git a/docu/templates/commandAndEventDocu.ejs b/docu/templates/commandAndEventDocu.ejs index 6b8ae8a6..0fb1a77c 100644 --- a/docu/templates/commandAndEventDocu.ejs +++ b/docu/templates/commandAndEventDocu.ejs @@ -7,7 +7,7 @@ This is an autogenerated docu. <%= now %> (Poinz version <%= version %>) ## Commands <% commandHandlerFileData.forEach( (cmdInfo) => { -%> - * [<%= cmdInfo.commandName %>](#command-<%= cmdInfo.commandName %>) + * [<%= cmdInfo.commandName %>](#command-<%= cmdInfo.commandName.toLowerCase() %>-) <% }) %> <% commandHandlerFileData.forEach( (cmdInfo) => { -%> @@ -16,7 +16,7 @@ This is an autogenerated docu. <%= now %> (Poinz version <%= version %>) ## Events <% eventList.forEach( (evtInfo) => { -%> - * [<%= evtInfo.eventName %>](#event-<%= evtInfo.eventName %>) + * [<%= evtInfo.eventName %>](#event-<%= evtInfo.eventName.toLowerCase() %>-) <% }) %> <% eventList.forEach( (evtInfo) => { -%> diff --git a/docu/templates/singleCommand.ejs b/docu/templates/singleCommand.ejs index 6d5a7eab..dd6dc8a5 100644 --- a/docu/templates/singleCommand.ejs +++ b/docu/templates/singleCommand.ejs @@ -1,4 +1,4 @@ -### Command "<%= cmdInfo.commandName %>" +### Command "<%= cmdInfo.commandName %>" Source: [<%=cmdInfo.relativeFilePath %>](<%=cmdInfo.relativeFilePath %>) diff --git a/docu/templates/singleEvent.ejs b/docu/templates/singleEvent.ejs index 51fbf15d..0408c54e 100644 --- a/docu/templates/singleEvent.ejs +++ b/docu/templates/singleEvent.ejs @@ -1,4 +1,4 @@ -### Event "<%= evtInfo.eventName %>" +### Event "<%= evtInfo.eventName %>" Source: [<%= evtInfo.relativeFilePath %>](<%= evtInfo.relativeFilePath %>)