@promptbook/openai 0.82.0 → 0.83.0

package/esm/typings/src/commands/KNOWLEDGE/knowledgeCommandParser.d.ts

@@ -4,7 +4,7 @@ import type { KnowledgeCommand } from './KnowledgeCommand';
  * Parses the knowledge command
  *
  * @see `documentationUrl` for more details
- * @private within the commands folder
+ * @public exported from `@promptbook/editable`
  */
 export declare const knowledgeCommandParser: PipelineHeadCommandParser<KnowledgeCommand>;
 /**

package/esm/typings/src/commands/KNOWLEDGE/utils/{sourceContentToName.d.ts → knowledgeSourceContentToName.d.ts}

@@ -3,9 +3,9 @@ import type { string_name } from '../../../types/typeAliases';
 /**
  * Creates unique name for the source
  *
- * @private within the repository
+ * @public exported from `@promptbook/editable`
  */
-export declare function sourceContentToName(sourceContent: string_knowledge_source_content): string_name;
+export declare function knowledgeSourceContentToName(knowledgeSourceContent: string_knowledge_source_content): string_name;
 /**
  * TODO: [🐱‍🐉][🧠] Make some smart crop NOT source-i-m-pavol-a-develop-... BUT source-i-m-pavol-a-developer-...
  */

package/esm/typings/src/commands/MODEL/ModelCommand.d.ts

@@ -4,7 +4,8 @@ import type { TODO_any } from '../../utils/organization/TODO_any';
  * Parsed MODEL command
  *
  * @see ./modelCommandParser.ts for more details
- * @private within the commands folder
+ * @deprecated Option to manually set the model requirements is not recommended to use, use `PERSONA` instead
+ * @public exported from `@promptbook/editable`
  */
 export type ModelCommand = {
     readonly type: 'MODEL';

package/esm/typings/src/commands/MODEL/modelCommandParser.d.ts

@@ -4,6 +4,7 @@ import type { ModelCommand } from './ModelCommand';
  * Parses the model command
  *
  * @see `documentationUrl` for more details
- * @private within the commands folder
+ * @deprecated Option to manually set the model requirements is not recommended to use, use `PERSONA` instead
+ * @public exported from `@promptbook/editable`
  */
 export declare const modelCommandParser: PipelineBothCommandParser<ModelCommand>;

package/esm/typings/src/commands/PARAMETER/ParameterCommand.d.ts

@@ -4,7 +4,7 @@ import type { string_name } from '../../types/typeAliases';
  * Parsed PARAMETER command
  *
  * @see ./parameterCommandParser.ts for more details
- * @private within the commands folder
+ * @public exported from `@promptbook/editable`
  */
 export type ParameterCommand = {
     readonly type: 'PARAMETER';

package/esm/typings/src/commands/PARAMETER/parameterCommandParser.d.ts

@@ -4,6 +4,6 @@ import type { ParameterCommand } from './ParameterCommand';
  * Parses the parameter command
  *
  * @see `documentationUrl` for more details
- * @private within the commands folder
+ * @public exported from `@promptbook/editable`
  */
 export declare const parameterCommandParser: PipelineBothCommandParser<ParameterCommand>;

package/esm/typings/src/commands/PERSONA/PersonaCommand.d.ts

@@ -4,7 +4,7 @@ import type { string_persona_description } from '../../types/typeAliases';
  * Parsed PERSONA command
  *
  * @see ./personaCommandParser.ts for more details
- * @private within the commands folder
+ * @public exported from `@promptbook/editable`
  */
 export type PersonaCommand = {
     readonly type: 'PERSONA';

package/esm/typings/src/commands/PERSONA/personaCommandParser.d.ts

@@ -4,6 +4,6 @@ import type { PersonaCommand } from './PersonaCommand';
  * Parses the persona command
  *
  * @see `documentationUrl` for more details
- * @private within the commands folder
+ * @public exported from `@promptbook/editable`
  */
 export declare const personaCommandParser: PipelineBothCommandParser<PersonaCommand>;

package/esm/typings/src/commands/POSTPROCESS/PostprocessCommand.d.ts

@@ -3,7 +3,7 @@ import type { string_name } from '../../types/typeAliases';
  * Parsed POSTPROCESS command
  *
  * @see ./postprocessCommandParser.ts for more details
- * @private within the commands folder
+ * @public exported from `@promptbook/editable`
  */
 export type PostprocessCommand = {
     readonly type: 'POSTPROCESS';

package/esm/typings/src/commands/POSTPROCESS/postprocessCommandParser.d.ts

@@ -4,6 +4,6 @@ import type { PostprocessCommand } from './PostprocessCommand';
  * Parses the postprocess command
  *
  * @see `documentationUrl` for more details
- * @private within the commands folder
+ * @public exported from `@promptbook/editable`
  */
 export declare const postprocessCommandParser: PipelineTaskCommandParser<PostprocessCommand>;

package/esm/typings/src/commands/SECTION/SectionCommand.d.ts

@@ -3,7 +3,7 @@ import type { SectionType } from '../../types/SectionType';
  * Parsed SECTION command
  *
  * @see ./sectionCommandParser.ts for more details
- * @private within the commands folder
+ * @public exported from `@promptbook/editable`
  */
 export type SectionCommand = {
     readonly type: 'SECTION';

package/esm/typings/src/commands/SECTION/sectionCommandParser.d.ts

@@ -4,7 +4,7 @@ import type { SectionCommand } from './SectionCommand';
  * Parses the section command
  *
  * @see `documentationUrl` for more details
- * @private within the commands folder
+ * @public exported from `@promptbook/editable`
  */
 export declare const sectionCommandParser: PipelineTaskCommandParser<SectionCommand>;
 /**

package/esm/typings/src/commands/URL/UrlCommand.d.ts

@@ -2,7 +2,7 @@
  * Parsed URL command
  *
  * @see ./urlCommandParser.ts for more details
- * @private within the commands folder
+ * @public exported from `@promptbook/editable`
  */
 export type UrlCommand = {
     readonly type: 'URL';

package/esm/typings/src/commands/URL/urlCommandParser.d.ts

@@ -4,6 +4,6 @@ import type { UrlCommand } from './UrlCommand';
  * Parses the url command
  *
  * @see `documentationUrl` for more details
- * @private within the commands folder
+ * @public exported from `@promptbook/editable`
  */
 export declare const urlCommandParser: PipelineHeadCommandParser<UrlCommand>;

package/esm/typings/src/commands/X_ACTION/ActionCommand.d.ts

@@ -2,7 +2,7 @@
  * Parsed ACTION command
  *
  * @see ./actionCommandParser.ts for more details
- * @private within the commands folder
+ * @public exported from `@promptbook/editable`
  */
 export type ActionCommand = {
     readonly type: 'ACTION';

package/esm/typings/src/commands/X_ACTION/actionCommandParser.d.ts

@@ -4,7 +4,7 @@ import type { ActionCommand } from './ActionCommand';
  * Parses the action command
  *
  * @see `documentationUrl` for more details
- * @private within the commands folder
+ * @public exported from `@promptbook/editable`
  */
 export declare const actionCommandParser: PipelineHeadCommandParser<ActionCommand>;
 /**

package/esm/typings/src/commands/X_INSTRUMENT/InstrumentCommand.d.ts

@@ -2,7 +2,7 @@
  * Parsed INSTRUMENT command
  *
  * @see ./instrumentCommandParser.ts for more details
- * @private within the commands folder
+ * @public exported from `@promptbook/editable`
  */
 export type InstrumentCommand = {
     readonly type: 'INSTRUMENT';

package/esm/typings/src/commands/X_INSTRUMENT/instrumentCommandParser.d.ts

@@ -4,7 +4,7 @@ import type { InstrumentCommand } from './InstrumentCommand';
  * Parses the instrument command
  *
  * @see `documentationUrl` for more details
- * @private within the commands folder
+ * @public exported from `@promptbook/editable`
  */
 export declare const instrumentCommandParser: PipelineHeadCommandParser<InstrumentCommand>;
 /**

package/esm/typings/src/commands/_common/getParserForCommand.d.ts

@@ -6,6 +6,6 @@ import type { CommandParser } from './types/CommandParser';
  * @returns the parser for the command
  * @throws {UnexpectedError} if the parser is not found
  *
- * @private within the compilePipeline
+ * @public exported from `@promptbook/editable`
  */
 export declare function getParserForCommand<TCommand extends Command>(command: TCommand): CommandParser<TCommand>;

package/esm/typings/src/commands/_common/parseCommand.d.ts

@@ -7,6 +7,6 @@ import type { CommandUsagePlace } from './types/CommandUsagePlaces';
  * @returns parsed command object
  * @throws {ParseError} if the command is invalid
  *
- * @private within the compilePipeline
+ * @public exported from `@promptbook/editable`
  */
 export declare function parseCommand(raw: string_markdown_text, usagePlace: CommandUsagePlace): Command;

package/esm/typings/src/commands/_common/stringifyCommand.d.ts

@@ -6,6 +6,7 @@ import type { Command } from './types/Command';
  * @returns stringified command
  * @throws {UnexpectedError} if the command is invalid
  *
+ * @deprecated Option to convert JSON back to string is outdated and will be removed
  * @private within the compilePipeline
  */
 export declare function stringifyCommand(command: Command): string_markdown_text;

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

@@ -17,6 +17,8 @@ export type CommandBase = {
 };
 /**
  * @@@
+ *
+ * @public exported from `@promptbook/editable`
  */
 export type CommandParser<TCommand extends CommandBase> = PipelineHeadCommandParser<TCommand> | PipelineTaskCommandParser<TCommand> | PipelineBothCommandParser<TCommand>;
 /**
@@ -71,10 +73,14 @@ export type CommonCommandParser<TCommand extends CommandBase> = {
 };
 /**
  * @@@
+ *
+ * @public exported from `@promptbook/editable`
  */
 export type PipelineBothCommandParser<TCommand extends CommandBase> = ___and___ & Omit<PipelineHeadCommandParser<TCommand>, 'isUsedInPipelineTask'> & Omit<PipelineTaskCommandParser<TCommand>, 'isUsedInPipelineHead'>;
 /**
  * @@@
+ *
+ * @public exported from `@promptbook/editable`
  */
 export type PipelineHeadCommandParser<TCommand extends CommandBase> = CommonCommandParser<TCommand> & {
     /**
@@ -101,6 +107,8 @@ export type PipelineHeadCommandParser<TCommand extends CommandBase> = CommonComm
 };
 /**
  * @@@
+ *
+ * @public exported from `@promptbook/editable`
  */
 export type PipelineTaskCommandParser<TCommand extends CommandBase> = CommonCommandParser<TCommand> & {
     /**

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

@@ -1,6 +1,8 @@
 import type { TupleToUnion } from 'type-fest';
 /**
  * Where the command can be used
+ *
+ * @public exported from `@promptbook/editable`
  */
 export type CommandUsagePlace = TupleToUnion<typeof CommandUsagePlaces>;
 /**

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

@@ -1,7 +1,7 @@
 /**
  * All available command parsers
  *
- * @private internal index of `parseCommand`
+ * @public exported from `@promptbook/editable`
  */
 export declare const COMMANDS: readonly [import("./_common/types/CommandParser").PipelineTaskCommandParser<import("./SECTION/SectionCommand").SectionCommand>, import("./_common/types/CommandParser").PipelineTaskCommandParser<import("./EXPECT/ExpectCommand").ExpectCommand>, import("./_common/types/CommandParser").PipelineTaskCommandParser<import("./FORMAT/FormatCommand").FormatCommand>, import("./_common/types/CommandParser").PipelineTaskCommandParser<import("./JOKER/JokerCommand").JokerCommand>, import("./_common/types/CommandParser").PipelineBothCommandParser<import("./MODEL/ModelCommand").ModelCommand>, import("./_common/types/CommandParser").PipelineBothCommandParser<import("./PARAMETER/ParameterCommand").ParameterCommand>, import("./_common/types/CommandParser").PipelineTaskCommandParser<import("./POSTPROCESS/PostprocessCommand").PostprocessCommand>, import("./_common/types/CommandParser").PipelineHeadCommandParser<import("./BOOK_VERSION/BookVersionCommand").BookVersionCommand>, import("./_common/types/CommandParser").PipelineHeadCommandParser<import("./FORMFACTOR/FormfactorCommand").FormfactorCommand>, import("./_common/types/CommandParser").PipelineHeadCommandParser<import("./URL/UrlCommand").UrlCommand>, import("./_common/types/CommandParser").PipelineHeadCommandParser<import("./KNOWLEDGE/KnowledgeCommand").KnowledgeCommand>, import("./_common/types/CommandParser").PipelineHeadCommandParser<import("./X_ACTION/ActionCommand").ActionCommand>, import("./_common/types/CommandParser").PipelineHeadCommandParser<import("./X_INSTRUMENT/InstrumentCommand").InstrumentCommand>, import("./_common/types/CommandParser").PipelineBothCommandParser<import("./PERSONA/PersonaCommand").PersonaCommand>, import("./_common/types/CommandParser").PipelineTaskCommandParser<import("./FOREACH/ForeachCommand").ForeachCommand>, import("./_common/types/CommandParser").PipelineBothCommandParser<import("./_BOILERPLATE/BoilerplateCommand").BoilerplateCommand>];
 /**

package/esm/typings/src/pipeline/PipelineJson/KnowledgeSourceJson.d.ts

@@ -24,7 +24,7 @@ export type KnowledgeSourceJson = {
      * For example `"Pavol Hejný has web https://pavolhejny.com/"`
      * For example `"Pavol Hejný is web developer and creator of Promptbook and Collboard"`
      */
-    readonly sourceContent: string_knowledge_source_content;
+    readonly knowledgeSourceContent: string_knowledge_source_content;
 };
 /**
  * Defines one source of knowledge in the pipeline after it has been prepared

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/openai",
-    "version": "0.82.0",
+    "version": "0.83.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/openai.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.82.0"
+        "@promptbook/core": "0.83.0"
     },
     "dependencies": {
         "colors": "1.4.0",

package/umd/index.umd.js

@@ -24,7 +24,7 @@
      * @generated
      * @see https://github.com/webgptorg/promptbook
      */
-    var PROMPTBOOK_ENGINE_VERSION = '0.82.0-3';
+    var PROMPTBOOK_ENGINE_VERSION = '0.82.0';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name