**[@adobe/exc-app](../README.md)**

> [Globals](../README.md) / network

# Module: network

APIs that simplify code to make authenticated network requests for resources, execute GraphQL
queries, etc..

***Import:***

```typescript
import {fetch, query} from '@adobe/exc-app/network';
```

***Default export:***

[NetworkApi](../interfaces/network.networkapi.md)

***Usage:***

```typescript
import {fetch, query} from '@adobe/exc-app/network';

// Performs a window.fetch call with Authorization and x-api-key headers set
const fetchResponse = await fetch('https://localhost', {auth: 'Header', method: 'GET'});

// Executes a query for resources to the ExC GraphQL service
const queryResponse = await query({
  data: {
    query: `
      query PPSQuery($userId: String!, $apiKey: String!) {
        getPPSProfile(userId: $userId, apiKey: $apiKey) {
          images
        }
      }`,
    variables: {
      apiKey: 'test-app',
      userId: '123@AdobeID'
    }
  },
  operationName: 'PPSAvatar'
});

```

## Index

### Enumerations

* [FetchScope](../enums/network.fetchscope.md)
* [ROUTING](../enums/network.routing.md)
* [StandardVariables](../enums/network.standardvariables.md)

### Interfaces

* [ApolloClientOptions](../interfaces/network.apolloclientoptions.md)
* [DataDedupConfig](../interfaces/network.datadedupconfig.md)
* [DataPrefetchContract](../interfaces/network.dataprefetchcontract.md)
* [DefaultMetaData](../interfaces/network.defaultmetadata.md)
* [FetchCondition](../interfaces/network.fetchcondition.md)
* [FetchOptions](../interfaces/network.fetchoptions.md)
* [GraphQLQuery](../interfaces/network.graphqlquery.md)
* [NetworkApi](../interfaces/network.networkapi.md)
* [PrefetchOptions](../interfaces/network.prefetchoptions.md)
* [QueryDefinition](../interfaces/network.querydefinition.md)
* [QueryRequest](../interfaces/network.queryrequest.md)

### Type aliases

* [FetchInit](network.md#fetchinit)
* [GraphQLRegion](network.md#graphqlregion)
* [PrefetchResponse](network.md#prefetchresponse)

### Variables

* [DEFAULT\_STATUS\_CODES\_TO\_RETRY](network.md#default_status_codes_to_retry)
* [FRESH\_MS](network.md#fresh_ms)

### Functions

* [fetch](network.md#fetch)
* [getApolloClient](network.md#getapolloclient)
* [getPrefetched](network.md#getprefetched)
* [query](network.md#query)

## Type aliases

### FetchInit

Ƭ  **FetchInit**: RequestInit & [FetchOptions](../interfaces/network.fetchoptions.md)

Defines the object containing any custom settings that you want to apply to the request. You can
also additionally specify the 'auth' parameter to automatically set the Authentication, API key in Headers/Query params.

***Example:***

`{auth: 'Header', body: 'xyz', headers: {'Content-Type': 'text/plain'}, method: 'POST'}` or
`{auth: 'Header', method: 'GET'}` or
`{method: 'GET'}`

___

### GraphQLRegion

Ƭ  **GraphQLRegion**: \"va7\" \| \"aus5\" \| \"nld2\"| \"va6\"

___

### PrefetchResponse

Ƭ  **PrefetchResponse**<T\>: [CacheEntry](cache.md#cacheentry)<T\> & { getFresh?: undefined \| () => Promise<[PrefetchResponse](network.md#prefetchresponse)<T\>\>  }

#### Type parameters:

Name |
------ |
`T` |

## Variables

### DEFAULT\_STATUS\_CODES\_TO\_RETRY

• `Const` **DEFAULT\_STATUS\_CODES\_TO\_RETRY**: number[] = [429, 502, 503, 504]

Default status codes which imply a transient error and can be retried.

___

### FRESH\_MS

• `Const` **FRESH\_MS**: number = 60 * 1000

## Functions

### fetch

▸ **fetch**(`input`: RequestInfo, `init?`: [FetchInit](network.md#fetchinit)): Promise<Response\>

Provides an interface for fetching resources powered by the global 'fetch' API.

***Example:***

```typescript
// performs a window.fetch call
let response = await fetch('https://example.com/api/ping');

// performs a window.fetch call with Authorization and x-api-key headers set
response = await fetch('https://localhost', {auth: 'Header', method: 'GET'});

// performs a window.fetch call with user_token and client_id query parameters added to the URL
const request = new Request('https://localhost', {
  body: JSON.stringify({k: 'v'}),
  headers: new Headers(),
  method: 'POST'
});
response = await fetch(request, {auth: 'Header'});
```

#### Parameters:

Name | Type | Description |
------ | ------ | ------ |
`input` | RequestInfo | The resource that you wish to fetch. It can either be the URL of the resource you want to fetch or a Request object. |
`init?` | [FetchInit](network.md#fetchinit) | An object containing any custom settings that you want to apply to the request. |

**Returns:** Promise<Response\>

The promise for the response to the fetch operation.

___

### getApolloClient

▸ **getApolloClient**(`options?`: [ApolloClientOptions](../interfaces/network.apolloclientoptions.md)): Promise<{ apolloClient: ApolloClient<InMemoryCache\> ; gql: *typeof* gql  }\>

Provides an interface for querying resources via GraphqQL using ApolloClient
***Example***
```typescript
 const apolloClientModule = await getApolloClient();
 const apolloClient = apolloClientModule.apolloClient;
 const gql = apolloClientModule.gql;
 const result = await apolloClient.query({
   query: gql`query  user {
     id
     name
   }`,
   variables : {}
 });
 console.log(result.data);
```

#### Parameters:

Name | Type | Description |
------ | ------ | ------ |
`options?` | [ApolloClientOptions](../interfaces/network.apolloclientoptions.md) | Configuration to create ApolloClient instance |

**Returns:** Promise<{ apolloClient: ApolloClient<InMemoryCache\> ; gql: *typeof* gql  }\>

GraphQL query response

___

### getPrefetched

▸ **getPrefetched**<T\>(`key`: string, `options?`: [PrefetchOptions](../interfaces/network.prefetchoptions.md)): Promise<[PrefetchResponse](network.md#prefetchresponse)<T\>\>

Provides an interface for querying known data.
Data querying and caching are managed in Unified Shell in advance.

This is an experimental feature.

#### Type parameters:

Name |
------ |
`T` |

#### Parameters:

Name | Type | Description |
------ | ------ | ------ |
`key` | string | Data Contract key |
`options?` | [PrefetchOptions](../interfaces/network.prefetchoptions.md) | Prefetch options |

**Returns:** Promise<[PrefetchResponse](network.md#prefetchresponse)<T\>\>

Promise for the contract execution response

___

### query

▸ **query**(`input`: [QueryRequest](../interfaces/network.queryrequest.md)): Promise<Response\>

Provides an interface for querying resources via GraphqQL.
In order to consume query, please make sure the respective query resolver is
available in the GraphQL Service.
***Example:***

```typescript
const PPS_QUERY = `
  query PPSQuery($userId: String!, $apiKey: String!) {
    getPPSProfile(userId: $userId, apiKey: $apiKey) {
      images
    }
  }`;

// queries the respective resource via GraphQL and returns HTTP Response {ok: true, status: 200, ...}
query({data: {query: PPS_QUERY, variables: {
  userId: '123@AdobeID',
  apiKey: 'test-app',
}}, operationName: 'PPSAvatar'});

// queries the respective resource via GraphQL and returns HTTP Response {ok: true, status: 200, ...}
query({data: {query: `
  query PPSQuery {
    getPPSProfile(userId: "123@AdobeID", apiKey: "test-app") {
      images
    }
  }`
}});
```

#### Parameters:

Name | Type | Description |
------ | ------ | ------ |
`input` | [QueryRequest](../interfaces/network.queryrequest.md) | Query request containing desired GQL Query. |

**Returns:** Promise<Response\>

The promise for the response to the query operation.