q-fi-core 2.3.1

package/dist/types/index.js

@@ -0,0 +1,26 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./album"), exports);
+__exportStar(require("./artist"), exports);
+__exportStar(require("./show"), exports);
+__exportStar(require("./playlist"), exports);
+__exportStar(require("./playlist-channel"), exports);
+__exportStar(require("./channel"), exports);
+__exportStar(require("./profile"), exports);
+__exportStar(require("./search"), exports);
+__exportStar(require("./tracks"), exports);
+__exportStar(require("./user"), exports);

package/dist/types/playlist-channel.d.ts

@@ -0,0 +1,81 @@
+type itemType = 'album' | 'playlist' | 'radio' | 'show' | 'livestream';
+export interface playlistChannelItemsType {
+    item_id: string;
+    id: string;
+    type: itemType;
+    data: {
+        NB_FAN: number;
+        NB_SONG: number;
+        PARENT_USER_ID: string;
+        PICTURE_TYPE: string;
+        PLAYLIST_ID: string;
+        PLAYLIST_PICTURE: string;
+        STATUS: number;
+        TITLE: string;
+        TYPE: string;
+        DATE_MOD: string;
+        DATE_ADD: string;
+        DESCRIPTION: string;
+        __TYPE__: itemType;
+    } | {
+        __TYPE__: itemType;
+        background_color: string;
+        description: string | null;
+        id: string;
+        logo: string | null;
+        name: string;
+        pictures: [
+            {
+                md5: string;
+                type: string;
+            }
+        ];
+        slug: string;
+        title: string;
+        type: itemType;
+    } | null;
+    target: string;
+    title: string;
+    subtitle: string;
+    description: string;
+    pictures: [
+        {
+            md5: string;
+            type: string;
+        }
+    ];
+    weight: number;
+    layout_parameters: {
+        cta: {
+            type: 'browse';
+            label: 'BROWSE';
+        };
+    };
+}
+export interface playlistChannelSectionsType {
+    layout: string;
+    section_id: string;
+    items: playlistChannelItemsType[];
+    title: string;
+    target: string;
+    related: {
+        target: string;
+        label: string;
+        mandatory: boolean;
+    };
+    alignment: string;
+    group_id: string;
+    hasMoreItems: boolean;
+}
+export interface playlistChannelType {
+    version: string;
+    page_id: string;
+    ga: {
+        screen_name: string;
+    };
+    title: string;
+    persistent: boolean;
+    sections: playlistChannelSectionsType[];
+    expire: number;
+}
+export {};

package/dist/types/playlist-channel.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/playlist.d.ts

@@ -0,0 +1,49 @@
+import type { trackType } from './tracks';
+export interface playlistInfoMinimal {
+    PLAYLIST_ID: string;
+    PARENT_PLAYLIST_ID: string;
+    TYPE: string;
+    TITLE: string;
+    PARENT_USER_ID: string;
+    PARENT_USERNAME: string;
+    PARENT_USER_PICTURE?: string;
+    STATUS: string;
+    PLAYLIST_PICTURE: string;
+    PICTURE_TYPE: string;
+    NB_SONG: number;
+    HAS_ARTIST_LINKED: boolean;
+    DATE_ADD: string;
+    DATE_MOD: string;
+    __TYPE__: 'playlist';
+}
+export interface playlistInfo {
+    PLAYLIST_ID: string;
+    DESCRIPTION?: string;
+    PARENT_USERNAME: string;
+    PARENT_USER_PICTURE?: string;
+    PARENT_USER_ID: string;
+    PICTURE_TYPE: string;
+    PLAYLIST_PICTURE: string;
+    TITLE: string;
+    TYPE: string;
+    STATUS: string;
+    USER_ID: string;
+    DATE_ADD: string;
+    DATE_MOD: string;
+    DATE_CREATE: string;
+    NB_SONG: number;
+    NB_FAN: number;
+    CHECKSUM: string;
+    HAS_ARTIST_LINKED: boolean;
+    IS_SPONSORED: boolean;
+    IS_EDITO: boolean;
+    __TYPE__: 'playlist';
+}
+export interface playlistTracksType {
+    data: trackType[];
+    count: number;
+    total: number;
+    filtered_count: number;
+    filtered_items?: number[];
+    next?: number;
+}

package/dist/types/playlist.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/profile.d.ts

@@ -0,0 +1,29 @@
+import type { albumTracksType } from './album';
+export interface profileTypeMinimal {
+    USER_ID: string;
+    FIRSTNAME: string;
+    LASTNAME: string;
+    BLOG_NAME: string;
+    USER_PICTURE?: string;
+    IS_FOLLOW: boolean;
+    __TYPE__: 'user';
+}
+export interface profileType {
+    IS_FOLLOW: boolean;
+    NB_ARTISTS: number;
+    NB_FOLLOWERS: number;
+    NB_FOLLOWINGS: number;
+    NB_MP3S: number;
+    TOP_TRACK: albumTracksType;
+    USER: {
+        USER_ID: string;
+        BLOG_NAME: string;
+        SEX?: string;
+        COUNTRY: string;
+        USER_PICTURE?: string;
+        COUNTRY_NAME: string;
+        PRIVATE: boolean;
+        DISPLAY_NAME: string;
+        __TYPE__: 'user';
+    };
+}

package/dist/types/profile.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/radio.d.ts

@@ -0,0 +1,7 @@
+export interface radioType {
+    RADIO_ID: string;
+    RADIO_PICTURE: string;
+    TITLE: string;
+    TAGS: string[];
+    __TYPE__: 'radio';
+}

package/dist/types/radio.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/search.d.ts

@@ -0,0 +1,79 @@
+import type { albumType, albumTypeMinimal } from './album';
+import type { artistInfoTypeMinimal, artistType } from './artist';
+import type { playlistInfo, playlistInfoMinimal } from './playlist';
+import type { trackType } from './tracks';
+import type { profileTypeMinimal } from './profile';
+import type { channelSearchType } from './channel';
+import type { radioType } from './radio';
+import type { showEpisodeType } from './show';
+interface searchTypeCommon {
+    count: number;
+    total: number;
+    filtered_count: number;
+    filtered_items: number[];
+    next: number;
+}
+interface albumSearchType extends searchTypeCommon {
+    data: albumTypeMinimal[];
+}
+interface artistSearchType extends searchTypeCommon {
+    data: artistInfoTypeMinimal[];
+}
+interface playlistSearchType extends searchTypeCommon {
+    data: playlistInfoMinimal[];
+}
+interface trackSearchType extends searchTypeCommon {
+    data: trackType[];
+}
+interface profileSearchType extends searchTypeCommon {
+    data: profileTypeMinimal[];
+}
+interface radioSearchType extends searchTypeCommon {
+    data: radioType[];
+}
+interface liveSearchType extends searchTypeCommon {
+    data: unknown[];
+}
+interface showSearchType extends searchTypeCommon {
+    data: showEpisodeType[];
+}
+export interface discographyType {
+    data: albumType[];
+    count: number;
+    total: number;
+    cache_version: number;
+    filtered_count: number;
+    art_id: number;
+    start: number;
+    nb: number;
+}
+export interface searchType {
+    QUERY: string;
+    FUZZINNESS: boolean;
+    AUTOCORRECT: boolean;
+    TOP_RESULT: [albumType | artistType | trackType | playlistInfo | artistType | unknown] | [];
+    ORDER: [
+        'TOP_RESULT',
+        'TRACK',
+        'PLAYLIST',
+        'ALBUM',
+        'ARTIST',
+        'LIVESTREAM',
+        'EPISODE',
+        'SHOW',
+        'CHANNEL',
+        'RADIO',
+        'USER',
+        'LYRICS'
+    ];
+    ALBUM: albumSearchType;
+    ARTIST: artistSearchType;
+    TRACK: trackSearchType;
+    PLAYLIST: playlistSearchType;
+    RADIO: radioSearchType;
+    SHOW: showSearchType;
+    USER: profileSearchType;
+    LIVESTREAM: liveSearchType;
+    CHANNEL: channelSearchType;
+}
+export {};

package/dist/types/search.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/show.d.ts

@@ -0,0 +1,61 @@
+interface generesType {
+    GENRE_ID: number;
+    GENRE_NAME: string;
+}
+export interface showEpisodeType {
+    EPISODE_ID: string;
+    EPISODE_STATUS: string;
+    AVAILABLE: boolean;
+    SHOW_ID: string;
+    SHOW_NAME: string;
+    SHOW_ART_MD5: string;
+    SHOW_DESCRIPTION: string;
+    SHOW_IS_EXPLICIT: string;
+    EPISODE_TITLE: string;
+    EPISODE_DESCRIPTION: string;
+    MD5_ORIGIN: string;
+    FILESIZE_MP3_32: string;
+    FILESIZE_MP3_64: string;
+    EPISODE_DIRECT_STREAM_URL: string;
+    SHOW_IS_DIRECT_STREAM: string;
+    DURATION: string;
+    EPISODE_PUBLISHED_TIMESTAMP: string;
+    EPISODE_UPDATE_TIMESTAMP: string;
+    SHOW_IS_ADVERTISING_ALLOWED: string;
+    SHOW_IS_DOWNLOAD_ALLOWED: string;
+    TRACK_TOKEN: string;
+    TRACK_TOKEN_EXPIRE: string;
+    __TYPE__: 'episode';
+}
+export interface showType {
+    DATA: {
+        AVAILABLE: boolean;
+        SHOW_IS_EXPLICIT: string;
+        LABEL_ID: string;
+        LABEL_NAME: string;
+        LANGUAGE_CD: string;
+        SHOW_IS_DIRECT_STREAM: string;
+        SHOW_IS_ADVERTISING_ALLOWED: string;
+        SHOW_IS_DOWNLOAD_ALLOWED: string;
+        SHOW_EPISODE_DISPLAY_COUNT: string;
+        SHOW_ID: string;
+        SHOW_ART_MD5: string;
+        SHOW_NAME: string;
+        SHOW_DESCRIPTION: string;
+        SHOW_STATUS: string;
+        SHOW_TYPE: string;
+        GENRES: generesType[];
+        NB_FAN: number;
+        NB_RATE: number;
+        RATING: string;
+        __TYPE__: 'show';
+    };
+    FAVORITE_STATUS: boolean;
+    EPISODES: {
+        data: showEpisodeType[];
+        count: number;
+        total: number;
+        filtered_count: number;
+    };
+}
+export {};

package/dist/types/show.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/tracks.d.ts

@@ -0,0 +1,144 @@
+import type { artistType } from './artist';
+interface mediaType {
+    TYPE: 'preview';
+    HREF: string;
+}
+interface lyricsSync {
+    lrc_timestamp: string;
+    milliseconds: string;
+    duration: string;
+    line: string;
+}
+export interface lyricsType {
+    LYRICS_ID?: string;
+    LYRICS_SYNC_JSON?: lyricsSync[];
+    LYRICS_TEXT: string;
+    LYRICS_COPYRIGHTS?: string;
+    LYRICS_WRITERS?: string;
+}
+interface songType {
+    ALB_ID: string;
+    ALB_TITLE: string;
+    ALB_PICTURE: string;
+    ARTISTS: artistType[];
+    ART_ID: string;
+    ART_NAME: string;
+    ARTIST_IS_DUMMY: boolean;
+    ART_PICTURE: string;
+    DATE_START: string;
+    DISK_NUMBER?: string;
+    DURATION: string;
+    EXPLICIT_TRACK_CONTENT: {
+        EXPLICIT_LYRICS_STATUS: number;
+        EXPLICIT_COVER_STATUS: number;
+    };
+    ISRC: string;
+    LYRICS_ID: number;
+    LYRICS?: lyricsType;
+    EXPLICIT_LYRICS?: string;
+    RANK: string;
+    SMARTRADIO: string;
+    SNG_ID: string;
+    SNG_TITLE: string;
+    SNG_CONTRIBUTORS?: {
+        main_artist: string[];
+        author?: string[];
+        composer?: string[];
+        musicpublisher?: string[];
+        producer?: string[];
+        publisher: string[];
+        engineer?: string[];
+        writer?: string[];
+        mixer?: string[];
+    } | [];
+    STATUS: number;
+    S_MOD: number;
+    S_PREMIUM: number;
+    TRACK_NUMBER: number;
+    URL_REWRITING: string;
+    VERSION?: string;
+    MD5_ORIGIN?: string;
+    FILESIZE_AAC_64: '0';
+    FILESIZE_MP3_64: string;
+    FILESIZE_MP3_128: string;
+    FILESIZE_MP3_256: '0';
+    FILESIZE_MP3_320: '0';
+    FILESIZE_MP4_RA1: '0';
+    FILESIZE_MP4_RA2: '0';
+    FILESIZE_MP4_RA3: '0';
+    FILESIZE_FLAC: '0';
+    FILESIZE: string;
+    GAIN: string;
+    MEDIA_VERSION: string;
+    TRACK_TOKEN: string;
+    TRACK_TOKEN_EXPIRE: number;
+    MEDIA: [mediaType];
+    RIGHTS: {
+        STREAM_ADS_AVAILABLE?: boolean;
+        STREAM_ADS?: string;
+        STREAM_SUB_AVAILABLE?: boolean;
+        STREAM_SUB?: string;
+    };
+    PROVIDER_ID: string;
+    __TYPE__: 'song';
+}
+export interface trackType extends songType {
+    FALLBACK?: songType;
+    TRACK_POSITION?: number;
+}
+export interface contributorsPublicApi {
+    id: number;
+    name: string;
+    link: string;
+    share: string;
+    picture: string;
+    picture_small: string;
+    picture_medium: string;
+    picture_big: string;
+    picture_xl: string;
+    radio: boolean;
+    tracklist: string;
+    type: string;
+    role: string;
+}
+export interface trackTypePublicApi {
+    id: number;
+    readable: boolean;
+    title: string;
+    title_short: string;
+    title_version?: string;
+    isrc: string;
+    link: string;
+    share: string;
+    duration: number;
+    track_position: number;
+    disk_number: number;
+    rank: number;
+    release_date: string;
+    explicit_lyrics: boolean;
+    explicit_content_lyrics: number;
+    explicit_content_cover: number;
+    preview: string;
+    bpm: number;
+    gain: number;
+    available_countries: string[];
+    contributors: contributorsPublicApi[];
+    md5_image: string;
+    artist: contributorsPublicApi;
+    album: {
+        id: number;
+        title: string;
+        link: string;
+        cover: string;
+        cover_small: string;
+        cover_medium: string;
+        cover_big: string;
+        cover_xl: string;
+        md5_image: string;
+        release_date: string;
+        tracklist: string;
+        type: 'album';
+    };
+    type: 'track';
+}
+export {};

package/dist/types/tracks.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/user.d.ts

@@ -0,0 +1,16 @@
+export interface userType {
+    USER_ID: string;
+    EMAIL: string;
+    FIRSTNAME: string;
+    LASTNAME: string;
+    BIRTHDAY: string;
+    BLOG_NAME: string;
+    SEX: string;
+    ADDRESS?: string;
+    CITY?: string;
+    ZIP?: string;
+    COUNTRY: string;
+    LANG: string;
+    PHONE?: string;
+    __TYPE__: 'user';
+}

package/dist/types/user.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -0,0 +1,69 @@
+{
+  "name": "q-fi-core",
+  "version": "2.3.1",
+  "description": "Core module for q-fi.",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "lint": "node ./node_modules/eslint/bin/eslint.js --config .eslintrc.js --resolve-plugins-relative-to . .",
+    "prepublishOnly": "npm run lint && tsc",
+    "prebuild": "npm run lint",
+    "build": "tsc",
+    "test": "ava"
+  },
+  "files": [
+    "dist/**/*",
+    "types/**/*",
+    "CHANGELOG.md"
+  ],
+  "engines": {
+    "node": ">=12"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/soulwax/q-fi-core.git"
+  },
+  "homepage": "https://github.com/soulwax/q-fi-core#readme",
+  "bugs": {
+    "url": "https://github.com/soulwax/q-fi-core/issues"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "author": "Christian Kling",
+  "license": "SEE LICENSE IN LICENSE",
+  "dependencies": {
+    "browser-id3-writer": "^4.4.0",
+    "delay": "^5.0.0",
+    "node-html-parser": "^5.3.3",
+    "p-queue": "^6.6.2",
+    "spotify-uri": "^2.2.0",
+    "spotify-web-api-node": "^5.0.2"
+  },
+  "devDependencies": {
+    "@types/node": "^17.0.23",
+    "@types/spotify-web-api-node": "^5.0.3",
+    "@typescript-eslint/eslint-plugin": "^5.16.0",
+    "@typescript-eslint/parser": "^5.16.0",
+    "ava": "^4.1.0",
+    "eslint": "^8.11.0",
+    "eslint-plugin-prettier": "^4.0.0",
+    "prettier": "^2.6.0",
+    "ts-node": "^10.7.0",
+    "typescript": "^4.6.3"
+  },
+  "ava": {
+    "extensions": [
+      "ts"
+    ],
+    "files": [
+      "!dist",
+      "!__tests__/helpers.ts"
+    ],
+    "require": [
+      "ts-node/register"
+    ],
+    "timeout": "2m",
+    "verbose": true
+  }
+}

package/types/index.d.ts

@@ -0,0 +1 @@
+export * from '../dist/types';

package/types/index.js

@@ -0,0 +1,3 @@
+'use strict';
+
+module.exports = require('../dist/types');

package/types/package.json

@@ -0,0 +1,4 @@
+{
+  "main": "./index.js",
+  "types": "./index.d.ts"
+}