@youversion/platform-core 0.5.6 → 0.5.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,5 +1,5 @@
1
1
 
2
- > @youversion/platform-core@0.5.6 build /home/runner/work/platform-sdk-react/platform-sdk-react/packages/core
2
+ > @youversion/platform-core@0.5.8 build /home/runner/work/platform-sdk-react/platform-sdk-react/packages/core
3
3
  > tsup src/index.ts --format cjs,esm --dts
4
4
 
5
5
  CLI Building entry: src/index.ts
@@ -9,10 +9,10 @@
9
9
  CJS Build start
10
10
  ESM Build start
11
11
  CJS dist/index.cjs 39.59 KB
12
- CJS ⚡️ Build success in 37ms
12
+ CJS ⚡️ Build success in 32ms
13
13
  ESM dist/index.js 37.59 KB
14
- ESM ⚡️ Build success in 38ms
14
+ ESM ⚡️ Build success in 32ms
15
15
  DTS Build start
16
- DTS ⚡️ Build success in 1846ms
16
+ DTS ⚡️ Build success in 1811ms
17
17
  DTS dist/index.d.cts 34.21 KB
18
18
  DTS dist/index.d.ts 34.21 KB
package/CHANGELOG.md CHANGED
@@ -1,5 +1,18 @@
1
1
  # @youversion/platform-core
2
2
 
3
+ ## 0.5.8
4
+
5
+ ### Patch Changes
6
+
7
+ - ae9c599: chore(build): move tsup to devDependency
8
+ - ae9c599: chore(build): move tsup to devDependency
9
+
10
+ ## 0.5.7
11
+
12
+ ### Patch Changes
13
+
14
+ - 8b2be56: Improve sample code and readmes
15
+
3
16
  ## 0.5.6
4
17
 
5
18
  ### Patch Changes
package/README.md CHANGED
@@ -27,24 +27,28 @@ Get your App Key at [platform.youversion.com](https://platform.youversion.com/)
27
27
  ## Usage
28
28
 
29
29
  ```ts
30
- import { ApiClient, BibleClient } from '@youversion/platform-core'
30
+ import { ApiClient, BibleClient } from '@youversion/platform-core';
31
31
 
32
- // Initialize API client
33
32
  const apiClient = new ApiClient({
34
- appKey: import.meta.env.YVP_APP_KEY,
35
- })
33
+ appKey: 'YOUR_APP_KEY',
34
+ });
35
+ const bibleClient = new BibleClient(apiClient);
36
36
 
37
- const bibleClient = new BibleClient(apiClient)
37
+ // Find available Bible versions in English
38
+ const versions = await bibleClient.getVersions('en*');
39
+ console.log(versions.data[0].title);
38
40
 
39
- // Get English Bible versions
40
- const versions = await bibleClient.getVersions('en*')
41
- console.log(versions.data[0].title)
42
-
43
- // Get a specific passage
44
- const passage = await bibleClient.getPassage(111, 'JHN.3.16')
45
- console.log(passage.content) // "For God so loved the world..."
41
+ // Fetch the html text of John 3:16 in that first Bible version
42
+ const passage = await bibleClient.getPassage(versions.data[0].id, 'JHN.3.16');
43
+ console.log(passage.content);
46
44
  ```
47
45
 
48
- ---
46
+ ## Documentation and API Reference
47
+ * [developers.youversion.com/sdks/typescript](https://developers.youversion.com/sdks/typescript)
48
+
49
+ ## License
50
+
51
+ This SDK is licensed under [Apache 2.0](./LICENSE).
49
52
 
50
- **API Reference:** [developers.youversion.com/sdks/typescript](https://developers.youversion.com/sdks/typescript)
53
+ Licensing information for the Bible versions is available
54
+ at the [YouVersion Platform](https://platform.youversion.com/) site.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@youversion/platform-core",
3
- "version": "0.5.6",
3
+ "version": "0.5.8",
4
4
  "type": "module",
5
5
  "publishConfig": {
6
6
  "access": "public",
@@ -27,13 +27,13 @@
27
27
  "eslint": "9.38.0",
28
28
  "jsdom": "24.0.0",
29
29
  "msw": "2.11.6",
30
+ "tsup": "8.5.0",
30
31
  "typescript": "5.9.3",
31
32
  "vitest": "4.0.4",
32
33
  "@internal/eslint-config": "0.0.0",
33
34
  "@internal/tsconfig": "0.0.0"
34
35
  },
35
36
  "dependencies": {
36
- "tsup": "8.5.0",
37
37
  "zod": "4.1.12"
38
38
  },
39
39
  "scripts": {