@promptbook/types 0.83.0 → 0.84.0-0

package/README.md

@@ -23,6 +23,10 @@
 
 
 
+<blockquote style="color: #ff8811">
+    <b>⚠ Warning:</b> This is a pre-release version of the library. It is not yet ready for production use. Please look at <a href="https://www.npmjs.com/package/@promptbook/core?activeTab=versions">latest stable release</a>.
+</blockquote>
+
 ## 📦 Package `@promptbook/types`
 
 - Promptbooks are [divided into several](#-packages) packages, all are published from [single monorepo](https://github.com/webgptorg/promptbook).

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

@@ -36,8 +36,11 @@ import type { ActionCommand } from '../commands/X_ACTION/ActionCommand';
 import { actionCommandParser } from '../commands/X_ACTION/actionCommandParser';
 import type { InstrumentCommand } from '../commands/X_INSTRUMENT/InstrumentCommand';
 import { instrumentCommandParser } from '../commands/X_INSTRUMENT/instrumentCommandParser';
+import { addPipelineCommand } from '../utils/editable/edit-pipeline-string/addPipelineCommand';
+import { deflatePipeline } from '../utils/editable/edit-pipeline-string/deflatePipeline';
+import { removePipelineCommand } from '../utils/editable/edit-pipeline-string/removePipelineCommand';
 import type { PipelineEditableSerialized } from '../utils/editable/types/PipelineEditableSerialized';
-import { removePipelineCommand } from '../utils/editable/utils/removePipelineCommand';
+import { isFlatPipeline } from '../utils/editable/utils/isFlatPipeline';
 import { renamePipelineParameter } from '../utils/editable/utils/renamePipelineParameter';
 import { stringifyPipelineJson } from '../utils/editable/utils/stringifyPipelineJson';
 export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };
@@ -78,7 +81,10 @@ export type { ActionCommand };
 export { actionCommandParser };
 export type { InstrumentCommand };
 export { instrumentCommandParser };
-export type { PipelineEditableSerialized };
+export { addPipelineCommand };
+export { deflatePipeline };
 export { removePipelineCommand };
+export type { PipelineEditableSerialized };
+export { isFlatPipeline };
 export { renamePipelineParameter };
 export { stringifyPipelineJson };

package/esm/typings/src/utils/editable/edit-pipeline-string/addPipelineCommand.d.ts

@@ -0,0 +1,17 @@
+import type { PipelineString } from '../../../pipeline/PipelineString';
+import type { string_markdown_text } from '../../../types/typeAliases';
+type AddPipelineCommandOptions = {
+    commandString: string_markdown_text;
+    pipelineString: PipelineString;
+};
+/**
+ * @@@
+ *
+ * @public exported from `@promptbook/editable`
+ */
+export declare function addPipelineCommand(options: AddPipelineCommandOptions): PipelineString;
+export {};
+/**
+ * TODO: [🧠] What is the better solution - `- xxx`, - `-   xxx` or preserve (see also next TODO)
+ * TODO: When existing commands 1) as 2) number 3) list, add 4) new command as next number
+ */

package/esm/typings/src/utils/editable/edit-pipeline-string/deflatePipeline.d.ts

@@ -0,0 +1,10 @@
+import type { PipelineString } from '../../../pipeline/PipelineString';
+/**
+ * @@@
+ *
+ * @public exported from `@promptbook/editable`
+ */
+export declare function deflatePipeline(pipelineString: PipelineString): PipelineString;
+/**
+ * TODO: Unit test
+ */

package/esm/typings/src/utils/editable/{utils → edit-pipeline-string}/removePipelineCommand.d.ts

@@ -11,7 +11,7 @@ type RemovePipelineCommandOptions = {
     /**
      * Pipeline you want to remove command from
      */
-    pipeline: PipelineString;
+    pipelineString: PipelineString;
 };
 /**
  * Function `removePipelineCommand` will remove one command from pipeline string

package/esm/typings/src/utils/editable/edit-pipeline-string/removePipelineCommand.test.d.ts

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

package/esm/typings/src/utils/editable/utils/isFlatPipeline.d.ts

@@ -0,0 +1,7 @@
+import type { PipelineString } from '../../../pipeline/PipelineString';
+/**
+ * @@@
+ *
+ * @public exported from `@promptbook/editable`
+ */
+export declare function isFlatPipeline(pipelineString: PipelineString): boolean;

package/esm/typings/src/utils/editable/utils/renamePipelineParameter.d.ts

@@ -24,3 +24,6 @@ type RenameParameterOptions = {
  */
 export declare function renamePipelineParameter(options: RenameParameterOptions): PipelineJson;
 export {};
+/**
+ * TODO: Also variant for `edit-pipeline-string`
+ */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/types",
-    "version": "0.83.0",
+    "version": "0.84.0-0",
     "description": "It's time for a paradigm shift. The future of software in plain English, French or Latin",
     "--note-0": "    <- [🐊]",
     "private": false,
@@ -52,6 +52,6 @@
     ],
     "typings": "./esm/typings/src/_packages/types.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.83.0"
+        "@promptbook/core": "0.84.0-0"
     }
 }