@hubspot/local-dev-lib 3.10.0-beta.0 → 3.10.0-beta.1

package/errors/index.d.ts

@@ -14,5 +14,6 @@ export declare function isTimeoutError(err: unknown): err is HubSpotHttpError;
 export declare function isAuthError(err: unknown): err is HubSpotHttpError;
 export declare function isValidationError(err: unknown): boolean;
 export declare function isHubSpotHttpError(error?: unknown): error is HubSpotHttpError;
+export declare function isGithubRateLimitError(err: unknown): boolean;
 export declare function isSystemError(err: unknown): err is BaseError;
 export declare function isFileSystemError(err: unknown): err is FileSystemError;

package/errors/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isFileSystemError = exports.isSystemError = exports.isHubSpotHttpError = exports.isValidationError = exports.isAuthError = exports.isTimeoutError = exports.isGatingError = exports.isMissingScopeError = exports.isSpecifiedError = void 0;
+exports.isFileSystemError = exports.isSystemError = exports.isGithubRateLimitError = exports.isHubSpotHttpError = exports.isValidationError = exports.isAuthError = exports.isTimeoutError = exports.isGatingError = exports.isMissingScopeError = exports.isSpecifiedError = void 0;
 const HubSpotHttpError_1 = require("../models/HubSpotHttpError");
 const FileSystemError_1 = require("../models/FileSystemError");
 function isSpecifiedError(err, { statusCode, category, subCategory, errorType, code, }) {
@@ -47,6 +47,15 @@ function isHubSpotHttpError(error) {
     return !!error && error instanceof HubSpotHttpError_1.HubSpotHttpError;
 }
 exports.isHubSpotHttpError = isHubSpotHttpError;
+function isGithubRateLimitError(err) {
+    if (!isHubSpotHttpError(err)) {
+        return false;
+    }
+    return (!!err.headers &&
+        err.headers['x-ratelimit-remaining'] === '0' &&
+        'x-github-request-id' in err.headers);
+}
+exports.isGithubRateLimitError = isGithubRateLimitError;
 function isSystemError(err) {
     return (err instanceof Error &&
         'errno' in err &&

package/lang/en.json

@@ -31,6 +31,7 @@
       }
     },
     "github": {
+      "rateLimitError": "Github rate limit hit. Set the GITHUB_TOKEN env variable with your github PATH. This will increase the github api's rate limit.",
       "fetchFileFromRepository": {
         "fetching": "Fetching {{ path }}...",
         "errors": {

package/lib/github.js

@@ -24,6 +24,7 @@ async function fetchFileFromRepository(repoPath, filePath, ref) {
         return data;
     }
     catch (err) {
+        checkGithubRateLimit(err);
         throw new Error((0, lang_1.i18n)(`${i18nKey}.fetchFileFromRepository.errors.fetchFail`), {
             cause: err,
         });
@@ -43,6 +44,7 @@ async function fetchReleaseData(repoPath, tag) {
         return data;
     }
     catch (err) {
+        checkGithubRateLimit(err);
         throw new Error((0, lang_1.i18n)(`${i18nKey}.fetchReleaseData.errors.fetchFail`, {
             tag: tag || 'latest',
         }), { cause: err });
@@ -72,6 +74,7 @@ async function downloadGithubRepoZip(repoPath, isRelease = false, options = {})
         return data;
     }
     catch (err) {
+        checkGithubRateLimit(err);
         throw new Error((0, lang_1.i18n)(`${i18nKey}.downloadGithubRepoZip.errors.fetchFail`), {
             cause: err,
         });
@@ -147,6 +150,7 @@ async function downloadGithubRepoContents(repoPath, contentPath, dest, ref, filt
         await Promise.all(contentPromises);
     }
     catch (e) {
+        checkGithubRateLimit(e);
         if ((0, errors_1.isSystemError)(e) && e?.error?.message) {
             throw new Error((0, lang_1.i18n)(`${i18nKey}.downloadGithubRepoContents.errors.fetchFail`, {
                 errorMessage: e.error.message,
@@ -166,6 +170,7 @@ async function listGithubRepoContents(repoPath, contentPath, fileFilter) {
         return filteredFiles;
     }
     catch (e) {
+        checkGithubRateLimit(e);
         if ((0, errors_1.isHubSpotHttpError)(e) && e.data.message) {
             throw new Error((0, lang_1.i18n)(`${i18nKey}.downloadGithubRepoContents.errors.fetchFail`, {
                 errorMessage: e.data.message,
@@ -175,3 +180,10 @@ async function listGithubRepoContents(repoPath, contentPath, fileFilter) {
     }
 }
 exports.listGithubRepoContents = listGithubRepoContents;
+function checkGithubRateLimit(err) {
+    if ((0, errors_1.isGithubRateLimitError)(err)) {
+        throw new Error((0, lang_1.i18n)(`${i18nKey}.rateLimitError`), {
+            cause: err,
+        });
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@hubspot/local-dev-lib",
-    "version": "3.10.0-beta.0",
+    "version": "3.10.0-beta.1",
     "description": "Provides library functionality for HubSpot local development tooling, including the HubSpot CLI",
     "repository": {
         "type": "git",