@open-resource-discovery/metadata-renderer 0.0.0 → 1.0.1

package/dist/mcp/index.d.ts

@@ -0,0 +1,8 @@
+import { RendererTheme } from '../types';
+export type McpRendererProps = {
+    content: string;
+    showValidation?: boolean;
+    className?: string;
+    theme?: RendererTheme;
+};
+export declare function McpRenderer({ content, showValidation, className, theme }: McpRendererProps): import("react").JSX.Element;

package/dist/mcp.js

@@ -0,0 +1,2 @@
+import { t as McpRenderer } from "./chunks/mcp-qA5sYRAN.js";
+export { McpRenderer };

package/dist/openApi/customAttributes/attributeLink.d.ts

@@ -0,0 +1,3 @@
+export default function attributeLink({ attributeName }: {
+    attributeName: string;
+}): import("react").JSX.Element | null;

package/dist/openApi/customAttributes/autoDiscover.d.ts

@@ -0,0 +1,15 @@
+type Rec = Record<string, unknown>;
+export declare function discoverAttributeNames(doc: Rec, prefix: string): string[];
+/**
+ * Synthetic property key injected into schema.properties so Scalar calls SpecificationExtension on it.
+ * The value is the full schema object; our extension component reads any x-* fields from it.
+ */
+export declare const SCHEMA_ATTRS_KEY = "x-sap-schema-attrs";
+/**
+ * Clone doc and inject a synthetic property into every schema object that carries
+ * at least one key matching the given prefix. Scalar only calls SpecificationExtension
+ * on property-level schemas, so this is the only way to render schema-level x-* fields.
+ */
+export declare function injectSchemaExtensions(doc: Rec, prefixes: string[]): Rec;
+export declare function extractCustomAttributeValues(doc: Rec, prefix: string): [string, unknown][];
+export {};

package/dist/openApi/customAttributes/genericRenderer.d.ts

@@ -0,0 +1,3 @@
+import { JSX } from 'react';
+import { AttributeDefinition, OpenApiCustomAttributesConfig } from './types';
+export declare function buildGenericRenderer(fieldName: string, def: AttributeDefinition | undefined, config: OpenApiCustomAttributesConfig): (data: unknown) => JSX.Element | null;

package/dist/openApi/customAttributes/sapAttributes/operation/deprecatedOperation.d.ts

@@ -0,0 +1,10 @@
+import { JSX } from 'react';
+type Props = {
+    xSapDeprecatedOperation: {
+        deprecationDate: string;
+        successorOperationRef?: string;
+        successorOperationId?: string;
+    };
+};
+export default function deprecatedOperation({ xSapDeprecatedOperation }: Props): JSX.Element;
+export {};

package/dist/openApi/customAttributes/sapAttributes/root/extOverview.d.ts

@@ -0,0 +1,2 @@
+import { JSX } from 'react';
+export default function extOverview(props: unknown): JSX.Element | null;

package/dist/openApi/customAttributes/sapAttributes/root/extensible.d.ts

@@ -0,0 +1,10 @@
+import { JSX } from 'react';
+type Props = {
+    xSapExtensible: {
+        supported?: 'no' | 'manual' | 'automatic';
+        type?: 'no' | 'manual' | 'automatic';
+        description?: string;
+    };
+};
+export default function extensible({ xSapExtensible }: Props): JSX.Element;
+export {};

package/dist/openApi/customAttributes/sapAttributes/root/ordId.d.ts

@@ -0,0 +1,6 @@
+import { JSX } from 'react';
+type Props = {
+    xSapOrdId: string;
+};
+export default function ordId({ xSapOrdId }: Props): JSX.Element | null;
+export {};

package/dist/openApi/customAttributes/sapAttributes/root/stateInfo.d.ts

@@ -0,0 +1,11 @@
+import { JSX } from 'react';
+type Props = {
+    xSapStateInfo: {
+        state: string;
+        deprecationDate?: string;
+        decommissionedDate?: string;
+        successorApi?: string;
+    };
+};
+export default function StateInfo({ xSapStateInfo }: Props): JSX.Element | null;
+export {};

package/dist/openApi/customAttributes/sapAttributes/root/typeCheckXxtOverview.d.ts

@@ -0,0 +1,10 @@
+export type ExtOverviewProps = {
+    xSapExtOverview: {
+        name: string;
+        values: string | (string | {
+            text: string;
+            format: 'plain' | 'markdown';
+        })[];
+    }[];
+};
+export declare function typeCheckExSapExtOverviewExSapExtOverview(obj: unknown): obj is ExtOverviewProps;

package/dist/openApi/customAttributes/sapAttributes/root/typeCheckXxtOverview.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/openApi/customAttributes/sapAttributes/sapPreset.d.ts

@@ -0,0 +1,2 @@
+import { OpenApiCustomAttributesConfig } from '../types';
+export declare const sapOpenApiAttributesConfig: OpenApiCustomAttributesConfig;

package/dist/openApi/customAttributes/sapAttributes/schema/odmEntityName.d.ts

@@ -0,0 +1,6 @@
+import { JSX } from 'react';
+type Props = {
+    xSapOdmEntityName: string;
+};
+export default function odmEntityName({ xSapOdmEntityName }: Props): JSX.Element | null;
+export {};

package/dist/openApi/customAttributes/sapAttributes/schema/odmSemanticKey.d.ts

@@ -0,0 +1,10 @@
+import { JSX } from 'react';
+type SemanticKeyEntry = {
+    name: string;
+    values: string[];
+};
+type Props = {
+    xSapOdmSemanticKey: SemanticKeyEntry[];
+};
+export default function odmSemanticKey({ xSapOdmSemanticKey }: Props): JSX.Element | null;
+export {};

package/dist/openApi/customAttributes/types.d.ts

@@ -0,0 +1,31 @@
+import { JSX } from 'react';
+export type AttributeDefinition = {
+    type: 'string';
+    label?: string;
+    valueLinks?: Record<string, string>;
+} | {
+    type: 'boolean';
+    label?: string;
+} | {
+    type: 'number';
+    label?: string;
+} | {
+    type: 'array';
+    label?: string;
+} | {
+    type: 'object';
+    label?: string;
+} | {
+    type: 'link';
+    label?: string;
+    callback: (value: unknown) => string | undefined;
+} | {
+    component: (props: unknown) => JSX.Element | null;
+};
+export type OpenApiCustomAttributesConfig = {
+    prefixStartsWith?: string;
+    documentationUrl?: (attributeName: string, ctx: {
+        version: string;
+    }) => string;
+    extensions?: Record<string, AttributeDefinition>;
+};

package/dist/openApi/index.d.ts

@@ -0,0 +1,9 @@
+import { RendererTheme } from '../types';
+import { OpenApiCustomAttributesConfig } from './customAttributes/types';
+export type OpenApiRendererProps = {
+    content: string;
+    customAttributes?: OpenApiCustomAttributesConfig[];
+    className?: string;
+    theme?: RendererTheme;
+};
+export declare function OpenApiRenderer({ content, customAttributes, className, theme }: OpenApiRendererProps): import("react").JSX.Element;

package/dist/openApi/styles.d.ts

@@ -0,0 +1,2 @@
+declare const _default: "\n.sap-api-container {\n    display: flex;\n    flex-wrap: wrap;\n    container-type: inline-size;\n    border: var(--scalar-border-width) solid var(--scalar-border-color);\n    border-radius: var(--scalar-radius-lg);\n    margin-top: 8px;\n    font-size: var(--scalar-small);\n    line-height: var(--scalar-line-height-3);\n    overflow: hidden;\n}\n\n.sap-api-label {\n    color: var(--scalar-color-1);\n    width: 30%;\n    min-width: 20ch;\n    flex-shrink: 0;\n    background: var(--scalar-background-2);\n    padding: 6px 9px 6px 12px;\n    border-right: var(--scalar-border-width) solid var(--scalar-border-color);\n    display: flex;\n    align-items: flex-start;\n    justify-content: space-between;\n    font-weight: 500;\n}\n\n.sap-api-label--root {\n    min-width: 20ch;\n}\n\n.sap-api-value {\n    color: var(--scalar-color-2);\n    padding: 8px;\n    flex: 1 1 0;\n    min-width: 0;\n}\n\n.sap-api-value--root {\n    flex: 1 1 0;\n    min-width: 0;\n}\n\n.sap-api-list {\n    margin: 0 2ch;\n    list-style: disc;\n}\n\n.sap-api-link {\n    text-decoration: none;\n    color: var(--scalar-link-color);\n    transition: color 0.1s ease-in-out;\n    cursor: pointer;\n}\n\n.sap-api-ord-id {\n    display: flex;\n    align-items: flex-start;\n    gap: 8px;\n}\n\n.sap-api-ord-id-text {\n    flex: 1 1 auto;\n    min-width: 0;\n    word-break: break-all;\n}\n\n.sap-api-copy-btn {\n    flex-shrink: 0;\n    cursor: pointer;\n    display: inline-flex;\n    align-items: center;\n    justify-content: center;\n    font-size: 1em;\n    line-height: 1;\n    padding: 4px;\n    color: var(--scalar-color-2);\n    background: var(--scalar-background-2);\n    border: var(--scalar-border-width) solid var(--scalar-border-color);\n    border-radius: var(--scalar-radius);\n    transition: background 0.1s ease-in-out, color 0.1s ease-in-out;\n}\n\n.sap-api-copy-btn:hover {\n    background: var(--scalar-background-3);\n    color: var(--scalar-color-1);\n}\n\n.sap-api-placeholder {\n    color: #999;\n}\n\n.sap-api-obj {\n    margin: 0;\n    padding-left: 12px;\n}\n\n.sap-api-obj-row {\n    margin-bottom: 4px;\n}\n\n.sap-api-obj-key {\n    font-weight: 600;\n    display: inline;\n}\n\n.sap-api-obj-val {\n    display: inline;\n    margin: 0;\n}\n\n/* Width-adaptive rows: react to the row's own available width (container-type above).\n   When the row is narrow, label and value wrap onto separate lines (label above value). */\n@container (max-width: 420px) {\n    .sap-api-label,\n    .sap-api-label--root {\n        flex-basis: 100%;\n        width: 100%;\n        min-width: 0;\n        border-right: none;\n        border-bottom: var(--scalar-border-width) solid var(--scalar-border-color);\n    }\n    .sap-api-value,\n    .sap-api-value--root {\n        flex-basis: 100%;\n        width: 100%;\n    }\n}\n\na {\n    text-decoration: none;\n    color: var(--sapLinkColor);\n    transition: color 0.1s ease-in-out;\n    cursor: pointer;\n}\na:hover {\n    text-decoration: underline;\n}\n\n/* Keyboard key: use Scalar background instead of Infima colors */\n.scalar-app kbd {\n    background: var(--scalar-background-1);\n    color: var(--scalar-color-1);\n    border: 1px solid var(--scalar-border-color);\n}\n\n/* Syntax highlighting \u2014 override --scalar-color-* with ThemeEditor --ord-hljs-* tokens */\n.scalar-app .hljs-attr,\n.scalar-app .hljs-attribute { color: var(--ord-hljs-attr); }\n\n.scalar-app .hljs-string,\n.scalar-app .hljs-regexp,\n.scalar-app .hljs-subst,\n.scalar-app .hljs-doctag,\n.scalar-app .hljs-bullet,\n.scalar-app .hljs-link,\n.scalar-app .hljs-meta,\n.scalar-app .hljs-symbol { color: var(--ord-hljs-string); }\n\n.scalar-app .hljs-number,\n.scalar-app .hljs-selector-attr,\n.scalar-app .hljs-selector-pseudo,\n.scalar-app .hljs-built_in { color: var(--ord-hljs-number); }\n\n.scalar-app .hljs-title.function_ { color: var(--ord-hljs-function); }\n\n.scalar-app .hljs-addition,\n.scalar-app .hljs-literal,\n.scalar-app .hljs-selector-tag,\n.scalar-app .hljs-type { color: var(--ord-hljs-literal); }\n\n.scalar-app .hljs-keyword { color: var(--ord-hljs-keyword); }\n\n.scalar-app .hljs-comment,\n.scalar-app .hljs-quote { color: var(--ord-hljs-comment); }\n\n.scalar-app .hljs-punctuation { color: var(--ord-hljs-punctuation); }\n\n/* Hide the \"x-sap-schema-attrs\" property heading row \u2014 the row exists only to\n   carry schema-level extension components; the key name should not be visible. */\n.scalar-app .property:has(.sap-schema-attrs-block) {\n    padding-top: 2px;\n}\n.scalar-app .property:has(.sap-schema-attrs-block) .property-heading {\n    display: none;\n}\n\n/* Override Scalar's sidebar height variable so the <aside> uses our measured container height\n   instead of Scalar's default 100dvh (which breaks when embedded in Docusaurus/non-fullscreen). */\n.scalar-app {\n    --refs-sidebar-height: calc(var(--scalar-container-height, 100dvh) - var(--refs-header-height, 0px));\n}\n";
+export default _default;

package/dist/openApi/utils/context.d.ts

@@ -0,0 +1,7 @@
+import { OpenApiCustomAttributesConfig } from '../customAttributes/types';
+export declare const openApiContext: {
+    version: string;
+    configs: OpenApiCustomAttributesConfig[];
+    getDocumentationUrl(attributeName: string): string | undefined;
+};
+export declare const getVersion: (content: string) => string;

package/dist/openApi/utils/context.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/openApi/utils/plugins.d.ts

@@ -0,0 +1,3 @@
+import { ApiReferencePlugin } from '@scalar/types/api-reference';
+import { OpenApiCustomAttributesConfig } from '../customAttributes/types';
+export declare function buildCustomAttributesPlugin(doc: Record<string, unknown> | undefined, configs: OpenApiCustomAttributesConfig[]): ApiReferencePlugin;

package/dist/openApi/utils/scalarTheme.d.ts

@@ -0,0 +1,11 @@
+interface ThemeAdapter {
+    selector: string;
+    map(canonical: Record<string, string>): Record<string, string>;
+}
+export declare const scalarAdapter: ThemeAdapter;
+export declare const scalarSidebarAdapter: ThemeAdapter;
+export declare const scalarModeAdapter: ThemeAdapter;
+export declare const scalarHljsAdapter: ThemeAdapter;
+export declare const scalarTeleportAdapter: ThemeAdapter;
+export declare function buildScalarThemeStyles(id: string, theme: Record<string, string>): string;
+export {};

package/dist/openapi.js

@@ -0,0 +1,2 @@
+import { t as OpenApiRenderer } from "./chunks/openApi-BTb5yzun.js";
+export { OpenApiRenderer };

package/dist/styles.js

@@ -0,0 +1,4 @@
+/* empty css                      */
+/* empty css                        */
+/* empty css                     */
+/* empty css                     */

package/dist/theme-builder.d.ts

@@ -0,0 +1,28 @@
+import { RendererTheme } from './types';
+export interface ThemeTokens {
+    background?: string;
+    foreground?: string;
+    primary?: string;
+    primaryForeground?: string;
+    secondary?: string;
+    secondaryForeground?: string;
+    muted?: string;
+    mutedForeground?: string;
+    accent?: string;
+    accentForeground?: string;
+    destructive?: string;
+    destructiveForeground?: string;
+    success?: string;
+    successForeground?: string;
+    warning?: string;
+    warningForeground?: string;
+    border?: string;
+    input?: string;
+    ring?: string;
+    card?: string;
+    cardForeground?: string;
+    popover?: string;
+    popoverForeground?: string;
+    radius?: string;
+}
+export declare function createTheme(tokens: ThemeTokens): RendererTheme;

package/dist/types.d.ts

@@ -0,0 +1,46 @@
+import { ComponentType } from 'react';
+import { CsnRendererConfig } from '@sap/csn-interop-renderer';
+import { ConfigInterface } from '@asyncapi/react-component';
+import { MetaType } from './core/utils';
+import { OpenApiCustomAttributesConfig } from './openApi/customAttributes/types';
+import { AsyncApiCustomAttributesConfig } from './asyncApi/customAttributes/types';
+import { CsnCustomAttributesConfig } from './csn/customAttributes/types';
+export type CustomAttributesOptions = {
+    openapi?: OpenApiCustomAttributesConfig[];
+    asyncapi?: AsyncApiCustomAttributesConfig[];
+    csn?: CsnCustomAttributesConfig[];
+};
+export type RendererTheme = Partial<Record<`--ord-${string}`, string>>;
+export type RendererEntry = ComponentType<{
+    content: string;
+    className?: string;
+    theme?: RendererTheme;
+    [key: string]: any;
+}>;
+export type RendererMap = Partial<Record<MetaType, RendererEntry>>;
+export type MetadataRendererOptions = {
+    /** Auto-detect format from content when `type` prop is absent. Default: true. */
+    autoDetect?: boolean;
+    /** What to show for unresolved/disabled types. Default: 'error'. */
+    fallback?: 'error' | 'raw';
+    /**
+     * When `type` is explicitly set and content is not detected as that type,
+     * show an error instead of passing content to the renderer. Default: true.
+     */
+    strictTypeCheck?: boolean;
+    /** Custom attribute renderers per protocol. Pass `false` to disable all. Default: disabled. */
+    customAttributes?: CustomAttributesOptions | false;
+    /** Passed through to CsnRenderer. */
+    csn?: CsnRendererConfig;
+    /** Passed through to AsyncApiRenderer. */
+    asyncapi?: Partial<ConfigInterface>;
+    /** Passed through to A2ARenderer. */
+    a2a?: {
+        showValidation?: boolean;
+        showConnection?: boolean;
+    };
+    /** Passed through to McpRenderer. */
+    mcp?: {
+        showValidation?: boolean;
+    };
+};

package/dist/vendor.d.ts

@@ -0,0 +1,2 @@
+declare module '@open-resource-discovery/a2a-editor/styles';
+declare module '@open-resource-discovery/mcp-server-card-ui/styles';

package/package.json

@@ -1,5 +1,137 @@
 {
-  "name": "@open-resource-discovery/metadata-renderer",
-  "version": "0.0.0",
-  "author": "SAP SE"
+    "name": "@open-resource-discovery/metadata-renderer",
+    "version": "1.0.1",
+    "description": "React components that render OpenAPI, CSN, AsyncAPI, A2A, and MCP metadata documents.",
+    "author": "SAP SE",
+    "license": "Apache-2.0",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/open-resource-discovery/metadata-renderer"
+    },
+    "keywords": [
+        "metadata",
+        "renderer",
+        "react",
+        "openapi",
+        "swagger",
+        "csn",
+        "asyncapi",
+        "a2a",
+        "mcp"
+    ],
+    "engines": {
+        "node": ">=22",
+        "npm": ">=10"
+    },
+    "type": "module",
+    "scarfSettings": {
+        "enabled": false
+    },
+    "main": "./dist/index.js",
+    "module": "./dist/index.js",
+    "types": "./dist/index.d.ts",
+    "sideEffects": [
+        "**/*.css"
+    ],
+    "exports": {
+        "./package.json": "./package.json",
+        ".": {
+            "types": "./dist/index.d.ts",
+            "import": "./dist/index.js",
+            "default": "./dist/index.js"
+        },
+        "./openapi": {
+            "types": "./dist/entries/openapi.d.ts",
+            "import": "./dist/openapi.js",
+            "default": "./dist/openapi.js"
+        },
+        "./csn": {
+            "types": "./dist/entries/csn.d.ts",
+            "import": "./dist/csn.js",
+            "default": "./dist/csn.js"
+        },
+        "./asyncapi": {
+            "types": "./dist/entries/asyncapi.d.ts",
+            "import": "./dist/asyncapi.js",
+            "default": "./dist/asyncapi.js"
+        },
+        "./a2a": {
+            "types": "./dist/entries/a2a.d.ts",
+            "import": "./dist/a2a.js",
+            "default": "./dist/a2a.js"
+        },
+        "./mcp": {
+            "types": "./dist/entries/mcp.d.ts",
+            "import": "./dist/mcp.js",
+            "default": "./dist/mcp.js"
+        },
+        "./styles": "./dist/index.css"
+    },
+    "files": [
+        "dist",
+        "README.md"
+    ],
+    "publishConfig": {
+        "access": "public"
+    },
+    "scripts": {
+        "dev": "vite",
+        "build": "tsc -b && vite build --mode lib",
+        "build:lib:watch": "vite build --mode lib --watch",
+        "build:demo": "vite build",
+        "website:start": "npm --prefix website run start",
+        "website:build": "npm --prefix website run build",
+        "preview": "vite preview",
+        "typecheck": "tsc -b --noEmit",
+        "test": "vitest run",
+        "test:watch": "vitest",
+        "lint": "npm run eslint:ci",
+        "eslint": "eslint . --fix",
+        "eslint:ci": "eslint .",
+        "prettier": "prettier --write .",
+        "prettier:ci": "prettier --check .",
+        "format": "npm run prettier && npm run eslint",
+        "format:check": "npm run prettier:ci && npm run eslint:ci",
+        "prepack": "npm run build"
+    },
+    "peerDependencies": {
+        "react": "^18.0.0 || ^19.0.0",
+        "react-dom": "^18.0.0 || ^19.0.0"
+    },
+    "dependencies": {
+        "@asyncapi/react-component": "^3.1.3",
+        "@open-resource-discovery/a2a-editor": "^0.4.2",
+        "@open-resource-discovery/mcp-server-card-ui": "0.2.1",
+        "@sap/csn-interop-renderer": "0.5.0",
+        "@scalar/api-reference-react": "^0.9.54",
+        "@scalar/react-renderer": "^0.4.1",
+        "@scalar/types": "^0.16.2",
+        "react-error-boundary": "^6.0.0",
+        "react-markdown": "^10.1.0",
+        "yaml": "^2.8.1"
+    },
+    "overrides": {
+        "dompurify": ">=3.4.12",
+        "fast-uri": ">=3.1.5",
+        "undici": ">=7.29.0 <8",
+        "postcss": ">=8.5.23",
+        "brace-expansion": ">=1.1.18"
+    },
+    "devDependencies": {
+        "@sap/eslint-config": "0.5.2",
+        "@types/node": "24.13.3",
+        "@types/react": "19.2.17",
+        "@types/react-dom": "19.2.3",
+        "@vitejs/plugin-react": "6.0.5",
+        "eslint": "10.6.0",
+        "jsdom": "29.1.1",
+        "jsonc-eslint-parser": "3.1.0",
+        "prettier": "3.9.6",
+        "react": "19.2.8",
+        "react-dom": "19.2.8",
+        "typescript": "5.9.3",
+        "vite": "8.1.5",
+        "vite-plugin-dts": "4.5.4",
+        "vitest": "3.2.7"
+    }
 }