= (node) => {
+ const handleKeyDown = (event: KeyboardEvent) => {
+ if (event.ctrlKey && event.key === 'k') {
+ event.preventDefault();
+ node.focus();
+ }
+ };
+
+ window.addEventListener('keydown', handleKeyDown, true);
+
+ return {
+ destroy() {
+ window.removeEventListener('keydown', handleKeyDown, true);
+ }
+ };
+};
diff --git a/src/lib/components/AboutLinkButton.svelte b/src/lib/components/AboutLinkButton.svelte
new file mode 100644
index 00000000..9f72a1a6
--- /dev/null
+++ b/src/lib/components/AboutLinkButton.svelte
@@ -0,0 +1,8 @@
+
+
+
+
diff --git a/src/lib/components/DocRoot.svelte b/src/lib/components/DocRoot.svelte
new file mode 100644
index 00000000..1622a497
--- /dev/null
+++ b/src/lib/components/DocRoot.svelte
@@ -0,0 +1,4 @@
+
+
+
diff --git a/src/lib/components/FaqLinkButton.svelte b/src/lib/components/FaqLinkButton.svelte
new file mode 100644
index 00000000..492f6087
--- /dev/null
+++ b/src/lib/components/FaqLinkButton.svelte
@@ -0,0 +1,8 @@
+
+
+
+
diff --git a/src/lib/components/Footer.svelte b/src/lib/components/Footer.svelte
new file mode 100644
index 00000000..6f49bea9
--- /dev/null
+++ b/src/lib/components/Footer.svelte
@@ -0,0 +1,15 @@
+
+
+
diff --git a/src/lib/components/GitHubLinkButton.svelte b/src/lib/components/GitHubLinkButton.svelte
new file mode 100644
index 00000000..dbefa1ce
--- /dev/null
+++ b/src/lib/components/GitHubLinkButton.svelte
@@ -0,0 +1,8 @@
+
+
+
+
diff --git a/src/lib/components/HomepageLinkButton.svelte b/src/lib/components/HomepageLinkButton.svelte
new file mode 100644
index 00000000..d4cbbef5
--- /dev/null
+++ b/src/lib/components/HomepageLinkButton.svelte
@@ -0,0 +1,8 @@
+
+
+
+
diff --git a/src/lib/components/HomepageLogo.svelte b/src/lib/components/HomepageLogo.svelte
new file mode 100644
index 00000000..3c651247
--- /dev/null
+++ b/src/lib/components/HomepageLogo.svelte
@@ -0,0 +1,13 @@
+
+
+
+
+
+
+ Automatic documentation for npm packages
+
+
+
Official Resources
+
+
+
+
+
Package Info
+
+
+
+
+
+
+
+
External Resources
+
+
+
+
+
System Info
+
+ {#if showPackageAnalysisInfo}
+
+ {/if}
+
+
+ {#each shortKeywords as keyword}
+
+ {keyword}
+
+ {/each}
+
+{/if}
diff --git a/src/lib/components/Navbar.svelte b/src/lib/components/Navbar.svelte
new file mode 100644
index 00000000..62c67b57
--- /dev/null
+++ b/src/lib/components/Navbar.svelte
@@ -0,0 +1,20 @@
+
+
+
diff --git a/src/lib/components/PackageInfoBundlephobia.svelte b/src/lib/components/PackageInfoBundlephobia.svelte
new file mode 100644
index 00000000..25324a19
--- /dev/null
+++ b/src/lib/components/PackageInfoBundlephobia.svelte
@@ -0,0 +1,16 @@
+
+
+
+ Bundlephobia
+
diff --git a/src/lib/components/PackageInfoDependencies.svelte b/src/lib/components/PackageInfoDependencies.svelte
new file mode 100644
index 00000000..715fff28
--- /dev/null
+++ b/src/lib/components/PackageInfoDependencies.svelte
@@ -0,0 +1,19 @@
+
+
+
+ {dependenciesDescription}
+
diff --git a/src/lib/components/PackageInfoHomepage.svelte b/src/lib/components/PackageInfoHomepage.svelte
new file mode 100644
index 00000000..fded1213
--- /dev/null
+++ b/src/lib/components/PackageInfoHomepage.svelte
@@ -0,0 +1,22 @@
+
+
+{#if url}
+
+ {prettyHomepage}
+
+{/if}
diff --git a/src/lib/components/PackageInfoLicense.svelte b/src/lib/components/PackageInfoLicense.svelte
new file mode 100644
index 00000000..d22941e6
--- /dev/null
+++ b/src/lib/components/PackageInfoLicense.svelte
@@ -0,0 +1,16 @@
+
+
+
+ {licenseDescription}
+
diff --git a/src/lib/components/PackageInfoNpm.svelte b/src/lib/components/PackageInfoNpm.svelte
new file mode 100644
index 00000000..61eb4794
--- /dev/null
+++ b/src/lib/components/PackageInfoNpm.svelte
@@ -0,0 +1,16 @@
+
+
+
+ {name}
+
diff --git a/src/lib/components/PackageInfoPublishedAt.svelte b/src/lib/components/PackageInfoPublishedAt.svelte
new file mode 100644
index 00000000..c4d53962
--- /dev/null
+++ b/src/lib/components/PackageInfoPublishedAt.svelte
@@ -0,0 +1,24 @@
+
+
+
+ Published {prettyPublishedAt}
+
diff --git a/src/lib/components/PackageInfoRepository.svelte b/src/lib/components/PackageInfoRepository.svelte
new file mode 100644
index 00000000..0745e145
--- /dev/null
+++ b/src/lib/components/PackageInfoRepository.svelte
@@ -0,0 +1,35 @@
+
+
+{#if url}
+
+ {#if url.hostname === 'github.com'}
+ {repositoryName}
+
+{/if}
diff --git a/src/lib/components/PackageInfoRunKit.svelte b/src/lib/components/PackageInfoRunKit.svelte
new file mode 100644
index 00000000..ef38980f
--- /dev/null
+++ b/src/lib/components/PackageInfoRunKit.svelte
@@ -0,0 +1,16 @@
+
+
+
+ RunKit
+
diff --git a/src/lib/components/PackageInfoUnpackedSize.svelte b/src/lib/components/PackageInfoUnpackedSize.svelte
new file mode 100644
index 00000000..f1a12184
--- /dev/null
+++ b/src/lib/components/PackageInfoUnpackedSize.svelte
@@ -0,0 +1,22 @@
+
+
+{#if unpackedSize !== undefined}
+
+ {prettySize} unpacked size
+
+{/if}
diff --git a/src/lib/components/PackageInfoUnpkg.svelte b/src/lib/components/PackageInfoUnpkg.svelte
new file mode 100644
index 00000000..24c0b6d1
--- /dev/null
+++ b/src/lib/components/PackageInfoUnpkg.svelte
@@ -0,0 +1,16 @@
+
+
+
+ Unpkg
+
diff --git a/src/lib/components/PackageInfoVersion.svelte b/src/lib/components/PackageInfoVersion.svelte
new file mode 100644
index 00000000..4c683439
--- /dev/null
+++ b/src/lib/components/PackageInfoVersion.svelte
@@ -0,0 +1,16 @@
+
+
+
+ Version {version}
+
diff --git a/src/lib/components/PackageInfoWeeklyDownloads.svelte b/src/lib/components/PackageInfoWeeklyDownloads.svelte
new file mode 100644
index 00000000..0d6b1c94
--- /dev/null
+++ b/src/lib/components/PackageInfoWeeklyDownloads.svelte
@@ -0,0 +1,19 @@
+
+
+{#if weeklyDownloads !== undefined}
+
+ {prettyWeeklyDownloads} weekly downloads
+
+{/if}
diff --git a/src/lib/components/Pill.svelte b/src/lib/components/Pill.svelte
new file mode 100644
index 00000000..913ada30
--- /dev/null
+++ b/src/lib/components/Pill.svelte
@@ -0,0 +1 @@
+
diff --git a/src/lib/components/PoweredByVercelLinkButton.svelte b/src/lib/components/PoweredByVercelLinkButton.svelte
new file mode 100644
index 00000000..5f5efa78
--- /dev/null
+++ b/src/lib/components/PoweredByVercelLinkButton.svelte
@@ -0,0 +1,11 @@
+
+
+
+
diff --git a/src/lib/components/PrivacyLinkButton.svelte b/src/lib/components/PrivacyLinkButton.svelte
new file mode 100644
index 00000000..ec677032
--- /dev/null
+++ b/src/lib/components/PrivacyLinkButton.svelte
@@ -0,0 +1,8 @@
+
+
+
+
diff --git a/src/lib/components/QuickSearch.svelte b/src/lib/components/QuickSearch.svelte
new file mode 100644
index 00000000..3d9d6fa1
--- /dev/null
+++ b/src/lib/components/QuickSearch.svelte
@@ -0,0 +1,31 @@
+
+
+
+
+
diff --git a/src/lib/components/QuickSearchBackdrop.svelte b/src/lib/components/QuickSearchBackdrop.svelte
new file mode 100644
index 00000000..a067643b
--- /dev/null
+++ b/src/lib/components/QuickSearchBackdrop.svelte
@@ -0,0 +1,3 @@
+
diff --git a/src/lib/components/QuickSearchButton.svelte b/src/lib/components/QuickSearchButton.svelte
new file mode 100644
index 00000000..b10d7cdb
--- /dev/null
+++ b/src/lib/components/QuickSearchButton.svelte
@@ -0,0 +1,26 @@
+
+
+
+
+
+ F
+
diff --git a/src/lib/components/QuickSearchHeader.svelte b/src/lib/components/QuickSearchHeader.svelte
new file mode 100644
index 00000000..9941dd7b
--- /dev/null
+++ b/src/lib/components/QuickSearchHeader.svelte
@@ -0,0 +1,22 @@
+
+
+
+
Quick Search
+
+
+
+
diff --git a/src/lib/components/QuickSearchInput.svelte b/src/lib/components/QuickSearchInput.svelte
new file mode 100644
index 00000000..043bd6d7
--- /dev/null
+++ b/src/lib/components/QuickSearchInput.svelte
@@ -0,0 +1,16 @@
+
+
+Search for symbols in this package
+
+
+Search npm packages. Press Ctrl and K to focus.
+
diff --git a/src/lib/components/SearchResult.svelte b/src/lib/components/SearchResult.svelte
new file mode 100644
index 00000000..eedf6011
--- /dev/null
+++ b/src/lib/components/SearchResult.svelte
@@ -0,0 +1,17 @@
+
+
+
+
diff --git a/src/lib/components/SearchResultDescription.svelte b/src/lib/components/SearchResultDescription.svelte
new file mode 100644
index 00000000..49498b57
--- /dev/null
+++ b/src/lib/components/SearchResultDescription.svelte
@@ -0,0 +1,7 @@
+
+
+{#if description}
+ {description}
+{/if}
diff --git a/src/lib/components/SearchResultTitle.svelte b/src/lib/components/SearchResultTitle.svelte
new file mode 100644
index 00000000..44fc61e1
--- /dev/null
+++ b/src/lib/components/SearchResultTitle.svelte
@@ -0,0 +1,17 @@
+
+
+
+
+ {name}
+
+
{version}
+ {#if name === query}
+
Exact match
+ {/if}
+
+
+ {#if packages.length > 0}
+ {#each packages as pkg}
+
+
+ {/each}
+ {:else}
+
No packages found
+
+ {/if}
+
+ Tip: Try with packages like
+ {packages[0]} ,
+ {packages[1]} or
+ {packages[2]}
+
diff --git a/src/lib/components/SponsorLinkButton.svelte b/src/lib/components/SponsorLinkButton.svelte
new file mode 100644
index 00000000..e00ade40
--- /dev/null
+++ b/src/lib/components/SponsorLinkButton.svelte
@@ -0,0 +1,8 @@
+
+
+
+
diff --git a/src/lib/components/SystemInfoBugReport.svelte b/src/lib/components/SystemInfoBugReport.svelte
new file mode 100644
index 00000000..d12943ef
--- /dev/null
+++ b/src/lib/components/SystemInfoBugReport.svelte
@@ -0,0 +1,17 @@
+
+
+
+ Report a bug with this package
+
diff --git a/src/lib/components/SystemInfoPackageAnalysis.svelte b/src/lib/components/SystemInfoPackageAnalysis.svelte
new file mode 100644
index 00000000..be0a6e6c
--- /dev/null
+++ b/src/lib/components/SystemInfoPackageAnalysis.svelte
@@ -0,0 +1,28 @@
+
+
+
+ Analyzed {prettyAnalyzedAt} in {prettyAnalysisDuration}
+
diff --git a/src/lib/components/SystemInfoUpdatedAt.svelte b/src/lib/components/SystemInfoUpdatedAt.svelte
new file mode 100644
index 00000000..e0332cab
--- /dev/null
+++ b/src/lib/components/SystemInfoUpdatedAt.svelte
@@ -0,0 +1,24 @@
+
+
+
+ Updated {prettyUpdatedAt}
+
diff --git a/src/lib/components/ThemeButton.svelte b/src/lib/components/ThemeButton.svelte
new file mode 100644
index 00000000..78029d79
--- /dev/null
+++ b/src/lib/components/ThemeButton.svelte
@@ -0,0 +1,18 @@
+
+
+
+
diff --git a/src/lib/components/TocDeclarations.svelte b/src/lib/components/TocDeclarations.svelte
new file mode 100644
index 00000000..6b41df67
--- /dev/null
+++ b/src/lib/components/TocDeclarations.svelte
@@ -0,0 +1,91 @@
+
+
+
+ {#if variables.length > 0}
+
Variables
+
+ {#each variables as { id, name }}
+
+ {name}
+
+ {/each}
+ {/if}
+
+ {#if functions.length > 0}
+
Functions
+ {#each functions as { id, name }}
+
+ {name}
+
+ {/each}
+ {/if}
+
+ {#if classes.length > 0}
+
Classes
+ {#each classes as { id, name }}
+
+ {name}
+
+ {/each}
+ {/if}
+
+ {#if interfaces.length > 0}
+
Interfaces
+ {#each interfaces as { id, name }}
+
+ {name}
+
+ {/each}
+ {/if}
+
+ {#if typeAliases.length > 0}
+
Type Aliases
+ {#each typeAliases as { id, name }}
+
+ {name}
+
+ {/each}
+ {/if}
+
+ {#if namespaces.length > 0}
+
Namespaces
+ {#each namespaces as { id, name }}
+
+ {name}
+
+ {/each}
+ {/if}
+
+
diff --git a/src/lib/registry/fetch-manifest.ts b/src/lib/registry/fetch-manifest.ts
new file mode 100644
index 00000000..26ea27af
--- /dev/null
+++ b/src/lib/registry/fetch-manifest.ts
@@ -0,0 +1,16 @@
+import { fetchPackument } from '$lib/registry/fetch-packument';
+import type { Manifest } from '$lib/registry/manifest';
+
+export const fetchManifest = async (
+ fetch: typeof window.fetch,
+ name: string,
+ version = 'latest'
+): Promise => {
+ const packument = await fetchPackument(fetch, name);
+ const semver = packument['dist-tags'][version] ?? version;
+ const manifest = packument.versions[semver];
+ if (!manifest) {
+ throw new Error(`fetchManifest: manifest not found for ${name}@${semver}`);
+ }
+ return manifest;
+};
diff --git a/src/lib/registry/fetch-package-dependencies.ts b/src/lib/registry/fetch-package-dependencies.ts
new file mode 100644
index 00000000..a97638b4
--- /dev/null
+++ b/src/lib/registry/fetch-package-dependencies.ts
@@ -0,0 +1,20 @@
+import { fetchManifest } from '$lib/registry/fetch-manifest';
+import { manifestSchema } from '$lib/registry/manifest';
+import type { z } from 'zod';
+
+const packageDependenciesSchema = manifestSchema.pick({
+ dependencies: true,
+ devDependencies: true,
+ peerDependencies: true
+});
+
+export type PackageDependencies = z.infer;
+
+export const fetchPackageDependencies = async (
+ fetch: typeof window.fetch,
+ name: string,
+ version = 'latest'
+): Promise => {
+ const manifest = await fetchManifest(fetch, name, version);
+ return packageDependenciesSchema.parse(manifest);
+};
diff --git a/src/lib/registry/fetch-package-versions.ts b/src/lib/registry/fetch-package-versions.ts
new file mode 100644
index 00000000..e4393cfa
--- /dev/null
+++ b/src/lib/registry/fetch-package-versions.ts
@@ -0,0 +1,27 @@
+import { fetchPackument } from '$lib/registry/fetch-packument';
+import { packumentSchema } from '$lib/registry/packument';
+import type { z } from 'zod';
+
+const packageVersionsSchema = packumentSchema
+ .pick({
+ 'dist-tags': true,
+ time: true
+ })
+ .transform((obj) => {
+ // eslint-disable-next-line @typescript-eslint/no-unused-vars
+ const { created, modified, ...history } = obj.time;
+ return {
+ tags: obj['dist-tags'],
+ history: history
+ };
+ });
+
+export type PackageVersions = z.infer;
+
+export const fetchPackageVersions = async (
+ fetch: typeof window.fetch,
+ name: string
+): Promise => {
+ const packument = await fetchPackument(fetch, name);
+ return packageVersionsSchema.parse(packument);
+};
diff --git a/src/lib/registry/fetch-package-weekly-downloads.ts b/src/lib/registry/fetch-package-weekly-downloads.ts
new file mode 100644
index 00000000..89cdb5ee
--- /dev/null
+++ b/src/lib/registry/fetch-package-weekly-downloads.ts
@@ -0,0 +1,36 @@
+import { REGISTRY_CACHE_TTL, REGISTRY_DOWNLOADS_API_URL } from '$env/static/private';
+import { isValidPackageName } from '$lib/registry/is-valid-package-name';
+import {
+ packageDownloadsTotalSchema,
+ type PackageDownloadsTotal
+} from '$lib/registry/package-downloads-total';
+import Keyv from 'keyv';
+import urlJoin from 'url-join';
+
+const registryDownloadsApiUrl = REGISTRY_DOWNLOADS_API_URL;
+
+const cache = new Keyv({ namespace: 'package_downloads_total' });
+const ttl = parseInt(REGISTRY_CACHE_TTL, 10);
+
+export const fetchPackageWeeklyDownloads = async (
+ fetch: typeof window.fetch,
+ name: string
+): Promise => {
+ if (!isValidPackageName(name)) {
+ throw new Error(`fetchPackageWeeklyDownloads: invalid package name: ${name}`);
+ }
+ const cachedPackageDownloadsTotal = await cache.get(name);
+ if (cachedPackageDownloadsTotal) {
+ return cachedPackageDownloadsTotal;
+ }
+ const response = await fetch(urlJoin(registryDownloadsApiUrl, 'last-week', name));
+ if (!response.ok) {
+ throw new Error(
+ `fetchPackageWeeklyDownloads: cannot fetch downloads for package ${name}: ${response.statusText}`
+ );
+ }
+ const data = await response.json();
+ const packageDownloadsTotal = packageDownloadsTotalSchema.parse(data);
+ await cache.set(name, packageDownloadsTotal, ttl);
+ return packageDownloadsTotal;
+};
diff --git a/src/lib/registry/fetch-packument.ts b/src/lib/registry/fetch-packument.ts
new file mode 100644
index 00000000..27309ff4
--- /dev/null
+++ b/src/lib/registry/fetch-packument.ts
@@ -0,0 +1,31 @@
+import { REGISTRY_API_URL, REGISTRY_CACHE_TTL } from '$env/static/private';
+import { isValidPackageName } from '$lib/registry/is-valid-package-name';
+import { packumentSchema, type Packument } from '$lib/registry/packument';
+import Keyv from 'keyv';
+import urlJoin from 'url-join';
+
+const registryApiUrl = REGISTRY_API_URL;
+
+const cache = new Keyv({ namespace: 'package_packument' });
+const ttl = parseInt(REGISTRY_CACHE_TTL, 10);
+
+export const fetchPackument = async (
+ fetch: typeof window.fetch,
+ name: string
+): Promise => {
+ if (!isValidPackageName(name)) {
+ throw new Error(`fetchPackument: invalid package name: ${name}`);
+ }
+ const cachedPackument = await cache.get(name);
+ if (cachedPackument) {
+ return cachedPackument;
+ }
+ const response = await fetch(urlJoin(registryApiUrl, name));
+ if (!response.ok) {
+ throw new Error(`fetchPackument: cannot fetch package ${name}: ${response.statusText}`);
+ }
+ const data = await response.json();
+ const packument = packumentSchema.parse(data);
+ await cache.set(name, packument, ttl);
+ return packument;
+};
diff --git a/src/lib/registry/is-valid-package-name.ts b/src/lib/registry/is-valid-package-name.ts
new file mode 100644
index 00000000..31b96a3f
--- /dev/null
+++ b/src/lib/registry/is-valid-package-name.ts
@@ -0,0 +1,5 @@
+import validate from 'validate-npm-package-name';
+
+export const isValidPackageName = (name: string): boolean => {
+ return validate(name).validForNewPackages;
+};
diff --git a/src/lib/registry/manifest.ts b/src/lib/registry/manifest.ts
new file mode 100644
index 00000000..5a5576ff
--- /dev/null
+++ b/src/lib/registry/manifest.ts
@@ -0,0 +1,16 @@
+import { z } from 'zod';
+
+export const manifestSchema = z.object({
+ name: z.string(),
+ version: z.string(),
+ description: z.string().optional(),
+ license: z.string().optional(),
+ types: z.string().optional(),
+ typings: z.string().optional(),
+ dependencies: z.record(z.string()).catch({}),
+ dist: z.object({
+ unpackedSize: z.number().optional()
+ })
+});
+
+export type Manifest = z.infer;
diff --git a/src/lib/registry/package-downloads-total.ts b/src/lib/registry/package-downloads-total.ts
new file mode 100644
index 00000000..fafbed2c
--- /dev/null
+++ b/src/lib/registry/package-downloads-total.ts
@@ -0,0 +1,19 @@
+import { z } from 'zod';
+
+export const packageDownloadsTotalSchema = z.object({
+ /** Total number of downloads. */
+ downloads: z.number(),
+ /** Download period start date (inclusive). */
+ start: z.string(),
+ /** Download period end date (inclusive). */
+ end: z.string(),
+ /** Package name. */
+ package: z.string()
+});
+
+/**
+ * `PackageDownloadsTotal` contains the total number of downloads from the registry for a package for a given period.
+ *
+ * @see {@link https://github.com/npm/registry/blob/master/docs/download-counts.md#point-values}
+ */
+export type PackageDownloadsTotal = z.infer;
diff --git a/src/lib/registry/packument.ts b/src/lib/registry/packument.ts
new file mode 100644
index 00000000..cba44463
--- /dev/null
+++ b/src/lib/registry/packument.ts
@@ -0,0 +1,20 @@
+import { manifestSchema } from '$lib/registry/manifest';
+import { z } from 'zod';
+
+export const packumentSchema = z.object({
+ name: z.string(),
+ 'dist-tags': z
+ .object({
+ latest: z.string()
+ })
+ .catchall(z.string()),
+ time: z
+ .object({
+ created: z.string(),
+ modified: z.string()
+ })
+ .catchall(z.string()),
+ versions: z.record(manifestSchema)
+});
+
+export type Packument = z.infer;
diff --git a/src/lib/registry/search-packages.ts b/src/lib/registry/search-packages.ts
new file mode 100644
index 00000000..bcae898f
--- /dev/null
+++ b/src/lib/registry/search-packages.ts
@@ -0,0 +1,44 @@
+import { PUBLIC_REGISTRY_SEARCH_API_URL } from '$env/static/public';
+import { isValidPackageName } from '$lib/registry/is-valid-package-name';
+
+import { z } from 'zod';
+
+const endpoint = PUBLIC_REGISTRY_SEARCH_API_URL;
+
+const packageResultSchema = z.object({
+ name: z.string(),
+ version: z.string(),
+ description: z.string().catch(''),
+ keywords: z.array(z.string()).catch([]),
+ links: z.object({
+ npm: z.string().optional(),
+ homepage: z.string().optional(),
+ repository: z.string().optional()
+ })
+});
+
+export type PackageResult = z.infer;
+
+const schema = z.object({
+ objects: z.array(
+ z.object({
+ package: packageResultSchema
+ })
+ )
+});
+
+export const searchPackages = async (
+ fetch: typeof window.fetch,
+ query: string,
+ size = 20
+): Promise => {
+ if (!query) {
+ return [];
+ }
+ const response = await fetch(`${endpoint}?text=${query}&size=${size}`);
+ const data = await response.json();
+ return schema
+ .parse(data)
+ .objects.map((obj) => obj.package)
+ .filter((pkg) => isValidPackageName(pkg.name));
+};
diff --git a/src/lib/stores/package-api.ts b/src/lib/stores/package-api.ts
new file mode 100644
index 00000000..cb900049
--- /dev/null
+++ b/src/lib/stores/package-api.ts
@@ -0,0 +1,38 @@
+import { getContext, hasContext, setContext } from 'svelte';
+import { writable, type Writable } from 'svelte/store';
+import { z } from 'zod';
+
+const packageApiKey = Symbol();
+
+const packageApiSchema = z.object({
+ overview: z.string().optional(),
+ declarations: z.array(
+ z.object({
+ id: z.string(),
+ kind: z.enum(['variable', 'function', 'class', 'interface', 'enum', 'type', 'namespace']),
+ name: z.string()
+ })
+ ),
+ analyzedAt: z.string(),
+ analysisDuration: z.number()
+});
+
+export type PackageApi = z.infer;
+
+export const setPackageApi = () => {
+ const { subscribe, set } = writable();
+ setContext(packageApiKey, {
+ subscribe,
+ set(value: unknown) {
+ set(packageApiSchema.parse(value));
+ }
+ });
+};
+
+export const getPackageApi = (): Writable => {
+ return getContext(packageApiKey);
+};
+
+export const hasPackageApi = (): boolean => {
+ return hasContext(packageApiKey);
+};
diff --git a/src/lib/stores/package-info.ts b/src/lib/stores/package-info.ts
new file mode 100644
index 00000000..601982ba
--- /dev/null
+++ b/src/lib/stores/package-info.ts
@@ -0,0 +1,33 @@
+import { getContext, setContext } from 'svelte';
+import { writable, type Writable } from 'svelte/store';
+import { z } from 'zod';
+
+const packageInfoKey = Symbol();
+
+const packageInfoSchema = z.object({
+ name: z.string(),
+ version: z.string(),
+ repository: z.string().optional(),
+ publishedAt: z.string(),
+ homepage: z.string().optional(),
+ license: z.string().optional(),
+ dependencies: z.record(z.string()),
+ weeklyDownloads: z.number().optional(),
+ unpackedSize: z.number().optional()
+});
+
+export type PackageInfo = z.infer;
+
+export const setPackageInfo = () => {
+ const { subscribe, set } = writable();
+ setContext(packageInfoKey, {
+ subscribe,
+ set(value: unknown) {
+ set(packageInfoSchema.parse(value));
+ }
+ });
+};
+
+export const getPackageInfo = (): Writable => {
+ return getContext(packageInfoKey);
+};
diff --git a/src/lib/stores/page-info.ts b/src/lib/stores/page-info.ts
new file mode 100644
index 00000000..aab41fc0
--- /dev/null
+++ b/src/lib/stores/page-info.ts
@@ -0,0 +1,25 @@
+import { getContext, setContext } from 'svelte';
+import { writable, type Writable } from 'svelte/store';
+import { z } from 'zod';
+
+const pageInfoKey = Symbol();
+
+const pageInfoSchema = z.object({
+ updatedAt: z.string()
+});
+
+export type PageInfo = z.infer;
+
+export const setPageInfo = () => {
+ const { subscribe, set } = writable();
+ setContext(pageInfoKey, {
+ subscribe,
+ set(value: unknown) {
+ set(pageInfoSchema.parse(value));
+ }
+ });
+};
+
+export const getPageInfo = (): Writable => {
+ return getContext(pageInfoKey);
+};
diff --git a/src/lib/stores/quick-search.ts b/src/lib/stores/quick-search.ts
new file mode 100644
index 00000000..dc164b58
--- /dev/null
+++ b/src/lib/stores/quick-search.ts
@@ -0,0 +1,26 @@
+import { getContext, setContext } from 'svelte';
+import { writable, type Writable } from 'svelte/store';
+
+const quickSearchDialogKey = Symbol();
+const quickSearchQueryKey = Symbol();
+
+export const setQuickSearchDialog = () => {
+ setContext(quickSearchDialogKey, writable(undefined));
+};
+
+export const getQuickSearchDialog = (): Writable => {
+ return getContext(quickSearchDialogKey);
+};
+
+export const setQuickSearchQuery = () => {
+ setContext(quickSearchQueryKey, writable(''));
+};
+
+export const getQuickSearchQuery = (): Writable => {
+ return getContext(quickSearchQueryKey);
+};
+
+export const setQuickSearchStores = () => {
+ setQuickSearchDialog();
+ setQuickSearchQuery();
+};
diff --git a/src/lib/temp/mock-declarations.ts b/src/lib/temp/mock-declarations.ts
new file mode 100644
index 00000000..47497909
--- /dev/null
+++ b/src/lib/temp/mock-declarations.ts
@@ -0,0 +1,87 @@
+export const mockDeclarations = [
+ {
+ id: 'analyzeRegistryPackage',
+ kind: 'function',
+ name: 'analyzeRegistryPackage'
+ },
+ {
+ id: 'isClassConstructorDeclaration',
+ kind: 'function',
+ name: 'isClassConstructorDeclaration'
+ },
+ {
+ id: 'isClassDeclaration',
+ kind: 'function',
+ name: 'isClassDeclaration'
+ },
+ {
+ id: 'isClassMethodDeclaration',
+ kind: 'function',
+ name: 'isClassMethodDeclaration'
+ },
+ {
+ id: 'isClassPropertyDeclaration',
+ kind: 'function',
+ name: 'isClassPropertyDeclaration'
+ },
+ {
+ id: 'isEnumDeclaration',
+ kind: 'function',
+ name: 'isEnumDeclaration'
+ },
+ {
+ id: 'isEnumMemberDeclaration',
+ kind: 'function',
+ name: 'isEnumMemberDeclaration'
+ },
+ {
+ id: 'isFunctionDeclaration',
+ kind: 'function',
+ name: 'isFunctionDeclaration'
+ },
+ {
+ id: 'isInterfaceCallSignatureDeclaration',
+ kind: 'function',
+ name: 'isInterfaceCallSignatureDeclaration'
+ },
+ {
+ id: 'isInterfaceConstructSignatureDeclaration',
+ kind: 'function',
+ name: 'isInterfaceConstructSignatureDeclaration'
+ },
+ {
+ id: 'isInterfaceDeclaration',
+ kind: 'function',
+ name: 'isInterfaceDeclaration'
+ },
+ {
+ id: 'isInterfaceIndexSignatureDeclaration',
+ kind: 'function',
+ name: 'isInterfaceIndexSignatureDeclaration'
+ },
+ {
+ id: 'isInterfaceMethodDeclaration',
+ kind: 'function',
+ name: 'isInterfaceMethodDeclaration'
+ },
+ {
+ id: 'isInterfacePropertyDeclaration',
+ kind: 'function',
+ name: 'isInterfacePropertyDeclaration'
+ },
+ {
+ id: 'isNamespaceDeclaration',
+ kind: 'function',
+ name: 'isNamespaceDeclaration'
+ },
+ {
+ id: 'isTypeAliasDeclaration',
+ kind: 'function',
+ name: 'isTypeAliasDeclaration'
+ },
+ {
+ id: 'isVariableDeclaration',
+ kind: 'function',
+ name: 'isVariableDeclaration'
+ }
+];
diff --git a/src/lib/utils/mod.ts b/src/lib/utils/mod.ts
new file mode 100644
index 00000000..01e045f8
--- /dev/null
+++ b/src/lib/utils/mod.ts
@@ -0,0 +1,3 @@
+export const mod = (a: number, b: number): number => {
+ return ((a % b) + b) % b;
+};
diff --git a/src/lib/utils/url-can-parse.ts b/src/lib/utils/url-can-parse.ts
new file mode 100644
index 00000000..b1a5c1c4
--- /dev/null
+++ b/src/lib/utils/url-can-parse.ts
@@ -0,0 +1,10 @@
+// TODO: replace with URL.canParse when supported by all browsers.
+// See: https://developer.mozilla.org/en-US/docs/Web/API/URL/canParse_static#browser_compatibility.
+export const urlCanParse = (url: string): boolean => {
+ try {
+ new URL(url);
+ return true;
+ } catch {
+ return false;
+ }
+};
diff --git a/src/params/name.ts b/src/params/name.ts
new file mode 100644
index 00000000..bf6ac677
--- /dev/null
+++ b/src/params/name.ts
@@ -0,0 +1,8 @@
+import { isValidPackageName } from '$lib/registry/is-valid-package-name';
+import type { ParamMatcher } from '@sveltejs/kit';
+
+export const match: ParamMatcher = (param) => {
+ // Remove trailing slash if present and validate package name.
+ const name = param.replace(/\/$/, '');
+ return isValidPackageName(name);
+};
diff --git a/src/params/version.ts b/src/params/version.ts
new file mode 100644
index 00000000..afcd27d5
--- /dev/null
+++ b/src/params/version.ts
@@ -0,0 +1,8 @@
+import type { ParamMatcher } from '@sveltejs/kit';
+import validate from 'semver/functions/valid';
+
+export const match: ParamMatcher = (param) => {
+ // Validate semver version.
+ const version = validate(param);
+ return version !== null;
+};
diff --git a/src/routes/+layout.svelte b/src/routes/+layout.svelte
new file mode 100644
index 00000000..cad2b67f
--- /dev/null
+++ b/src/routes/+layout.svelte
@@ -0,0 +1,20 @@
+
+
+About
diff --git a/src/routes/credits/+page.svelte b/src/routes/credits/+page.svelte
new file mode 100644
index 00000000..3d3ede65
--- /dev/null
+++ b/src/routes/credits/+page.svelte
@@ -0,0 +1 @@
+Credits
diff --git a/src/routes/faq/+page.svelte b/src/routes/faq/+page.svelte
new file mode 100644
index 00000000..fee9fa9a
--- /dev/null
+++ b/src/routes/faq/+page.svelte
@@ -0,0 +1 @@
+FAQ
diff --git a/src/routes/package/[...name=name]/+layout.server.ts b/src/routes/package/[...name=name]/+layout.server.ts
new file mode 100644
index 00000000..4a23e0ed
--- /dev/null
+++ b/src/routes/package/[...name=name]/+layout.server.ts
@@ -0,0 +1,51 @@
+import { fetchManifest } from '$lib/registry/fetch-manifest';
+import { fetchPackageWeeklyDownloads } from '$lib/registry/fetch-package-weekly-downloads';
+import { fetchPackument } from '$lib/registry/fetch-packument';
+import type { Manifest } from '$lib/registry/manifest';
+import type { PackageDownloadsTotal } from '$lib/registry/package-downloads-total';
+import type { Packument } from '$lib/registry/packument';
+import { searchPackages, type PackageResult } from '$lib/registry/search-packages';
+import { error } from '@sveltejs/kit';
+import type { LayoutServerLoad } from './$types';
+
+export const load = (async ({ fetch, params }) => {
+ const { name } = params;
+
+ let packument: Packument;
+ let manifest: Manifest;
+ try {
+ packument = await fetchPackument(fetch, name);
+ manifest = await fetchManifest(fetch, name);
+ } catch (err) {
+ console.error(`package layout load: no packument for ${name}: ${err}`);
+ throw error(404, { message: 'Package not found' });
+ }
+
+ let packageResult: PackageResult | undefined;
+ try {
+ const foundPackages = await searchPackages(fetch, manifest.name, 1);
+ packageResult = foundPackages.find((pkg) => pkg.name === manifest.name);
+ } catch (err) {
+ console.error(`package layout load: no search results for ${name}: ${err}`);
+ }
+
+ let packageDownloads: PackageDownloadsTotal | undefined;
+ try {
+ packageDownloads = await fetchPackageWeeklyDownloads(fetch, manifest.name);
+ } catch (err) {
+ console.error(`package layout load: no downloads for ${name}: ${err}`);
+ }
+
+ return {
+ name: manifest.name,
+ version: manifest.version,
+ repository: packageResult?.links.repository,
+ homepage: packageResult?.links.homepage,
+ publishedAt: packument.time[manifest.version]!,
+ license: manifest.license,
+ dependencies: manifest.dependencies,
+ weeklyDownloads: packageDownloads?.downloads,
+ unpackedSize: manifest.dist.unpackedSize,
+ updatedAt: new Date().toISOString()
+ };
+}) satisfies LayoutServerLoad;
diff --git a/src/routes/package/[...name=name]/+layout.svelte b/src/routes/package/[...name=name]/+layout.svelte
new file mode 100644
index 00000000..e477bbab
--- /dev/null
+++ b/src/routes/package/[...name=name]/+layout.svelte
@@ -0,0 +1,17 @@
+
+
+Privacy
diff --git a/src/routes/search/+page.svelte b/src/routes/search/+page.svelte
new file mode 100644
index 00000000..65855c06
--- /dev/null
+++ b/src/routes/search/+page.svelte
@@ -0,0 +1,14 @@
+
+
+
+
diff --git a/src/routes/search/+page.ts b/src/routes/search/+page.ts
new file mode 100644
index 00000000..f412a79b
--- /dev/null
+++ b/src/routes/search/+page.ts
@@ -0,0 +1,11 @@
+import { searchPackages } from '$lib/registry/search-packages';
+import type { PageLoad } from './$types';
+
+export const ssr = false;
+
+export const load = (async ({ fetch, url }) => {
+ const q = url.searchParams.get('q') ?? '';
+ const query = q.trim();
+ const packages = await searchPackages(fetch, query);
+ return { query, packages };
+}) satisfies PageLoad;
diff --git a/src/routes/sponsor/+page.svelte b/src/routes/sponsor/+page.svelte
new file mode 100644
index 00000000..fd55d906
--- /dev/null
+++ b/src/routes/sponsor/+page.svelte
@@ -0,0 +1 @@
+Sponsor
diff --git a/static/favicon.png b/static/favicon.png
new file mode 100644
index 00000000..825b9e65
Binary files /dev/null and b/static/favicon.png differ
diff --git a/svelte.config.js b/svelte.config.js
new file mode 100644
index 00000000..1cf26a00
--- /dev/null
+++ b/svelte.config.js
@@ -0,0 +1,18 @@
+import adapter from '@sveltejs/adapter-auto';
+import { vitePreprocess } from '@sveltejs/kit/vite';
+
+/** @type {import('@sveltejs/kit').Config} */
+const config = {
+ // Consult https://kit.svelte.dev/docs/integrations#preprocessors
+ // for more information about preprocessors
+ preprocess: vitePreprocess(),
+
+ kit: {
+ // adapter-auto only supports some environments, see https://kit.svelte.dev/docs/adapter-auto for a list.
+ // If your environment is not supported or you settled on a specific environment, switch out the adapter.
+ // See https://kit.svelte.dev/docs/adapters for more information about adapters.
+ adapter: adapter()
+ }
+};
+
+export default config;
diff --git a/tailwind.config.js b/tailwind.config.js
index 424002f3..3d415808 100644
--- a/tailwind.config.js
+++ b/tailwind.config.js
@@ -1,9 +1,16 @@
/** @type {import('tailwindcss').Config} */
-module.exports = {
- darkMode: "class",
- content: ["src/**/*.tsx"],
- theme: {
- extend: {},
- },
- plugins: [],
+export default {
+ content: ['./src/**/*.{html,js,svelte,ts}'],
+ theme: {
+ extend: {
+ screens: {
+ '3xl': '1600px',
+ '4xl': '1920px'
+ }
+ }
+ },
+ daisyui: {
+ logs: false
+ },
+ plugins: [require('@tailwindcss/typography'), require('daisyui')]
};
diff --git a/tsconfig.json b/tsconfig.json
index 8e2bfda9..09fb3fdc 100644
--- a/tsconfig.json
+++ b/tsconfig.json
@@ -1,25 +1,18 @@
{
- "include": ["next-env.d.ts", "src", "config.ts"],
- "compilerOptions": {
- "target": "es5",
- "module": "esnext",
- "lib": ["dom", "dom.iterable", "esnext"],
- "strict": true,
- "noUnusedLocals": true,
- "noUnusedParameters": true,
- "noImplicitReturns": true,
- "noFallthroughCasesInSwitch": true,
- "noUncheckedIndexedAccess": true,
- "forceConsistentCasingInFileNames": true,
- "noEmit": true,
- "esModuleInterop": true,
- "moduleResolution": "node",
- "resolveJsonModule": true,
- "isolatedModules": true,
- "jsx": "preserve",
- "allowJs": true,
- "skipLibCheck": true,
- "incremental": true
- },
- "exclude": ["node_modules"]
+ "extends": "./.svelte-kit/tsconfig.json",
+ "compilerOptions": {
+ "allowJs": true,
+ "checkJs": true,
+ "esModuleInterop": true,
+ "forceConsistentCasingInFileNames": true,
+ "resolveJsonModule": true,
+ "skipLibCheck": true,
+ "sourceMap": true,
+ "strict": true,
+ "noUncheckedIndexedAccess": true
+ }
+ // Path aliases are handled by https://kit.svelte.dev/docs/configuration#alias
+ //
+ // If you want to overwrite includes/excludes, make sure to copy over the relevant includes/excludes
+ // from the referenced tsconfig.json - TypeScript does not merge them in
}
diff --git a/vite.config.ts b/vite.config.ts
new file mode 100644
index 00000000..a6178fea
--- /dev/null
+++ b/vite.config.ts
@@ -0,0 +1,15 @@
+import { sveltekit } from '@sveltejs/kit/vite';
+import Icons from 'unplugin-icons/vite';
+import { defineConfig } from 'vitest/config';
+
+export default defineConfig({
+ plugins: [
+ sveltekit(),
+ Icons({
+ compiler: 'svelte'
+ })
+ ],
+ test: {
+ include: ['src/**/*.{test,spec}.{js,ts}']
+ }
+});
-
-
-
-