Mark middlewares as depreacted (#397)

* Mark `middleware`s as depreacted

* Add changeset

Author: witoszekdev

.changeset/witty-carrots-occur.md

@@ -0,0 +1,5 @@
+---
+"@saleor/app-sdk": patch
+---
+
+Marked `/middleware`s as deprecated in favor of `/handlers`

src/middleware/middleware-debug.ts

@@ -9,6 +9,8 @@ type DebugFactory = (handlerName: string) => (msg: string, ...args: unknown[]) =
 
 /**
  * Experimental. Needs to be tested and evaluated on security
+ *
+ * @depreacted Use `/handlers` instead of middlewares
  */
 export const withReqResDebugging =
   (debugFactory: DebugFactory = createMiddlewareDebug): Middleware =>

src/middleware/with-auth-token-required.ts

@@ -5,6 +5,9 @@ import { createMiddlewareDebug } from "./middleware-debug";
 
 const debug = createMiddlewareDebug("withAuthTokenRequired");
 
+/**
+ * @deprecated Use `/handlers` instead of middlewares
+ * */
 export const withAuthTokenRequired: Middleware = (handler) => async (request) => {
   debug("Middleware called");
 

src/middleware/with-base-url.ts

@@ -5,6 +5,9 @@ import { createMiddlewareDebug } from "./middleware-debug";
 
 const debug = createMiddlewareDebug("withBaseURL");
 
+/**
+ * @deprecated Use `/handlers` instead of middlewares
+ * */
 export const withBaseURL: Middleware = (handler) => async (request) => {
   const { host, "x-forwarded-proto": protocol = "http" } = request.headers;
 

src/middleware/with-jwt-verified.ts

@@ -15,6 +15,9 @@ export interface DashboardTokenPayload extends jose.JWTPayload {
 
 const ERROR_MESSAGE = "JWT verification failed:";
 
+/**
+ * @deprecated Use `/handlers` instead of middlewares
+ * */
 export const withJWTVerified =
   (getAppId: (request: Request) => Promise<string | undefined>): Middleware =>
   (handler) =>

src/middleware/with-registered-saleor-domain-header.ts

@@ -7,6 +7,9 @@ import { getSaleorAppFromRequest } from "./with-saleor-app";
 
 const debug = createMiddlewareDebug("withRegisteredSaleorDomainHeader");
 
+/**
+ * @deprecated Use `/handlers` instead of middlewares
+ * */
 export const withRegisteredSaleorDomainHeader: Middleware = (handler) => async (request) => {
   const { saleorApiUrl } = getSaleorHeaders(request.headers);
 

src/middleware/with-saleor-app.ts

@@ -5,6 +5,9 @@ import { createMiddlewareDebug } from "./middleware-debug";
 
 const debug = createMiddlewareDebug("withSaleorApp");
 
+/**
+ * @deprecated Use `/handlers` instead of middlewares
+ * */
 export const withSaleorApp =
   (saleorApp: SaleorApp): Middleware =>
   (handler) =>

src/middleware/with-saleor-event-match.ts

@@ -6,6 +6,9 @@ import { createMiddlewareDebug } from "./middleware-debug";
 
 const debug = createMiddlewareDebug("withSaleorEventMatch");
 
+/**
+ * @deprecated Use `/handlers` instead of middlewares
+ * */
 export const withSaleorEventMatch =
   <E extends string>(expectedEvent: `${Lowercase<E>}`): Middleware =>
   (handler) =>

src/middleware/with-webhook-signature-verified.ts

@@ -12,8 +12,8 @@ const debug = createMiddlewareDebug("withWebhookSignatureVerified");
 const ERROR_MESSAGE = "Webhook signature verification failed:";
 
 /**
- * TODO: Add test
- */
+ * @deprecated Use `/handlers` instead of middlewares
+ * */
 export const withWebhookSignatureVerified =
   (secretKey: string | undefined = undefined): Middleware =>
   (handler) =>