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

package/dist/chunks/{openApi-Ccp9Pa_k.js → openApi-BTb5yzun.js}

@@ -1,9 +1,9 @@
 import { i as loadObject } from "./utils-BC3WF3-9.js";
 /* empty css               */
-import { createElement, useEffect, useId, useMemo, useRef, useState } from "react";
+import { createElement, useEffect, useId, useMemo, useRef } from "react";
 import { ApiReferenceReact } from "@scalar/api-reference-react";
 import Markdown from "react-markdown";
-import { Fragment, jsx, jsxs } from "react/jsx-runtime";
+import { jsx, jsxs } from "react/jsx-runtime";
 import { ReactRenderer } from "@scalar/react-renderer";
 //#region src/lib/openApi/utils/context.ts
 var openApiContext = {
@@ -522,316 +522,6 @@ function buildScalarThemeStyles(id, theme) {
 	})()].filter(Boolean).join("\n\n");
 }
 //#endregion
-//#region src/lib/openApi/customAttributes/sapAttributes/root/typeCheckXxtOverview.ts
-function typeCheckExSapExtOverviewExSapExtOverview(obj) {
-	if (typeof obj !== "object" || obj === null) return false;
-	if (!("xSapExtOverview" in obj) || !Array.isArray(obj.xSapExtOverview)) return false;
-	return obj.xSapExtOverview.every((xSapExtOverview) => {
-		if (typeof xSapExtOverview !== "object" || xSapExtOverview === null) return false;
-		if (!("name" in xSapExtOverview) || !("values" in xSapExtOverview)) return false;
-		if (typeof xSapExtOverview.name !== "string") return false;
-		if (typeof xSapExtOverview.values === "string") return true;
-		if (!Array.isArray(xSapExtOverview.values)) return false;
-		if (xSapExtOverview.values.every((value) => typeof value === "string")) return true;
-		return xSapExtOverview.values.every((value) => {
-			if (typeof value !== "object" || value === null) return false;
-			if (!("text" in value) || typeof value.text !== "string") return false;
-			return "format" in value && (value.format === "plain" || value.format === "markdown");
-		});
-	});
-}
-//#endregion
-//#region src/lib/openApi/customAttributes/sapAttributes/root/extOverview.tsx
-function extOverview(props) {
-	if (!typeCheckExSapExtOverviewExSapExtOverview(props)) return null;
-	const { xSapExtOverview } = props;
-	return /* @__PURE__ */ jsxs("div", {
-		className: "sap-api-container",
-		children: [/* @__PURE__ */ jsxs("div", {
-			className: "sap-api-label sap-api-label--root",
-			children: ["SAP Extensibility Overview ", /* @__PURE__ */ jsx(attributeLink, { attributeName: "x-sap-ext-overview" })]
-		}), /* @__PURE__ */ jsx("div", {
-			className: "sap-api-value sap-api-value--root",
-			children: xSapExtOverview.map((extension) => /* @__PURE__ */ jsxs("div", { children: [/* @__PURE__ */ jsx("strong", { children: extension.name }), /* @__PURE__ */ jsx("ul", {
-				className: "sap-api-list",
-				children: typeof extension.values === "string" ? /* @__PURE__ */ jsx("li", { children: extension.values }) : extension.values.map((value) => typeof value === "string" ? /* @__PURE__ */ jsx("li", { children: value }, value) : /* @__PURE__ */ jsx("li", { children: value.format === "plain" ? value.text : /* @__PURE__ */ jsx(Markdown, { children: value.text }) }, value.text))
-			})] }, extension.name))
-		})]
-	});
-}
-//#endregion
-//#region src/lib/openApi/customAttributes/sapAttributes/root/stateInfo.tsx
-var background = {
-	ACTIVE: "color-mix(in srgb, var(--scalar-color-green) 15%, transparent)",
-	BETA: "color-mix(in srgb, var(--scalar-color-blue) 15%, transparent)",
-	DEPRECATED: "color-mix(in srgb, var(--scalar-color-orange) 15%, transparent)",
-	DECOMMISSIONED: "color-mix(in srgb, var(--scalar-color-red) 15%, transparent)"
-};
-var color = {
-	ACTIVE: "var(--scalar-color-green)",
-	BETA: "var(--scalar-color-blue)",
-	DEPRECATED: "var(--scalar-color-orange)",
-	DECOMMISSIONED: "var(--scalar-color-red)"
-};
-function StateInfo({ xSapStateInfo }) {
-	if (!xSapStateInfo) return null;
-	const status = xSapStateInfo.state?.toUpperCase();
-	const badge = /* @__PURE__ */ jsx("span", {
-		style: {
-			display: "inline-block",
-			borderRadius: "10px",
-			padding: "0 6px",
-			background: background[status] || "",
-			color: color[status] || ""
-		},
-		children: status
-	});
-	const dateFormatter = new Intl.DateTimeFormat("en-GB", { dateStyle: "long" });
-	const formatDate = (d) => {
-		const parsed = new Date(d);
-		return isNaN(parsed.getTime()) ? d : dateFormatter.format(parsed);
-	};
-	return /* @__PURE__ */ jsxs("div", {
-		className: "sap-api-container",
-		children: [/* @__PURE__ */ jsxs("div", {
-			className: "sap-api-label",
-			children: ["API State ", /* @__PURE__ */ jsx(attributeLink, { attributeName: "x-sap-stateInfo" })]
-		}), /* @__PURE__ */ jsxs("div", {
-			className: "sap-api-value",
-			children: [
-				badge,
-				xSapStateInfo.deprecationDate && /* @__PURE__ */ jsxs("div", { children: ["Deprecated on ", formatDate(xSapStateInfo.deprecationDate)] }),
-				xSapStateInfo.decommissionedDate && /* @__PURE__ */ jsxs("div", { children: ["Decommissioned on ", formatDate(xSapStateInfo.decommissionedDate)] }),
-				xSapStateInfo.successorApi && /* @__PURE__ */ jsxs("div", { children: ["Successor API: ", /* @__PURE__ */ jsx("a", {
-					href: xSapStateInfo.successorApi,
-					target: "_blank",
-					rel: "noreferrer",
-					className: "sap-api-link",
-					children: xSapStateInfo.successorApi
-				})] })
-			]
-		})]
-	});
-}
-//#endregion
-//#region src/lib/openApi/customAttributes/sapAttributes/root/ordId.tsx
-function CopyIcon() {
-	return /* @__PURE__ */ jsxs("svg", {
-		viewBox: "0 0 24 24",
-		width: "1em",
-		height: "1em",
-		fill: "none",
-		stroke: "currentColor",
-		strokeWidth: "2",
-		"aria-hidden": "true",
-		children: [/* @__PURE__ */ jsx("rect", {
-			x: "9",
-			y: "9",
-			width: "13",
-			height: "13",
-			rx: "2"
-		}), /* @__PURE__ */ jsx("path", { d: "M5 15H4a2 2 0 0 1-2-2V4a2 2 0 0 1 2-2h9a2 2 0 0 1 2 2v1" })]
-	});
-}
-function CheckIcon() {
-	return /* @__PURE__ */ jsx("svg", {
-		viewBox: "0 0 24 24",
-		width: "1em",
-		height: "1em",
-		fill: "none",
-		stroke: "currentColor",
-		strokeWidth: "2",
-		"aria-hidden": "true",
-		children: /* @__PURE__ */ jsx("path", { d: "M20 6 9 17l-5-5" })
-	});
-}
-function ordId({ xSapOrdId }) {
-	const [copied, setCopied] = useState(false);
-	if (!xSapOrdId) return null;
-	const copy = () => {
-		navigator.clipboard?.writeText(xSapOrdId).then(() => {
-			setCopied(true);
-			setTimeout(() => setCopied(false), 1500);
-		});
-	};
-	return /* @__PURE__ */ jsxs("div", {
-		className: "sap-api-container",
-		children: [/* @__PURE__ */ jsxs("div", {
-			className: "sap-api-label",
-			children: ["ORD ID ", /* @__PURE__ */ jsx(attributeLink, { attributeName: "x-sap-ord-id" })]
-		}), /* @__PURE__ */ jsxs("div", {
-			className: "sap-api-value sap-api-ord-id",
-			children: [/* @__PURE__ */ jsx("span", {
-				className: "sap-api-ord-id-text",
-				children: xSapOrdId
-			}), /* @__PURE__ */ jsx("button", {
-				type: "button",
-				className: "sap-api-copy-btn",
-				onClick: copy,
-				"aria-label": "Copy ORD ID",
-				title: copied ? "Copied" : "Copy",
-				children: copied ? /* @__PURE__ */ jsx(CheckIcon, {}) : /* @__PURE__ */ jsx(CopyIcon, {})
-			})]
-		})]
-	});
-}
-//#endregion
-//#region src/lib/openApi/customAttributes/sapAttributes/operation/deprecatedOperation.tsx
-function deprecatedOperation({ xSapDeprecatedOperation }) {
-	const deprecationDate = new Intl.DateTimeFormat("en-GB", { dateStyle: "long" }).format(new Date(xSapDeprecatedOperation.deprecationDate));
-	return /* @__PURE__ */ jsxs("div", {
-		className: "sap-api-container",
-		children: [/* @__PURE__ */ jsxs("div", {
-			className: "sap-api-label",
-			children: ["SAP Deprecated Operation ", /* @__PURE__ */ jsx(attributeLink, { attributeName: "x-sap-deprecated-operation" })]
-		}), /* @__PURE__ */ jsxs("div", {
-			className: "sap-api-value",
-			children: [
-				"Deprecated on ",
-				deprecationDate,
-				" ",
-				/* @__PURE__ */ jsx("br", {}),
-				!xSapDeprecatedOperation.successorOperationRef && !xSapDeprecatedOperation.successorOperationId ? null : /* @__PURE__ */ jsxs(Fragment, { children: [
-					" Successor ",
-					xSapDeprecatedOperation.successorOperationRef ? /* @__PURE__ */ jsx("a", {
-						href: xSapDeprecatedOperation.successorOperationRef,
-						rel: "noreferrer, noopener",
-						children: xSapDeprecatedOperation.successorOperationRef
-					}) : null,
-					xSapDeprecatedOperation.successorOperationId ? /* @__PURE__ */ jsx("span", { children: xSapDeprecatedOperation.successorOperationId }) : null
-				] })
-			]
-		})]
-	});
-}
-//#endregion
-//#region src/lib/openApi/customAttributes/sapAttributes/schema/odmEntityName.tsx
-function odmEntityName({ xSapOdmEntityName }) {
-	return /* @__PURE__ */ jsxs("div", {
-		className: "sap-api-container",
-		children: [/* @__PURE__ */ jsxs("div", {
-			className: "sap-api-label",
-			children: ["ODM entity name ", /* @__PURE__ */ jsx(attributeLink, { attributeName: "x-sap-odm-entity-name" })]
-		}), /* @__PURE__ */ jsx("div", {
-			className: "sap-api-value",
-			children: xSapOdmEntityName
-		})]
-	});
-}
-//#endregion
-//#region src/lib/openApi/customAttributes/sapAttributes/schema/odmSemanticKey.tsx
-function odmSemanticKey({ xSapOdmSemanticKey }) {
-	return /* @__PURE__ */ jsxs("div", {
-		className: "sap-api-container",
-		children: [/* @__PURE__ */ jsxs("div", {
-			className: "sap-api-label",
-			children: ["ODM Semantic Key ", /* @__PURE__ */ jsx(attributeLink, { attributeName: "x-sap-odm-semantic-key" })]
-		}), /* @__PURE__ */ jsx("div", {
-			className: "sap-api-value",
-			children: xSapOdmSemanticKey.map((entry) => /* @__PURE__ */ jsxs("div", { children: [/* @__PURE__ */ jsx("strong", { children: entry.name }), /* @__PURE__ */ jsx("ul", {
-				className: "sap-api-list",
-				children: entry.values.map((v) => /* @__PURE__ */ jsx("li", { children: v }, v))
-			})] }, entry.name))
-		})]
-	});
-}
-//#endregion
-//#region src/lib/openApi/customAttributes/sapAttributes/sapPreset.ts
-function component(fn) {
-	return { component: fn };
-}
-var sapOpenApiAttributesConfig = {
-	prefixStartsWith: "x-sap-",
-	documentationUrl: (name, { version }) => `https://github.com/SAP/openapi-specification/tree/main/sap-schemas/v${version}#${name}`,
-	extensions: {
-		"x-sap-compliance-level": {
-			type: "link",
-			label: "SAP Compliance Level",
-			callback: (v) => {
-				return {
-					"sap:base:v1": "https://github.com/open-resource-discovery/specification/blob/main/docs/spec-extensions/policy-levels/sap-base-v1.md",
-					"sap:core:v1": "https://github.com/open-resource-discovery/specification/blob/main/docs/spec-extensions/policy-levels/sap-core-v1.md",
-					"sap:core:v2": "https://github.com/open-resource-discovery/specification/blob/main/docs/spec-extensions/policy-levels/sap-core-v1.md"
-				}[String(v)];
-			}
-		},
-		"x-sap-shortText": {
-			type: "string",
-			label: "SAP Short Text"
-		},
-		"x-sap-software-min-version": {
-			type: "string",
-			label: "SAP Software Version"
-		},
-		"x-sap-api-type": {
-			type: "string",
-			label: "SAP API Type"
-		},
-		"x-sap-direction": {
-			type: "string",
-			label: "SAP Direction"
-		},
-		"x-sap-ord-id": component(ordId),
-		"x-sap-operation-intent": {
-			type: "string",
-			label: "SAP Operation Intent"
-		},
-		"x-sap-odm-oid": {
-			type: "string",
-			label: "ODM OID"
-		},
-		"x-sap-odm-oid-reference-entity-name": {
-			type: "string",
-			label: "ODM OID Reference Entity Name"
-		},
-		"x-sap-precision": {
-			type: "number",
-			label: "SAP Precision"
-		},
-		"x-sap-scale": {
-			type: "number",
-			label: "SAP Scale"
-		},
-		"x-sap-root-entity": {
-			type: "boolean",
-			label: "SAP Root Entity"
-		},
-		"x-sap-dpp-entity-semantics": {
-			type: "string",
-			label: "SAP DPP: Entity Semantics"
-		},
-		"x-sap-dpp-data-subject-role": {
-			type: "string",
-			label: "SAP DPP: Data Subject Role"
-		},
-		"x-sap-dpp-data-subject-role-description": {
-			type: "string",
-			label: "SAP DPP: Data Subject Role Description"
-		},
-		"x-sap-dpp-field-semantics": {
-			type: "string",
-			label: "SAP DPP: Field Semantics"
-		},
-		"x-sap-dpp-is-potentially-personal": {
-			type: "boolean",
-			label: "SAP DPP: Potentially Personal"
-		},
-		"x-sap-dpp-is-potentially-sensitive": {
-			type: "boolean",
-			label: "SAP DPP: Potentially Sensitive"
-		},
-		"x-sap-ext-overview": component(extOverview),
-		"x-sap-stateInfo": component(StateInfo),
-		"x-sap-extensible": {
-			type: "object",
-			label: "SAP Extensible"
-		},
-		"x-sap-deprecated-operation": component(deprecatedOperation),
-		"x-sap-odm-entity-name": component(odmEntityName),
-		"x-sap-odm-semantic-key": component(odmSemanticKey)
-	}
-};
-//#endregion
 //#region src/lib/openApi/styles.ts
 var styles_default = `
 .sap-api-container {
@@ -1028,11 +718,12 @@ a:hover {
 `;
 //#endregion
 //#region src/lib/openApi/index.tsx
-function OpenApiRenderer({ content, showCustomAttributes = true, customAttributes, className, theme }) {
+function OpenApiRenderer({ content, customAttributes, className, theme }) {
 	const id = useId();
 	const containerRef = useRef(null);
 	const isDark = className?.split(/\s+/).includes("dark") ?? false;
-	const activeConfigs = customAttributes ?? [sapOpenApiAttributesConfig];
+	const activeConfigs = useMemo(() => customAttributes ?? [], [customAttributes]);
+	const isEnabled = customAttributes !== void 0;
 	useEffect(() => {
 		const el = containerRef.current;
 		if (!el) return;
@@ -1046,23 +737,23 @@ function OpenApiRenderer({ content, showCustomAttributes = true, customAttribute
 		};
 	}, []);
 	const customAttributesKey = useMemo(() => {
-		if (!showCustomAttributes) return "";
+		if (!isEnabled) return "";
 		const parsed = loadObject(content);
 		if (!parsed) return "";
 		return activeConfigs.flatMap((config) => extractCustomAttributeValues(parsed, config.prefixStartsWith ?? "").map(([k, v]) => `${k}=${JSON.stringify(v)}`)).join("|");
 	}, [
 		content,
-		showCustomAttributes,
+		isEnabled,
 		activeConfigs
 	]);
 	const configuration = useMemo(() => {
 		openApiContext.version = getVersion(content);
-		openApiContext.configs = showCustomAttributes ? activeConfigs : [];
+		openApiContext.configs = isEnabled ? activeConfigs : [];
 		const parsed = loadObject(content);
 		const prefixes = activeConfigs.map((c) => c.prefixStartsWith).filter(Boolean);
 		return {
-			content: showCustomAttributes && parsed && prefixes.length ? injectSchemaExtensions(parsed, prefixes) : parsed ?? content,
-			plugins: showCustomAttributes ? [buildCustomAttributesPlugin(parsed, activeConfigs)] : [],
+			content: isEnabled && parsed && prefixes.length ? injectSchemaExtensions(parsed, prefixes) : parsed ?? content,
+			plugins: isEnabled ? [buildCustomAttributesPlugin(parsed, activeConfigs)] : [],
 			forceDarkModeState: isDark ? "dark" : "light",
 			hideDarkModeToggle: true,
 			hideClientButton: true,
@@ -1071,7 +762,7 @@ function OpenApiRenderer({ content, showCustomAttributes = true, customAttribute
 	}, [
 		content,
 		isDark,
-		showCustomAttributes,
+		isEnabled,
 		activeConfigs
 	]);
 	return /* @__PURE__ */ jsxs("div", {
@@ -1084,9 +775,9 @@ function OpenApiRenderer({ content, showCustomAttributes = true, customAttribute
 		children: [
 			/* @__PURE__ */ jsx("style", { children: styles_default }),
 			theme && /* @__PURE__ */ jsx("style", { children: buildScalarThemeStyles(id, theme) }),
-			/* @__PURE__ */ jsx(ApiReferenceReact, { configuration }, `${isDark ? "dark" : "light"}-${showCustomAttributes}-${customAttributesKey}`)
+			/* @__PURE__ */ jsx(ApiReferenceReact, { configuration }, `${isDark ? "dark" : "light"}-${isEnabled}-${customAttributesKey}`)
 		]
 	});
 }
 //#endregion
-export { sapOpenApiAttributesConfig as n, OpenApiRenderer as t };
+export { attributeLink as n, OpenApiRenderer as t };

package/dist/core/dispatch.d.ts

@@ -0,0 +1,3 @@
+import { MetaType } from './utils';
+import { MetadataRendererOptions } from '../types';
+export declare function buildRendererExtraProps(metaType: MetaType, options: MetadataRendererOptions | undefined): Record<string, unknown>;

package/dist/core/dispatch.test.d.ts

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

package/dist/csn/index.d.ts

@@ -4,9 +4,8 @@ import { CsnCustomAttributesConfig } from './customAttributes/types';
 export type CsnRendererProps = {
     content: string;
     config?: CsnRendererConfig;
-    showCustomAttributes?: boolean;
     customAttributes?: CsnCustomAttributesConfig[];
     className?: string;
     theme?: RendererTheme;
 };
-export declare function CsnRenderer({ content, config, showCustomAttributes, customAttributes, className, theme, }: CsnRendererProps): import("react").JSX.Element;
+export declare function CsnRenderer({ content, config, customAttributes, className, theme }: CsnRendererProps): import("react").JSX.Element;

package/dist/csn.js

@@ -1,2 +1,2 @@
-import { t as CsnRenderer } from "./chunks/csn-D4GBs8tC.js";
+import { t as CsnRenderer } from "./chunks/csn-3ek2O4d6.js";
 export { CsnRenderer };