UNPKG

amplify-cli-core

Version:
1,634 lines (1,454 loc) 68.4 kB
## API Report File for "amplify-cli-core" > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts /// <reference types="node" /> import Ajv from 'ajv'; import { ApiKeyConfig } from '@aws-amplify/graphql-transformer-interfaces'; import * as cdk from 'aws-cdk-lib'; import { ChildProcess } from 'child_process'; import { DeploymentResources } from '@aws-amplify/graphql-transformer-interfaces'; import opn from 'open'; import { Ora } from 'ora'; import { Template as Template_2 } from 'cloudform-types'; // @public (undocumented) export type $TSAny = any; // @public (undocumented) export type $TSContext = { amplify: AmplifyToolkit; print: IContextPrint; migrationInfo: MigrationInfo; projectHasMobileHubResources: boolean; prompt: $TSAny; exeInfo: EnvironmentInfo & InputParameters & PinpointInfo & ProjectInfo; input: CommandLineInput; parameters: ContextParameters; usageData: IUsageData; runtime: Runtime; pluginPlatform: IPluginPlatform; newUserInfo?: string; filesystem: IContextFilesystem; template: IContextTemplate; }; // @public (undocumented) export type $TSCopyJob = $TSAny; // @public (undocumented) export type $TSMeta = $TSAny; // @public (undocumented) export type $TSObject = Record<string, $TSAny>; // @public (undocumented) export type $TSTeamProviderInfo = $TSAny; // @public (undocumented) export const AMPLIFY_DOCS_URL = "https://docs.amplify.aws"; // @public (undocumented) export const AMPLIFY_SUPPORT_DOCS: { CLI_PROJECT_TROUBLESHOOTING: { name: string; url: string; }; CLI_GRAPHQL_TROUBLESHOOTING: { name: string; url: string; }; CLI_EXTENSIBILITY: { name: string; url: string; }; AWS_CUSTOM_DOMAIN_TROUBLESHOOTING: { name: string; url: string; }; AMPLIFY_IAM_TROUBLESHOOTING_URL: { name: string; url: string; }; AMPLIFY_DATASTORE: { name: string; url: string; }; AWS_CLOUDFORMATION_DRIFT: { name: string; url: string; }; AWS_KNOWLEDGE_CENTER: { name: string; url: string; }; }; // @public (undocumented) export const AmplifyCategories: { STORAGE: string; API: string; AUTH: string; FUNCTION: string; HOSTING: string; INTERACTIONS: string; NOTIFICATIONS: string; PREDICTIONS: string; ANALYTICS: string; CUSTOM: string; }; // @public (undocumented) export abstract class AmplifyCategoryTransform { constructor(resourceName: string); // (undocumented) abstract applyOverride(): Promise<void>; // (undocumented) resourceName: string; // (undocumented) abstract saveBuildFiles(context: $TSContext, template: Template): Promise<void>; // (undocumented) abstract transform(context: $TSContext): Promise<Template>; } // @public (undocumented) export class AmplifyError extends AmplifyException { constructor(name: AmplifyErrorType, options: AmplifyExceptionOptions, downstreamException?: Error); } // @public (undocumented) export type AmplifyErrorType = 'AmplifyStudioError' | 'AmplifyStudioLoginError' | 'AmplifyStudioNotEnabledError' | 'ApiCategorySchemaNotFoundError' | 'AuthImportError' | 'BackendConfigValidationError' | 'BucketAlreadyExistsError' | 'BucketNotFoundError' | 'CategoryNotEnabledError' | 'CloudFormationTemplateError' | 'CommandNotSupportedError' | 'ConfigurationError' | 'CustomPoliciesFormatError' | 'DebugConfigValueNotSetError' | 'DeploymentError' | 'DeploymentInProgressError' | 'DestructiveMigrationError' | 'DiagnoseReportUploadError' | 'DirectoryAlreadyExistsError' | 'DirectoryError' | 'DuplicateLogicalIdError' | 'EnvironmentConfigurationError' | 'EnvironmentNameError' | 'EnvironmentNotInitializedError' | 'ExportError' | 'FeatureFlagsValidationError' | 'FileSystemPermissionsError' | 'FrameworkNotSupportedError' | 'FunctionTooLargeError' | 'GraphQLError' | 'InputValidationError' | 'InvalidAmplifyAppIdError' | 'InvalidCustomResourceError' | 'InvalidDirectiveError' | 'InvalidGSIMigrationError' | 'InvalidMigrationError' | 'InvalidOverrideError' | 'InvalidStackError' | 'InvalidTransformerError' | 'IterativeRollbackError' | 'LambdaFunctionInvokeError' | 'LambdaLayerDeleteError' | 'MigrationError' | 'MissingAmplifyMetaFileError' | 'MissingExpectedParameterError' | 'MissingOverridesInstallationRequirementsError' | 'MockProcessError' | 'ModelgenError' | 'NestedProjectInitError' | 'NotImplementedError' | 'NoUpdateBackendError' | 'OpenSslCertificateError' | 'PackagingLambdaFunctionError' | 'ParameterNotFoundError' | 'PermissionsError' | 'PluginMethodNotFoundError' | 'PluginNotFoundError' | 'PluginPolicyAddError' | 'ProfileConfigurationError' | 'ProjectAppIdResolveError' | 'ProjectInitError' | 'ProjectNotFoundError' | 'ProjectNotInitializedError' | 'PushResourcesError' | 'RegionNotAvailableError' | 'RemoveNotificationAppError' | 'ResourceAlreadyExistsError' | 'ResourceCountLimitExceedError' | 'ResourceDoesNotExistError' | 'ResourceInUseError' | 'ResourceNotReadyError' | 'SchemaNotFoundError' | 'SchemaValidationError' | 'SearchableMockProcessError' | 'SearchableMockUnavailablePortError' | 'SearchableMockUnsupportedPlatformError' | 'StackNotFoundError' | 'StackStateError' | 'StorageImportError' | 'TransformerContractError' | 'UnknownDirectiveError' | 'UnsupportedLockFileTypeError' | 'UserInputError'; // @public (undocumented) export enum AmplifyEvent { // (undocumented) InternalOnlyPostEnvRemove = "InternalOnlyPostEnvRemove", // (undocumented) PostCodegenModels = "PostCodegenModels", // (undocumented) PostEnvAdd = "PostEnvAdd", // (undocumented) PostInit = "PostInit", // (undocumented) PostPull = "PostPull", // (undocumented) PostPush = "PostPush", // (undocumented) PreCodegenModels = "PreCodegenModels", // (undocumented) PreExport = "PreExport", // (undocumented) PreInit = "PreInit", // (undocumented) PrePull = "PrePull", // (undocumented) PrePush = "PrePush" } // @public (undocumented) export interface AmplifyEventArgs<T extends AmplifyEvent> { // (undocumented) data?: AmplifyEventData[T]; // (undocumented) event: T; } // @public (undocumented) export interface AmplifyEventData { // (undocumented) [AmplifyEvent.InternalOnlyPostEnvRemove]: AmplifyInternalOnlyPostEnvRemoveEventData; // (undocumented) [AmplifyEvent.PostCodegenModels]: NoArgsAmplifyEventData; // (undocumented) [AmplifyEvent.PostEnvAdd]: AmplifyPostEnvAddEventData; // (undocumented) [AmplifyEvent.PostInit]: NoArgsAmplifyEventData; // (undocumented) [AmplifyEvent.PostPull]: NoArgsAmplifyEventData; // (undocumented) [AmplifyEvent.PostPush]: NoArgsAmplifyEventData; // (undocumented) [AmplifyEvent.PreCodegenModels]: NoArgsAmplifyEventData; // (undocumented) [AmplifyEvent.PreExport]: NoArgsAmplifyEventData; // (undocumented) [AmplifyEvent.PreInit]: NoArgsAmplifyEventData; // (undocumented) [AmplifyEvent.PrePull]: NoArgsAmplifyEventData; // (undocumented) [AmplifyEvent.PrePush]: NoArgsAmplifyEventData; } // @public (undocumented) export abstract class AmplifyException extends Error { constructor(name: AmplifyExceptionType, classification: AmplifyExceptionClassification, options: AmplifyExceptionOptions, downstreamException?: Error | undefined); // (undocumented) readonly classification: AmplifyExceptionClassification; // (undocumented) readonly code?: string; // (undocumented) readonly details?: string; // (undocumented) readonly downstreamException?: Error | undefined; // (undocumented) readonly link?: string; // (undocumented) readonly message: string; // (undocumented) readonly name: AmplifyExceptionType; // (undocumented) readonly options: AmplifyExceptionOptions; // (undocumented) readonly resolution?: string; // (undocumented) toObject: () => object; } // @public (undocumented) export type AmplifyExceptionClassification = 'FAULT' | 'ERROR'; // @public (undocumented) export type AmplifyExceptionOptions = { message: string; details?: string; resolution?: string; link?: string; code?: string; }; // @public (undocumented) export type AmplifyExceptionType = AmplifyErrorType | AmplifyFaultType; // @public (undocumented) export class AmplifyFault extends AmplifyException { constructor(name: AmplifyFaultType, options: AmplifyExceptionOptions, downstreamException?: Error); } // @public (undocumented) export type AmplifyFaultType = 'AmplifyBackupFault' | 'AnalyticsCategoryFault' | 'AuthCategoryFault' | 'BackendDeleteFault' | 'BackendPullFault' | 'ConfigurationFault' | 'ConfigurationFault' | 'DeploymentFault' | 'DeploymentStateUploadFault' | 'FileNotFoundFault' | 'LockFileNotFoundFault' | 'LockFileParsingFault' | 'MockProcessFault' | 'NotificationsChannelAPNSFault' | 'NotificationsChannelEmailFault' | 'NotificationsChannelFCMFault' | 'NotificationsChannelInAppMessagingFault' | 'NotificationsChannelSmsFault' | 'NotImplementedFault' | 'ParameterDownloadFault' | 'ParameterUploadFault' | 'PluginNotLoadedFault' | 'ProjectDeleteFault' | 'ParametersDeleteFault' | 'ProjectInitFault' | 'PullBackendFault' | 'PushResourcesFault' | 'ResourceExportFault' | 'ResourceNotFoundFault' | 'ResourceNotReadyFault' | 'ResourceRemoveFault' | 'RootStackNotFoundFault' | 'ServiceCallFault' | 'SnsSandboxModeCheckFault' | 'TimeoutFault' | 'TriggerUploadFault' | 'UnexpectedS3Fault' | 'UnknownFault' | 'UnknownNodeJSFault' | 'ZipExtractFault'; // @public (undocumented) export enum AmplifyFrontend { // (undocumented) android = "android", // (undocumented) ios = "ios", // (undocumented) javascript = "javascript" } // @public (undocumented) export interface AmplifyInternalOnlyPostEnvRemoveEventData { // (undocumented) envName: string; } // @public (undocumented) export class AmplifyNodePkgDetector { constructor(amplifyDetectorProps: AmplifyNodePkgDetectorProps); // (undocumented) detectAffectedDirectDependencies: (dependencyToSearch: string) => Array<DetectedDependency> | []; } // @public (undocumented) export type AmplifyNodePkgDetectorProps = { projectRoot: string; }; // @public (undocumented) export interface AmplifyPostEnvAddEventData { // (undocumented) newEnvName: string; // (undocumented) prevEnvName: string; } // @public (undocumented) export interface AmplifyProjectConfig { // (undocumented) frontend: AmplifyFrontend; // (undocumented) projectName: string; // (undocumented) providers: string[]; // (undocumented) version: string; } // @public (undocumented) export interface AmplifyStackTemplate { // (undocumented) addCfnCondition: (props: cdk.CfnConditionProps, logicalId: string) => void; // (undocumented) addCfnMapping: (props: cdk.CfnMappingProps, logicalId: string) => void; // (undocumented) addCfnOutput: (props: cdk.CfnOutputProps, logicalId: string) => void; // (undocumented) addCfnParameter: (props: cdk.CfnParameterProps, logicalId: string) => void; // (undocumented) getCfnCondition: (logicalId: string) => cdk.CfnCondition; // (undocumented) getCfnMapping: (logicalId: string) => cdk.CfnMapping; // (undocumented) getCfnOutput: (logicalId: string) => cdk.CfnOutput; // (undocumented) getCfnParameter: (logicalId: string) => cdk.CfnParameter; } // @public (undocumented) export const AmplifySupportedService: { APIGW: string; APPSYNC: string; S3: string; DYNAMODB: string; COGNITO: string; COGNITOUSERPOOLGROUPS: string; LAMBDA: string; LAMBDA_LAYER: string; PINPOINT: string; KINESIS: string; }; // @public (undocumented) export class AngularConfigNotFoundError extends AmplifyError { constructor(errMessage?: string); } // @public (undocumented) export class ApiCategoryFacade { // (undocumented) static getDirectiveDefinitions(context: $TSContext, resourceDir: string): Promise<string>; // (undocumented) static getTransformerVersion(context: $TSContext): Promise<number>; // (undocumented) static transformGraphQLSchema(context: $TSContext, options: $TSAny): Promise<DeploymentResources | undefined>; } // @public (undocumented) export function attachExtensions(context: $TSContext): void; // @public (undocumented) export function attachPrint(context: $TSContext): void; // @public (undocumented) export const AWS_AMPLIFY_DEFAULT_BANNER_URL = "https://aws-amplify.github.io/amplify-cli/banner-message.json"; // @public (undocumented) export const AWS_DOCS_URL = "https://docs.aws.amazon.com/"; // @public (undocumented) export const AWS_PREMIUM_SUPPORT_URL = "https://aws.amazon.com/premiumsupport"; // @public (undocumented) export class BannerMessage { // (undocumented) static getMessage: (messageId: string) => Promise<string | undefined>; // (undocumented) getMessages: (messageId: string) => Promise<string | undefined>; // (undocumented) static initialize: (cliVersion: string) => BannerMessage; } // @public (undocumented) export function blue(message: string): void; // @public (undocumented) export type BooleanFeatureFlag = { type: 'boolean'; name: string; defaultValueForExistingProjects: boolean; defaultValueForNewProjects: boolean; }; // @public (undocumented) export const buildOverrideDir: (cwd: string, destDirPath: string) => Promise<boolean>; // @public (undocumented) export abstract class CategoryInputState { constructor(resourceName: string); // (undocumented) abstract getCLIInputPayload(): $TSAny; // (undocumented) abstract isCLIInputsValid(props: $TSAny): void; // (undocumented) _resourceName: string; // (undocumented) abstract saveCLIInputPayload(props: $TSAny): void; } // @public (undocumented) export type CategoryName = string; // @public (undocumented) export enum CFNTemplateFormat { // (undocumented) JSON = "json", // (undocumented) YAML = "yaml" } // @public (undocumented) export interface CLIContext { // (undocumented) getEnvInfo: () => $TSAny; } // @public (undocumented) export class CLIContextEnvironmentProvider implements CLIEnvironmentProvider { // Warning: (ae-forgotten-export) The symbol "EnvInfoProvider" needs to be exported by the entry point index.d.ts constructor(context: EnvInfoProvider); // (undocumented) getCurrentEnvName(): string; } // @public (undocumented) export interface CLIEnvironmentProvider { // (undocumented) getCurrentEnvName(): string; } // @public (undocumented) export type CLIGlobalFlags = { version?: boolean; help?: boolean; yes?: boolean; }; // @public (undocumented) export class CLIInputSchemaGenerator { constructor(typeDefs: TypeDef[]); // (undocumented) generateJSONSchemas(): string[]; // (undocumented) OVERWRITE_SCHEMA_FLAG: string; // (undocumented) SCHEMA_FILES_ROOT: string; // (undocumented) TYPES_SRC_ROOT: string; } // @public (undocumented) export class CLIInputSchemaValidator { constructor(context: $TSContext, service: string, category: string, schemaFileName: string); // (undocumented) _ajv: Ajv.Ajv; // (undocumented) _category: string; // (undocumented) _context: $TSContext; // (undocumented) getUserInputSchema(): Promise<any>; // (undocumented) _schemaFileName: string; // (undocumented) _service: string; // (undocumented) validateInput(userInput: string): Promise<boolean>; } // @public (undocumented) export interface CLIParams { // (undocumented) cliCommand: string; // (undocumented) cliOptions: Record<string, $TSAny>; // (undocumented) cliSubcommands: string[] | undefined; } // @public (undocumented) export const CLISubCommands: { ADD: string; PUSH: string; PULL: string; REMOVE: string; UPDATE: string; CONSOLE: string; IMPORT: string; }; // @public (undocumented) export enum CLISubCommandType { // (undocumented) ADD = "add", // (undocumented) CONSOLE = "console", // (undocumented) IMPORT = "import", // (undocumented) MIGRATE = "migrate", // (undocumented) OVERRIDE = "override", // (undocumented) PULL = "pull", // (undocumented) PUSH = "push", // (undocumented) REMOVE = "remove", // (undocumented) UPDATE = "update" } // @public (undocumented) export class CloudformationProviderFacade { // (undocumented) static getApiKeyConfig(context: $TSContext): Promise<ApiKeyConfig>; // (undocumented) static hashDirectory(context: $TSContext, directory: string): Promise<string>; // (undocumented) static isAmplifyAdminApp(context: $TSContext, appId: string): Promise<{ isAdminApp: boolean; region: string; userPoolID: string; }>; // (undocumented) static prePushCfnTemplateModifier(context: $TSContext, template: Template_2): Promise<(template: Template_2) => Promise<void>>; } // @public (undocumented) export type CommandFlagInfo = { short: string; long: string; flagDescription: string; }; // @public (undocumented) export type CommandInfo = { command: string; commandDescription: string; commandUsage: string; commandFlags: Array<CommandFlagInfo>; subCommands: Array<SubCommandInfo>; }; // @public (undocumented) export type CommandLineInput = { argv: Array<string>; plugin?: string; command: string; subCommands?: string[]; options?: CLIGlobalFlags & Record<string, $TSAny>; }; // @public (undocumented) export const commandsInfo: Array<CommandInfo>; // @public (undocumented) export class ConfigurationError extends AmplifyError { constructor(errMessage?: string); } // @public (undocumented) export const constants: { HELP: string; HELP_SHORT: string; VERSION: string; VERSION_SHORT: string; VERBOSE: string; YES: string; YES_SHORT: string; PLUGIN_DEFAULT_COMMAND: string; MANIFEST_FILE_NAME: string; PACKAGEJSON_FILE_NAME: string; PLUGINS_FILE_NAME: string; CORE: string; CODEGEN: string; AMPLIFY: string; DOT_AMPLIFY_DIR_NAME: string; DEFAULT_PROVIDER: string; AMPLIFY_PREFIX: string; LOCAL_NODE_MODULES: string; PARENT_DIRECTORY: string; GLOBAL_NODE_MODULES: string; PACKAGED_NODE_MODULES: string; EXECUTE_AMPLIFY_COMMAND: string; EXECUTE_AMPLIFY_HEADLESS_COMMAND: string; HANDLE_AMPLIFY_EVENT: string; LOG_FILENAME: string; }; // @public (undocumented) export interface ContextParameters extends Pick<CommandLineInput, 'argv' | 'plugin' | 'command' | 'options'> { // (undocumented) array: CommandLineInput['subCommands']; // (undocumented) first?: string; // (undocumented) raw: CommandLineInput['argv']; // (undocumented) second?: string; // (undocumented) third?: string; } // @public (undocumented) export const convertNumBytes: (numBytes: number) => { toKB: () => number; toMB: () => number; }; // @public (undocumented) export function createDefaultCustomPoliciesFile(categoryName: string, resourceName: string): void; // @public (undocumented) export type CustomIAMPolicies = CustomIAMPolicy[]; // @public (undocumented) export const CustomIAMPoliciesSchema: { type: string; minItems: number; items: { type: string; properties: { Action: { type: string; items: { type: string; }; minItems: number; nullable: boolean; }; Resource: { type: string; anyOf: ({ contains: { type: string; additionalProperties?: undefined; }; } | { contains: { type: string; additionalProperties: boolean; }; })[]; minItems: number; nullable: boolean; }; }; optionalProperties: { Effect: { type: string; enum: string[]; default: string; }; }; required: string[]; additionalProperties: boolean; }; additionalProperties: boolean; }; // @public (undocumented) export type CustomIAMPolicy = { Action: string[]; Effect?: string; Resource: (string | $TSObject)[]; }; // @public (undocumented) export class CustomPoliciesFormatError extends AmplifyError { constructor(errMessage?: string); } // @public (undocumented) export type DataParameter = { amplify: { version?: string; environment?: string; command?: string; subCommand?: string; argv?: string[]; }; }; // @public (undocumented) export function debug(message: string, title?: string): void; // @public (undocumented) export class DebugConfigValueNotSetError extends AmplifyError { constructor(errMessage?: string); } // @public (undocumented) export const defaultSupportedExt: HookExtensions; // @public (undocumented) export type DeploymentSecrets = { appSecrets: Array<{ rootStackId: string; environments: { [env: string]: { [category: string]: { [resourceName: string]: { [key: string]: string; }; }; }; }; }>; }; // @public (undocumented) export type DeploymentState = { version: '1'; startedAt?: string; finishedAt?: string; status: DeploymentStatus; currentStepIndex: number; steps: DeploymentStepState[]; }; // @public (undocumented) export enum DeploymentStatus { // (undocumented) 'DEPLOYED' = "DEPLOYED", // (undocumented) 'DEPLOYING' = "DEPLOYING", // (undocumented) 'FAILED' = "FAILED", // (undocumented) 'IDLE' = "IDLE", // (undocumented) 'ROLLED_BACK' = "ROLLED_BACK", // (undocumented) 'ROLLING_BACK' = "ROLLING_BACK" } // @public (undocumented) export type DeploymentStepState = { status: DeploymentStepStatus; previousMetaKey?: string; }; // @public (undocumented) export enum DeploymentStepStatus { // (undocumented) 'DEPLOYED' = "DEPLOYED", // (undocumented) 'DEPLOYING' = "DEPLOYING", // (undocumented) 'ROLLED_BACK' = "ROLLED_BACK", // (undocumented) 'ROLLING_BACK' = "ROLLING_BACK", // (undocumented) 'WAITING_FOR_DEPLOYMENT' = "WAITING_FOR_DEPLOYMENT", // (undocumented) 'WAITING_FOR_ROLLBACK' = "WAITING_FOR_ROLLBACK", // (undocumented) 'WAITING_FOR_TABLE_TO_BE_READY' = "WAITING_FOR_TABLE_TO_BE_READY" } // @public (undocumented) export type DetectedDependency = { packageName?: string; dependentPackage?: { name: string; version: string; }; }; // @public (undocumented) export class DiagnoseReportUploadError extends AmplifyError { constructor(errMessage?: string); } // @public (undocumented) type EnvironmentInfo = { existingLocalEnvInfo?: LocalEnvInfo; isNewEnv?: boolean; sourceEnvName?: string; }; // @public (undocumented) export class EnvVarFormatError extends Error { constructor(variableName: string); } // @public (undocumented) export function error(message: string): void; // @public (undocumented) export type ErrorParameter = { message: string; stack: string; }; // @public (undocumented) export type EventPrefix = 'pre' | 'post'; // @public (undocumented) export const executeHooks: (hooksMetadata: HooksMeta) => Promise<void>; declare namespace ExeInfo { export { EnvironmentInfo, InputParameters, PinpointInfo, ProjectInfo } } export { ExeInfo } // @public (undocumented) export const exitOnNextTick: (code: number) => void; // @public (undocumented) export class ExportedStackNotFoundError extends AmplifyError { constructor(errMessage?: string); } // @public (undocumented) export class ExportedStackNotInValidStateError extends AmplifyError { constructor(errMessage?: string); } // @public (undocumented) export class ExportPathValidationError extends AmplifyError { constructor(errMessage?: string); } // @public (undocumented) export function fancy(message?: string): void; // @public (undocumented) export type FeatureFlagConfiguration = { project: FeatureFlagsEntry; environments: Record<string, FeatureFlagsEntry>; }; // @public (undocumented) export type FeatureFlagRegistration = NumberFeatureFlag | BooleanFeatureFlag; // @public (undocumented) export class FeatureFlags { // (undocumented) static ensureDefaultFeatureFlags: (newProject: boolean) => Promise<void>; // (undocumented) static ensureFeatureFlag: (featureFlagSection: string, featureFlagName: string) => Promise<void>; // (undocumented) static getBoolean: (flagName: string) => boolean; // (undocumented) static getEffectiveFlags: () => Readonly<FeatureFlagsEntry>; // (undocumented) static getExistingProjectDefaults: () => Readonly<FeatureFlagsEntry>; // (undocumented) static getNewProjectDefaults: () => Readonly<FeatureFlagsEntry>; // (undocumented) static getNumber: (flagName: string) => number; // (undocumented) static initialize: (environmentProvider: CLIEnvironmentProvider, useNewDefaults?: boolean, additionalFlags?: Record<string, FeatureFlagRegistration[]>) => Promise<void>; // (undocumented) static isInitialized: () => boolean; // (undocumented) static reloadValues: () => Promise<void>; // (undocumented) static removeFeatureFlagConfiguration: (removeProjectConfiguration: boolean, envNames: string[]) => Promise<void>; } // @public (undocumented) export type FeatureFlagsEntry = Record<string, Record<string, $TSAny>>; // @public (undocumented) export type FeatureFlagType = 'boolean' | 'number'; // @public (undocumented) export interface FlowRecorder { // (undocumented) assignProjectIdentifier: (envName?: string) => string | undefined; // (undocumented) getFlowReport: () => IFlowReport | Record<string, never>; // (undocumented) pushHeadlessFlow: (headlessFlowDataString: string, input: CommandLineInput) => void; // (undocumented) pushInteractiveFlow: (prompt: string, input: unknown) => void; // (undocumented) setIsHeadless: (headless: boolean) => void; } // @public (undocumented) export enum FromStartupTimedCodePaths { // (undocumented) PLATFORM_STARTUP = "platformStartup", // (undocumented) TOTAL_DURATION = "totalDuration" } // @public (undocumented) export type FunctionBreadcrumb = { pluginId: string; functionRuntime: string; defaultEditorFile: string; useLegacyBuild: true; }; // @public (undocumented) export const generateAmplifyOverrideProjectBuildFiles: (backendDir: string, srcResourceDirPath: string) => void; // @public (undocumented) export function generateCustomPoliciesInTemplate(template: Template_2, resourceName: string, service: string, category: string): Template_2; // @public (undocumented) export const generateOverrideSkeleton: (context: $TSContext, srcResourceDirPath: string, destDirPath: string) => Promise<void>; // @public (undocumented) export const generateTsConfigforProject: (srcResourceDirPath: string, destDirPath: string) => void; // @public (undocumented) export function getAmplifyResourceByCategories(category: string): string[]; // @public (undocumented) export function getFolderSize(filePaths: string | string[]): Promise<number>; // @public (undocumented) export function getGraphQLTransformerAuthDocLink(version: number): string; // @public (undocumented) export function getGraphQLTransformerAuthSubscriptionsDocLink(version: number): string; // @public (undocumented) export function getGraphQLTransformerFunctionDocLink(version: number): string; // @public (undocumented) export function getGraphQLTransformerOpenSearchDocLink(version: number): string; // @public (undocumented) export function getGraphQLTransformerOpenSearchProductionDocLink(version: number): string; // @public (undocumented) export function getMigrateResourceMessageForOverride(categoryName: string, resourceName: string, isUpdate?: boolean): string; // @public (undocumented) export type GetOptions<T> = { throwIfNotExist?: boolean; preserveComments?: boolean; default?: T; }; // @public (undocumented) export type GetPackageAssetPaths = () => Promise<string[]>; // @public (undocumented) export const getPackageManager: (rootPath?: string) => PackageManager | null; // @public (undocumented) export const getPermissionsBoundaryArn: (env?: string) => string | undefined; // @public (undocumented) export function green(message: string): void; // @public (undocumented) export type HookEvent = { command: string; subCommand?: string; argv: string[]; eventPrefix?: EventPrefix; forcePush: boolean; }; // @public (undocumented) export type HookExtensions = Record<string, { runtime: string; runtime_options?: string[]; runtime_windows?: string; }>; // @public (undocumented) export type HookFileMeta = { baseName: string; extension?: string; filePath?: string; fileName: string; }; // @public (undocumented) export const hookFileSeparator = "-"; // @public (undocumented) export type HooksConfig = { extensions?: HookExtensions; ignore?: string[]; }; // @public (undocumented) export class HooksMeta { // (undocumented) getDataParameter(): DataParameter; // (undocumented) getErrorParameter(): ErrorParameter | undefined; // (undocumented) getHookEvent(): HookEvent; // (undocumented) static getInstance: (input?: CommandLineInput, eventPrefix?: EventPrefix, errorParameter?: ErrorParameter) => HooksMeta; // (undocumented) mergeDataParameter(newDataParameter: DataParameter): void; // (undocumented) setAmplifyVersion(amplifyVersion: string): void; // (undocumented) setEnvironmentName(envName?: string): void; // (undocumented) setErrorParameter(errorParameter?: ErrorParameter): void; // (undocumented) setEventCommand(command: string): void; // (undocumented) setEventPrefix(prefix?: EventPrefix): void; // (undocumented) setEventSubCommand(subCommand?: string): void; // (undocumented) setHookEventFromInput(input?: CommandLineInput): void; } // @public (undocumented) export type HooksNoun = 'notifications' | 'analytics' | 'api' | 'auth' | 'function' | 'hosting' | 'interactions' | 'predictions' | 'storage' | 'codegen' | 'env'; // @public (undocumented) export type HooksVerb = 'add' | 'update' | 'remove' | 'push' | 'pull' | 'publish' | 'delete' | 'checkout' | 'list' | 'get' | 'mock' | 'build' | 'status' | 'import' | 'gqlcompile' | 'addgraphqldatasource' | 'statements' | 'types'; // Warning: (ae-forgotten-export) The symbol "TagVariables" needs to be exported by the entry point index.d.ts // // @public (undocumented) export function HydrateTags(tags: Tag[], tagVariables: TagVariables, skipProjectEnv?: boolean): Tag[]; // @public (undocumented) export interface IAmplifyResource { // (undocumented) category: string; // (undocumented) id?: string; // (undocumented) region?: string; // (undocumented) resourceName: string; // (undocumented) service: string; } // @public (undocumented) export interface IAnalyticsResource extends IAmplifyResource { // (undocumented) id?: string; // (undocumented) output?: $TSAny; // (undocumented) region?: string; } // @public (undocumented) export type IAuthResource = IAmplifyResource; // @public (undocumented) export type IContextFilesystem = { remove: (targetPath: string) => void; read: (targetPath: string, encoding?: BufferEncoding) => $TSAny; write: (targetPath: string, data: string | NodeJS.ArrayBufferView) => void; exists: (targetPath: string) => boolean; isFile: (targetPath: string) => boolean; path: (...pathParts: string[]) => string; }; // @public (undocumented) export type IContextPrint = { info: (message: string) => void; fancy: (message?: string) => void; warning: (message: string) => void; error: (message: string) => void; success: (message: string) => void; table: (data: string[][], options?: { format?: 'markdown' | 'lean'; }) => void; debug: (message: string) => void; green: (message: string) => void; yellow: (message: string) => void; red: (message: string) => void; blue: (message: string) => void; }; // @public (undocumented) export type IContextTemplate = { generate: (opts: { template: string; target: string; props: $TSObject; directory: string; }) => Promise<string>; }; // @public (undocumented) export interface IDeploymentStateManager { // (undocumented) advanceStep: () => Promise<void>; // (undocumented) deleteDeploymentStateFile: () => Promise<void>; // (undocumented) failDeployment: () => Promise<void>; // (undocumented) getStatus: () => DeploymentState | undefined; // (undocumented) isDeploymentFinished: () => boolean; // (undocumented) isDeploymentInProgress: () => boolean; // (undocumented) startCurrentStep: (parameters?: StepStatusParameters) => Promise<void>; // (undocumented) startDeployment: (steps: DeploymentStepState[]) => Promise<boolean>; // (undocumented) startRollback: () => Promise<void>; // (undocumented) updateCurrentStepStatus: (status: DeploymentStepStatus) => Promise<void>; // (undocumented) updateStatus: (status: DeploymentStatus) => Promise<void>; } // @public (undocumented) export interface IFlowReport { // (undocumented) category: string; // (undocumented) cmd: string; // (undocumented) executable: string; // (undocumented) input: CommandLineInput; // (undocumented) isHeadless: boolean; // (undocumented) optionFlowData: Array<TypeOptionFlowData>; // (undocumented) projectEnvIdentifier?: string; // (undocumented) projectIdentifier?: string; // (undocumented) runtime: string; // (undocumented) subCmd: string | undefined; // (undocumented) timestamp: string; // (undocumented) version: string; } // @public (undocumented) export function info(message: string): void; // @public (undocumented) export type INotificationsResource = IAnalyticsResource; // @public (undocumented) export interface INotificationsResourceMeta { // (undocumented) Id: string; // (undocumented) lastPushDirHash?: string; // (undocumented) lastPushTimeStamp?: string; // (undocumented) mobileHubMigrated?: boolean; // (undocumented) Name: string; // (undocumented) output: Record<string, $TSAny>; // (undocumented) Region: string; // (undocumented) ResourceName: string; // (undocumented) service: string; } // @public (undocumented) export type InputOptions = Record<string, string | boolean>; // @public (undocumented) type InputParameters = { forcePush?: boolean; iterativeRollback?: boolean; restoreBackend?: boolean; }; // @public (undocumented) export class InvalidSubCommandError extends AmplifyError { constructor(errMessage?: string); } // @public (undocumented) export interface IOptionFlowCLIData { // (undocumented) input: unknown; // (undocumented) prompt: string; // (undocumented) timestamp: number; } // @public (undocumented) export interface IOptionFlowHeadlessData { // (undocumented) input: string; // (undocumented) timestamp: number; } // @public (undocumented) export interface IPluginAPIResponse { // (undocumented) errorCode?: PluginAPIError; // (undocumented) pluginName: string; // (undocumented) reasonMsg?: string; // (undocumented) resourceProviderServiceName: string; // (undocumented) status: boolean; } // @public (undocumented) export interface IPluginCapabilityAPIResponse extends IPluginAPIResponse { // (undocumented) capability: string; // (undocumented) subCapability?: string; } // @public (undocumented) export type IPluginCollection = { [pluginType: string]: IPluginInfo[]; }; // @public (undocumented) export type IPluginInfo = { packageName: string; packageVersion: string; packageLocation: string; manifest: IPluginManifest; }; // @public (undocumented) export type IPluginManifest = { name: string; type: string; commands?: string[]; services?: string[]; functionRuntime?: FunctionBreadcrumb; }; // @public (undocumented) export type IPluginPlatform = { pluginDirectories: string[]; pluginPrefixes: string[]; userAddedLocations: string[]; lastScanTime: Date; maxScanIntervalInSeconds: number; plugins: IPluginCollection; excluded: IPluginCollection; }; // @public (undocumented) export const isCI: () => boolean; // @public (undocumented) export const isPackaged: boolean; // @public (undocumented) export const isResourceNameUnique: (category: string, resourceName: string, throwOnMatch?: boolean) => boolean; // @public (undocumented) export const isWindowsPlatform: () => boolean; // @public (undocumented) export interface IUsageData extends IUsageMetricsData, FlowRecorder { } // @public (undocumented) export interface IUsageDataPayload { // (undocumented) accountId: string; // (undocumented) amplifyCliVersion: string; // (undocumented) codePathDurations: Partial<Record<TimedCodePath, number>>; // (undocumented) downstreamException: SerializableError; // (undocumented) error: SerializableError; // (undocumented) flowReport: IFlowReport; // (undocumented) input: CommandLineInput | null; // (undocumented) inputOptions: CommandLineInput['options']; // (undocumented) installationUuid: string; // (undocumented) isCi: boolean; // (undocumented) nodeVersion: string; // (undocumented) osPlatform: string; // (undocumented) osRelease: string; // (undocumented) payloadVersion: string; // (undocumented) projectSetting: ProjectSettings; // (undocumented) pushNormalizationFactor: number; // (undocumented) sessionUuid: string; // (undocumented) state: string; // (undocumented) timestamp: string; } // @public (undocumented) export interface IUsageMetricsData { // (undocumented) calculatePushNormalizationFactor: (events: { StackId: string; PhysicalResourceId: string; }[], StackId: string) => void; // (undocumented) emitAbort: () => Promise<void>; // (undocumented) emitError: (error: Error | null) => Promise<void>; // (undocumented) emitSuccess: () => Promise<void>; // (undocumented) getSessionUuid: () => string; // (undocumented) getUsageDataPayload: (error: Error | null, state: string) => IUsageDataPayload; // (undocumented) init: (installationUuid: string, version: string, input: CommandLineInput, accountId: string, projectSettings: ProjectSettings, processStartTimeStamp: number) => void; // (undocumented) startCodePathTimer: (codePath: StartableTimedCodePath) => void; // (undocumented) stopCodePathTimer: (codePath: StoppableTimedCodePath) => void; } // @public (undocumented) export class JSONUtilities { // (undocumented) static parse: <T>(jsonString: string, options?: { preserveComments?: boolean; }) => T; // (undocumented) static readJson: <T>(fileName: string, options?: { throwIfNotExist?: boolean; preserveComments?: boolean; }) => T | undefined; // (undocumented) static stringify: (data: unknown, options?: { minify?: boolean; orderedKeys?: boolean; }) => string; // (undocumented) static writeJson: (fileName: string, data: unknown, options?: { mode?: number; minify?: boolean; secureFile?: boolean; orderedKeys?: boolean; }) => void; } // @public (undocumented) export type LocalAwsInfo = { NONE: Record<string, unknown>; }; // @public (undocumented) export type LocalEnvInfo = Required<Pick<ProjectSettings, 'projectPath' | 'defaultEditor' | 'envName' | 'noUpdateBackend'>>; // @public (undocumented) export function lookUpCommand(commandsInfo: Array<CommandInfo>, commandName: string): CommandInfo | undefined; // @public (undocumented) export function lookUpSubcommand(commandsInfo: Array<CommandInfo>, commandName: string, subcommandName: string): SubCommandInfo | undefined; // @public (undocumented) export enum ManuallyTimedCodePath { // (undocumented) INIT_ENV_CATEGORIES = "initEnvCategories", // (undocumented) INIT_ENV_PLATFORM = "initEnvPlatform", // (undocumented) PLUGIN_TIME = "pluginTime", // (undocumented) PROMPT_TIME = "promptTime", // (undocumented) PUSH_DEPLOYMENT = "pushDeployment", // (undocumented) PUSH_TRANSFORM = "pushTransform" } // Warning: (ae-forgotten-export) The symbol "deploymentSecretMerge" needs to be exported by the entry point index.d.ts // // @public (undocumented) export const mergeDeploymentSecrets: (deploymentSecretsModifier: deploymentSecretMerge) => DeploymentSecrets; // @public (undocumented) export type Message = { message: string; id: string; conditions?: { enabled: boolean; cliVersions?: string; startTime?: string; endTime?: string; }; }; // @public (undocumented) export interface MigrationInfo { // (undocumented) amplifyMeta: $TSMeta; // (undocumented) backendConfig: Record<string, unknown>; // (undocumented) currentAmplifyMeta: $TSMeta; // (undocumented) initVersion: string; // (undocumented) localAwsInfo: LocalAwsInfo; // (undocumented) localEnvInfo: LocalEnvInfo; // (undocumented) newVersion: string; // (undocumented) projectConfig: ProjectConfig; // (undocumented) projectPath: string; // (undocumented) teamProviderInfo: TeamProviderInfo; } // @public (undocumented) export class MissingParametersError extends AmplifyError { constructor(errMessage?: string); } // @public (undocumented) export type NoArgsAmplifyEventData = Record<string, never>; // @public (undocumented) export enum NotificationChannels { // (undocumented) APNS = "APNS", // (undocumented) EMAIL = "Email", // (undocumented) FCM = "FCM", // (undocumented) IN_APP_MSG = "InAppMessaging", // (undocumented) PUSH_NOTIFICATION = "PushNotification", // (undocumented) SMS = "SMS" } // @public (undocumented) export class NotImplementedError extends AmplifyError { constructor(errMessage?: string); } // @public (undocumented) export type NumberFeatureFlag = { type: 'number'; name: string; defaultValueForExistingProjects: number; defaultValueForNewProjects: number; }; // @public (undocumented) const open_2: (target: string, options: opn.Options) => Promise<ChildProcess | void>; export { open_2 as open } // @public (undocumented) export const overriddenCategories: string[]; // @public (undocumented) export type PackageManager = { packageManager: PackageManagerType; lockFile: string; executable: string; yarnrcPath?: string; }; // @public (undocumented) export type PackageManagerType = 'yarn' | 'npm' | 'yarn2'; // @public (undocumented) export function parseHelpCommands(input: $TSAny, commandsInfo: Array<CommandInfo>): { command: string; subCommand: string; }; // @public (undocumented) export type PartialAmplifyExceptionOptions = Partial<AmplifyExceptionOptions> & { message: string; }; // @public (undocumented) export const PathConstants: { DotAWSDirName: string; AWSCredentials: string; AWSConfig: string; DeploymentSecretsFileName: string; AmplifyAdminDirName: string; AmplifyDirName: string; DotAmplifyDirName: string; DotConfigDirName: string; BackendDirName: string; CurrentCloudBackendDirName: string; HooksDirName: string; BuildDirName: string; OverrideDirName: string; ProviderName: string; CfnStacksBuildDirName: string; AmplifyAdminConfigFileName: string; AmplifyRcFileName: string; GitIgnoreFileName: string; ProjectConfigFileName: string; AmplifyMetaFileName: string; TagsFileName: string; ParametersJsonFileName: string; ReadMeFileName: string; HooksConfigFileName: string; HooksShellSampleFileName: string; HooksJsSampleFileName: string; HooksReadmeFileName: string; LocalEnvFileName: string; LocalAWSInfoFileName: string; TeamProviderInfoFileName: string; BackendConfigFileName: string; CLIJSONFileName: string; CLIJSONFileNameGlob: string; CLIJsonWithEnvironmentFileName: (env: string) => string; CLIInputsJsonFileName: string; CfnFileName: (resourceName: string) => string; CustomPoliciesFilename: string; DefaultFrontEndExportFolder: string; DefaultExportFolder: string; ExportManifestJsonFilename: string; ExportTagsJsonFileName: string; ExportCategoryStackMappingJsonFilename: string; OverrideFileName: string; }; // @public (undocumented) export class PathManager { constructor(); // (undocumented) findProjectRoot: () => string | undefined; // (undocumented) getAmplifyAdminConfigFilePath: () => string; // (undocumented) getAmplifyAdminDirPath: () => string; // (undocumented) getAmplifyDirPath: (projectPath?: string) => string; // (undocumented) getAmplifyLibRoot: () => string; // (undocumented) getAmplifyMetaFilePath: (projectPath?: string) => string; // (undocumented) getAmplifyPackageLibDirPath: (packageName: string) => string; // (undocumented) getAmplifyRcFilePath: (projectPath?: string) => string; // (undocumented) getAWSConfigFilePath: () => string; // (undocumented) getAWSCredentialsFilePath: () => string; // (undocumented) getBackendConfigFilePath: (projectPath?: string) => string; // (undocumented) getBackendDirPath: (projectPath?: string) => string; // (undocumented) getCLIJSONFilePath: (projectPath: string, env?: string) => string; // (undocumented) getCurrentAmplifyMetaFilePath: (projectPath?: string) => string; // (undocumented) getCurrentBackendConfigFilePath: (projectPath?: string) => string; // (undocumented) getCurrentCfnTemplatePath: (projectPath: string | undefined, categoryName: string, resourceName: string) => string; // (undocumented) getCurrentCloudBackendDirPath: (projectPath?: string) => string; // (undocumented) getCurrentCloudRootStackDirPath: (projectPath: string) => string; // (undocumented) getCurrentResourceParametersJsonPath: (projectPath: string | undefined, categoryName: string, resourceName: string) => string; // (undocumented) getCurrentTagFilePath: (projectPath?: string) => string; // (undocumented) getCustomPoliciesPath: (category: string, resourceName: string) => string; // (undocumented) getDeploymentSecrets: () => string; // (undocumented) getDotAWSAmplifyDirPath: () => string; // (undocumented) getDotAWSDirPath: () => string; // (undocumented) getDotConfigDirPath: (projectPath?: string) => string; // (undocumented) getGitIgnoreFilePath: (projectPath?: string) => string; // (undocumented) getHomeDotAmplifyDirPath: () => string; // (undocumented) getHooksConfigFilePath: (projectPath?: string) => string; // (undocumented) getHooksDirPath: (projectPath?: string) => string; // (undocumented) getLocalAWSInfoFilePath: (projectPath?: string) => string; // (undocumented) getLocalEnvFilePath: (projectPath?: string) => string; // (undocumented) getOverrideDirPath: (projectPath: string, category: string, resourceName: string) => string; // (undocumented) getProjectConfigFilePath: (projectPath?: string) => string; // (undocumented) getReadMeFilePath: (projectPath?: string) => string; // (undocumented) getResourceCfnTemplatePath: (projectPath: string | undefined, category: string, resourceName: string, buildDirectory?: boolean) => string; // (undocumented) getResourceDirectoryPath: (projectPath: string | undefined, category: string, resourceName: string) => string; // (undocumented) getResourceInputsJsonFilePath: (projectPath: string | undefined, category: string, resourceName: string) => string; // (undocumented) getResourceOverrideFilePath: (projectPath: string | undefined, category: string, resourceName: string) => string; // (undocumented) getResourceParametersFilePath: (projectPath: string | undefined, category: string, resourceName: string) => string; // (undocumented) getRootOverrideDirPath: (projectPath: string) => string; // (undocumented) getRootStackBuildDirPath: (projectPath: string) => string; // (undocumented) getTagFilePath: (projectPath?: string) => string; // (undocumented) getTeamProviderInfoFilePath: (projectPath?: string) => string; } // @public (undocumented) export const pathManager: PathManager; // @public (undocumente