@contentrain/types 1.33.0 → 1.36.0

package/dist/index.mjs

@@ -625,6 +625,13 @@ function evaluateApproval(input) {
 //#region src/migrate-claim.ts
 /** Contract version carried in the payload as `v`. */
 const MIGRATE_STUDIO_CLAIM_VERSION = 1;
+/**
+* v2: "Migrate with Studio". No trial: the Studio year is part of the order's
+* first invoice (Studio creates that checkout itself, server to server), and
+* the claim names the customer's GitHub account so Studio can find or create
+* the user without a sign-in. v1 stays valid for the claim-link flow.
+*/
+const MIGRATE_STUDIO_CLAIM_VERSION_2 = 2;
 /** JWS `alg` header value. */
 const MIGRATE_STUDIO_CLAIM_ALG = "EdDSA";
 /** `iss` — who signs. */
@@ -643,6 +650,7 @@ const isObject = (x) => typeof x === "object" && x !== null && !Array.isArray(x)
 const isText = (x) => typeof x === "string" && x.trim().length > 0;
 const isSeconds = (x) => typeof x === "number" && Number.isInteger(x) && x > 0;
 const isFiniteNonNegative = (x) => typeof x === "number" && Number.isFinite(x) && x >= 0;
+const isCents = (x) => typeof x === "number" && Number.isInteger(x) && x >= 0 && x <= 1e8;
 const LOCAL_HOSTS = new Set([
 	"localhost",
 	"127.0.0.1",
@@ -664,6 +672,18 @@ function isClaimOrigin(x) {
 function isCompactJws(x) {
 	return typeof x === "string" && x.length <= 2048 && /^[\w-]+\.[\w-]+\.[\w-]+$/.test(x);
 }
+/** A post-payment return address: https (http for localhost), no credentials or fragment; a query is fine. */
+function isReturnUrl(x) {
+	if (typeof x !== "string" || x.length > 2048) return false;
+	let url;
+	try {
+		url = new URL(x);
+	} catch {
+		return false;
+	}
+	if (url.username || url.password || url.hash || url.hostname.endsWith(".")) return false;
+	return url.protocol === "https:" || url.protocol === "http:" && LOCAL_HOSTS.has(url.hostname);
+}
 /** A fetchable export address: https (http for localhost), no credentials, query or fragment — nowhere for a secret. */
 function isExportUrl(x) {
 	if (typeof x !== "string" || x.length > 2048) return false;
@@ -688,6 +708,21 @@ function isExportUrl(x) {
 * file upload instead.
 */
 function validateMigrateStudioClaim(input, options = {}) {
+	return validateClaim(input, options, 1);
+}
+/**
+* The v2 counterpart of `validateMigrateStudioClaim`: same envelope, plan, repo
+* and add-on checks, no `trial_days` (a v2 claim that carries one is refused),
+* plus `github_user_id`, `email_verified`, `return_url` and `billing`.
+*/
+function validateMigrateStudioClaimV2(input, options = {}) {
+	return validateClaim(input, options, 2);
+}
+/** Validate a claim of either version; read `result.claim.v` to tell them apart. */
+function validateMigrateStudioClaimAny(input, options = {}) {
+	return (isObject(input) ? input.v : void 0) === 2 ? validateMigrateStudioClaimV2(input, options) : validateMigrateStudioClaim(input, options);
+}
+function validateClaim(input, options, version) {
 	const errors = [];
 	if (!isObject(input)) return {
 		ok: false,
@@ -696,7 +731,7 @@ function validateMigrateStudioClaim(input, options = {}) {
 	const x = input;
 	if (x.iss !== "contentrain-migrate") errors.push("iss: unexpected issuer");
 	if (x.aud !== "contentrain-studio") errors.push("aud: unexpected audience");
-	if (x.v !== 1) errors.push("v: unsupported version");
+	if (x.v !== version) errors.push("v: unsupported version");
 	for (const key of [
 		"sub",
 		"jti",
@@ -720,7 +755,16 @@ function validateMigrateStudioClaim(input, options = {}) {
 		if (!isObject(e) || !isText(e.limit_key) || !isFiniteNonNegative(e.measured) || !isFiniteNonNegative(e.limit)) errors.push(`plan_evidence[${i}]: invalid`);
 		else if (e.capability !== void 0 && !CAPABILITY_SET.has(e.capability)) errors.push(`plan_evidence[${i}].capability: unknown`);
 	});
-	if (typeof x.trial_days !== "number" || !Number.isInteger(x.trial_days) || x.trial_days < 1 || x.trial_days > 90) errors.push("trial_days: out of range");
+	if (version === 1) {
+		if (typeof x.trial_days !== "number" || !Number.isInteger(x.trial_days) || x.trial_days < 1 || x.trial_days > 90) errors.push("trial_days: out of range");
+	} else {
+		if (x.trial_days !== void 0) errors.push("trial_days: not part of v2");
+		if (typeof x.github_user_id !== "string" || !/^[1-9]\d{0,18}$/.test(x.github_user_id)) errors.push("github_user_id: invalid");
+		if (typeof x.email_verified !== "boolean") errors.push("email_verified: required");
+		if (!isReturnUrl(x.return_url)) errors.push("return_url: invalid");
+		const b = x.billing;
+		if (!isObject(b) || !isCents(b.migrate_fee_cents) || !isCents(b.quoted_total_cents) || b.quoted_total_cents <= 0 || b.currency !== "usd" || b.quoted_total_cents < b.migrate_fee_cents) errors.push("billing: invalid");
+	}
 	const repo = x.repo;
 	if (!isObject(repo) || repo.provider !== "github" || !isText(repo.owner) || !isText(repo.name) || repo.owner.includes("/") || repo.name.includes("/")) errors.push("repo: invalid");
 	if (x.capabilities !== void 0) if (!Array.isArray(x.capabilities)) errors.push("capabilities: not an array");
@@ -766,6 +810,99 @@ function isMigrateStudioClaim(input) {
 	const result = validateMigrateStudioClaim(input);
 	return result.ok && !result.warnings;
 }
+const MIGRATE_ACCOUNT_STATES = [
+	"none",
+	"covers",
+	"too_small"
+];
+/** Plans in ascending order; a higher index carries more. */
+const PLAN_RANK = {
+	starter: 0,
+	pro: 1
+};
+/**
+* Check the signed request Studio receives. Pass `now` (seconds since the
+* epoch) to also check the validity window. It does no cryptography, and it
+* does not remember `jti`: Studio keeps a replay record for account-state
+* requests, as it does for claims (a repeated `jti` is refused).
+*/
+function validateMigrateAccountStateRequest(input, options = {}) {
+	if (!isObject(input)) return {
+		ok: false,
+		errors: ["payload: not an object"]
+	};
+	const x = input;
+	const errors = [];
+	if (x.iss !== "contentrain-migrate") errors.push("iss: unexpected issuer");
+	if (x.aud !== "contentrain-studio") errors.push("aud: unexpected audience");
+	if (!isText(x.jti)) errors.push("jti: required");
+	if (!isSeconds(x.iat)) errors.push("iat: invalid");
+	if (!isSeconds(x.exp)) errors.push("exp: invalid");
+	if (isSeconds(x.iat) && isSeconds(x.exp)) {
+		const ttl = x.exp - x.iat;
+		if (ttl <= 0) errors.push("exp: not after iat");
+		else if (ttl > 1800) errors.push("exp: lifetime too long");
+		if (options.now !== void 0) {
+			if (options.now >= x.exp + 60) errors.push("exp: expired");
+			if (x.iat > options.now + 60) errors.push("iat: in the future");
+		}
+	}
+	if (typeof x.github_user_id !== "string" || !/^[1-9]\d{0,18}$/.test(x.github_user_id)) errors.push("github_user_id: invalid");
+	if (!MIGRATE_STUDIO_PLANS.includes(x.plan)) errors.push("plan: unknown plan");
+	return errors.length === 0 ? {
+		ok: true,
+		request: x
+	} : {
+		ok: false,
+		errors
+	};
+}
+/**
+* Check Studio's answer against the plan that was asked about (`requested`,
+* required: an answer is only meaningful against its question), which is what
+* Migrate does before it prices an Offer from it:
+* - `none`: no `current_plan`; `plan` is the requested plan.
+* - `too_small`: `plan` is the requested plan and `current_plan` is below it.
+* - `covers`: `current_plan` is at least the requested plan, `plan` is that
+*   current plan, and nothing is added (`year1_cents` 0).
+* Errors are the stable `field: problem` strings the claim validators use.
+*/
+function validateMigrateAccountStateResponse(input, options) {
+	if (!isObject(input)) return {
+		ok: false,
+		errors: ["payload: not an object"]
+	};
+	const errors = [];
+	const planOk = MIGRATE_STUDIO_PLANS.includes(input.plan);
+	const currentOk = MIGRATE_STUDIO_PLANS.includes(input.current_plan);
+	if (!MIGRATE_ACCOUNT_STATES.includes(input.state)) errors.push("state: unknown");
+	if (!planOk) errors.push("plan: unknown plan");
+	if (!isCents(input.year1_cents)) errors.push("year1_cents: invalid");
+	else if (input.state === "covers" && input.year1_cents !== 0) errors.push("year1_cents: must be 0 when covers");
+	else if (input.state !== void 0 && input.state !== "covers" && input.year1_cents === 0) errors.push("year1_cents: must be > 0");
+	if (input.current_plan !== void 0 && !currentOk) errors.push("current_plan: unknown plan");
+	if (input.state === "none" && input.current_plan !== void 0) errors.push("current_plan: not allowed when none");
+	if ((input.state === "covers" || input.state === "too_small") && input.current_plan === void 0) errors.push("current_plan: required unless none");
+	const asked = options?.requested;
+	if (!MIGRATE_STUDIO_PLANS.includes(asked)) errors.push("requested: unknown plan");
+	else if (planOk) {
+		const plan = input.plan;
+		if (input.state === "covers") {
+			if (currentOk && PLAN_RANK[input.current_plan] < PLAN_RANK[asked]) errors.push("current_plan: below the requested plan");
+			if (currentOk && plan !== input.current_plan) errors.push("plan: must be the current plan when covers");
+		} else if (input.state === "none" || input.state === "too_small") {
+			if (plan !== asked) errors.push("plan: not the requested plan");
+			if (input.state === "too_small" && currentOk && PLAN_RANK[input.current_plan] >= PLAN_RANK[asked]) errors.push("current_plan: not below the requested plan");
+		}
+	}
+	return errors.length === 0 ? {
+		ok: true,
+		response: input
+	} : {
+		ok: false,
+		errors
+	};
+}
 //#endregion
 //#region src/project-plan.ts
 const PROJECT_PLAN_FORMAT = "contentrain-project-plan@1";
@@ -799,7 +936,11 @@ const PLAN_TOKEN_ROLES = [
 	"text-heading-2",
 	"text-heading-3",
 	"spacing-section",
-	"color-link"
+	"color-link",
+	"color-page",
+	"color-card",
+	"shadow-card",
+	"spacing-card"
 ];
 const PLAN_VALUE_PATTERN = /^(?:field:[\w-]+|media:[\w-]+|ref:[\w-]+\.[\w-]+|href:(?:self|[\w-]+)|term:[\w-]+|ui:[\w.-]+|site:[\w-]+|menu:(?:primary|footer)|page:(?:base|current|total|breadcrumb)|const:(?:true|false|-?\d+(?:\.\d+)?|[a-z][a-z0-9_-]{0,31}))$/;
 const PLAN_STARTER_FEATURES = ["search"];
@@ -866,25 +1007,41 @@ function validateProjectPlan(plan) {
 			"cover"
 		].includes(part)) || new Set(parts).size !== parts.length) errors.push("site.post.header lists a part twice or one the starter does not have");
 		if (!Number.isSafeInteger(site.post.more) || site.post.more < 0 || site.post.more > 20) errors.push("site.post.more is not a count from 0 to 20");
+		if (site.post.moreIncludesCurrent !== void 0 && typeof site.post.moreIncludesCurrent !== "boolean") errors.push("site.post.moreIncludesCurrent is not true or false");
 	}
 	if (site?.lists && ![
 		"cards",
 		"list",
 		"full"
 	].includes(site.lists.display)) errors.push(`site.lists.display ${site.lists.display} is not cards, list or full`);
+	if (site?.lists?.tone !== void 0 && site.lists.tone !== "muted") errors.push(`site.lists.tone ${String(site.lists.tone)} is not muted`);
 	if (site?.lists?.text !== void 0 && !CSS_LENGTH.test(site.lists.text)) errors.push(`site.lists.text ${site.lists.text} is not a CSS size`);
+	for (const [route, layout] of Object.entries(site?.entryLayouts ?? {})) {
+		if (typeof layout?.adjacent !== "boolean") errors.push(`site.entryLayouts.${route}.adjacent is not true or false`);
+		if (layout?.more !== void 0 && (!Number.isSafeInteger(layout.more) || layout.more < 0 || layout.more > 20)) errors.push(`site.entryLayouts.${route}.more is not a count from 0 to 20`);
+		if (layout?.moreIncludesCurrent !== void 0 && typeof layout.moreIncludesCurrent !== "boolean") errors.push(`site.entryLayouts.${route}.moreIncludesCurrent is not true or false`);
+	}
 	const chrome = site?.chrome;
 	if (chrome?.brand !== void 0 && !CSS_LENGTH.test(chrome.brand)) errors.push(`site.chrome.brand ${chrome.brand} is not a CSS size`);
 	if (chrome?.tagline !== void 0 && typeof chrome.tagline !== "boolean") errors.push("site.chrome.tagline is not a boolean");
 	if (chrome?.titleLinks !== void 0 && typeof chrome.titleLinks !== "boolean") errors.push("site.chrome.titleLinks is not a boolean");
 	if (chrome?.navLinks !== void 0 && typeof chrome.navLinks !== "boolean") errors.push("site.chrome.navLinks is not a boolean");
 	if (chrome?.footerAlign !== void 0 && !["start", "center"].includes(chrome.footerAlign)) errors.push(`site.chrome.footerAlign ${chrome.footerAlign} is not start or center`);
-	for (const key of ["frame", "listFrame"]) {
+	for (const key of [
+		"frame",
+		"listFrame",
+		"postFrame"
+	]) {
 		const steps = chrome?.[key];
 		if (steps === void 0) continue;
 		if (!Array.isArray(steps) || steps.length === 0 || steps.length > 8) errors.push(`site.chrome.${key} is not a list of 1–8 steps`);
 		else if (steps.some((step, i) => !Number.isSafeInteger(step?.min) || !Number.isSafeInteger(step?.width) || step.min < 1 || step.width < 1 || step.min > 1e4 || step.width > 1e4 || i > 0 && step.min <= steps[i - 1].min)) errors.push(`site.chrome.${key} steps are not whole pixel widths in ascending order of min`);
 	}
+	if (chrome?.listColumns !== void 0) {
+		const steps = chrome.listColumns;
+		if (!Array.isArray(steps) || steps.length === 0 || steps.length > 8) errors.push("site.chrome.listColumns is not a list of 1–8 steps");
+		else if (steps.some((step, i) => !Number.isSafeInteger(step?.min) || !Number.isSafeInteger(step?.columns) || step.min < 1 || step.min > 1e4 || step.columns < 1 || step.columns > 6 || i > 0 && step.min <= steps[i - 1].min)) errors.push("site.chrome.listColumns steps are not a whole pixel min in ascending order and 1–6 columns");
+	}
 	if (chrome?.copyright !== void 0 && (typeof chrome.copyright !== "string" || !chrome.copyright.trim() || chrome.copyright.length > 200 || /[<>]/.test(chrome.copyright))) errors.push("site.chrome.copyright is not a line of plain text (1–200 characters, no markup)");
 	const footer = site?.menus?.footer;
 	if (typeof footer === "string") {
@@ -2139,6 +2296,6 @@ function serializeMarkdownFrontmatter(data, body) {
 	return lines.join("\n");
 }
 //#endregion
-export { APPROVAL_GATES, APPROVAL_MODES, CANONICAL_JSON, CAPABILITY_KEYS, CHROME_BODY_SLOT, CHROME_COMPONENT_CLOSE, CHROME_COMPONENT_OPEN, CHROME_IF_CLOSE, CHROME_IF_OPEN, CHROME_REPEAT_CLOSE, CHROME_REPEAT_OPEN, COMMENTS_EXPORT_FORMAT, COMPONENT_TYPES, CONTENTRAIN_BRANCH, CONTENTRAIN_DIR, DEFAULT_APPROVAL_POLICY, DICTIONARY_TITLE_FIELD, ENTRY_ID_PATTERN, EXECUTION_CONTRACT_VERSION, INTEGRATION_CATEGORIES, INTEGRATION_EVIDENCE_KINDS, LEGACY_CSS_LAYER, LIST_ITEMS_SLOT, LOCALE_PATTERN, LOCAL_CAPABILITIES, MIGRATE_STUDIO_CLAIM_ALG, MIGRATE_STUDIO_CLAIM_AUDIENCE, MIGRATE_STUDIO_CLAIM_CLOCK_SKEW_SECONDS, MIGRATE_STUDIO_CLAIM_ISSUER, MIGRATE_STUDIO_CLAIM_MAX_TRIAL_DAYS, MIGRATE_STUDIO_CLAIM_MAX_TTL_SECONDS, MIGRATE_STUDIO_CLAIM_VERSION, MIGRATE_STUDIO_PLANS, MIGRATION_CONTRACT_VERSION, MODEL_EXTENSION_KEYS, MODEL_FIELD_ORDER, PAGE_BODY_KINDS, PATH_PATTERNS, PLAN_BEHAVIOR_REASON, PLAN_SECTION_RULE, PLAN_STARTER_FEATURES, PLAN_TOKEN_ROLES, PLAN_VALUE_PATTERN, PROJECT_PLAN_FORMAT, RAW_MARK_SUFFIX, RESERVED_PATHS, RISK_CLASSES, RUN_STATUSES, SCHEDULE_KINDS, SECRET_PATTERNS, SEO_PROVIDERS, SLUG_PATTERN, SOURCE_ACCESS_LADDER, SOURCE_DELTA_OPS, TERMINAL_RUN_STATUSES, TEXT_CANDIDATE_KINDS, TEXT_EXCLUDE_REASONS, TITLE_FIELD_TYPES, approversFor, canonicalStringify, commentsExportSource, componentSlot, computePlanHash, conflictId, describeModelLocaleScope, detectSecrets, effectiveRisk, evaluateApproval, fieldDepth, footerMenusOf, generateEntryId, highestRisk, isMediaType, isMigrateStudioClaim, isRepoRelativePath, isReservedPath, isStoredMediaPath, isTerminalRunStatus, isTitleFieldType, looksLikeCredential, orderedFieldNames, parseFrontmatterScalar, parseFrontmatterScalarString, parseMarkdownFrontmatter, planHashPayload, requiredApprovals, resolveFieldLabel, resolveModelLocales, rewriteEntryMedia, rewriteFieldMedia, rewriteMarkdownMedia, rewriteMediaUrl, riskRank, sectionFieldName, serializeMarkdownFrontmatter, sortKeys, splitFrontmatterList, stableHash, titleFieldTarget, titleFieldValue, toDeliveryUrl, validateAccept, validateEntryId, validateFieldValue, validateHandoffCommentsExport, validateLocale, validateMigrateStudioClaim, validateModelLocales, validateProjectPlan, validateSemanticType, validateSlug };
+export { APPROVAL_GATES, APPROVAL_MODES, CANONICAL_JSON, CAPABILITY_KEYS, CHROME_BODY_SLOT, CHROME_COMPONENT_CLOSE, CHROME_COMPONENT_OPEN, CHROME_IF_CLOSE, CHROME_IF_OPEN, CHROME_REPEAT_CLOSE, CHROME_REPEAT_OPEN, COMMENTS_EXPORT_FORMAT, COMPONENT_TYPES, CONTENTRAIN_BRANCH, CONTENTRAIN_DIR, DEFAULT_APPROVAL_POLICY, DICTIONARY_TITLE_FIELD, ENTRY_ID_PATTERN, EXECUTION_CONTRACT_VERSION, INTEGRATION_CATEGORIES, INTEGRATION_EVIDENCE_KINDS, LEGACY_CSS_LAYER, LIST_ITEMS_SLOT, LOCALE_PATTERN, LOCAL_CAPABILITIES, MIGRATE_ACCOUNT_STATES, MIGRATE_STUDIO_CLAIM_ALG, MIGRATE_STUDIO_CLAIM_AUDIENCE, MIGRATE_STUDIO_CLAIM_CLOCK_SKEW_SECONDS, MIGRATE_STUDIO_CLAIM_ISSUER, MIGRATE_STUDIO_CLAIM_MAX_TRIAL_DAYS, MIGRATE_STUDIO_CLAIM_MAX_TTL_SECONDS, MIGRATE_STUDIO_CLAIM_VERSION, MIGRATE_STUDIO_CLAIM_VERSION_2, MIGRATE_STUDIO_PLANS, MIGRATION_CONTRACT_VERSION, MODEL_EXTENSION_KEYS, MODEL_FIELD_ORDER, PAGE_BODY_KINDS, PATH_PATTERNS, PLAN_BEHAVIOR_REASON, PLAN_SECTION_RULE, PLAN_STARTER_FEATURES, PLAN_TOKEN_ROLES, PLAN_VALUE_PATTERN, PROJECT_PLAN_FORMAT, RAW_MARK_SUFFIX, RESERVED_PATHS, RISK_CLASSES, RUN_STATUSES, SCHEDULE_KINDS, SECRET_PATTERNS, SEO_PROVIDERS, SLUG_PATTERN, SOURCE_ACCESS_LADDER, SOURCE_DELTA_OPS, TERMINAL_RUN_STATUSES, TEXT_CANDIDATE_KINDS, TEXT_EXCLUDE_REASONS, TITLE_FIELD_TYPES, approversFor, canonicalStringify, commentsExportSource, componentSlot, computePlanHash, conflictId, describeModelLocaleScope, detectSecrets, effectiveRisk, evaluateApproval, fieldDepth, footerMenusOf, generateEntryId, highestRisk, isMediaType, isMigrateStudioClaim, isRepoRelativePath, isReservedPath, isStoredMediaPath, isTerminalRunStatus, isTitleFieldType, looksLikeCredential, orderedFieldNames, parseFrontmatterScalar, parseFrontmatterScalarString, parseMarkdownFrontmatter, planHashPayload, requiredApprovals, resolveFieldLabel, resolveModelLocales, rewriteEntryMedia, rewriteFieldMedia, rewriteMarkdownMedia, rewriteMediaUrl, riskRank, sectionFieldName, serializeMarkdownFrontmatter, sortKeys, splitFrontmatterList, stableHash, titleFieldTarget, titleFieldValue, toDeliveryUrl, validateAccept, validateEntryId, validateFieldValue, validateHandoffCommentsExport, validateLocale, validateMigrateAccountStateRequest, validateMigrateAccountStateResponse, validateMigrateStudioClaim, validateMigrateStudioClaimAny, validateMigrateStudioClaimV2, validateModelLocales, validateProjectPlan, validateSemanticType, validateSlug };
 
 //# sourceMappingURL=index.mjs.map