@aws-amplify/api-graphql 4.0.1-api-v6-models.bc74e14.0 → 4.0.1-api-v6-models.13c9b49.0

package/lib/types/index.d.ts

@@ -1,329 +0,0 @@
-import { AmplifyClassV6, ResourcesConfig } from '@aws-amplify/core';
-import { ModelTypes } from '@aws-amplify/amplify-api-next-types-alpha';
-import { Source, DocumentNode, GraphQLError } from 'graphql';
-export { OperationTypeNode } from 'graphql';
-import { Observable } from 'rxjs';
-import { GraphQLAuthMode, DocumentType } from '@aws-amplify/core/internals/utils';
-import { AmplifyServer } from '@aws-amplify/core/internals/adapter-core';
-export { CONTROL_MSG, ConnectionState } from './PubSub';
-export { SelectionSet } from '@aws-amplify/amplify-api-next-types-alpha';
-export { CommonPublicClientOptions } from '../internals/types';
-/**
- * Loose/Unknown options for raw GraphQLAPICategory `graphql()`.
- */
-export interface GraphQLOptions {
-    query: string | DocumentNode;
-    variables?: Record<string, DocumentType>;
-    authMode?: GraphQLAuthMode;
-    authToken?: string;
-    /**
-     * @deprecated This property should not be used
-     */
-    userAgentSuffix?: string;
-}
-export interface GraphQLResult<T = object> {
-    data: T;
-    errors?: GraphQLError[];
-    extensions?: {
-        [key: string]: any;
-    };
-}
-declare const queryType: unique symbol;
-export type GraphQLQuery<T> = T & {
-    readonly [queryType]: 'query';
-};
-export type GraphQLSubscription<T> = T & {
-    readonly [queryType]: 'subscription';
-};
-/**
- * Accepts a code generated model type and returns a supertype that
- * can accept return values from the relevant graphql operations.
- *
- * For example:
- *
- * ```typescript
- * import { GraphQLReturnType } from 'aws-amplify/api';
- * import { MyModel } from './API';
- * import { getMyModel } from './graphql/queries';
- *
- * const [item, setItem] = useState<GraphQLReturnType<MyModel>>();
- * setItem(await client.graphql({ query: getMyModel }).data.getMyModel!)
- * ```
- *
- * Trying to assign the result of a `getMyModel` operation directly to a
- * `MyModel` variables won't necessarily work, because normally-required related
- * models might not be part of the selection set.
- *
- * This util simply makes related model properties optional recursively.
- */
-export type GraphQLReturnType<T> = T extends {} ? {
-    [K in keyof T]?: GraphQLReturnType<T[K]>;
-} : T;
-/**
- * Describes a paged list result from AppSync, which can either
- * live at the top query or property (e.g., related model) level.
- */
-type PagedList<T, TYPENAME> = {
-    __typename: TYPENAME;
-    nextToken?: string | null | undefined;
-    items: Array<T>;
-};
-/**
- * Recursively looks through a result type and removes nulls and
- * and undefined from `PagedList` types.
- *
- * Although a graphql response might contain empty values in an
- * array, this will only be the case when we also have errors,
- * which will then be *thrown*.
- */
-type WithListsFixed<T> = T extends PagedList<infer IT, infer NAME> ? PagedList<Exclude<IT, null | undefined>, NAME> : T extends {} ? {
-    [K in keyof T]: WithListsFixed<T[K]>;
-} : T;
-/**
- * Returns an updated response type to always return a value.
- */
-type NeverEmpty<T> = {
-    [K in keyof T]-?: Exclude<WithListsFixed<T[K]>, undefined | null>;
-};
-/**
- * Replaces all list result types in a query result with types to exclude
- * nulls and undefined from list member unions.
- *
- * If empty members are present, there will also be errors present,
- * and the response will instead be *thrown*.
- */
-type FixedQueryResult<T> = Exclude<T[keyof T], null | undefined> extends PagedList<any, any> ? {
-    [K in keyof T]-?: WithListsFixed<Exclude<T[K], null | undefined>>;
-} : T;
-/**
- * The return value from a `graphql({query})` call when `query` is a subscription.
- *
- * ```ts
- * //               |-- You are here
- * //               v
- * const subResult: GraphqlSubscriptionResult<T> = client.graphql({
- * 	query: onCreateWidget
- * });
- *
- * const sub = subResult.subscribe({
- * 	//
- * 	//            |-- You are here
- * 	//            v
- * 	next(message: GraphqlSubscriptionMessage<OnCreateWidgetSubscription>) {
- * 		handle(message.value);  // <-- type OnCreateWidgetSubscription
- * 	}
- * })
- * ```
- */
-export type GraphqlSubscriptionResult<T> = Observable<GraphqlSubscriptionMessage<T>>;
-/**
- * The shape of messages passed to `next()` from a graphql subscription. E.g.,
- *
- * ```ts
- * const sub = client.graphql({
- * 	query: onCreateWidget,
- * }).subscribe({
- * 	//
- * 	//            |-- You are here
- * 	//            v
- * 	next(message: GraphqlSubscriptionMessage<OnCreateWidgetSubscription>) {
- * 		handle(message.value);  // <-- type OnCreateWidgetSubscription
- * 	}
- * })
- * ```
- */
-export type GraphqlSubscriptionMessage<T> = {
-    data: T;
-};
-export interface AWSAppSyncRealTimeProviderOptions {
-    appSyncGraphqlEndpoint?: string;
-    authenticationType?: GraphQLAuthMode;
-    query?: string;
-    variables?: Record<string, unknown>;
-    apiKey?: string;
-    region?: string;
-    graphql_headers?: () => {} | (() => Promise<{}>);
-    additionalHeaders?: {
-        [key: string]: string;
-    };
-}
-export type AWSAppSyncRealTimeProvider = {
-    subscribe(options?: AWSAppSyncRealTimeProviderOptions): Observable<Record<string, unknown>>;
-};
-export declare enum GraphQLAuthError {
-    NO_API_KEY = "No api-key configured",
-    NO_CURRENT_USER = "No current user",
-    NO_CREDENTIALS = "No credentials",
-    NO_FEDERATED_JWT = "No federated jwt",
-    NO_AUTH_TOKEN = "No auth token specified"
-}
-/**
- * GraphQLSource or string, the type of the parameter for calling graphql.parse
- * @see: https://graphql.org/graphql-js/language/#parse
- */
-export type GraphQLOperation = Source | string;
-/**
- * API V6 `graphql({options})` type that can leverage branded graphql `query`
- * objects and fallback types.
- */
-export interface GraphQLOptionsV6<FALLBACK_TYPES = unknown, TYPED_GQL_STRING extends string = string> {
-    query: TYPED_GQL_STRING | DocumentNode;
-    variables?: GraphQLVariablesV6<FALLBACK_TYPES, TYPED_GQL_STRING>;
-    authMode?: GraphQLAuthMode;
-    authToken?: string;
-    /**
-     * @deprecated This property should not be used
-     */
-    userAgentSuffix?: string;
-}
-/**
- * Result type for `graphql()` operations that don't include any specific
- * type information. The result could be either a `Promise` or `Subscription`.
- *
- * Invoking code should either cast the result or use `?` and `!` operators to
- * navigate the result objects.
- */
-export type UnknownGraphQLResponse = Promise<GraphQLResult<any>> | GraphqlSubscriptionResult<any>;
-/**
- * The expected type for `variables` in a V6 `graphql()` operation with
- * respect to the given `FALLBACK_TYPES` and `TYPED_GQL_STRING`.
- */
-export type GraphQLVariablesV6<FALLBACK_TYPES = unknown, TYPED_GQL_STRING extends string = string> = TYPED_GQL_STRING extends GeneratedQuery<infer IN, any> ? IN : TYPED_GQL_STRING extends GeneratedMutation<infer IN, any> ? IN : TYPED_GQL_STRING extends GeneratedSubscription<infer IN, any> ? IN : FALLBACK_TYPES extends GraphQLOperationType<infer IN, any> ? IN : any;
-/**
- * The expected return type with respect to the given `FALLBACK_TYPE`
- * and `TYPED_GQL_STRING`.
- */
-export type GraphQLResponseV6<FALLBACK_TYPE = unknown, TYPED_GQL_STRING extends string = string> = TYPED_GQL_STRING extends GeneratedQuery<infer IN, infer QUERY_OUT> ? Promise<GraphQLResult<FixedQueryResult<QUERY_OUT>>> : TYPED_GQL_STRING extends GeneratedMutation<infer IN, infer MUTATION_OUT> ? Promise<GraphQLResult<NeverEmpty<MUTATION_OUT>>> : TYPED_GQL_STRING extends GeneratedSubscription<infer IN, infer SUB_OUT> ? GraphqlSubscriptionResult<NeverEmpty<SUB_OUT>> : FALLBACK_TYPE extends GraphQLQuery<infer T> ? Promise<GraphQLResult<FALLBACK_TYPE>> : FALLBACK_TYPE extends GraphQLSubscription<infer T> ? GraphqlSubscriptionResult<FALLBACK_TYPE> : FALLBACK_TYPE extends GraphQLOperationType<infer IN, infer CUSTOM_OUT> ? CUSTOM_OUT : UnknownGraphQLResponse;
-/**
- * The shape customers can use to provide `T` to `graphql<T>()` to specify both
- * `IN` and `OUT` types (the type of `variables` and the return type, respectively).
- *
- * I.E.,
- *
- * ```ts
- * type MyVariablesType = { ... };
- * type MyResultType = { ... };
- * type MyOperationType = { variables: MyVariablesType, result: MyResultType };
- *
- * const result: MyResultType = graphql<MyOperationType>("graphql string", {
- * 	variables: {
- * 		// MyVariablesType
- * 	}
- * })
- * ```
- */
-export type GraphQLOperationType<IN extends {}, OUT extends {}> = {
-    variables: IN;
-    result: OUT;
-};
-/**
- * Nominal type for branding generated graphql query operation strings with
- * input and output types.
- *
- * E.g.,
- *
- * ```ts
- * export const getWidget = `...` as GeneratedQuery<
- * 	GetWidgetQueryVariables,
- * 	GetWidgetQuery
- * >;
- * ```
- *
- * This allows `graphql()` to extract `InputType` and `OutputType` to correctly
- * assign types to the `variables` and result objects.
- */
-export type GeneratedQuery<InputType, OutputType> = string & {
-    __generatedQueryInput: InputType;
-    __generatedQueryOutput: OutputType;
-};
-/**
- * Nominal type for branding generated graphql mutation operation strings with
- * input and output types.
- *
- * E.g.,
- *
- * ```ts
- * export const createWidget = `...` as GeneratedQuery<
- * 	CreateWidgetMutationVariables,
- * 	CreateWidgetMutation
- * >;
- * ```
- *
- * This allows `graphql()` to extract `InputType` and `OutputType` to correctly
- * assign types to the `variables` and result objects.
- */
-export type GeneratedMutation<InputType, OutputType> = string & {
-    __generatedMutationInput: InputType;
-    __generatedMutationOutput: OutputType;
-};
-/**
- * Nominal type for branding generated graphql mutation operation strings with
- * input and output types.
- *
- * E.g.,
- *
- * ```ts
- * export const createWidget = `...` as GeneratedMutation<
- * 	CreateWidgetMutationVariables,
- * 	CreateWidgetMutation
- * >;
- * ```
- *
- * This allows `graphql()` to extract `InputType` and `OutputType` to correctly
- * assign types to the `variables` and result objects.
- */
-export type GeneratedSubscription<InputType, OutputType> = string & {
-    __generatedSubscriptionInput: InputType;
-    __generatedSubscriptionOutput: OutputType;
-};
-type FilteredKeys<T> = {
-    [P in keyof T]: T[P] extends never ? never : P;
-}[keyof T];
-type ExcludeNeverFields<O> = {
-    [K in FilteredKeys<O>]: O[K];
-};
-export declare const __amplify: unique symbol;
-export declare const __authMode: unique symbol;
-export declare const __authToken: unique symbol;
-export type V6Client<T extends Record<any, any> = never> = ExcludeNeverFields<{
-    [__amplify]: AmplifyClassV6;
-    [__authMode]?: GraphQLAuthMode;
-    [__authToken]?: string;
-    graphql: GraphQLMethod;
-    cancel: (promise: Promise<any>, message?: string) => boolean;
-    isCancelError: (error: any) => boolean;
-    models: ModelTypes<T>;
-}>;
-export type V6ClientSSRRequest<T extends Record<any, any> = never> = ExcludeNeverFields<{
-    [__amplify]: AmplifyClassV6;
-    [__authMode]?: GraphQLAuthMode;
-    [__authToken]?: string;
-    graphql: GraphQLMethodSSR;
-    cancel: (promise: Promise<any>, message?: string) => boolean;
-    isCancelError: (error: any) => boolean;
-    models: ModelTypes<T, 'REQUEST'>;
-}>;
-export type V6ClientSSRCookies<T extends Record<any, any> = never> = ExcludeNeverFields<{
-    [__amplify]: AmplifyClassV6;
-    [__authMode]?: GraphQLAuthMode;
-    [__authToken]?: string;
-    graphql: GraphQLMethod;
-    cancel: (promise: Promise<any>, message?: string) => boolean;
-    isCancelError: (error: any) => boolean;
-    models: ModelTypes<T, 'COOKIES'>;
-}>;
-export type GraphQLMethod = <FALLBACK_TYPES = unknown, TYPED_GQL_STRING extends string = string>(options: GraphQLOptionsV6<FALLBACK_TYPES, TYPED_GQL_STRING>, additionalHeaders?: {
-    [key: string]: string;
-} | undefined) => GraphQLResponseV6<FALLBACK_TYPES, TYPED_GQL_STRING>;
-export type GraphQLMethodSSR = <FALLBACK_TYPES = unknown, TYPED_GQL_STRING extends string = string>(contextSpec: AmplifyServer.ContextSpec, options: GraphQLOptionsV6<FALLBACK_TYPES, TYPED_GQL_STRING>, additionalHeaders?: {
-    [key: string]: string;
-} | undefined) => GraphQLResponseV6<FALLBACK_TYPES, TYPED_GQL_STRING>;
-/**
- * @private
- *
- * The knobs available for configuring `server/generateClient` internally.
- */
-export type ServerClientGenerationParams = {
-    amplify: null | ((fn: (amplify: AmplifyClassV6) => Promise<any>) => Promise<any>);
-    config: ResourcesConfig;
-};

package/lib/utils/ConnectionStateMonitor.d.ts

@@ -1,41 +0,0 @@
-import { Observable } from 'rxjs';
-import { ConnectionState } from '../types/PubSub';
-type LinkedConnectionState = 'connected' | 'disconnected';
-type LinkedHealthState = 'healthy' | 'unhealthy';
-type LinkedConnectionStates = {
-    networkState: LinkedConnectionState;
-    connectionState: LinkedConnectionState | 'connecting';
-    intendedConnectionState: LinkedConnectionState;
-    keepAliveState: LinkedHealthState;
-};
-export declare const CONNECTION_CHANGE: {
-    [key in 'KEEP_ALIVE_MISSED' | 'KEEP_ALIVE' | 'CONNECTION_ESTABLISHED' | 'CONNECTION_FAILED' | 'CLOSING_CONNECTION' | 'OPENING_CONNECTION' | 'CLOSED' | 'ONLINE' | 'OFFLINE']: Partial<LinkedConnectionStates>;
-};
-export declare class ConnectionStateMonitor {
-    /**
-     * @private
-     */
-    private _linkedConnectionState;
-    private _linkedConnectionStateObservable;
-    private _linkedConnectionStateObserver;
-    private _networkMonitoringSubscription?;
-    private _initialNetworkStateSubscription?;
-    constructor();
-    /**
-     * Turn network state monitoring on if it isn't on already
-     */
-    private enableNetworkMonitoring;
-    /**
-     * Turn network state monitoring off if it isn't off already
-     */
-    private disableNetworkMonitoring;
-    /**
-     * Get the observable that allows us to monitor the connection state
-     *
-     * @returns {Observable<ConnectionState>} - The observable that emits ConnectionState updates
-     */
-    get connectionStateObservable(): Observable<ConnectionState>;
-    record(statusUpdates: Partial<LinkedConnectionStates>): void;
-    private connectionStatesTranslator;
-}
-export {};

package/lib/utils/ReachabilityMonitor/index.d.ts

@@ -1 +0,0 @@
-export declare const ReachabilityMonitor: () => import("rxjs").Observable<import("@aws-amplify/core/lib-esm/Reachability/types").NetworkStatus>;

package/lib/utils/ReachabilityMonitor/index.native.d.ts

@@ -1 +0,0 @@
-export declare const ReachabilityMonitor: () => import("rxjs").Observable<import("@aws-amplify/core/lib-esm/Reachability/types").NetworkStatus>;

package/lib/utils/ReconnectionMonitor.d.ts

@@ -1,29 +0,0 @@
-import { Observer } from 'rxjs';
-export declare enum ReconnectEvent {
-    START_RECONNECT = "START_RECONNECT",
-    HALT_RECONNECT = "HALT_RECONNECT"
-}
-/**
- * Captures the reconnect event logic used to determine when to reconnect to PubSub providers.
- *   Reconnnect attempts are delayed by 5 seconds to let the interface settle.
- *   Attempting to reconnect only once creates unrecoverable states when the network state isn't
- *   supported by the browser, so this keeps retrying every minute until halted.
- */
-export declare class ReconnectionMonitor {
-    private reconnectObservers;
-    private reconnectIntervalId?;
-    private reconnectSetTimeoutId?;
-    /**
-     * Add reconnect observer to the list of observers to alert on reconnect
-     */
-    addObserver(reconnectObserver: Observer<void>): void;
-    /**
-     * Given a reconnect event, start the appropriate behavior
-     */
-    record(event: ReconnectEvent): void;
-    /**
-     * Complete all reconnect observers
-     */
-    close(): void;
-    private _triggerReconnect;
-}

package/lib/utils/errors/APIError.d.ts

@@ -1,7 +0,0 @@
-import { AmplifyError, AmplifyErrorParams } from '@aws-amplify/core/internals/utils';
-/**
- * @internal
- */
-export declare class APIError extends AmplifyError {
-    constructor(params: AmplifyErrorParams);
-}

package/lib/utils/errors/assertValidationError.d.ts

@@ -1,5 +0,0 @@
-import { APIValidationErrorCode } from './validation';
-/**
- * @internal
- */
-export declare function assertValidationError(assertion: boolean, name: APIValidationErrorCode): asserts assertion;

package/lib/utils/errors/index.d.ts

@@ -1,3 +0,0 @@
-export { APIError } from './APIError';
-export { assertValidationError } from './assertValidationError';
-export { APIValidationErrorCode, validationErrorMap } from './validation';

package/lib/utils/errors/validation.d.ts

@@ -1,7 +0,0 @@
-import { AmplifyErrorMap } from '@aws-amplify/core/internals/utils';
-export declare enum APIValidationErrorCode {
-    NoAuthSession = "NoAuthSession",
-    NoRegion = "NoRegion",
-    NoCustomEndpoint = "NoCustomEndpoint"
-}
-export declare const validationErrorMap: AmplifyErrorMap<APIValidationErrorCode>;

package/lib/utils/findIndexByFields.d.ts

@@ -1,9 +0,0 @@
-/**
- * Iterates through a collection to find a matching item and returns the index.
- *
- * @param needle The item to search for
- * @param haystack The collection to search
- * @param keyFields The fields used to indicate a match
- * @returns Index of `needle` in `haystack`, otherwise -1 if not found.
- */
-export declare function findIndexByFields<T>(needle: T, haystack: T[], keyFields: Array<keyof T>): number;

package/lib/utils/index.d.ts

@@ -1,4 +0,0 @@
-export { resolveConfig } from './resolveConfig';
-export { resolveLibraryOptions } from './resolveLibraryOptions';
-export { resolvePKFields } from './resolvePKFields';
-export { findIndexByFields } from './findIndexByFields';

package/lib/utils/resolveConfig.d.ts

@@ -1,12 +0,0 @@
-import { AmplifyClassV6 } from '@aws-amplify/core';
-/**
- * @internal
- */
-export declare const resolveConfig: (amplify: AmplifyClassV6) => {
-    apiKey: string | undefined;
-    customEndpoint: string | undefined;
-    customEndpointRegion: string | undefined;
-    defaultAuthMode: import("@aws-amplify/core/lib-esm/libraryUtils").GraphQLAuthMode | undefined;
-    endpoint: string | undefined;
-    region: string | undefined;
-};

package/lib/utils/resolveOwnerFields.d.ts

@@ -1,12 +0,0 @@
-import { ResourcesConfig } from '@aws-amplify/core';
-type GraphQLConfig = Exclude<ResourcesConfig['API'], undefined>['GraphQL'];
-type ModelIntrospectionSchema = Exclude<Exclude<GraphQLConfig, undefined>['modelIntrospection'], undefined>;
-type Model = ModelIntrospectionSchema['models'][string];
-/**
- * Given an introspection schema model, returns all owner fields.
- *
- * @param model Model from an introspection schema
- * @returns List of owner field names
- */
-export declare function resolveOwnerFields(model: Model): string[];
-export {};

package/lib/utils/resolvePKFields.d.ts

@@ -1,13 +0,0 @@
-import { ResourcesConfig } from '@aws-amplify/core';
-type GraphQLConfig = Exclude<ResourcesConfig['API'], undefined>['GraphQL'];
-type ModelIntrospectionSchema = Exclude<Exclude<GraphQLConfig, undefined>['modelIntrospection'], undefined>;
-type SchemaModel = ModelIntrospectionSchema['models'][string];
-/**
- * Given a SchemaModel from a ModelIntrospectionSchema, returns the primary key
- * as an array of field names.
- *
- * @param model The model object
- * @returns Array of field names
- */
-export declare function resolvePKFields(model: SchemaModel): string[];
-export {};

package/lib-esm/index.js

@@ -1,5 +0,0 @@
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
-export { GraphQLAPI, GraphQLAPIClass, graphqlOperation } from './GraphQLAPI';
-export * from './types';
-export { CONNECTION_STATE_CHANGE } from './Providers/constants';

package/lib-esm/internals/index.js

@@ -1,5 +0,0 @@
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
-export { InternalGraphQLAPI, InternalGraphQLAPIClass, } from './InternalGraphQLAPI';
-export { graphql, cancel, isCancelError } from './v6';
-export { generateClient } from './generateClient';

package/lib-esm/internals/server/index.js

@@ -1,3 +0,0 @@
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
-export { generateClient } from './generateClient';

package/lib-esm/internals/types.js

@@ -1 +0,0 @@
-export {};