alitu-podparse/index.d.ts

Clone of the popular package podparse, with some bugfixes and improvements. Credits go to the original author Thomas Barrasso <tom@barrasso.me>

declare module 'alitu-podparse' {
    export interface Podcast {
        meta: Meta;
        episodes: Episode[];
        liveEpisodes?: LiveItem[];
    }

    export interface Meta {
        title: string;
        description: string;
        language: string;
        author: string;
        summary: string;
        type: string;

        generator?: string;

        category?: string[];
        keywords?: string[];

        owner: Owner;
        image: MetaImage;
        explicit: boolean;
        lastBuildDate: string;
        pubDate: string;
        link: string;
        links: Link[];

        managingEditor?: string;
        webMaster?: string;

        blocked?: boolean;
        complete?: boolean;

        countryOfOrigin?: string;

        limit?: number;
        showId?: string;
        showUrl?: string;
        episodeId?: string;
        episodeUrl?: string;

        person?: Person[];
        locked?: boolean;
        funding?: Funding[];
        location?: Location;
        license?: License;
        medium?: Medium;
        images?: Images;

        trailer?: Trailer[];
        value?: Value[];

        network?: Network;
        seriesDetails?: SeriesDetails;

        importFeedUrl?: string;
        updatedAt?: string;
        createdAt?: string;
        deleted?: boolean;
        exclusive?: string;
        copyright?: string;
        guid?: string;
        txt?: string;
    }

    export interface Episode {
        title: string;
        description: string;
        author: string;
        summary: string;
        episodeType: EpisodeType;
        guid: string;
        explicit?: boolean;

        duration: number;
        enclosure: Enclosure;

        season?: number;
        episode?: number;

        lastBuildDate: string;
        pubDate: string;
        link?: string;
        image?: EpisodeImage;
        subtitle?: string;

        point?: number[];
        lat?: number;
        long?: number;

        clipId?: string;

        person?: Person[];
        transcript?: Transcript[];
        chapters?: Chapter[];
        soundbite?: Soundbite[];
        location?: Location;
        license?: License;
        alternateEnclosure?: AlternateEnclosure[];
        gateway?: Gateway;
        images?: Images;

        socialInteract?: SocialInteract[];
        value?: Value[];

        updatedAt?: string;
        createdAt?: string;
        exclusive?: string;

        cta?: CTA[];
    }

    export type LiveItemStatus = 'pending' | 'live' | 'ended';

    export interface LiveItem extends Episode {
        status: LiveItemStatus;
        start: string; // ISO8601
        end: string; // ISO8601
        contentLink?: ContentLink[];
    }

    export interface ContentLink {
        href: string;
        text: string;
    }

    export interface Enclosure {
        url: string;
        type?: string;
        length?: number;
        duration?: number;
    }

    export interface Person {
        name: string;
        role: string;
        group: string;
        img?: string;
        href?: string;
    }

    export interface Funding {
        url: string;
        name: string;
    }

    export interface Transcript {
        url: string;
        type: string;
        language?: string;
        rel?: string;
    }

    export interface Chapter {
        url: string;
        type: string;
    }

    export interface Soundbite {
        name?: string;
        startTime: number;
        duration: number;
    }

    export interface Location {
        name: string;
        geo?: number[];
        osm?: string;
        rel?: string;
        country?: string;
    }

    export interface License {
        slug: string;
        url?: string;
    }

    export interface Network {
        name: string;
        slug?: string;
        id?: string;
    }

    export interface SeriesDetails {
        frequency?: string;
        daysLive?: number;
    }

    export interface CTA {
        headline?: string;
        subtitle?: string;
        actions?: CTAActions[];
    }

    export interface CTAActions {
        class?: string;
        disposition?: string;
        href?: string;
        label?: string;
    }

    export interface ValueRecipient {
        name?: string;
        type: string;
        address: string;
        customKey?: string;
        customValue?: string;
        split: number;
        fee?: boolean;
    }

    export interface Value {
        type: string;
        method: string;
        suggested?: number;
        valueRecipient: ValueRecipient[];
    }

    export interface SocialInteract {
        platform: string;
        protocol: string;
        accountId: string;
        url: string;
        pubDate?: string;
        priority?: string;
    }

    export enum Medium {
        Podcast = "podcast",
        Music = "music",
        Video = "video",
        Film = "film",
        Audiobook = "audiobook",
        Newsletter = "newsletter",
        Blog = "blog",
    }

    export interface Gateway {
        text: string;
        order?: number;
    }

    export interface Images {
        srcset: string;
    }

    export interface AlternateEnclosureSource {
        uri: string;
        contentType?: string;
    }

    export interface AlternateEnclosureIntegrity {
        type: string;
        value: string;
    }

    export interface AlternateEnclosure {
        type: string;
        length: number;
        bitrate?: number;
        height?: number;
        lang?: string;
        title?: string;
        rel?: string;
        codecs?: string;
        default: boolean;
        source?: AlternateEnclosureSource[];
        integrity?: AlternateEnclosureIntegrity[];
    }
  
    export interface Category {
        name?: string;
        domain?: string;
        scheme?: string;
        term?: string;
    }

    export interface Extension {
        name: string;
        objects: any;
    }

    export enum EpisodeType {
        Bonus = 'bonus',
        Full = 'full',
        Trailer = 'trailer',
    }

    export interface Trailer {
        url: string;
        title?: string;
        pubDate: string; // RFC2822
        length?: number;
        type?: string;
        season?: number;
    }

    export interface EpisodeImage {
        url: string;
    }

    export interface MetaImage {
        url: string;
        link: string;
        title: string;
    }

    export interface Link {
        rel: string;
        href: string;
        type: string;
    }

    export interface Owner {
        name: string;
        email: string;
    }

    export interface CallArgs {
        includeEpisodes?: boolean;
    }

    export default function getPodcastFromFeed(feed: string, options?: CallArgs): Podcast;
}