@camox/api-contract 0.48.0 → 0.51.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@camox/api-contract",
-  "version": "0.48.0",
+  "version": "0.51.0",
   "license": "MIT",
   "files": [
     "src",
@@ -39,6 +39,14 @@
     "./projects": {
       "types": "./dist/projects.d.ts",
       "default": "./dist/projects.js"
+    },
+    "./locales": {
+      "types": "./dist/locales.d.ts",
+      "default": "./dist/locales.js"
+    },
+    "./router": {
+      "types": "./dist/router.d.ts",
+      "default": "./dist/router.js"
     }
   },
   "dependencies": {

package/src/drafts.ts

@@ -1,4 +1,4 @@
-import type { Router } from "./index.ts";
+import type { Router } from "./router.ts";
 
 /** Request header naming the draft a request reads and writes (ADR 0011). Absent means Live. */
 export const DRAFT_HEADER = "x-camox-draft";
@@ -147,6 +147,7 @@ const FILE_WRITES: Record<keyof Router["files"], boolean> = {
 const PAGE_WRITES: Record<keyof Router["pages"], boolean> = {
   getByPath: false,
   getStructure: false,
+  getMarkdown: false,
   list: false,
   listBySlug: false,
   get: false,

package/src/index.ts

@@ -4,6 +4,3 @@ export * from "./ids.ts";
 export * from "./record-templates.ts";
 export * from "./reference-query.ts";
 export * from "./structured-data.ts";
-export type { Router } from "../../../apps/api/src/router";
-export type { PublishPreview } from "../../../apps/api/src/domains/drafts/publish";
-export type { EntityKind } from "../../../apps/api/src/domains/drafts/overlay";

package/src/locales.ts

@@ -0,0 +1,34 @@
+/**
+ * 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 function localePrefix(locale: LocaleView): string {
+  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.
+ */
+export function parseLocalePath(pathname: string, locales: readonly LocaleView[]): LocalePath {
+  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 };
+}

package/src/projects.ts

@@ -42,6 +42,9 @@ export const projectSlugSchema = /* @__PURE__ */ z
     "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. */
+export const projectWebsiteUrl = (slug: string) => `https://${slug}.camox.site`;
+
 /** Why a slug can't be given to a new project. */
 export type UnavailableSlugReason = "invalid" | "reserved" | "taken";
 

package/src/router.ts

@@ -0,0 +1,5 @@
+// The API's router and server-side types. Kept off the main entry so a site importing
+// `camox` doesn't load the whole API's types (and packages it can't resolve).
+export type { Router } from "../../../apps/api/src/router";
+export type { PublishPreview } from "../../../apps/api/src/domains/drafts/publish";
+export type { EntityKind } from "../../../apps/api/src/domains/drafts/overlay";