@serwist/window 9.5.6 → 9.5.8

package/dist/chunks/isCurrentPageOutOfScope-vi3IAsNY.js

@@ -0,0 +1,10 @@
+//#region src/utils/isCurrentPageOutOfScope.ts
+const isCurrentPageOutOfScope = (scope) => {
+	const scopeURL = new URL(scope, document.baseURI);
+	const scopeURLBasePath = new URL("./", scopeURL.href).pathname;
+	return !location.pathname.startsWith(scopeURLBasePath);
+};
+//#endregion
+export { isCurrentPageOutOfScope as t };
+
+//# sourceMappingURL=isCurrentPageOutOfScope-vi3IAsNY.js.map

package/dist/chunks/isCurrentPageOutOfScope-vi3IAsNY.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"isCurrentPageOutOfScope-vi3IAsNY.js","names":[],"sources":["../../src/utils/isCurrentPageOutOfScope.ts"],"sourcesContent":["export const isCurrentPageOutOfScope = (scope: string) => {\n  const scopeURL = new URL(scope, document.baseURI);\n  const scopeURLBasePath = new URL(\"./\", scopeURL.href).pathname;\n  return !location.pathname.startsWith(scopeURLBasePath);\n};\n"],"mappings":";AAAA,MAAa,2BAA2B,UAAkB;CACxD,MAAM,WAAW,IAAI,IAAI,OAAO,SAAS,QAAQ;CACjD,MAAM,mBAAmB,IAAI,IAAI,MAAM,SAAS,KAAK,CAAC;AACtD,QAAO,CAAC,SAAS,SAAS,WAAW,iBAAiB"}

package/dist/index.d.mts

@@ -0,0 +1,246 @@
+//#region src/messageSW.d.ts
+/**
+ * Sends a data object to a service worker via `postMessage` and resolves with
+ * a response (if any).
+ *
+ * A response can be sent by calling `event.ports[0].postMessage(...)`, which will
+ * resolve the promise returned by `messageSW()`. If no response is sent, the promise
+ * will never resolve.
+ *
+ * @param sw The service worker to send the message to.
+ * @param data An object to send to the service worker.
+ * @returns
+ */
+declare const messageSW: (sw: ServiceWorker, data: any) => Promise<any>;
+//#endregion
+//#region src/utils/SerwistEvent.d.ts
+/**
+ * A minimal `Event` subclass shim.
+ * This doesn't *actually* subclass `Event` because not all browsers support
+ * constructable `EventTarget`, and using a real `Event` will error.
+ * @private
+ */
+declare class SerwistEvent<K extends keyof SerwistEventMap> {
+  type: K;
+  target?: SerwistEventTarget;
+  sw?: ServiceWorker;
+  originalEvent?: Event;
+  isExternal?: boolean;
+  constructor(type: K, props: Omit<SerwistEventMap[K], "target" | "type">);
+}
+interface SerwistMessageEvent extends SerwistEvent<"message"> {
+  data: any;
+  originalEvent: Event;
+  ports: readonly MessagePort[];
+}
+interface SerwistLifecycleEvent extends SerwistEvent<keyof SerwistLifecycleEventMap> {
+  isUpdate?: boolean;
+}
+interface SerwistLifecycleWaitingEvent extends SerwistLifecycleEvent {
+  wasWaitingBeforeRegister?: boolean;
+}
+interface SerwistLifecycleEventMap {
+  installing: SerwistLifecycleEvent;
+  installed: SerwistLifecycleEvent;
+  waiting: SerwistLifecycleWaitingEvent;
+  activating: SerwistLifecycleEvent;
+  activated: SerwistLifecycleEvent;
+  controlling: SerwistLifecycleEvent;
+  redundant: SerwistLifecycleEvent;
+}
+interface SerwistEventMap extends SerwistLifecycleEventMap {
+  message: SerwistMessageEvent;
+}
+//#endregion
+//#region src/utils/SerwistEventTarget.d.ts
+/**
+ * A minimal `EventTarget` shim.
+ * This is necessary because not all browsers support constructable
+ * `EventTarget`, so using a real `EventTarget` will error.
+ * @private
+ */
+declare class SerwistEventTarget {
+  private readonly _eventListenerRegistry;
+  /**
+   * @param type
+   * @param listener
+   * @private
+   */
+  addEventListener<K extends keyof SerwistEventMap>(type: K, listener: (event: SerwistEventMap[K]) => any): void;
+  /**
+   * @param type
+   * @param listener
+   * @private
+   */
+  removeEventListener<K extends keyof SerwistEventMap>(type: K, listener: (event: SerwistEventMap[K]) => any): void;
+  /**
+   * @param event
+   * @private
+   */
+  dispatchEvent(event: SerwistEvent<any>): void;
+  /**
+   * Returns a Set of listeners associated with the passed event type.
+   * If no handlers have been registered, an empty Set is returned.
+   *
+   * @param type The event type.
+   * @returns An array of handler functions.
+   * @private
+   */
+  private _getEventListenersByType;
+}
+//#endregion
+//#region src/Serwist.d.ts
+/**
+ * A class to aid in handling service worker registration, updates, and
+ * reacting to service worker lifecycle events.
+ *
+ * @fires `@serwist/window.Serwist.message`
+ * @fires `@serwist/window.Serwist.installed`
+ * @fires `@serwist/window.Serwist.waiting`
+ * @fires `@serwist/window.Serwist.controlling`
+ * @fires `@serwist/window.Serwist.activated`
+ * @fires `@serwist/window.Serwist.redundant`
+ */
+declare class Serwist extends SerwistEventTarget {
+  private readonly _scriptURL;
+  private readonly _registerOptions;
+  private _updateFoundCount;
+  private readonly _swDeferred;
+  private readonly _activeDeferred;
+  private readonly _controllingDeferred;
+  private _registrationTime;
+  private _isUpdate?;
+  private _compatibleControllingSW?;
+  private _registration?;
+  private _sw?;
+  private readonly _ownSWs;
+  private _externalSW?;
+  private _waitingTimeout?;
+  /**
+   * Creates a new Serwist instance with a script URL and service worker
+   * options. The script URL and options are the same as those used when
+   * calling [navigator.serviceWorker.register(scriptURL, options)](https://developer.mozilla.org/en-US/docs/Web/API/ServiceWorkerContainer/register).
+   *
+   * @param scriptURL The service worker script associated with this instance. Using a
+   * [`TrustedScriptURL`](https://developer.mozilla.org/en-US/docs/Web/API/TrustedScriptURL) is supported.
+   * @param registerOptions The service worker options associated with this instance.
+   */
+  constructor(scriptURL: string | TrustedScriptURL, registerOptions?: RegistrationOptions);
+  /**
+   * Registers a service worker for this instances script URL and service
+   * worker options. By default this method delays registration until after
+   * the window has loaded.
+   *
+   * @param options
+   */
+  register({
+    immediate
+  }?: {
+    /**
+     * Setting this to true will register the service worker immediately,
+     * even if the window has not loaded (not recommended).
+     */
+    immediate?: boolean;
+  }): Promise<ServiceWorkerRegistration | undefined>;
+  /**
+   * Checks for updates of the registered service worker.
+   */
+  update(): Promise<void>;
+  /**
+   * Resolves to the service worker registered by this instance as soon as it
+   * is active. If a service worker was already controlling at registration
+   * time then it will resolve to that if the script URLs (and optionally
+   * script versions) match, otherwise it will wait until an update is found
+   * and activates.
+   *
+   * @returns
+   */
+  get active(): Promise<ServiceWorker>;
+  /**
+   * Resolves to the service worker registered by this instance as soon as it
+   * is controlling the page. If a service worker was already controlling at
+   * registration time then it will resolve to that if the script URLs (and
+   * optionally script versions) match, otherwise it will wait until an update
+   * is found and starts controlling the page.
+   * Note: the first time a service worker is installed it will active but
+   * not start controlling the page unless `clients.claim()` is called in the
+   * service worker.
+   *
+   * @returns
+   */
+  get controlling(): Promise<ServiceWorker>;
+  /**
+   * Resolves with a reference to a service worker that matches the script URL
+   * of this instance, as soon as it's available.
+   *
+   * If, at registration time, there's already an active or waiting service
+   * worker with a matching script URL, it will be used (with the waiting
+   * service worker taking precedence over the active service worker if both
+   * match, since the waiting service worker would have been registered more
+   * recently).
+   * If there's no matching active or waiting service worker at registration
+   * time then the promise will not resolve until an update is found and starts
+   * installing, at which point the installing service worker is used.
+   *
+   * @returns
+   */
+  getSW(): Promise<ServiceWorker>;
+  /**
+   * Sends the passed data object to the service worker registered by this
+   * instance (via `getSW`) and resolves with a response (if any).
+   *
+   * A response can be sent by calling `event.ports[0].postMessage(...)`, which will
+   * resolve the promise returned by `messageSW()`. If no response is sent, the promise
+   * will never resolve.
+   *
+   * @param data An object to send to the service worker
+   * @returns
+   */
+  messageSW(data: any): Promise<any>;
+  /**
+   * Sends a `{ type: "SKIP_WAITING" }` message to the service worker that is
+   * currently waiting and associated with the current registration.
+   *
+   * If there is no current registration, or no service worker is waiting,
+   * calling this will have no effect.
+   */
+  messageSkipWaiting(): void;
+  /**
+   * Checks for a service worker already controlling the page and returns
+   * it if its script URL matches.
+   *
+   * @private
+   * @returns
+   */
+  private _getControllingSWIfCompatible;
+  /**
+   * Registers a service worker for this instances script URL and register
+   * options and tracks the time registration was complete.
+   *
+   * @private
+   */
+  private _registerScript;
+  /**
+   * @private
+   * @param originalEvent
+   */
+  private readonly _onUpdateFound;
+  /**
+   * @private
+   * @param originalEvent
+   */
+  private readonly _onStateChange;
+  /**
+   * @private
+   * @param originalEvent
+   */
+  private readonly _onControllerChange;
+  /**
+   * @private
+   * @param originalEvent
+   */
+  private readonly _onMessage;
+}
+//#endregion
+export { Serwist, SerwistEvent, SerwistEventMap, SerwistLifecycleEvent, SerwistLifecycleEventMap, SerwistLifecycleWaitingEvent, SerwistMessageEvent, messageSW };
+//# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","names":[],"sources":["../src/messageSW.ts","../src/utils/SerwistEvent.ts","../src/utils/SerwistEventTarget.ts","../src/Serwist.ts"],"mappings":";;AAoBA;;;;;;;;;;;cAAa,SAAA,GAAa,EAAA,EAAI,aAAA,EAAe,IAAA,UAAY,OAAA;;;AAAzD;;;;;;AAAA,cCJa,YAAA,iBAA6B,eAAA;EAO/B,IAAA,EAAM,CAAA;EANf,MAAA,GAAS,kBAAA;EACT,EAAA,GAAK,aAAA;EACL,aAAA,GAAgB,KAAA;EAChB,UAAA;cAGS,IAAA,EAAM,CAAA,EACb,KAAA,EAAO,IAAA,CAAK,eAAA,CAAgB,CAAA;AAAA;AAAA,UAMf,mBAAA,SAA4B,YAAA;EAC3C,IAAA;EACA,aAAA,EAAe,KAAA;EACf,KAAA,WAAgB,WAAA;AAAA;AAAA,UAGD,qBAAA,SAA8B,YAAA,OAAmB,wBAAA;EAChE,QAAA;AAAA;AAAA,UAGe,4BAAA,SAAqC,qBAAA;EACpD,wBAAA;AAAA;AAAA,UAGe,wBAAA;EACf,UAAA,EAAY,qBAAA;EACZ,SAAA,EAAW,qBAAA;EACX,OAAA,EAAS,4BAAA;EACT,UAAA,EAAY,qBAAA;EACZ,SAAA,EAAW,qBAAA;EACX,WAAA,EAAa,qBAAA;EACb,SAAA,EAAW,qBAAA;AAAA;AAAA,UAGI,eAAA,SAAwB,wBAAA;EACvC,OAAA,EAAS,mBAAA;AAAA;;;;;;;;;cCrCE,kBAAA;EAAA,iBACM,sBAAA;EFC6C;;;;ACJhE;ECUE,gBAAA,iBAAiC,eAAA,CAAA,CAAiB,IAAA,EAAM,CAAA,EAAG,QAAA,GAAW,KAAA,EAAO,eAAA,CAAgB,CAAA;EDVtE;;;;;ECoBvB,mBAAA,iBAAoC,eAAA,CAAA,CAAiB,IAAA,EAAM,CAAA,EAAG,QAAA,GAAW,KAAA,EAAO,eAAA,CAAgB,CAAA;EDbjF;;;;ECqBf,aAAA,CAAc,KAAA,EAAO,YAAA;EDpBR;;;;;;;;EAAA,QCqCL,wBAAA;AAAA;;;AFzCV;;;;;;;;;;;AAAA,cGqBa,OAAA,SAAgB,kBAAA;EAAA,iBACV,UAAA;EAAA,iBACA,gBAAA;EAAA,QACT,iBAAA;EAAA,iBAGS,WAAA;EAAA,iBACA,eAAA;EAAA,iBACA,oBAAA;EAAA,QAET,iBAAA;EAAA,QACA,SAAA;EAAA,QACA,wBAAA;EAAA,QACA,aAAA;EAAA,QACA,GAAA;EAAA,iBACS,OAAA;EAAA,QACT,WAAA;EAAA,QACA,eAAA;EFlCK;;;;;;;;;cE6CD,SAAA,WAAoB,gBAAA,EAAkB,eAAA,GAAiB,mBAAA;EFlDnD;;;;;;;EEqEV,QAAA,CAAA;IACJ;EAAA;IFjEA;;;AAMJ;IEiEI,SAAA;EAAA,IACO,OAAA,CAAQ,yBAAA;EFhEF;;;EE4JT,MAAA,CAAA,GAAU,OAAA;EF9JuC;;;;;;;;;EAAA,IEmLnD,MAAA,CAAA,GAAU,OAAA,CAAQ,aAAA;EF7Ke;;;;;;;;AAIvC;;;;EAJuC,IE6LjC,WAAA,CAAA,GAAe,OAAA,CAAQ,aAAA;EFrLZ;;;;;;;;;;;;;;;EEwMf,KAAA,CAAA,GAAS,OAAA,CAAQ,aAAA;EFrMjB;;;;;;;;;;;EEuNM,SAAA,CAAU,IAAA,QAAY,OAAA;EFhNb;;;;;;;EE4Nf,kBAAA,CAAA;EF3N4B;;;;ACrC9B;;;EDqC8B,QEwOpB,6BAAA;EDrQgD;;;;;;EAAA,QCmR1C,eAAA;EDjQO;;;;EAAA,iBC2RJ,cAAA;ED7SA;;;;EAAA,iBCyXA,cAAA;EDzX4E;;;;EAAA,iBCod5E,mBAAA;ED1cmB;;;;EAAA,iBCuenB,UAAA;AAAA"}

package/dist/index.internal.d.mts

@@ -0,0 +1,5 @@
+//#region src/utils/isCurrentPageOutOfScope.d.ts
+declare const isCurrentPageOutOfScope: (scope: string) => boolean;
+//#endregion
+export { isCurrentPageOutOfScope };
+//# sourceMappingURL=index.internal.d.mts.map

package/dist/index.internal.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.internal.d.mts","names":[],"sources":["../src/utils/isCurrentPageOutOfScope.ts"],"mappings":";cAAa,uBAAA,GAA2B,KAAA"}

package/dist/index.internal.mjs

@@ -0,0 +1,2 @@
+import { t as isCurrentPageOutOfScope } from "./chunks/isCurrentPageOutOfScope-vi3IAsNY.js";
+export { isCurrentPageOutOfScope };