@hubspot/local-dev-lib 3.13.1 → 3.14.0-beta.0

package/api/sandboxHubs.d.ts

@@ -1,8 +1,10 @@
 import { AxiosPromise } from 'axios';
 import { Environment } from '../types/Config';
-import { SandboxHubData, SandboxResponse, SandboxUsageLimitsResponse } from '../types/Sandbox';
+import { SandboxPersonalAccessKey, SandboxHubData, SandboxResponse, SandboxUsageLimitsResponse, V2Sandbox } from '../types/Sandbox';
 import { HubSpotPromise } from '../types/Http';
 export declare function createSandbox(accountId: number, name: string, type: 1 | 2): HubSpotPromise<SandboxResponse>;
 export declare function deleteSandbox(parentAccountId: number, sandboxAccountId: number): HubSpotPromise<void>;
 export declare function getSandboxUsageLimits(parentAccountId: number): HubSpotPromise<SandboxUsageLimitsResponse>;
 export declare function fetchSandboxHubData(accessToken: string, accountId: number, env?: Environment): AxiosPromise<SandboxHubData>;
+export declare function createV2Sandbox(accountId: number, name: string, type: 'STANDARD' | 'DEVELOPER', syncObjectRecords: boolean): HubSpotPromise<V2Sandbox>;
+export declare function getSandboxPersonalAccessKey(accountId: number, sandboxId: number): HubSpotPromise<SandboxPersonalAccessKey>;

package/api/sandboxHubs.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.fetchSandboxHubData = exports.getSandboxUsageLimits = exports.deleteSandbox = exports.createSandbox = void 0;
+exports.getSandboxPersonalAccessKey = exports.createV2Sandbox = exports.fetchSandboxHubData = exports.getSandboxUsageLimits = exports.deleteSandbox = exports.createSandbox = void 0;
 const axios_1 = __importDefault(require("axios"));
 const http_1 = require("../http");
 const getAxiosConfig_1 = require("../http/getAxiosConfig");
@@ -47,3 +47,20 @@ function fetchSandboxHubData(accessToken, accountId, env = environments_1.ENVIRO
     return (0, axios_1.default)(reqWithToken);
 }
 exports.fetchSandboxHubData = fetchSandboxHubData;
+function createV2Sandbox(accountId, name, type, syncObjectRecords) {
+    return http_1.http.post(accountId, {
+        url: `${SANDBOX_API_PATH_V2}/sandboxes`,
+        data: { name, type, syncObjectRecords },
+    });
+}
+exports.createV2Sandbox = createV2Sandbox;
+function getSandboxPersonalAccessKey(accountId, sandboxId) {
+    return http_1.http.post(accountId, {
+        url: `${SANDBOX_API_PATH_V2}/sandboxes/${sandboxId}/personal-access-key`,
+        headers: {
+            'Content-Type': 'application/json',
+        },
+        timeout: api_1.SANDBOX_TIMEOUT,
+    });
+}
+exports.getSandboxPersonalAccessKey = getSandboxPersonalAccessKey;

package/package.json

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

package/types/Deploy.d.ts

@@ -35,9 +35,25 @@ export type DeployStatusTaskLocator = {
         status: string;
     }>;
 };
-export type ProjectDeployResponse = {
+export type ProjectDeployResponseQueued = {
     id: string;
+    buildResultType: 'DEPLOY_QUEUED';
     links: {
         status: string;
     };
 };
+type SubdeployValidationIssue = {
+    uid: string;
+    componentTypeName: string;
+    errorMessages: string[];
+    blockingMessages: {
+        message: string;
+        isWarning: boolean;
+    }[];
+};
+export type ProjectDeployResponseBlocked = {
+    buildResultType: 'DEPLOY_BLOCKED';
+    issues: SubdeployValidationIssue[];
+};
+export type ProjectDeployResponse = ProjectDeployResponseQueued | ProjectDeployResponseBlocked;
+export {};

package/types/Sandbox.d.ts

@@ -111,6 +111,33 @@ export type Sandbox = {
     requestAccessFrom?: User | null;
     superAdminsInSandbox?: number;
 };
+export declare const SandboxVersioning: {
+    readonly V1: "V1";
+    readonly V2: "V2";
+};
+export declare const SandboxStatus: {
+    readonly PENDING: "PENDING";
+    readonly READY: "READY";
+    readonly FAILED: "FAILED";
+};
+export type SandboxVersion = keyof typeof SandboxVersioning;
+export type V2SandboxStatus = keyof typeof SandboxStatus;
+export type V2Sandbox = {
+    sandboxHubId: number;
+    parentHubId: number;
+    name: string;
+    version: SandboxVersion;
+    type: string;
+    status: V2SandboxStatus;
+    createdAt: string;
+    createdByUser: User;
+    currentUserHasAccess?: boolean;
+    currentUserHasSuperAdminAccess?: boolean;
+    superAdminsInSandbox?: number;
+    requestAccessFrom?: User | null;
+    updatedAt?: string;
+    updatedByUser?: User | null;
+};
 export type SandboxResponse = {
     sandbox: Sandbox;
     personalAccessKey: string;
@@ -152,4 +179,10 @@ export type SandboxType = {
 export type FetchTypesResponse = {
     results: Array<SandboxType>;
 };
+export type SandboxPersonalAccessKey = {
+    personalAccessKey: {
+        encodedOAuthRefreshToken: string;
+        oauthAccessToken: string;
+    };
+};
 export {};

package/types/Sandbox.js

@@ -1,2 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.SandboxStatus = exports.SandboxVersioning = void 0;
+exports.SandboxVersioning = {
+    V1: 'V1',
+    V2: 'V2',
+};
+exports.SandboxStatus = {
+    PENDING: 'PENDING',
+    READY: 'READY',
+    FAILED: 'FAILED',
+};