@financial-times/dotcom-server-handlebars 7.3.0 → 7.3.2

package/dist/node/PageKitHandlebars.d.ts

@@ -0,0 +1,46 @@
+import Handlebars, { HelperDelegate, TemplateDelegate } from 'handlebars';
+import { TRenderCallback, TPartialTemplates, TFilePaths } from './types';
+export declare type TPageKitHandlebarsOptions = {
+    /**
+     * An instance of Handlebars to use.
+     * @default require('handlebars')
+     */
+    handlebars?: typeof Handlebars;
+    /**
+     * Current working directory.
+     * @default process.cwd()
+     */
+    rootDirectory?: string;
+    /**
+     * Additional helper functions to register with Handlebars.
+     * @default {}
+     */
+    helpers?: {
+        [key: string]: HelperDelegate;
+    };
+    /**
+     * Partial templates to register with Handlebars.
+     * @default {}
+     */
+    partials?: TPartialTemplates;
+    /**
+     * A list of directories and patterns used to dynamically find and load partial template files.
+     * @default { './views/partials': '**\/*.{hbs,html}' }
+     */
+    partialPaths?: TFilePaths;
+    /**
+     * Enable caching of template files to reduce filesystem I/O
+     * @default process.env.NODE_ENV !== 'development
+     */
+    cache?: boolean;
+};
+export declare class PageKitHandlebars {
+    options: TPageKitHandlebarsOptions;
+    engine: this['renderView'];
+    private cache;
+    constructor(userOptions?: TPageKitHandlebarsOptions);
+    loadPartials(): TPartialTemplates;
+    loadTemplate(filePath: string): TemplateDelegate;
+    render(template: string | TemplateDelegate, templateContext: any): string;
+    renderView(templatePath: string, templateContext: any, callback: TRenderCallback): void;
+}

package/dist/node/findPartialFiles.d.ts

@@ -0,0 +1,2 @@
+import { TFilePaths } from './types';
+export default function loadPartialFiles(cwd: string, partialPaths: TFilePaths): TFilePaths;

package/dist/node/helpers/array.d.ts

@@ -0,0 +1 @@
+export default function array(...args: any[]): any[];

package/dist/node/helpers/capture.d.ts

@@ -0,0 +1,2 @@
+import { HelperOptions } from 'handlebars';
+export default function capture(name: string, options: HelperOptions): void;

package/dist/node/helpers/concat.d.ts

@@ -0,0 +1 @@
+export default function concat(...args: any[]): string;

package/dist/node/helpers/dateformat.d.ts

@@ -0,0 +1 @@
+export default function dateformat(...args: any[]): any;

package/dist/node/helpers/encode.d.ts

@@ -0,0 +1 @@
+export default function encode(...args: any[]): string;

package/dist/node/helpers/ifAll.d.ts

@@ -0,0 +1 @@
+export default function ifAll(...args: any[]): string;

package/dist/node/helpers/ifEquals.d.ts

@@ -0,0 +1 @@
+export default function ifEquals(...args: any[]): string;

package/dist/node/helpers/ifEqualsSome.d.ts

@@ -0,0 +1 @@
+export default function ifEqualsSome(...args: any[]): string;

package/dist/node/helpers/ifSome.d.ts

@@ -0,0 +1 @@
+export default function ifSome(...args: any[]): string;

package/dist/node/helpers/json.d.ts

@@ -0,0 +1 @@
+export default function json(...args: any[]): string;

package/dist/node/helpers/renderReactComponent.d.ts

@@ -0,0 +1,3 @@
+export default function renderReactComponent({ hash }: {
+    hash: any;
+}): any;

package/dist/node/helpers/resize.d.ts

@@ -0,0 +1 @@
+export default function resize(...args: any[]): string;

package/dist/node/helpers/slice.d.ts

@@ -0,0 +1 @@
+export default function slice(...args: any[]): string;

package/dist/node/helpers/unlessAll.d.ts

@@ -0,0 +1 @@
+export default function unlessAll(...args: any[]): string;

package/dist/node/helpers/unlessEquals.d.ts

@@ -0,0 +1 @@
+export default function unlessEquals(...args: any[]): string;

package/dist/node/helpers/unlessSome.d.ts

@@ -0,0 +1 @@
+export default function unlessSome(...args: any[]): string;

package/dist/node/helpers.d.ts

@@ -0,0 +1,16 @@
+export { default as array } from './helpers/array';
+export { default as capture } from './helpers/capture';
+export { default as concat } from './helpers/concat';
+export { default as dateformat } from './helpers/dateformat';
+export { default as encode } from './helpers/encode';
+export { default as ifAll } from './helpers/ifAll';
+export { default as ifEquals } from './helpers/ifEquals';
+export { default as ifEqualsSome } from './helpers/ifEqualsSome';
+export { default as ifSome } from './helpers/ifSome';
+export { default as json } from './helpers/json';
+export { default as renderReactComponent } from './helpers/renderReactComponent';
+export { default as resize } from './helpers/resize';
+export { default as slice } from './helpers/slice';
+export { default as unlessAll } from './helpers/unlessAll';
+export { default as unlessEquals } from './helpers/unlessEquals';
+export { default as unlessSome } from './helpers/unlessSome';

package/dist/node/index.d.ts

@@ -0,0 +1,3 @@
+import * as helpers from './helpers';
+export * from './PageKitHandlebars';
+export { helpers };

package/dist/node/loadFileContents.d.ts

@@ -0,0 +1 @@
+export default function loadFileContents(filePath: string): string;