@ryusenkei/maezae 0.18.0 → 0.19.0

package/README.md

@@ -13,6 +13,7 @@ maezae の SDK（導入先のサイト向け）
 | `@ryusenkei/maezae/analytics` | サイトの閲覧の記録（CMS の閲覧数の集計と同じ形式） |
 | `@ryusenkei/maezae/trace` | CMS のログと相関を取るトレースの区間 |
 | `@ryusenkei/maezae/integrations` | 外の関数・Webhook が受け取る本文の型と署名の検証（ヘッダー `x-cms-signature`） |
+| `@ryusenkei/maezae/schema` | 配信 API の値の型の定義の生成とずれの検査（CLI `maezae-types`、Node） |
 
 ## 取得（Cloudflare Workers の service binding）
 
@@ -131,6 +132,36 @@ try {
 }
 ```
 
+## スキーマを取る口（0.19.0 から）
+
+スキーマの正本は CMS。サイトは `schema.json` の写しを置かず、次の3つに分ける
+
+| 値 | 置き場所 | 取り方 |
+| --- | --- | --- |
+| コードが前提にする形（型の id、項目の key と種類、複数か、選択肢の値） | リポに置く生成のファイル | `maezae-types` で生成し、`--check` でずれを止める |
+| 編集で変わる値（表示名、文字数の上限、URL の形） | 置かない | 実行時に `GET /content/v1/types` を読み、`optionLabels`・`limitOf`・`pagePath`（`@ryusenkei/maezae/delivery`）に渡す |
+| 本文の設定と部品の宣言 | 置かない | CMS が保存のときに検査する。知らない部品は描画しない |
+
+```sh
+# 生成（API の鍵は MAEZAE_API_KEY、URL は --url か MAEZAE_DELIVERY_URL）
+npx maezae-types --out src/cms-types.ts --url https://example.com/<媒体>
+# ずれの検査（CI と pre-push。CMS で項目を足すと失敗し、生成し直してコミットする）
+npx maezae-types --out src/cms-types.ts --check
+```
+
+- 生成のファイル: 型ごとに `export type <PascalCase の型の id>`（`ItemOf` と同じ値の形）、全体の対応 `CmsTypes`、型の id の一覧 `TYPE_IDS`。表示名・上限・配信しない項目は含めないので、管理画面での表示名の変更ではずれにならない
+- 整形の対象から外す（`--check` は文字の一致で比べる。改行の CRLF は同じとみなす）
+- MCP の `get_schema` も同じ文を返す（`format: "typescript"`）。管理画面の「設定 → データ」の型定義のエクスポートも同じ文
+
+## 公開のフォーム（お問い合わせ）
+
+お問い合わせのモジュールを有効にした媒体は、toolkit の `@ryusenkei/web/form` の形でフォームを受け付ける
+
+- `GET /content/v1/forms/contact`: 項目の宣言 `{ form, label, fields, labels, choices }`。`fields` は web/form の宣言のまま（`parseForm` と画面の検査にそのまま渡せる）、`labels` は項目の名前、`choices` は選択肢の表示。ご用件と上限は CMS の設定から作るので、サイトは写しを持たない
+- `POST /content/v1/forms/contact`: 本文は項目の値の JSON。受け付けは `200 { ok: true, requestId, id }`（`id` は受付の番号、転送だけの設定は `null`）、検査の失敗は `400 { ok: false, error: "invalid", problems }`（文言は web/form の `FORM_MESSAGES_JA` で引く）
+- ボット対策と送信元ごとの回数の制限はサイトの受け取りの処理で行う（web/form の `submissionHandler` の `botCheck`・`rateLimiter`、CMS への転送は `httpDestination` に API の鍵を付ける）
+- 今の `POST /content/v1/contacts`（`201 { id }`）は導入先が移るまで残す
+
 ## 回数の制限
 
 - 対象は公開のエンドポイント（`https://api.maezae.app/<媒体>/content/v1/…`）だけ。上限は媒体と API の鍵ごとに1分で600回で、データセンターごとの近似で数える
@@ -243,7 +274,8 @@ if (body.hook === 'publish_check' && body.dryRun) problems.push(...(await verify
 
 - `event`: `submitted`（レビューの依頼）・`published`（公開）・`unpublished`（非公開）・`rejected`（差し戻し）。型は `type`（型の ID）で判断する（型の ID を変えても `event` は変わらない）
 - `id`: イベントの ID（再送しても同じ値、重複の除去に使用）、`item`: 行の ID と題、`by`: 操作した人の表示名、`at`: 出来事の日時
-- 拡張機能の出来事（例: お問い合わせの `contact.received`）: `{ version: 1, id, event: "contact.received", data, at }`（接頭辞はモジュールの ID で型の ID ではない）
+- 拡張機能の出来事: `{ version: 1, id, event, data, at }`（`event` は拡張機能が宣言した名前で、接頭辞は型の ID ではない）
+- 公開のフォームの送信（お問い合わせの `form.submitted`）: toolkit の `@ryusenkei/web/form` の `webhookDestination` と同じ `{ event: "form.submitted", id, form, values, order, receivedAt }`。`id` は送信ごとの UUID、`values` は項目の値（未入力の項目は含めない）、`order` は宣言の項目の順。署名は `x-cms-signature`
 - 購読: 管理画面の「設定 → 連携」で、送る出来事と対象の型を別々に選ぶ。編集の出来事は「選んだ出来事 × 選んだ型」で届く
 
 ```ts

package/dist/analytics.js

@@ -6,27 +6,43 @@ const dayIn = (timeZone, at = /* @__PURE__ */ new Date()) => new Intl.DateTimeFo
 	month: "2-digit",
 	day: "2-digit"
 }).format(at);
-// ../analytics/src/record.ts
+// ../analytics/src/view.ts
+/** 位置で持つ記録先の列の順 */
+const VIEW_COLUMNS = [
+	"kind",
+	"id",
+	"path",
+	"date",
+	"event",
+	"project"
+];
 const BOT = /bot|crawl|spider|slurp|preview|monitor|headless/i;
 /** ボットの UA か */
 const isBot = (userAgent) => BOT.test(userAgent ?? "");
-/** 閲覧を1件記録（対象: GET で応答が200の HTML・ボット以外、記録の失敗は無視） */
-function recordView(dataset, request, response, { classify, timeZone, project }) {
-	if (!dataset || request.method !== "GET" || response.status !== 200) return;
-	if (!response.headers.get("content-type")?.includes("text/html") || isBot(request.headers.get("user-agent"))) return;
+/** 閲覧の出来事（対象: GET で応答が200の HTML・ボット以外、ほかは null） */
+function viewOf(request, response, { classify, timeZone, project }) {
+	if (request.method !== "GET" || response.status !== 200) return null;
+	if (!response.headers.get("content-type")?.includes("text/html") || isBot(request.headers.get("user-agent"))) return null;
 	const path = new URL(request.url).pathname;
 	const { kind, id } = classify(path);
+	return {
+		kind,
+		id,
+		path,
+		date: dayIn(timeZone),
+		event: "view",
+		...project !== void 0 && { project }
+	};
+}
+// src/analytics.ts
+/** 閲覧を1件記録（対象: GET で応答が200の HTML・ボット以外、binding なしと記録の失敗は無視） */
+function recordView(dataset, request, response, options) {
+	const view = dataset && viewOf(request, response, options);
+	if (!view) return;
 	try {
 		dataset.writeDataPoint({
-			blobs: [
-				kind,
-				id,
-				path,
-				dayIn(timeZone),
-				"view",
-				project ?? ""
-			],
-			indexes: [project ?? kind]
+			blobs: VIEW_COLUMNS.map((key) => view[key] ?? ""),
+			indexes: [view.project ?? view.kind]
 		});
 	} catch {}
 }

package/dist/body.js

@@ -72,6 +72,32 @@ const SAFE_HREF = /^(?:https?:\/\/|mailto:|#|\/(?![/\\]))/i;
 const isSafeHref = (href) => SAFE_HREF.test(href);
 /** 許可しないリンク先の問題の文言 */
 const unsafeHrefMessage = (href) => `リンク先 ${href} は使えない（https://・http://・mailto:・/ で始まるサイト内のパス・# で始まるページ内のリンクだけ）`;
+// ../body/src/inline.ts
+/** 装飾の順序（外側から内側、Markdown と HTML の入れ子の順） */
+const MARK_ORDER = [
+	"strong",
+	"em",
+	"strike",
+	"underline",
+	"mark",
+	"sup",
+	"sub",
+	"code"
+];
+/** 装飾を MARK_ORDER の順に並べる（重複は1つ） */
+const sortMarks = (marks) => MARK_ORDER.filter((m) => marks?.includes(m));
+/** 装飾の描画の HTML の要素 */
+const MARK_HTML_TAGS = {
+	strong: "strong",
+	em: "em",
+	code: "code",
+	strike: "s",
+	mark: "mark",
+	sup: "sup",
+	sub: "sub",
+	underline: "u"
+};
+({ ...Object.fromEntries(Object.entries(MARK_HTML_TAGS).map(([mark, tag]) => [tag, mark])) });
 // ../body/src/profile.ts
 const MARK_LABELS = {
 	strong: "太字",
@@ -240,27 +266,6 @@ const ESCAPES = {
 };
 const esc = (s) => s.replace(/[&<>"']/g, (c) => ESCAPES[c]);
 const attrs = (pairs) => Object.entries(pairs).filter(([, v]) => v !== void 0 && v !== null && v !== false && v !== "").map(([k, v]) => ` ${k}="${esc(String(v))}"`).join("");
-const MARK_TAGS = {
-	strong: "strong",
-	em: "em",
-	code: "code",
-	strike: "s",
-	mark: "mark",
-	sup: "sup",
-	sub: "sub",
-	underline: "u"
-};
-/** 外側から内側の順 */
-const MARK_ORDER = [
-	"strong",
-	"em",
-	"strike",
-	"underline",
-	"mark",
-	"sup",
-	"sub",
-	"code"
-];
 const CSS_PROPERTY = {
 	color: "color",
 	background: "background-color",
@@ -294,7 +299,7 @@ function bodyToHtml(body, options) {
 		if (typeof i === "string") return esc(i).replaceAll("\n", "<br>");
 		if ("component" in i) return options.inlineComponent?.(i.component, i.props ?? {}, i.text ?? "") ?? esc(i.text ?? "");
 		let html = esc(i.text).replaceAll("\n", "<br>");
-		for (const m of [...MARK_ORDER].reverse()) if (i.marks?.includes(m)) html = `<${MARK_TAGS[m]}>${html}</${MARK_TAGS[m]}>`;
+		for (const m of sortMarks(i.marks).reverse()) html = `<${MARK_HTML_TAGS[m]}>${html}</${MARK_HTML_TAGS[m]}>`;
 		if (i.style) {
 			const a = styleAttr(i.style);
 			if (a) html = `<span${a}>${html}</span>`;

package/dist/client-ClY3gSSd.js

@@ -0,0 +1,137 @@
+// src/delivery/query.ts
+const isRecord = (v) => typeof v === "object" && v !== null && !Array.isArray(v);
+const OPS = [
+	"eq",
+	"ne",
+	"in",
+	"gte",
+	"lte",
+	"begins",
+	"exists"
+];
+/** in・ids の値の検査（コンマを含む値はクエリで区切れない） */
+const joined = (values) => {
+	const parts = values.map(String);
+	const bad = parts.find((p) => p.includes(","));
+	if (bad !== void 0) throw new Error(`in・ids の値にコンマは不可: ${bad}`);
+	return parts.join(",");
+};
+/** 一覧の指定をクエリの組に（find・get・subPath の params、一式の path に使用、1件の取得の fields にも使用） */
+function listParams(query) {
+	const params = {};
+	for (const [key, value] of Object.entries(query.filter ?? {})) {
+		if (value === void 0) continue;
+		if (!isRecord(value)) {
+			params[`filter[${key}]`] = String(value);
+			continue;
+		}
+		for (const op of OPS) if (value[op] !== void 0) params[`filter[${key}][${op}]`] = op === "in" ? joined(value[op]) : String(value[op]);
+	}
+	if (query.ids) params.ids = joined(query.ids);
+	if (query.fields?.length) params.fields = joined(query.fields);
+	if (query.order?.length) params.order = query.order.join(",");
+	if (query.limit !== void 0) params.limit = String(query.limit);
+	if (query.cursor) params.cursor = query.cursor;
+	return params;
+}
+// src/delivery/client.ts
+/** 配信 API のパスの前半 */
+const DELIVERY_PATH = "/content/v1";
+/** 配信 API の取得の失敗（call: 失敗した経路、status: 応答のステータス） */
+var DeliveryError = class extends Error {
+	call;
+	status;
+	constructor(call, status, body) {
+		super(`配信 API ${call}: ${status}${body ? ` ${body}` : ""}`);
+		this.name = "DeliveryError";
+		this.call = call;
+		this.status = status;
+	}
+};
+/** 配信 API の中のパスとクエリ（一式の path と結果のキー） */
+const subPath = (path, params = {}) => {
+	const q = new URLSearchParams(params).toString();
+	return `${path}${q ? `?${q}` : ""}`;
+};
+/**
+* 配信 API の読み取り
+* - drafts: 下書き・予約なども含める（プレビュー用、署名は接続の側で付与）
+* - at: 公開の基準の日時（なしは今）
+*/
+function createDeliveryClient(delivery, { drafts = false, at } = {}) {
+	const query = (params = {}) => new URLSearchParams({
+		...params,
+		...drafts ? { drafts: "1" } : {},
+		...at ? { at } : {}
+	});
+	const url = (path, params) => {
+		const q = query(params).toString();
+		return `${DELIVERY_PATH}${path}${q ? `?${q}` : ""}`;
+	};
+	let bundled = /* @__PURE__ */ new Map();
+	/** 取得（404は undefined、ほかの失敗は例外、一式で取得済みならその結果） */
+	const find = async (path, params = {}) => {
+		const hit = bundled.get(subPath(path, params));
+		if (hit) {
+			if (hit.status === 404) return void 0;
+			if (hit.status < 200 || hit.status >= 300) throw new DeliveryError(path, hit.status, JSON.stringify(hit.body));
+			return hit.body;
+		}
+		const res = await delivery(url(path, params));
+		if (res.status === 404) return void 0;
+		if (!res.ok) throw new DeliveryError(path, res.status, await res.text());
+		return await res.json();
+	};
+	/** 取得（404も例外） */
+	const get = async (path, params) => {
+		const v = await find(path, params);
+		if (v === void 0) throw new DeliveryError(path, 404, "");
+		return v;
+	};
+	/**
+	* 型の一覧の1ページ（path は型の一覧の経路、例: /post）
+	* - query: 絞り込み・並べ替えと limit、次のページは前の応答の next を cursor に
+	* - 一式で同じ path とクエリを取得済みならその結果（一式の path は `subPath(path, listParams(query))`）
+	*/
+	const page = (path, query) => get(path, listParams(query));
+	/**
+	* 経路の一覧を一式の1回で取得（paths は配信 API の中のパスとクエリ、`*` の区画は一覧の id ごとに展開）
+	* - ifNoneMatch: 前回の ETag（一致すれば notModified で、結果は未取得）
+	*/
+	const prefetch = async (paths, { ifNoneMatch } = {}) => {
+		const q = query();
+		for (const p of paths) q.append("path", p);
+		const res = await delivery(`${DELIVERY_PATH}/bundle?${q}`, ifNoneMatch ? { headers: { "if-none-match": ifNoneMatch } } : {});
+		if (res.status === 304) return {
+			notModified: true,
+			etag: ifNoneMatch ?? null,
+			stale: false,
+			partial: false
+		};
+		if (!res.ok) throw new DeliveryError("/bundle", res.status, await res.text());
+		const { results } = await res.json();
+		bundled = new Map(Object.entries(results));
+		return {
+			notModified: false,
+			etag: res.headers.get("etag"),
+			stale: res.headers.has("x-stale"),
+			partial: res.headers.has("x-partial")
+		};
+	};
+	/**
+	* 変更の一覧の1ページ（since は前回の next、null は全件の取得から）
+	* - 410（保存の期間を過ぎた cursor）は DeliveryError、since なしで取り直す
+	*/
+	const changes = (since, { limit } = {}) => get("/changes", {
+		...since ? { since } : {},
+		...limit !== void 0 ? { limit: String(limit) } : {}
+	});
+	return {
+		find,
+		get,
+		page,
+		prefetch,
+		changes
+	};
+}
+export { listParams as a, subPath as i, DeliveryError as n, createDeliveryClient as r, DELIVERY_PATH as t };

package/dist/delivery.js

@@ -1,3 +1,4 @@
+import { a as listParams, i as subPath, n as DeliveryError, r as createDeliveryClient, t as DELIVERY_PATH } from "./client-ClY3gSSd.js";
 import { a as optionsOf, l as cropRect, o as typeOf, p as createClock, t as pagePathOf, u as croppedHotspot } from "./page-BnwHL-LC.js";
 // src/delivery/cache.ts
 /** 保持した日時（ミリ秒）を置く内部のヘッダー */
@@ -106,142 +107,6 @@ async function readChanges(client, since, apply, { limit } = {}) {
 		if (!page.more) return cursor;
 	}
 }
-// src/delivery/query.ts
-const isRecord = (v) => typeof v === "object" && v !== null && !Array.isArray(v);
-const OPS = [
-	"eq",
-	"ne",
-	"in",
-	"gte",
-	"lte",
-	"begins",
-	"exists"
-];
-/** in・ids の値の検査（コンマを含む値はクエリで区切れない） */
-const joined = (values) => {
-	const parts = values.map(String);
-	const bad = parts.find((p) => p.includes(","));
-	if (bad !== void 0) throw new Error(`in・ids の値にコンマは不可: ${bad}`);
-	return parts.join(",");
-};
-/** 一覧の指定をクエリの組に（find・get・subPath の params、一式の path に使用、1件の取得の fields にも使用） */
-function listParams(query) {
-	const params = {};
-	for (const [key, value] of Object.entries(query.filter ?? {})) {
-		if (value === void 0) continue;
-		if (!isRecord(value)) {
-			params[`filter[${key}]`] = String(value);
-			continue;
-		}
-		for (const op of OPS) if (value[op] !== void 0) params[`filter[${key}][${op}]`] = op === "in" ? joined(value[op]) : String(value[op]);
-	}
-	if (query.ids) params.ids = joined(query.ids);
-	if (query.fields?.length) params.fields = joined(query.fields);
-	if (query.order?.length) params.order = query.order.join(",");
-	if (query.limit !== void 0) params.limit = String(query.limit);
-	if (query.cursor) params.cursor = query.cursor;
-	return params;
-}
-// src/delivery/client.ts
-/** 配信 API のパスの前半 */
-const DELIVERY_PATH = "/content/v1";
-/** 配信 API の取得の失敗（call: 失敗した経路、status: 応答のステータス） */
-var DeliveryError = class extends Error {
-	call;
-	status;
-	constructor(call, status, body) {
-		super(`配信 API ${call}: ${status}${body ? ` ${body}` : ""}`);
-		this.name = "DeliveryError";
-		this.call = call;
-		this.status = status;
-	}
-};
-/** 配信 API の中のパスとクエリ（一式の path と結果のキー） */
-const subPath = (path, params = {}) => {
-	const q = new URLSearchParams(params).toString();
-	return `${path}${q ? `?${q}` : ""}`;
-};
-/**
-* 配信 API の読み取り
-* - drafts: 下書き・予約なども含める（プレビュー用、署名は接続の側で付与）
-* - at: 公開の基準の日時（なしは今）
-*/
-function createDeliveryClient(delivery, { drafts = false, at } = {}) {
-	const query = (params = {}) => new URLSearchParams({
-		...params,
-		...drafts ? { drafts: "1" } : {},
-		...at ? { at } : {}
-	});
-	const url = (path, params) => {
-		const q = query(params).toString();
-		return `${DELIVERY_PATH}${path}${q ? `?${q}` : ""}`;
-	};
-	let bundled = /* @__PURE__ */ new Map();
-	/** 取得（404は undefined、ほかの失敗は例外、一式で取得済みならその結果） */
-	const find = async (path, params = {}) => {
-		const hit = bundled.get(subPath(path, params));
-		if (hit) {
-			if (hit.status === 404) return void 0;
-			if (hit.status < 200 || hit.status >= 300) throw new DeliveryError(path, hit.status, JSON.stringify(hit.body));
-			return hit.body;
-		}
-		const res = await delivery(url(path, params));
-		if (res.status === 404) return void 0;
-		if (!res.ok) throw new DeliveryError(path, res.status, await res.text());
-		return await res.json();
-	};
-	/** 取得（404も例外） */
-	const get = async (path, params) => {
-		const v = await find(path, params);
-		if (v === void 0) throw new DeliveryError(path, 404, "");
-		return v;
-	};
-	/**
-	* 型の一覧の1ページ（path は型の一覧の経路、例: /post）
-	* - query: 絞り込み・並べ替えと limit、次のページは前の応答の next を cursor に
-	* - 一式で同じ path とクエリを取得済みならその結果（一式の path は `subPath(path, listParams(query))`）
-	*/
-	const page = (path, query) => get(path, listParams(query));
-	/**
-	* 経路の一覧を一式の1回で取得（paths は配信 API の中のパスとクエリ、`*` の区画は一覧の id ごとに展開）
-	* - ifNoneMatch: 前回の ETag（一致すれば notModified で、結果は未取得）
-	*/
-	const prefetch = async (paths, { ifNoneMatch } = {}) => {
-		const q = query();
-		for (const p of paths) q.append("path", p);
-		const res = await delivery(`${DELIVERY_PATH}/bundle?${q}`, ifNoneMatch ? { headers: { "if-none-match": ifNoneMatch } } : {});
-		if (res.status === 304) return {
-			notModified: true,
-			etag: ifNoneMatch ?? null,
-			stale: false,
-			partial: false
-		};
-		if (!res.ok) throw new DeliveryError("/bundle", res.status, await res.text());
-		const { results } = await res.json();
-		bundled = new Map(Object.entries(results));
-		return {
-			notModified: false,
-			etag: res.headers.get("etag"),
-			stale: res.headers.has("x-stale"),
-			partial: res.headers.has("x-partial")
-		};
-	};
-	/**
-	* 変更の一覧の1ページ（since は前回の next、null は全件の取得から）
-	* - 410（保存の期間を過ぎた cursor）は DeliveryError、since なしで取り直す
-	*/
-	const changes = (since, { limit } = {}) => get("/changes", {
-		...since ? { since } : {},
-		...limit !== void 0 ? { limit: String(limit) } : {}
-	});
-	return {
-		find,
-		get,
-		page,
-		prefetch,
-		changes
-	};
-}
 // ../model/src/mediaUrl.ts
 /** 配信する形式と拡張子 */
 const EXTENSIONS = {

package/dist/dev.js

@@ -1,4 +1,4 @@
-import { i as SIGNED_HEADERS, s as signedHeaders } from "./src-C6YqllXw.js";
+import { i as SIGNED_HEADERS, s as signedHeaders } from "./src-BMOqN7Xs.js";
 import { createHash } from "node:crypto";
 import { existsSync, readFileSync } from "node:fs";
 import { createServer } from "node:http";
@@ -49,6 +49,11 @@ function relayDelivery({ origin, apiKey, previewSecret }) {
 		});
 	};
 }
+const DECODED_BODY_HEADERS = /* @__PURE__ */ new Set([
+	"content-encoding",
+	"content-length",
+	"transfer-encoding"
+]);
 /** 手元の配信 API のサーバー（/content/v1/… だけ、失敗は502、戻り値は origin と停止の関数） */
 async function serveDelivery(delivery, options = {}) {
 	const server = createServer(async (req, res) => {
@@ -67,7 +72,9 @@ async function serveDelivery(delivery, options = {}) {
 				...chunks.length ? { body: Buffer.concat(chunks).toString("utf8") } : {}
 			});
 			const out = {};
-			response.headers.forEach((v, k) => out[k] = v);
+			response.headers.forEach((v, k) => {
+				if (!DECODED_BODY_HEADERS.has(k)) out[k] = v;
+			});
 			res.writeHead(response.status, out);
 			res.end(Buffer.from(await response.arrayBuffer()));
 		} catch (e) {

package/dist/integrations.js

@@ -1,4 +1,4 @@
-import { a as openValue, i as SIGNED_HEADERS, l as verifyRequest } from "./src-C6YqllXw.js";
+import { a as openValue, i as SIGNED_HEADERS, l as verifyRequest } from "./src-BMOqN7Xs.js";
 import "./src-BrLwIWaT.js";
 // ../cms-contract/src/embeds.ts
 /** URL のクエリの名前（署名つきの文脈） */