@hubspot/local-dev-lib 0.0.3 → 0.0.4

package/src/utils/handleFieldsJS.d.ts

@@ -1,35 +0,0 @@
-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>;
-}
-type FieldsArray<T> = Array<T | FieldsArray<T>>;
-export declare function fieldsArrayToJson<T>(fields: FieldsArray<T>): string;
-/**
- * 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;
-export {};

package/src/utils/handleFieldsJS.js

@@ -1,158 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.cleanupTmpDirSync = exports.createTmpDirSync = exports.isConvertableFieldJs = exports.fieldsArrayToJson = exports.FieldsJs = void 0;
-const fs_extra_1 = __importDefault(require("fs-extra"));
-const os_1 = __importDefault(require("os"));
-const path_1 = __importDefault(require("path"));
-const child_process_1 = require("child_process");
-const escapeRegExp_1 = require("./escapeRegExp");
-const modules_1 = require("../lib/modules");
-const logger_1 = require("./logger");
-const standardErrors_1 = require("../errors/standardErrors");
-const i18nKey = 'utils.handleFieldsJs';
-class FieldsJs {
-    projectDir;
-    filePath;
-    rootWriteDir;
-    rejected;
-    fieldOptions;
-    outputPath;
-    constructor(projectDir, filePath, rootWriteDir, fieldOptions = '') {
-        this.projectDir = projectDir;
-        this.filePath = filePath;
-        this.fieldOptions = fieldOptions;
-        this.rejected = false;
-        // Create tmpDir if no writeDir is given.
-        this.rootWriteDir =
-            rootWriteDir === undefined
-                ? createTmpDirSync('hubspot-temp-fieldsjs-output-')
-                : rootWriteDir;
-    }
-    async init() {
-        const outputPath = await this.getOutputPathPromise();
-        this.outputPath = this.rejected ? undefined : outputPath;
-        return this;
-    }
-    // Converts a fields.js file into a fields.json file, writes, and returns of fields.json
-    convertFieldsJs(writeDir) {
-        const filePath = this.filePath;
-        const dirName = path_1.default.dirname(filePath);
-        return new Promise((resolve, reject) => {
-            const convertFieldsProcess = (0, child_process_1.fork)(path_1.default.join(__dirname, './processFieldsJs.js'), [], {
-                cwd: dirName,
-                env: {
-                    dirName,
-                    fieldOptions: this.fieldOptions,
-                    filePath,
-                    writeDir,
-                },
-            });
-            (0, logger_1.debug)(`${i18nKey}.convertFieldsJs.creating`, {
-                pid: convertFieldsProcess.pid || '',
-            });
-            convertFieldsProcess.on('message', function (message) {
-                if (message.action === 'ERROR') {
-                    reject(message.message);
-                }
-                else if (message.action === 'COMPLETE') {
-                    resolve(message.finalPath);
-                }
-            });
-            convertFieldsProcess.on('close', () => {
-                (0, logger_1.debug)(`${i18nKey}.convertFieldsJs.terminating`, {
-                    pid: convertFieldsProcess.pid || '',
-                });
-            });
-        }).catch((e) => {
-            (0, standardErrors_1.throwErrorWithMessage)(`${i18nKey}.convertFieldsJs`, { filePath }, e);
-        });
-    }
-    /**
-     * 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() {
-        if (!this.outputPath || !fs_extra_1.default.existsSync(this.outputPath)) {
-            (0, standardErrors_1.throwErrorWithMessage)(`${i18nKey}.saveOutput`, { path: this.filePath });
-        }
-        const relativePath = path_1.default.relative(this.rootWriteDir, path_1.default.dirname(this.outputPath));
-        const savePath = path_1.default.join(this.projectDir, relativePath, 'fields.output.json');
-        try {
-            fs_extra_1.default.copyFileSync(this.outputPath, savePath);
-        }
-        catch (err) {
-            (0, standardErrors_1.throwErrorWithMessage)(`${i18nKey}.saveOutput`, { path: savePath }, err);
-        }
-    }
-    /**
-     * 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() {
-        const projectDirRegex = new RegExp(`^${(0, escapeRegExp_1.escapeRegExp)(this.projectDir)}`);
-        const relativePath = this.filePath.replace(projectDirRegex, '');
-        return path_1.default.dirname(path_1.default.join(this.rootWriteDir, relativePath));
-    }
-    getOutputPathPromise() {
-        const writeDir = this.getWriteDir();
-        return this.convertFieldsJs(writeDir).then(outputPath => outputPath);
-    }
-}
-exports.FieldsJs = FieldsJs;
-/*
- * Polyfill for `Array.flat(Infinity)` since the `flat` is only available for Node v11+
- * https://stackoverflow.com/a/15030117
- */
-function flattenArray(arr) {
-    return arr.reduce((flat, toFlatten) => {
-        return flat.concat(Array.isArray(toFlatten) ? flattenArray(toFlatten) : toFlatten);
-    }, []);
-}
-//Transform fields array to JSON
-function fieldsArrayToJson(fields) {
-    const flattened = flattenArray(fields);
-    return JSON.stringify(flattened, null, 2);
-}
-exports.fieldsArrayToJson = fieldsArrayToJson;
-/**
- * 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.
- */
-function isConvertableFieldJs(rootDir, filePath, convertFields = false) {
-    const allowedFieldsNames = ['fields.js', 'fields.mjs', 'fields.cjs'];
-    const regex = new RegExp(`^${(0, escapeRegExp_1.escapeRegExp)(rootDir)}`);
-    const relativePath = path_1.default.dirname(filePath.replace(regex, ''));
-    const baseName = path_1.default.basename(filePath);
-    const inModuleFolder = (0, modules_1.isModuleFolderChild)({ path: filePath, isLocal: true });
-    return !!(convertFields &&
-        allowedFieldsNames.includes(baseName) &&
-        (inModuleFolder || relativePath == '/'));
-}
-exports.isConvertableFieldJs = isConvertableFieldJs;
-// Try creating tempdir
-function createTmpDirSync(prefix) {
-    let tmpDir;
-    try {
-        tmpDir = fs_extra_1.default.mkdtempSync(path_1.default.join(os_1.default.tmpdir(), prefix));
-    }
-    catch (err) {
-        (0, standardErrors_1.throwErrorWithMessage)(`${i18nKey}.createTmpDirSync`, {}, err);
-    }
-    return tmpDir;
-}
-exports.createTmpDirSync = createTmpDirSync;
-// Try cleaning up resources from os's tempdir
-function cleanupTmpDirSync(tmpDir) {
-    fs_extra_1.default.rm(tmpDir, { recursive: true }, err => {
-        if (err) {
-            (0, standardErrors_1.throwErrorWithMessage)(`${i18nKey}.cleanupTmpDirSync`, {}, err);
-        }
-    });
-}
-exports.cleanupTmpDirSync = cleanupTmpDirSync;

package/src/utils/interpolation.d.ts

@@ -1,5 +0,0 @@
-type InterpolationData = {
-    [identifier: string]: string | number;
-};
-export declare function interpolate(stringValue: string, interpolationData: InterpolationData): string;
-export {};

package/src/utils/interpolation.js

@@ -1,31 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.interpolate = void 0;
-const delimiters = {
-    interpolation: {
-        start: '{{',
-        end: '}}',
-    },
-};
-function generateReplaceFn(matchedText, startIndex, replacementString) {
-    return function (currentStringValue) {
-        return `${currentStringValue.slice(0, startIndex)}${replacementString || ''}${currentStringValue.slice(startIndex + matchedText.length)}`;
-    };
-}
-function interpolate(stringValue, interpolationData) {
-    const interpolationIdentifierRegEx = new RegExp(`${delimiters.interpolation.start}(.*?)${delimiters.interpolation.end}`, 'g');
-    const replaceQueue = [];
-    let match;
-    // while & reduce necessary because RegExp.exec is stateful and only runs
-    // from beginning to end of string
-    while ((match = interpolationIdentifierRegEx.exec(stringValue)) != null) {
-        const { 0: matchedText, 1: rawIdentifier, index } = match;
-        const identifier = rawIdentifier.trim();
-        if (identifier) {
-            replaceQueue.unshift(generateReplaceFn(matchedText, index, interpolationData[identifier]));
-        }
-    }
-    const compiledString = replaceQueue.reduce((currentValue, replaceFn) => replaceFn(currentValue), stringValue);
-    return compiledString;
-}
-exports.interpolate = interpolate;

package/src/utils/lang.d.ts

@@ -1,8 +0,0 @@
-type InterpolationData = {
-    [identifier: string]: string | number;
-};
-export declare function interpolate(stringValue: string, interpolationData: InterpolationData): string;
-export declare function i18n(lookupDotNotation: string, options?: {
-    [identifier: string]: string | number;
-}): string;
-export {};

package/src/utils/lang.js

@@ -1,83 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.i18n = exports.interpolate = void 0;
-const path_1 = require("path");
-const fs_extra_1 = require("fs-extra");
-const js_yaml_1 = require("js-yaml");
-const MISSING_LANGUAGE_DATA_PREFIX = '[Missing language data]';
-let locale = '';
-let languageObj;
-function loadLanguageFromYaml() {
-    if (languageObj)
-        return;
-    try {
-        const nodeLocale = Intl.DateTimeFormat()
-            .resolvedOptions()
-            .locale.split('-')[0];
-        const languageFilePath = (0, path_1.join)(__dirname, `../lang/${nodeLocale}.lyaml`);
-        const languageFileExists = (0, fs_extra_1.existsSync)(languageFilePath);
-        // Fall back to using the default language file
-        locale = languageFileExists ? nodeLocale : 'en';
-        languageObj = (0, js_yaml_1.load)((0, fs_extra_1.readFileSync)((0, path_1.join)(__dirname, `../lang/${locale}.lyaml`), 'utf8'));
-    }
-    catch (e) {
-        throw new Error(`Error loading language data: ${e}`);
-    }
-}
-function getTextValue(lookupDotNotation) {
-    const lookupProps = [locale, ...lookupDotNotation.split('.')];
-    const missingTextData = `${MISSING_LANGUAGE_DATA_PREFIX}: ${lookupProps.join('.')}`;
-    let textValue = languageObj;
-    let previouslyCheckedProp = lookupProps[0];
-    lookupProps.forEach(prop => {
-        previouslyCheckedProp = prop;
-        if (typeof textValue === 'object') {
-            textValue = textValue[prop];
-        }
-        else {
-            console.debug(`Unable to access language property: ${lookupProps.join('.')}. Failed to access prop "${previouslyCheckedProp}".`);
-        }
-    });
-    if (typeof textValue !== 'string') {
-        return missingTextData;
-    }
-    return textValue;
-}
-const delimiters = {
-    interpolation: {
-        start: '{{',
-        end: '}}',
-    },
-};
-function generateReplaceFn(matchedText, startIndex, replacementString) {
-    return function (currentStringValue) {
-        return `${currentStringValue.slice(0, startIndex)}${replacementString || ''}${currentStringValue.slice(startIndex + matchedText.length)}`;
-    };
-}
-function interpolate(stringValue, interpolationData) {
-    const interpolationIdentifierRegEx = new RegExp(`${delimiters.interpolation.start}(.*?)${delimiters.interpolation.end}`, 'g');
-    const replaceQueue = [];
-    let match;
-    // while & reduce necessary because RegExp.exec is stateful and only runs
-    // from beginning to end of string
-    while ((match = interpolationIdentifierRegEx.exec(stringValue)) != null) {
-        const { 0: matchedText, 1: rawIdentifier, index } = match;
-        const identifier = rawIdentifier.trim();
-        if (identifier) {
-            replaceQueue.unshift(generateReplaceFn(matchedText, index, interpolationData[identifier]));
-        }
-    }
-    const compiledString = replaceQueue.reduce((currentValue, replaceFn) => replaceFn(currentValue), stringValue);
-    return compiledString;
-}
-exports.interpolate = interpolate;
-function i18n(lookupDotNotation, options = {}) {
-    if (typeof lookupDotNotation !== 'string') {
-        throw new Error(`i18n must be passed a string value for lookupDotNotation, received ${typeof lookupDotNotation}`);
-    }
-    const textValue = getTextValue(lookupDotNotation);
-    const shouldInterpolate = !textValue.startsWith(MISSING_LANGUAGE_DATA_PREFIX);
-    return shouldInterpolate ? interpolate(textValue, options) : textValue;
-}
-exports.i18n = i18n;
-loadLanguageFromYaml();

package/src/utils/logger.d.ts

@@ -1,10 +0,0 @@
-import { LogCallbacks } from '../types/LogCallbacks';
-export declare function log<T extends string>(key: T, callbacks?: LogCallbacks<T>, debugKey?: string, debugInterpolation?: {
-    [key: string]: string | number;
-}): void;
-export declare function makeTypedLogger<T extends readonly string[]>(callbacks?: LogCallbacks<T[number]>, debugKey?: string): (key: T[number], debugInterpolation?: {
-    [key: string]: string | number;
-} | undefined) => void;
-export declare function debug(identifier: string, interpolation?: {
-    [key: string]: string | number;
-}): void;

package/src/utils/logger.js

@@ -1,22 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.debug = exports.makeTypedLogger = exports.log = void 0;
-const lang_1 = require("./lang");
-function log(key, callbacks, debugKey, debugInterpolation) {
-    if (callbacks && callbacks[key]) {
-        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-        callbacks[key]();
-    }
-    else if (debugKey) {
-        debug(debugKey, debugInterpolation);
-    }
-}
-exports.log = log;
-function makeTypedLogger(callbacks, debugKey) {
-    return (key, debugInterpolation) => log(key, callbacks, `${debugKey}.${key}`, debugInterpolation);
-}
-exports.makeTypedLogger = makeTypedLogger;
-function debug(identifier, interpolation) {
-    console.debug((0, lang_1.i18n)(`debug.${identifier}`, interpolation));
-}
-exports.debug = debug;

package/src/utils/text.d.ts

@@ -1 +0,0 @@
-export declare function commaSeparatedValues(arr: Array<string>, conjunction?: string, ifempty?: string): string;

package/src/utils/text.js

@@ -1,16 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.commaSeparatedValues = void 0;
-function commaSeparatedValues(arr, conjunction = 'and', ifempty = '') {
-    const l = arr.length;
-    if (!l)
-        return ifempty;
-    if (l < 2)
-        return arr[0];
-    if (l < 3)
-        return arr.join(` ${conjunction} `);
-    arr = arr.slice();
-    arr[l - 1] = `${conjunction} ${arr[l - 1]}`;
-    return arr.join(', ');
-}
-exports.commaSeparatedValues = commaSeparatedValues;

package/src/utils/urls.d.ts

@@ -1,2 +0,0 @@
-export declare const getHubSpotWebsiteOrigin: (env: string) => string;
-export declare function getHubSpotApiOrigin(env?: string, useLocalHost?: boolean): string;

package/src/utils/urls.js

@@ -1,20 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getHubSpotApiOrigin = exports.getHubSpotWebsiteOrigin = void 0;
-const environments_1 = require("../constants/environments");
-function getEnvUrlString(env) {
-    if (typeof env !== 'string') {
-        return '';
-    }
-    return env.toLowerCase() === environments_1.ENVIRONMENTS.QA ? environments_1.ENVIRONMENTS.QA : '';
-}
-const getHubSpotWebsiteOrigin = (env) => `https://app.hubspot${getEnvUrlString(env)}.com`;
-exports.getHubSpotWebsiteOrigin = getHubSpotWebsiteOrigin;
-function getHubSpotApiOrigin(env, useLocalHost) {
-    let domain = process.env.HUBAPI_DOMAIN_OVERRIDE;
-    if (!domain || typeof domain !== 'string') {
-        domain = `${useLocalHost ? 'local' : 'api'}.hubapi${getEnvUrlString(env)}`;
-    }
-    return `https://${domain}.com`;
-}
-exports.getHubSpotApiOrigin = getHubSpotApiOrigin;

package/utils/encoding.d.ts

@@ -1 +0,0 @@
-export declare function base64EncodeString(valueToEncode: string): string;

package/utils/encoding.js

@@ -1,11 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.base64EncodeString = void 0;
-function base64EncodeString(valueToEncode) {
-    if (typeof valueToEncode !== 'string') {
-        return valueToEncode;
-    }
-    const stringBuffer = Buffer.from(valueToEncode);
-    return encodeURIComponent(stringBuffer.toString('base64'));
-}
-exports.base64EncodeString = base64EncodeString;

package/utils/environment.d.ts

@@ -1 +0,0 @@
-export declare function getValidEnv(env: string, maskedProductionValue?: string): string;

package/utils/environment.js

@@ -1,16 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getValidEnv = void 0;
-const environments_1 = require("../constants/environments");
-function getValidEnv(env, maskedProductionValue) {
-    const prodValue = maskedProductionValue
-        ? maskedProductionValue
-        : environments_1.ENVIRONMENTS.PROD;
-    const returnVal = typeof env &&
-        typeof env === 'string' &&
-        env.toLowerCase() === environments_1.ENVIRONMENTS.QA
-        ? environments_1.ENVIRONMENTS.QA
-        : prodValue;
-    return returnVal;
-}
-exports.getValidEnv = getValidEnv;

package/utils/interpolation.d.ts

@@ -1,5 +0,0 @@
-type InterpolationData = {
-    [identifier: string]: string | number;
-};
-export declare function interpolate(stringValue: string, interpolationData: InterpolationData): string;
-export {};

package/utils/interpolation.js

@@ -1,31 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.interpolate = void 0;
-const delimiters = {
-    interpolation: {
-        start: '{{',
-        end: '}}',
-    },
-};
-function generateReplaceFn(matchedText, startIndex, replacementString) {
-    return function (currentStringValue) {
-        return `${currentStringValue.slice(0, startIndex)}${replacementString || ''}${currentStringValue.slice(startIndex + matchedText.length)}`;
-    };
-}
-function interpolate(stringValue, interpolationData) {
-    const interpolationIdentifierRegEx = new RegExp(`${delimiters.interpolation.start}(.*?)${delimiters.interpolation.end}`, 'g');
-    const replaceQueue = [];
-    let match;
-    // while & reduce necessary because RegExp.exec is stateful and only runs
-    // from beginning to end of string
-    while ((match = interpolationIdentifierRegEx.exec(stringValue)) != null) {
-        const { 0: matchedText, 1: rawIdentifier, index } = match;
-        const identifier = rawIdentifier.trim();
-        if (identifier) {
-            replaceQueue.unshift(generateReplaceFn(matchedText, index, interpolationData[identifier]));
-        }
-    }
-    const compiledString = replaceQueue.reduce((currentValue, replaceFn) => replaceFn(currentValue), stringValue);
-    return compiledString;
-}
-exports.interpolate = interpolate;

package/utils/text.d.ts

@@ -1 +0,0 @@
-export declare function commaSeparatedValues(arr: Array<string>, conjunction?: string, ifempty?: string): string;

package/utils/text.js

@@ -1,16 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.commaSeparatedValues = void 0;
-function commaSeparatedValues(arr, conjunction = 'and', ifempty = '') {
-    const l = arr.length;
-    if (!l)
-        return ifempty;
-    if (l < 2)
-        return arr[0];
-    if (l < 3)
-        return arr.join(` ${conjunction} `);
-    arr = arr.slice();
-    arr[l - 1] = `${conjunction} ${arr[l - 1]}`;
-    return arr.join(', ');
-}
-exports.commaSeparatedValues = commaSeparatedValues;