@digi-frontend/dgate-api-documentation 4.0.8 → 4.1.0

package/dist/index.cjs

@@ -1621,7 +1621,7 @@ const ViewModeApiHeader = ({ api, viewLayout, onViewLayoutChange }) => {
 };
 //#endregion
 //#region src/view/components/ApiPage/index.tsx
-const APIPage = () => {
+const APIPage = ({ apiOverride }) => {
 	const [selectedUrl, setSelectedUrl] = (0, react$1.useState)("");
 	const { view: { selectedApi, focusedTag, setFocusedTag } } = useStore();
 	const [viewStyle, setViewStyle] = (0, react$1.useState)("grid");
@@ -1667,7 +1667,7 @@ const APIPage = () => {
 		vertical: true,
 		gap: token.margin,
 		children: [selectedApi && /* @__PURE__ */ (0, react_jsx_runtime.jsx)(ViewModeApiHeader, {
-			api: selectedApi,
+			api: apiOverride ?? selectedApi,
 			viewLayout: viewStyle,
 			onViewLayoutChange: setViewStyle
 		}), Object.entries(getEndpointsForSelectedUrl()).sort(([a], [b]) => {
@@ -7319,7 +7319,7 @@ const AddTagDrawer = ({ open, onClose, mode, initialValues, onAddTag, onEditTag
 							if (!desc?.trim()) return Promise.resolve();
 							if (!link?.trim()) return Promise.reject(/* @__PURE__ */ new Error("External Docs Link is required when Description is filled"));
 							try {
-								new URL(link);
+								if (!/^https?:\/\/[a-zA-Z0-9]+([\-\.]{1}[a-zA-Z0-9]+)*\.[a-zA-Z]{2,}(:[0-9]{1,5})?(\/.*)?$/.test(link)) return Promise.reject(/* @__PURE__ */ new Error("Please enter a valid URL"));
 								return Promise.resolve();
 							} catch {
 								return Promise.reject(/* @__PURE__ */ new Error("Please enter a valid URL"));
@@ -8514,7 +8514,7 @@ const EndpointPage = () => {
 };
 //#endregion
 //#region src/view/console/MainContent.tsx
-const MainContent = ({ searchEnabled, handleResetSearch, handleVisitLandingPage }) => {
+const MainContent = ({ searchEnabled, handleResetSearch, handleVisitLandingPage, apiOverride }) => {
 	const { focusedContent, transformedData } = useStore(({ view }) => view);
 	const { wrapSSR, cx, token } = useStyle("MainContent", (token, scope) => ({
 		[scope("inner-doc-container")]: {
@@ -8597,7 +8597,7 @@ const MainContent = ({ searchEnabled, handleResetSearch, handleVisitLandingPage
 					children: "Reset Search"
 				})
 			]
-		}) : focusedContent === "ENDPOINT" ? /* @__PURE__ */ (0, react_jsx_runtime.jsx)(EndpointPage, {}) : /* @__PURE__ */ (0, react_jsx_runtime.jsx)(APIPage, {})
+		}) : focusedContent === "ENDPOINT" ? /* @__PURE__ */ (0, react_jsx_runtime.jsx)(EndpointPage, {}) : /* @__PURE__ */ (0, react_jsx_runtime.jsx)(APIPage, { apiOverride })
 	}));
 };
 //#endregion
@@ -8681,7 +8681,6 @@ function CodeboxSidebar$1() {
 		const queryParams = params.filter((p) => p.in === "query");
 		return [`curl --location '${serverUrl}${resolvedPath}${queryParams.length > 0 ? "?" + queryParams.map((p) => `${p.name}=sample-value`).join("&") : ""}'`, ...params.filter((p) => p.in === "header").map((p) => `--header '${p.name}: sample-value'`)];
 	})();
-	const hasAnyParams = (selectedEndpoint?.parameters ?? []).some((p) => p.in === "header" || p.in === "path" || p.in === "query");
 	const { token: antdToken, theme: themeConfig } = antd.theme.useToken();
 	const isDark = themeConfig.id == 1;
 	const headerBg = isDark ? antdToken.colorBgElevated : "#1d2856";
@@ -8803,7 +8802,7 @@ function CodeboxSidebar$1() {
 	}));
 	return /* @__PURE__ */ (0, react_jsx_runtime.jsxs)("div", {
 		className: cx("container"),
-		children: [hasAnyParams && /* @__PURE__ */ (0, react_jsx_runtime.jsxs)("div", {
+		children: [curlCommand && /* @__PURE__ */ (0, react_jsx_runtime.jsxs)("div", {
 			className: cx("rightCard", "rightCardRequest"),
 			children: [/* @__PURE__ */ (0, react_jsx_runtime.jsxs)("div", {
 				className: cx("rightCardHeader"),
@@ -9007,6 +9006,21 @@ const ConsoleDocumentationLayout = ({ data, preSelectedApi, handleVisitLandingPa
 	const { useBreakpoint } = antd.Grid;
 	const isMobile = !useBreakpoint().md;
 	const allEndpoints = (0, react$1.useMemo)(() => selectedApi ? Object.values(selectedApi.tags ?? {}).flat() : [], [selectedApi]);
+	const viewModeApi = (0, react$1.useMemo)(() => {
+		if (!selectedApi) return null;
+		if (mode !== "view") return selectedApi;
+		if (localApiName === selectedApi.title && localDescription === selectedApi.description) return selectedApi;
+		return {
+			...selectedApi,
+			title: localApiName,
+			description: localDescription
+		};
+	}, [
+		mode,
+		selectedApi,
+		localApiName,
+		localDescription
+	]);
 	(0, react$1.useEffect)(() => {
 		return () => {
 			resetStore();
@@ -9311,6 +9325,12 @@ const ConsoleDocumentationLayout = ({ data, preSelectedApi, handleVisitLandingPa
 	(0, react$1.useEffect)(() => {
 		if (mode !== "view" || !selectedEndpoint) return;
 		const epId = selectedEndpoint.id;
+		const localName = endpointNames[epId];
+		const localDesc = endpointDescs[epId];
+		const localEpTags = endpointTags[epId];
+		const patchedSummary = localName !== void 0 && localName !== selectedEndpoint.summary ? localName : selectedEndpoint.summary;
+		const patchedDesc = localDesc !== void 0 && localDesc !== selectedEndpoint.description ? localDesc : selectedEndpoint.description;
+		const patchedTags = localEpTags !== void 0 && JSON.stringify(localEpTags) !== JSON.stringify(selectedEndpoint.tags ?? []) ? localEpTags : selectedEndpoint.tags;
 		const openApiParams = (endpointParams[epId] ?? []).map((p) => ({
 			name: p.name,
 			in: p.in,
@@ -9321,7 +9341,6 @@ const ConsoleDocumentationLayout = ({ data, preSelectedApi, handleVisitLandingPa
 				...p.enum && p.enum.length > 0 ? { enum: p.enum } : {}
 			}
 		}));
-		if (JSON.stringify(selectedEndpoint.parameters ?? []) === JSON.stringify(openApiParams)) return;
 		const responseHeadersMap = (endpointResponseParams[epId] ?? []).reduce((acc, p) => {
 			acc[p.name] = {
 				schema: {
@@ -9337,14 +9356,21 @@ const ConsoleDocumentationLayout = ({ data, preSelectedApi, handleVisitLandingPa
 			...resp,
 			headers: Object.keys(responseHeadersMap).length > 0 ? responseHeadersMap : resp.headers
 		}]));
+		if (selectedEndpoint.summary === patchedSummary && selectedEndpoint.description === patchedDesc && JSON.stringify(selectedEndpoint.tags ?? []) === JSON.stringify(patchedTags ?? []) && JSON.stringify(selectedEndpoint.parameters ?? []) === JSON.stringify(openApiParams) && JSON.stringify(selectedEndpoint.responses) === JSON.stringify(patchedResponses)) return;
 		setSelectedEndpoint({
 			...selectedEndpoint,
+			summary: patchedSummary,
+			description: patchedDesc,
+			tags: patchedTags,
 			parameters: openApiParams,
 			responses: patchedResponses
 		});
 	}, [
 		mode,
 		selectedEndpoint,
+		endpointNames,
+		endpointDescs,
+		endpointTags,
 		endpointParams,
 		endpointResponseParams,
 		setSelectedEndpoint
@@ -9694,7 +9720,7 @@ const ConsoleDocumentationLayout = ({ data, preSelectedApi, handleVisitLandingPa
 			/* @__PURE__ */ (0, react_jsx_runtime.jsx)("div", {
 				className: cx("section"),
 				children: /* @__PURE__ */ (0, react_jsx_runtime.jsx)(ApiDocumentationBar, {
-					apiName: selectedApi?.title || "API",
+					apiName: localApiName,
 					mode,
 					onModeChange: setMode,
 					onReset: () => setResetConfirmModal(true),
@@ -10053,7 +10079,8 @@ const ConsoleDocumentationLayout = ({ data, preSelectedApi, handleVisitLandingPa
 					children: [/* @__PURE__ */ (0, react_jsx_runtime.jsx)(MainContent, {
 						handleVisitLandingPage: _handleVisitLandingPage,
 						handleResetSearch,
-						searchEnabled: !!searchValue
+						searchEnabled: !!searchValue,
+						apiOverride: mode === "view" ? viewModeApi : void 0
 					}), !isMobile && focusedContent === "ENDPOINT" && /* @__PURE__ */ (0, react_jsx_runtime.jsx)(CodeboxSidebar$1, {})]
 				})]
 			}),