@hubspot/local-dev-lib 0.2.2 → 0.2.3-experimental.0

package/LICENSE

@@ -0,0 +1,12 @@
+Copyright 2019  HubSpot, Inc.
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/README.md

@@ -0,0 +1,17 @@
+# hubspot/local-dev-lib
+
+Provides library functionality for HubSpot local development tooling, including the [HubSpot CLI](https://github.com/HubSpot/hubspot-cli).
+
+**NOTE:** This library is intended to replace the deprecated [@hubspot/cli-lib](https://github.com/HubSpot/cli-lib) library.
+
+## Overview
+
+This library contains utils that facilitate interactions with HubSpot. It is consumed by the [HubSpot CLI](https://github.com/HubSpot/hubspot-cli) as well as other HubSpot development tooling. Major exports include:
+
+- Config utils for managing HubSpot account configuration and access keys ([docs](./config/README.md))
+- API utils to interact with HubSpot assets such as Design Manager and Developer Projects ([docs](./api/README.md))
+- Utils to navigate the local filesystem, parse common HubSpot files, interact with common HubSpot objects, and connect with GitHub ([docs](./lib/README.md))
+
+## Contributing
+
+For more information on developing, see the [Contributing Guide](CONTRIBUTING.md).

package/api/appsDev.d.ts

@@ -0,0 +1,6 @@
+import { PublicApp, PublicAppInstallCounts, PublicAppDeveloperTestAccountInstallData, FetchPublicAppsForPortalResponse } from '../types/Apps';
+import { HubSpotPromise } from '../types/Http';
+export declare function fetchPublicAppsForPortal(accountId: number): HubSpotPromise<FetchPublicAppsForPortalResponse>;
+export declare function fetchPublicAppDeveloperTestAccountInstallData(appId: number, accountId: number): HubSpotPromise<PublicAppDeveloperTestAccountInstallData>;
+export declare function fetchPublicAppProductionInstallCounts(appId: number, accountId: number): HubSpotPromise<PublicAppInstallCounts>;
+export declare function fetchPublicAppMetadata(appId: number, accountId: number): HubSpotPromise<PublicApp>;

package/api/appsDev.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fetchPublicAppMetadata = exports.fetchPublicAppProductionInstallCounts = exports.fetchPublicAppDeveloperTestAccountInstallData = exports.fetchPublicAppsForPortal = void 0;
+const http_1 = require("../http");
+const APPS_DEV_API_PATH = 'apps-dev/external/public/v3';
+function fetchPublicAppsForPortal(accountId) {
+    return http_1.http.get(accountId, {
+        url: `${APPS_DEV_API_PATH}/full/portal`,
+    });
+}
+exports.fetchPublicAppsForPortal = fetchPublicAppsForPortal;
+function fetchPublicAppDeveloperTestAccountInstallData(appId, accountId) {
+    return http_1.http.get(accountId, {
+        url: `${APPS_DEV_API_PATH}/${appId}/test-portal-installs`,
+    });
+}
+exports.fetchPublicAppDeveloperTestAccountInstallData = fetchPublicAppDeveloperTestAccountInstallData;
+function fetchPublicAppProductionInstallCounts(appId, accountId) {
+    return http_1.http.get(accountId, {
+        url: `${APPS_DEV_API_PATH}/${appId}/install-counts-without-test-portals`,
+    });
+}
+exports.fetchPublicAppProductionInstallCounts = fetchPublicAppProductionInstallCounts;
+function fetchPublicAppMetadata(appId, accountId) {
+    return http_1.http.get(accountId, {
+        url: `${APPS_DEV_API_PATH}/${appId}/full`,
+    });
+}
+exports.fetchPublicAppMetadata = fetchPublicAppMetadata;

package/api/customObjects.d.ts

@@ -1,7 +1,8 @@
-import { FetchSchemasResponse, Schema } from '../types/Schemas';
-export declare function batchCreateObjects(accountId: number, objectTypeId: string, objects: JSON): Promise<void>;
-export declare function createObjectSchema(accountId: number, schema: JSON): Promise<Schema>;
-export declare function updateObjectSchema(accountId: number, schemaObjectType: string, schema: Schema): Promise<Schema>;
-export declare function fetchObjectSchema(accountId: number, schemaObjectType: string): Promise<Schema>;
-export declare function fetchObjectSchemas(accountId: number): Promise<FetchSchemasResponse>;
-export declare function deleteObjectSchema(accountId: number, schemaObjectType: string): Promise<void>;
+import { FetchSchemasResponse, Schema, SchemaDefinition, ObjectDefinition, CreateObjectsResponse } from '../types/Schemas';
+import { HubSpotPromise } from '../types/Http';
+export declare function batchCreateObjects(accountId: number, objectTypeId: string, objects: ObjectDefinition): HubSpotPromise<CreateObjectsResponse>;
+export declare function createObjectSchema(accountId: number, schema: SchemaDefinition): HubSpotPromise<Schema>;
+export declare function updateObjectSchema(accountId: number, schemaObjectType: string, schema: SchemaDefinition): HubSpotPromise<Schema>;
+export declare function fetchObjectSchema(accountId: number, schemaObjectType: string): HubSpotPromise<Schema>;
+export declare function fetchObjectSchemas(accountId: number): HubSpotPromise<FetchSchemasResponse>;
+export declare function deleteObjectSchema(accountId: number, schemaObjectType: string): HubSpotPromise<void>;

package/api/customObjects.js

@@ -1,47 +1,44 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.deleteObjectSchema = exports.fetchObjectSchemas = exports.fetchObjectSchema = exports.updateObjectSchema = exports.createObjectSchema = exports.batchCreateObjects = void 0;
-const http_1 = __importDefault(require("../http"));
+const http_1 = require("../http");
 const CUSTOM_OBJECTS_API_PATH = 'crm/v3/objects';
 const SCHEMA_API_PATH = 'crm-object-schemas/v3/schemas';
-async function batchCreateObjects(accountId, objectTypeId, objects) {
-    http_1.default.post(accountId, {
+function batchCreateObjects(accountId, objectTypeId, objects) {
+    return http_1.http.post(accountId, {
         url: `${CUSTOM_OBJECTS_API_PATH}/${objectTypeId}/batch/create`,
         data: objects,
     });
 }
 exports.batchCreateObjects = batchCreateObjects;
-async function createObjectSchema(accountId, schema) {
-    return http_1.default.post(accountId, {
+function createObjectSchema(accountId, schema) {
+    return http_1.http.post(accountId, {
         url: SCHEMA_API_PATH,
         data: schema,
     });
 }
 exports.createObjectSchema = createObjectSchema;
-async function updateObjectSchema(accountId, schemaObjectType, schema) {
-    return http_1.default.patch(accountId, {
+function updateObjectSchema(accountId, schemaObjectType, schema) {
+    return http_1.http.patch(accountId, {
         url: `${SCHEMA_API_PATH}/${schemaObjectType}`,
         data: schema,
     });
 }
 exports.updateObjectSchema = updateObjectSchema;
-async function fetchObjectSchema(accountId, schemaObjectType) {
-    return http_1.default.get(accountId, {
+function fetchObjectSchema(accountId, schemaObjectType) {
+    return http_1.http.get(accountId, {
         url: `${SCHEMA_API_PATH}/${schemaObjectType}`,
     });
 }
 exports.fetchObjectSchema = fetchObjectSchema;
-async function fetchObjectSchemas(accountId) {
-    return http_1.default.get(accountId, {
+function fetchObjectSchemas(accountId) {
+    return http_1.http.get(accountId, {
         url: SCHEMA_API_PATH,
     });
 }
 exports.fetchObjectSchemas = fetchObjectSchemas;
-async function deleteObjectSchema(accountId, schemaObjectType) {
-    return http_1.default.delete(accountId, {
+function deleteObjectSchema(accountId, schemaObjectType) {
+    return http_1.http.delete(accountId, {
         url: `${SCHEMA_API_PATH}/${schemaObjectType}`,
     });
 }

package/api/designManager.d.ts

@@ -1,13 +1,4 @@
-type FetchThemesResponse = {
-    objects: Array<{
-        theme: {
-            path: string;
-        };
-    }>;
-};
-export declare function fetchThemes(accountId: number, query?: {}): Promise<FetchThemesResponse>;
-type FetchBuiltinMappingResponse = {
-    [key: string]: string;
-};
-export declare function fetchBuiltinMapping(accountId: number): Promise<FetchBuiltinMappingResponse>;
-export {};
+import { HubSpotPromise, QueryParams } from '../types/Http';
+import { FetchThemesResponse, FetchBuiltinMappingResponse } from '../types/DesignManager';
+export declare function fetchThemes(accountId: number, params?: QueryParams): HubSpotPromise<FetchThemesResponse>;
+export declare function fetchBuiltinMapping(accountId: number): HubSpotPromise<FetchBuiltinMappingResponse>;

package/api/designManager.js

@@ -1,20 +1,17 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.fetchBuiltinMapping = exports.fetchThemes = void 0;
-const http_1 = __importDefault(require("../http"));
+const http_1 = require("../http");
 const DESIGN_MANAGER_API_PATH = 'designmanager/v1';
-async function fetchThemes(accountId, query = {}) {
-    return http_1.default.get(accountId, {
+function fetchThemes(accountId, params = {}) {
+    return http_1.http.get(accountId, {
         url: `${DESIGN_MANAGER_API_PATH}/themes/combined`,
-        query,
+        params,
     });
 }
 exports.fetchThemes = fetchThemes;
-async function fetchBuiltinMapping(accountId) {
-    return http_1.default.get(accountId, {
+function fetchBuiltinMapping(accountId) {
+    return http_1.http.get(accountId, {
         url: `${DESIGN_MANAGER_API_PATH}/widgets/builtin-mapping`,
     });
 }

package/api/developerTestAccounts.d.ts

@@ -0,0 +1,7 @@
+import { DeveloperTestAccount, FetchDeveloperTestAccountsResponse } from '../types/developerTestAccounts';
+import { Environment } from '../types/Config';
+import { HubSpotPromise } from '../types/Http';
+export declare function fetchDeveloperTestAccounts(accountId: number): HubSpotPromise<FetchDeveloperTestAccountsResponse>;
+export declare function createDeveloperTestAccount(accountId: number, accountName: string): HubSpotPromise<DeveloperTestAccount>;
+export declare function deleteDeveloperTestAccount(accountId: number, testAccountId: number): HubSpotPromise<void>;
+export declare function fetchDeveloperTestAccountData(accessToken: string, accountId: number, env?: Environment): HubSpotPromise<DeveloperTestAccount>;

package/api/developerTestAccounts.js

@@ -0,0 +1,48 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fetchDeveloperTestAccountData = exports.deleteDeveloperTestAccount = exports.createDeveloperTestAccount = exports.fetchDeveloperTestAccounts = void 0;
+const axios_1 = __importDefault(require("axios"));
+const http_1 = require("../http");
+const getAxiosConfig_1 = require("../http/getAxiosConfig");
+const environments_1 = require("../constants/environments");
+const api_1 = require("../constants/api");
+const TEST_ACCOUNTS_API_PATH = 'integrators/test-portals/v2';
+function fetchDeveloperTestAccounts(accountId) {
+    return http_1.http.get(accountId, {
+        url: TEST_ACCOUNTS_API_PATH,
+    });
+}
+exports.fetchDeveloperTestAccounts = fetchDeveloperTestAccounts;
+function createDeveloperTestAccount(accountId, accountName) {
+    return http_1.http.post(accountId, {
+        url: TEST_ACCOUNTS_API_PATH,
+        data: { accountName, generatePersonalAccessKey: true },
+        timeout: api_1.SANDBOX_TIMEOUT,
+    });
+}
+exports.createDeveloperTestAccount = createDeveloperTestAccount;
+function deleteDeveloperTestAccount(accountId, testAccountId) {
+    return http_1.http.delete(accountId, {
+        url: `${TEST_ACCOUNTS_API_PATH}/${testAccountId}`,
+    });
+}
+exports.deleteDeveloperTestAccount = deleteDeveloperTestAccount;
+function fetchDeveloperTestAccountData(accessToken, accountId, env = environments_1.ENVIRONMENTS.PROD) {
+    const axiosConfig = (0, getAxiosConfig_1.getAxiosConfig)({
+        env,
+        url: `${TEST_ACCOUNTS_API_PATH}/self`,
+        params: { portalId: accountId },
+    });
+    const reqWithToken = {
+        ...axiosConfig,
+        headers: {
+            ...axiosConfig.headers,
+            Authorization: `Bearer ${accessToken}`,
+        },
+    };
+    return (0, axios_1.default)(reqWithToken);
+}
+exports.fetchDeveloperTestAccountData = fetchDeveloperTestAccountData;

package/api/fileManager.d.ts

@@ -1,5 +1,6 @@
+import { HubSpotPromise } from '../types/Http';
 import { FetchStatResponse, FetchFilesResponse, FetchFolderResponse, UploadResponse } from '../types/FileManager';
-export declare function uploadFile(accountId: number, src: string, dest: string): Promise<UploadResponse>;
-export declare function fetchStat(accountId: number, src: string): Promise<FetchStatResponse>;
-export declare function fetchFiles(accountId: number, folderId: number | 'None', offset: number, archived?: boolean): Promise<FetchFilesResponse>;
-export declare function fetchFolders(accountId: number, folderId: number | 'None'): Promise<FetchFolderResponse>;
+export declare function uploadFile(accountId: number, src: string, dest: string): HubSpotPromise<UploadResponse>;
+export declare function fetchStat(accountId: number, src: string): HubSpotPromise<FetchStatResponse>;
+export declare function fetchFiles(accountId: number, folderId: number | 'None', offset: number, archived?: boolean): HubSpotPromise<FetchFilesResponse>;
+export declare function fetchFolders(accountId: number, folderId: number | 'None'): HubSpotPromise<FetchFolderResponse>;

package/api/fileManager.js

@@ -6,10 +6,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.fetchFolders = exports.fetchFiles = exports.fetchStat = exports.uploadFile = void 0;
 const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
-const http_1 = __importDefault(require("../http"));
+const http_1 = require("../http");
 const FILE_MANAGER_V2_API_PATH = 'filemanager/api/v2';
 const FILE_MANAGER_V3_API_PATH = 'filemanager/api/v3';
-async function uploadFile(accountId, src, dest) {
+function uploadFile(accountId, src, dest) {
     const directory = path_1.default.dirname(dest);
     const filename = path_1.default.basename(dest);
     const formData = {
@@ -26,23 +26,23 @@ async function uploadFile(accountId, src, dest) {
     else {
         formData.folderPath = '/';
     }
-    return http_1.default.post(accountId, {
+    return http_1.http.post(accountId, {
         url: `${FILE_MANAGER_V3_API_PATH}/files/upload`,
         data: formData,
         headers: { 'Content-Type': 'multipart/form-data' },
     });
 }
 exports.uploadFile = uploadFile;
-async function fetchStat(accountId, src) {
-    return http_1.default.get(accountId, {
+function fetchStat(accountId, src) {
+    return http_1.http.get(accountId, {
         url: `${FILE_MANAGER_V2_API_PATH}/files/stat/${src}`,
     });
 }
 exports.fetchStat = fetchStat;
-async function fetchFiles(accountId, folderId, offset, archived) {
-    return http_1.default.get(accountId, {
+function fetchFiles(accountId, folderId, offset, archived) {
+    return http_1.http.get(accountId, {
         url: `${FILE_MANAGER_V2_API_PATH}/files/`,
-        query: {
+        params: {
             hidden: 0,
             offset: offset,
             folder_id: folderId,
@@ -51,10 +51,10 @@ async function fetchFiles(accountId, folderId, offset, archived) {
     });
 }
 exports.fetchFiles = fetchFiles;
-async function fetchFolders(accountId, folderId) {
-    return http_1.default.get(accountId, {
+function fetchFolders(accountId, folderId) {
+    return http_1.http.get(accountId, {
         url: `${FILE_MANAGER_V2_API_PATH}/folders/`,
-        query: {
+        params: {
             hidden: 0,
             parent_folder_id: folderId,
         },

package/api/fileMapper.d.ts

@@ -1,12 +1,13 @@
 import { AxiosResponse } from 'axios';
 import { FileMapperNode, FileMapperOptions, FileTree } from '../types/Files';
+import { HubSpotPromise } from '../types/Http';
 export declare const FILE_MAPPER_API_PATH = "content/filemapper/v1";
 export declare function createFileMapperNodeFromStreamResponse(filePath: string, response: Partial<AxiosResponse>): FileMapperNode;
-export declare function upload(accountId: number, src: string, dest: string, options?: FileMapperOptions): Promise<void>;
-export declare function fetchModule(accountId: number, moduleId: number, options?: FileMapperOptions): Promise<FileTree>;
+export declare function upload(accountId: number, src: string, dest: string, options?: FileMapperOptions): HubSpotPromise<void>;
+export declare function fetchModule(accountId: number, moduleId: number, options?: FileMapperOptions): HubSpotPromise<FileTree>;
 export declare function fetchFileStream(accountId: number, filePath: string, destination: string, options?: FileMapperOptions): Promise<FileMapperNode>;
-export declare function download(accountId: number, filepath: string, options?: FileMapperOptions): Promise<FileMapperNode>;
-export declare function downloadDefault(accountId: number, filepath: string, options?: FileMapperOptions): Promise<FileMapperNode>;
-export declare function deleteFile(accountId: number, filePath: string, options?: FileMapperOptions): Promise<void>;
-export declare function moveFile(accountId: number, srcPath: string, destPath: string): Promise<void>;
-export declare function getDirectoryContentsByPath(accountId: number, path: string): Promise<void>;
+export declare function download(accountId: number, filepath: string, options?: FileMapperOptions): HubSpotPromise<FileMapperNode>;
+export declare function downloadDefault(accountId: number, filepath: string, options?: FileMapperOptions): HubSpotPromise<FileMapperNode>;
+export declare function deleteFile(accountId: number, filePath: string): HubSpotPromise<void>;
+export declare function moveFile(accountId: number, srcPath: string, destPath: string): HubSpotPromise<void>;
+export declare function getDirectoryContentsByPath(accountId: number, path: string): HubSpotPromise<FileMapperNode>;

package/api/fileMapper.js

@@ -7,7 +7,7 @@ exports.getDirectoryContentsByPath = exports.moveFile = exports.deleteFile = exp
 const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
 const content_disposition_1 = __importDefault(require("content-disposition"));
-const http_1 = __importDefault(require("../http"));
+const http_1 = require("../http");
 const path_2 = require("../lib/path");
 exports.FILE_MAPPER_API_PATH = 'content/filemapper/v1';
 function createFileMapperNodeFromStreamResponse(filePath, response) {
@@ -38,8 +38,8 @@ function createFileMapperNodeFromStreamResponse(filePath, response) {
     };
 }
 exports.createFileMapperNodeFromStreamResponse = createFileMapperNodeFromStreamResponse;
-async function upload(accountId, src, dest, options = {}) {
-    return http_1.default.post(accountId, {
+function upload(accountId, src, dest, options = {}) {
+    return http_1.http.post(accountId, {
         url: `${exports.FILE_MAPPER_API_PATH}/upload/${encodeURIComponent(dest)}`,
         data: {
             file: fs_1.default.createReadStream(path_1.default.resolve((0, path_2.getCwd)(), src)),
@@ -50,8 +50,8 @@ async function upload(accountId, src, dest, options = {}) {
 }
 exports.upload = upload;
 // Fetch a module by moduleId
-async function fetchModule(accountId, moduleId, options = {}) {
-    return http_1.default.get(accountId, {
+function fetchModule(accountId, moduleId, options = {}) {
+    return http_1.http.get(accountId, {
         url: `${exports.FILE_MAPPER_API_PATH}/modules/${moduleId}`,
         ...options,
     });
@@ -59,7 +59,7 @@ async function fetchModule(accountId, moduleId, options = {}) {
 exports.fetchModule = fetchModule;
 // Fetch a file by file path.
 async function fetchFileStream(accountId, filePath, destination, options = {}) {
-    const response = await http_1.default.getOctetStream(accountId, {
+    const response = await http_1.http.getOctetStream(accountId, {
         url: `${exports.FILE_MAPPER_API_PATH}/stream/${encodeURIComponent(filePath)}`,
         ...options,
     }, destination);
@@ -67,39 +67,39 @@ async function fetchFileStream(accountId, filePath, destination, options = {}) {
 }
 exports.fetchFileStream = fetchFileStream;
 // Fetch a folder or file node by path.
-async function download(accountId, filepath, options = {}) {
-    return http_1.default.get(accountId, {
+function download(accountId, filepath, options = {}) {
+    return http_1.http.get(accountId, {
         url: `${exports.FILE_MAPPER_API_PATH}/download/${encodeURIComponent(filepath)}`,
         ...options,
     });
 }
 exports.download = download;
 // Fetch a folder or file node by path.
-async function downloadDefault(accountId, filepath, options = {}) {
-    return http_1.default.get(accountId, {
+function downloadDefault(accountId, filepath, options = {}) {
+    return http_1.http.get(accountId, {
         url: `${exports.FILE_MAPPER_API_PATH}/download-default/${filepath}`,
         ...options,
     });
 }
 exports.downloadDefault = downloadDefault;
 // Delete a file or folder by path
-async function deleteFile(accountId, filePath, options = {}) {
-    return http_1.default.delete(accountId, {
+function deleteFile(accountId, filePath) {
+    return http_1.http.delete(accountId, {
         url: `${exports.FILE_MAPPER_API_PATH}/delete/${encodeURIComponent(filePath)}`,
-        ...options,
     });
 }
 exports.deleteFile = deleteFile;
 // Moves file from srcPath to destPath
-async function moveFile(accountId, srcPath, destPath) {
-    return http_1.default.put(accountId, {
+function moveFile(accountId, srcPath, destPath) {
+    return http_1.http.put(accountId, {
         url: `${exports.FILE_MAPPER_API_PATH}/rename/${srcPath}?path=${destPath}`,
+        headers: { 'Content-Type': 'application/json' },
     });
 }
 exports.moveFile = moveFile;
 // Get directory contents
-async function getDirectoryContentsByPath(accountId, path) {
-    return http_1.default.get(accountId, {
+function getDirectoryContentsByPath(accountId, path) {
+    return http_1.http.get(accountId, {
         url: `${exports.FILE_MAPPER_API_PATH}/meta/${path}`,
     });
 }

package/api/fileTransport.d.ts

@@ -0,0 +1,4 @@
+import { HubSpotPromise } from '../types/Http';
+export declare function createSchemaFromHubFile(accountId: number, filepath: string): HubSpotPromise;
+export declare function updateSchemaFromHubFile(accountId: number, filepath: string): HubSpotPromise;
+export declare function fetchHubFileSchema(accountId: number, objectName: string, path: string): HubSpotPromise;

package/api/fileTransport.js

@@ -0,0 +1,39 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fetchHubFileSchema = exports.updateSchemaFromHubFile = exports.createSchemaFromHubFile = void 0;
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const path_2 = require("../lib/path");
+const http_1 = require("../http");
+const HUBFILES_API_PATH = '/file-transport/v1/hubfiles';
+function createSchemaFromHubFile(accountId, filepath) {
+    const file = fs_1.default.createReadStream(path_1.default.resolve((0, path_2.getCwd)(), filepath));
+    return http_1.http.post(accountId, {
+        url: `${HUBFILES_API_PATH}/object-schemas`,
+        data: {
+            file,
+        },
+        headers: { 'Content-Type': 'multipart/form-data' },
+    });
+}
+exports.createSchemaFromHubFile = createSchemaFromHubFile;
+async function updateSchemaFromHubFile(accountId, filepath) {
+    const file = fs_1.default.createReadStream(path_1.default.resolve((0, path_2.getCwd)(), filepath));
+    return http_1.http.put(accountId, {
+        url: `${HUBFILES_API_PATH}/object-schemas`,
+        data: {
+            file,
+        },
+        headers: { 'Content-Type': 'multipart/form-data' },
+    });
+}
+exports.updateSchemaFromHubFile = updateSchemaFromHubFile;
+async function fetchHubFileSchema(accountId, objectName, path) {
+    return http_1.http.getOctetStream(accountId, {
+        url: `${HUBFILES_API_PATH}/object-schemas/${objectName}`,
+    }, path);
+}
+exports.fetchHubFileSchema = fetchHubFileSchema;

package/api/functions.d.ts

@@ -1,4 +1,7 @@
-import { GetBuildStatusResponse, GetRoutesResponse } from '../types/Functions';
-export declare function getRoutes(accountId: number): Promise<GetRoutesResponse>;
-export declare function buildPackage(accountId: number, folderPath: string): Promise<string>;
-export declare function getBuildStatus(portalId: number, buildId: number): Promise<GetBuildStatusResponse>;
+import { HubSpotPromise, QueryParams } from '../types/Http';
+import { GetBuildStatusResponse, FunctionLog, GetRoutesResponse, GetFunctionLogsResponse } from '../types/Functions';
+export declare function getRoutes(accountId: number): HubSpotPromise<GetRoutesResponse>;
+export declare function getFunctionLogs(accountId: number, route: string, params?: QueryParams): HubSpotPromise<GetFunctionLogsResponse>;
+export declare function getLatestFunctionLog(accountId: number, route: string): HubSpotPromise<FunctionLog>;
+export declare function buildPackage(accountId: number, folderPath: string): HubSpotPromise<string>;
+export declare function getBuildStatus(accountId: number, buildId: number): HubSpotPromise<GetBuildStatusResponse>;

package/api/functions.js

@@ -1,19 +1,30 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getBuildStatus = exports.buildPackage = exports.getRoutes = void 0;
-const http_1 = __importDefault(require("../http"));
+exports.getBuildStatus = exports.buildPackage = exports.getLatestFunctionLog = exports.getFunctionLogs = exports.getRoutes = void 0;
+const http_1 = require("../http");
 const FUNCTION_API_PATH = 'cms/v3/functions';
-async function getRoutes(accountId) {
-    return http_1.default.get(accountId, {
+function getRoutes(accountId) {
+    return http_1.http.get(accountId, {
         url: `${FUNCTION_API_PATH}/routes`,
     });
 }
 exports.getRoutes = getRoutes;
-async function buildPackage(accountId, folderPath) {
-    return http_1.default.post(accountId, {
+function getFunctionLogs(accountId, route, params = {}) {
+    const { limit = 5 } = params;
+    return http_1.http.get(accountId, {
+        url: `${FUNCTION_API_PATH}/results/by-route/${encodeURIComponent(route)}`,
+        params: { ...params, limit },
+    });
+}
+exports.getFunctionLogs = getFunctionLogs;
+function getLatestFunctionLog(accountId, route) {
+    return http_1.http.get(accountId, {
+        url: `${FUNCTION_API_PATH}/results/by-route/${encodeURIComponent(route)}/latest`,
+    });
+}
+exports.getLatestFunctionLog = getLatestFunctionLog;
+function buildPackage(accountId, folderPath) {
+    return http_1.http.post(accountId, {
         url: `${FUNCTION_API_PATH}/build/async`,
         headers: {
             Accept: 'text/plain',
@@ -24,8 +35,8 @@ async function buildPackage(accountId, folderPath) {
     });
 }
 exports.buildPackage = buildPackage;
-async function getBuildStatus(portalId, buildId) {
-    return http_1.default.get(portalId, {
+function getBuildStatus(accountId, buildId) {
+    return http_1.http.get(accountId, {
         url: `${FUNCTION_API_PATH}/build/${buildId}/poll`,
     });
 }

package/api/github.d.ts

@@ -1,13 +1,11 @@
 /// <reference types="node" />
-import { AxiosResponse } from 'axios';
-import { GithubReleaseData, GithubRepoFile } from '../types/Github';
+import { GithubReleaseData, GithubRepoFile, RepoPath } from '../types/Github';
+import { HubSpotPromise } from '../types/Http';
 declare global {
     var githubToken: string;
 }
-type RepoPath = `${string}/${string}`;
-export declare function fetchRepoReleaseData(repoPath: RepoPath, tag?: string): Promise<AxiosResponse<GithubReleaseData>>;
-export declare function fetchRepoAsZip(zipUrl: string): Promise<AxiosResponse<Buffer>>;
-export declare function fetchRepoFile(repoPath: RepoPath, filePath: string, ref: string): Promise<AxiosResponse<Buffer>>;
-export declare function fetchRepoFileByDownloadUrl(downloadUrl: string): Promise<AxiosResponse<Buffer>>;
-export declare function fetchRepoContents(repoPath: RepoPath, path: string, ref?: string): Promise<AxiosResponse<Array<GithubRepoFile>>>;
-export {};
+export declare function fetchRepoReleaseData(repoPath: RepoPath, tag?: string): HubSpotPromise<GithubReleaseData>;
+export declare function fetchRepoAsZip(zipUrl: string): HubSpotPromise<Buffer>;
+export declare function fetchRepoFile<T = Buffer>(repoPath: RepoPath, filePath: string, ref: string): HubSpotPromise<T>;
+export declare function fetchRepoFileByDownloadUrl(downloadUrl: string): HubSpotPromise<Buffer>;
+export declare function fetchRepoContents(repoPath: RepoPath, path: string, ref?: string): HubSpotPromise<Array<GithubRepoFile>>;