musicbrainz-api 0.5.2 → 0.7.2

package/lib/digest-auth.d.ts

@@ -1,21 +1,21 @@
-export interface ICredentials {
-    username: string;
-    password: string;
-}
-export declare class DigestAuth {
-    private credentials;
-    /**
-     * RFC 2617: handle both MD5 and MD5-sess algorithms.
-     *
-     * If the algorithm directive's value is "MD5" or unspecified, then HA1 is
-     *   HA1=MD5(username:realm:password)
-     * If the algorithm directive's value is "MD5-sess", then HA1 is
-     *   HA1=MD5(MD5(username:realm:password):nonce:cnonce)
-     */
-    static ha1Compute(algorithm: any, user: any, realm: any, pass: any, nonce: any, cnonce: any): string;
-    hasAuth: boolean;
-    sentAuth: boolean;
-    bearerToken: string;
-    constructor(credentials: ICredentials);
-    digest(method: string, path: string, authHeader: string): string;
-}
+export interface ICredentials {
+    username: string;
+    password: string;
+}
+export declare class DigestAuth {
+    private credentials;
+    /**
+     * RFC 2617: handle both MD5 and MD5-sess algorithms.
+     *
+     * If the algorithm directive's value is "MD5" or unspecified, then HA1 is
+     *   HA1=MD5(username:realm:password)
+     * If the algorithm directive's value is "MD5-sess", then HA1 is
+     *   HA1=MD5(MD5(username:realm:password):nonce:cnonce)
+     */
+    static ha1Compute(algorithm: any, user: any, realm: any, pass: any, nonce: any, cnonce: any): string;
+    hasAuth: boolean;
+    sentAuth: boolean;
+    bearerToken: string;
+    constructor(credentials: ICredentials);
+    digest(method: string, path: string, authHeader: string): string;
+}

package/lib/digest-auth.js

@@ -1,87 +1,88 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const uuid = require("uuid/v4");
-const crypto = require("crypto");
-function md5(str) {
-    return crypto.createHash('md5').update(str).digest('hex');
-}
-class DigestAuth {
-    constructor(credentials) {
-        this.credentials = credentials;
-        this.hasAuth = false;
-        this.sentAuth = false;
-        this.bearerToken = null;
-    }
-    /**
-     * RFC 2617: handle both MD5 and MD5-sess algorithms.
-     *
-     * If the algorithm directive's value is "MD5" or unspecified, then HA1 is
-     *   HA1=MD5(username:realm:password)
-     * If the algorithm directive's value is "MD5-sess", then HA1 is
-     *   HA1=MD5(MD5(username:realm:password):nonce:cnonce)
-     */
-    static ha1Compute(algorithm, user, realm, pass, nonce, cnonce) {
-        const ha1 = md5(user + ':' + realm + ':' + pass);
-        if (algorithm && algorithm.toLowerCase() === 'md5-sess') {
-            return md5(ha1 + ':' + nonce + ':' + cnonce);
-        }
-        else {
-            return ha1;
-        }
-    }
-    digest(method, path, authHeader) {
-        // TODO: More complete implementation of RFC 2617.
-        //   - support qop="auth-int" only
-        //   - handle Authentication-Info (not necessarily?)
-        //   - check challenge.stale (not necessarily?)
-        //   - increase nc (not necessarily?)
-        // For reference:
-        // http://tools.ietf.org/html/rfc2617#section-3
-        // https://github.com/bagder/curl/blob/master/lib/http_digest.c
-        const challenge = {};
-        const re = /([a-z0-9_-]+)=(?:"([^"]+)"|([a-z0-9_-]+))/gi;
-        while (true) {
-            const match = re.exec(authHeader);
-            if (!match) {
-                break;
-            }
-            challenge[match[1]] = match[2] || match[3];
-        }
-        const qop = /(^|,)\s*auth\s*($|,)/.test(challenge.qop) && 'auth';
-        const nc = qop && '00000001';
-        const cnonce = qop && uuid().replace(/-/g, '');
-        const ha1 = DigestAuth.ha1Compute(challenge.algorithm, this.credentials.username, challenge.realm, this.credentials.password, challenge.nonce, cnonce);
-        const ha2 = md5(method + ':' + path);
-        const digestResponse = qop
-            ? md5(ha1 + ':' + challenge.nonce + ':' + nc + ':' + cnonce + ':' + qop + ':' + ha2)
-            : md5(ha1 + ':' + challenge.nonce + ':' + ha2);
-        const authValues = {
-            username: this.credentials.username,
-            realm: challenge.realm,
-            nonce: challenge.nonce,
-            uri: path,
-            qop,
-            response: digestResponse,
-            nc,
-            cnonce,
-            algorithm: challenge.algorithm,
-            opaque: challenge.opaque
-        };
-        const parts = [];
-        for (const k in authValues) {
-            if (authValues[k]) {
-                if (k === 'qop' || k === 'nc' || k === 'algorithm') {
-                    parts.push(k + '=' + authValues[k]);
-                }
-                else {
-                    parts.push(k + '="' + authValues[k] + '"');
-                }
-            }
-        }
-        authHeader = 'Digest ' + parts.join(', ');
-        this.sentAuth = true;
-        return authHeader;
-    }
-}
-exports.DigestAuth = DigestAuth;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DigestAuth = void 0;
+const uuid_1 = require("uuid");
+const crypto = require("crypto");
+function md5(str) {
+    return crypto.createHash('md5').update(str).digest('hex'); // lgtm [js/insufficient-password-hash]
+}
+class DigestAuth {
+    constructor(credentials) {
+        this.credentials = credentials;
+        this.hasAuth = false;
+        this.sentAuth = false;
+        this.bearerToken = null;
+    }
+    /**
+     * RFC 2617: handle both MD5 and MD5-sess algorithms.
+     *
+     * If the algorithm directive's value is "MD5" or unspecified, then HA1 is
+     *   HA1=MD5(username:realm:password)
+     * If the algorithm directive's value is "MD5-sess", then HA1 is
+     *   HA1=MD5(MD5(username:realm:password):nonce:cnonce)
+     */
+    static ha1Compute(algorithm, user, realm, pass, nonce, cnonce) {
+        const ha1 = md5(user + ':' + realm + ':' + pass); // lgtm [js/insufficient-password-hash]
+        if (algorithm && algorithm.toLowerCase() === 'md5-sess') {
+            return md5(ha1 + ':' + nonce + ':' + cnonce);
+        }
+        else {
+            return ha1;
+        }
+    }
+    digest(method, path, authHeader) {
+        // TODO: More complete implementation of RFC 2617.
+        //   - support qop="auth-int" only
+        //   - handle Authentication-Info (not necessarily?)
+        //   - check challenge.stale (not necessarily?)
+        //   - increase nc (not necessarily?)
+        // For reference:
+        // http://tools.ietf.org/html/rfc2617#section-3
+        // https://github.com/bagder/curl/blob/master/lib/http_digest.c
+        const challenge = {};
+        const re = /([a-z0-9_-]+)=(?:"([^"]+)"|([a-z0-9_-]+))/gi;
+        while (true) {
+            const match = re.exec(authHeader);
+            if (!match) {
+                break;
+            }
+            challenge[match[1]] = match[2] || match[3];
+        }
+        const qop = /(^|,)\s*auth\s*($|,)/.test(challenge.qop) && 'auth';
+        const nc = qop && '00000001';
+        const cnonce = qop && (0, uuid_1.v4)().replace(/-/g, '');
+        const ha1 = DigestAuth.ha1Compute(challenge.algorithm, this.credentials.username, challenge.realm, this.credentials.password, challenge.nonce, cnonce);
+        const ha2 = md5(method + ':' + path); // lgtm [js/insufficient-password-hash]
+        const digestResponse = qop
+            ? md5(ha1 + ':' + challenge.nonce + ':' + nc + ':' + cnonce + ':' + qop + ':' + ha2) // lgtm [js/insufficient-password-hash]
+            : md5(ha1 + ':' + challenge.nonce + ':' + ha2); // lgtm [js/insufficient-password-hash]
+        const authValues = {
+            username: this.credentials.username,
+            realm: challenge.realm,
+            nonce: challenge.nonce,
+            uri: path,
+            qop,
+            response: digestResponse,
+            nc,
+            cnonce,
+            algorithm: challenge.algorithm,
+            opaque: challenge.opaque
+        };
+        const parts = [];
+        for (const k in authValues) {
+            if (authValues[k]) {
+                if (k === 'qop' || k === 'nc' || k === 'algorithm') {
+                    parts.push(k + '=' + authValues[k]);
+                }
+                else {
+                    parts.push(k + '="' + authValues[k] + '"');
+                }
+            }
+        }
+        authHeader = 'Digest ' + parts.join(', ');
+        this.sentAuth = true;
+        return authHeader;
+    }
+}
+exports.DigestAuth = DigestAuth;
 //# sourceMappingURL=digest-auth.js.map

package/lib/musicbrainz-api.d.ts

@@ -1,140 +1,156 @@
-export { XmlMetadata } from './xml/xml-metadata';
-export { XmlIsrc } from './xml/xml-isrc';
-export { XmlIsrcList } from './xml/xml-isrc-list';
-export { XmlRecording } from './xml/xml-recording';
-import { XmlMetadata } from './xml/xml-metadata';
-import * as mb from './musicbrainz.types';
-export * from './musicbrainz.types';
-/**
- * https://musicbrainz.org/doc/Development/XML_Web_Service/Version_2#Subqueries
- */
-export declare type Includes = 'artists' | 'releases' | 'recordings' | 'artists' | 'artist-credits' | 'isrcs' | 'url-rels' | 'release-groups' | 'aliases' | 'discids' | 'annotation' | 'media' | 'area-rels' | 'artist-rels' | 'event-rels' | 'instrument-rels' | 'label-rels' | 'place-rels' | 'recording-rels' | 'release-rels' | 'release-group-rels' | 'series-rels' | 'url-rels' | 'work-rels';
-export interface IFormData {
-    [key: string]: string | number;
-}
-export interface IMusicBrainzConfig {
-    botAccount?: {
-        username: string;
-        password: string;
-    };
-    baseUrl?: string;
-    appName?: string;
-    appVersion?: string;
-    /**
-     * HTTP Proxy
-     */
-    proxy?: string;
-    /**
-     * User e-mail address or application URL
-     */
-    appContactInfo?: string;
-}
-export declare class MusicBrainzApi {
-    private static escapeText;
-    readonly config: IMusicBrainzConfig;
-    private request;
-    private rateLimiter;
-    private readonly cookieJar;
-    constructor(_config?: IMusicBrainzConfig);
-    restGet<T>(relUrl: string, query?: {
-        [key: string]: any;
-    }, attempt?: number): Promise<T>;
-    /**
-     * Generic lookup function
-     * @param entity
-     * @param mbid
-     * @param inc
-     */
-    getEntity<T>(entity: mb.EntityType, mbid: string, inc?: Includes[]): Promise<T>;
-    /**
-     * Lookup area
-     * @param areaId Area MBID
-     * @param inc Sub-queries
-     */
-    getArea(areaId: string, inc?: Includes[]): Promise<mb.IArea>;
-    /**
-     * Lookup artist
-     * @param artistId Artist MBID
-     * @param inc Sub-queries
-     */
-    getArtist(artistId: string, inc?: Includes[]): Promise<mb.IArtist>;
-    /**
-     * Lookup release
-     * @param releaseId Release MBID
-     * @param inc Include: artist-credits, labels, recordings, release-groups, media, discids, isrcs (with recordings)
-     * ToDo: ['recordings', 'artists', 'artist-credits', 'isrcs', 'url-rels', 'release-groups']
-     */
-    getRelease(releaseId: string, inc?: Includes[]): Promise<mb.IRelease>;
-    /**
-     * Lookup release-group
-     * @param releaseGroupId Release-group MBID
-     * @param inc Include: ToDo
-     */
-    getReleaseGroup(releaseGroupId: string, inc?: Includes[]): Promise<mb.IReleaseGroup>;
-    /**
-     * Lookup work
-     * @param workId Work MBID
-     */
-    getWork(workId: string): Promise<mb.IWork>;
-    /**
-     * Lookup label
-     * @param labelId Label MBID
-     */
-    getLabel(labelId: string): Promise<mb.ILabel>;
-    /**
-     * Lookup recording
-     * @param recordingId Label MBID
-     * @param inc Include: artist-credits, isrcs
-     */
-    getRecording(recordingId: string, inc?: Array<'artists' | 'artist-credits' | 'releases' | 'isrcs' | 'url-rels'>): Promise<mb.IRecording>;
-    postRecording(xmlMetadata: XmlMetadata): Promise<void>;
-    post(entity: mb.EntityType, xmlMetadata: XmlMetadata): Promise<void>;
-    login(): Promise<boolean>;
-    /**
-     * Submit entity
-     * @param entity Entity type e.g. 'recording'
-     * @param mbid
-     * @param formData
-     */
-    editEntity(entity: mb.EntityType, mbid: string, formData: IFormData): Promise<void>;
-    /**
-     * Set URL to recording
-     * @param recording Recording to update
-     * @param url2add URL to add to the recording
-     * @param editNote Edit note
-     */
-    addUrlToRecording(recording: mb.IRecording, url2add: {
-        linkTypeId: mb.LinkType;
-        text: string;
-    }, editNote?: string): Promise<void>;
-    /**
-     * Add ISRC to recording
-     * @param recording Recording to update
-     * @param isrc ISRC code to add
-     * @param editNote Edit note
-     */
-    addIsrc(recording: mb.IRecording, isrc: string, editNote?: string): Promise<void>;
-    /**
-     * Search an entity using a search query
-     * @param query e.g.: '" artist: Madonna, track: Like a virgin"' or object with search terms: {artist: Madonna}
-     * @param entity e.g. 'recording'
-     * @param offset
-     * @param limit
-     */
-    search<T extends mb.ISearchResult>(entity: mb.EntityType, query: string | IFormData, offset?: number, limit?: number): Promise<T>;
-    /**
-     * Add Spotify-ID to MusicBrainz recording.
-     * This function will automatically lookup the recording title, which is required to submit the recording URL
-     * @param recording MBID of the recording
-     * @param spotifyId Spotify ID
-     * @param editNote Comment to add.
-     */
-    addSpotifyIdToRecording(recording: mb.IRecording, spotifyId: string, editNote: string): Promise<void>;
-    searchArtist(query: string | IFormData, offset?: number, limit?: number): Promise<mb.IArtistList>;
-    searchRelease(query: string | IFormData, offset?: number, limit?: number): Promise<mb.IReleaseList>;
-    searchReleaseGroup(query: string | IFormData, offset?: number, limit?: number): Promise<mb.IReleaseGroupList>;
-    searchArea(query: string | IFormData, offset?: number, limit?: number): Promise<mb.IAreaList>;
-    searchUrl(query: string | IFormData, offset?: number, limit?: number): Promise<mb.IUrlList>;
-    private getCookies;
-}
-export declare function makeAndQueryString(keyValuePairs: IFormData): string;
+export { XmlMetadata } from './xml/xml-metadata';
+export { XmlIsrc } from './xml/xml-isrc';
+export { XmlIsrcList } from './xml/xml-isrc-list';
+export { XmlRecording } from './xml/xml-recording';
+import { XmlMetadata } from './xml/xml-metadata';
+import * as mb from './musicbrainz.types';
+export * from './musicbrainz.types';
+/**
+ * https://musicbrainz.org/doc/Development/XML_Web_Service/Version_2#Subqueries
+ */
+export declare type Includes = 'artists' | 'releases' | 'recordings' | 'artist-credits' | 'isrcs' | 'url-rels' | 'release-groups' | 'aliases' | 'discids' | 'annotation' | 'media' | 'area-rels' | 'artist-rels' | 'event-rels' | 'instrument-rels' | 'label-rels' | 'place-rels' | 'recording-rels' | 'release-rels' | 'release-group-rels' | 'series-rels' | 'work-rels';
+export interface IFormData {
+    [key: string]: string | number;
+}
+export interface IMusicBrainzConfig {
+    botAccount?: {
+        username: string;
+        password: string;
+    };
+    baseUrl?: string;
+    appName?: string;
+    appVersion?: string;
+    /**
+     * HTTP Proxy
+     */
+    proxy?: string;
+    /**
+     * User e-mail address or application URL
+     */
+    appContactInfo?: string;
+}
+export interface ISessionInformation {
+    csrf: {
+        sessionKey: string;
+        token: string;
+    };
+    loggedIn?: boolean;
+}
+export declare class MusicBrainzApi {
+    private static escapeText;
+    readonly config: IMusicBrainzConfig;
+    private rateLimiter;
+    private options;
+    private session;
+    static fetchCsrf(html: string): {
+        sessionKey: string;
+        token: string;
+    };
+    private static fetchValue;
+    private getCookies;
+    constructor(_config?: IMusicBrainzConfig);
+    restGet<T>(relUrl: string, query?: {
+        [key: string]: any;
+    }, attempt?: number): Promise<T>;
+    /**
+     * Generic lookup function
+     * @param entity
+     * @param mbid
+     * @param inc
+     */
+    getEntity<T>(entity: mb.EntityType, mbid: string, inc?: Includes[]): Promise<T>;
+    /**
+     * Lookup area
+     * @param areaId Area MBID
+     * @param inc Sub-queries
+     */
+    getArea(areaId: string, inc?: Includes[]): Promise<mb.IArea>;
+    /**
+     * Lookup artist
+     * @param artistId Artist MBID
+     * @param inc Sub-queries
+     */
+    getArtist(artistId: string, inc?: Includes[]): Promise<mb.IArtist>;
+    /**
+     * Lookup release
+     * @param releaseId Release MBID
+     * @param inc Include: artist-credits, labels, recordings, release-groups, media, discids, isrcs (with recordings)
+     * ToDo: ['recordings', 'artists', 'artist-credits', 'isrcs', 'url-rels', 'release-groups']
+     */
+    getRelease(releaseId: string, inc?: Includes[]): Promise<mb.IRelease>;
+    /**
+     * Lookup release-group
+     * @param releaseGroupId Release-group MBID
+     * @param inc Include: ToDo
+     */
+    getReleaseGroup(releaseGroupId: string, inc?: Includes[]): Promise<mb.IReleaseGroup>;
+    /**
+     * Lookup work
+     * @param workId Work MBID
+     */
+    getWork(workId: string): Promise<mb.IWork>;
+    /**
+     * Lookup label
+     * @param labelId Label MBID
+     */
+    getLabel(labelId: string): Promise<mb.ILabel>;
+    /**
+     * Lookup recording
+     * @param recordingId Label MBID
+     * @param inc Include: artist-credits, isrcs
+     */
+    getRecording(recordingId: string, inc?: Includes[]): Promise<mb.IRecording>;
+    postRecording(xmlMetadata: XmlMetadata): Promise<void>;
+    post(entity: mb.EntityType, xmlMetadata: XmlMetadata): Promise<void>;
+    login(): Promise<boolean>;
+    /**
+     * Logout
+     */
+    logout(): Promise<boolean>;
+    /**
+     * Submit entity
+     * @param entity Entity type e.g. 'recording'
+     * @param mbid
+     * @param formData
+     */
+    editEntity(entity: mb.EntityType, mbid: string, formData: Record<string, any>): Promise<void>;
+    /**
+     * Set URL to recording
+     * @param recording Recording to update
+     * @param url2add URL to add to the recording
+     * @param editNote Edit note
+     */
+    addUrlToRecording(recording: mb.IRecording, url2add: {
+        linkTypeId: mb.LinkType;
+        text: string;
+    }, editNote?: string): Promise<void>;
+    /**
+     * Add ISRC to recording
+     * @param recording Recording to update
+     * @param isrc ISRC code to add
+     * @param editNote Edit note
+     */
+    addIsrc(recording: mb.IRecording, isrc: string, editNote?: string): Promise<void>;
+    /**
+     * Search an entity using a search query
+     * @param query e.g.: '" artist: Madonna, track: Like a virgin"' or object with search terms: {artist: Madonna}
+     * @param entity e.g. 'recording'
+     * @param query Arguments
+     */
+    search<T extends mb.ISearchResult>(entity: mb.EntityType, query: mb.ISearchQuery): Promise<T>;
+    /**
+     * Add Spotify-ID to MusicBrainz recording.
+     * This function will automatically lookup the recording title, which is required to submit the recording URL
+     * @param recording MBID of the recording
+     * @param spotifyId Spotify ID
+     * @param editNote Comment to add.
+     */
+    addSpotifyIdToRecording(recording: mb.IRecording, spotifyId: string, editNote: string): Promise<void>;
+    searchArea(query: mb.ISearchQuery & mb.ILinkedEntitiesArea): Promise<mb.IAreaList>;
+    searchArtist(query: mb.ISearchQuery & mb.ILinkedEntitiesArtist): Promise<mb.IArtistList>;
+    searchRelease(query: mb.ISearchQuery & mb.ILinkedEntitiesRelease): Promise<mb.IReleaseList>;
+    searchReleaseGroup(query: mb.ISearchQuery & mb.ILinkedEntitiesReleaseGroup): Promise<mb.IReleaseGroupList>;
+    searchUrl(query: mb.ISearchQuery & mb.ILinkedEntitiesUrl): Promise<mb.IUrlList>;
+    private getSession;
+}
+export declare function makeAndQueryString(keyValuePairs: IFormData): string;