@zuzjs/flare 0.2.4 → 0.2.5

package/dist/index.d.cts

@@ -5,6 +5,7 @@ export { Anonymous, Apple, AuthGuard, AuthToken, CreateUserWithEmailAndPasswordI
  * Client Configuration
  */
 interface FlareConfig {
+    /** Base URL for the Flare API. */
     endpoint: string;
     /**
      * Optional HTTP base URL for auth API calls.
@@ -14,15 +15,26 @@ interface FlareConfig {
      * Example: '/api/flare'  (relative, browser resolves against current origin)
      */
     httpBase?: string;
+    /** Unique identifier for the application. */
     appId: string;
+    /** API key for the application. */
     apiKey?: string;
+    /** Public key for the application. */
     publicKey?: string;
+    /** Whether to automatically reconnect on connection loss. */
     autoReconnect?: boolean;
+    /** Delay between reconnection attempts in milliseconds. */
     reconnectDelay?: number;
+    /** Maximum delay between reconnection attempts in milliseconds. */
     maxReconnectDelay?: number;
+    /** Enable or disable debug mode. */
     debug?: boolean;
+    /** Enable or disable request timing. */
     requestTiming?: boolean;
+    /** Connection timeout in milliseconds. */
     connectionTimeout?: number;
+    /** Enable automatic push notification registration on supported platforms. */
+    pushNotifications?: boolean;
 }
 type FlareAuthProviderId = "credentials" | "anonymous" | "google" | "facebook" | "github" | "dropbox" | "apple" | "twitter";
 interface FlareAuthProviderPublicConfig {
@@ -65,6 +77,86 @@ interface FlareAuthUser {
     email_verified: string;
     [x: string]: any;
 }
+interface RegisterPushTokenInput {
+    token: string;
+    platform?: string;
+    deviceId?: string;
+    topics?: string[];
+    authAppId?: string;
+}
+interface BrowserPushTokenOptions {
+    /** Service worker registration used for PushManager subscription. */
+    serviceWorkerRegistration?: ServiceWorkerRegistration;
+    /** Existing PushSubscription to reuse instead of subscribing again. */
+    subscription?: PushSubscription;
+    /** Public VAPID key used when creating a new PushSubscription. */
+    applicationServerKey?: string;
+    /** When true, unsubscribe old subscriptions before creating a new one. */
+    forceResubscribe?: boolean;
+}
+interface BrowserPushRegistrationOptions extends BrowserPushTokenOptions {
+    /** Optional explicit platform label. Defaults to "web". */
+    platform?: string;
+    deviceId?: string;
+    topics?: string[];
+    authAppId?: string;
+}
+interface SendPushNotificationInput {
+    title?: string;
+    body?: string;
+    image?: string;
+    data?: Record<string, unknown>;
+    tokens?: string[];
+    uid?: string;
+    topic?: string;
+    priority?: "normal" | "high";
+    ttlSeconds?: number;
+    dryRun?: boolean;
+    authAppId?: string;
+}
+interface PushSendResult {
+    sent: boolean;
+    appId: string;
+    targetCount: number;
+    successCount: number;
+    failureCount: number;
+    invalidatedTokenCount: number;
+    dryRun: boolean;
+}
+interface SendEmailInput {
+    to: string | string[];
+    tag: string;
+    values?: Record<string, unknown>;
+    authAppId?: string;
+}
+interface EmailSendResult {
+    sent: boolean;
+    appId: string;
+    tag: string;
+    recipientCount: number;
+    acceptedCount: number;
+    rejectedCount: number;
+    includeVerificationLink?: boolean;
+    linkId?: string;
+    verifyUrl?: string;
+    messageId?: string;
+}
+interface VerifyEmailLinkInput {
+    token: string;
+    tag?: string;
+    email?: string;
+    authAppId?: string;
+}
+interface EmailLinkVerifyResult {
+    verified: boolean;
+    alreadyVerified: boolean;
+    appId: string;
+    linkId: string;
+    email: string;
+    tag: string;
+    verifiedAt?: string;
+    acceptedByUid?: string;
+}
 type AuthStateListener = (session: FlareAuthSession & FlareAuthUser | null) => void;
 type AuthConfigListener = (conf: FlareAuthConfig) => void;
 interface SubscribeOptions {
@@ -167,7 +259,7 @@ interface VectorSearchClause {
     metric?: "cosine" | "euclidean" | "dotProduct";
     minScore?: number;
 }
-/** Full structured query (Firestore + SQL feature set) */
+/** Full structured query (document query + SQL-style feature set) */
 interface StructuredQuery {
     where?: AnyFilter[];
     orderBy?: OrderByClause[];
@@ -781,6 +873,7 @@ declare class FlareAuth<TPresetMap extends QueryPresetMap = {}> extends FlareBas
     protected csrfInitPromise?: Promise<void>;
     protected csrfBootstrapAttempted: boolean;
     protected socketAuthSyncPromise?: Promise<void>;
+    protected pushServiceWorkerInitPromise?: Promise<ServiceWorkerRegistration | null>;
     protected authSession: FlareAuthSession | null;
     protected authStateListeners: AuthStateListener[];
     protected authConfigListeners: AuthConfigListener[];
@@ -977,6 +1070,39 @@ declare class FlareAuth<TPresetMap extends QueryPresetMap = {}> extends FlareBas
         email: string;
         sessionsRevoked?: number;
     }>;
+    private toUint8ArrayFromBase64Url;
+    private encodePushTokenFromSubscription;
+    private fetchPushSetupConfig;
+    setupPushServiceWorker(): Promise<ServiceWorkerRegistration | null>;
+    requestPushPermission(): Promise<NotificationPermission>;
+    acquireBrowserPushToken(options?: BrowserPushTokenOptions): Promise<{
+        token: string;
+        subscription: PushSubscription;
+    }>;
+    enableBrowserPush(options?: BrowserPushRegistrationOptions): Promise<{
+        registered: boolean;
+        appId: string;
+        uid: string;
+        token: string;
+        platform?: string;
+        subscription: PushSubscription;
+    }>;
+    registerPushToken(input: RegisterPushTokenInput): Promise<{
+        registered: boolean;
+        appId: string;
+        uid: string;
+        token: string;
+        platform?: string;
+    }>;
+    unregisterPushToken(token: string, authAppId?: string): Promise<{
+        unregistered: boolean;
+        appId: string;
+        token: string;
+        removed: boolean;
+    }>;
+    sendPushNotification(input: SendPushNotificationInput): Promise<PushSendResult>;
+    sendEmail(input: SendEmailInput): Promise<EmailSendResult>;
+    verifyEmailLink(input: VerifyEmailLinkInput): Promise<EmailLinkVerifyResult>;
     signIn(providerId: ProviderId, options?: {
         returnTo?: string;
         metaTag?: string;
@@ -1062,7 +1188,10 @@ declare class FlareAuth<TPresetMap extends QueryPresetMap = {}> extends FlareBas
  */
 
 declare class FlareClient<TPresetMap extends QueryPresetMap = {}> extends FlareAuth<TPresetMap> {
+    private autoPushRegisteredIdentity?;
     constructor(config: FlareConfig);
+    private enableAutoPushNotificationsAfterAuth;
+    autoEnablePushNotifications(): Promise<void>;
 }
 
 /**
@@ -1253,4 +1382,4 @@ declare const getFlare: () => FlareClient | null;
  */
 declare const disconnectFlare: () => void;
 
-export { type AggregateFunction, type AggregateSpec, type AnyFilter, type AuthConfigListener, type AuthConfigResponse, type AuthResult, type AuthStateListener, type AuthWithPendingVerificationResult, type AuthWithTokenResult, type BaseMessage, type ChangeEvent, type ChangeOperation, type CollectionPresetMethods, type CollectionQuery, CollectionReference, type ConnectionState, type CsrfProxyConfig, type CursorValue, type DocAddedCallback, type DocChangedCallback, type DocDeletedCallback, type DocUpdatedCallback, DocumentQueryBuilder, DocumentReference, type DocumentSnapshot, FlareAction, type FlareAuthConfig, type FlareAuthProviderId, type FlareAuthProviderPublicConfig, type FlareAuthSession, type FlareAuthUser, type FlareConfig, FlareError, FlareErrors, FlareEvent, FlareResponseCodes, type FlareRule, type GroupByClause, type HavingClause, type JoinClause, type JoinQueryPattern, type NestedJoinClause, type OfflineOperation, type OrFilter, type OrderByClause, type PresenceCallback, type PresenceJoinCallback, type PresenceLeaveCallback, type PresenceMember, type QueryConfig, type QueryOperator, type QueryPresetMap, type QueryPresetParams, type QueryPresetRow, type QueryPresetSpec, type QuerySnapshot, type RulePermission, type SecurityRuleEntry, type SecurityRulesMap, type SnapshotEvent, type StructuredJoinClause, type StructuredQuery, type SubscribeMessage, type SubscribeOptions, type SubscriptionCallback, type SubscriptionData, type SubscriptionError, type SubscriptionErrorCallback, type SubscriptionHandle, type VectorFieldConfig, type VectorSearchClause, type WhereCondition, buildFlareHeaders, connectApp, createCsrfProxy, createCsrfProxyHandler, FlareClient as default, disconnectFlare, extractCsrfFromRequest, flareRulesToSecurityMap, getFlare, parseValue, parseWhereCondition, securityMapToFlareRules };
+export { type AggregateFunction, type AggregateSpec, type AnyFilter, type AuthConfigListener, type AuthConfigResponse, type AuthResult, type AuthStateListener, type AuthWithPendingVerificationResult, type AuthWithTokenResult, type BaseMessage, type BrowserPushRegistrationOptions, type BrowserPushTokenOptions, type ChangeEvent, type ChangeOperation, type CollectionPresetMethods, type CollectionQuery, CollectionReference, type ConnectionState, type CsrfProxyConfig, type CursorValue, type DocAddedCallback, type DocChangedCallback, type DocDeletedCallback, type DocUpdatedCallback, DocumentQueryBuilder, DocumentReference, type DocumentSnapshot, type EmailLinkVerifyResult, type EmailSendResult, FlareAction, type FlareAuthConfig, type FlareAuthProviderId, type FlareAuthProviderPublicConfig, type FlareAuthSession, type FlareAuthUser, type FlareConfig, FlareError, FlareErrors, FlareEvent, FlareResponseCodes, type FlareRule, type GroupByClause, type HavingClause, type JoinClause, type JoinQueryPattern, type NestedJoinClause, type OfflineOperation, type OrFilter, type OrderByClause, type PresenceCallback, type PresenceJoinCallback, type PresenceLeaveCallback, type PresenceMember, type PushSendResult, type QueryConfig, type QueryOperator, type QueryPresetMap, type QueryPresetParams, type QueryPresetRow, type QueryPresetSpec, type QuerySnapshot, type RegisterPushTokenInput, type RulePermission, type SecurityRuleEntry, type SecurityRulesMap, type SendEmailInput, type SendPushNotificationInput, type SnapshotEvent, type StructuredJoinClause, type StructuredQuery, type SubscribeMessage, type SubscribeOptions, type SubscriptionCallback, type SubscriptionData, type SubscriptionError, type SubscriptionErrorCallback, type SubscriptionHandle, type VectorFieldConfig, type VectorSearchClause, type VerifyEmailLinkInput, type WhereCondition, buildFlareHeaders, connectApp, createCsrfProxy, createCsrfProxyHandler, FlareClient as default, disconnectFlare, extractCsrfFromRequest, flareRulesToSecurityMap, getFlare, parseValue, parseWhereCondition, securityMapToFlareRules };

package/dist/index.d.ts

@@ -5,6 +5,7 @@ export { Anonymous, Apple, AuthGuard, AuthToken, CreateUserWithEmailAndPasswordI
  * Client Configuration
  */
 interface FlareConfig {
+    /** Base URL for the Flare API. */
     endpoint: string;
     /**
      * Optional HTTP base URL for auth API calls.
@@ -14,15 +15,26 @@ interface FlareConfig {
      * Example: '/api/flare'  (relative, browser resolves against current origin)
      */
     httpBase?: string;
+    /** Unique identifier for the application. */
     appId: string;
+    /** API key for the application. */
     apiKey?: string;
+    /** Public key for the application. */
     publicKey?: string;
+    /** Whether to automatically reconnect on connection loss. */
     autoReconnect?: boolean;
+    /** Delay between reconnection attempts in milliseconds. */
     reconnectDelay?: number;
+    /** Maximum delay between reconnection attempts in milliseconds. */
     maxReconnectDelay?: number;
+    /** Enable or disable debug mode. */
     debug?: boolean;
+    /** Enable or disable request timing. */
     requestTiming?: boolean;
+    /** Connection timeout in milliseconds. */
     connectionTimeout?: number;
+    /** Enable automatic push notification registration on supported platforms. */
+    pushNotifications?: boolean;
 }
 type FlareAuthProviderId = "credentials" | "anonymous" | "google" | "facebook" | "github" | "dropbox" | "apple" | "twitter";
 interface FlareAuthProviderPublicConfig {
@@ -65,6 +77,86 @@ interface FlareAuthUser {
     email_verified: string;
     [x: string]: any;
 }
+interface RegisterPushTokenInput {
+    token: string;
+    platform?: string;
+    deviceId?: string;
+    topics?: string[];
+    authAppId?: string;
+}
+interface BrowserPushTokenOptions {
+    /** Service worker registration used for PushManager subscription. */
+    serviceWorkerRegistration?: ServiceWorkerRegistration;
+    /** Existing PushSubscription to reuse instead of subscribing again. */
+    subscription?: PushSubscription;
+    /** Public VAPID key used when creating a new PushSubscription. */
+    applicationServerKey?: string;
+    /** When true, unsubscribe old subscriptions before creating a new one. */
+    forceResubscribe?: boolean;
+}
+interface BrowserPushRegistrationOptions extends BrowserPushTokenOptions {
+    /** Optional explicit platform label. Defaults to "web". */
+    platform?: string;
+    deviceId?: string;
+    topics?: string[];
+    authAppId?: string;
+}
+interface SendPushNotificationInput {
+    title?: string;
+    body?: string;
+    image?: string;
+    data?: Record<string, unknown>;
+    tokens?: string[];
+    uid?: string;
+    topic?: string;
+    priority?: "normal" | "high";
+    ttlSeconds?: number;
+    dryRun?: boolean;
+    authAppId?: string;
+}
+interface PushSendResult {
+    sent: boolean;
+    appId: string;
+    targetCount: number;
+    successCount: number;
+    failureCount: number;
+    invalidatedTokenCount: number;
+    dryRun: boolean;
+}
+interface SendEmailInput {
+    to: string | string[];
+    tag: string;
+    values?: Record<string, unknown>;
+    authAppId?: string;
+}
+interface EmailSendResult {
+    sent: boolean;
+    appId: string;
+    tag: string;
+    recipientCount: number;
+    acceptedCount: number;
+    rejectedCount: number;
+    includeVerificationLink?: boolean;
+    linkId?: string;
+    verifyUrl?: string;
+    messageId?: string;
+}
+interface VerifyEmailLinkInput {
+    token: string;
+    tag?: string;
+    email?: string;
+    authAppId?: string;
+}
+interface EmailLinkVerifyResult {
+    verified: boolean;
+    alreadyVerified: boolean;
+    appId: string;
+    linkId: string;
+    email: string;
+    tag: string;
+    verifiedAt?: string;
+    acceptedByUid?: string;
+}
 type AuthStateListener = (session: FlareAuthSession & FlareAuthUser | null) => void;
 type AuthConfigListener = (conf: FlareAuthConfig) => void;
 interface SubscribeOptions {
@@ -167,7 +259,7 @@ interface VectorSearchClause {
     metric?: "cosine" | "euclidean" | "dotProduct";
     minScore?: number;
 }
-/** Full structured query (Firestore + SQL feature set) */
+/** Full structured query (document query + SQL-style feature set) */
 interface StructuredQuery {
     where?: AnyFilter[];
     orderBy?: OrderByClause[];
@@ -781,6 +873,7 @@ declare class FlareAuth<TPresetMap extends QueryPresetMap = {}> extends FlareBas
     protected csrfInitPromise?: Promise<void>;
     protected csrfBootstrapAttempted: boolean;
     protected socketAuthSyncPromise?: Promise<void>;
+    protected pushServiceWorkerInitPromise?: Promise<ServiceWorkerRegistration | null>;
     protected authSession: FlareAuthSession | null;
     protected authStateListeners: AuthStateListener[];
     protected authConfigListeners: AuthConfigListener[];
@@ -977,6 +1070,39 @@ declare class FlareAuth<TPresetMap extends QueryPresetMap = {}> extends FlareBas
         email: string;
         sessionsRevoked?: number;
     }>;
+    private toUint8ArrayFromBase64Url;
+    private encodePushTokenFromSubscription;
+    private fetchPushSetupConfig;
+    setupPushServiceWorker(): Promise<ServiceWorkerRegistration | null>;
+    requestPushPermission(): Promise<NotificationPermission>;
+    acquireBrowserPushToken(options?: BrowserPushTokenOptions): Promise<{
+        token: string;
+        subscription: PushSubscription;
+    }>;
+    enableBrowserPush(options?: BrowserPushRegistrationOptions): Promise<{
+        registered: boolean;
+        appId: string;
+        uid: string;
+        token: string;
+        platform?: string;
+        subscription: PushSubscription;
+    }>;
+    registerPushToken(input: RegisterPushTokenInput): Promise<{
+        registered: boolean;
+        appId: string;
+        uid: string;
+        token: string;
+        platform?: string;
+    }>;
+    unregisterPushToken(token: string, authAppId?: string): Promise<{
+        unregistered: boolean;
+        appId: string;
+        token: string;
+        removed: boolean;
+    }>;
+    sendPushNotification(input: SendPushNotificationInput): Promise<PushSendResult>;
+    sendEmail(input: SendEmailInput): Promise<EmailSendResult>;
+    verifyEmailLink(input: VerifyEmailLinkInput): Promise<EmailLinkVerifyResult>;
     signIn(providerId: ProviderId, options?: {
         returnTo?: string;
         metaTag?: string;
@@ -1062,7 +1188,10 @@ declare class FlareAuth<TPresetMap extends QueryPresetMap = {}> extends FlareBas
  */
 
 declare class FlareClient<TPresetMap extends QueryPresetMap = {}> extends FlareAuth<TPresetMap> {
+    private autoPushRegisteredIdentity?;
     constructor(config: FlareConfig);
+    private enableAutoPushNotificationsAfterAuth;
+    autoEnablePushNotifications(): Promise<void>;
 }
 
 /**
@@ -1253,4 +1382,4 @@ declare const getFlare: () => FlareClient | null;
  */
 declare const disconnectFlare: () => void;
 
-export { type AggregateFunction, type AggregateSpec, type AnyFilter, type AuthConfigListener, type AuthConfigResponse, type AuthResult, type AuthStateListener, type AuthWithPendingVerificationResult, type AuthWithTokenResult, type BaseMessage, type ChangeEvent, type ChangeOperation, type CollectionPresetMethods, type CollectionQuery, CollectionReference, type ConnectionState, type CsrfProxyConfig, type CursorValue, type DocAddedCallback, type DocChangedCallback, type DocDeletedCallback, type DocUpdatedCallback, DocumentQueryBuilder, DocumentReference, type DocumentSnapshot, FlareAction, type FlareAuthConfig, type FlareAuthProviderId, type FlareAuthProviderPublicConfig, type FlareAuthSession, type FlareAuthUser, type FlareConfig, FlareError, FlareErrors, FlareEvent, FlareResponseCodes, type FlareRule, type GroupByClause, type HavingClause, type JoinClause, type JoinQueryPattern, type NestedJoinClause, type OfflineOperation, type OrFilter, type OrderByClause, type PresenceCallback, type PresenceJoinCallback, type PresenceLeaveCallback, type PresenceMember, type QueryConfig, type QueryOperator, type QueryPresetMap, type QueryPresetParams, type QueryPresetRow, type QueryPresetSpec, type QuerySnapshot, type RulePermission, type SecurityRuleEntry, type SecurityRulesMap, type SnapshotEvent, type StructuredJoinClause, type StructuredQuery, type SubscribeMessage, type SubscribeOptions, type SubscriptionCallback, type SubscriptionData, type SubscriptionError, type SubscriptionErrorCallback, type SubscriptionHandle, type VectorFieldConfig, type VectorSearchClause, type WhereCondition, buildFlareHeaders, connectApp, createCsrfProxy, createCsrfProxyHandler, FlareClient as default, disconnectFlare, extractCsrfFromRequest, flareRulesToSecurityMap, getFlare, parseValue, parseWhereCondition, securityMapToFlareRules };
+export { type AggregateFunction, type AggregateSpec, type AnyFilter, type AuthConfigListener, type AuthConfigResponse, type AuthResult, type AuthStateListener, type AuthWithPendingVerificationResult, type AuthWithTokenResult, type BaseMessage, type BrowserPushRegistrationOptions, type BrowserPushTokenOptions, type ChangeEvent, type ChangeOperation, type CollectionPresetMethods, type CollectionQuery, CollectionReference, type ConnectionState, type CsrfProxyConfig, type CursorValue, type DocAddedCallback, type DocChangedCallback, type DocDeletedCallback, type DocUpdatedCallback, DocumentQueryBuilder, DocumentReference, type DocumentSnapshot, type EmailLinkVerifyResult, type EmailSendResult, FlareAction, type FlareAuthConfig, type FlareAuthProviderId, type FlareAuthProviderPublicConfig, type FlareAuthSession, type FlareAuthUser, type FlareConfig, FlareError, FlareErrors, FlareEvent, FlareResponseCodes, type FlareRule, type GroupByClause, type HavingClause, type JoinClause, type JoinQueryPattern, type NestedJoinClause, type OfflineOperation, type OrFilter, type OrderByClause, type PresenceCallback, type PresenceJoinCallback, type PresenceLeaveCallback, type PresenceMember, type PushSendResult, type QueryConfig, type QueryOperator, type QueryPresetMap, type QueryPresetParams, type QueryPresetRow, type QueryPresetSpec, type QuerySnapshot, type RegisterPushTokenInput, type RulePermission, type SecurityRuleEntry, type SecurityRulesMap, type SendEmailInput, type SendPushNotificationInput, type SnapshotEvent, type StructuredJoinClause, type StructuredQuery, type SubscribeMessage, type SubscribeOptions, type SubscriptionCallback, type SubscriptionData, type SubscriptionError, type SubscriptionErrorCallback, type SubscriptionHandle, type VectorFieldConfig, type VectorSearchClause, type VerifyEmailLinkInput, type WhereCondition, buildFlareHeaders, connectApp, createCsrfProxy, createCsrfProxyHandler, FlareClient as default, disconnectFlare, extractCsrfFromRequest, flareRulesToSecurityMap, getFlare, parseValue, parseWhereCondition, securityMapToFlareRules };