@microsoft/rayfin-docs 1.35.0-alpha.1374 → 1.35.0-alpha.1412

package/assets/catalog.json

@@ -62,9 +62,10 @@
     {
       "name": "@microsoft/rayfin-storage",
       "kind": "sdk",
-      "summary": "Type-safe blob storage client for Rayfin storage backends.",
+      "stability": "experimental",
+      "summary": "Experimental — type-safe blob storage client for Rayfin storage backends. Requires the `@blob()` decorator from `@microsoft/rayfin-core/experimental`.",
       "topics": ["storage", "blob", "azure-blob", "file", "upload"],
-      "modules": []
+      "modules": ["rayfin-storage"]
     },
     {
       "name": "@microsoft/rayfin-auth-provider-fabric",
@@ -73,6 +74,20 @@
       "topics": ["fabric", "auth-provider", "token", "msal"],
       "modules": ["rayfin-auth-provider-fabric"]
     },
+    {
+      "name": "@microsoft/rayfin-app-state-fabric",
+      "kind": "sdk",
+      "summary": "Deep-link application state for Rayfin apps embedded in the Microsoft Fabric portal. Reads launch state and writes shareable, bookmarkable portal URLs.",
+      "topics": [
+        "fabric",
+        "deep-link",
+        "url-state",
+        "history",
+        "embedded",
+        "share"
+      ],
+      "modules": ["rayfin-app-state-fabric"]
+    },
     {
       "name": "@microsoft/rayfin-connector-fabric-semanticmodel",
       "kind": "sdk",
@@ -131,7 +146,7 @@
     {
       "name": "@microsoft/rayfin-host-docs",
       "kind": "host",
-      "summary": "Host service reference docs for Rayfin .NET hosting components (WebService, Auth, Storage, DataApi, Function). Discovered via the rayfinDocs field.",
+      "summary": "Host service reference docs for Rayfin .NET hosting components (WebService, Auth, DataApi, Function). Discovered via the rayfinDocs field.",
       "topics": [
         "host",
         "dotnet",

package/dist/catalog-types.d.ts

@@ -18,12 +18,32 @@
  * updates ship as `rayfin-docs` version bumps (no hosted endpoint).
  */
 export type CatalogPackageKind = 'sdk' | 'tool' | 'guide' | 'host' | 'sample' | 'external';
+/**
+ * Release stability of a catalog package.
+ *
+ * - `stable` — on the supported public surface; safe to recommend.
+ * - `experimental` — ships, but its API may change or be removed without
+ *   a major-version bump. Present in the catalog so its docs are still
+ *   discovered and searchable once installed, but never recommended by
+ *   `discoverPackages(query)`.
+ */
+export type CatalogPackageStability = 'stable' | 'experimental';
 /** A single entry in the catalog. */
 export interface CatalogPackage {
     /** Full npm name (e.g. `@microsoft/rayfin-core`). */
     name: string;
     /** Kind, used to group results in CLI/MCP surfaces. */
     kind: CatalogPackageKind;
+    /**
+     * Release stability. Defaults to `stable` when omitted.
+     *
+     * Experimental packages stay in the catalog so
+     * `getKnownRayfinDocsPackages()` still probes them for the `rayfinDocs`
+     * field — their docs remain listable and searchable once installed —
+     * but {@link discoverPackages} filters them out so install
+     * recommendations never point at an unsupported surface.
+     */
+    stability?: CatalogPackageStability;
     /** One-line summary surfaced in discover results. */
     summary: string;
     /** Searchable topics - used by the relevance scorer in

package/dist/catalog.d.ts

@@ -16,7 +16,7 @@
  * `assets/` directory. Updates are rolled out as `rayfin-docs` version
  * bumps - there is no hosted-endpoint refresh path.
  */
-export type { Catalog, CatalogPackage, CatalogPackageKind, } from './catalog-types.js';
+export type { Catalog, CatalogPackage, CatalogPackageKind, CatalogPackageStability, } from './catalog-types.js';
 import type { Catalog, CatalogPackage, CatalogPackageKind } from './catalog-types.js';
 export declare function getCatalog(): Catalog;
 /**
@@ -44,7 +44,10 @@ export interface DiscoverScore {
  * alphabetical package name. Packages with score 0 are excluded.
  * SDK catalog-only entries with no docs modules are also excluded so
  * discover results never recommend installing an SDK package that cannot
- * contribute searchable docs yet.
+ * contribute searchable docs yet. Packages marked
+ * `stability: 'experimental'` are excluded for the same reason — they
+ * stay in the catalog so their docs are still discovered once installed,
+ * but they are never surfaced as an install recommendation.
  *
  * Stop-words and tokens shorter than 3 chars are ignored to keep the
  * signal-to-noise ratio high - the rare "auth" 4-char query still

package/dist/catalog.js

@@ -76,7 +76,10 @@ function freezeCatalog(data) {
  * alphabetical package name. Packages with score 0 are excluded.
  * SDK catalog-only entries with no docs modules are also excluded so
  * discover results never recommend installing an SDK package that cannot
- * contribute searchable docs yet.
+ * contribute searchable docs yet. Packages marked
+ * `stability: 'experimental'` are excluded for the same reason — they
+ * stay in the catalog so their docs are still discovered once installed,
+ * but they are never surfaced as an install recommendation.
  *
  * Stop-words and tokens shorter than 3 chars are ignored to keep the
  * signal-to-noise ratio high - the rare "auth" 4-char query still
@@ -93,6 +96,9 @@ export function discoverPackages(query, catalog = getCatalog()) {
         if (pkg.kind === 'sdk' && pkg.modules.length === 0) {
             continue;
         }
+        if (pkg.stability === 'experimental') {
+            continue;
+        }
         let score = 0;
         const matchedOn = [];
         // Name substring match - strongest signal

package/dist/index.d.ts

@@ -36,7 +36,7 @@ export declare function getKnownRayfinDocsPackages(): readonly string[];
 export type { DocEntry, DocListItem, DocModule, DocSearchResult, DocSearchScope, DocSection, DocSectionRef, DocSource, DocKind, RayfinDocsManifest, } from './types.js';
 export { type DiscoveredPackage, type DiscoveryResult, type DiscoveryOptions, type ManifestValidation, type TrustPredicate, defaultTrust, discoverRayfinDocsPackages, validateRayfinDocsManifest, docKindToModule, } from './discovery.js';
 export type { DocsIndex, PrebuiltDocsIndex } from './search.js';
-export { type Catalog, type CatalogPackage, type CatalogPackageKind, type DiscoverItem, type DiscoverScore, getCatalog, discoverPackages, mapDiscoverResult, deriveInstallCommand, deriveUpdateCommand, _resetCatalogForTesting, } from './catalog.js';
+export { type Catalog, type CatalogPackage, type CatalogPackageKind, type CatalogPackageStability, type DiscoverItem, type DiscoverScore, getCatalog, discoverPackages, mapDiscoverResult, deriveInstallCommand, deriveUpdateCommand, _resetCatalogForTesting, } from './catalog.js';
 export declare class DocsService {
     private entries;
     private entriesById;

package/dist/index.js

@@ -40,6 +40,11 @@ export const DOCS_DEFAULT_MODULES = ['guide', 'ts-sdk'];
  * by `discoverRayfinDocsPackages`; catalog candidates not present in
  * `node_modules` appear in `DiscoveryResult.notInstalled`.
  *
+ * Experimental packages are deliberately still probed. `stability` only
+ * gates install recommendations in `discoverPackages(query)` — once a
+ * Builder has actually installed an experimental package, its docs
+ * should be listable and searchable like any other.
+ *
  * **`--module ts-sdk` compatibility:** when a discovered package
  * declares `kind: 'api-reference'`, its docs are tagged with the
  * legacy `module: 'ts-sdk'` so existing CLI/MCP filters keep working

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@microsoft/rayfin-docs",
-  "version": "1.35.0-alpha.1374",
+  "version": "1.35.0-alpha.1412",
   "description": "Rayfin docs indexing and search library — used by the MCP server, CLI, and other doc-facing surfaces",
   "type": "module",
   "main": "dist/index.js",