@aws-amplify/core/dist/esm/singleton/API/types.d.ts

import { Headers } from '../../clients';
import { AtLeastOne } from '../types';
export interface LibraryAPIOptions {
    GraphQL?: {
        headers?(options?: {
            query?: string;
            variables?: Record<string, DocumentType>;
        }): Promise<Headers | Record<string, unknown>>;
        withCredentials?: boolean;
    };
    REST?: {
        headers?(options: {
            apiName: string;
        }): Promise<Headers>;
    };
}
export interface APIGraphQLConfig {
    /**
     * Required GraphQL endpoint, must be a valid URL string.
     */
    endpoint: string;
    /**
     * Optional region string used to sign the request. Required only if the auth mode is 'iam'.
     */
    region?: string;
    /**
     * Optional API key string. Required only if the auth mode is 'apiKey'.
     */
    apiKey?: string;
    /**
     * Custom domain endpoint for GraphQL API.
     */
    customEndpoint?: string;
    /**
     * Optional region string used to sign the request to `customEndpoint`. Effective only if `customEndpoint` is
     * specified, and the auth mode is 'iam'.
     */
    customEndpointRegion?: string;
    /**
     * Default auth mode for all the API calls to given service.
     */
    defaultAuthMode: GraphQLAuthMode;
    modelIntrospection?: ModelIntrospectionSchema;
}
/**
 * @experimental
 */
export interface APIEventsConfig {
    /**
     * Required GraphQL endpoint, must be a valid URL string.
     */
    endpoint: string;
    /**
     * Optional region string used to sign the request. Required only if the auth mode is 'iam'.
     */
    region?: string;
    /**
     * Optional API key string. Required only if the auth mode is 'apiKey'.
     */
    apiKey?: string;
    /**
     * Custom domain endpoint for GraphQL API.
     */
    customEndpoint?: string;
    /**
     * Optional region string used to sign the request to `customEndpoint`. Effective only if `customEndpoint` is
     * specified, and the auth mode is 'iam'.
     */
    customEndpointRegion?: string;
    /**
     * Default auth mode for all the API calls to given service.
     */
    defaultAuthMode: GraphQLAuthMode;
}
export interface APIRestConfig {
    /**
     * Required REST endpoint, must be a valid URL string.
     */
    endpoint: string;
    /**
     * Optional region string used to sign the request with IAM credentials. If Omitted, region will be extracted from
     * the endpoint.
     *
     * @default 'us-east-1'
     */
    region?: string;
    /**
     * Optional service name string to sign the request with IAM credentials.
     *
     * @default 'execute-api'
     */
    service?: string;
}
export interface RESTProviderConfig {
    REST: Record<string, APIRestConfig>;
}
export interface GraphQLProviderConfig {
    GraphQL: APIGraphQLConfig;
}
export interface EventsProviderConfig {
    Events: APIEventsConfig;
}
export type APIConfig = AtLeastOne<RESTProviderConfig & GraphQLProviderConfig & EventsProviderConfig>;
export type GraphQLAuthMode = 'apiKey' | 'oidc' | 'userPool' | 'iam' | 'identityPool' | 'lambda' | 'none';
/**
 * Type representing a plain JavaScript object that can be serialized to JSON.
 */
export type DocumentType = null | boolean | number | string | DocumentType[] | {
    [prop: string]: DocumentType;
};
/**
 * Root model instrospection schema shape.
 *
 * Borrowed from: https://github.com/aws-amplify/samsara-cli/pull/377/commits/c08ea2c1a43f36aafe63b6d14d03f884e9c0c671#diff-21ae6faa2f22c15bb25ff9b272eaab7846c0650e2d267ab720546c19559583d0R4-R108
 */
export interface ModelIntrospectionSchema {
    version: 1;
    models: SchemaModels;
    nonModels: SchemaNonModels;
    enums: SchemaEnums;
    queries?: CustomOperations;
    mutations?: CustomOperations;
    subscriptions?: CustomOperations;
    conversations?: SchemaConversationRoutes;
    generations?: SchemaGenerationRoutes;
}
/**
 * Top-level Entities on a Schema
 */
export type SchemaModels = Record<string, SchemaModel>;
export type SchemaNonModels = Record<string, SchemaNonModel>;
export type SchemaEnums = Record<string, SchemaEnum>;
export type CustomOperations = Record<string, CustomOperation>;
type SchemaConversationRoutes = Record<string, SchemaConversationRoute>;
type SchemaGenerationRoutes = Record<string, CustomOperation>;
interface SchemaConversationRoute {
    name: string;
    models: SchemaModels;
    nonModels: SchemaNonModels;
    enums: SchemaEnums;
    conversation: SchemaConversation;
    message: SchemaConversationMessage;
}
interface SchemaConversation {
    modelName: string;
}
interface SchemaConversationMessage {
    modelName: string;
    subscribe: CustomOperation;
    send: CustomOperation;
}
export interface SchemaModel {
    name: string;
    attributes?: ModelAttribute[];
    fields: Fields;
    pluralName: string;
    syncable?: boolean;
    primaryKeyInfo: PrimaryKeyInfo;
}
export interface SchemaNonModel {
    name: string;
    fields: Fields;
}
export interface SchemaEnum {
    name: string;
    values: string[];
}
export interface ModelAttribute {
    type: string;
    properties?: Record<string, any>;
}
export interface SecondaryIndexAttribute {
    type: 'key';
    properties: {
        name: string;
        queryField: string;
        fields: string[];
    };
}
export interface CustomOperation {
    name: string;
    type: FieldType;
    isArray: boolean;
    isRequired: boolean;
    arguments?: CustomOperationArguments;
}
export type CustomOperationArguments = Record<string, CustomOperationArgument>;
export interface CustomOperationArgument {
    name: string;
    type: InputFieldType;
    isArray: boolean;
    isRequired: boolean;
    isArrayNullable?: boolean;
}
/**
 * Field Definition
 */
export type Fields = Record<string, Field>;
export interface Field {
    name: string;
    type: FieldType;
    isArray: boolean;
    isRequired: boolean;
    isReadOnly?: boolean;
    isArrayNullable?: boolean;
    attributes?: FieldAttribute[];
    association?: AssociationType;
}
export interface ModelFieldType {
    model: string;
}
export interface NonModelFieldType {
    nonModel: string;
}
interface EnumType {
    enum: string;
}
interface InputType {
    input: string;
}
type ScalarType = 'ID' | 'String' | 'Int' | 'Float' | 'AWSDate' | 'AWSTime' | 'AWSDateTime' | 'AWSTimestamp' | 'AWSEmail' | 'AWSURL' | 'AWSIPAddress' | 'Boolean' | 'AWSJSON' | 'AWSPhone';
type FieldType = ScalarType | EnumType | ModelFieldType | NonModelFieldType;
type InputFieldType = ScalarType | EnumType | InputType;
export type FieldAttribute = ModelAttribute;
/**
 * Field-level Relationship Definitions
 */
export declare enum CodeGenConnectionType {
    HAS_ONE = "HAS_ONE",
    BELONGS_TO = "BELONGS_TO",
    HAS_MANY = "HAS_MANY"
}
export interface AssociationBaseType {
    connectionType: CodeGenConnectionType;
}
export type AssociationHasMany = AssociationBaseType & {
    connectionType: CodeGenConnectionType.HAS_MANY;
    associatedWith: string[];
};
export type AssociationHasOne = AssociationBaseType & {
    connectionType: CodeGenConnectionType.HAS_ONE;
    associatedWith: string[];
    targetNames: string[];
};
export type AssociationBelongsTo = AssociationBaseType & {
    connectionType: CodeGenConnectionType.BELONGS_TO;
    targetNames: string[];
};
export type AssociationType = AssociationHasMany | AssociationHasOne | AssociationBelongsTo;
export interface PrimaryKeyInfo {
    isCustomPrimaryKey: boolean;
    primaryKeyFieldName: string;
    sortKeyFieldNames: string[];
}
export {};