@promptbook/browser - npm Package Compare versions

Comparing version 0.74.0-11 to 0.74.0-12

esm/index.es.js

@@ -16,3 +16,3 @@ import spaceTrim$1, { spaceTrim } from 'spacetrim';
  */
-var PROMPTBOOK_ENGINE_VERSION = '0.74.0-10';
+var PROMPTBOOK_ENGINE_VERSION = '0.74.0-11';
 /**
@@ -722,3 +722,3 @@ * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
 /**
- * TODO: [🐝] Not Working propperly @see https://promptbook.studio/examples/mixed-knowledge.ptbk.md
+ * TODO: [🐝] Not Working propperly @see https://promptbook.studio/examples/mixed-knowledge.book.md
  * TODO: [🧠][0] Maybe rename to `stringifyPipelineJson`, `stringifyIndexedJson`,...
@@ -725,0 +725,0 @@ * TODO: [🧠] Maybe more elegant solution than replacing via regex

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

@@ -8,3 +8,3 @@ /**
 /**
- * TODO: [🧠] Maybe `run` command the default, instead of `ptbk run ./foo.ptbk.md` -> `ptbk ./foo.ptbk.md`
+ * TODO: [🧠] Maybe `run` command the default, instead of `ptbk run ./foo.book.md` -> `ptbk ./foo.book.md`
  * 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.ptbk.md is not valid
+ * Note: [🐠] For example here URL https://example.com/pipeline.book.md 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

@@ -8,3 +8,3 @@ import type { ExecutionTools } from '../../execution/ExecutionTools';
  *
- * Note: `rootDirname` is not needed because it is the folder in which `.ptbk.md` file is located
+ * Note: `rootDirname` is not needed because it is the folder in which `.book.md` file is located
  *       This is not same as `path` which is the first argument of `createCollectionFromDirectory` - it can be a subfolder
@@ -11,0 +11,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 `.ptbk.md` file
+ * Note: @@@ This command is used as boilerplate for new commands - it should NOT be used in any `.book.md` file
  *
@@ -9,0 +9,0 @@ * @see `documentationUrl` for more details

esm/typings/src/commands/BOOK_VERSION/BookVersionCommand.d.ts

@@ -10,3 +10,3 @@ import type { string_semantic_version } from '../../types/typeAliases';
     readonly type: 'BOOK_VERSION';
-    readonly promptbookVersion: string_semantic_version;
+    readonly bookVersion: string_semantic_version;
 };

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

@@ -6,3 +6,3 @@ import type { PipelineTemplateCommandParser } from '../_common/types/CommandParser';
  *
- * Note: @@@ This command is used as foreach for new commands - it should NOT be used in any `.ptbk.md` file
+ * Note: @@@ This command is used as foreach for new commands - it should NOT be used in any `.book.md` file
  *
@@ -14,3 +14,3 @@ * @see `documentationUrl` for more details
 /**
- * TODO: [🍭] Make .ptbk.md file with examples of the FOREACH with wrong parsing and logic
+ * TODO: [🍭] Make .book.md file with examples of the FOREACH with wrong parsing and logic
  */

esm/typings/src/conversion/pipelineJsonToString.d.ts

@@ -6,4 +6,4 @@ import type { PipelineJson } from '../types/PipelineJson/PipelineJson';
  *
- * @param pipelineJson Promptbook in JSON format (.ptbk.json)
- * @returns Promptbook in string format (.ptbk.md)
+ * @param pipelineJson Promptbook in JSON format (.book.json)
+ * @returns Promptbook in string format (.book.md)
  * @public exported from `@promptbook/core`
@@ -17,3 +17,3 @@ */
  * TODO: [🏛] Escape all
- * TODO: [🧠] Should be in generated .ptbk.md file GENERATOR_WARNING
+ * TODO: [🧠] Should be in generated .book.md file GENERATOR_WARNING
  */

esm/typings/src/conversion/pipelineStringToJson.d.ts

@@ -16,6 +16,6 @@ import type { ExecutionTools } from '../execution/ExecutionTools';
  *
- * @param pipelineString {Promptbook} in string markdown format (.ptbk.md)
+ * @param pipelineString {Promptbook} in string markdown format (.book.md)
  * @param tools - Tools for the preparation and scraping - if not provided together with `llm`, the preparation will be skipped
  * @param options - Options and tools for the compilation
- * @returns {Promptbook} compiled in JSON format (.ptbk.json)
+ * @returns {Promptbook} compiled in JSON format (.book.json)
  * @throws {ParseError} if the promptbook string is not valid
@@ -22,0 +22,0 @@ * @public exported from `@promptbook/core`

esm/typings/src/conversion/pipelineStringToJsonSync.d.ts

@@ -14,4 +14,4 @@ import type { PipelineJson } from '../types/PipelineJson/PipelineJson';
  *
- * @param pipelineString {Promptbook} in string markdown format (.ptbk.md)
- * @returns {Promptbook} compiled in JSON format (.ptbk.json)
+ * @param pipelineString {Promptbook} in string markdown format (.book.md)
+ * @returns {Promptbook} compiled in JSON format (.book.json)
  * @throws {ParseError} if the promptbook string is not valid
@@ -18,0 +18,0 @@ * @public exported from `@promptbook/core`

esm/typings/src/conversion/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.ptbk.md
+ * TODO: [🐝] Not Working propperly @see https://promptbook.studio/examples/mixed-knowledge.book.md
  * TODO: [🧠][0] Maybe rename to `stringifyPipelineJson`, `stringifyIndexedJson`,...
@@ -15,0 +15,0 @@ * TODO: [🧠] Maybe more elegant solution than replacing via regex

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

@@ -5,3 +5,3 @@ import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
 /**
- * Import the pipeline.ptbk.md or pipeline.ptbk.json file
+ * Import the pipeline.book.md or pipeline.book.json file
  *
@@ -14,18 +14,18 @@ * Note: Using here custom import to work in jest tests
  */
-export declare function importPipelineWithoutPreparation(path: `${string}.ptbk.md`): PipelineString;
-export declare function importPipelineWithoutPreparation(path: `${string}.ptbk.json`): PipelineJson;
+export declare function importPipelineWithoutPreparation(path: `${string}.book.md`): PipelineString;
+export declare function importPipelineWithoutPreparation(path: `${string}.book.json`): PipelineJson;
 /**
- * Import the pipeline.ptbk.json file as parsed JSON
+ * Import the pipeline.book.json file as parsed JSON
  *
  * @private internal function of tests
  */
-export declare function importPipelineJson(path: `${string}.ptbk.json`): PipelineJson;
+export declare function importPipelineJson(path: `${string}.book.json`): PipelineJson;
 /**
- * Import the pipeline.ptbk.json file as string
+ * Import the pipeline.book.json file as string
  *
  * @private internal function of tests
  */
-export declare function importPipelineJsonAsString(path: `${string}.ptbk.json`): string_json<PipelineJson>;
+export declare function importPipelineJsonAsString(path: `${string}.book.json`): string_json<PipelineJson>;
 /**
  * Note: [⚫] Code in this file should never be published in any package
  */

esm/typings/src/formats/_common/FormatDefinition.d.ts

@@ -16,3 +16,3 @@ import type { string_mime_type } from '../../types/typeAliases';
     /**
-     * The name of the format used in .ptbk.md files
+     * The name of the format used in .book.md files
      *
@@ -19,0 +19,0 @@ * @example "JSON"

esm/typings/src/formats/_common/FormatSubvalueDefinition.d.ts

@@ -12,3 +12,3 @@ import type { Promisable } from 'type-fest';
     /**
-     * The name of the format used in .ptbk.md files
+     * The name of the format used in .book.md files
      *
@@ -15,0 +15,0 @@ * @example "CELL"

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

@@ -29,3 +29,3 @@ import type { ModelRequirements } from '../ModelRequirements';
      * Tip: You can do versioning in the URL
-     *      For example: https://promptbook.studio/webgpt/write-website-content-cs.ptbk.md@1.0.0
+     *      For example: https://promptbook.studio/webgpt/write-website-content-cs.book.md@1.0.0
      * Warning: Do not hash part of the URL, hash part is used for identification of the template in the pipeline
@@ -35,3 +35,3 @@ */
     /**
-     * Internal helper for tracking the source `.ptbk.md` file of the pipeline
+     * Internal helper for tracking the source `.book.md` file of the pipeline
      */
@@ -45,5 +45,7 @@ readonly sourceFile?: string_filename;
     /**
-     * Version of the .ptbk.json file
+     * Version of the Book language
+     *
+     * @see https://github.com/webgptorg/book
      */
-    readonly promptbookVersion?: string_semantic_version;
+    readonly bookVersion?: string_semantic_version;
     /**
@@ -50,0 +52,0 @@ * Description of the promptbook

esm/typings/src/types/PipelineJson/PreparationJson.d.ts

@@ -21,3 +21,3 @@ import type { PromptResultUsage } from '../../execution/PromptResultUsage';
  * TODO: Maybe put here used `modelName`
- * TODO: [🍥] When using `date` it changes all examples .ptbk.json files each time so until some more elegant solution omit the time from prepared pipeline
+ * TODO: [🍥] When using `date` it changes all examples .book.json files each time so until some more elegant solution omit the time from prepared pipeline
  */

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.ptbk.md#keywords
+     * @example https://promptbook.studio/webgpt/write-website-content-cs.book.md#keywords
      */
@@ -101,0 +101,0 @@ readonly pipelineUrl?: string_pipeline_url_with_hashtemplate;

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

@@ -301,3 +301,3 @@ import type { TupleToUnion } from 'type-fest';
  *
- * For example `"https://promptbook.studio/webgpt/write-website-content-cs.ptbk.md"`
+ * For example `"https://promptbook.studio/webgpt/write-website-content-cs.book.md"`
  */
@@ -308,3 +308,3 @@ export type string_pipeline_url = string;
  *
- * For example `"https://promptbook.studio/webgpt/write-website-content-cs.ptbk.md#keywords"`
+ * For example `"https://promptbook.studio/webgpt/write-website-content-cs.book.md#keywords"`
  */
@@ -311,0 +311,0 @@ export type string_pipeline_url_with_hashtemplate = string;

package.json

 {
     "name": "@promptbook/browser",
-    "version": "0.74.0-11",
+    "version": "0.74.0-12",
     "description": "Supercharge your use of large language models",
@@ -56,3 +56,3 @@ "private": false,
     "peerDependencies": {
-        "@promptbook/core": "0.74.0-11"
+        "@promptbook/core": "0.74.0-12"
     },
@@ -59,0 +59,0 @@ "dependencies": {

README.md

@@ -155,3 +155,3 @@ <!-- ⚠️ WARNING: This code has been generated so that any manual changes will be overwritten -->
 
-It has file with `.ptbk.md` or `.book` extension with `UTF-8` non BOM encoding.
+It has file with `.book.md` or `.book` extension with `UTF-8` non BOM encoding.
 
@@ -249,7 +249,2 @@ As it is source code, it can leverage all the features of version control systems like git and does not suffer from the problems of binary formats, proprietary formats, or no-code solutions.
 
-
-
-
-
-
 ### 📚 Dictionary
@@ -270,4 +265,2 @@
 
-
-
 _Note: Thos section is not complete dictionary, more list of general AI / LLM terms that has connection with Promptbook_
@@ -333,4 +326,2 @@
 
-
-
 ### Terms specific to Promptbook TypeScript implementation
@@ -337,0 +328,0 @@

umd/index.umd.js

@@ -23,3 +23,3 @@ (function (global, factory) {
      */
-    var PROMPTBOOK_ENGINE_VERSION = '0.74.0-10';
+    var PROMPTBOOK_ENGINE_VERSION = '0.74.0-11';
     /**
@@ -729,3 +729,3 @@ * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
     /**
-     * TODO: [🐝] Not Working propperly @see https://promptbook.studio/examples/mixed-knowledge.ptbk.md
+     * TODO: [🐝] Not Working propperly @see https://promptbook.studio/examples/mixed-knowledge.book.md
      * TODO: [🧠][0] Maybe rename to `stringifyPipelineJson`, `stringifyIndexedJson`,...
@@ -732,0 +732,0 @@ * TODO: [🧠] Maybe more elegant solution than replacing via regex

No alert changes

Improved metrics

Total package byte prevSize

612792

Lines of code

12154

increased by0.02%

Worsened metrics

Number of lines in readme file

401

decreased by-2.2%

No dependency changes