combining all api elements into a single repository

.github/workflows/deployment.yml

@@ -31,31 +31,31 @@ jobs:
         run: npm ci
       - name: Run tests
         run: npm test
-  test_win:
-    name: "Windows"
-    runs-on: windows-latest
-    steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v1
-        with:
-          node-version: 14
-      - uses: microsoft/playwright-github-action@v1
-      - uses: actions/cache@v1
-        with:
-          path: ~/.npm
-          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
-          restore-keys: |
-            ${{ runner.os }}-node-
-      - name: Install dependencies
-        run: npm ci
-      - name: Run tests
-        run: npm test
+  # test_win:
+  #   name: "Windows"
+  #   runs-on: windows-latest
+  #   steps:
+  #     - uses: actions/checkout@v2
+  #     - uses: actions/setup-node@v1
+  #       with:
+  #         node-version: 14
+  #     - uses: microsoft/playwright-github-action@v1
+  #     - uses: actions/cache@v1
+  #       with:
+  #         path: ~/.npm
+  #         key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
+  #         restore-keys: |
+  #           ${{ runner.os }}-node-
+  #     - name: Install dependencies
+  #       run: npm ci
+  #     - name: Run tests
+  #       run: npm test
   tag:
     name: "Publishing release"
     if: github.ref == 'refs/heads/main' || github.ref == 'refs/heads/master'
     needs: 
       - test_linux
-      - test_win
+      # - test_win
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code

.vscode/settings.json

@@ -1,23 +1,63 @@
 {
   "cSpell.words": [
+    "amfstoreapiprotocols",
+    "amfstoreapisummary",
+    "amfstoreapiversion",
+    "amfstoredocumentationget",
+    "amfstoredocumentationlist",
+    "amfstoredocumentmeta",
+    "amfstoreendpointbypath",
+    "amfstoreendpointget",
+    "amfstoreendpointlist",
+    "amfstoreopget",
+    "amfstoreopgetparent",
+    "amfstorepayloadget",
+    "amfstorerequestget",
+    "amfstoreresponseget",
+    "amfstoresecurityget",
+    "amfstoresecuritygetrequirement",
+    "amfstoresecuritygetsettings",
+    "amfstoresecuritylist",
+    "amfstoretypeget",
+    "amfstoretypelist",
+    "apierror",
+    "apinavigate",
+    "apinavigateexternal",
     "apirequest",
+    "apiresponse",
     "apiserverchanged",
+    "apistorechange",
+    "apistoregraphchange",
+    "apistoreserverquery",
     "Applian",
+    "Arrable",
     "contentinfo",
     "dompurify",
     "fasttext",
     "formdata",
+    "graphload",
     "httpbin",
+    "itemschange",
     "mimechange",
     "monostate",
     "Nexmo",
     "notryit",
     "onapiserverchange",
     "onserverscountchange",
+    "openedchange",
+    "populateannotatedfields",
+    "preconnect",
+    "redirecturichange",
+    "Renderable",
     "securitysettingsinfochanged",
     "serverscountchanged",
     "signedup",
     "stevetest",
+    "telemetryevent",
+    "telemetryexception",
+    "telemetryscreenview",
+    "telemetrysocial",
+    "telemetrytiming",
     "Tryit",
     "Unionable",
     "xone"

CHANGELOG.md

@@ -1,21 +1,173 @@
 # Changelog
 
-## ApiResourceDocumentElement (former api-endpoint-documentation)
+## Old components vs this repository
 
-The `api-resource-document` element has the following properties changes compared to deprecated `api-endpoint-documentation`
+### User (consumer) changelog
 
-- `noTryIt` is renamed to `tryItButton`. When `tryItButton` is set then the try it button in operations is rendered.
+The UI in most cases is consistent with the previous version, except for the following items:
+
+- Removed an option to disable a single parameter. The rationale is that these parameters are defined in the API and the request editor and the outgoing HTTP request should reflect what the API author designed.
+- Changes titles of operations and resource: added sub title describing the section.
+- The URI and query parameters are now combined into a single section: Parameters.
+- The information architecture for parameters changed for better readability and accessibility.
+- Schema documentation was redesigned to better visualize complex objects.
+- Authorization now support OpenID Connect which can be defined in an OAS file.
+
+### Developer changelog
+
+#### General changes
+
+The `compatibility` has been renamed to `anypoint`.
+
+The `selected` property has been renamed to `domainId` which is the id of the graph node rendered by the AMF parser.
+
+The `selectedType` has been renamed to `domainType`. This is a value generated by the navigation element to help to reduce the scope of searching for an object in the graph model.
+
+The components do not read the generated graph model anymore (generated through the AMF library LD+JSON model). See **docs/architecture.md** for detailed description.
+
+#### Documentation components
+
+##### Api navigation
+
+The API navigate event definition changed. With this version the detail object has the following properties.
+
+- domainId (`string`) The domain id (graph id) of the selected object.
+- domainType (`summary` | `resource` | `operation` | `schema` | `security` | `documentation`) The type of the selected domain object.
+- parentId (`string`) Optional, the parent object domain id (for an operation it is an endpoint)
+- passive: (`boolean`) Optional, whether the selection came from the system processing rather than user interaction.
+
+The navigation event is now `apinavigate` and can be dispatched by using `NavigationEvents` interface:
+
+```javascript
+import { Events } from '@api-components/amf-components';
+
+Events.Navigation.apiNavigate(document.body, 'amf://id', 'resource');
+```
+
+##### ApiDocumentationElement (former api-documentation)
+
+###### Refactored properties
+
+- `selected` -> `domainId`
+- `selectedType` -> `domainType`
+- `inlineMethods` -> `tryItPanel`
+- `compatibility` -> `anypoint`
+
+###### Removed properties
+
+- `noTryIt` - this has been replaced with `tryItButton`
+- `noUrlEditor` - this has been replaced with `httpUrlEditor`
+- `narrow` - no longer needed
+- `scrollTarget` - no longer needed
+- `graph` - not ever used
+- `outlined` - we are dropping support for this property
+- `noBottomNavigation` - not used anymore
+
+###### New properties
+
+- `tryItButton` - the opposite of the previous `noTryIt`
+- `httpUrlEditor` - passed to the request editor as `urlEditor`
+- `httpApplyAuthorization` - passed to the request editor as `applyAuthorization`
+- `httpCredentialsSource` - passed to the request editor as `credentialsSource`
+
+##### ApiResourceDocumentElement (former api-endpoint-documentation)
+
+###### Refactored properties
+
+- `selected` -> `domainId`
+- `selectedType` - `domainType`
+- `compatibility` - `anypoint`
+- `noTryIt` - this has been replaced with `tryItButton`
 - `inlineMethods` is renamed to `tryItPanel`. Has the same function.
 - `noUrlEditor` is now renamed to `urlEditor`. When `urlEditor` is set then the HTTP request editor renders the URL editor input field.
 
-## ApiOperationDocumentElement (former api-operation-documentation)
+###### Removed properties
+
+- `apiVersion` - no longer in use
+- `endpointUri` - no longer in use
+- `server` - no longer in use
+- `endpointName` - no longer in use
+- `description` - no longer in use
+- `path` - no longer in use
+- `hasCustomProperties` - no longer in use
+- `narrow` - no longer in use
+- `extendsTypes` - no longer in use
+- `parentType` - no longer in use
+- `parentTypeName` - no longer in use
+- `traits` - no longer in use
+- `previous` - no longer in use
+- `next` - no longer in use
+- `scrollTarget` - no longer in use
+- `operations` - no longer in use
+- `hasOperations` - no longer in use
+- `outlined` - no longer in use
+- `graph` - no longer in use
+- `noNavigation` - no longer in use
+
+###### New properties
+
+- `serverId` the domain id of the selected API server.
+- `operationId` - the domain id of the selected API operation, when `tryItPanel` is set.
+- `tryItPanel` - renders the HTTP editors next to the operation. Former `inlineMethods`.
+- `tryItButton` - the opposite of the previous `noTryIt`
+- `httpUrlEditor` - passed to the request editor as `urlEditor`
+- `httpApplyAuthorization` - passed to the request editor as `applyAuthorization`
+- `httpCredentialsSource` - passed to the request editor as `credentialsSource`
+- `httpNoServerSelector` - passed to the request editor as `noServerSelector`
+- `asyncApi` - indicates the rendered API is an async API.
+
+##### ApiOperationDocumentElement (former api-operation-documentation)
+
+###### Refactored properties
 
 - `tryIt` is renamed to `tryItButton`
 - `tryItButton` is always set to `false` when `tryItPanel` is set on the resource document element.
-
-## Authorization
-
-### Configuration and HTTP request
+- `method` is now `operation` which accepts serialized API operation model.
+- `endpoint` now accepts serialized API endpoint model.
+- `compatibility` -> anypoint
+
+###### Removed properties
+
+- `methodName` - no longer in use
+- `httpMethod` - no longer in use
+- `apiVersion` - no longer in use
+- `endpointUri` - no longer in use
+- `description` - no longer in use
+- `hasCustomProperties` - no longer in use
+- `expects` - no longer in use
+- `server` - no longer in use
+- `serverVariables` - no longer in use
+- `endpointVariables` - no longer in use
+- `hasPathParameters` - no longer in use
+- `queryParameters` - no longer in use
+- `hasParameters` - no longer in use
+- `payload` - no longer in use
+- `headers` - no longer in use
+- `returns` - no longer in use
+- `security` - no longer in use
+- `narrow` - no longer in use
+- `previous` - no longer in use
+- `next` - no longer in use
+- `extendsTypes` - no longer in use
+- `traits` - no longer in use
+- `graph` - no longer in use
+- `methodSummary` - no longer in use
+- `noNavigation` - no longer in use
+- `ignoreBaseUri` - no longer in use
+- `protocol` - no longer in use
+
+###### New properties
+
+- `serverId` the domain id of the selected API server.
+- `tryItButton` - the opposite of the previous `noTryIt`
+- `asyncApi` - indicates the rendered API is an async API.
+- `requestMimeType` - The mime type of rendered request.
+
+#### Request editor components
+
+##### Authorization
+
+###### Configuration and HTTP request
 
 The authorization has been moved into this library and has a new API surface.
 
@@ -32,33 +184,33 @@ To maximize the compatibility with 0.2.0 use the following configuration:
 ></api-request-editor>
 ```
 
-## Caching values
+##### Caching values
 
 The editor has a new boolean property `globalCache`. Once set it instruct the caching mechanism to cache user input in memory. The cached values are kept in memory even when API spec change.
 Use the `src/lib/InputCache.js` class to manipulate the cache programmatically when needed.
 
 When the `globalCache` is not set then the values are stored in a reference to the editor element. After removing the element from the DOM all cached properties are GC'd.
 
-## Request editor
+##### Request editor
 
-### Refactor
+###### Refactor
 
 - `serializeRequest()` -> `serialize()`
 - removed option `allowDisableParams`
 
-### Setting URL values (baseUri, protocols, server)
+###### Setting URL values (baseUri, protocols, server)
 
 With version `0.2.x` it was possible to set `server`, `baseUri`, and `protocols` properties so the component is able to compute the endpoint URL without having the `server` value read from the AMF graph model. This turned out to be a feature that is not used so it is removed in `0.3.0`. Use `baseUri` to override any value defined in the servers.
 Note, when `baseUri` is set it takes precedence over any other URI configuration (like a selected server).
 
-## URL editor
+##### URL editor
 
 The URL editor is optional by default. The input won't be rendered until the `urlEditor` property is set.
 For a better user experience do not set this option unless crucial for the application. To give user a feedback when updating parameters use option `urlLabel`.
 
 Additionally, the user entered values are now updated on input value change rather than user input. This reduces UI changes (especially with URL editor enabled) while typing value into the editor.
 
-## Body editor
+##### Body editor
 
 The body editor has been re-created from scratch. The new editor uses monaco editor to render the body input.
 This requires loading monaco environment before the editor is rendered and activated.
@@ -77,7 +229,7 @@ await MonacoLoader.monacoReady(); // waits until all libraries are loaded.
 
 Note, Monaco does not support encapsulation. Once loaded a global `Monaco` variable is created.
 
-## Events
+#### Events
 
 With this version the following events are deprecated:
 
@@ -107,6 +259,6 @@ window.addEventListener(EventTypes.Request.apiRequest, (e) => {
 RequestEvents.apiRequest(window, { /* the request definition */ });
 ```
 
-## Tests
+#### Tests
 
 The tests for Firefox currently fails because `playwright` uses a previous version of the browser which has no support for ES modules in web workers. However, the current version support them. Firefox is temporarily removed from tests.