@budarin/base-service-worker

Базовый pluggable service worker для веб-приложений, основанный на @budarin/pluggable-serviceworker.

( в процессе разработки )

Функциональность

• Кеширование ресурсов - автоматическое кеширование ассетов приложения
• Статус мониторинг - эндпоинт для проверки состояния service worker
• Обмен сообщениями - JSON-RPC коммуникация между главным потоком и worker
• Оффлайн поддержка - обслуживание кешированного контента без сети
• Утилиты клиента - хелперы для регистрации и взаимодействия с SW

Требования

Сервисворкер ожидает, что кешируемые файлы в папке /assets/ содержат хэш в имени файла для корректного управления версиями и кешированием.

Установка

npm install @budarin/base-service-worker

Использование

В service worker:

import { initializeServiceWorker } from '@budarin/base-service-worker';

initializeServiceWorker([], {
    version: '1.0.0',
    assets: ['/app.js', '/app.css', '/manifest.json'],
    logger: console,
    offlineIndex: {
        name: 'index.html',
        headers: {
            'X-Served-By': 'ServiceWorker',
        },
    },
});

API

Основные функции

• initializeServiceWorker(plugins, options) - инициализация service worker с плагинами

Утилиты клиента

• registerDevSw(path) - регистрация service worker для разработки
• checkForNewServiceWorker() - проверка обновлений service worker
• postMessageToSw(logger, message) - отправка сообщений в SW Сообщения отправляются в service worker как объект с обязательным строковым полем type:

  {
      type: string;
  }

• logStorageEstimateInfo() - логирование информации о хранилище
• askBrowserToPersistData() - запрос на постоянное хранение данных

Утилиты для кеша

• openCache(name) - открытие кеша
• matchCache(request, options) - поиск в кеше
• putCache(request, response) - сохранение в кеш
• clearOldCaches(currentCaches) - очистка старых кешей
• cacheKeys - ключи кешей

JSON-RPC ответы

• createJsonRpcSuccessResponse(id, result) - успешный ответ
• createJsonRpcErrorResponse(id, error) - ошибка

Константы и сообщения

• SW_INSTALLED, SW_INSTALLING, SW_START_INSTALLING - статусы SW
• PAGE_RELOAD, SKIP_WAITING - команды
• askClientsToReload() - перезагрузка клиентов
• sendMerssageToClients(message) - отправка сообщений клиентам

Лицензия

ISC