@unplugin-pwa/core 0.0.0 → 0.0.2

package/info.d.ts

@@ -0,0 +1,71 @@
+declare module 'virtual:pwa-info' {
+  export interface PwaInfo {
+    pwaInDevEnvironment: boolean
+    /**
+     * The web manifest will be always here.
+     */
+    webManifest: {
+      href: string
+      useCredentials: boolean
+      /**
+       * The link tag with or without `crossorigin`:
+       * - `<link rel="manifest" href="<webManifestUrl>" />`.
+       * - `<link rel="manifest" href="<webManifestUrl>" crossorigin="use-credentials" />`.
+       */
+      linkTag: string
+    }
+    /**
+     * The service worker data will be exposed only if required, that's, will **NOT** be exposed if:
+     * - not using `pwaPluginOptions.injectRegister` with `script`, `script-defer` or `inline` values
+     * - if using `pwaPluginOptions.injectRegister` with `auto` (default) and importing any of the virtual modules
+     *
+     * **NOTE**: `registerSW` will be `undefined` if:
+     * - SSR build (only if required)
+     * - PWA is disabled: `pwaPluginOptions.disable = true`
+     * - running `Dev Server` and `pwaPluginOptions.devOptions.enabled = false` (default).
+     */
+    registerSW?: {
+      /**
+       * Should use `type="module"?
+       *
+       * **NOTE**: `module` will be `true` **ONLY** at `Dev server` and using dual service worker workers: `classic-and-module`.
+       */
+      module: boolean
+      /**
+       * When this flag is `inline` the service worker must be registered via inline script otherwise registered via script with src attribute `registerSW.js`.
+       */
+      mode: 'inline' | 'script' | 'script-defer'
+      /**
+       * The path for the inline script: will contain the service worker url.
+       */
+      inlinePath: string
+      /**
+       * The path for the src script for `registerSW.js`.
+       */
+      registerPath: string
+      /**
+       * The scope for the service worker: only required for `inline: true`.
+       */
+      scope: string
+      /**
+       * The type for the service worker: only required for `inline: true`.
+       */
+      type: 'classic' | 'module'
+      /**
+       * The script tag if `shouldRegisterSW` returns `true`.
+       */
+      scriptTag?: string
+    }
+  }
+  /**
+   * Return the PWA information if available.
+   *
+   * This property will be `undefined` if:
+   * - SSR build
+   * - PWA is disabled: `pwaPluginOptions.disable = true`
+   * - running `Dev Server` and `pwaPluginOptions.devOptions.enabled = false` (default).
+   *
+   * @returns The PWA information.
+   */
+  export const pwaInfo: PwaInfo | undefined
+}

package/package.json

@@ -1,13 +1,14 @@
 {
   "name": "@unplugin-pwa/core",
-  "version": "0.0.0",
-  "main": "index.js",
+  "type": "module",
+  "version": "0.0.2",
   "description": "PWA bundler-agnostic core logic and utilities",
-  "publishConfig": {
-    "access": "public"
-  },
   "author": "Vite PWA's Team",
+  "maintainers": [
+    "userquin <userquin@gmail.com>"
+  ],
   "license": "MIT",
+  "funding": "https://github.com/sponsors/antfu",
   "homepage": "https://github.com/vite-pwa/unplugin-pwa#readme",
   "repository": {
     "type": "git",
@@ -25,5 +26,130 @@
     "agnostic",
     "configuration",
     "helpers"
-  ]
-}
+  ],
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.mts"
+    },
+    "./additional-manifest-entries": "./dist/additional-manifest-entries.mjs",
+    "./build-pwa-asset": "./dist/build-pwa-asset.mjs",
+    "./config": "./dist/config.mjs",
+    "./constants": "./dist/constants.mjs",
+    "./context": "./dist/context.mjs",
+    "./context-types": {
+      "types": "./dist/context-types.d.mts"
+    },
+    "./create-generate-register-sw-script": "./dist/create-generate-register-sw-script.mjs",
+    "./create-web-manifest-html-link": "./dist/create-web-manifest-html-link.mjs",
+    "./dual-sw-utilities": "./dist/dual-sw-utilities.mjs",
+    "./generate-register-sw": "./dist/generate-register-sw.mjs",
+    "./generate-web-manifest": "./dist/generate-web-manifest.mjs",
+    "./html": "./dist/html.mjs",
+    "./helpers": "./dist/helpers.mjs",
+    "./inject-generate-register-sw": "./dist/inject-generate-register-sw.mjs",
+    "./inject-web-manifest-html-link": "./dist/inject-web-manifest-html-link.mjs",
+    "./inspector-utils": "./dist/inspector-utils.mjs",
+    "./logs": "./dist/logs.mjs",
+    "./prepare-pwa-context": "./dist/prepare-pwa-context.mjs",
+    "./prepare-sw-names": "./dist/prepare-sw-names.mjs",
+    "./resolve-inspector-dist": "./dist/resolve-inspector-dist.mjs",
+    "./dev/prepare-sw-names-and-glob-directory": "./dist/dev/prepare-sw-names-and-glob-directory.mjs",
+    "./dev/prepare-temp-folder": "./dist/dev/prepare-temp-folder.mjs",
+    "./pwa-assets/build": "./dist/pwa-assets/build.mjs",
+    "./pwa-assets/config": "./dist/pwa-assets/config.mjs",
+    "./pwa-assets/dev": "./dist/pwa-assets/dev.mjs",
+    "./pwa-assets/generator": "./dist/pwa-assets/generator.mjs",
+    "./pwa-assets/html": "./dist/pwa-assets/html.mjs",
+    "./pwa-assets/manifest": "./dist/pwa-assets/manifest.mjs",
+    "./pwa-assets/options": "./dist/pwa-assets/options.mjs",
+    "./pwa-assets/types": {
+      "types": "./dist/pwa-assets/types.d.mts"
+    },
+    "./pwa-assets/utils": "./dist/pwa-assets/utils.mjs",
+    "./types": {
+      "types": "./types/index.d.ts"
+    },
+    "./preact": {
+      "types": "./preact.d.ts"
+    },
+    "./react": {
+      "types": "./react.d.ts"
+    },
+    "./react-legacy": {
+      "types": "./react-legacy.d.ts"
+    },
+    "./solid": {
+      "types": "./solid.d.ts"
+    },
+    "./svelte": {
+      "types": "./svelte.d.ts"
+    },
+    "./vanillajs": {
+      "types": "./vanillajs.d.ts"
+    },
+    "./vue": {
+      "types": "./vue.d.ts"
+    },
+    "./client": {
+      "types": "./client.d.ts"
+    },
+    "./info": {
+      "types": "./info.d.ts"
+    },
+    "./pwa-assets": {
+      "types": "./pwa-assets.d.ts"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "*.d.ts",
+    "dist",
+    "types"
+  ],
+  "engines": {
+    "node": ">=22.14.0"
+  },
+  "peerDependencies": {
+    "@vite-pwa/assets-generator": "^1.0.0 || ^2.0.0",
+    "rolldown": "^1.0.0-0",
+    "vite": "^3.1.0 || ^4.0.0 || ^5.0.0 || ^6.0.0 || ^7.0.0 || ^8.0.0"
+  },
+  "peerDependenciesMeta": {
+    "@vite-pwa/assets-generator": {
+      "optional": true
+    },
+    "rolldown": {
+      "optional": true
+    },
+    "vite": {
+      "optional": true
+    }
+  },
+  "dependencies": {
+    "@vite-pwa/workbox-build": "^8.0.13",
+    "hookable": "^6.1.2"
+  },
+  "devDependencies": {
+    "@types/react": "^19.3.0",
+    "@vite-pwa/assets-generator": "^2.0.0",
+    "preact": "^10.29.8",
+    "react": "^19.3.1",
+    "rolldown": "^1.2.14",
+    "solid-js": "^1.9.17",
+    "svelte": "^5.57.2",
+    "vite": "^8.3.5",
+    "vue": "^3.5.44"
+  },
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
+  "scripts": {
+    "build": "tsdown --config-loader unrun",
+    "test:typecheck": "tsc --noEmit",
+    "test:ci": "vitest run --coverage",
+    "test": "vitest",
+    "test:ui": "vitest --ui --open --coverage"
+  }
+}

package/preact.d.ts

@@ -0,0 +1,17 @@
+declare module 'virtual:pwa-register/preact' {
+  import type { PWATrustedScriptURL, RegisterSWOptions } from '@unplugin-pwa/core/types'
+  // eslint-disable-next-line ts/ban-ts-comment
+  // @ts-ignore ignore when preact/hooks is not installed
+  import type { Dispatch, StateUpdater } from 'preact/hooks'
+
+  export type { PWATrustedScriptURL, RegisterSWOptions }
+
+  export function useRegisterSW(options?: RegisterSWOptions): {
+    needRefresh: [boolean, Dispatch<StateUpdater<boolean>>]
+    offlineReady: [boolean, Dispatch<StateUpdater<boolean>>]
+    /**
+     * Reloads the current window to allow the service worker take the control.
+     */
+    updateServiceWorker: () => Promise<void>
+  }
+}

package/pwa-assets.d.ts

@@ -0,0 +1,40 @@
+/* WARNING: these virtual modules are meant to be used by integrations and not being consumed directly from applications */
+
+declare module 'virtual:pwa-assets/head' {
+  export interface PWAAssetHeadLink {
+    id?: string
+    rel: 'apple-touch-startup-image' | 'apple-touch-icon' | 'icon'
+    href: string
+    media?: string
+    sizes?: string
+    type?: string
+  }
+
+  export interface ColorSchemeMeta {
+    name: string
+    content: string
+  }
+
+  export interface PWAAssetsHead {
+    links: PWAAssetHeadLink[]
+    themeColor?: ColorSchemeMeta
+  }
+
+  export const pwaAssetsHead: PWAAssetsHead
+}
+
+declare module 'virtual:pwa-assets/icons' {
+  import type { AppleSplashScreenLink, FaviconLink, HtmlLink, IconAsset } from '@vite-pwa/assets-generator/api'
+
+  export type PWAAssetIcon<T extends HtmlLink> = Omit<IconAsset<T>, 'buffer'>
+
+  export interface PWAAssetsIcons {
+    favicon: Record<string, PWAAssetIcon<FaviconLink>>
+    transparent: Record<string, PWAAssetIcon<HtmlLink>>
+    maskable: Record<string, PWAAssetIcon<HtmlLink>>
+    apple: Record<string, PWAAssetIcon<HtmlLink>>
+    appleSplashScreen: Record<string, PWAAssetIcon<AppleSplashScreenLink>>
+  }
+
+  export const pwaAssetsIcons: PWAAssetsIcons
+}

package/react-legacy.d.ts

@@ -0,0 +1,22 @@
+/**
+ * This module is a legacy version of the PWA register hook for React and will
+ * be removed in the next major version.
+ * @deprecated use `virtual:pwa-register/react` instead
+ */
+declare module 'virtual:pwa-register/react-legacy' {
+  import type { PWATrustedScriptURL, RegisterSWOptions } from '@unplugin-pwa/core/types'
+  // eslint-disable-next-line ts/ban-ts-comment
+  // @ts-ignore ignore when react is not installed
+  import type { Dispatch, SetStateAction } from 'react'
+
+  export type { PWATrustedScriptURL, RegisterSWOptions }
+
+  export function useRegisterSW(options?: RegisterSWOptions): {
+    needRefresh: [boolean, Dispatch<SetStateAction<boolean>>]
+    offlineReady: [boolean, Dispatch<SetStateAction<boolean>>]
+    /**
+     * Reloads the current window to allow the service worker take the control.
+     */
+    updateServiceWorker: () => Promise<void>
+  }
+}

package/react.d.ts

@@ -0,0 +1,17 @@
+declare module 'virtual:pwa-register/react' {
+  import type { PWATrustedScriptURL, RegisterSWOptions } from '@unplugin-pwa/core/types'
+  // eslint-disable-next-line ts/ban-ts-comment
+  // @ts-ignore ignore when react is not installed
+  import type { Dispatch, SetStateAction } from 'react'
+
+  export type { PWATrustedScriptURL, RegisterSWOptions }
+
+  export function useRegisterSW(options?: RegisterSWOptions): {
+    needRefresh: [boolean, Dispatch<SetStateAction<boolean>>]
+    offlineReady: [boolean, Dispatch<SetStateAction<boolean>>]
+    /**
+     * Reloads the current window to allow the service worker take the control.
+     */
+    updateServiceWorker: () => Promise<void>
+  }
+}

package/solid.d.ts

@@ -0,0 +1,17 @@
+declare module 'virtual:pwa-register/solid' {
+  import type { PWATrustedScriptURL, RegisterSWOptions } from '@unplugin-pwa/core/types'
+  // eslint-disable-next-line ts/ban-ts-comment
+  // @ts-ignore ignore when solid-js is not installed
+  import type { Accessor, Setter } from 'solid-js'
+
+  export type { PWATrustedScriptURL, RegisterSWOptions }
+
+  export function useRegisterSW(options?: RegisterSWOptions): {
+    needRefresh: [Accessor<boolean>, Setter<boolean>]
+    offlineReady: [Accessor<boolean>, Setter<boolean>]
+    /**
+     * Reloads the current window to allow the service worker take the control.
+     */
+    updateServiceWorker: () => Promise<void>
+  }
+}

package/svelte.d.ts

@@ -0,0 +1,17 @@
+declare module 'virtual:pwa-register/svelte' {
+  import type { PWATrustedScriptURL, RegisterSWOptions } from '@unplugin-pwa/core/types'
+  // eslint-disable-next-line ts/ban-ts-comment
+  // @ts-ignore ignore when svelte is not installed
+  import type { Writable } from 'svelte/store'
+
+  export type { PWATrustedScriptURL, RegisterSWOptions }
+
+  export function useRegisterSW(options?: RegisterSWOptions): {
+    needRefresh: Writable<boolean>
+    offlineReady: Writable<boolean>
+    /**
+     * Reloads the current window to allow the service worker take the control.
+     */
+    updateServiceWorker: () => Promise<void>
+  }
+}

package/types/index.d.ts

@@ -0,0 +1,43 @@
+import type { TrustedScriptURL } from 'trusted-types/lib'
+
+export type { TrustedScriptURL } from 'trusted-types/lib'
+
+/**
+ * A function that returns the service worker trusted script url.
+ *
+ * @param classic Whether the browser is in legacy mode (i.e. not supporting ES modules in service workers).
+ * @param swUrl The url for the service worker.
+ * @returns The service worker script url.
+ */
+export type PWATrustedScriptURL = (classic: boolean, swUrl: string) => TrustedScriptURL
+
+export interface RegisterSWOptions {
+  immediate?: boolean
+  /**
+   * Called when the service worker has taken control and the page would normally reload.
+   *
+   * Useful to fully control the reload flow (for example, to defer reload until the next
+   * SPA navigation).
+   */
+  onNeedReload?: () => void
+  onNeedRefresh?: () => void
+  onOfflineReady?: () => void
+  /**
+   * Service worker trusted script url.
+   *
+   * @since 2.0.0
+   */
+  trustedScriptUrl?: TrustedScriptURL | PWATrustedScriptURL
+  /**
+   * Called once the service worker is registered (requires version `0.12.8+`).
+   *
+   * @param swScriptUrl The service worker script url.
+   * @param registration The service worker registration if available.
+   */
+  onRegisteredSW?: (swScriptUrl: string, registration: ServiceWorkerRegistration | undefined) => void
+  onRegisterError?: (error: unknown) => void
+  /**
+   * @see https://developer.mozilla.org/en-US/docs/Web/API/ServiceWorkerRegistration/updateViaCache
+   */
+  updateViaCache?: ServiceWorkerUpdateViaCache
+}

package/types/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "module"
+}

package/vanillajs.d.ts

@@ -0,0 +1,13 @@
+declare module 'virtual:pwa-register' {
+  import type { PWATrustedScriptURL, RegisterSWOptions } from '@unplugin-pwa/core/types'
+
+  export type { PWATrustedScriptURL, RegisterSWOptions }
+
+  /**
+   * Registers the service worker returning a callback to reload the current page when an update is found.
+   *
+   * @param options the options to register the service worker.
+   * @return The callback to activate the new service worker.
+   */
+  export function registerSW(options?: RegisterSWOptions): () => Promise<void>
+}

package/vue.d.ts

@@ -0,0 +1,17 @@
+declare module 'virtual:pwa-register/vue' {
+  import type { PWATrustedScriptURL, RegisterSWOptions, TrustedScriptURL } from '@unplugin-pwa/core/types'
+  // eslint-disable-next-line ts/ban-ts-comment
+  // @ts-ignore ignore when vue is not installed
+  import type { Ref } from 'vue'
+
+  export type { PWATrustedScriptURL, RegisterSWOptions, TrustedScriptURL }
+
+  export function useRegisterSW(options?: RegisterSWOptions): {
+    needRefresh: Ref<boolean>
+    offlineReady: Ref<boolean>
+    /**
+     * Reloads the current window to allow the service worker take the control.
+     */
+    updateServiceWorker: () => Promise<void>
+  }
+}

package/index.js

@@ -1 +0,0 @@
-module.exports = {};