@ryusenkei/maezae 0.19.0 → 0.20.0

package/README.md

@@ -151,6 +151,9 @@ npx maezae-types --out src/cms-types.ts --check
 
 - 生成のファイル: 型ごとに `export type <PascalCase の型の id>`（`ItemOf` と同じ値の形）、全体の対応 `CmsTypes`、型の id の一覧 `TYPE_IDS`。表示名・上限・配信しない項目は含めないので、管理画面での表示名の変更ではずれにならない
 - 整形の対象から外す（`--check` は文字の一致で比べる。改行の CRLF は同じとみなす）
+- 識別子でない key（`lab-note` など）は引用符で囲む（0.20.0 から）
+- 終了の状態（0.20.0 から、`TYPES_EXIT_CODES`）: 成功は `0`、ずれは `1`、引数と鍵の不足や CMS の拒否（4xx）は `2`、CMS に届かない（接続の失敗、5xx）ときは `3`。CMS が止まったときに検査を省くなら、`3` だけを通す
+- 同じ処理を Node のスクリプトから呼ぶときは `runTypesCli`（`@ryusenkei/maezae/schema`）。戻り値が終了の状態で、例外を投げない
 - MCP の `get_schema` も同じ文を返す（`format: "typescript"`）。管理画面の「設定 → データ」の型定義のエクスポートも同じ文
 
 ## 公開のフォーム（お問い合わせ）
@@ -160,7 +163,6 @@ npx maezae-types --out src/cms-types.ts --check
 - `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 }`）は導入先が移るまで残す
 
 ## 回数の制限
 

package/dist/model.js

@@ -1,6 +1,6 @@
 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-Qo-mWnDd.js";
-import { t as typesSourceOf } from "./typesSource-BKPzvl--.js";
+import { t as typesSourceOf } from "./typesSource-DKTe9a2-.js";
 import "./src-BrLwIWaT.js";
 import { z } from "zod";
 // ../model/src/asset.ts

package/dist/schema-CUrLZWsb.js

@@ -0,0 +1,114 @@
+import { t as typesSourceOf } from "./typesSource-DKTe9a2-.js";
+import { t as DELIVERY_PATH } from "./client-ClY3gSSd.js";
+import { readFileSync, writeFileSync } from "node:fs";
+// src/schema.ts
+/**
+* maezae-types の終了の状態
+* - drift: --check でファイルが CMS のスキーマと違う
+* - failed: 引数と鍵の不足、CMS の拒否（4xx）、応答の形の誤り、ファイルの読み書きの失敗
+* - unreachable: CMS に届かない（接続の失敗、5xx）
+*/
+const TYPES_EXIT_CODES = {
+	ok: 0,
+	drift: 1,
+	failed: 2,
+	unreachable: 3
+};
+/** 標準出力と標準エラーの文 */
+const MESSAGES = {
+	usage: "usage: maezae-types --out <file> [--check] [--url <delivery API URL>]（API key: MAEZAE_API_KEY）",
+	missingUrl: "missing_url: --url か MAEZAE_DELIVERY_URL に配信 API の URL（例: https://example.com/<媒体>）",
+	missingKey: "missing_api_key: 環境変数 MAEZAE_API_KEY",
+	fetchFailed: (status, body) => `fetch_failed: ${status} ${body.slice(0, 200)}`,
+	invalidResponse: "invalid_response: 配信 API の /types の応答に types がない",
+	unreachable: (url, reason) => `cms_unreachable: ${url} ${reason}`,
+	drift: (file) => `schema_drift: ${file} が CMS のスキーマと違う（maezae-types --out ${file} で生成し直す）`,
+	upToDate: (file) => `up_to_date: ${file}`,
+	written: (file) => `written: ${file}`
+};
+/** 引数（--name value と --flag） */
+function argsOf(argv) {
+	const value = (name) => {
+		const i = argv.indexOf(name);
+		return i >= 0 ? argv[i + 1] : void 0;
+	};
+	return {
+		out: value("--out"),
+		url: value("--url"),
+		check: argv.includes("--check")
+	};
+}
+/** 配信 API の /types の応答の失敗（status は HTTP の状態） */
+var TypesResponseError = class extends Error {
+	status;
+	constructor(message, status) {
+		super(message);
+		this.status = status;
+	}
+};
+/**
+* 配信 API の型の一覧（/types、表示名・選択肢・上限・ページの URL の形を含む。実行時に読む値もここから）
+* - 例外: 2xx でなければ `fetch_failed: <状態> <本文>`、本文に types がなければ `invalid_response`、接続の失敗は fetcher の例外のまま
+*/
+async function fetchDeliveredTypes(url, apiKey, fetcher = fetch) {
+	const res = await fetcher(`${url.replace(/\/+$/, "")}${DELIVERY_PATH}/types`, { headers: { authorization: `Bearer ${apiKey}` } });
+	if (!res.ok) throw new TypesResponseError(MESSAGES.fetchFailed(res.status, await res.text().catch(() => "")), res.status);
+	const types = (await res.json().catch(() => null))?.types;
+	if (!Array.isArray(types)) throw new TypesResponseError(MESSAGES.invalidResponse, res.status);
+	return types;
+}
+const messageOf = (e) => {
+	const cause = e instanceof Error && e.cause instanceof Error ? `（${e.cause.message}）` : "";
+	return `${e instanceof Error ? e.message : String(e)}${cause}`;
+};
+/** 取得の失敗の終了の状態と文（接続の失敗と 5xx は unreachable） */
+function fetchFailureOf(url, e) {
+	if (!(e instanceof TypesResponseError)) return {
+		code: TYPES_EXIT_CODES.unreachable,
+		message: MESSAGES.unreachable(url, messageOf(e))
+	};
+	return {
+		code: e.status >= 500 ? TYPES_EXIT_CODES.unreachable : TYPES_EXIT_CODES.failed,
+		message: e.message
+	};
+}
+/** 生成の結果をファイルに書くか、--check でファイルと比べる（戻り値は終了の状態） */
+function writeOrCheck(out, source, check) {
+	if (!check) {
+		writeFileSync(out, source);
+		console.log(MESSAGES.written(out));
+		return TYPES_EXIT_CODES.ok;
+	}
+	let current = null;
+	try {
+		current = readFileSync(out, "utf8").replace(/\r\n/g, "\n");
+	} catch {
+		current = null;
+	}
+	if (current !== source) return console.error(MESSAGES.drift(out)), TYPES_EXIT_CODES.drift;
+	console.log(MESSAGES.upToDate(out));
+	return TYPES_EXIT_CODES.ok;
+}
+/** CLI の本体（戻り値は終了の状態 TYPES_EXIT_CODES、失敗は例外にせず標準エラーと終了の状態で返す） */
+async function runTypesCli(argv, env, fetcher = fetch) {
+	const { out, url = env.MAEZAE_DELIVERY_URL, check } = argsOf(argv);
+	if (!out) return console.error(MESSAGES.usage), TYPES_EXIT_CODES.failed;
+	if (!url) return console.error(MESSAGES.missingUrl), TYPES_EXIT_CODES.failed;
+	const apiKey = env.MAEZAE_API_KEY;
+	if (!apiKey) return console.error(MESSAGES.missingKey), TYPES_EXIT_CODES.failed;
+	let types;
+	try {
+		types = await fetchDeliveredTypes(url, apiKey, fetcher);
+	} catch (e) {
+		const failure = fetchFailureOf(url, e);
+		console.error(failure.message);
+		return failure.code;
+	}
+	try {
+		return writeOrCheck(out, typesSourceOf({ types }), check);
+	} catch (e) {
+		console.error(messageOf(e));
+		return TYPES_EXIT_CODES.failed;
+	}
+}
+export { fetchDeliveredTypes as n, runTypesCli as r, TYPES_EXIT_CODES as t };

package/dist/schema.js

@@ -1,56 +1 @@
-import { t as typesSourceOf } from "./typesSource-BKPzvl--.js";
-import { t as DELIVERY_PATH } from "./client-ClY3gSSd.js";
-import { readFileSync, writeFileSync } from "node:fs";
-// src/schema.ts
-/** 標準出力と標準エラーの文 */
-const MESSAGES = {
-	usage: "usage: maezae-types --out <file> [--check] [--url <delivery API URL>]（API key: MAEZAE_API_KEY）",
-	missingUrl: "missing_url: --url か MAEZAE_DELIVERY_URL に配信 API の URL（例: https://example.com/<媒体>）",
-	missingKey: "missing_api_key: 環境変数 MAEZAE_API_KEY",
-	fetchFailed: (status, body) => `fetch_failed: ${status} ${body.slice(0, 200)}`,
-	drift: (file) => `schema_drift: ${file} が CMS のスキーマと違う（maezae-types --out ${file} で生成し直す）`,
-	upToDate: (file) => `up_to_date: ${file}`,
-	written: (file) => `written: ${file}`
-};
-/** 引数（--name value と --flag） */
-function argsOf(argv) {
-	const value = (name) => {
-		const i = argv.indexOf(name);
-		return i >= 0 ? argv[i + 1] : void 0;
-	};
-	return {
-		out: value("--out"),
-		url: value("--url"),
-		check: argv.includes("--check")
-	};
-}
-/** 配信 API の型の一覧（/types、表示名・選択肢・上限・ページの URL の形を含む。実行時に読む値もここから） */
-async function fetchDeliveredTypes(url, apiKey, fetcher = fetch) {
-	const res = await fetcher(`${url.replace(/\/+$/, "")}${DELIVERY_PATH}/types`, { headers: { authorization: `Bearer ${apiKey}` } });
-	if (!res.ok) throw new Error(MESSAGES.fetchFailed(res.status, await res.text().catch(() => "")));
-	return (await res.json()).types;
-}
-/** CLI の本体（戻り値は終了の状態） */
-async function runTypesCli(argv, env, fetcher = fetch) {
-	const { out, url = env.MAEZAE_DELIVERY_URL, check } = argsOf(argv);
-	if (!out) return console.error(MESSAGES.usage), 1;
-	if (!url) return console.error(MESSAGES.missingUrl), 1;
-	const apiKey = env.MAEZAE_API_KEY;
-	if (!apiKey) return console.error(MESSAGES.missingKey), 1;
-	const source = typesSourceOf({ types: await fetchDeliveredTypes(url, apiKey, fetcher) });
-	if (check) {
-		let current = null;
-		try {
-			current = readFileSync(out, "utf8").replace(/\r\n/g, "\n");
-		} catch {
-			current = null;
-		}
-		if (current !== source) return console.error(MESSAGES.drift(out)), 1;
-		console.log(MESSAGES.upToDate(out));
-		return 0;
-	}
-	writeFileSync(out, source);
-	console.log(MESSAGES.written(out));
-	return 0;
-}
-export { fetchDeliveredTypes, runTypesCli };
+export { t as TYPES_EXIT_CODES, n as fetchDeliveredTypes, r as runTypesCli } from "./schema-CUrLZWsb.js";

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

@@ -1,5 +1,20 @@
 import { type ContentType } from '../../model/src/index.js';
-/** 配信 API の型の一覧（/types、表示名・選択肢・上限・ページの URL の形を含む。実行時に読む値もここから） */
+/**
+ * maezae-types の終了の状態
+ * - drift: --check でファイルが CMS のスキーマと違う
+ * - failed: 引数と鍵の不足、CMS の拒否（4xx）、応答の形の誤り、ファイルの読み書きの失敗
+ * - unreachable: CMS に届かない（接続の失敗、5xx）
+ */
+export declare const TYPES_EXIT_CODES: {
+    readonly ok: 0;
+    readonly drift: 1;
+    readonly failed: 2;
+    readonly unreachable: 3;
+};
+/**
+ * 配信 API の型の一覧（/types、表示名・選択肢・上限・ページの URL の形を含む。実行時に読む値もここから）
+ * - 例外: 2xx でなければ `fetch_failed: <状態> <本文>`、本文に types がなければ `invalid_response`、接続の失敗は fetcher の例外のまま
+ */
 export declare function fetchDeliveredTypes(url: string, apiKey: string, fetcher?: typeof fetch): Promise<readonly ContentType[]>;
-/** CLI の本体（戻り値は終了の状態） */
+/** CLI の本体（戻り値は終了の状態 TYPES_EXIT_CODES、失敗は例外にせず標準エラーと終了の状態で返す） */
 export declare function runTypesCli(argv: readonly string[], env: Readonly<Record<string, string | undefined>>, fetcher?: typeof fetch): Promise<number>;

package/dist/types-cli.js

@@ -1,7 +1,4 @@
 #!/usr/bin/env node
-import { runTypesCli } from "./schema.js";
+import { r as runTypesCli } from "./schema-CUrLZWsb.js";
 // src/types-cli.ts
-runTypesCli(process.argv.slice(2), process.env).then((code) => process.exit(code), (e) => {
-	console.error(e instanceof Error ? e.message : String(e));
-	process.exit(1);
-});
+process.exitCode = await runTypesCli(process.argv.slice(2), process.env);

package/dist/{typesSource-BKPzvl--.js → typesSource-DKTe9a2-.js}

@@ -9,6 +9,8 @@ const deliveredFields = (fields) => fields.filter((f) => !f.private).map((f) =>
 const SDK = "@ryusenkei/maezae";
 /** 型の import の行（指定は JSON の文字列の形） */
 const importLine = (names, spec) => `import type { ${names.join(", ")} } from ${JSON.stringify(spec)};`;
+/** プロパティの名前（識別子でない key は JSON の文字列の形） */
+const propertyName = (key) => /^[A-Za-z_$][\w$]*$/.test(key) ? key : JSON.stringify(key);
 const pascal = (id) => id.replace(/(^|[-_])(\w)/g, (_, __, ch) => ch.toUpperCase());
 /** 項目の1つ分の値の型（SDK の SingleValue と同じ） */
 function singleOf(f, indent) {
@@ -34,7 +36,7 @@ const valueOf = (f, indent) => {
 };
 /** 配信する項目の種類（まとまりの中を含む） */
 const kindsOf = (fields) => deliveredFields(fields).flatMap((f) => [f.type, ...f.type === "group" ? kindsOf(f.fields) : []]);
-const fieldsOf = (fields, indent) => fields.map((f) => `${indent}readonly ${f.key}: ${valueOf(f, indent)};`).join("\n");
+const fieldsOf = (fields, indent) => fields.map((f) => `${indent}readonly ${propertyName(f.key)}: ${valueOf(f, indent)};`).join("\n");
 const typeOf = (t) => `export type ${pascal(t.id)} = Readonly<{\n  id: string;\n  _meta: ItemMeta;\n${fieldsOf(deliveredFields(t.fields), "  ")}\n}>;`;
 /**
 * スキーマから配信 API の値の型の定義（TypeScript のモジュールの文）

package/package.json

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