@emeryld/rrroutes-contract 2.1.9 → 2.1.11

package/dist/core/routesV3.core.d.ts

@@ -29,6 +29,40 @@ export type MethodCfg = {
     feed?: boolean;
     /** Optional human-readable description for docs/debugging. */
     description?: string;
+    /**
+     * Short one-line summary for docs list views.
+     * Shown in navigation / tables instead of the full description.
+     */
+    summary?: string;
+    /**
+     * Group name used for navigation sections in docs UIs.
+     * e.g. "Users", "Billing", "Auth".
+     */
+    docsGroup?: string;
+    /**
+     * Tags that can be used to filter / facet in interactive docs.
+     * e.g. ["users", "admin", "internal"].
+     */
+    tags?: string[];
+    /**
+     * Mark the route as deprecated in docs.
+     * Renderers can badge this and/or hide by default.
+     */
+    deprecated?: boolean;
+    /**
+     * Optional stability information for the route.
+     * Renderers can surface this prominently.
+     */
+    stability?: 'experimental' | 'beta' | 'stable' | 'deprecated';
+    /**
+     * Hide this route from public docs while keeping it usable in code.
+     */
+    docsHidden?: boolean;
+    /**
+     * Arbitrary extra metadata for docs renderers.
+     * Can be used for auth requirements, rate limits, feature flags, etc.
+     */
+    docsMeta?: Record<string, unknown>;
 };
 /** Immutable representation of a single HTTP route in the tree. */
 export type Leaf<M extends HttpMethod, P extends string, C extends MethodCfg> = {

package/dist/docs/docs.d.ts

@@ -1,2 +1,2 @@
 import { AnyLeaf } from "../core/routesV3.core";
-export declare function renderLeafDocsMarkdown(leaves: AnyLeaf[]): string;
+export declare function renderLeafDocsHTML(leaves: AnyLeaf[]): string;

package/dist/docs/serializer.d.ts

@@ -0,0 +1,14 @@
+import { AnyLeaf, MethodCfg } from "../core/routesV3.core";
+type SerializableMethodCfg = Pick<MethodCfg, 'description' | 'summary' | 'docsGroup' | 'tags' | 'deprecated' | 'stability' | 'feed' | 'docsMeta'> & {
+    hasBody: boolean;
+    hasQuery: boolean;
+    hasParams: boolean;
+    hasOutput: boolean;
+};
+export type SerializableLeaf = {
+    method: string;
+    path: string;
+    cfg: SerializableMethodCfg;
+};
+export declare function serializeLeaf(leaf: AnyLeaf): SerializableLeaf;
+export {};