@promptbook/openai - npm Package Compare versions

Comparing version 0.85.0 to 0.86.0-2

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

@@ -8,3 +8,3 @@ /**
 /**
- * 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
@@ -11,0 +11,0 @@ * TODO: [🕌] When more functionalities, rename

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

 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
@@ -5,0 +5,0 @@ *       there is no error message and false return (the error) happen deep in:

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

@@ -9,3 +9,3 @@ import type { ExecutionTools } from '../../execution/ExecutionTools';
  *
- * 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
@@ -12,0 +12,0 @@ */

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

@@ -6,3 +6,3 @@ import type { PipelineBothCommandParser } from '../_common/types/CommandParser';
  *
- * 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
  *
@@ -9,0 +9,0 @@ * @see `documentationUrl` for more details

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

@@ -6,3 +6,3 @@ import type { PipelineTaskCommandParser } from '../_common/types/CommandParser';
  *
- * 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
  *
@@ -9,0 +9,0 @@ * @see `documentationUrl` for more details

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

@@ -6,3 +6,3 @@ import type { PipelineHeadCommandParser } from '../_common/types/CommandParser';
  *
- * 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
  *
@@ -9,0 +9,0 @@ * @see `documentationUrl` for more details

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

@@ -5,3 +5,3 @@ import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
 /**
- * Import the pipeline.book.md or pipeline.book.json file
+ * Import the pipeline.book or pipeline.book.json file
  *
@@ -14,3 +14,3 @@ * Note: Using here custom import to work in jest 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;
@@ -17,0 +17,0 @@ /**

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

@@ -32,3 +32,3 @@ import type { string_formfactor_name } from '../../formfactors/_common/string_formfactor_name';
      * 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
@@ -38,3 +38,3 @@ */
     /**
-     * Internal helper for tracking the source `.book.md` file of the pipeline
+     * Internal helper for tracking the source `.book` file of the pipeline
      */
@@ -41,0 +41,0 @@ readonly sourceFile?: string_filename;

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

@@ -98,3 +98,3 @@ import type { FormatCommand } from '../commands/FORMAT/FormatCommand';
      *
-     * @example https://promptbook.studio/webgpt/write-website-content-cs.book.md#keywords
+     * @example https://promptbook.studio/webgpt/write-website-content-cs.book#keywords
      */
@@ -101,0 +101,0 @@ readonly pipelineUrl?: string_pipeline_url_with_task_hash;

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

@@ -331,3 +331,3 @@ import type { TupleToUnion } from 'type-fest';
  *
- * For example `"https://promptbook.studio/webgpt/write-website-content-cs.book.md"`
+ * For example `"https://promptbook.studio/webgpt/write-website-content-cs.book"`
  */
@@ -338,3 +338,3 @@ export type string_pipeline_url = string;
  *
- * 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"`
  */
@@ -341,0 +341,0 @@ export type string_pipeline_url_with_task_hash = string;

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

@@ -12,3 +12,3 @@ import type { string_json } from '../../../types/typeAliases';
 /**
- * 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`,...
@@ -15,0 +15,0 @@ * TODO: [🧠] Maybe more elegant solution than replacing via regex

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

@@ -22,5 +22,5 @@ import type { ExecutionTools } from '../execution/ExecutionTools';
      * 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
@@ -47,5 +47,5 @@ *
      * 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
@@ -52,0 +52,0 @@ *

package.json

 {
     "name": "@promptbook/openai",
-    "version": "0.85.0",
+    "version": "0.86.0-2",
     "description": "It's time for a paradigm shift. The future of software in plain English, French or Latin",
@@ -50,3 +50,3 @@ "private": false,
     "peerDependencies": {
-        "@promptbook/core": "0.85.0"
+        "@promptbook/core": "0.86.0-2"
     },
@@ -53,0 +53,0 @@ "dependencies": {

README.md

@@ -19,2 +19,3 @@ <!-- ⚠️ WARNING: This code has been generated so that any manual changes will be overwritten -->
 
+-   📂 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/)
@@ -28,2 +29,6 @@ -   🐋 **Support of [DeepSeek models](https://www.npmjs.com/package/@promptbook/deepseek)**
 
+<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`
@@ -79,3 +84,3 @@
 // ▶ 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`);
 
@@ -114,3 +119,3 @@ // ▶ Create executor - the function that will execute the Pipeline
     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',
@@ -144,3 +149,3 @@ });
 // ▶ 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`);
 
@@ -217,3 +222,3 @@ // ▶ Create executor - the function that will execute the Pipeline
 // ▶ 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`);
 
@@ -263,3 +268,3 @@ // ▶ Create executor - the function that will execute the Pipeline
 
-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!
 
@@ -293,4 +298,3 @@ 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.
       <th>Project</th>
-      <th>Description</th>
-      <th>Link</th>
+      <th>About</th>
     </tr>
@@ -300,31 +304,15 @@ </thead>
     <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>
@@ -331,0 +319,0 @@ </tbody>

No alert changes

Worsened metrics

Total package byte prevSize

952998

decreased by-0.02%

Number of lines in readme file

640

decreased by-1.84%

No dependency changes