README
Uttori View Model Enrichment - Recent Documents
A plugin to expose and add recently edited documents to a view-model or other object.
Install
npm install --save uttori-plugin-vm-recent-documents
Config
{
// Registration Events
events: {
callback: ['view-model-home'],
},
// Key to use in the view model
key: 'recentDocuments',
// Number of documents to return.
limit: 10,
// A list of slugs to ignore
ignore_slugs: [],
}
API Reference
ViewModelRecentDocuments
Uttori View Model Enrichment - Recent Documents
Kind: global class
- ViewModelRecentDocuments
- .configKey ⇒
String
- .defaultConfig() ⇒
Object
- .validateConfig(config, _context)
- .register(context)
- .callback(viewModel, context) ⇒
Object
- .configKey ⇒
String
ViewModelRecentDocuments.configKey ⇒ The configuration key for plugin to look for in the provided configuration.
Kind: static property of ViewModelRecentDocuments
Returns: String
- The configuration key.
Example (ViewModelRecentDocuments.configKey)
const config = { ...ViewModelRecentDocuments.defaultConfig(), ...context.config[ViewModelRecentDocuments.configKey] };
Object
ViewModelRecentDocuments.defaultConfig() ⇒ The default configuration.
Kind: static method of ViewModelRecentDocuments
Returns: Object
- The configuration.
Example (ViewModelRecentDocuments.defaultConfig())
const config = { ...ViewModelRecentDocuments.defaultConfig(), ...context.config[ViewModelRecentDocuments.configKey] };
ViewModelRecentDocuments.validateConfig(config, _context)
Validates the provided configuration for required entries.
Kind: static method of ViewModelRecentDocuments
Param | Type | Description |
---|---|---|
config | Object |
A configuration object. |
config[ViewModelRecentDocuments.configKey | Object |
A configuration object specifically for this plugin. |
config[ViewModelRecentDocuments.configKey].key | String |
The that will be added to the passed in object and returned with the recent documents. |
config[ViewModelRecentDocuments.configKey].limit | String |
The maximum number of documents to be returned. |
_context | Object |
A Uttori-like context (unused). |
Example (ViewModelRecentDocuments.validateConfig(config, _context))
ViewModelRecentDocuments.validateConfig({ ... });
ViewModelRecentDocuments.register(context)
Register the plugin with a provided set of events on a provided Hook system.
Kind: static method of ViewModelRecentDocuments
Param | Type | Description |
---|---|---|
context | Object |
A Uttori-like context. |
context.hooks | Object |
An event system / hook system to use. |
context.hooks.on | function |
An event registration function. |
context.config | Object |
A provided configuration to use. |
context.config.events | Object |
An object whose keys correspong to methods, and contents are events to listen for. |
Example (ViewModelRecentDocuments.register(context))
const context = {
hooks: {
on: (event, callback) => { ... },
},
config: {
[ViewModelRecentDocuments.configKey]: {
...,
events: {
callback: ['document-save', 'document-delete'],
validateConfig: ['validate-config'],
},
},
},
};
ViewModelRecentDocuments.register(context);
Object
ViewModelRecentDocuments.callback(viewModel, context) ⇒ Queries for recent documents and searches the storage provider.
Kind: static method of ViewModelRecentDocuments
Returns: Object
- The provided view-model document.
Param | Type | Description |
---|---|---|
viewModel | Object |
A Uttori view-model object. |
context | Object |
A Uttori-like context. |
context.config | Object |
A provided configuration to use. |
context.config.key | String |
The key to add the array of documents to on the view-model. |
context.config.limit | Number |
The maximum number of documents to return. |
context.config.ignore_slugs | Array.<String> |
A list of slugs to not consider when fetching recent documents. |
context.storageProvider | Object |
A provided Uttori StorageProvider instance. |
context.storageProvider.getQuery | function |
Access method for getting documents. |
Example (ViewModelRecentDocuments.callback(viewModel, context))
const context = {
config: {
[ViewModelRecentDocuments.configKey]: {
...,
},
},
storageProvider: {
getQuery: (query) => { ... }
},
};
ViewModelRecentDocuments.callback(viewModel, context);
Tests
To run the test suite, first install the dependencies, then run npm test
:
npm install
npm test
DEBUG=Uttori* npm test