@youversion/platform-core 0.8.2 → 0.9.0

package/dist/index.d.ts

@@ -18,9 +18,9 @@ declare const BibleVersionSchema: z.ZodObject<{
 type BibleVersion = z.infer<typeof BibleVersionSchema>;
 
 declare const CanonSchema: z.ZodEnum<{
-    ot: "ot";
-    nt: "nt";
-    dc: "dc";
+    old_testament: "old_testament";
+    new_testament: "new_testament";
+    deuterocanon: "deuterocanon";
 }>;
 type Canon = z.infer<typeof CanonSchema>;
 declare const BookUsfmSchema: z.ZodUnion<readonly [...z.ZodLiteral<"GEN" | "EXO" | "LEV" | "NUM" | "DEU" | "JOS" | "JDG" | "RUT" | "1SA" | "2SA" | "1KI" | "2KI" | "1CH" | "2CH" | "EZR" | "NEH" | "EST" | "JOB" | "PSA" | "PRO" | "ECC" | "SNG" | "ISA" | "JER" | "LAM" | "EZK" | "DAN" | "HOS" | "JOL" | "AMO" | "OBA" | "JON" | "MIC" | "NAM" | "HAB" | "ZEP" | "HAG" | "ZEC" | "MAL" | "MAT" | "MRK" | "LUK" | "JHN" | "ACT" | "ROM" | "1CO" | "2CO" | "GAL" | "EPH" | "PHP" | "COL" | "1TH" | "2TH" | "1TI" | "2TI" | "TIT" | "PHM" | "HEB" | "JAS" | "1PE" | "2PE" | "1JN" | "2JN" | "3JN" | "JUD" | "REV" | "TOB" | "JDT" | "ESG" | "WIS" | "SIR" | "BAR" | "LJE" | "S3Y" | "SUS" | "BEL" | "1MA" | "2MA" | "3MA" | "4MA" | "1ES" | "2ES" | "MAN" | "PS2" | "ODA" | "PSS" | "3ES" | "EZA" | "5EZ" | "6EZ" | "DAG" | "PS3" | "2BA" | "LBA" | "JUB" | "ENO" | "1MQ" | "2MQ" | "3MQ" | "REP" | "4BA" | "LAO" | "LKA">[], z.ZodType<string & {}, unknown, z.core.$ZodTypeInternals<string & {}, unknown>>]>;
@@ -31,9 +31,9 @@ declare const BibleBookSchema: z.ZodObject<{
     full_title: z.ZodString;
     abbreviation: z.ZodOptional<z.ZodString>;
     canon: z.ZodEnum<{
-        ot: "ot";
-        nt: "nt";
-        dc: "dc";
+        old_testament: "old_testament";
+        new_testament: "new_testament";
+        deuterocanon: "deuterocanon";
     }>;
     chapters: z.ZodOptional<z.ZodArray<z.ZodObject<{
         id: z.ZodString;
@@ -101,9 +101,9 @@ declare const BibleIndexBookSchema: z.ZodObject<{
     full_title: z.ZodString;
     abbreviation: z.ZodString;
     canon: z.ZodEnum<{
-        ot: "ot";
-        nt: "nt";
-        dc: "dc";
+        old_testament: "old_testament";
+        new_testament: "new_testament";
+        deuterocanon: "deuterocanon";
     }>;
     chapters: z.ZodArray<z.ZodObject<{
         id: z.ZodString;
@@ -123,9 +123,9 @@ declare const _BibleIndexSchema: z.ZodObject<{
         full_title: z.ZodString;
         abbreviation: z.ZodString;
         canon: z.ZodEnum<{
-            ot: "ot";
-            nt: "nt";
-            dc: "dc";
+            old_testament: "old_testament";
+            new_testament: "new_testament";
+            deuterocanon: "deuterocanon";
         }>;
         chapters: z.ZodArray<z.ZodObject<{
             id: z.ZodString;
@@ -209,7 +209,6 @@ type SignInWithYouVersionResultProps = {
     expiresIn?: number;
     refreshToken?: string;
     idToken?: string;
-    permissions?: SignInWithYouVersionPermissionValues[];
     yvpUserId?: string;
     name?: string;
     profilePicture?: string;
@@ -220,12 +219,11 @@ declare class SignInWithYouVersionResult {
     readonly expiryDate: Date | undefined;
     readonly refreshToken: string | undefined;
     readonly idToken: string | undefined;
-    readonly permissions: SignInWithYouVersionPermissionValues[] | undefined;
     readonly yvpUserId: string | undefined;
     readonly name: string | undefined;
     readonly profilePicture: string | undefined;
     readonly email: string | undefined;
-    constructor({ accessToken, expiresIn, refreshToken, idToken, permissions, yvpUserId, name, profilePicture, email, }: SignInWithYouVersionResultProps);
+    constructor({ accessToken, expiresIn, refreshToken, idToken, yvpUserId, name, profilePicture, email, }: SignInWithYouVersionResultProps);
 }
 
 type SignInWithYouVersionPermissionValues = (typeof SignInWithYouVersionPermission)[keyof typeof SignInWithYouVersionPermission];
@@ -237,6 +235,7 @@ interface AuthenticationState {
     result: SignInWithYouVersionResult | null;
     error: Error | null;
 }
+type AuthenticationScopes = 'profile' | 'email';
 
 /**
  * Legacy type for highlight colors (constants only)
@@ -337,7 +336,7 @@ declare class BibleClient {
     /**
      * Fetches all books for a given Bible version.
      * @param versionId The version ID.
-     * @param canon Optional canon filter ('ot', 'nt', 'deuterocanon').
+     * @param canon Optional canon filter ("old_testament", 'new_testament', 'deuterocanon').
      * @returns An array of BibleBook objects.
      */
     getBooks(versionId: number, canon?: CANON): Promise<Collection<BibleBook>>;
@@ -593,14 +592,14 @@ declare 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 signIn(permissions: Set<SignInWithYouVersionPermissionValues>, redirectURL: string): Promise<void>;
+    static signIn(redirectURL: string, scopes?: AuthenticationScopes[]): Promise<void>;
     /**
      * Handles the OAuth callback after user authentication.
      *
@@ -668,11 +667,6 @@ declare class YouVersionAPI {
     static addStandardHeaders(url: URL): Request;
 }
 
-declare class URLBuilder {
-    private static get baseURL();
-    static authURL(appKey: string, requiredPermissions?: Set<SignInWithYouVersionPermissionValues>, optionalPermissions?: Set<SignInWithYouVersionPermissionValues>): URL;
-}
-
 /**
  * Security Note: Tokens are stored in localStorage for persistence.
  * Ensure your application follows XSS prevention best practices:
@@ -712,4 +706,4 @@ declare const BOOK_IDS: readonly ["GEN", "EXO", "LEV", "NUM", "DEU", "JOS", "JDG
  */
 declare const BOOK_CANON: Record<BookUsfm, Canon>;
 
-export { ApiClient, type ApiConfig, type AuthenticationState, BOOK_CANON, BOOK_IDS, type BibleBook, type BibleChapter, BibleClient, type BibleIndex, type BibleIndexBook, type BibleIndexChapter, type BibleIndexVerse, type BiblePassage, type BibleVerse, type BibleVersion, type CANON, type Collection, type CreateHighlight, type DeleteHighlightOptions, type GetHighlightsOptions, type GetLanguagesOptions, type Highlight, type HighlightColor, HighlightsClient, type Language, LanguagesClient, MemoryStorageStrategy, SessionStorageStrategy, SignInWithYouVersionPermission, type SignInWithYouVersionPermissionValues, SignInWithYouVersionResult, type StorageStrategy, URLBuilder, type User, type VOTD, YouVersionAPI, YouVersionAPIUsers, YouVersionPlatformConfiguration, YouVersionUserInfo, type YouVersionUserInfoJSON };
+export { ApiClient, type ApiConfig, type AuthenticationScopes, type AuthenticationState, BOOK_CANON, BOOK_IDS, type BibleBook, type BibleChapter, BibleClient, type BibleIndex, type BibleIndexBook, type BibleIndexChapter, type BibleIndexVerse, type BiblePassage, type BibleVerse, type BibleVersion, type CANON, type Collection, type CreateHighlight, type DeleteHighlightOptions, type GetHighlightsOptions, type GetLanguagesOptions, type Highlight, type HighlightColor, HighlightsClient, type Language, LanguagesClient, MemoryStorageStrategy, SessionStorageStrategy, SignInWithYouVersionPermission, type SignInWithYouVersionPermissionValues, SignInWithYouVersionResult, type StorageStrategy, type User, type VOTD, YouVersionAPI, YouVersionAPIUsers, YouVersionPlatformConfiguration, YouVersionUserInfo, type YouVersionUserInfoJSON };

package/dist/index.js

@@ -192,7 +192,7 @@ var BibleClient = class {
   /**
    * Fetches all books for a given Bible version.
    * @param versionId The version ID.
-   * @param canon Optional canon filter ('ot', 'nt', 'deuterocanon').
+   * @param canon Optional canon filter ("old_testament", 'new_testament', 'deuterocanon').
    * @returns An array of BibleBook objects.
    */
   async getBooks(versionId, canon) {
@@ -692,7 +692,7 @@ var YouVersionUserInfo = class {
 
 // src/SignInWithYouVersionPKCE.ts
 var SignInWithYouVersionPKCEAuthorizationRequestBuilder = class {
-  static async make(appKey, permissions, redirectURL) {
+  static async make(appKey, redirectURL, scopes) {
     const codeVerifier = this.randomURLSafeString(32);
     const codeChallenge = await this.codeChallenge(codeVerifier);
     const state = this.randomURLSafeString(24);
@@ -703,10 +703,10 @@ var SignInWithYouVersionPKCEAuthorizationRequestBuilder = class {
       state,
       nonce
     };
-    const url = this.authorizeURL(appKey, permissions, redirectURL, parameters);
+    const url = this.authorizeURL(appKey, redirectURL, parameters, scopes);
     return { url, parameters };
   }
-  static authorizeURL(appKey, permissions, redirectURL, parameters) {
+  static authorizeURL(appKey, redirectURL, parameters, scopes) {
     const components = new URL(`https://${YouVersionPlatformConfiguration.apiHost}/auth/authorize`);
     const redirectUrlString = redirectURL.toString().endsWith("/") ? redirectURL.toString().slice(0, -1) : redirectURL.toString();
     const queryParams = new URLSearchParams({
@@ -722,7 +722,7 @@ var SignInWithYouVersionPKCEAuthorizationRequestBuilder = class {
     if (installId) {
       queryParams.set("x-yvp-installation-id", installId);
     }
-    const scopeValue = this.scopeValue(permissions);
+    const scopeValue = this.scopeValue(scopes || []);
     if (scopeValue) {
       queryParams.set("scope", scopeValue);
     }
@@ -762,8 +762,8 @@ var SignInWithYouVersionPKCEAuthorizationRequestBuilder = class {
     const base64 = btoa(String.fromCharCode.apply(null, Array.from(data)));
     return base64.replace(/\+/g, "-").replace(/\//g, "_").replace(/=/g, "");
   }
-  static scopeValue(permissions) {
-    const scopeArray = Array.from(permissions).sort();
+  static scopeValue(scopes) {
+    const scopeArray = Array.from(scopes).sort();
     let scopeWithOpenID = scopeArray.join(" ");
     if (!scopeWithOpenID.split(" ").includes("openid")) {
       scopeWithOpenID += (scopeWithOpenID === "" ? "" : " ") + "openid";
@@ -785,7 +785,6 @@ var SignInWithYouVersionResult = class {
   expiryDate;
   refreshToken;
   idToken;
-  permissions;
   yvpUserId;
   name;
   profilePicture;
@@ -795,7 +794,6 @@ var SignInWithYouVersionResult = class {
     expiresIn,
     refreshToken,
     idToken,
-    permissions,
     yvpUserId,
     name,
     profilePicture,
@@ -805,7 +803,6 @@ var SignInWithYouVersionResult = class {
     this.expiryDate = expiresIn ? new Date(Date.now() + expiresIn * 1e3) : /* @__PURE__ */ new Date();
     this.refreshToken = refreshToken;
     this.idToken = idToken;
-    this.permissions = permissions;
     this.yvpUserId = yvpUserId;
     this.name = name;
     this.profilePicture = profilePicture;
@@ -818,22 +815,22 @@ var YouVersionAPIUsers = class {
   /**
    * 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, redirectURL) {
+  static async signIn(redirectURL, scopes) {
     const appKey = YouVersionPlatformConfiguration.appKey;
     if (!appKey) {
       throw new Error("YouVersionPlatformConfiguration.appKey must be set before calling signIn");
     }
     const authorizationRequest = await SignInWithYouVersionPKCEAuthorizationRequestBuilder.make(
       appKey,
-      permissions,
-      new URL(redirectURL)
+      new URL(redirectURL),
+      scopes
     );
     localStorage.setItem(
       "youversion-auth-code-verifier",
@@ -933,17 +930,11 @@ var YouVersionAPIUsers = class {
    */
   static extractSignInResult(tokens) {
     const idClaims = this.decodeJWT(tokens.id_token);
-    const permissions = tokens.scope.split(" ").map((p) => p.trim()).filter((p) => p.length > 0).filter(
-      (p) => Object.values(SignInWithYouVersionPermission).includes(
-        p
-      )
-    );
     const resultData = {
       accessToken: tokens.access_token,
       expiresIn: tokens.expires_in,
       refreshToken: tokens.refresh_token,
       idToken: tokens.id_token,
-      permissions,
       yvpUserId: idClaims.sub,
       name: idClaims.name,
       profilePicture: idClaims.profile_picture,
@@ -1062,12 +1053,7 @@ var YouVersionAPIUsers = class {
         accessToken: tokens.access_token,
         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) => Object.values(SignInWithYouVersionPermission).includes(
-            p
-          )
-        )
+        idToken: existingIdToken
       });
       YouVersionPlatformConfiguration.saveAuthData(
         result.accessToken || null,
@@ -1137,43 +1123,6 @@ var YouVersionAPI = class {
   }
 };
 
-// src/URLBuilder.ts
-var URLBuilder = class {
-  static get baseURL() {
-    return new URL(`https://${YouVersionPlatformConfiguration.apiHost}`);
-  }
-  static authURL(appKey, requiredPermissions = /* @__PURE__ */ new Set(), optionalPermissions = /* @__PURE__ */ new Set()) {
-    if (typeof appKey !== "string" || appKey.trim().length === 0) {
-      throw new Error("appKey must be a non-empty string");
-    }
-    try {
-      const url = new URL(this.baseURL);
-      url.pathname = "/auth/login";
-      const searchParams = new URLSearchParams();
-      searchParams.append("APP_KEY", appKey);
-      searchParams.append("language", "en");
-      if (requiredPermissions.size > 0) {
-        const requiredList = Array.from(requiredPermissions).map((p) => p.toString());
-        searchParams.append("required_perms", requiredList.join(","));
-      }
-      if (optionalPermissions.size > 0) {
-        const optionalList = Array.from(optionalPermissions).map((p) => p.toString());
-        searchParams.append("opt_perms", optionalList.join(","));
-      }
-      const installationId = YouVersionPlatformConfiguration.installationId;
-      if (installationId) {
-        searchParams.append("x-yvp-installation-id", installationId);
-      }
-      url.search = searchParams.toString();
-      return url;
-    } catch (error) {
-      throw new Error(
-        `Failed to construct auth URL: ${error instanceof Error ? error.message : "Unknown error"}`
-      );
-    }
-  }
-};
-
 // src/utils/constants.ts
 var BOOK_IDS = [
   "GEN",
@@ -1283,109 +1232,109 @@ var BOOK_IDS = [
   "LKA"
 ];
 var BOOK_CANON = {
-  GEN: "ot",
-  EXO: "ot",
-  LEV: "ot",
-  NUM: "ot",
-  DEU: "ot",
-  JOS: "ot",
-  JDG: "ot",
-  RUT: "ot",
-  "1SA": "ot",
-  "2SA": "ot",
-  "1KI": "ot",
-  "2KI": "ot",
-  "1CH": "ot",
-  "2CH": "ot",
-  EZR: "ot",
-  NEH: "ot",
-  EST: "ot",
-  JOB: "ot",
-  PSA: "ot",
-  PRO: "ot",
-  ECC: "ot",
-  SNG: "ot",
-  ISA: "ot",
-  JER: "ot",
-  LAM: "ot",
-  EZK: "ot",
-  DAN: "ot",
-  HOS: "ot",
-  JOL: "ot",
-  AMO: "ot",
-  OBA: "ot",
-  JON: "ot",
-  MIC: "ot",
-  NAM: "ot",
-  HAB: "ot",
-  ZEP: "ot",
-  HAG: "ot",
-  ZEC: "ot",
-  MAL: "ot",
-  MAT: "nt",
-  MRK: "nt",
-  LUK: "nt",
-  JHN: "nt",
-  ACT: "nt",
-  ROM: "nt",
-  "1CO": "nt",
-  "2CO": "nt",
-  GAL: "nt",
-  EPH: "nt",
-  PHP: "nt",
-  COL: "nt",
-  "1TH": "nt",
-  "2TH": "nt",
-  "1TI": "nt",
-  "2TI": "nt",
-  TIT: "nt",
-  PHM: "nt",
-  HEB: "nt",
-  JAS: "nt",
-  "1PE": "nt",
-  "2PE": "nt",
-  "1JN": "nt",
-  "2JN": "nt",
-  "3JN": "nt",
-  JUD: "nt",
-  REV: "nt",
-  TOB: "dc",
-  JDT: "dc",
-  ESG: "dc",
-  WIS: "dc",
-  SIR: "dc",
-  BAR: "dc",
-  LJE: "dc",
-  S3Y: "dc",
-  SUS: "dc",
-  BEL: "dc",
-  "1MA": "dc",
-  "2MA": "dc",
-  "3MA": "dc",
-  "4MA": "dc",
-  "1ES": "dc",
-  "2ES": "dc",
-  MAN: "dc",
-  PS2: "dc",
-  ODA: "dc",
-  PSS: "dc",
-  "3ES": "dc",
-  EZA: "dc",
-  "5EZ": "dc",
-  "6EZ": "dc",
-  DAG: "dc",
-  PS3: "dc",
-  "2BA": "dc",
-  LBA: "dc",
-  JUB: "dc",
-  ENO: "dc",
-  "1MQ": "dc",
-  "2MQ": "dc",
-  "3MQ": "dc",
-  REP: "dc",
-  "4BA": "dc",
-  LAO: "dc",
-  LKA: "nt"
+  GEN: "old_testament",
+  EXO: "old_testament",
+  LEV: "old_testament",
+  NUM: "old_testament",
+  DEU: "old_testament",
+  JOS: "old_testament",
+  JDG: "old_testament",
+  RUT: "old_testament",
+  "1SA": "old_testament",
+  "2SA": "old_testament",
+  "1KI": "old_testament",
+  "2KI": "old_testament",
+  "1CH": "old_testament",
+  "2CH": "old_testament",
+  EZR: "old_testament",
+  NEH: "old_testament",
+  EST: "old_testament",
+  JOB: "old_testament",
+  PSA: "old_testament",
+  PRO: "old_testament",
+  ECC: "old_testament",
+  SNG: "old_testament",
+  ISA: "old_testament",
+  JER: "old_testament",
+  LAM: "old_testament",
+  EZK: "old_testament",
+  DAN: "old_testament",
+  HOS: "old_testament",
+  JOL: "old_testament",
+  AMO: "old_testament",
+  OBA: "old_testament",
+  JON: "old_testament",
+  MIC: "old_testament",
+  NAM: "old_testament",
+  HAB: "old_testament",
+  ZEP: "old_testament",
+  HAG: "old_testament",
+  ZEC: "old_testament",
+  MAL: "old_testament",
+  MAT: "new_testament",
+  MRK: "new_testament",
+  LUK: "new_testament",
+  JHN: "new_testament",
+  ACT: "new_testament",
+  ROM: "new_testament",
+  "1CO": "new_testament",
+  "2CO": "new_testament",
+  GAL: "new_testament",
+  EPH: "new_testament",
+  PHP: "new_testament",
+  COL: "new_testament",
+  "1TH": "new_testament",
+  "2TH": "new_testament",
+  "1TI": "new_testament",
+  "2TI": "new_testament",
+  TIT: "new_testament",
+  PHM: "new_testament",
+  HEB: "new_testament",
+  JAS: "new_testament",
+  "1PE": "new_testament",
+  "2PE": "new_testament",
+  "1JN": "new_testament",
+  "2JN": "new_testament",
+  "3JN": "new_testament",
+  JUD: "new_testament",
+  REV: "new_testament",
+  TOB: "deuterocanon",
+  JDT: "deuterocanon",
+  ESG: "deuterocanon",
+  WIS: "deuterocanon",
+  SIR: "deuterocanon",
+  BAR: "deuterocanon",
+  LJE: "deuterocanon",
+  S3Y: "deuterocanon",
+  SUS: "deuterocanon",
+  BEL: "deuterocanon",
+  "1MA": "deuterocanon",
+  "2MA": "deuterocanon",
+  "3MA": "deuterocanon",
+  "4MA": "deuterocanon",
+  "1ES": "deuterocanon",
+  "2ES": "deuterocanon",
+  MAN: "deuterocanon",
+  PS2: "deuterocanon",
+  ODA: "deuterocanon",
+  PSS: "deuterocanon",
+  "3ES": "deuterocanon",
+  EZA: "deuterocanon",
+  "5EZ": "deuterocanon",
+  "6EZ": "deuterocanon",
+  DAG: "deuterocanon",
+  PS3: "deuterocanon",
+  "2BA": "deuterocanon",
+  LBA: "deuterocanon",
+  JUB: "deuterocanon",
+  ENO: "deuterocanon",
+  "1MQ": "deuterocanon",
+  "2MQ": "deuterocanon",
+  "3MQ": "deuterocanon",
+  REP: "deuterocanon",
+  "4BA": "deuterocanon",
+  LAO: "deuterocanon",
+  LKA: "new_testament"
   // Luke-Acts combo, treated canonically as New Testament
 };
 export {
@@ -1399,7 +1348,6 @@ export {
   SessionStorageStrategy,
   SignInWithYouVersionPermission,
   SignInWithYouVersionResult,
-  URLBuilder,
   YouVersionAPI,
   YouVersionAPIUsers,
   YouVersionPlatformConfiguration,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@youversion/platform-core",
-  "version": "0.8.2",
+  "version": "0.9.0",
   "type": "module",
   "publishConfig": {
     "access": "public",

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;