Add pagination support

Author: joshwlewis

package.json

@@ -23,14 +23,14 @@
     "@types/chai": "^4.1.4",
     "@types/mocha": "^5.2.5",
     "@types/nock": "^9.3.0",
-    "@types/node": "^10.7.1",
+    "@types/node": "^20.14.8",
     "@types/node-fetch": "^2.1.2",
     "mocha": "^5",
     "nock": "^9.2.6",
     "nyc": "^11",
     "ts-node": "^6",
     "tslint": "^5.11.0",
-    "typescript": "^2.8"
+    "typescript": "^5.7"
   },
   "dependencies": {
     "node-fetch": "^2.2.0",
@@ -41,5 +41,6 @@
   },
   "files": [
     "/dist"
-  ]
+  ],
+  "packageManager": "[email protected]+sha512.a6b2f7906b721bba3d67d4aff083df04dad64c399707841b7acf00f6b133b7ac24255f2652fa22ae3534329dc6180534e98d17432037ff6fd140556e2bb3137e"
 }

src/buildpack-registry-api.ts

@@ -1,6 +1,6 @@
-import fetch, {Headers, RequestInit, Response} from 'node-fetch'
+import fetch, { Headers, RequestInit, Response } from 'node-fetch'
 
-export {Response} from 'node-fetch'
+export { Response } from 'node-fetch'
 
 export type IBody = {
   [property: string]: string
@@ -85,7 +85,7 @@ export class BuildpackRegistryApi {
   }
 
   headers(options: HeaderOptions = {}): Headers {
-    let defaultHeaders: {[property: string]: string} = {
+    let defaultHeaders: { [property: string]: string } = {
       Accept: 'application/vnd.heroku+json; version=3.buildpack-registry',
       'Content-Type': 'application/json'
     }
@@ -99,7 +99,7 @@ export class BuildpackRegistryApi {
 
     if (process.env.HEROKU_HEADERS) {
       let herokuHeaders = JSON.parse(process.env.HEROKU_HEADERS)
-      return new Headers({...defaultHeaders, herokuHeaders})
+      return new Headers({ ...defaultHeaders, herokuHeaders })
     } else {
       return new Headers(defaultHeaders)
     }
@@ -117,9 +117,9 @@ export class BuildpackRegistryApi {
     return fetch(`${BuildpackRegistryApi.url()}${path}`, options)
   }
 
-  async get(path: string): Promise<Response> {
-    return fetch(`${BuildpackRegistryApi.url()}${path}`, {
-      headers: this.headers()
-    })
+  async get(path: string, headers?: Headers): Promise<Response> {
+    return await fetch(`${BuildpackRegistryApi.url()}${path}`, {
+      headers: headers ? headers : this.headers(),
+    });
   }
 }

src/buildpack-registry.ts

@@ -1,8 +1,10 @@
-import {Result} from 'true-myth'
+import { Result } from 'true-myth'
 
-import {BuildpackBody, BuildpackRegistryApi as Api, Category, HeaderOptions, ReadmeBody, Response, RevisionBody, RevisionStatus} from './buildpack-registry-api'
+import { BuildpackBody, BuildpackRegistryApi as Api, Category, HeaderOptions, ReadmeBody, Response, RevisionBody, RevisionStatus } from './buildpack-registry-api'
 
-export {BuildpackBody, Category, ReadmeBody, RevisionBody, RevisionStatus}
+import { Headers } from 'node-fetch'
+
+export { BuildpackBody, Category, ReadmeBody, RevisionBody, RevisionStatus }
 
 const BUILDPACK_FORMATTING_MESSAGE = "To specify a buildpack, please format it like the following: namespace/name (e.g. heroku/ruby). Also names can only contain letters, numbers, '_', and '-'."
 
@@ -58,15 +60,41 @@ export class BuildpackRegistry {
     }
   }
 
+  async list(path: string): Promise<Result<Array<any>, ResponseError>> {
+    let page = await this.api.get(path);
+    let items = [];
+    if (page.status === 200 || page.status === 206) {
+      items = await page.json();
+    }
+    while (page.status === 206) {
+      let nextRange = page.headers.get('Next-Range')
+      if (typeof nextRange !== "string") {
+        break;
+      }
+      page = await this.api.get(path, new Headers({ 'Accept-Range': nextRange}));
+      if (page.status === 200 || page.status === 206) {
+        items = [...items, ...await page.json()];
+      }
+    }
+    if (page.status !== 200) {
+        return Result.err({
+          status: page.status,
+          path,
+          description: await page.text()
+        });
+    }
+    return Result.ok(items);
+  }
+
   async publish(buildpack: string, ref: string, token: string, secondFactor?: string): Promise<Result<RevisionBody, ResponseError>> {
-    let options: HeaderOptions = {token}
+    let options: HeaderOptions = { token }
     if (secondFactor !== undefined) {
       options.secondFactor = secondFactor
     }
     let path = `/buildpacks/${encodeURIComponent(buildpack)}/revisions`
     let response = await this.api.post(
       path,
-      {ref},
+      { ref },
       this.api.headers(options))
 
     if (response.status === 200) {
@@ -81,7 +109,7 @@ export class BuildpackRegistry {
   }
 
   async rollback(buildpack: string, token: string, secondFactor?: string): Promise<Result<RevisionBody, ResponseError>> {
-    let options: HeaderOptions = {token}
+    let options: HeaderOptions = { token }
     if (secondFactor !== undefined) {
       options.secondFactor = secondFactor
     }
@@ -123,16 +151,7 @@ export class BuildpackRegistry {
     }
 
     let path = `/buildpacks${queryString}`
-    let response = await this.api.get(path)
-    if (response.status === 200) {
-      return Result.ok(await response.json())
-    } else {
-      return Result.err({
-        status: response.status,
-        path,
-        description: await response.text(),
-      })
-    }
+    return this.list(path);
   }
 
   async info(buildpack: string): Promise<Result<InfoData, ResponseError>> {
@@ -189,14 +208,18 @@ export class BuildpackRegistry {
     }
 
     if (readme.content) {
-      data.readme = `\n${Buffer.from(readme.content, readme.encoding).toString()}`
+      let encoding: BufferEncoding = 'utf8';
+      if (readme.encoding && ['ascii', 'utf16le', 'latin1', 'base64', 'base64url'].includes(readme.encoding)) {
+        encoding = readme.encoding as BufferEncoding;
+      }
+      data.readme = `\n${Buffer.from(readme.content, encoding).toString()}`
     }
 
     return Result.ok(data)
   }
 
   async archive(buildpack: string, token: string, secondFactor?: string): Promise<Result<BuildpackBody, ResponseError>> {
-    let options: HeaderOptions = {token}
+    let options: HeaderOptions = { token }
     if (secondFactor !== undefined) {
       options.secondFactor = secondFactor
     }
@@ -233,17 +256,7 @@ export class BuildpackRegistry {
 
   async listVersions(buildpack: string): Promise<Result<RevisionBody[], ResponseError>> {
     let path = `/buildpacks/${encodeURIComponent(buildpack)}/revisions`
-    let response = await this.api.get(path)
-
-    if (response.status === 200) {
-      return Result.ok(await response.json())
-    } else {
-      return Result.err({
-        status: response.status,
-        path,
-        description: await response.text()
-      })
-    }
+    return await this.list(path)
   }
 
   async delay(ms: number) {

yarn.lock

@@ -22,10 +22,17 @@
   dependencies:
     "@types/node" "*"
 
-"@types/node@*", "@types/node@^10.7.1":
+"@types/node@*":
   version "10.7.1"
   resolved "https://registry.yarnpkg.com/@types/node/-/node-10.7.1.tgz#b704d7c259aa40ee052eec678758a68d07132a2e"
 
+"@types/node@^20.14.8":
+  version "20.17.16"
+  resolved "https://registry.yarnpkg.com/@types/node/-/node-20.17.16.tgz#b33b0edc1bf925b27349e494b871ca4451fabab4"
+  integrity sha512-vOTpLduLkZXePLxHiHsBLp98mHGnl8RptV4YAO3HfKO5UHjDvySGbxKtpYfy8Sx5+WKcgc45qNreJJRVM3L6mw==
+  dependencies:
+    undici-types "~6.19.2"
+
 ansi-regex@^2.0.0:
   version "2.1.1"
   resolved "https://registry.yarnpkg.com/ansi-regex/-/ansi-regex-2.1.1.tgz#c3b33ab5ee360d86e0e628f0468ae7ef27d654df"
@@ -1636,14 +1643,20 @@ type-detect@^4.0.0:
   version "4.0.8"
   resolved "https://registry.yarnpkg.com/type-detect/-/type-detect-4.0.8.tgz#7646fb5f18871cfbb7749e69bd39a6388eb7450c"
 
-typescript@^2.8:
-  version "2.9.2"
-  resolved "https://registry.yarnpkg.com/typescript/-/typescript-2.9.2.tgz#1cbf61d05d6b96269244eb6a3bce4bd914e0f00c"
+typescript@^5.7:
+  version "5.7.3"
+  resolved "https://registry.yarnpkg.com/typescript/-/typescript-5.7.3.tgz#919b44a7dbb8583a9b856d162be24a54bf80073e"
+  integrity sha512-84MVSjMEHP+FQRPy3pX9sTVV/INIex71s9TL2Gm5FG/WG1SqXeKyZ0k7/blY/4FdOzI12CBy1vGc4og/eus0fw==
 
 uglify-js@^3.1.4:
   version "3.19.3"
   resolved "https://registry.yarnpkg.com/uglify-js/-/uglify-js-3.19.3.tgz#82315e9bbc6f2b25888858acd1fff8441035b77f"
 
+undici-types@~6.19.2:
+  version "6.19.8"
+  resolved "https://registry.yarnpkg.com/undici-types/-/undici-types-6.19.8.tgz#35111c9d1437ab83a7cdc0abae2f26d88eda0a02"
+  integrity sha512-ve2KP6f/JnbPBFyobGHuerC9g1FYGn/F8n1LWTwNxCEzd6IfqTwUQcNXgEtmmQ6DlRrC1hrSrBnCZPokRrDHjw==
+
 union-value@^1.0.0:
   version "1.0.0"
   resolved "https://registry.yarnpkg.com/union-value/-/union-value-1.0.0.tgz#5c71c34cb5bad5dcebe3ea0cd08207ba5aa1aea4"