feat(): deprecate forRoot and remove galleryService and IdValidatorSe…

…rvice in favour of providedIn: 'root' #144
Ks89 · Oct 15, 2018 · 1ab263b · 1ab263b
1 parent 5ee047d
commit 1ab263b
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 20 deletions.
diff --git a/projects/ks89/angular-modal-gallery/src/lib/modal-gallery.module.ts b/projects/ks89/angular-modal-gallery/src/lib/modal-gallery.module.ts
@@ -29,8 +29,6 @@ import { DIRECTIVES } from './directives/directives';
 import { COMPONENTS, ModalGalleryComponent, CarouselComponent } from './components/components';
 import { KEYBOARD_CONFIGURATION, KeyboardService } from './services/keyboard.service';
 import { KeyboardServiceConfig } from './model/keyboard-service-config.interface';
-import { GalleryService } from './services/gallery.service';
-import { IdValidatorService } from './services/id-validator.service';
 
 /**
  * Module with `forRoot` method to import it in the root module of your application.
@@ -41,6 +39,12 @@ import { IdValidatorService } from './services/id-validator.service';
   exports: [ModalGalleryComponent, CarouselComponent]
 })
 export class GalleryModule {
+  /**
+   * Importing with '.forRoot()' is no longer necessary, you can simply import the module.
+   * Will be removed in 8.0.0.
+   *
+   * @deprecated 7.0.0
+   */
   static forRoot(config?: KeyboardServiceConfig): ModuleWithProviders {
     return {
       ngModule: GalleryModule,
@@ -53,14 +57,6 @@ export class GalleryModule {
           provide: KeyboardService,
           useFactory: setupKeyboardService,
           deps: [KEYBOARD_CONFIGURATION]
-        },
-        {
-          provide: GalleryService,
-          useFactory: setupGalleryService
-        },
-        {
-          provide: IdValidatorService,
-          useFactory: setupIdValidatorService
         }
       ]
     };
@@ -75,11 +71,3 @@ export class GalleryModule {
 export function setupKeyboardService(injector: KeyboardServiceConfig): KeyboardService {
   return new KeyboardService(injector);
 }
-
-export function setupGalleryService(): GalleryService {
-  return new GalleryService();
-}
-
-export function setupIdValidatorService(): IdValidatorService {
-  return new IdValidatorService();
-}
diff --git a/projects/ks89/angular-modal-gallery/src/lib/services/gallery.service.ts b/projects/ks89/angular-modal-gallery/src/lib/services/gallery.service.ts
@@ -31,7 +31,7 @@ export interface InternalGalleryPayload {
   image?: Image;
 }
 
-@Injectable()
+@Injectable({ providedIn: 'root' })
 export class GalleryService {
   navigate: EventEmitter<InternalGalleryPayload> = new EventEmitter<InternalGalleryPayload>();
   close: EventEmitter<number> = new EventEmitter<number>();
@@ -64,6 +64,11 @@ export class GalleryService {
     this.close.emit(galleryId);
   }
 
+  /**
+   * Service to update an image with a new object
+   *
+   * @since 6.3.0
+   */
   updateGallery(galleryId: number | undefined, index: number, image: Image): void {
     if (galleryId === undefined || galleryId < 0 || index < 0) {
       throw new Error('Cannot update gallery via GalleryService with either index<0 or galleryId<0 or galleryId===undefined');

diff --git a/projects/ks89/angular-modal-gallery/src/lib/services/id-validator.service.ts b/projects/ks89/angular-modal-gallery/src/lib/services/id-validator.service.ts
@@ -27,7 +27,7 @@ import { Injectable } from '@angular/core';
 /**
  * Service to check if the provided id is unique
  */
-@Injectable()
+@Injectable({ providedIn: 'root' })
 export class IdValidatorService {
   ids = new Map();