@promptbook/legacy-documents 0.77.1 → 0.78.0-0

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

@@ -30,6 +30,9 @@ import { pipelineJsonToString } from '../conversion/pipelineJsonToString';
 import { pipelineStringToJson } from '../conversion/pipelineStringToJson';
 import { pipelineStringToJsonSync } from '../conversion/pipelineStringToJsonSync';
 import { prettifyPipelineString } from '../conversion/prettify/prettifyPipelineString';
+import { extractParameterNamesFromTask } from '../conversion/utils/extractParameterNamesFromTask';
+import { removePipelineCommand } from '../conversion/utils/removePipelineCommand';
+import { renamePipelineParameter } from '../conversion/utils/renamePipelineParameter';
 import { stringifyPipelineJson } from '../conversion/utils/stringifyPipelineJson';
 import { validatePipeline } from '../conversion/validation/validatePipeline';
 import { CallbackInterfaceTools } from '../dialogs/callback/CallbackInterfaceTools';
@@ -145,6 +148,9 @@ export { pipelineJsonToString };
 export { pipelineStringToJson };
 export { pipelineStringToJsonSync };
 export { prettifyPipelineString };
+export { extractParameterNamesFromTask };
+export { removePipelineCommand };
+export { renamePipelineParameter };
 export { stringifyPipelineJson };
 export { validatePipeline };
 export { CallbackInterfaceTools };

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

@@ -5,6 +5,8 @@ import type { PipelineBothCommandParser } from '../commands/_common/types/Comman
 import type { PipelineHeadCommandParser } from '../commands/_common/types/CommandParser';
 import type { PipelineTaskCommandParser } from '../commands/_common/types/CommandParser';
 import type { CommandParserInput } from '../commands/_common/types/CommandParser';
+import type { CommandType } from '../commands/_common/types/CommandType';
+import type { CommandTypeOrAlias } from '../commands/_common/types/CommandType';
 import type { CommandUsagePlace } from '../commands/_common/types/CommandUsagePlaces';
 import type { ExpectCommand } from '../commands/EXPECT/ExpectCommand';
 import type { ForeachJson } from '../commands/FOREACH/ForeachJson';
@@ -263,6 +265,8 @@ export type { PipelineBothCommandParser };
 export type { PipelineHeadCommandParser };
 export type { PipelineTaskCommandParser };
 export type { CommandParserInput };
+export type { CommandType };
+export type { CommandTypeOrAlias };
 export type { CommandUsagePlace };
 export type { ExpectCommand };
 export type { ForeachJson };

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

@@ -1,9 +1,6 @@
 import { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION } from '../version';
 import { renderPromptbookMermaid } from '../conversion/prettify/renderPipelineMermaidOptions';
-import { extractParameterNamesFromTask } from '../conversion/utils/extractParameterNamesFromTask';
-import { extractVariables } from '../conversion/utils/extractVariables';
-import { renameParameter } from '../conversion/utils/renameParameter';
-import { titleToName } from '../conversion/utils/titleToName';
+import { extractVariablesFromScript } from '../conversion/utils/extractVariablesFromScript';
 import { deserializeError } from '../errors/utils/deserializeError';
 import { serializeError } from '../errors/utils/serializeError';
 import { forEachAsync } from '../execution/utils/forEachAsync';
@@ -45,6 +42,7 @@ import { parseKeywords } from '../utils/normalization/parseKeywords';
 import { parseKeywordsFromString } from '../utils/normalization/parseKeywordsFromString';
 import { removeDiacritics } from '../utils/normalization/removeDiacritics';
 import { searchKeywords } from '../utils/normalization/searchKeywords';
+import { titleToName } from '../utils/normalization/titleToName';
 import { spaceTrim } from '../utils/organization/spaceTrim';
 import { extractParameterNames } from '../utils/parameters/extractParameterNames';
 import { replaceParameters } from '../utils/parameters/replaceParameters';
@@ -75,10 +73,7 @@ import { isValidUrl } from '../utils/validators/url/isValidUrl';
 import { isValidUuid } from '../utils/validators/uuid/isValidUuid';
 export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };
 export { renderPromptbookMermaid };
-export { extractParameterNamesFromTask };
-export { extractVariables };
-export { renameParameter };
-export { titleToName };
+export { extractVariablesFromScript };
 export { deserializeError };
 export { serializeError };
 export { forEachAsync };
@@ -120,6 +115,7 @@ export { parseKeywords };
 export { parseKeywordsFromString };
 export { removeDiacritics };
 export { searchKeywords };
+export { titleToName };
 export { spaceTrim };
 export { extractParameterNames };
 export { replaceParameters };

package/esm/typings/src/commands/_common/types/CommandType.d.ts

@@ -0,0 +1,17 @@
+import type { Command } from './Command';
+/**
+ * Command is one piece of the book file section which adds some logic to the task or the whole pipeline.
+ * It is parsed from the markdown from ul/ol items - one command per one item.
+ *
+ * This is a type of the command like "KNOWLEDGE" or "PERSONA"
+ */
+export type CommandType = Command['type'];
+/**
+ * Command is one piece of the book file section which adds some logic to the task or the whole pipeline.
+ * It is parsed from the markdown from ul/ol items - one command per one item.
+ *
+ * This is a type of the command like "KNOWLEDGE" or "PERSONA"
+ *
+export type CommandTypeOrAlias = Command['type'] | Command['aliasNames'] | Command['deprecatedNames'];
+// <- TODO: [🧘] Implement
+*/

package/esm/typings/src/conversion/utils/extractParameterNamesFromTask.d.ts

@@ -7,7 +7,7 @@ import type { string_parameter_name } from '../../types/typeAliases';
  * @param task the task with used parameters
  * @returns the set of parameter names
  * @throws {ParseError} if the script is invalid
- * @public exported from `@promptbook/utils`
+ * @public exported from `@promptbook/core` <- Note: [👖] This utility is so tightly interconnected with the Promptbook that it is not exported as util but in core
  */
 export declare function extractParameterNamesFromTask(task: ReadonlyDeep<Pick<TaskJson, 'title' | 'description' | 'taskType' | 'content' | 'preparedContent' | 'jokerParameterNames' | 'foreach'>>): Set<string_parameter_name>;
 /**

package/esm/typings/src/conversion/utils/{extractVariables.d.ts → extractVariablesFromScript.d.ts}

@@ -6,9 +6,9 @@ import type { string_javascript_name } from '../../types/typeAliases';
  * @param script from which to extract the variables
  * @returns the list of variable names
  * @throws {ParseError} if the script is invalid
- * @public exported from `@promptbook/utils`
+ * @public exported from `@promptbook/utils` <- Note: [👖] This is usable elsewhere than in Promptbook, so keeping in utils
  */
-export declare function extractVariables(script: string_javascript): Set<string_javascript_name>;
+export declare function extractVariablesFromScript(script: string_javascript): Set<string_javascript_name>;
 /**
  * TODO: [🔣] Support for multiple languages - python, java,...
  */

package/esm/typings/src/conversion/utils/removePipelineCommand.d.ts

@@ -0,0 +1,22 @@
+import type { CommandType } from '../../commands/_common/types/CommandType';
+import type { PipelineString } from '../../pipeline/PipelineString';
+/**
+ * Options for `removePipelineCommand`
+ */
+type RemovePipelineCommandOptions = {
+    /**
+     * The command you want to remove
+     */
+    command: CommandType;
+    /**
+     * Pipeline you want to remove command from
+     */
+    pipeline: PipelineString;
+};
+/**
+ * Function `removePipelineCommand` will remove one command from pipeline string
+ *
+ * @public exported from `@promptbook/core` <- Note: [👖] This utility is so tightly interconnected with the Promptbook that it is not exported as util but in core
+ */
+export declare function removePipelineCommand(options: RemovePipelineCommandOptions): PipelineString;
+export {};

package/esm/typings/src/conversion/utils/{renameParameter.d.ts → renamePipelineParameter.d.ts}

@@ -16,11 +16,11 @@ type RenameParameterOptions = {
     readonly newParameterName: string_name;
 };
 /**
- * Function `renameParameter` will find all usable parameters for given task
+ * Function `renamePipelineParameter` will find all usable parameters for given task
  * In other words, it will find all parameters that are not used in the task itseld and all its dependencies
  *
  * @throws {PipelineLogicError} If the new parameter name is already used in the pipeline
- * @public exported from `@promptbook/utils`
+ * @public exported from `@promptbook/core` <- Note: [👖] This utility is so tightly interconnected with the Promptbook that it is not exported as util but in core
  */
-export declare function renameParameter(options: RenameParameterOptions): PipelineJson;
+export declare function renamePipelineParameter(options: RenameParameterOptions): PipelineJson;
 export {};

package/esm/typings/src/utils/normalization/titleToName.test.d.ts

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

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/legacy-documents",
-    "version": "0.77.1",
+    "version": "0.78.0-0",
     "description": "It's time for a paradigm shift. The future of software in plain English, French or Latin",
     "--note-0": "    <- [🐊]",
     "private": false,
@@ -54,7 +54,7 @@
     "module": "./esm/index.es.js",
     "typings": "./esm/typings/src/_packages/legacy-documents.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.77.1"
+        "@promptbook/core": "0.78.0-0"
     },
     "dependencies": {
         "colors": "1.4.0",

package/umd/index.umd.js

@@ -23,7 +23,7 @@
      *
      * @see https://github.com/webgptorg/promptbook
      */
-    var PROMPTBOOK_ENGINE_VERSION = '0.77.0';
+    var PROMPTBOOK_ENGINE_VERSION = '0.77.1';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -740,32 +740,12 @@
      */
 
     /**
-     * Tests if given string is valid URL.
-     *
-     * Note: Dataurl are considered perfectly valid.
-     * Note: There are two simmilar functions:
-     * - `isValidUrl` which tests any URL
-     * - `isValidPipelineUrl` *(this one)* which tests just promptbook URL
+     * @@@
      *
-     * @public exported from `@promptbook/utils`
+     * @private for `FileCacheStorage`
      */
-    function isValidUrl(url) {
-        if (typeof url !== 'string') {
-            return false;
-        }
-        try {
-            if (url.startsWith('blob:')) {
-                url = url.replace(/^blob:/, '');
-            }
-            var urlObject = new URL(url /* because fail is handled */);
-            if (!['http:', 'https:', 'data:'].includes(urlObject.protocol)) {
-                return false;
-            }
-            return true;
-        }
-        catch (error) {
-            return false;
-        }
+    function nameToSubfolderPath(name) {
+        return [name.substr(0, 1).toLowerCase(), name.substr(1, 1).toLowerCase()];
     }
 
     var defaultDiacriticsRemovalMap = [
@@ -1133,6 +1113,35 @@
         return false;
     }
 
+    /**
+     * Tests if given string is valid URL.
+     *
+     * Note: Dataurl are considered perfectly valid.
+     * Note: There are two simmilar functions:
+     * - `isValidUrl` which tests any URL
+     * - `isValidPipelineUrl` *(this one)* which tests just promptbook URL
+     *
+     * @public exported from `@promptbook/utils`
+     */
+    function isValidUrl(url) {
+        if (typeof url !== 'string') {
+            return false;
+        }
+        try {
+            if (url.startsWith('blob:')) {
+                url = url.replace(/^blob:/, '');
+            }
+            var urlObject = new URL(url /* because fail is handled */);
+            if (!['http:', 'https:', 'data:'].includes(urlObject.protocol)) {
+                return false;
+            }
+            return true;
+        }
+        catch (error) {
+            return false;
+        }
+    }
+
     /**
      * @@@
      *
@@ -1157,15 +1166,6 @@
         return value;
     }
 
-    /**
-     * @@@
-     *
-     * @private for `FileCacheStorage`
-     */
-    function nameToSubfolderPath(name) {
-        return [name.substr(0, 1).toLowerCase(), name.substr(1, 1).toLowerCase()];
-    }
-
     /**
      * Create a filename for intermediate cache for scrapers
      *
@@ -3840,9 +3840,9 @@
      * @param script from which to extract the variables
      * @returns the list of variable names
      * @throws {ParseError} if the script is invalid
-     * @public exported from `@promptbook/utils`
+     * @public exported from `@promptbook/utils` <- Note: [👖] This is usable elsewhere than in Promptbook, so keeping in utils
      */
-    function extractVariables(script) {
+    function extractVariablesFromScript(script) {
         var variables = new Set();
         script = "(()=>{".concat(script, "})()");
         try {
@@ -3889,7 +3889,7 @@
      * @param task the task with used parameters
      * @returns the set of parameter names
      * @throws {ParseError} if the script is invalid
-     * @public exported from `@promptbook/utils`
+     * @public exported from `@promptbook/core` <- Note: [👖] This utility is so tightly interconnected with the Promptbook that it is not exported as util but in core
      */
     function extractParameterNamesFromTask(task) {
         var e_1, _a, e_2, _b, e_3, _c, e_4, _d;
@@ -3910,7 +3910,7 @@
         }
         if (taskType === 'SCRIPT_TASK') {
             try {
-                for (var _g = __values(extractVariables(content)), _h = _g.next(); !_h.done; _h = _g.next()) {
+                for (var _g = __values(extractVariablesFromScript(content)), _h = _g.next(); !_h.done; _h = _g.next()) {
                     var parameterName = _h.value;
                     parameterNames.add(parameterName);
                 }