@hubspot/local-dev-lib 1.1.0 → 1.3.0

package/api/projects.js

@@ -162,13 +162,13 @@ async function cancelStagedBuild(accountId, projectName) {
 exports.cancelStagedBuild = cancelStagedBuild;
 async function fetchBuildWarnLogs(accountId, projectName, buildId) {
     return http_1.default.get(accountId, {
-        url: `${PROJECTS_LOGS_API_PATH}/logs/projects/${projectName}/builds/${buildId}/combined/warn`,
+        url: `${PROJECTS_LOGS_API_PATH}/logs/projects/${encodeURIComponent(projectName)}/builds/${buildId}/combined/warn`,
     });
 }
 exports.fetchBuildWarnLogs = fetchBuildWarnLogs;
 async function fetchDeployWarnLogs(accountId, projectName, deployId) {
     return http_1.default.get(accountId, {
-        url: `${PROJECTS_LOGS_API_PATH}/logs/projects/${projectName}/deploys/${deployId}/combined/warn`,
+        url: `${PROJECTS_LOGS_API_PATH}/logs/projects/${encodeURIComponent(projectName)}/deploys/${deployId}/combined/warn`,
     });
 }
 exports.fetchDeployWarnLogs = fetchDeployWarnLogs;

package/api/sandboxSync.d.ts

@@ -1,4 +1,4 @@
-import { InitiateSyncResponse, Task, SyncTask, FetchTypesResponse } from '../types/Sandbox';
-export declare function initiateSync(fromHubId: number, toHubId: number, tasks: Array<SyncTask>, sandboxHubId: number): Promise<InitiateSyncResponse>;
-export declare function fetchTaskStatus(accountId: number, taskId: number): Promise<Task>;
+import { InitiateSyncResponse, FetchTypesResponse, TaskRequestData, SyncTaskStatusType } from '../types/Sandbox';
+export declare function initiateSync(fromHubId: number, toHubId: number, tasks: Array<TaskRequestData>, sandboxHubId: number): Promise<InitiateSyncResponse>;
+export declare function fetchTaskStatus(accountId: number, taskId: number): Promise<SyncTaskStatusType>;
 export declare function fetchTypes(accountId: number, toHubId: number): Promise<FetchTypesResponse>;

package/api/sandboxSync.js

@@ -23,7 +23,7 @@ async function initiateSync(fromHubId, toHubId, tasks, sandboxHubId) {
 exports.initiateSync = initiateSync;
 async function fetchTaskStatus(accountId, taskId) {
     return http_1.default.get(accountId, {
-        url: `${SANDBOXES_SYNC_API_PATH}/tasks/${taskId}`,
+        url: `${SANDBOXES_SYNC_API_PATH}/tasks/${taskId}/status`,
     });
 }
 exports.fetchTaskStatus = fetchTaskStatus;

package/lang/en.json

@@ -223,11 +223,11 @@
             }
         },
         "accountTypes": {
-            "developmentSandbox": "development sandbox",
+            "developmentSandbox": "dev sandbox",
             "standardSandbox": "standard sandbox",
-            "developerTest": "developer test account",
-            "appDeveloper": "app developer account",
-            "standard": "production account"
+            "developerTest": "test account",
+            "appDeveloper": "dev account",
+            "standard": "standard"
         }
     },
     "config": {

package/lang/lang/en.json

@@ -223,11 +223,11 @@
       }
     },
     "accountTypes": {
-      "developmentSandbox": "development sandbox",
+      "developmentSandbox": "dev sandbox",
       "standardSandbox": "standard sandbox",
-      "developerTest": "developer test account",
-      "appDeveloper": "app developer account",
-      "standard": "production account"
+      "developerTest": "test account",
+      "appDeveloper": "dev account",
+      "standard": "standard"
     }
   },
   "config": {

package/lib/cms/modules.d.ts

@@ -21,4 +21,5 @@ export declare function createModule(moduleDefinition: ModuleDefinition, name: s
     allowExistingDir: boolean;
 }): Promise<void>;
 export declare function retrieveDefaultModule(name: string | undefined, dest: string): Promise<import("../../types/Github").GithubRepoFile[] | undefined>;
+export declare const isModuleHTMLFile: (filePath: string) => boolean;
 export {};

package/lib/cms/modules.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.retrieveDefaultModule = exports.createModule = exports.validateSrcAndDestPaths = exports.ValidationIds = void 0;
+exports.isModuleHTMLFile = exports.retrieveDefaultModule = exports.createModule = exports.validateSrcAndDestPaths = exports.ValidationIds = void 0;
 const path_1 = __importDefault(require("path"));
 const fs_extra_1 = __importDefault(require("fs-extra"));
 const path_2 = require("../path");
@@ -114,7 +114,7 @@ async function createModule(moduleDefinition, name, dest, getInternalVersion, op
         external_js: [],
         global: global,
         help_text: '',
-        host_template_types: contentTypes,
+        content_types: contentTypes,
         js_assets: [],
         other_assets: [],
         smart_type: 'NOT_SMART',
@@ -182,3 +182,6 @@ async function retrieveDefaultModule(name, dest) {
     await (0, github_1.downloadGithubRepoContents)('HubSpot/cms-react', `default-react-modules/src/components/modules/${name}`, dest);
 }
 exports.retrieveDefaultModule = retrieveDefaultModule;
+const MODULE_HTML_EXTENSION_REGEX = new RegExp(/\.module(?:\/|\\)module\.html$/);
+const isModuleHTMLFile = (filePath) => MODULE_HTML_EXTENSION_REGEX.test(filePath);
+exports.isModuleHTMLFile = isModuleHTMLFile;

package/lib/cms/templates.d.ts

@@ -20,4 +20,46 @@ declare const ASSET_PATHS: {
 export declare function createTemplate(name: string, dest: string, type?: keyof typeof ASSET_PATHS, options?: {
     allowExisting: boolean;
 }): Promise<void>;
+export declare const TEMPLATE_TYPES: {
+    unmapped: number;
+    email_base_template: number;
+    email: number;
+    landing_page_base_template: number;
+    landing_page: number;
+    blog_base: number;
+    blog: number;
+    blog_listing: number;
+    site_page: number;
+    blog_listing_context: number;
+    blog_post_context: number;
+    error_page: number;
+    subscription_preferences: number;
+    unsubscribe_confirmation: number;
+    unsubscribe_simple: number;
+    optin_email: number;
+    optin_followup_email: number;
+    optin_confirmation_page: number;
+    global_group: number;
+    password_prompt_page: number;
+    resubscribe_email: number;
+    unsubscribe_confirmation_email: number;
+    resubscribe_confirmation_email: number;
+    custom_module: number;
+    css: number;
+    js: number;
+    search_results: number;
+    membership_login: number;
+    membership_register: number;
+    membership_reset: number;
+    membership_reset_request: number;
+    drag_drop_email: number;
+    knowledge_article: number;
+    membership_email: number;
+    section: number;
+    global_content_partial: number;
+    simple_landing_page_template: number;
+    proposal: number;
+    blog_post: number;
+    quote: number;
+};
 export {};

package/lib/cms/templates.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.createTemplate = exports.isCodedFile = exports.getAnnotationValue = exports.ANNOTATION_KEYS = void 0;
+exports.TEMPLATE_TYPES = exports.createTemplate = exports.isCodedFile = exports.getAnnotationValue = exports.ANNOTATION_KEYS = void 0;
 const fs_extra_1 = __importDefault(require("fs-extra"));
 const path_1 = __importDefault(require("path"));
 const github_1 = require("../github");
@@ -64,3 +64,45 @@ async function createTemplate(name, dest, type = 'page-template', options = { al
     await (0, github_1.downloadGithubRepoContents)('HubSpot/cms-sample-assets', assetPath, filePath);
 }
 exports.createTemplate = createTemplate;
+exports.TEMPLATE_TYPES = {
+    unmapped: 0,
+    email_base_template: 1,
+    email: 2,
+    landing_page_base_template: 3,
+    landing_page: 4,
+    blog_base: 5,
+    blog: 6,
+    blog_listing: 42,
+    site_page: 8,
+    blog_listing_context: 9,
+    blog_post_context: 10,
+    error_page: 11,
+    subscription_preferences: 12,
+    unsubscribe_confirmation: 13,
+    unsubscribe_simple: 14,
+    optin_email: 15,
+    optin_followup_email: 16,
+    optin_confirmation_page: 17,
+    global_group: 18,
+    password_prompt_page: 19,
+    resubscribe_email: 20,
+    unsubscribe_confirmation_email: 21,
+    resubscribe_confirmation_email: 22,
+    custom_module: 23,
+    css: 24,
+    js: 25,
+    search_results: 27,
+    membership_login: 29,
+    membership_register: 30,
+    membership_reset: 31,
+    membership_reset_request: 32,
+    drag_drop_email: 34,
+    knowledge_article: 35,
+    membership_email: 36,
+    section: 37,
+    global_content_partial: 38,
+    simple_landing_page_template: 39,
+    proposal: 40,
+    blog_post: 41,
+    quote: 43,
+};

package/lib/cms/watch.d.ts

@@ -13,5 +13,5 @@ type WatchOptions = {
     filePaths?: Array<string>;
 };
 type ErrorHandler = (error: AxiosError) => void;
-export declare function watch(accountId: number, src: string, dest: string, { mode, remove, disableInitial, notify, commandOptions, filePaths, }: WatchOptions, postInitialUploadCallback?: ((result: Array<UploadFolderResults>) => void) | null, onUploadFolderError?: ErrorHandler, onQueueAddError?: ErrorHandler): chokidar.FSWatcher;
+export declare function watch(accountId: number, src: string, dest: string, { mode, remove, disableInitial, notify, commandOptions, filePaths, }: WatchOptions, postInitialUploadCallback?: ((result: Array<UploadFolderResults>) => void) | null, onUploadFolderError?: ErrorHandler, onQueueAddError?: ErrorHandler, onUploadFileError?: (file: string, dest: string, accountId: number) => ErrorHandler): chokidar.FSWatcher;
 export {};

package/lib/cms/watch.js

@@ -35,7 +35,18 @@ function _notifyOfThemePreview(filePath, accountId) {
     }));
 }
 const notifyOfThemePreview = (0, debounce_1.default)(_notifyOfThemePreview, 1000);
-async function uploadFile(accountId, file, dest, options, mode = null) {
+const defaultOnUploadFileError = (file, dest, accountId) => (error) => {
+    logger_1.logger.debug((0, lang_1.i18n)(`${i18nKey}.uploadFailed`, {
+        file,
+        dest,
+    }));
+    (0, apiErrors_1.throwApiUploadError)(error, {
+        accountId,
+        request: dest,
+        payload: file,
+    });
+};
+async function uploadFile(accountId, file, dest, options, mode = null, onUploadFileError = defaultOnUploadFileError) {
     const src = options.src;
     const absoluteSrcPath = path_1.default.resolve((0, path_2.getCwd)(), file);
     const themeJsonPath = (0, themes_1.getThemeJSONPath)(absoluteSrcPath);
@@ -71,17 +82,7 @@ async function uploadFile(accountId, file, dest, options, mode = null) {
             .catch(() => {
             logger_1.logger.debug((0, lang_1.i18n)(`${i18nKey}.uploadFailed`, { file, dest }));
             logger_1.logger.debug((0, lang_1.i18n)(`${i18nKey}.uploadRetry`, { file, dest }));
-            return (0, fileMapper_2.upload)(accountId, file, dest, apiOptions).catch((error) => {
-                logger_1.logger.debug((0, lang_1.i18n)(`${i18nKey}.uploadFailed`, {
-                    file,
-                    dest,
-                }));
-                (0, apiErrors_1.throwApiUploadError)(error, {
-                    accountId,
-                    request: dest,
-                    payload: file,
-                });
-            });
+            return (0, fileMapper_2.upload)(accountId, file, dest, apiOptions).catch(onUploadFileError(file, dest, accountId));
         });
     });
 }
@@ -108,7 +109,7 @@ async function deleteRemoteFile(accountId, filePath, remoteFilePath) {
         });
     });
 }
-function watch(accountId, src, dest, { mode, remove, disableInitial, notify, commandOptions, filePaths, }, postInitialUploadCallback = null, onUploadFolderError, onQueueAddError) {
+function watch(accountId, src, dest, { mode, remove, disableInitial, notify, commandOptions, filePaths, }, postInitialUploadCallback = null, onUploadFolderError, onQueueAddError, onUploadFileError) {
     const regex = new RegExp(`^${(0, escapeRegExp_1.escapeRegExp)(src)}`);
     if (notify) {
         (0, ignoreRules_1.ignoreFile)(notify);
@@ -145,7 +146,7 @@ function watch(accountId, src, dest, { mode, remove, disableInitial, notify, com
         const uploadPromise = uploadFile(accountId, filePath, destPath, {
             src,
             commandOptions,
-        }, mode);
+        }, mode, onUploadFileError);
         (0, notify_1.triggerNotify)(notify, 'Added', filePath, uploadPromise);
     });
     if (remove) {
@@ -185,7 +186,7 @@ function watch(accountId, src, dest, { mode, remove, disableInitial, notify, com
         const uploadPromise = uploadFile(accountId, filePath, destPath, {
             src,
             commandOptions,
-        }, mode);
+        }, mode, onUploadFileError);
         (0, notify_1.triggerNotify)(notify, 'Changed', filePath, uploadPromise);
     });
     return watcher;

package/lib/sandboxes.d.ts

@@ -1,4 +1,4 @@
-import { InitiateSyncResponse, Sandbox, SandboxType, SyncTask, Task, Usage } from '../types/Sandbox';
+import { InitiateSyncResponse, Sandbox, SandboxType, SyncTaskStatusType, TaskRequestData, Usage } from '../types/Sandbox';
 export declare function createSandbox(accountId: number, name: string, type: 1 | 2): Promise<{
     name: string;
     sandbox: Sandbox;
@@ -9,6 +9,6 @@ export declare function deleteSandbox(parentAccountId: number, sandboxAccountId:
     sandboxAccountId: number;
 }>;
 export declare function getSandboxUsageLimits(parentAccountId: number): Promise<Usage | void>;
-export declare function initiateSync(fromHubId: number, toHubId: number, tasks: Array<SyncTask>, sandboxHubId: number): Promise<InitiateSyncResponse>;
-export declare function fetchTaskStatus(accountId: number, taskId: number): Promise<Task>;
+export declare function initiateSync(fromHubId: number, toHubId: number, tasks: Array<TaskRequestData>, sandboxHubId: number): Promise<InitiateSyncResponse>;
+export declare function fetchTaskStatus(accountId: number, taskId: number): Promise<SyncTaskStatusType>;
 export declare function fetchTypes(accountId: number, toHubId: number): Promise<Array<SandboxType> | void>;

package/lib/sandboxes.js

@@ -51,7 +51,8 @@ async function initiateSync(fromHubId, toHubId, tasks, sandboxHubId) {
 exports.initiateSync = initiateSync;
 async function fetchTaskStatus(accountId, taskId) {
     try {
-        return await (0, sandboxSync_1.fetchTaskStatus)(accountId, taskId);
+        const result = await (0, sandboxSync_1.fetchTaskStatus)(accountId, taskId);
+        return result;
     }
     catch (err) {
         (0, apiErrors_1.throwApiError)(err);

package/package.json

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

package/types/Sandbox.d.ts

@@ -47,13 +47,18 @@ type MutationError = {
         };
     };
 };
-type TaskStatus = {
+export type SyncTaskStatusType = {
+    status: string;
+    result?: string;
+    tasks: Pick<CompositeSyncTask, 'type' | 'status'>[];
+};
+type SyncMutationData = {
     numRequests: number;
     numSuccesses: number;
     errors: Array<TaskError>;
     mutationErrors: Array<MutationError>;
 };
-export type Task = {
+export type CompositeSyncTask = {
     id: string;
     parentHubId: number;
     sandboxHubId: number;
@@ -70,12 +75,29 @@ export type Task = {
     startedAt: string;
     completedAt: string;
     error: MutationError;
-    creates: TaskStatus;
-    updates: TaskStatus;
-    deletes: TaskStatus;
+    creates: SyncMutationData;
+    updates: SyncMutationData;
+    deletes: SyncMutationData;
     diffSummary: string;
     portableKeys: Array<string>;
 };
+export type SyncTask = {
+    id: string;
+    parentHubId: number;
+    sandboxHubId: number;
+    fromHubId: number;
+    toHubId: number;
+    command: string;
+    status: string;
+    result: string;
+    sandboxType: string;
+    requestedAt: string;
+    requestedByUserId: number;
+    requestedByUser: User;
+    startedAt: string;
+    completedAt: string;
+    tasks: Array<CompositeSyncTask>;
+};
 export type Sandbox = {
     sandboxHubId: number;
     parentHubId: number;
@@ -88,23 +110,7 @@ export type Sandbox = {
     domain: string;
     createdByUser: User;
     updatedByUser?: User | null;
-    lastSync?: {
-        id: string;
-        parentHubId: number;
-        sandboxHubId: number;
-        fromHubId: number;
-        toHubId: number;
-        command: string;
-        status: string;
-        result: string;
-        sandboxType: string;
-        requestedAt: string;
-        requestedByUserId: number;
-        requestedByUser: User;
-        startedAt: string;
-        completedAt: string;
-        tasks: Array<Task>;
-    };
+    lastSync?: SyncTask;
     currentUserHasAccess?: boolean;
     currentUserHasSuperAdminAccess?: boolean;
     requestAccessFrom?: User | null;
@@ -129,26 +135,14 @@ export type Usage = {
 export type SandboxUsageLimitsResponse = {
     usage: Usage;
 };
-export type SyncTask = {
+export type TaskRequestData = {
     type: string;
 };
 export type InitiateSyncResponse = {
     links: {
         status: string;
     };
-    sync: {
-        id: string;
-        parentHubId: number;
-        sandboxHubId: number;
-        fromHubId: number;
-        toHubId: number;
-        command: string;
-        status: string;
-        sandboxType: string;
-        requestedAt: string;
-        requestedByUserId: number;
-        tasks: Array<Task>;
-    };
+    sync: SyncTask;
     id: string;
 };
 export type SandboxType = {