@angular/service-worker 13.0.0-next.8 → 13.0.0-rc.2

package/package.json

@@ -1,18 +1,48 @@
 {
   "name": "@angular/service-worker",
-  "version": "13.0.0-next.8",
+  "version": "13.0.0-rc.2",
   "description": "Angular - service worker tooling!",
   "author": "angular",
   "license": "MIT",
   "engines": {
-    "node": "^12.14.1 || >=14.0.0"
+    "node": "^12.20.0 || ^14.15.0 || >=16.10.0"
+  },
+  "exports": {
+    "./ngsw-worker.js": {
+      "default": "./ngsw-worker.js"
+    },
+    "./safety-worker.js": {
+      "default": "./safety-worker.js"
+    },
+    "./config/schema.json": {
+      "default": "./config/schema.json"
+    },
+    "./package.json": {
+      "default": "./package.json"
+    },
+    ".": {
+      "types": "./service-worker.d.ts",
+      "esm2020": "./esm2020/service-worker.mjs",
+      "es2020": "./fesm2020/service-worker.mjs",
+      "es2015": "./fesm2015/service-worker.mjs",
+      "node": "./fesm2015/service-worker.mjs",
+      "default": "./fesm2020/service-worker.mjs"
+    },
+    "./config": {
+      "types": "./config/config.d.ts",
+      "esm2020": "./esm2020/config/config.mjs",
+      "es2020": "./fesm2020/config.mjs",
+      "es2015": "./fesm2015/config.mjs",
+      "node": "./fesm2015/config.mjs",
+      "default": "./fesm2020/config.mjs"
+    }
   },
   "dependencies": {
     "tslib": "^2.3.0"
   },
   "peerDependencies": {
-    "@angular/core": "13.0.0-next.8",
-    "@angular/common": "13.0.0-next.8"
+    "@angular/core": "13.0.0-rc.2",
+    "@angular/common": "13.0.0-rc.2"
   },
   "repository": {
     "type": "git",
@@ -43,10 +73,11 @@
     ]
   },
   "sideEffects": false,
-  "main": "./bundles/service-worker.umd.js",
-  "fesm2015": "./fesm2015/service-worker.js",
-  "esm2015": "./esm2015/service-worker.js",
+  "fesm2020": "./fesm2020/service-worker.mjs",
+  "fesm2015": "./fesm2015/service-worker.mjs",
+  "esm2020": "./esm2020/service-worker.mjs",
   "typings": "./service-worker.d.ts",
-  "module": "./fesm2015/service-worker.js",
-  "es2015": "./fesm2015/service-worker.js"
+  "module": "./fesm2015/service-worker.mjs",
+  "es2020": "./fesm2020/service-worker.mjs",
+  "type": "module"
 }

package/service-worker.d.ts

@@ -1,14 +1,31 @@
 /**
- * @license Angular v13.0.0-next.8
+ * @license Angular v13.0.0-rc.2
  * (c) 2010-2021 Google LLC. https://angular.io/
  * License: MIT
  */
 
-import { InjectionToken } from '@angular/core';
-import { Injector } from '@angular/core';
+import * as i0 from '@angular/core';
 import { ModuleWithProviders } from '@angular/core';
 import { Observable } from 'rxjs';
 
+/**
+ * @publicApi
+ */
+declare class NgswCommChannel {
+    private serviceWorker;
+    readonly worker: Observable<ServiceWorker>;
+    readonly registration: Observable<ServiceWorkerRegistration>;
+    readonly events: Observable<TypedEvent>;
+    constructor(serviceWorker: ServiceWorkerContainer | undefined);
+    postMessage(action: string, payload: Object): Promise<void>;
+    postMessageWithOperation(type: string, payload: Object, operationNonce: number): Promise<boolean>;
+    generateNonce(): number;
+    eventsOfType<T extends TypedEvent>(type: T['type'] | T['type'][]): Observable<T>;
+    nextEventOfType<T extends TypedEvent>(type: T['type']): Observable<T>;
+    waitForOperationCompleted(nonce: number): Promise<boolean>;
+    get isEnabled(): boolean;
+}
+
 /**
  * @publicApi
  */
@@ -20,6 +37,9 @@ export declare class ServiceWorkerModule {
      * workers are not supported by the browser, and the service worker will not be registered.
      */
     static register(script: string, opts?: SwRegistrationOptions): ModuleWithProviders<ServiceWorkerModule>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<ServiceWorkerModule, never>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<ServiceWorkerModule, never, never, never>;
+    static ɵinj: i0.ɵɵInjectorDeclaration<ServiceWorkerModule>;
 }
 
 /**
@@ -137,7 +157,7 @@ export declare class SwPush {
     get isEnabled(): boolean;
     private pushManager;
     private subscriptionChanges;
-    constructor(sw: ɵangular_packages_service_worker_service_worker_a);
+    constructor(sw: NgswCommChannel);
     /**
      * Subscribes to Web Push Notifications,
      * after requesting and receiving user permission.
@@ -156,6 +176,8 @@ export declare class SwPush {
      */
     unsubscribe(): Promise<void>;
     private decodeBase64;
+    static ɵfac: i0.ɵɵFactoryDeclaration<SwPush, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<SwPush>;
 }
 
 /**
@@ -226,12 +248,40 @@ export declare abstract class SwRegistrationOptions {
  */
 export declare class SwUpdate {
     private sw;
+    /**
+     * Emits a `VersionDetectedEvent` event whenever a new version is detected on the server.
+     *
+     * Emits a `VersionInstallationFailedEvent` event whenever checking for or downloading a new
+     * version fails.
+     *
+     * Emits a `VersionReadyEvent` event whenever a new version has been downloaded and is ready for
+     * activation.
+     */
+    readonly versionUpdates: Observable<VersionEvent>;
     /**
      * Emits an `UpdateAvailableEvent` event whenever a new app version is available.
+     *
+     * @deprecated Use {@link versionUpdates} instead.
+     *
+     * The of behavior `available` can be rebuild by filtering for the `VersionReadyEvent`:
+     * ```
+     * import {filter, map} from 'rxjs/operators';
+     * // ...
+     * const updatesAvailable = swUpdate.versionUpdates.pipe(
+     *   filter((evt): evt is VersionReadyEvent => evt.type === 'VERSION_READY'),
+     *   map(evt => ({
+     *     type: 'UPDATE_AVAILABLE',
+     *     current: evt.currentVersion,
+     *     available: evt.latestVersion,
+     *   })));
+     * ```
      */
     readonly available: Observable<UpdateAvailableEvent>;
     /**
      * Emits an `UpdateActivatedEvent` event whenever the app has been updated to a new version.
+     *
+     * @deprecated Use the return value of {@link SwUpdate#activateUpdate} instead.
+     *
      */
     readonly activated: Observable<UpdateActivatedEvent>;
     /**
@@ -245,9 +295,30 @@ export declare class SwUpdate {
      * `ServiceWorkerModule`).
      */
     get isEnabled(): boolean;
-    constructor(sw: ɵangular_packages_service_worker_service_worker_a);
-    checkForUpdate(): Promise<void>;
-    activateUpdate(): Promise<void>;
+    constructor(sw: NgswCommChannel);
+    /**
+     * Checks for an update and waits until the new version is downloaded from the server and ready
+     * for activation.
+     *
+     * @returns a promise that
+     * - resolves to `true` if a new version was found and is ready to be activated.
+     * - resolves to `false` if no new version was found
+     * - rejects if any error occurs
+     */
+    checkForUpdate(): Promise<boolean>;
+    /**
+     * Updates the current client (i.e. browser tab) to the latest version that is ready for
+     * activation.
+     *
+     * @returns a promise that
+     *  - resolves to `true` if an update was activated successfully
+     *  - resolves to `false` if no update was available (for example, the client was already on the
+     *    latest version).
+     *  - rejects if any error occurs
+     */
+    activateUpdate(): Promise<boolean>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<SwUpdate, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<SwUpdate>;
 }
 
 declare interface TypedEvent {
@@ -277,6 +348,10 @@ export declare interface UnrecoverableStateEvent {
  *
  * @see {@link guide/service-worker-communications Service worker communication guide}
  *
+ * @deprecated
+ * This event is only emitted by the deprecated {@link SwUpdate#activated}.
+ * Use the return value of {@link SwUpdate#activateUpdate} instead.
+ *
  * @publicApi
  */
 export declare interface UpdateActivatedEvent {
@@ -296,6 +371,11 @@ export declare interface UpdateActivatedEvent {
  *
  * @see {@link guide/service-worker-communications Service worker communication guide}
  *
+ * @deprecated
+ * This event is only emitted by the deprecated {@link SwUpdate#available}.
+ * Use the {@link VersionReadyEvent} instead, which is emitted by {@link SwUpdate#versionUpdates}.
+ * See {@link SwUpdate#available} docs for an example.
+ *
  * @publicApi
  */
 export declare interface UpdateAvailableEvent {
@@ -311,27 +391,63 @@ export declare interface UpdateAvailableEvent {
 }
 
 /**
+ * An event emitted when the service worker has detected a new version of the app on the server and
+ * is about to start downloading it.
+ *
+ * @see {@link guide/service-worker-communications Service worker communication guide}
+ *
  * @publicApi
  */
-export declare class ɵangular_packages_service_worker_service_worker_a {
-    private serviceWorker;
-    readonly worker: Observable<ServiceWorker>;
-    readonly registration: Observable<ServiceWorkerRegistration>;
-    readonly events: Observable<TypedEvent>;
-    constructor(serviceWorker: ServiceWorkerContainer | undefined);
-    postMessage(action: string, payload: Object): Promise<void>;
-    postMessageWithStatus(type: string, payload: Object, nonce: number): Promise<void>;
-    generateNonce(): number;
-    eventsOfType<T extends TypedEvent>(type: T['type']): Observable<T>;
-    nextEventOfType<T extends TypedEvent>(type: T['type']): Observable<T>;
-    waitForStatus(nonce: number): Promise<void>;
-    get isEnabled(): boolean;
+export declare interface VersionDetectedEvent {
+    type: 'VERSION_DETECTED';
+    version: {
+        hash: string;
+        appData?: object;
+    };
 }
 
-export declare const ɵangular_packages_service_worker_service_worker_b: InjectionToken<string>;
+/**
+ * A union of all event types that can be emitted by
+ * {@link api/service-worker/SwUpdate#versionUpdates SwUpdate#versionUpdates}.
+ *
+ * @publicApi
+ */
+export declare type VersionEvent = VersionDetectedEvent | VersionInstallationFailedEvent | VersionReadyEvent;
 
-export declare function ɵangular_packages_service_worker_service_worker_c(injector: Injector, script: string, options: SwRegistrationOptions, platformId: string): Function;
+/**
+ * An event emitted when the installation of a new version failed.
+ * It may be used for logging/monitoring purposes.
+ *
+ * @see {@link guide/service-worker-communications Service worker communication guide}
+ *
+ * @publicApi
+ */
+export declare interface VersionInstallationFailedEvent {
+    type: 'VERSION_INSTALLATION_FAILED';
+    version: {
+        hash: string;
+        appData?: object;
+    };
+    error: string;
+}
 
-export declare function ɵangular_packages_service_worker_service_worker_d(opts: SwRegistrationOptions, platformId: string): ɵangular_packages_service_worker_service_worker_a;
+/**
+ * An event emitted when a new version of the app is available.
+ *
+ * @see {@link guide/service-worker-communications Service worker communication guide}
+ *
+ * @publicApi
+ */
+export declare interface VersionReadyEvent {
+    type: 'VERSION_READY';
+    currentVersion: {
+        hash: string;
+        appData?: object;
+    };
+    latestVersion: {
+        hash: string;
+        appData?: object;
+    };
+}
 
 export { }