@uttori/plugin-vm-popular-documents v3.1.0

Uttori View Model Enrichment Plugin - Popular Documents

A plugin to expose and add popular documents to a view-model or other object.

Install

npm install --save @uttori/plugin-vm-popular-documents

Dependencies

There must be a plugin registered with the hooks to listen for a popular-documents event and respond with an array containing the slugs of the popular documents.

Config

{
  // Registration Events
  events: {
    callback: ['view-model-home'],
  },

  // Key to use in the view model
  key: 'popularDocuments',

  // Number of documents to return.
  limit: 10,

  // A list of slugs to ignore when considering popularity.
  ignore_slugs: [],
}

API Reference

ViewModelPopularDocuments

Uttori View Model Enrichment - Popular Documents

Kind: global class

• ViewModelPopularDocuments
  • .configKey ⇒ string
  • .defaultConfig() ⇒ object
  • .validateConfig(config, _context)
  • .register(context)
  • .callback(viewModel, context) ⇒ Promise.<object>

ViewModelPopularDocuments.configKey ⇒ string

The configuration key for plugin to look for in the provided configuration.

Kind: static property of ViewModelPopularDocuments
Returns: string - The configuration key.
Example (ViewModelPopularDocuments.configKey)

const config = { ...ViewModelPopularDocuments.defaultConfig(), ...context.config[ViewModelPopularDocuments.configKey] };

ViewModelPopularDocuments.defaultConfig() ⇒ object

The default configuration.

Kind: static method of ViewModelPopularDocuments
Returns: object - The configuration.
Example (ViewModelPopularDocuments.defaultConfig())

const config = { ...ViewModelPopularDocuments.defaultConfig(), ...context.config[ViewModelPopularDocuments.configKey] };

ViewModelPopularDocuments.validateConfig(config, _context)

Validates the provided configuration for required entries.

Kind: static method of ViewModelPopularDocuments

Example (ViewModelPopularDocuments.validateConfig(config, _context))

ViewModelPopularDocuments.validateConfig({ ... });

ViewModelPopularDocuments.register(context)

Register the plugin with a provided set of events on a provided Hook system.

Kind: static method of ViewModelPopularDocuments

Example (ViewModelPopularDocuments.register(context))

const context = {
  config: {
    [ViewModelPopularDocuments.configKey]: {
      ...,
      events: {
        callback: ['document-save', 'document-delete'],
        validateConfig: ['validate-config'],
      },
    },
  },
  hooks: {
    on: (event, callback) => { ... },
  },
};
ViewModelPopularDocuments.register(context);

ViewModelPopularDocuments.callback(viewModel, context) ⇒ Promise.<object>

Queries the hooks for popular documents and searches the storage provider.

Kind: static method of ViewModelPopularDocuments
Returns: Promise.<object> - The provided view-model document.

Example (ViewModelPopularDocuments.callback(viewModel, context))

const context = {
  config: {
    [ViewModelPopularDocuments.configKey]: {
      ...,
    },
  },
  hooks: {
    on: (event) => { ... },
    fetch: (event, query) => { ... },
  },
};
ViewModelPopularDocuments.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

Contributors

• Matthew Callis

License

• MIT