189 lines
14 KiB
Plaintext
189 lines
14 KiB
Plaintext
page wrnexuspwa {
|
|
seo {
|
|
title = "@wrnexus/pwa"
|
|
description = "Progressive Web App manifests, service workers, and offline strategies."
|
|
}
|
|
|
|
view {
|
|
<div class="docs-shell">
|
|
<a href="#main" class="skip-link">Skip to content</a>
|
|
<header class="topbar">
|
|
<a class="brand" href="/"><span>W</span> WRNexusJS</a>
|
|
<nav aria-label="Primary"><a href="/getting-started">Get started</a><a href="/packages">Packages</a><a href="https://component.wrnexusjs.dev/">Components</a><a href="/language">Language</a><a href="/architecture">Architecture</a></nav>
|
|
<div class="topbar-actions"><a class="preview-pill" href="/access">Private preview · v0.8.8</a><button data-wire-theme-toggle class="theme-button" aria-label="Toggle color theme" title="Toggle color theme">◐</button></div>
|
|
</header>
|
|
<div class="mobile-doc-nav"><details><summary>Browse documentation</summary><nav><a href="/getting-started">Get started</a><a href="/packages">Packages</a><a href="https://component.wrnexusjs.dev/">Components</a><a href="/language">Language</a><a href="/architecture">Architecture</a><a href="/tutorial">Tutorial</a><a href="/guides/project-structure">Guides</a><a href="/examples">Examples</a><a href="/search">Search</a></nav></details></div>
|
|
<main id="main" class="portal-main docs-layout docs-layout--navigation"><aside class="docs-section-menu" aria-label="Documentation sections"><nav>
|
|
<section><strong>Get started</strong><a href="/getting-started">Quick start</a><a href="/tutorial">Tutorial</a><a href="/guides/full-stack-auth-demo">Auth dashboard demo</a><a href="/guides/configuration-and-profiles">Configuration</a></section>
|
|
<section><strong>Build</strong><a href="/guides/pages-and-components">Pages and components</a><a href="/guides/routing">Routing</a><a href="/guides/server-data">Server data</a><a href="/guides/forms-and-validation">Forms and validation</a><a href="/guides/database">Database</a></section>
|
|
<section><strong>Auth and security</strong><a href="/guides/authentication">Authentication</a><a href="/guides/authorization">Authorization</a><a href="/guides/security">Application security</a><a href="/security">Security policy</a></section>
|
|
<section><strong>Reference</strong><a href="/packages">Packages overview</a><a href="/packages/cli">CLI</a><a href="/language">.wrn language</a><a href="https://component.wrnexusjs.dev/">Components</a><a href="/examples">Examples</a></section>
|
|
<section class="package-menu"><strong>Packages</strong><a href="/packages/ai">@wrnexus/ai</a><a href="/packages/auth">@wrnexus/auth</a><a href="/packages/authz">@wrnexus/authz</a><a href="/packages/benchmark">@wrnexus/benchmark</a><a href="/packages/cache">@wrnexus/cache</a><a href="/packages/captcha">@wrnexus/captcha</a><a href="/packages/cli">@wrnexus/cli</a><a href="/packages/compiler">@wrnexus/compiler</a><a href="/packages/content">@wrnexus/content</a><a href="/packages/core">@wrnexus/core</a><a href="/packages/csr">@wrnexus/csr</a><a href="/packages/db">@wrnexus/db</a><a href="/packages/dev-server">@wrnexus/dev-server</a><a href="/packages/dev-toolbar">@wrnexus/dev-toolbar</a><a href="/packages/encryption">@wrnexus/encryption</a><a href="/packages/graphql">@wrnexus/graphql</a><a href="/packages/helpers">@wrnexus/helpers</a><a href="/packages/i18n">@wrnexus/i18n</a><a href="/packages/identity">@wrnexus/identity</a><a href="/packages/image">@wrnexus/image</a><a href="/packages/jwt">@wrnexus/jwt</a><a href="/packages/language-server">@wrnexus/language-server</a><a href="/packages/mcp">@wrnexus/mcp</a><a href="/packages/mobile">@wrnexus/mobile</a><a href="/packages/native">@wrnexus/native</a><a href="/packages/oauth">@wrnexus/oauth</a><a href="/packages/observability">@wrnexus/observability</a><a href="/packages/playground">@wrnexus/playground</a><a href="/packages/plugin">@wrnexus/plugin</a><a href="/packages/pubsub">@wrnexus/pubsub</a><a href="/packages/pwa">@wrnexus/pwa</a><a href="/packages/queue">@wrnexus/queue</a><a href="/packages/reactive">@wrnexus/reactive</a><a href="/packages/realtime">@wrnexus/realtime</a><a href="/packages/router">@wrnexus/router</a><a href="/packages/security">@wrnexus/security</a><a href="/packages/ssr">@wrnexus/ssr</a><a href="/packages/store">@wrnexus/store</a><a href="/packages/styles">@wrnexus/styles</a><a href="/packages/syntax">@wrnexus/syntax</a><a href="/packages/test">@wrnexus/test</a><a href="/packages/tracking">@wrnexus/tracking</a><a href="/packages/typecheck">@wrnexus/typecheck</a><a href="/packages/ui">@wrnexus/ui</a><a href="/packages/uploader">@wrnexus/uploader</a><a href="/packages/validation">@wrnexus/validation</a></section>
|
|
</nav></aside><div class="docs-reading-column">
|
|
<article class="documentation prose standalone package-document"><nav class="breadcrumbs" aria-label="Breadcrumb"><a href="/">Home</a><span>/</span><a href="/packages">Packages</a><span>/</span><span aria-current="page">@wrnexus/pwa</span></nav><section class="doc-intro"><span class="eyebrow">Frontend · Package reference</span><h1>@wrnexus/pwa</h1><p>Progressive Web App manifests, service workers, and offline strategies.</p><div class="doc-meta"><span>v0.8.8</span><span>Private registry</span><span>Frontend</span></div><section id="access" class="access-callout"><h2>Install the package</h2><p>After WorkRoot approves private registry access, install the release-aligned package:</p><pre><code>bun add @wrnexus/pwa@0.8.8</code><button type="button" class="copy-button" aria-label="Copy installation command">Copy</button></pre><p><a href="/access">Request preview access</a>. Never put registry tokens in source control.</p></section></section><section id="guide"><p>Official PWA primitives for manifests, service workers, offline pages and precaching, runtime caching, background synchronization, push notifications, install/update events, offline mutation stores, and conflict resolution. <code>createOfflineQueue()</code> accepts a durable IndexedDB-style store and retries requests with stable idempotency headers.</p></section><section id="api" class="api"><h2>Complete TypeScript API</h2><p>Generated from the exact installed package declarations.</p><pre data-language="typescript"><code>interface IndexedDbMigration {
|
|
version: number;
|
|
migrate(db: IDBDatabase, transaction: IDBTransaction): void;
|
|
}
|
|
declare function openPwaDatabase(name: string, migrations: IndexedDbMigration[], factory?: IDBFactory): Promise<IDBDatabase>;
|
|
declare function indexedDbOfflineQueueStore(db: IDBDatabase, storeName?: string): OfflineQueueStore;
|
|
declare const offlineQueueMigration: IndexedDbMigration;
|
|
interface StoredPushSubscription {
|
|
id: string;
|
|
userId: string;
|
|
endpoint: string;
|
|
expirationTime?: number | null;
|
|
keys: {
|
|
p256dh: string;
|
|
auth: string;
|
|
};
|
|
createdAt: number;
|
|
}
|
|
interface PushSubscriptionStore {
|
|
put(value: StoredPushSubscription): Promise<void>;
|
|
remove(id: string): Promise<void>;
|
|
list(userId: string): Promise<StoredPushSubscription[]>;
|
|
}
|
|
declare function memoryPushSubscriptionStore(): PushSubscriptionStore;
|
|
interface PushSqlClient {
|
|
query<T = Record<string, unknown>>(sql: string, parameters?: unknown[]): Promise<{
|
|
rows: T[];
|
|
}>;
|
|
}
|
|
declare function postgresPushSubscriptionStore(db: PushSqlClient): PushSubscriptionStore;
|
|
declare const POSTGRES_PUSH_SUBSCRIPTION_SCHEMA = "CREATE TABLE IF NOT EXISTS wrnexus_push_subscriptions (id text PRIMARY KEY,user_id text NOT NULL,endpoint text NOT NULL,expiration_time bigint,p256dh text NOT NULL,auth text NOT NULL,created_at bigint NOT NULL); CREATE INDEX IF NOT EXISTS wrnexus_push_user ON wrnexus_push_subscriptions (user_id);";
|
|
declare function createPushSubscriptionService(store: PushSubscriptionStore, options?: {
|
|
now?: () => number;
|
|
maxPerUser?: number;
|
|
}): {
|
|
subscribe(userId: string, value: {
|
|
endpoint: string;
|
|
expirationTime?: number | null;
|
|
keys: {
|
|
p256dh: string;
|
|
auth: string;
|
|
};
|
|
}): Promise<{
|
|
keys: {
|
|
p256dh: string;
|
|
auth: string;
|
|
};
|
|
createdAt: number;
|
|
endpoint: string;
|
|
expirationTime?: number | null;
|
|
id: string;
|
|
userId: string;
|
|
}>;
|
|
unsubscribe: (id: string) => Promise<void>;
|
|
list: (userId: string) => Promise<StoredPushSubscription[]>;
|
|
};
|
|
declare function renderOfflineQueueReview(items: OfflineMutation[], conflicts?: Array<{
|
|
id: string;
|
|
message: string;
|
|
}>): string;
|
|
declare const PWA_REVIEW_RUNTIME = "document.addEventListener(\"click\",event=>{const button=event.target.closest(\"[data-pwa-retry],[data-pwa-remove],[data-pwa-client],[data-pwa-server]\");if(!button)return;const action=button.hasAttribute(\"data-pwa-retry\")?\"retry\":button.hasAttribute(\"data-pwa-remove\")?\"remove\":button.hasAttribute(\"data-pwa-client\")?\"client\":\"server\";const id=button.getAttribute(\"data-pwa-\"+action);dispatchEvent(new CustomEvent(\"wrnexus:pwa-review\",{detail:{action,id}}))});";
|
|
|
|
type RuntimeCacheStrategy = "network-first" | "cache-first" | "stale-while-revalidate";
|
|
interface RuntimeCacheRule {
|
|
pattern: string;
|
|
strategy: RuntimeCacheStrategy;
|
|
cacheName?: string;
|
|
methods?: string[];
|
|
}
|
|
interface ServiceWorkerOptions {
|
|
cacheName?: string;
|
|
offlineUrl?: string;
|
|
startUrl?: string;
|
|
cacheUrls?: string[];
|
|
runtimeCaching?: RuntimeCacheRule[];
|
|
backgroundSyncTag?: string;
|
|
}
|
|
interface WebManifestOptions {
|
|
name: string;
|
|
shortName?: string;
|
|
description?: string;
|
|
id?: string;
|
|
startUrl?: string;
|
|
scope?: string;
|
|
display?: "standalone" | "fullscreen" | "minimal-ui" | "browser";
|
|
themeColor?: string;
|
|
backgroundColor?: string;
|
|
icons?: Array<{
|
|
src: string;
|
|
sizes: string;
|
|
type?: string;
|
|
purpose?: string;
|
|
}>;
|
|
shortcuts?: unknown[];
|
|
screenshots?: unknown[];
|
|
categories?: string[];
|
|
lang?: string;
|
|
}
|
|
declare function createWebManifest(options: WebManifestOptions): {
|
|
id: string;
|
|
name: string;
|
|
short_name: string;
|
|
description: string | undefined;
|
|
start_url: string;
|
|
scope: string;
|
|
display: "standalone" | "fullscreen" | "minimal-ui" | "browser";
|
|
theme_color: string;
|
|
background_color: string;
|
|
icons: {
|
|
src: string;
|
|
sizes: string;
|
|
type?: string;
|
|
purpose?: string;
|
|
}[];
|
|
shortcuts: unknown[];
|
|
screenshots: unknown[];
|
|
categories: string[];
|
|
lang: string;
|
|
};
|
|
declare function generateServiceWorker(options?: ServiceWorkerOptions): string;
|
|
interface OfflineMutation<T = unknown> {
|
|
id: string;
|
|
createdAt: number;
|
|
updatedAt: number;
|
|
endpoint: string;
|
|
method: string;
|
|
payload: T;
|
|
attempts: number;
|
|
}
|
|
interface OfflineQueueStore {
|
|
list(): Promise<OfflineMutation[]>;
|
|
put(item: OfflineMutation): Promise<void>;
|
|
remove(id: string): Promise<void>;
|
|
}
|
|
declare function memoryOfflineQueueStore(): OfflineQueueStore;
|
|
type ConflictResolution<T> = {
|
|
action: "client" | "server" | "merge";
|
|
value: T;
|
|
};
|
|
declare function resolveOfflineConflict<T extends object>(client: T, server: T, strategy?: "client-wins" | "server-wins" | "last-write-wins" | ((client: T, server: T) => T)): ConflictResolution<T>;
|
|
declare function createOfflineQueue(options?: {
|
|
store?: OfflineQueueStore;
|
|
fetch?: (input: string | URL | Request, init?: RequestInit) => Promise<Response>;
|
|
maxItems?: number;
|
|
now?: () => number;
|
|
}): {
|
|
enqueue<T>(input: Omit<OfflineMutation<T>, "id" | "createdAt" | "updatedAt" | "attempts">): Promise<OfflineMutation<T>>;
|
|
list: () => Promise<OfflineMutation<unknown>[]>;
|
|
sync(): Promise<{
|
|
id: string;
|
|
ok: boolean;
|
|
status?: number;
|
|
}[]>;
|
|
remove: (id: string) => Promise<void>;
|
|
};
|
|
declare function pwaClientRuntime(serviceWorkerUrl?: string): string;
|
|
declare function subscribeToPush(registration: ServiceWorkerRegistration, publicKey: Uint8Array): Promise<PushSubscription>;
|
|
|
|
export { type ConflictResolution, type IndexedDbMigration, type OfflineMutation, type OfflineQueueStore, POSTGRES_PUSH_SUBSCRIPTION_SCHEMA, PWA_REVIEW_RUNTIME, type PushSqlClient, type PushSubscriptionStore, type RuntimeCacheRule, type RuntimeCacheStrategy, type ServiceWorkerOptions, type StoredPushSubscription, type WebManifestOptions, createOfflineQueue, createPushSubscriptionService, createWebManifest, generateServiceWorker, indexedDbOfflineQueueStore, memoryOfflineQueueStore, memoryPushSubscriptionStore, offlineQueueMigration, openPwaDatabase, postgresPushSubscriptionStore, pwaClientRuntime, renderOfflineQueueReview, resolveOfflineConflict, subscribeToPush };
|
|
</code></pre></section><section id="examples" class="examples"><h2>Examples</h2><p>Copy-ready examples from the installed package documentation.</p><div class="example-grid"><article class="example-card"><h3>Install @wrnexus/pwa</h3><pre data-language="sh"><code>bun add @wrnexus/pwa</code></pre></article><article class="example-card"><h3>Import @wrnexus/pwa</h3><pre data-language="ts"><code>import * as pwa from "@wrnexus/pwa";</code></pre></article></div></section></article></div>
|
|
<aside class="on-this-page"><h2>On this page</h2><nav><a class="toc-level-2" href="#guide">Guide</a><a class="toc-level-2" href="#api">Complete API</a><a class="toc-level-2" href="#examples">Examples</a></nav></aside>
|
|
</main>
|
|
<footer><div class="footer-brand"><span class="footer-mark" aria-hidden="true">W</span><p><strong>WRNexusJS 0.8.8</strong><span>Complete API documentation generated from installed package declarations.</span></p></div><nav aria-label="Footer"><a href="/packages">All packages</a><a href="/getting-started">Get started</a><a href="/security">Security</a><a href="/support">Support</a><a href="/llms.txt">AI guide</a></nav><p class="footer-meta">Private Developer Preview · Bun-native</p></footer>
|
|
</div>
|
|
}
|
|
}
|