@hubspot/local-dev-lib 3.3.1-beta.0 → 3.3.2-beta.0

package/api/customObjects.d.ts

@@ -1,8 +1,8 @@
-import { FetchSchemasResponse, Schema, CreateObjectsResponse } from '../types/Schemas';
+import { FetchSchemasResponse, Schema, SchemaDefinition, ObjectDefinition, CreateObjectsResponse } from '../types/Schemas';
 import { HubSpotPromise } from '../types/Http';
-export declare function batchCreateObjects(accountId: number, objectTypeId: string, objects: JSON): HubSpotPromise<CreateObjectsResponse>;
-export declare function createObjectSchema(accountId: number, schema: JSON): HubSpotPromise<Schema>;
-export declare function updateObjectSchema(accountId: number, schemaObjectType: string, schema: Schema): HubSpotPromise<Schema>;
+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/lib/github.d.ts

@@ -1,5 +1,8 @@
 /// <reference types="node" />
 import { GithubReleaseData, GithubRepoFile, RepoPath, CloneGithubRepoOptions } from '../types/Github';
+/**
+ * @deprecated Use `fetchRepoFile` instead - this util is a thin wrapper around it
+ */
 export declare function fetchFileFromRepository<T = Buffer>(repoPath: RepoPath, filePath: string, ref: string): Promise<T>;
 export declare function fetchReleaseData(repoPath: RepoPath, tag?: string): Promise<GithubReleaseData>;
 export declare function cloneGithubRepo(repoPath: RepoPath, dest: string, options?: CloneGithubRepoOptions): Promise<boolean>;

package/lib/github.js

@@ -12,6 +12,9 @@ const github_1 = require("../api/github");
 const lang_1 = require("../utils/lang");
 const errors_1 = require("../errors");
 const i18nKey = 'lib.github';
+/**
+ * @deprecated Use `fetchRepoFile` instead - this util is a thin wrapper around it
+ */
 async function fetchFileFromRepository(repoPath, filePath, ref) {
     try {
         logger_1.logger.debug((0, lang_1.i18n)(`${i18nKey}.fetchFileFromRepository.fetching`, {
@@ -75,14 +78,17 @@ async function downloadGithubRepoZip(repoPath, isRelease = false, options = {})
     }
 }
 async function cloneGithubRepo(repoPath, dest, options = {}) {
-    const { tag, isRelease, branch, sourceDir, type } = options;
+    const { tag, isRelease, branch, sourceDir, type, hideLogs } = options;
     const zip = await downloadGithubRepoZip(repoPath, isRelease, {
         tag,
         branch,
     });
     const repoName = repoPath.split('/')[1];
-    const success = await (0, archive_1.extractZipArchive)(zip, repoName, dest, { sourceDir });
-    if (success) {
+    const success = await (0, archive_1.extractZipArchive)(zip, repoName, dest, {
+        sourceDir,
+        hideLogs,
+    });
+    if (success && !hideLogs) {
         logger_1.logger.log((0, lang_1.i18n)(`${i18nKey}.cloneGithubRepo.success`, {
             type: type || '',
             dest,

package/package.json

@@ -1,8 +1,7 @@
 {
     "name": "@hubspot/local-dev-lib",
-    "version": "3.3.1-beta.0",
+    "version": "3.3.2-beta.0",
     "description": "Provides library functionality for HubSpot local development tooling, including the HubSpot CLI",
-    "main": "lib/index.js",
     "repository": {
         "type": "git",
         "url": "https://github.com/HubSpot/hubspot-local-dev-lib"

package/types/Github.d.ts

@@ -72,5 +72,6 @@ export type CloneGithubRepoOptions = {
     branch?: string;
     tag?: string;
     sourceDir?: string;
+    hideLogs?: boolean;
 };
 export {};

package/types/Schemas.d.ts

@@ -37,3 +37,47 @@ export type CreateObjectsResponse = {
         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;
+            };
+        }
+    ];
+};