@churchapps/content-providers 0.1.13 → 0.3.0

package/dist/index.d.cts

@@ -149,6 +149,33 @@ interface Instructions {
     name?: string;
     items: InstructionItem[];
 }
+interface MessageFileInterface {
+    id?: string;
+    name?: string;
+    url?: string;
+    seconds?: number;
+    fileType?: string;
+    sort?: number;
+    loop?: boolean;
+    loopVideo?: boolean;
+    image?: string;
+}
+interface PlanTimelineItem {
+    id: string;
+    label?: string;
+    itemType?: string;
+    seconds?: number;
+    fileIds?: string[];
+    children?: PlanTimelineItem[];
+}
+interface CurrentPlan {
+    id: string;
+    title: string;
+    serviceDate?: string;
+    thumbnail?: string;
+    files: MessageFileInterface[];
+    timeline?: PlanTimelineItem[];
+}
 interface VenueActionInterface {
     id?: string;
     name?: string;
@@ -199,12 +226,17 @@ interface IProvider {
     exchangeCodeForTokens?(code: string, codeVerifier: string, redirectUri: string): Promise<ContentProviderAuthData | null>;
     initiateDeviceFlow?(): Promise<DeviceAuthorizationResponse | null>;
     pollDeviceFlowToken?(deviceCode: string): Promise<DeviceFlowPollResult>;
+    performLogin?(email: string, password: string): Promise<ContentProviderAuthData | null>;
     getPlaylist?(path: string, auth?: ContentProviderAuthData | null, resolution?: number): Promise<ContentFile[] | null>;
     getInstructions?(path: string, auth?: ContentProviderAuthData | null): Promise<Instructions | null>;
+    getCurrentPlan?(auth?: ContentProviderAuthData | null): Promise<CurrentPlan | null>;
+    /** Hand opaque pairing data (provider-specific shape) to the provider so it can resolve its current plan. */
+    setPairingData?(data: unknown): void;
     checkMediaLicense?(mediaId: string, auth?: ContentProviderAuthData | null): Promise<MediaLicenseResult | null>;
 }
 
 declare function detectMediaType(url: string, explicitType?: string): "video" | "image";
+declare function isMediaFile(filename: string): boolean;
 declare function createFolder(id: string, title: string, path: string, thumbnail?: string, isLeaf?: boolean): ContentFolder;
 declare function createFile(id: string, title: string, url: string, options?: {
     mediaType?: "video" | "image";
@@ -371,7 +403,7 @@ declare class DeviceFlowHelper {
 
 declare class ApiHelper {
     createAuthHeaders(auth: ContentProviderAuthData | null | undefined): Record<string, string> | null;
-    apiRequest<T>(config: ContentProviderConfig, _providerId: string, path: string, auth?: ContentProviderAuthData | null, method?: "GET" | "POST", body?: unknown): Promise<T | null>;
+    apiRequest<T>(config: ContentProviderConfig, providerId: string, path: string, auth?: ContentProviderAuthData | null, method?: "GET" | "POST", body?: unknown): Promise<T | null>;
 }
 
 /**
@@ -501,6 +533,9 @@ declare class B1ChurchProvider implements IProvider {
     pollDeviceFlowToken(deviceCode: string): Promise<DeviceFlowPollResult>;
     browse(path?: string | null, authData?: ContentProviderAuthData | null): Promise<ContentItem[]>;
     private fetchPlanImages;
+    private planTypeId;
+    setPairingData(data: unknown): void;
+    getCurrentPlan(_authData?: ContentProviderAuthData | null): Promise<CurrentPlan | null>;
     getInstructions(path: string, authData?: ContentProviderAuthData | null): Promise<Instructions | null>;
     private processInstructionItems;
     private findItemByPath;
@@ -511,6 +546,7 @@ declare class B1ChurchProvider implements IProvider {
 
 declare class DropboxProvider implements IProvider {
     private readonly oauthHelper;
+    private readonly apiHelper;
     readonly id = "dropbox";
     readonly name = "Dropbox";
     readonly logos: ProviderLogos;
@@ -534,6 +570,8 @@ declare class DropboxProvider implements IProvider {
         url: string;
         challengeMethod: string;
     }>;
+    /** For environments without Web Crypto (e.g. React Native): caller computes the challenge. */
+    buildAuthUrlFromChallenge(codeChallenge: string, redirectUri: string, state: string): string;
     exchangeCodeForTokens(code: string, codeVerifier: string, redirectUri: string): Promise<ContentProviderAuthData | null>;
 }
 
@@ -650,17 +688,43 @@ declare class JesusFilmProvider implements IProvider {
 }
 
 /**
- * Get a provider by ID.
+ * 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})
  */
+declare class CbnProvider implements IProvider {
+    private readonly apiHelper;
+    private readonly deviceFlowHelper;
+    private apiRequest;
+    readonly id = "cbn";
+    readonly name = "CBN";
+    readonly logos: ProviderLogos;
+    readonly config: ContentProviderConfig;
+    readonly requiresAuth = true;
+    readonly authTypes: AuthType[];
+    readonly capabilities: ProviderCapabilities;
+    browse(path?: string | null, auth?: ContentProviderAuthData | null): Promise<ContentItem[]>;
+    private getCourses;
+    private getLessons;
+    private getVideos;
+    private fetchPlaylist;
+    getPlaylist(path: string, auth?: ContentProviderAuthData | null, _resolution?: number): Promise<ContentFile[] | null>;
+    getInstructions(path: string, auth?: ContentProviderAuthData | null): Promise<Instructions | null>;
+    supportsDeviceFlow(): boolean;
+    initiateDeviceFlow(): Promise<DeviceAuthorizationResponse | null>;
+    pollDeviceFlowToken(deviceCode: string): Promise<DeviceFlowPollResult>;
+}
+
 declare function getProvider(providerId: string): IProvider | null;
-/**
- * Get all registered providers.
- */
 declare function getAllProviders(): IProvider[];
-/**
- * Register a custom provider.
- */
 declare function registerProvider(provider: IProvider): void;
+
 /**
  * Get provider configuration by ID (for backward compatibility).
  */
@@ -678,4 +742,4 @@ declare function getAvailableProviders(ids?: string[]): ProviderInfo[];
  */
 declare const VERSION = "0.0.5";
 
-export { APlayProvider, ApiHelper, type AuthType, B1ChurchProvider, BibleProjectProvider, type ContentFile, type ContentFolder, type ContentItem, type ContentProviderAuthData, type ContentProviderConfig, DEFAULT_DURATION_CONFIG, type DeviceAuthorizationResponse, DeviceFlowHelper, type DeviceFlowPollResult, type DeviceFlowState, DropboxProvider, type DurationEstimationConfig, type EndpointValue, type EndpointsConfig, type FeedActionInterface, type FeedFileInterface, type FeedSectionInterface, type FeedVenueInterface, FormatConverters, FormatResolver, type FormatResolverOptions, HighVoltageKidsProvider, type IProvider, type InstructionItem, type Instructions, JesusFilmProvider, LessonsChurchProvider, type MediaLicenseResult, type MediaLicenseStatus, OAuthHelper, type Plan, type PlanPresentation, type PlanSection, PlanningCenterProvider, type ProviderCapabilities, type ProviderInfo, type ProviderLogos, type ResolvedFormatMeta, SignPresenterProvider, TokenHelper, VERSION, type VenueActionInterface, type VenueActionsResponseInterface, type VenueSectionActionsInterface, appendToPath, buildPath, countWords, createFile, createFolder, detectMediaType, estimateDuration, estimateImageDuration, estimateTextDuration, generatePath, getAllProviders, getAvailableProviders, getProvider, getProviderConfig, getSegment, isContentFile, isContentFolder, navigateToPath, parsePath, registerProvider };
+export { APlayProvider, ApiHelper, type AuthType, B1ChurchProvider, BibleProjectProvider, CbnProvider, type ContentFile, type ContentFolder, type ContentItem, type ContentProviderAuthData, type ContentProviderConfig, type CurrentPlan, DEFAULT_DURATION_CONFIG, type DeviceAuthorizationResponse, DeviceFlowHelper, type DeviceFlowPollResult, type DeviceFlowState, DropboxProvider, type DurationEstimationConfig, type EndpointValue, type EndpointsConfig, type FeedActionInterface, type FeedFileInterface, type FeedSectionInterface, type FeedVenueInterface, FormatConverters, FormatResolver, type FormatResolverOptions, HighVoltageKidsProvider, type IProvider, type InstructionItem, type Instructions, JesusFilmProvider, LessonsChurchProvider, type MediaLicenseResult, type MediaLicenseStatus, type MessageFileInterface, OAuthHelper, type Plan, type PlanPresentation, type PlanSection, type PlanTimelineItem, PlanningCenterProvider, type ProviderCapabilities, type ProviderInfo, type ProviderLogos, type ResolvedFormatMeta, SignPresenterProvider, TokenHelper, VERSION, type VenueActionInterface, type VenueActionsResponseInterface, type VenueSectionActionsInterface, appendToPath, buildPath, countWords, createFile, createFolder, detectMediaType, estimateDuration, estimateImageDuration, estimateTextDuration, generatePath, getAllProviders, getAvailableProviders, getProvider, getProviderConfig, getSegment, isContentFile, isContentFolder, isMediaFile, navigateToPath, parsePath, registerProvider };

package/dist/index.d.ts

@@ -149,6 +149,33 @@ interface Instructions {
     name?: string;
     items: InstructionItem[];
 }
+interface MessageFileInterface {
+    id?: string;
+    name?: string;
+    url?: string;
+    seconds?: number;
+    fileType?: string;
+    sort?: number;
+    loop?: boolean;
+    loopVideo?: boolean;
+    image?: string;
+}
+interface PlanTimelineItem {
+    id: string;
+    label?: string;
+    itemType?: string;
+    seconds?: number;
+    fileIds?: string[];
+    children?: PlanTimelineItem[];
+}
+interface CurrentPlan {
+    id: string;
+    title: string;
+    serviceDate?: string;
+    thumbnail?: string;
+    files: MessageFileInterface[];
+    timeline?: PlanTimelineItem[];
+}
 interface VenueActionInterface {
     id?: string;
     name?: string;
@@ -199,12 +226,17 @@ interface IProvider {
     exchangeCodeForTokens?(code: string, codeVerifier: string, redirectUri: string): Promise<ContentProviderAuthData | null>;
     initiateDeviceFlow?(): Promise<DeviceAuthorizationResponse | null>;
     pollDeviceFlowToken?(deviceCode: string): Promise<DeviceFlowPollResult>;
+    performLogin?(email: string, password: string): Promise<ContentProviderAuthData | null>;
     getPlaylist?(path: string, auth?: ContentProviderAuthData | null, resolution?: number): Promise<ContentFile[] | null>;
     getInstructions?(path: string, auth?: ContentProviderAuthData | null): Promise<Instructions | null>;
+    getCurrentPlan?(auth?: ContentProviderAuthData | null): Promise<CurrentPlan | null>;
+    /** Hand opaque pairing data (provider-specific shape) to the provider so it can resolve its current plan. */
+    setPairingData?(data: unknown): void;
     checkMediaLicense?(mediaId: string, auth?: ContentProviderAuthData | null): Promise<MediaLicenseResult | null>;
 }
 
 declare function detectMediaType(url: string, explicitType?: string): "video" | "image";
+declare function isMediaFile(filename: string): boolean;
 declare function createFolder(id: string, title: string, path: string, thumbnail?: string, isLeaf?: boolean): ContentFolder;
 declare function createFile(id: string, title: string, url: string, options?: {
     mediaType?: "video" | "image";
@@ -371,7 +403,7 @@ declare class DeviceFlowHelper {
 
 declare class ApiHelper {
     createAuthHeaders(auth: ContentProviderAuthData | null | undefined): Record<string, string> | null;
-    apiRequest<T>(config: ContentProviderConfig, _providerId: string, path: string, auth?: ContentProviderAuthData | null, method?: "GET" | "POST", body?: unknown): Promise<T | null>;
+    apiRequest<T>(config: ContentProviderConfig, providerId: string, path: string, auth?: ContentProviderAuthData | null, method?: "GET" | "POST", body?: unknown): Promise<T | null>;
 }
 
 /**
@@ -501,6 +533,9 @@ declare class B1ChurchProvider implements IProvider {
     pollDeviceFlowToken(deviceCode: string): Promise<DeviceFlowPollResult>;
     browse(path?: string | null, authData?: ContentProviderAuthData | null): Promise<ContentItem[]>;
     private fetchPlanImages;
+    private planTypeId;
+    setPairingData(data: unknown): void;
+    getCurrentPlan(_authData?: ContentProviderAuthData | null): Promise<CurrentPlan | null>;
     getInstructions(path: string, authData?: ContentProviderAuthData | null): Promise<Instructions | null>;
     private processInstructionItems;
     private findItemByPath;
@@ -511,6 +546,7 @@ declare class B1ChurchProvider implements IProvider {
 
 declare class DropboxProvider implements IProvider {
     private readonly oauthHelper;
+    private readonly apiHelper;
     readonly id = "dropbox";
     readonly name = "Dropbox";
     readonly logos: ProviderLogos;
@@ -534,6 +570,8 @@ declare class DropboxProvider implements IProvider {
         url: string;
         challengeMethod: string;
     }>;
+    /** For environments without Web Crypto (e.g. React Native): caller computes the challenge. */
+    buildAuthUrlFromChallenge(codeChallenge: string, redirectUri: string, state: string): string;
     exchangeCodeForTokens(code: string, codeVerifier: string, redirectUri: string): Promise<ContentProviderAuthData | null>;
 }
 
@@ -650,17 +688,43 @@ declare class JesusFilmProvider implements IProvider {
 }
 
 /**
- * Get a provider by ID.
+ * 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})
  */
+declare class CbnProvider implements IProvider {
+    private readonly apiHelper;
+    private readonly deviceFlowHelper;
+    private apiRequest;
+    readonly id = "cbn";
+    readonly name = "CBN";
+    readonly logos: ProviderLogos;
+    readonly config: ContentProviderConfig;
+    readonly requiresAuth = true;
+    readonly authTypes: AuthType[];
+    readonly capabilities: ProviderCapabilities;
+    browse(path?: string | null, auth?: ContentProviderAuthData | null): Promise<ContentItem[]>;
+    private getCourses;
+    private getLessons;
+    private getVideos;
+    private fetchPlaylist;
+    getPlaylist(path: string, auth?: ContentProviderAuthData | null, _resolution?: number): Promise<ContentFile[] | null>;
+    getInstructions(path: string, auth?: ContentProviderAuthData | null): Promise<Instructions | null>;
+    supportsDeviceFlow(): boolean;
+    initiateDeviceFlow(): Promise<DeviceAuthorizationResponse | null>;
+    pollDeviceFlowToken(deviceCode: string): Promise<DeviceFlowPollResult>;
+}
+
 declare function getProvider(providerId: string): IProvider | null;
-/**
- * Get all registered providers.
- */
 declare function getAllProviders(): IProvider[];
-/**
- * Register a custom provider.
- */
 declare function registerProvider(provider: IProvider): void;
+
 /**
  * Get provider configuration by ID (for backward compatibility).
  */
@@ -678,4 +742,4 @@ declare function getAvailableProviders(ids?: string[]): ProviderInfo[];
  */
 declare const VERSION = "0.0.5";
 
-export { APlayProvider, ApiHelper, type AuthType, B1ChurchProvider, BibleProjectProvider, type ContentFile, type ContentFolder, type ContentItem, type ContentProviderAuthData, type ContentProviderConfig, DEFAULT_DURATION_CONFIG, type DeviceAuthorizationResponse, DeviceFlowHelper, type DeviceFlowPollResult, type DeviceFlowState, DropboxProvider, type DurationEstimationConfig, type EndpointValue, type EndpointsConfig, type FeedActionInterface, type FeedFileInterface, type FeedSectionInterface, type FeedVenueInterface, FormatConverters, FormatResolver, type FormatResolverOptions, HighVoltageKidsProvider, type IProvider, type InstructionItem, type Instructions, JesusFilmProvider, LessonsChurchProvider, type MediaLicenseResult, type MediaLicenseStatus, OAuthHelper, type Plan, type PlanPresentation, type PlanSection, PlanningCenterProvider, type ProviderCapabilities, type ProviderInfo, type ProviderLogos, type ResolvedFormatMeta, SignPresenterProvider, TokenHelper, VERSION, type VenueActionInterface, type VenueActionsResponseInterface, type VenueSectionActionsInterface, appendToPath, buildPath, countWords, createFile, createFolder, detectMediaType, estimateDuration, estimateImageDuration, estimateTextDuration, generatePath, getAllProviders, getAvailableProviders, getProvider, getProviderConfig, getSegment, isContentFile, isContentFolder, navigateToPath, parsePath, registerProvider };
+export { APlayProvider, ApiHelper, type AuthType, B1ChurchProvider, BibleProjectProvider, CbnProvider, type ContentFile, type ContentFolder, type ContentItem, type ContentProviderAuthData, type ContentProviderConfig, type CurrentPlan, DEFAULT_DURATION_CONFIG, type DeviceAuthorizationResponse, DeviceFlowHelper, type DeviceFlowPollResult, type DeviceFlowState, DropboxProvider, type DurationEstimationConfig, type EndpointValue, type EndpointsConfig, type FeedActionInterface, type FeedFileInterface, type FeedSectionInterface, type FeedVenueInterface, FormatConverters, FormatResolver, type FormatResolverOptions, HighVoltageKidsProvider, type IProvider, type InstructionItem, type Instructions, JesusFilmProvider, LessonsChurchProvider, type MediaLicenseResult, type MediaLicenseStatus, type MessageFileInterface, OAuthHelper, type Plan, type PlanPresentation, type PlanSection, type PlanTimelineItem, PlanningCenterProvider, type ProviderCapabilities, type ProviderInfo, type ProviderLogos, type ResolvedFormatMeta, SignPresenterProvider, TokenHelper, VERSION, type VenueActionInterface, type VenueActionsResponseInterface, type VenueSectionActionsInterface, appendToPath, buildPath, countWords, createFile, createFolder, detectMediaType, estimateDuration, estimateImageDuration, estimateTextDuration, generatePath, getAllProviders, getAvailableProviders, getProvider, getProviderConfig, getSegment, isContentFile, isContentFolder, isMediaFile, navigateToPath, parsePath, registerProvider };