@promptbook/remote-client 0.85.0-9 → 0.86.0-10

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.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'> & {
@@ -51,13 +51,13 @@ type CreatePipelineCollectionFromDirectoryOptions = Omit<PrepareAndScrapeOptions
  *
  * Note: Works only in Node.js environment because it reads the file system
  *
- * @param path - path to the directory with pipelines
+ * @param rootPath - path to the directory with pipelines
  * @param tools - Execution tools to be used for pipeline preparation if needed - If not provided, `$provideExecutionToolsForNode` will be used
  * @param options - Options for the collection creation
  * @returns PipelineCollection
  * @public exported from `@promptbook/node`
  */
-export declare function createCollectionFromDirectory(path: string_dirname, tools?: Pick<ExecutionTools, 'llm' | 'fs' | 'scrapers'>, options?: CreatePipelineCollectionFromDirectoryOptions): Promise<PipelineCollection>;
+export declare function createCollectionFromDirectory(rootPath: string_dirname, tools?: Pick<ExecutionTools, 'llm' | 'fs' | 'scrapers'>, options?: CreatePipelineCollectionFromDirectoryOptions): Promise<PipelineCollection>;
 export {};
 /**
  * TODO: [🖇] What about symlinks? Maybe option isSymlinksFollowed

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/remote-client",
-    "version": "0.85.0-9",
+    "version": "0.86.0-10",
     "description": "It's time for a paradigm shift. The future of software in plain English, French or Latin",
     "private": false,
     "sideEffects": false,
@@ -42,12 +42,12 @@
     "bugs": {
         "url": "https://github.com/webgptorg/promptbook/issues"
     },
-    "homepage": "https://www.npmjs.com/package/@promptbook/core",
+    "homepage": "https://ptbk.io/",
     "main": "./umd/index.umd.js",
     "module": "./esm/index.es.js",
     "typings": "./esm/typings/src/_packages/remote-client.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.85.0-9"
+        "@promptbook/core": "0.86.0-10"
     },
     "dependencies": {
         "crypto-js": "4.2.0",

package/umd/index.umd.js

@@ -23,7 +23,7 @@
      * @generated
      * @see https://github.com/webgptorg/promptbook
      */
-    var PROMPTBOOK_ENGINE_VERSION = '0.85.0-8';
+    var PROMPTBOOK_ENGINE_VERSION = '0.86.0-9';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -1394,7 +1394,7 @@
     /**
      * 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
@@ -2623,7 +2623,7 @@
     /**
      * 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`
@@ -3074,7 +3074,7 @@
     /**
      * 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`
@@ -3702,57 +3702,6 @@
         },
     };
 
-    /**
-     * Checks if an URL is reserved for private networks or localhost.
-     *
-     * Note: There are two simmilar functions:
-     * - `isUrlOnPrivateNetwork` which tests full URL
-     * - `isHostnameOnPrivateNetwork` *(this one)* which tests just hostname
-     *
-     * @public exported from `@promptbook/utils`
-     */
-    function isHostnameOnPrivateNetwork(hostname) {
-        if (hostname === 'example.com' ||
-            hostname === 'localhost' ||
-            hostname.endsWith('.localhost') ||
-            hostname.endsWith('.local') ||
-            hostname.endsWith('.test') ||
-            hostname === '127.0.0.1' ||
-            hostname === '::1') {
-            return true;
-        }
-        if (hostname.includes(':')) {
-            // IPv6
-            var ipParts = hostname.split(':');
-            return ipParts[0] === 'fc00' || ipParts[0] === 'fd00' || ipParts[0] === 'fe80';
-        }
-        else {
-            // IPv4
-            var ipParts = hostname.split('.').map(function (part) { return Number.parseInt(part, 10); });
-            return (ipParts[0] === 10 ||
-                (ipParts[0] === 172 && ipParts[1] >= 16 && ipParts[1] <= 31) ||
-                (ipParts[0] === 192 && ipParts[1] === 168));
-        }
-    }
-
-    /**
-     * Checks if an IP address or hostname is reserved for private networks or localhost.
-     *
-     * Note: There are two simmilar functions:
-     * - `isUrlOnPrivateNetwork` *(this one)* which tests full URL
-     * - `isHostnameOnPrivateNetwork` which tests just hostname
-     *
-     * @param {string} ipAddress - The IP address to check.
-     * @returns {boolean} Returns true if the IP address is reserved for private networks or localhost, otherwise false.
-     * @public exported from `@promptbook/utils`
-     */
-    function isUrlOnPrivateNetwork(url) {
-        if (typeof url === 'string') {
-            url = new URL(url);
-        }
-        return isHostnameOnPrivateNetwork(url.hostname);
-    }
-
     /**
      * Tests if given string is valid pipeline URL URL.
      *
@@ -3766,16 +3715,19 @@
         if (!isValidUrl(url)) {
             return false;
         }
-        if (!url.startsWith('https://')) {
+        if (!url.startsWith('https://') && !url.startsWith('http://') /* <- Note: [👣] */) {
             return false;
         }
         if (url.includes('#')) {
             // TODO: [🐠]
             return false;
         }
+        /*
+        Note: [👣][🧠] Is it secure to allow pipeline URLs on private and unsecured networks?
         if (isUrlOnPrivateNetwork(url)) {
             return false;
         }
+        */
         return true;
     }
     /**
@@ -3815,9 +3767,9 @@
          * Example usages of the URL command
          */
         examples: [
-            'PIPELINE URL https://promptbook.studio/library/write-cv.book.md',
-            'URL https://promptbook.studio/library/write-cv.book.md',
-            'https://promptbook.studio/library/write-cv.book.md',
+            'PIPELINE URL https://promptbook.studio/library/write-cv.book',
+            'URL https://promptbook.studio/library/write-cv.book',
+            'https://promptbook.studio/library/write-cv.book',
         ],
         /**
          * Parses the URL command