api/src/models/missionAPI.ts
import mongoose, { Schema, InferSchemaType } from "mongoose";
import patchHistory from "mongoose-patch-history";
import mongooseElastic from "@selego/mongoose-elastic";
import esClient from "../es";
const MODELNAME = "missionapi";
import { DocumentExtended, CustomSaveParams, UserExtension, UserSaved, InterfaceExtended } from "./types";
const schema = new Schema({
title: {
type: String,
documentation: {
description: "Titre de la mission",
},
}, // OK
domain: {
type: String,
documentation: {
description: "Domaine de la mission (citoyenneté, sport, culture, ...)",
},
}, // OK
startAt: {
type: Date,
documentation: {
description: "Date du début de la mission",
},
}, // OK
endAt: {
type: Date,
documentation: {
description: "Date de fin de la mission",
},
}, // OK
format: {
type: String,
default: "CONTINUOUS",
enum: ["CONTINUOUS", "DISCONTINUOUS", "AUTONOMOUS"],
documentation: {
description: "Format de la mission",
},
},
places: {
type: Number,
default: 1,
documentation: {
description: "Nombre de places total pour cette mission",
},
}, // OK
description: {
type: String,
documentation: {
description: "Description de la mission",
},
}, // OK
structureId: {
type: String,
documentation: {
description: "Identifiant de la structure proposant la mission",
},
}, // OK
structureName: {
type: String,
documentation: {
description: "Nom de la structure proposant la mission",
},
}, // OK ( slave data from structure)
status: {
type: String,
default: "DRAFT",
enum: ["DRAFT", "WAITING_VALIDATION", "WAITING_CORRECTION", "VALIDATED", "REFUSED", "CANCEL", "ARCHIVED"],
documentation: {
description: "Statut de la mission",
},
},
tutorId: {
type: String,
documentation: {
description: "Identifiant de l'utilisateur tuteur de la mission",
},
},
tutorName: {
type: String,
documentation: {
description: "Prénom et nom de l'utilisateur tuteur de la mission",
},
},
adresse: {
type: String,
documentation: {
description: "Adresse du lieu où se déroule la mission",
},
},
postalCode: {
type: String,
documentation: {
description: "Code postal du lieu où se déroule la mission",
},
},
city: {
type: String,
documentation: {
description: "Ville où se déroule la mission",
},
},
departmentName: {
type: String,
documentation: {
description: "Département où se déroule la mission",
},
},
departmentCode: {
type: String,
documentation: {
description: "Département où se déroule la mission",
},
},
region: {
type: String,
documentation: {
description: "Région où se déroule la mission",
},
},
country: {
type: String,
documentation: {
description: "",
},
},
location: {
lat: {
type: Number,
},
lon: {
type: Number,
},
},
remote: {
type: String,
documentation: {
description: "La mission peut se réaliser à distance",
},
},
organizationName: { type: String },
applicationUrl: { type: String },
publisherName: { type: String },
publisherUrl: { type: String },
lastSyncAt: { type: Date },
createdAt: { type: Date, default: Date.now },
updatedAt: { type: Date, default: Date.now },
});
schema.virtual("fromUser").set<SchemaExtended>(function (fromUser: UserSaved) {
if (fromUser) {
const { _id, role, department, region, email, firstName, lastName, model } = fromUser;
this._user = { _id, role, department, region, email, firstName, lastName, model };
}
});
schema.pre<SchemaExtended>("save", function (next, params: CustomSaveParams) {
this.fromUser = params?.fromUser;
this.updatedAt = new Date();
next();
});
schema.plugin(patchHistory, {
mongoose,
name: `${MODELNAME}Patches`,
trackOriginalValue: true,
includes: {
modelName: { type: String, required: true, default: MODELNAME },
user: { type: Object, required: false, from: "_user" },
},
excludes: ["/updatedAt"],
});
schema.plugin(mongooseElastic(esClient), MODELNAME);
export type MissionAPIType = InterfaceExtended<InferSchemaType<typeof schema>>;
export type MissionAPIDocument<T = {}> = DocumentExtended<MissionAPIType & T>;
type SchemaExtended = MissionAPIDocument & UserExtension;
export const MissionAPIModel = mongoose.model<MissionAPIDocument>(MODELNAME, schema);