Changed the file structure around a bit.

Author: mo-g

Models/contact.js renamed to Models/contact.mjs

@@ -0,0 +1 @@
+export * from './user.mjs';

Models/index.mjs

@@ -1,93 +1,113 @@
-/**
- * Combadge-protocol, an implementation of an OEM Combadge control protocol for Spin Doctor
- * Copyright (C) 2021-2022 The Combadge Project by mo-g
- *
- * Combadge-protocol is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Affero General Public License as published by
- * the Free Software Foundation, version 3 of the License.
- *
- * Combadge-protocol is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with Combadge-protocol.  If not, see <https://www.gnu.org/licenses/>.
- */
-
-userTemplate = { 
-    userName: "u-fallbackuser", // Globally unique ID
-    fullName: new UserFullName(foreName = "Fallback", familyName = "User", nickName = "Fallback User"),
-    ipaPronunciation: "fɔːlbæk ˈjuːzə", // Not currently in use for STT or TTS but worth adding.
-    associatedGroups: [],
-
-    assignedBadge: "ba:dg:em:ac:ad:dr", // Optional, for autologin/whitelisting
-    personalTerminals: [] // Being vidcom terminals that can be used to make video calls.
-};
-
-groupTemplate = {
-    groupName: "g-allhands",
-    nickName: "All Hands",
-    ipaPronunciation: "ɔːl hændz", // Not currently in use for STT or TTS but worth adding.
-    associatedUsers: [],
-
-    assignedAddress: "Placeholder for multicast IPAddress Object"
-};
-
-
-/**
- * Frst pass. Probably want to restructure this to allow returning different form of name.
- * 
- * Assume middle names to include patronyms. Should obviously be treated as an ordered list regardless.
- * Do we want to merge pronunciation in to this as well?
- */
-class UserFullName {
-    constructor ({prefix = "", foreName = "", middleNames = [], familyName = "", suffix = "", nickName = ""} = {}) {
-        this.prefix = prefix;
-        this.foreName = foreName;
-        this.middleNames = middleNames;
-        this.familyName = familyName;
-        this.suffix = suffix;
-        this.nickName = nickName;
-
-        preferredFormat = this.fullName;
-    };
-
-    fullName () {
-        var assembled = "";
-        if (this.prefix) {assembled += this.prefix};
-        if (this.foreName) {assembled += this.foreName};
-        if (this.middleNames) {
-            this.middleNames.forEach(function (name) {
-                assembled += name;
-            });
-        };
-        if (this.familyName) {assembled += this.familyName};
-        if (this.suffix) {assembled += this.suffix};
-
-        if (assembled) {
-            return assembled;
-        } else {
-            throw "Cannot stringify empty name."
-        };
-    };
-
-    toString () {
-        return this.preferredFormat();
-    };
-
-}
-
-class User {
-    constructor () {
-
-    };
-};
-
-class Group {
-    constructor () {
-
-    };
-};
-
+/**
+ * Spin Doctor, a Combadge Voice Server
+ * Copyright (C) 2021-2022 The Combadge Project by mo-g
+ * 
+ * Spin Doctor is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, version 3 of the License.
+ * 
+ * Spin Doctor is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ * 
+ * You should have received a copy of the GNU General Public License
+ * along with Spin Doctor.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+
+/**
+ * User class describes a person who signs in to a Communicator. A User will
+ * have the following mandatory attributes:
+ * - username: a unique identifier. This will link a User object to it's source
+ *   in the database, and will be derived from and associated to any directory.
+ * - name: The user's human-readable name as they or the directory records.
+ * 
+ * Additionally, a User may have the following optional attributes:
+ * - presence: A representation of the presence state of the user. This could
+ *   be offline, available, DND, in-call.
+ * - permittedContacts: A machine readable reference to the contacts permitted
+ *   to contact this user. i.e. in SME, allow your secretary to contact the CEO
+ *   but not the chaiwala. Should probably handle state-dependent logic - i.e.
+ *   allow your partner to contact you in DND mode, but not your mother-in-law.
+ * - personalContacts: A store of the contacts that relate specifically to you.
+ *   E.G. Your pharmacy, your work. This allows shorthands that wouldn't make
+ *   sense when used by other people.
+ */
+
+ userTemplate = { 
+    userName: "u-fallbackuser", // Globally unique ID
+    fullName: new UserFullName(foreName = "Fallback", familyName = "User", nickName = "Fallback User"),
+    ipaPronunciation: "fɔːlbæk ˈjuːzə", // Not currently in use for STT or TTS but worth adding.
+    associatedGroups: [],
+
+    assignedDevices: ["ba:dg:em:ac:ad:dr"], // Optional, for autologin/whitelisting
+    personalTerminals: ["te:rm:in:al:ma:cs"] // Being vidcom terminals that can be used to make video calls.
+};
+
+groupTemplate = {
+    groupName: "g-allhands",
+    nickName: "All Hands",
+    ipaPronunciation: "ɔːl hændz", // Not currently in use for STT or TTS but worth adding.
+    associatedUsers: [],
+
+    assignedAddress: "Placeholder for multicast IPAddress Object"
+};
+
+
+/**
+ * Frst pass. Probably want to restructure this to allow returning different form of name.
+ * 
+ * Assume middle names to include patronyms. Should obviously be treated as an ordered list regardless.
+ * Do we want to merge pronunciation in to this as well?
+ */
+class UserFullName {
+    constructor ({prefix = "", foreName = "", middleNames = [], familyName = "", suffix = "", nickName = ""} = {}) {
+        this.prefix = prefix;
+        this.foreName = foreName;
+        this.middleNames = middleNames;
+        this.familyName = familyName;
+        this.suffix = suffix;
+        this.nickName = nickName;
+
+        preferredFormat = this.fullName;
+    };
+
+    fullName () {
+        var assembled = "";
+        if (this.prefix) {assembled += this.prefix};
+        if (this.foreName) {assembled += this.foreName};
+        if (this.middleNames) {
+            this.middleNames.forEach(function (name) {
+                assembled += name;
+            });
+        };
+        if (this.familyName) {assembled += this.familyName};
+        if (this.suffix) {assembled += this.suffix};
+
+        if (assembled) {
+            return assembled;
+        } else {
+            throw "Cannot stringify empty name."
+        };
+    };
+
+    toString () {
+        return this.preferredFormat();
+    };
+
+}
+
+class User {
+    constructor () {
+
+    };
+};
+
+class Group {
+    constructor () {
+
+    };
+};
+
 export { User, Group };

Models/terminal.js renamed to Models/terminal.mjs

@@ -25,6 +25,7 @@
 
 import dgram from 'dgram';
 import { CombadgePacket, Combadge } from './Libraries/ecma-cccp/index.mjs';
+import { User, Group } from './Models/index.mjs';
 import { Agent } from './Libraries/robin-agent/index.mjs';
 import { RTPHeader, RTPPacket } from './Libraries/ecma-rtp/index.mjs';
 import express from 'express';