@scayle/storefront-core 7.46.1 → 7.48.0

package/CHANGELOG.md

@@ -1,5 +1,31 @@
 # @scayle/storefront-core
 
+## 7.48.0
+
+### Minor Changes
+
+- Add support for dynamically adding query parameters to the IDP redirect callback URLs to be read back when the user returns from the IDP.
+
+  ```ts
+  const { data: externalIDPRedirects } = await useIDP({
+    queryParams: { redirectTo: '/account' },
+  })
+  ```
+
+  Please note that `code` and `state` are not supported as these are used by the SCAYLE Authentication API.
+
+### Patch Changes
+
+- Added merge basket and merge wishlist functionality after login with IDP
+- Updated dependencies
+  - @aboutyou/backbone@16.2.1
+
+## 7.47.0
+
+### Minor Changes
+
+- Add `resolveSearch` and `getSearchSuggestions` RPC methods
+
 ## 7.46.1
 
 ### Patch Changes

package/dist/constants/withParameters.d.ts

@@ -1,7 +1,4 @@
-import type { BasketWith } from '@aboutyou/backbone/endpoints/basket/getBasket';
-import type { ProductWith } from '@aboutyou/backbone/types/ProductWith';
-import type { WishlistWith } from '@aboutyou/backbone/endpoints/wishlist/getWishlist';
-import { SearchWith } from '../types';
+import type { SearchWith, BasketWith, ProductWith, WishlistWith } from '../types';
 declare const DEFAULT_WITH_LISTING: {
     items: {
         product: {

package/dist/rpc/methods/oauth/idp.cjs

@@ -7,36 +7,44 @@ exports.handleIDPLoginCallback = exports.getExternalIdpRedirect = void 0;
 var _jose = require("jose");
 var _types = require("../../../types/index.cjs");
 var _oauth = require("../../../api/oauth.cjs");
-var _user = require("../user.cjs");
-const getExternalIdpRedirect = exports.getExternalIdpRedirect = async function getExternalIdpRedirect2(context) {
-  const shopId = context.shopId.toString();
-  const OAuthClient = (0, _oauth.getOAuthClient)(context);
-  const checkoutSecret = context.checkout.secret;
+var _session = require("../session.cjs");
+const getExternalIdpRedirect = exports.getExternalIdpRedirect = async function getExternalIdpRedirect2({
+  queryParams
+}, context) {
   if (!context.idp?.enabled) {
     return {};
   }
-  const IDPKeys = context.idp.idpKeys;
-  const IDPRedirectURL = context.idp.idpRedirectURL;
-  if (!IDPKeys.length) {
-    throw new Error("No IDP keys configured");
+  if (context.idp.idpKeys.length === 0) {
+    return new Response("No IDP keys are configured", {
+      status: 400
+    });
   }
-  if (!IDPRedirectURL) {
-    throw new Error("No redirect URL");
+  if (!context.idp.idpRedirectURL) {
+    return new Response("No IDP redirect url is configured", {
+      status: 400
+    });
   }
-  if (!shopId) {
-    throw new Error("Missing shopId");
+  const OAuthClient = (0, _oauth.getOAuthClient)(context);
+  const redirectUrl = new URL(context.idp.idpRedirectURL);
+  if (queryParams) {
+    for (const [key, value] of Object.entries(queryParams)) {
+      redirectUrl.searchParams.set(key, value);
+    }
   }
-  const secret = new TextEncoder().encode(checkoutSecret);
-  const results = await Promise.all(IDPKeys.map(async idpKey => {
+  const secret = new TextEncoder().encode(context.checkout.secret);
+  const results = await Promise.all(context.idp.idpKeys.map(async idpKey => {
     const jwtPayload = await new _jose.SignJWT({
       idpKey,
-      callbackUrl: IDPRedirectURL,
+      callbackUrl: redirectUrl.toString(),
       clientId: OAuthClient.clientId.toString()
     }).setProtectedHeader({
       alg: "HS256",
       typ: "JWT"
     }).setIssuedAt().setExpirationTime("2h").sign(secret);
-    return [idpKey, `${OAuthClient.baseURL}/auth/external/redirect?shopId=${shopId}&jwt=${jwtPayload}`];
+    const url = new URL(`${OAuthClient.baseURL}/auth/external/redirect`);
+    url.searchParams.set("shopId", `${context.shopId}`);
+    url.searchParams.set("jwt", jwtPayload);
+    return [idpKey, url.toString()];
   }));
   return Object.fromEntries(results);
 };
@@ -44,15 +52,8 @@ const handleIDPLoginCallback = exports.handleIDPLoginCallback = async function h
   (0, _types.assertSession)(context);
   const OAuthClient = (0, _oauth.getOAuthClient)(context);
   const code = typeof payload === "string" ? payload : payload.code;
-  const {
-    access_token: accessToken,
-    refresh_token: refreshToken
-  } = await OAuthClient.generateToken(code);
-  context.updateTokens({
-    accessToken,
-    refreshToken
-  });
-  await (0, _user.refreshUser)(context);
+  const tokens = await OAuthClient.generateToken(code);
+  await (0, _session.postLogin)(context, tokens);
   return {
     message: "success"
   };

package/dist/rpc/methods/oauth/idp.d.ts

@@ -1,9 +1,11 @@
 import type { RpcContext } from '../../../types';
-export declare const getExternalIdpRedirect: (context: RpcContext) => Promise<{
+export declare const getExternalIdpRedirect: ({ queryParams }: {
+    queryParams?: Record<string, string>;
+}, context: RpcContext) => Promise<Response | {
     [k: string]: string;
 }>;
-export declare const handleIDPLoginCallback: (payload: string | {
+export declare const handleIDPLoginCallback: (payload: {
     code: string;
-}, context: RpcContext) => Promise<{
+} | string, context: RpcContext) => Promise<{
     message: string;
 }>;

package/dist/rpc/methods/oauth/idp.mjs

@@ -1,37 +1,36 @@
 import { SignJWT } from "jose";
 import { assertSession } from "../../../types/index.mjs";
 import { getOAuthClient } from "../../../api/oauth.mjs";
-import { refreshUser } from "../user.mjs";
-export const getExternalIdpRedirect = async function getExternalIdpRedirect2(context) {
-  const shopId = context.shopId.toString();
-  const OAuthClient = getOAuthClient(context);
-  const checkoutSecret = context.checkout.secret;
+import { postLogin } from "../session.mjs";
+export const getExternalIdpRedirect = async function getExternalIdpRedirect2({ queryParams }, context) {
   if (!context.idp?.enabled) {
     return {};
   }
-  const IDPKeys = context.idp.idpKeys;
-  const IDPRedirectURL = context.idp.idpRedirectURL;
-  if (!IDPKeys.length) {
-    throw new Error("No IDP keys configured");
+  if (context.idp.idpKeys.length === 0) {
+    return new Response("No IDP keys are configured", { status: 400 });
   }
-  if (!IDPRedirectURL) {
-    throw new Error("No redirect URL");
+  if (!context.idp.idpRedirectURL) {
+    return new Response("No IDP redirect url is configured", { status: 400 });
   }
-  if (!shopId) {
-    throw new Error("Missing shopId");
+  const OAuthClient = getOAuthClient(context);
+  const redirectUrl = new URL(context.idp.idpRedirectURL);
+  if (queryParams) {
+    for (const [key, value] of Object.entries(queryParams)) {
+      redirectUrl.searchParams.set(key, value);
+    }
   }
-  const secret = new TextEncoder().encode(checkoutSecret);
+  const secret = new TextEncoder().encode(context.checkout.secret);
   const results = await Promise.all(
-    IDPKeys.map(async (idpKey) => {
+    context.idp.idpKeys.map(async (idpKey) => {
       const jwtPayload = await new SignJWT({
         idpKey,
-        callbackUrl: IDPRedirectURL,
+        callbackUrl: redirectUrl.toString(),
         clientId: OAuthClient.clientId.toString()
       }).setProtectedHeader({ alg: "HS256", typ: "JWT" }).setIssuedAt().setExpirationTime("2h").sign(secret);
-      return [
-        idpKey,
-        `${OAuthClient.baseURL}/auth/external/redirect?shopId=${shopId}&jwt=${jwtPayload}`
-      ];
+      const url = new URL(`${OAuthClient.baseURL}/auth/external/redirect`);
+      url.searchParams.set("shopId", `${context.shopId}`);
+      url.searchParams.set("jwt", jwtPayload);
+      return [idpKey, url.toString()];
     })
   );
   return Object.fromEntries(results);
@@ -40,12 +39,8 @@ export const handleIDPLoginCallback = async function handleIDPLoginCallback2(pay
   assertSession(context);
   const OAuthClient = getOAuthClient(context);
   const code = typeof payload === "string" ? payload : payload.code;
-  const { access_token: accessToken, refresh_token: refreshToken } = await OAuthClient.generateToken(code);
-  context.updateTokens({
-    accessToken,
-    refreshToken
-  });
-  await refreshUser(context);
+  const tokens = await OAuthClient.generateToken(code);
+  await postLogin(context, tokens);
   return {
     message: "success"
   };

package/dist/rpc/methods/search.cjs

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.searchProducts = void 0;
+exports.searchProducts = exports.resolveSearch = exports.getSearchSuggestions = void 0;
 var _constants = require("../../constants/index.cjs");
 var _stringHelpers = require("../../helpers/stringHelpers.cjs");
 const searchProducts = exports.searchProducts = async function searchProducts2({
@@ -25,6 +25,39 @@ const searchProducts = exports.searchProducts = async function searchProducts2({
     with: _with ?? withParams?.search ?? _constants.MIN_WITH_PARAMS_SEARCH
   });
 };
+const getSearchSuggestions = exports.getSearchSuggestions = async function getSearchSuggestions2({
+  term,
+  with: _with,
+  categoryId
+}, {
+  bapiClient,
+  withParams
+}) {
+  return await bapiClient.searchv2.suggestions(term, {
+    categoryId,
+    with: _with ?? withParams?.searchV2
+  });
+};
+const resolveSearch = exports.resolveSearch = async function resolveSearch2({
+  term,
+  with: _with,
+  categoryId
+}, {
+  cached,
+  bapiClient,
+  withParams
+}) {
+  const resolvedEntity = await cached(bapiClient.searchv2.resolve, {
+    cacheKeyPrefix: `resolve-${term}`
+  })(term, {
+    categoryId,
+    with: _with ?? withParams?.searchV2
+  });
+  if (!resolvedEntity) {
+    return null;
+  }
+  return resolvedEntity;
+};
 const getCategoryId = async (cached, bapiClient, slug) => {
   if (!slug) {
     return;

package/dist/rpc/methods/search.d.ts

@@ -1,9 +1,13 @@
 import type { TypeaheadSuggestionsEndpointRequestParameters, TypeaheadSuggestionsEndpointResponseData } from '@aboutyou/backbone/endpoints/typeahead/typeahead';
+import type { SearchV2ResolveEndpointParameters, SearchV2SuggestionsEndpointResponseData, SearchV2SuggestionsEndpointParameters } from '../../types/bapi/search';
 type SearchWith = TypeaheadSuggestionsEndpointRequestParameters['with'];
+/** @deprecated `searchProducts` is deprecated. Please, use `getSuggestions` or `resolve` RPC methods */
 export declare const searchProducts: ({ term, slug, with: _with, productLimit }: {
     term: string;
     slug?: string | undefined;
     with?: SearchWith;
     productLimit?: number | undefined;
 }, { cached, bapiClient, withParams }: import("../../types").RpcContext) => Promise<TypeaheadSuggestionsEndpointResponseData>;
+export declare const getSearchSuggestions: ({ term, with: _with, categoryId }: SearchV2SuggestionsEndpointParameters, { bapiClient, withParams }: import("../../types").RpcContext) => Promise<SearchV2SuggestionsEndpointResponseData>;
+export declare const resolveSearch: ({ term, with: _with, categoryId }: SearchV2ResolveEndpointParameters, { cached, bapiClient, withParams }: import("../../types").RpcContext) => Promise<import("@aboutyou/backbone/types/Search").SearchEntity | null>;
 export {};

package/dist/rpc/methods/search.mjs

@@ -10,6 +10,27 @@ export const searchProducts = async function searchProducts2({ term, slug, with:
     with: _with ?? withParams?.search ?? MIN_WITH_PARAMS_SEARCH
   });
 };
+export const getSearchSuggestions = async function getSearchSuggestions2({ term, with: _with, categoryId }, { bapiClient, withParams }) {
+  return await bapiClient.searchv2.suggestions(
+    term,
+    {
+      categoryId,
+      with: _with ?? withParams?.searchV2
+    }
+  );
+};
+export const resolveSearch = async function resolveSearch2({ term, with: _with, categoryId }, { cached, bapiClient, withParams }) {
+  const resolvedEntity = await cached(bapiClient.searchv2.resolve, {
+    cacheKeyPrefix: `resolve-${term}`
+  })(term, {
+    categoryId,
+    with: _with ?? withParams?.searchV2
+  });
+  if (!resolvedEntity) {
+    return null;
+  }
+  return resolvedEntity;
+};
 const getCategoryId = async (cached, bapiClient, slug) => {
   if (!slug) {
     return;

package/dist/rpc/methods/session.cjs

@@ -3,7 +3,9 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.updatePasswordByHash = exports.refreshAccessToken = exports.oauthRevokeToken = exports.oauthRegister = exports.oauthLogin = exports.oauthGuestLogin = exports.oauthForgetPassword = void 0;
+exports.oauthRevokeToken = exports.oauthRegister = exports.oauthLogin = exports.oauthGuestLogin = exports.oauthForgetPassword = void 0;
+exports.postLogin = postLogin;
+exports.updatePasswordByHash = exports.refreshAccessToken = void 0;
 var _jose = require("jose");
 var _types = require("../../types/index.cjs");
 var _constants = require("../../constants/index.cjs");

package/dist/rpc/methods/session.d.ts

@@ -1,5 +1,6 @@
 import type { Optional } from 'utility-types';
-import type { GuestRequest, LoginRequest, RegisterRequest, RpcContext, UpdatePasswordByHashRequest } from '../../types';
+import type { GuestRequest, LoginRequest, Oauth, RegisterRequest, RpcContext, RpcContextWithSession, UpdatePasswordByHashRequest } from '../../types';
+export declare function postLogin(context: RpcContextWithSession, tokens: Oauth): Promise<void>;
 export declare const oauthLogin: (login: Optional<LoginRequest, "shop_id">, context: RpcContext) => Promise<Response>;
 export declare const oauthRegister: (register: Optional<RegisterRequest, "shop_id">, context: RpcContext) => Promise<Response>;
 export declare const oauthGuestLogin: (guest: Optional<GuestRequest, "shop_id">, context: RpcContext) => Promise<Response>;

package/dist/rpc/methods/session.mjs

@@ -11,7 +11,7 @@ const convertErrorForRpcCall = (error, httpStatuses) => {
     return new Response(null, { status: error.response.status });
   }
 };
-async function postLogin(context, tokens) {
+export async function postLogin(context, tokens) {
   const user = await unwrap(
     fetchUser({ accessToken: tokens.access_token, callback: "" }, context)
   );

package/dist/types/api/context.d.ts

@@ -2,7 +2,7 @@ import type { BapiClient } from '@aboutyou/backbone';
 import type { Log } from '../../utils';
 import type { CachedType } from '../../cache/cached';
 import type { ShopUser } from '../user';
-import type { WishlistWithOptions, BasketWithOptions, ProductWith, VariantWith, SearchWith, CategoryWith, ProductCategoryWith } from '../';
+import type { WishlistWithOptions, BasketWithOptions, ProductWith, VariantWith, SearchWith, SearchV2With, CategoryWith, ProductCategoryWith } from '../';
 import { OAuthTokens, IDPConfig } from './auth';
 export type WithParams = Partial<{
     basket: BasketWithOptions;
@@ -11,6 +11,7 @@ export type WithParams = Partial<{
     productCategory: ProductCategoryWith;
     category: CategoryWith;
     search: SearchWith;
+    searchV2: SearchV2With;
     variant: VariantWith;
 }>;
 export interface RuntimeConfiguration {

package/dist/types/bapi/search.d.ts

@@ -2,6 +2,10 @@ import type { ProductWith } from '@aboutyou/backbone/types/ProductWith';
 import type { TypeaheadSuggestionsEndpointRequestParameters } from '@aboutyou/backbone/endpoints/typeahead/typeahead';
 import { Query } from '../index';
 export type { BrandOrCategorySuggestion, ProductSuggestion, TypeaheadSuggestion, TypeaheadBrandOrCategorySuggestion, TypeaheadProductSuggestion, TypeaheadSuggestionsEndpointResponseData, } from '@aboutyou/backbone/endpoints/typeahead/typeahead';
+export type { SearchV2With } from '@aboutyou/backbone/endpoints/searchv2/includes';
+export type { SearchV2SuggestionsEndpointResponseData, SearchV2SuggestionsEndpointParameters, } from '@aboutyou/backbone/endpoints/searchv2/suggestions';
+export type { SearchV2ResolveEndpointResponseData, SearchV2ResolveEndpointParameters, } from '@aboutyou/backbone/endpoints/searchv2/resolve';
+export type * from '@aboutyou/backbone/types/Search';
 export type SearchInput = {
     term?: Query;
     slug?: string;

package/dist/utils/keys.d.ts

@@ -1,24 +1,24 @@
 import type { Log } from '..';
 import { HashAlgorithm } from '../constants/hash';
 export declare const generateKey: ({ keyTemplate, hashAlgorithm, shopId, userId, log, }: {
-    keyName?: string | undefined;
+    keyName?: string;
     keyTemplate: string;
     hashAlgorithm: HashAlgorithm;
     shopId: string;
     userId: string;
-    log?: Log | undefined;
+    log?: Log;
 }) => Promise<string>;
 export declare const generateWishlistKey: ({ keyTemplate, hashAlgorithm, shopId, userId, log, }: {
     keyTemplate: string;
     hashAlgorithm: HashAlgorithm;
     shopId: string;
     userId: string;
-    log?: Log | undefined;
+    log?: Log;
 }) => Promise<string>;
 export declare const generateBasketKey: ({ keyTemplate, hashAlgorithm, shopId, userId, log, }: {
     keyTemplate: string;
     hashAlgorithm: HashAlgorithm;
     shopId: string;
     userId: string;
-    log?: Log | undefined;
+    log?: Log;
 }) => Promise<string>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scayle/storefront-core",
-  "version": "7.46.1",
+  "version": "7.48.0",
   "description": "Collection of essential utilities to work with the Storefront API",
   "author": "SCAYLE Commerce Engine",
   "license": "MIT",
@@ -59,7 +59,7 @@
     "test:ci": "vitest --run --passWithNoTests --coverage --reporter=default --reporter=junit"
   },
   "dependencies": {
-    "@aboutyou/backbone": "16.2.0",
+    "@aboutyou/backbone": "16.2.1",
     "crypto-js": "4.2.0",
     "jose": "5.2.3",
     "radash": "12.1.0",
@@ -71,16 +71,16 @@
   "devDependencies": {
     "@scayle/eslint-config-storefront": "3.2.6",
     "@types/crypto-js": "4.2.2",
-    "@types/node": "20.11.30",
+    "@types/node": "20.12.5",
     "@types/webpack-env": "1.18.4",
     "@vitest/coverage-v8": "1.4.0",
-    "dprint": "0.45.0",
+    "dprint": "0.45.1",
     "eslint": "8.57.0",
     "eslint-formatter-gitlab": "5.1.0",
     "publint": "0.2.7",
     "rimraf": "5.0.5",
     "ts-node": "10.9.2",
-    "typescript": "5.4.3",
+    "typescript": "5.4.4",
     "unbuild": "2.0.0",
     "unstorage": "1.10.2",
     "vitest": "1.4.0"