@churchapps/content-providers 0.10.0 → 0.12.0

package/dist/index.d.cts

@@ -38,7 +38,14 @@ interface DeviceFlowState {
     error?: string;
     pollCount?: number;
 }
-type AuthType = "none" | "oauth_pkce" | "device_flow" | "form_login";
+type AuthType = "none" | "oauth_pkce" | "device_flow" | "form_login" | "network_discovery";
+interface NetworkInstance {
+    id: string;
+    name: string;
+    host: string;
+    ip: string;
+    port: number;
+}
 interface ProviderLogos {
     light: string;
     dark: string;
@@ -248,6 +255,7 @@ interface IProvider {
     initiateDeviceFlow?(): Promise<DeviceAuthorizationResponse | null>;
     pollDeviceFlowToken?(deviceCode: string): Promise<DeviceFlowPollResult>;
     performLogin?(email: string, password: string): Promise<ContentProviderAuthData | null>;
+    discoverInstances?(): Promise<NetworkInstance[]>;
     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>;
@@ -563,6 +571,45 @@ declare class CbnProvider extends BaseProvider {
     pollDeviceFlowToken(deviceCode: string): Promise<DeviceFlowPollResult>;
 }
 
+type FreeShowDiscoverer = () => Promise<NetworkInstance[]>;
+
+declare class FreeShowProvider extends BaseProvider {
+    readonly id = "freeshow";
+    readonly name = "FreeShow";
+    readonly logos: ProviderLogos;
+    readonly config: ContentProviderConfig;
+    readonly requiresAuth = true;
+    readonly authTypes: AuthType[];
+    readonly capabilities: ProviderCapabilities;
+    private discoverer;
+    /** mDNS needs native code, so the host app browses `_freeshow._udp` and maps results with freeShowServicesToInstances. */
+    setDiscoverer(discoverer: FreeShowDiscoverer | null): void;
+    discoverInstances(): Promise<NetworkInstance[]>;
+    toAuth(instance: NetworkInstance): ContentProviderAuthData;
+    selectedInstance(auth?: ContentProviderAuthData | null): NetworkInstance | null;
+    private requireInstance;
+    browse(path?: string | null, auth?: ContentProviderAuthData | null): Promise<ContentItem[]>;
+    private showFiles;
+    private load;
+    getPlaylist(path: string, auth?: ContentProviderAuthData | null, _resolution?: number): Promise<ContentFile[] | null>;
+    getInstructions(path: string, auth?: ContentProviderAuthData | null): Promise<Instructions | null>;
+}
+
+declare const FREESHOW_REST_PORT = 5506;
+interface MdnsService {
+    name: string;
+    host?: string | null;
+    txt?: Record<string, string>;
+}
+/**
+ * FreeShow advertises its Remote/Stage/etc. servers (not its API) as `_freeshow._udp`, named `freeshow-<SERVER>-<instanceId>`,
+ * with TXT `ip` and `ips` (comma-joined). Group by machine and pick the address that answers the REST API.
+ */
+declare function servicesToInstances(services: MdnsService[], port?: number): Promise<NetworkInstance[]>;
+
+declare function networkInstanceToAuth(instance: NetworkInstance): ContentProviderAuthData;
+declare function authToNetworkInstance(auth?: ContentProviderAuthData | null): NetworkInstance | null;
+
 /** 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";
@@ -606,4 +653,4 @@ declare function getAvailableProviders(ids?: string[]): ProviderInfo[];
  */
 declare const VERSION: string;
 
-export { APlayProvider, type AuthType, B1ChurchProvider, BaseProvider, BibleProjectProvider, CbnProvider, type ContentDownload, type ContentFile, type ContentFolder, type ContentItem, type ContentProviderAuthData, type ContentProviderConfig, type CurrentPlan, type DeviceAuthorizationResponse, DeviceFlowHelper, type DeviceFlowPollResult, type DeviceFlowState, DropboxProvider, type EndpointValue, type EndpointsConfig, type FeedActionInterface, type FeedDownloadInterface, type FeedFileInterface, type FeedSectionInterface, type FeedVenueInterface, HighVoltageKidsProvider, type IProvider, type InstructionItem, type Instructions, JesusFilmProvider, LessonsChurchProvider, LifeChurchProvider, type MediaLicenseResult, type MediaLicenseStatus, type MessageFileInterface, OAuthHelper, type Plan, type PlanPresentation, type PlanSection, type PlanTimelineItem, PlanningCenterProvider, type ProviderCapabilities, type ProviderInfo, type ProviderLogos, SignPresenterProvider, TokenHelper, VERSION, type VenueActionInterface, type VenueActionsResponseInterface, type VenueSectionActionsInterface, authIsExpired, getAllProviders, getAvailableProviders, getProvider, getProviderConfig, isContentFile, isContentFolder, navigateToPath, registerProvider, setProviderSecret, toAuthData };
+export { APlayProvider, type AuthType, B1ChurchProvider, BaseProvider, BibleProjectProvider, CbnProvider, type ContentDownload, type ContentFile, type ContentFolder, type ContentItem, type ContentProviderAuthData, type ContentProviderConfig, type CurrentPlan, type DeviceAuthorizationResponse, DeviceFlowHelper, type DeviceFlowPollResult, type DeviceFlowState, DropboxProvider, type EndpointValue, type EndpointsConfig, FREESHOW_REST_PORT, type FeedActionInterface, type FeedDownloadInterface, type FeedFileInterface, type FeedSectionInterface, type FeedVenueInterface, type FreeShowDiscoverer, FreeShowProvider, HighVoltageKidsProvider, type IProvider, type InstructionItem, type Instructions, JesusFilmProvider, LessonsChurchProvider, LifeChurchProvider, type MdnsService, type MediaLicenseResult, type MediaLicenseStatus, type MessageFileInterface, type NetworkInstance, OAuthHelper, type Plan, type PlanPresentation, type PlanSection, type PlanTimelineItem, PlanningCenterProvider, type ProviderCapabilities, type ProviderInfo, type ProviderLogos, SignPresenterProvider, TokenHelper, VERSION, type VenueActionInterface, type VenueActionsResponseInterface, type VenueSectionActionsInterface, authIsExpired, authToNetworkInstance, servicesToInstances as freeShowServicesToInstances, getAllProviders, getAvailableProviders, getProvider, getProviderConfig, isContentFile, isContentFolder, navigateToPath, networkInstanceToAuth, registerProvider, setProviderSecret, toAuthData };

package/dist/index.d.ts

@@ -38,7 +38,14 @@ interface DeviceFlowState {
     error?: string;
     pollCount?: number;
 }
-type AuthType = "none" | "oauth_pkce" | "device_flow" | "form_login";
+type AuthType = "none" | "oauth_pkce" | "device_flow" | "form_login" | "network_discovery";
+interface NetworkInstance {
+    id: string;
+    name: string;
+    host: string;
+    ip: string;
+    port: number;
+}
 interface ProviderLogos {
     light: string;
     dark: string;
@@ -248,6 +255,7 @@ interface IProvider {
     initiateDeviceFlow?(): Promise<DeviceAuthorizationResponse | null>;
     pollDeviceFlowToken?(deviceCode: string): Promise<DeviceFlowPollResult>;
     performLogin?(email: string, password: string): Promise<ContentProviderAuthData | null>;
+    discoverInstances?(): Promise<NetworkInstance[]>;
     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>;
@@ -563,6 +571,45 @@ declare class CbnProvider extends BaseProvider {
     pollDeviceFlowToken(deviceCode: string): Promise<DeviceFlowPollResult>;
 }
 
+type FreeShowDiscoverer = () => Promise<NetworkInstance[]>;
+
+declare class FreeShowProvider extends BaseProvider {
+    readonly id = "freeshow";
+    readonly name = "FreeShow";
+    readonly logos: ProviderLogos;
+    readonly config: ContentProviderConfig;
+    readonly requiresAuth = true;
+    readonly authTypes: AuthType[];
+    readonly capabilities: ProviderCapabilities;
+    private discoverer;
+    /** mDNS needs native code, so the host app browses `_freeshow._udp` and maps results with freeShowServicesToInstances. */
+    setDiscoverer(discoverer: FreeShowDiscoverer | null): void;
+    discoverInstances(): Promise<NetworkInstance[]>;
+    toAuth(instance: NetworkInstance): ContentProviderAuthData;
+    selectedInstance(auth?: ContentProviderAuthData | null): NetworkInstance | null;
+    private requireInstance;
+    browse(path?: string | null, auth?: ContentProviderAuthData | null): Promise<ContentItem[]>;
+    private showFiles;
+    private load;
+    getPlaylist(path: string, auth?: ContentProviderAuthData | null, _resolution?: number): Promise<ContentFile[] | null>;
+    getInstructions(path: string, auth?: ContentProviderAuthData | null): Promise<Instructions | null>;
+}
+
+declare const FREESHOW_REST_PORT = 5506;
+interface MdnsService {
+    name: string;
+    host?: string | null;
+    txt?: Record<string, string>;
+}
+/**
+ * FreeShow advertises its Remote/Stage/etc. servers (not its API) as `_freeshow._udp`, named `freeshow-<SERVER>-<instanceId>`,
+ * with TXT `ip` and `ips` (comma-joined). Group by machine and pick the address that answers the REST API.
+ */
+declare function servicesToInstances(services: MdnsService[], port?: number): Promise<NetworkInstance[]>;
+
+declare function networkInstanceToAuth(instance: NetworkInstance): ContentProviderAuthData;
+declare function authToNetworkInstance(auth?: ContentProviderAuthData | null): NetworkInstance | null;
+
 /** 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";
@@ -606,4 +653,4 @@ declare function getAvailableProviders(ids?: string[]): ProviderInfo[];
  */
 declare const VERSION: string;
 
-export { APlayProvider, type AuthType, B1ChurchProvider, BaseProvider, BibleProjectProvider, CbnProvider, type ContentDownload, type ContentFile, type ContentFolder, type ContentItem, type ContentProviderAuthData, type ContentProviderConfig, type CurrentPlan, type DeviceAuthorizationResponse, DeviceFlowHelper, type DeviceFlowPollResult, type DeviceFlowState, DropboxProvider, type EndpointValue, type EndpointsConfig, type FeedActionInterface, type FeedDownloadInterface, type FeedFileInterface, type FeedSectionInterface, type FeedVenueInterface, HighVoltageKidsProvider, type IProvider, type InstructionItem, type Instructions, JesusFilmProvider, LessonsChurchProvider, LifeChurchProvider, type MediaLicenseResult, type MediaLicenseStatus, type MessageFileInterface, OAuthHelper, type Plan, type PlanPresentation, type PlanSection, type PlanTimelineItem, PlanningCenterProvider, type ProviderCapabilities, type ProviderInfo, type ProviderLogos, SignPresenterProvider, TokenHelper, VERSION, type VenueActionInterface, type VenueActionsResponseInterface, type VenueSectionActionsInterface, authIsExpired, getAllProviders, getAvailableProviders, getProvider, getProviderConfig, isContentFile, isContentFolder, navigateToPath, registerProvider, setProviderSecret, toAuthData };
+export { APlayProvider, type AuthType, B1ChurchProvider, BaseProvider, BibleProjectProvider, CbnProvider, type ContentDownload, type ContentFile, type ContentFolder, type ContentItem, type ContentProviderAuthData, type ContentProviderConfig, type CurrentPlan, type DeviceAuthorizationResponse, DeviceFlowHelper, type DeviceFlowPollResult, type DeviceFlowState, DropboxProvider, type EndpointValue, type EndpointsConfig, FREESHOW_REST_PORT, type FeedActionInterface, type FeedDownloadInterface, type FeedFileInterface, type FeedSectionInterface, type FeedVenueInterface, type FreeShowDiscoverer, FreeShowProvider, HighVoltageKidsProvider, type IProvider, type InstructionItem, type Instructions, JesusFilmProvider, LessonsChurchProvider, LifeChurchProvider, type MdnsService, type MediaLicenseResult, type MediaLicenseStatus, type MessageFileInterface, type NetworkInstance, OAuthHelper, type Plan, type PlanPresentation, type PlanSection, type PlanTimelineItem, PlanningCenterProvider, type ProviderCapabilities, type ProviderInfo, type ProviderLogos, SignPresenterProvider, TokenHelper, VERSION, type VenueActionInterface, type VenueActionsResponseInterface, type VenueSectionActionsInterface, authIsExpired, authToNetworkInstance, servicesToInstances as freeShowServicesToInstances, getAllProviders, getAvailableProviders, getProvider, getProviderConfig, isContentFile, isContentFolder, navigateToPath, networkInstanceToAuth, registerProvider, setProviderSecret, toAuthData };