@budarin/psw-plugin-opfs-serve-range 1.1.4 → 1.1.6

package/README.md

@@ -165,28 +165,19 @@ Client‑side helpers are exported from the entry point `@budarin/psw-plugin-opf
 
 **Message payload**
 
-Every subscription handler receives a `MessageEvent`; `event.data` is `{ type: string } & OpfsMessagePayload`:
-
-- `type` — message type (one of the `OPFS_MSG_*` constants);
-- `url?` — URL of the resource the event refers to (when applicable);
-- `size?` — size in bytes (e.g. file that did not fit);
-- `limit?` — cache limit in bytes (e.g. in WRITE_SKIPPED / CACHE_LIMIT_REACHED);
-- `reason?` — error text (in WRITE_FAILED).
-
-Some events send extra fields (e.g. `count` in EVICTION_COMPLETED).
+Each handler receives a `MessageEvent`; `event.data` is `{ type: string } & OpfsMessagePayload`, and some events add a `count` field. The exact set of fields depends on the message type (see table below). The package type `OpfsMessagePayload` is `{ url?: string; size?: number; limit?: number; reason?: string }`.
 
 **Message subscriptions**
 
-Each function takes one argument — the handler — and returns an unsubscribe function `() => void`. Call it when the subscription is no longer needed.
+Each function takes a handler and returns an unsubscribe function `() => void`. The table lists only subscriptions for messages **that the service worker actually sends** in the current version; the exact `event.data` fields are in the last column.
 
-| Function | Signature | When it runs |
-|----------|-----------|---------------|
-| `onOPFSQuotaExceeded` | `(handler: (event: MessageEvent) => void) => () => void` | Browser threw QuotaExceeded while writing to OPFS. `event.data`: `url`, optionally `size`. |
-| `onOPFSWriteSkipped` | `(handler: (event: MessageEvent) => void) => () => void` | Write not started: file does not fit even after eviction. `event.data`: `url`, `size`, `limit`. |
-| `onOPFSCacheLimitReached` | `(handler: (event: MessageEvent) => void) => () => void` | Cache limit reached, eviction started. `event.data`: `limit`, etc. |
-| `onOPFSEvictionCompleted` | `(handler: (event: MessageEvent) => void) => () => void` | Eviction finished. `event.data`: `count` (number of files removed). |
-| `onOPFSWriteFailed` | `(handler: (event: MessageEvent) => void) => () => void` | Write error (network, disk, partial file removed). `event.data`: `url`, `reason`. |
-| `onOPFSSkipQuotaExceeded` | `(handler: (event: MessageEvent) => void) => () => void` | Repeat request for a blacklisted URL (resource not cached). `event.data`: `url`. |
+| Function | Signature | When it runs | Fields in `event.data` (besides `type`) |
+|----------|-----------|---------------|----------------------------------------|
+| `onOPFSQuotaExceeded` | `(handler: (event: MessageEvent) => void) => () => void` | Browser threw QuotaExceeded while writing to OPFS. | `url: string` |
+| `onOPFSWriteSkipped` | `(handler: (event: MessageEvent) => void) => () => void` | Write not started: file does not fit even after eviction. | `url: string`, `size: number`, `reason: string` |
+| `onOPFSEvictionCompleted` | `(handler: (event: MessageEvent) => void) => () => void` | Eviction finished. | `count: number` (number of files removed) |
+| `onOPFSWriteFailed` | `(handler: (event: MessageEvent) => void) => () => void` | Write error (network, disk, partial file removed). | `url?: string`, `reason: string` |
+| `onOPFSSkipQuotaExceeded` | `(handler: (event: MessageEvent) => void) => () => void` | Repeat request for a blacklisted URL (resource not cached). | `url: string` |
 
 **Cache management and types**
 
@@ -194,7 +185,7 @@ Each function takes one argument — the handler — and returns an unsubscribe
 - `hasInOpfsCache(url: string): Promise<boolean>` — whether the URL is in the cache.
 - `deleteFromOpfsCache(url: string): Promise<void>` — remove resource by URL from the cache.
 
-Types `OpfsMessagePayload` and `OpfsCachedResource` are exported; message type constants are `OPFS_MSG_QUOTA_EXCEEDED`, `OPFS_MSG_WRITE_SKIPPED_SIZE`, etc.
+Types `OpfsMessagePayload` and `OpfsCachedResource` are exported. Message type constants (name equals the string value in `event.data.type`): `OPFS_MSG_QUOTA_EXCEEDED`, `OPFS_MSG_WRITE_SKIPPED_SIZE`, `OPFS_MSG_CACHE_LIMIT_REACHED`, `OPFS_MSG_EVICTION_COMPLETED`, `OPFS_MSG_WRITE_FAILED`, `OPFS_MSG_SKIP_QUOTA_EXCEEDED`.
 
 ### Tab notifications about quota and limits
 

package/README.ru.md

@@ -155,28 +155,19 @@ await writeToOpfs(dir, key, response.body, metadata);
 
 **Данные в сообщениях**
 
-Во всех подписках обработчик получает `MessageEvent`: в `event.data` приходит объект типа `{ type: string } & OpfsMessagePayload`:
-
-- `type` — тип сообщения (константа `OPFS_MSG_*`);
-- `url?` — URL ресурса, к которому относится событие (если применимо);
-- `size?` — размер в байтах (например, размер файла, который не влез);
-- `limit?` — лимит кеша в байтах (например, в WRITE_SKIPPED / CACHE_LIMIT_REACHED);
-- `reason?` — текст ошибки (в WRITE_FAILED).
-
-В части сообщений в `event.data` бывают и другие поля (например, `count` в EVICTION_COMPLETED).
+Обработчик получает `MessageEvent`; `event.data` имеет тип `{ type: string } & OpfsMessagePayload` плюс при необходимости поле `count`. Конкретный набор полей зависит от типа сообщения (см. таблицу ниже). Тип `OpfsMessagePayload` в пакете: `{ url?: string; size?: number; limit?: number; reason?: string }`.
 
 **Подписки на сообщения**
 
-Каждая функция принимает один аргумент — обработчик — и возвращает функцию отписки `() => void`. Вызовите её, когда подписка больше не нужна.
+Каждая функция принимает обработчик и возвращает функцию отписки `() => void`. В таблице только те подписки, **сообщения которых сервис-воркер реально отправляет** в текущей версии пакета; точный состав `event.data` — в последней колонке.
 
-| Функция | Сигнатура | Когда вызывается |
-|--------|-----------|-------------------|
-| `onOPFSQuotaExceeded` | `(handler: (event: MessageEvent) => void) => () => void` | При записи в OPFS браузер вернул QuotaExceeded. В `event.data`: `url`, при необходимости `size`. |
-| `onOPFSWriteSkipped` | `(handler: (event: MessageEvent) => void) => () => void` | Запись не начата: файл не влезает даже после попытки эвикции. В `event.data`: `url`, `size`, `limit`. |
-| `onOPFSCacheLimitReached` | `(handler: (event: MessageEvent) => void) => () => void` | Достигнут лимит кеша, начинается эвикция. В `event.data`: `limit` и др. |
-| `onOPFSEvictionCompleted` | `(handler: (event: MessageEvent) => void) => () => void` | Эвикция завершена. В `event.data`: `count` (число удалённых файлов). |
-| `onOPFSWriteFailed` | `(handler: (event: MessageEvent) => void) => () => void` | Ошибка записи (сеть, диск, удалён частичный файл). В `event.data`: `url`, `reason`. |
-| `onOPFSSkipQuotaExceeded` | `(handler: (event: MessageEvent) => void) => () => void` | Повторный запрос к URL из чёрного списка (ресурс не кешируем). В `event.data`: `url`. |
+| Функция | Сигнатура | Когда вызывается | Поля в `event.data` (кроме `type`) |
+|--------|-----------|-------------------|------------------------------------|
+| `onOPFSQuotaExceeded` | `(handler: (event: MessageEvent) => void) => () => void` | При записи в OPFS браузер вернул QuotaExceeded. | `url: string` |
+| `onOPFSWriteSkipped` | `(handler: (event: MessageEvent) => void) => () => void` | Запись не начата: файл не влезает даже после эвикции. | `url: string`, `size: number`, `reason: string` |
+| `onOPFSEvictionCompleted` | `(handler: (event: MessageEvent) => void) => () => void` | Эвикция завершена. | `count: number` (число удалённых файлов) |
+| `onOPFSWriteFailed` | `(handler: (event: MessageEvent) => void) => () => void` | Ошибка записи (сеть, диск, удалён частичный файл). | `url?: string`, `reason: string` |
+| `onOPFSSkipQuotaExceeded` | `(handler: (event: MessageEvent) => void) => () => void` | Повторный запрос к URL из чёрного списка (ресурс не кешируем). | `url: string` |
 
 **Управление кешем и типы**
 
@@ -184,7 +175,7 @@ await writeToOpfs(dir, key, response.body, metadata);
 - `hasInOpfsCache(url: string): Promise<boolean>` — есть ли URL в кеше.
 - `deleteFromOpfsCache(url: string): Promise<void>` — удалить ресурс по URL из кеша.
 
-Типы `OpfsMessagePayload` и `OpfsCachedResource` экспортируются из пакета; константы типов сообщений — `OPFS_MSG_QUOTA_EXCEEDED`, `OPFS_MSG_WRITE_SKIPPED_SIZE` и т.д.
+Типы `OpfsMessagePayload` и `OpfsCachedResource` экспортируются из пакета. Константы типов сообщений (имя совпадает со строковым значением в `event.data.type`): `OPFS_MSG_QUOTA_EXCEEDED`, `OPFS_MSG_WRITE_SKIPPED_SIZE`, `OPFS_MSG_CACHE_LIMIT_REACHED`, `OPFS_MSG_EVICTION_COMPLETED`, `OPFS_MSG_WRITE_FAILED`, `OPFS_MSG_SKIP_QUOTA_EXCEEDED`.
 
 ### Оповещения вкладок о квоте и лимитах
 

package/dist/opfsMessages.d.ts

@@ -1,7 +1,7 @@
-export declare const OPFS_MSG_QUOTA_EXCEEDED = "OPFS_QUOTA_EXCEEDED";
-export declare const OPFS_MSG_WRITE_SKIPPED_SIZE = "OPFS_WRITE_SKIPPED_SIZE";
-export declare const OPFS_MSG_CACHE_LIMIT_REACHED = "OPFS_CACHE_LIMIT_REACHED";
-export declare const OPFS_MSG_EVICTION_COMPLETED = "OPFS_EVICTION_COMPLETED";
-export declare const OPFS_MSG_WRITE_FAILED = "OPFS_WRITE_FAILED";
-export declare const OPFS_MSG_SKIP_QUOTA_EXCEEDED = "OPFS_SKIP_QUOTA_EXCEEDED";
+export declare const OPFS_MSG_QUOTA_EXCEEDED = "OPFS_MSG_QUOTA_EXCEEDED";
+export declare const OPFS_MSG_WRITE_SKIPPED_SIZE = "OPFS_MSG_WRITE_SKIPPED_SIZE";
+export declare const OPFS_MSG_CACHE_LIMIT_REACHED = "OPFS_MSG_CACHE_LIMIT_REACHED";
+export declare const OPFS_MSG_EVICTION_COMPLETED = "OPFS_MSG_EVICTION_COMPLETED";
+export declare const OPFS_MSG_WRITE_FAILED = "OPFS_MSG_WRITE_FAILED";
+export declare const OPFS_MSG_SKIP_QUOTA_EXCEEDED = "OPFS_MSG_SKIP_QUOTA_EXCEEDED";
 export type OpfsMessageType = typeof OPFS_MSG_QUOTA_EXCEEDED | typeof OPFS_MSG_WRITE_SKIPPED_SIZE | typeof OPFS_MSG_CACHE_LIMIT_REACHED | typeof OPFS_MSG_EVICTION_COMPLETED | typeof OPFS_MSG_WRITE_FAILED | typeof OPFS_MSG_SKIP_QUOTA_EXCEEDED;

package/dist/opfsMessages.js

@@ -1,6 +1,6 @@
-export const OPFS_MSG_QUOTA_EXCEEDED = 'OPFS_QUOTA_EXCEEDED';
-export const OPFS_MSG_WRITE_SKIPPED_SIZE = 'OPFS_WRITE_SKIPPED_SIZE';
-export const OPFS_MSG_CACHE_LIMIT_REACHED = 'OPFS_CACHE_LIMIT_REACHED';
-export const OPFS_MSG_EVICTION_COMPLETED = 'OPFS_EVICTION_COMPLETED';
-export const OPFS_MSG_WRITE_FAILED = 'OPFS_WRITE_FAILED';
-export const OPFS_MSG_SKIP_QUOTA_EXCEEDED = 'OPFS_SKIP_QUOTA_EXCEEDED';
+export const OPFS_MSG_QUOTA_EXCEEDED = 'OPFS_MSG_QUOTA_EXCEEDED';
+export const OPFS_MSG_WRITE_SKIPPED_SIZE = 'OPFS_MSG_WRITE_SKIPPED_SIZE';
+export const OPFS_MSG_CACHE_LIMIT_REACHED = 'OPFS_MSG_CACHE_LIMIT_REACHED';
+export const OPFS_MSG_EVICTION_COMPLETED = 'OPFS_MSG_EVICTION_COMPLETED';
+export const OPFS_MSG_WRITE_FAILED = 'OPFS_MSG_WRITE_FAILED';
+export const OPFS_MSG_SKIP_QUOTA_EXCEEDED = 'OPFS_MSG_SKIP_QUOTA_EXCEEDED';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@budarin/psw-plugin-opfs-serve-range",
-  "version": "1.1.4",
+  "version": "1.1.6",
   "description": "Service Worker plugin: serve HTTP Range requests from OPFS files",
   "keywords": [
     "service-worker",