@camox/api-contract 0.48.0 → 0.51.0

package/dist/locales.d.ts

@@ -0,0 +1,25 @@
+//#region src/locales.d.ts
+/**
+ * The URL names the locale (ADR 0015): a non-default locale's paths sit under its prefix
+ * (`/de/preise`), the default locale's have none. Pure, so the API, the runtime and the browser
+ * read a path the same way.
+ */
+/** A locale of a project, as `locales.list` returns it. */
+export type LocaleView = {
+  tag: string;
+  isDefault: boolean;
+};
+/** A runtime path split into the locale it names and the locale-relative path after its prefix. */
+export type LocalePath = {
+  locale: LocaleView;
+  path: string;
+};
+/** A locale's URL prefix: its tag in lowercase. The default locale has none. */
+export declare function localePrefix(locale: LocaleView): string;
+/**
+ * The locale a runtime path names, and the path after its prefix, without search or hash. A first
+ * segment that isn't a non-default locale's prefix leaves the path the default locale's. A
+ * locale's home is `/de`; `/de/` names it too.
+ */
+export declare function parseLocalePath(pathname: string, locales: readonly LocaleView[]): LocalePath;
+//#endregion

package/dist/locales.js

@@ -0,0 +1,29 @@
+//#region src/locales.ts
+/** A locale's URL prefix: its tag in lowercase. The default locale has none. */
+function localePrefix(locale) {
+	return locale.isDefault ? "" : `/${locale.tag.toLowerCase()}`;
+}
+/**
+* The locale a runtime path names, and the path after its prefix, without search or hash. A first
+* segment that isn't a non-default locale's prefix leaves the path the default locale's. A
+* locale's home is `/de`; `/de/` names it too.
+*/
+function parseLocalePath(pathname, locales) {
+	const path = pathname.replace(/[?#].*$/s, "") || "/";
+	const end = path.indexOf("/", 1);
+	const segment = end === -1 ? path.slice(1) : path.slice(1, end);
+	const named = locales.find((locale) => !locale.isDefault && localePrefix(locale) === `/${segment}`);
+	if (named) return {
+		locale: named,
+		path: end === -1 ? "/" : path.slice(end)
+	};
+	const fallback = locales.find((locale) => locale.isDefault);
+	if (!fallback) throw new Error("A project's locales include its default locale.");
+	return {
+		locale: fallback,
+		path
+	};
+}
+
+//#endregion
+export { localePrefix, parseLocalePath };

package/dist/projects.d.ts

@@ -10,6 +10,8 @@ export declare const RESERVED_PROJECT_SLUGS: ReadonlySet<string>;
  * made of letters, digits and inner hyphens.
  */
 export declare const projectSlugSchema: z.ZodString;
+/** The address a project's website is served at: its Project Slug's `camox.site` subdomain. */
+export declare const projectWebsiteUrl: (slug: string) => string;
 /** Why a slug can't be given to a new project. */
 export type UnavailableSlugReason = "invalid" | "reserved" | "taken";
 /** What a member is told when a slug can't be used, by reason. */

package/dist/projects.js

@@ -34,6 +34,8 @@ const RESERVED_PROJECT_SLUGS = /* @__PURE__ */ new Set([
 * made of letters, digits and inner hyphens.
 */
 const projectSlugSchema = /* @__PURE__ */ z.string().min(1, "Enter a slug").max(63, "Use at most 63 characters").regex(/^[a-z0-9]+(?:-[a-z0-9]+)*$/, "Use lowercase letters, digits and hyphens, without a hyphen at either end");
+/** The address a project's website is served at: its Project Slug's `camox.site` subdomain. */
+const projectWebsiteUrl = (slug) => `https://${slug}.camox.site`;
 /** What a member is told when a slug can't be used, by reason. */
 const UNAVAILABLE_SLUG_MESSAGES = {
 	invalid: "Use lowercase letters, digits and hyphens, without a hyphen at either end.",
@@ -60,4 +62,4 @@ function isHttpsUrl(value) {
 }
 
 //#endregion
-export { PROJECT_SETUP_STEPS, RESERVED_PROJECT_SLUGS, UNAVAILABLE_SLUG_MESSAGES, projectSlugSchema, socialProfileUrlSchema };
+export { PROJECT_SETUP_STEPS, RESERVED_PROJECT_SLUGS, UNAVAILABLE_SLUG_MESSAGES, projectSlugSchema, projectWebsiteUrl, socialProfileUrlSchema };