Refactor handlers, remove deprecated exports, v1 (#399)

* Simplify tsconfig, add aliases

* Refactor handlers/next -> handlers/platform/next

* Fix imports

* Move to shared

* Fix vitest config

* Fix failing tests due to change in aliases

* Add missing shared files

* Move sync-webhook response builder

* Refactor commonly used types to shared folder

* Add deprecated exports notes, add index file

* Export shared folder

* Fix broken build

* Fix broken build

* Remove re-exports for compatibility

* Make `schemaVersion` required, remove alpha note, combine files

* Fix imports

Author: witoszekdev

README.md

@@ -8,19 +8,15 @@
 
 SDK for building [Saleor Apps](https://github.com/saleor/apps).
 
+Supports Saleor version 3.20+
+
 <div>
 
 [![npm version badge](https://img.shields.io/npm/v/@saleor/app-sdk)](https://www.npmjs.com/package/@saleor/app-sdk)
 [![npm downloads count](https://img.shields.io/npm/dt/@saleor/app-sdk)](https://www.npmjs.com/package/@saleor/app-sdk)
 
 </div>
 
-## 🚨 Alpha phase
-
-App SDK is in the early stage at the moment. Every API below 1.x.x release is likely to change.
-
-Feel free to play with SDK and move its code directly to your app.
-
 ## Release flow
 
 - The `main` branch is a current, latest branch.

package.json

@@ -84,6 +84,7 @@
     "typescript": "4.9.5",
     "vi-fetch": "^0.8.0",
     "vite": "6.0.11 ",
+    "vite-tsconfig-paths": "^5.1.4",
     "vitest": "3.0.4"
   },
   "peerDependenciesMeta": {
@@ -150,6 +151,11 @@
       "import": "./handlers/next/index.mjs",
       "require": "./handlers/next/index.js"
     },
+    "./handlers/shared": {
+      "types": "./handlers/shared/index.d.ts",
+      "import": "./handlers/shared/index.mjs",
+      "require": "./handlers/shared/index.js"
+    },
     "./saleor-app": {
       "types": "./saleor-app.d.ts",
       "import": "./saleor-app.mjs",

pnpm-lock.yaml

@@ -1,20 +1,20 @@
 import { createMocks } from "node-mocks-http";
 import { beforeEach, describe, expect, it, Mock, vi } from "vitest";
 
-import { APL, AuthData } from "../../APL";
-import { MockAPL } from "../../test-utils/mock-apl";
+import { APL, AuthData } from "@/APL";
+import * as fetchRemoteJwksModule from "@/fetch-remote-jwks";
+import * as getAppIdModule from "@/get-app-id";
+import { MockAPL } from "@/test-utils/mock-apl";
+
 import { createAppRegisterHandler } from "./create-app-register-handler";
 
 const mockJwksValue = "{}";
 const mockAppId = "42";
 
-vi.mock("../../get-app-id", () => ({
-  getAppId: vi.fn().mockResolvedValue("42"), // can't use var reference, due to hoisting
-}));
-
-vi.mock("../../fetch-remote-jwks", () => ({
-  fetchRemoteJwks: vi.fn().mockResolvedValue("{}"), // can't use var reference, due to hoisting
-}));
+// Cannot use vi.mock on module, due to issues with alias resolution
+// in vitest vs TypeScript: https://github.com/vitest-dev/vitest/issues/3105
+vi.spyOn(fetchRemoteJwksModule, "fetchRemoteJwks").mockResolvedValue("{}");
+vi.spyOn(getAppIdModule, "getAppId").mockResolvedValue("42");
 
 describe("create-app-register-handler", () => {
   let mockApl: APL;

src/handlers/next/create-manifest-handler.ts

@@ -3,22 +3,18 @@ import { toNextHandler } from "retes/adapter";
 import { withMethod } from "retes/middleware";
 import { Response } from "retes/response";
 
-import { AuthData } from "../../APL";
-import { SALEOR_API_URL_HEADER } from "../../const";
-import { createDebug } from "../../debug";
-import { fetchRemoteJwks } from "../../fetch-remote-jwks";
-import { getAppId } from "../../get-app-id";
-import { withAuthTokenRequired } from "../../middleware";
-import { HasAPL } from "../../saleor-app";
-import { validateAllowSaleorUrls } from "./validate-allow-saleor-urls";
+import { AuthData } from "@/APL";
+import { SALEOR_API_URL_HEADER } from "@/const";
+import { createDebug } from "@/debug";
+import { fetchRemoteJwks } from "@/fetch-remote-jwks";
+import { getAppId } from "@/get-app-id";
+import { HookCallbackErrorParams } from "@/handlers/shared/create-app-register-handler-types";
+import { validateAllowSaleorUrls } from "@/handlers/shared/validate-allow-saleor-urls";
+import { withAuthTokenRequired } from "@/middleware";
+import { HasAPL } from "@/saleor-app";
 
 const debug = createDebug("createAppRegisterHandler");
 
-type HookCallbackErrorParams = {
-  status?: number;
-  message?: string;
-};
-
 class RegisterCallbackError extends Error {
   public status = 500;
 

src/handlers/next/create-protected-handler.ts

@@ -1,7 +1,8 @@
 import { createMocks } from "node-mocks-http";
 import { describe, expect, it } from "vitest";
 
-import { AppManifest } from "../../types";
+import { AppManifest } from "@/types";
+
 import { createManifestHandler } from "./create-manifest-handler";
 
 describe("createManifestHandler", () => {

src/handlers/next/create-app-register-handler.test.ts src/handlers/platforms/next/create-app-register-handler.test.ts

@@ -0,0 +1,48 @@
+import { NextApiHandler, NextApiRequest } from "next";
+
+import { createDebug } from "@/debug";
+import { getBaseUrl, getSaleorHeaders } from "@/headers";
+import { AppManifest } from "@/types";
+
+export type CreateManifestHandlerOptions = {
+  manifestFactory(context: {
+    appBaseUrl: string;
+    request: NextApiRequest;
+    /** For Saleor < 3.15 it will be null. */
+    schemaVersion: number | null;
+  }): AppManifest | Promise<AppManifest>;
+};
+
+const debug = createDebug("create-manifest-handler");
+
+/**
+ * Creates API handler for Next.js. Helps with Manifest creation, hides
+ * implementation details if possible
+ * In the future this will be extracted to separate sdk/next package
+ */
+export const createManifestHandler =
+  (options: CreateManifestHandlerOptions): NextApiHandler =>
+    async (request, response) => {
+      const { schemaVersion } = getSaleorHeaders(request.headers);
+      const baseURL = getBaseUrl(request.headers);
+
+      debug("Received request with schema version \"%s\" and base URL \"%s\"", schemaVersion, baseURL);
+
+      try {
+        const manifest = await options.manifestFactory({
+          appBaseUrl: baseURL,
+          request,
+          schemaVersion,
+        });
+
+        debug("Executed manifest file");
+
+        return response.status(200).json(manifest);
+      } catch (e) {
+        debug("Error while resolving manifest: %O", e);
+
+        return response.status(500).json({
+          message: "Error resolving manifest file",
+        });
+      }
+    };