@promptbook/remote-server 0.72.0-9 → 0.73.0

package/esm/typings/src/prepare/isPipelinePrepared.d.ts

@@ -6,11 +6,11 @@ import type { PipelineJson } from '../types/PipelineJson/PipelineJson';
  */
 export declare function isPipelinePrepared(pipeline: PipelineJson): boolean;
 /**
- * TODO: [🔃][main] !!!!! If the pipeline was prepared with different version or different set of models, prepare it once again
+ * TODO: [🔃][main] !! If the pipeline was prepared with different version or different set of models, prepare it once again
  * TODO: [🐠] Maybe base this on `makeValidator`
  * TODO: [🧊] Pipeline can be partially prepared, this should return true ONLY if fully prepared
  * TODO: [🧿] Maybe do same process with same granularity and subfinctions as `preparePipeline`
  *     - [🏍] ? Is context in each template
- *     - [♨] Are samples prepared
+ *     - [♨] Are examples prepared
  *     - [♨] Are templates prepared
  */

package/esm/typings/src/prepare/prepareTemplates.d.ts

@@ -12,7 +12,7 @@ type PreparedTemplates = {
     /**
      * @@@ Sequence of templates that are chained together to form a pipeline
      */
-    readonly templatesPrepared: Array<TemplateJson>;
+    readonly templatesPrepared: ReadonlyArray<TemplateJson>;
 };
 /**
  * @@@
@@ -24,7 +24,7 @@ export {};
 /**
  * TODO: [🧠] Add context to each template (if missing)
  * TODO: [🧠] What is better name `prepareTemplate` or `prepareTemplateAndParameters`
- * TODO: [♨][main] !!! Prepare index the samples and maybe templates
+ * TODO: [♨][main] !!! Prepare index the examples and maybe templates
  * TODO: Write tests for `preparePipeline`
  * TODO: [🏏] Leverage the batch API and build queues @see https://platform.openai.com/docs/guides/batch
  * TODO: [🧊] In future one preparation can take data from previous preparation and save tokens and time

package/esm/typings/src/scrapers/_common/Scraper.d.ts

@@ -17,7 +17,7 @@ export type Scraper = {
     /**
      * Scrapes the markdown file and returns the knowledge pieces or `null` if it can't scrape it
      */
-    scrape(source: ScraperSourceHandler): Promisable<Array<Omit<KnowledgePiecePreparedJson, 'sources' | 'preparationIds'>> | null>;
+    scrape(source: ScraperSourceHandler): Promisable<ReadonlyArray<Omit<KnowledgePiecePreparedJson, 'sources' | 'preparationIds'>> | null>;
 };
 /**
  * @@@
@@ -51,16 +51,9 @@ export type ScraperSourceHandler = {
      * Get the content as a utf-8 string
      */
     asText(): Promisable<string>;
-    /**
-     * Get the content as a blob
-     */
-    asBlob(): Promisable<Blob>;
 };
 /**
+ * TODO: [🥽] Add ` asBlob(): Promisable<Blob>;` or asFile
  * TODO: [🐝] @@@ Annotate all
  * TODO: [🔼] Export via types
  */
-/**
- * TODO: !!!!!! Test that this is catched
- * Note: [⚫] Code in this file should never be published in any package
- */

package/esm/typings/src/scrapers/_common/prepareKnowledgePieces.d.ts

@@ -8,7 +8,7 @@ import type { ExecutionTools } from '../../execution/ExecutionTools';
  * @see https://github.com/webgptorg/promptbook/discussions/41
  * @public exported from `@promptbook/core`
  */
-export declare function prepareKnowledgePieces(knowledgeSources: Array<KnowledgeSourceJson>, tools: Pick<ExecutionTools, 'llm' | 'fs' | 'scrapers'>, options: PrepareAndScrapeOptions): Promise<Array<Omit<KnowledgePiecePreparedJson, 'preparationIds'>>>;
+export declare function prepareKnowledgePieces(knowledgeSources: ReadonlyArray<KnowledgeSourceJson>, tools: Pick<ExecutionTools, 'llm' | 'fs' | 'scrapers'>, options: PrepareAndScrapeOptions): Promise<ReadonlyArray<Omit<KnowledgePiecePreparedJson, 'preparationIds'>>>;
 /**
  * TODO: [🧊] In future one preparation can take data from previous preparation and save tokens and time
  *       Put `knowledgePieces` into `PrepareKnowledgeOptions`

package/esm/typings/src/scrapers/_common/register/$provideScrapersForBrowser.d.ts

@@ -2,11 +2,11 @@ import type { ExecutionTools } from '../../../execution/ExecutionTools';
 import type { PrepareAndScrapeOptions } from '../../../prepare/PrepareAndScrapeOptions';
 import type { Scraper } from '../Scraper';
 /**
- * @@@!!!!!!
+ * @@@
  *
  * 1) @@@
  * 2) @@@
  *
  * @public exported from `@promptbook/browser`
  */
-export declare function $provideScrapersForBrowser(tools: Pick<ExecutionTools, 'llm'>, options?: PrepareAndScrapeOptions): Promise<Array<Scraper>>;
+export declare function $provideScrapersForBrowser(tools: Pick<ExecutionTools, 'llm'>, options?: PrepareAndScrapeOptions): Promise<ReadonlyArray<Scraper>>;

package/esm/typings/src/scrapers/_common/register/$provideScrapersForNode.d.ts

@@ -2,14 +2,14 @@ import type { ExecutionTools } from '../../../execution/ExecutionTools';
 import type { PrepareAndScrapeOptions } from '../../../prepare/PrepareAndScrapeOptions';
 import type { Scraper } from '../Scraper';
 /**
- * !!!!!!
+ * @@@
  *
  * 1) @@@
  * 2) @@@
  *
  * @public exported from `@promptbook/node`
  */
-export declare function $provideScrapersForNode(tools: Pick<ExecutionTools, 'fs' | 'llm'>, options?: PrepareAndScrapeOptions): Promise<Array<Scraper>>;
+export declare function $provideScrapersForNode(tools: Pick<ExecutionTools, 'fs' | 'llm' | 'executables'>, options?: PrepareAndScrapeOptions): Promise<ReadonlyArray<Scraper>>;
 /**
  * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
  */

package/esm/typings/src/scrapers/_common/register/ScraperAndConverterMetadata.d.ts

@@ -1,8 +1,8 @@
+import type { Executables } from '../../../execution/Executables';
 import type { string_mime_type } from '../../../types/typeAliases';
 import type { string_promptbook_documentation_url } from '../../../types/typeAliases';
 import type { string_title } from '../../../types/typeAliases';
 import type { Registered } from '../../../utils/$Register';
-import type { TODO_any } from '../../../utils/organization/TODO_any';
 /**
  * @@@
  *
@@ -33,7 +33,7 @@ export type ScraperAndConverterMetadata = Registered & {
     /**
      * @@@
      */
-    readonly requiredExecutables: TODO_any;
+    readonly requiredExecutables: ReadonlyArray<Capitalize<keyof Executables extends `${infer N}Path` ? N : never>>;
     /**
      * Link to documentation
      */

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

@@ -13,7 +13,7 @@ type GetScraperIntermediateSourceSource = Pick<ScraperSourceHandler, 'filename'
  *
  * @private internal utility of `getScraperIntermediateSource`
  */
-type GetScraperIntermediateSourceHandler = Required<Pick<PrepareAndScrapeOptions, 'rootDirname' | 'cacheDirname' | 'isCacheCleaned' | 'isVerbose'>> & {
+type GetScraperIntermediateSourceHandler = Required<Pick<PrepareAndScrapeOptions, 'rootDirname' | 'cacheDirname' | 'intermediateFilesStrategy' | 'isVerbose'>> & {
     readonly extension: string_file_extension;
 };
 /**
@@ -28,7 +28,7 @@ export {};
 /**
  * Note: Not using `FileCacheStorage` for two reasons:
  * 1) Need to store more than serialized JSONs
- * 2) Need to switch between a `rootDirname` and `cacheDirname` <- TODO: !!!!
+ * 2) Need to switch between a `rootDirname` and `cacheDirname` <- TODO: [😡]
  * TODO: [🐱‍🐉][🧠] Make some smart crop
  * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
  */

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

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

package/esm/typings/src/scrapers/document/DocumentScraper.d.ts

@@ -23,7 +23,7 @@ export declare class DocumentScraper implements Converter, Scraper {
      * Markdown scraper is used internally
      */
     private readonly markdownScraper;
-    constructor(tools: Pick<ExecutionTools, 'fs' | 'llm'>, options: PrepareAndScrapeOptions);
+    constructor(tools: Pick<ExecutionTools, 'fs' | 'llm' | 'executables'>, options: PrepareAndScrapeOptions);
     /**
      * Convert the `.docx` or `.odt`  to `.md` file and returns intermediate source
      *
@@ -33,7 +33,7 @@ export declare class DocumentScraper implements Converter, Scraper {
     /**
      * Scrapes the docx file and returns the knowledge pieces or `null` if it can't scrape it
      */
-    scrape(source: ScraperSourceHandler): Promise<Array<Omit<KnowledgePiecePreparedJson, 'sources' | 'preparationIds'>> | null>;
+    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

package/esm/typings/src/scrapers/document/DocumentScraper.test.d.ts

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

package/esm/typings/src/scrapers/document/createDocumentScraper.d.ts

@@ -13,7 +13,7 @@ export declare const createDocumentScraper: ((tools: Pick<ExecutionTools, 'llm'>
     mimeTypes: string[];
     documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
     isAvilableInBrowser: false;
-    requiredExecutables: string[];
+    requiredExecutables: "Pandoc"[];
 }>;
 /**
  * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"

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

@@ -11,7 +11,7 @@ export declare const documentScraperMetadata: import("type-fest/source/readonly-
     mimeTypes: string[];
     documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
     isAvilableInBrowser: false;
-    requiredExecutables: string[];
+    requiredExecutables: "Pandoc"[];
 }>;
 /**
  * Registration of known scraper metadata

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

@@ -7,7 +7,7 @@ import type { Scraper } from '../_common/Scraper';
 import type { ScraperSourceHandler } from '../_common/Scraper';
 import type { ScraperIntermediateSource } from '../_common/ScraperIntermediateSource';
 /**
- * Scraper for .docx files
+ * Scraper for old document files (like .doc and .rtf)
  *
  * @see `documentationUrl` for more details
  * @public exported from `@promptbook/legacy-documents`
@@ -23,7 +23,7 @@ export declare class LegacyDocumentScraper implements Converter, Scraper {
      * Document scraper is used internally
      */
     private readonly documentScraper;
-    constructor(tools: Pick<ExecutionTools, 'fs' | 'llm'>, options: PrepareAndScrapeOptions);
+    constructor(tools: Pick<ExecutionTools, 'fs' | 'llm' | 'executables'>, options: PrepareAndScrapeOptions);
     /**
      * Convert the `.doc` or `.rtf`  to `.doc` file and returns intermediate source
      *
@@ -33,7 +33,7 @@ export declare class LegacyDocumentScraper implements Converter, Scraper {
     /**
      * Scrapes the `.doc` or `.rtf` file and returns the knowledge pieces or `null` if it can't scrape it
      */
-    scrape(source: ScraperSourceHandler): Promise<Array<Omit<KnowledgePiecePreparedJson, 'sources' | 'preparationIds'>> | null>;
+    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

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

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

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

@@ -13,7 +13,7 @@ export declare const createLegacyDocumentScraper: ((tools: Pick<ExecutionTools,
     mimeTypes: string[];
     documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
     isAvilableInBrowser: false;
-    requiredExecutables: string[];
+    requiredExecutables: ("Pandoc" | "LibreOffice")[];
 }>;
 /**
  * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"

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

@@ -11,7 +11,7 @@ export declare const legacyDocumentScraperMetadata: import("type-fest/source/rea
     mimeTypes: string[];
     documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
     isAvilableInBrowser: false;
-    requiredExecutables: string[];
+    requiredExecutables: ("Pandoc" | "LibreOffice")[];
 }>;
 /**
  * Registration of known scraper metadata

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

@@ -21,7 +21,7 @@ export declare class MarkdownScraper implements Scraper {
     /**
      * Scrapes the markdown file and returns the knowledge pieces or `null` if it can't scrape it
      */
-    scrape(source: ScraperSourceHandler): Promise<Array<Omit<KnowledgePiecePreparedJson, 'sources' | 'preparationIds'>> | null>;
+    scrape(source: ScraperSourceHandler): Promise<ReadonlyArray<Omit<KnowledgePiecePreparedJson, 'sources' | 'preparationIds'>> | null>;
 }
 /**
  * TODO: [🪂] Do it in parallel 11:11

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

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

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

@@ -13,7 +13,7 @@ export declare const createMarkdownScraper: ((tools: Pick<ExecutionTools, 'llm'>
     mimeTypes: string[];
     documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
     isAvilableInBrowser: true;
-    requiredExecutables: string[];
+    requiredExecutables: never[];
 }>;
 /**
  * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"

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

@@ -11,7 +11,7 @@ export declare const markdownScraperMetadata: import("type-fest/source/readonly-
     mimeTypes: string[];
     documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
     isAvilableInBrowser: true;
-    requiredExecutables: string[];
+    requiredExecutables: never[];
 }>;
 /**
  * Registration of known scraper metadata

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

@@ -7,7 +7,7 @@ import type { Converter } from '../_common/Converter';
 import type { ScraperAndConverterMetadata } from '../_common/register/ScraperAndConverterMetadata';
 import type { ScraperIntermediateSource } from '../_common/ScraperIntermediateSource';
 /**
- * Scraper for .docx files
+ * Scraper for .pdf files
  *
  * @see `documentationUrl` for more details
  * @public exported from `@promptbook/pdf`
@@ -31,7 +31,7 @@ export declare class PdfScraper implements Converter, Scraper {
     /**
      * Scrapes the `.pdf` file and returns the knowledge pieces or `null` if it can't scrape it
      */
-    scrape(source: ScraperSourceHandler): Promise<Array<Omit<KnowledgePiecePreparedJson, 'sources' | 'preparationIds'>> | null>;
+    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

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

@@ -13,7 +13,7 @@ export declare const createPdfScraper: ((tools: Pick<ExecutionTools, 'llm'>, opt
     mimeTypes: string[];
     documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
     isAvilableInBrowser: true;
-    requiredExecutables: string[];
+    requiredExecutables: never[];
 }>;
 /**
  * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"

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

@@ -11,7 +11,7 @@ export declare const pdfScraperMetadata: import("type-fest/source/readonly-deep"
     mimeTypes: string[];
     documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
     isAvilableInBrowser: true;
-    requiredExecutables: string[];
+    requiredExecutables: never[];
 }>;
 /**
  * Registration of known scraper metadata

package/esm/typings/src/scrapers/website/WebsiteScraper.d.ts

@@ -8,7 +8,7 @@ import type { PrepareAndScrapeOptions } from '../../prepare/PrepareAndScrapeOpti
 import type { ScraperAndConverterMetadata } from '../_common/register/ScraperAndConverterMetadata';
 import type { ScraperIntermediateSource } from '../_common/ScraperIntermediateSource';
 /**
- * Scraper for .docx files
+ * Scraper for websites
  *
  * @see `documentationUrl` for more details
  * @public exported from `@promptbook/website-crawler`
@@ -24,6 +24,10 @@ export declare class WebsiteScraper implements Converter, Scraper {
      * Markdown scraper is used internally
      */
     private readonly markdownScraper;
+    /**
+     * Showdown converter is used internally
+     */
+    private readonly showdownConverter;
     constructor(tools: Pick<ExecutionTools, 'fs' | 'llm'>, options: PrepareAndScrapeOptions);
     /**
      * Convert the website  to `.md` file and returns intermediate source
@@ -36,10 +40,9 @@ export declare class WebsiteScraper implements Converter, Scraper {
     /**
      * Scrapes the website and returns the knowledge pieces or `null` if it can't scrape it
      */
-    scrape(source: ScraperSourceHandler): Promise<Array<Omit<KnowledgePiecePreparedJson, 'sources' | 'preparationIds'>> | null>;
+    scrape(source: ScraperSourceHandler): Promise<ReadonlyArray<Omit<KnowledgePiecePreparedJson, 'sources' | 'preparationIds'>> | null>;
 }
 /**
- * TODO: !!!!!! Put into separate package
  * TODO: [👣] Scraped website in .md can act as cache item - 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/website/createWebsiteScraper.d.ts

@@ -13,7 +13,7 @@ export declare const createWebsiteScraper: ((tools: Pick<ExecutionTools, 'llm'>,
     mimeTypes: string[];
     documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
     isAvilableInBrowser: false;
-    requiredExecutables: string[];
+    requiredExecutables: never[];
 }>;
 /**
  * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"

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

@@ -11,7 +11,7 @@ export declare const websiteScraperMetadata: import("type-fest/source/readonly-d
     mimeTypes: string[];
     documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
     isAvilableInBrowser: false;
-    requiredExecutables: string[];
+    requiredExecutables: never[];
 }>;
 /**
  * Registration of known scraper metadata

package/esm/typings/src/scrapers/website/utils/createShowdownConverter.d.ts

@@ -0,0 +1,7 @@
+import { Converter as ShowdownConverter } from 'showdown';
+/**
+ * Create a new showdown converter instance
+ *
+ * @private utility of `WebsiteScraper`
+ */
+export declare function createShowdownConverter(): ShowdownConverter;

package/esm/typings/src/scrapers/website/utils/createShowdownConverter.test.d.ts

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

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/storage/file-cache-storage/utils/nameToSubfolderPath.d.ts

@@ -4,4 +4,4 @@ import type { string_name } from '../../../types/typeAliases';
  *
  * @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/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

@@ -37,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

@@ -27,10 +27,10 @@ export type ParameterJson = {
      */
     readonly description?: string_markdown_text;
     /**
-     * Sample values of the parameter
+     * Example values of the parameter
      * Note: This values won't be actually used as some default values, but they are just for better understanding of the parameter
      */
-    readonly sampleValues?: Array<string_parameter_value>;
+    readonly exampleValues?: Array<string_parameter_value>;
 };
 /**
  * TODO: [🧠] Should be here registered subparameters from foreach or not?

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/PreparationJson.d.ts

@@ -18,5 +18,5 @@ export type PreparationJson = {
 /**
  * TODO: [🍙] Make some standard order of json properties
  * TODO: Maybe put here used `modelName`
- * TODO: [🍥] When using `date` it changes all samples .ptbk.json files each time so until some more elegant solution omit the time from prepared pipeline
+ * TODO: [🍥] When using `date` it changes all examples .ptbk.json files each time so until some more elegant solution omit the time from prepared pipeline
  */

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,5 +37,5 @@ export type ExecutionReportJson = {
     /**
      * Sequence of templates in order which were executed
      */
-    readonly promptExecutions: Array<ExecutionPromptReportJson>;
+    readonly promptExecutions: ReadonlyArray<ExecutionPromptReportJson>;
 };

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

@@ -350,12 +350,6 @@ export type string_uri = string;
  * For example `"9SeSQTupmQHwuSrLi"`
  */
 export type string_uri_part = string;
-/**
- * Semantic helper, ID of the board used in URL and API
- *
- * For example `"9SeSQTupmQHwuSrLi"` <- TODO: !! Update
- */
-export type string_uriid = string_uri_part;
 /**
  * Semantic helper
  *
@@ -399,9 +393,17 @@ export type string_uuid = string & {
     readonly _type: 'uuid';
 };
 /**
- * End user identifier;
+ * Application identifier
+ *
+ * @@@
+ */
+export type string_app_id = id;
+/**
+ * End user identifier
+ *
+ * @@@
  */
-export type string_user_id = string;
+export type string_user_id = id;
 /**
  * Semantic helper
  *
@@ -523,6 +525,7 @@ export type string_javascript_name = string;
  * Semantic helper; For example "unwrapResult" or "spaceTrim"
  */
 export type string_postprocessing_function_name = string;
+export type id = string | number;
 export type string_token = string;
 export type string_license_token = string_token;
 export type string_password = string;

package/esm/typings/src/utils/$Register.d.ts

@@ -34,6 +34,6 @@ export declare class $Register<TRegistered extends Registered> {
     private readonly registerName;
     private readonly storage;
     constructor(registerName: string_name);
-    list(): Array<TRegistered>;
+    list(): ReadonlyArray<TRegistered>;
     register(registered: TRegistered): Registration;
 }

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

@@ -1,7 +1,7 @@
 /**
  * Represents items which are compared to each other
  */
-export type FromtoItems = Array<{
+export type FromtoItems = ReadonlyArray<{
     /**
      * The title of the item
      */

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

@@ -8,4 +8,4 @@ import type { Arrayable } from '../types/Arrayable';
  *
  * @private internal utility
  */
-export declare function arrayableToArray<TItem>(input?: Arrayable<TItem>): Array<TItem>;
+export declare function arrayableToArray<TItem>(input?: Arrayable<TItem>): ReadonlyArray<TItem>;

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

@@ -8,7 +8,7 @@ import type { string_char_emoji } from '../types/typeAliasEmoji';
  * @private within the repository
  * @deprecated Use /\p{Extended_Pictographic}/ instead
  */
-export declare const EMOJIS_IN_CATEGORIES: Record<string, Array<string_char_emoji>>;
+export declare const EMOJIS_IN_CATEGORIES: Record<string, ReadonlyArray<string_char_emoji>>;
 /**
  *
  * All possible emoji chars like "🍆", "🍡", "🍤"...