@data-fair/frame 0.18.6 → 0.19.0

package/lib/vue-router/state-change-adapter.js

@@ -17,13 +17,23 @@ class VueRouterDFrameStateChangeAdapter {
         if (!newRoute.startsWith('/'))
             newRoute = '/' + newRoute;
         element.log('debug', 'apply state change on vue.router', action, newRoute);
+        // a guard that throws rejects the navigation without calling afterEach: the parent stays on its URL,
+        // the child is brought back to it like after an aborted navigation
+        const onError = (err) => {
+            element.log('error', 'failed to apply state change on vue.router', err);
+            element.updateSrc();
+        };
         if (action === 'push')
-            this.router.push(newRoute);
+            this.router.push(newRoute).catch(onError);
         if (action === 'replace')
-            this.router.replace(newRoute);
+            this.router.replace(newRoute).catch(onError);
     }
     onStateChange(callback) {
-        this.router.afterEach(callback);
+        // a cancelled navigation is superseded by a newer one: syncing the child from the parent URL
+        // would send back stale params while the child has already moved on (fast clicks in the child).
+        // An aborted one (4 = NavigationFailureType.aborted) was refused by a guard: the child must go back to the parent URL
+        return this.router.afterEach((_to, _from, failure) => { if (!failure || failure.type === 4)
+            callback(); });
     }
 }
 export default (router) => new VueRouterDFrameStateChangeAdapter(router);

package/lib/vue-router/use-parent-url.js

@@ -17,16 +17,21 @@ export const useParentUrl = (location, router, dFrameContent) => {
     let listener = null;
     const parentUrl = ref(null);
     watch(() => toValue(location), (to) => {
+        const href = to === undefined ? undefined : router.resolve(to).href;
+        // a getter can return a new location object for the same target: keep the listener and its result
+        if (href === resolved)
+            return;
         if (listener && resolved)
             dFrameContent.removeParentUrlListener(resolved, listener);
-        if (to === undefined) {
-            parentUrl.value = to;
+        resolved = href;
+        listener = null;
+        if (href === undefined) {
+            parentUrl.value = undefined;
         }
         else {
             parentUrl.value = null;
-            resolved = router.resolve(to).href;
             listener = (result) => { parentUrl.value = result; };
-            dFrameContent.addParentUrlListener(resolved, listener);
+            dFrameContent.addParentUrlListener(href, listener);
         }
     }, { immediate: true });
     onScopeDispose(() => {

package/package.json

@@ -1,14 +1,15 @@
 {
   "name": "@data-fair/frame",
-  "version": "0.18.6",
+  "version": "0.19.0",
   "description": "An iframe wrapper for powerful web app integrations.",
-  "main": "dist/frame.min.js",
+  "main": "lib/d-frame.js",
   "directories": {
     "doc": "doc"
   },
   "devDependencies": {
     "@commitlint/config-conventional": "^19.6.0",
     "@koumoul/gh-pages-multi": "^0.7.2",
+    "@playwright/test": "^1.64.1",
     "commitlint": "^19.6.0",
     "eslint": "^9.16.0",
     "husky": "^9.1.7",
@@ -19,14 +20,16 @@
     "vue-router": "^5.0.0"
   },
   "scripts": {
-    "check-types": "tsc",
+    "check-types": "tsc --noEmit && tsc -p tests",
     "lint": "eslint .",
     "lint:fix": "eslint . --fix",
     "dev-zellij": "zellij --layout .zellij.kdl",
     "prepare": "husky",
-    "test": "node --test tests/*.js",
-    "test:only": "node --test --test-only tests/*.js",
-    "build": "rm -f lib/*.d.ts && rm -f lib/*.js && tsc -p tsconfig.json && rm -rf dist && vite -c vite.config.d-frame.js build && vite -c vite.config.d-frame-content.js build && vite -c vite.config.v-iframe-compat-d-frame-content.js build",
+    "test": "playwright test && playwright test -c playwright.doc.config.ts",
+    "test:unit": "playwright test --project=unit",
+    "test:e2e": "playwright test --project=e2e",
+    "test:doc": "playwright test -c playwright.doc.config.ts",
+    "build": "find lib \\( -name '*.js' -o -name '*.d.ts' \\) -delete && tsc -p tsconfig.json && rm -rf dist && vite -c vite.config.d-frame.js build && vite -c vite.config.d-frame-content.js build && vite -c vite.config.v-iframe-compat-d-frame-content.js build",
     "prepublishOnly": "npm run lint && npm run test && npm run build",
     "publish:main": "cd doc && npm run build:main && cd .. && gh-pages-multi deploy -v -s doc/.output/public -t main",
     "publish:latest": "cd doc && npm run build:latest && cd .. && gh-pages-multi deploy -v -s doc/.output/public -t latest"

package/lib/vue-router/router-type.d.ts

@@ -1,17 +0,0 @@
-import type { Router as Router4, RouteLocationRaw as RouteLocationRaw4 } from 'vue-router';
-type Router4Options = {
-    base?: string;
-    history?: {
-        base?: string;
-    };
-};
-type Router5Options = {
-    base?: string;
-};
-export type Router = Router4 & {
-    options: Router4Options | Router5Options;
-};
-export type RouteLocationRaw = RouteLocationRaw4;
-export declare function isRouter4(router: Router): router is Router4;
-export declare function getRouterBase(router: Router): string | undefined;
-export {};

package/lib/vue-router/router-type.js

@@ -1,7 +0,0 @@
-export function isRouter4(router) {
-    return 'options' in router && 'history' in router.options;
-}
-export function getRouterBase(router) {
-    const options = router.options;
-    return options.base ?? options.history?.base;
-}

package/lib/vue-router/util.d.ts

@@ -1,17 +0,0 @@
-import type { RouteLocationRaw as RouteLocationRaw5 } from 'vue-router';
-export type Router = {
-    options: {
-        base?: string;
-        history?: {
-            base?: string;
-        };
-    };
-    push: (to: RouteLocationRaw5) => Promise<any>;
-    replace: (to: RouteLocationRaw5) => Promise<any>;
-    resolve: (to: RouteLocationRaw5) => {
-        href: string;
-    };
-    afterEach: (callback: () => any) => any;
-};
-export type RouteLocationRaw = RouteLocationRaw5;
-export declare function getRouterBase(router: Router): string | undefined;

package/lib/vue-router/util.js

@@ -1,3 +0,0 @@
-export function getRouterBase(router) {
-    return router.options.base ?? router.options.history?.base;
-}