@supertokens-plugins/rownd-nodejs 0.2.1 → 0.3.0-beta.1

package/README.md

@@ -44,6 +44,39 @@ SuperTokens.init({
 });
 ```
 
+### 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.
+
+```typescript
+RowndMigrationPlugin.init({
+  rowndAppKey: process.env.ROWND_APP_KEY,
+  rowndAppSecret: process.env.ROWND_APP_SECRET,
+  schema: {
+    employee_id: {
+      display_name: "Employee ID",
+      type: "string",
+      user_visible: false,
+      include_in_session_claims: true,
+      session_claim_name: "employee_id_claim",
+    },
+  },
+});
+```
+
+### Mobile Deep Links
+
+Set `mobileDeepLinkBaseUrl` to rewrite mobile-context account links to a native deep link target. The value must be an absolute URL base, such as a custom scheme or HTTPS universal/app link domain.
+
+```typescript
+RowndMigrationPlugin.init({
+  rowndAppKey: process.env.ROWND_APP_KEY,
+  rowndAppSecret: process.env.ROWND_APP_SECRET,
+  mobileDeepLinkBaseUrl: "customDomain://",
+  // or: mobileDeepLinkBaseUrl: "https://links.example.com",
+});
+```
+
 ## API Endpoint
 
 The plugin exposes a single endpoint: