Module: api/apiUtils: JSDoc

(static) dataMwContentType(outputContentVersion)

Return the appropriate content-type string for a data-mw JSON blob.

Parameters:

Name	Type	Description
`outputContentVersion`	string

Source:

api/apiUtils.js, line 269

(static) dataParsoidContentType(outputContentVersion)

Return the appropriate content-type string for a data-parsoid JSON blob.

Parameters:

Name	Type	Description
`outputContentVersion`	string

Source:

api/apiUtils.js, line 260

(static) doDowngrade(downgrade, metricsopt, env, revision, version) → {Object}

Downgrade content

.

Downgrade content

Parameters:

Name	Type	Attributes
`downgrade`	Object
`metrics`	Object	<optional>
`env`	MWParserEnvironment
`revision`	Object
`version`	string

Source:

api/apiUtils.js, line 529

Returns:

Type: Object

(static) errorHandler(env, err)

Generic error response handler.

Parameters:

Name	Type	Description
`env`	MWParserEnvironment
`err`	Error

Source:

api/apiUtils.js, line 176

(static) errorResponse(res, text, statusopt)

Error response.

Parameters:

Name	Type	Attributes	Description
`res`	Response		The response object from our routing function.
`text`	string
`status`	number	<optional>

Source:

api/apiUtils.js, line 150

(static) errorWrapper(env, promiseOrValue)

Wrap a promised value with a catch that invokes #errorHandler.

Parameters:

Name	Type	Description
`env`	MWParserEnvironment
`promiseOrValue`	Promise \| any

Source:

api/apiUtils.js, line 193

(static) extractPageBundle(revision) → {Object}

Extracts a pagebundle from a revision.

Parameters:

Name	Type	Description
`revision`	Object

Source:

api/apiUtils.js, line 279

Returns:

Type: Object

(static) fatalRequest(env, text, httpStatusopt)

Log a fatal/request.

Parameters:

Name	Type	Attributes
`env`	MWParserEnvironment
`text`	string
`httpStatus`	number	<optional>

Source:

api/apiUtils.js, line 316

(static) findDowngrade(from, to) → {Object|`undefined`}

Is this a transition we know how to handle?

.

Is this a transition we know how to handle?

Parameters:

Name	Type	Description
`from`	string
`to`	string

Source:

api/apiUtils.js, line 510

Returns:

Type: Object | undefined

(static) htmlContentType(outputContentVersion)

Return the appropriate content-type string for Parsoid HTML.

Parameters:

Name	Type	Description
`outputContentVersion`	string

Source:

api/apiUtils.js, line 242

(static) htmlResponse(res, body, statusopt, headersopt, omitEscapeopt)

Send an html response, but only if response hasn't been sent.

Parameters:

Name Type Attributes Description

res

Response

The response object from our routing function.

body string

status

number

HTTP status code.

headers

Object

HTTP headers to include.

Properties

Name	Type	Attributes	Description
`content-type`	string	<optional>	A more specific type to use.
`content-language`	string	<optional>	Content language of response.
`vary`	string	<optional>	Vary header contents.

omitEscape

boolean

Be explicit about omitting escaping.

Source:

api/apiUtils.js, line 65

(static) jsonResponse(res, json, statusopt, contentTypeopt)

Send a JSON response, but only if response hasn't been sent.

Parameters:

Name	Type	Attributes	Description
`res`	Response		The response object from our routing function.
`json`	Object
`status`	number	<optional>	HTTP status code.
`contentType`	string	<optional>	A more specific type to use.

Source:

api/apiUtils.js, line 120

(static) pagebundleContentType(outputContentVersion)

Return the appropriate content-type string for a Parsoid page bundle.

Parameters:

Name	Type	Description
`outputContentVersion`	string

Source:

api/apiUtils.js, line 251

(static) parseProfile(profile, format) → {Object|`null`}

Used to extract the format and content version from a profile.

Parameters:

Name	Type	Description
`profile`	string
`format`	string	Just used for backwards compatibility w/ <= 1.2.0 where the pagebundle didn't have a spec.

Source:

api/apiUtils.js, line 361

Returns:

Type: Object | null

(static) plainResponse(res, text, statusopt, contentTypeopt)

Send a plaintext response, but only if response hasn't been sent.

Parameters:

Name	Type	Attributes	Description
`res`	Response		The response object from our routing function.
`text`	string
`status`	number	<optional>	HTTP status code.
`contentType`	string	<optional>	A more specific type to use.

Source:

api/apiUtils.js, line 99

(static) redirectToOldid(req, res)

Generate an HTTP redirect to a specific revision.

Parameters:

Name	Type	Description
`req`	Request
`res`	Response

Source:

api/apiUtils.js, line 449

(static) relativeRedirect(res, path, httpStatusopt)

Send a redirect response with optional code and a relative URL.

Parameters:

Name	Type	Attributes	Description
`res`	Response		The response object from our routing function.
`path`	string
`httpStatus`	number	<optional>

Source:

api/apiUtils.js, line 31

(static) renderResponse(res, view, locals)

Render response, but only if response hasn't been sent.

Parameters:

Name	Type	Description
`res`	Response	The response object from our routing function.
`view`	string
`locals`	Object

Source:

api/apiUtils.js, line 138

(static) returnDowngrade(downgrade, metricsopt, env, revision, res, contentmodelopt)

Downgrade and return content

.

Downgrade and return content

Parameters:

Name	Type	Attributes
`downgrade`	Object
`metrics`	Object	<optional>
`env`	MWParserEnvironment
`revision`	Object
`res`	Response
`contentmodel`	string	<optional>

Source:

api/apiUtils.js, line 550

(static) setHeader(res, field, value)

Set header, but only if response hasn't been sent.

Parameters:

Name	Type	Description
`res`	Response	The response object from our routing function.
`field`	string
`value`	string

Source:

api/apiUtils.js, line 47

(static) shouldScrub() → {boolean}

...

Source:

api/apiUtils.js, line 604

Returns:

Type: boolean

(static) substTopLevelTemplates(env, target, wt)

To support the 'subst' API parameter, we need to prefix each top-level template with 'subst'.

To support the 'subst' API parameter, we need to prefix each top-level template with 'subst'. To make sure we do this for the correct templates, tokenize the starting wikitext and use that to detect top-level templates. Then, substitute each starting '{{' with '{{subst' using the template token's tsr.

Parameters:

Name	Type	Description
`env`	MWParserEnvironment
`target`	string
`wt`	string

Source:

api/apiUtils.js, line 210

(static) validateAndSetOutputContentVersion(res, acceptableTypes) → {boolean}

Set the content version to an acceptable version.

Set the content version to an acceptable version. Returns false if Parsoid is unable to supply one.

Parameters:

Name	Type	Description
`res`	Response
`acceptableTypes`	Array

Source:

api/apiUtils.js, line 386

Returns:

Type: boolean

(static) validatePageBundle(pb, originalVersion)

Validates the pagebundle was provided in the expected format.

Parameters:

Name	Type	Description
`pb`	Object
`originalVersion`	string

Source:

api/apiUtils.js, line 292

(static) versionFromType(html) → {string|`null`}

Determine the content version from the html's content type.

Parameters:

Name	Type	Description
`html`	Object

Source:

api/apiUtils.js, line 329

Returns:

Type: string | null

(static) wikitextContentType(env)

Return the appropriate content-type string for wikitext.

Parameters:

Name	Type	Description
`env`	MWParserEnvironment

Source:

api/apiUtils.js, line 233

(static) wt2htmlRes(res, html, pb, contentmodelopt, headers, outputContentVersion)

Send an appropriate response with the right content types for wt2html.

Parameters:

Name	Type	Attributes
`res`	Object
`html`	string
`pb`	Object
`contentmodel`	string	<optional>
`headers`	Object
`outputContentVersion`	string

Source:

api/apiUtils.js, line 572

Methods

(static) dataMwContentType(outputContentVersion)

Parameters:

(static) dataParsoidContentType(outputContentVersion)

Parameters:

(static) doDowngrade(downgrade, metricsopt, env, revision, version) → {Object}

Parameters:

Returns:

(static) errorHandler(env, err)

Parameters:

(static) errorResponse(res, text, statusopt)

Parameters:

(static) errorWrapper(env, promiseOrValue)

Parameters:

(static) extractPageBundle(revision) → {Object}

Parameters:

Returns:

(static) fatalRequest(env, text, httpStatusopt)

Parameters:

(static) findDowngrade(from, to) → {Object|undefined}

Parameters:

Returns:

(static) htmlContentType(outputContentVersion)

Parameters:

(static) htmlResponse(res, body, statusopt, headersopt, omitEscapeopt)

Parameters:

Properties

(static) jsonResponse(res, json, statusopt, contentTypeopt)

Parameters:

(static) pagebundleContentType(outputContentVersion)

Parameters:

(static) parseProfile(profile, format) → {Object|null}

Parameters:

Returns:

(static) plainResponse(res, text, statusopt, contentTypeopt)

Parameters:

(static) redirectToOldid(req, res)

Parameters:

(static) relativeRedirect(res, path, httpStatusopt)

Parameters:

(static) renderResponse(res, view, locals)

Parameters:

(static) returnDowngrade(downgrade, metricsopt, env, revision, res, contentmodelopt)

Parameters:

(static) setHeader(res, field, value)

Parameters:

(static) shouldScrub() → {boolean}

Returns:

(static) substTopLevelTemplates(env, target, wt)

Parameters:

(static) validateAndSetOutputContentVersion(res, acceptableTypes) → {boolean}

Parameters:

Returns:

(static) validatePageBundle(pb, originalVersion)

Parameters:

(static) versionFromType(html) → {string|null}

Parameters:

Returns:

(static) wikitextContentType(env)

Parameters:

(static) wt2htmlRes(res, html, pb, contentmodelopt, headers, outputContentVersion)

Parameters:

(inner) downgrade999to2(doc, pb)

Parameters:

(static) findDowngrade(from, to) → {Object|`undefined`}

(static) parseProfile(profile, format) → {Object|`null`}

(static) versionFromType(html) → {string|`null`}