@grapadigital/shared-schemas 1.0.183 → 1.0.185

package/src/schemas/script.schema.ts

@@ -0,0 +1,235 @@
+import { Prop, Schema, SchemaFactory } from '@nestjs/mongoose';
+import { ApiProperty } from '@nestjs/swagger';
+import {
+  HydratedDocument,
+  Schema as MongooseSchema,
+  Types,
+  model as MongooseModel,
+} from 'mongoose';
+
+import { Action } from './action.schema';
+import { Client } from './client.schema';
+import { Profile } from './profile.schema';
+import { TASK_FORMAT_VALUES, TaskFormat } from './task.schema';
+
+export type ScriptDocument = HydratedDocument<Script>;
+
+export const SCRIPT_STATUS_VALUES = [
+  'draft',
+  'pending',
+  'approved',
+  'reproved',
+] as const;
+export type ScriptStatus = (typeof SCRIPT_STATUS_VALUES)[number];
+
+export const SCRIPT_DECISION_VALUES = [
+  'approved',
+  'reproved',
+  'questioned',
+] as const;
+export type ScriptDecisionValue = (typeof SCRIPT_DECISION_VALUES)[number];
+
+@Schema({ _id: false })
+export class ScriptDecision {
+  @ApiProperty({ enum: SCRIPT_DECISION_VALUES })
+  @Prop({ type: String, enum: SCRIPT_DECISION_VALUES, required: true })
+  decision: ScriptDecisionValue;
+
+  @ApiProperty({ required: false })
+  @Prop({ type: String, required: false })
+  comment?: string;
+
+  @ApiProperty({ description: 'Time do cliente que respondeu, lido do JWT' })
+  @Prop({ type: String, required: true })
+  team: string;
+
+  @ApiProperty()
+  @Prop({ type: String, required: true })
+  respondedBy: string;
+
+  @ApiProperty()
+  @Prop({ type: Date, required: true })
+  respondedAt: Date;
+}
+
+export const ScriptDecisionSchema = SchemaFactory.createForClass(ScriptDecision);
+
+@Schema({ _id: false })
+export class ScriptStaffReply {
+  @ApiProperty()
+  @Prop({ type: String, required: true })
+  message: string;
+
+  @ApiProperty()
+  @Prop({ type: String, required: true })
+  repliedBy: string;
+
+  @ApiProperty()
+  @Prop({ type: Date, required: true })
+  repliedAt: Date;
+}
+
+export const ScriptStaffReplySchema =
+  SchemaFactory.createForClass(ScriptStaffReply);
+
+@Schema({ _id: false })
+export class ScriptVersion {
+  @ApiProperty()
+  @Prop({ type: Number, required: true })
+  version: number;
+
+  @ApiProperty({ required: false })
+  @Prop({ type: String, required: false, default: null })
+  fileUrl?: string | null;
+
+  @ApiProperty({ required: false })
+  @Prop({ type: String, required: false, default: null })
+  fileName?: string | null;
+
+  @ApiProperty({ required: false })
+  @Prop({ type: String, required: false, default: null })
+  link?: string | null;
+
+  @ApiProperty({ enum: ['approved', 'reproved'] })
+  @Prop({ type: String, enum: ['approved', 'reproved'], required: true })
+  status: 'approved' | 'reproved';
+
+  @ApiProperty({ required: false })
+  @Prop({ type: String, required: false })
+  submittedBy?: string;
+
+  @ApiProperty({ required: false })
+  @Prop({ type: Date, required: false })
+  submittedAt?: Date;
+
+  @ApiProperty({ type: () => [ScriptDecision] })
+  @Prop({ type: [ScriptDecisionSchema], default: [] })
+  decisions: ScriptDecision[];
+
+  @ApiProperty({ type: () => [ScriptStaffReply] })
+  @Prop({ type: [ScriptStaffReplySchema], default: [] })
+  staffReplies: ScriptStaffReply[];
+
+  @ApiProperty()
+  @Prop({ type: Date, required: true })
+  archivedAt: Date;
+}
+
+export const ScriptVersionSchema = SchemaFactory.createForClass(ScriptVersion);
+
+/**
+ * Aprovação de roteiro: um documento por (action, profile, deliverableType,
+ * deliverableIndex) — não um doc único por Ação. A versão mora no mesmo doc;
+ * ao reprovar, o estado atual é arquivado em `versions[]` e o doc volta a
+ * `draft` para uma nova tentativa (ver GD-532).
+ */
+@Schema({ timestamps: true })
+export class Script {
+  @ApiProperty()
+  @Prop({ type: MongooseSchema.Types.ObjectId, auto: true, required: false })
+  _id?: Types.ObjectId;
+
+  @ApiProperty({ type: () => Action })
+  @Prop({ type: MongooseSchema.Types.ObjectId, ref: 'Action', required: true })
+  action: Types.ObjectId | Action;
+
+  @ApiProperty({ type: () => Client })
+  @Prop({ type: MongooseSchema.Types.ObjectId, ref: 'Client', required: false })
+  client?: Types.ObjectId | Client;
+
+  @ApiProperty({ type: () => Profile })
+  @Prop({ type: MongooseSchema.Types.ObjectId, ref: 'Profile', required: true })
+  profile: Types.ObjectId | Profile;
+
+  @ApiProperty({
+    enum: TASK_FORMAT_VALUES,
+    description: 'Unidade de entrega do escopo (mesmos valores de recruitment.scope.delivery)',
+  })
+  @Prop({ type: String, enum: TASK_FORMAT_VALUES, required: true })
+  deliverableType: TaskFormat;
+
+  @ApiProperty({
+    description: 'Ex.: 1 de 2 quando o escopo pede mais de uma unidade do mesmo tipo; sempre 1 para "story"',
+  })
+  @Prop({ type: Number, required: true, default: 1 })
+  deliverableIndex: number;
+
+  @ApiProperty()
+  @Prop({ type: Number, required: true, default: 1 })
+  version: number;
+
+  @ApiProperty({ required: false })
+  @Prop({ type: String, required: false, default: null })
+  fileUrl?: string | null;
+
+  @ApiProperty({ required: false })
+  @Prop({ type: String, required: false, default: null })
+  fileName?: string | null;
+
+  @ApiProperty({
+    required: false,
+    description: 'Alternativa ao arquivo — staff usa arquivo OU link',
+  })
+  @Prop({ type: String, required: false, default: null })
+  link?: string | null;
+
+  @ApiProperty({ enum: SCRIPT_STATUS_VALUES })
+  @Prop({
+    type: String,
+    enum: SCRIPT_STATUS_VALUES,
+    required: true,
+    default: 'draft',
+  })
+  status: ScriptStatus;
+
+  @ApiProperty({
+    type: [String],
+    description:
+      'Snapshot de Client.requiredTeams no momento da criação — vazio = 1 aprovação resolve; com times = todos precisam aprovar',
+  })
+  @Prop({ type: [String], required: false, default: [] })
+  requiredTeams: string[];
+
+  @ApiProperty({ required: false })
+  @Prop({ type: String, required: false })
+  submittedBy?: string;
+
+  @ApiProperty({ required: false })
+  @Prop({ type: Date, required: false })
+  submittedAt?: Date;
+
+  @ApiProperty({ type: () => [ScriptDecision] })
+  @Prop({ type: [ScriptDecisionSchema], default: [] })
+  decisions: ScriptDecision[];
+
+  @ApiProperty({ type: () => [ScriptStaffReply] })
+  @Prop({ type: [ScriptStaffReplySchema], default: [] })
+  staffReplies: ScriptStaffReply[];
+
+  @ApiProperty({ type: () => [ScriptVersion] })
+  @Prop({ type: [ScriptVersionSchema], default: [] })
+  versions: ScriptVersion[];
+
+  @Prop({ type: MongooseSchema.Types.ObjectId, required: false })
+  organization?: Types.ObjectId;
+
+  @ApiProperty()
+  @Prop({ default: Date.now, required: false })
+  createdAt?: Date;
+
+  @ApiProperty()
+  @Prop({ default: Date.now, required: false })
+  updatedAt?: Date;
+}
+
+export const ScriptSchema = SchemaFactory.createForClass(Script);
+
+ScriptSchema.index(
+  { action: 1, profile: 1, deliverableType: 1, deliverableIndex: 1 },
+  { unique: true },
+);
+ScriptSchema.index({ action: 1, status: 1 });
+ScriptSchema.index({ client: 1, status: 1 });
+ScriptSchema.index({ organization: 1, status: 1 });
+
+export const ScriptModel = MongooseModel('Script', ScriptSchema);