@hubspot/local-dev-lib 1.0.0 → 1.1.0

package/api/appsDev.d.ts

@@ -0,0 +1,2 @@
+import { PublicApp } from '../types/Apps';
+export declare function fetchPublicAppsForPortal(accountId: number): Promise<Array<PublicApp>>;

package/api/appsDev.js

@@ -0,0 +1,15 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fetchPublicAppsForPortal = void 0;
+const http_1 = __importDefault(require("../http"));
+const APPS_DEV_API_PATH = 'apps-dev/external/public/v3';
+async function fetchPublicAppsForPortal(accountId) {
+    const resp = await http_1.default.get(accountId, {
+        url: `${APPS_DEV_API_PATH}/full/portal`,
+    });
+    return resp ? resp.results : [];
+}
+exports.fetchPublicAppsForPortal = fetchPublicAppsForPortal;

package/api/localDevAuth.d.ts

@@ -2,6 +2,7 @@ import { Environment } from '../types/Config';
 import { ScopeData } from '../types/Accounts';
 import { HUBSPOT_ACCOUNT_TYPES } from '../constants/config';
 import { ValueOf } from '../types/Utils';
+import { PublicAppInstallationData } from '../types/Apps';
 type AccessTokenResponse = {
     hubId: number;
     userId: number;
@@ -17,4 +18,5 @@ type AccessTokenResponse = {
 };
 export declare function fetchAccessToken(personalAccessKey: string, env?: Environment, portalId?: number): Promise<AccessTokenResponse>;
 export declare function fetchScopeData(accountId: number, scopeGroup: string): Promise<ScopeData>;
+export declare function fetchAppInstallationData(portalId: number, projectId: number, appUid: string, requiredScopeGroups: Array<string>, optionalScopeGroups?: Array<string>): Promise<PublicAppInstallationData>;
 export {};

package/api/localDevAuth.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.fetchScopeData = exports.fetchAccessToken = void 0;
+exports.fetchAppInstallationData = exports.fetchScopeData = exports.fetchAccessToken = void 0;
 const getAxiosConfig_1 = require("../http/getAxiosConfig");
 const http_1 = __importDefault(require("../http"));
 const environments_1 = require("../constants/environments");
@@ -28,8 +28,21 @@ async function fetchAccessToken(personalAccessKey, env = environments_1.ENVIRONM
 exports.fetchAccessToken = fetchAccessToken;
 async function fetchScopeData(accountId, scopeGroup) {
     return http_1.default.get(accountId, {
-        url: `localdevauth/v1/auth/check-scopes`,
+        url: `${LOCALDEVAUTH_API_AUTH_PATH}/check-scopes`,
         params: { scopeGroup },
     });
 }
 exports.fetchScopeData = fetchScopeData;
+async function fetchAppInstallationData(portalId, projectId, appUid, requiredScopeGroups, optionalScopeGroups = []) {
+    return http_1.default.post(portalId, {
+        url: `${LOCALDEVAUTH_API_AUTH_PATH}/install-info`,
+        data: {
+            portalId,
+            projectId,
+            sourceId: appUid,
+            requiredScopeGroups,
+            optionalScopeGroups,
+        },
+    });
+}
+exports.fetchAppInstallationData = fetchAppInstallationData;

package/errors/apiErrors.js

@@ -83,7 +83,7 @@ function throwValidationError(error) {
 function getAxiosErrorWithContext(
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 error, context = {}) {
-    const { status } = error;
+    const status = error.response?.status;
     const method = error.config?.method;
     const { projectName } = context;
     let messageDetail;
@@ -106,8 +106,8 @@ error, context = {}) {
     if ((method === 'put' || method === 'post') && context.payload) {
         errorMessage.push((0, lang_1.i18n)(`${i18nKey}.unableToUpload`, { payload: context.payload }));
     }
-    const isProjectMissingScopeError = isMissingScopeError(error) && projectName;
-    const isProjectGatingError = isGatingError(error) && projectName;
+    const isProjectMissingScopeError = isMissingScopeError(error) && !!projectName;
+    const isProjectGatingError = isGatingError(error) && !!projectName;
     switch (status) {
         case 400:
             errorMessage.push((0, lang_1.i18n)(`${i18nKey}.codes.400`, { messageDetail }));

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@hubspot/local-dev-lib",
-    "version": "1.0.0",
+    "version": "1.1.0",
     "description": "Provides library functionality for HubSpot local development tooling, including the HubSpot CLI",
     "main": "lib/index.js",
     "repository": {

package/types/Apps.d.ts

@@ -0,0 +1,42 @@
+export type PublicAppInstallationData = {
+    appId: number;
+    isInstalledWithScopeGroups: boolean;
+    previouslyAuthorizedScopeGroups: Array<{
+        id: number;
+        name: string;
+    }>;
+};
+export type PublicApp = {
+    id: number;
+    name: string;
+    description: string;
+    portalId: number;
+    updatedAt: number;
+    createdAt: number;
+    clientId: string;
+    iconUrl: string;
+    archived: boolean;
+    ownerId: number;
+    isUserLevel: boolean;
+    isBusinessUnitEnabled: boolean;
+    isFeatured: boolean;
+    isInternal: boolean;
+    documentationUrl: string | null;
+    supportUrl: string | null;
+    supportEmail: string | null;
+    supportPhone: string | null;
+    extensionIconUrl: string | null;
+    isAdvancedScopesSettingEnabled: boolean;
+    publicApplicationInstallCounts: {
+        uniquePortalInstallCount: number;
+        uniqueUserInstallCount: number;
+        uniqueBusinessUnitInstallCount: number;
+    };
+    redirectUrls: Array<string>;
+    scopeGroupIds: Array<number>;
+    additionalScopeGroupIds: Array<number>;
+    optionalScopeGroupIds: Array<number>;
+    projectId: number | null;
+    sourceId: string | null;
+    allowedExternalUrls: Array<string>;
+};

package/types/Apps.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });