@promptbook/legacy-documents 0.72.0-14 → 0.72.0-23

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (119) hide show
  1. package/README.md +1 -1
  2. package/esm/index.es.js +136 -136
  3. package/esm/index.es.js.map +1 -1
  4. package/esm/typings/src/_packages/cli.index.d.ts +0 -4
  5. package/esm/typings/src/_packages/core.index.d.ts +22 -20
  6. package/esm/typings/src/_packages/node.index.d.ts +2 -0
  7. package/esm/typings/src/_packages/types.index.d.ts +12 -10
  8. package/esm/typings/src/_packages/utils.index.d.ts +2 -2
  9. package/esm/typings/src/collection/PipelineCollection.d.ts +1 -1
  10. package/esm/typings/src/collection/SimplePipelineCollection.d.ts +2 -2
  11. package/esm/typings/src/collection/collectionToJson.d.ts +1 -1
  12. package/esm/typings/src/collection/constructors/createCollectionFromJson.d.ts +1 -1
  13. package/esm/typings/src/collection/constructors/createCollectionFromPromise.d.ts +1 -1
  14. package/esm/typings/src/commands/_common/types/CommandParser.d.ts +5 -5
  15. package/esm/typings/src/config.d.ts +21 -14
  16. package/esm/typings/src/executables/$provideExecutablesForNode.d.ts +12 -0
  17. package/esm/typings/src/executables/apps/locateLibreoffice.d.ts +11 -0
  18. package/esm/typings/src/executables/apps/locatePandoc.d.ts +11 -0
  19. package/esm/typings/src/executables/locateApp.d.ts +33 -0
  20. package/esm/typings/src/executables/locateApp.test.d.ts +1 -0
  21. package/esm/typings/src/executables/platforms/locateAppOnLinux.d.ts +12 -0
  22. package/esm/typings/src/executables/platforms/locateAppOnMacOs.d.ts +12 -0
  23. package/esm/typings/src/executables/platforms/locateAppOnWindows.d.ts +12 -0
  24. package/esm/typings/src/execution/EmbeddingVector.d.ts +1 -1
  25. package/esm/typings/src/execution/Executables.d.ts +18 -0
  26. package/esm/typings/src/execution/ExecutionTools.d.ts +9 -3
  27. package/esm/typings/src/execution/LlmExecutionTools.d.ts +1 -1
  28. package/esm/typings/src/execution/PipelineExecutorResult.d.ts +2 -2
  29. package/esm/typings/src/execution/assertsExecutionSuccessful.d.ts +1 -0
  30. package/esm/typings/src/execution/createPipelineExecutor/00-CreatePipelineExecutorOptions.d.ts +29 -6
  31. package/esm/typings/src/execution/createPipelineExecutor/10-executePipeline.d.ts +2 -11
  32. package/esm/typings/src/execution/createPipelineExecutor/20-executeTemplate.d.ts +4 -13
  33. package/esm/typings/src/execution/createPipelineExecutor/40-executeAttempts.d.ts +9 -14
  34. package/esm/typings/src/execution/translation/automatic-translate/automatic-translators/LindatAutomaticTranslator.d.ts +11 -3
  35. package/esm/typings/src/execution/utils/addUsage.d.ts +1 -1
  36. package/esm/typings/src/execution/utils/forEachAsync.d.ts +1 -1
  37. package/esm/typings/src/formats/_common/FormatDefinition.d.ts +2 -2
  38. package/esm/typings/src/formats/_common/FormatSubvalueDefinition.d.ts +2 -2
  39. package/esm/typings/src/llm-providers/_common/register/$provideLlmToolsForCli.d.ts +2 -2
  40. package/esm/typings/src/llm-providers/_common/register/LlmToolsConfiguration.d.ts +1 -1
  41. package/esm/typings/src/llm-providers/_common/utils/cache/CacheLlmToolsOptions.d.ts +4 -1
  42. package/esm/typings/src/llm-providers/anthropic-claude/AnthropicClaudeExecutionTools.d.ts +1 -1
  43. package/esm/typings/src/llm-providers/anthropic-claude/anthropic-claude-models.d.ts +1 -1
  44. package/esm/typings/src/llm-providers/azure-openai/AzureOpenAiExecutionTools.d.ts +1 -1
  45. package/esm/typings/src/llm-providers/mocked/$fakeTextToExpectations.d.ts +1 -1
  46. package/esm/typings/src/llm-providers/mocked/MockedEchoLlmExecutionTools.d.ts +1 -1
  47. package/esm/typings/src/llm-providers/mocked/MockedFackedLlmExecutionTools.d.ts +1 -1
  48. package/esm/typings/src/llm-providers/multiple/MultipleLlmExecutionTools.d.ts +4 -5
  49. package/esm/typings/src/llm-providers/multiple/joinLlmExecutionTools.d.ts +1 -1
  50. package/esm/typings/src/llm-providers/openai/OpenAiAssistantExecutionTools.d.ts +0 -1
  51. package/esm/typings/src/llm-providers/openai/OpenAiExecutionTools.d.ts +1 -1
  52. package/esm/typings/src/llm-providers/openai/openai-models.d.ts +1 -1
  53. package/esm/typings/src/llm-providers/remote/RemoteLlmExecutionTools.d.ts +1 -1
  54. package/esm/typings/src/llm-providers/remote/interfaces/PromptbookServer_ListModels_Response.d.ts +3 -3
  55. package/esm/typings/src/llm-providers/remote/interfaces/PromptbookServer_Prompt_Response.d.ts +2 -2
  56. package/esm/typings/src/prepare/PrepareAndScrapeOptions.d.ts +4 -23
  57. package/esm/typings/src/prepare/prepareTemplates.d.ts +1 -1
  58. package/esm/typings/src/scrapers/_common/Scraper.d.ts +2 -9
  59. package/esm/typings/src/scrapers/_common/prepareKnowledgePieces.d.ts +1 -1
  60. package/esm/typings/src/scrapers/_common/register/$provideScrapersForBrowser.d.ts +2 -2
  61. package/esm/typings/src/scrapers/_common/register/$provideScrapersForNode.d.ts +2 -2
  62. package/esm/typings/src/scrapers/_common/register/ScraperAndConverterMetadata.d.ts +2 -2
  63. package/esm/typings/src/scrapers/_common/utils/getScraperIntermediateSource.d.ts +2 -2
  64. package/esm/typings/src/scrapers/document/DocumentScraper.d.ts +2 -2
  65. package/esm/typings/src/scrapers/document/createDocumentScraper.d.ts +1 -1
  66. package/esm/typings/src/scrapers/document/register-metadata.d.ts +1 -1
  67. package/esm/typings/src/scrapers/document-legacy/LegacyDocumentScraper.d.ts +3 -3
  68. package/esm/typings/src/scrapers/document-legacy/createLegacyDocumentScraper.d.ts +1 -1
  69. package/esm/typings/src/scrapers/document-legacy/register-metadata.d.ts +1 -1
  70. package/esm/typings/src/scrapers/markdown/MarkdownScraper.d.ts +1 -1
  71. package/esm/typings/src/scrapers/markdown/createMarkdownScraper.d.ts +1 -1
  72. package/esm/typings/src/scrapers/markdown/register-metadata.d.ts +1 -1
  73. package/esm/typings/src/scrapers/pdf/PdfScraper.d.ts +2 -2
  74. package/esm/typings/src/scrapers/pdf/createPdfScraper.d.ts +1 -1
  75. package/esm/typings/src/scrapers/pdf/register-metadata.d.ts +1 -1
  76. package/esm/typings/src/scripting/javascript/utils/preserve.d.ts +1 -1
  77. package/esm/typings/src/storage/file-cache-storage/utils/nameToSubfolderPath.d.ts +1 -1
  78. package/esm/typings/src/types/Arrayable.d.ts +1 -1
  79. package/esm/typings/src/types/IntermediateFilesStrategy.d.ts +7 -0
  80. package/esm/typings/src/types/PipelineJson/KnowledgePieceJson.d.ts +4 -4
  81. package/esm/typings/src/types/PipelineJson/KnowledgeSourceJson.d.ts +1 -1
  82. package/esm/typings/src/types/PipelineJson/PersonaJson.d.ts +1 -1
  83. package/esm/typings/src/types/PipelineJson/TemplateJsonCommon.d.ts +2 -2
  84. package/esm/typings/src/types/Prompt.d.ts +1 -1
  85. package/esm/typings/src/types/execution-report/ExecutionReportJson.d.ts +1 -1
  86. package/esm/typings/src/utils/$Register.d.ts +1 -1
  87. package/esm/typings/src/utils/FromtoItems.d.ts +1 -1
  88. package/esm/typings/src/utils/arrayableToArray.d.ts +1 -1
  89. package/esm/typings/src/utils/emojis.d.ts +1 -1
  90. package/esm/typings/src/utils/execCommand/$execCommand.d.ts +2 -2
  91. package/esm/typings/src/utils/execCommand/{IExecCommandOptions.d.ts → ExecCommandOptions.d.ts} +2 -6
  92. package/esm/typings/src/utils/execCommand/execCommandNormalizeOptions.d.ts +3 -3
  93. package/esm/typings/src/utils/expectation-counters/countSentences.d.ts +1 -1
  94. package/esm/typings/src/utils/files/isExecutable.d.ts +11 -0
  95. package/esm/typings/src/utils/markdown/extractAllBlocksFromMarkdown.d.ts +1 -1
  96. package/esm/typings/src/utils/markdown/splitMarkdownIntoSections.d.ts +1 -1
  97. package/esm/typings/src/utils/normalization/IKeywords.d.ts +2 -2
  98. package/esm/typings/src/utils/normalization/parseKeywords.d.ts +2 -2
  99. package/esm/typings/src/utils/normalization/parseKeywordsFromString.d.ts +2 -2
  100. package/esm/typings/src/utils/normalization/searchKeywords.d.ts +2 -2
  101. package/esm/typings/src/utils/organization/TODO_USE.d.ts +1 -1
  102. package/esm/typings/src/utils/organization/keepUnused.d.ts +1 -1
  103. package/esm/typings/src/utils/random/$randomSeed.d.ts +1 -1
  104. package/esm/typings/src/utils/sets/intersection.d.ts +1 -1
  105. package/esm/typings/src/utils/sets/union.d.ts +1 -1
  106. package/esm/typings/src/utils/unwrapResult.d.ts +4 -4
  107. package/package.json +4 -3
  108. package/umd/index.umd.js +136 -136
  109. package/umd/index.umd.js.map +1 -1
  110. package/esm/typings/src/_packages/website-crawler.index.d.ts +0 -8
  111. package/esm/typings/src/execution/createPipelineExecutor/00-CreatePipelineExecutorSettings.d.ts +0 -29
  112. package/esm/typings/src/scrapers/website/WebsiteScraper.d.ts +0 -47
  113. package/esm/typings/src/scrapers/website/createWebsiteScraper.d.ts +0 -20
  114. package/esm/typings/src/scrapers/website/playground/website-scraper-playground.d.ts +0 -5
  115. package/esm/typings/src/scrapers/website/register-constructor.d.ts +0 -13
  116. package/esm/typings/src/scrapers/website/register-metadata.d.ts +0 -24
  117. package/esm/typings/src/scrapers/website/utils/markdownConverter.d.ts +0 -12
  118. /package/esm/typings/src/{scrapers/website/WebsiteScraper.test.d.ts → executables/apps/locateLibreoffice.test.d.ts} +0 -0
  119. /package/esm/typings/src/{scrapers/website/utils/markdownConverter.test.d.ts → executables/apps/locatePandoc.test.d.ts} +0 -0
@@ -13,7 +13,7 @@ type GetScraperIntermediateSourceSource = Pick<ScraperSourceHandler, 'filename'
13
13
  *
14
14
  * @private internal utility of `getScraperIntermediateSource`
15
15
  */
16
- type GetScraperIntermediateSourceHandler = Required<Pick<PrepareAndScrapeOptions, 'rootDirname' | 'cacheDirname' | 'isCacheCleaned' | 'isVerbose'>> & {
16
+ type GetScraperIntermediateSourceHandler = Required<Pick<PrepareAndScrapeOptions, 'rootDirname' | 'cacheDirname' | 'intermediateFilesStrategy' | 'isVerbose'>> & {
17
17
  readonly extension: string_file_extension;
18
18
  };
19
19
  /**
@@ -28,7 +28,7 @@ export {};
28
28
  /**
29
29
  * Note: Not using `FileCacheStorage` for two reasons:
30
30
  * 1) Need to store more than serialized JSONs
31
- * 2) Need to switch between a `rootDirname` and `cacheDirname` <- TODO: !!!!
31
+ * 2) Need to switch between a `rootDirname` and `cacheDirname` <- TODO: [😡]
32
32
  * TODO: [🐱‍🐉][🧠] Make some smart crop
33
33
  * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
34
34
  */
@@ -23,7 +23,7 @@ export declare class DocumentScraper implements Converter, Scraper {
23
23
  * Markdown scraper is used internally
24
24
  */
25
25
  private readonly markdownScraper;
26
- constructor(tools: Pick<ExecutionTools, 'fs' | 'llm'>, options: PrepareAndScrapeOptions);
26
+ constructor(tools: Pick<ExecutionTools, 'fs' | 'llm' | 'executables'>, options: PrepareAndScrapeOptions);
27
27
  /**
28
28
  * Convert the `.docx` or `.odt` to `.md` file and returns intermediate source
29
29
  *
@@ -33,7 +33,7 @@ export declare class DocumentScraper implements Converter, Scraper {
33
33
  /**
34
34
  * Scrapes the docx file and returns the knowledge pieces or `null` if it can't scrape it
35
35
  */
36
- scrape(source: ScraperSourceHandler): Promise<Array<Omit<KnowledgePiecePreparedJson, 'sources' | 'preparationIds'>> | null>;
36
+ scrape(source: ScraperSourceHandler): Promise<ReadonlyArray<Omit<KnowledgePiecePreparedJson, 'sources' | 'preparationIds'>> | null>;
37
37
  }
38
38
  /**
39
39
  * TODO: [👣] Converted documents can act as cached items - there is no need to run conversion each time
@@ -13,7 +13,7 @@ export declare const createDocumentScraper: ((tools: Pick<ExecutionTools, 'llm'>
13
13
  mimeTypes: string[];
14
14
  documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
15
15
  isAvilableInBrowser: false;
16
- requiredExecutables: string[];
16
+ requiredExecutables: "Pandoc"[];
17
17
  }>;
18
18
  /**
19
19
  * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
@@ -11,7 +11,7 @@ export declare const documentScraperMetadata: import("type-fest/source/readonly-
11
11
  mimeTypes: string[];
12
12
  documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
13
13
  isAvilableInBrowser: false;
14
- requiredExecutables: string[];
14
+ requiredExecutables: "Pandoc"[];
15
15
  }>;
16
16
  /**
17
17
  * Registration of known scraper metadata
@@ -7,7 +7,7 @@ import type { Scraper } from '../_common/Scraper';
7
7
  import type { ScraperSourceHandler } from '../_common/Scraper';
8
8
  import type { ScraperIntermediateSource } from '../_common/ScraperIntermediateSource';
9
9
  /**
10
- * Scraper for .docx files
10
+ * Scraper for old document files (like .doc and .rtf)
11
11
  *
12
12
  * @see `documentationUrl` for more details
13
13
  * @public exported from `@promptbook/legacy-documents`
@@ -23,7 +23,7 @@ export declare class LegacyDocumentScraper implements Converter, Scraper {
23
23
  * Document scraper is used internally
24
24
  */
25
25
  private readonly documentScraper;
26
- constructor(tools: Pick<ExecutionTools, 'fs' | 'llm'>, options: PrepareAndScrapeOptions);
26
+ constructor(tools: Pick<ExecutionTools, 'fs' | 'llm' | 'executables'>, options: PrepareAndScrapeOptions);
27
27
  /**
28
28
  * Convert the `.doc` or `.rtf` to `.doc` file and returns intermediate source
29
29
  *
@@ -33,7 +33,7 @@ export declare class LegacyDocumentScraper implements Converter, Scraper {
33
33
  /**
34
34
  * Scrapes the `.doc` or `.rtf` file and returns the knowledge pieces or `null` if it can't scrape it
35
35
  */
36
- scrape(source: ScraperSourceHandler): Promise<Array<Omit<KnowledgePiecePreparedJson, 'sources' | 'preparationIds'>> | null>;
36
+ scrape(source: ScraperSourceHandler): Promise<ReadonlyArray<Omit<KnowledgePiecePreparedJson, 'sources' | 'preparationIds'>> | null>;
37
37
  }
38
38
  /**
39
39
  * TODO: [👣] Converted documents can act as cached items - there is no need to run conversion each time
@@ -13,7 +13,7 @@ export declare const createLegacyDocumentScraper: ((tools: Pick<ExecutionTools,
13
13
  mimeTypes: string[];
14
14
  documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
15
15
  isAvilableInBrowser: false;
16
- requiredExecutables: string[];
16
+ requiredExecutables: ("Pandoc" | "LibreOffice")[];
17
17
  }>;
18
18
  /**
19
19
  * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
@@ -11,7 +11,7 @@ export declare const legacyDocumentScraperMetadata: import("type-fest/source/rea
11
11
  mimeTypes: string[];
12
12
  documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
13
13
  isAvilableInBrowser: false;
14
- requiredExecutables: string[];
14
+ requiredExecutables: ("Pandoc" | "LibreOffice")[];
15
15
  }>;
16
16
  /**
17
17
  * Registration of known scraper metadata
@@ -21,7 +21,7 @@ export declare class MarkdownScraper implements Scraper {
21
21
  /**
22
22
  * Scrapes the markdown file and returns the knowledge pieces or `null` if it can't scrape it
23
23
  */
24
- scrape(source: ScraperSourceHandler): Promise<Array<Omit<KnowledgePiecePreparedJson, 'sources' | 'preparationIds'>> | null>;
24
+ scrape(source: ScraperSourceHandler): Promise<ReadonlyArray<Omit<KnowledgePiecePreparedJson, 'sources' | 'preparationIds'>> | null>;
25
25
  }
26
26
  /**
27
27
  * TODO: [🪂] Do it in parallel 11:11
@@ -13,7 +13,7 @@ export declare const createMarkdownScraper: ((tools: Pick<ExecutionTools, 'llm'>
13
13
  mimeTypes: string[];
14
14
  documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
15
15
  isAvilableInBrowser: true;
16
- requiredExecutables: string[];
16
+ requiredExecutables: never[];
17
17
  }>;
18
18
  /**
19
19
  * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
@@ -11,7 +11,7 @@ export declare const markdownScraperMetadata: import("type-fest/source/readonly-
11
11
  mimeTypes: string[];
12
12
  documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
13
13
  isAvilableInBrowser: true;
14
- requiredExecutables: string[];
14
+ requiredExecutables: never[];
15
15
  }>;
16
16
  /**
17
17
  * Registration of known scraper metadata
@@ -7,7 +7,7 @@ import type { Converter } from '../_common/Converter';
7
7
  import type { ScraperAndConverterMetadata } from '../_common/register/ScraperAndConverterMetadata';
8
8
  import type { ScraperIntermediateSource } from '../_common/ScraperIntermediateSource';
9
9
  /**
10
- * Scraper for .docx files
10
+ * Scraper for .pdf files
11
11
  *
12
12
  * @see `documentationUrl` for more details
13
13
  * @public exported from `@promptbook/pdf`
@@ -31,7 +31,7 @@ export declare class PdfScraper implements Converter, Scraper {
31
31
  /**
32
32
  * Scrapes the `.pdf` file and returns the knowledge pieces or `null` if it can't scrape it
33
33
  */
34
- scrape(source: ScraperSourceHandler): Promise<Array<Omit<KnowledgePiecePreparedJson, 'sources' | 'preparationIds'>> | null>;
34
+ scrape(source: ScraperSourceHandler): Promise<ReadonlyArray<Omit<KnowledgePiecePreparedJson, 'sources' | 'preparationIds'>> | null>;
35
35
  }
36
36
  /**
37
37
  * TODO: [👣] Converted pdf documents can act as cached items - there is no need to run conversion each time
@@ -13,7 +13,7 @@ export declare const createPdfScraper: ((tools: Pick<ExecutionTools, 'llm'>, opt
13
13
  mimeTypes: string[];
14
14
  documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
15
15
  isAvilableInBrowser: true;
16
- requiredExecutables: string[];
16
+ requiredExecutables: never[];
17
17
  }>;
18
18
  /**
19
19
  * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
@@ -11,7 +11,7 @@ export declare const pdfScraperMetadata: import("type-fest/source/readonly-deep"
11
11
  mimeTypes: string[];
12
12
  documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
13
13
  isAvilableInBrowser: true;
14
- requiredExecutables: string[];
14
+ requiredExecutables: never[];
15
15
  }>;
16
16
  /**
17
17
  * Registration of known scraper metadata
@@ -7,7 +7,7 @@ import type { really_any } from '../../../utils/organization/really_any';
7
7
  * @returns nothing
8
8
  * @private internal function of `JavascriptExecutionTools` and `JavascriptEvalExecutionTools`
9
9
  */
10
- export declare function preserve(func: (...params: Array<really_any>) => unknown): void;
10
+ export declare function preserve(func: (...params: ReadonlyArray<really_any>) => unknown): void;
11
11
  /**
12
12
  * TODO: !! [1] This maybe does memory leak
13
13
  */
@@ -4,4 +4,4 @@ import type { string_name } from '../../../types/typeAliases';
4
4
  *
5
5
  * @private for `FileCacheStorage`
6
6
  */
7
- export declare function nameToSubfolderPath(name: string_name): Array<string>;
7
+ export declare function nameToSubfolderPath(name: string_name): ReadonlyArray<string>;
@@ -7,4 +7,4 @@
7
7
  *
8
8
  * @private internal type
9
9
  */
10
- export type Arrayable<TItem> = TItem | Array<TItem> | undefined;
10
+ export type Arrayable<TItem> = TItem | ReadonlyArray<TItem> | undefined;
@@ -0,0 +1,7 @@
1
+ /**
2
+ * @@@
3
+ */
4
+ export type IntermediateFilesStrategy = 'HIDE_AND_CLEAN' | 'HIDE_AND_KEEP';
5
+ /**
6
+ * TODO: [🎅] Maube add options for all kinds of cache, unite with `isCacheReloaded` and make `cacheStrategy` (which is not specific only for intermediate files)
7
+ */
@@ -31,7 +31,7 @@ export type KnowledgePiecePreparedJson = {
31
31
  /**
32
32
  * List of sources where the information comes from
33
33
  */
34
- readonly sources: Array<{
34
+ readonly sources: ReadonlyArray<{
35
35
  /**
36
36
  * Identifier of the source
37
37
  */
@@ -48,11 +48,11 @@ export type KnowledgePiecePreparedJson = {
48
48
  /**
49
49
  * List of keywords that are associated with the knowledge piece
50
50
  */
51
- readonly keywords: Array<string_keyword>;
51
+ readonly keywords: ReadonlyArray<string_keyword>;
52
52
  /**
53
53
  * List of models embeddings that are associated with the knowledge piece
54
54
  */
55
- readonly index: Array<{
55
+ readonly index: ReadonlyArray<{
56
56
  /**
57
57
  * Model name which generated the embedding
58
58
  */
@@ -65,7 +65,7 @@ export type KnowledgePiecePreparedJson = {
65
65
  /**
66
66
  * List of preparation ids that were used to prepare this knowledge piece
67
67
  */
68
- readonly preparationIds: Array<number_id>;
68
+ readonly preparationIds: ReadonlyArray<number_id>;
69
69
  };
70
70
  /**
71
71
  * TODO: [🍙] Make some standard order of json properties
@@ -37,7 +37,7 @@ export type KnowledgeSourcePreparedJson = KnowledgeSourceJson & {
37
37
  /**
38
38
  * List of preparation ids that were used to prepare this knowledge source to knowledge pieces
39
39
  */
40
- readonly preparationIds: Array<number_id>;
40
+ readonly preparationIds: ReadonlyArray<number_id>;
41
41
  };
42
42
  /**
43
43
  * TODO: [🍙] Make some standard order of json properties
@@ -38,7 +38,7 @@ export type PersonaPreparedJson = PersonaJson & {
38
38
  /**
39
39
  * List of preparation ids that were used to prepare this persona
40
40
  */
41
- readonly preparationIds: Array<number_id>;
41
+ readonly preparationIds: ReadonlyArray<number_id>;
42
42
  };
43
43
  /**
44
44
  * TODO: [🍙] Make some standard order of json properties
@@ -13,7 +13,7 @@ import type { Expectations } from './Expectations';
13
13
  /**
14
14
  * Common properties of all templates
15
15
  */
16
- export interface TemplateJsonCommon {
16
+ export type TemplateJsonCommon = {
17
17
  /**
18
18
  * Name of the template
19
19
  * - It must be unique across the pipeline
@@ -93,7 +93,7 @@ export interface TemplateJsonCommon {
93
93
  * Name of the parameter that is the result of the template
94
94
  */
95
95
  readonly resultingParameterName: string_name;
96
- }
96
+ };
97
97
  /**
98
98
  * TODO: use one helper type> (string_prompt | string_javascript | string_markdown) & string_template
99
99
  * TODO: [♈] Probbably move expectations from templates to parameters
@@ -77,7 +77,7 @@ export type CommonPrompt = {
77
77
  /**
78
78
  * List of postprocessing steps that are executed after the prompt
79
79
  */
80
- readonly postprocessingFunctionNames?: Array<string_postprocessing_function_name>;
80
+ readonly postprocessingFunctionNames?: ReadonlyArray<string_postprocessing_function_name>;
81
81
  /**
82
82
  * Expectations for the answer
83
83
  *
@@ -37,5 +37,5 @@ export type ExecutionReportJson = {
37
37
  /**
38
38
  * Sequence of templates in order which were executed
39
39
  */
40
- readonly promptExecutions: Array<ExecutionPromptReportJson>;
40
+ readonly promptExecutions: ReadonlyArray<ExecutionPromptReportJson>;
41
41
  };
@@ -34,6 +34,6 @@ export declare class $Register<TRegistered extends Registered> {
34
34
  private readonly registerName;
35
35
  private readonly storage;
36
36
  constructor(registerName: string_name);
37
- list(): Array<TRegistered>;
37
+ list(): ReadonlyArray<TRegistered>;
38
38
  register(registered: TRegistered): Registration;
39
39
  }
@@ -1,7 +1,7 @@
1
1
  /**
2
2
  * Represents items which are compared to each other
3
3
  */
4
- export type FromtoItems = Array<{
4
+ export type FromtoItems = ReadonlyArray<{
5
5
  /**
6
6
  * The title of the item
7
7
  */
@@ -8,4 +8,4 @@ import type { Arrayable } from '../types/Arrayable';
8
8
  *
9
9
  * @private internal utility
10
10
  */
11
- export declare function arrayableToArray<TItem>(input?: Arrayable<TItem>): Array<TItem>;
11
+ export declare function arrayableToArray<TItem>(input?: Arrayable<TItem>): ReadonlyArray<TItem>;
@@ -8,7 +8,7 @@ import type { string_char_emoji } from '../types/typeAliasEmoji';
8
8
  * @private within the repository
9
9
  * @deprecated Use /\p{Extended_Pictographic}/ instead
10
10
  */
11
- export declare const EMOJIS_IN_CATEGORIES: Record<string, Array<string_char_emoji>>;
11
+ export declare const EMOJIS_IN_CATEGORIES: Record<string, ReadonlyArray<string_char_emoji>>;
12
12
  /**
13
13
  *
14
14
  * All possible emoji chars like "🍆", "🍡", "🍤"...
@@ -1,4 +1,4 @@
1
- import type { IExecCommandOptions } from './IExecCommandOptions';
1
+ import type { ExecCommandOptions } from './ExecCommandOptions';
2
2
  /**
3
3
  * Run one command in a shell
4
4
  *
@@ -8,7 +8,7 @@ import type { IExecCommandOptions } from './IExecCommandOptions';
8
8
  *
9
9
  * @public exported from `@promptbook/node`
10
10
  */
11
- export declare function $execCommand(options: IExecCommandOptions): Promise<string>;
11
+ export declare function $execCommand(options: ExecCommandOptions): Promise<string>;
12
12
  /**
13
13
  * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
14
14
  */
@@ -4,16 +4,12 @@
4
4
  type RequiredAndOptional<TBase, TRequired extends keyof TBase, TOptional extends keyof TBase> = Pick<TBase, TRequired> & Partial<Pick<TBase, TOptional>>;
5
5
  /**
6
6
  * Simple options for `execCommand`
7
- *
8
- * TODO: !!!!!! Rename - remove I prefix
9
7
  */
10
- export type IExecCommandOptions = string | RequiredAndOptional<IExecCommandOptionsAdvanced, 'command', 'args' | 'cwd' | 'crashOnError' | 'timeout'>;
8
+ export type ExecCommandOptions = string | RequiredAndOptional<ExecCommandOptionsAdvanced, 'command', 'args' | 'cwd' | 'crashOnError' | 'timeout'>;
11
9
  /**
12
10
  * Advanced options for `execCommand`
13
- *
14
- * TODO: !!!!!! Rename - remove I prefix
15
11
  */
16
- export type IExecCommandOptionsAdvanced = {
12
+ export type ExecCommandOptionsAdvanced = {
17
13
  readonly command: string;
18
14
  readonly args: string[];
19
15
  readonly cwd: string;
@@ -1,10 +1,10 @@
1
- import type { IExecCommandOptions } from './IExecCommandOptions';
2
- import type { IExecCommandOptionsAdvanced } from './IExecCommandOptions';
1
+ import type { ExecCommandOptions } from './ExecCommandOptions';
2
+ import type { ExecCommandOptionsAdvanced } from './ExecCommandOptions';
3
3
  /**
4
4
  * Normalize options for `execCommand` and `execCommands`
5
5
  *
6
6
  * @private internal utility of `execCommand` and `execCommands`
7
7
  */
8
- export declare function execCommandNormalizeOptions(options: IExecCommandOptions): Pick<IExecCommandOptionsAdvanced, 'command' | 'args' | 'cwd' | 'crashOnError' | 'timeout'> & {
8
+ export declare function execCommandNormalizeOptions(options: ExecCommandOptions): Pick<ExecCommandOptionsAdvanced, 'command' | 'args' | 'cwd' | 'crashOnError' | 'timeout'> & {
9
9
  humanReadableCommand: string;
10
10
  };
@@ -4,7 +4,7 @@ import type { ExpectationAmount } from '../../types/PipelineJson/Expectations';
4
4
  *
5
5
  * @public exported from `@promptbook/utils`
6
6
  */
7
- export declare function splitIntoSentences(text: string): Array<string>;
7
+ export declare function splitIntoSentences(text: string): ReadonlyArray<string>;
8
8
  /**
9
9
  * Counts number of sentences in the text
10
10
  *
@@ -0,0 +1,11 @@
1
+ import type { FilesystemTools } from '../../execution/FilesystemTools';
2
+ /**
3
+ * Checks if the file is executable
4
+ *
5
+ * @private within the repository
6
+ */
7
+ export declare function isExecutable(path: string, fs: FilesystemTools): Promise<boolean>;
8
+ /**
9
+ * Note: Not [~🟢~] because it is not directly dependent on `fs
10
+ * TODO: [🖇] What about symlinks?
11
+ */
@@ -30,7 +30,7 @@ export type CodeBlock = {
30
30
  * @throws {ParseError} if block is not closed properly
31
31
  * @public exported from `@promptbook/markdown-utils`
32
32
  */
33
- export declare function extractAllBlocksFromMarkdown(markdown: string_markdown): Array<CodeBlock>;
33
+ export declare function extractAllBlocksFromMarkdown(markdown: string_markdown): ReadonlyArray<CodeBlock>;
34
34
  /**
35
35
  * TODO: Maybe name for `blockNotation` instead of '```' and '>'
36
36
  */
@@ -5,7 +5,7 @@ import type { string_markdown_section } from '../../types/typeAliases';
5
5
  *
6
6
  * @public exported from `@promptbook/markdown-utils`
7
7
  */
8
- export declare function splitMarkdownIntoSections(markdown: string_markdown): Array<string_markdown_section>;
8
+ export declare function splitMarkdownIntoSections(markdown: string_markdown): ReadonlyArray<string_markdown_section>;
9
9
  /**
10
10
  * TODO: [🏛] This can be part of markdown builder
11
11
  * Note: [🕞] In past (commit 42086e1603cbed506482997c00a8ee979af0a247) there was much more
@@ -2,7 +2,7 @@
2
2
  * Semantic helper
3
3
  *
4
4
  * Keyword is string without diacritics in lowercase [a-z1-9]
5
- * Words are splitted between multiple keywords @see IKeywords
5
+ * Words are splitted between multiple keywords @see Keywords
6
6
  *
7
7
  * For example `"keyword"`
8
8
  *
@@ -15,7 +15,7 @@ export type string_keyword = string;
15
15
  *
16
16
  * @public exported from `@promptbook/utils`
17
17
  */
18
- export type IKeywords = Set<string_keyword>;
18
+ export type Keywords = Set<string_keyword>;
19
19
  /**
20
20
  * TODO: [🌮] Keywords with weight
21
21
  */
@@ -1,5 +1,5 @@
1
1
  import type { really_unknown } from '../organization/really_unknown';
2
- import type { IKeywords } from './IKeywords';
2
+ import type { Keywords } from './IKeywords';
3
3
  /**
4
4
  * Parses keywords from any object and recursively walks through
5
5
  *
@@ -9,7 +9,7 @@ import type { IKeywords } from './IKeywords';
9
9
  * @returns {Set} of keywords without diacritics in lowercase
10
10
  * @public exported from `@promptbook/utils`
11
11
  */
12
- export declare function parseKeywords(input: really_unknown): IKeywords;
12
+ export declare function parseKeywords(input: really_unknown): Keywords;
13
13
  /**
14
14
  * Note: Not using spread in input param because of keeping second parameter for options
15
15
  * TODO: [🌺] Use some intermediate util splitWords
@@ -1,4 +1,4 @@
1
- import type { IKeywords } from './IKeywords';
1
+ import type { Keywords } from './IKeywords';
2
2
  /**
3
3
  * Parses keywords from a string
4
4
  *
@@ -6,4 +6,4 @@ import type { IKeywords } from './IKeywords';
6
6
  * @returns {Set} of keywords without diacritics in lowercase
7
7
  * @public exported from `@promptbook/utils`
8
8
  */
9
- export declare function parseKeywordsFromString(input: string): IKeywords;
9
+ export declare function parseKeywordsFromString(input: string): Keywords;
@@ -1,4 +1,4 @@
1
- import type { IKeywords } from './IKeywords';
1
+ import type { Keywords } from './IKeywords';
2
2
  /**
3
3
  * @@@
4
4
  *
@@ -7,4 +7,4 @@ import type { IKeywords } from './IKeywords';
7
7
  * @returns
8
8
  * @public exported from `@promptbook/utils`
9
9
  */
10
- export declare function searchKeywords(haystack: IKeywords, needle: IKeywords): boolean;
10
+ export declare function searchKeywords(haystack: Keywords, needle: Keywords): boolean;
@@ -9,4 +9,4 @@ import type { really_any } from './really_any';
9
9
  * @returns void
10
10
  * @private within the repository
11
11
  */
12
- export declare function TODO_USE(...value: Array<really_any>): void;
12
+ export declare function TODO_USE(...value: ReadonlyArray<really_any>): void;
@@ -13,4 +13,4 @@ import type { really_any } from './really_any';
13
13
  * @returns void
14
14
  * @private within the repository
15
15
  */
16
- export declare function keepUnused<TTypeToKeep1 = really_any, TTypeToKeep2 = really_any, TTypeToKeep3 = really_any>(...valuesToKeep: Array<really_any>): void;
16
+ export declare function keepUnused<TTypeToKeep1 = really_any, TTypeToKeep2 = really_any, TTypeToKeep3 = really_any>(...valuesToKeep: ReadonlyArray<really_any>): void;
@@ -3,7 +3,7 @@ import type { number_seed } from '../../types/typeAliases';
3
3
  * Generates random seed
4
4
  *
5
5
  * Note: `$` is used to indicate that this function is not a pure function - it is not deterministic
6
- * Warning: This function is not cryptographically secure (it uses Math.random internally)
6
+ * Warning: This function is NOT cryptographically secure (it uses Math.random internally)
7
7
  * @public exported from `@promptbook/utils`
8
8
  */
9
9
  export declare function $randomSeed(): number_seed;
@@ -4,4 +4,4 @@
4
4
  * @deprecated use new javascript set methods instead @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set
5
5
  * @public exported from `@promptbook/utils`
6
6
  */
7
- export declare function intersection<TItem>(...sets: Array<Set<TItem>>): Set<TItem>;
7
+ export declare function intersection<TItem>(...sets: ReadonlyArray<Set<TItem>>): Set<TItem>;
@@ -4,4 +4,4 @@
4
4
  * @deprecated use new javascript set methods instead @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set
5
5
  * @public exported from `@promptbook/utils`
6
6
  */
7
- export declare function union<TItem>(...sets: Array<Set<TItem>>): Set<TItem>;
7
+ export declare function union<TItem>(...sets: ReadonlyArray<Set<TItem>>): Set<TItem>;
@@ -1,11 +1,11 @@
1
1
  /**
2
2
  * Additional options for `unwrapResult`
3
3
  */
4
- interface UnwrapResultOptions {
4
+ type UnwrapResultOptions = {
5
5
  /**
6
6
  * If true, the text is trimmed before processing
7
7
  */
8
- isTrimmed?: boolean;
8
+ readonly isTrimmed?: boolean;
9
9
  /**
10
10
  * If true, the introduce sentence is removed
11
11
  *
@@ -15,8 +15,8 @@ interface UnwrapResultOptions {
15
15
  *
16
16
  * @default true
17
17
  */
18
- isIntroduceSentenceRemoved?: boolean;
19
- }
18
+ readonly isIntroduceSentenceRemoved?: boolean;
19
+ };
20
20
  /**
21
21
  * Removes quotes and optional introduce text from a string
22
22
  *
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@promptbook/legacy-documents",
3
- "version": "0.72.0-14",
3
+ "version": "0.72.0-23",
4
4
  "description": "Supercharge your use of large language models",
5
5
  "private": false,
6
6
  "sideEffects": false,
@@ -11,6 +11,7 @@
11
11
  "contributors": [
12
12
  "Pavol Hejný <me@pavolhejny.com> (https://www.pavolhejny.com/)"
13
13
  ],
14
+ "todo-0": "TODO: [❇️] Make better list of keywords",
14
15
  "keywords": [
15
16
  "ai",
16
17
  "llm",
@@ -51,14 +52,14 @@
51
52
  "module": "./esm/index.es.js",
52
53
  "typings": "./esm/typings/src/_packages/legacy-documents.index.d.ts",
53
54
  "peerDependencies": {
54
- "@promptbook/core": "0.72.0-14"
55
+ "@promptbook/core": "0.72.0-23"
55
56
  },
56
57
  "dependencies": {
57
58
  "colors": "1.4.0",
58
59
  "crypto-js": "4.2.0",
59
60
  "papaparse": "5.4.1",
60
61
  "prettier": "2.8.1",
61
- "spacetrim": "0.11.39",
62
+ "spacetrim": "0.11.59",
62
63
  "waitasecond": "1.11.83"
63
64
  }
64
65
  }