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

package/types/Http.d.ts

@@ -0,0 +1,29 @@
+/// <reference types="node" />
+/// <reference types="node" />
+/// <reference types="node" />
+import { ResponseType } from 'axios';
+import { ReadStream } from 'fs';
+import { Stream } from 'stream';
+export type Data = {
+    [key: string]: any;
+};
+export type QueryParams = {
+    [key: string]: string | number | boolean | undefined;
+};
+export type FormData = {
+    [key: string]: string | ReadStream;
+};
+export type HttpOptions = {
+    baseURL?: string;
+    url: string;
+    env?: string;
+    localHostOverride?: boolean;
+    data?: Data | string | ArrayBuffer | ArrayBufferView | URLSearchParams | Stream | Buffer;
+    resolveWithFullResponse?: boolean;
+    params?: QueryParams;
+    timeout?: number;
+    responseType?: ResponseType;
+    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,109 @@
+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?: {
+        teamIds: Array<any>;
+        userIds: Array<any>;
+    };
+    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?: {
+        [key: string]: number;
+    };
+    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;
+        number_column?: number;
+        multiselect?: Array<any>;
+    };
+    path: string | null;
+    name: string | null;
+    childTableId?: string;
+    isSoftEditable?: boolean;
+};
+export type CreateRowsResponse = {
+    status: string;
+    results: Array<Row>;
+    startedAt?: string;
+    completedAt?: string;
+    links?: {
+        [key: string]: any;
+    };
+};
+export type FetchRowsResponse = {
+    total: number;
+    results: Array<Row>;
+    paging?: {
+        next: {
+            after: string | null;
+        };
+    } | null;
+};
+export type FetchTablesResponse = {
+    total: number;
+    results: Array<Table>;
+    paging?: {
+        next: {
+            after: string | null;
+        };
+    } | null;
+};

package/types/Hubdb.js

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

package/types/HublValidation.d.ts

@@ -0,0 +1,59 @@
+export type HublValidationOptions = {
+    is_available_for_new_content?: boolean;
+    template_type?: string;
+    template_path?: string;
+    module_path?: string;
+};
+export type HubLValidationError = {
+    reason: string;
+    message: string;
+    lineno: number;
+    startPosition: number;
+    categoryErrors: {
+        fullName?: string;
+        path?: string;
+    };
+    category: string;
+    severity?: string;
+};
+export type LintResult = {
+    file: string;
+    validation: Validation | null;
+};
+export type Validation = {
+    meta: {
+        all_widgets: Array<string>;
+        widgets_in_rich_text: Array<string>;
+        editable_flex_areas: Array<string>;
+        editable_layout_sections: {
+            key: string;
+        } | null;
+        email_style_settings: {
+            key: string;
+        } | null;
+        sms_flex_area: Array<string>;
+        google_font_variations: {
+            key: string;
+        } | null;
+        custom_font_variations: Array<string>;
+        has_style_tag: boolean;
+        has_header_tag: boolean;
+        output_html: string;
+        has_menu_tag: boolean;
+        has_theme_setting_function: boolean;
+        template_source: string;
+        attribute_defaults?: {
+            key: string;
+        } | null;
+        template_errors: Array<HubLValidationError>;
+        path_dependencies: Array<string>;
+        theme_field_dependencies: Array<string>;
+        template_type_ids?: {
+            key: string;
+        } | null;
+        exact_path_references: Array<string>;
+        required_scopes_to_render: Array<string>;
+    };
+    renderingErrors: Array<HubLValidationError>;
+    html: string;
+};

package/types/HublValidation.js

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

package/types/Lang.d.ts

@@ -0,0 +1,10 @@
+import lang from '../lang/en.json';
+import { Leaves } from './Utils';
+export type GenericLanguageObject = {
+    [key: string]: string | GenericLanguageObject;
+};
+export type LanguageObject = typeof lang;
+export type LangKey = Leaves<LanguageObject>;
+export type InterpolationData = {
+    [identifier: string]: string | number;
+};

package/types/Lang.js

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

package/types/Lighthouse.d.ts

@@ -0,0 +1,25 @@
+export type RequestLighthouseScoreResponse = {
+    desktopId: number;
+    mobileId: number;
+};
+export type GetLighthouseScoreResponse = {
+    portalId: number;
+    themePath: string;
+    status: string;
+    scores: [
+        {
+            accessibilityScore: number;
+            bestPracticesScore: number;
+            performanceScore: number;
+            pwaScore: number;
+            seoScore: number;
+            runWarnings: Array<string>;
+            auditDetails: null;
+            emulatedFormFactor: string;
+            templatePath: string | null;
+            link: string | null;
+        }
+    ];
+    failedTemplatePaths: Array<string>;
+    error: Error | null;
+};

package/types/Lighthouse.js

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

package/types/MarketplaceValidation.d.ts

@@ -0,0 +1,28 @@
+type Check = {
+    check: string;
+    status: string;
+    title: string;
+    documentationLink: string;
+    message: string | null;
+    description: string;
+    line: number | null;
+    file: string;
+};
+export type GetValidationResultsResponse = {
+    validationRequestId: number;
+    assetPath: string;
+    assetType: string;
+    results: {
+        REQUIRED: {
+            status: string;
+            results: Array<Check>;
+        };
+        RECOMMENDED: {
+            status: string;
+            results: Array<Check>;
+        };
+    };
+    errors: Array<Error>;
+    requestedAt: string;
+};
+export {};

package/types/MarketplaceValidation.js

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

package/types/Migration.d.ts

@@ -0,0 +1,28 @@
+import { ValueOf } from './Utils';
+import { OptionalError } from './Error';
+export declare const MIGRATION_STATUS: {
+    readonly BUILDING: "BUILDING";
+    readonly FAILURE: "FAILURE";
+    readonly PREPARING: "PREPARING";
+    readonly PENDING: "PENDING";
+    readonly SUCCESS: "SUCCESS";
+};
+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?: OptionalError;
+    status: ValueOf<typeof MIGRATION_STATUS>;
+};

package/types/Migration.js

@@ -0,0 +1,10 @@
+"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',
+};

package/types/Modules.d.ts

@@ -0,0 +1,16 @@
+export type PathInput = {
+    isLocal?: boolean;
+    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/Modules.js

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

package/types/PortManager.d.ts

@@ -0,0 +1,11 @@
+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/PortManager.js

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

package/types/Project.d.ts

@@ -0,0 +1,42 @@
+import { Build } from './Build';
+import { GithubSourceData } from './Github';
+export type Project = {
+    createdAt: number;
+    deletedAt: number;
+    deployedBuild?: Build;
+    deployedBuildId?: number;
+    id: number;
+    isLocked: boolean;
+    latestBuild?: Build;
+    name: string;
+    portalId: number;
+    sourceIntegration?: GithubSourceData;
+    updatedAt: number;
+};
+export type FetchProjectResponse = {
+    results: Array<Project>;
+};
+export type UploadProjectResponse = {
+    buildId: number;
+    projectTree: {
+        path: string;
+        name: string;
+        parentPath: string;
+        updatedAt: number;
+        children: Array<UploadProjectResponse>;
+        folder: boolean;
+    };
+    buildStatusTaskLocator: {
+        id: string;
+        links: {
+            status: string;
+        };
+    };
+};
+export type ProjectSettings = {
+    isAutoDeployEnabled: boolean;
+};
+export type FetchPlatformVersionResponse = {
+    defaultPlatformVersion: string;
+    activePlatformVersions: Array<string>;
+};

package/types/Project.js

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

package/types/ProjectLog.d.ts

@@ -0,0 +1,9 @@
+export type ProjectLog = {
+    lineNumber: number;
+    logLevel: string;
+    message: string;
+    pipelineStepId: number;
+    pipelineSubstepId?: string;
+    pipelineSubstepName?: string;
+    timestamp: number;
+};

package/types/ProjectLog.js

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

package/types/Sandbox.d.ts

@@ -0,0 +1,155 @@
+export type SandboxHubData = {
+    type?: string | null;
+    parentHubId?: number;
+};
+type User = {
+    userId: number;
+    firstName: string;
+    lastName: string;
+    gdprDeleted?: boolean;
+    removed?: boolean;
+    deactivated?: boolean;
+};
+type TaskError = {
+    message: string;
+    in: string;
+    code: string;
+    subCategory: string;
+    context: {
+        missingScopes: Array<string>;
+    };
+};
+type MutationError = {
+    message: string;
+    portableKey: string;
+    subResource: {
+        type: string;
+        key: string;
+    };
+    standardError: {
+        status: string;
+        id: string;
+        category: string;
+        subCategory: {
+            [key: string]: string;
+        };
+        message: string;
+        errors: Array<TaskError>;
+        context: {
+            additionalProp1: Array<string>;
+            additionalProp2: Array<string>;
+            additionalProp3: Array<string>;
+        };
+        links: {
+            additionalProp1: string;
+            additionalProp2: string;
+            additionalProp3: string;
+        };
+    };
+};
+type SyncMutationData = {
+    numRequests: number;
+    numSuccesses: number;
+    errors: Array<TaskError>;
+    mutationErrors: Array<MutationError>;
+};
+export type CompositeSyncTask = {
+    id: string;
+    parentHubId: number;
+    sandboxHubId: number;
+    fromHubId: number;
+    toHubId: number;
+    command: string;
+    type: string;
+    status: string;
+    result: string;
+    sandboxType: string;
+    requestedAt: string;
+    requestedByUserId: number;
+    requestedByUser: User;
+    startedAt: string;
+    completedAt: string;
+    error: MutationError;
+    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;
+    createdAt: string;
+    updatedAt?: string | null;
+    archivedAt?: string | null;
+    type: string;
+    archived: boolean;
+    name: string;
+    domain: string;
+    createdByUser: User;
+    updatedByUser?: User | null;
+    lastSync?: SyncTask;
+    currentUserHasAccess?: boolean;
+    currentUserHasSuperAdminAccess?: boolean;
+    requestAccessFrom?: User | null;
+    superAdminsInSandbox?: number;
+};
+export type SandboxResponse = {
+    sandbox: Sandbox;
+    personalAccessKey: string;
+};
+export type Usage = {
+    STANDARD: {
+        used: number;
+        available: number;
+        limit: number;
+    };
+    DEVELOPER: {
+        used: number;
+        available: number;
+        limit: number;
+    };
+};
+export type SandboxUsageLimitsResponse = {
+    usage: Usage;
+};
+export type TaskRequestData = {
+    type: string;
+};
+export type InitiateSyncResponse = {
+    links: {
+        status: string;
+    };
+    sync: SyncTask;
+    id: string;
+};
+export type SandboxType = {
+    name: string;
+    dependsOn: Array<string>;
+    pushToProductionEnabled: boolean;
+    isBeta: boolean;
+    diffEnabled: boolean;
+    groupType: string;
+    syncMandatory: boolean;
+};
+export type FetchTypesResponse = {
+    results: Array<SandboxType>;
+};
+export {};

package/types/Sandbox.js

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

package/types/Schemas.d.ts

@@ -0,0 +1,39 @@
+export type Schema = {
+    id: string;
+    name: string;
+    createdAt?: string;
+    updatedAt?: string;
+    properties: Array<any>;
+    associations: Array<{
+        id: string;
+        fromObjectTypeId: string;
+        toObjectTypeId: string;
+        name?: string;
+        createdAt?: string | null;
+        updatedAt?: string | null;
+    }>;
+    labels: {
+        singular?: string;
+        plural?: string;
+    };
+    requiredProperties: Array<string>;
+    searchableProperties?: Array<string>;
+    primaryDisplayProperty?: string;
+    fullyQualifiedName?: string;
+    [key: string]: any;
+};
+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;
+    }>;
+};

package/types/Schemas.js

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

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

@@ -0,0 +1,6 @@
+export type ValueOf<T> = T[keyof T];
+type Join<K, P> = K extends string | number ? P extends string | number ? `${K}${'' extends P ? '' : '.'}${P}` : never : never;
+export type Leaves<T> = [10] extends [never] ? never : T extends object ? {
+    [K in keyof T]-?: Join<K, Leaves<T[K]>>;
+}[keyof T] : '';
+export {};

package/types/Utils.js

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

package/types/developerTestAccounts.d.ts

@@ -0,0 +1,12 @@
+export type DeveloperTestAccount = {
+    testPortalId: number;
+    parentPortalId: number;
+    accountName: string;
+    createdAt: string;
+    updatedAt: string;
+    status: string;
+};
+export type FetchDeveloperTestAccountsResponse = {
+    results: DeveloperTestAccount[];
+    maxTestPortals: number;
+};

package/types/developerTestAccounts.js

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