Intlayer

import { DictionaryModel } from '@models/dictionary.model'; import { ensureMongoDocumentToObject } from '@utils/ensureMongoDocumentToObject'; import { GenericError } from '@utils/errors'; import type { DictionaryFilters } from '@utils/filtersAndPagination/getDictionaryFiltersAndPagination'; import { removeObjectKeys } from '@utils/removeObjectKeys'; import { type DictionaryFields, validateDictionary, } from '@utils/validation/validateDictionary'; import { Types } from 'mongoose'; import type { Dictionary, DictionaryData, DictionaryDocument, } from '@/types/dictionary.types'; import type { Project } from '@/types/project.types'; /** * Finds dictionaries based on filters and pagination options. * @param filters - MongoDB filter query. * @param skip - Number of documents to skip. * @param limit - Number of documents to limit. * @returns List of dictionaries matching the filters. */ export const findDictionaries = async ( filters: DictionaryFilters, skip = 0, limit = 100, sortOptions?: Record<string, 1 | -1> ): Promise<DictionaryDocument[]> => { try { const dictionaries = await DictionaryModel.aggregate<DictionaryDocument>([ // Stage 1: Match the filters { $match: filters }, // Stage 2: Sort if provided (default handled in filter builder) ...(sortOptions && Object.keys(sortOptions).length > 0 ? [{ $sort: sortOptions }] : []), // Stage 3: Skip for pagination { $skip: skip }, // Stage 4: Limit the number of documents { $limit: limit }, ]); const formattedResults = dictionaries.map( (result) => new DictionaryModel(result) ); return formattedResults; } catch (error) { console.error('Error fetching dictionaries:', error); throw error; } }; /** * Finds a dictionary by its ID. * @param dictionaryId - The ID of the dictionary to find. * @returns The dictionary matching the ID. */ /** * Finds a dictionary by its ID and includes the 'versions' field. * @param dictionaryId - The ID of the dictionary to find. * @returns The dictionary matching the ID with available versions. */ export const getDictionaryById = async ( dictionaryId: string | Types.ObjectId ): Promise<DictionaryDocument> => { const id = Types.ObjectId.isValid(dictionaryId as string) ? new Types.ObjectId(dictionaryId as string) : dictionaryId; const dictionaries = await DictionaryModel.aggregate<DictionaryDocument>([ // Stage 1: Match the document by ID { $match: { _id: id } }, // Stage 2: Add the 'versions' field { $addFields: { versions: { $map: { input: { $objectToArray: '$content' }, as: 'version', in: '$$version.k', }, }, }, }, ]); if (!dictionaries.length) { throw new GenericError('DICTIONARY_NOT_FOUND', { dictionaryId }); } return new DictionaryModel(dictionaries[0]); }; /** * Finds a dictionary by its ID. * @param dictionaryKey - The ID of the dictionary to find. * @returns The dictionary matching the ID. */ export const getDictionaryByKey = async ( dictionaryKey: string, projectId: string | Types.ObjectId ): Promise<DictionaryDocument> => { const dictionaries = await getDictionariesByKeys([dictionaryKey], projectId); return dictionaries[0]; }; export const getDictionariesByKeys = async ( dictionaryKeys: string[], projectId: string | Types.ObjectId ): Promise<DictionaryDocument[]> => { const dictionaries = await DictionaryModel.aggregate<DictionaryDocument>([ // Stage 1: Match the document by key { $match: { key: { $in: dictionaryKeys }, projectIds: projectId } }, // Stage 2: Add the 'versions' field { $addFields: { versions: { $map: { input: { $objectToArray: '$content' }, as: 'version', in: '$$version.k', }, }, }, }, ]); if (!dictionaries) { throw new GenericError('DICTIONARY_NOT_FOUND', { dictionaryKeys, projectId, }); } const formattedResults = dictionaries.map( (result) => new DictionaryModel(result) ); return formattedResults; }; export const getDictionariesByTags = async ( tags: string[], projectId: string | Project['id'] ): Promise<DictionaryDocument[]> => { const dictionaries = await DictionaryModel.aggregate<DictionaryDocument>([ // Stage 1: Match the document by tags { $match: { tags: { $in: tags }, projectIds: projectId, }, }, // Stage 2: Add the 'versions' field { $addFields: { versions: { $map: { input: { $objectToArray: '$content' }, as: 'version', in: '$$version.k', }, }, }, }, ]); const formattedResults = dictionaries.map( (result) => new DictionaryModel(result) ); return formattedResults; }; /** * Counts the total number of dictionaries that match the filters. * @param filters - MongoDB filter query. * @returns Total number of dictionaries. */ export const countDictionaries = async ( filters: DictionaryFilters ): Promise<number> => { const result = await DictionaryModel.countDocuments(filters); if (typeof result === 'undefined') { throw new GenericError('DICTIONARY_COUNT_FAILED', { filters }); } return result; }; /** * Creates a new dictionary in the database. * @param dictionary - The dictionary data to create. * @returns The created dictionary. */ export const createDictionary = async ( dictionary: DictionaryData ): Promise<DictionaryDocument> => { const errors = await validateDictionary(dictionary); if (Object.keys(errors).length > 0) { throw new GenericError('DICTIONARY_INVALID_FIELDS', { errors, }); } return await DictionaryModel.create(dictionary); }; /** * Updates an existing dictionary in the database by its ID. * @param dictionaryId - The ID of the dictionary to update. * @param dictionary - The updated dictionary data. * @returns The updated dictionary. */ export const updateDictionaryById = async ( dictionaryId: string | Types.ObjectId, dictionary: Partial<Dictionary> ): Promise<DictionaryDocument> => { const dictionaryObject = ensureMongoDocumentToObject(dictionary); const dictionaryToUpdate = removeObjectKeys(dictionaryObject, [ 'id', ]) as unknown as Partial<Dictionary>; const updatedKeys = Object.keys(dictionaryToUpdate) as DictionaryFields; const errors = await validateDictionary(dictionaryToUpdate, updatedKeys); if (Object.keys(errors).length > 0) { throw new GenericError('DICTIONARY_INVALID_FIELDS', { dictionaryId, errors, }); } const result = await DictionaryModel.updateOne( { _id: dictionaryId }, dictionaryToUpdate ); if (result.matchedCount === 0) { throw new GenericError('DICTIONARY_UPDATE_FAILED', { dictionaryId }); } const updatedDictionary = await getDictionaryById(dictionaryId); return updatedDictionary; }; /** * Updates an existing dictionary in the database by its key. * @param dictionaryKey - The ID of the dictionary to update. * @param dictionary - The updated dictionary data. * @returns The updated dictionary. */ export const updateDictionaryByKey = async ( dictionaryKey: string, dictionary: Partial<Dictionary>, projectId: string | Types.ObjectId ): Promise<DictionaryDocument> => { const existing = await DictionaryModel.findOne({ key: dictionaryKey, projectIds: projectId, }); if (!existing) { throw new GenericError('DICTIONARY_UPDATE_FAILED', { dictionaryKey }); } const dictionaryObject = ensureMongoDocumentToObject(dictionary); const dictionaryToUpdate = removeObjectKeys(dictionaryObject, [ 'id', ]) as Partial<Dictionary>; // Optional: run your validateDictionary on dictionaryToUpdate here // Apply updated fields onto the existing doc Object.assign(existing, dictionaryToUpdate); // Save – this will trigger timestamps on parent + subdocs await existing.save(); return existing; }; /** * Deletes a dictionary from the database by its ID. * @param dictionaryId - The ID of the dictionary to delete. * @returns The result of the deletion operation. */ export const deleteDictionaryById = async ( dictionaryId: string ): Promise<DictionaryDocument> => { const dictionary = await DictionaryModel.findByIdAndDelete(dictionaryId); if (!dictionary) { throw new GenericError('DICTIONARY_NOT_FOUND', { dictionaryId }); } return dictionary; }; // Function to extract the numeric part of the version const getVersionNumber = (version: string): number => { const match = version.match(/^v(\d+)$/); if (!match) { throw new Error(`Invalid version format: ${version}`); } return parseInt(match[1], 10); }; export const incrementVersion = (dictionary: Dictionary): string => { const VERSION_PREFIX = 'v'; const versions = [...(dictionary.content.keys() ?? [])]; const lastVersion = versions[versions.length - 1]; // Start with the next version number let newNumber = getVersionNumber(lastVersion) + 1; let newVersion = `${VERSION_PREFIX}${newNumber}`; // Loop until a unique version is found while (versions.includes(newVersion)) { newNumber += 1; newVersion = `${VERSION_PREFIX}${newNumber}`; } return newVersion; };