@churchapps/content-provider-helper 0.0.1
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.
- package/LICENSE +21 -0
- package/README.md +101 -0
- package/dist/index.cjs +11908 -0
- package/dist/index.cjs.map +1 -0
- package/dist/index.d.cts +733 -0
- package/dist/index.d.ts +733 -0
- package/dist/index.js +11866 -0
- package/dist/index.js.map +1 -0
- package/package.json +48 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 ChurchApps
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,101 @@
|
|
|
1
|
+
<img align="right" width="150" src="https://raw.githubusercontent.com/ChurchApps/B1Admin/main/public/images/logo.png">
|
|
2
|
+
|
|
3
|
+
# @churchapps/content-provider-helper
|
|
4
|
+
|
|
5
|
+
> **ContentProviderHelper** is a TypeScript library for integrating with third-party content providers like Planning Center, Lessons.church, and more. It provides a unified interface for browsing media libraries, handling OAuth authentication, and retrieving content for playback in church presentation software.
|
|
6
|
+
|
|
7
|
+
## Installation
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
npm install @churchapps/content-provider-helper
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Usage
|
|
14
|
+
|
|
15
|
+
### Browse Available Providers
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import { getAllProviders, getAvailableProviders } from '@churchapps/content-provider-helper';
|
|
19
|
+
|
|
20
|
+
// Get all registered providers
|
|
21
|
+
const providers = getAllProviders();
|
|
22
|
+
|
|
23
|
+
// Get info about available providers
|
|
24
|
+
const available = getAvailableProviders();
|
|
25
|
+
console.log(available); // [{ id: 'planningcenter', name: 'Planning Center', ... }]
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
### Use a Specific Provider
|
|
29
|
+
|
|
30
|
+
```typescript
|
|
31
|
+
import { getProvider } from '@churchapps/content-provider-helper';
|
|
32
|
+
|
|
33
|
+
const provider = getProvider('planningcenter');
|
|
34
|
+
|
|
35
|
+
// Browse content
|
|
36
|
+
const items = await provider.browse();
|
|
37
|
+
|
|
38
|
+
// Get presentations/playlist for a service
|
|
39
|
+
const plan = await provider.getPresentations(serviceId);
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
### Built-in Providers
|
|
43
|
+
|
|
44
|
+
- **B1ChurchProvider** - B1.Church content integration
|
|
45
|
+
- **PlanningCenterProvider** - Planning Center Services
|
|
46
|
+
- **LessonsChurchProvider** - Lessons.church curriculum
|
|
47
|
+
- **BibleProjectProvider** - Bible Project videos
|
|
48
|
+
- **APlayProvider** - A.Play media library
|
|
49
|
+
- **SignPresenterProvider** - Sign Presenter content
|
|
50
|
+
|
|
51
|
+
### Create a Custom Provider
|
|
52
|
+
|
|
53
|
+
```typescript
|
|
54
|
+
import { ContentProvider, registerProvider } from '@churchapps/content-provider-helper';
|
|
55
|
+
|
|
56
|
+
class MyProvider extends ContentProvider {
|
|
57
|
+
// Implement required methods
|
|
58
|
+
}
|
|
59
|
+
|
|
60
|
+
registerProvider(new MyProvider());
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
### Utilities
|
|
64
|
+
|
|
65
|
+
```typescript
|
|
66
|
+
import { detectMediaType } from '@churchapps/content-provider-helper';
|
|
67
|
+
|
|
68
|
+
detectMediaType('https://example.com/video.mp4'); // 'video'
|
|
69
|
+
detectMediaType('https://example.com/image.png'); // 'image'
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
## Get Involved
|
|
73
|
+
|
|
74
|
+
### 🤝 Help Support Us
|
|
75
|
+
|
|
76
|
+
The only reason this program is free is because of the generous support from users. If you want to support us to keep this free, please head over to [ChurchApps](https://churchapps.org/partner) or [sponsor us on GitHub](https://github.com/sponsors/ChurchApps/). Thank you so much!
|
|
77
|
+
|
|
78
|
+
### 🏘️ Join the Community
|
|
79
|
+
|
|
80
|
+
We have a great community for end-users on [Facebook](https://www.facebook.com/churchapps.org). It's a good way to ask questions, get tips and follow new updates. Come join us!
|
|
81
|
+
|
|
82
|
+
### ⚠️ Report an Issue
|
|
83
|
+
|
|
84
|
+
If you discover an issue or have a feature request, simply submit it to our [issues log](https://github.com/ChurchApps/ContentProviderHelper/issues). Don't be shy, that's how the program gets better.
|
|
85
|
+
|
|
86
|
+
### 💬 Join us on Slack
|
|
87
|
+
|
|
88
|
+
If you would like to contribute in any way, head over to our [Slack Channel](https://join.slack.com/t/livechurchsolutions/shared_invite/zt-i88etpo5-ZZhYsQwQLVclW12DKtVflg) and introduce yourself. We'd love to hear from you.
|
|
89
|
+
|
|
90
|
+
### 💻 Start Coding
|
|
91
|
+
|
|
92
|
+
If you'd like to contribute to the project:
|
|
93
|
+
|
|
94
|
+
1. Clone the repository
|
|
95
|
+
2. Install dependencies: `npm install`
|
|
96
|
+
3. Run the development playground: `npm run dev`
|
|
97
|
+
4. Build: `npm run build`
|
|
98
|
+
|
|
99
|
+
## License
|
|
100
|
+
|
|
101
|
+
MIT
|