update apl exports

Author: lkostrowski

.changeset/long-mirrors-leave.md

@@ -0,0 +1,8 @@
+---
+"@saleor/app-sdk": major
+---
+
+### APL
+
+- `isReady` and `isConfigured` methods are now optional in the `APL` interface
+- All APL implementations are now exported from dedicated paths `@saleor/app-sdk/APL/*` where `*` is one of the implementations. Now tree shaking is available

package.json

@@ -115,6 +115,26 @@
       "import": "./APL/redis/index.mjs",
       "require": "./APL/redis/index.js"
     },
+    "./APL/env": {
+      "types": "./APL/env/index.d.ts",
+      "import": "./APL/env/index.mjs",
+      "require": "./APL/env/index.js"
+    },
+    "./APL/file": {
+      "types": "./APL/file/index.d.ts",
+      "import": "./APL/file/index.mjs",
+      "require": "./APL/file/index.js"
+    },
+    "./APL/upstash": {
+      "types": "./APL/upstash/index.d.ts",
+      "import": "./APL/upstash/index.mjs",
+      "require": "./APL/upstash/index.js"
+    },
+    "./APL/saleor-cloud": {
+      "types": "./APL/saleor-cloud/index.d.ts",
+      "import": "./APL/saleor-cloud/index.mjs",
+      "require": "./APL/saleor-cloud/index.js"
+    },
     "./APL/vercel-kv": {
       "types": "./APL/vercel-kv/index.d.ts",
       "import": "./APL/vercel-kv/index.mjs",

src/APL/apl.ts

@@ -31,6 +31,6 @@ export interface APL {
   /**
    * Inform that configuration is finished and correct
    */
-  isReady: () => Promise<AplReadyResult>;
-  isConfigured: () => Promise<AplConfiguredResult>;
+  isReady?: () => Promise<AplReadyResult>;
+  isConfigured?: () => Promise<AplConfiguredResult>;
 }

src/APL/auth-data-from-string.ts

@@ -1,6 +1,6 @@
 import { describe, expect, it, vi } from "vitest";
 
-import { AuthData } from "./apl";
+import { AuthData } from "../apl";
 import { EnvAPL } from "./env-apl";
 
 const getMockEnvVars = () => ({
@@ -27,7 +27,7 @@ describe("EnvAPL", () => {
           appId: envVars.SALEOR_APP_ID,
           saleorApiUrl: envVars.SALEOR_API_URL,
         },
-      })
+      }),
     ).toBeDefined();
   });
 
@@ -58,7 +58,7 @@ describe("EnvAPL", () => {
   "appId": "app-id",
   "token": "some-token",
   "jwks": "{}"
-}`
+}`,
     );
   });
 

src/APL/env-apl.test.ts src/APL/env/env-apl.test.ts

@@ -1,5 +1,5 @@
-import { APL, AuthData } from "./apl";
-import { createAPLDebug } from "./apl-debug";
+import { APL, AuthData } from "../apl";
+import { createAPLDebug } from "../apl-debug";
 
 const debug = createAPLDebug("EnvAPL");
 
@@ -25,7 +25,7 @@ export class EnvAPL implements APL {
     if (!this.isAuthDataValid(options.env)) {
       // eslint-disable-next-line no-console
       console.warn(
-        "EnvAPL constructor not filled with valid AuthData config. Try to install the app with \"printAuthDataOnRegister\" enabled and check console logs"
+        "EnvAPL constructor not filled with valid AuthData config. Try to install the app with \"printAuthDataOnRegister\" enabled and check console logs",
       );
     }
 
@@ -39,7 +39,7 @@ export class EnvAPL implements APL {
     const keysToValidateAgainst: Array<keyof AuthData> = ["appId", "saleorApiUrl", "token"];
 
     return keysToValidateAgainst.every(
-      (key) => authData[key] && typeof authData[key] === "string" && authData[key]!.length > 0
+      (key) => authData[key] && typeof authData[key] === "string" && authData[key]!.length > 0,
     );
   }
 
@@ -71,7 +71,7 @@ export class EnvAPL implements APL {
       // eslint-disable-next-line no-console
       console.log(JSON.stringify(authData, null, 2));
       console.warn(
-        "🛑'printAuthDataOnRegister' option should be turned off once APL is configured, to avoid possible leaks"
+        "🛑'printAuthDataOnRegister' option should be turned off once APL is configured, to avoid possible leaks",
       );
     }
     debug("Called set method");
@@ -85,7 +85,7 @@ export class EnvAPL implements APL {
 
     if (saleorApiUrl !== this.options.env.saleorApiUrl) {
       throw new Error(
-        `Requested AuthData for domain "${saleorApiUrl}", however APL is configured for ${this.options.env.saleorApiUrl}. You may trying to install app in invalid Saleor URL `
+        `Requested AuthData for domain "${saleorApiUrl}", however APL is configured for ${this.options.env.saleorApiUrl}. You may trying to install app in invalid Saleor URL `,
       );
     }
 

src/APL/env-apl.ts src/APL/env/env-apl.ts

@@ -0,0 +1 @@
+export * from "./env-apl";

src/APL/env/index.ts

@@ -1,7 +1,7 @@
 import { promises as fsPromises } from "fs";
 import { afterEach, describe, expect, it, vi } from "vitest";
 
-import { AuthData } from "./apl";
+import { AuthData } from "../apl";
 import { FileAPL } from "./file-apl";
 
 const stubAuthData: AuthData = {
@@ -39,7 +39,7 @@ describe("APL", () => {
             token: stubAuthData.token,
             saleorApiUrl: stubAuthData.saleorApiUrl,
             appId: stubAuthData.appId,
-          })
+          }),
         );
 
         const apl = new FileAPL();
@@ -69,7 +69,7 @@ describe("APL", () => {
         const apl = new FileAPL();
 
         await expect(apl.set(stubAuthData)).rejects.toThrow(
-          "File APL was unable to save auth data"
+          "File APL was unable to save auth data",
         );
         expect(spyWriteFile).toBeCalledWith(".saleor-app-auth.json", JSON.stringify(stubAuthData));
       });

src/APL/file-apl.test.ts src/APL/file/file-apl.test.ts

@@ -1,7 +1,7 @@
 import { promises as fsPromises } from "fs";
 
-import { APL, AplConfiguredResult, AplReadyResult, AuthData } from "./apl";
-import { createAPLDebug } from "./apl-debug";
+import { APL, AuthData } from "../apl";
+import { createAPLDebug } from "../apl-debug";
 
 const debug = createAPLDebug("FileAPL");
 
@@ -42,7 +42,7 @@ export class FileAPL implements APL {
     } catch (err) {
       debug(`Could not read auth data from the ${this.fileName} file`, err);
       debug(
-        "Maybe apl.get() was called before app was registered. Returning empty, fallback data (undefined)"
+        "Maybe apl.get() was called before app was registered. Returning empty, fallback data (undefined)",
       );
 
       return undefined;
@@ -113,26 +113,4 @@ export class FileAPL implements APL {
 
     return [authData];
   }
-
-  // eslint-disable-next-line class-methods-use-this
-  async isReady(): Promise<AplReadyResult> {
-    /**
-     * Assume FileAPL is just ready to use.
-     * Consider checking if directory is writable
-     */
-    return {
-      ready: true,
-    };
-  }
-
-  // eslint-disable-next-line class-methods-use-this
-  async isConfigured(): Promise<AplConfiguredResult> {
-    /**
-     * Assume FileAPL is just ready to use.
-     * Consider checking if directory is writable
-     */
-    return {
-      configured: true,
-    };
-  }
 }

src/APL/file-apl.ts src/APL/file/file-apl.ts

@@ -0,0 +1 @@
+export * from "./file-apl";

src/APL/file/index.ts

@@ -1,5 +1 @@
 export * from "./apl";
-export * from "./env-apl";
-export * from "./file-apl";
-export * from "./saleor-cloud";
-export * from "./upstash-apl";

src/APL/index.ts

@@ -3,7 +3,7 @@ import { SemanticAttributes } from "@opentelemetry/semantic-conventions";
 
 import { hasProp } from "../../has-prop";
 import { getOtelTracer, OTEL_APL_SERVICE_NAME } from "../../open-telemetry";
-import { APL, AplConfiguredResult, AplReadyResult, AuthData } from "../apl";
+import { APL, AuthData } from "../apl";
 import { createAPLDebug } from "../apl-debug";
 import { authDataFromObject } from "../auth-data-from-object";
 import { Paginator } from "./paginator";
@@ -42,7 +42,7 @@ const validateResponseStatus = (response: Response) => {
 
     throw new SaleorCloudAplError(
       CloudAplError.RESPONSE_NON_200,
-      `Fetch returned with non 200 status code ${response.status}`
+      `Fetch returned with non 200 status code ${response.status}`,
     );
   }
 };
@@ -170,7 +170,7 @@ export class SaleorCloudAPL implements APL {
 
           throw new SaleorCloudAplError(
             CloudAplError.FAILED_TO_REACH_API,
-            `${extractErrorMessage(error)}`
+            `${extractErrorMessage(error)}`,
           );
         });
 
@@ -187,7 +187,7 @@ export class SaleorCloudAPL implements APL {
 
           throw new SaleorCloudAplError(
             CloudAplError.FAILED_TO_REACH_API,
-            "Response couldn't be resolved"
+            "Response couldn't be resolved",
           );
         }
 
@@ -261,7 +261,7 @@ export class SaleorCloudAPL implements APL {
           .end();
 
         return authData;
-      }
+      },
     );
   }
 
@@ -296,7 +296,7 @@ export class SaleorCloudAPL implements APL {
 
           throw new SaleorCloudAplError(
             CloudAplError.ERROR_SAVING_DATA,
-            `Error during saving the data: ${extractErrorMessage(e)}`
+            `Error during saving the data: ${extractErrorMessage(e)}`,
           );
         });
 
@@ -312,7 +312,7 @@ export class SaleorCloudAPL implements APL {
         span.end();
 
         return undefined;
-      }
+      },
     );
   }
 
@@ -336,7 +336,7 @@ export class SaleorCloudAPL implements APL {
 
       throw new SaleorCloudAplError(
         CloudAplError.ERROR_DELETING_DATA,
-        `Error during deleting the data: ${errorMessage}`
+        `Error during deleting the data: ${errorMessage}`,
       );
     }
   }
@@ -360,31 +360,4 @@ export class SaleorCloudAPL implements APL {
 
     return [];
   }
-
-  async isReady(): Promise<AplReadyResult> {
-    const configured = await this.isConfigured();
-
-    return configured
-      ? {
-          ready: true,
-        }
-      : {
-          ready: false,
-          error: new Error("SaleorCloudAPL is not configured"),
-        };
-  }
-
-  async isConfigured(): Promise<AplConfiguredResult> {
-    if (!this.resourceUrl) {
-      debug("Resource URL has not been specified.");
-      return {
-        configured: false,
-        error: new Error("SaleorCloudAPL required resourceUrl param"),
-      };
-    }
-
-    return {
-      configured: true,
-    };
-  }
 }

src/APL/saleor-cloud/saleor-cloud-apl.ts

@@ -0,0 +1 @@
+export * from "./upstash-apl";

src/APL/upstash/index.ts

@@ -1,6 +1,6 @@
 import { afterEach, describe, expect, it, vi } from "vitest";
 
-import { AuthData } from "./apl";
+import { AuthData } from "../apl";
 import { UpstashAPL, UpstashAPLConfig, UpstashAPLVariables } from "./upstash-apl";
 
 const fetchMock = vi.fn();
@@ -62,7 +62,7 @@ describe("APL", () => {
               Authorization: "Bearer token",
             },
             method: "POST",
-          }
+          },
         );
       });
 
@@ -79,7 +79,7 @@ describe("APL", () => {
           restToken: "token",
         });
         await expect(apl.set(stubAuthData)).rejects.toThrow(
-          "Upstash APL was not able to perform operation. Status code: 401. Error: Unauthorized"
+          "Upstash APL was not able to perform operation. Status code: 401. Error: Unauthorized",
         );
       });
     });
@@ -138,7 +138,7 @@ describe("APL", () => {
         // @ts-ignore
         expect(result.error.message).toEqual(
           // eslint-disable-next-line quotes
-          'Configuration values for: "restToken", "restURL" not found or is empty. Pass values to constructor of use env variables.'
+          'Configuration values for: "restToken", "restURL" not found or is empty. Pass values to constructor of use env variables.',
         );
       });
     });