pika-shared 1.0.2 → 1.2.0

package/dist/util/instruction-assistance-utils.d.mts

@@ -0,0 +1,49 @@
+import { InstructionAssistanceConfig, TagsChatAppOverridableFeature, AgentInstructionChatAppOverridableFeature, TagDefinition, TagDefinitionWidget } from '../types/chatbot/chatbot-types.mjs';
+import '@aws-sdk/client-bedrock-agent-runtime';
+
+/**
+ * IMPORTANT!!!!!!!!!!!!!!!!!!!!!!
+ *
+ * The functions in this utility are used both by the front end svelte kit web client in the browser
+ * and in the backend lambda converse functions.  So, that means it needs to be able
+ * to run in a browser.  Do not add additional imports beyond anodine types.
+ *
+ * To be super clear: this is just logic to generate instruction assistance content given
+ * the right inputs.  It does not collect up those inputs, it is given them.
+ *
+ */
+
+/**
+ * IMPORTANT!!!!!!!!!!!!!!!!!!!!!!
+ *
+ * See header at top of file for important notes.
+ *
+ * Generate instruction assistance content based on enabled features
+ *
+ * @param instructionAssistanceConfig - The instruction assistance configuration from SSM
+ * @param tags - The tags configuration from the chat app
+ * @param agentInstructionFeature - The agent instruction feature configuration from the chat app
+ * @returns The instruction assistance content
+ */
+declare function generateInstructionAssistanceContent(instructionAssistanceConfig: InstructionAssistanceConfig | undefined, tags: TagsChatAppOverridableFeature | undefined, agentInstructionFeature: AgentInstructionChatAppOverridableFeature | undefined, tagDefinitions: TagDefinition<TagDefinitionWidget>[]): InstructionAssistanceConfig;
+/**
+ * IMPORTANT!!!!!!!!!!!!!!!!!!!!!!
+ *
+ * See header at top of file for important notes.
+ *
+ * Apply instruction assistance to the base prompt using placeholder replacement
+ */
+declare function applyInstructionAssistance(basePrompt: string, instructionContent: InstructionAssistanceConfig): string;
+/**
+ * IMPORTANT!!!!!!!!!!!!!!!!!!!!!!
+ *
+ * See header at top of file for important notes.
+ *
+ * Get the instruction assistance configuration from raw SSM parameters
+ *
+ * @param params - The raw SSM parameters
+ * @returns The instruction assistance configuration
+ */
+declare function getInstructionsAssistanceConfigFromRawSsmParams(params: Record<string, string>): InstructionAssistanceConfig;
+
+export { applyInstructionAssistance, generateInstructionAssistanceContent, getInstructionsAssistanceConfigFromRawSsmParams };

package/dist/util/instruction-assistance-utils.d.ts

@@ -0,0 +1,49 @@
+import { InstructionAssistanceConfig, TagsChatAppOverridableFeature, AgentInstructionChatAppOverridableFeature, TagDefinition, TagDefinitionWidget } from '../types/chatbot/chatbot-types.js';
+import '@aws-sdk/client-bedrock-agent-runtime';
+
+/**
+ * IMPORTANT!!!!!!!!!!!!!!!!!!!!!!
+ *
+ * The functions in this utility are used both by the front end svelte kit web client in the browser
+ * and in the backend lambda converse functions.  So, that means it needs to be able
+ * to run in a browser.  Do not add additional imports beyond anodine types.
+ *
+ * To be super clear: this is just logic to generate instruction assistance content given
+ * the right inputs.  It does not collect up those inputs, it is given them.
+ *
+ */
+
+/**
+ * IMPORTANT!!!!!!!!!!!!!!!!!!!!!!
+ *
+ * See header at top of file for important notes.
+ *
+ * Generate instruction assistance content based on enabled features
+ *
+ * @param instructionAssistanceConfig - The instruction assistance configuration from SSM
+ * @param tags - The tags configuration from the chat app
+ * @param agentInstructionFeature - The agent instruction feature configuration from the chat app
+ * @returns The instruction assistance content
+ */
+declare function generateInstructionAssistanceContent(instructionAssistanceConfig: InstructionAssistanceConfig | undefined, tags: TagsChatAppOverridableFeature | undefined, agentInstructionFeature: AgentInstructionChatAppOverridableFeature | undefined, tagDefinitions: TagDefinition<TagDefinitionWidget>[]): InstructionAssistanceConfig;
+/**
+ * IMPORTANT!!!!!!!!!!!!!!!!!!!!!!
+ *
+ * See header at top of file for important notes.
+ *
+ * Apply instruction assistance to the base prompt using placeholder replacement
+ */
+declare function applyInstructionAssistance(basePrompt: string, instructionContent: InstructionAssistanceConfig): string;
+/**
+ * IMPORTANT!!!!!!!!!!!!!!!!!!!!!!
+ *
+ * See header at top of file for important notes.
+ *
+ * Get the instruction assistance configuration from raw SSM parameters
+ *
+ * @param params - The raw SSM parameters
+ * @returns The instruction assistance configuration
+ */
+declare function getInstructionsAssistanceConfigFromRawSsmParams(params: Record<string, string>): InstructionAssistanceConfig;
+
+export { applyInstructionAssistance, generateInstructionAssistanceContent, getInstructionsAssistanceConfigFromRawSsmParams };

package/dist/util/instruction-assistance-utils.js

@@ -0,0 +1,133 @@
+'use strict';
+
+// src/util/instruction-assistance-utils.ts
+function generateInstructionAssistanceContent(instructionAssistanceConfig, tags, agentInstructionFeature, tagDefinitions) {
+  console.log("Generating instruction assistance content:", {
+    enabled: agentInstructionFeature?.enabled,
+    includeOutputFormattingRequirements: agentInstructionFeature?.includeOutputFormattingRequirements,
+    includeInstructionsForTags: agentInstructionFeature?.includeInstructionsForTags,
+    completeExampleEnabled: agentInstructionFeature?.completeExampleInstructionEnabled,
+    jsonOnlyEnabled: agentInstructionFeature?.jsonOnlyImperativeInstructionEnabled
+  });
+  let outputFormattingRequirements = "";
+  let tagInstructions = "";
+  let completeExampleInstructionLine = "";
+  let jsonOnlyImperativeInstructionLine = "";
+  if (!agentInstructionFeature?.enabled) {
+    return {
+      outputFormattingRequirements,
+      tagInstructions,
+      completeExampleInstructionLine,
+      jsonOnlyImperativeInstructionLine
+    };
+  }
+  if (agentInstructionFeature.includeOutputFormattingRequirements) {
+    outputFormattingRequirements = instructionAssistanceConfig?.outputFormattingRequirements || `**Output Formatting Requirements:**
+- **Output Response Enclosure**: All response output MUST be completely enclosed within <answer></answer> tags, including supported custom tags.
+- **Output Content Format:** All responses MUST be in Markdown with supported custom tags.`;
+  }
+  if (agentInstructionFeature.includeInstructionsForTags && tags && tags.tagsEnabled?.length > 0) {
+    console.log("Fetching tag definitions for instruction generation:", tags.tagsEnabled);
+    if (tagDefinitions.length > 0) {
+      const tagDictionary = tagDefinitions.filter((tagDef) => tagDef.canBeGeneratedByLlm && !tagDef.disabled).map((tagDef) => `  - ${tagDef.tagTitle}: \`${tagDef.shortTagEx}\``).join("\n");
+      let tagInstructionsContent = "";
+      if (tagDictionary) {
+        tagInstructionsContent += `- **Custom Tags Supported:**
+${tagDictionary}
+`;
+      }
+      for (const tagDef of tagDefinitions) {
+        if (tagDef.canBeGeneratedByLlm && !tagDef.disabled && tagDef.llmInstructionsMd) {
+          const tagType = `${tagDef.scope}.${tagDef.tag}`;
+          tagInstructionsContent += `- **${tagDef.tagTitle}:**
+  <tag-instructions type="${tagType}">
+${tagDef.llmInstructionsMd}
+  </tag-instructions>
+`;
+        }
+      }
+      if (tagInstructionsContent) {
+        tagInstructions = tagInstructionsContent;
+      }
+    }
+  }
+  if (agentInstructionFeature.completeExampleInstructionEnabled) {
+    completeExampleInstructionLine = agentInstructionFeature.completeExampleInstructionLine || instructionAssistanceConfig?.completeExampleInstructionLine || "- **Complete Example Output:**\n  `<answer>##Example markdown\nNormal text and an <image>http://some.url</image> and some **bold text**\n<chart>(...)</chart></answer>`";
+  }
+  if (agentInstructionFeature.jsonOnlyImperativeInstructionEnabled) {
+    jsonOnlyImperativeInstructionLine = agentInstructionFeature.jsonOnlyImperativeInstructionLine || instructionAssistanceConfig?.jsonOnlyImperativeInstructionLine || "BE ABSOLUTELY CERTAIN ANY JSON INCLUDED IS 100% VALID (especially for charts). Invalid JSON will break the user experience.";
+  }
+  console.log("Generated instruction assistance content:", {
+    hasOutputFormatting: !!outputFormattingRequirements,
+    hasTagInstructions: !!tagInstructions,
+    hasCompleteExample: !!completeExampleInstructionLine,
+    hasJsonValidation: !!jsonOnlyImperativeInstructionLine
+  });
+  return {
+    outputFormattingRequirements,
+    tagInstructions,
+    completeExampleInstructionLine,
+    jsonOnlyImperativeInstructionLine
+  };
+}
+function applyInstructionAssistance(basePrompt, instructionContent) {
+  let enhancedPrompt = basePrompt;
+  if (enhancedPrompt.includes("{{prompt-assistance}}")) {
+    console.log("Found {{prompt-assistance}} placeholder");
+    const allContent = [
+      instructionContent.outputFormattingRequirements,
+      instructionContent.tagInstructions,
+      instructionContent.completeExampleInstructionLine,
+      instructionContent.jsonOnlyImperativeInstructionLine
+    ].filter((content) => content && content.trim().length > 0).join("\n\n");
+    enhancedPrompt = enhancedPrompt.replace("{{prompt-assistance}}", allContent);
+  } else {
+    const placeholders = [
+      { placeholder: "{{output-formatting-requirements}}", content: instructionContent.outputFormattingRequirements },
+      { placeholder: "{{tag-instructions}}", content: instructionContent.tagInstructions },
+      { placeholder: "{{complete-example-instruction-line}}", content: instructionContent.completeExampleInstructionLine },
+      { placeholder: "{{json-only-imperative-instruction-line}}", content: instructionContent.jsonOnlyImperativeInstructionLine }
+    ];
+    let hasAnyPlaceholder = false;
+    for (const { placeholder, content } of placeholders) {
+      if (enhancedPrompt.includes(placeholder) && content) {
+        console.log(`Found ${placeholder} placeholder`);
+        hasAnyPlaceholder = true;
+        enhancedPrompt = enhancedPrompt.replace(placeholder, content);
+      }
+    }
+    if (!hasAnyPlaceholder) {
+      console.log("No placeholders found, appending to end of prompt");
+      const allContent = [
+        instructionContent.outputFormattingRequirements,
+        instructionContent.tagInstructions,
+        instructionContent.completeExampleInstructionLine,
+        instructionContent.jsonOnlyImperativeInstructionLine
+      ].filter((content) => content && content.trim().length > 0);
+      if (allContent.length > 0) {
+        enhancedPrompt = enhancedPrompt + "\n\n" + allContent.join("\n\n");
+      }
+    }
+  }
+  return enhancedPrompt;
+}
+function getInstructionsAssistanceConfigFromRawSsmParams(params) {
+  const expectedKeys = ["output-formatting-requirements", "default-complete-example-line", "default-json-validation-line"];
+  const missingKeys = expectedKeys.filter((key) => !params[key]);
+  if (missingKeys.length > 0) {
+    throw new Error(
+      `Missing required instruction assistance parameters: ${Object.keys(params).filter((key) => !expectedKeys.includes(key)).join(", ")}`
+    );
+  }
+  return {
+    outputFormattingRequirements: params["output-formatting-requirements"],
+    completeExampleInstructionLine: params["default-complete-example-line"],
+    jsonOnlyImperativeInstructionLine: params["default-json-validation-line"]
+  };
+}
+
+exports.applyInstructionAssistance = applyInstructionAssistance;
+exports.generateInstructionAssistanceContent = generateInstructionAssistanceContent;
+exports.getInstructionsAssistanceConfigFromRawSsmParams = getInstructionsAssistanceConfigFromRawSsmParams;
+//# sourceMappingURL=instruction-assistance-utils.js.map
+//# sourceMappingURL=instruction-assistance-utils.js.map

package/dist/util/instruction-assistance-utils.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/util/instruction-assistance-utils.ts"],"names":[],"mappings":";;;AAgCO,SAAS,oCACZ,CAAA,2BAAA,EACA,IACA,EAAA,uBAAA,EACA,cAC2B,EAAA;AAC3B,EAAA,OAAA,CAAQ,IAAI,4CAA8C,EAAA;AAAA,IACtD,SAAS,uBAAyB,EAAA,OAAA;AAAA,IAClC,qCAAqC,uBAAyB,EAAA,mCAAA;AAAA,IAC9D,4BAA4B,uBAAyB,EAAA,0BAAA;AAAA,IACrD,wBAAwB,uBAAyB,EAAA,iCAAA;AAAA,IACjD,iBAAiB,uBAAyB,EAAA;AAAA,GAC7C,CAAA;AAED,EAAA,IAAI,4BAA+B,GAAA,EAAA;AACnC,EAAA,IAAI,eAAkB,GAAA,EAAA;AACtB,EAAA,IAAI,8BAAiC,GAAA,EAAA;AACrC,EAAA,IAAI,iCAAoC,GAAA,EAAA;AAExC,EAAI,IAAA,CAAC,yBAAyB,OAAS,EAAA;AACnC,IAAO,OAAA;AAAA,MACH,4BAAA;AAAA,MACA,eAAA;AAAA,MACA,8BAAA;AAAA,MACA;AAAA,KACJ;AAAA;AAIJ,EAAA,IAAI,wBAAwB,mCAAqC,EAAA;AAC7D,IAAA,4BAAA,GACI,6BAA6B,4BAC7B,IAAA,CAAA;AAAA;AAAA,0FAAA,CAAA;AAAA;AAMR,EAAA,IAAI,wBAAwB,0BAA8B,IAAA,IAAA,IAAQ,IAAK,CAAA,WAAA,EAAa,SAAS,CAAG,EAAA;AAC5F,IAAQ,OAAA,CAAA,GAAA,CAAI,sDAAwD,EAAA,IAAA,CAAK,WAAW,CAAA;AAEpF,IAAI,IAAA,cAAA,CAAe,SAAS,CAAG,EAAA;AAE3B,MAAM,MAAA,aAAA,GAAgB,eACjB,MAAO,CAAA,CAAC,WAAW,MAAO,CAAA,mBAAA,IAAuB,CAAC,MAAA,CAAO,QAAQ,CAAA,CACjE,IAAI,CAAC,MAAA,KAAW,CAAO,IAAA,EAAA,MAAA,CAAO,QAAQ,CAAA,IAAA,EAAO,OAAO,UAAU,CAAA,EAAA,CAAI,CAClE,CAAA,IAAA,CAAK,IAAI,CAAA;AAEd,MAAA,IAAI,sBAAyB,GAAA,EAAA;AAC7B,MAAA,IAAI,aAAe,EAAA;AACf,QAA0B,sBAAA,IAAA,CAAA;AAAA,EAAiC,aAAa;AAAA,CAAA;AAAA;AAI5E,MAAA,KAAA,MAAW,UAAU,cAAgB,EAAA;AACjC,QAAA,IAAI,OAAO,mBAAuB,IAAA,CAAC,MAAO,CAAA,QAAA,IAAY,OAAO,iBAAmB,EAAA;AAC5E,UAAA,MAAM,UAAU,CAAG,EAAA,MAAA,CAAO,KAAK,CAAA,CAAA,EAAI,OAAO,GAAG,CAAA,CAAA;AAC7C,UAA0B,sBAAA,IAAA,CAAA,IAAA,EAAO,OAAO,QAAQ,CAAA;AAAA,0BAAA,EAAkC,OAAO,CAAA;AAAA,EAAO,OAAO,iBAAiB;AAAA;AAAA,CAAA;AAAA;AAC5H;AAGJ,MAAA,IAAI,sBAAwB,EAAA;AACxB,QAAkB,eAAA,GAAA,sBAAA;AAAA;AACtB;AACJ;AAIJ,EAAA,IAAI,wBAAwB,iCAAmC,EAAA;AAC3D,IACI,8BAAA,GAAA,uBAAA,CAAwB,8BACxB,IAAA,2BAAA,EAA6B,8BAC7B,IAAA,yKAAA;AAAA;AAIR,EAAA,IAAI,wBAAwB,oCAAsC,EAAA;AAC9D,IACI,iCAAA,GAAA,uBAAA,CAAwB,iCACxB,IAAA,2BAAA,EAA6B,iCAC7B,IAAA,6HAAA;AAAA;AAGR,EAAA,OAAA,CAAQ,IAAI,2CAA6C,EAAA;AAAA,IACrD,mBAAA,EAAqB,CAAC,CAAC,4BAAA;AAAA,IACvB,kBAAA,EAAoB,CAAC,CAAC,eAAA;AAAA,IACtB,kBAAA,EAAoB,CAAC,CAAC,8BAAA;AAAA,IACtB,iBAAA,EAAmB,CAAC,CAAC;AAAA,GACxB,CAAA;AAED,EAAO,OAAA;AAAA,IACH,4BAAA;AAAA,IACA,eAAA;AAAA,IACA,8BAAA;AAAA,IACA;AAAA,GACJ;AACJ;AASO,SAAS,0BAAA,CAA2B,YAAoB,kBAAyD,EAAA;AACpH,EAAA,IAAI,cAAiB,GAAA,UAAA;AAGrB,EAAI,IAAA,cAAA,CAAe,QAAS,CAAA,uBAAuB,CAAG,EAAA;AAClD,IAAA,OAAA,CAAQ,IAAI,yCAAyC,CAAA;AAErD,IAAA,MAAM,UAAa,GAAA;AAAA,MACf,kBAAmB,CAAA,4BAAA;AAAA,MACnB,kBAAmB,CAAA,eAAA;AAAA,MACnB,kBAAmB,CAAA,8BAAA;AAAA,MACnB,kBAAmB,CAAA;AAAA,KAElB,CAAA,MAAA,CAAO,CAAC,OAAA,KAAY,OAAW,IAAA,OAAA,CAAQ,IAAK,EAAA,CAAE,MAAS,GAAA,CAAC,CACxD,CAAA,IAAA,CAAK,MAAM,CAAA;AAEhB,IAAiB,cAAA,GAAA,cAAA,CAAe,OAAQ,CAAA,uBAAA,EAAyB,UAAU,CAAA;AAAA,GACxE,MAAA;AAEH,IAAA,MAAM,YAAe,GAAA;AAAA,MACjB,EAAE,WAAA,EAAa,oCAAsC,EAAA,OAAA,EAAS,mBAAmB,4BAA6B,EAAA;AAAA,MAC9G,EAAE,WAAA,EAAa,sBAAwB,EAAA,OAAA,EAAS,mBAAmB,eAAgB,EAAA;AAAA,MACnF,EAAE,WAAA,EAAa,uCAAyC,EAAA,OAAA,EAAS,mBAAmB,8BAA+B,EAAA;AAAA,MACnH,EAAE,WAAA,EAAa,2CAA6C,EAAA,OAAA,EAAS,mBAAmB,iCAAkC;AAAA,KAC9H;AAEA,IAAA,IAAI,iBAAoB,GAAA,KAAA;AACxB,IAAA,KAAA,MAAW,EAAE,WAAA,EAAa,OAAQ,EAAA,IAAK,YAAc,EAAA;AACjD,MAAA,IAAI,cAAe,CAAA,QAAA,CAAS,WAAW,CAAA,IAAK,OAAS,EAAA;AACjD,QAAQ,OAAA,CAAA,GAAA,CAAI,CAAS,MAAA,EAAA,WAAW,CAAc,YAAA,CAAA,CAAA;AAC9C,QAAoB,iBAAA,GAAA,IAAA;AACpB,QAAiB,cAAA,GAAA,cAAA,CAAe,OAAQ,CAAA,WAAA,EAAa,OAAO,CAAA;AAAA;AAChE;AAIJ,IAAA,IAAI,CAAC,iBAAmB,EAAA;AACpB,MAAA,OAAA,CAAQ,IAAI,mDAAmD,CAAA;AAC/D,MAAA,MAAM,UAAa,GAAA;AAAA,QACf,kBAAmB,CAAA,4BAAA;AAAA,QACnB,kBAAmB,CAAA,eAAA;AAAA,QACnB,kBAAmB,CAAA,8BAAA;AAAA,QACnB,kBAAmB,CAAA;AAAA,OACvB,CAAE,OAAO,CAAC,OAAA,KAAY,WAAW,OAAQ,CAAA,IAAA,EAAO,CAAA,MAAA,GAAS,CAAC,CAAA;AAE1D,MAAI,IAAA,UAAA,CAAW,SAAS,CAAG,EAAA;AACvB,QAAA,cAAA,GAAiB,cAAiB,GAAA,MAAA,GAAS,UAAW,CAAA,IAAA,CAAK,MAAM,CAAA;AAAA;AACrE;AACJ;AAGJ,EAAO,OAAA,cAAA;AACX;AAYO,SAAS,gDAAgD,MAA6D,EAAA;AACzH,EAAA,MAAM,YAAe,GAAA,CAAC,gCAAkC,EAAA,+BAAA,EAAiC,8BAA8B,CAAA;AACvH,EAAM,MAAA,WAAA,GAAc,aAAa,MAAO,CAAA,CAAC,QAAQ,CAAC,MAAA,CAAO,GAAG,CAAC,CAAA;AAC7D,EAAI,IAAA,WAAA,CAAY,SAAS,CAAG,EAAA;AACxB,IAAA,MAAM,IAAI,KAAA;AAAA,MACN,uDAAuD,MAAO,CAAA,IAAA,CAAK,MAAM,CAAA,CACpE,OAAO,CAAC,GAAA,KAAQ,CAAC,YAAA,CAAa,SAAS,GAAG,CAAC,CAC3C,CAAA,IAAA,CAAK,IAAI,CAAC,CAAA;AAAA,KACnB;AAAA;AAGJ,EAAO,OAAA;AAAA,IACH,4BAAA,EAA8B,OAAO,gCAAgC,CAAA;AAAA,IACrE,8BAAA,EAAgC,OAAO,+BAA+B,CAAA;AAAA,IACtE,iCAAA,EAAmC,OAAO,8BAA8B;AAAA,GAC5E;AACJ","file":"instruction-assistance-utils.js","sourcesContent":["/**\n * IMPORTANT!!!!!!!!!!!!!!!!!!!!!!\n *\n * The functions in this utility are used both by the front end svelte kit web client in the browser\n * and in the backend lambda converse functions.  So, that means it needs to be able\n * to run in a browser.  Do not add additional imports beyond anodine types.\n *\n * To be super clear: this is just logic to generate instruction assistance content given\n * the right inputs.  It does not collect up those inputs, it is given them.\n *\n */\n\nimport type {\n    AgentInstructionChatAppOverridableFeature,\n    InstructionAssistanceConfig,\n    TagDefinition,\n    TagDefinitionWidget,\n    TagsChatAppOverridableFeature\n} from '../types/chatbot/chatbot-types';\n\n/**\n * IMPORTANT!!!!!!!!!!!!!!!!!!!!!!\n *\n * See header at top of file for important notes.\n *\n * Generate instruction assistance content based on enabled features\n *\n * @param instructionAssistanceConfig - The instruction assistance configuration from SSM\n * @param tags - The tags configuration from the chat app\n * @param agentInstructionFeature - The agent instruction feature configuration from the chat app\n * @returns The instruction assistance content\n */\nexport function generateInstructionAssistanceContent(\n    instructionAssistanceConfig: InstructionAssistanceConfig | undefined,\n    tags: TagsChatAppOverridableFeature | undefined,\n    agentInstructionFeature: AgentInstructionChatAppOverridableFeature | undefined,\n    tagDefinitions: TagDefinition<TagDefinitionWidget>[]\n): InstructionAssistanceConfig {\n    console.log('Generating instruction assistance content:', {\n        enabled: agentInstructionFeature?.enabled,\n        includeOutputFormattingRequirements: agentInstructionFeature?.includeOutputFormattingRequirements,\n        includeInstructionsForTags: agentInstructionFeature?.includeInstructionsForTags,\n        completeExampleEnabled: agentInstructionFeature?.completeExampleInstructionEnabled,\n        jsonOnlyEnabled: agentInstructionFeature?.jsonOnlyImperativeInstructionEnabled\n    });\n\n    let outputFormattingRequirements = '';\n    let tagInstructions = '';\n    let completeExampleInstructionLine = '';\n    let jsonOnlyImperativeInstructionLine = '';\n\n    if (!agentInstructionFeature?.enabled) {\n        return {\n            outputFormattingRequirements,\n            tagInstructions,\n            completeExampleInstructionLine,\n            jsonOnlyImperativeInstructionLine\n        };\n    }\n\n    // Generate output formatting requirements\n    if (agentInstructionFeature.includeOutputFormattingRequirements) {\n        outputFormattingRequirements =\n            instructionAssistanceConfig?.outputFormattingRequirements ||\n            `**Output Formatting Requirements:**\n- **Output Response Enclosure**: All response output MUST be completely enclosed within <answer></answer> tags, including supported custom tags.\n- **Output Content Format:** All responses MUST be in Markdown with supported custom tags.`;\n    }\n\n    // Generate tag instructions\n    if (agentInstructionFeature.includeInstructionsForTags && tags && tags.tagsEnabled?.length > 0) {\n        console.log('Fetching tag definitions for instruction generation:', tags.tagsEnabled);\n\n        if (tagDefinitions.length > 0) {\n            // First create a dictionary listing all supported tags\n            const tagDictionary = tagDefinitions\n                .filter((tagDef) => tagDef.canBeGeneratedByLlm && !tagDef.disabled)\n                .map((tagDef) => `  - ${tagDef.tagTitle}: \\`${tagDef.shortTagEx}\\``)\n                .join('\\n');\n\n            let tagInstructionsContent = '';\n            if (tagDictionary) {\n                tagInstructionsContent += `- **Custom Tags Supported:**\\n${tagDictionary}\\n`;\n            }\n\n            // Then add detailed instructions for each tag\n            for (const tagDef of tagDefinitions) {\n                if (tagDef.canBeGeneratedByLlm && !tagDef.disabled && tagDef.llmInstructionsMd) {\n                    const tagType = `${tagDef.scope}.${tagDef.tag}`;\n                    tagInstructionsContent += `- **${tagDef.tagTitle}:**\\n  <tag-instructions type=\"${tagType}\">\\n${tagDef.llmInstructionsMd}\\n  </tag-instructions>\\n`;\n                }\n            }\n\n            if (tagInstructionsContent) {\n                tagInstructions = tagInstructionsContent;\n            }\n        }\n    }\n\n    // Generate complete example instruction line\n    if (agentInstructionFeature.completeExampleInstructionEnabled) {\n        completeExampleInstructionLine =\n            agentInstructionFeature.completeExampleInstructionLine ||\n            instructionAssistanceConfig?.completeExampleInstructionLine ||\n            '- **Complete Example Output:**\\n  `<answer>##Example markdown\\nNormal text and an <image>http://some.url</image> and some **bold text**\\n<chart>(...)</chart></answer>`';\n    }\n\n    // Generate JSON validation instruction line\n    if (agentInstructionFeature.jsonOnlyImperativeInstructionEnabled) {\n        jsonOnlyImperativeInstructionLine =\n            agentInstructionFeature.jsonOnlyImperativeInstructionLine ||\n            instructionAssistanceConfig?.jsonOnlyImperativeInstructionLine ||\n            'BE ABSOLUTELY CERTAIN ANY JSON INCLUDED IS 100% VALID (especially for charts). Invalid JSON will break the user experience.';\n    }\n\n    console.log('Generated instruction assistance content:', {\n        hasOutputFormatting: !!outputFormattingRequirements,\n        hasTagInstructions: !!tagInstructions,\n        hasCompleteExample: !!completeExampleInstructionLine,\n        hasJsonValidation: !!jsonOnlyImperativeInstructionLine\n    });\n\n    return {\n        outputFormattingRequirements,\n        tagInstructions,\n        completeExampleInstructionLine,\n        jsonOnlyImperativeInstructionLine\n    };\n}\n\n/**\n * IMPORTANT!!!!!!!!!!!!!!!!!!!!!!\n *\n * See header at top of file for important notes.\n *\n * Apply instruction assistance to the base prompt using placeholder replacement\n */\nexport function applyInstructionAssistance(basePrompt: string, instructionContent: InstructionAssistanceConfig): string {\n    let enhancedPrompt = basePrompt;\n\n    // Check for primary placeholder first\n    if (enhancedPrompt.includes('{{prompt-assistance}}')) {\n        console.log('Found {{prompt-assistance}} placeholder');\n\n        const allContent = [\n            instructionContent.outputFormattingRequirements,\n            instructionContent.tagInstructions,\n            instructionContent.completeExampleInstructionLine,\n            instructionContent.jsonOnlyImperativeInstructionLine\n        ]\n            .filter((content) => content && content.trim().length > 0)\n            .join('\\n\\n');\n\n        enhancedPrompt = enhancedPrompt.replace('{{prompt-assistance}}', allContent);\n    } else {\n        // Look for fine-grained placeholders\n        const placeholders = [\n            { placeholder: '{{output-formatting-requirements}}', content: instructionContent.outputFormattingRequirements },\n            { placeholder: '{{tag-instructions}}', content: instructionContent.tagInstructions },\n            { placeholder: '{{complete-example-instruction-line}}', content: instructionContent.completeExampleInstructionLine },\n            { placeholder: '{{json-only-imperative-instruction-line}}', content: instructionContent.jsonOnlyImperativeInstructionLine }\n        ];\n\n        let hasAnyPlaceholder = false;\n        for (const { placeholder, content } of placeholders) {\n            if (enhancedPrompt.includes(placeholder) && content) {\n                console.log(`Found ${placeholder} placeholder`);\n                hasAnyPlaceholder = true;\n                enhancedPrompt = enhancedPrompt.replace(placeholder, content);\n            }\n        }\n\n        // If no placeholders found, append to end\n        if (!hasAnyPlaceholder) {\n            console.log('No placeholders found, appending to end of prompt');\n            const allContent = [\n                instructionContent.outputFormattingRequirements,\n                instructionContent.tagInstructions,\n                instructionContent.completeExampleInstructionLine,\n                instructionContent.jsonOnlyImperativeInstructionLine\n            ].filter((content) => content && content.trim().length > 0);\n\n            if (allContent.length > 0) {\n                enhancedPrompt = enhancedPrompt + '\\n\\n' + allContent.join('\\n\\n');\n            }\n        }\n    }\n\n    return enhancedPrompt;\n}\n\n/**\n * IMPORTANT!!!!!!!!!!!!!!!!!!!!!!\n *\n * See header at top of file for important notes.\n *\n * Get the instruction assistance configuration from raw SSM parameters\n *\n * @param params - The raw SSM parameters\n * @returns The instruction assistance configuration\n */\nexport function getInstructionsAssistanceConfigFromRawSsmParams(params: Record<string, string>): InstructionAssistanceConfig {\n    const expectedKeys = ['output-formatting-requirements', 'default-complete-example-line', 'default-json-validation-line'];\n    const missingKeys = expectedKeys.filter((key) => !params[key]);\n    if (missingKeys.length > 0) {\n        throw new Error(\n            `Missing required instruction assistance parameters: ${Object.keys(params)\n                .filter((key) => !expectedKeys.includes(key))\n                .join(', ')}`\n        );\n    }\n\n    return {\n        outputFormattingRequirements: params['output-formatting-requirements'],\n        completeExampleInstructionLine: params['default-complete-example-line'],\n        jsonOnlyImperativeInstructionLine: params['default-json-validation-line']\n    };\n}\n"]}

package/dist/util/instruction-assistance-utils.mjs

@@ -0,0 +1,129 @@
+// src/util/instruction-assistance-utils.ts
+function generateInstructionAssistanceContent(instructionAssistanceConfig, tags, agentInstructionFeature, tagDefinitions) {
+  console.log("Generating instruction assistance content:", {
+    enabled: agentInstructionFeature?.enabled,
+    includeOutputFormattingRequirements: agentInstructionFeature?.includeOutputFormattingRequirements,
+    includeInstructionsForTags: agentInstructionFeature?.includeInstructionsForTags,
+    completeExampleEnabled: agentInstructionFeature?.completeExampleInstructionEnabled,
+    jsonOnlyEnabled: agentInstructionFeature?.jsonOnlyImperativeInstructionEnabled
+  });
+  let outputFormattingRequirements = "";
+  let tagInstructions = "";
+  let completeExampleInstructionLine = "";
+  let jsonOnlyImperativeInstructionLine = "";
+  if (!agentInstructionFeature?.enabled) {
+    return {
+      outputFormattingRequirements,
+      tagInstructions,
+      completeExampleInstructionLine,
+      jsonOnlyImperativeInstructionLine
+    };
+  }
+  if (agentInstructionFeature.includeOutputFormattingRequirements) {
+    outputFormattingRequirements = instructionAssistanceConfig?.outputFormattingRequirements || `**Output Formatting Requirements:**
+- **Output Response Enclosure**: All response output MUST be completely enclosed within <answer></answer> tags, including supported custom tags.
+- **Output Content Format:** All responses MUST be in Markdown with supported custom tags.`;
+  }
+  if (agentInstructionFeature.includeInstructionsForTags && tags && tags.tagsEnabled?.length > 0) {
+    console.log("Fetching tag definitions for instruction generation:", tags.tagsEnabled);
+    if (tagDefinitions.length > 0) {
+      const tagDictionary = tagDefinitions.filter((tagDef) => tagDef.canBeGeneratedByLlm && !tagDef.disabled).map((tagDef) => `  - ${tagDef.tagTitle}: \`${tagDef.shortTagEx}\``).join("\n");
+      let tagInstructionsContent = "";
+      if (tagDictionary) {
+        tagInstructionsContent += `- **Custom Tags Supported:**
+${tagDictionary}
+`;
+      }
+      for (const tagDef of tagDefinitions) {
+        if (tagDef.canBeGeneratedByLlm && !tagDef.disabled && tagDef.llmInstructionsMd) {
+          const tagType = `${tagDef.scope}.${tagDef.tag}`;
+          tagInstructionsContent += `- **${tagDef.tagTitle}:**
+  <tag-instructions type="${tagType}">
+${tagDef.llmInstructionsMd}
+  </tag-instructions>
+`;
+        }
+      }
+      if (tagInstructionsContent) {
+        tagInstructions = tagInstructionsContent;
+      }
+    }
+  }
+  if (agentInstructionFeature.completeExampleInstructionEnabled) {
+    completeExampleInstructionLine = agentInstructionFeature.completeExampleInstructionLine || instructionAssistanceConfig?.completeExampleInstructionLine || "- **Complete Example Output:**\n  `<answer>##Example markdown\nNormal text and an <image>http://some.url</image> and some **bold text**\n<chart>(...)</chart></answer>`";
+  }
+  if (agentInstructionFeature.jsonOnlyImperativeInstructionEnabled) {
+    jsonOnlyImperativeInstructionLine = agentInstructionFeature.jsonOnlyImperativeInstructionLine || instructionAssistanceConfig?.jsonOnlyImperativeInstructionLine || "BE ABSOLUTELY CERTAIN ANY JSON INCLUDED IS 100% VALID (especially for charts). Invalid JSON will break the user experience.";
+  }
+  console.log("Generated instruction assistance content:", {
+    hasOutputFormatting: !!outputFormattingRequirements,
+    hasTagInstructions: !!tagInstructions,
+    hasCompleteExample: !!completeExampleInstructionLine,
+    hasJsonValidation: !!jsonOnlyImperativeInstructionLine
+  });
+  return {
+    outputFormattingRequirements,
+    tagInstructions,
+    completeExampleInstructionLine,
+    jsonOnlyImperativeInstructionLine
+  };
+}
+function applyInstructionAssistance(basePrompt, instructionContent) {
+  let enhancedPrompt = basePrompt;
+  if (enhancedPrompt.includes("{{prompt-assistance}}")) {
+    console.log("Found {{prompt-assistance}} placeholder");
+    const allContent = [
+      instructionContent.outputFormattingRequirements,
+      instructionContent.tagInstructions,
+      instructionContent.completeExampleInstructionLine,
+      instructionContent.jsonOnlyImperativeInstructionLine
+    ].filter((content) => content && content.trim().length > 0).join("\n\n");
+    enhancedPrompt = enhancedPrompt.replace("{{prompt-assistance}}", allContent);
+  } else {
+    const placeholders = [
+      { placeholder: "{{output-formatting-requirements}}", content: instructionContent.outputFormattingRequirements },
+      { placeholder: "{{tag-instructions}}", content: instructionContent.tagInstructions },
+      { placeholder: "{{complete-example-instruction-line}}", content: instructionContent.completeExampleInstructionLine },
+      { placeholder: "{{json-only-imperative-instruction-line}}", content: instructionContent.jsonOnlyImperativeInstructionLine }
+    ];
+    let hasAnyPlaceholder = false;
+    for (const { placeholder, content } of placeholders) {
+      if (enhancedPrompt.includes(placeholder) && content) {
+        console.log(`Found ${placeholder} placeholder`);
+        hasAnyPlaceholder = true;
+        enhancedPrompt = enhancedPrompt.replace(placeholder, content);
+      }
+    }
+    if (!hasAnyPlaceholder) {
+      console.log("No placeholders found, appending to end of prompt");
+      const allContent = [
+        instructionContent.outputFormattingRequirements,
+        instructionContent.tagInstructions,
+        instructionContent.completeExampleInstructionLine,
+        instructionContent.jsonOnlyImperativeInstructionLine
+      ].filter((content) => content && content.trim().length > 0);
+      if (allContent.length > 0) {
+        enhancedPrompt = enhancedPrompt + "\n\n" + allContent.join("\n\n");
+      }
+    }
+  }
+  return enhancedPrompt;
+}
+function getInstructionsAssistanceConfigFromRawSsmParams(params) {
+  const expectedKeys = ["output-formatting-requirements", "default-complete-example-line", "default-json-validation-line"];
+  const missingKeys = expectedKeys.filter((key) => !params[key]);
+  if (missingKeys.length > 0) {
+    throw new Error(
+      `Missing required instruction assistance parameters: ${Object.keys(params).filter((key) => !expectedKeys.includes(key)).join(", ")}`
+    );
+  }
+  return {
+    outputFormattingRequirements: params["output-formatting-requirements"],
+    completeExampleInstructionLine: params["default-complete-example-line"],
+    jsonOnlyImperativeInstructionLine: params["default-json-validation-line"]
+  };
+}
+
+export { applyInstructionAssistance, generateInstructionAssistanceContent, getInstructionsAssistanceConfigFromRawSsmParams };
+//# sourceMappingURL=instruction-assistance-utils.mjs.map
+//# sourceMappingURL=instruction-assistance-utils.mjs.map

package/dist/util/instruction-assistance-utils.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/util/instruction-assistance-utils.ts"],"names":[],"mappings":";AAgCO,SAAS,oCACZ,CAAA,2BAAA,EACA,IACA,EAAA,uBAAA,EACA,cAC2B,EAAA;AAC3B,EAAA,OAAA,CAAQ,IAAI,4CAA8C,EAAA;AAAA,IACtD,SAAS,uBAAyB,EAAA,OAAA;AAAA,IAClC,qCAAqC,uBAAyB,EAAA,mCAAA;AAAA,IAC9D,4BAA4B,uBAAyB,EAAA,0BAAA;AAAA,IACrD,wBAAwB,uBAAyB,EAAA,iCAAA;AAAA,IACjD,iBAAiB,uBAAyB,EAAA;AAAA,GAC7C,CAAA;AAED,EAAA,IAAI,4BAA+B,GAAA,EAAA;AACnC,EAAA,IAAI,eAAkB,GAAA,EAAA;AACtB,EAAA,IAAI,8BAAiC,GAAA,EAAA;AACrC,EAAA,IAAI,iCAAoC,GAAA,EAAA;AAExC,EAAI,IAAA,CAAC,yBAAyB,OAAS,EAAA;AACnC,IAAO,OAAA;AAAA,MACH,4BAAA;AAAA,MACA,eAAA;AAAA,MACA,8BAAA;AAAA,MACA;AAAA,KACJ;AAAA;AAIJ,EAAA,IAAI,wBAAwB,mCAAqC,EAAA;AAC7D,IAAA,4BAAA,GACI,6BAA6B,4BAC7B,IAAA,CAAA;AAAA;AAAA,0FAAA,CAAA;AAAA;AAMR,EAAA,IAAI,wBAAwB,0BAA8B,IAAA,IAAA,IAAQ,IAAK,CAAA,WAAA,EAAa,SAAS,CAAG,EAAA;AAC5F,IAAQ,OAAA,CAAA,GAAA,CAAI,sDAAwD,EAAA,IAAA,CAAK,WAAW,CAAA;AAEpF,IAAI,IAAA,cAAA,CAAe,SAAS,CAAG,EAAA;AAE3B,MAAM,MAAA,aAAA,GAAgB,eACjB,MAAO,CAAA,CAAC,WAAW,MAAO,CAAA,mBAAA,IAAuB,CAAC,MAAA,CAAO,QAAQ,CAAA,CACjE,IAAI,CAAC,MAAA,KAAW,CAAO,IAAA,EAAA,MAAA,CAAO,QAAQ,CAAA,IAAA,EAAO,OAAO,UAAU,CAAA,EAAA,CAAI,CAClE,CAAA,IAAA,CAAK,IAAI,CAAA;AAEd,MAAA,IAAI,sBAAyB,GAAA,EAAA;AAC7B,MAAA,IAAI,aAAe,EAAA;AACf,QAA0B,sBAAA,IAAA,CAAA;AAAA,EAAiC,aAAa;AAAA,CAAA;AAAA;AAI5E,MAAA,KAAA,MAAW,UAAU,cAAgB,EAAA;AACjC,QAAA,IAAI,OAAO,mBAAuB,IAAA,CAAC,MAAO,CAAA,QAAA,IAAY,OAAO,iBAAmB,EAAA;AAC5E,UAAA,MAAM,UAAU,CAAG,EAAA,MAAA,CAAO,KAAK,CAAA,CAAA,EAAI,OAAO,GAAG,CAAA,CAAA;AAC7C,UAA0B,sBAAA,IAAA,CAAA,IAAA,EAAO,OAAO,QAAQ,CAAA;AAAA,0BAAA,EAAkC,OAAO,CAAA;AAAA,EAAO,OAAO,iBAAiB;AAAA;AAAA,CAAA;AAAA;AAC5H;AAGJ,MAAA,IAAI,sBAAwB,EAAA;AACxB,QAAkB,eAAA,GAAA,sBAAA;AAAA;AACtB;AACJ;AAIJ,EAAA,IAAI,wBAAwB,iCAAmC,EAAA;AAC3D,IACI,8BAAA,GAAA,uBAAA,CAAwB,8BACxB,IAAA,2BAAA,EAA6B,8BAC7B,IAAA,yKAAA;AAAA;AAIR,EAAA,IAAI,wBAAwB,oCAAsC,EAAA;AAC9D,IACI,iCAAA,GAAA,uBAAA,CAAwB,iCACxB,IAAA,2BAAA,EAA6B,iCAC7B,IAAA,6HAAA;AAAA;AAGR,EAAA,OAAA,CAAQ,IAAI,2CAA6C,EAAA;AAAA,IACrD,mBAAA,EAAqB,CAAC,CAAC,4BAAA;AAAA,IACvB,kBAAA,EAAoB,CAAC,CAAC,eAAA;AAAA,IACtB,kBAAA,EAAoB,CAAC,CAAC,8BAAA;AAAA,IACtB,iBAAA,EAAmB,CAAC,CAAC;AAAA,GACxB,CAAA;AAED,EAAO,OAAA;AAAA,IACH,4BAAA;AAAA,IACA,eAAA;AAAA,IACA,8BAAA;AAAA,IACA;AAAA,GACJ;AACJ;AASO,SAAS,0BAAA,CAA2B,YAAoB,kBAAyD,EAAA;AACpH,EAAA,IAAI,cAAiB,GAAA,UAAA;AAGrB,EAAI,IAAA,cAAA,CAAe,QAAS,CAAA,uBAAuB,CAAG,EAAA;AAClD,IAAA,OAAA,CAAQ,IAAI,yCAAyC,CAAA;AAErD,IAAA,MAAM,UAAa,GAAA;AAAA,MACf,kBAAmB,CAAA,4BAAA;AAAA,MACnB,kBAAmB,CAAA,eAAA;AAAA,MACnB,kBAAmB,CAAA,8BAAA;AAAA,MACnB,kBAAmB,CAAA;AAAA,KAElB,CAAA,MAAA,CAAO,CAAC,OAAA,KAAY,OAAW,IAAA,OAAA,CAAQ,IAAK,EAAA,CAAE,MAAS,GAAA,CAAC,CACxD,CAAA,IAAA,CAAK,MAAM,CAAA;AAEhB,IAAiB,cAAA,GAAA,cAAA,CAAe,OAAQ,CAAA,uBAAA,EAAyB,UAAU,CAAA;AAAA,GACxE,MAAA;AAEH,IAAA,MAAM,YAAe,GAAA;AAAA,MACjB,EAAE,WAAA,EAAa,oCAAsC,EAAA,OAAA,EAAS,mBAAmB,4BAA6B,EAAA;AAAA,MAC9G,EAAE,WAAA,EAAa,sBAAwB,EAAA,OAAA,EAAS,mBAAmB,eAAgB,EAAA;AAAA,MACnF,EAAE,WAAA,EAAa,uCAAyC,EAAA,OAAA,EAAS,mBAAmB,8BAA+B,EAAA;AAAA,MACnH,EAAE,WAAA,EAAa,2CAA6C,EAAA,OAAA,EAAS,mBAAmB,iCAAkC;AAAA,KAC9H;AAEA,IAAA,IAAI,iBAAoB,GAAA,KAAA;AACxB,IAAA,KAAA,MAAW,EAAE,WAAA,EAAa,OAAQ,EAAA,IAAK,YAAc,EAAA;AACjD,MAAA,IAAI,cAAe,CAAA,QAAA,CAAS,WAAW,CAAA,IAAK,OAAS,EAAA;AACjD,QAAQ,OAAA,CAAA,GAAA,CAAI,CAAS,MAAA,EAAA,WAAW,CAAc,YAAA,CAAA,CAAA;AAC9C,QAAoB,iBAAA,GAAA,IAAA;AACpB,QAAiB,cAAA,GAAA,cAAA,CAAe,OAAQ,CAAA,WAAA,EAAa,OAAO,CAAA;AAAA;AAChE;AAIJ,IAAA,IAAI,CAAC,iBAAmB,EAAA;AACpB,MAAA,OAAA,CAAQ,IAAI,mDAAmD,CAAA;AAC/D,MAAA,MAAM,UAAa,GAAA;AAAA,QACf,kBAAmB,CAAA,4BAAA;AAAA,QACnB,kBAAmB,CAAA,eAAA;AAAA,QACnB,kBAAmB,CAAA,8BAAA;AAAA,QACnB,kBAAmB,CAAA;AAAA,OACvB,CAAE,OAAO,CAAC,OAAA,KAAY,WAAW,OAAQ,CAAA,IAAA,EAAO,CAAA,MAAA,GAAS,CAAC,CAAA;AAE1D,MAAI,IAAA,UAAA,CAAW,SAAS,CAAG,EAAA;AACvB,QAAA,cAAA,GAAiB,cAAiB,GAAA,MAAA,GAAS,UAAW,CAAA,IAAA,CAAK,MAAM,CAAA;AAAA;AACrE;AACJ;AAGJ,EAAO,OAAA,cAAA;AACX;AAYO,SAAS,gDAAgD,MAA6D,EAAA;AACzH,EAAA,MAAM,YAAe,GAAA,CAAC,gCAAkC,EAAA,+BAAA,EAAiC,8BAA8B,CAAA;AACvH,EAAM,MAAA,WAAA,GAAc,aAAa,MAAO,CAAA,CAAC,QAAQ,CAAC,MAAA,CAAO,GAAG,CAAC,CAAA;AAC7D,EAAI,IAAA,WAAA,CAAY,SAAS,CAAG,EAAA;AACxB,IAAA,MAAM,IAAI,KAAA;AAAA,MACN,uDAAuD,MAAO,CAAA,IAAA,CAAK,MAAM,CAAA,CACpE,OAAO,CAAC,GAAA,KAAQ,CAAC,YAAA,CAAa,SAAS,GAAG,CAAC,CAC3C,CAAA,IAAA,CAAK,IAAI,CAAC,CAAA;AAAA,KACnB;AAAA;AAGJ,EAAO,OAAA;AAAA,IACH,4BAAA,EAA8B,OAAO,gCAAgC,CAAA;AAAA,IACrE,8BAAA,EAAgC,OAAO,+BAA+B,CAAA;AAAA,IACtE,iCAAA,EAAmC,OAAO,8BAA8B;AAAA,GAC5E;AACJ","file":"instruction-assistance-utils.mjs","sourcesContent":["/**\n * IMPORTANT!!!!!!!!!!!!!!!!!!!!!!\n *\n * The functions in this utility are used both by the front end svelte kit web client in the browser\n * and in the backend lambda converse functions.  So, that means it needs to be able\n * to run in a browser.  Do not add additional imports beyond anodine types.\n *\n * To be super clear: this is just logic to generate instruction assistance content given\n * the right inputs.  It does not collect up those inputs, it is given them.\n *\n */\n\nimport type {\n    AgentInstructionChatAppOverridableFeature,\n    InstructionAssistanceConfig,\n    TagDefinition,\n    TagDefinitionWidget,\n    TagsChatAppOverridableFeature\n} from '../types/chatbot/chatbot-types';\n\n/**\n * IMPORTANT!!!!!!!!!!!!!!!!!!!!!!\n *\n * See header at top of file for important notes.\n *\n * Generate instruction assistance content based on enabled features\n *\n * @param instructionAssistanceConfig - The instruction assistance configuration from SSM\n * @param tags - The tags configuration from the chat app\n * @param agentInstructionFeature - The agent instruction feature configuration from the chat app\n * @returns The instruction assistance content\n */\nexport function generateInstructionAssistanceContent(\n    instructionAssistanceConfig: InstructionAssistanceConfig | undefined,\n    tags: TagsChatAppOverridableFeature | undefined,\n    agentInstructionFeature: AgentInstructionChatAppOverridableFeature | undefined,\n    tagDefinitions: TagDefinition<TagDefinitionWidget>[]\n): InstructionAssistanceConfig {\n    console.log('Generating instruction assistance content:', {\n        enabled: agentInstructionFeature?.enabled,\n        includeOutputFormattingRequirements: agentInstructionFeature?.includeOutputFormattingRequirements,\n        includeInstructionsForTags: agentInstructionFeature?.includeInstructionsForTags,\n        completeExampleEnabled: agentInstructionFeature?.completeExampleInstructionEnabled,\n        jsonOnlyEnabled: agentInstructionFeature?.jsonOnlyImperativeInstructionEnabled\n    });\n\n    let outputFormattingRequirements = '';\n    let tagInstructions = '';\n    let completeExampleInstructionLine = '';\n    let jsonOnlyImperativeInstructionLine = '';\n\n    if (!agentInstructionFeature?.enabled) {\n        return {\n            outputFormattingRequirements,\n            tagInstructions,\n            completeExampleInstructionLine,\n            jsonOnlyImperativeInstructionLine\n        };\n    }\n\n    // Generate output formatting requirements\n    if (agentInstructionFeature.includeOutputFormattingRequirements) {\n        outputFormattingRequirements =\n            instructionAssistanceConfig?.outputFormattingRequirements ||\n            `**Output Formatting Requirements:**\n- **Output Response Enclosure**: All response output MUST be completely enclosed within <answer></answer> tags, including supported custom tags.\n- **Output Content Format:** All responses MUST be in Markdown with supported custom tags.`;\n    }\n\n    // Generate tag instructions\n    if (agentInstructionFeature.includeInstructionsForTags && tags && tags.tagsEnabled?.length > 0) {\n        console.log('Fetching tag definitions for instruction generation:', tags.tagsEnabled);\n\n        if (tagDefinitions.length > 0) {\n            // First create a dictionary listing all supported tags\n            const tagDictionary = tagDefinitions\n                .filter((tagDef) => tagDef.canBeGeneratedByLlm && !tagDef.disabled)\n                .map((tagDef) => `  - ${tagDef.tagTitle}: \\`${tagDef.shortTagEx}\\``)\n                .join('\\n');\n\n            let tagInstructionsContent = '';\n            if (tagDictionary) {\n                tagInstructionsContent += `- **Custom Tags Supported:**\\n${tagDictionary}\\n`;\n            }\n\n            // Then add detailed instructions for each tag\n            for (const tagDef of tagDefinitions) {\n                if (tagDef.canBeGeneratedByLlm && !tagDef.disabled && tagDef.llmInstructionsMd) {\n                    const tagType = `${tagDef.scope}.${tagDef.tag}`;\n                    tagInstructionsContent += `- **${tagDef.tagTitle}:**\\n  <tag-instructions type=\"${tagType}\">\\n${tagDef.llmInstructionsMd}\\n  </tag-instructions>\\n`;\n                }\n            }\n\n            if (tagInstructionsContent) {\n                tagInstructions = tagInstructionsContent;\n            }\n        }\n    }\n\n    // Generate complete example instruction line\n    if (agentInstructionFeature.completeExampleInstructionEnabled) {\n        completeExampleInstructionLine =\n            agentInstructionFeature.completeExampleInstructionLine ||\n            instructionAssistanceConfig?.completeExampleInstructionLine ||\n            '- **Complete Example Output:**\\n  `<answer>##Example markdown\\nNormal text and an <image>http://some.url</image> and some **bold text**\\n<chart>(...)</chart></answer>`';\n    }\n\n    // Generate JSON validation instruction line\n    if (agentInstructionFeature.jsonOnlyImperativeInstructionEnabled) {\n        jsonOnlyImperativeInstructionLine =\n            agentInstructionFeature.jsonOnlyImperativeInstructionLine ||\n            instructionAssistanceConfig?.jsonOnlyImperativeInstructionLine ||\n            'BE ABSOLUTELY CERTAIN ANY JSON INCLUDED IS 100% VALID (especially for charts). Invalid JSON will break the user experience.';\n    }\n\n    console.log('Generated instruction assistance content:', {\n        hasOutputFormatting: !!outputFormattingRequirements,\n        hasTagInstructions: !!tagInstructions,\n        hasCompleteExample: !!completeExampleInstructionLine,\n        hasJsonValidation: !!jsonOnlyImperativeInstructionLine\n    });\n\n    return {\n        outputFormattingRequirements,\n        tagInstructions,\n        completeExampleInstructionLine,\n        jsonOnlyImperativeInstructionLine\n    };\n}\n\n/**\n * IMPORTANT!!!!!!!!!!!!!!!!!!!!!!\n *\n * See header at top of file for important notes.\n *\n * Apply instruction assistance to the base prompt using placeholder replacement\n */\nexport function applyInstructionAssistance(basePrompt: string, instructionContent: InstructionAssistanceConfig): string {\n    let enhancedPrompt = basePrompt;\n\n    // Check for primary placeholder first\n    if (enhancedPrompt.includes('{{prompt-assistance}}')) {\n        console.log('Found {{prompt-assistance}} placeholder');\n\n        const allContent = [\n            instructionContent.outputFormattingRequirements,\n            instructionContent.tagInstructions,\n            instructionContent.completeExampleInstructionLine,\n            instructionContent.jsonOnlyImperativeInstructionLine\n        ]\n            .filter((content) => content && content.trim().length > 0)\n            .join('\\n\\n');\n\n        enhancedPrompt = enhancedPrompt.replace('{{prompt-assistance}}', allContent);\n    } else {\n        // Look for fine-grained placeholders\n        const placeholders = [\n            { placeholder: '{{output-formatting-requirements}}', content: instructionContent.outputFormattingRequirements },\n            { placeholder: '{{tag-instructions}}', content: instructionContent.tagInstructions },\n            { placeholder: '{{complete-example-instruction-line}}', content: instructionContent.completeExampleInstructionLine },\n            { placeholder: '{{json-only-imperative-instruction-line}}', content: instructionContent.jsonOnlyImperativeInstructionLine }\n        ];\n\n        let hasAnyPlaceholder = false;\n        for (const { placeholder, content } of placeholders) {\n            if (enhancedPrompt.includes(placeholder) && content) {\n                console.log(`Found ${placeholder} placeholder`);\n                hasAnyPlaceholder = true;\n                enhancedPrompt = enhancedPrompt.replace(placeholder, content);\n            }\n        }\n\n        // If no placeholders found, append to end\n        if (!hasAnyPlaceholder) {\n            console.log('No placeholders found, appending to end of prompt');\n            const allContent = [\n                instructionContent.outputFormattingRequirements,\n                instructionContent.tagInstructions,\n                instructionContent.completeExampleInstructionLine,\n                instructionContent.jsonOnlyImperativeInstructionLine\n            ].filter((content) => content && content.trim().length > 0);\n\n            if (allContent.length > 0) {\n                enhancedPrompt = enhancedPrompt + '\\n\\n' + allContent.join('\\n\\n');\n            }\n        }\n    }\n\n    return enhancedPrompt;\n}\n\n/**\n * IMPORTANT!!!!!!!!!!!!!!!!!!!!!!\n *\n * See header at top of file for important notes.\n *\n * Get the instruction assistance configuration from raw SSM parameters\n *\n * @param params - The raw SSM parameters\n * @returns The instruction assistance configuration\n */\nexport function getInstructionsAssistanceConfigFromRawSsmParams(params: Record<string, string>): InstructionAssistanceConfig {\n    const expectedKeys = ['output-formatting-requirements', 'default-complete-example-line', 'default-json-validation-line'];\n    const missingKeys = expectedKeys.filter((key) => !params[key]);\n    if (missingKeys.length > 0) {\n        throw new Error(\n            `Missing required instruction assistance parameters: ${Object.keys(params)\n                .filter((key) => !expectedKeys.includes(key))\n                .join(', ')}`\n        );\n    }\n\n    return {\n        outputFormattingRequirements: params['output-formatting-requirements'],\n        completeExampleInstructionLine: params['default-complete-example-line'],\n        jsonOnlyImperativeInstructionLine: params['default-json-validation-line']\n    };\n}\n"]}

package/dist/util/server-client-utils.d.mts

@@ -11,5 +11,21 @@ declare function redactData(data: any, attributesToRedact: string | string[]): a
  * @returns The redacted value
  */
 declare function redactValue(value: any): any;
+/**
+ * Constructs a scope string from scopeType and scopeValue
+ * @param scopeType - The type of scope (chatapp, agent, tool, entity, agent-entity)
+ * @param scopeValue - The value(s) for the scope
+ * @returns The constructed scope string
+ */
+declare function constructScope(scopeType: string, scopeValue: string | number | Record<string, string | number>): string;
+/**
+ * Parses a scope string back into scopeType and scopeValue
+ * @param scope - The scope string to parse
+ * @returns Object containing scopeType and scopeValue
+ */
+declare function parseScope(scope: string): {
+    scopeType: string;
+    scopeValue: string | number | Record<string, string | number>;
+};
 
-export { redactData, redactValue };
+export { constructScope, parseScope, redactData, redactValue };

package/dist/util/server-client-utils.d.ts

@@ -11,5 +11,21 @@ declare function redactData(data: any, attributesToRedact: string | string[]): a
  * @returns The redacted value
  */
 declare function redactValue(value: any): any;
+/**
+ * Constructs a scope string from scopeType and scopeValue
+ * @param scopeType - The type of scope (chatapp, agent, tool, entity, agent-entity)
+ * @param scopeValue - The value(s) for the scope
+ * @returns The constructed scope string
+ */
+declare function constructScope(scopeType: string, scopeValue: string | number | Record<string, string | number>): string;
+/**
+ * Parses a scope string back into scopeType and scopeValue
+ * @param scope - The scope string to parse
+ * @returns Object containing scopeType and scopeValue
+ */
+declare function parseScope(scope: string): {
+    scopeType: string;
+    scopeValue: string | number | Record<string, string | number>;
+};
 
-export { redactData, redactValue };
+export { constructScope, parseScope, redactData, redactValue };

package/dist/util/server-client-utils.js

@@ -30,7 +30,70 @@ function redactValue(value) {
   }
   return value;
 }
+function validateScopeValue(scopeValue, scopeType) {
+  if (typeof scopeValue === "string" && scopeValue.includes("#")) {
+    throw new Error(`Scope value cannot contain '#' character. Found in ${scopeType} scope value: ${scopeValue}`);
+  }
+  if (typeof scopeValue === "object" && scopeValue !== null) {
+    for (const [key, value] of Object.entries(scopeValue)) {
+      if (typeof value === "string" && value.includes("#")) {
+        throw new Error(`Scope value cannot contain '#' character. Found in ${scopeType}.${key}: ${value}`);
+      }
+    }
+  }
+}
+function constructScope(scopeType, scopeValue) {
+  validateScopeValue(scopeValue, scopeType);
+  switch (scopeType) {
+    case "chatapp":
+    case "agent":
+    case "tool":
+    case "entity":
+      return `${scopeType}#${scopeValue}`;
+    case "agent-entity":
+      if (typeof scopeValue !== "object" || scopeValue === null) {
+        throw new Error("agent-entity scopeType requires an object with agent and entity properties");
+      }
+      const agentEntityValue = scopeValue;
+      if (!("agent" in agentEntityValue) || !("entity" in agentEntityValue)) {
+        throw new Error("agent-entity scopeType requires an object with both agent and entity properties");
+      }
+      return `agent#${agentEntityValue.agent}#entity#${agentEntityValue.entity}`;
+    default:
+      throw new Error(`Unsupported scopeType: ${scopeType}`);
+  }
+}
+function parseScope(scope) {
+  if (!scope || typeof scope !== "string") {
+    throw new Error("Invalid scope: must be a non-empty string");
+  }
+  const parts = scope.split("#");
+  if (parts.length < 2) {
+    throw new Error(`Invalid scope format: ${scope}. Expected format: scopeType#scopeValue`);
+  }
+  const [firstType, firstValue, ...remaining] = parts;
+  if (remaining.length >= 2 && firstType === "agent" && remaining[0] === "entity") {
+    return {
+      scopeType: "agent-entity",
+      scopeValue: {
+        agent: firstValue,
+        entity: remaining[1]
+      }
+    };
+  }
+  if (remaining.length === 0) {
+    const numericValue = Number(firstValue);
+    const scopeValue = !isNaN(numericValue) && isFinite(numericValue) ? numericValue : firstValue;
+    return {
+      scopeType: firstType,
+      scopeValue
+    };
+  }
+  throw new Error(`Unsupported scope format: ${scope}`);
+}
 
+exports.constructScope = constructScope;
+exports.parseScope = parseScope;
 exports.redactData = redactData;
 exports.redactValue = redactValue;
 //# sourceMappingURL=server-client-utils.js.map

package/dist/util/server-client-utils.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/util/server-client-utils.ts"],"names":[],"mappings":";;;AAUA,SAAS,UAAA,CAAW,MAAW,kBAA4C,EAAA;AACvE,EAAA,IAAI,CAAC,IAAA,IAAQ,OAAO,IAAA,KAAS,QAAU,EAAA;AACnC,IAAO,OAAA,IAAA;AAAA;AAGX,EAAA,MAAM,aAAa,KAAM,CAAA,OAAA,CAAQ,kBAAkB,CAAI,GAAA,kBAAA,GAAqB,CAAC,kBAAkB,CAAA;AAC/F,EAAM,MAAA,QAAA,GAAW,EAAE,GAAG,IAAK,EAAA;AAE3B,EAAA,KAAA,MAAW,QAAQ,UAAY,EAAA;AAC3B,IAAA,IAAI,QAAQ,QAAU,EAAA;AAClB,MAAA,QAAA,CAAS,IAAI,CAAA,GAAI,WAAY,CAAA,QAAA,CAAS,IAAI,CAAC,CAAA;AAAA;AAC/C;AAGJ,EAAO,OAAA,QAAA;AACX;AAOA,SAAS,YAAY,KAAiB,EAAA;AAClC,EAAI,IAAA,OAAO,UAAU,QAAU,EAAA;AAC3B,IAAO,OAAA,YAAA;AAAA,GACA,MAAA,IAAA,KAAA,CAAM,OAAQ,CAAA,KAAK,CAAG,EAAA;AAC7B,IAAA,OAAO,MAAM,GAAI,CAAA,CAAC,IAAS,KAAA,WAAA,CAAY,IAAI,CAAC,CAAA;AAAA,GACrC,MAAA,IAAA,KAAA,IAAS,OAAO,KAAA,KAAU,QAAU,EAAA;AAC3C,IAAA,MAAM,cAAmB,EAAC;AAC1B,IAAA,KAAA,MAAW,OAAO,KAAO,EAAA;AACrB,MAAI,IAAA,KAAA,CAAM,cAAe,CAAA,GAAG,CAAG,EAAA;AAC3B,QAAA,WAAA,CAAY,GAAG,CAAA,GAAI,WAAY,CAAA,KAAA,CAAM,GAAG,CAAC,CAAA;AAAA;AAC7C;AAEJ,IAAO,OAAA,WAAA;AAAA;AAEX,EAAO,OAAA,KAAA;AACX","file":"server-client-utils.js","sourcesContent":["/*\n * These are utils that are safe to use both on the server and the client.\n */\n\n/**\n * Helper function to redact sensitive data from specified attributes\n * @param data - The object containing data to redact\n * @param attributesToRedact - Single attribute name or array of attribute names to redact\n * @returns A new object with specified attributes redacted\n */\nfunction redactData(data: any, attributesToRedact: string | string[]): any {\n    if (!data || typeof data !== 'object') {\n        return data;\n    }\n\n    const attributes = Array.isArray(attributesToRedact) ? attributesToRedact : [attributesToRedact];\n    const redacted = { ...data };\n\n    for (const attr of attributes) {\n        if (attr in redacted) {\n            redacted[attr] = redactValue(redacted[attr]);\n        }\n    }\n\n    return redacted;\n}\n\n/**\n * Recursively redacts a value based on its type\n * @param value - The value to redact\n * @returns The redacted value\n */\nfunction redactValue(value: any): any {\n    if (typeof value === 'string') {\n        return '[REDACTED]';\n    } else if (Array.isArray(value)) {\n        return value.map((item) => redactValue(item));\n    } else if (value && typeof value === 'object') {\n        const redactedObj: any = {};\n        for (const key in value) {\n            if (value.hasOwnProperty(key)) {\n                redactedObj[key] = redactValue(value[key]);\n            }\n        }\n        return redactedObj;\n    }\n    return value; // Return as-is for other types (numbers, booleans, null, etc.)\n}\n\n// Export both functions\nexport { redactData, redactValue };\n"]}
+{"version":3,"sources":["../../src/util/server-client-utils.ts"],"names":[],"mappings":";;;AAUA,SAAS,UAAA,CAAW,MAAW,kBAA4C,EAAA;AACvE,EAAA,IAAI,CAAC,IAAA,IAAQ,OAAO,IAAA,KAAS,QAAU,EAAA;AACnC,IAAO,OAAA,IAAA;AAAA;AAGX,EAAA,MAAM,aAAa,KAAM,CAAA,OAAA,CAAQ,kBAAkB,CAAI,GAAA,kBAAA,GAAqB,CAAC,kBAAkB,CAAA;AAC/F,EAAM,MAAA,QAAA,GAAW,EAAE,GAAG,IAAK,EAAA;AAE3B,EAAA,KAAA,MAAW,QAAQ,UAAY,EAAA;AAC3B,IAAA,IAAI,QAAQ,QAAU,EAAA;AAClB,MAAA,QAAA,CAAS,IAAI,CAAA,GAAI,WAAY,CAAA,QAAA,CAAS,IAAI,CAAC,CAAA;AAAA;AAC/C;AAGJ,EAAO,OAAA,QAAA;AACX;AAOA,SAAS,YAAY,KAAiB,EAAA;AAClC,EAAI,IAAA,OAAO,UAAU,QAAU,EAAA;AAC3B,IAAO,OAAA,YAAA;AAAA,GACA,MAAA,IAAA,KAAA,CAAM,OAAQ,CAAA,KAAK,CAAG,EAAA;AAC7B,IAAA,OAAO,MAAM,GAAI,CAAA,CAAC,IAAS,KAAA,WAAA,CAAY,IAAI,CAAC,CAAA;AAAA,GACrC,MAAA,IAAA,KAAA,IAAS,OAAO,KAAA,KAAU,QAAU,EAAA;AAC3C,IAAA,MAAM,cAAmB,EAAC;AAC1B,IAAA,KAAA,MAAW,OAAO,KAAO,EAAA;AACrB,MAAI,IAAA,KAAA,CAAM,cAAe,CAAA,GAAG,CAAG,EAAA;AAC3B,QAAA,WAAA,CAAY,GAAG,CAAA,GAAI,WAAY,CAAA,KAAA,CAAM,GAAG,CAAC,CAAA;AAAA;AAC7C;AAEJ,IAAO,OAAA,WAAA;AAAA;AAEX,EAAO,OAAA,KAAA;AACX;AAKA,SAAS,kBAAA,CAAmB,YAA+D,SAAyB,EAAA;AAChH,EAAA,IAAI,OAAO,UAAe,KAAA,QAAA,IAAY,UAAW,CAAA,QAAA,CAAS,GAAG,CAAG,EAAA;AAC5D,IAAA,MAAM,IAAI,KAAM,CAAA,CAAA,mDAAA,EAAsD,SAAS,CAAA,cAAA,EAAiB,UAAU,CAAE,CAAA,CAAA;AAAA;AAEhH,EAAA,IAAI,OAAO,UAAA,KAAe,QAAY,IAAA,UAAA,KAAe,IAAM,EAAA;AACvD,IAAA,KAAA,MAAW,CAAC,GAAK,EAAA,KAAK,KAAK,MAAO,CAAA,OAAA,CAAQ,UAAU,CAAG,EAAA;AACnD,MAAA,IAAI,OAAO,KAAU,KAAA,QAAA,IAAY,KAAM,CAAA,QAAA,CAAS,GAAG,CAAG,EAAA;AAClD,QAAM,MAAA,IAAI,MAAM,CAAsD,mDAAA,EAAA,SAAS,IAAI,GAAG,CAAA,EAAA,EAAK,KAAK,CAAE,CAAA,CAAA;AAAA;AACtG;AACJ;AAER;AAQA,SAAS,cAAA,CAAe,WAAmB,UAAuE,EAAA;AAE9G,EAAA,kBAAA,CAAmB,YAAY,SAAS,CAAA;AAExC,EAAA,QAAQ,SAAW;AAAA,IACf,KAAK,SAAA;AAAA,IACL,KAAK,OAAA;AAAA,IACL,KAAK,MAAA;AAAA,IACL,KAAK,QAAA;AACD,MAAO,OAAA,CAAA,EAAG,SAAS,CAAA,CAAA,EAAI,UAAU,CAAA,CAAA;AAAA,IACrC,KAAK,cAAA;AACD,MAAA,IAAI,OAAO,UAAA,KAAe,QAAY,IAAA,UAAA,KAAe,IAAM,EAAA;AACvD,QAAM,MAAA,IAAI,MAAM,4EAA4E,CAAA;AAAA;AAGhG,MAAA,MAAM,gBAAmB,GAAA,UAAA;AACzB,MAAA,IAAI,EAAE,OAAA,IAAW,gBAAqB,CAAA,IAAA,EAAE,YAAY,gBAAmB,CAAA,EAAA;AACnE,QAAM,MAAA,IAAI,MAAM,iFAAiF,CAAA;AAAA;AAGrG,MAAA,OAAO,CAAS,MAAA,EAAA,gBAAA,CAAiB,KAAK,CAAA,QAAA,EAAW,iBAAiB,MAAM,CAAA,CAAA;AAAA,IAE5E;AACI,MAAA,MAAM,IAAI,KAAA,CAAM,CAA0B,uBAAA,EAAA,SAAS,CAAE,CAAA,CAAA;AAAA;AAEjE;AAOA,SAAS,WAAW,KAAqG,EAAA;AACrH,EAAA,IAAI,CAAC,KAAA,IAAS,OAAO,KAAA,KAAU,QAAU,EAAA;AACrC,IAAM,MAAA,IAAI,MAAM,2CAA2C,CAAA;AAAA;AAG/D,EAAM,MAAA,KAAA,GAAQ,KAAM,CAAA,KAAA,CAAM,GAAG,CAAA;AAC7B,EAAI,IAAA,KAAA,CAAM,SAAS,CAAG,EAAA;AAClB,IAAA,MAAM,IAAI,KAAA,CAAM,CAAyB,sBAAA,EAAA,KAAK,CAAyC,uCAAA,CAAA,CAAA;AAAA;AAG3F,EAAA,MAAM,CAAC,SAAA,EAAW,UAAY,EAAA,GAAG,SAAS,CAAI,GAAA,KAAA;AAG9C,EAAI,IAAA,SAAA,CAAU,UAAU,CAAK,IAAA,SAAA,KAAc,WAAW,SAAU,CAAA,CAAC,MAAM,QAAU,EAAA;AAC7E,IAAO,OAAA;AAAA,MACH,SAAW,EAAA,cAAA;AAAA,MACX,UAAY,EAAA;AAAA,QACR,KAAO,EAAA,UAAA;AAAA,QACP,MAAA,EAAQ,UAAU,CAAC;AAAA;AACvB,KACJ;AAAA;AAIJ,EAAI,IAAA,SAAA,CAAU,WAAW,CAAG,EAAA;AAExB,IAAM,MAAA,YAAA,GAAe,OAAO,UAAU,CAAA;AACtC,IAAM,MAAA,UAAA,GAAa,CAAC,KAAM,CAAA,YAAY,KAAK,QAAS,CAAA,YAAY,IAAI,YAAe,GAAA,UAAA;AAEnF,IAAO,OAAA;AAAA,MACH,SAAW,EAAA,SAAA;AAAA,MACX;AAAA,KACJ;AAAA;AAGJ,EAAA,MAAM,IAAI,KAAA,CAAM,CAA6B,0BAAA,EAAA,KAAK,CAAE,CAAA,CAAA;AACxD","file":"server-client-utils.js","sourcesContent":["/*\n * These are utils that are safe to use both on the server and the client.\n */\n\n/**\n * Helper function to redact sensitive data from specified attributes\n * @param data - The object containing data to redact\n * @param attributesToRedact - Single attribute name or array of attribute names to redact\n * @returns A new object with specified attributes redacted\n */\nfunction redactData(data: any, attributesToRedact: string | string[]): any {\n    if (!data || typeof data !== 'object') {\n        return data;\n    }\n\n    const attributes = Array.isArray(attributesToRedact) ? attributesToRedact : [attributesToRedact];\n    const redacted = { ...data };\n\n    for (const attr of attributes) {\n        if (attr in redacted) {\n            redacted[attr] = redactValue(redacted[attr]);\n        }\n    }\n\n    return redacted;\n}\n\n/**\n * Recursively redacts a value based on its type\n * @param value - The value to redact\n * @returns The redacted value\n */\nfunction redactValue(value: any): any {\n    if (typeof value === 'string') {\n        return '[REDACTED]';\n    } else if (Array.isArray(value)) {\n        return value.map((item) => redactValue(item));\n    } else if (value && typeof value === 'object') {\n        const redactedObj: any = {};\n        for (const key in value) {\n            if (value.hasOwnProperty(key)) {\n                redactedObj[key] = redactValue(value[key]);\n            }\n        }\n        return redactedObj;\n    }\n    return value; // Return as-is for other types (numbers, booleans, null, etc.)\n}\n\n/**\n * Validates that a scope value doesn't contain the '#' character which is reserved for scope construction\n */\nfunction validateScopeValue(scopeValue: string | number | Record<string, string | number>, scopeType: string): void {\n    if (typeof scopeValue === 'string' && scopeValue.includes('#')) {\n        throw new Error(`Scope value cannot contain '#' character. Found in ${scopeType} scope value: ${scopeValue}`);\n    }\n    if (typeof scopeValue === 'object' && scopeValue !== null) {\n        for (const [key, value] of Object.entries(scopeValue)) {\n            if (typeof value === 'string' && value.includes('#')) {\n                throw new Error(`Scope value cannot contain '#' character. Found in ${scopeType}.${key}: ${value}`);\n            }\n        }\n    }\n}\n\n/**\n * Constructs a scope string from scopeType and scopeValue\n * @param scopeType - The type of scope (chatapp, agent, tool, entity, agent-entity)\n * @param scopeValue - The value(s) for the scope\n * @returns The constructed scope string\n */\nfunction constructScope(scopeType: string, scopeValue: string | number | Record<string, string | number>): string {\n    // Validate scope value doesn't contain '#'\n    validateScopeValue(scopeValue, scopeType);\n\n    switch (scopeType) {\n        case 'chatapp':\n        case 'agent':\n        case 'tool':\n        case 'entity':\n            return `${scopeType}#${scopeValue}`;\n        case 'agent-entity':\n            if (typeof scopeValue !== 'object' || scopeValue === null) {\n                throw new Error('agent-entity scopeType requires an object with agent and entity properties');\n            }\n\n            const agentEntityValue = scopeValue as Record<string, string | number>;\n            if (!('agent' in agentEntityValue) || !('entity' in agentEntityValue)) {\n                throw new Error('agent-entity scopeType requires an object with both agent and entity properties');\n            }\n\n            return `agent#${agentEntityValue.agent}#entity#${agentEntityValue.entity}`;\n\n        default:\n            throw new Error(`Unsupported scopeType: ${scopeType}`);\n    }\n}\n\n/**\n * Parses a scope string back into scopeType and scopeValue\n * @param scope - The scope string to parse\n * @returns Object containing scopeType and scopeValue\n */\nfunction parseScope(scope: string): { scopeType: string; scopeValue: string | number | Record<string, string | number> } {\n    if (!scope || typeof scope !== 'string') {\n        throw new Error('Invalid scope: must be a non-empty string');\n    }\n\n    const parts = scope.split('#');\n    if (parts.length < 2) {\n        throw new Error(`Invalid scope format: ${scope}. Expected format: scopeType#scopeValue`);\n    }\n\n    const [firstType, firstValue, ...remaining] = parts;\n\n    // Handle compound scopes (agent-entity)\n    if (remaining.length >= 2 && firstType === 'agent' && remaining[0] === 'entity') {\n        return {\n            scopeType: 'agent-entity',\n            scopeValue: {\n                agent: firstValue,\n                entity: remaining[1]\n            }\n        };\n    }\n\n    // Handle simple scopes\n    if (remaining.length === 0) {\n        // For simple scopes, try to convert to number if it's numeric\n        const numericValue = Number(firstValue);\n        const scopeValue = !isNaN(numericValue) && isFinite(numericValue) ? numericValue : firstValue;\n\n        return {\n            scopeType: firstType,\n            scopeValue: scopeValue\n        };\n    }\n\n    throw new Error(`Unsupported scope format: ${scope}`);\n}\n\n// Export both functions\nexport { redactData, redactValue, constructScope, parseScope };\n"]}

package/dist/util/server-client-utils.mjs

@@ -28,7 +28,68 @@ function redactValue(value) {
   }
   return value;
 }
+function validateScopeValue(scopeValue, scopeType) {
+  if (typeof scopeValue === "string" && scopeValue.includes("#")) {
+    throw new Error(`Scope value cannot contain '#' character. Found in ${scopeType} scope value: ${scopeValue}`);
+  }
+  if (typeof scopeValue === "object" && scopeValue !== null) {
+    for (const [key, value] of Object.entries(scopeValue)) {
+      if (typeof value === "string" && value.includes("#")) {
+        throw new Error(`Scope value cannot contain '#' character. Found in ${scopeType}.${key}: ${value}`);
+      }
+    }
+  }
+}
+function constructScope(scopeType, scopeValue) {
+  validateScopeValue(scopeValue, scopeType);
+  switch (scopeType) {
+    case "chatapp":
+    case "agent":
+    case "tool":
+    case "entity":
+      return `${scopeType}#${scopeValue}`;
+    case "agent-entity":
+      if (typeof scopeValue !== "object" || scopeValue === null) {
+        throw new Error("agent-entity scopeType requires an object with agent and entity properties");
+      }
+      const agentEntityValue = scopeValue;
+      if (!("agent" in agentEntityValue) || !("entity" in agentEntityValue)) {
+        throw new Error("agent-entity scopeType requires an object with both agent and entity properties");
+      }
+      return `agent#${agentEntityValue.agent}#entity#${agentEntityValue.entity}`;
+    default:
+      throw new Error(`Unsupported scopeType: ${scopeType}`);
+  }
+}
+function parseScope(scope) {
+  if (!scope || typeof scope !== "string") {
+    throw new Error("Invalid scope: must be a non-empty string");
+  }
+  const parts = scope.split("#");
+  if (parts.length < 2) {
+    throw new Error(`Invalid scope format: ${scope}. Expected format: scopeType#scopeValue`);
+  }
+  const [firstType, firstValue, ...remaining] = parts;
+  if (remaining.length >= 2 && firstType === "agent" && remaining[0] === "entity") {
+    return {
+      scopeType: "agent-entity",
+      scopeValue: {
+        agent: firstValue,
+        entity: remaining[1]
+      }
+    };
+  }
+  if (remaining.length === 0) {
+    const numericValue = Number(firstValue);
+    const scopeValue = !isNaN(numericValue) && isFinite(numericValue) ? numericValue : firstValue;
+    return {
+      scopeType: firstType,
+      scopeValue
+    };
+  }
+  throw new Error(`Unsupported scope format: ${scope}`);
+}
 
-export { redactData, redactValue };
+export { constructScope, parseScope, redactData, redactValue };
 //# sourceMappingURL=server-client-utils.mjs.map
 //# sourceMappingURL=server-client-utils.mjs.map