@accordproject/template-engine 3.0.1 → 4.0.0

package/umd/template-engine.js.LICENSE.txt

@@ -0,0 +1,21 @@
+/*!
+ * Accord Project Template Engine v4.0.0 — browser build
+ * Licensed under the Apache License, Version 2.0
+ */
+
+/*!
+ * The buffer module from node.js, for the browser.
+ *
+ * @author   Feross Aboukhadijeh <https://feross.org>
+ * @license  MIT
+ */
+
+/*! For license information please see concerto-codegen.js.LICENSE.txt */
+
+/*! For license information please see markdown-template.js.LICENSE.txt */
+
+/*! For license information please see markdown-transform.js.LICENSE.txt */
+
+/*! ieee754. BSD-3-Clause License. Feross Aboukhadijeh <https://feross.org/opensource> */
+
+/*! jsonpath 1.3.0 */

package/dist/index.d.ts

@@ -1,174 +0,0 @@
-import { ModelManager, ClassDeclaration } from '@accordproject/concerto-core';
-import { Template } from '@accordproject/cicero-core';
-
-/*
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-/* eslint-disable @typescript-eslint/no-empty-object-type */
-
-// we duplicate these interfaces here to avoid imports into the runtime
-interface IConcept {
-    $class: string;
- }
-
-interface ITransaction extends IConcept {
-    $timestamp: Date;
- }
-
-interface IEvent extends IConcept {
-   $timestamp: Date;
-}
-
-interface IState {
-    $identifier: string;
-}
-
-interface EngineResponse<S extends IState> {
-    state?: S;
-    events?: Array<IEvent>
-}
-
-interface IRequest extends ITransaction {
-}
-
-interface IResponse extends ITransaction {
-}
-
-interface IAsset extends IConcept {
-   $identifier: string;
-}
-
-interface IContract extends IAsset {
-   contractId: string;
-}
-
-interface IClause extends IAsset {
-   clauseId: string;
-}
-
-interface TriggerResponse$1<S extends IState = IState> extends EngineResponse<S> {
-    result: IResponse;
-}
-
-interface InitResponse$1<S extends IState> extends EngineResponse<S> {}
-
-type TemplateData$1 = IContract|IClause;
-
-declare abstract class TemplateLogic<T extends TemplateData$1, S extends IState = IState> {
-    abstract trigger(data: T, request: IRequest, state:S) : Promise<TriggerResponse$1<S>>;
-    init(data: T) : Promise<InitResponse$1<S>|undefined>;
-}
-
-type TemplateData = Record<string, unknown>;
-
-/**
- * BEWARE - this type is duplicated in TypeScriptCompilationContext
- * for use by code generation
- */
-type GenerationOptions = {
-    now?: string;
-    locale?: string;
-    disableJavaScriptEvaluation?: boolean;
-    childProcessJavaScriptEvaluation?: boolean;
-    timeout?: number;
-};
-
-/**
- * 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): object;
-    generate(templateMark: object, data: TemplateData, options?: GenerationOptions): Promise<any>;
-}
-
-type State = object;
-type Response = object;
-type Event = object;
-type TriggerResponse = {
-    result: Response;
-    state: State;
-    events: Event[];
-};
-type InitResponse = {
-    state: State;
-};
-/**
- * A template archive processor: can draft content using the
- * templatemark for the archive and trigger the logic of the archive
- */
-declare class TemplateArchiveProcessor {
-    template: Template;
-    /**
-     * Creates a template archive processor
-     * @param {Template} template - the template to be used by the processor
-     */
-    constructor(template: Template);
-    /**
-     * Drafts a template by merging it with data
-     * @param {any} data the data to merge with the template
-     * @param {string} format the output format
-     * @param {any} options merge options
-     * @param {[string]} currentTime the current value for 'now'
-     * @returns {Promise} the drafted content
-     */
-    draft(data: any, format: string, options: any, currentTime?: string): Promise<any>;
-    /**
-     * Trigger the logic of a template
-     * @param {object} request - the request to send to the template logic
-     * @param {object} state - the current state of the template
-     * @param {[string]} currentTime - the current time, defaults to now
-     * @param {[number]} utcOffset - the UTC offset, defaults to zero
-     * @returns {Promise} the response and any events
-     */
-    trigger(data: any, request: any, state?: any, currentTime?: string, utcOffset?: number): Promise<TriggerResponse>;
-    /**
-     * Init the logic of a template
-     * @param {[string]} currentTime - the current time, defaults to now
-     * @param {[number]} utcOffset - the UTC offset, defaults to zero
-     * @returns {Promise<InitResponse>} the new state
-     */
-    init(data: any, currentTime?: string, utcOffset?: number): Promise<InitResponse>;
-}
-
-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 { TemplateArchiveProcessor, TemplateLogic, TemplateMarkInterpreter, ensureDirSync, getTemplateClassDeclaration, nameUserCode, removeSync, writeFunctionToString };