@logto/vue 1.0.0-alpha.2 → 1.0.0-beta.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +7 -72
- package/lib/index.d.ts +1 -1
- package/lib/index.d.ts.map +1 -1
- package/lib/index.js.map +1 -1
- package/lib/module.js.map +1 -1
- package/package.json +5 -5
package/README.md
CHANGED
|
@@ -3,9 +3,9 @@
|
|
|
3
3
|
[](https://github.com/logto-io/js/actions/workflows/main.yml)
|
|
4
4
|
[](https://app.codecov.io/gh/logto-io/js?branch=master)
|
|
5
5
|
|
|
6
|
-
The Logto Vue SDK written in TypeScript. Check out our [integration guide](https://docs.logto.io/integrate-
|
|
6
|
+
The Logto Vue SDK written in TypeScript. Check out our [integration guide](https://docs.logto.io/docs/recipes/integrate-logto/vue) or [docs](https://docs.logto.io/sdk/JavaScript/vue/) for more information.
|
|
7
7
|
|
|
8
|
-
We also provide [集成指南](https://docs.logto.io/zh-cn/integrate-
|
|
8
|
+
We also provide [集成指南](https://docs.logto.io/zh-cn/docs/recipes/integrate-logto/vue/) and [文档](https://docs.logto.io/zh-cn/sdk/JavaScript/vue/) in Simplified Chinese.
|
|
9
9
|
|
|
10
10
|
## Installation
|
|
11
11
|
|
|
@@ -24,86 +24,21 @@ yarn add @logto/vue
|
|
|
24
24
|
### Using pnpm
|
|
25
25
|
|
|
26
26
|
```bash
|
|
27
|
-
pnpm
|
|
27
|
+
pnpm add @logto/vue
|
|
28
28
|
```
|
|
29
29
|
|
|
30
|
-
|
|
30
|
+
## Get sample
|
|
31
31
|
|
|
32
|
-
|
|
33
|
-
<script src="https://logto.io/js/logto-sdk-vue/0.1.0/logto-sdk-vue.production.js" />
|
|
34
|
-
```
|
|
35
|
-
|
|
36
|
-
## Get Started
|
|
37
|
-
|
|
38
|
-
A sample project with the following code snippets can be found at [Vue Sample](https://github.com/logto-io/js/tree/master/packages/vue-sample)
|
|
39
|
-
|
|
40
|
-
Check out the source code and try it yourself. (We use [pnpm](https://pnpm.io/) for package management)
|
|
32
|
+
A sample Vue project with the integration of @logto/vue SDK can be found at [Vue Sample](https://github.com/logto-io/js/tree/master/packages/vue-sample). Check out the source code and try it with ease.
|
|
41
33
|
|
|
42
34
|
```bash
|
|
43
35
|
pnpm i && pnpm start
|
|
44
36
|
```
|
|
45
37
|
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
```ts
|
|
49
|
-
import { createLogto, LogtoConfig } from '@logto/vue';
|
|
50
|
-
|
|
51
|
-
const config: LogtoConfig = {
|
|
52
|
-
appId: '<your-application-id>',
|
|
53
|
-
endpoint: '<your-logto-endpoint>'
|
|
54
|
-
};
|
|
55
|
-
|
|
56
|
-
const app = createApp(App);
|
|
57
|
-
|
|
58
|
-
app.use(createLogto, config);
|
|
59
|
-
app.mount("#app");
|
|
60
|
-
```
|
|
61
|
-
|
|
62
|
-
### Setup your sign-in
|
|
63
|
-
|
|
64
|
-
```ts
|
|
65
|
-
import { useLogto } from "@logto/vue";
|
|
66
|
-
|
|
67
|
-
const { signIn } = useLogto();
|
|
68
|
-
const onClickSignIn = () => signIn(redirectUrl);
|
|
69
|
-
```
|
|
70
|
-
|
|
71
|
-
```html
|
|
72
|
-
<button @click="onClickSignIn">Sign In</button>
|
|
73
|
-
```
|
|
74
|
-
|
|
75
|
-
### Retrieve Auth Status
|
|
76
|
-
|
|
77
|
-
```ts
|
|
78
|
-
import { useLogto } from '@logto/vue';
|
|
79
|
-
|
|
80
|
-
const { isAuthenticated } = useLogto();
|
|
81
|
-
```
|
|
82
|
-
|
|
83
|
-
```html
|
|
84
|
-
<div v-if="!isAuthenticated">
|
|
85
|
-
<!-- E.g. navigate to the sign in page -->
|
|
86
|
-
</div>
|
|
87
|
-
<div v-else>
|
|
88
|
-
<!-- Do things when user is authenticated -->
|
|
89
|
-
</div>
|
|
90
|
-
```
|
|
91
|
-
|
|
92
|
-
### Sign out
|
|
93
|
-
|
|
94
|
-
```ts
|
|
95
|
-
import { useLogto } from "@logto/vue";
|
|
96
|
-
|
|
97
|
-
const { signOut } = useLogto();
|
|
98
|
-
const onClickSignOut = () => signOut('http://localhost:1234');
|
|
99
|
-
```
|
|
100
|
-
|
|
101
|
-
```html
|
|
102
|
-
<button @click="onClickSignOut">Sign Out</button>
|
|
103
|
-
```
|
|
38
|
+
Note: Currently only supports Vue 3.x and its [composition API](https://vuejs.org/api/composition-api-setup.html#composition-api-setup). Please let us know if you would like Logto to support Vue 2.x or options API by filing a [feature request](https://github.com/logto-io/logto/issues/new?assignees=&labels=feature-request&template=feature_request.md&title=feature+request%3A+).
|
|
104
39
|
|
|
105
40
|
## Resources
|
|
106
41
|
|
|
107
42
|
[](https://logto.io/)
|
|
108
|
-
[](https://docs.logto.io/
|
|
43
|
+
[](https://docs.logto.io/sdk/JavaScript/vue/)
|
|
109
44
|
[](https://discord.gg/UEPaF3j5e6)
|
package/lib/index.d.ts
CHANGED
|
@@ -12,7 +12,7 @@ type Logto = {
|
|
|
12
12
|
getAccessToken: (resource?: string) => Promise<string | undefined>;
|
|
13
13
|
getIdTokenClaims: () => IdTokenClaims | undefined;
|
|
14
14
|
signIn: (redirectUri: string) => Promise<void>;
|
|
15
|
-
signOut: (postLogoutRedirectUri
|
|
15
|
+
signOut: (postLogoutRedirectUri?: string) => Promise<void>;
|
|
16
16
|
};
|
|
17
17
|
/**
|
|
18
18
|
* Creates the Logto Vue plugin
|
package/lib/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"mappings":";;AGOA,YAAY,EACV,WAAW,EACX,aAAa,EACb,cAAc,EACd,oBAAoB,GACrB,MAAM,gBAAgB,CAAC;AAExB,OAAO,EAAE,UAAU,EAAE,gBAAgB,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAEjF,sBAAsB;IACpB,OAAO,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,WAAW,KAAK,IAAI,CAAC;CAClD,CAAC;AAEF,aAAa;IACX,eAAe,EAAE,QAAQ,CAAC,IAAI,OAAO,CAAC,CAAC,CAAC;IACxC,SAAS,EAAE,QAAQ,CAAC,IAAI,OAAO,CAAC,CAAC,CAAC;IAClC,KAAK,EAAE,QAAQ,CAAC,IAAI,KAAK,GAAG,SAAS,CAAC,CAAC,CAAC;IACxC,cAAc,EAAE,CAAC,QAAQ,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;IACnE,gBAAgB,EAAE,MAAM,aAAa,GAAG,SAAS,CAAC;IAClD,MAAM,EAAE,CAAC,WAAW,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAC/C,OAAO,EAAE,CAAC,qBAAqB,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;
|
|
1
|
+
{"mappings":";;AGOA,YAAY,EACV,WAAW,EACX,aAAa,EACb,cAAc,EACd,oBAAoB,GACrB,MAAM,gBAAgB,CAAC;AAExB,OAAO,EAAE,UAAU,EAAE,gBAAgB,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAEjF,sBAAsB;IACpB,OAAO,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,WAAW,KAAK,IAAI,CAAC;CAClD,CAAC;AAEF,aAAa;IACX,eAAe,EAAE,QAAQ,CAAC,IAAI,OAAO,CAAC,CAAC,CAAC;IACxC,SAAS,EAAE,QAAQ,CAAC,IAAI,OAAO,CAAC,CAAC,CAAC;IAClC,KAAK,EAAE,QAAQ,CAAC,IAAI,KAAK,GAAG,SAAS,CAAC,CAAC,CAAC;IACxC,cAAc,EAAE,CAAC,QAAQ,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;IACnE,gBAAgB,EAAE,MAAM,aAAa,GAAG,SAAS,CAAC;IAClD,MAAM,EAAE,CAAC,WAAW,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAC/C,OAAO,EAAE,CAAC,qBAAqB,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;CAC5D,CAAC;AAEF;;;;;;;;;;;;;;;;;GAiBG;AACH,OAAO,MAAM,aAAa,cAezB,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,OAAO,MAAM,gBAAe,KAQ3B,CAAC;AAEF;;;;;;;;;;;;;;;GAeG;AACH,OAAO,MAAM,4CAA4C,IAAI;;;;CAuB5D,CAAC","sources":["packages/vue/src/src/consts.ts","packages/vue/src/src/context.ts","packages/vue/src/src/plugin.ts","packages/vue/src/src/index.ts","packages/vue/src/index.ts"],"sourcesContent":[null,null,null,null,"import LogtoClient, { IdTokenClaims, LogtoConfig } from '@logto/browser';\nimport { App, inject, readonly, Ref, watchEffect } from 'vue';\n\nimport { logtoInjectionKey, contextInjectionKey } from './consts';\nimport { Context, createContext, throwContextError } from './context';\nimport { createPluginMethods } from './plugin';\n\nexport type {\n LogtoConfig,\n IdTokenClaims,\n LogtoErrorCode,\n LogtoClientErrorCode,\n} from '@logto/browser';\n\nexport { LogtoError, LogtoClientError, OidcError, Prompt } from '@logto/browser';\n\ntype LogtoVuePlugin = {\n install: (app: App, config: LogtoConfig) => void;\n};\n\ntype Logto = {\n isAuthenticated: Readonly<Ref<boolean>>;\n isLoading: Readonly<Ref<boolean>>;\n error: Readonly<Ref<Error | undefined>>;\n getAccessToken: (resource?: string) => Promise<string | undefined>;\n getIdTokenClaims: () => IdTokenClaims | undefined;\n signIn: (redirectUri: string) => Promise<void>;\n signOut: (postLogoutRedirectUri?: string) => Promise<void>;\n};\n\n/**\n * Creates the Logto Vue plugin\n *\n * ```ts\n * import { createApp } from 'vue';\n * import { createLogto } from '@logto/vue';\n *\n * const app = createApp(App);\n * const app.use(createLogto, {\n * appId: '<your-app-id>',\n * endpoint: '<your-oidc-endpoint-domain>',\n * });\n *\n * app.mount('#app');\n * ```\n *\n * Use this in your Vue root component to register the plugin\n */\nexport const createLogto: LogtoVuePlugin = {\n install(app: App, config: LogtoConfig) {\n const client = new LogtoClient(config);\n const context = createContext(client);\n const pluginMethods = createPluginMethods(context);\n const { isAuthenticated, isLoading, error } = context;\n\n app.provide<Context>(contextInjectionKey, context);\n app.provide<Logto>(logtoInjectionKey, {\n isAuthenticated: readonly(isAuthenticated),\n isLoading: readonly(isLoading),\n error: readonly(error),\n ...pluginMethods,\n });\n },\n};\n\n/**\n * A Vue composable method that provides the Logto reactive refs and auth methods.\n *\n * ```ts\n * import { useLogto } from '@logto/vue';\n *\n * export default {\n * setup() {\n * const { isAuthenticated, signIn } = useLogto();\n *\n * return {\n * isAuthenticated,\n * onClickSignIn: () => {\n * signIn('<your-redirect-uri>');\n * },\n * }\n * }\n * }\n * ```\n *\n * Use this composable in the setup script of your Vue component to make sure the injection works\n */\nexport const useLogto = (): Logto => {\n const logto = inject<Logto>(logtoInjectionKey);\n\n if (!logto) {\n return throwContextError();\n }\n\n return logto;\n};\n\n/**\n * A Vue composable method that watches browser navigation and automatically handles the sign-in callback\n *\n * ```ts\n * import { useLogto } from '@logto/vue';\n * import { useHandleSignInCallback } from '@logto/vue';\n *\n * export default {\n * setup() {\n * useHandleSignInCallback();\n * }\n * }\n * ```\n *\n * Use this in the setup script of your Callback page to make sure the injection works\n */\nexport const useHandleSignInCallback = (callback?: () => void) => {\n const context = inject<Context>(contextInjectionKey);\n\n if (!context) {\n return throwContextError();\n }\n\n const { isAuthenticated, isLoading, logtoClient, error } = context;\n const { handleSignInCallback } = createPluginMethods(context);\n\n watchEffect(() => {\n const currentPageUrl = window.location.href;\n\n if (!isAuthenticated.value && logtoClient.value?.isSignInRedirected(currentPageUrl)) {\n void handleSignInCallback(currentPageUrl, callback);\n }\n });\n\n return {\n isLoading: readonly(isLoading),\n isAuthenticated: readonly(isAuthenticated),\n error: readonly(error),\n };\n};\n"],"names":[],"version":3,"file":"index.d.ts.map"}
|
package/lib/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"mappings":";;;;;;;;;;;;;;;;;AAAA;;ACAO,MAAM,yCAAiB,GAAG,YAAY,AAAC;AACvC,MAAM,yCAAmB,GAAG,oBAAoB,AAAC;;;ACDxD;AAsBO,MAAM,yCAAa,GAAG,CAAC,MAAmB,GAAc;IAC7D,MAAM,OAAO,GAAG,CAAA,GAAA,iBAAM,CAAA,CACpB,CAAA,GAAA,mBAAQ,CAAA,CAAyB;QAC/B,WAAW,EAAE,MAAM;QACnB,eAAe,EAAE,MAAM,CAAC,eAAe;QACvC,YAAY,EAAE,CAAC;QACf,KAAK,EAAE,SAAS;KACjB,CAAC,CACH,AAAC;IAEF,MAAM,mBAAE,eAAe,CAAA,gBAAE,YAAY,CAAA,SAAE,KAAK,CAAA,EAAE,GAAG,OAAO,AAAC;IAEzD,MAAM,UAAS,GAAG,CAAA,GAAA,mBAAQ,CAAA,CAAC,IAAM,YAAY,CAAC,KAAK,GAAG,CAAC,CAAC,AAAC;IAEzD,+CAA+C,CAC/C,MAAM,QAAQ,GAAG,CAAC,MAAe,EAAE,oBAA6B,GAAK;QACnE,IAAI,MAAM,YAAY,KAAK,EACzB,KAAK,CAAC,KAAK,GAAG,MAAM,CAAC;aAChB,IAAI,oBAAoB,EAC7B,KAAK,CAAC,KAAK,GAAG,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAC;QAEhD,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;KACtB,AAAC;IAEF,MAAM,UAAU,GAAG,CAAC,SAAkB,GAAK;QACzC,IAAI,SAAS,EACX,YAAY,CAAC,KAAK,IAAI,CAAC,CAAC;aAExB,YAAY,CAAC,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,YAAY,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC;KAE5D,AAAC;IAEF,MAAM,kBAAkB,GAAG,CAAC,gBAAyB,GAAK;QACxD,eAAe,CAAC,KAAK,GAAG,gBAAgB,CAAC;KAC1C,AAAC;IACF,8CAA8C,CAE9C,OAAO;QAAE,GAAG,OAAO;QAAE,SAAS,EAAT,UAAS;kBAAE,QAAQ;oBAAE,UAAU;4BAAE,kBAAkB;KAAE,CAAC;CAC5E,AAAC;AAEK,MAAM,yCAAiB,GAAG,IAAa;IAC5C,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAC;CACrD,AAAC;;;AChEF;AAEO,MAAM,uCAAmB,GAAG,CAAC,OAAgB,GAAK;IACvD,MAAM,eAAE,WAAW,CAAA,cAAE,UAAU,CAAA,YAAE,QAAQ,CAAA,sBAAE,kBAAkB,CAAA,EAAE,GAAG,OAAO,AAAC;IAE1E,MAAM,MAAM,GAAG,OAAO,WAAmB,GAAK;QAC5C,IAAI,CAAC,WAAW,CAAC,KAAK,EACpB,OAAO,CAAA,GAAA,yCAAiB,CAAA,EAAE,CAAC;QAG7B,IAAI;YACF,UAAU,CAAC,IAAI,CAAC,CAAC;YAEjB,MAAM,WAAW,CAAC,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;SAC7C,CAAC,OAAO,KAAK,EAAW;YACvB,QAAQ,CAAC,KAAK,EAAE,6CAA6C,CAAC,CAAC;SAChE,QAAS;YACR,UAAU,CAAC,KAAK,CAAC,CAAC;SACnB;KACF,AAAC;IAEF,MAAM,OAAO,GAAG,OAAO,qBAA6B,GAAK;QACvD,IAAI,CAAC,WAAW,CAAC,KAAK,EACpB,OAAO,CAAA,GAAA,yCAAiB,CAAA,EAAE,CAAC;QAG7B,IAAI;YACF,UAAU,CAAC,IAAI,CAAC,CAAC;YAEjB,MAAM,WAAW,CAAC,KAAK,CAAC,OAAO,CAAC,qBAAqB,CAAC,CAAC;QAEvD,yGAAyG;QACzG,iGAAiG;QACjG,uGAAuG;SACxG,CAAC,OAAO,KAAK,EAAW;YACvB,QAAQ,CAAC,KAAK,EAAE,8CAA8C,CAAC,CAAC;SACjE,QAAS;YACR,UAAU,CAAC,KAAK,CAAC,CAAC;SACnB;KACF,AAAC;IAEF,MAAM,cAAc,GAAG,OAAO,QAAiB,GAAK;QAClD,IAAI,CAAC,WAAW,CAAC,KAAK,EACpB,OAAO,CAAA,GAAA,yCAAiB,CAAA,EAAE,CAAC;QAG7B,IAAI;YACF,UAAU,CAAC,IAAI,CAAC,CAAC;YAEjB,OAAO,MAAM,WAAW,CAAC,KAAK,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;SACzD,CAAC,OAAO,KAAK,EAAW;YACvB,QAAQ,CAAC,KAAK,EAAE,uDAAuD,CAAC,CAAC;SAC1E,QAAS;YACR,UAAU,CAAC,KAAK,CAAC,CAAC;SACnB;KACF,AAAC;IAEF,MAAM,gBAAgB,GAAG,IAAM;QAC7B,IAAI,CAAC,WAAW,CAAC,KAAK,EACpB,OAAO,CAAA,GAAA,yCAAiB,CAAA,EAAE,CAAC;QAG7B,IAAI;YACF,OAAO,WAAW,CAAC,KAAK,CAAC,gBAAgB,EAAE,CAAC;SAC7C,CAAC,OAAO,KAAK,EAAW;YACvB,QAAQ,CAAC,KAAK,EAAE,0DAA0D,CAAC,CAAC;SAC7E;KACF,AAAC;IAEF,MAAM,oBAAoB,GAAG,OAAO,WAAmB,EAAE,gBAA6B,GAAK;QACzF,IAAI,CAAC,WAAW,CAAC,KAAK,EACpB,OAAO,CAAA,GAAA,yCAAiB,CAAA,EAAE,CAAC;QAG7B,IAAI;YACF,UAAU,CAAC,IAAI,CAAC,CAAC;YACjB,MAAM,WAAW,CAAC,KAAK,CAAC,oBAAoB,CAAC,WAAW,CAAC,CAAC;YAC1D,kBAAkB,CAAC,IAAI,CAAC,CAAC;YACzB,gBAAgB,IAAI,CAAC;SACtB,CAAC,OAAO,KAAK,EAAW;YACvB,QAAQ,CAAC,KAAK,EAAE,4DAA4D,CAAC,CAAC;SAC/E,QAAS;YACR,UAAU,CAAC,KAAK,CAAC,CAAC;SACnB;KACF,AAAC;IAEF,OAAO;gBACL,MAAM;iBACN,OAAO;wBACP,cAAc;0BACd,gBAAgB;8BAChB,oBAAoB;KACrB,CAAC;CACH,AAAC;;;;AH7CK,MAAM,yCAAW,GAAmB;IACzC,OAAO,EAAC,GAAQ,EAAE,MAAmB,EAAE;QACrC,MAAM,MAAM,GAAG,IAAI,CAAA,GAAA,6CAAW,CAAA,CAAC,MAAM,CAAC,AAAC;QACvC,MAAM,OAAO,GAAG,CAAA,GAAA,yCAAa,CAAA,CAAC,MAAM,CAAC,AAAC;QACtC,MAAM,aAAa,GAAG,CAAA,GAAA,uCAAmB,CAAA,CAAC,OAAO,CAAC,AAAC;QACnD,MAAM,mBAAE,eAAe,CAAA,aAAE,SAAS,CAAA,SAAE,KAAK,CAAA,EAAE,GAAG,OAAO,AAAC;QAEtD,GAAG,CAAC,OAAO,CAAU,CAAA,GAAA,yCAAmB,CAAA,EAAE,OAAO,CAAC,CAAC;QACnD,GAAG,CAAC,OAAO,CAAQ,CAAA,GAAA,yCAAiB,CAAA,EAAE;YACpC,eAAe,EAAE,CAAA,GAAA,mBAAQ,CAAA,CAAC,eAAe,CAAC;YAC1C,SAAS,EAAE,CAAA,GAAA,mBAAQ,CAAA,CAAC,SAAS,CAAC;YAC9B,KAAK,EAAE,CAAA,GAAA,mBAAQ,CAAA,CAAC,KAAK,CAAC;YACtB,GAAG,aAAa;SACjB,CAAC,CAAC;KACJ;CACF,AAAC;AAwBK,MAAM,yCAAQ,GAAG,IAAa;IACnC,MAAM,KAAK,GAAG,CAAA,GAAA,iBAAM,CAAA,CAAQ,CAAA,GAAA,yCAAiB,CAAA,CAAC,AAAC;IAE/C,IAAI,CAAC,KAAK,EACR,OAAO,CAAA,GAAA,yCAAiB,CAAA,EAAE,CAAC;IAG7B,OAAO,KAAK,CAAC;CACd,AAAC;AAkBK,MAAM,yCAAuB,GAAG,CAAC,QAAqB,GAAK;IAChE,MAAM,OAAO,GAAG,CAAA,GAAA,iBAAM,CAAA,CAAU,CAAA,GAAA,yCAAmB,CAAA,CAAC,AAAC;IAErD,IAAI,CAAC,OAAO,EACV,OAAO,CAAA,GAAA,yCAAiB,CAAA,EAAE,CAAC;IAG7B,MAAM,mBAAE,eAAe,CAAA,aAAE,SAAS,CAAA,eAAE,WAAW,CAAA,SAAE,KAAK,CAAA,EAAE,GAAG,OAAO,AAAC;IACnE,MAAM,wBAAE,oBAAoB,CAAA,EAAE,GAAG,CAAA,GAAA,uCAAmB,CAAA,CAAC,OAAO,CAAC,AAAC;IAE9D,CAAA,GAAA,sBAAW,CAAA,CAAC,IAAM;QAChB,MAAM,cAAc,GAAG,MAAM,CAAC,QAAQ,CAAC,IAAI,AAAC;QAE5C,IAAI,CAAC,eAAe,CAAC,KAAK,IAAI,WAAW,CAAC,KAAK,EAAE,kBAAkB,CAAC,cAAc,CAAC,EAC5E,oBAAoB,CAAC,cAAc,EAAE,QAAQ,CAAC,CAAC;KAEvD,CAAC,CAAC;IAEH,OAAO;QACL,SAAS,EAAE,CAAA,GAAA,mBAAQ,CAAA,CAAC,SAAS,CAAC;QAC9B,eAAe,EAAE,CAAA,GAAA,mBAAQ,CAAA,CAAC,eAAe,CAAC;QAC1C,KAAK,EAAE,CAAA,GAAA,mBAAQ,CAAA,CAAC,KAAK,CAAC;KACvB,CAAC;CACH,AAAC","sources":["packages/vue/src/index.ts","packages/vue/src/consts.ts","packages/vue/src/context.ts","packages/vue/src/plugin.ts"],"sourcesContent":["import LogtoClient, { IdTokenClaims, LogtoConfig } from '@logto/browser';\nimport { App, inject, readonly, Ref, watchEffect } from 'vue';\n\nimport { logtoInjectionKey, contextInjectionKey } from './consts';\nimport { Context, createContext, throwContextError } from './context';\nimport { createPluginMethods } from './plugin';\n\nexport type {\n LogtoConfig,\n IdTokenClaims,\n LogtoErrorCode,\n LogtoClientErrorCode,\n} from '@logto/browser';\n\nexport { LogtoError, LogtoClientError, OidcError, Prompt } from '@logto/browser';\n\ntype LogtoVuePlugin = {\n install: (app: App, config: LogtoConfig) => void;\n};\n\ntype Logto = {\n isAuthenticated: Readonly<Ref<boolean>>;\n isLoading: Readonly<Ref<boolean>>;\n error: Readonly<Ref<Error | undefined>>;\n getAccessToken: (resource?: string) => Promise<string | undefined>;\n getIdTokenClaims: () => IdTokenClaims | undefined;\n signIn: (redirectUri: string) => Promise<void>;\n signOut: (postLogoutRedirectUri: string) => Promise<void>;\n};\n\n/**\n * Creates the Logto Vue plugin\n *\n * ```ts\n * import { createApp } from 'vue';\n * import { createLogto } from '@logto/vue';\n *\n * const app = createApp(App);\n * const app.use(createLogto, {\n * appId: '<your-app-id>',\n * endpoint: '<your-oidc-endpoint-domain>',\n * });\n *\n * app.mount('#app');\n * ```\n *\n * Use this in your Vue root component to register the plugin\n */\nexport const createLogto: LogtoVuePlugin = {\n install(app: App, config: LogtoConfig) {\n const client = new LogtoClient(config);\n const context = createContext(client);\n const pluginMethods = createPluginMethods(context);\n const { isAuthenticated, isLoading, error } = context;\n\n app.provide<Context>(contextInjectionKey, context);\n app.provide<Logto>(logtoInjectionKey, {\n isAuthenticated: readonly(isAuthenticated),\n isLoading: readonly(isLoading),\n error: readonly(error),\n ...pluginMethods,\n });\n },\n};\n\n/**\n * A Vue composable method that provides the Logto reactive refs and auth methods.\n *\n * ```ts\n * import { useLogto } from '@logto/vue';\n *\n * export default {\n * setup() {\n * const { isAuthenticated, signIn } = useLogto();\n *\n * return {\n * isAuthenticated,\n * onClickSignIn: () => {\n * signIn('<your-redirect-uri>');\n * },\n * }\n * }\n * }\n * ```\n *\n * Use this composable in the setup script of your Vue component to make sure the injection works\n */\nexport const useLogto = (): Logto => {\n const logto = inject<Logto>(logtoInjectionKey);\n\n if (!logto) {\n return throwContextError();\n }\n\n return logto;\n};\n\n/**\n * A Vue composable method that watches browser navigation and automatically handles the sign-in callback\n *\n * ```ts\n * import { useLogto } from '@logto/vue';\n * import { useHandleSignInCallback } from '@logto/vue';\n *\n * export default {\n * setup() {\n * useHandleSignInCallback();\n * }\n * }\n * ```\n *\n * Use this in the setup script of your Callback page to make sure the injection works\n */\nexport const useHandleSignInCallback = (callback?: () => void) => {\n const context = inject<Context>(contextInjectionKey);\n\n if (!context) {\n return throwContextError();\n }\n\n const { isAuthenticated, isLoading, logtoClient, error } = context;\n const { handleSignInCallback } = createPluginMethods(context);\n\n watchEffect(() => {\n const currentPageUrl = window.location.href;\n\n if (!isAuthenticated.value && logtoClient.value?.isSignInRedirected(currentPageUrl)) {\n void handleSignInCallback(currentPageUrl, callback);\n }\n });\n\n return {\n isLoading: readonly(isLoading),\n isAuthenticated: readonly(isAuthenticated),\n error: readonly(error),\n };\n};\n","export const logtoInjectionKey = '@logto/vue';\nexport const contextInjectionKey = '@logto/vue:context';\n","import LogtoClient from '@logto/browser';\nimport { computed, ComputedRef, reactive, Ref, toRefs, UnwrapRef } from 'vue';\n\ntype LogtoContextProperties = {\n logtoClient: LogtoClient | undefined;\n isAuthenticated: boolean;\n loadingCount: number;\n error: Error | undefined;\n};\n\nexport type Context = {\n // Wrong type workaround. https://github.com/vuejs/core/issues/2981\n logtoClient: Ref<UnwrapRef<LogtoClient | undefined>>;\n isAuthenticated: Ref<boolean>;\n loadingCount: Ref<number>;\n error: Ref<Error | undefined>;\n isLoading: ComputedRef<boolean>;\n setError: (error: unknown, fallbackErrorMessage?: string | undefined) => void;\n setIsAuthenticated: (isAuthenticated: boolean) => void;\n setLoading: (isLoading: boolean) => void;\n};\n\nexport const createContext = (client: LogtoClient): Context => {\n const context = toRefs(\n reactive<LogtoContextProperties>({\n logtoClient: client,\n isAuthenticated: client.isAuthenticated,\n loadingCount: 0,\n error: undefined,\n })\n );\n\n const { isAuthenticated, loadingCount, error } = context;\n\n const isLoading = computed(() => loadingCount.value > 0);\n\n /* eslint-disable @silverhand/fp/no-mutation */\n const setError = (_error: unknown, fallbackErrorMessage?: string) => {\n if (_error instanceof Error) {\n error.value = _error;\n } else if (fallbackErrorMessage) {\n error.value = new Error(fallbackErrorMessage);\n }\n console.error(error);\n };\n\n const setLoading = (isLoading: boolean) => {\n if (isLoading) {\n loadingCount.value += 1;\n } else {\n loadingCount.value = Math.max(0, loadingCount.value - 1);\n }\n };\n\n const setIsAuthenticated = (_isAuthenticated: boolean) => {\n isAuthenticated.value = _isAuthenticated;\n };\n /* eslint-enable @silverhand/fp/no-mutation */\n\n return { ...context, isLoading, setError, setLoading, setIsAuthenticated };\n};\n\nexport const throwContextError = (): never => {\n throw new Error('Must install Logto plugin first.');\n};\n","import { Context, throwContextError } from './context';\n\nexport const createPluginMethods = (context: Context) => {\n const { logtoClient, setLoading, setError, setIsAuthenticated } = context;\n\n const signIn = async (redirectUri: string) => {\n if (!logtoClient.value) {\n return throwContextError();\n }\n\n try {\n setLoading(true);\n\n await logtoClient.value.signIn(redirectUri);\n } catch (error: unknown) {\n setError(error, 'Unexpected error occurred while signing in.');\n } finally {\n setLoading(false);\n }\n };\n\n const signOut = async (postLogoutRedirectUri: string) => {\n if (!logtoClient.value) {\n return throwContextError();\n }\n\n try {\n setLoading(true);\n\n await logtoClient.value.signOut(postLogoutRedirectUri);\n\n // We deliberately do NOT set isAuthenticated to false here, because the app state may change immediately\n // even before navigating to the oidc end session endpoint, which might cause rendering problems.\n // Moreover, since the location will be redirected, the isAuthenticated state will not matter any more.\n } catch (error: unknown) {\n setError(error, 'Unexpected error occurred while signing out.');\n } finally {\n setLoading(false);\n }\n };\n\n const getAccessToken = async (resource?: string) => {\n if (!logtoClient.value) {\n return throwContextError();\n }\n\n try {\n setLoading(true);\n\n return await logtoClient.value.getAccessToken(resource);\n } catch (error: unknown) {\n setError(error, 'Unexpected error occurred while getting access token.');\n } finally {\n setLoading(false);\n }\n };\n\n const getIdTokenClaims = () => {\n if (!logtoClient.value) {\n return throwContextError();\n }\n\n try {\n return logtoClient.value.getIdTokenClaims();\n } catch (error: unknown) {\n setError(error, 'Unexpected error occurred while getting id token claims.');\n }\n };\n\n const handleSignInCallback = async (callbackUri: string, callbackFunction?: () => void) => {\n if (!logtoClient.value) {\n return throwContextError();\n }\n\n try {\n setLoading(true);\n await logtoClient.value.handleSignInCallback(callbackUri);\n setIsAuthenticated(true);\n callbackFunction?.();\n } catch (error: unknown) {\n setError(error, 'Unexpected error occurred while handling sign in callback.');\n } finally {\n setLoading(false);\n }\n };\n\n return {\n signIn,\n signOut,\n getAccessToken,\n getIdTokenClaims,\n handleSignInCallback,\n };\n};\n"],"names":[],"version":3,"file":"index.js.map"}
|
|
1
|
+
{"mappings":";;;;;;;;;;;;;;;;;AAAA;;ACAO,MAAM,yCAAiB,GAAG,YAAY,AAAC;AACvC,MAAM,yCAAmB,GAAG,oBAAoB,AAAC;;;ACDxD;AAsBO,MAAM,yCAAa,GAAG,CAAC,MAAmB,GAAc;IAC7D,MAAM,OAAO,GAAG,CAAA,GAAA,iBAAM,CAAA,CACpB,CAAA,GAAA,mBAAQ,CAAA,CAAyB;QAC/B,WAAW,EAAE,MAAM;QACnB,eAAe,EAAE,MAAM,CAAC,eAAe;QACvC,YAAY,EAAE,CAAC;QACf,KAAK,EAAE,SAAS;KACjB,CAAC,CACH,AAAC;IAEF,MAAM,mBAAE,eAAe,CAAA,gBAAE,YAAY,CAAA,SAAE,KAAK,CAAA,EAAE,GAAG,OAAO,AAAC;IAEzD,MAAM,UAAS,GAAG,CAAA,GAAA,mBAAQ,CAAA,CAAC,IAAM,YAAY,CAAC,KAAK,GAAG,CAAC,CAAC,AAAC;IAEzD,+CAA+C,CAC/C,MAAM,QAAQ,GAAG,CAAC,MAAe,EAAE,oBAA6B,GAAK;QACnE,IAAI,MAAM,YAAY,KAAK,EACzB,KAAK,CAAC,KAAK,GAAG,MAAM,CAAC;aAChB,IAAI,oBAAoB,EAC7B,KAAK,CAAC,KAAK,GAAG,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAC;QAEhD,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;KACtB,AAAC;IAEF,MAAM,UAAU,GAAG,CAAC,SAAkB,GAAK;QACzC,IAAI,SAAS,EACX,YAAY,CAAC,KAAK,IAAI,CAAC,CAAC;aAExB,YAAY,CAAC,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,YAAY,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC;KAE5D,AAAC;IAEF,MAAM,kBAAkB,GAAG,CAAC,gBAAyB,GAAK;QACxD,eAAe,CAAC,KAAK,GAAG,gBAAgB,CAAC;KAC1C,AAAC;IACF,8CAA8C,CAE9C,OAAO;QAAE,GAAG,OAAO;QAAE,SAAS,EAAT,UAAS;kBAAE,QAAQ;oBAAE,UAAU;4BAAE,kBAAkB;KAAE,CAAC;CAC5E,AAAC;AAEK,MAAM,yCAAiB,GAAG,IAAa;IAC5C,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAC;CACrD,AAAC;;;AChEF;AAEO,MAAM,uCAAmB,GAAG,CAAC,OAAgB,GAAK;IACvD,MAAM,eAAE,WAAW,CAAA,cAAE,UAAU,CAAA,YAAE,QAAQ,CAAA,sBAAE,kBAAkB,CAAA,EAAE,GAAG,OAAO,AAAC;IAE1E,MAAM,MAAM,GAAG,OAAO,WAAmB,GAAK;QAC5C,IAAI,CAAC,WAAW,CAAC,KAAK,EACpB,OAAO,CAAA,GAAA,yCAAiB,CAAA,EAAE,CAAC;QAG7B,IAAI;YACF,UAAU,CAAC,IAAI,CAAC,CAAC;YAEjB,MAAM,WAAW,CAAC,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;SAC7C,CAAC,OAAO,KAAK,EAAW;YACvB,QAAQ,CAAC,KAAK,EAAE,6CAA6C,CAAC,CAAC;SAChE,QAAS;YACR,UAAU,CAAC,KAAK,CAAC,CAAC;SACnB;KACF,AAAC;IAEF,MAAM,OAAO,GAAG,OAAO,qBAA8B,GAAK;QACxD,IAAI,CAAC,WAAW,CAAC,KAAK,EACpB,OAAO,CAAA,GAAA,yCAAiB,CAAA,EAAE,CAAC;QAG7B,IAAI;YACF,UAAU,CAAC,IAAI,CAAC,CAAC;YAEjB,MAAM,WAAW,CAAC,KAAK,CAAC,OAAO,CAAC,qBAAqB,CAAC,CAAC;QAEvD,yGAAyG;QACzG,iGAAiG;QACjG,uGAAuG;SACxG,CAAC,OAAO,KAAK,EAAW;YACvB,QAAQ,CAAC,KAAK,EAAE,8CAA8C,CAAC,CAAC;SACjE,QAAS;YACR,UAAU,CAAC,KAAK,CAAC,CAAC;SACnB;KACF,AAAC;IAEF,MAAM,cAAc,GAAG,OAAO,QAAiB,GAAK;QAClD,IAAI,CAAC,WAAW,CAAC,KAAK,EACpB,OAAO,CAAA,GAAA,yCAAiB,CAAA,EAAE,CAAC;QAG7B,IAAI;YACF,UAAU,CAAC,IAAI,CAAC,CAAC;YAEjB,OAAO,MAAM,WAAW,CAAC,KAAK,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;SACzD,CAAC,OAAO,KAAK,EAAW;YACvB,QAAQ,CAAC,KAAK,EAAE,uDAAuD,CAAC,CAAC;SAC1E,QAAS;YACR,UAAU,CAAC,KAAK,CAAC,CAAC;SACnB;KACF,AAAC;IAEF,MAAM,gBAAgB,GAAG,IAAM;QAC7B,IAAI,CAAC,WAAW,CAAC,KAAK,EACpB,OAAO,CAAA,GAAA,yCAAiB,CAAA,EAAE,CAAC;QAG7B,IAAI;YACF,OAAO,WAAW,CAAC,KAAK,CAAC,gBAAgB,EAAE,CAAC;SAC7C,CAAC,OAAO,KAAK,EAAW;YACvB,QAAQ,CAAC,KAAK,EAAE,0DAA0D,CAAC,CAAC;SAC7E;KACF,AAAC;IAEF,MAAM,oBAAoB,GAAG,OAAO,WAAmB,EAAE,gBAA6B,GAAK;QACzF,IAAI,CAAC,WAAW,CAAC,KAAK,EACpB,OAAO,CAAA,GAAA,yCAAiB,CAAA,EAAE,CAAC;QAG7B,IAAI;YACF,UAAU,CAAC,IAAI,CAAC,CAAC;YACjB,MAAM,WAAW,CAAC,KAAK,CAAC,oBAAoB,CAAC,WAAW,CAAC,CAAC;YAC1D,kBAAkB,CAAC,IAAI,CAAC,CAAC;YACzB,gBAAgB,IAAI,CAAC;SACtB,CAAC,OAAO,KAAK,EAAW;YACvB,QAAQ,CAAC,KAAK,EAAE,4DAA4D,CAAC,CAAC;SAC/E,QAAS;YACR,UAAU,CAAC,KAAK,CAAC,CAAC;SACnB;KACF,AAAC;IAEF,OAAO;gBACL,MAAM;iBACN,OAAO;wBACP,cAAc;0BACd,gBAAgB;8BAChB,oBAAoB;KACrB,CAAC;CACH,AAAC;;;;AH7CK,MAAM,yCAAW,GAAmB;IACzC,OAAO,EAAC,GAAQ,EAAE,MAAmB,EAAE;QACrC,MAAM,MAAM,GAAG,IAAI,CAAA,GAAA,6CAAW,CAAA,CAAC,MAAM,CAAC,AAAC;QACvC,MAAM,OAAO,GAAG,CAAA,GAAA,yCAAa,CAAA,CAAC,MAAM,CAAC,AAAC;QACtC,MAAM,aAAa,GAAG,CAAA,GAAA,uCAAmB,CAAA,CAAC,OAAO,CAAC,AAAC;QACnD,MAAM,mBAAE,eAAe,CAAA,aAAE,SAAS,CAAA,SAAE,KAAK,CAAA,EAAE,GAAG,OAAO,AAAC;QAEtD,GAAG,CAAC,OAAO,CAAU,CAAA,GAAA,yCAAmB,CAAA,EAAE,OAAO,CAAC,CAAC;QACnD,GAAG,CAAC,OAAO,CAAQ,CAAA,GAAA,yCAAiB,CAAA,EAAE;YACpC,eAAe,EAAE,CAAA,GAAA,mBAAQ,CAAA,CAAC,eAAe,CAAC;YAC1C,SAAS,EAAE,CAAA,GAAA,mBAAQ,CAAA,CAAC,SAAS,CAAC;YAC9B,KAAK,EAAE,CAAA,GAAA,mBAAQ,CAAA,CAAC,KAAK,CAAC;YACtB,GAAG,aAAa;SACjB,CAAC,CAAC;KACJ;CACF,AAAC;AAwBK,MAAM,yCAAQ,GAAG,IAAa;IACnC,MAAM,KAAK,GAAG,CAAA,GAAA,iBAAM,CAAA,CAAQ,CAAA,GAAA,yCAAiB,CAAA,CAAC,AAAC;IAE/C,IAAI,CAAC,KAAK,EACR,OAAO,CAAA,GAAA,yCAAiB,CAAA,EAAE,CAAC;IAG7B,OAAO,KAAK,CAAC;CACd,AAAC;AAkBK,MAAM,yCAAuB,GAAG,CAAC,QAAqB,GAAK;IAChE,MAAM,OAAO,GAAG,CAAA,GAAA,iBAAM,CAAA,CAAU,CAAA,GAAA,yCAAmB,CAAA,CAAC,AAAC;IAErD,IAAI,CAAC,OAAO,EACV,OAAO,CAAA,GAAA,yCAAiB,CAAA,EAAE,CAAC;IAG7B,MAAM,mBAAE,eAAe,CAAA,aAAE,SAAS,CAAA,eAAE,WAAW,CAAA,SAAE,KAAK,CAAA,EAAE,GAAG,OAAO,AAAC;IACnE,MAAM,wBAAE,oBAAoB,CAAA,EAAE,GAAG,CAAA,GAAA,uCAAmB,CAAA,CAAC,OAAO,CAAC,AAAC;IAE9D,CAAA,GAAA,sBAAW,CAAA,CAAC,IAAM;QAChB,MAAM,cAAc,GAAG,MAAM,CAAC,QAAQ,CAAC,IAAI,AAAC;QAE5C,IAAI,CAAC,eAAe,CAAC,KAAK,IAAI,WAAW,CAAC,KAAK,EAAE,kBAAkB,CAAC,cAAc,CAAC,EAC5E,oBAAoB,CAAC,cAAc,EAAE,QAAQ,CAAC,CAAC;KAEvD,CAAC,CAAC;IAEH,OAAO;QACL,SAAS,EAAE,CAAA,GAAA,mBAAQ,CAAA,CAAC,SAAS,CAAC;QAC9B,eAAe,EAAE,CAAA,GAAA,mBAAQ,CAAA,CAAC,eAAe,CAAC;QAC1C,KAAK,EAAE,CAAA,GAAA,mBAAQ,CAAA,CAAC,KAAK,CAAC;KACvB,CAAC;CACH,AAAC","sources":["packages/vue/src/index.ts","packages/vue/src/consts.ts","packages/vue/src/context.ts","packages/vue/src/plugin.ts"],"sourcesContent":["import LogtoClient, { IdTokenClaims, LogtoConfig } from '@logto/browser';\nimport { App, inject, readonly, Ref, watchEffect } from 'vue';\n\nimport { logtoInjectionKey, contextInjectionKey } from './consts';\nimport { Context, createContext, throwContextError } from './context';\nimport { createPluginMethods } from './plugin';\n\nexport type {\n LogtoConfig,\n IdTokenClaims,\n LogtoErrorCode,\n LogtoClientErrorCode,\n} from '@logto/browser';\n\nexport { LogtoError, LogtoClientError, OidcError, Prompt } from '@logto/browser';\n\ntype LogtoVuePlugin = {\n install: (app: App, config: LogtoConfig) => void;\n};\n\ntype Logto = {\n isAuthenticated: Readonly<Ref<boolean>>;\n isLoading: Readonly<Ref<boolean>>;\n error: Readonly<Ref<Error | undefined>>;\n getAccessToken: (resource?: string) => Promise<string | undefined>;\n getIdTokenClaims: () => IdTokenClaims | undefined;\n signIn: (redirectUri: string) => Promise<void>;\n signOut: (postLogoutRedirectUri?: string) => Promise<void>;\n};\n\n/**\n * Creates the Logto Vue plugin\n *\n * ```ts\n * import { createApp } from 'vue';\n * import { createLogto } from '@logto/vue';\n *\n * const app = createApp(App);\n * const app.use(createLogto, {\n * appId: '<your-app-id>',\n * endpoint: '<your-oidc-endpoint-domain>',\n * });\n *\n * app.mount('#app');\n * ```\n *\n * Use this in your Vue root component to register the plugin\n */\nexport const createLogto: LogtoVuePlugin = {\n install(app: App, config: LogtoConfig) {\n const client = new LogtoClient(config);\n const context = createContext(client);\n const pluginMethods = createPluginMethods(context);\n const { isAuthenticated, isLoading, error } = context;\n\n app.provide<Context>(contextInjectionKey, context);\n app.provide<Logto>(logtoInjectionKey, {\n isAuthenticated: readonly(isAuthenticated),\n isLoading: readonly(isLoading),\n error: readonly(error),\n ...pluginMethods,\n });\n },\n};\n\n/**\n * A Vue composable method that provides the Logto reactive refs and auth methods.\n *\n * ```ts\n * import { useLogto } from '@logto/vue';\n *\n * export default {\n * setup() {\n * const { isAuthenticated, signIn } = useLogto();\n *\n * return {\n * isAuthenticated,\n * onClickSignIn: () => {\n * signIn('<your-redirect-uri>');\n * },\n * }\n * }\n * }\n * ```\n *\n * Use this composable in the setup script of your Vue component to make sure the injection works\n */\nexport const useLogto = (): Logto => {\n const logto = inject<Logto>(logtoInjectionKey);\n\n if (!logto) {\n return throwContextError();\n }\n\n return logto;\n};\n\n/**\n * A Vue composable method that watches browser navigation and automatically handles the sign-in callback\n *\n * ```ts\n * import { useLogto } from '@logto/vue';\n * import { useHandleSignInCallback } from '@logto/vue';\n *\n * export default {\n * setup() {\n * useHandleSignInCallback();\n * }\n * }\n * ```\n *\n * Use this in the setup script of your Callback page to make sure the injection works\n */\nexport const useHandleSignInCallback = (callback?: () => void) => {\n const context = inject<Context>(contextInjectionKey);\n\n if (!context) {\n return throwContextError();\n }\n\n const { isAuthenticated, isLoading, logtoClient, error } = context;\n const { handleSignInCallback } = createPluginMethods(context);\n\n watchEffect(() => {\n const currentPageUrl = window.location.href;\n\n if (!isAuthenticated.value && logtoClient.value?.isSignInRedirected(currentPageUrl)) {\n void handleSignInCallback(currentPageUrl, callback);\n }\n });\n\n return {\n isLoading: readonly(isLoading),\n isAuthenticated: readonly(isAuthenticated),\n error: readonly(error),\n };\n};\n","export const logtoInjectionKey = '@logto/vue';\nexport const contextInjectionKey = '@logto/vue:context';\n","import LogtoClient from '@logto/browser';\nimport { computed, ComputedRef, reactive, Ref, toRefs, UnwrapRef } from 'vue';\n\ntype LogtoContextProperties = {\n logtoClient: LogtoClient | undefined;\n isAuthenticated: boolean;\n loadingCount: number;\n error: Error | undefined;\n};\n\nexport type Context = {\n // Wrong type workaround. https://github.com/vuejs/core/issues/2981\n logtoClient: Ref<UnwrapRef<LogtoClient | undefined>>;\n isAuthenticated: Ref<boolean>;\n loadingCount: Ref<number>;\n error: Ref<Error | undefined>;\n isLoading: ComputedRef<boolean>;\n setError: (error: unknown, fallbackErrorMessage?: string | undefined) => void;\n setIsAuthenticated: (isAuthenticated: boolean) => void;\n setLoading: (isLoading: boolean) => void;\n};\n\nexport const createContext = (client: LogtoClient): Context => {\n const context = toRefs(\n reactive<LogtoContextProperties>({\n logtoClient: client,\n isAuthenticated: client.isAuthenticated,\n loadingCount: 0,\n error: undefined,\n })\n );\n\n const { isAuthenticated, loadingCount, error } = context;\n\n const isLoading = computed(() => loadingCount.value > 0);\n\n /* eslint-disable @silverhand/fp/no-mutation */\n const setError = (_error: unknown, fallbackErrorMessage?: string) => {\n if (_error instanceof Error) {\n error.value = _error;\n } else if (fallbackErrorMessage) {\n error.value = new Error(fallbackErrorMessage);\n }\n console.error(error);\n };\n\n const setLoading = (isLoading: boolean) => {\n if (isLoading) {\n loadingCount.value += 1;\n } else {\n loadingCount.value = Math.max(0, loadingCount.value - 1);\n }\n };\n\n const setIsAuthenticated = (_isAuthenticated: boolean) => {\n isAuthenticated.value = _isAuthenticated;\n };\n /* eslint-enable @silverhand/fp/no-mutation */\n\n return { ...context, isLoading, setError, setLoading, setIsAuthenticated };\n};\n\nexport const throwContextError = (): never => {\n throw new Error('Must install Logto plugin first.');\n};\n","import { Context, throwContextError } from './context';\n\nexport const createPluginMethods = (context: Context) => {\n const { logtoClient, setLoading, setError, setIsAuthenticated } = context;\n\n const signIn = async (redirectUri: string) => {\n if (!logtoClient.value) {\n return throwContextError();\n }\n\n try {\n setLoading(true);\n\n await logtoClient.value.signIn(redirectUri);\n } catch (error: unknown) {\n setError(error, 'Unexpected error occurred while signing in.');\n } finally {\n setLoading(false);\n }\n };\n\n const signOut = async (postLogoutRedirectUri?: string) => {\n if (!logtoClient.value) {\n return throwContextError();\n }\n\n try {\n setLoading(true);\n\n await logtoClient.value.signOut(postLogoutRedirectUri);\n\n // We deliberately do NOT set isAuthenticated to false here, because the app state may change immediately\n // even before navigating to the oidc end session endpoint, which might cause rendering problems.\n // Moreover, since the location will be redirected, the isAuthenticated state will not matter any more.\n } catch (error: unknown) {\n setError(error, 'Unexpected error occurred while signing out.');\n } finally {\n setLoading(false);\n }\n };\n\n const getAccessToken = async (resource?: string) => {\n if (!logtoClient.value) {\n return throwContextError();\n }\n\n try {\n setLoading(true);\n\n return await logtoClient.value.getAccessToken(resource);\n } catch (error: unknown) {\n setError(error, 'Unexpected error occurred while getting access token.');\n } finally {\n setLoading(false);\n }\n };\n\n const getIdTokenClaims = () => {\n if (!logtoClient.value) {\n return throwContextError();\n }\n\n try {\n return logtoClient.value.getIdTokenClaims();\n } catch (error: unknown) {\n setError(error, 'Unexpected error occurred while getting id token claims.');\n }\n };\n\n const handleSignInCallback = async (callbackUri: string, callbackFunction?: () => void) => {\n if (!logtoClient.value) {\n return throwContextError();\n }\n\n try {\n setLoading(true);\n await logtoClient.value.handleSignInCallback(callbackUri);\n setIsAuthenticated(true);\n callbackFunction?.();\n } catch (error: unknown) {\n setError(error, 'Unexpected error occurred while handling sign in callback.');\n } finally {\n setLoading(false);\n }\n };\n\n return {\n signIn,\n signOut,\n getAccessToken,\n getIdTokenClaims,\n handleSignInCallback,\n };\n};\n"],"names":[],"version":3,"file":"index.js.map"}
|
package/lib/module.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"mappings":";;;AAAA;;ACAO,MAAM,yCAAiB,GAAG,YAAY,AAAC;AACvC,MAAM,yCAAmB,GAAG,oBAAoB,AAAC;;;ACDxD;AAsBO,MAAM,yCAAa,GAAG,CAAC,MAAmB,GAAc;IAC7D,MAAM,OAAO,GAAG,CAAA,GAAA,aAAM,CAAA,CACpB,CAAA,GAAA,eAAQ,CAAA,CAAyB;QAC/B,WAAW,EAAE,MAAM;QACnB,eAAe,EAAE,MAAM,CAAC,eAAe;QACvC,YAAY,EAAE,CAAC;QACf,KAAK,EAAE,SAAS;KACjB,CAAC,CACH,AAAC;IAEF,MAAM,mBAAE,eAAe,CAAA,gBAAE,YAAY,CAAA,SAAE,KAAK,CAAA,EAAE,GAAG,OAAO,AAAC;IAEzD,MAAM,UAAS,GAAG,CAAA,GAAA,eAAQ,CAAA,CAAC,IAAM,YAAY,CAAC,KAAK,GAAG,CAAC,CAAC,AAAC;IAEzD,+CAA+C,CAC/C,MAAM,QAAQ,GAAG,CAAC,MAAe,EAAE,oBAA6B,GAAK;QACnE,IAAI,MAAM,YAAY,KAAK,EACzB,KAAK,CAAC,KAAK,GAAG,MAAM,CAAC;aAChB,IAAI,oBAAoB,EAC7B,KAAK,CAAC,KAAK,GAAG,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAC;QAEhD,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;KACtB,AAAC;IAEF,MAAM,UAAU,GAAG,CAAC,SAAkB,GAAK;QACzC,IAAI,SAAS,EACX,YAAY,CAAC,KAAK,IAAI,CAAC,CAAC;aAExB,YAAY,CAAC,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,YAAY,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC;KAE5D,AAAC;IAEF,MAAM,kBAAkB,GAAG,CAAC,gBAAyB,GAAK;QACxD,eAAe,CAAC,KAAK,GAAG,gBAAgB,CAAC;KAC1C,AAAC;IACF,8CAA8C,CAE9C,OAAO;QAAE,GAAG,OAAO;QAAE,SAAS,EAAT,UAAS;kBAAE,QAAQ;oBAAE,UAAU;4BAAE,kBAAkB;KAAE,CAAC;CAC5E,AAAC;AAEK,MAAM,yCAAiB,GAAG,IAAa;IAC5C,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAC;CACrD,AAAC;;;AChEF;AAEO,MAAM,uCAAmB,GAAG,CAAC,OAAgB,GAAK;IACvD,MAAM,eAAE,WAAW,CAAA,cAAE,UAAU,CAAA,YAAE,QAAQ,CAAA,sBAAE,kBAAkB,CAAA,EAAE,GAAG,OAAO,AAAC;IAE1E,MAAM,MAAM,GAAG,OAAO,WAAmB,GAAK;QAC5C,IAAI,CAAC,WAAW,CAAC,KAAK,EACpB,OAAO,CAAA,GAAA,yCAAiB,CAAA,EAAE,CAAC;QAG7B,IAAI;YACF,UAAU,CAAC,IAAI,CAAC,CAAC;YAEjB,MAAM,WAAW,CAAC,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;SAC7C,CAAC,OAAO,KAAK,EAAW;YACvB,QAAQ,CAAC,KAAK,EAAE,6CAA6C,CAAC,CAAC;SAChE,QAAS;YACR,UAAU,CAAC,KAAK,CAAC,CAAC;SACnB;KACF,AAAC;IAEF,MAAM,OAAO,GAAG,OAAO,qBAA6B,GAAK;QACvD,IAAI,CAAC,WAAW,CAAC,KAAK,EACpB,OAAO,CAAA,GAAA,yCAAiB,CAAA,EAAE,CAAC;QAG7B,IAAI;YACF,UAAU,CAAC,IAAI,CAAC,CAAC;YAEjB,MAAM,WAAW,CAAC,KAAK,CAAC,OAAO,CAAC,qBAAqB,CAAC,CAAC;QAEvD,yGAAyG;QACzG,iGAAiG;QACjG,uGAAuG;SACxG,CAAC,OAAO,KAAK,EAAW;YACvB,QAAQ,CAAC,KAAK,EAAE,8CAA8C,CAAC,CAAC;SACjE,QAAS;YACR,UAAU,CAAC,KAAK,CAAC,CAAC;SACnB;KACF,AAAC;IAEF,MAAM,cAAc,GAAG,OAAO,QAAiB,GAAK;QAClD,IAAI,CAAC,WAAW,CAAC,KAAK,EACpB,OAAO,CAAA,GAAA,yCAAiB,CAAA,EAAE,CAAC;QAG7B,IAAI;YACF,UAAU,CAAC,IAAI,CAAC,CAAC;YAEjB,OAAO,MAAM,WAAW,CAAC,KAAK,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;SACzD,CAAC,OAAO,KAAK,EAAW;YACvB,QAAQ,CAAC,KAAK,EAAE,uDAAuD,CAAC,CAAC;SAC1E,QAAS;YACR,UAAU,CAAC,KAAK,CAAC,CAAC;SACnB;KACF,AAAC;IAEF,MAAM,gBAAgB,GAAG,IAAM;QAC7B,IAAI,CAAC,WAAW,CAAC,KAAK,EACpB,OAAO,CAAA,GAAA,yCAAiB,CAAA,EAAE,CAAC;QAG7B,IAAI;YACF,OAAO,WAAW,CAAC,KAAK,CAAC,gBAAgB,EAAE,CAAC;SAC7C,CAAC,OAAO,KAAK,EAAW;YACvB,QAAQ,CAAC,KAAK,EAAE,0DAA0D,CAAC,CAAC;SAC7E;KACF,AAAC;IAEF,MAAM,oBAAoB,GAAG,OAAO,WAAmB,EAAE,gBAA6B,GAAK;QACzF,IAAI,CAAC,WAAW,CAAC,KAAK,EACpB,OAAO,CAAA,GAAA,yCAAiB,CAAA,EAAE,CAAC;QAG7B,IAAI;YACF,UAAU,CAAC,IAAI,CAAC,CAAC;YACjB,MAAM,WAAW,CAAC,KAAK,CAAC,oBAAoB,CAAC,WAAW,CAAC,CAAC;YAC1D,kBAAkB,CAAC,IAAI,CAAC,CAAC;YACzB,gBAAgB,IAAI,CAAC;SACtB,CAAC,OAAO,KAAK,EAAW;YACvB,QAAQ,CAAC,KAAK,EAAE,4DAA4D,CAAC,CAAC;SAC/E,QAAS;YACR,UAAU,CAAC,KAAK,CAAC,CAAC;SACnB;KACF,AAAC;IAEF,OAAO;gBACL,MAAM;iBACN,OAAO;wBACP,cAAc;0BACd,gBAAgB;8BAChB,oBAAoB;KACrB,CAAC;CACH,AAAC;;;;AH7CK,MAAM,yCAAW,GAAmB;IACzC,OAAO,EAAC,GAAQ,EAAE,MAAmB,EAAE;QACrC,MAAM,MAAM,GAAG,IAAI,CAAA,GAAA,mBAAW,CAAA,CAAC,MAAM,CAAC,AAAC;QACvC,MAAM,OAAO,GAAG,CAAA,GAAA,yCAAa,CAAA,CAAC,MAAM,CAAC,AAAC;QACtC,MAAM,aAAa,GAAG,CAAA,GAAA,uCAAmB,CAAA,CAAC,OAAO,CAAC,AAAC;QACnD,MAAM,mBAAE,eAAe,CAAA,aAAE,SAAS,CAAA,SAAE,KAAK,CAAA,EAAE,GAAG,OAAO,AAAC;QAEtD,GAAG,CAAC,OAAO,CAAU,CAAA,GAAA,yCAAmB,CAAA,EAAE,OAAO,CAAC,CAAC;QACnD,GAAG,CAAC,OAAO,CAAQ,CAAA,GAAA,yCAAiB,CAAA,EAAE;YACpC,eAAe,EAAE,CAAA,GAAA,eAAQ,CAAA,CAAC,eAAe,CAAC;YAC1C,SAAS,EAAE,CAAA,GAAA,eAAQ,CAAA,CAAC,SAAS,CAAC;YAC9B,KAAK,EAAE,CAAA,GAAA,eAAQ,CAAA,CAAC,KAAK,CAAC;YACtB,GAAG,aAAa;SACjB,CAAC,CAAC;KACJ;CACF,AAAC;AAwBK,MAAM,yCAAQ,GAAG,IAAa;IACnC,MAAM,KAAK,GAAG,CAAA,GAAA,aAAM,CAAA,CAAQ,CAAA,GAAA,yCAAiB,CAAA,CAAC,AAAC;IAE/C,IAAI,CAAC,KAAK,EACR,OAAO,CAAA,GAAA,yCAAiB,CAAA,EAAE,CAAC;IAG7B,OAAO,KAAK,CAAC;CACd,AAAC;AAkBK,MAAM,yCAAuB,GAAG,CAAC,QAAqB,GAAK;IAChE,MAAM,OAAO,GAAG,CAAA,GAAA,aAAM,CAAA,CAAU,CAAA,GAAA,yCAAmB,CAAA,CAAC,AAAC;IAErD,IAAI,CAAC,OAAO,EACV,OAAO,CAAA,GAAA,yCAAiB,CAAA,EAAE,CAAC;IAG7B,MAAM,mBAAE,eAAe,CAAA,aAAE,SAAS,CAAA,eAAE,WAAW,CAAA,SAAE,KAAK,CAAA,EAAE,GAAG,OAAO,AAAC;IACnE,MAAM,wBAAE,oBAAoB,CAAA,EAAE,GAAG,CAAA,GAAA,uCAAmB,CAAA,CAAC,OAAO,CAAC,AAAC;IAE9D,CAAA,GAAA,kBAAW,CAAA,CAAC,IAAM;QAChB,MAAM,cAAc,GAAG,MAAM,CAAC,QAAQ,CAAC,IAAI,AAAC;QAE5C,IAAI,CAAC,eAAe,CAAC,KAAK,IAAI,WAAW,CAAC,KAAK,EAAE,kBAAkB,CAAC,cAAc,CAAC,EAC5E,oBAAoB,CAAC,cAAc,EAAE,QAAQ,CAAC,CAAC;KAEvD,CAAC,CAAC;IAEH,OAAO;QACL,SAAS,EAAE,CAAA,GAAA,eAAQ,CAAA,CAAC,SAAS,CAAC;QAC9B,eAAe,EAAE,CAAA,GAAA,eAAQ,CAAA,CAAC,eAAe,CAAC;QAC1C,KAAK,EAAE,CAAA,GAAA,eAAQ,CAAA,CAAC,KAAK,CAAC;KACvB,CAAC;CACH,AAAC","sources":["packages/vue/src/index.ts","packages/vue/src/consts.ts","packages/vue/src/context.ts","packages/vue/src/plugin.ts"],"sourcesContent":["import LogtoClient, { IdTokenClaims, LogtoConfig } from '@logto/browser';\nimport { App, inject, readonly, Ref, watchEffect } from 'vue';\n\nimport { logtoInjectionKey, contextInjectionKey } from './consts';\nimport { Context, createContext, throwContextError } from './context';\nimport { createPluginMethods } from './plugin';\n\nexport type {\n LogtoConfig,\n IdTokenClaims,\n LogtoErrorCode,\n LogtoClientErrorCode,\n} from '@logto/browser';\n\nexport { LogtoError, LogtoClientError, OidcError, Prompt } from '@logto/browser';\n\ntype LogtoVuePlugin = {\n install: (app: App, config: LogtoConfig) => void;\n};\n\ntype Logto = {\n isAuthenticated: Readonly<Ref<boolean>>;\n isLoading: Readonly<Ref<boolean>>;\n error: Readonly<Ref<Error | undefined>>;\n getAccessToken: (resource?: string) => Promise<string | undefined>;\n getIdTokenClaims: () => IdTokenClaims | undefined;\n signIn: (redirectUri: string) => Promise<void>;\n signOut: (postLogoutRedirectUri: string) => Promise<void>;\n};\n\n/**\n * Creates the Logto Vue plugin\n *\n * ```ts\n * import { createApp } from 'vue';\n * import { createLogto } from '@logto/vue';\n *\n * const app = createApp(App);\n * const app.use(createLogto, {\n * appId: '<your-app-id>',\n * endpoint: '<your-oidc-endpoint-domain>',\n * });\n *\n * app.mount('#app');\n * ```\n *\n * Use this in your Vue root component to register the plugin\n */\nexport const createLogto: LogtoVuePlugin = {\n install(app: App, config: LogtoConfig) {\n const client = new LogtoClient(config);\n const context = createContext(client);\n const pluginMethods = createPluginMethods(context);\n const { isAuthenticated, isLoading, error } = context;\n\n app.provide<Context>(contextInjectionKey, context);\n app.provide<Logto>(logtoInjectionKey, {\n isAuthenticated: readonly(isAuthenticated),\n isLoading: readonly(isLoading),\n error: readonly(error),\n ...pluginMethods,\n });\n },\n};\n\n/**\n * A Vue composable method that provides the Logto reactive refs and auth methods.\n *\n * ```ts\n * import { useLogto } from '@logto/vue';\n *\n * export default {\n * setup() {\n * const { isAuthenticated, signIn } = useLogto();\n *\n * return {\n * isAuthenticated,\n * onClickSignIn: () => {\n * signIn('<your-redirect-uri>');\n * },\n * }\n * }\n * }\n * ```\n *\n * Use this composable in the setup script of your Vue component to make sure the injection works\n */\nexport const useLogto = (): Logto => {\n const logto = inject<Logto>(logtoInjectionKey);\n\n if (!logto) {\n return throwContextError();\n }\n\n return logto;\n};\n\n/**\n * A Vue composable method that watches browser navigation and automatically handles the sign-in callback\n *\n * ```ts\n * import { useLogto } from '@logto/vue';\n * import { useHandleSignInCallback } from '@logto/vue';\n *\n * export default {\n * setup() {\n * useHandleSignInCallback();\n * }\n * }\n * ```\n *\n * Use this in the setup script of your Callback page to make sure the injection works\n */\nexport const useHandleSignInCallback = (callback?: () => void) => {\n const context = inject<Context>(contextInjectionKey);\n\n if (!context) {\n return throwContextError();\n }\n\n const { isAuthenticated, isLoading, logtoClient, error } = context;\n const { handleSignInCallback } = createPluginMethods(context);\n\n watchEffect(() => {\n const currentPageUrl = window.location.href;\n\n if (!isAuthenticated.value && logtoClient.value?.isSignInRedirected(currentPageUrl)) {\n void handleSignInCallback(currentPageUrl, callback);\n }\n });\n\n return {\n isLoading: readonly(isLoading),\n isAuthenticated: readonly(isAuthenticated),\n error: readonly(error),\n };\n};\n","export const logtoInjectionKey = '@logto/vue';\nexport const contextInjectionKey = '@logto/vue:context';\n","import LogtoClient from '@logto/browser';\nimport { computed, ComputedRef, reactive, Ref, toRefs, UnwrapRef } from 'vue';\n\ntype LogtoContextProperties = {\n logtoClient: LogtoClient | undefined;\n isAuthenticated: boolean;\n loadingCount: number;\n error: Error | undefined;\n};\n\nexport type Context = {\n // Wrong type workaround. https://github.com/vuejs/core/issues/2981\n logtoClient: Ref<UnwrapRef<LogtoClient | undefined>>;\n isAuthenticated: Ref<boolean>;\n loadingCount: Ref<number>;\n error: Ref<Error | undefined>;\n isLoading: ComputedRef<boolean>;\n setError: (error: unknown, fallbackErrorMessage?: string | undefined) => void;\n setIsAuthenticated: (isAuthenticated: boolean) => void;\n setLoading: (isLoading: boolean) => void;\n};\n\nexport const createContext = (client: LogtoClient): Context => {\n const context = toRefs(\n reactive<LogtoContextProperties>({\n logtoClient: client,\n isAuthenticated: client.isAuthenticated,\n loadingCount: 0,\n error: undefined,\n })\n );\n\n const { isAuthenticated, loadingCount, error } = context;\n\n const isLoading = computed(() => loadingCount.value > 0);\n\n /* eslint-disable @silverhand/fp/no-mutation */\n const setError = (_error: unknown, fallbackErrorMessage?: string) => {\n if (_error instanceof Error) {\n error.value = _error;\n } else if (fallbackErrorMessage) {\n error.value = new Error(fallbackErrorMessage);\n }\n console.error(error);\n };\n\n const setLoading = (isLoading: boolean) => {\n if (isLoading) {\n loadingCount.value += 1;\n } else {\n loadingCount.value = Math.max(0, loadingCount.value - 1);\n }\n };\n\n const setIsAuthenticated = (_isAuthenticated: boolean) => {\n isAuthenticated.value = _isAuthenticated;\n };\n /* eslint-enable @silverhand/fp/no-mutation */\n\n return { ...context, isLoading, setError, setLoading, setIsAuthenticated };\n};\n\nexport const throwContextError = (): never => {\n throw new Error('Must install Logto plugin first.');\n};\n","import { Context, throwContextError } from './context';\n\nexport const createPluginMethods = (context: Context) => {\n const { logtoClient, setLoading, setError, setIsAuthenticated } = context;\n\n const signIn = async (redirectUri: string) => {\n if (!logtoClient.value) {\n return throwContextError();\n }\n\n try {\n setLoading(true);\n\n await logtoClient.value.signIn(redirectUri);\n } catch (error: unknown) {\n setError(error, 'Unexpected error occurred while signing in.');\n } finally {\n setLoading(false);\n }\n };\n\n const signOut = async (postLogoutRedirectUri: string) => {\n if (!logtoClient.value) {\n return throwContextError();\n }\n\n try {\n setLoading(true);\n\n await logtoClient.value.signOut(postLogoutRedirectUri);\n\n // We deliberately do NOT set isAuthenticated to false here, because the app state may change immediately\n // even before navigating to the oidc end session endpoint, which might cause rendering problems.\n // Moreover, since the location will be redirected, the isAuthenticated state will not matter any more.\n } catch (error: unknown) {\n setError(error, 'Unexpected error occurred while signing out.');\n } finally {\n setLoading(false);\n }\n };\n\n const getAccessToken = async (resource?: string) => {\n if (!logtoClient.value) {\n return throwContextError();\n }\n\n try {\n setLoading(true);\n\n return await logtoClient.value.getAccessToken(resource);\n } catch (error: unknown) {\n setError(error, 'Unexpected error occurred while getting access token.');\n } finally {\n setLoading(false);\n }\n };\n\n const getIdTokenClaims = () => {\n if (!logtoClient.value) {\n return throwContextError();\n }\n\n try {\n return logtoClient.value.getIdTokenClaims();\n } catch (error: unknown) {\n setError(error, 'Unexpected error occurred while getting id token claims.');\n }\n };\n\n const handleSignInCallback = async (callbackUri: string, callbackFunction?: () => void) => {\n if (!logtoClient.value) {\n return throwContextError();\n }\n\n try {\n setLoading(true);\n await logtoClient.value.handleSignInCallback(callbackUri);\n setIsAuthenticated(true);\n callbackFunction?.();\n } catch (error: unknown) {\n setError(error, 'Unexpected error occurred while handling sign in callback.');\n } finally {\n setLoading(false);\n }\n };\n\n return {\n signIn,\n signOut,\n getAccessToken,\n getIdTokenClaims,\n handleSignInCallback,\n };\n};\n"],"names":[],"version":3,"file":"module.js.map"}
|
|
1
|
+
{"mappings":";;;AAAA;;ACAO,MAAM,yCAAiB,GAAG,YAAY,AAAC;AACvC,MAAM,yCAAmB,GAAG,oBAAoB,AAAC;;;ACDxD;AAsBO,MAAM,yCAAa,GAAG,CAAC,MAAmB,GAAc;IAC7D,MAAM,OAAO,GAAG,CAAA,GAAA,aAAM,CAAA,CACpB,CAAA,GAAA,eAAQ,CAAA,CAAyB;QAC/B,WAAW,EAAE,MAAM;QACnB,eAAe,EAAE,MAAM,CAAC,eAAe;QACvC,YAAY,EAAE,CAAC;QACf,KAAK,EAAE,SAAS;KACjB,CAAC,CACH,AAAC;IAEF,MAAM,mBAAE,eAAe,CAAA,gBAAE,YAAY,CAAA,SAAE,KAAK,CAAA,EAAE,GAAG,OAAO,AAAC;IAEzD,MAAM,UAAS,GAAG,CAAA,GAAA,eAAQ,CAAA,CAAC,IAAM,YAAY,CAAC,KAAK,GAAG,CAAC,CAAC,AAAC;IAEzD,+CAA+C,CAC/C,MAAM,QAAQ,GAAG,CAAC,MAAe,EAAE,oBAA6B,GAAK;QACnE,IAAI,MAAM,YAAY,KAAK,EACzB,KAAK,CAAC,KAAK,GAAG,MAAM,CAAC;aAChB,IAAI,oBAAoB,EAC7B,KAAK,CAAC,KAAK,GAAG,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAC;QAEhD,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;KACtB,AAAC;IAEF,MAAM,UAAU,GAAG,CAAC,SAAkB,GAAK;QACzC,IAAI,SAAS,EACX,YAAY,CAAC,KAAK,IAAI,CAAC,CAAC;aAExB,YAAY,CAAC,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,YAAY,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC;KAE5D,AAAC;IAEF,MAAM,kBAAkB,GAAG,CAAC,gBAAyB,GAAK;QACxD,eAAe,CAAC,KAAK,GAAG,gBAAgB,CAAC;KAC1C,AAAC;IACF,8CAA8C,CAE9C,OAAO;QAAE,GAAG,OAAO;QAAE,SAAS,EAAT,UAAS;kBAAE,QAAQ;oBAAE,UAAU;4BAAE,kBAAkB;KAAE,CAAC;CAC5E,AAAC;AAEK,MAAM,yCAAiB,GAAG,IAAa;IAC5C,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAC;CACrD,AAAC;;;AChEF;AAEO,MAAM,uCAAmB,GAAG,CAAC,OAAgB,GAAK;IACvD,MAAM,eAAE,WAAW,CAAA,cAAE,UAAU,CAAA,YAAE,QAAQ,CAAA,sBAAE,kBAAkB,CAAA,EAAE,GAAG,OAAO,AAAC;IAE1E,MAAM,MAAM,GAAG,OAAO,WAAmB,GAAK;QAC5C,IAAI,CAAC,WAAW,CAAC,KAAK,EACpB,OAAO,CAAA,GAAA,yCAAiB,CAAA,EAAE,CAAC;QAG7B,IAAI;YACF,UAAU,CAAC,IAAI,CAAC,CAAC;YAEjB,MAAM,WAAW,CAAC,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;SAC7C,CAAC,OAAO,KAAK,EAAW;YACvB,QAAQ,CAAC,KAAK,EAAE,6CAA6C,CAAC,CAAC;SAChE,QAAS;YACR,UAAU,CAAC,KAAK,CAAC,CAAC;SACnB;KACF,AAAC;IAEF,MAAM,OAAO,GAAG,OAAO,qBAA8B,GAAK;QACxD,IAAI,CAAC,WAAW,CAAC,KAAK,EACpB,OAAO,CAAA,GAAA,yCAAiB,CAAA,EAAE,CAAC;QAG7B,IAAI;YACF,UAAU,CAAC,IAAI,CAAC,CAAC;YAEjB,MAAM,WAAW,CAAC,KAAK,CAAC,OAAO,CAAC,qBAAqB,CAAC,CAAC;QAEvD,yGAAyG;QACzG,iGAAiG;QACjG,uGAAuG;SACxG,CAAC,OAAO,KAAK,EAAW;YACvB,QAAQ,CAAC,KAAK,EAAE,8CAA8C,CAAC,CAAC;SACjE,QAAS;YACR,UAAU,CAAC,KAAK,CAAC,CAAC;SACnB;KACF,AAAC;IAEF,MAAM,cAAc,GAAG,OAAO,QAAiB,GAAK;QAClD,IAAI,CAAC,WAAW,CAAC,KAAK,EACpB,OAAO,CAAA,GAAA,yCAAiB,CAAA,EAAE,CAAC;QAG7B,IAAI;YACF,UAAU,CAAC,IAAI,CAAC,CAAC;YAEjB,OAAO,MAAM,WAAW,CAAC,KAAK,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;SACzD,CAAC,OAAO,KAAK,EAAW;YACvB,QAAQ,CAAC,KAAK,EAAE,uDAAuD,CAAC,CAAC;SAC1E,QAAS;YACR,UAAU,CAAC,KAAK,CAAC,CAAC;SACnB;KACF,AAAC;IAEF,MAAM,gBAAgB,GAAG,IAAM;QAC7B,IAAI,CAAC,WAAW,CAAC,KAAK,EACpB,OAAO,CAAA,GAAA,yCAAiB,CAAA,EAAE,CAAC;QAG7B,IAAI;YACF,OAAO,WAAW,CAAC,KAAK,CAAC,gBAAgB,EAAE,CAAC;SAC7C,CAAC,OAAO,KAAK,EAAW;YACvB,QAAQ,CAAC,KAAK,EAAE,0DAA0D,CAAC,CAAC;SAC7E;KACF,AAAC;IAEF,MAAM,oBAAoB,GAAG,OAAO,WAAmB,EAAE,gBAA6B,GAAK;QACzF,IAAI,CAAC,WAAW,CAAC,KAAK,EACpB,OAAO,CAAA,GAAA,yCAAiB,CAAA,EAAE,CAAC;QAG7B,IAAI;YACF,UAAU,CAAC,IAAI,CAAC,CAAC;YACjB,MAAM,WAAW,CAAC,KAAK,CAAC,oBAAoB,CAAC,WAAW,CAAC,CAAC;YAC1D,kBAAkB,CAAC,IAAI,CAAC,CAAC;YACzB,gBAAgB,IAAI,CAAC;SACtB,CAAC,OAAO,KAAK,EAAW;YACvB,QAAQ,CAAC,KAAK,EAAE,4DAA4D,CAAC,CAAC;SAC/E,QAAS;YACR,UAAU,CAAC,KAAK,CAAC,CAAC;SACnB;KACF,AAAC;IAEF,OAAO;gBACL,MAAM;iBACN,OAAO;wBACP,cAAc;0BACd,gBAAgB;8BAChB,oBAAoB;KACrB,CAAC;CACH,AAAC;;;;AH7CK,MAAM,yCAAW,GAAmB;IACzC,OAAO,EAAC,GAAQ,EAAE,MAAmB,EAAE;QACrC,MAAM,MAAM,GAAG,IAAI,CAAA,GAAA,mBAAW,CAAA,CAAC,MAAM,CAAC,AAAC;QACvC,MAAM,OAAO,GAAG,CAAA,GAAA,yCAAa,CAAA,CAAC,MAAM,CAAC,AAAC;QACtC,MAAM,aAAa,GAAG,CAAA,GAAA,uCAAmB,CAAA,CAAC,OAAO,CAAC,AAAC;QACnD,MAAM,mBAAE,eAAe,CAAA,aAAE,SAAS,CAAA,SAAE,KAAK,CAAA,EAAE,GAAG,OAAO,AAAC;QAEtD,GAAG,CAAC,OAAO,CAAU,CAAA,GAAA,yCAAmB,CAAA,EAAE,OAAO,CAAC,CAAC;QACnD,GAAG,CAAC,OAAO,CAAQ,CAAA,GAAA,yCAAiB,CAAA,EAAE;YACpC,eAAe,EAAE,CAAA,GAAA,eAAQ,CAAA,CAAC,eAAe,CAAC;YAC1C,SAAS,EAAE,CAAA,GAAA,eAAQ,CAAA,CAAC,SAAS,CAAC;YAC9B,KAAK,EAAE,CAAA,GAAA,eAAQ,CAAA,CAAC,KAAK,CAAC;YACtB,GAAG,aAAa;SACjB,CAAC,CAAC;KACJ;CACF,AAAC;AAwBK,MAAM,yCAAQ,GAAG,IAAa;IACnC,MAAM,KAAK,GAAG,CAAA,GAAA,aAAM,CAAA,CAAQ,CAAA,GAAA,yCAAiB,CAAA,CAAC,AAAC;IAE/C,IAAI,CAAC,KAAK,EACR,OAAO,CAAA,GAAA,yCAAiB,CAAA,EAAE,CAAC;IAG7B,OAAO,KAAK,CAAC;CACd,AAAC;AAkBK,MAAM,yCAAuB,GAAG,CAAC,QAAqB,GAAK;IAChE,MAAM,OAAO,GAAG,CAAA,GAAA,aAAM,CAAA,CAAU,CAAA,GAAA,yCAAmB,CAAA,CAAC,AAAC;IAErD,IAAI,CAAC,OAAO,EACV,OAAO,CAAA,GAAA,yCAAiB,CAAA,EAAE,CAAC;IAG7B,MAAM,mBAAE,eAAe,CAAA,aAAE,SAAS,CAAA,eAAE,WAAW,CAAA,SAAE,KAAK,CAAA,EAAE,GAAG,OAAO,AAAC;IACnE,MAAM,wBAAE,oBAAoB,CAAA,EAAE,GAAG,CAAA,GAAA,uCAAmB,CAAA,CAAC,OAAO,CAAC,AAAC;IAE9D,CAAA,GAAA,kBAAW,CAAA,CAAC,IAAM;QAChB,MAAM,cAAc,GAAG,MAAM,CAAC,QAAQ,CAAC,IAAI,AAAC;QAE5C,IAAI,CAAC,eAAe,CAAC,KAAK,IAAI,WAAW,CAAC,KAAK,EAAE,kBAAkB,CAAC,cAAc,CAAC,EAC5E,oBAAoB,CAAC,cAAc,EAAE,QAAQ,CAAC,CAAC;KAEvD,CAAC,CAAC;IAEH,OAAO;QACL,SAAS,EAAE,CAAA,GAAA,eAAQ,CAAA,CAAC,SAAS,CAAC;QAC9B,eAAe,EAAE,CAAA,GAAA,eAAQ,CAAA,CAAC,eAAe,CAAC;QAC1C,KAAK,EAAE,CAAA,GAAA,eAAQ,CAAA,CAAC,KAAK,CAAC;KACvB,CAAC;CACH,AAAC","sources":["packages/vue/src/index.ts","packages/vue/src/consts.ts","packages/vue/src/context.ts","packages/vue/src/plugin.ts"],"sourcesContent":["import LogtoClient, { IdTokenClaims, LogtoConfig } from '@logto/browser';\nimport { App, inject, readonly, Ref, watchEffect } from 'vue';\n\nimport { logtoInjectionKey, contextInjectionKey } from './consts';\nimport { Context, createContext, throwContextError } from './context';\nimport { createPluginMethods } from './plugin';\n\nexport type {\n LogtoConfig,\n IdTokenClaims,\n LogtoErrorCode,\n LogtoClientErrorCode,\n} from '@logto/browser';\n\nexport { LogtoError, LogtoClientError, OidcError, Prompt } from '@logto/browser';\n\ntype LogtoVuePlugin = {\n install: (app: App, config: LogtoConfig) => void;\n};\n\ntype Logto = {\n isAuthenticated: Readonly<Ref<boolean>>;\n isLoading: Readonly<Ref<boolean>>;\n error: Readonly<Ref<Error | undefined>>;\n getAccessToken: (resource?: string) => Promise<string | undefined>;\n getIdTokenClaims: () => IdTokenClaims | undefined;\n signIn: (redirectUri: string) => Promise<void>;\n signOut: (postLogoutRedirectUri?: string) => Promise<void>;\n};\n\n/**\n * Creates the Logto Vue plugin\n *\n * ```ts\n * import { createApp } from 'vue';\n * import { createLogto } from '@logto/vue';\n *\n * const app = createApp(App);\n * const app.use(createLogto, {\n * appId: '<your-app-id>',\n * endpoint: '<your-oidc-endpoint-domain>',\n * });\n *\n * app.mount('#app');\n * ```\n *\n * Use this in your Vue root component to register the plugin\n */\nexport const createLogto: LogtoVuePlugin = {\n install(app: App, config: LogtoConfig) {\n const client = new LogtoClient(config);\n const context = createContext(client);\n const pluginMethods = createPluginMethods(context);\n const { isAuthenticated, isLoading, error } = context;\n\n app.provide<Context>(contextInjectionKey, context);\n app.provide<Logto>(logtoInjectionKey, {\n isAuthenticated: readonly(isAuthenticated),\n isLoading: readonly(isLoading),\n error: readonly(error),\n ...pluginMethods,\n });\n },\n};\n\n/**\n * A Vue composable method that provides the Logto reactive refs and auth methods.\n *\n * ```ts\n * import { useLogto } from '@logto/vue';\n *\n * export default {\n * setup() {\n * const { isAuthenticated, signIn } = useLogto();\n *\n * return {\n * isAuthenticated,\n * onClickSignIn: () => {\n * signIn('<your-redirect-uri>');\n * },\n * }\n * }\n * }\n * ```\n *\n * Use this composable in the setup script of your Vue component to make sure the injection works\n */\nexport const useLogto = (): Logto => {\n const logto = inject<Logto>(logtoInjectionKey);\n\n if (!logto) {\n return throwContextError();\n }\n\n return logto;\n};\n\n/**\n * A Vue composable method that watches browser navigation and automatically handles the sign-in callback\n *\n * ```ts\n * import { useLogto } from '@logto/vue';\n * import { useHandleSignInCallback } from '@logto/vue';\n *\n * export default {\n * setup() {\n * useHandleSignInCallback();\n * }\n * }\n * ```\n *\n * Use this in the setup script of your Callback page to make sure the injection works\n */\nexport const useHandleSignInCallback = (callback?: () => void) => {\n const context = inject<Context>(contextInjectionKey);\n\n if (!context) {\n return throwContextError();\n }\n\n const { isAuthenticated, isLoading, logtoClient, error } = context;\n const { handleSignInCallback } = createPluginMethods(context);\n\n watchEffect(() => {\n const currentPageUrl = window.location.href;\n\n if (!isAuthenticated.value && logtoClient.value?.isSignInRedirected(currentPageUrl)) {\n void handleSignInCallback(currentPageUrl, callback);\n }\n });\n\n return {\n isLoading: readonly(isLoading),\n isAuthenticated: readonly(isAuthenticated),\n error: readonly(error),\n };\n};\n","export const logtoInjectionKey = '@logto/vue';\nexport const contextInjectionKey = '@logto/vue:context';\n","import LogtoClient from '@logto/browser';\nimport { computed, ComputedRef, reactive, Ref, toRefs, UnwrapRef } from 'vue';\n\ntype LogtoContextProperties = {\n logtoClient: LogtoClient | undefined;\n isAuthenticated: boolean;\n loadingCount: number;\n error: Error | undefined;\n};\n\nexport type Context = {\n // Wrong type workaround. https://github.com/vuejs/core/issues/2981\n logtoClient: Ref<UnwrapRef<LogtoClient | undefined>>;\n isAuthenticated: Ref<boolean>;\n loadingCount: Ref<number>;\n error: Ref<Error | undefined>;\n isLoading: ComputedRef<boolean>;\n setError: (error: unknown, fallbackErrorMessage?: string | undefined) => void;\n setIsAuthenticated: (isAuthenticated: boolean) => void;\n setLoading: (isLoading: boolean) => void;\n};\n\nexport const createContext = (client: LogtoClient): Context => {\n const context = toRefs(\n reactive<LogtoContextProperties>({\n logtoClient: client,\n isAuthenticated: client.isAuthenticated,\n loadingCount: 0,\n error: undefined,\n })\n );\n\n const { isAuthenticated, loadingCount, error } = context;\n\n const isLoading = computed(() => loadingCount.value > 0);\n\n /* eslint-disable @silverhand/fp/no-mutation */\n const setError = (_error: unknown, fallbackErrorMessage?: string) => {\n if (_error instanceof Error) {\n error.value = _error;\n } else if (fallbackErrorMessage) {\n error.value = new Error(fallbackErrorMessage);\n }\n console.error(error);\n };\n\n const setLoading = (isLoading: boolean) => {\n if (isLoading) {\n loadingCount.value += 1;\n } else {\n loadingCount.value = Math.max(0, loadingCount.value - 1);\n }\n };\n\n const setIsAuthenticated = (_isAuthenticated: boolean) => {\n isAuthenticated.value = _isAuthenticated;\n };\n /* eslint-enable @silverhand/fp/no-mutation */\n\n return { ...context, isLoading, setError, setLoading, setIsAuthenticated };\n};\n\nexport const throwContextError = (): never => {\n throw new Error('Must install Logto plugin first.');\n};\n","import { Context, throwContextError } from './context';\n\nexport const createPluginMethods = (context: Context) => {\n const { logtoClient, setLoading, setError, setIsAuthenticated } = context;\n\n const signIn = async (redirectUri: string) => {\n if (!logtoClient.value) {\n return throwContextError();\n }\n\n try {\n setLoading(true);\n\n await logtoClient.value.signIn(redirectUri);\n } catch (error: unknown) {\n setError(error, 'Unexpected error occurred while signing in.');\n } finally {\n setLoading(false);\n }\n };\n\n const signOut = async (postLogoutRedirectUri?: string) => {\n if (!logtoClient.value) {\n return throwContextError();\n }\n\n try {\n setLoading(true);\n\n await logtoClient.value.signOut(postLogoutRedirectUri);\n\n // We deliberately do NOT set isAuthenticated to false here, because the app state may change immediately\n // even before navigating to the oidc end session endpoint, which might cause rendering problems.\n // Moreover, since the location will be redirected, the isAuthenticated state will not matter any more.\n } catch (error: unknown) {\n setError(error, 'Unexpected error occurred while signing out.');\n } finally {\n setLoading(false);\n }\n };\n\n const getAccessToken = async (resource?: string) => {\n if (!logtoClient.value) {\n return throwContextError();\n }\n\n try {\n setLoading(true);\n\n return await logtoClient.value.getAccessToken(resource);\n } catch (error: unknown) {\n setError(error, 'Unexpected error occurred while getting access token.');\n } finally {\n setLoading(false);\n }\n };\n\n const getIdTokenClaims = () => {\n if (!logtoClient.value) {\n return throwContextError();\n }\n\n try {\n return logtoClient.value.getIdTokenClaims();\n } catch (error: unknown) {\n setError(error, 'Unexpected error occurred while getting id token claims.');\n }\n };\n\n const handleSignInCallback = async (callbackUri: string, callbackFunction?: () => void) => {\n if (!logtoClient.value) {\n return throwContextError();\n }\n\n try {\n setLoading(true);\n await logtoClient.value.handleSignInCallback(callbackUri);\n setIsAuthenticated(true);\n callbackFunction?.();\n } catch (error: unknown) {\n setError(error, 'Unexpected error occurred while handling sign in callback.');\n } finally {\n setLoading(false);\n }\n };\n\n return {\n signIn,\n signOut,\n getAccessToken,\n getIdTokenClaims,\n handleSignInCallback,\n };\n};\n"],"names":[],"version":3,"file":"module.js.map"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@logto/vue",
|
|
3
|
-
"version": "1.0.0-
|
|
3
|
+
"version": "1.0.0-beta.2",
|
|
4
4
|
"source": "./src/index.ts",
|
|
5
5
|
"main": "./lib/index.js",
|
|
6
6
|
"exports": {
|
|
@@ -29,15 +29,15 @@
|
|
|
29
29
|
"prepack": "pnpm test"
|
|
30
30
|
},
|
|
31
31
|
"dependencies": {
|
|
32
|
-
"@logto/browser": "^1.0.0-
|
|
32
|
+
"@logto/browser": "^1.0.0-beta.2"
|
|
33
33
|
},
|
|
34
34
|
"devDependencies": {
|
|
35
35
|
"@jest/types": "^27.5.1",
|
|
36
36
|
"@parcel/core": "^2.6.2",
|
|
37
37
|
"@parcel/packager-ts": "^2.6.2",
|
|
38
38
|
"@parcel/transformer-typescript-types": "^2.6.2",
|
|
39
|
-
"@silverhand/eslint-config": "^0.
|
|
40
|
-
"@silverhand/ts-config": "^0.
|
|
39
|
+
"@silverhand/eslint-config": "^0.17.0",
|
|
40
|
+
"@silverhand/ts-config": "^0.17.0",
|
|
41
41
|
"@types/jest": "^27.4.1",
|
|
42
42
|
"eslint": "^8.9.0",
|
|
43
43
|
"jest": "^27.5.1",
|
|
@@ -70,5 +70,5 @@
|
|
|
70
70
|
"publishConfig": {
|
|
71
71
|
"access": "public"
|
|
72
72
|
},
|
|
73
|
-
"gitHead": "
|
|
73
|
+
"gitHead": "212891497b04e3a5fd6b24bbbeec227dfec8ae53"
|
|
74
74
|
}
|