@grapadigital/shared-schemas 1.0.236 → 1.0.237

package/dist/schemas/log.schema.d.ts

@@ -25,16 +25,25 @@
 /// <reference types="mongoose/types/inferrawdoctype" />
 import { HydratedDocument, Schema as MongooseSchema, Types } from 'mongoose';
 export type LogDocument = HydratedDocument<Log>;
+export declare const LOG_REFERENCE_VALUES: readonly ["action", "recruitment", "content", "contract", "sale", "invoice", "payment", "assignment", "commission", "hub-access"];
+export type LogReference = (typeof LOG_REFERENCE_VALUES)[number];
+export declare const LOG_TYPE_VALUES: readonly ["created", "updated", "deleted", "email", "client-selected", "access-blocked"];
+export type LogType = (typeof LOG_TYPE_VALUES)[number];
 declare class UpdatedBy {
     team: string;
     name: string;
     email: string;
 }
+export declare class LogTarget {
+    /** uid da conta no Firebase do Hub (projeto hub-grapa). */
+    uid: string;
+    email: string;
+}
 export declare class Log {
     _id?: Types.ObjectId;
     referenceId: string;
-    reference: 'action' | 'recruitment' | 'content' | 'contract' | 'sale' | 'invoice' | 'payment' | 'assignment' | 'commission';
-    type: 'created' | 'updated' | 'deleted' | 'email';
+    reference: LogReference;
+    type: LogType;
     phase?: string;
     changes: Record<string, {
         before: any;
@@ -42,6 +51,10 @@ export declare class Log {
     }>;
     updatedAt: Date;
     updatedBy?: UpdatedBy;
+    /**
+     * Conta do Hub afetada pela ação. Vazio fora de `hub-access`. Ver GD-760.
+     */
+    target?: LogTarget | null;
 }
 export declare const LogSchema: MongooseSchema<Log, import("mongoose").Model<Log, any, any, any, import("mongoose").Document<unknown, any, Log, any, {}> & Log & Required<{
     _id: Types.ObjectId;

package/dist/schemas/log.schema.js

@@ -9,9 +9,30 @@ var __metadata = (this && this.__metadata) || function (k, v) {
     if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.LogModel = exports.LogSchema = exports.Log = void 0;
+exports.LogModel = exports.LogSchema = exports.Log = exports.LogTarget = exports.LOG_TYPE_VALUES = exports.LOG_REFERENCE_VALUES = void 0;
 const mongoose_1 = require("@nestjs/mongoose");
+const swagger_1 = require("@nestjs/swagger");
 const mongoose_2 = require("mongoose");
+exports.LOG_REFERENCE_VALUES = [
+    'action',
+    'recruitment',
+    'content',
+    'contract',
+    'sale',
+    'invoice',
+    'payment',
+    'assignment',
+    'commission',
+    'hub-access',
+];
+exports.LOG_TYPE_VALUES = [
+    'created',
+    'updated',
+    'deleted',
+    'email',
+    'client-selected',
+    'access-blocked',
+];
 let UpdatedBy = class UpdatedBy {
 };
 __decorate([
@@ -29,6 +50,22 @@ __decorate([
 UpdatedBy = __decorate([
     (0, mongoose_1.Schema)({ _id: false })
 ], UpdatedBy);
+let LogTarget = class LogTarget {
+};
+__decorate([
+    (0, swagger_1.ApiProperty)({ example: 'FmWcCgBLTwOR2YIEZ5toRdoRpGC3' }),
+    (0, mongoose_1.Prop)({ required: true }),
+    __metadata("design:type", String)
+], LogTarget.prototype, "uid", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({ example: 'pessoa@cliente.com.br' }),
+    (0, mongoose_1.Prop)({ required: true }),
+    __metadata("design:type", String)
+], LogTarget.prototype, "email", void 0);
+LogTarget = __decorate([
+    (0, mongoose_1.Schema)({ _id: false })
+], LogTarget);
+exports.LogTarget = LogTarget;
 let Log = class Log {
 };
 __decorate([
@@ -40,32 +77,13 @@ __decorate([
     __metadata("design:type", String)
 ], Log.prototype, "referenceId", void 0);
 __decorate([
-    (0, mongoose_1.Prop)({
-        required: true,
-        enum: [
-            'action',
-            'recruitment',
-            'content',
-            'contract',
-            'sale',
-            'invoice',
-            'payment',
-            'assignment',
-            'commission',
-        ],
-    }),
+    (0, swagger_1.ApiProperty)({ enum: exports.LOG_REFERENCE_VALUES }),
+    (0, mongoose_1.Prop)({ required: true, enum: exports.LOG_REFERENCE_VALUES }),
     __metadata("design:type", String)
 ], Log.prototype, "reference", void 0);
 __decorate([
-    (0, mongoose_1.Prop)({
-        required: true,
-        enum: [
-            'created',
-            'updated',
-            'deleted',
-            'email'
-        ],
-    }),
+    (0, swagger_1.ApiProperty)({ enum: exports.LOG_TYPE_VALUES }),
+    (0, mongoose_1.Prop)({ required: true, enum: exports.LOG_TYPE_VALUES }),
     __metadata("design:type", String)
 ], Log.prototype, "type", void 0);
 __decorate([
@@ -84,6 +102,11 @@ __decorate([
     (0, mongoose_1.Prop)({ type: UpdatedBy }),
     __metadata("design:type", UpdatedBy)
 ], Log.prototype, "updatedBy", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({ type: LogTarget, required: false, nullable: true }),
+    (0, mongoose_1.Prop)({ type: LogTarget, default: null }),
+    __metadata("design:type", Object)
+], Log.prototype, "target", void 0);
 Log = __decorate([
     (0, mongoose_1.Schema)()
 ], Log);
@@ -91,4 +114,5 @@ exports.Log = Log;
 exports.LogSchema = mongoose_1.SchemaFactory.createForClass(Log);
 exports.LogSchema.index({ referenceId: 1, reference: 1 });
 exports.LogSchema.index({ reference: 1, updatedAt: -1 });
+exports.LogSchema.index({ reference: 1, 'target.uid': 1, updatedAt: -1 });
 exports.LogModel = (0, mongoose_2.model)('Log', exports.LogSchema);

package/docs/specs/GD-761.md

@@ -0,0 +1,94 @@
+# Spec: log: acesso ao Hub e troca de cliente
+
+**Feature:** GD-761 (Story GD-760)
+**Consumido por:** api-entities (GD-762)
+
+---
+
+## Descrição
+
+O Log passa a guardar três coisas novas do Hub de Relatórios:
+
+- alteração de acesso (criar, editar, remover), feita pela tela do Cliente no web-entities;
+- troca de cliente (`POST /auth/select-client`);
+- acesso bloqueado (conta de fora da Grapa com role diferente de `client`).
+
+Hoje o Log só sabe quem fez (`updatedBy`). Aqui ele precisa saber também **quem foi afetado**, que é uma conta do Firebase do Hub e não um documento do Mongo. Isso vira o campo `target`.
+
+`referenceId` continua sendo ObjectId e recebe o `clientId` do Cliente envolvido.
+
+Os campos novos são opcionais e têm default `null`. Logs que já existem não mudam.
+
+## Schema
+
+### `log.schema.ts`
+
+```ts
+export const LOG_REFERENCE_VALUES = [
+  'action', 'recruitment', 'content', 'contract', 'sale',
+  'invoice', 'payment', 'assignment', 'commission',
+  'hub-access',                 // novo
+] as const;
+export type LogReference = (typeof LOG_REFERENCE_VALUES)[number];
+
+export const LOG_TYPE_VALUES = [
+  'created', 'updated', 'deleted', 'email',
+  'client-selected',            // novo: troca de cliente no Hub
+  'access-blocked',             // novo: conta externa barrada pelo guard
+] as const;
+export type LogType = (typeof LOG_TYPE_VALUES)[number];
+
+@Schema({ _id: false })
+export class LogTarget {
+  uid: string;    // uid no Firebase do Hub (projeto hub-grapa)
+  email: string;
+}
+
+Log.reference: LogReference          // @Prop com enum LOG_REFERENCE_VALUES
+Log.type: LogType                    // @Prop com enum LOG_TYPE_VALUES
+Log.target?: LogTarget | null        // default null; preenchido só em reference 'hub-access'
+```
+
+- `@ApiProperty` em `target` e nos dois enums.
+- JSDoc em português no `target`: "Conta do Hub afetada pela ação. Vazio fora de `hub-access`. Ver GD-760."
+
+Índice novo, para buscar o histórico de uma pessoa e para a trava de um alerta por hora da GD-762:
+
+```ts
+LogSchema.index({ reference: 1, 'target.uid': 1, updatedAt: -1 });
+```
+
+Os índices atuais (`{ referenceId: 1, reference: 1 }` e `{ reference: 1, updatedAt: -1 }`) ficam.
+
+---
+
+## Arquivos
+
+- Alterar `src/schemas/log.schema.ts`: as duas constantes `as const` com o tipo derivado, a classe `LogTarget`, o campo `target` e o índice.
+- Alterar `package.json`: versão nova (a última publicada hoje é a 1.0.236; conferir no npm antes).
+
+## Passos
+
+1. Trocar os enums inline de `reference` e `type` pelas constantes `LOG_REFERENCE_VALUES` e `LOG_TYPE_VALUES`, com os valores novos. Os valores antigos continuam, na mesma ordem.
+2. Criar `LogTarget` (`@Schema({ _id: false })`) e o campo `target` (`@Prop({ type: LogTarget, default: null })`), com `@ApiProperty` e o JSDoc.
+3. Declarar o índice `{ reference: 1, 'target.uid': 1, updatedAt: -1 }`.
+4. `npm run build` e conferir no `dist` as constantes, `LogTarget` e o índice, exportados pelo barrel (`src/index.ts` já faz `export *` do arquivo).
+5. Checar com `validateSync`, usando o `dist`:
+   - um Log antigo, sem `target`, continua válido;
+   - um Log com `reference: 'hub-access'`, `type: 'client-selected'` e `target` preenchido é válido;
+   - `type: 'qualquer'` continua inválido.
+6. Subir a versão no `package.json` e publicar (José).
+
+## Dependências
+
+- Nenhuma. Esta Task vem antes da GD-762.
+
+## Validação
+
+- `npm run build`.
+- Script rápido de `validateSync` com o `dist` (passo 5).
+- `npm view @grapadigital/shared-schemas version` antes de publicar.
+
+## Pontos abertos
+
+- O DTO da api-logs (`create-log.dto.ts`) já aceita referências que o schema não tem (`influencer`, `profile`, `curation`, `prospect`). Isso não muda aqui: a GD-762 grava o Log direto pelo model e não passa pela api-logs.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grapadigital/shared-schemas",
-  "version": "1.0.236",
+  "version": "1.0.237",
   "description": "Shared Mongoose Schemas",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/schemas/log.schema.ts

@@ -1,8 +1,33 @@
 import { Prop, Schema, SchemaFactory } from "@nestjs/mongoose";
+import { ApiProperty } from '@nestjs/swagger';
 import { HydratedDocument, Schema as MongooseSchema, Types, model as MongooseModel } from 'mongoose';
 
 export type LogDocument = HydratedDocument<Log>;
 
+export const LOG_REFERENCE_VALUES = [
+  'action',
+  'recruitment',
+  'content',
+  'contract',
+  'sale',
+  'invoice',
+  'payment',
+  'assignment',
+  'commission',
+  'hub-access',
+] as const;
+export type LogReference = (typeof LOG_REFERENCE_VALUES)[number];
+
+export const LOG_TYPE_VALUES = [
+  'created',
+  'updated',
+  'deleted',
+  'email',
+  'client-selected',
+  'access-blocked',
+] as const;
+export type LogType = (typeof LOG_TYPE_VALUES)[number];
+
 @Schema({ _id: false })
 class UpdatedBy {
   @Prop({ required: true }) team: string;
@@ -10,6 +35,18 @@ class UpdatedBy {
   @Prop({ required: true }) email: string;
 }
 
+@Schema({ _id: false })
+export class LogTarget {
+  /** uid da conta no Firebase do Hub (projeto hub-grapa). */
+  @ApiProperty({ example: 'FmWcCgBLTwOR2YIEZ5toRdoRpGC3' })
+  @Prop({ required: true })
+  uid: string;
+
+  @ApiProperty({ example: 'pessoa@cliente.com.br' })
+  @Prop({ required: true })
+  email: string;
+}
+
 @Schema()
 export class Log {
   @Prop({ type: MongooseSchema.Types.ObjectId, auto: true, required: false })
@@ -18,32 +55,13 @@ export class Log {
   @Prop({ type: MongooseSchema.Types.ObjectId })
   referenceId: string;
 
-  @Prop({
-    required: true,
-    enum: [
-      'action',
-      'recruitment',
-      'content',
-      'contract',
-      'sale',
-      'invoice',
-      'payment',
-      'assignment',
-      'commission',
-    ],
-  })
-  reference: 'action' | 'recruitment' | 'content' | 'contract' | 'sale' | 'invoice' | 'payment' | 'assignment' | 'commission';
-
-  @Prop({
-    required: true,
-    enum: [
-      'created',
-      'updated',
-      'deleted',
-      'email'
-    ],
-  })
-  type: 'created' | 'updated' | 'deleted' | 'email';
+  @ApiProperty({ enum: LOG_REFERENCE_VALUES })
+  @Prop({ required: true, enum: LOG_REFERENCE_VALUES })
+  reference: LogReference;
+
+  @ApiProperty({ enum: LOG_TYPE_VALUES })
+  @Prop({ required: true, enum: LOG_TYPE_VALUES })
+  type: LogType;
 
   @Prop({ required: false }) phase?: string;
 
@@ -55,11 +73,19 @@ export class Log {
 
   @Prop({ type: UpdatedBy })
   updatedBy?: UpdatedBy;
+
+  /**
+   * Conta do Hub afetada pela ação. Vazio fora de `hub-access`. Ver GD-760.
+   */
+  @ApiProperty({ type: LogTarget, required: false, nullable: true })
+  @Prop({ type: LogTarget, default: null })
+  target?: LogTarget | null;
 }
 
 export const LogSchema = SchemaFactory.createForClass(Log);
 
 LogSchema.index({ referenceId: 1, reference: 1 });
 LogSchema.index({ reference: 1, updatedAt: -1 });
+LogSchema.index({ reference: 1, 'target.uid': 1, updatedAt: -1 });
 
 export const LogModel = MongooseModel('Log', LogSchema);