@shopify/admin-api-client - npm Package Compare versions

Comparing version 1.0.8 to 1.1.0

dist/admin-api-client.d.ts

 import { ApiClientConfig, CustomFetchApi, ApiClientLogger, ApiClientLogContentTypes, ApiClient } from '@shopify/graphql-client';
-export { AllOperations, ApiClientRequestOptions, ClientResponse, FetchResponseBody, HTTPResponseLog, HTTPRetryLog, LogContent, ResponseWithType, ReturnData } from '@shopify/graphql-client';
+export { AllOperations, ApiClientRequestOptions, ClientResponse, FetchResponseBody, HTTPResponseGraphQLDeprecationNotice, HTTPResponseLog, HTTPRetryLog, LogContent, ResponseWithType, ReturnData } from '@shopify/graphql-client';
 
@@ -4,0 +4,0 @@ type AdminApiClientLogContentTypes = ApiClientLogContentTypes;

dist/constants.js

@@ -5,3 +5,3 @@ 'use strict';
 // This is value is replaced with package.json version during rollup build process
-const DEFAULT_CLIENT_VERSION = '1.0.8';
+const DEFAULT_CLIENT_VERSION = '1.1.0';
 const ACCESS_TOKEN_HEADER = 'X-Shopify-Access-Token';
@@ -8,0 +8,0 @@ const CLIENT = 'Admin API Client';

dist/ts/index.d.ts

@@ -5,3 +5,3 @@ export { createAdminApiClient } from './graphql';
 export type { AdminRestApiClient, SearchParams } from './rest/types';
-export type { AllOperations, ApiClientRequestOptions, ClientResponse, FetchResponseBody, HTTPResponseLog, HTTPRetryLog, LogContent, ResponseWithType, ReturnData, } from '@shopify/graphql-client';
+export type { AllOperations, ApiClientRequestOptions, ClientResponse, FetchResponseBody, HTTPResponseLog, HTTPRetryLog, HTTPResponseGraphQLDeprecationNotice, LogContent, ResponseWithType, ReturnData, } from '@shopify/graphql-client';
 //# sourceMappingURL=index.d.ts.map

package.json

 {
   "name": "@shopify/admin-api-client",
-  "version": "1.0.8",
+  "version": "1.1.0",
   "description": "Shopify Admin API Client - A lightweight JS client to interact with Shopify's Admin API",
@@ -53,3 +53,3 @@ "repository": {
   "dependencies": {
-    "@shopify/graphql-client": "^1.3.2"
+    "@shopify/graphql-client": "^1.4.0"
   },
@@ -56,0 +56,0 @@ "devDependencies": {

README.md

@@ -61,3 +61,3 @@ # Admin API Client
 | customFetchApi?  | `(url: string, init?: {method?: string, headers?: HeaderInit, body?: string}) => Promise<Response>`                                                           | A replacement `fetch` function that will be used in all client network requests. By default, the client uses `window.fetch()`.                                                                                |
-| logger?          | `(logContent:`[`UnsupportedApiVersionLog`](#unsupportedapiversionlog) `\|`[`HTTPResponseLog`](#httpresponselog)`\|`[`HTTPRetryLog`](#httpretrylog)`) => void` | A logger function that accepts [log content objects](#log-content-types). This logger will be called in certain conditions with contextual information.                                                       |
+| logger?          | `(logContent:`[`UnsupportedApiVersionLog`](#unsupportedapiversionlog) `\|`[`HTTPResponseLog`](#httpresponselog)`\|`[`HTTPRetryLog`](#httpretrylog)`\|`[`HTTPResponseGraphQLDeprecationNotice`](#httpresponsegraphqldeprecationnotice)`) => void` | A logger function that accepts [log content objects](#log-content-types). This logger will be called in certain conditions with contextual information.                                                       |
 
@@ -367,2 +367,11 @@ ### Client properties
 
+### `HTTPResponseGraphQLDeprecationNotice`
+
+This log content is sent to the logger whenever a HTTP response with a `X-Shopify-API-Deprecated-Reason` is received by the client.
+
+| Property | Type                     | Description                        |
+| -------- | ------------------------ | ---------------------------------- |
+| type      | `LogType['HTTP-Response-GraphQL-Deprecation-Notice']`                 | The type of log content. Is always set to `HTTP-Response-GraphQL-Deprecation-Notice`            |
+| content  | `{`[`requestParams`](#requestparams)`: [url, init?], deprecationNotice: string}` | Contextual data regarding the request and received deprecation information |
+
 #### `RequestParams`
@@ -369,0 +378,0 @@

No alert changes

Improved metrics

Total package byte prevSize

125254

0.69%

Number of lines in readme file

519

1.76%

Dependency changes

• Updated

  @shopify/graphql-client@^1.4.0