@hubspot/local-dev-lib 0.0.4 → 0.0.6

package/types/Accounts.d.ts

@@ -1,50 +1,95 @@
-import { DEFAULT_MODES } from '../constants/config';
-import { ValueOf } from './Utils';
+import { Mode } from './Files';
+import { Environment } from './Config';
 export type AuthType = 'personalaccesskey' | 'apikey' | 'oauth2';
-export interface CLIAccount {
+export interface CLIAccount_NEW {
     name?: string;
     accountId: number;
-    defaultMode?: ValueOf<typeof DEFAULT_MODES>;
-    env?: string;
+    defaultMode?: Mode;
+    env: Environment;
     authType?: AuthType;
-    auth?: object;
+    auth?: {
+        tokenInfo?: TokenInfo;
+    };
     sandboxAccountType?: string | null;
     parentAccountId?: number | null;
     apiKey?: string;
     personalAccessKey?: string;
 }
-export type PersonalAccessKeyTokenInfo = {
-    accessToken: string;
-    expiresAt: string;
-};
-export type OauthTokenInfo = {
+export interface CLIAccount_DEPRECATED {
+    name?: string;
+    portalId?: number;
+    defaultMode?: Mode;
+    env: Environment;
+    authType?: AuthType;
+    auth?: {
+        tokenInfo?: TokenInfo;
+    };
+    sandboxAccountType?: string | null;
+    parentAccountId?: number | null;
+    apiKey?: string;
+    personalAccessKey?: string;
+}
+export type CLIAccount = CLIAccount_NEW | CLIAccount_DEPRECATED;
+export type TokenInfo = {
+    accessToken?: string;
+    expiresAt?: string;
     refreshToken?: string;
 };
-export interface PersonalAccessKeyAccount extends CLIAccount {
+export interface PersonalAccessKeyAccount_NEW extends CLIAccount_NEW {
+    authType: 'personalaccesskey';
+    personalAccessKey: string;
+}
+export interface PersonalAccessKeyAccount_DEPRECATED extends CLIAccount_DEPRECATED {
     authType: 'personalaccesskey';
-    auth?: {
-        tokenInfo: PersonalAccessKeyTokenInfo;
-    };
     personalAccessKey: string;
 }
-export interface OAuthAccount extends CLIAccount {
+export type PersonalAccessKeyAccount = PersonalAccessKeyAccount_NEW | PersonalAccessKeyAccount_DEPRECATED;
+export interface OAuthAccount_NEW extends CLIAccount_NEW {
     authType: 'oauth2';
-    auth?: {
+    auth: {
         clientId?: string;
         clientSecret?: string;
         scopes?: Array<string>;
-        tokenInfo?: OauthTokenInfo;
+        tokenInfo?: TokenInfo;
     };
 }
-export interface APIKeyAccount extends CLIAccount {
+export interface OAuthAccount_DEPRECATED extends CLIAccount_DEPRECATED {
+    authType: 'oauth2';
+    auth: {
+        clientId?: string;
+        clientSecret?: string;
+        scopes?: Array<string>;
+        tokenInfo?: TokenInfo;
+    };
+}
+export type OAuthAccount = OAuthAccount_NEW | OAuthAccount_DEPRECATED;
+export interface APIKeyAccount_NEW extends CLIAccount_NEW {
     authType: 'apikey';
     apiKey: string;
 }
-export interface FlatAccountFields<T extends OauthTokenInfo | PersonalAccessKeyTokenInfo> extends CLIAccount {
-    tokenInfo?: T;
+export interface APIKeyAccount_DEPRECATED extends CLIAccount_DEPRECATED {
+    authType: 'apikey';
+    apiKey: string;
+}
+export type APIKeyAccount = APIKeyAccount_NEW | APIKeyAccount_DEPRECATED;
+export interface FlatAccountFields_NEW extends CLIAccount_NEW {
+    tokenInfo?: TokenInfo;
+    clientId?: string;
+    clientSecret?: string;
+    scopes?: Array<string>;
+    apiKey?: string;
+    personalAccessKey?: string;
+}
+export interface FlatAccountFields_DEPRECATED extends CLIAccount_DEPRECATED {
+    tokenInfo?: TokenInfo;
     clientId?: string;
     clientSecret?: string;
     scopes?: Array<string>;
     apiKey?: string;
     personalAccessKey?: string;
 }
+export type FlatAccountFields = FlatAccountFields_NEW | FlatAccountFields_DEPRECATED;
+export type ScopeData = {
+    portalScopesInGroup: Array<string>;
+    userScopesInGroup: Array<string>;
+};

package/types/Activity.d.ts

@@ -0,0 +1,20 @@
+import { ACTIVITY_SOURCE } from '../enums/project';
+import { ValueOf } from './Utils';
+import { GithubSourceData } from './Github';
+export interface GithubActivitySource extends GithubSourceData {
+    authorEmail: string;
+    authorName: string;
+    branchName: string;
+    branch: string;
+    commitHash: string;
+    committersUsername: string;
+    ownerName: string;
+    owner: string;
+    repositoryName: string;
+    type: typeof ACTIVITY_SOURCE.GITHUB_USER;
+}
+export type HubspotActivitySource = {
+    userId?: number;
+    type: ValueOf<typeof ACTIVITY_SOURCE>;
+};
+export type ActivitySource = GithubActivitySource | HubspotActivitySource;

package/types/Activity.js

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

package/types/Api.d.ts

@@ -0,0 +1,2 @@
+import { HTTP_METHOD_VERBS } from '../constants/api';
+export type HttpMethod = keyof typeof HTTP_METHOD_VERBS;

package/types/Api.js

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

package/types/Build.d.ts

@@ -0,0 +1,41 @@
+import { ValueOf } from './Utils';
+import { BUILD_STATUS, SUBBUILD_TYPES, DEPLOYABLE_STATES } from '../enums/build';
+import { ActivitySource } from './Activity';
+import { DeployStatusTaskLocator } from './Deploy';
+import { OptionalError } from './Error';
+export type SubbuildStatus = {
+    buildName: string;
+    buildType: ValueOf<typeof SUBBUILD_TYPES>;
+    errorMessage: string;
+    finishedAt: string;
+    rootPath: string;
+    standardError?: OptionalError;
+    startedAt: string;
+    status: ValueOf<typeof BUILD_STATUS>;
+    id: string;
+};
+export type Build = {
+    activitySource: ActivitySource;
+    buildId: number;
+    createdAt: string;
+    deployableState: ValueOf<typeof DEPLOYABLE_STATES>;
+    deployStatusTaskLocator: DeployStatusTaskLocator;
+    enqueuedAt: string;
+    finishedAt: string;
+    isAutoDeployEnabled: boolean;
+    portalId: number;
+    projectName: string;
+    startedAt: string;
+    status: ValueOf<typeof BUILD_STATUS>;
+    subbuildStatuses: Array<SubbuildStatus>;
+    uploadMessage: string;
+};
+export type FetchProjectBuildsResponse = {
+    results: Array<Build>;
+    paging: {
+        next: {
+            after: string;
+            link: string;
+        };
+    };
+};

package/types/Build.js

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

package/types/CLIOptions.d.ts

@@ -1,3 +1,8 @@
 export interface CLIOptions {
+    silenceErrors?: boolean;
     useEnv?: boolean;
 }
+export type WriteConfigOptions = {
+    path?: string;
+    source?: string;
+};

package/types/ComponentStructure.d.ts

@@ -0,0 +1,20 @@
+import { COMPONENT_TYPES, SUBCOMPONENT_TYPES } from '../enums/build';
+import { ValueOf } from './Utils';
+export type ComponentStructure = {
+    [key: string]: Array<string>;
+};
+export type ComponentStructureResponse = {
+    topLevelComponentsWithChildren: ComponentStructure;
+};
+export type ComponentMetadata = {
+    componentIdentifier: string;
+    componentName: string;
+    componentType: ValueOf<typeof COMPONENT_TYPES> | ValueOf<typeof SUBCOMPONENT_TYPES>;
+    metadata: {
+        appId: string;
+    };
+    parentComponentType: string;
+};
+export type ComponentMetadataResponse = {
+    results: Array<ComponentMetadata>;
+};

package/types/ComponentStructure.js

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

package/types/Config.d.ts

@@ -1,10 +1,23 @@
-import { CLIAccount } from './Accounts';
-export interface CLIConfig {
-    accounts: Array<CLIAccount>;
+import { ENVIRONMENTS } from '../constants/environments';
+import { CLIAccount_NEW, CLIAccount_DEPRECATED } from './Accounts';
+import { ValueOf } from './Utils';
+export interface CLIConfig_NEW {
+    accounts: Array<CLIAccount_NEW>;
     allowUsageTracking?: boolean;
     defaultAccount?: string | number;
     defaultMode?: string;
     httpTimeout?: number;
-    env?: string;
+    env?: Environment;
     httpUseLocalhost?: boolean;
 }
+export interface CLIConfig_DEPRECATED {
+    portals: Array<CLIAccount_DEPRECATED>;
+    allowUsageTracking?: boolean;
+    defaultPortal?: string | number;
+    defaultMode?: string;
+    httpTimeout?: number;
+    env?: Environment;
+    httpUseLocalhost?: boolean;
+}
+export type CLIConfig = CLIConfig_NEW | CLIConfig_DEPRECATED;
+export type Environment = ValueOf<typeof ENVIRONMENTS> | '';

package/types/Deploy.d.ts

@@ -0,0 +1,42 @@
+import { ValueOf } from './Utils';
+import { ACTIVITY_SOURCE } from '../enums/project';
+import { DEPLOY_ACTION, DEPLOY_STATUS } from '../enums/deploy';
+import { COMPONENT_TYPES, SUBCOMPONENT_TYPES } from '../enums/build';
+import { OptionalError } from './Error';
+export type DeployStatus = ValueOf<typeof DEPLOY_STATUS>;
+export type SubdeployStatus = {
+    action: ValueOf<typeof DEPLOY_ACTION>;
+    deployName: string;
+    deployType: ValueOf<typeof COMPONENT_TYPES> | ValueOf<typeof SUBCOMPONENT_TYPES>;
+    errorMessage: string;
+    finishedAt: string;
+    standardError?: OptionalError;
+    startedAt: string;
+    status: DeployStatus;
+    id: string;
+};
+export type Deploy = {
+    buildId: number;
+    deployId: number;
+    enqueuedAt: string;
+    finishedAt: string;
+    portalId: number;
+    projectName: string;
+    startedAt: string;
+    status: DeployStatus;
+    subdeployStatuses: Array<SubdeployStatus>;
+    userId: number;
+    source: ValueOf<typeof ACTIVITY_SOURCE>;
+};
+export type DeployStatusTaskLocator = {
+    id: string;
+    links: Array<{
+        status: string;
+    }>;
+};
+export type ProjectDeployResponse = {
+    id: string;
+    links: {
+        status: string;
+    };
+};

package/types/Deploy.js

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

package/types/Error.d.ts

@@ -1,3 +1,4 @@
+import { HttpMethod } from './Api';
 export interface BaseError extends Error {
     name: string;
     message: string;
@@ -6,26 +7,50 @@ export interface BaseError extends Error {
     syscall?: string | null;
     reason?: string;
     statusCode?: number;
+    error?: BaseError;
+    errors?: Array<BaseError>;
 }
 export interface StatusCodeError extends BaseError {
-    name: 'StatusCodeError';
-    statusCode: number;
+    name: string;
+    statusCode?: number;
     message: string;
+    category?: string;
+    subCategory?: string;
     response: {
         request: {
             href: string;
             method: string;
         };
         body: {
-            [key: string]: string;
+            message?: string;
+            errors?: Array<StatusCodeError>;
+            category?: string;
+            subCategory?: string;
         };
         headers: {
             [key: string]: string;
         };
+        statusCode: number;
     };
-}
-export interface GithubError extends BaseError {
-    error: {
-        message?: string;
+    options?: {
+        method: HttpMethod;
+    };
+    errorTokens?: {
+        line: number;
     };
+    error?: StatusCodeError;
+    errors?: Array<StatusCodeError>;
 }
+export type FileSystemErrorContext = {
+    filepath: string;
+    write?: boolean;
+    read?: boolean;
+    accountId?: number;
+};
+export type StatusCodeErrorContext = {
+    accountId?: number;
+    request?: string;
+    payload?: string;
+    projectName?: string;
+};
+export type OptionalError = BaseError | null | undefined;

package/types/FileManager.d.ts

@@ -0,0 +1,66 @@
+type File = {
+    id: number;
+    portal_id: number;
+    name: string;
+    size: number;
+    height: number | null;
+    width: number | null;
+    encoding: string | null;
+    type: string;
+    extension: string;
+    cloud_key: string;
+    s3_url: string;
+    friendly_url: string;
+    meta: {
+        allows_anonymous_access: boolean;
+        charset_guess: string;
+        line_count: number;
+        indexable: boolean;
+    };
+    created: number;
+    updated: number;
+    deleted_at: number;
+    folder_id: number | null;
+    hidden: boolean;
+    archived: boolean;
+    created_by: number;
+    deleted_by: number | null;
+    replaceable: boolean;
+    default_hosting_url: string;
+    teams?: Array<number>;
+    is_indexable: boolean;
+    cloud_key_hash: string;
+    url: string;
+    title: string;
+    cdn_purge_embargo_time: number | null;
+    file_hash: string;
+};
+type Folder = {
+    id: number;
+    portal_id: number;
+    name: string;
+    deleted: boolean;
+    teams?: Array<number>;
+    parent_folder_id: number | null;
+    created: number;
+    updated: number;
+    deleted_at: number;
+    full_path: string;
+    category: number;
+    hidden: false;
+    cdn_purge_embargo_time: number | null;
+};
+export type UploadResponse = {
+    objects: Array<File>;
+};
+export type FetchStatResponse = {
+    file: File | null;
+    folder: Folder | null;
+};
+export type FetchFilesOrFolderResponse = {
+    limit: number;
+    offset: number;
+    objects: Array<File | Folder>;
+    total_count: number;
+};
+export {};

package/types/FileManager.js

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

package/types/Files.d.ts

@@ -1,8 +1,40 @@
 import { ValueOf } from '../types/Utils';
-import { STAT_TYPES } from '../constants/files';
+import { STAT_TYPES, FILE_TYPES, FILE_UPLOAD_RESULT_TYPES } from '../constants/files';
+import { MODE } from '../constants/files';
+import { HttpOptions } from './Http';
+import { StatusCodeError } from './Error';
 export type StatType = ValueOf<typeof STAT_TYPES>;
 export type FileData = {
     filepath: string;
     files?: Array<string>;
     type: StatType;
 };
+export type FileMapperNode = {
+    name: string;
+    createdAt: number;
+    updatedAt: number;
+    source: string | null;
+    path: string;
+    folder: boolean;
+    children: Array<FileMapperNode>;
+};
+export type Mode = ValueOf<typeof MODE>;
+export type FileMapperOptions = Omit<HttpOptions, 'url'>;
+export type FileMapperInputOptions = {
+    staging?: boolean;
+    assetVersion?: string;
+    overwrite?: boolean;
+};
+export type FileType = ValueOf<typeof FILE_TYPES>;
+type ResultType = ValueOf<typeof FILE_UPLOAD_RESULT_TYPES>;
+export type UploadFolderResults = {
+    resultType: ResultType;
+    error: StatusCodeError | null;
+    file: string;
+};
+export type FileTree = {
+    source?: string;
+    path: string;
+    children: Array<FileTree>;
+};
+export {};

package/types/Functions.d.ts

@@ -0,0 +1,40 @@
+type ServerlessFunction = {
+    portalId: number;
+    id: number;
+    serverlessFunctionId: number;
+    route: string;
+    rawAssetPath: string;
+    method: string;
+    configHash: number;
+    secretNames: Array<string>;
+    created: number;
+    updated: number;
+    deletedAt: number;
+    deployId: number;
+    projectName: string | null;
+    authorFullName: string | null;
+    createdById: number | null;
+    updatedById: number | null;
+    appId: number | null;
+    subbuildId: number | null;
+    deployed: boolean;
+    deployedNullable: boolean;
+};
+export type GetRoutesResponse = {
+    objects: Array<ServerlessFunction>;
+    total: number;
+    limit: number;
+    offset: number;
+    message: string | null;
+    totalCount: number;
+};
+export type GetBuildStatusResponse = {
+    status: string;
+    buildStartedAt: number;
+    updateCutoff?: number;
+    cdnUrl?: string;
+    buildTime?: number;
+    userId: number;
+    deployId: number;
+};
+export {};

package/types/Functions.js

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

package/types/Github.d.ts

@@ -55,4 +55,10 @@ export type GithubRepoFile = {
         html: string;
     };
 };
+export interface GithubSourceData {
+    branch: string;
+    owner: string;
+    repositoryName: string;
+    source: string;
+}
 export {};

package/types/Http.d.ts

@@ -0,0 +1,33 @@
+/// <reference types="node" />
+import { ReadStream } from 'fs';
+export type Body = {
+    [key: string]: any;
+};
+export type AxiosConfigOptions = {
+    url: string;
+    env?: string;
+    localHostOverride?: boolean;
+    params?: {
+        portalId?: number;
+        buffer?: boolean;
+        environmentId?: number;
+        version?: string;
+    };
+    body?: Body | JSON;
+    resolveWithFullResponse?: boolean;
+};
+export type QueryParams = {
+    [key: string]: string | number | boolean;
+};
+export type FormData = {
+    [key: string]: string | ReadStream;
+};
+export type HttpOptions = AxiosConfigOptions & {
+    query?: QueryParams;
+    formData?: FormData;
+    timeout?: number;
+    encoding?: string | null;
+    headers?: {
+        [header: string]: string | string[] | undefined;
+    };
+};

package/types/Http.js

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

package/types/Hubdb.d.ts

@@ -0,0 +1,90 @@
+export type Schema = {
+    label: string;
+    name: string;
+    columns: Array<Column>;
+    useForPages: boolean;
+    allowChildTables: boolean;
+    enableChildTablePages: boolean;
+    allowPublicApiAccess: boolean;
+};
+export type Table = {
+    id: string;
+    name: string;
+    portalId: number;
+    createdAt: string;
+    publishedAt: string;
+    updatedAt: string;
+    label: string;
+    columns: Array<Column>;
+    rows: Array<Row>;
+    partitioningSettings?: null;
+    published: boolean;
+    cosObjectType: string;
+    updated: number;
+    archived: boolean;
+    columnCount: number;
+    cdnPurgeEmbargoTime: number | null;
+    rowCount: number;
+    createdBy: {
+        id: string;
+        email: string;
+        firstName: string;
+        lastName: string;
+    };
+    useForPages: boolean;
+    allowChildTables: boolean;
+    enableChildTablePages: boolean;
+    crmObjectTypeId: number;
+    dynamicMetaTags?: null;
+    allowPublicApiAccess: boolean;
+};
+export type Column = {
+    name: string;
+    label: string;
+    id: string;
+    archived: boolean;
+    type: string;
+    deleted?: boolean;
+    foreignIdsByName?: {
+        [key: string]: {
+            id: string;
+            name: string;
+            type: string;
+        };
+    };
+    foreignIdsById?: {
+        [key: string]: {
+            id: string;
+            name: string;
+            type: string;
+        };
+    };
+};
+export type Row = {
+    id: string;
+    createdAt: string;
+    updatedAt: string;
+    publishedAt: string | null;
+    values: {
+        text_column: string;
+    };
+    path: string | null;
+    name: string | null;
+    childTableId?: string;
+    isSoftEditable?: boolean;
+};
+export type CreateRowsResponse = {
+    status: string;
+    results: Array<Row>;
+    startedAt: string;
+    completedAt: string;
+};
+export type FetchRowsResponse = {
+    total: number;
+    results: Array<Row>;
+    paging?: {
+        next: {
+            after: string | null;
+        };
+    };
+};

package/types/Hubdb.js

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