@pobuca/email-builder 1.0.0 → 1.1.0

package/lib/services/user-middleware-service/pb-middlewares.service.d.ts

@@ -1,190 +1,190 @@
-import { HttpErrorResponse } from '@angular/common/http';
-import { CdkDrag, CdkDragDrop } from '@angular/cdk/drag-drop';
-import { MatButtonToggleChange } from '@angular/material/button-toggle';
-import { Observable } from 'rxjs';
-import { IStructure, IUserTemplate } from '../../interfaces/interfaces';
-import { TBlocks } from '../../classes/Elements';
-import { PBEmail } from '../../classes/DefaultEmail';
-import { TPreviewDevice } from '../../components/preview.component';
-/**
- * Email editor export file types.
- */
-export declare type TExportType = 'html' | 'json' | 'mjml';
-/**
- * Email editor import file types. 'mjml' type is under development - don't use it yet.
- */
-export declare type TImportType = 'json' | 'mjml';
-/**
- * Add new Structure within email body event
- */
-export interface IAddStructureEvent extends CdkDragDrop<Set<IStructure>, Set<IStructure>> {
-    item: CdkDrag<IStructure>;
-}
-/**
- * Add new Block within structures' columns event
- */
-export interface IAddBlockEvent extends CdkDragDrop<TBlocks[], TBlocks[]> {
-    item: CdkDrag<TBlocks>;
-}
-/**
- * Preview device buttons
- */
-export interface IPreviewToggleButton extends MatButtonToggleChange {
-    value: TPreviewDevice;
-}
-/**
- * This service allows you to control all your users' abilities within this builder. Lets say you want to implement user Roles or just
- * need to disable some functionality for certain users based on purchase plan or on something else. You can allow or disallow almost
- * everything.
- *
- * All the methods must return an Observable, so, in my opinion, that's the best part of this service, you can either return an
- * [EMPTY Observable]{@link https://rxjs.dev/api/index/const/EMPTY}, a modified object or an (Info Modal).pipe(mapTo(EMPTY)) - I think you
- * got the idea.
- *
- * I recommend always using a Modal or a Toast for forbidden actions.
- *
- * It won't work if you have a Regular/Free License - you'll get an error on running the project,
- * you need either an [Extended or Commercial License]{@link https://wlocalhost.org} key for this purpose.
- *
- * @example
- * // Create a custom service
- * class YourOwnMiddlewareService extends PbUserMiddlewaresService {}
- *
- * // Rewrite it into AppModule
- * { provide: PbUserMiddlewaresService, useClass: YourOwnMiddlewareService }
- */
-export declare abstract class PbUserMiddlewaresService {
-    /**
-     * This method is called before sending the request to MJML Convertor. Use it to add some additional blocks or anything else to
-     * the PBEmail object.
-     * @param email PBEmail object that's being sent to MJML Convertor.
-     */
-    createHTMLTemplate(email: PBEmail): Observable<PBEmail>;
-    /**
-     * Allow or Disallow preview window.
-     * @param state Coming Preview state
-     */
-    togglePreview(state: boolean): Observable<boolean>;
-    /**
-     * Allow or Disallow preview devices.
-     * @param button Device's button that has been clicked
-     */
-    togglePreviewDevice(button: IPreviewToggleButton): Observable<TPreviewDevice>;
-    /**
-     * Allow or disallow users to select certain templates based either on category or template object.
-     * @param category Template's category user has selected
-     * @param template Template user has selected
-     */
-    chooseTemplate(category: string, template: IUserTemplate): Observable<{
-        category: string;
-        template: IUserTemplate;
-    }>;
-    /**
-     * Allow, disallow or return the same path for all user's uploaded images.
-     * @param path Path of uploaded image
-     *
-     * @TODO Check if this middleware is being called before image has been uploaded
-     */
-    uploadImage(path: string): Observable<string>;
-    /**
-     * Allow or disallow users to add blocks within email structures.
-     * @param event Event of dropped block
-     * @param column Column that block has been dropped
-     *
-     * @TODO add parent structure as a parameter
-     */
-    addBlock(event: IAddBlockEvent, column: TBlocks[]): Observable<{
-        column: TBlocks[];
-        event: IAddBlockEvent;
-    }>;
-    /**
-     * Prevent user to edit blocks within email body.
-     * @param block Block that user intends to edit
-     */
-    editBlock(block: TBlocks): Observable<TBlocks>;
-    /**
-     * Prevent user to remove blocks within email body.
-     * @param index Block's Index
-     * @param column Block's parent column
-     * @param block Block that user intends to remove
-     */
-    removeBlock(index: number, column: TBlocks[], block: TBlocks): Observable<{
-        index: number;
-        column: TBlocks[];
-    }>;
-    /**
-     * Prevent user to duplicate blocks within email body.
-     * @param index Block's Index
-     * @param column Block's parent column
-     * @param block Block that user intends to duplicate
-     */
-    duplicateBlock(index: number, column: TBlocks[], block: TBlocks): Observable<{
-        index: number;
-        column: TBlocks[];
-        block: TBlocks;
-    }>;
-    /**
-     * Disable Drag and Drop certain blocks from Blocks list to Email body.
-     * Return TRUE to disable all blocks - no matter on block's data.
-     * @param block Block to allow or disallow from being dragged
-     */
-    disableBlockDragFromList(block: TBlocks): Observable<boolean>;
-    /**
-     * Prevent users to sort blocks within email body.
-     * @param block Block that user intends to change the order
-     */
-    disableBlockDragWithinEmailBody(block: TBlocks): Observable<boolean>;
-    /**
-     * Prevent user to add new structure.
-     * @param event Event of dropped structure
-     */
-    addStructure(event: IAddStructureEvent): Observable<IAddStructureEvent>;
-    /**
-     * Prevent user to edit the structure.
-     * @param structure Structure that user intends to edit
-     */
-    editStructure(structure: IStructure): Observable<IStructure>;
-    /**
-     * Prevent user to remove the structure.
-     * @param index Index of the structure
-     * @param structure Structure that user intends to remove
-     */
-    removeStructure(index: number, structure: IStructure): Observable<number>;
-    /**
-     * Prevent user to duplicate the structure within email body.
-     * @param index Index of structure
-     * @param structure Structure that user intends to duplicate
-     */
-    duplicateStructure(index: number, structure: IStructure): Observable<number>;
-    /**
-     * Disable Drag and Drop certain structures from Structures list to Email body.
-     * Return TRUE to disable all structures.
-     * @param structure Structure to prevent from being dragged
-     */
-    disableStructureDragFromList(structure: IStructure): Observable<boolean>;
-    /**
-     * Allow or disallow users to sort structures within email body.
-     * @param structure Structure that user intends to change the order
-     */
-    disableStructureDragWithinEmailBody(structure: IStructure): Observable<boolean>;
-    /**
-     * I don't know why would you do that, but you can disable OnExit confirm modal.
-     * @param event Window [BeforeUnloadEvent]{@link https://developer.mozilla.org/en-US/docs/Web/API/BeforeUnloadEvent}
-     */
-    preventWindowExit(event: BeforeUnloadEvent): Observable<BeforeUnloadEvent>;
-    /**
-     * Allow or disallow user to export certain types of file
-     * @param type Type that user intends to download
-     */
-    exportFile(type: TExportType): Observable<TExportType>;
-    /**
-     * Allow or disallow user to import certain types of file
-     * @param file Web APIs [FILE]{@link https://developer.mozilla.org/en-US/docs/Web/API/File}
-     */
-    importFile(file: File): Observable<File>;
-    /**
-     * Catch all errors within email editor, it might not work 100%, it's still on working process.
-     * @param error Throwable Error
-     */
-    catchError(error: Error | HttpErrorResponse): Observable<Error | HttpErrorResponse>;
-}
+import { HttpErrorResponse } from '@angular/common/http';
+import { CdkDrag, CdkDragDrop } from '@angular/cdk/drag-drop';
+import { MatButtonToggleChange } from '@angular/material/button-toggle';
+import { Observable } from 'rxjs';
+import { IStructure, IUserTemplate } from '../../interfaces/interfaces';
+import { TBlocks } from '../../classes/Elements';
+import { PBEmail } from '../../classes/DefaultEmail';
+import { TPreviewDevice } from '../../components/preview.component';
+/**
+ * Email editor export file types.
+ */
+export declare type TExportType = 'html' | 'json' | 'mjml';
+/**
+ * Email editor import file types. 'mjml' type is under development - don't use it yet.
+ */
+export declare type TImportType = 'json' | 'mjml';
+/**
+ * Add new Structure within email body event
+ */
+export interface IAddStructureEvent extends CdkDragDrop<Set<IStructure>, Set<IStructure>> {
+    item: CdkDrag<IStructure>;
+}
+/**
+ * Add new Block within structures' columns event
+ */
+export interface IAddBlockEvent extends CdkDragDrop<TBlocks[], TBlocks[]> {
+    item: CdkDrag<TBlocks>;
+}
+/**
+ * Preview device buttons
+ */
+export interface IPreviewToggleButton extends MatButtonToggleChange {
+    value: TPreviewDevice;
+}
+/**
+ * This service allows you to control all your users' abilities within this builder. Lets say you want to implement user Roles or just
+ * need to disable some functionality for certain users based on purchase plan or on something else. You can allow or disallow almost
+ * everything.
+ *
+ * All the methods must return an Observable, so, in my opinion, that's the best part of this service, you can either return an
+ * [EMPTY Observable]{@link https://rxjs.dev/api/index/const/EMPTY}, a modified object or an (Info Modal).pipe(mapTo(EMPTY)) - I think you
+ * got the idea.
+ *
+ * I recommend always using a Modal or a Toast for forbidden actions.
+ *
+ * It won't work if you have a Regular/Free License - you'll get an error on running the project,
+ * you need either an [Extended or Commercial License]{@link https://wlocalhost.org} key for this purpose.
+ *
+ * @example
+ * // Create a custom service
+ * class YourOwnMiddlewareService extends PbUserMiddlewaresService {}
+ *
+ * // Rewrite it into AppModule
+ * { provide: PbUserMiddlewaresService, useClass: YourOwnMiddlewareService }
+ */
+export declare abstract class PbUserMiddlewaresService {
+    /**
+     * This method is called before sending the request to MJML Convertor. Use it to add some additional blocks or anything else to
+     * the PBEmail object.
+     * @param email PBEmail object that's being sent to MJML Convertor.
+     */
+    createHTMLTemplate(email: PBEmail): Observable<PBEmail>;
+    /**
+     * Allow or Disallow preview window.
+     * @param state Coming Preview state
+     */
+    togglePreview(state: boolean): Observable<boolean>;
+    /**
+     * Allow or Disallow preview devices.
+     * @param button Device's button that has been clicked
+     */
+    togglePreviewDevice(button: IPreviewToggleButton): Observable<TPreviewDevice>;
+    /**
+     * Allow or disallow users to select certain templates based either on category or template object.
+     * @param category Template's category user has selected
+     * @param template Template user has selected
+     */
+    chooseTemplate(category: string, template: IUserTemplate): Observable<{
+        category: string;
+        template: IUserTemplate;
+    }>;
+    /**
+     * Allow, disallow or return the same path for all user's uploaded images.
+     * @param path Path of uploaded image
+     *
+     * @TODO Check if this middleware is being called before image has been uploaded
+     */
+    uploadImage(path: string): Observable<string>;
+    /**
+     * Allow or disallow users to add blocks within email structures.
+     * @param event Event of dropped block
+     * @param column Column that block has been dropped
+     *
+     * @TODO add parent structure as a parameter
+     */
+    addBlock(event: IAddBlockEvent, column: TBlocks[]): Observable<{
+        column: TBlocks[];
+        event: IAddBlockEvent;
+    }>;
+    /**
+     * Prevent user to edit blocks within email body.
+     * @param block Block that user intends to edit
+     */
+    editBlock(block: TBlocks): Observable<TBlocks>;
+    /**
+     * Prevent user to remove blocks within email body.
+     * @param index Block's Index
+     * @param column Block's parent column
+     * @param block Block that user intends to remove
+     */
+    removeBlock(index: number, column: TBlocks[], block: TBlocks): Observable<{
+        index: number;
+        column: TBlocks[];
+    }>;
+    /**
+     * Prevent user to duplicate blocks within email body.
+     * @param index Block's Index
+     * @param column Block's parent column
+     * @param block Block that user intends to duplicate
+     */
+    duplicateBlock(index: number, column: TBlocks[], block: TBlocks): Observable<{
+        index: number;
+        column: TBlocks[];
+        block: TBlocks;
+    }>;
+    /**
+     * Disable Drag and Drop certain blocks from Blocks list to Email body.
+     * Return TRUE to disable all blocks - no matter on block's data.
+     * @param block Block to allow or disallow from being dragged
+     */
+    disableBlockDragFromList(block: TBlocks): Observable<boolean>;
+    /**
+     * Prevent users to sort blocks within email body.
+     * @param block Block that user intends to change the order
+     */
+    disableBlockDragWithinEmailBody(block: TBlocks): Observable<boolean>;
+    /**
+     * Prevent user to add new structure.
+     * @param event Event of dropped structure
+     */
+    addStructure(event: IAddStructureEvent): Observable<IAddStructureEvent>;
+    /**
+     * Prevent user to edit the structure.
+     * @param structure Structure that user intends to edit
+     */
+    editStructure(structure: IStructure): Observable<IStructure>;
+    /**
+     * Prevent user to remove the structure.
+     * @param index Index of the structure
+     * @param structure Structure that user intends to remove
+     */
+    removeStructure(index: number, structure: IStructure): Observable<number>;
+    /**
+     * Prevent user to duplicate the structure within email body.
+     * @param index Index of structure
+     * @param structure Structure that user intends to duplicate
+     */
+    duplicateStructure(index: number, structure: IStructure): Observable<number>;
+    /**
+     * Disable Drag and Drop certain structures from Structures list to Email body.
+     * Return TRUE to disable all structures.
+     * @param structure Structure to prevent from being dragged
+     */
+    disableStructureDragFromList(structure: IStructure): Observable<boolean>;
+    /**
+     * Allow or disallow users to sort structures within email body.
+     * @param structure Structure that user intends to change the order
+     */
+    disableStructureDragWithinEmailBody(structure: IStructure): Observable<boolean>;
+    /**
+     * I don't know why would you do that, but you can disable OnExit confirm modal.
+     * @param event Window [BeforeUnloadEvent]{@link https://developer.mozilla.org/en-US/docs/Web/API/BeforeUnloadEvent}
+     */
+    preventWindowExit(event: BeforeUnloadEvent): Observable<BeforeUnloadEvent>;
+    /**
+     * Allow or disallow user to export certain types of file
+     * @param type Type that user intends to download
+     */
+    exportFile(type: TExportType): Observable<TExportType>;
+    /**
+     * Allow or disallow user to import certain types of file
+     * @param file Web APIs [FILE]{@link https://developer.mozilla.org/en-US/docs/Web/API/File}
+     */
+    importFile(file: File): Observable<File>;
+    /**
+     * Catch all errors within email editor, it might not work 100%, it's still on working process.
+     * @param error Throwable Error
+     */
+    catchError(error: Error | HttpErrorResponse): Observable<Error | HttpErrorResponse>;
+}

package/lib/services/user-rest-api-service/free-users-rest-api.service.d.ts

@@ -1,10 +1,10 @@
-import { HttpClient } from '@angular/common/http';
-import { PbUserRestApiService } from './user-rest-api.service';
-/**
- * @internal
- * The free User Rest API service for Regular license.
- * No differences between other licenses for now, but might be in the future.
- */
-export default class FreeUsersRestApi extends PbUserRestApiService {
-    constructor(http: HttpClient);
-}
+import { HttpClient } from '@angular/common/http';
+import { PbUserRestApiService } from './user-rest-api.service';
+/**
+ * @internal
+ * The free User Rest API service for Regular license.
+ * No differences between other licenses for now, but might be in the future.
+ */
+export default class FreeUsersRestApi extends PbUserRestApiService {
+    constructor(http: HttpClient);
+}

package/lib/services/user-rest-api-service/index.d.ts

@@ -1,2 +1,2 @@
-import FreeUsersRestApi from './free-users-rest-api.service';
-export { FreeUsersRestApi };
+import FreeUsersRestApi from './free-users-rest-api.service';
+export { FreeUsersRestApi };

package/lib/services/user-rest-api-service/user-rest-api.service.d.ts

@@ -1,82 +1,82 @@
-import { HttpClient, HttpEvent } from '@angular/common/http';
-import { Observable } from 'rxjs';
-import { IMjmlServerResponse, IUserModule, IUserTemplate, IUserTemplateCategory } from '../../interfaces/interfaces';
-import { PBEmail } from '../../classes/DefaultEmail';
-/**
- * Add Google Fonts list to PBEmail object to include into template.
- * MJML Convertor will filter and remove fonts that aren't used.
- */
-export interface IEmailAndGoogleFonts extends PBEmail {
-    googleFonts: string[];
-}
-/**
- * The abstract service that must extend the user's custom REST API service.
- * Contains all required properties needed within project.
- *
- * Rewrite the default methods/properties to get the desired data.
- * We recommend using `shareReplay()` operator if it's just a simple static data.
- *
- * @example
- * // Create a custom service
- * class YourOwnRestApiService extends PbUserRestApiService {}
- *
- * // Rewrite it into AppModule
- * { provide: PbUserRestApiService, useClass: YourOwnRestApiService }
- */
-export declare abstract class PbUserRestApiService {
-    http: HttpClient;
-    /**
-     * Get all user merge fields to inject into text editor.
-     */
-    getAllUserMergeFields$: Observable<string[]>;
-    /**
-     * Get all Custom Modules to be included into Modules List.
-     * We're looking for someone who could create many modules to be included by default, if you feel you can help us, please leave a message!
-     */
-    getAllUserModules$: Observable<IUserModule[]>;
-    /**
-     * Get all Predefined Templates and categories.
-     * You can leave it to get all default templates from NGB API
-     */
-    getAllUserTemplates$: Observable<IUserTemplateCategory[]>;
-    constructor(http: HttpClient);
-    /**
-     * This method must return the chosen template from Template Gallery List PBEmail object,
-     * see {@link PbUserRestApiService#getAllUserTemplates$|getAllUserTemplates$}.
-     *
-     * Sometimes it can contain 'templateData' property - in this case, just return it.
-     *
-     * @param category Selected Category from Template Gallery.
-     * @param template Selected Template from Template Gallery.
-     *
-     * @example
-     * if (template.templateData) { return template }
-     */
-    getUserTemplateData$(category: string, template: IUserTemplate): Observable<IUserTemplate>;
-    /**
-     * Handle all uploaded images.
-     * FormData 'csrf' is deprecated in favor of [HttpClientXsrfModule]{@link https://angular.io/api/common/http/HttpClientXsrfModule}.
-     *
-     * @param body A FormData that contains 'image' and 'csrf' data.
-     * @param uploadImagePath Define a path where NGB have to send the upload request.
-     */
-    userImageUpload$(body: FormData, uploadImagePath: string): Observable<HttpEvent<{
-        success: boolean;
-        path: string;
-        message?: string;
-    }>>;
-    /**
-     * Get all images to include into Image Gallery.
-     */
-    getUserImages$(): Observable<string[]>;
-    /**
-     * Rewrite the default request which converts PBEmail to HTML, if you have a paid License,
-     * this method allows you to rewrite the default Convertor API Path to yours.
-     *
-     * You can still use the default Convertor API Path, since you have a valid and active License Key.
-     *
-     * @param emailAndFonts PBEmail plus Google Fonts List object.
-     * @param url Your own Convertor API Path, or leave it empty to use NGB servers.
-     */
-    createHTMLTemplate$(emailAndFonts: IEmailAndGoogleFonts, url?: string): Observable<IMjmlServerResponse>;
-}
+import { HttpClient, HttpEvent } from '@angular/common/http';
+import { Observable } from 'rxjs';
+import { IMjmlServerResponse, IUserModule, IUserTemplate, IUserTemplateCategory } from '../../interfaces/interfaces';
+import { PBEmail } from '../../classes/DefaultEmail';
+/**
+ * Add Google Fonts list to PBEmail object to include into template.
+ * MJML Convertor will filter and remove fonts that aren't used.
+ */
+export interface IEmailAndGoogleFonts extends PBEmail {
+    googleFonts: string[];
+}
+/**
+ * The abstract service that must extend the user's custom REST API service.
+ * Contains all required properties needed within project.
+ *
+ * Rewrite the default methods/properties to get the desired data.
+ * We recommend using `shareReplay()` operator if it's just a simple static data.
+ *
+ * @example
+ * // Create a custom service
+ * class YourOwnRestApiService extends PbUserRestApiService {}
+ *
+ * // Rewrite it into AppModule
+ * { provide: PbUserRestApiService, useClass: YourOwnRestApiService }
+ */
+export declare abstract class PbUserRestApiService {
+    http: HttpClient;
+    /**
+     * Get all user merge fields to inject into text editor.
+     */
+    getAllUserMergeFields$: Observable<string[]>;
+    /**
+     * Get all Custom Modules to be included into Modules List.
+     * We're looking for someone who could create many modules to be included by default, if you feel you can help us, please leave a message!
+     */
+    getAllUserModules$: Observable<IUserModule[]>;
+    /**
+     * Get all Predefined Templates and categories.
+     * You can leave it to get all default templates from NGB API
+     */
+    getAllUserTemplates$: Observable<IUserTemplateCategory[]>;
+    constructor(http: HttpClient);
+    /**
+     * This method must return the chosen template from Template Gallery List PBEmail object,
+     * see {@link PbUserRestApiService#getAllUserTemplates$|getAllUserTemplates$}.
+     *
+     * Sometimes it can contain 'templateData' property - in this case, just return it.
+     *
+     * @param category Selected Category from Template Gallery.
+     * @param template Selected Template from Template Gallery.
+     *
+     * @example
+     * if (template.templateData) { return template }
+     */
+    getUserTemplateData$(category: string, template: IUserTemplate): Observable<IUserTemplate>;
+    /**
+     * Handle all uploaded images.
+     * FormData 'csrf' is deprecated in favor of [HttpClientXsrfModule]{@link https://angular.io/api/common/http/HttpClientXsrfModule}.
+     *
+     * @param body A FormData that contains 'image' and 'csrf' data.
+     * @param uploadImagePath Define a path where NGB have to send the upload request.
+     */
+    userImageUpload$(body: FormData, uploadImagePath: string): Observable<HttpEvent<{
+        success: boolean;
+        path: string;
+        message?: string;
+    }>>;
+    /**
+     * Get all images to include into Image Gallery.
+     */
+    getUserImages$(): Observable<string[]>;
+    /**
+     * Rewrite the default request which converts PBEmail to HTML, if you have a paid License,
+     * this method allows you to rewrite the default Convertor API Path to yours.
+     *
+     * You can still use the default Convertor API Path, since you have a valid and active License Key.
+     *
+     * @param emailAndFonts PBEmail plus Google Fonts List object.
+     * @param url Your own Convertor API Path, or leave it empty to use NGB servers.
+     */
+    createHTMLTemplate$(emailAndFonts: IEmailAndGoogleFonts, url?: string): Observable<IMjmlServerResponse>;
+}

package/lib/tokens/private-tokens.d.ts

@@ -1,5 +1,5 @@
-import { InjectionToken } from '@angular/core';
-/**
- * @internal
- */
-export declare const LIBRARY_IS_PRO: InjectionToken<boolean>;
+import { InjectionToken } from '@angular/core';
+/**
+ * @internal
+ */
+export declare const LIBRARY_IS_PRO: InjectionToken<boolean>;