@funcstache/stache-stream 0.2.2

package/src/lib/tokenize/Tokenize.js

@@ -0,0 +1,268 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "Tokenize", {
+    enumerable: true,
+    get: function() {
+        return Tokenize;
+    }
+});
+const _nodeevents = require("node:events");
+const _logger = require("@funcstache/logger");
+const _Tag = require("../tag/Tag");
+let Tokenize = class Tokenize extends _nodeevents.EventEmitter {
+    #TOKEN_ENTER_CHAR;
+    #TOKEN_EXIT_CHAR;
+    #logger;
+    #stateCurrent;
+    #statePrevious;
+    #leftBuffer;
+    #leftTokenBuffer;
+    #middleBuffer;
+    #rightTokenBuffer;
+    #emitTagToken() {
+        if (this.#leftTokenBuffer.length === this.#rightTokenBuffer.length) {
+            const data = _Tag.Tag.parse(`${this.#leftTokenBuffer}${this.#middleBuffer}${this.#rightTokenBuffer}`);
+            data && this.#emitToken({
+                data,
+                uid: performance.now(),
+                type: "tag"
+            });
+        }
+        this.#leftBuffer = "";
+        this.#leftTokenBuffer = "";
+        this.#middleBuffer = "";
+        this.#rightTokenBuffer = "";
+    }
+    #emitToken(event) {
+        this.#logger.debug(()=>[
+                `!!! #emitEvent: event=`,
+                JSON.stringify(event)
+            ]);
+        this.emit("token", event);
+    }
+    async push(char) {
+        this.#logger.debug(()=>"-".repeat(80));
+        char && this.#updateStatus(char);
+        await this.#processChar(char);
+    }
+    async #processChar(char) {
+        this.#logger.debug(()=>`=== #processChar: current=${this.#stateCurrent}, previous=${this.#statePrevious}`);
+        if (char === null) {
+            if (this.#leftBuffer) {
+                this.#emitToken({
+                    data: this.#leftBuffer,
+                    type: "text",
+                    uid: performance.now()
+                });
+            }
+            this.#emitTagToken();
+            this.#emitToken(null);
+            return;
+        }
+        // The only state changes that should happen here are resets that need to be done after `char`
+        // is processed.
+        switch(this.#stateCurrent){
+            case "tagEnteringMaybe":
+                {
+                    // This state change happens in the case of nested tags, for example: `{{#a}}{{m}}{{/a}}`
+                    // It's why we can't set `#leftTokenBuffer` in the `#updateStatus` method.
+                    if (this.#statePrevious === "tagExitingMaybe") {
+                        this.#emitTagToken();
+                    }
+                    this.#leftTokenBuffer += char;
+                    break;
+                }
+            // case "tagExitingMaybe": {
+            //   break;
+            // }
+            case "inTagValue":
+                {
+                    if (this.#leftBuffer) {
+                        this.#emitToken({
+                            data: this.#leftBuffer,
+                            type: "text",
+                            uid: performance.now()
+                        });
+                        this.#leftBuffer = "";
+                    }
+                    break;
+                }
+            case "outsideTag":
+                {
+                    if (this.#statePrevious === "tagEnteringMaybe") {
+                        // Single `{` that was not the start of a mustache tag — treat as plain text.
+                        // #updateStatus already appended the current char to leftBuffer, so insert
+                        // leftTokenBuffer before that last char to preserve the correct order.
+                        this.#leftBuffer = this.#leftBuffer.slice(0, -1) + this.#leftTokenBuffer + this.#leftBuffer.slice(-1);
+                        this.#leftTokenBuffer = "";
+                    } else if (this.#leftTokenBuffer && this.#rightTokenBuffer) {
+                        const data = _Tag.Tag.parse(`${this.#leftTokenBuffer}${this.#middleBuffer}${this.#rightTokenBuffer}`);
+                        data && this.#emitToken({
+                            data,
+                            type: "tag",
+                            uid: performance.now()
+                        });
+                        this.#leftTokenBuffer = "";
+                        this.#middleBuffer = "";
+                        this.#rightTokenBuffer = "";
+                    }
+                    break;
+                }
+        }
+        this.#logger.debug(()=>`--- #processChar: '${char}' - ${this.#leftBuffer},${this.#leftTokenBuffer ? ` _${this.#leftTokenBuffer}_` : " "}, ${this.#middleBuffer}, ${this.#rightTokenBuffer ? `_${this.#rightTokenBuffer}_` : ""}`);
+    }
+    #updateStateFromModel(current, options, instantStateCallback) {
+        const currentStateData = stateModel[current];
+        let nextState = current;
+        for (const stateName of Object.keys(currentStateData)){
+            const dataArr = currentStateData[stateName];
+            if (!dataArr) {
+                continue;
+            }
+            if (dataArr.some((data)=>{
+                const allFalse = "isFalse" in data ? data.isFalse.every((optionName)=>options[optionName] === false) : true;
+                if (!allFalse) {
+                    return false;
+                }
+                const allTrue = "isTrue" in data ? data.isTrue.every((optionName)=>options[optionName] === true) : true;
+                if (allTrue) {
+                    nextState = stateName;
+                    // If the next state is "instant" invoke the callback then invoke
+                    // `#updateStateFromModel` function again recursively.
+                    if ("instant" in data && data.instant) {
+                        instantStateCallback && instantStateCallback(nextState);
+                        nextState = this.#updateStateFromModel(nextState, options);
+                    }
+                    return true;
+                }
+                return false;
+            })) {
+                break;
+            }
+        }
+        return nextState;
+    }
+    #updateStatus(char) {
+        this.#logger.debug(()=>`--- #updateStatus: '${char}' - ${this.#leftBuffer},${this.#leftTokenBuffer ? ` _${this.#leftTokenBuffer}_` : " "}, ${this.#middleBuffer}, ${this.#rightTokenBuffer ? `_${this.#rightTokenBuffer}_` : ""}`);
+        this.#statePrevious = this.#stateCurrent;
+        // This code sets the state for how `char` should be processed.
+        const isEnterToken = char === this.#TOKEN_ENTER_CHAR;
+        const isExitToken = char === this.#TOKEN_EXIT_CHAR;
+        const options = {
+            currentCharEnterToken: isEnterToken,
+            currentCharExitToken: isExitToken,
+            currentCharNotToken: !isEnterToken && !isExitToken,
+            enterTokenCountEqualsOne: 1 === this.#leftTokenBuffer.length,
+            enterTokenCountEqualsTwo: 2 === this.#leftTokenBuffer.length,
+            enterTokenCountEqualsThree: 3 === this.#leftTokenBuffer.length,
+            exitTokenCountEqualsEnterTokenCount: this.#leftTokenBuffer.length === this.#rightTokenBuffer.length
+        };
+        this.#stateCurrent = this.#updateStateFromModel(this.#stateCurrent, options, (state)=>{
+            this.#logger.debug(()=>`>>> #updateStatus: instant;\n  #statePrevious='${this.#statePrevious}',\n  state='${state}'`);
+        });
+        // Manage most of the state changes here. a small number of them have to be done in
+        // `#processChar` because certain state values have to be reset after the char is processed.
+        switch(this.#stateCurrent){
+            case "tagEnteringMaybe":
+                {
+                    break;
+                }
+            case "tagExitingMaybe":
+                {
+                    this.#rightTokenBuffer += char;
+                    break;
+                }
+            case "outsideTag":
+                {
+                    this.#leftBuffer += char;
+                    break;
+                }
+            case "inTagValue":
+                {
+                    this.#middleBuffer += char;
+                    break;
+                }
+        }
+    }
+    constructor(...args){
+        super(...args);
+        this.#TOKEN_ENTER_CHAR = "{";
+        this.#TOKEN_EXIT_CHAR = "}";
+        this.#logger = new _logger.Log({
+            category: "TKZ",
+            level: process.env.LOG_LEVEL || "warn"
+        });
+        this.#stateCurrent = "outsideTag";
+        this.#leftBuffer = "";
+        this.#leftTokenBuffer = "";
+        this.#middleBuffer = "";
+        this.#rightTokenBuffer = "";
+    }
+};
+const stateModel = {
+    inTagValue: {
+        tagExitingMaybe: [
+            {
+                isTrue: [
+                    "currentCharExitToken"
+                ]
+            }
+        ]
+    },
+    outsideTag: {
+        tagEnteringMaybe: [
+            {
+                isTrue: [
+                    "currentCharEnterToken"
+                ]
+            }
+        ]
+    },
+    tagExitingMaybe: {
+        tagEnteringMaybe: [
+            {
+                isTrue: [
+                    "currentCharEnterToken",
+                    "exitTokenCountEqualsEnterTokenCount"
+                ]
+            }
+        ],
+        outsideTag: [
+            {
+                isTrue: [
+                    "currentCharNotToken",
+                    "exitTokenCountEqualsEnterTokenCount"
+                ]
+            }
+        ]
+    },
+    tagEnteringMaybe: {
+        outsideTag: [
+            {
+                isFalse: [
+                    "currentCharEnterToken"
+                ],
+                isTrue: [
+                    "enterTokenCountEqualsOne"
+                ]
+            }
+        ],
+        inTagValue: [
+            {
+                isTrue: [
+                    "currentCharNotToken",
+                    "enterTokenCountEqualsTwo"
+                ]
+            },
+            {
+                isTrue: [
+                    "enterTokenCountEqualsThree"
+                ]
+            }
+        ]
+    }
+};
+
+//# sourceMappingURL=Tokenize.js.map

package/src/lib/tokenize/Tokenize.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../../../libs/stache-stream/src/lib/tokenize/Tokenize.ts"],"sourcesContent":["import { EventEmitter } from \"node:events\";\nimport { Log } from \"@funcstache/logger\";\nimport { Tag } from \"../tag/Tag\";\n\nexport class Tokenize extends EventEmitter<TokenizeEventMap> {\n  readonly #TOKEN_ENTER_CHAR = \"{\";\n  readonly #TOKEN_EXIT_CHAR = \"}\";\n\n  #logger = new Log({\n    category: \"TKZ\",\n    level: (process.env as any).LOG_LEVEL || \"warn\",\n  });\n\n  #stateCurrent: StateNames = \"outsideTag\";\n  #statePrevious: StateNames | undefined;\n  #leftBuffer = \"\";\n  #leftTokenBuffer = \"\";\n  #middleBuffer = \"\";\n  #rightTokenBuffer = \"\";\n\n  #emitTagToken() {\n    if (this.#leftTokenBuffer.length === this.#rightTokenBuffer.length) {\n      const data = Tag.parse(\n        `${this.#leftTokenBuffer}${this.#middleBuffer}${this.#rightTokenBuffer}`\n      );\n\n      data &&\n        this.#emitToken({\n          data,\n          uid: performance.now(),\n          type: \"tag\",\n        });\n    }\n\n    this.#leftBuffer = \"\";\n    this.#leftTokenBuffer = \"\";\n    this.#middleBuffer = \"\";\n    this.#rightTokenBuffer = \"\";\n  }\n\n  #emitToken(event: TokenizeTagEvent | TokenizeTextEvent | null) {\n    this.#logger.debug(() => [`!!! #emitEvent: event=`, JSON.stringify(event)]);\n    this.emit(\"token\", event);\n  }\n\n  async push(char: string | null): Promise<void> {\n    this.#logger.debug(() => \"-\".repeat(80));\n\n    char && this.#updateStatus(char);\n    await this.#processChar(char);\n  }\n\n  async #processChar(char: string | null): Promise<void> {\n    this.#logger.debug(\n      () =>\n        `=== #processChar: current=${this.#stateCurrent}, previous=${\n          this.#statePrevious\n        }`\n    );\n\n    if (char === null) {\n      if (this.#leftBuffer) {\n        this.#emitToken({\n          data: this.#leftBuffer,\n          type: \"text\",\n          uid: performance.now(),\n        });\n      }\n      this.#emitTagToken();\n      this.#emitToken(null);\n      return;\n    }\n\n    // The only state changes that should happen here are resets that need to be done after `char`\n    // is processed.\n    switch (this.#stateCurrent) {\n      case \"tagEnteringMaybe\": {\n        // This state change happens in the case of nested tags, for example: `{{#a}}{{m}}{{/a}}`\n        // It's why we can't set `#leftTokenBuffer` in the `#updateStatus` method.\n        if (this.#statePrevious === \"tagExitingMaybe\") {\n          this.#emitTagToken();\n        }\n\n        this.#leftTokenBuffer += char;\n\n        break;\n      }\n\n      // case \"tagExitingMaybe\": {\n      //   break;\n      // }\n\n      case \"inTagValue\": {\n        if (this.#leftBuffer) {\n          this.#emitToken({\n            data: this.#leftBuffer,\n            type: \"text\",\n            uid: performance.now(),\n          });\n          this.#leftBuffer = \"\";\n        }\n        break;\n      }\n\n      case \"outsideTag\": {\n        if (this.#statePrevious === \"tagEnteringMaybe\") {\n          // Single `{` that was not the start of a mustache tag — treat as plain text.\n          // #updateStatus already appended the current char to leftBuffer, so insert\n          // leftTokenBuffer before that last char to preserve the correct order.\n          this.#leftBuffer =\n            this.#leftBuffer.slice(0, -1) +\n            this.#leftTokenBuffer +\n            this.#leftBuffer.slice(-1);\n          this.#leftTokenBuffer = \"\";\n        } else if (this.#leftTokenBuffer && this.#rightTokenBuffer) {\n          const data = Tag.parse(\n            `${this.#leftTokenBuffer}${this.#middleBuffer}${\n              this.#rightTokenBuffer\n            }`\n          );\n\n          data &&\n            this.#emitToken({\n              data,\n              type: \"tag\",\n              uid: performance.now(),\n            });\n\n          this.#leftTokenBuffer = \"\";\n          this.#middleBuffer = \"\";\n          this.#rightTokenBuffer = \"\";\n        }\n        break;\n      }\n    }\n\n    this.#logger.debug(\n      () =>\n        `--- #processChar: '${char}' - ${this.#leftBuffer},${\n          this.#leftTokenBuffer ? ` _${this.#leftTokenBuffer}_` : \" \"\n        }, ${this.#middleBuffer}, ${\n          this.#rightTokenBuffer ? `_${this.#rightTokenBuffer}_` : \"\"\n        }`\n    );\n  }\n\n  #updateStateFromModel(\n    current: StateNames,\n    options: UpdateStateModelOptions,\n    instantStateCallback?: (state: StateNames) => void\n  ): StateNames {\n    const currentStateData = stateModel[current];\n    let nextState: StateNames = current;\n    for (const stateName of Object.keys(currentStateData) as StateNames[]) {\n      const dataArr = currentStateData[stateName];\n      if (!dataArr) {\n        continue;\n      }\n\n      if (\n        dataArr.some((data) => {\n          const allFalse =\n            \"isFalse\" in data\n              ? data.isFalse.every(\n                  (optionName) => options[optionName] === false\n                )\n              : true;\n\n          if (!allFalse) {\n            return false;\n          }\n\n          const allTrue =\n            \"isTrue\" in data\n              ? data.isTrue.every((optionName) => options[optionName] === true)\n              : true;\n\n          if (allTrue) {\n            nextState = stateName;\n\n            // If the next state is \"instant\" invoke the callback then invoke\n            // `#updateStateFromModel` function again recursively.\n            if (\"instant\" in data && data.instant) {\n              instantStateCallback && instantStateCallback(nextState);\n              nextState = this.#updateStateFromModel(nextState, options);\n            }\n\n            return true;\n          }\n\n          return false;\n        })\n      ) {\n        break;\n      }\n    }\n\n    return nextState;\n  }\n\n  #updateStatus(char: string): void {\n    this.#logger.debug(\n      () =>\n        `--- #updateStatus: '${char}' - ${this.#leftBuffer},${\n          this.#leftTokenBuffer ? ` _${this.#leftTokenBuffer}_` : \" \"\n        }, ${this.#middleBuffer}, ${\n          this.#rightTokenBuffer ? `_${this.#rightTokenBuffer}_` : \"\"\n        }`\n    );\n\n    this.#statePrevious = this.#stateCurrent;\n\n    // This code sets the state for how `char` should be processed.\n    const isEnterToken = char === this.#TOKEN_ENTER_CHAR;\n    const isExitToken = char === this.#TOKEN_EXIT_CHAR;\n\n    const options: UpdateStateModelOptions = {\n      currentCharEnterToken: isEnterToken,\n      currentCharExitToken: isExitToken,\n      currentCharNotToken: !isEnterToken && !isExitToken,\n      enterTokenCountEqualsOne: 1 === this.#leftTokenBuffer.length,\n      enterTokenCountEqualsTwo: 2 === this.#leftTokenBuffer.length,\n      enterTokenCountEqualsThree: 3 === this.#leftTokenBuffer.length,\n      exitTokenCountEqualsEnterTokenCount:\n        this.#leftTokenBuffer.length === this.#rightTokenBuffer.length,\n    };\n\n    this.#stateCurrent = this.#updateStateFromModel(\n      this.#stateCurrent,\n      options,\n      (state) => {\n        this.#logger.debug(\n          () =>\n            `>>> #updateStatus: instant;\\n  #statePrevious='${\n              this.#statePrevious\n            }',\\n  state='${state}'`\n        );\n      }\n    );\n\n    // Manage most of the state changes here. a small number of them have to be done in\n    // `#processChar` because certain state values have to be reset after the char is processed.\n    switch (this.#stateCurrent) {\n      case \"tagEnteringMaybe\": {\n        //Changing to \"tagEnteringMaybe\" could happen because of nested tags, for example:\n        // `{{#a}}{{m}}{{/a}}`. It's why we can't set `#leftTokenBuffer` here, it has to be done as\n        // part of #processChar.\n\n        // this.#leftTokenBuffer += char;\n        break;\n      }\n\n      case \"tagExitingMaybe\": {\n        this.#rightTokenBuffer += char;\n        break;\n      }\n\n      case \"outsideTag\": {\n        this.#leftBuffer += char;\n        break;\n      }\n\n      case \"inTagValue\": {\n        this.#middleBuffer += char;\n        break;\n      }\n    }\n  }\n}\n\ninterface TokenizeEvent {\n  uid: number;\n}\n\nexport interface TokenizeTagEvent extends TokenizeEvent {\n  data: Tag;\n  type: \"tag\";\n}\n\nexport interface TokenizeTextEvent extends TokenizeEvent {\n  data: string;\n  type: \"text\";\n}\n\nexport type TokenizeEventMap = {\n  token: [TokenizeTagEvent | TokenizeTextEvent | null];\n};\n\nexport type StateNames =\n  | \"inTagValue\"\n  | \"outsideTag\"\n  | \"tagExitingMaybe\"\n  | \"tagEnteringMaybe\";\n\nconst stateModel: StateModel = {\n  inTagValue: {\n    tagExitingMaybe: [\n      {\n        isTrue: [\"currentCharExitToken\"],\n      },\n    ],\n  },\n\n  outsideTag: {\n    tagEnteringMaybe: [\n      {\n        isTrue: [\"currentCharEnterToken\"],\n      },\n    ],\n  },\n\n  tagExitingMaybe: {\n    tagEnteringMaybe: [\n      {\n        isTrue: [\n          \"currentCharEnterToken\",\n          \"exitTokenCountEqualsEnterTokenCount\",\n        ],\n      },\n    ],\n    outsideTag: [\n      {\n        isTrue: [\"currentCharNotToken\", \"exitTokenCountEqualsEnterTokenCount\"],\n      },\n    ],\n  },\n\n  tagEnteringMaybe: {\n    outsideTag: [\n      {\n        isFalse: [\"currentCharEnterToken\"],\n        isTrue: [\"enterTokenCountEqualsOne\"],\n      },\n    ],\n    inTagValue: [\n      {\n        isTrue: [\"currentCharNotToken\", \"enterTokenCountEqualsTwo\"],\n      },\n      {\n        isTrue: [\"enterTokenCountEqualsThree\"],\n      },\n    ],\n  },\n} as const;\n\ntype StateModel = {\n  [currentState in StateNames]: {\n    [moveToStateWhen in StateNames]?: (\n      | {\n          instant?: boolean;\n          isFalse: (keyof UpdateStateModelOptions)[];\n          isTrue: (keyof UpdateStateModelOptions)[];\n        }\n      | {\n          instant?: boolean;\n          isFalse: (keyof UpdateStateModelOptions)[];\n        }\n      | {\n          instant?: boolean;\n          isTrue: (keyof UpdateStateModelOptions)[];\n        }\n    )[];\n  };\n};\n\ninterface UpdateStateModelOptions {\n  currentCharEnterToken: boolean;\n  currentCharExitToken: boolean;\n  currentCharNotToken: boolean;\n  enterTokenCountEqualsOne: boolean;\n  enterTokenCountEqualsTwo: boolean;\n  enterTokenCountEqualsThree: boolean;\n  exitTokenCountEqualsEnterTokenCount: boolean;\n}\n"],"names":["Tokenize","EventEmitter","TOKEN_ENTER_CHAR","TOKEN_EXIT_CHAR","logger","stateCurrent","statePrevious","leftBuffer","leftTokenBuffer","middleBuffer","rightTokenBuffer","emitTagToken","length","data","Tag","parse","emitToken","uid","performance","now","type","event","debug","JSON","stringify","emit","push","char","repeat","updateStatus","processChar","slice","updateStateFromModel","current","options","instantStateCallback","currentStateData","stateModel","nextState","stateName","Object","keys","dataArr","some","allFalse","isFalse","every","optionName","allTrue","isTrue","instant","isEnterToken","isExitToken","currentCharEnterToken","currentCharExitToken","currentCharNotToken","enterTokenCountEqualsOne","enterTokenCountEqualsTwo","enterTokenCountEqualsThree","exitTokenCountEqualsEnterTokenCount","state","Log","category","level","process","env","LOG_LEVEL","inTagValue","tagExitingMaybe","outsideTag","tagEnteringMaybe"],"rangeMappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;","mappings":";;;;+BAIaA;;;eAAAA;;;4BAJgB;wBACT;qBACA;AAEb,IAAA,AAAMA,WAAN,MAAMA,iBAAiBC,wBAAY;IAC/B,CAACC,gBAAgB,CAAO;IACxB,CAACC,eAAe,CAAO;IAEhC,CAACC,MAAM,CAGJ;IAEH,CAACC,YAAY,CAA4B;IACzC,CAACC,aAAa,CAAyB;IACvC,CAACC,UAAU,CAAM;IACjB,CAACC,eAAe,CAAM;IACtB,CAACC,YAAY,CAAM;IACnB,CAACC,gBAAgB,CAAM;IAEvB,CAACC,YAAY;QACX,IAAI,IAAI,CAAC,CAACH,eAAe,CAACI,MAAM,KAAK,IAAI,CAAC,CAACF,gBAAgB,CAACE,MAAM,EAAE;YAClE,MAAMC,OAAOC,QAAG,CAACC,KAAK,CACpB,CAAC,EAAE,IAAI,CAAC,CAACP,eAAe,CAAC,EAAE,IAAI,CAAC,CAACC,YAAY,CAAC,EAAE,IAAI,CAAC,CAACC,gBAAgB,CAAC,CAAC;YAG1EG,QACE,IAAI,CAAC,CAACG,SAAS,CAAC;gBACdH;gBACAI,KAAKC,YAAYC,GAAG;gBACpBC,MAAM;YACR;QACJ;QAEA,IAAI,CAAC,CAACb,UAAU,GAAG;QACnB,IAAI,CAAC,CAACC,eAAe,GAAG;QACxB,IAAI,CAAC,CAACC,YAAY,GAAG;QACrB,IAAI,CAAC,CAACC,gBAAgB,GAAG;IAC3B;IAEA,CAACM,SAAS,CAACK,KAAkD;QAC3D,IAAI,CAAC,CAACjB,MAAM,CAACkB,KAAK,CAAC,IAAM;gBAAC,CAAC,sBAAsB,CAAC;gBAAEC,KAAKC,SAAS,CAACH;aAAO;QAC1E,IAAI,CAACI,IAAI,CAAC,SAASJ;IACrB;IAEA,MAAMK,KAAKC,IAAmB,EAAiB;QAC7C,IAAI,CAAC,CAACvB,MAAM,CAACkB,KAAK,CAAC,IAAM,IAAIM,MAAM,CAAC;QAEpCD,QAAQ,IAAI,CAAC,CAACE,YAAY,CAACF;QAC3B,MAAM,IAAI,CAAC,CAACG,WAAW,CAACH;IAC1B;IAEA,MAAM,CAACG,WAAW,CAACH,IAAmB;QACpC,IAAI,CAAC,CAACvB,MAAM,CAACkB,KAAK,CAChB,IACE,CAAC,0BAA0B,EAAE,IAAI,CAAC,CAACjB,YAAY,CAAC,WAAW,EACzD,IAAI,CAAC,CAACC,aAAa,CACpB,CAAC;QAGN,IAAIqB,SAAS,MAAM;YACjB,IAAI,IAAI,CAAC,CAACpB,UAAU,EAAE;gBACpB,IAAI,CAAC,CAACS,SAAS,CAAC;oBACdH,MAAM,IAAI,CAAC,CAACN,UAAU;oBACtBa,MAAM;oBACNH,KAAKC,YAAYC,GAAG;gBACtB;YACF;YACA,IAAI,CAAC,CAACR,YAAY;YAClB,IAAI,CAAC,CAACK,SAAS,CAAC;YAChB;QACF;QAEA,8FAA8F;QAC9F,gBAAgB;QAChB,OAAQ,IAAI,CAAC,CAACX,YAAY;YACxB,KAAK;gBAAoB;oBACvB,yFAAyF;oBACzF,0EAA0E;oBAC1E,IAAI,IAAI,CAAC,CAACC,aAAa,KAAK,mBAAmB;wBAC7C,IAAI,CAAC,CAACK,YAAY;oBACpB;oBAEA,IAAI,CAAC,CAACH,eAAe,IAAImB;oBAEzB;gBACF;YAEA,4BAA4B;YAC5B,WAAW;YACX,IAAI;YAEJ,KAAK;gBAAc;oBACjB,IAAI,IAAI,CAAC,CAACpB,UAAU,EAAE;wBACpB,IAAI,CAAC,CAACS,SAAS,CAAC;4BACdH,MAAM,IAAI,CAAC,CAACN,UAAU;4BACtBa,MAAM;4BACNH,KAAKC,YAAYC,GAAG;wBACtB;wBACA,IAAI,CAAC,CAACZ,UAAU,GAAG;oBACrB;oBACA;gBACF;YAEA,KAAK;gBAAc;oBACjB,IAAI,IAAI,CAAC,CAACD,aAAa,KAAK,oBAAoB;wBAC9C,6EAA6E;wBAC7E,2EAA2E;wBAC3E,uEAAuE;wBACvE,IAAI,CAAC,CAACC,UAAU,GACd,IAAI,CAAC,CAACA,UAAU,CAACwB,KAAK,CAAC,GAAG,CAAC,KAC3B,IAAI,CAAC,CAACvB,eAAe,GACrB,IAAI,CAAC,CAACD,UAAU,CAACwB,KAAK,CAAC,CAAC;wBAC1B,IAAI,CAAC,CAACvB,eAAe,GAAG;oBAC1B,OAAO,IAAI,IAAI,CAAC,CAACA,eAAe,IAAI,IAAI,CAAC,CAACE,gBAAgB,EAAE;wBAC1D,MAAMG,OAAOC,QAAG,CAACC,KAAK,CACpB,CAAC,EAAE,IAAI,CAAC,CAACP,eAAe,CAAC,EAAE,IAAI,CAAC,CAACC,YAAY,CAAC,EAC5C,IAAI,CAAC,CAACC,gBAAgB,CACvB,CAAC;wBAGJG,QACE,IAAI,CAAC,CAACG,SAAS,CAAC;4BACdH;4BACAO,MAAM;4BACNH,KAAKC,YAAYC,GAAG;wBACtB;wBAEF,IAAI,CAAC,CAACX,eAAe,GAAG;wBACxB,IAAI,CAAC,CAACC,YAAY,GAAG;wBACrB,IAAI,CAAC,CAACC,gBAAgB,GAAG;oBAC3B;oBACA;gBACF;QACF;QAEA,IAAI,CAAC,CAACN,MAAM,CAACkB,KAAK,CAChB,IACE,CAAC,mBAAmB,EAAEK,KAAK,IAAI,EAAE,IAAI,CAAC,CAACpB,UAAU,CAAC,CAAC,EACjD,IAAI,CAAC,CAACC,eAAe,GAAG,CAAC,EAAE,EAAE,IAAI,CAAC,CAACA,eAAe,CAAC,CAAC,CAAC,GAAG,IACzD,EAAE,EAAE,IAAI,CAAC,CAACC,YAAY,CAAC,EAAE,EACxB,IAAI,CAAC,CAACC,gBAAgB,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,CAACA,gBAAgB,CAAC,CAAC,CAAC,GAAG,GAC1D,CAAC;IAER;IAEA,CAACsB,oBAAoB,CACnBC,OAAmB,EACnBC,OAAgC,EAChCC,oBAAkD;QAElD,MAAMC,mBAAmBC,UAAU,CAACJ,QAAQ;QAC5C,IAAIK,YAAwBL;QAC5B,KAAK,MAAMM,aAAaC,OAAOC,IAAI,CAACL,kBAAmC;YACrE,MAAMM,UAAUN,gBAAgB,CAACG,UAAU;YAC3C,IAAI,CAACG,SAAS;gBACZ;YACF;YAEA,IACEA,QAAQC,IAAI,CAAC,CAAC9B;gBACZ,MAAM+B,WACJ,aAAa/B,OACTA,KAAKgC,OAAO,CAACC,KAAK,CAChB,CAACC,aAAeb,OAAO,CAACa,WAAW,KAAK,SAE1C;gBAEN,IAAI,CAACH,UAAU;oBACb,OAAO;gBACT;gBAEA,MAAMI,UACJ,YAAYnC,OACRA,KAAKoC,MAAM,CAACH,KAAK,CAAC,CAACC,aAAeb,OAAO,CAACa,WAAW,KAAK,QAC1D;gBAEN,IAAIC,SAAS;oBACXV,YAAYC;oBAEZ,iEAAiE;oBACjE,sDAAsD;oBACtD,IAAI,aAAa1B,QAAQA,KAAKqC,OAAO,EAAE;wBACrCf,wBAAwBA,qBAAqBG;wBAC7CA,YAAY,IAAI,CAAC,CAACN,oBAAoB,CAACM,WAAWJ;oBACpD;oBAEA,OAAO;gBACT;gBAEA,OAAO;YACT,IACA;gBACA;YACF;QACF;QAEA,OAAOI;IACT;IAEA,CAACT,YAAY,CAACF,IAAY;QACxB,IAAI,CAAC,CAACvB,MAAM,CAACkB,KAAK,CAChB,IACE,CAAC,oBAAoB,EAAEK,KAAK,IAAI,EAAE,IAAI,CAAC,CAACpB,UAAU,CAAC,CAAC,EAClD,IAAI,CAAC,CAACC,eAAe,GAAG,CAAC,EAAE,EAAE,IAAI,CAAC,CAACA,eAAe,CAAC,CAAC,CAAC,GAAG,IACzD,EAAE,EAAE,IAAI,CAAC,CAACC,YAAY,CAAC,EAAE,EACxB,IAAI,CAAC,CAACC,gBAAgB,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,CAACA,gBAAgB,CAAC,CAAC,CAAC,GAAG,GAC1D,CAAC;QAGN,IAAI,CAAC,CAACJ,aAAa,GAAG,IAAI,CAAC,CAACD,YAAY;QAExC,+DAA+D;QAC/D,MAAM8C,eAAexB,SAAS,IAAI,CAAC,CAACzB,gBAAgB;QACpD,MAAMkD,cAAczB,SAAS,IAAI,CAAC,CAACxB,eAAe;QAElD,MAAM+B,UAAmC;YACvCmB,uBAAuBF;YACvBG,sBAAsBF;YACtBG,qBAAqB,CAACJ,gBAAgB,CAACC;YACvCI,0BAA0B,MAAM,IAAI,CAAC,CAAChD,eAAe,CAACI,MAAM;YAC5D6C,0BAA0B,MAAM,IAAI,CAAC,CAACjD,eAAe,CAACI,MAAM;YAC5D8C,4BAA4B,MAAM,IAAI,CAAC,CAAClD,eAAe,CAACI,MAAM;YAC9D+C,qCACE,IAAI,CAAC,CAACnD,eAAe,CAACI,MAAM,KAAK,IAAI,CAAC,CAACF,gBAAgB,CAACE,MAAM;QAClE;QAEA,IAAI,CAAC,CAACP,YAAY,GAAG,IAAI,CAAC,CAAC2B,oBAAoB,CAC7C,IAAI,CAAC,CAAC3B,YAAY,EAClB6B,SACA,CAAC0B;YACC,IAAI,CAAC,CAACxD,MAAM,CAACkB,KAAK,CAChB,IACE,CAAC,+CAA+C,EAC9C,IAAI,CAAC,CAAChB,aAAa,CACpB,aAAa,EAAEsD,MAAM,CAAC,CAAC;QAE9B;QAGF,mFAAmF;QACnF,4FAA4F;QAC5F,OAAQ,IAAI,CAAC,CAACvD,YAAY;YACxB,KAAK;gBAAoB;oBAMvB;gBACF;YAEA,KAAK;gBAAmB;oBACtB,IAAI,CAAC,CAACK,gBAAgB,IAAIiB;oBAC1B;gBACF;YAEA,KAAK;gBAAc;oBACjB,IAAI,CAAC,CAACpB,UAAU,IAAIoB;oBACpB;gBACF;YAEA,KAAK;gBAAc;oBACjB,IAAI,CAAC,CAAClB,YAAY,IAAIkB;oBACtB;gBACF;QACF;IACF;;;aAtQS,CAACzB,gBAAgB,GAAG;aACpB,CAACC,eAAe,GAAG;aAE5B,CAACC,MAAM,GAAG,IAAIyD,WAAG,CAAC;YAChBC,UAAU;YACVC,OAAO,AAACC,QAAQC,GAAG,CAASC,SAAS,IAAI;QAC3C;aAEA,CAAC7D,YAAY,GAAe;aAE5B,CAACE,UAAU,GAAG;aACd,CAACC,eAAe,GAAG;aACnB,CAACC,YAAY,GAAG;aAChB,CAACC,gBAAgB,GAAG;;AA0PtB;AA0BA,MAAM2B,aAAyB;IAC7B8B,YAAY;QACVC,iBAAiB;YACf;gBACEnB,QAAQ;oBAAC;iBAAuB;YAClC;SACD;IACH;IAEAoB,YAAY;QACVC,kBAAkB;YAChB;gBACErB,QAAQ;oBAAC;iBAAwB;YACnC;SACD;IACH;IAEAmB,iBAAiB;QACfE,kBAAkB;YAChB;gBACErB,QAAQ;oBACN;oBACA;iBACD;YACH;SACD;QACDoB,YAAY;YACV;gBACEpB,QAAQ;oBAAC;oBAAuB;iBAAsC;YACxE;SACD;IACH;IAEAqB,kBAAkB;QAChBD,YAAY;YACV;gBACExB,SAAS;oBAAC;iBAAwB;gBAClCI,QAAQ;oBAAC;iBAA2B;YACtC;SACD;QACDkB,YAAY;YACV;gBACElB,QAAQ;oBAAC;oBAAuB;iBAA2B;YAC7D;YACA;gBACEA,QAAQ;oBAAC;iBAA6B;YACxC;SACD;IACH;AACF"}

package/src/lib/types.d.ts

@@ -0,0 +1,224 @@
+import { ReadableStream } from "node:stream/web";
+export type ContentTagTagTypes = (typeof ContentTagTypes)[number];
+export declare const ContentTagTypes: readonly ["block", "end", "inverted", "parent", "section"];
+/**
+ * A JavaScript object that supplies replacements for tags in a Mustache template. The Mustache
+ * specification uses the term "hash." In stache-stream "hash" and "context" are synonyms.
+ * @category Context
+ */
+export interface Context {
+    readonly [key: string]: ContextTypes | undefined;
+}
+/**
+ * When a Mustache template is rendered data needs to be provided to replace tags in the template; a
+ * ContextProvider delivers that information. The ContextProvider includes context for a template as
+ * well as the method `getContextValue` to search for a value not found in the current context in
+ * the parent context.
+ *
+ * @property context Context for the current template.
+ * @property getContextValue If a value is not found in the current context invoke this method to
+ * look for a value in parent context.
+ */
+export interface ContextProvider {
+    readonly context: ContextTypes;
+    readonly getContextValue?: <CTX extends ContextTypes>(tag: Tag) => Promise<CTX | undefined>;
+}
+/**
+ * Properties in a { @link Context } object implement these types. The specific types to implement
+ * are determined by the tag type in a Mustache template.
+ * @category Context
+ */
+export type ContextTypes = Context | PartialTagContext | SectionTagContext | VariableTagContext;
+/**
+ * A primitive JavaScript type that can be serialized in a JSON object.
+ */
+export type JsonType = boolean | number | string;
+/**
+ * Implement one of these interfaces to provide replacements for
+ * {@link https://mustache.github.io/mustache.5.html#Variables Partial tags}. See
+ * {@link ContextTypes ContextTypes}.
+ * @category Context
+ * @category Partial
+ */
+export type PartialTagContext = PartialTagContextLambda;
+/**
+ * Implement this function to asynchronously return a `ReadableStream` that contains a Mustache
+ * template and its associated context that replaces a
+ * {@link https://mustache.github.io/mustache.5.html#Variables Partial tag}.
+ *
+ * @example PartialTagContextLambda
+ * ```
+ * const lambda: PartialTagContextLambda = (tag) => {
+ *   context: { title: "On Tyranny" },
+ *   template: () => bookSummary.getReadableStream()
+ * }
+ * ```
+ *
+ * @param tag The partial tag that is being processed. `PartialTagContextLambda` returns the
+ * template and the context that the partial tag references which are needed to render the partial
+ * replacement.
+ * @returns The template and context to render the partial that the `tag` parameter references.
+ * @category Context
+ * @category Partial
+ */
+export interface PartialTagContextLambda {
+    (tag: Tag): Promise<PartialTagContextLambdaResult>;
+}
+/**
+ * The result of invoking a {@link PartialTagContextLambda}.
+ * @category Context
+ * @category Partial
+ */
+export interface PartialTagContextLambdaResult {
+    /** The optional context associated with this template. */
+    context?: ContextTypes;
+    /** When invoked `input` resolves to a stream containing the Mustache template that replaces a
+     * partial tag. */
+    input: () => Promise<ReadableStream>;
+}
+/**
+ * Implement one of these interfaces to provide replacements for
+ * {@link https://mustache.github.io/mustache.5.html#Sections Section tags}. See
+ * {@link ContextTypes ContextTypes}.
+ * @category Context
+ * @category Section
+ */
+export type SectionTagContext = SectionTagCallback | SectionTagContextRecord[];
+/**
+ * Provides zero or more items that will replace a
+ * {@link https://mustache.github.io/mustache.5.html#Sections Section tag}. See
+ * {@link SectionTagContext SectionTagContext}.
+ * @category Context
+ * @category Section
+ */
+export interface SectionTagContextRecord {
+    [key: string]: JsonType | SectionTagContextRecord;
+}
+/**
+ * When provided this callback is invoked when the
+ * {@link https://mustache.github.io/mustache.5.html#Sections Section tag} is encountered. The
+ * callback is passed the text contained within the section. If the section contains tags those tags
+ * will **not** have been replaced.
+ *
+ * @remarks
+ * Note that this is a callback function. The function provider is responsible for returning
+ * rendered text that will be written directly to the output.
+ *
+ * @example
+ * ```
+ * const callback = context as SectionTagCallback;
+ * const replacementText = callback(tag.content);
+ * this.writeToOutput(replacementText);
+ * ```
+ *
+ * @param tagContent The unrendered content of the section tag.
+ * @returns A string of rendered text that will replace the content of the section tag.
+ * @category Context
+ * @category Section
+ */
+export interface SectionTagCallback {
+    (tagContent: string): string;
+}
+/**
+ * Represents a tag in a Mustache template providing information about a tag and its
+ * characteristics.
+ *
+ * @remarks
+ * Parts of a tag
+ *
+ * ```txt
+ * >------tag------<
+ *  {{ >  header }}
+ *
+ *    >--value--<
+ *  {{ >  header }}
+ *
+ *    >S<>-key--<
+ *  {{ >  header }}
+ *
+ * >TO<         >TC<
+ *  {{ >  header }}
+ *
+ * >-------------------tag--------------------<
+ *  {{ #  section }}  Hello!   {{ / section }}
+ *
+ * >---start tag----<         >----end tag----<
+ *  {{ #  section }}  Hello!   {{ / section }}
+ *
+ *                 >--content--<
+ *  {{ #  section }}  Hello!   {{ / section }}
+ *
+ *  S = sigil or tag type
+ *  TO = tag open
+ *  TC = tag close
+ * ```
+ *
+ * @property content When a "tag" has a start and end tag (e.g. a Section tag) `content` contains
+ * the string between the two tags. When a tag is a single tag (like a Variable tag) `content` will
+ * be `null`.
+ * @property key The value that will be used to lookup a value in context. This key will have its
+ * sigil removed, for example, if the template is "{{ &title }}" the `key` value is "title".
+ * @property raw True when the tag has either three braces (e.g. "{{{ name }}}") or an ampersand
+ * (like "{{ &name }}").
+ * @property type The Tag type as described in the Mustache spec.
+ * @property value The string between a tag's opening "{{" and its closing "}}". If the template is
+ * "{{ #items }}" the `value` is "#items".
+ */
+export interface Tag {
+    readonly content: string | null;
+    readonly key: string;
+    readonly raw: boolean;
+    readonly type: ContentTagTagTypes | ValueTagTagTypes;
+    readonly value: string;
+}
+/**
+ * Defines how to access a template file.
+ *   - string: The name of a template file in the same directory as this module file. The name must
+ *     **not** include an extension.
+ *   - tuple: An array of two strings: the first element is the name of the template, as described
+ *     in the "string" type above. The second element is a relative path to the directory where the
+ *     template file is located; the path is relative to the location of this module file.
+ */
+export type TemplateName = string | [templateName: string, templateFilename: string];
+export type ValueTagTagTypes = (typeof ValueTagTypes)[number];
+export declare const ValueTagTypes: readonly ["comment", "implicit", "partial", "variable"];
+/**
+ * Interfaces that can supply replacements for
+ * {@link https://mustache.github.io/mustache.5.html#Variables variable tags}. See
+ * {@link ContextTypes ContextTypes}.
+ * @category Context
+ * @category Variable
+ */
+export type VariableTagContext = VariableTagContextPrimitive | VariableTagContextLambda | VariableTagContextRecord;
+/**
+ * A function that resolves to the value that replaces a
+ * {@link https://mustache.github.io/mustache.5.html#Variables variable tag}. See
+ * {@link VariableTagContext VariableTagContext}.
+ * @category Context
+ * @category Variable
+ */
+export interface VariableTagContextLambda {
+    (): Promise<VariableTagContextPrimitive | VariableTagContextRecord>;
+}
+/**
+ * A {@link https://mustache.github.io/mustache.5.html#Variables variable tag} can be replaced by
+ * these JavaScript primitives. See {@link VariableTagContext VariableTagContext}.
+ * @category Context
+ * @category Variable
+ */
+export type VariableTagContextPrimitive = JsonType | Array<boolean | number | string>;
+/**
+ * A {@link https://mustache.github.io/mustache.5.html#Variables variable tag} with a "dotted name"
+ * can be replaced by a JavaScript object. See {@link VariableTagContext VariableTagContext}.
+ * @category Context
+ * @category Variable
+ */
+export interface VariableTagContextRecord {
+    [key: string]: unknown;
+}
+/**
+ * Invoke this function to write to the output `WritableStream`.
+ */
+export interface WriteToOutput {
+    (text: string): Promise<void>;
+}

package/src/lib/types.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+function _export(target, all) {
+    for(var name in all)Object.defineProperty(target, name, {
+        enumerable: true,
+        get: all[name]
+    });
+}
+_export(exports, {
+    ContentTagTypes: function() {
+        return ContentTagTypes;
+    },
+    ValueTagTypes: function() {
+        return ValueTagTypes;
+    }
+});
+const ContentTagTypes = [
+    "block",
+    "end",
+    "inverted",
+    "parent",
+    "section"
+];
+const ValueTagTypes = [
+    "comment",
+    "implicit",
+    "partial",
+    "variable"
+];
+
+//# sourceMappingURL=types.js.map

package/src/lib/types.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../../libs/stache-stream/src/lib/types.ts"],"sourcesContent":["import { ReadableStream } from \"node:stream/web\";\n\nexport type ContentTagTagTypes = (typeof ContentTagTypes)[number];\n\nexport const ContentTagTypes = [\n  \"block\", // `{{$tag}}{{/tag}}`\n  \"end\", // `{{/tag}}`\n  \"inverted\", // `{{^tag}}{{/tag}}`\n  \"parent\", // `{{<tag}}{{/tag}}`\n  \"section\", // `{{#tag}}{{/tag}}`\n] as const;\n\n/**\n * A JavaScript object that supplies replacements for tags in a Mustache template. The Mustache\n * specification uses the term \"hash.\" In stache-stream \"hash\" and \"context\" are synonyms.\n * @category Context\n */\nexport interface Context {\n  readonly [key: string]: ContextTypes | undefined;\n}\n\n/**\n * When a Mustache template is rendered data needs to be provided to replace tags in the template; a\n * ContextProvider delivers that information. The ContextProvider includes context for a template as\n * well as the method `getContextValue` to search for a value not found in the current context in\n * the parent context.\n *\n * @property context Context for the current template.\n * @property getContextValue If a value is not found in the current context invoke this method to\n * look for a value in parent context.\n */\nexport interface ContextProvider {\n  readonly context: ContextTypes;\n  readonly getContextValue?: <CTX extends ContextTypes>(\n    tag: Tag\n  ) => Promise<CTX | undefined>;\n}\n\n/**\n * Properties in a { @link Context } object implement these types. The specific types to implement\n * are determined by the tag type in a Mustache template.\n * @category Context\n */\nexport type ContextTypes =\n  | Context\n  // | JsonType\n  | PartialTagContext\n  | SectionTagContext\n  | VariableTagContext;\n// | (Context | JsonType | SectionTagContextList)[];\n\n/**\n * A primitive JavaScript type that can be serialized in a JSON object.\n */\nexport type JsonType = boolean | number | string;\n\n/**\n * Implement one of these interfaces to provide replacements for\n * {@link https://mustache.github.io/mustache.5.html#Variables Partial tags}. See\n * {@link ContextTypes ContextTypes}.\n * @category Context\n * @category Partial\n */\nexport type PartialTagContext = PartialTagContextLambda;\n\n/**\n * Implement this function to asynchronously return a `ReadableStream` that contains a Mustache\n * template and its associated context that replaces a\n * {@link https://mustache.github.io/mustache.5.html#Variables Partial tag}.\n *\n * @example PartialTagContextLambda\n * ```\n * const lambda: PartialTagContextLambda = (tag) => {\n *   context: { title: \"On Tyranny\" },\n *   template: () => bookSummary.getReadableStream()\n * }\n * ```\n *\n * @param tag The partial tag that is being processed. `PartialTagContextLambda` returns the\n * template and the context that the partial tag references which are needed to render the partial\n * replacement.\n * @returns The template and context to render the partial that the `tag` parameter references.\n * @category Context\n * @category Partial\n */\nexport interface PartialTagContextLambda {\n  (tag: Tag): Promise<PartialTagContextLambdaResult>;\n}\n\n/**\n * The result of invoking a {@link PartialTagContextLambda}.\n * @category Context\n * @category Partial\n */\nexport interface PartialTagContextLambdaResult {\n  /** The optional context associated with this template. */\n  context?: ContextTypes;\n  /** When invoked `input` resolves to a stream containing the Mustache template that replaces a\n   * partial tag. */\n  input: () => Promise<ReadableStream>;\n}\n\n/**\n * Implement one of these interfaces to provide replacements for\n * {@link https://mustache.github.io/mustache.5.html#Sections Section tags}. See\n * {@link ContextTypes ContextTypes}.\n * @category Context\n * @category Section\n */\nexport type SectionTagContext = SectionTagCallback | SectionTagContextRecord[];\n\n/**\n * Provides zero or more items that will replace a\n * {@link https://mustache.github.io/mustache.5.html#Sections Section tag}. See\n * {@link SectionTagContext SectionTagContext}.\n * @category Context\n * @category Section\n */\nexport interface SectionTagContextRecord {\n  [key: string]: JsonType | SectionTagContextRecord;\n}\n\n/**\n * When provided this callback is invoked when the\n * {@link https://mustache.github.io/mustache.5.html#Sections Section tag} is encountered. The\n * callback is passed the text contained within the section. If the section contains tags those tags\n * will **not** have been replaced.\n *\n * @remarks\n * Note that this is a callback function. The function provider is responsible for returning\n * rendered text that will be written directly to the output.\n *\n * @example\n * ```\n * const callback = context as SectionTagCallback;\n * const replacementText = callback(tag.content);\n * this.writeToOutput(replacementText);\n * ```\n *\n * @param tagContent The unrendered content of the section tag.\n * @returns A string of rendered text that will replace the content of the section tag.\n * @category Context\n * @category Section\n */\nexport interface SectionTagCallback {\n  (tagContent: string): string;\n}\n\n/**\n * Represents a tag in a Mustache template providing information about a tag and its\n * characteristics.\n *\n * @remarks\n * Parts of a tag\n *\n * ```txt\n * >------tag------<\n *  {{ >  header }}\n *\n *    >--value--<\n *  {{ >  header }}\n *\n *    >S<>-key--<\n *  {{ >  header }}\n *\n * >TO<         >TC<\n *  {{ >  header }}\n *\n * >-------------------tag--------------------<\n *  {{ #  section }}  Hello!   {{ / section }}\n *\n * >---start tag----<         >----end tag----<\n *  {{ #  section }}  Hello!   {{ / section }}\n *\n *                 >--content--<\n *  {{ #  section }}  Hello!   {{ / section }}\n *\n *  S = sigil or tag type\n *  TO = tag open\n *  TC = tag close\n * ```\n *\n * @property content When a \"tag\" has a start and end tag (e.g. a Section tag) `content` contains\n * the string between the two tags. When a tag is a single tag (like a Variable tag) `content` will\n * be `null`.\n * @property key The value that will be used to lookup a value in context. This key will have its\n * sigil removed, for example, if the template is \"{{ &title }}\" the `key` value is \"title\".\n * @property raw True when the tag has either three braces (e.g. \"{{{ name }}}\") or an ampersand\n * (like \"{{ &name }}\").\n * @property type The Tag type as described in the Mustache spec.\n * @property value The string between a tag's opening \"{{\" and its closing \"}}\". If the template is\n * \"{{ #items }}\" the `value` is \"#items\".\n */\nexport interface Tag {\n  readonly content: string | null;\n  readonly key: string;\n  readonly raw: boolean;\n  readonly type: ContentTagTagTypes | ValueTagTagTypes;\n  readonly value: string;\n  // process: () => Promise<void>;\n}\n\n/**\n * Defines how to access a template file.\n *   - string: The name of a template file in the same directory as this module file. The name must\n *     **not** include an extension.\n *   - tuple: An array of two strings: the first element is the name of the template, as described\n *     in the \"string\" type above. The second element is a relative path to the directory where the\n *     template file is located; the path is relative to the location of this module file.\n */\nexport type TemplateName =\n  | string\n  | [templateName: string, templateFilename: string];\n\nexport type ValueTagTagTypes = (typeof ValueTagTypes)[number];\n\nexport const ValueTagTypes = [\n  \"comment\", // {{!text}}\n  \"implicit\", // `{{.}}`\n  \"partial\", // `{{>tag}}`\n  \"variable\",\n] as const;\n\n/**\n * Interfaces that can supply replacements for\n * {@link https://mustache.github.io/mustache.5.html#Variables variable tags}. See\n * {@link ContextTypes ContextTypes}.\n * @category Context\n * @category Variable\n */\nexport type VariableTagContext =\n  | VariableTagContextPrimitive\n  | VariableTagContextLambda\n  | VariableTagContextRecord;\n\n/**\n * A function that resolves to the value that replaces a\n * {@link https://mustache.github.io/mustache.5.html#Variables variable tag}. See\n * {@link VariableTagContext VariableTagContext}.\n * @category Context\n * @category Variable\n */\nexport interface VariableTagContextLambda {\n  (): Promise<VariableTagContextPrimitive | VariableTagContextRecord>;\n}\n\n/**\n * A {@link https://mustache.github.io/mustache.5.html#Variables variable tag} can be replaced by\n * these JavaScript primitives. See {@link VariableTagContext VariableTagContext}.\n * @category Context\n * @category Variable\n */\nexport type VariableTagContextPrimitive =\n  | JsonType\n  | Array<boolean | number | string>;\n\n/**\n * A {@link https://mustache.github.io/mustache.5.html#Variables variable tag} with a \"dotted name\"\n * can be replaced by a JavaScript object. See {@link VariableTagContext VariableTagContext}.\n * @category Context\n * @category Variable\n */\nexport interface VariableTagContextRecord {\n  [key: string]: unknown;\n}\n\n/**\n * Invoke this function to write to the output `WritableStream`.\n */\nexport interface WriteToOutput {\n  (text: string): Promise<void>;\n}\n"],"names":["ContentTagTypes","ValueTagTypes"],"rangeMappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;","mappings":";;;;;;;;;;;IAIaA,eAAe;eAAfA;;IAoNAC,aAAa;eAAbA;;;AApNN,MAAMD,kBAAkB;IAC7B;IACA;IACA;IACA;IACA;CACD;AA8MM,MAAMC,gBAAgB;IAC3B;IACA;IACA;IACA;CACD"}