@hubspot/local-dev-lib 0.0.2 → 0.0.4

package/lib/gitignore.js

@@ -0,0 +1,76 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.checkAndAddConfigToGitignore = void 0;
+const fs_extra_1 = require("fs-extra");
+const path_1 = __importDefault(require("path"));
+const findup_sync_1 = __importDefault(require("findup-sync"));
+const git_1 = require("../utils/git");
+const config_1 = require("../constants/config");
+const standardErrors_1 = require("../errors/standardErrors");
+const GITIGNORE_FILE = '.gitignore';
+// Get all .gitignore files since they can cascade down directory structures
+function getGitignoreFiles(configPath) {
+    const gitDir = (0, git_1.getGitComparisonDir)();
+    const files = [];
+    if (!gitDir) {
+        // Not in git
+        return files;
+    }
+    // Start findup from config dir
+    let cwd = configPath && path_1.default.dirname(configPath);
+    while (cwd) {
+        const ignorePath = (0, findup_sync_1.default)(GITIGNORE_FILE, { cwd });
+        const ignorePathComparisonDir = (0, git_1.makeComparisonDir)(ignorePath);
+        const gitComparisonDir = (0, git_1.makeComparisonDir)(gitDir);
+        if (ignorePath &&
+            ignorePathComparisonDir &&
+            gitComparisonDir &&
+            ignorePathComparisonDir.startsWith(gitComparisonDir)) {
+            const file = path_1.default.resolve(ignorePath);
+            files.push(file);
+            cwd = path_1.default.resolve(path_1.default.dirname(file) + '..');
+        }
+        else {
+            cwd = null;
+        }
+    }
+    return files;
+}
+function checkGitInclusion(configPath) {
+    const result = {
+        inGit: false,
+        configIgnored: false,
+        gitignoreFiles: [],
+    };
+    if ((0, git_1.isConfigPathInGitRepo)(configPath)) {
+        result.inGit = true;
+        result.gitignoreFiles = getGitignoreFiles(configPath);
+        if ((0, git_1.configFilenameIsIgnoredByGitignore)(result.gitignoreFiles, configPath)) {
+            // Found ignore statement in .gitignore that matches config filename
+            result.configIgnored = true;
+        }
+    }
+    return result;
+}
+function checkAndAddConfigToGitignore(configPath) {
+    try {
+        const { configIgnored, gitignoreFiles } = checkGitInclusion(configPath);
+        if (configIgnored)
+            return;
+        let gitignoreFilePath = gitignoreFiles && gitignoreFiles.length ? gitignoreFiles[0] : null;
+        if (!gitignoreFilePath) {
+            gitignoreFilePath = path_1.default.resolve(configPath, GITIGNORE_FILE);
+            (0, fs_extra_1.writeFileSync)(gitignoreFilePath, '');
+        }
+        const gitignoreContents = (0, fs_extra_1.readFileSync)(gitignoreFilePath).toString();
+        const updatedContents = `${gitignoreContents.trim()}\n\n# HubSpot config file\n${config_1.DEFAULT_HUBSPOT_CONFIG_YAML_FILE_NAME}\n`;
+        (0, fs_extra_1.writeFileSync)(gitignoreFilePath, updatedContents);
+    }
+    catch (e) {
+        (0, standardErrors_1.throwErrorWithMessage)('utils.git.configIgnore', {}, e);
+    }
+}
+exports.checkAndAddConfigToGitignore = checkAndAddConfigToGitignore;

package/lib/index.d.ts

@@ -0,0 +1,11 @@
+import { extractZipArchive as __extractZipArchive } from './archive';
+import { getValidEnv as __getValidEnv } from './environment';
+import { walk as __walk } from './fs';
+import { commaSeparatedValues as __commaSeparatedValues } from './text';
+import { getHubSpotApiOrigin as __getHubSpotApiOrigin } from './urls';
+export declare const extractZipArchive: typeof __extractZipArchive;
+export declare const getValidEnv: typeof __getValidEnv;
+export declare const walk: typeof __walk;
+export declare const commaSeparatedValues: typeof __commaSeparatedValues;
+export declare const getHubSpotApiOrigin: typeof __getHubSpotApiOrigin;
+export declare const getHubSpotWebsiteOrigin: (env: string) => string;

package/lib/index.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getHubSpotWebsiteOrigin = exports.getHubSpotApiOrigin = exports.commaSeparatedValues = exports.walk = exports.getValidEnv = exports.extractZipArchive = void 0;
+const archive_1 = require("./archive");
+const environment_1 = require("./environment");
+const fs_1 = require("./fs");
+const text_1 = require("./text");
+const urls_1 = require("./urls");
+exports.extractZipArchive = archive_1.extractZipArchive;
+exports.getValidEnv = environment_1.getValidEnv;
+exports.walk = fs_1.walk;
+exports.commaSeparatedValues = text_1.commaSeparatedValues;
+exports.getHubSpotApiOrigin = urls_1.getHubSpotApiOrigin;
+exports.getHubSpotWebsiteOrigin = urls_1.getHubSpotWebsiteOrigin;

package/lib/path.d.ts

@@ -0,0 +1,10 @@
+/// <reference types="node" />
+import path from 'path';
+export declare function convertToUnixPath(_path: string): string;
+export declare function convertToLocalFileSystemPath(_path: string): string;
+export declare function splitLocalPath(filepath: string, pathImplementation?: path.PlatformPath): Array<string>;
+export declare function splitHubSpotPath(filepath: string): Array<string>;
+export declare function getCwd(): string;
+export declare function getExt(filepath: string): string;
+export declare function isAllowedExtension(filepath: string): boolean;
+export declare function getAbsoluteFilePath(_path: string): string;

package/lib/path.js

@@ -0,0 +1,84 @@
+"use strict";
+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.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");
+function convertToUnixPath(_path) {
+    return (0, unixify_1.default)(path_1.default.normalize(_path));
+}
+exports.convertToUnixPath = convertToUnixPath;
+function convertToWindowsPath(_path) {
+    const rgx = new RegExp(`\\${path_1.default.posix.sep}`, 'g');
+    return path_1.default.normalize(_path).replace(rgx, path_1.default.win32.sep);
+}
+function convertToLocalFileSystemPath(_path) {
+    switch (path_1.default.sep) {
+        case path_1.default.posix.sep:
+            return convertToUnixPath(_path);
+        case path_1.default.win32.sep:
+            return convertToWindowsPath(_path);
+        default:
+            return path_1.default.normalize(_path);
+    }
+}
+exports.convertToLocalFileSystemPath = convertToLocalFileSystemPath;
+function removeTrailingSlashFromSplits(parts) {
+    if (parts.length > 1 && parts[parts.length - 1] === '') {
+        return parts.slice(0, parts.length - 1);
+    }
+    return parts;
+}
+// Splits a filepath for local file system sources.
+function splitLocalPath(filepath, pathImplementation = path_1.default) {
+    if (!filepath)
+        return [];
+    const { sep } = pathImplementation;
+    const rgx = new RegExp(`\\${sep}+`, 'g');
+    const parts = pathImplementation.normalize(filepath).split(rgx);
+    // Restore posix root if present
+    if (sep === path_1.default.posix.sep && parts[0] === '') {
+        parts[0] = '/';
+    }
+    return removeTrailingSlashFromSplits(parts);
+}
+exports.splitLocalPath = splitLocalPath;
+// Splits a filepath for remote sources (HubSpot).
+function splitHubSpotPath(filepath) {
+    if (!filepath)
+        return [];
+    const rgx = new RegExp(`\\${path_1.default.posix.sep}+`, 'g');
+    const parts = convertToUnixPath(filepath).split(rgx);
+    // Restore root if present
+    if (parts[0] === '') {
+        parts[0] = '/';
+    }
+    return removeTrailingSlashFromSplits(parts);
+}
+exports.splitHubSpotPath = splitHubSpotPath;
+function getCwd() {
+    if (process.env.INIT_CWD) {
+        return process.env.INIT_CWD;
+    }
+    return process.cwd();
+}
+exports.getCwd = getCwd;
+function getExt(filepath) {
+    if (typeof filepath !== 'string')
+        return '';
+    const ext = path_1.default.extname(filepath).trim().toLowerCase();
+    return ext[0] === '.' ? ext.slice(1) : ext;
+}
+exports.getExt = getExt;
+function isAllowedExtension(filepath) {
+    const ext = getExt(filepath);
+    return extensions_1.ALLOWED_EXTENSIONS.has(ext);
+}
+exports.isAllowedExtension = isAllowedExtension;
+function getAbsoluteFilePath(_path) {
+    return path_1.default.resolve(getCwd(), _path);
+}
+exports.getAbsoluteFilePath = getAbsoluteFilePath;

package/lib/text.d.ts

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

package/lib/text.js

@@ -0,0 +1,16 @@
+"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/lib/urls.d.ts

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

package/lib/urls.js

@@ -0,0 +1,20 @@
+"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/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@hubspot/local-dev-lib",
-    "version": "0.0.2",
+    "version": "0.0.4",
     "description": "Provides library functionality for HubSpot local development tooling, including the HubSpot CLI",
     "main": "dist/index.js",
     "repository": {
@@ -14,12 +14,12 @@
     "scripts": {
         "build": "tsc --rootDir . --outdir dist",
         "check-main": "branch=$(git rev-parse --abbrev-ref HEAD) && [ $branch = main ] || (echo 'Error: New release can only be published on main branch' && exit 1)",
-        "lint": "eslint --max-warnings=0 . && prettier --check src/**/*.ts",
+        "lint": "eslint --max-warnings=0 . && prettier --check ./**/*.ts",
         "local-dev": "yarn build && cd dist && yarn link && cd .. && tsc --watch --rootDir . --outdir dist",
         "_postinstall": "husky install",
         "prepack": "pinst --disable",
         "postpack": "pinst --enable",
-        "prettier:write": "prettier --write src/**/*.{js,json}",
+        "prettier:write": "prettier --write ./**/*.{js,json}",
         "pub": "cd dist && npm publish --tag latest && cd ..",
         "push": "git push --atomic origin main v$npm_package_version",
         "release:major": "yarn check-main && yarn version --major && yarn build && yarn pub && yarn push",
@@ -45,15 +45,12 @@
         "ts-jest": "^29.0.5",
         "typescript": "^4.9.5"
     },
-    "files": [
-        "dist/**/*"
-    ],
     "exports": {
-        ".": "./dist/lib/index.js",
-        "./cms": "./dist/lib/cms",
-        "./constants": "./dist/constants.js",
-        "./github": "./dist/lib/github.js",
-        "./path": "./dist/lib/path.js"
+        ".": "./lib/index.js",
+        "./cms": "./lib/cms",
+        "./constants": "./constants",
+        "./github": "./lib/github.js",
+        "./path": "./lib/path.js"
     },
     "dependencies": {
         "axios": "^1.3.5",

package/types/Accounts.d.ts

@@ -0,0 +1,50 @@
+import { DEFAULT_MODES } from '../constants/config';
+import { ValueOf } from './Utils';
+export type AuthType = 'personalaccesskey' | 'apikey' | 'oauth2';
+export interface CLIAccount {
+    name?: string;
+    accountId: number;
+    defaultMode?: ValueOf<typeof DEFAULT_MODES>;
+    env?: string;
+    authType?: AuthType;
+    auth?: object;
+    sandboxAccountType?: string | null;
+    parentAccountId?: number | null;
+    apiKey?: string;
+    personalAccessKey?: string;
+}
+export type PersonalAccessKeyTokenInfo = {
+    accessToken: string;
+    expiresAt: string;
+};
+export type OauthTokenInfo = {
+    refreshToken?: string;
+};
+export interface PersonalAccessKeyAccount extends CLIAccount {
+    authType: 'personalaccesskey';
+    auth?: {
+        tokenInfo: PersonalAccessKeyTokenInfo;
+    };
+    personalAccessKey: string;
+}
+export interface OAuthAccount extends CLIAccount {
+    authType: 'oauth2';
+    auth?: {
+        clientId?: string;
+        clientSecret?: string;
+        scopes?: Array<string>;
+        tokenInfo?: OauthTokenInfo;
+    };
+}
+export interface APIKeyAccount extends CLIAccount {
+    authType: 'apikey';
+    apiKey: string;
+}
+export interface FlatAccountFields<T extends OauthTokenInfo | PersonalAccessKeyTokenInfo> extends CLIAccount {
+    tokenInfo?: T;
+    clientId?: string;
+    clientSecret?: string;
+    scopes?: Array<string>;
+    apiKey?: string;
+    personalAccessKey?: string;
+}

package/types/Accounts.js

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

package/types/CLIOptions.d.ts

@@ -0,0 +1,3 @@
+export interface CLIOptions {
+    useEnv?: boolean;
+}

package/types/CLIOptions.js

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

package/types/Config.d.ts

@@ -0,0 +1,10 @@
+import { CLIAccount } from './Accounts';
+export interface CLIConfig {
+    accounts: Array<CLIAccount>;
+    allowUsageTracking?: boolean;
+    defaultAccount?: string | number;
+    defaultMode?: string;
+    httpTimeout?: number;
+    env?: string;
+    httpUseLocalhost?: boolean;
+}

package/types/Config.js

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

package/types/Error.d.ts

@@ -0,0 +1,31 @@
+export interface BaseError extends Error {
+    name: string;
+    message: string;
+    errno?: number | null;
+    code?: string | null;
+    syscall?: string | null;
+    reason?: string;
+    statusCode?: number;
+}
+export interface StatusCodeError extends BaseError {
+    name: 'StatusCodeError';
+    statusCode: number;
+    message: string;
+    response: {
+        request: {
+            href: string;
+            method: string;
+        };
+        body: {
+            [key: string]: string;
+        };
+        headers: {
+            [key: string]: string;
+        };
+    };
+}
+export interface GithubError extends BaseError {
+    error: {
+        message?: string;
+    };
+}

package/types/Error.js

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

package/types/Files.d.ts

@@ -0,0 +1,8 @@
+import { ValueOf } from '../types/Utils';
+import { STAT_TYPES } from '../constants/files';
+export type StatType = ValueOf<typeof STAT_TYPES>;
+export type FileData = {
+    filepath: string;
+    files?: Array<string>;
+    type: StatType;
+};

package/types/Files.js

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

package/types/Github.d.ts

@@ -0,0 +1,58 @@
+type GithubAuthor = {
+    login: string;
+    id: number;
+    node_id: string;
+    avatar_url: string;
+    gravatar_id: string;
+    url: string;
+    html_url: string;
+    followers_url: string;
+    following_url: string;
+    gists_url: string;
+    starred_url: string;
+    subscriptions_url: string;
+    organizations_url: string;
+    repos_url: string;
+    events_url: string;
+    received_events_url: string;
+    type: string;
+    site_admin: boolean;
+};
+export type GithubReleaseData = {
+    url: string;
+    assets_url: string;
+    upload_url: string;
+    html_url: string;
+    id: number;
+    author: GithubAuthor;
+    node_id: string;
+    tag_name: string;
+    target_commitish: string;
+    name: string;
+    draft: boolean;
+    prerelease: boolean;
+    created_at: string;
+    published_at: string;
+    assets: Array<object>;
+    tarball_url: string;
+    zipball_url: string;
+    body: string;
+    mentions_count: number;
+};
+export type GithubRepoFile = {
+    name: string;
+    path: string;
+    sha: string;
+    size: number;
+    url: string;
+    html_url: string;
+    git_url: string;
+    download_url: string;
+    type: string;
+    _links: {
+        self: string;
+        git: string;
+        html: string;
+    };
+};
+export {};

package/types/Github.js

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

package/types/LogCallbacks.d.ts

@@ -0,0 +1,6 @@
+export type LogCallbacks<T extends string> = {
+    [key in T]?: () => void;
+};
+export type LogCallbacksArg<T extends readonly string[]> = {
+    [key in T[number]]?: () => void;
+};

package/types/LogCallbacks.js

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

package/types/Modules.d.ts

@@ -0,0 +1,5 @@
+export type PathInput = {
+    isLocal?: boolean;
+    isHubSpot?: boolean;
+    path: string;
+};

package/types/Modules.js

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

package/types/Utils.d.ts

@@ -0,0 +1 @@
+export type ValueOf<T> = T[keyof T];

package/types/Utils.js

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

package/utils/escapeRegExp.d.ts

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

package/utils/escapeRegExp.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.escapeRegExp = void 0;
+function escapeRegExp(string) {
+    return string.replace(/[.*+?^${}()|[\]\\]/g, '\\$&'); // $& means the whole matched string
+}
+exports.escapeRegExp = escapeRegExp;

package/utils/fieldsJS.d.ts

@@ -0,0 +1,3 @@
+type FieldsArray<T> = Array<T | FieldsArray<T>>;
+export declare function fieldsArrayToJson<T>(fields: FieldsArray<T>): string;
+export {};

package/utils/fieldsJS.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fieldsArrayToJson = void 0;
+/*
+ * 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;

package/utils/git.d.ts

@@ -0,0 +1,4 @@
+export declare function makeComparisonDir(filepath: string | null): string | null;
+export declare const getGitComparisonDir: () => string | null;
+export declare function isConfigPathInGitRepo(configPath: string): boolean;
+export declare function configFilenameIsIgnoredByGitignore(ignoreFiles: Array<string>, configPath: string): boolean;

package/utils/git.js

@@ -0,0 +1,40 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.configFilenameIsIgnoredByGitignore = exports.isConfigPathInGitRepo = exports.getGitComparisonDir = exports.makeComparisonDir = void 0;
+const fs_extra_1 = require("fs-extra");
+const path_1 = __importDefault(require("path"));
+const ignore_1 = __importDefault(require("ignore"));
+const findup_sync_1 = __importDefault(require("findup-sync"));
+function makeComparisonDir(filepath) {
+    if (typeof filepath !== 'string')
+        return null;
+    // Append sep to make comparisons easier e.g. 'foos'.startsWith('foo')
+    return path_1.default.dirname(path_1.default.resolve(filepath)).toLowerCase() + path_1.default.sep;
+}
+exports.makeComparisonDir = makeComparisonDir;
+const getGitComparisonDir = () => makeComparisonDir((0, findup_sync_1.default)('.git'));
+exports.getGitComparisonDir = getGitComparisonDir;
+function isConfigPathInGitRepo(configPath) {
+    const gitDir = (0, exports.getGitComparisonDir)();
+    if (!gitDir)
+        return false;
+    const configDir = makeComparisonDir(configPath);
+    if (!configDir)
+        return false;
+    return configDir.startsWith(gitDir);
+}
+exports.isConfigPathInGitRepo = isConfigPathInGitRepo;
+function configFilenameIsIgnoredByGitignore(ignoreFiles, configPath) {
+    return ignoreFiles.some(gitignore => {
+        const gitignoreContents = (0, fs_extra_1.readFileSync)(gitignore).toString();
+        const gitignoreConfig = (0, ignore_1.default)().add(gitignoreContents);
+        if (gitignoreConfig.ignores(path_1.default.relative(path_1.default.dirname(gitignore), configPath))) {
+            return true;
+        }
+        return false;
+    });
+}
+exports.configFilenameIsIgnoredByGitignore = configFilenameIsIgnoredByGitignore;

package/utils/lang.d.ts

@@ -0,0 +1,8 @@
+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 {};