@promptbook/browser 0.72.0-9 → 0.73.0

package/esm/typings/src/utils/execCommand/$execCommand.d.ts

@@ -1,14 +1,16 @@
-import type { IExecCommandOptions } from './IExecCommandOptions';
+import type { ExecCommandOptions } from './ExecCommandOptions';
 /**
  * Run one command in a shell
  *
+ *
  * Note: There are 2 similar functions in the codebase:
  * - `$execCommand` which runs a single command
  * - `$execCommands` which runs multiple commands
+ * Note: `$` is used to indicate that this function is not a pure function - it runs a command in a shell
  *
  * @public exported from `@promptbook/node`
  */
-export declare function $execCommand(options: IExecCommandOptions): Promise<string>;
+export declare function $execCommand(options: ExecCommandOptions): Promise<string>;
 /**
  * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
  */

package/esm/typings/src/utils/execCommand/$execCommandNormalizeOptions.d.ts

@@ -0,0 +1,12 @@
+import type { ExecCommandOptions } from './ExecCommandOptions';
+import type { ExecCommandOptionsAdvanced } from './ExecCommandOptions';
+/**
+ * Normalize options for `execCommand` and `execCommands`
+ *
+ * Note: `$` is used to indicate that this function behaves differently according to `process.platform`
+ *
+ * @private internal utility of `execCommand` and `execCommands`
+ */
+export declare function $execCommandNormalizeOptions(options: ExecCommandOptions): Pick<ExecCommandOptionsAdvanced, 'command' | 'args' | 'cwd' | 'crashOnError' | 'timeout' | 'isVerbose'> & {
+    humanReadableCommand: string;
+};

package/esm/typings/src/utils/execCommand/$execCommands.d.ts

@@ -4,6 +4,7 @@
  * Note: There are 2 similar functions in the codebase:
  * - `$execCommand` which runs a single command
  * - `$execCommands` which runs multiple commands
+ * Note: `$` is used to indicate that this function is not a pure function - it runs a commands in a shell
  *
  * @public exported from `@promptbook/node`
  */

package/esm/typings/src/utils/execCommand/ExecCommandOptions.d.ts

@@ -0,0 +1,45 @@
+/**
+ * @deprecated Use sth from type-fest or move this to type helpers
+ */
+type RequiredAndOptional<TBase, TRequired extends keyof TBase, TOptional extends keyof TBase> = Pick<TBase, TRequired> & Partial<Pick<TBase, TOptional>>;
+/**
+ * Simple options for `execCommand`
+ */
+export type ExecCommandOptions = string | RequiredAndOptional<ExecCommandOptionsAdvanced, 'command', 'args' | 'cwd' | 'crashOnError' | 'timeout' | 'isVerbose'>;
+/**
+ * Advanced options for `execCommand`
+ */
+export type ExecCommandOptionsAdvanced = {
+    /**
+     * Command to run
+     */
+    readonly command: string;
+    /**
+     * Arguments for the command
+     */
+    readonly args: string[];
+    /**
+     * Current working directory
+     *
+     * @default process.cwd()
+     */
+    readonly cwd: string;
+    /**
+     * If `true` then the command will throw an error if the return code is not `0`
+     */
+    readonly crashOnError: boolean;
+    /**
+     * Timeout in milliseconds
+     */
+    readonly timeout: number;
+    /**
+     * If `true` then the command and entire CLI output will be logged to the console
+     *
+     * @default false
+     */
+    readonly isVerbose?: boolean;
+};
+export {};
+/**
+ * TODO: [⏳] Make DEFAULT_TIMEOUT_MS as global constant
+ */

package/esm/typings/src/utils/expectation-counters/countSentences.d.ts

@@ -4,7 +4,7 @@ import type { ExpectationAmount } from '../../types/PipelineJson/Expectations';
  *
  * @public exported from `@promptbook/utils`
  */
-export declare function splitIntoSentences(text: string): Array<string>;
+export declare function splitIntoSentences(text: string): ReadonlyArray<string>;
 /**
  * Counts number of sentences in the text
  *

package/esm/typings/src/utils/files/isExecutable.d.ts

@@ -0,0 +1,11 @@
+import type { FilesystemTools } from '../../execution/FilesystemTools';
+/**
+ * Checks if the file is executable
+ *
+ * @private within the repository
+ */
+export declare function isExecutable(path: string, fs: FilesystemTools): Promise<boolean>;
+/**
+ * Note: Not [~🟢~] because it is not directly dependent on `fs
+ * TODO: [🖇] What about symlinks?
+ */

package/esm/typings/src/utils/markdown/extractAllBlocksFromMarkdown.d.ts

@@ -30,7 +30,7 @@ export type CodeBlock = {
  * @throws {ParseError} if block is not closed properly
  * @public exported from `@promptbook/markdown-utils`
  */
-export declare function extractAllBlocksFromMarkdown(markdown: string_markdown): Array<CodeBlock>;
+export declare function extractAllBlocksFromMarkdown(markdown: string_markdown): ReadonlyArray<CodeBlock>;
 /**
  * TODO: Maybe name for `blockNotation` instead of  '```' and '>'
  */

package/esm/typings/src/utils/markdown/splitMarkdownIntoSections.d.ts

@@ -5,7 +5,7 @@ import type { string_markdown_section } from '../../types/typeAliases';
  *
  * @public exported from `@promptbook/markdown-utils`
  */
-export declare function splitMarkdownIntoSections(markdown: string_markdown): Array<string_markdown_section>;
+export declare function splitMarkdownIntoSections(markdown: string_markdown): ReadonlyArray<string_markdown_section>;
 /**
  * TODO: [🏛] This can be part of markdown builder
  * Note: [🕞] In past (commit 42086e1603cbed506482997c00a8ee979af0a247) there was much more

package/esm/typings/src/utils/normalization/IKeywords.d.ts

@@ -2,7 +2,7 @@
  * Semantic helper
  *
  * Keyword is string without diacritics in lowercase [a-z1-9]
- * Words are splitted between multiple keywords @see IKeywords
+ * Words are splitted between multiple keywords @see Keywords
  *
  * For example `"keyword"`
  *
@@ -15,7 +15,7 @@ export type string_keyword = string;
  *
  * @public exported from `@promptbook/utils`
  */
-export type IKeywords = Set<string_keyword>;
+export type Keywords = Set<string_keyword>;
 /**
  * TODO: [🌮] Keywords with weight
  */

package/esm/typings/src/utils/normalization/parseKeywords.d.ts

@@ -1,5 +1,5 @@
 import type { really_unknown } from '../organization/really_unknown';
-import type { IKeywords } from './IKeywords';
+import type { Keywords } from './IKeywords';
 /**
  * Parses keywords from any object and recursively walks through
  *
@@ -9,7 +9,7 @@ import type { IKeywords } from './IKeywords';
  * @returns {Set} of keywords without diacritics in lowercase
  * @public exported from `@promptbook/utils`
  */
-export declare function parseKeywords(input: really_unknown): IKeywords;
+export declare function parseKeywords(input: really_unknown): Keywords;
 /**
  * Note: Not using spread in input param because of keeping second parameter for options
  * TODO: [🌺] Use some intermediate util splitWords

package/esm/typings/src/utils/normalization/parseKeywordsFromString.d.ts

@@ -1,4 +1,4 @@
-import type { IKeywords } from './IKeywords';
+import type { Keywords } from './IKeywords';
 /**
  * Parses keywords from a string
  *
@@ -6,4 +6,4 @@ import type { IKeywords } from './IKeywords';
  * @returns {Set} of keywords without diacritics in lowercase
  * @public exported from `@promptbook/utils`
  */
-export declare function parseKeywordsFromString(input: string): IKeywords;
+export declare function parseKeywordsFromString(input: string): Keywords;

package/esm/typings/src/utils/normalization/searchKeywords.d.ts

@@ -1,4 +1,4 @@
-import type { IKeywords } from './IKeywords';
+import type { Keywords } from './IKeywords';
 /**
  * @@@
  *
@@ -7,4 +7,4 @@ import type { IKeywords } from './IKeywords';
  * @returns
  * @public exported from `@promptbook/utils`
  */
-export declare function searchKeywords(haystack: IKeywords, needle: IKeywords): boolean;
+export declare function searchKeywords(haystack: Keywords, needle: Keywords): boolean;

package/esm/typings/src/utils/organization/TODO_USE.d.ts

@@ -9,4 +9,4 @@ import type { really_any } from './really_any';
  * @returns void
  * @private within the repository
  */
-export declare function TODO_USE(...value: Array<really_any>): void;
+export declare function TODO_USE(...value: ReadonlyArray<really_any>): void;

package/esm/typings/src/utils/organization/keepUnused.d.ts

@@ -13,4 +13,4 @@ import type { really_any } from './really_any';
  * @returns void
  * @private within the repository
  */
-export declare function keepUnused<TTypeToKeep1 = really_any, TTypeToKeep2 = really_any, TTypeToKeep3 = really_any>(...valuesToKeep: Array<really_any>): void;
+export declare function keepUnused<TTypeToKeep1 = really_any, TTypeToKeep2 = really_any, TTypeToKeep3 = really_any>(...valuesToKeep: ReadonlyArray<really_any>): void;

package/esm/typings/src/utils/random/$randomSeed.d.ts

@@ -3,7 +3,7 @@ import type { number_seed } from '../../types/typeAliases';
  * Generates random seed
  *
  * Note: `$` is used to indicate that this function is not a pure function - it is not deterministic
- * Warning: This function is not cryptographically secure (it uses Math.random internally)
+ * Warning: This function is NOT cryptographically secure (it uses Math.random internally)
  * @public exported from `@promptbook/utils`
  */
 export declare function $randomSeed(): number_seed;

package/esm/typings/src/utils/sets/intersection.d.ts

@@ -4,4 +4,4 @@
  * @deprecated use new javascript set methods instead @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set
  * @public exported from `@promptbook/utils`
  */
-export declare function intersection<TItem>(...sets: Array<Set<TItem>>): Set<TItem>;
+export declare function intersection<TItem>(...sets: ReadonlyArray<Set<TItem>>): Set<TItem>;

package/esm/typings/src/utils/sets/union.d.ts

@@ -4,4 +4,4 @@
  * @deprecated use new javascript set methods instead @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set
  * @public exported from `@promptbook/utils`
  */
-export declare function union<TItem>(...sets: Array<Set<TItem>>): Set<TItem>;
+export declare function union<TItem>(...sets: ReadonlyArray<Set<TItem>>): Set<TItem>;

package/esm/typings/src/utils/unwrapResult.d.ts

@@ -1,11 +1,11 @@
 /**
  * Additional options for `unwrapResult`
  */
-interface UnwrapResultOptions {
+type UnwrapResultOptions = {
     /**
      * If true, the text is trimmed before processing
      */
-    isTrimmed?: boolean;
+    readonly isTrimmed?: boolean;
     /**
      * If true, the introduce sentence is removed
      *
@@ -15,8 +15,8 @@ interface UnwrapResultOptions {
      *
      * @default true
      */
-    isIntroduceSentenceRemoved?: boolean;
-}
+    readonly isIntroduceSentenceRemoved?: boolean;
+};
 /**
  * Removes quotes and optional introduce text from a string
  *

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/browser",
-    "version": "0.72.0-9",
+    "version": "0.73.0",
     "description": "Supercharge your use of large language models",
     "private": false,
     "sideEffects": false,
@@ -11,6 +11,7 @@
     "contributors": [
         "Pavol Hejný <me@pavolhejny.com> (https://www.pavolhejny.com/)"
     ],
+    "todo-0": "TODO: [❇️] Make better list of keywords",
     "keywords": [
         "ai",
         "llm",
@@ -30,7 +31,8 @@
         "o1",
         "o1-mini",
         "o1-preview",
-        "anthropic"
+        "anthropic",
+        "LLMOps"
     ],
     "license": "CC-BY-4.0",
     "bugs": {
@@ -51,9 +53,9 @@
     "module": "./esm/index.es.js",
     "typings": "./esm/typings/src/_packages/browser.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.72.0-9"
+        "@promptbook/core": "0.73.0"
     },
     "dependencies": {
-        "spacetrim": "0.11.39"
+        "spacetrim": "0.11.59"
     }
 }

package/umd/index.umd.js

@@ -12,7 +12,7 @@
     /**
      * The version of the Promptbook library
      */
-    var PROMPTBOOK_VERSION = '0.72.0-8';
+    var PROMPTBOOK_VERSION = '0.72.0';
     // TODO: [main] !!!! List here all the versions and annotate + put into script
 
     /*! *****************************************************************************
@@ -200,32 +200,6 @@
      */
     var $isRunningInWebWorker = new Function("\n    try {\n        if (typeof WorkerGlobalScope !== 'undefined' && self instanceof WorkerGlobalScope) {\n            return true;\n        } else {\n            return false;\n        }\n    } catch (e) {\n        return false;\n    }\n");
 
-    /**
-     * @@@!!!!!!
-     *
-     * 1) @@@
-     * 2) @@@
-     *
-     * @public exported from `@promptbook/browser`
-     */
-    function $provideScrapersForBrowser(tools, options) {
-        return __awaiter(this, void 0, void 0, function () {
-            var isAutoInstalled /* Note: [0] Intentionally not assigning a default value = IS_AUTO_INSTALLED */;
-            return __generator(this, function (_a) {
-                if (!$isRunningInBrowser() || $isRunningInWebWorker()) {
-                    throw new EnvironmentMismatchError('Function `$provideScrapersForBrowser` works only in browser environment');
-                }
-                isAutoInstalled = (options || {}).isAutoInstalled;
-                if (isAutoInstalled === true /* <- Note: [0] Ignoring undefined, just checking EXPLICIT requirement for install */) {
-                    throw new EnvironmentMismatchError('Auto-installing is not supported in browser environment');
-                }
-                return [2 /*return*/, [
-                    // TODO: !!!!!!! Implement
-                    ]];
-            });
-        });
-    }
-
     /**
      * @@@
      *
@@ -441,10 +415,10 @@
         'content',
         'context',
         'knowledge',
-        'samples',
+        'examples',
         'modelName',
         'currentDate',
-        // <- TODO: !!!!! list here all command names
+        // <- TODO: list here all command names
         // <- TODO: Add more like 'date', 'modelName',...
         // <- TODO: Add [emoji] + instructions ACRY when adding new reserved parameter
     ]);
@@ -464,6 +438,229 @@
      * TODO: [🧠][🧜‍♂️] Maybe join remoteUrl and path into single value
      */
 
+    /**
+     * This error type indicates that some part of the code is not implemented yet
+     *
+     * @public exported from `@promptbook/core`
+     */
+    var NotYetImplementedError = /** @class */ (function (_super) {
+        __extends(NotYetImplementedError, _super);
+        function NotYetImplementedError(message) {
+            var _this = _super.call(this, spaceTrim.spaceTrim(function (block) { return "\n                    ".concat(block(message), "\n\n                    Note: This feature is not implemented yet but it will be soon.\n\n                    If you want speed up the implementation or just read more, look here:\n                    https://github.com/webgptorg/promptbook\n\n                    Or contact us on me@pavolhejny.com\n\n                "); })) || this;
+            _this.name = 'NotYetImplementedError';
+            Object.setPrototypeOf(_this, NotYetImplementedError.prototype);
+            return _this;
+        }
+        return NotYetImplementedError;
+    }(Error));
+
+    /**
+     * @@@
+     *
+     * Note: `$` is used to indicate that this function is not a pure function - it access global scope
+     *
+     *  @private internal function of `$Register`
+     */
+    function $getGlobalScope() {
+        return Function('return this')();
+    }
+
+    /**
+     * @@@
+     *
+     * @param text @@@
+     * @returns @@@
+     * @example 'HELLO_WORLD'
+     * @example 'I_LOVE_PROMPTBOOK'
+     * @public exported from `@promptbook/utils`
+     */
+    function normalizeTo_SCREAMING_CASE(text) {
+        var e_1, _a;
+        var charType;
+        var lastCharType = 'OTHER';
+        var normalizedName = '';
+        try {
+            for (var text_1 = __values(text), text_1_1 = text_1.next(); !text_1_1.done; text_1_1 = text_1.next()) {
+                var char = text_1_1.value;
+                var normalizedChar = void 0;
+                if (/^[a-z]$/.test(char)) {
+                    charType = 'LOWERCASE';
+                    normalizedChar = char.toUpperCase();
+                }
+                else if (/^[A-Z]$/.test(char)) {
+                    charType = 'UPPERCASE';
+                    normalizedChar = char;
+                }
+                else if (/^[0-9]$/.test(char)) {
+                    charType = 'NUMBER';
+                    normalizedChar = char;
+                }
+                else {
+                    charType = 'OTHER';
+                    normalizedChar = '_';
+                }
+                if (charType !== lastCharType &&
+                    !(lastCharType === 'UPPERCASE' && charType === 'LOWERCASE') &&
+                    !(lastCharType === 'NUMBER') &&
+                    !(charType === 'NUMBER')) {
+                    normalizedName += '_';
+                }
+                normalizedName += normalizedChar;
+                lastCharType = charType;
+            }
+        }
+        catch (e_1_1) { e_1 = { error: e_1_1 }; }
+        finally {
+            try {
+                if (text_1_1 && !text_1_1.done && (_a = text_1.return)) _a.call(text_1);
+            }
+            finally { if (e_1) throw e_1.error; }
+        }
+        normalizedName = normalizedName.replace(/_+/g, '_');
+        normalizedName = normalizedName.replace(/_?\/_?/g, '/');
+        normalizedName = normalizedName.replace(/^_/, '');
+        normalizedName = normalizedName.replace(/_$/, '');
+        return normalizedName;
+    }
+    /**
+     * TODO: Tests
+     *     > expect(encodeRoutePath({ uriId: 'VtG7sR9rRJqwNEdM2', name: 'Moje tabule' })).toEqual('/VtG7sR9rRJqwNEdM2/Moje tabule');
+     *     > expect(encodeRoutePath({ uriId: 'VtG7sR9rRJqwNEdM2', name: 'ěščřžžýáíúů' })).toEqual('/VtG7sR9rRJqwNEdM2/escrzyaieuu');
+     *     > expect(encodeRoutePath({ uriId: 'VtG7sR9rRJqwNEdM2', name: '  ahoj  ' })).toEqual('/VtG7sR9rRJqwNEdM2/ahoj');
+     *     > expect(encodeRoutePath({ uriId: 'VtG7sR9rRJqwNEdM2', name: '  ahoj_ahojAhoj    ahoj  ' })).toEqual('/VtG7sR9rRJqwNEdM2/ahoj-ahoj-ahoj-ahoj');
+     * TODO: [🌺] Use some intermediate util splitWords
+     */
+
+    /**
+     * @@@
+     *
+     * @param text @@@
+     * @returns @@@
+     * @example 'hello_world'
+     * @example 'i_love_promptbook'
+     * @public exported from `@promptbook/utils`
+     */
+    function normalizeTo_snake_case(text) {
+        return normalizeTo_SCREAMING_CASE(text).toLowerCase();
+    }
+
+    /**
+     * Register is @@@
+     *
+     * Note: `$` is used to indicate that this function is not a pure function - it accesses and adds variables in global scope.
+     *
+     * @private internal utility, exported are only signleton instances of this class
+     */
+    var $Register = /** @class */ (function () {
+        function $Register(registerName) {
+            this.registerName = registerName;
+            var storageName = "_promptbook_".concat(normalizeTo_snake_case(registerName));
+            var globalScope = $getGlobalScope();
+            if (globalScope[storageName] === undefined) {
+                globalScope[storageName] = [];
+            }
+            else if (!Array.isArray(globalScope[storageName])) {
+                throw new UnexpectedError("Expected (global) ".concat(storageName, " to be an array, but got ").concat(typeof globalScope[storageName]));
+            }
+            this.storage = globalScope[storageName];
+        }
+        $Register.prototype.list = function () {
+            // <- TODO: ReadonlyDeep<ReadonlyArray<TRegistered>>
+            return this.storage;
+        };
+        $Register.prototype.register = function (registered) {
+            var packageName = registered.packageName, className = registered.className;
+            var existingRegistrationIndex = this.storage.findIndex(function (item) { return item.packageName === packageName && item.className === className; });
+            var existingRegistration = this.storage[existingRegistrationIndex];
+            if (!existingRegistration) {
+                this.storage.push(registered);
+            }
+            else {
+                this.storage[existingRegistrationIndex] = registered;
+            }
+            return {
+                registerName: this.registerName,
+                packageName: packageName,
+                className: className,
+                get isDestroyed() {
+                    return false;
+                },
+                destroy: function () {
+                    throw new NotYetImplementedError("Registration to ".concat(this.registerName, " is permanent in this version of Promptbook"));
+                },
+            };
+        };
+        return $Register;
+    }());
+
+    /**
+     * @@@
+     *
+     * Note: `$` is used to indicate that this interacts with the global scope
+     * @singleton Only one instance of each register is created per build, but thare can be more @@@
+     * @public exported from `@promptbook/core`
+     */
+    var $scrapersRegister = new $Register('scraper_constructors');
+    /**
+     * TODO: [®] DRY Register logic
+     */
+
+    /**
+     * @@@
+     *
+     * 1) @@@
+     * 2) @@@
+     *
+     * @public exported from `@promptbook/browser`
+     */
+    function $provideScrapersForBrowser(tools, options) {
+        return __awaiter(this, void 0, void 0, function () {
+            var isAutoInstalled /* Note: [0] Intentionally not assigning a default value = IS_AUTO_INSTALLED */, scrapers, _a, _b, scraperFactory, scraper, e_1_1;
+            var e_1, _c;
+            return __generator(this, function (_d) {
+                switch (_d.label) {
+                    case 0:
+                        if (!$isRunningInBrowser() || $isRunningInWebWorker()) {
+                            throw new EnvironmentMismatchError('Function `$provideScrapersForBrowser` works only in browser environment');
+                        }
+                        isAutoInstalled = (options || {}).isAutoInstalled;
+                        if (isAutoInstalled === true /* <- Note: [0] Ignoring undefined, just checking EXPLICIT requirement for install */) {
+                            throw new EnvironmentMismatchError('Auto-installing is not supported in browser environment');
+                        }
+                        scrapers = [];
+                        _d.label = 1;
+                    case 1:
+                        _d.trys.push([1, 6, 7, 8]);
+                        _a = __values($scrapersRegister.list()), _b = _a.next();
+                        _d.label = 2;
+                    case 2:
+                        if (!!_b.done) return [3 /*break*/, 5];
+                        scraperFactory = _b.value;
+                        return [4 /*yield*/, scraperFactory(tools, options || {})];
+                    case 3:
+                        scraper = _d.sent();
+                        scrapers.push(scraper);
+                        _d.label = 4;
+                    case 4:
+                        _b = _a.next();
+                        return [3 /*break*/, 2];
+                    case 5: return [3 /*break*/, 8];
+                    case 6:
+                        e_1_1 = _d.sent();
+                        e_1 = { error: e_1_1 };
+                        return [3 /*break*/, 8];
+                    case 7:
+                        try {
+                            if (_b && !_b.done && (_c = _a.return)) _c.call(_a);
+                        }
+                        finally { if (e_1) throw e_1.error; }
+                        return [7 /*endfinally*/];
+                    case 8: return [2 /*return*/, scrapers];
+                }
+            });
+        });
+    }
+
     /**
      * Tests if the value is [🚉] serializable as JSON
      *
@@ -518,7 +715,7 @@
         return pipelineJsonStringified;
     }
     /**
-     * TODO: [🐝] Not Working propperly @see https://promptbook.studio/samples/mixed-knowledge.ptbk.md
+     * TODO: [🐝] Not Working propperly @see https://promptbook.studio/examples/mixed-knowledge.ptbk.md
      * TODO: [🧠][0] Maybe rename to `stringifyPipelineJson`, `stringifyIndexedJson`,...
      * TODO: [🧠] Maybe more elegant solution than replacing via regex
      * TODO: [🍙] Make some standard order of json properties