@grapadigital/shared-schemas 1.0.218 → 1.0.219

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

@@ -34,6 +34,17 @@ export type ClientDocument = HydratedDocument<Client>;
  */
 export declare const CLIENT_CUSTOMIZATION_VALUES: readonly ["samsung"];
 export type ClientCustomization = (typeof CLIENT_CUSTOMIZATION_VALUES)[number];
+/**
+ * Catálogo de métricas que podem virar meta no Tier ou na Meta anual do
+ * cliente. Quem cadastra escolhe a métrica e o valor; nada fica fixo.
+ * `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", "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%). */
+export declare const CLIENT_GOAL_METRIC_UNITS: Record<ClientGoalMetric, ClientGoalMetricUnit>;
 export declare class Cluster {
     key: string;
     label: string;
@@ -74,6 +85,56 @@ export declare const CommissionRangeSchema: MongooseSchema<CommissionRange, impo
 } & {
     __v: number;
 }>;
+export declare class ClientMetricGoal {
+    metric: ClientGoalMetric;
+    /** Na unidade da métrica (`CLIENT_GOAL_METRIC_UNITS`); `rate` em fração. */
+    value: number;
+}
+export declare const ClientMetricGoalSchema: MongooseSchema<ClientMetricGoal, import("mongoose").Model<ClientMetricGoal, any, any, any, import("mongoose").Document<unknown, any, ClientMetricGoal, any, {}> & ClientMetricGoal & {
+    _id: Types.ObjectId;
+} & {
+    __v: number;
+}, any>, {}, {}, {}, {}, import("mongoose").DefaultSchemaOptions, ClientMetricGoal, import("mongoose").Document<unknown, {}, import("mongoose").FlatRecord<ClientMetricGoal>, {}, import("mongoose").ResolveSchemaOptions<import("mongoose").DefaultSchemaOptions>> & import("mongoose").FlatRecord<ClientMetricGoal> & {
+    _id: Types.ObjectId;
+} & {
+    __v: number;
+}>;
+/**
+ * Faixa de seguidores do cliente com as metas dela (ex.: Micro, Macro, Hero,
+ * Icon da Samsung). O Tier é do cliente, não do Influenciador: para mudar a
+ * meta, edita o Tier. Faixas inclusivas nas duas pontas, contínuas e sem
+ * sobreposição (validado na api-entities). Ver GD-687.
+ */
+export declare class ClientTier {
+    name: string;
+    minFollowers: number;
+    /** `null` = sem teto (só o último Tier). */
+    maxFollowers?: number | null;
+    goals: ClientMetricGoal[];
+}
+export declare const ClientTierSchema: MongooseSchema<ClientTier, import("mongoose").Model<ClientTier, any, any, any, import("mongoose").Document<unknown, any, ClientTier, any, {}> & ClientTier & {
+    _id: Types.ObjectId;
+} & {
+    __v: number;
+}, any>, {}, {}, {}, {}, import("mongoose").DefaultSchemaOptions, ClientTier, import("mongoose").Document<unknown, {}, import("mongoose").FlatRecord<ClientTier>, {}, import("mongoose").ResolveSchemaOptions<import("mongoose").DefaultSchemaOptions>> & import("mongoose").FlatRecord<ClientTier> & {
+    _id: Types.ObjectId;
+} & {
+    __v: number;
+}>;
+/** Metas do cliente num ano (alimentam os cards do gen_ia). Ver GD-687. */
+export declare class ClientAnnualGoal {
+    year: number;
+    goals: ClientMetricGoal[];
+}
+export declare const ClientAnnualGoalSchema: MongooseSchema<ClientAnnualGoal, import("mongoose").Model<ClientAnnualGoal, any, any, any, import("mongoose").Document<unknown, any, ClientAnnualGoal, any, {}> & ClientAnnualGoal & {
+    _id: Types.ObjectId;
+} & {
+    __v: number;
+}, any>, {}, {}, {}, {}, import("mongoose").DefaultSchemaOptions, ClientAnnualGoal, import("mongoose").Document<unknown, {}, import("mongoose").FlatRecord<ClientAnnualGoal>, {}, import("mongoose").ResolveSchemaOptions<import("mongoose").DefaultSchemaOptions>> & import("mongoose").FlatRecord<ClientAnnualGoal> & {
+    _id: Types.ObjectId;
+} & {
+    __v: number;
+}>;
 export declare class AgencyCommissionPeriod {
     ranges: CommissionRange[];
     startDate: Date;
@@ -149,6 +210,10 @@ export declare class Client extends Party {
      * Ver GD-683.
      */
     customization?: ClientCustomization | null;
+    /** Tiers do cliente (só com Personalização Samsung por enquanto). Ver GD-687. */
+    tiers: ClientTier[];
+    /** Metas anuais do cliente (só com Personalização Samsung por enquanto). Ver GD-687. */
+    annualGoals: ClientAnnualGoal[];
     /**
      * Client de organização (ex.: "Oma Creators"): representa a organização
      * inteira, não uma marca. No hub, mostra todas as actions dessa organização

package/dist/schemas/client.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.ClientModel = exports.ClientSchema = exports.Client = exports.ClientResponsibleSchema = exports.ClientResponsible = exports.NicheItemSchema = exports.NicheItem = exports.AgencyCommissionPeriodSchema = exports.AgencyCommissionPeriod = exports.CommissionRangeSchema = exports.CommissionRange = exports.CompanySchema = exports.Company = exports.ClusterSchema = exports.Cluster = exports.CLIENT_CUSTOMIZATION_VALUES = void 0;
+exports.ClientModel = exports.ClientSchema = exports.Client = exports.ClientResponsibleSchema = exports.ClientResponsible = exports.NicheItemSchema = exports.NicheItem = exports.AgencyCommissionPeriodSchema = exports.AgencyCommissionPeriod = exports.ClientAnnualGoalSchema = exports.ClientAnnualGoal = exports.ClientTierSchema = exports.ClientTier = exports.ClientMetricGoalSchema = exports.ClientMetricGoal = exports.CommissionRangeSchema = exports.CommissionRange = exports.CompanySchema = exports.Company = exports.ClusterSchema = exports.Cluster = exports.CLIENT_GOAL_METRIC_UNITS = exports.CLIENT_GOAL_METRIC_VALUES = exports.CLIENT_CUSTOMIZATION_VALUES = void 0;
 const mongoose_1 = require("@nestjs/mongoose");
 const swagger_1 = require("@nestjs/swagger");
 const mongoose_2 = require("mongoose");
@@ -20,6 +20,45 @@ const responsible_schema_1 = require("./responsible.schema");
  * Ver GD-683.
  */
 exports.CLIENT_CUSTOMIZATION_VALUES = ['samsung'];
+/**
+ * Catálogo de métricas que podem virar meta no Tier ou na Meta anual do
+ * cliente. Quem cadastra escolhe a métrica e o valor; nada fica fixo.
+ * `viralReachEngagementRate` é o limite de viral e só vale no Tier.
+ * Ver GD-687.
+ */
+exports.CLIENT_GOAL_METRIC_VALUES = [
+    'potentialReach',
+    'reachCount',
+    'impressionCount',
+    'engagementCount',
+    'engagementRate',
+    'reachEngagementRate',
+    'qualifiedEngagementRate',
+    'effectiveReach',
+    'emv',
+    'score',
+    'cpmi',
+    'cpi',
+    'cpe',
+    'viralReachEngagementRate',
+];
+/** Unidade de cada métrica. `rate` é guardado como fração (0,10 = 10%). */
+exports.CLIENT_GOAL_METRIC_UNITS = {
+    potentialReach: 'count',
+    reachCount: 'count',
+    impressionCount: 'count',
+    engagementCount: 'count',
+    engagementRate: 'rate',
+    reachEngagementRate: 'rate',
+    qualifiedEngagementRate: 'rate',
+    effectiveReach: 'count',
+    emv: 'currency',
+    score: 'count',
+    cpmi: 'currency',
+    cpi: 'currency',
+    cpe: 'currency',
+    viralReachEngagementRate: 'rate',
+};
 let Cluster = class Cluster {
 };
 __decorate([
@@ -69,6 +108,66 @@ CommissionRange = __decorate([
 ], CommissionRange);
 exports.CommissionRange = CommissionRange;
 exports.CommissionRangeSchema = mongoose_1.SchemaFactory.createForClass(CommissionRange);
+let ClientMetricGoal = class ClientMetricGoal {
+};
+__decorate([
+    (0, mongoose_1.Prop)({ type: String, enum: exports.CLIENT_GOAL_METRIC_VALUES, required: true }),
+    __metadata("design:type", String)
+], ClientMetricGoal.prototype, "metric", void 0);
+__decorate([
+    (0, mongoose_1.Prop)({ type: Number, required: true }),
+    __metadata("design:type", Number)
+], ClientMetricGoal.prototype, "value", void 0);
+ClientMetricGoal = __decorate([
+    (0, mongoose_1.Schema)({ _id: false })
+], ClientMetricGoal);
+exports.ClientMetricGoal = ClientMetricGoal;
+exports.ClientMetricGoalSchema = mongoose_1.SchemaFactory.createForClass(ClientMetricGoal);
+/**
+ * Faixa de seguidores do cliente com as metas dela (ex.: Micro, Macro, Hero,
+ * Icon da Samsung). O Tier é do cliente, não do Influenciador: para mudar a
+ * meta, edita o Tier. Faixas inclusivas nas duas pontas, contínuas e sem
+ * sobreposição (validado na api-entities). Ver GD-687.
+ */
+let ClientTier = class ClientTier {
+};
+__decorate([
+    (0, mongoose_1.Prop)({ type: String, required: true }),
+    __metadata("design:type", String)
+], ClientTier.prototype, "name", void 0);
+__decorate([
+    (0, mongoose_1.Prop)({ type: Number, required: true }),
+    __metadata("design:type", Number)
+], ClientTier.prototype, "minFollowers", void 0);
+__decorate([
+    (0, mongoose_1.Prop)({ type: Number, required: false, default: null }),
+    __metadata("design:type", Object)
+], ClientTier.prototype, "maxFollowers", void 0);
+__decorate([
+    (0, mongoose_1.Prop)({ type: [exports.ClientMetricGoalSchema], default: [] }),
+    __metadata("design:type", Array)
+], ClientTier.prototype, "goals", void 0);
+ClientTier = __decorate([
+    (0, mongoose_1.Schema)({ _id: false })
+], ClientTier);
+exports.ClientTier = ClientTier;
+exports.ClientTierSchema = mongoose_1.SchemaFactory.createForClass(ClientTier);
+/** Metas do cliente num ano (alimentam os cards do gen_ia). Ver GD-687. */
+let ClientAnnualGoal = class ClientAnnualGoal {
+};
+__decorate([
+    (0, mongoose_1.Prop)({ type: Number, required: true }),
+    __metadata("design:type", Number)
+], ClientAnnualGoal.prototype, "year", void 0);
+__decorate([
+    (0, mongoose_1.Prop)({ type: [exports.ClientMetricGoalSchema], default: [] }),
+    __metadata("design:type", Array)
+], ClientAnnualGoal.prototype, "goals", void 0);
+ClientAnnualGoal = __decorate([
+    (0, mongoose_1.Schema)({ _id: false })
+], ClientAnnualGoal);
+exports.ClientAnnualGoal = ClientAnnualGoal;
+exports.ClientAnnualGoalSchema = mongoose_1.SchemaFactory.createForClass(ClientAnnualGoal);
 let AgencyCommissionPeriod = class AgencyCommissionPeriod {
 };
 __decorate([
@@ -178,6 +277,14 @@ __decorate([
     (0, mongoose_1.Prop)({ type: String, enum: exports.CLIENT_CUSTOMIZATION_VALUES, required: false, default: null }),
     __metadata("design:type", Object)
 ], Client.prototype, "customization", void 0);
+__decorate([
+    (0, mongoose_1.Prop)({ type: [exports.ClientTierSchema], default: [] }),
+    __metadata("design:type", Array)
+], Client.prototype, "tiers", void 0);
+__decorate([
+    (0, mongoose_1.Prop)({ type: [exports.ClientAnnualGoalSchema], default: [] }),
+    __metadata("design:type", Array)
+], Client.prototype, "annualGoals", void 0);
 __decorate([
     (0, mongoose_1.Prop)({ type: mongoose_2.Schema.Types.ObjectId, ref: 'Organization', required: false }),
     __metadata("design:type", mongoose_2.Types.ObjectId)

package/package.json

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

package/src/schemas/client.schema.ts

@@ -19,6 +19,50 @@ export type ClientDocument = HydratedDocument<Client>;
 export const CLIENT_CUSTOMIZATION_VALUES = ['samsung'] as const;
 export type ClientCustomization = (typeof CLIENT_CUSTOMIZATION_VALUES)[number];
 
+/**
+ * Catálogo de métricas que podem virar meta no Tier ou na Meta anual do
+ * cliente. Quem cadastra escolhe a métrica e o valor; nada fica fixo.
+ * `viralReachEngagementRate` é o limite de viral e só vale no Tier.
+ * Ver GD-687.
+ */
+export const CLIENT_GOAL_METRIC_VALUES = [
+  'potentialReach',
+  'reachCount',
+  'impressionCount',
+  'engagementCount',
+  'engagementRate',
+  'reachEngagementRate',
+  'qualifiedEngagementRate',
+  'effectiveReach',
+  'emv',
+  'score',
+  'cpmi',
+  'cpi',
+  'cpe',
+  'viralReachEngagementRate',
+] as const;
+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%). */
+export const CLIENT_GOAL_METRIC_UNITS: Record<ClientGoalMetric, ClientGoalMetricUnit> = {
+  potentialReach: 'count',
+  reachCount: 'count',
+  impressionCount: 'count',
+  engagementCount: 'count',
+  engagementRate: 'rate',
+  reachEngagementRate: 'rate',
+  qualifiedEngagementRate: 'rate',
+  effectiveReach: 'count',
+  emv: 'currency',
+  score: 'count',
+  cpmi: 'currency',
+  cpi: 'currency',
+  cpe: 'currency',
+  viralReachEngagementRate: 'rate',
+};
+
 @Schema({ _id: false })
 export class Cluster {
   @Prop({ required: true })
@@ -55,6 +99,54 @@ export class CommissionRange {
 
 export const CommissionRangeSchema = SchemaFactory.createForClass(CommissionRange);
 
+@Schema({ _id: false })
+export class ClientMetricGoal {
+  @Prop({ type: String, enum: CLIENT_GOAL_METRIC_VALUES, required: true })
+  metric: ClientGoalMetric;
+
+  /** Na unidade da métrica (`CLIENT_GOAL_METRIC_UNITS`); `rate` em fração. */
+  @Prop({ type: Number, required: true })
+  value: number;
+}
+
+export const ClientMetricGoalSchema = SchemaFactory.createForClass(ClientMetricGoal);
+
+/**
+ * Faixa de seguidores do cliente com as metas dela (ex.: Micro, Macro, Hero,
+ * Icon da Samsung). O Tier é do cliente, não do Influenciador: para mudar a
+ * meta, edita o Tier. Faixas inclusivas nas duas pontas, contínuas e sem
+ * sobreposição (validado na api-entities). Ver GD-687.
+ */
+@Schema({ _id: false })
+export class ClientTier {
+  @Prop({ type: String, required: true })
+  name: string;
+
+  @Prop({ type: Number, required: true })
+  minFollowers: number;
+
+  /** `null` = sem teto (só o último Tier). */
+  @Prop({ type: Number, required: false, default: null })
+  maxFollowers?: number | null;
+
+  @Prop({ type: [ClientMetricGoalSchema], default: [] })
+  goals: ClientMetricGoal[];
+}
+
+export const ClientTierSchema = SchemaFactory.createForClass(ClientTier);
+
+/** Metas do cliente num ano (alimentam os cards do gen_ia). Ver GD-687. */
+@Schema({ _id: false })
+export class ClientAnnualGoal {
+  @Prop({ type: Number, required: true })
+  year: number;
+
+  @Prop({ type: [ClientMetricGoalSchema], default: [] })
+  goals: ClientMetricGoal[];
+}
+
+export const ClientAnnualGoalSchema = SchemaFactory.createForClass(ClientAnnualGoal);
+
 @Schema({ _id: false })
 export class AgencyCommissionPeriod {
   @Prop({ type: [CommissionRangeSchema], required: true, default: [] })
@@ -157,6 +249,14 @@ export class Client extends Party {
   @Prop({ type: String, enum: CLIENT_CUSTOMIZATION_VALUES, required: false, default: null })
   customization?: ClientCustomization | null;
 
+  /** Tiers do cliente (só com Personalização Samsung por enquanto). Ver GD-687. */
+  @Prop({ type: [ClientTierSchema], default: [] })
+  tiers: ClientTier[];
+
+  /** Metas anuais do cliente (só com Personalização Samsung por enquanto). Ver GD-687. */
+  @Prop({ type: [ClientAnnualGoalSchema], default: [] })
+  annualGoals: ClientAnnualGoal[];
+
   /**
    * Client de organização (ex.: "Oma Creators"): representa a organização
    * inteira, não uma marca. No hub, mostra todas as actions dessa organização