@salesforce/commerce-sdk-react 1.0.1 → 1.0.2

package/CHANGELOG.md

@@ -1,3 +1,8 @@
+## v1.0.2 (Sep 21, 2023)
+
+- commerce-sdk-react: have typedoc-related deps as dev dependencies [#1425](https://github.com/SalesforceCommerceCloud/pwa-kit/pull/1425)
+- Updated commerce-sdk-isomorphic to v1.10.4 [#137](https://github.com/SalesforceCommerceCloud/commerce-sdk-isomorphic/pull/137)
+
 ## v1.0.1 (Jul 26, 2023)
 
 - Updated the expiry of the guest refresh token cookie to 30 days, to match the actual [duration of the token](https://developer.salesforce.com/docs/commerce/commerce-api/guide/slas.html?q=refresh+token#access-tokens-and-refresh-tokens). [#1342](https://github.com/SalesforceCommerceCloud/pwa-kit/pull/1342)

package/auth/index.js

@@ -82,6 +82,10 @@ const DATA_MAP = {
       store.delete('cc-nx-g');
     }
   },
+  refresh_token_expires_in: {
+    storageType: 'local',
+    key: 'refresh_token_expires_in'
+  },
   // For Hybrid setups, we need a mechanism to inform PWA Kit whenever customer login state changes on SFRA.
   // So we maintain a copy of the refersh_tokens in the local storage which is compared to the actual refresh_token stored in cookie storage.
   // If the key or value of the refresh_token in local storage is different from the one in cookie storage, this indicates a change in customer auth state and we invalidate the access_token in PWA Kit.
@@ -207,7 +211,8 @@ class Auth {
       refresh_token: this.get('refresh_token_registered') || this.get('refresh_token_guest'),
       token_type: this.get('token_type'),
       usid: this.get('usid'),
-      customer_type: this.get('customer_type')
+      customer_type: this.get('customer_type'),
+      refresh_token_expires_in: this.get('refresh_token_expires_in')
     };
   }
 

package/hooks/ShopperLogin/query.d.ts

@@ -1,18 +1,6 @@
 import { UseQueryResult } from '@tanstack/react-query';
 import { ApiClients, ApiQueryOptions, Argument, DataType, NullableParameters } from '../types';
 type Client = ApiClients['shopperLogin'];
-/**
- * Get credential quality statistics for a user.
- * @group ShopperLogin
- * @category Query
- * @parameter apiOptions - Options to pass through to `commerce-sdk-isomorphic`, with `null` accepted for unset API parameters.
- * @parameter queryOptions - TanStack Query query options, with `enabled` by default set to check that all required API parameters have been set.
- * @returns A TanStack Query query hook with data from the Shopper Login `retrieveCredQualityUserInfo` endpoint.
- * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-login?meta=retrieveCredQualityUserInfo| Salesforce Developer Center} for more information about the API endpoint.
- * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shopperlogin.shopperlogin-1.html#retrievecredqualityuserinfo | `commerce-sdk-isomorphic` documentation} for more information on the parameters and returned data type.
- * @see {@link https://tanstack.com/query/latest/docs/react/reference/useQuery | TanStack Query `useQuery` reference} for more information about the return value.
- */
-export declare const useCredQualityUserInfo: (apiOptions: NullableParameters<Argument<Client['retrieveCredQualityUserInfo']>>, queryOptions?: ApiQueryOptions<Client['retrieveCredQualityUserInfo']>) => UseQueryResult<DataType<Client['retrieveCredQualityUserInfo']>>;
 /**
  * Returns a JSON listing of claims about the currently authenticated user.
  * @group ShopperLogin

package/hooks/ShopperLogin/query.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.useWellknownOpenidConfiguration = exports.useUserInfo = exports.useJwksUri = exports.useCredQualityUserInfo = void 0;
+exports.useWellknownOpenidConfiguration = exports.useUserInfo = exports.useJwksUri = void 0;
 var _useCommerceApi = _interopRequireDefault(require("../useCommerceApi"));
 var _useQuery = require("../useQuery");
 var _utils = require("../utils");
@@ -18,46 +18,6 @@ function _asyncToGenerator(fn) { return function () { var self = this, args = ar
                                                                                                                                                                                                                                                                                                                                                                                                        * SPDX-License-Identifier: BSD-3-Clause
                                                                                                                                                                                                                                                                                                                                                                                                        * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause
                                                                                                                                                                                                                                                                                                                                                                                                        */
-/**
- * Get credential quality statistics for a user.
- * @group ShopperLogin
- * @category Query
- * @parameter apiOptions - Options to pass through to `commerce-sdk-isomorphic`, with `null` accepted for unset API parameters.
- * @parameter queryOptions - TanStack Query query options, with `enabled` by default set to check that all required API parameters have been set.
- * @returns A TanStack Query query hook with data from the Shopper Login `retrieveCredQualityUserInfo` endpoint.
- * @see {@link https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-login?meta=retrieveCredQualityUserInfo| Salesforce Developer Center} for more information about the API endpoint.
- * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shopperlogin.shopperlogin-1.html#retrievecredqualityuserinfo | `commerce-sdk-isomorphic` documentation} for more information on the parameters and returned data type.
- * @see {@link https://tanstack.com/query/latest/docs/react/reference/useQuery | TanStack Query `useQuery` reference} for more information about the return value.
- */
-const useCredQualityUserInfo = (apiOptions, queryOptions = {}) => {
-  const {
-    shopperLogin: client
-  } = (0, _useCommerceApi.default)();
-  const methodName = 'retrieveCredQualityUserInfo';
-  const requiredParameters = ['organizationId', 'username'];
-
-  // Parameters can be set in `apiOptions` or `client.clientConfig`;
-  // we must merge them in order to generate the correct query key.
-  const netOptions = (0, _utils.omitNullableParameters)((0, _utils.mergeOptions)(client, apiOptions));
-  const queryKey = queryKeyHelpers[methodName].queryKey(netOptions.parameters);
-  // We don't use `netOptions` here because we manipulate the options in `useQuery`.
-  const method = /*#__PURE__*/function () {
-    var _ref = _asyncToGenerator(function* (options) {
-      return yield client[methodName](options);
-    });
-    return function method(_x) {
-      return _ref.apply(this, arguments);
-    };
-  }();
-
-  // For some reason, if we don't explicitly set these generic parameters, the inferred type for
-  // `Data` sometimes, but not always, includes `Response`, which is incorrect. I don't know why.
-  return (0, _useQuery.useQuery)(netOptions, queryOptions, {
-    method,
-    queryKey,
-    requiredParameters
-  });
-};
 /**
  * Returns a JSON listing of claims about the currently authenticated user.
  * @group ShopperLogin
@@ -69,7 +29,6 @@ const useCredQualityUserInfo = (apiOptions, queryOptions = {}) => {
  * @see {@link https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/classes/shopperlogin.shopperlogin-1.html#getuserinfo | `commerce-sdk-isomorphic` documentation} for more information on the parameters and returned data type.
  * @see {@link https://tanstack.com/query/latest/docs/react/reference/useQuery | TanStack Query `useQuery` reference} for more information about the return value.
  */
-exports.useCredQualityUserInfo = useCredQualityUserInfo;
 const useUserInfo = (apiOptions, queryOptions = {}) => {
   const {
     shopperLogin: client
@@ -83,11 +42,11 @@ const useUserInfo = (apiOptions, queryOptions = {}) => {
   const queryKey = queryKeyHelpers[methodName].queryKey(netOptions.parameters);
   // We don't use `netOptions` here because we manipulate the options in `useQuery`.
   const method = /*#__PURE__*/function () {
-    var _ref2 = _asyncToGenerator(function* (options) {
+    var _ref = _asyncToGenerator(function* (options) {
       return yield client[methodName](options);
     });
-    return function method(_x2) {
-      return _ref2.apply(this, arguments);
+    return function method(_x) {
+      return _ref.apply(this, arguments);
     };
   }();
 
@@ -124,11 +83,11 @@ const useWellknownOpenidConfiguration = (apiOptions, queryOptions = {}) => {
   const queryKey = queryKeyHelpers[methodName].queryKey(netOptions.parameters);
   // We don't use `netOptions` here because we manipulate the options in `useQuery`.
   const method = /*#__PURE__*/function () {
-    var _ref3 = _asyncToGenerator(function* (options) {
+    var _ref2 = _asyncToGenerator(function* (options) {
       return yield client[methodName](options);
     });
-    return function method(_x3) {
-      return _ref3.apply(this, arguments);
+    return function method(_x2) {
+      return _ref2.apply(this, arguments);
     };
   }();
 
@@ -165,11 +124,11 @@ const useJwksUri = (apiOptions, queryOptions = {}) => {
   const queryKey = queryKeyHelpers[methodName].queryKey(netOptions.parameters);
   // We don't use `netOptions` here because we manipulate the options in `useQuery`.
   const method = /*#__PURE__*/function () {
-    var _ref4 = _asyncToGenerator(function* (options) {
+    var _ref3 = _asyncToGenerator(function* (options) {
       return yield client[methodName](options);
     });
-    return function method(_x4) {
-      return _ref4.apply(this, arguments);
+    return function method(_x3) {
+      return _ref3.apply(this, arguments);
     };
   }();
 

package/hooks/ShopperLogin/queryKeyHelpers.d.ts

@@ -5,13 +5,6 @@ type Client = ShopperLogin<{
 }>;
 type Params<T extends keyof QueryKeys> = Partial<Argument<Client[T]>['parameters']>;
 export type QueryKeys = {
-    retrieveCredQualityUserInfo: [
-        '/commerce-sdk-react',
-        '/organizations/',
-        string | undefined,
-        '/cred-qual/user',
-        Params<'retrieveCredQualityUserInfo'>
-    ];
     getUserInfo: [
         '/commerce-sdk-react',
         '/organizations/',
@@ -45,7 +38,6 @@ type QueryKeyHelper<T extends keyof QueryKeys> = {
     /** Generates the full query key for an endpoint. */
     queryKey: (params: Params<T>) => QueryKeys[T];
 };
-export declare const retrieveCredQualityUserInfo: QueryKeyHelper<'retrieveCredQualityUserInfo'>;
 export declare const getUserInfo: QueryKeyHelper<'getUserInfo'>;
 export declare const getWellknownOpenidConfiguration: QueryKeyHelper<'getWellknownOpenidConfiguration'>;
 export declare const getJwksUri: QueryKeyHelper<'getJwksUri'>;

package/hooks/ShopperLogin/queryKeyHelpers.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.retrieveCredQualityUserInfo = exports.getWellknownOpenidConfiguration = exports.getUserInfo = exports.getJwksUri = void 0;
+exports.getWellknownOpenidConfiguration = exports.getUserInfo = exports.getJwksUri = void 0;
 var _utils = require("../utils");
 /*
  * Copyright (c) 2023, Salesforce, Inc.
@@ -17,12 +17,6 @@ var _utils = require("../utils");
 // This is defined here, rather than `types.ts`, because it relies on `Client` and `QueryKeys`,
 // and making those generic would add too much complexity.
 
-const retrieveCredQualityUserInfo = {
-  parameters: params => (0, _utils.pick)(params, ['organizationId', 'username']),
-  path: params => ['/commerce-sdk-react', '/organizations/', params.organizationId, '/cred-qual/user'],
-  queryKey: params => [...retrieveCredQualityUserInfo.path(params), retrieveCredQualityUserInfo.parameters(params)]
-};
-exports.retrieveCredQualityUserInfo = retrieveCredQualityUserInfo;
 const getUserInfo = {
   parameters: params => (0, _utils.pick)(params, ['organizationId', 'channel_id']),
   path: params => ['/commerce-sdk-react', '/organizations/', params.organizationId, '/oauth2/userinfo'],

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce/commerce-sdk-react",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "A library that provides react hooks for fetching data from Commerce Cloud",
   "homepage": "https://github.com/SalesforceCommerceCloud/pwa-kit/tree/develop/packages/ecom-react-hooks#readme",
   "bugs": {
@@ -40,14 +40,12 @@
     "version": "node ./scripts/version.js"
   },
   "dependencies": {
-    "commerce-sdk-isomorphic": "^1.10.1",
+    "commerce-sdk-isomorphic": "^1.10.4",
     "js-cookie": "^3.0.1",
-    "jwt-decode": "^3.1.2",
-    "typedoc": "^0.24.7",
-    "typedoc-plugin-missing-exports": "^2.0.0"
+    "jwt-decode": "^3.1.2"
   },
   "devDependencies": {
-    "@salesforce/pwa-kit-dev": "3.1.0",
+    "@salesforce/pwa-kit-dev": "3.1.1",
     "@tanstack/react-query": "^4.28.0",
     "@testing-library/jest-dom": "^5.16.5",
     "@testing-library/react": "^14.0.0",
@@ -59,7 +57,7 @@
     "@types/react-dom": "^18.2.1",
     "@types/react-helmet": "^6.1.6",
     "cross-env": "^5.2.1",
-    "internal-lib-build": "3.1.0",
+    "internal-lib-build": "3.1.1",
     "jsonwebtoken": "^9.0.0",
     "nock": "^13.3.0",
     "nodemon": "^2.0.22",
@@ -69,6 +67,7 @@
     "semver": "^7.5.2",
     "shelljs": "^0.8.5",
     "typedoc": "^0.24.7",
+    "typedoc-plugin-missing-exports": "^2.0.0",
     "typescript": "4.9.5"
   },
   "peerDependencies": {
@@ -86,5 +85,5 @@
   "publishConfig": {
     "directory": "dist"
   },
-  "gitHead": "9903df6beef25919921962f4fa950f91352adee2"
+  "gitHead": "0194d62014788b280549e70e6e80da279227b500"
 }