@ryusenkei/maezae 0.16.0 → 0.17.0

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

@@ -36,7 +36,7 @@ export type ImportItemReport = Readonly<{
     source: string;
     type: string;
     id: string | null;
-    status: 'created' | 'ready' | 'skipped';
+    status: 'created' | 'updated' | 'ready' | 'skipped';
     problems: readonly ImportProblem[];
 }>;
 /** 画像の結果（checked は試しの実行で取得できた、asset は保存した画像の ID） */
@@ -71,6 +71,7 @@ export type ImportReport = Readonly<{
     summary: Readonly<{
         items: number;
         created: number;
+        updated: number;
         ready: number;
         skipped: number;
         images: Readonly<Record<ImportImage['status'], number>>;
@@ -99,3 +100,33 @@ 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;
+/** microCMS から取り込む API（schema は API のスキーマの JSON、relations は関係の項目の fieldId と先のエンドポイント） */
+export type MicroCmsApiInput = Readonly<{
+    endpoint: string;
+    label: string;
+    format: 'list' | 'object';
+    schema: unknown;
+    relations: Readonly<Record<string, string>>;
+}>;
+/** microCMS の型の変換の注意（path は型の id と項目） */
+export type MicroCmsNote = Readonly<{
+    level: 'error' | 'warning';
+    path: string;
+    message: string;
+}>;
+/** 本文の変換で捨てたもの（what は要素・属性・style の項目・class） */
+export type MicroCmsDropped = Readonly<{
+    what: string;
+    count: number;
+}>;
+/** microCMS のコンテンツの1ページの取り込みの結果（next は次のページの offset、なしは終わり、tooLarge は大きすぎて残さなかった元の HTML） */
+export type MicroCmsContentResult = Readonly<{
+    report: ImportReport;
+    total: number;
+    next: number | null;
+    dropped: readonly MicroCmsDropped[];
+    tooLarge: readonly Readonly<{
+        id: string;
+        field: string;
+    }>[];
+}>;

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

@@ -1,21 +1,22 @@
-export { API_KEY_RATE, type ApiKey } from './apiKeys.js';
+export { API_KEY_ALL_TYPES, API_KEY_KINDS, API_KEY_OPERATIONS, API_KEY_RATE, API_KEY_WRITE_OPERATIONS, PUBLIC_FAILURE_RATE, apiKeyAllows, type ApiKey, type ApiKeyKind, type ApiKeyOperation, type ApiKeyPermissions, DEFAULT_API_KEY_PERMISSIONS } from './apiKeys.js';
 export { ASSET_BULK_MAX, ASSET_IMAGE_TYPES, ASSET_SIZE_MAX } from './assets.js';
 export { errorLabel, errorTitle, mergeMessages, TARGET_LABELS, targetOf, type TargetMessages } from './errorLabels.js';
 export { ERROR_STATUS, JSON_BODY_MAX, type ErrorBody, type ErrorCode, type ErrorParams, type ErrorTarget } from './errors.js';
-export { STATUS } from './labels.js';
+export { CHANGES_LABELS, STATUS } from './labels.js';
 export { ANALYTICS_MODULE, BUILTIN_MODULES, OG_FONTS, OG_MODULE, type OgFont, type OgSettings } from './builtins.js';
 export { type CalendarField, calendarFieldSource, type CalendarItem, type ExtensionState, type ExtensionUpdate, fieldOwnersOf, type PendingItem, permissionTargetsOf } from './extensions.js';
 export { type CallApi, type ConnectionPoint, type ContentTypePoint, createModules, type FieldRef, type McpModule, type McpModuleContext, type McpParts, type McpTool, type ModuleAbout, type ModuleBase, moduleBaseOf, type ModuleContext, type ModuleInstance, type ModuleManifest, type ModuleSettingsInput, type ModuleSide, moduleTargetsOf, type PermissionTarget, type SettingField } from './modules.js';
 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, 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, 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 { 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';
 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 { isWebhookAction, parseWebhookEvent, type Webhook, WEBHOOK_ACTION_LABELS, type WebhookBody, WEBHOOK_ACTIONS, type WebhookAction, type WebhookDelivery, type WebhookEvent, webhookEventLabel, webhookEventOf, type WebhookKind, type WebhookModuleBody, type WebhookSubscription, webhookSubscriptionLabel, WEBHOOK_VERSION, 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 { ENTRY_ACTIONS, ENTRY_STATES, type EntryAction, entryActions, type EntryChanges, entryGuard, type EntryGuard, type EntryGuardInput, type EntryRow, type EntryState, entryStateOf, isLiveState, type WorkflowPublishing } from './workflow.js';
 export { canManageSettings, isSettingsTarget, managedAreasOf, SETTINGS_AREA_LABELS, SETTINGS_AREAS, type SettingsArea, settingsTarget } from './settings.js';

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

@@ -4,3 +4,8 @@ export declare const STATUS: {
     readonly review: "レビュー待ち";
     readonly published: "公開済み";
 };
+/** 公開中・予約の行の未公開の変更（#596） */
+export declare const CHANGES_LABELS: {
+    readonly draft: "未公開の変更あり";
+    readonly review: "変更のレビュー待ち";
+};

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

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

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

@@ -1,5 +1,5 @@
-/** ビューで許可できる一括操作（assign: 担当者の割り当て、publish: 公開） */
-export declare const VIEW_ACTIONS: readonly ["assign", "publish"];
+/** ビューで許可できる一括操作（名前は行の操作 workflow.ts の EntryAction と同じ、assign は担当者の割り当て） */
+export declare const VIEW_ACTIONS: readonly ["assign", "submit", "publish", "unpublish", "delete"];
 /** ビューで許可できる一括操作 */
 export type ViewAction = (typeof VIEW_ACTIONS)[number];
 /** ビューの内容（filters は列の id ごとの絞り込みの値、query は検索の文、columns は表示する列、editable は一覧で編集する列） */

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

@@ -0,0 +1,49 @@
+import type { ErrorCode, ErrorParams } from './errors.js';
+import { type ContentAccess } from './permissions.js';
+import type { User } from './roles.js';
+/** 型の公開の管理（model の Publishing と同じ値） */
+export type WorkflowPublishing = 'none' | 'draft' | 'review';
+/** 行の派生の状態 */
+export declare const ENTRY_STATES: readonly ["draft", "returned", "review", "scheduled", "published"];
+export type EntryState = (typeof ENTRY_STATES)[number];
+/** 公開中・予約の行の未公開の変更（none はなし、review はレビュー待ち） */
+export type EntryChanges = 'none' | 'draft' | 'review';
+/** 行の操作（publish は公開・予約・再公開・変更の公開、unpublish は下書きに戻す・予約の取り消し、discard は未公開の変更の破棄） */
+export declare const ENTRY_ACTIONS: readonly ["save", "submit", "reject", "publish", "unpublish", "discard", "delete", "assign"];
+export type EntryAction = (typeof ENTRY_ACTIONS)[number];
+/** 判定に使う行の値（API の形: has_draft・draft_status は未公開の変更、持ち主の項目と created_by を含む） */
+export type EntryRow = ContentAccess & Readonly<{
+    published_at?: unknown;
+    review_note?: unknown;
+    has_draft?: unknown;
+    draft_status?: unknown;
+}>;
+type Subject = Pick<User, 'permissions' | 'id' | 'entryId' | 'link'>;
+/** 判定の材料（target は型の id、now は ISO の日時） */
+export type EntryGuardInput = Readonly<{
+    publishing: WorkflowPublishing;
+    user: Subject;
+    target: string;
+    row: EntryRow;
+    now: string;
+}>;
+/** 判定の結果（拒否はエラーのコードと引数） */
+export type EntryGuard = {
+    ok: true;
+} | {
+    ok: false;
+    code: Exclude<ErrorCode, 'network_error'>;
+    params?: ErrorParams;
+};
+/** 行の派生の状態と未公開の変更 */
+export declare function entryStateOf(row: EntryRow, now: string): {
+    state: EntryState;
+    changes: EntryChanges;
+};
+/** 公開中か予約の状態か */
+export declare const isLiveState: (state: EntryState) => boolean;
+/** 行の操作の可否 */
+export declare function entryGuard({ publishing, user, target, row, now }: EntryGuardInput, action: EntryAction): EntryGuard;
+/** 行に許される操作（ENTRY_ACTIONS の順） */
+export declare const entryActions: (input: EntryGuardInput) => EntryAction[];
+export {};

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

@@ -8,7 +8,7 @@ export { dateRoleFieldsOf, primaryTypeOf, requiredPrimaryTypeOf, SOURCES_FIELD,
 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 { 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 { 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 { 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

@@ -178,10 +178,16 @@ export declare const publishingOf: (type: ContentType) => Publishing;
 export declare const isListType: (type: ContentType) => boolean;
 /**
  * 編集の機能を持つ型か（公開の管理がある一覧の型）
- * - 機能: 版・楽観ロック・編集中のリース・コメント・担当者・公開の前の点検
- * - 提出と差し戻し: レビューありの型だけ
+ * - 機能: 版・楽観ロック・編集中のリース・コメント・公開の前の点検
+ * - 提出と差し戻し・担当者: レビューありの型だけ（usesReview）
  */
 export declare const isEditorial: (type: ContentType) => boolean;
+/**
+ * レビューのワークフローを持つ型か（レビューありの一覧の型）
+ * - 機能: 提出と差し戻し・担当者（レビューを担当するアカウント）
+ * - 下書きと公開の型: 担当者の表示・割り当て・一括の割り当てを出さない
+ */
+export declare const usesReview: (type: ContentType) => boolean;
 /** 型の行を表 entries に保存するか（メディアの型を除くすべて） */
 export declare const isStoredType: (type: ContentType) => boolean;
 /** コンテンツスキーマの型（id から、なければ例外: 導入先の設定の誤り） */

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

@@ -1,2 +1,2 @@
-export { blockSchemaOf, citesOf, DESCRIPTION_MAX, descriptionOf, excerptOf, isSafeHref, linksOf, plainOf, READING_SPEED, readMinOf } from '../../body/src/index.js';
-export type { Block, Body, BodyProfile, ComponentBlock, DeclaredComponent, HeadingLevel, Inline, InlineComponent, Link, List, ListItem, Mark, PropSchema, PropsSchema, PropType, Rich, StandardBlock, Text } from '../../body/src/index.js';
+export { blockSchemaOf, bodyToHtml, cellParagraphs, citesOf, DESCRIPTION_MAX, descriptionOf, EMBED_PROVIDERS, embedOfUrl, embedSrcOf, excerptOf, isSafeCssValue, isSafeHref, isTableCell, linksOf, plainOf, READING_SPEED, readMinOf } from '../../body/src/index.js';
+export type { Align, Block, Body, BodyProfile, Cell, ComponentBlock, DeclaredComponent, EmbedProvider, EmbedTarget, HeadingLevel, ImageAlign, Inline, InlineComponent, Link, List, ListItem, Mark, Named, NamedStyle, NamedValue, PropSchema, PropsSchema, PropType, RenderedImage, RenderOptions, Rich, StandardBlock, TableCell, Text, TextStyle } from '../../body/src/index.js';

package/package.json

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