@serve.zone/dcrouter 17.7.1 → 17.8.0

package/dist_ts/webpush/classes.webpush-manager.d.ts

@@ -0,0 +1,153 @@
+import * as plugins from '../plugins.js';
+import { WebPushBindingDoc, WebPushSpoolDoc, type IWebPushStoredCredential, type TWebPushControllerIntent } from '../db/index.js';
+import { type IWebPushTransport } from './classes.webpush-transport.js';
+type IWebPushBinding = plugins.servezoneInterfaces.data.IWebPushBinding;
+type IWebPushCredentialOneTimeSecret = plugins.servezoneInterfaces.data.IWebPushCredentialOneTimeSecret;
+type IWebPushDeliveryStatus = plugins.servezoneInterfaces.data.IWebPushDeliveryStatus;
+type IWebPushNotificationPayload = plugins.servezoneInterfaces.data.IWebPushNotificationPayload;
+type IWebPushResourceOwner = plugins.servezoneInterfaces.data.IWebPushResourceOwner;
+type IWebPushServiceStatus = plugins.servezoneInterfaces.data.IWebPushServiceStatus;
+type IWebPushSubscription = plugins.servezoneInterfaces.data.IWebPushSubscription;
+type TWebPushBindingSync = plugins.servezoneInterfaces.requests.webpush.TWebPushBindingSync;
+type IWebPushAppCredentialAuth = plugins.servezoneInterfaces.requests.webpush.IWebPushAppCredentialAuth;
+type TWebPushCancellationTarget = plugins.servezoneInterfaces.data.TWebPushCancellationTarget;
+type TWebPushDeliveryState = plugins.servezoneInterfaces.data.TWebPushDeliveryState;
+type TWebPushUrgency = plugins.servezoneInterfaces.data.TWebPushUrgency;
+interface IWebPushQenv {
+    getEnvVarOnDemand(nameArg: string): Promise<string | undefined>;
+}
+export interface IWebPushManagerOptions {
+    qenv?: IWebPushQenv;
+    transport?: IWebPushTransport;
+    startWorker?: boolean;
+    now?: () => number;
+    admissionPolicy?: Partial<IWebPushAdmissionPolicy>;
+}
+export interface IWebPushAdmissionPolicy {
+    shortWindowMs: number;
+    shortLimit: number;
+    longWindowMs: number;
+    longLimit: number;
+}
+export interface IWebPushAuthenticatedBinding {
+    binding: WebPushBindingDoc;
+    credential: IWebPushStoredCredential;
+}
+export interface IWebPushBindingSyncResult {
+    binding: IWebPushBinding;
+    credential?: IWebPushCredentialOneTimeSecret;
+}
+/**
+ * Durable controller ordering token. The controller id and epoch remain stable
+ * for an owner, while generation increases for every desired-state mutation.
+ */
+export interface IWebPushControllerMutation {
+    id: string;
+    epoch: string;
+    generation: number;
+    operationId: string;
+    intent: TWebPushControllerIntent;
+}
+export interface IWebPushBindingDelete {
+    id?: string;
+    owner: IWebPushResourceOwner;
+    controller: IWebPushControllerMutation;
+}
+export interface IWebPushEnqueueResult {
+    accepted: boolean;
+    spoolItemId: string;
+}
+export interface IWebPushCancelResult {
+    cancelledCount: number;
+    alreadyTerminalCount: number;
+}
+export declare function toPublicWebPushBinding(bindingArg: WebPushBindingDoc): IWebPushBinding;
+export declare function toPublicWebPushDelivery(spoolArg: WebPushSpoolDoc): IWebPushDeliveryStatus;
+export declare function buildWebPushTerminalUpdate(optionsArg: {
+    state: Extract<TWebPushDeliveryState, 'pushServiceAccepted' | 'invalidSubscription' | 'failed' | 'expired' | 'cancelled'>;
+    now: number;
+    pushServiceStatusCode?: number;
+    errorCode?: string;
+}): Record<string, unknown>;
+export declare class WebPushManager {
+    private readonly qenv;
+    private readonly transport;
+    private readonly startWorker;
+    private readonly now;
+    private readonly admissionPolicy;
+    private enabled;
+    private started;
+    private ready;
+    private crypto?;
+    private vapidSubject?;
+    private workerTimer?;
+    private activeWorkerCycle?;
+    private expiredCredentialOverlapCursor?;
+    private expiredCredentialRecoveryCursor?;
+    private retiredVapidCursor?;
+    private inactiveLifecycleCursor?;
+    constructor(optionsArg?: IWebPushManagerOptions);
+    get isEnabled(): boolean;
+    get isReady(): boolean;
+    start(): Promise<void>;
+    stop(): Promise<void>;
+    getUnavailableServiceStatus(): IWebPushServiceStatus;
+    listBindings(ownerFilterArg?: Partial<IWebPushResourceOwner>): Promise<IWebPushBinding[]>;
+    getBindingById(idArg: string): Promise<WebPushBindingDoc | null>;
+    getBindingByCredentialId(credentialIdArg: string): Promise<WebPushBindingDoc | null>;
+    syncBinding(bindingArg: TWebPushBindingSync, controllerArg: IWebPushControllerMutation, createdByArg: string): Promise<IWebPushBindingSyncResult>;
+    private resumeControllerSyncReplay;
+    deleteBinding(deleteArg: IWebPushBindingDelete, deletedByArg: string): Promise<boolean>;
+    private resumeControllerDeleteReplay;
+    rotateCredential(credentialIdArg: string): Promise<IWebPushCredentialOneTimeSecret>;
+    rotateVapidKey(bindingIdArg: string): Promise<IWebPushBinding>;
+    authenticateAppCredential(authArg: IWebPushAppCredentialAuth): Promise<IWebPushAuthenticatedBinding>;
+    getServiceStatus(authArg: IWebPushAppCredentialAuth): Promise<IWebPushServiceStatus>;
+    enqueue(authArg: IWebPushAppCredentialAuth, requestArg: {
+        idempotencyKey: string;
+        subscriptionId: string;
+        subscription: IWebPushSubscription;
+        vapidKeyId: string;
+        payload: IWebPushNotificationPayload;
+        ttlSeconds?: number;
+        urgency?: TWebPushUrgency;
+        collapseKey?: string;
+    }): Promise<IWebPushEnqueueResult>;
+    getDeliveryStatus(authArg: IWebPushAppCredentialAuth, spoolItemIdArg: string): Promise<IWebPushDeliveryStatus | undefined>;
+    cancel(authArg: IWebPushAppCredentialAuth, targetArg: TWebPushCancellationTarget): Promise<IWebPushCancelResult>;
+    processDueDeliveriesOnce(limitArg?: number): Promise<number>;
+    private requirePersistenceReady;
+    private requireReady;
+    private bindingOwner;
+    private assertBindingOwner;
+    private credentialHmacValue;
+    private createCredential;
+    private credentialRotationRecoveryAad;
+    private replayCredentialRotation;
+    private createVapidKey;
+    private spoolAadBase;
+    private assertBindingLifecycleActive;
+    private reserveAdmission;
+    private cancelSpoolIfLifecycleChanged;
+    private scrubDeletedBindingLifecycle;
+    private cleanupExpiredCredentialOverlaps;
+    private cleanupExpiredCredentialRotationRecoveries;
+    private cleanupRetiredVapidKeys;
+    private runMaintenanceOnce;
+    private cleanupInactiveBindingLifecycles;
+    private selectBindingMaintenanceBatch;
+    private requestBindingLifecyclesBeforeCancellation;
+    private drainBindingLifecyclesBefore;
+    private waitForBindingLifecyclesBeforeDrain;
+    private finishStaleCancelledSending;
+    private finishStaleCancelledSendingBefore;
+    private cancelWithinBinding;
+    private expireDueItems;
+    private claimNextItem;
+    private processClaimedItem;
+    private finishTerminal;
+    private deferOrFinish;
+    private retryDelayMs;
+    private scheduleWorker;
+}
+export {};