@jjdenhertog/plex-music-search 1.0.1

package/README.md

@@ -0,0 +1,110 @@
+
+# Plex Music Search
+
+[![Buy Me a Coffee](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://www.buymeacoffee.com/jjdenhertog)
+
+The `plex-music-search` library provides tools for searching and analyzing tracks within a Plex music library, building on the functionality of [music-search](https://github.com/jjdenhertog/music-search) with Plex-specific configurations. It can handle track searches efficiently and offers configuration options tailored to Plex’s system.
+
+## Table of Contents
+- [Installation](#installation)
+- [Usage](#usage)
+- [Default Settings](#default-settings)
+- [Configuration Options](#configuration-options)
+- [Getting Plex URI and Token](#getting-plex-uri-and-token)
+- [Examples](#examples)
+- [Support](#support)
+
+## Installation
+
+Install the `plex-music-search` library with npm:
+
+```bash
+npm install @jjdenhertog/plex-music-search
+```
+
+## Usage
+
+The library provides a straightforward API to search tracks in your Plex library. To get started, you’ll need the URI and token for your Plex server.
+
+```typescript
+import PlexMusicSearch from '@jjdenhertog/plex-music-search';
+
+const searchItems = [
+    { id: "track1", title: "Shape of You", album: "Divide", artists: ["Ed Sheeran"] },
+    // More items...
+];
+
+const plexMusicSearch = new PlexMusicSearch({
+    uri: "https://your-plex-server-url",
+    token: "your-plex-auth-token",
+});
+
+// Search for multiple tracks
+const searchResult = await plexMusicSearch.search(searchItems);
+console.log(searchResult);
+```
+
+## Default Settings
+
+The `plex-music-search` library has a set of default search settings, allowing you to use it without additional configuration:
+
+- **URI**: The base URL of your Plex server.
+- **Token**: Your Plex authentication token.
+
+These settings ensure you can start searching with minimal setup. Advanced configurations are available if needed.
+
+## Configuration Options
+
+The `plex-music-search` library supports several configuration options to customize the search behavior. Here’s a quick look at the main options:
+
+- **uri**: URL of the Plex server.
+- **token**: Plex authentication token.
+
+Example:
+
+```typescript
+const plexMusicSearch = new PlexMusicSearch({
+    uri: "https://your-plex-server-url",
+    token: "your-plex-auth-token"
+});
+```
+
+## Getting Plex URI and Token
+
+To use `plex-music-search`, you’ll need your Plex server's URI and a token for authentication:
+
+1. **URI**: This is the base URL of your Plex server. You can usually find this in your Plex server settings, or by accessing Plex Web and copying the URL from your browser.
+
+2. **Token**: The Plex token is required to authenticate API requests. To find your token:
+   - Open Plex Web and log in.
+   - Right-click on the page and select "Inspect" or "View Page Source."
+   - Look for the token in the source code (often found after the term "X-Plex-Token").
+
+## Faster searching
+
+The default approach search quite thoroughly through your but as a result can be extremely time-consuming. By default it uses three search approaches. By limiting to only one search approach you will decrease the time searching tremendously.
+
+```typescript
+const searchItems = [
+    { id: "1234", title: "Shape of You", album: "Divide", artists: ["Ed Sheeran"] },
+    // More items...
+];
+
+const plexMusicSearch = new PlexMusicSearch({
+    uri: "https://your-plex-server-url",
+    token: "your-plex-auth-token",
+    searchApproaches: [{ id: 'fast', filtered: true, trimmed: false}]
+});
+
+// Search for multiple tracks
+const searchResult = await plexMusicSearch.search(searchItems);
+
+```
+
+## Support
+
+If this project helps you, consider supporting me:
+
+[![Buy Me a Coffee](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://www.buymeacoffee.com/jjdenhertog)
+
+Your support helps improve and maintain this library.

package/actions/getAlbumTracks.d.ts

@@ -0,0 +1,2 @@
+import { HubSearchResult } from "../types";
+export default function getAlbumTracks(uri: string, token: string, key: string): Promise<HubSearchResult[]>;

package/actions/getAlbumTracks.js

@@ -0,0 +1,78 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
+    return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = getAlbumTracks;
+var music_search_1 = require("@jjdenhertog/music-search");
+var getMetadata_1 = require("./getMetadata");
+function getAlbumTracks(uri, token, key) {
+    return __awaiter(this, void 0, void 0, function () {
+        var albumTracks, trackResult;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, (0, getMetadata_1.getMetadata)(uri, token, key)];
+                case 1:
+                    albumTracks = _a.sent();
+                    trackResult = albumTracks.map(function (metadata) {
+                        return {
+                            type: "track",
+                            id: metadata.key,
+                            ratingKey: metadata.ratingKey,
+                            guid: metadata.guid,
+                            score: metadata.score,
+                            image: metadata.thumb,
+                            title: metadata.title,
+                            album: {
+                                id: metadata.parentKey,
+                                guid: metadata.parentGuid,
+                                title: metadata.parentTitle,
+                                year: metadata.parentYear,
+                                image: metadata.parentThumb,
+                            },
+                            artist: {
+                                id: metadata.grandparentKey,
+                                guid: metadata.grandparentGuid,
+                                title: (0, music_search_1.removeFeaturing)(metadata.originalTitle || metadata.grandparentTitle),
+                                image: metadata.grandparentThumb,
+                            }
+                        };
+                    });
+                    return [2 /*return*/, trackResult];
+            }
+        });
+    });
+}

package/actions/getMetadata.d.ts

@@ -0,0 +1,2 @@
+import { Metadata } from "../types/plex/Metadata";
+export declare function getMetadata(uri: string, token: string, key: string): Promise<Metadata[]>;

package/actions/getMetadata.js

@@ -0,0 +1,80 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
+    return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getMetadata = getMetadata;
+var AxiosRequest_1 = require("../utils/AxiosRequest");
+var getAPIUrl_1 = __importDefault(require("../utils/getAPIUrl"));
+function getMetadata(uri, token, key) {
+    return __awaiter(this, void 0, void 0, function () {
+        var url, result, _e_1, MediaContainer;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    url = (0, getAPIUrl_1.default)(uri, key);
+                    _a.label = 1;
+                case 1:
+                    _a.trys.push([1, 3, , 6]);
+                    return [4 /*yield*/, AxiosRequest_1.AxiosRequest.get(url, token)];
+                case 2:
+                    result = _a.sent();
+                    return [3 /*break*/, 6];
+                case 3:
+                    _e_1 = _a.sent();
+                    // Cooldown
+                    return [4 /*yield*/, (new Promise(function (resolve) { setTimeout(resolve, 1000); }))];
+                case 4:
+                    // Cooldown
+                    _a.sent();
+                    return [4 /*yield*/, AxiosRequest_1.AxiosRequest.get(url, token)];
+                case 5:
+                    result = _a.sent();
+                    return [3 /*break*/, 6];
+                case 6:
+                    if (result === null || result === void 0 ? void 0 : result.data) {
+                        MediaContainer = result.data.MediaContainer;
+                        if (MediaContainer && MediaContainer.size > 0)
+                            return [2 /*return*/, MediaContainer.Metadata];
+                    }
+                    return [2 /*return*/, []];
+            }
+        });
+    });
+}

package/actions/hubSearch.d.ts

@@ -0,0 +1,2 @@
+import { HubSearchResult } from "../types/actions/HubSearchResult";
+export default function hubSearch(uri: string, token: string, query: string, limit?: number): Promise<HubSearchResult[]>;

package/actions/hubSearch.js

@@ -0,0 +1,85 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = hubSearch;
+/* eslint-disable unicorn/prefer-code-point */
+/* eslint-disable prefer-template */
+/* eslint-disable unicorn/prefer-string-replace-all */
+var music_search_1 = require("@jjdenhertog/music-search");
+var AxiosRequest_1 = require("../utils/AxiosRequest");
+var getAPIUrl_1 = __importDefault(require("../utils/getAPIUrl"));
+function hubSearch(uri, token, query, limit) {
+    if (limit === void 0) { limit = 5; }
+    return new Promise(function (resolve, reject) {
+        var url = (0, getAPIUrl_1.default)(uri, "/hubs/search?query=".concat(fixedEncodeURIComponent(query.trim()), "&limit=").concat(limit));
+        AxiosRequest_1.AxiosRequest.get(url, token)
+            .then(function (result) {
+            var response = [];
+            if (result.data.MediaContainer.Hub.length > 0) {
+                for (var i = 0; i < result.data.MediaContainer.Hub.length; i++) {
+                    var hub = result.data.MediaContainer.Hub[i];
+                    if (hub.type == "album" && hub.Metadata) {
+                        for (var j = 0; j < hub.Metadata.length; j++) {
+                            var metadata = hub.Metadata[j];
+                            response.push({
+                                type: "album",
+                                id: metadata.key,
+                                ratingKey: metadata.ratingKey,
+                                guid: metadata.guid,
+                                score: metadata.score,
+                                image: metadata.thumb,
+                                year: metadata.year,
+                                title: metadata.title,
+                                artist: {
+                                    guid: metadata.parentGuid,
+                                    id: metadata.parentKey,
+                                    title: (0, music_search_1.removeFeaturing)(metadata.parentTitle),
+                                    alternative_title: "",
+                                    image: metadata.parentThumb,
+                                },
+                            });
+                        }
+                    }
+                    if (hub.type == "track" && hub.Metadata) {
+                        for (var j = 0; j < hub.Metadata.length; j++) {
+                            var metadata = hub.Metadata[j];
+                            response.push({
+                                type: "track",
+                                id: metadata.key,
+                                ratingKey: metadata.ratingKey,
+                                guid: metadata.guid,
+                                score: metadata.score,
+                                image: metadata.thumb,
+                                title: metadata.title,
+                                album: {
+                                    id: metadata.parentKey,
+                                    guid: metadata.parentGuid,
+                                    title: metadata.parentTitle,
+                                    year: metadata.parentYear,
+                                    image: metadata.parentThumb,
+                                },
+                                artist: {
+                                    id: metadata.grandparentKey,
+                                    guid: metadata.grandparentGuid,
+                                    title: (0, music_search_1.removeFeaturing)(metadata.originalTitle || metadata.grandparentTitle),
+                                    image: metadata.grandparentThumb,
+                                }
+                            });
+                        }
+                    }
+                }
+            }
+            resolve(response);
+        })
+            .catch(function (_error) {
+            reject("Could not connect to server");
+        });
+    });
+}
+function fixedEncodeURIComponent(str) {
+    return encodeURIComponent(str).replace(/[!'()*]/g, function (c) {
+        return '%' + c.charCodeAt(0).toString(16);
+    });
+}

package/index.d.ts

@@ -0,0 +1,16 @@
+import { PlexMusicSearchConfig } from "./types/PlexMusicSearchConfig";
+import { PlexMusicSearchTrack } from "./types/PlexMusicSearchTrack";
+import { PlexTrack } from "./types/PlexTrack";
+import { SearchResponse } from "./types/SearchResponse";
+export declare class PlexMusicSearch {
+    private readonly _config;
+    private _cache;
+    constructor(config: PlexMusicSearchConfig);
+    search(tracks: PlexMusicSearchTrack[]): Promise<SearchResponse[]>;
+    analyze(track: PlexMusicSearchTrack): Promise<SearchResponse>;
+    searchAlbum(tracks: PlexMusicSearchTrack[]): Promise<SearchResponse[]>;
+    getById(key: string): Promise<PlexTrack>;
+    private _newTrackSearch;
+    private _findTrack;
+}
+export * from './types';