@jakubmazanec/template 1.0.1-265acad → 1.0.1-2d1145f

package/dist/Template.d.ts

@@ -1,7 +1,10 @@
 import prettier from 'prettier';
 import { type z, type AnyZodObject } from 'zod';
-import { type TemplateAttributes, type TemplateRenders } from './types.js';
+import { type TemplateAttributes } from './TemplateAttributes.js';
+import { type TemplateRenders } from './TemplateRenders.js';
 export type TemplateOptions<A extends AnyZodObject | undefined = undefined, D extends AnyZodObject | undefined = undefined> = {
+    /** Template path. */
+    path?: string;
     /** Template content. */
     content: string;
     /** Template attributes.  */
@@ -52,6 +55,8 @@ export type TemplateRenderOptions = {
  * @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 path. */
+    path?: string;
     /** 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. */
@@ -62,22 +67,22 @@ export declare class Template<A extends AnyZodObject | undefined = undefined, D
     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>);
+    constructor({ path, content, attributes, attributesSchema, dataSchema }: TemplateOptions<A, D>);
     /**
      * Reads a template from a file.
      *
-     * @param templateFilePath Path to the template file.
+     * @param templatePath 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>>;
+    static read<A extends AnyZodObject | undefined = undefined, D extends AnyZodObject | undefined = undefined>(templatePath: 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 templatePath 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>>;
+    static readAndRender<A extends AnyZodObject | undefined = undefined, D extends AnyZodObject | undefined = undefined>(templatePath: string, data: D extends undefined ? null : z.infer<NonNullable<D>>, options?: TemplateReadAndRenderOptions<A, D>): Promise<TemplateRenders<A, D>>;
     /**
      * Renders the template using data.
      *

package/dist/Template.js

@@ -5,8 +5,8 @@ import omit from 'lodash.omit';
 import prettier from 'prettier';
 import yaml from 'yaml';
 import { NO_INFERRED_PARSER_REGEXP } from './constants.js';
+import { templateAttributesSchema } from './TemplateAttributes.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.
  *
@@ -25,12 +25,16 @@ import { templateAttributesSchema } from './types.js';
  * @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 {
+    /** Template path. */ path;
     /** Template content. Templates are written in [EJS](https://ejs.co/). */ content;
     /** 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. */ attributes;
     /** Template function. */ fn;
     /** Zod schema for custom template attributes. */ attributesSchema;
     /** Zod schema for template data. */ dataSchema;
-    constructor({ content, attributes, attributesSchema, dataSchema }){
+    constructor({ path, content, attributes, attributesSchema, dataSchema }){
+        if (path) {
+            this.path = path;
+        }
         this.content = content;
         this.attributes = attributes;
         this.fn = ejs.compile(this.content);
@@ -48,22 +52,23 @@ import { templateAttributesSchema } from './types.js';
     /**
    * Reads a template from a file.
    *
-   * @param templateFilePath Path to the template file.
-   */ static async read(templateFilePath, options) {
+   * @param templatePath Path to the template file.
+   */ static async read(templatePath, options) {
         var _options, _options1, _options2;
-        let { data: attributes, content } = matter(await fs.readFile(templateFilePath, 'utf8'));
+        let { data: attributes, content } = matter(await fs.readFile(templatePath, 'utf8'));
         let attributesSchema = ((_options = 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,
+                    path: templatePath,
                     zodIssues: attributesParseResult.error.issues
                 }
             });
         }
         return new this({
+            path: templatePath,
             attributes,
             content,
             attributesSchema: (_options1 = options) === null || _options1 === void 0 ? void 0 : _options1.attributesSchema,
@@ -73,13 +78,13 @@ import { templateAttributesSchema } from './types.js';
     /**
    * Reads a template from a file and then renders it.
    *
-   * @param templateFilePath Path to the template file.
+   * @param templatePath 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) {
+   */ static async readAndRender(templatePath, data, options) {
         var _options, _options1, _options2, _options3;
-        let template = await Template.read(templateFilePath, {
+        let template = await Template.read(templatePath, {
             attributesSchema: (_options = options) === null || _options === void 0 ? void 0 : _options.attributesSchema,
             dataSchema: (_options1 = options) === null || _options1 === void 0 ? void 0 : _options1.dataSchema
         });

package/dist/Template.js.map

@@ -1 +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","content","attributes","fn","attributesSchema","dataSchema","constructor","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;IAIX,uEAAuE,GACvE,AAASC,QAAgB;IAEzB,4uBAA4uB,GAC5uB,AAASC,WAEwC;IAEjD,uBAAuB,GACvB,AAAiBC,GAAqB;IAEtC,+CAA+C,GAC/C,AAASC,iBAAoD;IAE7D,kCAAkC,GAClC,AAASC,WAA8C;IAEvDC,YAAY,EAACL,OAAO,EAAEC,UAAU,EAAEE,gBAAgB,EAAEC,UAAU,EAAwB,CAAE;QACtF,IAAI,CAACJ,OAAO,GAAGA;QACf,IAAI,CAACC,UAAU,GAAGA;QAClB,IAAI,CAACC,EAAE,GAAGZ,IAAIgB,OAAO,CAAC,IAAI,CAACN,OAAO;QAElC,IAAIG,kBAAkB;YACpB,IAAI,CAACA,gBAAgB,GAAGA;QAC1B,OAAO;YACL,IAAI,CAACA,gBAAgB,GAAG;QAC1B;QAEA,IAAIC,YAAY;YACd,IAAI,CAACA,UAAU,GAAGA;QACpB,OAAO;YACL,IAAI,CAACA,UAAU,GAAG;QACpB;IACF;IAEA;;;;GAIC,GACD,aAAaG,KAGXC,gBAAwB,EAAEC,OAAmC,EAA2B;YAEjEA,UAkBHA,WACNA;QApBd,IAAI,EAACC,MAAMT,UAAU,EAAED,OAAO,EAAC,GAAGR,OAAO,MAAMD,GAAGoB,QAAQ,CAACH,kBAAkB;QAC7E,IAAIL,mBAAmBM,EAAAA,WAAAA,qBAAAA,+BAAAA,SAASN,gBAAgB,IAC5CL,yBAAyBc,KAAK,CAACH,QAAQN,gBAAgB,IACvDL;QACJ,IAAIe,wBAAwBV,iBAAiBW,SAAS,CAACb;QAEvD,IAAI,CAACY,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;QACF;QAEA,OAAO,IAAI,IAAI,CAAC;YACdnB;YACAD;YACAG,gBAAgB,GAAEM,YAAAA,qBAAAA,gCAAAA,UAASN,gBAAgB;YAC3CC,UAAU,GAAEK,YAAAA,qBAAAA,gCAAAA,UAASL,UAAU;QACjC;IACF;IAEA;;;;;;;GAOC,GACD,aAAaiB,cAIXb,gBAAwB,EACxBE,IAA0D,EAC1DD,OAA4C,EAC5C;YAEoBA,UACNA,WAIKA,WACAA;QAPnB,IAAIa,WAAW,MAAMvB,SAASQ,IAAI,CAAOC,kBAAkB;YACzDL,gBAAgB,GAAEM,WAAAA,qBAAAA,+BAAAA,SAASN,gBAAgB;YAC3CC,UAAU,GAAEK,YAAAA,qBAAAA,gCAAAA,UAASL,UAAU;QACjC;QAEA,OAAOkB,SAASC,MAAM,CAACb,MAAM;YAC3Bc,eAAe,GAAEf,YAAAA,qBAAAA,gCAAAA,UAASe,eAAe;YACzCC,eAAe,GAAEhB,YAAAA,qBAAAA,gCAAAA,UAASgB,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,CAAC5B,UAAU,CAAC0B,SAAS,IACzD,IAAI,CAAC1B,UAAU,CAAC0B,SAAS,GACzB;YAAC,IAAI,CAAC1B,UAAU,CAAC0B,SAAS;SAAC,CAAE;gBAsC1BlB;YArCL,IAAIqB,qBAAqBrC,KAAK,IAAI,CAACQ,UAAU,EAAE;gBAAC;aAAK;YACrD,IAAI8B,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;gBACF;gBAEAH,mBAAmBH,SAAS,GAAGI;YACjC;YAEA,IAAIK,qBAAqB;gBAAC,GAAG1B,IAAI;gBAAET,YAAY6B;YAAkB;YAEjE,IAAI,IAAI,CAAC7B,UAAU,CAACoC,EAAE,EAAE;gBACtB,IAAIC,aAAahD,IAAIiC,MAAM,CAAC,IAAI,CAACtB,UAAU,CAACoC,EAAE,EAAED;gBAChD,IAAIG,WAAW5C,KAAK6C,KAAK,CAACF;gBAE1B,IAAIC,aAAa,OAAO;oBACtB;gBACF;YACF;YAEAT,mBAAmBW,EAAE,GAAGnD,IAAIiC,MAAM,CAACO,mBAAmBW,EAAE,EAAEL;YAC1DA,mBAAmBnC,UAAU,GAAG6B;YAEhC,IAAI9B;YAEJ,IAAI;gBACFA,UAAU,IAAI,CAACE,EAAE,CAACkC;YACpB,EAAE,OAAOnB,OAAgB;gBACvB,MAAM,IAAIpB,cAAc,iBAAiB;oBAACmB,OAAOC;gBAAK;YACxD;YAEA,IAAI,GAACR,WAAAA,qBAAAA,+BAAAA,SAASgB,eAAe,GAAE;gBAC7B,IAAI;wBAEGhB;oBADLT,UAAUN,SAASgD,MAAM,CAAC1C,SAAS;4BAC9BS,YAAAA,qBAAAA,gCAAAA,UAASe,eAAe,AAA3B;wBACAmB,UAAUb,mBAAmBW,EAAE;oBACjC;gBACF,EAAE,OAAOxB,OAAgB;oBACvB,IAAI,CAACrB,0BAA0BgD,IAAI,CAAC,AAAC3B,MAAgB4B,OAAO,GAAG;wBAC7D,MAAM,IAAIhD,cAAc,iBAAiB;4BAACmB,OAAOC;wBAAK;oBACxD;gBACF;YACF;YAEAS,QAAQoB,IAAI,CAAC;gBACX7C,YAAY6B;gBACZpB,MAAMA,QAAQ;gBACdV;YACF;QACF;QAEA,OAAO0B;IACT;AACF"}
+{"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 {templateAttributesSchema, type TemplateAttributes} from './TemplateAttributes.js';\nimport {TemplateError} from './TemplateError.js';\nimport {type TemplateFunction} from './TemplateFunction.js';\nimport {type TemplateRender} from './TemplateRender.js';\nimport {type TemplateRenders} from './TemplateRenders.js';\n\nexport type TemplateOptions<\n  A extends AnyZodObject | undefined = undefined,\n  D extends AnyZodObject | undefined = undefined,\n> = {\n  /** Template path. */\n  path?: string;\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 path. */\n  path?: string;\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({path, content, attributes, attributesSchema, dataSchema}: TemplateOptions<A, D>) {\n    if (path) {\n      this.path = path;\n    }\n\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 templatePath Path to the template file.\n   */\n  static async read<\n    A extends AnyZodObject | undefined = undefined,\n    D extends AnyZodObject | undefined = undefined,\n  >(templatePath: string, options?: TemplateReadOptions<A, D>): Promise<Template<A, D>> {\n    let {data: attributes, content} = matter(await fs.readFile(templatePath, '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: templatePath,\n          zodIssues: attributesParseResult.error.issues,\n        },\n      });\n    }\n\n    return new this({\n      path: templatePath,\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 templatePath 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    templatePath: 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>(templatePath, {\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","templateAttributesSchema","TemplateError","Template","path","content","attributes","fn","attributesSchema","dataSchema","constructor","compile","read","templatePath","options","data","readFile","merge","attributesParseResult","safeParse","success","cause","error","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,wBAAwB,QAAgC,0BAA0B;AAC1F,SAAQC,aAAa,QAAO,qBAAqB;AA+DjD;;;;;;;;;;;;;;;;;CAiBC,GACD,OAAO,MAAMC;IAIX,mBAAmB,GACnBC,KAAc;IAEd,uEAAuE,GACvE,AAASC,QAAgB;IAEzB,4uBAA4uB,GAC5uB,AAASC,WAEwC;IAEjD,uBAAuB,GACvB,AAAiBC,GAAqB;IAEtC,+CAA+C,GAC/C,AAASC,iBAAoD;IAE7D,kCAAkC,GAClC,AAASC,WAA8C;IAEvDC,YAAY,EAACN,IAAI,EAAEC,OAAO,EAAEC,UAAU,EAAEE,gBAAgB,EAAEC,UAAU,EAAwB,CAAE;QAC5F,IAAIL,MAAM;YACR,IAAI,CAACA,IAAI,GAAGA;QACd;QAEA,IAAI,CAACC,OAAO,GAAGA;QACf,IAAI,CAACC,UAAU,GAAGA;QAClB,IAAI,CAACC,EAAE,GAAGb,IAAIiB,OAAO,CAAC,IAAI,CAACN,OAAO;QAElC,IAAIG,kBAAkB;YACpB,IAAI,CAACA,gBAAgB,GAAGA;QAC1B,OAAO;YACL,IAAI,CAACA,gBAAgB,GAAG;QAC1B;QAEA,IAAIC,YAAY;YACd,IAAI,CAACA,UAAU,GAAGA;QACpB,OAAO;YACL,IAAI,CAACA,UAAU,GAAG;QACpB;IACF;IAEA;;;;GAIC,GACD,aAAaG,KAGXC,YAAoB,EAAEC,OAAmC,EAA2B;YAE7DA,UAmBHA,WACNA;QArBd,IAAI,EAACC,MAAMT,UAAU,EAAED,OAAO,EAAC,GAAGT,OAAO,MAAMD,GAAGqB,QAAQ,CAACH,cAAc;QACzE,IAAIL,mBAAmBM,EAAAA,WAAAA,qBAAAA,+BAAAA,SAASN,gBAAgB,IAC5CP,yBAAyBgB,KAAK,CAACH,QAAQN,gBAAgB,IACvDP;QACJ,IAAIiB,wBAAwBV,iBAAiBW,SAAS,CAACb;QAEvD,IAAI,CAACY,sBAAsBE,OAAO,EAAE;YAClC,MAAM,IAAIlB,cAAc,sBAAsB;gBAC5CmB,OAAOH,sBAAsBI,KAAK;gBAClCP,MAAM;oBACJX,MAAMS;oBACNU,WAAWL,sBAAsBI,KAAK,CAACE,MAAM;gBAC/C;YACF;QACF;QAEA,OAAO,IAAI,IAAI,CAAC;YACdpB,MAAMS;YACNP;YACAD;YACAG,gBAAgB,GAAEM,YAAAA,qBAAAA,gCAAAA,UAASN,gBAAgB;YAC3CC,UAAU,GAAEK,YAAAA,qBAAAA,gCAAAA,UAASL,UAAU;QACjC;IACF;IAEA;;;;;;;GAOC,GACD,aAAagB,cAIXZ,YAAoB,EACpBE,IAA0D,EAC1DD,OAA4C,EAC5C;YAEoBA,UACNA,WAIKA,WACAA;QAPnB,IAAIY,WAAW,MAAMvB,SAASS,IAAI,CAAOC,cAAc;YACrDL,gBAAgB,GAAEM,WAAAA,qBAAAA,+BAAAA,SAASN,gBAAgB;YAC3CC,UAAU,GAAEK,YAAAA,qBAAAA,gCAAAA,UAASL,UAAU;QACjC;QAEA,OAAOiB,SAASC,MAAM,CAACZ,MAAM;YAC3Ba,eAAe,GAAEd,YAAAA,qBAAAA,gCAAAA,UAASc,eAAe;YACzCC,eAAe,GAAEf,YAAAA,qBAAAA,gCAAAA,UAASe,eAAe;QAC3C;IACF;IAEA;;;;;;GAMC,GACD,MAAMF,OACJZ,IAA0D,EAC1DD,OAA+B,EACC;QAChC,IAAIgB,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;gBAsC1BjB;YArCL,IAAIoB,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,GAAGtB,IAAI;wBAAA;oBACtE,OAAO;wBACLoB,iBAAiB,CAACC,aAAa,GAAGC;oBACpC;gBACF;gBAEAH,mBAAmBH,SAAS,GAAGI;YACjC;YAEA,IAAIK,qBAAqB;gBAAC,GAAGzB,IAAI;gBAAET,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,OAAO;oBACtB;gBACF;YACF;YAEAT,mBAAmBW,EAAE,GAAGnD,IAAIiC,MAAM,CAACO,mBAAmBW,EAAE,EAAEL;YAC1DA,mBAAmBlC,UAAU,GAAG4B;YAEhC,IAAI7B;YAEJ,IAAI;gBACFA,UAAU,IAAI,CAACE,EAAE,CAACiC;YACpB,EAAE,OAAOlB,OAAgB;gBACvB,MAAM,IAAIpB,cAAc,iBAAiB;oBAACmB,OAAOC;gBAAK;YACxD;YAEA,IAAI,GAACR,WAAAA,qBAAAA,+BAAAA,SAASe,eAAe,GAAE;gBAC7B,IAAI;wBAEGf;oBADLT,UAAUP,SAASgD,MAAM,CAACzC,SAAS;4BAC9BS,YAAAA,qBAAAA,gCAAAA,UAASc,eAAe,AAA3B;wBACAmB,UAAUb,mBAAmBW,EAAE;oBACjC;gBACF,EAAE,OAAOvB,OAAgB;oBACvB,IAAI,CAACtB,0BAA0BgD,IAAI,CAAC,AAAC1B,MAAgB2B,OAAO,GAAG;wBAC7D,MAAM,IAAI/C,cAAc,iBAAiB;4BAACmB,OAAOC;wBAAK;oBACxD;gBACF;YACF;YAEAQ,QAAQoB,IAAI,CAAC;gBACX5C,YAAY4B;gBACZnB,MAAMA,QAAQ;gBACdV;YACF;QACF;QAEA,OAAOyB;IACT;AACF"}

package/dist/{types/TemplateAttributes.d.ts → TemplateAttributes.d.ts}

@@ -1,6 +1,6 @@
 import { z } from 'zod';
 /**
- * Zod schema for {@linkcode TemplateAttributes}.
+ * Zod schema for {@link TemplateAttributes}.
  */
 export declare const templateAttributesSchema: z.ZodObject<{
     to: z.ZodString;

package/dist/{types/TemplateAttributes.js → TemplateAttributes.js}

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

package/dist/TemplateAttributes.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/TemplateAttributes.ts"],"sourcesContent":["import {z} from 'zod';\n\nimport {templateVariablesSchema} from './TemplateVariables.js';\n\n/**\n * Zod schema for {@link 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/TemplateContent.js.map

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

package/dist/TemplateFunction.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/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/TemplateRender.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/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/TemplateRenders.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/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 → TemplateVariables.d.ts}

@@ -1,9 +1,9 @@
 import * as z from 'zod';
 /**
- * Zod schema for {@linkcode TemplateAttributesVariables}.
+ * Zod schema for {@link 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}.
+ * Type of `variables`` property of {@link TemplateAttributes}.
  */
 export type TemplateAttributesVariables = z.infer<typeof templateVariablesSchema>;

package/dist/{types/TemplateVariables.js → TemplateVariables.js}

@@ -1,6 +1,6 @@
 import * as z from 'zod';
 /**
- * Zod schema for {@linkcode TemplateAttributesVariables}.
+ * Zod schema for {@link TemplateAttributesVariables}.
  */ export const templateVariablesSchema = z.union([
     z.record(z.unknown()),
     z.array(z.record(z.unknown()))

package/dist/TemplateVariables.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/TemplateVariables.ts"],"sourcesContent":["import * as z from 'zod';\n\n/**\n * Zod schema for {@link 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 {@link 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/main.d.ts

@@ -1,3 +1,8 @@
 export * from './Template.js';
+export * from './TemplateAttributes.js';
+export * from './TemplateContent.js';
 export * from './TemplateError.js';
-export * from './types.js';
+export * from './TemplateFunction.js';
+export * from './TemplateRender.js';
+export * from './TemplateRenders.js';
+export * from './TemplateVariables.js';

package/dist/main.js

@@ -1,5 +1,10 @@
 export * from './Template.js';
+export * from './TemplateAttributes.js';
+export * from './TemplateContent.js';
 export * from './TemplateError.js';
-export * from './types.js';
+export * from './TemplateFunction.js';
+export * from './TemplateRender.js';
+export * from './TemplateRenders.js';
+export * from './TemplateVariables.js';
 
 //# sourceMappingURL=main.js.map

package/dist/main.js.map

@@ -1 +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"}
+{"version":3,"sources":["../src/main.ts"],"sourcesContent":["export * from './Template.js';\nexport * from './TemplateAttributes.js';\nexport * from './TemplateContent.js';\nexport * from './TemplateError.js';\nexport * from './TemplateFunction.js';\nexport * from './TemplateRender.js';\nexport * from './TemplateRenders.js';\nexport * from './TemplateVariables.js';\n"],"names":[],"mappings":"AAAA,cAAc,gBAAgB;AAC9B,cAAc,0BAA0B;AACxC,cAAc,uBAAuB;AACrC,cAAc,qBAAqB;AACnC,cAAc,wBAAwB;AACtC,cAAc,sBAAsB;AACpC,cAAc,uBAAuB;AACrC,cAAc,yBAAyB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jakubmazanec/template",
-  "version": "1.0.1-265acad",
+  "version": "1.0.1-2d1145f",
   "description": "TypeScript-first library for working with templates using EJS and Zod.",
   "repository": {
     "type": "git",
@@ -26,7 +26,7 @@
     "typecheck": "tsc --project tsconfig.typecheck.json"
   },
   "dependencies": {
-    "@jakubmazanec/error": "2.0.1-265acad",
+    "@jakubmazanec/error": "2.0.1-2d1145f",
     "ejs": "^3.1.9",
     "fs-extra": "^11.1.1",
     "gray-matter": "^4.0.3",

package/src/Template.ts

@@ -7,19 +7,19 @@ import yaml from 'yaml';
 import {type z, type AnyZodObject} from 'zod';
 
 import {NO_INFERRED_PARSER_REGEXP} from './constants.js';
+import {templateAttributesSchema, type TemplateAttributes} from './TemplateAttributes.js';
 import {TemplateError} from './TemplateError.js';
-import {
-  templateAttributesSchema,
-  type TemplateAttributes,
-  type TemplateFunction,
-  type TemplateRender,
-  type TemplateRenders,
-} from './types.js';
+import {type TemplateFunction} from './TemplateFunction.js';
+import {type TemplateRender} from './TemplateRender.js';
+import {type TemplateRenders} from './TemplateRenders.js';
 
 export type TemplateOptions<
   A extends AnyZodObject | undefined = undefined,
   D extends AnyZodObject | undefined = undefined,
 > = {
+  /** Template path. */
+  path?: string;
+
   /** Template content. */
   content: string;
 
@@ -93,6 +93,9 @@ export class Template<
   A extends AnyZodObject | undefined = undefined,
   D extends AnyZodObject | undefined = undefined,
 > {
+  /** Template path. */
+  path?: string;
+
   /** Template content. Templates are written in [EJS](https://ejs.co/). */
   readonly content: string;
 
@@ -110,7 +113,11 @@ export class Template<
   /** Zod schema for template data. */
   readonly dataSchema: D extends AnyZodObject ? D : null;
 
-  constructor({content, attributes, attributesSchema, dataSchema}: TemplateOptions<A, D>) {
+  constructor({path, content, attributes, attributesSchema, dataSchema}: TemplateOptions<A, D>) {
+    if (path) {
+      this.path = path;
+    }
+
     this.content = content;
     this.attributes = attributes;
     this.fn = ejs.compile(this.content);
@@ -131,13 +138,13 @@ export class Template<
   /**
    * Reads a template from a file.
    *
-   * @param templateFilePath Path to the template file.
+   * @param templatePath Path to the template file.
    */
   static async read<
     A extends AnyZodObject | undefined = undefined,
     D extends AnyZodObject | undefined = undefined,
-  >(templateFilePath: string, options?: TemplateReadOptions<A, D>): Promise<Template<A, D>> {
-    let {data: attributes, content} = matter(await fs.readFile(templateFilePath, 'utf8'));
+  >(templatePath: string, options?: TemplateReadOptions<A, D>): Promise<Template<A, D>> {
+    let {data: attributes, content} = matter(await fs.readFile(templatePath, 'utf8'));
     let attributesSchema = options?.attributesSchema
       ? templateAttributesSchema.merge(options.attributesSchema)
       : templateAttributesSchema;
@@ -147,13 +154,14 @@ export class Template<
       throw new TemplateError('INVALID_ATTRIBUTES', {
         cause: attributesParseResult.error,
         data: {
-          path: templateFilePath,
+          path: templatePath,
           zodIssues: attributesParseResult.error.issues,
         },
       });
     }
 
     return new this({
+      path: templatePath,
       attributes,
       content,
       attributesSchema: options?.attributesSchema,
@@ -164,7 +172,7 @@ export class Template<
   /**
    * Reads a template from a file and then renders it.
    *
-   * @param templateFilePath Path to the template file.
+   * @param templatePath Path to the template file.
    * @param data Data used for rendering the template.
    * @param options Options object.
    * @return Template renders.
@@ -173,11 +181,11 @@ export class Template<
     A extends AnyZodObject | undefined = undefined,
     D extends AnyZodObject | undefined = undefined,
   >(
-    templateFilePath: string,
+    templatePath: string,
     data: D extends undefined ? null : z.infer<NonNullable<D>>,
     options?: TemplateReadAndRenderOptions<A, D>,
   ) {
-    let template = await Template.read<A, D>(templateFilePath, {
+    let template = await Template.read<A, D>(templatePath, {
       attributesSchema: options?.attributesSchema,
       dataSchema: options?.dataSchema,
     });

package/src/{types/TemplateAttributes.ts → TemplateAttributes.ts}

@@ -3,7 +3,7 @@ import {z} from 'zod';
 import {templateVariablesSchema} from './TemplateVariables.js';
 
 /**
- * Zod schema for {@linkcode TemplateAttributes}.
+ * Zod schema for {@link TemplateAttributes}.
  */
 export const templateAttributesSchema = z
   .object({

package/src/{types/TemplateVariables.ts → TemplateVariables.ts}

@@ -1,7 +1,7 @@
 import * as z from 'zod';
 
 /**
- * Zod schema for {@linkcode TemplateAttributesVariables}.
+ * Zod schema for {@link TemplateAttributesVariables}.
  */
 export const templateVariablesSchema = z.union([
   z.record(z.unknown()),
@@ -9,6 +9,6 @@ export const templateVariablesSchema = z.union([
 ]);
 
 /**
- * Type of `variables`` property of {@linkcode TemplateAttributes}.
+ * Type of `variables`` property of {@link TemplateAttributes}.
  */
 export type TemplateAttributesVariables = z.infer<typeof templateVariablesSchema>;

package/src/main.ts

@@ -1,3 +1,8 @@
 export * from './Template.js';
+export * from './TemplateAttributes.js';
+export * from './TemplateContent.js';
 export * from './TemplateError.js';
-export * from './types.js';
+export * from './TemplateFunction.js';
+export * from './TemplateRender.js';
+export * from './TemplateRenders.js';
+export * from './TemplateVariables.js';

package/dist/types/TemplateAttributes.js.map

@@ -1 +0,0 @@
-{"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.js.map

@@ -1 +0,0 @@
-{"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.js.map

@@ -1 +0,0 @@
-{"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.js.map

@@ -1 +0,0 @@
-{"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.js.map

@@ -1 +0,0 @@
-{"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.js.map

@@ -1 +0,0 @@
-{"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

@@ -1,5 +0,0 @@
-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

@@ -1,7 +0,0 @@
-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

@@ -1 +0,0 @@
-{"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"}

package/src/types.ts

@@ -1,5 +0,0 @@
-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';