tsarr 1.0.0 → 1.1.1

package/README.md

@@ -7,7 +7,7 @@
 
 **Type-safe TypeScript SDK for Servarr APIs (Radarr, Sonarr, etc.)**
 
-TsArr provides type-safe TypeScript clients for all Servarr APIs, generated from their Swagger/OpenAPI specifications. Designed to run with Bun as the JavaScript runtime and optimized for Infrastructure-as-Code (IaC) workflows in stateless Kubernetes environments.
+TsArr provides type-safe TypeScript clients for all Servarr APIs, generated from their Swagger/OpenAPI specifications. Perfect for building automation tools, scripts, and applications to manage your media servers.
 
 ## Features
 
@@ -16,7 +16,7 @@ TsArr provides type-safe TypeScript clients for all Servarr APIs, generated from
 - 📦 **Modular** - Separate modules for each Servarr app (Radarr, Sonarr, etc.)
 - 🌳 **Tree-shakable** - Lightweight and dependency-minimal
 - 🔄 **Auto-generated** - CI pipeline regenerates when APIs change
-- ☸️ **IaC-ready** - Compatible with Helm, Terraform, and PrepArr/CodeArr
+- 🤖 **Automation-friendly** - Perfect for building tools and scripts
 
 ## Supported Servarr Apps
 
@@ -76,20 +76,18 @@ bun run format
 
 ## 📖 Documentation
 
+- [API Documentation](https://robbeverhelst.github.io/tsarr/) - Auto-generated TypeScript API docs
 - [Usage Guide](./docs/usage.md) - Complete usage documentation with examples
 - [Examples](./docs/examples.md) - Real-world automation examples
-- [IaC Integration](./docs/iac-integration.md) - Docker, Kubernetes, Terraform guides
-- [Releasing](./docs/releasing.md) - Release process and conventional commits
-- [Setup Secrets](./docs/setup-secrets.md) - Configure GitHub secrets for releases
 - [Examples Directory](./examples/) - Runnable example scripts
 
-## Architecture
+## Use Cases
 
-TsArr is designed for use with:
-- **Kubernetes** - Stateless container environments
-- **IaC tools** - Helm, Terraform, Ansible, etc.
-- **CI/CD pipelines** - Automated deployments and maintenance
-- **Container orchestration** - Docker Compose, Docker Swarm
+Perfect for building:
+- **Automation scripts** - Bulk movie imports, library maintenance, and media organization
+- **Management tools** - Custom dashboards, backup utilities, and monitoring scripts  
+- **Integration scripts** - Connect Servarr apps with other services and workflows
+- **CLI tools** - Command-line utilities for media server administration
 
 ## Contributing
 

package/dist/clients/lidarr.js

@@ -0,0 +1,626 @@
+// src/core/errors.ts
+class TsArrError extends Error {
+  code;
+  statusCode;
+  details;
+  constructor(message, code, statusCode, details) {
+    super(message);
+    this.code = code;
+    this.statusCode = statusCode;
+    this.details = details;
+    this.name = "TsArrError";
+  }
+}
+
+class ApiKeyError extends TsArrError {
+  constructor(message = "Invalid or missing API key") {
+    super(message, "API_KEY_ERROR", 401);
+    this.name = "ApiKeyError";
+  }
+}
+
+class ConnectionError extends TsArrError {
+  constructor(message, details) {
+    super(message, "CONNECTION_ERROR", undefined, details);
+    this.name = "ConnectionError";
+  }
+}
+
+// src/core/client.ts
+function createServarrClient(config) {
+  if (!config.apiKey) {
+    throw new ApiKeyError;
+  }
+  if (!config.baseUrl) {
+    throw new ConnectionError("No base URL provided");
+  }
+  const validatedConfig = {
+    ...config,
+    baseUrl: config.baseUrl.replace(/\/$/, "")
+  };
+  return {
+    config: validatedConfig,
+    getHeaders: () => ({
+      "X-Api-Key": validatedConfig.apiKey,
+      "Content-Type": "application/json",
+      ...validatedConfig.headers
+    }),
+    getBaseUrl: () => validatedConfig.baseUrl
+  };
+}
+
+// node_modules/@hey-api/client-fetch/dist/index.js
+var T = /\{[^{}]+\}/g;
+var h = ({ allowReserved: i, name: n, value: e }) => {
+  if (e == null)
+    return "";
+  if (typeof e == "object")
+    throw new Error("Deeply-nested arrays/objects aren’t supported. Provide your own `querySerializer()` to handle these.");
+  return `${n}=${i ? e : encodeURIComponent(e)}`;
+};
+var U = (i) => {
+  switch (i) {
+    case "label":
+      return ".";
+    case "matrix":
+      return ";";
+    case "simple":
+      return ",";
+    default:
+      return "&";
+  }
+};
+var $ = (i) => {
+  switch (i) {
+    case "form":
+      return ",";
+    case "pipeDelimited":
+      return "|";
+    case "spaceDelimited":
+      return "%20";
+    default:
+      return ",";
+  }
+};
+var D = (i) => {
+  switch (i) {
+    case "label":
+      return ".";
+    case "matrix":
+      return ";";
+    case "simple":
+      return ",";
+    default:
+      return "&";
+  }
+};
+var j = ({ allowReserved: i, explode: n, name: e, style: a, value: o }) => {
+  if (!n) {
+    let r = (i ? o : o.map((c) => encodeURIComponent(c))).join($(a));
+    switch (a) {
+      case "label":
+        return `.${r}`;
+      case "matrix":
+        return `;${e}=${r}`;
+      case "simple":
+        return r;
+      default:
+        return `${e}=${r}`;
+    }
+  }
+  let s = U(a), t = o.map((r) => a === "label" || a === "simple" ? i ? r : encodeURIComponent(r) : h({ allowReserved: i, name: e, value: r })).join(s);
+  return a === "label" || a === "matrix" ? s + t : t;
+};
+var C = ({ allowReserved: i, explode: n, name: e, style: a, value: o }) => {
+  if (o instanceof Date)
+    return `${e}=${o.toISOString()}`;
+  if (a !== "deepObject" && !n) {
+    let r = [];
+    Object.entries(o).forEach(([u, l]) => {
+      r = [...r, u, i ? l : encodeURIComponent(l)];
+    });
+    let c = r.join(",");
+    switch (a) {
+      case "form":
+        return `${e}=${c}`;
+      case "label":
+        return `.${c}`;
+      case "matrix":
+        return `;${e}=${c}`;
+      default:
+        return c;
+    }
+  }
+  let s = D(a), t = Object.entries(o).map(([r, c]) => h({ allowReserved: i, name: a === "deepObject" ? `${e}[${r}]` : r, value: c })).join(s);
+  return a === "label" || a === "matrix" ? s + t : t;
+};
+var _ = ({ path: i, url: n }) => {
+  let e = n, a = n.match(T);
+  if (a)
+    for (let o of a) {
+      let s = false, t = o.substring(1, o.length - 1), r = "simple";
+      t.endsWith("*") && (s = true, t = t.substring(0, t.length - 1)), t.startsWith(".") ? (t = t.substring(1), r = "label") : t.startsWith(";") && (t = t.substring(1), r = "matrix");
+      let c = i[t];
+      if (c == null)
+        continue;
+      if (Array.isArray(c)) {
+        e = e.replace(o, j({ explode: s, name: t, style: r, value: c }));
+        continue;
+      }
+      if (typeof c == "object") {
+        e = e.replace(o, C({ explode: s, name: t, style: r, value: c }));
+        continue;
+      }
+      if (r === "matrix") {
+        e = e.replace(o, `;${h({ name: t, value: c })}`);
+        continue;
+      }
+      let u = encodeURIComponent(r === "label" ? `.${c}` : c);
+      e = e.replace(o, u);
+    }
+  return e;
+};
+var b = ({ allowReserved: i, array: n, object: e } = {}) => (o) => {
+  let s = [];
+  if (o && typeof o == "object")
+    for (let t in o) {
+      let r = o[t];
+      if (r != null) {
+        if (Array.isArray(r)) {
+          s = [...s, j({ allowReserved: i, explode: true, name: t, style: "form", value: r, ...n })];
+          continue;
+        }
+        if (typeof r == "object") {
+          s = [...s, C({ allowReserved: i, explode: true, name: t, style: "deepObject", value: r, ...e })];
+          continue;
+        }
+        s = [...s, h({ allowReserved: i, name: t, value: r })];
+      }
+    }
+  return s.join("&");
+};
+var A = (i) => {
+  if (!i)
+    return;
+  let n = i.split(";")[0].trim();
+  if (n.startsWith("application/json") || n.endsWith("+json"))
+    return "json";
+  if (n === "multipart/form-data")
+    return "formData";
+  if (["application/", "audio/", "image/", "video/"].some((e) => n.startsWith(e)))
+    return "blob";
+  if (n.startsWith("text/"))
+    return "text";
+};
+var w = ({ baseUrl: i, path: n, query: e, querySerializer: a, url: o }) => {
+  let s = o.startsWith("/") ? o : `/${o}`, t = i + s;
+  n && (t = _({ path: n, url: t }));
+  let r = e ? a(e) : "";
+  return r.startsWith("?") && (r = r.substring(1)), r && (t += `?${r}`), t;
+};
+var R = (i, n) => {
+  let e = { ...i, ...n };
+  return e.baseUrl?.endsWith("/") && (e.baseUrl = e.baseUrl.substring(0, e.baseUrl.length - 1)), e.headers = O(i.headers, n.headers), e;
+};
+var O = (...i) => {
+  let n = new Headers;
+  for (let e of i) {
+    if (!e || typeof e != "object")
+      continue;
+    let a = e instanceof Headers ? e.entries() : Object.entries(e);
+    for (let [o, s] of a)
+      if (s === null)
+        n.delete(o);
+      else if (Array.isArray(s))
+        for (let t of s)
+          n.append(o, t);
+      else
+        s !== undefined && n.set(o, typeof s == "object" ? JSON.stringify(s) : s);
+  }
+  return n;
+};
+var y = class {
+  _fns;
+  constructor() {
+    this._fns = [];
+  }
+  clear() {
+    this._fns = [];
+  }
+  exists(n) {
+    return this._fns.indexOf(n) !== -1;
+  }
+  eject(n) {
+    let e = this._fns.indexOf(n);
+    e !== -1 && (this._fns = [...this._fns.slice(0, e), ...this._fns.slice(e + 1)]);
+  }
+  use(n) {
+    this._fns = [...this._fns, n];
+  }
+};
+var P = () => ({ error: new y, request: new y, response: new y });
+var E = { bodySerializer: (i) => JSON.stringify(i) };
+var W = b({ allowReserved: false, array: { explode: true, style: "form" }, object: { explode: true, style: "deepObject" } });
+var B = { "Content-Type": "application/json" };
+var x = (i = {}) => ({ ...E, baseUrl: "", fetch: globalThis.fetch, headers: B, parseAs: "auto", querySerializer: W, ...i });
+var J = (i = {}) => {
+  let n = R(x(), i), e = () => ({ ...n }), a = (t) => (n = R(n, t), e()), o = P(), s = async (t) => {
+    let r = { ...n, ...t, headers: O(n.headers, t.headers) };
+    r.body && r.bodySerializer && (r.body = r.bodySerializer(r.body)), r.body || r.headers.delete("Content-Type");
+    let c = w({ baseUrl: r.baseUrl ?? "", path: r.path, query: r.query, querySerializer: typeof r.querySerializer == "function" ? r.querySerializer : b(r.querySerializer), url: r.url }), u = { redirect: "follow", ...r }, l = new Request(c, u);
+    for (let f of o.request._fns)
+      l = await f(l, r);
+    let I = r.fetch, p = await I(l);
+    for (let f of o.response._fns)
+      p = await f(p, l, r);
+    let g = { request: l, response: p };
+    if (p.ok) {
+      if (p.status === 204 || p.headers.get("Content-Length") === "0")
+        return { data: {}, ...g };
+      if (r.parseAs === "stream")
+        return { data: p.body, ...g };
+      let f = (r.parseAs === "auto" ? A(p.headers.get("Content-Type")) : r.parseAs) ?? "json", S = await p[f]();
+      return f === "json" && r.responseTransformer && (S = await r.responseTransformer(S)), { data: S, ...g };
+    }
+    let m = await p.text();
+    try {
+      m = JSON.parse(m);
+    } catch {}
+    let d = m;
+    for (let f of o.error._fns)
+      d = await f(m, p, l, r);
+    if (d = d || {}, r.throwOnError)
+      throw d;
+    return { error: d, ...g };
+  };
+  return { connect: (t) => s({ ...t, method: "CONNECT" }), delete: (t) => s({ ...t, method: "DELETE" }), get: (t) => s({ ...t, method: "GET" }), getConfig: e, head: (t) => s({ ...t, method: "HEAD" }), interceptors: o, options: (t) => s({ ...t, method: "OPTIONS" }), patch: (t) => s({ ...t, method: "PATCH" }), post: (t) => s({ ...t, method: "POST" }), put: (t) => s({ ...t, method: "PUT" }), request: s, setConfig: a, trace: (t) => s({ ...t, method: "TRACE" }) };
+};
+
+// src/generated/lidarr/services.gen.ts
+var client = J(x());
+var getApiV1Album = (options) => {
+  return (options?.client ?? client).get({
+    ...options,
+    url: "/api/v1/album"
+  });
+};
+var postApiV1Album = (options) => {
+  return (options?.client ?? client).post({
+    ...options,
+    url: "/api/v1/album"
+  });
+};
+var putApiV1AlbumById = (options) => {
+  return (options?.client ?? client).put({
+    ...options,
+    url: "/api/v1/album/{id}"
+  });
+};
+var deleteApiV1AlbumById = (options) => {
+  return (options?.client ?? client).delete({
+    ...options,
+    url: "/api/v1/album/{id}"
+  });
+};
+var getApiV1AlbumById = (options) => {
+  return (options?.client ?? client).get({
+    ...options,
+    url: "/api/v1/album/{id}"
+  });
+};
+var getApiV1AlbumLookup = (options) => {
+  return (options?.client ?? client).get({
+    ...options,
+    url: "/api/v1/album/lookup"
+  });
+};
+var getApiV1ArtistById = (options) => {
+  return (options?.client ?? client).get({
+    ...options,
+    url: "/api/v1/artist/{id}"
+  });
+};
+var putApiV1ArtistById = (options) => {
+  return (options?.client ?? client).put({
+    ...options,
+    url: "/api/v1/artist/{id}"
+  });
+};
+var deleteApiV1ArtistById = (options) => {
+  return (options?.client ?? client).delete({
+    ...options,
+    url: "/api/v1/artist/{id}"
+  });
+};
+var getApiV1Artist = (options) => {
+  return (options?.client ?? client).get({
+    ...options,
+    url: "/api/v1/artist"
+  });
+};
+var postApiV1Artist = (options) => {
+  return (options?.client ?? client).post({
+    ...options,
+    url: "/api/v1/artist"
+  });
+};
+var getApiV1ArtistLookup = (options) => {
+  return (options?.client ?? client).get({
+    ...options,
+    url: "/api/v1/artist/lookup"
+  });
+};
+var getApiV1Calendar = (options) => {
+  return (options?.client ?? client).get({
+    ...options,
+    url: "/api/v1/calendar"
+  });
+};
+var getFeedV1CalendarLidarrIcs = (options) => {
+  return (options?.client ?? client).get({
+    ...options,
+    url: "/feed/v1/calendar/lidarr.ics"
+  });
+};
+var postApiV1Command = (options) => {
+  return (options?.client ?? client).post({
+    ...options,
+    url: "/api/v1/command"
+  });
+};
+var getApiV1Command = (options) => {
+  return (options?.client ?? client).get({
+    ...options,
+    url: "/api/v1/command"
+  });
+};
+var getApiV1CustomformatById = (options) => {
+  return (options?.client ?? client).get({
+    ...options,
+    url: "/api/v1/customformat/{id}"
+  });
+};
+var putApiV1CustomformatById = (options) => {
+  return (options?.client ?? client).put({
+    ...options,
+    url: "/api/v1/customformat/{id}"
+  });
+};
+var deleteApiV1CustomformatById = (options) => {
+  return (options?.client ?? client).delete({
+    ...options,
+    url: "/api/v1/customformat/{id}"
+  });
+};
+var getApiV1Customformat = (options) => {
+  return (options?.client ?? client).get({
+    ...options,
+    url: "/api/v1/customformat"
+  });
+};
+var postApiV1Customformat = (options) => {
+  return (options?.client ?? client).post({
+    ...options,
+    url: "/api/v1/customformat"
+  });
+};
+var putApiV1CustomformatBulk = (options) => {
+  return (options?.client ?? client).put({
+    ...options,
+    url: "/api/v1/customformat/bulk"
+  });
+};
+var deleteApiV1CustomformatBulk = (options) => {
+  return (options?.client ?? client).delete({
+    ...options,
+    url: "/api/v1/customformat/bulk"
+  });
+};
+var getApiV1CustomformatSchema = (options) => {
+  return (options?.client ?? client).get({
+    ...options,
+    url: "/api/v1/customformat/schema"
+  });
+};
+var getApiV1Health = (options) => {
+  return (options?.client ?? client).get({
+    ...options,
+    url: "/api/v1/health"
+  });
+};
+var postApiV1Qualityprofile = (options) => {
+  return (options?.client ?? client).post({
+    ...options,
+    url: "/api/v1/qualityprofile"
+  });
+};
+var getApiV1Qualityprofile = (options) => {
+  return (options?.client ?? client).get({
+    ...options,
+    url: "/api/v1/qualityprofile"
+  });
+};
+var deleteApiV1QualityprofileById = (options) => {
+  return (options?.client ?? client).delete({
+    ...options,
+    url: "/api/v1/qualityprofile/{id}"
+  });
+};
+var putApiV1QualityprofileById = (options) => {
+  return (options?.client ?? client).put({
+    ...options,
+    url: "/api/v1/qualityprofile/{id}"
+  });
+};
+var getApiV1QualityprofileById = (options) => {
+  return (options?.client ?? client).get({
+    ...options,
+    url: "/api/v1/qualityprofile/{id}"
+  });
+};
+var getApiV1QualityprofileSchema = (options) => {
+  return (options?.client ?? client).get({
+    ...options,
+    url: "/api/v1/qualityprofile/schema"
+  });
+};
+var postApiV1Rootfolder = (options) => {
+  return (options?.client ?? client).post({
+    ...options,
+    url: "/api/v1/rootfolder"
+  });
+};
+var getApiV1Rootfolder = (options) => {
+  return (options?.client ?? client).get({
+    ...options,
+    url: "/api/v1/rootfolder"
+  });
+};
+var getApiV1SystemStatus = (options) => {
+  return (options?.client ?? client).get({
+    ...options,
+    url: "/api/v1/system/status"
+  });
+};
+
+// src/clients/lidarr.ts
+class LidarrClient {
+  clientConfig;
+  constructor(config) {
+    this.clientConfig = createServarrClient(config);
+    client.setConfig({
+      baseUrl: this.clientConfig.getBaseUrl(),
+      headers: this.clientConfig.getHeaders()
+    });
+  }
+  async getSystemStatus() {
+    return getApiV1SystemStatus();
+  }
+  async getHealth() {
+    return getApiV1Health();
+  }
+  async getArtists() {
+    return getApiV1Artist();
+  }
+  async getArtist(id) {
+    return getApiV1ArtistById({ path: { id } });
+  }
+  async addArtist(artist) {
+    return postApiV1Artist({ body: artist });
+  }
+  async updateArtist(id, artist) {
+    return putApiV1ArtistById({ path: { id: String(id) }, body: artist });
+  }
+  async deleteArtist(id) {
+    return deleteApiV1ArtistById({ path: { id } });
+  }
+  async getAlbums() {
+    return getApiV1Album();
+  }
+  async getAlbum(id) {
+    return getApiV1AlbumById({ path: { id } });
+  }
+  async searchArtists(term) {
+    return getApiV1ArtistLookup({ query: { term } });
+  }
+  async runCommand(command) {
+    return postApiV1Command({ body: command });
+  }
+  async getCommands() {
+    return getApiV1Command();
+  }
+  async getRootFolders() {
+    return getApiV1Rootfolder();
+  }
+  async addRootFolder(path) {
+    return postApiV1Rootfolder({
+      body: { path }
+    });
+  }
+  async addAlbum(album) {
+    return postApiV1Album({ body: album });
+  }
+  async updateAlbum(id, album) {
+    return putApiV1AlbumById({ path: { id: String(id) }, body: album });
+  }
+  async deleteAlbum(id) {
+    return deleteApiV1AlbumById({ path: { id } });
+  }
+  async searchAlbums(term) {
+    return getApiV1AlbumLookup({ query: { term } });
+  }
+  async getCalendar(start, end, unmonitored) {
+    const query = {};
+    if (start)
+      query.start = start;
+    if (end)
+      query.end = end;
+    if (unmonitored !== undefined)
+      query.unmonitored = unmonitored;
+    return getApiV1Calendar(Object.keys(query).length > 0 ? { query } : {});
+  }
+  async getCalendarFeed(pastDays, futureDays, tags) {
+    const query = {};
+    if (pastDays !== undefined)
+      query.pastDays = pastDays;
+    if (futureDays !== undefined)
+      query.futureDays = futureDays;
+    if (tags)
+      query.tags = tags;
+    return getFeedV1CalendarLidarrIcs(Object.keys(query).length > 0 ? { query } : {});
+  }
+  async getQualityProfiles() {
+    return getApiV1Qualityprofile();
+  }
+  async getQualityProfile(id) {
+    return getApiV1QualityprofileById({ path: { id } });
+  }
+  async addQualityProfile(profile) {
+    return postApiV1Qualityprofile({ body: profile });
+  }
+  async updateQualityProfile(id, profile) {
+    return putApiV1QualityprofileById({ path: { id: String(id) }, body: profile });
+  }
+  async deleteQualityProfile(id) {
+    return deleteApiV1QualityprofileById({ path: { id } });
+  }
+  async getQualityProfileSchema() {
+    return getApiV1QualityprofileSchema();
+  }
+  async getCustomFormats() {
+    return getApiV1Customformat();
+  }
+  async getCustomFormat(id) {
+    return getApiV1CustomformatById({ path: { id } });
+  }
+  async addCustomFormat(format) {
+    return postApiV1Customformat({ body: format });
+  }
+  async updateCustomFormat(id, format) {
+    return putApiV1CustomformatById({ path: { id: String(id) }, body: format });
+  }
+  async deleteCustomFormat(id) {
+    return deleteApiV1CustomformatById({ path: { id } });
+  }
+  async updateCustomFormatsBulk(formats) {
+    return putApiV1CustomformatBulk({ body: formats });
+  }
+  async deleteCustomFormatsBulk(ids) {
+    return deleteApiV1CustomformatBulk({ body: { ids } });
+  }
+  async getCustomFormatSchema() {
+    return getApiV1CustomformatSchema();
+  }
+  updateConfig(newConfig) {
+    const updatedConfig = { ...this.clientConfig.config, ...newConfig };
+    this.clientConfig = createServarrClient(updatedConfig);
+    client.setConfig({
+      baseUrl: this.clientConfig.getBaseUrl(),
+      headers: this.clientConfig.getHeaders()
+    });
+    return this.clientConfig.config;
+  }
+}
+export {
+  LidarrClient
+};