@oondemand/oon-core-back 0.3.32 → 0.3.34

package/README.md

@@ -20,3 +20,22 @@ Compatibilidade temporária: `CENTRAL_ATIVACAO_BACKEND_URL` e `MEUS_APPS_BACKEND
 `GET /ativacao/status` informa estado sem segredos. `POST /ativacao/validar-codigo` valida sem consumir. `POST /ativacao/concluir` revalida, chama `/ativar`, criptografa imediatamente o token da instância, executa hooks declarativos, chama `/concluir` e marca a instância como `ativa`. `POST /ativacao/tentar-novamente` retoma uma ativação já registrada sem exigir novo código.
 
 Campos adicionais podem ser declarados em `activation.fields`; `password` e `secret` são sanitizados na configuração retornada ao frontend. Hooks opcionais: `validate`, `beforeComplete`, `afterComplete`.
+
+## Rótulos de campos relacionados
+
+Por padrão, campos declarados com `fields.ref(...)` continuam sendo devolvidos pelo CRUD como `ObjectId`. Uma model pode optar pela população segura das referências usadas em grids e cards:
+
+```js
+defineModel({
+  name: "Pedido",
+  schema: {
+    clienteId: fields.ref("Cliente", { required: true, label: "Cliente" }),
+  },
+  crud: {
+    enabled: true,
+    populateRefs: ["clienteId"],
+  },
+});
+```
+
+Use `populateRefs: true` para todas as referências da model ou informe uma lista explícita. O CRUD devolve somente `_id` e campos usuais de identificação, como nome, razão social, descrição, código, e-mail e campos pesquisáveis da model referenciada. Exportações mantêm os identificadores originais.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oondemand/oon-core-back",
-  "version": "0.3.32",
+  "version": "0.3.34",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/oondemand/oon-platform.git",

package/src/core/factories/crudService.js

@@ -1,4 +1,71 @@
 const GenericError = require("../errors/GenericError");
+const registry = require("../registry");
+
+const COMMON_REFERENCE_LABEL_FIELDS = [
+  "nome",
+  "razaoSocial",
+  "razao_social",
+  "descricao",
+  "numero",
+  "codigoIndividual",
+  "codigo_individual",
+  "codigo",
+  "label",
+  "email",
+  "sigla",
+];
+
+/**
+ * Gera especificações de populate somente quando a model opta explicitamente
+ * por `crud.populateRefs`. O select é restrito a campos de identificação para
+ * evitar devolver o documento relacionado inteiro nas listagens genéricas.
+ */
+function referencePopulateSpecs(entry) {
+  const setting = entry.definition?.crud?.populateRefs;
+  if (!setting) return [];
+
+  const allowed = Array.isArray(setting) ? new Set(setting) : null;
+  const metaFields = Object.values(entry.metaFields || {});
+
+  return metaFields
+    .filter((field) =>
+      field?.kind === "ref" &&
+      field.ref &&
+      (!allowed || allowed.has(field.name))
+    )
+    .map((field) => {
+      const referencedEntry = registry.getModel(field.ref);
+      const select = [
+        "_id",
+        ...COMMON_REFERENCE_LABEL_FIELDS,
+        ...(referencedEntry?.searchableFields || []),
+      ];
+
+      return {
+        path: field.name,
+        select: [...new Set(select)].join(" "),
+      };
+    });
+}
+
+function populateQuery(query, specs) {
+  return specs.length ? query.populate(specs) : query;
+}
+
+/**
+ * Aceita tanto uma Query Mongoose quanto uma Promise/Document devolvida por
+ * uma model que sobrescreveu métodos como `findByIdAndUpdate`.
+ */
+async function resolvePopulated(result, specs) {
+  if (!specs.length) return result;
+  if (result && typeof result.populate === "function") {
+    return result.populate(specs);
+  }
+
+  const doc = await result;
+  if (doc && typeof doc.populate === "function") await doc.populate(specs);
+  return doc;
+}
 
 /**
  * Gera um service de CRUD genérico para uma model registrada.
@@ -6,6 +73,7 @@ const GenericError = require("../errors/GenericError");
  */
 function createCrudService(entry) {
   const { mongooseModel: Model, searchableFields } = entry;
+  const populateSpecs = referencePopulateSpecs(entry);
 
   async function listPaginated({ pageIndex = 0, pageSize = 20, searchTerm, sort, filtros = {} } = {}) {
     const page = Math.max(0, Number(pageIndex) || 0);
@@ -18,8 +86,12 @@ function createCrudService(entry) {
     }
 
     const sortSpec = parseSort(sort);
+    const listQuery = populateQuery(
+      Model.find(query).sort(sortSpec).skip(page * limit).limit(limit),
+      populateSpecs
+    );
     const [results, totalItems] = await Promise.all([
-      Model.find(query).sort(sortSpec).skip(page * limit).limit(limit).lean(),
+      listQuery.lean(),
       Model.countDocuments(query),
     ]);
 
@@ -35,20 +107,24 @@ function createCrudService(entry) {
   }
 
   async function getById(id) {
-    const doc = await Model.findById(id);
+    const doc = await resolvePopulated(Model.findById(id), populateSpecs);
     if (!doc) throw new GenericError("Registro não encontrado.", { statusCode: 404 });
     return doc;
   }
 
   async function create(data) {
-    return Model.create(data);
+    const doc = await Model.create(data);
+    return resolvePopulated(doc, populateSpecs);
   }
 
   async function update(id, data) {
-    const doc = await Model.findByIdAndUpdate(id, data, {
-      new: true,
-      runValidators: true,
-    });
+    const doc = await resolvePopulated(
+      Model.findByIdAndUpdate(id, data, {
+        new: true,
+        runValidators: true,
+      }),
+      populateSpecs
+    );
     if (!doc) throw new GenericError("Registro não encontrado.", { statusCode: 404 });
     return doc;
   }
@@ -93,4 +169,4 @@ function escapeRegex(str) {
   return String(str).replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
 }
 
-module.exports = { createCrudService };
+module.exports = { createCrudService, referencePopulateSpecs, resolvePopulated };