@ryusenkei/maezae 0.8.0 → 0.9.0

package/README.md

@@ -51,3 +51,5 @@ import { type PublishCheckRequest, SIGNED_HEADERS, verifyRequest } from '@ryusen
 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;
 ```
+
+- Webhook の重複: 失敗した送信は同じ本文で再送する。本文の `id`（イベントの ID）を処理済みとして保存し、同じ `id` は処理せずに 2xx を返す

package/dist/delivery.js

@@ -1,4 +1,4 @@
-import { c as croppedHotspot, d as createClock, i as typeOf, r as optionsOf, s as cropRect, t as pagePathOf } from "./page-TFUlKv3R.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/query.ts
 const isRecord = (v) => typeof v === "object" && v !== null && !Array.isArray(v);
 /** in の値の検査（コンマを含む値はクエリで区切れない） */

package/dist/model.js

@@ -1,4 +1,4 @@
-import { a as coverPosition, c as croppedHotspot, d as createClock, f as isDateOnly, i as typeOf, l as objectPosition, n as publicPathOf, o as coverStart, s as cropRect, t as pagePathOf, u as stillOf } from "./page-TFUlKv3R.js";
+import { c as coverStart, d as objectPosition, f as stillOf, i as acceptsRole, l as cropRect, m as isDateOnly, n as publicPathOf, o as typeOf, p as createClock, r as FIELD_ROLES, s as coverPosition, t as pagePathOf, u as croppedHotspot } from "./page-BnwHL-LC.js";
 import { i as CORE_COMPONENTS, t as declaredComponentsSchema } from "./declared-9_jI3JXH.js";
 import "./src-BrLwIWaT.js";
 import { z } from "zod";
@@ -413,6 +413,12 @@ function computedProblems(fields) {
 		return [...[...fields.find((g) => g.key === f.computed.from)?.type === "body" ? [] : [`${f.key}: 計算の元 ${f.computed.from} が同じ型の本文の項目でない`], ...COMPUTED_TYPES[f.computed.kind]?.(f) ? [] : [`${f.key}: 計算の種類 ${f.computed.kind} に合わない項目の種類 ${f.type}`]], ...inner];
 	});
 }
+/** 役割の宣言の誤り（最上位にない key・役割が受け付けない項目） */
+const roleProblems = (roles, fields) => Object.entries(roles).flatMap(([role, key]) => {
+	const f = fields.find((g) => g.key === key);
+	if (!f) return [`${role}: 項目 ${key} が最上位にない`];
+	return acceptsRole(role, f) ? [] : [`${role}: 項目 ${key}（${f.type}）は役割に合わない`];
+});
 /** 本文の項目が使用する部品の名前（まとまりの中も、key は項目の key） */
 const bodyComponents = (fields) => fields.flatMap((f) => f.type === "body" ? f.profile.components.map((name) => ({
 	key: f.key,
@@ -438,7 +444,8 @@ const contentType = z.object({
 		field: fieldKey
 	})).optional(),
 	og: z.string().startsWith("/", "OG 画像の雛形は / で始まる").optional(),
-	idInput: z.boolean().optional()
+	idInput: z.boolean().optional(),
+	roles: z.partialRecord(z.enum(FIELD_ROLES), fieldKey).optional()
 }).refine((t) => new Set(t.fields.map((f) => f.key)).size === t.fields.length, { message: "項目の key が重複" }).refine((t) => conditionsValid(t.fields), { message: "項目の条件が同じ階層の選択肢の項目と値を指していない" }).refine((t) => (t.pages ?? []).every((p) => conditionValid(p.when, t.fields)), { message: "ページの条件が型の選択肢の項目と値を指していない" }).superRefine((t, ctx) => {
 	for (const k of reservedKeysOf(t)) ctx.addIssue({
 		code: "custom",
@@ -452,6 +459,11 @@ const contentType = z.object({
 		code: "custom",
 		message: `型 ${t.id} の項目 ${m}`
 	});
+	for (const m of roleProblems(t.roles ?? {}, t.fields)) ctx.addIssue({
+		code: "custom",
+		message: `型 ${t.id} の役割 ${m}`,
+		path: ["roles"]
+	});
 });
 const modelSchema = z.object({
 	components: declaredComponentsSchema.optional(),
@@ -527,6 +539,11 @@ const DEFAULT_SCHEMA = { "types": [
 		"id": "post",
 		"label": "投稿",
 		"publishing": "review",
+		"roles": {
+			"title": "title",
+			"image": "image",
+			"body": "body"
+		},
 		"fields": [
 			{
 				"key": "title",
@@ -635,6 +652,10 @@ const DEFAULT_SCHEMA = { "types": [
 	{
 		"id": "author",
 		"label": "著者",
+		"roles": {
+			"title": "name",
+			"image": "portrait"
+		},
 		"fields": [
 			{
 				"key": "name",
@@ -659,6 +680,7 @@ const DEFAULT_SCHEMA = { "types": [
 	{
 		"id": "tag",
 		"label": "タグ",
+		"roles": { "title": "label" },
 		"fields": [{
 			"key": "label",
 			"label": "名前",

package/dist/{page-TFUlKv3R.js → page-BnwHL-LC.js}

@@ -101,6 +101,14 @@ function croppedHotspot(hotspot, crop) {
 	};
 }
 // ../model/src/model.ts
+/** 項目の役割（製品の処理が型ごとの key によらず参照する項目） */
+const FIELD_ROLES = [
+	"title",
+	"image",
+	"body",
+	"summary",
+	"date"
+];
 /** コンテンツスキーマの型（id から、なければ例外: 導入先の設定の誤り） */
 function typeOf(model, id) {
 	const type = model.types.find((t) => t.id === id);
@@ -114,6 +122,19 @@ function optionsOf(type, key) {
 	for (const k of rest) field = field?.type === "group" ? field.fields.find((f) => f.key === k) : void 0;
 	return field?.type === "select" ? field.options : [];
 }
+/** 入力する項目か（計算の項目を除く） */
+const isInputField = (f) => !f.computed;
+/** 役割ごとに受け付ける項目（宣言の検査と、宣言のない型の推測で共通） */
+const ROLE_ACCEPTS = {
+	title: (f) => (f.type === "text" || f.type === "textarea") && !f.multiple && isInputField(f),
+	image: (f) => f.type === "media" && !f.multiple && (!f.accept || f.accept.includes("image")),
+	body: (f) => f.type === "body",
+	summary: (f) => (f.type === "text" || f.type === "textarea") && !f.multiple,
+	date: (f) => f.type === "date" || f.type === "datetime"
+};
+ROLE_ACCEPTS.image, ROLE_ACCEPTS.body;
+/** 役割の項目が受け付ける項目か（宣言の検査に使用） */
+const acceptsRole = (role, f) => ROLE_ACCEPTS[role](f);
 // ../model/src/page.ts
 const matches = (when, entry) => !when || when.in.includes(String(entry[when.key]));
 const passes = (rule, entry, now) => {
@@ -149,4 +170,4 @@ function hasPublicPage(type, entry, now) {
 function publicPathOf(type, entry, now) {
 	return hasPublicPage(type, entry, now) ? pagePathOf(type, entry) : null;
 }
-export { coverPosition as a, croppedHotspot as c, createClock as d, isDateOnly as f, typeOf as i, objectPosition as l, publicPathOf as n, coverStart as o, optionsOf as r, cropRect as s, pagePathOf as t, stillOf as u };
+export { optionsOf as a, coverStart as c, objectPosition as d, stillOf as f, acceptsRole as i, cropRect as l, isDateOnly as m, publicPathOf as n, typeOf as o, createClock as p, FIELD_ROLES as r, coverPosition as s, pagePathOf as t, croppedHotspot as u };

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

@@ -70,7 +70,7 @@ export type ErrorParams = {
     /** 使用先: in_use */
     by?: 'uses' | 'places' | 'outputs' | 'entry' | 'writers' | 'members' | 'accounts';
     /** 状態の不一致の理由: invalid_state */
-    reason?: 'not_draft' | 'not_in_review' | 'request_handled' | 'deleted' | 'not_deleted' | 'schema_confirm' | 'no_publishing' | 'no_review';
+    reason?: 'not_draft' | 'no_draft' | 'not_in_review' | 'request_handled' | 'deleted' | 'not_deleted' | 'schema_confirm' | 'no_publishing' | 'no_review';
     /** 取得の対象: upstream_failed */
     resource?: 'page' | 'image' | 'webhook';
     /**

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

@@ -0,0 +1,101 @@
+/** 1回のリクエストで取り込む件数の上限（画像の取得の時間と、本文の大きさの上限 JSON_BODY_MAX のため） */
+export declare const IMPORT_ITEMS_MAX = 50;
+/** 取り込む1件（fields は項目の key と値、source は報告に載せる元の位置: ファイルの行・元の CMS の ID など） */
+export type ImportItem = Readonly<{
+    type: string;
+    id?: string;
+    fields: Readonly<Record<string, unknown>>;
+    source?: string;
+}>;
+/** 取り込みの問題の種類 */
+export declare const IMPORT_PROBLEMS: readonly ["unknown_type", "forbidden", "invalid_id", "id_conflict", "duplicate_id", "unknown_field", "invalid_value", "image_failed", "markdown", "save_rejected", "reference_lowercased"];
+export type ImportProblemCode = (typeof IMPORT_PROBLEMS)[number];
+/** 問題の種類の表示名 */
+export declare const IMPORT_PROBLEM_LABELS: {
+    readonly unknown_type: "取り込めない型";
+    readonly forbidden: "作成の権限がない";
+    readonly invalid_id: "ID の形が不正";
+    readonly id_conflict: "ID の変換でぶつかる";
+    readonly duplicate_id: "ID が重複";
+    readonly unknown_field: "スキーマにない項目（取り込まない）";
+    readonly invalid_value: "値の形が不正";
+    readonly image_failed: "画像を取り込めない";
+    readonly markdown: "本文を変換できない";
+    readonly save_rejected: "保存の検査で拒否";
+    readonly reference_lowercased: "参照の ID を小文字に変換";
+};
+/** 取り込みの問題（error は取り込まない、warning は取り込んで報告、path は項目の key・まとまりの中はドットで連結） */
+export type ImportProblem = Readonly<{
+    level: 'error' | 'warning';
+    code: ImportProblemCode;
+    path: string;
+    message: string;
+}>;
+/** 1件の結果（created は作成、ready は試しの実行で作成できる、skipped は問題で取り込まない） */
+export type ImportItemReport = Readonly<{
+    source: string;
+    type: string;
+    id: string | null;
+    status: 'created' | 'ready' | 'skipped';
+    problems: readonly ImportProblem[];
+}>;
+/** 画像の結果（checked は試しの実行で取得できた、asset は保存した画像の ID） */
+export type ImportImage = Readonly<{
+    url: string;
+    status: 'imported' | 'existing' | 'checked' | 'failed';
+    asset: string | null;
+    message: string | null;
+}>;
+/** 小文字に変換した ID（paths は型のページの旧と新のパス、ページのない型は null） */
+export type ImportIdChange = Readonly<{
+    type: string;
+    from: string;
+    to: string;
+    source: string;
+    paths: Readonly<{
+        from: string;
+        to: string;
+    }> | null;
+}>;
+/** 変換でぶつかる ID（ids は元の ID、existing は変換後の ID の行がすでにある） */
+export type ImportIdConflict = Readonly<{
+    type: string;
+    id: string;
+    ids: readonly string[];
+    sources: readonly string[];
+    existing: boolean;
+}>;
+/** 取り込みの報告 */
+export type ImportReport = Readonly<{
+    dryRun: boolean;
+    summary: Readonly<{
+        items: number;
+        created: number;
+        ready: number;
+        skipped: number;
+        images: Readonly<Record<ImportImage['status'], number>>;
+    }>;
+    items: readonly ImportItemReport[];
+    images: readonly ImportImage[];
+    idChanges: readonly ImportIdChange[];
+    idConflicts: readonly ImportIdConflict[];
+}>;
+/** 取り込む ID（前後の空白を除き小文字に、changed は大文字を含んでいた） */
+export declare function importIdOf(raw: string): Readonly<{
+    id: string;
+    changed: boolean;
+}>;
+/** 入力の中の ID の計画（conflicts は大文字と小文字の違いだけでぶつかる組み合わせ、duplicates は同じ ID が複数、どちらも位置 index の集合で除外） */
+export type ImportIdPlan = Readonly<{
+    conflicts: readonly ImportIdConflict[];
+    excluded: ReadonlySet<number>;
+    duplicates: ReadonlySet<number>;
+}>;
+/** 入力の中で ID がぶつかる行（型ごと、ID のない行は自動の ID で対象外） */
+export declare function planImportIds(items: readonly ImportItem[]): ImportIdPlan;
+/** 報告に載せる元の位置（指定がなければ入力の何件目か） */
+export declare const sourceOf: (item: ImportItem, index: number) => string;
+/** 件数を数え直した報告 */
+export declare function importReportOf(dryRun: boolean, parts: Omit<ImportReport, 'dryRun' | 'summary'>): ImportReport;
+/** 分けて送った取り込みの報告を1つに（同じ URL の画像は先の結果） */
+export declare function mergeImportReports(dryRun: boolean, reports: readonly ImportReport[], extra?: Partial<Omit<ImportReport, 'dryRun' | 'summary'>>): ImportReport;

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

@@ -12,8 +12,9 @@ export { type AccountLink, type Action, ACTION_LEVELS, ACTIONS, allows, ANY_TARG
 export { ADMIN_PERMISSIONS, ADMIN_ROLE, isAdmin, rolePermissionsOf, type Role, SYSTEM_ROLES, type User, WRITER_ROLE } from './roles.js';
 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 { 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 WebhookEvent, webhookEventLabel, webhookEventOf, type WebhookKind } from './webhooks.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 { 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/webhooks.d.ts

@@ -31,9 +31,11 @@ export type Webhook = Readonly<{
 }>;
 /**
  * json の形式の本文（編集機能を持つ型の出来事、署名はヘッダー x-cms-signature で登録ごとの鍵）
- * - item: 行の ID と題、by: 操作した人の表示名、at: 送信の日時（ISO 8601）
+ * - id: イベントの ID（再送しても同じ値、受け手は処理済みの id を捨てて重複を除く）
+ * - item: 行の ID と題、by: 操作した人の表示名、at: 出来事の日時（ISO 8601、再送しても同じ値）
  */
 export type WebhookBody = Readonly<{
+    id: string;
     event: WebhookEvent;
     type: string;
     item: Readonly<{
@@ -43,3 +45,16 @@ export type WebhookBody = Readonly<{
     by: string;
     at: string;
 }>;
+/** 送信の記録（attempt は何回目の送信か、retryAt は次の再送の予定の日時、再送なしは null） */
+export type WebhookDelivery = Readonly<{
+    id: number;
+    source: 'webhook' | 'function';
+    event: string;
+    status: number;
+    error: string | null;
+    eventId: string | null;
+    attempt: number;
+    retryAt: string | null;
+    label: string | null;
+    created_at: string;
+}>;

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

@@ -8,7 +8,7 @@ export { primaryTypeOf, requiredPrimaryTypeOf, SOURCES_FIELD, sourceIdsOf, sourc
 export { appliesTo, checkFields, fieldsFor } from './check.js';
 export { deliveredFields, emptyValues, pickValues, referencedIds, referencesOf, valueFieldsOf } from './values.js';
 export { entryRefsOf, type EntryRef } from './refs.js';
-export { bodyFieldOf, bodyFieldsOf, computedFieldsOf, idInputOf, imageFieldOf, initialValueOf, isEditorial, isInputField, isListType, isMediaType, isSingleton, isStoredType, MEDIA_TYPE_IDS, optionLabelOf, optionsOf, publishingOf, requestReferencesOf, titleFieldOf, toneOf, typeOf, type ComputedKind, type FieldComputed, type ContentFormat, type ContentModel, type ContentType, type FieldCondition, type FieldDef, type FieldDerive, type FieldFixedBy, type CountDef, type FieldProblem, type MediaKind, type OptionTone, type Publishing, type ReferenceRules, type SelectOption } from './model.js';
+export { acceptsRole, bodyFieldsOf, computedFieldsOf, FIELD_ROLES, idInputOf, initialValueOf, isEditorial, isInputField, isListType, isMediaType, isSingleton, isStoredType, MEDIA_TYPE_IDS, optionLabelOf, optionsOf, publishingOf, requestReferencesOf, resolvedRolesOf, roleFieldOf, toneOf, typeOf, type ComputedKind, type FieldRole, type FieldRoles, type FieldComputed, type ContentFormat, type ContentModel, type ContentType, type FieldCondition, type FieldDef, type FieldDerive, type FieldFixedBy, type CountDef, type FieldProblem, type MediaKind, type OptionTone, type Publishing, type ReferenceRules, type SelectOption } from './model.js';
 export { hasPublicPage, imageFrameOf, pagePathOf, publicPathOf, withPagesFrom, type ImageFrame, type ImageFrameDef, type PageDef, type PageEntry, type PageRule } from './page.js';
 export { schemaRulesOf, type SchemaRule } from './rules.js';
 export { parseModel } from './schema.js';

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

@@ -134,6 +134,7 @@ export type Publishing = 'none' | 'draft' | 'review';
  * - counts: 被参照の件数（ページの公開中の条件・ページの公開で必須の判定に使用）
  * - og: サイトの OG 画像のパスの雛形（{key} は行の値、管理画面の OG 画像のプレビュー）
  * - idInput: 作成のときに管理画面で ID を入力できる（ページのある型は常に入力可、空欄は自動）
+ * - roles: 項目の役割（役割ごとに最上位の項目の key、roleFieldOf）
  */
 export type ContentType = Readonly<{
     id: string;
@@ -146,7 +147,13 @@ export type ContentType = Readonly<{
     counts?: readonly CountDef[];
     og?: string;
     idInput?: boolean;
+    roles?: FieldRoles;
 }>;
+/** 項目の役割（製品の処理が型ごとの key によらず参照する項目） */
+export declare const FIELD_ROLES: readonly ["title", "image", "body", "summary", "date"];
+export type FieldRole = (typeof FIELD_ROLES)[number];
+/** 型の役割の宣言（役割ごとに最上位の項目の key） */
+export type FieldRoles = Readonly<Partial<Record<FieldRole, string>>>;
 /** コンテンツスキーマ（導入先ごとに1つ） */
 export type ContentModel = Readonly<{
     types: readonly ContentType[];
@@ -189,18 +196,22 @@ export declare const toneOf: (type: ContentType, key: string, value: string) =>
 export declare const optionLabelOf: (type: ContentType, key: string, value: string) => string;
 /** 入力する項目か（計算の項目を除く） */
 export declare const isInputField: (f: FieldDef) => boolean;
-/** 型の表示名の項目（複数でない文字の項目で先頭、なければ null: 行の表示名に使用） */
-export declare const titleFieldOf: (type: ContentType) => FieldDef | null;
-/** 型のサムネの項目（複数でない画像の項目で先頭、なければ null: 一覧・参照の候補・アイキャッチに使用） */
-export declare const imageFieldOf: (type: ContentType) => FieldDef | null;
-/** 型の本文の項目（最上位で先頭、なければ null: 本文の Markdown・点検・制作の案内に使用） */
-export declare const bodyFieldOf: (type: ContentType) => Extract<FieldDef, {
-    type: "body";
-}> | null;
+type BodyField = Extract<FieldDef, {
+    type: 'body';
+}>;
+/** 役割の項目が受け付ける項目か（宣言の検査に使用） */
+export declare const acceptsRole: (role: FieldRole, f: FieldDef) => boolean;
+/**
+ * 型の役割の項目（宣言 roles の項目、宣言のない役割は推測、なければ null）
+ * - 用途: 題は行の表示名、画像は一覧・参照の候補・アイキャッチ、本文は Markdown・点検・制作の案内、要約は説明、日付は暦
+ * - 宣言が最上位の項目を指さない・受け付けない項目を指す: null（検査は schema.ts）
+ */
+export declare function roleFieldOf(type: ContentType, role: 'body'): BodyField | null;
+export declare function roleFieldOf(type: ContentType, role: FieldRole): FieldDef | null;
+/** 宣言のない役割も推測で埋めた役割の宣言（既存の型に役割を書き足す移行に使用） */
+export declare function resolvedRolesOf(type: ContentType): FieldRoles;
 /** 最上位で本文の種類の項目（表 entry_bodies に保存、一覧では取得しない） */
-export declare const bodyFieldsOf: (type: ContentType) => Extract<FieldDef, {
-    type: "body";
-}>[];
+export declare const bodyFieldsOf: (type: ContentType) => BodyField[];
 /** 型の計算の項目（最上位） */
 export declare const computedFieldsOf: (type: ContentType) => FieldDef[];
 /** 追加の依頼ができる参照の項目（参照先が一覧で管理する型で requests の指定があるもの、タグ・分類など） */

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

@@ -1,3 +1,3 @@
-import type { ContentModel } from './model.js';
+import { type ContentModel } from './model.js';
 /** コンテンツスキーマの JSON を検査して返却（形が合わなければ例外、理由は zod の issues） */
 export declare const parseModel: (json: unknown) => ContentModel;

package/dist/types/sdk/src/delivery/client.d.ts

@@ -50,6 +50,7 @@ export declare function createDeliveryClient(delivery: Delivery, { drafts, at }?
         counts?: readonly import("../../../model/src/model.js").CountDef[];
         og?: string;
         idInput?: boolean;
+        roles?: import("../../../model/src/model.js").FieldRoles;
     }>>(path: string, query: ListQuery<T> & Readonly<{
         limit: number;
     }>) => Promise<Page<I>>;

package/package.json

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