@hubspot/local-dev-lib 3.16.0 → 3.17.0-beta.0

package/api/crm.d.ts

@@ -0,0 +1,3 @@
+import { HubSpotPromise } from '../types/Http';
+import { ImportRequest, ImportResponse } from '../types/Crm';
+export declare function createImport(accountId: number, importRequest: ImportRequest, dataFileNames: string[]): HubSpotPromise<ImportResponse>;

package/api/crm.js

@@ -0,0 +1,29 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createImport = void 0;
+const path_1 = __importDefault(require("path"));
+const fs_extra_1 = __importDefault(require("fs-extra"));
+const form_data_1 = __importDefault(require("form-data"));
+const http_1 = require("../http");
+const path_2 = require("../lib/path");
+const HUBSPOT_CRM_IMPORT_PATH = '/crm/v3/imports';
+function createImport(accountId, importRequest, dataFileNames) {
+    const jsonImportRequest = JSON.stringify(importRequest);
+    const formData = new form_data_1.default();
+    formData.append('importRequest', jsonImportRequest);
+    dataFileNames.forEach(file => {
+        const stream = fs_extra_1.default.createReadStream(path_1.default.resolve((0, path_2.getCwd)(), file));
+        formData.append('files', stream, file);
+    });
+    return http_1.http.post(accountId, {
+        url: `${HUBSPOT_CRM_IMPORT_PATH}`,
+        data: formData,
+        headers: {
+            ...formData.getHeaders(),
+        },
+    });
+}
+exports.createImport = createImport;

package/lang/en.json

@@ -78,6 +78,14 @@
         "invalidPersonalAccessKey": "Error while retrieving new access token: {{ errorMessage }}"
       }
     },
+    "crm": {
+      "importData": {
+        "errors": {
+          "fileNotFound": "The file {{ fileName }} does not exist",
+          "notJson": "You must provide a JSON file for the import data request schema."
+        }
+      }
+    },
     "cms": {
       "modules": {
         "createModule": {

package/lib/cms/uploadFolder.js

@@ -38,6 +38,16 @@ function getFileType(filePath) {
             return files_1.FILE_TYPES.other;
     }
 }
+function isMetaJsonFile(filePath) {
+    return path_1.default.basename(filePath).toLowerCase() === 'meta.json';
+}
+function resolveUploadPath(file, fieldsJsPaths, tmpDirRegex, regex, dest) {
+    const fieldsJsFileInfo = fieldsJsPaths.find(f => f.outputPath === file);
+    const relativePath = file.replace(fieldsJsFileInfo ? tmpDirRegex : regex, '');
+    const destPath = (0, path_2.convertToUnixPath)(path_1.default.join(dest, relativePath));
+    const originalFilePath = fieldsJsFileInfo ? fieldsJsFileInfo.filePath : file;
+    return { fieldsJsFileInfo, relativePath, destPath, originalFilePath };
+}
 async function getFilesByType(filePaths, projectDir, rootWriteDir, commandOptions) {
     const { convertFields, fieldOptions } = commandOptions;
     const projectDirRegex = new RegExp(`^${(0, escapeRegExp_1.escapeRegExp)(projectDir)}`);
@@ -106,6 +116,12 @@ const defaultUploadFinalErrorCallback = (accountId, file, destPath, error) => {
         payload: file,
     });
 };
+async function uploadMetaJsonFiles(moduleFiles, uploadFile) {
+    const moduleMetaJsonFiles = moduleFiles.filter(isMetaJsonFile);
+    if (moduleMetaJsonFiles.length > 0) {
+        await queue.addAll(moduleMetaJsonFiles.map(uploadFile));
+    }
+}
 async function uploadFolder(accountId, src, dest, fileMapperOptions, commandOptions = {}, filePaths = [], cmsPublishMode = null) {
     const { saveOutput, convertFields, onAttemptCallback, onSuccessCallback, onFirstErrorCallback, onRetryCallback, onFinalErrorCallback, } = commandOptions;
     const _onAttemptCallback = onAttemptCallback || defaultUploadAttemptCallback;
@@ -120,23 +136,15 @@ async function uploadFolder(accountId, src, dest, fileMapperOptions, commandOpti
     const apiOptions = (0, fileMapper_1.getFileMapperQueryValues)(cmsPublishMode, fileMapperOptions);
     const failures = [];
     let fieldsJsPaths = [];
-    let tmpDirRegex;
+    const tmpDirRegex = new RegExp(`^${(0, escapeRegExp_1.escapeRegExp)(tmpDir || '')}`);
     const [filesByType, fieldsJsObjects] = await getFilesByType(filePaths, src, tmpDir, commandOptions);
-    const fileList = Object.values(filesByType);
     if (fieldsJsObjects.length) {
         fieldsJsPaths = fieldsJsObjects.map(fieldsJs => {
             return { outputPath: fieldsJs.outputPath, filePath: fieldsJs.filePath };
         });
-        tmpDirRegex = new RegExp(`^${(0, escapeRegExp_1.escapeRegExp)(tmpDir || '')}`);
     }
     function uploadFile(file) {
-        const fieldsJsFileInfo = fieldsJsPaths.find(f => f.outputPath === file);
-        const originalFilePath = fieldsJsFileInfo
-            ? fieldsJsFileInfo.filePath
-            : file;
-        // files in fieldsJsPaths always belong to the tmp directory.
-        const relativePath = file.replace(fieldsJsFileInfo ? tmpDirRegex : regex, '');
-        const destPath = (0, path_2.convertToUnixPath)(path_1.default.join(dest, relativePath));
+        const { originalFilePath, destPath } = resolveUploadPath(file, fieldsJsPaths, tmpDirRegex, regex, dest);
         return async () => {
             _onAttemptCallback(originalFilePath, destPath);
             try {
@@ -155,9 +163,23 @@ async function uploadFolder(accountId, src, dest, fileMapperOptions, commandOpti
             }
         };
     }
-    for (let i = 0; i < fileList.length; i++) {
-        const filesToUpload = fileList[i];
-        await queue.addAll(filesToUpload.map(uploadFile));
+    // Upload all meta.json files first
+    await uploadMetaJsonFiles(filesByType[files_1.FILE_TYPES.module] || [], uploadFile);
+    // Collect all remaining files for upload
+    const deferredFiles = [];
+    Object.entries(filesByType).forEach(([fileType, files]) => {
+        if (fileType === files_1.FILE_TYPES.module) {
+            // Add non-meta.json module files
+            deferredFiles.push(...files.filter(f => !isMetaJsonFile(f)));
+        }
+        else {
+            // Add all non-module files
+            deferredFiles.push(...files);
+        }
+    });
+    // Upload all remaining files concurrently
+    if (deferredFiles.length > 0) {
+        await queue.addAll(deferredFiles.map(uploadFile));
     }
     const results = await queue
         .addAll(failures.map(({ file, destPath }) => {

package/lib/crm.d.ts

@@ -0,0 +1,6 @@
+import { ImportRequest } from '../types/Crm';
+export declare function getImportDataRequest(fileName: string): {
+    importRequest: ImportRequest;
+    dataFileNames: string[];
+};
+export declare function validateImportRequestFile(fileName: string): void;

package/lib/crm.js

@@ -0,0 +1,47 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateImportRequestFile = exports.getImportDataRequest = void 0;
+const path_1 = __importDefault(require("path"));
+const path_2 = require("./path");
+const fs_extra_1 = __importDefault(require("fs-extra"));
+const lang_1 = require("../utils/lang");
+function getImportDataRequest(fileName) {
+    validateImportRequestFile(fileName);
+    const importRequest = fs_extra_1.default.readJsonSync(path_1.default.resolve((0, path_2.getCwd)(), fileName));
+    const dataFileNames = importRequest.files.map(file => file.fileName);
+    dataFileNames.forEach(fileName => {
+        if (!fileExists(fileName)) {
+            throw new Error((0, lang_1.i18n)('lib.crm.importData.errors.fileNotFound', { fileName }));
+        }
+    });
+    return { importRequest, dataFileNames };
+}
+exports.getImportDataRequest = getImportDataRequest;
+function validateImportRequestFile(fileName) {
+    if (!fileExists(fileName)) {
+        throw new Error((0, lang_1.i18n)('lib.crm.importData.errors.fileNotFound', { fileName }));
+    }
+    if (path_1.default.extname(fileName) !== '.json') {
+        throw new Error((0, lang_1.i18n)('lib.crm.importData.errors.notJson'));
+    }
+}
+exports.validateImportRequestFile = validateImportRequestFile;
+function fileExists(_path) {
+    try {
+        const absoluteSrcPath = path_1.default.resolve((0, path_2.getCwd)(), _path);
+        if (!absoluteSrcPath)
+            return false;
+        const stats = fs_extra_1.default.statSync(absoluteSrcPath);
+        const isFile = stats.isFile();
+        if (!isFile) {
+            return false;
+        }
+    }
+    catch (e) {
+        return false;
+    }
+    return true;
+}

package/lib/isDeepEqual.d.ts

@@ -0,0 +1 @@
+export declare function isDeepEqual(object1: unknown, object2: unknown, ignoreKeys?: string[]): boolean;

package/lib/isDeepEqual.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isDeepEqual = void 0;
+function isDeepEqual(object1, object2, ignoreKeys) {
+    if (object1 === object2) {
+        return true;
+    }
+    if (object1 === null ||
+        object2 === null ||
+        typeof object1 !== 'object' ||
+        typeof object2 !== 'object') {
+        return object1 === object2;
+    }
+    if (typeof object1 !== typeof object2) {
+        return false;
+    }
+    const isArray1 = Array.isArray(object1);
+    const isArray2 = Array.isArray(object2);
+    if (isArray1 !== isArray2) {
+        return false;
+    }
+    const objKeys1 = Object.keys(object1).filter(key => !ignoreKeys?.includes(key));
+    const objKeys2 = Object.keys(object2).filter(key => !ignoreKeys?.includes(key));
+    if (objKeys1.length !== objKeys2.length)
+        return false;
+    for (const key of objKeys1) {
+        const value1 = object1[key];
+        const value2 = object2[key];
+        if (!isDeepEqual(value1, value2, ignoreKeys)) {
+            return false;
+        }
+    }
+    return true;
+}
+exports.isDeepEqual = isDeepEqual;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@hubspot/local-dev-lib",
-    "version": "3.16.0",
+    "version": "3.17.0-beta.0",
     "description": "Provides library functionality for HubSpot local development tooling, including the HubSpot CLI",
     "repository": {
         "type": "git",
@@ -70,6 +70,7 @@
         "express": "4.21.2",
         "extract-zip": "2.0.1",
         "findup-sync": "5.0.0",
+        "form-data": "^4.0.4",
         "fs-extra": "11.2.0",
         "ignore": "5.3.1",
         "js-yaml": "4.1.0",

package/types/Crm.d.ts

@@ -0,0 +1,26 @@
+export interface ImportRequest {
+    name: string;
+    importOperations: {
+        [objectTypeId: string]: 'CREATE' | 'UPDATE' | 'UPSERT';
+    };
+    dateFormat?: string;
+    marketableContactImport?: boolean;
+    createContactListFromImport?: boolean;
+    files: Array<{
+        fileName: string;
+        fileFormat: 'CSV' | 'XLSX' | 'XLS';
+        fileImportPage: {
+            hasHeader: boolean;
+            columnMappings: Array<{
+                columnObjectTypeId: string;
+                columnName: string;
+                propertyName: string;
+                columnType?: string;
+            }>;
+        };
+    }>;
+}
+export interface ImportResponse {
+    id: string;
+    state: 'STARTED' | 'PROCESSING' | 'DONE' | 'FAILED' | 'CANCELED' | 'DEFERRED';
+}

package/types/Crm.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });