Updated readme, fixed lints, and added container
This commit is contained in:
Hugo Bernier
parent
3d1a156705
commit
bb54263bb8
|
|
@ -0,0 +1,39 @@
|
|||
// For more information on how to run this SPFx project in a VS Code Remote Container, please visit https://aka.ms/spfx-devcontainer
|
||||
{
|
||||
"name": "SPFx 1.17.1",
|
||||
"image": "docker.io/m365pnp/spfx:1.17.1",
|
||||
// Set *default* container specific settings.json values on container create.
|
||||
"settings": {},
|
||||
// Add the IDs of extensions you want installed when the container is created.
|
||||
"extensions": [
|
||||
"editorconfig.editorconfig",
|
||||
"dbaeumer.vscode-eslint"
|
||||
],
|
||||
// Use 'forwardPorts' to make a list of ports inside the container available locally.
|
||||
"forwardPorts": [
|
||||
4321,
|
||||
35729
|
||||
],
|
||||
"portsAttributes": {
|
||||
"4321": {
|
||||
"protocol": "https",
|
||||
"label": "Manifest",
|
||||
"onAutoForward": "silent",
|
||||
"requireLocalPort": true
|
||||
},
|
||||
// Not needed for SPFx>= 1.12.1
|
||||
// "5432": {
|
||||
// "protocol": "https",
|
||||
// "label": "Workbench",
|
||||
// "onAutoForward": "silent"
|
||||
// },
|
||||
"35729": {
|
||||
"protocol": "https",
|
||||
"label": "LiveReload",
|
||||
"onAutoForward": "silent",
|
||||
"requireLocalPort": true
|
||||
}
|
||||
},
|
||||
"postCreateCommand": "bash .devcontainer/spfx-startup.sh",
|
||||
"remoteUser": "node"
|
||||
}
|
||||
|
|
@ -0,0 +1,33 @@
|
|||
echo
|
||||
echo -e "\e[1;94mInstalling Node dependencies\e[0m"
|
||||
npm install
|
||||
|
||||
## commands to create dev certificate and copy it to the root folder of the project
|
||||
echo
|
||||
echo -e "\e[1;94mGenerating dev certificate\e[0m"
|
||||
gulp trust-dev-cert
|
||||
|
||||
# Convert the generated PEM certificate to a CER certificate
|
||||
openssl x509 -inform PEM -in ~/.rushstack/rushstack-serve.pem -outform DER -out ./spfx-dev-cert.cer
|
||||
|
||||
# Copy the PEM ecrtificate for non-Windows hosts
|
||||
cp ~/.rushstack/rushstack-serve.pem ./spfx-dev-cert.pem
|
||||
|
||||
## add *.cer to .gitignore to prevent certificates from being saved in repo
|
||||
if ! grep -Fxq '*.cer' ./.gitignore
|
||||
then
|
||||
echo "# .CER Certificates" >> .gitignore
|
||||
echo "*.cer" >> .gitignore
|
||||
fi
|
||||
|
||||
## add *.pem to .gitignore to prevent certificates from being saved in repo
|
||||
if ! grep -Fxq '*.pem' ./.gitignore
|
||||
then
|
||||
echo "# .PEM Certificates" >> .gitignore
|
||||
echo "*.pem" >> .gitignore
|
||||
fi
|
||||
|
||||
echo
|
||||
echo -e "\e[1;92mReady!\e[0m"
|
||||
|
||||
echo -e "\n\e[1;94m**********\nOptional: if you plan on using gulp serve, don't forget to add the container certificate to your local machine. Please visit https://aka.ms/spfx-devcontainer for more information\n**********"
|
||||
|
|
@ -10,28 +10,40 @@ This sample web part shows a report of the web parts used on the current site.
|
|||
|
||||
|
||||
|
||||
## Used SharePoint Framework Version
|
||||
Compatibility
|
||||
|
||||
|
||||
| :warning: Important |
|
||||
|:---------------------------|
|
||||
| Every SPFx version is optimally compatible with specific versions of Node.js. In order to be able to build this sample, you need to ensure that the version of Node on your workstation matches one of the versions listed in this section. This sample will not work on a different version of Node.|
|
||||
|Refer to <https://aka.ms/spfx-matrix> for more information on SPFx compatibility. |
|
||||
|
||||
This sample is optimally compatible with the following environment configuration:
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
-Incompatible-red.svg "SharePoint Server 2016 Feature Pack 2 requires SPFx 1.1")
|
||||
|
||||
|
||||
|
||||
|
||||
## Applies to
|
||||
|
||||
- [SharePoint Framework](https://aka.ms/spfx)
|
||||
- [Microsoft 365 tenant](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/set-up-your-developer-tenant)
|
||||
* [SharePoint Framework](https://learn.microsoft.com/sharepoint/dev/spfx/sharepoint-framework-overview)
|
||||
* [Microsoft 365 tenant](https://learn.microsoft.com/sharepoint/dev/spfx/set-up-your-development-environment)
|
||||
|
||||
> Get your own free development tenant by subscribing to [Microsoft 365 developer program](http://aka.ms/o365devprogram)
|
||||
> Get your own free development tenant by subscribing to [Microsoft 365 developer program](http://aka.ms/m365devprogram)
|
||||
|
||||
## Prerequisites
|
||||
|
||||
Microsoft Graph permission:
|
||||
|
||||
- Sites.Read.All
|
||||
* Sites.Read.All
|
||||
|
||||
## Solution
|
||||
## Contributors
|
||||
|
||||
| Solution | Author(s) |
|
||||
| ----------- | ------------------------------------------------------- |
|
||||
| react-graph-webpart-report | [Aimery Thomas](https://github.com/a1mery) |
|
||||
* [Aimery Thomas](https://github.com/a1mery) |
|
||||
|
||||
## Version history
|
||||
|
||||
|
|
@ -39,18 +51,14 @@ Microsoft Graph permission:
|
|||
| ------- | ---------------- | --------------- |
|
||||
| 1.0 | March 23, 2023 | Initial release |
|
||||
|
||||
## Disclaimer
|
||||
|
||||
**THIS CODE IS PROVIDED _AS IS_ WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING ANY IMPLIED WARRANTIES OF FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, OR NON-INFRINGEMENT.**
|
||||
|
||||
---
|
||||
|
||||
## Minimal Path to Awesome
|
||||
|
||||
- Clone this repository
|
||||
- Ensure that you are at the solution folder
|
||||
- in the command-line run:
|
||||
- `npm install`
|
||||
* Clone this repository (or [download this solution as a .ZIP file](https://pnp.github.io/download-partial/?url=https://github.com/pnp/sp-dev-fx-webparts/tree/main/samples/react-graph-webpart-report) then unzip it)
|
||||
* From your command line, change your current directory to the directory containing this sample (`react-graph-webpart-report`, located under `samples`)
|
||||
* in the command line run:
|
||||
* `npm install`
|
||||
- `gulp bundle`
|
||||
- `gulp package-solution`
|
||||
- Deploy the package to your app catalog
|
||||
|
|
@ -59,10 +67,9 @@ Microsoft Graph permission:
|
|||
- In the command-line run:
|
||||
- `gulp serve --nobrowser`
|
||||
|
||||
|
||||
## Features
|
||||
|
||||
This webpart illustrates the following concepts:
|
||||
This web part illustrates the following concepts:
|
||||
|
||||
- Consume the Microsoft Graph API from SPFx web part
|
||||
- Use of the SharePoint Pages Microsoft Graph API
|
||||
|
|
@ -77,3 +84,25 @@ This webpart illustrates the following concepts:
|
|||
- [Adding support for web part Top Actions](https://learn.microsoft.com/en-us/sharepoint/dev/spfx/web-parts/guidance/getting-started-with-top-actions)
|
||||
- [Microsoft 365 Patterns and Practices](https://aka.ms/m365pnp) - Guidance, tooling, samples and open-source controls for your Microsoft 365 development
|
||||
- [@pnp/spfx-controls-react](https://pnp.github.io/sp-dev-fx-controls-react/)
|
||||
|
||||
## Help
|
||||
|
||||
We do not support samples, but this community is always willing to help, and we want to improve these samples. We use GitHub to track issues, which makes it easy for community members to volunteer their time and help resolve issues.
|
||||
|
||||
If you're having issues building the solution, please run [spfx doctor](https://pnp.github.io/cli-microsoft365/cmd/spfx/spfx-doctor/) from within the solution folder to diagnose incompatibility issues with your environment.
|
||||
|
||||
You can try looking at [issues related to this sample](https://github.com/pnp/sp-dev-fx-webparts/issues?q=label%3A%22sample%3A%20react-graph-webpart-report%22) to see if anybody else is having the same issues.
|
||||
|
||||
You can also try looking at [discussions related to this sample](https://github.com/pnp/sp-dev-fx-webparts/discussions?discussions_q=react-graph-webpart-report) and see what the community is saying.
|
||||
|
||||
If you encounter any issues using this sample, [create a new issue](https://github.com/pnp/sp-dev-fx-webparts/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Abug-suspected%2Csample%3A%20react-graph-webpart-report&template=bug-report.yml&sample=react-graph-webpart-report&authors=@a1mery&title=react-graph-webpart-report%20-%20).
|
||||
|
||||
For questions regarding this sample, [create a new question](https://github.com/pnp/sp-dev-fx-webparts/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Aquestion%2Csample%3A%20react-graph-webpart-report&template=question.yml&sample=react-graph-webpart-report&authors=@a1mery&title=react-graph-webpart-report%20-%20).
|
||||
|
||||
Finally, if you have an idea for improvement, [make a suggestion](https://github.com/pnp/sp-dev-fx-webparts/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Aenhancement%2Csample%3A%20react-graph-webpart-report&template=suggestion.yml&sample=react-graph-webpart-report&authors=@a1mery&title=react-graph-webpart-report%20-%20).
|
||||
|
||||
## Disclaimer
|
||||
|
||||
**THIS CODE IS PROVIDED *AS IS* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING ANY IMPLIED WARRANTIES OF FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, OR NON-INFRINGEMENT.**
|
||||
|
||||
<img src="https://m365-visitor-stats.azurewebsites.net/sp-dev-fx-webparts/samples/react-graph-webpart-report" />
|
||||
|
|
|
|||
|
|
@ -0,0 +1,50 @@
|
|||
[
|
||||
{
|
||||
"name": "pnp-sp-dev-spfx-web-parts-react-graph-webpart-report",
|
||||
"source": "pnp",
|
||||
"title": "Web Part Report",
|
||||
"shortDescription": "This sample web part shows a report of the web parts used on the current site.",
|
||||
"url": "https://github.com/pnp/sp-dev-fx-webparts/tree/main/samples/react-graph-webpart-report",
|
||||
"downloadUrl": "https://pnp.github.io/download-partial/?url=https://github.com/pnp/sp-dev-fx-webparts/tree/main/samples/react-graph-webpart-report",
|
||||
"longDescription": [
|
||||
"This sample web part shows a report of the web parts used on the current site."
|
||||
],
|
||||
"creationDateTime": "2023-05-13",
|
||||
"updateDateTime": "2023-05-13",
|
||||
"products": [
|
||||
"SharePoint"
|
||||
],
|
||||
"metadata": [
|
||||
{
|
||||
"key": "CLIENT-SIDE-DEV",
|
||||
"value": "React"
|
||||
},
|
||||
{
|
||||
"key": "SPFX-VERSION",
|
||||
"value": "1.17.1"
|
||||
}
|
||||
],
|
||||
"thumbnails": [
|
||||
{
|
||||
"type": "image",
|
||||
"order": 100,
|
||||
"url": "https://github.com/pnp/sp-dev-fx-webparts/raw/main/samples/react-graph-webpart-report/assets/YOUR-IMAGE-NAME-HERE",
|
||||
"alt": "Web Part Preview"
|
||||
}
|
||||
],
|
||||
"authors": [
|
||||
{
|
||||
"gitHubAccount": "a1mery",
|
||||
"pictureUrl": "https://github.com/a1mery.png",
|
||||
"name": "Aimery Thomas"
|
||||
}
|
||||
],
|
||||
"references": [
|
||||
{
|
||||
"name": "Build your first SharePoint client-side web part",
|
||||
"description": "Client-side web parts are client-side components that run in the context of a SharePoint page. Client-side web parts can be deployed to SharePoint environments that support the SharePoint Framework. You can also use modern JavaScript web frameworks, tools, and libraries to build them.",
|
||||
"url": "https://docs.microsoft.com/en-us/sharepoint/dev/spfx/web-parts/get-started/build-a-hello-world-web-part"
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
File diff suppressed because it is too large
Load Diff
|
|
@ -3,17 +3,20 @@ import { SitePage } from "./types";
|
|||
|
||||
|
||||
export interface IGraphService {
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
GetWebParts(client: MSGraphClientV3, siteId: string, pageId: string): Promise<any>;
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
GetSitePages(client: MSGraphClientV3, siteId: string): Promise<any>;
|
||||
}
|
||||
|
||||
|
||||
|
||||
class GraphService implements IGraphService {
|
||||
constructor() { }
|
||||
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
public async GetWebParts(client: MSGraphClientV3, siteId: string, pageId: string): Promise<any> {
|
||||
try{
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
const rawWebParts: any = await this.GET(client, "sites/" + siteId + "/pages/" + pageId + "/webparts","","");
|
||||
return rawWebParts;
|
||||
} catch (error){
|
||||
|
|
@ -24,7 +27,9 @@ class GraphService implements IGraphService {
|
|||
}
|
||||
|
||||
public async GetSitePages(client: MSGraphClientV3, siteId: string): Promise<SitePage[]> {
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
const rawPages: any = await this.GET(client, "sites/" + siteId + "/pages", "", "id,title");
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
return rawPages.value.flatMap((rawPage: any) => (
|
||||
[
|
||||
{
|
||||
|
|
@ -36,9 +41,13 @@ class GraphService implements IGraphService {
|
|||
}
|
||||
|
||||
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
private GET(client: MSGraphClientV3, api: string, filter?: string, select?: string, top?: number, responseType?: any): Promise<any> {
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
return new Promise<any>((resolve, reject) => {
|
||||
// eslint-disable-next-line @typescript-eslint/no-floating-promises
|
||||
client.api(api).version("beta").select(select).filter(filter).responseType(responseType)
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
.get((error: any, response: any) => {
|
||||
if (error) {
|
||||
reject(error);
|
||||
|
|
|
|||
|
|
@ -5,13 +5,16 @@ import { MSGraphClientV3 } from "@microsoft/sp-http";
|
|||
|
||||
export async function _getSiteWebParts(graphClient: MSGraphClientV3, siteId: string): Promise<WebPart[]> {
|
||||
try {
|
||||
let siteWebParts: any = [];
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
const siteWebParts: any = [];
|
||||
const sitePages: SitePage[] = await GraphServiceInstance.GetSitePages(graphClient, siteId);
|
||||
for (let i: number = 0; i<sitePages.length-1; i++){
|
||||
let r: any = await GraphServiceInstance.GetWebParts(graphClient, siteId, sitePages[i].id);
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
const r: any = await GraphServiceInstance.GetWebParts(graphClient, siteId, sitePages[i].id);
|
||||
if (r !== null){
|
||||
siteWebParts.push(
|
||||
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
r.value.flatMap((siteWebPart: any) => ([
|
||||
{
|
||||
siteId: siteId,
|
||||
|
|
@ -22,8 +25,8 @@ export async function _getSiteWebParts(graphClient: MSGraphClientV3, siteId: str
|
|||
]))
|
||||
);
|
||||
}
|
||||
|
||||
}
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
return siteWebParts.flatMap((t: any)=>t);
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -41,6 +41,7 @@ export default class WebPartReportWebPart extends BaseClientSideWebPart<IWebPart
|
|||
}
|
||||
|
||||
protected async onInit(): Promise<void> {
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
return new Promise<void>((resolve: () => void, reject: (error: any) => void): void => {
|
||||
this.context.msGraphClientFactory
|
||||
.getClient("3")
|
||||
|
|
|
|||
|
|
@ -35,6 +35,7 @@ const _viewFields: IViewField[] = [
|
|||
}
|
||||
];
|
||||
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
const options: any = {
|
||||
legend: {
|
||||
display: true,
|
||||
|
|
@ -50,7 +51,7 @@ const options: any = {
|
|||
let siteWebParts: WebPart[];
|
||||
let webPartsCounts: number[] = [];
|
||||
let webPartsTitles: string[] = [];
|
||||
let aggregatedWebPartData = new Map<string, number>();
|
||||
const aggregatedWebPartData = new Map<string, number>();
|
||||
|
||||
export default class WebPartReport extends React.Component<IWebPartReportProps, IWebPartReportWebPartState> {
|
||||
|
||||
|
|
@ -63,8 +64,8 @@ export default class WebPartReport extends React.Component<IWebPartReportProps,
|
|||
};
|
||||
}
|
||||
|
||||
public async componentDidMount() {
|
||||
this._setChartData();
|
||||
public async componentDidMount():Promise<void> {
|
||||
await this._setChartData();
|
||||
}
|
||||
|
||||
private loadingData(): Promise<ChartData> {
|
||||
|
|
@ -83,7 +84,7 @@ export default class WebPartReport extends React.Component<IWebPartReportProps,
|
|||
});
|
||||
}
|
||||
|
||||
public async _setChartData() {
|
||||
public async _setChartData(): Promise<void> {
|
||||
|
||||
webPartsCounts = [];
|
||||
webPartsTitles = [];
|
||||
|
|
@ -125,22 +126,22 @@ export default class WebPartReport extends React.Component<IWebPartReportProps,
|
|||
return (
|
||||
<section className={`${styles.webPartReport} ${hasTeamsContext ? styles.teams : ''}`}>
|
||||
<div className={this.state.loading ? styles.hiddenComponent : ''}>
|
||||
<div className={displayOption.toString() == "2" ? styles.hiddenComponent : ''}>
|
||||
<div className={displayOption.toString() === "2" ? styles.hiddenComponent : ''}>
|
||||
<p className={styles.title}>Web parts list:</p>
|
||||
<ListView
|
||||
viewFields={_viewFields}
|
||||
items={siteWebParts}
|
||||
></ListView>
|
||||
/>
|
||||
</div>
|
||||
<ChartControl
|
||||
type={ChartType.Doughnut}
|
||||
datapromise={this.loadingData()}
|
||||
options={options}
|
||||
className={displayOption.toString() == "1" ? styles.hiddenComponent : ''}
|
||||
className={displayOption.toString() === "1" ? styles.hiddenComponent : ''}
|
||||
/>
|
||||
</div>
|
||||
<div className={!this.state.loading ? styles.hiddenComponent : ''}>
|
||||
<Spinner label="Loading webparts..." />
|
||||
<Spinner label="Loading web parts..." />
|
||||
</div>
|
||||
</section>
|
||||
);
|
||||
|
|
|
|||
Loading…
Reference in New Issue