hyperdx/packages/api/src/models/dashboard.ts

import { DashboardSchema } from '@hyperdx/common-utils/dist/types';
import mongoose, { Schema } from 'mongoose';
import { z } from 'zod';

import type { ObjectId } from '.';

export interface IDashboard extends z.infer<typeof DashboardSchema> {
  _id: ObjectId;
  team: ObjectId;
  createdBy?: ObjectId;
  updatedBy?: ObjectId;
  createdAt: Date;
  updatedAt: Date;
}

export type DashboardDocument = mongoose.HydratedDocument<IDashboard>;

export default mongoose.model<IDashboard>(
  'Dashboard',
  new Schema<IDashboard>(
    {
      name: {
        type: String,
        required: true,
      },
      tiles: { type: mongoose.Schema.Types.Mixed, required: true },
      team: { type: mongoose.Schema.Types.ObjectId, ref: 'Team' },
      tags: {
        type: [String],
        default: [],
      },
      filters: { type: mongoose.Schema.Types.Array, default: [] },
      savedQuery: { type: String, required: false },
      savedQueryLanguage: { type: String, required: false },
      savedFilterValues: { type: mongoose.Schema.Types.Array, required: false },
      containers: { type: mongoose.Schema.Types.Array, required: false },
      createdBy: {
        type: mongoose.Schema.Types.ObjectId,
        ref: 'User',
        required: false,
      },
      updatedBy: {
        type: mongoose.Schema.Types.ObjectId,
        ref: 'User',
        required: false,
      },
    },
    {
      timestamps: true,
      toJSON: { getters: true },
    },
  ),
);