@fragola-ai/prompt 1.0.3 → 1.0.4

package/dist/Prompt.js

@@ -0,0 +1,169 @@
+import { readFileSync } from "fs";
+import path from "path";
+class MissingVariablesError extends Error {
+  constructor(variables, prompt) {
+    super(`Missing variables: ${variables.map((v) => `'${v}'`).join(", ")}. For prompt: ${prompt}`);
+    this.variables = variables;
+    this.name = "MissingVariablesError";
+  }
+}
+class NamespaceUndefinedError extends Error {
+  constructor(namespace) {
+    super(`Tried to acess undefined namespace when using load() function: '${namespace}' does not exist`);
+    this.namespace = namespace;
+    this.name = "NamespaceUndefinedError";
+  }
+}
+class LoadFileReadError extends Error {
+  constructor(filePath, originalError) {
+    super(`Failed to load prompt from ${filePath}: ${originalError.message}`);
+    this.filePath = filePath;
+    this.originalError = originalError;
+    this.name = "LoadFileReadError";
+  }
+}
+const load = (relativePath) => ({ load: true, relativePath });
+class Prompt {
+  static defaultVariableRegex = /\{\{(\s*[\w.]+\s*)\}\}/g;
+  /**
+   * A map of aliases to file paths for use with the {@link load} function.
+   * Allows defining shortcuts for commonly used prompt file paths.
+   * 
+   * @example
+   * ```typescript
+   * Prompt.pathAlias = {
+   *   browse: "prompts",      // Maps "@browse" to "prompts/"
+   *   refund: "prompts/refund" // Maps "@refund" to "prompts/refund/"
+   * }
+   * 
+   * // Usage with load():
+   * load("@refund/shopRefund.md") // Resolves to "prompts/refund/shopRefund.md"
+   * ```
+   * @see {@link load}
+   */
+  static pathAlias = {};
+  #originalPrompt = "";
+  #value = "";
+  #variableRegex = Prompt.defaultVariableRegex;
+  #variables = {};
+  #basePath = process.env["PWD"];
+  constructor(prompt, variables = {}) {
+    if (!process.env["PWD"])
+      console.warn("PWD env variable not set");
+    if (typeof prompt == "string") {
+      this.#originalPrompt = prompt;
+      this.#value = prompt;
+    } else {
+      this.#originalPrompt = this.#load(prompt.relativePath);
+      this.#value = this.#originalPrompt;
+    }
+    this.setVariables(variables);
+  }
+  #stringify(value) {
+    switch (typeof value) {
+      case "object":
+        return JSON.stringify(value);
+      default:
+        return value;
+    }
+  }
+  #isInsideCodeBlock(index, text) {
+    const codeBlockRegex = /```[\s\S]*?```/g;
+    let match;
+    while ((match = codeBlockRegex.exec(text)) !== null) {
+      const start = match.index;
+      const end = start + match[0].length;
+      if (index >= start && index < end) {
+        return true;
+      }
+    }
+    return false;
+  }
+  /**
+   * Updates the variables used for string interpolation and re-processes the prompt template.
+   * 
+   * @param variables - Your new variables
+   * @throws {MissingVariablesError} When required variables are not provided in the variables object
+   */
+  setVariables(variables) {
+    this.#variables = variables;
+    const allMatch = Array.from(this.#originalPrompt.matchAll(this.#variableRegex)).filter((match) => !this.#isInsideCodeBlock(match.index, this.#originalPrompt)).map((match) => {
+      return {
+        placeholder: match[0],
+        index: match.index
+      };
+    });
+    const getVariableNameFromPlaceholder = (placeholder) => {
+      return placeholder.replaceAll(/[{}]/g, "").trim();
+    };
+    let missingVariables = [];
+    let applyReplace = [];
+    allMatch.forEach((match) => {
+      const variableName = getVariableNameFromPlaceholder(match.placeholder);
+      if (variableName in variables)
+        applyReplace.push(() => this.#value = this.#value.replace(match.placeholder, this.#stringify(this.#variables[variableName])));
+      else
+        missingVariables.push(variableName);
+    });
+    if (missingVariables.length)
+      throw new MissingVariablesError(missingVariables, this.#originalPrompt);
+    applyReplace.forEach((replace) => replace());
+  }
+  #load(relativePath) {
+    let _relativePath = (() => {
+      const split = relativePath.split("/");
+      if (split.length > 1) {
+        const namespace = split[0].trim();
+        if (namespace[0] == "@") {
+          const name = split[0].slice(1);
+          if (name in Prompt.pathAlias) {
+            return path.join(Prompt.pathAlias[name], split[1]);
+          } else
+            throw new NamespaceUndefinedError(namespace);
+        }
+      }
+      return relativePath;
+    })();
+    let fullPath = path.join(this.#basePath || "./", _relativePath);
+    if (!fullPath.split("/").at(-1)?.includes("."))
+      fullPath = `${fullPath}.md`;
+    try {
+      const content = readFileSync(fullPath, "utf-8");
+      return content;
+    } catch (error) {
+      if (error instanceof Error) {
+        throw new LoadFileReadError(fullPath, error);
+      }
+      throw error;
+    }
+  }
+  /**
+   * Gets the original prompt string used for this instance. Before any processing
+   * @returns {string} The original prompt string
+   */
+  get promptString() {
+    return this.#originalPrompt;
+  }
+  /**
+   * Gets the variables currently in use for this prompt.
+   * @returns {Map<string, any>} A map containing the prompt variables and their values.
+   */
+  get variables() {
+    return this.#variables;
+  }
+  /**
+   * Gets the interpolated value of the prompt.
+   * @returns {string} The resulting string after all variable interpolation has been applied.
+   */
+  get value() {
+    return this.#value;
+  }
+}
+export {
+  LoadFileReadError,
+  MissingVariablesError,
+  NamespaceUndefinedError,
+  Prompt as default,
+  load
+};
+//# sourceMappingURL=Prompt.js.map

package/dist/Prompt.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../Prompt.ts"],
+  "sourcesContent": ["import { readFileSync } from \"fs\";\nimport path from \"path\";\n\n/**\n * Represents a record of variables used for string interpolation in prompts.\n * Each key in the record is a variable name to interpolate in the prompt template,\n * and its value can be any type (object, array, number, string, etc.) which will replace the placeholder.\n */\nexport type Variables = Record<string, any>;\n\nexport class MissingVariablesError extends Error {\n    constructor(public variables: string[], prompt: string) {\n        super(`Missing variables: ${variables.map(v => `'${v}'`).join(', ')}. For prompt: ${prompt}`);\n        this.name = 'MissingVariablesError';\n    }\n}\n\nexport class NamespaceUndefinedError extends Error {\n    constructor(public namespace: string) {\n        super(`Tried to acess undefined namespace when using load() function: '${namespace}' does not exist`)\n        this.name = \"NamespaceUndefinedError\";\n    }\n}\n\nexport class LoadFileReadError extends Error {\n    constructor(public filePath: string, public originalError: Error) {\n        super(`Failed to load prompt from ${filePath}: ${originalError.message}`);\n        this.name = \"LoadFileReadError\";\n    }\n}\n\nexport type Load = { load: true, relativePath: string };\n\n/**\n * Creates a Load object to specify a prompt file location.\n * This function is used when the prompt is located in a file system.\n * The process working directory (PWD) is used as the base path by default.\n * Path aliases can be used to reduce path overhead.\n * \n * @param {string} relativePath - The relative path to the prompt file. Can include path aliases.\n * @returns {Load} An object containing the load flag and the relative path to the prompt file\n * \n * @example\n * // Using relative path\n * load('./prompts/myPrompt.txt')\n * \n * @example\n * // Using path alias\n * load('prompts:myPrompt.txt')\n */\nexport const load = (relativePath: string): Load => ({ load: true, relativePath });\n\nexport default class Prompt {\n    private static defaultVariableRegex = /\\{\\{(\\s*[\\w.]+\\s*)\\}\\}/g;\n    /**\n     * A map of aliases to file paths for use with the {@link load} function.\n     * Allows defining shortcuts for commonly used prompt file paths.\n     * \n     * @example\n     * ```typescript\n     * Prompt.pathAlias = {\n     *   browse: \"prompts\",      // Maps \"@browse\" to \"prompts/\"\n     *   refund: \"prompts/refund\" // Maps \"@refund\" to \"prompts/refund/\"\n     * }\n     * \n     * // Usage with load():\n     * load(\"@refund/shopRefund.md\") // Resolves to \"prompts/refund/shopRefund.md\"\n     * ```\n     * @see {@link load}\n     */\n    public static pathAlias: Record<string, string> = {};\n\n    #originalPrompt: string = \"\";\n    #value: string = \"\";\n    #variableRegex: RegExp = Prompt.defaultVariableRegex;\n    #variables: Variables = {};\n    #basePath = process.env[\"PWD\"];\n\n    constructor(prompt: string | Load, variables: Variables = {}) {\n        if (!process.env[\"PWD\"])\n            console.warn(\"PWD env variable not set\");\n        if (typeof prompt == 'string') {\n            this.#originalPrompt = prompt;\n            this.#value = prompt;\n        } else {\n            this.#originalPrompt = this.#load(prompt.relativePath);\n            this.#value = this.#originalPrompt;\n        }\n        this.setVariables(variables);\n    }\n\n    #stringify(value: any) {\n        switch (typeof value) {\n            case \"object\":\n                return JSON.stringify(value);\n            default:\n                return value;\n        }\n    }\n\n    #isInsideCodeBlock(index: number, text: string): boolean {\n        const codeBlockRegex = /```[\\s\\S]*?```/g;\n        let match;\n\n        while ((match = codeBlockRegex.exec(text)) !== null) {\n            const start = match.index;\n            const end = start + match[0].length;\n\n            if (index >= start && index < end) {\n                return true;\n            }\n        }\n\n        return false;\n    }\n\n    /**\n     * Updates the variables used for string interpolation and re-processes the prompt template.\n     * \n     * @param variables - Your new variables\n     * @throws {MissingVariablesError} When required variables are not provided in the variables object\n     */\n    setVariables(variables: Variables) {\n        this.#variables = variables;\n        const allMatch = Array.from(this.#originalPrompt.matchAll(this.#variableRegex))\n            .filter(match => !this.#isInsideCodeBlock(match.index!, this.#originalPrompt))\n            .map(match => {\n                return {\n                    placeholder: match[0],\n                    index: match.index\n                }\n            });\n\n        const getVariableNameFromPlaceholder = (placeholder: string) => {\n            return placeholder.replaceAll(/[{}]/g, \"\").trim();\n        }\n\n        let missingVariables: string[] = [];\n        let applyReplace: (() => {})[] = [];\n\n        allMatch.forEach(match => {\n            const variableName = getVariableNameFromPlaceholder(match.placeholder);\n            if (variableName in variables)\n                applyReplace.push(() => this.#value = this.#value.replace(match.placeholder, this.#stringify(this.#variables[variableName])));\n            else\n                missingVariables.push(variableName);\n        });\n\n        if (missingVariables.length)\n            throw new MissingVariablesError(missingVariables, this.#originalPrompt);\n        applyReplace.forEach(replace => replace());\n    }\n\n    #load(relativePath: string): string {\n        let _relativePath = ((): string => {\n            const split = relativePath.split(\"/\");\n            if (split.length > 1) {\n                const namespace = split[0].trim();\n                if (namespace[0] == \"@\") {\n                    const name = split[0].slice(1);\n                    if (name in Prompt.pathAlias) {\n                        return path.join(Prompt.pathAlias[name], split[1]);\n                    } else\n                        throw new NamespaceUndefinedError(namespace);\n                }\n            }\n            return relativePath;\n        })();\n\n        let fullPath = path.join(this.#basePath || \"./\", _relativePath);\n        if (!fullPath.split(\"/\").at(-1)?.includes(\".\"))\n            fullPath = `${fullPath}.md`;\n        try {\n            const content = readFileSync(fullPath, 'utf-8');\n            return content;\n        } catch (error) {\n            if (error instanceof Error) {\n                throw new LoadFileReadError(fullPath, error);\n            }\n            throw error;\n        }\n    }\n\n    /**\n     * Gets the original prompt string used for this instance. Before any processing\n     * @returns {string} The original prompt string\n     */\n    get promptString() {\n        return this.#originalPrompt;\n    }\n\n    /**\n     * Gets the variables currently in use for this prompt.\n     * @returns {Map<string, any>} A map containing the prompt variables and their values.\n     */\n    get variables() {\n        return this.#variables;\n    }\n\n    /**\n     * Gets the interpolated value of the prompt.\n     * @returns {string} The resulting string after all variable interpolation has been applied.\n     */\n    get value() {\n        return this.#value;\n    }\n}"],
+  "mappings": "AAAA,SAAS,oBAAoB;AAC7B,OAAO,UAAU;AASV,MAAM,8BAA8B,MAAM;AAAA,EAC7C,YAAmB,WAAqB,QAAgB;AACpD,UAAM,sBAAsB,UAAU,IAAI,OAAK,IAAI,CAAC,GAAG,EAAE,KAAK,IAAI,CAAC,iBAAiB,MAAM,EAAE;AAD7E;AAEf,SAAK,OAAO;AAAA,EAChB;AACJ;AAEO,MAAM,gCAAgC,MAAM;AAAA,EAC/C,YAAmB,WAAmB;AAClC,UAAM,mEAAmE,SAAS,kBAAkB;AADrF;AAEf,SAAK,OAAO;AAAA,EAChB;AACJ;AAEO,MAAM,0BAA0B,MAAM;AAAA,EACzC,YAAmB,UAAyB,eAAsB;AAC9D,UAAM,8BAA8B,QAAQ,KAAK,cAAc,OAAO,EAAE;AADzD;AAAyB;AAExC,SAAK,OAAO;AAAA,EAChB;AACJ;AAqBO,MAAM,OAAO,CAAC,kBAAgC,EAAE,MAAM,MAAM,aAAa;AAEhF,MAAO,OAAqB;AAAA,EACxB,OAAe,uBAAuB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAiBtC,OAAc,YAAoC,CAAC;AAAA,EAEnD,kBAA0B;AAAA,EAC1B,SAAiB;AAAA,EACjB,iBAAyB,OAAO;AAAA,EAChC,aAAwB,CAAC;AAAA,EACzB,YAAY,QAAQ,IAAI,KAAK;AAAA,EAE7B,YAAY,QAAuB,YAAuB,CAAC,GAAG;AAC1D,QAAI,CAAC,QAAQ,IAAI,KAAK;AAClB,cAAQ,KAAK,0BAA0B;AAC3C,QAAI,OAAO,UAAU,UAAU;AAC3B,WAAK,kBAAkB;AACvB,WAAK,SAAS;AAAA,IAClB,OAAO;AACH,WAAK,kBAAkB,KAAK,MAAM,OAAO,YAAY;AACrD,WAAK,SAAS,KAAK;AAAA,IACvB;AACA,SAAK,aAAa,SAAS;AAAA,EAC/B;AAAA,EAEA,WAAW,OAAY;AACnB,YAAQ,OAAO,OAAO;AAAA,MAClB,KAAK;AACD,eAAO,KAAK,UAAU,KAAK;AAAA,MAC/B;AACI,eAAO;AAAA,IACf;AAAA,EACJ;AAAA,EAEA,mBAAmB,OAAe,MAAuB;AACrD,UAAM,iBAAiB;AACvB,QAAI;AAEJ,YAAQ,QAAQ,eAAe,KAAK,IAAI,OAAO,MAAM;AACjD,YAAM,QAAQ,MAAM;AACpB,YAAM,MAAM,QAAQ,MAAM,CAAC,EAAE;AAE7B,UAAI,SAAS,SAAS,QAAQ,KAAK;AAC/B,eAAO;AAAA,MACX;AAAA,IACJ;AAEA,WAAO;AAAA,EACX;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,aAAa,WAAsB;AAC/B,SAAK,aAAa;AAClB,UAAM,WAAW,MAAM,KAAK,KAAK,gBAAgB,SAAS,KAAK,cAAc,CAAC,EACzE,OAAO,WAAS,CAAC,KAAK,mBAAmB,MAAM,OAAQ,KAAK,eAAe,CAAC,EAC5E,IAAI,WAAS;AACV,aAAO;AAAA,QACH,aAAa,MAAM,CAAC;AAAA,QACpB,OAAO,MAAM;AAAA,MACjB;AAAA,IACJ,CAAC;AAEL,UAAM,iCAAiC,CAAC,gBAAwB;AAC5D,aAAO,YAAY,WAAW,SAAS,EAAE,EAAE,KAAK;AAAA,IACpD;AAEA,QAAI,mBAA6B,CAAC;AAClC,QAAI,eAA6B,CAAC;AAElC,aAAS,QAAQ,WAAS;AACtB,YAAM,eAAe,+BAA+B,MAAM,WAAW;AACrE,UAAI,gBAAgB;AAChB,qBAAa,KAAK,MAAM,KAAK,SAAS,KAAK,OAAO,QAAQ,MAAM,aAAa,KAAK,WAAW,KAAK,WAAW,YAAY,CAAC,CAAC,CAAC;AAAA;AAE5H,yBAAiB,KAAK,YAAY;AAAA,IAC1C,CAAC;AAED,QAAI,iBAAiB;AACjB,YAAM,IAAI,sBAAsB,kBAAkB,KAAK,eAAe;AAC1E,iBAAa,QAAQ,aAAW,QAAQ,CAAC;AAAA,EAC7C;AAAA,EAEA,MAAM,cAA8B;AAChC,QAAI,iBAAiB,MAAc;AAC/B,YAAM,QAAQ,aAAa,MAAM,GAAG;AACpC,UAAI,MAAM,SAAS,GAAG;AAClB,cAAM,YAAY,MAAM,CAAC,EAAE,KAAK;AAChC,YAAI,UAAU,CAAC,KAAK,KAAK;AACrB,gBAAM,OAAO,MAAM,CAAC,EAAE,MAAM,CAAC;AAC7B,cAAI,QAAQ,OAAO,WAAW;AAC1B,mBAAO,KAAK,KAAK,OAAO,UAAU,IAAI,GAAG,MAAM,CAAC,CAAC;AAAA,UACrD;AACI,kBAAM,IAAI,wBAAwB,SAAS;AAAA,QACnD;AAAA,MACJ;AACA,aAAO;AAAA,IACX,GAAG;AAEH,QAAI,WAAW,KAAK,KAAK,KAAK,aAAa,MAAM,aAAa;AAC9D,QAAI,CAAC,SAAS,MAAM,GAAG,EAAE,GAAG,EAAE,GAAG,SAAS,GAAG;AACzC,iBAAW,GAAG,QAAQ;AAC1B,QAAI;AACA,YAAM,UAAU,aAAa,UAAU,OAAO;AAC9C,aAAO;AAAA,IACX,SAAS,OAAO;AACZ,UAAI,iBAAiB,OAAO;AACxB,cAAM,IAAI,kBAAkB,UAAU,KAAK;AAAA,MAC/C;AACA,YAAM;AAAA,IACV;AAAA,EACJ;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,IAAI,eAAe;AACf,WAAO,KAAK;AAAA,EAChB;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,IAAI,YAAY;AACZ,WAAO,KAAK;AAAA,EAChB;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,IAAI,QAAQ;AACR,WAAO,KAAK;AAAA,EAChB;AACJ;",
+  "names": []
+}

package/dist/utils.js

@@ -0,0 +1 @@
+//# sourceMappingURL=utils.js.map

package/dist/utils.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": [],
+  "sourcesContent": [],
+  "mappings": "",
+  "names": []
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fragola-ai/prompt",
-  "version": "1.0.3",
+  "version": "1.0.4",
   "description": "Prompt interpolation and loading library for Node.js/TypeScript.",
   "main": "dist/index.js",
   "module": "dist/index.js",