5 | {props.children}
6 |
7 | {code}
4 | );
5 | };
6 |
7 | export default InlineCode;
8 |
--------------------------------------------------------------------------------
/src/data/vercel-url.ts:
--------------------------------------------------------------------------------
1 | export const vercelURL =
2 | "https://vercel.com/?utm_source=jsdocs-io&utm_campaign=oss";
3 |
4 | export const vercelPrivacyPolicyURL =
5 | "https://vercel.com/legal/privacy-policy?utm_source=jsdocs-io&utm_campaign=oss";
6 |
--------------------------------------------------------------------------------
/src/components/CharSetTag.tsx:
--------------------------------------------------------------------------------
1 | import Head from "next/head";
2 |
3 | const CharSetTag = () => {
4 | return (
5 |
6 |
7 |
8 | );
9 | };
10 |
11 | export default CharSetTag;
12 |
--------------------------------------------------------------------------------
/next-env.d.ts:
--------------------------------------------------------------------------------
1 | ///
4 |
8 | );
9 | };
10 |
11 | export default PackageLicenseAlert;
12 |
--------------------------------------------------------------------------------
/src/lib/min-semver-version.ts:
--------------------------------------------------------------------------------
1 | import semverMinVersion from "semver/ranges/min-version";
2 |
3 | const minSemverVersion = ({
4 | semver,
5 | }: {
6 | semver: string;
7 | }): string | undefined => {
8 | let version;
9 | try {
10 | version = semverMinVersion(semver)?.version;
11 | } catch {}
12 | return version !== "0.0.0" ? version : undefined;
13 | };
14 |
15 | export default minSemverVersion;
16 |
--------------------------------------------------------------------------------
/src/components/package/PackageMissingTypesAlert.tsx:
--------------------------------------------------------------------------------
1 | const PackageMissingTypesAlert = () => {
2 | return (
3 | 5 | API extraction from unlicensed or proprietary packages is not supported 6 |
7 |
4 |
9 | );
10 | };
11 |
12 | export default PackageMissingTypesAlert;
13 |
--------------------------------------------------------------------------------
/src/lib/load-nprogress.ts:
--------------------------------------------------------------------------------
1 | import Router from "next/router";
2 | import NProgress from "nprogress";
3 |
4 | const loadNProgress = () => {
5 | NProgress.configure({ showSpinner: false });
6 | Router.events.on("routeChangeStart", () => NProgress.start());
7 | Router.events.on("routeChangeComplete", () => NProgress.done());
8 | Router.events.on("routeChangeError", () => NProgress.done());
9 | };
10 |
11 | export default loadNProgress;
12 |
--------------------------------------------------------------------------------
/src/pages/_app.tsx:
--------------------------------------------------------------------------------
1 | import type { AppProps } from "next/app";
2 | import "../../node_modules/nprogress/nprogress.css";
3 | import "../../node_modules/prismjs/themes/prism-tomorrow.css";
4 | import "../../styles/index.css";
5 | import loadNProgress from "../lib/load-nprogress";
6 |
7 | loadNProgress();
8 |
9 | const MyApp = ({ Component, pageProps }: AppProps) => {
10 | return 5 | Unfortunately type definitions are currently not available for this 6 | package 7 |
8 |
14 |
16 | );
17 | };
18 |
19 | export default CodeBlock;
20 |
--------------------------------------------------------------------------------
/src/components/common/PackageVersionsLink.tsx:
--------------------------------------------------------------------------------
1 | import InternalLink from "./InternalLink";
2 |
3 | const PackageVersionsLink = ({
4 | name,
5 | title,
6 | children,
7 | }: {
8 | name: string;
9 | title?: string;
10 | children: React.ReactNode;
11 | }) => {
12 | return (
13 | Package Files ({files.length})
8 | 9 |Enums
12 | 13 |Install
13 | 14 | {installCommands.map((command) => ( 15 |Classes
16 | 17 |Overview
13 | 14 | {overview &&{description}
} 17 | 18 | {!overview && !description &&Overview not available.
} 19 |Functions
16 | 17 |-
11 | {variables.map(({ id, name }) => (
12 |
-
13 |
14 | {name} 15 | 16 |
17 | ))}
18 |
Variables
16 | 17 |-
11 | {functions.map(({ id, name }) => (
12 |
-
13 |
14 | {`${name}()`} 15 | 16 |
17 | ))}
18 |
10 |
18 | );
19 | };
20 |
21 | export default PackageExternalTypesAlert;
22 |
--------------------------------------------------------------------------------
/src/components/package/PackageIndexInterfacesSection.tsx:
--------------------------------------------------------------------------------
1 | import { InterfaceDeclaration } from "@jsdocs-io/extractor";
2 | import PackageIndexInterfacesList from "./PackageIndexInterfacesList";
3 |
4 | const PackageIndexInterfacesSection = ({
5 | interfaces,
6 | }: {
7 | interfaces: InterfaceDeclaration[];
8 | }) => {
9 | if (!interfaces.length) {
10 | return null;
11 | }
12 |
13 | return (
14 |
11 | Type definitions are available in the{" "}
12 |
Interfaces
16 | 17 |Namespaces
16 | 17 |-
11 | {typeAliases.map(({ id, name }) => (
12 |
-
13 |
14 | {name} 15 | 16 |
17 | ))}
18 |
Type Aliases
16 | 17 |
17 |
23 |
24 | );
25 | };
26 |
27 | export default Layout;
28 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | # See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
2 |
3 | # dependencies
4 | /node_modules
5 | /.pnp
6 | .pnp.js
7 |
8 | # testing
9 | /coverage
10 |
11 | # next.js
12 | /.next/
13 | /out/
14 |
15 | # production
16 | /build
17 |
18 | # misc
19 | .DS_Store
20 | *.pem
21 |
22 | # debug
23 | npm-debug.log*
24 | yarn-debug.log*
25 | yarn-error.log*
26 |
27 | # local env files
28 | .env.local
29 | .env.development.local
30 | .env.test.local
31 | .env.production.local
32 |
33 | # vercel
34 | .vercel
35 |
36 | # tsconfig build info
37 | tsconfig.tsbuildinfo
38 |
39 | # SvelteKit
40 | .svelte-kit
41 |
42 | # Env
43 | .env
44 |
45 | # Vite
46 | vite.config.ts.timestamp-*
47 |
--------------------------------------------------------------------------------
/src/data/dark-mode-script.ts:
--------------------------------------------------------------------------------
1 | export const darkModeScript = `
2 | if (localStorage.darkMode === 'true' || (!localStorage.darkMode && window.matchMedia('(prefers-color-scheme: dark)').matches)) {
3 | document.documentElement.classList.add('dark');
4 | localStorage.darkMode = 'true';
5 | } else {
6 | document.documentElement.classList.remove('dark');
7 | localStorage.darkMode = 'false';
8 | }`;
9 |
10 | export const darkModeScriptMinified = `"true"===localStorage.darkMode||!localStorage.darkMode&&window.matchMedia("(prefers-color-scheme: dark)").matches?(document.documentElement.classList.add("dark"),localStorage.darkMode="true"):(document.documentElement.classList.remove("dark"),localStorage.darkMode="false")`;
11 |
--------------------------------------------------------------------------------
/src/components/Logo.tsx:
--------------------------------------------------------------------------------
1 | import clsx from "clsx";
2 | import Link from "next/link";
3 |
4 | const Logo = ({ hideText = false }: { hideText?: boolean }) => {
5 | return (
6 |
7 |
8 | 
13 |
19 | jsDocs.io
20 |
21 |
22 |
23 | );
24 | };
25 |
26 | export default Logo;
27 |
--------------------------------------------------------------------------------
/test/lib/parse-json-stream.test.ts:
--------------------------------------------------------------------------------
1 | import stream from "stream";
2 | import parseJSONStream from "../../src/lib/parse-json-stream";
3 |
4 | describe("parseJSONStream", () => {
5 | it("rejects when the JSON stream is invalid", async () => {
6 | expect.assertions(1);
7 |
8 | try {
9 | await parseJSONStream({ jsonStream: stream.Readable.from(["{"]) });
10 | } catch (err) {
11 | expect(err).toBeDefined();
12 | }
13 | });
14 |
15 | it("resolves when the JSON stream is valid", async () => {
16 | expect.assertions(1);
17 |
18 | const got = await parseJSONStream({
19 | jsonStream: stream.Readable.from(['{"x":1}']),
20 | });
21 |
22 | expect(got).toStrictEqual({ x: 1 });
23 | });
24 | });
25 |
--------------------------------------------------------------------------------
/.github/FUNDING.yml:
--------------------------------------------------------------------------------
1 | # These are supported funding model platforms
2 |
3 | # github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
4 | patreon: jsdocs_io
5 | # open_collective: # Replace with a single Open Collective username
6 | # ko_fi: # Replace with a single Ko-fi username
7 | # tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
8 | # community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
9 | # liberapay: # Replace with a single Liberapay username
10 | # issuehunt: # Replace with a single IssueHunt username
11 | # otechie: # Replace with a single Otechie username
12 | # custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']
13 |
--------------------------------------------------------------------------------
/src/lib/get-package-page-error-props.ts:
--------------------------------------------------------------------------------
1 | import { GetStaticPropsResult } from "next";
2 | import { PackagePageKind } from "./package-page-kind";
3 | import { week } from "./revalidate-times";
4 |
5 | export interface PackagePagePropsError {
6 | readonly kind: PackagePageKind.Error;
7 | readonly message?: string;
8 | }
9 |
10 | const getPackagePageErrorProps = ({
11 | message = "Page Not Found",
12 | revalidate = week,
13 | }: {
14 | message?: string;
15 | revalidate?: number | boolean;
16 | } = {}): GetStaticPropsResultEnums
12 | 13 |
14 | {enums.map((declaration) => (
15 |
21 | -
15 | {members.map(({ id, name }) => (
16 |
-
17 |
18 | {name} 19 | 20 |
21 | ))}
22 |
Classes
16 | 17 |
18 | {classes.map((declaration) => (
19 |
25 | Functions
16 | 17 |
18 | {functions.map((declaration) => (
19 |
25 | Variables
16 | 17 |
18 | {variables.map((declaration) => (
19 |
25 | -
7 | {files.map(({ filename, unpkgURL, isIndexFile }) => (
8 |
- 9 | {unpkgURL ? ( 10 | 11 | {isIndexFile ? ( 12 | {filename} 13 | ) : ( 14 | <>{filename} 15 | )} 16 | 17 | ) : ( 18 | <>{filename} 19 | )} 20 | 21 | ))} 22 |
Type Aliases
16 | 17 |
18 | {typeAliases.map((declaration) => (
19 |
25 | -
8 | {enums.map(({ id, name, members }) => (
9 |
-
10 | 11 |19 |
12 |
16 | 17 |13 | {name} 14 | 15 |18 |
20 | ))}
21 |
Interfaces
16 | 17 |
18 | {interfaces.map((declaration) => (
19 |
25 | Namespaces
16 | 17 |
18 | {namespaces.map((declaration) => (
19 |
25 |
13 |
23 | );
24 | };
25 |
26 | export default PackageEnumDeclarationSections;
27 |
--------------------------------------------------------------------------------
/src/components/PageHead.tsx:
--------------------------------------------------------------------------------
1 | import CharSetTag from "./CharSetTag";
2 | import DescriptionTag from "./DescriptionTag";
3 | import Favicon from "./Favicon";
4 | import OpenGraphTags from "./OpenGraphTags";
5 | import TitleTag from "./TitleTag";
6 | import TwitterTags from "./TwitterTags";
7 | import ViewportTag from "./ViewportTag";
8 |
9 | const PageHead = ({
10 | title,
11 | description,
12 | url,
13 | }: {
14 | title: string;
15 | description: string;
16 | url: string;
17 | }) => {
18 | return (
19 | <>
20 |
17 | {declaration.members.map((decl) => (
18 |
21 | )}
22 | -
12 | {classes.map(({ id, name, members }) => (
13 |
-
14 | 15 |23 |
16 |
20 | 21 |17 | {name} 18 | 19 |22 |
24 | ))}
25 |
-
12 | {interfaces.map(({ id, name, members }) => (
13 |
-
14 | 15 |23 |
16 |
20 | 21 |17 | {name} 18 | 19 |22 |
24 | ))}
25 |
-
12 | {namespaces.map(({ id, name, declarations }) => (
13 |
-
14 | 15 |23 |
16 |
20 | 21 |17 | {name} 18 | 19 |22 |
24 | ))}
25 |
-
18 | {links.map(({ href, text }) => (
19 |
- 20 | 21 | {text} 22 | 23 | 24 | ))} 25 |
-
19 | {dependencies.map(({ name, semver, version }) => (
20 |
-
21 |
26 | {name} 27 | 28 |
29 | ))}
30 |
20 | {kindTitle} ({numDeps}) 21 |
22 | 23 | {numDeps > 0 ? ( 24 |No {kindDescription} dependencies.
27 | )} 28 |
20 |
21 | {tokens.map((line, index) => (
22 |
23 | {line.map((token, key) => (
24 |
25 | ))}
26 |
27 | ))}
28 |
29 |
30 | )}
31 | Tags ({Object.keys(distTags).length})
14 | 15 |-
16 | {Object.entries(distTags).map(([tag, version]) => (
17 |
-
21 |
26 | {version} 27 | 28 | 29 | {tag} 30 |
31 | ))}
32 |
20 |
33 | );
34 | };
35 |
36 | export default PackageNav;
37 |
--------------------------------------------------------------------------------
/src/hooks/useLocationHashRefresh.ts:
--------------------------------------------------------------------------------
1 | import { useRouter } from "next/router";
2 | import { useEffect } from "react";
3 |
4 | /**
5 | * Refresh the location hash to make browsers scroll
6 | * to the anchor link present in the URL.
7 | */
8 | const useLocationHashRefresh = () => {
9 | const router = useRouter();
10 |
11 | useEffect(() => {
12 | /**
13 | * Preserve hash for redirects on package documentation pages.
14 | *
15 | * For example, preserve the hash `#bar`
16 | * when going from the fallback page `/package/foo#bar`
17 | * to the versioned page `/package/foo/v/1.0.0#bar`.
18 | */
19 | if (router.isFallback) {
20 | window.jsdocsio.prevHash = window.location.hash;
21 | return;
22 | }
23 |
24 | const hash = window.jsdocsio.prevHash || window.location.hash;
25 | if (hash !== "") {
26 | setTimeout(() => {
27 | window.location.hash = "";
28 | window.location.hash = hash;
29 |
30 | window.jsdocsio.prevHash = undefined;
31 | });
32 | }
33 | });
34 | };
35 |
36 | export default useLocationHashRefresh;
37 |
--------------------------------------------------------------------------------
/src/pages/404.tsx:
--------------------------------------------------------------------------------
1 | import NextHead from "next/head";
2 | import Layout from "../components/common/Layout";
3 |
4 | const Page404 = ({ message = "Page Not Found" }: { message?: string }) => {
5 | const pageTitle = `${message} - jsDocs.io`;
6 | const pageDescription = pageTitle;
7 |
8 | return (
9 | <>
10 |
24 |
27 | 404
25 |{message}
26 |-
32 | {docs.map((doc) => (
33 |
-
34 |
35 |
36 | ))}
37 |
{name}
26 | 27 |27 | {kindDescription}{" "} 28 | {unpkgURL ? ( 29 | 30 | {name} 31 | 32 | ) : ( 33 | <>{name} 34 | )} 35 |
36 | ); 37 | }; 38 | 39 | export default PackageDeclarationTitle; 40 | -------------------------------------------------------------------------------- /test/lib/min-semver-version.test.ts: -------------------------------------------------------------------------------- 1 | import minSemverVersion from "../../src/lib/min-semver-version"; 2 | 3 | describe("minSemverVersion", () => { 4 | it("should return undefined when the minimum version cannot be found", () => { 5 | // Invalid ranges 6 | expect(minSemverVersion({ semver: "" })).toBeUndefined(); 7 | expect(minSemverVersion({ semver: "foo" })).toBeUndefined(); 8 | 9 | // X-ranges 10 | expect(minSemverVersion({ semver: "*" })).toBeUndefined(); 11 | expect(minSemverVersion({ semver: "x" })).toBeUndefined(); 12 | expect(minSemverVersion({ semver: "X" })).toBeUndefined(); 13 | 14 | // Less than ranges 15 | expect(minSemverVersion({ semver: "<=1.0.0" })).toBeUndefined(); 16 | }); 17 | 18 | it("should return the minimum version when possible", () => { 19 | expect(minSemverVersion({ semver: "1.*" })).toBe("1.0.0"); 20 | expect(minSemverVersion({ semver: "^1.0.0" })).toBe("1.0.0"); 21 | expect(minSemverVersion({ semver: ">=1.0.0" })).toBe("1.0.0"); 22 | expect(minSemverVersion({ semver: "=1.0.0" })).toBe("1.0.0"); 23 | expect(minSemverVersion({ semver: "~1.0.0" })).toBe("1.0.0"); 24 | }); 25 | }); 26 | -------------------------------------------------------------------------------- /src/components/common/InternalLink.tsx: -------------------------------------------------------------------------------- 1 | import { sanitizeUrl } from "@braintree/sanitize-url"; 2 | import Link from "next/link"; 3 | import React from "react"; 4 | import A from "./A"; 5 | 6 | const InternalLink = ({ 7 | href: rawHref, 8 | title, 9 | children, 10 | }: { 11 | href: string; 12 | title?: string; 13 | children: React.ReactNode; 14 | }) => { 15 | const href = sanitizeUrl(rawHref); 16 | const samePage = href.startsWith("#"); 17 | const hash = href.match(/(#.+)$/)?.[0]; 18 | 19 | if (samePage) { 20 | // A simple tag prevents re-rendering when jumping to anchors 21 | return ( 22 | 23 | {children} 24 | 25 | ); 26 | } 27 | 28 | return ( 29 | 30 | {/* eslint-disable-next-line jsx-a11y/anchor-is-valid */} 31 | { 35 | window.jsdocsio.prevHash = hash; 36 | }} 37 | > 38 | {children} 39 | 40 | 41 | ); 42 | }; 43 | 44 | export default InternalLink; 45 | -------------------------------------------------------------------------------- /src/data/heroicons-license.ts: -------------------------------------------------------------------------------- 1 | export const heroIconsLicense = `MIT License 2 | 3 | Copyright (c) 2020 Refactoring UI Inc. 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | `; 23 | -------------------------------------------------------------------------------- /src/data/modern-normalize-license.ts: -------------------------------------------------------------------------------- 1 | export const modernNormalizeLicense = `MIT License 2 | 3 | Copyright (c) Nicolas Gallagher 4 | Copyright (c) Jonathan Neal 5 | Copyright (c) Sindre Sorhus-
12 | {repositoryURL && (
13 |
- 14 | 15 | {repositoryURL.replace(/^https?:\/\//, "")} 16 | 17 | 18 | )} 19 | 20 |
- 21 | 25 | npm 26 | 27 | 28 | 29 |
- 30 | 34 | unpkg 35 | 36 | 37 | 38 |
- 39 | 43 | RunKit 44 | 45 | 46 |
14 | Versions ({Object.keys(versionsToTimestamps).length}) 15 |
16 | 17 |-
18 | {Object.entries(versionsToTimestamps)
19 | .reverse()
20 | .map(([version, publishedAt]) => (
21 |
-
25 |
30 | {version} 31 | 32 | 33 |34 |
35 | ))}
36 |
-
17 | {members.map(({ id, name, kind }) => (
18 |
-
19 |
25 | {name} 26 | {isCallableDeclarationKind({ kind }) && "()"} 27 | 28 |
29 | ))}
30 |
15 |
33 | );
34 | };
35 |
36 | export default PackageClassDeclarationSections;
37 |
--------------------------------------------------------------------------------
/test/lib/is-valid-license.test.ts:
--------------------------------------------------------------------------------
1 | import isValidLicense from "../../src/lib/is-valid-license";
2 |
3 | describe("isValidLicense", () => {
4 | it("returns false for invalid licenses", () => {
5 | expect(isValidLicense({})).toBeFalsy();
6 | expect(isValidLicense({ license: undefined })).toBeFalsy();
7 |
8 | // UNLICENSED
9 | expect(isValidLicense({ license: "UNLICENSED" })).toBeFalsy();
10 | expect(isValidLicense({ license: "UNlicensed" })).toBeFalsy();
11 | expect(isValidLicense({ license: "unlicensed" })).toBeFalsy();
12 |
13 | expect(isValidLicense({ license: "SEE " })).toBeFalsy();
14 | expect(isValidLicense({ license: "SEE LICENSE IN ..." })).toBeFalsy();
15 | expect(isValidLicense({ license: "see " })).toBeFalsy();
16 | expect(isValidLicense({ license: "see license" })).toBeFalsy();
17 | expect(isValidLicense({ license: "see license in ..." })).toBeFalsy();
18 | });
19 |
20 | it("returns true for valid licenses", () => {
21 | expect(isValidLicense({ license: "MIT" })).toBeTruthy();
22 | expect(isValidLicense({ license: "Apache-2.0" })).toBeTruthy();
23 |
24 | // unlicense.org license
25 | expect(isValidLicense({ license: "Unlicense" })).toBeTruthy();
26 | expect(isValidLicense({ license: "unlicense" })).toBeTruthy();
27 | });
28 | });
29 |
--------------------------------------------------------------------------------
/src/components/package/PackageIndexClassMembersList.tsx:
--------------------------------------------------------------------------------
1 | import { ClassMemberDeclarations } from "@jsdocs-io/extractor";
2 | import getDeclarationKindDescription from "../../lib/get-declaration-kind-description";
3 | import isCallableDeclarationKind from "../../lib/is-callable-declaration-kind";
4 | import sortByID from "../../lib/sort-by-id";
5 | import InternalLink from "../common/InternalLink";
6 |
7 | const PackageIndexClassMembersList = ({
8 | members: rawMembers,
9 | }: {
10 | members: ClassMemberDeclarations;
11 | }) => {
12 | const { properties, methods } = rawMembers;
13 | const members = sortByID([...properties, ...methods]);
14 | if (!members.length) {
15 | return null;
16 | }
17 |
18 | return (
19 |
19 | {declaration.constructors.map((decl) => (
20 |
31 | )}
32 | -
20 | {members.map(({ id, name, kind }) => (
21 |
-
22 |
28 | {name} 29 | {isCallableDeclarationKind({ kind }) && "()"} 30 | 31 |
32 | ))}
33 |
-
20 | {members.map(({ id, name, kind }) => (
21 |
-
22 |
28 | {name} 29 | {isCallableDeclarationKind({ kind }) && "()"} 30 | 31 |
32 | ))}
33 |
21 |
31 |
32 |
34 | );
35 | };
36 |
37 | export default CodeBlockContents;
38 |
--------------------------------------------------------------------------------
/src/lib/get-oss-libraries.ts:
--------------------------------------------------------------------------------
1 | import { readJSON } from "fs-extra";
2 | import cleanObject from "./clean-object";
3 |
4 | export interface OSSLibrary {
5 | readonly id: string;
6 | readonly name: string;
7 | readonly npm: string;
8 | readonly version?: string;
9 | readonly license?: string;
10 | readonly licenseText?: string;
11 | }
12 |
13 | interface RawOSSLibrary {
14 | readonly name: string;
15 | readonly version: string | null;
16 | readonly license: string | null;
17 | readonly licenseText: string | null;
18 | }
19 |
20 | /**
21 | * @param licensesFile - file generated by the `license-webpack-plugin` package (See `next.config.js`)
22 | */
23 | const getOSSLibraries = async ({
24 | licensesFile,
25 | }: {
26 | licensesFile: string;
27 | }): Promise-
14 |
-
15 |
19 | {name} 20 | 21 |
22 |
23 | {definitelyTypedName && (
24 | -
25 |
29 | 30 | {definitelyTypedName} 31 | 32 | 33 |
34 | )}
35 |
36 | {untypedName && (
37 | -
38 |
42 | {untypedName} 43 | 44 |
45 | )}
46 |
17 |
33 |
34 |
18 |
24 |
25 |
21 |
23 |
26 | {showSearchBar &&
32 |
29 |
31 |
35 |
37 | Badge
15 | 16 |
17 | To add a badge like this one
18 | 
19 | to your {"package's"} README, use the codes available below.
20 |
23 | You may also use Shields.io to create
24 | a custom badge linking to
-
28 |
-
29 | Markdown
30 |
31 |
32 |
33 | -
34 | HTML
35 |
36 |
37 |
34 |
40 |
35 |
39 |
13 |
39 | );
40 | };
41 |
42 | export default PackageInterfaceDeclarationSections;
43 |
--------------------------------------------------------------------------------
/src/lib/get-package-page-static-props.ts:
--------------------------------------------------------------------------------
1 | import { GetStaticPropsResult } from "next";
2 | import { PackagePagePropsAvailableVersions } from "./get-package-page-available-versions-props";
3 | import getPackagePageDocsProps, {
4 | PackagePagePropsDocs,
5 | } from "./get-package-page-docs-props";
6 | import { PackagePagePropsError } from "./get-package-page-error-props";
7 | import parsePackageRoute, { PackageRouteKind } from "./parse-package-route";
8 | import { week } from "./revalidate-times";
9 |
10 | export type PackagePageProps =
11 | | PackagePagePropsDocs
12 | | PackagePagePropsAvailableVersions
13 | | PackagePagePropsError;
14 |
15 | const getPackagePageStaticProps = async ({
16 | route: rawRoute,
17 | }: {
18 | route: string;
19 | }): Promise
17 | {declaration.members.properties.map((decl) => (
18 |
37 | )}
38 | Index
28 | 29 |
30 |
38 |
27 |
28 |
29 |
39 |
28 |
29 |
30 |
32 |
33 |
34 | Try with
29 | 30 |
-
31 |
-
32 | Updated
. 33 | {analysisTime && ( 34 | <> 35 |
36 | Package analyzed in {analysisTime} ms. 37 | 38 | )} 39 |
40 |
41 | {name && version && (
42 | - 43 | Missing or incorrect documentation?{" "} 44 | Open an issue for this package. 45 | 46 | )} 47 | 48 |
- 49 | 55 | 56 |
36 |
54 |
16 |
56 | );
57 | };
58 |
59 | export default PackageNamespaceDeclarationSections;
60 |
--------------------------------------------------------------------------------
/src/components/search/SearchResults.tsx:
--------------------------------------------------------------------------------
1 | import { SearchResult } from "query-registry";
2 | import TimeAgo from "../../components/common/TimeAgo";
3 | import A from "../common/A";
4 | import PackageLink from "../common/PackageLink";
5 |
6 | const SearchResults = ({
7 | searchResults,
8 | }: {
9 | searchResults?: SearchResult[];
10 | }) => {
11 | if (!searchResults) {
12 | return (
13 |
20 | {declaration.declarations.variables.map((decl) => (
21 |
54 | )}
55 | 14 | Loading... 15 |
16 | ); 17 | } 18 | 19 | const packages = searchResults.map(({ package: pkg }) => { 20 | return { 21 | name: pkg.name, 22 | version: pkg.version, 23 | description: pkg.description, 24 | date: pkg.date as string | undefined, 25 | publisherName: pkg.publisher?.username as string | undefined, 26 | }; 27 | }); 28 | if (!packages.length) { 29 | return ( 30 |No search results
31 | ); 32 | } 33 | 34 | return ( 35 |
36 | {packages.map(({ name, version, description, date, publisherName }) => (
37 |
75 | );
76 | };
77 |
78 | export default SearchResults;
79 |
--------------------------------------------------------------------------------
/test/lib/storage.test.ts:
--------------------------------------------------------------------------------
1 | import stream from "stream";
2 | import { loadObject, storeObject } from "../../src/lib/storage";
3 |
4 | describe("loadObject", () => {
5 | it("uses the default client by default", async () => {
6 | expect.assertions(1);
7 |
8 | const obj = await loadObject({ name: "" });
9 | expect(obj).toBeUndefined();
10 | });
11 |
12 | it("returns the object found in storage and parsed from JSON", async () => {
13 | expect.assertions(1);
14 |
15 | const mockClient = {
16 | async getObject() {
17 | return stream.Readable.from(['{"x":1}']);
18 | },
19 | async putObject() {
20 | throw new Error("not implemented");
21 | },
22 | };
23 |
24 | const obj = await loadObject({ name: "foo", client: mockClient });
25 | expect(obj).toStrictEqual({ x: 1 });
26 | });
27 |
28 | it("returns undefined if an object cannot be parsed from JSON", async () => {
29 | expect.assertions(1);
30 |
31 | const mockClient = {
32 | async getObject() {
33 | return stream.Readable.from(["{"]);
34 | },
35 | async putObject() {
36 | throw new Error("not implemented");
37 | },
38 | };
39 |
40 | const obj = await loadObject({ name: "foo", client: mockClient });
41 | expect(obj).toBeUndefined();
42 | });
43 |
44 | it("returns undefined if an object cannot be retrieved", async () => {
45 | expect.assertions(1);
46 |
47 | const mockClient = {
48 | async getObject() {
49 | throw new Error("object not found");
50 | },
51 | async putObject() {
52 | throw new Error("not implemented");
53 | },
54 | };
55 |
56 | const obj = await loadObject({ name: "foo", client: mockClient });
57 | expect(obj).toBeUndefined();
58 | });
59 | });
60 |
61 | describe("storeObject", () => {
62 | it("uses the default client by default", async () => {
63 | expect.assertions(1);
64 |
65 | await storeObject({ name: "", obj: {} });
66 | expect(true).toBeTruthy();
67 | });
68 |
69 | it("tries to store an object", async () => {
70 | expect.assertions(1);
71 |
72 | const mockClient = {
73 | async getObject() {
74 | throw new Error("not implemented");
75 | },
76 | async putObject() {
77 | throw new Error("operation failed");
78 | },
79 | };
80 |
81 | await storeObject({ name: "foo", obj: {}, client: mockClient });
82 | expect(true).toBeTruthy();
83 | });
84 | });
85 |
--------------------------------------------------------------------------------
/src/components/package/PackageNavDocsResourcesList.tsx:
--------------------------------------------------------------------------------
1 | import { useRouter } from "next/router";
2 | import InternalLink from "../common/InternalLink";
3 | import PackageVersionsLink from "../common/PackageVersionsLink";
4 |
5 | const PackageNavDocsResourcesList = ({
6 | name,
7 | hasDocs,
8 | }: {
9 | name: string;
10 | hasDocs: boolean;
11 | }) => {
12 | // Do not render this component on the `/package/
38 |
44 |
45 | {name}
46 |
47 |
48 |
49 | {description &&
73 | ))}
74 | {description}
} 50 | 51 |
52 | Version {version}
53 | {date && (
54 | <>
55 | {" "}
56 | published
-
22 | {hasDocs && (
23 | <>
24 |
-
25 |
26 | Index 27 | 28 |
29 |
30 | -
31 |
35 | Files 36 | 37 |
38 |
39 | )}
40 |
41 | -
42 |
46 | Dependencies 47 | 48 | 49 | {" ("} 50 | 51 |55 | Dev 56 | 57 | 58 | {", "} 59 | 60 |64 | Peer 65 | 66 | 67 | {")"} 68 |
69 |
70 | -
71 |
75 | Badge 76 | 77 |
78 |
79 | -
80 |
84 | Versions 85 | 86 |
87 |
49 |
52 |
53 |
65 |
66 |
80 |
81 | );
82 | };
83 |
84 | export default SearchBar;
85 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 |
2 |
3 | 
4 |
5 |
19 |
20 | 
21 |
22 |
Privacy Policy
41 | 42 |This page contains the privacy policy for jsDocs.io.
43 | 44 |The privacy policy was last updated on October 4, 2023.
45 |First Party
53 | 54 |55 | On jsDocs.io we do not directly collect personal data from our visitors. 56 |
57 |Hosting
65 | 66 |67 | jsDocs.io is hosted on Vercel, which may collect 68 | some data to provide its hosting services. 69 |
70 | 71 |72 | To learn more about the data collected by Vercel, you can visit their{" "} 73 | privacy policy page. 74 |
75 |Links to External Websites
83 | 84 |85 | jsDocs.io may contain links to external websites not operated by us and 86 | with different privacy policies. 87 |
88 | 89 |90 | We recommend you to review the privacy policy of any website you may 91 | visit. 92 |
93 |Contact Information
101 | 102 |103 | You can reach us by email at{" "} 104 | scibona.edoardo@proton.me. 105 |
106 |Credits
49 |OSS Licenses
61 | 62 |This website uses the following open source software:
63 | 64 |-
65 | {ossLibraries.map(
66 | ({ id, name, version, npm, license, licenseText }) => (
67 |
-
68 | 69 |87 |
70 | 71 | {name} 72 | 73 |
74 | 75 |-
76 | {version &&
- Version: {version} } 77 | 78 | {license &&
- License: {license} } 79 | 80 | {licenseText && ( 81 |
-
82 |
83 |
84 | )}
85 |
88 | )
89 | )}
90 |
Styling
99 | 100 |101 | The custom styling used in this website is generated by{" "} 102 | Tailwind CSS. 103 |
104 | 105 |
106 |
110 |
111 | License: MIT
107 | 108 |112 | The stylesheet generated by Tailwind CSS includes a version of{" "} 113 | 114 | modern-normalize 115 | 116 | . 117 |
118 | 119 |
120 |
124 | License: MIT
121 | 122 |Icons
132 | 133 |134 | The icons used in this website come from the{" "} 135 | Heroicons set. 136 |
137 | 138 |
139 |
143 | License: MIT
140 | 141 |Sponsor
48 | 49 |50 | Thank you for your interest in supporting jsDocs.io, your contribution 51 | will help fund the ongoing development and maintenance of this open 52 | source project! 53 |
54 | 55 |56 | You can{" "} 57 | 58 | 59 | become a backer or sponsor on Patreon 60 | 61 | {" "} 62 | with a monthly contribution and have your name or company logo listed 63 | below. 64 |
65 |Gold Sponsors
73 | 74 |-
75 | {goldSponsors.map(({ name, url, logo }, index) => (
76 |
-
77 |
82 |
87 | 88 |
89 | ))}
90 |
Silver Sponsors
99 | 100 |-
101 | {silverSponsors.map(({ name, url, logo }, index) => (
102 |
-
103 |
108 |
115 | ))}
116 |
Bronze Sponsors
125 | 126 |-
127 | {bronzeSponsors.map(({ name, url, logo }, index) => (
128 |
-
129 |
134 |
141 | ))}
142 |
Generous Backers
151 | 152 |-
153 | {generousBackers.map(({ name, url }, index) => (
154 |
- {url ? {name} : <>{name}} 155 | ))} 156 |
Backers
165 | 166 |-
167 | {backers.map(({ name }, index) => (
168 |
- {name} 169 | ))} 170 |