@promptbook/types 0.44.0-20 → 0.44.0-22

package/README.md

@@ -8,10 +8,39 @@ Library to supercharge your use of large language models
 [![License of 📖 Prompt book](https://img.shields.io/github/license/webgptorg/promptbook.svg?style=flat)](https://github.com/webgptorg/promptbook/blob/main/LICENSE)
 [![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 Badge](https://socket.dev/api/badge/npm/package/@promptbook/types)](https://socket.dev/npm/package/@promptbook/types)
 
 <!--/Badges-->
 
+## 📦 Package `@promptbook/types`
+
+- Promptbooks are [divided into several](#-packages) packages, all are published from [single monorepo](https://github.com/webgptorg/promptbook).
+- This package `@promptbook/types` is one part of the promptbook ecosystem.
+
+To install this package, run:
+
+```bash
+npm i -D @promptbook/types
+```
+
+This package is usefull when you want to explicitly define types in your code.
+
+```typescript
+import type { PromptbookJson } from '@promptbook/types';
+import { promptbookStringToJson } from '@promptbook/core';
+
+const promptbook: PromptbookJson = promptbookStringToJson(...);
+```
+
+
+---
+
+Rest of the documentation is common for **entire promptbook ecosystem**:
+
+<!--
+TODO: Probbably remove this section only in packages
 > ⚠ Warning: This library is still in early development.
+-->
 
 ## 🤍 Whitepaper
 
@@ -282,6 +311,22 @@ flowchart LR
 
 _Note: We are using [postprocessing functions](#postprocessing-functions) like `unwrapResult` that can be used to postprocess the result._
 
+## 📦 Packages
+
+This library is divided into several packages, all are published from [single monorepo](https://github.com/webgptorg/promptbook):
+
+<!--[🔠]-->
+
+-   **[@promptbook/core](https://www.npmjs.com/package/@promptbook/core)** - Core of the library, it contains the main logic for promptbooks
+-   **[@promptbook/utils](https://www.npmjs.com/package/@promptbook/utils)** - Utility functions used in the library but also useful for individual use in preprocessing and postprocessing LLM inputs and outputs
+-   _(Not finished)_ **[@promptbook/wizzard](https://www.npmjs.com/package/@promptbook/wizzard)** - Wizard for creating+running promptbooks in single line
+-   **[@promptbook/execute-javascript](https://www.npmjs.com/package/@promptbook/execute-javascript)** - Execution tools for javascript inside promptbooks
+-   **[@promptbook/openai](https://www.npmjs.com/package/@promptbook/openai)** - Execution tools for OpenAI API, wrapper around OpenAI SDK
+-   **[@promptbook/remote-client](https://www.npmjs.com/package/@promptbook/remote-client)** - Remote client for remote execution of promptbooks
+-   **[@promptbook/remote-server](https://www.npmjs.com/package/@promptbook/remote-server)** - Remote server for remote execution of promptbooks
+-   **[@promptbook/types](https://www.npmjs.com/package/@promptbook/types)** - Just typescript types used in the library
+-   **[@promptbook/cli](https://www.npmjs.com/package/@promptbook/cli)** - Command line interface utilities for promptbooks
+
 ## 📚 Dictionary
 
 The following glossary is used to clarify certain basic concepts:
@@ -667,6 +712,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<img style="height:22px!important;margin-left:3px;vertical-align:text-bottom;" src="https://mirrors.creativecommons.org/presskit/icons/cc.svg?ref=chooser-v1" alt=""><img style="height:22px!important;margin-left:3px;vertical-align:text-bottom;" src="https://mirrors.creativecommons.org/presskit/icons/by.svg?ref=chooser-v1" alt=""></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/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/types",
-    "version": "0.44.0-20",
+    "version": "0.44.0-22",
     "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-20"
+        "@promptbook/core": "0.44.0-22"
     },
     "main": "./umd/index.umd.js",
     "module": "./esm/index.es.js",