cmx-sdk 0.2.2 → 0.2.3

package/dist/index.d.ts

@@ -683,6 +683,21 @@ interface DataTypeResponse {
     updatedAt: Date;
 }
 
+/**
+ * Generated by orval v7.17.2 🍺
+ * Do not edit manually.
+ * CMX SDK API
+ * CMX SDK API（コンテンツ配信＋管理）
+ * OpenAPI spec version: 1.0.0
+ */
+type DeleteManageDataTypeSlugIdParams = {
+    /**
+     * 参照中でも強制削除するか
+     * @nullable
+     */
+    force?: boolean | null;
+};
+
 /**
  * Generated by orval v7.17.2 🍺
  * Do not edit manually.
@@ -1427,11 +1442,8 @@ interface SdkComponentSuccessResponse {
  */
 
 interface SdkComponentSyncRequest {
-    /**
-     * 同期するコンポーネント定義
-     * @minItems 1
-     */
-    components: SdkComponentDefinition[];
+    /** 同期するコンポーネント定義 */
+    components?: SdkComponentDefinition[];
 }
 
 /**
@@ -1490,9 +1502,55 @@ interface SdkContentReferencesResponse {
  * CMX SDK API（コンテンツ配信＋管理）
  * OpenAPI spec version: 1.0.0
  */
+type SdkCreateContentResponseWarningsItemIssueType = typeof SdkCreateContentResponseWarningsItemIssueType[keyof typeof SdkCreateContentResponseWarningsItemIssueType];
+declare const SdkCreateContentResponseWarningsItemIssueType: {
+    readonly missing_target: "missing_target";
+    readonly cross_environment: "cross_environment";
+    readonly archived_target: "archived_target";
+};
+
+/**
+ * Generated by orval v7.17.2 🍺
+ * Do not edit manually.
+ * CMX SDK API
+ * CMX SDK API（コンテンツ配信＋管理）
+ * OpenAPI spec version: 1.0.0
+ */
+type SdkCreateContentResponseWarningsItemTargetType = typeof SdkCreateContentResponseWarningsItemTargetType[keyof typeof SdkCreateContentResponseWarningsItemTargetType];
+declare const SdkCreateContentResponseWarningsItemTargetType: {
+    readonly content: "content";
+    readonly asset: "asset";
+};
+
+/**
+ * Generated by orval v7.17.2 🍺
+ * Do not edit manually.
+ * CMX SDK API
+ * CMX SDK API（コンテンツ配信＋管理）
+ * OpenAPI spec version: 1.0.0
+ */
+
+type SdkCreateContentResponseWarningsItem = {
+    issueType: SdkCreateContentResponseWarningsItemIssueType;
+    targetType: SdkCreateContentResponseWarningsItemTargetType;
+    targetId: string;
+    componentName: string;
+    propName: string;
+    message: string;
+};
+
+/**
+ * Generated by orval v7.17.2 🍺
+ * Do not edit manually.
+ * CMX SDK API
+ * CMX SDK API（コンテンツ配信＋管理）
+ * OpenAPI spec version: 1.0.0
+ */
+
 interface SdkCreateContentResponse {
     id: string;
     slug: string;
+    warnings?: SdkCreateContentResponseWarningsItem[];
 }
 
 /**
@@ -1536,6 +1594,20 @@ interface SdkCreateEntryRequest {
     status?: SdkCreateEntryRequestStatus;
 }
 
+/**
+ * Generated by orval v7.17.2 🍺
+ * Do not edit manually.
+ * CMX SDK API
+ * CMX SDK API（コンテンツ配信＋管理）
+ * OpenAPI spec version: 1.0.0
+ */
+type SdkCustomComponentResponseStatus = typeof SdkCustomComponentResponseStatus[keyof typeof SdkCustomComponentResponseStatus];
+declare const SdkCustomComponentResponseStatus: {
+    readonly requested: "requested";
+    readonly ready: "ready";
+    readonly deprecated: "deprecated";
+};
+
 /**
  * Generated by orval v7.17.2 🍺
  * Do not edit manually.
@@ -1561,6 +1633,7 @@ interface SdkCustomComponentResponse {
     displayName: string;
     /** @nullable */
     description: string | null;
+    status: SdkCustomComponentResponseStatus;
     propsSchema: SdkCustomComponentResponsePropsSchema;
     /** @nullable */
     examples: string[] | null;
@@ -1675,6 +1748,37 @@ interface SdkDataEntriesListResponse {
     entries: SdkDataEntryResponse[];
 }
 
+/**
+ * Generated by orval v7.17.2 🍺
+ * Do not edit manually.
+ * CMX SDK API
+ * CMX SDK API（コンテンツ配信＋管理）
+ * OpenAPI spec version: 1.0.0
+ */
+interface SdkDataEntryDeletionImpactItem {
+    contentId: string;
+    contentTitle: string;
+    contentSlug: string;
+    contentStatus: string;
+    fieldSlug: string;
+}
+
+/**
+ * Generated by orval v7.17.2 🍺
+ * Do not edit manually.
+ * CMX SDK API
+ * CMX SDK API（コンテンツ配信＋管理）
+ * OpenAPI spec version: 1.0.0
+ */
+
+interface SdkDataEntryDeletionImpactResponse {
+    canDelete: boolean;
+    requiresForce: boolean;
+    totalReferences: number;
+    publishedReferences: number;
+    affectedContents: SdkDataEntryDeletionImpactItem[];
+}
+
 /**
  * Generated by orval v7.17.2 🍺
  * Do not edit manually.
@@ -2420,6 +2524,13 @@ declare const componentSchemas: {
     }>;
 };
 type ComponentName = keyof typeof componentSchemas;
+type ComponentSource = "standard" | "custom";
+type ComponentKind = "presentational" | "data-bound";
+interface ComponentBinding {
+    prop: string;
+    target: "content" | "asset" | "dataEntry";
+    strategy: "by-id";
+}
 interface ComponentDefinition<T extends ComponentName = ComponentName> {
     name: T;
     displayName: string;
@@ -2428,15 +2539,29 @@ interface ComponentDefinition<T extends ComponentName = ComponentName> {
     schema: (typeof componentSchemas)[T];
     examples: string[];
     hasReferences: boolean;
+    source: "standard";
+    kind: ComponentKind;
+    locked: true;
+    editable: false;
+    bindings?: ComponentBinding[];
+}
+interface CatalogForAIComponent {
+    name: string;
+    description: string;
+    props: Record<string, {
+        type: string;
+        description?: string;
+        required: boolean;
+    }>;
+    examples: string[];
+    source: ComponentSource;
+    kind: ComponentKind;
+    locked: boolean;
+    editable: boolean;
+    bindings?: ComponentBinding[];
 }
 declare const componentCatalog: Record<ComponentName, ComponentDefinition>;
-/**
- * コンポーネント名が有効かチェック
- */
 declare function isValidComponent(name: string): name is ComponentName;
-/**
- * コンポーネントのpropsをバリデート
- */
 declare function validateComponentProps(name: ComponentName, props: unknown): {
     success: true;
     data: unknown;
@@ -2444,27 +2569,9 @@ declare function validateComponentProps(name: ComponentName, props: unknown): {
     success: false;
     error: z.ZodError;
 };
-/**
- * 参照を持つコンポーネント名の一覧
- */
 declare function getComponentsWithReferences(): ComponentName[];
-/**
- * カテゴリでコンポーネントをグループ化
- */
 declare function getComponentsByCategory(): Record<string, ComponentDefinition[]>;
-/**
- * AI向けのカタログ情報（MCP用）
- */
-declare function getCatalogForAI(): Array<{
-    name: string;
-    description: string;
-    props: Record<string, {
-        type: string;
-        description?: string;
-        required: boolean;
-    }>;
-    examples: string[];
-}>;
+declare function getCatalogForAI(): CatalogForAIComponent[];
 
 interface ValidationError {
     type: "syntax" | "forbidden" | "component" | "props";
@@ -2539,4 +2646,4 @@ declare function renderMdx(mdx: string, references?: References, options?: Rende
  */
 declare function renderMdxPreview(mdx: string, additionalComponents?: Record<string, React.ComponentType<any>>): Promise<React.ReactElement>;
 
-export { type ApiResponse, type AssetReference, type AssetReferenceVariants, BlogCard, Button, CACHE_TAGS, Callout, CmxApiError, type CollectionConfig, type CollectionConfigDefaults, type CollectionContentDetailResponse, type CollectionContentsOptions, type CollectionContentsResponse, type CollectionListResponse, type CollectionResponse, CollectionType, type ComponentDefinition, type ComponentName, type ContentReference, type CreateCollectionRequest, type CreateContentRequest, type CreateDataTypeRequest, type CreateFormDefinitionRequest, type DataEntriesOptions, type DataEntryDetailResponse, type DataEntryItem, type DataListResponse, type DataTypeConfig, type DataTypeResponse, Embed, type ErrorResponse, type ErrorResponseDetails, type FetchOptions, type FieldDefinition, type FieldDefinitionDefaultValue, type FieldOptions, type FieldOptionsChoicesItem, FieldType, type FormDefinitionResponse, type FormDefinitionResponseConfigJson, type GetCollectionsSlugContentsParams, GetCollectionsSlugContentsSortBy, GetCollectionsSlugContentsSortOrder, type GetDataTypeSlugParams, GetDataTypeSlugSortBy, GetDataTypeSlugSortOrder, type GetManageCollectionPresets200, type GetManageCollectionPresetsParams, GetManageCollectionPresetsType, type GetManageDataTypeSlugParams, GetManageDataTypeSlugSortBy, GetManageDataTypeSlugSortOrder, GetManageDataTypeSlugStatus, type GetPreviewToken200, type GetPreviewToken200Collection, type GetPreviewToken200Content, type GetPreviewToken200References, type GetPreviewToken200ReferencesAssets, type GetPreviewToken200ReferencesAssetsVariants, type GetPreviewToken200ReferencesContents, Image, type PreviewResponse, type PublicCollectionInfo, type PublicContentDetail, type PublicContentListItem, type PublicContentParent, type PublicFetcherOptions, type PublicSubmissionRequest, type PublicSubmissionRequestData, type PublicSubmissionResponse, type ReferenceField, ReferenceFieldReferenceType, type References, type ReferencesAssets, type ReferencesContents, type RenderOptions, type RenderResult, type ResolvedReferences, type RevalidationConfig, type SchemaCollection, type SchemaDataType, type SchemaFieldDefinition, type SchemaFieldOption, type SchemaFieldOptionChoicesItem, type SchemaFormDefinition, type SchemaResponse, type SdkAddCollectionDataTypeRequest, SdkAddCollectionDataTypeRequestReferenceType, type SdkCollectionDataTypeResponse, type SdkCollectionDataTypeResponseAllOf, type SdkComponentDefinition, type SdkComponentDefinitionPropsSchema, type SdkComponentProp, type SdkComponentPropDefault, type SdkComponentSuccessResponse, type SdkComponentSyncRequest, type SdkContentReferencesResponse, type SdkContentReferencesResponseReferencesItem, type SdkContentReferencesResponseReferencesItemDataEntriesItem, type SdkContentReferencesResponseReferencesItemDataEntriesItemData, type SdkCreateContentResponse, type SdkCreateEntryRequest, type SdkCreateEntryRequestDataJson, SdkCreateEntryRequestStatus, type SdkCustomComponentResponse, type SdkCustomComponentResponsePropsSchema, type SdkCustomComponentsListResponse, type SdkDataEntriesListResponse, type SdkDataEntryDetailResponse, type SdkDataEntryResponse, type SdkDataEntryResponseCreatedAt, type SdkDataEntryResponseDataJson, SdkDataEntryResponseStatus, type SdkDataEntryResponseUpdatedAt, type SdkDataTypeInfo, type SdkDeleteCollectionDataTypeResponse, type SdkDeleteCollectionResponse, type SdkDeleteDataEntryResponse, type SdkDeleteDataTypeResponse, type SdkDeleteFormDefinitionResponse, type SdkLinkExistingDataTypeRequest, SdkLinkExistingDataTypeRequestReferenceType, type SdkPreset, SdkPresetReferenceType, type SdkPublishContentResponse, type SdkRequestReviewResponse, type SdkSetContentReferencesRequest, type SdkSetContentReferencesRequestReferencesItem, type SdkSetContentReferencesResponse, type SdkUpdateEntryRequest, type SdkUpdateEntryRequestDataJson, SdkUpdateEntryRequestStatus, type UpdateCollectionRequest, type UpdateDataTypeRequest, type UpdateFormDefinitionRequest, type UpdateFormDefinitionRequestConfigJson, type ValidationError, type ValidationResult, basicComponents, componentCatalog, componentSchemas, customComponents, getCatalogForAI, getCollectionContentDetail, getCollectionContentDetailOrThrow, getCollectionContents, getCollectionContentsOrThrow, getCollections, getCollectionsSlugContents, getCollectionsSlugContentsContentSlug, getComponentsByCategory, getComponentsWithReferences, getDataEntries, getDataEntriesOrThrow, getDataEntry, getDataEntryOrThrow, getDataTypeSlug, getGetCollectionsSlugContentsContentSlugUrl, getGetCollectionsSlugContentsUrl, getGetDataTypeSlugUrl, getGetPreviewTokenUrl, getPreviewByToken, getPreviewToken, getSchema, getSdkApiBaseUrl, getSdkApiToken, isValidComponent, markdownComponents, mdxComponents, quickValidateMdx, renderMdx, renderMdxPreview, sdkCustomInstance, sdkFetchWithTags, sdkFetcher, sdkPostFetcher, submitFormData, validateComponentProps, validateMdx };
+export { type ApiResponse, type AssetReference, type AssetReferenceVariants, BlogCard, Button, CACHE_TAGS, Callout, CmxApiError, type CollectionConfig, type CollectionConfigDefaults, type CollectionContentDetailResponse, type CollectionContentsOptions, type CollectionContentsResponse, type CollectionListResponse, type CollectionResponse, CollectionType, type ComponentDefinition, type ComponentName, type ContentReference, type CreateCollectionRequest, type CreateContentRequest, type CreateDataTypeRequest, type CreateFormDefinitionRequest, type DataEntriesOptions, type DataEntryDetailResponse, type DataEntryItem, type DataListResponse, type DataTypeConfig, type DataTypeResponse, type DeleteManageDataTypeSlugIdParams, Embed, type ErrorResponse, type ErrorResponseDetails, type FetchOptions, type FieldDefinition, type FieldDefinitionDefaultValue, type FieldOptions, type FieldOptionsChoicesItem, FieldType, type FormDefinitionResponse, type FormDefinitionResponseConfigJson, type GetCollectionsSlugContentsParams, GetCollectionsSlugContentsSortBy, GetCollectionsSlugContentsSortOrder, type GetDataTypeSlugParams, GetDataTypeSlugSortBy, GetDataTypeSlugSortOrder, type GetManageCollectionPresets200, type GetManageCollectionPresetsParams, GetManageCollectionPresetsType, type GetManageDataTypeSlugParams, GetManageDataTypeSlugSortBy, GetManageDataTypeSlugSortOrder, GetManageDataTypeSlugStatus, type GetPreviewToken200, type GetPreviewToken200Collection, type GetPreviewToken200Content, type GetPreviewToken200References, type GetPreviewToken200ReferencesAssets, type GetPreviewToken200ReferencesAssetsVariants, type GetPreviewToken200ReferencesContents, Image, type PreviewResponse, type PublicCollectionInfo, type PublicContentDetail, type PublicContentListItem, type PublicContentParent, type PublicFetcherOptions, type PublicSubmissionRequest, type PublicSubmissionRequestData, type PublicSubmissionResponse, type ReferenceField, ReferenceFieldReferenceType, type References, type ReferencesAssets, type ReferencesContents, type RenderOptions, type RenderResult, type ResolvedReferences, type RevalidationConfig, type SchemaCollection, type SchemaDataType, type SchemaFieldDefinition, type SchemaFieldOption, type SchemaFieldOptionChoicesItem, type SchemaFormDefinition, type SchemaResponse, type SdkAddCollectionDataTypeRequest, SdkAddCollectionDataTypeRequestReferenceType, type SdkCollectionDataTypeResponse, type SdkCollectionDataTypeResponseAllOf, type SdkComponentDefinition, type SdkComponentDefinitionPropsSchema, type SdkComponentProp, type SdkComponentPropDefault, type SdkComponentSuccessResponse, type SdkComponentSyncRequest, type SdkContentReferencesResponse, type SdkContentReferencesResponseReferencesItem, type SdkContentReferencesResponseReferencesItemDataEntriesItem, type SdkContentReferencesResponseReferencesItemDataEntriesItemData, type SdkCreateContentResponse, type SdkCreateContentResponseWarningsItem, SdkCreateContentResponseWarningsItemIssueType, SdkCreateContentResponseWarningsItemTargetType, type SdkCreateEntryRequest, type SdkCreateEntryRequestDataJson, SdkCreateEntryRequestStatus, type SdkCustomComponentResponse, type SdkCustomComponentResponsePropsSchema, SdkCustomComponentResponseStatus, type SdkCustomComponentsListResponse, type SdkDataEntriesListResponse, type SdkDataEntryDeletionImpactItem, type SdkDataEntryDeletionImpactResponse, type SdkDataEntryDetailResponse, type SdkDataEntryResponse, type SdkDataEntryResponseCreatedAt, type SdkDataEntryResponseDataJson, SdkDataEntryResponseStatus, type SdkDataEntryResponseUpdatedAt, type SdkDataTypeInfo, type SdkDeleteCollectionDataTypeResponse, type SdkDeleteCollectionResponse, type SdkDeleteDataEntryResponse, type SdkDeleteDataTypeResponse, type SdkDeleteFormDefinitionResponse, type SdkLinkExistingDataTypeRequest, SdkLinkExistingDataTypeRequestReferenceType, type SdkPreset, SdkPresetReferenceType, type SdkPublishContentResponse, type SdkRequestReviewResponse, type SdkSetContentReferencesRequest, type SdkSetContentReferencesRequestReferencesItem, type SdkSetContentReferencesResponse, type SdkUpdateEntryRequest, type SdkUpdateEntryRequestDataJson, SdkUpdateEntryRequestStatus, type UpdateCollectionRequest, type UpdateDataTypeRequest, type UpdateFormDefinitionRequest, type UpdateFormDefinitionRequestConfigJson, type ValidationError, type ValidationResult, basicComponents, componentCatalog, componentSchemas, customComponents, getCatalogForAI, getCollectionContentDetail, getCollectionContentDetailOrThrow, getCollectionContents, getCollectionContentsOrThrow, getCollections, getCollectionsSlugContents, getCollectionsSlugContentsContentSlug, getComponentsByCategory, getComponentsWithReferences, getDataEntries, getDataEntriesOrThrow, getDataEntry, getDataEntryOrThrow, getDataTypeSlug, getGetCollectionsSlugContentsContentSlugUrl, getGetCollectionsSlugContentsUrl, getGetDataTypeSlugUrl, getGetPreviewTokenUrl, getPreviewByToken, getPreviewToken, getSchema, getSdkApiBaseUrl, getSdkApiToken, isValidComponent, markdownComponents, mdxComponents, quickValidateMdx, renderMdx, renderMdxPreview, sdkCustomInstance, sdkFetchWithTags, sdkFetcher, sdkPostFetcher, submitFormData, validateComponentProps, validateMdx };

package/dist/index.js

@@ -597,29 +597,24 @@ var mdxComponents = {
 // src/mdx/component-catalog.ts
 import { z } from "zod";
 var componentSchemas = {
-  // BlogCard: 他記事への参照
   BlogCard: z.object({
     contentId: z.string().uuid().describe("\u53C2\u7167\u5148\u30B3\u30F3\u30C6\u30F3\u30C4\u306EUUID")
   }),
-  // Image: 画像表示
   Image: z.object({
     assetId: z.string().uuid().describe("\u30A2\u30BB\u30C3\u30C8\u306EUUID"),
     alt: z.string().optional().describe("\u4EE3\u66FF\u30C6\u30AD\u30B9\u30C8"),
     size: z.enum(["thumbnail", "medium", "large", "original"]).default("large").describe("\u8868\u793A\u30B5\u30A4\u30BA"),
     caption: z.string().optional().describe("\u30AD\u30E3\u30D7\u30B7\u30E7\u30F3")
   }),
-  // Callout: 注意書きボックス
   Callout: z.object({
     type: z.enum(["info", "warning", "error", "success", "tip"]).default("info").describe("\u30BF\u30A4\u30D7"),
     title: z.string().optional().describe("\u30BF\u30A4\u30C8\u30EB"),
     children: z.string().describe("\u672C\u6587\uFF08Markdown\u53EF\uFF09")
   }),
-  // Embed: 外部埋め込み
   Embed: z.object({
     url: z.string().url().describe("\u57CB\u3081\u8FBC\u307FURL"),
     type: z.enum(["youtube", "twitter", "generic"]).default("generic").describe("\u30BF\u30A4\u30D7")
   }),
-  // Button: ボタンリンク
   Button: z.object({
     href: z.string().describe("\u30EA\u30F3\u30AF\u5148URL"),
     children: z.string().describe("\u30DC\u30BF\u30F3\u30C6\u30AD\u30B9\u30C8"),
@@ -634,7 +629,12 @@ var componentCatalog = {
     category: "reference",
     schema: componentSchemas.BlogCard,
     examples: ['<BlogCard contentId="123e4567-e89b-12d3-a456-426614174000" />'],
-    hasReferences: true
+    hasReferences: true,
+    source: "standard",
+    kind: "data-bound",
+    locked: true,
+    editable: false,
+    bindings: [{ prop: "contentId", target: "content", strategy: "by-id" }]
   },
   Image: {
     name: "Image",
@@ -646,7 +646,12 @@ var componentCatalog = {
       '<Image assetId="123e4567-e89b-12d3-a456-426614174000" alt="\u8AAC\u660E" />',
       '<Image assetId="123e4567-e89b-12d3-a456-426614174000" size="medium" caption="\u30AD\u30E3\u30D7\u30B7\u30E7\u30F3" />'
     ],
-    hasReferences: true
+    hasReferences: true,
+    source: "standard",
+    kind: "data-bound",
+    locked: true,
+    editable: false,
+    bindings: [{ prop: "assetId", target: "asset", strategy: "by-id" }]
   },
   Callout: {
     name: "Callout",
@@ -658,7 +663,11 @@ var componentCatalog = {
       '<Callout type="info">\u3053\u308C\u306F\u60C5\u5831\u3067\u3059</Callout>',
       '<Callout type="warning" title="\u6CE8\u610F">\u91CD\u8981\u306A\u6CE8\u610F\u4E8B\u9805\u3067\u3059</Callout>'
     ],
-    hasReferences: false
+    hasReferences: false,
+    source: "standard",
+    kind: "presentational",
+    locked: true,
+    editable: false
   },
   Embed: {
     name: "Embed",
@@ -670,7 +679,11 @@ var componentCatalog = {
       '<Embed url="https://www.youtube.com/watch?v=dQw4w9WgXcQ" type="youtube" />',
       '<Embed url="https://twitter.com/example/status/123456789" type="twitter" />'
     ],
-    hasReferences: false
+    hasReferences: false,
+    source: "standard",
+    kind: "presentational",
+    locked: true,
+    editable: false
   },
   Button: {
     name: "Button",
@@ -682,7 +695,11 @@ var componentCatalog = {
       '<Button href="/contact">\u304A\u554F\u3044\u5408\u308F\u305B</Button>',
       '<Button href="https://example.com" variant="secondary">\u8A73\u7D30\u3092\u898B\u308B</Button>'
     ],
-    hasReferences: false
+    hasReferences: false,
+    source: "standard",
+    kind: "presentational",
+    locked: true,
+    editable: false
   }
 };
 function isValidComponent(name) {
@@ -727,7 +744,12 @@ function getCatalogForAI() {
       name: def.name,
       description: def.description,
       props,
-      examples: def.examples
+      examples: def.examples,
+      source: def.source,
+      kind: def.kind,
+      locked: def.locked,
+      editable: def.editable,
+      bindings: def.bindings
     };
   });
 }