@youversion/platform-core 1.2.0 → 1.2.1

package/.turbo/turbo-build.log

@@ -1,5 +1,5 @@
 
-> @youversion/platform-core@1.2.0 build /home/runner/work/platform-sdk-react/platform-sdk-react/packages/core
+> @youversion/platform-core@1.2.1 build /home/runner/work/platform-sdk-react/platform-sdk-react/packages/core
 > tsup src/index.ts --format cjs,esm --dts
 
 CLI Building entry: src/index.ts
@@ -8,11 +8,11 @@
 CLI Target: es2022
 CJS Build start
 ESM Build start
-CJS dist/index.cjs 42.87 KB
-CJS ⚡️ Build success in 31ms
-ESM dist/index.js 41.06 KB
-ESM ⚡️ Build success in 32ms
+ESM dist/index.js 41.09 KB
+ESM ⚡️ Build success in 34ms
+CJS dist/index.cjs 42.90 KB
+CJS ⚡️ Build success in 34ms
 DTS Build start
-DTS ⚡️ Build success in 1751ms
-DTS dist/index.d.cts 32.80 KB
-DTS dist/index.d.ts  32.80 KB
+DTS ⚡️ Build success in 2020ms
+DTS dist/index.d.cts 32.78 KB
+DTS dist/index.d.ts  32.78 KB

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @youversion/platform-core
 
+## 1.2.1
+
+### Patch Changes
+
+- e845974: fix: make country parameter optional for getLanguages
+
+  The country parameter is now optional when fetching languages, allowing developers to retrieve all available languages without filtering by country. This improves developer experience by providing a more flexible API while maintaining backward compatibility for existing code that provides a country filter.
+
 ## 1.2.0
 
 ### Minor Changes

package/dist/index.cjs

@@ -409,13 +409,15 @@ var LanguagesClient = class {
   }
   /**
    * Fetches a collection of languages supported in the Platform.
-   * @param options Query parameters for pagination and filtering (country is required).
+   * @param options Query parameters for pagination and filtering.
    * @returns A collection of Language objects.
    */
-  async getLanguages(options) {
+  async getLanguages(options = {}) {
     const params = {};
-    const country = this.countrySchema.parse(options.country);
-    params.country = country;
+    if (options.country !== void 0) {
+      const country = this.countrySchema.parse(options.country);
+      params.country = country;
+    }
     if (options.page_size !== void 0) {
       const pageSizeSchema = import_zod2.z.number().int().positive();
       pageSizeSchema.parse(options.page_size);

package/dist/index.d.cts

@@ -449,7 +449,7 @@ declare class BibleClient {
 type GetLanguagesOptions = {
     page_size?: number;
     page_token?: string;
-    country: string;
+    country?: string;
 };
 /**
  * Client for interacting with Languages API endpoints.
@@ -465,10 +465,10 @@ declare class LanguagesClient {
     constructor(client: ApiClient);
     /**
      * Fetches a collection of languages supported in the Platform.
-     * @param options Query parameters for pagination and filtering (country is required).
+     * @param options Query parameters for pagination and filtering.
      * @returns A collection of Language objects.
      */
-    getLanguages(options: GetLanguagesOptions): Promise<Collection<Language>>;
+    getLanguages(options?: GetLanguagesOptions): Promise<Collection<Language>>;
     /**
      * Fetches details about a specific language in the Platform.
      * @param languageId The BCP 47 language code (optionally including script, e.g., "en" or "sr-Latn").

package/dist/index.d.ts

@@ -449,7 +449,7 @@ declare class BibleClient {
 type GetLanguagesOptions = {
     page_size?: number;
     page_token?: string;
-    country: string;
+    country?: string;
 };
 /**
  * Client for interacting with Languages API endpoints.
@@ -465,10 +465,10 @@ declare class LanguagesClient {
     constructor(client: ApiClient);
     /**
      * Fetches a collection of languages supported in the Platform.
-     * @param options Query parameters for pagination and filtering (country is required).
+     * @param options Query parameters for pagination and filtering.
      * @returns A collection of Language objects.
      */
-    getLanguages(options: GetLanguagesOptions): Promise<Collection<Language>>;
+    getLanguages(options?: GetLanguagesOptions): Promise<Collection<Language>>;
     /**
      * Fetches details about a specific language in the Platform.
      * @param languageId The BCP 47 language code (optionally including script, e.g., "en" or "sr-Latn").

package/dist/index.js

@@ -370,13 +370,15 @@ var LanguagesClient = class {
   }
   /**
    * Fetches a collection of languages supported in the Platform.
-   * @param options Query parameters for pagination and filtering (country is required).
+   * @param options Query parameters for pagination and filtering.
    * @returns A collection of Language objects.
    */
-  async getLanguages(options) {
+  async getLanguages(options = {}) {
     const params = {};
-    const country = this.countrySchema.parse(options.country);
-    params.country = country;
+    if (options.country !== void 0) {
+      const country = this.countrySchema.parse(options.country);
+      params.country = country;
+    }
     if (options.page_size !== void 0) {
       const pageSizeSchema = z2.number().int().positive();
       pageSizeSchema.parse(options.page_size);

package/package.json

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

package/src/__tests__/{MockLangauges.ts → MockLanguages.ts}

@@ -76,8 +76,8 @@ export const mockLanguages: Language[] = [
     speaking_population: 8000000,
     default_bible_version_id: null,
   },
-  // Add more languages to reach 25 for default page size when filtering by 'US'
-  ...Array.from({ length: 24 }, (_, i) => ({
+  // Add more languages to exceed the maximum page size and exercise pagination
+  ...Array.from({ length: 120 }, (_, i) => ({
     id: `lang${i + 1}`,
     language: `lang${i + 1}`,
     script: 'Latn',
@@ -86,7 +86,7 @@ export const mockLanguages: Language[] = [
     display_names: {},
     scripts: ['Latn'],
     variants: [],
-    countries: ['US'],
+    countries: i % 2 === 0 ? ['US', 'CA'] : ['BR'],
     text_direction: 'ltr' as const,
     writing_population: 1000000,
     speaking_population: 1000000,

package/src/__tests__/handlers.ts

@@ -1,6 +1,6 @@
 import { http, HttpResponse } from 'msw';
 import type { Collection, Highlight, Language } from '../types';
-import { mockLanguages } from './MockLangauges';
+import { mockLanguages } from './MockLanguages';
 import { mockVersions, mockVersionKJV } from './MockVersions';
 import { mockBibleGenesis, mockBibleBooks } from './MockBibles';
 import { mockChapterGenesis1, mockGenesisChapters } from './MockChapters';

package/src/__tests__/languages.test.ts

@@ -17,22 +17,23 @@ describe('LanguagesClient', () => {
   });
 
   describe('getLanguages', () => {
-    it('should fetch languages with required country param', async () => {
-      const languages = await languagesClient.getLanguages({ country: 'US' });
+    it('should fetch languages without country filter', async () => {
+      const languages = await languagesClient.getLanguages({ page_size: 99 });
 
       const { success } = LanguageSchema.safeParse(languages.data[0]);
       expect(success).toBe(true);
-      expect(languages.data).toHaveLength(25);
-      expect(languages.data[0]).toHaveProperty('countries', expect.arrayContaining(['US']));
+      expect(languages.data).toHaveLength(99);
+      expect(languages.next_page_token).not.toBeNull();
     });
 
-    it('should fetch languages with page_size option', async () => {
-      const languages = await languagesClient.getLanguages({ country: 'US', page_size: 10 });
+    it('should fetch languages with country filter', async () => {
+      const languages = await languagesClient.getLanguages({ country: 'US', page_size: 20 });
 
       const { success } = LanguageSchema.safeParse(languages.data[0]);
       expect(success).toBe(true);
-      expect(languages.data).toHaveLength(10);
-      expect(languages.next_page_token).toBe('eyJzdGFydCI6IDEwfQ==');
+      expect(languages.data).toHaveLength(20);
+      expect(languages.data.every((language) => language.countries?.includes('US'))).toBe(true);
+      expect(languages.next_page_token).not.toBeNull();
     });
 
     it('should throw an error for invalid country code - empty string', async () => {

package/src/languages.ts

@@ -8,7 +8,7 @@ import type { Collection, Language } from './types';
 export type GetLanguagesOptions = {
   page_size?: number;
   page_token?: string;
-  country: string; // ISO 3166-1 alpha-2 country code (required per OpenAPI spec)
+  country?: string; // ISO 3166-1 alpha-2 country code
 };
 
 /**
@@ -41,15 +41,16 @@ export class LanguagesClient {
 
   /**
    * Fetches a collection of languages supported in the Platform.
-   * @param options Query parameters for pagination and filtering (country is required).
+   * @param options Query parameters for pagination and filtering.
    * @returns A collection of Language objects.
    */
-  async getLanguages(options: GetLanguagesOptions): Promise<Collection<Language>> {
+  async getLanguages(options: GetLanguagesOptions = {}): Promise<Collection<Language>> {
     const params: Record<string, string | number> = {};
 
-    // Country is required per OpenAPI spec
-    const country = this.countrySchema.parse(options.country);
-    params.country = country;
+    if (options.country !== undefined) {
+      const country = this.countrySchema.parse(options.country);
+      params.country = country;
+    }
 
     if (options.page_size !== undefined) {
       const pageSizeSchema = z.number().int().positive();