Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 | import type { Assembly } from "@jsii/spec";
import type { Schema } from "jsii-docgen";
import { createContext, FunctionComponent, useContext, useMemo } from "react";
import { useQuery, UseQueryResult } from "react-query";
import { useParams } from "react-router-dom";
import { Types, MenuItem, parseMarkdownStructure } from "./util";
import { fetchAssembly } from "../../api/package/assembly";
import { fetchJsonDocs, fetchMarkdownDocs } from "../../api/package/docs";
import { fetchMetadata, Metadata } from "../../api/package/metadata";
import { Language, languageFilename } from "../../constants/languages";
import { QUERY_PARAMS } from "../../constants/url";
import { useLanguage } from "../../hooks/useLanguage";
import { useQueryParams } from "../../hooks/useQueryParams";
import { useVersions } from "../../hooks/useVersions";
import { NotFound } from "../NotFound";
interface PathParams {
name: string;
scope?: string;
version: string;
}
interface PackageState {
apiReference?: Types;
assembly: UseQueryResult<Assembly>;
hasDocs: boolean;
hasError: boolean;
isLoadingDocs: boolean;
isSupported: boolean;
language: Language;
markdownDocs: UseQueryResult<string>;
jsonDocs: UseQueryResult<Schema>;
metadata: UseQueryResult<Metadata>;
name: string;
pageDescription: string;
pageTitle: string;
readme?: string;
scope?: string;
version: string;
allVersions?: string[];
menuItems: MenuItem[];
}
const PackageStateContext = createContext<PackageState | undefined>(undefined);
/**
* Consumes shared page-leve data for components on the Package page
*/
export const usePackageState = () => {
const state = useContext(PackageStateContext);
if (!state) {
throw new Error(
"This component must be a child of a <PackageStateProvider />"
);
}
return state;
};
/**
* Provides shared page-level data to components on the Package page
*/
export const PackageStateProvider: FunctionComponent = ({ children }) => {
const { name, scope, version }: PathParams = useParams();
const id = `${scope}/${name}/v${version}`;
const [language] = useLanguage();
const q = useQueryParams();
const submodule = q.get(QUERY_PARAMS.SUBMODULE) ?? "";
const { data: versionData } = useVersions();
const pkgName = scope ? `${scope}/${name}` : name;
const allVersions = versionData?.packages[pkgName];
const markdownDocs = useQuery(`${id}-docs-${language}-${submodule}-md`, () =>
fetchMarkdownDocs(
name,
version,
languageFilename[language],
scope,
submodule
)
);
const jsonDocs = useQuery(`${id}-docs-${language}-${submodule}-json`, () =>
fetchJsonDocs(name, version, languageFilename[language], scope, submodule)
);
const assembly = useQuery(`${id}-assembly`, () =>
fetchAssembly(name, version, scope)
);
const metadata = useQuery(`${id}-metadata`, () =>
fetchMetadata(name, version, scope)
);
const pageTitle = `${scope ? `${scope}/${name}` : name} ${version}`;
const pageDescription = assembly.data?.description ?? "";
const hasError = Boolean(
markdownDocs.error || jsonDocs.error || assembly.error
);
const hasDocs = Boolean(
!markdownDocs.isLoading &&
!jsonDocs.isLoading &&
!assembly.isLoading &&
markdownDocs.data &&
jsonDocs.data &&
assembly.data
);
// This will also be true if it cannot be verified (assembly not there)
const isSupported = Boolean(
language === Language.TypeScript ||
assembly.isLoading ||
assembly.error ||
assembly.data?.targets?.[language.toString()] != null
);
const isLoadingDocs = Boolean(
!metadata.isLoading &&
(assembly.isLoading || markdownDocs.isLoading || jsonDocs.isLoading)
);
const parsedMd = useMemo(() => {
if (!markdownDocs.data) return { menuItems: [] };
return parseMarkdownStructure(markdownDocs.data, {
scope,
name,
version,
language,
submodule,
});
}, [markdownDocs.data, name, scope, version, language, submodule]);
// Handle missing JSON for assembly
if (assembly.error) {
return <NotFound />;
}
return (
<PackageStateContext.Provider
value={{
assembly: assembly,
hasDocs,
hasError,
isLoadingDocs,
isSupported,
language,
markdownDocs,
jsonDocs,
metadata: metadata,
name,
pageDescription,
pageTitle,
scope,
version,
allVersions,
...parsedMd,
}}
>
{children}
</PackageStateContext.Provider>
);
};
|