@lightspeed/crane-api 1.0.0

package/types.d.ts

@@ -0,0 +1,622 @@
+/// <reference types="vite/client" />
+
+
+
+
+type ActionLinkType
+  = 'SCROLL_TO_TILE'
+  | 'HYPER_LINK'
+  | 'MAIL_LINK'
+  | 'TEL_LINK'
+  | 'GO_TO_STORE'
+  | 'GO_TO_STORE_LINK'
+  | 'GO_TO_PAGE'
+  | 'GO_TO_CATEGORY'
+  | 'GO_TO_CATEGORY_LINK';
+
+interface ButtonContentData {
+  readonly title: string;
+  readonly type: ActionLinkType;
+  readonly link?: string;
+  readonly email?: string;
+  readonly phone?: string;
+  readonly tileId?: string;
+  readonly pageId?: string;
+  readonly pageUrl?: string;
+}
+
+interface ImageInfoData {
+  readonly url: string;
+  readonly width: number;
+  readonly height: number;
+}
+
+interface ImageBorderInfoData {
+  readonly homogeneity: boolean;
+  readonly color: {
+    readonly r: number;
+    readonly g: number;
+    readonly b: number;
+    readonly a: number;
+  };
+}
+
+interface ImageContentData {
+  readonly bucket: string;
+  readonly borderInfo: ImageBorderInfoData;
+  readonly set: Record<string, ImageInfoData>;
+}
+
+interface ToggleContentData {
+  readonly enabled: boolean;
+}
+
+const ProductSelectionType = {
+  CATEGORY: 'CATEGORY',
+  MANUAL: 'MANUAL',
+} as const;
+
+const CategorySelectionType = {
+  ROOT: 'ROOT',
+  MANUAL: 'MANUAL',
+} as const;
+
+type CategorySelectionType = keyof typeof CategorySelectionType;
+
+interface CategorySelectorData {
+  readonly categories: {
+    readonly categoryIds: Array<number>;
+    readonly items: Array<CategoryItemData>;
+    readonly selectionType: CategorySelectionType;
+  };
+}
+
+interface ProductSelectorData {
+  readonly product?: {
+    readonly id: number;
+  };
+  readonly products?: {
+    readonly productIds: Array<number>;
+    readonly selectionType: keyof typeof ProductSelectionType;
+  };
+  readonly categoryId?: number;
+}
+
+interface ActionLink {
+  id: string;
+  title?: string;
+  type?: ActionLinkType;
+  link?: string;
+  email?: string;
+  phone?: string;
+  tileIdForScroll?: string;
+  pageIdForNavigate?: string;
+  showStoreCategories?: boolean;
+  isSubmenuOpened?: boolean;
+  categoryId?: number;
+  performAction?: () => void;
+}
+
+interface MenuContentData {
+  readonly items: ReadonlyArray<ActionLink>;
+}
+
+type LogoType = 'TEXT' | 'IMAGE';
+
+interface LogoContentData {
+  readonly type: LogoType;
+  readonly text: string;
+  readonly image: ImageContentData;
+}
+
+type GlobalColorsString
+  = 'global.color.title'
+  | 'global.color.body'
+  | 'global.color.button'
+  | 'global.color.link'
+  | 'global.color.background';
+
+type GlobalFontsString
+  = 'global.fontFamily.title'
+  | 'global.fontFamily.body';
+
+type GlobalTextSizeString
+  = 'global.textSize.title'
+  | 'global.textSize.subtitle'
+  | 'global.textSize.body';
+
+interface HSLColor {
+  h: number;
+  s: number;
+  l: number;
+  a: number;
+}
+
+interface RGBAColor {
+  r: number;
+  g: number;
+  b: number;
+  a: number;
+}
+
+// Note: We should check if RGBAColor has abbreviations or full names
+interface RGBAColorNamed {
+  red: number;
+  green: number;
+  blue: number;
+  alpha: number;
+}
+
+interface Color {
+  raw: string;
+  hex: string;
+  hsl: HSLColor;
+  rgba: RGBAColor;
+  auto?: boolean;
+}
+
+interface SolidColor {
+  color: Color | GlobalColorsString | undefined;
+}
+
+interface GradientColor {
+  fromColor: Color | GlobalColorsString | undefined;
+  toColor: Color | GlobalColorsString | undefined;
+}
+
+interface TextDesignData {
+  font: string | GlobalFontsString | undefined;
+  size: number | GlobalTextSizeString | undefined;
+  bold: boolean | undefined;
+  italic: boolean | undefined;
+  color: Color | GlobalColorsString | undefined;
+  visible: boolean;
+}
+
+interface TextareaDesignData extends TextDesignData {
+  readonly whiteSpace: string;
+}
+
+type CapitalizationType
+  = 'none'
+  | 'all'
+  | 'small';
+
+interface Frame {
+  visible: boolean;
+  width: number | undefined;
+  color: Color | GlobalColorsString | undefined;
+}
+
+interface LogoDesignData {
+  font: string | GlobalFontsString | undefined;
+  size: number | GlobalTextSizeString | undefined;
+  bold: boolean | undefined;
+  italic: boolean | undefined;
+  color: Color | GlobalColorsString | undefined;
+  visible: boolean;
+  spacing: number | undefined;
+  capitalization: CapitalizationType | undefined;
+  frame: Frame | undefined;
+}
+
+type ButtonAppearance
+  = 'solid-button'
+  | 'outline-button'
+  | 'text-link';
+
+type ButtonSize
+  = 'small'
+  | 'medium'
+  | 'large';
+
+type ButtonStyle
+  = 'round-corner'
+  | 'rectangle'
+  | 'pill';
+
+interface ButtonDesignData {
+  appearance: ButtonAppearance | undefined;
+  font: string | GlobalFontsString | undefined;
+  size: ButtonSize | undefined;
+  style: ButtonStyle | undefined;
+  color: Color | GlobalColorsString | undefined;
+  visible: boolean;
+}
+
+type OverlayType
+  = 'solid'
+  | 'gradient'
+  | 'none';
+
+interface Overlay {
+  type: OverlayType | undefined;
+  solid: SolidColor | undefined;
+  gradient: GradientColor | undefined;
+}
+
+interface ImageDesignData {
+  overlay: Overlay | undefined;
+  visible: boolean;
+}
+
+interface SelectboxDesignData {
+  value: string | undefined;
+}
+
+interface ToggleDesignData {
+  enabled: boolean | undefined;
+}
+
+type BackgroundType
+  = 'solid'
+  | 'gradient';
+
+interface Background {
+  type: BackgroundType | undefined;
+  solid: SolidColor | undefined;
+  gradient: GradientColor | undefined;
+}
+
+interface BackgroundDesignData {
+  background: Background | undefined;
+}
+
+type MapEditorContentTypes = {
+  readonly INPUTBOX: string;
+  readonly TEXTAREA: string;
+  readonly BUTTON: ButtonContentData;
+  readonly IMAGE: ImageContentData;
+  readonly TOGGLE: ToggleContentData;
+  readonly SELECTBOX: string;
+  readonly MENU: MenuContentData;
+  readonly LOGO: LogoContentData;
+};
+
+interface InputboxContentEditor {
+  readonly type: 'INPUTBOX';
+  readonly label: Record<string, string>;
+  readonly placeholder: Record<string, string>;
+}
+
+interface TextareaContentEditor {
+  readonly type: 'TEXTAREA';
+  readonly label: Record<string, string>;
+  readonly placeholder: Record<string, string>;
+}
+
+interface ReportAbuse {
+  readonly title: string;
+  readonly url: string | undefined;
+  readonly target: string | undefined;
+}
+
+interface MadeWith {
+  readonly url: string | undefined;
+  readonly target: string | undefined;
+  readonly icon: string | undefined;
+  readonly poweredBy: string | undefined;
+  readonly company: string | undefined;
+}
+
+interface Language {
+  readonly code: string;
+  readonly description: string;
+  readonly main: boolean;
+  readonly selected: boolean;
+  readonly url: string;
+}
+
+interface Account {
+  readonly title: string | undefined;
+  readonly url: string | undefined;
+  readonly target: string | undefined;
+}
+
+interface Cart {
+  readonly url: string | undefined;
+  readonly count: number;
+}
+
+interface LegalPage {
+  readonly title: string | undefined;
+  readonly url: string | undefined;
+}
+
+interface SiteContent {
+  readonly isPreviewMode: boolean;
+  readonly reportAbuse?: ReportAbuse;
+  readonly madeWith?: MadeWith;
+  readonly languages?: Language[];
+  readonly account?: Account;
+  readonly cart?: Cart;
+  readonly legalPages?: LegalPage[];
+}
+
+interface ImageBorderInfo {
+  readonly homogeneity?: boolean;
+  readonly dominatingColor?: {
+    readonly red?: number;
+    readonly green?: number;
+    readonly blue?: number;
+    readonly alpha?: number;
+  };
+}
+
+interface AlternativeProductImage {
+  readonly imageUrl?: string;
+  readonly thumbnailImageUrl?: string;
+  readonly fullImageUrl?: string;
+  readonly imageBorderInfo?: ImageBorderInfo;
+  readonly alt?: string;
+}
+
+interface LowestPrice {
+  readonly priceFormatted: string;
+  readonly label: string;
+  readonly countDateFromCreate: string;
+}
+
+interface RibbonSettings {
+  readonly text: string;
+  readonly color: RGBAColorNamed;
+}
+
+type ProductLegalInfoType = 'TAX_EXEMPT_BUSINESS' | 'TAX_INCLUDED' | 'TERMS_LINK';
+
+interface ProductLegalInfo {
+  readonly type: ProductLegalInfoType;
+  readonly text: string;
+  readonly url?: string;
+  readonly urlTarget?: string;
+}
+
+interface RecurringChargeSettings {
+  readonly subscriptionPriceWithSignUpFee?: number;
+  readonly subscriptionPriceWithSignUpFeeFormatted?: string;
+}
+
+interface SubscriptionSettings {
+  readonly subscriptionAllowed: boolean;
+  readonly oneTimePurchaseAllowed: boolean;
+  readonly recurringChargeSettings: RecurringChargeSettings[];
+  readonly oneTimePurchasePrice?: number;
+  readonly oneTimePurchasePriceFormatted?: string;
+  readonly oneTimePurchaseMarkupPercent?: number;
+}
+
+interface ProductRatingItem {
+  readonly rating?: number;
+  readonly reviewsPublished?: number;
+  readonly isHideRating?: boolean;
+  readonly isHideCount?: boolean;
+  readonly isHideReviewFullStars?: boolean;
+}
+
+interface ProductListComponentItem {
+  readonly id: number;
+  readonly name: string;
+  readonly url: string;
+  readonly imageUrl?: string;
+  readonly thumbnailImageUrl?: string;
+  readonly fullImageUrl?: string;
+  readonly imageBorderInfo: ImageBorderInfo;
+  readonly alternativeProductImage?: AlternativeProductImage;
+  readonly description?: string;
+  readonly price: number;
+  readonly comparePrice?: number;
+  readonly formattedPrice: string;
+  readonly formattedComparePrice?: string;
+  readonly lowestPrice?: LowestPrice;
+  readonly zeroPrice?: boolean;
+  readonly inStock: boolean;
+  readonly subtitle?: string;
+  readonly sku?: string;
+  readonly quantity?: number;
+  readonly ribbon?: RibbonSettings;
+  readonly nameYourPriceEnabled?: boolean;
+  readonly attributeValues?: string[];
+  readonly legalInfos?: ProductLegalInfo[];
+  readonly isSampleProduct?: boolean;
+  readonly subscriptionSettings?: SubscriptionSettings;
+  readonly preorder?: boolean;
+  readonly alt?: string;
+  readonly productRating?: ProductRatingItem;
+  readonly categoryName?: string;
+  readonly enabled?: boolean;
+  readonly isOnSale: boolean;
+  readonly defaultCategoryId?: number;
+  readonly categoryIds?: number[];
+}
+
+interface CategoryListComponentItem {
+  readonly id: number;
+  readonly name: string;
+  readonly url: string;
+  readonly imageUrl?: string;
+  readonly thumbnailImageUrl?: string;
+  readonly imageBorderInfo?: ImageBorderInfo;
+  readonly alt?: string;
+  readonly productsCount: number;
+}
+
+interface CategoryTree {
+  readonly id: number;
+  readonly name: string;
+  readonly nameTranslated: Record<string, string>;
+  readonly urlPath: string;
+  readonly enabled: boolean;
+  readonly children: CategoryTree[];
+}
+
+type CategoryTreeWithoutChildren = Omit<CategoryTree, 'children' | 'urlPath'>;
+interface CategoryItemData extends CategoryTreeWithoutChildren {
+  itemId?: string;
+  parentId?: number;
+  customName?: string;
+}
+
+interface CategoryCollectionItem extends CategoryItemData, CategoryListComponentItem {
+  selectionType: CategorySelectionType;
+}
+
+interface CategoryCollectionItemElement extends CategoryItemData, CategoryListComponentItem {
+  readonly label: string;
+  readonly showCategory: boolean;
+}
+
+interface Category {
+  readonly categories?: CategoryListComponentItem[];
+  readonly categoryTree?: CategoryTree[];
+}
+
+interface StoreData {
+  readonly categories: CategoryListComponentItem[];
+  readonly products: ProductListComponentItem[];
+}
+
+interface ExternalContentData {
+  readonly site?: SiteContent;
+  readonly category?: Category;
+  readonly storeData?: StoreData;
+}
+
+interface ButtonContentEditor {
+  readonly type: 'BUTTON';
+  readonly label: Record<string, string>;
+}
+
+interface ImageContentEditor {
+  readonly type: 'IMAGE';
+  readonly label: Record<string, string>;
+}
+
+interface ToggleContentEditor {
+  readonly type: 'TOGGLE';
+  readonly label: Record<string, string>;
+  readonly description?: Record<string, string>;
+}
+
+interface SelectboxContentOption {
+  readonly value: string;
+  readonly label: Record<string, string>;
+}
+
+interface SelectboxContentEditor {
+  readonly type: 'SELECTBOX';
+  readonly label: Record<string, string>;
+  readonly placeholder: Record<string, string>;
+  readonly description?: Record<string, string>;
+  readonly options: ReadonlyArray<SelectboxOption>;
+}
+
+interface MenuContentEditor {
+  readonly type: 'MENU';
+  readonly label: Record<string, string>;
+  readonly items: ReadonlyArray<ActionLink>;
+}
+
+interface NavigationMenuContentEditor {
+  readonly type: 'NAVIGATION_MENU';
+}
+
+interface LogoContentEditor {
+  readonly type: 'LOGO';
+  readonly label: Record<string, string>;
+}
+
+type ContentEditor
+  = TextContentEditor
+  | MultilineTextContentEditor
+  | ButtonContentEditor
+  | ImageContentEditor
+  | ToggleContentEditor
+  | SelectboxContentEditor
+  | MenuContentEditor
+  | NavigationMenuContentEditor
+  | LogoContentEditor;
+
+type InferContentType<T extends Record<string, ContentEditor>> = {
+  readonly [P in keyof T]: MapEditorContentTypes[T[P]['type']]
+};
+
+type MapEditorDesignTypes = {
+  readonly TEXT: string;
+  readonly BUTTON: string;
+  readonly IMAGE: string;
+  readonly TOGGLE: string;
+  readonly SELECTBOX: string;
+  readonly BACKGROUND: string;
+  readonly COLOR_PICKER: string;
+  readonly LOGO: string;
+  readonly DIVIDER: string;
+};
+
+interface TextDesignEditor {
+  readonly type: 'TEXT';
+  readonly label: string | Record<string, string>;
+  defaults: Record<string, unknown>;
+}
+
+interface ButtonDesignEditor {
+  readonly type: 'BUTTON';
+  readonly label: string | Record<string, string>;
+  defaults: Record<string, unknown>;
+}
+
+interface ImageDesignEditor {
+  readonly type: 'IMAGE';
+  readonly label: string | Record<string, string>;
+  defaults: Record<string, unknown>;
+}
+
+interface ToggleDesignEditor {
+  readonly type: 'TOGGLE';
+  readonly label: string | Record<string, string>;
+  defaults: Record<string, unknown>;
+}
+
+interface SelectboxDesignEditor {
+  readonly type: 'SELECTBOX';
+  readonly label: string | Record<string, string>;
+  defaults: Record<string, unknown>;
+}
+
+interface BackgroundDesignEditor {
+  readonly type: 'BACKGROUND';
+  readonly label: string | Record<string, string>;
+  defaults: Record<string, unknown>;
+}
+
+interface ColorPickerDesignEditor {
+  readonly type: 'COLOR_PICKER';
+  defaults: Record<string, unknown>;
+}
+
+interface LogoDesignEditor {
+  readonly type: 'LOGO';
+  readonly label?: string | Record<string, string>;
+  defaults: Record<string, unknown>;
+}
+
+interface DividerDesignEditor {
+  readonly type: 'DIVIDER';
+  readonly label: string | Record<string, string>;
+}
+
+type DesignEditor
+  = TextDesignEditor
+  | ButtonDesignEditor
+  | ImageDesignEditor
+  | ToggleDesignEditor
+  | SelectboxDesignEditor
+  | BackgroundDesignEditor
+  | ColorPickerDesignEditor
+  | LogoDesignEditor
+  | DividerDesignEditor;
+
+type InferDesignType<T extends Record<string, DesignEditor>> = {
+  readonly [P in keyof T]: MapEditorDesignTypes[T[P]['type']]
+};
+
+type SettingsEditor = DesignEditor | ContentEditor;