@promptbook/fake-llm 0.83.0 → 0.84.0-10

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

@@ -9,12 +9,16 @@ import { _OpenAiMetadataRegistration } from '../llm-providers/openai/register-co
 import { _OpenAiAssistantMetadataRegistration } from '../llm-providers/openai/register-configuration';
 import { _OpenAiRegistration } from '../llm-providers/openai/register-constructor';
 import { _OpenAiAssistantRegistration } from '../llm-providers/openai/register-constructor';
+import { _BoilerplateScraperRegistration } from '../scrapers/_boilerplate/register-constructor';
+import { _BoilerplateScraperMetadataRegistration } from '../scrapers/_boilerplate/register-metadata';
 import { _LegacyDocumentScraperRegistration } from '../scrapers/document-legacy/register-constructor';
 import { _LegacyDocumentScraperMetadataRegistration } from '../scrapers/document-legacy/register-metadata';
 import { _DocumentScraperRegistration } from '../scrapers/document/register-constructor';
 import { _DocumentScraperMetadataRegistration } from '../scrapers/document/register-metadata';
 import { _MarkdownScraperRegistration } from '../scrapers/markdown/register-constructor';
 import { _MarkdownScraperMetadataRegistration } from '../scrapers/markdown/register-metadata';
+import { _MarkitdownScraperRegistration } from '../scrapers/markitdown/register-constructor';
+import { _MarkitdownScraperMetadataRegistration } from '../scrapers/markitdown/register-metadata';
 import { _PdfScraperRegistration } from '../scrapers/pdf/register-constructor';
 import { _PdfScraperMetadataRegistration } from '../scrapers/pdf/register-metadata';
 import { _WebsiteScraperRegistration } from '../scrapers/website/register-constructor';
@@ -31,12 +35,16 @@ export { _OpenAiMetadataRegistration };
 export { _OpenAiAssistantMetadataRegistration };
 export { _OpenAiRegistration };
 export { _OpenAiAssistantRegistration };
+export { _BoilerplateScraperRegistration };
+export { _BoilerplateScraperMetadataRegistration };
 export { _LegacyDocumentScraperRegistration };
 export { _LegacyDocumentScraperMetadataRegistration };
 export { _DocumentScraperRegistration };
 export { _DocumentScraperMetadataRegistration };
 export { _MarkdownScraperRegistration };
 export { _MarkdownScraperMetadataRegistration };
+export { _MarkitdownScraperRegistration };
+export { _MarkitdownScraperMetadataRegistration };
 export { _PdfScraperRegistration };
 export { _PdfScraperMetadataRegistration };
 export { _WebsiteScraperRegistration };

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

@@ -11,7 +11,7 @@ export declare const ORDER_OF_PIPELINE_JSON: ExportJsonOptions<PipelineJson>['or
  *
  * @private within the repository
  */
-export declare const REPLACING_NONCE = "u$k42k%!V2zo34w7Fu#@QUHYPW";
+export declare const REPLACING_NONCE = "ptbkauk42kV2dzao34faw7FudQUHYPtW";
 /**
  * @@@
  *

package/esm/typings/src/executables/platforms/locateAppOnLinux.d.ts

@@ -5,7 +5,7 @@ import type { LocateAppOptions } from '../locateApp';
  *
  * @private within the repository
  */
-export declare function locateAppOnLinux({ appName, linuxWhich, }: Pick<Required<LocateAppOptions>, 'appName' | 'linuxWhich'>): Promise<string_executable_path | null>;
+export declare function locateAppOnLinux({ linuxWhich, }: Pick<Required<LocateAppOptions>, 'linuxWhich'>): Promise<string_executable_path | null>;
 /**
  * TODO: [🧠][♿] Maybe export through `@promptbook/node`
  * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment

package/esm/typings/src/executables/platforms/locateAppOnMacOs.d.ts

@@ -5,7 +5,7 @@ import type { LocateAppOptions } from '../locateApp';
  *
  * @private within the repository
  */
-export declare function locateAppOnMacOs({ appName, macOsName, }: Pick<Required<LocateAppOptions>, 'appName' | 'macOsName'>): Promise<string_executable_path | null>;
+export declare function locateAppOnMacOs({ macOsName, }: Pick<Required<LocateAppOptions>, 'macOsName'>): Promise<string_executable_path | null>;
 /**
  * TODO: [🧠][♿] Maybe export through `@promptbook/node`
  * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment

package/esm/typings/src/pipeline/book-notation.d.ts

@@ -2,6 +2,10 @@ import type { PipelineString } from './PipelineString';
 /**
  * Tag function for notating a pipeline with a book\`...\ notation as template literal
  *
+ * Note: There are 2 similar functions:
+ * 1) `prompt` for notating single prompt exported from `@promptbook/utils`
+ * 1) `book` for notating and validating entire books exported from `@promptbook/utils`
+ *
  * @param strings @@@
  * @param values @@@
  * @returns the pipeline string

package/esm/typings/src/pipeline/prompt-notation.d.ts

@@ -0,0 +1,18 @@
+import type { string_prompt } from '../types/typeAliases';
+/**
+ * Tag function for notating a prompt as template literal
+ *
+ * Note: There are 2 similar functions:
+ * 1) `prompt` for notating single prompt exported from `@promptbook/utils`
+ * 1) `book` for notating and validating entire books exported from `@promptbook/utils`
+ *
+ * @param strings @@@
+ * @param values @@@
+ * @returns the pipeline string
+ * @public exported from `@promptbook/utils`
+ */
+export declare function prompt(strings: TemplateStringsArray, ...values: Array<string>): string_prompt;
+/**
+ * TODO: [🧠][🈴] Where is the best location for this file
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/pipeline/prompt-notation.test.d.ts

@@ -0,0 +1,4 @@
+export {};
+/**
+ * TODO: [🧠][🈴] Where is the best location for this file
+ */

package/esm/typings/src/scrapers/_boilerplate/BoilerplateScraper.d.ts

@@ -0,0 +1,43 @@
+import type { ExecutionTools } from '../../execution/ExecutionTools';
+import type { KnowledgePiecePreparedJson } from '../../pipeline/PipelineJson/KnowledgePieceJson';
+import type { PrepareAndScrapeOptions } from '../../prepare/PrepareAndScrapeOptions';
+import type { Converter } from '../_common/Converter';
+import type { ScraperAndConverterMetadata } from '../_common/register/ScraperAndConverterMetadata';
+import type { Scraper } from '../_common/Scraper';
+import type { ScraperSourceHandler } from '../_common/Scraper';
+import type { ScraperIntermediateSource } from '../_common/ScraperIntermediateSource';
+/**
+ * Scraper of @@@ files
+ *
+ * @see `documentationUrl` for more details
+ * @public exported from `@promptbook/boilerplate`
+ */
+export declare class BoilerplateScraper implements Converter, Scraper {
+    private readonly tools;
+    private readonly options;
+    /**
+     * Metadata of the scraper which includes title, mime types, etc.
+     */
+    get metadata(): ScraperAndConverterMetadata;
+    /**
+     * Markdown scraper is used internally
+     */
+    private readonly markdownScraper;
+    constructor(tools: Pick<ExecutionTools, 'fs' | 'llm' | 'executables'>, options: PrepareAndScrapeOptions);
+    /**
+     * Convert the `.@@@`  to `.md` file and returns intermediate source
+     *
+     * Note: `$` is used to indicate that this function is not a pure function - it leaves files on the disk and you are responsible for cleaning them by calling `destroy` method of returned object
+     */
+    $convert(source: ScraperSourceHandler): Promise<ScraperIntermediateSource>;
+    /**
+     * Scrapes the docx file and returns the knowledge pieces or `null` if it can't scrape it
+     */
+    scrape(source: ScraperSourceHandler): Promise<ReadonlyArray<Omit<KnowledgePiecePreparedJson, 'sources' | 'preparationIds'>> | null>;
+}
+/**
+ * TODO: [👣] Converted documents can act as cached items - there is no need to run conversion each time
+ * TODO: [🪂] Do it in parallel
+ * Note: No need to aggregate usage here, it is done by intercepting the llmTools
+ * @@@ Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
+ */

package/esm/typings/src/scrapers/_boilerplate/createBoilerplateScraper.d.ts

@@ -0,0 +1,20 @@
+import type { ExecutionTools } from '../../execution/ExecutionTools';
+import type { PrepareAndScrapeOptions } from '../../prepare/PrepareAndScrapeOptions';
+import { BoilerplateScraper } from './BoilerplateScraper';
+/**
+ * Constructor of `BoilerplateScraper`
+ *
+ * @public exported from `@promptbook/boilerplate`
+ */
+export declare const createBoilerplateScraper: ((tools: Pick<ExecutionTools, 'llm'>, options: PrepareAndScrapeOptions) => BoilerplateScraper) & import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
+    title: string;
+    packageName: string;
+    className: string;
+    mimeTypes: string[];
+    documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@@";
+    isAvilableInBrowser: false;
+    requiredExecutables: never[];
+}>;
+/**
+ * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
+ */

package/esm/typings/src/scrapers/_boilerplate/playground/boilerplate-scraper-playground.d.ts

@@ -0,0 +1,5 @@
+#!/usr/bin/env ts-node
+export {};
+/**
+ * Note: [⚫] Code in this file should never be published in any package
+ */

package/esm/typings/src/scrapers/_boilerplate/register-constructor.d.ts

@@ -0,0 +1,15 @@
+import type { Registration } from '../../utils/$Register';
+/**
+ * Registration of known scraper
+ *
+ * Warning: This is not useful for the end user, it is just a side effect of the mechanism that handles all available known scrapers
+ *
+ * @public exported from `@promptbook/boilerplate`
+ * @public exported from `@promptbook/wizzard`
+ * @public exported from `@promptbook/cli`
+ */
+export declare const _BoilerplateScraperRegistration: Registration;
+/**
+ * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/scrapers/_boilerplate/register-metadata.d.ts

@@ -0,0 +1,28 @@
+import type { Registration } from '../../utils/$Register';
+/**
+ * Metadata of the scraper
+ *
+ * @private within the scraper directory
+ */
+export declare const boilerplateScraperMetadata: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
+    title: string;
+    packageName: string;
+    className: string;
+    mimeTypes: string[];
+    documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@@";
+    isAvilableInBrowser: false;
+    requiredExecutables: never[];
+}>;
+/**
+ * Registration of known scraper metadata
+ *
+ * Warning: This is not useful for the end user, it is just a side effect of the mechanism that handles all available known scrapers
+ *
+ * @public exported from `@promptbook/core`
+ * @public exported from `@promptbook/wizzard`
+ * @public exported from `@promptbook/cli`
+ */
+export declare const _BoilerplateScraperMetadataRegistration: Registration;
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/scrapers/markitdown/MarkitdownScraper.d.ts

@@ -0,0 +1,50 @@
+import type { ExecutionTools } from '../../execution/ExecutionTools';
+import type { KnowledgePiecePreparedJson } from '../../pipeline/PipelineJson/KnowledgePieceJson';
+import type { PrepareAndScrapeOptions } from '../../prepare/PrepareAndScrapeOptions';
+import type { Converter } from '../_common/Converter';
+import type { ScraperAndConverterMetadata } from '../_common/register/ScraperAndConverterMetadata';
+import type { Scraper } from '../_common/Scraper';
+import type { ScraperSourceHandler } from '../_common/Scraper';
+import type { ScraperIntermediateSource } from '../_common/ScraperIntermediateSource';
+/**
+ * Integration of Markitdown by Microsoft into Promptbook
+ *
+ * @see https://github.com/microsoft/markitdown
+ * @see `documentationUrl` for more details
+ * @public exported from `@promptbook/markitdown`
+ * @public exported from `@promptbook/pdf`
+ */
+export declare class MarkitdownScraper implements Converter, Scraper {
+    private readonly tools;
+    private readonly options;
+    /**
+     * Metadata of the scraper which includes title, mime types, etc.
+     */
+    get metadata(): ScraperAndConverterMetadata;
+    /**
+     * Markdown scraper is used internally
+     */
+    private readonly markdownScraper;
+    /**
+     * Markdown scraper is used internally
+     */
+    private readonly markitdown;
+    constructor(tools: Pick<ExecutionTools, 'fs' | 'llm' | 'executables'>, options: PrepareAndScrapeOptions);
+    /**
+     * Convert the documents to `.md` file and returns intermediate source
+     *
+     * Note: `$` is used to indicate that this function is not a pure function - it leaves files on the disk and you are responsible for cleaning them by calling `destroy` method of returned object
+     */
+    $convert(source: ScraperSourceHandler): Promise<ScraperIntermediateSource>;
+    /**
+     * Scrapes the docx file and returns the knowledge pieces or `null` if it can't scrape it
+     */
+    scrape(source: ScraperSourceHandler): Promise<ReadonlyArray<Omit<KnowledgePiecePreparedJson, 'sources' | 'preparationIds'>> | null>;
+}
+/**
+ * TODO: [🧠][🌜] Export only from `@promptbook/markitdown` or `@promptbook/pdf` NOT both
+ * TODO: [👣] Converted documents can act as cached items - there is no need to run conversion each time
+ * TODO: [🪂] Do it in parallel
+ * Note: No need to aggregate usage here, it is done by intercepting the llmTools
+ * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
+ */

package/esm/typings/src/scrapers/markitdown/createMarkitdownScraper.d.ts

@@ -0,0 +1,22 @@
+import type { ExecutionTools } from '../../execution/ExecutionTools';
+import type { PrepareAndScrapeOptions } from '../../prepare/PrepareAndScrapeOptions';
+import { MarkitdownScraper } from './MarkitdownScraper';
+/**
+ * Constructor of `MarkitdownScraper`
+ *
+ * @public exported from `@promptbook/markitdown`
+ * @public exported from `@promptbook/pdf`
+ */
+export declare const createMarkitdownScraper: ((tools: Pick<ExecutionTools, 'llm'>, options: PrepareAndScrapeOptions) => MarkitdownScraper) & import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
+    title: string;
+    packageName: string;
+    className: string;
+    mimeTypes: string[];
+    documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
+    isAvilableInBrowser: false;
+    requiredExecutables: never[];
+}>;
+/**
+ * TODO: [🧠][🌜] Export only from `@promptbook/markitdown` or `@promptbook/pdf` NOT both
+ * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
+ */

package/esm/typings/src/scrapers/markitdown/playground/markitdown-scraper-playground.d.ts

@@ -0,0 +1,5 @@
+#!/usr/bin/env ts-node
+export {};
+/**
+ * Note: [⚫] Code in this file should never be published in any package
+ */

package/esm/typings/src/scrapers/markitdown/register-constructor.d.ts

@@ -0,0 +1,17 @@
+import type { Registration } from '../../utils/$Register';
+/**
+ * Registration of known scraper
+ *
+ * Warning: This is not useful for the end user, it is just a side effect of the mechanism that handles all available known scrapers
+ *
+ * @public exported from `@promptbook/markitdown`
+ * @public exported from `@promptbook/pdf`
+ * @public exported from `@promptbook/wizzard`
+ * @public exported from `@promptbook/cli`
+ */
+export declare const _MarkitdownScraperRegistration: Registration;
+/**
+ * TODO: [🧠][🌜] Export only from `@promptbook/markitdown` or `@promptbook/pdf` NOT both
+ * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/scrapers/markitdown/register-metadata.d.ts

@@ -0,0 +1,28 @@
+import type { Registration } from '../../utils/$Register';
+/**
+ * Metadata of the scraper
+ *
+ * @private within the scraper directory
+ */
+export declare const markitdownScraperMetadata: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
+    title: string;
+    packageName: string;
+    className: string;
+    mimeTypes: string[];
+    documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
+    isAvilableInBrowser: false;
+    requiredExecutables: never[];
+}>;
+/**
+ * Registration of known scraper metadata
+ *
+ * Warning: This is not useful for the end user, it is just a side effect of the mechanism that handles all available known scrapers
+ *
+ * @public exported from `@promptbook/core`
+ * @public exported from `@promptbook/wizzard`
+ * @public exported from `@promptbook/cli`
+ */
+export declare const _MarkitdownScraperMetadataRegistration: Registration;
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

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

@@ -235,7 +235,7 @@ export type string_markdown_codeblock_language = 'book' | 'markdown' | 'text' |
 /**
  * @@@
  */
-export type string_promptbook_documentation_url = `https://github.com/webgptorg/promptbook/discussions/${number | '@@'}`;
+export type string_promptbook_documentation_url = `https://github.com/webgptorg/promptbook/discussions/${number | `@@${string}`}`;
 /**
  * Semantic helper
  *

package/esm/typings/src/utils/editable/edit-pipeline-string/addPipelineCommand.d.ts

@@ -0,0 +1,17 @@
+import type { PipelineString } from '../../../pipeline/PipelineString';
+import type { string_markdown_text } from '../../../types/typeAliases';
+type AddPipelineCommandOptions = {
+    commandString: string_markdown_text;
+    pipelineString: PipelineString;
+};
+/**
+ * @@@
+ *
+ * @public exported from `@promptbook/editable`
+ */
+export declare function addPipelineCommand(options: AddPipelineCommandOptions): PipelineString;
+export {};
+/**
+ * TODO: [🧠] What is the better solution - `- xxx`, - `-   xxx` or preserve (see also next TODO)
+ * TODO: When existing commands 1) as 2) number 3) list, add 4) new command as next number
+ */

package/esm/typings/src/utils/editable/edit-pipeline-string/deflatePipeline.d.ts

@@ -0,0 +1,10 @@
+import type { PipelineString } from '../../../pipeline/PipelineString';
+/**
+ * @@@
+ *
+ * @public exported from `@promptbook/editable`
+ */
+export declare function deflatePipeline(pipelineString: PipelineString): PipelineString;
+/**
+ * TODO: Unit test
+ */

package/esm/typings/src/utils/editable/{utils → edit-pipeline-string}/removePipelineCommand.d.ts

@@ -11,7 +11,7 @@ type RemovePipelineCommandOptions = {
     /**
      * Pipeline you want to remove command from
      */
-    pipeline: PipelineString;
+    pipelineString: PipelineString;
 };
 /**
  * Function `removePipelineCommand` will remove one command from pipeline string

package/esm/typings/src/utils/editable/edit-pipeline-string/removePipelineCommand.test.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,7 @@
+import type { PipelineString } from '../../../pipeline/PipelineString';
+/**
+ * @@@
+ *
+ * @public exported from `@promptbook/editable`
+ */
+export declare function isFlatPipeline(pipelineString: PipelineString): boolean;

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

@@ -24,3 +24,6 @@ type RenameParameterOptions = {
  */
 export declare function renamePipelineParameter(options: RenameParameterOptions): PipelineJson;
 export {};
+/**
+ * TODO: Also variant for `edit-pipeline-string`
+ */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/fake-llm",
-    "version": "0.83.0",
+    "version": "0.84.0-10",
     "description": "It's time for a paradigm shift. The future of software in plain English, French or Latin",
     "--note-0": "    <- [🐊]",
     "private": false,
@@ -10,7 +10,7 @@
         "url": "https://github.com/webgptorg/promptbook"
     },
     "contributors": [
-        "Pavol Hejný <me@pavolhejny.com> (https://www.pavolhejny.com/)"
+        "Pavol Hejný <pavol@ptbk.io> (https://www.pavolhejny.com/)"
     ],
     "--todo-0": "TODO: [❇️] Make better list of keywords",
     "keywords": [
@@ -54,7 +54,7 @@
     "module": "./esm/index.es.js",
     "typings": "./esm/typings/src/_packages/fake-llm.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.83.0"
+        "@promptbook/core": "0.84.0-10"
     },
     "dependencies": {
         "lorem-ipsum": "2.0.8",

package/umd/index.umd.js

@@ -23,7 +23,7 @@
      * @generated
      * @see https://github.com/webgptorg/promptbook
      */
-    var PROMPTBOOK_ENGINE_VERSION = '0.82.0';
+    var PROMPTBOOK_ENGINE_VERSION = '0.84.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
@@ -257,7 +257,7 @@
      *
      * @public exported from `@promptbook/core`
      */
-    var ADMIN_EMAIL = 'me@pavolhejny.com';
+    var ADMIN_EMAIL = 'pavol@ptbk.io';
     /**
      * Name of the responsible person for the Promptbook on GitHub
      *
@@ -546,7 +546,7 @@
      *
      * @private within the repository
      */
-    var REPLACING_NONCE = 'u$k42k%!V2zo34w7Fu#@QUHYPW';
+    var REPLACING_NONCE = 'ptbkauk42kV2dzao34faw7FudQUHYPtW';
     /**
      * @@@
      *
@@ -1639,7 +1639,7 @@
     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;
+            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 pavol@ptbk.io\n\n                "); })) || this;
             _this.name = 'NotYetImplementedError';
             Object.setPrototypeOf(_this, NotYetImplementedError.prototype);
             return _this;