@prestizni-software/server-dem 0.7.3 → 0.7.4

package/dist/AutoUpdateManagerClass.d.ts

@@ -17,21 +17,86 @@ export declare abstract class AutoUpdateManager<T extends IAutoUpdatedClientObje
     };
     protected loggers: LoggersType;
     protected emitter: EventEmitter3;
+    /**
+     * Initializes the base AutoUpdateManager instance.
+     * Extracts registered property metadata from the class prototype.
+     *
+     * @param classParam - The constructor function of the managed object class.
+     * @param className - The name identifier of the managed class.
+     * @param socket - The socket instance (client Socket.IO or server Server).
+     * @param loggers - Logging interfaces for info, debug, warn, and error levels.
+     * @param managers - Registry of sibling managers.
+     * @param emitter - Event emitter for manager and lifecycle events.
+     * @throws {DEMError} Throws DEMErrorCode.MISSING_ARGUMENT when classParam is omitted.
+     */
     constructor(classParam: Constructor<T>, className: string, socket: unknown, loggers: LoggersType, managers: M, emitter: EventEmitter3);
+    /**
+     * Indicates whether the manager has completed its initialization and reference loading.
+     *
+     * @returns True when the manager is fully loaded.
+     */
     get isLoaded(): boolean;
+    /**
+     * Closes the manager, purges cached objects, and disconnects the underlying socket.
+     */
     close(): void;
+    /**
+     * Asynchronously loads unresolved references across all managed objects.
+     * Marks the manager as loaded upon completion.
+     *
+     * @returns A promise that resolves when all references are loaded.
+     */
     loadReferences(): Promise<void>;
+    /**
+     * Deletes an object by its identifier, destroys the instance, and clears global caches.
+     *
+     * @param _id - The unique identifier of the object to delete.
+     * @returns A promise resolving to the deletion result object.
+     */
     deleteObject(_id: MongoId): Promise<{
         success: boolean;
         message: string;
         code?: DEMErrorCode;
     }>;
+    /**
+     * Retrieves an array of all managed object string identifiers.
+     *
+     * @returns Array of object ID strings.
+     */
     get objectIDs(): string[];
+    /**
+     * Fetches an object missing from local memory.
+     *
+     * @param _id - Identifier of the missing object.
+     * @returns A promise resolving to the retrieved object instance.
+     */
     abstract handleGetMissingObject(_id: MongoId): Promise<T>;
+    /**
+     * Creates a new object instance.
+     *
+     * @param data - Object initial data properties without the `_id` field.
+     * @returns A promise resolving to the created object instance.
+     */
     abstract createObject(data: Omit<IsData<T>, "_id">): Promise<T>;
+    /**
+     * Retrieves a managed object from local state by ID.
+     *
+     * @param _id - Optional identifier of the object.
+     * @returns The object instance, null, or undefined.
+     */
     abstract getObject(_id?: MongoId): T | null | undefined;
+    /**
+     * Retrieves the dictionary of all managed objects keyed by their identifier.
+     *
+     * @returns Map of objects keyed by string ID.
+     */
     abstract get objects(): {
         [_id: string]: T;
     };
+    /**
+     * Retrieves all managed objects as an array.
+     *
+     * @returns Array containing all managed object instances.
+     */
     abstract get objectsAsArray(): T[];
 }

package/dist/AutoUpdateManagerClass.js

@@ -19,6 +19,18 @@ export class AutoUpdateManager {
         warn: () => { },
     };
     emitter;
+    /**
+     * Initializes the base AutoUpdateManager instance.
+     * Extracts registered property metadata from the class prototype.
+     *
+     * @param classParam - The constructor function of the managed object class.
+     * @param className - The name identifier of the managed class.
+     * @param socket - The socket instance (client Socket.IO or server Server).
+     * @param loggers - Logging interfaces for info, debug, warn, and error levels.
+     * @param managers - Registry of sibling managers.
+     * @param emitter - Event emitter for manager and lifecycle events.
+     * @throws {DEMError} Throws DEMErrorCode.MISSING_ARGUMENT when classParam is omitted.
+     */
     constructor(classParam, className, socket, loggers, managers, emitter) {
         if (!classParam)
             throw new DEMError(DEMErrorCode.MISSING_ARGUMENT, "Missing required argument: classParam");
@@ -43,9 +55,17 @@ export class AutoUpdateManager {
         this.loggers.error = (s) => loggers.error?.("[DEM - " + className + " MANAGER] " + s);
         this.loggers.warn = (s) => loggers.warn?.("[DEM - " + className + " MANAGER] " + s);
     }
+    /**
+     * Indicates whether the manager has completed its initialization and reference loading.
+     *
+     * @returns True when the manager is fully loaded.
+     */
     get isLoaded() {
         return this.isLoaded_;
     }
+    /**
+     * Closes the manager, purges cached objects, and disconnects the underlying socket.
+     */
     close() {
         for (const id of this.objectIDs) {
             delete this.objects_[id];
@@ -55,10 +75,22 @@ export class AutoUpdateManager {
             this.socket.disconnectSockets?.(true);
         this.loggers.info("Goodbye, see you next time!");
     }
+    /**
+     * Asynchronously loads unresolved references across all managed objects.
+     * Marks the manager as loaded upon completion.
+     *
+     * @returns A promise that resolves when all references are loaded.
+     */
     async loadReferences() {
         await Promise.all(this.objectsAsArray.map((obj) => obj.loadMissingReferences()));
         this.isLoaded_ = true;
     }
+    /**
+     * Deletes an object by its identifier, destroys the instance, and clears global caches.
+     *
+     * @param _id - The unique identifier of the object to delete.
+     * @returns A promise resolving to the deletion result object.
+     */
     async deleteObject(_id) {
         const _idStr = _id.toString();
         const o = this.objects_[_idStr];
@@ -73,6 +105,11 @@ export class AutoUpdateManager {
         o?.callbacks?.delete?.(this);
         return res ?? { success: true, message: "Already gone" };
     }
+    /**
+     * Retrieves an array of all managed object string identifiers.
+     *
+     * @returns Array of object ID strings.
+     */
     get objectIDs() {
         return Object.keys(this.objects_);
     }

package/dist/AutoUpdateManagerClass.js.map

@@ -1 +1 @@
-{"version":3,"file":"AutoUpdateManagerClass.js","sourceRoot":"","sources":["../AutoUpdateManagerClass.ts"],"names":[],"mappings":"AAAA,OAAO,EASL,WAAW,EACX,QAAQ,EACR,YAAY,GACb,MAAM,kBAAkB,CAAC;AAC1B,OAAO,kBAAkB,CAAC;AAE1B,MAAM,OAAgB,iBAAiB;IAQ3B,SAAS,GAAG,KAAK,CAAC;IACZ,MAAM,CAAU;IACtB,UAAU,CAAiB;IAC3B,UAAU,CAAW;IACf,SAAS,CAAS;IAClB,KAAK,GAAa;QAChC,UAAU,EAAE,EAAE;KACf,CAAC;IACc,QAAQ,CAAI;IAClB,SAAS,GAAG,KAAK,CAAC;IAClB,0BAA0B,GAA8B,EAAE,CAAC;IAC3D,OAAO,GAAgB;QAC/B,IAAI,EAAE,GAAG,EAAE,GAAE,CAAC;QACd,KAAK,EAAE,GAAG,EAAE,GAAE,CAAC;QACf,KAAK,EAAE,GAAG,EAAE,GAAE,CAAC;QACf,IAAI,EAAE,GAAG,EAAE,GAAE,CAAC;KACf,CAAC;IACQ,OAAO,CAAgB;IAEjC,YACE,UAA0B,EAC1B,SAAiB,EACjB,MAAe,EACf,OAAoB,EACpB,QAAW,EACX,OAAsB;QAEtB,IAAI,CAAC,UAAU;YACb,MAAM,IAAI,QAAQ,CAChB,YAAY,CAAC,gBAAgB,EAC7B,uCAAuC,CACxC,CAAC;QACJ,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAE7B,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAU,CAAC;QACnC,IAAI,MAAM,GAAG,UAAU,CAAC,SAAS,CAAC;QAClC,OAAO,MAAM,IAAI,MAAM,KAAK,MAAM,CAAC,SAAS,EAAE,CAAC;YAC7C,MAAM,KAAK,GACT,OAAO,CAAC,cAAc,CAAC,OAAO,EAAE,MAAM,CAAC;gBACvC,OAAO,CAAC,WAAW,CAAC,OAAO,EAAE,MAAM,CAAC;gBACpC,EAAE,CAAC;YACL,KAAK,MAAM,CAAC,IAAI,KAAK;gBAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;YACvC,MAAM,GAAG,MAAM,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;QACzC,CAAC;QACD,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAEvC,IAAI,CAAC,OAAO,CAAC,KAAK,GAAG,CAAC,CAAS,EAAE,EAAE,CACjC,OAAO,CAAC,KAAK,EAAE,CAAC,SAAS,GAAG,SAAS,GAAG,YAAY,GAAG,CAAC,CAAC,CAAC;QAC5D,IAAI,CAAC,OAAO,CAAC,IAAI,GAAG,CAAC,CAAS,EAAE,EAAE,CAChC,OAAO,CAAC,IAAI,EAAE,CAAC,SAAS,GAAG,SAAS,GAAG,YAAY,GAAG,CAAC,CAAC,CAAC;QAC3D,IAAI,CAAC,OAAO,CAAC,KAAK,GAAG,CAAC,CAAS,EAAE,EAAE,CACjC,OAAO,CAAC,KAAK,EAAE,CAAC,SAAS,GAAG,SAAS,GAAG,YAAY,GAAG,CAAC,CAAC,CAAC;QAC5D,IAAI,CAAC,OAAO,CAAC,IAAI,GAAG,CAAC,CAAS,EAAE,EAAE,CAChC,OAAO,CAAC,IAAI,EAAE,CAAC,SAAS,GAAG,SAAS,GAAG,YAAY,GAAG,CAAC,CAAC,CAAC;IAC7D,CAAC;IAED,IAAW,QAAQ;QACjB,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAEM,KAAK;QACV,KAAK,MAAM,EAAE,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YAChC,OAAO,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;YACzB,OAAO,WAAW,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QACjC,CAAC;QAEC,IAAI,CAAC,MAIN,CAAC,UAAU,EAAE,EAAE;YAEZ,IAAI,CAAC,MAIN,CAAC,iBAAiB,EAAE,CAAC,IAAI,CAAC,CAAC;QAC9B,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,6BAA6B,CAAC,CAAC;IACnD,CAAC;IAEM,KAAK,CAAC,cAAc;QACzB,MAAM,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,qBAAqB,EAAE,CAAC,CAAC,CAAC;QACjF,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;IACxB,CAAC;IAEM,KAAK,CAAC,YAAY,CACvB,GAAY;QAEZ,MAAM,MAAM,GAAG,GAAG,CAAC,QAAQ,EAAE,CAAC;QAC9B,MAAM,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QAChC,IAAI,GAAsD,CAAC;QAC3D,IAAI,CAAC,IAAI,OAAO,CAAC,CAAC,OAAO,KAAK,UAAU,EAAE,CAAC;YACzC,GAAG,GAAG,MAAM,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAC9B,CAAC;QACD,IAAI,GAAG,EAAE,OAAO,IAAI,CAAC,CAAC,IAAI,OAAO,CAAC,EAAE,OAAO,KAAK,UAAU,EAAE,CAAC;YAC3D,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;YAC7B,OAAO,WAAW,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QACrC,CAAC;QACD,CAAC,EAAE,SAAS,EAAE,MAAM,EAAE,CAAC,IAAI,CAAC,CAAC;QAC7B,OAAO,GAAG,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,cAAc,EAAE,CAAC;IAC3D,CAAC;IAED,IAAW,SAAS;QAClB,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACpC,CAAC;CAWF"}
+{"version":3,"file":"AutoUpdateManagerClass.js","sourceRoot":"","sources":["../AutoUpdateManagerClass.ts"],"names":[],"mappings":"AAAA,OAAO,EASL,WAAW,EACX,QAAQ,EACR,YAAY,GACb,MAAM,kBAAkB,CAAC;AAC1B,OAAO,kBAAkB,CAAC;AAE1B,MAAM,OAAgB,iBAAiB;IAQ3B,SAAS,GAAG,KAAK,CAAC;IACZ,MAAM,CAAU;IACtB,UAAU,CAAiB;IAC3B,UAAU,CAAW;IACf,SAAS,CAAS;IAClB,KAAK,GAAa;QAChC,UAAU,EAAE,EAAE;KACf,CAAC;IACc,QAAQ,CAAI;IAClB,SAAS,GAAG,KAAK,CAAC;IAClB,0BAA0B,GAA8B,EAAE,CAAC;IAC3D,OAAO,GAAgB;QAC/B,IAAI,EAAE,GAAG,EAAE,GAAE,CAAC;QACd,KAAK,EAAE,GAAG,EAAE,GAAE,CAAC;QACf,KAAK,EAAE,GAAG,EAAE,GAAE,CAAC;QACf,IAAI,EAAE,GAAG,EAAE,GAAE,CAAC;KACf,CAAC;IACQ,OAAO,CAAgB;IAEjC;;;;;;;;;;;OAWG;IACH,YACE,UAA0B,EAC1B,SAAiB,EACjB,MAAe,EACf,OAAoB,EACpB,QAAW,EACX,OAAsB;QAEtB,IAAI,CAAC,UAAU;YACb,MAAM,IAAI,QAAQ,CAChB,YAAY,CAAC,gBAAgB,EAC7B,uCAAuC,CACxC,CAAC;QACJ,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAE7B,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAU,CAAC;QACnC,IAAI,MAAM,GAAG,UAAU,CAAC,SAAS,CAAC;QAClC,OAAO,MAAM,IAAI,MAAM,KAAK,MAAM,CAAC,SAAS,EAAE,CAAC;YAC7C,MAAM,KAAK,GACT,OAAO,CAAC,cAAc,CAAC,OAAO,EAAE,MAAM,CAAC;gBACvC,OAAO,CAAC,WAAW,CAAC,OAAO,EAAE,MAAM,CAAC;gBACpC,EAAE,CAAC;YACL,KAAK,MAAM,CAAC,IAAI,KAAK;gBAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;YACvC,MAAM,GAAG,MAAM,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;QACzC,CAAC;QACD,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAEvC,IAAI,CAAC,OAAO,CAAC,KAAK,GAAG,CAAC,CAAS,EAAE,EAAE,CACjC,OAAO,CAAC,KAAK,EAAE,CAAC,SAAS,GAAG,SAAS,GAAG,YAAY,GAAG,CAAC,CAAC,CAAC;QAC5D,IAAI,CAAC,OAAO,CAAC,IAAI,GAAG,CAAC,CAAS,EAAE,EAAE,CAChC,OAAO,CAAC,IAAI,EAAE,CAAC,SAAS,GAAG,SAAS,GAAG,YAAY,GAAG,CAAC,CAAC,CAAC;QAC3D,IAAI,CAAC,OAAO,CAAC,KAAK,GAAG,CAAC,CAAS,EAAE,EAAE,CACjC,OAAO,CAAC,KAAK,EAAE,CAAC,SAAS,GAAG,SAAS,GAAG,YAAY,GAAG,CAAC,CAAC,CAAC;QAC5D,IAAI,CAAC,OAAO,CAAC,IAAI,GAAG,CAAC,CAAS,EAAE,EAAE,CAChC,OAAO,CAAC,IAAI,EAAE,CAAC,SAAS,GAAG,SAAS,GAAG,YAAY,GAAG,CAAC,CAAC,CAAC;IAC7D,CAAC;IAED;;;;OAIG;IACH,IAAW,QAAQ;QACjB,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED;;OAEG;IACI,KAAK;QACV,KAAK,MAAM,EAAE,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YAChC,OAAO,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;YACzB,OAAO,WAAW,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QACjC,CAAC;QAEC,IAAI,CAAC,MAIN,CAAC,UAAU,EAAE,EAAE;YAEZ,IAAI,CAAC,MAIN,CAAC,iBAAiB,EAAE,CAAC,IAAI,CAAC,CAAC;QAC9B,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,6BAA6B,CAAC,CAAC;IACnD,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,cAAc;QACzB,MAAM,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,qBAAqB,EAAE,CAAC,CAAC,CAAC;QACjF,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;IACxB,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,YAAY,CACvB,GAAY;QAEZ,MAAM,MAAM,GAAG,GAAG,CAAC,QAAQ,EAAE,CAAC;QAC9B,MAAM,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QAChC,IAAI,GAAsD,CAAC;QAC3D,IAAI,CAAC,IAAI,OAAO,CAAC,CAAC,OAAO,KAAK,UAAU,EAAE,CAAC;YACzC,GAAG,GAAG,MAAM,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAC9B,CAAC;QACD,IAAI,GAAG,EAAE,OAAO,IAAI,CAAC,CAAC,IAAI,OAAO,CAAC,EAAE,OAAO,KAAK,UAAU,EAAE,CAAC;YAC3D,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;YAC7B,OAAO,WAAW,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QACrC,CAAC;QACD,CAAC,EAAE,SAAS,EAAE,MAAM,EAAE,CAAC,IAAI,CAAC,CAAC;QAC7B,OAAO,GAAG,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,cAAc,EAAE,CAAC;IAC3D,CAAC;IAED;;;;OAIG;IACH,IAAW,SAAS;QAClB,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACpC,CAAC;CAuCF"}

package/dist/AutoUpdateServerManagerClass.d.ts

@@ -64,10 +64,25 @@ export type DEMEvent<C extends IAutoUpdatedClientObject<any>> = {
     data: Omit<IsData<C>, "_id">;
 };
 /**
- * Inspect database states for all server managers.
- * Throws DEMError if any manager database is not connected.
+ * Inspects database readiness states across all configured server managers.
+ *
+ * @param managers - Registry of server managers to inspect.
+ * @param loggers - Optional logger callbacks.
+ * @param emitter - Optional event emitter for error events.
+ * @throws {DEMError} Throws DEMErrorCode.DB_NOT_CONNECTED if any database is disconnected.
  */
 export declare function checkServerDbStates(managers: Record<string, AutoUpdateServerManager<any>>, loggers?: LoggersType, emitter?: EventEmitter3): void;
+/**
+ * Initializes and starts all server managers, executes DB state assertions, preloads data, and attaches sockets.
+ *
+ * @param defs - Server manager definitions including class constructors and options.
+ * @param loggers_ - Loggers interface.
+ * @param socket - Socket.IO server instance.
+ * @param doDebug - Flag indicating whether debug logging is enabled.
+ * @param emitter - Shared event emitter.
+ * @param models - Optional model registry.
+ * @returns Promise resolving to the map of initialized server managers.
+ */
 export declare function AUSManagerFactory<T extends Record<string, IAutoUpdatedClientObject<any>>>(defs: AUSDefinitions<T>, loggers_: LoggersType, socket: Server, doDebug?: boolean, emitter?: EventEmitter3, models?: unknown): Promise<WrappedInstances<T>>;
 export declare class AutoUpdateServerManager<T extends IAutoUpdatedClientObject<T>, M extends Record<string, IAutoUpdateManager<any>> = any> extends AutoUpdateManager<T, M> {
     readonly model: ReturnModelType<any, BeAnObject>;
@@ -85,9 +100,23 @@ export declare class AutoUpdateServerManager<T extends IAutoUpdatedClientObject<
     } | null;
     private _cachedObjectsArray;
     readonly changeTracker?: ServerChangeTracker;
+    /**
+     * Initializes an AutoUpdateServerManager instance.
+     *
+     * @param classParam - Target server object class constructor.
+     * @param className - Managed entity class name.
+     * @param socket - Socket.IO Server instance.
+     * @param loggers - Logger callbacks interface.
+     * @param model - Typegoose Mongoose model for database operations.
+     * @param managers - Sibling server managers registry.
+     * @param emitter - Shared event emitter.
+     * @param options - Server manager options including access middlewares and delta sync settings.
+     */
     constructor(classParam: Constructor<T>, className: string, socket: Server, loggers: LoggersType, model: ReturnModelType<any, BeAnObject>, managers: M, emitter: EventEmitter3, options?: AUSOption<T, Record<string, IAutoUpdatedClientObject<any>>>);
     /**
-     * Inspect current database connection state.
+     * Inspects current database connection state.
+     *
+     * @returns Object describing connected flag, numeric readyState, and stateName.
      */
     checkDbState(): {
         connected: boolean;
@@ -95,25 +124,85 @@ export declare class AutoUpdateServerManager<T extends IAutoUpdatedClientObject<
         stateName: string;
     };
     /**
-     * Verify database connection is active.
-     * Throws DEMError if database is not connected.
+     * Verifies database connection is active.
+     *
+     * @throws {DEMError} Throws DEMErrorCode.DB_NOT_CONNECTED if database is not connected.
      */
     assertDbConnected(): void;
+    /**
+     * Preloads all database documents into memory for the manager class.
+     *
+     * @param options - Optional batch loading options.
+     * @returns Promise resolving when all entities are loaded and populated in globalCache.
+     */
     preLoad(options?: {
         batchSize?: number;
     }): Promise<void>;
+    /**
+     * Resolves back-references and pointers across loaded objects.
+     *
+     * @returns Promise resolving when reference resolution completes.
+     */
     loadReferences(): Promise<void>;
+    /**
+     * Registers a client socket with the manager and binds startup, delete, and new event listeners.
+     *
+     * @param socket - Connected client Socket instance.
+     */
     registerSocket(socket: Socket): void;
+    /**
+     * Retrieves a server managed object by identifier.
+     *
+     * @param _id - Optional entity identifier.
+     * @returns Managed entity instance, null, or undefined.
+     */
     getObject(_id?: MongoId): T | null | undefined;
+    /**
+     * Dictionary of all managed entities keyed by their string IDs.
+     *
+     * @returns Map of managed entities.
+     */
     get objects(): Record<string, T>;
+    /**
+     * Array representation of all managed entities.
+     *
+     * @returns Array containing all managed entities.
+     */
     get objectsAsArray(): T[];
+    /**
+     * Deletes an entity from database, manager cache, and mutation tracker.
+     *
+     * @param _id - Identifier of entity to delete.
+     * @returns Promise resolving to deletion outcome object.
+     */
     deleteObject(_id: MongoId): Promise<{
         success: boolean;
         message: string;
         code?: DEMErrorCode;
     }>;
     private pendingMissingFetches;
+    /**
+     * Retrieves an entity missing from memory by querying MongoDB directly.
+     *
+     * @param _id - Identifier of missing entity.
+     * @returns Promise resolving to the retrieved server object.
+     * @throws {DEMError} Throws DEMErrorCode.DOCUMENT_NOT_FOUND or MANAGERS_NOT_INITIALIZED.
+     */
     handleGetMissingObject(_id: MongoId): Promise<T>;
+    /**
+     * Creates a new entity document in MongoDB and instantiates its manager wrapper.
+     * Broadcasts creation event to client sockets with authorized access.
+     *
+     * @param data - Initial entity properties.
+     * @returns Promise resolving to the created server entity.
+     * @throws {DEMError} Throws DEMErrorCode.MANAGERS_NOT_INITIALIZED.
+     */
     createObject(data: Omit<IsData<T>, "_id">): Promise<T>;
+    /**
+     * Re-evaluates client socket permissions against dynamic startup middleware rules.
+     * Emits 'new' or 'delete' socket events when client access changes dynamically.
+     *
+     * @param object - Entity to evaluate.
+     */
     checkPermissionBoundaries(object: T): Promise<void>;
 }

package/dist/AutoUpdateServerManagerClass.js

@@ -12,6 +12,14 @@ export var DEMEventTypes;
     DEMEventTypes["get"] = "get";
     DEMEventTypes["startup"] = "startup";
 })(DEMEventTypes || (DEMEventTypes = {}));
+/**
+ * Configures event whitelisting and permission middleware for the Socket.IO server.
+ *
+ * @param socket_server - Socket.IO server instance.
+ * @param loggers - Logging interfaces.
+ * @param managers - Registry of server managers.
+ * @param _models - Optional models registry.
+ */
 function setupSocketMiddleware(socket_server, loggers, managers, _models) {
     socket_server.use(async (socket, next) => {
         socket.use((async (event, nextEvent) => {
@@ -155,8 +163,12 @@ function setupSocketMiddleware(socket_server, loggers, managers, _models) {
     });
 }
 /**
- * Inspect database states for all server managers.
- * Throws DEMError if any manager database is not connected.
+ * Inspects database readiness states across all configured server managers.
+ *
+ * @param managers - Registry of server managers to inspect.
+ * @param loggers - Optional logger callbacks.
+ * @param emitter - Optional event emitter for error events.
+ * @throws {DEMError} Throws DEMErrorCode.DB_NOT_CONNECTED if any database is disconnected.
  */
 export function checkServerDbStates(managers, loggers, emitter) {
     for (const [key, manager] of Object.entries(managers)) {
@@ -171,6 +183,17 @@ export function checkServerDbStates(managers, loggers, emitter) {
         }
     }
 }
+/**
+ * Initializes and starts all server managers, executes DB state assertions, preloads data, and attaches sockets.
+ *
+ * @param defs - Server manager definitions including class constructors and options.
+ * @param loggers_ - Loggers interface.
+ * @param socket - Socket.IO server instance.
+ * @param doDebug - Flag indicating whether debug logging is enabled.
+ * @param emitter - Shared event emitter.
+ * @param models - Optional model registry.
+ * @returns Promise resolving to the map of initialized server managers.
+ */
 export async function AUSManagerFactory(defs, loggers_, socket, doDebug = true, emitter = new EventEmitter(), models) {
     // Use delegation instead of cloning or direct mutation to ensure late-added spies work
     const loggers = {
@@ -266,6 +289,18 @@ export class AutoUpdateServerManager extends AutoUpdateManager {
     startupPayloadCache = null;
     _cachedObjectsArray = null;
     changeTracker;
+    /**
+     * Initializes an AutoUpdateServerManager instance.
+     *
+     * @param classParam - Target server object class constructor.
+     * @param className - Managed entity class name.
+     * @param socket - Socket.IO Server instance.
+     * @param loggers - Logger callbacks interface.
+     * @param model - Typegoose Mongoose model for database operations.
+     * @param managers - Sibling server managers registry.
+     * @param emitter - Shared event emitter.
+     * @param options - Server manager options including access middlewares and delta sync settings.
+     */
     constructor(classParam, className, socket, loggers, model, managers, emitter, options) {
         super(classParam, className, socket, loggers, managers, emitter);
         this.managers = managers;
@@ -279,7 +314,9 @@ export class AutoUpdateServerManager extends AutoUpdateManager {
         }
     }
     /**
-     * Inspect current database connection state.
+     * Inspects current database connection state.
+     *
+     * @returns Object describing connected flag, numeric readyState, and stateName.
      */
     checkDbState() {
         const db = this.model?.db;
@@ -302,8 +339,9 @@ export class AutoUpdateServerManager extends AutoUpdateManager {
         };
     }
     /**
-     * Verify database connection is active.
-     * Throws DEMError if database is not connected.
+     * Verifies database connection is active.
+     *
+     * @throws {DEMError} Throws DEMErrorCode.DB_NOT_CONNECTED if database is not connected.
      */
     assertDbConnected() {
         const status = this.checkDbState();
@@ -314,6 +352,12 @@ export class AutoUpdateServerManager extends AutoUpdateManager {
             throw err;
         }
     }
+    /**
+     * Preloads all database documents into memory for the manager class.
+     *
+     * @param options - Optional batch loading options.
+     * @returns Promise resolving when all entities are loaded and populated in globalCache.
+     */
     async preLoad(options) {
         this.assertDbConnected();
         this.loggers.debug("Loading manager DB " + this.className);
@@ -342,6 +386,11 @@ export class AutoUpdateServerManager extends AutoUpdateManager {
             docs.length +
             "] entries");
     }
+    /**
+     * Resolves back-references and pointers across loaded objects.
+     *
+     * @returns Promise resolving when reference resolution completes.
+     */
     async loadReferences() {
         // Phase 1: Initial reference resolution (including back-references/createdWithParent)
         // This MUST happen after all managers have finished preLoad so that all objects exist in globalCache.
@@ -349,6 +398,11 @@ export class AutoUpdateServerManager extends AutoUpdateManager {
         // Phase 2: Resolve missing references (pointers) and set isLoaded_ = true
         await super.loadReferences();
     }
+    /**
+     * Registers a client socket with the manager and binds startup, delete, and new event listeners.
+     *
+     * @param socket - Connected client Socket instance.
+     */
     registerSocket(socket) {
         this.clientSockets.add(socket);
         socket.on(EVENT_STARTUP + this.className, async (req, ack) => {
@@ -616,20 +670,42 @@ export class AutoUpdateServerManager extends AutoUpdateManager {
             this.knownObjectIdsBySocket.delete(socket);
         });
     }
+    /**
+     * Retrieves a server managed object by identifier.
+     *
+     * @param _id - Optional entity identifier.
+     * @returns Managed entity instance, null, or undefined.
+     */
     getObject(_id) {
         if (!_id)
             return null;
         return this.objects_[_id.toString()] || undefined;
     }
+    /**
+     * Dictionary of all managed entities keyed by their string IDs.
+     *
+     * @returns Map of managed entities.
+     */
     get objects() {
         return this.objects_;
     }
+    /**
+     * Array representation of all managed entities.
+     *
+     * @returns Array containing all managed entities.
+     */
     get objectsAsArray() {
         if (!this._cachedObjectsArray) {
             this._cachedObjectsArray = Object.values(this.objects_);
         }
         return this._cachedObjectsArray;
     }
+    /**
+     * Deletes an entity from database, manager cache, and mutation tracker.
+     *
+     * @param _id - Identifier of entity to delete.
+     * @returns Promise resolving to deletion outcome object.
+     */
     async deleteObject(_id) {
         this._cachedObjectsArray = null;
         const idStr = _id.toString();
@@ -645,6 +721,13 @@ export class AutoUpdateServerManager extends AutoUpdateManager {
         return super.deleteObject(_id);
     }
     pendingMissingFetches = new Map();
+    /**
+     * Retrieves an entity missing from memory by querying MongoDB directly.
+     *
+     * @param _id - Identifier of missing entity.
+     * @returns Promise resolving to the retrieved server object.
+     * @throws {DEMError} Throws DEMErrorCode.DOCUMENT_NOT_FOUND or MANAGERS_NOT_INITIALIZED.
+     */
     async handleGetMissingObject(_id) {
         const _idStr = _id.toString();
         if (this.getObject(_idStr))
@@ -679,6 +762,14 @@ export class AutoUpdateServerManager extends AutoUpdateManager {
         this.pendingMissingFetches.set(_idStr, fetchPromise);
         return fetchPromise;
     }
+    /**
+     * Creates a new entity document in MongoDB and instantiates its manager wrapper.
+     * Broadcasts creation event to client sockets with authorized access.
+     *
+     * @param data - Initial entity properties.
+     * @returns Promise resolving to the created server entity.
+     * @throws {DEMError} Throws DEMErrorCode.MANAGERS_NOT_INITIALIZED.
+     */
     async createObject(data) {
         if (!this.managers)
             throw new DEMError(DEMErrorCode.MANAGERS_NOT_INITIALIZED, `No managers.`);
@@ -763,6 +854,12 @@ export class AutoUpdateServerManager extends AutoUpdateManager {
         }
         return object;
     }
+    /**
+     * Re-evaluates client socket permissions against dynamic startup middleware rules.
+     * Emits 'new' or 'delete' socket events when client access changes dynamically.
+     *
+     * @param object - Entity to evaluate.
+     */
     async checkPermissionBoundaries(object) {
         if (!this.options?.accessDefinitions?.startupMiddleware)
             return;