();
718 |
719 | for (const pathObj of pathObjs) {
720 | uniquePaths.set(pathObj.path, pathObj);
721 | }
722 |
723 | return Array.from(uniquePaths.values());
724 | }
725 |
726 | /**
727 | * Converts the user-provided `additionalPaths` into `PathObj[]` type, ensuring each path starts
728 | * with a forward slash and each PathObj contains default changefreq and priority.
729 | *
730 | * - `additionalPaths` are never translated based on the lang config because they could be something
731 | * like a PDF within the user's static dir.
732 | *
733 | * @private
734 | */
735 | export function generateAdditionalPaths({
736 | additionalPaths,
737 | defaultChangefreq,
738 | defaultPriority,
739 | }: {
740 | additionalPaths: string[];
741 | defaultChangefreq: SitemapConfig['defaultChangefreq'];
742 | defaultPriority: SitemapConfig['defaultPriority'];
743 | }): PathObj[] {
744 | const defaults = {
745 | changefreq: defaultChangefreq,
746 | lastmod: undefined,
747 | priority: defaultPriority,
748 | };
749 |
750 | return additionalPaths.map((path) => ({
751 | ...defaults,
752 | path: path.startsWith('/') ? path : `/${path}`,
753 | }));
754 | }
755 |
--------------------------------------------------------------------------------
/src/lib/test.js:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/jasongitmail/super-sitemap/ca6a9363a4af62e467afb70d5fb1e0b3b4fa70f5/src/lib/test.js
--------------------------------------------------------------------------------
/src/params/integer.ts:
--------------------------------------------------------------------------------
1 | import type { ParamMatcher } from '@sveltejs/kit';
2 |
3 | // Returns true if 0 or greater.
4 | export const match: ParamMatcher = (param) => {
5 | return /^\d+$/.test(param);
6 | };
7 |
--------------------------------------------------------------------------------
/src/routes/(authenticated)/dashboard/+page.svelte:
--------------------------------------------------------------------------------
1 |
4 |
5 | Dashboard
6 |
--------------------------------------------------------------------------------
/src/routes/(authenticated)/dashboard/+page.ts:
--------------------------------------------------------------------------------
1 | export async function load() {
2 | const meta = {
3 | title: `Dashboard`,
4 | };
5 |
6 | return { meta };
7 | }
8 |
--------------------------------------------------------------------------------
/src/routes/(authenticated)/dashboard/profile/+page.svelte:
--------------------------------------------------------------------------------
1 |
4 |
5 | Dashboard Profile
6 |
--------------------------------------------------------------------------------
/src/routes/(authenticated)/dashboard/profile/+page.ts:
--------------------------------------------------------------------------------
1 | export async function load() {
2 | const meta = {
3 | description: `Profile`,
4 | title: `Profile`,
5 | };
6 |
7 | return { meta };
8 | }
9 |
--------------------------------------------------------------------------------
/src/routes/(public)/[[lang]]/+page.svelte:
--------------------------------------------------------------------------------
1 | Home
2 |
--------------------------------------------------------------------------------
/src/routes/(public)/[[lang]]/+page.ts:
--------------------------------------------------------------------------------
1 | export async function load() {
2 | const meta = {
3 | description: `Foo meta description...`,
4 | title: `Foo`,
5 | };
6 |
7 | return { meta };
8 | }
9 |
--------------------------------------------------------------------------------
/src/routes/(public)/[[lang]]/[foo]/+page.svelte:
--------------------------------------------------------------------------------
1 |
4 |
5 | Foo parameterized route
6 |
7 |
8 | Appears as a general fallback. Exists to test route specificity handling by
9 | `sampled.findFirstMatches()` (an internal function)
10 |
11 |
--------------------------------------------------------------------------------
/src/routes/(public)/[[lang]]/[foo]/+page.ts:
--------------------------------------------------------------------------------
1 | export async function load() {
2 | const meta = {
3 | description: `Foo meta description...`,
4 | title: `Foo`,
5 | };
6 |
7 | return { meta };
8 | }
9 |
--------------------------------------------------------------------------------
/src/routes/(public)/[[lang]]/about/+page.svelte:
--------------------------------------------------------------------------------
1 |
4 |
5 | About
6 |
--------------------------------------------------------------------------------
/src/routes/(public)/[[lang]]/about/+page.ts:
--------------------------------------------------------------------------------
1 | import { sampledPaths, sampledUrls } from '$lib/sampled'; // Import from 'super-sitemap' in your app
2 |
3 | export async function load() {
4 | const meta = {
5 | description: `About this site`,
6 | title: `About`,
7 | };
8 |
9 | console.log('sampledUrls', await sampledUrls('http://localhost:5173/sitemap.xml'));
10 | console.log('sampledPaths', await sampledPaths('http://localhost:5173/sitemap.xml'));
11 |
12 | return { meta };
13 | }
14 |
--------------------------------------------------------------------------------
/src/routes/(public)/[[lang]]/blog/+page.svelte:
--------------------------------------------------------------------------------
1 |
4 |
5 | Blog
6 |
7 | Show first page of blog posts.
8 |
--------------------------------------------------------------------------------
/src/routes/(public)/[[lang]]/blog/+page.ts:
--------------------------------------------------------------------------------
1 | export async function load() {
2 | const meta = {
3 | description: `Blog meta description...`,
4 | title: `Blog`,
5 | };
6 |
7 | return { meta };
8 | }
9 |
--------------------------------------------------------------------------------
/src/routes/(public)/[[lang]]/blog/[page=integer]/+page.svelte:
--------------------------------------------------------------------------------
1 |
5 |
6 | Blog - Page {params.page}
7 |
8 | Show a blog post for {params.slug} or 404.
9 |
--------------------------------------------------------------------------------
/src/routes/(public)/[[lang]]/blog/[page=integer]/+page.ts:
--------------------------------------------------------------------------------
1 | export async function load() {
2 | const meta = {
3 | description: `Login meta description...`,
4 | title: `Login`,
5 | };
6 |
7 | return { meta };
8 | }
9 |
--------------------------------------------------------------------------------
/src/routes/(public)/[[lang]]/blog/[slug]/+page.svelte:
--------------------------------------------------------------------------------
1 |
5 |
6 | A blog post
7 |
8 | Show a blog post for {params.slug} or 404.
9 |
--------------------------------------------------------------------------------
/src/routes/(public)/[[lang]]/blog/[slug]/+page.ts:
--------------------------------------------------------------------------------
1 | export async function load() {
2 | const meta = {
3 | description: `Login meta description...`,
4 | title: `Login`,
5 | };
6 |
7 | return { meta };
8 | }
9 |
--------------------------------------------------------------------------------
/src/routes/(public)/[[lang]]/blog/tag/[tag]/+page.svelte:
--------------------------------------------------------------------------------
1 |
5 |
6 | Posts tagged {params.tag}
7 |
8 | Show posts tagged {params.tag} or 404.
9 |
--------------------------------------------------------------------------------
/src/routes/(public)/[[lang]]/blog/tag/[tag]/+page.ts:
--------------------------------------------------------------------------------
1 | export async function load() {
2 | const meta = {
3 | description: `Login meta description...`,
4 | title: `Login`,
5 | };
6 |
7 | return { meta };
8 | }
9 |
--------------------------------------------------------------------------------
/src/routes/(public)/[[lang]]/blog/tag/[tag]/[page=integer]/+page.svelte:
--------------------------------------------------------------------------------
1 |
5 |
6 | Posts tagged {params.tag}
7 |
8 | Show page {params.page} of posts tagged {params.tag} or 404.
9 |
--------------------------------------------------------------------------------
/src/routes/(public)/[[lang]]/blog/tag/[tag]/[page=integer]/+page.ts:
--------------------------------------------------------------------------------
1 | export async function load() {
2 | const meta = {
3 | description: `Login meta description...`,
4 | title: `Login`,
5 | };
6 |
7 | return { meta };
8 | }
9 |
--------------------------------------------------------------------------------
/src/routes/(public)/[[lang]]/campsites/[country]/[state]/+page.svelte:
--------------------------------------------------------------------------------
1 |
4 |
5 | Campsites
6 |
--------------------------------------------------------------------------------
/src/routes/(public)/[[lang]]/campsites/[country]/[state]/+page.ts:
--------------------------------------------------------------------------------
1 | export async function load() {
2 | const meta = {
3 | description: `Campsites`,
4 | title: `Campsites`,
5 | };
6 |
7 | return { meta };
8 | }
9 |
--------------------------------------------------------------------------------
/src/routes/(public)/[[lang]]/login/+page.svelte:
--------------------------------------------------------------------------------
1 |
4 |
5 | Login
6 |
--------------------------------------------------------------------------------
/src/routes/(public)/[[lang]]/login/+page.ts:
--------------------------------------------------------------------------------
1 | export async function load() {
2 | const meta = {
3 | description: `Login meta description...`,
4 | title: `Login`,
5 | };
6 |
7 | return { meta };
8 | }
9 |
--------------------------------------------------------------------------------
/src/routes/(public)/[[lang]]/og/blog/[title].png/+server.ts:
--------------------------------------------------------------------------------
1 | import type { RequestHandler } from '@sveltejs/kit';
2 |
3 | export const GET: RequestHandler = async () => {
4 | // Pretend this is a SvelteKit OG image generation lib; for testing SK
5 | // Sitemap, we only need the route to exist.
6 | return new Response('OG route', { headers: { 'content-type': 'text/html' } });
7 | };
8 |
--------------------------------------------------------------------------------
/src/routes/(public)/[[lang]]/optionals/[[optional]]/+page.svelte:
--------------------------------------------------------------------------------
1 |
4 |
5 | Route with an optional param
6 |
--------------------------------------------------------------------------------
/src/routes/(public)/[[lang]]/optionals/[[optional]]/+page.ts:
--------------------------------------------------------------------------------
1 | export async function load() {
2 | const meta = {
3 | description: `Foo meta description...`,
4 | title: `Foo`,
5 | };
6 |
7 | return { meta };
8 | }
9 |
--------------------------------------------------------------------------------
/src/routes/(public)/[[lang]]/optionals/many/[[paramA]]/+page.svelte:
--------------------------------------------------------------------------------
1 |
4 |
5 | Route with an optional param B
6 |
--------------------------------------------------------------------------------
/src/routes/(public)/[[lang]]/optionals/many/[[paramA]]/[[paramB]]/foo/+page.svelte:
--------------------------------------------------------------------------------
1 |
4 |
5 | Route with an optional param foo
6 |
--------------------------------------------------------------------------------
/src/routes/(public)/[[lang]]/optionals/many/[[paramA]]/[[paramB]]/foo/+page.ts:
--------------------------------------------------------------------------------
1 | export async function load() {
2 | const meta = {
3 | description: `Foo meta description...`,
4 | title: `Foo`,
5 | };
6 |
7 | return { meta };
8 | }
9 |
--------------------------------------------------------------------------------
/src/routes/(public)/[[lang]]/optionals/to-exclude/[[optional]]/+page.svelte:
--------------------------------------------------------------------------------
1 |
4 |
5 | Route with an optional param
6 |
--------------------------------------------------------------------------------
/src/routes/(public)/[[lang]]/optionals/to-exclude/[[optional]]/+page.ts:
--------------------------------------------------------------------------------
1 | export async function load() {
2 | const meta = {
3 | description: `Foo meta description...`,
4 | title: `Foo`,
5 | };
6 |
7 | return { meta };
8 | }
9 |
--------------------------------------------------------------------------------
/src/routes/(public)/[[lang]]/pricing/+page.svelte:
--------------------------------------------------------------------------------
1 |
4 |
5 | Pricing
6 |
--------------------------------------------------------------------------------
/src/routes/(public)/[[lang]]/pricing/+page.ts:
--------------------------------------------------------------------------------
1 | export async function load() {
2 | const meta = {
3 | description: `Privacy meta description...`,
4 | title: `Privacy`,
5 | };
6 |
7 | return { meta };
8 | }
9 |
--------------------------------------------------------------------------------
/src/routes/(public)/[[lang]]/privacy/+page.svelte:
--------------------------------------------------------------------------------
1 |
4 |
5 | Pricing
6 |
--------------------------------------------------------------------------------
/src/routes/(public)/[[lang]]/privacy/+page.ts:
--------------------------------------------------------------------------------
1 | export async function load() {
2 | const meta = {
3 | description: `Pricing meta description...`,
4 | title: `Pricing`,
5 | };
6 |
7 | return { meta };
8 | }
9 |
--------------------------------------------------------------------------------
/src/routes/(public)/[[lang]]/signup/+page.svelte:
--------------------------------------------------------------------------------
1 |
4 |
5 | Sign up
6 |
--------------------------------------------------------------------------------
/src/routes/(public)/[[lang]]/signup/+page.ts:
--------------------------------------------------------------------------------
1 | export async function load() {
2 | const meta = {
3 | description: `Sign up meta description...`,
4 | title: `Sign up`,
5 | };
6 |
7 | return { meta };
8 | }
9 |
--------------------------------------------------------------------------------
/src/routes/(public)/[[lang]]/sitemap[[page]].xml/+server.ts:
--------------------------------------------------------------------------------
1 | import * as sitemap from '$lib/sitemap'; // Import from 'super-sitemap' in your app
2 | import type { RequestHandler } from '@sveltejs/kit';
3 |
4 | import * as blog from '$lib/data/blog';
5 | import { error } from '@sveltejs/kit';
6 |
7 | // - Use prerender if you only have static routes or the data for your
8 | // parameterized routes does not change between your builds builds. Otherwise,
9 | // disabling prerendering will allow your database that generate param values
10 | // to be executed when a user request to the sitemap does not hit cache.
11 | // export const prerender = true;
12 |
13 | export const GET: RequestHandler = async ({ params }) => {
14 | // Get data for parameterized routes
15 | let slugs, tags;
16 | try {
17 | [slugs, tags] = await Promise.all([blog.getSlugs(), blog.getTags()]);
18 | } catch (err) {
19 | throw error(500, 'Could not load paths');
20 | }
21 |
22 | return await sitemap.response({
23 | additionalPaths: ['/foo.pdf'], // e.g. a file in the `static` dir
24 | excludeRoutePatterns: [
25 | '/dashboard.*',
26 | '/to-exclude',
27 | '(secret-group)',
28 |
29 | // Exclude routes containing `[page=integer]`–e.g. `/blog/2`
30 | `.*\\[page=integer\\].*`,
31 | ],
32 | // maxPerPage: 20,
33 | origin: 'https://example.com',
34 | page: params.page,
35 |
36 | /* eslint-disable perfectionist/sort-objects */
37 | paramValues: {
38 | '/[[lang]]/[foo]': ['foo-path-1'],
39 | '/[[lang]]/optionals/[[optional]]': ['optional-1', 'optional-2'],
40 | '/[[lang]]/optionals/many/[[paramA]]': ['data-a1', 'data-a2'],
41 | '/[[lang]]/optionals/many/[[paramA]]/[[paramB]]': [
42 | ['data-a1', 'data-b1'],
43 | ['data-a2', 'data-b2'],
44 | ],
45 | '/[[lang]]/optionals/many/[[paramA]]/[[paramB]]/foo': [
46 | ['data-a1', 'data-b1'],
47 | ['data-a2', 'data-b2'],
48 | ],
49 | '/[[lang]]/blog/[slug]': slugs,
50 | '/[[lang]]/blog/tag/[tag]': tags,
51 | '/[[lang]]/campsites/[country]/[state]': [
52 | {
53 | values: ['usa', 'new-york'],
54 | lastmod: '2025-01-01T00:00:00Z',
55 | changefreq: 'daily',
56 | priority: 0.5,
57 | },
58 | {
59 | values: ['usa', 'california'],
60 | lastmod: '2025-01-05',
61 | changefreq: 'daily',
62 | priority: 0.4,
63 | },
64 | // {
65 | // values: ['canada', 'toronto']
66 | // },
67 | ],
68 | },
69 |
70 | defaultPriority: 0.7,
71 | defaultChangefreq: 'daily',
72 | sort: 'alpha', // helps predictability of test data
73 | lang: {
74 | default: 'en',
75 | alternates: ['zh'],
76 | },
77 | processPaths: (paths: sitemap.PathObj[]) => {
78 | // Add trailing slashes. (In reality, using no trailing slash is
79 | // preferable b/c it provides consistency among all possible paths, even
80 | // items like `/foo.pdf`; this is merely intended to test the
81 | // `processPaths()` callback.)
82 | return paths.map(({ path, alternates, ...rest }) => {
83 | const rtrn = { path: path === '/' ? path : `${path}/`, ...rest };
84 |
85 | if (alternates) {
86 | rtrn.alternates = alternates.map((alternate: sitemap.Alternate) => ({
87 | ...alternate,
88 | path: alternate.path === '/' ? alternate.path : `${alternate.path}/`,
89 | }));
90 | }
91 |
92 | return rtrn;
93 | });
94 | },
95 | });
96 | };
97 |
--------------------------------------------------------------------------------
/src/routes/(public)/[[lang]]/terms/+page.ts:
--------------------------------------------------------------------------------
1 | export async function load() {
2 | const meta = {
3 | description: `Terms meta description...`,
4 | title: `Terms`,
5 | };
6 |
7 | return { meta };
8 | }
9 |
--------------------------------------------------------------------------------
/src/routes/(public)/[[lang]]/terms/+page@.svelte:
--------------------------------------------------------------------------------
1 |
6 |
7 | Terms
8 |
--------------------------------------------------------------------------------
/src/routes/(public)/markdown-md/+page.md:
--------------------------------------------------------------------------------
1 | # Markdown example (`.md`)
2 |
3 | This page is to test support markdown files for SvelteKit sites that use MDSveX.
4 | https://github.com/jasongitmail/super-sitemap/issues/34
5 |
--------------------------------------------------------------------------------
/src/routes/(public)/markdown-svx/+page.svx:
--------------------------------------------------------------------------------
1 | # Markdown example (`.svx`)
2 |
3 | This page is to test support markdown files for SvelteKit sites that use MDSveX.
4 | https://github.com/jasongitmail/super-sitemap/issues/34
5 |
--------------------------------------------------------------------------------
/src/routes/(secret-group)/secret-page/+page.svelte:
--------------------------------------------------------------------------------
1 |
4 |
5 | Secret Page
6 |
--------------------------------------------------------------------------------
/src/routes/(secret-group)/secret-page/+page.ts:
--------------------------------------------------------------------------------
1 | export async function load() {
2 | const meta = {
3 | description: `A secret page`,
4 | title: `A secret page`,
5 | };
6 |
7 | return { meta };
8 | }
9 |
--------------------------------------------------------------------------------
/src/routes/dashboard/settings/+page.svelte:
--------------------------------------------------------------------------------
1 |
4 |
5 | Dashboard settings
6 |
--------------------------------------------------------------------------------
/src/routes/dashboard/settings/+page.ts:
--------------------------------------------------------------------------------
1 | export async function load() {
2 | const meta = {
3 | title: `Dashboard settings`,
4 | };
5 |
6 | return { meta };
7 | }
8 |
--------------------------------------------------------------------------------
/static/favicon.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/jasongitmail/super-sitemap/ca6a9363a4af62e467afb70d5fb1e0b3b4fa70f5/static/favicon.png
--------------------------------------------------------------------------------
/svelte.config.js:
--------------------------------------------------------------------------------
1 | import adapter from '@sveltejs/adapter-auto';
2 | import { vitePreprocess } from '@sveltejs/kit/vite';
3 | import { mdsvex } from 'mdsvex';
4 |
5 | /** @type {import('@sveltejs/kit').Config} */
6 | const config = {
7 | extensions: ['.svelte', '.svx', '.md'],
8 |
9 | // Consult https://kit.svelte.dev/docs/integrations#preprocessors
10 | kit: {
11 | // adapter-auto only supports some environments, see https://kit.svelte.dev/docs/adapter-auto for a list.
12 | // If your environment is not supported or you settled on a specific environment, switch out the adapter.
13 | // See https://kit.svelte.dev/docs/adapters for more information about adapters.
14 | adapter: adapter(),
15 | },
16 |
17 | preprocess: [
18 | vitePreprocess(),
19 | mdsvex({
20 | extensions: ['.svx', '.md'],
21 | }),
22 | ],
23 | };
24 |
25 | export default config;
26 |
--------------------------------------------------------------------------------
/tsconfig.json:
--------------------------------------------------------------------------------
1 | {
2 | "extends": "./.svelte-kit/tsconfig.json",
3 | "compilerOptions": {
4 | "allowJs": true,
5 | "checkJs": true,
6 | "esModuleInterop": true,
7 | "forceConsistentCasingInFileNames": true,
8 | "resolveJsonModule": true,
9 | "skipLibCheck": true,
10 | "sourceMap": true,
11 | "strict": true,
12 | "moduleResolution": "NodeNext"
13 | }
14 | }
15 |
--------------------------------------------------------------------------------
/vite.config.ts:
--------------------------------------------------------------------------------
1 | import { sveltekit } from '@sveltejs/kit/vite';
2 | import { defineConfig } from 'vitest/config';
3 |
4 | export default defineConfig({
5 | plugins: [sveltekit()],
6 | test: {
7 | include: ['src/**/*.{test,spec}.{js,ts}'],
8 | },
9 | });
10 |
--------------------------------------------------------------------------------
8 |
9 |
10 | 
11 |
12 |
13 | 
14 |
15 |