-
Notifications
You must be signed in to change notification settings - Fork 2.7k
[msal-node-extensions]: Add electron webpack sample #4034
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Samuel Kubai (samuelkubai)
merged 17 commits into
dev
from
samples/electron-webpack-msal-node-extensions
Sep 27, 2021
Merged
Changes from 10 commits
Commits
Show all changes
17 commits
Select commit
Hold shift + click to select a range
f0fe422
samples: add electron webpack sample
samuelkubai a396452
feat: add sample documentation
samuelkubai 0c2185b
feat: implement new bindings api
samuelkubai 7dc44a2
Change files
samuelkubai 8d06338
fix: update package files
samuelkubai dd5d802
Merge branch 'dev' into samples/electron-webpack-msal-node-extensions
samuelkubai 7446a15
fix: update lock files
samuelkubai e0f37d3
fix: update msal-extensions package definition
samuelkubai 410255b
Change files
samuelkubai 882330e
Merge branch 'dev' into samples/electron-webpack-msal-node-extensions
samuelkubai 8884864
fix: remove unnecessary dependency from msal-core
samuelkubai 262e37a
fix: change the sample license to MIT
samuelkubai 9a3340c
refactor: switching from a commit hash to a tag
samuelkubai 72eb5e1
Merge branch 'dev' into samples/electron-webpack-msal-node-extensions
samuelkubai f8cf121
docs: remove the DPAPI.node symlink section
samuelkubai e992411
Merge branch 'dev' into samples/electron-webpack-msal-node-extensions
samuelkubai 1c1852c
Merge branch 'dev' into samples/electron-webpack-msal-node-extensions
samuelkubai File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
7 changes: 7 additions & 0 deletions
7
change/@azure-msal-angular-9ad45f54-0380-40ba-ab9e-2dd4165ff095.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| { | ||
| "type": "none", | ||
| "comment": "fix: add forked bindings library to node-extensions", | ||
| "packageName": "@azure/msal-angular", | ||
| "email": "kamausamuel11@gmail.com", | ||
| "dependentChangeType": "none" | ||
| } |
7 changes: 7 additions & 0 deletions
7
change/@azure-msal-browser-b826cb55-92b9-4d28-a1df-7c21444407cc.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| { | ||
| "type": "none", | ||
| "comment": "fix: add forked bindings library to node-extensions", | ||
| "packageName": "@azure/msal-browser", | ||
| "email": "kamausamuel11@gmail.com", | ||
| "dependentChangeType": "none" | ||
| } |
7 changes: 7 additions & 0 deletions
7
change/@azure-msal-common-1ea9f7e5-95e2-4a9a-999d-f0cf0da70413.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| { | ||
| "type": "none", | ||
| "comment": "fix: integrate forked bindings package", | ||
| "packageName": "@azure/msal-common", | ||
| "email": "kamausamuel11@gmail.com", | ||
| "dependentChangeType": "none" | ||
| } |
7 changes: 7 additions & 0 deletions
7
change/@azure-msal-node-53c1ee23-e281-4469-8157-de3a7da7f77c.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| { | ||
| "type": "none", | ||
| "comment": "fix: add forked bindings library to node-extensions", | ||
| "packageName": "@azure/msal-node", | ||
| "email": "kamausamuel11@gmail.com", | ||
| "dependentChangeType": "none" | ||
| } |
7 changes: 7 additions & 0 deletions
7
change/@azure-msal-node-extensions-33dbfcdb-65d5-4562-8fe8-ed9e4e25f6e9.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| { | ||
| "type": "patch", | ||
| "comment": "fix: integrate forked bindings package", | ||
| "packageName": "@azure/msal-node-extensions", | ||
| "email": "kamausamuel11@gmail.com", | ||
| "dependentChangeType": "patch" | ||
| } |
7 changes: 7 additions & 0 deletions
7
change/@azure-msal-react-a190dea9-c53d-495e-bec0-e6b732784d54.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| { | ||
| "type": "none", | ||
| "comment": "fix: add forked bindings library to node-extensins", | ||
| "packageName": "@azure/msal-react", | ||
| "email": "kamausamuel11@gmail.com", | ||
| "dependentChangeType": "none" | ||
| } |
7 changes: 7 additions & 0 deletions
7
change/electron-msal-node-extensions-6fa1acbd-8856-43ed-a552-1a92016d5e1f.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| { | ||
| "type": "none", | ||
| "comment": "fix: integrate forked bindings package", | ||
| "packageName": "electron-msal-node-extensions", | ||
| "email": "kamausamuel11@gmail.com", | ||
| "dependentChangeType": "none" | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| { | ||
| "type": "none", | ||
| "comment": "fix: add forked bindings library to node-extensions", | ||
| "packageName": "msal", | ||
| "email": "kamausamuel11@gmail.com", | ||
| "dependentChangeType": "none" | ||
| } |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| { | ||
| "root": true, | ||
| "parser": "@typescript-eslint/parser", | ||
| "plugins": [ | ||
| "@typescript-eslint" | ||
| ], | ||
| "extends": [ | ||
| "eslint:recommended", | ||
| "plugin:@typescript-eslint/eslint-recommended", | ||
| "plugin:@typescript-eslint/recommended" | ||
| ] | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| node_modules | ||
| dist |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| CC0 1.0 Universal | ||
| ================== | ||
|
|
||
| Statement of Purpose | ||
| --------------------- | ||
|
|
||
| The laws of most jurisdictions throughout the world automatically confer exclusive Copyright and Related Rights (defined below) upon the creator and subsequent owner(s) (each and all, an "owner") of an original work of authorship and/or a database (each, a "Work"). | ||
|
|
||
| Certain owners wish to permanently relinquish those rights to a Work for the purpose of contributing to a commons of creative, cultural and scientific works ("Commons") that the public can reliably and without fear of later claims of infringement build upon, modify, incorporate in other works, reuse and redistribute as freely as possible in any form whatsoever and for any purposes, including without limitation commercial purposes. These owners may contribute to the Commons to promote the ideal of a free culture and the further production of creative, cultural and scientific works, or to gain reputation or greater distribution for their Work in part through the use and efforts of others. | ||
|
|
||
| For these and/or other purposes and motivations, and without any expectation of additional consideration or compensation, the person associating CC0 with a Work (the "Affirmer"), to the extent that he or she is an owner of Copyright and Related Rights in the Work, voluntarily elects to apply CC0 to the Work and publicly distribute the Work under its terms, with knowledge of his or her Copyright and Related Rights in the Work and the meaning and intended legal effect of CC0 on those rights. | ||
|
|
||
| 1. Copyright and Related Rights. | ||
| -------------------------------- | ||
| A Work made available under CC0 may be protected by copyright and related or neighboring rights ("Copyright and Related Rights"). Copyright and Related Rights include, but are not limited to, the following: | ||
|
|
||
| i. the right to reproduce, adapt, distribute, perform, display, communicate, and translate a Work; | ||
| ii. moral rights retained by the original author(s) and/or performer(s); | ||
| iii. publicity and privacy rights pertaining to a person's image or likeness depicted in a Work; | ||
| iv. rights protecting against unfair competition in regards to a Work, subject to the limitations in paragraph 4(a), below; | ||
| v. rights protecting the extraction, dissemination, use and reuse of data in a Work; | ||
| vi. database rights (such as those arising under Directive 96/9/EC of the European Parliament and of the Council of 11 March 1996 on the legal protection of databases, and under any national implementation thereof, including any amended or successor version of such directive); and | ||
| vii. other similar, equivalent or corresponding rights throughout the world based on applicable law or treaty, and any national implementations thereof. | ||
|
|
||
| 2. Waiver. | ||
| ----------- | ||
| To the greatest extent permitted by, but not in contravention of, applicable law, Affirmer hereby overtly, fully, permanently, irrevocably and unconditionally waives, abandons, and surrenders all of Affirmer's Copyright and Related Rights and associated claims and causes of action, whether now known or unknown (including existing as well as future claims and causes of action), in the Work (i) in all territories worldwide, (ii) for the maximum duration provided by applicable law or treaty (including future time extensions), (iii) in any current or future medium and for any number of copies, and (iv) for any purpose whatsoever, including without limitation commercial, advertising or promotional purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each member of the public at large and to the detriment of Affirmer's heirs and successors, fully intending that such Waiver shall not be subject to revocation, rescission, cancellation, termination, or any other legal or equitable action to disrupt the quiet enjoyment of the Work by the public as contemplated by Affirmer's express Statement of Purpose. | ||
|
|
||
| 3. Public License Fallback. | ||
| ---------------------------- | ||
| Should any part of the Waiver for any reason be judged legally invalid or ineffective under applicable law, then the Waiver shall be preserved to the maximum extent permitted taking into account Affirmer's express Statement of Purpose. In addition, to the extent the Waiver is so judged Affirmer hereby grants to each affected person a royalty-free, non transferable, non sublicensable, non exclusive, irrevocable and unconditional license to exercise Affirmer's Copyright and Related Rights in the Work (i) in all territories worldwide, (ii) for the maximum duration provided by applicable law or treaty (including future time extensions), (iii) in any current or future medium and for any number of copies, and (iv) for any purpose whatsoever, including without limitation commercial, advertising or promotional purposes (the "License"). The License shall be deemed effective as of the date CC0 was applied by Affirmer to the Work. Should any part of the License for any reason be judged legally invalid or ineffective under applicable law, such partial invalidity or ineffectiveness shall not invalidate the remainder of the License, and in such case Affirmer hereby affirms that he or she will not (i) exercise any of his or her remaining Copyright and Related Rights in the Work or (ii) assert any associated claims and causes of action with respect to the Work, in either case contrary to Affirmer's express Statement of Purpose. | ||
|
|
||
| 4. Limitations and Disclaimers. | ||
| -------------------------------- | ||
|
|
||
| a. No trademark or patent rights held by Affirmer are waived, abandoned, surrendered, licensed or otherwise affected by this document. | ||
| b. Affirmer offers the Work as-is and makes no representations or warranties of any kind concerning the Work, express, implied, statutory or otherwise, including without limitation warranties of title, merchantability, fitness for a particular purpose, non infringement, or the absence of latent or other defects, accuracy, or the present or absence of errors, whether or not discoverable, all to the greatest extent permissible under applicable law. | ||
| c. Affirmer disclaims responsibility for clearing rights of other persons that may apply to the Work or any use thereof, including without limitation any person's Copyright and Related Rights in the Work. Further, Affirmer disclaims responsibility for obtaining any necessary consents, permissions or other rights required for any use of the Work. | ||
| d. Affirmer understands and acknowledges that Creative Commons is not a party to this document and has no duty or obligation with respect to this CC0 or use of the Work. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| ## About | ||
| This is a sample that depicts how to integrate the `msal-node-extensions` library to your [electron](https://www.electronjs.org/) application that has been bundled by [webpack](https://webpack.js.org/). | ||
|
|
||
| ## Getting started | ||
| To get started using this sample, you need to do the following: | ||
|
|
||
| **1. Change the MSAL Electron Configuration** \ | ||
| Navigate to the `main.ts` file in the src folder and replace the `<CLIENT_ID>` with your client ID. Follow this [steps](https://docs.microsoft.com/en-us/graph/toolkit/get-started/build-an-electron-app#add-new-application-registration-in-azure-ad-to-get-a-client-id) to generate the client ID from Azure. | ||
|
derisen marked this conversation as resolved.
|
||
|
|
||
| ```js | ||
| // Initialize the electron authenticator | ||
| const config: MsalElectronConfig = { | ||
| clientId: '<CLIENT_ID>', // <<== Replace this placeholder with your client ID | ||
| mainWindow: mainWindow, //BrowserWindow instance that requires auth | ||
| scopes: [ | ||
| 'user.read', | ||
| 'people.read', | ||
| 'user.readbasic.all', | ||
| 'contacts.read', | ||
| 'presence.read.all', | ||
| 'presence.read', | ||
| 'user.read.all', | ||
| 'calendars.read', | ||
| 'Sites.Read.All', | ||
| 'Sites.ReadWrite.All', | ||
| ], | ||
| cachePlugin: new PersistenceCachePlugin(persistence), | ||
| }; | ||
| ``` | ||
|
|
||
| **2. Run `npm install`** \ | ||
| Run `npm install` or your preferred alternative to it, to install the dependencies necessary to run the sample. | ||
|
|
||
| ```bash | ||
| npm install | ||
| ``` | ||
|
|
||
| **3. Create the DPAPI.node symlink** \ | ||
| To allow the `bindings` library to correctly locate the `dpapi.node` file you need to create a symlink to it in the `build` folder on the root of the sample. Run the command below while in the `build` folder on the sample's root to do that. | ||
|
samuelkubai marked this conversation as resolved.
Outdated
|
||
|
|
||
| ```bash | ||
| ln -s ../node_modules/@azure/msal-node-extensions/build/Release/dpapi.node dpapi.node | ||
| ``` | ||
|
|
||
| **4. Start your application** \ | ||
| To start your application, run the command below: | ||
|
|
||
| ```bash | ||
| npm run start | ||
| ``` | ||
|
|
||
| > NOTE: If you encounter any errors related to having some of the binaries built with a different NODE_VERSION, run `npm run rebuild` to try rebuild the application with the right NODE_VERSION target | ||
Empty file.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| <!DOCTYPE html> | ||
| <html> | ||
| <head> | ||
| <meta charset="UTF-8" /> | ||
| <title>Sample Electron Msal Node Etensions</title> | ||
| </head> | ||
| <body> | ||
| <mgt-login></mgt-login> | ||
| <mgt-agenda group-by-day></mgt-agenda> | ||
| <script type="module" src="./dist/renderer.js"></script> | ||
| </body> | ||
| </html> |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.