@dataemergencia/emergency 0.2.1 → 0.4.0

package/dist/index.d.cts

@@ -101,6 +101,17 @@ interface EmergencyGeolocation {
   readonly longitude: number;
   readonly accuracy?: number;
 }
+interface EmergencyRealtimeConfig {
+  /** Public Pusher app key supplied by the host. */
+  readonly key: string;
+  /** Pusher cluster that serves the app key. */
+  readonly cluster: string;
+  /**
+   * Channel name pattern. `{phone}` is replaced with the responder phone in
+   * digits-only form. Defaults to `whatsapp.{phone}`.
+   */
+  readonly channelPattern?: string;
+}
 interface EmergencyConfig {
   /** Full BFF route prefix, for example `https://example.com/de-bff/emergency`. */
   readonly bffBaseUrl: string;
@@ -122,6 +133,11 @@ interface EmergencyConfig {
   readonly geolocationTimeoutMs?: number;
   /** Request timeout in milliseconds. Defaults to 15000. */
   readonly requestTimeoutMs?: number;
+  /**
+   * Public Pusher values supplied by the host. When omitted, the client stays
+   * in pull mode and never opens a realtime connection.
+   */
+  readonly realtime?: EmergencyRealtimeConfig;
 }
 interface EmergencySnapshot {
   readonly emergencyId: string;
@@ -239,18 +255,8 @@ interface EmergencyMountOptions extends EmergencyConfig {
  * message, and an inert client.
  */
 export declare function mount(options: EmergencyMountOptions): EmergencyClient;
-interface RealtimePusherConfig {
-  readonly key: string;
-  readonly cluster: string;
-  readonly channel_pattern: string;
-}
-interface RealtimePublicConfig {
-  readonly mode: 'public';
-  readonly pusher: RealtimePusherConfig;
-}
 interface ConfigResponse {
   readonly route_prefix: string;
-  readonly realtime: RealtimePublicConfig;
   readonly csrf_token: string;
 }
 interface SessionResponse {
@@ -292,7 +298,6 @@ type EmergencyPayload = Readonly<Record<string, unknown>>;
 interface CurrentResponse {
   readonly active: boolean;
   readonly emergency: EmergencyPayload | null;
-  readonly realtime: RealtimePublicConfig;
 }
 interface GeolocationRequest {
   readonly latitude: number;
@@ -377,7 +382,7 @@ interface RealtimeProvider {
    * Returns `null` when the realtime configuration is unusable, in which case
    * the client keeps working in pull mode.
    */
-  subscribe(config: RealtimePublicConfig, phones: readonly string[], handlers: RealtimeHandlers): RealtimeSubscription | null;
+  subscribe(config: EmergencyRealtimeConfig, phones: readonly string[], handlers: RealtimeHandlers): RealtimeSubscription | null;
 }
 export declare function createPusherRealtimeProvider(): RealtimeProvider;
 type EmergencyStore = StoreApi<EmergencyClientState>;
@@ -409,7 +414,10 @@ interface ConfigValidationResult {
   readonly error: EmergencyError | null;
   readonly config: EmergencyConfig | null;
 }
-export declare function validateConfig(config: EmergencyConfig): ConfigValidationResult;
+type EmergencyConfigInput = Omit<EmergencyConfig, 'realtime'> & {
+  readonly realtime?: unknown;
+};
+export declare function validateConfig(config: EmergencyConfigInput): ConfigValidationResult;
 export declare function themeToCssVariables(theme: EmergencyTheme | undefined): Record<string, string>;
 interface EmergencyErrorOptions {
   status?: number | null;
@@ -428,5 +436,5 @@ export declare class EmergencyClientError extends Error {
   readonly error: EmergencyError;
   constructor(error: EmergencyError);
 }
-export type { AbortResponse, AbortResult, ActivateRequest, BffClient, BffClientOptions, ConfigResponse, CsrfStrategy, CurrentResponse, EmergencyClient, EmergencyClientState, EmergencyConfig, EmergencyController, EmergencyControllerDeps, EmergencyError, EmergencyErrorCode, EmergencyEventEmitter, EmergencyEventMap, EmergencyEventName, EmergencyFailure, EmergencyFallback, EmergencyFontFamilyFlags, EmergencyFontLoading, EmergencyGeolocation, EmergencyMountOptions, EmergencyOperation, EmergencyPhase, EmergencyPhaseName, EmergencyResultPayload, EmergencySnapshot, EmergencyStore, EmergencyTheme, EmergencyTrigger, FailurePayload, Message, MessageKind, PanelCloseReason, PanelOpenReason, RealtimeStatus, RefreshResponse, Responder, ResponderPayload, ResponderStatus, SessionResponse, SimulationResult };
+export type { AbortResponse, AbortResult, ActivateRequest, BffClient, BffClientOptions, ConfigResponse, CsrfStrategy, CurrentResponse, EmergencyClient, EmergencyClientState, EmergencyConfig, EmergencyConfigInput, EmergencyController, EmergencyControllerDeps, EmergencyError, EmergencyErrorCode, EmergencyEventEmitter, EmergencyEventMap, EmergencyEventName, EmergencyFailure, EmergencyFallback, EmergencyFontFamilyFlags, EmergencyFontLoading, EmergencyGeolocation, EmergencyMountOptions, EmergencyOperation, EmergencyPhase, EmergencyPhaseName, EmergencyRealtimeConfig, EmergencyResultPayload, EmergencySnapshot, EmergencyStore, EmergencyTheme, EmergencyTrigger, FailurePayload, Message, MessageKind, PanelCloseReason, PanelOpenReason, RealtimeStatus, RefreshResponse, Responder, ResponderPayload, ResponderStatus, SessionResponse, SimulationResult };
 //# sourceMappingURL=index.d.cts.map

package/dist/index.d.ts

@@ -101,6 +101,17 @@ interface EmergencyGeolocation {
   readonly longitude: number;
   readonly accuracy?: number;
 }
+interface EmergencyRealtimeConfig {
+  /** Public Pusher app key supplied by the host. */
+  readonly key: string;
+  /** Pusher cluster that serves the app key. */
+  readonly cluster: string;
+  /**
+   * Channel name pattern. `{phone}` is replaced with the responder phone in
+   * digits-only form. Defaults to `whatsapp.{phone}`.
+   */
+  readonly channelPattern?: string;
+}
 interface EmergencyConfig {
   /** Full BFF route prefix, for example `https://example.com/de-bff/emergency`. */
   readonly bffBaseUrl: string;
@@ -122,6 +133,11 @@ interface EmergencyConfig {
   readonly geolocationTimeoutMs?: number;
   /** Request timeout in milliseconds. Defaults to 15000. */
   readonly requestTimeoutMs?: number;
+  /**
+   * Public Pusher values supplied by the host. When omitted, the client stays
+   * in pull mode and never opens a realtime connection.
+   */
+  readonly realtime?: EmergencyRealtimeConfig;
 }
 interface EmergencySnapshot {
   readonly emergencyId: string;
@@ -239,18 +255,8 @@ interface EmergencyMountOptions extends EmergencyConfig {
  * message, and an inert client.
  */
 export declare function mount(options: EmergencyMountOptions): EmergencyClient;
-interface RealtimePusherConfig {
-  readonly key: string;
-  readonly cluster: string;
-  readonly channel_pattern: string;
-}
-interface RealtimePublicConfig {
-  readonly mode: 'public';
-  readonly pusher: RealtimePusherConfig;
-}
 interface ConfigResponse {
   readonly route_prefix: string;
-  readonly realtime: RealtimePublicConfig;
   readonly csrf_token: string;
 }
 interface SessionResponse {
@@ -292,7 +298,6 @@ type EmergencyPayload = Readonly<Record<string, unknown>>;
 interface CurrentResponse {
   readonly active: boolean;
   readonly emergency: EmergencyPayload | null;
-  readonly realtime: RealtimePublicConfig;
 }
 interface GeolocationRequest {
   readonly latitude: number;
@@ -377,7 +382,7 @@ interface RealtimeProvider {
    * Returns `null` when the realtime configuration is unusable, in which case
    * the client keeps working in pull mode.
    */
-  subscribe(config: RealtimePublicConfig, phones: readonly string[], handlers: RealtimeHandlers): RealtimeSubscription | null;
+  subscribe(config: EmergencyRealtimeConfig, phones: readonly string[], handlers: RealtimeHandlers): RealtimeSubscription | null;
 }
 export declare function createPusherRealtimeProvider(): RealtimeProvider;
 type EmergencyStore = StoreApi<EmergencyClientState>;
@@ -409,7 +414,10 @@ interface ConfigValidationResult {
   readonly error: EmergencyError | null;
   readonly config: EmergencyConfig | null;
 }
-export declare function validateConfig(config: EmergencyConfig): ConfigValidationResult;
+type EmergencyConfigInput = Omit<EmergencyConfig, 'realtime'> & {
+  readonly realtime?: unknown;
+};
+export declare function validateConfig(config: EmergencyConfigInput): ConfigValidationResult;
 export declare function themeToCssVariables(theme: EmergencyTheme | undefined): Record<string, string>;
 interface EmergencyErrorOptions {
   status?: number | null;
@@ -428,5 +436,5 @@ export declare class EmergencyClientError extends Error {
   readonly error: EmergencyError;
   constructor(error: EmergencyError);
 }
-export type { AbortResponse, AbortResult, ActivateRequest, BffClient, BffClientOptions, ConfigResponse, CsrfStrategy, CurrentResponse, EmergencyClient, EmergencyClientState, EmergencyConfig, EmergencyController, EmergencyControllerDeps, EmergencyError, EmergencyErrorCode, EmergencyEventEmitter, EmergencyEventMap, EmergencyEventName, EmergencyFailure, EmergencyFallback, EmergencyFontFamilyFlags, EmergencyFontLoading, EmergencyGeolocation, EmergencyMountOptions, EmergencyOperation, EmergencyPhase, EmergencyPhaseName, EmergencyResultPayload, EmergencySnapshot, EmergencyStore, EmergencyTheme, EmergencyTrigger, FailurePayload, Message, MessageKind, PanelCloseReason, PanelOpenReason, RealtimeStatus, RefreshResponse, Responder, ResponderPayload, ResponderStatus, SessionResponse, SimulationResult };
+export type { AbortResponse, AbortResult, ActivateRequest, BffClient, BffClientOptions, ConfigResponse, CsrfStrategy, CurrentResponse, EmergencyClient, EmergencyClientState, EmergencyConfig, EmergencyConfigInput, EmergencyController, EmergencyControllerDeps, EmergencyError, EmergencyErrorCode, EmergencyEventEmitter, EmergencyEventMap, EmergencyEventName, EmergencyFailure, EmergencyFallback, EmergencyFontFamilyFlags, EmergencyFontLoading, EmergencyGeolocation, EmergencyMountOptions, EmergencyOperation, EmergencyPhase, EmergencyPhaseName, EmergencyRealtimeConfig, EmergencyResultPayload, EmergencySnapshot, EmergencyStore, EmergencyTheme, EmergencyTrigger, FailurePayload, Message, MessageKind, PanelCloseReason, PanelOpenReason, RealtimeStatus, RefreshResponse, Responder, ResponderPayload, ResponderStatus, SessionResponse, SimulationResult };
 //# sourceMappingURL=index.d.ts.map