@promptbook/browser 0.72.0-2 → 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.
- package/README.md +11 -1
- package/esm/index.es.js +247 -6
- package/esm/index.es.js.map +1 -1
- package/esm/typings/src/_packages/browser.index.d.ts +3 -1
- package/esm/typings/src/_packages/cli.index.d.ts +16 -0
- package/esm/typings/src/_packages/core.index.d.ts +54 -28
- package/esm/typings/src/_packages/documents.index.d.ts +8 -0
- package/esm/typings/src/_packages/legacy-documents.index.d.ts +8 -0
- package/esm/typings/src/_packages/markdown-utils.index.d.ts +6 -0
- package/esm/typings/src/_packages/node.index.d.ts +18 -6
- package/esm/typings/src/_packages/pdf.index.d.ts +8 -0
- package/esm/typings/src/_packages/types.index.d.ts +57 -33
- package/esm/typings/src/_packages/utils.index.d.ts +2 -2
- package/esm/typings/src/cli/cli-commands/about.d.ts +1 -1
- package/esm/typings/src/cli/cli-commands/hello.d.ts +2 -1
- package/esm/typings/src/cli/cli-commands/make.d.ts +1 -1
- package/esm/typings/src/cli/cli-commands/prettify.d.ts +2 -1
- package/esm/typings/src/cli/cli-commands/test-command.d.ts +13 -0
- package/esm/typings/src/cli/main.d.ts +1 -1
- package/esm/typings/src/cli/promptbookCli.d.ts +1 -1
- package/esm/typings/src/collection/PipelineCollection.d.ts +1 -1
- package/esm/typings/src/collection/SimplePipelineCollection.d.ts +2 -2
- package/esm/typings/src/collection/collectionToJson.d.ts +1 -1
- package/esm/typings/src/collection/constructors/createCollectionFromDirectory.d.ts +11 -6
- package/esm/typings/src/collection/constructors/createCollectionFromJson.d.ts +1 -1
- package/esm/typings/src/collection/constructors/createCollectionFromPromise.d.ts +1 -1
- package/esm/typings/src/collection/constructors/createCollectionFromUrl.d.ts +1 -1
- package/esm/typings/src/commands/EXPECT/expectCommandParser.d.ts +1 -1
- package/esm/typings/src/commands/FOREACH/ForeachJson.d.ts +5 -1
- package/esm/typings/src/commands/FOREACH/foreachCommandParser.d.ts +1 -1
- package/esm/typings/src/commands/FORMAT/formatCommandParser.d.ts +1 -1
- package/esm/typings/src/commands/JOKER/jokerCommandParser.d.ts +1 -1
- package/esm/typings/src/commands/KNOWLEDGE/knowledgeCommandParser.d.ts +1 -1
- package/esm/typings/src/commands/KNOWLEDGE/utils/sourceContentToName.d.ts +11 -0
- package/esm/typings/src/commands/KNOWLEDGE/utils/sourceContentToName.test.d.ts +4 -0
- package/esm/typings/src/commands/MODEL/modelCommandParser.d.ts +1 -1
- package/esm/typings/src/commands/PARAMETER/parameterCommandParser.d.ts +1 -1
- package/esm/typings/src/commands/PERSONA/personaCommandParser.d.ts +1 -1
- package/esm/typings/src/commands/POSTPROCESS/postprocessCommandParser.d.ts +1 -1
- package/esm/typings/src/commands/PROMPTBOOK_VERSION/promptbookVersionCommandParser.d.ts +1 -1
- package/esm/typings/src/commands/TEMPLATE/templateCommandParser.d.ts +1 -1
- package/esm/typings/src/commands/URL/urlCommandParser.d.ts +1 -1
- package/esm/typings/src/commands/X_ACTION/actionCommandParser.d.ts +1 -1
- package/esm/typings/src/commands/X_INSTRUMENT/instrumentCommandParser.d.ts +1 -1
- package/esm/typings/src/commands/_BOILERPLATE/boilerplateCommandParser.d.ts +1 -1
- package/esm/typings/src/commands/_common/types/CommandParser.d.ts +5 -5
- package/esm/typings/src/config.d.ts +35 -12
- package/esm/typings/src/conversion/pipelineStringToJson.d.ts +4 -15
- package/esm/typings/src/conversion/pipelineStringToJsonSync.d.ts +1 -1
- package/esm/typings/src/conversion/validation/_importPipeline.d.ts +1 -1
- package/esm/typings/src/conversion/validation/validatePipeline.d.ts +5 -5
- package/esm/typings/src/{knowledge/dialogs → dialogs}/callback/CallbackInterfaceTools.d.ts +2 -2
- package/esm/typings/src/{knowledge/dialogs → dialogs}/callback/CallbackInterfaceToolsOptions.d.ts +3 -3
- package/esm/typings/src/{knowledge/dialogs → dialogs}/simple-prompt/SimplePromptInterfaceTools.d.ts +6 -6
- package/esm/typings/src/errors/AbstractFormatError.d.ts +11 -0
- package/esm/typings/src/errors/KnowledgeScrapeError.d.ts +9 -0
- package/esm/typings/src/errors/MissingToolsError.d.ts +9 -0
- package/esm/typings/src/executables/$provideExecutablesForNode.d.ts +12 -0
- package/esm/typings/src/executables/apps/locateLibreoffice.d.ts +11 -0
- package/esm/typings/src/executables/apps/locatePandoc.d.ts +11 -0
- package/esm/typings/src/executables/locateApp.d.ts +33 -0
- package/esm/typings/src/executables/platforms/locateAppOnLinux.d.ts +12 -0
- package/esm/typings/src/executables/platforms/locateAppOnMacOs.d.ts +12 -0
- package/esm/typings/src/executables/platforms/locateAppOnWindows.d.ts +12 -0
- package/esm/typings/src/execution/{CommonExecutionToolsOptions.d.ts → CommonToolsOptions.d.ts} +1 -1
- package/esm/typings/src/execution/EmbeddingVector.d.ts +1 -1
- package/esm/typings/src/execution/Executables.d.ts +18 -0
- package/esm/typings/src/execution/ExecutionTools.d.ts +35 -9
- package/esm/typings/src/execution/FilesystemTools.d.ts +9 -0
- package/esm/typings/src/execution/LlmExecutionTools.d.ts +2 -2
- package/esm/typings/src/execution/PipelineExecutor.d.ts +1 -0
- package/esm/typings/src/execution/PipelineExecutorResult.d.ts +2 -2
- package/esm/typings/src/execution/assertsExecutionSuccessful.d.ts +3 -2
- package/esm/typings/src/execution/createPipelineExecutor/00-CreatePipelineExecutorOptions.d.ts +31 -5
- package/esm/typings/src/execution/createPipelineExecutor/00-createPipelineExecutor.d.ts +3 -0
- package/esm/typings/src/execution/createPipelineExecutor/10-executePipeline.d.ts +6 -12
- package/esm/typings/src/execution/createPipelineExecutor/20-executeTemplate.d.ts +7 -18
- package/esm/typings/src/execution/createPipelineExecutor/{30-executeFormatCells.d.ts → 30-executeFormatSubvalues.d.ts} +2 -6
- package/esm/typings/src/execution/createPipelineExecutor/40-executeAttempts.d.ts +9 -19
- package/esm/typings/src/execution/embeddingVectorToString.d.ts +1 -1
- package/esm/typings/src/execution/translation/automatic-translate/automatic-translators/LindatAutomaticTranslator.d.ts +11 -3
- package/esm/typings/src/execution/translation/automatic-translate/translateMessages.d.ts +4 -0
- package/esm/typings/src/execution/utils/$provideExecutionToolsForNode.d.ts +13 -0
- package/esm/typings/src/execution/utils/addUsage.d.ts +1 -1
- package/esm/typings/src/execution/utils/forEachAsync.d.ts +2 -1
- package/esm/typings/src/formats/_common/FormatDefinition.d.ts +2 -2
- package/esm/typings/src/formats/_common/FormatSubvalueDefinition.d.ts +3 -2
- package/esm/typings/src/formats/csv/CsvFormatError.d.ts +10 -0
- package/esm/typings/src/llm-providers/_common/{$llmToolsMetadataRegister.d.ts → register/$llmToolsMetadataRegister.d.ts} +4 -1
- package/esm/typings/src/llm-providers/_common/{$llmToolsRegister.d.ts → register/$llmToolsRegister.d.ts} +5 -2
- package/esm/typings/src/llm-providers/_common/{createLlmToolsFromConfigurationFromEnv.d.ts → register/$provideLlmToolsConfigurationFromEnv.d.ts} +3 -3
- package/esm/typings/src/llm-providers/_common/register/$provideLlmToolsForCli.d.ts +15 -0
- package/esm/typings/src/llm-providers/_common/{getLlmToolsForTestingAndScriptsAndPlayground.d.ts → register/$provideLlmToolsForTestingAndScriptsAndPlayground.d.ts} +4 -3
- package/esm/typings/src/llm-providers/_common/{createLlmToolsFromEnv.d.ts → register/$provideLlmToolsFromEnv.d.ts} +6 -5
- package/esm/typings/src/llm-providers/_common/{$registeredLlmToolsMessage.d.ts → register/$registeredLlmToolsMessage.d.ts} +5 -2
- package/esm/typings/src/llm-providers/_common/{LlmToolsConfiguration.d.ts → register/LlmToolsConfiguration.d.ts} +6 -5
- package/esm/typings/src/llm-providers/_common/{LlmToolsMetadata.d.ts → register/LlmToolsMetadata.d.ts} +5 -4
- package/esm/typings/src/llm-providers/_common/{LlmToolsOptions.d.ts → register/LlmToolsOptions.d.ts} +4 -1
- package/esm/typings/src/llm-providers/_common/{createLlmToolsFromConfiguration.d.ts → register/createLlmToolsFromConfiguration.d.ts} +12 -4
- package/esm/typings/src/llm-providers/_common/utils/cache/CacheLlmToolsOptions.d.ts +4 -1
- package/esm/typings/src/llm-providers/anthropic-claude/AnthropicClaudeExecutionTools.d.ts +1 -1
- package/esm/typings/src/llm-providers/anthropic-claude/AnthropicClaudeExecutionToolsOptions.d.ts +5 -5
- package/esm/typings/src/llm-providers/anthropic-claude/anthropic-claude-models.d.ts +1 -1
- package/esm/typings/src/llm-providers/anthropic-claude/playground/playground.d.ts +3 -2
- package/esm/typings/src/llm-providers/anthropic-claude/register-configuration.d.ts +4 -3
- package/esm/typings/src/llm-providers/anthropic-claude/register-constructor.d.ts +4 -3
- package/esm/typings/src/llm-providers/azure-openai/AzureOpenAiExecutionTools.d.ts +7 -1
- package/esm/typings/src/llm-providers/azure-openai/AzureOpenAiExecutionToolsOptions.d.ts +4 -3
- package/esm/typings/src/llm-providers/azure-openai/playground/playground.d.ts +1 -0
- package/esm/typings/src/llm-providers/azure-openai/register-configuration.d.ts +4 -3
- package/esm/typings/src/llm-providers/azure-openai/register-constructor.d.ts +4 -3
- package/esm/typings/src/llm-providers/langtail/LangtailExecutionTools.d.ts +1 -1
- package/esm/typings/src/llm-providers/langtail/playground/playground.d.ts +3 -0
- package/esm/typings/src/llm-providers/mocked/$fakeTextToExpectations.d.ts +1 -1
- package/esm/typings/src/llm-providers/mocked/MockedEchoLlmExecutionTools.d.ts +4 -4
- package/esm/typings/src/llm-providers/mocked/MockedFackedLlmExecutionTools.d.ts +4 -4
- package/esm/typings/src/llm-providers/multiple/MultipleLlmExecutionTools.d.ts +4 -4
- package/esm/typings/src/llm-providers/multiple/joinLlmExecutionTools.d.ts +1 -1
- package/esm/typings/src/llm-providers/multiple/playground/playground.d.ts +3 -0
- package/esm/typings/src/llm-providers/openai/OpenAiAssistantExecutionTools.d.ts +1 -2
- package/esm/typings/src/llm-providers/openai/OpenAiExecutionTools.d.ts +2 -2
- package/esm/typings/src/llm-providers/openai/OpenAiExecutionToolsOptions.d.ts +4 -4
- package/esm/typings/src/llm-providers/openai/openai-models.d.ts +1 -1
- package/esm/typings/src/llm-providers/openai/playground/playground.d.ts +2 -1
- package/esm/typings/src/llm-providers/openai/register-configuration.d.ts +5 -4
- package/esm/typings/src/llm-providers/openai/register-constructor.d.ts +5 -4
- package/esm/typings/src/llm-providers/remote/RemoteLlmExecutionTools.d.ts +4 -4
- package/esm/typings/src/llm-providers/remote/interfaces/PromptbookServer_ListModels_Request.d.ts +16 -7
- package/esm/typings/src/llm-providers/remote/interfaces/PromptbookServer_ListModels_Response.d.ts +4 -4
- package/esm/typings/src/llm-providers/remote/interfaces/PromptbookServer_Prompt_Request.d.ts +7 -13
- package/esm/typings/src/llm-providers/remote/interfaces/PromptbookServer_Prompt_Response.d.ts +3 -3
- package/esm/typings/src/llm-providers/remote/interfaces/RemoteLlmExecutionToolsOptions.d.ts +11 -16
- package/esm/typings/src/llm-providers/remote/interfaces/RemoteServerOptions.d.ts +24 -9
- package/esm/typings/src/llm-providers/remote/playground/playground.d.ts +3 -0
- package/esm/typings/src/llm-providers/remote/startRemoteServer.d.ts +1 -1
- package/esm/typings/src/personas/preparePersona.d.ts +3 -2
- package/esm/typings/src/prepare/PrepareAndScrapeOptions.d.ts +49 -0
- package/esm/typings/src/prepare/preparePipeline.d.ts +3 -2
- package/esm/typings/src/prepare/prepareTemplates.d.ts +4 -3
- package/esm/typings/src/scrapers/_common/Converter.d.ts +22 -0
- package/esm/typings/src/scrapers/_common/Scraper.d.ts +59 -0
- package/esm/typings/src/scrapers/_common/ScraperIntermediateSource.d.ts +11 -0
- package/esm/typings/src/{knowledge/prepare-knowledge → scrapers}/_common/prepareKnowledgePieces.d.ts +5 -4
- package/esm/typings/src/scrapers/_common/register/$provideFilesystemForNode.d.ts +11 -0
- package/esm/typings/src/scrapers/_common/register/$provideScrapersForBrowser.d.ts +12 -0
- package/esm/typings/src/scrapers/_common/register/$provideScrapersForNode.d.ts +15 -0
- package/esm/typings/src/scrapers/_common/register/$registeredScrapersMessage.d.ts +12 -0
- package/esm/typings/src/scrapers/_common/register/$scrapersMetadataRegister.d.ts +13 -0
- package/esm/typings/src/scrapers/_common/register/$scrapersRegister.d.ts +13 -0
- package/esm/typings/src/scrapers/_common/register/ScraperAndConverterMetadata.d.ts +41 -0
- package/esm/typings/src/scrapers/_common/register/ScraperConstructor.d.ts +12 -0
- package/esm/typings/src/scrapers/_common/utils/getScraperIntermediateSource.d.ts +34 -0
- package/esm/typings/src/scrapers/_common/utils/getScraperIntermediateSource.test.d.ts +4 -0
- package/esm/typings/src/scrapers/_common/utils/makeKnowledgeSourceHandler.d.ts +11 -0
- package/esm/typings/src/scrapers/document/DocumentScraper.d.ts +43 -0
- package/esm/typings/src/scrapers/document/DocumentScraper.test.d.ts +4 -0
- package/esm/typings/src/scrapers/document/createDocumentScraper.d.ts +20 -0
- package/esm/typings/src/scrapers/document/playground/document-scraper-playground.d.ts +5 -0
- package/esm/typings/src/scrapers/document/register-constructor.d.ts +13 -0
- package/esm/typings/src/scrapers/document/register-metadata.d.ts +24 -0
- package/esm/typings/src/scrapers/document-legacy/LegacyDocumentScraper.d.ts +43 -0
- package/esm/typings/src/scrapers/document-legacy/LegacyDocumentScraper.test.d.ts +4 -0
- package/esm/typings/src/scrapers/document-legacy/createLegacyDocumentScraper.d.ts +20 -0
- package/esm/typings/src/scrapers/document-legacy/playground/legacy-document-scraper-playground.d.ts +5 -0
- package/esm/typings/src/scrapers/document-legacy/register-constructor.d.ts +13 -0
- package/esm/typings/src/scrapers/document-legacy/register-metadata.d.ts +24 -0
- package/esm/typings/src/scrapers/markdown/MarkdownScraper.d.ts +29 -0
- package/esm/typings/src/scrapers/markdown/createMarkdownScraper.d.ts +20 -0
- package/esm/typings/src/scrapers/markdown/playground/markdown-scraper-playground.d.ts +5 -0
- package/esm/typings/src/scrapers/markdown/register-constructor.d.ts +13 -0
- package/esm/typings/src/scrapers/markdown/register-metadata.d.ts +24 -0
- package/esm/typings/src/scrapers/pdf/PdfScraper.d.ts +40 -0
- package/esm/typings/src/scrapers/pdf/createPdfScraper.d.ts +20 -0
- package/esm/typings/src/scrapers/pdf/playground/pdf-scraper-playground.d.ts +5 -0
- package/esm/typings/src/scrapers/pdf/register-constructor.d.ts +13 -0
- package/esm/typings/src/scrapers/pdf/register-metadata.d.ts +24 -0
- package/esm/typings/src/scripting/javascript/JavascriptExecutionToolsOptions.d.ts +2 -2
- package/esm/typings/src/scripting/javascript/utils/preserve.d.ts +1 -1
- package/esm/typings/src/scripting/python/PythonExecutionTools.d.ts +3 -3
- package/esm/typings/src/scripting/typescript/TypescriptExecutionTools.d.ts +3 -3
- package/esm/typings/src/storage/{files-storage/FilesStorage.d.ts → file-cache-storage/FileCacheStorage.d.ts} +7 -5
- package/esm/typings/src/storage/file-cache-storage/FileCacheStorageOptions.d.ts +10 -0
- package/esm/typings/src/storage/{files-storage → file-cache-storage}/utils/nameToSubfolderPath.d.ts +2 -2
- package/esm/typings/src/storage/local-storage/getLocalStorage.d.ts +1 -1
- package/esm/typings/src/storage/local-storage/getSessionStorage.d.ts +1 -1
- package/esm/typings/src/storage/{utils → memory/utils}/PrefixStorage.d.ts +1 -1
- package/esm/typings/src/storage/{utils → memory/utils}/makePromptbookStorageFromWebStorage.d.ts +1 -1
- package/esm/typings/src/types/Arrayable.d.ts +1 -1
- package/esm/typings/src/types/IntermediateFilesStrategy.d.ts +7 -0
- package/esm/typings/src/types/PipelineJson/KnowledgePieceJson.d.ts +4 -4
- package/esm/typings/src/types/PipelineJson/KnowledgeSourceJson.d.ts +10 -3
- package/esm/typings/src/types/PipelineJson/ParameterJson.d.ts +1 -1
- package/esm/typings/src/types/PipelineJson/PersonaJson.d.ts +1 -1
- package/esm/typings/src/types/PipelineJson/PipelineJson.d.ts +2 -2
- package/esm/typings/src/types/PipelineJson/TemplateJsonCommon.d.ts +2 -2
- package/esm/typings/src/types/Prompt.d.ts +2 -1
- package/esm/typings/src/types/execution-report/ExecutionReportJson.d.ts +1 -4
- package/esm/typings/src/types/execution-report/executionReportJsonToString.d.ts +2 -1
- package/esm/typings/src/types/typeAliases.d.ts +27 -20
- package/esm/typings/src/utils/$Register.d.ts +20 -7
- package/esm/typings/src/utils/FromtoItems.d.ts +1 -1
- package/esm/typings/src/utils/arrayableToArray.d.ts +1 -1
- package/esm/typings/src/utils/emojis.d.ts +1 -1
- package/esm/typings/src/utils/execCommand/$execCommand.d.ts +14 -0
- package/esm/typings/src/utils/execCommand/$execCommands.d.ts +17 -0
- package/esm/typings/src/utils/execCommand/ExecCommandOptions.d.ts +19 -0
- package/esm/typings/src/utils/execCommand/execCommandNormalizeOptions.d.ts +10 -0
- package/esm/typings/src/utils/execCommand/execCommandNormalizeOptions.test.d.ts +1 -0
- package/esm/typings/src/utils/expectation-counters/countSentences.d.ts +1 -1
- package/esm/typings/src/utils/files/extensionToMimeType.d.ts +8 -0
- package/esm/typings/src/utils/files/extensionToMimeType.test.d.ts +1 -0
- package/esm/typings/src/utils/files/getFileExtension.d.ts +8 -0
- package/esm/typings/src/utils/files/getFileExtension.test.d.ts +1 -0
- package/esm/typings/src/utils/files/isDirectoryExisting.d.ts +14 -0
- package/esm/typings/src/utils/files/isDirectoryExisting.test.d.ts +1 -0
- package/esm/typings/src/utils/files/isExecutable.d.ts +11 -0
- package/esm/typings/src/utils/files/isFileExisting.d.ts +13 -0
- package/esm/typings/src/utils/files/isFileExisting.test.d.ts +1 -0
- package/esm/typings/src/utils/files/listAllFiles.d.ts +17 -0
- package/esm/typings/src/utils/files/listAllFiles.test.d.ts +1 -0
- package/esm/typings/src/utils/markdown/extractAllBlocksFromMarkdown.d.ts +1 -1
- package/esm/typings/src/utils/markdown/splitMarkdownIntoSections.d.ts +1 -1
- package/esm/typings/src/utils/normalization/IKeywords.d.ts +2 -2
- package/esm/typings/src/utils/normalization/parseKeywords.d.ts +2 -2
- package/esm/typings/src/utils/normalization/parseKeywordsFromString.d.ts +2 -2
- package/esm/typings/src/utils/normalization/searchKeywords.d.ts +2 -2
- package/esm/typings/src/utils/organization/TODO_USE.d.ts +1 -1
- package/esm/typings/src/utils/organization/keepUnused.d.ts +1 -1
- package/esm/typings/src/utils/random/$randomSeed.d.ts +1 -1
- package/esm/typings/src/utils/sets/intersection.d.ts +1 -1
- package/esm/typings/src/utils/sets/union.d.ts +1 -1
- package/esm/typings/src/utils/unwrapResult.d.ts +4 -4
- package/esm/typings/src/utils/validators/filePath/isValidFilePath.d.ts +2 -2
- package/package.json +4 -3
- package/umd/index.umd.js +247 -5
- package/umd/index.umd.js.map +1 -1
- package/esm/typings/src/execution/createPipelineExecutor/00-CreatePipelineExecutorSettings.d.ts +0 -40
- package/esm/typings/src/knowledge/prepare-knowledge/_common/Scraper.d.ts +0 -37
- package/esm/typings/src/knowledge/prepare-knowledge/markdown/playground/markdown-knowledge-playground.d.ts +0 -2
- package/esm/typings/src/knowledge/prepare-knowledge/markdown/prepareKnowledgeFromMarkdown.d.ts +0 -14
- package/esm/typings/src/knowledge/prepare-knowledge/pdf/prepareKnowledgeFromPdf.d.ts +0 -15
- package/esm/typings/src/llm-providers/_common/getLlmToolsForCli.d.ts +0 -22
- package/esm/typings/src/prepare/PrepareOptions.d.ts +0 -22
- package/esm/typings/src/storage/files-storage/FilesStorageOptions.d.ts +0 -10
- package/esm/typings/src/utils/files/$isDirectoryExisting.d.ts +0 -15
- package/esm/typings/src/utils/files/$isFileExisting.d.ts +0 -14
- package/esm/typings/src/utils/files/$listAllFiles.d.ts +0 -17
- /package/esm/typings/src/{knowledge/dialogs → dialogs}/user-interface-execution-tools.test.d.ts +0 -0
- /package/esm/typings/src/{knowledge/prepare-knowledge/_common/prepareKnowledgePieces.test.d.ts → executables/apps/locateLibreoffice.test.d.ts} +0 -0
- /package/esm/typings/src/{knowledge/prepare-knowledge/pdf/prepareKnowledgeFromPdf.test.d.ts → executables/apps/locatePandoc.test.d.ts} +0 -0
- /package/esm/typings/src/{storage/files-storage/utils/nameToSubfolderPath.test.d.ts → executables/locateApp.test.d.ts} +0 -0
- /package/esm/typings/src/{utils/files/$isDirectoryExisting.test.d.ts → scrapers/_common/prepareKnowledgePieces.test.d.ts} +0 -0
- /package/esm/typings/src/{knowledge/prepare-knowledge/markdown/prepareKnowledgeFromMarkdown.test.d.ts → scrapers/markdown/MarkdownScraper.test.d.ts} +0 -0
- /package/esm/typings/src/{utils/files/$isFileExisting.test.d.ts → storage/file-cache-storage/utils/nameToSubfolderPath.test.d.ts} +0 -0
- /package/esm/typings/src/utils/{files/$listAllFiles.test.d.ts → execCommand/execCommand.test.d.ts} +0 -0
|
@@ -1,10 +1,14 @@
|
|
|
1
|
-
import type {
|
|
2
|
-
import type {
|
|
1
|
+
import type { ExecutionTools } from '../../execution/ExecutionTools';
|
|
2
|
+
import type { PrepareAndScrapeOptions } from '../../prepare/PrepareAndScrapeOptions';
|
|
3
|
+
import type { string_dirname } from '../../types/typeAliases';
|
|
3
4
|
import type { PipelineCollection } from '../PipelineCollection';
|
|
4
5
|
/**
|
|
5
6
|
* Options for `createCollectionFromDirectory` function
|
|
7
|
+
*
|
|
8
|
+
* Note: `rootDirname` is not needed because it is the folder in which `.ptbk.md` file is located
|
|
9
|
+
* This is not same as `path` which is the first argument of `createCollectionFromDirectory` - it can be a subfolder
|
|
6
10
|
*/
|
|
7
|
-
type CreatePipelineCollectionFromDirectoryOptions =
|
|
11
|
+
type CreatePipelineCollectionFromDirectoryOptions = Omit<PrepareAndScrapeOptions, 'rootDirname'> & {
|
|
8
12
|
/**
|
|
9
13
|
* If true, the directory is searched recursively for pipelines
|
|
10
14
|
*
|
|
@@ -37,13 +41,14 @@ type CreatePipelineCollectionFromDirectoryOptions = PipelineStringToJsonOptions
|
|
|
37
41
|
* Note: Works only in Node.js environment because it reads the file system
|
|
38
42
|
*
|
|
39
43
|
* @param path - path to the directory with pipelines
|
|
40
|
-
* @param
|
|
44
|
+
* @param tools - Execution tools to be used for pipeline preparation if needed - If not provided, `$provideExecutionToolsForNode` will be used
|
|
45
|
+
* @param options - Options for the collection creation
|
|
41
46
|
* @returns PipelineCollection
|
|
42
47
|
* @public exported from `@promptbook/node`
|
|
43
48
|
*/
|
|
44
|
-
export declare function createCollectionFromDirectory(path:
|
|
49
|
+
export declare function createCollectionFromDirectory(path: string_dirname, tools?: Pick<ExecutionTools, 'llm' | 'fs' | 'scrapers'>, options?: CreatePipelineCollectionFromDirectoryOptions): Promise<PipelineCollection>;
|
|
45
50
|
export {};
|
|
46
51
|
/**
|
|
47
|
-
* Note: [🟢] This code should never be published outside of `@promptbook/node` and `@promptbook/cli` and `@promptbook/cli`
|
|
48
52
|
* TODO: [🖇] What about symlinks? Maybe option isSymlinksFollowed
|
|
53
|
+
* TODO: Maybe move from `@promptbook/node` to `@promptbook/core` as we removes direct dependency on `fs`
|
|
49
54
|
*/
|
|
@@ -10,4 +10,4 @@ import type { PipelineCollection } from '../PipelineCollection';
|
|
|
10
10
|
* @returns PipelineCollection
|
|
11
11
|
* @public exported from `@promptbook/core`
|
|
12
12
|
*/
|
|
13
|
-
export declare function createCollectionFromJson(...promptbooks:
|
|
13
|
+
export declare function createCollectionFromJson(...promptbooks: ReadonlyArray<PipelineJson>): PipelineCollection;
|
|
@@ -20,4 +20,4 @@ import type { PipelineCollection } from '../PipelineCollection';
|
|
|
20
20
|
* @deprecated Do not use, it will became internal tool for other constructor functions
|
|
21
21
|
* @public exported from `@promptbook/core`
|
|
22
22
|
*/
|
|
23
|
-
export declare function createCollectionFromPromise(promptbookSourcesPromiseOrFactory: Promise<
|
|
23
|
+
export declare function createCollectionFromPromise(promptbookSourcesPromiseOrFactory: Promise<ReadonlyArray<PipelineJson>> | (() => Promise<ReadonlyArray<PipelineJson>>)): PipelineCollection;
|
|
@@ -25,5 +25,5 @@ type CreatePipelineCollectionFromUrlyOptions = {
|
|
|
25
25
|
export declare function createCollectionFromUrl(url: string_url | URL, options: CreatePipelineCollectionFromUrlyOptions): Promise<PipelineCollection>;
|
|
26
26
|
export {};
|
|
27
27
|
/**
|
|
28
|
-
* TODO:[main] !!!! [🧠] Library precompilation and do not mix markdown and json promptbooks
|
|
28
|
+
* TODO: [main] !!!! [🧠] Library precompilation and do not mix markdown and json promptbooks
|
|
29
29
|
*/
|
|
@@ -3,7 +3,7 @@ import type { ExpectCommand } from './ExpectCommand';
|
|
|
3
3
|
/**
|
|
4
4
|
* Parses the expect command
|
|
5
5
|
*
|
|
6
|
-
* @see
|
|
6
|
+
* @see `documentationUrl` for more details
|
|
7
7
|
* @private within the commands folder
|
|
8
8
|
*/
|
|
9
9
|
export declare const expectCommandParser: PipelineTemplateCommandParser<ExpectCommand>;
|
|
@@ -19,5 +19,9 @@ export type ForeachJson = {
|
|
|
19
19
|
/**
|
|
20
20
|
* @@@
|
|
21
21
|
*/
|
|
22
|
-
readonly
|
|
22
|
+
readonly inputSubparameterNames: Array<string_parameter_name>;
|
|
23
|
+
/**
|
|
24
|
+
* @@@
|
|
25
|
+
*/
|
|
26
|
+
readonly outputSubparameterName: string_parameter_name;
|
|
23
27
|
};
|
|
@@ -5,7 +5,7 @@ import type { ForeachCommand } from './ForeachCommand';
|
|
|
5
5
|
*
|
|
6
6
|
* Note: @@@ This command is used as foreach for new commands - it should NOT be used in any `.ptbk.md` file
|
|
7
7
|
*
|
|
8
|
-
* @see
|
|
8
|
+
* @see `documentationUrl` for more details
|
|
9
9
|
* @private within the commands folder
|
|
10
10
|
*/
|
|
11
11
|
export declare const foreachCommandParser: PipelineTemplateCommandParser<ForeachCommand>;
|
|
@@ -3,7 +3,7 @@ import type { FormatCommand } from './FormatCommand';
|
|
|
3
3
|
/**
|
|
4
4
|
* Parses the format command
|
|
5
5
|
*
|
|
6
|
-
* @see
|
|
6
|
+
* @see `documentationUrl` for more details
|
|
7
7
|
* @private within the commands folder
|
|
8
8
|
*/
|
|
9
9
|
export declare const formatCommandParser: PipelineTemplateCommandParser<FormatCommand>;
|
|
@@ -3,7 +3,7 @@ import type { JokerCommand } from './JokerCommand';
|
|
|
3
3
|
/**
|
|
4
4
|
* Parses the joker command
|
|
5
5
|
*
|
|
6
|
-
* @see
|
|
6
|
+
* @see `documentationUrl` for more details
|
|
7
7
|
* @private within the commands folder
|
|
8
8
|
*/
|
|
9
9
|
export declare const jokerCommandParser: PipelineTemplateCommandParser<JokerCommand>;
|
|
@@ -3,7 +3,7 @@ import type { KnowledgeCommand } from './KnowledgeCommand';
|
|
|
3
3
|
/**
|
|
4
4
|
* Parses the knowledge command
|
|
5
5
|
*
|
|
6
|
-
* @see
|
|
6
|
+
* @see `documentationUrl` for more details
|
|
7
7
|
* @private within the commands folder
|
|
8
8
|
*/
|
|
9
9
|
export declare const knowledgeCommandParser: PipelineHeadCommandParser<KnowledgeCommand>;
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import type { string_knowledge_source_content } from '../../../types/typeAliases';
|
|
2
|
+
import type { string_name } from '../../../types/typeAliases';
|
|
3
|
+
/**
|
|
4
|
+
* Creates unique name for the source
|
|
5
|
+
*
|
|
6
|
+
* @private within the repository
|
|
7
|
+
*/
|
|
8
|
+
export declare function sourceContentToName(sourceContent: string_knowledge_source_content): string_name;
|
|
9
|
+
/**
|
|
10
|
+
* TODO: [🐱🐉][🧠] Make some smart crop NOT source-i-m-pavol-a-develop-... BUT source-i-m-pavol-a-developer-...
|
|
11
|
+
*/
|
|
@@ -3,7 +3,7 @@ import type { ModelCommand } from './ModelCommand';
|
|
|
3
3
|
/**
|
|
4
4
|
* Parses the model command
|
|
5
5
|
*
|
|
6
|
-
* @see
|
|
6
|
+
* @see `documentationUrl` for more details
|
|
7
7
|
* @private within the commands folder
|
|
8
8
|
*/
|
|
9
9
|
export declare const modelCommandParser: PipelineBothCommandParser<ModelCommand>;
|
|
@@ -3,7 +3,7 @@ import type { ParameterCommand } from './ParameterCommand';
|
|
|
3
3
|
/**
|
|
4
4
|
* Parses the parameter command
|
|
5
5
|
*
|
|
6
|
-
* @see
|
|
6
|
+
* @see `documentationUrl` for more details
|
|
7
7
|
* @private within the commands folder
|
|
8
8
|
*/
|
|
9
9
|
export declare const parameterCommandParser: PipelineBothCommandParser<ParameterCommand>;
|
|
@@ -3,7 +3,7 @@ import type { PersonaCommand } from './PersonaCommand';
|
|
|
3
3
|
/**
|
|
4
4
|
* Parses the persona command
|
|
5
5
|
*
|
|
6
|
-
* @see
|
|
6
|
+
* @see `documentationUrl` for more details
|
|
7
7
|
* @private within the commands folder
|
|
8
8
|
*/
|
|
9
9
|
export declare const personaCommandParser: PipelineBothCommandParser<PersonaCommand>;
|
|
@@ -3,7 +3,7 @@ import type { PostprocessCommand } from './PostprocessCommand';
|
|
|
3
3
|
/**
|
|
4
4
|
* Parses the postprocess command
|
|
5
5
|
*
|
|
6
|
-
* @see
|
|
6
|
+
* @see `documentationUrl` for more details
|
|
7
7
|
* @private within the commands folder
|
|
8
8
|
*/
|
|
9
9
|
export declare const postprocessCommandParser: PipelineTemplateCommandParser<PostprocessCommand>;
|
|
@@ -3,7 +3,7 @@ import type { PromptbookVersionCommand } from './PromptbookVersionCommand';
|
|
|
3
3
|
/**
|
|
4
4
|
* Parses the PROMPTBOOK_VERSION command
|
|
5
5
|
*
|
|
6
|
-
* @see
|
|
6
|
+
* @see `documentationUrl` for more details
|
|
7
7
|
* @private within the commands folder
|
|
8
8
|
*/
|
|
9
9
|
export declare const promptbookVersionCommandParser: PipelineHeadCommandParser<PromptbookVersionCommand>;
|
|
@@ -3,7 +3,7 @@ import type { TemplateCommand } from './TemplateCommand';
|
|
|
3
3
|
/**
|
|
4
4
|
* Parses the template command
|
|
5
5
|
*
|
|
6
|
-
* @see
|
|
6
|
+
* @see `documentationUrl` for more details
|
|
7
7
|
* @private within the commands folder
|
|
8
8
|
*/
|
|
9
9
|
export declare const templateCommandParser: PipelineTemplateCommandParser<TemplateCommand>;
|
|
@@ -3,7 +3,7 @@ import type { UrlCommand } from './UrlCommand';
|
|
|
3
3
|
/**
|
|
4
4
|
* Parses the url command
|
|
5
5
|
*
|
|
6
|
-
* @see
|
|
6
|
+
* @see `documentationUrl` for more details
|
|
7
7
|
* @private within the commands folder
|
|
8
8
|
*/
|
|
9
9
|
export declare const urlCommandParser: PipelineHeadCommandParser<UrlCommand>;
|
|
@@ -3,7 +3,7 @@ import type { ActionCommand } from './ActionCommand';
|
|
|
3
3
|
/**
|
|
4
4
|
* Parses the action command
|
|
5
5
|
*
|
|
6
|
-
* @see
|
|
6
|
+
* @see `documentationUrl` for more details
|
|
7
7
|
* @private within the commands folder
|
|
8
8
|
*/
|
|
9
9
|
export declare const actionCommandParser: PipelineHeadCommandParser<ActionCommand>;
|
|
@@ -3,7 +3,7 @@ import type { InstrumentCommand } from './InstrumentCommand';
|
|
|
3
3
|
/**
|
|
4
4
|
* Parses the instrument command
|
|
5
5
|
*
|
|
6
|
-
* @see
|
|
6
|
+
* @see `documentationUrl` for more details
|
|
7
7
|
* @private within the commands folder
|
|
8
8
|
*/
|
|
9
9
|
export declare const instrumentCommandParser: PipelineHeadCommandParser<InstrumentCommand>;
|
|
@@ -5,7 +5,7 @@ import type { BoilerplateCommand } from './BoilerplateCommand';
|
|
|
5
5
|
*
|
|
6
6
|
* Note: @@@ This command is used as boilerplate for new commands - it should NOT be used in any `.ptbk.md` file
|
|
7
7
|
*
|
|
8
|
-
* @see
|
|
8
|
+
* @see `documentationUrl` for more details
|
|
9
9
|
* @private within the commands folder
|
|
10
10
|
*/
|
|
11
11
|
export declare const boilerplateCommandParser: PipelineBothCommandParser<BoilerplateCommand>;
|
|
@@ -40,11 +40,11 @@ export type CommonCommandParser<TCommand extends CommandBase> = {
|
|
|
40
40
|
/**
|
|
41
41
|
* @@@
|
|
42
42
|
*/
|
|
43
|
-
readonly aliasNames?:
|
|
43
|
+
readonly aliasNames?: ReadonlyArray<string_name & string_SCREAMING_CASE>;
|
|
44
44
|
/**
|
|
45
45
|
* @@@
|
|
46
46
|
*/
|
|
47
|
-
readonly deprecatedNames?:
|
|
47
|
+
readonly deprecatedNames?: ReadonlyArray<string_name & string_SCREAMING_CASE>;
|
|
48
48
|
/**
|
|
49
49
|
* @@@
|
|
50
50
|
*/
|
|
@@ -56,7 +56,7 @@ export type CommonCommandParser<TCommand extends CommandBase> = {
|
|
|
56
56
|
/**
|
|
57
57
|
* @@@
|
|
58
58
|
*/
|
|
59
|
-
readonly examples:
|
|
59
|
+
readonly examples: ReadonlyArray<string_markdown_text>;
|
|
60
60
|
/**
|
|
61
61
|
* @throws {ParseError} if the parsing fails
|
|
62
62
|
*/
|
|
@@ -95,7 +95,7 @@ export type PipelineHeadCommandParser<TCommand extends CommandBase> = CommonComm
|
|
|
95
95
|
*
|
|
96
96
|
* Note: This is used in `pipelineJsonToString` utility
|
|
97
97
|
*/
|
|
98
|
-
takeFromPipelineJson(pipelineJson: PipelineJson):
|
|
98
|
+
takeFromPipelineJson(pipelineJson: PipelineJson): ReadonlyArray<TCommand>;
|
|
99
99
|
};
|
|
100
100
|
/**
|
|
101
101
|
* @@@
|
|
@@ -120,7 +120,7 @@ export type PipelineTemplateCommandParser<TCommand extends CommandBase> = Common
|
|
|
120
120
|
*
|
|
121
121
|
* Note: This is used in `pipelineJsonToString` utility
|
|
122
122
|
*/
|
|
123
|
-
takeFromTemplateJson($templateJson: $TemplateJson):
|
|
123
|
+
takeFromTemplateJson($templateJson: $TemplateJson): ReadonlyArray<TCommand>;
|
|
124
124
|
};
|
|
125
125
|
/**
|
|
126
126
|
* @@@
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import type { CsvSettings } from './formats/csv/CsvSettings';
|
|
2
|
+
import type { IntermediateFilesStrategy } from './types/IntermediateFilesStrategy';
|
|
2
3
|
/**
|
|
3
4
|
* Warning message for the generated sections and files files
|
|
4
5
|
*
|
|
@@ -12,7 +13,7 @@ export declare const GENERATOR_WARNING = "\u26A0\uFE0F WARNING: This code has be
|
|
|
12
13
|
*
|
|
13
14
|
* @public exported from `@promptbook/core`
|
|
14
15
|
*/
|
|
15
|
-
export declare const CLAIM = "
|
|
16
|
+
export declare const CLAIM = "Build responsible, controlled and transparent applications on top of LLM models!";
|
|
16
17
|
/**
|
|
17
18
|
* Warning message for the generated sections and files files
|
|
18
19
|
*
|
|
@@ -50,49 +51,65 @@ export declare const CONNECTION_RETRIES_LIMIT = 5;
|
|
|
50
51
|
*/
|
|
51
52
|
export declare const IMMEDIATE_TIME = 10;
|
|
52
53
|
/**
|
|
53
|
-
* The maximum
|
|
54
|
+
* The maximum length of the (generated) filename
|
|
54
55
|
*
|
|
55
56
|
* @public exported from `@promptbook/core`
|
|
56
57
|
*/
|
|
57
|
-
export declare const
|
|
58
|
+
export declare const MAX_FILENAME_LENGTH = 30;
|
|
58
59
|
/**
|
|
59
|
-
*
|
|
60
|
+
* Strategy for caching the intermediate results for knowledge sources
|
|
60
61
|
*
|
|
61
62
|
* @public exported from `@promptbook/core`
|
|
62
63
|
*/
|
|
63
|
-
export declare const
|
|
64
|
+
export declare const DEFAULT_INTERMEDIATE_FILES_STRATEGY: IntermediateFilesStrategy;
|
|
64
65
|
/**
|
|
65
|
-
* The maximum
|
|
66
|
+
* The maximum number of (LLM) tasks running in parallel
|
|
66
67
|
*
|
|
67
68
|
* @public exported from `@promptbook/core`
|
|
68
69
|
*/
|
|
69
|
-
export declare const
|
|
70
|
+
export declare const DEFAULT_MAX_PARALLEL_COUNT = 5;
|
|
71
|
+
/**
|
|
72
|
+
* The maximum number of attempts to execute LLM task before giving up
|
|
73
|
+
*
|
|
74
|
+
* @public exported from `@promptbook/core`
|
|
75
|
+
*/
|
|
76
|
+
export declare const DEFAULT_MAX_EXECUTION_ATTEMPTS = 3;
|
|
70
77
|
/**
|
|
71
78
|
* @@@
|
|
72
79
|
* TODO: [🐝][main] !!! Use
|
|
73
80
|
*
|
|
74
81
|
* @public exported from `@promptbook/core`
|
|
75
82
|
*/
|
|
76
|
-
export declare const
|
|
83
|
+
export declare const DEFAULT_MAX_KNOWLEDGE_SOURCES_SCRAPING_DEPTH = 3;
|
|
77
84
|
/**
|
|
78
85
|
* @@@
|
|
79
86
|
* TODO: [🐝][main] !!! Use
|
|
80
87
|
*
|
|
81
88
|
* @public exported from `@promptbook/core`
|
|
82
89
|
*/
|
|
83
|
-
export declare const
|
|
90
|
+
export declare const DEFAULT_MAX_KNOWLEDGE_SOURCES_SCRAPING_TOTAL = 200;
|
|
84
91
|
/**
|
|
85
92
|
* Where to store the cache of executions for promptbook CLI
|
|
86
93
|
*
|
|
94
|
+
* Note: When the folder does not exist, it is created recursively
|
|
95
|
+
*
|
|
96
|
+
* @public exported from `@promptbook/core`
|
|
97
|
+
*/
|
|
98
|
+
export declare const DEFAULT_EXECUTIONS_CACHE_DIRNAME = "/.promptbook/executions-cache";
|
|
99
|
+
/**
|
|
100
|
+
* Where to store the scrape cache
|
|
101
|
+
*
|
|
102
|
+
* Note: When the folder does not exist, it is created recursively
|
|
103
|
+
*
|
|
87
104
|
* @public exported from `@promptbook/core`
|
|
88
105
|
*/
|
|
89
|
-
export declare const
|
|
106
|
+
export declare const DEFAULT_SCRAPE_CACHE_DIRNAME = "/.promptbook/scrape-cache";
|
|
90
107
|
/**
|
|
91
108
|
* The name of the builded pipeline collection made by CLI `ptbk make` and for lookup in `createCollectionFromDirectory`
|
|
92
109
|
*
|
|
93
110
|
* @public exported from `@promptbook/core`
|
|
94
111
|
*/
|
|
95
|
-
export declare const
|
|
112
|
+
export declare const DEFAULT_PIPELINE_COLLECTION_BASE_FILENAME = "index";
|
|
96
113
|
/**
|
|
97
114
|
* Nonce which is used for replacing things in strings
|
|
98
115
|
*
|
|
@@ -149,7 +166,13 @@ export declare const DEFAULT_CSV_SETTINGS: CsvSettings;
|
|
|
149
166
|
*
|
|
150
167
|
* @public exported from `@promptbook/core`
|
|
151
168
|
*/
|
|
152
|
-
export declare const
|
|
169
|
+
export declare const DEFAULT_IS_VERBOSE = false;
|
|
170
|
+
/**
|
|
171
|
+
* @@@
|
|
172
|
+
*
|
|
173
|
+
* @public exported from `@promptbook/core`
|
|
174
|
+
*/
|
|
175
|
+
export declare const DEFAULT_IS_AUTO_INSTALLED = false;
|
|
153
176
|
/**
|
|
154
177
|
* @@@
|
|
155
178
|
*
|
|
@@ -1,19 +1,7 @@
|
|
|
1
|
-
import type {
|
|
1
|
+
import type { ExecutionTools } from '../execution/ExecutionTools';
|
|
2
|
+
import type { PrepareAndScrapeOptions } from '../prepare/PrepareAndScrapeOptions';
|
|
2
3
|
import type { PipelineJson } from '../types/PipelineJson/PipelineJson';
|
|
3
4
|
import type { PipelineString } from '../types/PipelineString';
|
|
4
|
-
/**
|
|
5
|
-
* Options for `pipelineStringToJson`
|
|
6
|
-
*
|
|
7
|
-
* @public exported from `@promptbook/core`
|
|
8
|
-
*/
|
|
9
|
-
export type PipelineStringToJsonOptions = {
|
|
10
|
-
/**
|
|
11
|
-
* Tools for processing required for preparation of knowledge *(not for actual execution)*
|
|
12
|
-
*
|
|
13
|
-
* Note: If you provide `null`, the knowledge will not be prepared
|
|
14
|
-
*/
|
|
15
|
-
readonly llmTools: LlmExecutionTools | null;
|
|
16
|
-
};
|
|
17
5
|
/**
|
|
18
6
|
* Compile pipeline from string (markdown) format to JSON format
|
|
19
7
|
*
|
|
@@ -26,12 +14,13 @@ export type PipelineStringToJsonOptions = {
|
|
|
26
14
|
* Note: This function acts as compilation process
|
|
27
15
|
*
|
|
28
16
|
* @param pipelineString {Promptbook} in string markdown format (.ptbk.md)
|
|
17
|
+
* @param tools - Tools for the preparation and scraping - if not provided together with `llm`, the preparation will be skipped
|
|
29
18
|
* @param options - Options and tools for the compilation
|
|
30
19
|
* @returns {Promptbook} compiled in JSON format (.ptbk.json)
|
|
31
20
|
* @throws {ParseError} if the promptbook string is not valid
|
|
32
21
|
* @public exported from `@promptbook/core`
|
|
33
22
|
*/
|
|
34
|
-
export declare function pipelineStringToJson(pipelineString: PipelineString, options?:
|
|
23
|
+
export declare function pipelineStringToJson(pipelineString: PipelineString, tools?: Pick<ExecutionTools, 'llm' | 'fs' | 'scrapers'>, options?: PrepareAndScrapeOptions): Promise<PipelineJson>;
|
|
35
24
|
/**
|
|
36
25
|
* TODO: [🏏] Leverage the batch API and build queues @see https://platform.openai.com/docs/guides/batch
|
|
37
26
|
* TODO: [🛠] Actions, instruments (and maybe knowledge) => Functions and tools
|
|
@@ -18,7 +18,7 @@ import type { PipelineString } from '../types/PipelineString';
|
|
|
18
18
|
*/
|
|
19
19
|
export declare function pipelineStringToJsonSync(pipelineString: PipelineString): PipelineJson;
|
|
20
20
|
/**
|
|
21
|
-
* TODO:[main] !!!! Warn if used only sync version
|
|
21
|
+
* TODO: [main] !!!! Warn if used only sync version
|
|
22
22
|
* TODO: [🚞] Report here line/column of error
|
|
23
23
|
* TODO: Use spaceTrim more effectively
|
|
24
24
|
* TODO: [🧠] Parameter flags - isInput, isOutput, isInternal
|
|
@@ -25,5 +25,5 @@ export declare function importPipelineJson(path: `${string}.ptbk.json`): Pipelin
|
|
|
25
25
|
*/
|
|
26
26
|
export declare function importPipelineJsonAsString(path: `${string}.ptbk.json`): string_json<PipelineJson>;
|
|
27
27
|
/**
|
|
28
|
-
*
|
|
28
|
+
* Note: [⚫] Code in this file should never be published in any package
|
|
29
29
|
*/
|
|
@@ -32,11 +32,11 @@ export declare function validatePipelineCore(pipeline: PipelineJson): void;
|
|
|
32
32
|
* > ex port function validatePipeline(promptbook: really_unknown): asserts promptbook is PipelineJson {
|
|
33
33
|
*/
|
|
34
34
|
/**
|
|
35
|
-
* TODO: [
|
|
36
|
-
* TODO: [
|
|
37
|
-
* TODO: [
|
|
38
|
-
* TODO: [
|
|
39
|
-
* TODO: [
|
|
35
|
+
* TODO: [🧳][main] !!!! Validate that all samples match expectations
|
|
36
|
+
* TODO: [🧳][🐝][main] !!!! Validate that knowledge is valid (non-void)
|
|
37
|
+
* TODO: [🧳][main] !!!! Validate that persona can be used only with CHAT variant
|
|
38
|
+
* TODO: [🧳][main] !!!! Validate that parameter with reserved name not used RESERVED_PARAMETER_NAMES
|
|
39
|
+
* TODO: [🧳][main] !!!! Validate that reserved parameter is not used as joker
|
|
40
40
|
* TODO: [🧠] Validation not only logic itself but imports around - files and websites and rerefenced pipelines exists
|
|
41
41
|
* TODO: [🛠] Actions, instruments (and maybe knowledge) => Functions and tools
|
|
42
42
|
*/
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import type { UserInterfaceTools } from '
|
|
2
|
-
import type { UserInterfaceToolsPromptDialogOptions } from '
|
|
1
|
+
import type { UserInterfaceTools } from '../../execution/UserInterfaceTools';
|
|
2
|
+
import type { UserInterfaceToolsPromptDialogOptions } from '../../execution/UserInterfaceTools';
|
|
3
3
|
import type { CallbackInterfaceToolsOptions } from './CallbackInterfaceToolsOptions';
|
|
4
4
|
/**
|
|
5
5
|
* Delagates the user interaction to a async callback function
|
package/esm/typings/src/{knowledge/dialogs → dialogs}/callback/CallbackInterfaceToolsOptions.d.ts
RENAMED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
import type { Promisable } from 'type-fest';
|
|
2
|
-
import type {
|
|
3
|
-
import type { UserInterfaceToolsPromptDialogOptions } from '
|
|
2
|
+
import type { CommonToolsOptions } from '../../execution/CommonToolsOptions';
|
|
3
|
+
import type { UserInterfaceToolsPromptDialogOptions } from '../../execution/UserInterfaceTools';
|
|
4
4
|
/**
|
|
5
5
|
* Options for `CallbackInterfaceTools`
|
|
6
6
|
*
|
|
7
7
|
* @public exported from `@promptbook/core`
|
|
8
8
|
*/
|
|
9
|
-
export type CallbackInterfaceToolsOptions =
|
|
9
|
+
export type CallbackInterfaceToolsOptions = CommonToolsOptions & {
|
|
10
10
|
/**
|
|
11
11
|
* The callback function to be called when promptDialog is called
|
|
12
12
|
*/
|
package/esm/typings/src/{knowledge/dialogs → dialogs}/simple-prompt/SimplePromptInterfaceTools.d.ts
RENAMED
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import type {
|
|
2
|
-
import type { UserInterfaceTools } from '
|
|
3
|
-
import type { UserInterfaceToolsPromptDialogOptions } from '
|
|
1
|
+
import type { CommonToolsOptions } from '../../execution/CommonToolsOptions';
|
|
2
|
+
import type { UserInterfaceTools } from '../../execution/UserInterfaceTools';
|
|
3
|
+
import type { UserInterfaceToolsPromptDialogOptions } from '../../execution/UserInterfaceTools';
|
|
4
4
|
/**
|
|
5
5
|
* Wrapper around `window.prompt` synchronous function that interacts with the user via browser prompt
|
|
6
6
|
*
|
|
@@ -10,13 +10,13 @@ import type { UserInterfaceToolsPromptDialogOptions } from '../../../execution/U
|
|
|
10
10
|
* @public exported from `@promptbook/browser`
|
|
11
11
|
*/
|
|
12
12
|
export declare class SimplePromptInterfaceTools implements UserInterfaceTools {
|
|
13
|
-
protected readonly options:
|
|
14
|
-
constructor(options?:
|
|
13
|
+
protected readonly options: CommonToolsOptions;
|
|
14
|
+
constructor(options?: CommonToolsOptions);
|
|
15
15
|
/**
|
|
16
16
|
* Trigger window.DIALOG TEMPLATE
|
|
17
17
|
*/
|
|
18
18
|
promptDialog(options: UserInterfaceToolsPromptDialogOptions): Promise<string>;
|
|
19
19
|
}
|
|
20
20
|
/**
|
|
21
|
-
* Note: [🔵]
|
|
21
|
+
* Note: [🔵] Code in this file should never be published outside of `@promptbook/browser`
|
|
22
22
|
*/
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This error indicates problems parsing the format value
|
|
3
|
+
*
|
|
4
|
+
* For example, when the format value is not a valid JSON or CSV
|
|
5
|
+
* This is not thrown directly but in extended classes
|
|
6
|
+
*
|
|
7
|
+
* @public exported from `@promptbook/core`
|
|
8
|
+
*/
|
|
9
|
+
export declare class AbstractFormatError extends Error {
|
|
10
|
+
constructor(message: string);
|
|
11
|
+
}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This error indicates that the promptbook can not retrieve knowledge from external sources
|
|
3
|
+
*
|
|
4
|
+
* @public exported from `@promptbook/core`
|
|
5
|
+
*/
|
|
6
|
+
export declare class KnowledgeScrapeError extends Error {
|
|
7
|
+
readonly name = "KnowledgeScrapeError";
|
|
8
|
+
constructor(message: string);
|
|
9
|
+
}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This error type indicates that some tools are missing for pipeline execution or preparation
|
|
3
|
+
*
|
|
4
|
+
* @public exported from `@promptbook/core`
|
|
5
|
+
*/
|
|
6
|
+
export declare class MissingToolsError extends Error {
|
|
7
|
+
readonly name = "MissingToolsError";
|
|
8
|
+
constructor(message: string);
|
|
9
|
+
}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import type { Executables } from '../execution/Executables';
|
|
2
|
+
import type { PrepareAndScrapeOptions } from '../prepare/PrepareAndScrapeOptions';
|
|
3
|
+
/**
|
|
4
|
+
* @@@
|
|
5
|
+
*
|
|
6
|
+
* @public exported from `@promptbook/node`
|
|
7
|
+
*/
|
|
8
|
+
export declare function $provideExecutablesForNode(options?: PrepareAndScrapeOptions): Promise<Executables>;
|
|
9
|
+
/**
|
|
10
|
+
* TODO: [🧠] Allow to override the executables without need to call `locatePandoc` / `locateLibreoffice` in case of provided
|
|
11
|
+
* Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
|
|
12
|
+
*/
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import type { string_executable_path } from '../../types/typeAliases';
|
|
2
|
+
/**
|
|
3
|
+
* @@@
|
|
4
|
+
*
|
|
5
|
+
* @private within the repository
|
|
6
|
+
*/
|
|
7
|
+
export declare function locateLibreoffice(): Promise<string_executable_path>;
|
|
8
|
+
/**
|
|
9
|
+
* TODO: [🧠][♿] Maybe export through `@promptbook/node` OR `@promptbook/legacy-documents`
|
|
10
|
+
* Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
|
|
11
|
+
*/
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import type { string_executable_path } from '../../types/typeAliases';
|
|
2
|
+
/**
|
|
3
|
+
* @@@
|
|
4
|
+
*
|
|
5
|
+
* @private within the repository
|
|
6
|
+
*/
|
|
7
|
+
export declare function locatePandoc(): Promise<string_executable_path>;
|
|
8
|
+
/**
|
|
9
|
+
* TODO: [🧠][♿] Maybe export through `@promptbook/node` OR `@promptbook/documents`
|
|
10
|
+
* Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
|
|
11
|
+
*/
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
import type { RequireAtLeastOne } from 'type-fest';
|
|
2
|
+
import type { string_executable_path } from '../types/typeAliases';
|
|
3
|
+
/**
|
|
4
|
+
* Options for locating any application
|
|
5
|
+
*/
|
|
6
|
+
export interface LocateAppOptions {
|
|
7
|
+
/**
|
|
8
|
+
* Name of the application
|
|
9
|
+
*/
|
|
10
|
+
appName: string;
|
|
11
|
+
/**
|
|
12
|
+
* Name of the executable on Linux
|
|
13
|
+
*/
|
|
14
|
+
linuxWhich?: string;
|
|
15
|
+
/**
|
|
16
|
+
* Path suffix on Windows
|
|
17
|
+
*/
|
|
18
|
+
windowsSuffix?: string;
|
|
19
|
+
/**
|
|
20
|
+
* Name of the application on macOS
|
|
21
|
+
*/
|
|
22
|
+
macOsName?: string;
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* Locates an application on the system
|
|
26
|
+
*
|
|
27
|
+
* @private within the repository
|
|
28
|
+
*/
|
|
29
|
+
export declare function locateApp(options: RequireAtLeastOne<LocateAppOptions, 'linuxWhich' | 'windowsSuffix' | 'macOsName'>): Promise<string_executable_path>;
|
|
30
|
+
/**
|
|
31
|
+
* TODO: [🧠][♿] Maybe export through `@promptbook/node`
|
|
32
|
+
* Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
|
|
33
|
+
*/
|