@grapadigital/shared-schemas 1.0.222 → 1.0.224

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

@@ -122,37 +122,19 @@ export declare class Metrics {
     reachEngagementRate?: number | null;
     /** Tx. de Engaj. por Seguidores: engagementCount ÷ potentialReach (fração). Ver GD-703. */
     followersEngagementRate?: number | 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;
-} & {
-    __v: number;
-}, any>, {}, {}, {}, {}, import("mongoose").DefaultSchemaOptions, Metrics, import("mongoose").Document<unknown, {}, import("mongoose").FlatRecord<Metrics>, {}, import("mongoose").ResolveSchemaOptions<import("mongoose").DefaultSchemaOptions>> & import("mongoose").FlatRecord<Metrics> & {
-    _id: Types.ObjectId;
-} & {
-    __v: number;
-}>;
-/**
- * Métricas que dependem dos seguidores de uma pessoa do post (autor ou
- * coautor). As brutas ficam uma vez só em Content.metrics. Ver GD-703.
- */
-export declare class ContentPersonMetrics {
-    potentialReach?: number | null;
-    followersEngagementRate?: number | null;
-    effectiveReach?: number | null;
-    reachPerformance?: number | null;
-    qualifiedEngagementRate?: number | null;
-    score?: number | null;
-    /** Nome do Client.tiers da pessoa; null sem Tiers ou fora das faixas. */
+    /** Nome do Client.tiers pelo potentialReach do post; null sem Tiers ou fora das faixas. Ver GD-703. */
     tier?: string | null;
-    /** reachEngagementRate ≥ meta viralReachEngagementRate do Tier; null sem Tier ou sem a meta. */
+    /**
+     * 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 ContentPersonMetricsSchema: MongooseSchema<ContentPersonMetrics, import("mongoose").Model<ContentPersonMetrics, any, any, any, import("mongoose").Document<unknown, any, ContentPersonMetrics, any, {}> & ContentPersonMetrics & {
+export declare const MetricsSchema: MongooseSchema<Metrics, import("mongoose").Model<Metrics, any, any, any, import("mongoose").Document<unknown, any, Metrics, any, {}> & Metrics & {
     _id: Types.ObjectId;
 } & {
     __v: number;
-}, any>, {}, {}, {}, {}, import("mongoose").DefaultSchemaOptions, ContentPersonMetrics, import("mongoose").Document<unknown, {}, import("mongoose").FlatRecord<ContentPersonMetrics>, {}, import("mongoose").ResolveSchemaOptions<import("mongoose").DefaultSchemaOptions>> & import("mongoose").FlatRecord<ContentPersonMetrics> & {
+}, any>, {}, {}, {}, {}, import("mongoose").DefaultSchemaOptions, Metrics, import("mongoose").Document<unknown, {}, import("mongoose").FlatRecord<Metrics>, {}, import("mongoose").ResolveSchemaOptions<import("mongoose").DefaultSchemaOptions>> & import("mongoose").FlatRecord<Metrics> & {
     _id: Types.ObjectId;
 } & {
     __v: number;
@@ -161,7 +143,6 @@ export declare const ContentPersonMetricsSchema: MongooseSchema<ContentPersonMet
 export declare class ContentCollab {
     profile: Types.ObjectId | Profile;
     followersAtPost?: number | null;
-    metrics?: ContentPersonMetrics | 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;
@@ -311,9 +292,7 @@ export declare class Content {
     hasAffiliateLink: boolean;
     /** Coautores do post; isCollab = collabs.length > 0. Ver GD-703. */
     collabs?: ContentCollab[];
-    /** Métricas do autor, com os seguidores dele (followersAtPost). Ver GD-703. */
-    profileMetrics?: ContentPersonMetrics | null;
-    /** Visão da Ação: brutas uma vez só e derivadas com o potentialReach somado. */
+    /** Métricas do post (sem métrica por pessoa): derivadas com o potentialReach somado. Ver GD-703. */
     metrics: Metrics;
     metricsBreakdown?: ContentMetricsBreakdown | null;
     /**
@@ -355,6 +334,18 @@ export declare class Content {
      * junto. Ver GD-699.
      */
     linkKey?: string | null;
+    /**
+     * Quando a edição pediu o recálculo das métricas (api-campaigns). A tela
+     * mostra "Recalculando…" enquanto for mais novo que metricsCalculatedAt.
+     * Ver GD-705.
+     */
+    metricsRequestedAt?: Date | null;
+    /**
+     * metricsRequestedAt que o metrics-generator-worker atendeu, gravado ao
+     * terminar o recálculo (não a hora do fim: um pedido que chegou durante o
+     * cálculo continua pendente). Ver GD-705.
+     */
+    metricsCalculatedAt?: Date | null;
 }
 export declare const ContentSchema: MongooseSchema<Content, import("mongoose").Model<Content, any, any, any, import("mongoose").Document<unknown, any, Content, any, {}> & Content & Required<{
     _id: Types.ObjectId;

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.ContentPersonMetricsSchema = exports.ContentPersonMetrics = 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");
@@ -219,54 +219,19 @@ __decorate([
     (0, mongoose_1.Prop)({ type: Number, required: false, default: null }),
     __metadata("design:type", Object)
 ], Metrics.prototype, "followersEngagementRate", void 0);
-Metrics = __decorate([
-    (0, mongoose_1.Schema)({ _id: false })
-], Metrics);
-exports.Metrics = Metrics;
-exports.MetricsSchema = mongoose_1.SchemaFactory.createForClass(Metrics);
-/**
- * Métricas que dependem dos seguidores de uma pessoa do post (autor ou
- * coautor). As brutas ficam uma vez só em Content.metrics. Ver GD-703.
- */
-let ContentPersonMetrics = class ContentPersonMetrics {
-};
-__decorate([
-    (0, mongoose_1.Prop)({ type: Number, required: false, default: null }),
-    __metadata("design:type", Object)
-], ContentPersonMetrics.prototype, "potentialReach", void 0);
-__decorate([
-    (0, mongoose_1.Prop)({ type: Number, required: false, default: null }),
-    __metadata("design:type", Object)
-], ContentPersonMetrics.prototype, "followersEngagementRate", void 0);
-__decorate([
-    (0, mongoose_1.Prop)({ type: Number, required: false, default: null }),
-    __metadata("design:type", Object)
-], ContentPersonMetrics.prototype, "effectiveReach", void 0);
-__decorate([
-    (0, mongoose_1.Prop)({ type: Number, required: false, default: null }),
-    __metadata("design:type", Object)
-], ContentPersonMetrics.prototype, "reachPerformance", void 0);
-__decorate([
-    (0, mongoose_1.Prop)({ type: Number, required: false, default: null }),
-    __metadata("design:type", Object)
-], ContentPersonMetrics.prototype, "qualifiedEngagementRate", void 0);
-__decorate([
-    (0, mongoose_1.Prop)({ type: Number, required: false, default: null }),
-    __metadata("design:type", Object)
-], ContentPersonMetrics.prototype, "score", void 0);
 __decorate([
     (0, mongoose_1.Prop)({ type: String, required: false, default: null }),
     __metadata("design:type", Object)
-], ContentPersonMetrics.prototype, "tier", void 0);
+], Metrics.prototype, "tier", void 0);
 __decorate([
     (0, mongoose_1.Prop)({ type: Boolean, required: false, default: null }),
     __metadata("design:type", Object)
-], ContentPersonMetrics.prototype, "isViral", void 0);
-ContentPersonMetrics = __decorate([
+], Metrics.prototype, "isViral", void 0);
+Metrics = __decorate([
     (0, mongoose_1.Schema)({ _id: false })
-], ContentPersonMetrics);
-exports.ContentPersonMetrics = ContentPersonMetrics;
-exports.ContentPersonMetricsSchema = mongoose_1.SchemaFactory.createForClass(ContentPersonMetrics);
+], 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 {
 };
@@ -278,10 +243,6 @@ __decorate([
     (0, mongoose_1.Prop)({ type: Number, required: false, default: null }),
     __metadata("design:type", Object)
 ], ContentCollab.prototype, "followersAtPost", void 0);
-__decorate([
-    (0, mongoose_1.Prop)({ type: exports.ContentPersonMetricsSchema, required: false, default: null }),
-    __metadata("design:type", Object)
-], ContentCollab.prototype, "metrics", void 0);
 ContentCollab = __decorate([
     (0, mongoose_1.Schema)({ _id: false })
 ], ContentCollab);
@@ -598,10 +559,6 @@ __decorate([
     (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.ContentPersonMetricsSchema, required: false, default: null }),
-    __metadata("design:type", Object)
-], Content.prototype, "profileMetrics", void 0);
 __decorate([
     (0, mongoose_1.Prop)({ type: exports.MetricsSchema, required: true }),
     __metadata("design:type", Metrics)
@@ -694,6 +651,14 @@ __decorate([
     (0, mongoose_1.Prop)({ type: String, required: false, default: null }),
     __metadata("design:type", Object)
 ], Content.prototype, "linkKey", void 0);
+__decorate([
+    (0, mongoose_1.Prop)({ type: Date, required: false, default: null }),
+    __metadata("design:type", Object)
+], Content.prototype, "metricsRequestedAt", void 0);
+__decorate([
+    (0, mongoose_1.Prop)({ type: Date, required: false, default: null }),
+    __metadata("design:type", Object)
+], Content.prototype, "metricsCalculatedAt", void 0);
 Content = __decorate([
     (0, mongoose_1.Schema)({ timestamps: true })
 ], Content);

package/package.json

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

package/src/schemas/content.schema.ts

@@ -172,44 +172,20 @@ export class Metrics {
   /** Tx. de Engaj. por Seguidores: engagementCount ÷ potentialReach (fração). Ver GD-703. */
   @Prop({ type: Number, required: false, default: null })
   followersEngagementRate?: number | null;
-}
-
-export const MetricsSchema = SchemaFactory.createForClass(Metrics);
-
-/**
- * Métricas que dependem dos seguidores de uma pessoa do post (autor ou
- * coautor). As brutas ficam uma vez só em Content.metrics. Ver GD-703.
- */
-@Schema({ _id: false })
-export class ContentPersonMetrics {
-  @Prop({ type: Number, required: false, default: null })
-  potentialReach?: number | null;
 
-  @Prop({ type: Number, required: false, default: null })
-  followersEngagementRate?: number | null;
-
-  @Prop({ type: Number, required: false, default: null })
-  effectiveReach?: number | null;
-
-  @Prop({ type: Number, required: false, default: null })
-  reachPerformance?: number | null;
-
-  @Prop({ type: Number, required: false, default: null })
-  qualifiedEngagementRate?: number | null;
-
-  @Prop({ type: Number, required: false, default: null })
-  score?: number | null;
-
-  /** Nome do Client.tiers da pessoa; null sem Tiers ou fora das faixas. */
+  /** 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;
 
-  /** reachEngagementRate ≥ meta viralReachEngagementRate do Tier; null sem Tier ou sem a meta. */
+  /**
+   * 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 ContentPersonMetricsSchema = SchemaFactory.createForClass(ContentPersonMetrics);
+export const MetricsSchema = SchemaFactory.createForClass(Metrics);
 
 /** Coautor do post (Colab), com os seguidores dele no momento do post. Ver GD-703. */
 @Schema({ _id: false })
@@ -219,9 +195,6 @@ export class ContentCollab {
 
   @Prop({ type: Number, required: false, default: null })
   followersAtPost?: number | null;
-
-  @Prop({ type: ContentPersonMetricsSchema, required: false, default: null })
-  metrics?: ContentPersonMetrics | null;
 }
 
 export const ContentCollabSchema = SchemaFactory.createForClass(ContentCollab);
@@ -506,11 +479,7 @@ export class Content {
   @Prop({ type: [ContentCollabSchema], required: false, default: [] })
   collabs?: ContentCollab[];
 
-  /** Métricas do autor, com os seguidores dele (followersAtPost). Ver GD-703. */
-  @Prop({ type: ContentPersonMetricsSchema, required: false, default: null })
-  profileMetrics?: ContentPersonMetrics | null;
-
-  /** Visão da Ação: brutas uma vez só e derivadas com o potentialReach somado. */
+  /** Métricas do post (sem métrica por pessoa): derivadas com o potentialReach somado. Ver GD-703. */
   @Prop({ type: MetricsSchema, required: true })
   metrics: Metrics;
 
@@ -604,6 +573,22 @@ export class Content {
    */
   @Prop({ type: String, required: false, default: null })
   linkKey?: string | null;
+
+  /**
+   * Quando a edição pediu o recálculo das métricas (api-campaigns). A tela
+   * mostra "Recalculando…" enquanto for mais novo que metricsCalculatedAt.
+   * Ver GD-705.
+   */
+  @Prop({ type: Date, required: false, default: null })
+  metricsRequestedAt?: Date | null;
+
+  /**
+   * metricsRequestedAt que o metrics-generator-worker atendeu, gravado ao
+   * terminar o recálculo (não a hora do fim: um pedido que chegou durante o
+   * cálculo continua pendente). Ver GD-705.
+   */
+  @Prop({ type: Date, required: false, default: null })
+  metricsCalculatedAt?: Date | null;
 }
 
 export const ContentSchema = SchemaFactory.createForClass(Content);