@microsoft/rayfin-docs 1.27.0 → 1.33.0-beta.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/discovery.d.ts +3 -3
- package/dist/discovery.js +1 -1
- package/dist/index.d.ts +3 -2
- package/dist/site-cjs/discovery.js +1 -1
- package/package.json +1 -1
package/dist/discovery.d.ts
CHANGED
|
@@ -2,7 +2,7 @@ import type { DocKind, RayfinDocsManifest } from './types.js';
|
|
|
2
2
|
export type { DocKind } from './types.js';
|
|
3
3
|
/**
|
|
4
4
|
* A package discovered to declare `rayfinDocs`. Returned by
|
|
5
|
-
*
|
|
5
|
+
* `discoverRayfinDocsPackages` for `DocsService` to load.
|
|
6
6
|
*/
|
|
7
7
|
export interface DiscoveredPackage {
|
|
8
8
|
packageName: string;
|
|
@@ -19,7 +19,7 @@ export type TrustPredicate = (packageName: string) => boolean;
|
|
|
19
19
|
/** Default trust predicate. Auto-trusts the Microsoft Rayfin namespace. */
|
|
20
20
|
export declare const defaultTrust: TrustPredicate;
|
|
21
21
|
/**
|
|
22
|
-
* Inputs to
|
|
22
|
+
* Inputs to `discoverRayfinDocsPackages`. Callers must choose exactly one
|
|
23
23
|
* discovery source: `candidates` to probe a fixed catalog list,
|
|
24
24
|
* `packageRoots` for explicit workspace package folders, or
|
|
25
25
|
* `scanInstalledPackages: true` to walk all packages under ancestor
|
|
@@ -79,7 +79,7 @@ export interface DiscoveryResult {
|
|
|
79
79
|
}>;
|
|
80
80
|
}
|
|
81
81
|
export declare function discoverRayfinDocsPackages(options: DiscoveryOptions): DiscoveryResult;
|
|
82
|
-
type ManifestValidation = {
|
|
82
|
+
export type ManifestValidation = {
|
|
83
83
|
ok: true;
|
|
84
84
|
manifest: RayfinDocsManifest;
|
|
85
85
|
} | {
|
package/dist/discovery.js
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
*
|
|
4
4
|
* Walks a project's `node_modules` to find packages declaring the
|
|
5
5
|
* `rayfinDocs` field in their `package.json`. Returns a list of
|
|
6
|
-
* discovered package roots so
|
|
6
|
+
* discovered package roots so `DocsService` can load each tree's
|
|
7
7
|
* markdown alongside any explicit `assetsRoot`.
|
|
8
8
|
*
|
|
9
9
|
* **Trust model.** Discovery is conservative by default: only
|
package/dist/index.d.ts
CHANGED
|
@@ -34,7 +34,8 @@ export declare const DOCS_NO_CACHE_OPTION_DESCRIPTION = "Bypass any existing on-
|
|
|
34
34
|
export declare const DOCS_DEFAULT_MODULES: readonly DocModule[];
|
|
35
35
|
export declare function getKnownRayfinDocsPackages(): readonly string[];
|
|
36
36
|
export type { DocEntry, DocListItem, DocModule, DocSearchResult, DocSearchScope, DocSection, DocSectionRef, DocSource, DocKind, RayfinDocsManifest, } from './types.js';
|
|
37
|
-
export { type DiscoveredPackage, type DiscoveryResult, type DiscoveryOptions, type TrustPredicate, defaultTrust, discoverRayfinDocsPackages, validateRayfinDocsManifest, docKindToModule, } from './discovery.js';
|
|
37
|
+
export { type DiscoveredPackage, type DiscoveryResult, type DiscoveryOptions, type ManifestValidation, type TrustPredicate, defaultTrust, discoverRayfinDocsPackages, validateRayfinDocsManifest, docKindToModule, } from './discovery.js';
|
|
38
|
+
export type { DocsIndex, PrebuiltDocsIndex } from './search.js';
|
|
38
39
|
export { type Catalog, type CatalogPackage, type CatalogPackageKind, type DiscoverItem, type DiscoverScore, getCatalog, discoverPackages, mapDiscoverResult, deriveInstallCommand, deriveUpdateCommand, _resetCatalogForTesting, } from './catalog.js';
|
|
39
40
|
export declare class DocsService {
|
|
40
41
|
private entries;
|
|
@@ -55,7 +56,7 @@ export declare class DocsService {
|
|
|
55
56
|
* and load each declaring package's docs. If `candidates` is omitted,
|
|
56
57
|
* DocsService probes only Rayfin's known docs package list instead of
|
|
57
58
|
* walking the entire `node_modules` tree. The `from` argument is passed
|
|
58
|
-
* to
|
|
59
|
+
* to `discoverRayfinDocsPackages` and used as the `createRequire`
|
|
59
60
|
* base.
|
|
60
61
|
*/
|
|
61
62
|
discover?: DiscoveryOptions;
|
|
@@ -10,7 +10,7 @@ exports.docKindToModule = docKindToModule;
|
|
|
10
10
|
*
|
|
11
11
|
* Walks a project's `node_modules` to find packages declaring the
|
|
12
12
|
* `rayfinDocs` field in their `package.json`. Returns a list of
|
|
13
|
-
* discovered package roots so
|
|
13
|
+
* discovered package roots so `DocsService` can load each tree's
|
|
14
14
|
* markdown alongside any explicit `assetsRoot`.
|
|
15
15
|
*
|
|
16
16
|
* **Trust model.** Discovery is conservative by default: only
|
package/package.json
CHANGED