@promptbook/markdown-utils 0.81.0-16 → 0.81.0-18

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

@@ -93,6 +93,8 @@ import { MultipleLlmExecutionTools } from '../llm-providers/multiple/MultipleLlm
 import { _OpenAiMetadataRegistration } from '../llm-providers/openai/register-configuration';
 import { _OpenAiAssistantMetadataRegistration } from '../llm-providers/openai/register-configuration';
 import { preparePersona } from '../personas/preparePersona';
+import { book } from '../pipeline/book-notation';
+import { isValidPipelineString } from '../pipeline/isValidPipelineString';
 import { GENERIC_PIPELINE_INTERFACE } from '../pipeline/PipelineInterface/constants';
 import { getPipelineInterface } from '../pipeline/PipelineInterface/getPipelineInterface';
 import { isPipelineImplementingInterface } from '../pipeline/PipelineInterface/isPipelineImplementingInterface';
@@ -213,6 +215,8 @@ export { MultipleLlmExecutionTools };
 export { _OpenAiMetadataRegistration };
 export { _OpenAiAssistantMetadataRegistration };
 export { preparePersona };
+export { book };
+export { isValidPipelineString };
 export { GENERIC_PIPELINE_INTERFACE };
 export { getPipelineInterface };
 export { isPipelineImplementingInterface };

package/esm/typings/src/_packages/markdown-utils.index.d.ts

@@ -19,7 +19,7 @@ import { extractOneBlockFromMarkdown } from '../utils/markdown/extractOneBlockFr
 import { flattenMarkdown } from '../utils/markdown/flattenMarkdown';
 import type { MarkdownSection } from '../utils/markdown/parseMarkdownSection';
 import { parseMarkdownSection } from '../utils/markdown/parseMarkdownSection';
-import { removeContentComments } from '../utils/markdown/removeContentComments';
+import { removeMarkdownComments } from '../utils/markdown/removeMarkdownComments';
 import { removeMarkdownFormatting } from '../utils/markdown/removeMarkdownFormatting';
 import { splitMarkdownIntoSections } from '../utils/markdown/splitMarkdownIntoSections';
 export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };
@@ -43,6 +43,6 @@ export { extractOneBlockFromMarkdown };
 export { flattenMarkdown };
 export type { MarkdownSection };
 export { parseMarkdownSection };
-export { removeContentComments };
+export { removeMarkdownComments };
 export { removeMarkdownFormatting };
 export { splitMarkdownIntoSections };

package/esm/typings/src/formfactors/generator/GeneratorFormfactorDefinition.d.ts

@@ -5,15 +5,20 @@
  */
 export declare const GeneratorFormfactorDefinition: {
     readonly name: "GENERATOR";
-    readonly description: "@@@";
+    readonly description: "Generates any kind (in HTML with possible scripts and css format) of content from input message";
     readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/184";
     readonly pipelineInterface: {
         readonly inputParameters: readonly [{
-            readonly name: "nonce";
-            readonly description: "Just to prevent GENERATOR to be set as implicit formfactor";
+            readonly name: "inputMessage";
+            readonly description: "Input message to be image made from";
             readonly isInput: true;
             readonly isOutput: false;
         }];
-        readonly outputParameters: readonly [];
+        readonly outputParameters: readonly [{
+            readonly name: "result";
+            readonly description: "Result in HTML to be shown to user";
+            readonly isInput: false;
+            readonly isOutput: true;
+        }];
     };
 };

package/esm/typings/src/formfactors/image-generator/ImageGeneratorFormfactorDefinition.d.ts

@@ -5,7 +5,7 @@
  */
 export declare const ImageGeneratorFormfactorDefinition: {
     readonly name: "IMAGE_GENERATOR";
-    readonly description: "@@@";
+    readonly description: "Generates prompt for image generation from input message";
     readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/184";
     readonly pipelineInterface: {
         readonly inputParameters: readonly [{

package/esm/typings/src/formfactors/index.d.ts

@@ -105,20 +105,25 @@ export declare const FORMFACTOR_DEFINITIONS: readonly [{
     };
 }, {
     readonly name: "GENERATOR";
-    readonly description: "@@@";
+    readonly description: "Generates any kind (in HTML with possible scripts and css format) of content from input message";
     readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/184";
     readonly pipelineInterface: {
         readonly inputParameters: readonly [{
-            readonly name: "nonce";
-            readonly description: "Just to prevent GENERATOR to be set as implicit formfactor";
+            readonly name: "inputMessage";
+            readonly description: "Input message to be image made from";
             readonly isInput: true;
             readonly isOutput: false;
         }];
-        readonly outputParameters: readonly [];
+        readonly outputParameters: readonly [{
+            readonly name: "result";
+            readonly description: "Result in HTML to be shown to user";
+            readonly isInput: false;
+            readonly isOutput: true;
+        }];
     };
 }, {
     readonly name: "IMAGE_GENERATOR";
-    readonly description: "@@@";
+    readonly description: "Generates prompt for image generation from input message";
     readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/184";
     readonly pipelineInterface: {
         readonly inputParameters: readonly [{

package/esm/typings/src/high-level-abstractions/quick-chatbot/QuickChatbotHla.d.ts

@@ -8,3 +8,6 @@ export declare const QuickChatbotHla: {
     type: "SYNC";
     $applyToPipelineJson($pipelineJson: $PipelineJson): void;
 };
+/**
+ * TODO: [🧠][📛] Should this be here?
+ */

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

@@ -0,0 +1,15 @@
+import type { PipelineString } from './PipelineString';
+/**
+ * Function for notating a pipeline with a book\`...\ notation as template literal
+ *
+ * @param strings @@@
+ * @param values @@@
+ * @returns the pipeline string
+ * @public exported from `@promptbook/core`
+ */
+export declare function book(strings: TemplateStringsArray, ...values: Array<string>): PipelineString;
+/**
+ * TODO: !!!!!! Use 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
+ */

package/esm/typings/src/pipeline/isValidPipelineString.d.ts

@@ -0,0 +1,11 @@
+import type { PipelineString } from './PipelineString';
+/**
+ * Function `isValidPipelineString` will validate the if the string is a valid pipeline string
+ * It does not check if the string is fully logically correct, but if it is a string that can be a pipeline string or the string looks completely different.
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare function isValidPipelineString(value: string): value is PipelineString;
+/**
+ * TODO: [🧠][🈴] Where is the best location for this file
+ */

package/esm/typings/src/pipeline/isValidPipelineString.test.d.ts

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

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

@@ -12,7 +12,9 @@ export declare const createWebsiteScraper: ((tools: Pick<ExecutionTools, 'llm'>,
     className: string;
     mimeTypes: string[];
     documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
-    isAvilableInBrowser: false;
+    isAvilableInBrowser: true; /**
+     * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
+     */
     requiredExecutables: never[];
 }>;
 /**

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

@@ -10,7 +10,7 @@ export declare const websiteScraperMetadata: import("type-fest/source/readonly-d
     className: string;
     mimeTypes: string[];
     documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
-    isAvilableInBrowser: false;
+    isAvilableInBrowser: true;
     requiredExecutables: never[];
 }>;
 /**

package/esm/typings/src/utils/markdown/{removeContentComments.d.ts → removeMarkdownComments.d.ts}

@@ -1,10 +1,10 @@
 import type { string_html } from '../../types/typeAliases';
 import type { string_markdown } from '../../types/typeAliases';
 /**
- * Removes HTML or Markdown comments from a string.
+ * Removes Markdown (or HTML) comments
  *
  * @param {string} content - The string to remove comments from.
  * @returns {string} The input string with all comments removed.
  * @public exported from `@promptbook/markdown-utils`
  */
-export declare function removeContentComments<TContent extends string_html | string_markdown>(content: TContent): TContent;
+export declare function removeMarkdownComments<TContent extends string_html | string_markdown>(content: TContent): TContent;

package/esm/typings/src/utils/serialization/isSerializableAsJson.d.ts

@@ -1,4 +1,4 @@
-import { JsonValue } from 'type-fest';
+import type { JsonValue } from 'type-fest';
 /**
  * Tests if the value is [🚉] serializable as JSON
  *

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/markdown-utils",
-    "version": "0.81.0-16",
+    "version": "0.81.0-18",
     "description": "It's time for a paradigm shift. The future of software in plain English, French or Latin",
     "--note-0": "    <- [🐊]",
     "private": false,

package/umd/index.umd.js

@@ -24,7 +24,7 @@
      * @generated
      * @see https://github.com/webgptorg/promptbook
      */
-    var PROMPTBOOK_ENGINE_VERSION = '0.81.0-15';
+    var PROMPTBOOK_ENGINE_VERSION = '0.81.0-17';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -969,7 +969,6 @@
     function deepClone(objectValue) {
         return JSON.parse(JSON.stringify(objectValue));
         /*
-        !!!!!!!!
         TODO: [🧠] Is there a better implementation?
         > const propertyNames = Object.getOwnPropertyNames(objectValue);
         > for (const propertyName of propertyNames) {
@@ -6138,13 +6137,13 @@
      */
 
     /**
-     * Removes HTML or Markdown comments from a string.
+     * Removes Markdown (or HTML) comments
      *
      * @param {string} content - The string to remove comments from.
      * @returns {string} The input string with all comments removed.
      * @public exported from `@promptbook/markdown-utils`
      */
-    function removeContentComments(content) {
+    function removeMarkdownComments(content) {
         return spaceTrim.spaceTrim(content.replace(/<!--(.*?)-->/gs, ''));
     }
 
@@ -6163,7 +6162,7 @@
             return content.replace(sectionRegex, contentToInsert);
         }
         // Note: Following is the case when the section is not found in the file so we add it there
-        var placeForSection = removeContentComments(content).match(/^##.*$/im);
+        var placeForSection = removeMarkdownComments(content).match(/^##.*$/im);
         if (placeForSection !== null) {
             var _a = __read(placeForSection, 1), heading_1 = _a[0];
             return content.replace(heading_1, spaceTrim.spaceTrim(function (block) { return "\n                    ".concat(block(contentToInsert), "\n\n                    ").concat(block(heading_1), "\n                "); }));
@@ -6477,7 +6476,7 @@
     exports.extractOneBlockFromMarkdown = extractOneBlockFromMarkdown;
     exports.flattenMarkdown = flattenMarkdown;
     exports.parseMarkdownSection = parseMarkdownSection;
-    exports.removeContentComments = removeContentComments;
+    exports.removeMarkdownComments = removeMarkdownComments;
     exports.removeMarkdownFormatting = removeMarkdownFormatting;
     exports.splitMarkdownIntoSections = splitMarkdownIntoSections;