sound-tank 1.0.0

package/.env.example

@@ -0,0 +1,2 @@
+REVERB_API_KEY=1234567890
+REVERB_POST_KEY=1234567890

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Zachary Eggert
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,19 @@
+# Library Template
+
+This is a template for a typescript library.
+
+## Usage
+
+- Use this template to create a new repository
+- Clone the repository
+- Run `yarn install`
+- Add a NPM token to your github environment variables as "NPM_TOKEN"
+- Delete this README.md and replace it with your own
+- Update the package.json with your own information
+- Update the LICENSE file with your own information
+
+## Links
+
+- [Github](https://github.com/ZacharyEggert/library-template)
+
+- [NPM](https://www.npmjs.com/package/@zacharyeggert/library-template)

package/dist/index.d.ts

@@ -0,0 +1,173 @@
+import * as axios from 'axios';
+import { Axios } from 'axios';
+
+type Link = {
+    href: string;
+    method?: 'PUT' | 'POST' | 'GET' | Exclude<string, 'PUT' | 'POST' | 'GET'>;
+};
+type ShippingRate = {
+    region_code: string;
+    rate: Price;
+    carrier_calculated: boolean;
+    regional: boolean;
+    destination_postal_code_needed: boolean;
+};
+type ListingStateSlug = 'sold' | 'live' | Exclude<string, 'sold' | 'live'>;
+type ListingState = {
+    slug: ListingStateSlug;
+    description: string;
+};
+type ListingStats = {
+    views: number;
+    watches: number;
+};
+type ConditionDisplayName = 'Excellent' | 'New' | 'B-Stock' | 'Very Good' | 'Good' | 'Fair' | 'Poor' | Exclude<string, 'Excellent' | 'New' | 'B-Stock' | 'Very Good' | 'Good' | 'Fair' | 'Poor'>;
+type ListingCondition = {
+    uuid: string;
+    displayName: ConditionDisplayName;
+};
+type ListingShipping = {
+    local: boolean;
+    rates: ShippingRate[];
+    user_region_rate: ShippingRate;
+    initial_offer_rate: ShippingRate;
+};
+type ListingLinks = {
+    photo: Link;
+    self: Link;
+    update: Link;
+    end: Link;
+    want: Link;
+    unwant: Link;
+    edit: Link;
+    web: Link;
+    make_offer: Link;
+    cart: Link;
+};
+type Category = {
+    uuid: string;
+    full_name: string;
+};
+type CurrencyCode = string;
+type CurrencySymbol = '$' | Exclude<string, '$'>;
+type Price = {
+    amount: `${number}.${number}` | `${number}`;
+    amount_cents: number;
+    currency: CurrencyCode;
+    symbol: CurrencySymbol;
+    display: string;
+    tax_included_hint?: string;
+    tax_included?: boolean;
+    tax_included_rate?: number;
+};
+type PhotoLinks = {
+    large_crop: Link;
+    small_crop: Link;
+    full: Link;
+    thumbnail: Link;
+};
+type Listing = {
+    id: number | string;
+    make: string;
+    model: string;
+    finish: string;
+    year: string;
+    title: string;
+    created_at: ReturnType<typeof Date.toString>;
+    shop_name: string;
+    description: string;
+    condition: ListingCondition;
+    price: Price;
+    inventory: number;
+    has_inventory: boolean;
+    offers_enabled: boolean;
+    auction: boolean;
+    categories: Category[];
+    listing_currency: string;
+    published_at: ReturnType<typeof Date.toString>;
+    buyer_price: Price;
+    seller_price: Price;
+    state: ListingState;
+    shipping_profile_id: number;
+    shipping: ListingShipping;
+    stats: ListingStats;
+    slug: string;
+    photos: {
+        _links: PhotoLinks;
+    }[];
+    _links: ListingLinks;
+};
+
+interface GetMyListingsOptions {
+    page?: number;
+    perPage?: number;
+    query?: string;
+    sku?: string;
+    state?: string;
+}
+
+type PaginatedReverbResponse<T> = T & {
+    total: number;
+    current_page: number;
+    total_pages: number;
+    _links: {
+        next?: Link;
+        prev?: Link;
+    };
+};
+
+type ApiVersion = string;
+type ApiKey = string;
+type Locale = string;
+type ShippingRegion = string;
+type DisplayCurrency = string;
+type RootEndpoint = Domain;
+type Domain = `${string}.${string}` | `${string}.${string}.${string}`;
+interface ReverbOptions {
+    apiKey: ApiKey;
+    version?: ApiVersion | undefined;
+    rootEndpoint?: RootEndpoint | undefined;
+    displayCurrency?: DisplayCurrency | undefined;
+    shippingRegion?: ShippingRegion | undefined;
+    locale?: Locale | undefined;
+}
+type ReverbHeaders = Axios['get']['arguments'][1] & {
+    'Content-Type': string;
+    'Accept-Version': ApiVersion;
+    Accept: string;
+    'Accept-Language': Locale;
+    'X-Display-Currency': DisplayCurrency;
+    'X-Shipping-Region'?: ShippingRegion | undefined;
+    'User-Agent'?: string;
+};
+interface AuthReverbHeaders extends ReverbHeaders {
+    Authorization: `Bearer ${ApiKey}`;
+}
+declare class Reverb {
+    static defaultHeaders: ReverbHeaders;
+    private _rootEndpoint;
+    private _version;
+    private apiKey;
+    private _headers;
+    private _displayCurrency;
+    private _shippingRegion;
+    private _locale;
+    constructor(options: ReverbOptions);
+    private updateHeaders;
+    set locale(locale: Locale);
+    get locale(): Locale;
+    set shippingRegion(shippingRegion: ShippingRegion | undefined);
+    get shippingRegion(): ShippingRegion | undefined;
+    get headers(): AuthReverbHeaders;
+    set displayCurrency(displayCurrency: DisplayCurrency);
+    get displayCurrency(): DisplayCurrency;
+    set version(version: ApiVersion);
+    get version(): ApiVersion;
+    set rootEndpoint(rootEndpoint: RootEndpoint);
+    get rootEndpoint(): RootEndpoint;
+    getMyListings(options?: GetMyListingsOptions): Promise<axios.AxiosResponse<PaginatedReverbResponse<{
+        listings: Listing[];
+    }>, any>>;
+}
+
+export { ApiKey, ApiVersion, AuthReverbHeaders, DisplayCurrency, Locale, ReverbHeaders, ReverbOptions, RootEndpoint, ShippingRegion, Reverb as default };

package/dist/index.js

@@ -0,0 +1,201 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __defProps = Object.defineProperties;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropDescs = Object.getOwnPropertyDescriptors;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getOwnPropSymbols = Object.getOwnPropertySymbols;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __propIsEnum = Object.prototype.propertyIsEnumerable;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __spreadValues = (a, b) => {
+  for (var prop in b || (b = {}))
+    if (__hasOwnProp.call(b, prop))
+      __defNormalProp(a, prop, b[prop]);
+  if (__getOwnPropSymbols)
+    for (var prop of __getOwnPropSymbols(b)) {
+      if (__propIsEnum.call(b, prop))
+        __defNormalProp(a, prop, b[prop]);
+    }
+  return a;
+};
+var __spreadProps = (a, b) => __defProps(a, __getOwnPropDescs(b));
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var __async = (__this, __arguments, generator) => {
+  return new Promise((resolve, reject) => {
+    var fulfilled = (value) => {
+      try {
+        step(generator.next(value));
+      } catch (e) {
+        reject(e);
+      }
+    };
+    var rejected = (value) => {
+      try {
+        step(generator.throw(value));
+      } catch (e) {
+        reject(e);
+      }
+    };
+    var step = (x) => x.done ? resolve(x.value) : Promise.resolve(x.value).then(fulfilled, rejected);
+    step((generator = generator.apply(__this, __arguments)).next());
+  });
+};
+
+// src/index.ts
+var src_exports = {};
+__export(src_exports, {
+  default: () => src_default
+});
+module.exports = __toCommonJS(src_exports);
+
+// src/methods/listings/getListings.ts
+var import_axios = __toESM(require("axios"));
+var getMyListings = (reverb, options) => __async(void 0, null, function* () {
+  const { page, perPage, query, sku, state } = options;
+  const baseUrl = `${reverb.rootEndpoint}/my/listings`;
+  const pageString = page ? `&page=${page}` : "";
+  const perPageString = perPage ? `&per_page=${perPage}` : "";
+  const queryString = query ? `&query=${query}` : "";
+  const skuString = sku ? `&sku=${sku}` : "";
+  const stateString = state ? `&state=${state}` : "";
+  const url = `${baseUrl}?${pageString}${perPageString}${queryString}${skuString}${stateString}`;
+  const response = yield import_axios.default.get(url, {
+    headers: reverb.headers
+  });
+  return response;
+});
+
+// src/methods/index.ts
+var import_axios2 = __toESM(require("axios"));
+
+// src/Reverb.ts
+var _Reverb = class {
+  constructor(options) {
+    this._rootEndpoint = "https://api.reverb.com/api";
+    this._version = _Reverb.defaultHeaders["Accept-Version"];
+    this._displayCurrency = _Reverb.defaultHeaders["X-Display-Currency"];
+    this._locale = _Reverb.defaultHeaders["Accept-Language"];
+    const {
+      apiKey,
+      version,
+      rootEndpoint: defaultEndpoint,
+      displayCurrency,
+      shippingRegion,
+      locale
+    } = options;
+    if (!apiKey || apiKey === "") {
+      throw new Error("Reverb: apiKey is required");
+    }
+    if (version) {
+      this._version = version;
+    }
+    if (defaultEndpoint) {
+      this._rootEndpoint = defaultEndpoint;
+    }
+    if (displayCurrency) {
+      this._displayCurrency = displayCurrency;
+    }
+    if (shippingRegion) {
+      this._shippingRegion = shippingRegion;
+    }
+    if (locale) {
+      this._locale = locale;
+    }
+    this.apiKey = apiKey;
+    this._headers = __spreadProps(__spreadValues({}, _Reverb.defaultHeaders), {
+      Authorization: `Bearer ${this.apiKey}`
+    });
+    this.updateHeaders();
+  }
+  updateHeaders() {
+    const optionalHeaders = {};
+    if (this._shippingRegion)
+      optionalHeaders["X-Shipping-Region"] = this._shippingRegion;
+    this._headers = __spreadValues(__spreadProps(__spreadValues({}, this._headers), {
+      Authorization: `Bearer ${this.apiKey}`,
+      "Accept-Version": this._version,
+      "X-Display-Currency": this._displayCurrency,
+      "Accept-Language": this._locale
+    }), optionalHeaders);
+  }
+  set locale(locale) {
+    this._locale = locale;
+    this.updateHeaders();
+  }
+  get locale() {
+    return this._locale;
+  }
+  set shippingRegion(shippingRegion) {
+    this._shippingRegion = shippingRegion;
+    this.updateHeaders();
+  }
+  get shippingRegion() {
+    return this._shippingRegion;
+  }
+  get headers() {
+    return this._headers;
+  }
+  set displayCurrency(displayCurrency) {
+    this._displayCurrency = displayCurrency;
+    this.updateHeaders();
+  }
+  get displayCurrency() {
+    return this._displayCurrency;
+  }
+  set version(version) {
+    this._version = version;
+    this.updateHeaders();
+  }
+  get version() {
+    return this._version;
+  }
+  set rootEndpoint(rootEndpoint) {
+    this._rootEndpoint = rootEndpoint;
+  }
+  get rootEndpoint() {
+    return this._rootEndpoint;
+  }
+  getMyListings(options) {
+    return __async(this, null, function* () {
+      return yield getMyListings(this, options != null ? options : {});
+    });
+  }
+};
+var Reverb = _Reverb;
+Reverb.defaultHeaders = {
+  "Content-Type": "application/hal+json",
+  "Accept-Version": "3.0",
+  Accept: "application/hal+json",
+  "Accept-Language": "en",
+  "X-Display-Currency": "USD",
+  // 'X-Shipping-Region': undefined
+  "User-Agent": "Reverb Node SDK"
+};
+
+// src/index.ts
+var src_default = Reverb;
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {});

package/dist/index.mjs

@@ -0,0 +1,169 @@
+var __defProp = Object.defineProperty;
+var __defProps = Object.defineProperties;
+var __getOwnPropDescs = Object.getOwnPropertyDescriptors;
+var __getOwnPropSymbols = Object.getOwnPropertySymbols;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __propIsEnum = Object.prototype.propertyIsEnumerable;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __spreadValues = (a, b) => {
+  for (var prop in b || (b = {}))
+    if (__hasOwnProp.call(b, prop))
+      __defNormalProp(a, prop, b[prop]);
+  if (__getOwnPropSymbols)
+    for (var prop of __getOwnPropSymbols(b)) {
+      if (__propIsEnum.call(b, prop))
+        __defNormalProp(a, prop, b[prop]);
+    }
+  return a;
+};
+var __spreadProps = (a, b) => __defProps(a, __getOwnPropDescs(b));
+var __async = (__this, __arguments, generator) => {
+  return new Promise((resolve, reject) => {
+    var fulfilled = (value) => {
+      try {
+        step(generator.next(value));
+      } catch (e) {
+        reject(e);
+      }
+    };
+    var rejected = (value) => {
+      try {
+        step(generator.throw(value));
+      } catch (e) {
+        reject(e);
+      }
+    };
+    var step = (x) => x.done ? resolve(x.value) : Promise.resolve(x.value).then(fulfilled, rejected);
+    step((generator = generator.apply(__this, __arguments)).next());
+  });
+};
+
+// src/methods/listings/getListings.ts
+import axios from "axios";
+var getMyListings = (reverb, options) => __async(void 0, null, function* () {
+  const { page, perPage, query, sku, state } = options;
+  const baseUrl = `${reverb.rootEndpoint}/my/listings`;
+  const pageString = page ? `&page=${page}` : "";
+  const perPageString = perPage ? `&per_page=${perPage}` : "";
+  const queryString = query ? `&query=${query}` : "";
+  const skuString = sku ? `&sku=${sku}` : "";
+  const stateString = state ? `&state=${state}` : "";
+  const url = `${baseUrl}?${pageString}${perPageString}${queryString}${skuString}${stateString}`;
+  const response = yield axios.get(url, {
+    headers: reverb.headers
+  });
+  return response;
+});
+
+// src/methods/index.ts
+import axios2 from "axios";
+
+// src/Reverb.ts
+var _Reverb = class {
+  constructor(options) {
+    this._rootEndpoint = "https://api.reverb.com/api";
+    this._version = _Reverb.defaultHeaders["Accept-Version"];
+    this._displayCurrency = _Reverb.defaultHeaders["X-Display-Currency"];
+    this._locale = _Reverb.defaultHeaders["Accept-Language"];
+    const {
+      apiKey,
+      version,
+      rootEndpoint: defaultEndpoint,
+      displayCurrency,
+      shippingRegion,
+      locale
+    } = options;
+    if (!apiKey || apiKey === "") {
+      throw new Error("Reverb: apiKey is required");
+    }
+    if (version) {
+      this._version = version;
+    }
+    if (defaultEndpoint) {
+      this._rootEndpoint = defaultEndpoint;
+    }
+    if (displayCurrency) {
+      this._displayCurrency = displayCurrency;
+    }
+    if (shippingRegion) {
+      this._shippingRegion = shippingRegion;
+    }
+    if (locale) {
+      this._locale = locale;
+    }
+    this.apiKey = apiKey;
+    this._headers = __spreadProps(__spreadValues({}, _Reverb.defaultHeaders), {
+      Authorization: `Bearer ${this.apiKey}`
+    });
+    this.updateHeaders();
+  }
+  updateHeaders() {
+    const optionalHeaders = {};
+    if (this._shippingRegion)
+      optionalHeaders["X-Shipping-Region"] = this._shippingRegion;
+    this._headers = __spreadValues(__spreadProps(__spreadValues({}, this._headers), {
+      Authorization: `Bearer ${this.apiKey}`,
+      "Accept-Version": this._version,
+      "X-Display-Currency": this._displayCurrency,
+      "Accept-Language": this._locale
+    }), optionalHeaders);
+  }
+  set locale(locale) {
+    this._locale = locale;
+    this.updateHeaders();
+  }
+  get locale() {
+    return this._locale;
+  }
+  set shippingRegion(shippingRegion) {
+    this._shippingRegion = shippingRegion;
+    this.updateHeaders();
+  }
+  get shippingRegion() {
+    return this._shippingRegion;
+  }
+  get headers() {
+    return this._headers;
+  }
+  set displayCurrency(displayCurrency) {
+    this._displayCurrency = displayCurrency;
+    this.updateHeaders();
+  }
+  get displayCurrency() {
+    return this._displayCurrency;
+  }
+  set version(version) {
+    this._version = version;
+    this.updateHeaders();
+  }
+  get version() {
+    return this._version;
+  }
+  set rootEndpoint(rootEndpoint) {
+    this._rootEndpoint = rootEndpoint;
+  }
+  get rootEndpoint() {
+    return this._rootEndpoint;
+  }
+  getMyListings(options) {
+    return __async(this, null, function* () {
+      return yield getMyListings(this, options != null ? options : {});
+    });
+  }
+};
+var Reverb = _Reverb;
+Reverb.defaultHeaders = {
+  "Content-Type": "application/hal+json",
+  "Accept-Version": "3.0",
+  Accept: "application/hal+json",
+  "Accept-Language": "en",
+  "X-Display-Currency": "USD",
+  // 'X-Shipping-Region': undefined
+  "User-Agent": "Reverb Node SDK"
+};
+
+// src/index.ts
+var src_default = Reverb;
+export {
+  src_default as default
+};

package/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "sound-tank",
+  "version": "1.0.0",
+  "description": "A library for interacting with the Reverb Marketplace API",
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "private": false,
+  "types": "dist/index.d.ts",
+  "author": "Zachary Eggert <Eggert.Zachary@gmail.com>",
+  "license": "MIT",
+  "scripts": {
+    "dev": "vitest",
+    "test": "vitest run",
+    "build": "tsup src/index.ts --dts --format cjs,esm",
+    "lint": "tsc",
+    "ci": "yarn install --frozen-lockfile && yarn lint && yarn test && yarn build",
+    "release": "yarn lint && yarn test && yarn build && changeset publish"
+  },
+  "devDependencies": {
+    "@changesets/cli": "^2.26.1",
+    "@types/node": "^20.2.1",
+    "@vitest/coverage-c8": "^0.31.1",
+    "dotenv": "^16.0.3",
+    "prettier": "^2.8.8",
+    "tsup": "^6.7.0",
+    "typescript": "^5.0.4",
+    "vitest": "^0.31.1"
+  },
+  "dependencies": {
+    "axios": "^1.4.0"
+  }
+}