Merge pull request #4019 from NishkalankBezawada/main

samples/react-manage-hublevel-subscriptions/.gitignore

@@ -0,0 +1,34 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+
+# Dependency directories
+node_modules
+
+# Build generated files
+dist
+lib
+release
+solution
+temp
+*.sppkg
+.heft
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# OSX
+.DS_Store
+
+# Visual Studio files
+.ntvs_analysis.dat
+.vs
+bin
+obj
+
+# Resx Generated Code
+*.resx.ts
+
+# Styles Generated Code
+*.scss.ts

samples/react-manage-hublevel-subscriptions/.npmignore

@@ -0,0 +1,16 @@
+!dist
+config
+
+gulpfile.js
+
+release
+src
+temp
+
+tsconfig.json
+tslint.json
+
+*.log
+
+.yo-rc.json
+.vscode

samples/react-manage-hublevel-subscriptions/.yo-rc.json

@@ -0,0 +1,21 @@
+{
+  "@microsoft/generator-sharepoint": {
+    "plusBeta": false,
+    "isCreatingSolution": true,
+    "nodeVersion": "16.18.1",
+    "sdksVersions": {
+      "@microsoft/microsoft-graph-client": "3.0.2",
+      "@microsoft/teams-js": "2.9.1"
+    },
+    "version": "1.17.4",
+    "libraryName": "react-manage-hublevel-list-subscriptions",
+    "libraryId": "e2c0325f-7b70-4738-b4cf-568be2bdf627",
+    "environment": "spo",
+    "packageManager": "npm",
+    "solutionName": "react-manage-hublevel-list-subscriptions",
+    "solutionShortDescription": "react-manage-hublevel-list-subscriptions description",
+    "skipFeatureDeployment": true,
+    "isDomainIsolated": false,
+    "componentType": "webpart"
+  }
+}

samples/react-manage-hublevel-subscriptions/README.md

@@ -0,0 +1,88 @@
+# Subscription Manager
+
+## Summary
+
+This sample web part demonstrates managing the list subscriptions (sharepoint webhooks) and action to renew the webhook expiration date using Rest calls. The webpart is to be added at Hubsite level or the sites associated to the hubsite, on selection of the site, it will list out the lists available. On list/library selection, the available subscriptions is displayed. Depending upon the expiry date of the subscription, 'Renew subscription' action can be performed. The subscription (webhook expiry renewal date) renewal date is set to 179 days, as the default days are 180. 
+
+# Subscription Manager
+
+![](./assets/SubscriptionsDashboard.gif)
+
+# Configuring subscription manager webpart
+
+![](./assets/ConfiguringWebpart.gif)
+
+# Renewing webhook subscriptions
+
+![](./assets/RenewingSubscriptions.gif)
+
+# Configuration error while adding the webpart to Non-Hub related sites 
+
+![](./assets/ConfiguringWebpart-NonHubrelatedSite.gif)
+
+## Compatibility
+
+| :warning: Important          |
+|:---------------------------|
+| Every SPFx version is only compatible with specific version(s) of Node.js. In order to be able to build this sample, please 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.   |
+
+![SPFx 1.17.4](https://img.shields.io/badge/SPFx-1.17.4-green.svg)
+![Node.js v16 | v14](https://img.shields.io/badge/Node.js-v16%20%7C%20v14-green.svg) 
+![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg)
+![Does not work with SharePoint 2019](https://img.shields.io/badge/SharePoint%20Server%202019-Incompatible-red.svg "SharePoint Server 2019 requires SPFx 1.4.1 or lower")
+![Does not work with SharePoint 2016 (Feature Pack 2)](https://img.shields.io/badge/SharePoint%20Server%202016%20(Feature%20Pack%202)-Incompatible-red.svg "SharePoint Server 2016 Feature Pack 2 requires SPFx 1.1")
+![Local Workbench Unsupported](https://img.shields.io/badge/Local%20Workbench-Unsupported-red.svg "Local workbench is no longer available as of SPFx 1.13 and above")
+![Hosted Workbench Compatible (with permissions)](https://img.shields.io/badge/Hosted%20Workbench-Compatible-yellow.svg "Requires API permissions")
+![Compatible with Remote Containers](https://img.shields.io/badge/Remote%20Containers-Compatible-green.svg)
+
+## Prerequisites
+
+This web part requires access to lists and libraries to perform renewing the webhook subscription 
+
+## References
+
+*[Get Subscription](https://learn.microsoft.com/en-us/sharepoint/dev/apis/webhooks/lists/get-subscription)
+*[Update Subscription](https://learn.microsoft.com/en-us/sharepoint/dev/apis/webhooks/lists/update-subscription)
+
+## Minimal Path to Awesome
+
+- 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-manage-hublevel-subscriptions) then unzip it)
+- From your command line, change your current directory to the directory containing this sample (`react-manage-hublevel-subscriptions`, located under `samples`)
+- in the command-line run:
+  - `npm install`
+  - `gulp serve`
+
+>  This sample can also be opened with [VS Code Remote Development](https://code.visualstudio.com/docs/remote/remote-overview). Visit https://aka.ms/spfx-devcontainer for further instructions.
+
+## Contributors
+
+* [Nishkalank Bezawada](https://github.com/NishkalankBezawada)
+
+## Version history
+
+Version|Date|Comments
+-------|----|--------
+1.0|September 9, 2023|Initial release
+
+## 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-manage-hublevel-subscriptions%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-manage-hublevel-subscriptions) and see what the community is saying.
+
+If you encounter any issues while 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-manage-hublevel-subscriptions&template=bug-report.yml&sample=react-manage-hublevel-subscriptions&authors=@NishkalankBezawada&title=react-manage-hublevel-subscriptions%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-manage-hublevel-subscriptions&template=question.yml&sample=react-manage-hublevel-subscriptions&authors=@NishkalankBezawada&title=react-manage-hublevel-subscriptions%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-manage-hublevel-subscriptions&template=suggestion.yml&sample=react-manage-hublevel-subscriptions&authors=@NishkalankBezawada&title=react-manage-hublevel-subscriptions%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-manage-hublevel-subscriptions" />

samples/react-manage-hublevel-subscriptions/assets/sample.json

@@ -0,0 +1,81 @@
+[
+    {
+        "name": "pnp-sp-dev-spfx-web-parts-react-manage-hublevel-subscriptions",
+        "source": "pnp",
+        "title": "React-Manage-Subscriptions",
+        "shortDescription": "This sample web part demonstrates managing the list subscriptions (sharepoint webhooks) and action to renew the webhook expiration date using Rest calls.",
+        "url": "https://github.com/pnp/sp-dev-fx-webparts/tree/main/samples/react-manage-hublevel-subscriptions",
+        "longDescription": [
+            "This sample web part demonstrates managing the list subscriptions (sharepoint webhooks) and action to renew the webhook expiration date using Rest calls. The webpart is to be added at Hubsite level or the sites associated to the hubsite, on selection of the site, it will list out the lists available. On list/library selection, the available subscriptions is displayed. Depending upon the expiry date of the subscription, 'Renew subscription' action can be performed. The subscription (webhook expiry renewal date) renewal date is set to 179 days, as the default days are 180. "
+        ],
+        "creationDateTime": "2023-09-01",
+        "updateDateTime": "2023-09-01",
+        "products": [
+            "SharePoint",
+            "WebHooks",
+            "Subscriptions",
+            "Update Subscriptions",
+            "Get Subscriptions"
+        ],
+        "metadata": [
+            {
+                "key": "CLIENT-SIDE-DEV",
+                "value": "React"
+            },
+            {
+                "key": "SPFX-VERSION",
+                "value": "1.17.4"
+            }
+        ],
+        "thumbnails": [
+            {
+                "type": "image",
+                "order": 100,
+                "url": "https://github.com/pnp/sp-dev-fx-webparts/raw/main/samples/react-manage-hublevel-subscriptions/assets/SubscriptionsDashboard.gif",
+                "alt": "Subscription Manager"
+            },
+            {
+                "type": "image",
+                "order": 101,
+                "url": "https://github.com/pnp/sp-dev-fx-webparts/raw/main/samples/react-manage-hublevel-subscriptions/assets/ConfiguringWebpart.gif",
+                "alt": "Configuring subscription manager webpart"
+            },
+            {
+                "type": "image",
+                "order": 102,
+                "url": "https://github.com/pnp/sp-dev-fx-webparts/raw/main/samples/react-manage-hublevel-subscriptions/assets/RenewingSubscriptions.gif",
+                "alt": "Renewing webhook subscriptions"
+            },
+            {
+                "type": "image",
+                "order": 103,
+                "url": "https://github.com/pnp/sp-dev-fx-webparts/raw/main/samples/react-manage-hublevel-subscriptions/assets/ConfiguringWebpart-NonHubrelatedSite.gif",
+                "alt": "Configuration error while adding the webpart to Non-Hub related sites"
+            }
+        ],
+        "authors": [
+            {
+                "gitHubAccount": "NishkalankBezawada",
+                "pictureUrl": "https://github.com/NishkalankBezawada.png",
+                "name": "NIshkalank Bezawada"
+            }
+        ],
+        "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://learn.microsoft.com/sharepoint/dev/spfx/web-parts/get-started/build-a-hello-world-web-part"
+            },
+            {
+                "name": "Get Subscription",
+                "description": "Get SharePoint webhook subscriptions",
+                "url": "https://learn.microsoft.com/en-us/sharepoint/dev/apis/webhooks/lists/get-subscription"
+            },
+            {
+                "name": "Update Subscription",
+                "description": "Update SharePoint webhook subscriptions",
+                "url": "https://learn.microsoft.com/en-us/sharepoint/dev/apis/webhooks/lists/update-subscription"
+            }
+        ]
+    }
+]

samples/react-manage-hublevel-subscriptions/config/config.json

@@ -0,0 +1,19 @@
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/spfx-build/config.2.0.schema.json",
+  "version": "2.0",
+  "bundles": {
+    "react-manage-hublevel-list-subscriptions-web-part": {
+      "components": [
+        {
+          "entrypoint": "./lib/webparts/reactManageHublevelSubscriptions/ReactManageHublevelSubscriptionsWebPart.js",
+          "manifest": "./src/webparts/reactManageHublevelSubscriptions/ReactManageHublevelSubscriptionsWebPart.manifest.json"
+        }
+      ]
+    }
+  },
+  "externals": {},
+  "localizedResources": {
+    "ReactManageHublevelSubscriptionsWebPartStrings": "lib/webparts/reactManageHublevelSubscriptions/loc/{locale}.js",
+    "ControlStrings": "node_modules/@pnp/spfx-controls-react/lib/loc/{locale}.js"
+  }
+}

samples/react-manage-hublevel-subscriptions/config/deploy-azure-storage.json

@@ -0,0 +1,7 @@
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/spfx-build/deploy-azure-storage.schema.json",
+  "workingDir": "./release/assets/",
+  "account": "<!-- STORAGE ACCOUNT NAME -->",
+  "container": "react-manage-hublevel-list-subscriptions",
+  "accessKey": "<!-- ACCESS KEY -->"
+}

samples/react-manage-hublevel-subscriptions/config/package-solution.json

@@ -0,0 +1,40 @@
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/spfx-build/package-solution.schema.json",
+  "solution": {
+    "name": "react-manage-hublevel-list-subscriptions-client-side-solution",
+    "id": "e2c0325f-7b70-4738-b4cf-568be2bdf627",
+    "version": "1.0.0.0",
+    "includeClientSideAssets": true,
+    "skipFeatureDeployment": true,
+    "isDomainIsolated": false,
+    "developer": {
+      "name": "Nishkalank Bezawada",
+      "websiteUrl": "https://github.com/NishkalankBezawada",
+      "privacyUrl": "",
+      "termsOfUseUrl": "",
+      "mpnId": "Undefined-1.17.4"
+    },
+    "metadata": {
+      "shortDescription": {
+        "default": "react-manage-hublevel-list-subscriptions description"
+      },
+      "longDescription": {
+        "default": "react-manage-hublevel-list-subscriptions description"
+      },
+      "screenshotPaths": [],
+      "videoUrl": "",
+      "categories": []
+    },
+    "features": [
+      {
+        "title": "react-manage-hublevel-list-subscriptions Feature",
+        "description": "The feature that activates elements of the react-manage-hublevel-list-subscriptions solution.",
+        "id": "668cceeb-581c-4f11-b14d-2510726c7f2a",
+        "version": "1.0.0.0"
+      }
+    ]
+  },
+  "paths": {
+    "zippedPackage": "solution/react-manage-hublevel-list-subscriptions.sppkg"
+  }
+}

samples/react-manage-hublevel-subscriptions/config/sass.json

@@ -0,0 +1,3 @@
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/core-build/sass.schema.json"
+}

samples/react-manage-hublevel-subscriptions/config/serve.json

@@ -0,0 +1,6 @@
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/spfx-build/spfx-serve.schema.json",
+  "port": 4321,
+  "https": true,
+  "initialPage": "https://{tenantDomain}/_layouts/workbench.aspx"
+}

samples/react-manage-hublevel-subscriptions/config/write-manifests.json

@@ -0,0 +1,4 @@
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/spfx-build/write-manifests.schema.json",
+  "cdnBasePath": "<!-- PATH TO CDN -->"
+}

samples/react-manage-hublevel-subscriptions/gulpfile.js

@@ -0,0 +1,16 @@
+'use strict';
+
+const build = require('@microsoft/sp-build-web');
+
+build.addSuppression(`Warning - [sass] The local CSS class 'ms-Grid' is not camelCase and will not be type-safe.`);
+
+var getTasks = build.rig.getTasks;
+build.rig.getTasks = function () {
+  var result = getTasks.call(build.rig);
+
+  result.set('serve', result.get('serve-deprecated'));
+
+  return result;
+};
+
+build.initialize(require('gulp'));