@dwp/govuk-casa 8.0.0-alpha2 → 8.0.0-beta1

package/dist/lib/configuration-ingestor.d.ts

@@ -0,0 +1,262 @@
+/**
+ * Validates and sanitises i18n obejct.
+ *
+ * @param {object} i18n Object to validate.
+ * @param {Function} cb Callback function that receives the validated value.
+ * @throws {TypeError} For invalid object.
+ * @returns {object} Sanitised i18n object.
+ */
+export function validateI18nObject(i18n: object, cb?: Function): object;
+/**
+ * Validates and sanitises i18n directory.
+ *
+ * @param {Array} dirs Array of directories.
+ * @throws {SyntaxError} For invalid directories.
+ * @throws {TypeError} For invalid type.
+ * @returns {Array} Array of directories.
+ */
+export function validateI18nDirs(dirs: any[]): any[];
+/**
+ * Validates and sanitises i18n locales.
+ *
+ * @param {Array} locales Array of locales.
+ * @throws {SyntaxError} For invalid locales.
+ * @throws {TypeError} For invalid type.
+ * @returns {Array} Array of locales.
+ */
+export function validateI18nLocales(locales: any[]): any[];
+/**
+ * Validates and sanitises mount url.
+ *
+ * @param {string} mountUrl URL from which Express app will be served.
+ * @param {string} name Name of the URL type (Mount URL, or Proxy Mount URL).
+ * @throws {SyntaxError} For invalid URL.
+ * @returns {string} Sanitised URL.
+ */
+export function validateMountUrl(mountUrl: string, name?: string): string;
+/**
+ * Validates and sanitises sessions object.
+ *
+ * @param {object} session Object to validate.
+ * @param {Function} cb Callback function that receives the validated value.
+ * @throws {TypeError} For invalid object.
+ * @returns {object} Sanitised sessions object.
+ */
+export function validateSessionObject(session: object, cb?: Function): object;
+/**
+ * Validates and sanitises view directory.
+ *
+ * @param {Array} dirs Array of directories.
+ * @throws {SyntaxError} For invalid directories.
+ * @throws {TypeError} For invalid type.
+ * @returns {Array} Array of directories.
+ */
+export function validateViews(dirs: any[]): any[];
+/**
+ * Validates and sanitises sessions secret.
+ *
+ * @param {string} secret Session secret.
+ * @throws {ReferenceError} For missing value type.
+ * @throws {TypeError} For invalid value.
+ * @returns {string} Secret.
+ */
+export function validateSessionSecret(secret: string): string;
+/**
+ * Validates and sanitises sessions ttl.
+ *
+ * @param {number} ttl Session ttl (seconds).
+ * @throws {ReferenceError} For missing value type.
+ * @throws {TypeError} For invalid value.
+ * @returns {number} Ttl.
+ */
+export function validateSessionTtl(ttl: number): number;
+/**
+ * Validates and sanitises sessions name.
+ *
+ * @param {string} name Session name.
+ * @throws {ReferenceError} For missing value type.
+ * @throws {TypeError} For invalid value.
+ * @returns {string} Name.
+ */
+export function validateSessionName(name: string): string;
+/**
+ * Validates and sanitises sessions secure flag.
+ *
+ * @param {boolean} secure Session secure flag.
+ * @throws {ReferenceError} For missing value type.
+ * @throws {TypeError} For invalid value.
+ * @returns {string} Name.
+ */
+export function validateSessionSecure(secure: boolean): string;
+/**
+ * Validates and sanitises sessions store.
+ *
+ * @param {Function} store Session store.
+ * @returns {Function} Store.
+ */
+export function validateSessionStore(store: Function): Function;
+/**
+ * Validates and sanitises sessions cookie url path.
+ *
+ * @param {string} cookiePath Session cookie url path.
+ * @param {string} defaultPath Default path if none specified.
+ * @returns {string} Cookie path.
+ */
+export function validateSessionCookiePath(cookiePath: string, defaultPath?: string): string;
+/**
+ * Validates and sanitises sessions cookie "sameSite" flag. One of:
+ * true (Strict)
+ * false (will not set the flag at all)
+ * Strict
+ * Lax
+ * None
+ *
+ * @param {any} cookieSameSite Session cookie "sameSite" flag
+ * @param {any} defaultFlag Default path if none specified
+ * @returns {boolean} cookie path
+ * @throws {TypeError} When invalid arguments are provided
+ */
+export function validateSessionCookieSameSite(cookieSameSite: any, defaultFlag: any): boolean;
+export function validatePageHooks(hooks: any): any[];
+export function validateFields(fields: any): any[];
+export function validatePages(pages: any): any[];
+export function validatePlan(plan: any): any;
+export function validateGlobalHooks(hooks: any): any[];
+export function validatePlugins(plugins: any): any;
+export function validateEvents(events: any): any;
+/**
+ * Ingest, validate, sanitise and manipulate configuration parameters.
+ *
+ * @param {ConfigurationOptions} config Config to ingest.
+ * @throws {Error|SyntaxError|TypeError} For invalid config values.
+ * @returns {object} Immutable config object.
+ */
+export default function ingest(config?: ConfigurationOptions): object;
+export type ContextEvent = import('./index').ContextEvent;
+export type SessionOptions = {
+    /**
+     * Session name
+     */
+    name?: string | undefined;
+    /**
+     * Encryption secret
+     */
+    secret?: string | undefined;
+    /**
+     * Session ttl (seconds)
+     */
+    ttl?: number | undefined;
+    /**
+     * Whether to use secure session cookies
+     */
+    secure?: boolean | undefined;
+    /**
+     * SameSite (true = Strict)
+     */
+    cookieSameSite?: string | boolean | undefined;
+    /**
+     * Session store (default MemoryStore)
+     */
+    store?: object | undefined;
+};
+export type I18nOptions = {
+    /**
+     * Directories to search for locale dictionaries
+     */
+    dirs: string[];
+    /**
+     * Supported locales
+     */
+    locales?: string[] | undefined;
+};
+/**
+ * Hook configuration
+ */
+export type GlobalHook = {
+    /**
+     * Hook name in format `<router>.<hook>`
+     */
+    hook: string;
+    /**
+     * Middleware function to insert at the hook point
+     */
+    middleware: Function;
+    /**
+     * Only run if route path matches this string/regexp
+     */
+    path?: string | RegExp | undefined;
+};
+/**
+ * (extends GlobalHook)
+ */
+export type PageHook = {
+    /**
+     * Hook name (without a scope prefix)
+     */
+    hook: string;
+    /**
+     * Middleware function to insert at the hook point
+     */
+    middleware: Function;
+};
+/**
+ * Page configuration. A Page is the interactive representation of a waypoint
+ */
+export type Page = {
+    /**
+     * The waypoint with which this page is associated
+     */
+    waypoint: string;
+    /**
+     * Template path
+     */
+    view: string;
+    /**
+     * Page-specific hooks (optional, default [])
+     */
+    hooks?: PageHook[] | undefined;
+    /**
+     * Fields to be managed on this page (optional, default [])
+     */
+    fields?: PageField[] | undefined;
+};
+/**
+ * Configuration options
+ */
+export type ConfigurationOptions = {
+    mountUrl?: string | undefined;
+    /**
+     * Template directories
+     */
+    views?: string[] | undefined;
+    /**
+     * Session configuration
+     */
+    session?: SessionOptions | undefined;
+    /**
+     * Pages the represent waypoints
+     */
+    pages?: Page[] | undefined;
+    /**
+     * Hooks to apply
+     */
+    hooks?: GlobalHook[] | undefined;
+    /**
+     * Plugins
+     */
+    plugins?: object[] | undefined;
+    /**
+     * I18n configuration
+     */
+    i18n?: I18nOptions[] | undefined;
+    /**
+     * CASA Plan
+     */
+    plan: Plan;
+    /**
+     * Handlers for JourneyContext events
+     */
+    events?: any[] | undefined;
+};
+import { PageField } from "./field.js";
+import Plan from "./Plan.js";