pds-dev-kit-web 1.7.5 → 1.8.0

package/dist/src/sub/DynamicLayout/types.d.ts

@@ -0,0 +1,163 @@
+export declare type TypeOfSectionManifestSchema = 'BASE_INTRO' | 'BASE_CONTENTS' | 'BASE_CONTENTS_CAROUSEL' | 'BASE_FOOTER' | 'BASE_INFO_BOX';
+export declare type TypeofSectionTemplate = 'BASE_INTRO_A' | 'BASE_INTRO_B' | 'BASE_INTRO_C' | 'BASE_INTRO_D' | 'BASE_CONTENTS_A' | 'BASE_CONTENTS_B' | 'BASE_CONTENTS_CAROUSEL_A' | 'BASE_CONTENTS_CAROUSEL_B' | 'BASE_FOOTER_A' | 'BASE_FOOTER_B' | 'BASE_INFO_BOX_A';
+export declare type TypeOfSectionContentMediaType = 'IMAGE' | 'YOUTUBE';
+export declare type TypeOfSectionLinkType = 'WEB_LINK' | 'INTERNAL_LINK' | 'NONE';
+export declare type TypeOfCarouselAutoplayMode = 'AUTO' | 'NORMAL';
+export declare type TypeOfCarouselInfiniteLoopMode = 'USE' | 'NO_USE';
+export declare type TypeOfBackgroundMediaType = 'IMAGE' | 'YOUTUBE';
+export declare type TypeOfSectionButtonDesignType = 'A' | 'B' | 'C' | 'D' | 'E' | 'F' | 'G' | 'H' | 'I';
+export declare type TypeOfItemButtonDesignType = 'A' | 'B' | 'C' | 'D' | 'E' | 'F' | 'G' | 'H' | 'I';
+export declare type TypeOfItemManifestSchema = 'BASE_CONTENTS_CAROUSEL_ITEM' | 'BASE_FOOTER_ITEM' | 'BASE_INFO_BOX_ITEM';
+export declare type TypeOfItemLinkMethod = 'CLICK_ITEM' | 'CLICK_BUTTON_IN_ITEM' | 'NONE';
+export declare type TypeOfItemLinkType = 'WEB_LINK' | 'INTERNAL_LINK' | 'NONE';
+export interface ISection {
+    id: string;
+    display: boolean;
+    order: number;
+    manifest: {
+        schema: TypeOfSectionManifestSchema;
+        availableProperties: Array<string>;
+        availableStyles: Array<string>;
+    };
+    template: TypeofSectionTemplate;
+    properties: ISectionProperties;
+    styles: ISectionStyles;
+    dynamicLayoutSectionItems: Array<IItem> | null;
+}
+export interface ISectionProperties {
+    title: string;
+    description: string;
+    sectionContentMediaType: TypeOfSectionContentMediaType;
+    sectionContentMediaSrc: string;
+    buttonAlphaLabel: string;
+    buttonAlphaLinkType: TypeOfSectionLinkType;
+    buttonAlphaLinkSrc: string;
+    buttonBravoLabel: string;
+    buttonBravoLinkType: TypeOfSectionLinkType;
+    buttonBravoLinkSrc: string;
+    buttonCharlieLabel: string;
+    buttonCharlieLinkType: TypeOfSectionLinkType;
+    buttonCharlieLinkSrc: string;
+    buttonDeltaLabel: string;
+    buttonDeltaLinkType: TypeOfSectionLinkType;
+    buttonDeltaLinkSrc: string;
+    buttonEchoLabel: string;
+    buttonEchoLinkType: TypeOfSectionLinkType;
+    buttonEchoLinkSrc: string;
+    carouselAutoplayMode: TypeOfCarouselAutoplayMode;
+    carouselAutoplayTime: number;
+    carouselInfiniteLoopMode: TypeOfCarouselInfiniteLoopMode;
+}
+export interface ISectionStyles {
+    titleColorInHex: string;
+    descriptionColorInHex: string;
+    backgroundColorInHex: string;
+    backgroundMediaType: TypeOfBackgroundMediaType;
+    backgroundMediaSrc: string;
+    backgroundOverlayColorInHex: string;
+    buttonAlphaDesignType: TypeOfSectionButtonDesignType;
+    buttonAlphaBackgroundColorInHex: string;
+    buttonAlphaLabelColorInHex: string;
+    buttonBravoDesignType: TypeOfSectionButtonDesignType;
+    buttonBravoBackgroundColorInHex: string;
+    buttonBravoLabelColorInHex: string;
+    buttonCharlieDesignType: TypeOfSectionButtonDesignType;
+    buttonCharlieBackgroundColorInHex: string;
+    buttonCharlieLabelColorInHex: string;
+    buttonDeltaDesignType: TypeOfSectionButtonDesignType;
+    buttonDeltaBackgroundColorInHex: string;
+    buttonDeltaLabelColorInHex: string;
+    buttonEchoDesignType: TypeOfSectionButtonDesignType;
+    buttonEchoBackgroundColorInHex: string;
+    buttonEchoLabelColorInHex: string;
+    itemTitleColorInHex: string;
+    itemDescriptionColorInHex: string;
+    itemButtonDesignType: TypeOfItemButtonDesignType;
+    itemButtonBackgroundColorInHex: string;
+    itemButtonLabelColorInHex: string;
+}
+export interface IItem {
+    id: string;
+    order: number;
+    display: boolean;
+    manifest: {
+        schema: TypeOfItemManifestSchema;
+        availableProperties: Array<string>;
+    };
+    properties: {
+        title: string;
+        description: string;
+        body: string;
+        logoImageSrc: string;
+        imageSrc: string;
+        linkMethod: TypeOfItemLinkMethod;
+        linkType: TypeOfItemLinkType;
+        linkSrc: string;
+        buttonLabel: string;
+    };
+}
+interface IButton {
+    buttonType: string;
+    backgroundColor?: string;
+    textColor?: string;
+    text?: string;
+    linkType?: TypeOfSectionLinkType | TypeOfItemLinkType;
+    src?: string;
+    borderColor?: string;
+    state?: 'normal' | 'disabled';
+}
+export interface ISectionButton extends IButton {
+    linkType?: TypeOfSectionLinkType;
+}
+export interface IItemButton extends IButton {
+    linkType?: TypeOfItemLinkType;
+    linkMethod?: TypeOfItemLinkMethod;
+}
+interface IBackground {
+    backgroundType: TypeOfBackground;
+    backgroundColorInHex?: string;
+    backgroundMediaSrc?: string;
+    backgroundOverlayColorInHex?: IBackgroundOverlay;
+}
+export interface ISectionBackground extends IBackground {
+    type: TypeOfBackground;
+    src?: string;
+    color?: string;
+    overlay?: IBackgroundOverlay;
+}
+declare type TypeOfBackground = 'COLOR' | 'IMAGE' | 'VIDEO' | 'YOUTUBE';
+export interface IBackgroundOverlay {
+    color?: string;
+}
+interface ITitle {
+    text: string;
+    color?: string;
+}
+export interface ISectionTitle extends ITitle {
+    text: string;
+    color?: string;
+}
+export interface IItemTitle extends ITitle {
+    text: string;
+    color?: string;
+}
+interface IDescription {
+    text: string;
+    color?: string;
+}
+export interface ISectionDescription extends IDescription {
+    text: string;
+    color?: string;
+}
+export interface IItemDescription extends IDescription {
+    text: string;
+    color?: string;
+}
+export declare type DynamicLayoutProps = {
+    device: 'DESKTOP' | 'MOBILE';
+    isPreview: boolean;
+    sections: ISection[];
+    navigationHandler?: (linkType: 'WEB_LINK' | 'INTERNAL_LINK' | 'NONE', src: string) => void;
+};
+export declare const MOCK_DATA: ISection[];
+export {};