diff --git a/CHANGELOG.md b/CHANGELOG.md index 15c0f12c..52c40d91 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,6 @@ # Changelog -## Unreleased +## 3.1.0 (2026-05-17) ### New Features diff --git a/CITATION.cff b/CITATION.cff index b7c8af10..17795cbe 100644 --- a/CITATION.cff +++ b/CITATION.cff @@ -21,5 +21,5 @@ keywords: - extension license: MIT commit: 455f0784f291c69a6c1331364f150d4fa1fb2289 -version: 3.0.1 -date-released: "2026-05-12" +version: 3.1.0 +date-released: "2026-05-17" diff --git a/docs/_environment b/docs/_environment index 96c019b9..5a372468 100644 --- a/docs/_environment +++ b/docs/_environment @@ -1 +1 @@ -VERSION=3.0.1 +VERSION=3.1.0 diff --git a/docs/api/core/archive.qmd b/docs/api/core/archive.qmd index 6cb309cd..a1328235 100644 --- a/docs/api/core/archive.qmd +++ b/docs/api/core/archive.qmd @@ -75,7 +75,7 @@ Includes protection against path traversal and zip bomb attacks. function checkPathTraversal(filePath): void; ``` -Defined in: [packages/core/src/archive/security.ts:29](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/archive/security.ts#L29) +Defined in: [packages/core/src/archive/security.ts:29](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/archive/security.ts#L29) Check for path traversal attempts in archive entry paths. @@ -99,7 +99,7 @@ SecurityError if path traversal is detected function cleanupExtraction(extractDir): Promise; ``` -Defined in: [packages/core/src/archive/extract.ts:243](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/archive/extract.ts#L243) +Defined in: [packages/core/src/archive/extract.ts:243](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/archive/extract.ts#L243) Clean up a temporary extraction directory. @@ -119,7 +119,7 @@ Clean up a temporary extraction directory. function detectArchiveFormat(archivePath): "zip" | "tarball" | null; ``` -Defined in: [packages/core/src/archive/extract.ts:43](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/archive/extract.ts#L43) +Defined in: [packages/core/src/archive/extract.ts:43](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/archive/extract.ts#L43) Detect archive format from file path. @@ -139,7 +139,7 @@ Detect archive format from file path. function extractArchive(archivePath, options?): Promise; ``` -Defined in: [packages/core/src/archive/extract.ts:64](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/archive/extract.ts#L64) +Defined in: [packages/core/src/archive/extract.ts:64](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/archive/extract.ts#L64) Extract an archive to a temporary directory. @@ -165,7 +165,7 @@ function extractTar( options?): Promise; ``` -Defined in: [packages/core/src/archive/tar.ts:34](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/archive/tar.ts#L34) +Defined in: [packages/core/src/archive/tar.ts:34](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/archive/tar.ts#L34) Extract a TAR.GZ archive to a directory. @@ -192,7 +192,7 @@ function extractZip( options?): Promise; ``` -Defined in: [packages/core/src/archive/zip.ts:34](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/archive/zip.ts#L34) +Defined in: [packages/core/src/archive/zip.ts:34](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/archive/zip.ts#L34) Extract a ZIP archive to a directory. @@ -216,7 +216,7 @@ List of extracted file paths function findAllExtensionRoots(extractDir): Promise; ``` -Defined in: [packages/core/src/archive/extract.ts:204](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/archive/extract.ts#L204) +Defined in: [packages/core/src/archive/extract.ts:204](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/archive/extract.ts#L204) Find all extension roots in an extracted archive. @@ -242,7 +242,7 @@ Array of discovered extensions function findExtensionRoot(extractDir, depth?): Promise; ``` -Defined in: [packages/core/src/archive/extract.ts:120](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/archive/extract.ts#L120) +Defined in: [packages/core/src/archive/extract.ts:120](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/archive/extract.ts#L120) Find the extension root in an extracted archive. @@ -268,7 +268,7 @@ Path to extension root or null if not found function formatSize(bytes): string; ``` -Defined in: [packages/core/src/archive/security.ts:70](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/archive/security.ts#L70) +Defined in: [packages/core/src/archive/security.ts:70](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/archive/security.ts#L70) Format a byte count for display. @@ -290,7 +290,7 @@ Human-readable size string function validateUrlProtocol(url): void; ``` -Defined in: [packages/core/src/archive/security.ts:50](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/archive/security.ts#L50) +Defined in: [packages/core/src/archive/security.ts:50](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/archive/security.ts#L50) Validate that a URL uses an allowed protocol. @@ -312,7 +312,7 @@ SecurityError if the protocol is not allowed ## DiscoveredExtension {#symbol-interface-discoveredextension} -Defined in: [packages/core/src/archive/extract.ts:159](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/archive/extract.ts#L159) +Defined in: [packages/core/src/archive/extract.ts:159](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/archive/extract.ts#L159) Information about a discovered extension in an archive. @@ -320,15 +320,15 @@ Information about a discovered extension in an archive. | Property | Type | Description | Defined in | | ------------------------------------------------- | ------------------ | --------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | `object` | Extension ID derived from directory structure. | [packages/core/src/archive/extract.ts:165](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/archive/extract.ts#L165) | -| `id.name` | `string` | - | [packages/core/src/archive/extract.ts:165](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/archive/extract.ts#L165) | -| `id.owner` | `string` \| `null` | - | [packages/core/src/archive/extract.ts:165](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/archive/extract.ts#L165) | -| `path` | `string` | Absolute path to the extension root (directory containing \_extension.yml). | [packages/core/src/archive/extract.ts:161](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/archive/extract.ts#L161) | -| `relativePath` | `string` | Path relative to the extraction root (for display purposes). | [packages/core/src/archive/extract.ts:163](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/archive/extract.ts#L163) | +| `id` | `object` | Extension ID derived from directory structure. | [packages/core/src/archive/extract.ts:165](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/archive/extract.ts#L165) | +| `id.name` | `string` | - | [packages/core/src/archive/extract.ts:165](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/archive/extract.ts#L165) | +| `id.owner` | `string` \| `null` | - | [packages/core/src/archive/extract.ts:165](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/archive/extract.ts#L165) | +| `path` | `string` | Absolute path to the extension root (directory containing \_extension.yml). | [packages/core/src/archive/extract.ts:161](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/archive/extract.ts#L161) | +| `relativePath` | `string` | Path relative to the extraction root (for display purposes). | [packages/core/src/archive/extract.ts:163](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/archive/extract.ts#L163) | ## ExtractOptions {#symbol-interface-extractoptions} -Defined in: [packages/core/src/archive/extract.ts:21](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/archive/extract.ts#L21) +Defined in: [packages/core/src/archive/extract.ts:21](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/archive/extract.ts#L21) Options for archive extraction. @@ -336,12 +336,12 @@ Options for archive extraction. | Property | Type | Description | Defined in | | ---------------------------------------------- | ------------------ | --------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `maxSize?` | `number` | Maximum total extraction size in bytes. | [packages/core/src/archive/extract.ts:23](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/archive/extract.ts#L23) | -| `onProgress?` | (`file`) => `void` | Progress callback. | [packages/core/src/archive/extract.ts:25](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/archive/extract.ts#L25) | +| `maxSize?` | `number` | Maximum total extraction size in bytes. | [packages/core/src/archive/extract.ts:23](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/archive/extract.ts#L23) | +| `onProgress?` | (`file`) => `void` | Progress callback. | [packages/core/src/archive/extract.ts:25](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/archive/extract.ts#L25) | ## ExtractResult {#symbol-interface-extractresult} -Defined in: [packages/core/src/archive/extract.ts:31](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/archive/extract.ts#L31) +Defined in: [packages/core/src/archive/extract.ts:31](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/archive/extract.ts#L31) Result of archive extraction. @@ -349,13 +349,13 @@ Result of archive extraction. | Property | Type | Description | Defined in | | --------------------------------------------- | ---------------------- | --------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `extractDir` | `string` | Path to the extraction directory. | [packages/core/src/archive/extract.ts:33](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/archive/extract.ts#L33) | -| `files` | `string[]` | List of extracted file paths. | [packages/core/src/archive/extract.ts:35](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/archive/extract.ts#L35) | -| `format` | `"zip"` \| `"tarball"` | Detected archive format. | [packages/core/src/archive/extract.ts:37](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/archive/extract.ts#L37) | +| `extractDir` | `string` | Path to the extraction directory. | [packages/core/src/archive/extract.ts:33](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/archive/extract.ts#L33) | +| `files` | `string[]` | List of extracted file paths. | [packages/core/src/archive/extract.ts:35](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/archive/extract.ts#L35) | +| `format` | `"zip"` \| `"tarball"` | Detected archive format. | [packages/core/src/archive/extract.ts:37](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/archive/extract.ts#L37) | ## TarExtractOptions {#symbol-interface-tarextractoptions} -Defined in: [packages/core/src/archive/tar.ts:19](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/archive/tar.ts#L19) +Defined in: [packages/core/src/archive/tar.ts:19](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/archive/tar.ts#L19) Options for TAR extraction. @@ -363,12 +363,12 @@ Options for TAR extraction. | Property | Type | Description | Defined in | | ---------------------------------------------- | ------------------ | --------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `maxSize?` | `number` | Maximum total extraction size in bytes. | [packages/core/src/archive/tar.ts:21](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/archive/tar.ts#L21) | -| `onProgress?` | (`file`) => `void` | Progress callback. | [packages/core/src/archive/tar.ts:23](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/archive/tar.ts#L23) | +| `maxSize?` | `number` | Maximum total extraction size in bytes. | [packages/core/src/archive/tar.ts:21](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/archive/tar.ts#L21) | +| `onProgress?` | (`file`) => `void` | Progress callback. | [packages/core/src/archive/tar.ts:23](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/archive/tar.ts#L23) | ## ZipExtractOptions {#symbol-interface-zipextractoptions} -Defined in: [packages/core/src/archive/zip.ts:19](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/archive/zip.ts#L19) +Defined in: [packages/core/src/archive/zip.ts:19](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/archive/zip.ts#L19) Options for ZIP extraction. @@ -376,8 +376,8 @@ Options for ZIP extraction. | Property | Type | Description | Defined in | | ---------------------------------------------- | ------------------ | --------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `maxSize?` | `number` | Maximum total extraction size in bytes. | [packages/core/src/archive/zip.ts:21](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/archive/zip.ts#L21) | -| `onProgress?` | (`file`) => `void` | Progress callback. | [packages/core/src/archive/zip.ts:23](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/archive/zip.ts#L23) | +| `maxSize?` | `number` | Maximum total extraction size in bytes. | [packages/core/src/archive/zip.ts:21](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/archive/zip.ts#L21) | +| `onProgress?` | (`file`) => `void` | Progress callback. | [packages/core/src/archive/zip.ts:23](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/archive/zip.ts#L23) | ## DEFAULT_MAX_SIZE {#symbol-variable-default-max-size} @@ -385,7 +385,7 @@ Options for ZIP extraction. const DEFAULT_MAX_SIZE: number; ``` -Defined in: [packages/core/src/archive/security.ts:15](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/archive/security.ts#L15) +Defined in: [packages/core/src/archive/security.ts:15](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/archive/security.ts#L15) Default maximum extraction size: 100 MB. @@ -395,7 +395,7 @@ Default maximum extraction size: 100 MB. const MAX_COMPRESSION_RATIO: 100 = 100; ``` -Defined in: [packages/core/src/archive/security.ts:18](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/archive/security.ts#L18) +Defined in: [packages/core/src/archive/security.ts:18](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/archive/security.ts#L18) Maximum compression ratio allowed. @@ -405,6 +405,6 @@ Maximum compression ratio allowed. const MAX_FILE_COUNT: 10000 = 10_000; ``` -Defined in: [packages/core/src/archive/security.ts:21](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/archive/security.ts#L21) +Defined in: [packages/core/src/archive/security.ts:21](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/archive/security.ts#L21) Maximum number of entries allowed in an archive. diff --git a/docs/api/core/auth.qmd b/docs/api/core/auth.qmd index 791edcf6..fde11a0d 100644 --- a/docs/api/core/auth.qmd +++ b/docs/api/core/auth.qmd @@ -50,7 +50,7 @@ Tokens can also be set via VS Code settings or the extension's authentication UI function createAuthConfig(options?): AuthConfig; ``` -Defined in: [packages/core/src/types/auth.ts:66](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/types/auth.ts#L66) +Defined in: [packages/core/src/types/auth.ts:66](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/types/auth.ts#L66) Create an AuthConfig from options. Automatically reads from environment variables if not provided. @@ -77,7 +77,7 @@ Error if header format is invalid function getAuthHeaders(auth, isGitHub): Record; ``` -Defined in: [packages/core/src/types/auth.ts:107](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/types/auth.ts#L107) +Defined in: [packages/core/src/types/auth.ts:107](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/types/auth.ts#L107) Get authorization headers for a request. @@ -96,7 +96,7 @@ Headers object for fetch ## AuthConfig {#symbol-interface-authconfig} -Defined in: [packages/core/src/types/auth.ts:41](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/types/auth.ts#L41) +Defined in: [packages/core/src/types/auth.ts:41](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/types/auth.ts#L41) Authentication configuration for API requests. @@ -104,12 +104,12 @@ Authentication configuration for API requests. | Property | Type | Description | Defined in | | ------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `githubToken?` | `string` | GitHub personal access token for GitHub API and private repos. | [packages/core/src/types/auth.ts:43](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/types/auth.ts#L43) | -| `httpHeaders` | `HttpHeader[]`{=html} | Custom HTTP headers for URL downloads. | [packages/core/src/types/auth.ts:45](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/types/auth.ts#L45) | +| `githubToken?` | `string` | GitHub personal access token for GitHub API and private repos. | [packages/core/src/types/auth.ts:43](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/types/auth.ts#L43) | +| `httpHeaders` | `HttpHeader[]`{=html} | Custom HTTP headers for URL downloads. | [packages/core/src/types/auth.ts:45](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/types/auth.ts#L45) | ## AuthConfigOptions {#symbol-interface-authconfigoptions} -Defined in: [packages/core/src/types/auth.ts:51](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/types/auth.ts#L51) +Defined in: [packages/core/src/types/auth.ts:51](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/types/auth.ts#L51) Options for creating an AuthConfig. @@ -117,12 +117,12 @@ Options for creating an AuthConfig. | Property | Type | Description | Defined in | | ------------------------------------------------ | ---------- | ------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `githubToken?` | `string` | GitHub personal access token. | [packages/core/src/types/auth.ts:53](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/types/auth.ts#L53) | -| `httpHeaders?` | `string[]` | HTTP headers in "Name: Value" format. | [packages/core/src/types/auth.ts:55](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/types/auth.ts#L55) | +| `githubToken?` | `string` | GitHub personal access token. | [packages/core/src/types/auth.ts:53](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/types/auth.ts#L53) | +| `httpHeaders?` | `string[]` | HTTP headers in "Name: Value" format. | [packages/core/src/types/auth.ts:55](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/types/auth.ts#L55) | ## HttpHeader {#symbol-interface-httpheader} -Defined in: [packages/core/src/types/auth.ts:31](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/types/auth.ts#L31) +Defined in: [packages/core/src/types/auth.ts:31](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/types/auth.ts#L31) HTTP header for custom authentication. @@ -130,5 +130,5 @@ HTTP header for custom authentication. | Property | Type | Description | Defined in | | ----------------------------------- | -------- | --------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `name` | `string` | Header name (e.g., "Authorization"). | [packages/core/src/types/auth.ts:33](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/types/auth.ts#L33) | -| `value` | `string` | Header value (e.g., "Bearer token123"). | [packages/core/src/types/auth.ts:35](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/types/auth.ts#L35) | +| `name` | `string` | Header name (e.g., "Authorization"). | [packages/core/src/types/auth.ts:33](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/types/auth.ts#L33) | +| `value` | `string` | Header value (e.g., "Bearer token123"). | [packages/core/src/types/auth.ts:35](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/types/auth.ts#L35) | diff --git a/docs/api/core/constants.qmd b/docs/api/core/constants.qmd index 7027bec7..61eaebb8 100644 --- a/docs/api/core/constants.qmd +++ b/docs/api/core/constants.qmd @@ -14,6 +14,6 @@ title: "Constants" const USER_AGENT: "quarto-wizard" = "quarto-wizard"; ``` -Defined in: [packages/core/src/constants.ts:2](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/constants.ts#L2) +Defined in: [packages/core/src/constants.ts:2](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/constants.ts#L2) User-Agent header value for all outgoing HTTP requests. diff --git a/docs/api/core/errors.qmd b/docs/api/core/errors.qmd index 65adec1f..6f4be08f 100644 --- a/docs/api/core/errors.qmd +++ b/docs/api/core/errors.qmd @@ -35,7 +35,7 @@ Provides typed error classes for handling various failure scenarios. ## AuthenticationError {#symbol-class-authenticationerror} -Defined in: [packages/core/src/errors.ts:66](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/errors.ts#L66) +Defined in: [packages/core/src/errors.ts:66](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/errors.ts#L66) Error when authentication is required or failed. @@ -51,7 +51,7 @@ Error when authentication is required or failed. new AuthenticationError(message, options?): AuthenticationError; ``` -Defined in: [packages/core/src/errors.ts:67](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/errors.ts#L67) +Defined in: [packages/core/src/errors.ts:67](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/errors.ts#L67) ##### Parameters @@ -89,7 +89,7 @@ Defined in: node_modules/typescript/lib/lib.es2022.error.d.ts:24 readonly code: string; ``` -Defined in: [packages/core/src/errors.ts:25](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/errors.ts#L25) +Defined in: [packages/core/src/errors.ts:25](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/errors.ts#L25) Error code for programmatic handling. @@ -139,7 +139,7 @@ Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076 readonly optional suggestion?: string; ``` -Defined in: [packages/core/src/errors.ts:27](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/errors.ts#L27) +Defined in: [packages/core/src/errors.ts:27](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/errors.ts#L27) Suggestion for how to resolve the error. @@ -177,7 +177,7 @@ not capture any frames. format(): string; ``` -Defined in: [packages/core/src/errors.ts:44](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/errors.ts#L44) +Defined in: [packages/core/src/errors.ts:44](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/errors.ts#L44) Format the error for display. @@ -285,7 +285,7 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces ## CancellationError {#symbol-class-cancellationerror} -Defined in: [packages/core/src/errors.ts:175](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/errors.ts#L175) +Defined in: [packages/core/src/errors.ts:175](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/errors.ts#L175) Error thrown when an operation is cancelled by the user. @@ -305,7 +305,7 @@ fragile string matching. new CancellationError(message?): CancellationError; ``` -Defined in: [packages/core/src/errors.ts:176](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/errors.ts#L176) +Defined in: [packages/core/src/errors.ts:176](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/errors.ts#L176) ##### Parameters @@ -341,7 +341,7 @@ Defined in: node_modules/typescript/lib/lib.es2022.error.d.ts:24 readonly code: string; ``` -Defined in: [packages/core/src/errors.ts:25](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/errors.ts#L25) +Defined in: [packages/core/src/errors.ts:25](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/errors.ts#L25) Error code for programmatic handling. @@ -391,7 +391,7 @@ Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076 readonly optional suggestion?: string; ``` -Defined in: [packages/core/src/errors.ts:27](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/errors.ts#L27) +Defined in: [packages/core/src/errors.ts:27](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/errors.ts#L27) Suggestion for how to resolve the error. @@ -429,7 +429,7 @@ not capture any frames. format(): string; ``` -Defined in: [packages/core/src/errors.ts:44](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/errors.ts#L44) +Defined in: [packages/core/src/errors.ts:44](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/errors.ts#L44) Format the error for display. @@ -537,7 +537,7 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces ## ExtensionError {#symbol-class-extensionerror} -Defined in: [packages/core/src/errors.ts:56](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/errors.ts#L56) +Defined in: [packages/core/src/errors.ts:56](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/errors.ts#L56) Error related to extension operations (install, update, remove). @@ -553,7 +553,7 @@ Error related to extension operations (install, update, remove). new ExtensionError(message, options?): ExtensionError; ``` -Defined in: [packages/core/src/errors.ts:57](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/errors.ts#L57) +Defined in: [packages/core/src/errors.ts:57](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/errors.ts#L57) ##### Parameters @@ -590,7 +590,7 @@ Defined in: node_modules/typescript/lib/lib.es2022.error.d.ts:24 readonly code: string; ``` -Defined in: [packages/core/src/errors.ts:25](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/errors.ts#L25) +Defined in: [packages/core/src/errors.ts:25](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/errors.ts#L25) Error code for programmatic handling. @@ -640,7 +640,7 @@ Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076 readonly optional suggestion?: string; ``` -Defined in: [packages/core/src/errors.ts:27](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/errors.ts#L27) +Defined in: [packages/core/src/errors.ts:27](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/errors.ts#L27) Suggestion for how to resolve the error. @@ -678,7 +678,7 @@ not capture any frames. format(): string; ``` -Defined in: [packages/core/src/errors.ts:44](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/errors.ts#L44) +Defined in: [packages/core/src/errors.ts:44](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/errors.ts#L44) Format the error for display. @@ -786,7 +786,7 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces ## ManifestError {#symbol-class-manifesterror} -Defined in: [packages/core/src/errors.ts:144](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/errors.ts#L144) +Defined in: [packages/core/src/errors.ts:144](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/errors.ts#L144) Error when parsing a manifest file fails. @@ -802,7 +802,7 @@ Error when parsing a manifest file fails. new ManifestError(message, options?): ManifestError; ``` -Defined in: [packages/core/src/errors.ts:148](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/errors.ts#L148) +Defined in: [packages/core/src/errors.ts:148](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/errors.ts#L148) ##### Parameters @@ -841,7 +841,7 @@ Defined in: node_modules/typescript/lib/lib.es2022.error.d.ts:24 readonly code: string; ``` -Defined in: [packages/core/src/errors.ts:25](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/errors.ts#L25) +Defined in: [packages/core/src/errors.ts:25](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/errors.ts#L25) Error code for programmatic handling. @@ -855,7 +855,7 @@ Error code for programmatic handling. readonly optional manifestPath?: string; ``` -Defined in: [packages/core/src/errors.ts:146](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/errors.ts#L146) +Defined in: [packages/core/src/errors.ts:146](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/errors.ts#L146) Path to the manifest file. @@ -901,7 +901,7 @@ Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076 readonly optional suggestion?: string; ``` -Defined in: [packages/core/src/errors.ts:27](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/errors.ts#L27) +Defined in: [packages/core/src/errors.ts:27](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/errors.ts#L27) Suggestion for how to resolve the error. @@ -939,7 +939,7 @@ not capture any frames. format(): string; ``` -Defined in: [packages/core/src/errors.ts:44](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/errors.ts#L44) +Defined in: [packages/core/src/errors.ts:44](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/errors.ts#L44) Format the error for display. @@ -1047,7 +1047,7 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces ## NetworkError {#symbol-class-networkerror} -Defined in: [packages/core/src/errors.ts:92](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/errors.ts#L92) +Defined in: [packages/core/src/errors.ts:92](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/errors.ts#L92) Error related to network operations. @@ -1067,7 +1067,7 @@ Error related to network operations. new NetworkError(message, options?): NetworkError; ``` -Defined in: [packages/core/src/errors.ts:96](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/errors.ts#L96) +Defined in: [packages/core/src/errors.ts:96](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/errors.ts#L96) ##### Parameters @@ -1106,7 +1106,7 @@ Defined in: node_modules/typescript/lib/lib.es2022.error.d.ts:24 readonly code: string; ``` -Defined in: [packages/core/src/errors.ts:25](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/errors.ts#L25) +Defined in: [packages/core/src/errors.ts:25](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/errors.ts#L25) Error code for programmatic handling. @@ -1156,7 +1156,7 @@ Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076 readonly optional statusCode?: number; ``` -Defined in: [packages/core/src/errors.ts:94](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/errors.ts#L94) +Defined in: [packages/core/src/errors.ts:94](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/errors.ts#L94) HTTP status code if available. @@ -1166,7 +1166,7 @@ HTTP status code if available. readonly optional suggestion?: string; ``` -Defined in: [packages/core/src/errors.ts:27](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/errors.ts#L27) +Defined in: [packages/core/src/errors.ts:27](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/errors.ts#L27) Suggestion for how to resolve the error. @@ -1204,7 +1204,7 @@ not capture any frames. format(): string; ``` -Defined in: [packages/core/src/errors.ts:44](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/errors.ts#L44) +Defined in: [packages/core/src/errors.ts:44](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/errors.ts#L44) Format the error for display. @@ -1312,7 +1312,7 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces ## QuartoWizardError {#symbol-class-quartowizarderror} -Defined in: [packages/core/src/errors.ts:23](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/errors.ts#L23) +Defined in: [packages/core/src/errors.ts:23](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/errors.ts#L23) Base error class for all Quarto Wizard errors. @@ -1342,7 +1342,7 @@ new QuartoWizardError( options?): QuartoWizardError; ``` -Defined in: [packages/core/src/errors.ts:29](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/errors.ts#L29) +Defined in: [packages/core/src/errors.ts:29](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/errors.ts#L29) ##### Parameters @@ -1384,7 +1384,7 @@ Error.cause readonly code: string; ``` -Defined in: [packages/core/src/errors.ts:25](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/errors.ts#L25) +Defined in: [packages/core/src/errors.ts:25](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/errors.ts#L25) Error code for programmatic handling. @@ -1436,7 +1436,7 @@ Error.stack readonly optional suggestion?: string; ``` -Defined in: [packages/core/src/errors.ts:27](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/errors.ts#L27) +Defined in: [packages/core/src/errors.ts:27](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/errors.ts#L27) Suggestion for how to resolve the error. @@ -1472,7 +1472,7 @@ Error.stackTraceLimit format(): string; ``` -Defined in: [packages/core/src/errors.ts:44](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/errors.ts#L44) +Defined in: [packages/core/src/errors.ts:44](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/errors.ts#L44) Format the error for display. @@ -1580,7 +1580,7 @@ Error.prepareStackTrace ## RepositoryNotFoundError {#symbol-class-repositorynotfounderror} -Defined in: [packages/core/src/errors.ts:79](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/errors.ts#L79) +Defined in: [packages/core/src/errors.ts:79](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/errors.ts#L79) Error when a repository or resource is not found. @@ -1596,7 +1596,7 @@ Error when a repository or resource is not found. new RepositoryNotFoundError(message, options?): RepositoryNotFoundError; ``` -Defined in: [packages/core/src/errors.ts:80](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/errors.ts#L80) +Defined in: [packages/core/src/errors.ts:80](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/errors.ts#L80) ##### Parameters @@ -1635,7 +1635,7 @@ Defined in: node_modules/typescript/lib/lib.es2022.error.d.ts:24 readonly code: string; ``` -Defined in: [packages/core/src/errors.ts:25](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/errors.ts#L25) +Defined in: [packages/core/src/errors.ts:25](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/errors.ts#L25) Error code for programmatic handling. @@ -1685,7 +1685,7 @@ Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076 readonly optional suggestion?: string; ``` -Defined in: [packages/core/src/errors.ts:27](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/errors.ts#L27) +Defined in: [packages/core/src/errors.ts:27](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/errors.ts#L27) Suggestion for how to resolve the error. @@ -1723,7 +1723,7 @@ not capture any frames. format(): string; ``` -Defined in: [packages/core/src/errors.ts:44](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/errors.ts#L44) +Defined in: [packages/core/src/errors.ts:44](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/errors.ts#L44) Format the error for display. @@ -1831,7 +1831,7 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces ## SamlSsoError {#symbol-class-samlssoerror} -Defined in: [packages/core/src/errors.ts:113](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/errors.ts#L113) +Defined in: [packages/core/src/errors.ts:113](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/errors.ts#L113) Error thrown when a GitHub organisation enforces SAML SSO and the token has not been authorised for that organisation. @@ -1851,7 +1851,7 @@ containing the URL the user must visit to authorise their token. new SamlSsoError(message, options): SamlSsoError; ``` -Defined in: [packages/core/src/errors.ts:117](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/errors.ts#L117) +Defined in: [packages/core/src/errors.ts:117](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/errors.ts#L117) ##### Parameters @@ -1878,7 +1878,7 @@ Defined in: [packages/core/src/errors.ts:117](https://github.com/mcanouil/quarto readonly authorizationUrl: string; ``` -Defined in: [packages/core/src/errors.ts:115](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/errors.ts#L115) +Defined in: [packages/core/src/errors.ts:115](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/errors.ts#L115) URL provided by GitHub to authorise the token for SAML SSO. @@ -1900,7 +1900,7 @@ Defined in: node_modules/typescript/lib/lib.es2022.error.d.ts:24 readonly code: string; ``` -Defined in: [packages/core/src/errors.ts:25](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/errors.ts#L25) +Defined in: [packages/core/src/errors.ts:25](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/errors.ts#L25) Error code for programmatic handling. @@ -1950,7 +1950,7 @@ Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076 readonly optional statusCode?: number; ``` -Defined in: [packages/core/src/errors.ts:94](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/errors.ts#L94) +Defined in: [packages/core/src/errors.ts:94](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/errors.ts#L94) HTTP status code if available. @@ -1964,7 +1964,7 @@ HTTP status code if available. readonly optional suggestion?: string; ``` -Defined in: [packages/core/src/errors.ts:27](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/errors.ts#L27) +Defined in: [packages/core/src/errors.ts:27](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/errors.ts#L27) Suggestion for how to resolve the error. @@ -2002,7 +2002,7 @@ not capture any frames. format(): string; ``` -Defined in: [packages/core/src/errors.ts:44](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/errors.ts#L44) +Defined in: [packages/core/src/errors.ts:44](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/errors.ts#L44) Format the error for display. @@ -2110,7 +2110,7 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces ## SecurityError {#symbol-class-securityerror} -Defined in: [packages/core/src/errors.ts:134](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/errors.ts#L134) +Defined in: [packages/core/src/errors.ts:134](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/errors.ts#L134) Error related to security issues (path traversal, zip bombs, etc.). @@ -2126,7 +2126,7 @@ Error related to security issues (path traversal, zip bombs, etc.). new SecurityError(message, options?): SecurityError; ``` -Defined in: [packages/core/src/errors.ts:135](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/errors.ts#L135) +Defined in: [packages/core/src/errors.ts:135](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/errors.ts#L135) ##### Parameters @@ -2164,7 +2164,7 @@ Defined in: node_modules/typescript/lib/lib.es2022.error.d.ts:24 readonly code: string; ``` -Defined in: [packages/core/src/errors.ts:25](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/errors.ts#L25) +Defined in: [packages/core/src/errors.ts:25](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/errors.ts#L25) Error code for programmatic handling. @@ -2214,7 +2214,7 @@ Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076 readonly optional suggestion?: string; ``` -Defined in: [packages/core/src/errors.ts:27](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/errors.ts#L27) +Defined in: [packages/core/src/errors.ts:27](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/errors.ts#L27) Suggestion for how to resolve the error. @@ -2252,7 +2252,7 @@ not capture any frames. format(): string; ``` -Defined in: [packages/core/src/errors.ts:44](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/errors.ts#L44) +Defined in: [packages/core/src/errors.ts:44](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/errors.ts#L44) Format the error for display. @@ -2360,7 +2360,7 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces ## VersionError {#symbol-class-versionerror} -Defined in: [packages/core/src/errors.ts:161](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/errors.ts#L161) +Defined in: [packages/core/src/errors.ts:161](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/errors.ts#L161) Error when a version cannot be resolved. @@ -2376,7 +2376,7 @@ Error when a version cannot be resolved. new VersionError(message, options?): VersionError; ``` -Defined in: [packages/core/src/errors.ts:162](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/errors.ts#L162) +Defined in: [packages/core/src/errors.ts:162](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/errors.ts#L162) ##### Parameters @@ -2413,7 +2413,7 @@ Defined in: node_modules/typescript/lib/lib.es2022.error.d.ts:24 readonly code: string; ``` -Defined in: [packages/core/src/errors.ts:25](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/errors.ts#L25) +Defined in: [packages/core/src/errors.ts:25](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/errors.ts#L25) Error code for programmatic handling. @@ -2463,7 +2463,7 @@ Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076 readonly optional suggestion?: string; ``` -Defined in: [packages/core/src/errors.ts:27](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/errors.ts#L27) +Defined in: [packages/core/src/errors.ts:27](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/errors.ts#L27) Suggestion for how to resolve the error. @@ -2501,7 +2501,7 @@ not capture any frames. format(): string; ``` -Defined in: [packages/core/src/errors.ts:44](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/errors.ts#L44) +Defined in: [packages/core/src/errors.ts:44](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/errors.ts#L44) Format the error for display. @@ -2613,7 +2613,7 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces function getErrorMessage(error): string; ``` -Defined in: [packages/core/src/errors.ts:199](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/errors.ts#L199) +Defined in: [packages/core/src/errors.ts:199](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/errors.ts#L199) Extract a human-readable message from an unknown error value. @@ -2633,7 +2633,7 @@ Extract a human-readable message from an unknown error value. function isCancellationError(error): error is CancellationError; ``` -Defined in: [packages/core/src/errors.ts:185](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/errors.ts#L185) +Defined in: [packages/core/src/errors.ts:185](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/errors.ts#L185) Check if an error is a CancellationError. @@ -2653,7 +2653,7 @@ Check if an error is a CancellationError. function isQuartoWizardError(error): error is QuartoWizardError; ``` -Defined in: [packages/core/src/errors.ts:192](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/errors.ts#L192) +Defined in: [packages/core/src/errors.ts:192](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/errors.ts#L192) Check if an error is a QuartoWizardError. @@ -2673,7 +2673,7 @@ Check if an error is a QuartoWizardError. function isSamlSsoError(error): error is SamlSsoError; ``` -Defined in: [packages/core/src/errors.ts:127](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/errors.ts#L127) +Defined in: [packages/core/src/errors.ts:127](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/errors.ts#L127) Check if an error is a SamlSsoError. @@ -2693,7 +2693,7 @@ Check if an error is a SamlSsoError. function wrapError(error, context?): QuartoWizardError; ``` -Defined in: [packages/core/src/errors.ts:206](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/errors.ts#L206) +Defined in: [packages/core/src/errors.ts:206](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/errors.ts#L206) Wrap an unknown error as a QuartoWizardError. @@ -2710,7 +2710,7 @@ Wrap an unknown error as a QuartoWizardError. ## QuartoWizardErrorOptions {#symbol-interface-quartowizarderroroptions} -Defined in: [packages/core/src/errors.ts:13](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/errors.ts#L13) +Defined in: [packages/core/src/errors.ts:13](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/errors.ts#L13) Options for constructing a QuartoWizardError. @@ -2718,5 +2718,5 @@ Options for constructing a QuartoWizardError. | Property | Type | Description | Defined in | | ---------------------------------------------- | --------- | ---------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `cause?` | `unknown` | Original error that caused this error. | [packages/core/src/errors.ts:17](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/errors.ts#L17) | -| `suggestion?` | `string` | Suggestion for how to resolve the error. | [packages/core/src/errors.ts:15](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/errors.ts#L15) | +| `cause?` | `unknown` | Original error that caused this error. | [packages/core/src/errors.ts:17](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/errors.ts#L17) | +| `suggestion?` | `string` | Suggestion for how to resolve the error. | [packages/core/src/errors.ts:15](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/errors.ts#L15) | diff --git a/docs/api/core/filesystem.qmd b/docs/api/core/filesystem.qmd index 4b3f60a0..4bfe1b6f 100644 --- a/docs/api/core/filesystem.qmd +++ b/docs/api/core/filesystem.qmd @@ -77,7 +77,7 @@ Provides recursive directory traversal and file copying operations. function collectFiles(directory): Promise; ``` -Defined in: [packages/core/src/filesystem/walk.ts:62](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/filesystem/walk.ts#L62) +Defined in: [packages/core/src/filesystem/walk.ts:62](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/filesystem/walk.ts#L62) Collect all file paths in a directory recursively. @@ -99,7 +99,7 @@ Array of file paths function copyDirectory(sourceDir, targetDir): Promise; ``` -Defined in: [packages/core/src/filesystem/walk.ts:99](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/filesystem/walk.ts#L99) +Defined in: [packages/core/src/filesystem/walk.ts:99](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/filesystem/walk.ts#L99) Copy a directory recursively. @@ -122,7 +122,7 @@ Array of created file paths function discoverInstalledExtensions(projectDir, options?): Promise; ``` -Defined in: [packages/core/src/filesystem/discovery.ts:82](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/filesystem/discovery.ts#L82) +Defined in: [packages/core/src/filesystem/discovery.ts:82](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/filesystem/discovery.ts#L82) Discover all installed extensions in a project. @@ -159,7 +159,7 @@ for (const ext of extensions) { function discoverInstalledExtensionsSync(projectDir, options?): InstalledExtension[]; ``` -Defined in: [packages/core/src/filesystem/discovery.ts:99](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/filesystem/discovery.ts#L99) +Defined in: [packages/core/src/filesystem/discovery.ts:99](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/filesystem/discovery.ts#L99) Synchronous version of discoverInstalledExtensions. @@ -184,7 +184,7 @@ function findInstalledExtension(projectDir, extensionId): Promise< | null>; ``` -Defined in: [packages/core/src/filesystem/discovery.ts:203](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/filesystem/discovery.ts#L203) +Defined in: [packages/core/src/filesystem/discovery.ts:203](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/filesystem/discovery.ts#L203) Find a specific installed extension by ID. @@ -209,7 +209,7 @@ InstalledExtension or null if not found function findManifestFile(directory): string | null; ``` -Defined in: [packages/core/src/filesystem/manifest.ts:38](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/filesystem/manifest.ts#L38) +Defined in: [packages/core/src/filesystem/manifest.ts:38](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/filesystem/manifest.ts#L38) Find the manifest file in a directory. @@ -231,7 +231,7 @@ Path to manifest file or null if not found function getExtensionInstallPath(projectDir, extensionId): string; ``` -Defined in: [packages/core/src/filesystem/discovery.ts:239](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/filesystem/discovery.ts#L239) +Defined in: [packages/core/src/filesystem/discovery.ts:239](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/filesystem/discovery.ts#L239) Get the installation path for an extension. @@ -254,7 +254,7 @@ Path where the extension should be installed function getExtensionsDir(projectDir): string; ``` -Defined in: [packages/core/src/filesystem/discovery.ts:48](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/filesystem/discovery.ts#L48) +Defined in: [packages/core/src/filesystem/discovery.ts:48](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/filesystem/discovery.ts#L48) Get the extensions directory path for a project. @@ -276,7 +276,7 @@ Path to \_extensions directory function hasExtensionsDir(projectDir): boolean; ``` -Defined in: [packages/core/src/filesystem/discovery.ts:58](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/filesystem/discovery.ts#L58) +Defined in: [packages/core/src/filesystem/discovery.ts:58](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/filesystem/discovery.ts#L58) Check if an extensions directory exists. @@ -298,7 +298,7 @@ True if \_extensions directory exists function hasManifest(directory): boolean; ``` -Defined in: [packages/core/src/filesystem/manifest.ts:127](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/filesystem/manifest.ts#L127) +Defined in: [packages/core/src/filesystem/manifest.ts:127](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/filesystem/manifest.ts#L127) Check if a directory contains a manifest file. @@ -320,7 +320,7 @@ True if manifest exists function parseManifestContent(content, sourcePath?): ExtensionManifest; ``` -Defined in: [packages/core/src/filesystem/manifest.ts:78](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/filesystem/manifest.ts#L78) +Defined in: [packages/core/src/filesystem/manifest.ts:78](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/filesystem/manifest.ts#L78) Parse manifest content from a YAML string. @@ -347,7 +347,7 @@ ManifestError if parsing fails function parseManifestFile(manifestPath): ExtensionManifest; ``` -Defined in: [packages/core/src/filesystem/manifest.ts:55](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/filesystem/manifest.ts#L55) +Defined in: [packages/core/src/filesystem/manifest.ts:55](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/filesystem/manifest.ts#L55) Parse a manifest file from a path. @@ -373,7 +373,7 @@ ManifestError if parsing fails function pathExists(filePath): Promise; ``` -Defined in: [packages/core/src/filesystem/walk.ts:83](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/filesystem/walk.ts#L83) +Defined in: [packages/core/src/filesystem/walk.ts:83](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/filesystem/walk.ts#L83) Async check whether a path exists on disk. @@ -400,7 +400,7 @@ function readManifest(directory): | null; ``` -Defined in: [packages/core/src/filesystem/manifest.ts:104](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/filesystem/manifest.ts#L104) +Defined in: [packages/core/src/filesystem/manifest.ts:104](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/filesystem/manifest.ts#L104) Read a manifest from a directory. @@ -426,7 +426,7 @@ function updateManifestSource( sourceType?): void; ``` -Defined in: [packages/core/src/filesystem/manifest.ts:197](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/filesystem/manifest.ts#L197) +Defined in: [packages/core/src/filesystem/manifest.ts:197](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/filesystem/manifest.ts#L197) Update the source field in an existing manifest file. @@ -448,7 +448,7 @@ Update the source field in an existing manifest file. function walkDirectory(directory, callback): Promise; ``` -Defined in: [packages/core/src/filesystem/walk.ts:37](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/filesystem/walk.ts#L37) +Defined in: [packages/core/src/filesystem/walk.ts:37](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/filesystem/walk.ts#L37) Walk a directory recursively, calling the callback for each entry. @@ -469,7 +469,7 @@ Walk a directory recursively, calling the callback for each entry. function writeManifest(manifestPath, manifest): void; ``` -Defined in: [packages/core/src/filesystem/manifest.ts:137](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/filesystem/manifest.ts#L137) +Defined in: [packages/core/src/filesystem/manifest.ts:137](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/filesystem/manifest.ts#L137) Write a manifest to a file. @@ -486,7 +486,7 @@ Write a manifest to a file. ## DiscoveryOptions {#symbol-interface-discoveryoptions} -Defined in: [packages/core/src/filesystem/discovery.ts:37](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/filesystem/discovery.ts#L37) +Defined in: [packages/core/src/filesystem/discovery.ts:37](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/filesystem/discovery.ts#L37) Options for extension discovery. @@ -494,11 +494,11 @@ Options for extension discovery. | Property | Type | Description | Defined in | | ------------------------------------------------------ | --------- | ------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `includeInvalid?` | `boolean` | Include extensions without valid manifests. | [packages/core/src/filesystem/discovery.ts:39](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/filesystem/discovery.ts#L39) | +| `includeInvalid?` | `boolean` | Include extensions without valid manifests. | [packages/core/src/filesystem/discovery.ts:39](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/filesystem/discovery.ts#L39) | ## InstalledExtension {#symbol-interface-installedextension} -Defined in: [packages/core/src/filesystem/discovery.ts:23](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/filesystem/discovery.ts#L23) +Defined in: [packages/core/src/filesystem/discovery.ts:23](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/filesystem/discovery.ts#L23) An installed extension discovered on the filesystem. @@ -506,14 +506,14 @@ An installed extension discovered on the filesystem. | Property | Type | Description | Defined in | | ------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `directory` | `string` | Full path to the extension directory. | [packages/core/src/filesystem/discovery.ts:31](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/filesystem/discovery.ts#L31) | -| `id` | [`ExtensionId`](types.qmd#symbol-interface-extensionid) | Extension identifier. | [packages/core/src/filesystem/discovery.ts:25](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/filesystem/discovery.ts#L25) | -| `manifest` | [`ExtensionManifest`](types.qmd#symbol-interface-extensionmanifest) | Parsed manifest data. | [packages/core/src/filesystem/discovery.ts:27](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/filesystem/discovery.ts#L27) | -| `manifestPath` | `string` | Full path to the manifest file. | [packages/core/src/filesystem/discovery.ts:29](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/filesystem/discovery.ts#L29) | +| `directory` | `string` | Full path to the extension directory. | [packages/core/src/filesystem/discovery.ts:31](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/filesystem/discovery.ts#L31) | +| `id` | [`ExtensionId`](types.qmd#symbol-interface-extensionid) | Extension identifier. | [packages/core/src/filesystem/discovery.ts:25](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/filesystem/discovery.ts#L25) | +| `manifest` | [`ExtensionManifest`](types.qmd#symbol-interface-extensionmanifest) | Parsed manifest data. | [packages/core/src/filesystem/discovery.ts:27](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/filesystem/discovery.ts#L27) | +| `manifestPath` | `string` | Full path to the manifest file. | [packages/core/src/filesystem/discovery.ts:29](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/filesystem/discovery.ts#L29) | ## ManifestReadResult {#symbol-interface-manifestreadresult} -Defined in: [packages/core/src/filesystem/manifest.ts:23](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/filesystem/manifest.ts#L23) +Defined in: [packages/core/src/filesystem/manifest.ts:23](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/filesystem/manifest.ts#L23) Result of reading a manifest file. @@ -521,13 +521,13 @@ Result of reading a manifest file. | Property | Type | Description | Defined in | | ------------------------------------------------- | ------------------------------------------------------------------- | ---------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `filename` | `string` | Filename used (e.g., "\_extension.yml"). | [packages/core/src/filesystem/manifest.ts:29](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/filesystem/manifest.ts#L29) | -| `manifest` | [`ExtensionManifest`](types.qmd#symbol-interface-extensionmanifest) | Parsed manifest data. | [packages/core/src/filesystem/manifest.ts:25](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/filesystem/manifest.ts#L25) | -| `manifestPath` | `string` | Full path to the manifest file. | [packages/core/src/filesystem/manifest.ts:27](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/filesystem/manifest.ts#L27) | +| `filename` | `string` | Filename used (e.g., "\_extension.yml"). | [packages/core/src/filesystem/manifest.ts:29](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/filesystem/manifest.ts#L29) | +| `manifest` | [`ExtensionManifest`](types.qmd#symbol-interface-extensionmanifest) | Parsed manifest data. | [packages/core/src/filesystem/manifest.ts:25](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/filesystem/manifest.ts#L25) | +| `manifestPath` | `string` | Full path to the manifest file. | [packages/core/src/filesystem/manifest.ts:27](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/filesystem/manifest.ts#L27) | ## WalkEntry {#symbol-interface-walkentry} -Defined in: [packages/core/src/filesystem/walk.ts:16](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/filesystem/walk.ts#L16) +Defined in: [packages/core/src/filesystem/walk.ts:16](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/filesystem/walk.ts#L16) Entry information for directory walking. @@ -535,9 +535,9 @@ Entry information for directory walking. | Property | Type | Description | Defined in | | ----------------------------------------------- | --------- | ----------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `isDirectory` | `boolean` | Whether entry is a directory. | [packages/core/src/filesystem/walk.ts:22](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/filesystem/walk.ts#L22) | -| `name` | `string` | Entry name (basename). | [packages/core/src/filesystem/walk.ts:20](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/filesystem/walk.ts#L20) | -| `path` | `string` | Full path to the entry. | [packages/core/src/filesystem/walk.ts:18](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/filesystem/walk.ts#L18) | +| `isDirectory` | `boolean` | Whether entry is a directory. | [packages/core/src/filesystem/walk.ts:22](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/filesystem/walk.ts#L22) | +| `name` | `string` | Entry name (basename). | [packages/core/src/filesystem/walk.ts:20](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/filesystem/walk.ts#L20) | +| `path` | `string` | Full path to the entry. | [packages/core/src/filesystem/walk.ts:18](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/filesystem/walk.ts#L18) | ## WalkCallback {#symbol-typealias-walkcallback} @@ -545,7 +545,7 @@ Entry information for directory walking. type WalkCallback = (entry) => boolean | void | Promise; ``` -Defined in: [packages/core/src/filesystem/walk.ts:29](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/filesystem/walk.ts#L29) +Defined in: [packages/core/src/filesystem/walk.ts:29](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/filesystem/walk.ts#L29) Callback for directory walking. Return false to skip processing children of a directory. @@ -566,7 +566,7 @@ Return false to skip processing children of a directory. const EXTENSIONS_DIR: "_extensions" = "_extensions"; ``` -Defined in: [packages/core/src/filesystem/discovery.ts:18](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/filesystem/discovery.ts#L18) +Defined in: [packages/core/src/filesystem/discovery.ts:18](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/filesystem/discovery.ts#L18) Name of the extensions directory. @@ -576,6 +576,6 @@ Name of the extensions directory. const MANIFEST_FILENAMES: readonly ["_extension.yml", "_extension.yaml"]; ``` -Defined in: [packages/core/src/filesystem/manifest.ts:18](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/filesystem/manifest.ts#L18) +Defined in: [packages/core/src/filesystem/manifest.ts:18](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/filesystem/manifest.ts#L18) Supported manifest file names. diff --git a/docs/api/core/github.qmd b/docs/api/core/github.qmd index 3174e045..6fe13329 100644 --- a/docs/api/core/github.qmd +++ b/docs/api/core/github.qmd @@ -56,7 +56,7 @@ function constructArchiveUrl( format?): string; ``` -Defined in: [packages/core/src/github/releases.ts:146](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/github/releases.ts#L146) +Defined in: [packages/core/src/github/releases.ts:146](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/github/releases.ts#L146) Construct a GitHub archive URL. @@ -82,7 +82,7 @@ Archive URL function downloadArchive(url, options?): Promise; ``` -Defined in: [packages/core/src/github/download.ts:126](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/github/download.ts#L126) +Defined in: [packages/core/src/github/download.ts:126](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/github/download.ts#L126) Download an archive from a URL. @@ -111,7 +111,7 @@ Path to downloaded file function downloadFromUrl(url, options?): Promise; ``` -Defined in: [packages/core/src/github/download.ts:290](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/github/download.ts#L290) +Defined in: [packages/core/src/github/download.ts:290](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/github/download.ts#L290) Download from a custom URL (non-GitHub). @@ -143,7 +143,7 @@ function downloadGitHubArchive( options?): Promise; ``` -Defined in: [packages/core/src/github/download.ts:70](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/github/download.ts#L70) +Defined in: [packages/core/src/github/download.ts:70](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/github/download.ts#L70) Download an archive from GitHub. @@ -171,7 +171,7 @@ function fetchReleases( options?): Promise; ``` -Defined in: [packages/core/src/github/releases.ts:266](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/github/releases.ts#L266) +Defined in: [packages/core/src/github/releases.ts:266](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/github/releases.ts#L266) Fetch releases for a repository. @@ -198,7 +198,7 @@ function fetchTags( options?): Promise; ``` -Defined in: [packages/core/src/github/releases.ts:307](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/github/releases.ts#L307) +Defined in: [packages/core/src/github/releases.ts:307](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/github/releases.ts#L307) Fetch tags for a repository. @@ -225,7 +225,7 @@ function getLatestRelease( options?): Promise; ``` -Defined in: [packages/core/src/github/releases.ts:338](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/github/releases.ts#L338) +Defined in: [packages/core/src/github/releases.ts:338](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/github/releases.ts#L338) Get the latest release for a repository. @@ -253,7 +253,7 @@ function resolveVersion( options?): Promise; ``` -Defined in: [packages/core/src/github/releases.ts:356](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/github/releases.ts#L356) +Defined in: [packages/core/src/github/releases.ts:356](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/github/releases.ts#L356) Resolve a version specification to a release or tag. @@ -274,7 +274,7 @@ Resolved release/tag info with download URL ## DownloadOptions {#symbol-interface-downloadoptions} -Defined in: [packages/core/src/github/download.ts:38](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/github/download.ts#L38) +Defined in: [packages/core/src/github/download.ts:38](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/github/download.ts#L38) Options for downloading archives. @@ -286,19 +286,19 @@ Options for downloading archives. | Property | Type | Description | Inherited from | Defined in | | -------------------------------------------------------------- | ---------------------------------------------------------------------------------- | --------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `auth?` | [`AuthConfig`](auth.qmd#symbol-interface-authconfig) | Authentication configuration. | [`ResolveVersionOptions`](github.qmd#symbol-interface-resolveversionoptions).[`auth`](github.qmd#symbol-interface-resolveversionoptions-property-auth) | [packages/core/src/github/releases.ts:84](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/github/releases.ts#L84) | -| `defaultBranch?` | `string` | Default branch to use when no releases/tags exist. | [`ResolveVersionOptions`](github.qmd#symbol-interface-resolveversionoptions).[`defaultBranch`](github.qmd#symbol-interface-resolveversionoptions-property-defaultbranch) | [packages/core/src/github/releases.ts:98](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/github/releases.ts#L98) | -| `downloadDir?` | `string` | Custom download directory (uses temp by default). | - | [packages/core/src/github/download.ts:44](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/github/download.ts#L44) | -| `format?` | `"zip"` \| `"tarball"` | Preferred archive format. | - | [packages/core/src/github/download.ts:40](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/github/download.ts#L40) | -| `includePrereleases?` | `boolean` | Include prereleases when resolving versions. | [`ResolveVersionOptions`](github.qmd#symbol-interface-resolveversionoptions).[`includePrereleases`](github.qmd#symbol-interface-resolveversionoptions-property-includeprereleases) | [packages/core/src/github/releases.ts:88](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/github/releases.ts#L88) | -| `latestCommit?` | `string` | Latest commit SHA on default branch (for fallback). | [`ResolveVersionOptions`](github.qmd#symbol-interface-resolveversionoptions).[`latestCommit`](github.qmd#symbol-interface-resolveversionoptions-property-latestcommit) | [packages/core/src/github/releases.ts:100](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/github/releases.ts#L100) | -| `onProgress?` | [`DownloadProgressCallback`](github.qmd#symbol-typealias-downloadprogresscallback) | Progress callback. | - | [packages/core/src/github/download.ts:42](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/github/download.ts#L42) | -| `signal?` | `AbortSignal` | AbortSignal for cancellation. | [`ResolveVersionOptions`](github.qmd#symbol-interface-resolveversionoptions).[`signal`](github.qmd#symbol-interface-resolveversionoptions-property-signal) | [packages/core/src/github/releases.ts:90](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/github/releases.ts#L90) | -| `timeout?` | `number` | Request timeout in milliseconds. | [`ResolveVersionOptions`](github.qmd#symbol-interface-resolveversionoptions).[`timeout`](github.qmd#symbol-interface-resolveversionoptions-property-timeout) | [packages/core/src/github/releases.ts:86](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/github/releases.ts#L86) | +| `auth?` | [`AuthConfig`](auth.qmd#symbol-interface-authconfig) | Authentication configuration. | [`ResolveVersionOptions`](github.qmd#symbol-interface-resolveversionoptions).[`auth`](github.qmd#symbol-interface-resolveversionoptions-property-auth) | [packages/core/src/github/releases.ts:84](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/github/releases.ts#L84) | +| `defaultBranch?` | `string` | Default branch to use when no releases/tags exist. | [`ResolveVersionOptions`](github.qmd#symbol-interface-resolveversionoptions).[`defaultBranch`](github.qmd#symbol-interface-resolveversionoptions-property-defaultbranch) | [packages/core/src/github/releases.ts:98](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/github/releases.ts#L98) | +| `downloadDir?` | `string` | Custom download directory (uses temp by default). | - | [packages/core/src/github/download.ts:44](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/github/download.ts#L44) | +| `format?` | `"zip"` \| `"tarball"` | Preferred archive format. | - | [packages/core/src/github/download.ts:40](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/github/download.ts#L40) | +| `includePrereleases?` | `boolean` | Include prereleases when resolving versions. | [`ResolveVersionOptions`](github.qmd#symbol-interface-resolveversionoptions).[`includePrereleases`](github.qmd#symbol-interface-resolveversionoptions-property-includeprereleases) | [packages/core/src/github/releases.ts:88](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/github/releases.ts#L88) | +| `latestCommit?` | `string` | Latest commit SHA on default branch (for fallback). | [`ResolveVersionOptions`](github.qmd#symbol-interface-resolveversionoptions).[`latestCommit`](github.qmd#symbol-interface-resolveversionoptions-property-latestcommit) | [packages/core/src/github/releases.ts:100](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/github/releases.ts#L100) | +| `onProgress?` | [`DownloadProgressCallback`](github.qmd#symbol-typealias-downloadprogresscallback) | Progress callback. | - | [packages/core/src/github/download.ts:42](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/github/download.ts#L42) | +| `signal?` | `AbortSignal` | AbortSignal for cancellation. | [`ResolveVersionOptions`](github.qmd#symbol-interface-resolveversionoptions).[`signal`](github.qmd#symbol-interface-resolveversionoptions-property-signal) | [packages/core/src/github/releases.ts:90](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/github/releases.ts#L90) | +| `timeout?` | `number` | Request timeout in milliseconds. | [`ResolveVersionOptions`](github.qmd#symbol-interface-resolveversionoptions).[`timeout`](github.qmd#symbol-interface-resolveversionoptions-property-timeout) | [packages/core/src/github/releases.ts:86](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/github/releases.ts#L86) | ## DownloadResult {#symbol-interface-downloadresult} -Defined in: [packages/core/src/github/download.ts:50](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/github/download.ts#L50) +Defined in: [packages/core/src/github/download.ts:50](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/github/download.ts#L50) Result of a download operation. @@ -306,14 +306,14 @@ Result of a download operation. | Property | Type | Description | Defined in | | ----------------------------------------------- | ---------------------- | -------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `archivePath` | `string` | Path to the downloaded archive. | [packages/core/src/github/download.ts:52](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/github/download.ts#L52) | -| `commitSha?` | `string` | Commit SHA if resolved to a commit (first 7 characters). | [packages/core/src/github/download.ts:58](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/github/download.ts#L58) | -| `format` | `"zip"` \| `"tarball"` | Archive format. | [packages/core/src/github/download.ts:56](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/github/download.ts#L56) | -| `tagName` | `string` | Resolved tag/version name. | [packages/core/src/github/download.ts:54](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/github/download.ts#L54) | +| `archivePath` | `string` | Path to the downloaded archive. | [packages/core/src/github/download.ts:52](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/github/download.ts#L52) | +| `commitSha?` | `string` | Commit SHA if resolved to a commit (first 7 characters). | [packages/core/src/github/download.ts:58](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/github/download.ts#L58) | +| `format` | `"zip"` \| `"tarball"` | Archive format. | [packages/core/src/github/download.ts:56](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/github/download.ts#L56) | +| `tagName` | `string` | Resolved tag/version name. | [packages/core/src/github/download.ts:54](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/github/download.ts#L54) | ## GitHubOptions {#symbol-interface-githuboptions} -Defined in: [packages/core/src/github/releases.ts:82](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/github/releases.ts#L82) +Defined in: [packages/core/src/github/releases.ts:82](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/github/releases.ts#L82) Options for GitHub API requests. @@ -325,14 +325,14 @@ Options for GitHub API requests. | Property | Type | Description | Defined in | | -------------------------------------------------------------- | ---------------------------------------------------- | -------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `auth?` | [`AuthConfig`](auth.qmd#symbol-interface-authconfig) | Authentication configuration. | [packages/core/src/github/releases.ts:84](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/github/releases.ts#L84) | -| `includePrereleases?` | `boolean` | Include prereleases when resolving versions. | [packages/core/src/github/releases.ts:88](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/github/releases.ts#L88) | -| `signal?` | `AbortSignal` | AbortSignal for cancellation. | [packages/core/src/github/releases.ts:90](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/github/releases.ts#L90) | -| `timeout?` | `number` | Request timeout in milliseconds. | [packages/core/src/github/releases.ts:86](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/github/releases.ts#L86) | +| `auth?` | [`AuthConfig`](auth.qmd#symbol-interface-authconfig) | Authentication configuration. | [packages/core/src/github/releases.ts:84](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/github/releases.ts#L84) | +| `includePrereleases?` | `boolean` | Include prereleases when resolving versions. | [packages/core/src/github/releases.ts:88](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/github/releases.ts#L88) | +| `signal?` | `AbortSignal` | AbortSignal for cancellation. | [packages/core/src/github/releases.ts:90](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/github/releases.ts#L90) | +| `timeout?` | `number` | Request timeout in milliseconds. | [packages/core/src/github/releases.ts:86](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/github/releases.ts#L86) | ## GitHubRelease {#symbol-interface-githubrelease} -Defined in: [packages/core/src/github/releases.ts:22](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/github/releases.ts#L22) +Defined in: [packages/core/src/github/releases.ts:22](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/github/releases.ts#L22) GitHub release information. @@ -340,18 +340,18 @@ GitHub release information. | Property | Type | Description | Defined in | | ----------------------------------------------- | --------- | ---------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `draft` | `boolean` | Whether this is a draft. | [packages/core/src/github/releases.ts:38](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/github/releases.ts#L38) | -| `htmlUrl` | `string` | URL to the release page. | [packages/core/src/github/releases.ts:32](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/github/releases.ts#L32) | -| `name` | `string` | Release name/title. | [packages/core/src/github/releases.ts:26](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/github/releases.ts#L26) | -| `prerelease` | `boolean` | Whether this is a prerelease. | [packages/core/src/github/releases.ts:36](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/github/releases.ts#L36) | -| `publishedAt` | `string` | ISO timestamp when published. | [packages/core/src/github/releases.ts:34](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/github/releases.ts#L34) | -| `tagName` | `string` | Release tag name (e.g., "v1.0.0"). | [packages/core/src/github/releases.ts:24](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/github/releases.ts#L24) | -| `tarballUrl` | `string` | URL to download the tarball. | [packages/core/src/github/releases.ts:30](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/github/releases.ts#L30) | -| `zipballUrl` | `string` | URL to download the zipball. | [packages/core/src/github/releases.ts:28](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/github/releases.ts#L28) | +| `draft` | `boolean` | Whether this is a draft. | [packages/core/src/github/releases.ts:38](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/github/releases.ts#L38) | +| `htmlUrl` | `string` | URL to the release page. | [packages/core/src/github/releases.ts:32](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/github/releases.ts#L32) | +| `name` | `string` | Release name/title. | [packages/core/src/github/releases.ts:26](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/github/releases.ts#L26) | +| `prerelease` | `boolean` | Whether this is a prerelease. | [packages/core/src/github/releases.ts:36](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/github/releases.ts#L36) | +| `publishedAt` | `string` | ISO timestamp when published. | [packages/core/src/github/releases.ts:34](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/github/releases.ts#L34) | +| `tagName` | `string` | Release tag name (e.g., "v1.0.0"). | [packages/core/src/github/releases.ts:24](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/github/releases.ts#L24) | +| `tarballUrl` | `string` | URL to download the tarball. | [packages/core/src/github/releases.ts:30](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/github/releases.ts#L30) | +| `zipballUrl` | `string` | URL to download the zipball. | [packages/core/src/github/releases.ts:28](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/github/releases.ts#L28) | ## GitHubTag {#symbol-interface-githubtag} -Defined in: [packages/core/src/github/releases.ts:44](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/github/releases.ts#L44) +Defined in: [packages/core/src/github/releases.ts:44](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/github/releases.ts#L44) GitHub tag information. @@ -359,14 +359,14 @@ GitHub tag information. | Property | Type | Description | Defined in | | --------------------------------------------- | -------- | ---------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `name` | `string` | Tag name. | [packages/core/src/github/releases.ts:46](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/github/releases.ts#L46) | -| `sha` | `string` | Commit SHA. | [packages/core/src/github/releases.ts:48](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/github/releases.ts#L48) | -| `tarballUrl` | `string` | URL to download the tarball. | [packages/core/src/github/releases.ts:52](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/github/releases.ts#L52) | -| `zipballUrl` | `string` | URL to download the zipball. | [packages/core/src/github/releases.ts:50](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/github/releases.ts#L50) | +| `name` | `string` | Tag name. | [packages/core/src/github/releases.ts:46](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/github/releases.ts#L46) | +| `sha` | `string` | Commit SHA. | [packages/core/src/github/releases.ts:48](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/github/releases.ts#L48) | +| `tarballUrl` | `string` | URL to download the tarball. | [packages/core/src/github/releases.ts:52](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/github/releases.ts#L52) | +| `zipballUrl` | `string` | URL to download the zipball. | [packages/core/src/github/releases.ts:50](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/github/releases.ts#L50) | ## ResolvedVersion {#symbol-interface-resolvedversion} -Defined in: [packages/core/src/github/releases.ts:106](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/github/releases.ts#L106) +Defined in: [packages/core/src/github/releases.ts:106](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/github/releases.ts#L106) Result of version resolution. @@ -374,14 +374,14 @@ Result of version resolution. | Property | Type | Description | Defined in | | --------------------------------------------- | -------- | -------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `commitSha?` | `string` | Commit SHA if resolved to a commit (first 7 characters). | [packages/core/src/github/releases.ts:114](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/github/releases.ts#L114) | -| `tagName` | `string` | Resolved tag/version name. | [packages/core/src/github/releases.ts:108](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/github/releases.ts#L108) | -| `tarballUrl` | `string` | URL to download the tarball. | [packages/core/src/github/releases.ts:112](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/github/releases.ts#L112) | -| `zipballUrl` | `string` | URL to download the zipball. | [packages/core/src/github/releases.ts:110](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/github/releases.ts#L110) | +| `commitSha?` | `string` | Commit SHA if resolved to a commit (first 7 characters). | [packages/core/src/github/releases.ts:114](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/github/releases.ts#L114) | +| `tagName` | `string` | Resolved tag/version name. | [packages/core/src/github/releases.ts:108](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/github/releases.ts#L108) | +| `tarballUrl` | `string` | URL to download the tarball. | [packages/core/src/github/releases.ts:112](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/github/releases.ts#L112) | +| `zipballUrl` | `string` | URL to download the zipball. | [packages/core/src/github/releases.ts:110](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/github/releases.ts#L110) | ## ResolveVersionOptions {#symbol-interface-resolveversionoptions} -Defined in: [packages/core/src/github/releases.ts:96](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/github/releases.ts#L96) +Defined in: [packages/core/src/github/releases.ts:96](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/github/releases.ts#L96) Options for version resolution. @@ -397,12 +397,12 @@ Options for version resolution. | Property | Type | Description | Inherited from | Defined in | | -------------------------------------------------------------- | ---------------------------------------------------- | --------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `auth?` | [`AuthConfig`](auth.qmd#symbol-interface-authconfig) | Authentication configuration. | [`GitHubOptions`](github.qmd#symbol-interface-githuboptions).[`auth`](github.qmd#symbol-interface-githuboptions-property-auth) | [packages/core/src/github/releases.ts:84](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/github/releases.ts#L84) | -| `defaultBranch?` | `string` | Default branch to use when no releases/tags exist. | - | [packages/core/src/github/releases.ts:98](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/github/releases.ts#L98) | -| `includePrereleases?` | `boolean` | Include prereleases when resolving versions. | [`GitHubOptions`](github.qmd#symbol-interface-githuboptions).[`includePrereleases`](github.qmd#symbol-interface-githuboptions-property-includeprereleases) | [packages/core/src/github/releases.ts:88](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/github/releases.ts#L88) | -| `latestCommit?` | `string` | Latest commit SHA on default branch (for fallback). | - | [packages/core/src/github/releases.ts:100](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/github/releases.ts#L100) | -| `signal?` | `AbortSignal` | AbortSignal for cancellation. | [`GitHubOptions`](github.qmd#symbol-interface-githuboptions).[`signal`](github.qmd#symbol-interface-githuboptions-property-signal) | [packages/core/src/github/releases.ts:90](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/github/releases.ts#L90) | -| `timeout?` | `number` | Request timeout in milliseconds. | [`GitHubOptions`](github.qmd#symbol-interface-githuboptions).[`timeout`](github.qmd#symbol-interface-githuboptions-property-timeout) | [packages/core/src/github/releases.ts:86](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/github/releases.ts#L86) | +| `auth?` | [`AuthConfig`](auth.qmd#symbol-interface-authconfig) | Authentication configuration. | [`GitHubOptions`](github.qmd#symbol-interface-githuboptions).[`auth`](github.qmd#symbol-interface-githuboptions-property-auth) | [packages/core/src/github/releases.ts:84](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/github/releases.ts#L84) | +| `defaultBranch?` | `string` | Default branch to use when no releases/tags exist. | - | [packages/core/src/github/releases.ts:98](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/github/releases.ts#L98) | +| `includePrereleases?` | `boolean` | Include prereleases when resolving versions. | [`GitHubOptions`](github.qmd#symbol-interface-githuboptions).[`includePrereleases`](github.qmd#symbol-interface-githuboptions-property-includeprereleases) | [packages/core/src/github/releases.ts:88](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/github/releases.ts#L88) | +| `latestCommit?` | `string` | Latest commit SHA on default branch (for fallback). | - | [packages/core/src/github/releases.ts:100](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/github/releases.ts#L100) | +| `signal?` | `AbortSignal` | AbortSignal for cancellation. | [`GitHubOptions`](github.qmd#symbol-interface-githuboptions).[`signal`](github.qmd#symbol-interface-githuboptions-property-signal) | [packages/core/src/github/releases.ts:90](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/github/releases.ts#L90) | +| `timeout?` | `number` | Request timeout in milliseconds. | [`GitHubOptions`](github.qmd#symbol-interface-githuboptions).[`timeout`](github.qmd#symbol-interface-githuboptions-property-timeout) | [packages/core/src/github/releases.ts:86](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/github/releases.ts#L86) | ## DownloadProgressCallback {#symbol-typealias-downloadprogresscallback} @@ -410,7 +410,7 @@ Options for version resolution. type DownloadProgressCallback = (progress) => void; ``` -Defined in: [packages/core/src/github/download.ts:27](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/github/download.ts#L27) +Defined in: [packages/core/src/github/download.ts:27](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/github/download.ts#L27) Progress callback for downloads. diff --git a/docs/api/core/operations.qmd b/docs/api/core/operations.qmd index 97e10425..787d74c5 100644 --- a/docs/api/core/operations.qmd +++ b/docs/api/core/operations.qmd @@ -120,7 +120,7 @@ Combines installation with template file copying for starter templates. function applySourceOwner(extensions, source): void; ``` -Defined in: [packages/core/src/operations/install.ts:631](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/install.ts#L631) +Defined in: [packages/core/src/operations/install.ts:631](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/install.ts#L631) Apply GitHub owner to all discovered extensions. When installing from GitHub, extensions are namespaced under the repository owner. @@ -142,7 +142,7 @@ When installing from GitHub, extensions are namespaced under the repository owne function applyUpdates(updates, options): Promise; ``` -Defined in: [packages/core/src/operations/update.ts:331](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/update.ts#L331) +Defined in: [packages/core/src/operations/update.ts:331](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/update.ts#L331) Apply updates to extensions. @@ -165,7 +165,7 @@ Update result function checkForBrandExtension(dir): BrandExtensionInfo; ``` -Defined in: [packages/core/src/operations/brand.ts:91](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/brand.ts#L91) +Defined in: [packages/core/src/operations/brand.ts:91](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/brand.ts#L91) Check if a directory contains a brand extension. @@ -189,7 +189,7 @@ Brand extension info function checkForUpdates(options): Promise; ``` -Defined in: [packages/core/src/operations/update.ts:100](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/update.ts#L100) +Defined in: [packages/core/src/operations/update.ts:100](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/update.ts#L100) Check for available updates. @@ -211,7 +211,7 @@ Array of available updates function extractBrandFilePaths(brandYamlPath, onWarning?): string[]; ``` -Defined in: [packages/core/src/operations/brand.ts:299](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/brand.ts#L299) +Defined in: [packages/core/src/operations/brand.ts:299](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/brand.ts#L299) Extract all local file paths referenced in a brand YAML file. @@ -240,7 +240,7 @@ Array of unique relative file paths function findBrandFile(stagedDir): BrandFileInfo | null; ``` -Defined in: [packages/core/src/operations/brand.ts:136](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/brand.ts#L136) +Defined in: [packages/core/src/operations/brand.ts:136](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/brand.ts#L136) Find the brand file in a staged directory. @@ -268,7 +268,7 @@ Brand file info or null if not found function formatInstallSource(source): string; ``` -Defined in: [packages/core/src/operations/install.ts:254](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/install.ts#L254) +Defined in: [packages/core/src/operations/install.ts:254](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/install.ts#L254) Format an install source as a string. @@ -288,7 +288,7 @@ Format an install source as a string. function getTemplateFiles(sourceRoot, exclude?): Promise; ``` -Defined in: [packages/core/src/operations/use.ts:804](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/use.ts#L804) +Defined in: [packages/core/src/operations/use.ts:804](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/use.ts#L804) Get list of template files that would be copied from repo root. @@ -311,7 +311,7 @@ List of template file paths function install(source, options): Promise; ``` -Defined in: [packages/core/src/operations/install.ts:303](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/install.ts#L303) +Defined in: [packages/core/src/operations/install.ts:303](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/install.ts#L303) Install an extension from a source. @@ -356,7 +356,7 @@ function installSingleExtension( sourceType?): Promise; ``` -Defined in: [packages/core/src/operations/install.ts:733](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/install.ts#L733) +Defined in: [packages/core/src/operations/install.ts:733](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/install.ts#L733) Install a single extension from an already-extracted directory. Used for installing additional extensions when multiple are selected, @@ -386,7 +386,7 @@ Installation result function normaliseVersion(version): string | null; ``` -Defined in: [packages/core/src/operations/update.ts:435](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/update.ts#L435) +Defined in: [packages/core/src/operations/update.ts:435](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/update.ts#L435) Normalise a version string for comparison. Strips leading "v" prefix and coerces to valid semver. @@ -409,7 +409,7 @@ Normalised semver string, or null if invalid function parseInstallSource(input, checkExists?): InstallSource; ``` -Defined in: [packages/core/src/operations/install.ts:174](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/install.ts#L174) +Defined in: [packages/core/src/operations/install.ts:174](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/install.ts#L174) Parse an install source string. @@ -452,7 +452,7 @@ parseInstallSource("./my-extension"); function remove(extensionId, options): Promise; ``` -Defined in: [packages/core/src/operations/remove.ts:58](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/remove.ts#L58) +Defined in: [packages/core/src/operations/remove.ts:58](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/remove.ts#L58) Remove an installed extension. @@ -490,7 +490,7 @@ function removeMultiple(extensionIds, options): Promise<( })[]>; ``` -Defined in: [packages/core/src/operations/remove.ts:97](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/remove.ts#L97) +Defined in: [packages/core/src/operations/remove.ts:97](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/remove.ts#L97) Remove multiple extensions. @@ -518,7 +518,7 @@ Array of removal results function resolveStagedDir(extractDir): string; ``` -Defined in: [packages/core/src/operations/brand.ts:467](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/brand.ts#L467) +Defined in: [packages/core/src/operations/brand.ts:467](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/brand.ts#L467) Resolve the staged directory from a downloaded/extracted archive. @@ -545,7 +545,7 @@ function selectExtensionsFromSource(allExtensions, selectExtension?): Promise< | null>; ``` -Defined in: [packages/core/src/operations/install.ts:647](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/install.ts#L647) +Defined in: [packages/core/src/operations/install.ts:647](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/install.ts#L647) Select extensions from a list using an optional callback. Returns null if the user cancelled. @@ -571,7 +571,7 @@ Selected extensions, or null if cancelled function update(options): Promise; ``` -Defined in: [packages/core/src/operations/update.ts:388](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/update.ts#L388) +Defined in: [packages/core/src/operations/update.ts:388](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/update.ts#L388) Check and apply updates in one operation. @@ -593,7 +593,7 @@ Update result function use(source, options): Promise; ``` -Defined in: [packages/core/src/operations/use.ts:528](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/use.ts#L528) +Defined in: [packages/core/src/operations/use.ts:528](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/use.ts#L528) Install an extension and optionally copy template files. @@ -616,7 +616,7 @@ Use result function useBrand(source, options): Promise; ``` -Defined in: [packages/core/src/operations/brand.ts:615](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/brand.ts#L615) +Defined in: [packages/core/src/operations/brand.ts:615](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/brand.ts#L615) Download and apply a Quarto brand to a project. @@ -648,7 +648,7 @@ const result = await useBrand("mcanouil/quarto-mcanouil", { ## BrandExtensionInfo {#symbol-interface-brandextensioninfo} -Defined in: [packages/core/src/operations/brand.ts:28](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/brand.ts#L28) +Defined in: [packages/core/src/operations/brand.ts:28](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/brand.ts#L28) Result of brand extension detection. @@ -656,13 +656,13 @@ Result of brand extension detection. | Property | Type | Description | Defined in | | --------------------------------------------------------- | --------- | ------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `brandFileName?` | `string` | The brand file name declared in the extension manifest. | [packages/core/src/operations/brand.ts:34](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/brand.ts#L34) | -| `extensionDir?` | `string` | Directory containing the brand extension. | [packages/core/src/operations/brand.ts:32](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/brand.ts#L32) | -| `isBrandExtension` | `boolean` | Whether a brand extension was found. | [packages/core/src/operations/brand.ts:30](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/brand.ts#L30) | +| `brandFileName?` | `string` | The brand file name declared in the extension manifest. | [packages/core/src/operations/brand.ts:34](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/brand.ts#L34) | +| `extensionDir?` | `string` | Directory containing the brand extension. | [packages/core/src/operations/brand.ts:32](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/brand.ts#L32) | +| `isBrandExtension` | `boolean` | Whether a brand extension was found. | [packages/core/src/operations/brand.ts:30](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/brand.ts#L30) | ## BrandFileInfo {#symbol-interface-brandfileinfo} -Defined in: [packages/core/src/operations/brand.ts:40](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/brand.ts#L40) +Defined in: [packages/core/src/operations/brand.ts:40](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/brand.ts#L40) Located brand file information. @@ -670,13 +670,13 @@ Located brand file information. | Property | Type | Description | Defined in | | --------------------------------------------------------- | --------- | ------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `brandFileDir` | `string` | Directory containing the brand file (for resolving relative paths). | [packages/core/src/operations/brand.ts:44](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/brand.ts#L44) | -| `brandFilePath` | `string` | Absolute path to the brand YAML file. | [packages/core/src/operations/brand.ts:42](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/brand.ts#L42) | -| `isBrandExtension` | `boolean` | Whether the brand was found via a brand extension. | [packages/core/src/operations/brand.ts:46](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/brand.ts#L46) | +| `brandFileDir` | `string` | Directory containing the brand file (for resolving relative paths). | [packages/core/src/operations/brand.ts:44](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/brand.ts#L44) | +| `brandFilePath` | `string` | Absolute path to the brand YAML file. | [packages/core/src/operations/brand.ts:42](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/brand.ts#L42) | +| `isBrandExtension` | `boolean` | Whether the brand was found via a brand extension. | [packages/core/src/operations/brand.ts:46](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/brand.ts#L46) | ## FileSelectionResult {#symbol-interface-fileselectionresult} -Defined in: [packages/core/src/operations/use.ts:154](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/use.ts#L154) +Defined in: [packages/core/src/operations/use.ts:154](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/use.ts#L154) Result of file selection callback. @@ -684,12 +684,12 @@ Result of file selection callback. | Property | Type | Description | Defined in | | ----------------------------------------------------------- | ---------- | ------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `overwriteExisting` | `boolean` | Whether to overwrite existing files without prompting. | [packages/core/src/operations/use.ts:158](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/use.ts#L158) | -| `selectedFiles` | `string[]` | Files selected for copying. | [packages/core/src/operations/use.ts:156](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/use.ts#L156) | +| `overwriteExisting` | `boolean` | Whether to overwrite existing files without prompting. | [packages/core/src/operations/use.ts:158](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/use.ts#L158) | +| `selectedFiles` | `string[]` | Files selected for copying. | [packages/core/src/operations/use.ts:156](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/use.ts#L156) | ## InstallOptions {#symbol-interface-installoptions} -Defined in: [packages/core/src/operations/install.ts:77](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/install.ts#L77) +Defined in: [packages/core/src/operations/install.ts:77](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/install.ts#L77) Options for extension installation. @@ -701,27 +701,27 @@ Options for extension installation. | Property | Type | Description | Overrides | Inherited from | Defined in | | -------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `auth?` | [`AuthConfig`](auth.qmd#symbol-interface-authconfig) | Authentication configuration. | [`RegistryOptions`](registry.qmd#symbol-interface-registryoptions).[`auth`](registry.qmd#symbol-interface-registryoptions-property-auth) | - | [packages/core/src/operations/install.ts:81](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/install.ts#L81) | -| `cacheDir?` | `string` | Cache directory (uses platform default if not provided). | - | [`RegistryOptions`](registry.qmd#symbol-interface-registryoptions).[`cacheDir`](registry.qmd#symbol-interface-registryoptions-property-cachedir) | [packages/core/src/registry/fetcher.ts:27](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/registry/fetcher.ts#L27) | -| `cacheTtl?` | `number` | Cache TTL in milliseconds (default: 24 hours). | - | [`RegistryOptions`](registry.qmd#symbol-interface-registryoptions).[`cacheTtl`](registry.qmd#symbol-interface-registryoptions-property-cachettl) | [packages/core/src/registry/fetcher.ts:31](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/registry/fetcher.ts#L31) | -| `confirmOverwrite?` | [`ConfirmOverwriteCallback`](operations.qmd#symbol-typealias-confirmoverwritecallback) | Callback for confirming overwrite when extension already exists. Only called when force is true. If not provided, overwrites silently. Return true to overwrite, false to cancel. | - | - | [packages/core/src/operations/install.ts:104](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/install.ts#L104) | -| `dryRun?` | `boolean` | Dry run mode - resolve without installing. | - | - | [packages/core/src/operations/install.ts:91](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/install.ts#L91) | -| `force?` | `boolean` | Force reinstall if already installed. | - | - | [packages/core/src/operations/install.ts:85](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/install.ts#L85) | -| `forceRefresh?` | `boolean` | Force refresh, ignoring cache. | - | [`RegistryOptions`](registry.qmd#symbol-interface-registryoptions).[`forceRefresh`](registry.qmd#symbol-interface-registryoptions-property-forcerefresh) | [packages/core/src/registry/fetcher.ts:29](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/registry/fetcher.ts#L29) | -| `keepSourceDir?` | `boolean` | Keep source directory after installation (for template copying). | - | - | [packages/core/src/operations/install.ts:89](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/install.ts#L89) | -| `onProgress?` | [`InstallProgressCallback`](operations.qmd#symbol-typealias-installprogresscallback) | Progress callback. | - | - | [packages/core/src/operations/install.ts:83](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/install.ts#L83) | -| `projectDir` | `string` | Project directory. | - | - | [packages/core/src/operations/install.ts:79](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/install.ts#L79) | -| `registryUrl?` | `string` | Custom registry URL. | - | [`RegistryOptions`](registry.qmd#symbol-interface-registryoptions).[`registryUrl`](registry.qmd#symbol-interface-registryoptions-property-registryurl) | [packages/core/src/registry/fetcher.ts:25](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/registry/fetcher.ts#L25) | -| `selectExtension?` | [`ExtensionSelectionCallback`](operations.qmd#symbol-typealias-extensionselectioncallback) | Callback for selecting extensions when source contains multiple. If not provided and source contains multiple extensions, the first one is installed (legacy behaviour). | - | - | [packages/core/src/operations/install.ts:98](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/install.ts#L98) | -| `signal?` | `AbortSignal` | AbortSignal for cancellation. | - | - | [packages/core/src/operations/install.ts:87](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/install.ts#L87) | -| `sourceDisplay?` | `string` | Display source to record in manifest (for relative paths that were resolved). | - | - | [packages/core/src/operations/install.ts:93](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/install.ts#L93) | -| `sourceType?` | [`SourceType`](types.qmd#symbol-typealias-sourcetype) | Override the source type written to the manifest. By default, the source type is inferred from the install source (e.g., "github", "url", "local"). Use "registry" when installing via the extension registry. | - | - | [packages/core/src/operations/install.ts:116](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/install.ts#L116) | -| `timeout?` | `number` | Request timeout in milliseconds. | - | [`RegistryOptions`](registry.qmd#symbol-interface-registryoptions).[`timeout`](registry.qmd#symbol-interface-registryoptions-property-timeout) | [packages/core/src/registry/fetcher.ts:35](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/registry/fetcher.ts#L35) | -| `validateQuartoVersion?` | [`ValidateQuartoVersionCallback`](operations.qmd#symbol-typealias-validatequartoversioncallback) | Callback for validating Quarto version requirement. Called when the manifest specifies a quartoRequired field. Return true to proceed, false to cancel. | - | - | [packages/core/src/operations/install.ts:110](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/install.ts#L110) | +| `auth?` | [`AuthConfig`](auth.qmd#symbol-interface-authconfig) | Authentication configuration. | [`RegistryOptions`](registry.qmd#symbol-interface-registryoptions).[`auth`](registry.qmd#symbol-interface-registryoptions-property-auth) | - | [packages/core/src/operations/install.ts:81](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/install.ts#L81) | +| `cacheDir?` | `string` | Cache directory (uses platform default if not provided). | - | [`RegistryOptions`](registry.qmd#symbol-interface-registryoptions).[`cacheDir`](registry.qmd#symbol-interface-registryoptions-property-cachedir) | [packages/core/src/registry/fetcher.ts:27](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/registry/fetcher.ts#L27) | +| `cacheTtl?` | `number` | Cache TTL in milliseconds (default: 24 hours). | - | [`RegistryOptions`](registry.qmd#symbol-interface-registryoptions).[`cacheTtl`](registry.qmd#symbol-interface-registryoptions-property-cachettl) | [packages/core/src/registry/fetcher.ts:31](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/registry/fetcher.ts#L31) | +| `confirmOverwrite?` | [`ConfirmOverwriteCallback`](operations.qmd#symbol-typealias-confirmoverwritecallback) | Callback for confirming overwrite when extension already exists. Only called when force is true. If not provided, overwrites silently. Return true to overwrite, false to cancel. | - | - | [packages/core/src/operations/install.ts:104](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/install.ts#L104) | +| `dryRun?` | `boolean` | Dry run mode - resolve without installing. | - | - | [packages/core/src/operations/install.ts:91](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/install.ts#L91) | +| `force?` | `boolean` | Force reinstall if already installed. | - | - | [packages/core/src/operations/install.ts:85](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/install.ts#L85) | +| `forceRefresh?` | `boolean` | Force refresh, ignoring cache. | - | [`RegistryOptions`](registry.qmd#symbol-interface-registryoptions).[`forceRefresh`](registry.qmd#symbol-interface-registryoptions-property-forcerefresh) | [packages/core/src/registry/fetcher.ts:29](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/registry/fetcher.ts#L29) | +| `keepSourceDir?` | `boolean` | Keep source directory after installation (for template copying). | - | - | [packages/core/src/operations/install.ts:89](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/install.ts#L89) | +| `onProgress?` | [`InstallProgressCallback`](operations.qmd#symbol-typealias-installprogresscallback) | Progress callback. | - | - | [packages/core/src/operations/install.ts:83](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/install.ts#L83) | +| `projectDir` | `string` | Project directory. | - | - | [packages/core/src/operations/install.ts:79](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/install.ts#L79) | +| `registryUrl?` | `string` | Custom registry URL. | - | [`RegistryOptions`](registry.qmd#symbol-interface-registryoptions).[`registryUrl`](registry.qmd#symbol-interface-registryoptions-property-registryurl) | [packages/core/src/registry/fetcher.ts:25](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/registry/fetcher.ts#L25) | +| `selectExtension?` | [`ExtensionSelectionCallback`](operations.qmd#symbol-typealias-extensionselectioncallback) | Callback for selecting extensions when source contains multiple. If not provided and source contains multiple extensions, the first one is installed (legacy behaviour). | - | - | [packages/core/src/operations/install.ts:98](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/install.ts#L98) | +| `signal?` | `AbortSignal` | AbortSignal for cancellation. | - | - | [packages/core/src/operations/install.ts:87](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/install.ts#L87) | +| `sourceDisplay?` | `string` | Display source to record in manifest (for relative paths that were resolved). | - | - | [packages/core/src/operations/install.ts:93](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/install.ts#L93) | +| `sourceType?` | [`SourceType`](types.qmd#symbol-typealias-sourcetype) | Override the source type written to the manifest. By default, the source type is inferred from the install source (e.g., "github", "url", "local"). Use "registry" when installing via the extension registry. | - | - | [packages/core/src/operations/install.ts:116](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/install.ts#L116) | +| `timeout?` | `number` | Request timeout in milliseconds. | - | [`RegistryOptions`](registry.qmd#symbol-interface-registryoptions).[`timeout`](registry.qmd#symbol-interface-registryoptions-property-timeout) | [packages/core/src/registry/fetcher.ts:35](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/registry/fetcher.ts#L35) | +| `validateQuartoVersion?` | [`ValidateQuartoVersionCallback`](operations.qmd#symbol-typealias-validatequartoversioncallback) | Callback for validating Quarto version requirement. Called when the manifest specifies a quartoRequired field. Return true to proceed, false to cancel. | - | - | [packages/core/src/operations/install.ts:110](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/install.ts#L110) | ## InstallResult {#symbol-interface-installresult} -Defined in: [packages/core/src/operations/install.ts:122](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/install.ts#L122) +Defined in: [packages/core/src/operations/install.ts:122](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/install.ts#L122) Result of installation. @@ -729,22 +729,22 @@ Result of installation. | Property | Type | Description | Defined in | | ---------------------------------------------------------------------------- | -------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `additionalInstallFailures?` | `object[]` | Additional extensions that failed to install when multiple were selected. | [packages/core/src/operations/install.ts:144](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/install.ts#L144) | -| `additionalInstalls?` | `InstallResult[]` | Additional extensions installed when multiple were selected (only set when using selectExtension callback). | [packages/core/src/operations/install.ts:142](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/install.ts#L142) | -| `alreadyExists?` | `boolean` | Whether the extension already exists (only relevant in dry run mode). | [packages/core/src/operations/install.ts:140](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/install.ts#L140) | -| `cancelled?` | `boolean` | Whether the installation was cancelled by user (via callbacks). | [packages/core/src/operations/install.ts:146](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/install.ts#L146) | -| `dryRun?` | `boolean` | Whether this was a dry run (no files were actually created). | [packages/core/src/operations/install.ts:136](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/install.ts#L136) | -| `extension` | [`InstalledExtension`](filesystem.qmd#symbol-interface-installedextension) | Installed extension details. | [packages/core/src/operations/install.ts:126](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/install.ts#L126) | -| `filesCreated` | `string[]` | Files created during installation. | [packages/core/src/operations/install.ts:128](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/install.ts#L128) | -| `source` | `string` | Source string for the manifest. | [packages/core/src/operations/install.ts:130](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/install.ts#L130) | -| `sourceRoot?` | `string` | Path to extracted source root (only set if keepSourceDir was true). | [packages/core/src/operations/install.ts:134](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/install.ts#L134) | -| `sourceType?` | [`SourceType`](types.qmd#symbol-typealias-sourcetype) | Source type for the manifest. | [packages/core/src/operations/install.ts:132](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/install.ts#L132) | -| `success` | `boolean` | Whether installation succeeded. | [packages/core/src/operations/install.ts:124](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/install.ts#L124) | -| `wouldCreate?` | `string[]` | Files that would be created (only set in dry run mode). | [packages/core/src/operations/install.ts:138](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/install.ts#L138) | +| `additionalInstallFailures?` | `object[]` | Additional extensions that failed to install when multiple were selected. | [packages/core/src/operations/install.ts:144](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/install.ts#L144) | +| `additionalInstalls?` | `InstallResult[]` | Additional extensions installed when multiple were selected (only set when using selectExtension callback). | [packages/core/src/operations/install.ts:142](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/install.ts#L142) | +| `alreadyExists?` | `boolean` | Whether the extension already exists (only relevant in dry run mode). | [packages/core/src/operations/install.ts:140](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/install.ts#L140) | +| `cancelled?` | `boolean` | Whether the installation was cancelled by user (via callbacks). | [packages/core/src/operations/install.ts:146](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/install.ts#L146) | +| `dryRun?` | `boolean` | Whether this was a dry run (no files were actually created). | [packages/core/src/operations/install.ts:136](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/install.ts#L136) | +| `extension` | [`InstalledExtension`](filesystem.qmd#symbol-interface-installedextension) | Installed extension details. | [packages/core/src/operations/install.ts:126](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/install.ts#L126) | +| `filesCreated` | `string[]` | Files created during installation. | [packages/core/src/operations/install.ts:128](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/install.ts#L128) | +| `source` | `string` | Source string for the manifest. | [packages/core/src/operations/install.ts:130](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/install.ts#L130) | +| `sourceRoot?` | `string` | Path to extracted source root (only set if keepSourceDir was true). | [packages/core/src/operations/install.ts:134](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/install.ts#L134) | +| `sourceType?` | [`SourceType`](types.qmd#symbol-typealias-sourcetype) | Source type for the manifest. | [packages/core/src/operations/install.ts:132](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/install.ts#L132) | +| `success` | `boolean` | Whether installation succeeded. | [packages/core/src/operations/install.ts:124](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/install.ts#L124) | +| `wouldCreate?` | `string[]` | Files that would be created (only set in dry run mode). | [packages/core/src/operations/install.ts:138](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/install.ts#L138) | ## RemoveOptions {#symbol-interface-removeoptions} -Defined in: [packages/core/src/operations/remove.ts:21](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/remove.ts#L21) +Defined in: [packages/core/src/operations/remove.ts:21](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/remove.ts#L21) Options for removal. @@ -752,12 +752,12 @@ Options for removal. | Property | Type | Description | Defined in | | -------------------------------------------------- | --------- | ---------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `cleanupEmpty?` | `boolean` | Clean up empty parent directories. | [packages/core/src/operations/remove.ts:25](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/remove.ts#L25) | -| `projectDir` | `string` | Project directory. | [packages/core/src/operations/remove.ts:23](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/remove.ts#L23) | +| `cleanupEmpty?` | `boolean` | Clean up empty parent directories. | [packages/core/src/operations/remove.ts:25](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/remove.ts#L25) | +| `projectDir` | `string` | Project directory. | [packages/core/src/operations/remove.ts:23](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/remove.ts#L23) | ## RemoveResult {#symbol-interface-removeresult} -Defined in: [packages/core/src/operations/remove.ts:31](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/remove.ts#L31) +Defined in: [packages/core/src/operations/remove.ts:31](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/remove.ts#L31) Result of removal. @@ -765,14 +765,14 @@ Result of removal. | Property | Type | Description | Defined in | | ------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `directoriesRemoved` | `string[]` | Directories cleaned up. | [packages/core/src/operations/remove.ts:39](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/remove.ts#L39) | -| `extension` | [`InstalledExtension`](filesystem.qmd#symbol-interface-installedextension) | Removed extension details. | [packages/core/src/operations/remove.ts:35](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/remove.ts#L35) | -| `filesRemoved` | `string[]` | Files removed. | [packages/core/src/operations/remove.ts:37](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/remove.ts#L37) | -| `success` | `boolean` | Whether removal succeeded. | [packages/core/src/operations/remove.ts:33](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/remove.ts#L33) | +| `directoriesRemoved` | `string[]` | Directories cleaned up. | [packages/core/src/operations/remove.ts:39](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/remove.ts#L39) | +| `extension` | [`InstalledExtension`](filesystem.qmd#symbol-interface-installedextension) | Removed extension details. | [packages/core/src/operations/remove.ts:35](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/remove.ts#L35) | +| `filesRemoved` | `string[]` | Files removed. | [packages/core/src/operations/remove.ts:37](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/remove.ts#L37) | +| `success` | `boolean` | Whether removal succeeded. | [packages/core/src/operations/remove.ts:33](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/remove.ts#L33) | ## UpdateCheckOptions {#symbol-interface-updatecheckoptions} -Defined in: [packages/core/src/operations/update.ts:46](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/update.ts#L46) +Defined in: [packages/core/src/operations/update.ts:46](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/update.ts#L46) Options for checking updates. @@ -788,19 +788,19 @@ Options for checking updates. | Property | Type | Description | Inherited from | Defined in | | -------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `auth?` | [`AuthConfig`](auth.qmd#symbol-interface-authconfig) | Authentication configuration. | [`RegistryOptions`](registry.qmd#symbol-interface-registryoptions).[`auth`](registry.qmd#symbol-interface-registryoptions-property-auth) | [packages/core/src/registry/fetcher.ts:33](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/registry/fetcher.ts#L33) | -| `cacheDir?` | `string` | Cache directory (uses platform default if not provided). | [`RegistryOptions`](registry.qmd#symbol-interface-registryoptions).[`cacheDir`](registry.qmd#symbol-interface-registryoptions-property-cachedir) | [packages/core/src/registry/fetcher.ts:27](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/registry/fetcher.ts#L27) | -| `cacheTtl?` | `number` | Cache TTL in milliseconds (default: 24 hours). | [`RegistryOptions`](registry.qmd#symbol-interface-registryoptions).[`cacheTtl`](registry.qmd#symbol-interface-registryoptions-property-cachettl) | [packages/core/src/registry/fetcher.ts:31](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/registry/fetcher.ts#L31) | -| `crossSource?` | `boolean` | Allow registry lookup to resolve updates for GitHub-sourced extensions. When false (default), extensions with `sourceType: "github"` are resolved against GitHub releases/tags directly, respecting how they were installed. When true, if the GitHub lookup yields no tag, fall back to the registry (legacy behaviour). | - | [packages/core/src/operations/update.ts:59](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/update.ts#L59) | -| `extension?` | [`ExtensionId`](types.qmd#symbol-interface-extensionid) | Specific extension to check (all if omitted). | - | [packages/core/src/operations/update.ts:50](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/update.ts#L50) | -| `forceRefresh?` | `boolean` | Force refresh, ignoring cache. | [`RegistryOptions`](registry.qmd#symbol-interface-registryoptions).[`forceRefresh`](registry.qmd#symbol-interface-registryoptions-property-forcerefresh) | [packages/core/src/registry/fetcher.ts:29](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/registry/fetcher.ts#L29) | -| `projectDir` | `string` | Project directory. | - | [packages/core/src/operations/update.ts:48](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/update.ts#L48) | -| `registryUrl?` | `string` | Custom registry URL. | [`RegistryOptions`](registry.qmd#symbol-interface-registryoptions).[`registryUrl`](registry.qmd#symbol-interface-registryoptions-property-registryurl) | [packages/core/src/registry/fetcher.ts:25](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/registry/fetcher.ts#L25) | -| `timeout?` | `number` | Request timeout in milliseconds. | [`RegistryOptions`](registry.qmd#symbol-interface-registryoptions).[`timeout`](registry.qmd#symbol-interface-registryoptions-property-timeout) | [packages/core/src/registry/fetcher.ts:35](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/registry/fetcher.ts#L35) | +| `auth?` | [`AuthConfig`](auth.qmd#symbol-interface-authconfig) | Authentication configuration. | [`RegistryOptions`](registry.qmd#symbol-interface-registryoptions).[`auth`](registry.qmd#symbol-interface-registryoptions-property-auth) | [packages/core/src/registry/fetcher.ts:33](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/registry/fetcher.ts#L33) | +| `cacheDir?` | `string` | Cache directory (uses platform default if not provided). | [`RegistryOptions`](registry.qmd#symbol-interface-registryoptions).[`cacheDir`](registry.qmd#symbol-interface-registryoptions-property-cachedir) | [packages/core/src/registry/fetcher.ts:27](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/registry/fetcher.ts#L27) | +| `cacheTtl?` | `number` | Cache TTL in milliseconds (default: 24 hours). | [`RegistryOptions`](registry.qmd#symbol-interface-registryoptions).[`cacheTtl`](registry.qmd#symbol-interface-registryoptions-property-cachettl) | [packages/core/src/registry/fetcher.ts:31](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/registry/fetcher.ts#L31) | +| `crossSource?` | `boolean` | Allow registry lookup to resolve updates for GitHub-sourced extensions. When false (default), extensions with `sourceType: "github"` are resolved against GitHub releases/tags directly, respecting how they were installed. When true, if the GitHub lookup yields no tag, fall back to the registry (legacy behaviour). | - | [packages/core/src/operations/update.ts:59](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/update.ts#L59) | +| `extension?` | [`ExtensionId`](types.qmd#symbol-interface-extensionid) | Specific extension to check (all if omitted). | - | [packages/core/src/operations/update.ts:50](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/update.ts#L50) | +| `forceRefresh?` | `boolean` | Force refresh, ignoring cache. | [`RegistryOptions`](registry.qmd#symbol-interface-registryoptions).[`forceRefresh`](registry.qmd#symbol-interface-registryoptions-property-forcerefresh) | [packages/core/src/registry/fetcher.ts:29](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/registry/fetcher.ts#L29) | +| `projectDir` | `string` | Project directory. | - | [packages/core/src/operations/update.ts:48](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/update.ts#L48) | +| `registryUrl?` | `string` | Custom registry URL. | [`RegistryOptions`](registry.qmd#symbol-interface-registryoptions).[`registryUrl`](registry.qmd#symbol-interface-registryoptions-property-registryurl) | [packages/core/src/registry/fetcher.ts:25](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/registry/fetcher.ts#L25) | +| `timeout?` | `number` | Request timeout in milliseconds. | [`RegistryOptions`](registry.qmd#symbol-interface-registryoptions).[`timeout`](registry.qmd#symbol-interface-registryoptions-property-timeout) | [packages/core/src/registry/fetcher.ts:35](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/registry/fetcher.ts#L35) | ## UpdateInfo {#symbol-interface-updateinfo} -Defined in: [packages/core/src/operations/update.ts:30](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/update.ts#L30) +Defined in: [packages/core/src/operations/update.ts:30](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/update.ts#L30) Information about an available update. @@ -808,15 +808,15 @@ Information about an available update. | Property | Type | Description | Defined in | | ----------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `currentVersion` | `string` | Current installed version. | [packages/core/src/operations/update.ts:34](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/update.ts#L34) | -| `extension` | [`InstalledExtension`](filesystem.qmd#symbol-interface-installedextension) | Extension with update available. | [packages/core/src/operations/update.ts:32](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/update.ts#L32) | -| `latestVersion` | `string` | Latest available version. | [packages/core/src/operations/update.ts:36](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/update.ts#L36) | -| `releaseUrl` | `string` \| `null` | URL to the release. | [packages/core/src/operations/update.ts:38](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/update.ts#L38) | -| `source` | `string` | Source reference for updating. | [packages/core/src/operations/update.ts:40](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/update.ts#L40) | +| `currentVersion` | `string` | Current installed version. | [packages/core/src/operations/update.ts:34](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/update.ts#L34) | +| `extension` | [`InstalledExtension`](filesystem.qmd#symbol-interface-installedextension) | Extension with update available. | [packages/core/src/operations/update.ts:32](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/update.ts#L32) | +| `latestVersion` | `string` | Latest available version. | [packages/core/src/operations/update.ts:36](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/update.ts#L36) | +| `releaseUrl` | `string` \| `null` | URL to the release. | [packages/core/src/operations/update.ts:38](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/update.ts#L38) | +| `source` | `string` | Source reference for updating. | [packages/core/src/operations/update.ts:40](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/update.ts#L40) | ## UpdateOptions {#symbol-interface-updateoptions} -Defined in: [packages/core/src/operations/update.ts:65](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/update.ts#L65) +Defined in: [packages/core/src/operations/update.ts:65](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/update.ts#L65) Options for applying updates. @@ -828,20 +828,20 @@ Options for applying updates. | Property | Type | Description | Overrides | Inherited from | Defined in | | -------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `auth?` | [`AuthConfig`](auth.qmd#symbol-interface-authconfig) | Authentication configuration. | [`UpdateCheckOptions`](operations.qmd#symbol-interface-updatecheckoptions).[`auth`](operations.qmd#symbol-interface-updatecheckoptions-property-auth) | - | [packages/core/src/operations/update.ts:67](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/update.ts#L67) | -| `cacheDir?` | `string` | Cache directory (uses platform default if not provided). | - | [`UpdateCheckOptions`](operations.qmd#symbol-interface-updatecheckoptions).[`cacheDir`](operations.qmd#symbol-interface-updatecheckoptions-property-cachedir) | [packages/core/src/registry/fetcher.ts:27](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/registry/fetcher.ts#L27) | -| `cacheTtl?` | `number` | Cache TTL in milliseconds (default: 24 hours). | - | [`UpdateCheckOptions`](operations.qmd#symbol-interface-updatecheckoptions).[`cacheTtl`](operations.qmd#symbol-interface-updatecheckoptions-property-cachettl) | [packages/core/src/registry/fetcher.ts:31](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/registry/fetcher.ts#L31) | -| `crossSource?` | `boolean` | Allow registry lookup to resolve updates for GitHub-sourced extensions. When false (default), extensions with `sourceType: "github"` are resolved against GitHub releases/tags directly, respecting how they were installed. When true, if the GitHub lookup yields no tag, fall back to the registry (legacy behaviour). | - | [`UpdateCheckOptions`](operations.qmd#symbol-interface-updatecheckoptions).[`crossSource`](operations.qmd#symbol-interface-updatecheckoptions-property-crosssource) | [packages/core/src/operations/update.ts:59](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/update.ts#L59) | -| `extension?` | [`ExtensionId`](types.qmd#symbol-interface-extensionid) | Specific extension to check (all if omitted). | - | [`UpdateCheckOptions`](operations.qmd#symbol-interface-updatecheckoptions).[`extension`](operations.qmd#symbol-interface-updatecheckoptions-property-extension) | [packages/core/src/operations/update.ts:50](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/update.ts#L50) | -| `forceRefresh?` | `boolean` | Force refresh, ignoring cache. | - | [`UpdateCheckOptions`](operations.qmd#symbol-interface-updatecheckoptions).[`forceRefresh`](operations.qmd#symbol-interface-updatecheckoptions-property-forcerefresh) | [packages/core/src/registry/fetcher.ts:29](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/registry/fetcher.ts#L29) | -| `onProgress?` | (`info`) => `void` | Progress callback. | - | - | [packages/core/src/operations/update.ts:69](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/update.ts#L69) | -| `projectDir` | `string` | Project directory. | - | [`UpdateCheckOptions`](operations.qmd#symbol-interface-updatecheckoptions).[`projectDir`](operations.qmd#symbol-interface-updatecheckoptions-property-projectdir) | [packages/core/src/operations/update.ts:48](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/update.ts#L48) | -| `registryUrl?` | `string` | Custom registry URL. | - | [`UpdateCheckOptions`](operations.qmd#symbol-interface-updatecheckoptions).[`registryUrl`](operations.qmd#symbol-interface-updatecheckoptions-property-registryurl) | [packages/core/src/registry/fetcher.ts:25](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/registry/fetcher.ts#L25) | -| `timeout?` | `number` | Request timeout in milliseconds. | - | [`UpdateCheckOptions`](operations.qmd#symbol-interface-updatecheckoptions).[`timeout`](operations.qmd#symbol-interface-updatecheckoptions-property-timeout) | [packages/core/src/registry/fetcher.ts:35](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/registry/fetcher.ts#L35) | +| `auth?` | [`AuthConfig`](auth.qmd#symbol-interface-authconfig) | Authentication configuration. | [`UpdateCheckOptions`](operations.qmd#symbol-interface-updatecheckoptions).[`auth`](operations.qmd#symbol-interface-updatecheckoptions-property-auth) | - | [packages/core/src/operations/update.ts:67](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/update.ts#L67) | +| `cacheDir?` | `string` | Cache directory (uses platform default if not provided). | - | [`UpdateCheckOptions`](operations.qmd#symbol-interface-updatecheckoptions).[`cacheDir`](operations.qmd#symbol-interface-updatecheckoptions-property-cachedir) | [packages/core/src/registry/fetcher.ts:27](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/registry/fetcher.ts#L27) | +| `cacheTtl?` | `number` | Cache TTL in milliseconds (default: 24 hours). | - | [`UpdateCheckOptions`](operations.qmd#symbol-interface-updatecheckoptions).[`cacheTtl`](operations.qmd#symbol-interface-updatecheckoptions-property-cachettl) | [packages/core/src/registry/fetcher.ts:31](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/registry/fetcher.ts#L31) | +| `crossSource?` | `boolean` | Allow registry lookup to resolve updates for GitHub-sourced extensions. When false (default), extensions with `sourceType: "github"` are resolved against GitHub releases/tags directly, respecting how they were installed. When true, if the GitHub lookup yields no tag, fall back to the registry (legacy behaviour). | - | [`UpdateCheckOptions`](operations.qmd#symbol-interface-updatecheckoptions).[`crossSource`](operations.qmd#symbol-interface-updatecheckoptions-property-crosssource) | [packages/core/src/operations/update.ts:59](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/update.ts#L59) | +| `extension?` | [`ExtensionId`](types.qmd#symbol-interface-extensionid) | Specific extension to check (all if omitted). | - | [`UpdateCheckOptions`](operations.qmd#symbol-interface-updatecheckoptions).[`extension`](operations.qmd#symbol-interface-updatecheckoptions-property-extension) | [packages/core/src/operations/update.ts:50](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/update.ts#L50) | +| `forceRefresh?` | `boolean` | Force refresh, ignoring cache. | - | [`UpdateCheckOptions`](operations.qmd#symbol-interface-updatecheckoptions).[`forceRefresh`](operations.qmd#symbol-interface-updatecheckoptions-property-forcerefresh) | [packages/core/src/registry/fetcher.ts:29](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/registry/fetcher.ts#L29) | +| `onProgress?` | (`info`) => `void` | Progress callback. | - | - | [packages/core/src/operations/update.ts:69](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/update.ts#L69) | +| `projectDir` | `string` | Project directory. | - | [`UpdateCheckOptions`](operations.qmd#symbol-interface-updatecheckoptions).[`projectDir`](operations.qmd#symbol-interface-updatecheckoptions-property-projectdir) | [packages/core/src/operations/update.ts:48](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/update.ts#L48) | +| `registryUrl?` | `string` | Custom registry URL. | - | [`UpdateCheckOptions`](operations.qmd#symbol-interface-updatecheckoptions).[`registryUrl`](operations.qmd#symbol-interface-updatecheckoptions-property-registryurl) | [packages/core/src/registry/fetcher.ts:25](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/registry/fetcher.ts#L25) | +| `timeout?` | `number` | Request timeout in milliseconds. | - | [`UpdateCheckOptions`](operations.qmd#symbol-interface-updatecheckoptions).[`timeout`](operations.qmd#symbol-interface-updatecheckoptions-property-timeout) | [packages/core/src/registry/fetcher.ts:35](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/registry/fetcher.ts#L35) | ## UpdateResult {#symbol-interface-updateresult} -Defined in: [packages/core/src/operations/update.ts:75](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/update.ts#L75) +Defined in: [packages/core/src/operations/update.ts:75](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/update.ts#L75) Result of update operation. @@ -849,13 +849,13 @@ Result of update operation. | Property | Type | Description | Defined in | | --------------------------------------- | ---------- | -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `failed` | `object[]` | Failed updates with errors. | [packages/core/src/operations/update.ts:88](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/update.ts#L88) | -| `skipped` | `object[]` | Skipped extensions with reasons. | [packages/core/src/operations/update.ts:83](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/update.ts#L83) | -| `updated` | `object[]` | Successfully updated extensions. | [packages/core/src/operations/update.ts:77](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/update.ts#L77) | +| `failed` | `object[]` | Failed updates with errors. | [packages/core/src/operations/update.ts:88](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/update.ts#L88) | +| `skipped` | `object[]` | Skipped extensions with reasons. | [packages/core/src/operations/update.ts:83](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/update.ts#L83) | +| `updated` | `object[]` | Successfully updated extensions. | [packages/core/src/operations/update.ts:77](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/update.ts#L77) | ## UseBrandOptions {#symbol-interface-usebrandoptions} -Defined in: [packages/core/src/operations/brand.ts:52](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/brand.ts#L52) +Defined in: [packages/core/src/operations/brand.ts:52](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/brand.ts#L52) Options for "use brand" operation. @@ -867,20 +867,20 @@ Options for "use brand" operation. | Property | Type | Description | Overrides | Inherited from | Defined in | | ---------------------------------------------------------- | ---------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `auth?` | [`AuthConfig`](auth.qmd#symbol-interface-authconfig) | Authentication configuration. | [`RegistryOptions`](registry.qmd#symbol-interface-registryoptions).[`auth`](registry.qmd#symbol-interface-registryoptions-property-auth) | - | [packages/core/src/operations/brand.ts:56](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/brand.ts#L56) | -| `cacheDir?` | `string` | Cache directory (uses platform default if not provided). | - | [`RegistryOptions`](registry.qmd#symbol-interface-registryoptions).[`cacheDir`](registry.qmd#symbol-interface-registryoptions-property-cachedir) | [packages/core/src/registry/fetcher.ts:27](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/registry/fetcher.ts#L27) | -| `cacheTtl?` | `number` | Cache TTL in milliseconds (default: 24 hours). | - | [`RegistryOptions`](registry.qmd#symbol-interface-registryoptions).[`cacheTtl`](registry.qmd#symbol-interface-registryoptions-property-cachettl) | [packages/core/src/registry/fetcher.ts:31](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/registry/fetcher.ts#L31) | -| `cleanupExtra?` | (`files`) => `Promise` | Callback to confirm removing extra files in \_brand/ not present in the source. | - | - | [packages/core/src/operations/brand.ts:60](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/brand.ts#L60) | -| `confirmOverwrite?` | (`files`) => `Promise` | Callback to confirm overwriting existing files. Receives list of files that would be overwritten. | - | - | [packages/core/src/operations/brand.ts:58](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/brand.ts#L58) | -| `forceRefresh?` | `boolean` | Force refresh, ignoring cache. | - | [`RegistryOptions`](registry.qmd#symbol-interface-registryoptions).[`forceRefresh`](registry.qmd#symbol-interface-registryoptions-property-forcerefresh) | [packages/core/src/registry/fetcher.ts:29](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/registry/fetcher.ts#L29) | -| `onProgress?` | (`info`) => `void` | Progress callback. | - | - | [packages/core/src/operations/brand.ts:62](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/brand.ts#L62) | -| `projectDir` | `string` | Project directory. | - | - | [packages/core/src/operations/brand.ts:54](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/brand.ts#L54) | -| `registryUrl?` | `string` | Custom registry URL. | - | [`RegistryOptions`](registry.qmd#symbol-interface-registryoptions).[`registryUrl`](registry.qmd#symbol-interface-registryoptions-property-registryurl) | [packages/core/src/registry/fetcher.ts:25](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/registry/fetcher.ts#L25) | -| `timeout?` | `number` | Request timeout in milliseconds. | - | [`RegistryOptions`](registry.qmd#symbol-interface-registryoptions).[`timeout`](registry.qmd#symbol-interface-registryoptions-property-timeout) | [packages/core/src/registry/fetcher.ts:35](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/registry/fetcher.ts#L35) | +| `auth?` | [`AuthConfig`](auth.qmd#symbol-interface-authconfig) | Authentication configuration. | [`RegistryOptions`](registry.qmd#symbol-interface-registryoptions).[`auth`](registry.qmd#symbol-interface-registryoptions-property-auth) | - | [packages/core/src/operations/brand.ts:56](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/brand.ts#L56) | +| `cacheDir?` | `string` | Cache directory (uses platform default if not provided). | - | [`RegistryOptions`](registry.qmd#symbol-interface-registryoptions).[`cacheDir`](registry.qmd#symbol-interface-registryoptions-property-cachedir) | [packages/core/src/registry/fetcher.ts:27](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/registry/fetcher.ts#L27) | +| `cacheTtl?` | `number` | Cache TTL in milliseconds (default: 24 hours). | - | [`RegistryOptions`](registry.qmd#symbol-interface-registryoptions).[`cacheTtl`](registry.qmd#symbol-interface-registryoptions-property-cachettl) | [packages/core/src/registry/fetcher.ts:31](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/registry/fetcher.ts#L31) | +| `cleanupExtra?` | (`files`) => `Promise` | Callback to confirm removing extra files in \_brand/ not present in the source. | - | - | [packages/core/src/operations/brand.ts:60](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/brand.ts#L60) | +| `confirmOverwrite?` | (`files`) => `Promise` | Callback to confirm overwriting existing files. Receives list of files that would be overwritten. | - | - | [packages/core/src/operations/brand.ts:58](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/brand.ts#L58) | +| `forceRefresh?` | `boolean` | Force refresh, ignoring cache. | - | [`RegistryOptions`](registry.qmd#symbol-interface-registryoptions).[`forceRefresh`](registry.qmd#symbol-interface-registryoptions-property-forcerefresh) | [packages/core/src/registry/fetcher.ts:29](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/registry/fetcher.ts#L29) | +| `onProgress?` | (`info`) => `void` | Progress callback. | - | - | [packages/core/src/operations/brand.ts:62](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/brand.ts#L62) | +| `projectDir` | `string` | Project directory. | - | - | [packages/core/src/operations/brand.ts:54](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/brand.ts#L54) | +| `registryUrl?` | `string` | Custom registry URL. | - | [`RegistryOptions`](registry.qmd#symbol-interface-registryoptions).[`registryUrl`](registry.qmd#symbol-interface-registryoptions-property-registryurl) | [packages/core/src/registry/fetcher.ts:25](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/registry/fetcher.ts#L25) | +| `timeout?` | `number` | Request timeout in milliseconds. | - | [`RegistryOptions`](registry.qmd#symbol-interface-registryoptions).[`timeout`](registry.qmd#symbol-interface-registryoptions-property-timeout) | [packages/core/src/registry/fetcher.ts:35](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/registry/fetcher.ts#L35) | ## UseBrandResult {#symbol-interface-usebrandresult} -Defined in: [packages/core/src/operations/brand.ts:68](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/brand.ts#L68) +Defined in: [packages/core/src/operations/brand.ts:68](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/brand.ts#L68) Result of "use brand" operation. @@ -888,16 +888,16 @@ Result of "use brand" operation. | Property | Type | Description | Defined in | | ----------------------------------------------- | ---------- | ------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `cleaned` | `string[]` | Files cleaned up (removed from \_brand/). | [packages/core/src/operations/brand.ts:78](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/brand.ts#L78) | -| `created` | `string[]` | Files created (new files). | [packages/core/src/operations/brand.ts:72](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/brand.ts#L72) | -| `overwritten` | `string[]` | Files overwritten. | [packages/core/src/operations/brand.ts:74](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/brand.ts#L74) | -| `skipped` | `string[]` | Files skipped (existing, not overwritten). | [packages/core/src/operations/brand.ts:76](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/brand.ts#L76) | -| `source` | `string` | Source string for display. | [packages/core/src/operations/brand.ts:80](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/brand.ts#L80) | -| `success` | `boolean` | Whether the operation succeeded. | [packages/core/src/operations/brand.ts:70](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/brand.ts#L70) | +| `cleaned` | `string[]` | Files cleaned up (removed from \_brand/). | [packages/core/src/operations/brand.ts:78](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/brand.ts#L78) | +| `created` | `string[]` | Files created (new files). | [packages/core/src/operations/brand.ts:72](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/brand.ts#L72) | +| `overwritten` | `string[]` | Files overwritten. | [packages/core/src/operations/brand.ts:74](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/brand.ts#L74) | +| `skipped` | `string[]` | Files skipped (existing, not overwritten). | [packages/core/src/operations/brand.ts:76](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/brand.ts#L76) | +| `source` | `string` | Source string for display. | [packages/core/src/operations/brand.ts:80](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/brand.ts#L80) | +| `success` | `boolean` | Whether the operation succeeded. | [packages/core/src/operations/brand.ts:70](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/brand.ts#L70) | ## UseOptions {#symbol-interface-useoptions} -Defined in: [packages/core/src/operations/use.ts:184](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/use.ts#L184) +Defined in: [packages/core/src/operations/use.ts:184](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/use.ts#L184) Options for "use extension" operation. @@ -905,27 +905,27 @@ Options for "use extension" operation. | Property | Type | Description | Defined in | | ---------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `auth?` | [`AuthConfig`](auth.qmd#symbol-interface-authconfig) | Authentication configuration. | [packages/core/src/operations/use.ts:188](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/use.ts#L188) | -| `confirmExtensionOverwrite?` | (`extensions`) => `Promise< | DiscoveredExtension[] | null>`{=html} | Callback to confirm overwriting existing extensions. Called with extensions that already exist in the project. Returns the extensions to overwrite, or null to cancel. | [packages/core/src/operations/use.ts:223](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/use.ts#L223) | -| `confirmOverwrite?` | [`OverwriteCallback`](operations.qmd#symbol-typealias-overwritecallback) | Callback to confirm overwrites (per-file). Takes precedence if confirmOverwriteBatch is not provided. | [packages/core/src/operations/use.ts:196](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/use.ts#L196) | -| `confirmOverwriteBatch?` | [`OverwriteBatchCallback`](operations.qmd#symbol-typealias-overwritebatchcallback) | Callback to confirm overwrites in batch. Receives all conflicting files upfront. Takes precedence over confirmOverwrite. | [packages/core/src/operations/use.ts:198](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/use.ts#L198) | -| `dryRun?` | `boolean` | Dry run mode - resolve and validate without copying files. | [packages/core/src/operations/use.ts:210](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/use.ts#L210) | -| `exclude?` | `string[]` | Additional patterns to exclude. | [packages/core/src/operations/use.ts:194](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/use.ts#L194) | -| `include?` | `string[]` | File patterns to include (overrides defaults). | [packages/core/src/operations/use.ts:192](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/use.ts#L192) | -| `noTemplate?` | `boolean` | Skip template copying. | [packages/core/src/operations/use.ts:190](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/use.ts#L190) | -| `onProgress?` | (`info`) => `void` | Progress callback. | [packages/core/src/operations/use.ts:208](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/use.ts#L208) | -| `projectDir` | `string` | Project directory. | [packages/core/src/operations/use.ts:186](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/use.ts#L186) | -| `selectExtension?` | [`ExtensionSelectionCallback`](operations.qmd#symbol-typealias-extensionselectioncallback) | Callback for selecting extensions when source contains multiple. If not provided and source contains multiple extensions, the first one is installed. | [packages/core/src/operations/use.ts:217](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/use.ts#L217) | -| `selectFiles?` | [`FileSelectionCallback`](operations.qmd#symbol-typealias-fileselectioncallback) | Callback for interactive file selection. Takes precedence over include/exclude/confirmOverwrite. | [packages/core/src/operations/use.ts:200](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/use.ts#L200) | -| `selectFilesFirst?` | `boolean` | Show file selection before installing extension (default: false). When true, the extension is only installed if the user confirms file selection. When false, the extension is installed immediately and then files are selected. | [packages/core/src/operations/use.ts:206](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/use.ts#L206) | -| `selectTargetSubdir?` | [`SelectTargetSubdirCallback`](operations.qmd#symbol-typealias-selecttargetsubdircallback) | Callback for interactive target subdirectory selection. Called before file selection in two-phase flow. Returns subdirectory path, or null/empty string for project root. | [packages/core/src/operations/use.ts:235](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/use.ts#L235) | -| `sourceDisplay?` | `string` | Display source to record in manifest (for relative paths that were resolved). | [packages/core/src/operations/use.ts:212](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/use.ts#L212) | -| `sourceType?` | [`SourceType`](types.qmd#symbol-typealias-sourcetype) | Override the source type written to the manifest. Use "registry" when installing via the extension registry. | [packages/core/src/operations/use.ts:240](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/use.ts#L240) | -| `targetSubdir?` | `string` | Subdirectory within projectDir where template files should be copied. If selectTargetSubdir callback is provided and selectFilesFirst is true, the callback takes precedence. | [packages/core/src/operations/use.ts:229](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/use.ts#L229) | +| `auth?` | [`AuthConfig`](auth.qmd#symbol-interface-authconfig) | Authentication configuration. | [packages/core/src/operations/use.ts:188](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/use.ts#L188) | +| `confirmExtensionOverwrite?` | (`extensions`) => `Promise< | DiscoveredExtension[] | null>`{=html} | Callback to confirm overwriting existing extensions. Called with extensions that already exist in the project. Returns the extensions to overwrite, or null to cancel. | [packages/core/src/operations/use.ts:223](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/use.ts#L223) | +| `confirmOverwrite?` | [`OverwriteCallback`](operations.qmd#symbol-typealias-overwritecallback) | Callback to confirm overwrites (per-file). Takes precedence if confirmOverwriteBatch is not provided. | [packages/core/src/operations/use.ts:196](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/use.ts#L196) | +| `confirmOverwriteBatch?` | [`OverwriteBatchCallback`](operations.qmd#symbol-typealias-overwritebatchcallback) | Callback to confirm overwrites in batch. Receives all conflicting files upfront. Takes precedence over confirmOverwrite. | [packages/core/src/operations/use.ts:198](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/use.ts#L198) | +| `dryRun?` | `boolean` | Dry run mode - resolve and validate without copying files. | [packages/core/src/operations/use.ts:210](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/use.ts#L210) | +| `exclude?` | `string[]` | Additional patterns to exclude. | [packages/core/src/operations/use.ts:194](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/use.ts#L194) | +| `include?` | `string[]` | File patterns to include (overrides defaults). | [packages/core/src/operations/use.ts:192](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/use.ts#L192) | +| `noTemplate?` | `boolean` | Skip template copying. | [packages/core/src/operations/use.ts:190](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/use.ts#L190) | +| `onProgress?` | (`info`) => `void` | Progress callback. | [packages/core/src/operations/use.ts:208](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/use.ts#L208) | +| `projectDir` | `string` | Project directory. | [packages/core/src/operations/use.ts:186](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/use.ts#L186) | +| `selectExtension?` | [`ExtensionSelectionCallback`](operations.qmd#symbol-typealias-extensionselectioncallback) | Callback for selecting extensions when source contains multiple. If not provided and source contains multiple extensions, the first one is installed. | [packages/core/src/operations/use.ts:217](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/use.ts#L217) | +| `selectFiles?` | [`FileSelectionCallback`](operations.qmd#symbol-typealias-fileselectioncallback) | Callback for interactive file selection. Takes precedence over include/exclude/confirmOverwrite. | [packages/core/src/operations/use.ts:200](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/use.ts#L200) | +| `selectFilesFirst?` | `boolean` | Show file selection before installing extension (default: false). When true, the extension is only installed if the user confirms file selection. When false, the extension is installed immediately and then files are selected. | [packages/core/src/operations/use.ts:206](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/use.ts#L206) | +| `selectTargetSubdir?` | [`SelectTargetSubdirCallback`](operations.qmd#symbol-typealias-selecttargetsubdircallback) | Callback for interactive target subdirectory selection. Called before file selection in two-phase flow. Returns subdirectory path, or null/empty string for project root. | [packages/core/src/operations/use.ts:235](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/use.ts#L235) | +| `sourceDisplay?` | `string` | Display source to record in manifest (for relative paths that were resolved). | [packages/core/src/operations/use.ts:212](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/use.ts#L212) | +| `sourceType?` | [`SourceType`](types.qmd#symbol-typealias-sourcetype) | Override the source type written to the manifest. Use "registry" when installing via the extension registry. | [packages/core/src/operations/use.ts:240](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/use.ts#L240) | +| `targetSubdir?` | `string` | Subdirectory within projectDir where template files should be copied. If selectTargetSubdir callback is provided and selectFilesFirst is true, the callback takes precedence. | [packages/core/src/operations/use.ts:229](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/use.ts#L229) | ## UseResult {#symbol-interface-useresult} -Defined in: [packages/core/src/operations/use.ts:246](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/use.ts#L246) +Defined in: [packages/core/src/operations/use.ts:246](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/use.ts#L246) Result of "use extension" operation. @@ -933,13 +933,13 @@ Result of "use extension" operation. | Property | Type | Description | Defined in | | ---------------------------------------------------- | ---------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `cancelled?` | `boolean` | Whether the user cancelled the file selection (only set when selectFilesFirst is true). | [packages/core/src/operations/use.ts:260](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/use.ts#L260) | -| `dryRun?` | `boolean` | Whether this was a dry run (no files were actually copied). | [packages/core/src/operations/use.ts:254](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/use.ts#L254) | -| `install` | [`InstallResult`](operations.qmd#symbol-interface-installresult) | Installation result. | [packages/core/src/operations/use.ts:248](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/use.ts#L248) | -| `skippedFiles` | `string[]` | Files skipped due to existing. | [packages/core/src/operations/use.ts:252](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/use.ts#L252) | -| `templateFiles` | `string[]` | Template files copied. | [packages/core/src/operations/use.ts:250](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/use.ts#L250) | -| `wouldConflict?` | `string[]` | Files that would conflict with existing files (only set in dry run mode). | [packages/core/src/operations/use.ts:258](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/use.ts#L258) | -| `wouldCopy?` | `string[]` | Template files that would be copied (only set in dry run mode). | [packages/core/src/operations/use.ts:256](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/use.ts#L256) | +| `cancelled?` | `boolean` | Whether the user cancelled the file selection (only set when selectFilesFirst is true). | [packages/core/src/operations/use.ts:260](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/use.ts#L260) | +| `dryRun?` | `boolean` | Whether this was a dry run (no files were actually copied). | [packages/core/src/operations/use.ts:254](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/use.ts#L254) | +| `install` | [`InstallResult`](operations.qmd#symbol-interface-installresult) | Installation result. | [packages/core/src/operations/use.ts:248](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/use.ts#L248) | +| `skippedFiles` | `string[]` | Files skipped due to existing. | [packages/core/src/operations/use.ts:252](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/use.ts#L252) | +| `templateFiles` | `string[]` | Template files copied. | [packages/core/src/operations/use.ts:250](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/use.ts#L250) | +| `wouldConflict?` | `string[]` | Files that would conflict with existing files (only set in dry run mode). | [packages/core/src/operations/use.ts:258](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/use.ts#L258) | +| `wouldCopy?` | `string[]` | Template files that would be copied (only set in dry run mode). | [packages/core/src/operations/use.ts:256](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/use.ts#L256) | ## ConfirmOverwriteCallback {#symbol-typealias-confirmoverwritecallback} @@ -947,7 +947,7 @@ Result of "use extension" operation. type ConfirmOverwriteCallback = (extension) => Promise; ``` -Defined in: [packages/core/src/operations/install.ts:63](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/install.ts#L63) +Defined in: [packages/core/src/operations/install.ts:63](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/install.ts#L63) Callback for confirming overwrite when extension already exists. @@ -971,7 +971,7 @@ type ExtensionSelectionCallback = (extensions) => Promise< | null>; ``` -Defined in: [packages/core/src/operations/install.ts:55](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/install.ts#L55) +Defined in: [packages/core/src/operations/install.ts:55](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/install.ts#L55) Callback for selecting which extension(s) to install from a multi-extension source. Called when a repository contains multiple extensions. @@ -998,7 +998,7 @@ type FileSelectionCallback = (availableFiles, existingFiles, defaultExcludePatte | null>; ``` -Defined in: [packages/core/src/operations/use.ts:166](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/use.ts#L166) +Defined in: [packages/core/src/operations/use.ts:166](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/use.ts#L166) Callback for interactive file selection. Receives all available template files and which ones already exist. @@ -1024,7 +1024,7 @@ Returns which files to copy and whether to overwrite existing. type InstallPhase = "resolving" | "downloading" | "extracting" | "installing" | "finalizing"; ``` -Defined in: [packages/core/src/operations/install.ts:41](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/install.ts#L41) +Defined in: [packages/core/src/operations/install.ts:41](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/install.ts#L41) Progress phases for installation. @@ -1034,7 +1034,7 @@ Progress phases for installation. type InstallProgressCallback = (progress) => void; ``` -Defined in: [packages/core/src/operations/install.ts:46](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/install.ts#L46) +Defined in: [packages/core/src/operations/install.ts:46](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/install.ts#L46) Progress callback for installation. @@ -1071,7 +1071,7 @@ type InstallSource = }; ``` -Defined in: [packages/core/src/operations/install.ts:33](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/install.ts#L33) +Defined in: [packages/core/src/operations/install.ts:33](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/install.ts#L33) Source for extension installation. @@ -1081,7 +1081,7 @@ Source for extension installation. type OverwriteBatchCallback = (files) => Promise; ``` -Defined in: [packages/core/src/operations/use.ts:149](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/use.ts#L149) +Defined in: [packages/core/src/operations/use.ts:149](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/use.ts#L149) Callback for confirming file overwrites in batch. Receives all conflicting files upfront and returns which ones to overwrite. @@ -1102,7 +1102,7 @@ Receives all conflicting files upfront and returns which ones to overwrite. type OverwriteBatchResult = "all" | "none" | string[]; ``` -Defined in: [packages/core/src/operations/use.ts:143](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/use.ts#L143) +Defined in: [packages/core/src/operations/use.ts:143](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/use.ts#L143) Result of batch overwrite confirmation. @@ -1116,7 +1116,7 @@ Result of batch overwrite confirmation. type OverwriteCallback = (file) => Promise; ``` -Defined in: [packages/core/src/operations/use.ts:135](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/use.ts#L135) +Defined in: [packages/core/src/operations/use.ts:135](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/use.ts#L135) Callback for confirming file overwrites (per-file). @@ -1136,7 +1136,7 @@ Callback for confirming file overwrites (per-file). type SelectTargetSubdirCallback = () => Promise; ``` -Defined in: [packages/core/src/operations/use.ts:179](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/use.ts#L179) +Defined in: [packages/core/src/operations/use.ts:179](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/use.ts#L179) Callback for selecting target subdirectory. Returns: @@ -1155,7 +1155,7 @@ Returns: type ValidateQuartoVersionCallback = (required, manifest) => Promise; ``` -Defined in: [packages/core/src/operations/install.ts:72](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/operations/install.ts#L72) +Defined in: [packages/core/src/operations/install.ts:72](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/operations/install.ts#L72) Callback for validating Quarto version requirement. diff --git a/docs/api/core/proxy.qmd b/docs/api/core/proxy.qmd index 2721aeec..a1bb5270 100644 --- a/docs/api/core/proxy.qmd +++ b/docs/api/core/proxy.qmd @@ -104,7 +104,7 @@ Automatically routes requests through configured proxy servers. function clearProxyAgentCache(): void; ``` -Defined in: [packages/core/src/proxy/fetch.ts:161](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/proxy/fetch.ts#L161) +Defined in: [packages/core/src/proxy/fetch.ts:161](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/proxy/fetch.ts#L161) Clear the proxy agent cache. Useful for testing or when proxy configuration changes. @@ -119,7 +119,7 @@ Useful for testing or when proxy configuration changes. function getProxyConfig(): ProxyConfig; ``` -Defined in: [packages/core/src/proxy/config.ts:88](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/proxy/config.ts#L88) +Defined in: [packages/core/src/proxy/config.ts:88](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/proxy/config.ts#L88) Read proxy configuration from environment variables. @@ -135,7 +135,7 @@ Proxy configuration function getProxyForUrl(url, config?): string | undefined; ``` -Defined in: [packages/core/src/proxy/config.ts:146](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/proxy/config.ts#L146) +Defined in: [packages/core/src/proxy/config.ts:146](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/proxy/config.ts#L146) Get the appropriate proxy URL for a given request URL. @@ -158,7 +158,7 @@ Proxy URL or undefined if no proxy should be used function proxyFetch(url, options?): Promise; ``` -Defined in: [packages/core/src/proxy/fetch.ts:130](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/proxy/fetch.ts#L130) +Defined in: [packages/core/src/proxy/fetch.ts:130](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/proxy/fetch.ts#L130) Proxy-aware fetch function. @@ -184,7 +184,7 @@ Response function shouldBypassProxy(hostname, noProxy): boolean; ``` -Defined in: [packages/core/src/proxy/config.ts:109](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/proxy/config.ts#L109) +Defined in: [packages/core/src/proxy/config.ts:109](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/proxy/config.ts#L109) Check if a hostname should bypass the proxy. @@ -210,7 +210,7 @@ True if the host should bypass the proxy ## ProxyConfig {#symbol-interface-proxyconfig} -Defined in: [packages/core/src/proxy/config.ts:46](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/proxy/config.ts#L46) +Defined in: [packages/core/src/proxy/config.ts:46](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/proxy/config.ts#L46) Proxy configuration. @@ -218,13 +218,13 @@ Proxy configuration. | Property | Type | Description | Defined in | | ---------------------------------------------- | ---------- | ------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpProxy?` | `string` | Proxy URL for HTTP requests. | [packages/core/src/proxy/config.ts:48](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/proxy/config.ts#L48) | -| `httpsProxy?` | `string` | Proxy URL for HTTPS requests. | [packages/core/src/proxy/config.ts:50](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/proxy/config.ts#L50) | -| `noProxy` | `string[]` | List of hosts/patterns to bypass the proxy. | [packages/core/src/proxy/config.ts:52](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/proxy/config.ts#L52) | +| `httpProxy?` | `string` | Proxy URL for HTTP requests. | [packages/core/src/proxy/config.ts:48](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/proxy/config.ts#L48) | +| `httpsProxy?` | `string` | Proxy URL for HTTPS requests. | [packages/core/src/proxy/config.ts:50](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/proxy/config.ts#L50) | +| `noProxy` | `string[]` | List of hosts/patterns to bypass the proxy. | [packages/core/src/proxy/config.ts:52](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/proxy/config.ts#L52) | ## ProxyFetchOptions {#symbol-interface-proxyfetchoptions} -Defined in: [packages/core/src/proxy/fetch.ts:93](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/proxy/fetch.ts#L93) +Defined in: [packages/core/src/proxy/fetch.ts:93](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/proxy/fetch.ts#L93) Options for proxy-aware fetch. @@ -246,7 +246,7 @@ Options for proxy-aware fetch. | `keepalive?` | `boolean` | - | `RequestInit.keepalive` | node_modules/undici-types/fetch.d.ts:130 | | `method?` | `string` | - | `RequestInit.method` | node_modules/undici-types/fetch.d.ts:131 | | `mode?` | `RequestMode` | - | `RequestInit.mode` | node_modules/undici-types/fetch.d.ts:132 | -| `proxyConfig?` | [`ProxyConfig`](proxy.qmd#symbol-interface-proxyconfig) | Proxy configuration. If not provided, reads from environment. | - | [packages/core/src/proxy/fetch.ts:95](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/proxy/fetch.ts#L95) | +| `proxyConfig?` | [`ProxyConfig`](proxy.qmd#symbol-interface-proxyconfig) | Proxy configuration. If not provided, reads from environment. | - | [packages/core/src/proxy/fetch.ts:95](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/proxy/fetch.ts#L95) | | `redirect?` | `RequestRedirect` | - | `RequestInit.redirect` | node_modules/undici-types/fetch.d.ts:133 | | `referrer?` | `string` | - | `RequestInit.referrer` | node_modules/undici-types/fetch.d.ts:134 | | `referrerPolicy?` | `ReferrerPolicy` | - | `RequestInit.referrerPolicy` | node_modules/undici-types/fetch.d.ts:135 | diff --git a/docs/api/core/registry.qmd b/docs/api/core/registry.qmd index 6eff3b4b..ba7c285e 100644 --- a/docs/api/core/registry.qmd +++ b/docs/api/core/registry.qmd @@ -76,7 +76,7 @@ Provides search and filtering capabilities for the extensions registry. function clearRegistryCache(cacheDir?): Promise; ``` -Defined in: [packages/core/src/registry/cache.ts:146](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/registry/cache.ts#L146) +Defined in: [packages/core/src/registry/cache.ts:146](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/registry/cache.ts#L146) Clear the registry cache. @@ -96,7 +96,7 @@ Clear the registry cache. function fetchJson(url, options?): Promise; ``` -Defined in: [packages/core/src/registry/http.ts:190](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/registry/http.ts#L190) +Defined in: [packages/core/src/registry/http.ts:190](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/registry/http.ts#L190) Fetch JSON with timeout and retry support. @@ -125,7 +125,7 @@ Parsed JSON response function fetchRegistry(options?): Promise; ``` -Defined in: [packages/core/src/registry/fetcher.ts:44](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/registry/fetcher.ts#L44) +Defined in: [packages/core/src/registry/fetcher.ts:44](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/registry/fetcher.ts#L44) Fetch the extension registry. @@ -147,7 +147,7 @@ Parsed registry function fetchText(url, options?): Promise; ``` -Defined in: [packages/core/src/registry/http.ts:206](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/registry/http.ts#L206) +Defined in: [packages/core/src/registry/http.ts:206](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/registry/http.ts#L206) Fetch text with timeout and retry support. @@ -170,7 +170,7 @@ Response text function getCacheFilePath(cacheDir?): string; ``` -Defined in: [packages/core/src/registry/cache.ts:62](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/registry/cache.ts#L62) +Defined in: [packages/core/src/registry/cache.ts:62](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/registry/cache.ts#L62) Get the cache file path. @@ -198,7 +198,7 @@ function getCacheStatus(cacheDir?): Promise< | null>; ``` -Defined in: [packages/core/src/registry/cache.ts:201](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/registry/cache.ts#L201) +Defined in: [packages/core/src/registry/cache.ts:201](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/registry/cache.ts#L201) Get cache status information. @@ -226,7 +226,7 @@ Cache status or null if no cache exists function getDefaultCacheDir(): string; ``` -Defined in: [packages/core/src/registry/cache.ts:40](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/registry/cache.ts#L40) +Defined in: [packages/core/src/registry/cache.ts:40](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/registry/cache.ts#L40) Get the default cache directory. @@ -242,7 +242,7 @@ Path to cache directory function getDefaultRegistryUrl(): string; ``` -Defined in: [packages/core/src/registry/fetcher.ts:80](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/registry/fetcher.ts#L80) +Defined in: [packages/core/src/registry/fetcher.ts:80](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/registry/fetcher.ts#L80) Get the default registry URL. @@ -256,7 +256,7 @@ Get the default registry URL. function getExtension(id, options?): Promise; ``` -Defined in: [packages/core/src/registry/search.ts:156](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/registry/search.ts#L156) +Defined in: [packages/core/src/registry/search.ts:156](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/registry/search.ts#L156) Get a specific extension by ID from the registry. @@ -279,7 +279,7 @@ Registry entry or null if not found function getExtensionsByOwner(owner, options?): Promise; ``` -Defined in: [packages/core/src/registry/search.ts:168](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/registry/search.ts#L168) +Defined in: [packages/core/src/registry/search.ts:168](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/registry/search.ts#L168) Get extensions by owner. @@ -302,7 +302,7 @@ Array of registry entries function listAvailable(options?): Promise; ``` -Defined in: [packages/core/src/registry/search.ts:72](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/registry/search.ts#L72) +Defined in: [packages/core/src/registry/search.ts:72](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/registry/search.ts#L72) List all available extensions from the registry. @@ -334,7 +334,7 @@ const templates = await listAvailable({ templatesOnly: true, limit: 10 }); function lookupRegistryEntry(registry, key): RegistryEntry | null; ``` -Defined in: [packages/core/src/registry/search.ts:21](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/registry/search.ts#L21) +Defined in: [packages/core/src/registry/search.ts:21](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/registry/search.ts#L21) Look up a registry entry by key with case-insensitive fallback. @@ -360,7 +360,7 @@ function readCachedRegistry( ttl?): Promise; ``` -Defined in: [packages/core/src/registry/cache.ts:75](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/registry/cache.ts#L75) +Defined in: [packages/core/src/registry/cache.ts:75](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/registry/cache.ts#L75) Read cached registry if valid. @@ -384,7 +384,7 @@ Cached registry or null if cache is invalid/expired function search(query, options?): Promise; ``` -Defined in: [packages/core/src/registry/search.ts:111](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/registry/search.ts#L111) +Defined in: [packages/core/src/registry/search.ts:111](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/registry/search.ts#L111) Search for extensions in the registry. @@ -420,7 +420,7 @@ function writeCachedRegistry( registry): Promise; ``` -Defined in: [packages/core/src/registry/cache.ts:119](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/registry/cache.ts#L119) +Defined in: [packages/core/src/registry/cache.ts:119](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/registry/cache.ts#L119) Write registry to cache. @@ -438,7 +438,7 @@ Write registry to cache. ## HttpOptions {#symbol-interface-httpoptions} -Defined in: [packages/core/src/registry/http.ts:18](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/registry/http.ts#L18) +Defined in: [packages/core/src/registry/http.ts:18](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/registry/http.ts#L18) Options for HTTP requests. @@ -446,15 +446,15 @@ Options for HTTP requests. | Property | Type | Description | Defined in | | ---------------------------------------------- | ------------------------ | --------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `headers?` | `Record` | Custom headers to include. | [packages/core/src/registry/http.ts:26](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/registry/http.ts#L26) | -| `retries?` | `number` | Number of retry attempts (default: 3). | [packages/core/src/registry/http.ts:22](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/registry/http.ts#L22) | -| `retryDelay?` | `number` | Base delay for exponential backoff in ms (default: 1000). | [packages/core/src/registry/http.ts:24](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/registry/http.ts#L24) | -| `signal?` | `AbortSignal` | AbortSignal for cancellation. | [packages/core/src/registry/http.ts:28](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/registry/http.ts#L28) | -| `timeout?` | `number` | Request timeout in milliseconds (default: 30000). | [packages/core/src/registry/http.ts:20](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/registry/http.ts#L20) | +| `headers?` | `Record` | Custom headers to include. | [packages/core/src/registry/http.ts:26](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/registry/http.ts#L26) | +| `retries?` | `number` | Number of retry attempts (default: 3). | [packages/core/src/registry/http.ts:22](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/registry/http.ts#L22) | +| `retryDelay?` | `number` | Base delay for exponential backoff in ms (default: 1000). | [packages/core/src/registry/http.ts:24](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/registry/http.ts#L24) | +| `signal?` | `AbortSignal` | AbortSignal for cancellation. | [packages/core/src/registry/http.ts:28](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/registry/http.ts#L28) | +| `timeout?` | `number` | Request timeout in milliseconds (default: 30000). | [packages/core/src/registry/http.ts:20](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/registry/http.ts#L20) | ## ListAvailableOptions {#symbol-interface-listavailableoptions} -Defined in: [packages/core/src/registry/search.ts:40](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/registry/search.ts#L40) +Defined in: [packages/core/src/registry/search.ts:40](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/registry/search.ts#L40) Options for listing available extensions. @@ -470,19 +470,19 @@ Options for listing available extensions. | Property | Type | Description | Inherited from | Defined in | | ---------------------------------------------------- | ----------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `auth?` | [`AuthConfig`](auth.qmd#symbol-interface-authconfig) | Authentication configuration. | [`RegistryOptions`](registry.qmd#symbol-interface-registryoptions).[`auth`](registry.qmd#symbol-interface-registryoptions-property-auth) | [packages/core/src/registry/fetcher.ts:33](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/registry/fetcher.ts#L33) | -| `cacheDir?` | `string` | Cache directory (uses platform default if not provided). | [`RegistryOptions`](registry.qmd#symbol-interface-registryoptions).[`cacheDir`](registry.qmd#symbol-interface-registryoptions-property-cachedir) | [packages/core/src/registry/fetcher.ts:27](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/registry/fetcher.ts#L27) | -| `cacheTtl?` | `number` | Cache TTL in milliseconds (default: 24 hours). | [`RegistryOptions`](registry.qmd#symbol-interface-registryoptions).[`cacheTtl`](registry.qmd#symbol-interface-registryoptions-property-cachettl) | [packages/core/src/registry/fetcher.ts:31](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/registry/fetcher.ts#L31) | -| `forceRefresh?` | `boolean` | Force refresh, ignoring cache. | [`RegistryOptions`](registry.qmd#symbol-interface-registryoptions).[`forceRefresh`](registry.qmd#symbol-interface-registryoptions-property-forcerefresh) | [packages/core/src/registry/fetcher.ts:29](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/registry/fetcher.ts#L29) | -| `limit?` | `number` | Maximum number of results. | - | [packages/core/src/registry/search.ts:46](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/registry/search.ts#L46) | -| `registryUrl?` | `string` | Custom registry URL. | [`RegistryOptions`](registry.qmd#symbol-interface-registryoptions).[`registryUrl`](registry.qmd#symbol-interface-registryoptions-property-registryurl) | [packages/core/src/registry/fetcher.ts:25](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/registry/fetcher.ts#L25) | -| `templatesOnly?` | `boolean` | Filter to templates only. | - | [packages/core/src/registry/search.ts:44](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/registry/search.ts#L44) | -| `timeout?` | `number` | Request timeout in milliseconds. | [`RegistryOptions`](registry.qmd#symbol-interface-registryoptions).[`timeout`](registry.qmd#symbol-interface-registryoptions-property-timeout) | [packages/core/src/registry/fetcher.ts:35](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/registry/fetcher.ts#L35) | -| `type?` | [`ExtensionType`](types.qmd#symbol-typealias-extensiontype) | Filter by extension type (based on topics). | - | [packages/core/src/registry/search.ts:42](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/registry/search.ts#L42) | +| `auth?` | [`AuthConfig`](auth.qmd#symbol-interface-authconfig) | Authentication configuration. | [`RegistryOptions`](registry.qmd#symbol-interface-registryoptions).[`auth`](registry.qmd#symbol-interface-registryoptions-property-auth) | [packages/core/src/registry/fetcher.ts:33](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/registry/fetcher.ts#L33) | +| `cacheDir?` | `string` | Cache directory (uses platform default if not provided). | [`RegistryOptions`](registry.qmd#symbol-interface-registryoptions).[`cacheDir`](registry.qmd#symbol-interface-registryoptions-property-cachedir) | [packages/core/src/registry/fetcher.ts:27](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/registry/fetcher.ts#L27) | +| `cacheTtl?` | `number` | Cache TTL in milliseconds (default: 24 hours). | [`RegistryOptions`](registry.qmd#symbol-interface-registryoptions).[`cacheTtl`](registry.qmd#symbol-interface-registryoptions-property-cachettl) | [packages/core/src/registry/fetcher.ts:31](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/registry/fetcher.ts#L31) | +| `forceRefresh?` | `boolean` | Force refresh, ignoring cache. | [`RegistryOptions`](registry.qmd#symbol-interface-registryoptions).[`forceRefresh`](registry.qmd#symbol-interface-registryoptions-property-forcerefresh) | [packages/core/src/registry/fetcher.ts:29](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/registry/fetcher.ts#L29) | +| `limit?` | `number` | Maximum number of results. | - | [packages/core/src/registry/search.ts:46](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/registry/search.ts#L46) | +| `registryUrl?` | `string` | Custom registry URL. | [`RegistryOptions`](registry.qmd#symbol-interface-registryoptions).[`registryUrl`](registry.qmd#symbol-interface-registryoptions-property-registryurl) | [packages/core/src/registry/fetcher.ts:25](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/registry/fetcher.ts#L25) | +| `templatesOnly?` | `boolean` | Filter to templates only. | - | [packages/core/src/registry/search.ts:44](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/registry/search.ts#L44) | +| `timeout?` | `number` | Request timeout in milliseconds. | [`RegistryOptions`](registry.qmd#symbol-interface-registryoptions).[`timeout`](registry.qmd#symbol-interface-registryoptions-property-timeout) | [packages/core/src/registry/fetcher.ts:35](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/registry/fetcher.ts#L35) | +| `type?` | [`ExtensionType`](types.qmd#symbol-typealias-extensiontype) | Filter by extension type (based on topics). | - | [packages/core/src/registry/search.ts:42](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/registry/search.ts#L42) | ## RegistryOptions {#symbol-interface-registryoptions} -Defined in: [packages/core/src/registry/fetcher.ts:23](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/registry/fetcher.ts#L23) +Defined in: [packages/core/src/registry/fetcher.ts:23](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/registry/fetcher.ts#L23) Options for fetching the registry. @@ -497,16 +497,16 @@ Options for fetching the registry. | Property | Type | Description | Defined in | | -------------------------------------------------- | ---------------------------------------------------- | -------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `auth?` | [`AuthConfig`](auth.qmd#symbol-interface-authconfig) | Authentication configuration. | [packages/core/src/registry/fetcher.ts:33](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/registry/fetcher.ts#L33) | -| `cacheDir?` | `string` | Cache directory (uses platform default if not provided). | [packages/core/src/registry/fetcher.ts:27](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/registry/fetcher.ts#L27) | -| `cacheTtl?` | `number` | Cache TTL in milliseconds (default: 24 hours). | [packages/core/src/registry/fetcher.ts:31](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/registry/fetcher.ts#L31) | -| `forceRefresh?` | `boolean` | Force refresh, ignoring cache. | [packages/core/src/registry/fetcher.ts:29](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/registry/fetcher.ts#L29) | -| `registryUrl?` | `string` | Custom registry URL. | [packages/core/src/registry/fetcher.ts:25](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/registry/fetcher.ts#L25) | -| `timeout?` | `number` | Request timeout in milliseconds. | [packages/core/src/registry/fetcher.ts:35](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/registry/fetcher.ts#L35) | +| `auth?` | [`AuthConfig`](auth.qmd#symbol-interface-authconfig) | Authentication configuration. | [packages/core/src/registry/fetcher.ts:33](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/registry/fetcher.ts#L33) | +| `cacheDir?` | `string` | Cache directory (uses platform default if not provided). | [packages/core/src/registry/fetcher.ts:27](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/registry/fetcher.ts#L27) | +| `cacheTtl?` | `number` | Cache TTL in milliseconds (default: 24 hours). | [packages/core/src/registry/fetcher.ts:31](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/registry/fetcher.ts#L31) | +| `forceRefresh?` | `boolean` | Force refresh, ignoring cache. | [packages/core/src/registry/fetcher.ts:29](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/registry/fetcher.ts#L29) | +| `registryUrl?` | `string` | Custom registry URL. | [packages/core/src/registry/fetcher.ts:25](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/registry/fetcher.ts#L25) | +| `timeout?` | `number` | Request timeout in milliseconds. | [packages/core/src/registry/fetcher.ts:35](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/registry/fetcher.ts#L35) | ## SearchOptions {#symbol-interface-searchoptions} -Defined in: [packages/core/src/registry/search.ts:52](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/registry/search.ts#L52) +Defined in: [packages/core/src/registry/search.ts:52](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/registry/search.ts#L52) Options for searching extensions. @@ -518,16 +518,16 @@ Options for searching extensions. | Property | Type | Description | Inherited from | Defined in | | ---------------------------------------------------- | ----------------------------------------------------------- | -------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `auth?` | [`AuthConfig`](auth.qmd#symbol-interface-authconfig) | Authentication configuration. | [`ListAvailableOptions`](registry.qmd#symbol-interface-listavailableoptions).[`auth`](registry.qmd#symbol-interface-listavailableoptions-property-auth) | [packages/core/src/registry/fetcher.ts:33](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/registry/fetcher.ts#L33) | -| `cacheDir?` | `string` | Cache directory (uses platform default if not provided). | [`ListAvailableOptions`](registry.qmd#symbol-interface-listavailableoptions).[`cacheDir`](registry.qmd#symbol-interface-listavailableoptions-property-cachedir) | [packages/core/src/registry/fetcher.ts:27](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/registry/fetcher.ts#L27) | -| `cacheTtl?` | `number` | Cache TTL in milliseconds (default: 24 hours). | [`ListAvailableOptions`](registry.qmd#symbol-interface-listavailableoptions).[`cacheTtl`](registry.qmd#symbol-interface-listavailableoptions-property-cachettl) | [packages/core/src/registry/fetcher.ts:31](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/registry/fetcher.ts#L31) | -| `forceRefresh?` | `boolean` | Force refresh, ignoring cache. | [`ListAvailableOptions`](registry.qmd#symbol-interface-listavailableoptions).[`forceRefresh`](registry.qmd#symbol-interface-listavailableoptions-property-forcerefresh) | [packages/core/src/registry/fetcher.ts:29](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/registry/fetcher.ts#L29) | -| `limit?` | `number` | Maximum number of results. | [`ListAvailableOptions`](registry.qmd#symbol-interface-listavailableoptions).[`limit`](registry.qmd#symbol-interface-listavailableoptions-property-limit) | [packages/core/src/registry/search.ts:46](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/registry/search.ts#L46) | -| `minStars?` | `number` | Minimum star count. | - | [packages/core/src/registry/search.ts:54](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/registry/search.ts#L54) | -| `registryUrl?` | `string` | Custom registry URL. | [`ListAvailableOptions`](registry.qmd#symbol-interface-listavailableoptions).[`registryUrl`](registry.qmd#symbol-interface-listavailableoptions-property-registryurl) | [packages/core/src/registry/fetcher.ts:25](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/registry/fetcher.ts#L25) | -| `templatesOnly?` | `boolean` | Filter to templates only. | [`ListAvailableOptions`](registry.qmd#symbol-interface-listavailableoptions).[`templatesOnly`](registry.qmd#symbol-interface-listavailableoptions-property-templatesonly) | [packages/core/src/registry/search.ts:44](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/registry/search.ts#L44) | -| `timeout?` | `number` | Request timeout in milliseconds. | [`ListAvailableOptions`](registry.qmd#symbol-interface-listavailableoptions).[`timeout`](registry.qmd#symbol-interface-listavailableoptions-property-timeout) | [packages/core/src/registry/fetcher.ts:35](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/registry/fetcher.ts#L35) | -| `type?` | [`ExtensionType`](types.qmd#symbol-typealias-extensiontype) | Filter by extension type (based on topics). | [`ListAvailableOptions`](registry.qmd#symbol-interface-listavailableoptions).[`type`](registry.qmd#symbol-interface-listavailableoptions-property-type) | [packages/core/src/registry/search.ts:42](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/registry/search.ts#L42) | +| `auth?` | [`AuthConfig`](auth.qmd#symbol-interface-authconfig) | Authentication configuration. | [`ListAvailableOptions`](registry.qmd#symbol-interface-listavailableoptions).[`auth`](registry.qmd#symbol-interface-listavailableoptions-property-auth) | [packages/core/src/registry/fetcher.ts:33](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/registry/fetcher.ts#L33) | +| `cacheDir?` | `string` | Cache directory (uses platform default if not provided). | [`ListAvailableOptions`](registry.qmd#symbol-interface-listavailableoptions).[`cacheDir`](registry.qmd#symbol-interface-listavailableoptions-property-cachedir) | [packages/core/src/registry/fetcher.ts:27](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/registry/fetcher.ts#L27) | +| `cacheTtl?` | `number` | Cache TTL in milliseconds (default: 24 hours). | [`ListAvailableOptions`](registry.qmd#symbol-interface-listavailableoptions).[`cacheTtl`](registry.qmd#symbol-interface-listavailableoptions-property-cachettl) | [packages/core/src/registry/fetcher.ts:31](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/registry/fetcher.ts#L31) | +| `forceRefresh?` | `boolean` | Force refresh, ignoring cache. | [`ListAvailableOptions`](registry.qmd#symbol-interface-listavailableoptions).[`forceRefresh`](registry.qmd#symbol-interface-listavailableoptions-property-forcerefresh) | [packages/core/src/registry/fetcher.ts:29](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/registry/fetcher.ts#L29) | +| `limit?` | `number` | Maximum number of results. | [`ListAvailableOptions`](registry.qmd#symbol-interface-listavailableoptions).[`limit`](registry.qmd#symbol-interface-listavailableoptions-property-limit) | [packages/core/src/registry/search.ts:46](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/registry/search.ts#L46) | +| `minStars?` | `number` | Minimum star count. | - | [packages/core/src/registry/search.ts:54](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/registry/search.ts#L54) | +| `registryUrl?` | `string` | Custom registry URL. | [`ListAvailableOptions`](registry.qmd#symbol-interface-listavailableoptions).[`registryUrl`](registry.qmd#symbol-interface-listavailableoptions-property-registryurl) | [packages/core/src/registry/fetcher.ts:25](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/registry/fetcher.ts#L25) | +| `templatesOnly?` | `boolean` | Filter to templates only. | [`ListAvailableOptions`](registry.qmd#symbol-interface-listavailableoptions).[`templatesOnly`](registry.qmd#symbol-interface-listavailableoptions-property-templatesonly) | [packages/core/src/registry/search.ts:44](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/registry/search.ts#L44) | +| `timeout?` | `number` | Request timeout in milliseconds. | [`ListAvailableOptions`](registry.qmd#symbol-interface-listavailableoptions).[`timeout`](registry.qmd#symbol-interface-listavailableoptions-property-timeout) | [packages/core/src/registry/fetcher.ts:35](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/registry/fetcher.ts#L35) | +| `type?` | [`ExtensionType`](types.qmd#symbol-typealias-extensiontype) | Filter by extension type (based on topics). | [`ListAvailableOptions`](registry.qmd#symbol-interface-listavailableoptions).[`type`](registry.qmd#symbol-interface-listavailableoptions-property-type) | [packages/core/src/registry/search.ts:42](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/registry/search.ts#L42) | ## DEFAULT_CACHE_TTL {#symbol-variable-default-cache-ttl} @@ -535,6 +535,6 @@ Options for searching extensions. const DEFAULT_CACHE_TTL: number; ``` -Defined in: [packages/core/src/registry/cache.ts:16](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/registry/cache.ts#L16) +Defined in: [packages/core/src/registry/cache.ts:16](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/registry/cache.ts#L16) Default cache TTL: 24 hours in milliseconds. diff --git a/docs/api/core/samlSso.qmd b/docs/api/core/samlSso.qmd index ee3f0645..7061fa63 100644 --- a/docs/api/core/samlSso.qmd +++ b/docs/api/core/samlSso.qmd @@ -33,7 +33,7 @@ input. This module: function detectSamlSsoError(response, messagePrefix): SamlSsoError | undefined; ``` -Defined in: [packages/core/src/samlSso.ts:68](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/samlSso.ts#L68) +Defined in: [packages/core/src/samlSso.ts:68](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/samlSso.ts#L68) Detect a SAML SSO enforcement error from a non-ok HTTP response. diff --git a/docs/api/core/types.qmd b/docs/api/core/types.qmd index dfb76094..0952db38 100644 --- a/docs/api/core/types.qmd +++ b/docs/api/core/types.qmd @@ -76,7 +76,7 @@ Defines types for registry entries and the registry data structure. function formatExtensionId(id): string; ``` -Defined in: [packages/core/src/types/extension.ts:93](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/types/extension.ts#L93) +Defined in: [packages/core/src/types/extension.ts:93](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/types/extension.ts#L93) Format an ExtensionId object as a string. @@ -98,7 +98,7 @@ Formatted string (e.g., "quarto-ext/lightbox" or "lightbox") function formatExtensionRef(ref): string; ``` -Defined in: [packages/core/src/types/extension.ts:158](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/types/extension.ts#L158) +Defined in: [packages/core/src/types/extension.ts:158](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/types/extension.ts#L158) Format an ExtensionRef object as a string. @@ -120,7 +120,7 @@ Formatted string (e.g., "quarto-ext/lightbox@v1.0.0") function getEffectiveSourceType(manifest): SourceType | undefined; ``` -Defined in: [packages/core/src/types/manifest.ts:215](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/types/manifest.ts#L215) +Defined in: [packages/core/src/types/manifest.ts:215](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/types/manifest.ts#L215) Resolve the effective source type for a manifest, preferring the explicit `sourceType` field and falling back to inference from the source string. @@ -143,7 +143,7 @@ The resolved source type, or undefined if it cannot be determined function getExtensionTypes(manifest): ExtensionType[]; ``` -Defined in: [packages/core/src/types/manifest.ts:78](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/types/manifest.ts#L78) +Defined in: [packages/core/src/types/manifest.ts:78](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/types/manifest.ts#L78) Get the extension types from a manifest based on its contributions. @@ -165,7 +165,7 @@ Array of extension types function inferSourceType(source): SourceType | undefined; ``` -Defined in: [packages/core/src/types/manifest.ts:192](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/types/manifest.ts#L192) +Defined in: [packages/core/src/types/manifest.ts:192](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/types/manifest.ts#L192) Infer the source type from a raw source string when no explicit `source-type` was recorded in the manifest (legacy installations). @@ -188,7 +188,7 @@ Inferred source type, or undefined if the string is unrecognised function normaliseManifest(raw): ExtensionManifest; ``` -Defined in: [packages/core/src/types/manifest.ts:115](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/types/manifest.ts#L115) +Defined in: [packages/core/src/types/manifest.ts:115](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/types/manifest.ts#L115) Convert a raw manifest from YAML to a normalised ExtensionManifest. @@ -210,7 +210,7 @@ Normalised ExtensionManifest function parseExtensionId(input): ExtensionId; ``` -Defined in: [packages/core/src/types/extension.ts:50](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/types/extension.ts#L50) +Defined in: [packages/core/src/types/extension.ts:50](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/types/extension.ts#L50) Parse an extension ID string into an ExtensionId object. @@ -232,7 +232,7 @@ Parsed ExtensionId object function parseExtensionRef(input): ExtensionRef; ``` -Defined in: [packages/core/src/types/extension.ts:132](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/types/extension.ts#L132) +Defined in: [packages/core/src/types/extension.ts:132](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/types/extension.ts#L132) Parse an extension reference string into an ExtensionRef object. @@ -254,7 +254,7 @@ Parsed ExtensionRef object function parseRegistry(raw): Registry; ``` -Defined in: [packages/core/src/types/registry.ts:150](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/types/registry.ts#L150) +Defined in: [packages/core/src/types/registry.ts:150](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/types/registry.ts#L150) Parse a raw registry object into a normalised Registry. @@ -276,7 +276,7 @@ Normalised Registry function parseRegistryEntry(key, raw): RegistryEntry; ``` -Defined in: [packages/core/src/types/registry.ts:120](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/types/registry.ts#L120) +Defined in: [packages/core/src/types/registry.ts:120](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/types/registry.ts#L120) Parse a raw registry entry into a normalised RegistryEntry. @@ -299,7 +299,7 @@ Normalised RegistryEntry function parseVersionSpec(input): VersionSpec; ``` -Defined in: [packages/core/src/types/extension.ts:105](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/types/extension.ts#L105) +Defined in: [packages/core/src/types/extension.ts:105](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/types/extension.ts#L105) Parse a version specification string. @@ -323,7 +323,7 @@ Parsed VersionSpec function splitSourceRef(source): object; ``` -Defined in: [packages/core/src/types/manifest.ts:159](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/types/manifest.ts#L159) +Defined in: [packages/core/src/types/manifest.ts:159](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/types/manifest.ts#L159) Split a source string of the form `base@ref` into its base and an indicator of whether an explicit ref was present. @@ -354,7 +354,7 @@ hasRef: boolean; ## Contributes {#symbol-interface-contributes} -Defined in: [packages/core/src/types/manifest.ts:16](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/types/manifest.ts#L16) +Defined in: [packages/core/src/types/manifest.ts:16](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/types/manifest.ts#L16) Contributions an extension can provide to Quarto. Uses singular forms normalised from YAML plural keys. @@ -363,16 +363,16 @@ Uses singular forms normalised from YAML plural keys. | Property | Type | Description | Defined in | | ------------------------------------------------------ | ------------------------- | -------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `filter?` | `string[]` | Lua filters provided by the extension. | [packages/core/src/types/manifest.ts:18](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/types/manifest.ts#L18) | -| `format?` | `Record` | Custom formats provided by the extension. | [packages/core/src/types/manifest.ts:22](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/types/manifest.ts#L22) | -| `metadata?` | `unknown` | Metadata contributions. | [packages/core/src/types/manifest.ts:28](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/types/manifest.ts#L28) | -| `project?` | `unknown` | Project type contributions. | [packages/core/src/types/manifest.ts:24](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/types/manifest.ts#L24) | -| `revealjsPlugin?` | `string[]` | Reveal.js plugins provided by the extension. | [packages/core/src/types/manifest.ts:26](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/types/manifest.ts#L26) | -| `shortcode?` | `string[]` | Shortcodes provided by the extension. | [packages/core/src/types/manifest.ts:20](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/types/manifest.ts#L20) | +| `filter?` | `string[]` | Lua filters provided by the extension. | [packages/core/src/types/manifest.ts:18](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/types/manifest.ts#L18) | +| `format?` | `Record` | Custom formats provided by the extension. | [packages/core/src/types/manifest.ts:22](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/types/manifest.ts#L22) | +| `metadata?` | `unknown` | Metadata contributions. | [packages/core/src/types/manifest.ts:28](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/types/manifest.ts#L28) | +| `project?` | `unknown` | Project type contributions. | [packages/core/src/types/manifest.ts:24](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/types/manifest.ts#L24) | +| `revealjsPlugin?` | `string[]` | Reveal.js plugins provided by the extension. | [packages/core/src/types/manifest.ts:26](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/types/manifest.ts#L26) | +| `shortcode?` | `string[]` | Shortcodes provided by the extension. | [packages/core/src/types/manifest.ts:20](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/types/manifest.ts#L20) | ## ExtensionId {#symbol-interface-extensionid} -Defined in: [packages/core/src/types/extension.ts:14](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/types/extension.ts#L14) +Defined in: [packages/core/src/types/extension.ts:14](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/types/extension.ts#L14) Unique identifier for a Quarto extension. Supports both "owner/name" and name-only patterns. @@ -381,12 +381,12 @@ Supports both "owner/name" and name-only patterns. | Property | Type | Description | Defined in | | ----------------------------------- | ------------------ | -------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `name` | `string` | The name of the extension. | [packages/core/src/types/extension.ts:18](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/types/extension.ts#L18) | -| `owner` | `string` \| `null` | The owner (user or organisation) of the extension. | [packages/core/src/types/extension.ts:16](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/types/extension.ts#L16) | +| `name` | `string` | The name of the extension. | [packages/core/src/types/extension.ts:18](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/types/extension.ts#L18) | +| `owner` | `string` \| `null` | The owner (user or organisation) of the extension. | [packages/core/src/types/extension.ts:16](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/types/extension.ts#L16) | ## ExtensionManifest {#symbol-interface-extensionmanifest} -Defined in: [packages/core/src/types/manifest.ts:34](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/types/manifest.ts#L34) +Defined in: [packages/core/src/types/manifest.ts:34](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/types/manifest.ts#L34) Parsed extension manifest from \_extension.yml. @@ -394,17 +394,17 @@ Parsed extension manifest from \_extension.yml. | Property | Type | Description | Defined in | | ------------------------------------------------------ | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `author` | `string` | Author of the extension. | [packages/core/src/types/manifest.ts:38](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/types/manifest.ts#L38) | -| `contributes` | [`Contributes`](types.qmd#symbol-interface-contributes) | Contributions provided by the extension. | [packages/core/src/types/manifest.ts:44](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/types/manifest.ts#L44) | -| `quartoRequired?` | `string` | Minimum required Quarto version. | [packages/core/src/types/manifest.ts:42](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/types/manifest.ts#L42) | -| `source?` | `string` | Source URL or reference (added during installation). | [packages/core/src/types/manifest.ts:46](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/types/manifest.ts#L46) | -| `sourceType?` | [`SourceType`](types.qmd#symbol-typealias-sourcetype) | Source type indicating how the extension was installed. | [packages/core/src/types/manifest.ts:48](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/types/manifest.ts#L48) | -| `title` | `string` | Display title of the extension. | [packages/core/src/types/manifest.ts:36](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/types/manifest.ts#L36) | -| `version` | `string` | Version string of the extension. | [packages/core/src/types/manifest.ts:40](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/types/manifest.ts#L40) | +| `author` | `string` | Author of the extension. | [packages/core/src/types/manifest.ts:38](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/types/manifest.ts#L38) | +| `contributes` | [`Contributes`](types.qmd#symbol-interface-contributes) | Contributions provided by the extension. | [packages/core/src/types/manifest.ts:44](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/types/manifest.ts#L44) | +| `quartoRequired?` | `string` | Minimum required Quarto version. | [packages/core/src/types/manifest.ts:42](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/types/manifest.ts#L42) | +| `source?` | `string` | Source URL or reference (added during installation). | [packages/core/src/types/manifest.ts:46](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/types/manifest.ts#L46) | +| `sourceType?` | [`SourceType`](types.qmd#symbol-typealias-sourcetype) | Source type indicating how the extension was installed. | [packages/core/src/types/manifest.ts:48](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/types/manifest.ts#L48) | +| `title` | `string` | Display title of the extension. | [packages/core/src/types/manifest.ts:36](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/types/manifest.ts#L36) | +| `version` | `string` | Version string of the extension. | [packages/core/src/types/manifest.ts:40](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/types/manifest.ts#L40) | ## ExtensionRef {#symbol-interface-extensionref} -Defined in: [packages/core/src/types/extension.ts:34](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/types/extension.ts#L34) +Defined in: [packages/core/src/types/extension.ts:34](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/types/extension.ts#L34) Reference to an extension with optional version specification. @@ -412,12 +412,12 @@ Reference to an extension with optional version specification. | Property | Type | Defined in | | --------------------------------------- | ------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | [`ExtensionId`](types.qmd#symbol-interface-extensionid) | [packages/core/src/types/extension.ts:35](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/types/extension.ts#L35) | -| `version` | [`VersionSpec`](types.qmd#symbol-typealias-versionspec) | [packages/core/src/types/extension.ts:36](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/types/extension.ts#L36) | +| `id` | [`ExtensionId`](types.qmd#symbol-interface-extensionid) | [packages/core/src/types/extension.ts:35](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/types/extension.ts#L35) | +| `version` | [`VersionSpec`](types.qmd#symbol-typealias-versionspec) | [packages/core/src/types/extension.ts:36](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/types/extension.ts#L36) | ## RawManifest {#symbol-interface-rawmanifest} -Defined in: [packages/core/src/types/manifest.ts:55](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/types/manifest.ts#L55) +Defined in: [packages/core/src/types/manifest.ts:55](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/types/manifest.ts#L55) Raw manifest data as parsed from YAML. This matches the structure of \_extension.yml files. @@ -426,23 +426,23 @@ This matches the structure of \_extension.yml files. | Property | Type | Defined in | | -------------------------------------------------------- | ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `author?` | `string` | [packages/core/src/types/manifest.ts:57](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/types/manifest.ts#L57) | -| `contributes?` | `object` | [packages/core/src/types/manifest.ts:60](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/types/manifest.ts#L60) | -| `contributes.filters?` | `string[]` | [packages/core/src/types/manifest.ts:61](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/types/manifest.ts#L61) | -| `contributes.formats?` | `Record` | [packages/core/src/types/manifest.ts:63](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/types/manifest.ts#L63) | -| `contributes.metadata?` | `unknown` | [packages/core/src/types/manifest.ts:66](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/types/manifest.ts#L66) | -| `contributes.project?` | `unknown` | [packages/core/src/types/manifest.ts:64](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/types/manifest.ts#L64) | -| `contributes.revealjs-plugins?` | `string[]` | [packages/core/src/types/manifest.ts:65](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/types/manifest.ts#L65) | -| `contributes.shortcodes?` | `string[]` | [packages/core/src/types/manifest.ts:62](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/types/manifest.ts#L62) | -| `quarto-required?` | `string` | [packages/core/src/types/manifest.ts:59](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/types/manifest.ts#L59) | -| `source?` | `string` | [packages/core/src/types/manifest.ts:68](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/types/manifest.ts#L68) | -| `source-type?` | `string` | [packages/core/src/types/manifest.ts:69](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/types/manifest.ts#L69) | -| `title?` | `string` | [packages/core/src/types/manifest.ts:56](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/types/manifest.ts#L56) | -| `version?` | `string` \| `number` | [packages/core/src/types/manifest.ts:58](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/types/manifest.ts#L58) | +| `author?` | `string` | [packages/core/src/types/manifest.ts:57](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/types/manifest.ts#L57) | +| `contributes?` | `object` | [packages/core/src/types/manifest.ts:60](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/types/manifest.ts#L60) | +| `contributes.filters?` | `string[]` | [packages/core/src/types/manifest.ts:61](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/types/manifest.ts#L61) | +| `contributes.formats?` | `Record` | [packages/core/src/types/manifest.ts:63](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/types/manifest.ts#L63) | +| `contributes.metadata?` | `unknown` | [packages/core/src/types/manifest.ts:66](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/types/manifest.ts#L66) | +| `contributes.project?` | `unknown` | [packages/core/src/types/manifest.ts:64](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/types/manifest.ts#L64) | +| `contributes.revealjs-plugins?` | `string[]` | [packages/core/src/types/manifest.ts:65](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/types/manifest.ts#L65) | +| `contributes.shortcodes?` | `string[]` | [packages/core/src/types/manifest.ts:62](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/types/manifest.ts#L62) | +| `quarto-required?` | `string` | [packages/core/src/types/manifest.ts:59](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/types/manifest.ts#L59) | +| `source?` | `string` | [packages/core/src/types/manifest.ts:68](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/types/manifest.ts#L68) | +| `source-type?` | `string` | [packages/core/src/types/manifest.ts:69](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/types/manifest.ts#L69) | +| `title?` | `string` | [packages/core/src/types/manifest.ts:56](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/types/manifest.ts#L56) | +| `version?` | `string` \| `number` | [packages/core/src/types/manifest.ts:58](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/types/manifest.ts#L58) | ## RawRegistryEntry {#symbol-interface-rawregistryentry} -Defined in: [packages/core/src/types/registry.ts:82](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/types/registry.ts#L82) +Defined in: [packages/core/src/types/registry.ts:82](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/types/registry.ts#L82) Raw registry entry as returned from the JSON API. @@ -477,24 +477,24 @@ to `RawRegistryEntry` objects. | Property | Type | Description | Defined in | | ---------------------------------------------------------- | ------------------ | ----------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `contributes?` | `string[]` | What the extension contributes (e.g., "filter", "shortcode", "format", "project", "revealjs-plugin", "metadata"). | [packages/core/src/types/registry.ts:94](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/types/registry.ts#L94) | -| `defaultBranchRef?` | `string` \| `null` | Default branch name (e.g., "main", "master"). | [packages/core/src/types/registry.ts:108](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/types/registry.ts#L108) | -| `description?` | `string` \| `null` | Extension description. | [packages/core/src/types/registry.ts:90](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/types/registry.ts#L90) | -| `latestCommit?` | `string` \| `null` | SHA of the latest commit on the default branch. | [packages/core/src/types/registry.ts:110](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/types/registry.ts#L110) | -| `latestRelease?` | `string` \| `null` | Latest release tag (e.g., "v1.0.0"). | [packages/core/src/types/registry.ts:96](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/types/registry.ts#L96) | -| `latestReleaseUrl?` | `string` \| `null` | URL to the latest release page on GitHub. | [packages/core/src/types/registry.ts:98](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/types/registry.ts#L98) | -| `licenseInfo?` | `string` \| `null` | SPDX licence identifier (e.g., "MIT", "GPL-3.0"). | [packages/core/src/types/registry.ts:102](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/types/registry.ts#L102) | -| `nameWithOwner` | `string` | Full repository name in "owner/repo" format. Required. | [packages/core/src/types/registry.ts:88](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/types/registry.ts#L88) | -| `owner` | `string` | Repository owner (GitHub username or organisation). Required. | [packages/core/src/types/registry.ts:84](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/types/registry.ts#L84) | -| `repositoryTopics?` | `string[]` | GitHub repository topics/tags for categorisation. | [packages/core/src/types/registry.ts:92](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/types/registry.ts#L92) | -| `stargazerCount?` | `number` | GitHub star count. | [packages/core/src/types/registry.ts:100](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/types/registry.ts#L100) | -| `template?` | `boolean` | Whether this extension provides project templates. | [packages/core/src/types/registry.ts:106](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/types/registry.ts#L106) | -| `title` | `string` | Display name/title of the extension. Required. | [packages/core/src/types/registry.ts:86](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/types/registry.ts#L86) | -| `url` | `string` | GitHub repository URL. Required. | [packages/core/src/types/registry.ts:104](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/types/registry.ts#L104) | +| `contributes?` | `string[]` | What the extension contributes (e.g., "filter", "shortcode", "format", "project", "revealjs-plugin", "metadata"). | [packages/core/src/types/registry.ts:94](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/types/registry.ts#L94) | +| `defaultBranchRef?` | `string` \| `null` | Default branch name (e.g., "main", "master"). | [packages/core/src/types/registry.ts:108](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/types/registry.ts#L108) | +| `description?` | `string` \| `null` | Extension description. | [packages/core/src/types/registry.ts:90](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/types/registry.ts#L90) | +| `latestCommit?` | `string` \| `null` | SHA of the latest commit on the default branch. | [packages/core/src/types/registry.ts:110](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/types/registry.ts#L110) | +| `latestRelease?` | `string` \| `null` | Latest release tag (e.g., "v1.0.0"). | [packages/core/src/types/registry.ts:96](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/types/registry.ts#L96) | +| `latestReleaseUrl?` | `string` \| `null` | URL to the latest release page on GitHub. | [packages/core/src/types/registry.ts:98](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/types/registry.ts#L98) | +| `licenseInfo?` | `string` \| `null` | SPDX licence identifier (e.g., "MIT", "GPL-3.0"). | [packages/core/src/types/registry.ts:102](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/types/registry.ts#L102) | +| `nameWithOwner` | `string` | Full repository name in "owner/repo" format. Required. | [packages/core/src/types/registry.ts:88](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/types/registry.ts#L88) | +| `owner` | `string` | Repository owner (GitHub username or organisation). Required. | [packages/core/src/types/registry.ts:84](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/types/registry.ts#L84) | +| `repositoryTopics?` | `string[]` | GitHub repository topics/tags for categorisation. | [packages/core/src/types/registry.ts:92](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/types/registry.ts#L92) | +| `stargazerCount?` | `number` | GitHub star count. | [packages/core/src/types/registry.ts:100](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/types/registry.ts#L100) | +| `template?` | `boolean` | Whether this extension provides project templates. | [packages/core/src/types/registry.ts:106](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/types/registry.ts#L106) | +| `title` | `string` | Display name/title of the extension. Required. | [packages/core/src/types/registry.ts:86](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/types/registry.ts#L86) | +| `url` | `string` | GitHub repository URL. Required. | [packages/core/src/types/registry.ts:104](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/types/registry.ts#L104) | ## RegistryEntry {#symbol-interface-registryentry} -Defined in: [packages/core/src/types/registry.ts:13](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/types/registry.ts#L13) +Defined in: [packages/core/src/types/registry.ts:13](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/types/registry.ts#L13) Entry for an extension in the registry. @@ -502,22 +502,22 @@ Entry for an extension in the registry. | Property | Type | Description | Defined in | | --------------------------------------------------------- | ------------------ | -------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `contributes` | `string[]` | What the extension contributes (e.g., filters, formats, shortcodes). | [packages/core/src/types/registry.ts:27](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/types/registry.ts#L27) | -| `defaultBranchRef` | `string` \| `null` | Default branch name (e.g., "main", "master"). | [packages/core/src/types/registry.ts:43](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/types/registry.ts#L43) | -| `description` | `string` \| `null` | Extension description. | [packages/core/src/types/registry.ts:23](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/types/registry.ts#L23) | -| `fullName` | `string` | The full repository name (owner/repo format). | [packages/core/src/types/registry.ts:21](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/types/registry.ts#L21) | -| `htmlUrl` | `string` | GitHub repository URL. | [packages/core/src/types/registry.ts:39](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/types/registry.ts#L39) | -| `id` | `string` | Unique key in the registry (usually owner/repo). | [packages/core/src/types/registry.ts:15](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/types/registry.ts#L15) | -| `latestCommit` | `string` \| `null` | SHA of the latest commit on the default branch. | [packages/core/src/types/registry.ts:45](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/types/registry.ts#L45) | -| `latestReleaseUrl` | `string` \| `null` | URL to the latest release page. | [packages/core/src/types/registry.ts:33](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/types/registry.ts#L33) | -| `latestTag` | `string` \| `null` | Latest release tag (with 'v' prefix if present). | [packages/core/src/types/registry.ts:31](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/types/registry.ts#L31) | -| `latestVersion` | `string` \| `null` | Latest version (without 'v' prefix). | [packages/core/src/types/registry.ts:29](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/types/registry.ts#L29) | -| `licence` | `string` \| `null` | Licence information. | [packages/core/src/types/registry.ts:37](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/types/registry.ts#L37) | -| `name` | `string` | The display name/title. | [packages/core/src/types/registry.ts:19](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/types/registry.ts#L19) | -| `owner` | `string` | The owner (user or organisation). | [packages/core/src/types/registry.ts:17](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/types/registry.ts#L17) | -| `stars` | `number` | GitHub star count. | [packages/core/src/types/registry.ts:35](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/types/registry.ts#L35) | -| `template` | `boolean` | Whether this extension provides templates. | [packages/core/src/types/registry.ts:41](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/types/registry.ts#L41) | -| `topics` | `string[]` | Repository topics/tags. | [packages/core/src/types/registry.ts:25](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/types/registry.ts#L25) | +| `contributes` | `string[]` | What the extension contributes (e.g., filters, formats, shortcodes). | [packages/core/src/types/registry.ts:27](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/types/registry.ts#L27) | +| `defaultBranchRef` | `string` \| `null` | Default branch name (e.g., "main", "master"). | [packages/core/src/types/registry.ts:43](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/types/registry.ts#L43) | +| `description` | `string` \| `null` | Extension description. | [packages/core/src/types/registry.ts:23](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/types/registry.ts#L23) | +| `fullName` | `string` | The full repository name (owner/repo format). | [packages/core/src/types/registry.ts:21](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/types/registry.ts#L21) | +| `htmlUrl` | `string` | GitHub repository URL. | [packages/core/src/types/registry.ts:39](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/types/registry.ts#L39) | +| `id` | `string` | Unique key in the registry (usually owner/repo). | [packages/core/src/types/registry.ts:15](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/types/registry.ts#L15) | +| `latestCommit` | `string` \| `null` | SHA of the latest commit on the default branch. | [packages/core/src/types/registry.ts:45](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/types/registry.ts#L45) | +| `latestReleaseUrl` | `string` \| `null` | URL to the latest release page. | [packages/core/src/types/registry.ts:33](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/types/registry.ts#L33) | +| `latestTag` | `string` \| `null` | Latest release tag (with 'v' prefix if present). | [packages/core/src/types/registry.ts:31](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/types/registry.ts#L31) | +| `latestVersion` | `string` \| `null` | Latest version (without 'v' prefix). | [packages/core/src/types/registry.ts:29](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/types/registry.ts#L29) | +| `licence` | `string` \| `null` | Licence information. | [packages/core/src/types/registry.ts:37](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/types/registry.ts#L37) | +| `name` | `string` | The display name/title. | [packages/core/src/types/registry.ts:19](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/types/registry.ts#L19) | +| `owner` | `string` | The owner (user or organisation). | [packages/core/src/types/registry.ts:17](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/types/registry.ts#L17) | +| `stars` | `number` | GitHub star count. | [packages/core/src/types/registry.ts:35](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/types/registry.ts#L35) | +| `template` | `boolean` | Whether this extension provides templates. | [packages/core/src/types/registry.ts:41](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/types/registry.ts#L41) | +| `topics` | `string[]` | Repository topics/tags. | [packages/core/src/types/registry.ts:25](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/types/registry.ts#L25) | ## ExtensionType {#symbol-typealias-extensiontype} @@ -531,7 +531,7 @@ type ExtensionType = | "metadata"; ``` -Defined in: [packages/core/src/types/extension.ts:42](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/types/extension.ts#L42) +Defined in: [packages/core/src/types/extension.ts:42](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/types/extension.ts#L42) Types of contributions an extension can provide. @@ -541,7 +541,7 @@ Types of contributions an extension can provide. type Registry = Record; ``` -Defined in: [packages/core/src/types/registry.ts:51](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/types/registry.ts#L51) +Defined in: [packages/core/src/types/registry.ts:51](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/types/registry.ts#L51) The full registry mapping extension IDs to their entries. @@ -551,7 +551,7 @@ The full registry mapping extension IDs to their entries. type SourceType = "github" | "url" | "local" | "registry"; ``` -Defined in: [packages/core/src/types/manifest.ts:135](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/types/manifest.ts#L135) +Defined in: [packages/core/src/types/manifest.ts:135](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/types/manifest.ts#L135) Valid source types for extension installation. @@ -580,6 +580,6 @@ type VersionSpec = }; ``` -Defined in: [packages/core/src/types/extension.ts:24](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/core/src/types/extension.ts#L24) +Defined in: [packages/core/src/types/extension.ts:24](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/core/src/types/extension.ts#L24) Version specification for extension references. diff --git a/docs/api/schema/errors.qmd b/docs/api/schema/errors.qmd index c7a3f6c9..9cd57b3d 100644 --- a/docs/api/schema/errors.qmd +++ b/docs/api/schema/errors.qmd @@ -16,7 +16,7 @@ Error types for @quarto-wizard/schema. ## SchemaError {#symbol-class-schemaerror} -Defined in: [packages/schema/src/errors.ts:11](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/schema/src/errors.ts#L11) +Defined in: [packages/schema/src/errors.ts:11](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/errors.ts#L11) Error when parsing a schema file fails. @@ -32,7 +32,7 @@ Error when parsing a schema file fails. new SchemaError(message, options?): SchemaError; ``` -Defined in: [packages/schema/src/errors.ts:19](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/schema/src/errors.ts#L19) +Defined in: [packages/schema/src/errors.ts:19](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/errors.ts#L19) ##### Parameters @@ -75,7 +75,7 @@ Error.cause readonly code: "SCHEMA_ERROR" = "SCHEMA_ERROR"; ``` -Defined in: [packages/schema/src/errors.ts:13](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/schema/src/errors.ts#L13) +Defined in: [packages/schema/src/errors.ts:13](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/errors.ts#L13) Error code for programmatic handling. @@ -113,7 +113,7 @@ Error.name readonly optional schemaPath?: string; ``` -Defined in: [packages/schema/src/errors.ts:15](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/schema/src/errors.ts#L15) +Defined in: [packages/schema/src/errors.ts:15](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/errors.ts#L15) Path to the schema file. @@ -137,7 +137,7 @@ Error.stack readonly optional suggestion?: string; ``` -Defined in: [packages/schema/src/errors.ts:17](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/schema/src/errors.ts#L17) +Defined in: [packages/schema/src/errors.ts:17](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/errors.ts#L17) Suggestion for how to resolve the error. @@ -173,7 +173,7 @@ Error.stackTraceLimit format(): string; ``` -Defined in: [packages/schema/src/errors.ts:33](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/schema/src/errors.ts#L33) +Defined in: [packages/schema/src/errors.ts:33](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/errors.ts#L33) Format the error for display. @@ -285,7 +285,7 @@ Error.prepareStackTrace function getErrorMessage(error): string; ``` -Defined in: [packages/schema/src/errors.ts:45](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/schema/src/errors.ts#L45) +Defined in: [packages/schema/src/errors.ts:45](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/errors.ts#L45) Extract a human-readable message from an unknown error value. diff --git a/docs/api/schema/filesystem.qmd b/docs/api/schema/filesystem.qmd index ef639008..85029ccb 100644 --- a/docs/api/schema/filesystem.qmd +++ b/docs/api/schema/filesystem.qmd @@ -36,7 +36,7 @@ Provides functions to find, parse, and read Quarto extension schemas. ## SchemaCache {#symbol-class-schemacache} -Defined in: [packages/schema/src/filesystem/schema-cache.ts:19](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/schema/src/filesystem/schema-cache.ts#L19) +Defined in: [packages/schema/src/filesystem/schema-cache.ts:19](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/filesystem/schema-cache.ts#L19) Cache for parsed extension schemas. Schemas are loaded lazily on first access. @@ -61,7 +61,7 @@ new SchemaCache(): SchemaCache; get(extensionDir): ExtensionSchema | null; ``` -Defined in: [packages/schema/src/filesystem/schema-cache.ts:30](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/schema/src/filesystem/schema-cache.ts#L30) +Defined in: [packages/schema/src/filesystem/schema-cache.ts:30](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/filesystem/schema-cache.ts#L30) Get the schema for an extension directory. Loads and caches the schema on first access. @@ -84,7 +84,7 @@ Parsed schema or null if no schema file exists getError(extensionDir): string | null; ``` -Defined in: [packages/schema/src/filesystem/schema-cache.ts:57](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/schema/src/filesystem/schema-cache.ts#L57) +Defined in: [packages/schema/src/filesystem/schema-cache.ts:57](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/filesystem/schema-cache.ts#L57) Get the parse error for a schema in the given directory, if any. @@ -106,7 +106,7 @@ Error message or null if no error occurred has(extensionDir): boolean; ``` -Defined in: [packages/schema/src/filesystem/schema-cache.ts:67](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/schema/src/filesystem/schema-cache.ts#L67) +Defined in: [packages/schema/src/filesystem/schema-cache.ts:67](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/filesystem/schema-cache.ts#L67) Check whether a schema is cached for the given directory. @@ -128,7 +128,7 @@ True if a schema is cached invalidate(extensionDir): void; ``` -Defined in: [packages/schema/src/filesystem/schema-cache.ts:76](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/schema/src/filesystem/schema-cache.ts#L76) +Defined in: [packages/schema/src/filesystem/schema-cache.ts:76](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/filesystem/schema-cache.ts#L76) Invalidate the cached schema for a specific extension directory. @@ -148,7 +148,7 @@ Invalidate the cached schema for a specific extension directory. invalidateAll(): void; ``` -Defined in: [packages/schema/src/filesystem/schema-cache.ts:84](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/schema/src/filesystem/schema-cache.ts#L84) +Defined in: [packages/schema/src/filesystem/schema-cache.ts:84](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/filesystem/schema-cache.ts#L84) Invalidate all cached schemas. @@ -162,7 +162,7 @@ Invalidate all cached schemas. function findSchemaFile(directory): string | null; ``` -Defined in: [packages/schema/src/filesystem/schema.ts:38](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/schema/src/filesystem/schema.ts#L38) +Defined in: [packages/schema/src/filesystem/schema.ts:38](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/filesystem/schema.ts#L38) Find the schema file in a directory. @@ -187,7 +187,7 @@ function parseSchemaContent( format?): ExtensionSchema; ``` -Defined in: [packages/schema/src/filesystem/schema.ts:86](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/schema/src/filesystem/schema.ts#L86) +Defined in: [packages/schema/src/filesystem/schema.ts:86](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/filesystem/schema.ts#L86) Parse schema content from a YAML or JSON string. @@ -215,7 +215,7 @@ SchemaError if parsing fails function parseSchemaFile(schemaPath): ExtensionSchema; ``` -Defined in: [packages/schema/src/filesystem/schema.ts:62](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/schema/src/filesystem/schema.ts#L62) +Defined in: [packages/schema/src/filesystem/schema.ts:62](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/filesystem/schema.ts#L62) Parse a schema file from a path. @@ -241,7 +241,7 @@ SchemaError if parsing fails function readSchema(directory): SchemaReadResult | null; ``` -Defined in: [packages/schema/src/filesystem/schema.ts:127](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/schema/src/filesystem/schema.ts#L127) +Defined in: [packages/schema/src/filesystem/schema.ts:127](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/filesystem/schema.ts#L127) Read a schema from a directory. @@ -259,7 +259,7 @@ SchemaReadResult or null if no schema found ## SchemaReadResult {#symbol-interface-schemareadresult} -Defined in: [packages/schema/src/filesystem/schema.ts:23](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/schema/src/filesystem/schema.ts#L23) +Defined in: [packages/schema/src/filesystem/schema.ts:23](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/filesystem/schema.ts#L23) Result of reading a schema file. @@ -267,9 +267,9 @@ Result of reading a schema file. | Property | Type | Description | Defined in | | --------------------------------------------- | --------------------------------------------------------------- | -------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `filename` | `string` | Filename used (e.g., "\_schema.yml" or "\_schema.json"). | [packages/schema/src/filesystem/schema.ts:29](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/schema/src/filesystem/schema.ts#L29) | -| `schema` | [`ExtensionSchema`](types.qmd#symbol-interface-extensionschema) | Parsed schema data. | [packages/schema/src/filesystem/schema.ts:25](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/schema/src/filesystem/schema.ts#L25) | -| `schemaPath` | `string` | Full path to the schema file. | [packages/schema/src/filesystem/schema.ts:27](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/schema/src/filesystem/schema.ts#L27) | +| `filename` | `string` | Filename used (e.g., "\_schema.yml" or "\_schema.json"). | [packages/schema/src/filesystem/schema.ts:29](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/filesystem/schema.ts#L29) | +| `schema` | [`ExtensionSchema`](types.qmd#symbol-interface-extensionschema) | Parsed schema data. | [packages/schema/src/filesystem/schema.ts:25](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/filesystem/schema.ts#L25) | +| `schemaPath` | `string` | Full path to the schema file. | [packages/schema/src/filesystem/schema.ts:27](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/filesystem/schema.ts#L27) | ## SCHEMA_FILENAMES {#symbol-variable-schema-filenames} @@ -277,6 +277,6 @@ Result of reading a schema file. const SCHEMA_FILENAMES: readonly ["_schema.json", "_schema.yml", "_schema.yaml"]; ``` -Defined in: [packages/schema/src/filesystem/schema.ts:18](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/schema/src/filesystem/schema.ts#L18) +Defined in: [packages/schema/src/filesystem/schema.ts:18](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/filesystem/schema.ts#L18) Supported schema file names, ordered by precedence (JSON first). diff --git a/docs/api/schema/types.qmd b/docs/api/schema/types.qmd index 42c13cbb..9ebf3f5e 100644 --- a/docs/api/schema/types.qmd +++ b/docs/api/schema/types.qmd @@ -19,18 +19,28 @@ and the overall extension schema structure. - [RawSchema](types.qmd#symbol-interface-rawschema) - [ShortcodeSchema](types.qmd#symbol-interface-shortcodeschema) +### Type Aliases + +- [SchemaVersion](types.qmd#symbol-typealias-schemaversion) + ### Variables +- [FIELD_ALIAS_PAIRS](types.qmd#symbol-variable-field-alias-pairs) +- [SCHEMA_V1_VERSION_URI](types.qmd#symbol-variable-schema-v1-version-uri) +- [SCHEMA_V2_VERSION_URI](types.qmd#symbol-variable-schema-v2-version-uri) - [SCHEMA_VERSION_URI](types.qmd#symbol-variable-schema-version-uri) - [SUPPORTED_SCHEMA_VERSIONS](types.qmd#symbol-variable-supported-schema-versions) ### Functions - [formatType](types.qmd#symbol-function-formattype) +- [isSupportedSchemaUri](types.qmd#symbol-function-issupportedschemauri) - [normaliseFieldDescriptor](types.qmd#symbol-function-normalisefielddescriptor) - [normaliseFieldDescriptorMap](types.qmd#symbol-function-normalisefielddescriptormap) - [normaliseSchema](types.qmd#symbol-function-normaliseschema) +- [normaliseSchemaUri](types.qmd#symbol-function-normaliseschemauri) - [normaliseShortcodeSchema](types.qmd#symbol-function-normaliseshortcodeschema) +- [resolveSchemaVersion](types.qmd#symbol-function-resolveschemaversion) - [typeIncludes](types.qmd#symbol-function-typeincludes) ## formatType {#symbol-function-formattype} @@ -39,7 +49,7 @@ and the overall extension schema structure. function formatType(typeSpec): string; ``` -Defined in: [packages/schema/src/types/schema.ts:359](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/schema/src/types/schema.ts#L359) +Defined in: [packages/schema/src/types/schema.ts:433](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/types/schema.ts#L433) Format a type spec for display (e.g., "number | boolean"). @@ -55,13 +65,34 @@ Format a type spec for display (e.g., "number | boolean"). Human-readable type string. +## isSupportedSchemaUri {#symbol-function-issupportedschemauri} + +```{.ts filename="TypeScript"} +function isSupportedSchemaUri(schemaUri): boolean; +``` + +Defined in: [packages/schema/src/types/schema.ts:213](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/types/schema.ts#L213) + +Whether a `$schema` URI matches one of the supported schema versions (after +trailing-slash normalisation). + +### Parameters + +| Parameter | Type | +| ----------- | -------- | +| `schemaUri` | `string` | + +### Returns + +`boolean` + ## normaliseFieldDescriptor {#symbol-function-normalisefielddescriptor} ```{.ts filename="TypeScript"} function normaliseFieldDescriptor(raw): FieldDescriptor; ``` -Defined in: [packages/schema/src/types/schema.ts:200](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/schema/src/types/schema.ts#L200) +Defined in: [packages/schema/src/types/schema.ts:272](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/types/schema.ts#L272) Normalise a raw field descriptor from YAML, converting kebab-case keys to camelCase. @@ -83,7 +114,7 @@ Normalised FieldDescriptor function normaliseFieldDescriptorMap(raw): Record; ``` -Defined in: [packages/schema/src/types/schema.ts:226](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/schema/src/types/schema.ts#L226) +Defined in: [packages/schema/src/types/schema.ts:300](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/types/schema.ts#L300) Normalise a map of field descriptors from YAML. @@ -105,7 +136,7 @@ Normalised map of FieldDescriptor objects function normaliseSchema(raw): ExtensionSchema; ``` -Defined in: [packages/schema/src/types/schema.ts:275](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/schema/src/types/schema.ts#L275) +Defined in: [packages/schema/src/types/schema.ts:349](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/types/schema.ts#L349) Normalise a raw schema from YAML to an ExtensionSchema. @@ -121,13 +152,33 @@ Normalise a raw schema from YAML to an ExtensionSchema. Normalised ExtensionSchema +## normaliseSchemaUri {#symbol-function-normaliseschemauri} + +```{.ts filename="TypeScript"} +function normaliseSchemaUri(uri): string; +``` + +Defined in: [packages/schema/src/types/schema.ts:194](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/types/schema.ts#L194) + +Normalise a `$schema` URI for comparison: strip a single trailing slash. + +### Parameters + +| Parameter | Type | +| --------- | -------- | +| `uri` | `string` | + +### Returns + +`string` + ## normaliseShortcodeSchema {#symbol-function-normaliseshortcodeschema} ```{.ts filename="TypeScript"} function normaliseShortcodeSchema(raw): ShortcodeSchema; ``` -Defined in: [packages/schema/src/types/schema.ts:244](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/schema/src/types/schema.ts#L244) +Defined in: [packages/schema/src/types/schema.ts:318](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/types/schema.ts#L318) Normalise a raw shortcode schema from YAML. @@ -143,13 +194,34 @@ Normalise a raw shortcode schema from YAML. Normalised ShortcodeSchema +## resolveSchemaVersion {#symbol-function-resolveschemaversion} + +```{.ts filename="TypeScript"} +function resolveSchemaVersion(schemaUri): SchemaVersion; +``` + +Defined in: [packages/schema/src/types/schema.ts:202](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/types/schema.ts#L202) + +Resolve a schema version from an instance file's `$schema` URI. +Returns `"v1"` when no URI is present or the URI is unrecognised. + +### Parameters + +| Parameter | Type | +| ----------- | ----------------------- | +| `schemaUri` | `string` \| `undefined` | + +### Returns + +[`SchemaVersion`](types.qmd#symbol-typealias-schemaversion) + ## typeIncludes {#symbol-function-typeincludes} ```{.ts filename="TypeScript"} function typeIncludes(typeSpec, name): boolean; ``` -Defined in: [packages/schema/src/types/schema.ts:346](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/schema/src/types/schema.ts#L346) +Defined in: [packages/schema/src/types/schema.ts:420](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/types/schema.ts#L420) Check whether a type spec includes a given type name. @@ -168,7 +240,7 @@ True if the type spec includes the given name. ## ClassDefinition {#symbol-interface-classdefinition} -Defined in: [packages/schema/src/types/schema.ts:109](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/schema/src/types/schema.ts#L109) +Defined in: [packages/schema/src/types/schema.ts:127](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/types/schema.ts#L127) Definition for a CSS class contributed by an extension. @@ -176,11 +248,11 @@ Definition for a CSS class contributed by an extension. | Property | Type | Description | Defined in | | ------------------------------------------------ | -------- | ---------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `description?` | `string` | Human-readable description of the class. | [packages/schema/src/types/schema.ts:111](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/schema/src/types/schema.ts#L111) | +| `description?` | `string` | Human-readable description of the class. | [packages/schema/src/types/schema.ts:129](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/types/schema.ts#L129) | ## CompletionSpec {#symbol-interface-completionspec} -Defined in: [packages/schema/src/types/schema.ts:15](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/schema/src/types/schema.ts#L15) +Defined in: [packages/schema/src/types/schema.ts:15](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/types/schema.ts#L15) Completion specification for a field. Describes how a field's value should be completed in an editor. @@ -189,16 +261,16 @@ Describes how a field's value should be completed in an editor. | Property | Type | Description | Defined in | | ------------------------------------------------ | ---------- | --------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `dynamic?` | `boolean` | Whether completion values are dynamically resolved. | [packages/schema/src/types/schema.ts:25](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/schema/src/types/schema.ts#L25) | -| `extensions?` | `string[]` | File extensions to filter (for file completions). | [packages/schema/src/types/schema.ts:19](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/schema/src/types/schema.ts#L19) | -| `placeholder?` | `string` | Placeholder text shown in the editor. | [packages/schema/src/types/schema.ts:21](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/schema/src/types/schema.ts#L21) | -| `source?` | `string` | Source for dynamic completion values. | [packages/schema/src/types/schema.ts:27](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/schema/src/types/schema.ts#L27) | -| `type?` | `string` | Type of completion (e.g., "file", "value"). | [packages/schema/src/types/schema.ts:17](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/schema/src/types/schema.ts#L17) | -| `values?` | `string[]` | Static list of allowed values. | [packages/schema/src/types/schema.ts:23](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/schema/src/types/schema.ts#L23) | +| `dynamic?` | `boolean` | Whether completion values are dynamically resolved. | [packages/schema/src/types/schema.ts:25](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/types/schema.ts#L25) | +| `extensions?` | `string[]` | File extensions to filter (for file completions). | [packages/schema/src/types/schema.ts:19](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/types/schema.ts#L19) | +| `placeholder?` | `string` | Placeholder text shown in the editor. | [packages/schema/src/types/schema.ts:21](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/types/schema.ts#L21) | +| `source?` | `string` | Source for dynamic completion values. | [packages/schema/src/types/schema.ts:27](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/types/schema.ts#L27) | +| `type?` | `string` | Type of completion (e.g., "file", "value"). | [packages/schema/src/types/schema.ts:17](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/types/schema.ts#L17) | +| `values?` | `string[]` | Static list of allowed values. | [packages/schema/src/types/schema.ts:23](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/types/schema.ts#L23) | ## DeprecatedSpec {#symbol-interface-deprecatedspec} -Defined in: [packages/schema/src/types/schema.ts:34](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/schema/src/types/schema.ts#L34) +Defined in: [packages/schema/src/types/schema.ts:34](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/types/schema.ts#L34) Structured deprecation specification for a field. Provides version, message, and optional auto-forwarding to a replacement key. @@ -207,13 +279,13 @@ Provides version, message, and optional auto-forwarding to a replacement key. | Property | Type | Description | Defined in | | ------------------------------------------------ | -------- | -------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `message?` | `string` | Human-readable deprecation message. | [packages/schema/src/types/schema.ts:38](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/schema/src/types/schema.ts#L38) | -| `replaceWith?` | `string` | Replacement key name to auto-forward the value to. | [packages/schema/src/types/schema.ts:40](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/schema/src/types/schema.ts#L40) | -| `since?` | `string` | Version since which the field is deprecated. | [packages/schema/src/types/schema.ts:36](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/schema/src/types/schema.ts#L36) | +| `message?` | `string` | Human-readable deprecation message. | [packages/schema/src/types/schema.ts:38](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/types/schema.ts#L38) | +| `replaceWith?` | `string` | Replacement key name to auto-forward the value to. | [packages/schema/src/types/schema.ts:40](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/types/schema.ts#L40) | +| `since?` | `string` | Version since which the field is deprecated. | [packages/schema/src/types/schema.ts:36](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/types/schema.ts#L36) | ## ExtensionSchema {#symbol-interface-extensionschema} -Defined in: [packages/schema/src/types/schema.ts:118](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/schema/src/types/schema.ts#L118) +Defined in: [packages/schema/src/types/schema.ts:136](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/types/schema.ts#L136) Complete extension schema parsed from a \_schema.yml or \_schema.json file. All sections are optional and default to empty objects or arrays. @@ -222,51 +294,60 @@ All sections are optional and default to empty objects or arrays. | Property | Type | Description | Defined in | | ---------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `$schema?` | `string` | Schema version URI (e.g., "https://m.canouil.dev/quarto-wizard/assets/schema/v1/extension-schema.json"). | [packages/schema/src/types/schema.ts:120](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/schema/src/types/schema.ts#L120) | -| `attributes?` | `Record<string, RecordFieldDescriptor>>`{=html} | Element-level attributes grouped by CSS class or element type (e.g., "\_any", "panel", "card"). | [packages/schema/src/types/schema.ts:130](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/schema/src/types/schema.ts#L130) | -| `classes?` | `Record<string, ClassDefinition>`{=html} | CSS classes contributed by the extension. | [packages/schema/src/types/schema.ts:132](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/schema/src/types/schema.ts#L132) | -| `formats?` | `Record<string, RecordFieldDescriptor>>`{=html} | Format-specific options the extension supports. | [packages/schema/src/types/schema.ts:126](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/schema/src/types/schema.ts#L126) | -| `options?` | `Record<string, FieldDescriptor>`{=html} | Options (top-level YAML keys) the extension accepts. | [packages/schema/src/types/schema.ts:122](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/schema/src/types/schema.ts#L122) | -| `projects?` | `string[]` | Project types contributed by the extension (suggested for project.type). | [packages/schema/src/types/schema.ts:128](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/schema/src/types/schema.ts#L128) | -| `shortcodes?` | `Record<string, ShortcodeSchema>`{=html} | Shortcodes the extension provides. | [packages/schema/src/types/schema.ts:124](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/schema/src/types/schema.ts#L124) | +| `$schema?` | `string` | Schema version URI (e.g., "https://m.canouil.dev/quarto-wizard/assets/schema/v1/extension-schema.json"). | [packages/schema/src/types/schema.ts:138](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/types/schema.ts#L138) | +| `attributes?` | `Record<string, RecordFieldDescriptor>>`{=html} | Element-level attributes grouped by CSS class or element type (e.g., "\_any", "panel", "card"). | [packages/schema/src/types/schema.ts:148](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/types/schema.ts#L148) | +| `classes?` | `Record<string, ClassDefinition>`{=html} | CSS classes contributed by the extension. | [packages/schema/src/types/schema.ts:150](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/types/schema.ts#L150) | +| `formats?` | `Record<string, RecordFieldDescriptor>>`{=html} | Format-specific options the extension supports. | [packages/schema/src/types/schema.ts:144](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/types/schema.ts#L144) | +| `options?` | `Record<string, FieldDescriptor>`{=html} | Options (top-level YAML keys) the extension accepts. | [packages/schema/src/types/schema.ts:140](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/types/schema.ts#L140) | +| `projects?` | `string[]` | Project types contributed by the extension (suggested for project.type). | [packages/schema/src/types/schema.ts:146](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/types/schema.ts#L146) | +| `shortcodes?` | `Record<string, ShortcodeSchema>`{=html} | Shortcodes the extension provides. | [packages/schema/src/types/schema.ts:142](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/types/schema.ts#L142) | ## FieldDescriptor {#symbol-interface-fielddescriptor} -Defined in: [packages/schema/src/types/schema.ts:47](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/schema/src/types/schema.ts#L47) +Defined in: [packages/schema/src/types/schema.ts:47](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/types/schema.ts#L47) Descriptor for a single field in an extension schema. Describes the type, constraints, and metadata for a configuration option. ### Properties -| Property | Type | Description | Defined in | -| ---------------------------------------------------------------- | -------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `aliases?` | `string[]` | Alternative names for the field. | [packages/schema/src/types/schema.ts:83](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/schema/src/types/schema.ts#L83) | -| `completion?` | [`CompletionSpec`](types.qmd#symbol-interface-completionspec) | Completion specification for the field. | [packages/schema/src/types/schema.ts:87](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/schema/src/types/schema.ts#L87) | -| `const?` | `unknown` | Fixed value the field must equal. | [packages/schema/src/types/schema.ts:81](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/schema/src/types/schema.ts#L81) | -| `default?` | `unknown` | Default value for the field. | [packages/schema/src/types/schema.ts:53](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/schema/src/types/schema.ts#L53) | -| `deprecated?` | `string` \| `boolean` \| [`DeprecatedSpec`](types.qmd#symbol-interface-deprecatedspec) | Whether the field is deprecated. Accepts boolean, message string, or structured spec. | [packages/schema/src/types/schema.ts:85](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/schema/src/types/schema.ts#L85) | -| `description?` | `string` | Human-readable description of the field. | [packages/schema/src/types/schema.ts:55](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/schema/src/types/schema.ts#L55) | -| `enum?` | `unknown[]` | Allowed values for the field. | [packages/schema/src/types/schema.ts:57](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/schema/src/types/schema.ts#L57) | -| `enumCaseInsensitive?` | `boolean` | Whether enum matching is case-insensitive. | [packages/schema/src/types/schema.ts:59](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/schema/src/types/schema.ts#L59) | -| `exclusiveMaximum?` | `number` | Exclusive maximum numeric value (value must be strictly less). | [packages/schema/src/types/schema.ts:71](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/schema/src/types/schema.ts#L71) | -| `exclusiveMinimum?` | `number` | Exclusive minimum numeric value (value must be strictly greater). | [packages/schema/src/types/schema.ts:69](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/schema/src/types/schema.ts#L69) | -| `items?` | `FieldDescriptor` | Schema for array items when type is "array". | [packages/schema/src/types/schema.ts:89](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/schema/src/types/schema.ts#L89) | -| `max?` | `number` | Maximum numeric value. | [packages/schema/src/types/schema.ts:67](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/schema/src/types/schema.ts#L67) | -| `maxItems?` | `number` | Maximum number of items (for arrays). | [packages/schema/src/types/schema.ts:79](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/schema/src/types/schema.ts#L79) | -| `maxLength?` | `number` | Maximum string length. | [packages/schema/src/types/schema.ts:75](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/schema/src/types/schema.ts#L75) | -| `min?` | `number` | Minimum numeric value. | [packages/schema/src/types/schema.ts:65](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/schema/src/types/schema.ts#L65) | -| `minItems?` | `number` | Minimum number of items (for arrays). | [packages/schema/src/types/schema.ts:77](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/schema/src/types/schema.ts#L77) | -| `minLength?` | `number` | Minimum string length. | [packages/schema/src/types/schema.ts:73](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/schema/src/types/schema.ts#L73) | -| `pattern?` | `string` | Regular expression pattern the value must match. | [packages/schema/src/types/schema.ts:61](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/schema/src/types/schema.ts#L61) | -| `patternExact?` | `boolean` | Whether the pattern must match the entire value. | [packages/schema/src/types/schema.ts:63](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/schema/src/types/schema.ts#L63) | -| `properties?` | `Record` | Schema for object properties when type is "object". | [packages/schema/src/types/schema.ts:91](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/schema/src/types/schema.ts#L91) | -| `required?` | `boolean` | Whether the field is required. | [packages/schema/src/types/schema.ts:51](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/schema/src/types/schema.ts#L51) | -| `type?` | `string` \| `string[]` | Data type of the field. A single type name or an array of type names for union types. | [packages/schema/src/types/schema.ts:49](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/schema/src/types/schema.ts#L49) | +| Property | Type | Description | Defined in | +| ------------------------------------------------------------------ | -------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `additionalProperties?` | `boolean` \| `FieldDescriptor` | Whether/how additional object keys are allowed (for type: object). | [packages/schema/src/types/schema.ts:101](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/types/schema.ts#L101) | +| `aliases?` | `string[]` | Alternative names for the field. | [packages/schema/src/types/schema.ts:91](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/types/schema.ts#L91) | +| `completion?` | [`CompletionSpec`](types.qmd#symbol-interface-completionspec) | Completion specification for the field. | [packages/schema/src/types/schema.ts:95](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/types/schema.ts#L95) | +| `const?` | `unknown` | Fixed value the field must equal. | [packages/schema/src/types/schema.ts:89](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/types/schema.ts#L89) | +| `contentEncoding?` | `string` | Content encoding for the string value (e.g., base64). | [packages/schema/src/types/schema.ts:107](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/types/schema.ts#L107) | +| `contentMediaType?` | `string` | Media type of the string content (e.g., application/json). | [packages/schema/src/types/schema.ts:109](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/types/schema.ts#L109) | +| `default?` | `unknown` | Default value for the field. | [packages/schema/src/types/schema.ts:53](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/types/schema.ts#L53) | +| `dependentRequired?` | `Record` | Map of key -> required-when-present keys (for type: object). | [packages/schema/src/types/schema.ts:105](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/types/schema.ts#L105) | +| `deprecated?` | `string` \| `boolean` \| [`DeprecatedSpec`](types.qmd#symbol-interface-deprecatedspec) | Whether the field is deprecated. Accepts boolean, message string, or structured spec. | [packages/schema/src/types/schema.ts:93](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/types/schema.ts#L93) | +| `description?` | `string` | Human-readable description of the field. | [packages/schema/src/types/schema.ts:55](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/types/schema.ts#L55) | +| `enum?` | `unknown[]` | Allowed values for the field. | [packages/schema/src/types/schema.ts:65](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/types/schema.ts#L65) | +| `enumCaseInsensitive?` | `boolean` | Whether enum matching is case-insensitive. | [packages/schema/src/types/schema.ts:67](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/types/schema.ts#L67) | +| `examples?` | `unknown[]` | Example values for documentation and tooling. | [packages/schema/src/types/schema.ts:59](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/types/schema.ts#L59) | +| `exclusiveMaximum?` | `number` | Exclusive maximum numeric value (value must be strictly less). | [packages/schema/src/types/schema.ts:79](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/types/schema.ts#L79) | +| `exclusiveMinimum?` | `number` | Exclusive minimum numeric value (value must be strictly greater). | [packages/schema/src/types/schema.ts:77](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/types/schema.ts#L77) | +| `format?` | `string` | JSON Schema format hint (e.g., uri, email, date-time). Annotation only. | [packages/schema/src/types/schema.ts:61](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/types/schema.ts#L61) | +| `items?` | `FieldDescriptor` | Schema for array items when type is "array". | [packages/schema/src/types/schema.ts:97](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/types/schema.ts#L97) | +| `max?` | `number` | Maximum numeric value. | [packages/schema/src/types/schema.ts:75](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/types/schema.ts#L75) | +| `maxItems?` | `number` | Maximum number of items (for arrays). | [packages/schema/src/types/schema.ts:87](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/types/schema.ts#L87) | +| `maxLength?` | `number` | Maximum string length. | [packages/schema/src/types/schema.ts:83](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/types/schema.ts#L83) | +| `min?` | `number` | Minimum numeric value. | [packages/schema/src/types/schema.ts:73](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/types/schema.ts#L73) | +| `minItems?` | `number` | Minimum number of items (for arrays). | [packages/schema/src/types/schema.ts:85](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/types/schema.ts#L85) | +| `minLength?` | `number` | Minimum string length. | [packages/schema/src/types/schema.ts:81](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/types/schema.ts#L81) | +| `multipleOf?` | `number` | Value must be a multiple of this number. | [packages/schema/src/types/schema.ts:63](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/types/schema.ts#L63) | +| `pattern?` | `string` | Regular expression pattern the value must match. | [packages/schema/src/types/schema.ts:69](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/types/schema.ts#L69) | +| `patternExact?` | `boolean` | Whether the pattern must match the entire value. | [packages/schema/src/types/schema.ts:71](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/types/schema.ts#L71) | +| `properties?` | `Record` | Schema for object properties when type is "object". | [packages/schema/src/types/schema.ts:99](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/types/schema.ts#L99) | +| `propertyNames?` | `string` | Regular expression that all object keys must match (for type: object). | [packages/schema/src/types/schema.ts:103](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/types/schema.ts#L103) | +| `required?` | `boolean` | Whether the field is required. | [packages/schema/src/types/schema.ts:51](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/types/schema.ts#L51) | +| `title?` | `string` | Short human-readable label. | [packages/schema/src/types/schema.ts:57](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/types/schema.ts#L57) | +| `type?` | `string` \| `string[]` | Data type of the field. A single type name or an array of type names for union types. | [packages/schema/src/types/schema.ts:49](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/types/schema.ts#L49) | ## RawSchema {#symbol-interface-rawschema} -Defined in: [packages/schema/src/types/schema.ts:138](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/schema/src/types/schema.ts#L138) +Defined in: [packages/schema/src/types/schema.ts:156](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/types/schema.ts#L156) Raw schema data as parsed from YAML or JSON. @@ -274,17 +355,17 @@ Raw schema data as parsed from YAML or JSON. | Property | Type | Defined in | | ---------------------------------------------- | ------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `$schema?` | `string` | [packages/schema/src/types/schema.ts:139](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/schema/src/types/schema.ts#L139) | -| `attributes?` | `Record` | [packages/schema/src/types/schema.ts:144](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/schema/src/types/schema.ts#L144) | -| `classes?` | `Record` | [packages/schema/src/types/schema.ts:145](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/schema/src/types/schema.ts#L145) | -| `formats?` | `Record` | [packages/schema/src/types/schema.ts:142](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/schema/src/types/schema.ts#L142) | -| `options?` | `Record` | [packages/schema/src/types/schema.ts:140](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/schema/src/types/schema.ts#L140) | -| `projects?` | `unknown[]` | [packages/schema/src/types/schema.ts:143](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/schema/src/types/schema.ts#L143) | -| `shortcodes?` | `Record` | [packages/schema/src/types/schema.ts:141](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/schema/src/types/schema.ts#L141) | +| `$schema?` | `string` | [packages/schema/src/types/schema.ts:157](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/types/schema.ts#L157) | +| `attributes?` | `Record` | [packages/schema/src/types/schema.ts:162](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/types/schema.ts#L162) | +| `classes?` | `Record` | [packages/schema/src/types/schema.ts:163](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/types/schema.ts#L163) | +| `formats?` | `Record` | [packages/schema/src/types/schema.ts:160](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/types/schema.ts#L160) | +| `options?` | `Record` | [packages/schema/src/types/schema.ts:158](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/types/schema.ts#L158) | +| `projects?` | `unknown[]` | [packages/schema/src/types/schema.ts:161](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/types/schema.ts#L161) | +| `shortcodes?` | `Record` | [packages/schema/src/types/schema.ts:159](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/types/schema.ts#L159) | ## ShortcodeSchema {#symbol-interface-shortcodeschema} -Defined in: [packages/schema/src/types/schema.ts:97](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/schema/src/types/schema.ts#L97) +Defined in: [packages/schema/src/types/schema.ts:115](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/types/schema.ts#L115) Schema for a shortcode, including its arguments and attributes. @@ -292,19 +373,64 @@ Schema for a shortcode, including its arguments and attributes. | Property | Type | Description | Defined in | | ------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `arguments?` | [`FieldDescriptor`](types.qmd#symbol-interface-fielddescriptor) & `object[]` | Positional arguments accepted by the shortcode. | [packages/schema/src/types/schema.ts:101](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/schema/src/types/schema.ts#L101) | -| `attributes?` | `Record<string, FieldDescriptor>`{=html} | Named attributes accepted by the shortcode. | [packages/schema/src/types/schema.ts:103](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/schema/src/types/schema.ts#L103) | -| `description?` | `string` | Human-readable description of the shortcode. | [packages/schema/src/types/schema.ts:99](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/schema/src/types/schema.ts#L99) | +| `arguments?` | [`FieldDescriptor`](types.qmd#symbol-interface-fielddescriptor) & `object[]` | Positional arguments accepted by the shortcode. | [packages/schema/src/types/schema.ts:119](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/types/schema.ts#L119) | +| `attributes?` | `Record<string, FieldDescriptor>`{=html} | Named attributes accepted by the shortcode. | [packages/schema/src/types/schema.ts:121](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/types/schema.ts#L121) | +| `description?` | `string` | Human-readable description of the shortcode. | [packages/schema/src/types/schema.ts:117](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/types/schema.ts#L117) | + +## SchemaVersion {#symbol-typealias-schemaversion} + +```{.ts filename="TypeScript"} +type SchemaVersion = "v1" | "v2"; +``` + +Defined in: [packages/schema/src/types/schema.ts:189](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/types/schema.ts#L189) + +Identifier for which schema version an instance file declares. +`"v1"` corresponds to [SCHEMA_V1_VERSION_URI](types.qmd#symbol-variable-schema-v1-version-uri), +`"v2"` to [SCHEMA_V2_VERSION_URI](types.qmd#symbol-variable-schema-v2-version-uri). + +## FIELD_ALIAS_PAIRS {#symbol-variable-field-alias-pairs} + +```{.ts filename="TypeScript"} +const FIELD_ALIAS_PAIRS: ReadonlyArray; +``` + +Defined in: [packages/schema/src/types/schema.ts:247](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/types/schema.ts#L247) + +Pairs of canonical / alias keys for field descriptors. Derived once from +KEY_ALIASES, minus `replace-with` (deprecation-spec scope only). +Iterated when checking for camelCase/kebab-case collisions on one descriptor. + +## SCHEMA_V1_VERSION_URI {#symbol-variable-schema-v1-version-uri} + +```{.ts filename="TypeScript"} +const SCHEMA_V1_VERSION_URI: "https://m.canouil.dev/quarto-wizard/assets/schema/v1/extension-schema.json" = "https://m.canouil.dev/quarto-wizard/assets/schema/v1/extension-schema.json"; +``` + +Defined in: [packages/schema/src/types/schema.ts:172](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/types/schema.ts#L172) + +Canonical schema version URIs. + +v1: original format, kebab-case canonical, dual-keyed. +v2: JSON Schema canonical names (camelCase, minimum/maximum, ...). + +## SCHEMA_V2_VERSION_URI {#symbol-variable-schema-v2-version-uri} + +```{.ts filename="TypeScript"} +const SCHEMA_V2_VERSION_URI: "https://m.canouil.dev/quarto-wizard/assets/schema/v2/extension-schema.json" = "https://m.canouil.dev/quarto-wizard/assets/schema/v2/extension-schema.json"; +``` + +Defined in: [packages/schema/src/types/schema.ts:173](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/types/schema.ts#L173) ## SCHEMA_VERSION_URI {#symbol-variable-schema-version-uri} ```{.ts filename="TypeScript"} -const SCHEMA_VERSION_URI: "https://m.canouil.dev/quarto-wizard/assets/schema/v1/extension-schema.json" = "https://m.canouil.dev/quarto-wizard/assets/schema/v1/extension-schema.json"; +const SCHEMA_VERSION_URI: "https://m.canouil.dev/quarto-wizard/assets/schema/v1/extension-schema.json" = SCHEMA_V1_VERSION_URI; ``` -Defined in: [packages/schema/src/types/schema.ts:151](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/schema/src/types/schema.ts#L151) +Defined in: [packages/schema/src/types/schema.ts:176](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/types/schema.ts#L176) -Canonical schema version URI for the current format. +Convenience alias for the default schema version URI ([SCHEMA_V1_VERSION_URI](types.qmd#symbol-variable-schema-v1-version-uri)). ## SUPPORTED_SCHEMA_VERSIONS {#symbol-variable-supported-schema-versions} @@ -312,7 +438,7 @@ Canonical schema version URI for the current format. const SUPPORTED_SCHEMA_VERSIONS: Set; ``` -Defined in: [packages/schema/src/types/schema.ts:157](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/schema/src/types/schema.ts#L157) +Defined in: [packages/schema/src/types/schema.ts:182](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/types/schema.ts#L182) Set of recognised schema version URIs. Unknown versions produce a warning but are not rejected (forward-compatible). diff --git a/docs/api/schema/validation.qmd b/docs/api/schema/validation.qmd index ee14cf39..7249cfcd 100644 --- a/docs/api/schema/validation.qmd +++ b/docs/api/schema/validation.qmd @@ -34,21 +34,67 @@ All derivation runs once at module load time. ### Variables - [ALLOWED_FIELD_PROPERTIES](validation.qmd#symbol-variable-allowed-field-properties) +- [ALLOWED_FIELD_PROPERTIES_V2](validation.qmd#symbol-variable-allowed-field-properties-v2) - [ALLOWED_SHORTCODE_KEYS](validation.qmd#symbol-variable-allowed-shortcode-keys) +- [ALLOWED_SHORTCODE_KEYS_V2](validation.qmd#symbol-variable-allowed-shortcode-keys-v2) - [ALLOWED_TOP_LEVEL_KEYS](validation.qmd#symbol-variable-allowed-top-level-keys) +- [ALLOWED_TOP_LEVEL_KEYS_V2](validation.qmd#symbol-variable-allowed-top-level-keys-v2) - [ALLOWED_TYPES](validation.qmd#symbol-variable-allowed-types) - [fieldDescriptorMetadata](validation.qmd#symbol-variable-fielddescriptormetadata) - [rootKeyMetadata](validation.qmd#symbol-variable-rootkeymetadata) - [SCHEMA_META_SCHEMA](validation.qmd#symbol-variable-schema-meta-schema) +- [SCHEMA_META_SCHEMA_V2](validation.qmd#symbol-variable-schema-meta-schema-v2) - [shortcodeEntryMetadata](validation.qmd#symbol-variable-shortcodeentrymetadata) +### Functions + +- [allowedSetsFor](validation.qmd#symbol-function-allowedsetsfor) + +## allowedSetsFor {#symbol-function-allowedsetsfor} + +```{.ts filename="TypeScript"} +function allowedSetsFor(version): object; +``` + +Defined in: [packages/schema/src/validation/schema-derived.ts:74](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/validation/schema-derived.ts#L74) + +Look up the allowed-property sets for a given schema version. + +### Parameters + +| Parameter | Type | +| --------- | ---------------- | +| `version` | `"v1"` \| `"v2"` | + +### Returns + +`object` + +#### fieldDescriptor {#symbol-function-allowedsetsfor-fielddescriptor} + +```{.ts filename="TypeScript"} +fieldDescriptor: ReadonlySet; +``` + +#### shortcodeEntry {#symbol-function-allowedsetsfor-shortcodeentry} + +```{.ts filename="TypeScript"} +shortcodeEntry: ReadonlySet; +``` + +#### topLevel {#symbol-function-allowedsetsfor-toplevel} + +```{.ts filename="TypeScript"} +topLevel: ReadonlySet; +``` + ## validateSchemaDefinition {#symbol-function-validateschemadefinition} ```{.ts filename="TypeScript"} function validateSchemaDefinition(content, format): SchemaDefinitionFinding[]; ``` -Defined in: [packages/schema/src/validation/schema-definition.ts:57](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/schema/src/validation/schema-definition.ts#L57) +Defined in: [packages/schema/src/validation/schema-definition.ts:61](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/validation/schema-definition.ts#L61) Validate a schema definition file and return all findings. @@ -71,7 +117,7 @@ Array of validation findings. function validateSchemaDefinitionStructure(parsed): SchemaDefinitionFinding[]; ``` -Defined in: [packages/schema/src/validation/schema-definition.ts:113](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/schema/src/validation/schema-definition.ts#L113) +Defined in: [packages/schema/src/validation/schema-definition.ts:117](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/validation/schema-definition.ts#L117) Validate the structure and semantics of a parsed schema definition. @@ -100,7 +146,7 @@ function validateSchemaDefinitionSyntax(content, format): }; ``` -Defined in: [packages/schema/src/validation/schema-definition.ts:72](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/schema/src/validation/schema-definition.ts#L72) +Defined in: [packages/schema/src/validation/schema-definition.ts:76](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/validation/schema-definition.ts#L76) Validate syntax of a schema definition file. @@ -125,7 +171,7 @@ Either an error array or the parsed object. ## SchemaDefinitionFinding {#symbol-interface-schemadefinitionfinding} -Defined in: [packages/schema/src/validation/schema-definition.ts:27](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/schema/src/validation/schema-definition.ts#L27) +Defined in: [packages/schema/src/validation/schema-definition.ts:31](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/validation/schema-definition.ts#L31) A single validation finding from schema definition analysis. @@ -133,12 +179,12 @@ A single validation finding from schema definition analysis. | Property | Type | Description | Defined in | | ----------------------------------------- | -------------------------------------------------------------------------------------- | ------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `code` | `string` | Machine-readable code identifying the check. | [packages/schema/src/validation/schema-definition.ts:33](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/schema/src/validation/schema-definition.ts#L33) | -| `column?` | `number` | Zero-based column number (when available from syntax errors). | [packages/schema/src/validation/schema-definition.ts:37](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/schema/src/validation/schema-definition.ts#L37) | -| `keyPath?` | `string` | Dot-separated key path to the problematic location. | [packages/schema/src/validation/schema-definition.ts:39](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/schema/src/validation/schema-definition.ts#L39) | -| `line?` | `number` | Zero-based line number (when available from syntax errors). | [packages/schema/src/validation/schema-definition.ts:35](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/schema/src/validation/schema-definition.ts#L35) | -| `message` | `string` | Human-readable description of the issue. | [packages/schema/src/validation/schema-definition.ts:29](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/schema/src/validation/schema-definition.ts#L29) | -| `severity` | [`SchemaDefinitionSeverity`](validation.qmd#symbol-typealias-schemadefinitionseverity) | Severity level. | [packages/schema/src/validation/schema-definition.ts:31](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/schema/src/validation/schema-definition.ts#L31) | +| `code` | `string` | Machine-readable code identifying the check. | [packages/schema/src/validation/schema-definition.ts:37](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/validation/schema-definition.ts#L37) | +| `column?` | `number` | Zero-based column number (when available from syntax errors). | [packages/schema/src/validation/schema-definition.ts:41](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/validation/schema-definition.ts#L41) | +| `keyPath?` | `string` | Dot-separated key path to the problematic location. | [packages/schema/src/validation/schema-definition.ts:43](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/validation/schema-definition.ts#L43) | +| `line?` | `number` | Zero-based line number (when available from syntax errors). | [packages/schema/src/validation/schema-definition.ts:39](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/validation/schema-definition.ts#L39) | +| `message` | `string` | Human-readable description of the issue. | [packages/schema/src/validation/schema-definition.ts:33](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/validation/schema-definition.ts#L33) | +| `severity` | [`SchemaDefinitionSeverity`](validation.qmd#symbol-typealias-schemadefinitionseverity) | Severity level. | [packages/schema/src/validation/schema-definition.ts:35](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/validation/schema-definition.ts#L35) | ## SchemaDefinitionSeverity {#symbol-typealias-schemadefinitionseverity} @@ -146,7 +192,7 @@ A single validation finding from schema definition analysis. type SchemaDefinitionSeverity = "error" | "warning" | "information"; ``` -Defined in: [packages/schema/src/validation/schema-definition.ts:22](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/schema/src/validation/schema-definition.ts#L22) +Defined in: [packages/schema/src/validation/schema-definition.ts:26](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/validation/schema-definition.ts#L26) Severity level for a schema definition finding. @@ -156,9 +202,19 @@ Severity level for a schema definition finding. const ALLOWED_FIELD_PROPERTIES: Set; ``` -Defined in: [packages/schema/src/validation/schema-derived.ts:50](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/schema/src/validation/schema-derived.ts#L50) +Defined in: [packages/schema/src/validation/schema-derived.ts:52](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/validation/schema-derived.ts#L52) + +Allowed properties on a v1 field descriptor (both camelCase and kebab-case). + +## ALLOWED_FIELD_PROPERTIES_V2 {#symbol-variable-allowed-field-properties-v2} + +```{.ts filename="TypeScript"} +const ALLOWED_FIELD_PROPERTIES_V2: Set; +``` -Allowed properties on a field descriptor (both camelCase and kebab-case). +Defined in: [packages/schema/src/validation/schema-derived.ts:68](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/validation/schema-derived.ts#L68) + +Allowed properties on a v2 field descriptor (camelCase only). ## ALLOWED_SHORTCODE_KEYS {#symbol-variable-allowed-shortcode-keys} @@ -166,9 +222,19 @@ Allowed properties on a field descriptor (both camelCase and kebab-case). const ALLOWED_SHORTCODE_KEYS: Set; ``` -Defined in: [packages/schema/src/validation/schema-derived.ts:56](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/schema/src/validation/schema-derived.ts#L56) +Defined in: [packages/schema/src/validation/schema-derived.ts:58](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/validation/schema-derived.ts#L58) + +Allowed top-level keys inside a v1 shortcode entry. + +## ALLOWED_SHORTCODE_KEYS_V2 {#symbol-variable-allowed-shortcode-keys-v2} + +```{.ts filename="TypeScript"} +const ALLOWED_SHORTCODE_KEYS_V2: Set; +``` -Allowed top-level keys inside a shortcode entry. +Defined in: [packages/schema/src/validation/schema-derived.ts:71](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/validation/schema-derived.ts#L71) + +Allowed top-level keys inside a v2 shortcode entry. ## ALLOWED_TOP_LEVEL_KEYS {#symbol-variable-allowed-top-level-keys} @@ -176,9 +242,19 @@ Allowed top-level keys inside a shortcode entry. const ALLOWED_TOP_LEVEL_KEYS: Set; ``` -Defined in: [packages/schema/src/validation/schema-derived.ts:47](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/schema/src/validation/schema-derived.ts#L47) +Defined in: [packages/schema/src/validation/schema-derived.ts:49](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/validation/schema-derived.ts#L49) + +Allowed top-level keys in a v1 schema definition file. + +## ALLOWED_TOP_LEVEL_KEYS_V2 {#symbol-variable-allowed-top-level-keys-v2} + +```{.ts filename="TypeScript"} +const ALLOWED_TOP_LEVEL_KEYS_V2: Set; +``` + +Defined in: [packages/schema/src/validation/schema-derived.ts:65](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/validation/schema-derived.ts#L65) -Allowed top-level keys in a schema definition file. +Allowed top-level keys in a v2 schema definition file. ## ALLOWED_TYPES {#symbol-variable-allowed-types} @@ -186,9 +262,9 @@ Allowed top-level keys in a schema definition file. const ALLOWED_TYPES: Set; ``` -Defined in: [packages/schema/src/validation/schema-derived.ts:53](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/schema/src/validation/schema-derived.ts#L53) +Defined in: [packages/schema/src/validation/schema-derived.ts:55](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/validation/schema-derived.ts#L55) -Allowed type values for a field descriptor. +Allowed type values for a field descriptor (same in v1 and v2). ## fieldDescriptorMetadata {#symbol-variable-fielddescriptormetadata} @@ -196,7 +272,7 @@ Allowed type values for a field descriptor. const fieldDescriptorMetadata: object; ``` -Defined in: [packages/schema/src/validation/schema-derived.ts:121](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/schema/src/validation/schema-derived.ts#L121) +Defined in: [packages/schema/src/validation/schema-derived.ts:156](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/validation/schema-derived.ts#L156) ### Type Declaration @@ -248,7 +324,7 @@ yamlHidden: Set; const rootKeyMetadata: object; ``` -Defined in: [packages/schema/src/validation/schema-derived.ts:173](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/schema/src/validation/schema-derived.ts#L173) +Defined in: [packages/schema/src/validation/schema-derived.ts:208](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/validation/schema-derived.ts#L208) ### Type Declaration @@ -270,7 +346,15 @@ yamlHidden: Set; const SCHEMA_META_SCHEMA: Record = metaSchema; ``` -Defined in: [packages/schema/src/validation/schema-derived.ts:40](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/schema/src/validation/schema-derived.ts#L40) +Defined in: [packages/schema/src/validation/schema-derived.ts:41](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/validation/schema-derived.ts#L41) + +## SCHEMA_META_SCHEMA_V2 {#symbol-variable-schema-meta-schema-v2} + +```{.ts filename="TypeScript"} +const SCHEMA_META_SCHEMA_V2: Record = metaSchemaV2; +``` + +Defined in: [packages/schema/src/validation/schema-derived.ts:42](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/validation/schema-derived.ts#L42) ## shortcodeEntryMetadata {#symbol-variable-shortcodeentrymetadata} @@ -278,7 +362,7 @@ Defined in: [packages/schema/src/validation/schema-derived.ts:40](https://github const shortcodeEntryMetadata: object; ``` -Defined in: [packages/schema/src/validation/schema-derived.ts:149](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/schema/src/validation/schema-derived.ts#L149) +Defined in: [packages/schema/src/validation/schema-derived.ts:184](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/schema/src/validation/schema-derived.ts#L184) ### Type Declaration diff --git a/docs/api/snippets/errors.qmd b/docs/api/snippets/errors.qmd index 1df7b20b..8f7431c9 100644 --- a/docs/api/snippets/errors.qmd +++ b/docs/api/snippets/errors.qmd @@ -16,7 +16,7 @@ Error types for @quarto-wizard/snippets. ## SnippetError {#symbol-class-snippeterror} -Defined in: [packages/snippets/src/errors.ts:11](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/snippets/src/errors.ts#L11) +Defined in: [packages/snippets/src/errors.ts:11](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/snippets/src/errors.ts#L11) Error when parsing a snippet file fails. @@ -32,7 +32,7 @@ Error when parsing a snippet file fails. new SnippetError(message, options?): SnippetError; ``` -Defined in: [packages/snippets/src/errors.ts:19](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/snippets/src/errors.ts#L19) +Defined in: [packages/snippets/src/errors.ts:19](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/snippets/src/errors.ts#L19) ##### Parameters @@ -75,7 +75,7 @@ Error.cause readonly code: "SNIPPET_ERROR" = "SNIPPET_ERROR"; ``` -Defined in: [packages/snippets/src/errors.ts:13](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/snippets/src/errors.ts#L13) +Defined in: [packages/snippets/src/errors.ts:13](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/snippets/src/errors.ts#L13) Error code for programmatic handling. @@ -113,7 +113,7 @@ Error.name readonly optional snippetPath?: string; ``` -Defined in: [packages/snippets/src/errors.ts:15](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/snippets/src/errors.ts#L15) +Defined in: [packages/snippets/src/errors.ts:15](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/snippets/src/errors.ts#L15) Path to the snippet file. @@ -137,7 +137,7 @@ Error.stack readonly optional suggestion?: string; ``` -Defined in: [packages/snippets/src/errors.ts:17](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/snippets/src/errors.ts#L17) +Defined in: [packages/snippets/src/errors.ts:17](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/snippets/src/errors.ts#L17) Suggestion for how to resolve the error. @@ -173,7 +173,7 @@ Error.stackTraceLimit format(): string; ``` -Defined in: [packages/snippets/src/errors.ts:33](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/snippets/src/errors.ts#L33) +Defined in: [packages/snippets/src/errors.ts:33](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/snippets/src/errors.ts#L33) Format the error for display. @@ -285,7 +285,7 @@ Error.prepareStackTrace function getErrorMessage(error): string; ``` -Defined in: [packages/snippets/src/errors.ts:45](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/snippets/src/errors.ts#L45) +Defined in: [packages/snippets/src/errors.ts:45](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/snippets/src/errors.ts#L45) Extract a human-readable message from an unknown error value. diff --git a/docs/api/snippets/filesystem.qmd b/docs/api/snippets/filesystem.qmd index 70eb1c62..53ad8f58 100644 --- a/docs/api/snippets/filesystem.qmd +++ b/docs/api/snippets/filesystem.qmd @@ -36,7 +36,7 @@ Provides functions to find, parse, and read Quarto extension snippet files. ## SnippetCache {#symbol-class-snippetcache} -Defined in: [packages/snippets/src/filesystem/snippet-cache.ts:19](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/snippets/src/filesystem/snippet-cache.ts#L19) +Defined in: [packages/snippets/src/filesystem/snippet-cache.ts:19](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/snippets/src/filesystem/snippet-cache.ts#L19) Cache for parsed extension snippets. Snippets are loaded lazily on first access. @@ -61,7 +61,7 @@ new SnippetCache(): SnippetCache; get(extensionDir): SnippetCollection | null; ``` -Defined in: [packages/snippets/src/filesystem/snippet-cache.ts:31](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/snippets/src/filesystem/snippet-cache.ts#L31) +Defined in: [packages/snippets/src/filesystem/snippet-cache.ts:31](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/snippets/src/filesystem/snippet-cache.ts#L31) Get the snippets for an extension directory. Loads and caches the snippets on first access. @@ -84,7 +84,7 @@ Parsed snippet collection or null if no snippet file exists. getError(extensionDir): string | null; ``` -Defined in: [packages/snippets/src/filesystem/snippet-cache.ts:65](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/snippets/src/filesystem/snippet-cache.ts#L65) +Defined in: [packages/snippets/src/filesystem/snippet-cache.ts:65](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/snippets/src/filesystem/snippet-cache.ts#L65) Get the parse error for snippets in the given directory, if any. @@ -106,7 +106,7 @@ Error message or null if no error occurred. has(extensionDir): boolean; ``` -Defined in: [packages/snippets/src/filesystem/snippet-cache.ts:75](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/snippets/src/filesystem/snippet-cache.ts#L75) +Defined in: [packages/snippets/src/filesystem/snippet-cache.ts:75](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/snippets/src/filesystem/snippet-cache.ts#L75) Check whether snippets are cached for the given directory. @@ -128,7 +128,7 @@ True if snippets are cached. invalidate(extensionDir): void; ``` -Defined in: [packages/snippets/src/filesystem/snippet-cache.ts:84](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/snippets/src/filesystem/snippet-cache.ts#L84) +Defined in: [packages/snippets/src/filesystem/snippet-cache.ts:84](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/snippets/src/filesystem/snippet-cache.ts#L84) Invalidate the cached snippets for a specific extension directory. @@ -148,7 +148,7 @@ Invalidate the cached snippets for a specific extension directory. invalidateAll(): void; ``` -Defined in: [packages/snippets/src/filesystem/snippet-cache.ts:93](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/snippets/src/filesystem/snippet-cache.ts#L93) +Defined in: [packages/snippets/src/filesystem/snippet-cache.ts:93](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/snippets/src/filesystem/snippet-cache.ts#L93) Invalidate all cached snippets. @@ -162,7 +162,7 @@ Invalidate all cached snippets. function findSnippetFile(directory): string | null; ``` -Defined in: [packages/snippets/src/filesystem/snippets.ts:34](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/snippets/src/filesystem/snippets.ts#L34) +Defined in: [packages/snippets/src/filesystem/snippets.ts:34](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/snippets/src/filesystem/snippets.ts#L34) Find the snippet file in a directory. @@ -184,7 +184,7 @@ Path to the snippet file or null if not found. function parseSnippetContent(content, sourcePath?): SnippetCollection; ``` -Defined in: [packages/snippets/src/filesystem/snippets.ts:78](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/snippets/src/filesystem/snippets.ts#L78) +Defined in: [packages/snippets/src/filesystem/snippets.ts:78](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/snippets/src/filesystem/snippets.ts#L78) Parse snippet content from a JSON string. Entries missing `prefix` or `body` are silently skipped. @@ -212,7 +212,7 @@ SnippetError if the JSON is invalid or the root is not an object. function parseSnippetFile(snippetPath): SnippetCollection; ``` -Defined in: [packages/snippets/src/filesystem/snippets.ts:110](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/snippets/src/filesystem/snippets.ts#L110) +Defined in: [packages/snippets/src/filesystem/snippets.ts:110](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/snippets/src/filesystem/snippets.ts#L110) Parse a snippet file from a path. @@ -238,7 +238,7 @@ SnippetError if reading or parsing fails. function readSnippets(directory): SnippetReadResult | null; ``` -Defined in: [packages/snippets/src/filesystem/snippets.ts:131](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/snippets/src/filesystem/snippets.ts#L131) +Defined in: [packages/snippets/src/filesystem/snippets.ts:131](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/snippets/src/filesystem/snippets.ts#L131) Read snippets from an extension directory. @@ -256,7 +256,7 @@ SnippetReadResult or null if no snippet file found. ## SnippetReadResult {#symbol-interface-snippetreadresult} -Defined in: [packages/snippets/src/filesystem/snippets.ts:21](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/snippets/src/filesystem/snippets.ts#L21) +Defined in: [packages/snippets/src/filesystem/snippets.ts:21](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/snippets/src/filesystem/snippets.ts#L21) Result of reading a snippet file. @@ -264,8 +264,8 @@ Result of reading a snippet file. | Property | Type | Description | Defined in | | ----------------------------------------------- | ------------------------------------------------------------------- | ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `snippetPath` | `string` | Full path to the snippet file. | [packages/snippets/src/filesystem/snippets.ts:25](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/snippets/src/filesystem/snippets.ts#L25) | -| `snippets` | [`SnippetCollection`](types.qmd#symbol-typealias-snippetcollection) | Parsed snippet collection. | [packages/snippets/src/filesystem/snippets.ts:23](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/snippets/src/filesystem/snippets.ts#L23) | +| `snippetPath` | `string` | Full path to the snippet file. | [packages/snippets/src/filesystem/snippets.ts:25](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/snippets/src/filesystem/snippets.ts#L25) | +| `snippets` | [`SnippetCollection`](types.qmd#symbol-typealias-snippetcollection) | Parsed snippet collection. | [packages/snippets/src/filesystem/snippets.ts:23](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/snippets/src/filesystem/snippets.ts#L23) | ## SNIPPET_FILENAME {#symbol-variable-snippet-filename} @@ -273,6 +273,6 @@ Result of reading a snippet file. const SNIPPET_FILENAME: "_snippets.json" = "_snippets.json"; ``` -Defined in: [packages/snippets/src/filesystem/snippets.ts:16](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/snippets/src/filesystem/snippets.ts#L16) +Defined in: [packages/snippets/src/filesystem/snippets.ts:16](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/snippets/src/filesystem/snippets.ts#L16) The snippet filename convention. diff --git a/docs/api/snippets/types.qmd b/docs/api/snippets/types.qmd index dfc05d8f..ab884aa7 100644 --- a/docs/api/snippets/types.qmd +++ b/docs/api/snippets/types.qmd @@ -26,7 +26,7 @@ Types for VS Code snippet JSON format and namespace utilities. function qualifySnippetPrefix(namespace, rawPrefix): string; ``` -Defined in: [packages/snippets/src/types.ts:56](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/snippets/src/types.ts#L56) +Defined in: [packages/snippets/src/types.ts:56](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/snippets/src/types.ts#L56) Qualify a snippet prefix with its extension namespace. Format: "namespace:rawPrefix". @@ -50,7 +50,7 @@ Qualified prefix string. function snippetNamespace(id): string; ``` -Defined in: [packages/snippets/src/types.ts:44](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/snippets/src/types.ts#L44) +Defined in: [packages/snippets/src/types.ts:44](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/snippets/src/types.ts#L44) Compute the namespace string for an extension. Format: "owner-name" when an owner exists, "name" otherwise. @@ -69,7 +69,7 @@ Namespace string. ## SnippetDefinition {#symbol-interface-snippetdefinition} -Defined in: [packages/snippets/src/types.ts:22](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/snippets/src/types.ts#L22) +Defined in: [packages/snippets/src/types.ts:22](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/snippets/src/types.ts#L22) A single snippet definition in VS Code snippet JSON format. @@ -77,13 +77,13 @@ A single snippet definition in VS Code snippet JSON format. | Property | Type | Description | Defined in | | ------------------------------------------------ | ---------------------- | -------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `body` | `string` \| `string[]` | Body lines of the snippet (joined with newlines on insertion). | [packages/snippets/src/types.ts:26](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/snippets/src/types.ts#L26) | -| `description?` | `string` | Human-readable description shown in IntelliSense. | [packages/snippets/src/types.ts:28](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/snippets/src/types.ts#L28) | -| `prefix` | `string` \| `string[]` | Trigger prefix(es) for the snippet. | [packages/snippets/src/types.ts:24](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/snippets/src/types.ts#L24) | +| `body` | `string` \| `string[]` | Body lines of the snippet (joined with newlines on insertion). | [packages/snippets/src/types.ts:26](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/snippets/src/types.ts#L26) | +| `description?` | `string` | Human-readable description shown in IntelliSense. | [packages/snippets/src/types.ts:28](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/snippets/src/types.ts#L28) | +| `prefix` | `string` \| `string[]` | Trigger prefix(es) for the snippet. | [packages/snippets/src/types.ts:24](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/snippets/src/types.ts#L24) | ## SnippetExtensionId {#symbol-interface-snippetextensionid} -Defined in: [packages/snippets/src/types.ts:12](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/snippets/src/types.ts#L12) +Defined in: [packages/snippets/src/types.ts:12](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/snippets/src/types.ts#L12) Extension identifier for snippet namespacing. Structurally compatible with @quarto-wizard/core's ExtensionId. @@ -92,8 +92,8 @@ Structurally compatible with @quarto-wizard/core's ExtensionId. | Property | Type | Description | Defined in | | ----------------------------------- | ------------------ | ---------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `name` | `string` | The name of the extension. | [packages/snippets/src/types.ts:16](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/snippets/src/types.ts#L16) | -| `owner` | `string` \| `null` | The owner (user or organisation) of the extension, or null if unowned. | [packages/snippets/src/types.ts:14](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/snippets/src/types.ts#L14) | +| `name` | `string` | The name of the extension. | [packages/snippets/src/types.ts:16](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/snippets/src/types.ts#L16) | +| `owner` | `string` \| `null` | The owner (user or organisation) of the extension, or null if unowned. | [packages/snippets/src/types.ts:14](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/snippets/src/types.ts#L14) | ## SnippetCollection {#symbol-typealias-snippetcollection} @@ -101,7 +101,7 @@ Structurally compatible with @quarto-wizard/core's ExtensionId. type SnippetCollection = Record; ``` -Defined in: [packages/snippets/src/types.ts:35](https://github.com/mcanouil/quarto-wizard/blob/adbbb034e9e58e856b2078f3b8c2ba6b29ee7325/packages/snippets/src/types.ts#L35) +Defined in: [packages/snippets/src/types.ts:35](https://github.com/mcanouil/quarto-wizard/blob/1fa78d62fe1f323bf3cae19d2b69c4be84966eeb/packages/snippets/src/types.ts#L35) A collection of named snippet definitions. Keys are human-readable snippet names; values are the definitions. diff --git a/docs/changelog.qmd b/docs/changelog.qmd index 69984548..d28d5b3c 100644 --- a/docs/changelog.qmd +++ b/docs/changelog.qmd @@ -4,6 +4,23 @@ title: "Changelog" ## 3 {#version-3} +### 3.1 {#version-3-1} + +#### 3.1.0 (2026-05-17) {#version-3-1-0} + +##### New Features + +- feat: support a v2 extension schema vocabulary at `https://m.canouil.dev/quarto-wizard/assets/schema/v2/extension-schema.json`. v2 uses JSON Schema canonical names exclusively (`minimum`, `maximum`, `multipleOf`, `additionalProperties`, `propertyNames`, `dependentRequired`, `contentEncoding`, `contentMediaType`, `replaceWith`, ...), drops `pattern-exact` in favour of `^...$` anchors in the pattern itself, and lets shortcode entries declare a parent-level `required: [name1, ...]` array. v1 schemas keep working under the v1 URI; the runtime dispatches on the instance `$schema` URI. +- feat: extend the v1 schema vocabulary with new optional field properties: `title`, `examples`, `format`, `null` type, `multiple-of`, `additional-properties`, `property-names`, `dependent-required`, `content-encoding`, `content-media-type`. `completion.type: directory` is now recognised alongside `file` / `color` / ... . +- feat: `$schema:` completion in `_schema.yml` offers both the v1 and v2 URIs (v2 preferred). +- feat: extend schema completion, diagnostics, and hover to YAML files included via `metadata-files:`. Secondary configuration files declared in `_quarto.yml`, `_metadata.yml`, or `.qmd` front-matter now receive the same IntelliSense as canonical Quarto config files. + +##### Bug Fixes + +- fix: discover extension schemas across nested Quarto projects. YAML completion, hover, diagnostics, shortcode completion, element attribute completion, and snippet completion now resolve schemas through each document's nearest enclosing project root instead of only the workspace folder, so extensions installed in sub-projects (for example `repo/subProj/_extensions/...`) populate IntelliSense for documents inside that sub-project. +- fix: report an `unknown-schema-version` warning when a `_schema.yml` declares a `$schema` URI that is not one of the supported versions, and an `invalid-schema-uri-type` error when `$schema` is set to a non-string value, instead of silently validating against v1. +- fix: flag stray `name:` on a field descriptor outside a shortcode argument (previously silently accepted); flag unknown keys on `classes.*` entries; report the camelCase keyPath in `invalid-property-names` when the author used `propertyNames` rather than `property-names`; warn when a single descriptor sets both the camelCase and kebab-case form of the same keyword (v1 only); reject `type: content` outside shortcode arguments; require shortcode positional arguments to declare a `name`. + ### 3.0 {#version-3-0} #### 3.0.1 (2026-05-12) {#version-3-0-1} diff --git a/package-lock.json b/package-lock.json index f9488b50..2bb6ef66 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "quarto-wizard", - "version": "3.0.1", + "version": "3.1.0", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "quarto-wizard", - "version": "3.0.1", + "version": "3.1.0", "license": "MIT", "workspaces": [ "packages/*" @@ -876,9 +876,6 @@ "arm64" ], "dev": true, - "libc": [ - "glibc" - ], "license": "MIT", "optional": true, "os": [ @@ -896,9 +893,6 @@ "arm64" ], "dev": true, - "libc": [ - "musl" - ], "license": "MIT", "optional": true, "os": [ @@ -916,9 +910,6 @@ "ppc64" ], "dev": true, - "libc": [ - "glibc" - ], "license": "MIT", "optional": true, "os": [ @@ -936,9 +927,6 @@ "s390x" ], "dev": true, - "libc": [ - "glibc" - ], "license": "MIT", "optional": true, "os": [ @@ -956,9 +944,6 @@ "x64" ], "dev": true, - "libc": [ - "glibc" - ], "license": "MIT", "optional": true, "os": [ @@ -976,9 +961,6 @@ "x64" ], "dev": true, - "libc": [ - "musl" - ], "license": "MIT", "optional": true, "os": [ @@ -6356,9 +6338,6 @@ "arm64" ], "dev": true, - "libc": [ - "glibc" - ], "license": "MPL-2.0", "optional": true, "os": [ @@ -6380,9 +6359,6 @@ "arm64" ], "dev": true, - "libc": [ - "musl" - ], "license": "MPL-2.0", "optional": true, "os": [ @@ -6404,9 +6380,6 @@ "x64" ], "dev": true, - "libc": [ - "glibc" - ], "license": "MPL-2.0", "optional": true, "os": [ @@ -6428,9 +6401,6 @@ "x64" ], "dev": true, - "libc": [ - "musl" - ], "license": "MPL-2.0", "optional": true, "os": [ diff --git a/package.json b/package.json index d3ed0a71..e3da23a5 100644 --- a/package.json +++ b/package.json @@ -2,7 +2,7 @@ "name": "quarto-wizard", "displayName": "Quarto Wizard", "description": "A Visual Studio Code extension that helps you manage Quarto projects.", - "version": "3.0.1", + "version": "3.1.0", "private": true, "workspaces": [ "packages/*" diff --git a/packages/core/package.json b/packages/core/package.json index 7ce40b33..981ec2d4 100644 --- a/packages/core/package.json +++ b/packages/core/package.json @@ -1,7 +1,7 @@ { "name": "@quarto-wizard/core", "displayName": "Quarto Wizard Core", - "version": "3.0.1", + "version": "3.1.0", "description": "Core library for Quarto extension management", "main": "dist/index.js", "types": "dist/index.d.ts", diff --git a/packages/schema/package.json b/packages/schema/package.json index d858aedd..3ec8c2fc 100644 --- a/packages/schema/package.json +++ b/packages/schema/package.json @@ -1,7 +1,7 @@ { "name": "@quarto-wizard/schema", "displayName": "Quarto Wizard Schema", - "version": "3.0.1", + "version": "3.1.0", "description": "Schema types, parsing, validation, and caching for Quarto extension schemas", "main": "dist/index.js", "types": "dist/index.d.ts", diff --git a/packages/snippets/package.json b/packages/snippets/package.json index 13195e74..8ee9b92f 100644 --- a/packages/snippets/package.json +++ b/packages/snippets/package.json @@ -1,7 +1,7 @@ { "name": "@quarto-wizard/snippets", "displayName": "Quarto Wizard Snippets", - "version": "3.0.1", + "version": "3.1.0", "description": "Snippet types, parsing, and caching for Quarto extension snippets", "main": "dist/index.js", "types": "dist/index.d.ts",