@grapadigital/shared-schemas 1.0.221 → 1.0.223

package/dist/index.d.ts

@@ -37,3 +37,4 @@ export * from './schemas/job.schema';
 export * from './schemas/snapshot.schema';
 export * from './schemas/lead.schema';
 export * from './utils/normalize-content-link.util';
+export * from './utils/merge-metrics-breakdown.util';

package/dist/index.js

@@ -58,3 +58,4 @@ __exportStar(require("./schemas/job.schema"), exports);
 __exportStar(require("./schemas/snapshot.schema"), exports);
 __exportStar(require("./schemas/lead.schema"), exports);
 __exportStar(require("./utils/normalize-content-link.util"), exports);
+__exportStar(require("./utils/merge-metrics-breakdown.util"), exports);

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

@@ -113,6 +113,22 @@ export declare class Metrics {
     cpmi?: number | null;
     cpi?: number | null;
     cpe?: number | null;
+    /**
+     * Alcance Potencial (o antigo PO Reach): seguidores no momento do post. Em
+     * Content.metrics soma o autor e todos os coautores. Ver GD-703.
+     */
+    potentialReach?: number | null;
+    /** Tx. de Engaj. por Alcance: engagementCount ÷ reachCount (fração). Ver GD-703. */
+    reachEngagementRate?: number | null;
+    /** Tx. de Engaj. por Seguidores: engagementCount ÷ potentialReach (fração). Ver GD-703. */
+    followersEngagementRate?: number | null;
+    /** Nome do Client.tiers pelo potentialReach do post; null sem Tiers ou fora das faixas. Ver GD-703. */
+    tier?: string | null;
+    /**
+     * followersEngagementRate ≥ meta viralReachEngagementRate do Tier (nome da
+     * meta herdado da GD-687); null sem Tier ou sem a meta. Ver GD-703.
+     */
+    isViral?: boolean | null;
 }
 export declare const MetricsSchema: MongooseSchema<Metrics, import("mongoose").Model<Metrics, any, any, any, import("mongoose").Document<unknown, any, Metrics, any, {}> & Metrics & {
     _id: Types.ObjectId;
@@ -123,6 +139,85 @@ export declare const MetricsSchema: MongooseSchema<Metrics, import("mongoose").M
 } & {
     __v: number;
 }>;
+/** Coautor do post (Colab), com os seguidores dele no momento do post. Ver GD-703. */
+export declare class ContentCollab {
+    profile: Types.ObjectId | Profile;
+    followersAtPost?: number | null;
+}
+export declare const ContentCollabSchema: MongooseSchema<ContentCollab, import("mongoose").Model<ContentCollab, any, any, any, import("mongoose").Document<unknown, any, ContentCollab, any, {}> & ContentCollab & {
+    _id: Types.ObjectId;
+} & {
+    __v: number;
+}, any>, {}, {}, {}, {}, import("mongoose").DefaultSchemaOptions, ContentCollab, import("mongoose").Document<unknown, {}, import("mongoose").FlatRecord<ContentCollab>, {}, import("mongoose").ResolveSchemaOptions<import("mongoose").DefaultSchemaOptions>> & import("mongoose").FlatRecord<ContentCollab> & {
+    _id: Types.ObjectId;
+} & {
+    __v: number;
+}>;
+/** Chaves brutas de Metrics que têm parte Orgânica e Impulsionada. Ver GD-707. */
+export declare const CONTENT_BASE_METRIC_KEYS: readonly ["impressionCount", "reachCount", "likeCount", "commentCount", "savedCount", "sharesCount", "storyCount", "tapBackCount", "clickCount", "replyCount", "tapForwardCount", "swipeForwardCount", "exitCount", "favoriteCount", "dislikeCount", "emv"];
+export type ContentBaseMetricKey = (typeof CONTENT_BASE_METRIC_KEYS)[number];
+export declare class ContentBaseMetrics {
+    impressionCount?: number | null;
+    reachCount?: number | null;
+    likeCount?: number | null;
+    commentCount?: number | null;
+    savedCount?: number | null;
+    sharesCount?: number | null;
+    storyCount?: number | null;
+    tapBackCount?: number | null;
+    clickCount?: number | null;
+    replyCount?: number | null;
+    tapForwardCount?: number | null;
+    swipeForwardCount?: number | null;
+    exitCount?: number | null;
+    favoriteCount?: number | null;
+    dislikeCount?: number | null;
+    emv?: number | null;
+}
+export declare const ContentBaseMetricsSchema: MongooseSchema<ContentBaseMetrics, import("mongoose").Model<ContentBaseMetrics, any, any, any, import("mongoose").Document<unknown, any, ContentBaseMetrics, any, {}> & ContentBaseMetrics & {
+    _id: Types.ObjectId;
+} & {
+    __v: number;
+}, any>, {}, {}, {}, {}, import("mongoose").DefaultSchemaOptions, ContentBaseMetrics, import("mongoose").Document<unknown, {}, import("mongoose").FlatRecord<ContentBaseMetrics>, {}, import("mongoose").ResolveSchemaOptions<import("mongoose").DefaultSchemaOptions>> & import("mongoose").FlatRecord<ContentBaseMetrics> & {
+    _id: Types.ObjectId;
+} & {
+    __v: number;
+}>;
+/** Divisão Orgânico e Impulsionado; o total em Content.metrics é sempre a soma. Ver GD-707. */
+export declare class ContentMetricsBreakdown {
+    organic: ContentBaseMetrics;
+    boosted: ContentBaseMetrics;
+}
+export declare const ContentMetricsBreakdownSchema: MongooseSchema<ContentMetricsBreakdown, import("mongoose").Model<ContentMetricsBreakdown, any, any, any, import("mongoose").Document<unknown, any, ContentMetricsBreakdown, any, {}> & ContentMetricsBreakdown & {
+    _id: Types.ObjectId;
+} & {
+    __v: number;
+}, any>, {}, {}, {}, {}, import("mongoose").DefaultSchemaOptions, ContentMetricsBreakdown, import("mongoose").Document<unknown, {}, import("mongoose").FlatRecord<ContentMetricsBreakdown>, {}, import("mongoose").ResolveSchemaOptions<import("mongoose").DefaultSchemaOptions>> & import("mongoose").FlatRecord<ContentMetricsBreakdown> & {
+    _id: Types.ObjectId;
+} & {
+    __v: number;
+}>;
+/**
+ * Dados do vídeo para o VCR. Views não ficam aqui: impressões e views são
+ * sempre Content.metrics.impressionCount. Ver GD-707.
+ */
+export declare class ContentVideo {
+    /** Duração em segundos. */
+    duration?: number | null;
+    /** Tempo total assistido, somando todas as visualizações, em segundos. */
+    watchTime?: number | null;
+    /** (watchTime ÷ duration) ÷ impressionCount, sem teto. */
+    vcr?: number | null;
+}
+export declare const ContentVideoSchema: MongooseSchema<ContentVideo, import("mongoose").Model<ContentVideo, any, any, any, import("mongoose").Document<unknown, any, ContentVideo, any, {}> & ContentVideo & {
+    _id: Types.ObjectId;
+} & {
+    __v: number;
+}, any>, {}, {}, {}, {}, import("mongoose").DefaultSchemaOptions, ContentVideo, import("mongoose").Document<unknown, {}, import("mongoose").FlatRecord<ContentVideo>, {}, import("mongoose").ResolveSchemaOptions<import("mongoose").DefaultSchemaOptions>> & import("mongoose").FlatRecord<ContentVideo> & {
+    _id: Types.ObjectId;
+} & {
+    __v: number;
+}>;
 export declare class ContentMetricsHistoryEntry {
     metrics: Metrics;
     recordedAt: Date;
@@ -195,8 +290,17 @@ export declare class Content {
     isCollab: boolean;
     isBoosted: boolean;
     hasAffiliateLink: boolean;
-    collabs?: Types.ObjectId[] | Profile[];
+    /** Coautores do post; isCollab = collabs.length > 0. Ver GD-703. */
+    collabs?: ContentCollab[];
+    /** Métricas do post (sem métrica por pessoa): derivadas com o potentialReach somado. Ver GD-703. */
     metrics: Metrics;
+    metricsBreakdown?: ContentMetricsBreakdown | null;
+    /**
+     * Caminhos das partes digitadas à mão (ex.: organic.reachCount,
+     * video.watchTime): a captura não sobrescreve. Ver GD-707.
+     */
+    manualMetrics?: string[];
+    video?: ContentVideo | null;
     estimates: Estimates;
     googleSheetRow?: string;
     createdAt?: Date;
@@ -206,7 +310,9 @@ export declare class Content {
     sentimentAnalysis?: SentimentAnalysis | null;
     thumbnailUrl?: string;
     mediaUrl?: string;
+    /** @deprecated Obsoleto desde a GD-707: a edição vale por parte (manualMetrics). */
     isEdited?: boolean;
+    /** @deprecated Obsoleto desde a GD-707. */
     editedAt?: Date;
     followersAtPost?: number | null;
     history?: ContentMetricsHistoryEntry[];

package/dist/schemas/content.schema.js

@@ -9,7 +9,7 @@ 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.ContentModel = exports.ContentSchema = exports.Content = exports.ContentStatusChangedBySchema = exports.ContentStatusChangedBy = exports.CONTENT_CLASSIFICATION_SOURCE_VALUES = exports.CONTENT_METRICS_SOURCE_VALUES = exports.CONTENT_COMMENT_COUNT_SOURCE_VALUES = exports.CONTENT_REPORTABLE_STATUS_VALUES = exports.CONTENT_STATUS_VALUES = exports.EstimatesSchema = exports.Estimates = exports.ContentMetricsHistoryEntrySchema = exports.ContentMetricsHistoryEntry = exports.MetricsSchema = exports.Metrics = exports.SentimentAnalysisSchema = exports.SentimentAnalysis = exports.SentimentScoreSchema = exports.SentimentScore = exports.WordCloudSchema = exports.WordCloud = exports.SentimentCommentSchema = exports.SentimentComment = void 0;
+exports.ContentModel = exports.ContentSchema = exports.Content = exports.ContentStatusChangedBySchema = exports.ContentStatusChangedBy = exports.CONTENT_CLASSIFICATION_SOURCE_VALUES = exports.CONTENT_METRICS_SOURCE_VALUES = exports.CONTENT_COMMENT_COUNT_SOURCE_VALUES = exports.CONTENT_REPORTABLE_STATUS_VALUES = exports.CONTENT_STATUS_VALUES = exports.EstimatesSchema = exports.Estimates = exports.ContentMetricsHistoryEntrySchema = exports.ContentMetricsHistoryEntry = exports.ContentVideoSchema = exports.ContentVideo = exports.ContentMetricsBreakdownSchema = exports.ContentMetricsBreakdown = exports.ContentBaseMetricsSchema = exports.ContentBaseMetrics = exports.CONTENT_BASE_METRIC_KEYS = exports.ContentCollabSchema = exports.ContentCollab = exports.MetricsSchema = exports.Metrics = exports.SentimentAnalysisSchema = exports.SentimentAnalysis = exports.SentimentScoreSchema = exports.SentimentScore = exports.WordCloudSchema = exports.WordCloud = exports.SentimentCommentSchema = exports.SentimentComment = void 0;
 const mongoose_1 = require("@nestjs/mongoose");
 const mongoose_2 = require("mongoose");
 const normalize_content_link_util_1 = require("../utils/normalize-content-link.util");
@@ -207,11 +207,176 @@ __decorate([
     (0, mongoose_1.Prop)({ type: Number, required: false, default: null }),
     __metadata("design:type", Object)
 ], Metrics.prototype, "cpe", void 0);
+__decorate([
+    (0, mongoose_1.Prop)({ type: Number, required: false, default: null }),
+    __metadata("design:type", Object)
+], Metrics.prototype, "potentialReach", void 0);
+__decorate([
+    (0, mongoose_1.Prop)({ type: Number, required: false, default: null }),
+    __metadata("design:type", Object)
+], Metrics.prototype, "reachEngagementRate", void 0);
+__decorate([
+    (0, mongoose_1.Prop)({ type: Number, required: false, default: null }),
+    __metadata("design:type", Object)
+], Metrics.prototype, "followersEngagementRate", void 0);
+__decorate([
+    (0, mongoose_1.Prop)({ type: String, required: false, default: null }),
+    __metadata("design:type", Object)
+], Metrics.prototype, "tier", void 0);
+__decorate([
+    (0, mongoose_1.Prop)({ type: Boolean, required: false, default: null }),
+    __metadata("design:type", Object)
+], Metrics.prototype, "isViral", void 0);
 Metrics = __decorate([
     (0, mongoose_1.Schema)({ _id: false })
 ], Metrics);
 exports.Metrics = Metrics;
 exports.MetricsSchema = mongoose_1.SchemaFactory.createForClass(Metrics);
+/** Coautor do post (Colab), com os seguidores dele no momento do post. Ver GD-703. */
+let ContentCollab = class ContentCollab {
+};
+__decorate([
+    (0, mongoose_1.Prop)({ type: mongoose_2.Schema.Types.ObjectId, ref: 'Profile', required: true }),
+    __metadata("design:type", Object)
+], ContentCollab.prototype, "profile", void 0);
+__decorate([
+    (0, mongoose_1.Prop)({ type: Number, required: false, default: null }),
+    __metadata("design:type", Object)
+], ContentCollab.prototype, "followersAtPost", void 0);
+ContentCollab = __decorate([
+    (0, mongoose_1.Schema)({ _id: false })
+], ContentCollab);
+exports.ContentCollab = ContentCollab;
+exports.ContentCollabSchema = mongoose_1.SchemaFactory.createForClass(ContentCollab);
+/** Chaves brutas de Metrics que têm parte Orgânica e Impulsionada. Ver GD-707. */
+exports.CONTENT_BASE_METRIC_KEYS = [
+    'impressionCount',
+    'reachCount',
+    'likeCount',
+    'commentCount',
+    'savedCount',
+    'sharesCount',
+    'storyCount',
+    'tapBackCount',
+    'clickCount',
+    'replyCount',
+    'tapForwardCount',
+    'swipeForwardCount',
+    'exitCount',
+    'favoriteCount',
+    'dislikeCount',
+    'emv',
+];
+let ContentBaseMetrics = class ContentBaseMetrics {
+};
+__decorate([
+    (0, mongoose_1.Prop)({ type: Number, required: false, default: null }),
+    __metadata("design:type", Object)
+], ContentBaseMetrics.prototype, "impressionCount", void 0);
+__decorate([
+    (0, mongoose_1.Prop)({ type: Number, required: false, default: null }),
+    __metadata("design:type", Object)
+], ContentBaseMetrics.prototype, "reachCount", void 0);
+__decorate([
+    (0, mongoose_1.Prop)({ type: Number, required: false, default: null }),
+    __metadata("design:type", Object)
+], ContentBaseMetrics.prototype, "likeCount", void 0);
+__decorate([
+    (0, mongoose_1.Prop)({ type: Number, required: false, default: null }),
+    __metadata("design:type", Object)
+], ContentBaseMetrics.prototype, "commentCount", void 0);
+__decorate([
+    (0, mongoose_1.Prop)({ type: Number, required: false, default: null }),
+    __metadata("design:type", Object)
+], ContentBaseMetrics.prototype, "savedCount", void 0);
+__decorate([
+    (0, mongoose_1.Prop)({ type: Number, required: false, default: null }),
+    __metadata("design:type", Object)
+], ContentBaseMetrics.prototype, "sharesCount", void 0);
+__decorate([
+    (0, mongoose_1.Prop)({ type: Number, required: false, default: null }),
+    __metadata("design:type", Object)
+], ContentBaseMetrics.prototype, "storyCount", void 0);
+__decorate([
+    (0, mongoose_1.Prop)({ type: Number, required: false, default: null }),
+    __metadata("design:type", Object)
+], ContentBaseMetrics.prototype, "tapBackCount", void 0);
+__decorate([
+    (0, mongoose_1.Prop)({ type: Number, required: false, default: null }),
+    __metadata("design:type", Object)
+], ContentBaseMetrics.prototype, "clickCount", void 0);
+__decorate([
+    (0, mongoose_1.Prop)({ type: Number, required: false, default: null }),
+    __metadata("design:type", Object)
+], ContentBaseMetrics.prototype, "replyCount", void 0);
+__decorate([
+    (0, mongoose_1.Prop)({ type: Number, required: false, default: null }),
+    __metadata("design:type", Object)
+], ContentBaseMetrics.prototype, "tapForwardCount", void 0);
+__decorate([
+    (0, mongoose_1.Prop)({ type: Number, required: false, default: null }),
+    __metadata("design:type", Object)
+], ContentBaseMetrics.prototype, "swipeForwardCount", void 0);
+__decorate([
+    (0, mongoose_1.Prop)({ type: Number, required: false, default: null }),
+    __metadata("design:type", Object)
+], ContentBaseMetrics.prototype, "exitCount", void 0);
+__decorate([
+    (0, mongoose_1.Prop)({ type: Number, required: false, default: null }),
+    __metadata("design:type", Object)
+], ContentBaseMetrics.prototype, "favoriteCount", void 0);
+__decorate([
+    (0, mongoose_1.Prop)({ type: Number, required: false, default: null }),
+    __metadata("design:type", Object)
+], ContentBaseMetrics.prototype, "dislikeCount", void 0);
+__decorate([
+    (0, mongoose_1.Prop)({ type: Number, required: false, default: null }),
+    __metadata("design:type", Object)
+], ContentBaseMetrics.prototype, "emv", void 0);
+ContentBaseMetrics = __decorate([
+    (0, mongoose_1.Schema)({ _id: false })
+], ContentBaseMetrics);
+exports.ContentBaseMetrics = ContentBaseMetrics;
+exports.ContentBaseMetricsSchema = mongoose_1.SchemaFactory.createForClass(ContentBaseMetrics);
+/** Divisão Orgânico e Impulsionado; o total em Content.metrics é sempre a soma. Ver GD-707. */
+let ContentMetricsBreakdown = class ContentMetricsBreakdown {
+};
+__decorate([
+    (0, mongoose_1.Prop)({ type: exports.ContentBaseMetricsSchema, required: false, default: () => ({}) }),
+    __metadata("design:type", ContentBaseMetrics)
+], ContentMetricsBreakdown.prototype, "organic", void 0);
+__decorate([
+    (0, mongoose_1.Prop)({ type: exports.ContentBaseMetricsSchema, required: false, default: () => ({}) }),
+    __metadata("design:type", ContentBaseMetrics)
+], ContentMetricsBreakdown.prototype, "boosted", void 0);
+ContentMetricsBreakdown = __decorate([
+    (0, mongoose_1.Schema)({ _id: false })
+], ContentMetricsBreakdown);
+exports.ContentMetricsBreakdown = ContentMetricsBreakdown;
+exports.ContentMetricsBreakdownSchema = mongoose_1.SchemaFactory.createForClass(ContentMetricsBreakdown);
+/**
+ * Dados do vídeo para o VCR. Views não ficam aqui: impressões e views são
+ * sempre Content.metrics.impressionCount. Ver GD-707.
+ */
+let ContentVideo = class ContentVideo {
+};
+__decorate([
+    (0, mongoose_1.Prop)({ type: Number, required: false, default: null }),
+    __metadata("design:type", Object)
+], ContentVideo.prototype, "duration", void 0);
+__decorate([
+    (0, mongoose_1.Prop)({ type: Number, required: false, default: null }),
+    __metadata("design:type", Object)
+], ContentVideo.prototype, "watchTime", void 0);
+__decorate([
+    (0, mongoose_1.Prop)({ type: Number, required: false, default: null }),
+    __metadata("design:type", Object)
+], ContentVideo.prototype, "vcr", void 0);
+ContentVideo = __decorate([
+    (0, mongoose_1.Schema)({ _id: false })
+], ContentVideo);
+exports.ContentVideo = ContentVideo;
+exports.ContentVideoSchema = mongoose_1.SchemaFactory.createForClass(ContentVideo);
 let ContentMetricsHistoryEntry = class ContentMetricsHistoryEntry {
 };
 __decorate([
@@ -391,15 +556,25 @@ __decorate([
     __metadata("design:type", Boolean)
 ], Content.prototype, "hasAffiliateLink", void 0);
 __decorate([
-    (0, mongoose_1.Prop)([
-        { type: mongoose_2.Schema.Types.ObjectId, ref: 'Profile', required: false },
-    ]),
+    (0, mongoose_1.Prop)({ type: [exports.ContentCollabSchema], required: false, default: [] }),
     __metadata("design:type", Array)
 ], Content.prototype, "collabs", void 0);
 __decorate([
     (0, mongoose_1.Prop)({ type: exports.MetricsSchema, required: true }),
     __metadata("design:type", Metrics)
 ], Content.prototype, "metrics", void 0);
+__decorate([
+    (0, mongoose_1.Prop)({ type: exports.ContentMetricsBreakdownSchema, required: false, default: null }),
+    __metadata("design:type", Object)
+], Content.prototype, "metricsBreakdown", void 0);
+__decorate([
+    (0, mongoose_1.Prop)({ type: [String], required: false, default: [] }),
+    __metadata("design:type", Array)
+], Content.prototype, "manualMetrics", void 0);
+__decorate([
+    (0, mongoose_1.Prop)({ type: exports.ContentVideoSchema, required: false, default: null }),
+    __metadata("design:type", Object)
+], Content.prototype, "video", void 0);
 __decorate([
     (0, mongoose_1.Prop)({ type: exports.MetricsSchema, required: true }),
     __metadata("design:type", Estimates)
@@ -500,6 +675,8 @@ exports.ContentSchema.index({ createdAt: -1, status: 1 });
 // Trava de aprovação entre Ações (GD-699): busca o mesmo post por publicação ou link.
 exports.ContentSchema.index({ primetagId: 1 });
 exports.ContentSchema.index({ linkKey: 1 });
+// Visão por Influenciador (GD-703): posts em que o Perfil é coautor.
+exports.ContentSchema.index({ 'collabs.profile': 1 });
 // Chave de idempotência da captura da Primetag — conteúdos manuais (sem
 // primetagId) ficam fora do índice.
 exports.ContentSchema.index({ action: 1, primetagId: 1 }, { unique: true, partialFilterExpression: { primetagId: { $type: 'string' } } });

package/dist/utils/merge-metrics-breakdown.util.d.ts

@@ -0,0 +1,12 @@
+import { ContentMetricsBreakdown, Metrics } from '../schemas/content.schema';
+/**
+ * Totais de Content.metrics a partir da divisão Orgânico e Impulsionado. Ver GD-707.
+ *
+ * - metrics.<chave> = organic + boosted (null só se as duas forem null);
+ * - engagementCount = o da Primetag, a menos que alguma parte de curtidas,
+ *   comentários, compartilhamentos ou salvos seja manual: aí vira a soma dos totais;
+ * - engagementRate = engagementCount ÷ impressionCount.
+ *
+ * Usada pela captura e pela edição (api-campaigns): as duas precisam dar o mesmo total.
+ */
+export declare const mergeMetricsBreakdown: (breakdown: ContentMetricsBreakdown, primetagEngagementCount: number | null | undefined, manualMetrics?: string[]) => Partial<Metrics>;

package/dist/utils/merge-metrics-breakdown.util.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mergeMetricsBreakdown = void 0;
+const content_schema_1 = require("../schemas/content.schema");
+// Partes que, se digitadas à mão, fazem o engajamento virar a soma.
+const ENGAGEMENT_KEYS = ['likeCount', 'commentCount', 'sharesCount', 'savedCount'];
+const sumParts = (organic, boosted) => organic == null && boosted == null ? null : (organic ?? 0) + (boosted ?? 0);
+/**
+ * Totais de Content.metrics a partir da divisão Orgânico e Impulsionado. Ver GD-707.
+ *
+ * - metrics.<chave> = organic + boosted (null só se as duas forem null);
+ * - engagementCount = o da Primetag, a menos que alguma parte de curtidas,
+ *   comentários, compartilhamentos ou salvos seja manual: aí vira a soma dos totais;
+ * - engagementRate = engagementCount ÷ impressionCount.
+ *
+ * Usada pela captura e pela edição (api-campaigns): as duas precisam dar o mesmo total.
+ */
+const mergeMetricsBreakdown = (breakdown, primetagEngagementCount, manualMetrics = []) => {
+    const organic = breakdown.organic ?? {};
+    const boosted = breakdown.boosted ?? {};
+    const totals = {};
+    for (const key of content_schema_1.CONTENT_BASE_METRIC_KEYS) {
+        totals[key] = sumParts(organic[key], boosted[key]);
+    }
+    const hasManualEngagement = ENGAGEMENT_KEYS.some((key) => manualMetrics.includes(`organic.${key}`) || manualMetrics.includes(`boosted.${key}`));
+    const engagementCount = hasManualEngagement
+        ? ENGAGEMENT_KEYS.reduce((sum, key) => sum + (totals[key] ?? 0), 0)
+        : primetagEngagementCount ?? null;
+    const impressionCount = totals.impressionCount ?? 0;
+    return {
+        ...totals,
+        engagementCount,
+        engagementRate: engagementCount != null && impressionCount > 0 ? engagementCount / impressionCount : null,
+    };
+};
+exports.mergeMetricsBreakdown = mergeMetricsBreakdown;

package/package.json

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

package/src/index.ts

@@ -37,3 +37,4 @@ export * from './schemas/job.schema';
 export * from './schemas/snapshot.schema';
 export * from './schemas/lead.schema';
 export * from './utils/normalize-content-link.util';
+export * from './utils/merge-metrics-breakdown.util';

package/src/schemas/content.schema.ts

@@ -157,10 +157,155 @@ export class Metrics {
 
   @Prop({ type: Number, required: false, default: null })
   cpe?: number | null;
+
+  /**
+   * Alcance Potencial (o antigo PO Reach): seguidores no momento do post. Em
+   * Content.metrics soma o autor e todos os coautores. Ver GD-703.
+   */
+  @Prop({ type: Number, required: false, default: null })
+  potentialReach?: number | null;
+
+  /** Tx. de Engaj. por Alcance: engagementCount ÷ reachCount (fração). Ver GD-703. */
+  @Prop({ type: Number, required: false, default: null })
+  reachEngagementRate?: number | null;
+
+  /** Tx. de Engaj. por Seguidores: engagementCount ÷ potentialReach (fração). Ver GD-703. */
+  @Prop({ type: Number, required: false, default: null })
+  followersEngagementRate?: number | null;
+
+  /** Nome do Client.tiers pelo potentialReach do post; null sem Tiers ou fora das faixas. Ver GD-703. */
+  @Prop({ type: String, required: false, default: null })
+  tier?: string | null;
+
+  /**
+   * followersEngagementRate ≥ meta viralReachEngagementRate do Tier (nome da
+   * meta herdado da GD-687); null sem Tier ou sem a meta. Ver GD-703.
+   */
+  @Prop({ type: Boolean, required: false, default: null })
+  isViral?: boolean | null;
 }
 
 export const MetricsSchema = SchemaFactory.createForClass(Metrics);
 
+/** Coautor do post (Colab), com os seguidores dele no momento do post. Ver GD-703. */
+@Schema({ _id: false })
+export class ContentCollab {
+  @Prop({ type: MongooseSchema.Types.ObjectId, ref: 'Profile', required: true })
+  profile: Types.ObjectId | Profile;
+
+  @Prop({ type: Number, required: false, default: null })
+  followersAtPost?: number | null;
+}
+
+export const ContentCollabSchema = SchemaFactory.createForClass(ContentCollab);
+
+/** Chaves brutas de Metrics que têm parte Orgânica e Impulsionada. Ver GD-707. */
+export const CONTENT_BASE_METRIC_KEYS = [
+  'impressionCount',
+  'reachCount',
+  'likeCount',
+  'commentCount',
+  'savedCount',
+  'sharesCount',
+  'storyCount',
+  'tapBackCount',
+  'clickCount',
+  'replyCount',
+  'tapForwardCount',
+  'swipeForwardCount',
+  'exitCount',
+  'favoriteCount',
+  'dislikeCount',
+  'emv',
+] as const;
+export type ContentBaseMetricKey = (typeof CONTENT_BASE_METRIC_KEYS)[number];
+
+@Schema({ _id: false })
+export class ContentBaseMetrics {
+  @Prop({ type: Number, required: false, default: null })
+  impressionCount?: number | null;
+
+  @Prop({ type: Number, required: false, default: null })
+  reachCount?: number | null;
+
+  @Prop({ type: Number, required: false, default: null })
+  likeCount?: number | null;
+
+  @Prop({ type: Number, required: false, default: null })
+  commentCount?: number | null;
+
+  @Prop({ type: Number, required: false, default: null })
+  savedCount?: number | null;
+
+  @Prop({ type: Number, required: false, default: null })
+  sharesCount?: number | null;
+
+  @Prop({ type: Number, required: false, default: null })
+  storyCount?: number | null;
+
+  @Prop({ type: Number, required: false, default: null })
+  tapBackCount?: number | null;
+
+  @Prop({ type: Number, required: false, default: null })
+  clickCount?: number | null;
+
+  @Prop({ type: Number, required: false, default: null })
+  replyCount?: number | null;
+
+  @Prop({ type: Number, required: false, default: null })
+  tapForwardCount?: number | null;
+
+  @Prop({ type: Number, required: false, default: null })
+  swipeForwardCount?: number | null;
+
+  @Prop({ type: Number, required: false, default: null })
+  exitCount?: number | null;
+
+  @Prop({ type: Number, required: false, default: null })
+  favoriteCount?: number | null;
+
+  @Prop({ type: Number, required: false, default: null })
+  dislikeCount?: number | null;
+
+  @Prop({ type: Number, required: false, default: null })
+  emv?: number | null;
+}
+
+export const ContentBaseMetricsSchema = SchemaFactory.createForClass(ContentBaseMetrics);
+
+/** Divisão Orgânico e Impulsionado; o total em Content.metrics é sempre a soma. Ver GD-707. */
+@Schema({ _id: false })
+export class ContentMetricsBreakdown {
+  @Prop({ type: ContentBaseMetricsSchema, required: false, default: () => ({}) })
+  organic: ContentBaseMetrics;
+
+  @Prop({ type: ContentBaseMetricsSchema, required: false, default: () => ({}) })
+  boosted: ContentBaseMetrics;
+}
+
+export const ContentMetricsBreakdownSchema = SchemaFactory.createForClass(ContentMetricsBreakdown);
+
+/**
+ * Dados do vídeo para o VCR. Views não ficam aqui: impressões e views são
+ * sempre Content.metrics.impressionCount. Ver GD-707.
+ */
+@Schema({ _id: false })
+export class ContentVideo {
+  /** Duração em segundos. */
+  @Prop({ type: Number, required: false, default: null })
+  duration?: number | null;
+
+  /** Tempo total assistido, somando todas as visualizações, em segundos. */
+  @Prop({ type: Number, required: false, default: null })
+  watchTime?: number | null;
+
+  /** (watchTime ÷ duration) ÷ impressionCount, sem teto. */
+  @Prop({ type: Number, required: false, default: null })
+  vcr?: number | null;
+}
+
+export const ContentVideoSchema = SchemaFactory.createForClass(ContentVideo);
+
 @Schema({ _id: false })
 export class ContentMetricsHistoryEntry {
   @Prop({ type: MetricsSchema, required: true })
@@ -330,14 +475,27 @@ export class Content {
   @Prop({ type: Boolean, required: true, default: false })
   hasAffiliateLink: boolean;
 
-  @Prop([
-    { type: MongooseSchema.Types.ObjectId, ref: 'Profile', required: false },
-  ])
-  collabs?: Types.ObjectId[] | Profile[];
+  /** Coautores do post; isCollab = collabs.length > 0. Ver GD-703. */
+  @Prop({ type: [ContentCollabSchema], required: false, default: [] })
+  collabs?: ContentCollab[];
 
+  /** Métricas do post (sem métrica por pessoa): derivadas com o potentialReach somado. Ver GD-703. */
   @Prop({ type: MetricsSchema, required: true })
   metrics: Metrics;
 
+  @Prop({ type: ContentMetricsBreakdownSchema, required: false, default: null })
+  metricsBreakdown?: ContentMetricsBreakdown | null;
+
+  /**
+   * Caminhos das partes digitadas à mão (ex.: organic.reachCount,
+   * video.watchTime): a captura não sobrescreve. Ver GD-707.
+   */
+  @Prop({ type: [String], required: false, default: [] })
+  manualMetrics?: string[];
+
+  @Prop({ type: ContentVideoSchema, required: false, default: null })
+  video?: ContentVideo | null;
+
   @Prop({ type: MetricsSchema, required: true })
   estimates: Estimates;
 
@@ -368,9 +526,11 @@ export class Content {
   @Prop({ type: String, required: false })
   mediaUrl?: string;
 
+  /** @deprecated Obsoleto desde a GD-707: a edição vale por parte (manualMetrics). */
   @Prop({ type: Boolean, required: false, default: false })
   isEdited?: boolean;
 
+  /** @deprecated Obsoleto desde a GD-707. */
   @Prop({ type: Date, required: false })
   editedAt?: Date;
 
@@ -437,6 +597,8 @@ ContentSchema.index({ createdAt: -1, status: 1 });
 // Trava de aprovação entre Ações (GD-699): busca o mesmo post por publicação ou link.
 ContentSchema.index({ primetagId: 1 });
 ContentSchema.index({ linkKey: 1 });
+// Visão por Influenciador (GD-703): posts em que o Perfil é coautor.
+ContentSchema.index({ 'collabs.profile': 1 });
 // Chave de idempotência da captura da Primetag — conteúdos manuais (sem
 // primetagId) ficam fora do índice.
 ContentSchema.index(

package/src/utils/merge-metrics-breakdown.util.ts

@@ -0,0 +1,51 @@
+import {
+  CONTENT_BASE_METRIC_KEYS,
+  ContentBaseMetricKey,
+  ContentBaseMetrics,
+  ContentMetricsBreakdown,
+  Metrics,
+} from '../schemas/content.schema';
+
+// Partes que, se digitadas à mão, fazem o engajamento virar a soma.
+const ENGAGEMENT_KEYS: ContentBaseMetricKey[] = ['likeCount', 'commentCount', 'sharesCount', 'savedCount'];
+
+const sumParts = (organic?: number | null, boosted?: number | null): number | null =>
+  organic == null && boosted == null ? null : (organic ?? 0) + (boosted ?? 0);
+
+/**
+ * Totais de Content.metrics a partir da divisão Orgânico e Impulsionado. Ver GD-707.
+ *
+ * - metrics.<chave> = organic + boosted (null só se as duas forem null);
+ * - engagementCount = o da Primetag, a menos que alguma parte de curtidas,
+ *   comentários, compartilhamentos ou salvos seja manual: aí vira a soma dos totais;
+ * - engagementRate = engagementCount ÷ impressionCount.
+ *
+ * Usada pela captura e pela edição (api-campaigns): as duas precisam dar o mesmo total.
+ */
+export const mergeMetricsBreakdown = (
+  breakdown: ContentMetricsBreakdown,
+  primetagEngagementCount: number | null | undefined,
+  manualMetrics: string[] = [],
+): Partial<Metrics> => {
+  const organic: ContentBaseMetrics = breakdown.organic ?? {};
+  const boosted: ContentBaseMetrics = breakdown.boosted ?? {};
+
+  const totals: Partial<Metrics> = {};
+  for (const key of CONTENT_BASE_METRIC_KEYS) {
+    totals[key] = sumParts(organic[key], boosted[key]);
+  }
+
+  const hasManualEngagement = ENGAGEMENT_KEYS.some(
+    (key) => manualMetrics.includes(`organic.${key}`) || manualMetrics.includes(`boosted.${key}`),
+  );
+  const engagementCount = hasManualEngagement
+    ? ENGAGEMENT_KEYS.reduce((sum, key) => sum + (totals[key] ?? 0), 0)
+    : primetagEngagementCount ?? null;
+
+  const impressionCount = totals.impressionCount ?? 0;
+  return {
+    ...totals,
+    engagementCount,
+    engagementRate: engagementCount != null && impressionCount > 0 ? engagementCount / impressionCount : null,
+  };
+};