Gets and caches a complete workspace with all locales, layers, and templates pre-loaded.

The workspaceCache method will be forced to clear the cached workspace and load the workspace again which may have changed. This is required for testing purposes. If templates should be loaded in order to extract roles it may be beneficial to use already cached templates.

The method will iterate over the workspace.locales to cache any templates defined in the locales object.

The method will iterate over each layer defined in every locale to cache any templates associated with the layer objects.

Finally each template defined in the workspace.templates will be cached.

The cached workspace requested from the workspaceCache() will be assigned to the workspace variable declared in the module scope.

The method checks whether the req.params.key matches a keyMethods property and returns the matching method.

The getNestedLocales is returned if the locales method is called with a locale property.

The locale will be requested from the getLocale module. An array of nested locales defined in the locales property of the locale is checked for user access.

Nested locales accessible to the user are returned. The key for a nested locale is an array left to right. For [UK,London] the London locale will be nested in the UK locale. The name for a nested locale will be concatenated like so UK/London.

The method requests a JSON layer from the getLayer module.

The layer is checked for user role access and will return an error if access is denied.

All role information is removed from the layer before being returned to the client.

The method requests a JSON locale from the getLocale module.

All locale layers are requested from the getLayer module with params.layers flag.

The locale.layers{} object is reduced to an array of layer keys without the params.layers flag.

The locales method returns an array of fully resolved locale objects from the workspace.

Each locale is retrieved via the getLocale method, which merges templates and applies proper role-based access control. Any locales that return errors (e.g., due to access restrictions) are filtered out of the response.

The nestedLocales method will be returned if a locale property is provided in the request params.

Processes the test configuration and returns formatted results.

Recursively removes all 'roles' objects from the provided object [locale, layer]. This function is designed to sanitize locale configuration objects before sending to the client, ensuring that role-based permissions data is not exposed.

The roles method returns an array of roles returned from the roles utility.

This method is only available to users with admin credentials.

The cacheTemplates method will called to read any template from it's src and cache the template. This is required to extract any roles from the workspace which may be defined in a template only.

The workspace.roles{} object will be returned with the detail=true url parameter.

A hierarchical tree structure can be requested with the tree=true url parameter.

Iterates through all nested object properties. Test properties found in the test.properties Set. Removes template keys from test.unused_templates Set. Add template keys to test.used_templates Array.

The workspace/test method which is only available to user with admin credentials requests all locales in workspace.

The cached workspace will be flushed for the test method.

Requesting all locales should add any additional templates to the workspace.

The test method will iterate over all workspace.templates and get from the getTemplate method to check whether any errors are logged on a template in regards to its src parameter.

A flat array of template.err will be returned from the workspace/test method.

Tests all locales in the workspace for errors and analyzes template usage.