chore(comments): fix 'em

README.md

@@ -34,6 +34,18 @@ import '@ng-web-apis/universal/mocks';
 
 ## Tokens
 
+You can provide tokens from this package into your `app.server.module.ts`
+to have type safe mocks for global objects on server side:
+
+```ts
+@NgModule({
+    imports: [AppBrowserModule, ServerModule],
+    bootstrap: [AppComponent],
+    providers: [UNIVERSAL_WINDOW],
+})
+export class AppServerModule {}
+```
+
 -   `WINDOW` — add `UNIVERSAL_WINDOW` to provide type-safe mock object, effectively mocking all `navigator` related entities
 -   `NAVIGATOR` — add `UNIVERSAL_NAVIGATOR` to provide type-safe mock object, effectively mocking all `navigator` related entities
 -   `NETWORK_INFORMATION` — no need to do anything

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

@@ -1,10 +1,10 @@
 import {FactoryProvider} from '@angular/core';
-import {USER_AGENT} from '@ng-web-apis/common';
+import {LOCATION} from '@ng-web-apis/common';
 import {SSR_LOCATION} from '../tokens/ssr-location';
 import {identity} from '../utils/functions';
 
 export const UNIVERSAL_LOCATION: FactoryProvider = {
-    provide: USER_AGENT,
+    provide: LOCATION,
     deps: [SSR_LOCATION],
     useFactory: identity,
 };

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

@@ -50,100 +50,105 @@ interface NavigatorLike extends Navigator {
     [key: string]: any;
 }
 
+export const NAVIGATOR_MOCK: NavigatorLike = {
+    appCodeName: '',
+    appName: '',
+    appVersion: '',
+    platform: '',
+    product: '',
+    productSub: '',
+    userAgent: '',
+    vendor: '',
+    vendorSub: '',
+
+    onLine: false,
+
+    confirmSiteSpecificTrackingException: alwaysFalse,
+    confirmWebWideTrackingException: alwaysFalse,
+    removeSiteSpecificTrackingException: emptyFunction,
+    removeWebWideTrackingException: emptyFunction,
+    storeSiteSpecificTrackingException: emptyFunction,
+    storeWebWideTrackingException: emptyFunction,
+
+    msSaveBlob: alwaysFalse,
+    msSaveOrOpenBlob: alwaysFalse,
+
+    sendBeacon: alwaysFalse,
+
+    hardwareConcurrency: 0,
+
+    getDisplayMedia: alwaysRejected,
+
+    language: '',
+    languages: [],
+
+    storage: {
+        estimate: alwaysRejected,
+        persist: alwaysRejected,
+        persisted: alwaysRejected,
+    },
+
+    activeVRDisplays: [],
+    authentication: {
+        getAssertion: alwaysRejected,
+        makeCredential: alwaysRejected,
+    },
+    clipboard: {
+        ...EVENT_TARGET,
+        readText: alwaysRejected,
+        writeText: alwaysRejected,
+    },
+    cookieEnabled: false,
+    doNotTrack: null,
+    gamepadInputEmulation: 'keyboard',
+    geolocation: {
+        clearWatch: emptyFunction,
+        getCurrentPosition: emptyFunction,
+        watchPosition: alwaysZero,
+    },
+    maxTouchPoints: 0,
+    mediaDevices: {
+        ...EVENT_TARGET,
+        ondevicechange: null,
+        enumerateDevices: alwaysRejected,
+        getSupportedConstraints: emptyObject,
+        getUserMedia: alwaysRejected,
+    },
+    mimeTypes: MIME_TYPES,
+    msManipulationViewsEnabled: false,
+    msMaxTouchPoints: 0,
+    msPointerEnabled: false,
+    permissions: {
+        query: alwaysRejected,
+    },
+    plugins: MIME_TYPES,
+    pointerEnabled: false,
+    serviceWorker: {
+        ...EVENT_TARGET,
+        controller: null,
+        oncontrollerchange: null,
+        onmessage: null,
+        onmessageerror: null,
+        ready: alwaysRejected(),
+        getRegistration: alwaysRejected,
+        getRegistrations: alwaysRejected,
+        register: alwaysRejected,
+        startMessages: emptyFunction,
+    },
+    webdriver: false,
+    getGamepads: emptyArray,
+    getUserMedia: emptyFunction,
+    getVRDisplays: alwaysRejected,
+    javaEnabled: alwaysFalse,
+    msLaunchUri: emptyFunction,
+    requestMediaKeySystemAccess: alwaysRejected,
+    vibrate: alwaysFalse,
+};
+
 export function navigatorFactory(userAgent: string | null): NavigatorLike {
     return {
-        appCodeName: '',
-        appName: '',
-        appVersion: '',
-        platform: '',
-        product: '',
-        productSub: '',
+        ...NAVIGATOR_MOCK,
         userAgent: userAgent || '',
-        vendor: '',
-        vendorSub: '',
-
-        onLine: false,
-
-        confirmSiteSpecificTrackingException: alwaysFalse,
-        confirmWebWideTrackingException: alwaysFalse,
-        removeSiteSpecificTrackingException: emptyFunction,
-        removeWebWideTrackingException: emptyFunction,
-        storeSiteSpecificTrackingException: emptyFunction,
-        storeWebWideTrackingException: emptyFunction,
-
-        msSaveBlob: alwaysFalse,
-        msSaveOrOpenBlob: alwaysFalse,
-
-        sendBeacon: alwaysFalse,
-
-        hardwareConcurrency: 0,
-
-        getDisplayMedia: alwaysRejected,
-
-        language: '',
-        languages: [],
-
-        storage: {
-            estimate: alwaysRejected,
-            persist: alwaysRejected,
-            persisted: alwaysRejected,
-        },
-
-        activeVRDisplays: [],
-        authentication: {
-            getAssertion: alwaysRejected,
-            makeCredential: alwaysRejected,
-        },
-        clipboard: {
-            ...EVENT_TARGET,
-            readText: alwaysRejected,
-            writeText: alwaysRejected,
-        },
-        cookieEnabled: false,
-        doNotTrack: null,
-        gamepadInputEmulation: 'keyboard',
-        geolocation: {
-            clearWatch: emptyFunction,
-            getCurrentPosition: emptyFunction,
-            watchPosition: alwaysZero,
-        },
-        maxTouchPoints: 0,
-        mediaDevices: {
-            ...EVENT_TARGET,
-            ondevicechange: null,
-            enumerateDevices: alwaysRejected,
-            getSupportedConstraints: emptyObject,
-            getUserMedia: alwaysRejected,
-        },
-        mimeTypes: MIME_TYPES,
-        msManipulationViewsEnabled: false,
-        msMaxTouchPoints: 0,
-        msPointerEnabled: false,
-        permissions: {
-            query: alwaysRejected,
-        },
-        plugins: MIME_TYPES,
-        pointerEnabled: false,
-        serviceWorker: {
-            ...EVENT_TARGET,
-            controller: null,
-            oncontrollerchange: null,
-            onmessage: null,
-            onmessageerror: null,
-            ready: alwaysRejected(),
-            getRegistration: alwaysRejected,
-            getRegistrations: alwaysRejected,
-            register: alwaysRejected,
-            startMessages: emptyFunction,
-        },
-        webdriver: false,
-        getGamepads: emptyArray,
-        getUserMedia: emptyFunction,
-        getVRDisplays: alwaysRejected,
-        javaEnabled: alwaysFalse,
-        msLaunchUri: emptyFunction,
-        requestMediaKeySystemAccess: alwaysRejected,
-        vibrate: alwaysFalse,
     };
 }
 

projects/universal/src/constants/universal-speech-synthesis.ts

@@ -2,7 +2,7 @@ import {ValueProvider} from '@angular/core';
 import {SPEECH_SYNTHESIS} from '@ng-web-apis/common';
 import {alwaysFalse, emptyArray, emptyFunction} from '../utils/functions';
 
-const MOCK: SpeechSynthesis = {
+export const SPEECH_SYNTHESIS_MOCK: SpeechSynthesis = {
     paused: false,
     pending: false,
     speaking: false,
@@ -19,5 +19,5 @@ const MOCK: SpeechSynthesis = {
 
 export const UNIVERSAL_SPEECH_SYNTHESIS: ValueProvider = {
     provide: SPEECH_SYNTHESIS,
-    useValue: MOCK,
+    useValue: SPEECH_SYNTHESIS_MOCK,
 };

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

@@ -1,15 +1,10 @@
 import {DOCUMENT} from '@angular/common';
-import {FactoryProvider} from '@angular/core';
-import {
-    LOCAL_STORAGE,
-    LOCATION,
-    NAVIGATOR,
-    PERFORMANCE,
-    SESSION_STORAGE,
-    SPEECH_SYNTHESIS,
-    WINDOW,
-} from '@ng-web-apis/common';
+import {FactoryProvider, Optional} from '@angular/core';
+import {WINDOW} from '@ng-web-apis/common';
 import {BlobMock} from '../classes/blob-mock';
+import {StorageMock} from '../classes/storage-mock';
+import {SSR_LOCATION} from '../tokens/ssr-location';
+import {SSR_USER_AGENT} from '../tokens/ssr-user-agent';
 import {EVENT_TARGET} from '../utils/event-target';
 import {
     alwaysFalse,
@@ -19,6 +14,9 @@ import {
     emptyFunction,
     identity,
 } from '../utils/functions';
+import {NAVIGATOR_MOCK} from './universal-navigator';
+import {performanceFactory} from './universal-performance';
+import {SPEECH_SYNTHESIS_MOCK} from './universal-speech-synthesis';
 
 const COMPUTED_STYLES: Partial<CSSStyleDeclaration> = {
     getPropertyPriority: () => '',
@@ -65,22 +63,18 @@ const WINDOW_HANDLER: ProxyHandler<Window> = {
 
 export function windowFactory(
     document: Document,
-    navigator: Navigator,
-    localStorage: Storage,
     location: Location,
-    performance: Performance,
-    sessionStorage: Storage,
-    speechSynthesis: SpeechSynthesis,
+    userAgent: string,
 ): Window {
     const windowMock: Window = {
         ...EVENT_TARGET,
         document,
-        localStorage,
-        location,
-        navigator,
-        performance,
-        sessionStorage,
-        speechSynthesis,
+        localStorage: new StorageMock(),
+        location: location || {},
+        navigator: {...NAVIGATOR_MOCK, userAgent: userAgent || ''},
+        performance: performanceFactory(),
+        sessionStorage: new StorageMock(),
+        speechSynthesis: SPEECH_SYNTHESIS_MOCK,
         URL,
         URLSearchParams,
         setTimeout,
@@ -205,14 +199,6 @@ export function windowFactory(
 
 export const UNIVERSAL_WINDOW: FactoryProvider = {
     provide: WINDOW,
-    deps: [
-        DOCUMENT,
-        LOCAL_STORAGE,
-        LOCATION,
-        NAVIGATOR,
-        PERFORMANCE,
-        SESSION_STORAGE,
-        SPEECH_SYNTHESIS,
-    ],
+    deps: [DOCUMENT, [new Optional(), SSR_LOCATION], [new Optional(), SSR_USER_AGENT]],
     useFactory: windowFactory,
 };