reader-star/apps/admin/src/typings/api/template.d.ts

/**
 * Namespace Api
 *
 * All backend api type
 */
declare namespace Api {
  namespace Template {
    /** common params of paginating */
    interface PaginatingCommonParams {
      /** currentPage page number */
      currentPage: number
      /** page pageSize */
      pageSize: number
      /** total count */
      total?: number
    }

    interface AddTemplateParams {
      /** template id */
      id: number | null
      /** page number */
      pageNo: number | null | string
      /** template name */
      name: string
      /** background url */
      backGroundUrl: string
      /** width */
      width: number
      /** height */
      height: number
      /** template content */
      tempContent: string
    }

    /** template search params */
    interface TemplateSearchParams extends PaginatingCommonParams {
      /** competition activity name */
      competitionActivityName?: string
      /** publish status */
      publishStatus?: EnableStatus
      /** template name */
      templateName?: string
      /** competition id */
      competitionId?: string
      /** size */
      size?: string
      /** status */
      status?: EnableStatus | null
    }

    /** common params of paginating query list data */
    interface PaginatingQueryRecord<T = any> extends PaginatingCommonParams {
      records: T[]
    }

    /** common search params of table */
    type CommonSearchParams = Pick<Common.PaginatingCommonParams, 'currentPage' | 'pageSize'>

    /**
     * enable status
     *
     * - "1": enabled
     * - "2": disabled
     */
    type EnableStatus = '1' | '2'

    /** question score type */
    type QuestionScoreType = '1' | '2' /** 固定分数 | 答题个数 */

    /** competition round type */
    type CompetitionRoundType = '1' | '2' /** 题包环节 | 加时环节 */

    /** common record */
    type CommonRecord<T = any> = {
      /** record id */
      id: number
      /** record creator */
      createBy: string
      /** record create time */
      createTime: string
      /** record updater */
      updateBy: string
      /** record update time */
      updateTime: string
      /** record status */
      status: EnableStatus | null
    } & T
  }
}