@tstdl/base 0.93.76 → 0.93.77

package/ai/prompts/instructions-formatter.d.ts

@@ -1,25 +1,88 @@
+/**
+ * Defines the visual formatting style for a list of instructions.
+ * - `sections`: Renders keys as Markdown headers (e.g., `# Header`).
+ * - `ordered`: Renders items as a numbered list (e.g., `1. Item`).
+ * - `unordered`: Renders items as a bulleted list (e.g., `- Item`).
+ */
 export type ListStyle = 'sections' | 'ordered' | 'unordered';
-type InstructionsListContent = string[] | Instructions;
+/**
+ * The content of an instructions list, which can be either:
+ * - An array of strings (simple list items).
+ * - A nested `Instructions` object (key-value pairs or further lists).
+ */
+export type InstructionsListContent = string[] | Instructions;
+/**
+ * A container representing a specific grouping of instructions with a defined style.
+ * This is usually created via factory functions like `sections()`, `orderedList()`, or `unorderedList()`.
+ */
 export type InstructionsList = {
+    /** The rendering style to apply to this group. */
     style: ListStyle;
+    /** An optional high-level instruction or description associated with this group. */
     instruction?: string;
+    /** The content of the list, either an array of strings or a nested key-value map. */
     items: InstructionsListContent;
 };
+/**
+ * A recursive dictionary structure for defining structured instructions.
+ * Keys typically represent labels or headers, while values represent the content.
+ */
 export type Instructions = {
     [key: string]: string | string[] | InstructionsList | Instructions;
 };
+/**
+ * Creates a container where content is rendered as Markdown sections.
+ * Keys in the object map become headers (e.g., `# Key`), and nested items reset indentation.
+ *
+ * @param items - The content of the section.
+ */
 export declare function sections(items: InstructionsListContent): InstructionsList;
+/**
+ * Creates a container where content is rendered as Markdown sections with a preamble.
+ *
+ * @param instruction - A general instruction describing this section.
+ * @param items - The content of the section.
+ */
 export declare function sections(instruction: string, items: InstructionsListContent): InstructionsList;
+/**
+ * Creates a container rendered as a numbered list.
+ *
+ * @param items - The list items or map.
+ */
 export declare function orderedList(items: InstructionsListContent): InstructionsList;
+/**
+ * Creates a container rendered as a numbered list with a preamble.
+ *
+ * @param instruction - An instruction describing the list.
+ * @param items - The list items or map.
+ */
 export declare function orderedList(instruction: string, items: InstructionsListContent): InstructionsList;
+/**
+ * Creates a container rendered as a bulleted list.
+ *
+ * @param items - The list items or map.
+ */
 export declare function unorderedList(items: InstructionsListContent): InstructionsList;
+/**
+ * Creates a container rendered as a bulleted list with a preamble.
+ *
+ * @param instruction - An instruction describing the list.
+ * @param items - The list items or map.
+ */
 export declare function unorderedList(instruction: string, items: InstructionsListContent): InstructionsList;
 /**
- * Formats instructions into a string representation suitable for AI prompts.
- * @param node
- * @param options
+ * Formats a structured instructions object into a string representation suitable for AI prompts (Markdown).
+ *
+ * It recursively handles:
+ * - `sections`: Creates headers (H1, H2...).
+ * - `ordered` / `unordered`: Creates indented lists.
+ * - `Instructions`: Objects are formatted as key-value pairs (e.g., `- **Key:** Value`).
+ *
+ * @param node - The root instructions object, array, or instructions list wrapper.
+ * @param options - Formatting options.
+ * @param options.initialDepth - The starting indentation level (default: 0).
+ * @returns A formatted string.
  */
 export declare function formatInstructions(node: Instructions | InstructionsList | string[], options?: {
     initialDepth?: number;
 }): string;
-export {};

package/ai/prompts/instructions-formatter.js

@@ -146,9 +146,17 @@ function processNode(node, context) {
     }).join(separator);
 }
 /**
- * Formats instructions into a string representation suitable for AI prompts.
- * @param node
- * @param options
+ * Formats a structured instructions object into a string representation suitable for AI prompts (Markdown).
+ *
+ * It recursively handles:
+ * - `sections`: Creates headers (H1, H2...).
+ * - `ordered` / `unordered`: Creates indented lists.
+ * - `Instructions`: Objects are formatted as key-value pairs (e.g., `- **Key:** Value`).
+ *
+ * @param node - The root instructions object, array, or instructions list wrapper.
+ * @param options - Formatting options.
+ * @param options.initialDepth - The starting indentation level (default: 0).
+ * @returns A formatted string.
  */
 export function formatInstructions(node, options = {}) {
     // Heuristic: If passing a raw object, assume it's a Root Section unless specified otherwise.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tstdl/base",
-  "version": "0.93.76",
+  "version": "0.93.77",
   "author": "Patrick Hein",
   "publishConfig": {
     "access": "public"
@@ -150,7 +150,7 @@
     "@zxcvbn-ts/language-de": "^3.0",
     "@zxcvbn-ts/language-en": "^3.0",
     "drizzle-orm": "^0.45",
-    "file-type": "^21.1",
+    "file-type": "^21.3",
     "genkit": "^1.27",
     "handlebars": "^4.7",
     "minio": "^8.0",
@@ -181,13 +181,13 @@
     "concurrently": "9.2",
     "drizzle-kit": "0.31",
     "eslint": "9.39",
-    "globals": "16.5",
+    "globals": "17.0",
     "tsc-alias": "1.8",
     "typedoc-github-wiki-theme": "2.1",
     "typedoc-plugin-markdown": "4.9",
     "typedoc-plugin-missing-exports": "4.1",
     "typescript": "5.9",
-    "typescript-eslint": "8.50"
+    "typescript-eslint": "8.51"
   },
   "overrides": {
     "drizzle-kit": {