@hitchy/plugin-odem-socket.io 0.2.3 → 0.2.4

package/api/services/odem/websocket-provider.js

@@ -7,8 +7,8 @@ module.exports = function() {
 	const logError = api.log( "hitchy:odem:socket.io:error" );
 
 	/**
-	 * Implements API for controlling and monitoring server-side ODM via
-	 * websocket.
+	 * Implements API for controlling and monitoring server-side
+	 * document-oriented database via websocket.
 	 */
 	class OdemWebsocketProvider {
 		/**
@@ -68,7 +68,7 @@ module.exports = function() {
 		 * @param {boolean} enabled true if command handling is enabled in configuration
 		 * @param {WebSocket} socket socket representing established incoming connection
 		 * @param {string} modelName name of model to manage
-		 * @param {class<Hitchy.Plugin.Odem.Model>} model ODM-based model instance to manage
+		 * @param {class<Hitchy.Plugin.Odem.Model>} model model instance based on document-oriented database to manage
 		 * @returns {Object<string,function>} map of registered handler functions
 		 */
 		static handleModelRequests( enabled, socket, modelName, model ) {
@@ -120,13 +120,14 @@ module.exports = function() {
 		}
 
 		/**
-		 * Sets up listeners for model-related notifications in ODM and forwards
-		 * them as broadcast events to connected clients.
+		 * Sets up listeners for model-related notifications in
+		 * document-oriented database and forwards them as broadcast events to
+		 * connected clients.
 		 *
 		 * @param {boolean} enabled true if command handling is enabled in configuration
 		 * @param {Server} namespace namespace managing a list of server-side sockets with common prefix
 		 * @param {string} modelName name of model to manage
-		 * @param {class<Hitchy.Plugin.Odem.Model>} model ODM-based model instance to manage
+		 * @param {class<Hitchy.Plugin.Odem.Model>} model model instance of document-oriented database to manage
 		 * @returns {Object<string,function>} map of registered handler functions
 		 */
 		static broadcastModelNotifications( enabled, namespace, modelName, model ) {

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@hitchy/plugin-odem-socket.io",
-	"version": "0.2.3",
-	"description": "exposing Hitchy's ODM via websocket",
+	"version": "0.2.4",
+	"description": "exposing Hitchy's document-oriented database via websocket",
 	"main": "index.js",
 	"scripts": {
 		"lint": "eslint .",
@@ -14,8 +14,7 @@
 	},
 	"keywords": [
 		"Hitchy",
-		"socket.io",
-		"ODM"
+		"socket.io"
 	],
 	"author": "cepharum GmbH",
 	"license": "MIT",
@@ -35,13 +34,13 @@
 		"@hitchy/plugin-socket.io": ">=0.1.1"
 	},
 	"devDependencies": {
-		"@hitchy/server-dev-tools": "^0.4.6",
-		"c8": "^8.0.1",
-		"eslint": "^8.47.0",
-		"eslint-config-cepharum": "^1.0.13",
-		"eslint-plugin-promise": "^6.1.1",
-		"mocha": "^10.2.0",
+		"@hitchy/server-dev-tools": "^0.4.9",
+		"c8": "^10.1.2",
+		"eslint": "^8.57.0",
+		"eslint-config-cepharum": "^1.0.14",
+		"eslint-plugin-promise": "^7.1.0",
+		"mocha": "^10.7.3",
 		"should": "^13.2.3",
-		"socket.io-client": "^4.7.2"
+		"socket.io-client": "^4.7.5"
 	}
 }

package/readme.md

@@ -1,6 +1,6 @@
 # @hitchy/plugin-odem-socket.io
 
-_exposing Hitchy's ODM via websocket_
+_exposing Hitchy's document-oriented database via websocket_
 
 ## License
 
@@ -29,7 +29,7 @@ npm i @hitchy/plugin-odem @hitchy/plugin-socket.io
 
 ### Basics
 
-This plugin is establishing an API via websocket for controlling and monitoring models of server-side ODM. Relying on particular features of [socket.io](https://socket.io/), this API is exposed in [namespace](https://socket.io/docs/v4/namespaces/) `/hitchy/odem`. 
+This plugin is establishing an API via websocket for controlling and monitoring models of server-side document-oriented database. Relying on particular features of [socket.io](https://socket.io/), this API is exposed in [namespace](https://socket.io/docs/v4/namespaces/) `/hitchy/odem`. 
 
 For every server-side model, request listeners and/or notification broadcasters are set up. Either model's name is converted into its kebab-case variant and used as colon-separated prefix in event names emitted either by the server or by a client. 
 
@@ -156,7 +156,7 @@ Last argument is a callback to be invoked with the resulting response from serve
 
 ### Notifications
 
-[ODM notifications](https://odem.hitchy.org/api/model.html#model-notifications) are forwarded as broadcast events named `<modelName>:changed`. Either event consists of 
+[notifications of the document-oriented database](https://odem.hitchy.org/api/model.html#model-notifications) are forwarded as broadcast events named `<modelName>:changed`. Either event consists of 
 
 - a type of change and 
 - the changed item's properties (limited to its UUID on deletion).