@mintlify/validation/dist/types/deployment/index.d.ts

Validates mint.json files

import { Analytics, MintConfig, InkeepType, FeatureFlags, LlmSupportedLocaleType, PlanTypeV2 } from '@mintlify/models';
import { DocsConfig } from '../../mint-config/schemas/v2/index.js';
import { AssistantType } from './assistant.js';
import { Auth, PreviewDeploymentAuth, UserAuth } from './auth.js';
import { DeployConfig } from './deployConfig.js';
import { DeploymentEntitlements } from './deploymentEntitlements.js';
import { DeploymentFeedbackType } from './deploymentFeedback.js';
import { EditorPermissionsType, EditorType } from './editor.js';
import { GitlabSource, GithubSource } from './gitSource.js';
import { GitSource } from './gitSource.js';
import { MCPType } from './mcp.js';
import { DeploymentPreviewType, PreviewType } from './preview.js';
import { SourceCheckType } from './sourceCheck.js';
import { StripeDeploymentDataType } from './stripe.js';
import { TrieveType } from './trieve.js';
export type DeploymentType = {
    name: string;
    subdomain: string;
    orgId: string;
    plan?: PlanTypeV2;
    createdAt?: string;
    gitSource: GitSource;
    sourceChecks?: SourceCheckType[];
    analytics?: Analytics;
    basePath: string;
    customDomains?: string[];
    mintConfig?: MintConfig;
    docsConfig: DocsConfig;
    inkeep?: InkeepType;
    featureFlags?: FeatureFlags;
    isWhiteLabeled?: boolean;
    trieve?: TrieveType;
    disableAiChat?: boolean;
    disable404SuggestedPages?: boolean;
    isHostedByMintlify?: boolean;
    auth?: Auth;
    previewDeploymentAuth?: PreviewDeploymentAuth;
    userAuth?: UserAuth;
    editorPermissions?: EditorPermissionsType;
    stripe?: StripeDeploymentDataType;
    preview?: PreviewType;
    allowedAutomatedLanguages?: LlmSupportedLocaleType[];
    enabledContinuousTranslations?: LlmSupportedLocaleType[];
    entitlements?: DeploymentEntitlements;
    feedback?: DeploymentFeedbackType;
    mcp?: MCPType;
    assistant?: AssistantType;
    deployConfig?: DeployConfig;
    editor?: EditorType;
};
export type StaticPropsDeploymentAuthType = {
    partial: boolean;
    logoutUrl?: string;
};
export type StaticPropsDeploymentType = Pick<DeploymentType, 'basePath' | 'customDomains' | 'disable404SuggestedPages' | 'disableAiChat' | 'entitlements' | 'featureFlags' | 'feedback' | 'inkeep' | 'isWhiteLabeled' | 'mintConfig' | 'subdomain' | 'trieve' | 'userAuth' | 'docsConfig' | 'assistant'> & {
    auth?: StaticPropsDeploymentAuthType;
    gitSource: GitSource;
    preview?: DeploymentPreviewType;
};
export type GithubDeploymentType = DeploymentType & {
    gitSource: GithubSource;
};
export type GitlabDeploymentType = DeploymentType & {
    gitSource: GitlabSource;
};
export * from './auth.js';
export * from './deploymentEntitlements.js';
export * from './deploymentFeedback.js';
export * from './gitSource.js';
export * from './sourceCheck.js';
export * from './stripe.js';
export * from './trieve.js';
export * from './assistant.js';
export * from './deployConfig.js';
export * from './preview.js';
export * from './editor.js';