Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: enable v3 documentation rendering #797

Merged
merged 12 commits into from
Oct 5, 2023
Merged

feat: enable v3 documentation rendering #797

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
9d3bde3
update to new parser
jonaslagoni Oct 3, 2023
1e531a6
update html template
jonaslagoni Oct 3, 2023
1980104
switch to new react components
jonaslagoni Oct 3, 2023
6ec54eb
Merge branch 'master' into enable_v3_react
jonaslagoni Oct 3, 2023
75092ce
Merge branch 'master' into enable_v3_react
jonaslagoni Oct 3, 2023
effe7cd
Merge branch 'master-github-upstream' into enable_v3_react
jonaslagoni Oct 4, 2023
5f17db3
fix
jonaslagoni Oct 4, 2023
8c1dcd7
Merge branch 'master' into enable_v3_react
jonaslagoni Oct 4, 2023
772ac2d
update dependency
jonaslagoni Oct 5, 2023
387e2ce
Merge branch 'master-github-upstream' into enable_v3_react
jonaslagoni Oct 5, 2023
25e2dd2
update dependency
jonaslagoni Oct 5, 2023
076812a
update lock file
jonaslagoni Oct 5, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions apps/studio/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,8 @@
"@asyncapi/avro-schema-parser": "^3.0.2",
"@asyncapi/converter": "^1.3.1",
"@asyncapi/openapi-schema-parser": "^3.0.4",
"@asyncapi/parser": "^3.0.0-next-major-spec.2",
"@asyncapi/react-component": "^1.0.0-next.54",
"@asyncapi/parser": "^3.0.0-next-major-spec.3",
"@asyncapi/react-component": "^1.0.2",
"@asyncapi/specs": "^6.0.0-next-major-spec.6",
"@ebay/nice-modal-react": "^1.2.10",
"@headlessui/react": "^1.7.4",
Expand Down
2 changes: 1 addition & 1 deletion apps/studio/src/components/Sidebar.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ export const Sidebar: FunctionComponent<SidebarProps> = () => {
onClick: () => updateState('secondaryPanel', 'template'),
icon: <VscOpenPreview className="w-5 h-5" />,
tooltip: 'HTML preview',
enabled: !isV3
enabled: true
},
// visuliser
{
Expand Down
18 changes: 4 additions & 14 deletions apps/studio/src/components/Template/HTMLWrapper.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@ import { AsyncApiComponentWP } from '@asyncapi/react-component';
import { useServices } from '../../services';
import { appState, useDocumentsState, useSettingsState, useOtherState, otherState } from '../../state';

import { OldAsyncAPIDocument as AsyncAPIDocument, convertToOldAPI } from '@asyncapi/parser/cjs';
import { AsyncAPIDocumentInterface } from '@asyncapi/parser/cjs';

interface HTMLWrapperProps {}

export const HTMLWrapper: React.FunctionComponent<HTMLWrapperProps> = () => {
const [parsedSpec, setParsedSpec] = useState<AsyncAPIDocument | null>(null);
const [parsedSpec, setParsedSpec] = useState<AsyncAPIDocumentInterface | null>(null);
const { navigationSvc } = useServices();
const document = useDocumentsState(state => state.documents['asyncapi']?.document) || null;

Expand All @@ -22,15 +22,13 @@ export const HTMLWrapper: React.FunctionComponent<HTMLWrapperProps> = () => {

useEffect(() => {
if (autoRendering || parsedSpec === null) {
const oldDocument = document !== null ? convertToOldAPI(document) : null;
setParsedSpec(oldDocument);
setParsedSpec(document);
}
}, [document]); // eslint-disable-line

useEffect(() => {
if (templateRerender) {
const oldDocument = document !== null ? convertToOldAPI(document) : null;
setParsedSpec(oldDocument);
setParsedSpec(document);
otherState.setState({ templateRerender: false });
}
}, [templateRerender]); // eslint-disable-line
Expand All @@ -43,14 +41,6 @@ export const HTMLWrapper: React.FunctionComponent<HTMLWrapperProps> = () => {
);
}

if (document?.version() === '3.0.0') {
return (
<div className="flex flex-1 overflow-hidden h-full justify-center items-center text-2xl mx-auto px-6 text-center">
<p>Documentation preview is not supported yet for v3.0.0 specifications.</p>
</div>
);
}

return (
parsedSpec && (
<div className="flex flex-1 flex-col h-full overflow-hidden">
Expand Down
Loading