pika-shared 1.0.2 → 1.1.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 {\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 {\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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pika-shared",
-  "version": "1.0.2",
+  "version": "1.1.0",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
   "types": "./dist/index.d.ts",

package/readme.md

@@ -1,3 +1,11 @@
 # Shared libraries go in here
 
 This is mostly for shared types and utilities.
+
+## Dev Instructions
+
+To publish...
+
+1. `pnpm run version:major` or `pnpm run version:minor` or `pnpm run version:patch`
+2. commit and push changes
+3. pnpm publish