@promptbook/openai 0.50.0-13 → 0.50.0-15

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

@@ -1,6 +1,8 @@
 import { spaceTrim } from 'spacetrim';
 import { prettifyPromptbookString } from '../conversion/prettify/prettifyPromptbookString';
 import { renderPromptbookMermaid } from '../conversion/prettify/renderPromptbookMermaid';
+import { extractParametersFromPromptTemplate } from '../conversion/utils/extractParametersFromPromptTemplate';
+import { extractVariables } from '../conversion/utils/extractVariables';
 import { parseNumber } from '../conversion/utils/parseNumber';
 import { renameParameter } from '../conversion/utils/renameParameter';
 import { titleToName } from '../conversion/utils/titleToName';
@@ -16,6 +18,7 @@ import { countPages } from '../utils/expectation-counters/countPages';
 import { countParagraphs } from '../utils/expectation-counters/countParagraphs';
 import { countSentences, splitIntoSentences } from '../utils/expectation-counters/countSentences';
 import { countWords } from '../utils/expectation-counters/countWords';
+import { extractParameters } from '../utils/extractParameters';
 import { isValidJsonString } from '../utils/isValidJsonString';
 import { extractAllBlocksFromMarkdown } from '../utils/markdown/extractAllBlocksFromMarkdown';
 import { extractAllListItemsFromMarkdown } from '../utils/markdown/extractAllListItemsFromMarkdown';
@@ -42,12 +45,15 @@ import { searchKeywords } from '../utils/normalization/searchKeywords';
 import { extractBlock } from '../utils/postprocessing/extractBlock';
 import { removeEmojis } from '../utils/removeEmojis';
 import { removeQuotes } from '../utils/removeQuotes';
+import { difference } from '../utils/sets/difference';
+import { intersection } from '../utils/sets/intersection';
+import { union } from '../utils/sets/union';
 import { trimCodeBlock } from '../utils/trimCodeBlock';
 import { trimEndOfCodeBlock } from '../utils/trimEndOfCodeBlock';
 import { unwrapResult } from '../utils/unwrapResult';
 export { assertsExecutionSuccessful, checkExpectations, executionReportJsonToString, ExecutionReportStringOptions, ExecutionReportStringOptionsDefaults, extractAllBlocksFromMarkdown, // <- [🌻]
 extractAllListItemsFromMarkdown, extractBlock, // <- [🌻]
-extractOneBlockFromMarkdown, isPassingExpectations, isValidJsonString, parseNumber, // <- [🌻]
+extractOneBlockFromMarkdown, extractParameters, extractVariables, isPassingExpectations, isValidJsonString, parseNumber, // <- [🌻]
 prettifyPromptbookString, removeContentComments, removeEmojis, removeMarkdownFormatting, removeQuotes, replaceParameters, spaceTrim, trimCodeBlock, trimEndOfCodeBlock, unwrapResult, };
 export { countCharacters, countLines, countPages, countParagraphs, countSentences, CountUtils, countWords };
 export { splitIntoSentences };
@@ -59,7 +65,8 @@ 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 { renameParameter, renderPromptbookMermaid };
+export { extractParametersFromPromptTemplate, renameParameter, renderPromptbookMermaid };
+export { difference, intersection, union };
 /**
  * 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/utils/extractParametersFromPromptTemplate.d.ts

@@ -0,0 +1,13 @@
+import { PromptTemplateJson } from '../../types/PromptbookJson/PromptTemplateJson';
+import { string_name } from '../../types/typeAliases';
+/**
+ * Parses the prompt template and returns the set of all used parameters
+ *
+ * @param promptTemplate the template with used parameters
+ * @returns the set of parameter names
+ * @throws {PromptbookSyntaxError} if the script is invalid
+ */
+export declare function extractParametersFromPromptTemplate(promptTemplate: Pick<PromptTemplateJson, 'title' | 'description' | 'executionType' | 'content'>): Set<string_name>;
+/**
+ * TODO: [🔣] If script require contentLanguage
+ */ 

package/esm/typings/conversion/utils/extractParametersFromPromptTemplate.test.d.ts

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

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

@@ -5,7 +5,8 @@ import { string_javascript, string_javascript_name } from '../../types/typeAlias
  * @param script from which to extract the variables
  * @returns the list of variable names
  * @throws {PromptbookSyntaxError} if the script is invalid
- *
- * @private within the promptbookStringToJson
  */
-export declare function extractVariables(script: string_javascript): Array<string_javascript_name>;
+export declare function extractVariables(script: string_javascript): Set<string_javascript_name>;
+/**
+ * TODO: [🔣] Support for multiple languages - python, java,...
+ */

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

@@ -32,7 +32,7 @@ export type Expectations = Partial<Record<Lowercase<ExpectationUnit>, {
 /**
  * Units of text measurement
  */
-export declare const EXPECTATION_UNITS: readonly ["CHARACTERS", "WORDS", "SENTENCES", "PARAGRAPHS", "LINES", "PAGES"];
+export declare const EXPECTATION_UNITS: readonly ["CHARACTERS", "WORDS", "SENTENCES", "LINES", "PARAGRAPHS", "PAGES"];
 /**
  * Unit of text measurement
  */

package/esm/typings/utils/extractParameters.d.ts

@@ -4,7 +4,5 @@ import { string_name, string_template } from '../types/typeAliases';
  *
  * @param template the template with parameters in {curly} braces
  * @returns the list of parameter names
- *
- * @private within the library
  */
-export declare function extractParameters(template: string_template): Array<string_name>;
+export declare function extractParameters(template: string_template): Set<string_name>;

package/esm/typings/utils/sets/difference.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Create difference set of two sets.
+ */
+export declare function difference<TItem>(a: Set<TItem>, b: Set<TItem>, isEqual?: (a: TItem, b: TItem) => boolean): Set<TItem>;

package/esm/typings/utils/sets/difference.test.d.ts

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

package/esm/typings/utils/sets/intersection.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Creates a new set with all elements that are present in all sets
+ */
+export declare function intersection<TItem>(...sets: Array<Set<TItem>>): Set<TItem>;

package/esm/typings/utils/sets/intersection.test.d.ts

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

package/esm/typings/utils/sets/union.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Creates a new set with all elements that are present in either set
+ */
+export declare function union<TItem>(...sets: Array<Set<TItem>>): Set<TItem>;

package/esm/typings/utils/sets/union.test.d.ts

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

package/package.json

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

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

@@ -1,6 +1,8 @@
 import { spaceTrim } from 'spacetrim';
 import { prettifyPromptbookString } from '../conversion/prettify/prettifyPromptbookString';
 import { renderPromptbookMermaid } from '../conversion/prettify/renderPromptbookMermaid';
+import { extractParametersFromPromptTemplate } from '../conversion/utils/extractParametersFromPromptTemplate';
+import { extractVariables } from '../conversion/utils/extractVariables';
 import { parseNumber } from '../conversion/utils/parseNumber';
 import { renameParameter } from '../conversion/utils/renameParameter';
 import { titleToName } from '../conversion/utils/titleToName';
@@ -16,6 +18,7 @@ import { countPages } from '../utils/expectation-counters/countPages';
 import { countParagraphs } from '../utils/expectation-counters/countParagraphs';
 import { countSentences, splitIntoSentences } from '../utils/expectation-counters/countSentences';
 import { countWords } from '../utils/expectation-counters/countWords';
+import { extractParameters } from '../utils/extractParameters';
 import { isValidJsonString } from '../utils/isValidJsonString';
 import { extractAllBlocksFromMarkdown } from '../utils/markdown/extractAllBlocksFromMarkdown';
 import { extractAllListItemsFromMarkdown } from '../utils/markdown/extractAllListItemsFromMarkdown';
@@ -42,12 +45,15 @@ import { searchKeywords } from '../utils/normalization/searchKeywords';
 import { extractBlock } from '../utils/postprocessing/extractBlock';
 import { removeEmojis } from '../utils/removeEmojis';
 import { removeQuotes } from '../utils/removeQuotes';
+import { difference } from '../utils/sets/difference';
+import { intersection } from '../utils/sets/intersection';
+import { union } from '../utils/sets/union';
 import { trimCodeBlock } from '../utils/trimCodeBlock';
 import { trimEndOfCodeBlock } from '../utils/trimEndOfCodeBlock';
 import { unwrapResult } from '../utils/unwrapResult';
 export { assertsExecutionSuccessful, checkExpectations, executionReportJsonToString, ExecutionReportStringOptions, ExecutionReportStringOptionsDefaults, extractAllBlocksFromMarkdown, // <- [🌻]
 extractAllListItemsFromMarkdown, extractBlock, // <- [🌻]
-extractOneBlockFromMarkdown, isPassingExpectations, isValidJsonString, parseNumber, // <- [🌻]
+extractOneBlockFromMarkdown, extractParameters, extractVariables, isPassingExpectations, isValidJsonString, parseNumber, // <- [🌻]
 prettifyPromptbookString, removeContentComments, removeEmojis, removeMarkdownFormatting, removeQuotes, replaceParameters, spaceTrim, trimCodeBlock, trimEndOfCodeBlock, unwrapResult, };
 export { countCharacters, countLines, countPages, countParagraphs, countSentences, CountUtils, countWords };
 export { splitIntoSentences };
@@ -59,7 +65,8 @@ 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 { renameParameter, renderPromptbookMermaid };
+export { extractParametersFromPromptTemplate, renameParameter, renderPromptbookMermaid };
+export { difference, intersection, union };
 /**
  * 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/utils/extractParametersFromPromptTemplate.d.ts

@@ -0,0 +1,13 @@
+import { PromptTemplateJson } from '../../types/PromptbookJson/PromptTemplateJson';
+import { string_name } from '../../types/typeAliases';
+/**
+ * Parses the prompt template and returns the set of all used parameters
+ *
+ * @param promptTemplate the template with used parameters
+ * @returns the set of parameter names
+ * @throws {PromptbookSyntaxError} if the script is invalid
+ */
+export declare function extractParametersFromPromptTemplate(promptTemplate: Pick<PromptTemplateJson, 'title' | 'description' | 'executionType' | 'content'>): Set<string_name>;
+/**
+ * TODO: [🔣] If script require contentLanguage
+ */ 

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

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

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

@@ -5,7 +5,8 @@ import { string_javascript, string_javascript_name } from '../../types/typeAlias
  * @param script from which to extract the variables
  * @returns the list of variable names
  * @throws {PromptbookSyntaxError} if the script is invalid
- *
- * @private within the promptbookStringToJson
  */
-export declare function extractVariables(script: string_javascript): Array<string_javascript_name>;
+export declare function extractVariables(script: string_javascript): Set<string_javascript_name>;
+/**
+ * TODO: [🔣] Support for multiple languages - python, java,...
+ */

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

@@ -32,7 +32,7 @@ export type Expectations = Partial<Record<Lowercase<ExpectationUnit>, {
 /**
  * Units of text measurement
  */
-export declare const EXPECTATION_UNITS: readonly ["CHARACTERS", "WORDS", "SENTENCES", "PARAGRAPHS", "LINES", "PAGES"];
+export declare const EXPECTATION_UNITS: readonly ["CHARACTERS", "WORDS", "SENTENCES", "LINES", "PARAGRAPHS", "PAGES"];
 /**
  * Unit of text measurement
  */

package/umd/typings/utils/extractParameters.d.ts

@@ -4,7 +4,5 @@ import { string_name, string_template } from '../types/typeAliases';
  *
  * @param template the template with parameters in {curly} braces
  * @returns the list of parameter names
- *
- * @private within the library
  */
-export declare function extractParameters(template: string_template): Array<string_name>;
+export declare function extractParameters(template: string_template): Set<string_name>;

package/umd/typings/utils/sets/difference.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Create difference set of two sets.
+ */
+export declare function difference<TItem>(a: Set<TItem>, b: Set<TItem>, isEqual?: (a: TItem, b: TItem) => boolean): Set<TItem>;

package/umd/typings/utils/sets/difference.test.d.ts

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

package/umd/typings/utils/sets/intersection.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Creates a new set with all elements that are present in all sets
+ */
+export declare function intersection<TItem>(...sets: Array<Set<TItem>>): Set<TItem>;

package/umd/typings/utils/sets/intersection.test.d.ts

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

package/umd/typings/utils/sets/union.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Creates a new set with all elements that are present in either set
+ */
+export declare function union<TItem>(...sets: Array<Set<TItem>>): Set<TItem>;

package/umd/typings/utils/sets/union.test.d.ts

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