@promptbook/markdown-utils 0.77.1 → 0.78.2

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

@@ -5,6 +5,8 @@ import { createCollectionFromPromise } from '../collection/constructors/createCo
 import { createCollectionFromUrl } from '../collection/constructors/createCollectionFromUrl';
 import { createSubcollection } from '../collection/constructors/createSubcollection';
 import { NAME } from '../config';
+import { ADMIN_EMAIL } from '../config';
+import { ADMIN_GITHUB_NAME } from '../config';
 import { CLAIM } from '../config';
 import { LOGO_LIGHT_SRC } from '../config';
 import { LOGO_DARK_SRC } from '../config';
@@ -30,6 +32,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';
@@ -120,6 +125,8 @@ export { createCollectionFromPromise };
 export { createCollectionFromUrl };
 export { createSubcollection };
 export { NAME };
+export { ADMIN_EMAIL };
+export { ADMIN_GITHUB_NAME };
 export { CLAIM };
 export { LOGO_LIGHT_SRC };
 export { LOGO_DARK_SRC };
@@ -145,6 +152,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/config.d.ts

@@ -1,5 +1,7 @@
 import type { CsvSettings } from './formats/csv/CsvSettings';
 import type { IntermediateFilesStrategy } from './types/IntermediateFilesStrategy';
+import type { string_email } from './types/typeAliases';
+import type { string_name } from './types/typeAliases';
 import type { string_url_image } from './types/typeAliases';
 /**
  * Warning message for the generated sections and files files
@@ -15,6 +17,18 @@ export declare const GENERATOR_WARNING = "\u26A0\uFE0F WARNING: This code has be
  * @public exported from `@promptbook/core`
  */
 export declare const NAME = "Promptbook";
+/**
+ * Email of the responsible person
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const ADMIN_EMAIL: string_email;
+/**
+ * Name of the responsible person for the Promptbook on GitHub
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const ADMIN_GITHUB_NAME: string_name;
 /**
  * Claim for the Promptbook
  *

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/errors/utils/getErrorReportUrl.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Make error report URL for the given error
+ *
+ * @private !!!!!!
+ */
+export declare function getErrorReportUrl(error: Error): URL;

package/esm/typings/src/execution/execution-report/ExecutionReportString.d.ts

@@ -12,5 +12,5 @@ export type ExecutionReportString = string & {
     readonly _type: 'ExecutionReportString';
 };
 /**
- * TODO: Better validation or remove branded type and make it just string
+ * TODO: [💩] Better validation or remove branded type and make it just string
  */

package/esm/typings/src/llm-providers/openai/openai-models.d.ts

@@ -24,7 +24,7 @@ export declare const OPENAI_MODELS: ReadonlyArray<AvailableModel & {
  * @see https://platform.openai.com/docs/models/gpt-4-turbo-and-gpt-4
  * @see https://openai.com/api/pricing/
  * @see /other/playground/playground.ts
- * TODO: [🍓] Make better
+ * TODO: [🍓][💩] Make better
  * TODO: Change model titles to human eg: "gpt-4-turbo-2024-04-09" -> "GPT-4 Turbo (2024-04-09)"
  * TODO: [🚸] Not all models are compatible with JSON mode, add this information here and use it
  * Note: [💞] Ignore a discrepancy between file name and entity name

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

@@ -8,5 +8,5 @@ export type PipelineString = string & {
     readonly _type: 'Promptbook';
 };
 /**
- * TODO: !! Better validation (validatePipelineString) or remove branded type and make it just string
+ * TODO: [💩] Better validation (validatePipelineString) or remove branded type and make it just string
  */

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

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

package/package.json

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