@ks89/angular-modal-gallery 8.0.0-rc.1 → 9.0.1

package/lib/components/upper-buttons/upper-buttons.component.d.ts

@@ -17,6 +17,10 @@ export interface InternalButtonConfig extends ButtonConfig {
  */
 export declare class UpperButtonsComponent extends AccessibleComponent implements OnInit {
     private configService;
+    /**
+     * Unique id (>=0) of the current instance of this library. This is required when you are using
+     * the service to call modal gallery.
+     */
     id: number | undefined;
     /**
      * Object of type `Image` that represent the visible image.
@@ -118,7 +122,7 @@ export declare class UpperButtonsComponent extends AccessibleComponent implement
     private addButtonIds;
     /**
      * Private method to validate custom buttons received as input.
-     * @param ButtonConfig[] buttons config array
+     * @param ButtonConfig[] buttons config array. [] by default.
      * @returns ButtonConfig[] the same input buttons config array
      * @throws an error is exists a button with an unknown type
      */

package/lib/directives/fallback-image.directive.d.ts

@@ -1,6 +1,9 @@
 import { ElementRef, EventEmitter, Renderer2 } from '@angular/core';
 import { SafeResourceUrl } from '@angular/platform-browser';
 import * as i0 from "@angular/core";
+/**
+ * Directive to add fallback image if the original one is not reachable.
+ */
 export declare class FallbackImageDirective {
     private renderer;
     private el;

package/lib/directives/keyboard-navigation.directive.d.ts

@@ -2,7 +2,7 @@ import { EventEmitter } from '@angular/core';
 import * as i0 from "@angular/core";
 export declare class KeyboardNavigationDirective {
     isOpen: boolean | undefined;
-    keyboardNavigation: EventEmitter<number>;
+    keyboardNavigation: EventEmitter<string>;
     /**
      * Listener to catch keyboard's events and call the right method based on the key.
      * For instance, pressing esc, this will call `closeGallery(Action.KEYBOARD)` and so on.

package/lib/directives/wrap.directive.d.ts

@@ -28,7 +28,7 @@ export declare class WrapDirective implements OnInit, OnChanges {
      */
     ngOnChanges(): void;
     /**
-     * Private method to change both widht and flex-wrap css properties.
+     * Private method to change both width and flex-wrap css properties.
      */
     private applyStyle;
     static ɵfac: i0.ɵɵFactoryDeclaration<WrapDirective, never>;

package/lib/model/carousel-config.interface.d.ts

@@ -8,5 +8,4 @@ export interface CarouselConfig {
     objectFit: string;
     keyboardEnable: boolean;
     modalGalleryEnable: boolean;
-    legacyIE11Mode: boolean;
 }

package/lib/model/keyboard-config.interface.d.ts

@@ -1,8 +1,8 @@
 /**
- * Interface `KeyboardConfig` to assign custom keyCodes to ESC, RIGHT and LEFT keyboard's actions.
+ * Interface `KeyboardConfig` to assign custom codes to ESC, RIGHT and LEFT keyboard's actions.
  */
 export interface KeyboardConfig {
-    esc?: number;
-    right?: number;
-    left?: number;
+    esc?: string;
+    right?: string;
+    left?: string;
 }

package/lib/model/keyboard.enum.d.ts

@@ -1,10 +1,13 @@
 /**
- * Enum `Keyboard` with keys and their relative key codes.
+ * Enum `Keyboard` with keys and their relative codes.
  */
-export declare enum Keyboard {
-    ESC = 27,
-    LEFT_ARROW = 37,
-    RIGHT_ARROW = 39,
-    UP_ARROW = 38,
-    DOWN_ARROW = 40
-}
+import { DOWN_ARROW_CODE, ESC_CODE, LEFT_ARROW_CODE, RIGHT_ARROW_CODE, UP_ARROW_CODE } from '../utils/user-input.util';
+declare type Keyboard = Readonly<{
+    ESC: typeof ESC_CODE;
+    LEFT_ARROW: typeof LEFT_ARROW_CODE;
+    RIGHT_ARROW: typeof RIGHT_ARROW_CODE;
+    UP_ARROW: typeof UP_ARROW_CODE;
+    DOWN_ARROW: typeof DOWN_ARROW_CODE;
+}>;
+export declare const Keyboard: Keyboard;
+export {};

package/lib/model/lib-config.interface.d.ts

@@ -11,20 +11,33 @@ import { CarouselImageConfig } from './carousel-image-config.interface';
 import { CarouselPreviewConfig } from './carousel-preview-config.interface';
 import { PlayConfig } from './play-config.interface';
 import { KeyboardServiceConfig } from './keyboard-service-config.interface';
-export interface LibConfig {
-    slideConfig?: SlideConfig;
+export interface AccessibleLibConfig {
     accessibilityConfig?: AccessibilityConfig;
+}
+export interface CommonLibConfig {
     previewConfig?: PreviewConfig;
-    buttonsConfig?: ButtonsConfig;
     dotsConfig?: DotsConfig;
-    plainGalleryConfig?: PlainGalleryConfig;
-    currentImageConfig?: CurrentImageConfig;
-    keyboardConfig?: KeyboardConfig;
+    slideConfig?: SlideConfig;
+}
+export interface KeyboardServiceLibConfig {
+    keyboardServiceConfig?: KeyboardServiceConfig;
+}
+export interface CarouselLibConfig extends CommonLibConfig, AccessibleLibConfig, KeyboardServiceLibConfig {
     carouselConfig?: CarouselConfig;
     carouselImageConfig?: CarouselImageConfig;
     carouselPreviewsConfig?: CarouselPreviewConfig;
     carouselPlayConfig?: PlayConfig;
     carouselDotsConfig?: DotsConfig;
+    carouselSlideInfinite?: boolean;
+}
+export interface ModalLibConfig extends CommonLibConfig, AccessibleLibConfig, KeyboardServiceLibConfig {
     enableCloseOutside?: boolean;
-    keyboardServiceConfig?: KeyboardServiceConfig;
+    keyboardConfig?: KeyboardConfig;
+    currentImageConfig?: CurrentImageConfig;
+    buttonsConfig?: ButtonsConfig;
+}
+export interface PlainLibConfig extends AccessibleLibConfig {
+    plainGalleryConfig?: PlainGalleryConfig;
+}
+export interface LibConfig extends ModalLibConfig, PlainLibConfig, CarouselLibConfig {
 }

package/lib/model/modal-gallery-config.interface.d.ts

@@ -1,8 +1,8 @@
 import { Image } from './image.class';
-import { LibConfig } from './lib-config.interface';
+import { ModalLibConfig } from './lib-config.interface';
 export interface ModalGalleryConfig {
     id: number;
     images: Image[];
     currentImage: Image;
-    libConfig?: LibConfig;
+    libConfig?: ModalLibConfig;
 }

package/lib/model/plain-gallery-config.interface.d.ts

@@ -9,7 +9,7 @@ export interface PlainGalleryConfig {
 }
 /**
  * Interface `PlainGalleryLayout` to configure the layout. This interface isn't used directly, instead
- * refers to either `LineLayout`, `GridLayout` or `AdvancedLayout`.
+ * refers to either `LineLayout`, `GridLayout`.
  */
 export interface PlainGalleryLayout {
 }
@@ -30,14 +30,6 @@ export declare class GridLayout implements PlainGalleryLayout {
     size: Size;
     constructor(size: Size, breakConfig: BreakConfig);
 }
-/**
- * Class `AdvancedLayout` to configure a fully custom plain gallery.
- */
-export declare class AdvancedLayout implements PlainGalleryLayout {
-    modalOpenerByIndex: number;
-    hideDefaultPlainGallery: boolean;
-    constructor(modalOpenerByIndex: number, hideDefaultPlainGallery: boolean);
-}
 /**
  * Enum `PlainGalleryStrategy` to choose the behaviour of the plain gallery.
  */

package/lib/services/id-validator.service.d.ts

@@ -15,8 +15,9 @@ export declare class IdValidatorService {
     /**
      * Method to remove a reserved id. In this way you are able to use the id again for another instance of the library.
      * @param galleryId number or undefined that represents the unique id of the gallery.
-     * @return boolean true if success. false is never returned, instead an exception is thrown
+     * @return boolean true if success. false is never returned, instead an exception is thrown*
      * @throws a error with a message if galleryId is neither integer or < 0
+     * * this should be improved without return true, because it doesn't make sense! :(
      */
     remove(galleryId: number | undefined): boolean;
     static ɵfac: i0.ɵɵFactoryDeclaration<IdValidatorService, never>;

package/lib/utils/user-input.util.d.ts

@@ -1,52 +1,69 @@
 /**
  * Key of the keyboard's key `enter`
  */
-export declare const ENTER_KEY = "Enter";
+export declare const ENTER_KEY: string;
 /**
  * Code of the keyboard's key `enter`
  */
-export declare const ENTER_CODE = "Enter";
+export declare const ENTER_CODE: string;
+/**
+ * Key of the keyboard's key `esc`
+ */
+export declare const ESC_KEY: string;
+/**
+ * Code of the keyboard's key `esc`
+ */
+export declare const ESC_CODE: string;
 /**
  * Key of the keyboard's key 'right arrow'
  */
-export declare const RIGHT_ARROW_KEY = "ArrowRight";
+export declare const RIGHT_ARROW_KEY: string;
 /**
  * Code of the keyboard's key 'right arrow'
  */
-export declare const RIGHT_ARROW_CODE = "ArrowRight";
+export declare const RIGHT_ARROW_CODE: string;
 /**
- * KeyCode of the keyboard's key 'right arrow'
- * Used in unit tests only
+ * Key of the keyboard's key 'left arrow'
  */
-export declare const RIGHT_ARROW_KEYCODE = 39;
+export declare const LEFT_ARROW_KEY: string;
+/**
+ * Code of the keyboard's key 'left arrow'
+ */
+export declare const LEFT_ARROW_CODE: string;
 /**
  * Key of the keyboard's key 'left arrow'
  */
-export declare const LEFT_ARROW_KEY = "ArrowLeft";
+export declare const UP_ARROW_KEY: string;
 /**
  * Code of the keyboard's key 'left arrow'
  */
-export declare const LEFT_ARROW_CODE = "ArrowLeft";
+export declare const UP_ARROW_CODE: string;
+/**
+ * Key of the keyboard's key 'left arrow'
+ */
+export declare const DOWN_ARROW_KEY: string;
 /**
- * KeyCode of the keyboard's key 'left arrow'
- * Used in unit tests only
+ * Code of the keyboard's key 'left arrow'
  */
-export declare const LEFT_ARROW_KEYCODE = 37;
+export declare const DOWN_ARROW_CODE: string;
 /**
  * Key of the keyboard's key `space`
  */
-export declare const SPACE_KEY = "";
+export declare const SPACE_KEY: string;
 /**
  * Code of the keyboard's key `space`
  */
-export declare const SPACE_CODE = "Space";
+export declare const SPACE_CODE: string;
+/**
+ * Const to represent the right direction
+ */
+export declare const DIRECTION_RIGHT: string;
 /**
- * KeyCode of the keyboard's key 'space'
- * Used in unit tests only
+ * Const to represent the left direction
  */
-export declare const SPACE_KEYCODE = 32;
+export declare const DIRECTION_LEFT: string;
 /**
- * KeyCode of the main mouse button
+ * Keycode of the main mouse button
  */
 export declare const MOUSE_MAIN_BUTTON_CLICK = 0;
 /**
@@ -61,11 +78,3 @@ export declare const PREV = -1;
  * Const NOTHING to represents a situation when it isn't both NEXT and PREV
  */
 export declare const NOTHING = 0;
-/**
- * Const to represent the right direction
- */
-export declare const DIRECTION_RIGHT = "right";
-/**
- * Const to represent the left direction
- */
-export declare const DIRECTION_LEFT = "left";

package/package.json

@@ -1,25 +1,25 @@
 {
   "name": "@ks89/angular-modal-gallery",
-  "version": "8.0.0-rc.1",
+  "version": "9.0.1",
   "description": "Image gallery for Angular",
   "license": "MIT",
   "author": "Stefano Cappa",
   "engines": {
-    "node": ">=14.17.0",
+    "node": ">=16.3.0",
     "npm": ">=7.16.0"
   },
-  "homepage": "https://ks89.github.io/angular-modal-gallery-2020-v8.github.io/",
+  "homepage": "https://ks89.github.io/angular-modal-gallery-2021-v9.github.io/",
   "dependencies": {
-    "tslib": ">=2.1.0"
+    "tslib": ">=2.3.0"
   },
   "peerDependencies": {
-    "@angular/platform-browser": ">=12.0.0",
-    "@angular/common": ">=12.0.0",
-    "@angular/core": ">=12.0.0",
-    "@angular/cdk": ">=12.0.0",
+    "@angular/platform-browser": ">=13.0.0",
+    "@angular/common": ">=13.0.0",
+    "@angular/core": ">=13.0.0",
+    "@angular/cdk": ">=13.0.0",
     "hammerjs": ">=2.0.8",
     "mousetrap": ">=1.6.5",
-    "rxjs": ">=6.6.0"
+    "rxjs": ">=7.4.0"
   },
   "keywords": [
     "angular-modal-gallery",
@@ -54,11 +54,24 @@
   "bugs": {
     "url": "https://github.com/Ks89/angular-modal-gallery/issues"
   },
-  "main": "bundles/ks89-angular-modal-gallery.umd.js",
-  "module": "fesm2015/ks89-angular-modal-gallery.js",
-  "es2015": "fesm2015/ks89-angular-modal-gallery.js",
-  "esm2015": "esm2015/ks89-angular-modal-gallery.js",
-  "fesm2015": "fesm2015/ks89-angular-modal-gallery.js",
+  "module": "fesm2015/ks89-angular-modal-gallery.mjs",
+  "es2020": "fesm2020/ks89-angular-modal-gallery.mjs",
+  "esm2020": "esm2020/ks89-angular-modal-gallery.mjs",
+  "fesm2020": "fesm2020/ks89-angular-modal-gallery.mjs",
+  "fesm2015": "fesm2015/ks89-angular-modal-gallery.mjs",
   "typings": "ks89-angular-modal-gallery.d.ts",
+  "exports": {
+    "./package.json": {
+      "default": "./package.json"
+    },
+    ".": {
+      "types": "./ks89-angular-modal-gallery.d.ts",
+      "esm2020": "./esm2020/ks89-angular-modal-gallery.mjs",
+      "es2020": "./fesm2020/ks89-angular-modal-gallery.mjs",
+      "es2015": "./fesm2015/ks89-angular-modal-gallery.mjs",
+      "node": "./fesm2015/ks89-angular-modal-gallery.mjs",
+      "default": "./fesm2020/ks89-angular-modal-gallery.mjs"
+    }
+  },
   "sideEffects": false
 }

package/public-api.d.ts

@@ -16,14 +16,14 @@ export { PlayConfig } from './lib/model/play-config.interface';
 export { CarouselImageConfig } from './lib/model/carousel-image-config.interface';
 export { Size } from './lib/model/size.interface';
 export { ButtonsConfig, ButtonsStrategy, ButtonType, ButtonEvent } from './lib/model/buttons-config.interface';
-export { LibConfig } from './lib/model/lib-config.interface';
+export { ModalLibConfig, PlainLibConfig, CarouselLibConfig } from './lib/model/lib-config.interface';
 export { ModalGalleryConfig } from './lib/model/modal-gallery-config.interface';
 export { CurrentImageConfig } from './lib/model/current-image-config.interface';
 export { LoadingConfig, LoadingType } from './lib/model/loading-config.interface';
 export { InteractionEvent } from './lib/model/interaction-event.interface';
 export { KS_DEFAULT_ACCESSIBILITY_CONFIG } from './lib/components/accessibility-default';
 export { KS_DEFAULT_BTN_FULL_SCREEN, KS_DEFAULT_BTN_CLOSE, KS_DEFAULT_BTN_DELETE, KS_DEFAULT_BTN_DOWNLOAD, KS_DEFAULT_BTN_EXTURL, KS_DEFAULT_SIZE } from './lib/components/upper-buttons/upper-buttons-default';
-export { PlainGalleryConfig, PlainGalleryLayout, LineLayout, GridLayout, AdvancedLayout, PlainGalleryStrategy, BreakConfig } from './lib/model/plain-gallery-config.interface';
+export { PlainGalleryConfig, PlainGalleryLayout, LineLayout, GridLayout, PlainGalleryStrategy, BreakConfig } from './lib/model/plain-gallery-config.interface';
 export { ModalGalleryComponent } from './lib/components/modal-gallery/modal-gallery.component';
 export { PlainGalleryComponent } from './lib/components/plain-gallery/plain-gallery.component';
 export { CarouselComponent } from './lib/components/carousel/carousel.component';