@slango/mangusta 1.0.7 → 1.1.0

package/.turbo/turbo-build.log

@@ -1,4 +1,4 @@
 
-> @slango/mangusta@1.0.7 build /home/runner/work/slango/slango/packages/mangusta
+> @slango/mangusta@1.1.0 build /home/runner/work/slango/slango/packages/mangusta
 > tsc -p tsconfig.build.json
 

package/.turbo/turbo-lint.log

@@ -1,4 +1,4 @@
 
-> @slango/mangusta@1.0.7 lint /home/runner/work/slango/slango/packages/mangusta
+> @slango/mangusta@1.1.0 lint /home/runner/work/slango/slango/packages/mangusta
 > eslint . --max-warnings 0
 

package/.turbo/turbo-test.log

@@ -1,28 +1,29 @@
 
-> @slango/mangusta@1.0.7 test /home/runner/work/slango/slango/packages/mangusta
+> @slango/mangusta@1.1.0 test /home/runner/work/slango/slango/packages/mangusta
 > vitest --run
 
 
  RUN  v3.2.4 /home/runner/work/slango/slango/packages/mangusta
 
-stdout | src/middleware/email.spec.ts
+stdout | src/middleware/compactId.spec.ts
 Downloading MongoDB "7.0.14": 0% (0mb / 80.8mb)
 
-stdout | src/middleware/email.spec.ts
+stdout | src/middleware/compactId.spec.ts
 Downloading MongoDB "7.0.14": 100% (80.8mb / 80.8mb)
 
-stdout | src/middleware/email.spec.ts
+stdout | src/middleware/compactId.spec.ts
 Downloading MongoDB "7.0.14": 100% (0mb / 0mb)
 
- ✓ src/middleware/email.spec.ts (7 tests) 4113ms
- ✓ src/middleware/owner.spec.ts (6 tests) 377ms
- ✓ src/middleware/timestamps.spec.ts (3 tests) 400ms
- ✓ src/middleware/compactId.spec.ts (6 tests) 6479ms
- ✓ src/middleware/tags.spec.ts (8 tests) 6599ms
- ✓ src/middleware/password.spec.ts (4 tests) 849ms
-
- Test Files  6 passed (6)
-      Tests  34 passed (34)
-   Start at  04:54:35
-   Duration  8.53s (transform 278ms, setup 0ms, collect 3.20s, tests 18.82s, environment 4ms, prepare 920ms)
+ ✓ src/middleware/compactId.spec.ts (6 tests) 4046ms
+ ✓ src/middleware/email.spec.ts (7 tests) 392ms
+ ✓ src/middleware/owner.spec.ts (6 tests) 374ms
+ ✓ src/middleware/reactions.spec.ts (7 tests) 6514ms
+ ✓ src/middleware/tags.spec.ts (8 tests) 6698ms
+ ✓ src/middleware/timestamps.spec.ts (3 tests) 673ms
+ ✓ src/middleware/password.spec.ts (4 tests) 654ms
+
+ Test Files  7 passed (7)
+      Tests  41 passed (41)
+   Start at  09:54:04
+   Duration  9.25s (transform 294ms, setup 0ms, collect 3.82s, tests 19.35s, environment 2ms, prepare 840ms)
 

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @slango/mangusta
 
+## 1.1.0
+
+### Minor Changes
+
+- 9ef53b9: Reactions middleware
+
+## 1.0.8
+
+### Patch Changes
+
+- 71b046e: Dependencies bump
+- 71b046e: Dependencies bump
+
 ## 1.0.7
 
 ### Patch Changes

package/dist/helpers.d.ts

@@ -0,0 +1,5 @@
+import { Types } from 'mongoose';
+export type Id = string | Types.ObjectId;
+export declare const toObjectId: (value: Id) => Types.ObjectId;
+export declare const toStringId: (value: Id) => string;
+//# sourceMappingURL=helpers.d.ts.map

package/dist/helpers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"helpers.d.ts","sourceRoot":"","sources":["../src/helpers.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AAEjC,MAAM,MAAM,EAAE,GAAG,MAAM,GAAG,KAAK,CAAC,QAAQ,CAAC;AAEzC,eAAO,MAAM,UAAU,GAAI,OAAO,EAAE,KAAG,KAAK,CAAC,QAM5C,CAAC;AAEF,eAAO,MAAM,UAAU,GAAI,OAAO,EAAE,KAAG,MACqB,CAAC"}

package/dist/helpers.js

@@ -0,0 +1,9 @@
+import { Types } from 'mongoose';
+export const toObjectId = (value) => {
+    if (value instanceof Types.ObjectId) {
+        return value;
+    }
+    return new Types.ObjectId(value);
+};
+export const toStringId = (value) => value instanceof Types.ObjectId ? value.toString() : value;
+//# sourceMappingURL=helpers.js.map

package/dist/helpers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"helpers.js","sourceRoot":"","sources":["../src/helpers.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AAIjC,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,KAAS,EAAkB,EAAE;IACtD,IAAI,KAAK,YAAY,KAAK,CAAC,QAAQ,EAAE,CAAC;QACpC,OAAO,KAAK,CAAC;IACf,CAAC;IAED,OAAO,IAAI,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;AACnC,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,KAAS,EAAU,EAAE,CAC9C,KAAK,YAAY,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC"}

package/dist/middleware/reactions.d.ts

@@ -0,0 +1,43 @@
+import { Types } from 'mongoose';
+import { Id } from '../helpers.js';
+import { PluginFunction } from '../types.js';
+export declare const defaultReactionTypes: readonly ["👍", "❤️", "🤔", "😂", "😮"];
+export type ReactionType = (typeof defaultReactionTypes)[number];
+export interface ReactionCountSummary {
+    perType: Record<string, number>;
+    total: number;
+}
+export type ReactionUserField<UserField extends string = 'user'> = {
+    [key in UserField]: Types.ObjectId;
+};
+export type ReactionTypeField<TypeField extends string = 'type'> = {
+    [key in TypeField]: string;
+};
+export type ReactionTimestampField<TimestampField extends string = 'createdAt'> = {
+    [key in TimestampField]?: Date;
+};
+export type ReactionEntry<UserField extends string = 'user', TypeField extends string = 'type', TimestampField extends string = 'createdAt'> = ReactionTimestampField<TimestampField> & ReactionTypeField<TypeField> & ReactionUserField<UserField>;
+export type WithReactions<Field extends string = 'reactions', UserField extends string = 'user', TypeField extends string = 'type', TimestampField extends string = 'createdAt'> = {
+    [key in Field]: ReactionEntry<UserField, TypeField, TimestampField>[];
+};
+export interface WithReactionsMethods {
+    addReaction(user: Id, type: string, timestampValue?: Date): this;
+    countReactions(type?: string): number | ReactionCountSummary;
+    hasReaction(user: Id, type?: string): boolean;
+    removeReaction(user: Id, type?: string): this;
+}
+export interface ReactionsMiddlewareOptions<Field extends string = 'reactions', UserField extends string = 'user', TypeField extends string = 'type', TimestampField extends string = 'createdAt'> {
+    allowedTypes?: readonly string[];
+    allowMultiplePerUser?: boolean;
+    field?: Field;
+    indexType?: -1 | 1 | boolean;
+    indexUser?: -1 | 1 | boolean;
+    timestamp?: boolean;
+    timestampField?: TimestampField;
+    typeField?: TypeField;
+    userField?: UserField;
+    userRef?: string;
+}
+declare const reactionsMiddleware: PluginFunction<ReactionsMiddlewareOptions>;
+export default reactionsMiddleware;
+//# sourceMappingURL=reactions.d.ts.map

package/dist/middleware/reactions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"reactions.d.ts","sourceRoot":"","sources":["../../src/middleware/reactions.ts"],"names":[],"mappings":"AAAA,OAAO,EAA2B,KAAK,EAAE,MAAM,UAAU,CAAC;AAE1D,OAAO,EAAE,EAAE,EAA0B,MAAM,eAAe,CAAC;AAC3D,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAE7C,eAAO,MAAM,oBAAoB,yCAA0C,CAAC;AAE5E,MAAM,MAAM,YAAY,GAAG,CAAC,OAAO,oBAAoB,CAAC,CAAC,MAAM,CAAC,CAAC;AAEjE,MAAM,WAAW,oBAAoB;IACnC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAChC,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,MAAM,iBAAiB,CAAC,SAAS,SAAS,MAAM,GAAG,MAAM,IAAI;KAChE,GAAG,IAAI,SAAS,GAAG,KAAK,CAAC,QAAQ;CACnC,CAAC;AAEF,MAAM,MAAM,iBAAiB,CAAC,SAAS,SAAS,MAAM,GAAG,MAAM,IAAI;KAChE,GAAG,IAAI,SAAS,GAAG,MAAM;CAC3B,CAAC;AAEF,MAAM,MAAM,sBAAsB,CAAC,cAAc,SAAS,MAAM,GAAG,WAAW,IAAI;KAC/E,GAAG,IAAI,cAAc,CAAC,CAAC,EAAE,IAAI;CAC/B,CAAC;AAEF,MAAM,MAAM,aAAa,CACvB,SAAS,SAAS,MAAM,GAAG,MAAM,EACjC,SAAS,SAAS,MAAM,GAAG,MAAM,EACjC,cAAc,SAAS,MAAM,GAAG,WAAW,IACzC,sBAAsB,CAAC,cAAc,CAAC,GACxC,iBAAiB,CAAC,SAAS,CAAC,GAC5B,iBAAiB,CAAC,SAAS,CAAC,CAAC;AAE/B,MAAM,MAAM,aAAa,CACvB,KAAK,SAAS,MAAM,GAAG,WAAW,EAClC,SAAS,SAAS,MAAM,GAAG,MAAM,EACjC,SAAS,SAAS,MAAM,GAAG,MAAM,EACjC,cAAc,SAAS,MAAM,GAAG,WAAW,IACzC;KACD,GAAG,IAAI,KAAK,GAAG,aAAa,CAAC,SAAS,EAAE,SAAS,EAAE,cAAc,CAAC,EAAE;CACtE,CAAC;AAEF,MAAM,WAAW,oBAAoB;IACnC,WAAW,CAAC,IAAI,EAAE,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,cAAc,CAAC,EAAE,IAAI,GAAG,IAAI,CAAC;IACjE,cAAc,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,oBAAoB,CAAC;IAC7D,WAAW,CAAC,IAAI,EAAE,EAAE,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC9C,cAAc,CAAC,IAAI,EAAE,EAAE,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC/C;AAED,MAAM,WAAW,0BAA0B,CACzC,KAAK,SAAS,MAAM,GAAG,WAAW,EAClC,SAAS,SAAS,MAAM,GAAG,MAAM,EACjC,SAAS,SAAS,MAAM,GAAG,MAAM,EACjC,cAAc,SAAS,MAAM,GAAG,WAAW;IAE3C,YAAY,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IACjC,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B,KAAK,CAAC,EAAE,KAAK,CAAC;IACd,SAAS,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC;IAC7B,SAAS,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC;IAC7B,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,cAAc,CAAC,EAAE,cAAc,CAAC;IAChC,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,QAAA,MAAM,mBAAmB,EAAE,cAAc,CAAC,0BAA0B,CA0TnE,CAAC;AAEF,eAAe,mBAAmB,CAAC"}

package/dist/middleware/reactions.js

@@ -0,0 +1,201 @@
+import { Schema, Types } from 'mongoose';
+import { toObjectId, toStringId } from '../helpers.js';
+export const defaultReactionTypes = ['👍', '❤️', '🤔', '😂', '😮'];
+const reactionsMiddleware = (schema, { allowedTypes = defaultReactionTypes, allowMultiplePerUser = false, field = 'reactions', indexType = false, indexUser = true, timestamp = true, timestampField = 'createdAt', typeField = 'type', userField = 'user', userRef = 'User', } = {}) => {
+    const allowedTypesSet = new Set(allowedTypes);
+    const shouldEnforceAllowedTypes = allowedTypesSet.size > 0;
+    const reactionSchemaDefinition = {
+        [userField]: {
+            ref: userRef,
+            required: true,
+            type: Types.ObjectId,
+        },
+        [typeField]: {
+            required: true,
+            type: String,
+            ...(shouldEnforceAllowedTypes && { enum: Array.from(allowedTypesSet) }),
+        },
+    };
+    const reactionsSubSchema = new Schema(reactionSchemaDefinition, {
+        _id: false,
+        timestamps: timestamp ? { createdAt: timestampField, updatedAt: false } : false,
+    });
+    schema.add(new Schema({
+        [field]: {
+            default: [],
+            type: [reactionsSubSchema],
+        },
+    }));
+    if (indexUser) {
+        schema.index({ [`${field}.${userField}`]: indexUser === true ? 1 : indexUser });
+    }
+    if (indexType) {
+        schema.index({ [`${field}.${typeField}`]: indexType === true ? 1 : indexType });
+    }
+    const ensureAllowedType = (reactionType) => {
+        if (shouldEnforceAllowedTypes && !allowedTypesSet.has(reactionType)) {
+            throw new Error(`Reaction type "${reactionType}" is not permitted.`);
+        }
+    };
+    const normalizeEntry = (entry) => {
+        const userValue = entry[userField];
+        const typeValue = entry[typeField];
+        if (!userValue || !typeValue) {
+            return null;
+        }
+        ensureAllowedType(typeValue);
+        const normalized = {
+            ...entry,
+            [userField]: toObjectId(userValue),
+            [typeField]: typeValue,
+        };
+        const rawTimestamp = entry[timestampField];
+        if (timestamp) {
+            if (rawTimestamp instanceof Date) {
+                normalized[timestampField] = rawTimestamp;
+            }
+            else if (rawTimestamp === undefined) {
+                normalized[timestampField] = new Date();
+            }
+            else if (typeof rawTimestamp === 'string' || typeof rawTimestamp === 'number') {
+                normalized[timestampField] = new Date(rawTimestamp);
+            }
+        }
+        else if (rawTimestamp !== undefined) {
+            delete normalized[timestampField];
+        }
+        return normalized;
+    };
+    schema.pre('save', function reactionsPreSave(next) {
+        try {
+            const existing = this.get(field) ??
+                [];
+            if (!existing.length) {
+                return next();
+            }
+            const normalizedEntries = [];
+            const seenUsers = new Map();
+            let modified = false;
+            for (const entry of existing) {
+                const normalized = normalizeEntry(entry);
+                if (!normalized) {
+                    modified = true;
+                    continue;
+                }
+                if (!allowMultiplePerUser) {
+                    const userKey = normalized[userField].toString();
+                    const idx = seenUsers.get(userKey);
+                    if (idx !== undefined) {
+                        normalizedEntries[idx] = normalized;
+                        modified = true;
+                    }
+                    else {
+                        seenUsers.set(userKey, normalizedEntries.length);
+                        normalizedEntries.push(normalized);
+                    }
+                }
+                else {
+                    normalizedEntries.push(normalized);
+                }
+            }
+            if (normalizedEntries.length !== existing.length || modified) {
+                this.set(field, normalizedEntries);
+            }
+            next();
+        }
+        catch (err) {
+            if (err instanceof Error) {
+                next(err);
+                return;
+            }
+            next(new Error('Unknown error while normalizing reactions.'));
+        }
+    });
+    schema.methods.addReaction = function addReaction(user, reactionType, timestampValue) {
+        ensureAllowedType(reactionType);
+        const userId = toObjectId(user);
+        const userKey = userId.toString();
+        const reactions = (this.get(field) ?? [])
+            .map((entry) => normalizeEntry(entry))
+            .filter((entry) => entry !== null);
+        let updated = false;
+        if (!allowMultiplePerUser) {
+            const existingIndex = reactions.findIndex((entry) => entry[userField]?.toString() === userKey);
+            const newEntry = {
+                [userField]: userId,
+                [typeField]: reactionType,
+            };
+            if (timestamp) {
+                newEntry[timestampField] = (timestampValue ?? new Date());
+            }
+            if (existingIndex !== -1) {
+                reactions[existingIndex] = newEntry;
+            }
+            else {
+                reactions.push(newEntry);
+            }
+            updated = true;
+        }
+        else {
+            const newEntry = {
+                [userField]: userId,
+                [typeField]: reactionType,
+            };
+            if (timestamp) {
+                newEntry[timestampField] = (timestampValue ?? new Date());
+            }
+            reactions.push(newEntry);
+            updated = true;
+        }
+        if (updated) {
+            this.set(field, reactions);
+        }
+        return this;
+    };
+    schema.methods.removeReaction = function removeReaction(user, reactionType) {
+        const userKey = toStringId(user);
+        const reactions = this.get(field) ?? [];
+        const filtered = reactions.filter((entry) => {
+            const matchesUser = entry[userField]?.toString() === userKey;
+            if (!matchesUser) {
+                return true;
+            }
+            if (!reactionType) {
+                return false;
+            }
+            return entry[typeField] !== reactionType;
+        });
+        if (filtered.length !== reactions.length) {
+            this.set(field, filtered);
+        }
+        return this;
+    };
+    schema.methods.hasReaction = function hasReaction(user, reactionType) {
+        const userKey = toStringId(user);
+        const reactions = this.get(field) ?? [];
+        return reactions.some((entry) => {
+            if (entry[userField]?.toString() !== userKey) {
+                return false;
+            }
+            if (reactionType) {
+                return entry[typeField] === reactionType;
+            }
+            return true;
+        });
+    };
+    schema.methods.countReactions = function countReactions(reactionType) {
+        const reactions = this.get(field) ?? [];
+        if (reactionType) {
+            ensureAllowedType(reactionType);
+            return reactions.filter((entry) => entry[typeField] === reactionType).length;
+        }
+        return reactions.reduce((accumulator, entry) => {
+            const type = entry[typeField];
+            accumulator.perType[type] = (accumulator.perType[type] ?? 0) + 1;
+            accumulator.total += 1;
+            return accumulator;
+        }, { total: 0, perType: {} });
+    };
+};
+export default reactionsMiddleware;
+//# sourceMappingURL=reactions.js.map

package/dist/middleware/reactions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"reactions.js","sourceRoot":"","sources":["../../src/middleware/reactions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAmB,MAAM,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AAE1D,OAAO,EAAM,UAAU,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAG3D,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAU,CAAC;AA+D5E,MAAM,mBAAmB,GAA+C,CAWtE,MAAuC,EACvC,EACE,YAAY,GAAG,oBAAoB,EACnC,oBAAoB,GAAG,KAAK,EAC5B,KAAK,GAAG,WAAoB,EAC5B,SAAS,GAAG,KAAK,EACjB,SAAS,GAAG,IAAI,EAChB,SAAS,GAAG,IAAI,EAChB,cAAc,GAAG,WAA6B,EAC9C,SAAS,GAAG,MAAmB,EAC/B,SAAS,GAAG,MAAmB,EAC/B,OAAO,GAAG,MAAM,MAC2D,EAAE,EACzE,EAAE;IACR,MAAM,eAAe,GAAG,IAAI,GAAG,CAAC,YAAY,CAAC,CAAC;IAC9C,MAAM,yBAAyB,GAAG,eAAe,CAAC,IAAI,GAAG,CAAC,CAAC;IAE3D,MAAM,wBAAwB,GAA4B;QACxD,CAAC,SAAS,CAAC,EAAE;YACX,GAAG,EAAE,OAAO;YACZ,QAAQ,EAAE,IAAI;YACd,IAAI,EAAE,KAAK,CAAC,QAAQ;SACrB;QACD,CAAC,SAAS,CAAC,EAAE;YACX,QAAQ,EAAE,IAAI;YACd,IAAI,EAAE,MAAM;YACZ,GAAG,CAAC,yBAAyB,IAAI,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,eAAe,CAAC,EAAE,CAAC;SACxE;KACF,CAAC;IAEF,MAAM,kBAAkB,GAAG,IAAI,MAAM,CACnC,wBAAwB,EACxB;QACE,GAAG,EAAE,KAAK;QACV,UAAU,EAAE,SAAS,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,cAAc,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,KAAK;KAChF,CACF,CAAC;IAEF,MAAM,CAAC,GAAG,CACR,IAAI,MAAM,CAA6D;QACrE,CAAC,KAAK,CAAC,EAAE;YACP,OAAO,EAAE,EAAE;YACX,IAAI,EAAE,CAAC,kBAAkB,CAAC;SAC3B;KACF,CAAC,CACH,CAAC;IAEF,IAAI,SAAS,EAAE,CAAC;QACd,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,GAAG,KAAK,IAAI,SAAS,EAAE,CAAC,EAAE,SAAS,KAAK,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE,CAAC,CAAC;IAClF,CAAC;IAED,IAAI,SAAS,EAAE,CAAC;QACd,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,GAAG,KAAK,IAAI,SAAS,EAAE,CAAC,EAAE,SAAS,KAAK,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE,CAAC,CAAC;IAClF,CAAC;IAED,MAAM,iBAAiB,GAAG,CAAC,YAAoB,EAAQ,EAAE;QACvD,IAAI,yBAAyB,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,YAAY,CAAC,EAAE,CAAC;YACpE,MAAM,IAAI,KAAK,CAAC,kBAAkB,YAAY,qBAAqB,CAAC,CAAC;QACvE,CAAC;IACH,CAAC,CAAC;IAEF,MAAM,cAAc,GAAG,CACrB,KAA0D,EACE,EAAE;QAC9D,MAAM,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC;QACnC,MAAM,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC;QAEnC,IAAI,CAAC,SAAS,IAAI,CAAC,SAAS,EAAE,CAAC;YAC7B,OAAO,IAAI,CAAC;QACd,CAAC;QAED,iBAAiB,CAAC,SAAS,CAAC,CAAC;QAE7B,MAAM,UAAU,GAAwD;YACtE,GAAG,KAAK;YACR,CAAC,SAAS,CAAC,EAAE,UAAU,CAAC,SAAS,CAAC;YAClC,CAAC,SAAS,CAAC,EAAE,SAAS;SACgC,CAAC;QAEzD,MAAM,YAAY,GAAG,KAAK,CAAC,cAAc,CAAY,CAAC;QAEtD,IAAI,SAAS,EAAE,CAAC;YACd,IAAI,YAAY,YAAY,IAAI,EAAE,CAAC;gBACjC,UAAU,CAAC,cAAc,CAAC,GAAG,YAIZ,CAAC;YACpB,CAAC;iBAAM,IAAI,YAAY,KAAK,SAAS,EAAE,CAAC;gBACtC,UAAU,CAAC,cAAc,CAAC,GAAG,IAAI,IAAI,EAIpB,CAAC;YACpB,CAAC;iBAAM,IAAI,OAAO,YAAY,KAAK,QAAQ,IAAI,OAAO,YAAY,KAAK,QAAQ,EAAE,CAAC;gBAChF,UAAU,CAAC,cAAc,CAAC,GAAG,IAAI,IAAI,CAAC,YAAY,CAIjC,CAAC;YACpB,CAAC;QACH,CAAC;aAAM,IAAI,YAAY,KAAK,SAAS,EAAE,CAAC;YACtC,OAAQ,UAAsC,CAAC,cAAc,CAAC,CAAC;QACjE,CAAC;QAED,OAAO,UAAU,CAAC;IACpB,CAAC,CAAC;IAEF,MAAM,CAAC,GAAG,CAAU,MAAM,EAAE,SAAS,gBAAgB,CAAC,IAAI;QACxD,IAAI,CAAC;YACH,MAAM,QAAQ,GACX,IAAI,CAAC,GAAG,CAAC,KAAK,CAAuE;gBACtF,EAAE,CAAC;YAEL,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;gBACrB,OAAO,IAAI,EAAE,CAAC;YAChB,CAAC;YAED,MAAM,iBAAiB,GAA0D,EAAE,CAAC;YACpF,MAAM,SAAS,GAAG,IAAI,GAAG,EAAkB,CAAC;YAC5C,IAAI,QAAQ,GAAG,KAAK,CAAC;YAErB,KAAK,MAAM,KAAK,IAAI,QAAQ,EAAE,CAAC;gBAC7B,MAAM,UAAU,GAAG,cAAc,CAAC,KAAK,CAAC,CAAC;gBACzC,IAAI,CAAC,UAAU,EAAE,CAAC;oBAChB,QAAQ,GAAG,IAAI,CAAC;oBAChB,SAAS;gBACX,CAAC;gBAED,IAAI,CAAC,oBAAoB,EAAE,CAAC;oBAC1B,MAAM,OAAO,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,QAAQ,EAAE,CAAC;oBACjD,MAAM,GAAG,GAAG,SAAS,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;oBAEnC,IAAI,GAAG,KAAK,SAAS,EAAE,CAAC;wBACtB,iBAAiB,CAAC,GAAG,CAAC,GAAG,UAAU,CAAC;wBACpC,QAAQ,GAAG,IAAI,CAAC;oBAClB,CAAC;yBAAM,CAAC;wBACN,SAAS,CAAC,GAAG,CAAC,OAAO,EAAE,iBAAiB,CAAC,MAAM,CAAC,CAAC;wBACjD,iBAAiB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;oBACrC,CAAC;gBACH,CAAC;qBAAM,CAAC;oBACN,iBAAiB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;gBACrC,CAAC;YACH,CAAC;YAED,IAAI,iBAAiB,CAAC,MAAM,KAAK,QAAQ,CAAC,MAAM,IAAI,QAAQ,EAAE,CAAC;gBAC7D,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,iBAAiB,CAAC,CAAC;YACrC,CAAC;YAED,IAAI,EAAE,CAAC;QACT,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,IAAI,GAAG,YAAY,KAAK,EAAE,CAAC;gBACzB,IAAI,CAAC,GAAG,CAAC,CAAC;gBACV,OAAO;YACT,CAAC;YAED,IAAI,CAAC,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAC,CAAC;QAChE,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,MAAM,CAAC,OAAO,CAAC,WAAW,GAAG,SAAS,WAAW,CAE/C,IAAQ,EACR,YAAoB,EACpB,cAAqB;QAErB,iBAAiB,CAAC,YAAY,CAAC,CAAC;QAEhC,MAAM,MAAM,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC;QAChC,MAAM,OAAO,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC;QAClC,MAAM,SAAS,GAAG,CACf,IAAI,CAAC,GAAG,CAAC,KAAK,CAA2D,IAAI,EAAE,CACjF;aACE,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;aACrC,MAAM,CACL,CAAC,KAAK,EAAgE,EAAE,CAAC,KAAK,KAAK,IAAI,CACxF,CAAC;QAEJ,IAAI,OAAO,GAAG,KAAK,CAAC;QAEpB,IAAI,CAAC,oBAAoB,EAAE,CAAC;YAC1B,MAAM,aAAa,GAAG,SAAS,CAAC,SAAS,CACvC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,EAAE,QAAQ,EAAE,KAAK,OAAO,CACpD,CAAC;YAEF,MAAM,QAAQ,GAAwD;gBACpE,CAAC,SAAS,CAAC,EAAE,MAAM;gBACnB,CAAC,SAAS,CAAC,EAAE,YAAY;aAC6B,CAAC;YAEzD,IAAI,SAAS,EAAE,CAAC;gBACd,QAAQ,CAAC,cAAc,CAAC,GAAG,CAAC,cAAc,IAAI,IAAI,IAAI,EAAE,CAIvC,CAAC;YACpB,CAAC;YAED,IAAI,aAAa,KAAK,CAAC,CAAC,EAAE,CAAC;gBACzB,SAAS,CAAC,aAAa,CAAC,GAAG,QAAQ,CAAC;YACtC,CAAC;iBAAM,CAAC;gBACN,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YAC3B,CAAC;YAED,OAAO,GAAG,IAAI,CAAC;QACjB,CAAC;aAAM,CAAC;YACN,MAAM,QAAQ,GAAwD;gBACpE,CAAC,SAAS,CAAC,EAAE,MAAM;gBACnB,CAAC,SAAS,CAAC,EAAE,YAAY;aAC6B,CAAC;YAEzD,IAAI,SAAS,EAAE,CAAC;gBACd,QAAQ,CAAC,cAAc,CAAC,GAAG,CAAC,cAAc,IAAI,IAAI,IAAI,EAAE,CAIvC,CAAC;YACpB,CAAC;YAED,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YACzB,OAAO,GAAG,IAAI,CAAC;QACjB,CAAC;QAED,IAAI,OAAO,EAAE,CAAC;YACZ,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;QAC7B,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC,CAAC;IAEF,MAAM,CAAC,OAAO,CAAC,cAAc,GAAG,SAAS,cAAc,CAErD,IAAQ,EACR,YAAqB;QAErB,MAAM,OAAO,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC;QACjC,MAAM,SAAS,GACZ,IAAI,CAAC,GAAG,CAAC,KAAK,CAAuE,IAAI,EAAE,CAAC;QAE/F,MAAM,QAAQ,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YAC1C,MAAM,WAAW,GAAG,KAAK,CAAC,SAAS,CAAC,EAAE,QAAQ,EAAE,KAAK,OAAO,CAAC;YAC7D,IAAI,CAAC,WAAW,EAAE,CAAC;gBACjB,OAAO,IAAI,CAAC;YACd,CAAC;YAED,IAAI,CAAC,YAAY,EAAE,CAAC;gBAClB,OAAO,KAAK,CAAC;YACf,CAAC;YAED,OAAO,KAAK,CAAC,SAAS,CAAC,KAAK,YAAY,CAAC;QAC3C,CAAC,CAAC,CAAC;QAEH,IAAI,QAAQ,CAAC,MAAM,KAAK,SAAS,CAAC,MAAM,EAAE,CAAC;YACzC,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;QAC5B,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC,CAAC;IAEF,MAAM,CAAC,OAAO,CAAC,WAAW,GAAG,SAAS,WAAW,CAE/C,IAAQ,EACR,YAAqB;QAErB,MAAM,OAAO,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC;QACjC,MAAM,SAAS,GACZ,IAAI,CAAC,GAAG,CAAC,KAAK,CAAuE,IAAI,EAAE,CAAC;QAE/F,OAAO,SAAS,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE;YAC9B,IAAI,KAAK,CAAC,SAAS,CAAC,EAAE,QAAQ,EAAE,KAAK,OAAO,EAAE,CAAC;gBAC7C,OAAO,KAAK,CAAC;YACf,CAAC;YAED,IAAI,YAAY,EAAE,CAAC;gBACjB,OAAO,KAAK,CAAC,SAAS,CAAC,KAAK,YAAY,CAAC;YAC3C,CAAC;YAED,OAAO,IAAI,CAAC;QACd,CAAC,CAAC,CAAC;IACL,CAAC,CAAC;IAEF,MAAM,CAAC,OAAO,CAAC,cAAc,GAAG,SAAS,cAAc,CAErD,YAAqB;QAErB,MAAM,SAAS,GACZ,IAAI,CAAC,GAAG,CAAC,KAAK,CAAuE,IAAI,EAAE,CAAC;QAE/F,IAAI,YAAY,EAAE,CAAC;YACjB,iBAAiB,CAAC,YAAY,CAAC,CAAC;YAChC,OAAO,SAAS,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,KAAK,YAAY,CAAC,CAAC,MAAM,CAAC;QAC/E,CAAC;QAED,OAAO,SAAS,CAAC,MAAM,CACrB,CAAC,WAAW,EAAE,KAAK,EAAE,EAAE;YACrB,MAAM,IAAI,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC;YAC9B,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC;YACjE,WAAW,CAAC,KAAK,IAAI,CAAC,CAAC;YACvB,OAAO,WAAW,CAAC;QACrB,CAAC,EACD,EAAE,KAAK,EAAE,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE,CAC1B,CAAC;IACJ,CAAC,CAAC;AACJ,CAAC,CAAC;AAEF,eAAe,mBAAmB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@slango/mangusta",
-  "version": "1.0.7",
+  "version": "1.1.0",
   "private": false,
   "description": "Mongoose middlewares and utilities",
   "type": "module",
@@ -12,22 +12,22 @@
   },
   "dependencies": {
     "bcrypt": "6.0.0",
-    "nanoid": "5.1.5"
+    "nanoid": "5.1.6"
   },
   "peerDependencies": {
-    "mongoose": "^8.18.1"
+    "mongoose": "^8.18.2"
   },
   "devDependencies": {
     "@types/bcrypt": "6.0.0",
     "@vitest/coverage-v8": "3.2.4",
     "@vitest/ui": "3.2.4",
     "eslint": "9.36.0",
-    "mongoose": "8.18.1",
+    "mongoose": "8.18.2",
     "typescript": "5.9.2",
     "vitest": "3.2.4",
+    "@slango.configs/eslint": "1.1.12",
     "@slango.configs/typescript": "1.0.5",
-    "@slango.configs/vitest": "1.0.30",
-    "@slango.configs/eslint": "1.1.9"
+    "@slango.configs/vitest": "1.0.33"
   },
   "scripts": {
     "build": "tsc -p tsconfig.build.json",

package/src/helpers.ts

@@ -0,0 +1,14 @@
+import { Types } from 'mongoose';
+
+export type Id = string | Types.ObjectId;
+
+export const toObjectId = (value: Id): Types.ObjectId => {
+  if (value instanceof Types.ObjectId) {
+    return value;
+  }
+
+  return new Types.ObjectId(value);
+};
+
+export const toStringId = (value: Id): string =>
+  value instanceof Types.ObjectId ? value.toString() : value;

package/src/middleware/reactions.spec.ts

@@ -0,0 +1,209 @@
+import { setupMongoTestEnvironment } from '@slango.configs/vitest/helpers/mongooseTestEnvironment';
+import mongoose, { Document, model, Schema, Types } from 'mongoose';
+import { describe, expect, it } from 'vitest';
+
+import type { PluginFunction } from '../types.js';
+
+import reactionsMiddleware, {
+  defaultReactionTypes,
+  ReactionCountSummary,
+  ReactionsMiddlewareOptions,
+  WithReactions,
+  WithReactionsMethods,
+} from './reactions.js';
+
+setupMongoTestEnvironment();
+
+type TestDoc<
+  Field extends string = 'reactions',
+  UserField extends string = 'user',
+  TypeField extends string = 'type',
+  TimestampField extends string = 'createdAt',
+> = Document &
+  WithReactions<Field, UserField, TypeField, TimestampField> &
+  WithReactionsMethods & {
+    [key: string]: unknown;
+  };
+
+const createTestModel = <
+  Field extends string = 'reactions',
+  UserField extends string = 'user',
+  TypeField extends string = 'type',
+  TimestampField extends string = 'createdAt',
+>(
+  options?: ReactionsMiddlewareOptions<Field, UserField, TypeField, TimestampField>,
+) => {
+  const modelName = 'ReactionsTestDoc';
+
+  if (mongoose.models[modelName]) {
+    delete mongoose.models[modelName];
+  }
+
+  const TestSchema = new Schema<TestDoc<Field, UserField, TypeField, TimestampField>>({});
+
+  if (options) {
+    TestSchema.plugin(
+      reactionsMiddleware as PluginFunction<
+        ReactionsMiddlewareOptions<Field, UserField, TypeField, TimestampField>
+      >,
+      options,
+    );
+  } else {
+    TestSchema.plugin(reactionsMiddleware);
+  }
+
+  return model<TestDoc<Field, UserField, TypeField, TimestampField>>(modelName, TestSchema);
+};
+
+describe('reactionsMiddleware', () => {
+  it('should add reactions field and persist entries with defaults', async () => {
+    const TestModel = createTestModel();
+    const userId = new Types.ObjectId();
+
+    const doc = new TestModel();
+    doc.reactions.push({ user: userId, type: defaultReactionTypes[0] });
+
+    await expect(doc.save()).resolves.not.toThrow();
+
+    const saved = await TestModel.findById(doc._id);
+    expect(saved).toBeDefined();
+    expect(saved!.reactions).toHaveLength(1);
+    expect(saved!.reactions[0]?.user?.toString()).toBe(userId.toString());
+    expect(saved!.reactions[0]?.type).toBe(defaultReactionTypes[0]);
+    expect(saved!.reactions[0]?.createdAt).toBeInstanceOf(Date);
+  });
+
+  it('should deduplicate reactions for the same user when multiple reactions are disabled', async () => {
+    const TestModel = createTestModel();
+    const userId = new Types.ObjectId();
+
+    const doc = new TestModel({
+      reactions: [
+        { user: userId, type: '👍' },
+        { user: userId, type: '❤️' },
+      ],
+    });
+
+    await expect(doc.save()).resolves.not.toThrow();
+
+    const saved = await TestModel.findById(doc._id).lean();
+    expect(saved).toBeDefined();
+    expect(saved!.reactions).toHaveLength(1);
+    expect(saved!.reactions[0]?.type).toBe('❤️');
+  });
+
+  it('should allow multiple reactions for the same user when enabled', async () => {
+    const TestModel = createTestModel({ allowMultiplePerUser: true });
+    const userId = new Types.ObjectId();
+
+    const doc = new TestModel();
+    doc.addReaction(userId, '👍');
+    doc.addReaction(userId, '❤️');
+
+    await expect(doc.save()).resolves.not.toThrow();
+
+    const saved = await TestModel.findById(doc._id);
+    expect(saved?.reactions).toHaveLength(2);
+    const types = saved?.reactions.map((reaction) => reaction.type).sort();
+    expect(types).toEqual(['❤️', '👍']);
+  });
+
+  it('should expose helper methods for managing reactions', async () => {
+    const TestModel = createTestModel();
+    const userId = new Types.ObjectId();
+
+    const doc = new TestModel();
+    doc.addReaction(userId, '👍');
+    doc.addReaction(userId, '❤️');
+
+    expect(doc.hasReaction(userId, '❤️')).toBe(true);
+    expect(doc.hasReaction(userId, '👍')).toBe(false);
+
+    const summary = doc.countReactions() as ReactionCountSummary;
+    expect(summary.total).toBe(1);
+    expect(summary.perType['❤️']).toBe(1);
+
+    const heartCount = doc.countReactions('❤️');
+    expect(heartCount).toBe(1);
+
+    doc.removeReaction(userId, '❤️');
+    expect(doc.hasReaction(userId)).toBe(false);
+
+    await expect(doc.save()).resolves.not.toThrow();
+    const saved = await TestModel.findById(doc._id);
+    expect(saved?.reactions).toHaveLength(0);
+  });
+
+  it('should reject unsupported reaction types', async () => {
+    const TestModel = createTestModel();
+    const userId = new Types.ObjectId();
+    const doc = new TestModel();
+
+    expect(() => doc.addReaction(userId, 'unsupported')).toThrowError(
+      /Reaction type "unsupported" is not permitted/,
+    );
+
+    doc.reactions.push({ user: userId, type: 'unsupported' });
+    await expect(doc.save()).rejects.toThrowError(
+      /`unsupported` is not a valid enum value for path `type`/,
+    );
+  });
+
+  it('should allow custom configuration for field and helper schema options', async () => {
+    const TestModel = createTestModel<'feedback', 'member', 'category', 'time'>({
+      field: 'feedback',
+      userField: 'member',
+      typeField: 'category',
+      timestampField: 'time',
+      allowMultiplePerUser: true,
+      allowedTypes: ['👏', '😲'],
+      indexUser: false,
+      indexType: true,
+      timestamp: true,
+      userRef: 'Account',
+    });
+
+    const doc = new TestModel();
+    const memberId = new Types.ObjectId();
+
+    doc.addReaction(memberId, '👏');
+    doc.addReaction(memberId, '😲');
+
+    expect(doc.hasReaction(memberId, '😲')).toBe(true);
+    const stats = doc.countReactions() as ReactionCountSummary;
+    expect(stats.total).toBe(2);
+    expect(Object.keys(stats.perType).sort()).toEqual(['👏', '😲']);
+
+    await expect(doc.save()).resolves.not.toThrow();
+
+    const indexes = TestModel.schema.indexes();
+    const categoryIndex = indexes.find(([fields]) =>
+      Object.prototype.hasOwnProperty.call(fields, 'feedback.category'),
+    );
+    const memberIndex = indexes.find(([fields]) =>
+      Object.prototype.hasOwnProperty.call(fields, 'feedback.member'),
+    );
+
+    expect(categoryIndex).toBeDefined();
+    expect(memberIndex).toBeUndefined();
+
+    const saved = await TestModel.findById(doc._id).lean();
+    expect(saved?.feedback).toHaveLength(2);
+    expect(saved?.feedback[0]).toHaveProperty('time');
+    expect(saved?.feedback[1]).toHaveProperty('time');
+  });
+
+  it('should support disabling timestamps', async () => {
+    const TestModel = createTestModel({ timestamp: false });
+    const userId = new Types.ObjectId();
+
+    const doc = new TestModel();
+    doc.addReaction(userId, '👍');
+
+    await expect(doc.save()).resolves.not.toThrow();
+
+    const saved = await TestModel.findById(doc._id).lean();
+    expect(saved?.reactions).toHaveLength(1);
+    expect(saved?.reactions[0]?.createdAt).toBeUndefined();
+  });
+});