@hubspot/local-dev-lib 0.1.3-experimental.0 → 0.1.5-experimental.0

package/api/customObjects.d.ts

@@ -1,7 +1,7 @@
 import { FetchSchemasResponse, Schema, CreateObjectsResponse } from '../types/Schemas';
 import { HubSpotPromise } from '../types/Http';
-export declare function batchCreateObjects(accountId: number, objectTypeId: string, objects: JSON): HubSpotPromise<CreateObjectsResponse>;
-export declare function createObjectSchema(accountId: number, schema: JSON): HubSpotPromise<Schema>;
+export declare function batchCreateObjects(accountId: number, objectTypeId: string, objects: Schema): HubSpotPromise<CreateObjectsResponse>;
+export declare function createObjectSchema(accountId: number, schema: Schema): HubSpotPromise<Schema>;
 export declare function updateObjectSchema(accountId: number, schemaObjectType: string, schema: Schema): HubSpotPromise<Schema>;
 export declare function fetchObjectSchema(accountId: number, schemaObjectType: string): HubSpotPromise<Schema>;
 export declare function fetchObjectSchemas(accountId: number): HubSpotPromise<FetchSchemasResponse>;

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/config/index.d.ts

@@ -22,7 +22,7 @@ export declare function updateDefaultAccount(nameOrId: string | number): void;
 export declare function renameAccount(currentName: string, newName: string): Promise<void>;
 export declare function getAccountId(nameOrId?: string | number): number | null;
 export declare function removeSandboxAccountFromConfig(nameOrId: string | number): boolean;
-export declare function deleteAccount(accountName: string): Promise<void>;
+export declare function deleteAccount(accountName: string): Promise<void | boolean>;
 export declare function updateHttpTimeout(timeout: string): void;
 export declare function updateAllowUsageTracking(isEnabled: boolean): void;
 export declare function deleteConfigFile(): void;

package/config/index.js

@@ -145,10 +145,10 @@ function updateDefaultAccount(nameOrId) {
 exports.updateDefaultAccount = updateDefaultAccount;
 async function renameAccount(currentName, newName) {
     if (CLIConfiguration_1.CLIConfiguration.isActive()) {
-        CLIConfiguration_1.CLIConfiguration.renameAccount(currentName, newName);
+        return CLIConfiguration_1.CLIConfiguration.renameAccount(currentName, newName);
     }
     else {
-        config_DEPRECATED.renameAccount(currentName, newName);
+        return config_DEPRECATED.renameAccount(currentName, newName);
     }
 }
 exports.renameAccount = renameAccount;
@@ -168,10 +168,10 @@ function removeSandboxAccountFromConfig(nameOrId) {
 exports.removeSandboxAccountFromConfig = removeSandboxAccountFromConfig;
 async function deleteAccount(accountName) {
     if (CLIConfiguration_1.CLIConfiguration.isActive()) {
-        CLIConfiguration_1.CLIConfiguration.removeAccountFromConfig(accountName);
+        return CLIConfiguration_1.CLIConfiguration.removeAccountFromConfig(accountName);
     }
     else {
-        config_DEPRECATED.deleteAccount(accountName);
+        return config_DEPRECATED.deleteAccount(accountName);
     }
 }
 exports.deleteAccount = deleteAccount;

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": "0.1.3-experimental.0",
+    "version": "0.1.5-experimental.0",
     "description": "Provides library functionality for HubSpot local development tooling, including the HubSpot CLI",
     "main": "lib/index.js",
     "repository": {

package/types/Accounts.d.ts

@@ -92,7 +92,6 @@ export interface FlatAccountFields_NEW extends CLIAccount_NEW {
     scopes?: Array<string>;
     apiKey?: string;
     personalAccessKey?: string;
-    environment?: Environment;
 }
 export interface FlatAccountFields_DEPRECATED extends CLIAccount_DEPRECATED {
     tokenInfo?: TokenInfo;
@@ -101,13 +100,25 @@ export interface FlatAccountFields_DEPRECATED extends CLIAccount_DEPRECATED {
     scopes?: Array<string>;
     apiKey?: string;
     personalAccessKey?: string;
-    environment?: Environment;
 }
 export type FlatAccountFields = FlatAccountFields_NEW | FlatAccountFields_DEPRECATED;
 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;