@promptbook/openai 0.48.0 → 0.49.0

package/README.md

@@ -5,12 +5,11 @@ Library to supercharge your use of large language models
 
 
 
-
 [![NPM Version of ![Promptbook logo - cube with letters P and B](./other/design/logo-h1.png) Promptbook](https://badge.fury.io/js/promptbook.svg)](https://www.npmjs.com/package/promptbook)
 [![Quality of package ![Promptbook logo - cube with letters P and B](./other/design/logo-h1.png) Promptbook](https://packagequality.com/shield/promptbook.svg)](https://packagequality.com/#?package=promptbook)
 [![Known Vulnerabilities](https://snyk.io/test/github/webgptorg/promptbook/badge.svg)](https://snyk.io/test/github/webgptorg/promptbook)
 [![Issues](https://img.shields.io/github/issues/webgptorg/promptbook.svg?style=flat)](https://github.com/webgptorg/promptbook/issues)
-[![Socket](https://socket.dev/api/badge/npm/package/promptbook)](https://socket.dev/npm/package/promptbook)
+
 
 [![Socket Badge](https://socket.dev/api/badge/npm/package/@promptbook/openai)](https://socket.dev/npm/package/@promptbook/openai)
 
@@ -662,9 +661,6 @@ GPTs are chat assistants that can be assigned to specific tasks and materials. B
 
 
 
-
-
-
 ### Where should I store my promptbooks?
 
 If you use raw SDKs, you just put prompts in the sourcecode, mixed in with typescript, javascript, python or whatever programming language you use.

package/esm/index.es.js

@@ -141,7 +141,7 @@ function computeOpenaiUsage(rawResponse) {
             completion: 0.03,
         },
     }[rawResponse.model];
-    // TODO: !!!!! Retrieve dynamically - post [ ]
+    // TODO: !!! Retrieve dynamically
     var price;
     if (pricePerThousandTokens === undefined) {
         price = 'UNKNOWN';

package/esm/typings/_packages/utils.index.d.ts

@@ -2,6 +2,7 @@ import { spaceTrim } from 'spacetrim';
 import { prettifyPromptbookString } from '../conversion/prettify/prettifyPromptbookString';
 import { renderPromptbookMermaid } from '../conversion/prettify/renderPromptbookMermaid';
 import { parseNumber } from '../conversion/utils/parseNumber';
+import { renameParameter } from '../conversion/utils/renameParameter';
 import { titleToName } from '../conversion/utils/titleToName';
 import { assertsExecutionSuccessful } from '../execution/assertsExecutionSuccessful';
 import { checkExpectations, isPassingExpectations } from '../execution/utils/checkExpectations';
@@ -58,7 +59,7 @@ export declare const normalizeTo: {
     'kebab-case': typeof normalizeToKebabCase;
 };
 export { capitalize, decapitalize, DIACRITIC_VARIANTS_LETTERS, IKeywords, isValidKeyword, nameToUriPart, nameToUriParts, normalizeTo_camelCase, normalizeTo_PascalCase, normalizeTo_SCREAMING_CASE, normalizeTo_snake_case, normalizeToKebabCase, normalizeWhitespaces, parseKeywords, parseKeywordsFromString, removeDiacritics, searchKeywords, string_keyword, titleToName, };
-export { renderPromptbookMermaid };
+export { renameParameter, renderPromptbookMermaid };
 /**
  * TODO: [🧠] Maybe create some indipendent package like `markdown-tools` from both here exported and @private utilities
  * Note: [🕙] It does not make sence to have simple lower / UPPER case normalization

package/esm/typings/conversion/prettify/renderPromptbookMermaid.d.ts

@@ -1,10 +1,23 @@
-import { PromptbookJson } from '../../_packages/types.index';
+import type { PromptbookJson, PromptTemplateJson } from '../../_packages/types.index';
+import type { string_href } from '../../types/typeAliases';
+/**
+ * Addtional options for rendering Mermaid graph
+ */
+export type renderPromptbookMermaidOptions = {
+    /**
+     * Callback for creating from prompt template graph node
+     */
+    linkPromptTemplate?(promptTemplate: PromptTemplateJson): {
+        href: string_href;
+        title: string;
+    } | null;
+};
 /**
  * Creates a Mermaid graph based on the promptbook
  *
  * Note: The result is not wrapped in a Markdown code block
  */
-export declare function renderPromptbookMermaid(promptbookJson: PromptbookJson): string;
+export declare function renderPromptbookMermaid(promptbookJson: PromptbookJson, options?: renderPromptbookMermaidOptions): string;
 /**
  * TODO: Maybe use some Mermaid library instead of string templating
  * TODO: [🕌] When more than 2 functionalities, split into separate functions

package/esm/typings/conversion/promptbookJsonToString.d.ts

@@ -1,8 +1,12 @@
 import type { PromptbookJson } from '../types/PromptbookJson/PromptbookJson';
 import type { PromptbookString } from '../types/PromptbookString';
+/**
+ * Converts promptbook in JSON format to string format
+ *
+ * @param promptbookJson Promptbook in JSON format (.ptbk.json)
+ * @returns Promptbook in string format (.ptbk.md)
+ */
 export declare function promptbookJsonToString(promptbookJson: PromptbookJson): PromptbookString;
 /**
- * TODO: !!!!! Implement
- * TODO: !!!!! Annotate and warn
- * TODO: !!!!! Test + test together with promptbookStringToJson
+ * TODO: Escape all
  */

package/esm/typings/conversion/utils/renameParameter.d.ts

@@ -0,0 +1,25 @@
+import type { PromptbookJson } from '../../types/PromptbookJson/PromptbookJson';
+import type { string_name } from '../../types/typeAliases';
+type RenameParameterOptions = {
+    /**
+     * Promptbook to search and replace for parameters
+     * This promptbook is returned as copy with replaced parameters
+     */
+    promptbook: PromptbookJson;
+    /**
+     * Original parameter name that should be replaced
+     */
+    oldParameterName: string_name;
+    /**
+     * New parameter name that should replace the original parameter name
+     */
+    newParameterName: string_name;
+};
+/**
+ * Function renameParameter will find all usable parameters for given prompt template
+ * In other words, it will find all parameters that are not used in the prompt template itseld and all its dependencies
+ *
+ * @throws {PromptbookLogicError} If the new parameter name is already used in the promptbook
+ */
+export declare function renameParameter(options: RenameParameterOptions): PromptbookJson;
+export {};

package/esm/typings/conversion/validation/_importPromptbook.d.ts

@@ -6,6 +6,7 @@ import { PromptbookString } from '../../types/PromptbookString';
  * Note: Using here custom import to work in jest tests
  * Note: Using sync version is 💩 in the production code, but it's ok here in tests
  *
+ * @param path - The path to the file relative to samples/templates directory
  * @private
  */
 export declare function importPromptbook(path: `${string}.ptbk.md`): PromptbookString;

package/esm/typings/conversion/validation/validatePromptbookJson.d.ts

@@ -1,6 +1,6 @@
 import type { PromptbookJson } from '../../types/PromptbookJson/PromptbookJson';
 /**
- * Validates PromptbookJson if it is logically valid.
+ * Validates PromptbookJson if it is logically valid
  *
  * It checks:
  * -   if it has correct parameters dependency
@@ -10,9 +10,10 @@ import type { PromptbookJson } from '../../types/PromptbookJson/PromptbookJson';
  * -   if it is meaningful
  *
  * @param promptbook valid or invalid PromptbookJson
+ * @returns the same promptbook if it is logically valid
  * @throws {PromptbookLogicError} on logical error in the promptbook
  */
-export declare function validatePromptbookJson(promptbook: PromptbookJson): void;
+export declare function validatePromptbookJson(promptbook: PromptbookJson): PromptbookJson;
 /**
  * TODO: [🧠] Work with promptbookVersion
  * TODO: Use here some json-schema, Zod or something similar and change it to:

package/esm/typings/types/PromptbookJson/PromptTemplateJson.d.ts

@@ -6,7 +6,7 @@ import type { number_integer, number_positive_or_zero, string_javascript, string
 /**
  * Describes one prompt template in the promptbook
  */
-export type PromptTemplateJson = LlmTemplateJson | SimpleTemplateJson | ScriptTemplateJson | PromptDialogJson;
+export type PromptTemplateJson = LlmTemplateJson | SimpleTemplateJson | ScriptJson | PromptDialogJson;
 /**
  * Template for prompt to LLM
  */
@@ -50,7 +50,7 @@ interface SimpleTemplateJson extends PromptTemplateJsonCommon {
 /**
  * Template for script execution
  */
-interface ScriptTemplateJson extends PromptTemplateJsonCommon {
+interface ScriptJson extends PromptTemplateJsonCommon {
     readonly executionType: 'SCRIPT';
     /**
      * Language of the script

package/esm/typings/utils/markdown/prettifyMarkdown.d.ts

@@ -2,7 +2,7 @@ import type { string_html } from '../../types/typeAliases';
 /**
  * Prettify the html code
  *
- * @param html raw html code
+ * @param content raw html code
  * @returns formatted html code
  */
-export declare function prettifyMarkdown(html: string_html): string_html;
+export declare function prettifyMarkdown<TContent extends string_html>(content: TContent): TContent;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/openai",
-    "version": "0.48.0",
+    "version": "0.49.0",
     "description": "Library to supercharge your use of large language models",
     "private": false,
     "sideEffects": false,
@@ -48,7 +48,7 @@
         }
     ],
     "peerDependencies": {
-        "@promptbook/core": "0.48.0"
+        "@promptbook/core": "0.49.0"
     },
     "main": "./umd/index.umd.js",
     "module": "./esm/index.es.js",

package/umd/index.umd.js

@@ -149,7 +149,7 @@
                 completion: 0.03,
             },
         }[rawResponse.model];
-        // TODO: !!!!! Retrieve dynamically - post [ ]
+        // TODO: !!! Retrieve dynamically
         var price;
         if (pricePerThousandTokens === undefined) {
             price = 'UNKNOWN';

package/umd/typings/_packages/utils.index.d.ts

@@ -2,6 +2,7 @@ import { spaceTrim } from 'spacetrim';
 import { prettifyPromptbookString } from '../conversion/prettify/prettifyPromptbookString';
 import { renderPromptbookMermaid } from '../conversion/prettify/renderPromptbookMermaid';
 import { parseNumber } from '../conversion/utils/parseNumber';
+import { renameParameter } from '../conversion/utils/renameParameter';
 import { titleToName } from '../conversion/utils/titleToName';
 import { assertsExecutionSuccessful } from '../execution/assertsExecutionSuccessful';
 import { checkExpectations, isPassingExpectations } from '../execution/utils/checkExpectations';
@@ -58,7 +59,7 @@ export declare const normalizeTo: {
     'kebab-case': typeof normalizeToKebabCase;
 };
 export { capitalize, decapitalize, DIACRITIC_VARIANTS_LETTERS, IKeywords, isValidKeyword, nameToUriPart, nameToUriParts, normalizeTo_camelCase, normalizeTo_PascalCase, normalizeTo_SCREAMING_CASE, normalizeTo_snake_case, normalizeToKebabCase, normalizeWhitespaces, parseKeywords, parseKeywordsFromString, removeDiacritics, searchKeywords, string_keyword, titleToName, };
-export { renderPromptbookMermaid };
+export { renameParameter, renderPromptbookMermaid };
 /**
  * TODO: [🧠] Maybe create some indipendent package like `markdown-tools` from both here exported and @private utilities
  * Note: [🕙] It does not make sence to have simple lower / UPPER case normalization

package/umd/typings/conversion/prettify/renderPromptbookMermaid.d.ts

@@ -1,10 +1,23 @@
-import { PromptbookJson } from '../../_packages/types.index';
+import type { PromptbookJson, PromptTemplateJson } from '../../_packages/types.index';
+import type { string_href } from '../../types/typeAliases';
+/**
+ * Addtional options for rendering Mermaid graph
+ */
+export type renderPromptbookMermaidOptions = {
+    /**
+     * Callback for creating from prompt template graph node
+     */
+    linkPromptTemplate?(promptTemplate: PromptTemplateJson): {
+        href: string_href;
+        title: string;
+    } | null;
+};
 /**
  * Creates a Mermaid graph based on the promptbook
  *
  * Note: The result is not wrapped in a Markdown code block
  */
-export declare function renderPromptbookMermaid(promptbookJson: PromptbookJson): string;
+export declare function renderPromptbookMermaid(promptbookJson: PromptbookJson, options?: renderPromptbookMermaidOptions): string;
 /**
  * TODO: Maybe use some Mermaid library instead of string templating
  * TODO: [🕌] When more than 2 functionalities, split into separate functions

package/umd/typings/conversion/promptbookJsonToString.d.ts

@@ -1,8 +1,12 @@
 import type { PromptbookJson } from '../types/PromptbookJson/PromptbookJson';
 import type { PromptbookString } from '../types/PromptbookString';
+/**
+ * Converts promptbook in JSON format to string format
+ *
+ * @param promptbookJson Promptbook in JSON format (.ptbk.json)
+ * @returns Promptbook in string format (.ptbk.md)
+ */
 export declare function promptbookJsonToString(promptbookJson: PromptbookJson): PromptbookString;
 /**
- * TODO: !!!!! Implement
- * TODO: !!!!! Annotate and warn
- * TODO: !!!!! Test + test together with promptbookStringToJson
+ * TODO: Escape all
  */

package/umd/typings/conversion/promptbookStringToJson.test.d.ts

@@ -0,0 +1 @@
+export {};

package/umd/typings/conversion/utils/renameParameter.d.ts

@@ -0,0 +1,25 @@
+import type { PromptbookJson } from '../../types/PromptbookJson/PromptbookJson';
+import type { string_name } from '../../types/typeAliases';
+type RenameParameterOptions = {
+    /**
+     * Promptbook to search and replace for parameters
+     * This promptbook is returned as copy with replaced parameters
+     */
+    promptbook: PromptbookJson;
+    /**
+     * Original parameter name that should be replaced
+     */
+    oldParameterName: string_name;
+    /**
+     * New parameter name that should replace the original parameter name
+     */
+    newParameterName: string_name;
+};
+/**
+ * Function renameParameter will find all usable parameters for given prompt template
+ * In other words, it will find all parameters that are not used in the prompt template itseld and all its dependencies
+ *
+ * @throws {PromptbookLogicError} If the new parameter name is already used in the promptbook
+ */
+export declare function renameParameter(options: RenameParameterOptions): PromptbookJson;
+export {};

package/umd/typings/conversion/utils/renameParameter.test.d.ts

@@ -0,0 +1 @@
+export {};

package/umd/typings/conversion/validation/_importPromptbook.d.ts

@@ -6,6 +6,7 @@ import { PromptbookString } from '../../types/PromptbookString';
  * Note: Using here custom import to work in jest tests
  * Note: Using sync version is 💩 in the production code, but it's ok here in tests
  *
+ * @param path - The path to the file relative to samples/templates directory
  * @private
  */
 export declare function importPromptbook(path: `${string}.ptbk.md`): PromptbookString;

package/umd/typings/conversion/validation/validatePromptbookJson.d.ts

@@ -1,6 +1,6 @@
 import type { PromptbookJson } from '../../types/PromptbookJson/PromptbookJson';
 /**
- * Validates PromptbookJson if it is logically valid.
+ * Validates PromptbookJson if it is logically valid
  *
  * It checks:
  * -   if it has correct parameters dependency
@@ -10,9 +10,10 @@ import type { PromptbookJson } from '../../types/PromptbookJson/PromptbookJson';
  * -   if it is meaningful
  *
  * @param promptbook valid or invalid PromptbookJson
+ * @returns the same promptbook if it is logically valid
  * @throws {PromptbookLogicError} on logical error in the promptbook
  */
-export declare function validatePromptbookJson(promptbook: PromptbookJson): void;
+export declare function validatePromptbookJson(promptbook: PromptbookJson): PromptbookJson;
 /**
  * TODO: [🧠] Work with promptbookVersion
  * TODO: Use here some json-schema, Zod or something similar and change it to:

package/umd/typings/types/PromptbookJson/PromptTemplateJson.d.ts

@@ -6,7 +6,7 @@ import type { number_integer, number_positive_or_zero, string_javascript, string
 /**
  * Describes one prompt template in the promptbook
  */
-export type PromptTemplateJson = LlmTemplateJson | SimpleTemplateJson | ScriptTemplateJson | PromptDialogJson;
+export type PromptTemplateJson = LlmTemplateJson | SimpleTemplateJson | ScriptJson | PromptDialogJson;
 /**
  * Template for prompt to LLM
  */
@@ -50,7 +50,7 @@ interface SimpleTemplateJson extends PromptTemplateJsonCommon {
 /**
  * Template for script execution
  */
-interface ScriptTemplateJson extends PromptTemplateJsonCommon {
+interface ScriptJson extends PromptTemplateJsonCommon {
     readonly executionType: 'SCRIPT';
     /**
      * Language of the script

package/umd/typings/utils/markdown/prettifyMarkdown.d.ts

@@ -2,7 +2,7 @@ import type { string_html } from '../../types/typeAliases';
 /**
  * Prettify the html code
  *
- * @param html raw html code
+ * @param content raw html code
  * @returns formatted html code
  */
-export declare function prettifyMarkdown(html: string_html): string_html;
+export declare function prettifyMarkdown<TContent extends string_html>(content: TContent): TContent;