msal-vue-poc 0.1.0 → 0.1.1

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.
Files changed (2) hide show
  1. package/README.md +35 -23
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -1,36 +1,48 @@
1
- # MSAL Vue PoC
1
+ # msal-vue-poc
2
2
 
3
- A Vue.js library for Microsoft Authentication Library (MSAL) integration.
3
+ This template should help get you started developing with Vue 3 in Vite.
4
4
 
5
- ## Installation
5
+ ## Recommended IDE Setup
6
6
 
7
- ```bash
8
- npm install msal-vue-poc
9
- ```
7
+ [VS Code](https://code.visualstudio.com/) + [Vue (Official)](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur).
8
+
9
+ ## Recommended Browser Setup
10
+
11
+ - Chromium-based browsers (Chrome, Edge, Brave, etc.):
12
+ - [Vue.js devtools](https://chromewebstore.google.com/detail/vuejs-devtools/nhdogjmejiglipccpnnnanhbledajbpd)
13
+ - [Turn on Custom Object Formatter in Chrome DevTools](http://bit.ly/object-formatters)
14
+ - Firefox:
15
+ - [Vue.js devtools](https://addons.mozilla.org/en-US/firefox/addon/vue-js-devtools/)
16
+ - [Turn on Custom Object Formatter in Firefox DevTools](https://fxdx.dev/firefox-devtools-custom-object-formatters/)
17
+
18
+ ## Type Support for `.vue` Imports in TS
19
+
20
+ TypeScript cannot handle type information for `.vue` imports by default, so we replace the `tsc` CLI with `vue-tsc` for type checking. In editors, we need [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) to make the TypeScript language service aware of `.vue` types.
10
21
 
11
- ## Usage
22
+ ## Customize configuration
12
23
 
13
- ```typescript
14
- import { msalService, useUserStore } from 'msal-vue-poc'
24
+ See [Vite Configuration Reference](https://vite.dev/config/).
15
25
 
16
- // Initialize MSAL
17
- const { initialize, login, logout } = msalService()
18
- await initialize()
26
+ ## Project Setup
19
27
 
20
- // Use the user store
21
- const userStore = useUserStore()
28
+ ```sh
29
+ npm install
22
30
  ```
23
31
 
24
- ## Dependencies
32
+ ### Compile and Hot-Reload for Development
25
33
 
26
- This library requires the following peer dependencies:
34
+ ```sh
35
+ npm run dev
36
+ ```
37
+
38
+ ### Type-Check, Compile and Minify for Production
27
39
 
28
- - vue
29
- - @azure/msal-browser
30
- - axios
31
- - pinia
32
- - vue-router
40
+ ```sh
41
+ npm run build
42
+ ```
33
43
 
34
- ## License
44
+ ### Lint with [ESLint](https://eslint.org/)
35
45
 
36
- MIT
46
+ ```sh
47
+ npm run lint
48
+ ```
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "msal-vue-poc",
3
- "version": "0.1.0",
3
+ "version": "0.1.1",
4
4
  "type": "module",
5
5
  "engines": {
6
6
  "node": "^20.19.0 || >=22.12.0"
@@ -64,4 +64,4 @@
64
64
  "url": "https://github.com/See-You-Sun/package-vue-msal/issues"
65
65
  },
66
66
  "homepage": "https://github.com/See-You-Sun/package-vue-msal#readme"
67
- }
67
+ }