@scayle/storefront-core 7.28.2 → 7.30.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @scayle/storefront-core
 
+## 7.30.0
+
+### Minor Changes
+
+- Allow `null` values for `promotionId` within the basket payload
+
+## 7.29.0
+
+### Minor Changes
+
+- Remove basic `gzip` compression in custom `unstorage` caching interface in favor of custom `@scayle/unstorage-compression-driver`
+
 ## 7.28.2
 
 ### Patch Changes

package/dist/api/oauth.d.ts

@@ -16,19 +16,19 @@ export declare class OAuthClient {
      * Register a user and retrieve a token set
      * @param payload
      */
-    register(payload: RegisterRequest): Oauth;
+    register(payload: RegisterRequest): Promise<Oauth>;
     /**
      * Execute a user login on the OAuth API and receive a token set
      * @param payload
      */
     login(payload: LoginRequest & {
         shopId: string;
-    }): Oauth;
+    }): Promise<Oauth>;
     /**
      * Execute a guest user login on the OAuth API and receive a token set
      * @param payload
      */
-    guestLogin(payload: GuestRequest): Oauth;
+    guestLogin(payload: GuestRequest): Promise<Oauth>;
     /**
      * Send a password reset email
      * @param payload
@@ -38,7 +38,7 @@ export declare class OAuthClient {
      * Update password by hash
      * @param payload
      */
-    updatePasswordByHash(payload: UpdatePasswordByHashRequest): Oauth;
+    updatePasswordByHash(payload: UpdatePasswordByHashRequest): Promise<Oauth>;
     /**
      * Generate a new access token via a refresh token
      * @param payload

package/dist/cache/providers/unstorage.cjs

@@ -4,7 +4,6 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.UnstorageCache = void 0;
-var _compression = require("../../utils/compression.cjs");
 class UnstorageCache {
   storage;
   prefix;
@@ -17,7 +16,7 @@ class UnstorageCache {
     if (value === null) {
       return null;
     }
-    return typeof value === "string" ? this.deserialize(value) : value;
+    return value;
   }
   async has(key) {
     return await this.storage.hasItem(this.getKey(key));
@@ -38,8 +37,7 @@ class UnstorageCache {
     await Promise.all(keys.map(k => this.storage.removeItem(k)));
   }
   async set(key, value, ttl, tags = []) {
-    const _value = await this.serialize(value);
-    await this.storage.setItem(this.getKey(key), _value, {
+    await this.storage.setItem(this.getKey(key), value, {
       ttl
     });
     await Promise.all(tags.map(tag => this.addKeyToTag(tag, this.getKey(key))));
@@ -53,26 +51,5 @@ class UnstorageCache {
   getKey(key) {
     return [this.prefix, key].join(":");
   }
-  /**
-   * First iteration copied from `packages/storefront-core/src/cache/providers/redis.ts`
-   * @param value String to be deserialized and decompressed
-   */
-  async deserialize(value) {
-    try {
-      const data = await (0, _compression.decompress)(value);
-      return JSON.parse(data);
-    } catch (error) {
-      console.warn("UnstorageCache: Unable to decompress data", error);
-      return value;
-    }
-  }
-  /**
-   * First iteration copied from `packages/storefront-core/src/cache/providers/redis.ts`
-   * @param value String to be deserialized and decompressed
-   */
-  async serialize(value) {
-    const data = JSON.stringify(value);
-    return await (0, _compression.compress)(data);
-  }
 }
 exports.UnstorageCache = UnstorageCache;

package/dist/cache/providers/unstorage.d.ts

@@ -13,14 +13,4 @@ export declare class UnstorageCache implements CacheInterface {
     set(key: string, value: any, ttl: number, tags?: string[]): Promise<void>;
     private addKeyToTag;
     private getKey;
-    /**
-     * First iteration copied from `packages/storefront-core/src/cache/providers/redis.ts`
-     * @param value String to be deserialized and decompressed
-     */
-    private deserialize;
-    /**
-     * First iteration copied from `packages/storefront-core/src/cache/providers/redis.ts`
-     * @param value String to be deserialized and decompressed
-     */
-    private serialize;
 }

package/dist/cache/providers/unstorage.mjs

@@ -1,4 +1,3 @@
-import { compress, decompress } from "../../utils/compression.mjs";
 export class UnstorageCache {
   storage;
   prefix;
@@ -11,7 +10,7 @@ export class UnstorageCache {
     if (value === null) {
       return null;
     }
-    return typeof value === "string" ? this.deserialize(value) : value;
+    return value;
   }
   async has(key) {
     return await this.storage.hasItem(this.getKey(key));
@@ -32,8 +31,7 @@ export class UnstorageCache {
     await Promise.all(keys.map((k) => this.storage.removeItem(k)));
   }
   async set(key, value, ttl, tags = []) {
-    const _value = await this.serialize(value);
-    await this.storage.setItem(this.getKey(key), _value, { ttl });
+    await this.storage.setItem(this.getKey(key), value, { ttl });
     await Promise.all(
       tags.map((tag) => this.addKeyToTag(tag, this.getKey(key)))
     );
@@ -47,25 +45,4 @@ export class UnstorageCache {
   getKey(key) {
     return [this.prefix, key].join(":");
   }
-  /**
-   * First iteration copied from `packages/storefront-core/src/cache/providers/redis.ts`
-   * @param value String to be deserialized and decompressed
-   */
-  async deserialize(value) {
-    try {
-      const data = await decompress(value);
-      return JSON.parse(data);
-    } catch (error) {
-      console.warn("UnstorageCache: Unable to decompress data", error);
-      return value;
-    }
-  }
-  /**
-   * First iteration copied from `packages/storefront-core/src/cache/providers/redis.ts`
-   * @param value String to be deserialized and decompressed
-   */
-  async serialize(value) {
-    const data = JSON.stringify(value);
-    return await compress(data);
-  }
 }

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

@@ -13,7 +13,7 @@ export type AddOrUpdateItemType = {
     };
     itemGroup?: ItemGroup;
     includeItemsWithoutProductData?: boolean;
-    promotionId?: string;
+    promotionId?: string | null;
 };
 export interface BasketWithOptions extends BasketWith {
     pricePromotionKey?: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scayle/storefront-core",
-  "version": "7.28.2",
+  "version": "7.30.0",
   "description": "Collection of essential utilities to work with the Storefront API",
   "author": "SCAYLE Commerce Engine",
   "license": "MIT",
@@ -66,7 +66,7 @@
     "utility-types": "^3.10.0"
   },
   "devDependencies": {
-    "@scayle/eslint-config-storefront": "3.2.5",
+    "@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",
@@ -81,7 +81,7 @@
     "publint": "0.2.6",
     "rimraf": "5.0.5",
     "ts-jest": "29.1.1",
-    "ts-node": "10.9.1",
+    "ts-node": "10.9.2",
     "typescript": "5.3.3",
     "unstorage": "1.10.1"
   },