@hubspot/local-dev-lib 3.2.0 → 3.3.0-beta.0

package/api/github.d.ts

@@ -1,5 +1,4 @@
 /// <reference types="node" />
-/// <reference types="node" />
 import { GithubReleaseData, GithubRepoFile, RepoPath } from '../types/Github';
 import { HubSpotPromise } from '../types/Http';
 declare global {

package/api/localDevAuth.d.ts

@@ -1,8 +1,9 @@
 import { Environment } from '../types/Config';
-import { ScopeData, AccessTokenResponse, EnabledFeaturesResponse } from '../types/Accounts';
+import { ScopeData, AccessTokenResponse, EnabledFeaturesResponse, ScopeAuthorizationResponse } from '../types/Accounts';
 import { PublicAppInstallationData } from '../types/Apps';
 import { HubSpotPromise } from '../types/Http';
 export declare function fetchAccessToken(personalAccessKey: string, env?: Environment, portalId?: number): HubSpotPromise<AccessTokenResponse>;
 export declare function fetchScopeData(accountId: number, scopeGroup: string): HubSpotPromise<ScopeData>;
+export declare function fetchScopeAuthorizationData(accountId: number): HubSpotPromise<ScopeAuthorizationResponse>;
 export declare function fetchAppInstallationData(portalId: number, projectId: number, appUid: string, requiredScopeGroups: Array<string>, optionalScopeGroups?: Array<string>): HubSpotPromise<PublicAppInstallationData>;
 export declare function fetchEnabledFeatures(accountId: number): Promise<import("axios").AxiosResponse<EnabledFeaturesResponse, any>>;

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.fetchEnabledFeatures = exports.fetchAppInstallationData = exports.fetchScopeData = exports.fetchAccessToken = void 0;
+exports.fetchEnabledFeatures = exports.fetchAppInstallationData = exports.fetchScopeAuthorizationData = exports.fetchScopeData = exports.fetchAccessToken = void 0;
 const getAxiosConfig_1 = require("../http/getAxiosConfig");
 const http_1 = require("../http");
 const environments_1 = require("../constants/environments");
@@ -32,6 +32,12 @@ function fetchScopeData(accountId, scopeGroup) {
     });
 }
 exports.fetchScopeData = fetchScopeData;
+async function fetchScopeAuthorizationData(accountId) {
+    return http_1.http.get(accountId, {
+        url: `${LOCALDEVAUTH_API_AUTH_PATH}/scope-groups/authorized`,
+    });
+}
+exports.fetchScopeAuthorizationData = fetchScopeAuthorizationData;
 function fetchAppInstallationData(portalId, projectId, appUid, requiredScopeGroups, optionalScopeGroups = []) {
     return http_1.http.post(portalId, {
         url: `${LOCALDEVAUTH_API_AUTH_PATH}/install-info`,

package/api/projects.d.ts

@@ -1,5 +1,4 @@
 /// <reference types="node" />
-/// <reference types="node" />
 import { HubSpotPromise, QueryParams } from '../types/Http';
 import { Project, FetchProjectResponse, UploadProjectResponse, ProjectSettings, FetchPlatformVersionResponse, WarnLogsResponse, UploadIRResponse } from '../types/Project';
 import { Build, FetchProjectBuildsResponse } from '../types/Build';

package/lib/archive.d.ts

@@ -1,4 +1,3 @@
 /// <reference types="node" />
-/// <reference types="node" />
 import { CopySourceToDestOptions } from '../types/Archive';
 export declare function extractZipArchive(zip: Buffer, name: string, dest: string, { sourceDir, includesRootDir, hideLogs }?: CopySourceToDestOptions): Promise<boolean>;

package/lib/github.d.ts

@@ -1,5 +1,4 @@
 /// <reference types="node" />
-/// <reference types="node" />
 import { GithubReleaseData, GithubRepoFile, RepoPath, CloneGithubRepoOptions } from '../types/Github';
 export declare function fetchFileFromRepository<T = Buffer>(repoPath: RepoPath, filePath: string, ref: string): Promise<T>;
 export declare function fetchReleaseData(repoPath: RepoPath, tag?: string): Promise<GithubReleaseData>;

package/lib/personalAccessKey.d.ts

@@ -1,4 +1,4 @@
-import { CLIAccount } from '../types/Accounts';
+import { CLIAccount, ScopeGroupAuthorization } from '../types/Accounts';
 import { Environment } from '../types/Config';
 import { AccessToken } from '../types/Accounts';
 export declare function getAccessToken(personalAccessKey: string, env?: Environment, accountId?: number): Promise<AccessToken>;
@@ -7,4 +7,5 @@ export declare function enabledFeaturesForPersonalAccessKey(accountId: number):
     [key: string]: number;
 } | undefined>;
 export declare function scopesOnAccessToken(accountId: number): Promise<Array<string>>;
+export declare function authorizedScopesForPortalAndUser(accountId: number): Promise<Array<ScopeGroupAuthorization>>;
 export declare function updateConfigWithAccessToken(token: AccessToken, personalAccessKey: string, env?: Environment, name?: string, makeDefault?: boolean): Promise<CLIAccount | null>;

package/lib/personalAccessKey.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.updateConfigWithAccessToken = exports.scopesOnAccessToken = exports.enabledFeaturesForPersonalAccessKey = exports.accessTokenForPersonalAccessKey = exports.getAccessToken = void 0;
+exports.updateConfigWithAccessToken = exports.authorizedScopesForPortalAndUser = exports.scopesOnAccessToken = exports.enabledFeaturesForPersonalAccessKey = exports.accessTokenForPersonalAccessKey = exports.getAccessToken = void 0;
 const moment_1 = __importDefault(require("moment"));
 const environments_1 = require("../constants/environments");
 const auth_1 = require("../constants/auth");
@@ -107,6 +107,10 @@ async function scopesOnAccessToken(accountId) {
     return (await getNewAccessTokenByAccountId(accountId)).scopeGroups;
 }
 exports.scopesOnAccessToken = scopesOnAccessToken;
+async function authorizedScopesForPortalAndUser(accountId) {
+    return (await (0, localDevAuth_1.fetchScopeAuthorizationData)(accountId)).data.results;
+}
+exports.authorizedScopesForPortalAndUser = authorizedScopesForPortalAndUser;
 async function updateConfigWithAccessToken(token, personalAccessKey, env, name, makeDefault = false) {
     const { portalId, accessToken, expiresAt, accountType } = token;
     const accountEnv = env || (0, config_1.getEnv)(name);

package/package.json

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

package/types/Accounts.d.ts

@@ -106,6 +106,19 @@ export type ScopeData = {
     portalScopesInGroup: Array<string>;
     userScopesInGroup: Array<string>;
 };
+export type ScopeAuthorizationResponse = {
+    results: Array<ScopeGroupAuthorization>;
+};
+export type ScopeGroupAuthorization = {
+    scopeGroup: ScopeGroup;
+    portalAuthorized: boolean;
+    userAuthorized: boolean;
+};
+export type ScopeGroup = {
+    name: string;
+    shortDescription: string;
+    longDescription: string;
+};
 export type AccessTokenResponse = {
     hubId: number;
     userId: number;

package/types/Http.d.ts

@@ -1,7 +1,6 @@
 /// <reference types="node" />
 /// <reference types="node" />
 /// <reference types="node" />
-/// <reference types="node" />
 import { AxiosPromise, ResponseType } from 'axios';
 import { ReadStream } from 'fs';
 import { Stream } from 'stream';