@grapadigital/shared-schemas 1.0.224 → 1.0.226

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

@@ -54,6 +54,16 @@ export declare const ActionPromptConfigSchema: MongooseSchema<ActionPromptConfig
 }>;
 export declare const ACTION_STATUS_VALUES: readonly ["config", "inProgress", "finished", "archived", "cancelled"];
 export type ActionStatus = (typeof ACTION_STATUS_VALUES)[number];
+/**
+ * Tipo da Ação (Action.type). O nome evita confusão com o ACTION_TYPE_VALUES
+ * do shared-app-modules, que é partnership. Ver GD-711.
+ * - influency: Influência (antes "creator", "Creators Pago");
+ * - organic: Orgânicos do mês da Samsung (GD-699/GD-711);
+ * - annual: Ação anual da Samsung, fora da captura diária, atualizada só pelo
+ *   modo metrics-only do content-capture-worker.
+ */
+export declare const ACTION_KIND_VALUES: readonly ["seeding", "ugc", "influency", "organic", "annual"];
+export type ActionKind = (typeof ACTION_KIND_VALUES)[number];
 /**
  * Fase da Ação (antigo briefing do genc). Com `_id` porque o Conteúdo aponta
  * para ela (`Content.phase`). Período e hashtags opcionais fazem a captura
@@ -91,8 +101,8 @@ export declare class Action {
     nps?: number;
     status: ActionStatus;
     partnership: 'partner' | 'exclusive';
-    /** organic = Orgânicos do mês: post aprovado numa Ação de produto sai dela. Ver GD-699. */
-    type: 'seeding' | 'ugc' | 'creator' | 'organic';
+    /** Ver ACTION_KIND_VALUES. organic: post aprovado numa Ação de produto sai dela (GD-699). */
+    type: ActionKind;
     socialnetworks?: string[];
     recruitedInfluencers?: number;
     hiredInfluencers?: number;

package/dist/schemas/action.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.ActionModel = exports.ActionSchema = exports.Action = exports.ActionPhaseSchema = exports.ActionPhase = exports.ACTION_STATUS_VALUES = exports.ActionPromptConfigSchema = exports.ActionPromptConfig = exports.ACTION_BUSINESS_UNIT_VALUES = void 0;
+exports.ActionModel = exports.ActionSchema = exports.Action = exports.ActionPhaseSchema = exports.ActionPhase = exports.ACTION_KIND_VALUES = exports.ACTION_STATUS_VALUES = exports.ActionPromptConfigSchema = exports.ActionPromptConfig = exports.ACTION_BUSINESS_UNIT_VALUES = void 0;
 const mongoose_1 = require("@nestjs/mongoose");
 const swagger_1 = require("@nestjs/swagger");
 const mongoose_2 = require("mongoose");
@@ -75,6 +75,15 @@ exports.ACTION_STATUS_VALUES = [
     'archived',
     'cancelled',
 ];
+/**
+ * Tipo da Ação (Action.type). O nome evita confusão com o ACTION_TYPE_VALUES
+ * do shared-app-modules, que é partnership. Ver GD-711.
+ * - influency: Influência (antes "creator", "Creators Pago");
+ * - organic: Orgânicos do mês da Samsung (GD-699/GD-711);
+ * - annual: Ação anual da Samsung, fora da captura diária, atualizada só pelo
+ *   modo metrics-only do content-capture-worker.
+ */
+exports.ACTION_KIND_VALUES = ['seeding', 'ugc', 'influency', 'organic', 'annual'];
 /**
  * Fase da Ação (antigo briefing do genc). Com `_id` porque o Conteúdo aponta
  * para ela (`Content.phase`). Período e hashtags opcionais fazem a captura
@@ -170,8 +179,8 @@ __decorate([
     __metadata("design:type", String)
 ], Action.prototype, "partnership", void 0);
 __decorate([
-    (0, swagger_1.ApiProperty)({ enum: ['seeding', 'ugc', 'creator', 'organic'], example: 'seeding' }),
-    (0, mongoose_1.Prop)({ type: String, enum: ['seeding', 'ugc', 'creator', 'organic'], required: true }),
+    (0, swagger_1.ApiProperty)({ enum: exports.ACTION_KIND_VALUES, example: 'seeding' }),
+    (0, mongoose_1.Prop)({ type: String, enum: exports.ACTION_KIND_VALUES, required: true }),
     __metadata("design:type", String)
 ], Action.prototype, "type", void 0);
 __decorate([

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

@@ -25,7 +25,14 @@
 /// <reference types="mongoose/types/inferrawdoctype" />
 import { HydratedDocument, Schema as MongooseSchema, Types } from 'mongoose';
 import { Client } from './client.schema';
-export type BenchmarkMetric = 'reach' | 'er' | 'cpi' | 'cpe';
+/**
+ * Métrica do benchmark. Nomes por extenso (GD-751); os antigos (`er`, `cpi`,
+ * `cpe`) ficam aceitos só durante a virada e saem na fase de remoção.
+ */
+export declare const BENCHMARK_METRIC_VALUES: readonly ["reach", "engagementRate", "costPerThousandImpressions", "costPerEngagement"];
+export type BenchmarkMetric = (typeof BENCHMARK_METRIC_VALUES)[number];
+/** @deprecated Nomes antigos aceitos só na virada (GD-751). */
+export declare const LEGACY_BENCHMARK_METRIC_VALUES: readonly ["er", "cpi", "cpe", "costPerImpression"];
 export type BenchmarkMode = 'organic' | 'paid';
 export type BenchmarkDocument = HydratedDocument<Benchmark>;
 export declare class Benchmark {

package/dist/schemas/benchmark.schema.js

@@ -9,9 +9,16 @@ 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.BenchmarkModel = exports.BenchmarkSchema = exports.Benchmark = void 0;
+exports.BenchmarkModel = exports.BenchmarkSchema = exports.Benchmark = exports.LEGACY_BENCHMARK_METRIC_VALUES = exports.BENCHMARK_METRIC_VALUES = void 0;
 const mongoose_1 = require("@nestjs/mongoose");
 const mongoose_2 = require("mongoose");
+/**
+ * Métrica do benchmark. Nomes por extenso (GD-751); os antigos (`er`, `cpi`,
+ * `cpe`) ficam aceitos só durante a virada e saem na fase de remoção.
+ */
+exports.BENCHMARK_METRIC_VALUES = ['reach', 'engagementRate', 'costPerThousandImpressions', 'costPerEngagement'];
+/** @deprecated Nomes antigos aceitos só na virada (GD-751). */
+exports.LEGACY_BENCHMARK_METRIC_VALUES = ['er', 'cpi', 'cpe', 'costPerImpression'];
 let Benchmark = class Benchmark {
 };
 __decorate([
@@ -27,7 +34,7 @@ __decorate([
     __metadata("design:type", String)
 ], Benchmark.prototype, "mode", void 0);
 __decorate([
-    (0, mongoose_1.Prop)({ type: String, enum: ['reach', 'er', 'cpi', 'cpe'], required: true }),
+    (0, mongoose_1.Prop)({ type: String, enum: [...exports.BENCHMARK_METRIC_VALUES, ...exports.LEGACY_BENCHMARK_METRIC_VALUES], required: true }),
     __metadata("design:type", String)
 ], Benchmark.prototype, "metric", void 0);
 __decorate([

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

@@ -40,7 +40,7 @@ export type ClientCustomization = (typeof CLIENT_CUSTOMIZATION_VALUES)[number];
  * `viralReachEngagementRate` é o limite de viral e só vale no Tier.
  * Ver GD-687.
  */
-export declare const CLIENT_GOAL_METRIC_VALUES: readonly ["potentialReach", "reachCount", "impressionCount", "engagementCount", "engagementRate", "reachEngagementRate", "qualifiedEngagementRate", "effectiveReach", "emv", "score", "cpmi", "cpi", "cpe", "savedCount", "sharesCount", "vcr", "viralReachEngagementRate"];
+export declare const CLIENT_GOAL_METRIC_VALUES: readonly ["potentialReach", "reachCount", "impressionCount", "engagementCount", "engagementRate", "reachEngagementRate", "qualifiedEngagementRate", "effectiveReach", "earnedMediaValue", "score", "costPerInfluency", "costPerImpact", "costPerEngagement", "savedCount", "shareCount", "videoCompletionRate", "viralReachEngagementRate"];
 export type ClientGoalMetric = (typeof CLIENT_GOAL_METRIC_VALUES)[number];
 export type ClientGoalMetricUnit = 'count' | 'rate' | 'currency';
 /** Unidade de cada métrica. `rate` é guardado como fração (0,10 = 10%). */

package/dist/schemas/client.schema.js

@@ -35,14 +35,14 @@ exports.CLIENT_GOAL_METRIC_VALUES = [
     'reachEngagementRate',
     'qualifiedEngagementRate',
     'effectiveReach',
-    'emv',
+    'earnedMediaValue',
     'score',
-    'cpmi',
-    'cpi',
-    'cpe',
+    'costPerInfluency',
+    'costPerImpact',
+    'costPerEngagement',
     'savedCount',
-    'sharesCount',
-    'vcr',
+    'shareCount',
+    'videoCompletionRate',
     'viralReachEngagementRate',
 ];
 /** Unidade de cada métrica. `rate` é guardado como fração (0,10 = 10%). */
@@ -55,14 +55,14 @@ exports.CLIENT_GOAL_METRIC_UNITS = {
     reachEngagementRate: 'rate',
     qualifiedEngagementRate: 'rate',
     effectiveReach: 'count',
-    emv: 'currency',
+    earnedMediaValue: 'currency',
     score: 'count',
-    cpmi: 'currency',
-    cpi: 'currency',
-    cpe: 'currency',
+    costPerInfluency: 'currency',
+    costPerImpact: 'currency',
+    costPerEngagement: 'currency',
     savedCount: 'count',
-    sharesCount: 'count',
-    vcr: 'rate',
+    shareCount: 'count',
+    videoCompletionRate: 'rate',
     viralReachEngagementRate: 'rate',
 };
 let Cluster = class Cluster {

package/dist/schemas/content-capture-process.schema.d.ts

@@ -35,7 +35,7 @@ export declare class ContentCaptureProcessMetrics {
     sentimentPositive?: number | null;
     sentimentNegative?: number | null;
     sentimentNeutral?: number | null;
-    emv?: number | null;
+    earnedMediaValue?: number | null;
 }
 export declare const ContentCaptureProcessMetricsSchema: MongooseSchema<ContentCaptureProcessMetrics, import("mongoose").Model<ContentCaptureProcessMetrics, any, any, any, import("mongoose").Document<unknown, any, ContentCaptureProcessMetrics, any, {}> & ContentCaptureProcessMetrics & {
     _id: Types.ObjectId;

package/dist/schemas/content-capture-process.schema.js

@@ -46,7 +46,7 @@ __decorate([
 __decorate([
     (0, mongoose_1.Prop)({ type: Number, required: false, default: null }),
     __metadata("design:type", Object)
-], ContentCaptureProcessMetrics.prototype, "emv", void 0);
+], ContentCaptureProcessMetrics.prototype, "earnedMediaValue", void 0);
 ContentCaptureProcessMetrics = __decorate([
     (0, mongoose_1.Schema)({ _id: false })
 ], ContentCaptureProcessMetrics);

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

@@ -92,6 +92,8 @@ export declare class Metrics {
     likeCount?: number | null;
     commentCount?: number | null;
     savedCount?: number | null;
+    shareCount?: number | null;
+    /** @deprecated Usar `shareCount` (GD-751). Sai na fase de remoção. */
     sharesCount?: number | null;
     storyCount?: number | null;
     tapBackCount?: number | null;
@@ -102,6 +104,9 @@ export declare class Metrics {
     exitCount?: number | null;
     favoriteCount?: number | null;
     dislikeCount?: number | null;
+    /** Valor de Mídia Estimado (EMV), da Primetag. Ver GD-751. */
+    earnedMediaValue?: number | null;
+    /** @deprecated Usar `earnedMediaValue` (GD-751). Sai na fase de remoção. */
     emv?: number | null;
     engagementCount?: number | null;
     engagementRate?: number | null;
@@ -110,8 +115,17 @@ export declare class Metrics {
     qualifiedEngagementRate?: number | null;
     score?: number | null;
     allocatedBudgetAmount?: number | null;
+    /** Custo por Influência (CPMI): investimento ÷ (alcance × Score) × 1000. Ver GD-751. */
+    costPerInfluency?: number | null;
+    /** @deprecated Usar `costPerInfluency` (GD-751). Sai na fase de remoção. */
     cpmi?: number | null;
+    /** Custo por Mil Impressões (CPM): investimento ÷ impressões × 1000. Ver GD-751. */
+    costPerThousandImpressions?: number | null;
+    /** @deprecated Usar `costPerThousandImpressions` (GD-751). Sai na fase de remoção. */
     cpi?: number | null;
+    /** Custo por Engajamento (CPE): investimento ÷ engajamento. Ver GD-751. */
+    costPerEngagement?: number | null;
+    /** @deprecated Usar `costPerEngagement` (GD-751). Sai na fase de remoção. */
     cpe?: number | null;
     /**
      * Alcance Potencial (o antigo PO Reach): seguidores no momento do post. Em
@@ -154,7 +168,7 @@ export declare const ContentCollabSchema: MongooseSchema<ContentCollab, import("
     __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 declare const CONTENT_BASE_METRIC_KEYS: readonly ["impressionCount", "reachCount", "likeCount", "commentCount", "savedCount", "shareCount", "storyCount", "tapBackCount", "clickCount", "replyCount", "tapForwardCount", "swipeForwardCount", "exitCount", "favoriteCount", "dislikeCount", "earnedMediaValue"];
 export type ContentBaseMetricKey = (typeof CONTENT_BASE_METRIC_KEYS)[number];
 export declare class ContentBaseMetrics {
     impressionCount?: number | null;
@@ -162,6 +176,8 @@ export declare class ContentBaseMetrics {
     likeCount?: number | null;
     commentCount?: number | null;
     savedCount?: number | null;
+    shareCount?: number | null;
+    /** @deprecated Usar `shareCount` (GD-751). Sai na fase de remoção. */
     sharesCount?: number | null;
     storyCount?: number | null;
     tapBackCount?: number | null;
@@ -172,6 +188,9 @@ export declare class ContentBaseMetrics {
     exitCount?: number | null;
     favoriteCount?: number | null;
     dislikeCount?: number | null;
+    /** Valor de Mídia Estimado (EMV), da Primetag. Ver GD-751. */
+    earnedMediaValue?: number | null;
+    /** @deprecated Usar `earnedMediaValue` (GD-751). Sai na fase de remoção. */
     emv?: number | null;
 }
 export declare const ContentBaseMetricsSchema: MongooseSchema<ContentBaseMetrics, import("mongoose").Model<ContentBaseMetrics, any, any, any, import("mongoose").Document<unknown, any, ContentBaseMetrics, any, {}> & ContentBaseMetrics & {
@@ -206,7 +225,9 @@ export declare class ContentVideo {
     duration?: number | null;
     /** Tempo total assistido, somando todas as visualizações, em segundos. */
     watchTime?: number | null;
-    /** (watchTime ÷ duration) ÷ impressionCount, sem teto. */
+    /** Taxa de Conclusão do Vídeo (VCR): (watchTime ÷ duration) ÷ impressionCount, sem teto. Ver GD-751. */
+    videoCompletionRate?: number | null;
+    /** @deprecated Usar `videoCompletionRate` (GD-751). Sai na fase de remoção. */
     vcr?: number | null;
 }
 export declare const ContentVideoSchema: MongooseSchema<ContentVideo, import("mongoose").Model<ContentVideo, any, any, any, import("mongoose").Document<unknown, any, ContentVideo, any, {}> & ContentVideo & {
@@ -231,17 +252,31 @@ export declare const ContentMetricsHistoryEntrySchema: MongooseSchema<ContentMet
 } & {
     __v: number;
 }>;
-export declare class Estimates {
+/** Métricas estimadas pelo porte do perfil, para quando a rede não informa. Ver GD-751. */
+export declare class EstimatedMetrics {
     impressionCount?: number | null;
     reachCount?: number | null;
     engagementCount?: number | null;
     engagementRate?: number | null;
 }
-export declare const EstimatesSchema: MongooseSchema<Estimates, import("mongoose").Model<Estimates, any, any, any, import("mongoose").Document<unknown, any, Estimates, any, {}> & Estimates & {
+export declare const EstimatedMetricsSchema: MongooseSchema<EstimatedMetrics, import("mongoose").Model<EstimatedMetrics, any, any, any, import("mongoose").Document<unknown, any, EstimatedMetrics, any, {}> & EstimatedMetrics & {
     _id: Types.ObjectId;
 } & {
     __v: number;
-}, any>, {}, {}, {}, {}, import("mongoose").DefaultSchemaOptions, Estimates, import("mongoose").Document<unknown, {}, import("mongoose").FlatRecord<Estimates>, {}, import("mongoose").ResolveSchemaOptions<import("mongoose").DefaultSchemaOptions>> & import("mongoose").FlatRecord<Estimates> & {
+}, any>, {}, {}, {}, {}, import("mongoose").DefaultSchemaOptions, EstimatedMetrics, import("mongoose").Document<unknown, {}, import("mongoose").FlatRecord<EstimatedMetrics>, {}, import("mongoose").ResolveSchemaOptions<import("mongoose").DefaultSchemaOptions>> & import("mongoose").FlatRecord<EstimatedMetrics> & {
+    _id: Types.ObjectId;
+} & {
+    __v: number;
+}>;
+/** @deprecated Usar `EstimatedMetrics` (GD-751). */
+export declare class Estimates extends EstimatedMetrics {
+}
+/** @deprecated Usar `EstimatedMetricsSchema` (GD-751). */
+export declare const EstimatesSchema: MongooseSchema<EstimatedMetrics, import("mongoose").Model<EstimatedMetrics, any, any, any, import("mongoose").Document<unknown, any, EstimatedMetrics, any, {}> & EstimatedMetrics & {
+    _id: Types.ObjectId;
+} & {
+    __v: number;
+}, any>, {}, {}, {}, {}, import("mongoose").DefaultSchemaOptions, EstimatedMetrics, import("mongoose").Document<unknown, {}, import("mongoose").FlatRecord<EstimatedMetrics>, {}, import("mongoose").ResolveSchemaOptions<import("mongoose").DefaultSchemaOptions>> & import("mongoose").FlatRecord<EstimatedMetrics> & {
     _id: Types.ObjectId;
 } & {
     __v: number;
@@ -301,7 +336,9 @@ export declare class Content {
      */
     manualMetrics?: string[];
     video?: ContentVideo | null;
-    estimates: Estimates;
+    estimatedMetrics?: EstimatedMetrics | null;
+    /** @deprecated Usar `estimatedMetrics` (GD-751). Sai na fase de remoção. */
+    estimates?: Estimates;
     googleSheetRow?: string;
     createdAt?: Date;
     updatedAt?: Date;

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.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;
+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.EstimatedMetricsSchema = exports.EstimatedMetrics = 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");
@@ -123,6 +123,10 @@ __decorate([
     (0, mongoose_1.Prop)({ type: Number, required: false, default: null }),
     __metadata("design:type", Object)
 ], Metrics.prototype, "savedCount", void 0);
+__decorate([
+    (0, mongoose_1.Prop)({ type: Number, required: false, default: null }),
+    __metadata("design:type", Object)
+], Metrics.prototype, "shareCount", void 0);
 __decorate([
     (0, mongoose_1.Prop)({ type: Number, required: false, default: null }),
     __metadata("design:type", Object)
@@ -163,6 +167,10 @@ __decorate([
     (0, mongoose_1.Prop)({ type: Number, required: false, default: null }),
     __metadata("design:type", Object)
 ], Metrics.prototype, "dislikeCount", void 0);
+__decorate([
+    (0, mongoose_1.Prop)({ type: Number, required: false, default: null }),
+    __metadata("design:type", Object)
+], Metrics.prototype, "earnedMediaValue", void 0);
 __decorate([
     (0, mongoose_1.Prop)({ type: Number, required: false, default: null }),
     __metadata("design:type", Object)
@@ -195,14 +203,26 @@ __decorate([
     (0, mongoose_1.Prop)({ type: Number, required: false, default: null }),
     __metadata("design:type", Object)
 ], Metrics.prototype, "allocatedBudgetAmount", void 0);
+__decorate([
+    (0, mongoose_1.Prop)({ type: Number, required: false, default: null }),
+    __metadata("design:type", Object)
+], Metrics.prototype, "costPerInfluency", void 0);
 __decorate([
     (0, mongoose_1.Prop)({ type: Number, required: false, default: null }),
     __metadata("design:type", Object)
 ], Metrics.prototype, "cpmi", void 0);
+__decorate([
+    (0, mongoose_1.Prop)({ type: Number, required: false, default: null }),
+    __metadata("design:type", Object)
+], Metrics.prototype, "costPerThousandImpressions", void 0);
 __decorate([
     (0, mongoose_1.Prop)({ type: Number, required: false, default: null }),
     __metadata("design:type", Object)
 ], Metrics.prototype, "cpi", void 0);
+__decorate([
+    (0, mongoose_1.Prop)({ type: Number, required: false, default: null }),
+    __metadata("design:type", Object)
+], Metrics.prototype, "costPerEngagement", void 0);
 __decorate([
     (0, mongoose_1.Prop)({ type: Number, required: false, default: null }),
     __metadata("design:type", Object)
@@ -255,7 +275,7 @@ exports.CONTENT_BASE_METRIC_KEYS = [
     'likeCount',
     'commentCount',
     'savedCount',
-    'sharesCount',
+    'shareCount',
     'storyCount',
     'tapBackCount',
     'clickCount',
@@ -265,7 +285,7 @@ exports.CONTENT_BASE_METRIC_KEYS = [
     'exitCount',
     'favoriteCount',
     'dislikeCount',
-    'emv',
+    'earnedMediaValue',
 ];
 let ContentBaseMetrics = class ContentBaseMetrics {
 };
@@ -289,6 +309,10 @@ __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, "shareCount", void 0);
 __decorate([
     (0, mongoose_1.Prop)({ type: Number, required: false, default: null }),
     __metadata("design:type", Object)
@@ -329,6 +353,10 @@ __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, "earnedMediaValue", void 0);
 __decorate([
     (0, mongoose_1.Prop)({ type: Number, required: false, default: null }),
     __metadata("design:type", Object)
@@ -368,6 +396,10 @@ __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, "videoCompletionRate", void 0);
 __decorate([
     (0, mongoose_1.Prop)({ type: Number, required: false, default: null }),
     __metadata("design:type", Object)
@@ -392,29 +424,36 @@ ContentMetricsHistoryEntry = __decorate([
 ], ContentMetricsHistoryEntry);
 exports.ContentMetricsHistoryEntry = ContentMetricsHistoryEntry;
 exports.ContentMetricsHistoryEntrySchema = mongoose_1.SchemaFactory.createForClass(ContentMetricsHistoryEntry);
-let Estimates = class Estimates {
+/** Métricas estimadas pelo porte do perfil, para quando a rede não informa. Ver GD-751. */
+let EstimatedMetrics = class EstimatedMetrics {
 };
 __decorate([
     (0, mongoose_1.Prop)({ type: Number, required: true, default: null }),
     __metadata("design:type", Object)
-], Estimates.prototype, "impressionCount", void 0);
+], EstimatedMetrics.prototype, "impressionCount", void 0);
 __decorate([
     (0, mongoose_1.Prop)({ type: Number, required: true, default: null }),
     __metadata("design:type", Object)
-], Estimates.prototype, "reachCount", void 0);
+], EstimatedMetrics.prototype, "reachCount", void 0);
 __decorate([
     (0, mongoose_1.Prop)({ type: Number, required: true, default: null }),
     __metadata("design:type", Object)
-], Estimates.prototype, "engagementCount", void 0);
+], EstimatedMetrics.prototype, "engagementCount", void 0);
 __decorate([
     (0, mongoose_1.Prop)({ type: Number, required: true, default: null }),
     __metadata("design:type", Object)
-], Estimates.prototype, "engagementRate", void 0);
-Estimates = __decorate([
+], EstimatedMetrics.prototype, "engagementRate", void 0);
+EstimatedMetrics = __decorate([
     (0, mongoose_1.Schema)({ _id: false })
-], Estimates);
+], EstimatedMetrics);
+exports.EstimatedMetrics = EstimatedMetrics;
+exports.EstimatedMetricsSchema = mongoose_1.SchemaFactory.createForClass(EstimatedMetrics);
+/** @deprecated Usar `EstimatedMetrics` (GD-751). */
+class Estimates extends EstimatedMetrics {
+}
 exports.Estimates = Estimates;
-exports.EstimatesSchema = mongoose_1.SchemaFactory.createForClass(Estimates);
+/** @deprecated Usar `EstimatedMetricsSchema` (GD-751). */
+exports.EstimatesSchema = exports.EstimatedMetricsSchema;
 // error: captura de comentários falhou ou a classificação falhou por inteiro.
 // partial_error: parte dos comentários não foi classificada. Nenhum dos dois
 // volta sozinho pro pipeline — só por reenvio manual (aprovação).
@@ -576,7 +615,11 @@ __decorate([
     __metadata("design:type", Object)
 ], Content.prototype, "video", void 0);
 __decorate([
-    (0, mongoose_1.Prop)({ type: exports.MetricsSchema, required: true }),
+    (0, mongoose_1.Prop)({ type: exports.EstimatedMetricsSchema, required: false, default: null }),
+    __metadata("design:type", Object)
+], Content.prototype, "estimatedMetrics", void 0);
+__decorate([
+    (0, mongoose_1.Prop)({ type: exports.MetricsSchema, required: false }),
     __metadata("design:type", Estimates)
 ], Content.prototype, "estimates", void 0);
 __decorate([

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

@@ -3,7 +3,7 @@ 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 ENGAGEMENT_KEYS = ['likeCount', 'commentCount', 'shareCount', '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.

package/package.json

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

package/src/schemas/action.schema.ts

@@ -68,6 +68,17 @@ export const ACTION_STATUS_VALUES = [
 ] as const;
 export type ActionStatus = (typeof ACTION_STATUS_VALUES)[number];
 
+/**
+ * Tipo da Ação (Action.type). O nome evita confusão com o ACTION_TYPE_VALUES
+ * do shared-app-modules, que é partnership. Ver GD-711.
+ * - influency: Influência (antes "creator", "Creators Pago");
+ * - organic: Orgânicos do mês da Samsung (GD-699/GD-711);
+ * - annual: Ação anual da Samsung, fora da captura diária, atualizada só pelo
+ *   modo metrics-only do content-capture-worker.
+ */
+export const ACTION_KIND_VALUES = ['seeding', 'ugc', 'influency', 'organic', 'annual'] as const;
+export type ActionKind = (typeof ACTION_KIND_VALUES)[number];
+
 /**
  * Fase da Ação (antigo briefing do genc). Com `_id` porque o Conteúdo aponta
  * para ela (`Content.phase`). Período e hashtags opcionais fazem a captura
@@ -149,10 +160,10 @@ export class Action {
   @Prop({ type: String, enum: ['partner', 'exclusive'], required: true })
   partnership: 'partner' | 'exclusive';
 
-  /** organic = Orgânicos do mês: post aprovado numa Ação de produto sai dela. Ver GD-699. */
-  @ApiProperty({ enum: ['seeding', 'ugc', 'creator', 'organic'], example: 'seeding' })
-  @Prop({ type: String, enum: ['seeding', 'ugc', 'creator', 'organic'], required: true })
-  type: 'seeding' | 'ugc' | 'creator' | 'organic';
+  /** Ver ACTION_KIND_VALUES. organic: post aprovado numa Ação de produto sai dela (GD-699). */
+  @ApiProperty({ enum: ACTION_KIND_VALUES, example: 'seeding' })
+  @Prop({ type: String, enum: ACTION_KIND_VALUES, required: true })
+  type: ActionKind;
 
   @ApiProperty({ example: ['instagram', 'tiktok'], required: false })
   @Prop({ type: [String], required: false })

package/src/schemas/benchmark.schema.ts

@@ -2,7 +2,14 @@ import { Prop, Schema, SchemaFactory } from '@nestjs/mongoose';
 import { HydratedDocument, Schema as MongooseSchema, Types, model as MongooseModel } from 'mongoose';
 import { Client } from './client.schema';
 
-export type BenchmarkMetric = 'reach' | 'er' | 'cpi' | 'cpe';
+/**
+ * Métrica do benchmark. Nomes por extenso (GD-751); os antigos (`er`, `cpi`,
+ * `cpe`) ficam aceitos só durante a virada e saem na fase de remoção.
+ */
+export const BENCHMARK_METRIC_VALUES = ['reach', 'engagementRate', 'costPerThousandImpressions', 'costPerEngagement'] as const;
+export type BenchmarkMetric = (typeof BENCHMARK_METRIC_VALUES)[number];
+/** @deprecated Nomes antigos aceitos só na virada (GD-751). */
+export const LEGACY_BENCHMARK_METRIC_VALUES = ['er', 'cpi', 'cpe', 'costPerImpression'] as const;
 export type BenchmarkMode = 'organic' | 'paid';
 export type BenchmarkDocument = HydratedDocument<Benchmark>;
 
@@ -17,7 +24,7 @@ export class Benchmark {
   @Prop({ type: String, enum: ['organic', 'paid'], required: true })
   mode: BenchmarkMode;
 
-  @Prop({ type: String, enum: ['reach', 'er', 'cpi', 'cpe'], required: true })
+  @Prop({ type: String, enum: [...BENCHMARK_METRIC_VALUES, ...LEGACY_BENCHMARK_METRIC_VALUES], required: true })
   metric: BenchmarkMetric;
 
   @Prop({ type: Number, required: true })

package/src/schemas/client.schema.ts

@@ -34,14 +34,14 @@ export const CLIENT_GOAL_METRIC_VALUES = [
   'reachEngagementRate',
   'qualifiedEngagementRate',
   'effectiveReach',
-  'emv',
+  'earnedMediaValue',
   'score',
-  'cpmi',
-  'cpi',
-  'cpe',
+  'costPerInfluency',
+  'costPerImpact',
+  'costPerEngagement',
   'savedCount',
-  'sharesCount',
-  'vcr',
+  'shareCount',
+  'videoCompletionRate',
   'viralReachEngagementRate',
 ] as const;
 export type ClientGoalMetric = (typeof CLIENT_GOAL_METRIC_VALUES)[number];
@@ -58,14 +58,14 @@ export const CLIENT_GOAL_METRIC_UNITS: Record<ClientGoalMetric, ClientGoalMetric
   reachEngagementRate: 'rate',
   qualifiedEngagementRate: 'rate',
   effectiveReach: 'count',
-  emv: 'currency',
+  earnedMediaValue: 'currency',
   score: 'count',
-  cpmi: 'currency',
-  cpi: 'currency',
-  cpe: 'currency',
+  costPerInfluency: 'currency',
+  costPerImpact: 'currency',
+  costPerEngagement: 'currency',
   savedCount: 'count',
-  sharesCount: 'count',
-  vcr: 'rate',
+  shareCount: 'count',
+  videoCompletionRate: 'rate',
   viralReachEngagementRate: 'rate',
 };
 

package/src/schemas/content-capture-process.schema.ts

@@ -34,7 +34,7 @@ export class ContentCaptureProcessMetrics {
   sentimentNeutral?: number | null;
 
   @Prop({ type: Number, required: false, default: null })
-  emv?: number | null;
+  earnedMediaValue?: number | null;
 }
 
 export const ContentCaptureProcessMetricsSchema = SchemaFactory.createForClass(

package/src/schemas/content.schema.ts

@@ -93,6 +93,10 @@ export class Metrics {
   @Prop({ type: Number, required: false, default: null })
   savedCount?: number | null;
 
+  @Prop({ type: Number, required: false, default: null })
+  shareCount?: number | null;
+
+  /** @deprecated Usar `shareCount` (GD-751). Sai na fase de remoção. */
   @Prop({ type: Number, required: false, default: null })
   sharesCount?: number | null;
 
@@ -123,6 +127,11 @@ export class Metrics {
   @Prop({ type: Number, required: false, default: null })
   dislikeCount?: number | null;
 
+  /** Valor de Mídia Estimado (EMV), da Primetag. Ver GD-751. */
+  @Prop({ type: Number, required: false, default: null })
+  earnedMediaValue?: number | null;
+
+  /** @deprecated Usar `earnedMediaValue` (GD-751). Sai na fase de remoção. */
   @Prop({ type: Number, required: false, default: null })
   emv?: number | null;
 
@@ -149,12 +158,27 @@ export class Metrics {
   @Prop({ type: Number, required: false, default: null })
   allocatedBudgetAmount?: number | null;
 
+  /** Custo por Influência (CPMI): investimento ÷ (alcance × Score) × 1000. Ver GD-751. */
+  @Prop({ type: Number, required: false, default: null })
+  costPerInfluency?: number | null;
+
+  /** @deprecated Usar `costPerInfluency` (GD-751). Sai na fase de remoção. */
   @Prop({ type: Number, required: false, default: null })
   cpmi?: number | null;
 
+  /** Custo por Mil Impressões (CPM): investimento ÷ impressões × 1000. Ver GD-751. */
+  @Prop({ type: Number, required: false, default: null })
+  costPerThousandImpressions?: number | null;
+
+  /** @deprecated Usar `costPerThousandImpressions` (GD-751). Sai na fase de remoção. */
   @Prop({ type: Number, required: false, default: null })
   cpi?: number | null;
 
+  /** Custo por Engajamento (CPE): investimento ÷ engajamento. Ver GD-751. */
+  @Prop({ type: Number, required: false, default: null })
+  costPerEngagement?: number | null;
+
+  /** @deprecated Usar `costPerEngagement` (GD-751). Sai na fase de remoção. */
   @Prop({ type: Number, required: false, default: null })
   cpe?: number | null;
 
@@ -206,7 +230,7 @@ export const CONTENT_BASE_METRIC_KEYS = [
   'likeCount',
   'commentCount',
   'savedCount',
-  'sharesCount',
+  'shareCount',
   'storyCount',
   'tapBackCount',
   'clickCount',
@@ -216,7 +240,7 @@ export const CONTENT_BASE_METRIC_KEYS = [
   'exitCount',
   'favoriteCount',
   'dislikeCount',
-  'emv',
+  'earnedMediaValue',
 ] as const;
 export type ContentBaseMetricKey = (typeof CONTENT_BASE_METRIC_KEYS)[number];
 
@@ -237,6 +261,10 @@ export class ContentBaseMetrics {
   @Prop({ type: Number, required: false, default: null })
   savedCount?: number | null;
 
+  @Prop({ type: Number, required: false, default: null })
+  shareCount?: number | null;
+
+  /** @deprecated Usar `shareCount` (GD-751). Sai na fase de remoção. */
   @Prop({ type: Number, required: false, default: null })
   sharesCount?: number | null;
 
@@ -267,6 +295,11 @@ export class ContentBaseMetrics {
   @Prop({ type: Number, required: false, default: null })
   dislikeCount?: number | null;
 
+  /** Valor de Mídia Estimado (EMV), da Primetag. Ver GD-751. */
+  @Prop({ type: Number, required: false, default: null })
+  earnedMediaValue?: number | null;
+
+  /** @deprecated Usar `earnedMediaValue` (GD-751). Sai na fase de remoção. */
   @Prop({ type: Number, required: false, default: null })
   emv?: number | null;
 }
@@ -299,7 +332,11 @@ export class ContentVideo {
   @Prop({ type: Number, required: false, default: null })
   watchTime?: number | null;
 
-  /** (watchTime ÷ duration) ÷ impressionCount, sem teto. */
+  /** Taxa de Conclusão do Vídeo (VCR): (watchTime ÷ duration) ÷ impressionCount, sem teto. Ver GD-751. */
+  @Prop({ type: Number, required: false, default: null })
+  videoCompletionRate?: number | null;
+
+  /** @deprecated Usar `videoCompletionRate` (GD-751). Sai na fase de remoção. */
   @Prop({ type: Number, required: false, default: null })
   vcr?: number | null;
 }
@@ -317,8 +354,9 @@ export class ContentMetricsHistoryEntry {
 
 export const ContentMetricsHistoryEntrySchema = SchemaFactory.createForClass(ContentMetricsHistoryEntry);
 
+/** Métricas estimadas pelo porte do perfil, para quando a rede não informa. Ver GD-751. */
 @Schema({ _id: false })
-export class Estimates {
+export class EstimatedMetrics {
   @Prop({ type: Number, required: true, default: null })
   impressionCount?: number | null;
 
@@ -332,7 +370,12 @@ export class Estimates {
   engagementRate?: number | null;
 }
 
-export const EstimatesSchema = SchemaFactory.createForClass(Estimates);
+export const EstimatedMetricsSchema = SchemaFactory.createForClass(EstimatedMetrics);
+
+/** @deprecated Usar `EstimatedMetrics` (GD-751). */
+export class Estimates extends EstimatedMetrics {}
+/** @deprecated Usar `EstimatedMetricsSchema` (GD-751). */
+export const EstimatesSchema = EstimatedMetricsSchema;
 
 // error: captura de comentários falhou ou a classificação falhou por inteiro.
 // partial_error: parte dos comentários não foi classificada. Nenhum dos dois
@@ -496,8 +539,12 @@ export class Content {
   @Prop({ type: ContentVideoSchema, required: false, default: null })
   video?: ContentVideo | null;
 
-  @Prop({ type: MetricsSchema, required: true })
-  estimates: Estimates;
+  @Prop({ type: EstimatedMetricsSchema, required: false, default: null })
+  estimatedMetrics?: EstimatedMetrics | null;
+
+  /** @deprecated Usar `estimatedMetrics` (GD-751). Sai na fase de remoção. */
+  @Prop({ type: MetricsSchema, required: false })
+  estimates?: Estimates;
 
   @Prop({ type: String, required: false })
   googleSheetRow?: string;

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

@@ -7,7 +7,7 @@ import {
 } 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 ENGAGEMENT_KEYS: ContentBaseMetricKey[] = ['likeCount', 'commentCount', 'shareCount', 'savedCount'];
 
 const sumParts = (organic?: number | null, boosted?: number | null): number | null =>
   organic == null && boosted == null ? null : (organic ?? 0) + (boosted ?? 0);