@promptbook/openai 0.43.0 → 0.44.0-0

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

@@ -2,8 +2,8 @@ import { prettifyPromptbookString } from '../conversion/prettify/prettifyPromptb
 import { parseNumber } from '../conversion/utils/parseNumber';
 import { assertsExecutionSuccessful } from '../execution/assertsExecutionSuccessful';
 import { replaceParameters } from '../execution/utils/replaceParameters';
-import { ExecutionReportStringOptions, ExecutionReportStringOptionsDefaults } from '../types/execution-report/ExecutionReportStringOptions';
 import { executionReportJsonToString } from '../types/execution-report/executionReportJsonToString';
+import { ExecutionReportStringOptions, ExecutionReportStringOptionsDefaults } from '../types/execution-report/ExecutionReportStringOptions';
 import { CountUtils } from '../utils/expectation-counters';
 import { countCharacters } from '../utils/expectation-counters/countCharacters';
 import { countLines } from '../utils/expectation-counters/countLines';
@@ -27,6 +27,24 @@ export { assertsExecutionSuccessful, countCharacters, countLines, countPages, co
 extractAllListItemsFromMarkdown, extractBlock, // <- [🌻]
 extractOneBlockFromMarkdown, isValidJsonString, parseNumber, // <- [🌻]
 prettifyPromptbookString, removeContentComments, removeEmojis, removeMarkdownFormatting, removeQuotes, replaceParameters, trimCodeBlock, trimEndOfCodeBlock, unwrapResult, };
+import { capitalize } from '../utils/normalization/capitalize';
+import { decapitalize } from '../utils/normalization/decapitalize';
+import { DIACRITIC_VARIANTS_LETTERS } from '../utils/normalization/DIACRITIC_VARIANTS_LETTERS';
+import { IKeywords, string_keyword } from '../utils/normalization/IKeywords';
+import { isValidKeyword } from '../utils/normalization/isValidKeyword';
+import { nameToUriPart } from '../utils/normalization/nameToUriPart';
+import { nameToUriParts } from '../utils/normalization/nameToUriParts';
+import { normalizeToKebabCase } from '../utils/normalization/normalize-to-kebab-case';
+import { normalizeTo_camelCase } from '../utils/normalization/normalizeTo_camelCase';
+import { normalizeTo_PascalCase } from '../utils/normalization/normalizeTo_PascalCase';
+import { normalizeTo_SCREAMING_CASE } from '../utils/normalization/normalizeTo_SCREAMING_CASE';
+import { normalizeTo_snake_case } from '../utils/normalization/normalizeTo_snake_case';
+import { normalizeWhitespaces } from '../utils/normalization/normalizeWhitespaces';
+import { parseKeywords } from '../utils/normalization/parseKeywords';
+import { parseKeywordsFromString } from '../utils/normalization/parseKeywordsFromString';
+import { removeDiacritics } from '../utils/normalization/removeDiacritics';
+import { searchKeywords } from '../utils/normalization/searchKeywords';
+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, };
 /**
  * TODO: [🧠] Maybe create some indipendent package like `markdown-tools` from both here exported and @private utilities
  */

package/esm/typings/utils/normalization/DIACRITIC_VARIANTS_LETTERS.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Map of letters from diacritic variant to diacritless variant
+ * Contains lowercase and uppercase separatelly
+ *
+ * > "á" => "a"
+ * > "ě" => "e"
+ * > "Ă" => "A"
+ * > ...
+ */
+export declare const DIACRITIC_VARIANTS_LETTERS: Record<string, string>;

package/esm/typings/utils/normalization/IKeywords.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Semantic helper
+ *
+ * Keyword is string without diacritics in lowercase [a-z1-9]
+ * Words are splitted between multiple keywords @see IKeywords
+ *
+ * For example `"keyword"`
+ */
+export type string_keyword = string;
+/**
+ * Semantic helper
+ * Set of keywords @see string_keyword
+ *
+ */
+export type IKeywords = Set<string_keyword>;
+/**
+ * TODO: [🌮] Keywords with weight
+ */

package/esm/typings/utils/normalization/capitalize.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Makes first letter of a string uppercase
+ *
+ */
+export declare function capitalize(word: string): string;

package/esm/typings/utils/normalization/capitalize.test.d.ts

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

package/esm/typings/utils/normalization/decapitalize.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Makes first letter of a string uppercase
+ *
+ */
+export declare function decapitalize(word: string): string;

package/esm/typings/utils/normalization/decapitalize.test.d.ts

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

package/esm/typings/utils/normalization/isValidKeyword.d.ts

@@ -0,0 +1,8 @@
+import { string_keyword } from './IKeywords';
+/**
+ * Tests if keyword is valid
+ *
+ * @param keyword to test
+ * @returns if keyword is valid or not
+ */
+export declare function isValidKeyword(keyword: string): keyword is string_keyword;

package/esm/typings/utils/normalization/isValidKeyword.test.d.ts

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

package/esm/typings/utils/normalization/nameToUriPart.d.ts

@@ -0,0 +1 @@
+export declare function nameToUriPart(name: string): string;

package/esm/typings/utils/normalization/nameToUriPart.test.d.ts

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

package/esm/typings/utils/normalization/nameToUriParts.d.ts

@@ -0,0 +1 @@
+export declare function nameToUriParts(name: string): string[];

package/esm/typings/utils/normalization/nameToUriParts.test.d.ts

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

package/esm/typings/utils/normalization/normalize-to-kebab-case.d.ts

@@ -0,0 +1 @@
+export declare function normalizeToKebabCase(sentence: string): string;

package/esm/typings/utils/normalization/normalize-to-kebab-case.test.d.ts

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

package/esm/typings/utils/normalization/normalizeTo_PascalCase.d.ts

@@ -0,0 +1 @@
+export declare function normalizeTo_PascalCase(sentence: string): string;

package/esm/typings/utils/normalization/normalizeTo_PascalCase.test.d.ts

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

package/esm/typings/utils/normalization/normalizeTo_SCREAMING_CASE.d.ts

@@ -0,0 +1,4 @@
+export declare function normalizeTo_SCREAMING_CASE(sentence: string): string;
+/**
+ * TODO: [🌺] Use some intermediate util splitWords
+ */

package/esm/typings/utils/normalization/normalizeTo_SCREAMING_CASE.test.d.ts

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

package/esm/typings/utils/normalization/normalizeTo_camelCase.d.ts

@@ -0,0 +1,4 @@
+export declare function normalizeTo_camelCase(sentence: string, __firstLetterCapital?: boolean): string;
+/**
+ * TODO: [🌺] Use some intermediate util splitWords
+ */

package/esm/typings/utils/normalization/normalizeTo_camelCase.test.d.ts

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

package/esm/typings/utils/normalization/normalizeTo_snake_case.d.ts

@@ -0,0 +1 @@
+export declare function normalizeTo_snake_case(sentence: string): string;

package/esm/typings/utils/normalization/normalizeTo_snake_case.test.d.ts

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

package/esm/typings/utils/normalization/normalizeWhitespaces.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Take every whitespace (space, new line, tab) and replace it with a single space.
+ */
+export declare function normalizeWhitespaces(sentence: string): string;

package/esm/typings/utils/normalization/normalizeWhitespaces.test.d.ts

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

package/esm/typings/utils/normalization/parseKeywords.d.ts

@@ -0,0 +1,14 @@
+import { IKeywords } from './IKeywords';
+/**
+ * Parses keywords from any object and recursively walks through
+ *
+ * Tip: If you want to parse multiple inputs, just wrap them in an array
+ *
+ * @param input of any kind
+ * @returns {Set} of keywords without diacritics in lowercase
+ */
+export declare function parseKeywords(input: unknown): IKeywords;
+/**
+ * Note: Not using spread in input param because of keeping second parameter for options
+ * TODO: [🌺] Use some intermediate util splitWords
+ */

package/esm/typings/utils/normalization/parseKeywords.test.d.ts

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

package/esm/typings/utils/normalization/parseKeywordsFromString.d.ts

@@ -0,0 +1,8 @@
+import { IKeywords } from './IKeywords';
+/**
+ * Parses keywords from a string
+ *
+ * @param {string} input
+ * @returns {Set} of keywords without diacritics in lowercase
+ */
+export declare function parseKeywordsFromString(input: string): IKeywords;

package/esm/typings/utils/normalization/parseKeywordsFromString.test.d.ts

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

package/esm/typings/utils/normalization/removeDiacritics.d.ts

@@ -0,0 +1,4 @@
+/**
+ *
+ */
+export declare function removeDiacritics(input: string): string;

package/esm/typings/utils/normalization/removeDiacritics.test.d.ts

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

package/esm/typings/utils/normalization/searchKeywords.d.ts

@@ -0,0 +1,5 @@
+import { IKeywords } from './IKeywords';
+/**
+ *
+ */
+export declare function searchKeywords(haystack: IKeywords, needle: IKeywords): boolean;

package/esm/typings/utils/normalization/searchKeywords.test.d.ts

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

package/package.json

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

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

@@ -2,8 +2,8 @@ import { prettifyPromptbookString } from '../conversion/prettify/prettifyPromptb
 import { parseNumber } from '../conversion/utils/parseNumber';
 import { assertsExecutionSuccessful } from '../execution/assertsExecutionSuccessful';
 import { replaceParameters } from '../execution/utils/replaceParameters';
-import { ExecutionReportStringOptions, ExecutionReportStringOptionsDefaults } from '../types/execution-report/ExecutionReportStringOptions';
 import { executionReportJsonToString } from '../types/execution-report/executionReportJsonToString';
+import { ExecutionReportStringOptions, ExecutionReportStringOptionsDefaults } from '../types/execution-report/ExecutionReportStringOptions';
 import { CountUtils } from '../utils/expectation-counters';
 import { countCharacters } from '../utils/expectation-counters/countCharacters';
 import { countLines } from '../utils/expectation-counters/countLines';
@@ -27,6 +27,24 @@ export { assertsExecutionSuccessful, countCharacters, countLines, countPages, co
 extractAllListItemsFromMarkdown, extractBlock, // <- [🌻]
 extractOneBlockFromMarkdown, isValidJsonString, parseNumber, // <- [🌻]
 prettifyPromptbookString, removeContentComments, removeEmojis, removeMarkdownFormatting, removeQuotes, replaceParameters, trimCodeBlock, trimEndOfCodeBlock, unwrapResult, };
+import { capitalize } from '../utils/normalization/capitalize';
+import { decapitalize } from '../utils/normalization/decapitalize';
+import { DIACRITIC_VARIANTS_LETTERS } from '../utils/normalization/DIACRITIC_VARIANTS_LETTERS';
+import { IKeywords, string_keyword } from '../utils/normalization/IKeywords';
+import { isValidKeyword } from '../utils/normalization/isValidKeyword';
+import { nameToUriPart } from '../utils/normalization/nameToUriPart';
+import { nameToUriParts } from '../utils/normalization/nameToUriParts';
+import { normalizeToKebabCase } from '../utils/normalization/normalize-to-kebab-case';
+import { normalizeTo_camelCase } from '../utils/normalization/normalizeTo_camelCase';
+import { normalizeTo_PascalCase } from '../utils/normalization/normalizeTo_PascalCase';
+import { normalizeTo_SCREAMING_CASE } from '../utils/normalization/normalizeTo_SCREAMING_CASE';
+import { normalizeTo_snake_case } from '../utils/normalization/normalizeTo_snake_case';
+import { normalizeWhitespaces } from '../utils/normalization/normalizeWhitespaces';
+import { parseKeywords } from '../utils/normalization/parseKeywords';
+import { parseKeywordsFromString } from '../utils/normalization/parseKeywordsFromString';
+import { removeDiacritics } from '../utils/normalization/removeDiacritics';
+import { searchKeywords } from '../utils/normalization/searchKeywords';
+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, };
 /**
  * TODO: [🧠] Maybe create some indipendent package like `markdown-tools` from both here exported and @private utilities
  */

package/umd/typings/utils/normalization/DIACRITIC_VARIANTS_LETTERS.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Map of letters from diacritic variant to diacritless variant
+ * Contains lowercase and uppercase separatelly
+ *
+ * > "á" => "a"
+ * > "ě" => "e"
+ * > "Ă" => "A"
+ * > ...
+ */
+export declare const DIACRITIC_VARIANTS_LETTERS: Record<string, string>;

package/umd/typings/utils/normalization/IKeywords.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Semantic helper
+ *
+ * Keyword is string without diacritics in lowercase [a-z1-9]
+ * Words are splitted between multiple keywords @see IKeywords
+ *
+ * For example `"keyword"`
+ */
+export type string_keyword = string;
+/**
+ * Semantic helper
+ * Set of keywords @see string_keyword
+ *
+ */
+export type IKeywords = Set<string_keyword>;
+/**
+ * TODO: [🌮] Keywords with weight
+ */

package/umd/typings/utils/normalization/capitalize.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Makes first letter of a string uppercase
+ *
+ */
+export declare function capitalize(word: string): string;

package/umd/typings/utils/normalization/capitalize.test.d.ts

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

package/umd/typings/utils/normalization/decapitalize.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Makes first letter of a string uppercase
+ *
+ */
+export declare function decapitalize(word: string): string;

package/umd/typings/utils/normalization/decapitalize.test.d.ts

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

package/umd/typings/utils/normalization/isValidKeyword.d.ts

@@ -0,0 +1,8 @@
+import { string_keyword } from './IKeywords';
+/**
+ * Tests if keyword is valid
+ *
+ * @param keyword to test
+ * @returns if keyword is valid or not
+ */
+export declare function isValidKeyword(keyword: string): keyword is string_keyword;

package/umd/typings/utils/normalization/isValidKeyword.test.d.ts

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

package/umd/typings/utils/normalization/nameToUriPart.d.ts

@@ -0,0 +1 @@
+export declare function nameToUriPart(name: string): string;

package/umd/typings/utils/normalization/nameToUriPart.test.d.ts

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

package/umd/typings/utils/normalization/nameToUriParts.d.ts

@@ -0,0 +1 @@
+export declare function nameToUriParts(name: string): string[];

package/umd/typings/utils/normalization/nameToUriParts.test.d.ts

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

package/umd/typings/utils/normalization/normalize-to-kebab-case.d.ts

@@ -0,0 +1 @@
+export declare function normalizeToKebabCase(sentence: string): string;

package/umd/typings/utils/normalization/normalize-to-kebab-case.test.d.ts

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

package/umd/typings/utils/normalization/normalizeTo_PascalCase.d.ts

@@ -0,0 +1 @@
+export declare function normalizeTo_PascalCase(sentence: string): string;

package/umd/typings/utils/normalization/normalizeTo_PascalCase.test.d.ts

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

package/umd/typings/utils/normalization/normalizeTo_SCREAMING_CASE.d.ts

@@ -0,0 +1,4 @@
+export declare function normalizeTo_SCREAMING_CASE(sentence: string): string;
+/**
+ * TODO: [🌺] Use some intermediate util splitWords
+ */

package/umd/typings/utils/normalization/normalizeTo_SCREAMING_CASE.test.d.ts

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

package/umd/typings/utils/normalization/normalizeTo_camelCase.d.ts

@@ -0,0 +1,4 @@
+export declare function normalizeTo_camelCase(sentence: string, __firstLetterCapital?: boolean): string;
+/**
+ * TODO: [🌺] Use some intermediate util splitWords
+ */

package/umd/typings/utils/normalization/normalizeTo_camelCase.test.d.ts

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

package/umd/typings/utils/normalization/normalizeTo_snake_case.d.ts

@@ -0,0 +1 @@
+export declare function normalizeTo_snake_case(sentence: string): string;

package/umd/typings/utils/normalization/normalizeTo_snake_case.test.d.ts

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

package/umd/typings/utils/normalization/normalizeWhitespaces.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Take every whitespace (space, new line, tab) and replace it with a single space.
+ */
+export declare function normalizeWhitespaces(sentence: string): string;

package/umd/typings/utils/normalization/normalizeWhitespaces.test.d.ts

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

package/umd/typings/utils/normalization/parseKeywords.d.ts

@@ -0,0 +1,14 @@
+import { IKeywords } from './IKeywords';
+/**
+ * Parses keywords from any object and recursively walks through
+ *
+ * Tip: If you want to parse multiple inputs, just wrap them in an array
+ *
+ * @param input of any kind
+ * @returns {Set} of keywords without diacritics in lowercase
+ */
+export declare function parseKeywords(input: unknown): IKeywords;
+/**
+ * Note: Not using spread in input param because of keeping second parameter for options
+ * TODO: [🌺] Use some intermediate util splitWords
+ */

package/umd/typings/utils/normalization/parseKeywords.test.d.ts

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

package/umd/typings/utils/normalization/parseKeywordsFromString.d.ts

@@ -0,0 +1,8 @@
+import { IKeywords } from './IKeywords';
+/**
+ * Parses keywords from a string
+ *
+ * @param {string} input
+ * @returns {Set} of keywords without diacritics in lowercase
+ */
+export declare function parseKeywordsFromString(input: string): IKeywords;

package/umd/typings/utils/normalization/parseKeywordsFromString.test.d.ts

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

package/umd/typings/utils/normalization/removeDiacritics.d.ts

@@ -0,0 +1,4 @@
+/**
+ *
+ */
+export declare function removeDiacritics(input: string): string;

package/umd/typings/utils/normalization/removeDiacritics.test.d.ts

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

package/umd/typings/utils/normalization/searchKeywords.d.ts

@@ -0,0 +1,5 @@
+import { IKeywords } from './IKeywords';
+/**
+ *
+ */
+export declare function searchKeywords(haystack: IKeywords, needle: IKeywords): boolean;

package/umd/typings/utils/normalization/searchKeywords.test.d.ts

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