kylefang/DefinitelyTyped
1
0
Fork 0
mirror of https://github.com/zhigang1992/DefinitelyTyped.git synced 2026-05-13 12:37:16 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
d1d40be2a932dcbd4e91b54b496a40d28cf2ae40
DefinitelyTyped/har-format/index.d.ts
Michael Mrowetz 63fb2e895a add har-format - typings for HAR files (#14932) 
* Add type definition for `HAR` - HTTP Archive 1.2

* fix formating
2017-03-09 22:48:39 -08:00

812 lines
24 KiB
TypeScript
Raw Blame History

// Type definitions for HAR 1.2
// Project: https://w3c.github.io/web-performance/specs/HAR/Overview.html
// Definitions by: Michael Mrowetz <https://github.com/micmro>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
/**
* HTTP Archive 1.2
*
* http://www.softwareishard.com/blog/har-12-spec
*/
export interface Har {
/** This object represents the root of exported data. */
"log": Log;
}
/**
* This object (`log`) represents the root of exported data.
*
* http://www.softwareishard.com/blog/har-12-spec/#log
*/
export interface Log {
/**
* Version number of the format.
*
* _If empty, string "1.1" is assumed by default._
*/
version: string;
/** Name and version info of the log creator application. */
creator: Creator;
/** Name and version info of used browser. */
browser?: Browser;
/**
* List of all exported (tracked) pages.
*
* _Leave out this field if the application
* does not support grouping by pages._
*
* There is one `<page>` object for every exported web page and one
* `<entry>` object for every HTTP request.
* In case when an HTTP trace tool isn't able to group requests by a page,
* the `<pages>` object is empty and individual requests doesn't have a
* parent page.
*/
pages?: Page[];
/** List of all exported (tracked) requests. */
entries: Entry[];
/** A comment provided by the user or the application. */
comment?: string;
}
/**
* Infos about application/browser used to export the log.
*
* `Creator` and `Browser` objects share the same structure.
*
* http://www.softwareishard.com/blog/har-12-spec/#creator
*/
export interface Creator {
/** Name of the application/browser used to export the log. */
name: string;
/** Version of the application/browser used to export the log. */
version: string;
/** A comment provided by the user or the application. */
comment?: string;
}
/**
* Infos about application/browser used to export the log.
*
* `Browser` and `Creator` objects share the same structure.
*
* http://www.softwareishard.com/blog/har-12-spec/#browser
*/
export interface Browser {
/** Name of the application/browser used to export the log. */
name: string;
/** Version of the application/browser used to export the log. */
version: string;
/** A comment provided by the user or the application. */
comment?: string;
}
/**
* This object represents list of exported pages.
*
* http://www.softwareishard.com/blog/har-12-spec/#pages
*/
export interface Page {
/** Date and time stamp for the beginning of the page load
*
* (ISO 8601 - `YYYY-MM-DDThh:mm:ss.sTZD`,
* e.g. `2009-07-24T19:20:30.45+01:00`).
*/
startedDateTime: string;
/**
* Unique identifier of a page within the `<log>` (HAR doc).
* Entries use it to refer the parent page.
*/
id: string;
/** Page title. */
title: string;
/** Detailed timing info about page load */
pageTimings: PageTiming;
/** A comment provided by the user or the application */
comment?: string;
/** _non-standard_ */
/** _non-standard_ */
_adult_site?: number;
/** _non-standard_ */
_aft?: number;
/** _non-standard_ */
_base_page_cdn?: string;
/** _non-standard_ */
_base_page_redirects?: number;
/** _non-standard_ */
_base_page_ttfb?: number;
/** _non-standard_ */
_browser_main_memory_kb?: number;
/** _non-standard_ */
_browser_name?: string;
/** _non-standard_ */
_browser_other_private_memory_kb?: number;
/** _non-standard_ */
_browser_process_count?: number;
/** _non-standard_ */
_browser_version?: string;
/** _non-standard_ */
_browser_working_set_kb?: number;
/** _non-standard_ */
_bytesIn?: number;
/** _non-standard_ */
_bytesInDoc?: number;
/** _non-standard_ */
_bytesOut?: number;
/** _non-standard_ */
_bytesOutDoc?: number;
/** _non-standard_ */
_cached?: number;
/** _non-standard_ */
_certificate_bytes?: number;
/** _non-standard_ */
_connections?: number;
/** _non-standard_ */
_date?: number;
/** _non-standard_ */
_docCPUms?: number;
/** _non-standard_ */
_docCPUpct?: number;
/** _non-standard_ */
_docTime?: number;
/** _non-standard_ */
_domContentLoadedEventEnd?: number;
/** _non-standard_ */
_domContentLoadedEventStart?: number;
/** _non-standard_ */
_domElements?: number;
/** _non-standard_ */
_domInteractive?: number;
/** _non-standard_ */
_domLoading?: number;
/** _non-standard_ */
_domTime?: number;
/** _non-standard_ */
_effectiveBps?: number;
/** _non-standard_ */
_effectiveBpsDoc?: number;
/** _non-standard_ */
_eventName?: string;
/** _non-standard_ */
_firstPaint?: number;
/** _non-standard_ */
_fixed_viewport?: number;
/** _non-standard_ */
_fullyLoaded?: number;
/** _non-standard_ */
_fullyLoadedCPUms?: number;
/** _non-standard_ */
_fullyLoadedCPUpct?: number;
/** _non-standard_ */
_gzip_savings?: number;
/** _non-standard_ */
_gzip_total?: number;
/** _non-standard_ */
_image_savings?: number;
/** _non-standard_ */
_image_total?: number;
/** _non-standard_ */
_isResponsive?: number;
/** _non-standard_ */
_lastVisualChange?: number;
/** _non-standard_ */
_loadEventEnd?: number;
/** _non-standard_ */
_loadEventStart?: number;
/** _non-standard_ */
_loadTime?: number;
/** _non-standard_ */
_minify_savings?: number;
/** _non-standard_ */
_minify_total?: number;
/** _non-standard_ */
_optimization_checked?: number;
/** _non-standard_ */
_pageSpeedVersion?: string;
/** _non-standard_ */
_render?: number;
/** _non-standard_ */
_requests?: number;
/** _non-standard_ */
_requestsDoc?: number;
/** _non-standard_ */
_requestsFull?: number;
/** _non-standard_ */
_responses_200?: number;
/** _non-standard_ */
_responses_404?: number;
/** _non-standard_ */
_responses_other?: number;
/** _non-standard_ */
_result?: number;
/** _non-standard_ */
_run?: number;
/** _non-standard_ */
_score_cache?: number;
/** _non-standard_ */
_score_cdn?: number;
/** _non-standard_ */
_score_combine?: number;
/** _non-standard_ */
_score_compress?: number;
/** _non-standard_ */
_score_cookies?: number;
/** _non-standard_ */
_score_etags?: number;
/** _non-standard_ */
_score_gzip?: number;
/** _non-standard_ */
"_score_keep-alive"?: number;
/** _non-standard_ */
_score_minify?: number;
/** _non-standard_ */
_score_progressive_jpeg?: number;
/** _non-standard_ */
_server_count?: number;
/** _non-standard_ */
_server_rtt?: number;
/** _non-standard_ */
_SpeedIndex?: number;
/** _non-standard_ */
_step?: number;
/** _non-standard_ */
_title?: string;
/** _non-standard_ */
_titleTime?: number;
/** _non-standard_ */
_TTFB?: number;
/** _non-standard_ */
_URL?: string;
/** _non-standard_ */
_visualComplete?: number;
}
/**
* This object describes timings for various events (states) fired during the
* page load.
*
* All times are specified in milliseconds.
*
* If a time info is not available appropriate field is set to `-1`.
*
* http://www.softwareishard.com/blog/har-12-spec/#pageTimings
*/
export interface PageTiming {
/** Content of the page loaded. Number of milliseconds since page load
* started (`page.startedDateTime`).
*
* Use `-1` if the timing does not apply to the current request.
*/
onContentLoad?: number;
/** Page is loaded (`onLoad` event fired). Number of milliseconds since
* page load started (`page.startedDateTime`).
*
* Use `-1` if the timing does not apply to the current request.
*/
onLoad?: number;
/** A comment provided by the user or the application */
comment?: string;
_startRender?: number;
}
/**
* This object represents an array with all exported HTTP requests. Sorting
* entries by `startedDateTime` (starting from the oldest) is preferred way how
* to export data since it can make importing faster.
* However the reader application should always make sure the array is sorted
* (if required for the import).
*
* http://www.softwareishard.com/blog/har-12-spec/#entries
*/
export interface Entry {
/**
* Reference to the parent page. Leave out this field if the application
* does not support grouping by pages.
*/
pageref?: string;
/**
* Date and time stamp of the request start
*
* (ISO 8601 - `YYYY-MM-DDThh:mm:ss.sTZD`).
*/
startedDateTime: string;
/**
* Total elapsed time of the request in milliseconds.
*
* This is the sum of all timings available in the timings object
* (i.e. not including `-1` values).
*/
time: number;
/** Detailed info about the request. */
request: Request;
/** Detailed info about the response. */
response: Response;
/** Info about cache usage. */
cache: Cache;
/** Detailed timing info about request/response round trip. */
timings: Timings;
/**
* IP address of the server that was connected
* (result of DNS resolution).
*/
serverIPAddress?: string;
/**
* Unique ID of the parent TCP/IP connection, can be the client or server
* port number.
*
* Note that a port number doesn't have to be unique identifier
* in cases where the port is shared for more connections.
*
* If the port isn't available for the application, any other unique
* connection ID can be used instead (e.g. connection index). Leave out
* this field if the application doesn't support this info.
*/
connection?: string;
/** A comment provided by the user or the application */
comment?: string;
/** _non-standard_ */
_all_end?: number | string;
/** _non-standard_ */
_all_ms?: number | string;
/** _non-standard_ */
_all_start?: number | string;
/** _non-standard_ */
_bytesIn?: number | string;
/** _non-standard_ */
_bytesOut?: number | string;
/** _non-standard_ */
_cacheControl?: string;
/** _non-standard_ */
_cache_time?: number | string;
/** _non-standard_ */
_cdn_provider?: string;
/** _non-standard_ */
_certificate_bytes?: number | string;
/** _non-standard_ */
_client_port?: number | string;
/** _non-standard_ */
_connect_end?: number | string;
/** _non-standard_ */
_connect_ms?: number | string;
/** _non-standard_ */
_connect_start?: number | string;
/** _non-standard_ */
_contentEncoding?: string;
/** _non-standard_ */
_contentType?: string;
/** _non-standard_ */
_dns_end?: number | string;
/** _non-standard_ */
_dns_ms?: number | string;
/** _non-standard_ */
_dns_start?: number | string;
/** _non-standard_ */
_download_end?: number | string;
/** _non-standard_ */
_download_ms?: number | string;
/** _non-standard_ */
_download_start?: number | string;
/** _non-standard_ */
_expires?: string;
/** _non-standard_ */
_full_url?: string;
/** _non-standard_ */
_gzip_save?: number | string;
/** _non-standard_ */
_gzip_total?: number | string;
/** _non-standard_ */
_host?: string;
/** _non-standard_ */
_http2_stream_dependency?: number | string;
/** _non-standard_ */
_http2_stream_exclusive?: number | string;
/** _non-standard_ */
_http2_stream_id?: number | string;
/** _non-standard_ */
_http2_stream_weight?: number | string;
/** _non-standard_ */
_image_save?: number | string;
/** _non-standard_ */
_image_total?: number | string;
/** _non-standard_ */
_index?: number;
/** _non-standard_ */
_initiator?: string;
/** _non-standard_ */
_initiator_column?: string;
/** _non-standard_ */
_initiator_detail?: string;
/** _non-standard_ */
_initiator_function?: string;
/** _non-standard_ */
_initiator_line?: string;
/** _non-standard_ */
_initiator_type?: string;
/** _non-standard_ */
_ip_addr?: string;
/** _non-standard_ */
_is_secure?: number | string;
/** _non-standard_ */
_jpeg_scan_count?: number | string;
/** _non-standard_ */
_load_end?: number | string;
/** _non-standard_ */
_load_ms?: number | string;
/** _non-standard_ */
_load_start?: number | string;
/** _non-standard_ */
_method?: string;
/** _non-standard_ */
_minify_save?: number | string;
/** _non-standard_ */
_minify_total?: number | string;
/** _non-standard_ */
_number?: number;
/** _non-standard_ */
_objectSize?: number | string;
/** _non-standard_ */
_objectSizeUncompressed?: number | string;
/** _non-standard_ */
_priority?: string;
/** _non-standard_ */
_protocol?: number | string;
/** _non-standard_ */
_request_id?: number | string;
/** _non-standard_ */
_responseCode?: number | string;
/** _non-standard_ */
_score_cache?: number | string;
/** _non-standard_ */
_score_cdn?: number | string;
/** _non-standard_ */
_score_combine?: number | string;
/** _non-standard_ */
_score_compress?: number | string;
/** _non-standard_ */
_score_cookies?: number | string;
/** _non-standard_ */
_score_etags?: number | string;
/** _non-standard_ */
_score_gzip?: number | string;
/** _non-standard_ */
"_score_keep-alive"?: number | string;
/** _non-standard_ */
_score_minify?: number | string;
/** _non-standard_ */
_score_progressive_jpeg?: number;
/** _non-standard_ */
_server_count?: number | string;
/** _non-standard_ */
_server_rtt?: number | string;
/** _non-standard_ */
_socket?: number | string;
/** _non-standard_ */
_ssl_end?: number | string;
/** _non-standard_ */
_ssl_ms?: number | string;
/** _non-standard_ */
_ssl_start?: number | string;
/** _non-standard_ */
_ttfb_end?: number | string;
/** _non-standard_ */
_ttfb_ms?: number | string;
/** _non-standard_ */
_ttfb_start?: number | string;
/** _non-standard_ */
_type?: number | string;
/** _non-standard_ */
_url?: string;
/** _non-standard_ */
_was_pushed?: number | string;
/** _non-standard_ */
_initialPriority?: string;
}
/**
* This object contains detailed info about performed request.
*
* http://www.softwareishard.com/blog/har-12-spec/#request
*/
export interface Request {
/** Request method (`GET`, `POST`, ...). */
method: string;
/** Absolute URL of the request (fragments are not included). */
url: string;
/** Request HTTP Version. */
httpVersion: string;
/** List of cookie objects. */
cookies: Cookie[];
/** List of header objects. */
headers: Header[];
/** List of query parameter objects. */
queryString: QueryString[];
/** Posted data info. */
postData?: PostData;
/**
* Total number of bytes from the start of the HTTP request message until
* (and including) the double CRLF before the body.
*
* Set to `-1` if the info is not available.
*/
headersSize: number;
/**
* Size of the request body (POST data payload) in bytes.
*
* Set to `-1` if the info is not available.
*/
bodySize: number;
/** A comment provided by the user or the application */
comment?: string;
}
/**
* This object contains detailed info about the response.
*
* http://www.softwareishard.com/blog/har-12-spec/#response
*/
export interface Response {
/** Response status. */
status: number;
/** Response status description. */
statusText: string;
/** Response HTTP Version. */
httpVersion: string;
/** List of cookie objects. */
cookies: Cookie[];
/** List of header objects. */
headers: Header[];
/** Details about the response body. */
content: Content;
/** Redirection target URL from the Location response header. */
redirectURL: string;
/**
* Total number of bytes from the start of the HTTP response message until
* (and including) the double CRLF before the body.
*
* Set to `-1` if the info is not available.
*
* _The size of received response-headers is computed only from headers
* that are really received from the server. Additional headers appended by
* the browser are not included in this number, but they appear in the list
* of header objects._
*/
headersSize: number;
/** Size of the received response body in bytes.
*
* - Set to zero in case of responses coming from the cache (`304`).
* - Set to `-1` if the info is not available.
*/
bodySize: number;
/** A comment provided by the user or the application */
comment?: string;
/** _non-standard_ */
_transferSize?: number;
}
/**
* This object contains list of all cookies (used in `request` and `response`
* objects).
*
* http://www.softwareishard.com/blog/har-12-spec/#cookies
*/
export interface Cookie {
/** The name of the cookie. */
name: string;
/** The cookie value. */
value: string;
/** The path pertaining to the cookie. */
path?: string;
/** The host of the cookie. */
domain?: string;
/**
* Cookie expiration time.
* (ISO 8601 - `YYYY-MM-DDThh:mm:ss.sTZD`,
* e.g. `2009-07-24T19:20:30.123+02:00`).
*/
expires?: string | Date | null;
/** Set to true if the cookie is HTTP only, false otherwise. */
httpOnly?: boolean;
/** True if the cookie was transmitted over ssl, false otherwise. */
secure?: boolean;
/** A comment provided by the user or the application */
comment?: string;
}
/**
* This object represents a headers (used in `request` and `response` objects).
*
* http://www.softwareishard.com/blog/har-12-spec/#headers
*/
export interface Header {
name: string;
value: string;
/** A comment provided by the user or the application */
comment?: string;
}
/**
* This object represents a parameter & value parsed from a query string,
* if any (embedded in `request` object).
*
* http://www.softwareishard.com/blog/har-12-spec/#queryString
*/
export interface QueryString {
name: string;
value: string;
/** A comment provided by the user or the application */
comment?: string;
}
/**
* This object describes posted data, if any (embedded in `request` object).
*
* http://www.softwareishard.com/blog/har-12-spec/#postData
*/
export interface PostData {
/** Mime type of posted data. */
mimeType: string;
/** List of posted parameters (in case of URL encoded parameters).
*
* _`text` and `params` fields are mutually exclusive._
*/
params: Param[];
/** Plain text posted data
*
* _`params` and `text` fields are mutually exclusive._
*/
text: string;
/** A comment provided by the user or the application */
comment?: string;
}
/**
* List of posted parameters, if any (embedded in `postData` object).
*
* http://www.softwareishard.com/blog/har-12-spec/#params
*/
export interface Param {
/** name of a posted parameter. */
name: string;
/** value of a posted parameter or content of a posted file */
value?: string;
/** name of a posted file. */
fileName?: string;
/** content type of a posted file. */
contentType?: string;
/** A comment provided by the user or the application */
comment?: string;
}
/**
* This object describes details about response content
* (embedded in `response` object).
*
* http://www.softwareishard.com/blog/har-12-spec/#content
*/
export interface Content {
/**
* Length of the returned content in bytes.
*
* Should be equal to `response.bodySize` if there is no compression and
* bigger when the content has been compressed.
*/
size: number;
/**
* Number of bytes saved. Leave out this field if the information is not
* available.
*/
compression?: number;
/**
* MIME type of the response text (value of the Content-Type response
* header).
*
* The charset attribute of the MIME type is included (if available).
*/
mimeType: string;
/**
* Response body sent from the server or loaded from the browser cache.
*
* This field is populated with textual content only.
*
* The text field is either HTTP decoded text or a encoded (e.g. `base64`)
* representation of the response body.
*
* Leave out this field if the information is not available.
*/
text?: string;
/**
* Encoding used for response text field e.g `base64`.
*
* Leave out this field if the text field is HTTP decoded
* (decompressed & unchunked), than trans-coded from its original character
* set into UTF-8.
*/
encoding?: string;
/** A comment provided by the user or the application */
comment?: string;
}
/**
* This objects contains info about a request coming from browser cache.
*
* http://www.softwareishard.com/blog/har-12-spec/#cache
*/
export interface Cache {
/**
* State of a cache entry before the request.
*
* Leave out this field if the information is not available.
*/
beforeRequest?: CacheDetails;
/**
* State of a cache entry after the request.
*
* Leave out this field if the information is not available.
*/
afterRequest?: CacheDetails;
/** A comment provided by the user or the application */
comment?: string;
}
export interface CacheDetails {
/** Expiration time of the cache entry.
*
* _(Format not documente but assumingly ISO 8601 -
* `YYYY-MM-DDThh:mm:ss.sTZD`)_
*/
expires?: string;
/** The last time the cache entry was opened.
* *
* _(Format not documente but assumingly ISO 8601 -
* `YYYY-MM-DDThh:mm:ss.sTZD`)_
*/
lastAccess: string;
/** Etag */
eTag: string;
/** The number of times the cache entry has been opened. */
hitCount: number;
/** A comment provided by the user or the application */
comment?: string;
}
/**
* This object describes various phases within request-response round trip.
*
* All times are specified in milliseconds.
*
* http://www.softwareishard.com/blog/har-12-spec/#timings
*/
export interface Timings {
/**
* Time spent in a queue waiting for a network connection.
*
* Use `-1` if the timing does not apply to the current request.
*/
blocked?: number;
/**
* DNS resolution time. The time required to resolve a host name.
*
* Use `-1` if the timing does not apply to the current request.
*/
dns?: number;
/**
* Time required to create TCP connection.
*
* Use `-1` if the timing does not apply to the current request.
*/
connect?: number;
/**
* Time required to send HTTP request to the server.
*
* _Not optional and must have non-negative values._
*/
send?: number;
/**
* Waiting for a response from the server.
*
* _Not optional and must have non-negative values._
*/
wait: number;
/**
* Time required to read entire response from the server (or cache).
*
* _Not optional and must have non-negative values._
*/
receive: number;
/**
* Time required for SSL/TLS negotiation.
*
* If this field is defined then the time is also included in the connect
* field (to ensure backward compatibility with HAR 1.1).
*
* Use `-1` if the timing does not apply to the current request.
*/
ssl?: number;
/** A comment provided by the user or the application */
comment?: string;
}
Reference in New Issue View Git Blame Copy Permalink