@promptbook/openai 0.85.0 → 0.86.0-11

package/README.md

@@ -16,6 +16,7 @@
 
 ## 🌟 New Features
 
+-   📂 We have plugin for [VSCode](https://github.com/webgptorg/book-extension) to support `.book` file extension
 -   💫 Support of [`o3-mini` model by OpenAI](https://openai.com/index/openai-o3-mini/)
 -   🐋 **Support of [DeepSeek models](https://www.npmjs.com/package/@promptbook/deepseek)**
 -   💙 Working [the **Book** language v1.0.0](https://github.com/webgptorg/book)
@@ -24,6 +25,10 @@
 
 
 
+<blockquote style="color: #ff8811">
+    <b>⚠ Warning:</b> This is a pre-release version of the library. It is not yet ready for production use. Please look at <a href="https://www.npmjs.com/package/@promptbook/core?activeTab=versions">latest stable release</a>.
+</blockquote>
+
 ## 📦 Package `@promptbook/openai`
 
 - Promptbooks are [divided into several](#-packages) packages, all are published from [single monorepo](https://github.com/webgptorg/promptbook).
@@ -74,7 +79,7 @@ const tools = {
 const collection = await createCollectionFromDirectory('./books', tools);
 
 // ▶ Get single Pipeline
-const pipeline = await collection.getPipelineByUrl(`https://promptbook.studio/my-collection/write-article.book.md`);
+const pipeline = await collection.getPipelineByUrl(`https://promptbook.studio/my-collection/write-article.book`);
 
 // ▶ Create executor - the function that will execute the Pipeline
 const pipelineExecutor = createPipelineExecutor({ pipeline, tools });
@@ -108,7 +113,7 @@ import { wizzard } from '@promptbook/wizzard';
 
 const {
     outputParameters: { joke },
-} = await wizzard.execute(`https://github.com/webgptorg/book/blob/main/books/templates/generic.book.md`, {
+} = await wizzard.execute(`https://github.com/webgptorg/book/blob/main/books/templates/generic.book`, {
     topic: 'Prague',
 });
 
@@ -137,7 +142,7 @@ const tools = await $provideExecutionToolsForNode();
 const collection = await createCollectionFromDirectory('./books', tools);
 
 // ▶ Get single Pipeline
-const pipeline = await collection.getPipelineByUrl(`https://promptbook.studio/my-collection/write-article.book.md`);
+const pipeline = await collection.getPipelineByUrl(`https://promptbook.studio/my-collection/write-article.book`);
 
 // ▶ Create executor - the function that will execute the Pipeline
 const pipelineExecutor = createPipelineExecutor({ pipeline, tools });
@@ -209,7 +214,7 @@ const tools = {
 const collection = await createCollectionFromDirectory('./books', tools);
 
 // ▶ Get single Pipeline
-const pipeline = await collection.getPipelineByUrl(`https://promptbook.studio/my-collection/write-article.book.md`);
+const pipeline = await collection.getPipelineByUrl(`https://promptbook.studio/my-collection/write-article.book`);
 
 // ▶ Create executor - the function that will execute the Pipeline
 const pipelineExecutor = createPipelineExecutor({ pipeline, tools });
@@ -254,7 +259,7 @@ Rest of the documentation is common for **entire promptbook ecosystem**:
 
 During the computer revolution, we have seen [multiple generations of computer languages](https://github.com/webgptorg/promptbook/discussions/180), from the physical rewiring of the vacuum tubes through low-level machine code to the high-level languages like Python or JavaScript. And now, we're on the edge of the **next revolution**!
 
-It's a revolution of writing software in plain human language that is understandable and executable by both humans and machines – and it's going to change everything!
+It's a revolution of writing software in **plain human language** that is understandable and executable by both humans and machines – and it's going to change everything!
 
 The incredible growth in power of microprocessors and the Moore's Law have been the driving force behind the ever-more powerful languages, and it's been an amazing journey! Similarly, the large language models (like GPT or Claude) are the next big thing in language technology, and they're set to transform the way we interact with computers.
 
@@ -283,41 +288,24 @@ Promptbook project is ecosystem of multiple projects and tools, following is a l
   <thead>
     <tr>
       <th>Project</th>
-      <th>Description</th>
-      <th>Link</th>
+      <th>About</th>
     </tr>
   </thead>
   <tbody>
     <tr>
-      <td>Core</td>
-      <td>Promptbook Core is a description and documentation of the basic concepts, ideas and inner workings of how Promptbook should be implemented, and defines what features must be describable by book language.</td>
-      <td rowspan=2>https://github.com/webgptorg/book</td>
-    </tr>
-    <tr>
-      <td>Book language</td>
+      <td><a href="https://github.com/webgptorg/book">Book language</a></td>
       <td>
-          Book is a markdown-like language to define core entities like projects, pipelines, knowledge,.... It is designed to be understandable by non-programmers and non-technical people
+          Book is a markdown-like language to define core entities like personas, knowledge, tasks,.... It is designed to be understandable by non-programmers and non-technical people<hr>
+          There is also <a href="https://github.com/webgptorg/book-extension">a plugin for VSCode</a> to support <code>.book</code> file extension
       </td>
     </tr>
     <tr>
-      <td>Promptbook typescript project</td>
-      <td>Promptbook implementation in TypeScript released as multiple NPM packages</td>
-      <td>https://github.com/webgptorg/promptbook + <a href="https://www.npmjs.com/package/@promptbook/core#-packages-for-developers">Multiple packages published on NPM</a></td>
+      <td><a href="https://github.com/webgptorg/promptbook">Promptbook Engine</a></td>
+      <td>Promptbook implementation in TypeScript released as <a href="https://www.npmjs.com/package/@promptbook/core#-packages-for-developers">multiple NPM packages</a> and <a href="https://hub.docker.com/r/hejny/promptbook">Docker HUB</a></td>
     </tr>
     <tr>
-      <td>Promptbook studio</td>
+      <td><a href="https://promptbook.studio">Promptbook Studio</a></td>
       <td>Studio to write Books and instantly publish them as miniapps</td>
-      <td>
-        https://promptbook.studio<br/>
-        https://github.com/hejny/promptbook-studio</td>
-      </tr><tr>
-      <td>Hello World</td>
-      <td>Simple starter kit with Books integrated into the sample applications</td>
-       <td>
-          https://github.com/webgptorg/hello-world<br/>
-          https://github.com/webgptorg/hello-world-node-js<br/>
-          https://github.com/webgptorg/hello-world-next-js
-       </td>
     </tr>
   </tbody>
 </table>

package/esm/index.es.js

@@ -16,7 +16,7 @@ var BOOK_LANGUAGE_VERSION = '1.0.0';
  * @generated
  * @see https://github.com/webgptorg/promptbook
  */
-var PROMPTBOOK_ENGINE_VERSION = '0.85.0-16';
+var PROMPTBOOK_ENGINE_VERSION = '0.86.0-10';
 /**
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
  * Note: [💞] Ignore a discrepancy between file name and entity name

package/esm/typings/src/cli/promptbookCli.d.ts

@@ -5,7 +5,7 @@
  */
 export declare function promptbookCli(): Promise<void>;
 /**
- * TODO: [🧠] Maybe `run` command the default, instead of `ptbk run ./foo.book.md` -> `ptbk ./foo.book.md`
+ * TODO: [🧠] Maybe `run` command the default, instead of `ptbk run ./foo.book` -> `ptbk ./foo.book`
  * TODO: [🥠] Do not export, its just for CLI script
  * TODO: [🕌] When more functionalities, rename
  * Note: 11:11

package/esm/typings/src/collection/collectionToJson.test.d.ts

@@ -1,6 +1,6 @@
 export {};
 /**
- * Note: [🐠] For example here URL https://example.com/pipeline.book.md is not valid
+ * Note: [🐠] For example here URL https://example.com/pipeline.book is not valid
  *       because it is on private network BUT its very hard to debug because
  *       there is no error message and false return (the error) happen deep in:
  *       `isValidPipelineUrl` -> `isValidPipelineUrl` -> `isUrlOnPrivateNetwork`

package/esm/typings/src/collection/constructors/createCollectionFromDirectory.d.ts

@@ -6,7 +6,7 @@ import type { PipelineCollection } from '../PipelineCollection';
 /**
  * Options for `createCollectionFromDirectory` function
  *
- * Note: `rootDirname` is not needed because it is the folder in which `.book` or `.book.md` file is located
+ * Note: `rootDirname` is not needed because it is the folder in which `.book` or `.book` file is located
  *       This is not same as `path` which is the first argument of `createCollectionFromDirectory` - it can be a subfolder
  */
 type CreatePipelineCollectionFromDirectoryOptions = Omit<PrepareAndScrapeOptions, 'rootDirname'> & {

package/esm/typings/src/commands/FOREACH/foreachCommandParser.d.ts

@@ -3,7 +3,7 @@ import type { ForeachCommand } from './ForeachCommand';
 /**
  * Parses the foreach command
  *
- * Note: @@@ This command is used as foreach for new commands - it should NOT be used in any `.book.md` file
+ * Note: @@@ This command is used as foreach for new commands - it should NOT be used in any `.book` file
  *
  * @see `documentationUrl` for more details
  * @public exported from `@promptbook/editable`

package/esm/typings/src/commands/FORMFACTOR/formfactorCommandParser.d.ts

@@ -3,7 +3,7 @@ import type { FormfactorCommand } from './FormfactorCommand';
 /**
  * Parses the formfactor command
  *
- * Note: @@@ This command is used as formfactor for new commands - it should NOT be used in any `.book.md` file
+ * Note: @@@ This command is used as formfactor for new commands - it should NOT be used in any `.book` file
  *
  * @see `documentationUrl` for more details
  * @public exported from `@promptbook/editable`

package/esm/typings/src/commands/_BOILERPLATE/boilerplateCommandParser.d.ts

@@ -3,7 +3,7 @@ import type { BoilerplateCommand } from './BoilerplateCommand';
 /**
  * Parses the boilerplate command
  *
- * Note: @@@ This command is used as boilerplate for new commands - it should NOT be used in any `.book.md` file
+ * Note: @@@ This command is used as boilerplate for new commands - it should NOT be used in any `.book` file
  *
  * @see `documentationUrl` for more details
  * @private within the commands folder

package/esm/typings/src/conversion/validation/_importPipeline.d.ts

@@ -2,7 +2,7 @@ import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
 import type { PipelineString } from '../../pipeline/PipelineString';
 import type { string_json } from '../../types/typeAliases';
 /**
- * Import the pipeline.book.md or pipeline.book.json file
+ * Import the pipeline.book or pipeline.book.json file
  *
  * Note: Using here custom import to work in jest tests
  * Note: Using sync version is 💩 in the production code, but it's ok here in tests
@@ -10,7 +10,7 @@ import type { string_json } from '../../types/typeAliases';
  * @param path - The path to the file relative to examples/pipelines directory
  * @private internal function of tests
  */
-export declare function importPipelineWithoutPreparation(path: `${string}.book.md`): PipelineString;
+export declare function importPipelineWithoutPreparation(path: `${string}.book`): PipelineString;
 export declare function importPipelineWithoutPreparation(path: `${string}.book.json`): PipelineJson;
 /**
  * Import the pipeline.book.json file as parsed JSON

package/esm/typings/src/pipeline/PipelineJson/PipelineJson.d.ts

@@ -29,12 +29,12 @@ export type PipelineJson = {
      * Note: It must be unique across all pipeline collections
      * Note: It must use HTTPs URL
      * Tip: You can do versioning in the URL
-     *      For example: https://promptbook.studio/webgpt/write-website-content-cs.book.md@1.0.0
+     *      For example: https://promptbook.studio/webgpt/write-website-content-cs.book@1.0.0
      * Warning: Do not hash part of the URL, hash part is used for identification of the task in the pipeline
      */
     readonly pipelineUrl?: string_pipeline_url;
     /**
-     * Internal helper for tracking the source `.book.md` file of the pipeline
+     * Internal helper for tracking the source `.book` file of the pipeline
      */
     readonly sourceFile?: string_filename;
     /**

package/esm/typings/src/types/Prompt.d.ts

@@ -95,7 +95,7 @@ export type CommonPrompt = {
     /**
      * Unique identifier of the pipeline with specific task name as hash
      *
-     * @example https://promptbook.studio/webgpt/write-website-content-cs.book.md#keywords
+     * @example https://promptbook.studio/webgpt/write-website-content-cs.book#keywords
      */
     readonly pipelineUrl?: string_pipeline_url_with_task_hash;
     /**

package/esm/typings/src/types/typeAliases.d.ts

@@ -328,13 +328,13 @@ export type string_pipeline_root_url = string;
 /**
  * Semantic helper
  *
- * For example `"https://promptbook.studio/webgpt/write-website-content-cs.book.md"`
+ * For example `"https://promptbook.studio/webgpt/write-website-content-cs.book"`
  */
 export type string_pipeline_url = string;
 /**
  * Semantic helper
  *
- * For example `"https://promptbook.studio/webgpt/write-website-content-cs.book.md#keywords"`
+ * For example `"https://promptbook.studio/webgpt/write-website-content-cs.book#keywords"`
  */
 export type string_pipeline_url_with_task_hash = string;
 /**

package/esm/typings/src/utils/editable/utils/stringifyPipelineJson.d.ts

@@ -9,7 +9,7 @@ import type { string_json } from '../../../types/typeAliases';
  */
 export declare function stringifyPipelineJson<TType>(pipeline: TType): string_json<TType>;
 /**
- * TODO: [🐝] Not Working propperly @see https://promptbook.studio/examples/mixed-knowledge.book.md
+ * TODO: [🐝] Not Working propperly @see https://promptbook.studio/examples/mixed-knowledge.book
  * TODO: [🧠][0] Maybe rename to `stringifyPipelineJson`, `stringifyIndexedJson`,...
  * TODO: [🧠] Maybe more elegant solution than replacing via regex
  * TODO: [🍙] Make some standard order of json properties

package/esm/typings/src/wizzard/wizzard.d.ts

@@ -19,9 +19,9 @@ declare class Wizzard {
      * Run the book
      *
      * It can be loaded from:
-     * 1) As a file ./books/write-cv.book.md
-     * 2) As a URL https://promptbook.studio/hejny/write-cv.book.md found in ./books folder recursively
-     * 2) As a URL https://promptbook.studio/hejny/write-cv.book.md fetched from the internet
+     * 1) As a file ./books/write-cv.book
+     * 2) As a URL https://promptbook.studio/hejny/write-cv.book found in ./books folder recursively
+     * 2) As a URL https://promptbook.studio/hejny/write-cv.book fetched from the internet
      * 3) As a string
      *
      * Note: This works simmilar to the `ptbk run` command
@@ -43,9 +43,9 @@ declare class Wizzard {
      * Load book from the source
      *
      * Pipelines can be loaded from:
-     * 1) As a file ./books/write-cv.book.md
-     * 2) As a URL https://promptbook.studio/hejny/write-cv.book.md found in ./books folder recursively
-     * 2) As a URL https://promptbook.studio/hejny/write-cv.book.md fetched from the internet
+     * 1) As a file ./books/write-cv.book
+     * 2) As a URL https://promptbook.studio/hejny/write-cv.book found in ./books folder recursively
+     * 2) As a URL https://promptbook.studio/hejny/write-cv.book fetched from the internet
      * 3) As a string
      *
      * @param pipelineSource

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/openai",
-    "version": "0.85.0",
+    "version": "0.86.0-11",
     "description": "It's time for a paradigm shift. The future of software in plain English, French or Latin",
     "private": false,
     "sideEffects": false,
@@ -47,7 +47,7 @@
     "module": "./esm/index.es.js",
     "typings": "./esm/typings/src/_packages/openai.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.85.0"
+        "@promptbook/core": "0.86.0-11"
     },
     "dependencies": {
         "colors": "1.4.0",

package/umd/index.umd.js

@@ -24,7 +24,7 @@
      * @generated
      * @see https://github.com/webgptorg/promptbook
      */
-    var PROMPTBOOK_ENGINE_VERSION = '0.85.0-16';
+    var PROMPTBOOK_ENGINE_VERSION = '0.86.0-10';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name