Justin PoehneltSometimes UUIDs are used as unique identifiers in URLs, but their length is not very user-friendly. A common pattern is to use a string encoding of the UUID to shorten the URL. This post will show how to apply that conversion in a SvelteKit store.
URL safe base 64 encoding uses the following characters: A-Z, a-z, 0-9, -, and _. The padding character = is not used and the characters + and / are replaced with - and _ respectively. See RFC 4648, sec. 5.
UUID to Slug and Slug to UUID
Here is a simple implementation of the conversion functions. The uuid package is used to parse and stringify UUIDs. The Buffer class is used to convert between byte arrays and base 64 strings. If Buffer is not available, the btoa and atob functions are used instead.
const toBase64 = (bytes: Uint8Array) => string = (() => {
if (typeof Buffer !== "undefined") {
return (bytes: Uint8Array) => Buffer.from(bytes).toString("base64");
}
return (bytes: Uint8Array) => btoa(String.fromCharCode(...bytes));
})();
const fromBase64 = (base64: string) => Uint8Array | Buffer = (() => {
if (typeof Buffer !== "undefined") {
return (base64: string) => Buffer.from(base64, "base64");
}
return (base64: string) =>
Uint8Array.from(atob(base64), (c) => c.charCodeAt(0));
})();
/**
* Returns the given uuid as a 22 character slug. This can be a regular v4
* slug or a "nice" slug.
*/
export function uuidToSlug(id: string) {
const bytes = uuid.parse(id);
const base64 = toBase64(bytes);
const slug = base64
.replace(/\+/g, "-") // Replace + with - (see RFC 4648, sec. 5)
.replace(/\//g, "_") // Replace / with _ (see RFC 4648, sec. 5)
.substring(0, 22); // Drop '==' padding
return slug;
}
/**
* Returns the uuid represented by the given slug
*/
export function slugToUUID(slug: string) {
const base64 = `${slug.replace(/-/g, "+").replace(/_/g, "/")}==`;
return uuid.stringify(fromBase64(base64));
}
A Parameters Store
In my SvelteKit application I am using the following folder structure for parameters:
src
└── routes
└── [fooId]
└── +page.svelte
The +page.svelte component is used to display the content of a page. The fooId path parameter is a UUID that is converted to a slug in the URL. The params store is used to convert the slugs back to UUIDs.
In this example, logic is applied to specifically convert slugs that are 22 characters long and conclude with Id or id. You might need to modify this logic to align with your specific use case.
// src/lib/stores.ts
import { page } from "$app/stores";
import { derived} from "svelte/store";
import { slugToUUID } from "$lib/utils/uuid";
export const params = derived(page, ($page) => {
return Object.fromEntries(
Object.entries($page.params).map(([key, value]) => {
// Convert slugs to UUIDs if ending in 'Id' or 'id' and 22 characters long
if (/^(id|[a-zA-Z]+Id)$/.test(key) && value && value.length === 22) {
value = slugToUUID(value);
}
return [key, value];
}),
);
});
The Regex match above should match the following examples:
-
id✅ -
fooId✅ -
foo❌ -
fooid❌
Using the Parameters Store
The params store is imported in the +page.svelte component to access the UUIDs.
// src/routes/[fooId]/+page.svelte
<script>
import { params } from "$lib/stores";
import { page } from "$app/stores";
</script>
<p>uuid: {$params.fooId}, slug: {$page.params.fooId}</p>
The above code will show the following output:
uuid: 376a4cca-9431-44f0-bc04-054faffba9b1, slug: N2pMypQxRPC8BAVPr_upsQ
Conclusion
This post showed how to convert slugs to UUIDs in a SvelteKit store. The params store can be used to automatically convert slugs in the URL path parameters. This is useful when UUIDs are used as unique identifiers in URLs, but their length is not very user-friendly.
While I plan to use this technique, I might also consider using a more user-friendly slug in the URL as a unique key in the database. This would allow me to use the slug directly in the URL without the need for conversion but at the cost of an additional database lookup.
