feat: update based on initial feedback

supertokens · Jan 15, 2025 · b1f72d2 · b1f72d2
1 parent ffca670
commit b1f72d2
Show file tree

Hide file tree

Showing 7 changed files with 79 additions and 19 deletions.
diff --git a/lib/build/supertokens.js b/lib/build/supertokens.js
diff --git a/lib/build/types.d.ts b/lib/build/types.d.ts
diff --git a/lib/build/utils.d.ts b/lib/build/utils.d.ts
diff --git a/lib/ts/supertokens.ts b/lib/ts/supertokens.ts
@@ -13,7 +13,15 @@
  * under the License.
  */
 
-import { TypeInput, NormalisedAppinfo, HTTPMethod, SuperTokensInfo, UserContext, PluginRouteHandler } from "./types";
+import {
+    TypeInput,
+    NormalisedAppinfo,
+    HTTPMethod,
+    SuperTokensInfo,
+    UserContext,
+    PluginRouteHandler,
+    SuperTokensPlugin,
+} from "./types";
 import {
     normaliseInputAppInfoOrThrowError,
     maxVersion,
@@ -53,18 +61,35 @@ export default class SuperTokens {
     telemetryEnabled: boolean;
 
     constructor(config: TypeInput) {
-        const pluginList = config.plugins ?? [];
+        const inputPluginList = config.plugins ?? [];
         this.pluginRouteHandlers = [];
-        for (const plugin of pluginList) {
-            const versionContraints = Array.isArray(plugin.sdkVersion) ? plugin.sdkVersion : [plugin.sdkVersion];
+        const finalPluginList: SuperTokensPlugin[] = [];
+        for (const plugin of inputPluginList) {
+            const versionContraints = Array.isArray(plugin.compatibleSDKVersions)
+                ? plugin.compatibleSDKVersions
+                : [plugin.compatibleSDKVersions];
             if (!versionContraints.includes(version)) {
                 // TODO: better checks
                 throw new Error("Plugin version mismatch");
             }
+            if (plugin.dependencies) {
+                const result = plugin.dependencies(finalPluginList, version);
+                if (result.status === "ERROR") {
+                    throw new Error(result.message);
+                }
+                if (result.pluginsToAdd) {
+                    finalPluginList.push(...result.pluginsToAdd);
+                }
+                finalPluginList.push(plugin);
+            }
+        }
+
+        for (const plugin of finalPluginList) {
             if (plugin.routeHandlers) {
                 this.pluginRouteHandlers.push(...plugin.routeHandlers);
             }
         }
+
         if (config.debug === true) {
             enableDebugLogs();
         }
@@ -138,7 +163,9 @@ export default class SuperTokens {
             const recipeModule = func(
                 this.appInfo,
                 this.isInServerlessEnv,
-                pluginList.map((p) => p.overrideMap)
+                finalPluginList.filter((p) => p.overrideMap !== undefined).map((p) => p.overrideMap) as NonNullable<
+                    SuperTokensPlugin["overrideMap"]
+                >[]
             );
             if (recipeModule.getRecipeId() === MultitenancyRecipe.RECIPE_ID) {
                 multitenancyFound = true;

diff --git a/lib/ts/types.ts b/lib/ts/types.ts
@@ -117,9 +117,14 @@ export type PluginRouteHandler = {
 };
 
 export type SuperTokensPlugin = {
-    id: string;
-    sdkVersion: string | string[]; // match the syntax of the engines field in package.json
-    overrideMap: {
+    id: string; // TODO: validate that no two plugins have the same id
+    version?: string;
+    compatibleSDKVersions?: string | string[]; // match the syntax of the engines field in package.json
+    dependencies?: (
+        pluginsAbove: SuperTokensPlugin[],
+        sdkVersion: string
+    ) => { status: "OK"; pluginsToAdd?: SuperTokensPlugin[] } | { status: "ERROR"; message: string };
+    overrideMap?: {
         [recipeId in keyof AllRecipeConfigs]?: RecipePluginOverride<recipeId> & {
             recipeInitRequired?: boolean | ((sdkVersion: string) => boolean);
         };
@@ -151,7 +156,7 @@ export interface HttpRequest {
 export type RecipeListFunction = (
     appInfo: NormalisedAppinfo,
     isInServerlessEnv: boolean,
-    overrideMaps?: SuperTokensPlugin["overrideMap"][]
+    overrideMaps?: NonNullable<SuperTokensPlugin["overrideMap"]>[]
 ) => RecipeModule;
 
 export type APIHandled = {

diff --git a/lib/ts/utils.ts b/lib/ts/utils.ts
@@ -525,7 +525,7 @@ export const isBuffer = (obj: any): boolean => {
 export function applyPlugins<T extends keyof AllRecipeConfigs>(
     recipeId: T,
     config: AllRecipeConfigs[T] | undefined,
-    plugins: SuperTokensPlugin["overrideMap"][]
+    plugins: NonNullable<SuperTokensPlugin["overrideMap"]>[]
 ): AllRecipeConfigs[T] {
     config = config ?? ({} as AllRecipeConfigs[T]);
     let functionLayers = [config.override?.functions];

diff --git a/test/with-typescript/index.ts b/test/with-typescript/index.ts
@@ -2317,7 +2317,7 @@ Supertokens.init({
     plugins: [
         {
             id: "asdf",
-            sdkVersion: "1.2.3",
+            compatibleSDKVersions: "1.2.3",
             overrideMap: {
                 emailpassword: {
                     id: "emailpassword",