@logto/vue 2.2.17 → 3.0.4

package/package.json

@@ -1,13 +1,11 @@
 {
   "name": "@logto/vue",
-  "version": "2.2.17",
+  "version": "3.0.4",
   "type": "module",
-  "main": "./lib/index.cjs",
   "module": "./lib/index.js",
   "types": "./lib/index.d.ts",
   "exports": {
     "types": "./lib/index.d.ts",
-    "require": "./lib/index.cjs",
     "import": "./lib/index.js",
     "default": "./lib/index.js"
   },
@@ -21,21 +19,21 @@
     "directory": "packages/vue"
   },
   "dependencies": {
-    "@silverhand/essentials": "^2.8.7",
-    "@logto/browser": "^2.2.18"
+    "@silverhand/essentials": "^2.9.2",
+    "@logto/browser": "^3.0.4"
   },
   "devDependencies": {
     "@silverhand/eslint-config": "^6.0.1",
     "@silverhand/ts-config": "^6.0.0",
-    "@vitest/coverage-v8": "^1.6.0",
+    "@vitest/coverage-v8": "^2.1.9",
     "eslint": "^8.57.0",
-    "happy-dom": "^14.0.0",
+    "happy-dom": "^16.0.0",
     "lint-staged": "^15.0.0",
     "postcss": "^8.4.31",
     "prettier": "^3.0.0",
-    "stylelint": "^15.0.0",
+    "stylelint": "^16.0.0",
     "typescript": "^5.3.3",
-    "vitest": "^1.6.0",
+    "vitest": "^2.1.9",
     "vue": "^3.4.19"
   },
   "peerDependencies": {

package/lib/consts.cjs

@@ -1,7 +0,0 @@
-'use strict';
-
-const logtoInjectionKey = '@logto/vue';
-const contextInjectionKey = '@logto/vue:context';
-
-exports.contextInjectionKey = contextInjectionKey;
-exports.logtoInjectionKey = logtoInjectionKey;

package/lib/context.cjs

@@ -1,48 +0,0 @@
-'use strict';
-
-var vue = require('vue');
-
-const createContext = (client) => {
-    const context = vue.toRefs(vue.reactive({
-        logtoClient: client,
-        isAuthenticated: false,
-        loadingCount: 1,
-        error: undefined,
-    }));
-    const { isAuthenticated, loadingCount, error } = context;
-    const isLoading = vue.computed(() => loadingCount.value > 0);
-    /* eslint-disable @silverhand/fp/no-mutation */
-    const setError = (_error, fallbackErrorMessage) => {
-        if (_error instanceof Error) {
-            error.value = _error;
-        }
-        else if (fallbackErrorMessage) {
-            error.value = new Error(fallbackErrorMessage);
-        }
-        console.error(error);
-    };
-    const setLoading = (isLoading) => {
-        if (isLoading) {
-            loadingCount.value += 1;
-        }
-        else {
-            loadingCount.value = Math.max(0, loadingCount.value - 1);
-        }
-    };
-    const setIsAuthenticated = (_isAuthenticated) => {
-        isAuthenticated.value = _isAuthenticated;
-    };
-    /* eslint-enable @silverhand/fp/no-mutation */
-    (async () => {
-        const isAuthenticated = await client.isAuthenticated();
-        setIsAuthenticated(isAuthenticated);
-        setLoading(false);
-    })();
-    return { ...context, isLoading, setError, setLoading, setIsAuthenticated };
-};
-const throwContextError = () => {
-    throw new Error('Must install Logto plugin first.');
-};
-
-exports.createContext = createContext;
-exports.throwContextError = throwContextError;

package/lib/index.cjs

@@ -1,164 +0,0 @@
-'use strict';
-
-var LogtoClient = require('@logto/browser');
-var vue = require('vue');
-var consts = require('./consts.cjs');
-var context = require('./context.cjs');
-var plugin = require('./plugin.cjs');
-
-function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
-
-var LogtoClient__default = /*#__PURE__*/_interopDefault(LogtoClient);
-
-/**
- * Creates the Logto Vue plugin
- *
- * ```ts
- * import { createApp } from 'vue';
- * import { createLogto } from '@logto/vue';
- *
- * const app = createApp(App);
- * const app.use(createLogto, {
- *   appId: '<your-app-id>',
- *   endpoint: '<your-oidc-endpoint-domain>',
- * });
- *
- * app.mount('#app');
- * ```
- *
- * Use this in your Vue root component to register the plugin
- */
-const createLogto = {
-    install(app, config) {
-        const client = new LogtoClient__default.default(config);
-        const context$1 = context.createContext(client);
-        const pluginMethods = plugin.createPluginMethods(context$1);
-        const { isAuthenticated, isLoading, error } = context$1;
-        app.provide(consts.contextInjectionKey, context$1);
-        app.provide(consts.logtoInjectionKey, {
-            isAuthenticated: vue.readonly(isAuthenticated),
-            isLoading: vue.readonly(isLoading),
-            error: vue.readonly(error),
-            ...pluginMethods,
-        });
-    },
-};
-/**
- * A Vue composable method that provides the Logto reactive refs and auth methods.
- *
- * ```ts
- * import { useLogto } from '@logto/vue';
- *
- * export default {
- *  setup() {
- *    const { isAuthenticated, signIn } = useLogto();
- *
- *    return {
- *      isAuthenticated,
- *      onClickSignIn: () => {
- *        signIn('<your-redirect-uri>');
- *      },
- *    }
- *  }
- * }
- * ```
- *
- * Use this composable in the setup script of your Vue component to make sure the injection works
- */
-const useLogto = () => {
-    const logto = vue.inject(consts.logtoInjectionKey);
-    if (!logto) {
-        return context.throwContextError();
-    }
-    return logto;
-};
-/**
- * A Vue composable method that watches browser navigation and automatically handles the sign-in callback
- *
- * ```ts
- * import { useLogto } from '@logto/vue';
- * import { useHandleSignInCallback } from '@logto/vue';
- *
- * export default {
- *   setup() {
- *     useHandleSignInCallback();
- *   }
- * }
- * ```
- *
- * Use this in the setup script of your Callback page to make sure the injection works
- */
-const useHandleSignInCallback = (callback) => {
-    const context$1 = vue.inject(consts.contextInjectionKey);
-    if (!context$1) {
-        return context.throwContextError();
-    }
-    const { isAuthenticated, isLoading, logtoClient, error } = context$1;
-    const { handleSignInCallback } = plugin.createPluginMethods(context$1);
-    vue.watchEffect(async () => {
-        if (!logtoClient.value) {
-            return;
-        }
-        const currentPageUrl = window.location.href;
-        const isAuthenticated = await logtoClient.value.isAuthenticated();
-        const isRedirected = await logtoClient.value.isSignInRedirected(currentPageUrl);
-        console.log('isAuthenticated', isAuthenticated);
-        console.log('isRedirected', isRedirected);
-        if (!isAuthenticated && isRedirected) {
-            void handleSignInCallback(currentPageUrl, callback);
-        }
-    });
-    return {
-        isLoading: vue.readonly(isLoading),
-        isAuthenticated: vue.readonly(isAuthenticated),
-        error: vue.readonly(error),
-    };
-};
-
-Object.defineProperty(exports, "LogtoClientError", {
-    enumerable: true,
-    get: function () { return LogtoClient.LogtoClientError; }
-});
-Object.defineProperty(exports, "LogtoError", {
-    enumerable: true,
-    get: function () { return LogtoClient.LogtoError; }
-});
-Object.defineProperty(exports, "LogtoRequestError", {
-    enumerable: true,
-    get: function () { return LogtoClient.LogtoRequestError; }
-});
-Object.defineProperty(exports, "OidcError", {
-    enumerable: true,
-    get: function () { return LogtoClient.OidcError; }
-});
-Object.defineProperty(exports, "PersistKey", {
-    enumerable: true,
-    get: function () { return LogtoClient.PersistKey; }
-});
-Object.defineProperty(exports, "Prompt", {
-    enumerable: true,
-    get: function () { return LogtoClient.Prompt; }
-});
-Object.defineProperty(exports, "ReservedScope", {
-    enumerable: true,
-    get: function () { return LogtoClient.ReservedScope; }
-});
-Object.defineProperty(exports, "UserScope", {
-    enumerable: true,
-    get: function () { return LogtoClient.UserScope; }
-});
-Object.defineProperty(exports, "buildOrganizationUrn", {
-    enumerable: true,
-    get: function () { return LogtoClient.buildOrganizationUrn; }
-});
-Object.defineProperty(exports, "getOrganizationIdFromUrn", {
-    enumerable: true,
-    get: function () { return LogtoClient.getOrganizationIdFromUrn; }
-});
-Object.defineProperty(exports, "organizationUrnPrefix", {
-    enumerable: true,
-    get: function () { return LogtoClient.organizationUrnPrefix; }
-});
-exports.createLogto = createLogto;
-exports.useHandleSignInCallback = useHandleSignInCallback;
-exports.useLogto = useLogto;

package/lib/plugin.cjs

@@ -1,67 +0,0 @@
-'use strict';
-
-var context = require('./context.cjs');
-
-const createPluginMethods = (context$1) => {
-    const { logtoClient, setLoading, setError, setIsAuthenticated } = context$1;
-    const client = logtoClient.value ?? context.throwContextError();
-    const proxy = (run, resetLoadingState = true) => {
-        return async (...args) => {
-            try {
-                setLoading(true);
-                return await run(...args);
-            }
-            catch (error) {
-                setError(error, `Unexpected error occurred while calling ${run.name}.`);
-            }
-            finally {
-                if (resetLoadingState) {
-                    setLoading(false);
-                }
-            }
-        };
-    };
-    const methods = {
-        getRefreshToken: proxy(client.getRefreshToken.bind(client)),
-        getAccessToken: proxy(client.getAccessToken.bind(client)),
-        getAccessTokenClaims: proxy(client.getAccessTokenClaims.bind(client)),
-        getOrganizationToken: proxy(client.getOrganizationToken.bind(client)),
-        getOrganizationTokenClaims: proxy(client.getOrganizationTokenClaims.bind(client)),
-        getIdToken: proxy(client.getIdToken.bind(client)),
-        getIdTokenClaims: proxy(client.getIdTokenClaims.bind(client)),
-        // eslint-disable-next-line no-restricted-syntax
-        signIn: proxy(client.signIn.bind(client), false),
-        // We deliberately do NOT set isAuthenticated to false in the function below, because the app state
-        // may change immediately even before navigating to the oidc end session endpoint, which might cause
-        // rendering problems.
-        // Moreover, since the location will be redirected, the isAuthenticated state will not matter any more.
-        signOut: proxy(client.signOut.bind(client)),
-        fetchUserInfo: proxy(client.fetchUserInfo.bind(client)),
-        clearAccessToken: proxy(client.clearAccessToken.bind(client)),
-        clearAllTokens: proxy(client.clearAllTokens.bind(client)),
-    };
-    const handleSignInCallback = async (callbackUri, callbackFunction) => {
-        if (!logtoClient.value) {
-            return context.throwContextError();
-        }
-        try {
-            setLoading(true);
-            console.log('handleSignInCallback');
-            await logtoClient.value.handleSignInCallback(callbackUri);
-            setIsAuthenticated(true);
-            callbackFunction?.();
-        }
-        catch (error) {
-            setError(error, 'Unexpected error occurred while handling sign in callback.');
-        }
-        finally {
-            setLoading(false);
-        }
-    };
-    return {
-        ...methods,
-        handleSignInCallback,
-    };
-};
-
-exports.createPluginMethods = createPluginMethods;