@opfelmusig/lib 0.0.0-ci.0.sha-3e76884

package/dist/types/resources/catalog/song.d.ts

@@ -0,0 +1,50 @@
+import type { Resource } from "../../../types/query/resource.js";
+import type { CatalogAlbum } from "../../../types/resources/catalog/album.js";
+import type { CatalogArtist } from "../../../types/resources/catalog/artist.js";
+import type { CatalogGenre } from "../../../types/resources/catalog/genre.js";
+import type { CatalogLyrics } from "../../../types/resources/catalog/lyrics.js";
+import type { CatalogMusicVideo } from "../../../types/resources/catalog/musicVideo.js";
+import type { CatalogRoleCategory } from "../../../types/resources/catalog/roleCategory.js";
+import type { CatalogStation } from "../../../types/resources/catalog/station.js";
+import type { CatalogSyllableLyrics } from "../../../types/resources/catalog/syllableLyrics.js";
+import type { LibrarySong } from "../../../types/resources/library/song.js";
+import type { BaseSongAttributes } from "../../../types/resources/shared/song.js";
+import type { AssetUrls, AudioVariants, EditorialNote, Offer, Preview, RatingValue } from "../../../types/shared.js";
+interface CatalogSongAttributes extends BaseSongAttributes {
+    attribution?: string;
+    composerName?: string;
+    editorialNotes?: EditorialNote;
+    isrc?: string;
+    movementCount?: number;
+    movementName?: string;
+    movementNumber?: number;
+    previews: Preview[];
+    url: string;
+    workName?: string;
+    audioLocale?: string;
+    audioTraits?: AudioVariants[];
+    isMasteredForItunes: boolean;
+    isVocalAttenuationAllowed: boolean;
+    isAppleDigitalMaster: boolean;
+    hasTimeSyncedLyrics: boolean;
+}
+interface CatalogSongExtend {
+    artistUrl?: string;
+    personalRating?: RatingValue;
+    inLibrary?: boolean;
+    extendedAssetUrls?: AssetUrls;
+    lyricsExcerpt?: string;
+    offers?: Offer[];
+}
+export type CatalogSong = Resource<"songs", CatalogSongAttributes, CatalogSongExtend, {
+    albums: CatalogAlbum;
+    artists: CatalogArtist;
+    credits: CatalogRoleCategory;
+    genres: CatalogGenre;
+    library: LibrarySong;
+    lyrics: CatalogLyrics;
+    "music-videos": CatalogMusicVideo;
+    station: CatalogStation;
+    "syllable-lyrics": CatalogSyllableLyrics;
+}>;
+export {};

package/dist/types/resources/catalog/station.d.ts

@@ -0,0 +1,21 @@
+import type { Resource } from "../../../types/query/resource.js";
+import type { CatalogAppleCurator } from "../../../types/resources/catalog/curator.js";
+import type { Artwork, EditorialNote, PlayParameters } from "../../../types/shared.js";
+interface CatalogStationAttributes {
+    artwork: Artwork;
+    editorialNotes?: EditorialNote;
+    mediaKind: "audio" | "video";
+    isLive: boolean;
+    kind: "songSeeded" | "artistSeeded" | "albumSeeded" | "playlistSeeded" | "user" | "artistOnly" | "query" | "streaming";
+    name: string;
+    playParams?: PlayParameters;
+    radioUrl?: string;
+    requiresSubscription: boolean;
+    url: string;
+}
+interface CatalogStationExtend {
+}
+export type CatalogStation = Resource<"stations", CatalogStationAttributes, CatalogStationExtend, {
+    "radio-show": CatalogAppleCurator;
+}>;
+export {};

package/dist/types/resources/catalog/stationGenre.d.ts

@@ -0,0 +1,11 @@
+import type { Resource } from "../../../types/query/resource.js";
+import type { CatalogStation } from "../../../types/resources/catalog/station.js";
+interface CatalogStationGenreAttributes {
+    name: string;
+}
+interface CatalogStationGenreExtend {
+}
+export type CatalogStationGenre = Resource<"station-genres", CatalogStationGenreAttributes, CatalogStationGenreExtend, {
+    stations: CatalogStation;
+}>;
+export {};

package/dist/types/resources/catalog/syllableLyrics.d.ts

@@ -0,0 +1,9 @@
+import type { Resource } from "../../../types/query/resource.js";
+import type { BaseLyricsAttributes } from "../../../types/resources/shared/lyrics.js";
+interface CatalogSyllableLyricsAttributes extends BaseLyricsAttributes {
+}
+interface CatalogSyllableLyricsExtend {
+    ttmlLocalizations?: string;
+}
+export type CatalogSyllableLyrics = Resource<"syllable-lyrics", CatalogSyllableLyricsAttributes, CatalogSyllableLyricsExtend>;
+export {};

package/dist/types/resources/catalog/venue.d.ts

@@ -0,0 +1,20 @@
+import type { Resource } from "../../../types/query/resource.js";
+interface VenueGeoLocation {
+    latitude: number;
+    longitude: number;
+}
+interface VenueStructuredAddress {
+    address: string;
+    city: string;
+    country: string;
+    countryIsoCode: string;
+    postCode: string;
+    region: string;
+}
+interface CatalogVenueAttributes {
+    geoLocation: VenueGeoLocation;
+    name: string;
+    structuredAddress: VenueStructuredAddress;
+}
+export type CatalogVenue = Resource<"venues", CatalogVenueAttributes>;
+export {};

package/dist/types/resources/library/album.d.ts

@@ -0,0 +1,17 @@
+import type { Resource } from "../../../types/query/resource.js";
+import type { CatalogAlbum } from "../../../types/resources/catalog/album.js";
+import type { LibraryArtist } from "../../../types/resources/library/artist.js";
+import type { LibraryMusicVideo } from "../../../types/resources/library/musicVideo.js";
+import type { LibrarySong } from "../../../types/resources/library/song.js";
+import type { BaseAlbumAttributes } from "../../../types/resources/shared/album.js";
+interface LibraryAlbumAttributes extends BaseAlbumAttributes {
+    dateAdded?: string;
+}
+interface LibraryAlbumExtend {
+}
+export type LibraryAlbum = Resource<"library-albums", LibraryAlbumAttributes, LibraryAlbumExtend, {
+    artists: LibraryArtist;
+    catalog: CatalogAlbum;
+    tracks: LibrarySong | LibraryMusicVideo;
+}>;
+export {};

package/dist/types/resources/library/artist.d.ts

@@ -0,0 +1,13 @@
+import type { Resource } from "../../../types/query/resource.js";
+import type { CatalogArtist } from "../../../types/resources/catalog/artist.js";
+import type { LibraryAlbum } from "../../../types/resources/library/album.js";
+import type { BaseArtistAttributes } from "../../../types/resources/shared/artist.js";
+interface LibraryArtistAttributes extends BaseArtistAttributes {
+}
+interface LibraryArtistExtend {
+}
+export type LibraryArtist = Resource<"library-artists", LibraryArtistAttributes, LibraryArtistExtend, {
+    albums: LibraryAlbum;
+    catalog: CatalogArtist;
+}>;
+export {};

package/dist/types/resources/library/musicVideo.d.ts

@@ -0,0 +1,15 @@
+import type { Resource } from "../../../types/query/resource.js";
+import type { CatalogMusicVideo } from "../../../types/resources/catalog/musicVideo.js";
+import type { LibraryAlbum } from "../../../types/resources/library/album.js";
+import type { LibraryArtist } from "../../../types/resources/library/artist.js";
+import type { BaseMusicVideoAttributes } from "../../../types/resources/shared/musicVideo.js";
+interface LibraryMusicVideoAttributes extends BaseMusicVideoAttributes {
+}
+interface LibraryMusicVideoExtend {
+}
+export type LibraryMusicVideo = Resource<"library-music-videos", LibraryMusicVideoAttributes, LibraryMusicVideoExtend, {
+    albums: LibraryAlbum;
+    artists: LibraryArtist;
+    catalog: CatalogMusicVideo;
+}>;
+export {};

package/dist/types/resources/library/playlist.d.ts

@@ -0,0 +1,24 @@
+import type { Resource } from "../../../types/query/resource.js";
+import type { CatalogPlaylist } from "../../../types/resources/catalog/playlist.js";
+import type { LibraryMusicVideo } from "../../../types/resources/library/musicVideo.js";
+import type { LibraryPlaylistFolder } from "../../../types/resources/library/playlistFolder.js";
+import type { LibrarySong } from "../../../types/resources/library/song.js";
+import type { BasePlaylistAttributes } from "../../../types/resources/shared/playlist.js";
+interface LibraryPlaylistAttributes extends BasePlaylistAttributes {
+    canEdit: boolean;
+    dateAdded?: string;
+    lastModifiedDate?: string;
+    hasCatalog: boolean;
+    isPublic: boolean;
+}
+interface LibraryPlaylistExtend {
+    trackTypes?: ("library-music-videos" | "library-songs")[];
+    tags?: ("favorited" | (string & {}))[];
+    trackCount?: number;
+}
+export type LibraryPlaylist = Resource<"library-playlists", LibraryPlaylistAttributes, LibraryPlaylistExtend, {
+    catalog: CatalogPlaylist;
+    tracks: LibrarySong | LibraryMusicVideo;
+    parent: LibraryPlaylistFolder;
+}>;
+export {};

package/dist/types/resources/library/playlistFolder.d.ts

@@ -0,0 +1,13 @@
+import type { Resource } from "../../../types/query/resource.js";
+import type { LibraryPlaylist } from "../../../types/resources/library/playlist.js";
+interface LibraryPlaylistFolderAttributes {
+    dateAdded?: string;
+    name?: string;
+}
+interface LibraryPlaylistFolderExtend {
+}
+export type LibraryPlaylistFolder = Resource<"library-playlist-folders", LibraryPlaylistFolderAttributes, LibraryPlaylistFolderExtend, {
+    children: LibraryPlaylist | LibraryPlaylistFolder;
+    parent: LibraryPlaylistFolder;
+}>;
+export {};

package/dist/types/resources/library/song.d.ts

@@ -0,0 +1,15 @@
+import type { Resource } from "../../../types/query/resource.js";
+import type { CatalogSong } from "../../../types/resources/catalog/song.js";
+import type { LibraryAlbum } from "../../../types/resources/library/album.js";
+import type { LibraryArtist } from "../../../types/resources/library/artist.js";
+import type { BaseSongAttributes } from "../../../types/resources/shared/song.js";
+interface LibrarySongAttributes extends BaseSongAttributes {
+}
+interface LibrarySongExtend {
+}
+export type LibrarySong = Resource<"library-songs", LibrarySongAttributes, LibrarySongExtend, {
+    albums: LibraryAlbum;
+    artists: LibraryArtist;
+    catalog: CatalogSong;
+}>;
+export {};

package/dist/types/resources/me/musicSummary.d.ts

@@ -0,0 +1,37 @@
+import type { Resource } from "../../../types/query/resource.js";
+import type { CatalogPlaylist } from "../../../types/resources/catalog/playlist.js";
+import type { AlbumPeriodSummary } from "../../../types/resources/me/summaries/albumPeriodSummary.js";
+import type { ArtistPeriodSummary } from "../../../types/resources/me/summaries/artistPeriodSummary.js";
+import type { GenrePeriodSummary } from "../../../types/resources/me/summaries/genrePeriodSummary.js";
+import type { MonthlySongPeriodSummary } from "../../../types/resources/me/summaries/monthlySongPeriodSummary.js";
+import type { PlaylistPeriodSummary } from "../../../types/resources/me/summaries/playlistPeriodSummary.js";
+import type { SongPeriodSummary } from "../../../types/resources/me/summaries/songPeriodSummary.js";
+import type { StationPeriodSummary } from "../../../types/resources/me/summaries/stationPeriodSummary.js";
+interface MusicSummaryAttributes {
+    name: string;
+    month?: number;
+    period: string;
+    year: number;
+    listenTimeInMinutes?: number;
+    topSongCount?: number;
+    uniqueAlbumCount?: number;
+    uniqueArtistCount?: number;
+    uniqueGenreCount?: number;
+    uniquePlaylistCount?: number;
+    uniqueSongCount?: number;
+    uniqueStationCount?: number;
+}
+interface MusicSummaryExtend {
+}
+export type MusicSummary = Resource<"music-summaries", MusicSummaryAttributes, MusicSummaryExtend, {
+    playlist: CatalogPlaylist;
+}, {
+    "top-albums": AlbumPeriodSummary;
+    "top-artists": ArtistPeriodSummary;
+    "top-genres": GenrePeriodSummary;
+    "top-playlists": PlaylistPeriodSummary;
+    "top-songs": SongPeriodSummary;
+    "top-songs-for-months": MonthlySongPeriodSummary;
+    "top-stations": StationPeriodSummary;
+}>;
+export {};

package/dist/types/resources/me/profile.d.ts

@@ -0,0 +1,32 @@
+import type { Resource } from "../../../types/query/resource.js";
+import type { CatalogPlaylist } from "../../../types/resources/catalog/playlist.js";
+import type { Artwork } from "../../../types/shared.js";
+interface SocialProfileAttributes {
+    artwork: Artwork;
+    handle: string;
+    isPrivate: boolean;
+    isVerified: boolean;
+    name: string;
+    url: string;
+}
+interface SocialProfileExtend {
+    followState: string;
+}
+export type SocialProfile = Resource<"social-profiles", SocialProfileAttributes, SocialProfileExtend, {
+    "shared-playlists": CatalogPlaylist;
+}>;
+interface PersonalSocialProfileAttributes extends SocialProfileAttributes {
+    acceptedTerms: string[];
+    collaborationAllowed: boolean;
+    isContactCheckAllowed: boolean;
+    isDiscoverableByContact: boolean;
+    isOnboarded: boolean;
+}
+interface PersonalSocialProfileExtend {
+    pendingFollowersCount: number;
+}
+export type PersonalSocialProfile = Resource<"personal-social-profiles", PersonalSocialProfileAttributes, PersonalSocialProfileExtend, {
+    "shared-playlists": CatalogPlaylist;
+    "social-profile": SocialProfile;
+}>;
+export {};

package/dist/types/resources/me/rating.d.ts

@@ -0,0 +1,11 @@
+import type { ResourceOf } from "../../../types/query/helpers.js";
+import type { Resource } from "../../../types/query/resource.js";
+import type { RatingValue } from "../../../types/shared.js";
+interface MeRatingsAttributes {
+    value?: RatingValue;
+}
+export type RatingResources = ResourceOf<"albums" | "music-videos" | "playlists" | "songs" | "stations" | "library-music-videos" | "library-playlists" | "library-songs">;
+export type Rating = Resource<"ratings", MeRatingsAttributes, {}, {
+    content: RatingResources;
+}>;
+export {};

package/dist/types/resources/me/recommendation.d.ts

@@ -0,0 +1,27 @@
+import type { Resource } from "../../../types/query/resource.js";
+import type { CatalogAlbum } from "../../../types/resources/catalog/album.js";
+import type { CatalogArtist } from "../../../types/resources/catalog/artist.js";
+import type { CatalogMusicVideo } from "../../../types/resources/catalog/musicVideo.js";
+import type { CatalogPlaylist } from "../../../types/resources/catalog/playlist.js";
+import type { CatalogSong } from "../../../types/resources/catalog/song.js";
+import type { LibraryAlbum } from "../../../types/resources/library/album.js";
+import type { LibraryArtist } from "../../../types/resources/library/artist.js";
+import type { LibraryMusicVideo } from "../../../types/resources/library/musicVideo.js";
+import type { LibraryPlaylist } from "../../../types/resources/library/playlist.js";
+import type { LibrarySong } from "../../../types/resources/library/song.js";
+interface DisplayString {
+    stringForDisplay: string;
+}
+interface RecommendationAttributes {
+    kind: "music-recommendations" | "recently-played" | "unknown";
+    nextUpdateDate: string;
+    reason?: DisplayString;
+    resourceTypes: string[];
+    title?: DisplayString;
+}
+interface RecommendationExtend {
+}
+export type Recommendation = Resource<"personal-recommendation", RecommendationAttributes, RecommendationExtend, {
+    contents: CatalogAlbum | CatalogArtist | CatalogMusicVideo | CatalogPlaylist | CatalogSong | LibraryAlbum | LibraryArtist | LibraryMusicVideo | LibraryPlaylist | LibrarySong;
+}>;
+export {};

package/dist/types/resources/me/summaries/albumPeriodSummary.d.ts

@@ -0,0 +1,15 @@
+import type { Resource } from "../../../../types/query/resource.js";
+import type { CatalogAlbum } from "../../../../types/resources/catalog/album.js";
+interface AlbumPeriodSummaryAttributes {
+    firstPlayed?: string;
+    lastPlayed?: string;
+    listenTimeInMinutes?: number;
+    playCount?: number;
+    year: string;
+}
+interface AlbumPeriodSummaryExtend {
+}
+export type AlbumPeriodSummary = Resource<"album-period-summaries", AlbumPeriodSummaryAttributes, AlbumPeriodSummaryExtend, {
+    album: CatalogAlbum;
+}>;
+export {};

package/dist/types/resources/me/summaries/artistPeriodSummary.d.ts

@@ -0,0 +1,15 @@
+import type { Resource } from "../../../../types/query/resource.js";
+import type { CatalogArtist } from "../../../../types/resources/catalog/artist.js";
+interface ArtistPeriodSummaryAttributes {
+    firstPlayed?: string;
+    lastPlayed?: string;
+    listenTimeInMinutes?: number;
+    playCount?: number;
+    year: string;
+}
+interface ArtistPeriodSummaryExtend {
+}
+export type ArtistPeriodSummary = Resource<"artist-period-summaries", ArtistPeriodSummaryAttributes, ArtistPeriodSummaryExtend, {
+    artist: CatalogArtist;
+}>;
+export {};

package/dist/types/resources/me/summaries/genrePeriodSummary.d.ts

@@ -0,0 +1,12 @@
+import type { Resource } from "../../../../types/query/resource.js";
+interface GenrePeriodSummaryAttributes {
+    firstPlayed?: string;
+    genreName?: string;
+    lastPlayed?: string;
+    listenTimeInMinutes?: number;
+    playCount?: number;
+}
+interface GenrePeriodSummaryExtend {
+}
+export type GenrePeriodSummary = Resource<"genre-period-summaries", GenrePeriodSummaryAttributes, GenrePeriodSummaryExtend>;
+export {};

package/dist/types/resources/me/summaries/monthlySongPeriodSummary.d.ts

@@ -0,0 +1,13 @@
+import type { Resource } from "../../../../types/query/resource.js";
+import type { CatalogSong } from "../../../../types/resources/catalog/song.js";
+interface MonthlySongPeriodSummaryAttributes {
+    firstPlayed?: string;
+    lastPlayed?: string;
+    playCount?: number;
+}
+interface MonthlySongPeriodSummaryExtend {
+}
+export type MonthlySongPeriodSummary = Resource<"monthly-song-period-summaries", MonthlySongPeriodSummaryAttributes, MonthlySongPeriodSummaryExtend, {
+    song: CatalogSong;
+}>;
+export {};

package/dist/types/resources/me/summaries/playlistPeriodSummary.d.ts

@@ -0,0 +1,14 @@
+import type { Resource } from "../../../../types/query/resource.js";
+import type { CatalogPlaylist } from "../../../../types/resources/catalog/playlist.js";
+interface PlaylistPeriodSummaryAttributes {
+    firstPlayed?: string;
+    lastPlayed?: string;
+    listenTimeInMinutes?: number;
+    playCount?: number;
+}
+interface PlaylistPeriodSummaryExtend {
+}
+export type PlaylistPeriodSummary = Resource<"playlist-period-summaries", PlaylistPeriodSummaryAttributes, PlaylistPeriodSummaryExtend, {
+    playlist: CatalogPlaylist;
+}>;
+export {};

package/dist/types/resources/me/summaries/songPeriodSummary.d.ts

@@ -0,0 +1,15 @@
+import type { Resource } from "../../../../types/query/resource.js";
+import type { CatalogSong } from "../../../../types/resources/catalog/song.js";
+interface SongPeriodSummaryAttributes {
+    firstPlayed?: string;
+    lastPlayed?: string;
+    listenTimeInMinutes?: number;
+    playCount?: number;
+    year: string;
+}
+interface SongPeriodSummaryExtend {
+}
+export type SongPeriodSummary = Resource<"song-period-summaries", SongPeriodSummaryAttributes, SongPeriodSummaryExtend, {
+    song: CatalogSong;
+}>;
+export {};

package/dist/types/resources/me/summaries/stationPeriodSummary.d.ts

@@ -0,0 +1,14 @@
+import type { Resource } from "../../../../types/query/resource.js";
+import type { CatalogStation } from "../../../../types/resources/catalog/station.js";
+interface StationPeriodSummaryAttributes {
+    firstPlayed?: string;
+    lastPlayed?: string;
+    listenTimeInMinutes?: number;
+    playCount?: number;
+}
+interface StationPeriodSummaryExtend {
+}
+export type StationPeriodSummary = Resource<"station-period-summaries", StationPeriodSummaryAttributes, StationPeriodSummaryExtend, {
+    station: CatalogStation;
+}>;
+export {};

package/dist/types/resources/other/storefront.d.ts

@@ -0,0 +1,8 @@
+import type { Resource } from "../../../types/query/resource.js";
+export type StorefrontAttributes = {
+    defaultLanguageTag: string;
+    explicitContentPolicy: "allowed" | "opt-in" | "prohibited";
+    name: string;
+    supportedLanguageTags: string[];
+};
+export type Storefront = Resource<"storefronts", StorefrontAttributes>;

package/dist/types/resources/shared/album.d.ts

@@ -0,0 +1,11 @@
+import type { Artwork, ContentRating, PlayParameters } from "../../../types/shared.js";
+export interface BaseAlbumAttributes {
+    artistName?: string;
+    artwork?: Artwork;
+    contentRating?: ContentRating;
+    genreNames: string[];
+    name: string;
+    playParams?: PlayParameters;
+    releaseDate?: string;
+    trackCount: number;
+}

package/dist/types/resources/shared/artist.d.ts

@@ -0,0 +1,3 @@
+export interface BaseArtistAttributes {
+    name: string;
+}

package/dist/types/resources/shared/lyrics.d.ts

@@ -0,0 +1,5 @@
+import type { PlayParameters } from "../../../types/shared.js";
+export interface BaseLyricsAttributes {
+    ttml?: string;
+    playParams?: PlayParameters;
+}

package/dist/types/resources/shared/musicVideo.d.ts

@@ -0,0 +1,13 @@
+import type { Artwork, ContentRating, PlayParameters } from "../../../types/shared.js";
+export interface BaseMusicVideoAttributes {
+    albumName?: string;
+    artistName: string;
+    artwork: Artwork;
+    contentRating?: ContentRating;
+    durationInMillis: number;
+    genreNames: string[];
+    name: string;
+    playParams?: PlayParameters;
+    releaseDate?: string;
+    trackNumber?: number;
+}

package/dist/types/resources/shared/playlist.d.ts

@@ -0,0 +1,7 @@
+import type { Artwork, Description, PlayParameters } from "../../../types/shared.js";
+export interface BasePlaylistAttributes {
+    artwork?: Artwork;
+    description?: Description;
+    name: string;
+    playParams?: PlayParameters;
+}

package/dist/types/resources/shared/song.d.ts

@@ -0,0 +1,15 @@
+import type { Artwork, ContentRating, PlayParameters } from "../../../types/shared.js";
+export interface BaseSongAttributes {
+    artistName: string;
+    albumName: string;
+    artwork?: Artwork;
+    contentRating?: ContentRating;
+    discNumber?: number;
+    durationInMillis: number;
+    genreNames: string[];
+    hasLyrics: boolean;
+    name: string;
+    playParams?: PlayParameters;
+    releaseDate?: string;
+    trackNumber?: number;
+}

package/dist/types/results/chart.d.ts

@@ -0,0 +1,8 @@
+import type { ResourceOf } from "../../types/query/helpers.js";
+import type { Result } from "../../types/query/results.js";
+export type ChartResult = Result<{
+    albums: ResourceOf<"albums">;
+    "music-videos": ResourceOf<"music-videos">;
+    playlists: ResourceOf<"playlists">;
+    songs: ResourceOf<"songs">;
+}>;