@scayle/storefront-core 7.58.3 → 7.59.0

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @scayle/storefront-core
 
+## 7.59.0
+
+### Minor Changes
+
+- Add `storefront:afterLogin` and `storefront:afterLogout` hooks to the respective RPC.
+
+  Add `callHook`, `callHookParallel` and `callHookWith` types to `RpcContext`
+
 ## 7.58.3
 
 ### Patch Changes

package/dist/helpers/productHelpers.cjs

@@ -11,7 +11,7 @@ var _product = require("../constants/product.cjs");
 var _attributeHelpers = require("./attributeHelpers.cjs");
 var _imageHelpers = require("./imageHelpers.cjs");
 var _arrayHelpers = require("./arrayHelpers.cjs");
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 const slugify = url => {
   return (0, _slugify.default)(url ?? "", {
     lower: true,

package/dist/index.cjs

@@ -97,4 +97,4 @@ Object.keys(_types).forEach(function (key) {
 });
 var _storefrontApi = require("@scayle/storefront-api");
 function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function (e) { return e ? t : r; })(e); }
-function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && Object.prototype.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
+function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }

package/dist/rpc/methods/checkout/checkout.cjs

@@ -31,7 +31,7 @@ const getCheckoutToken = exports.getCheckoutToken = async function getCheckoutTo
     carrier,
     basketId: context.basketKey,
     campaignKey: context.campaignKey
-  }).setIssuedAt(now).setNotBefore(now).setExpirationTime("1h").setIssuer(`${"@scayle/storefront-core"}@${"7.58.2"}`).setProtectedHeader({
+  }).setIssuedAt(now).setNotBefore(now).setExpirationTime("1h").setIssuer(`${"@scayle/storefront-core"}@${"7.58.3"}`).setProtectedHeader({
     alg: "HS256",
     typ: "JWT"
   }).sign(secret);

package/dist/rpc/methods/checkout/checkout.mjs

@@ -21,7 +21,7 @@ export const getCheckoutToken = async function getCheckoutToken2(jwtPayload = {}
     carrier,
     basketId: context.basketKey,
     campaignKey: context.campaignKey
-  }).setIssuedAt(now).setNotBefore(now).setExpirationTime("1h").setIssuer(`${"@scayle/storefront-core"}@${"7.58.2"}`).setProtectedHeader({ alg: "HS256", typ: "JWT" }).sign(secret);
+  }).setIssuedAt(now).setNotBefore(now).setExpirationTime("1h").setIssuer(`${"@scayle/storefront-core"}@${"7.58.3"}`).setProtectedHeader({ alg: "HS256", typ: "JWT" }).sign(secret);
   return {
     accessToken: refreshedAccessToken,
     checkoutJwt

package/dist/rpc/methods/session.cjs

@@ -35,6 +35,12 @@ async function postLogin(context, tokens) {
   } = (0, _jose.decodeJwt)(tokens.access_token);
   await Promise.all([(0, _user.mergeBaskets)(context.sessionId, await context.generateBasketKeyForUserId(customerId), _constants.DEFAULT_WITH_LISTING, context), (0, _user.mergeWishlists)(context.sessionId, await context.generateWishlistKeyForUserId(customerId), _constants.DEFAULT_WITH_LISTING, context)]);
   await context.createUserBoundSession();
+  await context.callHook?.("storefront:afterLogin", {
+    shopId: context.shopId,
+    user,
+    authenticationType: user.authentication?.type,
+    accessToken: tokens.access_token
+  }, context);
 }
 const oauthLogin = async (login, context) => {
   (0, _types.assertSession)(context);
@@ -141,10 +147,16 @@ const oauthRevokeToken = async context => {
   if (!accessToken) {
     throw new Error("No app oauth authentication credentials");
   }
+  const user = context.user;
   const client = (0, _oauth.getOAuthClient)(context);
   await context.destroySession();
   try {
     await client.revokeToken(context.shopId, accessToken);
+    await context.callHook?.("storefront:afterLogout", {
+      shopId: context.shopId,
+      user,
+      authenticationType: user.authentication?.type
+    }, context);
     return {
       result: true
     };

package/dist/rpc/methods/session.mjs

@@ -36,6 +36,12 @@ export async function postLogin(context, tokens) {
     )
   ]);
   await context.createUserBoundSession();
+  await context.callHook?.("storefront:afterLogin", {
+    shopId: context.shopId,
+    user,
+    authenticationType: user.authentication?.type,
+    accessToken: tokens.access_token
+  }, context);
 }
 export const oauthLogin = async (login, context) => {
   assertSession(context);
@@ -146,10 +152,16 @@ export const oauthRevokeToken = async (context) => {
   if (!accessToken) {
     throw new Error("No app oauth authentication credentials");
   }
+  const user = context.user;
   const client = getOAuthClient(context);
   await context.destroySession();
   try {
     await client.revokeToken(context.shopId, accessToken);
+    await context.callHook?.("storefront:afterLogout", {
+      shopId: context.shopId,
+      user,
+      authenticationType: user.authentication?.type
+    }, context);
     return { result: true };
   } catch (error) {
     const res = convertErrorForRpcCall(error, [

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

@@ -1,7 +1,8 @@
 import type { StorefrontAPIClient } from '@scayle/storefront-api';
+import type { Hookable } from 'hookable';
 import type { Log } from '../../utils';
 import type { CachedType } from '../../cache/cached';
-import type { ShopUser } from '../user';
+import type { AuthenticationType, ShopUser } from '../user';
 import type { BasketWithOptions, CategoryWith, ProductCategoryWith, ProductWith, SearchV2With, SearchWith, VariantWith, WishlistWithOptions } from '../';
 import type { IDPConfig, OAuthTokens } from './auth';
 export type WithParams = Partial<{
@@ -43,6 +44,21 @@ export interface ContextWithoutSession {
     updateUser: undefined;
     updateTokens: undefined;
 }
+interface LoginInformation {
+    shopId: number;
+    user: ShopUser;
+    authenticationType?: AuthenticationType;
+    accessToken: string;
+}
+interface LogoutInformation {
+    shopId: number;
+    user: ShopUser;
+    authenticationType?: AuthenticationType;
+}
+export interface StorefrontHooks {
+    'storefront:afterLogin': (loginInfo: LoginInformation, context: RpcContext) => Promise<void> | void;
+    'storefront:afterLogout': (logoutInfo: LogoutInformation, context: RpcContext) => Promise<void> | void;
+}
 export type RpcContext = {
     locale: string;
     checkout: {
@@ -84,6 +100,10 @@ export type RpcContext = {
     runtimeConfiguration: RuntimeConfiguration;
     idp?: IDPConfig;
     headers: Headers;
+    callHook?: Hookable<StorefrontHooks>['callHook'];
+    callHookParallel?: Hookable<StorefrontHooks>['callHookParallel'];
+    callHookWith?: Hookable<StorefrontHooks>['callHookWith'];
 } & AdditionalRpcContext & (ContextWithoutSession | ContextWithSession);
 export type RpcContextWithSession = RpcContext & ContextWithSession;
 export declare function assertSession(context: RpcContext): asserts context is RpcContextWithSession;
+export {};

package/dist/types/user.d.ts

@@ -14,7 +14,7 @@ interface MemberRole {
     memberPriority: number;
     memberRoleSap: string;
 }
-type AuthenticationType = 'password' | string;
+export type AuthenticationType = 'password' | string;
 interface UserAuthentication {
     data?: {
         accessToken?: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scayle/storefront-core",
-  "version": "7.58.3",
+  "version": "7.59.0",
   "description": "Collection of essential utilities to work with the Storefront API",
   "author": "SCAYLE Commerce Engine",
   "license": "MIT",
@@ -61,7 +61,8 @@
   "dependencies": {
     "@scayle/storefront-api": "17.3.0",
     "crypto-js": "4.2.0",
-    "jose": "5.5.0",
+    "hookable": "5.5.3",
+    "jose": "5.6.2",
     "radash": "12.1.0",
     "slugify": "1.6.6",
     "ufo": "1.5.3",
@@ -74,13 +75,13 @@
     "@types/node": "20.14.9",
     "@types/webpack-env": "1.18.5",
     "@vitest/coverage-v8": "1.6.0",
-    "dprint": "0.46.3",
-    "eslint": "9.5.0",
+    "dprint": "0.47.0",
+    "eslint": "9.6.0",
     "eslint-formatter-gitlab": "5.1.0",
     "publint": "0.2.8",
     "rimraf": "5.0.7",
     "ts-node": "10.9.2",
-    "typescript": "5.5.2",
+    "typescript": "5.5.3",
     "unbuild": "2.0.0",
     "unstorage": "1.10.2",
     "vitest": "1.6.0"