feat: enhance public config handling with normalized app info and improve types

Author: niftyvictor

lib/build/genericComponentOverrideContext.js

@@ -101,6 +101,7 @@ export default class SuperTokens {
      */
     constructor(config: SuperTokensConfig, plugins: SuperTokensPlugin[]) {
         this.appInfo = normaliseInputAppInfoOrThrowError(config.appInfo);
+
         if (config.recipeList === undefined || config.recipeList.length === 0) {
             throw new Error(
                 "Please provide at least one recipe to the supertokens.init function call. See https://supertokens.io/docs/emailpassword/quick-setup/frontend"
@@ -127,13 +128,16 @@ export default class SuperTokens {
 
         this.pluginList = plugins.map(getPublicPlugin);
 
+        const publicConfig = getPublicConfig({
+            ...config,
+            appInfo: this.appInfo,
+        });
         // 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(getPublicConfig(config), this.pluginList, package_version);
+                    pluginInit(publicConfig, this.pluginList, package_version);
                     this.pluginList[pluginIndex].initialized = true;
                 });
             }
@@ -142,7 +146,7 @@ export default class SuperTokens {
             if (pluginRouteHandlers) {
                 let handlers: PluginRouteHandler[] = [];
                 if (typeof pluginRouteHandlers === "function") {
-                    const result = pluginRouteHandlers(getPublicConfig(config), this.pluginList, package_version);
+                    const result = pluginRouteHandlers(publicConfig, this.pluginList, package_version);
                     if (result.status === "ERROR") {
                         throw new Error(result.message);
                     }
@@ -204,6 +208,12 @@ export default class SuperTokens {
                 ? config.recipeList
                 : config.recipeList.concat(Multitenancy.init({}));
 
+        const normalisedAppInfo = normaliseInputAppInfoOrThrowError(config.appInfo);
+        const publicConfig = getPublicConfig({
+            ...config,
+            appInfo: normalisedAppInfo,
+        });
+
         const finalPluginList: SuperTokensPlugin[] = [];
         if (config.experimental?.plugins) {
             for (const plugin of config.experimental.plugins) {
@@ -220,9 +230,10 @@ export default class SuperTokens {
                         );
                     }
                 }
+
                 if (plugin.dependencies) {
                     const result = plugin.dependencies(
-                        getPublicConfig(config),
+                        publicConfig,
                         finalPluginList.map(getPublicPlugin),
                         package_version
                     );
@@ -233,6 +244,7 @@ export default class SuperTokens {
                         finalPluginList.push(...result.pluginsToAdd);
                     }
                 }
+
                 finalPluginList.push(plugin);
             }
         }
@@ -246,10 +258,9 @@ export default class SuperTokens {
 
         for (const plugin of finalPluginList) {
             if (plugin.config) {
-                // prevent override of appInfo
-                // doing it like this because we don't want to override the appInfo and we can't make sure the plugin won't return it
-                // @ts-ignore
-                const { appInfo, ...pluginConfig } = plugin.config(getPublicConfig(config)) || {};
+                // @ts-ignore we don't want to override the appInfo and we can't make sure the plugin won't return it
+                const { appInfo, ...pluginConfig } =
+                    plugin.config(getPublicConfig({ ...config, appInfo: normalisedAppInfo })) || {};
 
                 config = { ...config, ...pluginConfig };
             }

lib/build/types.d.ts

@@ -547,6 +547,7 @@ export type SuperTokensPlugin = {
               sdkVersion: string
           ) => { status: "OK"; routeHandlers: PluginRouteHandler[] } | { status: "ERROR"; message: string })
         | PluginRouteHandler[];
+
     config?: (config: SuperTokensPublicConfig) => Omit<SuperTokensPublicConfig, "appInfo"> | undefined;
     exports?: Record<string, any>;
 };
@@ -555,9 +556,14 @@ export const nonPublicConfigProperties = ["experimental"] as const;
 
 export type NonPublicConfigPropertiesType = (typeof nonPublicConfigProperties)[number];
 
+export type SuperTokensConfigWithNormalisedAppInfo = Omit<SuperTokensConfig, "appInfo"> & {
+    appInfo: NormalisedAppInfo;
+};
 export type SuperTokensPublicPlugin = Pick<
     SuperTokensPlugin,
     "id" | "version" | "exports" | "compatibleAuthReactSDKVersions" | "compatibleWebJSSDKVersions"
 > & { initialized: boolean };
 
-export type SuperTokensPublicConfig = Omit<SuperTokensConfig, NonPublicConfigPropertiesType>;
+export type SuperTokensPublicConfig = Omit<Omit<SuperTokensConfig, NonPublicConfigPropertiesType>, "appInfo"> & {
+    appInfo: NormalisedAppInfo;
+};

lib/build/utils.d.ts

@@ -34,12 +34,12 @@ import type {
     NormalisedAppInfo,
     NormalisedFormField,
     NormalisedGetRedirectionURLContext,
-    SuperTokensConfig,
     SuperTokensPlugin,
     SuperTokensPublicConfig,
     SuperTokensPublicPlugin,
     UserContext,
     NonPublicConfigPropertiesType,
+    SuperTokensConfigWithNormalisedAppInfo,
 } from "./types";
 import { nonPublicConfigProperties } from "./types";
 
@@ -571,8 +571,8 @@ export function getPublicPlugin(plugin: SuperTokensPlugin): SuperTokensPublicPlu
     };
 }
 
-export function getPublicConfig(config: SuperTokensConfig): SuperTokensPublicConfig {
-    const configKeys = Object.keys(config) as (keyof SuperTokensConfig)[];
+export function getPublicConfig(config: SuperTokensConfigWithNormalisedAppInfo): SuperTokensPublicConfig {
+    const configKeys = Object.keys(config) as (keyof SuperTokensConfigWithNormalisedAppInfo)[];
 
     const publicConfig = configKeys.reduce((acc, key) => {
         if (nonPublicConfigProperties.includes(key as NonPublicConfigPropertiesType)) {
@@ -584,17 +584,3 @@ export function getPublicConfig(config: SuperTokensConfig): SuperTokensPublicCon
 
     return publicConfig;
 }
-
-export function getNonPublicConfig(config: SuperTokensConfig): Pick<SuperTokensConfig, NonPublicConfigPropertiesType> {
-    const configKeys = Object.keys(config) as (keyof SuperTokensConfig)[];
-
-    const publicConfig = configKeys.reduce((acc, key) => {
-        if (nonPublicConfigProperties.includes(key as NonPublicConfigPropertiesType)) {
-            return { ...acc, [key]: config[key] };
-        } else {
-            return acc;
-        }
-    }, {} as Pick<SuperTokensConfig, NonPublicConfigPropertiesType>);
-
-    return publicConfig;
-}