@scayle/storefront-core 8.29.0 → 8.30.1

package/CHANGELOG.md

@@ -1,5 +1,51 @@
 # @scayle/storefront-core
 
+## 8.30.1
+
+### Patch Changes
+
+**Dependencies**
+
+- Updated dependency to @scayle/unstorage-scayle-kv-driver@1.0.2
+
+## 8.30.0
+
+### Minor Changes
+
+- Added `defineRpcHandler` utility function that enhances RPC handlers with type-safe metadata for improved registration and invocation of RPC handlers. While defining RPC handlers without this utility remains supported, its usage is recommended and may become mandatory in a future major release.
+
+  Existing RPC handlers can be easily migrated to use `defineRpcHandler` by passing the existing handler to `defineRpcHandler`.
+
+  ```ts
+  export const existingHandlerWithoutParams = async (_context: RpcContext) => {
+    return 'existing handler'
+  }
+
+  export const existingHandlerWithParams = async (
+    { name }: { name: string },
+    _context: RpcContext,
+  ) => {
+    return name
+  }
+
+  // will become
+
+  export const existingHandlerWithoutParams = defineRpcHandler(
+    async (_context: RpcContext) => {
+      return 'existing handler'
+    },
+  )
+  export const existingHandlerWithParams = defineRpcHandler(
+    async ({ name }: { name: string }, _context: RpcContext) => {
+      return name
+    },
+  )
+  ```
+
+### Patch Changes
+
+- Removed unused `Awaited` and `PromiseReturnType` types.
+
 ## 8.29.0
 
 ### Minor Changes

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

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

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

@@ -2,16 +2,24 @@ import type { RpcContext } from './context';
 /**
  * Type for an RPC handler that accepts parameters.
  *
+ * @note In the upcoming major release `rpcType` property will be mandatory.
+ *
  * @template Params The type of the parameters object.
  * @template ResponseType The type of the response.
  */
-export type ParamRpcHandler<Params extends Record<string, any>, ResponseType> = (params: Params, context: RpcContext) => Promise<(ResponseType extends undefined ? void : ResponseType) | Response> | ResponseType | Response;
+export type ParamRpcHandler<Params extends Record<string, any>, ResponseType> = ((params: Params, context: RpcContext) => Promise<(ResponseType extends undefined ? void : ResponseType) | Response> | ResponseType | Response) & {
+    rpcType?: 'WithParam';
+};
 /**
  * Type for an RPC handler that does not accept parameters.
  *
+ * @note In the upcoming major release `rpcType` property will be mandatory.
+ *
  * @template ResponseType The type of the response.
  */
-export type NoParamRpcHandler<ResponseType> = (context: RpcContext) => Promise<ResponseType | Response> | ResponseType | Response;
+export type NoParamRpcHandler<ResponseType> = ((context: RpcContext) => Promise<ResponseType | Response> | ResponseType | Response) & {
+    rpcType?: 'NoParam';
+};
 /**
  * Generic RPC handler type. Handles both cases with and without parameters.
  *

package/dist/types/index.d.ts

@@ -1,4 +1,3 @@
-export * from './promises';
 export * from './user';
 export * from './breadcrumb';
 export * from './api/rpc';

package/dist/types/index.mjs

@@ -1,4 +1,3 @@
-export * from "./promises.mjs";
 export * from "./user.mjs";
 export * from "./breadcrumb.mjs";
 export * from "./api/rpc.mjs";

package/dist/utils/index.d.ts

@@ -3,3 +3,4 @@ export * from './log';
 export * from './fetch';
 export * from './basket';
 export * from './campaign';
+export { defineRpcHandler } from './rpc';

package/dist/utils/index.mjs

@@ -3,3 +3,4 @@ export * from "./log.mjs";
 export * from "./fetch.mjs";
 export * from "./basket.mjs";
 export * from "./campaign.mjs";
+export { defineRpcHandler } from "./rpc.mjs";

package/dist/utils/rpc.d.ts

@@ -0,0 +1,27 @@
+import type { RpcMethods, RpcMethodName } from '..';
+import type { RpcContext, RpcHandler } from '../types';
+type RpcType = 'NoParam' | 'WithParam';
+/**
+ * Defines an RPC method handler.
+ *
+ * @param handler - The RPC handler function.
+ * @returns The handler itself, with correct types enforced and internal properties set.
+ */
+export declare function defineRpcHandler<Params extends Record<string, unknown>, Result = unknown>(handler: (params: Params, context: RpcContext) => Result | Promise<Result>): RpcHandler<Params, Result>;
+/**
+ * Defines an RPC method handler.
+ *
+ * @param handler - The RPC handler function.
+ * @returns The handler itself, with correct types enforced and internal properties set.
+ */
+export declare function defineRpcHandler<Result = unknown>(handler: (context: RpcContext) => Result | Promise<Result>): RpcHandler<Result>;
+/**
+ * Defines an RPC method handler.
+ *
+ * @param handler The RPC handler function.
+ * @returns The handler itself, with correct types enforced and internal properties set.
+ */
+export declare function defineRpcHandler<T extends RpcMethods[RpcMethodName]>(handler: T): T & {
+    rpcType: RpcType;
+};
+export {};

package/dist/utils/rpc.mjs

@@ -0,0 +1,5 @@
+export function defineRpcHandler(handler) {
+  const rpcType = handler.length === 1 ? "NoParam" : "WithParam";
+  const handlerWithType = Object.assign(handler, { rpcType });
+  return handlerWithType;
+}

package/dist/utils/sapi.d.ts

@@ -10,4 +10,4 @@
  *
  * @throws Re-throws any error that is not an instance of FetchError.
  */
-export declare function mapSAPIFetchErrorToResponse<T extends (...args: any) => any>(func: T): (...args: Parameters<T>) => Promise<Awaited<ReturnType<T>> | Response>;
+export declare function mapSAPIFetchErrorToResponse<T extends (...args: any[]) => any>(func: T): (...args: Parameters<T>) => Promise<Awaited<ReturnType<T>> | Response>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scayle/storefront-core",
-  "version": "8.29.0",
+  "version": "8.30.1",
   "description": "Collection of essential utilities to work with the Storefront API",
   "author": "SCAYLE Commerce Engine",
   "license": "MIT",
@@ -65,7 +65,7 @@
   },
   "dependencies": {
     "@scayle/storefront-api": "18.9.0",
-    "@scayle/unstorage-scayle-kv-driver": "1.0.1",
+    "@scayle/unstorage-scayle-kv-driver": "1.0.2",
     "crypto-js": "^4.2.0",
     "hookable": "^5.5.3",
     "jose": "^6.0.8",
@@ -75,11 +75,11 @@
     "utility-types": "^3.11.0"
   },
   "devDependencies": {
-    "@scayle/eslint-config-storefront": "4.5.5",
+    "@scayle/eslint-config-storefront": "4.5.7",
     "@types/crypto-js": "4.2.2",
     "@types/node": "22.15.32",
     "@types/webpack-env": "1.18.8",
-    "@vitest/coverage-v8": "3.2.3",
+    "@vitest/coverage-v8": "3.2.4",
     "dprint": "0.50.0",
     "eslint-formatter-gitlab": "6.0.1",
     "eslint": "9.29.0",
@@ -89,7 +89,7 @@
     "typescript": "5.8.3",
     "unbuild": "3.5.0",
     "unstorage": "1.16.0",
-    "vitest": "3.2.3"
+    "vitest": "3.2.4"
   },
   "volta": {
     "node": "22.16.0"

package/dist/types/promises.d.ts

@@ -1,12 +0,0 @@
-/**
- * Extracts the type resolved by a promise or promise-like value.
- *
- * @template T The input type, which can be a promise-like value.
- */
-export type Awaited<T> = T extends PromiseLike<infer U> ? Awaited<U> : T;
-/**
- * Extracts the return type of a promise-returning function, after the promise resolves.
- *
- * @template T The promise-returning function type.
- */
-export type PromiseReturnType<T extends (...args: any) => Promise<any>> = Awaited<ReturnType<T>>;