@promptbook/website-crawler - npm Package Compare versions

Comparing version 0.81.0-19 to 0.81.0-21

esm/typings/books/index.d.ts

@@ -92,3 +92,41 @@ declare const _default: ({
     sourceFile: string;
+} | {
+    title: string;
+    pipelineUrl: string;
+    formfactorName: string;
+    parameters: {
+        name: string;
+        description: string;
+        isInput: boolean;
+        isOutput: boolean;
+    }[];
+    tasks: {
+        taskType: string;
+        name: string;
+        title: string;
+        content: string;
+        resultingParameterName: string;
+        expectations: {
+            words: {
+                min: number;
+                max: number;
+            };
+            lines: {
+                min: number;
+                max: number;
+            };
+        };
+        dependentParameterNames: string[];
+    }[];
+    personas: never[];
+    preparations: never[];
+    knowledgeSources: never[];
+    knowledgePieces: never[];
+    sources: {
+        type: string;
+        path: null;
+        content: string;
+    }[];
+    sourceFile: string;
 })[];
 export default _default;

esm/typings/src/_packages/core.index.d.ts

@@ -13,3 +13,3 @@ import { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION } from '../version';
 import { LOGO_DARK_SRC } from '../config';
-import { DEFAULT_TITLE } from '../config';
+import { DEFAULT_BOOK_TITLE } from '../config';
 import { MAX_FILENAME_LENGTH } from '../config';
@@ -35,4 +35,4 @@ import { DEFAULT_INTERMEDIATE_FILES_STRATEGY } from '../config';
 import { compilePipeline } from '../conversion/compilePipeline';
+import { parsePipeline } from '../conversion/parsePipeline';
 import { pipelineJsonToString } from '../conversion/pipelineJsonToString';
-import { precompilePipeline } from '../conversion/precompilePipeline';
 import { prettifyPipelineString } from '../conversion/prettify/prettifyPipelineString';
@@ -137,3 +137,3 @@ import { extractParameterNamesFromTask } from '../conversion/utils/extractParameterNamesFromTask';
 export { LOGO_DARK_SRC };
-export { DEFAULT_TITLE };
+export { DEFAULT_BOOK_TITLE };
 export { MAX_FILENAME_LENGTH };
@@ -159,4 +159,4 @@ export { DEFAULT_INTERMEDIATE_FILES_STRATEGY };
 export { compilePipeline };
+export { parsePipeline };
 export { pipelineJsonToString };
-export { precompilePipeline };
 export { prettifyPipelineString };
@@ -163,0 +163,0 @@ export { extractParameterNamesFromTask };

esm/typings/src/config.d.ts

@@ -61,3 +61,3 @@ import type { CsvSettings } from './formats/csv/CsvSettings';
  */
-export declare const DEFAULT_TITLE = "Untitled";
+export declare const DEFAULT_BOOK_TITLE = "\u2728 Untitled Book";
 /**
@@ -64,0 +64,0 @@ * Warning message for the generated sections and files files

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

@@ -8,6 +8,3 @@ import type { ExecutionTools } from '../execution/ExecutionTools';
  *
- * Note: There are 3 similar functions:
- * - `compilePipeline` **(preferred)** - which propperly compiles the promptbook and use embedding for external knowledge
- * - `precompilePipeline` - use only if you need to compile promptbook synchronously and it contains NO external knowledge
- * - `preparePipeline` - just one step in the compilation process
+ * @see https://github.com/webgptorg/promptbook/discussions/196
  *
@@ -14,0 +11,0 @@ * Note: This function does not validate logic of the pipeline only the parsing

esm/typings/src/high-level-abstractions/_common/HighLevelAbstraction.d.ts

 import type { $PipelineJson } from '../../commands/_common/types/CommandParser';
 /**
- * Used in `precompilePipeline`
+ * Used in `parsePipeline`
  *
@@ -5,0 +5,0 @@ * @private

esm/typings/src/high-level-abstractions/index.d.ts

 /**
  * All high-level abstractions
  *
- * @private internal index of `precompilePipeline` (= used for sync) and `preparePipeline` (= used for async)
+ * @private internal index of `parsePipeline` (= used for sync) and `preparePipeline` (= used for async)
  */
@@ -6,0 +6,0 @@ export declare const HIGH_LEVEL_ABSTRACTIONS: readonly [{

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

 import type { PipelineString } from './PipelineString';
 /**
- * Function for notating a pipeline with a book\`...\ notation as template literal
+ * Tag function for notating a pipeline with a book\`...\ notation as template literal
  *
@@ -12,5 +12,5 @@ * @param strings @@@
 /**
- * TODO: !!!!!! Use book\`...\ notation instead of as PipelineString
+ * TODO: Use ACRY book\`...\ notation instead of as PipelineString
  * TODO: [🧠][🈴] Where is the best location for this file
  * Note: [💞] Ignore a discrepancy between file name and entity name
  */

esm/typings/src/prepare/isPipelinePrepared.d.ts

@@ -5,2 +5,4 @@ import type { PipelineJson } from '../pipeline/PipelineJson/PipelineJson';
  *
+ * @see https://github.com/webgptorg/promptbook/discussions/196
+ *
  * @public exported from `@promptbook/core`
@@ -7,0 +9,0 @@ */

esm/typings/src/prepare/preparePipeline.d.ts

@@ -7,2 +7,4 @@ import type { ExecutionTools } from '../execution/ExecutionTools';
  *
+ * @see https://github.com/webgptorg/promptbook/discussions/196
+ *
  * Note: This function does not validate logic of the pipeline
@@ -9,0 +11,0 @@ * Note: This function acts as part of compilation process

esm/typings/src/scrapers/_common/Converter.d.ts

@@ -7,2 +7,3 @@ import type { ScraperAndConverterMetadata } from './register/ScraperAndConverterMetadata';
  *
+ * Note: [🌏] Converters are not usable in browser because they produce a files
  */
@@ -9,0 +10,0 @@ export type Converter = {

esm/typings/src/scrapers/_common/register/ScraperAndConverterMetadata.d.ts

@@ -31,2 +31,4 @@ import type { Executables } from '../../../execution/Executables';
      * @@@
+     *
+     * Note: [🌏] Only `MarkdownScraper` makes sense to be available in the browser, for scraping non-markdown sources in the browser use a remote server
      */
@@ -33,0 +35,0 @@ readonly isAvilableInBrowser: boolean;

esm/typings/src/scrapers/_common/Scraper.d.ts

@@ -10,3 +10,2 @@ import type { Promisable } from 'type-fest';
  * @@@
- *
  */
@@ -57,2 +56,3 @@ export type Scraper = {
 /**
+ * TODO: [🧠] Maybe split `ScraperSourceHandler` into `ScraperWebsiteSourceHandler` + `ScraperFileSourceHandler`
  * TODO: [🥽] Add ` asBlob(): Promisable<Blob>;` or asFile
@@ -59,0 +59,0 @@ * TODO: [🐝] @@@ Annotate all

esm/typings/src/scrapers/_common/ScraperIntermediateSource.d.ts

@@ -12,1 +12,4 @@ import type { IDestroyable } from 'destroyable';
 };
+/**
+ * Note: [🌏] Converters can be used only in node because they uses `ScraperIntermediateSource` which  uses file system
+ */

esm/typings/src/scrapers/pdf/createPdfScraper.d.ts

@@ -15,3 +15,3 @@ import type { ExecutionTools } from '../../execution/ExecutionTools';
     documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
-    isAvilableInBrowser: true;
+    isAvilableInBrowser: false;
     requiredExecutables: never[];
@@ -18,0 +18,0 @@ }>;

esm/typings/src/scrapers/pdf/PdfScraper.d.ts

@@ -40,2 +40,3 @@ import type { KnowledgePiecePreparedJson } from '../../pipeline/PipelineJson/KnowledgePieceJson';
  * 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
  */

esm/typings/src/scrapers/pdf/register-metadata.d.ts

@@ -13,3 +13,3 @@ import type { Registration } from '../../utils/$Register';
     documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
-    isAvilableInBrowser: true;
+    isAvilableInBrowser: false;
     requiredExecutables: never[];
@@ -16,0 +16,0 @@ }>;

esm/typings/src/scrapers/website/createWebsiteScraper.d.ts

@@ -15,3 +15,3 @@ import type { ExecutionTools } from '../../execution/ExecutionTools';
     documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
-    isAvilableInBrowser: true; /**
+    isAvilableInBrowser: false; /**
      * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
@@ -18,0 +18,0 @@ */

esm/typings/src/scrapers/website/register-metadata.d.ts

@@ -13,3 +13,3 @@ import type { Registration } from '../../utils/$Register';
     documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
-    isAvilableInBrowser: true;
+    isAvilableInBrowser: false;
     requiredExecutables: never[];
@@ -16,0 +16,0 @@ }>;

esm/typings/src/utils/markdown/flattenMarkdown.d.ts

@@ -5,3 +5,3 @@ import type { string_markdown } from '../../types/typeAliases';
  *
- * - It always have h1 - if there is no h1 in the markdown, it will be added "# Untitled"
+ * - It always have h1 - if there is no h1 in the markdown, it will be added `DEFAULT_BOOK_TITLE`
  * - All other headings are normalized to h2
@@ -8,0 +8,0 @@ *

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

@@ -11,4 +11,7 @@ import { Promisable } from 'type-fest';
 /**
+ * Wizzard for simple usage of the Promptbook
  * Look at `wizzard` for more details
  *
+ * Note: This works only in Node.js environment and looks for the configuration, environment, tools and cache in the Node.js environment
+ *
  * @private just for single instance
@@ -18,8 +21,16 @@ */
     /**
-     * @@@!!!!!!
+     * 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
+     * 3) As a string
+     *
+     * Note: This works simmilar to the `ptbk run` command
      */
-    execute(book: string_pipeline_url, inputParameters: InputParameters, onProgress?: (taskProgress: TaskProgress) => Promisable<void>): Promise<PipelineExecutorResult>;
+    execute(book: string_pipeline_url | string_filename | PipelineString, inputParameters: InputParameters, onProgress?: (taskProgress: TaskProgress) => Promisable<void>): Promise<PipelineExecutorResult>;
     private executionTools;
     /**
-     * @@@!!!
+     * Provides the tools automatically for the Node.js environment
      *
@@ -30,8 +41,9 @@ * @param pipelineSource
     /**
-     * TODO: Make standalone function from this exported from node and used here and in `ptbk run`
-     * @@@!!!
+     * Load book from the source
      *
-     * Strategies:
-     * 1) @@@!!!
-     * 2) @@@!!!
+     * 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
+     * 3) As a string
      *
@@ -43,4 +55,6 @@ * @param pipelineSource
 /**
- * 🧙‍♂️ @@@
+ * Wizzard for simple usage of the Promptbook
  *
+ * Note: This works only in Node.js environment and looks for the configuration, environment, tools and cache in the Node.js environment
+ *
  * @singleton
@@ -52,5 +66,3 @@ * @public exported from `@promptbook/wizzard`
 /**
- * TODO: !!!!!! Mark in jsdoc as non-pure
- * TODO: !!!!!! Add to readmes - one markdown here imported in all packages
  * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
  */

package.json

 {
     "name": "@promptbook/website-crawler",
-    "version": "0.81.0-19",
+    "version": "0.81.0-21",
     "description": "It's time for a paradigm shift. The future of software in plain English, French or Latin",
@@ -57,3 +57,3 @@ "--note-0": "    <- [🐊]",
     "peerDependencies": {
-        "@promptbook/core": "0.81.0-19"
+        "@promptbook/core": "0.81.0-21"
     },
@@ -60,0 +60,0 @@ "dependencies": {

README.md

@@ -129,10 +129,37 @@ <!-- ⚠️ WARNING: This code has been generated so that any manual changes will be overwritten -->
 
-Also we have a community of developers and users:
+We also have a community of developers and users of **Promptbook**:
 
--   [Discord](https://discord.gg/x3QWNaa89N)
--   [Landing page](https://ptbk.io)
+-   [Discord community](https://discord.gg/x3QWNaa89N)
+-   [Landing page `ptbk.io`](https://ptbk.io)
 -   [Github discussions](https://github.com/webgptorg/promptbook/discussions)
+-   [LinkedIn `Promptbook`](https://linkedin.com/company/promptbook)
+-   [Facebook `Promptbook`](https://www.facebook.com/61560776453536) 
 
+And **Promptbook.studio** branded socials:
 
 
+
+-   [Instagram `@promptbook.studio`](https://www.instagram.com/promptbook.studio/)
+
+
+
+And **Promptujeme** sub-brand:
+
+*/Subbrand for Czech clients/*
+
+
+
+-   [Promptujeme.cz](https://www.promptujeme.cz/)
+-   [Facebook `Promptujeme`](https://www.facebook.com/promptujeme/)
+
+
+And **Promptbook.city** branded socials:
+
+*/Sub-brand for images and graphics generated via Promptbook prompting/*
+
+-   [Instagram `@promptbook.city`](https://www.instagram.com/promptbook.city/)
+-   [Facebook `Promptbook City`](https://www.facebook.com/61565718625569) 
+
+
+
 ## 💙 Book language _(for prompt-engineer)_
@@ -268,2 +295,7 @@
 
+
+
+
+
+
 ### 📚 Dictionary
@@ -284,2 +316,4 @@
 
+
+
 _Note: Thos section is not complete dictionary, more list of general AI / LLM terms that has connection with Promptbook_
@@ -345,2 +379,4 @@
 
+
+
 ### Terms specific to Promptbook TypeScript implementation
@@ -347,0 +383,0 @@

New alerts

Long strings

Supply chain risk

Contains long string literals, which may be a sign of obfuscated or packed code.

Found 1 instance in 1 package

Fixed alerts

Long strings

Supply chain risk

Contains long string literals, which may be a sign of obfuscated or packed code.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

1593328

increased by0.92%

Number of package files

650

increased by0.15%

Lines of code

25054

increased by0.69%

Number of lines in readme file

456

increased by8.57%

No dependency changes