@churchapps/content-providers 0.5.0 → 0.5.1

package/dist/index.d.cts

@@ -235,10 +235,7 @@ interface IProvider {
     checkMediaLicense?(mediaId: string, auth?: ContentProviderAuthData | null): Promise<MediaLicenseResult | null>;
 }
 
-/**
- * Navigate to a specific item using a dot-notation path.
- * Path format: "0.2.1" means items[0].children[2].children[1]
- */
+/** Navigate to a specific item using dot-notation path (e.g. "0.2.1" → items[0].children[2].children[1]). */
 declare function navigateToPath(instructions: Instructions, path: string): InstructionItem | null;
 
 declare class OAuthHelper {
@@ -269,12 +266,7 @@ declare class DeviceFlowHelper {
     calculatePollDelay(baseInterval?: number, slowDownCount?: number): number;
 }
 
-/**
- * Shared base for providers: identity metadata, an authenticated fetch wrapper, and a
- * config-driven supportsDeviceFlow. Auth-flow methods (initiateDeviceFlow, buildAuthUrl, ...)
- * deliberately do NOT live here: consumers feature-detect them with `"method" in provider`,
- * so they must exist only on the providers that actually support each flow.
- */
+/** Base for providers; auth-flow methods are intentionally not here so consumers can feature-detect with `"method" in provider`. */
 declare abstract class BaseProvider implements IProvider {
     abstract readonly id: string;
     abstract readonly name: string;
@@ -289,16 +281,7 @@ declare abstract class BaseProvider implements IProvider {
     supportsDeviceFlow(): boolean;
 }
 
-/**
- * APlay Provider
- *
- * Path structure (variable depth based on module products):
- *   /modules                                              -> list modules
- *   /modules/{moduleId}                                   -> list products OR libraries (depends on module)
- *   /modules/{moduleId}/products/{productId}              -> list libraries (if module has multiple products)
- *   /modules/{moduleId}/products/{productId}/{libraryId}  -> media files
- *   /modules/{moduleId}/libraries/{libraryId}             -> media files (if module has 0-1 products)
- */
+/** APlay Provider: media curriculum library with OAuth 2.0 auth. */
 declare class APlayProvider extends BaseProvider {
     readonly id = "aplay";
     readonly name = "APlay";
@@ -317,13 +300,7 @@ declare class APlayProvider extends BaseProvider {
     checkMediaLicense(mediaId: string, auth?: ContentProviderAuthData | null): Promise<MediaLicenseResult | null>;
 }
 
-/**
- * SignPresenter Provider
- *
- * Path structure:
- *   /playlists                    -> list playlists
- *   /playlists/{playlistId}       -> list messages (files)
- */
+/** Browses SignPresenter playlists → messages (files). */
 declare class SignPresenterProvider extends BaseProvider {
     private readonly oauthHelper;
     private readonly deviceFlowHelper;
@@ -351,18 +328,9 @@ declare class SignPresenterProvider extends BaseProvider {
 }
 
 /**
- * LessonsChurch Provider
- *
- * Path structure:
- *   /lessons                                            -> programs
- *   /lessons/{programId}                                -> studies
- *   /lessons/{programId}/{studyId}                      -> lessons
- *   /lessons/{programId}/{studyId}/{lessonId}           -> venues
- *   /lessons/{programId}/{studyId}/{lessonId}/{venueId} -> playlist files
- *
- *   /addons                                             -> categories
- *   /addons/{category}                                  -> individual add-ons
- *   /addons/{category}/{addOnId}                        -> single add-on file
+ * Path: /lessons → programs, /lessons/{id} → studies, /lessons/{id}/{id} → lessons,
+ * /lessons/{id}/{id}/{id} → venues, /lessons/{id}/{id}/{id}/{id} → files;
+ * /addons → categories, /addons/{cat} → items, /addons/{cat}/{id} → file.
  */
 declare class LessonsChurchProvider extends BaseProvider {
     readonly id = "lessonschurch";
@@ -436,7 +404,6 @@ declare class DropboxProvider extends BaseProvider {
     private resolveFileLinks;
     private checkIsLeaf;
     browse(path?: string | null, auth?: ContentProviderAuthData | null): Promise<ContentItem[]>;
-    /** Resolve a folder path to playable files (list + media filter + link resolution). */
     private resolveMediaFiles;
     getPlaylist(path: string, auth?: ContentProviderAuthData | null, _resolution?: number): Promise<ContentFile[] | null>;
     getInstructions(path: string, auth?: ContentProviderAuthData | null): Promise<Instructions | null>;
@@ -450,14 +417,7 @@ declare class DropboxProvider extends BaseProvider {
     exchangeCodeForTokens(code: string, codeVerifier: string, redirectUri: string): Promise<ContentProviderAuthData | null>;
 }
 
-/**
- * PlanningCenter Provider
- *
- * Path structure:
- *   /serviceTypes                            -> list service types
- *   /serviceTypes/{serviceTypeId}            -> list plans
- *   /serviceTypes/{serviceTypeId}/{planId}   -> plan items (leaf)
- */
+/** Browses Planning Center service types → plans → items. */
 declare class PlanningCenterProvider extends BaseProvider {
     readonly id = "planningcenter";
     readonly name = "Planning Center";
@@ -472,14 +432,7 @@ declare class PlanningCenterProvider extends BaseProvider {
     private getPlanItems;
 }
 
-/**
- * BibleProject Provider
- *
- * Path structure:
- *   /                              -> list collections
- *   /{collectionSlug}              -> list videos in collection
- *   /{collectionSlug}/{videoId}    -> single video
- */
+/** BibleProject Provider: Bible education video content. */
 declare class BibleProjectProvider extends BaseProvider {
     readonly id = "bibleproject";
     readonly name = "The Bible Project";
@@ -499,13 +452,8 @@ declare class BibleProjectProvider extends BaseProvider {
 }
 
 /**
- * HighVoltageKids Provider
- *
- * Path structure:
- *   /                                          -> list collections (Elementary, Preschool)
- *   /{collectionSlug}                          -> list studies
- *   /{collectionSlug}/{studyId}                -> list lessons
- *   /{collectionSlug}/{studyId}/{lessonId}     -> lesson files (leaf)
+ * Path structure: / → collections, /{collection} → studies, /{collection}/{study} → lessons,
+ * /{collection}/{study}/{lesson} → files (leaf).
  */
 declare class HighVoltageKidsProvider extends BaseProvider {
     readonly id = "highvoltagekids";
@@ -522,15 +470,8 @@ declare class HighVoltageKidsProvider extends BaseProvider {
 }
 
 /**
- * Jesus Film Project Provider
- *
- * Uses the public Arclight API to browse video content from jesusfilm.org.
- *
- * Path structure:
- *   /                                    -> categories (Feature Films, Series, Collections)
- *   /{category}                          -> list items in category
- *   /{category}/{id}                     -> single video (feature film) or container children (series/collection)
- *   /{category}/{...containerIds}/{id}   -> nested containers or single video (supports arbitrary depth)
+ * Path: / → categories, /{category} → items, /{category}/{id} → video or children,
+ * /{category}/{...ids}/{id} → nested containers or video.
  */
 declare class JesusFilmProvider extends BaseProvider {
     readonly id = "jesusfilm";
@@ -556,17 +497,7 @@ declare class JesusFilmProvider extends BaseProvider {
     getInstructions(path: string, _auth?: ContentProviderAuthData | null): Promise<Instructions | null>;
 }
 
-/**
- * CBN Provider
- *
- * Faith-based kids' video curriculum. Auth uses OAuth 2.0 Device Flow.
- *
- * Path structure:
- *   /                              -> single "Catalog" root folder
- *   /catalog                       -> course folders (GET /catalog)
- *   /catalog/{courseId}            -> lesson folders (GET /catalog/{courseId})
- *   /catalog/{courseId}/{lessonId} -> video files   (GET /lesson-playlist/{lessonId})
- */
+/** Faith-based kids' video curriculum with OAuth 2.0 Device Flow auth. */
 declare class CbnProvider extends BaseProvider {
     private readonly deviceFlowHelper;
     readonly id = "cbn";
@@ -585,26 +516,7 @@ declare class CbnProvider extends BaseProvider {
     pollDeviceFlowToken(deviceCode: string): Promise<DeviceFlowPollResult>;
 }
 
-/**
- * Life.Church Provider
- *
- * Browses the Life.Church kids curriculum from a static catalog generated by
- * scripts/scrape-lifechurch.ts (sourced from life.church/media/* + the
- * open.life.church weekly calendar).
- *
- * Path structure:
- *   /                                       -> "scheduled" folder + 4 series
- *   /scheduled                              -> this Sunday's scheduled lessons (one per age group)
- *   /scheduled/{scheduledId}                -> single video file (leaf)
- *   /{seriesId}                             -> units within the series
- *   /{seriesId}/{unitId}                    -> lessons within the unit
- *   /{seriesId}/{unitId}/{lessonId}         -> single video file (leaf)
- *
- * Video delivery: ContentFile.url is a direct mp4 on Life.Church's CDN
- * (https://d.life.church/.../{slug}_720p.mp4). Public, no auth, supports
- * range requests — plays in any standard mp4 player including
- * react-native-video.
- */
+/** Browses Life.Church's kids curriculum from a static catalog (series → units → lessons), plus a weekly scheduled lesson index. */
 declare class LifeChurchProvider extends BaseProvider {
     readonly id = "lifechurch";
     readonly name = "Life.Church";
@@ -638,11 +550,7 @@ declare function registerProvider(provider: IProvider): void;
  * Get provider configuration by ID (for backward compatibility).
  */
 declare function getProviderConfig(providerId: string): ContentProviderConfig | null;
-/**
- * Get list of available providers with their info including logos and auth types.
- * Includes both implemented providers and coming soon providers.
- * @param ids - Optional array of provider IDs to filter the results. If provided, only providers with matching IDs will be returned.
- */
+/** Get available providers (implemented and coming soon), optionally filtered by IDs. */
 declare function getAvailableProviders(ids?: string[]): ProviderInfo[];
 
 /**

package/dist/index.d.ts

@@ -235,10 +235,7 @@ interface IProvider {
     checkMediaLicense?(mediaId: string, auth?: ContentProviderAuthData | null): Promise<MediaLicenseResult | null>;
 }
 
-/**
- * Navigate to a specific item using a dot-notation path.
- * Path format: "0.2.1" means items[0].children[2].children[1]
- */
+/** Navigate to a specific item using dot-notation path (e.g. "0.2.1" → items[0].children[2].children[1]). */
 declare function navigateToPath(instructions: Instructions, path: string): InstructionItem | null;
 
 declare class OAuthHelper {
@@ -269,12 +266,7 @@ declare class DeviceFlowHelper {
     calculatePollDelay(baseInterval?: number, slowDownCount?: number): number;
 }
 
-/**
- * Shared base for providers: identity metadata, an authenticated fetch wrapper, and a
- * config-driven supportsDeviceFlow. Auth-flow methods (initiateDeviceFlow, buildAuthUrl, ...)
- * deliberately do NOT live here: consumers feature-detect them with `"method" in provider`,
- * so they must exist only on the providers that actually support each flow.
- */
+/** Base for providers; auth-flow methods are intentionally not here so consumers can feature-detect with `"method" in provider`. */
 declare abstract class BaseProvider implements IProvider {
     abstract readonly id: string;
     abstract readonly name: string;
@@ -289,16 +281,7 @@ declare abstract class BaseProvider implements IProvider {
     supportsDeviceFlow(): boolean;
 }
 
-/**
- * APlay Provider
- *
- * Path structure (variable depth based on module products):
- *   /modules                                              -> list modules
- *   /modules/{moduleId}                                   -> list products OR libraries (depends on module)
- *   /modules/{moduleId}/products/{productId}              -> list libraries (if module has multiple products)
- *   /modules/{moduleId}/products/{productId}/{libraryId}  -> media files
- *   /modules/{moduleId}/libraries/{libraryId}             -> media files (if module has 0-1 products)
- */
+/** APlay Provider: media curriculum library with OAuth 2.0 auth. */
 declare class APlayProvider extends BaseProvider {
     readonly id = "aplay";
     readonly name = "APlay";
@@ -317,13 +300,7 @@ declare class APlayProvider extends BaseProvider {
     checkMediaLicense(mediaId: string, auth?: ContentProviderAuthData | null): Promise<MediaLicenseResult | null>;
 }
 
-/**
- * SignPresenter Provider
- *
- * Path structure:
- *   /playlists                    -> list playlists
- *   /playlists/{playlistId}       -> list messages (files)
- */
+/** Browses SignPresenter playlists → messages (files). */
 declare class SignPresenterProvider extends BaseProvider {
     private readonly oauthHelper;
     private readonly deviceFlowHelper;
@@ -351,18 +328,9 @@ declare class SignPresenterProvider extends BaseProvider {
 }
 
 /**
- * LessonsChurch Provider
- *
- * Path structure:
- *   /lessons                                            -> programs
- *   /lessons/{programId}                                -> studies
- *   /lessons/{programId}/{studyId}                      -> lessons
- *   /lessons/{programId}/{studyId}/{lessonId}           -> venues
- *   /lessons/{programId}/{studyId}/{lessonId}/{venueId} -> playlist files
- *
- *   /addons                                             -> categories
- *   /addons/{category}                                  -> individual add-ons
- *   /addons/{category}/{addOnId}                        -> single add-on file
+ * Path: /lessons → programs, /lessons/{id} → studies, /lessons/{id}/{id} → lessons,
+ * /lessons/{id}/{id}/{id} → venues, /lessons/{id}/{id}/{id}/{id} → files;
+ * /addons → categories, /addons/{cat} → items, /addons/{cat}/{id} → file.
  */
 declare class LessonsChurchProvider extends BaseProvider {
     readonly id = "lessonschurch";
@@ -436,7 +404,6 @@ declare class DropboxProvider extends BaseProvider {
     private resolveFileLinks;
     private checkIsLeaf;
     browse(path?: string | null, auth?: ContentProviderAuthData | null): Promise<ContentItem[]>;
-    /** Resolve a folder path to playable files (list + media filter + link resolution). */
     private resolveMediaFiles;
     getPlaylist(path: string, auth?: ContentProviderAuthData | null, _resolution?: number): Promise<ContentFile[] | null>;
     getInstructions(path: string, auth?: ContentProviderAuthData | null): Promise<Instructions | null>;
@@ -450,14 +417,7 @@ declare class DropboxProvider extends BaseProvider {
     exchangeCodeForTokens(code: string, codeVerifier: string, redirectUri: string): Promise<ContentProviderAuthData | null>;
 }
 
-/**
- * PlanningCenter Provider
- *
- * Path structure:
- *   /serviceTypes                            -> list service types
- *   /serviceTypes/{serviceTypeId}            -> list plans
- *   /serviceTypes/{serviceTypeId}/{planId}   -> plan items (leaf)
- */
+/** Browses Planning Center service types → plans → items. */
 declare class PlanningCenterProvider extends BaseProvider {
     readonly id = "planningcenter";
     readonly name = "Planning Center";
@@ -472,14 +432,7 @@ declare class PlanningCenterProvider extends BaseProvider {
     private getPlanItems;
 }
 
-/**
- * BibleProject Provider
- *
- * Path structure:
- *   /                              -> list collections
- *   /{collectionSlug}              -> list videos in collection
- *   /{collectionSlug}/{videoId}    -> single video
- */
+/** BibleProject Provider: Bible education video content. */
 declare class BibleProjectProvider extends BaseProvider {
     readonly id = "bibleproject";
     readonly name = "The Bible Project";
@@ -499,13 +452,8 @@ declare class BibleProjectProvider extends BaseProvider {
 }
 
 /**
- * HighVoltageKids Provider
- *
- * Path structure:
- *   /                                          -> list collections (Elementary, Preschool)
- *   /{collectionSlug}                          -> list studies
- *   /{collectionSlug}/{studyId}                -> list lessons
- *   /{collectionSlug}/{studyId}/{lessonId}     -> lesson files (leaf)
+ * Path structure: / → collections, /{collection} → studies, /{collection}/{study} → lessons,
+ * /{collection}/{study}/{lesson} → files (leaf).
  */
 declare class HighVoltageKidsProvider extends BaseProvider {
     readonly id = "highvoltagekids";
@@ -522,15 +470,8 @@ declare class HighVoltageKidsProvider extends BaseProvider {
 }
 
 /**
- * Jesus Film Project Provider
- *
- * Uses the public Arclight API to browse video content from jesusfilm.org.
- *
- * Path structure:
- *   /                                    -> categories (Feature Films, Series, Collections)
- *   /{category}                          -> list items in category
- *   /{category}/{id}                     -> single video (feature film) or container children (series/collection)
- *   /{category}/{...containerIds}/{id}   -> nested containers or single video (supports arbitrary depth)
+ * Path: / → categories, /{category} → items, /{category}/{id} → video or children,
+ * /{category}/{...ids}/{id} → nested containers or video.
  */
 declare class JesusFilmProvider extends BaseProvider {
     readonly id = "jesusfilm";
@@ -556,17 +497,7 @@ declare class JesusFilmProvider extends BaseProvider {
     getInstructions(path: string, _auth?: ContentProviderAuthData | null): Promise<Instructions | null>;
 }
 
-/**
- * CBN Provider
- *
- * Faith-based kids' video curriculum. Auth uses OAuth 2.0 Device Flow.
- *
- * Path structure:
- *   /                              -> single "Catalog" root folder
- *   /catalog                       -> course folders (GET /catalog)
- *   /catalog/{courseId}            -> lesson folders (GET /catalog/{courseId})
- *   /catalog/{courseId}/{lessonId} -> video files   (GET /lesson-playlist/{lessonId})
- */
+/** Faith-based kids' video curriculum with OAuth 2.0 Device Flow auth. */
 declare class CbnProvider extends BaseProvider {
     private readonly deviceFlowHelper;
     readonly id = "cbn";
@@ -585,26 +516,7 @@ declare class CbnProvider extends BaseProvider {
     pollDeviceFlowToken(deviceCode: string): Promise<DeviceFlowPollResult>;
 }
 
-/**
- * Life.Church Provider
- *
- * Browses the Life.Church kids curriculum from a static catalog generated by
- * scripts/scrape-lifechurch.ts (sourced from life.church/media/* + the
- * open.life.church weekly calendar).
- *
- * Path structure:
- *   /                                       -> "scheduled" folder + 4 series
- *   /scheduled                              -> this Sunday's scheduled lessons (one per age group)
- *   /scheduled/{scheduledId}                -> single video file (leaf)
- *   /{seriesId}                             -> units within the series
- *   /{seriesId}/{unitId}                    -> lessons within the unit
- *   /{seriesId}/{unitId}/{lessonId}         -> single video file (leaf)
- *
- * Video delivery: ContentFile.url is a direct mp4 on Life.Church's CDN
- * (https://d.life.church/.../{slug}_720p.mp4). Public, no auth, supports
- * range requests — plays in any standard mp4 player including
- * react-native-video.
- */
+/** Browses Life.Church's kids curriculum from a static catalog (series → units → lessons), plus a weekly scheduled lesson index. */
 declare class LifeChurchProvider extends BaseProvider {
     readonly id = "lifechurch";
     readonly name = "Life.Church";
@@ -638,11 +550,7 @@ declare function registerProvider(provider: IProvider): void;
  * Get provider configuration by ID (for backward compatibility).
  */
 declare function getProviderConfig(providerId: string): ContentProviderConfig | null;
-/**
- * Get list of available providers with their info including logos and auth types.
- * Includes both implemented providers and coming soon providers.
- * @param ids - Optional array of provider IDs to filter the results. If provided, only providers with matching IDs will be returned.
- */
+/** Get available providers (implemented and coming soon), optionally filtered by IDs. */
 declare function getAvailableProviders(ids?: string[]): ProviderInfo[];
 
 /**

package/dist/index.js

@@ -546,7 +546,6 @@ var SignPresenterProvider = class extends BaseProvider {
     const instructions = filesToInstructions(title, files, { id: playlistId + "-section", label: title });
     return { name: title, items: [{ id: playlistId + "-header", itemType: "header", label: title, children: instructions.items }] };
   }
-  // Auth methods
   generateCodeVerifier() {
     return this.oauthHelper.generateCodeVerifier();
   }
@@ -1663,7 +1662,6 @@ var DropboxProvider = class extends BaseProvider {
       mediaLicensing: false
     };
   }
-  // -- Pagination helper --
   dropboxPost(endpoint, body, auth) {
     if (!auth) {
       console.error("[Dropbox] No auth token provided");
@@ -1697,7 +1695,6 @@ var DropboxProvider = class extends BaseProvider {
     }
     return allEntries;
   }
-  // -- File link helpers --
   async getSharedLink(filePath, auth) {
     if (!auth) return null;
     try {
@@ -1753,7 +1750,6 @@ var DropboxProvider = class extends BaseProvider {
     );
     return results.filter((r) => r.viewUrl || r.downloadUrl).map((r) => fileEntryToContentFile(r.entry, r.viewUrl || r.downloadUrl, r.downloadUrl));
   }
-  // -- Leaf detection --
   async checkIsLeaf(folderPath, auth) {
     const response = await this.dropboxPost(
       "/2/files/list_folder",
@@ -1763,7 +1759,6 @@ var DropboxProvider = class extends BaseProvider {
     if (!response) return false;
     return !response.entries.some((e) => e[".tag"] === "folder");
   }
-  // -- IProvider methods --
   async browse(path, auth) {
     const dropboxPath = path && path !== "/" ? path.startsWith("/") ? path : "/" + path : "";
     const allEntries = await this.listAllEntries(dropboxPath, auth);
@@ -1775,7 +1770,6 @@ var DropboxProvider = class extends BaseProvider {
     const fileItems = await this.resolveFileLinks(mediaFiles, auth);
     return [...folderItems, ...fileItems];
   }
-  /** Resolve a folder path to playable files (list + media filter + link resolution). */
   async resolveMediaFiles(path, auth) {
     if (!path || path === "/") return null;
     const dropboxPath = path.startsWith("/") ? path : "/" + path;
@@ -1797,7 +1791,6 @@ var DropboxProvider = class extends BaseProvider {
     const folderName = segments[segments.length - 1] || "Dropbox";
     return filesToInstructions(folderName, resolved.files, { id: "dropbox-section", label: folderName });
   }
-  // -- Auth methods --
   generateCodeVerifier() {
     return this.oauthHelper.generateCodeVerifier();
   }
@@ -16317,7 +16310,7 @@ function getAvailableProviders(ids) {
 }
 
 // src/index.ts
-var VERSION = true ? "0.5.0" : "dev";
+var VERSION = true ? "0.5.1" : "dev";
 export {
   APlayProvider,
   B1ChurchProvider,