@youversion/platform-core 0.4.1 → 0.4.3

package/src/__tests__/client.test.ts

@@ -8,40 +8,36 @@ describe('ApiClient', () => {
 
   beforeEach(() => {
     apiClient = new ApiClient({
-      baseUrl: 'https://api-dev.youversion.com',
-      appId: 'test-app',
-      version: 'v1',
+      apiHost: 'test_placeholder.youversion.com',
+      appKey: 'test-app',
       installationId: 'test-installation',
     });
   });
 
   describe('constructor', () => {
-    it('should set default version to v1', () => {
+    it('should set remember the appKey', () => {
       const client = new ApiClient({
-        baseUrl: 'https://api-dev.youversion.com',
-        appId: 'test-app',
+        appKey: 'test-app1',
         installationId: 'test-installation',
       });
 
-      expect(client.config.version).toBe('v1');
+      expect(client.config.appKey).toBe('test-app1');
     });
 
-    it('should use provided version', () => {
+    it('should use provided appKey', () => {
       const client = new ApiClient({
-        baseUrl: 'https://api-dev.youversion.com',
-        appId: 'test-app',
-        version: 'v2',
+        appKey: 'test-app2',
         installationId: 'test-installation',
       });
 
-      expect(client.config.version).toBe('v2');
+      expect(client.config.appKey).toBe('test-app2');
     });
   });
 
   describe('get', () => {
     it('should make GET request and return data', async () => {
       server.use(
-        http.get('https://api-dev.youversion.com/test', () => {
+        http.get('https://test_placeholder.youversion.com/test', () => {
           return HttpResponse.json({ message: 'success' });
         }),
       );
@@ -53,7 +49,7 @@ describe('ApiClient', () => {
 
     it('should include query parameters', async () => {
       server.use(
-        http.get('https://api-dev.youversion.com/test', ({ request }) => {
+        http.get('https://test_placeholder.youversion.com/test', ({ request }) => {
           const url = new URL(request.url);
           const param = url.searchParams.get('param');
           return HttpResponse.json({ param });
@@ -71,7 +67,7 @@ describe('ApiClient', () => {
   describe('post', () => {
     it('should make POST request and return data', async () => {
       server.use(
-        http.post('https://api-dev.youversion.com/test', async ({ request }) => {
+        http.post('https://test_placeholder.youversion.com/test', async ({ request }) => {
           const body = await request.json();
           return HttpResponse.json({ received: body });
         }),
@@ -86,7 +82,7 @@ describe('ApiClient', () => {
 
     it('should include query parameters in POST request', async () => {
       server.use(
-        http.post('https://api-dev.youversion.com/test', async ({ request }) => {
+        http.post('https://test_placeholder.youversion.com/test', async ({ request }) => {
           const url = new URL(request.url);
           const param = url.searchParams.get('param');
           const body = await request.json();

package/src/__tests__/handlers.ts

@@ -1,11 +1,14 @@
 import { http, HttpResponse } from 'msw';
 import type { Collection, Highlight } from '../types';
 
-const baseUrl = 'https://api-dev.youversion.com';
+const apiHost = process.env.YVP_API_HOST;
+if (!apiHost) {
+  throw new Error('YVP_API_HOST environment variable must be set to run handler tests.');
+}
 
 export const handlers = [
   // Highlights endpoints
-  http.get(`${baseUrl}/v1/highlights`, ({ request }) => {
+  http.get(`https://${apiHost}/v1/highlights`, ({ request }) => {
     const url = new URL(request.url);
     const bibleId = url.searchParams.get('version_id');
     const passageId = url.searchParams.get('passage_id');
@@ -29,13 +32,13 @@ export const handlers = [
     return HttpResponse.json(highlights);
   }),
 
-  http.post(`${baseUrl}/v1/highlights`, async ({ request }) => {
+  http.post(`https://${apiHost}/v1/highlights`, async ({ request }) => {
     const body = (await request.json()) as Highlight;
 
     return HttpResponse.json(body, { status: 201 });
   }),
 
-  http.delete(`${baseUrl}/v1/highlights/:passageId`, () => {
+  http.delete(`https://${apiHost}/v1/highlights/:passageId`, () => {
     return new HttpResponse(null, { status: 204 });
   }),
 ];

package/src/__tests__/highlights.test.ts

@@ -9,9 +9,7 @@ describe('HighlightsClient', () => {
 
   beforeEach(() => {
     apiClient = new ApiClient({
-      baseUrl: 'https://api-dev.youversion.com',
-      appId: 'test-app',
-      version: 'v1',
+      appKey: 'test-app',
       installationId: 'test-installation',
     });
     highlightsClient = new HighlightsClient(apiClient);

package/src/__tests__/languages.test.ts

@@ -9,9 +9,7 @@ describe('LanguagesClient', () => {
 
   beforeEach(() => {
     apiClient = new ApiClient({
-      baseUrl: 'https://api-dev.youversion.com',
-      appId: process.env.YVP_APP_ID || '',
-      version: 'v1',
+      appKey: process.env.YVP_APP_KEY || '',
       installationId: 'test-installation',
     });
     languagesClient = new LanguagesClient(apiClient);

package/src/bible.ts

@@ -47,10 +47,6 @@ export class BibleClient {
     this.client = client;
   }
 
-  private get rootPath(): string {
-    return `/${this.client.config.version}`;
-  }
-
   /**
    * Fetches a collection of Bible versions filtered by language ranges.
    *
@@ -69,7 +65,7 @@ export class BibleClient {
     if (license_id !== undefined) {
       params.license_id = license_id;
     }
-    return this.client.get<Collection<BibleVersion>>(`${this.rootPath}/bibles`, params);
+    return this.client.get<Collection<BibleVersion>>(`/v1/bibles`, params);
   }
 
   /**
@@ -79,7 +75,7 @@ export class BibleClient {
    */
   async getVersion(id: number): Promise<BibleVersion> {
     this.versionIdSchema.parse(id);
-    return this.client.get<BibleVersion>(`${this.rootPath}/bibles/${id}`);
+    return this.client.get<BibleVersion>(`/v1/bibles/${id}`);
   }
 
   /**
@@ -90,7 +86,7 @@ export class BibleClient {
    */
   async getBooks(versionId: number, canon?: CANON): Promise<Collection<BibleBook>> {
     this.versionIdSchema.parse(versionId);
-    return this.client.get<Collection<BibleBook>>(`${this.rootPath}/bibles/${versionId}/books`, {
+    return this.client.get<Collection<BibleBook>>(`/v1/bibles/${versionId}/books`, {
       ...(canon && { canon }),
     });
   }
@@ -104,7 +100,7 @@ export class BibleClient {
   async getBook(versionId: number, book: string): Promise<BibleBook> {
     this.versionIdSchema.parse(versionId);
     this.bookSchema.parse(book);
-    return this.client.get<BibleBook>(`${this.rootPath}/bibles/${versionId}/books/${book}`);
+    return this.client.get<BibleBook>(`/v1/bibles/${versionId}/books/${book}`);
   }
 
   /**
@@ -117,7 +113,7 @@ export class BibleClient {
     this.versionIdSchema.parse(versionId);
     this.bookSchema.parse(book);
     return this.client.get<Collection<BibleChapter>>(
-      `${this.rootPath}/bibles/${versionId}/books/${book}/chapters`,
+      `/v1/bibles/${versionId}/books/${book}/chapters`,
     );
   }
 
@@ -134,7 +130,7 @@ export class BibleClient {
     this.chapterSchema.parse(chapter);
 
     return this.client.get<BibleChapter>(
-      `${this.rootPath}/bibles/${versionId}/books/${book}/chapters/${chapter}`,
+      `/v1/bibles/${versionId}/books/${book}/chapters/${chapter}`,
     );
   }
 
@@ -155,7 +151,7 @@ export class BibleClient {
     this.chapterSchema.parse(chapter);
 
     return this.client.get<Collection<BibleVerse>>(
-      `${this.rootPath}/bibles/${versionId}/books/${book}/chapters/${chapter}/verses`,
+      `/v1/bibles/${versionId}/books/${book}/chapters/${chapter}/verses`,
     );
   }
 
@@ -179,7 +175,7 @@ export class BibleClient {
     this.verseSchema.parse(verse);
 
     return this.client.get<BibleVerse>(
-      `${this.rootPath}/bibles/${versionId}/books/${book}/chapters/${chapter}/verses/${verse}`,
+      `/v1/bibles/${versionId}/books/${book}/chapters/${chapter}/verses/${verse}`,
     );
   }
 
@@ -227,10 +223,7 @@ export class BibleClient {
     if (include_notes !== undefined) {
       params.include_notes = include_notes;
     }
-    return this.client.get<BiblePassage>(
-      `${this.rootPath}/bibles/${versionId}/passages/${usfm}`,
-      params,
-    );
+    return this.client.get<BiblePassage>(`/v1/bibles/${versionId}/passages/${usfm}`, params);
   }
 
   /**
@@ -240,7 +233,7 @@ export class BibleClient {
    */
   async getIndex(versionId: number): Promise<BibleIndex> {
     this.versionIdSchema.parse(versionId);
-    return this.client.get<BibleIndex>(`${this.rootPath}/bibles/${versionId}/index`);
+    return this.client.get<BibleIndex>(`/v1/bibles/${versionId}/index`);
   }
 
   /**
@@ -248,7 +241,7 @@ export class BibleClient {
    * @returns A collection of VOTD objects for all days of the year.
    */
   async getAllVOTDs(): Promise<Collection<VOTD>> {
-    return this.client.get<Collection<VOTD>>(`${this.rootPath}/verse_of_the_days`);
+    return this.client.get<Collection<VOTD>>(`/v1/verse_of_the_days`);
   }
 
   /**
@@ -267,6 +260,6 @@ export class BibleClient {
   async getVOTD(day: number): Promise<VOTD> {
     const daySchema = z.number().int().min(1).max(366);
     daySchema.parse(day);
-    return this.client.get<VOTD>(`${this.rootPath}/verse_of_the_days/${day}`);
+    return this.client.get<VOTD>(`/v1/verse_of_the_days/${day}`);
   }
 }

package/src/client.ts

@@ -17,18 +17,23 @@ export 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) {
     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 || 10000;
     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',
     };
   }

package/src/highlights.ts

@@ -39,10 +39,6 @@ export class HighlightsClient {
     this.client = client;
   }
 
-  private get rootPath(): string {
-    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.
@@ -122,7 +118,7 @@ export class HighlightsClient {
       params.passage_id = options.passage_id;
     }
 
-    return this.client.get<Collection<Highlight>>(`${this.rootPath}/highlights`, params);
+    return this.client.get<Collection<Highlight>>(`/v1/highlights`, params);
   }
 
   /**
@@ -140,7 +136,7 @@ export class HighlightsClient {
 
     const token = this.getAuthToken(lat);
 
-    return this.client.post<Highlight>(`${this.rootPath}/highlights`, data, { lat: token });
+    return this.client.post<Highlight>(`/v1/highlights`, data, { lat: token });
   }
 
   /**
@@ -168,6 +164,6 @@ export class HighlightsClient {
       params.version_id = options.version_id;
     }
 
-    await this.client.delete<void>(`${this.rootPath}/highlights/${passageId}`, params);
+    await this.client.delete<void>(`/v1/highlights/${passageId}`, params);
   }
 }

package/src/languages.ts

@@ -39,10 +39,6 @@ export class LanguagesClient {
     this.client = client;
   }
 
-  private get rootPath(): string {
-    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).
@@ -65,7 +61,7 @@ export class LanguagesClient {
       params.page_token = options.page_token;
     }
 
-    return this.client.get<Collection<Language>>(`${this.rootPath}/languages`, params);
+    return this.client.get<Collection<Language>>(`/v1/languages`, params);
   }
 
   /**
@@ -75,6 +71,6 @@ export class LanguagesClient {
    */
   async getLanguage(languageId: string): Promise<Language> {
     this.languageIdSchema.parse(languageId);
-    return this.client.get<Language>(`${this.rootPath}/languages/${languageId}`);
+    return this.client.get<Language>(`/v1/languages/${languageId}`);
   }
 }

package/src/types/api-config.ts

@@ -1,9 +1,7 @@
 export interface ApiConfig {
-  baseUrl?: string;
-  appId: string;
+  apiHost?: string;
+  appKey: string;
   timeout?: number;
-  hostEnv?: string;
-  version?: string;
   installationId?: string;
   redirectUri?: string;
 }

package/.env.local

@@ -1,10 +0,0 @@
-YVP_API_BASE_URL=https://api-dev.youversion.com
-
-# Your application ID from YouVersion Platform
-YVP_APP_ID=Or8moGBK6GSh61OUOX7fUHgEsBsmVGMqAweZbydAgXnWj3nF
-
-# Your installation ID
-YVP_INSTALLATION_ID=a93b6749-7932-4bac-92ad-3e308f8a4bc4
-
-# Optional: Authentication token for endpoints that require it
-YVP_AUTH_TOKEN=