@descope/vue-sdk - npm Package Compare versions

Comparing version 2.2.29 to 2.3.0

package.json

 {
   "name": "@descope/vue-sdk",
-  "version": "2.2.29",
+  "version": "2.3.0",
   "main": "dist/index.cjs",
@@ -28,11 +28,11 @@ "module": "dist/index.mjs",
   "dependencies": {
-    "@descope/audit-management-widget": "0.2.21",
-    "@descope/role-management-widget": "0.2.21",
-    "@descope/user-management-widget": "0.6.16",
-    "@descope/access-key-management-widget": "0.3.17",
-    "@descope/applications-portal-widget": "0.2.20",
-    "@descope/web-component": "3.32.11",
-    "@descope/user-profile-widget": "0.2.17",
-    "@descope/web-js-sdk": "1.23.9",
-    "@descope/core-js-sdk": "2.33.6"
+    "@descope/access-key-management-widget": "0.3.18",
+    "@descope/audit-management-widget": "0.3.0",
+    "@descope/role-management-widget": "0.2.22",
+    "@descope/user-profile-widget": "0.2.18",
+    "@descope/applications-portal-widget": "0.2.21",
+    "@descope/web-component": "3.34.0",
+    "@descope/user-management-widget": "0.6.17",
+    "@descope/core-js-sdk": "2.34.0",
+    "@descope/web-js-sdk": "1.23.10"
   },
@@ -66,3 +66,3 @@ "peerDependencies": {
     "pretty-quick": "^3.1.3",
-    "rollup": "^2.79.1",
+    "rollup": "^4.0.0",
     "rollup-plugin-auto-external": "^2.0.0",
@@ -72,3 +72,3 @@ "rollup-plugin-commonjs": "^10.1.0",
     "rollup-plugin-delete": "^2.0.0",
-    "rollup-plugin-dts": "^4.2.2",
+    "rollup-plugin-dts": "^6.1.1",
     "@rollup/plugin-node-resolve": "^15.0.0",
@@ -90,3 +90,3 @@ "rollup-plugin-terser": "^7.0.2",
     "start": "vue-cli-service serve --port 3000",
-    "build": "rollup -m -c rollup.config.js",
+    "build": "rollup -c",
     "test": "vue-cli-service test:unit",
@@ -93,0 +93,0 @@ "lint": "vue-cli-service lint",

README.md

@@ -90,2 +90,33 @@ # Descope Vue SDK
 
+### `onScreenUpdate`
+
+A function that is called whenever there is a new screen state and after every next call. It receives the following parameters:
+
+- `screenName`: The name of the screen that is about to be rendered
+- `context`: An object containing the upcoming screen state
+- `next`: A function that, when called, continues the flow execution
+- `ref`: A reference to the descope-wc node
+
+The function can be sync or async, and should return a boolean indicating whether a custom screen should be rendered:
+
+- `true`: Render a custom screen
+- `false`: Render the default flow screen
+
+This function allows rendering custom screens instead of the default flow screens.
+It can be useful for highly customized UIs or specific logic not covered by the default screens
+
+To render a custom screen, its elements should be appended as children of the `Descope` component
+
+Usage example:
+
+```javascript
+function onScreenUpdate(screenName, context, next) {
+  if (screenName === 'My Custom Screen') {
+    return true;
+  }
+
+  return false;
+}
+```
+
 ### Use the `useDescope`, `useSession` and `useUser` functions in your components in order to get authentication state, user details and utilities
@@ -92,0 +123,0 @@

No alert changes

Improved metrics

Total package byte prevSize

301148

increased by0.65%

Lines of code

5367

increased by0.19%

Number of lines in readme file

519

increased by6.35%

Worsened metrics

Number of package files

8

decreased by-11.11%

Dependency changes

• + Added@descope/access-key-management-widget@0.3.18(transitive)

• + Added@descope/applications-portal-widget@0.2.21(transitive)

• + Added@descope/audit-management-widget@0.3.0(transitive)

• + Added@descope/core-js-sdk@2.34.0(transitive)

• + Added@descope/role-management-widget@0.2.22(transitive)

• + Added@descope/sdk-component-drivers@0.2.51(transitive)

• + Added@descope/sdk-helpers@0.2.0(transitive)

• + Added@descope/sdk-mixins@0.8.0(transitive)

• + Added@descope/user-management-widget@0.6.17(transitive)

• + Added@descope/user-profile-widget@0.2.18(transitive)

• + Added@descope/web-component@3.34.0(transitive)

• + Added@descope/web-js-sdk@1.23.10(transitive)

• + Addedpostcss@8.5.3(transitive)

• - Removed@descope/access-key-management-widget@0.3.17(transitive)

• - Removed@descope/applications-portal-widget@0.2.20(transitive)

• - Removed@descope/audit-management-widget@0.2.21(transitive)

• - Removed@descope/core-js-sdk@2.33.6(transitive)

• - Removed@descope/role-management-widget@0.2.21(transitive)

• - Removed@descope/sdk-component-drivers@0.2.50(transitive)

• - Removed@descope/sdk-helpers@0.1.67(transitive)

• - Removed@descope/sdk-mixins@0.6.8(transitive)

• - Removed@descope/user-management-widget@0.6.16(transitive)

• - Removed@descope/user-profile-widget@0.2.17(transitive)

• - Removed@descope/web-component@3.32.11(transitive)

• - Removed@descope/web-js-sdk@1.23.9(transitive)

• - Removedpostcss@8.5.2(transitive)

• Updated@descope/access-key-management-widget@0.3.18

• Updated@descope/applications-portal-widget@0.2.21

• Updated@descope/audit-management-widget@0.3.0

• Updated@descope/core-js-sdk@2.34.0

• Updated@descope/role-management-widget@0.2.22

• Updated@descope/user-management-widget@0.6.17

• Updated@descope/user-profile-widget@0.2.18

• Updated@descope/web-component@3.34.0

• Updated@descope/web-js-sdk@1.23.10