@progress/sitefinity-webservices-sdk 0.3.1 → 1.0.0

package/.eslintignore

@@ -0,0 +1,4 @@
+node_modules
+dist
+config
+coverage

package/.eslintrc.js

@@ -0,0 +1,19 @@
+module.exports = {
+    root: true,
+    parser: '@typescript-eslint/parser',
+    plugins: [
+      '@typescript-eslint',
+    ],
+    extends: [
+      'eslint:recommended',
+      'plugin:@typescript-eslint/recommended',
+    ],
+    rules: {
+        "@typescript-eslint/no-explicit-any": "off",
+        "@typescript-eslint/ban-types": "off",
+        "no-useless-escape": "off",
+        "no-prototype-builtins": "off",
+        "@typescript-eslint/no-empty-function": "off",
+        "no-constant-condition": "off"
+    }
+};

package/ci/pipelines/ci.yml

@@ -0,0 +1,219 @@
+trigger:
+  branches:
+    include:
+    - refs/heads/master
+jobs:
+- job: Job_1
+  displayName: Build and publish artifact
+  pool:
+    name: IrisVMware
+  steps:
+  - checkout: self
+  - task: UseNode@1
+    displayName: Use Node $(node.version)
+    inputs:
+      version: $(node.version)
+  - task: PowerShell@2
+    displayName: Verify Commit Type
+    condition: and(succeeded(), eq(variables['Build.Reason'], 'PullRequest'))
+    inputs:
+      targetType: inline
+      script: |
+        $pullrequestId = $(System.PullRequest.PullRequestId)
+        $azureDevOpsProject = "https://prgs-sitefinity.visualstudio.com/sitefinity"
+        $headers = @{}
+        $headers.Add("Content-Type", "application/json");
+        $headers.Add("Authorization", "Basic $(VstsRestApiToken)");
+        $pullRequestUrl = "${azureDevOpsProject}/_apis/git/repositories/sitefinity-webservices-sdk/pullrequests/${pullrequestId}?api-version=4.1"
+        $response = Invoke-WebRequest -URI $pullRequestUrl -Headers $headers
+        $responseJsonObject = $response | ConvertFrom-Json
+        $pullRequestTitle = $responseJsonObject.title
+        $semicolonIndex = $pullRequestTitle.IndexOf(":")
+
+        if($semicolonIndex -eq -1)
+        {
+            throw (new-object "Exception" @("Please specify pull request type. Check readme file for more information"))
+            exit 1
+        }
+
+        $prType = $pullRequestTitle.Substring(0, $semicolonIndex)
+        $versionType = ""
+
+        switch ($prType)
+        {
+            "build" { $versionType = "patch"; break}
+            "test" { $versionType = "patch"; break}
+            "fix" { $versionType = "patch"; break}
+            "feat" { $versionType = "minor"; break}
+            "BREAKING CHANGE" { $versionType = "major"; break}
+        }
+
+        if($versionType -eq "")
+        {
+            throw (new-object "Exception" @("Unsupported pull request type '$prType'. Check readme file for more information"))
+            exit 1
+        }
+
+        $tb="$(System.PullRequest.TargetBranch)"
+        $bnRegex = $tb -match "refs/heads/(.*)"
+        $bn = $Matches[1]
+        Write-Output "Target branch name is $bn"
+
+        if(($versionType -eq "major") -and ($bn -ne "master"))
+        {
+            throw (new-object "Exception" @("Cannot release BREAKING CHANGE from branch different than master."))
+            exit 1
+        }
+
+        Write-Output "Version type is $versionType"
+        "$versionType" | Out-File "$(Build.SourcesDirectory)/type.txt"
+        Write-Output "##vso[task.setvariable variable=VersionType]$versionType"
+  - task: PowerShell@2
+    displayName: Save Commit Type
+    condition: and(succeeded(), ne(variables['Build.Reason'], 'PullRequest'))
+    inputs:
+      targetType: inline
+      script: |
+        $releaseBranches = ConvertFrom-Json -InputObject "$(SitefinitySdkReleaseBranches)"
+
+        if ($releaseBranches -contains "$(Build.SourceBranch)") {
+            "$(Build.SourceVersionMessage)" -match "Merged PR \d+: (.*)"
+            $pullRequestTitle = $Matches[1]
+            Write-Output "Pull request title is '$pullRequestTitle'"
+            $semicolonIndex = $pullRequestTitle.IndexOf(":")
+            if($semicolonIndex -eq -1)
+            {
+                Write-Error "Please specify pull request type. Check readme file for more information"
+                exit 1
+            }
+
+            $prType = $pullRequestTitle.Substring(0, $semicolonIndex)
+            $versionType = ""
+            switch ($prType)
+            {
+                "build" { $versionType = "patch"; break}
+                "test" { $versionType = "patch"; break}
+                "fix" { $versionType = "patch"; break}
+                "feat" { $versionType = "minor"; break}
+                "BREAKING CHANGE" { $versionType = "major"; break}
+            }
+
+            Write-Output "##vso[task.setvariable variable=VersionType]$versionType"
+
+            if($versionType -eq "")
+            {
+                Write-Error "Unsupported pull request type '$prType'. Check readme file for more information"
+                exit 1
+            }
+
+            Write-Output "Version type is $versionType"
+            "$versionType" | Out-File "$(Build.SourcesDirectory)/type.txt"
+            Write-Output "##vso[task.setvariable variable=VersionType]$versionType"
+
+        } else {
+            Write-Output ""$(Build.SourceBranch)" branch is missing from the release branches $releaseBranches . Skipping this step"
+        }
+  - task: PublishPipelineArtifact@1
+    displayName: Create Commit Data Artifact
+    inputs:
+      path: type.txt
+      artifactName: commit-data-drop
+  - task: Npm@1
+    displayName: Npm install (CI)
+    inputs:
+      command: custom
+      customCommand: ci
+  - task: Npm@1
+    displayName: Run lint
+    inputs:
+      command: custom
+      verbose: true
+      customCommand: run lint
+  - task: Bash@3
+    displayName: Run Tests
+    inputs:
+      targetType: inline
+      script: >-
+        export DISPLAY=':99.0'
+
+        Xvfb :99 -screen 0 1024x768x24 > /dev/null 2>&1 &
+
+        cd $(Build.SourcesDirectory)
+
+        npm run test
+  - task: Npm@1
+    displayName: Build
+    inputs:
+      command: custom
+      verbose: false
+      customCommand: run build:release
+  - task: PublishPipelineArtifact@1
+    displayName: Publish Pipeline Artifact
+    inputs:
+      path: $(Pipeline.Workspace)/s
+      artifactName: sitefinity-webservices-sdk-drop
+  - task: PowerShell@2
+    displayName: Calculate release version
+    inputs:
+      targetType: inline
+      script: |
+        $version=git describe --long --tags
+        $version=$version.Replace('-', '.')
+
+        $versionSegments="$version".Split('.')
+        $major = [int]$versionSegments[0]
+        $minor = [int]$versionSegments[1]
+        $patch = [int]$versionSegments[2]
+        $latestVersion = "$major.$minor.$patch"
+        Write-Output "Currently published version is $latestVersion"
+
+        switch ("$(VersionType)")
+        {
+          "major" { $major = $major + 1; $minor = 0; $patch = 0; break}
+          "minor" { $minor = $minor + 1; $patch = 0; break}
+          "patch" { $patch = $patch + 1; break}
+          default {Write-Error "Version type not supported. Check Readme"; exit 1}
+        }
+
+        $newVersion = "$major.$minor.$patch"       
+        Write-Output "Releasing version $newVersion"
+
+        $validVersion = $newVersion -match "(\d){1,2}\.(\d){1,2}\.(\d){1,2}"
+        if(-not $validVersion)
+        {
+          Write-Error "Invalid version $newVersion aborting publish"
+          exit 1
+        }
+
+        Write-Output "Version number is $newVersion "
+        "$newVersion " | Out-File "$(Build.SourcesDirectory)/version.txt"
+
+        Write-Output "##vso[task.setvariable variable=ReleaseVersion]$newVersion"
+  - task: PublishPipelineArtifact@1
+    displayName: Publish release version artifact
+    inputs:
+      path: version.txt
+      artifactName: commit-data-drop-version
+  # - task: PowerShell@2
+  #   displayName: Tag sitefinity-webservices-sdk repo
+  #   condition: and(succeeded(), ne(variables['Build.Reason'], 'PullRequest'))
+  #   inputs:
+  #     targetType: inline
+  #     script: |
+  #       $releaseBranches = ConvertFrom-Json -InputObject "$(SitefinitySdkReleaseBranches)"
+
+  #       if ($releaseBranches -contains "$(Build.SourceBranch)") {
+  #         $token = "$(VstsRestApiToken)"
+  #         Write-Host "##vso[task.logissue type=warning;] Releasing Sitefinity webservices sdk - "$(ReleaseVersion)""
+
+  #         $postParams = @{name="$(ReleaseVersion)";taggedObject=@{objectId="$(Build.SourceVersion)"};message='Sitefinity webservices sdk release'}
+  #         $json = $postParams | ConvertTo-Json 
+
+  #         $headers = @{'Content-Type'='application/json'; 'Authorization'="Basic $token"}
+  #         $tagUrl = "https://prgs-sitefinity.visualstudio.com/sitefinity/_apis/git/repositories/sitefinity-webservices-sdk/annotatedtags?api-version=4.1-preview.1"
+
+  #         Invoke-WebRequest -Uri $tagUrl -Method POST -Body $json -Headers $headers
+  #       } else {
+  #          Write-Error "Cannot tag the branch with the new release since it is missing from the list with release branches. Please review the whitelisted branches"
+  #          exit 1
+  #       }

package/config/helpers.js

@@ -7,10 +7,4 @@ function root(...args) {
   return path.join.apply(path, [ROOT].concat(args));
 }
 
-function appRoot(file) {
-    var path = `src/${file}`;
-    return root(path);
-}
-
 exports.root = root;
-exports.appRoot = appRoot;

package/config/webpack.common.js

@@ -7,7 +7,7 @@ module.exports = function(options) {
     return {
         mode: 'development',
         entry: {
-            "app": helpers.appRoot("main")
+            "app": helpers.root("sitefinity-webservices-sdk"),
         },
 
         output: {
@@ -18,8 +18,6 @@ module.exports = function(options) {
             library: "Sitefinity"
         },
         plugins: [
-            // This plugin optimizes chunks and modules by how much they are used in your app
-            new webpack.optimize.OccurrenceOrderPlugin(),
             //Skipping the error emitting phase (and recording phase) during compilation, so there are no assets emitted that include errors
             new webpack.NoEmitOnErrorsPlugin()
         ],

package/config/webpack.dev.js

@@ -1,12 +1,9 @@
 // For instructions about this file refer to
 // webpack and webpack-hot-middleware documentation
-const webpackMerge = require("webpack-merge"); // used to merge webpack configs
-var HtmlWebpackPlugin = require('html-webpack-plugin');
-
+const { merge } = require("webpack-merge"); // used to merge webpack configs
 const commonConfig = require("./webpack.common"); // the settings that are common to prod and dev
-const htmlConfig = require("./html.conf");
 
-module.exports = webpackMerge(commonConfig({ env: "dev" }), {
+module.exports = merge(commonConfig({ env: "dev" }), {
         devtool: "source-map",
 
         output: {
@@ -19,8 +16,4 @@ module.exports = webpackMerge(commonConfig({ env: "dev" }), {
             historyApiFallback: true,
             stats: "normal"
         },
-
-        plugins: [
-            new HtmlWebpackPlugin(htmlConfig)
-        ]
     });

package/config/webpack.prod.js

@@ -1,12 +1,11 @@
 // For instructions about this file refer to
 // webpack and webpack-hot-middleware documentation
-const webpackMerge = require("webpack-merge"); // used to merge webpack configs
+const { merge } = require("webpack-merge"); // used to merge webpack configs
 const commonConfig = require("./webpack.common"); // the settings that are common to prod and dev
 const HtmlWebpackPlugin = require('html-webpack-plugin');
-const TypedocWebpackPlugin = require('typedoc-webpack-plugin');
 
 module.exports =
-    webpackMerge(commonConfig({ env: "prod" }), {
+    merge(commonConfig({ env: "prod" }), {
         mode: 'production',
         output: {
             filename: "sitefinity-webservices-sdk.min.js"
@@ -16,9 +15,9 @@ module.exports =
             new HtmlWebpackPlugin({
                 "filename": "../dist/samples.html",
                 "template": "template.html",
-                "inject": "head"
-            }),
-            new TypedocWebpackPlugin({})
+                "inject": "head",
+                "scriptLoading": "blocking"
+            })
         ],
         optimization: {
             minimize: true

package/dist/docs/.nojekyll

@@ -0,0 +1 @@
+TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false.

package/dist/docs/assets/highlight.css

@@ -0,0 +1,57 @@
+:root {
+    --light-hl-0: #000000;
+    --dark-hl-0: #D4D4D4;
+    --light-hl-1: #0000FF;
+    --dark-hl-1: #569CD6;
+    --light-hl-2: #001080;
+    --dark-hl-2: #9CDCFE;
+    --light-hl-3: #A31515;
+    --dark-hl-3: #CE9178;
+    --light-hl-4: #795E26;
+    --dark-hl-4: #DCDCAA;
+    --light-code-background: #F5F5F5;
+    --dark-code-background: #1E1E1E;
+}
+
+@media (prefers-color-scheme: light) { :root {
+    --hl-0: var(--light-hl-0);
+    --hl-1: var(--light-hl-1);
+    --hl-2: var(--light-hl-2);
+    --hl-3: var(--light-hl-3);
+    --hl-4: var(--light-hl-4);
+    --code-background: var(--light-code-background);
+} }
+
+@media (prefers-color-scheme: dark) { :root {
+    --hl-0: var(--dark-hl-0);
+    --hl-1: var(--dark-hl-1);
+    --hl-2: var(--dark-hl-2);
+    --hl-3: var(--dark-hl-3);
+    --hl-4: var(--dark-hl-4);
+    --code-background: var(--dark-code-background);
+} }
+
+body.light {
+    --hl-0: var(--light-hl-0);
+    --hl-1: var(--light-hl-1);
+    --hl-2: var(--light-hl-2);
+    --hl-3: var(--light-hl-3);
+    --hl-4: var(--light-hl-4);
+    --code-background: var(--light-code-background);
+}
+
+body.dark {
+    --hl-0: var(--dark-hl-0);
+    --hl-1: var(--dark-hl-1);
+    --hl-2: var(--dark-hl-2);
+    --hl-3: var(--dark-hl-3);
+    --hl-4: var(--dark-hl-4);
+    --code-background: var(--dark-code-background);
+}
+
+.hl-0 { color: var(--hl-0); }
+.hl-1 { color: var(--hl-1); }
+.hl-2 { color: var(--hl-2); }
+.hl-3 { color: var(--hl-3); }
+.hl-4 { color: var(--hl-4); }
+pre, code { background: var(--code-background); }