Convenient Pagination API, Browser Support, Missing API fields

models/api.ts

@@ -21,6 +21,29 @@ import { ExportItemIO } from './inventory'
 
 export type EmptyResponse = {}
 
+export const ErrorResponseIO = t.intersection([
+  t.type({
+    message: t.string,
+  }),
+  t.partial({
+    detail: t.array(
+      t.type({
+        loc: t.array(t.string),
+        msg: t.string,
+        type: t.string,
+      }),
+    ),
+  }),
+])
+
+export type ErrorResponse = t.TypeOf<typeof ErrorResponseIO>
+
+export type Pagination = t.TypeOf<typeof PaginationIO>
+
+export interface IPaginated {
+  pagination: Pagination
+}
+
 export type IdentityResponse = t.TypeOf<typeof IdentityIO>
 
 export type UserProfileResponse = t.TypeOf<typeof UserIO>
@@ -57,6 +80,13 @@ export const FoldersResponseIO = t.type({
 })
 export type FoldersResponse = t.TypeOf<typeof FoldersResponseIO>
 
+export const FieldIO = t.type({
+  field_id: t.Integer,
+  value: t.string,
+})
+
+export type Field = t.TypeOf<typeof FieldIO>
+
 /**
  * @internal
  */
@@ -69,6 +99,8 @@ export const FolderReleasesResponseIO = t.type({
       rating: t.Integer,
       date_added: t.string,
       basic_information: ReleaseMinimalInfoIO,
+      folder_id: t.Integer,
+      notes: t.array(FieldIO),
     }),
   ),
 })

models/artist.ts

@@ -23,6 +23,7 @@ const ArtistBaseIO = t.intersection([
   ResourceURLIO,
   t.type({
     id: t.Integer,
+    name: t.string,
     profile: t.string,
     data_quality: makeEnumIOType(DataQualityEnum),
     releases_url: t.string,

models/marketplace.ts

@@ -5,7 +5,7 @@ import { makeEnumIOType } from './helpers'
 import {
   CurrenciesEnum,
   EditOrderStatusesEnum,
-  ListingStatusesEnum,
+  InventoryStatusesEnum,
   OrderMessageTypesEnum,
   ReleaseConditionsEnum,
   SleeveConditionsEnum,
@@ -70,7 +70,7 @@ export const ListingIO = t.intersection([
   ResourceURLIO,
   t.type({
     id: t.Integer,
-    status: makeEnumIOType(ListingStatusesEnum),
+    status: makeEnumIOType(InventoryStatusesEnum),
     release: t.intersection([
       ResourceURLIO,
       t.type({
@@ -113,9 +113,20 @@ export const ListingIO = t.intersection([
     audio: t.boolean,
     uri: t.string,
   }),
+  // If the user is authorized, the listing will contain a in_cart boolean field indicating whether or not this listing is in their cart.
   t.partial({
     in_cart: t.boolean,
   }),
+  // If the authorized user is the listing owner the listing will include the weight, format_quantity, external_id, and location keys.
+  t.intersection([
+    t.type({
+      weight: t.number,
+      format_quantity: t.number,
+      external_id: t.string,
+      location: t.string,
+    }),
+    t.type({}),
+  ]),
 ])
 
 /**

models/master.ts

@@ -28,6 +28,9 @@ export const MasterIO = t.intersection([
     videos: t.array(VideoIO),
     uri: t.string,
   }),
+  t.partial({
+    notes: t.string,
+  }),
 ])
 
 export type Master = t.TypeOf<typeof MasterIO>

models/release.ts

@@ -50,10 +50,15 @@ export const ReleaseArtistIO = t.intersection([
 /**
  * @internal
  */
-const ReleaseFormatIO = t.type({
+const ReleaseFormatIOConcrete = t.type({
   name: t.string,
   qty: t.string,
 })
+const ReleaseFormatIOOptional = t.partial({
+  text: t.string,
+  descriptions: t.array(t.string),
+})
+const ReleaseFormatIO = t.intersection([ReleaseFormatIOConcrete, ReleaseFormatIOOptional])
 
 /**
  * @internal
@@ -67,6 +72,9 @@ const ReleaseEntityIO = t.intersection([
     entity_type_name: t.string,
     catno: t.string,
   }),
+  t.partial({
+    thumbnail_url: t.string,
+  }),
 ])
 
 /**
@@ -80,12 +88,17 @@ const ReleaseIdentifierIO = t.type({
 /**
  * @internal
  */
-export const TrackIO = t.type({
-  type_: t.string,
-  title: t.string,
-  position: t.string,
-  duration: t.string,
-})
+export const TrackIO = t.intersection([
+  t.type({
+    type_: t.string,
+    title: t.string,
+    position: t.string,
+    duration: t.string,
+  }),
+  t.partial({
+    artists: t.array(ReleaseArtistIO),
+  }),
+])
 
 /**
  * @internal

models/user.ts

@@ -62,6 +62,7 @@ export const UserIO = t.intersection([
     username: t.string,
     name: t.string,
     profile: t.string,
+    avatar_url: t.string,
     home_page: t.string,
     location: t.string,
     registered: t.string,

package.json

@@ -1,6 +1,6 @@
 {
   "name": "discojs",
-  "version": "2.2.0",
+  "version": "2.3.0",
   "description": "Easiest way to use the Discogs API in Javascript/Typescript",
   "author": "aknorw",
   "license": "MIT",
@@ -17,14 +17,15 @@
   "types": "./lib/index.d.ts",
   "scripts": {
     "clean": "rimraf lib",
-    "pretty": "prettier --config .prettierrc --write '{models,src}/**/*.{ts,json}'",
+    "pretty": "prettier --config .prettierrc --write \"{models,src}/**/*.{ts,json}\"",
     "lint": "eslint --ext .ts,.json models/ src/",
     "test:spec": "cross-env NODE_ENV=test jest --testMatch='**/*.spec.ts'",
     "test:e2e": "cross-env NODE_ENV=test jest --testMatch='**/*.e2e.ts' --runInBand",
     "test": "yarn build && yarn test:spec && yarn test:e2e",
     "docs": "typedoc --inputFiles src/index.ts --exclude \"**/*+(.spec).ts\" --excludeNotExported --excludePrivate --stripInternal",
     "prebuild": "yarn run clean",
     "build": "cross-env NODE_ENV=production rollup -c",
+    "build-dev": "cross-env NODE_ENV=development rollup -c",
     "prepare": "husky install"
   },
   "repository": {

src/allNext.ts

@@ -0,0 +1,48 @@
+import { IPaginated } from '../models/api'
+import type { Discojs } from './discojs'
+
+export class AllNext {
+  /**
+   * @internal
+   *
+   * Gets the next page of a paginated result
+   */
+  next<TResponse extends IPaginated>(this: Discojs, response: TResponse) {
+    const { next } = response.pagination.urls
+    if (next === undefined) {
+      return Promise.resolve(undefined)
+    }
+    return this.fetcher.schedule<TResponse>(next)
+  }
+
+  /**
+   * Retrieve all resources from a paginated endpoint.
+   * @param this
+   * @param key the name of the field in `TResponse` you wish to aggregate
+   * @param response the starting page for the paginated response
+   * @param onProgress optional callback to invoke as each page is retrieved
+   * @typeparam TKey the name of the field in `TResponse` you wish to aggregate (inferred from `key`)
+   * @typeparam TResultElement the type of record (inferred from `key` and `response`)
+   * @typeparam TResponse the type of the response (inferred from `response`)
+   * @returns an array containing all elements from the different pages concatenated together
+   */
+  async all<TKey extends string, TResultElement, TResponse extends IPaginated & { [K in TKey]: TResultElement[] }>(
+    this: Discojs,
+    key: TKey,
+    response: TResponse | undefined,
+    onProgress?: (data: TResultElement[]) => void,
+  ) {
+    let result: TResultElement[] = []
+    while (response !== undefined) {
+      const data = response[key]
+      onProgress?.(data)
+      result = result.concat(data)
+      // eslint-disable-next-line no-await-in-loop, no-param-reassign
+      response = await this.next(response)
+      if (response === undefined) {
+        break
+      }
+    }
+    return result
+  }
+}

src/discojs.ts

@@ -1,6 +1,7 @@
 import { CurrenciesEnum, ReleaseConditionsEnum, SleeveConditionsEnum } from './enums'
 import { applyMixins, FetcherOptions, Fetcher, OutputFormat } from './utils'
 
+import { AllNext } from './allNext'
 import { Database } from './database'
 import { MarketPlace } from './marketplace'
 import { InventoryExport } from './inventoryExport'
@@ -19,6 +20,7 @@ export interface Discojs
     UserLists,
     Database,
     MarketPlace,
+    AllNext,
     InventoryExport,
     InventoryUpload {}
 
@@ -88,6 +90,7 @@ applyMixins(Discojs, [
   UserLists,
   Database,
   MarketPlace,
+  AllNext,
   InventoryExport,
   InventoryUpload,
 ])

src/index.ts

@@ -1,4 +1,5 @@
 export * from './discojs'
 export * from './enums'
 export * from './errors'
-export { SortOrdersEnum } from './utils'
+export { ResultCache, SortOrdersEnum } from './utils'
+export { IPaginated, Pagination } from '../models/api'

src/userCollection.ts

@@ -332,8 +332,9 @@ export class UserCollection {
     const username = await this.getUsername()
     return this.fetcher.schedule<EmptyResponse>(
       `/users/${username}/collection/folders/${folderId}/releases/${releaseId}/instances/${instanceId}/fields/${fieldId}`,
-      { value },
+      undefined,
       HTTPVerbsEnum.POST,
+      { value },
     )
   }