Creates a new BatchedQueueClient. It allows to read and write from a SQS queue in batches, supporting larger batch sizes than the default of 10. If a message gets too big for SQS it is automatically swapped out to S3.
Name of the indexing configuration, subject to be renamed.
Promise.<(string|null)>Retrieves the content bus id by calculating the hash from the fstab.
Promise.<string>Retrieves the content bus id either from the context or by reading fstab entry of helix-config.json. If the helix-config.json does contain the information (yet) it will fall back to #calculateContentBusId.
Promise.<ConfigAll>Checks if the response is valid and returns the project config.
Promise.<ConfigAll>Retrieves the project config from the underlying storage and stores it in the context as projectConfig.
Promise.<ProjectConfig>Checks if the response is valid and returns the project config.
Promise.<ProjectConfig>Retrieves the project config from the underlying storage and stores it in the context as projectConfig.
Promise.<ProjectConfig>Checks if the response is valid and returns the project config.
Promise.<ProjectConfig>Retrieves the project config from the underlying storage and stores it in the context as projectConfig.
Promise.<MountConfig>Checks if the response is valid and returns a mount config.
Promise.<MountConfig>Retrieves the fstab from the underlying storage and stores it in the context as mountConfig.
Promise.<HelixConfig>Checks if the response is valid and returns the helix config.
Promise.<HelixConfig>Retrieves the helix-config.json which is an aggregate from fstab.yaml and head.html.
Note: it always uses the branch main.
Promise.<MountConfig>Checks if the response is valid and returns a IgnoreConfig.
Promise.<IgnoreConfig>Retrieves the hlxignore from github and stores it in the context as IgnoreConfig. If 404 is encountered, returns an empty IgnoreConfig that considers nothing ignored.
Promise.<IndexConfig>Checks if the response is valid and returns an index config.
Promise.<IndexConfig>Retrieves the indexing configuration from the underlying storage and stores it in the context as indexConfig.
Promise.<Response>Fetches content from s3
Promise.<SitemapConfig>Checks if the response is valid and returns a sitemap config.
Promise.<SitemapConfig>Retrieves the sitemap from the underlying storage and stores it in the context as sitemapConfig.
Converts a config row-based name/value pair array with dotted key notation to an object.
example:
host: www.adobe.com
document.level: 42,
document.title: hello
document.body.status: 200
acl.allow: /foo
acl.allow: /bar
cnd.0.type: fastly
cnd.0.host: www.adobe.com
cnd.1.type: cloudflare
becomes:
{
host: 'www.adobe.com',
document: {
level: 42,
title: 'hello',
body: {
status: 200,
}
},
acl: {
allow: ['/foo', '/bar],
}
cnd: [
{ type: 'fastly', host: 'www.adobe.com' },
{ type: 'cloudflare' },
]
}
ResponseGenerates an error response
Promise.<(string\|null)>
Retrieves the content bus id by calculating the hash from the fstab.
**Kind**: global function
**Returns**: Promise.<(string\|null)> - the content bus id or {@code null}
if no fstab or no mountpoint not found in fstab
| Param | Type | Description |
| --- | --- | --- |
| ctx | AdminContext | the context |
| info | PathInfo | lookup options |
## getContentBusId(ctx, info, optional) ⇒ Promise.<string>
Retrieves the content bus id either from the context or by reading fstab entry of
helix-config.json. If the helix-config.json does contain the information (yet) it will fall back
to [#calculateContentBusId](#calculateContentBusId).
**Kind**: global function
**Returns**: Promise.<string> - the content bus id
| Param | Type | Description |
| --- | --- | --- |
| ctx | AdminContext | the context |
| info | PathInfo | lookup options |
| optional | boolean | if {@code true} it will return {@code null} if none of the sources exists. |
## handleResponse(log, response, key, type) ⇒ Promise.<ConfigAll>
Checks if the response is valid and returns the project config.
**Kind**: global function
**Returns**: Promise.<ConfigAll> - the helix project config or null
| Param | Type | Description |
| --- | --- | --- |
| log | Console | logger |
| response | Response | content response from the storage |
| key | string | storage key (logging information) |
| type | string | type of storage (logging information) |
## fetchConfigAll(ctx, opts) ⇒ Promise.<ConfigAll>
Retrieves the project config from the underlying storage
and stores it in the context as projectConfig.
**Kind**: global function
**Returns**: Promise.<ConfigAll> - the project configuration
| Param | Type | Description |
| --- | --- | --- |
| ctx | AdminContext | the context |
| opts | PathInfo | lookup options |
## handleResponse(log, response, key, type) ⇒ Promise.<ProjectConfig>
Checks if the response is valid and returns the project config.
**Kind**: global function
**Returns**: Promise.<ProjectConfig> - the helix project config or null
| Param | Type | Description |
| --- | --- | --- |
| log | Console | logger |
| response | Response | content response from the storage |
| key | string | storage key (logging information) |
| type | string | type of storage (logging information) |
## fetchProjectConfig(ctx, opts) ⇒ Promise.<ProjectConfig>
Retrieves the project config from the underlying storage
and stores it in the context as projectConfig.
**Kind**: global function
**Returns**: Promise.<ProjectConfig> - the project configuration
| Param | Type | Description |
| --- | --- | --- |
| ctx | AdminContext | the context |
| opts | PathInfo | lookup options |
## handleResponse(log, response, key, type) ⇒ Promise.<ProjectConfig>
Checks if the response is valid and returns the project config.
**Kind**: global function
**Returns**: Promise.<ProjectConfig> - the helix project config or null
| Param | Type | Description |
| --- | --- | --- |
| log | Logger | logger |
| response | Response | content response from the storage |
| key | string | storage key (logging information) |
| type | string | type of storage (logging information) |
## fetchCrontab(ctx, opts) ⇒ Promise.<ProjectConfig>
Retrieves the project config from the underlying storage
and stores it in the context as projectConfig.
**Kind**: global function
**Returns**: Promise.<ProjectConfig> - the project configuration
| Param | Type | Description |
| --- | --- | --- |
| ctx | AdminContext | the context |
| opts | LookupOptions | lookup options |
## handleResponse(log, response, key, type) ⇒ Promise.<MountConfig>
Checks if the response is valid and returns a mount config.
**Kind**: global function
**Returns**: Promise.<MountConfig> - the mount config or null
| Param | Type | Description |
| --- | --- | --- |
| log | Logger | logger |
| response | Response | content response from the storage |
| key | string | storage key (logging information) |
| type | string | type of storage (logging information |
## fetchFstab(ctx, opts, optional) ⇒ Promise.<MountConfig>
Retrieves the fstab from the underlying storage and stores it in the context as mountConfig.
**Kind**: global function
**Returns**: Promise.<MountConfig> - the fstab
| Param | Type | Description |
| --- | --- | --- |
| ctx | AdminContext | the context |
| opts | LookupOptions | lookup options |
| optional | boolean | if {@code true}, no error is thrown if the fstab can't be retrieved |
## handleResponse(log, response, key, type) ⇒ Promise.<HelixConfig>
Checks if the response is valid and returns the helix config.
**Kind**: global function
**Returns**: Promise.<HelixConfig> - the index config or null
| Param | Type | Description |
| --- | --- | --- |
| log | Logger | logger |
| response | Response | content response from the storage |
| key | string | storage key (logging information) |
| type | string | type of storage (logging information |
## fetchHelixConfig(ctx, info, optional) ⇒ Promise.<HelixConfig>
Retrieves the helix-config.json which is an aggregate from fstab.yaml and head.html.
Note: it always uses the branch `main`.
**Kind**: global function
**Returns**: Promise.<HelixConfig> - the helix-config or {@code null} if optional and not found.
| Param | Type | Description |
| --- | --- | --- |
| ctx | AdminContext | the context |
| info | PathInfo | path info |
| optional | boolean | if {@code true} returns null if not found |
## handleResponse(log, response, key) ⇒ Promise.<MountConfig>
Checks if the response is valid and returns a IgnoreConfig.
**Kind**: global function
**Returns**: Promise.<MountConfig> - the IgnoreConfig
**Throws**:
- Error('Unable to fetch hlxignore')
| Param | Type | Description |
| --- | --- | --- |
| log | Logger | logger |
| response | Response | content response from the storage |
| key | string | storage key (logging information) |
## fetchIgnore(ctx, opts) ⇒ Promise.<IgnoreConfig>
Retrieves the hlxignore from github and stores it in the context as IgnoreConfig.
If 404 is encountered, returns an empty IgnoreConfig that considers nothing ignored.
**Kind**: global function
**Returns**: Promise.<IgnoreConfig> - the IgnoreConfig
| Param | Type | Description |
| --- | --- | --- |
| ctx | AdminContext | the context |
| opts | LookupOptions | lookup options |
## handleResponse(log, response, key, type) ⇒ Promise.<IndexConfig>
Checks if the response is valid and returns an index config.
**Kind**: global function
**Returns**: Promise.<IndexConfig> - the index config or null
| Param | Type | Description |
| --- | --- | --- |
| log | Logger | logger |
| response | Response | content response from the storage |
| key | string | storage key (logging information) |
| type | string | type of storage (logging information |
## fetchIndex(ctx, opts, optional) ⇒ Promise.<IndexConfig>
Retrieves the indexing configuration from the underlying storage and stores it in the context as
indexConfig.
**Kind**: global function
**Returns**: Promise.<IndexConfig> - the index config
| Param | Type | Description |
| --- | --- | --- |
| ctx | AdminContext | the context |
| opts | LookupOptions | lookup options |
| optional | boolean | if {@code true}, no error is thrown if the config can't be retrieved |
## fetchS3(bucketId, key, head) ⇒ Promise.<Response>
Fetches content from s3
**Kind**: global function
**Returns**: Promise.<Response> - fetch api response
**Oaram**: AdminContext context the admin context
| Param | Type | Description |
| --- | --- | --- |
| bucketId | string | bucket id |
| key | string | the resource key |
| head | boolean | flag indicating to create a head request |
## handleResponse(log, response, key, type) ⇒ Promise.<SitemapConfig>
Checks if the response is valid and returns a sitemap config.
**Kind**: global function
**Returns**: Promise.<SitemapConfig> - the sitemap config or null
| Param | Type | Description |
| --- | --- | --- |
| log | Logger | logger |
| response | Response | content response from the storage |
| key | string | storage key (logging information) |
| type | string | type of storage (logging information |
## fetchSitemap(ctx, opts, optional) ⇒ Promise.<SitemapConfig>
Retrieves the sitemap from the underlying storage and stores it in the context as sitemapConfig.
**Kind**: global function
**Returns**: Promise.<SitemapConfig> - the sitemap configuration
| Param | Type | Description |
| --- | --- | --- |
| ctx | AdminContext | the context |
| opts | LookupOptions | lookup options |
| optional | boolean | if {@code true}, no error is thrown if the config can't be retrieved |
## flatJson2object(rows, [keyName], [valueName])
Converts a config row-based name/value pair array with dotted key notation to an object.
example:
```
host: www.adobe.com
document.level: 42,
document.title: hello
document.body.status: 200
acl.allow: /foo
acl.allow: /bar
cnd.0.type: fastly
cnd.0.host: www.adobe.com
cnd.1.type: cloudflare
```
becomes:
```
{
host: 'www.adobe.com',
document: {
level: 42,
title: 'hello',
body: {
status: 200,
}
},
acl: {
allow: ['/foo', '/bar],
}
cnd: [
{ type: 'fastly', host: 'www.adobe.com' },
{ type: 'cloudflare' },
]
}
```
**Kind**: global function
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| rows | Array.<object> | | array of columns |
| [keyName] | string | "'key'" | name of the key column. |
| [valueName] | string | "'value'" | name of the value column. |
## error(message, status) ⇒ Response
Generates an error response
**Kind**: global function
**Returns**: Response - A response object.
| Param | Type | Description |
| --- | --- | --- |
| message | string | error message |
| status | number | error code. |
## BatchedQueueClientOpts
**Kind**: global typedef
**Properties**
| Name | Type | Default | Description |
| --- | --- | --- | --- |
| [log] | Console | Console | Console like logger |
| [maxSqsPollTime] | number | 20 | Time to poll for messages |
| inQueue | string | | Name of the receiving queue |
| outQueue | string | | Name of the output queue |
| s3ClientOpts | object | | S3 client options |
| sqsClientOpts | object | | SQS client options |
| headerKeys | Array.<string> | | Name of the properties that common to all message properties |
| swapBucket | string | | Name of the bucket used for swap space |
| swapPrefix | string | | Prefix for the swap objects |