@hubspot/local-dev-lib 0.0.1-experimental.0

package/types/Apps.d.ts

@@ -0,0 +1,77 @@
+export type PublicAppInstallationData = {
+    appId: number;
+    isInstalledWithScopeGroups: boolean;
+    previouslyAuthorizedScopeGroups: Array<{
+        id: number;
+        name: string;
+    }>;
+};
+export type PublicAppDeveloperTestAccountInstallData = {
+    testPortalInstalls: Array<{
+        portalId: number;
+        accountName: string;
+    }>;
+    testPortalInstallCount: string;
+};
+export type PublicAppInstallCounts = {
+    uniquePortalInstallCount: number;
+    uniqueUserInstallCount: number;
+    uniqueBusinessUnitInstallCount: number;
+};
+export type PublicApp = {
+    id: number;
+    name: string;
+    description: string;
+    portalId: number;
+    updatedAt: number;
+    createdAt: number;
+    clientId: string;
+    iconUrl: string;
+    archived: boolean;
+    ownerId: number;
+    isUserLevel: boolean;
+    isBusinessUnitEnabled: boolean;
+    isFeatured: boolean;
+    isInternal: boolean;
+    documentationUrl: string | null;
+    supportUrl: string | null;
+    supportEmail: string | null;
+    supportPhone: string | null;
+    extensionIconUrl: string | null;
+    isAdvancedScopesSettingEnabled: boolean;
+    publicApplicationInstallCounts: PublicAppInstallCounts;
+    redirectUrls: Array<string>;
+    scopeGroupIds: Array<number>;
+    requiredScopeInfo?: Array<{
+        id: number;
+        name: string;
+    }>;
+    additionalScopeGroupIds: Array<number>;
+    additionalScopeInfo?: Array<{
+        id: number;
+        name: string;
+    }>;
+    optionalScopeGroupIds: Array<number>;
+    optionalScopeInfo?: Array<{
+        id: number;
+        name: string;
+    }>;
+    projectId: number | null;
+    sourceId: string | null;
+    providerInfo?: {
+        domain: string;
+        isVerified: boolean;
+    };
+    listingInfo?: {
+        listingUrl: string;
+        isCertified: boolean;
+        isPublished: boolean;
+        hasDraft: boolean;
+        inReview: boolean;
+    };
+    allowedExternalUrls: Array<string>;
+    preventProjectMigrations?: boolean;
+};
+export type FetchPublicAppsForPortalResponse = {
+    results: Array<PublicApp>;
+};

package/types/Apps.js

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

package/types/Archive.d.ts

@@ -0,0 +1,9 @@
+export type ZipData = {
+    extractDir: string;
+    tmpDir: string;
+};
+export type CopySourceToDestOptions = {
+    sourceDir?: string;
+    includesRootDir?: boolean;
+    hideLogs?: boolean;
+};

package/types/Archive.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

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

package/types/CLIOptions.js

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

package/types/ComponentStructure.d.ts

@@ -0,0 +1,40 @@
+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 ProjectComponentsMetadata = {
+    topLevelComponentMetadata: TopLevelComponents[];
+};
+export interface ComponentMetadata<T> {
+    componentName: string;
+    type: {
+        name: T;
+    };
+    deployOutput: unknown;
+}
+export interface TopLevelComponent extends ComponentMetadata<ValueOf<typeof COMPONENT_TYPES>> {
+    featureComponents: FeatureComponents[];
+}
+export interface PrivateAppComponentMetadata extends TopLevelComponent {
+    deployOutput: {
+        cardId: number;
+        appId: number;
+    };
+}
+export type TopLevelComponents = PrivateAppComponentMetadata | TopLevelComponent;
+export interface FeatureComponent<T = unknown> extends ComponentMetadata<ValueOf<typeof SUBCOMPONENT_TYPES>> {
+    deployOutput: T;
+}
+export type AppFunctionComponentMetadata = FeatureComponent<{
+    appId: number;
+    appFunctionName: string;
+    endpoint?: {
+        path: string;
+        methods: string[];
+    };
+}>;
+export type FeatureComponents = FeatureComponent | AppFunctionComponentMetadata;

package/types/ComponentStructure.js

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

package/types/Config.d.ts

@@ -0,0 +1,37 @@
+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?: 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> | '';
+export type EnvironmentConfigVariables = {
+    apiKey?: string;
+    clientId?: string;
+    clientSecret?: string;
+    personalAccessKey?: string;
+    accountId?: number;
+    refreshToken?: string;
+    env?: Environment;
+};
+export type GitInclusionResult = {
+    inGit: boolean;
+    configIgnored: boolean;
+    gitignoreFiles: Array<string>;
+};

package/types/Config.js

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

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/DesignManager.d.ts

@@ -0,0 +1,10 @@
+export type FetchThemesResponse = {
+    objects: Array<{
+        theme: {
+            path: string;
+        };
+    }>;
+};
+export type FetchBuiltinMappingResponse = {
+    [key: string]: string;
+};

package/types/DesignManager.js

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

package/types/Error.d.ts

@@ -0,0 +1,37 @@
+export interface GenericError extends Error {
+    [key: string]: any;
+}
+export interface BaseError extends Error {
+    name: string;
+    message: string;
+    errno?: number | null;
+    code?: string | null;
+    syscall?: string | null;
+    reason?: string;
+    status?: number;
+    error?: BaseError;
+    errors?: Array<BaseError>;
+}
+export interface ValidationError extends BaseError {
+    errorTokens?: {
+        line: number;
+    };
+    context?: {
+        requiredScopes?: string[];
+    };
+}
+export type FileSystemErrorContext = {
+    filepath?: string;
+    operation?: 'write' | 'read';
+    accountId?: number;
+    dest?: string;
+};
+export interface HubSpotHttpErrorContext extends FileSystemErrorContext {
+    request?: string;
+    payload?: string;
+    projectName?: string;
+}
+export type OptionalError = BaseError | null | undefined;
+export type ErrorContext = {
+    accountId?: number;
+};

package/types/Error.js

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

package/types/FieldsJS.d.ts

@@ -0,0 +1 @@
+export type FieldsArray<T> = Array<T | FieldsArray<T>>;

package/types/FieldsJS.js

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

package/types/FileManager.d.ts

@@ -0,0 +1,71 @@
+export 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;
+        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;
+};
+export type Folder = {
+    id: number | 'None';
+    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 FetchFilesResponse = {
+    limit: number;
+    offset: number;
+    objects: Array<File>;
+    total_count: number;
+};
+export type FetchFolderResponse = {
+    limit: number;
+    offset: number;
+    objects: Array<Folder>;
+    total_count: number;
+};
+export type SimplifiedFolder = Partial<Folder> & Pick<Folder, 'id' | 'name'>;

package/types/FileManager.js

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

package/types/Files.d.ts

@@ -0,0 +1,79 @@
+import { ValueOf } from '../types/Utils';
+import { STAT_TYPES, FILE_TYPES, FILE_UPLOAD_RESULT_TYPES } from '../constants/files';
+import { MODE } from '../constants/files';
+import { HttpOptions } from './Http';
+import { AxiosError } from 'axios';
+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: unknown;
+    file: string;
+};
+export type FileTree = {
+    source?: string;
+    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 = {
+    mode?: Mode;
+    remove?: boolean;
+    disableInitial?: boolean;
+    notify?: string;
+    commandOptions: {
+        convertFields?: boolean;
+    };
+    filePaths?: Array<string>;
+};
+export type WatchErrorHandler = (error: AxiosError) => void;
+export {};

package/types/Files.js

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

package/types/Functions.d.ts

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

package/types/Functions.js

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

package/types/Github.d.ts

@@ -0,0 +1,76 @@
+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 interface GithubSourceData {
+    branch: string;
+    owner: string;
+    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;
+};
+export {};

package/types/Github.js

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