Task: extract and create npm package

.azure-pipelines/ci-build.yml

@@ -609,18 +609,21 @@ extends:
                 submodules: true
               - task: NodeTool@0
                 inputs:
-                  versionSpec: "18.x"
+                  versionSpec: "20.x"
               - pwsh: $(Build.SourcesDirectory)/scripts/get-prerelease-version.ps1 -currentBranch $(Build.SourceBranch) -previewBranch ${{ parameters.previewBranch }}
                 displayName: "Set version suffix"
               - pwsh: $(Build.SourcesDirectory)/scripts/get-version-from-csproj.ps1
                 displayName: "Get Kiota's version-number from .csproj"
-              - pwsh: $(Build.SourcesDirectory)/scripts/update-vscode-releases.ps1 -version $(artifactVersion)$(versionSuffix) -packageJsonFilePath $(Build.SourcesDirectory)/vscode/microsoft-kiota/package.json -runtimeFilePath $(Build.SourcesDirectory)/vscode/microsoft-kiota/src/kiotaInterop/runtime.json -binaryFolderPath $(Build.ArtifactStagingDirectory)/Binaries
+              - pwsh: $(Build.SourcesDirectory)/scripts/update-vscode-releases.ps1 -version $(artifactVersion)$(versionSuffix) -packageJsonFilePath $(Build.SourcesDirectory)/vscode/microsoft-kiota/package.json -runtimeFilePath $(Build.SourcesDirectory)/vscode/npm-package/runtime.json -binaryFolderPath $(Build.ArtifactStagingDirectory)/Binaries
                 displayName: "Update VSCode extension version-number"
-              - script: npm i -g @vscode/vsce
-                displayName: "Install vsce"
-              - script: npm ci
-                displayName: "Install dependencies"
-                workingDirectory: $(Build.SourcesDirectory)/vscode/microsoft-kiota
+              - script: npm i -g @vscode/vsce rimraf
+                displayName: "Install Global dependencies"
+                workingDirectory: $(Build.SourcesDirectory)/vscode
+              - script: |
+                  npm install
+                  npm list
+                displayName: "Install vscode dependencies"
+                workingDirectory: $(Build.SourcesDirectory)/vscode
               - script: vsce package --pre-release
                 displayName: "Package VSCode extension as pre-release"
                 workingDirectory: $(Build.SourcesDirectory)/vscode/microsoft-kiota
@@ -687,6 +690,65 @@ extends:
                 inputs:
                   artifactName: VSCode
                   targetPath: "$(Build.ArtifactStagingDirectory)/VSCode"
+          - job: build_npm_package
+            dependsOn:
+              [
+                win_x64_build_binaries,
+                win_x86_build_binaries,
+                linux_x64_build_binaries,
+                linux_arm64_build_binaries,
+                osx_x64_build_binaries,
+                osx_arm64_build_binaries,
+              ]
+            pool:
+              name: Azure-Pipelines-1ESPT-ExDShared
+              os: linux
+              image: ubuntu-latest
+            templateContext:
+              sdl:
+                baseline:
+                  baselineFile: $(Build.SourcesDirectory)/guardian/SDL/common/.gdnbaselines
+                suppression:
+                  suppressionFile: $(Build.SourcesDirectory)/guardian/SDL/common/.gdnsuppress
+              inputs:
+                - ${{ each distribution in parameters.distributions }}:
+                    - input: pipelineArtifact
+                      artifactName: Binaries_${{ distribution.jobPrefix }}
+                      targetPath: $(Build.ArtifactStagingDirectory)/Binaries
+            steps:
+              - checkout: self
+                clean: true
+                submodules: true
+              - task: NodeTool@0
+                inputs:
+                  versionSpec: "20.x"
+              - pwsh: $(Build.SourcesDirectory)/scripts/get-prerelease-version.ps1 -currentBranch $(Build.SourceBranch) -previewBranch ${{ parameters.previewBranch }}
+                displayName: "Set version suffix"
+              - pwsh: $(Build.SourcesDirectory)/scripts/get-version-from-csproj.ps1
+                displayName: "Get Kiota's version-number from .csproj"
+              - pwsh: $(Build.SourcesDirectory)/scripts/update-vscode-releases.ps1 -version $(artifactVersion)$(versionSuffix) -packageJsonFilePath $(Build.SourcesDirectory)/vscode/microsoft-kiota/package.json -runtimeFilePath $(Build.SourcesDirectory)/vscode/npm-package/runtime.json -binaryFolderPath $(Build.ArtifactStagingDirectory)/Binaries
+                displayName: "Update NPM package version-number"
+              - script: |
+                  npm i -g rimraf
+                displayName: "Install Global dependencies"
+              - script: npm install
+                displayName: "Install package dependencies"
+                workingDirectory: $(Build.SourcesDirectory)/vscode
+              - script: npm run package:package
+                displayName: "Package"
+                workingDirectory: $(Build.SourcesDirectory)/vscode
+              - task: CopyFiles@2
+                displayName: Prepare staging folder for upload
+                inputs:
+                  targetFolder: $(Build.ArtifactStagingDirectory)/npm-package
+                  sourceFolder: $(Build.SourcesDirectory)/vscode/npm-package
+                  contents: |
+                    *.tgz
+              - task: 1ES.PublishPipelineArtifact@1
+                displayName: "Publish Artifact: Npm Package"
+                inputs:
+                  artifactName: npm-package
+                  targetPath: "$(Build.ArtifactStagingDirectory)/npm-package"
 
       - stage: deploy
         condition: and(or(contains(variables['build.sourceBranch'], 'refs/tags/v'), eq(variables['build.sourceBranch'], '${{ parameters.previewBranch }}')), succeeded())
@@ -763,6 +825,9 @@ extends:
                 - input: pipelineArtifact
                   artifactName: changelog
                   targetPath: "$(Pipeline.Workspace)/changelog"
+                - input: pipelineArtifact
+                  artifactName: npm-package
+                  targetPath: "$(Pipeline.Workspace)/npm-package"
                 - ${{ each distribution in parameters.distributions }}:
                     - input: pipelineArtifact
                       artifactName: Binaries_${{ distribution.jobPrefix }}
@@ -794,6 +859,7 @@ extends:
                         assets: |
                           $(Pipeline.Workspace)/*.zip
                           $(Pipeline.Workspace)/*.vsix
+                          $(Pipeline.Workspace)/*.tgz
                           $(Pipeline.Workspace)/*.nupkg
                           $(Pipeline.Workspace)/*.snupkg
                         addChangeLog: false
@@ -809,6 +875,7 @@ extends:
                         assets: |
                           $(Pipeline.Workspace)/*.zip
                           $(Pipeline.Workspace)/*.vsix
+                          $(Pipeline.Workspace)/*.tgz
                           $(Pipeline.Workspace)/*.nupkg
                           $(Pipeline.Workspace)/*.snupkg
                         addChangeLog: false
@@ -974,3 +1041,41 @@ extends:
                     "$(Build.SourcesDirectory)"
                 displayName: "Build and Push Release Image"
                 condition: startsWith(variables['Build.SourceBranch'], 'refs/tags/v')
+          - job: deploy_npm
+            pool:
+              name: Azure-Pipelines-1ESPT-ExDShared
+              os: windows
+              image: windows-2022
+            templateContext:
+              type: releaseJob
+              isProduction: true
+              inputs:
+                - input: pipelineArtifact
+                  artifactName: npm-package
+                  targetPath: $(Pipeline.Workspace)/npm-package
+                - input: pipelineArtifact
+                  artifactName: scripts
+                  targetPath: "$(Pipeline.Workspace)/scripts"
+            dependsOn:
+              - github_release
+            steps:
+              - task: NodeTool@0
+                inputs:
+                  versionSpec: "20.x"
+              - task: EsrpRelease@7
+                inputs:
+                  connectedservicename: 'Federated DevX ESRP Managed Identity Connection'
+                  keyvaultname: 'akv-prod-eastus'
+                  authcertname: 'ReferenceLibraryPrivateCert'
+                  signcertname: 'ReferencePackagePublisherCertificate'
+                  clientid: '65035b7f-7357-4f29-bf25-c5ee5c3949f8'
+                  intent: 'PackageDistribution'
+                  contenttype: 'npm'
+                  contentsource: 'Folder'
+                  folderlocation: '$(Pipeline.Workspace)/npm-package/'
+                  waitforreleasecompletion: true
+                  owners: $(NPM_OWNERS_LIST)
+                  approvers: $(NPM_APPROVERS_LIST)
+                  serviceendpointurl: 'https://api.esrp.microsoft.com'
+                  mainpublisher: 'ESRPRELPACMAN'
+                  domaintenantid: 'cdc5aeea-15c5-4db6-b079-fcadd2505dc2'

.github/workflows/build-vscode-extension.yml

@@ -20,50 +20,155 @@ jobs:
         id: checksecret_job
         run: |
           echo "is_SONAR_TOKEN_set=${{ env.SONAR_TOKEN != '' }}" >> $GITHUB_OUTPUT
-  build_extension:
+
+  test_and_generate_binaries:
     needs: [checksecret]
-    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        binaries:
+          - architecture: win-x64
+            os: windows-latest
+          - architecture: linux-x64
+            os: ubuntu-latest
+          - architecture: osx-arm64
+            os: macOS-latest    
+    runs-on: ${{ matrix.binaries.os }}
     steps:
       - uses: actions/checkout@v4
+
       - uses: actions/setup-node@v4
         with:
           node-version: 20.x
+
+      - name: Use .NET 9
+        uses: actions/setup-dotnet@v4
+        with:
+          dotnet-version: '9.x'
+
       - id: last_release
         run: |
           $releaseVersion = gh release list --exclude-drafts --exclude-pre-releases --json tagName,isLatest | ConvertFrom-Json | ? {$_.isLatest -eq $true} | select -first 1 -ExpandProperty tagName
+          $releaseVersion = "$releaseVersion" -replace '^v', ''
           Write-Output "RELEASE_VERSION=$releaseVersion" >> $Env:GITHUB_OUTPUT
         shell: pwsh
         env:
           GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-      - run: scripts/update-vscode-releases.ps1 -version "${{ steps.last_release.outputs.RELEASE_VERSION }}" -packageJsonFilePath "./vscode/microsoft-kiota/package.json" -runtimeFilePath "./vscode/microsoft-kiota/src/kiotaInterop/runtime.json" -online
+
+      - run: scripts/update-vscode-releases.ps1 -version "v${{ steps.last_release.outputs.RELEASE_VERSION }}" -packageJsonFilePath "./vscode/microsoft-kiota/package.json" -runtimeFilePath "./vscode/npm-package/runtime.json" -online
         shell: pwsh
+
       - name: Install dependencies
         run: npm install
-        working-directory: vscode/microsoft-kiota
-      - run: npm run lint
-        working-directory: vscode/microsoft-kiota
-      - name: run tests(linux)
-        if: runner.os == 'Linux'
-        run: xvfb-run -a npm run test:coverage
-        working-directory: vscode/microsoft-kiota
-      - name: run tests
-        if: runner.os != 'Linux'
-        run: npm run test:coverage
-        working-directory: vscode/microsoft-kiota
+        working-directory: vscode
+
+      - name: Publish kiota for testing - ${{ matrix.binaries.os }} - ${{ matrix.binaries.architecture }}
+        run: |
+          dotnet publish src/kiota/kiota.csproj -c Release --runtime ${{ matrix.binaries.architecture }} -p:PublishSingleFile=true --self-contained --output vscode/npm-package/.kiotabin/${{ steps.last_release.outputs.RELEASE_VERSION }}/${{ matrix.binaries.architecture }} -f net9.0
+        shell: pwsh
+
+      - name: Lint
+        run: npm run lint
+        working-directory: vscode
+
+      - name: Run tests - package
+        run: |
+          if [[ "${{ matrix.binaries.os }}" == "ubuntu-latest" ]]; then
+            xvfb-run -a npm run test:package:coverage
+          else
+            npm run test:package:coverage
+          fi
+        shell: bash
+        working-directory: vscode
+
+      - name: Run tests - vscode
+        run: |
+          if [[ "${{ matrix.binaries.os }}" == "ubuntu-latest" ]]; then
+            xvfb-run -a npm run test:vscode:coverage
+          else
+            npm run test:vscode:coverage
+          fi
+        shell: bash
+        working-directory: vscode
+
       - name: Run sonar cloud analysis
         if: needs.checksecret.outputs.is_SONAR_TOKEN_set == 'true'
         uses: SonarSource/sonarqube-scan-action@v5
         env:
           SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
         with:
-          projectBaseDir: vscode/microsoft-kiota
-      - run: npm run package
-        working-directory: vscode/microsoft-kiota
-      - run: npm i -g @vscode/vsce
-      - run: vsce package
-        working-directory: vscode/microsoft-kiota
+          projectBaseDir: vscode
+          args: >
+            -Dsonar.javascript.lcov.reportPaths=coverage/lcov.info,../npm-package/coverage/lcov.info
+
+      - name: Upload artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: ${{ matrix.binaries.architecture }}
+          path: vscode/npm-package/.kiotabin/${{ steps.last_release.outputs.RELEASE_VERSION }}/${{ matrix.binaries.architecture }}
+          retention-days: 3
+
+  build:
+    needs: [test_and_generate_binaries]
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        builds:
+          - name: "VS Code Extension"
+            path: "microsoft-kiota"
+            id: "vscode"
+            item: "vsix"
+          - name: "Npm Package"
+            path: "npm-package"
+            id: "package"
+            item: "tgz"
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20.x
+
+      - id: last_release
+        run: |
+          $releaseVersion = gh release list --exclude-drafts --exclude-pre-releases --json tagName,isLatest | ConvertFrom-Json | ? {$_.isLatest -eq $true} | select -first 1 -ExpandProperty tagName
+          Write-Output "RELEASE_VERSION=$releaseVersion" >> $Env:GITHUB_OUTPUT
+        shell: pwsh
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - run: scripts/update-vscode-releases.ps1 -version "${{ steps.last_release.outputs.RELEASE_VERSION }}" -packageJsonFilePath "./vscode/microsoft-kiota/package.json" -runtimeFilePath "./vscode/npm-package/runtime.json" -online
+        shell: pwsh
+
+      - name: Install dependencies
+        run: npm install
+        working-directory: vscode
+
+      - run: npm run package:${{ matrix.builds.id }}
+        if: matrix.builds.id == 'package'
+        name: 'Package - ${{ matrix.builds.id }}'
+        working-directory: vscode
+
+      - run: |
+          npm i -g @vscode/vsce
+          vsce package
+        working-directory: vscode/${{ matrix.builds.path }}
+        name: 'Package - ${{ matrix.builds.id }}'
+        if: matrix.builds.id == 'vscode'
+
       - name: Upload artifact
         uses: actions/upload-artifact@v4
         with:
-          name: vscode-extension
-          path: vscode/microsoft-kiota/*.vsix
+          name: ${{ matrix.builds.name }}
+          path: vscode/${{ matrix.builds.path }}/*.${{ matrix.builds.item }}
+
+  build_extension:
+    runs-on: ubuntu-latest
+    needs: build
+    if: always()
+    steps:
+      - name: All build matrix options are successful
+        if: ${{ !(contains(needs.*.result, 'failure')) }}
+        run: exit 0
+      - name: One or more build matrix options failed
+        if: ${{ contains(needs.*.result, 'failure') }}
+        run: exit 1

.gitignore

@@ -450,3 +450,6 @@ samples/
 it/openapi.yaml
 
 idempotency-results/
+vscode/npm-package/dist/*
+vscode/npm-package/coverage/*
+vscode/npm-package/.kiotabin/*

scripts/update-vscode-releases.ps1

@@ -58,6 +58,15 @@ $extensionVersion = $versionParts[0] + "." + $versionParts[1] + "." + $updatedPa
 $packageJson.version = $extensionVersion
 $runtimeDependencies = $runtimeJson.runtimeDependencies
 
+# Update the version in the package.json located in the same directory as runtimeJson
+$runtimeJsonDirectory = Split-Path -Path $runtimeFilePath -Parent
+$runtimePackageJsonFilePath = Join-Path -Path $runtimeJsonDirectory -ChildPath "package.json"
+if (Test-Path $runtimePackageJsonFilePath) {
+  $runtimePackageJson = Get-Content $runtimePackageJsonFilePath | ConvertFrom-Json
+  $runtimePackageJson.version = $version
+  Set-Content $runtimePackageJsonFilePath ($runtimePackageJson | ConvertTo-Json -Depth 10)
+}
+
 if ($online) {
   Write-Warning "Downloading binaries from GitHub."
   $binaryFolderPath = Join-Path ($Env:TEMP ?? $PWD) ".kiota-vscode-$version" # $Env:TEMP is not available on GitHub Actions

src/Kiota.Builder/Configuration/GenerationConfiguration.cs

@@ -130,6 +130,10 @@ public bool ClearCache
         get; set;
     }
     public HashSet<string> DisabledValidationRules { get; set; } = new(0, StringComparer.OrdinalIgnoreCase);
+    public bool? IncludeKiotaValidationRules
+    {
+        get; set;
+    }
     public int MaxDegreeOfParallelism { get; set; } = -1;
     public object Clone()
     {
@@ -153,6 +157,7 @@ public object Clone()
             ExcludePatterns = new(ExcludePatterns ?? Enumerable.Empty<string>(), StringComparer.OrdinalIgnoreCase),
             ClearCache = ClearCache,
             DisabledValidationRules = new(DisabledValidationRules ?? Enumerable.Empty<string>(), StringComparer.OrdinalIgnoreCase),
+            IncludeKiotaValidationRules = IncludeKiotaValidationRules,
             MaxDegreeOfParallelism = MaxDegreeOfParallelism,
             SkipGeneration = SkipGeneration,
             Operation = Operation,