API and Product details pages

.editorconfig

@@ -0,0 +1,4 @@
+root = true
+
+[*]
+trim_trailing_whitespace = true

.eslintrc.cjs

@@ -0,0 +1,35 @@
+module.exports = {
+    root: true,
+    parser: "@typescript-eslint/parser",
+    plugins: [
+        "@typescript-eslint"
+    ],
+    extends: [
+        "eslint:recommended",
+        "plugin:@typescript-eslint/recommended",
+    ],
+    rules: {
+        "no-constant-condition": "warn",
+        "no-async-promise-executor": "off",
+        "no-extra-boolean-cast": "warn",
+        "no-useless-escape": "off",
+        "no-ex-assign": "warn",
+        "prefer-spread": "off",
+        "prefer-const": "warn",
+        "@typescript-eslint/ban-types": "off",
+        "@typescript-eslint/ban-ts-comment": "off",
+        "@typescript-eslint/no-explicit-any": "off",
+        "@typescript-eslint/no-unused-vars": "off",
+        "@typescript-eslint/no-inferrable-types": "off",
+        "@typescript-eslint/no-empty-interface": "off",
+        "@typescript-eslint/no-this-alias": "off",
+        "@typescript-eslint/quotes": [
+            "warn",
+            "double",
+            {
+                "avoidEscape": true,
+                "allowTemplateLiterals": true
+            }
+        ]
+    }
+};

.github/scripts/wait-for-server.ps1

@@ -0,0 +1,13 @@
+param ($HostName = $(throw "HostName parameter is required."))
+$Counter = 0
+while ($Counter -ne 2 ){
+    Start-Sleep -Seconds 4
+    $Response = Invoke-WebRequest -Uri $HostName
+    if ($Response.StatusCode -eq 200){
+        Write-Host "server returned 200"
+        exit 0
+    }
+    $Counter++
+}
+
+Write-Error "Server didn't return 200 status"

.github/workflows/codeql-analysis.yml

@@ -0,0 +1,70 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ master ]
+  schedule:
+    - cron: '25 16 * * 4'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'typescript' ]
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v3
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v2
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+
+        # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
+        # queries: security-extended,security-and-quality
+
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v2
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
+
+    #   If the Autobuild fails above, remove it and uncomment the following three lines. 
+    #   modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
+
+    # - run: |
+    #   echo "Run, Build Application using script"
+    #   ./location_of_script_within_repo/buildscript.sh
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v2

.github/workflows/eslint.yml

@@ -0,0 +1,45 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# ESLint is a tool for identifying and reporting on patterns
+# found in ECMAScript/JavaScript code.
+# More details at https://github.com/eslint/eslint
+# and https://eslint.org
+
+name: ESLint
+
+on:
+  pull_request:
+    branches: 
+      - master
+
+jobs:
+  eslint:
+    name: Run eslint scanning
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      security-events: write
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Install
+        run:
+          npm install
+          npm install @microsoft/[email protected]
+
+      - name: Run ESLint
+        run: npx eslint src/**/*.ts
+          --config .eslintrc.cjs
+          --format @microsoft/eslint-formatter-sarif 
+          --output-file ./eslint-results.sarif
+        continue-on-error: true
+
+      - name: Upload report artifacts
+        uses: github/codeql-action/upload-sarif@v2
+        with:
+          sarif_file: ./eslint-results.sarif
+          wait-for-processing: true
+        continue-on-error: true

.github/workflows/mainCI.yml

@@ -0,0 +1,38 @@
+name: CI
+
+on:
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Use Node.js 16.x
+        uses: actions/checkout@v2
+        with:
+          node-version: 16.x
+
+      - name: Install
+        run: npm install
+
+      - name: Build
+        run: npm run build-static-data
+
+      - name: Scan for accessibility issues
+        env:
+          ACCESS_TOKEN: ${{ secrets.ACCESS_TOKEN }}
+        uses: microsoft/accessibility-insights-action@v2
+        with:
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
+          site-dir: ${{ github.workspace }}/dist/website
+          localhost-port: 12345
+          input-urls: http://localhost:12345/profile http://localhost:12345/500 http://localhost:12345/404
+
+      - name: Upload report artifact
+        uses: actions/upload-artifact@v2
+        with:
+          name: accessibility-reports
+          path: ${{ github.workspace }}/_accessibility-reports

.github/workflows/test.yml

@@ -0,0 +1,60 @@
+name: Test
+
+on:
+  pull_request:
+    branches: 
+      - master
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Install
+        run: npm install
+
+      - name: Run tests
+        run: npm run test
+
+  end2end-tests:
+    runs-on: windows-latest
+
+    steps:      
+      - name: Checkout code
+        uses: actions/checkout@v3
+      - name: Setup Node.js 18
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18
+      - name: Install
+        run: npm install
+
+      - name: Compile
+        run: npx tsc -p tests\tsconfig.json
+
+      - name: Install Playwright Browsers
+        run: npx playwright install --with-deps
+
+      - name: Build static data
+        run: npm run build-mock-static-data
+
+      - name: Start mock server
+        run: npm run serve-website &
+        shell: bash
+
+      - name: Wait for the server
+        run: ./.github/scripts/wait-for-server.ps1 -HostName "http://localhost:8080"
+        shell: pwsh
+
+      - name: Run tests
+        run: npx playwright test tests/ --workers 1
+
+      - uses: actions/upload-artifact@v3
+        if: failure()
+        with:
+          name: playwright-report
+          path: test-results/
+          retention-days: 30

.gitignore

@@ -7,4 +7,5 @@ node_modules/
 src/config.design.json
 src/config.publish.json
 src/config.runtime.json
-
+test-results/
+tsconfig.tsbuildinfo

.pipeline/migrate.yml

@@ -21,7 +21,7 @@ jobs:
           command: "install"
 
       - pwsh: |        
-          node ./migrate --sourceSubscriptionId "$(sourceSubscriptionId)" --sourceResourceGroupName  "$(sourceResourceGroupName)" --sourceServiceName "$(sourceServiceName)" --destServiceName "$(destServiceName)" --destSubscriptionId "$(destSubscriptionId)" --destResourceGroupName "$(destResourceGroupName)" --sourceTenantId "$(sourceAzureTenantId)" --sourceServicePrincipal "$(sourceServicePrincipal)" --sourceSecret "$(sourceServicePrincipalSecret)"  --destTenantId "$(sourceAzureTenantId)" --destServicePrincipal "$(destServicePrincipal)" --destSecret "$(destServicePrincipalSecret)"
+          node ./migrate --sourceSubscriptionId "$(sourceSubscriptionId)" --sourceResourceGroupName  "$(sourceResourceGroupName)" --sourceServiceName "$(sourceServiceName)" --destServiceName "$(destServiceName)" --destSubscriptionId "$(destSubscriptionId)" --destResourceGroupName "$(destResourceGroupName)" --sourceTenantId "$(sourceAzureTenantId)" --sourceServicePrincipal "$(sourceServicePrincipal)" --sourceSecret "$(sourceServicePrincipalSecret)"  --destTenantId "$(destAzureTenantId)" --destServicePrincipal "$(destServicePrincipal)" --destSecret "$(destServicePrincipalSecret)"
         workingDirectory: "$(System.DefaultWorkingDirectory)/scripts.v3"
         displayName: Run Migrate cmd from $(sourceServiceName) to $(destinationServiceName)
 

.pipeline/readme.md

@@ -25,10 +25,10 @@ Then select Run. This saves and executes your pipeline for the fist time, seen b
 | destServiceName | Destination APIM service name |
 | destSubscriptionId | Destination APIM service resource subscription ID |
 | destResourceGroupName | Destination APIM service resource group name |
-| sourceTenantId | Source Azure tenant ID  |
+| sourceAzureTenantId | Source Azure tenant ID  |
 | sourceServicePrincipal | Source Azure service principal |
 | sourceServicePrincipalSecret | Source Azure service principal secret |
-| destTenantId | Destination Azure tenant ID |
+| destAzureTenantId | Destination Azure tenant ID |
 | destServicePrincipal | Destination Azure service principal|
 | destServicePrincipalSecret | Destination Azure service principal secret |
 | existingEnvUrls | Existing environment URLs (URLs used in the developer portal from source APIM to replace, if we have multiple urls then comma separated values to be given.) |

CONTRIBUTIONS.md

@@ -5,5 +5,3 @@ This project welcomes contributions and suggestions. Most contributions require
 When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.
 
 This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [[email protected]](mailto:[email protected]) with any additional questions or comments.
-
-**Refer to the [contribution guidelines](https://github.com/Azure/api-management-developer-portal/wiki/Widget-contribution-guidelines) for more information.**

README.md

@@ -14,7 +14,7 @@ You can **report bugs** or **submit feature requests** in [the repository's Issu
 
 Microsoft Azure Support assistance is limited to managed portals and only the initial setup of self-hosted portals ([documentation](https://aka.ms/apimdocs/selfhostportal)); best effort support is provided for problems that are caused by environmental factors, such as (but not limited to): hosting platform, development environment, network configuration. Other self-hosted portal assistance requests (for example, problem with custom widgets) should be submitted [on Stack Overflow](https://aka.ms/apimso) with the `azure-api-management` tag. **We don't provide support through GitHub Issues**.
 
-We welcome and appreciate [community contributions](CONTRIBUTIONS.md). Refer to the [contribution guidelines](https://aka.ms/apimdocs/portal/contribute) for more information.
+We welcome and appreciate [community contributions](CONTRIBUTIONS.md).
 
 ## <a name="license"></a> License
 

SECURITY.md

@@ -0,0 +1,21 @@
+# Security Policy
+
+## Supported Versions
+
+Use this section to tell people about which versions of your project are
+currently being supported with security updates.
+
+| Version | Supported          |
+| ------- | ------------------ |
+| 5.1.x   | :white_check_mark: |
+| 5.0.x   | :x:                |
+| 4.0.x   | :white_check_mark: |
+| < 4.0   | :x:                |
+
+## Reporting a Vulnerability
+
+Use this section to tell people how to report a vulnerability.
+
+Tell them where to go, how often they can expect to get an update on a
+reported vulnerability, what to expect if the vulnerability is accepted or
+declined, etc.

community/widgets/document-details/constants.ts

@@ -0,0 +1,7 @@
+export const widgetName = "document-details";
+export const widgetDisplayName = "Document details";
+export const widgetCategory = "Community";
+export const widgetSelector = "document-details";
+export const widgetRuntimeSelector = "document-details-runtime";
+export const widgetEditorSelector = "document-details-editor";
+export const defaultFileName = "sample_document.html";

community/widgets/document-details/ko/documentDetailsViewModelBinder.ts

@@ -21,7 +21,7 @@ export class DocumentDetailsViewModelBinder implements ViewModelBinder<DocumentD
             const binding: IWidgetBinding<DocumentDetailsModel, DocumentDetailsViewModel> = {
                 name: widgetName,
                 displayName: widgetDisplayName,
-                readonly: bindingContext?.readonly,
+                layer: bindingContext?.layer,
                 model: model,
                 flow: ComponentFlow.Block,
                 editor: widgetEditorSelector,

environmentConstants.js

@@ -0,0 +1,7 @@
+
+const staticDataEnvironment = "staticData";
+const mockStaticDataEnvironment = "mockStaticData";
+module.exports = {
+    staticDataEnvironment,
+    mockStaticDataEnvironment
+}

examples/publisher/azure-function/publish/index.ts

@@ -5,11 +5,13 @@ import { InversifyInjector } from "@paperbits/common/injection";
 import { IPublisher } from "@paperbits/common/publishing";
 import { CoreModule } from "@paperbits/core/core.module";
 import { CorePublishModule } from "@paperbits/core/core.publish.module";
+import { FormsModule } from "@paperbits/forms/forms.module";
 import { ApimPublishModule } from "../../../../src/apim.publish.module";
 import { StylePublishModule } from "@paperbits/styles/styles.publish.module";
 import { ProseMirrorModule } from "@paperbits/prosemirror/prosemirror.module";
 import { ConsoleLogger } from "@paperbits/common/logging";
 import { StaticSettingsProvider } from "../../../../src/components/staticSettingsProvider";
+import { PublishingCacheModule } from "../../../../src/persistence/publishingCacheModule";
 
 
 export async function publish(): Promise<void> {
@@ -40,9 +42,11 @@ export async function publish(): Promise<void> {
     injector.bindModule(new CorePublishModule());
     injector.bindModule(new StylePublishModule());
     injector.bindModule(new ProseMirrorModule());
+    injector.bindModule(new FormsModule());
     injector.bindModule(new ApimPublishModule());
     injector.bindInstance("settingsProvider", settingsProvider);
     injector.bindInstance("outputBlobStorage", outputBlobStorage);
+    injector.bindModule(new PublishingCacheModule());
     injector.resolve("autostart");
 
     const publisher = injector.resolve<IPublisher>("sitePublisher");