@promptbook/remote-server 0.80.0-1 → 0.81.0-5

package/README.md

@@ -251,6 +251,8 @@ Or you can install them separately:
 -   **[@promptbook/documents](https://www.npmjs.com/package/@promptbook/documents)** - Read knowledge from documents like `.docx`, `.odt`,…
 -   **[@promptbook/legacy-documents](https://www.npmjs.com/package/@promptbook/legacy-documents)** - Read knowledge from legacy documents like `.doc`, `.rtf`,…
 -   **[@promptbook/website-crawler](https://www.npmjs.com/package/@promptbook/website-crawler)** - Crawl knowledge from the web
+-   **[@promptbook/editable](https://www.npmjs.com/package/@promptbook/editable)** - Editable book as native javascript object with imperative object API
+-   **[@promptbook/templates](https://www.npmjs.com/package/@promptbook/templates)** - Usefull templates and examples of books which can be used as a starting point
 -   **[@promptbook/types](https://www.npmjs.com/package/@promptbook/types)** - Just typescript types used in the library
 -   **[@promptbook/cli](https://www.npmjs.com/package/@promptbook/cli)** - Command line interface utilities for promptbooks
 

package/esm/index.es.js

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

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

@@ -34,9 +34,6 @@ import { pipelineJsonToString } from '../conversion/pipelineJsonToString';
 import { precompilePipeline } from '../conversion/precompilePipeline';
 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';
 import type { CallbackInterfaceToolsOptions } from '../dialogs/callback/CallbackInterfaceToolsOptions';
@@ -155,9 +152,6 @@ export { pipelineJsonToString };
 export { precompilePipeline };
 export { prettifyPipelineString };
 export { extractParameterNamesFromTask };
-export { removePipelineCommand };
-export { renamePipelineParameter };
-export { stringifyPipelineJson };
 export { validatePipeline };
 export { CallbackInterfaceTools };
 export type { CallbackInterfaceToolsOptions };

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

@@ -0,0 +1,10 @@
+import { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION } from '../version';
+import type { PipelineEditableSerialized } from '../utils/editable/types/PipelineEditableSerialized';
+import { removePipelineCommand } from '../utils/editable/utils/removePipelineCommand';
+import { renamePipelineParameter } from '../utils/editable/utils/renamePipelineParameter';
+import { stringifyPipelineJson } from '../utils/editable/utils/stringifyPipelineJson';
+export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };
+export type { PipelineEditableSerialized };
+export { removePipelineCommand };
+export { renamePipelineParameter };
+export { stringifyPipelineJson };

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

@@ -0,0 +1,4 @@
+import { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION } from '../version';
+import { getBookTemplate } from '../utils/getBookTemplate';
+export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };
+export { getBookTemplate };

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

@@ -30,6 +30,7 @@ import type { LlmExecutionTools } from '../execution/LlmExecutionTools';
 import type { LlmExecutionToolsConstructor } from '../execution/LlmExecutionToolsConstructor';
 import type { PipelineExecutor } from '../execution/PipelineExecutor';
 import type { PipelineExecutorResult } from '../execution/PipelineExecutorResult';
+import type { PromptbookFetch } from '../execution/PromptbookFetch';
 import type { PromptResult } from '../execution/PromptResult';
 import type { CompletionPromptResult } from '../execution/PromptResult';
 import type { ChatPromptResult } from '../execution/PromptResult';
@@ -241,6 +242,7 @@ import type { number_gigabytes } from '../types/typeAliases';
 import type { number_terabytes } from '../types/typeAliases';
 import type { Registered } from '../utils/$Register';
 import type { Registration } from '../utils/$Register';
+import type { PipelineEditableSerialized } from '../utils/editable/types/PipelineEditableSerialized';
 import type { ExecCommandOptions } from '../utils/execCommand/ExecCommandOptions';
 import type { ExecCommandOptionsAdvanced } from '../utils/execCommand/ExecCommandOptions';
 import type { FromtoItems } from '../utils/FromtoItems';
@@ -292,6 +294,7 @@ export type { LlmExecutionTools };
 export type { LlmExecutionToolsConstructor };
 export type { PipelineExecutor };
 export type { PipelineExecutorResult };
+export type { PromptbookFetch };
 export type { PromptResult };
 export type { CompletionPromptResult };
 export type { ChatPromptResult };
@@ -503,6 +506,7 @@ export type { number_gigabytes };
 export type { number_terabytes };
 export type { Registered };
 export type { Registration };
+export type { PipelineEditableSerialized };
 export type { ExecCommandOptions };
 export type { ExecCommandOptionsAdvanced };
 export type { FromtoItems };

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

@@ -46,7 +46,7 @@ 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';
+import { templateParameters } from '../utils/parameters/templateParameters';
 import { parseNumber } from '../utils/parseNumber';
 import { $randomSeed } from '../utils/random/$randomSeed';
 import { removeEmojis } from '../utils/removeEmojis';
@@ -121,7 +121,7 @@ export { searchKeywords };
 export { titleToName };
 export { spaceTrim };
 export { extractParameterNames };
-export { replaceParameters };
+export { templateParameters };
 export { parseNumber };
 export { $randomSeed };
 export { removeEmojis };

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

@@ -3,6 +3,7 @@ import type { Arrayable } from '../types/Arrayable';
 import type { Executables } from './Executables';
 import type { FilesystemTools } from './FilesystemTools';
 import type { LlmExecutionTools } from './LlmExecutionTools';
+import type { PromptbookFetch } from './PromptbookFetch';
 import type { ScriptExecutionTools } from './ScriptExecutionTools';
 import type { UserInterfaceTools } from './UserInterfaceTools';
 /**
@@ -27,6 +28,12 @@ export type ExecutionTools = {
      * @default undefined - If not provided, no filesystem operations will be possible
      */
     readonly fs?: FilesystemTools;
+    /**
+     * Fetch function for fetching resources
+     *
+     * @default `fetch` - If not provided, the built-in `fetch' function is used with a lightweight error handling wrapper.
+     */
+    readonly fetch?: PromptbookFetch;
     /**
      * Scrapers for extracting knowledge from external sources
      *

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

@@ -0,0 +1,5 @@
+import type { string_url } from '../types/typeAliases';
+/**
+ * Fetch function for fetching data from the internet used in scraping
+ */
+export type PromptbookFetch = (url: string_url, init?: RequestInit) => Promise<Response>;

package/esm/typings/src/execution/PromptbookFetch.test-type.d.ts

@@ -0,0 +1,5 @@
+export {};
+/**
+ * Note: [⚪] This should never be in any released package
+ * TODO: Is this a good pattern to do type testing?
+ */

package/esm/typings/src/expectations/drafts/isDomainNameFree.d.ts

@@ -1,8 +1,9 @@
+import type { PromptbookFetch } from '../../execution/PromptbookFetch';
 import type { string_name } from '../../types/typeAliases';
 /**
  * @private still in development
  */
-export declare function isDomainNameFree(name: string_name): Promise<boolean>;
+export declare function isDomainNameFree(name: string_name, fetch: PromptbookFetch): Promise<boolean>;
 /**
  * TODO: [🍓][🧠] Test and implement `isDomainNameFree`
  * TODO: Export via some (and probably new) NPM package

package/esm/typings/src/expectations/drafts/isGithubNameFree.d.ts

@@ -1,8 +1,9 @@
+import type { PromptbookFetch } from '../../execution/PromptbookFetch';
 import type { string_name } from '../../types/typeAliases';
 /**
  * @private still in development
  */
-export declare function isGithubNameFree(name: string_name): Promise<boolean>;
+export declare function isGithubNameFree(name: string_name, fetch: PromptbookFetch): Promise<boolean>;
 /**
  * TODO: [🍓][🧠] Test and implement `isGithubNameFree`
  * TODO: Export via some (and probably new) NPM package

package/esm/typings/src/scrapers/_common/utils/makeKnowledgeSourceHandler.d.ts

@@ -8,4 +8,4 @@ import type { ScraperSourceHandler } from '../Scraper';
  *
  * @public exported from `@promptbook/core`
  */
-export declare function makeKnowledgeSourceHandler(knowledgeSource: SetOptional<KnowledgeSourceJson, 'name'>, tools: Pick<ExecutionTools, 'fs'>, options?: Pick<PrepareAndScrapeOptions, 'rootDirname' | 'isVerbose'>): Promise<ScraperSourceHandler>;
+export declare function makeKnowledgeSourceHandler(knowledgeSource: SetOptional<KnowledgeSourceJson, 'name'>, tools: Pick<ExecutionTools, 'fs' | 'fetch'>, options?: Pick<PrepareAndScrapeOptions, 'rootDirname' | 'isVerbose'>): Promise<ScraperSourceHandler>;

package/esm/typings/src/scrapers/_common/utils/scraperFetch.d.ts

@@ -0,0 +1,7 @@
+import type { PromptbookFetch } from '../../../execution/PromptbookFetch';
+/**
+ * The built-in `fetch' function with a lightweight error handling wrapper as default fetch function used in Promptbook scrapers
+ *
+ * @private as default `fetch` function used in Promptbook scrapers
+ */
+export declare const scraperFetch: PromptbookFetch;

package/esm/typings/src/utils/editable/types/PipelineEditableSerialized.d.ts

@@ -0,0 +1,42 @@
+import type { ErrorJson } from '../../../errors/utils/ErrorJson';
+import type { PipelineJson } from '../../../pipeline/PipelineJson/PipelineJson';
+import type { string_date_iso8601 } from '../../../types/typeAliases';
+import type { string_pipeline_url } from '../../../types/typeAliases';
+import type { PipelineString } from '../../../pipeline/PipelineString';
+/**
+ * Represents a single pipeline in PromptbookStudio
+ *
+ * This is simple extension of PipelineJson with additional metadata
+ * Note: There are two similar entities:
+ *       1) Type (interface) `PipelineEditableSerialized` which represents just data in database
+ *       2) Class `PipelineEditable` which implements `PipelineEditableSerialized` and adds error handling and editing capabilities
+ *
+ * @public exported from `@promptbook/editable`
+ */
+export type PipelineEditableSerialized = PipelineJson & {
+    /**
+     * When was the pipeline created
+     */
+    readonly createdAt: string_date_iso8601;
+    /**
+     * When was the pipeline last modified
+     */
+    readonly updatedAt: string_date_iso8601 | null;
+    /**
+     * Unique identifier of the pipeline
+     *
+     * Note: In PromptbookStudio it is required
+     */
+    readonly pipelineUrl: string_pipeline_url;
+    /**
+     * Backup of the pipeline string
+     *
+     * Note: This is present ONLY if pipelineString can not be automatically converted into json (i.e. compilePipeline throws an error)
+     *       In other words, this is just a BACKUP of pipeline which will be deleted whener pipeline is valid again
+     */
+    readonly pipelineString: PipelineString | string | null;
+    /**
+     * Known errors to transfer to new PipelineEditable
+     */
+    readonly knownErrors: Array<ErrorJson>;
+};

package/esm/typings/src/{conversion → utils/editable}/utils/removePipelineCommand.d.ts

@@ -1,5 +1,5 @@
-import type { CommandType } from '../../commands/_common/types/CommandType';
-import type { PipelineString } from '../../pipeline/PipelineString';
+import type { CommandType } from '../../../commands/_common/types/CommandType';
+import type { PipelineString } from '../../../pipeline/PipelineString';
 /**
  * Options for `removePipelineCommand`
  */
@@ -16,7 +16,7 @@ type RemovePipelineCommandOptions = {
 /**
  * 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
+ * @public exported from `@promptbook/editable`
  */
 export declare function removePipelineCommand(options: RemovePipelineCommandOptions): PipelineString;
 export {};

package/esm/typings/src/{conversion → utils/editable}/utils/renamePipelineParameter.d.ts

@@ -1,5 +1,5 @@
-import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
-import type { string_name } from '../../types/typeAliases';
+import type { PipelineJson } from '../../../pipeline/PipelineJson/PipelineJson';
+import type { string_name } from '../../../types/typeAliases';
 type RenameParameterOptions = {
     /**
      * Pipeline to search and replace for parameters
@@ -20,7 +20,7 @@ type RenameParameterOptions = {
  * 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/core` <- Note: [👖] This utility is so tightly interconnected with the Promptbook that it is not exported as util but in core
+ * @public exported from `@promptbook/editable`
  */
 export declare function renamePipelineParameter(options: RenameParameterOptions): PipelineJson;
 export {};

package/esm/typings/src/{conversion → utils/editable}/utils/stringifyPipelineJson.d.ts

@@ -1,11 +1,11 @@
-import type { string_json } from '../../types/typeAliases';
+import type { string_json } from '../../../types/typeAliases';
 /**
  * Stringify the PipelineJson with proper formatting
  *
  * Note: [0] It can be used for more JSON types like whole collection of pipelines, single knowledge piece, etc.
  * Note: In contrast to JSON.stringify, this function ensures that **embedding index** is on single line
  *
- * @public exported from `@promptbook/core`
+ * @public exported from `@promptbook/editable`
  */
 export declare function stringifyPipelineJson<TType>(pipeline: TType): string_json<TType>;
 /**

package/esm/typings/src/utils/getBookTemplate.d.ts

@@ -0,0 +1,12 @@
+import type { PipelineJson } from '../pipeline/PipelineJson/PipelineJson';
+import type { string_formfactor_name } from '../formfactors/_common/string_formfactor_name';
+/**
+ * Get template for new book
+ *
+ * @public exported from `@promptbook/templates`
+ */
+export declare function getBookTemplate(formfactorName: string_formfactor_name): PipelineJson | null;
+/**
+ * TODO: [🧠] Which is the best place for this function
+ * TODO: `book string template notation
+ */

package/esm/typings/src/utils/parameters/{replaceParameters.d.ts → templateParameters.d.ts}

@@ -9,4 +9,4 @@ import type { string_template } from '../../types/typeAliases';
  * @throws {PipelineExecutionError} if parameter is not defined, not closed, or not opened
  * @public exported from `@promptbook/utils`
  */
-export declare function replaceParameters(template: string_template, parameters: Parameters): string;
+export declare function templateParameters(template: string_template, parameters: Parameters): string;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/remote-server",
-    "version": "0.80.0-1",
+    "version": "0.81.0-5",
     "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/remote-server.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.80.0-1"
+        "@promptbook/core": "0.81.0-5"
     },
     "dependencies": {
         "colors": "1.4.0",

package/umd/index.umd.js

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