@ryusenkei/maezae 0.18.0 → 0.19.0

package/dist/types/body/src/inline.d.ts

@@ -0,0 +1,20 @@
+import type { Mark, TextStyle } from './types.js';
+/** 装飾の順序（外側から内側、Markdown と HTML の入れ子の順） */
+export declare const MARK_ORDER: readonly ["strong", "em", "strike", "underline", "mark", "sup", "sub", "code"];
+/** 装飾を MARK_ORDER の順に並べる（重複は1つ） */
+export declare const sortMarks: (marks: readonly Mark[] | undefined) => Mark[];
+/** 装飾の描画の HTML の要素 */
+export declare const MARK_HTML_TAGS: {
+    readonly strong: "strong";
+    readonly em: "em";
+    readonly code: "code";
+    readonly strike: "s";
+    readonly mark: "mark";
+    readonly sup: "sup";
+    readonly sub: "sub";
+    readonly underline: "u";
+};
+/** HTML の要素の装飾（描画の要素と、リッチエディタが使うほかの要素） */
+export declare const HTML_TAG_MARKS: Readonly<Record<string, Mark>>;
+/** 内側の見た目に外側の見た目を重ねる（内側を優先、名前のついた装飾は合わせる） */
+export declare const mergeStyle: (outer: TextStyle | undefined, inner: TextStyle | undefined) => TextStyle | undefined;

package/dist/types/body/src/normalize.d.ts

@@ -1,6 +1,4 @@
-import { type Body, type Mark, type Rich } from './types.js';
-/** 装飾の順序（Markdown では外側から内側） */
-export declare const MARK_ORDER: readonly Mark[];
+import { type Body, type Rich } from './types.js';
 /** インラインの断片の列を正規化 */
 export declare function normalizeRich(rich: Rich): Rich;
 /** 本文を正規化 */

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

@@ -9,7 +9,7 @@ export { type CallApi, type ConnectionPoint, type ContentTypePoint, createModule
 export { applyFieldRules, autoFieldsOf, type FieldRule, hiddenFieldsOf, restrictedChoicesOf, restrictedProblemsOf } from './fieldRules.js';
 export { pendingIds, pendingValue } from './pending.js';
 export { type AccountLink, type Action, ACTION_LEVELS, ACTIONS, allows, ANY_TARGET, canChangeRow, canDeleteContent, canEditContent, canPublishContent, canReadContent, canReadRow, canSubmitContent, checkPermissions, type ContentAccess, type Level, LEVELS, levelOf, ownsContent, ownsRow, type Permissions, type RowAccess } from './permissions.js';
-export { ADMIN_PERMISSIONS, ADMIN_ROLE, defaultRoleOf, isAdmin, rolePermissionsOf, type Role, SYSTEM_ROLES, type User, WRITER_ROLE } from './roles.js';
+export { ADMIN_PERMISSIONS, ADMIN_ROLE, defaultRoleOf, isAdmin, rolePermissionsOf, type Role, SYSTEM_ROLES, type User, DEFAULT_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, type MicroCmsApiInput, type MicroCmsContentResult, type MicroCmsDropped, type MicroCmsNote, planImportIds, sourceOf } from './import.js';

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

@@ -1,15 +1,15 @@
 import { type AccountLink, type Permissions } from './permissions.js';
 /** 管理者のロールの ID */
 export declare const ADMIN_ROLE = "admin";
-/** ライターのロールの ID（あれば新しいアカウントの既定、削除できる） */
-export declare const WRITER_ROLE = "writer";
+/** 新しいアカウントの既定のロールの ID（テンプレートのロールの ID、あれば既定、削除できる） */
+export declare const DEFAULT_ROLE = "writer";
 /** 管理者の権限の表（すべての対象・操作が可、DB の値より優先） */
 export declare const ADMIN_PERMISSIONS: Permissions;
 /** ロールの権限の表（管理者のロールは固定の表、ほかは保存した表） */
 export declare const rolePermissionsOf: (roleId: string, stored: Permissions) => Permissions;
 /** 削除できないロールの ID */
 export declare const SYSTEM_ROLES: readonly string[];
-/** 新しいアカウントの既定のロール（ライター、なければ管理者以外の最初のロール、それもなければ管理者） */
+/** 新しいアカウントの既定のロール（DEFAULT_ROLE、なければ管理者以外の最初のロール、それもなければ管理者） */
 export declare const defaultRoleOf: (roles: readonly Pick<Role, "id">[]) => string;
 /** ロール（API /api/roles の行） */
 export type Role = Readonly<{

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

@@ -60,6 +60,22 @@ export type Asset = ImageAsset | VideoAsset | FileAsset;
 export type AssetRef = Readonly<{
     asset: string;
 }>;
+/** 配信 API が解決した実体（url は配信 URL で配信のオリジンがある CMS だけ、hotspot・crop は元の画像に対する割合） */
+export type DeliveredAsset = Readonly<{
+    id: string;
+    kind: 'image' | 'video' | 'file';
+    url?: string;
+    width: number;
+    height: number;
+    alt: string;
+    hotspot?: Hotspot;
+    crop?: Crop;
+    poster?: DeliveredAsset | null; /** 非公開の実体（url は署名のない配信 URL、signMediaUrl で署名して渡す） */
+    visibility?: 'private'; /** ファイルの元のファイル名・形式・大きさ（バイト） */
+    name?: string;
+    mimeType?: string;
+    size?: number;
+}>;
 /**
  * 表示する素材の共通の項目
  * - src: URL（CMS の実体）か、ビルドで読み込んだ画像

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

@@ -1,14 +1,15 @@
 export { fieldZod, jsonSchemaOf, normalizeValues, zodOf, type ValueOptions } from './input.js';
-export { assetRefSchema, cropSchema, hotspotSchema, mediaSchema, type Asset, type AssetRef, type Crop, type Hotspot, type LocalImage, type Media } from './asset.js';
+export { assetRefSchema, cropSchema, hotspotSchema, mediaSchema, type Asset, type AssetRef, type Crop, type DeliveredAsset, type Hotspot, type LocalImage, type Media } from './asset.js';
 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, MEDIA_SIGNING_KEY_BLOB, mediaBlobKeyOf, mediaExtOf, mediaKindOf, mediaMimeOf, mediaPathOf, parseMediaPath, signMediaUrl, verifyMediaUrl, withImageParams, type ImageParams, type AssetKind, type MediaPath } from './mediaUrl.js';
+export { IMAGE_SIZE_MAX, imageParamsOf, isMediaId, MEDIA_SIGNING_KEY_BLOB, mediaBlobKeyOf, mediaExtOf, mediaKindOf, mediaMimeOf, mediaPathOf, parseMediaPath, signMediaUrl, verifyMediaUrl, withImageParams, type ImageParams, type AssetKind, type MediaPath } from './mediaUrl.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 { typesSourceOf } from './typesSource.js';
 export { entryRefsOf, type EntryRef } from './refs.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, usesReview } from './model.js';
+export { acceptsRole, bodyFieldsOf, computedFieldsOf, FIELD_ROLES, idInputOf, initialValueOf, isPublishable, 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, usesReview } 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/mediaUrl.d.ts

@@ -16,6 +16,8 @@ export type MediaPath = Readonly<{
     width?: number;
     height?: number;
 }>;
+/** 実体の ID の形か（CMS の /media と配信の Worker の共通、保存先のほかのキーを ID として読ませない） */
+export declare const isMediaId: (id: string) => boolean;
 /** 配信 URL のパス（媒体・ID の形が不正、配信しない形式なら null） */
 export declare function mediaPathOf({ kind, project, id, mimeType, width, height }: Readonly<{
     kind: AssetKind;

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

@@ -183,7 +183,7 @@ export declare const isListType: (type: ContentType) => boolean;
  * - 機能: 版・楽観ロック・編集中のリース・コメント・公開の前の点検
  * - 提出と差し戻し・担当者: レビューありの型だけ（usesReview）
  */
-export declare const isEditorial: (type: ContentType) => boolean;
+export declare const isPublishable: (type: ContentType) => boolean;
 /**
  * レビューのワークフローを持つ型か（レビューありの一覧の型）
  * - 機能: 提出と差し戻し・担当者（レビューを担当するアカウント）

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

@@ -0,0 +1,7 @@
+import type { ContentModel } from './model.js';
+/**
+ * スキーマから配信 API の値の型の定義（TypeScript のモジュールの文）
+ * - 型ごとに `export type <PascalCase の型の id>`、全体の対応 `CmsTypes` と型の id の一覧 `TYPE_IDS`
+ * - types: 配信する型だけ（メディアの型を除いた一覧、配信 API の `/types` の値）
+ */
+export declare function typesSourceOf(model: Pick<ContentModel, 'types'>): string;

package/dist/types/{sdk/src/defaults.d.ts → platform/src/defaultModel.d.ts}

@@ -1,4 +1,7 @@
-import type { ContentModel, ScreenSettings } from '../../model/src/index.js';
+import type { BodyProfile } from '../../body/src/index.js';
+import { type ContentModel, type ScreenSettings } from '../../model/src/index.js';
+/** 既定の本文の設定（本文の項目 profile と同じ値） */
+export declare const DEFAULT_BODY_PROFILE: BodyProfile;
 /** 中立の既定のスキーマ（新しい媒体の作成で適用する型: post・author・tag・image・video、設定の移入の土台） */
 export declare const DEFAULT_SCHEMA: ContentModel;
 /** 既定の画面設定（新しい媒体の作成で適用する中立の値、移入する screens の土台） */

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

@@ -1,2 +1,12 @@
-export { recordView } from '../../analytics/src/index.js';
-export type { Classify, Dataset } from '../../analytics/src/index.js';
+import { type Classify, type ViewOptions } from '../../analytics/src/index.js';
+export type { Classify };
+/** Analytics Engine のデータセットの binding（書き込みだけ） */
+export type Dataset = {
+    writeDataPoint(point: {
+        blobs?: string[];
+        doubles?: number[];
+        indexes?: string[];
+    }): void;
+};
+/** 閲覧を1件記録（対象: GET で応答が200の HTML・ボット以外、binding なしと記録の失敗は無視） */
+export declare function recordView(dataset: Dataset | undefined, request: Request, response: Response, options: ViewOptions): void;

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

@@ -2,8 +2,8 @@ export { cachedDelivery, memoryDeliveryCache, type DeliveryCache } from './cache
 export { readChanges, type Change, type ChangesPage } from './changes.js';
 export { createDeliveryClient, DELIVERY_PATH, DeliveryError, subPath, type BundleResult, type Delivery, type DeliveryClient, type Prefetched } from './client.js';
 export { deliveredImageUrl, mediaOf, type ImageUrl, type MediaOf } from './media.js';
-export { imageParamsOf, parseMediaPath, signMediaUrl, withImageParams, type ImageParams, type MediaPath } from '../../../model/src/index.js';
+export { imageParamsOf, parseMediaPath, signMediaUrl, withImageParams, type DeliveredAsset, type ImageParams, type MediaPath } from '../../../model/src/index.js';
 export type { FieldPath, Selected } from './fields.js';
 export { listParams, type ListFilter, type ListQuery, type Page } from './query.js';
 export { createDeliveryClock, fieldOf, limitOf, optionLabels, pagePath, type DeliveryClock } from './schema.js';
-export type { DeliveredAsset, FieldValue, Item, ItemMeta, ItemOf } from './values.js';
+export type { FieldValue, Item, ItemMeta, ItemOf } from './values.js';

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

@@ -1,23 +1,7 @@
 import type { Body } from '../../../body/src/index.js';
-import type { ContentType, Crop, DateString, FieldDef, Hotspot } from '../../../model/src/index.js';
+import type { ContentType, DateString, DeliveredAsset, FieldDef } from '../../../model/src/index.js';
 /** 配信 API の1件の値（id・項目の key・メタ情報 _meta） */
 export type Item = Readonly<Record<string, unknown>>;
-/** 配信 API が解決した実体（url は配信 URL で配信のオリジンがある CMS だけ、hotspot・crop は元の画像に対する割合） */
-export type DeliveredAsset = Readonly<{
-    id: string;
-    kind: 'image' | 'video' | 'file';
-    url?: string;
-    width: number;
-    height: number;
-    alt: string;
-    hotspot?: Hotspot;
-    crop?: Crop;
-    poster?: DeliveredAsset | null; /** 非公開の実体（url は署名のない配信 URL、signMediaUrl で署名して渡す） */
-    visibility?: 'private'; /** ファイルの元のファイル名・形式・大きさ（バイト） */
-    name?: string;
-    mimeType?: string;
-    size?: number;
-}>;
 /** 項目の1つ分の値（複数の値を持つ項目は FieldValue が配列に、query.ts の絞り込みの値と共通） */
 export type SingleValue<F extends FieldDef> = F extends {
     type: 'text' | 'textarea';

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

@@ -1,5 +1,5 @@
-export { coverPosition, coverStart, createClock, cropRect, croppedHotspot, IMAGE_TYPE, isDateOnly, mediaSchema, objectPosition, pagePathOf, parseModel, parseScreens, publicPathOf, stillOf, typeOf, VIDEO_TYPE } from '../../model/src/index.js';
+export { coverPosition, coverStart, createClock, cropRect, croppedHotspot, IMAGE_TYPE, isDateOnly, mediaSchema, objectPosition, pagePathOf, parseModel, parseScreens, publicPathOf, stillOf, typeOf, typesSourceOf, VIDEO_TYPE } from '../../model/src/index.js';
 export type { Asset, AssetRef, Clock, ContentModel, ContentType, Crop, CropRect, DateString, FieldDef, Hotspot, LocalImage, Media, PageDef, PageEntry, ScreenSettings } from '../../model/src/index.js';
 export { CONFIG_FORMAT } from '../../cms-contract/src/index.js';
 export type { ConfigBundle } from '../../cms-contract/src/index.js';
-export { DEFAULT_SCHEMA, DEFAULT_SCREENS } from './defaults.js';
+export { DEFAULT_SCHEMA, DEFAULT_SCREENS } from '../../platform/src/defaultModel.js';

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

@@ -0,0 +1,5 @@
+import { type ContentType } from '../../model/src/index.js';
+/** 配信 API の型の一覧（/types、表示名・選択肢・上限・ページの URL の形を含む。実行時に読む値もここから） */
+export declare function fetchDeliveredTypes(url: string, apiKey: string, fetcher?: typeof fetch): Promise<readonly ContentType[]>;
+/** CLI の本体（戻り値は終了の状態） */
+export declare function runTypesCli(argv: readonly string[], env: Readonly<Record<string, string | undefined>>, fetcher?: typeof fetch): Promise<number>;

package/dist/types/sdk/src/types-cli.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/types-cli.d.ts

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

package/dist/types-cli.js

@@ -0,0 +1,7 @@
+#!/usr/bin/env node
+import { runTypesCli } from "./schema.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);
+});

package/dist/typesSource-BKPzvl--.js

@@ -0,0 +1,62 @@
+// ../model/src/values.ts
+/** 配信する項目（非公開の項目を除く、まとまりの中も） */
+const deliveredFields = (fields) => fields.filter((f) => !f.private).map((f) => f.type === "group" ? {
+	...f,
+	fields: deliveredFields(f.fields)
+} : f);
+// ../model/src/typesSource.ts
+/** 生成した型の定義が SDK から読む型の import の元 */
+const SDK = "@ryusenkei/maezae";
+/** 型の import の行（指定は JSON の文字列の形） */
+const importLine = (names, spec) => `import type { ${names.join(", ")} } from ${JSON.stringify(spec)};`;
+const pascal = (id) => id.replace(/(^|[-_])(\w)/g, (_, __, ch) => ch.toUpperCase());
+/** 項目の1つ分の値の型（SDK の SingleValue と同じ） */
+function singleOf(f, indent) {
+	switch (f.type) {
+		case "text":
+		case "textarea":
+		case "datetime":
+		case "reference": return "string";
+		case "date": return "DateString";
+		case "number": return "number";
+		case "checkbox": return "boolean";
+		case "select": return f.options.map((o) => JSON.stringify(o.value)).join(" | ") || "string";
+		case "media": return "DeliveredAsset | null";
+		case "body": return "Body<DeliveredAsset | null>";
+		case "group": return `{\n${fieldsOf(deliveredFields(f.fields), `${indent}  `)}\n${indent}}`;
+	}
+}
+/** 項目の値の型（SDK の FieldValue と同じ、複数は readonly の配列、値なしは null） */
+const valueOf = (f, indent) => {
+	const one = singleOf(f, indent);
+	if ("multiple" in f && f.multiple) return `readonly ${one.includes(" | ") ? `(${one})` : one}[] | null`;
+	return one.endsWith(" | null") ? one : `${one} | null`;
+};
+/** 配信する項目の種類（まとまりの中を含む） */
+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 typeOf = (t) => `export type ${pascal(t.id)} = Readonly<{\n  id: string;\n  _meta: ItemMeta;\n${fieldsOf(deliveredFields(t.fields), "  ")}\n}>;`;
+/**
+* スキーマから配信 API の値の型の定義（TypeScript のモジュールの文）
+* - 型ごとに `export type <PascalCase の型の id>`、全体の対応 `CmsTypes` と型の id の一覧 `TYPE_IDS`
+* - types: 配信する型だけ（メディアの型を除いた一覧、配信 API の `/types` の値）
+*/
+function typesSourceOf(model) {
+	const types = [...model.types].sort((a, b) => a.id < b.id ? -1 : a.id > b.id ? 1 : 0);
+	const kinds = new Set(types.flatMap((t) => kindsOf(t.fields)));
+	const uses = (kind) => kinds.has(kind);
+	const delivery = ["ItemMeta", ...uses("media") || uses("body") ? ["DeliveredAsset"] : []].sort();
+	return [
+		"// Generated from the CMS schema (GET /content/v1/types). Do not edit; regenerate with maezae-types.",
+		importLine(delivery, `${SDK}/delivery`),
+		...uses("body") ? [importLine(["Body"], `${SDK}/body`)] : [],
+		...uses("date") ? [importLine(["DateString"], `${SDK}/model`)] : [],
+		"",
+		...types.flatMap((t) => [typeOf(t), ""]),
+		`export type CmsTypes = {\n${types.map((t) => `  ${JSON.stringify(t.id)}: ${pascal(t.id)};`).join("\n")}\n};`,
+		"",
+		`export const TYPE_IDS = [${types.map((t) => JSON.stringify(t.id)).join(", ")}] as const;`,
+		""
+	].join("\n");
+}
+export { typesSourceOf as t };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ryusenkei/maezae",
-  "version": "0.18.0",
+  "version": "0.19.0",
   "description": "maezae の導入先のサイト向けの SDK（配信 API の取得・本文の型・プレビューの署名・手元の開発の配信 API）",
   "license": "UNLICENSED",
   "author": "RYUSENKEI",
@@ -43,8 +43,15 @@
     "./dev": {
       "types": "./dist/dev.d.ts",
       "default": "./dist/dev.js"
+    },
+    "./schema": {
+      "types": "./dist/schema.d.ts",
+      "default": "./dist/schema.js"
     }
   },
+  "bin": {
+    "maezae-types": "./dist/types-cli.js"
+  },
   "files": [
     "dist"
   ],

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

@@ -1,22 +0,0 @@
-/** Analytics Engine のデータセットの binding（書き込みだけ） */
-export type Dataset = {
-    writeDataPoint(point: {
-        blobs?: string[];
-        doubles?: number[];
-        indexes?: string[];
-    }): void;
-};
-/** パスから種類と ID への対応（利用側が定義、例: /articles/<id> は記事） */
-export type Classify = (path: string) => {
-    kind: string;
-    id: string;
-};
-/** 記録の設定（project は媒体の識別子） */
-type RecordOptions = {
-    classify: Classify;
-    timeZone: string;
-    project?: string;
-};
-/** 閲覧を1件記録（対象: GET で応答が200の HTML・ボット以外、記録の失敗は無視） */
-export declare function recordView(dataset: Dataset | undefined, request: Request, response: Response, { classify, timeZone, project }: RecordOptions): void;
-export {};