@emeryld/rrroutes-openapi 2.3.1 → 2.3.3

package/README.md

@@ -3,6 +3,7 @@
 RRRoutes docs + “try it” playground, shipped as static assets plus a thin Express helper. The UI is React-based and reads the serialized registry you provide (no OpenAPI YAML needed).
 
 ## What you get
+
 - React docs UI (filters, grouping, schema tables) with a built-in playground for hitting your endpoints.
 - Express helper that mounts the docs page and serves the built assets.
 - Playground inputs share a base URL and let you set custom request headers across calls.
@@ -11,23 +12,24 @@ RRRoutes docs + “try it” playground, shipped as static assets plus a thin Ex
 ## Quick start (Express)
 
 ```ts
-import express from 'express';
-import { finalize } from '@emeryld/rrroutes-contract';
-import { mountRRRoutesDocs } from '@emeryld/rrroutes-openapi';
-import { leaves } from './contract';
+import express from 'express'
+import { finalize } from '@emeryld/rrroutes-contract'
+import { mountRRRoutesDocs } from '@emeryld/rrroutes-openapi'
+import { leaves } from './contract'
 
-const registry = finalize(leaves);
-const router = express.Router();
+const registry = finalize(leaves)
+const router = express.Router()
 
 // Mounts page at /__rrroutes/docs and serves JS/CSS from /__rrroutes/docs/assets
 mountRRRoutesDocs({
   router,
   leaves: registry.all,
   options: { path: '/__rrroutes/docs' },
-});
+})
 ```
 
 ### Options (server)
+
 - `path` (default `/__rrroutes/docs`): where the page is mounted.
 - `assetBasePath` (default `${path}/assets`): where the static JS/CSS are served from.
 - `csp` (default `true`): emit a CSP header + nonce.
@@ -40,18 +42,26 @@ mountRRRoutesDocs({
 If you want to control rendering:
 
 ```ts
-import { createLeafDocsDocument, renderLeafDocsHTML } from '@emeryld/rrroutes-openapi';
+import {
+  createLeafDocsDocument,
+  renderLeafDocsHTML,
+} from '@emeryld/rrroutes-openapi'
 
 // React element – mount into your own tree
-const element = createLeafDocsDocument(registry.all, { assetBasePath: '/__rrroutes/docs/assets' });
+const element = createLeafDocsDocument(registry.all, {
+  assetBasePath: '/__rrroutes/docs/assets',
+})
 
 // Or prerender to a string
-const html = renderLeafDocsHTML(registry.all, { assetBasePath: '/__rrroutes/docs/assets' });
+const html = renderLeafDocsHTML(registry.all, {
+  assetBasePath: '/__rrroutes/docs/assets',
+})
 ```
 
 ## Data shape
 
 The docs UI expects serialized leaves from `@emeryld/rrroutes-contract`. Each leaf includes:
+
 - `method`, `path`, and `cfg` (summary, description, tags, docsGroup, stability, deprecated, docsMeta, feed)
 - Optional Zod schemas for params/query/body/output; these are introspected into a serializable AST for schema tables.
 
@@ -64,5 +74,6 @@ pnpm run build  # Builds node bundle + types + web assets to dist/public
 ```
 
 Published package contents:
+
 - `dist/index.{mjs,cjs,d.ts}`: server helper + exports
 - `dist/public/assets/docs.{js,css}`: the docs UI bundle served by `mountRRRoutesDocs`

package/dist/docs/LeafDocsPage.d.ts

@@ -1,8 +1,4 @@
-import type { AnyLeaf } from '@emeryld/rrroutes-contract';
 import type { ReactElement } from 'react';
-import type { SerializablePreset } from './presets.js';
-import type { WebhookPaths } from '../webhooks.js';
-import type { LogFeedEntry } from '../webhooks.js';
 export interface RenderOptions {
     /** CSP nonce applied to data + script tags. */
     cspNonce?: string;
@@ -10,31 +6,15 @@ export interface RenderOptions {
     assetBasePath?: string;
     /** Root path where the docs are mounted (e.g. `/__rrroutes/docs`). Used for client routing. */
     docsBasePath?: string;
-    /** Optional suffix appended to the window origin when building default playground base URLs. */
-    baseUrlSuffix?: string;
-    /** Preset collections rendered into the docs UI. */
-    presets?: SerializablePreset[];
-    /** Optional seed history entries to pre-populate the UI (useful in dev). */
-    historySeeds?: SerializableHistoryEntry[];
-    /** Optional seed log entries to pre-populate the logs UI. */
-    logSeeds?: LogFeedEntry[];
-    /** Paths for webhook-backed history/log feeds. */
-    webhooks?: WebhookPaths;
 }
 type DocsDocumentProps = {
-    leavesJson: string;
-    presetsJson: string;
     assetBase: string;
     docsBase: string;
-    historyJson: string;
-    logsJson: string;
-    baseUrlSuffix?: string;
-    webhooks?: WebhookPaths;
     cspNonce?: string;
 };
-export declare const DocsDocument: ({ leavesJson, presetsJson, assetBase, docsBase, historyJson, logsJson, baseUrlSuffix, webhooks, cspNonce, }: DocsDocumentProps) => import("react/jsx-runtime").JSX.Element;
-export declare function createLeafDocsDocument(leaves: AnyLeaf[], options?: RenderOptions): ReactElement;
-export declare function renderLeafDocsHTML(leaves: AnyLeaf[], options?: RenderOptions): string;
+export declare const DocsDocument: ({ assetBase, docsBase, cspNonce, }: DocsDocumentProps) => import("react/jsx-runtime").JSX.Element;
+export declare function createLeafDocsDocument(options?: RenderOptions): ReactElement;
+export declare function renderLeafDocsHTML(options?: RenderOptions): string;
 export type SerializableHistoryEntry = {
     id?: string;
     timestamp: number;

package/dist/docs/docs.d.ts

@@ -1,7 +1,4 @@
-import type { AnyLeaf } from "@emeryld/rrroutes-contract";
-import { RenderOptions } from "./LeafDocsPage.js";
-export declare function renderLeafDocsHTML(leaves: AnyLeaf[], options?: RenderOptions): string;
-export type { RenderOptions, SerializableHistoryEntry } from "./LeafDocsPage.js";
-export { createLeafDocsDocument } from "./LeafDocsPage.js";
-export type { SerializablePreset, SerializablePresetOperation } from "./presets.js";
-export type { LogFeedEntry } from "../webhooks.js";
+import { RenderOptions } from './LeafDocsPage.js';
+export declare function renderLeafDocsHTML(options?: RenderOptions): string;
+export { createLeafDocsDocument } from './LeafDocsPage.js';
+export type { RenderOptions } from './LeafDocsPage.js';

package/dist/docs/schemaIntrospection.d.ts

@@ -1,15 +1,6 @@
-import * as z from "zod";
-export type SerializableSchemaNode = {
-    kind: string;
-    optional?: boolean;
-    nullable?: boolean;
-    description?: string;
-    properties?: Record<string, SerializableSchemaNode>;
-    element?: SerializableSchemaNode;
-    union?: SerializableSchemaNode[];
-    literal?: unknown;
-    enumValues?: string[];
-};
+import * as z from 'zod';
+import type { SerializableSchema } from '../web/v2/types/types.endpoint.js';
+export type SerializableSchemaNode = SerializableSchema;
 type ZodAny = z.ZodTypeAny;
-export declare function introspectSchema(schema: ZodAny | undefined): SerializableSchemaNode | undefined;
+export declare function introspectSchema(schema: ZodAny | undefined): SerializableSchema | undefined;
 export {};

package/dist/docs/serializer.d.ts

@@ -1,19 +1,5 @@
-import type { AnyLeaf, MethodCfg } from "@emeryld/rrroutes-contract";
-import { SerializableSchemaNode } from "./schemaIntrospection.js";
-type SerializableMethodCfg = Pick<MethodCfg, "description" | "summary" | "docsGroup" | "tags" | "deprecated" | "stability" | "feed" | "docsMeta"> & {
-    hasBody: boolean;
-    hasQuery: boolean;
-    hasParams: boolean;
-    hasOutput: boolean;
-    bodySchema?: SerializableSchemaNode;
-    querySchema?: SerializableSchemaNode;
-    paramsSchema?: SerializableSchemaNode;
-    outputSchema?: SerializableSchemaNode;
-};
-export type SerializableLeaf = {
-    method: string;
-    path: string;
-    cfg: SerializableMethodCfg;
-};
-export type { SerializableSchemaNode } from "./schemaIntrospection.js";
-export declare function serializeLeaf(leaf: AnyLeaf): SerializableLeaf;
+import { type AnyLeafLowProfile } from '@emeryld/rrroutes-contract';
+import type { Endpoint } from '../web/v2/types/types.endpoint.js';
+export type SerializedLeaf = Endpoint;
+export type { SerializableSchemaNode } from './schemaIntrospection.js';
+export declare function serializeLeaf(leaf: AnyLeafLowProfile): Endpoint;