itlab-internal-services 2.16.1 → 2.16.3

package/dist/classes/document/likeable-document.class.d.ts

@@ -0,0 +1,205 @@
+import { Document } from 'mongoose';
+import { User } from '../../models';
+export declare function LikeableDocument<TBase extends new (...args: any[]) => Document>(Base: TBase): {
+    new (...args: any[]): {
+        _likedBy: string[];
+        likes: number;
+        likedBy?: User[];
+        hasLiked(accountId: string): boolean;
+        addLike(accountId: string): Promise<number>;
+        removeLike(accountId: string): Promise<number>;
+        _id: unknown;
+        $assertPopulated<Paths = {}>(path: string | string[], values?: Partial<Paths>): Omit</*elided*/ any, keyof Paths> & Paths;
+        $clearModifiedPaths(): /*elided*/ any;
+        $clone(): /*elided*/ any;
+        $createModifiedPathsSnapshot(): import("mongoose").ModifiedPathsSnapshot;
+        $getAllSubdocs(): Document[];
+        $ignore(path: string): void;
+        $isDefault(path?: string): boolean;
+        $isDeleted(val?: boolean): boolean;
+        $getPopulatedDocs(): Document[];
+        $inc(path: string | string[], val?: number): /*elided*/ any;
+        $isEmpty(path: string): boolean;
+        $isValid(path: string): boolean;
+        $locals: Record<string, unknown>;
+        $markValid(path: string): void;
+        $model<ModelType = import("mongoose").Model<unknown, {}, {}, {}, Document<unknown, {}, unknown, {}, {}> & Required<{
+            _id: unknown;
+        }> & {
+            __v: number;
+        }, any>>(name: string): ModelType;
+        $model<ModelType = import("mongoose").Model<any, {}, {}, {}, any, any>>(): ModelType;
+        $op: "save" | "validate" | "remove" | null;
+        $restoreModifiedPathsSnapshot(snapshot: import("mongoose").ModifiedPathsSnapshot): /*elided*/ any;
+        $session(session?: import("mongoose").ClientSession | null): import("mongoose").ClientSession | null;
+        $set(path: string | Record<string, any>, val: any, type: any, options?: import("mongoose").DocumentSetOptions): /*elided*/ any;
+        $set(path: string | Record<string, any>, val: any, options?: import("mongoose").DocumentSetOptions): /*elided*/ any;
+        $set(value: string | Record<string, any>): /*elided*/ any;
+        $where: Record<string, unknown>;
+        baseModelName?: string;
+        collection: import("mongoose").Collection;
+        db: import("mongoose").Connection;
+        deleteOne(options?: import("mongoose").QueryOptions): any;
+        depopulate<Paths = {}>(path?: string | string[]): import("mongoose").MergeType</*elided*/ any, Paths>;
+        directModifiedPaths(): Array<string>;
+        equals(doc: Document<unknown, any, any, Record<string, any>, {}>): boolean;
+        errors?: import("mongoose").Error.ValidationError;
+        get<T extends string | number | symbol>(path: T, type?: any, options?: any): any;
+        get(path: string, type?: any, options?: any): any;
+        getChanges(): import("mongoose").UpdateQuery</*elided*/ any>;
+        id?: any;
+        increment(): /*elided*/ any;
+        init(obj: import("mongoose").AnyObject, opts?: import("mongoose").AnyObject): /*elided*/ any;
+        invalidate<T extends string | number | symbol>(path: T, errorMsg: string | NativeError, value?: any, kind?: string): NativeError | null;
+        invalidate(path: string, errorMsg: string | NativeError, value?: any, kind?: string): NativeError | null;
+        isDirectModified<T extends string | number | symbol>(path: T | T[]): boolean;
+        isDirectModified(path: string | Array<string>): boolean;
+        isDirectSelected<T extends string | number | symbol>(path: T): boolean;
+        isDirectSelected(path: string): boolean;
+        isInit<T extends string | number | symbol>(path: T): boolean;
+        isInit(path: string): boolean;
+        isModified<T extends string | number | symbol>(path?: T | T[], options?: {
+            ignoreAtomics?: boolean;
+        } | null): boolean;
+        isModified(path?: string | Array<string>, options?: {
+            ignoreAtomics?: boolean;
+        } | null): boolean;
+        isNew: boolean;
+        isSelected<T extends string | number | symbol>(path: T): boolean;
+        isSelected(path: string): boolean;
+        markModified<T extends string | number | symbol>(path: T, scope?: any): void;
+        markModified(path: string, scope?: any): void;
+        model<ModelType = import("mongoose").Model<unknown, {}, {}, {}, Document<unknown, {}, unknown, {}, {}> & Required<{
+            _id: unknown;
+        }> & {
+            __v: number;
+        }, any>>(name: string): ModelType;
+        model<ModelType = import("mongoose").Model<any, {}, {}, {}, any, any>>(): ModelType;
+        modifiedPaths(options?: {
+            includeChildren?: boolean;
+        }): Array<string>;
+        overwrite(obj: import("mongoose").AnyObject): /*elided*/ any;
+        $parent(): Document | undefined;
+        populate<Paths = {}>(path: string | import("mongoose").PopulateOptions | (string | import("mongoose").PopulateOptions)[]): Promise<import("mongoose").MergeType</*elided*/ any, Paths>>;
+        populate<Paths = {}>(path: string, select?: string | import("mongoose").AnyObject, model?: import("mongoose").Model<any>, match?: import("mongoose").AnyObject, options?: import("mongoose").PopulateOptions): Promise<import("mongoose").MergeType</*elided*/ any, Paths>>;
+        populated(path: string): any;
+        replaceOne(replacement?: import("mongoose").AnyObject, options?: import("mongoose").QueryOptions | null): import("mongoose").Query<any, /*elided*/ any, {}, unknown, "find", Record<string, never>>;
+        save(options?: import("mongoose").SaveOptions): Promise</*elided*/ any>;
+        schema: import("mongoose").Schema;
+        set<T extends string | number | symbol>(path: T, val: any, type: any, options?: import("mongoose").DocumentSetOptions): /*elided*/ any;
+        set(path: string | Record<string, any>, val: any, type: any, options?: import("mongoose").DocumentSetOptions): /*elided*/ any;
+        set(path: string | Record<string, any>, val: any, options?: import("mongoose").DocumentSetOptions): /*elided*/ any;
+        set(value: string | Record<string, any>): /*elided*/ any;
+        toJSON(options: import("mongoose").ToObjectOptions & {
+            versionKey: false;
+            virtuals: true;
+            flattenObjectIds: true;
+        }): Omit<{
+            [x: string]: any;
+        }, "__v">;
+        toJSON(options: import("mongoose").ToObjectOptions & {
+            virtuals: true;
+            flattenObjectIds: true;
+        }): {
+            [x: string]: any;
+        };
+        toJSON(options: import("mongoose").ToObjectOptions & {
+            versionKey: false;
+            virtuals: true;
+        }): Omit<any, "__v">;
+        toJSON(options: import("mongoose").ToObjectOptions & {
+            versionKey: false;
+            flattenObjectIds: true;
+        }): {
+            [x: string]: any;
+            [x: number]: any;
+            [x: symbol]: any;
+        };
+        toJSON(options: import("mongoose").ToObjectOptions & {
+            virtuals: true;
+        }): any;
+        toJSON(options: import("mongoose").ToObjectOptions & {
+            versionKey: false;
+        }): Omit<any, "__v">;
+        toJSON(options?: import("mongoose").ToObjectOptions & {
+            flattenMaps?: true;
+            flattenObjectIds?: false;
+        }): import("mongoose").FlattenMaps<any>;
+        toJSON(options: import("mongoose").ToObjectOptions & {
+            flattenObjectIds: false;
+        }): import("mongoose").FlattenMaps<any>;
+        toJSON(options: import("mongoose").ToObjectOptions & {
+            flattenObjectIds: true;
+        }): {
+            [x: string]: any;
+        };
+        toJSON(options: import("mongoose").ToObjectOptions & {
+            flattenMaps: false;
+        }): any;
+        toJSON(options: import("mongoose").ToObjectOptions & {
+            flattenMaps: false;
+            flattenObjectIds: true;
+        }): any;
+        toJSON<T = any>(options?: import("mongoose").ToObjectOptions & {
+            flattenMaps?: true;
+            flattenObjectIds?: false;
+        }): import("mongoose").FlattenMaps<T>;
+        toJSON<T = any>(options: import("mongoose").ToObjectOptions & {
+            flattenObjectIds: false;
+        }): import("mongoose").FlattenMaps<T>;
+        toJSON<T = any>(options: import("mongoose").ToObjectOptions & {
+            flattenObjectIds: true;
+        }): import("mongoose").ObjectIdToString<import("mongoose").FlattenMaps<T>>;
+        toJSON<T = any>(options: import("mongoose").ToObjectOptions & {
+            flattenMaps: false;
+        }): T;
+        toJSON<T = any>(options: import("mongoose").ToObjectOptions & {
+            flattenMaps: false;
+            flattenObjectIds: true;
+        }): import("mongoose").ObjectIdToString<T>;
+        toObject(options: import("mongoose").ToObjectOptions & {
+            versionKey: false;
+            virtuals: true;
+            flattenObjectIds: true;
+        }): Omit<any, "__v">;
+        toObject(options: import("mongoose").ToObjectOptions & {
+            virtuals: true;
+            flattenObjectIds: true;
+        }): any;
+        toObject(options: import("mongoose").ToObjectOptions & {
+            versionKey: false;
+            flattenObjectIds: true;
+        }): Omit<any, "__v">;
+        toObject(options: import("mongoose").ToObjectOptions & {
+            versionKey: false;
+            virtuals: true;
+        }): Omit<any, "__v">;
+        toObject(options: import("mongoose").ToObjectOptions & {
+            virtuals: true;
+        }): any;
+        toObject(options: import("mongoose").ToObjectOptions & {
+            versionKey: false;
+        }): Omit<any, "__v">;
+        toObject(options: import("mongoose").ToObjectOptions & {
+            flattenObjectIds: true;
+        }): any;
+        toObject(options?: import("mongoose").ToObjectOptions): any;
+        toObject<T>(options?: import("mongoose").ToObjectOptions): import("mongoose").Require_id<T> & {
+            __v: number;
+        };
+        unmarkModified<T extends string | number | symbol>(path: T): void;
+        unmarkModified(path: string): void;
+        updateOne(update?: import("mongoose").UpdateWithAggregationPipeline | import("mongoose").UpdateQuery</*elided*/ any>, options?: import("mongoose").QueryOptions | null): import("mongoose").Query<any, /*elided*/ any, {}, unknown, "find", Record<string, never>>;
+        validate<T extends string | number | symbol>(pathsToValidate?: T | T[], options?: import("mongoose").AnyObject): Promise<void>;
+        validate(pathsToValidate?: import("mongoose").pathsToValidate, options?: import("mongoose").AnyObject): Promise<void>;
+        validate(options: {
+            pathsToSkip?: import("mongoose").pathsToSkip;
+        }): Promise<void>;
+        validateSync(options: {
+            pathsToSkip?: import("mongoose").pathsToSkip;
+            [k: string]: any;
+        }): import("mongoose").Error.ValidationError | null;
+        validateSync<T extends string | number | symbol>(pathsToValidate?: T | T[], options?: import("mongoose").AnyObject): import("mongoose").Error.ValidationError | null;
+        validateSync(pathsToValidate?: import("mongoose").pathsToValidate, options?: import("mongoose").AnyObject): import("mongoose").Error.ValidationError | null;
+    };
+} & TBase;

package/dist/classes/document/likeable-document.class.js

@@ -0,0 +1,70 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LikeableDocument = LikeableDocument;
+const mongoose_1 = require("@nestjs/mongoose");
+const swagger_1 = require("@nestjs/swagger");
+const class_validator_1 = require("class-validator");
+const models_1 = require("../../models");
+function LikeableDocument(Base) {
+    class LikeableDocument extends Base {
+        hasLiked(accountId) {
+            return this._likedBy.includes(accountId);
+        }
+        async addLike(accountId) {
+            if (!(0, class_validator_1.isMongoId)(accountId))
+                return this.likes;
+            this._likedBy = Array.from(new Set([...this._likedBy, accountId]));
+            this.likes = this._likedBy.length;
+            await this.save({ timestamps: false });
+            return this.likes;
+        }
+        async removeLike(accountId) {
+            if (!(0, class_validator_1.isMongoId)(accountId))
+                return this.likes;
+            this._likedBy = this._likedBy.filter((id) => id !== accountId);
+            this.likes = this._likedBy.length;
+            await this.save({ timestamps: false });
+            return this.likes;
+        }
+    }
+    __decorate([
+        (0, swagger_1.ApiPropertyOptional)({
+            name: '_likedBy',
+            description: 'Array of user IDs that liked this resource.',
+            type: [String],
+            default: [],
+        }),
+        (0, mongoose_1.Prop)({ type: [String], default: [] }),
+        __metadata("design:type", Array)
+    ], LikeableDocument.prototype, "_likedBy", void 0);
+    __decorate([
+        (0, swagger_1.ApiPropertyOptional)({
+            name: 'likes',
+            description: 'Total number of likes for this resource.',
+            type: Number,
+            default: 0,
+        }),
+        (0, mongoose_1.Prop)({ type: Number, default: 0 }),
+        __metadata("design:type", Number)
+    ], LikeableDocument.prototype, "likes", void 0);
+    __decorate([
+        (0, swagger_1.ApiPropertyOptional)({
+            name: 'likedBy',
+            description: 'Populated list of User objects who liked this resource.',
+            type: [models_1.User],
+            default: [],
+        }),
+        (0, mongoose_1.Virtual)(),
+        __metadata("design:type", Array)
+    ], LikeableDocument.prototype, "likedBy", void 0);
+    return LikeableDocument;
+}

package/dist/classes/document/viewable-document.class.d.ts

@@ -0,0 +1,205 @@
+import { Document } from 'mongoose';
+import { User } from '../../models';
+export declare function ViewableDocument<TBase extends new (...args: any[]) => Document>(Base: TBase): {
+    new (...args: any[]): {
+        _viewedBy: string[];
+        views: number;
+        viewedBy?: User[];
+        hasViewed(accountId: string): boolean;
+        addView(accountId: string): Promise<number>;
+        removeView(accountId: string): Promise<number>;
+        _id: unknown;
+        $assertPopulated<Paths = {}>(path: string | string[], values?: Partial<Paths>): Omit</*elided*/ any, keyof Paths> & Paths;
+        $clearModifiedPaths(): /*elided*/ any;
+        $clone(): /*elided*/ any;
+        $createModifiedPathsSnapshot(): import("mongoose").ModifiedPathsSnapshot;
+        $getAllSubdocs(): Document[];
+        $ignore(path: string): void;
+        $isDefault(path?: string): boolean;
+        $isDeleted(val?: boolean): boolean;
+        $getPopulatedDocs(): Document[];
+        $inc(path: string | string[], val?: number): /*elided*/ any;
+        $isEmpty(path: string): boolean;
+        $isValid(path: string): boolean;
+        $locals: Record<string, unknown>;
+        $markValid(path: string): void;
+        $model<ModelType = import("mongoose").Model<unknown, {}, {}, {}, Document<unknown, {}, unknown, {}, {}> & Required<{
+            _id: unknown;
+        }> & {
+            __v: number;
+        }, any>>(name: string): ModelType;
+        $model<ModelType = import("mongoose").Model<any, {}, {}, {}, any, any>>(): ModelType;
+        $op: "save" | "validate" | "remove" | null;
+        $restoreModifiedPathsSnapshot(snapshot: import("mongoose").ModifiedPathsSnapshot): /*elided*/ any;
+        $session(session?: import("mongoose").ClientSession | null): import("mongoose").ClientSession | null;
+        $set(path: string | Record<string, any>, val: any, type: any, options?: import("mongoose").DocumentSetOptions): /*elided*/ any;
+        $set(path: string | Record<string, any>, val: any, options?: import("mongoose").DocumentSetOptions): /*elided*/ any;
+        $set(value: string | Record<string, any>): /*elided*/ any;
+        $where: Record<string, unknown>;
+        baseModelName?: string;
+        collection: import("mongoose").Collection;
+        db: import("mongoose").Connection;
+        deleteOne(options?: import("mongoose").QueryOptions): any;
+        depopulate<Paths = {}>(path?: string | string[]): import("mongoose").MergeType</*elided*/ any, Paths>;
+        directModifiedPaths(): Array<string>;
+        equals(doc: Document<unknown, any, any, Record<string, any>, {}>): boolean;
+        errors?: import("mongoose").Error.ValidationError;
+        get<T extends string | number | symbol>(path: T, type?: any, options?: any): any;
+        get(path: string, type?: any, options?: any): any;
+        getChanges(): import("mongoose").UpdateQuery</*elided*/ any>;
+        id?: any;
+        increment(): /*elided*/ any;
+        init(obj: import("mongoose").AnyObject, opts?: import("mongoose").AnyObject): /*elided*/ any;
+        invalidate<T extends string | number | symbol>(path: T, errorMsg: string | NativeError, value?: any, kind?: string): NativeError | null;
+        invalidate(path: string, errorMsg: string | NativeError, value?: any, kind?: string): NativeError | null;
+        isDirectModified<T extends string | number | symbol>(path: T | T[]): boolean;
+        isDirectModified(path: string | Array<string>): boolean;
+        isDirectSelected<T extends string | number | symbol>(path: T): boolean;
+        isDirectSelected(path: string): boolean;
+        isInit<T extends string | number | symbol>(path: T): boolean;
+        isInit(path: string): boolean;
+        isModified<T extends string | number | symbol>(path?: T | T[], options?: {
+            ignoreAtomics?: boolean;
+        } | null): boolean;
+        isModified(path?: string | Array<string>, options?: {
+            ignoreAtomics?: boolean;
+        } | null): boolean;
+        isNew: boolean;
+        isSelected<T extends string | number | symbol>(path: T): boolean;
+        isSelected(path: string): boolean;
+        markModified<T extends string | number | symbol>(path: T, scope?: any): void;
+        markModified(path: string, scope?: any): void;
+        model<ModelType = import("mongoose").Model<unknown, {}, {}, {}, Document<unknown, {}, unknown, {}, {}> & Required<{
+            _id: unknown;
+        }> & {
+            __v: number;
+        }, any>>(name: string): ModelType;
+        model<ModelType = import("mongoose").Model<any, {}, {}, {}, any, any>>(): ModelType;
+        modifiedPaths(options?: {
+            includeChildren?: boolean;
+        }): Array<string>;
+        overwrite(obj: import("mongoose").AnyObject): /*elided*/ any;
+        $parent(): Document | undefined;
+        populate<Paths = {}>(path: string | import("mongoose").PopulateOptions | (string | import("mongoose").PopulateOptions)[]): Promise<import("mongoose").MergeType</*elided*/ any, Paths>>;
+        populate<Paths = {}>(path: string, select?: string | import("mongoose").AnyObject, model?: import("mongoose").Model<any>, match?: import("mongoose").AnyObject, options?: import("mongoose").PopulateOptions): Promise<import("mongoose").MergeType</*elided*/ any, Paths>>;
+        populated(path: string): any;
+        replaceOne(replacement?: import("mongoose").AnyObject, options?: import("mongoose").QueryOptions | null): import("mongoose").Query<any, /*elided*/ any, {}, unknown, "find", Record<string, never>>;
+        save(options?: import("mongoose").SaveOptions): Promise</*elided*/ any>;
+        schema: import("mongoose").Schema;
+        set<T extends string | number | symbol>(path: T, val: any, type: any, options?: import("mongoose").DocumentSetOptions): /*elided*/ any;
+        set(path: string | Record<string, any>, val: any, type: any, options?: import("mongoose").DocumentSetOptions): /*elided*/ any;
+        set(path: string | Record<string, any>, val: any, options?: import("mongoose").DocumentSetOptions): /*elided*/ any;
+        set(value: string | Record<string, any>): /*elided*/ any;
+        toJSON(options: import("mongoose").ToObjectOptions & {
+            versionKey: false;
+            virtuals: true;
+            flattenObjectIds: true;
+        }): Omit<{
+            [x: string]: any;
+        }, "__v">;
+        toJSON(options: import("mongoose").ToObjectOptions & {
+            virtuals: true;
+            flattenObjectIds: true;
+        }): {
+            [x: string]: any;
+        };
+        toJSON(options: import("mongoose").ToObjectOptions & {
+            versionKey: false;
+            virtuals: true;
+        }): Omit<any, "__v">;
+        toJSON(options: import("mongoose").ToObjectOptions & {
+            versionKey: false;
+            flattenObjectIds: true;
+        }): {
+            [x: string]: any;
+            [x: number]: any;
+            [x: symbol]: any;
+        };
+        toJSON(options: import("mongoose").ToObjectOptions & {
+            virtuals: true;
+        }): any;
+        toJSON(options: import("mongoose").ToObjectOptions & {
+            versionKey: false;
+        }): Omit<any, "__v">;
+        toJSON(options?: import("mongoose").ToObjectOptions & {
+            flattenMaps?: true;
+            flattenObjectIds?: false;
+        }): import("mongoose").FlattenMaps<any>;
+        toJSON(options: import("mongoose").ToObjectOptions & {
+            flattenObjectIds: false;
+        }): import("mongoose").FlattenMaps<any>;
+        toJSON(options: import("mongoose").ToObjectOptions & {
+            flattenObjectIds: true;
+        }): {
+            [x: string]: any;
+        };
+        toJSON(options: import("mongoose").ToObjectOptions & {
+            flattenMaps: false;
+        }): any;
+        toJSON(options: import("mongoose").ToObjectOptions & {
+            flattenMaps: false;
+            flattenObjectIds: true;
+        }): any;
+        toJSON<T = any>(options?: import("mongoose").ToObjectOptions & {
+            flattenMaps?: true;
+            flattenObjectIds?: false;
+        }): import("mongoose").FlattenMaps<T>;
+        toJSON<T = any>(options: import("mongoose").ToObjectOptions & {
+            flattenObjectIds: false;
+        }): import("mongoose").FlattenMaps<T>;
+        toJSON<T = any>(options: import("mongoose").ToObjectOptions & {
+            flattenObjectIds: true;
+        }): import("mongoose").ObjectIdToString<import("mongoose").FlattenMaps<T>>;
+        toJSON<T = any>(options: import("mongoose").ToObjectOptions & {
+            flattenMaps: false;
+        }): T;
+        toJSON<T = any>(options: import("mongoose").ToObjectOptions & {
+            flattenMaps: false;
+            flattenObjectIds: true;
+        }): import("mongoose").ObjectIdToString<T>;
+        toObject(options: import("mongoose").ToObjectOptions & {
+            versionKey: false;
+            virtuals: true;
+            flattenObjectIds: true;
+        }): Omit<any, "__v">;
+        toObject(options: import("mongoose").ToObjectOptions & {
+            virtuals: true;
+            flattenObjectIds: true;
+        }): any;
+        toObject(options: import("mongoose").ToObjectOptions & {
+            versionKey: false;
+            flattenObjectIds: true;
+        }): Omit<any, "__v">;
+        toObject(options: import("mongoose").ToObjectOptions & {
+            versionKey: false;
+            virtuals: true;
+        }): Omit<any, "__v">;
+        toObject(options: import("mongoose").ToObjectOptions & {
+            virtuals: true;
+        }): any;
+        toObject(options: import("mongoose").ToObjectOptions & {
+            versionKey: false;
+        }): Omit<any, "__v">;
+        toObject(options: import("mongoose").ToObjectOptions & {
+            flattenObjectIds: true;
+        }): any;
+        toObject(options?: import("mongoose").ToObjectOptions): any;
+        toObject<T>(options?: import("mongoose").ToObjectOptions): import("mongoose").Require_id<T> & {
+            __v: number;
+        };
+        unmarkModified<T extends string | number | symbol>(path: T): void;
+        unmarkModified(path: string): void;
+        updateOne(update?: import("mongoose").UpdateWithAggregationPipeline | import("mongoose").UpdateQuery</*elided*/ any>, options?: import("mongoose").QueryOptions | null): import("mongoose").Query<any, /*elided*/ any, {}, unknown, "find", Record<string, never>>;
+        validate<T extends string | number | symbol>(pathsToValidate?: T | T[], options?: import("mongoose").AnyObject): Promise<void>;
+        validate(pathsToValidate?: import("mongoose").pathsToValidate, options?: import("mongoose").AnyObject): Promise<void>;
+        validate(options: {
+            pathsToSkip?: import("mongoose").pathsToSkip;
+        }): Promise<void>;
+        validateSync(options: {
+            pathsToSkip?: import("mongoose").pathsToSkip;
+            [k: string]: any;
+        }): import("mongoose").Error.ValidationError | null;
+        validateSync<T extends string | number | symbol>(pathsToValidate?: T | T[], options?: import("mongoose").AnyObject): import("mongoose").Error.ValidationError | null;
+        validateSync(pathsToValidate?: import("mongoose").pathsToValidate, options?: import("mongoose").AnyObject): import("mongoose").Error.ValidationError | null;
+    };
+} & TBase;

package/dist/classes/document/viewable-document.class.js

@@ -0,0 +1,67 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ViewableDocument = ViewableDocument;
+const mongoose_1 = require("@nestjs/mongoose");
+const swagger_1 = require("@nestjs/swagger");
+const class_validator_1 = require("class-validator");
+const models_1 = require("../../models");
+function ViewableDocument(Base) {
+    class ViewableDocument extends Base {
+        hasViewed(accountId) {
+            return this._viewedBy.includes(accountId);
+        }
+        async addView(accountId) {
+            if (!(0, class_validator_1.isMongoId)(accountId))
+                return this.views;
+            this._viewedBy = Array.from(new Set([...this._viewedBy, accountId]));
+            this.views = this._viewedBy.length;
+            await this.save({ timestamps: false });
+            return this.views;
+        }
+        async removeView(accountId) {
+            if (!(0, class_validator_1.isMongoId)(accountId))
+                return this.views;
+            this._viewedBy = this._viewedBy.filter((id) => id !== accountId);
+            this.views = this._viewedBy.length;
+            await this.save({ timestamps: false });
+            return this.views;
+        }
+    }
+    __decorate([
+        (0, swagger_1.ApiPropertyOptional)({
+            description: 'Array of user IDs that have viewed this resource.',
+            type: [String],
+            default: [],
+        }),
+        (0, mongoose_1.Prop)({ type: [String], default: [] }),
+        __metadata("design:type", Array)
+    ], ViewableDocument.prototype, "_viewedBy", void 0);
+    __decorate([
+        (0, swagger_1.ApiPropertyOptional)({
+            description: 'Total number of views for this resource.',
+            type: Number,
+            default: 0,
+        }),
+        (0, mongoose_1.Prop)({ type: Number, default: 0 }),
+        __metadata("design:type", Number)
+    ], ViewableDocument.prototype, "views", void 0);
+    __decorate([
+        (0, swagger_1.ApiPropertyOptional)({
+            description: 'Populated list of User objects who viewed this resource.',
+            type: [models_1.User],
+            default: [],
+        }),
+        (0, mongoose_1.Virtual)(),
+        __metadata("design:type", Array)
+    ], ViewableDocument.prototype, "viewedBy", void 0);
+    return ViewableDocument;
+}

package/dist/classes/document-updater.class.d.ts

@@ -0,0 +1,40 @@
+import { Document } from 'mongoose';
+import { Viewable } from '../viewable.interface';
+/**
+ * TODO: REMOVE
+ * Facilitates asynchronous updates to documents by adding unique account IDs to specified
+ * array attributes. This prevents duplication of IDs in those arrays, ensuring data integrity.
+ *
+ * Designed primarily for adding account references such as views or other related IDs.
+ */
+export declare class DocumentUpdater {
+    private static readonly logger;
+    /**
+     * Adds an account ID uniquely to a specified array attribute of a document.
+     *
+     * This method verifies the presence of an accountId before proceeding.
+     * It then performs an atomic MongoDB `$addToSet` update on the document to
+     * add the accountId to the given attribute array only if it is not already present,
+     * preventing duplicates without needing to fetch the document first.
+     *
+     * Updates are saved without modifying timestamps to preserve original metadata.
+     *
+     * @template I - Interface representing the document’s shape.
+     * @template T - Mongoose Document type extending `Document`.
+     * @param document - The Mongoose document to update.
+     * @param attribute - The document attribute (key) representing the array to update.
+     * @param accountId - The unique account ID to add.
+     */
+    static addUniqueAccountId<I, T extends Document = Document>(document: T, attribute: keyof I, accountId?: string): void;
+    /**
+     * Adds a view record to a document by associating an account ID with the '_viewedBy' attribute.
+     *
+     * This method leverages `addUniqueAccountId` to add the given accountId to the '_viewedBy' array,
+     * ensuring each viewer is recorded only once.
+     *
+     * @template T - Mongoose Document type that extends Document and implements Viewable interface.
+     * @param target - The target document to record the view.
+     * @param accountId - The account ID representing the viewer.
+     */
+    static addView<T extends Document & Viewable>(target: T, accountId?: string): void;
+}

package/dist/classes/document-updater.class.js

@@ -0,0 +1,58 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DocumentUpdater = void 0;
+const common_1 = require("@nestjs/common");
+/**
+ * TODO: REMOVE
+ * Facilitates asynchronous updates to documents by adding unique account IDs to specified
+ * array attributes. This prevents duplication of IDs in those arrays, ensuring data integrity.
+ *
+ * Designed primarily for adding account references such as views or other related IDs.
+ */
+class DocumentUpdater {
+    /**
+     * Adds an account ID uniquely to a specified array attribute of a document.
+     *
+     * This method verifies the presence of an accountId before proceeding.
+     * It then performs an atomic MongoDB `$addToSet` update on the document to
+     * add the accountId to the given attribute array only if it is not already present,
+     * preventing duplicates without needing to fetch the document first.
+     *
+     * Updates are saved without modifying timestamps to preserve original metadata.
+     *
+     * @template I - Interface representing the document’s shape.
+     * @template T - Mongoose Document type extending `Document`.
+     * @param document - The Mongoose document to update.
+     * @param attribute - The document attribute (key) representing the array to update.
+     * @param accountId - The unique account ID to add.
+     */
+    static addUniqueAccountId(document, attribute, accountId) {
+        if (!accountId)
+            return; // Exit if no accountId provided, avoiding unnecessary operations.
+        // Perform atomic update to add accountId uniquely to the attribute array.
+        document
+            .updateOne({ $addToSet: { [String(attribute)]: accountId } }, { timestamps: false })
+            .then(() => {
+            this.logger.log(`Added unique accountId '${accountId}' to attribute '${String(attribute)}' for document ${document._id.toString()}`);
+        })
+            .catch((error) => {
+            // Log any errors during the update operation for debugging and audit.
+            this.logger.error(`Failed to add accountId '${accountId}' to attribute '${String(attribute)}' for document ${document._id.toString()}: ${error.stack}`);
+        });
+    }
+    /**
+     * Adds a view record to a document by associating an account ID with the '_viewedBy' attribute.
+     *
+     * This method leverages `addUniqueAccountId` to add the given accountId to the '_viewedBy' array,
+     * ensuring each viewer is recorded only once.
+     *
+     * @template T - Mongoose Document type that extends Document and implements Viewable interface.
+     * @param target - The target document to record the view.
+     * @param accountId - The account ID representing the viewer.
+     */
+    static addView(target, accountId) {
+        this.addUniqueAccountId(target, '_viewedBy', accountId);
+    }
+}
+exports.DocumentUpdater = DocumentUpdater;
+DocumentUpdater.logger = new common_1.Logger('DocumentUpdater');