added support for export and init to plugins

Author: niftyvictor

lib/build/genericComponentOverrideContext.js

@@ -32,6 +32,7 @@ import {
     getDefaultCookieScope,
     getNormalisedUserContext,
     getOriginOfPage,
+    getPublicPlugin,
     getTenantIdFromQueryParams,
     isTest,
     normaliseCookieScopeOrThrowError,
@@ -56,6 +57,7 @@ import type {
     SuperTokensPlugin,
     AllRecipeConfigs,
     PluginRouteHandler,
+    SuperTokensPublicPlugin,
 } from "./types";
 
 /*
@@ -73,6 +75,8 @@ export default class SuperTokens {
      * Instance Attributes.
      */
     appInfo: NormalisedAppInfo;
+    // give access to plugins through the instance
+    pluginList: SuperTokensPublicPlugin[] = [];
     languageTranslations: {
         defaultLanguage: string;
         userTranslationStore: TranslationStore;
@@ -119,8 +123,28 @@ export default class SuperTokens {
                 ...(this.componentOverrides.authRecipe ?? {}),
                 ...(plugin.generalAuthRecipeComponentOverrides ?? {}),
             };
-            if (plugin.routeHandlers) {
-                this.pluginRouteHandlers.push(...plugin.routeHandlers);
+        }
+
+        this.pluginList = plugins.map(getPublicPlugin);
+
+        // iterated separately so we can pass the instance plugins  as reference so they always have access to the latest
+        for (let pluginIndex = 0; pluginIndex < this.pluginList.length; pluginIndex += 1) {
+            const pluginInit = plugins[pluginIndex].init;
+
+            if (pluginInit && !this.pluginList[pluginIndex].initialized) {
+                PostSuperTokensInitCallbacks.addPostInitCallback(() => {
+                    pluginInit(config, this.pluginList, package_version);
+                    this.pluginList[pluginIndex].initialized = true;
+                });
+            }
+
+            const pluginRouteHandlers = plugins[pluginIndex].routeHandlers;
+            if (pluginRouteHandlers) {
+                const result = pluginRouteHandlers(config, this.pluginList, package_version);
+                if (result.status === "ERROR") {
+                    throw new Error(result.message);
+                }
+                this.pluginRouteHandlers.push(...result.routeHandlers);
             }
         }
 

lib/build/superTokens.d.ts

@@ -528,8 +528,13 @@ export type SuperTokensPlugin = {
     version?: string;
     compatibleAuthReactSDKVersions?: string | string[]; // match the syntax of the engines field in package.json
     compatibleWebJSSDKVersions?: string | string[]; // match the syntax of the engines field in package.json
+    init?: (
+        config: Omit<SuperTokensConfig, "experimental" | "recipeList">,
+        allPlugins: Pick<SuperTokensPlugin, "id" | "version" | "exports">[],
+        sdkVersion: string
+    ) => Promise<void> | void;
     dependencies?: (
-        pluginsAbove: Pick<SuperTokensPlugin, "id" | "version">[],
+        pluginsAbove: Pick<SuperTokensPlugin, "id" | "version" | "exports">[],
         sdkVersion: string
     ) => { status: "OK"; pluginsToAdd?: SuperTokensPlugin[] } | { status: "ERROR"; message: string };
     overrideMap?: {
@@ -538,8 +543,18 @@ export type SuperTokensPlugin = {
         };
     };
     generalAuthRecipeComponentOverrides?: AuthRecipeComponentOverrideMap;
-    routeHandlers?: PluginRouteHandler[];
+    routeHandlers?: (
+        config: Omit<SuperTokensConfig, "experimental" | "recipeList">,
+        allPlugins: Pick<SuperTokensPlugin, "id" | "version" | "exports">[],
+        sdkVersion: string
+    ) => { status: "OK"; routeHandlers: PluginRouteHandler[] } | { status: "ERROR"; message: string };
     config?: (
         config: Omit<SuperTokensConfig, "experimental" | "recipeList">
     ) => Omit<SuperTokensConfig, "experimental" | "recipeList"> | undefined;
+    exports?: Record<string, any>;
 };
+
+export type SuperTokensPublicPlugin = Pick<
+    SuperTokensPlugin,
+    "id" | "version" | "exports" | "compatibleAuthReactSDKVersions" | "compatibleWebJSSDKVersions"
+> & { initialized: boolean };

lib/build/types.d.ts

@@ -34,6 +34,8 @@ import type {
     NormalisedAppInfo,
     NormalisedFormField,
     NormalisedGetRedirectionURLContext,
+    SuperTokensPlugin,
+    SuperTokensPublicPlugin,
     UserContext,
 } from "./types";
 
@@ -553,3 +555,14 @@ export function useRethrowInRender() {
 
     return setError;
 }
+
+export function getPublicPlugin(plugin: SuperTokensPlugin): SuperTokensPublicPlugin {
+    return {
+        id: plugin.id,
+        initialized: plugin.init ? false : true, // since the init method is optional, we default to true
+        version: plugin.version,
+        exports: plugin.exports,
+        compatibleAuthReactSDKVersions: plugin.compatibleAuthReactSDKVersions,
+        compatibleWebJSSDKVersions: plugin.compatibleWebJSSDKVersions,
+    };
+}