tabletcommand-backend-models 5.39.7 → 7.0.1

package/src/models/department.ts

@@ -2,26 +2,231 @@ import * as uuid from "uuid";
 import * as mongooseLeanVirtuals from "mongoose-lean-virtuals";
 
 import {
-  createSchema,
-  createModel,
   currentDate,
-  DocumentTypeFromSchema,
-  FieldsOfDocument,
   MongooseModule,
   retrieveCurrentUnixTime,
-  ItemTypeFromTypeSchemaFunction,
-  ModelTypeFromTypeSchemaFunction,
-  ReplaceModelReturnType,
 } from "../helpers";
 import ColorModule from "./schema/color";
 import PubNubTokenSchema from "./schema/pubnub-token";
-
-export async function DepartmentModule(mongoose: MongooseModule) {
-  const { Schema, Types } = mongoose;
+import { Model } from "mongoose";
+import {
+  AudioStreamGroupType,
+  AudioStreamType,
+  CustomButtonsType,
+  DepartmentType,
+  FireMapperConfigurationType,
+  FireMapperLayerType,
+  FireMapperOutlineType,
+  FirstArrivingConfigType,
+  IncidentTypeType,
+  IncidentVehicleStatusConfigType,
+  IntterraConfigType,
+  IntterraConnectionType,
+  IntterraFieldsType,
+  LicensingType,
+  Mark43ConfigType,
+  Mark43ProcessCommentConfigType,
+  Mark43ProcessConfigType,
+  Mark43ProcessLocationConfigType,
+  Mark43ProcessVehicleStatusConfigType,
+  Mark43StatusConfigType,
+  RestrictedCommentsType,
+  SafetyPriorityKeywordType,
+  SamsaraConfigurationType,
+  ShareIncidentRuleType,
+  SimpleSenseConfigType,
+  SkymiraConfigType,
+  SkytracConfigType,
+  StatusMappingConfigType,
+  StatusMappingObjectConfigType,
+  WebDisclaimerType
+} from "../types/department";
+
+export interface Department extends DepartmentType, Record<string, unknown> { }
+
+const Mark43StatusConfigDefault = {
+  TimeDispatched: ["D"],
+  TimeEnroute: ["EN"],
+  TimeStaged: ["ST"],
+  TimeCleared: ["AV", "AVF", "AOR"],
+  TimeAtHospital: ["AH"],
+  TimeTransporting: ["T", "EH"],
+  TimeArrived: ["ATS", "A"],
+};
+
+const IntterraFieldsDefault = [
+  {
+    "key": "IncidentNumber",
+    "value": "incidentId",
+    "required": true,
+    "enabled": true,
+    "transformationRequired": false,
+  },
+  {
+    "key": "AgencyIncidentCallTypeDescription",
+    "value": "incidentTypeDescription",
+    "required": false,
+    "enabled": true,
+    "transformationRequired": false,
+  },
+  {
+    "key": "units",
+    "value": "assignedUnits",
+    "required": false,
+    "enabled": true,
+    "transformationRequired": true,
+  },
+  {
+    "key": "Longitude",
+    "value": "longitude",
+    "required": false,
+    "enabled": true,
+    "transformationRequired": false,
+  },
+  {
+    "key": "Latitude",
+    "value": "latitude",
+    "required": false,
+    "enabled": true,
+    "transformationRequired": false,
+  },
+  {
+    "key": "full_address",
+    "value": "fullAddress",
+    "required": false,
+    "enabled": true,
+    "transformationRequired": false,
+  },
+  {
+    "key": "EntryDateTime",
+    "value": "alarmDatetime", // cspell:disable-line
+    "required": false,
+    "enabled": true,
+    "transformationRequired": false,
+  }
+];
+
+// If any of the following fields are updated/added/deleted,
+// make sure to update the database records, before/after release (script/query)
+const FireMapperConfigurationDefault = {
+  enabled: false,
+  layerRefreshInterval: 15,
+  proLicenseCount: 0,
+  host: "",
+  layer: [
+    {
+      name: "FireMapper - Symbols",
+      pathname: "/api/rest/services/features/FeatureServer/0",
+    },
+    {
+      name: "FireMapper - Lines",
+      pathname: "/api/rest/services/features/FeatureServer/1",
+    },
+    {
+      name: "FireMapper - Photos",
+      pathname: "/api/rest/services/features/FeatureServer/2",
+    },
+    {
+      name: "FireMapper - Areas",
+      pathname: "/api/rest/services/features/FeatureServer/3",
+    },
+    {
+      name: "FireMapper - PDFs",
+      pathname: "/api/rest/services/features/FeatureServer/4",
+    },
+    {
+      name: "FireMapper - Labels",
+      pathname: "/api/rest/services/features/FeatureServer/5",
+    },
+  ],
+  staticLayer: [],
+};
+
+const LicensingDefault = {
+  "tcPro2Way": 0,
+  "tcPro1Way": 0,
+  "tcMobile": 0,
+  "tcWeb": 0,
+  "fireMapperPro": 0,
+  "sendToCAD": 0,
+  "tcStreams": 0
+};
+
+const SafetyPriorityKeywordDefault = [
+  {
+    "keywords": [],
+    "priority": 0,
+    "hexColor": "FF3B30"
+  },
+  {
+    "keywords": [],
+    "priority": 1,
+    "hexColor": "FEC309"
+  },
+  {
+    "keywords": [],
+    "priority": 2,
+    "hexColor": "0A60FF"
+  }
+];
+
+const FirstArrivingConfigDefault = {
+  "token": "",
+  "apiUrl": "",
+};
+
+const IntterraConfigDefault = {
+  "enabled": false,
+  "connections": [],
+};
+
+const SkymiraConfigDefault = {
+  "enabled": false,
+  "token": "",
+  "locationsUrl": "",
+};
+
+const Mark43ConfigDefault = {
+  "baseUrl": "",
+  "authToken": "",
+  "apiToken": "",
+  "userId": 0,
+  "enabled": false,
+};
+
+const SimpleSenseConfigDefault = {
+  "token": "",
+};
+
+const WebDisclaimerDefault = {
+  "message": "",
+  "enabled": false
+};
+
+const RestrictedCommentsDefault = {
+  enabled: false,
+  callTypesAllowed: [],
+  statusesAllowed: [],
+  restrictedFields: [
+    "LocationComment",
+    "AgencyIncidentCallTypeDescription",
+    "Comment"
+  ],
+  restrictedMessage: "RESTRICTED"
+};
+
+const SamsaraConfigurationDefault = {
+  enabled: false,
+  token: "",
+};
+
+
+export default async function DepartmentModule(mongoose: MongooseModule) {
+  const { Schema } = mongoose;
   const PubNubToken = PubNubTokenSchema(mongoose);
   const Color = ColorModule(mongoose);
 
-  const Mark43StatusConfig = createSchema(Schema, {
+  const Mark43StatusConfig = new Schema<Mark43StatusConfigType>({
     TimeDispatched: {
       type: [String],
       default: []
@@ -55,17 +260,7 @@ export async function DepartmentModule(mongoose: MongooseModule) {
     id: false,
   });
 
-  const Mark43StatusConfigDefault = {
-    TimeDispatched: ["D"],
-    TimeEnroute: ["EN"],
-    TimeStaged: ["ST"],
-    TimeCleared: ["AV", "AVF", "AOR"],
-    TimeAtHospital: ["AH"],
-    TimeTransporting: ["T", "EH"],
-    TimeArrived: ["ATS", "A"],
-  };
-
-  const Mark43ProcessLocationConfig = createSchema(Schema, {
+  const Mark43ProcessLocationConfig = new Schema<Mark43ProcessLocationConfigType>({
     enabled: {
       type: Boolean,
       default: false,
@@ -79,8 +274,7 @@ export async function DepartmentModule(mongoose: MongooseModule) {
     id: false,
   });
 
-
-  const Mark43ProcessCommentConfig = createSchema(Schema, {
+  const Mark43ProcessCommentConfig = new Schema<Mark43ProcessCommentConfigType>({
     enabled: {
       type: Boolean,
       default: false,
@@ -102,7 +296,7 @@ export async function DepartmentModule(mongoose: MongooseModule) {
     id: false,
   });
 
-  const Mark43ProcessVehicleStatusConfig = createSchema(Schema, {
+  const Mark43ProcessVehicleStatusConfig = new Schema<Mark43ProcessVehicleStatusConfigType>({
     enabled: {
       type: Boolean,
       default: false,
@@ -120,7 +314,7 @@ export async function DepartmentModule(mongoose: MongooseModule) {
     id: false,
   });
 
-  const Mark43ProcessConfig = createSchema(Schema, {
+  const Mark43ProcessConfig = new Schema<Mark43ProcessConfigType>({
     location: {
       type: Mark43ProcessLocationConfig,
     },
@@ -135,7 +329,7 @@ export async function DepartmentModule(mongoose: MongooseModule) {
     id: false,
   });
 
-  const Mark43Config = createSchema(Schema, {
+  const Mark43Config = new Schema<Mark43ConfigType>({
     baseUrl: {
       type: String,
       default: "",
@@ -168,59 +362,7 @@ export async function DepartmentModule(mongoose: MongooseModule) {
     id: false,
   });
 
-  const IntterraFieldsDefault = [
-    {
-      "key": "IncidentNumber",
-      "value": "incidentId",
-      "required": true,
-      "enabled": true,
-      "transformationRequired": false,
-    },
-    {
-      "key": "AgencyIncidentCallTypeDescription",
-      "value": "incidentTypeDescription",
-      "required": false,
-      "enabled": true,
-      "transformationRequired": false,
-    },
-    {
-      "key": "units",
-      "value": "assignedUnits",
-      "required": false,
-      "enabled": true,
-      "transformationRequired": true,
-    },
-    {
-      "key": "Longitude",
-      "value": "longitude",
-      "required": false,
-      "enabled": true,
-      "transformationRequired": false,
-    },
-    {
-      "key": "Latitude",
-      "value": "latitude",
-      "required": false,
-      "enabled": true,
-      "transformationRequired": false,
-    },
-    {
-      "key": "full_address",
-      "value": "fullAddress",
-      "required": false,
-      "enabled": true,
-      "transformationRequired": false,
-    },
-    {
-      "key": "EntryDateTime",
-      "value": "alarmDatetime", // cspell:disable-line
-      "required": false,
-      "enabled": true,
-      "transformationRequired": false,
-    }
-  ];
-
-  const IntterraFields = createSchema(Schema, {
+  const IntterraFields = new Schema<IntterraFieldsType>({
     key: {
       type: String,
       default: "",
@@ -246,7 +388,7 @@ export async function DepartmentModule(mongoose: MongooseModule) {
     id: false,
   });
 
-  const IntterraConnection = createSchema(Schema, {
+  const IntterraConnection = new Schema<IntterraConnectionType>({
     active: {
       type: Boolean,
       default: false,
@@ -280,7 +422,7 @@ export async function DepartmentModule(mongoose: MongooseModule) {
     id: false,
   });
 
-  const IntterraConfig = createSchema(Schema, {
+  const IntterraConfig = new Schema<IntterraConfigType>({
     enabled: {
       type: Boolean,
       default: false,
@@ -294,7 +436,7 @@ export async function DepartmentModule(mongoose: MongooseModule) {
     id: false,
   });
 
-  const SkymiraConfig = createSchema(Schema, {
+  const SkymiraConfig = new Schema<SkymiraConfigType>({
     enabled: {
       type: Boolean,
       default: false,
@@ -312,7 +454,7 @@ export async function DepartmentModule(mongoose: MongooseModule) {
     id: false,
   });
 
-  const SkytracConfig = createSchema(Schema, {
+  const SkytracConfig = new Schema<SkytracConfigType>({
     enabled: {
       type: Boolean,
       default: false,
@@ -342,7 +484,7 @@ export async function DepartmentModule(mongoose: MongooseModule) {
     id: false,
   });
 
-  const SimpleSenseConfig = createSchema(Schema, {
+  const SimpleSenseConfig = new Schema<SimpleSenseConfigType>({
     token: {
       type: String,
       default: "",
@@ -352,7 +494,8 @@ export async function DepartmentModule(mongoose: MongooseModule) {
     id: false,
   });
 
-  const StatusMappingObjectConfig = createSchema(Schema, {
+
+  const StatusMappingObjectConfig = new Schema<StatusMappingObjectConfigType>({
     status: {
       type: String,
       default: "",
@@ -366,7 +509,7 @@ export async function DepartmentModule(mongoose: MongooseModule) {
     id: false,
   });
 
-  const StatusMappingConfig = createSchema(Schema, {
+  const StatusMappingConfig = new Schema<StatusMappingConfigType>({
     TimeDispatched: {
       type: StatusMappingObjectConfig,
     },
@@ -439,7 +582,8 @@ export async function DepartmentModule(mongoose: MongooseModule) {
     }
   };
 
-  const IncidentVehicleStatusConfig = createSchema(Schema, {
+
+  const IncidentVehicleStatusConfig = new Schema<IncidentVehicleStatusConfigType>({
     enabled: {
       type: Boolean,
       default: false,
@@ -457,7 +601,7 @@ export async function DepartmentModule(mongoose: MongooseModule) {
     id: false,
   });
 
-  const FirstArrivingConfig = createSchema(Schema, {
+  const FirstArrivingConfig = new Schema<FirstArrivingConfigType>({
     token: {
       type: String,
       default: "",
@@ -472,7 +616,7 @@ export async function DepartmentModule(mongoose: MongooseModule) {
   });
 
 
-  const SafetyPriorityKeyword = createSchema(Schema, {
+  const SafetyPriorityKeyword = new Schema<SafetyPriorityKeywordType>({
     priority: {
       type: Number,
       default: 6,
@@ -489,7 +633,7 @@ export async function DepartmentModule(mongoose: MongooseModule) {
     id: false,
   });
 
-  const WebDisclaimer = createSchema(Schema, {
+  const WebDisclaimer = new Schema<WebDisclaimerType>({
     message: {
       type: String,
       default: "",
@@ -503,7 +647,7 @@ export async function DepartmentModule(mongoose: MongooseModule) {
     id: false,
   });
 
-  const AudioStream = createSchema(Schema, {
+  const AudioStream = new Schema<AudioStreamType>({
     // eg. Central Dispatch Talk Group or also Available on 89.5 MHz
     description: {
       type: String,
@@ -527,7 +671,7 @@ export async function DepartmentModule(mongoose: MongooseModule) {
     id: false,
   });
 
-  const AudioStreamGroup = createSchema(Schema, {
+  const AudioStreamGroup = new Schema<AudioStreamGroupType>({
     group: {
       type: String,
       default: "",
@@ -545,7 +689,7 @@ export async function DepartmentModule(mongoose: MongooseModule) {
     id: false,
   });
 
-  const RestrictedComments = createSchema(Schema, {
+  const RestrictedComments = new Schema<RestrictedCommentsType>({
     enabled: {
       type: Boolean,
       default: false,
@@ -571,7 +715,7 @@ export async function DepartmentModule(mongoose: MongooseModule) {
     id: false,
   });
 
-  const CustomButtons = createSchema(Schema, {
+  const CustomButtons = new Schema<CustomButtonsType>({
     name: {
       type: String,
       default: "",
@@ -605,7 +749,7 @@ export async function DepartmentModule(mongoose: MongooseModule) {
     id: false,
   });
 
-  const FireMapperLayer = createSchema(Schema, {
+  const FireMapperLayer = new Schema<FireMapperLayerType>({
     pathname: {
       type: String,
       default: "", // Eg. /api/rest/services/features/FeatureServer/0 (including 0)
@@ -619,7 +763,7 @@ export async function DepartmentModule(mongoose: MongooseModule) {
     id: false,
   });
 
-  const FireMapperOutline = createSchema(Schema, {
+  const FireMapperOutline = new Schema<FireMapperOutlineType>({
     uuid: {
       type: String,
       default: "",
@@ -633,7 +777,7 @@ export async function DepartmentModule(mongoose: MongooseModule) {
     id: false,
   });
 
-  const SamsaraConfiguration = createSchema(Schema, {
+  const SamsaraConfiguration = new Schema<SamsaraConfigurationType>({
     enabled: {
       type: Boolean,
       default: false,
@@ -647,12 +791,7 @@ export async function DepartmentModule(mongoose: MongooseModule) {
     id: false,
   });
 
-  const SamsaraConfigurationDefault = {
-    enabled: false,
-    token: "",
-  };
-
-  const FireMapperConfiguration = createSchema(Schema, {
+  const FireMapperConfiguration = new Schema<FireMapperConfigurationType>({
     enabled: {
       type: Boolean,
       default: false,
@@ -688,43 +827,7 @@ export async function DepartmentModule(mongoose: MongooseModule) {
     id: false,
   });
 
-  // If any of the following fields are updated/added/deleted,
-  // make sure to update the database records, before/after release (script/query)
-  const FireMapperConfigurationDefault = {
-    enabled: false,
-    layerRefreshInterval: 15,
-    proLicenseCount: 0,
-    host: "",
-    layer: [
-      {
-        name: "FireMapper - Symbols",
-        pathname: "/api/rest/services/features/FeatureServer/0",
-      },
-      {
-        name: "FireMapper - Lines",
-        pathname: "/api/rest/services/features/FeatureServer/1",
-      },
-      {
-        name: "FireMapper - Photos",
-        pathname: "/api/rest/services/features/FeatureServer/2",
-      },
-      {
-        name: "FireMapper - Areas",
-        pathname: "/api/rest/services/features/FeatureServer/3",
-      },
-      {
-        name: "FireMapper - PDFs",
-        pathname: "/api/rest/services/features/FeatureServer/4",
-      },
-      {
-        name: "FireMapper - Labels",
-        pathname: "/api/rest/services/features/FeatureServer/5",
-      },
-    ],
-    staticLayer: [],
-  };
-
-  const Licensing = createSchema(Schema, {
+  const Licensing = new Schema<LicensingType>({
     tcPro2Way: {
       type: Number,
       default: 0,
@@ -758,80 +861,17 @@ export async function DepartmentModule(mongoose: MongooseModule) {
     id: false,
   });
 
-  const LicensingDefault = {
-    "tcPro2Way": 0,
-    "tcPro1Way": 0,
-    "tcMobile": 0,
-    "tcWeb": 0,
-    "fireMapperPro": 0,
-    "sendToCAD": 0,
-    "tcStreams": 0
-  };
 
-  const SafetyPriorityKeywordDefault = [
-    {
-      "keywords": [],
-      "priority": 0,
-      "hexColor": "FF3B30"
-    },
-    {
-      "keywords": [],
-      "priority": 1,
-      "hexColor": "FEC309"
-    },
-    {
-      "keywords": [],
-      "priority": 2,
-      "hexColor": "0A60FF"
-    }
-  ];
 
-  const FirstArrivingConfigDefault = {
-    "token": "",
-    "apiUrl": "",
-  };
 
-  const IntterraConfigDefault = {
-    "enabled": false,
-    "connections": [],
-  };
 
-  const SkymiraConfigDefault = {
-    "enabled": false,
-    "token": "",
-    "locationsUrl": "",
-  };
 
-  const Mark43ConfigDefault = {
-    "baseUrl": "",
-    "authToken": "",
-    "apiToken": "",
-    "userId": 0,
-    "enabled": false,
-  };
 
-  const SimpleSenseConfigDefault = {
-    "token": "",
-  };
 
-  const WebDisclaimerDefault = {
-    "message": "",
-    "enabled": false
-  };
 
-  const RestrictedCommentsDefault = {
-    enabled: false,
-    callTypesAllowed: [],
-    statusesAllowed: [],
-    restrictedFields: [
-      "LocationComment",
-      "AgencyIncidentCallTypeDescription",
-      "Comment"
-    ],
-    restrictedMessage: "RESTRICTED"
-  };
 
-  const IncidentType = createSchema(Schema, {
+
+  const IncidentType = new Schema<IncidentTypeType>({
     name: {
       type: String,
       default: "Any",
@@ -860,7 +900,7 @@ export async function DepartmentModule(mongoose: MongooseModule) {
     id: false,
   });
 
-  const ShareIncidentRule = createSchema(Schema, {
+  const ShareIncidentRule = new Schema<ShareIncidentRuleType>({
     ruleType: {
       type: String,
       default: "",
@@ -883,9 +923,9 @@ export async function DepartmentModule(mongoose: MongooseModule) {
   });
 
   // Main schema
-  const modelSchema = createSchema(Schema, {
+  const modelSchema = new Schema<DepartmentType>({
     _id: {
-      type: Types.ObjectId,
+      type: Schema.Types.ObjectId,
       auto: true,
     },
     uuid: {
@@ -1362,7 +1402,6 @@ export async function DepartmentModule(mongoose: MongooseModule) {
       default: [],
     },
   }, {
-    collection: "massive_admin",
   });
 
   modelSchema.set("autoIndex", false);
@@ -1370,23 +1409,19 @@ export async function DepartmentModule(mongoose: MongooseModule) {
     updatedAt: "modified",
   });
 
+  modelSchema.virtual("id").get(function(this: Department) {
+    return this._id.toHexString();
+  });
+
   modelSchema.set("toJSON", {
     virtuals: true,
     versionKey: false,
-    transform(doc: DocumentTypeFromSchema<typeof modelSchema>, ret: FieldsOfDocument<DocumentTypeFromSchema<typeof modelSchema>>) {
-      ret.id = ret._id;
-    },
   });
 
-  modelSchema.virtual("id").get(function(this: DocumentTypeFromSchema<typeof modelSchema>) {
-    return this._id.toHexString();
-  });
 
   modelSchema.plugin(mongooseLeanVirtuals);
 
-  return createModel(mongoose, "Department", modelSchema);
+  return mongoose.model<Department>("Department", modelSchema, "massive_admin", { overwriteModels: true });
 }
 
-export interface Department extends ItemTypeFromTypeSchemaFunction<typeof DepartmentModule> { }
-export interface DepartmentModel extends ModelTypeFromTypeSchemaFunction<Department> { }
-export default DepartmentModule as ReplaceModelReturnType<typeof DepartmentModule, DepartmentModel>;
+export interface DepartmentModel extends Model<Department> { }