webapp-astro-pwa/src/types.ts

A ready-to-use Astro component library for adding Progressive Web App (PWA) support to your Astro projects. This package provides drop-in components and utilities for manifest injection, service worker registration, install prompts, and more. Fully suppor

export interface BeforeInstallPromptEvent extends Event {
  prompt: () => Promise<void>;
  userChoice?: Promise<{ outcome: "accepted" | "dismissed"; platform?: string }>;
}
export type PWAOptions = {
  isManifest?: boolean;
  isInstallBtnVisible?: boolean;
};
export type PWAInstallPromptType = {
  btnId: string;
  installPrompt: BeforeInstallPromptEvent | null;
  btn: HTMLElement | null;

  checkIsPWAInstalled(): boolean;
  installPWABtnHandler(): Promise<void>;
  beforeInstallHandler(event: Event, btn: HTMLElement): void;
  runEvents(isPopup: boolean, popup?: HTMLElement): void;
};

export type IMetaItem = {
  name: string;
  content: string;
};

export type IIconItem = {
  rel: string;
  type: string;
  sizes: string;
  href: string;
};

export type IPWAOptions = {
  isManifest: boolean;
  isInstallBtnVisible: boolean;
  strategy: "NetworkFirst" | "StaleWhileRevalidate" | "CacheFirst";
  meta: IMetaItem[];
  icons: IIconItem[];
};

export type PWAMeta = {
  name: string;
  content: string;
};

export type PWAIcon = {
  rel: string;
  type: string;
  sizes: string;
  href: string;
};

export type Config =
  | {
      saveSubscriptionPath?: string;
      applicationServerKey?: string;
      notification?: boolean;
      forceUpdate?: boolean;
      scripts?: string[];
      isSetupPageEnabled?: boolean;
      createManifest?: boolean;
      cacheAssets?: string;
      disableDevLogs?: boolean;
      isManifest?: boolean;
      manifestPath?: string;
      isInstallBtnVisible?: boolean;
      strategy?: string;
      meta?: PWAMeta[];
      icons?: PWAIcon[];
      manifest?: object;
    }
  | undefined;