@hubspot/local-dev-lib 0.3.14 → 0.4.0-experimental.0

package/types/FieldsJS.js

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

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;
     };
@@ -69,3 +68,4 @@ export type FetchFolderResponse = {
     objects: Array<Folder>;
     total_count: number;
 };
+export type SimplifiedFolder = Partial<Folder> & Pick<Folder, 'id' | 'name'>;

package/types/Files.d.ts

@@ -1,8 +1,8 @@
-import { AxiosError } from 'axios';
 import { ValueOf } from '../types/Utils';
 import { STAT_TYPES, FILE_TYPES, FILE_UPLOAD_RESULT_TYPES } from '../constants/files';
-import { MODE } from '../constants/files';
+import { CMS_PUBLISH_MODE } from '../constants/files';
 import { HttpOptions } from './Http';
+import { AxiosError } from 'axios';
 export type StatType = ValueOf<typeof STAT_TYPES>;
 export type FileData = {
     filepath: string;
@@ -18,7 +18,7 @@ export type FileMapperNode = {
     folder: boolean;
     children: Array<FileMapperNode>;
 };
-export type Mode = ValueOf<typeof MODE>;
+export type CmsPublishMode = ValueOf<typeof CMS_PUBLISH_MODE>;
 export type FileMapperOptions = Omit<HttpOptions, 'url'>;
 export type FileMapperInputOptions = {
     staging?: boolean;
@@ -29,7 +29,7 @@ export type FileType = ValueOf<typeof FILE_TYPES>;
 type ResultType = ValueOf<typeof FILE_UPLOAD_RESULT_TYPES>;
 export type UploadFolderResults = {
     resultType: ResultType;
-    error: AxiosError | null;
+    error: unknown;
     file: string;
 };
 export type FileTree = {
@@ -37,4 +37,43 @@ export type FileTree = {
     path: string;
     children: Array<FileTree>;
 };
+export type PathTypeData = {
+    isModule: boolean;
+    isHubspot: boolean;
+    isFile: boolean;
+    isRoot: boolean;
+    isFolder: boolean;
+};
+export type RecursiveFileMapperCallback = (node: FileMapperNode, filepath?: string, depth?: number) => boolean;
+export type CommandOptions = {
+    convertFields?: boolean;
+    fieldOptions?: string;
+    saveOutput?: boolean;
+    onAttemptCallback?: (file: string | undefined, destPath: string) => void;
+    onSuccessCallback?: (file: string | undefined, destPath: string) => void;
+    onFirstErrorCallback?: (file: string, destPath: string, error: unknown) => void;
+    onRetryCallback?: (file: string, destPath: string) => void;
+    onFinalErrorCallback?: (accountId: number, file: string, destPath: string, error: unknown) => void;
+};
+export type FilePathsByType = {
+    [key: string]: Array<string>;
+};
+export type UploadFileOptions = FileMapperInputOptions & {
+    src: string;
+    commandOptions: {
+        convertFields?: boolean;
+    };
+    fieldOptions?: string;
+};
+export type WatchOptions = {
+    cmsPublishMode?: CmsPublishMode;
+    remove?: boolean;
+    disableInitial?: boolean;
+    notify?: string;
+    commandOptions: {
+        convertFields?: boolean;
+    };
+    filePaths?: Array<string>;
+};
+export type WatchErrorHandler = (error: AxiosError) => void;
 export {};

package/types/FireAlarm.d.ts

@@ -0,0 +1,9 @@
+export type FireAlarm = {
+    id: number;
+    title: string;
+    message: string;
+    urlRegexPattern: string | null;
+    querySelector: string | null;
+    severity: string;
+    createdAt: number;
+};

package/types/FireAlarm.js

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

package/types/Functions.d.ts

@@ -37,4 +37,56 @@ export type GetBuildStatusResponse = {
     userId: number;
     deployId: number;
 };
+export type FunctionConfig = {
+    runtime: string;
+    version: string;
+    environment: object;
+    secrets: Array<string>;
+    endpoints: {
+        [key: string]: {
+            method: string;
+            file: string;
+        };
+    };
+};
+export type FunctionConfigInfo = {
+    endpointPath: string;
+    endpointMethod: string;
+    functionFile: string;
+};
+export type FunctionInfo = {
+    functionsFolder: string;
+    filename: string;
+    endpointPath: string;
+    endpointMethod: string;
+};
+export type FunctionOptions = {
+    allowExistingFile?: boolean;
+};
+export type FunctionLog = {
+    id: string;
+    executionTime: number;
+    log: string;
+    error: {
+        message: string;
+        type: string;
+        stackTrace: string[][];
+    };
+    status: string;
+    createdAt: number;
+    memory: string;
+};
+export type GetFunctionLogsResponse = {
+    results: FunctionLog[];
+    paging: {
+        next: {
+            after: string;
+            link: string;
+        };
+        prev: {
+            before: string;
+            link: string;
+        };
+    };
+};
 export {};

package/types/Github.d.ts

@@ -61,4 +61,17 @@ export interface GithubSourceData {
     repositoryName: string;
     source: string;
 }
+export type RepoPath = `${string}/${string}`;
+export type DownloadGithubRepoZipOptions = {
+    branch?: string;
+    tag?: string;
+};
+export type CloneGithubRepoOptions = {
+    isRelease?: boolean;
+    type?: string;
+    branch?: string;
+    tag?: string;
+    sourceDir?: string;
+    hideLogs?: boolean;
+};
 export {};

package/types/Http.d.ts

@@ -1,29 +1,30 @@
 /// <reference types="node" />
+/// <reference types="node" />
+/// <reference types="node" />
+/// <reference types="node" />
+import { AxiosPromise, ResponseType } from 'axios';
 import { ReadStream } from 'fs';
+import { Stream } from 'stream';
+export type HubSpotPromise<T = unknown> = AxiosPromise<T>;
 export type Data = {
     [key: string]: any;
 };
 export type QueryParams = {
     [key: string]: string | number | boolean | undefined;
 };
-export type AxiosConfigOptions = {
+export type FormData = {
+    [key: string]: string | ReadStream;
+};
+export type HttpOptions = {
     baseURL?: string;
     url: string;
     env?: string;
     localHostOverride?: boolean;
-    params?: QueryParams;
-    data?: Data;
+    data?: Data | string | ArrayBuffer | ArrayBufferView | URLSearchParams | Stream | Buffer;
     resolveWithFullResponse?: boolean;
-    timeout?: number;
-    headers?: Data;
-};
-export type FormData = {
-    [key: string]: string | ReadStream;
-};
-export type HttpOptions = AxiosConfigOptions & {
     params?: QueryParams;
     timeout?: number;
-    responseType?: string;
+    responseType?: ResponseType;
     headers?: {
         [header: string]: string | string[] | undefined;
     };

package/types/Hubdb.d.ts

@@ -98,3 +98,12 @@ export type FetchRowsResponse = {
         };
     } | null;
 };
+export type FetchTablesResponse = {
+    total: number;
+    results: Array<Table>;
+    paging?: {
+        next: {
+            after: string | null;
+        };
+    } | null;
+};

package/types/MarketplaceValidation.d.ts

@@ -1,4 +1,4 @@
-type Check = {
+export type Check = {
     check: string;
     status: string;
     title: string;
@@ -8,6 +8,11 @@ type Check = {
     line: number | null;
     file: string;
 };
+export interface ValidationError {
+    validationRequestId: number;
+    failureReasonType: string;
+    context: string;
+}
 export type GetValidationResultsResponse = {
     validationRequestId: number;
     assetPath: string;
@@ -22,7 +27,6 @@ export type GetValidationResultsResponse = {
             results: Array<Check>;
         };
     };
-    errors: Array<Error>;
+    errors: Array<ValidationError>;
     requestedAt: string;
 };
-export {};

package/types/Migration.d.ts

@@ -0,0 +1,30 @@
+import { ValueOf } from './Utils';
+import { ProjectStandardError } from './Project';
+export declare const MIGRATION_STATUS: {
+    readonly BUILDING: "BUILDING";
+    readonly FAILURE: "FAILURE";
+    readonly PREPARING: "PREPARING";
+    readonly PENDING: "PENDING";
+    readonly SUCCESS: "SUCCESS";
+    readonly IN_PROGRESS: "IN_PROGRESS";
+    readonly INPUT_REQUIRED: "INPUT_REQUIRED";
+};
+export type MigrateAppResponse = {
+    id: number;
+    status: ValueOf<typeof MIGRATION_STATUS>;
+};
+export type CloneAppResponse = {
+    exportId: number;
+    status: ValueOf<typeof MIGRATION_STATUS>;
+};
+export type PollAppResponse = {
+    id: number;
+    project?: {
+        id: number;
+        name: string;
+        buildId: number;
+        deployId: number;
+    };
+    error: ProjectStandardError | null;
+    status: ValueOf<typeof MIGRATION_STATUS>;
+};

package/types/Migration.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MIGRATION_STATUS = void 0;
+exports.MIGRATION_STATUS = {
+    BUILDING: 'BUILDING',
+    FAILURE: 'FAILURE',
+    PREPARING: 'PREPARING',
+    PENDING: 'PENDING',
+    SUCCESS: 'SUCCESS',
+    IN_PROGRESS: 'IN_PROGRESS',
+    INPUT_REQUIRED: 'INPUT_REQUIRED',
+};

package/types/Modules.d.ts

@@ -3,3 +3,14 @@ export type PathInput = {
     isHubSpot?: boolean;
     path: string;
 };
+export type ValidationResult = {
+    id: string;
+    message: string;
+};
+export type ModuleDefinition = {
+    contentTypes: Array<string>;
+    moduleLabel: string;
+    reactType: boolean;
+    global: boolean;
+    availableForNewContent: boolean;
+};

package/types/PortManager.d.ts

@@ -2,3 +2,10 @@ export type RequestPortsData = {
     instanceId: string;
     port?: number;
 };
+export type NetError = Error & {
+    code: string;
+};
+export type ListenCallback = (error: NetError | null, port: number) => void;
+export type ServerPortMap = {
+    [instanceId: string]: number;
+};

package/types/Project.d.ts

@@ -1,5 +1,6 @@
 import { Build } from './Build';
 import { GithubSourceData } from './Github';
+import { ProjectLog } from './ProjectLog';
 export type Project = {
     createdAt: number;
     deletedAt: number;
@@ -33,6 +34,35 @@ export type UploadProjectResponse = {
         };
     };
 };
+export type UploadIRResponse = {
+    buildId?: number;
+    createdBuildId: number;
+};
 export type ProjectSettings = {
     isAutoDeployEnabled: boolean;
 };
+export type FetchPlatformVersionResponse = {
+    defaultPlatformVersion: string;
+    activePlatformVersions: Array<string>;
+};
+export type ProjectStandardError = {
+    status: string;
+    id?: string;
+    category: string;
+    subCategory?: string;
+    message?: string;
+    errors?: Array<{
+        message: string;
+        in?: string;
+        code?: string;
+        subcateogy?: string;
+        context: object;
+    }>;
+    context: object;
+    links: {
+        [key: string]: string;
+    };
+};
+export type WarnLogsResponse = {
+    logs: Array<ProjectLog>;
+};

package/types/Sandbox.d.ts

@@ -47,13 +47,13 @@ type MutationError = {
         };
     };
 };
-type TaskStatus = {
+type SyncMutationData = {
     numRequests: number;
     numSuccesses: number;
     errors: Array<TaskError>;
     mutationErrors: Array<MutationError>;
 };
-export type Task = {
+export type CompositeSyncTask = {
     id: string;
     parentHubId: number;
     sandboxHubId: number;
@@ -70,12 +70,29 @@ export type Task = {
     startedAt: string;
     completedAt: string;
     error: MutationError;
-    creates: TaskStatus;
-    updates: TaskStatus;
-    deletes: TaskStatus;
+    creates: SyncMutationData;
+    updates: SyncMutationData;
+    deletes: SyncMutationData;
     diffSummary: string;
     portableKeys: Array<string>;
 };
+export type SyncTask = {
+    id: string;
+    parentHubId: number;
+    sandboxHubId: number;
+    fromHubId: number;
+    toHubId: number;
+    command: string;
+    status: string;
+    result: string;
+    sandboxType: string;
+    requestedAt: string;
+    requestedByUserId: number;
+    requestedByUser: User;
+    startedAt: string;
+    completedAt: string;
+    tasks: Array<CompositeSyncTask>;
+};
 export type Sandbox = {
     sandboxHubId: number;
     parentHubId: number;
@@ -88,23 +105,7 @@ export type Sandbox = {
     domain: string;
     createdByUser: User;
     updatedByUser?: User | null;
-    lastSync?: {
-        id: string;
-        parentHubId: number;
-        sandboxHubId: number;
-        fromHubId: number;
-        toHubId: number;
-        command: string;
-        status: string;
-        result: string;
-        sandboxType: string;
-        requestedAt: string;
-        requestedByUserId: number;
-        requestedByUser: User;
-        startedAt: string;
-        completedAt: string;
-        tasks: Array<Task>;
-    };
+    lastSync?: SyncTask;
     currentUserHasAccess?: boolean;
     currentUserHasSuperAdminAccess?: boolean;
     requestAccessFrom?: User | null;
@@ -129,26 +130,14 @@ export type Usage = {
 export type SandboxUsageLimitsResponse = {
     usage: Usage;
 };
-export type SyncTask = {
+export type TaskRequestData = {
     type: string;
 };
 export type InitiateSyncResponse = {
     links: {
         status: string;
     };
-    sync: {
-        id: string;
-        parentHubId: number;
-        sandboxHubId: number;
-        fromHubId: number;
-        toHubId: number;
-        command: string;
-        status: string;
-        sandboxType: string;
-        requestedAt: string;
-        requestedByUserId: number;
-        tasks: Array<Task>;
-    };
+    sync: SyncTask;
     id: string;
 };
 export type SandboxType = {

package/types/Schemas.d.ts

@@ -25,3 +25,59 @@ export type Schema = {
 export type FetchSchemasResponse = {
     results: Array<Schema>;
 };
+export type CreateObjectsResponse = {
+    status: string;
+    startedAt: string;
+    completedAt: string;
+    results: Array<{
+        id: string;
+        properties: Array<any>;
+        createdAt: string;
+        updatedAt: string;
+        archived: boolean;
+    }>;
+};
+export type SchemaDefinition = {
+    allowsSensitiveProperties?: boolean;
+    associatedObjects?: Array<string>;
+    description?: string;
+    labels: {
+        plural: string;
+        singular: string;
+    };
+    searchableProperties?: Array<string>;
+    secondaryDisplayProperties?: Array<string>;
+    name: string;
+    primaryDisplayProperty?: string;
+    properties: [
+        {
+            isPrimaryDisplayLabel: true;
+            label: string;
+            name: string;
+        }
+    ];
+    requiredProperties: Array<string>;
+};
+export type ObjectDefinition = {
+    inputs: [
+        {
+            associations?: [
+                {
+                    types: [
+                        {
+                            associationCategory: string;
+                            associationTypeId: number;
+                        }
+                    ];
+                    to: {
+                        id: string;
+                    };
+                }
+            ];
+            objectWriteTraceId?: number;
+            properties: {
+                [key: string]: string;
+            };
+        }
+    ];
+};

package/types/Secrets.d.ts

@@ -0,0 +1,3 @@
+export type FetchSecretsResponse = {
+    results: Array<string>;
+};

package/types/Secrets.js

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

package/types/developerTestAccounts.d.ts

@@ -5,6 +5,17 @@ export type DeveloperTestAccount = {
     createdAt: string;
     updatedAt: string;
     status: string;
+    id: number;
+};
+export type CreateDeveloperTestAccountResponse = {
+    id: number;
+    accountName: string;
+    createdAt: string;
+    updatedAt: string;
+    trialEndsAt: string;
+    status: string;
+    currentUserHasAccess: boolean;
+    personalAccessKey: string;
 };
 export type FetchDeveloperTestAccountsResponse = {
     results: DeveloperTestAccount[];

package/utils/PortManagerServer.d.ts

@@ -1,11 +1,10 @@
 /// <reference types="node" />
 import { Express, Request, Response } from 'express';
 import { Server } from 'http';
-import { RequestPortsData } from '../types/PortManager';
-type ServerPortMap = {
-    [instanceId: string]: number;
-};
-declare class PortManagerServer {
+import { RequestPortsData, ServerPortMap } from '../types/PortManager';
+export declare const HEALTH_CHECK_PATH = "/port-manager-health-check";
+export declare const SERVICE_HEALTHY = "OK";
+declare class _PortManagerServer {
     app?: Express;
     server?: Server;
     serverPortMap: ServerPortMap;
@@ -25,5 +24,5 @@ declare class PortManagerServer {
     deleteServerInstance: (req: Request, res: Response) => void;
     closeServer: (req: Request, res: Response) => void;
 }
-declare const _default: PortManagerServer;
-export default _default;
+export declare const PortManagerServer: _PortManagerServer;
+export {};

package/utils/PortManagerServer.js

@@ -3,15 +3,18 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.PortManagerServer = exports.SERVICE_HEALTHY = exports.HEALTH_CHECK_PATH = void 0;
 const express_1 = __importDefault(require("express"));
 const cors_1 = __importDefault(require("cors"));
 const detectPort_1 = require("./detectPort");
 const ports_1 = require("../constants/ports");
-const standardErrors_1 = require("../errors/standardErrors");
+const errors_1 = require("../errors");
 const logger_1 = require("../lib/logger");
 const lang_1 = require("./lang");
 const i18nKey = 'utils.PortManagerServer';
-class PortManagerServer {
+exports.HEALTH_CHECK_PATH = '/port-manager-health-check';
+exports.SERVICE_HEALTHY = 'OK';
+class _PortManagerServer {
     app;
     server;
     serverPortMap;
@@ -20,7 +23,7 @@ class PortManagerServer {
     }
     async init() {
         if (this.app) {
-            (0, standardErrors_1.throwErrorWithMessage)(`${i18nKey}.errors.duplicateInstance`);
+            throw new Error((0, lang_1.i18n)(`${i18nKey}.errors.duplicateInstance`));
         }
         this.app = (0, express_1.default)();
         this.app.use(express_1.default.json());
@@ -28,15 +31,15 @@ class PortManagerServer {
         this.setupRoutes();
         try {
             this.server = await this.listen();
+            logger_1.logger.debug(this.server);
         }
         catch (e) {
-            const error = e;
-            if (error.code === 'EADDRINUSE') {
-                (0, standardErrors_1.throwErrorWithMessage)(`${i18nKey}.errors.portInUse`, {
+            if ((0, errors_1.isSystemError)(e) && e.code === 'EADDRINUSE') {
+                throw new Error((0, lang_1.i18n)(`${i18nKey}.errors.portInUse`, {
                     port: ports_1.PORT_MANAGER_SERVER_PORT,
-                }, error);
+                }), { cause: e });
             }
-            throw error;
+            throw e;
         }
     }
     reset() {
@@ -65,6 +68,9 @@ class PortManagerServer {
         this.app.post('/servers', this.assignPortsToServers);
         this.app.delete('/servers/:instanceId', this.deleteServerInstance);
         this.app.post('/close', this.closeServer);
+        this.app.use(exports.HEALTH_CHECK_PATH, (req, res) => {
+            res.status(200).send({ status: exports.SERVICE_HEALTHY });
+        });
     }
     setPort(instanceId, port) {
         logger_1.logger.debug((0, lang_1.i18n)(`${i18nKey}.setPort`, { instanceId, port }));
@@ -155,4 +161,4 @@ class PortManagerServer {
         }
     };
 }
-exports.default = new PortManagerServer();
+exports.PortManagerServer = new _PortManagerServer();

package/utils/{getAccountIdentifier.d.ts → accounts.d.ts}

@@ -1,10 +1,4 @@
 import { CLIAccount } from '../types/Accounts';
 import { CLIConfig } from '../types/Config';
-type Account = {
-    portalId?: number;
-    accountId?: number;
-};
-export declare function getAccountIdentifier(account?: Account | null): number | undefined;
 export declare function getAccounts(config?: CLIConfig | null): Array<CLIAccount>;
 export declare function getDefaultAccount(config?: CLIConfig | null): string | number | undefined;
-export {};