@zxncij2390/monorepo3 3.18.0

package/.eslintignore

@@ -0,0 +1,16 @@
+# don't ever lint node_modules
+node_modules
+# don't lint build output (make sure it's set to your correct build folder name)
+dist
+build
+docs
+samples
+tools
+# don't lint nyc coverage output
+coverage
+
+# local files
+.eslintrc.cjs
+debug
+buildsystem-config.ts
+settings.js

package/.eslintrc.cjs

@@ -0,0 +1,150 @@
+module.exports = {
+    root: true,
+    parser: "@typescript-eslint/parser",
+    parserOptions: {
+        project: [
+            "./tsconfig.json",
+            "./test/tsconfig.json",
+        ],
+        sourceType: "module",
+    },
+    plugins: [
+        "@typescript-eslint",
+    ],
+    extends: [
+        "eslint:recommended",
+        "plugin:@typescript-eslint/recommended",
+    ],
+    rules: {
+        // updated to address conflicts with code base / typescript such as interface redeclare, etc.
+
+        // reason: @typescript-eslint/indent says to disable indent so it works correctly
+        "indent": "off",
+        // reason: blocks all use of any on anything exposed by the library
+        "@typescript-eslint/explicit-module-boundary-types": "off",
+        // reason: blocks our use of interfaces defined from concrete types
+        "@typescript-eslint/no-empty-interface": "off",
+
+        // migrated by tool from tslint.json
+        "@typescript-eslint/dot-notation": "error",
+        "@typescript-eslint/explicit-member-accessibility": [
+            "error",
+            {
+                accessibility: "explicit",
+                overrides: {
+                    accessors: "explicit",
+                    constructors: "no-public",
+                    methods: "explicit",
+                    properties: "explicit",
+                    parameterProperties: "explicit"
+                  }
+            }
+        ],
+        "@typescript-eslint/no-explicit-any": "off",
+        "@typescript-eslint/indent": ["error", 4],
+        "@typescript-eslint/member-delimiter-style": [
+            "error",
+            {
+                "multiline": {
+                    "delimiter": "semi",
+                    "requireLast": true
+                },
+                "singleline": {
+                    "delimiter": "semi",
+                    "requireLast": false
+                }
+            }
+        ],
+        "@typescript-eslint/member-ordering": ["error", { "default": ["field", "constructor", "signature", "method"] }],
+        "@typescript-eslint/naming-convention": "off",
+        "@typescript-eslint/no-empty-function": "error",
+        "@typescript-eslint/no-inferrable-types": "error",
+        "@typescript-eslint/no-unused-expressions": "error",
+        "@typescript-eslint/no-use-before-define": "off",
+        "@typescript-eslint/quotes": [
+            "error",
+            "double",
+            {
+                "avoidEscape": true
+            }
+        ],
+        "@typescript-eslint/semi": [
+            "error",
+            "always"
+        ],
+        "@typescript-eslint/type-annotation-spacing": "error",
+        "brace-style": [
+            "error",
+            "1tbs"
+        ],
+        "comma-dangle": [
+            "error",
+            "always-multiline"
+        ],
+        "curly": "error",
+        "eol-last": "error",
+        "eqeqeq": [
+            "error",
+            "smart"
+        ],
+        "guard-for-in": "error",
+        "id-blacklist": "off",
+        "id-match": "off",
+        "max-len": [
+            "error",
+            {
+                "code": 180
+            }
+        ],
+        "no-bitwise": "error",
+        "no-caller": "error",
+        "no-console": [
+            "error",
+            {
+                "allow": [
+                    "log",
+                    "warn",
+                    "dir",
+                    "timeLog",
+                    "assert",
+                    "clear",
+                    "count",
+                    "countReset",
+                    "group",
+                    "groupEnd",
+                    "table",
+                    "dirxml",
+                    "error",
+                    "groupCollapsed",
+                    "Console",
+                    "profile",
+                    "profileEnd",
+                    "timeStamp",
+                    "context"
+                ]
+            }
+        ],
+        "no-debugger": "off",
+        "no-empty": "error",
+        "no-eval": "error",
+        "no-fallthrough": "error",
+        "no-multiple-empty-lines": "off",
+        "no-new-wrappers": "error",
+        "no-redeclare": "error",
+        "no-trailing-spaces": "error",
+        "no-underscore-dangle": "off",
+        "no-unused-labels": "error",
+        "no-var": "error",
+        "prefer-const": "error",
+        "radix": "error",
+        "spaced-comment": [
+            "error",
+            "always",
+            {
+                "markers": [
+                    "/"
+                ]
+            }
+        ],
+    },
+};

package/.github/ISSUE_TEMPLATE/bug-report.yml

@@ -0,0 +1,178 @@
+name: 🐞 Bug or Error Report
+description: Submit a bug or error report.
+labels: ["type: someting isn't working", "status: investigate"]
+
+body:
+- type: markdown
+  attributes:
+    value: |
+      This issue type is for submitting bugs or errors you believe you have found with the PnPjs library. If your submission references permission errors or 5xx status code responses, this is almost certainly not a bug with PnPjs but rather and issue with your configuration, please refer to other support options listed on the [new issue chooser page](https://github.dev/juliemturner/pnpjs/issues/new/choose). Please provide as much information as possible so we can best address your submission. Thanks!
+
+      - Follow our guidance on [How To Create Good Issues](https://github.dev/juliemturner/pnpjs/wiki/How-to-Create-Good-Issues).
+      - Remember to include sufficient details and context.
+      - If you have multiple questions, suggestions, or bugs, please submit them in separate issues.
+- type: dropdown
+  attributes:
+    label: Major Version
+    options:
+      - 4.x
+      - 3.x
+      - 2.x (No longer supported)
+      - 1.x (No longer supported)
+    default: 1
+  validations:
+    required: true
+- type: input
+  id: minorver
+  attributes:
+    label: Minor Version Number
+    description: Include the minor and patch version numbers, e.g. for 4.1.0 
+    placeholder: '1.0'
+  validations:
+    required: true
+- type: dropdown
+  attributes:
+    label: Target environment
+    options:
+      - All
+      - SharePoint Framework
+      - NodeJS
+      - Browser App (Hosted external to Microsoft 365 platform)
+      - other (enter in the "Additional environment details" area below)
+  validations:
+    required: true
+- type: textarea
+  attributes:
+    label: Additional environment details
+    description: Please describe the environment you're working in and how you're authenticating.
+    placeholder: |
+      I'm using NodeJS and certificate based MSAL for authentication.
+  validations:
+    required: true    
+- type: textarea
+  attributes:
+    label: Expected or Desired Behavior
+    description: Describe what you are trying to accomplish.
+    placeholder: |
+      I'm trying to get items from a list in a site.
+  validations:
+    required: true         
+- type: textarea
+  attributes:
+    label: Observed Behavior
+    description: Describe the results you're getting.
+    placeholder: |
+      I'm getting an empty response
+  validations:
+    required: true
+- type: textarea
+  attributes:
+    label: Steps to Reproduce
+    description: Please included code fenced example code, OR a link to a code snippet using GitHub or CodePen or the like to show how your code is structured. See the sample above.
+    placeholder: |
+      Here is the code I'm running
+      
+      ```TypeScript
+      import { spfi } from "@pnp/sp";
+      import "@pnp/sp/webs";
+      import "@pnp/sp/lists";
+      import "@pnp/sp/items";
+
+      const sp = spfi(...);
+
+      // get all the items from a list
+      const items: any[] = await sp.web.lists.getByTitle("My List").items();
+      console.log(items);
+      ```  
+  validations:
+    required: true
+       
+     
+=======
+name: 🐞 Bug or Error Report
+description: Submit a bug or error report.
+labels: ["type: something isn't working", "status: investigate"]
+
+body:
+- type: markdown
+  attributes:
+    value: |
+      This issue type is for submitting bugs or errors you believe you have found with the PnPjs library. If your submission references permission errors or 5xx status code responses, this is almost certainly not a bug with PnPjs but rather and issue with your configuration, please refer to other support options listed on the [new issue chooser page](https://github.dev/juliemturner/pnpjs/issues/new/choose). Please provide as much information as possible so we can best address your submission. Thanks!
+
+      - Follow our guidance on [How To Create Good Issues](https://github.dev/juliemturner/pnpjs/wiki/How-to-Create-Good-Issues).
+      - Remember to include sufficient details and context.
+      - If you have multiple questions, suggestions, or bugs, please submit them in separate issues.
+- type: dropdown
+  attributes:
+    label: Major Version
+    options:
+      - 4.x
+      - 3.x
+      - 2.x (No longer supported)
+      - 1.x (No longer supported)
+  validations:
+    required: true
+- type: input
+  id: minorver
+  attributes:
+    label: Minor Version Number
+    description: Include the minor and patch version numbers, e.g. for 4.1.0 
+    placeholder: '1.0'
+  validations:
+    required: true
+- type: dropdown
+  attributes:
+    label: Target environment
+    options:
+      - All
+      - SharePoint Framework
+      - NodeJS
+      - Browser App (Hosted external to Microsoft 365 platform)
+      - other (enter in the "Additional environment details" area below)
+  validations:
+    required: true
+- type: textarea
+  attributes:
+    label: Additional environment details
+    description: Please describe the environment you're working in and how you're authenticating.
+    placeholder: |
+      I'm using NodeJS and certificate based MSAL for authentication.
+  validations:
+    required: true    
+- type: textarea
+  attributes:
+    label: Expected or Desired Behavior
+    description: Describe what you are trying to accomplish.
+    placeholder: |
+      I'm trying to get items from a list in a site.
+  validations:
+    required: true         
+- type: textarea
+  attributes:
+    label: Observed Behavior
+    description: Describe the results you're getting.
+    placeholder: |
+      I'm getting an empty response
+  validations:
+    required: true
+- type: textarea
+  attributes:
+    label: Steps to Reproduce
+    description: Please included code fenced example code, OR a link to a code snippet using GitHub or CodePen or the like to show how your code is structured. See the sample above.
+    placeholder: |
+      Here is the code I'm running
+      
+      ```TypeScript
+      import { spfi } from "@pnp/sp";
+      import "@pnp/sp/webs";
+      import "@pnp/sp/lists";
+      import "@pnp/sp/items";
+
+      const sp = spfi(...);
+
+      // get all the items from a list
+      const items: any[] = await sp.web.lists.getByTitle("My List").items();
+      console.log(items);
+      ```  
+  validations:
+    required: true

package/.github/ISSUE_TEMPLATE/enhancement.yml

@@ -0,0 +1,99 @@
+name: 🏗 Enhancement
+description: Suggest an enhancement
+labels: ["type: enhancement", "status: investigate"]
+
+body:
+- type: markdown
+  attributes:
+    value: |
+      This issue type is for suggesting or discussing enhancements to the library.
+
+      - Follow our guidance on [How To Create Good Issues](https://github.dev/juliemturner/pnpjs/wiki/How-to-Create-Good-Issues).
+      - Remember to include sufficient details and context.
+      - If you have multiple questions, suggestions, or bugs, please submit them in separate issues.
+- type: dropdown
+  attributes:
+    label: Target environment
+    options:
+      - All
+      - SharePoint Framework
+      - NodeJS
+      - Browser App (Hosted external to Microsoft 365 platform)
+      - other (enter in the "Additional environment details" area below)
+  validations:
+    required: false
+- type: textarea
+  attributes:
+    label: Additional environment details
+    description: Please describe the environment you're working in and how you're authenticating.
+    placeholder: |
+      I'm using NodeJS and certificate based MSAL for authentication.
+- type: textarea
+  attributes:
+    label: Enhancement Idea
+    description: Please included details to describe your situation, code fenced example code OR a link to a code snippet using GitHub or CodePen or the like to show how your code is structured and get you the right help more quickly.
+    placeholder: |
+      I'm struggling to get a list item. Here is the code I'm running. Can anyone help me figure out what's wrong?
+      
+      ```TypeScript
+      import { spfi } from "@pnp/sp";
+      import "@pnp/sp/webs";
+      import "@pnp/sp/lists";
+      import "@pnp/sp/items";
+
+      const sp = spfi(...);
+
+      // get all the items from a list
+      const items: any[] = await sp.web.lists.getByTitle("My List").items();
+      console.log(items);
+      ```
+=======
+name: 🏗 Enhancement
+description: Suggest an enhancement
+labels: ["type: enhancement", "status: investigate"]
+
+body:
+- type: markdown
+  attributes:
+    value: |
+      This issue type is for suggesting or discussing enhancements to the library.
+
+      - Follow our guidance on [How To Create Good Issues](https://github.dev/juliemturner/pnpjs/wiki/How-to-Create-Good-Issues).
+      - Remember to include sufficient details and context.
+      - If you have multiple questions, suggestions, or bugs, please submit them in separate issues.
+- type: dropdown
+  attributes:
+    label: Target environment
+    options:
+      - All
+      - SharePoint Framework
+      - NodeJS
+      - Browser App (Hosted external to Microsoft 365 platform)
+      - other (enter in the "Additional environment details" area below)
+  validations:
+    required: false
+- type: textarea
+  attributes:
+    label: Additional environment details
+    description: Please describe the environment you're working in and how you're authenticating.
+    placeholder: |
+      I'm using NodeJS and certificate based MSAL for authentication.
+- type: textarea
+  attributes:
+    label: Enhancement Idea
+    description: Please included details to describe your situation, code fenced example code OR a link to a code snippet using GitHub or CodePen or the like to show how your code is structured and get you the right help more quickly.
+    placeholder: |
+      I'm struggling to get a list item. Here is the code I'm running. Can anyone help me figure out what's wrong?
+      
+      ```TypeScript
+      import { spfi } from "@pnp/sp";
+      import "@pnp/sp/webs";
+      import "@pnp/sp/lists";
+      import "@pnp/sp/items";
+
+      const sp = spfi(...);
+
+      // get all the items from a list
+      const items: any[] = await sp.web.lists.getByTitle("My List").items();
+      console.log(items);
+      ```

package/.github/ISSUE_TEMPLATE/question.yml

@@ -0,0 +1,72 @@
+name: ❓ Question/Assistance Needed
+description: Ask a question or seek guidance
+labels: ["type: question", "help wanted 🐇"]
+
+body:
+- type: markdown
+  attributes:
+    value: |
+      This issue type is for asking questions or requesting assistance in using the library. Please provide as much information as possible so a member of the community can best assist you. Thanks!
+
+      - Follow our guidance on [How To Create Good Issues](https://github.dev/juliemturner/pnpjs/wiki/How-to-Create-Good-Issues).
+      - Remember to include sufficient details and context.
+      - If you have multiple questions, suggestions, or bugs, please submit them in separate issues.
+- type: dropdown
+  attributes:
+    label: What version of PnPjs library you are using
+    options:
+      - 4.x
+      - 3.x
+      - 2.x (No longer supported)
+      - 1.x (No longer supported)
+    default: 1
+  validations:
+    required: true
+- type: input
+  id: minorver
+  attributes:
+    label: Minor Version Number
+    description: Include the minor and patch version numbers, e.g. for 4.1.0 
+    placeholder: '1.0'
+  validations:
+    required: true
+- type: dropdown
+  attributes:
+    label: Target environment
+    options:
+      - All
+      - SharePoint Framework
+      - NodeJS
+      - Browser App (Hosted external to Microsoft 365 platform)
+      - other (enter in the "Additional environment details" area below)
+  validations:
+    required: true
+- type: textarea
+  attributes:
+    label: Additional environment details
+    description: Please describe the environment you're working in and how you're authenticating.
+    placeholder: |
+      I'm using NodeJS and certificate based MSAL for authentication.
+  validations:
+    required: true
+- type: textarea
+  attributes:
+    label: Question/Request
+    description: Please included details to describe your situation, code fenced example code OR a link to a code snippet using GitHub or CodePen or the like to show how your code is structured and get you the right help more quickly.
+    placeholder: |
+      I'm struggling to get a list item. Here is the code I'm running. Can anyone help me figure out what's wrong?
+      
+      ```TypeScript
+      import { spfi } from "@pnp/sp";
+      import "@pnp/sp/webs";
+      import "@pnp/sp/lists";
+      import "@pnp/sp/items";
+
+      const sp = spfi(...);
+
+      // get all the items from a list
+      const items: any[] = await sp.web.lists.getByTitle("My List").items();
+      console.log(items);
+      ```
+  validations:
+    required: true

package/.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,39 @@
+Thank you for reporting an issue, suggesting an enhancement, or asking a question. We appreciate your feedback - to help the team understand your
+needs please complete the below template to ensure we have the details to help. Thanks!
+
+**Please check out the [Docs](https://pnp.github.io/pnpjs/) to see if your question is already addressed there. This will help us ensure our documentation covers the most frequent questions.**
+
+### Category
+- [ ] Enhancement
+- [ ] Bug
+- [ ] Question
+- [ ] Documentation gap/issue
+
+### Version
+
+Please specify what version of the library you are using: [         ]
+
+Please specify what version(s) of SharePoint you are targeting: [         ]
+
+*If you are not using the latest release, please update and see if the issue is resolved before submitting an issue.*
+
+### Expected / Desired Behavior / Question
+*If you are reporting an issue please describe the expected behavior. If you are suggesting an enhancement please
+describe thoroughly the enhancement, how it can be achieved, and expected benefit. If you are asking a question, ask away!*
+
+### Observed Behavior
+*If you are reporting an issue please describe the behavior you expected to occur when performing the action. If you are making a
+suggestion or asking a question delete this section.*
+
+### Steps to Reproduce
+*If you are reporting an issue please describe the steps to reproduce the bug in sufficient detail to allow testing. If you are making
+a suggestion or asking a question delete this section.*
+
+### Submission Guidelines
+*Delete this section after reading*
+* All suggestions, questions and issues are welcome, please let us know what's on your mind.
+* Remember to include sufficient details and context.
+* Please check back occasionally on your issue as we may have follow up questions.
+* If you have multiple suggestions, questions, or bugs please submit them in separate issues so we can track resolution.
+
+Thank you for your feedback!

package/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,24 @@
+#### Category
+- [ ] Bug fix?
+- [ ] New feature?
+- [ ] New sample?
+- [ ] Documentation update?
+
+#### Related Issues
+
+fixes #X, mentioned in #Y
+
+#### What's in this Pull Request?
+
+*Please describe the changes in this PR. Simple description of the contents of this PR so folks reviewing can easily understand what it contains.*
+
+#### Guidance
+
+*You can delete this section when you are submitting the pull request.* 
+
+* Please update this PR information accordingly. We'll use this as part of our release notes in monthly communications.
+* Please target your PR to "version-3" branch for v3 changes
+* Please ensure you have updated any associated docs files based on your code changes
+* Please ensure you have updated/added tests to cover your change.
+  * If you are fixing a bug include a test that would have caught the bug you are fixing
+

package/.github/workflows/lock.yml

@@ -0,0 +1,18 @@
+name: 'Lock Threads'
+
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: '0 0 * * *'
+
+jobs:
+  lock:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: dessant/lock-threads@v2
+        with:
+          github-token: ${{ github.token }}
+          issue-lock-inactive-days: '2'
+          issue-lock-labels: 'auto-locked'
+          issue-lock-comment: 'This issue is locked for inactivity or age. If you have a related issue please open a new issue and reference this one. Closed issues are not tracked.'
+          issue-lock-reason: ''

package/.github/workflows/publish-buildsystem.yml

@@ -0,0 +1,34 @@
+name: Publish Build System
+
+on:
+  workflow_dispatch:
+
+jobs:
+  publish-build-system:
+    # The type of runner that the job will run on
+    runs-on: ubuntu-latest
+
+    # Steps represent a sequence of tasks that will be executed as part of the job
+    steps:
+
+      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
+      - uses: actions/checkout@v3
+        with:
+          ref: version-3    
+      # setup nodejs
+      - name: Use Node.js 16
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16
+          registry-url: 'https://registry.npmjs.org'
+          cache: 'npm'
+          cache-dependency-path: package-lock.json
+          
+      # Runs a single command using the runners shell
+      - name: Run a one-line script
+        run: |
+          cd tools/buildsystem
+          npm install
+          npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_PUBLISH_TOKEN }}

package/.github/workflows/publish-docs.yml

@@ -0,0 +1,21 @@
+name: Publish docs
+on:
+  workflow_dispatch:
+  push:
+    branches:    
+      - main
+
+jobs:
+  build:
+    name: Deploy docs
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout main
+        uses: actions/checkout@v3
+
+      - name: Deploy docs
+        uses: mhausenblas/mkdocs-deploy-gh-pages@master
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          CONFIG_FILE: mkdocs.yml
+          REQUIREMENTS: mkdocs-requirements.txt