feat: mark plugins as experimental

supertokens · Feb 12, 2025 · 9fb6f3f · 9fb6f3f
1 parent e699f38
commit 9fb6f3f
Show file tree

Hide file tree

Showing 10 changed files with 93 additions and 66 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/version.d.ts b/lib/build/version.d.ts
diff --git a/lib/build/version.js b/lib/build/version.js
diff --git a/lib/ts/supertokens.ts b/lib/ts/supertokens.ts
@@ -63,7 +63,7 @@ export default class SuperTokens {
     telemetryEnabled: boolean;
 
     constructor(config: TypeInput) {
-        const inputPluginList = config.plugins ?? [];
+        const inputPluginList = config.experimental?.plugins ?? [];
         this.pluginRouteHandlers = [];
         const finalPluginList: SuperTokensPlugin[] = [];
         for (const plugin of inputPluginList) {

diff --git a/lib/ts/types.ts b/lib/ts/types.ts
@@ -145,7 +145,18 @@ export type TypeInput = {
     telemetry?: boolean;
     isInServerlessEnv?: boolean;
     debug?: boolean;
-    plugins?: SuperTokensPlugin[];
+    /**
+     *
+     * Our experimental features are not yet stable and are subject to change. In practical terms, this means that their interface is subject to change without a major version update.
+     * They are also not tested as much as our "normal" features.
+     *
+     * If you want to use these features, or if you have any feedback please let us know at:
+     * https://supertokens.com/discord
+     *
+     */
+    experimental?: {
+        plugins?: SuperTokensPlugin[];
+    };
 };
 
 export type NetworkInterceptor = (request: HttpRequest, userContext: UserContext) => HttpRequest;

diff --git a/lib/ts/version.ts b/lib/ts/version.ts
@@ -12,7 +12,7 @@
  * License for the specific language governing permissions and limitations
  * under the License.
  */
-export const version = "21.1.0";
+export const version = "21.1.0-canary-plugins.0";
 
 export const cdiSupported = ["5.2"];
 

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
     "name": "supertokens-node",
-    "version": "21.1.0",
+    "version": "21.1.0-canary-plugins.0",
     "description": "NodeJS driver for SuperTokens core",
     "main": "index.js",
     "scripts": {

diff --git a/test/with-typescript/index.ts b/test/with-typescript/index.ts
@@ -2369,59 +2369,61 @@ const customPlugin = createPluginInitFunction<{ log: (input: any) => void }, { p
 Supertokens.init({
     appInfo,
     recipeList: [OpenId.init()],
-    plugins: [
-        {
-            id: "asdf",
-            compatibleSDKVersions: "1.2.3",
-            overrideMap: {
-                emailpassword: {
-                    functions: (oI) => ({
-                        ...oI,
-                        signIn: (input) => {
-                            return oI.signIn(input);
-                        },
-                    }),
-                    apis: (apis) => ({
-                        ...apis,
-                        signInPOST: (input) => {
-                            return apis.signInPOST!(input);
-                        },
-                    }),
+    experimental: {
+        plugins: [
+            {
+                id: "asdf",
+                compatibleSDKVersions: "1.2.3",
+                overrideMap: {
+                    emailpassword: {
+                        functions: (oI) => ({
+                            ...oI,
+                            signIn: (input) => {
+                                return oI.signIn(input);
+                            },
+                        }),
+                        apis: (apis) => ({
+                            ...apis,
+                            signInPOST: (input) => {
+                                return apis.signInPOST!(input);
+                            },
+                        }),
+                    },
+                    passwordless: {
+                        functions: (oI) => ({
+                            ...oI,
+                            checkCode: (input) => {
+                                return oI.checkCode(input);
+                            },
+                        }),
+                    },
                 },
-                passwordless: {
-                    functions: (oI) => ({
-                        ...oI,
-                        checkCode: (input) => {
-                            return oI.checkCode(input);
+                routeHandlers: [
+                    {
+                        method: "get",
+                        path: "/asdf",
+                        verifySessionOptions: {},
+                        handler: async (req, res, userContext) => {
+                            return {
+                                status: 200,
+                                body: {},
+                            };
                         },
-                    }),
-                },
+                    },
+                ],
             },
-            routeHandlers: [
-                {
-                    method: "get",
-                    path: "/asdf",
-                    verifySessionOptions: {},
-                    handler: async (req, res, userContext) => {
-                        return {
-                            status: 200,
-                            body: {},
-                        };
+            customPlugin({
+                prefix: "asdf",
+                override: (oI) => ({
+                    ...oI,
+                    log: (input: any) => {
+                        console.log(`in log override - before oI.log`);
+                        const res = oI.log(input);
+                        console.log(`in log override - after oI.log`);
+                        return res;
                     },
-                },
-            ],
-        },
-        customPlugin({
-            prefix: "asdf",
-            override: (oI) => ({
-                ...oI,
-                log: (input: any) => {
-                    console.log(`in log override - before oI.log`);
-                    const res = oI.log(input);
-                    console.log(`in log override - after oI.log`);
-                    return res;
-                },
+                }),
             }),
-        }),
-    ],
+        ],
+    },
 });