@camox/api-contract 0.47.0 → 0.51.0

package/dist/index.js

@@ -32,6 +32,38 @@ function artifactTitle(source) {
 	return artifactSourceTitle(source) ?? "Untitled artifact";
 }
 
+//#endregion
+//#region src/record-templates.ts
+/**
+* A collection's `toTitle` and `toDescription` are record templates: text with `{{field}}` tokens
+* naming the record's String fields, which the SDK writes and the API fills with each record's
+* plain text. Both sides read them the same way through these helpers.
+*/
+const TOKEN = /\{\{([^}]*)\}\}/g;
+/** The fields a record template's tokens name, in order, such as `firstName` and `lastName`. */
+function templateFields(template) {
+	return [...template.matchAll(TOKEN)].map(([, name]) => name);
+}
+/**
+* The fields a record template names that aren't String fields of the content schema's
+* properties: templates read fields as plain text, so they name no other field.
+*/
+function nonStringTemplateFields(template, properties) {
+	const isString = (field) => field !== void 0 && "fieldType" in field && field.fieldType === "String";
+	return templateFields(template).filter((name) => !isString(properties[name]));
+}
+/**
+* A record's title and description: its collection's templates filled with the plain text
+* `textOf` reads from each field they name.
+*/
+function recordText(templates, textOf) {
+	const fill = (template) => template.replace(TOKEN, (_token, name) => textOf(name)).trim();
+	return {
+		title: fill(templates.toTitle),
+		description: templates.toDescription && fill(templates.toDescription) || null
+	};
+}
+
 //#endregion
 //#region src/reference-query.ts
 /**
@@ -67,4 +99,38 @@ function referenceQueryProblem(query, fieldTypeOf) {
 }
 
 //#endregion
-export { ICON_CATALOG_VERSION, PAGE_TEXT_LINK_PREFIX, QUERY_LIMIT_CAP, SYSTEM_ORDER_KEYS, UNTITLED_ARTIFACT, artifactSourceTitle, artifactTitle, generateUuidv7, isQueryBacked, isSystemOrderKey, projectIdSchema, referenceQueryProblem, scopeIconSvgIds, uuidv7JsonSchema, uuidv7Schema, validateIconValue };
+//#region src/structured-data.ts
+const RECORD_LINK_PREFIX = "camox:record:";
+/** A link to the node of the record with id `id`. */
+function recordLink(id) {
+	return { "@id": `${RECORD_LINK_PREFIX}${id}` };
+}
+/** The id of the record a value links, when it is a record link. */
+function linkedRecordId(value) {
+	if (typeof value !== "object" || value === null || Array.isArray(value)) return void 0;
+	if (Object.keys(value).length !== 1) return void 0;
+	const id = value["@id"];
+	if (typeof id !== "string" || !id.startsWith(RECORD_LINK_PREFIX)) return void 0;
+	return id.slice(13);
+}
+/** The Article types, whose name is their `headline`. */
+const ARTICLE_TYPES = [
+	"Article",
+	"BlogPosting",
+	"NewsArticle",
+	"TechArticle",
+	"ScholarlyArticle",
+	"Report",
+	"SocialMediaPosting"
+];
+/** Whether a value is a marker for a page's URL. */
+function isPageUrlMarker(value) {
+	return typeof value === "object" && value !== null && value["@camox"] === "pageUrl" && typeof value.path === "string";
+}
+/** Whether a template's value is shown only under a setting. */
+function isSettingCondition(value) {
+	return typeof value === "object" && value !== null && value["@camox"] === "if" && typeof value.setting === "string";
+}
+
+//#endregion
+export { ARTICLE_TYPES, ICON_CATALOG_VERSION, PAGE_TEXT_LINK_PREFIX, QUERY_LIMIT_CAP, SYSTEM_ORDER_KEYS, UNTITLED_ARTIFACT, artifactSourceTitle, artifactTitle, generateUuidv7, isPageUrlMarker, isQueryBacked, isSettingCondition, isSystemOrderKey, linkedRecordId, nonStringTemplateFields, projectIdSchema, recordLink, recordText, referenceQueryProblem, scopeIconSvgIds, templateFields, uuidv7JsonSchema, uuidv7Schema, validateIconValue };

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. */
@@ -25,4 +27,9 @@ export type ProjectStatus = "settingUp" | "live" | "setupFailed";
  */
 export type ProjectSetupStep = "copyTemplate" | "build" | "serve";
 export declare const PROJECT_SETUP_STEPS: readonly ProjectSetupStep[];
+/**
+ * A social profile's address: an absolute `https` URL. Shared so the studio checks a profile by
+ * the API's own rule before saving it.
+ */
+export declare const socialProfileUrlSchema: z.ZodString;
 //#endregion

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.",
@@ -45,6 +47,19 @@ const PROJECT_SETUP_STEPS = [
 	"build",
 	"serve"
 ];
+/**
+* A social profile's address: an absolute `https` URL. Shared so the studio checks a profile by
+* the API's own rule before saving it.
+*/
+const socialProfileUrlSchema = /* @__PURE__ */ z.string().max(2048, "Use a shorter URL").refine(isHttpsUrl, "Enter a URL starting with https://");
+function isHttpsUrl(value) {
+	if (!value.startsWith("https://")) return false;
+	try {
+		return new URL(value).hostname !== "";
+	} catch {
+		return false;
+	}
+}
 
 //#endregion
-export { PROJECT_SETUP_STEPS, RESERVED_PROJECT_SLUGS, UNAVAILABLE_SLUG_MESSAGES, projectSlugSchema };
+export { PROJECT_SETUP_STEPS, RESERVED_PROJECT_SLUGS, UNAVAILABLE_SLUG_MESSAGES, projectSlugSchema, projectWebsiteUrl, socialProfileUrlSchema };