@promptbook/remote-client 0.61.0-24 → 0.61.0-26

package/README.md

@@ -83,7 +83,7 @@ File `write-website-content.ptbk.md`:
 > -   PROMPTBOOK VERSION 0.0.1
 > -   INPUT  PARAM `{rawTitle}` Automatically suggested a site name or empty text
 > -   INPUT  PARAM `{rawAssigment}` Automatically generated site entry from image recognition
-> -   OUTPUT PARAM `{content}` Web content
+> -   OUTPUT PARAM `{websiteContent}` Web content
 > -   OUTPUT PARAM `{keywords}` Keywords
 >
 > ## 👤 Specifying the assigment
@@ -242,7 +242,7 @@ File `write-website-content.ptbk.md`:
 > {contentBody}
 > ```
 >
-> `-> {content}`
+> `-> {websiteContent}`
 
 
 
@@ -282,7 +282,7 @@ flowchart LR
       templateCombineTheBeginning--"{contentBeginning}"-->templateCombineTheContent
       templateWriteTheContent--"{contentBody}"-->templateCombineTheContent
 
-      templateCombineTheContent--"{content}"-->output
+      templateCombineTheContent--"{websiteContent}"-->output
       output((Output)):::output
 
       classDef input color: grey;

package/esm/index.es.js

@@ -214,7 +214,7 @@ var RemoteLlmExecutionTools = /** @class */ (function () {
 /**
  * The version of the Promptbook library
  */
-var PROMPTBOOK_VERSION = '0.61.0-23';
+var PROMPTBOOK_VERSION = '0.61.0-25';
 // TODO: !!!! List here all the versions and annotate + put into script
 
 export { PROMPTBOOK_VERSION, RemoteLlmExecutionTools };

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

@@ -1,6 +1,6 @@
 import { spaceTrim } from 'spacetrim';
 import { renderPromptbookMermaid } from '../conversion/prettify/renderPipelineMermaidOptions';
-import { extractParametersFromPromptTemplate } from '../conversion/utils/extractParametersFromPromptTemplate';
+import { extractParameterNamesFromPromptTemplate } from '../conversion/utils/extractParameterNamesFromPromptTemplate';
 import { extractVariables } from '../conversion/utils/extractVariables';
 import { renameParameter } from '../conversion/utils/renameParameter';
 import { titleToName } from '../conversion/utils/titleToName';
@@ -15,7 +15,7 @@ import { countParagraphs } from '../utils/expectation-counters/countParagraphs';
 import { countSentences, splitIntoSentences } from '../utils/expectation-counters/countSentences';
 import { countWords } from '../utils/expectation-counters/countWords';
 import { CountUtils } from '../utils/expectation-counters/index';
-import { extractParameters } from '../utils/extractParameters';
+import { extractParameterNames } from '../utils/extractParameterNames';
 import { DIACRITIC_VARIANTS_LETTERS } from '../utils/normalization/DIACRITIC_VARIANTS_LETTERS';
 import type { IKeywords, string_keyword } from '../utils/normalization/IKeywords';
 import { capitalize } from '../utils/normalization/capitalize';
@@ -55,7 +55,7 @@ import { isValidUrl } from '../utils/validators/url/isValidUrl';
 import { isValidUuid } from '../utils/validators/uuid/isValidUuid';
 import { PROMPTBOOK_VERSION } from '../version';
 export { forEachAsync, PROMPTBOOK_VERSION };
-export { extractParameters, extractVariables, replaceParameters, spaceTrim };
+export { extractParameterNames, extractVariables, replaceParameters, spaceTrim };
 export { $currentDate, $randomSeed, extractBlock, // <- [🌻] + maybe export through `@promptbook/markdown-utils`
 isHostnameOnPrivateNetwork, isUrlOnPrivateNetwork, isValidFilePath, isValidJavascriptName, isValidJsonString, isValidPipelineUrl, isValidPromptbookVersion, isValidSemanticVersion, isValidUrl, isValidUuid, parseNumber, // <- [🌻]
 removeEmojis, removeQuotes, trimCodeBlock, trimEndOfCodeBlock, unwrapResult, };
@@ -70,7 +70,7 @@ export declare const normalizeTo: {
 };
 export { capitalize, decapitalize, DIACRITIC_VARIANTS_LETTERS, IKeywords, isValidKeyword, nameToUriPart, nameToUriParts, normalizeTo_camelCase, normalizeTo_PascalCase, normalizeTo_SCREAMING_CASE, normalizeTo_snake_case, normalizeToKebabCase, normalizeWhitespaces, parseKeywords, parseKeywordsFromString, removeDiacritics, searchKeywords, string_keyword, titleToName, };
 export type { string_camelCase, string_kebab_case, string_PascalCase, string_SCREAMING_CASE, string_snake_case };
-export { extractParametersFromPromptTemplate, renameParameter, renderPromptbookMermaid };
+export { extractParameterNamesFromPromptTemplate, renameParameter, renderPromptbookMermaid };
 export { difference, intersection, union };
 /**
  * Note: [🕙] It does not make sence to have simple lower / UPPER case normalization

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

@@ -43,11 +43,15 @@ export declare const REPLACING_NONCE = "u$k42k%!V2zo34w7Fu#@QUHYPW";
 /**
  * The names of the parameters that are reserved for special purposes
  */
-export declare const RESERVED_PARAMETER_NAMES: readonly ["context", "knowledge", "samples", "modelName", "currentDate"];
+export declare const RESERVED_PARAMETER_NAMES: readonly ["content", "context", "knowledge", "samples", "modelName", "currentDate"];
 /**
  * @@@
  */
 export declare const RESERVED_PARAMETER_MISSING_VALUE: string;
+/**
+ * @@@
+ */
+export declare const RESERVED_PARAMETER_RESTRICTED: string;
 /**
  * @@@
  */

package/esm/typings/src/conversion/utils/{extractParametersFromPromptTemplate.d.ts → extractParameterNamesFromPromptTemplate.d.ts}

@@ -7,7 +7,7 @@ import type { string_parameter_name } from '../../types/typeAliases';
  * @returns the set of parameter names
  * @throws {ParsingError} if the script is invalid
  */
-export declare function extractParametersFromPromptTemplate(promptTemplate: Pick<PromptTemplateJson, 'title' | 'description' | 'blockType' | 'content' | 'jokerParameterNames'>): Set<string_parameter_name>;
+export declare function extractParameterNamesFromPromptTemplate(promptTemplate: Pick<PromptTemplateJson, 'title' | 'description' | 'blockType' | 'content' | 'preparedContent' | 'jokerParameterNames'>): Set<string_parameter_name>;
 /**
  * TODO: [🔣] If script require contentLanguage
  */

package/esm/typings/src/execution/createPipelineExecutor.d.ts

@@ -47,6 +47,8 @@ interface CreatePipelineExecutorOptions {
 export declare function createPipelineExecutor(options: CreatePipelineExecutorOptions): PipelineExecutor;
 export {};
 /**
+ * TODO: !!!! return `preparedPipeline` from execution
+ * TODO: !!!! `isNotPreparedWarningSupressed`
  * TODO: Use isVerbose here (not only pass to `preparePipeline`)
  * TODO: [🪂] Use maxParallelCount here (not only pass to `preparePipeline`)
  * TODO: [♈] Probbably move expectations from templates to parameters

package/esm/typings/src/knowledge/prepare-knowledge/markdown/prepareKnowledgeFromMarkdown.d.ts

@@ -4,7 +4,7 @@ import type { string_markdown } from '../../../types/typeAliases';
 /**
  * @@@
  */
-export declare function prepareKnowledgeFromMarkdown(content: string_markdown, options: PrepareOptions): Promise<Array<Omit<KnowledgePiecePreparedJson, 'sources' | 'preparationIds'>>>;
+export declare function prepareKnowledgeFromMarkdown(knowledgeContent: string_markdown, options: PrepareOptions): Promise<Array<Omit<KnowledgePiecePreparedJson, 'sources' | 'preparationIds'>>>;
 /**
  * TODO: [🐝][🔼] !!! Export via `@promptbook/markdown`
  * TODO: [🪂] Do it in parallel 11:11

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

@@ -81,7 +81,7 @@ export type PipelineJson = {
 /**
  * TODO: [🍙] Make some standart order of json properties
  * TODO: [🧠] Maybe wrap all {parameterNames} in brackets for example { "resultingParameterName": "{foo}" }
- * Note: There was a proposal for multiple types of promptbook objects 78816ff33e2705ee1a187aa2eb8affd976d4ea1a
+ * Note: [💼] There was a proposal for multiple types of promptbook objects 78816ff33e2705ee1a187aa2eb8affd976d4ea1a
  *       But then immediately reverted back to the single type
  *       With knowledge as part of the promptbook and collection just as a collection of promptbooks
  */

package/esm/typings/src/utils/{extractParameters.d.ts → extractParameterNames.d.ts}

@@ -6,4 +6,7 @@ import type { string_template } from '../types/typeAliases';
  * @param template the template with parameters in {curly} braces
  * @returns the list of parameter names
  */
-export declare function extractParameters(template: string_template): Set<string_parameter_name>;
+export declare function extractParameterNames(template: string_template): Set<string_parameter_name>;
+/**
+ * TODO: !!!!! Rename to extractParameterNames
+ */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/remote-client",
-    "version": "0.61.0-24",
+    "version": "0.61.0-26",
     "description": "Supercharge your use of large language models",
     "private": false,
     "sideEffects": false,
@@ -47,7 +47,7 @@
         }
     ],
     "peerDependencies": {
-        "@promptbook/core": "0.61.0-24"
+        "@promptbook/core": "0.61.0-26"
     },
     "main": "./umd/index.umd.js",
     "module": "./esm/index.es.js",

package/umd/index.umd.js

@@ -218,7 +218,7 @@
     /**
      * The version of the Promptbook library
      */
-    var PROMPTBOOK_VERSION = '0.61.0-23';
+    var PROMPTBOOK_VERSION = '0.61.0-25';
     // TODO: !!!! List here all the versions and annotate + put into script
 
     exports.PROMPTBOOK_VERSION = PROMPTBOOK_VERSION;

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

@@ -1,6 +1,6 @@
 import { spaceTrim } from 'spacetrim';
 import { renderPromptbookMermaid } from '../conversion/prettify/renderPipelineMermaidOptions';
-import { extractParametersFromPromptTemplate } from '../conversion/utils/extractParametersFromPromptTemplate';
+import { extractParameterNamesFromPromptTemplate } from '../conversion/utils/extractParameterNamesFromPromptTemplate';
 import { extractVariables } from '../conversion/utils/extractVariables';
 import { renameParameter } from '../conversion/utils/renameParameter';
 import { titleToName } from '../conversion/utils/titleToName';
@@ -15,7 +15,7 @@ import { countParagraphs } from '../utils/expectation-counters/countParagraphs';
 import { countSentences, splitIntoSentences } from '../utils/expectation-counters/countSentences';
 import { countWords } from '../utils/expectation-counters/countWords';
 import { CountUtils } from '../utils/expectation-counters/index';
-import { extractParameters } from '../utils/extractParameters';
+import { extractParameterNames } from '../utils/extractParameterNames';
 import { DIACRITIC_VARIANTS_LETTERS } from '../utils/normalization/DIACRITIC_VARIANTS_LETTERS';
 import type { IKeywords, string_keyword } from '../utils/normalization/IKeywords';
 import { capitalize } from '../utils/normalization/capitalize';
@@ -55,7 +55,7 @@ import { isValidUrl } from '../utils/validators/url/isValidUrl';
 import { isValidUuid } from '../utils/validators/uuid/isValidUuid';
 import { PROMPTBOOK_VERSION } from '../version';
 export { forEachAsync, PROMPTBOOK_VERSION };
-export { extractParameters, extractVariables, replaceParameters, spaceTrim };
+export { extractParameterNames, extractVariables, replaceParameters, spaceTrim };
 export { $currentDate, $randomSeed, extractBlock, // <- [🌻] + maybe export through `@promptbook/markdown-utils`
 isHostnameOnPrivateNetwork, isUrlOnPrivateNetwork, isValidFilePath, isValidJavascriptName, isValidJsonString, isValidPipelineUrl, isValidPromptbookVersion, isValidSemanticVersion, isValidUrl, isValidUuid, parseNumber, // <- [🌻]
 removeEmojis, removeQuotes, trimCodeBlock, trimEndOfCodeBlock, unwrapResult, };
@@ -70,7 +70,7 @@ export declare const normalizeTo: {
 };
 export { capitalize, decapitalize, DIACRITIC_VARIANTS_LETTERS, IKeywords, isValidKeyword, nameToUriPart, nameToUriParts, normalizeTo_camelCase, normalizeTo_PascalCase, normalizeTo_SCREAMING_CASE, normalizeTo_snake_case, normalizeToKebabCase, normalizeWhitespaces, parseKeywords, parseKeywordsFromString, removeDiacritics, searchKeywords, string_keyword, titleToName, };
 export type { string_camelCase, string_kebab_case, string_PascalCase, string_SCREAMING_CASE, string_snake_case };
-export { extractParametersFromPromptTemplate, renameParameter, renderPromptbookMermaid };
+export { extractParameterNamesFromPromptTemplate, renameParameter, renderPromptbookMermaid };
 export { difference, intersection, union };
 /**
  * Note: [🕙] It does not make sence to have simple lower / UPPER case normalization

package/umd/typings/src/config.d.ts

@@ -43,11 +43,15 @@ export declare const REPLACING_NONCE = "u$k42k%!V2zo34w7Fu#@QUHYPW";
 /**
  * The names of the parameters that are reserved for special purposes
  */
-export declare const RESERVED_PARAMETER_NAMES: readonly ["context", "knowledge", "samples", "modelName", "currentDate"];
+export declare const RESERVED_PARAMETER_NAMES: readonly ["content", "context", "knowledge", "samples", "modelName", "currentDate"];
 /**
  * @@@
  */
 export declare const RESERVED_PARAMETER_MISSING_VALUE: string;
+/**
+ * @@@
+ */
+export declare const RESERVED_PARAMETER_RESTRICTED: string;
 /**
  * @@@
  */

package/umd/typings/src/conversion/utils/{extractParametersFromPromptTemplate.d.ts → extractParameterNamesFromPromptTemplate.d.ts}

@@ -7,7 +7,7 @@ import type { string_parameter_name } from '../../types/typeAliases';
  * @returns the set of parameter names
  * @throws {ParsingError} if the script is invalid
  */
-export declare function extractParametersFromPromptTemplate(promptTemplate: Pick<PromptTemplateJson, 'title' | 'description' | 'blockType' | 'content' | 'jokerParameterNames'>): Set<string_parameter_name>;
+export declare function extractParameterNamesFromPromptTemplate(promptTemplate: Pick<PromptTemplateJson, 'title' | 'description' | 'blockType' | 'content' | 'preparedContent' | 'jokerParameterNames'>): Set<string_parameter_name>;
 /**
  * TODO: [🔣] If script require contentLanguage
  */

package/umd/typings/src/execution/createPipelineExecutor.d.ts

@@ -47,6 +47,8 @@ interface CreatePipelineExecutorOptions {
 export declare function createPipelineExecutor(options: CreatePipelineExecutorOptions): PipelineExecutor;
 export {};
 /**
+ * TODO: !!!! return `preparedPipeline` from execution
+ * TODO: !!!! `isNotPreparedWarningSupressed`
  * TODO: Use isVerbose here (not only pass to `preparePipeline`)
  * TODO: [🪂] Use maxParallelCount here (not only pass to `preparePipeline`)
  * TODO: [♈] Probbably move expectations from templates to parameters

package/umd/typings/src/knowledge/prepare-knowledge/markdown/prepareKnowledgeFromMarkdown.d.ts

@@ -4,7 +4,7 @@ import type { string_markdown } from '../../../types/typeAliases';
 /**
  * @@@
  */
-export declare function prepareKnowledgeFromMarkdown(content: string_markdown, options: PrepareOptions): Promise<Array<Omit<KnowledgePiecePreparedJson, 'sources' | 'preparationIds'>>>;
+export declare function prepareKnowledgeFromMarkdown(knowledgeContent: string_markdown, options: PrepareOptions): Promise<Array<Omit<KnowledgePiecePreparedJson, 'sources' | 'preparationIds'>>>;
 /**
  * TODO: [🐝][🔼] !!! Export via `@promptbook/markdown`
  * TODO: [🪂] Do it in parallel 11:11

package/umd/typings/src/types/PipelineJson/PipelineJson.d.ts

@@ -81,7 +81,7 @@ export type PipelineJson = {
 /**
  * TODO: [🍙] Make some standart order of json properties
  * TODO: [🧠] Maybe wrap all {parameterNames} in brackets for example { "resultingParameterName": "{foo}" }
- * Note: There was a proposal for multiple types of promptbook objects 78816ff33e2705ee1a187aa2eb8affd976d4ea1a
+ * Note: [💼] There was a proposal for multiple types of promptbook objects 78816ff33e2705ee1a187aa2eb8affd976d4ea1a
  *       But then immediately reverted back to the single type
  *       With knowledge as part of the promptbook and collection just as a collection of promptbooks
  */

package/umd/typings/src/utils/{extractParameters.d.ts → extractParameterNames.d.ts}

@@ -6,4 +6,7 @@ import type { string_template } from '../types/typeAliases';
  * @param template the template with parameters in {curly} braces
  * @returns the list of parameter names
  */
-export declare function extractParameters(template: string_template): Set<string_parameter_name>;
+export declare function extractParameterNames(template: string_template): Set<string_parameter_name>;
+/**
+ * TODO: !!!!! Rename to extractParameterNames
+ */