@dotcms/types 1.5.1-next.1964 → 1.5.1-next.1965

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dotcms/types",
-  "version": "1.5.1-next.1964",
+  "version": "1.5.1-next.1965",
   "keywords": [
     "dotCMS",
     "CMS",

package/src/internal.d.ts

@@ -3,3 +3,4 @@ export * from './lib/events/internal';
 export * from './lib/editor/internal';
 export * from './lib/ai/internal';
 export * from './lib/client/internal';
+export * from './lib/style-editor/internal';

package/src/lib/page/public.d.ts

@@ -1,4 +1,5 @@
 import { DotHttpError } from '../client/public';
+import { StyleEditorFormSchema } from '../style-editor/internal';
 /**
  * Represents a map of style property keys and their corresponding values
  * for use in the style editor.
@@ -1162,6 +1163,7 @@ export interface DotCMSPageResponse {
         query: string;
         variables: Record<string, unknown>;
     };
+    styleEditorSchemas?: StyleEditorFormSchema[];
 }
 export type DotCMSExtendedPageResponse = Partial<Pick<DotCMSPageResponse, 'pageAsset' | 'content'>>;
 export type DotCMSComposedPageAsset<T extends DotCMSExtendedPageResponse> = T['pageAsset'] extends DotCMSPageResponse['pageAsset'] ? DotCMSPageResponse['pageAsset'] & T['pageAsset'] : DotCMSPageResponse['pageAsset'];

package/src/lib/style-editor/internal.d.ts

@@ -0,0 +1,69 @@
+/**
+ * Available field types for the style editor.
+ */
+export type StyleEditorFieldType = 'input' | 'dropdown' | 'radio' | 'checkboxGroup';
+/**
+ * Available input types for input fields in the style editor.
+ */
+export type StyleEditorFieldInputType = 'text' | 'number';
+/**
+ * Base option object with label and value properties.
+ */
+export interface StyleEditorOptionObject {
+    label: string;
+    value: string;
+}
+/**
+ * Extended option object for radio fields with optional image support.
+ */
+export interface StyleEditorRadioOptionObject extends StyleEditorOptionObject {
+    imageURL?: string;
+}
+/**
+ * Option type for dropdown fields.
+ */
+export type StyleEditorOption = StyleEditorOptionObject;
+/**
+ * Option type for radio fields (supports optional image).
+ */
+export type StyleEditorRadioOption = StyleEditorRadioOptionObject;
+/**
+ * Checkbox option with a key identifier instead of value.
+ */
+export interface StyleEditorCheckboxOption {
+    label: string;
+    key: string;
+}
+/**
+ * Configuration object for normalized field schemas sent to UVE.
+ */
+export interface StyleEditorFieldSchemaConfig {
+    inputType?: StyleEditorFieldInputType;
+    placeholder?: string;
+    options?: StyleEditorRadioOptionObject[];
+    columns?: 1 | 2;
+}
+/**
+ * Normalized field schema sent to UVE.
+ */
+export interface StyleEditorFieldSchema {
+    id: string;
+    type: StyleEditorFieldType;
+    label: string;
+    config: StyleEditorFieldSchemaConfig;
+}
+/**
+ * Normalized section schema sent to UVE.
+ */
+export interface StyleEditorSectionSchema {
+    title: string;
+    fields: StyleEditorFieldSchema[];
+}
+/**
+ * Complete normalized form schema sent to UVE.
+ * This is the output format after processing a style editor form definition.
+ */
+export interface StyleEditorFormSchema {
+    contentType: string;
+    sections: StyleEditorSectionSchema[];
+}