@pobuca/email-builder 1.0.0

package/lib/groups/width-height.d.ts

@@ -0,0 +1,19 @@
+import { IWidthHeight } from '../interfaces/interfaces';
+import { PbEmailObjectStoreService } from '../services/internals/pb-email-object-store/pb-email-object-store.service';
+export declare class WidthHeightComponent {
+    private emailObject;
+    model: IWidthHeight;
+    label: string;
+    disabled: boolean;
+    private units;
+    constructor(emailObject: PbEmailObjectStoreService);
+    markForCheck(): void;
+    getLabel(): string;
+    toggleChange({ checked }: {
+        checked: any;
+    }): void;
+    getUnits(): import("../interfaces/interfaces").TUnits[];
+    disableValueField(): boolean;
+    showAutoSlider(): boolean;
+    getUnitLabel(unit: string): string;
+}

package/lib/interceptors/pb-interceptor.interceptor.d.ts

@@ -0,0 +1,10 @@
+import { HttpRequest, HttpHandler, HttpEvent, HttpInterceptor } from '@angular/common/http';
+import { Observable } from 'rxjs';
+import { IForRootConf } from '../interfaces/interfaces';
+import { PbUserInterfaceService } from '../services/internals/user-interfaces/user-interface.service';
+export declare class IpInterceptorInterceptor implements HttpInterceptor {
+    private userConfig;
+    private userInterface;
+    constructor(userConfig: IForRootConf, userInterface: PbUserInterfaceService);
+    intercept(request: HttpRequest<unknown>, next: HttpHandler): Observable<HttpEvent<unknown>>;
+}

package/lib/interfaces/interfaces.d.ts

@@ -0,0 +1,422 @@
+import { TBlocks } from '../classes/Elements';
+/**
+ * Main builder configuration Interface. See also {@link PbEmailBuilderModule#withConfig}.
+ */
+export interface IForRootConf {
+    /**
+     *  Either an [Extended or Commercial License]{@link} key if any, otherwise leave it empty.
+     *  @default t7HdQfZjGp6R96fOV4P8v18ggf6LLTQZ1puUI2tz
+     */
+    xApiKey?: string;
+    /**
+     * @deprecated Rewrite PbUserRestApiService in providers instead
+     * @ignore
+     */
+    uploadImagePath?: string;
+    /**
+     * @deprecated Rewrite PbUserRestApiService in providers instead
+     * @ignore
+     */
+    uploadImageName?: string;
+    /**
+     * @deprecated Rewrite PbUserRestApiService in providers instead
+     * @ignore
+     */
+    csrf?: {
+        name: string;
+        token: string;
+    };
+    /**
+     * Custom convertor path
+     */
+    apiPath?: string;
+    /**
+     * Show download button on builder top bar.
+     * @default true
+     */
+    useDownloadButton?: boolean;
+    /**
+     * Show preview button  on builder top bar.
+     * @default true
+     */
+    usePreviewButton?: boolean;
+    /**
+     * Show save button on builder top bar.
+     * @default true
+     */
+    useSaveButton?: boolean;
+    /**
+     * Show a button that opens template gallery in case email body is empty.
+     * @default true
+     */
+    templateListIfEmpty?: boolean;
+}
+/**
+ * Convertor errors response interface, id any.
+ */
+export interface IMjmlServerResponseErrors {
+    /**
+     * Error message.
+     */
+    message: string;
+    /**
+     * MJML TagName error occurred.
+     */
+    tagName: string;
+}
+/**
+ * Convertor response interface.
+ */
+export interface IMjmlServerResponse {
+    /**
+     * Converted HTML Template based on {@link IPBEmail}.
+     */
+    html: string;
+    /**
+     * Converted MJML Template based on {@link IPBEmail}.
+     */
+    mjml: string;
+    /**
+     * Error representation if any. See {@link IMjmlServerResponseErrors}.
+     */
+    errors: IMjmlServerResponseErrors[];
+}
+/**
+ * Builder structure types.
+ * @default cols_1
+ */
+export declare type TStructureTypes = 'cols_1' | 'cols_2' | 'cols_3' | 'cols_4' | 'cols_12' | 'cols_21';
+/**
+ * Builder direction types.
+ * @default ltr
+ */
+export declare type TDirection = 'ltr' | 'rtl';
+/**
+ * Builder units types.
+ * @default px
+ */
+export declare type TUnits = '%' | 'px' | 'cover' | 'contain';
+/**
+ * Builder align types.
+ * @default left
+ */
+export declare type TAlign = 'left' | 'center' | 'right';
+/**
+ * Builder vertical align types.
+ * @default middle
+ */
+export declare type TVerticalAlign = 'top' | 'middle' | 'bottom';
+/**
+ * Builder Line-height types.
+ * @default none
+ */
+export declare type TLineHeight = '%' | 'px' | 'none';
+/**
+ * Builder Link target.
+ * @default _blank
+ */
+export declare type TLinkTarget = '_blank' | '_self' | '_parent' | '_top';
+/**
+ * Builder font style types.
+ * @default normal
+ */
+export declare type TFontStyle = 'italic' | 'normal' | 'oblique';
+/**
+ * Builder font weight types.
+ * @default inherit
+ */
+export declare type TFontWeight = number | 'bold' | 'bolder' | 'inherit' | 'initial' | 'light' | 'normal';
+/**
+ * Builder background-repeat types.
+ * @default no-repeat
+ */
+export declare type TBackgroundRepeat = 'no-repeat' | 'repeat' | 'repeat-x' | 'repeat-y';
+/**
+ * Builder border styles interface.
+ */
+export interface IBorder {
+    color?: string;
+    /**
+     * Border style.
+     * @default solid
+     */
+    style?: 'solid' | 'dotted' | 'dashed' | 'double' | 'groove';
+    /**
+     * Border width
+     */
+    width?: number;
+    /**
+     * Border radius
+     */
+    radius?: number;
+}
+/**
+ * Builder padding styles interface.
+ */
+export interface IPadding {
+    top?: number;
+    right?: number;
+    bottom?: number;
+    left?: number;
+}
+/**
+ * Builder margin styles interface.
+ */
+export interface IMargin {
+    top?: number;
+    bottom?: number;
+}
+/**
+ * Builder Width and Height styles interface.
+ */
+export interface IWidthHeight {
+    value: number;
+    /**
+     * Width and Height unit type.
+     * @default px
+     */
+    unit: TUnits;
+    auto?: boolean;
+    units?: TUnits[];
+}
+/**
+ * Builder background styles interface.
+ */
+export interface IBackground {
+    color?: string;
+    url?: string;
+    repeat?: TBackgroundRepeat;
+    size?: IWidthHeight;
+}
+/**
+ * Builder font styles interface.
+ */
+export interface IFont {
+    family?: string;
+    fallback?: string;
+    size?: number;
+    style?: TFontStyle;
+    weight?: TFontWeight;
+}
+export declare type IFontFamily = Set<string>;
+/**
+ * Builder line-height styles interface.
+ */
+export interface ILineHeight {
+    value?: number;
+    unit?: TLineHeight;
+}
+/**
+ * Builder link styles interface.
+ */
+export interface ILink {
+    href: string;
+    target: TLinkTarget;
+}
+/**
+ * Builder structure columns' styles interface.
+ */
+export interface IStructureColumnOptions {
+    background?: IBackground;
+    border?: IBorder;
+    verticalAlign?: TVerticalAlign;
+}
+/**
+ * Builder structure styles interface.
+ */
+export interface IStructureOptions {
+    border?: IBorder;
+    background?: IBackground;
+    padding?: IPadding;
+    margin?: IMargin;
+    /**
+     * Disable responsive for entire structure
+     */
+    disableResponsive?: boolean;
+    /**
+     * Mame section full width
+     */
+    fullWidth?: boolean;
+    /**
+     * Mind the GAPS! Gaps between structure's columns.
+     */
+    gaps?: [number, number];
+    columnsWidth?: number[];
+    columns?: IStructureColumnOptions[];
+}
+/**
+ * Builder structure interface.
+ */
+export interface IStructure {
+    readonly type: TStructureTypes;
+    readonly id: number;
+    /**
+     * If it's module, it can't be edited within email body.
+     * @default false
+     */
+    isModule?: boolean;
+    options: IStructureOptions;
+    elements: TBlocks[][];
+    readonly columns: number;
+}
+/**
+ * Builder block state interface. If `disabled: true` it can't be dragged from left sidebar.
+ */
+export interface IBlockState {
+    /**
+     * @default false
+     */
+    disabled: boolean;
+    /**
+     * Show a message in case it's disabled.
+     */
+    message: string;
+}
+/**
+ * Builder {@link TextElementComponent} options interface.
+ */
+export interface ITextBlockOptions {
+    color?: string;
+    font?: IFont;
+    lineHeight?: ILineHeight;
+    padding?: IPadding;
+}
+/**
+ * Builder {@link ImageComponent} options interface.
+ */
+export interface IImageBLockOptions {
+    border?: IBorder;
+    width?: IWidthHeight;
+    height?: IWidthHeight;
+    link?: ILink;
+    align?: TAlign;
+    title?: string;
+    padding?: IPadding;
+}
+/**
+ * Builder {@link ButtonComponent} options interface.
+ */
+export interface IButtonBlockOptions {
+    backgroundColor?: string;
+    border?: IBorder;
+    color?: string;
+    font?: IFont;
+    align?: TAlign;
+    fullWidth?: boolean;
+    lineHeight?: ILineHeight;
+    link?: ILink;
+    innerPadding?: IPadding;
+    padding?: IPadding;
+}
+/**
+ * Builder {@link DividerComponent} options interface.
+ */
+export interface IDividerBlockOptions {
+    border?: IBorder;
+    padding?: IPadding;
+}
+/**
+ * Builder {@link SpacerComponent} options interface.
+ */
+export interface ISpacerBlockOptions {
+    height?: IWidthHeight;
+    width?: IWidthHeight;
+}
+/**
+ * Builder {@link SocialComponent} options interface.
+ */
+export interface ISocialBlockOptions {
+    align?: TAlign;
+    mode?: 'vertical' | 'horizontal';
+    font?: IFont;
+    iconSize?: ILineHeight;
+    lineHeight?: ILineHeight;
+    color?: string;
+    innerPadding?: IPadding;
+    padding?: IPadding;
+}
+/**
+ * Builder {@link SocialComponent} network options interface.
+ */
+export interface ISocialNetwork {
+    href: string;
+    label?: string;
+    name: 'github' | 'instagram' | 'web' | 'snapchat' | 'youtube' | 'vimeo' | 'medium' | 'soundcloud' | 'dribbble' | 'facebook' | 'twitter' | 'pinterest' | 'linkedin' | 'tumblr' | 'xing' | 'tiktok';
+    padding?: IPadding;
+}
+/**
+ * Builder {@link IPBEmail} general options interface.
+ */
+export interface IGeneralOptions {
+    width?: IWidthHeight;
+    background?: IBackground;
+    padding?: IPadding;
+    direction?: TDirection;
+    name?: string;
+    previewText: string;
+    global?: {
+        fonts?: string[];
+        padding?: IPadding;
+    };
+}
+/**
+ * Main builder Email Object interface.
+ */
+export interface IPBEmail {
+    general?: IGeneralOptions;
+    structures?: IStructure[];
+}
+/**
+ * Builder module interface.
+ */
+export interface IUserModule {
+    /**
+     * @deprecated Add name instead
+     * @ignore
+     */
+    thumb?: string;
+    name?: string;
+    module: IStructure;
+}
+/**
+ * @deprecated use IUserModule instead
+ * @internal
+ */
+export interface ICustomModule extends IUserModule {
+}
+/**
+ * Builder predefined template interface.
+ */
+export interface IUserTemplate {
+    id?: string;
+    title: string;
+    thumbPath: string;
+    templateData: IPBEmail;
+}
+/**
+ * @deprecated use IUserTemplate instead
+ * @internal
+ */
+export interface ICustomTemplate extends IUserTemplate {
+}
+/**
+ * Builder Template Gallery templates interface.
+ */
+export interface IUserTemplateCategory {
+    category: string;
+    templates: IUserTemplate[];
+}
+/**
+ * Builder IMage Gallery images interface.
+ */
+export interface IUserImageCategory {
+    category: string;
+    images: string[];
+}
+/**
+ * Template Storage/Cache keys.
+ */
+export declare enum ETemplatesStorage {
+    LATEST_USED = "NGB_LATEST_USED_TEMPLATES",
+    STORAGE = "NGB_TEMP_TEMPLATES_STORAGE"
+}

package/lib/pb-email-builder.component.d.ts

@@ -0,0 +1,67 @@
+import { Renderer2, OnChanges, SimpleChanges, OnDestroy, OnInit, ChangeDetectorRef, EventEmitter } from '@angular/core';
+import { ControlValueAccessor } from '@angular/forms';
+import { PbEmailBuilderService } from './pb-email-builder.service';
+import { IStructure } from './interfaces/interfaces';
+import { PBEmail } from './classes/DefaultEmail';
+import { SlugifyPipe } from './pipes/slugify.pipe';
+import { PbUserMiddlewaresService, TExportType } from './services/user-middleware-service/pb-middlewares.service';
+import { TBlocks } from './classes/Elements';
+import { PbUserInterfaceService } from './services/internals/user-interfaces/user-interface.service';
+import { PbEmailObjectStoreService } from './services/internals/pb-email-object-store/pb-email-object-store.service';
+import { PbUserRestApiService } from './services/user-rest-api-service/user-rest-api.service';
+export declare class PbEmailBuilderComponent implements OnChanges, OnDestroy, OnInit, ControlValueAccessor {
+    ngb: PbEmailBuilderService;
+    private userRestApiService;
+    private userInterfaceService;
+    private emailObjectStore;
+    private renderer2;
+    private slugifyPipe;
+    private middlewares;
+    private changeDetectorRef;
+    structures: IStructure[];
+    blocks: TBlocks[];
+    private doc;
+    email?: PBEmail;
+    emailChange: EventEmitter<PBEmail>;
+    previewTemplate: boolean;
+    showGeneralSettings$: import("rxjs").Observable<"general" | "structure" | "block">;
+    currentTabIndex$: import("rxjs").Observable<number>;
+    cdkDropListConnectedTo$: import("rxjs").Observable<any[]>;
+    getBuilderContainerStyles$: import("rxjs").Observable<{
+        direction: import("./interfaces/interfaces").TDirection;
+        backgroundRepeat: import("./interfaces/interfaces").TBackgroundRepeat;
+        backgroundColor: string;
+        backgroundSize: string;
+        backgroundPosition: string;
+    }>;
+    currentHTMLTemplate$: import("rxjs").Observable<string>;
+    activeMatProgress$: import("rxjs").Observable<boolean>;
+    customModuleList$: import("rxjs").Observable<import("./interfaces/interfaces").IUserModule[]>;
+    private readonly _onDestroy$;
+    private includedFonts;
+    constructor(ngb: PbEmailBuilderService, userRestApiService: PbUserRestApiService, userInterfaceService: PbUserInterfaceService, emailObjectStore: PbEmailObjectStoreService, renderer2: Renderer2, slugifyPipe: SlugifyPipe, middlewares: PbUserMiddlewaresService, changeDetectorRef: ChangeDetectorRef, structures: IStructure[], blocks: TBlocks[], googleFonts: TBlocks[], doc: Document);
+    private onChange;
+    private onTouched;
+    writeValue(email: PBEmail): void;
+    registerOnChange(fn: any): void;
+    registerOnTouched(fn: any): void;
+    /**
+     * Not implemented yet
+     * @param isDisabled The state of builder
+     */
+    setDisabledState?(isDisabled: boolean): void;
+    saveEmail(): import("rxjs").Subscription;
+    disableBlocksList$(block: TBlocks): import("rxjs").Observable<boolean>;
+    disableStructureList$(structure: IStructure): import("rxjs").Observable<boolean>;
+    trackByFn(block: TBlocks | IStructure): "button" | "image" | "text" | "divider" | "spacer" | "social" | "cols_1" | "cols_2" | "cols_3" | "cols_4" | "cols_12" | "cols_21";
+    changeTabIndex(index: number): void;
+    download(source: TExportType): import("rxjs").Subscription;
+    importFile(): void;
+    createArrayFromStructureColumns({ columns }: {
+        columns: any;
+    }): string[];
+    togglePreview(): import("rxjs").Subscription;
+    ngOnInit(): void;
+    ngOnChanges(changes: SimpleChanges): void;
+    ngOnDestroy(): void;
+}

package/lib/pb-email-builder.module.d.ts

@@ -0,0 +1,51 @@
+import { ModuleWithProviders } from '@angular/core';
+import { MatBottomSheet } from '@angular/material/bottom-sheet';
+import { MatDialog } from '@angular/material/dialog';
+import { HttpClient } from '@angular/common/http';
+import 'quill';
+import { IForRootConf } from './interfaces/interfaces';
+import { FreeUsersMiddleware, PaidUsersMiddleware } from './services/user-middleware-service';
+import { FreeUsersImageUploader, PaidUsersImageUploader } from './services/user-image-uploader-service';
+import { PbUserMiddlewaresService } from './services/user-middleware-service/pb-middlewares.service';
+import { PbUserImageUploaderService } from './services/user-image-uploader-service/user-image-uploader.service';
+import { FreeUsersRestApi } from './services/user-rest-api-service';
+import { FreeUsersPbStorage } from './services/pb-storage';
+import { PbUserRestApiService } from './services/user-rest-api-service/user-rest-api.service';
+import '@angular/localize/init';
+/**
+ * @internal
+ * @param http
+ */
+export declare function createCustomRestApiService(http: HttpClient): FreeUsersRestApi;
+/**
+ * @internal
+ * @param libraryIsProEnv
+ */
+export declare function createUserMiddlewareService(libraryIsProEnv: boolean): FreeUsersMiddleware | PaidUsersMiddleware;
+/**
+ * @internal
+ * @param templateStorage
+ */
+export declare function createUsersIpStorage(templateStorage: Storage): FreeUsersPbStorage;
+/**
+ * @internal
+ * @param libraryIsProEnv
+ * @param matBottomSheet
+ * @param matDialog
+ * @param userMiddleware
+ * @param userRestApi
+ */
+export declare function createUserUploaderService(libraryIsProEnv: boolean, matBottomSheet: MatBottomSheet, matDialog: MatDialog, userMiddleware: PbUserMiddlewaresService, userRestApi: PbUserRestApiService): FreeUsersImageUploader | PaidUsersImageUploader;
+export declare class PbEmailBuilderModule {
+    constructor(pbMiddlewaresService: PbUserMiddlewaresService, userImageUploader: PbUserImageUploaderService, libraryIsPro: boolean);
+    /**
+     * @deprecated use PbEmailBuilderModule.withConfig(userConfig) instead
+     * @internal
+     */
+    static forRoot(userConfig?: IForRootConf): ModuleWithProviders<PbEmailBuilderModule>;
+    /**
+     * Import module with configurations
+     * @param userConfig Configurations
+     */
+    static withConfig(userConfig?: IForRootConf): ModuleWithProviders<PbEmailBuilderModule>;
+}

package/lib/pb-email-builder.service.d.ts

@@ -0,0 +1,83 @@
+import { Observable } from 'rxjs';
+import { IForRootConf, IUserModule, IUserTemplate } from './interfaces/interfaces';
+import { PBEmail } from './classes/DefaultEmail';
+import { PbEmailObjectStoreService } from './services/internals/pb-email-object-store/pb-email-object-store.service';
+import { PbUserMiddlewaresService } from './services/user-middleware-service/pb-middlewares.service';
+import { PbUserInterfaceService } from './services/internals/user-interfaces/user-interface.service';
+/**
+ * @deprecated Soon it will be removed
+ * @internal
+ */
+export declare class PbEmailBuilderService {
+    config: IForRootConf;
+    private emailObjectStore;
+    private pbMiddleWares;
+    private pbUserInterface;
+    /**
+     * @deprecated Please use the new service "UserRestApiService" instead
+     */
+    modules: Set<IUserModule>;
+    /**
+     * @deprecated Please use the new service "UserRestApiService" instead
+     */
+    readonly customTemplates: Set<IUserTemplate>;
+    /**
+     * @deprecated Please use the new service "UserRestApiService" instead
+     */
+    private _mergeTags;
+    readonly onTemplateCreated$: Observable<[PBEmail, string, string]>;
+    /**
+     * @deprecated Use onTemplateCreated$ instead
+     */
+    readonly onSave$: Observable<[PBEmail, string, string]>;
+    /**
+     * @deprecated Use isLoading$ instead
+     */
+    readonly isLoading: Observable<boolean>;
+    readonly isLoading$: Observable<boolean>;
+    constructor(config: IForRootConf, emailObjectStore: PbEmailObjectStoreService, pbMiddleWares: PbUserMiddlewaresService, pbUserInterface: PbUserInterfaceService);
+    /**
+     * Save current Email Template
+     */
+    createHTMLTemplate$(): Observable<import("./interfaces/interfaces").IMjmlServerResponse>;
+    /**
+     *  @deprecated Please use ngb.createHTMLTemplate$() instead
+     */
+    saveEmail(): Observable<import("./interfaces/interfaces").IMjmlServerResponse>;
+    /**
+     * Get Email as object
+     */
+    get Email(): PBEmail;
+    /**
+     * Set Email saved from database or created with new PBEmail()
+     */
+    set Email(newEmail: PBEmail);
+    /**
+     * @deprecated Use getTemplateAsObservable$() instead
+     */
+    get Template(): any;
+    /**
+     * Set HTML output
+     */
+    /**
+     * @deprecated Use getMjmlAsObservable$() instead
+     */
+    get Mjml(): any;
+    /**
+     * Listen Email changes
+     */
+    getEmailAsObservable$(): Observable<PBEmail>;
+    /**
+     * Listen Template changes
+     */
+    getTemplateAsObservable$(): Observable<string>;
+    /**
+     * Listen MJML changes
+     */
+    getMjmlAsObservable$(): Observable<string>;
+    /**
+     * Listen Email and Template changes
+     * @deprecated Use onTemplateCreated$ instead
+     */
+    onChanges$(): Observable<[PBEmail, string, string]>;
+}

package/lib/pipes/slugify.pipe.d.ts

@@ -0,0 +1,9 @@
+import { PipeTransform } from '@angular/core';
+/**
+ * @ignore
+ *
+ * Soon will be removed.
+ */
+export declare class SlugifyPipe implements PipeTransform {
+    transform(input: string): string;
+}