palbase 0.16.0 → 0.17.0

package/types/internal/src/modules/notify.d.ts

@@ -45,6 +45,14 @@ export type DeliveryEvent = {
  * A device — never its token: a signed-in user's, or, with no one signed in on it, its installation's (user_id absent).
  */
 export type Device = {
+    /**
+     * The APNs environment an iOS token is for: the one its SDK said, or the one a push reached it through.
+     */
+    apns_environment?: "sandbox" | "production";
+    /**
+     * The project's app the device registered from: the one whose publishable key it presented. An iOS push goes to its bundle.
+     */
+    app_id?: string;
     app_version?: string;
     created_at: string;
     device_id: string;
@@ -80,6 +88,10 @@ export type DevicePage = {
  * A device's push token as the app's push SDK gave it: FCM's, APNs' (a PushKit VoIP token on ios_voip), Expo's (ExponentPushToken[…]), or a browser's push subscription (platform web: PushSubscription.toJSON(), its endpoint one of the browsers' push services). A token another device held moves here.
  */
 export type DeviceRegistration = {
+    /**
+     * The Apple Push Notification service environment an iOS token is for: sandbox (an app run from Xcode, a development-signed build) or production (TestFlight, the App Store, ad hoc). Palbase sends through it, to the bundle of the app whose publishable key registered the device. Absent: Palbase tries both and keeps the one that delivers.
+     */
+    apns_environment?: ("sandbox" | "production") | null;
     app_version?: string | null;
     /**
      * The app's own stable name for the device.
@@ -1957,6 +1969,14 @@ export type NotifyProvider = {
     active: boolean;
     channel: "email" | "sms" | "verify" | "whatsapp" | "push" | "iys";
     created_at: string;
+    /**
+     * Since when the provider's sends have failed for its own fault — its credential refused, a topic an APNs key may not send to: every send through it fails alike until it is fixed. A send to the app it failed for that goes through ends it, and so does saving it anew. Null while it works.
+     */
+    failing_since: string | null;
+    /**
+     * The provider's last such error (APNs error 403: InvalidProviderToken). Null while it works.
+     */
+    last_error: string | null;
     /**
      * Lower is tried first.
      */
@@ -1976,7 +1996,7 @@ export type NotifyProviderList = {
 export type NotifyProviderWrite = {
     active?: boolean;
     /**
-     * The provider's credentials, by channel. email — acs {connection_string, from_email}; ses {region, access_key_id, secret_access_key, from_domain}; sendgrid {api_key, from_domain, webhook_public_key: the signed Event Webhook's verification key, for delivery reports}; smtp {host, port, username, password, from_email, use_starttls}. sms — twilio {account_sid, auth_token or api_key_sid + api_key_secret, from_number or messaging_service_sid; with the auth token Twilio reports each text's delivery}; vonage {api_key, api_secret, from, signature_secret + signature_method (md5hash, md5, sha1, sha256, sha512) for its signed delivery receipts}; acs {connection_string, from_number}. verify — twilio_verify {account_sid, auth_token or api_key_sid + api_key_secret, service_sid}. whatsapp — meta {phone_number_id, access_token, api_version, app_secret + verify_token for its webhook}. push — fcm {the service account JSON}; apns {private_key, team_id, key_id, bundle_id, is_production}; expo {access_token}.
+     * The provider's credentials, by channel. email — acs {connection_string, from_email}; ses {region, access_key_id, secret_access_key, from_domain}; sendgrid {api_key, from_domain, webhook_public_key: the signed Event Webhook's verification key, for delivery reports}; smtp {host, port, username, password, from_email, use_starttls}. sms — twilio {account_sid, auth_token or api_key_sid + api_key_secret, from_number or messaging_service_sid; with the auth token Twilio reports each text's delivery}; vonage {api_key, api_secret, from, signature_secret + signature_method (md5hash, md5, sha1, sha256, sha512) for its signed delivery receipts}; acs {connection_string, from_number}. verify — twilio_verify {account_sid, auth_token or api_key_sid + api_key_secret, service_sid}. whatsapp — meta {phone_number_id, access_token, api_version, app_secret + verify_token for its webhook}. push — fcm {the service account JSON}; apns {private_key, team_id, key_id: a team-scoped APNs key, asked of Apple when saved; bundle_id and is_production optional — a push goes to the bundle of the app the device registered from, through the APNs environment it said}; expo {access_token}.
      */
     credentials: {
         [key: string]: unknown;
@@ -2095,11 +2115,40 @@ export type PushDelivery = {
     platform: string;
     provider: string;
     provider_message_id?: string;
+    /**
+     * Where an APNs push went: its environment and the app's bundle (production com.centauri).
+     */
+    route?: string;
     /**
      * The furthest it got.
      */
     status: "sent" | "failed" | "token_invalid" | "delivered" | "not_shown" | "dismissed" | "opened" | "action" | "unconfirmed";
 };
+/**
+ * notification.push_failing: a push provider that has started failing for its own fault.
+ */
+export type PushFailingEvent = {
+    /**
+     * push.
+     */
+    channel: string;
+    /**
+     * The provider's error (APNs error 403: InvalidProviderToken).
+     */
+    error: string;
+    /**
+     * When it started failing.
+     */
+    failing_since: string;
+    /**
+     * The project whose provider it is: the platform's own copy names the customer's.
+     */
+    project_id: string;
+    /**
+     * apns, fcm or expo.
+     */
+    provider: string;
+};
 /**
  * One report from the app about a push on this device.
  */
@@ -2685,6 +2734,10 @@ export interface Events {
      * notification.opened: the person opened a push.
      */
     "notification.opened": NotificationEvent;
+    /**
+     * notification.push_failing: a push provider has started failing for its own fault — its APNs key refused, a topic the key may not send to — and every push through it fails until its setting is fixed. Told to the project and to the platform's own (whose Studio mails the organization's owners), at most once a day a provider.
+     */
+    "notification.push_failing": PushFailingEvent;
     /**
      * notification.read: the recipient read it (WhatsApp).
      */