@supertokens-plugins/rownd-nodejs 0.6.0 → 0.6.1

package/README.md

@@ -44,6 +44,26 @@ SuperTokens.init({
 });
 ```
 
+### Disabling Rownd User Migration
+
+After migration is complete, disable Rownd user and session migration to run
+the compatibility endpoints without Rownd credentials:
+
+```typescript
+RowndMigrationPlugin.init({
+  disableRowndUserMigration: true,
+});
+```
+
+This prevents the Rownd API client and the `/plugin/rownd/migrate` and
+`/plugin/migrate-session` routes from being initialized. Other compatibility
+endpoints remain enabled. Passwordless and email-verification links continue to
+use the Rownd Hub with an internal dummy app key when `rowndAppKey` is omitted.
+The plugin logs a warning during initialization while migration is disabled.
+
+Without `disableRowndUserMigration: true`, both `rowndAppKey` and
+`rowndAppSecret` are required.
+
 ### Session Claim Fields
 
 Schema fields can be copied into the SuperTokens access-token payload by setting `include_in_session_claims: true`. Use `session_claim_name` when the claim name should differ from the Rownd data field name.

package/dist/index.d.mts

@@ -670,8 +670,14 @@ type RowndSubBrandConfigInput = RowndAppConfigInput & {
     };
 };
 interface RowndPluginConfig {
-    rowndAppKey: string;
-    rowndAppSecret: string;
+    rowndAppKey?: string;
+    rowndAppSecret?: string;
+    /**
+     * Disables Rownd user and session migration. This must be enabled when
+     * rowndAppKey or rowndAppSecret is omitted.
+     * @default false
+     */
+    disableRowndUserMigration?: boolean;
     enableDebugLogs?: boolean;
     clientDomains?: RowndClientDomains;
     crossDeviceConfirmationBypass?: {
@@ -756,7 +762,8 @@ interface MigrationResponse {
 }
 interface RowndPluginNormalisedConfig {
     rowndAppKey: string;
-    rowndAppSecret: string;
+    rowndAppSecret?: string;
+    disableRowndUserMigration: boolean;
     enableDebugLogs?: boolean;
     clientDomains?: RowndClientDomains;
     crossDeviceConfirmationBypass?: {
@@ -861,7 +868,7 @@ type CreateMagicLinkWithConfirmationBypassInput = {
 };
 declare function createMagicLinkWithConfirmationBypass(input: CreateMagicLinkWithConfirmationBypassInput): Promise<string>;
 
-declare function setRowndClient(client: IRowndClient): void;
+declare function setRowndClient(client: IRowndClient | undefined): void;
 declare function getRowndClient(): IRowndClient;
 
 declare const _default: {

package/dist/index.d.ts

@@ -670,8 +670,14 @@ type RowndSubBrandConfigInput = RowndAppConfigInput & {
     };
 };
 interface RowndPluginConfig {
-    rowndAppKey: string;
-    rowndAppSecret: string;
+    rowndAppKey?: string;
+    rowndAppSecret?: string;
+    /**
+     * Disables Rownd user and session migration. This must be enabled when
+     * rowndAppKey or rowndAppSecret is omitted.
+     * @default false
+     */
+    disableRowndUserMigration?: boolean;
     enableDebugLogs?: boolean;
     clientDomains?: RowndClientDomains;
     crossDeviceConfirmationBypass?: {
@@ -756,7 +762,8 @@ interface MigrationResponse {
 }
 interface RowndPluginNormalisedConfig {
     rowndAppKey: string;
-    rowndAppSecret: string;
+    rowndAppSecret?: string;
+    disableRowndUserMigration: boolean;
     enableDebugLogs?: boolean;
     clientDomains?: RowndClientDomains;
     crossDeviceConfirmationBypass?: {
@@ -861,7 +868,7 @@ type CreateMagicLinkWithConfirmationBypassInput = {
 };
 declare function createMagicLinkWithConfirmationBypass(input: CreateMagicLinkWithConfirmationBypassInput): Promise<string>;
 
-declare function setRowndClient(client: IRowndClient): void;
+declare function setRowndClient(client: IRowndClient | undefined): void;
 declare function getRowndClient(): IRowndClient;
 
 declare const _default: {

package/dist/index.js

@@ -2889,6 +2889,7 @@ function validateWritableFields(fields) {
 }
 
 // src/plugin.ts
+var DISABLED_MIGRATION_ROWND_APP_KEY = "migration-disabled";
 var verifyRowndUserSessionOptions = {
   sessionRequired: true,
   overrideGlobalClaimValidators: (validators) => validators.filter((validator) => {
@@ -2897,10 +2898,10 @@ var verifyRowndUserSessionOptions = {
 };
 var init = createPluginInitFunction(
   (pluginConfig2) => {
-    const rowndClient2 = (0, import_node.createInstance)({
+    const rowndClient2 = !pluginConfig2.disableRowndUserMigration && pluginConfig2.rowndAppSecret ? (0, import_node.createInstance)({
       app_key: pluginConfig2.rowndAppKey,
       app_secret: pluginConfig2.rowndAppSecret
-    });
+    }) : void 0;
     const telemetryClient = createClient(pluginConfig2.telemetry);
     let hubBootstrapParams;
     const addHubBootstrapParams = (input, linkKey, targetPath) => {
@@ -2940,6 +2941,11 @@ var init = createPluginInitFunction(
       id: PLUGIN_ID,
       compatibleSDKVersions: PLUGIN_SDK_VERSION,
       init: async () => {
+        if (pluginConfig2.disableRowndUserMigration) {
+          console.warn(
+            "RowndMigrationPlugin: Rownd user and session migration is disabled."
+          );
+        }
         if (!import_supertokens_node4.default.isRecipeInitialized("session")) {
           console.warn(
             "RowndMigrationPlugin: Session recipe is not initialized. Session migration will fail."
@@ -2983,11 +2989,11 @@ var init = createPluginInitFunction(
               method: "post",
               handler: withRequestHandler(handleGuestLogin(routeHandlerDeps))
             },
-            {
+            ...!pluginConfig2.disableRowndUserMigration ? [{
               path: `${apiBasePath}${HANDLE_BASE_PATH}/migrate`,
               method: "post",
               handler: withRequestHandler(handleMigrate(routeHandlerDeps))
-            },
+            }] : [],
             {
               path: `${apiBasePath}/plugin/passwordless-cross-device-confirmation/validate`,
               method: "post",
@@ -2995,11 +3001,11 @@ var init = createPluginInitFunction(
                 handleValidatePasswordlessConfirmationBypass(routeHandlerDeps)
               )
             },
-            {
+            ...!pluginConfig2.disableRowndUserMigration ? [{
               path: `${apiBasePath}/plugin/migrate-session`,
               method: "post",
               handler: withRequestHandler(handleMigrate(routeHandlerDeps))
-            },
+            }] : [],
             {
               path: `${apiBasePath}${HANDLE_BASE_PATH}/signout`,
               method: "post",
@@ -3379,9 +3385,14 @@ var init = createPluginInitFunction(
   },
   () => ({}),
   (config2) => {
-    if (!config2?.rowndAppKey || !config2?.rowndAppSecret) {
+    if (config2?.disableRowndUserMigration !== void 0 && typeof config2.disableRowndUserMigration !== "boolean") {
+      throw new Error(
+        "disableRowndUserMigration must be a boolean in plugin config"
+      );
+    }
+    if (!config2?.disableRowndUserMigration && (!config2?.rowndAppKey || !config2?.rowndAppSecret)) {
       throw new Error(
-        "Missing rowndAppKey or rowndAppSecret in plugin config"
+        "Missing rowndAppKey or rowndAppSecret in plugin config. Set disableRowndUserMigration to true to disable migration."
       );
     }
     if (config2.telemetry?.provider === "axiom") {
@@ -3402,8 +3413,9 @@ var init = createPluginInitFunction(
       validateClientDomainUrl(key, value);
     }
     return {
-      rowndAppKey: config2.rowndAppKey,
+      rowndAppKey: config2.rowndAppKey ?? DISABLED_MIGRATION_ROWND_APP_KEY,
       rowndAppSecret: config2.rowndAppSecret,
+      disableRowndUserMigration: config2.disableRowndUserMigration === true,
       enableDebugLogs: config2.enableDebugLogs,
       clientDomains: config2.clientDomains,
       crossDeviceConfirmationBypass: config2.crossDeviceConfirmationBypass,

package/dist/index.mjs

@@ -2866,6 +2866,7 @@ function validateWritableFields(fields) {
 }
 
 // src/plugin.ts
+var DISABLED_MIGRATION_ROWND_APP_KEY = "migration-disabled";
 var verifyRowndUserSessionOptions = {
   sessionRequired: true,
   overrideGlobalClaimValidators: (validators) => validators.filter((validator) => {
@@ -2874,10 +2875,10 @@ var verifyRowndUserSessionOptions = {
 };
 var init = createPluginInitFunction(
   (pluginConfig2) => {
-    const rowndClient2 = createInstance({
+    const rowndClient2 = !pluginConfig2.disableRowndUserMigration && pluginConfig2.rowndAppSecret ? createInstance({
       app_key: pluginConfig2.rowndAppKey,
       app_secret: pluginConfig2.rowndAppSecret
-    });
+    }) : void 0;
     const telemetryClient = createClient(pluginConfig2.telemetry);
     let hubBootstrapParams;
     const addHubBootstrapParams = (input, linkKey, targetPath) => {
@@ -2917,6 +2918,11 @@ var init = createPluginInitFunction(
       id: PLUGIN_ID,
       compatibleSDKVersions: PLUGIN_SDK_VERSION,
       init: async () => {
+        if (pluginConfig2.disableRowndUserMigration) {
+          console.warn(
+            "RowndMigrationPlugin: Rownd user and session migration is disabled."
+          );
+        }
         if (!supertokens.isRecipeInitialized("session")) {
           console.warn(
             "RowndMigrationPlugin: Session recipe is not initialized. Session migration will fail."
@@ -2960,11 +2966,11 @@ var init = createPluginInitFunction(
               method: "post",
               handler: withRequestHandler(handleGuestLogin(routeHandlerDeps))
             },
-            {
+            ...!pluginConfig2.disableRowndUserMigration ? [{
               path: `${apiBasePath}${HANDLE_BASE_PATH}/migrate`,
               method: "post",
               handler: withRequestHandler(handleMigrate(routeHandlerDeps))
-            },
+            }] : [],
             {
               path: `${apiBasePath}/plugin/passwordless-cross-device-confirmation/validate`,
               method: "post",
@@ -2972,11 +2978,11 @@ var init = createPluginInitFunction(
                 handleValidatePasswordlessConfirmationBypass(routeHandlerDeps)
               )
             },
-            {
+            ...!pluginConfig2.disableRowndUserMigration ? [{
               path: `${apiBasePath}/plugin/migrate-session`,
               method: "post",
               handler: withRequestHandler(handleMigrate(routeHandlerDeps))
-            },
+            }] : [],
             {
               path: `${apiBasePath}${HANDLE_BASE_PATH}/signout`,
               method: "post",
@@ -3356,9 +3362,14 @@ var init = createPluginInitFunction(
   },
   () => ({}),
   (config2) => {
-    if (!config2?.rowndAppKey || !config2?.rowndAppSecret) {
+    if (config2?.disableRowndUserMigration !== void 0 && typeof config2.disableRowndUserMigration !== "boolean") {
+      throw new Error(
+        "disableRowndUserMigration must be a boolean in plugin config"
+      );
+    }
+    if (!config2?.disableRowndUserMigration && (!config2?.rowndAppKey || !config2?.rowndAppSecret)) {
       throw new Error(
-        "Missing rowndAppKey or rowndAppSecret in plugin config"
+        "Missing rowndAppKey or rowndAppSecret in plugin config. Set disableRowndUserMigration to true to disable migration."
       );
     }
     if (config2.telemetry?.provider === "axiom") {
@@ -3379,8 +3390,9 @@ var init = createPluginInitFunction(
       validateClientDomainUrl(key, value);
     }
     return {
-      rowndAppKey: config2.rowndAppKey,
+      rowndAppKey: config2.rowndAppKey ?? DISABLED_MIGRATION_ROWND_APP_KEY,
       rowndAppSecret: config2.rowndAppSecret,
+      disableRowndUserMigration: config2.disableRowndUserMigration === true,
       enableDebugLogs: config2.enableDebugLogs,
       clientDomains: config2.clientDomains,
       crossDeviceConfirmationBypass: config2.crossDeviceConfirmationBypass,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@supertokens-plugins/rownd-nodejs",
-  "version": "0.6.0",
+  "version": "0.6.1",
   "description": "Rownd User Migration Plugin for SuperTokens",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",