@promptbook/types 0.61.0-24 → 0.61.0-25

package/README.md

@@ -109,7 +109,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
@@ -268,7 +268,7 @@ File `write-website-content.ptbk.md`:
 > {contentBody}
 > ```
 >
-> `-> {content}`
+> `-> {websiteContent}`
 
 
 
@@ -308,7 +308,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

@@ -10,7 +10,7 @@ var EXPECTATION_UNITS = ['CHARACTERS', 'WORDS', 'SENTENCES', 'LINES', 'PARAGRAPH
 /**
  * The version of the Promptbook library
  */
-var PROMPTBOOK_VERSION = '0.61.0-23';
+var PROMPTBOOK_VERSION = '0.61.0-24';
 // TODO: !!!! List here all the versions and annotate + put into script
 
 export { EXPECTATION_UNITS, PROMPTBOOK_VERSION };

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

@@ -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 extractParametersFromPromptTemplate(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/utils/extractParameters.d.ts

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

package/package.json

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

package/umd/index.umd.js

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

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

@@ -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 extractParametersFromPromptTemplate(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/utils/extractParameters.d.ts

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