Class: ViewService

ViewService()

new ViewService()

Service for fetching rendered views from the DataONE MNView API.
Since:
  • 2.39.0
Source:

Extends

Methods

clearCache() → {Promise.<void>}

Clear the cache for the current user scope.
Inherited From:
Source:
Returns:
Promise resolving when the cache is cleared
Type
Promise.<void>

download(pid, optionsopt) → {Promise.<ViewServiceDoc>}

Download rendered HTML and return a parsed rendered metadata document. This method intentionally bypasses DataONEService.download so rendered HTML is not persistently cached by default.
Parameters:
Name Type Attributes Description
pid string PID or SID to render
options object <optional>
 Request and document options
Properties
Name Type Attributes Description
resolveBaseUrl string <optional>
 Resolve URL for ecogrid rewrites
Overrides:
Source:
Returns:
Parsed rendered document
Type
Promise.<ViewServiceDoc>

fetch(pid, optionsopt) → {Promise.<DataONEHttpResponse>}

Fetch rendered HTML and return the full normalized HTTP response.
Parameters:
Name Type Attributes Description
pid string PID or SID to render
options object <optional>
 Request options for DataONEService#request.
Source:
Returns:
Normalized response
Type
Promise.<DataONEHttpResponse>

getCached(key) → {Promise.<*>}

Get a cached value scoped by the current user.
Parameters:
Name Type Description
key string Cache key
Inherited From:
Source:
Returns:
Promise resolving to the cached value
Type
Promise.<*>

getStore() → {PersistentStorage}

Get a PersistentStorage instance automatically scoped by the logged in user, using the configuration options provided to the constructor.
Inherited From:
Source:
Returns:
Storage instance
Type
PersistentStorage

getToken() → {Promise.<string>}

Resolve an auth token from MetacatUI when available.
Inherited From:
Source:
Returns:
Promise resolving to an auth token
Type
Promise.<string>

getUserName() → {Promise.<(string|null)>}

Resolve the current username from the MetacatUI app user model.
Inherited From:
Source:
Returns:
Promise resolving to the username, or null if unavailable.
Type
Promise.<(string|null)>

invalidate(pid) → {Promise.<void>}

Remove an explicitly cached rendered document, if a caller opted into cache use in the future.
Parameters:
Name Type Description
pid string PID to invalidate
Source:
Returns:
Promise resolving when invalidation completes
Type
Promise.<void>

isCached(key) → {Promise.<boolean>}

Check whether a value exists in the cache for the current user scope.
Parameters:
Name Type Description
key string Cache key
Inherited From:
Source:
Returns:
Promise resolving to whether the value is cached.
Type
Promise.<boolean>

removeCached(key) → {Promise.<void>}

Remove a cached value for the current user scope.
Parameters:
Name Type Description
key string Cache key
Inherited From:
Source:
Returns:
Promise resolving when removal completes
Type
Promise.<void>

request(optionsopt) → {Promise.<DataONEHttpResponse>}

Send a request via the DataONEHttpClient.
Parameters:
Name Type Attributes Description
options object <optional>
 Request options passed to DataONEHttpClient#request, plus auth controls.
Properties
Name Type Attributes Description
path string Path relative to baseUrl
auth boolean <optional>
 Whether to resolve a token automatically
Inherited From:
Source:
Returns:
Promise resolving to the response.
Type
Promise.<DataONEHttpResponse>

requestWithClient(client, optionsopt) → {Promise.<DataONEHttpResponse>}

Send a request through a specific DataONEHttpClient instance.
Parameters:
Name Type Attributes Description
client DataONEHttpClient Client instance to use
options object <optional>
 Request options
Inherited From:
Source:
Throws:
When client is invalid or the request fails
Type
Error
Returns:
Promise resolving to the response.
Type
Promise.<DataONEHttpResponse>

resolveToken(authopt) → {Promise.<(string|null)>}

Determine the token to use, if any, for a request.
Parameters:
Name Type Attributes Description
auth boolean <optional>
 Whether to use authentication for this request If set to false, no token will be used. If true, getToken() will be called. When undefined, defaultAuth is used.
Inherited From:
Source:
Returns:
Promise resolving to the token, or null if no auth.
Type
Promise.<(string|null)>

scopeKey() → {Promise.<string>}

If user is logged in, get a key based on their username; otherwise, return a "public" scope key.
Inherited From:
Source:
Returns:
Promise resolving to the scope key
Type
Promise.<string>

sendParsedIdentifierRequest(params) → {Promise.<DataONEHttpResponse>}

Send a request whose body is a DataONE identifier response and parse the returned XML. Shared by services that POST/PUT and read back an identifier (e.g. IdentifierService, ObjectService).
Parameters:
Name Type Description
params object Request params
Properties
Name Type Attributes Description
client DataONEHttpClient <optional>
 Client to use. Defaults to the service's primary client when omitted.
requestOptions object Options from DataONEService.buildRequestOptions.
context string Error/parse context label
Inherited From:
Source:
Throws:
When the request or identifier parsing fails
Type
Error
Returns:
Response with parsed identifier data.
Type
Promise.<DataONEHttpResponse>

setCached(key, value, optionsopt) → {Promise.<*>}

Store a value in the cache for the current user scope.
Parameters:
Name Type Attributes Description
key string Cache key
value * Value to store
options object <optional>
 Cache scope options
Properties
Name Type Attributes Description
ttlMs number | null <optional>
 Override cache TTL in ms
Inherited From:
Source:
Returns:
Promise resolving to the stored value
Type
Promise.<*>

shouldUseCache() → {Promise.<boolean>}

Determine whether caching is allowed for the current user scope.
Inherited From:
Source:
Returns:
Promise resolving to whether caching is allowed.
Type
Promise.<boolean>

upload(path, optionsopt) → {Promise.<DataONEHttpResponse>}

Upload data to a path.
Parameters:
Name Type Attributes Description
path string Path relative to baseUrl
options object <optional>
 Options passed to DataONEHttpClient#request (except `path`), plus cache controls.
Properties
Name Type Attributes Description
auth boolean <optional>
 Whether to resolve a token automatically
cacheKey string <optional>
 Cache key override
Inherited From:
Source:
Returns:
Promise resolving to the response.
Type
Promise.<DataONEHttpResponse>

ViewService(optionsopt)

new ViewService(optionsopt)

Parameters:
Name Type Attributes Description
options object <optional>
 Options for the ViewService. See DataONEService.optionsFromDescriptor for the shared option shape.
Properties
Name Type Attributes Description
baseUrl string <optional>
 Theme-qualified view-service base URL, e.g. `/views/metacatui/`.
theme string <optional>
 Theme name requested by this service Stored for callers; `baseUrl` is still expected to be theme-qualified in this slice.
Source:

Methods

clearCache() → {Promise.<void>}

Clear the cache for the current user scope.
Inherited From:
Source:
Returns:
Promise resolving when the cache is cleared
Type
Promise.<void>

download(pid, optionsopt) → {Promise.<ViewServiceDoc>}

Download rendered HTML and return a parsed rendered metadata document. This method intentionally bypasses DataONEService.download so rendered HTML is not persistently cached by default.
Parameters:
Name Type Attributes Description
pid string PID or SID to render
options object <optional>
 Request and document options
Properties
Name Type Attributes Description
resolveBaseUrl string <optional>
 Resolve URL for ecogrid rewrites
Overrides:
Source:
Returns:
Parsed rendered document
Type
Promise.<ViewServiceDoc>

fetch(pid, optionsopt) → {Promise.<DataONEHttpResponse>}

Fetch rendered HTML and return the full normalized HTTP response.
Parameters:
Name Type Attributes Description
pid string PID or SID to render
options object <optional>
 Request options for DataONEService#request.
Source:
Returns:
Normalized response
Type
Promise.<DataONEHttpResponse>

getCached(key) → {Promise.<*>}

Get a cached value scoped by the current user.
Parameters:
Name Type Description
key string Cache key
Inherited From:
Source:
Returns:
Promise resolving to the cached value
Type
Promise.<*>

getStore() → {PersistentStorage}

Get a PersistentStorage instance automatically scoped by the logged in user, using the configuration options provided to the constructor.
Inherited From:
Source:
Returns:
Storage instance
Type
PersistentStorage

getToken() → {Promise.<string>}

Resolve an auth token from MetacatUI when available.
Inherited From:
Source:
Returns:
Promise resolving to an auth token
Type
Promise.<string>

getUserName() → {Promise.<(string|null)>}

Resolve the current username from the MetacatUI app user model.
Inherited From:
Source:
Returns:
Promise resolving to the username, or null if unavailable.
Type
Promise.<(string|null)>

invalidate(pid) → {Promise.<void>}

Remove an explicitly cached rendered document, if a caller opted into cache use in the future.
Parameters:
Name Type Description
pid string PID to invalidate
Source:
Returns:
Promise resolving when invalidation completes
Type
Promise.<void>

isCached(key) → {Promise.<boolean>}

Check whether a value exists in the cache for the current user scope.
Parameters:
Name Type Description
key string Cache key
Inherited From:
Source:
Returns:
Promise resolving to whether the value is cached.
Type
Promise.<boolean>

removeCached(key) → {Promise.<void>}

Remove a cached value for the current user scope.
Parameters:
Name Type Description
key string Cache key
Inherited From:
Source:
Returns:
Promise resolving when removal completes
Type
Promise.<void>

request(optionsopt) → {Promise.<DataONEHttpResponse>}

Send a request via the DataONEHttpClient.
Parameters:
Name Type Attributes Description
options object <optional>
 Request options passed to DataONEHttpClient#request, plus auth controls.
Properties
Name Type Attributes Description
path string Path relative to baseUrl
auth boolean <optional>
 Whether to resolve a token automatically
Inherited From:
Source:
Returns:
Promise resolving to the response.
Type
Promise.<DataONEHttpResponse>

requestWithClient(client, optionsopt) → {Promise.<DataONEHttpResponse>}

Send a request through a specific DataONEHttpClient instance.
Parameters:
Name Type Attributes Description
client DataONEHttpClient Client instance to use
options object <optional>
 Request options
Inherited From:
Source:
Throws:
When client is invalid or the request fails
Type
Error
Returns:
Promise resolving to the response.
Type
Promise.<DataONEHttpResponse>

resolveToken(authopt) → {Promise.<(string|null)>}

Determine the token to use, if any, for a request.
Parameters:
Name Type Attributes Description
auth boolean <optional>
 Whether to use authentication for this request If set to false, no token will be used. If true, getToken() will be called. When undefined, defaultAuth is used.
Inherited From:
Source:
Returns:
Promise resolving to the token, or null if no auth.
Type
Promise.<(string|null)>

scopeKey() → {Promise.<string>}

If user is logged in, get a key based on their username; otherwise, return a "public" scope key.
Inherited From:
Source:
Returns:
Promise resolving to the scope key
Type
Promise.<string>

sendParsedIdentifierRequest(params) → {Promise.<DataONEHttpResponse>}

Send a request whose body is a DataONE identifier response and parse the returned XML. Shared by services that POST/PUT and read back an identifier (e.g. IdentifierService, ObjectService).
Parameters:
Name Type Description
params object Request params
Properties
Name Type Attributes Description
client DataONEHttpClient <optional>
 Client to use. Defaults to the service's primary client when omitted.
requestOptions object Options from DataONEService.buildRequestOptions.
context string Error/parse context label
Inherited From:
Source:
Throws:
When the request or identifier parsing fails
Type
Error
Returns:
Response with parsed identifier data.
Type
Promise.<DataONEHttpResponse>

setCached(key, value, optionsopt) → {Promise.<*>}

Store a value in the cache for the current user scope.
Parameters:
Name Type Attributes Description
key string Cache key
value * Value to store
options object <optional>
 Cache scope options
Properties
Name Type Attributes Description
ttlMs number | null <optional>
 Override cache TTL in ms
Inherited From:
Source:
Returns:
Promise resolving to the stored value
Type
Promise.<*>

shouldUseCache() → {Promise.<boolean>}

Determine whether caching is allowed for the current user scope.
Inherited From:
Source:
Returns:
Promise resolving to whether caching is allowed.
Type
Promise.<boolean>

upload(path, optionsopt) → {Promise.<DataONEHttpResponse>}

Upload data to a path.
Parameters:
Name Type Attributes Description
path string Path relative to baseUrl
options object <optional>
 Options passed to DataONEHttpClient#request (except `path`), plus cache controls.
Properties
Name Type Attributes Description
auth boolean <optional>
 Whether to resolve a token automatically
cacheKey string <optional>
 Cache key override
Inherited From:
Source:
Returns:
Promise resolving to the response.
Type
Promise.<DataONEHttpResponse>