feat: provide typesafe mocks for SSR_USER_AGENT & SSR_LOCATION (#41)

* feat: provide typesafe mocks for `SSR_USER_AGENT` & `SSR_LOCATION`

* chore: move mock-fallbacks (for user-agent & location) to another places

README.md

@@ -58,6 +58,8 @@ from requests. Use the following helpers to harvest that info:
 **server.ts:**
 
 ```typescript
+import {provideLocation, provideUserAgent} from '@ng-web-apis/universal';
+// ...
 app.get('/**/*', (req: Request, res: Response) => {
     res.render('../dist/index', {
         req,

projects/universal/src/classes/dom-string-list-mock.ts

@@ -0,0 +1,9 @@
+export class DOMStringListMock extends Array<string> implements DOMStringList {
+    contains(): boolean {
+        return false;
+    }
+
+    item(): null {
+        return null;
+    }
+}

projects/universal/src/classes/location-mock.ts

@@ -0,0 +1,21 @@
+import {emptyFunction} from '../utils/functions';
+import {DOMStringListMock} from './dom-string-list-mock';
+
+export class LocationMock implements Location {
+    readonly ancestorOrigins = new DOMStringListMock();
+    hash = '';
+    host = '';
+    hostname = '';
+    href = '';
+    readonly origin = '';
+    pathname = '';
+    port = '';
+    protocol = '';
+    search = '';
+
+    assign = emptyFunction;
+
+    reload = emptyFunction;
+
+    replace = emptyFunction;
+}

projects/universal/src/constants/universal-location.ts

@@ -1,10 +1,11 @@
-import {FactoryProvider} from '@angular/core';
+import {FactoryProvider, Optional} from '@angular/core';
 import {LOCATION} from '@ng-web-apis/common';
+
+import {LocationMock} from '../classes/location-mock';
 import {SSR_LOCATION} from '../tokens/ssr-location';
-import {identity} from '../utils/functions';
 
 export const UNIVERSAL_LOCATION: FactoryProvider = {
     provide: LOCATION,
-    deps: [SSR_LOCATION],
-    useFactory: identity,
+    deps: [[new Optional(), SSR_LOCATION]],
+    useFactory: (location: Location | null) => location || new LocationMock(),
 };

projects/universal/src/constants/universal-user-agent.ts

@@ -1,10 +1,10 @@
-import {FactoryProvider} from '@angular/core';
+import {FactoryProvider, Optional} from '@angular/core';
 import {USER_AGENT} from '@ng-web-apis/common';
+
 import {SSR_USER_AGENT} from '../tokens/ssr-user-agent';
-import {identity} from '../utils/functions';
 
 export const UNIVERSAL_USER_AGENT: FactoryProvider = {
     provide: USER_AGENT,
-    deps: [SSR_USER_AGENT],
-    useFactory: identity,
+    deps: [[new Optional(), SSR_USER_AGENT]],
+    useFactory: (userAgent: string | null) => userAgent || '',
 };

projects/universal/src/constants/universal-window.ts

@@ -1,7 +1,9 @@
 import {DOCUMENT} from '@angular/common';
 import {FactoryProvider, Optional} from '@angular/core';
 import {WINDOW} from '@ng-web-apis/common';
+
 import {BlobMock} from '../classes/blob-mock';
+import {LocationMock} from '../classes/location-mock';
 import {StorageMock} from '../classes/storage-mock';
 import {SSR_LOCATION} from '../tokens/ssr-location';
 import {SSR_USER_AGENT} from '../tokens/ssr-user-agent';
@@ -65,14 +67,14 @@ const WINDOW_HANDLER: ProxyHandler<Window> = {
 
 export function windowFactory(
     document: Document,
-    location: Location,
-    userAgent: string,
+    location: Location | null,
+    userAgent: string | null,
 ): Window {
     const windowMock: Window = {
         ...EVENT_TARGET,
         document,
         localStorage: new StorageMock(),
-        location: location || {},
+        location: location || new LocationMock(),
         navigator: {...NAVIGATOR_MOCK, userAgent: userAgent || ''},
         performance: performanceFactory(),
         sessionStorage: new StorageMock(),

projects/universal/src/utils/provide-location.ts

@@ -1,5 +1,7 @@
 import {ValueProvider} from '@angular/core';
 import {IncomingMessage} from 'http';
+
+import {DOMStringListMock} from '../classes/dom-string-list-mock';
 import {SSR_LOCATION} from '../tokens/ssr-location';
 import {emptyFunction} from './functions';
 
@@ -10,15 +12,7 @@ export function provideLocation(req: IncomingMessage): ValueProvider {
     url.assign = emptyFunction;
     url.reload = emptyFunction;
     url.replace = emptyFunction;
-    url.ancestorOrigins = new (class extends Array<string> implements DOMStringList {
-        contains(): boolean {
-            return false;
-        }
-
-        item(): null {
-            return null;
-        }
-    })();
+    url.ancestorOrigins = new DOMStringListMock();
 
     return {
         provide: SSR_LOCATION,