@dwp/govuk-casa 8.2.3 → 8.2.4

package/dist/lib/configuration-ingestor.js

@@ -10,9 +10,11 @@ const Plan_js_1 = __importDefault(require("./Plan.js"));
 const logger_js_1 = __importDefault(require("./logger.js"));
 const utils_js_1 = require("./utils.js");
 /**
+ * @access private
  * @typedef {import('../casa').ConfigurationOptions} ConfigurationOptions
  */
 /**
+ * @access private
  * @typedef {import('../casa').HelmetConfigurator} HelmetConfigurator
  */
 const log = (0, logger_js_1.default)('lib:configuration-ingestor');
@@ -20,6 +22,7 @@ const echo = (a) => (a);
 /**
  * Validates and sanitises i18n obejct.
  *
+ * @access private
  * @param {object} i18n Object to validate.
  * @param {Function} cb Callback function that receives the validated value.
  * @throws {TypeError} For invalid object.
@@ -35,6 +38,7 @@ exports.validateI18nObject = validateI18nObject;
 /**
  * Validates and sanitises i18n directory.
  *
+ * @access private
  * @param {Array} dirs Array of directories.
  * @throws {SyntaxError} For invalid directories.
  * @throws {TypeError} For invalid type.
@@ -55,6 +59,7 @@ exports.validateI18nDirs = validateI18nDirs;
 /**
  * Validates and sanitises i18n locales.
  *
+ * @access private
  * @param {Array} locales Array of locales.
  * @throws {SyntaxError} For invalid locales.
  * @throws {TypeError} For invalid type.
@@ -75,6 +80,7 @@ exports.validateI18nLocales = validateI18nLocales;
 /**
  * Validates and sanitises mount url.
  *
+ * @access private
  * @param {string} mountUrl Prefix for all URLs in the browser address bar
  * @throws {SyntaxError} For invalid URL.
  * @returns {string|undefined} Sanitised URL.
@@ -92,6 +98,7 @@ exports.validateMountUrl = validateMountUrl;
 /**
  * Validates and sanitises sessions object.
  *
+ * @access private
  * @param {object} session Object to validate.
  * @param {Function} cb Callback function that receives the validated value.
  * @throws {TypeError} For invalid object.
@@ -110,6 +117,7 @@ exports.validateSessionObject = validateSessionObject;
 /**
  * Validates and sanitises view directory.
  *
+ * @access private
  * @param {Array} dirs Array of directories.
  * @throws {SyntaxError} For invalid directories.
  * @throws {TypeError} For invalid type.
@@ -130,6 +138,7 @@ exports.validateViews = validateViews;
 /**
  * Validates and sanitises sessions secret.
  *
+ * @access private
  * @param {string} secret Session secret.
  * @throws {ReferenceError} For missing value type.
  * @throws {TypeError} For invalid value.
@@ -148,6 +157,7 @@ exports.validateSessionSecret = validateSessionSecret;
 /**
  * Validates and sanitises sessions ttl.
  *
+ * @access private
  * @param {number} ttl Session ttl (seconds).
  * @throws {ReferenceError} For missing value type.
  * @throws {TypeError} For invalid value.
@@ -163,6 +173,7 @@ exports.validateSessionTtl = validateSessionTtl;
 /**
  * Validates and sanitises sessions name.
  *
+ * @access private
  * @param {string} [name=casa-session] Session name.
  * @throws {ReferenceError} For missing value type.
  * @throws {TypeError} For invalid value.
@@ -178,6 +189,7 @@ exports.validateSessionName = validateSessionName;
 /**
  * Validates and sanitises sessions secure flag.
  *
+ * @access private
  * @param {boolean} [secure=false] Session secure flag.
  * @throws {ReferenceError} For missing value type.
  * @throws {TypeError} For invalid value.
@@ -193,6 +205,7 @@ exports.validateSessionSecure = validateSessionSecure;
 /**
  * Validates and sanitises sessions store.
  *
+ * @access private
  * @param {Function} store Session store.
  * @returns {Function} Store.
  */
@@ -207,6 +220,7 @@ exports.validateSessionStore = validateSessionStore;
 /**
  * Validates and sanitises sessions cookie url path.
  *
+ * @access private
  * @param {string} cookiePath Session cookie url path.
  * @param {string} defaultPath Default path if none specified.
  * @returns {string} Cookie path.
@@ -226,6 +240,7 @@ exports.validateSessionCookiePath = validateSessionCookiePath;
  * Lax
  * None
  *
+ * @access private
  * @param {any} cookieSameSite Session cookie "sameSite" flag
  * @param {any} defaultFlag Default path if none specified
  * @returns {boolean} cookie path
@@ -356,6 +371,7 @@ exports.validateEvents = validateEvents;
 /**
  * Validates helmet configuration function.
  *
+ * @access private
  * @param {HelmetConfigurator} helmetConfigurator Configuration function
  * @returns {HelmetConfigurator} Validated configuration function
  * @throws {TypeError} when passed a non-function
@@ -370,6 +386,7 @@ exports.validateHelmetConfigurator = validateHelmetConfigurator;
 /**
  * Ingest, validate, sanitise and manipulate configuration parameters.
  *
+ * @access private
  * @param {ConfigurationOptions} config Config to ingest.
  * @throws {Error|SyntaxError|TypeError} For invalid config values.
  * @returns {object} Immutable config object.

package/dist/lib/configure.d.ts

@@ -1,15 +1,19 @@
 /**
+ * @access private
  * @typedef {import('../casa').ConfigurationOptions} ConfigurationOptions
  */
 /**
+ * @access private
  * @typedef {import('../casa').ConfigurationOptions} ConfigureResult
  */
 /**
+ * @access private
  * @typedef {import('../casa').Mounter} Mounter
  */
 /**
  * Configure some middleware for use in creating a new CASA app.
  *
+ * @memberof module:@dwp/govuk-casa
  * @param {ConfigurationOptions} config Configuration options
  * @returns {ConfigureResult} Result
  */

package/dist/lib/configure.js

@@ -25,17 +25,21 @@ const data_js_1 = __importDefault(require("../middleware/data.js"));
 const body_parser_js_1 = __importDefault(require("../middleware/body-parser.js"));
 const csrf_js_1 = __importDefault(require("../middleware/csrf.js"));
 /**
+ * @access private
  * @typedef {import('../casa').ConfigurationOptions} ConfigurationOptions
  */
 /**
+ * @access private
  * @typedef {import('../casa').ConfigurationOptions} ConfigureResult
  */
 /**
+ * @access private
  * @typedef {import('../casa').Mounter} Mounter
  */
 /**
  * Configure some middleware for use in creating a new CASA app.
  *
+ * @memberof module:@dwp/govuk-casa
  * @param {ConfigurationOptions} config Configuration options
  * @returns {ConfigureResult} Result
  */
@@ -150,7 +154,16 @@ function configure(config = {}) {
                 res.redirect(302, `${reqPath}${reqParams}`);
             });
         }
-        // Service static assets from the `app` rather than the `router`. The router
+        // Capture the mount path of this CASA app, before any parameterised path
+        // segments exert influence over `req.baseUrl` in the `router` further below.
+        // This can later be used by middleware that wants to use the
+        // "unparameterised" version of the request's `baseUrl`, such as the static
+        // router's middleware.
+        app.use((req, res, next) => {
+            req.unparameterisedBaseUrl = req.baseUrl;
+            next();
+        });
+        // Serve static assets from the `app` rather than the `router`. The router
         // may contain paramaterised path segments which would mean serving static
         // assets over a dynamic URL each time, thus causing lots of cache misses on
         // the browser.

package/dist/lib/end-session.d.ts

@@ -6,8 +6,9 @@
  * Note: this will not remove the session from server-side storage, which will
  * instead be left up to the storage mechanism to clean up.
  *
- * @param {object} req HTTP request
+ * @memberof module:@dwp/govuk-casa
+ * @param {import('express').Request} req HTTP request
  * @param {Function} next Chain
  * @returns {void}
  */
-export default function endSession(req: object, next: Function): void;
+export default function endSession(req: import('express').Request, next: Function): void;

package/dist/lib/end-session.js

@@ -13,7 +13,8 @@ const log = (0, logger_js_1.default)('lib:end-session');
  * Note: this will not remove the session from server-side storage, which will
  * instead be left up to the storage mechanism to clean up.
  *
- * @param {object} req HTTP request
+ * @memberof module:@dwp/govuk-casa
+ * @param {import('express').Request} req HTTP request
  * @param {Function} next Chain
  * @returns {void}
  */

package/dist/lib/field.d.ts

@@ -1,16 +1,56 @@
-export default function field(...args: any[]): PageField;
+/**
+ * Factory for creating PageField instances.
+ *
+ * @memberof module:@dwp/govuk-casa
+ * @param {string} name Field name
+ * @param {object} opts Options
+ * @param {boolean} [opts.optional=false] Whether this field is optional
+ * @param {boolean} [opts.persist=true] Whether this field will persist in `req.body`
+ * @returns {PageField} A PageField
+ */
+export default function field(name: string, opts: {
+    optional?: boolean | undefined;
+    persist?: boolean | undefined;
+}): PageField;
+/**
+ * This class is not exposed via the public API. Instances should instead be
+ * instantiated through the `field()` factory function.
+ *
+ * @class
+ */
 export class PageField {
-    constructor(name: any, { optional, persist }?: any);
     /**
-     * For complex fields, we need may need to drill into an object to extract the
+     * Create a field.
+     *
+     * @param {string} name Field name
+     * @param {object} opts Options
+     * @param {boolean} [opts.optional=false] Whether this field is optional
+     * @param {boolean} [opts.persist=true] Whether this field will persist in `req.body`
+     */
+    constructor(name: string, { optional, persist }?: {
+        optional?: boolean | undefined;
+        persist?: boolean | undefined;
+    });
+    /**
+     * Extract this field's value from the given object.
+     *
+     * For complex fields, we may need to drill into an object to extract the
      * value.
      *
      * @param {object} obj Object from which to extract the value
      * @returns {any} Value extracted from object
-     * @throws {Error} When run on a complex field
+     * @throws {Error} When run on a complex field (not yet supported)
      */
     getValue(obj?: object): any;
-    putValue(obj?: any, value?: undefined): PageField;
+    /**
+     * Store this field's value in the given object, using its name as the key.
+     *
+     * @param {object} obj Object from which to extract the value
+     * @param {any} value Value to be stored
+     * @returns {any} Value extracted from object
+     * @throws {Error} When run on a complex field (not yet supported)
+     */
+    putValue(obj?: object, value?: any): any;
     get name(): string;
     get meta(): object;
     /**
@@ -18,60 +58,82 @@ export class PageField {
      * Some validators will include a `sanitise()` method which will be run at the
      * same time as other "processors".
      *
-     * @param {ValidateFunction[]} items Validation functions
-     * @returns {PageField | ValidateFunction[]} Chain or return all validators
+     * @param {Validator[]} items Validation functions
+     * @returns {PageField | Validator[]} Chain or return all validators
      */
-    validators(items?: ValidateFunction[]): PageField | ValidateFunction[];
+    validators(items?: Validator[]): PageField | Validator[];
     /**
      * Add/get value pre-processors
      * This is most often used to sanitise values to a particular data type.
      *
-     * @param {ProcessorFunction[]} items Processor functions
-     * @returns {PageField | ProcessorFunction[]} Chain or return all processors
+     * @param {FieldProcessorFunction[]} items Processor functions
+     * @returns {PageField | FieldProcessorFunction[]} Chain or return all processors
      */
-    processors(items?: ProcessorFunction[]): PageField | ProcessorFunction[];
+    processors(items?: FieldProcessorFunction[]): PageField | FieldProcessorFunction[];
     /**
      * Add/get conditions
      * All conditions must be met in order for this field to be considered
      * "actionable".
      *
-     * @param {ConditionFunction[]} items Condition functions
-     * @returns {PageField | ConditionFunction[]} Chain or return all conditions
+     * @param {ValidatorConditionFunction[]} items Condition functions
+     * @returns {PageField | ValidatorConditionFunction[]} Chain or return all conditions
      */
-    conditions(items?: ConditionFunction[]): PageField | ConditionFunction[];
+    conditions(items?: ValidatorConditionFunction[]): PageField | ValidatorConditionFunction[];
     /**
      * Run all validators and return array of errors, if applicable.
      *
      * @param {any} value Value to validate
-     * @param {ValidateContext} context Contextual information
+     * @param {ValidateContext} context Contextual validation information
      * @returns {ValidationError[]} Errors, or an empty array if all valid
      */
-    runValidators(value: any, context?: any): ValidationError[];
+    runValidators(value: any, context?: ValidateContext): ValidationError[];
+    /**
+     * Apply all the processors to the given value.
+     *
+     * @param {any} value Value to process
+     * @returns {any} Processed value
+     */
     applyProcessors(value: any): any;
     /**
-     * Apply all conditions to get the resulting boolean
+     * All conditions must return true to be considered a successful test.
      *
-     * @param {object} params Parameters
-     * @param {string} params.fieldValue Field value
-     * @param {string} params.waypoint Waypoint
-     * @param {object} params.journeyContext JourneyContext
+     * @param {ValidateContext} context Contextual validation information
      * @returns {boolean} True if all conditions pass
      */
-    testConditions({ fieldValue, waypoint, journeyContext }: {
-        fieldValue: string;
-        waypoint: string;
-        journeyContext: object;
-    }): boolean;
-    validator(validator: any): any[] | PageField;
-    processor(processor: any): PageField | ProcessorFunction[];
-    condition(condition: any): PageField | ConditionFunction[];
-    if(...args: any[]): PageField | ConditionFunction[];
+    testConditions({ fieldValue, waypoint, journeyContext }: ValidateContext): boolean;
+    /**
+     * Add a single validator.
+     *
+     * @param {Validator} validator Validation function
+     * @returns {PageField} Chain
+     */
+    validator(validator: Validator): PageField;
+    /**
+     * Add a single pre-processors
+     *
+     * @param {FieldProcessorFunction} processor Processor function
+     * @returns {PageField} Chain
+     */
+    processor(processor: FieldProcessorFunction): PageField;
+    /**
+     * Add a single condition.
+     *
+     * @param {ValidatorConditionFunction} condition Condition function
+     * @returns {PageField} Chain
+     */
+    condition(condition: ValidatorConditionFunction): PageField;
+    /**
+     * Alias for `conditions()`.
+     *
+     * @param {...ValidatorConditionFunction} args Condition functions
+     * @returns {PageField} Chain
+     */
+    if(...args: ValidatorConditionFunction[]): PageField;
     #private;
 }
 export type JourneyContext = import('./index').JourneyContext;
-export type Validator = import('./index').Validator;
-export type ValidateFunction = import('./index').ValidateFunction;
-export type ValidateContext = import('./index').ValidateContext;
+export type Validator = import('../casa').Validator;
+export type ValidateContext = import('../casa').ValidateContext;
+export type ValidatorConditionFunction = import('../casa').ValidatorConditionFunction;
+export type FieldProcessorFunction = import('../casa').FieldProcessorFunction;
 export type ValidationError = import('./index').ValidationError;
-export type ProcessorFunction = (value: any) => any;
-export type ConditionFunction = (context: Object, fieldName: string, fieldValue: any, waypoint: string, waypointId: string, journeyContext: JourneyContext) => boolean;

package/dist/lib/field.js

@@ -20,57 +20,63 @@ const lodash_1 = __importDefault(require("lodash"));
 const utils_js_1 = require("./utils.js");
 const { isFunction } = lodash_1.default;
 /**
+ * @access private
  * @typedef {import('./index').JourneyContext} JourneyContext
  */
 /**
- * @typedef {import('./index').Validator} Validator
+ * @access private
+ * @typedef {import('../casa').Validator} Validator
  */
 /**
- * @typedef {import('./index').ValidateFunction} ValidateFunction
+ * @access private
+ * @typedef {import('../casa').ValidateContext} ValidateContext
  */
 /**
- * @typedef {import('./index').ValidateContext} ValidateContext
+ * @access private
+ * @typedef {import('../casa').ValidatorConditionFunction} ValidatorConditionFunction
  */
 /**
- * @typedef {import('./index').ValidationError} ValidationError
- */
-/**
- * @callback ProcessorFunction
- * @param {any} value Value to be processed
- * @returns {any}
+ * @access private
+ * @typedef {import('../casa').FieldProcessorFunction} FieldProcessorFunction
  */
 /**
- * @callback ConditionFunction
- * @param {Object} context Value to be processed
- * @param {string} context.fieldName Field name
- * @param {any} context.fieldValue Field value
- * @param {string} context.waypoint Waypoint
- * @param {string} context.waypointId [DEPRECATED] Waypoint (for backwards compatibility with v7)
- * @param {JourneyContext} journeyContext Journey Context
- * @returns {boolean} True if the validators should be run
+ * @access private
+ * @typedef {import('./index').ValidationError} ValidationError
  */
 // Quick check to see if the field name corresponds to a non-primitive complex
 // type. For example, `my_field[nested]`.
 const reComplexType = /\[/;
 const reInvalidName = /[^a-z0-9_.\-[\]]/i;
-// This is never exposed via a public API, and instead users are encouraged to
-// use the `field()` factory instead
+/**
+ * This class is not exposed via the public API. Instances should instead be
+ * instantiated through the `field()` factory function.
+ *
+ * @class
+ */
 class PageField {
+    /**
+     * Create a field.
+     *
+     * @param {string} name Field name
+     * @param {object} opts Options
+     * @param {boolean} [opts.optional=false] Whether this field is optional
+     * @param {boolean} [opts.persist=true] Whether this field will persist in `req.body`
+     */
     constructor(name, { optional = false, persist = true } = Object.create(null)) {
-        /*
+        /**
          * @type {string}
          */
         _PageField_name.set(this, void 0);
         /**
-         * @type {ProcessorFunction[]}
+         * @type {FieldProcessorFunction[]}
          */
         _PageField_processors.set(this, void 0);
         /**
-         * @type {ValidateFunction[]}
+         * @type {Validator[]}
          */
         _PageField_validators.set(this, void 0);
         /**
-         * @type {ConditionFunction[]}
+         * @type {ValidatorConditionFunction[]}
          */
         _PageField_conditions.set(this, void 0);
         /**
@@ -94,12 +100,14 @@ class PageField {
         }, "f");
     }
     /**
-     * For complex fields, we need may need to drill into an object to extract the
+     * Extract this field's value from the given object.
+     *
+     * For complex fields, we may need to drill into an object to extract the
      * value.
      *
      * @param {object} obj Object from which to extract the value
      * @returns {any} Value extracted from object
-     * @throws {Error} When run on a complex field
+     * @throws {Error} When run on a complex field (not yet supported)
      */
     getValue(obj = Object.create(null)) {
         if (!__classPrivateFieldGet(this, _PageField_meta, "f").complex) {
@@ -107,6 +115,14 @@ class PageField {
         }
         throw new Error('Not yet supporting complex field types');
     }
+    /**
+     * Store this field's value in the given object, using its name as the key.
+     *
+     * @param {object} obj Object from which to extract the value
+     * @param {any} value Value to be stored
+     * @returns {any} Value extracted from object
+     * @throws {Error} When run on a complex field (not yet supported)
+     */
     putValue(obj = Object.create(null), value = undefined) {
         if (!__classPrivateFieldGet(this, _PageField_meta, "f").complex) {
             /* eslint-disable-next-line no-param-reassign */
@@ -127,8 +143,8 @@ class PageField {
      * Some validators will include a `sanitise()` method which will be run at the
      * same time as other "processors".
      *
-     * @param {ValidateFunction[]} items Validation functions
-     * @returns {PageField | ValidateFunction[]} Chain or return all validators
+     * @param {Validator[]} items Validation functions
+     * @returns {PageField | Validator[]} Chain or return all validators
      */
     validators(items = []) {
         if (!items.length) {
@@ -141,8 +157,8 @@ class PageField {
      * Add/get value pre-processors
      * This is most often used to sanitise values to a particular data type.
      *
-     * @param {ProcessorFunction[]} items Processor functions
-     * @returns {PageField | ProcessorFunction[]} Chain or return all processors
+     * @param {FieldProcessorFunction[]} items Processor functions
+     * @returns {PageField | FieldProcessorFunction[]} Chain or return all processors
      */
     processors(items = []) {
         if (!items.length) {
@@ -156,8 +172,8 @@ class PageField {
      * All conditions must be met in order for this field to be considered
      * "actionable".
      *
-     * @param {ConditionFunction[]} items Condition functions
-     * @returns {PageField | ConditionFunction[]} Chain or return all conditions
+     * @param {ValidatorConditionFunction[]} items Condition functions
+     * @returns {PageField | ValidatorConditionFunction[]} Chain or return all conditions
      */
     conditions(items = []) {
         if (!items.length) {
@@ -171,7 +187,7 @@ class PageField {
      * Run all validators and return array of errors, if applicable.
      *
      * @param {any} value Value to validate
-     * @param {ValidateContext} context Contextual information
+     * @param {ValidateContext} context Contextual validation information
      * @returns {ValidationError[]} Errors, or an empty array if all valid
      */
     runValidators(value, context = Object.create(null)) {
@@ -182,6 +198,8 @@ class PageField {
         }
         // Skip validation if conditions are not met
         // We duplicate value in context.fieldValue for historical reasons
+        // @todo explain these historical reasons! And deprecate the need for
+        // `value` altogether
         context.fieldValue = (_a = context.fieldValue) !== null && _a !== void 0 ? _a : value;
         if (!this.testConditions(context)) {
             return [];
@@ -190,6 +208,7 @@ class PageField {
         for (let i = 0, l = __classPrivateFieldGet(this, _PageField_validators, "f").length; i < l; i++) {
             // ESLint disabled as `i` is an integer
             /* eslint-disable security/detect-object-injection */
+            // TODO: Replace `value` with `context.fieldValue` here
             const fieldErrors = __classPrivateFieldGet(this, _PageField_validators, "f")[i].validate(value, context).map((e) => e.withContext(Object.assign(Object.assign({}, context), { validator: __classPrivateFieldGet(this, _PageField_validators, "f")[i].name })));
             /* eslint-enable security/detect-object-injection */
             errors = [
@@ -199,7 +218,7 @@ class PageField {
         }
         return errors;
     }
-    /*
+    /**
      * Apply all the processors to the given value.
      *
      * @param {any} value Value to process
@@ -225,12 +244,9 @@ class PageField {
         return processedValue;
     }
     /**
-     * Apply all conditions to get the resulting boolean
+     * All conditions must return true to be considered a successful test.
      *
-     * @param {object} params Parameters
-     * @param {string} params.fieldValue Field value
-     * @param {string} params.waypoint Waypoint
-     * @param {object} params.journeyContext JourneyContext
+     * @param {ValidateContext} context Contextual validation information
      * @returns {boolean} True if all conditions pass
      */
     testConditions({ fieldValue, waypoint, journeyContext }) {
@@ -250,23 +266,56 @@ class PageField {
         return result;
     }
     /* ---------------------------------------------------------------- aliases */
+    /**
+     * Add a single validator.
+     *
+     * @param {Validator} validator Validation function
+     * @returns {PageField} Chain
+     */
     validator(validator) {
         return this.validators([validator]);
     }
+    /**
+     * Add a single pre-processors
+     *
+     * @param {FieldProcessorFunction} processor Processor function
+     * @returns {PageField} Chain
+     */
     processor(processor) {
         return this.processors([processor]);
     }
+    /**
+     * Add a single condition.
+     *
+     * @param {ValidatorConditionFunction} condition Condition function
+     * @returns {PageField} Chain
+     */
     condition(condition) {
         return this.conditions([condition]);
     }
+    /**
+     * Alias for `conditions()`.
+     *
+     * @param {...ValidatorConditionFunction} args Condition functions
+     * @returns {PageField} Chain
+     */
     if(...args) {
         return this.conditions(...args);
     }
 }
 exports.PageField = PageField;
 _PageField_name = new WeakMap(), _PageField_processors = new WeakMap(), _PageField_validators = new WeakMap(), _PageField_conditions = new WeakMap(), _PageField_meta = new WeakMap();
-// Factory for convenience
-function field(...args) {
-    return new PageField(...args);
+/**
+ * Factory for creating PageField instances.
+ *
+ * @memberof module:@dwp/govuk-casa
+ * @param {string} name Field name
+ * @param {object} opts Options
+ * @param {boolean} [opts.optional=false] Whether this field is optional
+ * @param {boolean} [opts.persist=true] Whether this field will persist in `req.body`
+ * @returns {PageField} A PageField
+ */
+function field(name, opts) {
+    return new PageField(name, opts);
 }
 exports.default = field;

package/dist/lib/nunjucks-filters.d.ts

@@ -1,5 +1,13 @@
 export function mergeObjects(...objects: any[]): object;
-export function includes(source?: any[], search?: string): boolean;
+/**
+ * Determine whether a value exists in a list.
+ *
+ * @memberof NunjucksFilters
+ * @param {any[]} source List of items to search
+ * @param {any} search Item to search within the `source`
+ * @returns {boolean} True if the search item was found
+ */
+export function includes(source?: any[], search?: any): boolean;
 /**
  * Format a given date.
  *
@@ -8,6 +16,7 @@ export function includes(source?: any[], search?: string): boolean;
  * `date` may be any of the following types:
  *   object - {dd:'', mm:'', yyyy:''}
  *
+ * @memberof NunjucksFilters
  * @param  {object} date Date (see supported formats above)
  * @param  {object} config Holds locale
  * @returns {string} Formatted date
@@ -20,7 +29,8 @@ export function formatDateObject(date: object, config?: object): string;
  *   Given: {class: 'basic', 'data-ga': 3}
  *   Output: class="basic" data-ga="3"
  *
- * @param  {object} attrsObject Attributes object (in name:value pairs)
+ * @memberof NunjucksFilters
+ * @param {object} attrsObject Attributes object (in name:value pairs)
  * @returns {string} Formatted
  */
 export function renderAsAttributes(attrsObject: object): string;