All files / types/api sites.ts

0% Statements 0/76
100% Branches 1/1
100% Functions 1/1
0% Lines 0/76

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222                                                                                                                                                                                                                                                                                                                                                                                                                                                           
import { Validator } from '../backend/validation';
 
import { apiCodeValidator } from './_code';
import {
  api200Body,
  api400Body,
  api401Body, api403Body, api500Body
} from './_shared';
 
export interface AdjacentSiteBodyItem {
  time: string;
  rfss: string;
  site: string;
  sys_shortname: string;
  conv_ch: boolean;
  site_failed: boolean;
  valid_info: boolean;
  composite_ctrl: boolean;
  active_conn: boolean;
  backup_ctrl: boolean;
  no_service_req: boolean;
  supports_data: boolean;
  supports_voice: boolean;
  supports_registration: boolean;
  supports_authentication: boolean;
}
 
interface SiteObjectValue<T = boolean> {
  [tower: string]: T;
}
 
export interface FullSiteObject {
  SiteId: string;
  SiteName?: string;
 
  IsActive?: 'y' | 'n';
  SiteCounty?: string;
  SiteLat?: number;
  SiteLon?: number;
  SiteRng?: number;
 
  // Dynamic data
  ActiveConn?: SiteObjectValue;
  BackupCtrl?: SiteObjectValue;
  CompositeCtrl?: SiteObjectValue;
  ConvChannel?: SiteObjectValue;
  NoServReq?: SiteObjectValue;
  SiteFailed?: SiteObjectValue;
  SupportAuth?: SiteObjectValue;
  SupportData?: SiteObjectValue;
  SupportReg?: SiteObjectValue;
  SupportVoice?: SiteObjectValue;
  ValidInfo?: SiteObjectValue;
  UpdateTime?: SiteObjectValue<number>;
}
 
export type DynamicSiteKeys = Extract<{
  [key in keyof FullSiteObject]: SiteObjectValue<boolean> extends FullSiteObject[key]
    ? key
    : SiteObjectValue<number> extends FullSiteObject[key]
      ? key
      : never;
}[keyof FullSiteObject], string>;
 
/**
 * Retrieve a list of sites that have information
 * @summary Retrieve Sites List
 * @tags Sites
 */
export type GetAllSitesApi = {
  path: '/api/v2/sites/';
  method: 'GET';
  responses: {
 
    /**
     * @contentType application/json
     */
    200: {
      count: number;
      sites: FullSiteObject[];
    };
 
    /**
     * @contentType application/json
     */
    401: typeof api401Body;
 
    /**
     * @contentType application/json
     */
    403: typeof api403Body;
 
    /**
     * @contentType application/json
     */
    500: typeof api500Body;
  };
  security: [{
    cookie: [],
  }];
};
 
/**
 * Update site information from the DTR recorders
 * @summary Update Site Information
 * @tags Sites
 */
export type UpdateSitesApi = {
  path: '/api/v2/sites/';
  method: 'POST';
  body: {
    adjacent: ('' | AdjacentSiteBodyItem[])[];
 
    /**
     * The API code for validation
     */
    code: string;
  };
  responses: {
 
    /**
     * @contentType application/json
     */
    200: typeof api200Body;
 
    /**
     * @contentType application/json
     */
    400: typeof api400Body;
 
    /**
     * @contentType application/json
     */
    401: typeof api401Body;
 
    /**
     * @contentType application/json
     */
    500: typeof api500Body;
  };
  security: [{
    apiKey: [],
  }];
};
 
export const adjacentSiteItemValidator: Validator<AdjacentSiteBodyItem> = {
  time: {
    required: true,
    types: {
      string: {
        regex: /^[0-9]+$/,
      },
    },
  },
  rfss: {
    required: true,
    types: { string: {}, },
  },
  site: {
    required: true,
    types: { string: {}, },
  },
  sys_shortname: {
    required: true,
    types: { string: {}, },
  },
  conv_ch: {
    required: true,
    types: { boolean: {}, },
  },
  site_failed: {
    required: true,
    types: { boolean: {}, },
  },
  valid_info: {
    required: true,
    types: { boolean: {}, },
  },
  composite_ctrl: {
    required: true,
    types: { boolean: {}, },
  },
  active_conn: {
    required: true,
    types: { boolean: {}, },
  },
  backup_ctrl: {
    required: true,
    types: { boolean: {}, },
  },
  no_service_req: {
    required: true,
    types: { boolean: {}, },
  },
  supports_data: {
    required: true,
    types: { boolean: {}, },
  },
  supports_voice: {
    required: true,
    types: { boolean: {}, },
  },
  supports_registration: {
    required: true,
    types: { boolean: {}, },
  },
  supports_authentication: {
    required: true,
    types: { boolean: {}, },
  },
};
 
export const updateSitesBodyValidator: Validator<UpdateSitesApi['body']> = {
  ...apiCodeValidator,
  adjacent: {
    required: true,
    types: {
      array: {},
    },
  },
};