@ryusenkei/maezae 0.1.0 → 0.3.0

package/README.md

@@ -10,6 +10,9 @@ maezae の SDK（導入先のサイト向け）
 | `@ryusenkei/maezae/body` | 本文のブロックの型と描画の補助 |
 | `@ryusenkei/maezae/model` | コンテンツスキーマの型・ページのパス・画像の切り抜き |
 | `@ryusenkei/maezae/preview` | プレビューと下書きの取得の署名（ヘッダー `x-preview-signature`） |
+| `@ryusenkei/maezae/analytics` | サイトの閲覧の記録（CMS の閲覧数の集計と同じ形式） |
+| `@ryusenkei/maezae/trace` | CMS のログと相関を取るトレースの区間 |
+| `@ryusenkei/maezae/integrations` | 外の関数・Webhook が受け取る本文の型と署名の検証（ヘッダー `x-cms-signature`） |
 
 ## 取得（Cloudflare Workers の service binding）
 
@@ -35,3 +38,14 @@ import { SIGNED_HEADERS, verifyRequest } from '@ryusenkei/maezae/preview';
 
 const isPreview = await verifyRequest(env.PREVIEW_TOKEN, request, { header: SIGNED_HEADERS.preview });
 ```
+
+## 外の関数・Webhook の受け手
+
+- 鍵: 媒体の管理画面の「設定 → 連携」の登録ごとの署名の鍵
+
+```ts
+import { type PublishCheckRequest, SIGNED_HEADERS, verifyRequest } from '@ryusenkei/maezae/integrations';
+
+if (!(await verifyRequest(env.CMS_FUNCTION_SECRET, request, { header: SIGNED_HEADERS.outbound }))) return new Response(null, { status: 401 });
+const body = (await request.json()) as PublishCheckRequest;
+```

package/dist/analytics.d.ts

@@ -0,0 +1 @@
+export * from './types/sdk/src/analytics.js';

package/dist/analytics.js

@@ -0,0 +1,33 @@
+// ../analytics/src/day.ts
+/** 時間帯 timeZone での日付（YYYY-MM-DD、例: timeZone は Asia/Tokyo） */
+const dayIn = (timeZone, at = /* @__PURE__ */ new Date()) => new Intl.DateTimeFormat("en-CA", {
+	timeZone,
+	year: "numeric",
+	month: "2-digit",
+	day: "2-digit"
+}).format(at);
+// ../analytics/src/record.ts
+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, tenant }) {
+	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;
+	const path = new URL(request.url).pathname;
+	const { kind, id } = classify(path);
+	try {
+		dataset.writeDataPoint({
+			blobs: [
+				kind,
+				id,
+				path,
+				dayIn(timeZone),
+				"view",
+				tenant ?? ""
+			],
+			indexes: [tenant ?? kind]
+		});
+	} catch {}
+}
+export { recordView };

package/dist/body.d.ts

@@ -1,24 +1 @@
-import { a as ComponentBlock, c as InlineComponent, d as ListItem, f as Mark, h as Text, i as Body, l as Link, m as StandardBlock, o as HeadingLevel, p as Rich, r as Block, s as Inline, t as blockSchemaOf, u as List } from "./index-D11fUsoi.js";
-/** meta description の長さの上限（検索結果で省略されにくい字数の目安） */
-export declare const DESCRIPTION_MAX = 120;
-/**
- * 説明を meta description の長さに調整
- * - 上限を超える場合: 上限までの最後の句点まで
- * - 句点がない場合: 上限で切って省略の記号
- */
-export declare function descriptionOf(excerpt: string, max?: number): string;
-/** 読了時間の既定の分速（字/分） */
-export declare const READING_SPEED = 500;
-/** 断片の列の文字（装飾・リンクは文字、インラインのコンポーネントは中の文字） */
-export declare const plainOf: (rich: Rich) => string;
-/** 本文の注が参照する出典の ID（出現の順、重複あり） */
-export declare function citesOf<M>(body: Body<M>): string[];
-/** 本文の導入の文字（最初の見出しまでの段落をつなげたもの、導入がなければ空） */
-export declare function excerptOf<M>(body: Body<M>): string;
-/** 読了時間（分、本文の文字列の字数を分速 speed で割った概算、1分以上） */
-export declare const readMinOf: <M>(body: Body<M>, speed?: number) => number;
-/** 本文にあるサイト内へのリンク先（`/` で始まる href、重複なし） */
-export declare const linksOf: <M>(body: Body<M>) => string[];
-/** 本文のリンク先として許可する形か（保存の検査とサイトの出力で共通） */
-export declare const isSafeHref: (href: string) => boolean;
-export { type Block, type Body, type ComponentBlock, type HeadingLevel, type Inline, type InlineComponent, type Link, type List, type ListItem, type Mark, type Rich, type StandardBlock, type Text, blockSchemaOf };
+export * from './types/sdk/src/body.js';

package/dist/body.js

@@ -1,3 +1,4 @@
+import { a as coreComponentOf, n as declaredPropsZod, r as CITE } from "./declared-9_jI3JXH.js";
 import { z } from "zod";
 // ../body/src/description.ts
 /** meta description の長さの上限（検索結果で省略されにくい字数の目安） */
@@ -13,224 +14,6 @@ function descriptionOf(excerpt, max = 120) {
 	const end = head.lastIndexOf("。");
 	return end > 0 ? head.slice(0, end + 1) : `${[...head].slice(0, max - 1).join("")}…`;
 }
-// ../body/src/library.ts
-/** 注のコンポーネントの名前（本文からの算出 citesOf が参照） */
-const CITE = "cite";
-const https = z.string().regex(/^https:\/\//, "URL は https://");
-const caption = z.string().min(1, "注記が未入力");
-const datum = z.object({
-	label: z.string(),
-	value: z.number()
-});
-const color = z.union([
-	z.literal(1),
-	z.literal(2),
-	z.literal(3),
-	z.literal(4),
-	z.literal(5),
-	z.literal(6),
-	z.literal(7),
-	z.literal(8)
-]);
-const chart = z.union([
-	z.object({
-		chart: z.literal("bar"),
-		data: z.array(datum),
-		unit: z.string(),
-		color: color.optional(),
-		caption
-	}),
-	z.object({
-		chart: z.literal("line"),
-		labels: z.array(z.string()),
-		series: z.array(z.object({
-			name: z.string(),
-			values: z.array(z.number())
-		})),
-		unit: z.string(),
-		caption
-	}),
-	z.object({
-		chart: z.literal("pie"),
-		data: z.array(datum),
-		unit: z.string(),
-		caption
-	}),
-	z.object({
-		chart: z.literal("heat"),
-		cols: z.array(z.string()),
-		rows: z.array(z.object({
-			label: z.string(),
-			values: z.array(z.number())
-		})),
-		unit: z.string(),
-		color: color.optional(),
-		caption
-	})
-]);
-const optional = (attrs, keys) => Object.fromEntries(keys.filter((k) => attrs[k] !== void 0).map((k) => [k, attrs[k]]));
-const plain = (rich) => rich.map((i) => typeof i === "string" ? i : "text" in i ? i.text ?? "" : "").join("");
-/** 核のコンポーネント（chart の Markdown は既定の JSON） */
-const CORE_COMPONENTS = [
-	{
-		name: CITE,
-		inline: true,
-		description: "注（出典の ID を参照、出典は記事に結び付けが必要）",
-		example: ":cite{#出典の ID}",
-		props: () => z.object({ id: z.string().min(1, "注の出典が未入力") })
-	},
-	{
-		name: "pending",
-		inline: true,
-		description: "未定の値（方針のページで値が決まっていない箇所）",
-		example: ":pending[未定]",
-		props: () => z.object({})
-	},
-	{
-		name: "speech",
-		description: "発言（会話の一言を大きく引く、1段落）",
-		example: ":::speech\n大きく引く一言\n:::",
-		markdown: {
-			to: (p) => ({ content: [{
-				type: "paragraph",
-				content: [p.text]
-			}] }),
-			from: (_, content) => ({ text: content[0]?.type === "paragraph" ? plain(content[0].content) : "" })
-		},
-		props: () => z.object({ text: z.string().min(1, "発言が未入力") })
-	},
-	{
-		name: "chart",
-		description: "グラフ（中は JSON、chart は bar・line・pie・heat、caption は必須）",
-		example: ":::chart\n```json\n{\"chart\": \"bar\", \"unit\": \"%\", \"data\": [{\"label\": \"A\", \"value\": 40}], \"caption\": \"説明\"}\n```\n:::",
-		props: () => chart
-	},
-	{
-		name: "diagram",
-		description: "図（中は Mermaid、alt は図の内容の説明、caption は必須）",
-		example: ":::diagram{alt=\"内容の説明\" caption=\"説明\"}\n```mermaid\nflowchart LR\n  A --> B\n```\n:::",
-		markdown: {
-			to: (p) => ({
-				attributes: {
-					alt: p.alt,
-					caption: p.caption
-				},
-				content: [{
-					type: "code",
-					lang: "mermaid",
-					code: p.source
-				}]
-			}),
-			from: (attrs, content) => ({
-				source: content[0]?.type === "code" ? content[0].code : "",
-				alt: attrs.alt ?? "",
-				caption: attrs.caption ?? ""
-			})
-		},
-		props: () => z.object({
-			source: z.string().min(1, "図の記法が未入力"),
-			alt: z.string().min(1, "図の代替テキストが未入力"),
-			caption
-		})
-	},
-	{
-		name: "gallery",
-		description: "複数の画像を2列で配置（画像は2枚以上）",
-		example: ":::gallery\n![](asset/<画像の ID> \"説明\")\n\n![](asset/<画像の ID> \"説明\")\n:::",
-		markdown: {
-			to: (p) => ({ content: p.items.map((i) => ({
-				type: "image",
-				media: i.media,
-				...i.caption ? { caption: i.caption } : {}
-			})) }),
-			from: (_, content) => ({ items: content.flatMap((b) => b.type === "image" ? [{
-				media: b.media,
-				...b.caption ? { caption: b.caption } : {}
-			}] : []) })
-		},
-		props: (media) => z.object({ items: z.array(z.object({
-			media,
-			caption: z.string().optional()
-		})).min(2, "ギャラリーの画像は2枚以上") })
-	},
-	{
-		name: "link-card",
-		description: "外部リンクのカード（https のみ、site・desc・画像は任意）",
-		example: ":::link-card{href=\"https://…\" title=\"ページの題\" site=\"サイト名\" desc=\"説明\"}\n:::",
-		markdown: {
-			to: (p) => {
-				const { href, title, site, desc, image } = p;
-				return {
-					attributes: {
-						href,
-						title,
-						...site ? { site } : {},
-						...desc ? { desc } : {}
-					},
-					content: image ? [{
-						type: "image",
-						media: image
-					}] : []
-				};
-			},
-			from: (attrs, content) => ({
-				href: attrs.href,
-				title: attrs.title,
-				...optional(attrs, ["site", "desc"]),
-				...content[0]?.type === "image" ? { image: content[0].media } : {}
-			})
-		},
-		props: (media) => z.object({
-			href: https,
-			title: z.string().min(1, "リンクのタイトルが未入力"),
-			site: z.string().optional(),
-			desc: z.string().optional(),
-			image: media.optional()
-		})
-	},
-	{
-		name: "links",
-		description: "外部リンクの一覧（1件1行、リンクの title はサイト名、label は小見出しで既定は「参考」）",
-		example: ":::links{label=\"参考\"}\n- [ページの題](https://… \"サイト名\")\n:::",
-		markdown: {
-			to: (p) => {
-				const { label, items } = p;
-				const content = [{
-					type: "list",
-					items: items.map((i) => ({ content: [{
-						text: i.title,
-						link: {
-							href: i.href,
-							...i.site ? { title: i.site } : {}
-						}
-					}] }))
-				}];
-				return {
-					attributes: label ? { label } : void 0,
-					content
-				};
-			},
-			from: (attrs, content) => ({
-				...optional(attrs, ["label"]),
-				items: content[0]?.type === "list" ? content[0].items.flatMap((i) => i.content.flatMap((x) => typeof x !== "string" && "link" in x && x.link ? [{
-					href: x.link.href,
-					title: x.text,
-					...x.link.title ? { site: x.link.title } : {}
-				}] : [])) : []
-			})
-		},
-		props: () => z.object({
-			label: z.string().optional(),
-			items: z.array(z.object({
-				href: https,
-				title: z.string().min(1, "リンクのタイトルが未入力"),
-				site: z.string().optional()
-			}))
-		})
-	}
-];
-/** 名前から核のコンポーネント（なければ undefined） */
-const coreComponentOf = (name) => CORE_COMPONENTS.find((c) => c.name === name);
 // ../body/src/derive.ts
 /** 読了時間の既定の分速（字/分） */
 const READING_SPEED = 500;
@@ -412,42 +195,61 @@ const text = z.object({
 	marks: z.array(z.enum(MARKS)).optional(),
 	link: link.optional()
 });
-const inlineComponent = z.object({
+/** 部品の props の検査（名前で核のコンポーネント、なければ宣言した部品、どちらもないか種類が違えば null） */
+function propsOf(name, inline, media, declared) {
+	const core = coreComponentOf(name);
+	if (core) return Boolean(core.inline) === inline ? core.props(media) : null;
+	const d = declared.find((c) => c.name === name);
+	return d && Boolean(d.inline) === inline ? declaredPropsZod(d) : null;
+}
+const inlineComponentOf = (declared) => z.object({
 	component: z.string().min(1),
 	props: z.record(z.string(), z.string()).optional(),
 	text: z.string().optional()
 }).superRefine((c, ctx) => {
-	const def = coreComponentOf(c.component);
-	if (!def?.inline) return void ctx.addIssue({
+	const props = propsOf(c.component, true, z.never(), declared);
+	if (!props) return void ctx.addIssue({
 		code: "custom",
 		message: `インラインのコンポーネント ${c.component} はない`
 	});
-	const r = def.props(z.never()).safeParse(c.props ?? {});
+	const r = props.safeParse(c.props ?? {});
 	if (!r.success) for (const issue of r.error.issues) ctx.addIssue({
 		code: "custom",
 		message: issue.message,
 		path: ["props", ...issue.path]
 	});
 });
-const inline = z.union([
-	z.string(),
-	inlineComponent,
-	text
-]);
-const richOf = (cites) => z.array(inline).transform((items) => cites ? items.flatMap((item) => typeof item === "string" ? liftCites(item) : [item]) : items);
+/** インラインの1要素（component を持つ要素は部品としてだけ検査、union で文字の形に落ちて部品の検査を素通りしないため） */
+function inlineItemOf(declared) {
+	const component = inlineComponentOf(declared);
+	const plain = z.union([z.string(), text]);
+	return z.unknown().transform((value, ctx) => {
+		const r = (typeof value === "object" && value !== null && "component" in value ? component : plain).safeParse(value);
+		if (r.success) return r.data;
+		for (const issue of r.error.issues) ctx.addIssue({
+			code: "custom",
+			message: issue.message,
+			path: issue.path
+		});
+		return z.NEVER;
+	});
+}
+const richOf = (cites, declared) => z.array(inlineItemOf(declared)).transform((items) => cites ? items.flatMap((item) => typeof item === "string" ? liftCites(item) : [item]) : items);
 const variant = z.string().optional();
-/** 本文の1ブロックの検査（profile は本文の設定、media は画像の参照の検査） */
-function blockSchemaOf(profile, media) {
-	const rich = richOf(profile.components.includes(CITE));
-	const list = z.lazy(() => z.object({
+/** 本文の1ブロックの検査（profile は本文の設定、media は画像の参照の検査、declared は導入先が宣言した部品） */
+function blockSchemaOf(profile, media, declared = []) {
+	const rich = richOf(profile.components.includes(CITE), declared);
+	const list = z.object({
 		type: z.literal("list"),
 		ordered: z.boolean().optional(),
 		items: z.array(z.object({
 			content: rich,
-			children: list.optional()
+			get children() {
+				return list.optional();
+			}
 		})),
 		variant
-	}));
+	});
 	const heading = z.object({
 		type: z.literal("heading"),
 		level: z.union([
@@ -462,7 +264,7 @@ function blockSchemaOf(profile, media) {
 		id: z.string().optional(),
 		variant
 	});
-	return z.union([
+	return z.discriminatedUnion("type", [
 		z.object({
 			type: z.literal("paragraph"),
 			content: rich,
@@ -513,15 +315,15 @@ function blockSchemaOf(profile, media) {
 	]).transform((block, ctx) => {
 		let out = block;
 		if (out.type === "component") {
-			const def = coreComponentOf(out.name);
-			if (!def || def.inline) {
+			const props = propsOf(out.name, false, media, declared);
+			if (!props) {
 				ctx.addIssue({
 					code: "custom",
 					message: `コンポーネント ${out.name} はない`
 				});
 				return z.NEVER;
 			}
-			const r = def.props(media).safeParse(out.props);
+			const r = props.safeParse(out.props);
 			if (!r.success) {
 				for (const issue of r.error.issues) ctx.addIssue({
 					code: "custom",