@accordproject/template-engine 2.1.1 → 2.3.0

package/dist/index.d.ts

@@ -1,2 +1,53 @@
-export { TemplateMarkInterpreter } from './TemplateMarkInterpreter';
-export { TemplateMarkToTypeScriptCompiler } from './TemplateMarkToTypeScriptCompiler';
+import * as _accordproject_concerto_core_types_lib_model_resource from '@accordproject/concerto-core/types/lib/model/resource';
+import { ModelManager, ClassDeclaration } from '@accordproject/concerto-core';
+
+type TemplateData = Record<string, unknown>;
+
+/**
+ * BEWARE - this type is duplicated in TypeScriptCompilationContext
+ * for use by code generation
+ */
+type GenerationOptions = {
+    now?: string;
+    locale?: string;
+};
+
+/**
+ * A template engine: merges the markup and logic of a template with
+ * JSON data to produce JSON data.
+ */
+declare class TemplateMarkInterpreter {
+    modelManager: ModelManager;
+    templateClass: ClassDeclaration;
+    clauseLibrary: object;
+    constructor(modelManager: ModelManager, clauseLibrary: object, templateConceptFqn?: string);
+    /**
+     * Checks that a TemplateMark JSON document is valid with respect to the
+     * TemplateMark model, as well as the template model.
+     *
+     * Checks:
+     * 1. Variable names are valid properties in the template model
+     * 2. Optional properties have guards
+     * @param {*} templateMark the TemplateMark JSON object
+     * @returns {*} TemplateMark JSON that has been typed checked and has type metadata added
+     * @throws {Error} if the templateMark document is invalid
+     */
+    checkTypes(templateMark: object): object;
+    /**
+     * Compiles the code nodes containing TS to code nodes containing JS.
+     * @param {*} templateMark the TemplateMark JSON object
+     * @returns {*} TemplateMark JSON with JS nodes
+     * @throws {Error} if the templateMark document is invalid
+     */
+    compileTypeScriptToJavaScript(templateMark: object): Promise<object>;
+    validateCiceroMark(ciceroMark: object): _accordproject_concerto_core_types_lib_model_resource;
+    generate(templateMark: object, data: TemplateData, options?: GenerationOptions): Promise<any>;
+}
+
+declare function ensureDirSync(path: string): void;
+declare function removeSync(path: string): void;
+declare function writeFunctionToString(templateClass: ClassDeclaration, functionName: string, returnType: string, code: string): string;
+declare function nameUserCode(templateMarkDom: any): any;
+declare function getTemplateClassDeclaration(modelManager: ModelManager, templateConceptFqn?: string): ClassDeclaration;
+
+export { TemplateMarkInterpreter, ensureDirSync, getTemplateClassDeclaration, nameUserCode, removeSync, writeFunctionToString };