fix(core): Don't expost "adapter" naming in API

Author: Airblader

projects/ngqp-demo/src/app/test-router-adapter.service.ts

@@ -1,8 +1,7 @@
 import { Injectable } from '@angular/core';
 import { convertToParamMap, ParamMap, Params } from '@angular/router';
 import { ReplaySubject } from 'rxjs';
-import { RouterAdapter } from '@ngqp/core';
-import { RouterAdapterOptions } from '../../../ngqp/core/src/lib/router-adapter/router-adapter.interface';
+import { RouterAdapter, RouterOptions } from '@ngqp/core';
 
 @Injectable()
 export class TestRouterAdapter implements RouterAdapter {
@@ -15,7 +14,7 @@ export class TestRouterAdapter implements RouterAdapter {
 
     private _params: Params;
 
-    public navigate(queryParams: Params, extras: RouterAdapterOptions = {}): Promise<boolean> {
+    public navigate(queryParams: Params, extras: RouterOptions = {}): Promise<boolean> {
         const previousUrl = this.url;
 
         const newParams = {

projects/ngqp/core/src/lib/model.ts

@@ -2,7 +2,7 @@ import { Params } from '@angular/router';
 import { Observable, Subject } from 'rxjs';
 import { Comparator, isFunction, isMissing, wrapTryCatch } from './util';
 import { createEmptyOnDeserializer, createEmptyOnSerializer } from './serializers';
-import { RouterAdapterOptions } from './router-adapter/router-adapter.interface';
+import { RouterOptions } from './router-adapter/router-adapter.interface';
 
 /**
  * A serializer defines how the represented form control's
@@ -141,13 +141,13 @@ export class QueryParamGroup {
     public readonly queryParams: { [ queryParamName: string ]: QueryParam<any> };
 
     /** @internal */
-    public readonly routerOptions: RouterAdapterOptions;
+    public readonly routerOptions: RouterOptions;
 
     private changeFunctions: OnChangeFunction<QueryParamGroupValue>[] = [];
 
     constructor(
         queryParams: { [ queryParamName: string ]: QueryParam<any> },
-        extras: RouterAdapterOptions = {}
+        extras: RouterOptions = {}
     ) {
         this.queryParams = queryParams;
         this.routerOptions = extras;

projects/ngqp/core/src/lib/query-param-builder.service.ts

@@ -9,7 +9,7 @@ import {
     DEFAULT_STRING_SERIALIZER
 } from './serializers';
 import { LOOSE_IDENTITY_COMPARATOR } from './util';
-import { RouterAdapterOptions } from './router-adapter/router-adapter.interface';
+import { RouterOptions } from './router-adapter/router-adapter.interface';
 
 type OverwritePartial<T1, T2 extends keyof T1> = Pick<T1, Exclude<keyof T1, T2>> & Partial<Pick<T1, T2>>;
 
@@ -40,7 +40,7 @@ export class QueryParamBuilder {
      */
     public group(
         queryParams: { [ name: string ]: QueryParam<any> | string },
-        extras: RouterAdapterOptions = {}
+        extras: RouterOptions = {}
     ): QueryParamGroup {
         const mappedQueryParams: { [ queryParamName: string ]: QueryParam<any> } = {};
         Object.keys(queryParams).forEach(queryParamName => {

projects/ngqp/core/src/lib/query-param-group.directive.ts

@@ -2,7 +2,7 @@ import { Directive, Inject, Input, OnDestroy, OnInit, Optional } from '@angular/
 import { Params } from '@angular/router';
 import { Subject } from 'rxjs';
 import { concatMap, debounceTime, map, takeUntil, tap } from 'rxjs/operators';
-import { NGQP_ROUTER_ADAPTER, NGQP_ROUTER_OPTIONS, RouterAdapter, RouterAdapterOptions } from './router-adapter/router-adapter.interface';
+import { NGQP_ROUTER_ADAPTER, NGQP_ROUTER_OPTIONS, RouterAdapter, RouterOptions } from './router-adapter/router-adapter.interface';
 import { QueryParamNameDirective } from './query-param-name.directive';
 import { QueryParam, QueryParamGroup, QueryParamGroupValue, Unpack } from './model';
 import { isMissing } from './util';
@@ -46,7 +46,7 @@ export class QueryParamGroupDirective implements OnInit, OnDestroy {
 
     constructor(
         @Inject(NGQP_ROUTER_ADAPTER) private routerAdapter: RouterAdapter,
-        @Optional() @Inject(NGQP_ROUTER_OPTIONS) private globalRouterOptions: RouterAdapterOptions
+        @Optional() @Inject(NGQP_ROUTER_OPTIONS) private globalRouterOptions: RouterOptions
     ) {
         this.setupNavigationQueue();
     }
@@ -170,7 +170,7 @@ export class QueryParamGroupDirective implements OnInit, OnDestroy {
         }
     }
 
-    private get routerOptions(): RouterAdapterOptions {
+    private get routerOptions(): RouterOptions {
         const groupOptions = this.queryParamGroup ? this.queryParamGroup.routerOptions : {};
 
         return {

projects/ngqp/core/src/lib/query-param.module.ts

@@ -14,10 +14,10 @@ import {
 } from './accessors/accessors';
 import {
     DefaultRouterAdapter,
-    DefaultRouterAdapterOptions,
+    DefaultRouterOptions,
     NGQP_ROUTER_ADAPTER,
     NGQP_ROUTER_OPTIONS,
-    RouterAdapterOptions
+    RouterOptions
 } from './router-adapter/router-adapter';
 
 /** @ignore */
@@ -48,19 +48,19 @@ const DIRECTIVES: Type<any>[] = [
         },
         {
             provide: NGQP_ROUTER_OPTIONS,
-            useValue: DefaultRouterAdapterOptions,
+            useValue: DefaultRouterOptions,
         },
     ],
 })
 export class QueryParamModule {
 
-    public static forRoot(config: { routerOptions?: RouterAdapterOptions } = {}): ModuleWithProviders<QueryParamModule> {
+    public static forRoot(config: { routerOptions?: RouterOptions } = {}): ModuleWithProviders<QueryParamModule> {
         return {
             ngModule: QueryParamModule,
             providers: [
                 {
                     provide: NGQP_ROUTER_OPTIONS,
-                    useValue: config.routerOptions ? config.routerOptions : DefaultRouterAdapterOptions,
+                    useValue: config.routerOptions ? config.routerOptions : DefaultRouterOptions,
                 },
             ],
         };

projects/ngqp/core/src/lib/router-adapter/default-router-adapter.service.ts

@@ -1,6 +1,6 @@
 import { Injectable } from '@angular/core';
 import { ActivatedRoute, Params, Router } from '@angular/router';
-import { RouterAdapter, RouterAdapterOptions } from './router-adapter.interface';
+import { RouterAdapter, RouterOptions } from './router-adapter.interface';
 
 /** @internal */
 @Injectable()
@@ -17,7 +17,7 @@ export class DefaultRouterAdapter implements RouterAdapter {
         return this.route.queryParamMap;
     }
 
-    public navigate(queryParams: Params, extras: RouterAdapterOptions = {}): Promise<boolean> {
+    public navigate(queryParams: Params, extras: RouterOptions = {}): Promise<boolean> {
         return this.router.navigate([], {
             relativeTo: this.route,
             queryParamsHandling: 'merge',

projects/ngqp/core/src/lib/router-adapter/router-adapter.interface.ts

@@ -20,25 +20,25 @@ export interface RouterAdapter {
     queryParamMap: Observable<ParamMap>;
 
     /** @internal */
-    navigate(queryParams: Params, extras?: RouterAdapterOptions): Promise<boolean>;
+    navigate(queryParams: Params, extras?: RouterOptions): Promise<boolean>;
 
 }
 
 /**
  * Options to be provided when a navigation is started to update the URL.
  * These options are simply forwarded to Router#navigate.
  */
-export type RouterAdapterOptions = Pick<NavigationExtras, 'replaceUrl'>;
+export type RouterOptions = Pick<NavigationExtras, 'replaceUrl'>;
 
 /**
- * See {@link RouterAdapterOptions}.
+ * See {@link RouterOptions}.
  */
-export const DefaultRouterAdapterOptions: RouterAdapterOptions = {
+export const DefaultRouterOptions: RouterOptions = {
     replaceUrl: true,
 };
 
 /** @internal */
 export const NGQP_ROUTER_ADAPTER = new InjectionToken<RouterAdapter>('NGQP_ROUTER_ADAPTER');
 
-/** Injection token to provide {@link RouterAdapterOptions}. */
-export const NGQP_ROUTER_OPTIONS = new InjectionToken<RouterAdapterOptions>('NGQP_ROUTER_OPTIONS');
+/** Injection token to provide {@link RouterOptions}. */
+export const NGQP_ROUTER_OPTIONS = new InjectionToken<RouterOptions>('NGQP_ROUTER_OPTIONS');

projects/ngqp/core/src/lib/router-adapter/router-adapter.ts

@@ -1,8 +1,8 @@
 export {
     RouterAdapter,
     NGQP_ROUTER_ADAPTER,
-    RouterAdapterOptions,
-    DefaultRouterAdapterOptions,
+    RouterOptions,
+    DefaultRouterOptions,
     NGQP_ROUTER_OPTIONS
 } from './router-adapter.interface';
 export { DefaultRouterAdapter } from './default-router-adapter.service';