Skip to content

Commit

Permalink
chore: updated API
Browse files Browse the repository at this point in the history
  • Loading branch information
@vigy02
vigy02 committed Oct 29, 2024
1 parent 4f21f21 commit c7e53cc
Show file tree
Hide file tree
Showing 8 changed files with 30 additions and 768 deletions.
2 changes: 0 additions & 2 deletions packages/ai-constructs/API.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@
```ts

/// <reference types="node" />

import { AIConversationOutput } from '@aws-amplify/backend-output-schemas';
import { BackendOutputStorageStrategy } from '@aws-amplify/plugin-types';
import * as bedrock from '@aws-sdk/client-bedrock-runtime';
Expand Down
722 changes: 10 additions & 712 deletions packages/backend-output-schemas/API.md
View file

Large diffs are not rendered by default.

5 changes: 1 addition & 4 deletions packages/backend-output-storage/API.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,10 @@
```ts

/// <reference types="node" />

import { BackendOutputEntry } from '@aws-amplify/plugin-types';
import { BackendOutputStorageStrategy } from '@aws-amplify/plugin-types';
import { DeepPartial } from '@aws-amplify/plugin-types';
import * as _os from 'os';
import { PackageJsonReader } from '@aws-amplify/platform-core';
import { Stack } from 'aws-cdk-lib';

// @public (undocumented)
Expand All @@ -24,7 +21,7 @@ export type AttributionMetadata = {

// @public
export class AttributionMetadataStorage {
constructor(os?: typeof _os, packageJsonReader?: PackageJsonReader);
constructor(os?: typeof _os, packageJsonReader?: any);
storeAttributionMetadata: (stack: Stack, stackType: string, libraryPackageJsonAbsolutePath: string, additionalMetadata?: Record<string, string>) => void;
}

Expand Down
24 changes: 11 additions & 13 deletions packages/cli-core/API.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@
```ts

/// <reference types="node" />

import { PackageManagerController } from '@aws-amplify/plugin-types';
import { WriteStream } from 'node:tty';

Expand All @@ -32,33 +30,33 @@ export const colorNames: readonly ["Green", "Yellow", "Blue", "Magenta", "Cyan"]
export class Format {
constructor(packageManagerRunnerName?: string);
// (undocumented)
bold: (message: string) => string;
bold: (message: string) => any;
// (undocumented)
color: (message: string, colorName: ColorName) => string;
color: (message: string, colorName: ColorName) => any;
// (undocumented)
command: (command: string) => string;
command: (command: string) => any;
// (undocumented)
dim: (message: string) => string;
dim: (message: string) => any;
// (undocumented)
error: (error: string | Error | unknown) => string;
// (undocumented)
highlight: (command: string) => string;
highlight: (command: string) => any;
// (undocumented)
indent: (message: string) => string;
// (undocumented)
link: (link: string) => string;
link: (link: string) => any;
// (undocumented)
list: (lines: string[]) => string;
// (undocumented)
normalizeAmpxCommand: (command: string) => string;
normalizeAmpxCommand: (command: string) => any;
// (undocumented)
note: (message: string) => string;
note: (message: string) => any;
// (undocumented)
record: (record: Record<string, string | number | Date>) => string;
// (undocumented)
sectionHeader: (header: string) => string;
sectionHeader: (header: string) => any;
// (undocumented)
success: (message: string) => string;
success: (message: string) => any;
}

// @public (undocumented)
Expand All @@ -76,7 +74,7 @@ export enum LogLevel {

// @public
export class PackageManagerControllerFactory {
constructor(cwd?: string, printer?: Printer, platform?: NodeJS.Platform);
constructor(cwd?: any, printer?: Printer, platform?: any);
getPackageManagerController(): PackageManagerController;
}

Expand Down
20 changes: 4 additions & 16 deletions packages/client-config/API.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,7 @@
```ts

import { AmplifyClient } from '@aws-sdk/client-amplify';
import { AWSClientProvider } from '@aws-amplify/plugin-types';
import { CloudFormationClient } from '@aws-sdk/client-cloudformation';
import { DeployedBackendIdentifier } from '@aws-amplify/deployed-backend-client';
import { S3Client } from '@aws-sdk/client-s3';

// @public
type AmazonCognitoStandardAttributes = 'address' | 'birthdate' | 'email' | 'family_name' | 'gender' | 'given_name' | 'locale' | 'middle_name' | 'name' | 'nickname' | 'phone_number' | 'picture' | 'preferred_username' | 'profile' | 'sub' | 'updated_at' | 'website' | 'zoneinfo';
Expand Down Expand Up @@ -604,7 +600,7 @@ export type ClientConfigVersion = `${ClientConfigVersionOption}`;
// @public (undocumented)
export enum ClientConfigVersionOption {
// (undocumented)
V0 = "0",
V0 = "0",// Legacy client config
// (undocumented)
V1 = "1",
// (undocumented)
Expand All @@ -627,18 +623,10 @@ export type CustomClientConfig = {
export const DEFAULT_CLIENT_CONFIG_VERSION: ClientConfigVersion;

// @public
export const generateClientConfig: <T extends "1" | "1.1" | "1.2" | "1.3" | "0">(backendIdentifier: DeployedBackendIdentifier, version: T, awsClientProvider?: AWSClientProvider<{
getS3Client: S3Client;
getAmplifyClient: AmplifyClient;
getCloudFormationClient: CloudFormationClient;
}>) => Promise<ClientConfigVersionTemplateType<T>>;
export const generateClientConfig: <T extends ClientConfigVersion>(backendIdentifier: DeployedBackendIdentifier, version: T, awsClientProvider?: any) => Promise<ClientConfigVersionTemplateType<T>>;

// @public
export const generateClientConfigToFile: (backendIdentifier: DeployedBackendIdentifier, version: ClientConfigVersion, outDir?: string, format?: ClientConfigFormat, awsClientProvider?: AWSClientProvider<{
getS3Client: S3Client;
getAmplifyClient: AmplifyClient;
getCloudFormationClient: CloudFormationClient;
}>) => Promise<GenerateClientConfigToFileResult>;
export const generateClientConfigToFile: (backendIdentifier: DeployedBackendIdentifier, version: ClientConfigVersion, outDir?: string, format?: ClientConfigFormat, awsClientProvider?: any) => Promise<GenerateClientConfigToFileResult>;

// @public (undocumented)
export type GenerateClientConfigToFileResult = {
Expand Down Expand Up @@ -675,7 +663,7 @@ export type GeoClientConfig = {
export const getClientConfigFileName: (version: ClientConfigVersion) => ClientConfigFileBaseName;

// @public
export const getClientConfigPath: (fileName: ClientConfigFileBaseName, outDir?: string, format?: ClientConfigFormat) => Promise<string>;
export const getClientConfigPath: (fileName: ClientConfigFileBaseName, outDir?: string, format?: ClientConfigFormat) => Promise<any>;

// @public
export type GraphqlClientConfig = {
Expand Down
5 changes: 1 addition & 4 deletions packages/deployed-backend-client/API.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -109,10 +109,7 @@ export enum BackendOutputClientErrorType {

// @public
export class BackendOutputClientFactory {
static getInstance: (awsClientProvider?: AWSClientProvider<{
getAmplifyClient: AmplifyClient;
getCloudFormationClient: CloudFormationClient;
}>) => BackendOutputClient;
static getInstance: (awsClientProvider?: any) => BackendOutputClient;
}

// @public (undocumented)
Expand Down
18 changes: 3 additions & 15 deletions packages/platform-core/API.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ export abstract class AmplifyError<T extends string = string> extends Error {
// (undocumented)
readonly details?: string;
// (undocumented)
static fromError: (error: unknown) => AmplifyError<'UnknownFault' | 'CredentialsError' | 'InvalidCommandInputError' | 'DomainNotFoundError' | 'SyntaxError'>;
static fromError: (error: unknown) => AmplifyError<"UnknownFault" | "CredentialsError" | "InvalidCommandInputError" | "DomainNotFoundError" | "SyntaxError">;
// (undocumented)
static fromStderr: (_stderr: string) => AmplifyError | undefined;
// (undocumented)
Expand Down Expand Up @@ -80,7 +80,7 @@ export class BackendLocator {
export class CallerDirectoryExtractor {
constructor(stackTrace: string | undefined);
// (undocumented)
extract: () => string;
extract: () => any;
}

// @public
Expand Down Expand Up @@ -159,19 +159,7 @@ export class PackageJsonReader {
}

// @public
export const packageJsonSchema: z.ZodObject<{
name: z.ZodOptional<z.ZodString>;
version: z.ZodOptional<z.ZodString>;
type: z.ZodOptional<z.ZodUnion<[z.ZodLiteral<"module">, z.ZodLiteral<"commonjs">]>>;
}, "strip", z.ZodTypeAny, {
name?: string | undefined;
type?: "module" | "commonjs" | undefined;
version?: string | undefined;
}, {
name?: string | undefined;
type?: "module" | "commonjs" | undefined;
version?: string | undefined;
}>;
export const packageJsonSchema: any;

// @public
export class ParameterPathConversions {
Expand Down
2 changes: 0 additions & 2 deletions packages/sandbox/API.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@
```ts

/// <reference types="node" />

import { BackendIdentifier } from '@aws-amplify/plugin-types';
import { ClientConfigFormat } from '@aws-amplify/client-config';
import EventEmitter from 'events';
Expand Down

0 comments on commit c7e53cc

Please sign in to comment.