@getdraft/plugin 1.17.5 → 1.19.0-alpha.0

package/src/types.ts

@@ -23,6 +23,56 @@ type PersonalizationDictionaryEntry =
 
 export type PersonalizationDictionaryItems = PersonalizationDictionaryEntry[];
 
+export type SectionPersonalizationValue = string | number | boolean | null;
+
+export interface SectionPersonalizationField {
+  id: string;
+  operatorId: 'equals';
+}
+
+export interface SectionPersonalizationCatalogOption {
+  label: string;
+  value: Exclude<SectionPersonalizationValue, null>;
+}
+
+export interface SectionPersonalizationCatalogGroup {
+  type: 'group';
+  id: string;
+  label: string;
+  children: SectionPersonalizationCatalogNode[];
+}
+
+export interface SectionPersonalizationCatalogField {
+  type: 'field';
+  id: string;
+  label: string;
+  valueType?: 'string' | 'number' | 'boolean' | 'date';
+  options?: SectionPersonalizationCatalogOption[];
+}
+
+export type SectionPersonalizationCatalogNode =
+  | SectionPersonalizationCatalogGroup
+  | SectionPersonalizationCatalogField;
+
+export interface SectionPersonalizationConfig {
+  enabled: boolean;
+  aboutUrl?: string;
+}
+
+export interface RenderSectionPersonalizationGroupInput {
+  groupId: string;
+  fields: SectionPersonalizationField[];
+  variants: Array<{
+    id: string;
+    values: Record<string, SectionPersonalizationValue>;
+    html: string;
+  }>;
+  fallback?: {
+    id: string;
+    html: string;
+  };
+}
+
 export interface SerializedTemplate {
   [key: string]: unknown;
   parentId: string | null;
@@ -55,6 +105,7 @@ export type MessageData = {
   code?: string;
   message?: string;
   action?: string;
+  requestId?: string;
 };
 
 export interface ExportAsFileParams {
@@ -266,6 +317,14 @@ export interface Handlers {
   openGallery: EventHandler<(url?: string) => Promise<void>>;
   uploadImage: AsyncEventHandler<UploadImageParams, string>;
   loadPersonalization: AsyncEventHandler<void, PersonalizationDictionary>;
+  loadSectionPersonalizationCatalog: AsyncEventHandler<
+    void,
+    SectionPersonalizationCatalogNode[]
+  >;
+  renderSectionPersonalizationGroup: AsyncEventHandler<
+    RenderSectionPersonalizationGroupInput,
+    string
+  >;
 }
 
 export type HandlerParams<H> = H extends
@@ -290,6 +349,7 @@ export interface PluginConfig {
   pluginId: string;
   apiUrl: string;
   disableHotkeysPassing?: boolean;
+  sectionPersonalization?: SectionPersonalizationConfig;
   __config?: object;
   on: Partial<Handlers>;
 }