jg-sw

import { canInstallApp } from 'jg-sw';

installButton.hidden = !canInstallApp();

import { getServiceWorkerSnapshot, subscribeToServiceWorker } from 'jg-sw';

const { hasWaitingWorker, installation } = useSyncExternalStore(
  subscribeToServiceWorker,
  getServiceWorkerSnapshot,
  getServiceWorkerSnapshot,
);

import { installApp } from 'jg-sw';

installButton.addEventListener('click', async () => {
  const outcome = await installApp(); // 'accepted' or 'dismissed'
});

import { isIosBrowserTab } from 'jg-sw';

homeScreenHint.hidden = !isIosBrowserTab();

import { hasErrorCode } from 'jg-exception';
import { ERRORS, registerServiceWorker } from 'jg-sw';

const { registration, registrationError } = await registerServiceWorker();
if (hasErrorCode(registrationError, ERRORS.SW_NO_BROWSER_SUPPORT)) {
  // the browser has no service workers
}

import { getServiceWorkerSnapshot, subscribeToServiceWorker } from 'jg-sw';

const unsubscribe = subscribeToServiceWorker(() => {
  if (getServiceWorkerSnapshot().hasWaitingWorker) {
    showUpdateBanner();
  }
});

import { getServiceWorkerSnapshot, updateApp } from 'jg-sw';

if (getServiceWorkerSnapshot().hasWaitingWorker) {
  updateButton.addEventListener('click', () => updateApp());
}

const DEFAULT_SERVICE_WORKER_PATH: "/sw.js"

const DEFAULT_SERVICE_WORKER_SCOPE: "/"

const ERRORS: { SW_NO_BROWSER_SUPPORT: "SW_NO_BROWSER_SUPPORT"; EMPTY_SW_REGISTRATION: "EMPTY_SW_REGISTRATION"; SW_REGISTRATION_FAILED: "SW_REGISTRATION_FAILED"; NO_APP_INSTALLER: "NO_APP_INSTALLER"; UNKNOWN_INSTALLATION_PROMPT_ERROR: "UNKNOWN_INSTALLATION_PROMPT_ERROR" }

const REGISTRATION_DURATION_SECONDS: 5

const SKIP_WAITING_MESSAGE_TYPE: "JG_SW_SKIP_WAITING"

const UPDATE_INSTALL_TIMEOUT_SECONDS: 30

interface IBeforeInstallPromptEvent extends Event {
    readonly platforms: string[];
    readonly userChoice: Promise<IUserChoice>;
    prompt(): Promise<void>;
}

type IAppInstallationState = {
    canInstall: boolean;
    isAppInstalled: boolean | undefined;
    isRunningInstalledApp: boolean;
    promptOutcome: IInstallationPromptOutcome | undefined;
};

type IInstallationPromptOutcome = 'accepted' | 'dismissed';

type IRegisterServiceWorkerOptions = {
    path?: string;
    options?: RegistrationOptions;
    debugMode?: boolean;
};

type IServiceWorkerSnapshot = {
    registration: ServiceWorkerRegistration | undefined;
    worker: ServiceWorker | undefined;
    registrationError: Exception | undefined;
    hasWaitingWorker: boolean;
    preloadErrorDetected: boolean;
    installation: IAppInstallationState;
};

type IUserChoice = {
    outcome: IInstallationPromptOutcome;
    platform: string;
};

import { buildServiceWorker } from 'jg-sw/build';

const source = await buildServiceWorker(
  {
    outDir: 'dist',
    cacheNamePrefix: 'my-app',
    template: 'base',
    includeToPrecache: ['/', '/assets'],
    excludeFilesFromPrecache: [],
    excludeMIMETypesFromCache: ['application/json'],
  },
  { caching: true },
);

import { readServiceWorkerConfig } from 'jg-sw/build';

const config = await readServiceWorkerConfig('jg-sw.config.json');
config.template; // 'base'

// vite.config.ts
import { defineConfig } from 'vite';
import { serviceWorkerPlugin } from 'jg-sw/build';

export default defineConfig({
  plugins: [serviceWorkerPlugin({ config: 'jg-sw.config.json', environment: 'production' })],
});

import { readServiceWorkerConfig, writeServiceWorker } from 'jg-sw/build';

const config = await readServiceWorkerConfig('jg-sw.config.json');
await writeServiceWorker(config, { environment: 'production' }); // '/app/dist/sw.js'

const ERRORS: { INVALID_TEMPLATE_NAME: "INVALID_TEMPLATE_NAME"; NOT_A_PATH_ELEMENT: "NOT_A_PATH_ELEMENT"; FAILED_TO_READ_BASE_CONFIG: "FAILED_TO_READ_BASE_CONFIG"; INVALID_FIREBASE_CONFIG: "INVALID_FIREBASE_CONFIG"; INVALID_ENVIRONMENT: "INVALID_ENVIRONMENT"; FAILED_TO_BUILD_CONFIG: "FAILED_TO_BUILD_CONFIG"; FAILED_TO_READ_FIREBASE_CONFIG: "FAILED_TO_READ_FIREBASE_CONFIG"; INVALID_FIREBASE_SDK_VERSION: "INVALID_FIREBASE_SDK_VERSION"; NAVIGATION_FALLBACK_NOT_PRECACHED: "NAVIGATION_FALLBACK_NOT_PRECACHED" }

const ServiceWorkerConfigSchema: ZodDiscriminatedUnion<[ZodObject<{ outDir: ZodString; cacheNamePrefix: ZodString; includeToPrecache: ZodArray<ZodString>; excludeFilesFromPrecache: ZodArray<ZodString>; excludeMIMETypesFromCache: ZodArray<ZodString>; navigationFallback: ZodOptional<ZodString>; template: ZodLiteral<"base"> }, $strict>, ZodObject<{ outDir: ZodString; cacheNamePrefix: ZodString; includeToPrecache: ZodArray<ZodString>; excludeFilesFromPrecache: ZodArray<ZodString>; excludeMIMETypesFromCache: ZodArray<ZodString>; navigationFallback: ZodOptional<ZodString>; template: ZodLiteral<"firebase-fcm">; firebaseConfigProcessEnvKey: ZodString; firebaseSdkVersion: ZodString }, $strict>], "template">

import { ServiceWorkerConfigSchema } from 'jg-sw/build';

const config = ServiceWorkerConfigSchema.parse({
  outDir: 'dist',
  cacheNamePrefix: 'my-app',
  template: 'base',
  includeToPrecache: ['/', '/index.html', '/assets'],
  excludeFilesFromPrecache: [],
  excludeMIMETypesFromCache: ['application/json'],
});

type IBuildServiceWorkerOptions = {
    environment?: 'development' | 'staging' | 'production';
    caching?: boolean;
    cwd?: string;
};

type IServiceWorkerConfig = z.infer<typeof ServiceWorkerConfigSchema>;