@ryusenkei/maezae 0.0.0-stage → 0.1.0

package/dist/delivery.d.ts

@@ -0,0 +1,211 @@
+import { C as FieldDef, D as PageEntry, E as PageDef, S as CountDef, _ as Media, a as CropRect, b as ContentModel, h as Hotspot, m as Crop, n as DateString, t as Clock, w as Publishing, x as ContentType, y as ContentFormat } from "./index-57nirXxn.js";
+import { i as Body } from "./index-D11fUsoi.js";
+/** 配信 API の1件の値（項目の key と id・updated_at） */
+type Item = Readonly<Record<string, unknown>>;
+/** 配信 API が解決した実体（hotspot・crop は元の画像に対する割合） */
+type DeliveredAsset = Readonly<{
+  id: string;
+  kind: 'image' | 'video';
+  width: number;
+  height: number;
+  alt: string;
+  hotspot?: Hotspot;
+  crop?: Crop;
+  poster?: DeliveredAsset | null;
+}>;
+/** 項目の1つ分の値（複数の値を持つ項目は FieldValue が配列に、query.ts の絞り込みの値と共通） */
+type SingleValue<F extends FieldDef> = F extends {
+  type: 'text' | 'textarea';
+} ? string : F extends {
+  type: 'number';
+} ? number : F extends {
+  type: 'checkbox';
+} ? boolean : F extends {
+  type: 'date';
+} ? DateString : F extends {
+  type: 'datetime';
+} ? string : F extends {
+  type: 'select';
+  options: readonly (infer O extends {
+    value: string;
+  })[];
+} ? O['value'] : F extends {
+  type: 'reference';
+} ? string : F extends {
+  type: 'media';
+} ? DeliveredAsset | null : F extends {
+  type: 'body';
+} ? Body<DeliveredAsset | null> : F extends {
+  type: 'group';
+  fields: readonly (infer G extends FieldDef)[];
+} ? GroupValue<G> : unknown;
+/** まとまりの値（中の項目の key ごと） */
+type GroupValue<G extends FieldDef> = { readonly [K in G as K['key']]: FieldValue<K>; };
+/**
+ * 項目の値（種類ごと: 文字は string、日付は YYYY-MM-DD、日時は `ISO 8601` の UTC、参照は参照先の id、メディアは実体、本文は標準のブロック）
+ * - multiple の項目: 値の配列
+ * - 値なし: null
+ */
+type FieldValue<F extends FieldDef> = (F extends {
+  multiple: true;
+} ? readonly SingleValue<F>[] : SingleValue<F>) | null;
+/** 型の項目（コアの項目と追加の項目） */
+type FieldsOf<T extends ContentType> = (T['core'] extends readonly (infer C extends FieldDef)[] ? C : never) | T['fields'][number];
+/** 型の宣言から導く1件の値（id・更新日時と、項目の key ごとの値） */
+type ItemOf<T extends ContentType> = Readonly<{
+  id: string;
+  updated_at: string;
+} & { [F in FieldsOf<T> as F['key']]: FieldValue<F>; }>;
+/** 範囲の指定（両端を含む） */
+type Range<V> = Readonly<{
+  gte?: V;
+  lte?: V;
+}>;
+type Scalar<F extends FieldDef> = NonNullable<SingleValue<F>>;
+/** 項目の種類ごとの絞り込みの値（選択肢・参照は一致か in、チェックボックスは一致、数値・日付は一致か範囲、日時は範囲） */
+type FilterValue<F extends FieldDef> = F extends {
+  private: true;
+} ? never : F extends {
+  type: 'select' | 'reference';
+} ? Scalar<F> | Readonly<{
+  in: readonly Scalar<F>[];
+}> : F extends {
+  type: 'checkbox';
+} ? boolean : F extends {
+  type: 'number' | 'date';
+} ? Scalar<F> | Range<Scalar<F>> : F extends {
+  type: 'datetime';
+} ? Range<string> : never;
+/** 並べ替えできる項目の key（単数の文字・数値・日付・日時・選択肢・チェックボックス） */
+type SortableKey<T extends ContentType> = FieldsOf<T> extends (infer F) ? (F extends {
+  private: true;
+} | {
+  multiple: true;
+} ? never : F extends {
+  type: 'text' | 'number' | 'date' | 'datetime' | 'select' | 'checkbox';
+  key: infer K extends string;
+} ? K : never) : never;
+/** 並べ替えの key（項目・公開日時・更新日時・id） */
+type OrderKey<T extends ContentType> = SortableKey<T> | 'published_at' | 'updated_at' | 'id';
+/** 絞り込みの指定（項目の key ごと、公開日時・更新日時は範囲） */
+type ListFilter<T extends ContentType = ContentType> = Readonly<{ [F in FieldsOf<T> as [FilterValue<F>] extends [never] ? never : F['key']]?: FilterValue<F>; } & {
+  published_at?: Range<string>;
+  updated_at?: Range<string>;
+}>;
+/**
+ * 型の一覧の指定
+ * - limit: 1ページの件数（サーバーの上限は100）
+ * - cursor: 前のページの next
+ * - order: 並べ替えの key の配列（`-` の接頭辞で降順、最後に id を自動で追加）
+ * - filter: 項目の key ごとの絞り込み（複数の値の項目は値を含む行）
+ */
+type ListQuery<T extends ContentType = ContentType> = Readonly<{
+  limit?: number;
+  cursor?: string | null;
+  order?: readonly (OrderKey<T> | `-${OrderKey<T>}`)[];
+  filter?: ListFilter<T>;
+}>;
+/** ページ送りの応答（next は次のページの cursor、最後のページは null） */
+type Page<I = Item> = Readonly<{
+  items: readonly I[];
+  next: string | null;
+}>;
+/** どの型の一覧の指定も受け取る形（型の検査は ListQuery の側） */
+type QueryShape = Readonly<{
+  limit?: number;
+  cursor?: string | null;
+  order?: readonly string[];
+  filter?: Readonly<Record<string, unknown>>;
+}>;
+/** 一覧の指定をクエリの組に（find・get・subPath の params、一式の path に使用） */
+export declare function listParams(query: QueryShape): Record<string, string>;
+/** 配信 API のパスの前半 */
+export declare const DELIVERY_PATH = "/content/v1";
+/** 配信 API への接続（path は /content/v1 から始まるパスとクエリ） */
+type Delivery = (path: string, init?: RequestInit) => Promise<Response>;
+/** 一式の経路ごとの結果（body は経路の応答の JSON） */
+type BundleResult = Readonly<{
+  status: number;
+  body: unknown;
+}>;
+/**
+ * 一式の取得の結果
+ * - notModified: ETag が一致、etag: 応答の ETag、stale: 失敗のため最後に成功した値
+ * - partial: 一部の経路が 5xx の一式 x-partial（最後に成功した値や描画の結果として保存しない）
+ */
+type Prefetched = Readonly<{
+  notModified: boolean;
+  etag: string | null;
+  stale: boolean;
+  partial: boolean;
+}>;
+/** 配信 API の取得の失敗（call: 失敗した経路、status: 応答のステータス） */
+export declare class DeliveryError extends Error {
+  readonly call: string;
+  readonly status: number;
+  constructor(call: string, status: number, body: string);
+}
+/** 配信 API の中のパスとクエリ（一式の path と結果のキー） */
+export declare const subPath: (path: string, params?: Readonly<Record<string, string>>) => string;
+/**
+ * 配信 API の読み取り
+ * - drafts: 下書き・予約なども含める（プレビュー用、署名は接続の側で付与）
+ * - at: 公開の基準の日時（なしは今）
+ */
+export declare function createDeliveryClient(delivery: Delivery, { drafts, at }?: {
+  drafts?: boolean;
+  at?: string;
+}): {
+  find: <T>(path: string, params?: Readonly<Record<string, string>>) => Promise<T | undefined>;
+  get: <T>(path: string, params?: Readonly<Record<string, string>>) => Promise<T>;
+  page: <I = Readonly<Record<string, unknown>>, T extends ContentType = Readonly<{
+    id: string;
+    label: string;
+    description?: string;
+    format?: ContentFormat;
+    publishing?: Publishing;
+    table?: string;
+    core?: readonly FieldDef[];
+    fields: readonly FieldDef[];
+    pages?: readonly PageDef[];
+    counts?: readonly CountDef[];
+    og?: string;
+  }>>(path: string, query: ListQuery<T> & Readonly<{
+    limit: number;
+  }>) => Promise<Page<I>>;
+  prefetch: (paths: readonly string[], { ifNoneMatch }?: {
+    ifNoneMatch?: string;
+  }) => Promise<Prefetched>;
+};
+/** 配信 API の読み取り（createDeliveryClient の戻り値） */
+type DeliveryClient = ReturnType<typeof createDeliveryClient>;
+/** 配信する画像の URL（元の URL と、元画像の画素での切り抜きの範囲から、配信の側で変換する URL） */
+type ImageUrl = (src: string, rect?: CropRect) => string;
+/** 実体から表示の素材（見つからない実体はなし） */
+type MediaOf = (asset: unknown) => Media | undefined;
+/**
+ * 実体から表示の素材への変換（動画は代わりの画像も）
+ * - base: 実体の URL の前半（URL は base/<ID>）
+ * - 画像の変換: imageUrl があれば画像（動画の実体は除く）を変換の URL に、切り抜きは切り抜いた画像の URL・寸法・見せたい点
+ * - imageUrl なし: 元の画像のまま（手元の開発）
+ */
+export declare function mediaOf(base: string, imageUrl?: ImageUrl): MediaOf;
+/** 選択肢の項目から表示名の表（値 → 表示名、key はまとまりの中なら `links.kind` の形、選択肢の項目でなければ空） */
+export declare const optionLabels: <K extends string = string>(schema: ContentModel, type: string, key: string) => Readonly<Record<K, string>>;
+/** 型の項目（コアの項目と追加の項目から、なければ例外: 導入先の設定の誤り） */
+export declare function fieldOf(schema: ContentModel, type: string, key: string): FieldDef;
+/** 項目の宣言の上限（宣言がなければ例外） */
+export declare function limitOf(field: FieldDef, name: 'maxItems' | 'maxLength'): number;
+/** ページのパス（型の宣言 pages から、ページのない型は例外） */
+export declare function pagePath(schema: ContentModel, type: string, entry: PageEntry): string;
+/** 媒体のタイムゾーンでの日時の変換（表示用の日付と日時の組 dated を含む） */
+type DeliveryClock = Clock & Readonly<{
+  /** 日時の項目から、表示用のタイムゾーンの日付と `ISO 8601` の日時（日時の形でない値はそのまま） */
+  dated: (value: string) => Readonly<{
+    date: DateString;
+    at: string;
+  }>;
+}>;
+/** 日時の変換を作成（timeZone は媒体の設定にある IANA の名前） */
+export declare function createDeliveryClock(timeZone: string): DeliveryClock;
+export type { BundleResult, DeliveredAsset, Delivery, DeliveryClient, DeliveryClock, FieldValue, ImageUrl, Item, ItemOf, ListFilter, ListQuery, MediaOf, Page, Prefetched };

package/dist/delivery.js

@@ -0,0 +1,199 @@
+import { c as croppedHotspot, d as createClock, i as typeOf, r as optionsOf, s as cropRect, t as pagePathOf } from "./page-UEKb7_gu.js";
+// ../delivery-client/src/query.ts
+const isRecord = (v) => typeof v === "object" && v !== null && !Array.isArray(v);
+/** in の値の検査（コンマを含む値はクエリで区切れない） */
+const joined = (values) => {
+	const parts = values.map(String);
+	const bad = parts.find((p) => p.includes(","));
+	if (bad !== void 0) throw new Error(`in の値にコンマは不可: ${bad}`);
+	return parts.join(",");
+};
+/** 一覧の指定をクエリの組に（find・get・subPath の params、一式の path に使用） */
+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;
+		}
+		if ("in" in value) params[`filter[${key}][in]`] = joined(value.in);
+		for (const op of ["gte", "lte"]) if (value[op] !== void 0) params[`filter[${key}][${op}]`] = String(value[op]);
+	}
+	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;
+}
+// ../delivery-client/src/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")
+		};
+	};
+	return {
+		find,
+		get,
+		page,
+		prefetch
+	};
+}
+// ../delivery-client/src/media.ts
+/**
+* 実体から表示の素材への変換（動画は代わりの画像も）
+* - base: 実体の URL の前半（URL は base/<ID>）
+* - 画像の変換: imageUrl があれば画像（動画の実体は除く）を変換の URL に、切り抜きは切り抜いた画像の URL・寸法・見せたい点
+* - imageUrl なし: 元の画像のまま（手元の開発）
+*/
+function mediaOf(base, imageUrl) {
+	const still = (a) => {
+		const src = `${base}/${a.id}`;
+		const alt = a.alt ?? "";
+		if (!imageUrl || a.kind !== "image") return {
+			src,
+			width: a.width,
+			height: a.height,
+			alt,
+			...a.hotspot ? { hotspot: a.hotspot } : {}
+		};
+		if (!a.crop) return {
+			src: imageUrl(src),
+			width: a.width,
+			height: a.height,
+			alt,
+			...a.hotspot ? { hotspot: a.hotspot } : {}
+		};
+		const rect = cropRect(a.width, a.height, a.crop);
+		return {
+			src: imageUrl(src, rect),
+			width: rect.width,
+			height: rect.height,
+			alt,
+			...a.hotspot ? { hotspot: croppedHotspot(a.hotspot, a.crop) } : {}
+		};
+	};
+	return (v) => {
+		if (v === null || v === void 0) return void 0;
+		const a = v;
+		return a.kind === "video" && a.poster ? {
+			kind: "video",
+			...still(a),
+			poster: still(a.poster)
+		} : {
+			kind: "image",
+			...still(a)
+		};
+	};
+}
+// ../delivery-client/src/schema.ts
+/** 選択肢の項目から表示名の表（値 → 表示名、key はまとまりの中なら `links.kind` の形、選択肢の項目でなければ空） */
+const optionLabels = (schema, type, key) => Object.fromEntries(optionsOf(typeOf(schema, type), key).map((o) => [o.value, o.label]));
+/** 型の項目（コアの項目と追加の項目から、なければ例外: 導入先の設定の誤り） */
+function fieldOf(schema, type, key) {
+	const t = typeOf(schema, type);
+	const field = [...t.core ?? [], ...t.fields].find((f) => f.key === key);
+	if (!field) throw new Error(`型 ${type} に項目 ${key} がない`);
+	return field;
+}
+/** 項目の宣言の上限（宣言がなければ例外） */
+function limitOf(field, name) {
+	const value = field[name];
+	if (value === void 0) throw new Error(`項目 ${field.key} に ${name} の宣言がない`);
+	return value;
+}
+/** ページのパス（型の宣言 pages から、ページのない型は例外） */
+function pagePath(schema, type, entry) {
+	const path = pagePathOf(typeOf(schema, type), entry);
+	if (path === null) throw new Error(`サイトのページがない型: ${type}`);
+	return path;
+}
+/** 日時の変換を作成（timeZone は媒体の設定にある IANA の名前） */
+function createDeliveryClock(timeZone) {
+	const clock = createClock(timeZone);
+	return {
+		...clock,
+		dated: (value) => ({
+			date: clock.dateOf(value),
+			at: clock.toDateTime(value) ?? value
+		})
+	};
+}
+export { DELIVERY_PATH, DeliveryError, createDeliveryClient, createDeliveryClock, fieldOf, limitOf, listParams, mediaOf, optionLabels, pagePath, subPath };