@promptbook/openai 0.32.0-2 → 0.32.1

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

@@ -1,7 +1,6 @@
 import { assertsExecutionSuccessful } from '../execution/assertsExecutionSuccessful';
 import { ExecutionReportStringOptions, ExecutionReportStringOptionsDefaults } from '../types/execution-report/ExecutionReportStringOptions';
 import { executionReportJsonToString } from '../types/execution-report/executionReportJsonToString';
-import { EMOJIS, EMOJIS_IN_CATEGORIES } from '../utils/emojis';
 import { CountUtils } from '../utils/expectation-counters';
 import { countCharacters } from '../utils/expectation-counters/countCharacters';
 import { countLines } from '../utils/expectation-counters/countLines';
@@ -21,8 +20,7 @@ import { removeQuotes } from '../utils/removeQuotes';
 import { trimCodeBlock } from '../utils/trimCodeBlock';
 import { trimEndOfCodeBlock } from '../utils/trimEndOfCodeBlock';
 import { unwrapResult } from '../utils/unwrapResult';
-export { CountUtils, EMOJIS, EMOJIS_IN_CATEGORIES, ExecutionReportStringOptions, ExecutionReportStringOptionsDefaults, assertsExecutionSuccessful, countCharacters, countLines, countPages, countParagraphs, countSentences, countWords, executionReportJsonToString, extractAllBlocksFromMarkdown, extractAllListItemsFromMarkdown, extractOneBlockFromMarkdown, isValidJsonString, parseNumber, removeContentComments, removeEmojis, removeMarkdownFormatting, removeQuotes, trimCodeBlock, trimEndOfCodeBlock, unwrapResult, };
+export { CountUtils, ExecutionReportStringOptions, ExecutionReportStringOptionsDefaults, assertsExecutionSuccessful, countCharacters, countLines, countPages, countParagraphs, countSentences, countWords, executionReportJsonToString, extractAllBlocksFromMarkdown, extractAllListItemsFromMarkdown, extractOneBlockFromMarkdown, isValidJsonString, parseNumber, removeContentComments, removeEmojis, removeMarkdownFormatting, removeQuotes, trimCodeBlock, trimEndOfCodeBlock, unwrapResult, };
 /**
- * TODO: !!!! prune utils in 32
  * TODO: [🧠] Maybe create some indipendent package like `markdown-tools` from both here exported and @private utilities
  */

package/esm/typings/types/execution-report/ExecutionReportStringOptions.d.ts

@@ -1,13 +1,21 @@
 import { number_percent } from '../typeAliases';
+/**
+ * Options for generating an execution report string
+ */
 export type ExecutionReportStringOptions = {
+    /**
+     * The tax rate to be applied, expressed as a percentage from 0 to 1 (=100%) or even more
+     */
     taxRate: number_percent;
+    /**
+     * The width of the charts in the report
+     */
     chartsWidth: number;
 };
+/**
+ * Default options for generating an execution report string
+ */
 export declare const ExecutionReportStringOptionsDefaults: {
     taxRate: number;
     chartsWidth: number;
 };
-/**
- *
- * !!! Annotate
- */

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

@@ -4,11 +4,15 @@ import { string_char_emoji } from '../types/typeAliasEmoji';
  * Note: this will be needed to update annually - now updated at 2022-01-19
  *
  * @see https://getemoji.com/
+ *
+ * @private within the library
  */
 export declare const EMOJIS_IN_CATEGORIES: Record<string, Array<string_char_emoji>>;
 /**
  *
  * All possible emoji chars like "🍆", "🍡", "🍤"...
+ *
+ * @private within the library
  */
 export declare const EMOJIS: Set<string_char_emoji>;
 /**

package/package.json

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

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

@@ -1,7 +1,6 @@
 import { assertsExecutionSuccessful } from '../execution/assertsExecutionSuccessful';
 import { ExecutionReportStringOptions, ExecutionReportStringOptionsDefaults } from '../types/execution-report/ExecutionReportStringOptions';
 import { executionReportJsonToString } from '../types/execution-report/executionReportJsonToString';
-import { EMOJIS, EMOJIS_IN_CATEGORIES } from '../utils/emojis';
 import { CountUtils } from '../utils/expectation-counters';
 import { countCharacters } from '../utils/expectation-counters/countCharacters';
 import { countLines } from '../utils/expectation-counters/countLines';
@@ -21,8 +20,7 @@ import { removeQuotes } from '../utils/removeQuotes';
 import { trimCodeBlock } from '../utils/trimCodeBlock';
 import { trimEndOfCodeBlock } from '../utils/trimEndOfCodeBlock';
 import { unwrapResult } from '../utils/unwrapResult';
-export { CountUtils, EMOJIS, EMOJIS_IN_CATEGORIES, ExecutionReportStringOptions, ExecutionReportStringOptionsDefaults, assertsExecutionSuccessful, countCharacters, countLines, countPages, countParagraphs, countSentences, countWords, executionReportJsonToString, extractAllBlocksFromMarkdown, extractAllListItemsFromMarkdown, extractOneBlockFromMarkdown, isValidJsonString, parseNumber, removeContentComments, removeEmojis, removeMarkdownFormatting, removeQuotes, trimCodeBlock, trimEndOfCodeBlock, unwrapResult, };
+export { CountUtils, ExecutionReportStringOptions, ExecutionReportStringOptionsDefaults, assertsExecutionSuccessful, countCharacters, countLines, countPages, countParagraphs, countSentences, countWords, executionReportJsonToString, extractAllBlocksFromMarkdown, extractAllListItemsFromMarkdown, extractOneBlockFromMarkdown, isValidJsonString, parseNumber, removeContentComments, removeEmojis, removeMarkdownFormatting, removeQuotes, trimCodeBlock, trimEndOfCodeBlock, unwrapResult, };
 /**
- * TODO: !!!! prune utils in 32
  * TODO: [🧠] Maybe create some indipendent package like `markdown-tools` from both here exported and @private utilities
  */

package/umd/typings/types/execution-report/ExecutionReportStringOptions.d.ts

@@ -1,13 +1,21 @@
 import { number_percent } from '../typeAliases';
+/**
+ * Options for generating an execution report string
+ */
 export type ExecutionReportStringOptions = {
+    /**
+     * The tax rate to be applied, expressed as a percentage from 0 to 1 (=100%) or even more
+     */
     taxRate: number_percent;
+    /**
+     * The width of the charts in the report
+     */
     chartsWidth: number;
 };
+/**
+ * Default options for generating an execution report string
+ */
 export declare const ExecutionReportStringOptionsDefaults: {
     taxRate: number;
     chartsWidth: number;
 };
-/**
- *
- * !!! Annotate
- */

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

@@ -4,11 +4,15 @@ import { string_char_emoji } from '../types/typeAliasEmoji';
  * Note: this will be needed to update annually - now updated at 2022-01-19
  *
  * @see https://getemoji.com/
+ *
+ * @private within the library
  */
 export declare const EMOJIS_IN_CATEGORIES: Record<string, Array<string_char_emoji>>;
 /**
  *
  * All possible emoji chars like "🍆", "🍡", "🍤"...
+ *
+ * @private within the library
  */
 export declare const EMOJIS: Set<string_char_emoji>;
 /**