@promptbook/remote-server 0.72.0-2 → 0.72.0-23

package/esm/typings/src/scrapers/document-legacy/LegacyDocumentScraper.d.ts

@@ -0,0 +1,43 @@
+import type { KnowledgePiecePreparedJson } from '../../types/PipelineJson/KnowledgePieceJson';
+import type { ExecutionTools } from '../../execution/ExecutionTools';
+import type { PrepareAndScrapeOptions } from '../../prepare/PrepareAndScrapeOptions';
+import type { Converter } from '../_common/Converter';
+import type { ScraperAndConverterMetadata } from '../_common/register/ScraperAndConverterMetadata';
+import type { Scraper } from '../_common/Scraper';
+import type { ScraperSourceHandler } from '../_common/Scraper';
+import type { ScraperIntermediateSource } from '../_common/ScraperIntermediateSource';
+/**
+ * Scraper for old document files (like .doc and .rtf)
+ *
+ * @see `documentationUrl` for more details
+ * @public exported from `@promptbook/legacy-documents`
+ */
+export declare class LegacyDocumentScraper implements Converter, Scraper {
+    private readonly tools;
+    private readonly options;
+    /**
+     * Metadata of the scraper which includes title, mime types, etc.
+     */
+    get metadata(): ScraperAndConverterMetadata;
+    /**
+     * Document scraper is used internally
+     */
+    private readonly documentScraper;
+    constructor(tools: Pick<ExecutionTools, 'fs' | 'llm' | 'executables'>, options: PrepareAndScrapeOptions);
+    /**
+     * Convert the `.doc` or `.rtf`  to `.doc` file and returns intermediate source
+     *
+     * Note: `$` is used to indicate that this function is not a pure function - it leaves files on the disk and you are responsible for cleaning them by calling `destroy` method of returned object
+     */
+    $convert(source: ScraperSourceHandler): Promise<ScraperIntermediateSource>;
+    /**
+     * Scrapes the `.doc` or `.rtf` file and returns the knowledge pieces or `null` if it can't scrape it
+     */
+    scrape(source: ScraperSourceHandler): Promise<ReadonlyArray<Omit<KnowledgePiecePreparedJson, 'sources' | 'preparationIds'>> | null>;
+}
+/**
+ * TODO: [👣] Converted documents can act as cached items - there is no need to run conversion each time
+ * TODO: [🪂] Do it in parallel 11:11
+ * Note: No need to aggregate usage here, it is done by intercepting the llmTools
+ * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
+ */

package/esm/typings/src/scrapers/document-legacy/LegacyDocumentScraper.test.d.ts

@@ -0,0 +1,4 @@
+export {};
+/**
+ * TODO: [📓] Maybe test all file in samples (not just 10-simple.doc)
+ */

package/esm/typings/src/scrapers/document-legacy/createLegacyDocumentScraper.d.ts

@@ -0,0 +1,20 @@
+import type { ExecutionTools } from '../../execution/ExecutionTools';
+import type { PrepareAndScrapeOptions } from '../../prepare/PrepareAndScrapeOptions';
+import { LegacyDocumentScraper } from './LegacyDocumentScraper';
+/**
+ * @@@
+ *
+ * @public exported from `@promptbook/legacy-documents`
+ */
+export declare const createLegacyDocumentScraper: ((tools: Pick<ExecutionTools, 'llm'>, options: PrepareAndScrapeOptions) => LegacyDocumentScraper) & import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
+    title: string;
+    packageName: string;
+    className: string;
+    mimeTypes: string[];
+    documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
+    isAvilableInBrowser: false;
+    requiredExecutables: ("Pandoc" | "LibreOffice")[];
+}>;
+/**
+ * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
+ */

package/esm/typings/src/scrapers/document-legacy/playground/legacy-document-scraper-playground.d.ts

@@ -0,0 +1,5 @@
+#!/usr/bin/env ts-node
+export {};
+/**
+ * Note: [⚫] Code in this file should never be published in any package
+ */

package/esm/typings/src/scrapers/document-legacy/register-constructor.d.ts

@@ -0,0 +1,13 @@
+import type { Registration } from '../../utils/$Register';
+/**
+ * Registration of known scraper
+ *
+ * Warning: This is not useful for the end user, it is just a side effect of the mechanism that handles all available known scrapers
+ *
+ * @public exported from `@promptbook/legacy-documents`
+ * @public exported from `@promptbook/cli`
+ */
+export declare const _LegacyDocumentScraperRegistration: Registration;
+/**
+ * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
+ */

package/esm/typings/src/scrapers/document-legacy/register-metadata.d.ts

@@ -0,0 +1,24 @@
+import type { Registration } from '../../utils/$Register';
+/**
+ * Metadata of the scraper
+ *
+ * @private within the scraper directory
+ */
+export declare const legacyDocumentScraperMetadata: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
+    title: string;
+    packageName: string;
+    className: string;
+    mimeTypes: string[];
+    documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
+    isAvilableInBrowser: false;
+    requiredExecutables: ("Pandoc" | "LibreOffice")[];
+}>;
+/**
+ * Registration of known scraper metadata
+ *
+ * Warning: This is not useful for the end user, it is just a side effect of the mechanism that handles all available known scrapers
+ *
+ * @public exported from `@promptbook/core`
+ * @public exported from `@promptbook/cli`
+ */
+export declare const _LegacyDocumentScraperMetadataRegistration: Registration;

package/esm/typings/src/scrapers/markdown/MarkdownScraper.d.ts

@@ -0,0 +1,29 @@
+import type { KnowledgePiecePreparedJson } from '../../types/PipelineJson/KnowledgePieceJson';
+import type { Scraper } from '../_common/Scraper';
+import type { ScraperSourceHandler } from '../_common/Scraper';
+import type { ExecutionTools } from '../../execution/ExecutionTools';
+import type { PrepareAndScrapeOptions } from '../../prepare/PrepareAndScrapeOptions';
+import type { ScraperAndConverterMetadata } from '../_common/register/ScraperAndConverterMetadata';
+/**
+ * Scraper for markdown files
+ *
+ * @see `documentationUrl` for more details
+ * @public exported from `@promptbook/markdown-utils`
+ */
+export declare class MarkdownScraper implements Scraper {
+    private readonly tools;
+    private readonly options;
+    /**
+     * Metadata of the scraper which includes title, mime types, etc.
+     */
+    get metadata(): ScraperAndConverterMetadata;
+    constructor(tools: Pick<ExecutionTools, 'llm'>, options: PrepareAndScrapeOptions);
+    /**
+     * Scrapes the markdown file and returns the knowledge pieces or `null` if it can't scrape it
+     */
+    scrape(source: ScraperSourceHandler): Promise<ReadonlyArray<Omit<KnowledgePiecePreparedJson, 'sources' | 'preparationIds'>> | null>;
+}
+/**
+ * TODO: [🪂] Do it in parallel 11:11
+ * Note: No need to aggregate usage here, it is done by intercepting the llmTools
+ */

package/esm/typings/src/scrapers/markdown/createMarkdownScraper.d.ts

@@ -0,0 +1,20 @@
+import type { ExecutionTools } from '../../execution/ExecutionTools';
+import type { PrepareAndScrapeOptions } from '../../prepare/PrepareAndScrapeOptions';
+import { MarkdownScraper } from './MarkdownScraper';
+/**
+ * @@@
+ *
+ * @public exported from `@promptbook/markdown-utils`
+ */
+export declare const createMarkdownScraper: ((tools: Pick<ExecutionTools, 'llm'>, options: PrepareAndScrapeOptions) => MarkdownScraper) & import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
+    title: string;
+    packageName: string;
+    className: string;
+    mimeTypes: string[];
+    documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
+    isAvilableInBrowser: true;
+    requiredExecutables: never[];
+}>;
+/**
+ * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
+ */

package/esm/typings/src/scrapers/markdown/playground/markdown-scraper-playground.d.ts

@@ -0,0 +1,5 @@
+#!/usr/bin/env ts-node
+export {};
+/**
+ * Note: [⚫] Code in this file should never be published in any package
+ */

package/esm/typings/src/scrapers/markdown/register-constructor.d.ts

@@ -0,0 +1,13 @@
+import type { Registration } from '../../utils/$Register';
+/**
+ * Registration of known scraper
+ *
+ * Warning: This is not useful for the end user, it is just a side effect of the mechanism that handles all available known scrapers
+ *
+ * @public exported from `@promptbook/markdown-utils`
+ * @public exported from `@promptbook/cli`
+ */
+export declare const _MarkdownScraperRegistration: Registration;
+/**
+ * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
+ */

package/esm/typings/src/scrapers/markdown/register-metadata.d.ts

@@ -0,0 +1,24 @@
+import type { Registration } from '../../utils/$Register';
+/**
+ * Metadata of the scraper
+ *
+ * @private within the scraper directory
+ */
+export declare const markdownScraperMetadata: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
+    title: string;
+    packageName: string;
+    className: string;
+    mimeTypes: string[];
+    documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
+    isAvilableInBrowser: true;
+    requiredExecutables: never[];
+}>;
+/**
+ * Registration of known scraper metadata
+ *
+ * Warning: This is not useful for the end user, it is just a side effect of the mechanism that handles all available known scrapers
+ *
+ * @public exported from `@promptbook/core`
+ * @public exported from `@promptbook/cli`
+ */
+export declare const _MarkdownScraperMetadataRegistration: Registration;

package/esm/typings/src/scrapers/pdf/PdfScraper.d.ts

@@ -0,0 +1,40 @@
+import type { KnowledgePiecePreparedJson } from '../../types/PipelineJson/KnowledgePieceJson';
+import type { Scraper } from '../_common/Scraper';
+import type { ScraperSourceHandler } from '../_common/Scraper';
+import type { ExecutionTools } from '../../execution/ExecutionTools';
+import type { PrepareAndScrapeOptions } from '../../prepare/PrepareAndScrapeOptions';
+import type { Converter } from '../_common/Converter';
+import type { ScraperAndConverterMetadata } from '../_common/register/ScraperAndConverterMetadata';
+import type { ScraperIntermediateSource } from '../_common/ScraperIntermediateSource';
+/**
+ * Scraper for .pdf files
+ *
+ * @see `documentationUrl` for more details
+ * @public exported from `@promptbook/pdf`
+ */
+export declare class PdfScraper implements Converter, Scraper {
+    private readonly tools;
+    private readonly options;
+    /**
+     * Metadata of the scraper which includes title, mime types, etc.
+     */
+    get metadata(): ScraperAndConverterMetadata;
+    /**
+     * Markdown scraper is used internally
+     */
+    private readonly markdownScraper;
+    constructor(tools: Pick<ExecutionTools, 'llm'>, options: PrepareAndScrapeOptions);
+    /**
+     * Converts the `.pdf` file to `.md` file and returns intermediate source
+     */
+    $convert(source: ScraperSourceHandler): Promise<ScraperIntermediateSource>;
+    /**
+     * Scrapes the `.pdf` file and returns the knowledge pieces or `null` if it can't scrape it
+     */
+    scrape(source: ScraperSourceHandler): Promise<ReadonlyArray<Omit<KnowledgePiecePreparedJson, 'sources' | 'preparationIds'>> | null>;
+}
+/**
+ * TODO: [👣] Converted pdf documents can act as cached items - there is no need to run conversion each time
+ * TODO: [🪂] Do it in parallel 11:11
+ * Note: No need to aggregate usage here, it is done by intercepting the llmTools
+ */

package/esm/typings/src/scrapers/pdf/createPdfScraper.d.ts

@@ -0,0 +1,20 @@
+import type { ExecutionTools } from '../../execution/ExecutionTools';
+import type { PrepareAndScrapeOptions } from '../../prepare/PrepareAndScrapeOptions';
+import { PdfScraper } from './PdfScraper';
+/**
+ * @@@
+ *
+ * @public exported from `@promptbook/pdf`
+ */
+export declare const createPdfScraper: ((tools: Pick<ExecutionTools, 'llm'>, options: PrepareAndScrapeOptions) => PdfScraper) & import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
+    title: string;
+    packageName: string;
+    className: string;
+    mimeTypes: string[];
+    documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
+    isAvilableInBrowser: true;
+    requiredExecutables: never[];
+}>;
+/**
+ * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
+ */

package/esm/typings/src/scrapers/pdf/playground/pdf-scraper-playground.d.ts

@@ -0,0 +1,5 @@
+#!/usr/bin/env ts-node
+export {};
+/**
+ * Note: [⚫] Code in this file should never be published in any package
+ */

package/esm/typings/src/scrapers/pdf/register-constructor.d.ts

@@ -0,0 +1,13 @@
+import type { Registration } from '../../utils/$Register';
+/**
+ * Registration of known scraper
+ *
+ * Warning: This is not useful for the end user, it is just a side effect of the mechanism that handles all available known scrapers
+ *
+ * @public exported from `@promptbook/pdf`
+ * @public exported from `@promptbook/cli`
+ */
+export declare const _PdfScraperRegistration: Registration;
+/**
+ * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
+ */

package/esm/typings/src/scrapers/pdf/register-metadata.d.ts

@@ -0,0 +1,24 @@
+import type { Registration } from '../../utils/$Register';
+/**
+ * Metadata of the scraper
+ *
+ * @private within the scraper directory
+ */
+export declare const pdfScraperMetadata: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
+    title: string;
+    packageName: string;
+    className: string;
+    mimeTypes: string[];
+    documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
+    isAvilableInBrowser: true;
+    requiredExecutables: never[];
+}>;
+/**
+ * Registration of known scraper metadata
+ *
+ * Warning: This is not useful for the end user, it is just a side effect of the mechanism that handles all available known scrapers
+ *
+ * @public exported from `@promptbook/core`
+ * @public exported from `@promptbook/cli`
+ */
+export declare const _PdfScraperMetadataRegistration: Registration;

package/esm/typings/src/scripting/javascript/JavascriptExecutionToolsOptions.d.ts

@@ -1,10 +1,10 @@
 import type { Promisable } from 'type-fest';
-import type { CommonExecutionToolsOptions } from '../../execution/CommonExecutionToolsOptions';
+import type { CommonToolsOptions } from '../../execution/CommonToolsOptions';
 import type { string_postprocessing_function_name } from '../../types/typeAliases';
 /**
  * Options for `JavascriptExecutionTools`
  */
-export type JavascriptExecutionToolsOptions = CommonExecutionToolsOptions & {
+export type JavascriptExecutionToolsOptions = CommonToolsOptions & {
     /**
      * Functions to be executed in the JavaScript evaluation.
      *

package/esm/typings/src/scripting/javascript/utils/preserve.d.ts

@@ -7,7 +7,7 @@ import type { really_any } from '../../../utils/organization/really_any';
  * @returns nothing
  * @private internal function of `JavascriptExecutionTools` and `JavascriptEvalExecutionTools`
  */
-export declare function preserve(func: (...params: Array<really_any>) => unknown): void;
+export declare function preserve(func: (...params: ReadonlyArray<really_any>) => unknown): void;
 /**
  * TODO: !! [1] This maybe does memory leak
  */

package/esm/typings/src/scripting/python/PythonExecutionTools.d.ts

@@ -1,4 +1,4 @@
-import type { CommonExecutionToolsOptions } from '../../execution/CommonExecutionToolsOptions';
+import type { CommonToolsOptions } from '../../execution/CommonToolsOptions';
 import type { ScriptExecutionTools } from '../../execution/ScriptExecutionTools';
 import type { ScriptExecutionToolsExecuteOptions } from '../../execution/ScriptExecutionTools';
 /**
@@ -9,8 +9,8 @@ import type { ScriptExecutionToolsExecuteOptions } from '../../execution/ScriptE
  * @private still in development
  */
 export declare class PythonExecutionTools implements ScriptExecutionTools {
-    protected readonly options: CommonExecutionToolsOptions;
-    constructor(options?: CommonExecutionToolsOptions);
+    protected readonly options: CommonToolsOptions;
+    constructor(options?: CommonToolsOptions);
     /**
      * Executes a Python
      */

package/esm/typings/src/scripting/typescript/TypescriptExecutionTools.d.ts

@@ -1,4 +1,4 @@
-import type { CommonExecutionToolsOptions } from '../../execution/CommonExecutionToolsOptions';
+import type { CommonToolsOptions } from '../../execution/CommonToolsOptions';
 import type { ScriptExecutionTools } from '../../execution/ScriptExecutionTools';
 import type { ScriptExecutionToolsExecuteOptions } from '../../execution/ScriptExecutionTools';
 /**
@@ -9,8 +9,8 @@ import type { ScriptExecutionToolsExecuteOptions } from '../../execution/ScriptE
  * @private still in development
  */
 export declare class TypescriptExecutionTools implements ScriptExecutionTools {
-    protected readonly options: CommonExecutionToolsOptions;
-    constructor(options?: CommonExecutionToolsOptions);
+    protected readonly options: CommonToolsOptions;
+    constructor(options?: CommonToolsOptions);
     /**
      * Executes a TypeScript
      */

package/esm/typings/src/storage/{files-storage/FilesStorage.d.ts → file-cache-storage/FileCacheStorage.d.ts}

@@ -1,13 +1,15 @@
+import type { ExecutionTools } from '../../execution/ExecutionTools';
 import type { PromptbookStorage } from '../_common/PromptbookStorage';
-import type { FilesStorageOptions } from './FilesStorageOptions';
+import type { FileCacheStorageOptions } from './FileCacheStorageOptions';
 /**
  * @@@
  *
  * @public exported from `@promptbook/node`
  */
-export declare class FilesStorage<TItem> implements PromptbookStorage<TItem> {
-    protected readonly options: FilesStorageOptions;
-    constructor(options: FilesStorageOptions);
+export declare class FileCacheStorage<TItem> implements PromptbookStorage<TItem> {
+    protected readonly tools: Required<Pick<ExecutionTools, 'fs'>>;
+    private readonly options;
+    constructor(tools: Required<Pick<ExecutionTools, 'fs'>>, options: FileCacheStorageOptions);
     /**
      * @@@
      */
@@ -27,5 +29,5 @@ export declare class FilesStorage<TItem> implements PromptbookStorage<TItem> {
 }
 /**
  * TODO: [🌗] Maybe some checkers, not all valid JSONs are desired and valid values
- * Note: [🟢] This code should never be published outside of `@promptbook/node` and `@promptbook/cli` and `@promptbook/cli`
+ * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
  */

package/esm/typings/src/storage/file-cache-storage/FileCacheStorageOptions.d.ts

@@ -0,0 +1,10 @@
+import type { string_dirname } from '../../types/typeAliases';
+/**
+ * @@@
+ */
+export type FileCacheStorageOptions = {
+    /**
+     * @@@
+     */
+    rootFolderPath: string_dirname;
+};

package/esm/typings/src/storage/{files-storage → file-cache-storage}/utils/nameToSubfolderPath.d.ts

@@ -2,6 +2,6 @@ import type { string_name } from '../../../types/typeAliases';
 /**
  * @@@
  *
- * @private for `FilesStorage`
+ * @private for `FileCacheStorage`
  */
-export declare function nameToSubfolderPath(name: string_name): Array<string>;
+export declare function nameToSubfolderPath(name: string_name): ReadonlyArray<string>;

package/esm/typings/src/storage/local-storage/getLocalStorage.d.ts

@@ -6,5 +6,5 @@ import type { PromptbookStorage } from '../_common/PromptbookStorage';
  */
 export declare function getLocalStorage<TItem>(): PromptbookStorage<TItem>;
 /**
- * Note: [🔵] This code should never be published outside of `@promptbook/browser`
+ * Note: [🔵] Code in this file should never be published outside of `@promptbook/browser`
  */

package/esm/typings/src/storage/local-storage/getSessionStorage.d.ts

@@ -6,5 +6,5 @@ import type { PromptbookStorage } from '../_common/PromptbookStorage';
  */
 export declare function getSessionStorage<TItem>(): PromptbookStorage<TItem>;
 /**
- * Note: [🔵] This code should never be published outside of `@promptbook/browser`
+ * Note: [🔵] Code in this file should never be published outside of `@promptbook/browser`
  */

package/esm/typings/src/storage/{utils → memory/utils}/PrefixStorage.d.ts

@@ -1,5 +1,5 @@
 import type { Promisable } from 'type-fest';
-import type { PromptbookStorage } from '../_common/PromptbookStorage';
+import type { PromptbookStorage } from '../../_common/PromptbookStorage';
 /**
  * This class behaves like LocalStorage but separates keys by prefix
  *

package/esm/typings/src/storage/{utils → memory/utils}/makePromptbookStorageFromWebStorage.d.ts

@@ -1,4 +1,4 @@
-import type { PromptbookStorage } from '../_common/PromptbookStorage';
+import type { PromptbookStorage } from '../../_common/PromptbookStorage';
 /**
  * @@@
  *

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

@@ -7,4 +7,4 @@
  *
  * @private internal type
  */
-export type Arrayable<TItem> = TItem | Array<TItem> | undefined;
+export type Arrayable<TItem> = TItem | ReadonlyArray<TItem> | undefined;

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

@@ -0,0 +1,7 @@
+/**
+ * @@@
+ */
+export type IntermediateFilesStrategy = 'HIDE_AND_CLEAN' | 'HIDE_AND_KEEP';
+/**
+ * TODO: [🎅] Maube add options for all kinds of cache, unite with `isCacheReloaded` and make `cacheStrategy` (which is not specific only for intermediate files)
+ */

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

@@ -31,7 +31,7 @@ export type KnowledgePiecePreparedJson = {
     /**
      * List of sources where the information comes from
      */
-    readonly sources: Array<{
+    readonly sources: ReadonlyArray<{
         /**
          * Identifier of the source
          */
@@ -48,11 +48,11 @@ export type KnowledgePiecePreparedJson = {
     /**
      * List of keywords that are associated with the knowledge piece
      */
-    readonly keywords: Array<string_keyword>;
+    readonly keywords: ReadonlyArray<string_keyword>;
     /**
      * List of models embeddings that are associated with the knowledge piece
      */
-    readonly index: Array<{
+    readonly index: ReadonlyArray<{
         /**
          * Model name which generated the embedding
          */
@@ -65,7 +65,7 @@ export type KnowledgePiecePreparedJson = {
     /**
      * List of preparation ids that were used to prepare this knowledge piece
      */
-    readonly preparationIds: Array<number_id>;
+    readonly preparationIds: ReadonlyArray<number_id>;
 };
 /**
  * TODO: [🍙] Make some standard order of json properties

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

@@ -11,11 +11,18 @@ import type { string_name } from '../typeAliases';
  */
 export type KnowledgeSourceJson = {
     /**
-     * @@@
+     * Unique identifier of the knowledge source
      */
     readonly name: string_name;
     /**
-     * @@@
+     * Source of one knowledge
+     *
+     * It can be a link, a relative path to file or direct text or combination of those
+     *
+     * For example `"https://pavolhejny.com/"`
+     * For example `"./pavol-hejny-cv.pdf"`
+     * 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;
 };
@@ -30,7 +37,7 @@ export type KnowledgeSourcePreparedJson = KnowledgeSourceJson & {
     /**
      * List of preparation ids that were used to prepare this knowledge source to knowledge pieces
      */
-    readonly preparationIds: Array<number_id>;
+    readonly preparationIds: ReadonlyArray<number_id>;
 };
 /**
  * TODO: [🍙] Make some standard order of json properties

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

@@ -33,7 +33,7 @@ export type ParameterJson = {
     readonly sampleValues?: Array<string_parameter_value>;
 };
 /**
- * TODO: [🧠] !!!!!! Should be here registered subparameter from foreach or not?
+ * TODO: [🧠] Should be here registered subparameters from foreach or not?
  * TODO: [♈] Probbably move expectations from templates to parameters
  * TODO: [🍙] Make some standard order of json properties
  */

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

@@ -38,7 +38,7 @@ export type PersonaPreparedJson = PersonaJson & {
     /**
      * List of preparation ids that were used to prepare this persona
      */
-    readonly preparationIds: Array<number_id>;
+    readonly preparationIds: ReadonlyArray<number_id>;
 };
 /**
  * TODO: [🍙] Make some standard order of json properties

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

@@ -1,5 +1,5 @@
 import type { ModelRequirements } from '../ModelRequirements';
-import type { string_file_path } from '../typeAliases';
+import type { string_filename } from '../typeAliases';
 import type { string_markdown_text } from '../typeAliases';
 import type { string_pipeline_url } from '../typeAliases';
 import type { string_semantic_version } from '../typeAliases';
@@ -33,7 +33,7 @@ export type PipelineJson = {
     /**
      * Internal helper for tracking the source `.ptbk.md` file of the pipeline
      */
-    readonly sourceFile?: string_file_path;
+    readonly sourceFile?: string_filename;
     /**
      * Title of the promptbook
      * -It can use simple markdown formatting like **bold**, *italic*, [link](https://example.com), ... BUT not code blocks and structure

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

@@ -13,7 +13,7 @@ import type { Expectations } from './Expectations';
 /**
  * Common properties of all templates
  */
-export interface TemplateJsonCommon {
+export type TemplateJsonCommon = {
     /**
      * Name of the template
      * - It must be unique across the pipeline
@@ -93,7 +93,7 @@ export interface TemplateJsonCommon {
      * Name of the parameter that is the result of the template
      */
     readonly resultingParameterName: string_name;
-}
+};
 /**
  * TODO: use one helper type> (string_prompt | string_javascript | string_markdown) & string_template
  * TODO: [♈] Probbably move expectations from templates to parameters

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

@@ -77,7 +77,7 @@ export type CommonPrompt = {
     /**
      * List of postprocessing steps that are executed after the prompt
      */
-    readonly postprocessingFunctionNames?: Array<string_postprocessing_function_name>;
+    readonly postprocessingFunctionNames?: ReadonlyArray<string_postprocessing_function_name>;
     /**
      * Expectations for the answer
      *
@@ -107,4 +107,5 @@ export type CommonPrompt = {
  * TODO: [🧄] Replace all "github.com/webgptorg/promptbook#xxx" with "ptbk.io/xxx"
  * TODO: [✔] Check ModelRequirements in runtime
  * TODO: [🏳] Add options for translation - maybe create `TranslationPrompt`
+ * TODO: [🧠][🤺] Maybe allow overriding of `userId` for each prompt
  */

package/esm/typings/src/types/execution-report/ExecutionReportJson.d.ts

@@ -37,8 +37,5 @@ export type ExecutionReportJson = {
     /**
      * Sequence of templates in order which were executed
      */
-    readonly promptExecutions: Array<ExecutionPromptReportJson>;
+    readonly promptExecutions: ReadonlyArray<ExecutionPromptReportJson>;
 };
-/**
- * TODO: !!!!!! FOREACH in report
- */