@jakubmazanec/template 1.0.0-a3e1bca

package/README.md

@@ -0,0 +1,102 @@
+<div align="center">
+
+# @jakubmazanec/template
+
+TypeScript-first library for working with templates using EJS and Zod.
+
+</div>
+
+## Installation
+
+```sh
+npm install @jakubmazanec/template
+```
+
+⚠️ This is an [ESM](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c) package!
+It cannot be required from a CommonJS module.
+
+#### Prerequisites
+
+- Node.js 16 or later
+- TypeScript 5 or later
+
+## Usage
+
+Write templates using [EJS](https://ejs.co/) with YAML front matter:
+
+```
+---
+to: <%- attributes.variables.path %>
+if: <%- attributes.variables.enabled %>
+variables:
+  - path: foo-<%- value %>.json
+    enabled: true
+  - name: bar-<%- value %>.json
+    enabled: false
+---
+{
+    "value": <%- value %>
+}
+```
+
+The front matter is used for specifying template attributes that control how is the template
+rendered. Some attributes can be written in EJS too and are rendered before the template content is
+rendered.
+
+It is expected that attribute `if` renders to a string that can be parsed as YAML value; if that
+value is `false`, the rendering of the whole template is cancelled.
+
+Attribute `to` is also rendered and it represents the path of file the resulting template render is
+supposed to be written into. The extension is also used for file format detection by Prettier.
+
+Attribute `variables` is an object that is merged with the data object before rendering. If
+attribute `variables` is an array of objects, that leads to multiple renders, each with different
+variables object merged with the data. Each variable that is a string is also rendered.
+
+The JavaScript variable `value` (used in EJS tags `<% %>`) is not defined, so it must be passed as a
+data during the template rendering:
+
+```TypeScript
+let template = await Template.read('template.ejs', {
+  dataSchema: z.object({value: z.number()}) // we have to specify the schema that represent the template data type
+});
+
+console.log(await template.render({value: 1}));
+// ->
+// [{
+//   attributes: {
+//     to: 'foo-1.json',
+//     variables: { path: 'foo-1.json', enabled: true }
+//   },
+//   data: { value: 1 },
+//   content: '{\n  "value": 1\n}\n'
+// }]
+
+console.log(await template.render({value: 2}));
+// ->
+// [{
+//   attributes: {
+//     to: 'foo-2.json',
+//     variables: { path: 'foo-2.json', enabled: true }
+//   },
+//   data: { value: 2 },
+//   content: '{\n  "value": 2\n}\n'
+// }]
+```
+
+Because `variables` is an array, we can expect two renders; but because one of the variables,
+`enabled` is used for rendering the value of `if` attribute and is set to `false` in the second
+case, only one render is actually returned.
+
+## Documentation
+
+See [API reference](./docs) for auto-generated documentation.
+
+## Contributing
+
+If you want to contribute, see [CONTRIBUTING](./CONTRIBUTING.md) for details.
+
+## License
+
+This package is licensed under the GNU Lesser General Public License v3. See [LICENSE](./LICENSE.md)
+for details.

package/dist/Template.d.ts

@@ -0,0 +1,89 @@
+import prettier from 'prettier';
+import { type z, type AnyZodObject } from 'zod';
+import { type TemplateAttributes, type TemplateRenders } from './types.js';
+export type TemplateOptions<A extends AnyZodObject | undefined = undefined, D extends AnyZodObject | undefined = undefined> = {
+    /** Template content. */
+    content: string;
+    /** Template attributes.  */
+    attributes: A extends undefined ? TemplateAttributes : TemplateAttributes & z.infer<NonNullable<A>>;
+    /** Zod schema for custom template attributes. */
+    attributesSchema?: A | undefined;
+    /** Zod schema for template data. */
+    dataSchema?: D | undefined;
+};
+export type TemplateReadOptions<A extends AnyZodObject | undefined = undefined, D extends AnyZodObject | undefined = undefined> = {
+    /** Zod schema for custom template attributes. */
+    attributesSchema?: A | undefined;
+    /** Zod schema for template data. */
+    dataSchema?: D | undefined;
+};
+export type TemplateReadAndRenderOptions<A extends AnyZodObject | undefined = undefined, D extends AnyZodObject | undefined = undefined> = {
+    /** Prettier options.  */
+    prettierOptions?: prettier.Options | undefined;
+    /** Disable formatting the rendered template using Prettier.  */
+    disablePrettier?: boolean | undefined;
+    /** Zod schema for custom template attributes. */
+    attributesSchema?: A | undefined;
+    /** Zod schema for template data. */
+    dataSchema?: D | undefined;
+};
+export type TemplateRenderOptions = {
+    /** Prettier options.  */
+    prettierOptions?: prettier.Options | undefined;
+    /** Disable formatting the rendered template using Prettier.  */
+    disablePrettier?: boolean | undefined;
+};
+/**
+ * The `Template` object stores all information about a template and has methods for reading and rendering.
+ *
+ * ```TypeScript
+ * let template = new Template({
+ *   content: '<%- value %>',
+ *   attributes: {
+ *     to: 'value.txt',
+ *   },
+ *   dataSchema: z.object({value: z.number()}),
+ * });
+ *
+ * console.log(await template.render({value: 42})); // ->  [{attributes: {to: 'value.txt'}, data: {value: 42}, content: '42'}]
+ * ```
+ *
+ * @typeParam A A Zod schema type used to define the custom template attributes type.
+ * @typeParam D A Zod schema type used to define the template datatype.
+ */
+export declare class Template<A extends AnyZodObject | undefined = undefined, D extends AnyZodObject | undefined = undefined> {
+    /** Template content. Templates are written in [EJS](https://ejs.co/). */
+    readonly content: string;
+    /** Template attributes. These control how the template is rendered. Some attributes can be written in [EJS](https://ejs.co/) and are rendered before the template content is rendered. It is expected that attribute `if` renders to a string that can be parsed as YAML value; if that value is `false`, the rendering is cancelled. Attribute `to` is also rendered and it represents the path of file the resulting template render is supposed to be written into (by the user). Attribute `variables` is an object that is merged with the data object before rendering. If attribute `variables` is an array of objects, that leads to multiple renders, each with different variables object merged with the data. Each variable that is a string is also rendered. */
+    readonly attributes: A extends undefined ? TemplateAttributes : TemplateAttributes & z.infer<NonNullable<A>>;
+    /** Template function. */
+    private readonly fn;
+    /** Zod schema for custom template attributes. */
+    readonly attributesSchema: A extends AnyZodObject ? A : null;
+    /** Zod schema for template data. */
+    readonly dataSchema: D extends AnyZodObject ? D : null;
+    constructor({ content, attributes, attributesSchema, dataSchema }: TemplateOptions<A, D>);
+    /**
+     * Reads a template from a file.
+     *
+     * @param templateFilePath Path to the template file.
+     */
+    static read<A extends AnyZodObject | undefined = undefined, D extends AnyZodObject | undefined = undefined>(templateFilePath: string, options?: TemplateReadOptions<A, D>): Promise<Template<A, D>>;
+    /**
+     * Reads a template from a file and then renders it.
+     *
+     * @param templateFilePath Path to the template file.
+     * @param data Data used for rendering the template.
+     * @param options Options object.
+     * @return Template renders.
+     */
+    static readAndRender<A extends AnyZodObject | undefined = undefined, D extends AnyZodObject | undefined = undefined>(templateFilePath: string, data: D extends undefined ? null : z.infer<NonNullable<D>>, options?: TemplateReadAndRenderOptions<A, D>): Promise<TemplateRenders<A, D>>;
+    /**
+     * Renders the template using data.
+     *
+     * @param data Data used for rendering the template.
+     * @param options Options object.
+     * @return Template renders.
+     */
+    render(data: D extends undefined ? null : z.infer<NonNullable<D>>, options?: TemplateRenderOptions): Promise<TemplateRenders<A, D>>;
+}

package/dist/Template.js

@@ -0,0 +1,156 @@
+import ejs from 'ejs';
+import fs from 'fs-extra';
+import matter from 'gray-matter';
+import omit from 'lodash.omit';
+import prettier from 'prettier';
+import yaml from 'yaml';
+import { NO_INFERRED_PARSER_REGEXP } from './constants.js';
+import { TemplateError } from './TemplateError.js';
+import { templateAttributesSchema } from './types.js';
+/**
+ * The `Template` object stores all information about a template and has methods for reading and rendering.
+ *
+ * ```TypeScript
+ * let template = new Template({
+ *   content: '<%- value %>',
+ *   attributes: {
+ *     to: 'value.txt',
+ *   },
+ *   dataSchema: z.object({value: z.number()}),
+ * });
+ *
+ * console.log(await template.render({value: 42})); // ->  [{attributes: {to: 'value.txt'}, data: {value: 42}, content: '42'}]
+ * ```
+ *
+ * @typeParam A A Zod schema type used to define the custom template attributes type.
+ * @typeParam D A Zod schema type used to define the template datatype.
+ */ export class Template {
+    constructor({ content , attributes , attributesSchema , dataSchema  }){
+        this.content = content;
+        this.attributes = attributes;
+        this.fn = ejs.compile(this.content);
+        if (attributesSchema) {
+            this.attributesSchema = attributesSchema;
+        } else {
+            this.attributesSchema = null;
+        }
+        if (dataSchema) {
+            this.dataSchema = dataSchema;
+        } else {
+            this.dataSchema = null;
+        }
+    }
+    /**
+   * Reads a template from a file.
+   *
+   * @param templateFilePath Path to the template file.
+   */ static async read(templateFilePath, options) {
+        let { data: attributes , content  } = matter(await fs.readFile(templateFilePath, 'utf8'));
+        let attributesSchema = (options === null || options === void 0 ? void 0 : options.attributesSchema) ? templateAttributesSchema.merge(options.attributesSchema) : templateAttributesSchema;
+        let attributesParseResult = attributesSchema.safeParse(attributes);
+        if (!attributesParseResult.success) {
+            throw new TemplateError('INVALID_ATTRIBUTES', {
+                cause: attributesParseResult.error,
+                data: {
+                    path: templateFilePath,
+                    zodIssues: attributesParseResult.error.issues
+                }
+            });
+        }
+        return new this({
+            attributes,
+            content,
+            attributesSchema: options === null || options === void 0 ? void 0 : options.attributesSchema,
+            dataSchema: options === null || options === void 0 ? void 0 : options.dataSchema
+        });
+    }
+    /**
+   * Reads a template from a file and then renders it.
+   *
+   * @param templateFilePath Path to the template file.
+   * @param data Data used for rendering the template.
+   * @param options Options object.
+   * @return Template renders.
+   */ static async readAndRender(templateFilePath, data, options) {
+        let template = await Template.read(templateFilePath, {
+            attributesSchema: options === null || options === void 0 ? void 0 : options.attributesSchema,
+            dataSchema: options === null || options === void 0 ? void 0 : options.dataSchema
+        });
+        return template.render(data, {
+            prettierOptions: options === null || options === void 0 ? void 0 : options.prettierOptions,
+            disablePrettier: options === null || options === void 0 ? void 0 : options.disablePrettier
+        });
+    }
+    /**
+   * Renders the template using data.
+   *
+   * @param data Data used for rendering the template.
+   * @param options Options object.
+   * @return Template renders.
+   */ async render(data, options) {
+        let renders = [];
+        for (let variables of Array.isArray(this.attributes.variables) ? this.attributes.variables : [
+            this.attributes.variables
+        ]){
+            let renderedAttributes = omit(this.attributes, [
+                'if'
+            ]);
+            let renderedVariables = variables;
+            if (renderedVariables) {
+                for (let [variableName, variableValue] of Object.entries(renderedVariables)){
+                    if (typeof variableValue === 'string') {
+                        renderedVariables[variableName] = ejs.render(variableValue, {
+                            ...data
+                        });
+                    } else {
+                        renderedVariables[variableName] = variableValue;
+                    }
+                }
+                renderedAttributes.variables = renderedVariables;
+            }
+            let dataWithAttributes = {
+                ...data,
+                attributes: renderedAttributes
+            };
+            if (this.attributes.if) {
+                let renderedIf = ejs.render(this.attributes.if, dataWithAttributes);
+                let parsedIf = yaml.parse(renderedIf);
+                if (parsedIf === false) {
+                    continue;
+                }
+            }
+            renderedAttributes.to = ejs.render(renderedAttributes.to, dataWithAttributes);
+            dataWithAttributes.attributes = renderedAttributes;
+            let content;
+            try {
+                content = this.fn(dataWithAttributes);
+            } catch (error) {
+                throw new TemplateError('FAILED_RENDER', {
+                    cause: error
+                });
+            }
+            if (!(options === null || options === void 0 ? void 0 : options.disablePrettier)) {
+                try {
+                    content = prettier.format(content, {
+                        ...options === null || options === void 0 ? void 0 : options.prettierOptions,
+                        filepath: renderedAttributes.to
+                    });
+                } catch (error1) {
+                    if (!NO_INFERRED_PARSER_REGEXP.test(error1.message)) {
+                        throw new TemplateError('FAILED_FORMAT', {
+                            cause: error1
+                        });
+                    }
+                }
+            }
+            renders.push({
+                attributes: renderedAttributes,
+                data: data ?? null,
+                content
+            });
+        }
+        return renders;
+    }
+}
+
+//# sourceMappingURL=Template.js.map

package/dist/Template.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/Template.ts"],"sourcesContent":["import ejs from 'ejs';\nimport fs from 'fs-extra';\nimport matter from 'gray-matter';\nimport omit from 'lodash.omit';\nimport prettier from 'prettier';\nimport yaml from 'yaml';\nimport {type z, type AnyZodObject} from 'zod';\n\nimport {NO_INFERRED_PARSER_REGEXP} from './constants.js';\nimport {TemplateError} from './TemplateError.js';\nimport {\n  templateAttributesSchema,\n  type TemplateAttributes,\n  type TemplateFunction,\n  type TemplateRender,\n  type TemplateRenders,\n} from './types.js';\n\nexport type TemplateOptions<\n  A extends AnyZodObject | undefined = undefined,\n  D extends AnyZodObject | undefined = undefined,\n> = {\n  /** Template content. */\n  content: string;\n\n  /** Template attributes.  */\n  attributes: A extends undefined\n    ? TemplateAttributes\n    : TemplateAttributes & z.infer<NonNullable<A>>;\n\n  /** Zod schema for custom template attributes. */\n  attributesSchema?: A | undefined;\n\n  /** Zod schema for template data. */\n  dataSchema?: D | undefined;\n};\n\nexport type TemplateReadOptions<\n  A extends AnyZodObject | undefined = undefined,\n  D extends AnyZodObject | undefined = undefined,\n> = {\n  /** Zod schema for custom template attributes. */\n  attributesSchema?: A | undefined;\n\n  /** Zod schema for template data. */\n  dataSchema?: D | undefined;\n};\n\nexport type TemplateReadAndRenderOptions<\n  A extends AnyZodObject | undefined = undefined,\n  D extends AnyZodObject | undefined = undefined,\n> = {\n  /** Prettier options.  */\n  prettierOptions?: prettier.Options | undefined;\n\n  /** Disable formatting the rendered template using Prettier.  */\n  disablePrettier?: boolean | undefined;\n\n  /** Zod schema for custom template attributes. */\n  attributesSchema?: A | undefined;\n\n  /** Zod schema for template data. */\n  dataSchema?: D | undefined;\n};\n\nexport type TemplateRenderOptions = {\n  /** Prettier options.  */\n  prettierOptions?: prettier.Options | undefined;\n\n  /** Disable formatting the rendered template using Prettier.  */\n  disablePrettier?: boolean | undefined;\n};\n\n/**\n * The `Template` object stores all information about a template and has methods for reading and rendering.\n *\n * ```TypeScript\n * let template = new Template({\n *   content: '<%- value %>',\n *   attributes: {\n *     to: 'value.txt',\n *   },\n *   dataSchema: z.object({value: z.number()}),\n * });\n *\n * console.log(await template.render({value: 42})); // ->  [{attributes: {to: 'value.txt'}, data: {value: 42}, content: '42'}]\n * ```\n *\n * @typeParam A A Zod schema type used to define the custom template attributes type.\n * @typeParam D A Zod schema type used to define the template datatype.\n */\nexport class Template<\n  A extends AnyZodObject | undefined = undefined,\n  D extends AnyZodObject | undefined = undefined,\n> {\n  /** Template content. Templates are written in [EJS](https://ejs.co/). */\n  readonly content: string;\n\n  /** Template attributes. These control how the template is rendered. Some attributes can be written in [EJS](https://ejs.co/) and are rendered before the template content is rendered. It is expected that attribute `if` renders to a string that can be parsed as YAML value; if that value is `false`, the rendering is cancelled. Attribute `to` is also rendered and it represents the path of file the resulting template render is supposed to be written into (by the user). Attribute `variables` is an object that is merged with the data object before rendering. If attribute `variables` is an array of objects, that leads to multiple renders, each with different variables object merged with the data. Each variable that is a string is also rendered. */\n  readonly attributes: A extends undefined\n    ? TemplateAttributes\n    : TemplateAttributes & z.infer<NonNullable<A>>;\n\n  /** Template function. */\n  private readonly fn: TemplateFunction;\n\n  /** Zod schema for custom template attributes. */\n  readonly attributesSchema: A extends AnyZodObject ? A : null;\n\n  /** Zod schema for template data. */\n  readonly dataSchema: D extends AnyZodObject ? D : null;\n\n  constructor({content, attributes, attributesSchema, dataSchema}: TemplateOptions<A, D>) {\n    this.content = content;\n    this.attributes = attributes;\n    this.fn = ejs.compile(this.content);\n\n    if (attributesSchema) {\n      this.attributesSchema = attributesSchema as A extends AnyZodObject ? A : null;\n    } else {\n      this.attributesSchema = null as A extends AnyZodObject ? A : null;\n    }\n\n    if (dataSchema) {\n      this.dataSchema = dataSchema as D extends AnyZodObject ? D : null;\n    } else {\n      this.dataSchema = null as D extends AnyZodObject ? D : null;\n    }\n  }\n\n  /**\n   * Reads a template from a file.\n   *\n   * @param templateFilePath Path to the template file.\n   */\n  static async read<\n    A extends AnyZodObject | undefined = undefined,\n    D extends AnyZodObject | undefined = undefined,\n  >(templateFilePath: string, options?: TemplateReadOptions<A, D>): Promise<Template<A, D>> {\n    let {data: attributes, content} = matter(await fs.readFile(templateFilePath, 'utf8'));\n    let attributesSchema = options?.attributesSchema\n      ? templateAttributesSchema.merge(options.attributesSchema)\n      : templateAttributesSchema;\n    let attributesParseResult = attributesSchema.safeParse(attributes);\n\n    if (!attributesParseResult.success) {\n      throw new TemplateError('INVALID_ATTRIBUTES', {\n        cause: attributesParseResult.error,\n        data: {\n          path: templateFilePath,\n          zodIssues: attributesParseResult.error.issues,\n        },\n      });\n    }\n\n    return new this({\n      attributes,\n      content,\n      attributesSchema: options?.attributesSchema,\n      dataSchema: options?.dataSchema,\n    } as TemplateOptions<A, D>);\n  }\n\n  /**\n   * Reads a template from a file and then renders it.\n   *\n   * @param templateFilePath Path to the template file.\n   * @param data Data used for rendering the template.\n   * @param options Options object.\n   * @return Template renders.\n   */\n  static async readAndRender<\n    A extends AnyZodObject | undefined = undefined,\n    D extends AnyZodObject | undefined = undefined,\n  >(\n    templateFilePath: string,\n    data: D extends undefined ? null : z.infer<NonNullable<D>>,\n    options?: TemplateReadAndRenderOptions<A, D>,\n  ) {\n    let template = await Template.read<A, D>(templateFilePath, {\n      attributesSchema: options?.attributesSchema,\n      dataSchema: options?.dataSchema,\n    });\n\n    return template.render(data, {\n      prettierOptions: options?.prettierOptions,\n      disablePrettier: options?.disablePrettier,\n    });\n  }\n\n  /**\n   * Renders the template using data.\n   *\n   * @param data Data used for rendering the template.\n   * @param options Options object.\n   * @return Template renders.\n   */\n  async render(\n    data: D extends undefined ? null : z.infer<NonNullable<D>>,\n    options?: TemplateRenderOptions,\n  ): Promise<TemplateRenders<A, D>> {\n    let renders: TemplateRenders<A, D> = [];\n\n    for (let variables of Array.isArray(this.attributes.variables)\n      ? this.attributes.variables\n      : [this.attributes.variables]) {\n      let renderedAttributes = omit(this.attributes, ['if']);\n      let renderedVariables = variables;\n\n      if (renderedVariables) {\n        for (let [variableName, variableValue] of Object.entries(renderedVariables)) {\n          if (typeof variableValue === 'string') {\n            renderedVariables[variableName] = ejs.render(variableValue, {...data});\n          } else {\n            renderedVariables[variableName] = variableValue;\n          }\n        }\n\n        renderedAttributes.variables = renderedVariables;\n      }\n\n      let dataWithAttributes = {...data, attributes: renderedAttributes};\n\n      if (this.attributes.if) {\n        let renderedIf = ejs.render(this.attributes.if, dataWithAttributes);\n        let parsedIf = yaml.parse(renderedIf) as unknown;\n\n        if (parsedIf === false) {\n          continue;\n        }\n      }\n\n      renderedAttributes.to = ejs.render(renderedAttributes.to, dataWithAttributes);\n      dataWithAttributes.attributes = renderedAttributes;\n\n      let content;\n\n      try {\n        content = this.fn(dataWithAttributes);\n      } catch (error: unknown) {\n        throw new TemplateError('FAILED_RENDER', {cause: error});\n      }\n\n      if (!options?.disablePrettier) {\n        try {\n          content = prettier.format(content, {\n            ...options?.prettierOptions,\n            filepath: renderedAttributes.to,\n          });\n        } catch (error: unknown) {\n          if (!NO_INFERRED_PARSER_REGEXP.test((error as Error).message)) {\n            throw new TemplateError('FAILED_FORMAT', {cause: error});\n          }\n        }\n      }\n\n      renders.push({\n        attributes: renderedAttributes,\n        data: data ?? null,\n        content,\n      } as TemplateRender<A, D>);\n    }\n\n    return renders;\n  }\n}\n"],"names":["ejs","fs","matter","omit","prettier","yaml","NO_INFERRED_PARSER_REGEXP","TemplateError","templateAttributesSchema","Template","constructor","content","attributes","attributesSchema","dataSchema","fn","compile","read","templateFilePath","options","data","readFile","merge","attributesParseResult","safeParse","success","cause","error","path","zodIssues","issues","readAndRender","template","render","prettierOptions","disablePrettier","renders","variables","Array","isArray","renderedAttributes","renderedVariables","variableName","variableValue","Object","entries","dataWithAttributes","if","renderedIf","parsedIf","parse","to","format","filepath","test","message","push"],"mappings":"AAAA,OAAOA,SAAS,MAAM;AACtB,OAAOC,QAAQ,WAAW;AAC1B,OAAOC,YAAY,cAAc;AACjC,OAAOC,UAAU,cAAc;AAC/B,OAAOC,cAAc,WAAW;AAChC,OAAOC,UAAU,OAAO;AAGxB,SAAQC,yBAAyB,QAAO,iBAAiB;AACzD,SAAQC,aAAa,QAAO,qBAAqB;AACjD,SACEC,wBAAwB,QAKnB,aAAa;AAyDpB;;;;;;;;;;;;;;;;;CAiBC,GACD,OAAO,MAAMC;IAqBXC,YAAY,EAACC,QAAO,EAAEC,WAAU,EAAEC,iBAAgB,EAAEC,WAAU,EAAwB,CAAE;QACtF,IAAI,CAACH,OAAO,GAAGA;QACf,IAAI,CAACC,UAAU,GAAGA;QAClB,IAAI,CAACG,EAAE,GAAGf,IAAIgB,OAAO,CAAC,IAAI,CAACL,OAAO;QAElC,IAAIE,kBAAkB;YACpB,IAAI,CAACA,gBAAgB,GAAGA;QAC1B,OAAO;YACL,IAAI,CAACA,gBAAgB,GAAG,IAAI;QAC9B,CAAC;QAED,IAAIC,YAAY;YACd,IAAI,CAACA,UAAU,GAAGA;QACpB,OAAO;YACL,IAAI,CAACA,UAAU,GAAG,IAAI;QACxB,CAAC;IACH;IAEA;;;;GAIC,GACD,aAAaG,KAGXC,gBAAwB,EAAEC,OAAmC,EAA2B;QACxF,IAAI,EAACC,MAAMR,WAAU,EAAED,QAAO,EAAC,GAAGT,OAAO,MAAMD,GAAGoB,QAAQ,CAACH,kBAAkB;QAC7E,IAAIL,mBAAmBM,CAAAA,oBAAAA,qBAAAA,KAAAA,IAAAA,QAASN,gBAAgB,AAAD,IAC3CL,yBAAyBc,KAAK,CAACH,QAAQN,gBAAgB,IACvDL,wBAAwB;QAC5B,IAAIe,wBAAwBV,iBAAiBW,SAAS,CAACZ;QAEvD,IAAI,CAACW,sBAAsBE,OAAO,EAAE;YAClC,MAAM,IAAIlB,cAAc,sBAAsB;gBAC5CmB,OAAOH,sBAAsBI,KAAK;gBAClCP,MAAM;oBACJQ,MAAMV;oBACNW,WAAWN,sBAAsBI,KAAK,CAACG,MAAM;gBAC/C;YACF,GAAG;QACL,CAAC;QAED,OAAO,IAAI,IAAI,CAAC;YACdlB;YACAD;YACAE,kBAAkBM,oBAAAA,qBAAAA,KAAAA,IAAAA,QAASN,gBAAgB;YAC3CC,YAAYK,oBAAAA,qBAAAA,KAAAA,IAAAA,QAASL,UAAU;QACjC;IACF;IAEA;;;;;;;GAOC,GACD,aAAaiB,cAIXb,gBAAwB,EACxBE,IAA0D,EAC1DD,OAA4C,EAC5C;QACA,IAAIa,WAAW,MAAMvB,SAASQ,IAAI,CAAOC,kBAAkB;YACzDL,kBAAkBM,oBAAAA,qBAAAA,KAAAA,IAAAA,QAASN,gBAAgB;YAC3CC,YAAYK,oBAAAA,qBAAAA,KAAAA,IAAAA,QAASL,UAAU;QACjC;QAEA,OAAOkB,SAASC,MAAM,CAACb,MAAM;YAC3Bc,iBAAiBf,oBAAAA,qBAAAA,KAAAA,IAAAA,QAASe,eAAe;YACzCC,iBAAiBhB,oBAAAA,qBAAAA,KAAAA,IAAAA,QAASgB,eAAe;QAC3C;IACF;IAEA;;;;;;GAMC,GACD,MAAMF,OACJb,IAA0D,EAC1DD,OAA+B,EACC;QAChC,IAAIiB,UAAiC,EAAE;QAEvC,KAAK,IAAIC,aAAaC,MAAMC,OAAO,CAAC,IAAI,CAAC3B,UAAU,CAACyB,SAAS,IACzD,IAAI,CAACzB,UAAU,CAACyB,SAAS,GACzB;YAAC,IAAI,CAACzB,UAAU,CAACyB,SAAS;SAAC,CAAE;YAC/B,IAAIG,qBAAqBrC,KAAK,IAAI,CAACS,UAAU,EAAE;gBAAC;aAAK;YACrD,IAAI6B,oBAAoBJ;YAExB,IAAII,mBAAmB;gBACrB,KAAK,IAAI,CAACC,cAAcC,cAAc,IAAIC,OAAOC,OAAO,CAACJ,mBAAoB;oBAC3E,IAAI,OAAOE,kBAAkB,UAAU;wBACrCF,iBAAiB,CAACC,aAAa,GAAG1C,IAAIiC,MAAM,CAACU,eAAe;4BAAC,GAAGvB,IAAI;wBAAA;oBACtE,OAAO;wBACLqB,iBAAiB,CAACC,aAAa,GAAGC;oBACpC,CAAC;gBACH;gBAEAH,mBAAmBH,SAAS,GAAGI;YACjC,CAAC;YAED,IAAIK,qBAAqB;gBAAC,GAAG1B,IAAI;gBAAER,YAAY4B;YAAkB;YAEjE,IAAI,IAAI,CAAC5B,UAAU,CAACmC,EAAE,EAAE;gBACtB,IAAIC,aAAahD,IAAIiC,MAAM,CAAC,IAAI,CAACrB,UAAU,CAACmC,EAAE,EAAED;gBAChD,IAAIG,WAAW5C,KAAK6C,KAAK,CAACF;gBAE1B,IAAIC,aAAa,KAAK,EAAE;oBACtB,QAAS;gBACX,CAAC;YACH,CAAC;YAEDT,mBAAmBW,EAAE,GAAGnD,IAAIiC,MAAM,CAACO,mBAAmBW,EAAE,EAAEL;YAC1DA,mBAAmBlC,UAAU,GAAG4B;YAEhC,IAAI7B;YAEJ,IAAI;gBACFA,UAAU,IAAI,CAACI,EAAE,CAAC+B;YACpB,EAAE,OAAOnB,OAAgB;gBACvB,MAAM,IAAIpB,cAAc,iBAAiB;oBAACmB,OAAOC;gBAAK,GAAG;YAC3D;YAEA,IAAI,CAACR,CAAAA,oBAAAA,qBAAAA,KAAAA,IAAAA,QAASgB,eAAe,AAAD,GAAG;gBAC7B,IAAI;oBACFxB,UAAUP,SAASgD,MAAM,CAACzC,SAAS;wBACjC,GAAGQ,oBAAAA,qBAAAA,KAAAA,IAAAA,QAASe,eAAe;wBAC3BmB,UAAUb,mBAAmBW,EAAE;oBACjC;gBACF,EAAE,OAAOxB,QAAgB;oBACvB,IAAI,CAACrB,0BAA0BgD,IAAI,CAAC,AAAC3B,OAAgB4B,OAAO,GAAG;wBAC7D,MAAM,IAAIhD,cAAc,iBAAiB;4BAACmB,OAAOC;wBAAK,GAAG;oBAC3D,CAAC;gBACH;YACF,CAAC;YAEDS,QAAQoB,IAAI,CAAC;gBACX5C,YAAY4B;gBACZpB,MAAMA,QAAQ,IAAI;gBAClBT;YACF;QACF;QAEA,OAAOyB;IACT;AACF,CAAC"}

package/dist/TemplateError.d.ts

@@ -0,0 +1,14 @@
+import { type ZodIssue } from 'zod';
+import { type Template } from './Template.js';
+/**
+ * A subclass of `Error` that indicates a template  failure.
+ */
+export declare const TemplateError: new (code: "INVALID_ATTRIBUTES" | "FAILED_FORMAT" | "FAILED_RENDER", options?: import("@jakubmazanec/error").CustomErrorWithDataOptions<{
+    template?: Template;
+    path?: string;
+    zodIssues?: ZodIssue[];
+}> | undefined) => import("@jakubmazanec/error").CustomErrorWithData<"INVALID_ATTRIBUTES" | "FAILED_FORMAT" | "FAILED_RENDER" | "UNKNOWN_ERROR", {
+    template?: Template;
+    path?: string;
+    zodIssues?: ZodIssue[];
+}>;

package/dist/TemplateError.js

@@ -0,0 +1,11 @@
+import { createCustomErrorWithData } from '@jakubmazanec/error';
+/**
+ * A subclass of `Error` that indicates a template  failure.
+ */ export const TemplateError = createCustomErrorWithData('TemplateError', {
+    INVALID_ATTRIBUTES: 'Invalid template attributes.',
+    FAILED_FORMAT: 'Template render formatting has failed.',
+    FAILED_RENDER: 'Rendering has failed.'
+}, class TemplateErrorData {
+});
+
+//# sourceMappingURL=TemplateError.js.map

package/dist/TemplateError.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/TemplateError.ts"],"sourcesContent":["import {createCustomErrorWithData} from '@jakubmazanec/error';\nimport {type ZodIssue} from 'zod';\n\nimport {type Template} from './Template.js';\n\n/**\n * A subclass of `Error` that indicates a template  failure.\n */\nexport const TemplateError = createCustomErrorWithData(\n  'TemplateError',\n  {\n    INVALID_ATTRIBUTES: 'Invalid template attributes.',\n    FAILED_FORMAT: 'Template render formatting has failed.',\n    FAILED_RENDER: 'Rendering has failed.',\n  },\n  class TemplateErrorData {\n    template?: Template;\n    path?: string;\n    zodIssues?: ZodIssue[];\n  },\n);\n"],"names":["createCustomErrorWithData","TemplateError","INVALID_ATTRIBUTES","FAILED_FORMAT","FAILED_RENDER","TemplateErrorData"],"mappings":"AAAA,SAAQA,yBAAyB,QAAO,sBAAsB;AAK9D;;CAEC,GACD,OAAO,MAAMC,gBAAgBD,0BAC3B,iBACA;IACEE,oBAAoB;IACpBC,eAAe;IACfC,eAAe;AACjB,GACA,MAAMC;AAIN,GACA"}

package/dist/constants.d.ts

@@ -0,0 +1 @@
+export declare const NO_INFERRED_PARSER_REGEXP: RegExp;

package/dist/constants.js

@@ -0,0 +1,3 @@
+export const NO_INFERRED_PARSER_REGEXP = /parser.*inferred/i;
+
+//# sourceMappingURL=constants.js.map

package/dist/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/constants.ts"],"sourcesContent":["export const NO_INFERRED_PARSER_REGEXP = /parser.*inferred/i;\n"],"names":["NO_INFERRED_PARSER_REGEXP"],"mappings":"AAAA,OAAO,MAAMA,4BAA4B,oBAAoB"}

package/dist/main.d.ts

@@ -0,0 +1,3 @@
+export * from './Template.js';
+export * from './TemplateError.js';
+export * from './types.js';

package/dist/main.js

@@ -0,0 +1,5 @@
+export * from './Template.js';
+export * from './TemplateError.js';
+export * from './types.js';
+
+//# sourceMappingURL=main.js.map

package/dist/main.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/main.ts"],"sourcesContent":["export * from './Template.js';\nexport * from './TemplateError.js';\nexport * from './types.js';\n"],"names":[],"mappings":"AAAA,cAAc,gBAAgB;AAC9B,cAAc,qBAAqB;AACnC,cAAc,aAAa"}

package/dist/types/TemplateAttributes.d.ts

@@ -0,0 +1,21 @@
+import { z } from 'zod';
+/**
+ * Zod schema for {@linkcode TemplateAttributes}.
+ */
+export declare const templateAttributesSchema: z.ZodObject<{
+    to: z.ZodString;
+    if: z.ZodOptional<z.ZodString>;
+    variables: z.ZodOptional<z.ZodUnion<[z.ZodRecord<z.ZodString, z.ZodUnknown>, z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnknown>, "many">]>>;
+}, "strict", z.ZodTypeAny, {
+    to: string;
+    if?: string | undefined;
+    variables?: Record<string, unknown> | Record<string, unknown>[] | undefined;
+}, {
+    to: string;
+    if?: string | undefined;
+    variables?: Record<string, unknown> | Record<string, unknown>[] | undefined;
+}>;
+/**
+ * Type representing template attributes.
+ */
+export type TemplateAttributes = z.infer<typeof templateAttributesSchema>;

package/dist/types/TemplateAttributes.js

@@ -0,0 +1,11 @@
+import { z } from 'zod';
+import { templateVariablesSchema } from './TemplateVariables.js';
+/**
+ * Zod schema for {@linkcode TemplateAttributes}.
+ */ export const templateAttributesSchema = z.object({
+    to: z.string(),
+    if: z.string().optional(),
+    variables: templateVariablesSchema.optional()
+}).strict();
+
+//# sourceMappingURL=TemplateAttributes.js.map

package/dist/types/TemplateAttributes.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/types/TemplateAttributes.ts"],"sourcesContent":["import {z} from 'zod';\n\nimport {templateVariablesSchema} from './TemplateVariables.js';\n\n/**\n * Zod schema for {@linkcode TemplateAttributes}.\n */\nexport const templateAttributesSchema = z\n  .object({\n    to: z.string(),\n    if: z.string().optional(),\n    variables: templateVariablesSchema.optional(),\n  })\n  .strict();\n\n/**\n * Type representing template attributes.\n */\nexport type TemplateAttributes = z.infer<typeof templateAttributesSchema>;\n"],"names":["z","templateVariablesSchema","templateAttributesSchema","object","to","string","if","optional","variables","strict"],"mappings":"AAAA,SAAQA,CAAC,QAAO,MAAM;AAEtB,SAAQC,uBAAuB,QAAO,yBAAyB;AAE/D;;CAEC,GACD,OAAO,MAAMC,2BAA2BF,EACrCG,MAAM,CAAC;IACNC,IAAIJ,EAAEK,MAAM;IACZC,IAAIN,EAAEK,MAAM,GAAGE,QAAQ;IACvBC,WAAWP,wBAAwBM,QAAQ;AAC7C,GACCE,MAAM,GAAG"}

package/dist/types/TemplateContent.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Type representing a template content.
+ */
+export type TemplateContent = string;

package/dist/types/TemplateContent.js

@@ -0,0 +1,5 @@
+/**
+ * Type representing a template content.
+ */ export { };
+
+//# sourceMappingURL=TemplateContent.js.map

package/dist/types/TemplateContent.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/types/TemplateContent.ts"],"sourcesContent":["/**\n * Type representing a template content.\n */\nexport type TemplateContent = string;\n"],"names":[],"mappings":"AAAA;;CAEC,GACD,WAAqC"}

package/dist/types/TemplateFunction.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Type representing a template function that takes data and returns rendered string.
+ */
+export type TemplateFunction = (data?: Record<string, unknown>) => string;

package/dist/types/TemplateFunction.js

@@ -0,0 +1,5 @@
+/**
+ * Type representing a template function that takes data and returns rendered string.
+ */ export { };
+
+//# sourceMappingURL=TemplateFunction.js.map

package/dist/types/TemplateFunction.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/types/TemplateFunction.ts"],"sourcesContent":["/**\n * Type representing a template function that takes data and returns rendered string.\n */\nexport type TemplateFunction = (data?: Record<string, unknown>) => string;\n"],"names":[],"mappings":"AAAA;;CAEC,GACD,WAA0E"}

package/dist/types/TemplateRender.d.ts

@@ -0,0 +1,17 @@
+import { type z } from 'zod';
+import { type TemplateAttributes } from './TemplateAttributes.js';
+/**
+ * An object type representing the result of a template render.
+ *
+ * @typeParam A Type of Zod schema used to validate the custom template attributes.
+ * @typeParam D Type of Zod schema used to define the type of template data.
+ */
+export type TemplateRender<A extends z.AnyZodObject | undefined = undefined, D extends z.AnyZodObject | undefined = undefined> = {
+    /** Rendered template attributes. They created from the `to` and `variables` attributes, and from all of the custom template attributes.
+     */
+    attributes: A extends undefined ? Omit<TemplateAttributes, 'if'> : Omit<TemplateAttributes, 'if'> & z.infer<NonNullable<A>>;
+    /** Data used to render the template. */
+    data: D extends undefined ? null : z.infer<NonNullable<D>>;
+    /** Rendered template content. */
+    content: string;
+};

package/dist/types/TemplateRender.js

@@ -0,0 +1,3 @@
+export { };
+
+//# sourceMappingURL=TemplateRender.js.map

package/dist/types/TemplateRender.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/types/TemplateRender.ts"],"sourcesContent":["import {type z} from 'zod';\n\nimport {type TemplateAttributes} from './TemplateAttributes.js';\n\n/**\n * An object type representing the result of a template render.\n *\n * @typeParam A Type of Zod schema used to validate the custom template attributes.\n * @typeParam D Type of Zod schema used to define the type of template data.\n */\nexport type TemplateRender<\n  A extends z.AnyZodObject | undefined = undefined,\n  D extends z.AnyZodObject | undefined = undefined,\n> = {\n  /** Rendered template attributes. They created from the `to` and `variables` attributes, and from all of the custom template attributes.\n   */\n  attributes: A extends undefined\n    ? Omit<TemplateAttributes, 'if'>\n    : Omit<TemplateAttributes, 'if'> & z.infer<NonNullable<A>>;\n\n  /** Data used to render the template. */\n  data: D extends undefined ? null : z.infer<NonNullable<D>>;\n\n  /** Rendered template content. */\n  content: string;\n};\n"],"names":[],"mappings":"AAAA,WAyBE"}

package/dist/types/TemplateRenders.d.ts

@@ -0,0 +1,3 @@
+import { type z } from 'zod';
+import { type TemplateRender } from './TemplateRender.js';
+export type TemplateRenders<A extends z.AnyZodObject | undefined = undefined, D extends z.AnyZodObject | undefined = undefined> = Array<TemplateRender<A, D>>;

package/dist/types/TemplateRenders.js

@@ -0,0 +1,3 @@
+export { };
+
+//# sourceMappingURL=TemplateRenders.js.map

package/dist/types/TemplateRenders.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/types/TemplateRenders.ts"],"sourcesContent":["import {type z} from 'zod';\n\nimport {type TemplateRender} from './TemplateRender.js';\n\nexport type TemplateRenders<\n  A extends z.AnyZodObject | undefined = undefined,\n  D extends z.AnyZodObject | undefined = undefined,\n> = Array<TemplateRender<A, D>>;\n"],"names":[],"mappings":"AAAA,WAOgC"}

package/dist/types/TemplateVariables.d.ts

@@ -0,0 +1,9 @@
+import * as z from 'zod';
+/**
+ * Zod schema for {@linkcode TemplateAttributesVariables}.
+ */
+export declare const templateVariablesSchema: z.ZodUnion<[z.ZodRecord<z.ZodString, z.ZodUnknown>, z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnknown>, "many">]>;
+/**
+ * Type of `variables`` property of {@linkcode TemplateAttributes}.
+ */
+export type TemplateAttributesVariables = z.infer<typeof templateVariablesSchema>;

package/dist/types/TemplateVariables.js

@@ -0,0 +1,9 @@
+import * as z from 'zod';
+/**
+ * Zod schema for {@linkcode TemplateAttributesVariables}.
+ */ export const templateVariablesSchema = z.union([
+    z.record(z.unknown()),
+    z.array(z.record(z.unknown()))
+]);
+
+//# sourceMappingURL=TemplateVariables.js.map

package/dist/types/TemplateVariables.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/types/TemplateVariables.ts"],"sourcesContent":["import * as z from 'zod';\n\n/**\n * Zod schema for {@linkcode TemplateAttributesVariables}.\n */\nexport const templateVariablesSchema = z.union([\n  z.record(z.unknown()),\n  z.array(z.record(z.unknown())),\n]);\n\n/**\n * Type of `variables`` property of {@linkcode TemplateAttributes}.\n */\nexport type TemplateAttributesVariables = z.infer<typeof templateVariablesSchema>;\n"],"names":["z","templateVariablesSchema","union","record","unknown","array"],"mappings":"AAAA,YAAYA,OAAO,MAAM;AAEzB;;CAEC,GACD,OAAO,MAAMC,0BAA0BD,EAAEE,KAAK,CAAC;IAC7CF,EAAEG,MAAM,CAACH,EAAEI,OAAO;IAClBJ,EAAEK,KAAK,CAACL,EAAEG,MAAM,CAACH,EAAEI,OAAO;CAC3B,EAAE"}

package/dist/types.d.ts

@@ -0,0 +1,5 @@
+export * from './types/TemplateAttributes.js';
+export * from './types/TemplateVariables.js';
+export * from './types/TemplateFunction.js';
+export * from './types/TemplateRender.js';
+export * from './types/TemplateRenders.js';

package/dist/types.js

@@ -0,0 +1,7 @@
+export * from './types/TemplateAttributes.js';
+export * from './types/TemplateVariables.js';
+export * from './types/TemplateFunction.js';
+export * from './types/TemplateRender.js';
+export * from './types/TemplateRenders.js';
+
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/types.ts"],"sourcesContent":["export * from './types/TemplateAttributes.js';\nexport * from './types/TemplateVariables.js';\nexport * from './types/TemplateFunction.js';\nexport * from './types/TemplateRender.js';\nexport * from './types/TemplateRenders.js';\n"],"names":[],"mappings":"AAAA,cAAc,gCAAgC;AAC9C,cAAc,+BAA+B;AAC7C,cAAc,8BAA8B;AAC5C,cAAc,4BAA4B;AAC1C,cAAc,6BAA6B"}