@youversion/platform-core 0.8.1 → 0.9.0

package/src/SignInWithYouVersionPKCE.ts

@@ -1,5 +1,5 @@
 import { YouVersionPlatformConfiguration } from './YouVersionPlatformConfiguration';
-import type { SignInWithYouVersionPermissionValues } from './types/auth';
+import type { AuthenticationScopes } from './types';
 
 type SignInWithYouVersionPKCEParameters = {
   readonly codeVerifier: string;
@@ -15,8 +15,8 @@ type SignInWithYouVersionPKCEAuthorizationRequest = {
 export class SignInWithYouVersionPKCEAuthorizationRequestBuilder {
   public static async make(
     appKey: string,
-    permissions: Set<SignInWithYouVersionPermissionValues>,
     redirectURL: URL,
+    scopes?: AuthenticationScopes[],
   ): Promise<SignInWithYouVersionPKCEAuthorizationRequest> {
     const codeVerifier = this.randomURLSafeString(32);
     const codeChallenge = await this.codeChallenge(codeVerifier);
@@ -30,16 +30,16 @@ export class SignInWithYouVersionPKCEAuthorizationRequestBuilder {
       nonce,
     };
 
-    const url = this.authorizeURL(appKey, permissions, redirectURL, parameters);
+    const url = this.authorizeURL(appKey, redirectURL, parameters, scopes);
 
     return { url, parameters };
   }
 
   private static authorizeURL(
     appKey: string,
-    permissions: Set<SignInWithYouVersionPermissionValues>,
     redirectURL: URL,
     parameters: SignInWithYouVersionPKCEParameters,
+    scopes?: AuthenticationScopes[],
   ): URL {
     const components = new URL(`https://${YouVersionPlatformConfiguration.apiHost}/auth/authorize`);
 
@@ -61,7 +61,7 @@ export class SignInWithYouVersionPKCEAuthorizationRequestBuilder {
       queryParams.set('x-yvp-installation-id', installId);
     }
 
-    const scopeValue = this.scopeValue(permissions);
+    const scopeValue = this.scopeValue(scopes || []);
     if (scopeValue) {
       queryParams.set('scope', scopeValue);
     }
@@ -109,8 +109,8 @@ export class SignInWithYouVersionPKCEAuthorizationRequestBuilder {
     return base64.replace(/\+/g, '-').replace(/\//g, '_').replace(/=/g, '');
   }
 
-  private static scopeValue(permissions: Set<SignInWithYouVersionPermissionValues>): string | null {
-    const scopeArray = Array.from(permissions).sort();
+  private static scopeValue(scopes: AuthenticationScopes[]): string | null {
+    const scopeArray = Array.from(scopes).sort();
     let scopeWithOpenID = scopeArray.join(' ');
 
     if (!scopeWithOpenID.split(' ').includes('openid')) {

package/src/SignInWithYouVersionResult.ts

@@ -1,5 +1,3 @@
-import type { SignInWithYouVersionPermissionValues } from './types';
-
 export const SignInWithYouVersionPermission = {
   bibles: 'bibles',
   highlights: 'highlights',
@@ -13,7 +11,6 @@ type SignInWithYouVersionResultProps = {
   expiresIn?: number;
   refreshToken?: string;
   idToken?: string;
-  permissions?: SignInWithYouVersionPermissionValues[];
   yvpUserId?: string;
   name?: string;
   profilePicture?: string;
@@ -24,7 +21,6 @@ export class SignInWithYouVersionResult {
   public readonly expiryDate: Date | undefined;
   public readonly refreshToken: string | undefined;
   public readonly idToken: string | undefined;
-  public readonly permissions: SignInWithYouVersionPermissionValues[] | undefined;
   public readonly yvpUserId: string | undefined;
   public readonly name: string | undefined;
   public readonly profilePicture: string | undefined;
@@ -35,7 +31,6 @@ export class SignInWithYouVersionResult {
     expiresIn,
     refreshToken,
     idToken,
-    permissions,
     yvpUserId,
     name,
     profilePicture,
@@ -45,7 +40,6 @@ export class SignInWithYouVersionResult {
     this.expiryDate = expiresIn ? new Date(Date.now() + expiresIn * 1000) : new Date();
     this.refreshToken = refreshToken;
     this.idToken = idToken;
-    this.permissions = permissions;
     this.yvpUserId = yvpUserId;
     this.name = name;
     this.profilePicture = profilePicture;

package/src/Users.ts

@@ -1,25 +1,21 @@
-import type { SignInWithYouVersionPermissionValues } from './types';
+import type { AuthenticationScopes } from './types';
 import { YouVersionUserInfo } from './YouVersionUserInfo';
 import { YouVersionPlatformConfiguration } from './YouVersionPlatformConfiguration';
 import { SignInWithYouVersionPKCEAuthorizationRequestBuilder } from './SignInWithYouVersionPKCE';
 import { SignInWithYouVersionResult } from './SignInWithYouVersionResult';
-import { SignInWithYouVersionPermission } from './SignInWithYouVersionResult';
 
 export class YouVersionAPIUsers {
   /**
    * Presents the YouVersion login flow to the user and returns the login result upon completion.
    *
-   * This function authenticates the user with YouVersion, requesting the specified required and optional permissions.
+   * This function authenticates the user with YouVersion.
    * The function redirects to the YouVersion authorization URL and expects the callback to be handled separately.
    *
-   * @param permissions - The set of permissions that must be granted by the user for successful login.
+   * @param scopes - The scopes given to the authentication call.
    * @param redirectURL - The URL to redirect back to after authentication.
    * @throws An error if authentication fails or configuration is invalid.
    */
-  static async signIn(
-    permissions: Set<SignInWithYouVersionPermissionValues>,
-    redirectURL: string,
-  ): Promise<void> {
+  static async signIn(redirectURL: string, scopes?: AuthenticationScopes[]): Promise<void> {
     const appKey = YouVersionPlatformConfiguration.appKey;
     if (!appKey) {
       throw new Error('YouVersionPlatformConfiguration.appKey must be set before calling signIn');
@@ -27,8 +23,8 @@ export class YouVersionAPIUsers {
 
     const authorizationRequest = await SignInWithYouVersionPKCEAuthorizationRequestBuilder.make(
       appKey,
-      permissions,
       new URL(redirectURL),
+      scopes,
     );
 
     // Store auth data for callback handler
@@ -184,22 +180,11 @@ export class YouVersionAPIUsers {
   }): SignInWithYouVersionResult {
     const idClaims = this.decodeJWT(tokens.id_token);
 
-    const permissions = tokens.scope
-      .split(' ')
-      .map((p) => p.trim())
-      .filter((p) => p.length > 0)
-      .filter((p): p is SignInWithYouVersionPermissionValues =>
-        Object.values(SignInWithYouVersionPermission).includes(
-          p as SignInWithYouVersionPermissionValues,
-        ),
-      );
-
     const resultData = {
       accessToken: tokens.access_token,
       expiresIn: tokens.expires_in,
       refreshToken: tokens.refresh_token,
       idToken: tokens.id_token,
-      permissions,
       yvpUserId: idClaims.sub as string,
       name: idClaims.name as string,
       profilePicture: idClaims.profile_picture as string,
@@ -353,15 +338,6 @@ export class YouVersionAPIUsers {
         expiresIn: tokens.expires_in,
         refreshToken: tokens.refresh_token,
         idToken: existingIdToken,
-        permissions: tokens.scope
-          .split(' ')
-          .map((p) => p.trim())
-          .filter((p) => p.length > 0)
-          .filter((p): p is SignInWithYouVersionPermissionValues =>
-            Object.values(SignInWithYouVersionPermission).includes(
-              p as SignInWithYouVersionPermissionValues,
-            ),
-          ),
       });
 
       // Store updated tokens