@promptbook/types 0.44.0-21 → 0.44.0-23

package/README.md

@@ -35,7 +35,7 @@ const promptbook: PromptbookJson = promptbookStringToJson(...);
 
 ---
 
-Rest of the documentation is common for entire promptbook ecosystem:
+Rest of the documentation is common for **entire promptbook ecosystem**:
 
 <!--
 TODO: Probbably remove this section only in packages
@@ -431,8 +431,7 @@ Internally it can have multiple formats:
 ### Promptbook **Library**
 
 Library of all promptbooks used in your application.
-
-<!-- TODO: !!! Write more -->
+Each promptbook is a separate `.ptbk.md` file with unique `PROMPTBOOK URL`. Theese urls are used to reference promptbooks in other promptbooks or in the application code.
 
 ### Prompt Result
 
@@ -609,6 +608,30 @@ npm install --save @promptbook/wizzard
 -   [Simple usage](./samples/usage/simple-script)
 -   [Usage with client and remote server](./samples/usage/remote)
 
+## ➕➖ When to use Promptbook?
+
+### ➕ When to use
+
+-   When you are writing app that generates complex things via LLM - like **websites, articles, presentations, code, stories, songs**,...
+-   When you want to **separate code from text prompts**
+-   When you want to describe **complex prompt pipelines** and don't want to do it in the code
+-   When you want to **orchestrate multiple prompts** together
+-   When you want to **reuse** parts of prompts in multiple places
+-   When you want to **version** your prompts and **test multiple versions**
+-   When you want to **log** the execution of prompts and backtrace the issues
+
+### ➖ When not to use
+
+-   When you are writing just a simple chatbot without any extra logic, just system messages
+
+## 🐜 Known issues
+
+<!-- TODO:  -->
+
+## 🧼 Intentionally not implemented features
+
+<!-- TODO:  -->
+
 ## ❔ FAQ
 
 If you have a question [start a discussion](https://github.com/webgptorg/promptbook/discussions/), [open an issue](https://github.com/webgptorg/promptbook/issues) or [write me an email](https://www.pavolhejny.com/contact).
@@ -639,14 +662,14 @@ Include:
 GPTs are chat assistants that can be assigned to specific tasks and materials. But they are still chat assistants. Promptbooks are a way to orchestrate many more predefined tasks to have much tighter control over the process. Promptbooks are not a good technology for creating human-like chatbots, GPTs are not a good technology for creating outputs with specific requirements.
 
 <!--
-TODO:!!!
+TODO:
 ### Promptbooks vs. Semantic Kernel
 
 
 -->
 
 <!--
-TODO:
+TODO: !
 ### Promptbooks vs. Langtail
 
 
@@ -689,7 +712,7 @@ TODO: (Maybe)
 
 
 
-!!!!
+!
 
 
 
@@ -712,6 +735,10 @@ iterations
 
 See [CHANGELOG.md](./CHANGELOG.md)
 
+## 📜 License
+
+<p xmlns:cc="http://creativecommons.org/ns#" xmlns:dct="http://purl.org/dc/terms/"><a property="dct:title" rel="cc:attributionURL" href="https://github.com/webgptorg/promptbook">Promptbook</a> by <a rel="cc:attributionURL dct:creator" property="cc:attributionName" href="https://github.com/hejny/">Pavol Hejný</a> is licensed under <a href="https://creativecommons.org/licenses/by/4.0/?ref=chooser-v1" target="_blank" rel="license noopener noreferrer" style="display:inline-block;">CC BY 4.0</a></p>
+
 <!--Contributing-->
 <!--⚠️WARNING: This section was generated by https://github.com/hejny/batch-project-editor/blob/main/src/workflows/810-contributing/contributing.ts so every manual change will be overwritten.-->
 

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

@@ -1,3 +1,4 @@
+import { spaceTrim } from 'spacetrim';
 import { prettifyPromptbookString } from '../conversion/prettify/prettifyPromptbookString';
 import { parseNumber } from '../conversion/utils/parseNumber';
 import { assertsExecutionSuccessful } from '../execution/assertsExecutionSuccessful';
@@ -44,7 +45,7 @@ import { unwrapResult } from '../utils/unwrapResult';
 export { assertsExecutionSuccessful, checkExpectations, executionReportJsonToString, ExecutionReportStringOptions, ExecutionReportStringOptionsDefaults, extractAllBlocksFromMarkdown, // <- [🌻]
 extractAllListItemsFromMarkdown, extractBlock, // <- [🌻]
 extractOneBlockFromMarkdown, isPassingExpectations, isValidJsonString, parseNumber, // <- [🌻]
-prettifyPromptbookString, removeContentComments, removeEmojis, removeMarkdownFormatting, removeQuotes, replaceParameters, trimCodeBlock, trimEndOfCodeBlock, unwrapResult, };
+prettifyPromptbookString, removeContentComments, removeEmojis, removeMarkdownFormatting, removeQuotes, replaceParameters, spaceTrim, trimCodeBlock, trimEndOfCodeBlock, unwrapResult, };
 export { countCharacters, countLines, countPages, countParagraphs, countSentences, CountUtils, countWords };
 export { splitIntoSentences };
 export declare const normalizeTo: {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/types",
-    "version": "0.44.0-21",
+    "version": "0.44.0-23",
     "description": "Library to supercharge your use of large language models",
     "private": false,
     "sideEffects": false,
@@ -28,14 +28,14 @@
         "text-generation",
         "language-model"
     ],
-    "license": "SEE LICENSE IN LICENSE",
+    "license": "CC-BY-4.0",
     "bugs": {
         "url": "https://github.com/webgptorg/promptbook/issues"
     },
     "homepage": "https://www.npmjs.com/package/@promptbook/core",
     "dependencies": {},
     "peerDependencies": {
-        "@promptbook/core": "0.44.0-21"
+        "@promptbook/core": "0.44.0-23"
     },
     "main": "./umd/index.umd.js",
     "module": "./esm/index.es.js",

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

@@ -1,3 +1,4 @@
+import { spaceTrim } from 'spacetrim';
 import { prettifyPromptbookString } from '../conversion/prettify/prettifyPromptbookString';
 import { parseNumber } from '../conversion/utils/parseNumber';
 import { assertsExecutionSuccessful } from '../execution/assertsExecutionSuccessful';
@@ -44,7 +45,7 @@ import { unwrapResult } from '../utils/unwrapResult';
 export { assertsExecutionSuccessful, checkExpectations, executionReportJsonToString, ExecutionReportStringOptions, ExecutionReportStringOptionsDefaults, extractAllBlocksFromMarkdown, // <- [🌻]
 extractAllListItemsFromMarkdown, extractBlock, // <- [🌻]
 extractOneBlockFromMarkdown, isPassingExpectations, isValidJsonString, parseNumber, // <- [🌻]
-prettifyPromptbookString, removeContentComments, removeEmojis, removeMarkdownFormatting, removeQuotes, replaceParameters, trimCodeBlock, trimEndOfCodeBlock, unwrapResult, };
+prettifyPromptbookString, removeContentComments, removeEmojis, removeMarkdownFormatting, removeQuotes, replaceParameters, spaceTrim, trimCodeBlock, trimEndOfCodeBlock, unwrapResult, };
 export { countCharacters, countLines, countPages, countParagraphs, countSentences, CountUtils, countWords };
 export { splitIntoSentences };
 export declare const normalizeTo: {