@logto/vue 1.0.0-beta.13 → 1.0.0-beta.15

package/lib/module.d.mts

@@ -0,0 +1,82 @@
+import { IdTokenClaims, LogtoConfig, UserInfoResponse } from "@logto/browser";
+import { App, Ref } from "vue";
+export type { LogtoConfig, IdTokenClaims, UserInfoResponse, LogtoErrorCode, LogtoClientErrorCode, } from '@logto/browser';
+export { LogtoError, LogtoClientError, OidcError, Prompt, ReservedScope, UserScope, } from '@logto/browser';
+type LogtoVuePlugin = {
+    install: (app: App, config: LogtoConfig) => void;
+};
+type Logto = {
+    isAuthenticated: Readonly<Ref<boolean>>;
+    isLoading: Readonly<Ref<boolean>>;
+    error: Readonly<Ref<Error | undefined>>;
+    fetchUserInfo: () => Promise<UserInfoResponse | undefined>;
+    getAccessToken: (resource?: string) => Promise<string | undefined>;
+    getIdTokenClaims: () => Promise<IdTokenClaims | undefined>;
+    signIn: (redirectUri: string) => Promise<void>;
+    signOut: (postLogoutRedirectUri?: string) => Promise<void>;
+};
+/**
+ * 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
+ */
+export const createLogto: LogtoVuePlugin;
+/**
+ * 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
+ */
+export const useLogto: () => 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
+ */
+export const useHandleSignInCallback: (callback?: () => void) => {
+    isLoading: Readonly<Ref<boolean>>;
+    isAuthenticated: Readonly<Ref<boolean>>;
+    error: Readonly<Ref<Error | undefined>>;
+};
+
+//# sourceMappingURL=index.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@logto/vue",
-  "version": "1.0.0-beta.13",
+  "version": "1.0.0-beta.15",
   "source": "./src/index.ts",
   "main": "./lib/index.js",
   "exports": {
@@ -22,14 +22,14 @@
     "dev:tsc": "tsc -p tsconfig.build.json -w --preserveWatchOutput",
     "precommit": "lint-staged",
     "check": "tsc --noEmit",
-    "build": "rm -rf lib/ && pnpm check && parcel build",
+    "build": "rm -rf lib/ && pnpm check && parcel build && cp lib/index.d.ts lib/module.d.mts",
     "lint": "eslint --ext .ts src",
     "test": "jest",
     "test:coverage": "jest --silent --coverage",
     "prepack": "pnpm test"
   },
   "dependencies": {
-    "@logto/browser": "^1.0.0-beta.13"
+    "@logto/browser": "^1.0.0-beta.15"
   },
   "devDependencies": {
     "@jest/types": "^27.5.1",
@@ -70,5 +70,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "8c64e263617689191d60391021f5f1b0872ff276"
+  "gitHead": "4dcfacd4a1b5d5fa5c7c83edb34c591fab2a8f44"
 }