@hubspot/local-dev-lib 1.5.0 → 1.6.0

package/lang/en.json

@@ -10,15 +10,15 @@
                 "init": "Extracting project source...",
                 "success": "Completed project source extraction.",
                 "errors": {
-                    "write": "An error occured writing temp project source.",
-                    "extract": "An error occured extracting project source."
+                    "write": "An error occurred writing temp project source.",
+                    "extract": "An error occurred extracting project source."
                 }
             },
             "copySourceToDest": {
                 "init": "Copying project source...",
                 "sourceEmpty": "Project source is empty",
                 "success": "Completed copying project source.",
-                "error": "An error occured copying project source to {{ dest }}."
+                "error": "An error occurred copying project source to {{ dest }}."
             },
             "cleanupTempDir": {
                 "error": "Failed to clean up temp dir: {{ tmpDir }}"
@@ -33,7 +33,7 @@
             "fetchFileFromRepository": {
                 "fetching": "Fetching {{ path }}...",
                 "errors": {
-                    "fetchFail": "An error occured fetching JSON file."
+                    "fetchFail": "An error occurred fetching JSON file."
                 }
             },
             "fetchReleaseData": {
@@ -130,7 +130,7 @@
                 },
                 "createTmpDirSync": {
                     "errors": {
-                        "writeFailed": "An error occured writing temporary project source."
+                        "writeFailed": "An error occurred writing temporary project source."
                     }
                 },
                 "cleanupTmpDirSync": {

package/lang/lang/en.json

@@ -10,15 +10,15 @@
         "init": "Extracting project source...",
         "success": "Completed project source extraction.",
         "errors": {
-          "write": "An error occured writing temp project source.",
-          "extract": "An error occured extracting project source."
+          "write": "An error occurred writing temp project source.",
+          "extract": "An error occurred extracting project source."
         }
       },
       "copySourceToDest": {
         "init": "Copying project source...",
         "sourceEmpty": "Project source is empty",
         "success": "Completed copying project source.",
-        "error": "An error occured copying project source to {{ dest }}."
+        "error": "An error occurred copying project source to {{ dest }}."
       },
       "cleanupTempDir": {
         "error": "Failed to clean up temp dir: {{ tmpDir }}"
@@ -33,7 +33,7 @@
       "fetchFileFromRepository": {
         "fetching": "Fetching {{ path }}...",
         "errors": {
-          "fetchFail": "An error occured fetching JSON file."
+          "fetchFail": "An error occurred fetching JSON file."
         }
       },
       "fetchReleaseData": {
@@ -130,7 +130,7 @@
         },
         "createTmpDirSync": {
           "errors": {
-            "writeFailed": "An error occured writing temporary project source."
+            "writeFailed": "An error occurred writing temporary project source."
           }
         },
         "cleanupTmpDirSync": {

package/lib/archive.js

@@ -65,7 +65,7 @@ async function copySourceToDest(src, dest, { sourceDir, includesRootDir = true,
             if (!rootDir) {
                 logger_1.logger.debug((0, lang_1.i18n)(`${i18nKey}.copySourceToDest.sourceEmpty`));
                 // Create the dest path if it doesn't already exist
-                fs_extra_1.default.ensureDir(dest);
+                await fs_extra_1.default.ensureDir(dest);
                 // No root found so nothing to copy
                 return true;
             }
@@ -88,11 +88,11 @@ async function copySourceToDest(src, dest, { sourceDir, includesRootDir = true,
     }
     return false;
 }
-function cleanupTempDir(tmpDir) {
+async function cleanupTempDir(tmpDir) {
     if (!tmpDir)
         return;
     try {
-        fs_extra_1.default.remove(tmpDir);
+        await fs_extra_1.default.remove(tmpDir);
     }
     catch (e) {
         logger_1.logger.debug((0, lang_1.i18n)(`${i18nKey}.cleanupTempDir.error`, { tmpDir }));
@@ -109,7 +109,7 @@ async function extractZipArchive(zip, name, dest, { sourceDir, includesRootDir,
                 hideLogs,
             });
         }
-        cleanupTempDir(tmpDir);
+        await cleanupTempDir(tmpDir);
     }
     return success;
 }

package/lib/path.d.ts

@@ -9,3 +9,5 @@ export declare function getExt(filepath: string): string;
 export declare function getAllowedExtensions(allowList?: Array<string>): Set<string>;
 export declare function isAllowedExtension(filepath: string, allowList?: Array<string>): boolean;
 export declare function getAbsoluteFilePath(_path: string): string;
+export declare function sanitizeFileName(fileName: string): string;
+export declare function isValidPath(_path: string): boolean;

package/lib/path.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.getAbsoluteFilePath = exports.isAllowedExtension = exports.getAllowedExtensions = exports.getExt = exports.getCwd = exports.splitHubSpotPath = exports.splitLocalPath = exports.convertToLocalFileSystemPath = exports.convertToUnixPath = void 0;
+exports.isValidPath = exports.sanitizeFileName = exports.getAbsoluteFilePath = exports.isAllowedExtension = exports.getAllowedExtensions = exports.getExt = exports.getCwd = exports.splitHubSpotPath = exports.splitLocalPath = exports.convertToLocalFileSystemPath = exports.convertToUnixPath = void 0;
 const path_1 = __importDefault(require("path"));
 const unixify_1 = __importDefault(require("unixify"));
 const extensions_1 = require("../constants/extensions");
@@ -87,3 +87,36 @@ function getAbsoluteFilePath(_path) {
     return path_1.default.resolve(getCwd(), _path);
 }
 exports.getAbsoluteFilePath = getAbsoluteFilePath;
+// Reserved names (Windows specific)
+const reservedNames = /^(CON|PRN|AUX|NUL|COM[1-9]|LPT[1-9])$/i;
+// Based on the node-sanitize-filename package: https://github.com/parshap/node-sanitize-filename/blob/master/index.js
+function sanitizeFileName(fileName) {
+    // Windows invalid/control characters
+    // eslint-disable-next-line no-control-regex
+    const invalidChars = /[<>:"/|?*\x00-\x1F]/g;
+    //Replace invalid characters with dash
+    let sanitizedFileName = fileName.replace(invalidChars, '-');
+    // Removes trailing periods and spaces for Windows
+    sanitizedFileName = sanitizedFileName.replace(/[. ]+$/, '');
+    //Reserved names check for Windows
+    if (reservedNames.test(sanitizedFileName)) {
+        sanitizedFileName = `-${sanitizedFileName}`;
+    }
+    return sanitizedFileName;
+}
+exports.sanitizeFileName = sanitizeFileName;
+// Based on the node-sanitize-filename package: https://github.com/parshap/node-sanitize-filename/blob/master/index.js
+function isValidPath(_path) {
+    // Invalid characters excluding forward slash
+    // eslint-disable-next-line no-control-regex
+    const invalidChars = /[<>:"|?*\x00-\x1F]/;
+    const baseName = path_1.default.basename(_path);
+    if (invalidChars.test(baseName)) {
+        return false;
+    }
+    if (reservedNames.test(baseName)) {
+        return false;
+    }
+    return true;
+}
+exports.isValidPath = isValidPath;

package/lib/sandboxes.js

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

package/package.json

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

package/types/FileManager.d.ts

@@ -13,7 +13,6 @@ export type File = {
     friendly_url: string;
     meta: {
         allows_anonymous_access: boolean;
-        charset_guess: string;
         line_count: number;
         indexable: boolean;
     };