@scayle/storefront-core 7.32.0 → 7.34.0

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @scayle/storefront-core
 
+## 7.34.0
+
+### Minor Changes
+
+- We added support for Identity Provider (IDP), enhancing our authentication and identity management capabilities.
+
+## 7.33.0
+
+### Minor Changes
+
+- Previously the caching time for product RPCs was one hour which could easily lead to outdated product information for a long time.
+
+  The `getProductById` and `getProductsByIds` RPCs are now cached for 5 Minutes and `getProductsByCategory` is now cached for 15 Minutes.
+
 ## 7.32.0
 
 ### Minor Changes

package/dist/api/oauth.cjs

@@ -40,6 +40,7 @@ class OAuthClient {
   headers;
   baseURL;
   logger;
+  clientId;
   constructor(options, logger) {
     const {
       clientId,
@@ -49,6 +50,7 @@ class OAuthClient {
     if (!clientId || !clientSecret) {
       throw new MissingCredentialsError();
     }
+    this.clientId = clientId;
     this.baseURL = `${apiHost}/v1`;
     this.logger = logger ? logger.space("auth-client") : void 0;
     const basicAuthHash = (0, _hash.encodeBase64)(`${clientId}:${clientSecret}`);
@@ -174,5 +176,19 @@ class OAuthClient {
       }
     }).then(emptyOAuthResponseHandler);
   }
+  /**
+   * Revoke all tokens for a user
+   * @param userId
+   */
+  async generateToken(code) {
+    return await fetch(`${this.baseURL}/oauth/token`, {
+      method: "POST",
+      headers: this.headers,
+      body: JSON.stringify({
+        grant_type: "authorization_code",
+        code
+      })
+    }).then(oauthResponseHandler);
+  }
 }
 exports.OAuthClient = OAuthClient;

package/dist/api/oauth.d.ts

@@ -15,6 +15,7 @@ export declare class OAuthClient {
     headers: HeadersInit;
     baseURL: string;
     logger?: Log;
+    clientId?: string;
     constructor(options: OAuthOptions, logger?: Log);
     /**
      * Register a user and retrieve a token set
@@ -64,4 +65,9 @@ export declare class OAuthClient {
      * @param accessToken
      */
     revokeToken(accessToken: string): Promise<void>;
+    /**
+     * Revoke all tokens for a user
+     * @param userId
+     */
+    generateToken(code: string): Promise<Oauth>;
 }

package/dist/api/oauth.mjs

@@ -29,11 +29,13 @@ export class OAuthClient {
   headers;
   baseURL;
   logger;
+  clientId;
   constructor(options, logger) {
     const { clientId, clientSecret, apiHost } = options;
     if (!clientId || !clientSecret) {
       throw new MissingCredentialsError();
     }
+    this.clientId = clientId;
     this.baseURL = `${apiHost}/v1`;
     this.logger = logger ? logger.space("auth-client") : void 0;
     const basicAuthHash = encodeBase64(`${clientId}:${clientSecret}`);
@@ -159,4 +161,18 @@ export class OAuthClient {
       }
     }).then(emptyOAuthResponseHandler);
   }
+  /**
+   * Revoke all tokens for a user
+   * @param userId
+   */
+  async generateToken(code) {
+    return await fetch(`${this.baseURL}/oauth/token`, {
+      method: "POST",
+      headers: this.headers,
+      body: JSON.stringify({
+        grant_type: "authorization_code",
+        code
+      })
+    }).then(oauthResponseHandler);
+  }
 }

package/dist/cache/cached.cjs

@@ -3,11 +3,12 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.Cached = void 0;
+exports.MINUTE = exports.Cached = void 0;
 var _autobind = require("../helpers/autobind.cjs");
 var _utils = require("../utils/index.cjs");
 var _hash = require("../utils/hash.cjs");
 var _constants = require("../constants/index.cjs");
+const MINUTE = exports.MINUTE = 60;
 const CACHE_NOT_INITIALIZED_MSG = "Cache is not initialized";
 class Cached {
   cache;
@@ -66,7 +67,7 @@ class Cached {
     if (!this.isCacheEnabled) {
       return;
     }
-    const ttl = options?.ttl || 60 * 60;
+    const ttl = options?.ttl || 60 * MINUTE;
     if (ttl) {
       await (0, _utils.timeout)(_constants.CACHE_TIMEOUT, this.cache.set(cacheKey, value, ttl));
     }

package/dist/cache/cached.d.ts

@@ -1,5 +1,6 @@
 import { Log } from '../utils';
 import { Cache as CacheInterface } from './cache';
+export declare const MINUTE = 60;
 export type CacheOptions = Partial<{
     ttl: number;
     cacheKey: string;

package/dist/cache/cached.mjs

@@ -2,6 +2,7 @@ import { autobind } from "../helpers/autobind.mjs";
 import { timeout } from "../utils/index.mjs";
 import { sha256 } from "../utils/hash.mjs";
 import { CACHE_TIMEOUT } from "../constants/index.mjs";
+export const MINUTE = 60;
 const CACHE_NOT_INITIALIZED_MSG = "Cache is not initialized";
 export class Cached {
   cache;
@@ -63,7 +64,7 @@ export class Cached {
     if (!this.isCacheEnabled) {
       return;
     }
-    const ttl = options?.ttl || 60 * 60;
+    const ttl = options?.ttl || 60 * MINUTE;
     if (ttl) {
       await timeout(CACHE_TIMEOUT, this.cache.set(cacheKey, value, ttl));
     }

package/dist/rpc/methods/index.cjs

@@ -156,4 +156,15 @@ Object.keys(_promotion).forEach(function (key) {
       return _promotion[key];
     }
   });
+});
+var _idp = require("./oauth/idp.cjs");
+Object.keys(_idp).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _idp[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _idp[key];
+    }
+  });
 });

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

@@ -12,3 +12,4 @@ export * from './variants';
 export * from './navigationTrees';
 export * from './session';
 export * from './promotion';
+export * from './oauth/idp';

package/dist/rpc/methods/index.mjs

@@ -12,3 +12,4 @@ export * from "./variants.mjs";
 export * from "./navigationTrees.mjs";
 export * from "./session.mjs";
 export * from "./promotion.mjs";
+export * from "./oauth/idp.mjs";

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

@@ -0,0 +1,55 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.handleIDPLoginCallback = exports.getExternalIdpRedirect = void 0;
+var _jose = require("jose");
+var _oauth = require("../../../api/oauth.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;
+  const isIDPEnabled = context.idp.enabled;
+  const IDPKeys = context.idp.idpKeys;
+  const IDPRedirectURL = context.idp.idpRedirectURL;
+  if (!isIDPEnabled) {
+    throw new Error("IDP disabled");
+  }
+  if (!IDPKeys.length) {
+    throw new Error("No IDP keys configured");
+  }
+  if (!IDPRedirectURL) {
+    throw new Error("No redirect URL");
+  }
+  if (!shopId) {
+    throw new Error("Missing shopId");
+  }
+  const secret = new TextEncoder().encode(checkoutSecret);
+  const results = await Promise.all(IDPKeys.map(async idpKey => {
+    const jwtPayload = await new _jose.SignJWT({
+      idpKey,
+      callbackUrl: IDPRedirectURL,
+      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}`];
+  }));
+  return Object.fromEntries(results);
+};
+const handleIDPLoginCallback = exports.handleIDPLoginCallback = async function handleIDPLoginCallback2(code, context) {
+  const OAuthClient = (0, _oauth.getOAuthClient)(context);
+  const {
+    access_token: accessToken,
+    refresh_token: refreshToken
+  } = await OAuthClient.generateToken(code);
+  context.updateTokens({
+    accessToken,
+    refreshToken
+  });
+  return {
+    message: "success"
+  };
+};

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

@@ -0,0 +1,7 @@
+import type { RpcContext } from '../../../types';
+export declare const getExternalIdpRedirect: (context: RpcContext) => Promise<{
+    [k: string]: string;
+}>;
+export declare const handleIDPLoginCallback: (code: string, context: RpcContext) => Promise<{
+    message: string;
+}>;

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

@@ -0,0 +1,48 @@
+import { SignJWT } from "jose";
+import { getOAuthClient } from "../../../api/oauth.mjs";
+export const getExternalIdpRedirect = async function getExternalIdpRedirect2(context) {
+  const shopId = context.shopId.toString();
+  const OAuthClient = getOAuthClient(context);
+  const checkoutSecret = context.checkout.secret;
+  const isIDPEnabled = context.idp.enabled;
+  const IDPKeys = context.idp.idpKeys;
+  const IDPRedirectURL = context.idp.idpRedirectURL;
+  if (!isIDPEnabled) {
+    throw new Error("IDP disabled");
+  }
+  if (!IDPKeys.length) {
+    throw new Error("No IDP keys configured");
+  }
+  if (!IDPRedirectURL) {
+    throw new Error("No redirect URL");
+  }
+  if (!shopId) {
+    throw new Error("Missing shopId");
+  }
+  const secret = new TextEncoder().encode(checkoutSecret);
+  const results = await Promise.all(
+    IDPKeys.map(async (idpKey) => {
+      const jwtPayload = await new SignJWT({
+        idpKey,
+        callbackUrl: IDPRedirectURL,
+        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}`
+      ];
+    })
+  );
+  return Object.fromEntries(results);
+};
+export const handleIDPLoginCallback = async function handleIDPLoginCallback2(code, context) {
+  const OAuthClient = getOAuthClient(context);
+  const { access_token: accessToken, refresh_token: refreshToken } = await OAuthClient.generateToken(code);
+  context.updateTokens({
+    accessToken,
+    refreshToken
+  });
+  return {
+    message: "success"
+  };
+};

package/dist/rpc/methods/products.cjs

@@ -6,6 +6,7 @@ Object.defineProperty(exports, "__esModule", {
 exports.getProductsCount = exports.getProductsByIds = exports.getProductsByCategory = exports.getProductById = exports.getFilters = exports.fetchAllFiltersForCategory = void 0;
 var _helpers = require("../../helpers/index.cjs");
 var _constants = require("../../constants/index.cjs");
+var _cache = require("../../cache/index.cjs");
 const MAX_PER_PAGE = 100;
 const getProductById = exports.getProductById = async function getProductById2(options, {
   bapiClient,
@@ -14,7 +15,8 @@ const getProductById = exports.getProductById = async function getProductById2(o
   withParams
 }) {
   return await cached(bapiClient.products.getById, {
-    cacheKeyPrefix: `getById-product-${options.id}`
+    cacheKeyPrefix: `getById-product-${options.id}`,
+    ttl: 5 * _cache.MINUTE
   })(options.id, {
     with: options.with ?? withParams?.product ?? _constants.MIN_WITH_PARAMS_PRODUCT,
     campaignKey,
@@ -29,7 +31,8 @@ const getProductsByIds = exports.getProductsByIds = async function getProductsBy
   withParams
 }) {
   return await cached(bapiClient.products.getByIds, {
-    cacheKeyPrefix: "getByIds-products"
+    cacheKeyPrefix: "getByIds-products",
+    ttl: 5 * _cache.MINUTE
   })(options.ids, {
     with: options.with ?? withParams?.product ?? _constants.MIN_WITH_PARAMS_PRODUCT,
     campaignKey,
@@ -74,6 +77,7 @@ const getProductsByCategory = exports.getProductsByCategory = async function get
     pagination
   } = await cached(bapiClient.products.query, {
     ...cache,
+    ttl: 15 * _cache.MINUTE,
     cacheKeyPrefix: `products-query-category-${category === "/" ? "root" : category}`
   })({
     where: {
@@ -155,6 +159,7 @@ const getFilters = exports.getFilters = async function getFilters2({
     including: includedFilters,
     orFiltersOperator
   }), cached(bapiClient.products.query, {
+    ttl: 15 * _cache.MINUTE,
     cacheKeyPrefix: `products-query-category-${category === "/" ? "root" : category}`
   })({
     where: {
@@ -220,6 +225,7 @@ const getProductsCount = exports.getProductsCount = async function getProductsCo
     })(sanitizedPath);
   }
   const productCount = await cached(bapiClient.products.query, {
+    ttl: 15 * _cache.MINUTE,
     cacheKeyPrefix: "products-query"
   })({
     where: {

package/dist/rpc/methods/products.mjs

@@ -1,9 +1,11 @@
 import { splitAndRemoveEmpty } from "../../helpers/index.mjs";
 import { MIN_WITH_PARAMS_PRODUCT } from "../../constants/index.mjs";
+import { MINUTE } from "../../cache/index.mjs";
 const MAX_PER_PAGE = 100;
 export const getProductById = async function getProductById2(options, { bapiClient, cached, campaignKey, withParams }) {
   return await cached(bapiClient.products.getById, {
-    cacheKeyPrefix: `getById-product-${options.id}`
+    cacheKeyPrefix: `getById-product-${options.id}`,
+    ttl: 5 * MINUTE
   })(options.id, {
     with: options.with ?? withParams?.product ?? MIN_WITH_PARAMS_PRODUCT,
     campaignKey,
@@ -13,7 +15,8 @@ export const getProductById = async function getProductById2(options, { bapiClie
 };
 export const getProductsByIds = async function getProductsByIds2(options, { bapiClient, cached, campaignKey, withParams }) {
   return await cached(bapiClient.products.getByIds, {
-    cacheKeyPrefix: "getByIds-products"
+    cacheKeyPrefix: "getByIds-products",
+    ttl: 5 * MINUTE
   })(options.ids, {
     with: options.with ?? withParams?.product ?? MIN_WITH_PARAMS_PRODUCT,
     campaignKey,
@@ -49,6 +52,7 @@ export const getProductsByCategory = async function getProductsByCategory2({
     bapiClient.products.query,
     {
       ...cache,
+      ttl: 15 * MINUTE,
       cacheKeyPrefix: `products-query-category-${category === "/" ? "root" : category}`
     }
   )({
@@ -128,6 +132,7 @@ export const getFilters = async function getFilters2({
       orFiltersOperator
     }),
     cached(bapiClient.products.query, {
+      ttl: 15 * MINUTE,
       cacheKeyPrefix: `products-query-category-${category === "/" ? "root" : category}`
     })({
       where: {
@@ -184,6 +189,7 @@ export const getProductsCount = async function getProductsCount2({
     })(sanitizedPath);
   }
   const productCount = await cached(bapiClient.products.query, {
+    ttl: 15 * MINUTE,
     cacheKeyPrefix: "products-query"
   })({
     where: {

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

@@ -69,4 +69,14 @@ export interface Oauth {
     access_token: string;
     refresh_token: string;
 }
+/**
+ * This adds `string` so it's flexible enough to support
+ * multiple IDPs since we don't know what they are.
+ * More narrow type can be defined in the nuxt modules.
+ */
+export interface IDPConfig {
+    enabled: boolean;
+    idpKeys: string[];
+    idpRedirectURL: string;
+}
 export {};

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

@@ -3,7 +3,7 @@ import { Log } from '../../utils';
 import { CachedType } from '../../cache/cached';
 import { ShopUser } from '../user';
 import type { WishlistWithOptions, BasketWithOptions, ProductWith, VariantWith, SearchWith, CategoryWith, ProductCategoryWith } from '../';
-import { OAuthTokens } from './auth';
+import { OAuthTokens, IDPConfig } from './auth';
 export type WithParams = Partial<{
     basket: BasketWithOptions;
     wishlist: WishlistWithOptions;
@@ -62,4 +62,5 @@ export interface RpcContext {
         clientSecret: string;
     };
     runtimeConfiguration: RuntimeConfiguration;
+    idp?: IDPConfig;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scayle/storefront-core",
-  "version": "7.32.0",
+  "version": "7.34.0",
   "description": "Collection of essential utilities to work with the Storefront API",
   "author": "SCAYLE Commerce Engine",
   "license": "MIT",
@@ -40,6 +40,7 @@
     "dist",
     "utils"
   ],
+  "type": "module",
   "engines": {
     "node": ">= 18.15.0"
   },
@@ -52,8 +53,9 @@
     "lint": "eslint . --format gitlab",
     "lint:fix": "eslint . --fix",
     "package:lint": "publint",
-    "test": "jest --passWithNoTests --maxWorkers=50%",
-    "test:ci": "jest --passWithNoTests --runInBand --coverage --reporters=default --reporters=jest-junit"
+    "test:watch": "vitest --passWithNoTests",
+    "test": "vitest --run --passWithNoTests",
+    "test:ci": "vitest --run --passWithNoTests --coverage --reporter=default --reporter=junit"
   },
   "dependencies": {
     "@aboutyou/backbone": "16.0.1",
@@ -69,21 +71,19 @@
     "@scayle/eslint-config-storefront": "3.2.6",
     "@scayle/prettier-config-storefront": "2.0.2",
     "@types/crypto-js": "4.2.1",
-    "@types/jest": "29.5.11",
     "@types/node": "20.10.5",
     "@types/webpack-env": "1.18.4",
-    "unbuild": "2.0.0",
+    "@vitest/coverage-v8": "1.1.0",
     "eslint": "8.56.0",
     "eslint-formatter-gitlab": "5.1.0",
-    "jest": "29.7.0",
-    "jest-junit": "16.0.0",
     "prettier": "3.0.0",
     "publint": "0.2.6",
     "rimraf": "5.0.5",
-    "ts-jest": "29.1.1",
     "ts-node": "10.9.2",
     "typescript": "5.3.3",
-    "unstorage": "1.10.1"
+    "unbuild": "2.0.0",
+    "unstorage": "1.10.1",
+    "vitest": "1.1.0"
   },
   "optionalDependencies": {
     "redis": "4"