@youversion/platform-core 0.4.2 → 0.4.3

package/dist/index.cjs

@@ -50,18 +50,23 @@ var ApiClient = class {
   /**
    * Creates an instance of ApiClient.
    *
-   * @param config - The API configuration object containing baseUrl, timeout, and appId.
+   * @param config - The API configuration object containing baseUrl, timeout, and appKey.
    */
   constructor(config) {
     this.config = {
-      version: config.version || "v1",
       ...config
     };
-    this.baseURL = config.baseUrl || "https://api-dev.youversion.com";
+    const apiHost = config.apiHost ?? process.env.YVP_API_HOST ?? "api.youversion.com";
+    if (!apiHost) {
+      throw new Error(
+        "ApiClient requires a host name. Provide an apiHost in the config or set the YVP_API_HOST environment variable."
+      );
+    }
+    this.baseURL = "https://" + apiHost;
     this.timeout = config.timeout || 1e4;
     this.defaultHeaders = {
       "Content-Type": "application/json",
-      "X-YVP-App-Key": this.config.appId,
+      "X-YVP-App-Key": this.config.appKey,
       "X-YVP-Installation-Id": this.config.installationId || "web-sdk-default"
     };
   }
@@ -203,9 +208,6 @@ var BibleClient = class {
   constructor(client) {
     this.client = client;
   }
-  get rootPath() {
-    return `/${this.client.config.version}`;
-  }
   /**
    * Fetches a collection of Bible versions filtered by language ranges.
    *
@@ -221,7 +223,7 @@ var BibleClient = class {
     if (license_id !== void 0) {
       params.license_id = license_id;
     }
-    return this.client.get(`${this.rootPath}/bibles`, params);
+    return this.client.get(`/v1/bibles`, params);
   }
   /**
    * Fetches a Bible version by its ID.
@@ -230,7 +232,7 @@ var BibleClient = class {
    */
   async getVersion(id) {
     this.versionIdSchema.parse(id);
-    return this.client.get(`${this.rootPath}/bibles/${id}`);
+    return this.client.get(`/v1/bibles/${id}`);
   }
   /**
    * Fetches all books for a given Bible version.
@@ -240,7 +242,7 @@ var BibleClient = class {
    */
   async getBooks(versionId, canon) {
     this.versionIdSchema.parse(versionId);
-    return this.client.get(`${this.rootPath}/bibles/${versionId}/books`, {
+    return this.client.get(`/v1/bibles/${versionId}/books`, {
       ...canon && { canon }
     });
   }
@@ -253,7 +255,7 @@ var BibleClient = class {
   async getBook(versionId, book) {
     this.versionIdSchema.parse(versionId);
     this.bookSchema.parse(book);
-    return this.client.get(`${this.rootPath}/bibles/${versionId}/books/${book}`);
+    return this.client.get(`/v1/bibles/${versionId}/books/${book}`);
   }
   /**
    * Fetches all chapters for a specific book in a version.
@@ -265,7 +267,7 @@ var BibleClient = class {
     this.versionIdSchema.parse(versionId);
     this.bookSchema.parse(book);
     return this.client.get(
-      `${this.rootPath}/bibles/${versionId}/books/${book}/chapters`
+      `/v1/bibles/${versionId}/books/${book}/chapters`
     );
   }
   /**
@@ -280,7 +282,7 @@ var BibleClient = class {
     this.bookSchema.parse(book);
     this.chapterSchema.parse(chapter);
     return this.client.get(
-      `${this.rootPath}/bibles/${versionId}/books/${book}/chapters/${chapter}`
+      `/v1/bibles/${versionId}/books/${book}/chapters/${chapter}`
     );
   }
   /**
@@ -295,7 +297,7 @@ var BibleClient = class {
     this.bookSchema.parse(book);
     this.chapterSchema.parse(chapter);
     return this.client.get(
-      `${this.rootPath}/bibles/${versionId}/books/${book}/chapters/${chapter}/verses`
+      `/v1/bibles/${versionId}/books/${book}/chapters/${chapter}/verses`
     );
   }
   /**
@@ -312,7 +314,7 @@ var BibleClient = class {
     this.chapterSchema.parse(chapter);
     this.verseSchema.parse(verse);
     return this.client.get(
-      `${this.rootPath}/bibles/${versionId}/books/${book}/chapters/${chapter}/verses/${verse}`
+      `/v1/bibles/${versionId}/books/${book}/chapters/${chapter}/verses/${verse}`
     );
   }
   /**
@@ -353,10 +355,7 @@ var BibleClient = class {
     if (include_notes !== void 0) {
       params.include_notes = include_notes;
     }
-    return this.client.get(
-      `${this.rootPath}/bibles/${versionId}/passages/${usfm}`,
-      params
-    );
+    return this.client.get(`/v1/bibles/${versionId}/passages/${usfm}`, params);
   }
   /**
    * Fetches the indexing structure for a Bible version.
@@ -365,14 +364,14 @@ var BibleClient = class {
    */
   async getIndex(versionId) {
     this.versionIdSchema.parse(versionId);
-    return this.client.get(`${this.rootPath}/bibles/${versionId}/index`);
+    return this.client.get(`/v1/bibles/${versionId}/index`);
   }
   /**
    * Fetches the verse of the day calendar for an entire year.
    * @returns A collection of VOTD objects for all days of the year.
    */
   async getAllVOTDs() {
-    return this.client.get(`${this.rootPath}/verse_of_the_days`);
+    return this.client.get(`/v1/verse_of_the_days`);
   }
   /**
    * Fetches the passage_id for the Verse Of The Day.
@@ -390,7 +389,7 @@ var BibleClient = class {
   async getVOTD(day) {
     const daySchema = import_zod.z.number().int().min(1).max(366);
     daySchema.parse(day);
-    return this.client.get(`${this.rootPath}/verse_of_the_days/${day}`);
+    return this.client.get(`/v1/verse_of_the_days/${day}`);
   }
 };
 
@@ -410,9 +409,6 @@ var LanguagesClient = class {
   constructor(client) {
     this.client = client;
   }
-  get rootPath() {
-    return `/${this.client.config.version}`;
-  }
   /**
    * Fetches a collection of languages supported in the Platform.
    * @param options Query parameters for pagination and filtering (country is required).
@@ -430,7 +426,7 @@ var LanguagesClient = class {
     if (options.page_token !== void 0) {
       params.page_token = options.page_token;
     }
-    return this.client.get(`${this.rootPath}/languages`, params);
+    return this.client.get(`/v1/languages`, params);
   }
   /**
    * Fetches details about a specific language in the Platform.
@@ -439,7 +435,7 @@ var LanguagesClient = class {
    */
   async getLanguage(languageId) {
     this.languageIdSchema.parse(languageId);
-    return this.client.get(`${this.rootPath}/languages/${languageId}`);
+    return this.client.get(`/v1/languages/${languageId}`);
   }
 };
 
@@ -448,10 +444,10 @@ var import_zod3 = require("zod");
 
 // src/YouVersionPlatformConfiguration.ts
 var YouVersionPlatformConfiguration = class {
-  static _appId = null;
+  static _appKey = null;
   static _installationId = null;
   static _accessToken = null;
-  static _apiHost = "api-dev.youversion.com";
+  static _apiHost = "api.youversion.com";
   static _isPreviewMode = false;
   static _previewUserInfo = null;
   static getOrSetInstallationId() {
@@ -466,11 +462,11 @@ var YouVersionPlatformConfiguration = class {
     localStorage.setItem("x-yvp-installation-id", newId);
     return newId;
   }
-  static get appId() {
-    return this._appId;
+  static get appKey() {
+    return this._appKey;
   }
-  static set appId(value) {
-    this._appId = value;
+  static set appKey(value) {
+    this._appKey = value;
   }
   static get installationId() {
     if (!this._installationId) {
@@ -523,9 +519,6 @@ var HighlightsClient = class {
   constructor(client) {
     this.client = client;
   }
-  get rootPath() {
-    return `/${this.client.config.version}`;
-  }
   /**
    * Gets the authentication token, either from the provided parameter or from the platform configuration.
    * @param lat Optional explicit long access token. If not provided, retrieves from YouVersionPlatformConfiguration.
@@ -595,7 +588,7 @@ var HighlightsClient = class {
       this.validatePassageId(options.passage_id);
       params.passage_id = options.passage_id;
     }
-    return this.client.get(`${this.rootPath}/highlights`, params);
+    return this.client.get(`/v1/highlights`, params);
   }
   /**
    * Creates or updates a highlight on a passage.
@@ -610,7 +603,7 @@ var HighlightsClient = class {
     this.validatePassageId(data.passage_id);
     this.validateColor(data.color);
     const token = this.getAuthToken(lat);
-    return this.client.post(`${this.rootPath}/highlights`, data, { lat: token });
+    return this.client.post(`/v1/highlights`, data, { lat: token });
   }
   /**
    * Clears highlights for a passage.
@@ -630,7 +623,7 @@ var HighlightsClient = class {
       this.validateVersionId(options.version_id);
       params.version_id = options.version_id;
     }
-    await this.client.delete(`${this.rootPath}/highlights/${passageId}`, params);
+    await this.client.delete(`/v1/highlights/${passageId}`, params);
   }
 };
 
@@ -928,13 +921,13 @@ var YouVersionAPI = class {
       Accept: "application/json",
       "Content-Type": "application/json"
     };
-    const appId = YouVersionPlatformConfiguration.appId;
-    if (appId) {
-      headers["X-App-Id"] = appId;
+    const appKey = YouVersionPlatformConfiguration.appKey;
+    if (appKey) {
+      headers["X-YVP-App-Key"] = appKey;
     }
     const installationId = YouVersionPlatformConfiguration.installationId;
     if (installationId) {
-      headers["x-yvp-installation-id"] = installationId;
+      headers["X-YVP-Installation-ID"] = installationId;
     }
     const request = new Request(url.toString(), {
       headers
@@ -948,15 +941,15 @@ var URLBuilder = class {
   static get baseURL() {
     return new URL(`https://${YouVersionPlatformConfiguration.apiHost}`);
   }
-  static authURL(appId, requiredPermissions = /* @__PURE__ */ new Set(), optionalPermissions = /* @__PURE__ */ new Set()) {
-    if (typeof appId !== "string" || appId.trim().length === 0) {
-      throw new Error("appId must be a non-empty string");
+  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_id", appId);
+      searchParams.append("APP_KEY", appKey);
       searchParams.append("language", "en");
       if (requiredPermissions.size > 0) {
         const requiredList = Array.from(requiredPermissions).map((p) => p.toString());
@@ -1020,11 +1013,11 @@ var YouVersionAPIUsers = class {
     if (!optionalPermissions || !(optionalPermissions instanceof Set)) {
       throw new Error("Invalid optionalPermissions: must be a Set");
     }
-    const appId = YouVersionPlatformConfiguration.appId;
-    if (!appId) {
-      throw new Error("YouVersionPlatformConfiguration.appId must be set before calling signIn");
+    const appKey = YouVersionPlatformConfiguration.appKey;
+    if (!appKey) {
+      throw new Error("YouVersionPlatformConfiguration.appKey must be set before calling signIn");
     }
-    const url = URLBuilder.authURL(appId, requiredPermissions, optionalPermissions);
+    const url = URLBuilder.authURL(appKey, requiredPermissions, optionalPermissions);
     const strategy = AuthenticationStrategyRegistry.get();
     const callbackUrl = await strategy.authenticate(url);
     const result = new SignInWithYouVersionResult(callbackUrl);

package/dist/index.d.cts

@@ -179,11 +179,9 @@ type Collection<T> = {
 };
 
 interface ApiConfig {
-    baseUrl?: string;
-    appId: string;
+    apiHost?: string;
+    appKey: string;
     timeout?: number;
-    hostEnv?: string;
-    version?: string;
     installationId?: string;
     redirectUri?: string;
 }
@@ -237,7 +235,7 @@ declare class ApiClient {
     /**
      * Creates an instance of ApiClient.
      *
-     * @param config - The API configuration object containing baseUrl, timeout, and appId.
+     * @param config - The API configuration object containing baseUrl, timeout, and appKey.
      */
     constructor(config: ApiConfig);
     /**
@@ -294,7 +292,6 @@ declare class BibleClient {
      * @param client The API client to use for requests.
      */
     constructor(client: ApiClient);
-    private get rootPath();
     /**
      * Fetches a collection of Bible versions filtered by language ranges.
      *
@@ -424,7 +421,6 @@ declare class LanguagesClient {
      * @param client The API client to use for requests.
      */
     constructor(client: ApiClient);
-    private get rootPath();
     /**
      * Fetches a collection of languages supported in the Platform.
      * @param options Query parameters for pagination and filtering (country is required).
@@ -466,7 +462,6 @@ declare class HighlightsClient {
      * @param client The API client to use for requests.
      */
     constructor(client: ApiClient);
-    private get rootPath();
     /**
      * Gets the authentication token, either from the provided parameter or from the platform configuration.
      * @param lat Optional explicit long access token. If not provided, retrieves from YouVersionPlatformConfiguration.
@@ -701,20 +696,20 @@ declare class YouVersionAPI {
 
 declare class URLBuilder {
     private static get baseURL();
-    static authURL(appId: string, requiredPermissions?: Set<SignInWithYouVersionPermissionValues>, optionalPermissions?: Set<SignInWithYouVersionPermissionValues>): URL;
+    static authURL(appKey: string, requiredPermissions?: Set<SignInWithYouVersionPermissionValues>, optionalPermissions?: Set<SignInWithYouVersionPermissionValues>): URL;
     static userURL(accessToken: string): URL;
 }
 
 declare class YouVersionPlatformConfiguration {
-    private static _appId;
+    private static _appKey;
     private static _installationId;
     private static _accessToken;
     private static _apiHost;
     private static _isPreviewMode;
     private static _previewUserInfo;
     private static getOrSetInstallationId;
-    static get appId(): string | null;
-    static set appId(value: string | null);
+    static get appKey(): string | null;
+    static set appKey(value: string | null);
     static get installationId(): string;
     static set installationId(value: string | null);
     static setAccessToken(token: string | null): void;

package/dist/index.d.ts

@@ -179,11 +179,9 @@ type Collection<T> = {
 };
 
 interface ApiConfig {
-    baseUrl?: string;
-    appId: string;
+    apiHost?: string;
+    appKey: string;
     timeout?: number;
-    hostEnv?: string;
-    version?: string;
     installationId?: string;
     redirectUri?: string;
 }
@@ -237,7 +235,7 @@ declare class ApiClient {
     /**
      * Creates an instance of ApiClient.
      *
-     * @param config - The API configuration object containing baseUrl, timeout, and appId.
+     * @param config - The API configuration object containing baseUrl, timeout, and appKey.
      */
     constructor(config: ApiConfig);
     /**
@@ -294,7 +292,6 @@ declare class BibleClient {
      * @param client The API client to use for requests.
      */
     constructor(client: ApiClient);
-    private get rootPath();
     /**
      * Fetches a collection of Bible versions filtered by language ranges.
      *
@@ -424,7 +421,6 @@ declare class LanguagesClient {
      * @param client The API client to use for requests.
      */
     constructor(client: ApiClient);
-    private get rootPath();
     /**
      * Fetches a collection of languages supported in the Platform.
      * @param options Query parameters for pagination and filtering (country is required).
@@ -466,7 +462,6 @@ declare class HighlightsClient {
      * @param client The API client to use for requests.
      */
     constructor(client: ApiClient);
-    private get rootPath();
     /**
      * Gets the authentication token, either from the provided parameter or from the platform configuration.
      * @param lat Optional explicit long access token. If not provided, retrieves from YouVersionPlatformConfiguration.
@@ -701,20 +696,20 @@ declare class YouVersionAPI {
 
 declare class URLBuilder {
     private static get baseURL();
-    static authURL(appId: string, requiredPermissions?: Set<SignInWithYouVersionPermissionValues>, optionalPermissions?: Set<SignInWithYouVersionPermissionValues>): URL;
+    static authURL(appKey: string, requiredPermissions?: Set<SignInWithYouVersionPermissionValues>, optionalPermissions?: Set<SignInWithYouVersionPermissionValues>): URL;
     static userURL(accessToken: string): URL;
 }
 
 declare class YouVersionPlatformConfiguration {
-    private static _appId;
+    private static _appKey;
     private static _installationId;
     private static _accessToken;
     private static _apiHost;
     private static _isPreviewMode;
     private static _previewUserInfo;
     private static getOrSetInstallationId;
-    static get appId(): string | null;
-    static set appId(value: string | null);
+    static get appKey(): string | null;
+    static set appKey(value: string | null);
     static get installationId(): string;
     static set installationId(value: string | null);
     static setAccessToken(token: string | null): void;