@promptbook/browser 0.72.0-3 → 0.72.0-31
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 +20 -0
- package/esm/typings/src/_packages/core.index.d.ts +56 -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/_packages/website-crawler.index.d.ts +8 -0
- 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/scrapers/website/WebsiteScraper.d.ts +50 -0
- package/esm/typings/src/scrapers/website/createWebsiteScraper.d.ts +20 -0
- package/esm/typings/src/scrapers/website/playground/website-scraper-playground.d.ts +5 -0
- package/esm/typings/src/scrapers/website/register-constructor.d.ts +13 -0
- package/esm/typings/src/scrapers/website/register-metadata.d.ts +24 -0
- package/esm/typings/src/scrapers/website/utils/createShowdownConverter.d.ts +7 -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/execCommand.test.d.ts +1 -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 → scrapers/website/utils/createShowdownConverter.test.d.ts} +0 -0
- /package/esm/typings/src/{utils/files/$listAllFiles.test.d.ts → storage/file-cache-storage/utils/nameToSubfolderPath.test.d.ts} +0 -0
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
import type { Registration } from '../../utils/$Register';
|
|
2
|
+
/**
|
|
3
|
+
* Metadata of the scraper
|
|
4
|
+
*
|
|
5
|
+
* @private within the scraper directory
|
|
6
|
+
*/
|
|
7
|
+
export declare const websiteScraperMetadata: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
|
|
8
|
+
title: string;
|
|
9
|
+
packageName: string;
|
|
10
|
+
className: string;
|
|
11
|
+
mimeTypes: string[];
|
|
12
|
+
documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
|
|
13
|
+
isAvilableInBrowser: false;
|
|
14
|
+
requiredExecutables: never[];
|
|
15
|
+
}>;
|
|
16
|
+
/**
|
|
17
|
+
* Registration of known scraper metadata
|
|
18
|
+
*
|
|
19
|
+
* Warning: This is not useful for the end user, it is just a side effect of the mechanism that handles all available known scrapers
|
|
20
|
+
*
|
|
21
|
+
* @public exported from `@promptbook/core`
|
|
22
|
+
* @public exported from `@promptbook/cli`
|
|
23
|
+
*/
|
|
24
|
+
export declare const _WebsiteScraperMetadataRegistration: Registration;
|
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
import type { Promisable } from 'type-fest';
|
|
2
|
-
import type {
|
|
2
|
+
import type { CommonToolsOptions } from '../../execution/CommonToolsOptions';
|
|
3
3
|
import type { string_postprocessing_function_name } from '../../types/typeAliases';
|
|
4
4
|
/**
|
|
5
5
|
* Options for `JavascriptExecutionTools`
|
|
6
6
|
*/
|
|
7
|
-
export type JavascriptExecutionToolsOptions =
|
|
7
|
+
export type JavascriptExecutionToolsOptions = CommonToolsOptions & {
|
|
8
8
|
/**
|
|
9
9
|
* Functions to be executed in the JavaScript evaluation.
|
|
10
10
|
*
|
|
@@ -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:
|
|
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
|
*/
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type {
|
|
1
|
+
import type { CommonToolsOptions } from '../../execution/CommonToolsOptions';
|
|
2
2
|
import type { ScriptExecutionTools } from '../../execution/ScriptExecutionTools';
|
|
3
3
|
import type { ScriptExecutionToolsExecuteOptions } from '../../execution/ScriptExecutionTools';
|
|
4
4
|
/**
|
|
@@ -9,8 +9,8 @@ import type { ScriptExecutionToolsExecuteOptions } from '../../execution/ScriptE
|
|
|
9
9
|
* @private still in development
|
|
10
10
|
*/
|
|
11
11
|
export declare class PythonExecutionTools implements ScriptExecutionTools {
|
|
12
|
-
protected readonly options:
|
|
13
|
-
constructor(options?:
|
|
12
|
+
protected readonly options: CommonToolsOptions;
|
|
13
|
+
constructor(options?: CommonToolsOptions);
|
|
14
14
|
/**
|
|
15
15
|
* Executes a Python
|
|
16
16
|
*/
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type {
|
|
1
|
+
import type { CommonToolsOptions } from '../../execution/CommonToolsOptions';
|
|
2
2
|
import type { ScriptExecutionTools } from '../../execution/ScriptExecutionTools';
|
|
3
3
|
import type { ScriptExecutionToolsExecuteOptions } from '../../execution/ScriptExecutionTools';
|
|
4
4
|
/**
|
|
@@ -9,8 +9,8 @@ import type { ScriptExecutionToolsExecuteOptions } from '../../execution/ScriptE
|
|
|
9
9
|
* @private still in development
|
|
10
10
|
*/
|
|
11
11
|
export declare class TypescriptExecutionTools implements ScriptExecutionTools {
|
|
12
|
-
protected readonly options:
|
|
13
|
-
constructor(options?:
|
|
12
|
+
protected readonly options: CommonToolsOptions;
|
|
13
|
+
constructor(options?: CommonToolsOptions);
|
|
14
14
|
/**
|
|
15
15
|
* Executes a TypeScript
|
|
16
16
|
*/
|
|
@@ -1,13 +1,15 @@
|
|
|
1
|
+
import type { ExecutionTools } from '../../execution/ExecutionTools';
|
|
1
2
|
import type { PromptbookStorage } from '../_common/PromptbookStorage';
|
|
2
|
-
import type {
|
|
3
|
+
import type { FileCacheStorageOptions } from './FileCacheStorageOptions';
|
|
3
4
|
/**
|
|
4
5
|
* @@@
|
|
5
6
|
*
|
|
6
7
|
* @public exported from `@promptbook/node`
|
|
7
8
|
*/
|
|
8
|
-
export declare class
|
|
9
|
-
protected readonly
|
|
10
|
-
|
|
9
|
+
export declare class FileCacheStorage<TItem> implements PromptbookStorage<TItem> {
|
|
10
|
+
protected readonly tools: Required<Pick<ExecutionTools, 'fs'>>;
|
|
11
|
+
private readonly options;
|
|
12
|
+
constructor(tools: Required<Pick<ExecutionTools, 'fs'>>, options: FileCacheStorageOptions);
|
|
11
13
|
/**
|
|
12
14
|
* @@@
|
|
13
15
|
*/
|
|
@@ -27,5 +29,5 @@ export declare class FilesStorage<TItem> implements PromptbookStorage<TItem> {
|
|
|
27
29
|
}
|
|
28
30
|
/**
|
|
29
31
|
* TODO: [🌗] Maybe some checkers, not all valid JSONs are desired and valid values
|
|
30
|
-
* Note: [🟢]
|
|
32
|
+
* Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
|
|
31
33
|
*/
|
package/esm/typings/src/storage/{files-storage → file-cache-storage}/utils/nameToSubfolderPath.d.ts
RENAMED
|
@@ -2,6 +2,6 @@ import type { string_name } from '../../../types/typeAliases';
|
|
|
2
2
|
/**
|
|
3
3
|
* @@@
|
|
4
4
|
*
|
|
5
|
-
* @private for `
|
|
5
|
+
* @private for `FileCacheStorage`
|
|
6
6
|
*/
|
|
7
|
-
export declare function nameToSubfolderPath(name: string_name):
|
|
7
|
+
export declare function nameToSubfolderPath(name: string_name): ReadonlyArray<string>;
|
|
@@ -6,5 +6,5 @@ import type { PromptbookStorage } from '../_common/PromptbookStorage';
|
|
|
6
6
|
*/
|
|
7
7
|
export declare function getLocalStorage<TItem>(): PromptbookStorage<TItem>;
|
|
8
8
|
/**
|
|
9
|
-
* Note: [🔵]
|
|
9
|
+
* Note: [🔵] Code in this file should never be published outside of `@promptbook/browser`
|
|
10
10
|
*/
|
|
@@ -6,5 +6,5 @@ import type { PromptbookStorage } from '../_common/PromptbookStorage';
|
|
|
6
6
|
*/
|
|
7
7
|
export declare function getSessionStorage<TItem>(): PromptbookStorage<TItem>;
|
|
8
8
|
/**
|
|
9
|
-
* Note: [🔵]
|
|
9
|
+
* Note: [🔵] Code in this file should never be published outside of `@promptbook/browser`
|
|
10
10
|
*/
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { Promisable } from 'type-fest';
|
|
2
|
-
import type { PromptbookStorage } from '
|
|
2
|
+
import type { PromptbookStorage } from '../../_common/PromptbookStorage';
|
|
3
3
|
/**
|
|
4
4
|
* This class behaves like LocalStorage but separates keys by prefix
|
|
5
5
|
*
|
|
@@ -31,7 +31,7 @@ export type KnowledgePiecePreparedJson = {
|
|
|
31
31
|
/**
|
|
32
32
|
* List of sources where the information comes from
|
|
33
33
|
*/
|
|
34
|
-
readonly sources:
|
|
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:
|
|
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:
|
|
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:
|
|
68
|
+
readonly preparationIds: ReadonlyArray<number_id>;
|
|
69
69
|
};
|
|
70
70
|
/**
|
|
71
71
|
* TODO: [🍙] Make some standard order of json properties
|
|
@@ -11,11 +11,18 @@ import type { string_name } from '../typeAliases';
|
|
|
11
11
|
*/
|
|
12
12
|
export type KnowledgeSourceJson = {
|
|
13
13
|
/**
|
|
14
|
-
*
|
|
14
|
+
* Unique identifier of the knowledge source
|
|
15
15
|
*/
|
|
16
16
|
readonly name: string_name;
|
|
17
17
|
/**
|
|
18
|
-
*
|
|
18
|
+
* Source of one knowledge
|
|
19
|
+
*
|
|
20
|
+
* It can be a link, a relative path to file or direct text or combination of those
|
|
21
|
+
*
|
|
22
|
+
* For example `"https://pavolhejny.com/"`
|
|
23
|
+
* For example `"./pavol-hejny-cv.pdf"`
|
|
24
|
+
* For example `"Pavol Hejný has web https://pavolhejny.com/"`
|
|
25
|
+
* For example `"Pavol Hejný is web developer and creator of Promptbook and Collboard"`
|
|
19
26
|
*/
|
|
20
27
|
readonly sourceContent: string_knowledge_source_content;
|
|
21
28
|
};
|
|
@@ -30,7 +37,7 @@ export type KnowledgeSourcePreparedJson = KnowledgeSourceJson & {
|
|
|
30
37
|
/**
|
|
31
38
|
* List of preparation ids that were used to prepare this knowledge source to knowledge pieces
|
|
32
39
|
*/
|
|
33
|
-
readonly preparationIds:
|
|
40
|
+
readonly preparationIds: ReadonlyArray<number_id>;
|
|
34
41
|
};
|
|
35
42
|
/**
|
|
36
43
|
* TODO: [🍙] Make some standard order of json properties
|
|
@@ -33,7 +33,7 @@ export type ParameterJson = {
|
|
|
33
33
|
readonly sampleValues?: Array<string_parameter_value>;
|
|
34
34
|
};
|
|
35
35
|
/**
|
|
36
|
-
* TODO: [🧠]
|
|
36
|
+
* TODO: [🧠] Should be here registered subparameters from foreach or not?
|
|
37
37
|
* TODO: [♈] Probbably move expectations from templates to parameters
|
|
38
38
|
* TODO: [🍙] Make some standard order of json properties
|
|
39
39
|
*/
|
|
@@ -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:
|
|
41
|
+
readonly preparationIds: ReadonlyArray<number_id>;
|
|
42
42
|
};
|
|
43
43
|
/**
|
|
44
44
|
* TODO: [🍙] Make some standard order of json properties
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { ModelRequirements } from '../ModelRequirements';
|
|
2
|
-
import type {
|
|
2
|
+
import type { string_filename } from '../typeAliases';
|
|
3
3
|
import type { string_markdown_text } from '../typeAliases';
|
|
4
4
|
import type { string_pipeline_url } from '../typeAliases';
|
|
5
5
|
import type { string_semantic_version } from '../typeAliases';
|
|
@@ -33,7 +33,7 @@ export type PipelineJson = {
|
|
|
33
33
|
/**
|
|
34
34
|
* Internal helper for tracking the source `.ptbk.md` file of the pipeline
|
|
35
35
|
*/
|
|
36
|
-
readonly sourceFile?:
|
|
36
|
+
readonly sourceFile?: string_filename;
|
|
37
37
|
/**
|
|
38
38
|
* Title of the promptbook
|
|
39
39
|
* -It can use simple markdown formatting like **bold**, *italic*, [link](https://example.com), ... BUT not code blocks and structure
|
|
@@ -13,7 +13,7 @@ import type { Expectations } from './Expectations';
|
|
|
13
13
|
/**
|
|
14
14
|
* Common properties of all templates
|
|
15
15
|
*/
|
|
16
|
-
export
|
|
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?:
|
|
80
|
+
readonly postprocessingFunctionNames?: ReadonlyArray<string_postprocessing_function_name>;
|
|
81
81
|
/**
|
|
82
82
|
* Expectations for the answer
|
|
83
83
|
*
|
|
@@ -107,4 +107,5 @@ export type CommonPrompt = {
|
|
|
107
107
|
* TODO: [🧄] Replace all "github.com/webgptorg/promptbook#xxx" with "ptbk.io/xxx"
|
|
108
108
|
* TODO: [✔] Check ModelRequirements in runtime
|
|
109
109
|
* TODO: [🏳] Add options for translation - maybe create `TranslationPrompt`
|
|
110
|
+
* TODO: [🧠][🤺] Maybe allow overriding of `userId` for each prompt
|
|
110
111
|
*/
|
|
@@ -37,8 +37,5 @@ export type ExecutionReportJson = {
|
|
|
37
37
|
/**
|
|
38
38
|
* Sequence of templates in order which were executed
|
|
39
39
|
*/
|
|
40
|
-
readonly promptExecutions:
|
|
40
|
+
readonly promptExecutions: ReadonlyArray<ExecutionPromptReportJson>;
|
|
41
41
|
};
|
|
42
|
-
/**
|
|
43
|
-
* TODO: !!!!!! FOREACH in report
|
|
44
|
-
*/
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import type { ReadonlyDeep } from 'type-fest';
|
|
1
2
|
import type { ExecutionReportJson } from './ExecutionReportJson';
|
|
2
3
|
import type { ExecutionReportString } from './ExecutionReportString';
|
|
3
4
|
import type { ExecutionReportStringOptions } from './ExecutionReportStringOptions';
|
|
@@ -6,7 +7,7 @@ import type { ExecutionReportStringOptions } from './ExecutionReportStringOption
|
|
|
6
7
|
*
|
|
7
8
|
* @public exported from `@promptbook/core`
|
|
8
9
|
*/
|
|
9
|
-
export declare function executionReportJsonToString(executionReportJson: ExecutionReportJson
|
|
10
|
+
export declare function executionReportJsonToString(executionReportJson: ReadonlyDeep<ExecutionReportJson>, options?: Partial<ExecutionReportStringOptions>): ExecutionReportString;
|
|
10
11
|
/**
|
|
11
12
|
* TODO: Add mermaid chart for every report
|
|
12
13
|
* TODO: [🧠] Allow to filter out some parts of the report by options
|
|
@@ -156,7 +156,7 @@ export type string_knowledge_source_content = string_knowledge_source_link | str
|
|
|
156
156
|
*
|
|
157
157
|
* @@@ string_knowledge_source vs string_knowledge_source_link
|
|
158
158
|
*/
|
|
159
|
-
export type string_knowledge_source_link = string_url |
|
|
159
|
+
export type string_knowledge_source_link = string_url | string_filename;
|
|
160
160
|
/**
|
|
161
161
|
* Semantic helper
|
|
162
162
|
*
|
|
@@ -331,6 +331,13 @@ export type string_href = string;
|
|
|
331
331
|
* For example `"https://collboard.com/9SeSQTupmQHwuSrLi.png?width=1200&height=630"`
|
|
332
332
|
*/
|
|
333
333
|
export type string_url_image = string;
|
|
334
|
+
/**
|
|
335
|
+
* Semantic helper
|
|
336
|
+
*
|
|
337
|
+
* For example `"C:/Users/me/AppData/Local/Pandoc/pandoc.exe"`
|
|
338
|
+
* For example `"C:/Program Files/LibreOffice/program/swriter.exe"`
|
|
339
|
+
*/
|
|
340
|
+
export type string_executable_path = string;
|
|
334
341
|
/**
|
|
335
342
|
* Semantic helper
|
|
336
343
|
*
|
|
@@ -343,12 +350,6 @@ export type string_uri = string;
|
|
|
343
350
|
* For example `"9SeSQTupmQHwuSrLi"`
|
|
344
351
|
*/
|
|
345
352
|
export type string_uri_part = string;
|
|
346
|
-
/**
|
|
347
|
-
* Semantic helper, ID of the board used in URL and API
|
|
348
|
-
*
|
|
349
|
-
* For example `"9SeSQTupmQHwuSrLi"` <- TODO: !! Update
|
|
350
|
-
*/
|
|
351
|
-
export type string_uriid = string_uri_part;
|
|
352
353
|
/**
|
|
353
354
|
* Semantic helper
|
|
354
355
|
*
|
|
@@ -386,14 +387,23 @@ export type string_emails = string;
|
|
|
386
387
|
* - `isValidUuid to check validity
|
|
387
388
|
*
|
|
388
389
|
* For example `"5a0a153d-7be9-4018-9eda-e0e2e2b89bd9"`
|
|
390
|
+
* TODO: [🥬] Make some system for hashes and ids of promptbook
|
|
389
391
|
*/
|
|
390
392
|
export type string_uuid = string & {
|
|
391
393
|
readonly _type: 'uuid';
|
|
392
394
|
};
|
|
393
395
|
/**
|
|
394
|
-
*
|
|
396
|
+
* Application identifier
|
|
397
|
+
*
|
|
398
|
+
* @@@
|
|
399
|
+
*/
|
|
400
|
+
export type string_app_id = id;
|
|
401
|
+
/**
|
|
402
|
+
* End user identifier
|
|
403
|
+
*
|
|
404
|
+
* @@@
|
|
395
405
|
*/
|
|
396
|
-
export type string_user_id =
|
|
406
|
+
export type string_user_id = id;
|
|
397
407
|
/**
|
|
398
408
|
* Semantic helper
|
|
399
409
|
*
|
|
@@ -423,37 +433,33 @@ export type string_file_extension = string;
|
|
|
423
433
|
*
|
|
424
434
|
* For example `"C:/Users/me/work/collboard/modules-sdk/src/colldev/commands/develop/ColldevDevelop.tsx"`
|
|
425
435
|
*/
|
|
426
|
-
export type
|
|
436
|
+
export type string_absolute_filename = string;
|
|
427
437
|
/**
|
|
428
438
|
* Semantic helper
|
|
429
439
|
*
|
|
430
440
|
* For example `"./src/colldev/commands/develop/ColldevDevelop.tsx"`
|
|
431
441
|
*/
|
|
432
|
-
export type
|
|
442
|
+
export type string_relative_filename = string;
|
|
433
443
|
/**
|
|
434
444
|
* Semantic helper
|
|
435
445
|
*/
|
|
436
|
-
export type
|
|
446
|
+
export type string_filename = string_absolute_filename | string_relative_filename;
|
|
437
447
|
/**
|
|
438
448
|
* Semantic helper
|
|
439
449
|
*
|
|
440
450
|
* For example `"C:/Users/me/work/collboard/modules-sdk/src/colldev/commands/develop/ColldevDevelop.tsx"`
|
|
441
451
|
*/
|
|
442
|
-
export type
|
|
452
|
+
export type string_absolute_dirname = string;
|
|
443
453
|
/**
|
|
444
454
|
* Semantic helper
|
|
445
455
|
*
|
|
446
456
|
* For example `"./src/colldev/commands/develop/ColldevDevelop.tsx"`
|
|
447
457
|
*/
|
|
448
|
-
export type
|
|
449
|
-
/**
|
|
450
|
-
* Semantic helper
|
|
451
|
-
*/
|
|
452
|
-
export type string_folder_path = string_file_absolute_path | string_file_relative_path;
|
|
458
|
+
export type string_relative_dirname = string;
|
|
453
459
|
/**
|
|
454
460
|
* Semantic helper
|
|
455
461
|
*/
|
|
456
|
-
export type
|
|
462
|
+
export type string_dirname = string_absolute_dirname | string_relative_dirname;
|
|
457
463
|
/**
|
|
458
464
|
* Semantic helper
|
|
459
465
|
*
|
|
@@ -519,6 +525,7 @@ export type string_javascript_name = string;
|
|
|
519
525
|
* Semantic helper; For example "unwrapResult" or "spaceTrim"
|
|
520
526
|
*/
|
|
521
527
|
export type string_postprocessing_function_name = string;
|
|
528
|
+
export type id = string | number;
|
|
522
529
|
export type string_token = string;
|
|
523
530
|
export type string_license_token = string_token;
|
|
524
531
|
export type string_password = string;
|
|
@@ -592,7 +599,7 @@ export type number_megabytes = number_positive;
|
|
|
592
599
|
export type number_gigabytes = number_positive;
|
|
593
600
|
export type number_terabytes = number_positive;
|
|
594
601
|
/**.
|
|
595
|
-
* TODO:[main] !!! Change "For example" to @example
|
|
602
|
+
* TODO: [main] !!! Change "For example" to @example
|
|
596
603
|
* TODO: !! Change to branded types
|
|
597
604
|
* TODO: Delete type aliases that are not exported or used internally
|
|
598
605
|
*/
|
|
@@ -1,14 +1,27 @@
|
|
|
1
|
-
import type
|
|
1
|
+
import { type IDestroyable } from 'destroyable';
|
|
2
|
+
import type { string_name } from '../types/typeAliases';
|
|
2
3
|
import type { TODO_string } from './organization/TODO_string';
|
|
4
|
+
/**
|
|
5
|
+
* @@@
|
|
6
|
+
*/
|
|
3
7
|
export type Registered = {
|
|
4
8
|
/**
|
|
5
9
|
* @@@
|
|
6
10
|
*/
|
|
7
|
-
packageName: TODO_string;
|
|
11
|
+
readonly packageName: TODO_string;
|
|
12
|
+
/**
|
|
13
|
+
* @@@
|
|
14
|
+
*/
|
|
15
|
+
readonly className: TODO_string;
|
|
16
|
+
};
|
|
17
|
+
/**
|
|
18
|
+
* @@@
|
|
19
|
+
*/
|
|
20
|
+
export type Registration = Registered & IDestroyable & {
|
|
8
21
|
/**
|
|
9
22
|
* @@@
|
|
10
23
|
*/
|
|
11
|
-
|
|
24
|
+
readonly registerName: string_name;
|
|
12
25
|
};
|
|
13
26
|
/**
|
|
14
27
|
* Register is @@@
|
|
@@ -18,9 +31,9 @@ export type Registered = {
|
|
|
18
31
|
* @private internal utility, exported are only signleton instances of this class
|
|
19
32
|
*/
|
|
20
33
|
export declare class $Register<TRegistered extends Registered> {
|
|
21
|
-
private readonly
|
|
34
|
+
private readonly registerName;
|
|
22
35
|
private readonly storage;
|
|
23
|
-
constructor(
|
|
24
|
-
list():
|
|
25
|
-
register(registered: TRegistered):
|
|
36
|
+
constructor(registerName: string_name);
|
|
37
|
+
list(): ReadonlyArray<TRegistered>;
|
|
38
|
+
register(registered: TRegistered): Registration;
|
|
26
39
|
}
|
|
@@ -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>):
|
|
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,
|
|
11
|
+
export declare const EMOJIS_IN_CATEGORIES: Record<string, ReadonlyArray<string_char_emoji>>;
|
|
12
12
|
/**
|
|
13
13
|
*
|
|
14
14
|
* All possible emoji chars like "🍆", "🍡", "🍤"...
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
import type { ExecCommandOptions } from './ExecCommandOptions';
|
|
2
|
+
/**
|
|
3
|
+
* Run one command in a shell
|
|
4
|
+
*
|
|
5
|
+
* Note: There are 2 similar functions in the codebase:
|
|
6
|
+
* - `$execCommand` which runs a single command
|
|
7
|
+
* - `$execCommands` which runs multiple commands
|
|
8
|
+
*
|
|
9
|
+
* @public exported from `@promptbook/node`
|
|
10
|
+
*/
|
|
11
|
+
export declare function $execCommand(options: ExecCommandOptions): Promise<string>;
|
|
12
|
+
/**
|
|
13
|
+
* Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
|
|
14
|
+
*/
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Run multiple commands in a shell in sequence
|
|
3
|
+
*
|
|
4
|
+
* Note: There are 2 similar functions in the codebase:
|
|
5
|
+
* - `$execCommand` which runs a single command
|
|
6
|
+
* - `$execCommands` which runs multiple commands
|
|
7
|
+
*
|
|
8
|
+
* @public exported from `@promptbook/node`
|
|
9
|
+
*/
|
|
10
|
+
export declare function $execCommands({ commands, cwd, crashOnError, }: {
|
|
11
|
+
readonly commands: string[];
|
|
12
|
+
readonly cwd: string;
|
|
13
|
+
readonly crashOnError?: boolean;
|
|
14
|
+
}): Promise<void>;
|
|
15
|
+
/**
|
|
16
|
+
* Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
|
|
17
|
+
*/
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @deprecated Use sth from type-fest or move this to type helpers
|
|
3
|
+
*/
|
|
4
|
+
type RequiredAndOptional<TBase, TRequired extends keyof TBase, TOptional extends keyof TBase> = Pick<TBase, TRequired> & Partial<Pick<TBase, TOptional>>;
|
|
5
|
+
/**
|
|
6
|
+
* Simple options for `execCommand`
|
|
7
|
+
*/
|
|
8
|
+
export type ExecCommandOptions = string | RequiredAndOptional<ExecCommandOptionsAdvanced, 'command', 'args' | 'cwd' | 'crashOnError' | 'timeout'>;
|
|
9
|
+
/**
|
|
10
|
+
* Advanced options for `execCommand`
|
|
11
|
+
*/
|
|
12
|
+
export type ExecCommandOptionsAdvanced = {
|
|
13
|
+
readonly command: string;
|
|
14
|
+
readonly args: string[];
|
|
15
|
+
readonly cwd: string;
|
|
16
|
+
readonly crashOnError: boolean;
|
|
17
|
+
readonly timeout: number;
|
|
18
|
+
};
|
|
19
|
+
export {};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import type { ExecCommandOptions } from './ExecCommandOptions';
|
|
2
|
+
import type { ExecCommandOptionsAdvanced } from './ExecCommandOptions';
|
|
3
|
+
/**
|
|
4
|
+
* Normalize options for `execCommand` and `execCommands`
|
|
5
|
+
*
|
|
6
|
+
* @private internal utility of `execCommand` and `execCommands`
|
|
7
|
+
*/
|
|
8
|
+
export declare function execCommandNormalizeOptions(options: ExecCommandOptions): Pick<ExecCommandOptionsAdvanced, 'command' | 'args' | 'cwd' | 'crashOnError' | 'timeout'> & {
|
|
9
|
+
humanReadableCommand: string;
|
|
10
|
+
};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -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):
|
|
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,8 @@
|
|
|
1
|
+
import type { string_file_extension } from '../../types/typeAliases';
|
|
2
|
+
import type { string_mime_type } from '../../types/typeAliases';
|
|
3
|
+
/**
|
|
4
|
+
* Convert file extension to mime type
|
|
5
|
+
*
|
|
6
|
+
* @private within the repository
|
|
7
|
+
*/
|
|
8
|
+
export declare function extensionToMimeType(value: string_file_extension): string_mime_type;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|