@hubspot/local-dev-lib 0.0.2 → 0.0.4

package/config/environment.js

@@ -0,0 +1,64 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.loadConfigFromEnvironment = exports.getValidEnv = void 0;
+const logger_1 = require("../utils/logger");
+const constants_1 = require("../constants");
+const auth_1 = require("../constants/auth");
+const configUtils_1 = require("./configUtils");
+function getValidEnv(env, useProdDefault = true) {
+    if (typeof env === 'string' && env.toLowerCase() === constants_1.ENVIRONMENTS.QA) {
+        return constants_1.ENVIRONMENTS.QA;
+    }
+    return useProdDefault ? constants_1.ENVIRONMENTS.PROD : undefined;
+}
+exports.getValidEnv = getValidEnv;
+function getConfigVariablesFromEnv() {
+    const env = process.env;
+    return {
+        apiKey: env[constants_1.ENVIRONMENT_VARIABLES.HUBSPOT_API_KEY],
+        clientId: env[constants_1.ENVIRONMENT_VARIABLES.HUBSPOT_CLIENT_ID],
+        clientSecret: env[constants_1.ENVIRONMENT_VARIABLES.HUBSPOT_CLIENT_SECRET],
+        personalAccessKey: env[constants_1.ENVIRONMENT_VARIABLES.HUBSPOT_PERSONAL_ACCESS_KEY],
+        accountId: parseInt(env[constants_1.ENVIRONMENT_VARIABLES.HUBSPOT_ACCOUNT_ID], 10),
+        refreshToken: env[constants_1.ENVIRONMENT_VARIABLES.HUBSPOT_REFRESH_TOKEN],
+        env: getValidEnv(env[constants_1.ENVIRONMENT_VARIABLES.HUBSPOT_ENVIRONMENT]),
+    };
+}
+function loadConfigFromEnvironment() {
+    const { apiKey, clientId, clientSecret, personalAccessKey, accountId, refreshToken, env, } = getConfigVariablesFromEnv();
+    if (!accountId) {
+        (0, logger_1.debug)('environment.loadConfig.missingAccountId');
+        return null;
+    }
+    if (!env) {
+        (0, logger_1.debug)('environment.loadConfig.env');
+        return null;
+    }
+    if (personalAccessKey) {
+        return (0, configUtils_1.generateConfig)(auth_1.PERSONAL_ACCESS_KEY_AUTH_METHOD.value, {
+            accountId,
+            personalAccessKey,
+            env,
+        });
+    }
+    else if (clientId && clientSecret && refreshToken) {
+        return (0, configUtils_1.generateConfig)(auth_1.OAUTH_AUTH_METHOD.value, {
+            accountId,
+            clientId,
+            clientSecret,
+            refreshToken,
+            scopes: auth_1.OAUTH_SCOPES.map((scope) => scope.value),
+            env,
+        });
+    }
+    else if (apiKey) {
+        return (0, configUtils_1.generateConfig)(auth_1.API_KEY_AUTH_METHOD.value, {
+            accountId,
+            apiKey,
+            env,
+        });
+    }
+    (0, logger_1.debug)('environment.loadConfig.unknownAuthType');
+    return null;
+}
+exports.loadConfigFromEnvironment = loadConfigFromEnvironment;

package/constants/auth.d.ts

@@ -0,0 +1,24 @@
+export declare const API_KEY_AUTH_METHOD: {
+    readonly value: "apikey";
+    readonly name: "API Key";
+};
+export declare const OAUTH_AUTH_METHOD: {
+    readonly value: "oauth2";
+    readonly name: "OAuth2";
+};
+export declare const PERSONAL_ACCESS_KEY_AUTH_METHOD: {
+    readonly value: "personalaccesskey";
+    readonly name: "Personal Access Key";
+};
+export declare const DEFAULT_OAUTH_SCOPES: readonly ["content"];
+export declare const OAUTH_SCOPES: readonly [{
+    readonly name: "All CMS APIs, Calendar API, Email and Email Events APIs";
+    readonly value: "content";
+    readonly checked: true;
+}, {
+    readonly name: "HubDB API";
+    readonly value: "hubdb";
+}, {
+    readonly name: "File Manager API";
+    readonly value: "files";
+}];

package/constants/auth.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OAUTH_SCOPES = exports.DEFAULT_OAUTH_SCOPES = exports.PERSONAL_ACCESS_KEY_AUTH_METHOD = exports.OAUTH_AUTH_METHOD = exports.API_KEY_AUTH_METHOD = void 0;
+exports.API_KEY_AUTH_METHOD = {
+    value: 'apikey',
+    name: 'API Key',
+};
+exports.OAUTH_AUTH_METHOD = {
+    value: 'oauth2',
+    name: 'OAuth2',
+};
+exports.PERSONAL_ACCESS_KEY_AUTH_METHOD = {
+    value: 'personalaccesskey',
+    name: 'Personal Access Key',
+};
+exports.DEFAULT_OAUTH_SCOPES = ['content'];
+exports.OAUTH_SCOPES = [
+    {
+        name: 'All CMS APIs, Calendar API, Email and Email Events APIs',
+        value: 'content',
+        checked: true,
+    },
+    {
+        name: 'HubDB API',
+        value: 'hubdb',
+    },
+    {
+        name: 'File Manager API',
+        value: 'files',
+    },
+];

package/constants/config.d.ts

@@ -0,0 +1,8 @@
+export declare const DEFAULT_HUBSPOT_CONFIG_YAML_FILE_NAME = "hubspot.config.yml";
+export declare const HUBSPOT_CONFIGURATION_FOLDER = ".hubspot";
+export declare const HUBSPOT_CONFIGURATION_FILE = "config.yml";
+export declare const DEFAULT_MODES: {
+    readonly draft: "draft";
+    readonly publish: "publish";
+};
+export declare const MIN_HTTP_TIMEOUT = 3000;

package/constants/config.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MIN_HTTP_TIMEOUT = exports.DEFAULT_MODES = exports.HUBSPOT_CONFIGURATION_FILE = exports.HUBSPOT_CONFIGURATION_FOLDER = exports.DEFAULT_HUBSPOT_CONFIG_YAML_FILE_NAME = void 0;
+// NOTE this is the legacy config file name (We still need to keep it around though)
+exports.DEFAULT_HUBSPOT_CONFIG_YAML_FILE_NAME = 'hubspot.config.yml';
+exports.HUBSPOT_CONFIGURATION_FOLDER = '.hubspot';
+exports.HUBSPOT_CONFIGURATION_FILE = 'config.yml';
+exports.DEFAULT_MODES = {
+    draft: 'draft',
+    publish: 'publish',
+};
+exports.MIN_HTTP_TIMEOUT = 3000;

package/constants/environments.d.ts

@@ -0,0 +1,13 @@
+export declare const ENVIRONMENTS: {
+    readonly PROD: "prod";
+    readonly QA: "qa";
+};
+export declare const ENVIRONMENT_VARIABLES: {
+    readonly HUBSPOT_API_KEY: "HUBSPOT_API_KEY";
+    readonly HUBSPOT_CLIENT_ID: "HUBSPOT_CLIENT_ID";
+    readonly HUBSPOT_CLIENT_SECRET: "HUBSPOT_CLIENT_SECRET";
+    readonly HUBSPOT_PERSONAL_ACCESS_KEY: "HUBSPOT_PERSONAL_ACCESS_KEY";
+    readonly HUBSPOT_ACCOUNT_ID: "HUBSPOT_ACCOUNT_ID";
+    readonly HUBSPOT_REFRESH_TOKEN: "HUBSPOT_REFRESH_TOKEN";
+    readonly HUBSPOT_ENVIRONMENT: "HUBSPOT_ENVIRONMENT";
+};

package/constants/environments.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ENVIRONMENT_VARIABLES = exports.ENVIRONMENTS = void 0;
+exports.ENVIRONMENTS = {
+    PROD: 'prod',
+    QA: 'qa',
+};
+exports.ENVIRONMENT_VARIABLES = {
+    HUBSPOT_API_KEY: 'HUBSPOT_API_KEY',
+    HUBSPOT_CLIENT_ID: 'HUBSPOT_CLIENT_ID',
+    HUBSPOT_CLIENT_SECRET: 'HUBSPOT_CLIENT_SECRET',
+    HUBSPOT_PERSONAL_ACCESS_KEY: 'HUBSPOT_PERSONAL_ACCESS_KEY',
+    HUBSPOT_ACCOUNT_ID: 'HUBSPOT_ACCOUNT_ID',
+    HUBSPOT_REFRESH_TOKEN: 'HUBSPOT_REFRESH_TOKEN',
+    HUBSPOT_ENVIRONMENT: 'HUBSPOT_ENVIRONMENT',
+};

package/constants/extensions.d.ts

@@ -0,0 +1,2 @@
+export declare const ALLOWED_EXTENSIONS: Set<string>;
+export declare const MODULE_EXTENSION = "module";

package/constants/extensions.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MODULE_EXTENSION = exports.ALLOWED_EXTENSIONS = void 0;
+exports.ALLOWED_EXTENSIONS = new Set([
+    'css',
+    'js',
+    'json',
+    'html',
+    'txt',
+    'md',
+    'jpg',
+    'jpeg',
+    'png',
+    'gif',
+    'map',
+    'svg',
+    'eot',
+    'ttf',
+    'woff',
+    'woff2',
+    'graphql',
+]);
+exports.MODULE_EXTENSION = 'module';

package/constants/files.d.ts

@@ -0,0 +1,5 @@
+export declare const STAT_TYPES: {
+    readonly FILE: "file";
+    readonly SYMBOLIC_LINK: "symlink";
+    readonly DIRECTORY: "dir";
+};

package/constants/files.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.STAT_TYPES = void 0;
+exports.STAT_TYPES = {
+    FILE: 'file',
+    SYMBOLIC_LINK: 'symlink',
+    DIRECTORY: 'dir',
+};

package/constants/github.d.ts

@@ -0,0 +1,4 @@
+export declare const GITHUB_RELEASE_TYPES: {
+    readonly RELEASE: "release";
+    readonly REPOSITORY: "repository";
+};

package/constants/github.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GITHUB_RELEASE_TYPES = void 0;
+exports.GITHUB_RELEASE_TYPES = {
+    RELEASE: 'release',
+    REPOSITORY: 'repository',
+};

package/constants/index.d.ts

@@ -0,0 +1,16 @@
+export declare const ENVIRONMENTS: {
+    readonly PROD: "prod";
+    readonly QA: "qa";
+};
+export declare const ENVIRONMENT_VARIABLES: {
+    readonly HUBSPOT_API_KEY: "HUBSPOT_API_KEY";
+    readonly HUBSPOT_CLIENT_ID: "HUBSPOT_CLIENT_ID";
+    readonly HUBSPOT_CLIENT_SECRET: "HUBSPOT_CLIENT_SECRET";
+    readonly HUBSPOT_PERSONAL_ACCESS_KEY: "HUBSPOT_PERSONAL_ACCESS_KEY";
+    readonly HUBSPOT_ACCOUNT_ID: "HUBSPOT_ACCOUNT_ID";
+    readonly HUBSPOT_REFRESH_TOKEN: "HUBSPOT_REFRESH_TOKEN";
+    readonly HUBSPOT_ENVIRONMENT: "HUBSPOT_ENVIRONMENT";
+};
+export declare const DEFAULT_HUBSPOT_CONFIG_YAML_FILE_NAME = "hubspot.config.yml";
+export declare const HUBSPOT_CONFIGURATION_FOLDER = ".hubspot";
+export declare const HUBSPOT_CONFIGURATION_FILE = "config.yml";

package/constants/index.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HUBSPOT_CONFIGURATION_FILE = exports.HUBSPOT_CONFIGURATION_FOLDER = exports.DEFAULT_HUBSPOT_CONFIG_YAML_FILE_NAME = exports.ENVIRONMENT_VARIABLES = exports.ENVIRONMENTS = void 0;
+const environments_1 = require("./environments");
+const config_1 = require("./config");
+// Environment Variables
+exports.ENVIRONMENTS = environments_1.ENVIRONMENTS;
+exports.ENVIRONMENT_VARIABLES = environments_1.ENVIRONMENT_VARIABLES;
+// Config Variables
+exports.DEFAULT_HUBSPOT_CONFIG_YAML_FILE_NAME = config_1.DEFAULT_HUBSPOT_CONFIG_YAML_FILE_NAME;
+exports.HUBSPOT_CONFIGURATION_FOLDER = config_1.HUBSPOT_CONFIGURATION_FOLDER;
+exports.HUBSPOT_CONFIGURATION_FILE = config_1.HUBSPOT_CONFIGURATION_FILE;

package/errors/HubSpotAuthError.d.ts

@@ -0,0 +1,3 @@
+import { BaseError } from '../types/Error';
+export declare class HubSpotAuthError extends Error implements BaseError {
+}

package/errors/HubSpotAuthError.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HubSpotAuthError = void 0;
+class HubSpotAuthError extends Error {
+}
+exports.HubSpotAuthError = HubSpotAuthError;

package/errors/fileSystemErrors.d.ts

@@ -0,0 +1,8 @@
+import { BaseError } from '../types/Error';
+type FileSystemErrorContext = {
+    filepath: string;
+    write?: boolean;
+    read?: boolean;
+};
+export declare function throwFileSystemError(error: BaseError, context: FileSystemErrorContext): void;
+export {};

package/errors/fileSystemErrors.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.throwFileSystemError = void 0;
+const lang_1 = require("../utils/lang");
+const standardErrors_1 = require("./standardErrors");
+const i18nKey = 'errors.errorTypes.fileSystem';
+function throwFileSystemError(error, context) {
+    let fileAction = '';
+    if (context.read) {
+        fileAction = (0, lang_1.i18n)(`${i18nKey}.readAction`);
+    }
+    else if (context.write) {
+        fileAction = (0, lang_1.i18n)(`${i18nKey}.writeAction`);
+    }
+    else {
+        fileAction = (0, lang_1.i18n)(`${i18nKey}.otherAction`);
+    }
+    const filepath = context.filepath
+        ? `"${context.filepath}"`
+        : (0, lang_1.i18n)(`${i18nKey}.unknownFilepath`);
+    const message = [(0, lang_1.i18n)(`${i18nKey}.baseMessage`, { fileAction, filepath })];
+    // Many `fs` errors will be `SystemError`s
+    if ((0, standardErrors_1.isSystemError)(error)) {
+        message.push((0, lang_1.i18n)(`${i18nKey}.baseMessage`, { errorMessage: error.message }));
+    }
+    throw new Error(message.join(' '), { cause: error });
+}
+exports.throwFileSystemError = throwFileSystemError;

package/errors/standardErrors.d.ts

@@ -0,0 +1,19 @@
+import { BaseError } from '../types/Error';
+export declare function isSystemError(err: BaseError): boolean;
+export declare function isFatalError(err: BaseError): boolean;
+/**
+ * @throws
+ */
+export declare function throwErrorWithMessage(identifier: string, interpolation?: {
+    [key: string]: string | number;
+}, cause?: BaseError): never;
+/**
+ * @throws
+ */
+export declare function throwTypeErrorWithMessage(identifier: string, interpolation?: {
+    [key: string]: string | number;
+}, cause?: BaseError): never;
+/**
+ * @throws
+ */
+export declare function throwError(error: BaseError): never;

package/errors/standardErrors.js

@@ -0,0 +1,67 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.throwError = exports.throwTypeErrorWithMessage = exports.throwErrorWithMessage = exports.isFatalError = exports.isSystemError = void 0;
+const HubSpotAuthError_1 = require("./HubSpotAuthError");
+const lang_1 = require("../utils/lang");
+function isSystemError(err) {
+    return err.errno != null && err.code != null && err.syscall != null;
+}
+exports.isSystemError = isSystemError;
+function isFatalError(err) {
+    return err instanceof HubSpotAuthError_1.HubSpotAuthError;
+}
+exports.isFatalError = isFatalError;
+/**
+ * @throws
+ */
+function throwErrorWithMessage(identifier, interpolation, cause) {
+    const message = (0, lang_1.i18n)(`errors.${identifier}`, interpolation);
+    if (cause) {
+        throw new Error(message, { cause });
+    }
+    throw new Error(message);
+}
+exports.throwErrorWithMessage = throwErrorWithMessage;
+/**
+ * @throws
+ */
+function throwTypeErrorWithMessage(identifier, interpolation, cause) {
+    const message = (0, lang_1.i18n)(`errors.${identifier}`, interpolation);
+    if (cause) {
+        throw new TypeError(message, { cause });
+    }
+    throw new TypeError(message);
+}
+exports.throwTypeErrorWithMessage = throwTypeErrorWithMessage;
+function throwStatusCodeError(error) {
+    const { statusCode, message, response } = error;
+    const errorData = JSON.stringify({
+        statusCode,
+        message,
+        url: response.request.href,
+        method: response.request.method,
+        response: response.body,
+        headers: response.headers,
+    });
+    throw new Error(errorData, { cause: error });
+}
+/**
+ * @throws
+ */
+function throwError(error) {
+    if (error.name === 'StatusCodeError') {
+        throwStatusCodeError(error);
+    }
+    else {
+        // Error or Error subclass
+        const name = error.name || 'Error';
+        const message = [(0, lang_1.i18n)('errors.errorTypes.generic', { name })];
+        [error.message, error.reason].forEach(msg => {
+            if (msg) {
+                message.push(msg);
+            }
+        });
+        throw new Error(message.join(' '), { cause: error });
+    }
+}
+exports.throwError = throwError;

package/http/requestOptions.d.ts

@@ -0,0 +1,20 @@
+export declare const DEFAULT_USER_AGENT_HEADERS: {
+    'User-Agent': string;
+};
+type GetRequestOptionsOptions = {
+    env?: string;
+    localHostOverride?: boolean;
+};
+type RequestOptions = {
+    baseUrl: string;
+    headers: {
+        'User-Agent': string;
+    };
+    json: boolean;
+    simple: boolean;
+    timeout: number;
+    env?: string;
+    localHostOverride?: boolean;
+};
+export declare function getRequestOptions(options?: GetRequestOptionsOptions, requestOptions?: {}): RequestOptions;
+export {};

package/http/requestOptions.js

@@ -0,0 +1,27 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getRequestOptions = exports.DEFAULT_USER_AGENT_HEADERS = void 0;
+const package_json_1 = require("../package.json");
+const CLIConfiguration_1 = __importDefault(require("../config/CLIConfiguration"));
+const urls_1 = require("../lib/urls");
+exports.DEFAULT_USER_AGENT_HEADERS = {
+    'User-Agent': `HubSpot Local Dev Lib/${package_json_1.version}`,
+};
+function getRequestOptions(options = {}, requestOptions = {}) {
+    const { env, localHostOverride } = options;
+    const { httpTimeout, httpUseLocalhost } = CLIConfiguration_1.default.getAndLoadConfigIfNeeded();
+    return {
+        baseUrl: (0, urls_1.getHubSpotApiOrigin)(env, localHostOverride ? false : httpUseLocalhost),
+        headers: {
+            ...exports.DEFAULT_USER_AGENT_HEADERS,
+        },
+        json: true,
+        simple: true,
+        timeout: httpTimeout || 15000,
+        ...requestOptions,
+    };
+}
+exports.getRequestOptions = getRequestOptions;

package/lib/archive.d.ts

@@ -0,0 +1,7 @@
+/// <reference types="node" />
+type CopySourceToDestOptions = {
+    sourceDir?: string;
+    includesRootDir?: boolean;
+};
+export declare function extractZipArchive(zip: Buffer, name: string, dest: string, { sourceDir, includesRootDir }?: CopySourceToDestOptions): Promise<boolean>;
+export {};

package/lib/archive.js

@@ -0,0 +1,111 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.extractZipArchive = void 0;
+const fs_extra_1 = __importDefault(require("fs-extra"));
+const path_1 = require("path");
+const os_1 = require("os");
+const util_1 = require("util");
+const extract_zip_1 = __importDefault(require("extract-zip"));
+const fileSystemErrors_1 = require("../errors/fileSystemErrors");
+const standardErrors_1 = require("../errors/standardErrors");
+const logger_1 = require("../utils/logger");
+const extract = (0, util_1.promisify)(extract_zip_1.default);
+async function extractZip(name, zip) {
+    const result = { extractDir: '', tmpDir: '' };
+    const TMP_FOLDER_PREFIX = `hubspot-temp-${name}-`;
+    (0, logger_1.debug)('archive.extractZip.init');
+    // Write zip to disk
+    let tmpZipPath = '';
+    try {
+        result.tmpDir = await fs_extra_1.default.mkdtemp((0, path_1.join)((0, os_1.tmpdir)(), TMP_FOLDER_PREFIX));
+        tmpZipPath = (0, path_1.join)(result.tmpDir, 'hubspot-temp.zip');
+        await fs_extra_1.default.ensureFile(tmpZipPath);
+        await fs_extra_1.default.writeFile(tmpZipPath, zip, {
+            mode: 0o777,
+        });
+    }
+    catch (err) {
+        if (tmpZipPath || result.tmpDir) {
+            (0, fileSystemErrors_1.throwFileSystemError)(err, {
+                filepath: tmpZipPath || result.tmpDir,
+                write: true,
+            });
+        }
+        else {
+            (0, standardErrors_1.throwErrorWithMessage)('archive.extractZip.write', {}, err);
+        }
+        return result;
+    }
+    // Extract zip
+    try {
+        const tmpExtractPath = (0, path_1.join)(result.tmpDir, 'extracted');
+        await extract(tmpZipPath, { dir: tmpExtractPath });
+        result.extractDir = tmpExtractPath;
+    }
+    catch (err) {
+        (0, standardErrors_1.throwErrorWithMessage)('archive.extractZip.extract', {}, err);
+    }
+    (0, logger_1.debug)('archive.extractZip.success');
+    return result;
+}
+async function copySourceToDest(src, dest, { sourceDir, includesRootDir = true } = {}) {
+    try {
+        (0, logger_1.debug)('archive.copySourceToDest.init');
+        const srcDirPath = [src];
+        if (includesRootDir) {
+            const files = await fs_extra_1.default.readdir(src);
+            const rootDir = files[0];
+            if (!rootDir) {
+                (0, logger_1.debug)('archive.copySourceToDest.sourceEmpty');
+                // Create the dest path if it doesn't already exist
+                fs_extra_1.default.ensureDir(dest);
+                // No root found so nothing to copy
+                return true;
+            }
+            srcDirPath.push(rootDir);
+        }
+        if (sourceDir) {
+            srcDirPath.push(sourceDir);
+        }
+        const projectSrcDir = (0, path_1.join)(...srcDirPath);
+        await fs_extra_1.default.copy(projectSrcDir, dest);
+        (0, logger_1.debug)('archive.copySourceToDest.success');
+        return true;
+    }
+    catch (err) {
+        (0, logger_1.debug)('archive.copySourceToDest.error', { dest });
+        (0, fileSystemErrors_1.throwFileSystemError)(err, {
+            filepath: dest,
+            write: true,
+        });
+    }
+    return false;
+}
+function cleanupTempDir(tmpDir) {
+    if (!tmpDir)
+        return;
+    try {
+        fs_extra_1.default.remove(tmpDir);
+    }
+    catch (e) {
+        (0, logger_1.debug)('archive.cleanupTempDir.error', { tmpDir });
+    }
+}
+async function extractZipArchive(zip, name, dest, { sourceDir, includesRootDir } = {}) {
+    let success = false;
+    if (zip) {
+        const { extractDir, tmpDir } = await extractZip(name, zip);
+        if (extractDir !== null) {
+            success = await copySourceToDest(extractDir, dest, {
+                sourceDir,
+                includesRootDir,
+            });
+        }
+        cleanupTempDir(tmpDir);
+    }
+    return success;
+}
+exports.extractZipArchive = extractZipArchive;

package/lib/cms/handleFieldsJS.d.ts

@@ -0,0 +1,32 @@
+export declare class FieldsJs {
+    projectDir: string;
+    filePath: string;
+    rootWriteDir: string;
+    rejected: boolean;
+    fieldOptions: string;
+    outputPath?: string;
+    constructor(projectDir: string, filePath: string, rootWriteDir?: string, fieldOptions?: string);
+    init(): Promise<this>;
+    convertFieldsJs(writeDir: string): Promise<string | void>;
+    /**
+     * If there has been a fields.json written to the output path, then copy it from the output
+     * directory to the project directory, respecting the path within the output directory.
+     * Ex: path/to/tmp/example.module/fields.json => path/to/project/example.module/fields.output.json
+     */
+    saveOutput(): void;
+    /**
+     * Resolves the relative path to the fields.js within the project directory and returns
+     * directory name to write to in rootWriteDir directory.
+     *
+     * Ex: If rootWriteDir = 'path/to/temp', filePath = 'projectRoot/sample.module/fields.js'. Then getWriteDir() => path/to/temp/sample.module
+     */
+    getWriteDir(): string;
+    getOutputPathPromise(): Promise<string | void>;
+}
+/**
+ * Determines if file is a convertable fields.js file i.e., if it is called
+ * 'fields.js' and in a root or in a module folder, and if convertFields flag is true.
+ */
+export declare function isConvertableFieldJs(rootDir: string, filePath: string, convertFields?: boolean): boolean;
+export declare function createTmpDirSync(prefix: string): string;
+export declare function cleanupTmpDirSync(tmpDir: string): void;