Add isSandbox, handleExpiredPushTokens and handlePushTokenErrors (#113)

.changeset/chilled-ties-build.md

@@ -0,0 +1,6 @@
+---
+"@zemble/core": patch
+"@zemble/push-apple": patch
+---
+
+Add isSandbox, handleExpiredPushTokens and handlePushTokenErrors

packages/core/types.ts

@@ -90,18 +90,18 @@ export interface PushMessage {
   readonly launchImageName?: string;
 }
 
-export type PushTokenWithContents<TPush> = {
+export type PushTokenWithContents<TPush extends AnyPushTokenWithMetadata> = {
   readonly pushToken: TPush
   readonly contents: PushMessage | LiveActivityPushProps | Record<string, JSON>
 }
 
-export type PushTokenWithContentsAndTicket<TPush> = PushTokenWithContents<TPush> & { readonly ticketId: string }
+export type PushTokenWithContentsAndTicket<TPush extends AnyPushTokenWithMetadata> = PushTokenWithContents<TPush> & { readonly ticketId: string }
 
-export type PushTokenWithContentsAndTicketAndLiveActivityId<TPush> = PushTokenWithContents<TPush> & { readonly ticketId: string, readonly liveActivityId: string }
+export type PushTokenWithContentsAndTicketAndLiveActivityId<TPush extends AnyPushTokenWithMetadata> = PushTokenWithContents<TPush> & { readonly ticketId: string, readonly liveActivityId: string }
 
-export type PushTokenWithContentsAndFailedReason<TPush> = PushTokenWithContents<TPush> & { readonly failedReason: string }
+export type PushTokenWithContentsAndFailedReason<TPush extends AnyPushTokenWithMetadata> = PushTokenWithContents<TPush> & { readonly failedReason: string }
 
-export interface SendPushResponse<TPush, TSuccess = PushTokenWithContentsAndTicket<TPush>> {
+export interface SendPushResponse<TPush extends AnyPushTokenWithMetadata, TSuccess = PushTokenWithContentsAndTicket<TPush>> {
   readonly failedSendsToRemoveTokensFor: readonly TPush[]
   readonly failedSendsOthers: readonly PushTokenWithContentsAndFailedReason<TPush>[]
   readonly successfulSends: readonly TSuccess[]
@@ -127,11 +127,11 @@ export type SendSilentPushProvider = (
   pushTokens: readonly PushTokenWithMetadata[],
   data: Record<string, JSON>
 ) => PromiseOrValue<SendPushResponse<PushTokenWithMetadata>>
-export type SendStartLiveActivityPushProvider<TPush = PushTokenForStartingLiveActivityWithMetadata> = (
+export type SendStartLiveActivityPushProvider<TPush extends PushTokenForStartingLiveActivityWithMetadata = PushTokenForStartingLiveActivityWithMetadata> = (
   pushTokens: readonly TPush[],
   liveActivity: Omit<LiveActivityPushProps, 'event'> & PushMessage
 ) => PromiseOrValue<SendPushResponse<TPush>>
-export type SendUpdateLiveActivityPushProvider<TPush = PushTokenForUpdatingLiveActivityWithMetadata> = (
+export type SendUpdateLiveActivityPushProvider<TPush extends PushTokenForUpdatingLiveActivityWithMetadata = PushTokenForUpdatingLiveActivityWithMetadata> = (
   pushTokens: readonly TPush[],
   liveActivity: Omit<LiveActivityPushProps, 'attributesType' | 'attributes'>
 ) => PromiseOrValue<SendPushResponse<TPush>>
@@ -267,10 +267,13 @@ export interface BaseToken extends JWTPayload
   readonly sub: string
 }
 
+// eslint-disable-next-line @typescript-eslint/no-redundant-type-constituents
 export type TokenContents = Zemble.TokenRegistry[keyof Zemble.TokenRegistry] & BaseToken | BaseToken
 export type PushTokenWithMetadata = Zemble.PushTokenRegistry[keyof Zemble.PushTokenRegistry]
 export type PushTokenForStartingLiveActivityWithMetadata = Zemble.PushTokenStartLiveActivityRegistry[keyof Zemble.PushTokenStartLiveActivityRegistry]
 export type PushTokenForUpdatingLiveActivityWithMetadata = Zemble.PushTokenUpdateLiveActivityRegistry[keyof Zemble.PushTokenUpdateLiveActivityRegistry]
+// eslint-disable-next-line @typescript-eslint/no-duplicate-type-constituents, @typescript-eslint/no-redundant-type-constituents
+export type AnyPushTokenWithMetadata = PushTokenWithMetadata | PushTokenForStartingLiveActivityWithMetadata | PushTokenForUpdatingLiveActivityWithMetadata
 
 export type Dependency = {
   // eslint-disable-next-line @typescript-eslint/no-explicit-any

packages/push-apple/graphql/Mutation/registerApplePushToken.ts

@@ -1,13 +1,17 @@
 import pushExpoPlugin from '../../plugin'
 
+import type { ApplePushTokenWithMetadata } from '../../types'
 import type { MutationResolvers } from '../schema.generated'
 
-const registerApplePushToken: MutationResolvers['registerApplePushToken'] = async (_, { platform, token, appBundleId }, { decodedToken }) => {
-  const pushTokenWithMetadata: Zemble.ApplePushTokenWithMetadata = {
+const registerApplePushToken: MutationResolvers['registerApplePushToken'] = async (_, {
+  platform, token, appBundleId, isSandbox,
+}, { decodedToken }) => {
+  const pushTokenWithMetadata: ApplePushTokenWithMetadata = {
     type: 'APPLE',
     platform,
     pushToken: token,
     appBundleId,
+    isSandbox: isSandbox ?? false,
   }
 
   await pushExpoPlugin.config.persistPushToken(decodedToken!, pushTokenWithMetadata)

packages/push-apple/graphql/Mutation/registerAppleStartLiveActivityPushToken.ts

@@ -1,14 +1,17 @@
 import pushExpoPlugin from '../../plugin'
 import { ApplePushPlatform, type MutationResolvers } from '../schema.generated'
 
+import type { AppleStartLiveActivityPushTokenWithMetadata } from '../../types'
+
 const registerAppleStartLiveActivityPushToken: MutationResolvers['registerAppleStartLiveActivityPushToken'] = async (_, {
-  token, appBundleId,
+  token, appBundleId, isSandbox,
 }, { decodedToken }) => {
-  const pushTokenWithMetadata: Zemble.AppleStartLiveActivityPushTokenWithMetadata = {
+  const pushTokenWithMetadata: AppleStartLiveActivityPushTokenWithMetadata = {
     type: 'APPLE_START_LIVE_ACTIVITY',
     platform: ApplePushPlatform.Ios,
     pushToken: token,
     appBundleId,
+    isSandbox: isSandbox ?? false,
   }
 
   await pushExpoPlugin.config.persistPushToken(decodedToken!, pushTokenWithMetadata)

packages/push-apple/graphql/Mutation/registerAppleUpdateLiveActivityPushToken.ts

@@ -1,14 +1,17 @@
 import pushExpoPlugin from '../../plugin'
 import { ApplePushPlatform, type MutationResolvers } from '../schema.generated'
 
+import type { AppleUpdateLiveActivityPushTokenWithMetadata } from '../../types'
+
 const registerAppleUpdateLiveActivityPushToken: MutationResolvers['registerAppleUpdateLiveActivityPushToken'] = async (_, {
-  token, appBundleId,
+  token, appBundleId, isSandbox,
 }, { decodedToken }) => {
-  const pushTokenWithMetadata: Zemble.AppleUpdateLiveActivityPushTokenWithMetadata = {
+  const pushTokenWithMetadata: AppleUpdateLiveActivityPushTokenWithMetadata = {
     type: 'APPLE_UPDATE_LIVE_ACTIVITY',
     platform: ApplePushPlatform.Ios,
     pushToken: token,
     appBundleId,
+    isSandbox: isSandbox ?? false,
   }
 
   await pushExpoPlugin.config.persistPushToken(decodedToken!, pushTokenWithMetadata)

packages/push-apple/graphql/schema.generated.ts

@@ -41,20 +41,22 @@ export type Mutation = {
 
 export type MutationRegisterApplePushTokenArgs = {
   appBundleId: Scalars['String']['input'];
+  isSandbox?: InputMaybe<Scalars['Boolean']['input']>;
   platform: ApplePushPlatform;
   token: Scalars['String']['input'];
 };
 
 
 export type MutationRegisterAppleStartLiveActivityPushTokenArgs = {
   appBundleId: Scalars['String']['input'];
+  isSandbox?: InputMaybe<Scalars['Boolean']['input']>;
   token: Scalars['String']['input'];
 };
 
 
 export type MutationRegisterAppleUpdateLiveActivityPushTokenArgs = {
   appBundleId: Scalars['String']['input'];
-  liveActivityAttributes: Scalars['JSONObject']['input'];
+  isSandbox?: InputMaybe<Scalars['Boolean']['input']>;
   liveActivityType: Scalars['String']['input'];
   token: Scalars['String']['input'];
 };

packages/push-apple/graphql/schema.graphql

@@ -7,11 +7,21 @@ enum ApplePushPlatform {
 }
 
 type Mutation {
-  registerApplePushToken(token: String!, platform: ApplePushPlatform!, appBundleId: String!): Boolean!
-  registerAppleStartLiveActivityPushToken(token: String!, appBundleId: String!): Boolean!
+  registerApplePushToken(
+    token: String!,
+    platform: ApplePushPlatform!,
+    appBundleId: String!,
+    isSandbox: Boolean
+  ): Boolean!
+  registerAppleStartLiveActivityPushToken(
+    token: String!,
+    appBundleId: String!,
+    isSandbox: Boolean
+  ): Boolean!
   registerAppleUpdateLiveActivityPushToken(
     token: String!,
     appBundleId: String!,
     liveActivityType: String!
+    isSandbox: Boolean
   ): Boolean!
 }