@ryusenkei/maezae 0.9.0 → 0.11.0

package/README.md

@@ -21,6 +21,7 @@ maezae の SDK（導入先のサイト向け）
 - 鍵: 媒体の管理画面の「設定 → 連携」で発行した API の鍵
 - 1件の形: `{ id, ...項目, _meta: { created_at, updated_at, published_at } }`、published_at は公開の管理がある型だけ（0.7.0 から）
 - 一覧: 本文の種類の項目を含めない、本文は1件の取得か `/bundle` で
+- 契約の版: パス `/content/v1` と、すべての応答のヘッダー `x-cms-version: 1`。非互換の変更はバージョン（版）を上げて行う（#495）
 
 ```ts
 import { createDeliveryClient } from '@ryusenkei/maezae/delivery';
@@ -53,3 +54,71 @@ const body = (await request.json()) as PublishCheckRequest;
 ```
 
 - Webhook の重複: 失敗した送信は同じ本文で再送する。本文の `id`（イベントの ID）を処理済みとして保存し、同じ `id` は処理せずに 2xx を返す
+
+## Webhook の本文と契約の版
+
+本文の形は Webhook の登録ごとの契約の版（`version`）で決まる。非互換の変更はバージョン（版）を上げて行い、旧い版は受け手の移行の期間だけ残す（#495）
+
+| 版 | 対象の登録 | 編集の出来事の本文 |
+| --- | --- | --- |
+| 2（今の版） | 2026-11-12より後に作成した登録と、管理画面で版2に切り替えた登録 | `{ "version": 2, "id": "evt_…", "event": "published", "type": "column", "item": { "id": "…", "title": "…" }, "by": "…", "at": "…" }` |
+| 1（旧い版） | 2026-11-12より前に作成した登録（移し替えの後も版1のまま） | `{ "version": 1, "id": "evt_…", "event": "column.published", "type": "column", "item": {…}, "by": "…", "at": "…" }` |
+
+- `event`: `submitted`（レビューの依頼）・`published`（公開）・`unpublished`（非公開）・`rejected`（差し戻し）。型は `type` で判断する（型の ID を変えても受け手の分岐が切れない）
+- 拡張機能の出来事（例: お問い合わせの `contact.received`）: 版を問わず `{ version, id, event: "contact.received", data, at }`（接頭辞はモジュールの ID で型の ID ではないため、名前は変えない）
+- 購読: 管理画面の「設定 → 連携」で、送る出来事と対象の型を別々に選ぶ。編集の出来事は「選んだ出来事 × 選んだ型」で届く
+- 版1の廃止: 本番のすべての登録が版2になり、最後の切り替えから再送の期間（約55時間半）が過ぎた後。期限の目安は2027-01-31（延ばすときは #495に書く）
+- 版1の登録のまま型の ID を変えると、版1の `event`（`<型の ID>.<出来事>`）も変わる。型の ID の変更（#465）は受け手を版2に移してから行う
+
+### 受け手の移行（版1 → 版2）
+
+1. 受け手を両方の形で動くように直してデプロイ（下の例）。SDK を 0.11.0 以上にすると `WebhookBody` が2つの版の型になる
+2. 管理画面の「設定 → 連携」で Webhook を開き、「契約の版」を版2にして保存し、「テストの送信」で受け手の成功を確かめる
+3. 「送信の記録」で、切り替えの後の本物の出来事が成功していることを確かめる
+4. 3日（再送の期間の約55時間半を過ぎる）待ってから、受け手の版1の処理を消す。切り替えの前に失敗した送信の再送は、版1の形のまま届く
+
+```ts
+import type { WebhookBody } from '@ryusenkei/maezae/integrations';
+
+const body = (await request.json()) as WebhookBody;
+// 版2は event と type、版1は event の <型の ID>.<出来事> を分けて同じ形に
+const [type, event] = body.version === 2 ? [body.type, body.event] : [body.type, body.event.slice(body.event.lastIndexOf('.') + 1)];
+if (type === 'part' && event === 'published') await revalidatePart(body.item.id);
+```
+
+### microCMS の Webhook との対応
+
+キーの名前は maezae の語彙のまま（`type` を2つの意味で使わない）
+
+| microCMS | maezae（版2） | 備考 |
+| --- | --- | --- |
+| `service` | （なし） | 送信先の URL と署名の鍵が媒体ごと |
+| `api`（API のエンドポイント名） | `type`（型の ID） | |
+| `type`（`new`・`edit`・`delete`） | `event`（`submitted`・`published`・`unpublished`・`rejected`） | データの変更の出来事（作成・更新・削除）は #494の決定（3）で追加の予定 |
+| `id`（コンテンツ ID） | `item.id` | maezae の `id` はイベントの ID（重複の除去に使用） |
+| `contents`（前後の全内容） | `item`（ID と題） | 中身の選択は #494の決定（3）で追加の予定、今は配信 API で取得 |
+
+## 外の画面の受け手
+
+- 鍵: 媒体の管理画面の「設定 → 連携」の外の画面の登録ごとの署名の鍵
+
+```ts
+import { openEmbedContext } from '@ryusenkei/maezae/integrations';
+
+const context = await openEmbedContext(env.CMS_SCREEN_SECRET, request.url);
+if (!context) return new Response(null, { status: 401 });
+```
+
+## 署名の鍵の再発行（止めずに差し替える）
+
+- 対象: Webhook・外の関数・外の画面の登録ごとの鍵と、プレビューの署名の鍵
+- 移行の期間: 管理画面で「鍵を再発行」してから「古い鍵を失効」するまで、新旧の鍵の両方が有効
+  - Webhook・外の関数・プレビュー: CMS は署名のヘッダーに新旧の鍵の `v1` を並べる（新しい鍵が先、古い鍵が最後）
+  - 外の画面: クエリ `ctx` は古い鍵、`ctx_next` は新しい鍵で封印
+  - 古い SDK（0.10.0 より前）: 古い鍵の署名だけを照合するため、古い鍵のままなら移行の期間も通る
+- 導入先の手順
+  1. SDK を 0.10.0 以上にしてデプロイ（照合は `verifyRequest`、外の画面は `openEmbedContext`）
+  2. 管理画面で「鍵を再発行」し、表示された新しい鍵を受け手の秘密値（例: `CMS_FUNCTION_SECRET`）に設定してデプロイ
+  3. 管理画面の「送信の記録」で、差し替えの後の送信が成功していることを確かめる
+  4. 管理画面で「古い鍵を失効」
+- 受け手が新旧の鍵を並べて持つこともできる: `verifyRequest([env.NEW_SECRET, env.OLD_SECRET], request, …)`

package/dist/dev.js

@@ -1,4 +1,4 @@
-import { i as SIGNED_HEADERS, s as signedHeaders } from "./src-Baj-EC2G.js";
+import { i as SIGNED_HEADERS, s as signedHeaders } from "./src-C6YqllXw.js";
 import { createHash } from "node:crypto";
 import { existsSync, readFileSync } from "node:fs";
 import { createServer } from "node:http";

package/dist/integrations.js

@@ -1,8 +1,10 @@
-import { a as openValue, i as SIGNED_HEADERS, l as verifyRequest } from "./src-Baj-EC2G.js";
+import { a as openValue, i as SIGNED_HEADERS, l as verifyRequest } from "./src-C6YqllXw.js";
 import "./src-BrLwIWaT.js";
 // ../cms-contract/src/embeds.ts
 /** URL のクエリの名前（署名つきの文脈） */
 const EMBED_CONTEXT_PARAM = "ctx";
+/** URL のクエリの名前（鍵の移行の期間だけ、新しい鍵で封印した文脈） */
+const EMBED_CONTEXT_NEXT_PARAM = "ctx_next";
 /** postMessage の種類 */
 const EMBED_MESSAGES = {
 	ready: "maezae:ready",
@@ -13,4 +15,14 @@ const EMBED_MESSAGES = {
 // ../cms-contract/src/functions.ts
 /** 依頼する時点（save_check は型の保存前、publish_check は提出・公開の前の検査） */
 const FUNCTION_HOOKS = ["save_check", "publish_check"];
-export { EMBED_CONTEXT_PARAM, EMBED_MESSAGES, FUNCTION_HOOKS, SIGNED_HEADERS, openValue, verifyRequest };
+// src/integrations.ts
+/** 外の画面の URL の文脈（クエリ ctx と、鍵の移行の期間の ctx_next のどちらかが鍵で開けば文脈、なければ null） */
+async function openEmbedContext(secret, url, now = Date.now()) {
+	const params = new URL(url).searchParams;
+	for (const name of [EMBED_CONTEXT_NEXT_PARAM, "ctx"]) {
+		const context = await openValue(secret, params.get(name), now);
+		if (context) return context;
+	}
+	return null;
+}
+export { EMBED_CONTEXT_NEXT_PARAM, EMBED_CONTEXT_PARAM, EMBED_MESSAGES, FUNCTION_HOOKS, SIGNED_HEADERS, openEmbedContext, openValue, verifyRequest };

package/dist/preview.js

@@ -1 +1 @@
-export { i as SIGNED_HEADERS, o as signParts, s as signedHeaders, c as verifyParts, l as verifyRequest } from "./src-Baj-EC2G.js";
+export { i as SIGNED_HEADERS, o as signParts, s as signedHeaders, c as verifyParts, l as verifyRequest } from "./src-C6YqllXw.js";

package/dist/{src-Baj-EC2G.js → src-C6YqllXw.js}

@@ -56,23 +56,31 @@ async function messageOf(t, { method, url, body, subject }) {
 		digest
 	].join("\n"));
 }
-/** 署名のヘッダーの値（t=<秒>,v1=<署名>） */
+/** 鍵の一覧（空の値を除く） */
+const secretsOf = (secret) => (typeof secret === "string" ? [secret] : [...secret ?? []]).filter(Boolean);
+/** 署名のヘッダーの値（t=<秒>,v1=<署名>、鍵が複数なら v1 を鍵の順に並べる） */
 async function signParts(secret, parts, now = Date.now()) {
 	const t = Math.floor(now / 1e3);
-	const sig = await crypto.subtle.sign("HMAC", await hmacKey(secret), await messageOf(t, parts));
-	return `t=${t},v1=${base64Url(sig)}`;
+	const message = await messageOf(t, parts);
+	const sigs = await Promise.all(secretsOf(secret).map(async (s) => base64Url(await crypto.subtle.sign("HMAC", await hmacKey(s), message))));
+	return [`t=${t}`, ...sigs.map((sig) => `v1=${sig}`)].join(",");
 }
-/** 署名の照合（形の誤り・時刻のずれの超過・不一致は false） */
+/** 署名の照合（鍵のどれかと v1 のどれかが合えば true、形の誤り・時刻のずれの超過・不一致は false） */
 async function verifyParts(secret, header, parts, { now = Date.now(), maxSkewSec = MAX_SKEW_SEC } = {}) {
-	if (!secret || !header) return false;
-	const fields = Object.fromEntries(header.split(",").map((f) => f.trim().split("=", 2)));
-	const t = Number(fields.t);
-	if (!Number.isInteger(t) || !fields.v1 || Math.abs(now / 1e3 - t) > maxSkewSec) return false;
-	try {
-		return await crypto.subtle.verify("HMAC", await hmacKey(secret), decodeBase64Url(fields.v1), await messageOf(t, parts));
-	} catch {
-		return false;
+	const secrets = secretsOf(secret);
+	if (!secrets.length || !header) return false;
+	const fields = header.split(",").map((f) => f.trim().split("=", 2));
+	const t = Number(fields.find(([k]) => k === "t")?.[1]);
+	const sigs = fields.flatMap(([k, v]) => k === "v1" && v ? [v] : []);
+	if (!Number.isInteger(t) || !sigs.length || Math.abs(now / 1e3 - t) > maxSkewSec) return false;
+	const message = await messageOf(t, parts);
+	for (const s of secrets) {
+		const key = await hmacKey(s);
+		for (const sig of sigs) try {
+			if (await crypto.subtle.verify("HMAC", key, decodeBase64Url(sig), message)) return true;
+		} catch {}
 	}
+	return false;
 }
 /** 署名を付けたヘッダー（init のヘッダーに署名と主体を追加した新しい Headers） */
 async function signedHeaders(secret, { method, url, body, subject }, { header, subjectHeader, init, now }) {
@@ -86,10 +94,10 @@ async function signedHeaders(secret, { method, url, body, subject }, { header, s
 	}, now));
 	return headers;
 }
-/** リクエストの署名の照合（本文は複製から読み込み、元のリクエストの本文は残す） */
+/** リクエストの署名の照合（本文は複製から読み込み、元のリクエストの本文は残す、鍵の移行の期間は受け手が新旧の鍵を並べて渡せる） */
 async function verifyRequest(secret, request, { header, subjectHeader, now }) {
 	const value = request.headers.get(header);
-	if (!secret || !value) return false;
+	if (!secretsOf(secret).length || !value) return false;
 	const body = request.body ? await request.clone().arrayBuffer() : null;
 	return verifyParts(secret, value, {
 		method: request.method,
@@ -98,12 +106,15 @@ async function verifyRequest(secret, request, { header, subjectHeader, now }) {
 		subject: subjectHeader ? request.headers.get(subjectHeader) : null
 	}, now === void 0 ? {} : { now });
 }
-/** 封印した値（署名の不一致・期限切れ・形の誤りは null） */
+/** 封印した値（鍵のどれかで署名が合えば値、署名の不一致・期限切れ・形の誤りは null） */
 async function openValue(secret, token, now = Date.now()) {
 	const [body, sig] = token?.split(".") ?? [];
-	if (!secret || !body || !sig) return null;
+	const secrets = secretsOf(secret);
+	if (!secrets.length || !body || !sig) return null;
 	try {
-		if (!await crypto.subtle.verify("HMAC", await hmacKey(secret), decodeBase64Url(sig), enc.encode(body))) return null;
+		let matched = false;
+		for (const s of secrets) if (!matched) matched = await crypto.subtle.verify("HMAC", await hmacKey(s), decodeBase64Url(sig), enc.encode(body));
+		if (!matched) return null;
 		const { v, exp } = JSON.parse(new TextDecoder().decode(decodeBase64Url(body)));
 		return typeof exp === "number" && exp * 1e3 > now ? v : null;
 	} catch {

package/dist/trace.js

@@ -1 +1 @@
-export { r as TRACEPARENT_HEADER, t as sampleRateOf, n as withEdgeSpan } from "./src-Baj-EC2G.js";
+export { r as TRACEPARENT_HEADER, t as sampleRateOf, n as withEdgeSpan } from "./src-C6YqllXw.js";

package/dist/types/access/src/handoff.d.ts

@@ -0,0 +1,29 @@
+import type { LoginAuth } from './oidc.js';
+/** セッションの Cookie の名前（https は __Host- の接頭辞） */
+export declare const sessionCookieName: (url: URL) => string;
+/** セッションの Cookie の Set-Cookie の値（maxAgeSec が0は削除） */
+export declare const sessionCookie: (url: URL, value: string, maxAgeSec: number) => string;
+/** リクエストの Cookie の値（なければ null） */
+export declare const cookieValue: (request: Request, name: string) => string | null;
+/** セッションの値（なし・署名の不一致・期限切れは null） */
+export declare const openSession: <T>(request: Request, secret: string) => Promise<T | null>;
+/** 引き継ぎのログインの設定 */
+export type HandoffLoginOptions = Readonly<{
+    /** Cookie の署名の鍵 */
+    secret: string;
+    /** manage のログインの URL（例: https://example.com/manage/login） */
+    loginUrl: string;
+    /** トークンを消して使い、メールアドレスを返す（使えないトークンは null、host は CMS のホスト名） */
+    consume(token: string, host: string): Promise<string | null>;
+    /** 入り口のパスの頭（既定 /auth） */
+    basePath?: string;
+    /** セッションの秒数（既定は12時間） */
+    sessionTtlSec?: number;
+}>;
+/** manage からの引き継ぎのログイン */
+export declare function handoffLogin({ secret, loginUrl, consume, basePath, sessionTtlSec }: HandoffLoginOptions): LoginAuth;
+/**
+ * 2つのログインを順に試す（emailOf は first が null なら second、入り口とログアウトは first）
+ * - 用途: 引き継ぎのログインへの移行の間、Access の JWT も受け付ける
+ */
+export declare function eitherLogin(first: LoginAuth, second: LoginAuth): LoginAuth;

package/dist/types/access/src/index.d.ts

@@ -1,5 +1,6 @@
 export { accessJwtOptions, type FetchCerts, type JwtClaims, type JwtOptions, verifyAccessJwt, verifyJwt } from './jwt.js';
-export { emailOfClaims, type LoginAuth, oidcLogin, type OidcLoginOptions, tokenAuth, type TokenAuthOptions } from './oidc.js';
+export { cookieValue, eitherLogin, handoffLogin, type HandoffLoginOptions, openSession, sessionCookie, sessionCookieName } from './handoff.js';
+export { emailOfClaims, type LoginAuth, oidcLogin, type OidcLoginOptions, safeNext, tokenAuth, type TokenAuthOptions } from './oidc.js';
 export { type EdgeSpan, type EdgeSpanOptions, type EdgeSpanStatus, sampleRateOf, startEdgeSpan, withEdgeSpan } from './span.js';
-export { openValue, sealValue, SIGNED_HEADERS, signedHeaders, signParts, type SignedParts, verifyParts, verifyRequest, type VerifyRequestOptions } from './signed.js';
+export { openValue, sealValue, SIGNED_HEADERS, signedHeaders, type SigningSecrets, signParts, type SignedParts, verifyParts, verifyRequest, type VerifyRequestOptions } from './signed.js';
 export { childTraceContext, formatTraceparent, newSpanId, newTraceId, parseTraceparent, type TraceContext, TRACEPARENT_HEADER } from './traceparent.js';

package/dist/types/access/src/signed.d.ts

@@ -17,15 +17,17 @@ export type SignedParts = Readonly<{
     /** 主体（MCP のログインのメールアドレスなど、なしは空） */
     subject?: string | null;
 }>;
-/** 署名のヘッダーの値（t=<秒>,v1=<署名>） */
-export declare function signParts(secret: string, parts: SignedParts, now?: number): Promise<string>;
-/** 署名の照合（形の誤り・時刻のずれの超過・不一致は false） */
-export declare function verifyParts(secret: string, header: string | null | undefined, parts: SignedParts, { now, maxSkewSec }?: {
+/** 署名の鍵（1つか、移行の期間は新しい鍵を先・古い鍵を最後に並べた複数） */
+export type SigningSecrets = string | readonly string[];
+/** 署名のヘッダーの値（t=<秒>,v1=<署名>、鍵が複数なら v1 を鍵の順に並べる） */
+export declare function signParts(secret: SigningSecrets, parts: SignedParts, now?: number): Promise<string>;
+/** 署名の照合（鍵のどれかと v1 のどれかが合えば true、形の誤り・時刻のずれの超過・不一致は false） */
+export declare function verifyParts(secret: SigningSecrets | null | undefined, header: string | null | undefined, parts: SignedParts, { now, maxSkewSec }?: {
     now?: number;
     maxSkewSec?: number;
 }): Promise<boolean>;
 /** 署名を付けたヘッダー（init のヘッダーに署名と主体を追加した新しい Headers） */
-export declare function signedHeaders(secret: string, { method, url, body, subject }: SignedParts, { header, subjectHeader, init, now }: Readonly<{
+export declare function signedHeaders(secret: SigningSecrets, { method, url, body, subject }: SignedParts, { header, subjectHeader, init, now }: Readonly<{
     header: string;
     subjectHeader?: string;
     init?: HeadersInit;
@@ -39,9 +41,9 @@ export type VerifyRequestOptions = Readonly<{
     subjectHeader?: string;
     now?: number;
 }>;
-/** リクエストの署名の照合（本文は複製から読み込み、元のリクエストの本文は残す） */
-export declare function verifyRequest(secret: string | undefined, request: Request, { header, subjectHeader, now }: VerifyRequestOptions): Promise<boolean>;
+/** リクエストの署名の照合（本文は複製から読み込み、元のリクエストの本文は残す、鍵の移行の期間は受け手が新旧の鍵を並べて渡せる） */
+export declare function verifyRequest(secret: SigningSecrets | undefined, request: Request, { header, subjectHeader, now }: VerifyRequestOptions): Promise<boolean>;
 /** 期限と署名を付けた値（JSON にできる値、ttlSec は有効な秒数） */
 export declare function sealValue(secret: string, value: unknown, ttlSec: number, now?: number): Promise<string>;
-/** 封印した値（署名の不一致・期限切れ・形の誤りは null） */
-export declare function openValue<T = unknown>(secret: string, token: string | null | undefined, now?: number): Promise<T | null>;
+/** 封印した値（鍵のどれかで署名が合えば値、署名の不一致・期限切れ・形の誤りは null） */
+export declare function openValue<T = unknown>(secret: SigningSecrets, token: string | null | undefined, now?: number): Promise<T | null>;

package/dist/types/analytics/src/index.d.ts

@@ -1,4 +1,4 @@
 export { recordView, type Classify, type Dataset } from './record.js';
 export { syncCron } from './schedule.js';
-export { analyticsEngine, type DailyRow, fixedSource, type Source, projectDaily, type ProjectSource } from './source.js';
+export { analyticsEngine, type DailyRow, fixedSource, type Source, projectDaily, type ProjectSource, renamedSource } from './source.js';
 export { readDaily, syncDaily } from './store.js';

package/dist/types/analytics/src/source.d.ts

@@ -30,4 +30,6 @@ export type ProjectSource = {
 export declare function projectDaily(options: Omit<AnalyticsEngineOptions, 'project'>): ProjectSource;
 /** 集計済みの行の読み込み元（定期の集計で全媒体の問い合わせ結果を媒体ごとに受け渡し、daily は since 以降の行） */
 export declare const fixedSource: (rows: readonly DailyRow[]) => Source;
+/** 種類を付け替えた読み込み元（renames は旧の種類 → 今の種類、付け替えで重なった行は閲覧数を合計） */
+export declare function renamedSource(source: Source, renames: Readonly<Record<string, string>>): Source;
 export {};

package/dist/types/cms-contract/src/embeds.d.ts

@@ -2,7 +2,7 @@
 export declare const EMBED_PLACEMENTS: readonly ["panel"];
 /** 外の画面を表示する位置 */
 export type EmbedPlacement = (typeof EMBED_PLACEMENTS)[number];
-/** 外の画面の登録（secret は末尾だけを伏せずに返す） */
+/** 外の画面の登録（secret は末尾だけを伏せずに返す、previousSecret は鍵の移行の期間の古い鍵の末尾で期間の外は null） */
 export type ExternalScreen = Readonly<{
     id: string;
     label: string;
@@ -10,6 +10,7 @@ export type ExternalScreen = Readonly<{
     url: string;
     placement: EmbedPlacement;
     secret: string;
+    previousSecret: string | null;
     enabled: boolean;
 }>;
 /** 編集画面に置く外の画面（鍵なし、編集できるアカウントに返す） */
@@ -32,6 +33,8 @@ export type EmbedContext = Readonly<{
 }>;
 /** URL のクエリの名前（署名つきの文脈） */
 export declare const EMBED_CONTEXT_PARAM = "ctx";
+/** URL のクエリの名前（鍵の移行の期間だけ、新しい鍵で封印した文脈） */
+export declare const EMBED_CONTEXT_NEXT_PARAM = "ctx_next";
 /** 文脈の有効期間（秒） */
 export declare const EMBED_CONTEXT_TTL_SEC = 600;
 /** postMessage の種類 */

package/dist/types/cms-contract/src/errors.d.ts

@@ -57,7 +57,7 @@ export type ErrorCode = keyof typeof ERROR_STATUS;
  * - 型の対象: 型の id、表示名はスキーマ
  * - モジュールの対象: ModuleManifest の targets
  */
-export type ErrorTarget = 'request' | 'role' | 'media' | 'entry' | 'asset' | 'mcp' | 'version' | 'profile' | 'portrait' | 'extension' | 'account' | 'comment' | 'view' | 'webhook' | 'external_function' | 'external_screen' | 'api_key';
+export type ErrorTarget = 'request' | 'role' | 'media' | 'entry' | 'asset' | 'mcp' | 'version' | 'profile' | 'portrait' | 'extension' | 'account' | 'comment' | 'view' | 'webhook' | 'external_function' | 'external_screen' | 'api_key' | 'preview';
 /** エラーの補足の値（コードごとに使用する項目だけ） */
 export type ErrorParams = {
     /**

package/dist/types/cms-contract/src/functions.d.ts

@@ -6,7 +6,11 @@ export type FunctionHook = (typeof FUNCTION_HOOKS)[number];
 export declare const FUNCTION_HOOK_LABELS: Readonly<Record<FunctionHook, string>>;
 /** 時間切れ・失敗・不正な応答のときの扱い（block は保存・提出・公開を拒否、pass は通過） */
 export type FunctionOnError = 'block' | 'pass';
-/** 外の関数の登録（url・secret は末尾だけを伏せずに返す、lastStatus は最新の呼び出しで返った HTTP の状態、送れなかったときは0） */
+/**
+ * 外の関数の登録（url・secret は末尾だけを伏せずに返す）
+ * - previousSecret: 鍵の移行の期間の古い鍵の末尾、期間の外は null
+ * - lastStatus: 最新の呼び出しで返った HTTP の状態、送れなかったときは0
+ */
 export type ExternalFunction = Readonly<{
     id: string;
     label: string;
@@ -14,6 +18,7 @@ export type ExternalFunction = Readonly<{
     type: string;
     url: string;
     secret: string;
+    previousSecret: string | null;
     onError: FunctionOnError;
     enabled: boolean;
     lastStatus: number | null;

package/dist/types/cms-contract/src/index.d.ts

@@ -13,8 +13,9 @@ export { ADMIN_PERMISSIONS, ADMIN_ROLE, isAdmin, rolePermissionsOf, type Role, S
 export { isServerPath, OPS_PATHS, SERVER_PATHS } from './paths.js';
 export { CONFIG_FORMAT, type ConfigBundle, type ConfigPreview } from './transfer.js';
 export { IMPORT_ITEMS_MAX, IMPORT_PROBLEM_LABELS, IMPORT_PROBLEMS, type ImportIdChange, type ImportIdConflict, importIdOf, type ImportIdPlan, type ImportImage, type ImportItem, type ImportItemReport, type ImportProblem, type ImportProblemCode, type ImportReport, importReportOf, mergeImportReports, planImportIds, sourceOf } from './import.js';
-export { EMBED_CONTEXT_PARAM, EMBED_CONTEXT_TTL_SEC, EMBED_MESSAGES, EMBED_PLACEMENTS, type EmbedContext, type EmbedEntry, type EmbedMessage, type EmbedPlacement, type ExternalScreen } from './embeds.js';
+export { EMBED_CONTEXT_NEXT_PARAM, EMBED_CONTEXT_PARAM, EMBED_CONTEXT_TTL_SEC, EMBED_MESSAGES, EMBED_PLACEMENTS, type EmbedContext, type EmbedEntry, type EmbedMessage, type EmbedPlacement, type ExternalScreen } from './embeds.js';
 export { type ExternalFunction, FUNCTION_HOOK_LABELS, FUNCTION_HOOKS, functionEventLabel, functionEventOf, type FunctionHook, type FunctionOnError, type FunctionRequest, type PublishCheckRequest, type PublishCheckResponse, type SaveCheckRequest, type SaveCheckResponse } from './functions.js';
-export { parseWebhookEvent, type Webhook, WEBHOOK_ACTION_LABELS, type WebhookBody, WEBHOOK_ACTIONS, type WebhookAction, type WebhookDelivery, type WebhookEvent, webhookEventLabel, webhookEventOf, type WebhookKind } from './webhooks.js';
+export { isWebhookAction, parseWebhookEvent, type Webhook, WEBHOOK_ACTION_LABELS, type WebhookBody, type WebhookBodyV1, type WebhookBodyV2, WEBHOOK_ACTIONS, type WebhookAction, type WebhookDelivery, type WebhookEvent, webhookEventLabel, webhookEventOf, type WebhookKind, type WebhookModuleBody, type WebhookSubscription, webhookSubscriptionLabel, WEBHOOK_VERSION, WEBHOOK_VERSIONS, type WebhookVersion } from './webhooks.js';
+export { CONTRACT_VERSION_HEADER, DELIVERY_VERSION } from './versions.js';
 export { type SavedView, VIEW_ACTIONS, type ViewAction, type ViewDefinition } from './views.js';
 export { canManageSettings, isSettingsTarget, managedAreasOf, SETTINGS_AREA_LABELS, SETTINGS_AREAS, type SettingsArea, settingsTarget } from './settings.js';

package/dist/types/cms-contract/src/modules.d.ts

@@ -56,6 +56,8 @@ export type ModuleManifest<S = Readonly<Record<string, never>>> = Readonly<{
     settingFields?: readonly SettingField[];
     /** フィールドの宣言（設定値から作成、例: 種類で決まる名義） */
     fieldRules?(settings: S): readonly FieldRule[];
+    /** 型の id を値に持つ設定値のキー（型の id の変更で書き換え、値は id の文字列か配列） */
+    typeSettings?: readonly string[];
     /** 拡張機能が送る Webhook の出来事（キーは出来事の名前 <対象>.<操作>、値は表示名、設定の「連携」で選択） */
     webhookEvents?: Readonly<Record<string, string>>;
 }>;
@@ -91,6 +93,7 @@ export type ModuleBase = Readonly<{
     fieldRules: readonly FieldRule[];
     messages: TargetMessages;
     webhookEvents: Readonly<Record<string, string>>;
+    typeSettings: readonly string[];
 }>;
 /** 組み立てたモジュール（共通の定義と、側ごとの内容） */
 export type ModuleInstance<P> = ModuleBase & P;

package/dist/types/cms-contract/src/transfer.d.ts

@@ -29,8 +29,12 @@ export type ConfigBundle = Readonly<{
 }>;
 /** スキーマと設定の読み込みの確認（schema はスキーマの変更、ほかは追加と更新の件数） */
 export type ConfigPreview = Readonly<{
+    /** kind は変更の種類、type は型の id、value は型の id の変更の旧の id（型の id の変更の候補の選択に使用） */
     schema: readonly Readonly<{
         id: string;
+        kind: string;
+        type: string;
+        value?: string;
         level: 'safe' | 'confirm' | 'forbidden';
         message: string;
         count: number | null;

package/dist/types/cms-contract/src/versions.d.ts

@@ -0,0 +1,4 @@
+/** 配信 API の版（パス /content/v1） */
+export declare const DELIVERY_VERSION = 1;
+/** 配信 API の応答で契約の版を示すヘッダー */
+export declare const CONTRACT_VERSION_HEADER = "x-cms-version";

package/dist/types/cms-contract/src/webhooks.d.ts

@@ -2,39 +2,75 @@
 export declare const WEBHOOK_ACTIONS: readonly ["submitted", "published", "unpublished", "rejected"];
 /** 送れる操作 */
 export type WebhookAction = (typeof WEBHOOK_ACTIONS)[number];
-/** 送れる出来事（編集機能を持つ型の <型の id>.<操作> と、拡張機能が宣言した出来事） */
+/** Webhook の契約の版（1は旧い形、2は今の形） */
+export declare const WEBHOOK_VERSIONS: readonly [1, 2];
+/** Webhook の契約の版 */
+export type WebhookVersion = (typeof WEBHOOK_VERSIONS)[number];
+/** 新しい登録の版（今の版） */
+export declare const WEBHOOK_VERSION: WebhookVersion;
+/** サーバーの内側の出来事のキー（編集の出来事は <型の id>.<操作>、拡張機能の出来事は宣言の名前） */
 export type WebhookEvent = `${string}.${string}`;
+/** 購読する出来事（操作か拡張機能の出来事の名前） */
+export type WebhookSubscription = WebhookAction | WebhookEvent;
 /** 操作の表示名（画面の選択肢と、Slack の文） */
 export declare const WEBHOOK_ACTION_LABELS: Readonly<Record<WebhookAction, string>>;
-/** 型と操作の出来事 */
+/** 送れる操作か */
+export declare const isWebhookAction: (value: string) => value is WebhookAction;
+/** 型と操作の出来事のキー */
 export declare const webhookEventOf: (type: string, action: WebhookAction) => WebhookEvent;
-/** 出来事の型と操作（形が不正なら null） */
+/** 出来事のキーの型と操作（編集の出来事でなければ null） */
 export declare function parseWebhookEvent(event: string): Readonly<{
     type: string;
     action: WebhookAction;
 }> | null;
-/** 出来事の表示名（types は型の id と表示名で型の表示名と操作の表示名、moduleEvents は拡張機能の出来事の表示名） */
+/** 出来事のキーの表示名（types は型の id と表示名で型の表示名と操作の表示名、moduleEvents は拡張機能の出来事の表示名） */
 export declare function webhookEventLabel(event: string, types: Readonly<Record<string, string>>, moduleEvents?: Readonly<Record<string, string>>): string;
+/** 購読する出来事の表示名（操作か拡張機能の出来事） */
+export declare const webhookSubscriptionLabel: (subscription: string, moduleEvents?: Readonly<Record<string, string>>) => string;
 /** Webhook の形式 */
 export type WebhookKind = 'json' | 'slack';
-/** Webhook（url・secret は末尾だけを伏せずに返す、secret の null は署名なし、lastStatus は最新の送信で返った HTTP の状態、送れなかったときは0） */
+/**
+ * Webhook（url・secret は末尾だけを伏せずに返す、secret の null は署名なし）
+ * - version: 契約の版（本文の形）
+ * - events: 購読する出来事（操作と拡張機能の出来事）、types: 購読する型の id（編集の出来事は events の操作 × types）
+ * - previousSecret: 鍵の移行の期間の古い鍵の末尾、期間の外は null
+ * - lastStatus: 最新の送信で返った HTTP の状態、送れなかったときは0
+ */
 export type Webhook = Readonly<{
     id: string;
     label: string;
     kind: WebhookKind;
     url: string;
     secret: string | null;
-    events: readonly WebhookEvent[];
+    previousSecret: string | null;
+    version: WebhookVersion;
+    events: readonly WebhookSubscription[];
+    types: readonly string[];
     enabled: boolean;
     lastStatus: number | null;
     lastAt: string | null;
 }>;
 /**
- * json の形式の本文（編集機能を持つ型の出来事、署名はヘッダー x-cms-signature で登録ごとの鍵）
+ * json の形式の本文の版2（編集機能を持つ型の出来事、署名はヘッダー x-cms-signature で登録ごとの鍵）
  * - id: イベントの ID（再送しても同じ値、受け手は処理済みの id を捨てて重複を除く）
+ * - event: 操作、type: 型の id
  * - item: 行の ID と題、by: 操作した人の表示名、at: 出来事の日時（ISO 8601、再送しても同じ値）
  */
-export type WebhookBody = Readonly<{
+export type WebhookBodyV2 = Readonly<{
+    version: 2;
+    id: string;
+    event: WebhookAction;
+    type: string;
+    item: Readonly<{
+        id: string;
+        title: string;
+    }>;
+    by: string;
+    at: string;
+}>;
+/** json の形式の本文の版1（event は <型の id>.<操作>、ほかは版2と同じ。版1の登録だけに送る） */
+export type WebhookBodyV1 = Readonly<{
+    version: 1;
     id: string;
     event: WebhookEvent;
     type: string;
@@ -45,7 +81,17 @@ export type WebhookBody = Readonly<{
     by: string;
     at: string;
 }>;
-/** 送信の記録（attempt は何回目の送信か、retryAt は次の再送の予定の日時、再送なしは null） */
+/** json の形式の本文（編集機能を持つ型の出来事、version で形を判別） */
+export type WebhookBody = WebhookBodyV2 | WebhookBodyV1;
+/** json の形式の拡張機能の出来事の本文（event は宣言の名前、data はモジュールの値、形は版1と版2で同じ） */
+export type WebhookModuleBody = Readonly<{
+    version: WebhookVersion;
+    id: string;
+    event: WebhookEvent;
+    data: Readonly<Record<string, unknown>>;
+    at: string;
+}>;
+/** 送信の記録（event は出来事のキー、attempt は何回目の送信か、retryAt は次の再送の予定の日時、再送なしは null） */
 export type WebhookDelivery = Readonly<{
     id: number;
     source: 'webhook' | 'function';

package/dist/types/model/src/capabilities.d.ts

@@ -15,6 +15,11 @@ export type SourcesField = Extract<FieldDef, {
 export declare const primaryTypeOf: (model: ContentModel) => ContentType | null;
 /** 主の型（なければ例外: その型を前提にする画面・処理だけが使用） */
 export declare function requiredPrimaryTypeOf(model: ContentModel): ContentType;
+/** 暦の日付（日付の役割の項目を持つ一覧の型と項目の key、スキーマの順、役割は宣言だけで推測なし） */
+export declare const dateRoleFieldsOf: (model: ContentModel) => {
+    type: string;
+    field: string;
+}[];
 /** 型の出典の項目（なければ null） */
 export declare function sourcesFieldOf(type: ContentType): SourcesField | null;
 /** 出典の型（出典の項目の参照先でスキーマの順で先頭、なければ null） */

package/dist/types/model/src/changes.d.ts

@@ -2,8 +2,8 @@ import { type ContentModel } from './model.js';
 /** 変更の扱い */
 export type ChangeLevel = 'safe' | 'confirm' | 'forbidden';
 /** 変更の種類 */
-export type ChangeKind = 'type-added' | 'type-removed' | 'type-changed' | 'format-changed' | 'publishing-changed' | 'publishing-removed' | 'fixed-changed' | 'field-added' | 'field-removed' | 'field-changed' | 'field-type-changed' | 'field-key-reused' | 'required-added' | 'constraint-tightened' | 'option-added' | 'option-removed' | 'component-added' | 'component-changed' | 'component-removed';
-/** スキーマの1つの変更（id は確認と置き換え先の指定で使用する識別子、path は項目の key を `.` で連結、value は削除した選択肢の値） */
+export type ChangeKind = 'type-added' | 'type-removed' | 'type-renamed' | 'type-rename-invalid' | 'type-changed' | 'format-changed' | 'publishing-changed' | 'publishing-removed' | 'fixed-changed' | 'field-added' | 'field-removed' | 'field-changed' | 'field-type-changed' | 'field-key-reused' | 'required-added' | 'constraint-tightened' | 'option-added' | 'option-removed' | 'component-added' | 'component-changed' | 'component-removed';
+/** スキーマの1つの変更（id は確認と置き換え先の指定で使用する識別子、path は項目の key を `.` で連結、value は削除した選択肢の値・型の旧の id） */
 export type SchemaChange = Readonly<{
     id: string;
     level: ChangeLevel;
@@ -13,9 +13,18 @@ export type SchemaChange = Readonly<{
     value?: string;
     message: string;
 }>;
-/** 差分の条件（history は保存済みの版より古い過去の版） */
+/**
+ * 差分の条件
+ * - history: 保存済みの版より古い過去の版
+ * - renames: 型の id の変更（旧の id → 新しい id）
+ * - takenIds: 行が残る型の id（削除した型の行、id の変更先に不可）
+ */
 export type DiffOptions = Readonly<{
     history?: readonly ContentModel[];
+    renames?: Readonly<Record<string, string>>;
+    takenIds?: readonly string[];
 }>;
 /** 保存済みの版 prev から新しい定義 next への変更（型の順、項目の順） */
 export declare function diffSchema(prev: ContentModel, next: ContentModel, options?: DiffOptions): SchemaChange[];
+/** 型の id を from から to に変えた定義（型の id と、すべての型の参照の to） */
+export declare const renameType: (model: ContentModel, from: string, to: string) => ContentModel;

package/dist/types/model/src/index.d.ts

@@ -3,8 +3,8 @@ export { assetRefSchema, cropSchema, hotspotSchema, mediaSchema, type Asset, typ
 export { coverPosition, coverStart, cropRect, croppedHotspot, objectPosition, stillOf, type CropRect } from './image.js';
 export { IMAGE_TYPE, VIDEO_TYPE } from './media.js';
 export { IMAGE_SIZE_MAX, imageParamsOf, mediaExtOf, mediaMimeOf, mediaPathOf, parseMediaPath, withImageParams, type ImageParams, type MediaPath } from './mediaUrl.js';
-export { diffSchema, type ChangeKind, type ChangeLevel, type DiffOptions, type SchemaChange } from './changes.js';
-export { primaryTypeOf, requiredPrimaryTypeOf, SOURCES_FIELD, sourceIdsOf, sourcesFieldOf, sourceTypeOf, type SourcesField } from './capabilities.js';
+export { diffSchema, renameType, type ChangeKind, type ChangeLevel, type DiffOptions, type SchemaChange } from './changes.js';
+export { dateRoleFieldsOf, primaryTypeOf, requiredPrimaryTypeOf, SOURCES_FIELD, sourceIdsOf, sourcesFieldOf, sourceTypeOf, type SourcesField } from './capabilities.js';
 export { appliesTo, checkFields, fieldsFor } from './check.js';
 export { deliveredFields, emptyValues, pickValues, referencedIds, referencesOf, valueFieldsOf } from './values.js';
 export { entryRefsOf, type EntryRef } from './refs.js';

package/dist/types/sdk/src/integrations.d.ts

@@ -1,4 +1,8 @@
+import { type SigningSecrets } from '../../access/src/index.js';
+import { type EmbedContext } from '../../cms-contract/src/index.js';
 export { openValue, SIGNED_HEADERS, verifyRequest } from '../../access/src/index.js';
-export type { VerifyRequestOptions } from '../../access/src/index.js';
-export { EMBED_CONTEXT_PARAM, EMBED_MESSAGES, FUNCTION_HOOKS } from '../../cms-contract/src/index.js';
-export type { EmbedContext, EmbedMessage, FunctionHook, FunctionRequest, PublishCheckRequest, PublishCheckResponse, SaveCheckRequest, SaveCheckResponse, WebhookAction, WebhookBody, WebhookEvent } from '../../cms-contract/src/index.js';
+export type { SigningSecrets, VerifyRequestOptions } from '../../access/src/index.js';
+export { EMBED_CONTEXT_NEXT_PARAM, EMBED_CONTEXT_PARAM, EMBED_MESSAGES, FUNCTION_HOOKS } from '../../cms-contract/src/index.js';
+export type { EmbedContext, EmbedMessage, FunctionHook, FunctionRequest, PublishCheckRequest, PublishCheckResponse, SaveCheckRequest, SaveCheckResponse, WebhookAction, WebhookBody, WebhookBodyV1, WebhookBodyV2, WebhookEvent, WebhookModuleBody, WebhookVersion } from '../../cms-contract/src/index.js';
+/** 外の画面の URL の文脈（クエリ ctx と、鍵の移行の期間の ctx_next のどちらかが鍵で開けば文脈、なければ null） */
+export declare function openEmbedContext(secret: SigningSecrets, url: string | URL, now?: number): Promise<EmbedContext | null>;

package/dist/types/sdk/src/preview.d.ts

@@ -1,2 +1,2 @@
 export { SIGNED_HEADERS, signedHeaders, signParts, verifyParts, verifyRequest } from '../../access/src/index.js';
-export type { SignedParts, VerifyRequestOptions } from '../../access/src/index.js';
+export type { SignedParts, SigningSecrets, VerifyRequestOptions } from '../../access/src/index.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ryusenkei/maezae",
-  "version": "0.9.0",
+  "version": "0.11.0",
   "description": "maezae の導入先のサイト向けの SDK（配信 API の取得・本文の型・プレビューの署名・手元の開発の配信 API）",
   "license": "UNLICENSED",
   "author": "RYUSENKEI",