@techcake/broadcake-sdk 0.1.0

package/dist/index.d.cts

@@ -0,0 +1,350 @@
+interface Station {
+    id: string;
+    name: string;
+    slug: string;
+    timezone: string;
+    listen_url: string | null;
+}
+interface StationStream {
+    name: string;
+    url: string;
+    format: string | null;
+    bitrate: number | null;
+    is_default: boolean;
+}
+interface StationSocialLink {
+    platform: string;
+    url: string;
+}
+interface StationDetail extends Station {
+    broadcast_day_start: string;
+    streams: StationStream[];
+    social_links: StationSocialLink[];
+}
+interface Genre {
+    name: string;
+    slug: string;
+}
+interface SlotPresenter {
+    name: string;
+    role: string;
+    pronouns: string | null;
+}
+interface ScheduleSlot {
+    slot_start: string;
+    slot_end: string;
+    show_name: string | null;
+    show_slug: string | null;
+    show_description: string | null;
+    show_tagline: string | null;
+    is_repeat: boolean;
+    repeat_label: string | null;
+    source: string;
+    override_type: string | null;
+    auto_cancel_reason: string | null;
+    event_name: string | null;
+    event_slug: string | null;
+    genres: Genre[];
+    presenters: SlotPresenter[];
+    schedule_rule_id: string | null;
+    override_id: string | null;
+}
+interface WeekScheduleDay {
+    date: string;
+    slots: ScheduleSlot[];
+    error?: string;
+}
+interface WeekSchedule {
+    station: string;
+    timezone: string;
+    from: string;
+    to: string;
+    days: WeekScheduleDay[];
+}
+interface NowPlaying {
+    station: string;
+    now: ScheduleSlot | null;
+    next: ScheduleSlot | null;
+}
+interface ShowPresenter {
+    id: string;
+    slug: string;
+    display_name: string;
+    /** Included in show detail responses only. */
+    pronouns?: string | null;
+    /** Included in show detail responses only. */
+    bio?: string | null;
+    /** Included in show detail responses only. */
+    avatar_url?: string | null;
+    /** Included in show detail responses only. */
+    role?: string;
+}
+interface ShowGenre {
+    id: string;
+    name: string;
+    slug: string;
+}
+interface Show {
+    id: string;
+    name: string;
+    slug: string;
+    description: string | null;
+    is_active: boolean;
+    presenters: ShowPresenter[];
+    genres: ShowGenre[];
+}
+interface PresenterShow {
+    id: string;
+    name: string;
+    slug: string;
+    /** Included in presenter detail responses only. */
+    description?: string | null;
+    /** Included in presenter detail responses only. */
+    is_active?: boolean;
+}
+interface Presenter {
+    id: string;
+    display_name: string;
+    slug: string;
+    pronouns: string | null;
+    bio: string | null;
+    avatar_url: string | null;
+    is_active: boolean;
+    shows: PresenterShow[];
+}
+interface ArchiveLink {
+    id: string;
+    url: string;
+    label: string;
+    link_type: string;
+}
+interface ArchiveShow {
+    id: string;
+    name: string;
+    slug: string;
+}
+interface ArchiveEvent {
+    id: string;
+    name: string;
+    slug: string;
+}
+interface Archive {
+    id: string;
+    title: string;
+    aired_date: string;
+    description: string | null;
+    cover_url: string | null;
+    is_published: boolean;
+    archive_links: ArchiveLink[];
+}
+interface StationArchive extends Archive {
+    show: ArchiveShow | null;
+    event: ArchiveEvent | null;
+}
+interface ArchivePage {
+    data: Archive[];
+    next_cursor: string | null;
+}
+interface StationArchivePage {
+    data: StationArchive[];
+    next_cursor: string | null;
+    count: number;
+}
+interface EventShow {
+    id: string;
+    name: string;
+    slug: string;
+}
+interface EventSegmentPresenter {
+    id: string;
+    display_name: string;
+    slug: string;
+    role: string;
+}
+interface EventSegment {
+    id: string;
+    show_date: string;
+    start_time: string;
+    end_time: string;
+    display_order: number;
+    show: EventShow | null;
+    custom_name: string | null;
+    presenters: EventSegmentPresenter[];
+}
+interface Event {
+    id: string;
+    name: string;
+    slug: string;
+    description: string | null;
+    cover_url: string | null;
+    start_at: string;
+    end_at: string;
+    shows: EventShow[];
+}
+interface EventDetail {
+    id: string;
+    name: string;
+    slug: string;
+    description: string | null;
+    cover_url: string | null;
+    start_at: string;
+    end_at: string;
+    shows: EventSegment[];
+}
+interface ShowScheduleSlot {
+    day_of_week: number;
+    day_name: string;
+    start_time: string;
+    end_time: string;
+    is_repeat: boolean;
+    repeat_label: string | null;
+    recurrence_weeks: number;
+    effective_from: string;
+    effective_until: string | null;
+}
+interface ShowSchedule {
+    show: {
+        id: string;
+        name: string;
+        slug: string;
+    };
+    slots: ShowScheduleSlot[];
+}
+interface TodaySchedule {
+    station: string;
+    timezone: string;
+    date: string;
+    slots: ScheduleSlot[];
+}
+interface FormField {
+    id: string;
+    type: string;
+    label: string;
+    description?: string;
+    placeholder?: string;
+    required: boolean;
+    options?: string[];
+    default_value?: string;
+    min?: number;
+    max?: number;
+}
+interface FormConnectedData {
+    genres?: {
+        id: string;
+        name: string;
+        slug: string;
+    }[];
+    shows?: {
+        id: string;
+        name: string;
+        slug: string;
+    }[];
+    presenters?: {
+        id: string;
+        display_name: string;
+        slug: string;
+    }[];
+}
+type FormAvailability = 'open' | 'closed' | 'scheduled' | 'full' | 'unpublished';
+/** Form summary returned by the list endpoint (no fields). */
+interface Form {
+    id: string;
+    name: string;
+    slug: string;
+    description: string | null;
+    success_message: string | null;
+    success_redirect_url: string | null;
+    closed_message: string | null;
+    availability: FormAvailability;
+}
+/** Full form detail returned by the detail endpoint (includes fields + connected data). */
+interface FormDetail extends Form {
+    fields: FormField[];
+    connected: FormConnectedData;
+}
+interface FormSubmitResult {
+    success: boolean;
+    error?: string;
+    field_errors?: Record<string, string>;
+}
+interface BroadcakeOptions {
+    baseUrl?: string;
+}
+interface ScheduleRangeOptions {
+    from: string;
+    to?: string;
+}
+interface ArchiveListOptions {
+    show?: string;
+    cursor?: string;
+    offset?: number;
+    limit?: number;
+}
+interface ShowArchiveListOptions {
+    cursor?: string;
+    limit?: number;
+}
+interface SubscribeOptions {
+    interval?: number;
+}
+
+type NowPlayingCallback = (data: NowPlaying) => void;
+type Unsubscribe = () => void;
+
+type NowPlayingFn = {
+    (): Promise<NowPlaying>;
+    subscribe: (callback: NowPlayingCallback, options?: SubscribeOptions) => Unsubscribe;
+};
+declare class Broadcake {
+    private readonly stationSlug;
+    private readonly baseUrl;
+    /** Fetch current now-playing data, or subscribe for polling updates. */
+    readonly nowPlaying: NowPlayingFn;
+    constructor(stationSlug: string, options?: BroadcakeOptions);
+    private request;
+    private post;
+    private stationPath;
+    /** List all stations. */
+    stations(): Promise<Station[]>;
+    /** Get this station's details. */
+    station(): Promise<StationDetail>;
+    /** Get the schedule for a single day. */
+    schedule(date: string): Promise<ScheduleSlot[]>;
+    /** Get the schedule for a date range (defaults to 7 days if `to` is omitted). */
+    schedule(range: ScheduleRangeOptions): Promise<WeekSchedule>;
+    /** Get today's schedule (auto-resolves date in station timezone). */
+    scheduleToday(): Promise<TodaySchedule>;
+    /** List all shows. */
+    shows(): Promise<Show[]>;
+    /** Get a show by slug. */
+    show(showSlug: string): Promise<Show>;
+    /** Get a show's recurring schedule slots (when it airs). */
+    showSchedule(showSlug: string): Promise<ShowSchedule>;
+    /** List all presenters. */
+    presenters(): Promise<Presenter[]>;
+    /** Get a presenter by slug. */
+    presenter(presenterSlug: string): Promise<Presenter>;
+    /** List station-wide archives (paginated). */
+    archives(options?: ArchiveListOptions): Promise<StationArchivePage>;
+    /** List archives for a specific show (cursor-paginated). */
+    showArchives(showSlug: string, options?: ShowArchiveListOptions): Promise<ArchivePage>;
+    /** List upcoming events. */
+    events(): Promise<Event[]>;
+    /** Get an event by slug (includes segments and presenters). */
+    event(eventSlug: string): Promise<EventDetail>;
+    /** List all published forms. */
+    forms(): Promise<Form[]>;
+    /** Get a form by slug (includes connected data for genre/show/presenter fields). */
+    form(formSlug: string): Promise<FormDetail>;
+    /** Submit data to a form. */
+    submitForm(formSlug: string, data: Record<string, unknown>): Promise<FormSubmitResult>;
+}
+
+declare class BroadcakeError extends Error {
+    readonly status: number;
+    readonly endpoint: string;
+    readonly body: unknown;
+    constructor(status: number, message: string, endpoint: string, body?: unknown);
+}
+
+export { type Archive, type ArchiveEvent, type ArchiveLink, type ArchiveListOptions, type ArchivePage, type ArchiveShow, Broadcake, BroadcakeError, type BroadcakeOptions, type Event, type EventDetail, type EventSegment, type EventSegmentPresenter, type EventShow, type Form, type FormAvailability, type FormConnectedData, type FormDetail, type FormField, type FormSubmitResult, type Genre, type NowPlaying, type NowPlayingCallback, type Presenter, type PresenterShow, type ScheduleRangeOptions, type ScheduleSlot, type Show, type ShowArchiveListOptions, type ShowGenre, type ShowPresenter, type ShowSchedule, type ShowScheduleSlot, type SlotPresenter, type Station, type StationArchive, type StationArchivePage, type StationDetail, type StationSocialLink, type StationStream, type SubscribeOptions, type TodaySchedule, type Unsubscribe, type WeekSchedule, type WeekScheduleDay };

package/dist/index.d.ts

@@ -0,0 +1,350 @@
+interface Station {
+    id: string;
+    name: string;
+    slug: string;
+    timezone: string;
+    listen_url: string | null;
+}
+interface StationStream {
+    name: string;
+    url: string;
+    format: string | null;
+    bitrate: number | null;
+    is_default: boolean;
+}
+interface StationSocialLink {
+    platform: string;
+    url: string;
+}
+interface StationDetail extends Station {
+    broadcast_day_start: string;
+    streams: StationStream[];
+    social_links: StationSocialLink[];
+}
+interface Genre {
+    name: string;
+    slug: string;
+}
+interface SlotPresenter {
+    name: string;
+    role: string;
+    pronouns: string | null;
+}
+interface ScheduleSlot {
+    slot_start: string;
+    slot_end: string;
+    show_name: string | null;
+    show_slug: string | null;
+    show_description: string | null;
+    show_tagline: string | null;
+    is_repeat: boolean;
+    repeat_label: string | null;
+    source: string;
+    override_type: string | null;
+    auto_cancel_reason: string | null;
+    event_name: string | null;
+    event_slug: string | null;
+    genres: Genre[];
+    presenters: SlotPresenter[];
+    schedule_rule_id: string | null;
+    override_id: string | null;
+}
+interface WeekScheduleDay {
+    date: string;
+    slots: ScheduleSlot[];
+    error?: string;
+}
+interface WeekSchedule {
+    station: string;
+    timezone: string;
+    from: string;
+    to: string;
+    days: WeekScheduleDay[];
+}
+interface NowPlaying {
+    station: string;
+    now: ScheduleSlot | null;
+    next: ScheduleSlot | null;
+}
+interface ShowPresenter {
+    id: string;
+    slug: string;
+    display_name: string;
+    /** Included in show detail responses only. */
+    pronouns?: string | null;
+    /** Included in show detail responses only. */
+    bio?: string | null;
+    /** Included in show detail responses only. */
+    avatar_url?: string | null;
+    /** Included in show detail responses only. */
+    role?: string;
+}
+interface ShowGenre {
+    id: string;
+    name: string;
+    slug: string;
+}
+interface Show {
+    id: string;
+    name: string;
+    slug: string;
+    description: string | null;
+    is_active: boolean;
+    presenters: ShowPresenter[];
+    genres: ShowGenre[];
+}
+interface PresenterShow {
+    id: string;
+    name: string;
+    slug: string;
+    /** Included in presenter detail responses only. */
+    description?: string | null;
+    /** Included in presenter detail responses only. */
+    is_active?: boolean;
+}
+interface Presenter {
+    id: string;
+    display_name: string;
+    slug: string;
+    pronouns: string | null;
+    bio: string | null;
+    avatar_url: string | null;
+    is_active: boolean;
+    shows: PresenterShow[];
+}
+interface ArchiveLink {
+    id: string;
+    url: string;
+    label: string;
+    link_type: string;
+}
+interface ArchiveShow {
+    id: string;
+    name: string;
+    slug: string;
+}
+interface ArchiveEvent {
+    id: string;
+    name: string;
+    slug: string;
+}
+interface Archive {
+    id: string;
+    title: string;
+    aired_date: string;
+    description: string | null;
+    cover_url: string | null;
+    is_published: boolean;
+    archive_links: ArchiveLink[];
+}
+interface StationArchive extends Archive {
+    show: ArchiveShow | null;
+    event: ArchiveEvent | null;
+}
+interface ArchivePage {
+    data: Archive[];
+    next_cursor: string | null;
+}
+interface StationArchivePage {
+    data: StationArchive[];
+    next_cursor: string | null;
+    count: number;
+}
+interface EventShow {
+    id: string;
+    name: string;
+    slug: string;
+}
+interface EventSegmentPresenter {
+    id: string;
+    display_name: string;
+    slug: string;
+    role: string;
+}
+interface EventSegment {
+    id: string;
+    show_date: string;
+    start_time: string;
+    end_time: string;
+    display_order: number;
+    show: EventShow | null;
+    custom_name: string | null;
+    presenters: EventSegmentPresenter[];
+}
+interface Event {
+    id: string;
+    name: string;
+    slug: string;
+    description: string | null;
+    cover_url: string | null;
+    start_at: string;
+    end_at: string;
+    shows: EventShow[];
+}
+interface EventDetail {
+    id: string;
+    name: string;
+    slug: string;
+    description: string | null;
+    cover_url: string | null;
+    start_at: string;
+    end_at: string;
+    shows: EventSegment[];
+}
+interface ShowScheduleSlot {
+    day_of_week: number;
+    day_name: string;
+    start_time: string;
+    end_time: string;
+    is_repeat: boolean;
+    repeat_label: string | null;
+    recurrence_weeks: number;
+    effective_from: string;
+    effective_until: string | null;
+}
+interface ShowSchedule {
+    show: {
+        id: string;
+        name: string;
+        slug: string;
+    };
+    slots: ShowScheduleSlot[];
+}
+interface TodaySchedule {
+    station: string;
+    timezone: string;
+    date: string;
+    slots: ScheduleSlot[];
+}
+interface FormField {
+    id: string;
+    type: string;
+    label: string;
+    description?: string;
+    placeholder?: string;
+    required: boolean;
+    options?: string[];
+    default_value?: string;
+    min?: number;
+    max?: number;
+}
+interface FormConnectedData {
+    genres?: {
+        id: string;
+        name: string;
+        slug: string;
+    }[];
+    shows?: {
+        id: string;
+        name: string;
+        slug: string;
+    }[];
+    presenters?: {
+        id: string;
+        display_name: string;
+        slug: string;
+    }[];
+}
+type FormAvailability = 'open' | 'closed' | 'scheduled' | 'full' | 'unpublished';
+/** Form summary returned by the list endpoint (no fields). */
+interface Form {
+    id: string;
+    name: string;
+    slug: string;
+    description: string | null;
+    success_message: string | null;
+    success_redirect_url: string | null;
+    closed_message: string | null;
+    availability: FormAvailability;
+}
+/** Full form detail returned by the detail endpoint (includes fields + connected data). */
+interface FormDetail extends Form {
+    fields: FormField[];
+    connected: FormConnectedData;
+}
+interface FormSubmitResult {
+    success: boolean;
+    error?: string;
+    field_errors?: Record<string, string>;
+}
+interface BroadcakeOptions {
+    baseUrl?: string;
+}
+interface ScheduleRangeOptions {
+    from: string;
+    to?: string;
+}
+interface ArchiveListOptions {
+    show?: string;
+    cursor?: string;
+    offset?: number;
+    limit?: number;
+}
+interface ShowArchiveListOptions {
+    cursor?: string;
+    limit?: number;
+}
+interface SubscribeOptions {
+    interval?: number;
+}
+
+type NowPlayingCallback = (data: NowPlaying) => void;
+type Unsubscribe = () => void;
+
+type NowPlayingFn = {
+    (): Promise<NowPlaying>;
+    subscribe: (callback: NowPlayingCallback, options?: SubscribeOptions) => Unsubscribe;
+};
+declare class Broadcake {
+    private readonly stationSlug;
+    private readonly baseUrl;
+    /** Fetch current now-playing data, or subscribe for polling updates. */
+    readonly nowPlaying: NowPlayingFn;
+    constructor(stationSlug: string, options?: BroadcakeOptions);
+    private request;
+    private post;
+    private stationPath;
+    /** List all stations. */
+    stations(): Promise<Station[]>;
+    /** Get this station's details. */
+    station(): Promise<StationDetail>;
+    /** Get the schedule for a single day. */
+    schedule(date: string): Promise<ScheduleSlot[]>;
+    /** Get the schedule for a date range (defaults to 7 days if `to` is omitted). */
+    schedule(range: ScheduleRangeOptions): Promise<WeekSchedule>;
+    /** Get today's schedule (auto-resolves date in station timezone). */
+    scheduleToday(): Promise<TodaySchedule>;
+    /** List all shows. */
+    shows(): Promise<Show[]>;
+    /** Get a show by slug. */
+    show(showSlug: string): Promise<Show>;
+    /** Get a show's recurring schedule slots (when it airs). */
+    showSchedule(showSlug: string): Promise<ShowSchedule>;
+    /** List all presenters. */
+    presenters(): Promise<Presenter[]>;
+    /** Get a presenter by slug. */
+    presenter(presenterSlug: string): Promise<Presenter>;
+    /** List station-wide archives (paginated). */
+    archives(options?: ArchiveListOptions): Promise<StationArchivePage>;
+    /** List archives for a specific show (cursor-paginated). */
+    showArchives(showSlug: string, options?: ShowArchiveListOptions): Promise<ArchivePage>;
+    /** List upcoming events. */
+    events(): Promise<Event[]>;
+    /** Get an event by slug (includes segments and presenters). */
+    event(eventSlug: string): Promise<EventDetail>;
+    /** List all published forms. */
+    forms(): Promise<Form[]>;
+    /** Get a form by slug (includes connected data for genre/show/presenter fields). */
+    form(formSlug: string): Promise<FormDetail>;
+    /** Submit data to a form. */
+    submitForm(formSlug: string, data: Record<string, unknown>): Promise<FormSubmitResult>;
+}
+
+declare class BroadcakeError extends Error {
+    readonly status: number;
+    readonly endpoint: string;
+    readonly body: unknown;
+    constructor(status: number, message: string, endpoint: string, body?: unknown);
+}
+
+export { type Archive, type ArchiveEvent, type ArchiveLink, type ArchiveListOptions, type ArchivePage, type ArchiveShow, Broadcake, BroadcakeError, type BroadcakeOptions, type Event, type EventDetail, type EventSegment, type EventSegmentPresenter, type EventShow, type Form, type FormAvailability, type FormConnectedData, type FormDetail, type FormField, type FormSubmitResult, type Genre, type NowPlaying, type NowPlayingCallback, type Presenter, type PresenterShow, type ScheduleRangeOptions, type ScheduleSlot, type Show, type ShowArchiveListOptions, type ShowGenre, type ShowPresenter, type ShowSchedule, type ShowScheduleSlot, type SlotPresenter, type Station, type StationArchive, type StationArchivePage, type StationDetail, type StationSocialLink, type StationStream, type SubscribeOptions, type TodaySchedule, type Unsubscribe, type WeekSchedule, type WeekScheduleDay };