@intlayer/backend 3.5.5 → 3.5.6

package/dist/cjs/services/project.service.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/services/project.service.ts"],"sourcesContent":["import { ProjectModel } from '@models/project.model';\nimport { GenericError } from '@utils/errors';\nimport type { ProjectFilters } from '@utils/filtersAndPagination/getProjectFiltersAndPagination';\nimport {\n  type ProjectFields,\n  validateProject,\n} from '@utils/validation/validateProject';\nimport type { ObjectId } from 'mongoose';\nimport type {\n  Project,\n  ProjectData,\n  ProjectDocument,\n} from '@/types/project.types';\n\n/**\n * Finds projects based on filters and pagination options.\n * @param filters - MongoDB filter query.\n * @param skip - Number of documents to skip.\n * @param limit - Number of documents to limit.\n * @returns List of projects matching the filters.\n */\nexport const findProjects = async (\n  filters: ProjectFilters,\n  skip = 0,\n  limit = 100\n): Promise<ProjectDocument[]> =>\n  await ProjectModel.find(filters).skip(skip).limit(limit);\n\n/**\n * Finds a project by its ID.\n * @param projectId - The ID of the project to find.\n * @returns The project matching the ID.\n */\nexport const getProjectById = async (\n  projectId: string | ObjectId\n): Promise<ProjectDocument> => {\n  const project = await ProjectModel.findById(projectId);\n\n  if (!project) {\n    throw new GenericError('PROJECT_NOT_DEFINED', { projectId });\n  }\n\n  return project;\n};\n\n/**\n * Counts the total number of projects that match the filters.\n * @param filters - MongoDB filter query.\n * @returns Total number of projects.\n */\nexport const countProjects = async (\n  filters: ProjectFilters\n): Promise<number> => {\n  const result = await ProjectModel.countDocuments(filters);\n\n  if (typeof result === 'undefined') {\n    throw new GenericError('PROJECT_COUNT_FAILED', { filters });\n  }\n\n  return result;\n};\n\n/**\n * Creates a new project in the database.\n * @param  project - The project data to create.\n * @returns The created project.\n */\nexport const createProject = async (\n  project: ProjectData\n): Promise<ProjectDocument> => {\n  if ((project as Partial<Project>).oAuth2Access) {\n    delete (project as Partial<Project>).oAuth2Access;\n  }\n\n  const errors = await validateProject(project, ['name']);\n\n  if (Object.keys(errors).length > 0) {\n    throw new GenericError('PROJECT_INVALID_FIELDS', { errors });\n  }\n\n  return await ProjectModel.create(project);\n};\n\n/**\n * Updates an existing project in the database by its ID.\n * @param projectId - The ID of the project to update.\n * @param project - The updated project data.\n * @returns The updated project.\n */\nexport const updateProjectById = async (\n  projectId: string | ObjectId,\n  project: Partial<Project>\n): Promise<ProjectDocument> => {\n  if (project.oAuth2Access) {\n    delete project.oAuth2Access;\n  }\n\n  const updatedKeys = Object.keys(project) as ProjectFields;\n\n  const errors = validateProject(project, updatedKeys);\n\n  if (Object.keys(errors).length > 0) {\n    throw new GenericError('PROJECT_INVALID_FIELDS', {\n      projectId,\n      errors,\n    });\n  }\n\n  const result = await ProjectModel.updateOne({ _id: projectId }, project);\n\n  if (result.matchedCount === 0) {\n    throw new GenericError('PROJECT_UPDATE_FAILED', { projectId });\n  }\n\n  return await getProjectById(projectId);\n};\n\n/**\n * Deletes a project from the database by its ID.\n * @param projectId - The ID of the project to delete.\n * @returns The result of the deletion operation.\n */\nexport const deleteProjectById = async (\n  projectId: string | ObjectId\n): Promise<ProjectDocument> => {\n  const project = await ProjectModel.findByIdAndDelete(projectId);\n\n  if (!project) {\n    throw new GenericError('PROJECT_NOT_DEFINED', { projectId });\n  }\n\n  return project;\n};\n"],"mappings":";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,qBAA6B;AAC7B,oBAA6B;AAE7B,6BAGO;AAeA,MAAM,eAAe,OAC1B,SACA,OAAO,GACP,QAAQ,QAER,MAAM,4BAAa,KAAK,OAAO,EAAE,KAAK,IAAI,EAAE,MAAM,KAAK;AAOlD,MAAM,iBAAiB,OAC5B,cAC6B;AAC7B,QAAM,UAAU,MAAM,4BAAa,SAAS,SAAS;AAErD,MAAI,CAAC,SAAS;AACZ,UAAM,IAAI,2BAAa,uBAAuB,EAAE,UAAU,CAAC;AAAA,EAC7D;AAEA,SAAO;AACT;AAOO,MAAM,gBAAgB,OAC3B,YACoB;AACpB,QAAM,SAAS,MAAM,4BAAa,eAAe,OAAO;AAExD,MAAI,OAAO,WAAW,aAAa;AACjC,UAAM,IAAI,2BAAa,wBAAwB,EAAE,QAAQ,CAAC;AAAA,EAC5D;AAEA,SAAO;AACT;AAOO,MAAM,gBAAgB,OAC3B,YAC6B;AAC7B,MAAK,QAA6B,cAAc;AAC9C,WAAQ,QAA6B;AAAA,EACvC;AAEA,QAAM,SAAS,UAAM,wCAAgB,SAAS,CAAC,MAAM,CAAC;AAEtD,MAAI,OAAO,KAAK,MAAM,EAAE,SAAS,GAAG;AAClC,UAAM,IAAI,2BAAa,0BAA0B,EAAE,OAAO,CAAC;AAAA,EAC7D;AAEA,SAAO,MAAM,4BAAa,OAAO,OAAO;AAC1C;AAQO,MAAM,oBAAoB,OAC/B,WACA,YAC6B;AAC7B,MAAI,QAAQ,cAAc;AACxB,WAAO,QAAQ;AAAA,EACjB;AAEA,QAAM,cAAc,OAAO,KAAK,OAAO;AAEvC,QAAM,aAAS,wCAAgB,SAAS,WAAW;AAEnD,MAAI,OAAO,KAAK,MAAM,EAAE,SAAS,GAAG;AAClC,UAAM,IAAI,2BAAa,0BAA0B;AAAA,MAC/C;AAAA,MACA;AAAA,IACF,CAAC;AAAA,EACH;AAEA,QAAM,SAAS,MAAM,4BAAa,UAAU,EAAE,KAAK,UAAU,GAAG,OAAO;AAEvE,MAAI,OAAO,iBAAiB,GAAG;AAC7B,UAAM,IAAI,2BAAa,yBAAyB,EAAE,UAAU,CAAC;AAAA,EAC/D;AAEA,SAAO,MAAM,eAAe,SAAS;AACvC;AAOO,MAAM,oBAAoB,OAC/B,cAC6B;AAC7B,QAAM,UAAU,MAAM,4BAAa,kBAAkB,SAAS;AAE9D,MAAI,CAAC,SAAS;AACZ,UAAM,IAAI,2BAAa,uBAAuB,EAAE,UAAU,CAAC;AAAA,EAC7D;AAEA,SAAO;AACT;","names":[]}
+{"version":3,"sources":["../../../src/services/project.service.ts"],"sourcesContent":["import { ProjectModel } from '@models/project.model';\nimport { ensureMongoDocumentToObject } from '@utils/ensureMongoDocumentToObject';\nimport { GenericError } from '@utils/errors';\nimport type { ProjectFilters } from '@utils/filtersAndPagination/getProjectFiltersAndPagination';\nimport { removeObjectKeys } from '@utils/removeObjectKeys';\nimport {\n  type ProjectFields,\n  validateProject,\n} from '@utils/validation/validateProject';\nimport type { ObjectId } from 'mongoose';\nimport type {\n  Project,\n  ProjectData,\n  ProjectDocument,\n} from '@/types/project.types';\n\n/**\n * Finds projects based on filters and pagination options.\n * @param filters - MongoDB filter query.\n * @param skip - Number of documents to skip.\n * @param limit - Number of documents to limit.\n * @returns List of projects matching the filters.\n */\nexport const findProjects = async (\n  filters: ProjectFilters,\n  skip = 0,\n  limit = 100\n): Promise<ProjectDocument[]> =>\n  await ProjectModel.find(filters).skip(skip).limit(limit);\n\n/**\n * Finds a project by its ID.\n * @param projectId - The ID of the project to find.\n * @returns The project matching the ID.\n */\nexport const getProjectById = async (\n  projectId: string | ObjectId\n): Promise<ProjectDocument> => {\n  const project = await ProjectModel.findById(projectId);\n\n  if (!project) {\n    throw new GenericError('PROJECT_NOT_DEFINED', { projectId });\n  }\n\n  return project;\n};\n\n/**\n * Counts the total number of projects that match the filters.\n * @param filters - MongoDB filter query.\n * @returns Total number of projects.\n */\nexport const countProjects = async (\n  filters: ProjectFilters\n): Promise<number> => {\n  const result = await ProjectModel.countDocuments(filters);\n\n  if (typeof result === 'undefined') {\n    throw new GenericError('PROJECT_COUNT_FAILED', { filters });\n  }\n\n  return result;\n};\n\n/**\n * Creates a new project in the database.\n * @param  project - The project data to create.\n * @returns The created project.\n */\nexport const createProject = async (\n  project: ProjectData\n): Promise<ProjectDocument> => {\n  if ((project as Partial<Project>).oAuth2Access) {\n    delete (project as Partial<Project>).oAuth2Access;\n  }\n\n  const errors = await validateProject(project, ['name']);\n\n  if (Object.keys(errors).length > 0) {\n    throw new GenericError('PROJECT_INVALID_FIELDS', { errors });\n  }\n\n  return await ProjectModel.create(project);\n};\n\n/**\n * Updates an existing project in the database by its ID.\n * @param projectId - The ID of the project to update.\n * @param project - The updated project data.\n * @returns The updated project.\n */\nexport const updateProjectById = async (\n  projectId: string | ObjectId,\n  project: Partial<Project>\n): Promise<ProjectDocument> => {\n  const projectObject = ensureMongoDocumentToObject(project);\n  const projectToUpdate = removeObjectKeys(projectObject, [\n    '_id',\n    'oAuth2Access',\n    'organizationId',\n  ]);\n\n  const updatedKeys = Object.keys(projectToUpdate) as ProjectFields;\n\n  const errors = validateProject(project, updatedKeys);\n\n  if (Object.keys(errors).length > 0) {\n    throw new GenericError('PROJECT_INVALID_FIELDS', {\n      projectId,\n      errors,\n    });\n  }\n\n  console.log('projectToUpdate', projectToUpdate);\n\n  const result = await ProjectModel.updateOne(\n    { _id: projectId },\n    projectToUpdate\n  );\n\n  if (result.matchedCount === 0) {\n    throw new GenericError('PROJECT_UPDATE_FAILED', { projectId });\n  }\n\n  return await getProjectById(projectId);\n};\n\n/**\n * Deletes a project from the database by its ID.\n * @param projectId - The ID of the project to delete.\n * @returns The result of the deletion operation.\n */\nexport const deleteProjectById = async (\n  projectId: string | ObjectId\n): Promise<ProjectDocument> => {\n  const project = await ProjectModel.findByIdAndDelete(projectId);\n\n  if (!project) {\n    throw new GenericError('PROJECT_NOT_DEFINED', { projectId });\n  }\n\n  return project;\n};\n"],"mappings":";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,qBAA6B;AAC7B,yCAA4C;AAC5C,oBAA6B;AAE7B,8BAAiC;AACjC,6BAGO;AAeA,MAAM,eAAe,OAC1B,SACA,OAAO,GACP,QAAQ,QAER,MAAM,4BAAa,KAAK,OAAO,EAAE,KAAK,IAAI,EAAE,MAAM,KAAK;AAOlD,MAAM,iBAAiB,OAC5B,cAC6B;AAC7B,QAAM,UAAU,MAAM,4BAAa,SAAS,SAAS;AAErD,MAAI,CAAC,SAAS;AACZ,UAAM,IAAI,2BAAa,uBAAuB,EAAE,UAAU,CAAC;AAAA,EAC7D;AAEA,SAAO;AACT;AAOO,MAAM,gBAAgB,OAC3B,YACoB;AACpB,QAAM,SAAS,MAAM,4BAAa,eAAe,OAAO;AAExD,MAAI,OAAO,WAAW,aAAa;AACjC,UAAM,IAAI,2BAAa,wBAAwB,EAAE,QAAQ,CAAC;AAAA,EAC5D;AAEA,SAAO;AACT;AAOO,MAAM,gBAAgB,OAC3B,YAC6B;AAC7B,MAAK,QAA6B,cAAc;AAC9C,WAAQ,QAA6B;AAAA,EACvC;AAEA,QAAM,SAAS,UAAM,wCAAgB,SAAS,CAAC,MAAM,CAAC;AAEtD,MAAI,OAAO,KAAK,MAAM,EAAE,SAAS,GAAG;AAClC,UAAM,IAAI,2BAAa,0BAA0B,EAAE,OAAO,CAAC;AAAA,EAC7D;AAEA,SAAO,MAAM,4BAAa,OAAO,OAAO;AAC1C;AAQO,MAAM,oBAAoB,OAC/B,WACA,YAC6B;AAC7B,QAAM,oBAAgB,gEAA4B,OAAO;AACzD,QAAM,sBAAkB,0CAAiB,eAAe;AAAA,IACtD;AAAA,IACA;AAAA,IACA;AAAA,EACF,CAAC;AAED,QAAM,cAAc,OAAO,KAAK,eAAe;AAE/C,QAAM,aAAS,wCAAgB,SAAS,WAAW;AAEnD,MAAI,OAAO,KAAK,MAAM,EAAE,SAAS,GAAG;AAClC,UAAM,IAAI,2BAAa,0BAA0B;AAAA,MAC/C;AAAA,MACA;AAAA,IACF,CAAC;AAAA,EACH;AAEA,UAAQ,IAAI,mBAAmB,eAAe;AAE9C,QAAM,SAAS,MAAM,4BAAa;AAAA,IAChC,EAAE,KAAK,UAAU;AAAA,IACjB;AAAA,EACF;AAEA,MAAI,OAAO,iBAAiB,GAAG;AAC7B,UAAM,IAAI,2BAAa,yBAAyB,EAAE,UAAU,CAAC;AAAA,EAC/D;AAEA,SAAO,MAAM,eAAe,SAAS;AACvC;AAOO,MAAM,oBAAoB,OAC/B,cAC6B;AAC7B,QAAM,UAAU,MAAM,4BAAa,kBAAkB,SAAS;AAE9D,MAAI,CAAC,SAAS;AACZ,UAAM,IAAI,2BAAa,uBAAuB,EAAE,UAAU,CAAC;AAAA,EAC7D;AAEA,SAAO;AACT;","names":[]}

package/dist/cjs/services/tag.service.cjs

@@ -0,0 +1,91 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var tag_service_exports = {};
+__export(tag_service_exports, {
+  countTags: () => countTags,
+  createTag: () => createTag,
+  deleteTagById: () => deleteTagById,
+  findTags: () => findTags,
+  getTagById: () => getTagById,
+  getTagsByKeys: () => getTagsByKeys,
+  updateTagById: () => updateTagById
+});
+module.exports = __toCommonJS(tag_service_exports);
+var import_tag = require('./../models/tag.model.cjs');
+var import_errors = require('./../utils/errors/index.cjs');
+var import_validateTag = require('./../utils/validation/validateTag.cjs');
+const findTags = async (filters, skip = 0, limit = 100) => await import_tag.TagModel.find(filters).skip(skip).limit(limit);
+const getTagById = async (tagId) => {
+  const tag = await import_tag.TagModel.findById(tagId);
+  if (!tag) {
+    throw new import_errors.GenericError("TAG_NOT_FOUND", { tagId });
+  }
+  return tag;
+};
+const getTagsByKeys = async (keys, organizationId) => {
+  const tags = await import_tag.TagModel.find({ key: { $in: keys }, organizationId });
+  return tags;
+};
+const countTags = async (filters) => {
+  const result = await import_tag.TagModel.countDocuments(filters);
+  if (typeof result === "undefined") {
+    throw new import_errors.GenericError("TAG_COUNT_FAILED", { filters });
+  }
+  return result;
+};
+const createTag = async (tag) => {
+  const errors = await (0, import_validateTag.validateTag)(tag, ["key"]);
+  if (Object.keys(errors).length > 0) {
+    throw new import_errors.GenericError("TAG_INVALID_FIELDS", { errors });
+  }
+  return await import_tag.TagModel.create(tag);
+};
+const updateTagById = async (tagId, tag) => {
+  const updatedKeys = Object.keys(tag);
+  const errors = (0, import_validateTag.validateTag)(tag, updatedKeys);
+  if (Object.keys(errors).length > 0) {
+    throw new import_errors.GenericError("TAG_INVALID_FIELDS", {
+      tagId,
+      errors
+    });
+  }
+  const result = await import_tag.TagModel.updateOne({ _id: tagId }, tag);
+  if (result.matchedCount === 0) {
+    throw new import_errors.GenericError("TAG_UPDATE_FAILED", { tagId });
+  }
+  return await getTagById(tagId);
+};
+const deleteTagById = async (tagId) => {
+  const tag = await import_tag.TagModel.findByIdAndDelete(tagId);
+  if (!tag) {
+    throw new import_errors.GenericError("TAG_NOT_FOUND", { tagId });
+  }
+  return tag;
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  countTags,
+  createTag,
+  deleteTagById,
+  findTags,
+  getTagById,
+  getTagsByKeys,
+  updateTagById
+});
+//# sourceMappingURL=tag.service.cjs.map

package/dist/cjs/services/tag.service.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/services/tag.service.ts"],"sourcesContent":["import { TagModel } from '@models/tag.model';\nimport { GenericError } from '@utils/errors';\nimport type { TagFilters } from '@utils/filtersAndPagination/getTagFiltersAndPagination';\nimport { type TagFields, validateTag } from '@utils/validation/validateTag';\nimport type { ObjectId } from 'mongoose';\nimport { Organization } from '@/export';\nimport type { Tag, TagData, TagDocument } from '@/types/tag.types';\n\n/**\n * Finds tags based on filters and pagination options.\n * @param filters - MongoDB filter query.\n * @param skip - Number of documents to skip.\n * @param limit - Number of documents to limit.\n * @returns List of tags matching the filters.\n */\nexport const findTags = async (\n  filters: TagFilters,\n  skip = 0,\n  limit = 100\n): Promise<TagDocument[]> =>\n  await TagModel.find(filters).skip(skip).limit(limit);\n\n/**\n * Finds a tag by its ID.\n * @param tagId - The ID of the tag to find.\n * @returns The tag matching the ID.\n */\nexport const getTagById = async (\n  tagId: string | ObjectId\n): Promise<TagDocument> => {\n  const tag = await TagModel.findById(tagId);\n\n  if (!tag) {\n    throw new GenericError('TAG_NOT_FOUND', { tagId });\n  }\n\n  return tag;\n};\n\nexport const getTagsByKeys = async (\n  keys: string[],\n  organizationId: string | Organization['_id']\n): Promise<TagDocument[]> => {\n  const tags = await TagModel.find({ key: { $in: keys }, organizationId });\n\n  return tags;\n};\n\n/**\n * Counts the total number of tags that match the filters.\n * @param filters - MongoDB filter query.\n * @returns Total number of tags.\n */\nexport const countTags = async (filters: TagFilters): Promise<number> => {\n  const result = await TagModel.countDocuments(filters);\n\n  if (typeof result === 'undefined') {\n    throw new GenericError('TAG_COUNT_FAILED', { filters });\n  }\n\n  return result;\n};\n\n/**\n * Creates a new tag in the database.\n * @param  tag - The tag data to create.\n * @returns The created tag.\n */\nexport const createTag = async (tag: TagData): Promise<TagDocument> => {\n  const errors = await validateTag(tag, ['key']);\n\n  if (Object.keys(errors).length > 0) {\n    throw new GenericError('TAG_INVALID_FIELDS', { errors });\n  }\n\n  return await TagModel.create(tag);\n};\n\n/**\n * Updates an existing tag in the database by its ID.\n * @param tagId - The ID of the tag to update.\n * @param tag - The updated tag data.\n * @returns The updated tag.\n */\nexport const updateTagById = async (\n  tagId: string | ObjectId,\n  tag: Partial<Tag>\n): Promise<TagDocument> => {\n  const updatedKeys = Object.keys(tag) as TagFields;\n\n  const errors = validateTag(tag, updatedKeys);\n\n  if (Object.keys(errors).length > 0) {\n    throw new GenericError('TAG_INVALID_FIELDS', {\n      tagId,\n      errors,\n    });\n  }\n\n  const result = await TagModel.updateOne({ _id: tagId }, tag);\n\n  if (result.matchedCount === 0) {\n    throw new GenericError('TAG_UPDATE_FAILED', { tagId });\n  }\n\n  return await getTagById(tagId);\n};\n\n/**\n * Deletes a tag from the database by its ID.\n * @param tagId - The ID of the tag to delete.\n * @returns The result of the deletion operation.\n */\nexport const deleteTagById = async (\n  tagId: string | ObjectId\n): Promise<TagDocument> => {\n  const tag = await TagModel.findByIdAndDelete(tagId);\n\n  if (!tag) {\n    throw new GenericError('TAG_NOT_FOUND', { tagId });\n  }\n\n  return tag;\n};\n"],"mappings":";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,iBAAyB;AACzB,oBAA6B;AAE7B,yBAA4C;AAYrC,MAAM,WAAW,OACtB,SACA,OAAO,GACP,QAAQ,QAER,MAAM,oBAAS,KAAK,OAAO,EAAE,KAAK,IAAI,EAAE,MAAM,KAAK;AAO9C,MAAM,aAAa,OACxB,UACyB;AACzB,QAAM,MAAM,MAAM,oBAAS,SAAS,KAAK;AAEzC,MAAI,CAAC,KAAK;AACR,UAAM,IAAI,2BAAa,iBAAiB,EAAE,MAAM,CAAC;AAAA,EACnD;AAEA,SAAO;AACT;AAEO,MAAM,gBAAgB,OAC3B,MACA,mBAC2B;AAC3B,QAAM,OAAO,MAAM,oBAAS,KAAK,EAAE,KAAK,EAAE,KAAK,KAAK,GAAG,eAAe,CAAC;AAEvE,SAAO;AACT;AAOO,MAAM,YAAY,OAAO,YAAyC;AACvE,QAAM,SAAS,MAAM,oBAAS,eAAe,OAAO;AAEpD,MAAI,OAAO,WAAW,aAAa;AACjC,UAAM,IAAI,2BAAa,oBAAoB,EAAE,QAAQ,CAAC;AAAA,EACxD;AAEA,SAAO;AACT;AAOO,MAAM,YAAY,OAAO,QAAuC;AACrE,QAAM,SAAS,UAAM,gCAAY,KAAK,CAAC,KAAK,CAAC;AAE7C,MAAI,OAAO,KAAK,MAAM,EAAE,SAAS,GAAG;AAClC,UAAM,IAAI,2BAAa,sBAAsB,EAAE,OAAO,CAAC;AAAA,EACzD;AAEA,SAAO,MAAM,oBAAS,OAAO,GAAG;AAClC;AAQO,MAAM,gBAAgB,OAC3B,OACA,QACyB;AACzB,QAAM,cAAc,OAAO,KAAK,GAAG;AAEnC,QAAM,aAAS,gCAAY,KAAK,WAAW;AAE3C,MAAI,OAAO,KAAK,MAAM,EAAE,SAAS,GAAG;AAClC,UAAM,IAAI,2BAAa,sBAAsB;AAAA,MAC3C;AAAA,MACA;AAAA,IACF,CAAC;AAAA,EACH;AAEA,QAAM,SAAS,MAAM,oBAAS,UAAU,EAAE,KAAK,MAAM,GAAG,GAAG;AAE3D,MAAI,OAAO,iBAAiB,GAAG;AAC7B,UAAM,IAAI,2BAAa,qBAAqB,EAAE,MAAM,CAAC;AAAA,EACvD;AAEA,SAAO,MAAM,WAAW,KAAK;AAC/B;AAOO,MAAM,gBAAgB,OAC3B,UACyB;AACzB,QAAM,MAAM,MAAM,oBAAS,kBAAkB,KAAK;AAElD,MAAI,CAAC,KAAK;AACR,UAAM,IAAI,2BAAa,iBAAiB,EAAE,MAAM,CAAC;AAAA,EACnD;AAEA,SAAO;AACT;","names":[]}

package/dist/cjs/types/dictionary.types.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/types/dictionary.types.ts"],"sourcesContent":["import type { DictionaryValue } from '@intlayer/core';\nimport type { Model, ObjectId, Document } from 'mongoose';\nimport type { Project } from './project.types';\nimport type { User } from './user.types';\n\nexport type DictionaryCreationData = {\n  projectIds: (Project['_id'] | string)[];\n  key: string;\n  content?: DictionaryValue;\n  title?: string;\n  description?: string;\n  version?: number;\n  filePath?: string;\n};\n\nexport type DictionaryData = {\n  projectIds: (Project['_id'] | string)[];\n  key: string;\n  content: DictionaryValue[];\n  creatorId: User['_id'];\n  title?: string;\n  description?: string;\n  version?: number;\n  filePath?: Record<string, string>;\n};\n\nexport type Dictionary = DictionaryData & {\n  _id: ObjectId;\n  createdAt: number;\n  updatedAt: number;\n};\n\nexport type DictionaryAPI = Omit<Dictionary, 'filePath' | 'content'> & {\n  content: DictionaryValue;\n  filePath?: string;\n};\n\nexport type DictionaryDocument = Document<unknown, {}, Dictionary> & Dictionary;\nexport type DictionaryModelType = Model<Dictionary>;\n"],"mappings":";;;;;;;;;;;;;;AAAA;AAAA;","names":[]}
+{"version":3,"sources":["../../../src/types/dictionary.types.ts"],"sourcesContent":["import type { DictionaryValue } from '@intlayer/core';\nimport type { Model, ObjectId, Document } from 'mongoose';\nimport type { Project } from './project.types';\nimport type { User } from './user.types';\n\nexport type DictionaryCreationData = {\n  projectIds: (Project['_id'] | string)[];\n  key: string;\n  content?: DictionaryValue;\n  title?: string;\n  description?: string;\n  tags?: string[];\n  filePath?: string;\n};\n\nexport type VersionedContentEl = {\n  name?: string;\n  description?: string;\n  content: DictionaryValue;\n};\n\nexport type ContentVersion = string;\nexport type VersionedContent = Record<string, VersionedContentEl>;\n\nexport type DictionaryData = {\n  key: string;\n  content: VersionedContent;\n  projectIds: (Project['_id'] | string)[];\n  creatorId: User['_id'];\n  title?: string;\n  description?: string;\n  tags?: string[];\n  filePath?: Record<string, string>;\n  publishedVersion?: string | null;\n};\n\nexport type Dictionary = DictionaryData & {\n  _id: ObjectId;\n  createdAt: number;\n  updatedAt: number;\n  availableVersions?: string[];\n};\n\nexport type DictionaryAPI = Omit<Dictionary, 'filePath' | 'content'> & {\n  content: DictionaryValue;\n  filePath?: string;\n  availableVersions?: string[];\n};\n\nexport type DictionaryDocument = Document<unknown, {}, Dictionary> & Dictionary;\nexport type DictionaryModelType = Model<Dictionary>;\n"],"mappings":";;;;;;;;;;;;;;AAAA;AAAA;","names":[]}

package/dist/cjs/types/tag.types.cjs

@@ -0,0 +1,17 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var tag_types_exports = {};
+module.exports = __toCommonJS(tag_types_exports);
+//# sourceMappingURL=tag.types.cjs.map

package/dist/cjs/types/tag.types.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/types/tag.types.ts"],"sourcesContent":["import type { ObjectId, Document, Model } from 'mongoose';\nimport { Organization } from './organization.types';\nimport { User } from './user.types';\n\nexport type TagCreationData = {\n  key: string;\n  name?: string;\n  description?: string;\n  instructions?: string;\n};\n\nexport type TagData = {\n  key: string;\n  name?: string;\n  description?: string;\n  instructions?: string;\n  creatorId: User['_id'];\n  organizationId: Organization['_id'];\n};\n\nexport type Tag = TagData & {\n  _id: ObjectId;\n  createdAt: number;\n  updatedAt: number;\n};\n\nexport type TagAPI = Tag;\n\nexport type TagDocument = Document<unknown, {}, Tag> & Tag;\n\nexport type TagModelType = Model<Tag>;\n"],"mappings":";;;;;;;;;;;;;;AAAA;AAAA;","names":[]}

package/dist/cjs/utils/{audit → auditDictionary}/PROMPT.md

@@ -1,4 +1,4 @@
-You are an expert in internationalization and content management. Your task is to audit the content declaration files in the project and identify any potential issues or inconsistencies. Provide a detailed report of any issues found, including the file path, line number, and a brief explanation of the issue.
+You are an expert in internationalization, copy writing and content management. Your task is to audit the content declaration files in the project and identify any potential issues or inconsistencies. Provide a detailed report of any issues found, including the file path, line number, and a brief explanation of the issue.
 
 **Instructions:**
 
@@ -33,6 +33,7 @@ You are an expert in internationalization and content management. Your task is t
    - **Manage Localizations:** If the required languages contains similar languages, as `en` and `en-GB`, consider `en` as English US and `en-GB` as English UK, and insert or review both translations to maintain clarity and correctness.
    - **Order Translations:** If the translations are not in the same order as the required languages list, consider reordering the translations to maintain clarity and correctness.
    - **Escape Special Characters:** If the translations contain special characters, escape them using the appropriate escape sequence.
+   - **Respect the tags instructions:** If the tags instructions are provided, ensure that the audited file adheres to them.
 
 6. **Example Scenario:**
 
@@ -137,6 +138,10 @@ You are an expert in internationalization and content management. Your task is t
        - The import of the `t` function was imported from `react-intlayer` instead of `intlayer`.
        - A type `DeclarationContent` was added to the file to strengthen the content declaration.
 
+**Tags Instructions:**
+
+{{tagsInstructions}}
+
 **File to Audit:**
 
 {{fileContent}}

package/dist/cjs/utils/{audit → auditDictionary}/index.cjs

@@ -16,11 +16,11 @@ var __copyProps = (to, from, except, desc) => {
   return to;
 };
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-var audit_exports = {};
-__export(audit_exports, {
-  auditFile: () => auditFile
+var auditDictionary_exports = {};
+__export(auditDictionary_exports, {
+  auditDictionary: () => auditDictionary
 });
-module.exports = __toCommonJS(audit_exports);
+module.exports = __toCommonJS(auditDictionary_exports);
 var import_fs = require("fs");
 var import_path = require("path");
 var import_url = require("url");
@@ -48,14 +48,16 @@ const formatLocaleWithName = (locale) => {
   const localeName = (0, import_core.getLocaleName)(locale);
   return `${locale}: ${localeName}`;
 };
-const auditFile = async ({
+const formatTagInstructions = (tags = []) => tags.map((tag) => `- ${tag.key}: ${tag.instructions}`).join("\n\n");
+const auditDictionary = async ({
   fileContent,
   filePath,
   model,
   openAiApiKey,
   customPrompt,
   locales,
-  defaultLocale
+  defaultLocale,
+  tags
 }) => {
   try {
     const openai = new import_openai.OpenAI({
@@ -72,7 +74,7 @@ const auditFile = async ({
     ).replace(
       "{{declarationsContentTemplate}}",
       FILE_TEMPLATE[fileExtension]
-    ).replace("{{fileContent}}", fileContent);
+    ).replace("{{fileContent}}", fileContent).replace("{{tagsInstructions}}", formatTagInstructions(tags));
     const chatCompletion = await openai.chat.completions.create({
       model: model ?? "gpt-4o-mini",
       messages: [{ role: "system", content: prompt }]
@@ -91,6 +93,6 @@ const auditFile = async ({
 };
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  auditFile
+  auditDictionary
 });
 //# sourceMappingURL=index.cjs.map

package/dist/cjs/utils/auditDictionary/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../src/utils/auditDictionary/index.ts"],"sourcesContent":["import { readFileSync } from 'fs';\nimport { dirname, join } from 'path';\nimport { fileURLToPath } from 'url';\nimport { getLocaleName } from '@intlayer/core';\nimport { logger } from '@logger';\nimport { Locales } from 'intlayer';\nimport { OpenAI } from 'openai';\nimport { Tag } from '@/types/tag.types';\n\nconst __dirname = dirname(fileURLToPath(import.meta.url));\n\nexport type AuditOptions = {\n  locales: Locales[];\n  defaultLocale: Locales;\n  fileContent: string;\n  filePath?: string;\n  model?: string;\n  openAiApiKey: string;\n  customPrompt?: string;\n  tags?: Tag[];\n};\nexport type AuditFileResultData = { fileContent: string; tokenUsed: number };\n\n/**\n * Reads the content of a file synchronously.\n *\n * @function\n * @param relativeFilePath - The relative or absolute path to the target file.\n * @returns The entire contents of the specified file as a UTF-8 encoded string.\n */\nconst getFileContent = (relativeFilePath: string): string => {\n  const absolutePath = join(__dirname, relativeFilePath);\n  const fileContent = readFileSync(absolutePath, 'utf-8');\n  return fileContent;\n};\n\nconst FILE_TEMPLATE: Record<string, string> = {\n  ts: getFileContent('./TS_FORMAT.md'),\n  tsx: getFileContent('./TSX_FORMAT.md'),\n  js: getFileContent('./MJS_FORMAT.md'),\n  mjs: getFileContent('./MJS_FORMAT.md'),\n  cjs: getFileContent('./CJS_FORMAT.md'),\n  jsx: getFileContent('./JSX_FORMAT.md'),\n  json: getFileContent('./JSON_FORMAT.md'),\n};\n\n// The prompt template to send to ChatGPT, requesting an audit of content declaration files.\nconst CHAT_GPT_PROMPT = getFileContent('./PROMPT.md');\n\n/**\n * Formats a locale with its full name and returns a string representation.\n *\n * @function\n * @param locale - A locale from the project's configuration (e.g., 'en-US', 'fr-FR').\n * @returns A formatted string combining the locale's name and code. Example: \"English (US): en-US\".\n */\nconst formatLocaleWithName = (locale: Locales): string => {\n  // getLocaleName returns a human-readable name for the locale.\n  const localeName = getLocaleName(locale);\n\n  // Concatenate both the readable name and the locale code.\n  return `${locale}: ${localeName}`;\n};\n\n/**\n * Formats an array of tags with their keys and instructions.\n *\n * @function\n * @param tags - An array of tags from the project's configuration.\n * @returns A string representation of the tags, with their keys and instructions.\n */\nconst formatTagInstructions = (tags: Tag[] = []) =>\n  tags.map((tag) => `- ${tag.key}: ${tag.instructions}`).join('\\n\\n');\n\n/**\n * Audits a content declaration file by constructing a prompt for ChatGPT.\n * The prompt includes details about the project's locales, file paths of content declarations,\n * and requests for identifying issues or inconsistencies. It prints the prompt for each file,\n * and could be adapted to send requests to the ChatGPT model.\n */\nexport const auditDictionary = async ({\n  fileContent,\n  filePath,\n  model,\n  openAiApiKey,\n  customPrompt,\n  locales,\n  defaultLocale,\n  tags,\n}: AuditOptions): Promise<AuditFileResultData | undefined> => {\n  try {\n    // Optionally, you could initialize and configure the OpenAI client here, if you intend to make API calls.\n    // Uncomment and configure the following lines if you have `openai` installed and want to call the API:\n\n    const openai = new OpenAI({\n      apiKey: openAiApiKey,\n    });\n\n    // Read the file's content.\n    const splitted = (filePath ?? '.json').split('.');\n    const fileExtension = splitted[splitted.length - 1];\n\n    // Prepare the prompt for ChatGPT by replacing placeholders with actual values.\n    const prompt =\n      customPrompt ??\n      CHAT_GPT_PROMPT.replace('{{filePath}}', filePath ?? 'Not provided')\n        .replace(\n          '{{defaultLocale}}',\n          `{${formatLocaleWithName(defaultLocale)}}`\n        )\n        .replace(\n          '{{otherLocales}}',\n          `{${locales.map(formatLocaleWithName).join(', ')}}`\n        )\n        .replace(\n          '{{declarationsContentTemplate}}',\n          FILE_TEMPLATE[fileExtension]\n        )\n        .replace('{{fileContent}}', fileContent)\n        .replace('{{tagsInstructions}}', formatTagInstructions(tags));\n\n    // Example of how you might request a completion from ChatGPT:\n    const chatCompletion = await openai.chat.completions.create({\n      model: model ?? 'gpt-4o-mini',\n      messages: [{ role: 'system', content: prompt }],\n    });\n\n    const newContent = chatCompletion.choices[0].message?.content;\n\n    logger.info(\n      `${chatCompletion.usage?.total_tokens} tokens used in the request`\n    );\n\n    return {\n      fileContent: newContent ?? '',\n      tokenUsed: chatCompletion.usage?.total_tokens ?? 0,\n    };\n  } catch (error) {\n    console.error(error);\n  }\n};\n"],"mappings":";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,gBAA6B;AAC7B,kBAA8B;AAC9B,iBAA8B;AAC9B,kBAA8B;AAC9B,oBAAuB;AAEvB,oBAAuB;AANvB;AASA,MAAM,gBAAY,yBAAQ,0BAAc,YAAY,GAAG,CAAC;AAqBxD,MAAM,iBAAiB,CAAC,qBAAqC;AAC3D,QAAM,mBAAe,kBAAK,WAAW,gBAAgB;AACrD,QAAM,kBAAc,wBAAa,cAAc,OAAO;AACtD,SAAO;AACT;AAEA,MAAM,gBAAwC;AAAA,EAC5C,IAAI,eAAe,gBAAgB;AAAA,EACnC,KAAK,eAAe,iBAAiB;AAAA,EACrC,IAAI,eAAe,iBAAiB;AAAA,EACpC,KAAK,eAAe,iBAAiB;AAAA,EACrC,KAAK,eAAe,iBAAiB;AAAA,EACrC,KAAK,eAAe,iBAAiB;AAAA,EACrC,MAAM,eAAe,kBAAkB;AACzC;AAGA,MAAM,kBAAkB,eAAe,aAAa;AASpD,MAAM,uBAAuB,CAAC,WAA4B;AAExD,QAAM,iBAAa,2BAAc,MAAM;AAGvC,SAAO,GAAG,MAAM,KAAK,UAAU;AACjC;AASA,MAAM,wBAAwB,CAAC,OAAc,CAAC,MAC5C,KAAK,IAAI,CAAC,QAAQ,KAAK,IAAI,GAAG,KAAK,IAAI,YAAY,EAAE,EAAE,KAAK,MAAM;AAQ7D,MAAM,kBAAkB,OAAO;AAAA,EACpC;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF,MAA8D;AAC5D,MAAI;AAIF,UAAM,SAAS,IAAI,qBAAO;AAAA,MACxB,QAAQ;AAAA,IACV,CAAC;AAGD,UAAM,YAAY,YAAY,SAAS,MAAM,GAAG;AAChD,UAAM,gBAAgB,SAAS,SAAS,SAAS,CAAC;AAGlD,UAAM,SACJ,gBACA,gBAAgB,QAAQ,gBAAgB,YAAY,cAAc,EAC/D;AAAA,MACC;AAAA,MACA,IAAI,qBAAqB,aAAa,CAAC;AAAA,IACzC,EACC;AAAA,MACC;AAAA,MACA,IAAI,QAAQ,IAAI,oBAAoB,EAAE,KAAK,IAAI,CAAC;AAAA,IAClD,EACC;AAAA,MACC;AAAA,MACA,cAAc,aAAa;AAAA,IAC7B,EACC,QAAQ,mBAAmB,WAAW,EACtC,QAAQ,wBAAwB,sBAAsB,IAAI,CAAC;AAGhE,UAAM,iBAAiB,MAAM,OAAO,KAAK,YAAY,OAAO;AAAA,MAC1D,OAAO,SAAS;AAAA,MAChB,UAAU,CAAC,EAAE,MAAM,UAAU,SAAS,OAAO,CAAC;AAAA,IAChD,CAAC;AAED,UAAM,aAAa,eAAe,QAAQ,CAAC,EAAE,SAAS;AAEtD,yBAAO;AAAA,MACL,GAAG,eAAe,OAAO,YAAY;AAAA,IACvC;AAEA,WAAO;AAAA,MACL,aAAa,cAAc;AAAA,MAC3B,WAAW,eAAe,OAAO,gBAAgB;AAAA,IACnD;AAAA,EACF,SAAS,OAAO;AACd,YAAQ,MAAM,KAAK;AAAA,EACrB;AACF;","names":[]}

package/dist/cjs/utils/auditDictionaryField/PROMPT.md

@@ -0,0 +1,115 @@
+You are an expert in internationalization, copy writing and content management. Your task is to audit the given element into the content declaration file. If the element is not declared, review it. If this element is missing, write it by considering the given context of the content declaration, and by following instructions.
+
+**Instructions:**
+
+1. **Terminology:**
+
+- **Content Declaration:** A content declaration is a is a file (.ts, .js or .json) that contains the multilingual declaration related to a specific content. A content declaration file is usually related to a specific component, or page or section of a website.
+- **Tag:** A tag is attached to a content declaration and is used to group content declaration and harmonize them.
+- **KeyPath** The KeyPath correspond to to the path to retrieve the targeted element from the `content` key of the content declaration file.
+
+2.  **Locales:**
+
+    - Required Locales: {{otherLocales}}
+
+3.  **Audit Requirements:**
+
+    - **Consistency:** Ensure that all keys have translations for all specified locales.
+    - **Missing Content:** Identify any missing translations and specify the expected content.
+    - **Misplaced Content:** Detect if any translations are placed under incorrect keys.
+    - **Type Compliance:** Verify that the content types match the declarations (e.g., strings, string arrays).
+
+4.  **Modification Guidelines:**
+
+    - **Return Only the Targeted Content:** Provide the updated targeted content as plain text without any markdown, additional comments or explanations.
+    - **Consider the locale context:** If the targeted field correspond to a specific language, contains similar languages, as `zh` or `en-GB`, consider return the content in this specified language.
+    - **Escape Special Characters:** If the translations contain special characters, escape them using the appropriate escape sequence.
+    - **Respect the tags instructions:** If the tags instructions are provided, ensure that the audited file adheres to them.
+
+5.  **Example Scenario:**
+
+    - **Example 1:**
+
+      - **Input File:**
+
+      ```typescript
+      import { t, type DeclarationContent } from "intlayer";
+
+      export default {
+        key: "creative-work-structured-data",
+        content: {
+          audienceType: t({
+            en: "Developers, Content Managers",
+            fr: "Développeurs, Responsables de contenu",
+            es: "",
+          }),
+        },
+      } satisfies DeclarationContent;
+      ```
+
+      - **Input keyPath:**
+
+        `[{type: "object", key: "audienceType"},{type: "translation", key: "es"}]`
+
+      - **Expected Output:**
+
+        Desarrolladores, Gestores de Contenido
+
+    - **Example 2:**
+
+      - **Input File:**
+
+      ```typescript
+      import { t, enu, type DeclarationContent } from "intlayer";
+
+      const content = {
+        key: "creative-work-structured-data",
+        content: {
+          en: {
+            audienceType: t({
+              en: "Developers, Content Managers",
+              fr: "Développeurs, Responsables de contenu",
+              es: "Desarrolladores, Gestores de Contenido",
+            }),
+          },
+          audienceType: {
+            object1: enu({
+              "1": t({
+                en: "Developers, Content Managers",
+                es: "Desarrolladores, Gestores de Contenido",
+                fr: "Développeurs, Responsables de contenu",
+              }),
+              ">2": t({
+                en: "Developers, Content Managers",
+                es: "Desarrolladores, Gestores de Contenido",
+                fr: "Here content thst make no sense and should be replaced",
+              }),
+            }),
+          },
+        },
+      } satisfies DeclarationContent;
+      ```
+
+      - **Input target:**
+
+      `[{type: "object", key: "audienceType"},{type: "enumeration", key: ">2"},{type: "object", key: "audienceType"},{type: "translation", key: "es"}]`
+
+      - **Expected Output:**
+
+      Développeurs, Responsables de contenu
+
+**Tags Instructions:**
+
+{{tagsInstructions}}
+
+**File to Audit:**
+
+{{fileContent}}
+
+**KeyPath:**
+
+{{keyPath}}
+
+**Expected Response:**
+
+After auditing, provide only the targeted content as plain text without any Markdown or code block formatting. If no changes are needed, return the targeted content

package/dist/cjs/utils/auditDictionaryField/index.cjs

@@ -0,0 +1,81 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var auditDictionaryField_exports = {};
+__export(auditDictionaryField_exports, {
+  auditDictionaryField: () => auditDictionaryField
+});
+module.exports = __toCommonJS(auditDictionaryField_exports);
+var import_fs = require("fs");
+var import_path = require("path");
+var import_url = require("url");
+var import_core = require("@intlayer/core");
+var import_logger = require('./../../logger/index.cjs');
+var import_openai = require("openai");
+const import_meta = {};
+const __dirname = (0, import_path.dirname)((0, import_url.fileURLToPath)(import_meta.url));
+const getFileContent = (relativeFilePath) => {
+  const absolutePath = (0, import_path.join)(__dirname, relativeFilePath);
+  const fileContent = (0, import_fs.readFileSync)(absolutePath, "utf-8");
+  return fileContent;
+};
+const CHAT_GPT_PROMPT = getFileContent("./PROMPT.md");
+const formatLocaleWithName = (locale) => {
+  const localeName = (0, import_core.getLocaleName)(locale);
+  return `${locale}: ${localeName}`;
+};
+const formatTagInstructions = (tags = []) => tags.map((tag) => `- ${tag.key}: ${tag.instructions}`).join("\n\n");
+const auditDictionaryField = async ({
+  fileContent,
+  model,
+  openAiApiKey,
+  customPrompt,
+  locales,
+  keyPath,
+  tags
+}) => {
+  try {
+    const openai = new import_openai.OpenAI({
+      apiKey: openAiApiKey
+    });
+    const prompt = customPrompt ?? CHAT_GPT_PROMPT.replace(
+      "{{otherLocales}}",
+      `{${locales.map(formatLocaleWithName).join(", ")}}`
+    ).replace("{{keyPath}}", JSON.stringify(keyPath)).replace("{{fileContent}}", fileContent).replace("{{tagsInstructions}}", formatTagInstructions(tags));
+    const chatCompletion = await openai.chat.completions.create({
+      model: model ?? "gpt-4o-mini",
+      messages: [{ role: "system", content: prompt }]
+    });
+    const newContent = chatCompletion.choices[0].message?.content;
+    import_logger.logger.info(
+      `${chatCompletion.usage?.total_tokens} tokens used in the request`
+    );
+    console.log("newContent", newContent);
+    return {
+      fileContent: newContent ?? "",
+      tokenUsed: chatCompletion.usage?.total_tokens ?? 0
+    };
+  } catch (error) {
+    console.error(error);
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  auditDictionaryField
+});
+//# sourceMappingURL=index.cjs.map

package/dist/cjs/utils/auditDictionaryField/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../src/utils/auditDictionaryField/index.ts"],"sourcesContent":["import { readFileSync } from 'fs';\nimport { dirname, join } from 'path';\nimport { fileURLToPath } from 'url';\nimport { getLocaleName, type KeyPath } from '@intlayer/core';\nimport { logger } from '@logger';\nimport { Locales } from 'intlayer';\nimport { OpenAI } from 'openai';\nimport { Tag } from '@/types/tag.types';\n\nconst __dirname = dirname(fileURLToPath(import.meta.url));\n\nexport type AuditDictionaryFieldOptions = {\n  locales: Locales[];\n  fileContent: string;\n  model?: string;\n  openAiApiKey: string;\n  customPrompt?: string;\n  keyPath: KeyPath[];\n  tags?: Tag[];\n};\nexport type AuditDictionaryFieldResultData = {\n  fileContent: string;\n  tokenUsed: number;\n};\n\n/**\n * Reads the content of a file synchronously.\n *\n * @function\n * @param relativeFilePath - The relative or absolute path to the target file.\n * @returns The entire contents of the specified file as a UTF-8 encoded string.\n */\nconst getFileContent = (relativeFilePath: string): string => {\n  const absolutePath = join(__dirname, relativeFilePath);\n  const fileContent = readFileSync(absolutePath, 'utf-8');\n  return fileContent;\n};\n\n// The prompt template to send to ChatGPT, requesting an audit of content declaration files.\nconst CHAT_GPT_PROMPT = getFileContent('./PROMPT.md');\n\n/**\n * Formats a locale with its full name and returns a string representation.\n *\n * @function\n * @param locale - A locale from the project's configuration (e.g., 'en-US', 'fr-FR').\n * @returns A formatted string combining the locale's name and code. Example: \"English (US): en-US\".\n */\nconst formatLocaleWithName = (locale: Locales): string => {\n  // getLocaleName returns a human-readable name for the locale.\n  const localeName = getLocaleName(locale);\n\n  // Concatenate both the readable name and the locale code.\n  return `${locale}: ${localeName}`;\n};\n\n/**\n * Formats an array of tags with their keys and instructions.\n *\n * @function\n * @param tags - An array of tags from the project's configuration.\n * @returns A string representation of the tags, with their keys and instructions.\n */\nconst formatTagInstructions = (tags: Tag[] = []) =>\n  tags.map((tag) => `- ${tag.key}: ${tag.instructions}`).join('\\n\\n');\n\n/**\n * Audits a content declaration file by constructing a prompt for ChatGPT.\n * The prompt includes details about the project's locales, file paths of content declarations,\n * and requests for identifying issues or inconsistencies. It prints the prompt for each file,\n * and could be adapted to send requests to the ChatGPT model.\n */\nexport const auditDictionaryField = async ({\n  fileContent,\n  model,\n  openAiApiKey,\n  customPrompt,\n  locales,\n  keyPath,\n  tags,\n}: AuditDictionaryFieldOptions): Promise<\n  AuditDictionaryFieldResultData | undefined\n> => {\n  try {\n    // Optionally, you could initialize and configure the OpenAI client here, if you intend to make API calls.\n    // Uncomment and configure the following lines if you have `openai` installed and want to call the API:\n\n    const openai = new OpenAI({\n      apiKey: openAiApiKey,\n    });\n\n    // Prepare the prompt for ChatGPT by replacing placeholders with actual values.\n    const prompt =\n      customPrompt ??\n      CHAT_GPT_PROMPT.replace(\n        '{{otherLocales}}',\n        `{${locales.map(formatLocaleWithName).join(', ')}}`\n      )\n        .replace('{{keyPath}}', JSON.stringify(keyPath))\n        .replace('{{fileContent}}', fileContent)\n        .replace('{{tagsInstructions}}', formatTagInstructions(tags));\n\n    // Example of how you might request a completion from ChatGPT:\n    const chatCompletion = await openai.chat.completions.create({\n      model: model ?? 'gpt-4o-mini',\n      messages: [{ role: 'system', content: prompt }],\n    });\n\n    const newContent = chatCompletion.choices[0].message?.content;\n\n    logger.info(\n      `${chatCompletion.usage?.total_tokens} tokens used in the request`\n    );\n\n    console.log('newContent', newContent);\n\n    return {\n      fileContent: newContent ?? '',\n      tokenUsed: chatCompletion.usage?.total_tokens ?? 0,\n    };\n  } catch (error) {\n    console.error(error);\n  }\n};\n"],"mappings":";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,gBAA6B;AAC7B,kBAA8B;AAC9B,iBAA8B;AAC9B,kBAA4C;AAC5C,oBAAuB;AAEvB,oBAAuB;AANvB;AASA,MAAM,gBAAY,yBAAQ,0BAAc,YAAY,GAAG,CAAC;AAuBxD,MAAM,iBAAiB,CAAC,qBAAqC;AAC3D,QAAM,mBAAe,kBAAK,WAAW,gBAAgB;AACrD,QAAM,kBAAc,wBAAa,cAAc,OAAO;AACtD,SAAO;AACT;AAGA,MAAM,kBAAkB,eAAe,aAAa;AASpD,MAAM,uBAAuB,CAAC,WAA4B;AAExD,QAAM,iBAAa,2BAAc,MAAM;AAGvC,SAAO,GAAG,MAAM,KAAK,UAAU;AACjC;AASA,MAAM,wBAAwB,CAAC,OAAc,CAAC,MAC5C,KAAK,IAAI,CAAC,QAAQ,KAAK,IAAI,GAAG,KAAK,IAAI,YAAY,EAAE,EAAE,KAAK,MAAM;AAQ7D,MAAM,uBAAuB,OAAO;AAAA,EACzC;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF,MAEK;AACH,MAAI;AAIF,UAAM,SAAS,IAAI,qBAAO;AAAA,MACxB,QAAQ;AAAA,IACV,CAAC;AAGD,UAAM,SACJ,gBACA,gBAAgB;AAAA,MACd;AAAA,MACA,IAAI,QAAQ,IAAI,oBAAoB,EAAE,KAAK,IAAI,CAAC;AAAA,IAClD,EACG,QAAQ,eAAe,KAAK,UAAU,OAAO,CAAC,EAC9C,QAAQ,mBAAmB,WAAW,EACtC,QAAQ,wBAAwB,sBAAsB,IAAI,CAAC;AAGhE,UAAM,iBAAiB,MAAM,OAAO,KAAK,YAAY,OAAO;AAAA,MAC1D,OAAO,SAAS;AAAA,MAChB,UAAU,CAAC,EAAE,MAAM,UAAU,SAAS,OAAO,CAAC;AAAA,IAChD,CAAC;AAED,UAAM,aAAa,eAAe,QAAQ,CAAC,EAAE,SAAS;AAEtD,yBAAO;AAAA,MACL,GAAG,eAAe,OAAO,YAAY;AAAA,IACvC;AAEA,YAAQ,IAAI,cAAc,UAAU;AAEpC,WAAO;AAAA,MACL,aAAa,cAAc;AAAA,MAC3B,WAAW,eAAe,OAAO,gBAAgB;AAAA,IACnD;AAAA,EACF,SAAS,OAAO;AACd,YAAQ,MAAM,KAAK;AAAA,EACrB;AACF;","names":[]}

package/dist/cjs/utils/auditDictionaryMetadata/PROMPT.md

@@ -0,0 +1,76 @@
+Your role is to review content declaration fields. Correct this fields if they are misspelled or do not match the expected content, and / or complete missing content.
+
+1. **Terminology:**
+
+- **Content Declaration:** A content declaration is a is a file (.ts, .js or .json) that contains the multilingual declaration related to a specific content. A content declaration file is usually related to a specific component, or page or section of a website.
+- **Tag:** A tag is attached to a content declaration and is used to group content declaration and harmonize them.
+
+2. **Audit Requirements:**
+
+   - **Do Not Alter Structure:** If the file structure is correct, do not modify it. Only add, update, or remove content declarations as necessary.
+   - **Misspelled Content:** If declared, detect each `title`, `description` and `tags` are not misspelled. If some content is misspelled, correct it.
+
+3. **Fields functions:**
+
+- **Title:** The title of the content declaration allows to easily identify it. It should be considered as a readable way to represent the `key` (example: `page-metadata` -> `Page metadata`). It should be a short and descriptive title that accurately reflects the dictionary.
+- **Description:** The description of the content declaration provides a brief summary of the content declaration. It should be a concise and informative description that explains the purpose and content of the dictionary.
+- **Tags:** The tags is an array of strings that represent the key of the tags associated with the content declaration.
+
+**Expected Response:**
+
+After completion, provide only the final title, description and tags fields in a JSON without any Markdown, code block formatting or any additional comments or explanations.
+
+**Example of expected response:**
+
+- Entry:
+
+```ts
+import { t, type DeclarationContent } from "intlayer";
+import { Metadata } from "next";
+
+const metadataContent = {
+  key: "pricing-metadata",
+  title: "",
+  description:
+    "here a description that doesn't make any sense and should be replaced",
+  content: {
+    title: t({
+      en: "Pricing | Intlayer",
+      fr: "Tarification | Intlayer",
+      es: "Precios | Intlayer",
+    }),
+    description: t({
+      en: "Discover our pricing plans and get access to premium features with Intlayer. Choose the plan that suits you best.",
+      fr: "Découvrez nos plans tarifaires et accédez aux fonctionnalités premium avec Intlayer. Choisissez le plan qui vous convient le mieux.",
+      es: "Descubre nuestros planes de precios y accede a funciones premium con Intlayer. Elige el plan que mejor te convenga.",
+    }),
+    keywords: t<string[]>({
+      en: ["Pricing", "Subscription"],
+      fr: ["Tarification", "Abonnement"],
+      es: ["Precios", "Suscripción"],
+    }),
+  },
+} satisfies DeclarationContent<Metadata>;
+
+export default metadataContent;
+```
+
+- Response:
+
+```json
+{
+  "title": "Pricing page metadata",
+  "description": "Metadata related to the pricing page, includes title, description, keywords, metadata for SEO purpose. It will help search engines understand the content of the page.",
+  "tags": ["page metadata", "pricing page"]
+}
+```
+
+**List of existing Tags:**
+
+Here the list of existing tags as a context to help you to pick related ones.
+
+{{tags}}
+
+**Content Declaration to complete:**
+
+{{contentDeclaration}}

package/dist/cjs/utils/auditDictionaryMetadata/index.cjs

@@ -0,0 +1,78 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var auditDictionaryMetadata_exports = {};
+__export(auditDictionaryMetadata_exports, {
+  auditDictionaryMetadata: () => auditDictionaryMetadata
+});
+module.exports = __toCommonJS(auditDictionaryMetadata_exports);
+var import_fs = require("fs");
+var import_path = require("path");
+var import_url = require("url");
+var import_logger = require('./../../logger/index.cjs');
+var import_openai = require("openai");
+const import_meta = {};
+const __dirname = (0, import_path.dirname)((0, import_url.fileURLToPath)(import_meta.url));
+const getFileContent = (relativeFilePath) => {
+  const absolutePath = (0, import_path.join)(__dirname, relativeFilePath);
+  const fileContent = (0, import_fs.readFileSync)(absolutePath, "utf-8");
+  return fileContent;
+};
+const CHAT_GPT_PROMPT = getFileContent("./PROMPT.md");
+const auditDictionaryMetadata = async ({
+  model,
+  openAiApiKey,
+  customPrompt,
+  tags,
+  fileContent
+}) => {
+  try {
+    const openai = new import_openai.OpenAI({
+      apiKey: openAiApiKey
+    });
+    const prompt = customPrompt ?? CHAT_GPT_PROMPT.replace(
+      "{{tags}}",
+      `${JSON.stringify(
+        tags.map(({ key, description }) => `- ${key}: ${description}`).join("\n\n"),
+        null,
+        2
+      )}`
+    ).replace("{{contentDeclaration}}", fileContent);
+    console.log("prompt", prompt);
+    const chatCompletion = await openai.chat.completions.create({
+      model: model ?? "gpt-4o-mini",
+      messages: [{ role: "system", content: prompt }]
+    });
+    const newContent = chatCompletion.choices[0].message?.content;
+    console.log("newContent", newContent);
+    import_logger.logger.info(
+      `${chatCompletion.usage?.total_tokens} tokens used in the request`
+    );
+    return {
+      fileContent: newContent ?? "",
+      tokenUsed: chatCompletion.usage?.total_tokens ?? 0
+    };
+  } catch (error) {
+    console.error(error);
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  auditDictionaryMetadata
+});
+//# sourceMappingURL=index.cjs.map

package/dist/cjs/utils/auditDictionaryMetadata/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../src/utils/auditDictionaryMetadata/index.ts"],"sourcesContent":["import { readFileSync } from 'fs';\nimport { dirname, join } from 'path';\nimport { fileURLToPath } from 'url';\nimport { logger } from '@logger';\nimport { OpenAI } from 'openai';\nimport { Tag } from '@/types/tag.types';\n\nconst __dirname = dirname(fileURLToPath(import.meta.url));\n\nexport type AuditOptions = {\n  tags: Tag[];\n  fileContent: string;\n  model?: string;\n  openAiApiKey: string;\n  customPrompt?: string;\n};\nexport type AuditFileResultData = { fileContent: string; tokenUsed: number };\n\n/**\n * Reads the content of a file synchronously.\n *\n * @function\n * @param relativeFilePath - The relative or absolute path to the target file.\n * @returns The entire contents of the specified file as a UTF-8 encoded string.\n */\nconst getFileContent = (relativeFilePath: string): string => {\n  const absolutePath = join(__dirname, relativeFilePath);\n  const fileContent = readFileSync(absolutePath, 'utf-8');\n  return fileContent;\n};\n\n// The prompt template to send to ChatGPT, requesting an audit of content declaration files.\nconst CHAT_GPT_PROMPT = getFileContent('./PROMPT.md');\n\n/**\n * Audits a content declaration file by constructing a prompt for ChatGPT.\n * The prompt includes details about the project's locales, file paths of content declarations,\n * and requests for identifying issues or inconsistencies. It prints the prompt for each file,\n * and could be adapted to send requests to the ChatGPT model.\n *\n */\nexport const auditDictionaryMetadata = async ({\n  model,\n  openAiApiKey,\n  customPrompt,\n  tags,\n  fileContent,\n}: AuditOptions): Promise<AuditFileResultData | undefined> => {\n  try {\n    // Optionally, you could initialize and configure the OpenAI client here, if you intend to make API calls.\n    // Uncomment and configure the following lines if you have `openai` installed and want to call the API:\n\n    const openai = new OpenAI({\n      apiKey: openAiApiKey,\n    });\n\n    // Prepare the prompt for ChatGPT by replacing placeholders with actual values.\n    const prompt =\n      customPrompt ??\n      CHAT_GPT_PROMPT.replace(\n        '{{tags}}',\n        `${JSON.stringify(\n          tags\n            .map(({ key, description }) => `- ${key}: ${description}`)\n            .join('\\n\\n'),\n          null,\n          2\n        )}`\n      ).replace('{{contentDeclaration}}', fileContent);\n\n    console.log('prompt', prompt);\n\n    // Example of how you might request a completion from ChatGPT:\n    const chatCompletion = await openai.chat.completions.create({\n      model: model ?? 'gpt-4o-mini',\n      messages: [{ role: 'system', content: prompt }],\n    });\n\n    const newContent = chatCompletion.choices[0].message?.content;\n\n    console.log('newContent', newContent);\n\n    logger.info(\n      `${chatCompletion.usage?.total_tokens} tokens used in the request`\n    );\n\n    return {\n      fileContent: newContent ?? '',\n      tokenUsed: chatCompletion.usage?.total_tokens ?? 0,\n    };\n  } catch (error) {\n    console.error(error);\n  }\n};\n"],"mappings":";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,gBAA6B;AAC7B,kBAA8B;AAC9B,iBAA8B;AAC9B,oBAAuB;AACvB,oBAAuB;AAJvB;AAOA,MAAM,gBAAY,yBAAQ,0BAAc,YAAY,GAAG,CAAC;AAkBxD,MAAM,iBAAiB,CAAC,qBAAqC;AAC3D,QAAM,mBAAe,kBAAK,WAAW,gBAAgB;AACrD,QAAM,kBAAc,wBAAa,cAAc,OAAO;AACtD,SAAO;AACT;AAGA,MAAM,kBAAkB,eAAe,aAAa;AAS7C,MAAM,0BAA0B,OAAO;AAAA,EAC5C;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF,MAA8D;AAC5D,MAAI;AAIF,UAAM,SAAS,IAAI,qBAAO;AAAA,MACxB,QAAQ;AAAA,IACV,CAAC;AAGD,UAAM,SACJ,gBACA,gBAAgB;AAAA,MACd;AAAA,MACA,GAAG,KAAK;AAAA,QACN,KACG,IAAI,CAAC,EAAE,KAAK,YAAY,MAAM,KAAK,GAAG,KAAK,WAAW,EAAE,EACxD,KAAK,MAAM;AAAA,QACd;AAAA,QACA;AAAA,MACF,CAAC;AAAA,IACH,EAAE,QAAQ,0BAA0B,WAAW;AAEjD,YAAQ,IAAI,UAAU,MAAM;AAG5B,UAAM,iBAAiB,MAAM,OAAO,KAAK,YAAY,OAAO;AAAA,MAC1D,OAAO,SAAS;AAAA,MAChB,UAAU,CAAC,EAAE,MAAM,UAAU,SAAS,OAAO,CAAC;AAAA,IAChD,CAAC;AAED,UAAM,aAAa,eAAe,QAAQ,CAAC,EAAE,SAAS;AAEtD,YAAQ,IAAI,cAAc,UAAU;AAEpC,yBAAO;AAAA,MACL,GAAG,eAAe,OAAO,YAAY;AAAA,IACvC;AAEA,WAAO;AAAA,MACL,aAAa,cAAc;AAAA,MAC3B,WAAW,eAAe,OAAO,gBAAgB;AAAA,IACnD;AAAA,EACF,SAAS,OAAO;AACd,YAAQ,MAAM,KAAK;AAAA,EACrB;AACF;","names":[]}